Skip to content

Commit 5d8636b

Browse files
sdkrystianvinniefalco
sdkrystian
authored and
vinniefalco
committed
add IsInfo and InfoKind checking functions
close #276
1 parent e396dbf commit 5d8636b

26 files changed

+174
-184
lines changed

‎include/mrdox/Corpus.hpp

+10-18
Original file line numberDiff line numberDiff line change
@@ -146,24 +146,16 @@ get(
146146
{
147147
auto I = find(id);
148148
assert(I != nullptr);
149-
auto const t = static_cast<T const*>(I);
150-
if constexpr(std::is_same_v<T, NamespaceInfo>)
151-
assert(t->Kind == InfoKind::Namespace);
152-
else if constexpr(std::is_same_v<T, RecordInfo>)
153-
assert(t->Kind == InfoKind::Record);
154-
else if constexpr(std::is_same_v<T, FunctionInfo>)
155-
assert(t->Kind == InfoKind::Function);
156-
else if constexpr(std::is_same_v<T, TypedefInfo>)
157-
assert(t->Kind == InfoKind::Typedef);
158-
else if constexpr(std::is_same_v<T, EnumInfo>)
159-
assert(t->Kind == InfoKind::Enum);
160-
else if constexpr(std::is_same_v<T, VarInfo>)
161-
assert(t->Kind == InfoKind::Variable);
162-
else if constexpr(std::is_same_v<T, FieldInfo>)
163-
assert(t->Kind == InfoKind::Field);
164-
else if constexpr(std::is_same_v<T, SpecializationInfo>)
165-
assert(t->Kind == InfoKind::Specialization);
166-
return *t;
149+
if constexpr(std::is_same_v<T, Info>)
150+
{
151+
return *I;
152+
}
153+
else
154+
{
155+
auto const& J = *static_cast<T const*>(I);
156+
assert(J.Kind == T::kind_id);
157+
return J;
158+
}
167159
}
168160

169161
} // mrdox

‎include/mrdox/Metadata/Enum.hpp

+8-14
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
#define MRDOX_API_METADATA_ENUM_HPP
1414

1515
#include <mrdox/Platform.hpp>
16+
#include <mrdox/Metadata/Javadoc.hpp>
1617
#include <mrdox/Metadata/Symbol.hpp>
1718
#include <mrdox/Metadata/Type.hpp>
1819
#include <optional>
@@ -38,6 +39,10 @@ struct EnumValueInfo
3839
// constant. This will be empty for implicit enumeration values.
3940
std::string ValueExpr;
4041

42+
/** The documentation for the value, if any.
43+
*/
44+
std::unique_ptr<Javadoc> javadoc;
45+
4146
//--------------------------------------------
4247

4348
explicit
@@ -50,24 +55,15 @@ struct EnumValueInfo
5055
, ValueExpr(ValueExpr)
5156
{
5257
}
53-
54-
#if 0
55-
// VFALCO What was this for?
56-
bool operator==(EnumValueInfo const& Other) const
57-
{
58-
return
59-
std::tie(Name, Value, ValueExpr) ==
60-
std::tie(Other.Name, Other.Value, Other.ValueExpr);
61-
}
62-
#endif
6358
};
6459

6560
//------------------------------------------------
6661

6762
// TODO: Expand to allow for documenting templating.
6863
// Info for types.
6964
struct EnumInfo
70-
: SymbolInfo
65+
: IsInfo<InfoKind::Enum>
66+
, SymbolInfo
7167
{
7268
// Indicates whether this enum is scoped (e.g. enum class).
7369
bool Scoped = false;
@@ -82,12 +78,10 @@ struct EnumInfo
8278

8379
//--------------------------------------------
8480

85-
static constexpr InfoKind kind_id = InfoKind::Enum;
86-
8781
explicit
8882
EnumInfo(
8983
SymbolID ID = SymbolID::zero)
90-
: SymbolInfo(InfoKind::Enum, ID)
84+
: IsInfo(ID)
9185
{
9286
}
9387
};

‎include/mrdox/Metadata/Field.hpp

+3-4
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ union FieldFlags
3939
Non-static data members cannot be redeclared.
4040
*/
4141
struct FieldInfo
42-
: SymbolInfo
42+
: IsInfo<InfoKind::Field>
43+
, SymbolInfo
4344
{
4445
/** Type of the field */
4546
TypeInfo Type;
@@ -56,11 +57,9 @@ struct FieldInfo
5657

5758
//--------------------------------------------
5859

59-
static constexpr InfoKind kind_id = InfoKind::Field;
60-
6160
FieldInfo(
6261
SymbolID ID = SymbolID::zero)
63-
: SymbolInfo(InfoKind::Field, ID)
62+
: IsInfo(ID)
6463
{
6564
}
6665
};

‎include/mrdox/Metadata/Function.hpp

+4-6
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,8 @@ struct Param
175175
// TODO: Expand to allow for documenting templating and default args.
176176
// Info for functions.
177177
struct FunctionInfo
178-
: SymbolInfo
178+
: IsInfo<InfoKind::Function>
179+
, SymbolInfo
179180
{
180181
friend class ASTVisitor;
181182

@@ -190,21 +191,18 @@ struct FunctionInfo
190191

191192
//--------------------------------------------
192193

193-
static constexpr InfoKind kind_id = InfoKind::Function;
194-
195194
explicit
196195
FunctionInfo(
197196
SymbolID ID = SymbolID::zero)
198-
: SymbolInfo(InfoKind::Function, ID)
197+
: IsInfo(ID)
199198
{
200199
}
201200

202201
private:
203202
explicit
204203
FunctionInfo(
205204
std::unique_ptr<TemplateInfo>&& T)
206-
: SymbolInfo(InfoKind::Function)
207-
, Template(std::move(T))
205+
: Template(std::move(T))
208206
{
209207
}
210208
};

‎include/mrdox/Metadata/Info.hpp

+52-10
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,16 @@
1919
#include <array>
2020
#include <memory>
2121
#include <string>
22+
#include <string_view>
2223
#include <vector>
2324

2425
namespace clang {
2526
namespace mrdox {
2627

2728
/** Common properties of all symbols
2829
*/
29-
struct Info
30+
struct MRDOX_VISIBLE
31+
Info
3032
{
3133
/** The unique identifier for this symbol.
3234
*/
@@ -71,20 +73,60 @@ struct Info
7173
std::string
7274
extractName() const;
7375

74-
#if 0
75-
/** Return the fully qualified name.
76-
*/
77-
MRDOX_DECL
78-
std::string&
79-
getFullyQualifiedName(
80-
std::string& temp) const;
81-
#endif
8276
/** Return a string representing the symbol type.
8377
8478
For example, "namespace", "class", et. al.
8579
*/
86-
llvm::StringRef
80+
MRDOX_DECL
81+
std::string_view
8782
symbolType() const noexcept;
83+
84+
constexpr bool isDefault() { return Kind == InfoKind::Default; }
85+
constexpr bool isNamespace() { return Kind == InfoKind::Namespace; }
86+
constexpr bool isRecord() { return Kind == InfoKind::Record; }
87+
constexpr bool isFunction() { return Kind == InfoKind::Function; }
88+
constexpr bool isEnum() { return Kind == InfoKind::Enum; }
89+
constexpr bool isTypedef() { return Kind == InfoKind::Typedef; }
90+
constexpr bool isVariable() { return Kind == InfoKind::Variable; }
91+
constexpr bool isField() { return Kind == InfoKind::Field; }
92+
constexpr bool isSpecialization() { return Kind == InfoKind::Specialization; }
93+
};
94+
95+
//------------------------------------------------
96+
97+
/** Base class for providing variant discriminator functions.
98+
99+
This offers functions that return a boolean at
100+
compile-time, indicating if the most-derived
101+
class is a certain type.
102+
*/
103+
template<InfoKind K>
104+
struct IsInfo : Info
105+
{
106+
/** The variant discriminator constant of the most-derived class.
107+
*/
108+
static constexpr InfoKind kind_id = K;
109+
110+
static constexpr bool isDefault() { return K== InfoKind::Default; }
111+
static constexpr bool isNamespace() { return K == InfoKind::Namespace; }
112+
static constexpr bool isRecord() { return K == InfoKind::Record; }
113+
static constexpr bool isFunction() { return K == InfoKind::Function; }
114+
static constexpr bool isEnum() { return K == InfoKind::Enum; }
115+
static constexpr bool isTypedef() { return K == InfoKind::Typedef; }
116+
static constexpr bool isVariable() { return K == InfoKind::Variable; }
117+
static constexpr bool isField() { return K == InfoKind::Field; }
118+
static constexpr bool isSpecialization() { return K == InfoKind::Specialization; }
119+
120+
protected:
121+
constexpr IsInfo()
122+
: Info(K)
123+
{
124+
}
125+
126+
constexpr explicit IsInfo(SymbolID ID)
127+
: Info(K, ID)
128+
{
129+
}
88130
};
89131

90132
} // mrdox

‎include/mrdox/Metadata/Namespace.hpp

+7-7
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,18 @@ namespace mrdox {
2222
/** Describes a namespace.
2323
*/
2424
struct NamespaceInfo
25-
: public Info
25+
: IsInfo<InfoKind::Namespace>
2626
{
2727
Scope Children;
2828

2929
//--------------------------------------------
3030

31-
static constexpr InfoKind kind_id = InfoKind::Namespace;
32-
33-
NamespaceInfo();
34-
35-
explicit NamespaceInfo(
36-
SymbolID id);
31+
explicit
32+
NamespaceInfo(
33+
SymbolID ID = SymbolID::zero)
34+
: IsInfo(ID)
35+
{
36+
}
3737
};
3838

3939
} // mrdox

‎include/mrdox/Metadata/Record.hpp

+4-6
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,8 @@ enum class RecordKeyKind
124124
/** Metadata for struct, class, or union.
125125
*/
126126
struct RecordInfo
127-
: SymbolInfo
127+
: IsInfo<InfoKind::Record>
128+
, SymbolInfo
128129
{
129130
friend class ASTVisitor;
130131

@@ -158,21 +159,18 @@ struct RecordInfo
158159

159160
//--------------------------------------------
160161

161-
static constexpr InfoKind kind_id = InfoKind::Record;
162-
163162
explicit
164163
RecordInfo(
165164
SymbolID ID = SymbolID::zero)
166-
: SymbolInfo(InfoKind::Record, ID)
165+
: IsInfo(ID)
167166
{
168167
}
169168

170169
private:
171170
explicit
172171
RecordInfo(
173172
std::unique_ptr<TemplateInfo>&& T)
174-
: SymbolInfo(InfoKind::Record)
175-
, Template(std::move(T))
173+
: Template(std::move(T))
176174
{
177175
}
178176
};

‎include/mrdox/Metadata/Scope.hpp

-9
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ namespace mrdox {
2525
*/
2626
struct Scope
2727
{
28-
bool isNamespaceScope = true;
29-
3028
// Namespaces and Records are references because they will be properly
3129
// documented in their own info, while the entirety of Functions and Enums are
3230
// included here because they should not have separate documentation from
@@ -41,13 +39,6 @@ struct Scope
4139
std::vector<Reference> Enums;
4240
std::vector<Reference> Vars;
4341
std::vector<Reference> Specializations;
44-
45-
explicit
46-
Scope(
47-
bool isNamespaceScope_) noexcept
48-
: isNamespaceScope(isNamespaceScope_)
49-
{
50-
}
5142
};
5243

5344
} // mrdox

‎include/mrdox/Metadata/Specialization.hpp

+3-4
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ struct SpecializedMember
4545
/** Specialization info for members of implicit instantiations
4646
*/
4747
struct SpecializationInfo
48-
: Info
48+
: IsInfo<InfoKind::Specialization>
4949
{
5050
/** The template arguments the parent template is specialized for */
5151
std::vector<TArg> Args;
@@ -61,11 +61,10 @@ struct SpecializationInfo
6161
*/
6262
std::vector<SpecializedMember> Members;
6363

64-
static constexpr InfoKind kind_id = InfoKind::Specialization;
65-
64+
explicit
6665
SpecializationInfo(
6766
SymbolID ID = SymbolID::zero)
68-
: Info(InfoKind::Specialization, ID)
67+
: IsInfo(ID)
6968
{
7069
}
7170
};

‎include/mrdox/Metadata/Symbol.hpp

+2-10
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ namespace mrdox {
2424
/** Base class for Info that have source locations.
2525
*/
2626
struct SymbolInfo
27-
: Info
2827
{
2928
/** Location where the entity was defined
3029
@@ -41,15 +40,8 @@ struct SymbolInfo
4140
*/
4241
std::vector<Location> Loc;
4342

44-
//--------------------------------------------
45-
46-
explicit
47-
SymbolInfo(
48-
InfoKind kind,
49-
SymbolID ID = SymbolID::zero)
50-
: Info(kind, ID)
51-
{
52-
}
43+
protected:
44+
SymbolInfo() = default;
5345
};
5446

5547
} // mrdox

0 commit comments

Comments
 (0)