1 //===--- JSONNodeDumper.h - Printing of AST nodes to JSON -----------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // This file implements AST dumping of components of individual AST nodes to 10 // a JSON. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #ifndef LLVM_CLANG_AST_JSONNODEDUMPER_H 15 #define LLVM_CLANG_AST_JSONNODEDUMPER_H 16 17 #include "clang/AST/ASTContext.h" 18 #include "clang/AST/ASTDumperUtils.h" 19 #include "clang/AST/ASTNodeTraverser.h" 20 #include "clang/AST/AttrVisitor.h" 21 #include "clang/AST/CommentCommandTraits.h" 22 #include "clang/AST/CommentVisitor.h" 23 #include "clang/AST/ExprConcepts.h" 24 #include "clang/AST/ExprCXX.h" 25 #include "clang/AST/Mangle.h" 26 #include "clang/AST/Type.h" 27 #include "llvm/Support/JSON.h" 28 29 namespace clang { 30 31 class APValue; 32 33 class NodeStreamer { 34 bool FirstChild = true; 35 bool TopLevel = true; 36 llvm::SmallVector<std::function<void(bool IsLastChild)>, 32> Pending; 37 38 protected: 39 llvm::json::OStream JOS; 40 41 public: 42 /// Add a child of the current node. Calls DoAddChild without arguments 43 template <typename Fn> void AddChild(Fn DoAddChild) { 44 return AddChild("", DoAddChild); 45 } 46 47 /// Add a child of the current node with an optional label. 48 /// Calls DoAddChild without arguments. 49 template <typename Fn> void AddChild(StringRef Label, Fn DoAddChild) { 50 // If we're at the top level, there's nothing interesting to do; just 51 // run the dumper. 52 if (TopLevel) { 53 TopLevel = false; 54 JOS.objectBegin(); 55 56 DoAddChild(); 57 58 while (!Pending.empty()) { 59 Pending.back()(true); 60 Pending.pop_back(); 61 } 62 63 JOS.objectEnd(); 64 TopLevel = true; 65 return; 66 } 67 68 // We need to capture an owning-string in the lambda because the lambda 69 // is invoked in a deferred manner. 70 std::string LabelStr(!Label.empty() ? Label : "inner"); 71 bool WasFirstChild = FirstChild; 72 auto DumpWithIndent = [=](bool IsLastChild) { 73 if (WasFirstChild) { 74 JOS.attributeBegin(LabelStr); 75 JOS.arrayBegin(); 76 } 77 78 FirstChild = true; 79 unsigned Depth = Pending.size(); 80 JOS.objectBegin(); 81 82 DoAddChild(); 83 84 // If any children are left, they're the last at their nesting level. 85 // Dump those ones out now. 86 while (Depth < Pending.size()) { 87 Pending.back()(true); 88 this->Pending.pop_back(); 89 } 90 91 JOS.objectEnd(); 92 93 if (IsLastChild) { 94 JOS.arrayEnd(); 95 JOS.attributeEnd(); 96 } 97 }; 98 99 if (FirstChild) { 100 Pending.push_back(std::move(DumpWithIndent)); 101 } else { 102 Pending.back()(false); 103 Pending.back() = std::move(DumpWithIndent); 104 } 105 FirstChild = false; 106 } 107 108 NodeStreamer(raw_ostream &OS) : JOS(OS, 2) {} 109 }; 110 111 // Dumps AST nodes in JSON format. There is no implied stability for the 112 // content or format of the dump between major releases of Clang, other than it 113 // being valid JSON output. Further, there is no requirement that the 114 // information dumped is a complete representation of the AST, only that the 115 // information presented is correct. 116 class JSONNodeDumper 117 : public ConstAttrVisitor<JSONNodeDumper>, 118 public comments::ConstCommentVisitor<JSONNodeDumper, void, 119 const comments::FullComment *>, 120 public ConstTemplateArgumentVisitor<JSONNodeDumper>, 121 public ConstStmtVisitor<JSONNodeDumper>, 122 public TypeVisitor<JSONNodeDumper>, 123 public ConstDeclVisitor<JSONNodeDumper>, 124 public NodeStreamer { 125 friend class JSONDumper; 126 127 const SourceManager &SM; 128 ASTContext& Ctx; 129 ASTNameGenerator ASTNameGen; 130 PrintingPolicy PrintPolicy; 131 const comments::CommandTraits *Traits; 132 StringRef LastLocFilename, LastLocPresumedFilename; 133 unsigned LastLocLine, LastLocPresumedLine; 134 135 using InnerAttrVisitor = ConstAttrVisitor<JSONNodeDumper>; 136 using InnerCommentVisitor = 137 comments::ConstCommentVisitor<JSONNodeDumper, void, 138 const comments::FullComment *>; 139 using InnerTemplateArgVisitor = ConstTemplateArgumentVisitor<JSONNodeDumper>; 140 using InnerStmtVisitor = ConstStmtVisitor<JSONNodeDumper>; 141 using InnerTypeVisitor = TypeVisitor<JSONNodeDumper>; 142 using InnerDeclVisitor = ConstDeclVisitor<JSONNodeDumper>; 143 144 void attributeOnlyIfTrue(StringRef Key, bool Value) { 145 if (Value) 146 JOS.attribute(Key, Value); 147 } 148 149 void writeIncludeStack(PresumedLoc Loc, bool JustFirst = false); 150 151 // Writes the attributes of a SourceLocation object without. 152 void writeBareSourceLocation(SourceLocation Loc, bool IsSpelling); 153 154 // Writes the attributes of a SourceLocation to JSON based on its presumed 155 // spelling location. If the given location represents a macro invocation, 156 // this outputs two sub-objects: one for the spelling and one for the 157 // expansion location. 158 void writeSourceLocation(SourceLocation Loc); 159 void writeSourceRange(SourceRange R); 160 std::string createPointerRepresentation(const void *Ptr); 161 llvm::json::Object createQualType(QualType QT, bool Desugar = true); 162 llvm::json::Object createBareDeclRef(const Decl *D); 163 llvm::json::Object createFPOptions(FPOptionsOverride FPO); 164 void writeBareDeclRef(const Decl *D); 165 llvm::json::Object createCXXRecordDefinitionData(const CXXRecordDecl *RD); 166 llvm::json::Object createCXXBaseSpecifier(const CXXBaseSpecifier &BS); 167 std::string createAccessSpecifier(AccessSpecifier AS); 168 llvm::json::Array createCastPath(const CastExpr *C); 169 170 void writePreviousDeclImpl(...) {} 171 172 template <typename T> void writePreviousDeclImpl(const Mergeable<T> *D) { 173 const T *First = D->getFirstDecl(); 174 if (First != D) 175 JOS.attribute("firstRedecl", createPointerRepresentation(First)); 176 } 177 178 template <typename T> void writePreviousDeclImpl(const Redeclarable<T> *D) { 179 const T *Prev = D->getPreviousDecl(); 180 if (Prev) 181 JOS.attribute("previousDecl", createPointerRepresentation(Prev)); 182 } 183 void addPreviousDeclaration(const Decl *D); 184 185 StringRef getCommentCommandName(unsigned CommandID) const; 186 187 public: 188 JSONNodeDumper(raw_ostream &OS, const SourceManager &SrcMgr, ASTContext &Ctx, 189 const PrintingPolicy &PrintPolicy, 190 const comments::CommandTraits *Traits) 191 : NodeStreamer(OS), SM(SrcMgr), Ctx(Ctx), ASTNameGen(Ctx), 192 PrintPolicy(PrintPolicy), Traits(Traits), LastLocLine(0), 193 LastLocPresumedLine(0) {} 194 195 void Visit(const Attr *A); 196 void Visit(const Stmt *Node); 197 void Visit(const Type *T); 198 void Visit(QualType T); 199 void Visit(const Decl *D); 200 201 void Visit(const comments::Comment *C, const comments::FullComment *FC); 202 void Visit(const TemplateArgument &TA, SourceRange R = {}, 203 const Decl *From = nullptr, StringRef Label = {}); 204 void Visit(const CXXCtorInitializer *Init); 205 void Visit(const OMPClause *C); 206 void Visit(const BlockDecl::Capture &C); 207 void Visit(const GenericSelectionExpr::ConstAssociation &A); 208 void Visit(const concepts::Requirement *R); 209 void Visit(const APValue &Value, QualType Ty); 210 211 void VisitTypedefType(const TypedefType *TT); 212 void VisitFunctionType(const FunctionType *T); 213 void VisitFunctionProtoType(const FunctionProtoType *T); 214 void VisitRValueReferenceType(const ReferenceType *RT); 215 void VisitArrayType(const ArrayType *AT); 216 void VisitConstantArrayType(const ConstantArrayType *CAT); 217 void VisitDependentSizedExtVectorType(const DependentSizedExtVectorType *VT); 218 void VisitVectorType(const VectorType *VT); 219 void VisitUnresolvedUsingType(const UnresolvedUsingType *UUT); 220 void VisitUnaryTransformType(const UnaryTransformType *UTT); 221 void VisitTagType(const TagType *TT); 222 void VisitTemplateTypeParmType(const TemplateTypeParmType *TTPT); 223 void VisitAutoType(const AutoType *AT); 224 void VisitTemplateSpecializationType(const TemplateSpecializationType *TST); 225 void VisitInjectedClassNameType(const InjectedClassNameType *ICNT); 226 void VisitObjCInterfaceType(const ObjCInterfaceType *OIT); 227 void VisitPackExpansionType(const PackExpansionType *PET); 228 void VisitElaboratedType(const ElaboratedType *ET); 229 void VisitMacroQualifiedType(const MacroQualifiedType *MQT); 230 void VisitMemberPointerType(const MemberPointerType *MPT); 231 232 void VisitNamedDecl(const NamedDecl *ND); 233 void VisitTypedefDecl(const TypedefDecl *TD); 234 void VisitTypeAliasDecl(const TypeAliasDecl *TAD); 235 void VisitNamespaceDecl(const NamespaceDecl *ND); 236 void VisitUsingDirectiveDecl(const UsingDirectiveDecl *UDD); 237 void VisitNamespaceAliasDecl(const NamespaceAliasDecl *NAD); 238 void VisitUsingDecl(const UsingDecl *UD); 239 void VisitUsingEnumDecl(const UsingEnumDecl *UED); 240 void VisitUsingShadowDecl(const UsingShadowDecl *USD); 241 void VisitVarDecl(const VarDecl *VD); 242 void VisitFieldDecl(const FieldDecl *FD); 243 void VisitFunctionDecl(const FunctionDecl *FD); 244 void VisitEnumDecl(const EnumDecl *ED); 245 void VisitEnumConstantDecl(const EnumConstantDecl *ECD); 246 void VisitRecordDecl(const RecordDecl *RD); 247 void VisitCXXRecordDecl(const CXXRecordDecl *RD); 248 void VisitTemplateTypeParmDecl(const TemplateTypeParmDecl *D); 249 void VisitNonTypeTemplateParmDecl(const NonTypeTemplateParmDecl *D); 250 void VisitTemplateTemplateParmDecl(const TemplateTemplateParmDecl *D); 251 void VisitLinkageSpecDecl(const LinkageSpecDecl *LSD); 252 void VisitAccessSpecDecl(const AccessSpecDecl *ASD); 253 void VisitFriendDecl(const FriendDecl *FD); 254 255 void VisitObjCIvarDecl(const ObjCIvarDecl *D); 256 void VisitObjCMethodDecl(const ObjCMethodDecl *D); 257 void VisitObjCTypeParamDecl(const ObjCTypeParamDecl *D); 258 void VisitObjCCategoryDecl(const ObjCCategoryDecl *D); 259 void VisitObjCCategoryImplDecl(const ObjCCategoryImplDecl *D); 260 void VisitObjCProtocolDecl(const ObjCProtocolDecl *D); 261 void VisitObjCInterfaceDecl(const ObjCInterfaceDecl *D); 262 void VisitObjCImplementationDecl(const ObjCImplementationDecl *D); 263 void VisitObjCCompatibleAliasDecl(const ObjCCompatibleAliasDecl *D); 264 void VisitObjCPropertyDecl(const ObjCPropertyDecl *D); 265 void VisitObjCPropertyImplDecl(const ObjCPropertyImplDecl *D); 266 void VisitBlockDecl(const BlockDecl *D); 267 268 void VisitDeclRefExpr(const DeclRefExpr *DRE); 269 void VisitSYCLUniqueStableNameExpr(const SYCLUniqueStableNameExpr *E); 270 void VisitPredefinedExpr(const PredefinedExpr *PE); 271 void VisitUnaryOperator(const UnaryOperator *UO); 272 void VisitBinaryOperator(const BinaryOperator *BO); 273 void VisitCompoundAssignOperator(const CompoundAssignOperator *CAO); 274 void VisitMemberExpr(const MemberExpr *ME); 275 void VisitCXXNewExpr(const CXXNewExpr *NE); 276 void VisitCXXDeleteExpr(const CXXDeleteExpr *DE); 277 void VisitCXXThisExpr(const CXXThisExpr *TE); 278 void VisitCastExpr(const CastExpr *CE); 279 void VisitImplicitCastExpr(const ImplicitCastExpr *ICE); 280 void VisitCallExpr(const CallExpr *CE); 281 void VisitUnaryExprOrTypeTraitExpr(const UnaryExprOrTypeTraitExpr *TTE); 282 void VisitSizeOfPackExpr(const SizeOfPackExpr *SOPE); 283 void VisitUnresolvedLookupExpr(const UnresolvedLookupExpr *ULE); 284 void VisitAddrLabelExpr(const AddrLabelExpr *ALE); 285 void VisitCXXTypeidExpr(const CXXTypeidExpr *CTE); 286 void VisitConstantExpr(const ConstantExpr *CE); 287 void VisitInitListExpr(const InitListExpr *ILE); 288 void VisitGenericSelectionExpr(const GenericSelectionExpr *GSE); 289 void VisitCXXUnresolvedConstructExpr(const CXXUnresolvedConstructExpr *UCE); 290 void VisitCXXConstructExpr(const CXXConstructExpr *CE); 291 void VisitExprWithCleanups(const ExprWithCleanups *EWC); 292 void VisitCXXBindTemporaryExpr(const CXXBindTemporaryExpr *BTE); 293 void VisitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *MTE); 294 void VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *ME); 295 void VisitRequiresExpr(const RequiresExpr *RE); 296 297 void VisitObjCEncodeExpr(const ObjCEncodeExpr *OEE); 298 void VisitObjCMessageExpr(const ObjCMessageExpr *OME); 299 void VisitObjCBoxedExpr(const ObjCBoxedExpr *OBE); 300 void VisitObjCSelectorExpr(const ObjCSelectorExpr *OSE); 301 void VisitObjCProtocolExpr(const ObjCProtocolExpr *OPE); 302 void VisitObjCPropertyRefExpr(const ObjCPropertyRefExpr *OPRE); 303 void VisitObjCSubscriptRefExpr(const ObjCSubscriptRefExpr *OSRE); 304 void VisitObjCIvarRefExpr(const ObjCIvarRefExpr *OIRE); 305 void VisitObjCBoolLiteralExpr(const ObjCBoolLiteralExpr *OBLE); 306 307 void VisitIntegerLiteral(const IntegerLiteral *IL); 308 void VisitCharacterLiteral(const CharacterLiteral *CL); 309 void VisitFixedPointLiteral(const FixedPointLiteral *FPL); 310 void VisitFloatingLiteral(const FloatingLiteral *FL); 311 void VisitStringLiteral(const StringLiteral *SL); 312 void VisitCXXBoolLiteralExpr(const CXXBoolLiteralExpr *BLE); 313 314 void VisitIfStmt(const IfStmt *IS); 315 void VisitSwitchStmt(const SwitchStmt *SS); 316 void VisitCaseStmt(const CaseStmt *CS); 317 void VisitLabelStmt(const LabelStmt *LS); 318 void VisitGotoStmt(const GotoStmt *GS); 319 void VisitWhileStmt(const WhileStmt *WS); 320 void VisitObjCAtCatchStmt(const ObjCAtCatchStmt *OACS); 321 void VisitCompoundStmt(const CompoundStmt *IS); 322 323 void VisitNullTemplateArgument(const TemplateArgument &TA); 324 void VisitTypeTemplateArgument(const TemplateArgument &TA); 325 void VisitDeclarationTemplateArgument(const TemplateArgument &TA); 326 void VisitNullPtrTemplateArgument(const TemplateArgument &TA); 327 void VisitIntegralTemplateArgument(const TemplateArgument &TA); 328 void VisitTemplateTemplateArgument(const TemplateArgument &TA); 329 void VisitTemplateExpansionTemplateArgument(const TemplateArgument &TA); 330 void VisitExpressionTemplateArgument(const TemplateArgument &TA); 331 void VisitPackTemplateArgument(const TemplateArgument &TA); 332 333 void visitTextComment(const comments::TextComment *C, 334 const comments::FullComment *); 335 void visitInlineCommandComment(const comments::InlineCommandComment *C, 336 const comments::FullComment *); 337 void visitHTMLStartTagComment(const comments::HTMLStartTagComment *C, 338 const comments::FullComment *); 339 void visitHTMLEndTagComment(const comments::HTMLEndTagComment *C, 340 const comments::FullComment *); 341 void visitBlockCommandComment(const comments::BlockCommandComment *C, 342 const comments::FullComment *); 343 void visitParamCommandComment(const comments::ParamCommandComment *C, 344 const comments::FullComment *FC); 345 void visitTParamCommandComment(const comments::TParamCommandComment *C, 346 const comments::FullComment *FC); 347 void visitVerbatimBlockComment(const comments::VerbatimBlockComment *C, 348 const comments::FullComment *); 349 void 350 visitVerbatimBlockLineComment(const comments::VerbatimBlockLineComment *C, 351 const comments::FullComment *); 352 void visitVerbatimLineComment(const comments::VerbatimLineComment *C, 353 const comments::FullComment *); 354 }; 355 356 class JSONDumper : public ASTNodeTraverser<JSONDumper, JSONNodeDumper> { 357 JSONNodeDumper NodeDumper; 358 359 template <typename SpecializationDecl> 360 void writeTemplateDeclSpecialization(const SpecializationDecl *SD, 361 bool DumpExplicitInst, 362 bool DumpRefOnly) { 363 bool DumpedAny = false; 364 for (const auto *RedeclWithBadType : SD->redecls()) { 365 // FIXME: The redecls() range sometimes has elements of a less-specific 366 // type. (In particular, ClassTemplateSpecializationDecl::redecls() gives 367 // us TagDecls, and should give CXXRecordDecls). 368 const auto *Redecl = dyn_cast<SpecializationDecl>(RedeclWithBadType); 369 if (!Redecl) { 370 // Found the injected-class-name for a class template. This will be 371 // dumped as part of its surrounding class so we don't need to dump it 372 // here. 373 assert(isa<CXXRecordDecl>(RedeclWithBadType) && 374 "expected an injected-class-name"); 375 continue; 376 } 377 378 switch (Redecl->getTemplateSpecializationKind()) { 379 case TSK_ExplicitInstantiationDeclaration: 380 case TSK_ExplicitInstantiationDefinition: 381 if (!DumpExplicitInst) 382 break; 383 LLVM_FALLTHROUGH; 384 case TSK_Undeclared: 385 case TSK_ImplicitInstantiation: 386 if (DumpRefOnly) 387 NodeDumper.AddChild([=] { NodeDumper.writeBareDeclRef(Redecl); }); 388 else 389 Visit(Redecl); 390 DumpedAny = true; 391 break; 392 case TSK_ExplicitSpecialization: 393 break; 394 } 395 } 396 397 // Ensure we dump at least one decl for each specialization. 398 if (!DumpedAny) 399 NodeDumper.AddChild([=] { NodeDumper.writeBareDeclRef(SD); }); 400 } 401 402 template <typename TemplateDecl> 403 void writeTemplateDecl(const TemplateDecl *TD, bool DumpExplicitInst) { 404 // FIXME: it would be nice to dump template parameters and specializations 405 // to their own named arrays rather than shoving them into the "inner" 406 // array. However, template declarations are currently being handled at the 407 // wrong "level" of the traversal hierarchy and so it is difficult to 408 // achieve without losing information elsewhere. 409 410 dumpTemplateParameters(TD->getTemplateParameters()); 411 412 Visit(TD->getTemplatedDecl()); 413 414 for (const auto *Child : TD->specializations()) 415 writeTemplateDeclSpecialization(Child, DumpExplicitInst, 416 !TD->isCanonicalDecl()); 417 } 418 419 public: 420 JSONDumper(raw_ostream &OS, const SourceManager &SrcMgr, ASTContext &Ctx, 421 const PrintingPolicy &PrintPolicy, 422 const comments::CommandTraits *Traits) 423 : NodeDumper(OS, SrcMgr, Ctx, PrintPolicy, Traits) {} 424 425 JSONNodeDumper &doGetNodeDelegate() { return NodeDumper; } 426 427 void VisitFunctionTemplateDecl(const FunctionTemplateDecl *FTD) { 428 writeTemplateDecl(FTD, true); 429 } 430 void VisitClassTemplateDecl(const ClassTemplateDecl *CTD) { 431 writeTemplateDecl(CTD, false); 432 } 433 void VisitVarTemplateDecl(const VarTemplateDecl *VTD) { 434 writeTemplateDecl(VTD, false); 435 } 436 }; 437 438 } // namespace clang 439 440 #endif // LLVM_CLANG_AST_JSONNODEDUMPER_H 441