Skip to content

Commit 4e22c31

Browse files
vinniefalcovinniefalco
committed
final for CXXRecordInfo
1 parent d428e5f commit 4e22c31

File tree

9 files changed

+101
-94
lines changed

9 files changed

+101
-94
lines changed

‎include/mrdox/Metadata/Record.hpp

+21-11
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
#define MRDOX_METADATA_RECORD_HPP
1414

1515
#include <mrdox/Platform.hpp>
16+
#include <mrdox/Metadata/Bits.hpp>
1617
#include <mrdox/Metadata/MemberType.hpp>
1718
#include <mrdox/Metadata/Reference.hpp>
1819
#include <mrdox/Metadata/Scope.hpp>
@@ -29,19 +30,16 @@ namespace mrdox {
2930

3031
struct BaseRecordInfo;
3132

32-
// TODO: Expand to allow for documenting templating, inheritance access,
33-
// friend classes
34-
// Info for types.
35-
struct RecordInfo : SymbolInfo
33+
/** Bit constants used with function specifiers.
34+
*/
35+
enum RecFlags0 : std::uint32_t
3636
{
37-
static constexpr InfoType type_id = InfoType::IT_record;
38-
39-
RecordInfo(
40-
SymbolID id = SymbolID(),
41-
llvm::StringRef Name = llvm::StringRef());
42-
43-
void merge(RecordInfo&& I);
37+
isFinal = 0x00000001,
38+
isFinalDestructor = 0x00000002
39+
};
4440

41+
struct RecordInfo : SymbolInfo
42+
{
4543
// Type of this record (struct, class, union, interface).
4644
TagTypeKind TagType = TagTypeKind::TTK_Struct;
4745

@@ -58,6 +56,8 @@ struct RecordInfo : SymbolInfo
5856
// are converted into records with the typedef as the Name + this flag set.
5957
bool IsTypeDef = false;
6058

59+
Bits<RecFlags0> specs;
60+
6161
llvm::SmallVector<MemberTypeInfo, 4> Members; // List of info about record members.
6262
llvm::SmallVector<Reference, 4> Parents; // List of base/parent records
6363
// (does not include virtual parents).
@@ -70,6 +70,16 @@ struct RecordInfo : SymbolInfo
7070
llvm::SmallVector<SymbolID, 4> Friends;
7171

7272
Scope Children;
73+
74+
//--------------------------------------------
75+
76+
static constexpr InfoType type_id = InfoType::IT_record;
77+
78+
RecordInfo(
79+
SymbolID id = SymbolID(),
80+
llvm::StringRef Name = llvm::StringRef());
81+
82+
void merge(RecordInfo&& I);
7383
};
7484

7585
} // mrdox

‎source/api/AST/BitcodeIDs.hpp

+1
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ enum RecordId
8383
FUNCTION_ACCESS,
8484
FUNCTION_IS_METHOD,
8585
FUNCTION_BITS,
86+
INFO_BITS,
8687
JAVADOC_LIST_KIND,
8788
JAVADOC_NODE_KIND,
8889
JAVADOC_NODE_STRING,

‎source/api/AST/BitcodeReader.cpp

+23-25
Original file line numberDiff line numberDiff line change
@@ -67,24 +67,6 @@ decodeRecord(
6767
return llvm::Error::success();
6868
}
6969

70-
// bits
71-
template<class... Enum>
72-
static
73-
llvm::Error
74-
decodeRecord(
75-
Record const& R,
76-
std::uint32_t* data,
77-
std::size_t n,
78-
llvm::StringRef blob)
79-
{
80-
auto n1 = *R.begin();
81-
if(n1 != n)
82-
return makeError("wrong size(", n1, ") for Bits(", n, ")");
83-
for(std::size_t i = 0; i < n1; ++i)
84-
data[i] = static_cast<std::uint32_t>(R.begin()[i + 1]);
85-
return llvm::Error::success();
86-
}
87-
8870
// container of char
8971
template<class Field>
9072
requires std::is_same_v<
@@ -264,6 +246,26 @@ decodeRecord(
264246
return llvm::Error::success();
265247
}
266248

249+
250+
template<class Enum>
251+
requires std::is_enum_v<Enum>
252+
static
253+
llvm::Error
254+
decodeRecord(
255+
Record const& R,
256+
Bits<Enum>& bits,
257+
llvm::StringRef Blob)
258+
{
259+
auto n = *R.begin();
260+
if(n != 1)
261+
return makeError("wrong size(", n, ") for Bits[1]");
262+
auto const v = R.begin()[1];
263+
if(v > (std::numeric_limits<std::uint32_t>::max)())
264+
return makeError(v, " is out of range for Bits");
265+
bits.load(static_cast<std::uint32_t>(v));
266+
return llvm::Error::success();
267+
}
268+
267269
//------------------------------------------------
268270

269271
template<class T>
@@ -1054,6 +1056,8 @@ parseRecord(
10541056
return decodeRecord(R, I->IsTypeDef, Blob);
10551057
case RECORD_FRIENDS:
10561058
return decodeRecord(R, I->Friends, Blob);
1059+
case INFO_BITS:
1060+
return decodeRecord(R, I->specs, Blob);
10571061
default:
10581062
return makeError("invalid field for RecordInfo");
10591063
}
@@ -1109,13 +1113,7 @@ parseRecord(
11091113
case FUNCTION_IS_METHOD:
11101114
return decodeRecord(R, I->IsMethod, Blob);
11111115
case FUNCTION_BITS:
1112-
{
1113-
std::uint32_t v = 0;
1114-
if(auto err = decodeRecord(R, &v, 1, Blob))
1115-
return err;
1116-
I->specs.load(v);
1117-
return llvm::Error::success();
1118-
}
1116+
return decodeRecord(R, I->specs, Blob);
11191117
default:
11201118
return makeError("invalid field for FunctionInfo");
11211119
}

‎source/api/AST/BitcodeReader.hpp

+18-36
Original file line numberDiff line numberDiff line change
@@ -102,42 +102,24 @@ class BitcodeReader
102102
llvm::Error
103103
readRecord(unsigned ID, T I);
104104

105-
llvm::Error parseRecord(Record const& R, unsigned ID,
106-
llvm::StringRef Blob, const unsigned VersionNo);
107-
llvm::Error parseRecord(Record const& R, unsigned ID,
108-
llvm::StringRef Blob, NamespaceInfo* I);
109-
llvm::Error parseRecord(Record const& R, unsigned ID,
110-
llvm::StringRef Blob, RecordInfo* I);
111-
llvm::Error parseRecord(Record const& R, unsigned ID,
112-
llvm::StringRef Blob, BaseRecordInfo* I);
113-
llvm::Error parseRecord(Record const& R, unsigned ID,
114-
llvm::StringRef Blob, FunctionInfo* I);
115-
llvm::Error parseRecord(Record const& R, unsigned ID,
116-
llvm::StringRef Blob, EnumInfo* I);
117-
llvm::Error parseRecord(Record const& R, unsigned ID,
118-
llvm::StringRef Blob, EnumValueInfo* I);
119-
llvm::Error parseRecord(Record const& R, unsigned ID,
120-
llvm::StringRef Blob, TypedefInfo* I);
121-
llvm::Error parseRecord(Record const& R, unsigned ID,
122-
llvm::StringRef Blob, TypeInfo* I);
123-
llvm::Error parseRecord(Record const& R, unsigned ID,
124-
llvm::StringRef Blob, FieldTypeInfo* I);
125-
llvm::Error parseRecord(Record const& R, unsigned ID,
126-
llvm::StringRef Blob, MemberTypeInfo* I);
127-
llvm::Error parseRecord(Record const& R, unsigned ID,
128-
llvm::StringRef Blob, Reference* I, FieldId& F);
129-
llvm::Error parseRecord(Record const& R, unsigned ID,
130-
llvm::StringRef Blob, TemplateInfo* I);
131-
llvm::Error parseRecord(Record const& R, unsigned ID,
132-
llvm::StringRef Blob, TemplateSpecializationInfo* I);
133-
llvm::Error parseRecord(Record const& R, unsigned ID,
134-
llvm::StringRef Blob, TemplateParamInfo* I);
135-
llvm::Error parseRecord(Record const& R, unsigned ID,
136-
llvm::StringRef Blob, llvm::Optional<Javadoc>* I);
137-
llvm::Error parseRecord(Record const& R, unsigned ID,
138-
llvm::StringRef Blob, AnyNodeList* I);
139-
llvm::Error parseRecord(Record const& R, unsigned ID,
140-
llvm::StringRef Blob, AnyNodeList::Nodes* I);
105+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, const unsigned VersionNo);
106+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, NamespaceInfo* I);
107+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, RecordInfo* I);
108+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, BaseRecordInfo* I);
109+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, FunctionInfo* I);
110+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, EnumInfo* I);
111+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, EnumValueInfo* I);
112+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, TypedefInfo* I);
113+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, TypeInfo* I);
114+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, FieldTypeInfo* I);
115+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, MemberTypeInfo* I);
116+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, Reference* I, FieldId& F);
117+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, TemplateInfo* I);
118+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, TemplateSpecializationInfo* I);
119+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, TemplateParamInfo* I);
120+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, llvm::Optional<Javadoc>* I);
121+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, AnyNodeList* I);
122+
llvm::Error parseRecord(Record const& R, unsigned ID, llvm::StringRef Blob, AnyNodeList::Nodes* I);
141123

142124
// Helper function to step through blocks to find and dispatch the next record
143125
// or block to be read.

‎source/api/AST/BitcodeWriter.cpp

+10-21
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,7 @@ RecordIdNameMap = []()
233233
{JAVADOC_NODE_ADMONISH, {"JavadocNodeAdmonish", &Integer32Abbrev}},
234234
{FIELD_TYPE_NAME, {"Name", &StringAbbrev}},
235235
{FIELD_DEFAULT_VALUE, {"DefaultValue", &StringAbbrev}},
236+
{INFO_BITS, {"Bits", &Integer32ArrayAbbrev}},
236237
{MEMBER_TYPE_NAME, {"Name", &StringAbbrev}},
237238
{MEMBER_TYPE_ACCESS, {"Access", &Integer32Abbrev}},
238239
{NAMESPACE_USR, {"USR", &SymbolIDAbbrev}},
@@ -327,7 +328,7 @@ RecordsByBlock{
327328
{BI_RECORD_BLOCK_ID,
328329
{RECORD_USR, RECORD_NAME, RECORD_DEFLOCATION,
329330
RECORD_LOCATION, RECORD_TAG_TYPE, RECORD_IS_TYPE_DEF,
330-
RECORD_FRIENDS}},
331+
INFO_BITS, RECORD_FRIENDS}},
331332
// std::vector<Reference>
332333
{BI_REFERENCE_BLOCK_ID,
333334
{REFERENCE_USR, REFERENCE_NAME, REFERENCE_TYPE, REFERENCE_FIELD}},
@@ -463,6 +464,7 @@ emitBlock(
463464
emitRecord(L, RECORD_LOCATION);
464465
emitRecord(I.TagType, RECORD_TAG_TYPE);
465466
emitRecord(I.IsTypeDef, RECORD_IS_TYPE_DEF);
467+
emitRecord(I.specs, INFO_BITS);
466468
for (const auto& N : I.Members)
467469
emitBlock(N);
468470
for (const auto& P : I.Parents)
@@ -514,11 +516,7 @@ emitBlock(
514516
emitBlock(*I.javadoc);
515517
emitRecord(I.Access, FUNCTION_ACCESS);
516518
emitRecord(I.IsMethod, FUNCTION_IS_METHOD);
517-
{
518-
std::uint32_t v[1] = {
519-
I.specs.value() };
520-
emitRecord(v, 1, FUNCTION_BITS);
521-
}
519+
emitRecord(I.specs, FUNCTION_BITS);
522520
if (I.DefLoc)
523521
emitRecord(*I.DefLoc, FUNCTION_DEFLOCATION);
524522
for (const auto& L : I.Loc)
@@ -826,30 +824,21 @@ emitRecord(
826824
}
827825

828826
// Bits
827+
template<class Enum>
828+
requires std::is_enum_v<Enum>
829829
void
830830
BitcodeWriter::
831831
emitRecord(
832-
std::uint32_t const* p,
833-
std::size_t n,
832+
Bits<Enum> const& bits,
834833
RecordId ID)
835834
{
836835
Assert(RecordIdNameMap[ID]);
837836
Assert(RecordIdNameMap[ID].Abbrev ==
838837
&Integer32ArrayAbbrev);
839-
bool empty = true;
840-
for(std::size_t i = 0; i < n; ++i)
841-
{
842-
if(p[i] != 0)
843-
{
844-
empty = false;
845-
break;
846-
}
847-
}
848-
if (!prepRecordData(ID, ! empty))
838+
if (!prepRecordData(ID, bits.value() != 0))
849839
return;
850-
Record.push_back(n);
851-
for(std::size_t i = 0; i < n; ++i)
852-
Record.push_back(static_cast<RecordValue>(p[i]));
840+
Record.push_back(1);
841+
Record.push_back(static_cast<RecordValue>(bits.value()));
853842
Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record);
854843
}
855844

‎source/api/AST/BitcodeWriter.hpp

+4-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
#include <mrdox/Platform.hpp>
2323
#include "BitcodeIDs.hpp"
2424
#include <mrdox/MetadataFwd.hpp>
25+
#include <mrdox/Metadata/Bits.hpp>
2526
#include <mrdox/Metadata/Javadoc.hpp>
2627
#include <clang/AST/AST.h>
2728
#include <llvm/ADT/DenseMap.h>
@@ -92,7 +93,9 @@ class BitcodeWriter
9293
requires std::is_enum_v<Enum>
9394
void emitRecord(Enum Value, RecordId ID);
9495

95-
void emitRecord(std::uint32_t const* p, std::size_t n, RecordId ID);
96+
template<class Enum>
97+
requires std::is_enum_v<Enum>
98+
void emitRecord(Bits<Enum> const&, RecordId ID);
9699

97100
void emitRecord(llvm::SmallVectorImpl<SymbolID> const& Values, RecordId ID);
98101

‎source/api/AST/Serializer.cpp

+15
Original file line numberDiff line numberDiff line change
@@ -856,6 +856,20 @@ build(
856856
writeParent(std::move(I)) };
857857
}
858858

859+
static
860+
void
861+
getCXXRecordSpecs(
862+
RecordInfo& I,
863+
CXXRecordDecl const* D)
864+
{
865+
// These are from CXXRecordDecl::isEffectivelyFinal()
866+
I.specs.set<RecFlags0::isFinal>(D->hasAttr<FinalAttr>());
867+
if(auto const DT = D->getDestructor())
868+
{
869+
I.specs.set<RecFlags0::isFinalDestructor>(DT->hasAttr<FinalAttr>());
870+
}
871+
}
872+
859873
SerializeResult
860874
Serializer::
861875
build(
@@ -865,6 +879,7 @@ build(
865879
if(! getSymbolInfo(*this, I, D))
866880
return {};
867881
I.TagType = D->getTagKind();
882+
getCXXRecordSpecs(I, D);
868883
parseFields(I, D, PublicOnly, AccessSpecifier::AS_public, R_);
869884
if(auto const* C = dyn_cast<CXXRecordDecl>(D))
870885
{

‎source/api/Metadata/Record.cpp

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ merge(RecordInfo&& Other)
3737
if (!TagType)
3838
TagType = Other.TagType;
3939
IsTypeDef = IsTypeDef || Other.IsTypeDef;
40+
specs.merge(std::move(Other).specs);
4041
if (Members.empty())
4142
Members = std::move(Other.Members);
4243
if (Bases.empty())

‎source/api/_XML/XMLWriter.cpp

+8
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,14 @@ visit(
143143

144144
writeInfo(I);
145145
writeSymbol(I);
146+
{
147+
auto os = tags_.jit_indent();
148+
if(I.specs.get<RecFlags0::isFinal>())
149+
os << "<final/>";
150+
if(I.specs.get<RecFlags0::isFinalDestructor>())
151+
os << "<final-dtor/>";
152+
os.finish();
153+
}
146154
for(auto const& J : I.Bases)
147155
writeBaseRecord(J);
148156
// VFALCO data members?

0 commit comments

Comments
 (0)