Skip to content

Commit d64c254

Browse files
ilovepiilovepi
committed
[𝘀𝗽𝗿] initial version
Created using spr 1.3.6-beta.1
2 parents f01b62a + ac3ce2e commit d64c254

File tree

4 files changed

+159
-16
lines changed

4 files changed

+159
-16
lines changed

‎clang-tools-extra/clang-doc/Serialize.cpp‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -236,10 +236,10 @@ static RecordDecl *getRecordDeclForType(const QualType &T) {
236236
return nullptr;
237237
}
238238

239-
TypeInfo getTypeInfoForType(const QualType &T) {
239+
TypeInfo getTypeInfoForType(const QualType &T, const PrintingPolicy& Policy) {
240240
const TagDecl *TD = getTagDeclForType(T);
241241
if (!TD)
242-
return TypeInfo(Reference(SymbolID(), T.getAsString()));
242+
return TypeInfo(Reference(SymbolID(), T.getAsString(Policy)));
243243

244244
InfoType IT;
245245
if (dyn_cast<EnumDecl>(TD)) {
@@ -250,7 +250,7 @@ TypeInfo getTypeInfoForType(const QualType &T) {
250250
IT = InfoType::IT_default;
251251
}
252252
return TypeInfo(Reference(getUSRForDecl(TD), TD->getNameAsString(), IT,
253-
T.getAsString(), getInfoRelativePath(TD)));
253+
T.getAsString(Policy), getInfoRelativePath(TD)));
254254
}
255255

256256
static bool isPublic(const clang::AccessSpecifier AS,
@@ -379,10 +379,11 @@ static void parseFields(RecordInfo &I, const RecordDecl *D, bool PublicOnly,
379379
if (!shouldSerializeInfo(PublicOnly, /*IsInAnonymousNamespace=*/false, F))
380380
continue;
381381

382+
auto &LO = F->getLangOpts();
382383
// Use getAccessUnsafe so that we just get the default AS_none if it's not
383384
// valid, as opposed to an assert.
384385
MemberTypeInfo &NewMember = I.Members.emplace_back(
385-
getTypeInfoForType(F->getTypeSourceInfo()->getType()),
386+
getTypeInfoForType(F->getTypeSourceInfo()->getType(), LO),
386387
F->getNameAsString(),
387388
getFinalAccessSpecifier(Access, F->getAccessUnsafe()));
388389
populateMemberTypeInfo(NewMember, F);
@@ -412,9 +413,10 @@ static void parseEnumerators(EnumInfo &I, const EnumDecl *D) {
412413
}
413414

414415
static void parseParameters(FunctionInfo &I, const FunctionDecl *D) {
416+
auto &LO = D->getLangOpts();
415417
for (const ParmVarDecl *P : D->parameters()) {
416418
FieldTypeInfo &FieldInfo = I.Params.emplace_back(
417-
getTypeInfoForType(P->getOriginalType()), P->getNameAsString());
419+
getTypeInfoForType(P->getOriginalType(), LO), P->getNameAsString());
418420
FieldInfo.DefaultValue = getSourceCode(D, P->getDefaultArgRange());
419421
}
420422
}
@@ -541,7 +543,8 @@ static void populateFunctionInfo(FunctionInfo &I, const FunctionDecl *D,
541543
bool &IsInAnonymousNamespace) {
542544
populateSymbolInfo(I, D, FC, LineNumber, Filename, IsFileInRootDir,
543545
IsInAnonymousNamespace);
544-
I.ReturnType = getTypeInfoForType(D->getReturnType());
546+
auto &LO = D->getLangOpts();
547+
I.ReturnType = getTypeInfoForType(D->getReturnType(), LO);
545548
parseParameters(I, D);
546549

547550
PopulateTemplateParameters(I.Template, D);
@@ -783,7 +786,8 @@ emitInfo(const TypedefDecl *D, const FullComment *FC, int LineNumber,
783786
return {};
784787

785788
Info.DefLoc.emplace(LineNumber, File, IsFileInRootDir);
786-
Info.Underlying = getTypeInfoForType(D->getUnderlyingType());
789+
auto &LO = D->getLangOpts();
790+
Info.Underlying = getTypeInfoForType(D->getUnderlyingType(), LO);
787791
if (Info.Underlying.Type.Name.empty()) {
788792
// Typedef for an unnamed type. This is like "typedef struct { } Foo;"
789793
// The record serializer explicitly checks for this syntax and constructs
@@ -809,7 +813,8 @@ emitInfo(const TypeAliasDecl *D, const FullComment *FC, int LineNumber,
809813
return {};
810814

811815
Info.DefLoc.emplace(LineNumber, File, IsFileInRootDir);
812-
Info.Underlying = getTypeInfoForType(D->getUnderlyingType());
816+
auto &LO = D->getLangOpts();
817+
Info.Underlying = getTypeInfoForType(D->getUnderlyingType(), LO);
813818
Info.IsUsing = true;
814819

815820
// Info is wrapped in its parent scope so is returned in the second position.

‎clang-tools-extra/test/clang-doc/basic.cpp‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
// RUN: rm -rf %t
2+
// RUN: mkdir %t
3+
4+
// RUN: clang-doc --doxygen --executor=standalone %s -output=%t/docs
5+
// RUN: cat %t/docs/index.yaml | FileCheck %s --check-prefix=YAML
6+
7+
// RUN: clang-doc --doxygen --executor=standalone %s -output=%t/docs --format=md
8+
// RUN: cat %t/docs/GlobalNamespace/index.md | FileCheck %s --check-prefix=MD
9+
10+
// YAML: ---
11+
// YAML-NEXT: USR: '0000000000000000000000000000000000000000'
12+
// YAML-NEXT: ChildFunctions:
13+
14+
// MD: # Global Namespace
15+
// MD: ## Functions
16+
17+
extern bool b();
18+
19+
// YAML-NEXT: - USR: '88A104C263241E354ECF5B55B04AE8CEAD625B71'
20+
// YAML-NEXT: Name: 'b'
21+
// YAML-NEXT: Location:
22+
// YAML-NEXT: - LineNumber: [[# @LINE-5]]
23+
// YAML-NEXT: Filename: '{{.*}}'
24+
// YAML-NEXT: ReturnType:
25+
// YAML-NEXT: Type:
26+
// YAML-NEXT: Name: 'bool'
27+
// YAML-NEXT: QualName: 'bool'
28+
29+
// MD: ### b
30+
// MD: *bool b()*
31+
32+
char c();
33+
34+
// YAML-NEXT: - USR: 'EA3287837B3F175C8DB154406B4DAD2924F479B5'
35+
// YAML-NEXT: Name: 'c'
36+
// YAML-NEXT: Location:
37+
// YAML-NEXT: - LineNumber: [[# @LINE-5]]
38+
// YAML-NEXT: Filename: '{{.*}}'
39+
// YAML-NEXT: ReturnType:
40+
// YAML-NEXT: Type:
41+
// YAML-NEXT: Name: 'char'
42+
// YAML-NEXT: QualName: 'char'
43+
44+
// MD: ### c
45+
// MD: *char c()*
46+
47+
double d();
48+
49+
// YAML-NEXT: - USR: '60A47E4696CEFC411AB2E1EEFA2DD914E2A7E450'
50+
// YAML-NEXT: Name: 'd'
51+
// YAML-NEXT: Location:
52+
// YAML-NEXT: - LineNumber: [[# @LINE-5]]
53+
// YAML-NEXT: Filename: '{{.*}}'
54+
// YAML-NEXT: ReturnType:
55+
// YAML-NEXT: Type:
56+
// YAML-NEXT: Name: 'double'
57+
// YAML-NEXT: QualName: 'double'
58+
59+
// MD: ### d
60+
// MD: *double d()*
61+
62+
float f();
63+
64+
// YAML-NEXT: - USR: 'B3A9EC6BECD5869CF3ACDFB25153CFE6BBDD5EAB'
65+
// YAML-NEXT: Name: 'f'
66+
// YAML-NEXT: Location:
67+
// YAML-NEXT: - LineNumber: [[# @LINE-5]]
68+
// YAML-NEXT: Filename: '{{.*}}'
69+
// YAML-NEXT: ReturnType:
70+
// YAML-NEXT: Type:
71+
// YAML-NEXT: Name: 'float'
72+
// YAML-NEXT: QualName: 'float'
73+
74+
// MD: ### f
75+
// MD: *float f()*
76+
77+
int i();
78+
79+
// YAML-NEXT: - USR: '307041280A81EB46F949A94AD52587C659FD801C'
80+
// YAML-NEXT: Name: 'i'
81+
// YAML-NEXT: Location:
82+
// YAML-NEXT: - LineNumber: [[# @LINE-5]]
83+
// YAML-NEXT: Filename: '{{.*}}'
84+
// YAML-NEXT: ReturnType:
85+
// YAML-NEXT: Type:
86+
// YAML-NEXT: Name: 'int'
87+
// YAML-NEXT: QualName: 'int'
88+
89+
// MD: ### i
90+
// MD: *int i()*
91+
92+
long l();
93+
94+
// YAML-NEXT: - USR: 'A1CE9AB0064C412F857592E01332C641C1A06F37'
95+
// YAML-NEXT: Name: 'l'
96+
// YAML-NEXT: Location:
97+
// YAML-NEXT: - LineNumber: [[# @LINE-5]]
98+
// YAML-NEXT: Filename: '{{.*}}'
99+
// YAML-NEXT: ReturnType:
100+
// YAML-NEXT: Type:
101+
// YAML-NEXT: Name: 'long'
102+
// YAML-NEXT: QualName: 'long'
103+
104+
// MD: ### l
105+
// MD: *long l()*
106+
107+
long long ll();
108+
109+
// YAML-NEXT: - USR: '5C2C44ED4825C066EF6ED796863586F343C8BCA9'
110+
// YAML-NEXT: Name: 'll'
111+
// YAML-NEXT: Location:
112+
// YAML-NEXT: - LineNumber: [[# @LINE-5]]
113+
// YAML-NEXT: Filename: '{{.*}}'
114+
// YAML-NEXT: ReturnType:
115+
// YAML-NEXT: Type:
116+
// YAML-NEXT: Name: 'long long'
117+
// YAML-NEXT: QualName: 'long long'
118+
119+
// MD: ### ll
120+
// MD: *long long ll()*
121+
122+
short s();
123+
124+
// YAML-NEXT: - USR: '412341570FD3AD2C3A1E9A1DE7B3C01C07BEACFE'
125+
// YAML-NEXT: Name: 's'
126+
// YAML-NEXT: Location:
127+
// YAML-NEXT: - LineNumber: [[# @LINE-5]]
128+
// YAML-NEXT: Filename: '{{.*}}'
129+
// YAML-NEXT: ReturnType:
130+
// YAML-NEXT: Type:
131+
// YAML-NEXT: Name: 'short'
132+
// YAML-NEXT: QualName: 'short'
133+
// YAML-NEXT: ...
134+
135+
// MD: ### s
136+
// MD: *short s()*

‎clang-tools-extra/test/clang-doc/templates.cpp‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ void function<bool, 0>(bool x) {}
8080
// YAML-NEXT: Filename: '{{.*}}'
8181
// YAML-NEXT: Params:
8282
// YAML-NEXT: - Type:
83-
// YAML-NEXT: Name: '_Bool'
84-
// YAML-NEXT: QualName: '_Bool'
83+
// YAML-NEXT: Name: 'bool'
84+
// YAML-NEXT: QualName: 'bool'
8585
// YAML-NEXT: Name: 'x'
8686
// YAML-NEXT: ReturnType:
8787
// YAML-NEXT: Type:
@@ -95,7 +95,7 @@ void function<bool, 0>(bool x) {}
9595
// YAML-NEXT: - Contents: '0'
9696

9797
// MD: ### function
98-
// MD: *void function(_Bool x)*
98+
// MD: *void function(bool x)*
9999
// MD: *Defined at {{.*}}templates.cpp#[[# @LINE - 26]]*
100100

101101
/// A Tuple type
@@ -136,21 +136,21 @@ tuple<int,int,bool> func_with_tuple_param(tuple<int,int,bool> t){ return t;}
136136
// YAML-NEXT: - Type:
137137
// YAML-NEXT: Type: Record
138138
// YAML-NEXT: Name: 'tuple'
139-
// YAML-NEXT: QualName: 'tuple<int, int, _Bool>'
139+
// YAML-NEXT: QualName: 'tuple<int, int, bool>'
140140
// YAML-NEXT: USR: '{{([0-9A-F]{40})}}'
141141
// YAML-NEXT: Path: 'GlobalNamespace'
142142
// YAML-NEXT: Name: 't'
143143
// YAML-NEXT: ReturnType:
144144
// YAML-NEXT: Type:
145145
// YAML-NEXT: Type: Record
146146
// YAML-NEXT: Name: 'tuple'
147-
// YAML-NEXT: QualName: 'tuple<int, int, _Bool>'
147+
// YAML-NEXT: QualName: 'tuple<int, int, bool>'
148148
// YAML-NEXT: USR: '{{([0-9A-F]{40})}}'
149149
// YAML-NEXT: Path: 'GlobalNamespace'
150150
// YAML-NEXT: ...
151151

152152
// MD: ### func_with_tuple_param
153-
// MD: *tuple<int, int, _Bool> func_with_tuple_param(tuple<int, int, _Bool> t)*
153+
// MD: *tuple<int, int, bool> func_with_tuple_param(tuple<int, int, bool> t)*
154154
// MD: *Defined at {{.*}}templates.cpp#[[# @LINE - 44]]*
155155
// MD: A function with a tuple parameter
156156
// MD: **t** The input to func_with_tuple_param

‎clang-tools-extra/unittests/clang-doc/SerializeTest.cpp‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -631,8 +631,8 @@ TEST(SerializeTests, emitTypedefs) {
631631
TEST(SerializeTests, emitFunctionTemplate) {
632632
EmittedInfoList Infos;
633633
// A template and a specialization.
634-
ExtractInfosFromCode("template<typename T = int> void GetFoo(T);\n"
635-
"template<> void GetFoo<bool>(bool);",
634+
ExtractInfosFromCode("template<typename T = int> bool GetFoo(T);\n"
635+
"template<> bool GetFoo<bool>(bool);",
636636
2,
637637
/*Public=*/false, Infos);
638638

@@ -666,6 +666,8 @@ TEST(SerializeTests, emitFunctionTemplate) {
666666
ASSERT_EQ(1u, Func2.Template->Specialization->Params.size());
667667
EXPECT_EQ("bool", Func2.Template->Specialization->Params[0].Contents);
668668
EXPECT_EQ(Func1.USR, Func2.Template->Specialization->SpecializationOf);
669+
670+
EXPECT_EQ("bool", Func2.ReturnType.Type.Name);
669671
}
670672

671673
TEST(SerializeTests, emitClassTemplate) {

0 commit comments

Comments
 (0)