[clang-doc] Track if a type is a template or builtin

[ilovepi]

Originally part of #133161. This patch adds preliminary tracking
for of TypeInfo, by tracking if the type is a builtin or template.

The new functionality is not yet exercised.

Co-authored-by: Peter Chou [email protected]

[ilovepi]

• [clang-doc] Track if a type is a template or builtin #138067 👈 (View in Graphite)
• [clang-doc] Update clang-doc tool to enable mustache templates #138066
• [clang-doc] Update serializer for improved template handling #138065
• [clang-doc] Implement setupTemplateValue for HTMLMustacheGenerator #138064
• [clang-doc] Extract Info into JSON values #138063
• [clang-doc] Add helpers for Template config #138062
• [clang-doc] Add HTMLMustacheGenerator methods #138061
• [clang-doc] Add HTMLMustacheGenerator.cpp #138060
• [clang-doc] Add Mustache template assets #138059
• [clang-doc] Track Descriptions and TypeDeclaration for types #138058
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[llvmbot]

@llvm/pr-subscribers-clang-tools-extra

Author: Paul Kirth (ilovepi)

Changes

Originally part of #133161. This patch adds preliminary tracking
for of TypeInfo, by tracking if the type is a builtin or template.

The new functionality is not yet exercised.

Co-authored-by: Peter Chou <[email protected]>

---

Full diff: https://github.com/llvm/llvm-project/pull/138067.diff

2 Files Affected:

• (modified) clang-tools-extra/clang-doc/Representation.h (+3)
• (modified) clang-tools-extra/clang-doc/Serialize.cpp (+12-5)

diff --git a/clang-tools-extra/clang-doc/Representation.h b/clang-tools-extra/clang-doc/Representation.h
index 89e264f541a76..4d34109c399da 100644
--- a/clang-tools-extra/clang-doc/Representation.h
+++ b/clang-tools-extra/clang-doc/Representation.h
@@ -163,6 +163,9 @@ struct TypeInfo {
   bool operator==(const TypeInfo &Other) const { return Type == Other.Type; }
 
   Reference Type; // Referenced type in this info.
+
+  bool IsTemplate = false;
+  bool IsBuiltIn = false;
 };
 
 // Represents one template parameter.
diff --git a/clang-tools-extra/clang-doc/Serialize.cpp b/clang-tools-extra/clang-doc/Serialize.cpp
index 21cf44c1ccd35..c6ca43d148440 100644
--- a/clang-tools-extra/clang-doc/Serialize.cpp
+++ b/clang-tools-extra/clang-doc/Serialize.cpp
@@ -424,9 +424,12 @@ static RecordDecl *getRecordDeclForType(const QualType &T) {
 static TypeInfo getTypeInfoForType(const QualType &T,
                                    const PrintingPolicy &Policy) {
   const TagDecl *TD = getTagDeclForType(T);
-  if (!TD)
-    return TypeInfo(Reference(SymbolID(), T.getAsString(Policy)));
-
+  if (!TD) {
+    TypeInfo TI = TypeInfo(Reference(SymbolID(), T.getAsString(Policy)));
+    TI.IsBuiltIn = T->isBuiltinType();
+    TI.IsTemplate = T->isTemplateTypeParmType();
+    return TI;
+  }
   InfoType IT;
   if (isa<EnumDecl>(TD)) {
     IT = InfoType::IT_enum;
@@ -435,8 +438,12 @@ static TypeInfo getTypeInfoForType(const QualType &T,
   } else {
     IT = InfoType::IT_default;
   }
-  return TypeInfo(Reference(getUSRForDecl(TD), TD->getNameAsString(), IT,
-                            T.getAsString(Policy), getInfoRelativePath(TD)));
+  Reference R = Reference(getUSRForDecl(TD), TD->getNameAsString(), IT,
+                          T.getAsString(Policy), getInfoRelativePath(TD));
+  TypeInfo TI = TypeInfo(R);
+  TI.IsBuiltIn = T->isBuiltinType();
+  TI.IsTemplate = T->isTemplateTypeParmType();
+  return TI;
 }
 
 static bool isPublic(const clang::AccessSpecifier AS,

[ilovepi]

@PeterChou1 can you provide some context about how you originally expected these fields to be used/consumed? Here we bake them into the representation and serialize them, but I don't see any handling of them in the original patch. How should they be used by the different backends?

[ilovepi]

Merge activity

• May 28, 5:18 AM UTC: A user started a stack merge that includes this pull request via Graphite.
• May 28, 5:26 AM UTC: Graphite rebased this pull request as part of a merge.
• May 28, 5:28 AM UTC: @ilovepi merged this pull request with Graphite.