Skip to content

[clang-doc] Add JSON bools for parents, vparents and test #171699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
evelez7 merged 2 commits into from
Dec 11, 2025
Merged

[clang-doc] Add JSON bools for parents, vparents and test #171699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85b0b75
fix unittest
evelez7 Nov 14, 2025
45d8e8a
fix unittest
evelez7 Nov 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions clang-tools-extra/clang-doc/JSONGenerator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,6 +551,7 @@ static void serializeInfo(const RecordInfo &I, json::Object &Obj,
auto &MemberObj = *MemberVal.getAsObject();
MemberObj["Name"] = Member.Name;
MemberObj["Type"] = Member.Type.Name;
MemberObj["IsStatic"] = Member.IsStatic;

if (Member.Access == AccessSpecifier::AS_public)
PubMembersArrayRef.push_back(MemberVal);
Expand All @@ -571,12 +572,16 @@ static void serializeInfo(const RecordInfo &I, json::Object &Obj,
serializeInfo(Base, BaseObj, RepositoryUrl);
});

if (!I.Parents.empty())
if (!I.Parents.empty()) {
serializeArray(I.Parents, Obj, "Parents", SerializeReferenceLambda);
Obj["HasParents"] = true;
}

if (!I.VirtualParents.empty())
if (!I.VirtualParents.empty()) {
serializeArray(I.VirtualParents, Obj, "VirtualParents",
SerializeReferenceLambda);
Obj["HasVirtualParents"] = true;
}

if (I.Template)
serializeInfo(I.Template.value(), Obj);
Expand Down
4 changes: 2 additions & 2 deletions clang-tools-extra/clang-doc/assets/class-template.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@
<div>
{{#PublicMembers}}
<div id="{{Name}}" class="delimiter-container">
<pre><code class="language-cpp code-clang-doc" >{{Type}} {{Name}}</code></pre>
<pre><code class="language-cpp code-clang-doc" >{{#IsStatic}}static {{/IsStatic}}{{Type}} {{Name}}</code></pre>
{{#MemberComments}}
<div>
{{>Comments}}
Expand All @@ -171,7 +171,7 @@
<div>
{{#Obj}}
<div id="{{Name}}" class="delimiter-container">
<pre><code class="language-cpp code-clang-doc" >{{Type}} {{Name}}</code></pre>
<pre><code class="language-cpp code-clang-doc" >{{#IsStatic}}static {{/IsStatic}}{{Type}} {{Name}}</code></pre>
{{#MemberComments}}
<div>
{{>Comments}}
Expand Down
2 changes: 1 addition & 1 deletion clang-tools-extra/test/clang-doc/basic-project.mustache.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ HTML-CALC: <div id="public_val" class="delimiter-container">
HTML-CALC: <pre><code class="language-cpp code-clang-doc" >int public_val</code></pre>
HTML-CALC: </div>
HTML-CALC: <div id="static_val" class="delimiter-container">
HTML-CALC: <pre><code class="language-cpp code-clang-doc" >const int static_val</code></pre>
HTML-CALC: <pre><code class="language-cpp code-clang-doc" >static const int static_val</code></pre>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: </section>
Expand Down
2 changes: 2 additions & 0 deletions clang-tools-extra/test/clang-doc/json/class.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ struct MyClass {
// CHECK-NEXT: ],
// CHECK-NEXT: "ProtectedMembers": [
// CHECK-NEXT: {
// CHECK-NEXT: "IsStatic": false,
// CHECK-NEXT: "Name": "ProtectedField",
// CHECK-NEXT: "Type": "int"
// CHECK-NEXT: }
Expand Down Expand Up @@ -198,6 +199,7 @@ struct MyClass {
// CHECK-NEXT: },
// CHECK: "PublicMembers": [
// CHECK-NEXT: {
// CHECK-NEXT: "IsStatic": false,
// CHECK-NEXT: "Name": "PublicField",
// CHECK-NEXT: "Type": "int"
// CHECK-NEXT: }
Expand Down
111 changes: 111 additions & 0 deletions clang-tools-extra/test/clang-doc/json/inheritance.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
// RUN: rm -rf %t && mkdir -p %t
// RUN: clang-doc --output=%t --format=json --executor=standalone %s
// RUN: FileCheck %s < %t/json/GlobalNamespace/_ZTV7MyClass.json

class Virtual {};
class Foo : virtual Virtual {};
class Bar : Foo {};
class Fizz : virtual Virtual {};
class Buzz : Fizz {};

class MyClass : Bar, Buzz {};

// CHECK: "Bases": [
// CHECK-NEXT: {
// CHECK-NEXT: "Access": "private",
// CHECK-NEXT: "InfoType": "record",
// CHECK-NEXT: "IsParent": true,
// CHECK-NEXT: "IsTypedef": false,
// CHECK-NEXT: "IsVirtual": false,
// CHECK-NEXT: "MangledName": "",
// CHECK-NEXT: "Name": "Bar",
// CHECK-NEXT: "Path": "GlobalNamespace",
// CHECK-NEXT: "TagType": "struct",
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "Access": "private",
// CHECK-NEXT: "InfoType": "record",
// CHECK-NEXT: "IsParent": false,
// CHECK-NEXT: "IsTypedef": false,
// CHECK-NEXT: "IsVirtual": false,
// CHECK-NEXT: "MangledName": "",
// CHECK-NEXT: "Name": "Foo",
// CHECK-NEXT: "Path": "GlobalNamespace",
// CHECK-NEXT: "TagType": "struct",
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "Access": "private",
// CHECK-NEXT: "InfoType": "record",
// CHECK-NEXT: "IsParent": false,
// CHECK-NEXT: "IsTypedef": false,
// CHECK-NEXT: "IsVirtual": true,
// CHECK-NEXT: "MangledName": "",
// CHECK-NEXT: "Name": "Virtual",
// CHECK-NEXT: "Path": "GlobalNamespace",
// CHECK-NEXT: "TagType": "struct",
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "Access": "private",
// CHECK-NEXT: "InfoType": "record",
// CHECK-NEXT: "IsParent": true,
// CHECK-NEXT: "IsTypedef": false,
// CHECK-NEXT: "IsVirtual": false,
// CHECK-NEXT: "MangledName": "",
// CHECK-NEXT: "Name": "Buzz",
// CHECK-NEXT: "Path": "GlobalNamespace",
// CHECK-NEXT: "TagType": "struct",
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "Access": "private",
// CHECK-NEXT: "InfoType": "record",
// CHECK-NEXT: "IsParent": false,
// CHECK-NEXT: "IsTypedef": false,
// CHECK-NEXT: "IsVirtual": false,
// CHECK-NEXT: "MangledName": "",
// CHECK-NEXT: "Name": "Fizz",
// CHECK-NEXT: "Path": "GlobalNamespace",
// CHECK-NEXT: "TagType": "struct",
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "Access": "private",
// CHECK-NEXT: "End": true,
// CHECK-NEXT: "InfoType": "record",
// CHECK-NEXT: "IsParent": false,
// CHECK-NEXT: "IsTypedef": false,
// CHECK-NEXT: "IsVirtual": true,
// CHECK-NEXT: "MangledName": "",
// CHECK-NEXT: "Name": "Virtual",
// CHECK-NEXT: "Path": "GlobalNamespace",
// CHECK-NEXT: "TagType": "struct",
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
// CHECK-NEXT: }
// CHECK-NEXT: ],
// CHECK: "Parents": [
// CHECK-NEXT: {
// CHECK-NEXT: "Name": "Bar",
// CHECK-NEXT: "Path": "GlobalNamespace",
// CHECK-NEXT: "QualName": "Bar",
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
// CHECK-NEXT: },
// CHECK-NEXT: {
// CHECK-NEXT: "End": true,
// CHECK-NEXT: "Name": "Buzz",
// CHECK-NEXT: "Path": "GlobalNamespace",
// CHECK-NEXT: "QualName": "Buzz",
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
// CHECK-NEXT: }
// CHECK-NEXT: ],
// CHECK: "VirtualParents": [
// CHECK-NEXT: {
// CHECK-NEXT: "End": true,
// CHECK-NEXT: "Name": "Virtual",
// CHECK-NEXT: "Path": "GlobalNamespace",
// CHECK-NEXT: "QualName": "Virtual",
// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
// CHECK-NEXT: }
// CHECK-NEXT: ]
4 changes: 4 additions & 0 deletions clang-tools-extra/unittests/clang-doc/JSONGeneratorTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ TEST_F(JSONGeneratorTest, emitRecordJSON) {
],
"PublicMembers": [
{
"IsStatic": false,
"Name": "N",
"Type": "int"
}
Expand All @@ -115,8 +116,10 @@ TEST_F(JSONGeneratorTest, emitRecordJSON) {
}
],
"HasEnums": true,
"HasParents": true,
"HasPublicFunctions": true,
"HasRecords": true,
"HasVirtualParents": true,
"InfoType": "record",
"IsTypedef": false,
"Location": {
Expand All @@ -140,6 +143,7 @@ TEST_F(JSONGeneratorTest, emitRecordJSON) {
"Path": "GlobalNamespace",
"ProtectedMembers": [
{
"IsStatic": false,
"Name": "X",
"Type": "int"
}
Expand Down