1 //===--- ASTDumper.cpp - Dumping implementation for ASTs ------------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file implements the AST dump methods, which dump out the 11 // AST in a form that exposes type details and other fields. 12 // 13 //===----------------------------------------------------------------------===// 14 15 #include "clang/AST/ASTContext.h" 16 #include "clang/AST/Attr.h" 17 #include "clang/AST/CommentVisitor.h" 18 #include "clang/AST/DeclCXX.h" 19 #include "clang/AST/DeclLookups.h" 20 #include "clang/AST/DeclObjC.h" 21 #include "clang/AST/DeclVisitor.h" 22 #include "clang/AST/StmtVisitor.h" 23 #include "clang/AST/TypeVisitor.h" 24 #include "clang/Basic/Module.h" 25 #include "clang/Basic/SourceManager.h" 26 #include "llvm/Support/raw_ostream.h" 27 using namespace clang; 28 using namespace clang::comments; 29 30 //===----------------------------------------------------------------------===// 31 // ASTDumper Visitor 32 //===----------------------------------------------------------------------===// 33 34 namespace { 35 // Colors used for various parts of the AST dump 36 // Do not use bold yellow for any text. It is hard to read on white screens. 37 38 struct TerminalColor { 39 raw_ostream::Colors Color; 40 bool Bold; 41 }; 42 43 // Red - CastColor 44 // Green - TypeColor 45 // Bold Green - DeclKindNameColor, UndeserializedColor 46 // Yellow - AddressColor, LocationColor 47 // Blue - CommentColor, NullColor, IndentColor 48 // Bold Blue - AttrColor 49 // Bold Magenta - StmtColor 50 // Cyan - ValueKindColor, ObjectKindColor 51 // Bold Cyan - ValueColor, DeclNameColor 52 53 // Decl kind names (VarDecl, FunctionDecl, etc) 54 static const TerminalColor DeclKindNameColor = { raw_ostream::GREEN, true }; 55 // Attr names (CleanupAttr, GuardedByAttr, etc) 56 static const TerminalColor AttrColor = { raw_ostream::BLUE, true }; 57 // Statement names (DeclStmt, ImplicitCastExpr, etc) 58 static const TerminalColor StmtColor = { raw_ostream::MAGENTA, true }; 59 // Comment names (FullComment, ParagraphComment, TextComment, etc) 60 static const TerminalColor CommentColor = { raw_ostream::BLUE, false }; 61 62 // Type names (int, float, etc, plus user defined types) 63 static const TerminalColor TypeColor = { raw_ostream::GREEN, false }; 64 65 // Pointer address 66 static const TerminalColor AddressColor = { raw_ostream::YELLOW, false }; 67 // Source locations 68 static const TerminalColor LocationColor = { raw_ostream::YELLOW, false }; 69 70 // lvalue/xvalue 71 static const TerminalColor ValueKindColor = { raw_ostream::CYAN, false }; 72 // bitfield/objcproperty/objcsubscript/vectorcomponent 73 static const TerminalColor ObjectKindColor = { raw_ostream::CYAN, false }; 74 75 // Null statements 76 static const TerminalColor NullColor = { raw_ostream::BLUE, false }; 77 78 // Undeserialized entities 79 static const TerminalColor UndeserializedColor = { raw_ostream::GREEN, true }; 80 81 // CastKind from CastExpr's 82 static const TerminalColor CastColor = { raw_ostream::RED, false }; 83 84 // Value of the statement 85 static const TerminalColor ValueColor = { raw_ostream::CYAN, true }; 86 // Decl names 87 static const TerminalColor DeclNameColor = { raw_ostream::CYAN, true }; 88 89 // Indents ( `, -. | ) 90 static const TerminalColor IndentColor = { raw_ostream::BLUE, false }; 91 92 class ASTDumper 93 : public ConstDeclVisitor<ASTDumper>, public ConstStmtVisitor<ASTDumper>, 94 public ConstCommentVisitor<ASTDumper>, public TypeVisitor<ASTDumper> { 95 raw_ostream &OS; 96 const CommandTraits *Traits; 97 const SourceManager *SM; 98 99 /// Pending[i] is an action to dump an entity at level i. 100 llvm::SmallVector<std::function<void(bool isLastChild)>, 32> Pending; 101 102 /// Indicates whether we're at the top level. 103 bool TopLevel; 104 105 /// Indicates if we're handling the first child after entering a new depth. 106 bool FirstChild; 107 108 /// Prefix for currently-being-dumped entity. 109 std::string Prefix; 110 111 /// Keep track of the last location we print out so that we can 112 /// print out deltas from then on out. 113 const char *LastLocFilename; 114 unsigned LastLocLine; 115 116 /// The \c FullComment parent of the comment being dumped. 117 const FullComment *FC; 118 119 bool ShowColors; 120 121 /// Dump a child of the current node. 122 template<typename Fn> void dumpChild(Fn doDumpChild) { 123 // If we're at the top level, there's nothing interesting to do; just 124 // run the dumper. 125 if (TopLevel) { 126 TopLevel = false; 127 doDumpChild(); 128 while (!Pending.empty()) { 129 Pending.back()(true); 130 Pending.pop_back(); 131 } 132 Prefix.clear(); 133 OS << "\n"; 134 TopLevel = true; 135 return; 136 } 137 138 const FullComment *OrigFC = FC; 139 auto dumpWithIndent = [this, doDumpChild, OrigFC](bool isLastChild) { 140 // Print out the appropriate tree structure and work out the prefix for 141 // children of this node. For instance: 142 // 143 // A Prefix = "" 144 // |-B Prefix = "| " 145 // | `-C Prefix = "| " 146 // `-D Prefix = " " 147 // |-E Prefix = " | " 148 // `-F Prefix = " " 149 // G Prefix = "" 150 // 151 // Note that the first level gets no prefix. 152 { 153 OS << '\n'; 154 ColorScope Color(*this, IndentColor); 155 OS << Prefix << (isLastChild ? '`' : '|') << '-'; 156 this->Prefix.push_back(isLastChild ? ' ' : '|'); 157 this->Prefix.push_back(' '); 158 } 159 160 FirstChild = true; 161 unsigned Depth = Pending.size(); 162 163 FC = OrigFC; 164 doDumpChild(); 165 166 // If any children are left, they're the last at their nesting level. 167 // Dump those ones out now. 168 while (Depth < Pending.size()) { 169 Pending.back()(true); 170 this->Pending.pop_back(); 171 } 172 173 // Restore the old prefix. 174 this->Prefix.resize(Prefix.size() - 2); 175 }; 176 177 if (FirstChild) { 178 Pending.push_back(std::move(dumpWithIndent)); 179 } else { 180 Pending.back()(false); 181 Pending.back() = std::move(dumpWithIndent); 182 } 183 FirstChild = false; 184 } 185 186 class ColorScope { 187 ASTDumper &Dumper; 188 public: 189 ColorScope(ASTDumper &Dumper, TerminalColor Color) 190 : Dumper(Dumper) { 191 if (Dumper.ShowColors) 192 Dumper.OS.changeColor(Color.Color, Color.Bold); 193 } 194 ~ColorScope() { 195 if (Dumper.ShowColors) 196 Dumper.OS.resetColor(); 197 } 198 }; 199 200 public: 201 ASTDumper(raw_ostream &OS, const CommandTraits *Traits, 202 const SourceManager *SM) 203 : OS(OS), Traits(Traits), SM(SM), TopLevel(true), FirstChild(true), 204 LastLocFilename(""), LastLocLine(~0U), FC(nullptr), 205 ShowColors(SM && SM->getDiagnostics().getShowColors()) { } 206 207 ASTDumper(raw_ostream &OS, const CommandTraits *Traits, 208 const SourceManager *SM, bool ShowColors) 209 : OS(OS), Traits(Traits), SM(SM), TopLevel(true), FirstChild(true), 210 LastLocFilename(""), LastLocLine(~0U), 211 ShowColors(ShowColors) { } 212 213 void dumpDecl(const Decl *D); 214 void dumpStmt(const Stmt *S); 215 void dumpFullComment(const FullComment *C); 216 217 // Utilities 218 void dumpPointer(const void *Ptr); 219 void dumpSourceRange(SourceRange R); 220 void dumpLocation(SourceLocation Loc); 221 void dumpBareType(QualType T, bool Desugar = true); 222 void dumpType(QualType T); 223 void dumpTypeAsChild(QualType T); 224 void dumpTypeAsChild(const Type *T); 225 void dumpBareDeclRef(const Decl *Node); 226 void dumpDeclRef(const Decl *Node, const char *Label = nullptr); 227 void dumpName(const NamedDecl *D); 228 bool hasNodes(const DeclContext *DC); 229 void dumpDeclContext(const DeclContext *DC); 230 void dumpLookups(const DeclContext *DC, bool DumpDecls); 231 void dumpAttr(const Attr *A); 232 233 // C++ Utilities 234 void dumpAccessSpecifier(AccessSpecifier AS); 235 void dumpCXXCtorInitializer(const CXXCtorInitializer *Init); 236 void dumpTemplateParameters(const TemplateParameterList *TPL); 237 void dumpTemplateArgumentListInfo(const TemplateArgumentListInfo &TALI); 238 void dumpTemplateArgumentLoc(const TemplateArgumentLoc &A); 239 void dumpTemplateArgumentList(const TemplateArgumentList &TAL); 240 void dumpTemplateArgument(const TemplateArgument &A, 241 SourceRange R = SourceRange()); 242 243 // Types 244 void VisitComplexType(const ComplexType *T) { 245 dumpTypeAsChild(T->getElementType()); 246 } 247 void VisitPointerType(const PointerType *T) { 248 dumpTypeAsChild(T->getPointeeType()); 249 } 250 void VisitBlockPointerType(const BlockPointerType *T) { 251 dumpTypeAsChild(T->getPointeeType()); 252 } 253 void VisitReferenceType(const ReferenceType *T) { 254 dumpTypeAsChild(T->getPointeeType()); 255 } 256 void VisitRValueReferenceType(const ReferenceType *T) { 257 if (T->isSpelledAsLValue()) 258 OS << " written as lvalue reference"; 259 VisitReferenceType(T); 260 } 261 void VisitMemberPointerType(const MemberPointerType *T) { 262 dumpTypeAsChild(T->getClass()); 263 dumpTypeAsChild(T->getPointeeType()); 264 } 265 void VisitArrayType(const ArrayType *T) { 266 switch (T->getSizeModifier()) { 267 case ArrayType::Normal: break; 268 case ArrayType::Static: OS << " static"; break; 269 case ArrayType::Star: OS << " *"; break; 270 } 271 OS << " " << T->getIndexTypeQualifiers().getAsString(); 272 dumpTypeAsChild(T->getElementType()); 273 } 274 void VisitConstantArrayType(const ConstantArrayType *T) { 275 OS << " " << T->getSize(); 276 VisitArrayType(T); 277 } 278 void VisitVariableArrayType(const VariableArrayType *T) { 279 OS << " "; 280 dumpSourceRange(T->getBracketsRange()); 281 VisitArrayType(T); 282 dumpStmt(T->getSizeExpr()); 283 } 284 void VisitDependentSizedArrayType(const DependentSizedArrayType *T) { 285 VisitArrayType(T); 286 OS << " "; 287 dumpSourceRange(T->getBracketsRange()); 288 dumpStmt(T->getSizeExpr()); 289 } 290 void VisitDependentSizedExtVectorType( 291 const DependentSizedExtVectorType *T) { 292 OS << " "; 293 dumpLocation(T->getAttributeLoc()); 294 dumpTypeAsChild(T->getElementType()); 295 dumpStmt(T->getSizeExpr()); 296 } 297 void VisitVectorType(const VectorType *T) { 298 switch (T->getVectorKind()) { 299 case VectorType::GenericVector: break; 300 case VectorType::AltiVecVector: OS << " altivec"; break; 301 case VectorType::AltiVecPixel: OS << " altivec pixel"; break; 302 case VectorType::AltiVecBool: OS << " altivec bool"; break; 303 case VectorType::NeonVector: OS << " neon"; break; 304 case VectorType::NeonPolyVector: OS << " neon poly"; break; 305 } 306 OS << " " << T->getNumElements(); 307 dumpTypeAsChild(T->getElementType()); 308 } 309 void VisitFunctionType(const FunctionType *T) { 310 auto EI = T->getExtInfo(); 311 if (EI.getNoReturn()) OS << " noreturn"; 312 if (EI.getProducesResult()) OS << " produces_result"; 313 if (EI.getHasRegParm()) OS << " regparm " << EI.getRegParm(); 314 OS << " " << FunctionType::getNameForCallConv(EI.getCC()); 315 dumpTypeAsChild(T->getReturnType()); 316 } 317 void VisitFunctionProtoType(const FunctionProtoType *T) { 318 auto EPI = T->getExtProtoInfo(); 319 if (EPI.HasTrailingReturn) OS << " trailing_return"; 320 if (T->isConst()) OS << " const"; 321 if (T->isVolatile()) OS << " volatile"; 322 if (T->isRestrict()) OS << " restrict"; 323 switch (EPI.RefQualifier) { 324 case RQ_None: break; 325 case RQ_LValue: OS << " &"; break; 326 case RQ_RValue: OS << " &&"; break; 327 } 328 // FIXME: Exception specification. 329 // FIXME: Consumed parameters. 330 VisitFunctionType(T); 331 for (QualType PT : T->getParamTypes()) 332 dumpTypeAsChild(PT); 333 if (EPI.Variadic) 334 dumpChild([=] { OS << "..."; }); 335 } 336 void VisitUnresolvedUsingType(const UnresolvedUsingType *T) { 337 dumpDeclRef(T->getDecl()); 338 } 339 void VisitTypedefType(const TypedefType *T) { 340 dumpDeclRef(T->getDecl()); 341 } 342 void VisitTypeOfExprType(const TypeOfExprType *T) { 343 dumpStmt(T->getUnderlyingExpr()); 344 } 345 void VisitDecltypeType(const DecltypeType *T) { 346 dumpStmt(T->getUnderlyingExpr()); 347 } 348 void VisitUnaryTransformType(const UnaryTransformType *T) { 349 switch (T->getUTTKind()) { 350 case UnaryTransformType::EnumUnderlyingType: 351 OS << " underlying_type"; 352 break; 353 } 354 dumpTypeAsChild(T->getBaseType()); 355 } 356 void VisitTagType(const TagType *T) { 357 dumpDeclRef(T->getDecl()); 358 } 359 void VisitAttributedType(const AttributedType *T) { 360 // FIXME: AttrKind 361 dumpTypeAsChild(T->getModifiedType()); 362 } 363 void VisitTemplateTypeParmType(const TemplateTypeParmType *T) { 364 OS << " depth " << T->getDepth() << " index " << T->getIndex(); 365 if (T->isParameterPack()) OS << " pack"; 366 dumpDeclRef(T->getDecl()); 367 } 368 void VisitSubstTemplateTypeParmType(const SubstTemplateTypeParmType *T) { 369 dumpTypeAsChild(T->getReplacedParameter()); 370 } 371 void VisitSubstTemplateTypeParmPackType( 372 const SubstTemplateTypeParmPackType *T) { 373 dumpTypeAsChild(T->getReplacedParameter()); 374 dumpTemplateArgument(T->getArgumentPack()); 375 } 376 void VisitAutoType(const AutoType *T) { 377 if (T->isDecltypeAuto()) OS << " decltype(auto)"; 378 if (!T->isDeduced()) 379 OS << " undeduced"; 380 } 381 void VisitTemplateSpecializationType(const TemplateSpecializationType *T) { 382 if (T->isTypeAlias()) OS << " alias"; 383 OS << " "; T->getTemplateName().dump(OS); 384 for (auto &Arg : *T) 385 dumpTemplateArgument(Arg); 386 if (T->isTypeAlias()) 387 dumpTypeAsChild(T->getAliasedType()); 388 } 389 void VisitInjectedClassNameType(const InjectedClassNameType *T) { 390 dumpDeclRef(T->getDecl()); 391 } 392 void VisitObjCInterfaceType(const ObjCInterfaceType *T) { 393 dumpDeclRef(T->getDecl()); 394 } 395 void VisitObjCObjectPointerType(const ObjCObjectPointerType *T) { 396 dumpTypeAsChild(T->getPointeeType()); 397 } 398 void VisitAtomicType(const AtomicType *T) { 399 dumpTypeAsChild(T->getValueType()); 400 } 401 void VisitAdjustedType(const AdjustedType *T) { 402 dumpTypeAsChild(T->getOriginalType()); 403 } 404 void VisitPackExpansionType(const PackExpansionType *T) { 405 if (auto N = T->getNumExpansions()) OS << " expansions " << *N; 406 if (!T->isSugared()) 407 dumpTypeAsChild(T->getPattern()); 408 } 409 // FIXME: ElaboratedType, DependentNameType, 410 // DependentTemplateSpecializationType, ObjCObjectType 411 412 // Decls 413 void VisitLabelDecl(const LabelDecl *D); 414 void VisitTypedefDecl(const TypedefDecl *D); 415 void VisitEnumDecl(const EnumDecl *D); 416 void VisitRecordDecl(const RecordDecl *D); 417 void VisitEnumConstantDecl(const EnumConstantDecl *D); 418 void VisitIndirectFieldDecl(const IndirectFieldDecl *D); 419 void VisitFunctionDecl(const FunctionDecl *D); 420 void VisitFieldDecl(const FieldDecl *D); 421 void VisitVarDecl(const VarDecl *D); 422 void VisitFileScopeAsmDecl(const FileScopeAsmDecl *D); 423 void VisitImportDecl(const ImportDecl *D); 424 425 // C++ Decls 426 void VisitNamespaceDecl(const NamespaceDecl *D); 427 void VisitUsingDirectiveDecl(const UsingDirectiveDecl *D); 428 void VisitNamespaceAliasDecl(const NamespaceAliasDecl *D); 429 void VisitTypeAliasDecl(const TypeAliasDecl *D); 430 void VisitTypeAliasTemplateDecl(const TypeAliasTemplateDecl *D); 431 void VisitCXXRecordDecl(const CXXRecordDecl *D); 432 void VisitStaticAssertDecl(const StaticAssertDecl *D); 433 template<typename SpecializationDecl> 434 void VisitTemplateDeclSpecialization(const SpecializationDecl *D, 435 bool DumpExplicitInst, 436 bool DumpRefOnly); 437 template<typename TemplateDecl> 438 void VisitTemplateDecl(const TemplateDecl *D, bool DumpExplicitInst); 439 void VisitFunctionTemplateDecl(const FunctionTemplateDecl *D); 440 void VisitClassTemplateDecl(const ClassTemplateDecl *D); 441 void VisitClassTemplateSpecializationDecl( 442 const ClassTemplateSpecializationDecl *D); 443 void VisitClassTemplatePartialSpecializationDecl( 444 const ClassTemplatePartialSpecializationDecl *D); 445 void VisitClassScopeFunctionSpecializationDecl( 446 const ClassScopeFunctionSpecializationDecl *D); 447 void VisitVarTemplateDecl(const VarTemplateDecl *D); 448 void VisitVarTemplateSpecializationDecl( 449 const VarTemplateSpecializationDecl *D); 450 void VisitVarTemplatePartialSpecializationDecl( 451 const VarTemplatePartialSpecializationDecl *D); 452 void VisitTemplateTypeParmDecl(const TemplateTypeParmDecl *D); 453 void VisitNonTypeTemplateParmDecl(const NonTypeTemplateParmDecl *D); 454 void VisitTemplateTemplateParmDecl(const TemplateTemplateParmDecl *D); 455 void VisitUsingDecl(const UsingDecl *D); 456 void VisitUnresolvedUsingTypenameDecl(const UnresolvedUsingTypenameDecl *D); 457 void VisitUnresolvedUsingValueDecl(const UnresolvedUsingValueDecl *D); 458 void VisitUsingShadowDecl(const UsingShadowDecl *D); 459 void VisitLinkageSpecDecl(const LinkageSpecDecl *D); 460 void VisitAccessSpecDecl(const AccessSpecDecl *D); 461 void VisitFriendDecl(const FriendDecl *D); 462 463 // ObjC Decls 464 void VisitObjCIvarDecl(const ObjCIvarDecl *D); 465 void VisitObjCMethodDecl(const ObjCMethodDecl *D); 466 void VisitObjCCategoryDecl(const ObjCCategoryDecl *D); 467 void VisitObjCCategoryImplDecl(const ObjCCategoryImplDecl *D); 468 void VisitObjCProtocolDecl(const ObjCProtocolDecl *D); 469 void VisitObjCInterfaceDecl(const ObjCInterfaceDecl *D); 470 void VisitObjCImplementationDecl(const ObjCImplementationDecl *D); 471 void VisitObjCCompatibleAliasDecl(const ObjCCompatibleAliasDecl *D); 472 void VisitObjCPropertyDecl(const ObjCPropertyDecl *D); 473 void VisitObjCPropertyImplDecl(const ObjCPropertyImplDecl *D); 474 void VisitBlockDecl(const BlockDecl *D); 475 476 // Stmts. 477 void VisitStmt(const Stmt *Node); 478 void VisitDeclStmt(const DeclStmt *Node); 479 void VisitAttributedStmt(const AttributedStmt *Node); 480 void VisitLabelStmt(const LabelStmt *Node); 481 void VisitGotoStmt(const GotoStmt *Node); 482 void VisitCXXCatchStmt(const CXXCatchStmt *Node); 483 484 // Exprs 485 void VisitExpr(const Expr *Node); 486 void VisitCastExpr(const CastExpr *Node); 487 void VisitDeclRefExpr(const DeclRefExpr *Node); 488 void VisitPredefinedExpr(const PredefinedExpr *Node); 489 void VisitCharacterLiteral(const CharacterLiteral *Node); 490 void VisitIntegerLiteral(const IntegerLiteral *Node); 491 void VisitFloatingLiteral(const FloatingLiteral *Node); 492 void VisitStringLiteral(const StringLiteral *Str); 493 void VisitInitListExpr(const InitListExpr *ILE); 494 void VisitUnaryOperator(const UnaryOperator *Node); 495 void VisitUnaryExprOrTypeTraitExpr(const UnaryExprOrTypeTraitExpr *Node); 496 void VisitMemberExpr(const MemberExpr *Node); 497 void VisitExtVectorElementExpr(const ExtVectorElementExpr *Node); 498 void VisitBinaryOperator(const BinaryOperator *Node); 499 void VisitCompoundAssignOperator(const CompoundAssignOperator *Node); 500 void VisitAddrLabelExpr(const AddrLabelExpr *Node); 501 void VisitBlockExpr(const BlockExpr *Node); 502 void VisitOpaqueValueExpr(const OpaqueValueExpr *Node); 503 504 // C++ 505 void VisitCXXNamedCastExpr(const CXXNamedCastExpr *Node); 506 void VisitCXXBoolLiteralExpr(const CXXBoolLiteralExpr *Node); 507 void VisitCXXThisExpr(const CXXThisExpr *Node); 508 void VisitCXXFunctionalCastExpr(const CXXFunctionalCastExpr *Node); 509 void VisitCXXConstructExpr(const CXXConstructExpr *Node); 510 void VisitCXXBindTemporaryExpr(const CXXBindTemporaryExpr *Node); 511 void VisitCXXNewExpr(const CXXNewExpr *Node); 512 void VisitCXXDeleteExpr(const CXXDeleteExpr *Node); 513 void VisitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *Node); 514 void VisitExprWithCleanups(const ExprWithCleanups *Node); 515 void VisitUnresolvedLookupExpr(const UnresolvedLookupExpr *Node); 516 void dumpCXXTemporary(const CXXTemporary *Temporary); 517 void VisitLambdaExpr(const LambdaExpr *Node) { 518 VisitExpr(Node); 519 dumpDecl(Node->getLambdaClass()); 520 } 521 void VisitSizeOfPackExpr(const SizeOfPackExpr *Node); 522 523 // ObjC 524 void VisitObjCAtCatchStmt(const ObjCAtCatchStmt *Node); 525 void VisitObjCEncodeExpr(const ObjCEncodeExpr *Node); 526 void VisitObjCMessageExpr(const ObjCMessageExpr *Node); 527 void VisitObjCBoxedExpr(const ObjCBoxedExpr *Node); 528 void VisitObjCSelectorExpr(const ObjCSelectorExpr *Node); 529 void VisitObjCProtocolExpr(const ObjCProtocolExpr *Node); 530 void VisitObjCPropertyRefExpr(const ObjCPropertyRefExpr *Node); 531 void VisitObjCSubscriptRefExpr(const ObjCSubscriptRefExpr *Node); 532 void VisitObjCIvarRefExpr(const ObjCIvarRefExpr *Node); 533 void VisitObjCBoolLiteralExpr(const ObjCBoolLiteralExpr *Node); 534 535 // Comments. 536 const char *getCommandName(unsigned CommandID); 537 void dumpComment(const Comment *C); 538 539 // Inline comments. 540 void visitTextComment(const TextComment *C); 541 void visitInlineCommandComment(const InlineCommandComment *C); 542 void visitHTMLStartTagComment(const HTMLStartTagComment *C); 543 void visitHTMLEndTagComment(const HTMLEndTagComment *C); 544 545 // Block comments. 546 void visitBlockCommandComment(const BlockCommandComment *C); 547 void visitParamCommandComment(const ParamCommandComment *C); 548 void visitTParamCommandComment(const TParamCommandComment *C); 549 void visitVerbatimBlockComment(const VerbatimBlockComment *C); 550 void visitVerbatimBlockLineComment(const VerbatimBlockLineComment *C); 551 void visitVerbatimLineComment(const VerbatimLineComment *C); 552 }; 553 } // namespace 554 555 //===----------------------------------------------------------------------===// 556 // Utilities 557 //===----------------------------------------------------------------------===// 558 559 void ASTDumper::dumpPointer(const void *Ptr) { 560 ColorScope Color(*this, AddressColor); 561 OS << ' ' << Ptr; 562 } 563 564 void ASTDumper::dumpLocation(SourceLocation Loc) { 565 if (!SM) 566 return; 567 568 ColorScope Color(*this, LocationColor); 569 SourceLocation SpellingLoc = SM->getSpellingLoc(Loc); 570 571 // The general format we print out is filename:line:col, but we drop pieces 572 // that haven't changed since the last loc printed. 573 PresumedLoc PLoc = SM->getPresumedLoc(SpellingLoc); 574 575 if (PLoc.isInvalid()) { 576 OS << "<invalid sloc>"; 577 return; 578 } 579 580 if (strcmp(PLoc.getFilename(), LastLocFilename) != 0) { 581 OS << PLoc.getFilename() << ':' << PLoc.getLine() 582 << ':' << PLoc.getColumn(); 583 LastLocFilename = PLoc.getFilename(); 584 LastLocLine = PLoc.getLine(); 585 } else if (PLoc.getLine() != LastLocLine) { 586 OS << "line" << ':' << PLoc.getLine() 587 << ':' << PLoc.getColumn(); 588 LastLocLine = PLoc.getLine(); 589 } else { 590 OS << "col" << ':' << PLoc.getColumn(); 591 } 592 } 593 594 void ASTDumper::dumpSourceRange(SourceRange R) { 595 // Can't translate locations if a SourceManager isn't available. 596 if (!SM) 597 return; 598 599 OS << " <"; 600 dumpLocation(R.getBegin()); 601 if (R.getBegin() != R.getEnd()) { 602 OS << ", "; 603 dumpLocation(R.getEnd()); 604 } 605 OS << ">"; 606 607 // <t2.c:123:421[blah], t2.c:412:321> 608 609 } 610 611 void ASTDumper::dumpBareType(QualType T, bool Desugar) { 612 ColorScope Color(*this, TypeColor); 613 614 SplitQualType T_split = T.split(); 615 OS << "'" << QualType::getAsString(T_split) << "'"; 616 617 if (Desugar && !T.isNull()) { 618 // If the type is sugared, also dump a (shallow) desugared type. 619 SplitQualType D_split = T.getSplitDesugaredType(); 620 if (T_split != D_split) 621 OS << ":'" << QualType::getAsString(D_split) << "'"; 622 } 623 } 624 625 void ASTDumper::dumpType(QualType T) { 626 OS << ' '; 627 dumpBareType(T); 628 } 629 630 void ASTDumper::dumpTypeAsChild(QualType T) { 631 SplitQualType SQT = T.split(); 632 if (!SQT.Quals.hasQualifiers()) 633 return dumpTypeAsChild(SQT.Ty); 634 635 dumpChild([=] { 636 OS << "QualType"; 637 dumpPointer(T.getAsOpaquePtr()); 638 OS << " "; 639 dumpBareType(T, false); 640 OS << " " << T.split().Quals.getAsString(); 641 dumpTypeAsChild(T.split().Ty); 642 }); 643 } 644 645 void ASTDumper::dumpTypeAsChild(const Type *T) { 646 dumpChild([=] { 647 if (!T) { 648 ColorScope Color(*this, NullColor); 649 OS << "<<<NULL>>>"; 650 return; 651 } 652 653 { 654 ColorScope Color(*this, TypeColor); 655 OS << T->getTypeClassName() << "Type"; 656 } 657 dumpPointer(T); 658 OS << " "; 659 dumpBareType(QualType(T, 0), false); 660 661 QualType SingleStepDesugar = 662 T->getLocallyUnqualifiedSingleStepDesugaredType(); 663 if (SingleStepDesugar != QualType(T, 0)) 664 OS << " sugar"; 665 if (T->isDependentType()) 666 OS << " dependent"; 667 else if (T->isInstantiationDependentType()) 668 OS << " instantiation_dependent"; 669 if (T->isVariablyModifiedType()) 670 OS << " variably_modified"; 671 if (T->containsUnexpandedParameterPack()) 672 OS << " contains_unexpanded_pack"; 673 if (T->isFromAST()) 674 OS << " imported"; 675 676 TypeVisitor<ASTDumper>::Visit(T); 677 678 if (SingleStepDesugar != QualType(T, 0)) 679 dumpTypeAsChild(SingleStepDesugar); 680 }); 681 } 682 683 void ASTDumper::dumpBareDeclRef(const Decl *D) { 684 { 685 ColorScope Color(*this, DeclKindNameColor); 686 OS << D->getDeclKindName(); 687 } 688 dumpPointer(D); 689 690 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D)) { 691 ColorScope Color(*this, DeclNameColor); 692 OS << " '" << ND->getDeclName() << '\''; 693 } 694 695 if (const ValueDecl *VD = dyn_cast<ValueDecl>(D)) 696 dumpType(VD->getType()); 697 } 698 699 void ASTDumper::dumpDeclRef(const Decl *D, const char *Label) { 700 if (!D) 701 return; 702 703 dumpChild([=]{ 704 if (Label) 705 OS << Label << ' '; 706 dumpBareDeclRef(D); 707 }); 708 } 709 710 void ASTDumper::dumpName(const NamedDecl *ND) { 711 if (ND->getDeclName()) { 712 ColorScope Color(*this, DeclNameColor); 713 OS << ' ' << ND->getNameAsString(); 714 } 715 } 716 717 bool ASTDumper::hasNodes(const DeclContext *DC) { 718 if (!DC) 719 return false; 720 721 return DC->hasExternalLexicalStorage() || 722 DC->noload_decls_begin() != DC->noload_decls_end(); 723 } 724 725 void ASTDumper::dumpDeclContext(const DeclContext *DC) { 726 if (!DC) 727 return; 728 729 for (auto *D : DC->noload_decls()) 730 dumpDecl(D); 731 732 if (DC->hasExternalLexicalStorage()) { 733 dumpChild([=]{ 734 ColorScope Color(*this, UndeserializedColor); 735 OS << "<undeserialized declarations>"; 736 }); 737 } 738 } 739 740 void ASTDumper::dumpLookups(const DeclContext *DC, bool DumpDecls) { 741 dumpChild([=] { 742 OS << "StoredDeclsMap "; 743 dumpBareDeclRef(cast<Decl>(DC)); 744 745 const DeclContext *Primary = DC->getPrimaryContext(); 746 if (Primary != DC) { 747 OS << " primary"; 748 dumpPointer(cast<Decl>(Primary)); 749 } 750 751 bool HasUndeserializedLookups = Primary->hasExternalVisibleStorage(); 752 753 DeclContext::all_lookups_iterator I = Primary->noload_lookups_begin(), 754 E = Primary->noload_lookups_end(); 755 while (I != E) { 756 DeclarationName Name = I.getLookupName(); 757 DeclContextLookupResult R = *I++; 758 759 dumpChild([=] { 760 OS << "DeclarationName "; 761 { 762 ColorScope Color(*this, DeclNameColor); 763 OS << '\'' << Name << '\''; 764 } 765 766 for (DeclContextLookupResult::iterator RI = R.begin(), RE = R.end(); 767 RI != RE; ++RI) { 768 dumpChild([=] { 769 dumpBareDeclRef(*RI); 770 771 if ((*RI)->isHidden()) 772 OS << " hidden"; 773 774 // If requested, dump the redecl chain for this lookup. 775 if (DumpDecls) { 776 // Dump earliest decl first. 777 std::function<void(Decl *)> DumpWithPrev = [&](Decl *D) { 778 if (Decl *Prev = D->getPreviousDecl()) 779 DumpWithPrev(Prev); 780 dumpDecl(D); 781 }; 782 DumpWithPrev(*RI); 783 } 784 }); 785 } 786 }); 787 } 788 789 if (HasUndeserializedLookups) { 790 dumpChild([=] { 791 ColorScope Color(*this, UndeserializedColor); 792 OS << "<undeserialized lookups>"; 793 }); 794 } 795 }); 796 } 797 798 void ASTDumper::dumpAttr(const Attr *A) { 799 dumpChild([=] { 800 { 801 ColorScope Color(*this, AttrColor); 802 803 switch (A->getKind()) { 804 #define ATTR(X) case attr::X: OS << #X; break; 805 #include "clang/Basic/AttrList.inc" 806 default: 807 llvm_unreachable("unexpected attribute kind"); 808 } 809 OS << "Attr"; 810 } 811 dumpPointer(A); 812 dumpSourceRange(A->getRange()); 813 if (A->isInherited()) 814 OS << " Inherited"; 815 if (A->isImplicit()) 816 OS << " Implicit"; 817 #include "clang/AST/AttrDump.inc" 818 }); 819 } 820 821 static void dumpPreviousDeclImpl(raw_ostream &OS, ...) {} 822 823 template<typename T> 824 static void dumpPreviousDeclImpl(raw_ostream &OS, const Mergeable<T> *D) { 825 const T *First = D->getFirstDecl(); 826 if (First != D) 827 OS << " first " << First; 828 } 829 830 template<typename T> 831 static void dumpPreviousDeclImpl(raw_ostream &OS, const Redeclarable<T> *D) { 832 const T *Prev = D->getPreviousDecl(); 833 if (Prev) 834 OS << " prev " << Prev; 835 } 836 837 /// Dump the previous declaration in the redeclaration chain for a declaration, 838 /// if any. 839 static void dumpPreviousDecl(raw_ostream &OS, const Decl *D) { 840 switch (D->getKind()) { 841 #define DECL(DERIVED, BASE) \ 842 case Decl::DERIVED: \ 843 return dumpPreviousDeclImpl(OS, cast<DERIVED##Decl>(D)); 844 #define ABSTRACT_DECL(DECL) 845 #include "clang/AST/DeclNodes.inc" 846 } 847 llvm_unreachable("Decl that isn't part of DeclNodes.inc!"); 848 } 849 850 //===----------------------------------------------------------------------===// 851 // C++ Utilities 852 //===----------------------------------------------------------------------===// 853 854 void ASTDumper::dumpAccessSpecifier(AccessSpecifier AS) { 855 switch (AS) { 856 case AS_none: 857 break; 858 case AS_public: 859 OS << "public"; 860 break; 861 case AS_protected: 862 OS << "protected"; 863 break; 864 case AS_private: 865 OS << "private"; 866 break; 867 } 868 } 869 870 void ASTDumper::dumpCXXCtorInitializer(const CXXCtorInitializer *Init) { 871 dumpChild([=] { 872 OS << "CXXCtorInitializer"; 873 if (Init->isAnyMemberInitializer()) { 874 OS << ' '; 875 dumpBareDeclRef(Init->getAnyMember()); 876 } else if (Init->isBaseInitializer()) { 877 dumpType(QualType(Init->getBaseClass(), 0)); 878 } else if (Init->isDelegatingInitializer()) { 879 dumpType(Init->getTypeSourceInfo()->getType()); 880 } else { 881 llvm_unreachable("Unknown initializer type"); 882 } 883 dumpStmt(Init->getInit()); 884 }); 885 } 886 887 void ASTDumper::dumpTemplateParameters(const TemplateParameterList *TPL) { 888 if (!TPL) 889 return; 890 891 for (TemplateParameterList::const_iterator I = TPL->begin(), E = TPL->end(); 892 I != E; ++I) 893 dumpDecl(*I); 894 } 895 896 void ASTDumper::dumpTemplateArgumentListInfo( 897 const TemplateArgumentListInfo &TALI) { 898 for (unsigned i = 0, e = TALI.size(); i < e; ++i) 899 dumpTemplateArgumentLoc(TALI[i]); 900 } 901 902 void ASTDumper::dumpTemplateArgumentLoc(const TemplateArgumentLoc &A) { 903 dumpTemplateArgument(A.getArgument(), A.getSourceRange()); 904 } 905 906 void ASTDumper::dumpTemplateArgumentList(const TemplateArgumentList &TAL) { 907 for (unsigned i = 0, e = TAL.size(); i < e; ++i) 908 dumpTemplateArgument(TAL[i]); 909 } 910 911 void ASTDumper::dumpTemplateArgument(const TemplateArgument &A, SourceRange R) { 912 dumpChild([=] { 913 OS << "TemplateArgument"; 914 if (R.isValid()) 915 dumpSourceRange(R); 916 917 switch (A.getKind()) { 918 case TemplateArgument::Null: 919 OS << " null"; 920 break; 921 case TemplateArgument::Type: 922 OS << " type"; 923 dumpType(A.getAsType()); 924 break; 925 case TemplateArgument::Declaration: 926 OS << " decl"; 927 dumpDeclRef(A.getAsDecl()); 928 break; 929 case TemplateArgument::NullPtr: 930 OS << " nullptr"; 931 break; 932 case TemplateArgument::Integral: 933 OS << " integral " << A.getAsIntegral(); 934 break; 935 case TemplateArgument::Template: 936 OS << " template "; 937 A.getAsTemplate().dump(OS); 938 break; 939 case TemplateArgument::TemplateExpansion: 940 OS << " template expansion"; 941 A.getAsTemplateOrTemplatePattern().dump(OS); 942 break; 943 case TemplateArgument::Expression: 944 OS << " expr"; 945 dumpStmt(A.getAsExpr()); 946 break; 947 case TemplateArgument::Pack: 948 OS << " pack"; 949 for (TemplateArgument::pack_iterator I = A.pack_begin(), E = A.pack_end(); 950 I != E; ++I) 951 dumpTemplateArgument(*I); 952 break; 953 } 954 }); 955 } 956 957 //===----------------------------------------------------------------------===// 958 // Decl dumping methods. 959 //===----------------------------------------------------------------------===// 960 961 void ASTDumper::dumpDecl(const Decl *D) { 962 dumpChild([=] { 963 if (!D) { 964 ColorScope Color(*this, NullColor); 965 OS << "<<<NULL>>>"; 966 return; 967 } 968 969 { 970 ColorScope Color(*this, DeclKindNameColor); 971 OS << D->getDeclKindName() << "Decl"; 972 } 973 dumpPointer(D); 974 if (D->getLexicalDeclContext() != D->getDeclContext()) 975 OS << " parent " << cast<Decl>(D->getDeclContext()); 976 dumpPreviousDecl(OS, D); 977 dumpSourceRange(D->getSourceRange()); 978 OS << ' '; 979 dumpLocation(D->getLocation()); 980 if (Module *M = D->getImportedOwningModule()) 981 OS << " in " << M->getFullModuleName(); 982 else if (Module *M = D->getLocalOwningModule()) 983 OS << " in (local) " << M->getFullModuleName(); 984 if (auto *ND = dyn_cast<NamedDecl>(D)) 985 for (Module *M : D->getASTContext().getModulesWithMergedDefinition( 986 const_cast<NamedDecl *>(ND))) 987 dumpChild([=] { OS << "also in " << M->getFullModuleName(); }); 988 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D)) 989 if (ND->isHidden()) 990 OS << " hidden"; 991 if (D->isImplicit()) 992 OS << " implicit"; 993 if (D->isUsed()) 994 OS << " used"; 995 else if (D->isThisDeclarationReferenced()) 996 OS << " referenced"; 997 if (D->isInvalidDecl()) 998 OS << " invalid"; 999 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) 1000 if (FD->isConstexpr()) 1001 OS << " constexpr"; 1002 1003 1004 ConstDeclVisitor<ASTDumper>::Visit(D); 1005 1006 for (Decl::attr_iterator I = D->attr_begin(), E = D->attr_end(); I != E; 1007 ++I) 1008 dumpAttr(*I); 1009 1010 if (const FullComment *Comment = 1011 D->getASTContext().getLocalCommentForDeclUncached(D)) 1012 dumpFullComment(Comment); 1013 1014 // Decls within functions are visited by the body. 1015 if (!isa<FunctionDecl>(*D) && !isa<ObjCMethodDecl>(*D) && 1016 hasNodes(dyn_cast<DeclContext>(D))) 1017 dumpDeclContext(cast<DeclContext>(D)); 1018 }); 1019 } 1020 1021 void ASTDumper::VisitLabelDecl(const LabelDecl *D) { 1022 dumpName(D); 1023 } 1024 1025 void ASTDumper::VisitTypedefDecl(const TypedefDecl *D) { 1026 dumpName(D); 1027 dumpType(D->getUnderlyingType()); 1028 if (D->isModulePrivate()) 1029 OS << " __module_private__"; 1030 } 1031 1032 void ASTDumper::VisitEnumDecl(const EnumDecl *D) { 1033 if (D->isScoped()) { 1034 if (D->isScopedUsingClassTag()) 1035 OS << " class"; 1036 else 1037 OS << " struct"; 1038 } 1039 dumpName(D); 1040 if (D->isModulePrivate()) 1041 OS << " __module_private__"; 1042 if (D->isFixed()) 1043 dumpType(D->getIntegerType()); 1044 } 1045 1046 void ASTDumper::VisitRecordDecl(const RecordDecl *D) { 1047 OS << ' ' << D->getKindName(); 1048 dumpName(D); 1049 if (D->isModulePrivate()) 1050 OS << " __module_private__"; 1051 if (D->isCompleteDefinition()) 1052 OS << " definition"; 1053 } 1054 1055 void ASTDumper::VisitEnumConstantDecl(const EnumConstantDecl *D) { 1056 dumpName(D); 1057 dumpType(D->getType()); 1058 if (const Expr *Init = D->getInitExpr()) 1059 dumpStmt(Init); 1060 } 1061 1062 void ASTDumper::VisitIndirectFieldDecl(const IndirectFieldDecl *D) { 1063 dumpName(D); 1064 dumpType(D->getType()); 1065 1066 for (auto *Child : D->chain()) 1067 dumpDeclRef(Child); 1068 } 1069 1070 void ASTDumper::VisitFunctionDecl(const FunctionDecl *D) { 1071 dumpName(D); 1072 dumpType(D->getType()); 1073 1074 StorageClass SC = D->getStorageClass(); 1075 if (SC != SC_None) 1076 OS << ' ' << VarDecl::getStorageClassSpecifierString(SC); 1077 if (D->isInlineSpecified()) 1078 OS << " inline"; 1079 if (D->isVirtualAsWritten()) 1080 OS << " virtual"; 1081 if (D->isModulePrivate()) 1082 OS << " __module_private__"; 1083 1084 if (D->isPure()) 1085 OS << " pure"; 1086 else if (D->isDeletedAsWritten()) 1087 OS << " delete"; 1088 1089 if (const FunctionProtoType *FPT = D->getType()->getAs<FunctionProtoType>()) { 1090 FunctionProtoType::ExtProtoInfo EPI = FPT->getExtProtoInfo(); 1091 switch (EPI.ExceptionSpec.Type) { 1092 default: break; 1093 case EST_Unevaluated: 1094 OS << " noexcept-unevaluated " << EPI.ExceptionSpec.SourceDecl; 1095 break; 1096 case EST_Uninstantiated: 1097 OS << " noexcept-uninstantiated " << EPI.ExceptionSpec.SourceTemplate; 1098 break; 1099 } 1100 } 1101 1102 if (const FunctionTemplateSpecializationInfo *FTSI = 1103 D->getTemplateSpecializationInfo()) 1104 dumpTemplateArgumentList(*FTSI->TemplateArguments); 1105 1106 for (ArrayRef<NamedDecl *>::iterator 1107 I = D->getDeclsInPrototypeScope().begin(), 1108 E = D->getDeclsInPrototypeScope().end(); I != E; ++I) 1109 dumpDecl(*I); 1110 1111 if (!D->param_begin() && D->getNumParams()) 1112 dumpChild([=] { OS << "<<NULL params x " << D->getNumParams() << ">>"; }); 1113 else 1114 for (FunctionDecl::param_const_iterator I = D->param_begin(), 1115 E = D->param_end(); 1116 I != E; ++I) 1117 dumpDecl(*I); 1118 1119 if (const CXXConstructorDecl *C = dyn_cast<CXXConstructorDecl>(D)) 1120 for (CXXConstructorDecl::init_const_iterator I = C->init_begin(), 1121 E = C->init_end(); 1122 I != E; ++I) 1123 dumpCXXCtorInitializer(*I); 1124 1125 if (D->doesThisDeclarationHaveABody()) 1126 dumpStmt(D->getBody()); 1127 } 1128 1129 void ASTDumper::VisitFieldDecl(const FieldDecl *D) { 1130 dumpName(D); 1131 dumpType(D->getType()); 1132 if (D->isMutable()) 1133 OS << " mutable"; 1134 if (D->isModulePrivate()) 1135 OS << " __module_private__"; 1136 1137 if (D->isBitField()) 1138 dumpStmt(D->getBitWidth()); 1139 if (Expr *Init = D->getInClassInitializer()) 1140 dumpStmt(Init); 1141 } 1142 1143 void ASTDumper::VisitVarDecl(const VarDecl *D) { 1144 dumpName(D); 1145 dumpType(D->getType()); 1146 StorageClass SC = D->getStorageClass(); 1147 if (SC != SC_None) 1148 OS << ' ' << VarDecl::getStorageClassSpecifierString(SC); 1149 switch (D->getTLSKind()) { 1150 case VarDecl::TLS_None: break; 1151 case VarDecl::TLS_Static: OS << " tls"; break; 1152 case VarDecl::TLS_Dynamic: OS << " tls_dynamic"; break; 1153 } 1154 if (D->isModulePrivate()) 1155 OS << " __module_private__"; 1156 if (D->isNRVOVariable()) 1157 OS << " nrvo"; 1158 if (D->hasInit()) { 1159 switch (D->getInitStyle()) { 1160 case VarDecl::CInit: OS << " cinit"; break; 1161 case VarDecl::CallInit: OS << " callinit"; break; 1162 case VarDecl::ListInit: OS << " listinit"; break; 1163 } 1164 dumpStmt(D->getInit()); 1165 } 1166 } 1167 1168 void ASTDumper::VisitFileScopeAsmDecl(const FileScopeAsmDecl *D) { 1169 dumpStmt(D->getAsmString()); 1170 } 1171 1172 void ASTDumper::VisitImportDecl(const ImportDecl *D) { 1173 OS << ' ' << D->getImportedModule()->getFullModuleName(); 1174 } 1175 1176 //===----------------------------------------------------------------------===// 1177 // C++ Declarations 1178 //===----------------------------------------------------------------------===// 1179 1180 void ASTDumper::VisitNamespaceDecl(const NamespaceDecl *D) { 1181 dumpName(D); 1182 if (D->isInline()) 1183 OS << " inline"; 1184 if (!D->isOriginalNamespace()) 1185 dumpDeclRef(D->getOriginalNamespace(), "original"); 1186 } 1187 1188 void ASTDumper::VisitUsingDirectiveDecl(const UsingDirectiveDecl *D) { 1189 OS << ' '; 1190 dumpBareDeclRef(D->getNominatedNamespace()); 1191 } 1192 1193 void ASTDumper::VisitNamespaceAliasDecl(const NamespaceAliasDecl *D) { 1194 dumpName(D); 1195 dumpDeclRef(D->getAliasedNamespace()); 1196 } 1197 1198 void ASTDumper::VisitTypeAliasDecl(const TypeAliasDecl *D) { 1199 dumpName(D); 1200 dumpType(D->getUnderlyingType()); 1201 } 1202 1203 void ASTDumper::VisitTypeAliasTemplateDecl(const TypeAliasTemplateDecl *D) { 1204 dumpName(D); 1205 dumpTemplateParameters(D->getTemplateParameters()); 1206 dumpDecl(D->getTemplatedDecl()); 1207 } 1208 1209 void ASTDumper::VisitCXXRecordDecl(const CXXRecordDecl *D) { 1210 VisitRecordDecl(D); 1211 if (!D->isCompleteDefinition()) 1212 return; 1213 1214 for (const auto &I : D->bases()) { 1215 dumpChild([=] { 1216 if (I.isVirtual()) 1217 OS << "virtual "; 1218 dumpAccessSpecifier(I.getAccessSpecifier()); 1219 dumpType(I.getType()); 1220 if (I.isPackExpansion()) 1221 OS << "..."; 1222 }); 1223 } 1224 } 1225 1226 void ASTDumper::VisitStaticAssertDecl(const StaticAssertDecl *D) { 1227 dumpStmt(D->getAssertExpr()); 1228 dumpStmt(D->getMessage()); 1229 } 1230 1231 template<typename SpecializationDecl> 1232 void ASTDumper::VisitTemplateDeclSpecialization(const SpecializationDecl *D, 1233 bool DumpExplicitInst, 1234 bool DumpRefOnly) { 1235 bool DumpedAny = false; 1236 for (auto *RedeclWithBadType : D->redecls()) { 1237 // FIXME: The redecls() range sometimes has elements of a less-specific 1238 // type. (In particular, ClassTemplateSpecializationDecl::redecls() gives 1239 // us TagDecls, and should give CXXRecordDecls). 1240 auto *Redecl = dyn_cast<SpecializationDecl>(RedeclWithBadType); 1241 if (!Redecl) { 1242 // Found the injected-class-name for a class template. This will be dumped 1243 // as part of its surrounding class so we don't need to dump it here. 1244 assert(isa<CXXRecordDecl>(RedeclWithBadType) && 1245 "expected an injected-class-name"); 1246 continue; 1247 } 1248 1249 switch (Redecl->getTemplateSpecializationKind()) { 1250 case TSK_ExplicitInstantiationDeclaration: 1251 case TSK_ExplicitInstantiationDefinition: 1252 if (!DumpExplicitInst) 1253 break; 1254 // Fall through. 1255 case TSK_Undeclared: 1256 case TSK_ImplicitInstantiation: 1257 if (DumpRefOnly) 1258 dumpDeclRef(Redecl); 1259 else 1260 dumpDecl(Redecl); 1261 DumpedAny = true; 1262 break; 1263 case TSK_ExplicitSpecialization: 1264 break; 1265 } 1266 } 1267 1268 // Ensure we dump at least one decl for each specialization. 1269 if (!DumpedAny) 1270 dumpDeclRef(D); 1271 } 1272 1273 template<typename TemplateDecl> 1274 void ASTDumper::VisitTemplateDecl(const TemplateDecl *D, 1275 bool DumpExplicitInst) { 1276 dumpName(D); 1277 dumpTemplateParameters(D->getTemplateParameters()); 1278 1279 dumpDecl(D->getTemplatedDecl()); 1280 1281 for (auto *Child : D->specializations()) 1282 VisitTemplateDeclSpecialization(Child, DumpExplicitInst, 1283 !D->isCanonicalDecl()); 1284 } 1285 1286 void ASTDumper::VisitFunctionTemplateDecl(const FunctionTemplateDecl *D) { 1287 // FIXME: We don't add a declaration of a function template specialization 1288 // to its context when it's explicitly instantiated, so dump explicit 1289 // instantiations when we dump the template itself. 1290 VisitTemplateDecl(D, true); 1291 } 1292 1293 void ASTDumper::VisitClassTemplateDecl(const ClassTemplateDecl *D) { 1294 VisitTemplateDecl(D, false); 1295 } 1296 1297 void ASTDumper::VisitClassTemplateSpecializationDecl( 1298 const ClassTemplateSpecializationDecl *D) { 1299 VisitCXXRecordDecl(D); 1300 dumpTemplateArgumentList(D->getTemplateArgs()); 1301 } 1302 1303 void ASTDumper::VisitClassTemplatePartialSpecializationDecl( 1304 const ClassTemplatePartialSpecializationDecl *D) { 1305 VisitClassTemplateSpecializationDecl(D); 1306 dumpTemplateParameters(D->getTemplateParameters()); 1307 } 1308 1309 void ASTDumper::VisitClassScopeFunctionSpecializationDecl( 1310 const ClassScopeFunctionSpecializationDecl *D) { 1311 dumpDeclRef(D->getSpecialization()); 1312 if (D->hasExplicitTemplateArgs()) 1313 dumpTemplateArgumentListInfo(D->templateArgs()); 1314 } 1315 1316 void ASTDumper::VisitVarTemplateDecl(const VarTemplateDecl *D) { 1317 VisitTemplateDecl(D, false); 1318 } 1319 1320 void ASTDumper::VisitVarTemplateSpecializationDecl( 1321 const VarTemplateSpecializationDecl *D) { 1322 dumpTemplateArgumentList(D->getTemplateArgs()); 1323 VisitVarDecl(D); 1324 } 1325 1326 void ASTDumper::VisitVarTemplatePartialSpecializationDecl( 1327 const VarTemplatePartialSpecializationDecl *D) { 1328 dumpTemplateParameters(D->getTemplateParameters()); 1329 VisitVarTemplateSpecializationDecl(D); 1330 } 1331 1332 void ASTDumper::VisitTemplateTypeParmDecl(const TemplateTypeParmDecl *D) { 1333 if (D->wasDeclaredWithTypename()) 1334 OS << " typename"; 1335 else 1336 OS << " class"; 1337 if (D->isParameterPack()) 1338 OS << " ..."; 1339 dumpName(D); 1340 if (D->hasDefaultArgument()) 1341 dumpTemplateArgument(D->getDefaultArgument()); 1342 } 1343 1344 void ASTDumper::VisitNonTypeTemplateParmDecl(const NonTypeTemplateParmDecl *D) { 1345 dumpType(D->getType()); 1346 if (D->isParameterPack()) 1347 OS << " ..."; 1348 dumpName(D); 1349 if (D->hasDefaultArgument()) 1350 dumpTemplateArgument(D->getDefaultArgument()); 1351 } 1352 1353 void ASTDumper::VisitTemplateTemplateParmDecl( 1354 const TemplateTemplateParmDecl *D) { 1355 if (D->isParameterPack()) 1356 OS << " ..."; 1357 dumpName(D); 1358 dumpTemplateParameters(D->getTemplateParameters()); 1359 if (D->hasDefaultArgument()) 1360 dumpTemplateArgumentLoc(D->getDefaultArgument()); 1361 } 1362 1363 void ASTDumper::VisitUsingDecl(const UsingDecl *D) { 1364 OS << ' '; 1365 D->getQualifier()->print(OS, D->getASTContext().getPrintingPolicy()); 1366 OS << D->getNameAsString(); 1367 } 1368 1369 void ASTDumper::VisitUnresolvedUsingTypenameDecl( 1370 const UnresolvedUsingTypenameDecl *D) { 1371 OS << ' '; 1372 D->getQualifier()->print(OS, D->getASTContext().getPrintingPolicy()); 1373 OS << D->getNameAsString(); 1374 } 1375 1376 void ASTDumper::VisitUnresolvedUsingValueDecl(const UnresolvedUsingValueDecl *D) { 1377 OS << ' '; 1378 D->getQualifier()->print(OS, D->getASTContext().getPrintingPolicy()); 1379 OS << D->getNameAsString(); 1380 dumpType(D->getType()); 1381 } 1382 1383 void ASTDumper::VisitUsingShadowDecl(const UsingShadowDecl *D) { 1384 OS << ' '; 1385 dumpBareDeclRef(D->getTargetDecl()); 1386 } 1387 1388 void ASTDumper::VisitLinkageSpecDecl(const LinkageSpecDecl *D) { 1389 switch (D->getLanguage()) { 1390 case LinkageSpecDecl::lang_c: OS << " C"; break; 1391 case LinkageSpecDecl::lang_cxx: OS << " C++"; break; 1392 } 1393 } 1394 1395 void ASTDumper::VisitAccessSpecDecl(const AccessSpecDecl *D) { 1396 OS << ' '; 1397 dumpAccessSpecifier(D->getAccess()); 1398 } 1399 1400 void ASTDumper::VisitFriendDecl(const FriendDecl *D) { 1401 if (TypeSourceInfo *T = D->getFriendType()) 1402 dumpType(T->getType()); 1403 else 1404 dumpDecl(D->getFriendDecl()); 1405 } 1406 1407 //===----------------------------------------------------------------------===// 1408 // Obj-C Declarations 1409 //===----------------------------------------------------------------------===// 1410 1411 void ASTDumper::VisitObjCIvarDecl(const ObjCIvarDecl *D) { 1412 dumpName(D); 1413 dumpType(D->getType()); 1414 if (D->getSynthesize()) 1415 OS << " synthesize"; 1416 1417 switch (D->getAccessControl()) { 1418 case ObjCIvarDecl::None: 1419 OS << " none"; 1420 break; 1421 case ObjCIvarDecl::Private: 1422 OS << " private"; 1423 break; 1424 case ObjCIvarDecl::Protected: 1425 OS << " protected"; 1426 break; 1427 case ObjCIvarDecl::Public: 1428 OS << " public"; 1429 break; 1430 case ObjCIvarDecl::Package: 1431 OS << " package"; 1432 break; 1433 } 1434 } 1435 1436 void ASTDumper::VisitObjCMethodDecl(const ObjCMethodDecl *D) { 1437 if (D->isInstanceMethod()) 1438 OS << " -"; 1439 else 1440 OS << " +"; 1441 dumpName(D); 1442 dumpType(D->getReturnType()); 1443 1444 if (D->isThisDeclarationADefinition()) { 1445 dumpDeclContext(D); 1446 } else { 1447 for (ObjCMethodDecl::param_const_iterator I = D->param_begin(), 1448 E = D->param_end(); 1449 I != E; ++I) 1450 dumpDecl(*I); 1451 } 1452 1453 if (D->isVariadic()) 1454 dumpChild([=] { OS << "..."; }); 1455 1456 if (D->hasBody()) 1457 dumpStmt(D->getBody()); 1458 } 1459 1460 void ASTDumper::VisitObjCCategoryDecl(const ObjCCategoryDecl *D) { 1461 dumpName(D); 1462 dumpDeclRef(D->getClassInterface()); 1463 dumpDeclRef(D->getImplementation()); 1464 for (ObjCCategoryDecl::protocol_iterator I = D->protocol_begin(), 1465 E = D->protocol_end(); 1466 I != E; ++I) 1467 dumpDeclRef(*I); 1468 } 1469 1470 void ASTDumper::VisitObjCCategoryImplDecl(const ObjCCategoryImplDecl *D) { 1471 dumpName(D); 1472 dumpDeclRef(D->getClassInterface()); 1473 dumpDeclRef(D->getCategoryDecl()); 1474 } 1475 1476 void ASTDumper::VisitObjCProtocolDecl(const ObjCProtocolDecl *D) { 1477 dumpName(D); 1478 1479 for (auto *Child : D->protocols()) 1480 dumpDeclRef(Child); 1481 } 1482 1483 void ASTDumper::VisitObjCInterfaceDecl(const ObjCInterfaceDecl *D) { 1484 dumpName(D); 1485 dumpDeclRef(D->getSuperClass(), "super"); 1486 1487 dumpDeclRef(D->getImplementation()); 1488 for (auto *Child : D->protocols()) 1489 dumpDeclRef(Child); 1490 } 1491 1492 void ASTDumper::VisitObjCImplementationDecl(const ObjCImplementationDecl *D) { 1493 dumpName(D); 1494 dumpDeclRef(D->getSuperClass(), "super"); 1495 dumpDeclRef(D->getClassInterface()); 1496 for (ObjCImplementationDecl::init_const_iterator I = D->init_begin(), 1497 E = D->init_end(); 1498 I != E; ++I) 1499 dumpCXXCtorInitializer(*I); 1500 } 1501 1502 void ASTDumper::VisitObjCCompatibleAliasDecl(const ObjCCompatibleAliasDecl *D) { 1503 dumpName(D); 1504 dumpDeclRef(D->getClassInterface()); 1505 } 1506 1507 void ASTDumper::VisitObjCPropertyDecl(const ObjCPropertyDecl *D) { 1508 dumpName(D); 1509 dumpType(D->getType()); 1510 1511 if (D->getPropertyImplementation() == ObjCPropertyDecl::Required) 1512 OS << " required"; 1513 else if (D->getPropertyImplementation() == ObjCPropertyDecl::Optional) 1514 OS << " optional"; 1515 1516 ObjCPropertyDecl::PropertyAttributeKind Attrs = D->getPropertyAttributes(); 1517 if (Attrs != ObjCPropertyDecl::OBJC_PR_noattr) { 1518 if (Attrs & ObjCPropertyDecl::OBJC_PR_readonly) 1519 OS << " readonly"; 1520 if (Attrs & ObjCPropertyDecl::OBJC_PR_assign) 1521 OS << " assign"; 1522 if (Attrs & ObjCPropertyDecl::OBJC_PR_readwrite) 1523 OS << " readwrite"; 1524 if (Attrs & ObjCPropertyDecl::OBJC_PR_retain) 1525 OS << " retain"; 1526 if (Attrs & ObjCPropertyDecl::OBJC_PR_copy) 1527 OS << " copy"; 1528 if (Attrs & ObjCPropertyDecl::OBJC_PR_nonatomic) 1529 OS << " nonatomic"; 1530 if (Attrs & ObjCPropertyDecl::OBJC_PR_atomic) 1531 OS << " atomic"; 1532 if (Attrs & ObjCPropertyDecl::OBJC_PR_weak) 1533 OS << " weak"; 1534 if (Attrs & ObjCPropertyDecl::OBJC_PR_strong) 1535 OS << " strong"; 1536 if (Attrs & ObjCPropertyDecl::OBJC_PR_unsafe_unretained) 1537 OS << " unsafe_unretained"; 1538 if (Attrs & ObjCPropertyDecl::OBJC_PR_getter) 1539 dumpDeclRef(D->getGetterMethodDecl(), "getter"); 1540 if (Attrs & ObjCPropertyDecl::OBJC_PR_setter) 1541 dumpDeclRef(D->getSetterMethodDecl(), "setter"); 1542 } 1543 } 1544 1545 void ASTDumper::VisitObjCPropertyImplDecl(const ObjCPropertyImplDecl *D) { 1546 dumpName(D->getPropertyDecl()); 1547 if (D->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) 1548 OS << " synthesize"; 1549 else 1550 OS << " dynamic"; 1551 dumpDeclRef(D->getPropertyDecl()); 1552 dumpDeclRef(D->getPropertyIvarDecl()); 1553 } 1554 1555 void ASTDumper::VisitBlockDecl(const BlockDecl *D) { 1556 for (auto I : D->params()) 1557 dumpDecl(I); 1558 1559 if (D->isVariadic()) 1560 dumpChild([=]{ OS << "..."; }); 1561 1562 if (D->capturesCXXThis()) 1563 dumpChild([=]{ OS << "capture this"; }); 1564 1565 for (const auto &I : D->captures()) { 1566 dumpChild([=] { 1567 OS << "capture"; 1568 if (I.isByRef()) 1569 OS << " byref"; 1570 if (I.isNested()) 1571 OS << " nested"; 1572 if (I.getVariable()) { 1573 OS << ' '; 1574 dumpBareDeclRef(I.getVariable()); 1575 } 1576 if (I.hasCopyExpr()) 1577 dumpStmt(I.getCopyExpr()); 1578 }); 1579 } 1580 dumpStmt(D->getBody()); 1581 } 1582 1583 //===----------------------------------------------------------------------===// 1584 // Stmt dumping methods. 1585 //===----------------------------------------------------------------------===// 1586 1587 void ASTDumper::dumpStmt(const Stmt *S) { 1588 dumpChild([=] { 1589 if (!S) { 1590 ColorScope Color(*this, NullColor); 1591 OS << "<<<NULL>>>"; 1592 return; 1593 } 1594 1595 if (const DeclStmt *DS = dyn_cast<DeclStmt>(S)) { 1596 VisitDeclStmt(DS); 1597 return; 1598 } 1599 1600 ConstStmtVisitor<ASTDumper>::Visit(S); 1601 1602 for (Stmt::const_child_range CI = S->children(); CI; ++CI) 1603 dumpStmt(*CI); 1604 }); 1605 } 1606 1607 void ASTDumper::VisitStmt(const Stmt *Node) { 1608 { 1609 ColorScope Color(*this, StmtColor); 1610 OS << Node->getStmtClassName(); 1611 } 1612 dumpPointer(Node); 1613 dumpSourceRange(Node->getSourceRange()); 1614 } 1615 1616 void ASTDumper::VisitDeclStmt(const DeclStmt *Node) { 1617 VisitStmt(Node); 1618 for (DeclStmt::const_decl_iterator I = Node->decl_begin(), 1619 E = Node->decl_end(); 1620 I != E; ++I) 1621 dumpDecl(*I); 1622 } 1623 1624 void ASTDumper::VisitAttributedStmt(const AttributedStmt *Node) { 1625 VisitStmt(Node); 1626 for (ArrayRef<const Attr *>::iterator I = Node->getAttrs().begin(), 1627 E = Node->getAttrs().end(); 1628 I != E; ++I) 1629 dumpAttr(*I); 1630 } 1631 1632 void ASTDumper::VisitLabelStmt(const LabelStmt *Node) { 1633 VisitStmt(Node); 1634 OS << " '" << Node->getName() << "'"; 1635 } 1636 1637 void ASTDumper::VisitGotoStmt(const GotoStmt *Node) { 1638 VisitStmt(Node); 1639 OS << " '" << Node->getLabel()->getName() << "'"; 1640 dumpPointer(Node->getLabel()); 1641 } 1642 1643 void ASTDumper::VisitCXXCatchStmt(const CXXCatchStmt *Node) { 1644 VisitStmt(Node); 1645 dumpDecl(Node->getExceptionDecl()); 1646 } 1647 1648 //===----------------------------------------------------------------------===// 1649 // Expr dumping methods. 1650 //===----------------------------------------------------------------------===// 1651 1652 void ASTDumper::VisitExpr(const Expr *Node) { 1653 VisitStmt(Node); 1654 dumpType(Node->getType()); 1655 1656 { 1657 ColorScope Color(*this, ValueKindColor); 1658 switch (Node->getValueKind()) { 1659 case VK_RValue: 1660 break; 1661 case VK_LValue: 1662 OS << " lvalue"; 1663 break; 1664 case VK_XValue: 1665 OS << " xvalue"; 1666 break; 1667 } 1668 } 1669 1670 { 1671 ColorScope Color(*this, ObjectKindColor); 1672 switch (Node->getObjectKind()) { 1673 case OK_Ordinary: 1674 break; 1675 case OK_BitField: 1676 OS << " bitfield"; 1677 break; 1678 case OK_ObjCProperty: 1679 OS << " objcproperty"; 1680 break; 1681 case OK_ObjCSubscript: 1682 OS << " objcsubscript"; 1683 break; 1684 case OK_VectorComponent: 1685 OS << " vectorcomponent"; 1686 break; 1687 } 1688 } 1689 } 1690 1691 static void dumpBasePath(raw_ostream &OS, const CastExpr *Node) { 1692 if (Node->path_empty()) 1693 return; 1694 1695 OS << " ("; 1696 bool First = true; 1697 for (CastExpr::path_const_iterator I = Node->path_begin(), 1698 E = Node->path_end(); 1699 I != E; ++I) { 1700 const CXXBaseSpecifier *Base = *I; 1701 if (!First) 1702 OS << " -> "; 1703 1704 const CXXRecordDecl *RD = 1705 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl()); 1706 1707 if (Base->isVirtual()) 1708 OS << "virtual "; 1709 OS << RD->getName(); 1710 First = false; 1711 } 1712 1713 OS << ')'; 1714 } 1715 1716 void ASTDumper::VisitCastExpr(const CastExpr *Node) { 1717 VisitExpr(Node); 1718 OS << " <"; 1719 { 1720 ColorScope Color(*this, CastColor); 1721 OS << Node->getCastKindName(); 1722 } 1723 dumpBasePath(OS, Node); 1724 OS << ">"; 1725 } 1726 1727 void ASTDumper::VisitDeclRefExpr(const DeclRefExpr *Node) { 1728 VisitExpr(Node); 1729 1730 OS << " "; 1731 dumpBareDeclRef(Node->getDecl()); 1732 if (Node->getDecl() != Node->getFoundDecl()) { 1733 OS << " ("; 1734 dumpBareDeclRef(Node->getFoundDecl()); 1735 OS << ")"; 1736 } 1737 } 1738 1739 void ASTDumper::VisitUnresolvedLookupExpr(const UnresolvedLookupExpr *Node) { 1740 VisitExpr(Node); 1741 OS << " ("; 1742 if (!Node->requiresADL()) 1743 OS << "no "; 1744 OS << "ADL) = '" << Node->getName() << '\''; 1745 1746 UnresolvedLookupExpr::decls_iterator 1747 I = Node->decls_begin(), E = Node->decls_end(); 1748 if (I == E) 1749 OS << " empty"; 1750 for (; I != E; ++I) 1751 dumpPointer(*I); 1752 } 1753 1754 void ASTDumper::VisitObjCIvarRefExpr(const ObjCIvarRefExpr *Node) { 1755 VisitExpr(Node); 1756 1757 { 1758 ColorScope Color(*this, DeclKindNameColor); 1759 OS << " " << Node->getDecl()->getDeclKindName() << "Decl"; 1760 } 1761 OS << "='" << *Node->getDecl() << "'"; 1762 dumpPointer(Node->getDecl()); 1763 if (Node->isFreeIvar()) 1764 OS << " isFreeIvar"; 1765 } 1766 1767 void ASTDumper::VisitPredefinedExpr(const PredefinedExpr *Node) { 1768 VisitExpr(Node); 1769 OS << " " << PredefinedExpr::getIdentTypeName(Node->getIdentType()); 1770 } 1771 1772 void ASTDumper::VisitCharacterLiteral(const CharacterLiteral *Node) { 1773 VisitExpr(Node); 1774 ColorScope Color(*this, ValueColor); 1775 OS << " " << Node->getValue(); 1776 } 1777 1778 void ASTDumper::VisitIntegerLiteral(const IntegerLiteral *Node) { 1779 VisitExpr(Node); 1780 1781 bool isSigned = Node->getType()->isSignedIntegerType(); 1782 ColorScope Color(*this, ValueColor); 1783 OS << " " << Node->getValue().toString(10, isSigned); 1784 } 1785 1786 void ASTDumper::VisitFloatingLiteral(const FloatingLiteral *Node) { 1787 VisitExpr(Node); 1788 ColorScope Color(*this, ValueColor); 1789 OS << " " << Node->getValueAsApproximateDouble(); 1790 } 1791 1792 void ASTDumper::VisitStringLiteral(const StringLiteral *Str) { 1793 VisitExpr(Str); 1794 ColorScope Color(*this, ValueColor); 1795 OS << " "; 1796 Str->outputString(OS); 1797 } 1798 1799 void ASTDumper::VisitInitListExpr(const InitListExpr *ILE) { 1800 VisitExpr(ILE); 1801 if (auto *Filler = ILE->getArrayFiller()) { 1802 dumpChild([=] { 1803 OS << "array filler"; 1804 dumpStmt(Filler); 1805 }); 1806 } 1807 if (auto *Field = ILE->getInitializedFieldInUnion()) { 1808 OS << " field "; 1809 dumpBareDeclRef(Field); 1810 } 1811 } 1812 1813 void ASTDumper::VisitUnaryOperator(const UnaryOperator *Node) { 1814 VisitExpr(Node); 1815 OS << " " << (Node->isPostfix() ? "postfix" : "prefix") 1816 << " '" << UnaryOperator::getOpcodeStr(Node->getOpcode()) << "'"; 1817 } 1818 1819 void ASTDumper::VisitUnaryExprOrTypeTraitExpr( 1820 const UnaryExprOrTypeTraitExpr *Node) { 1821 VisitExpr(Node); 1822 switch(Node->getKind()) { 1823 case UETT_SizeOf: 1824 OS << " sizeof"; 1825 break; 1826 case UETT_AlignOf: 1827 OS << " alignof"; 1828 break; 1829 case UETT_VecStep: 1830 OS << " vec_step"; 1831 break; 1832 } 1833 if (Node->isArgumentType()) 1834 dumpType(Node->getArgumentType()); 1835 } 1836 1837 void ASTDumper::VisitMemberExpr(const MemberExpr *Node) { 1838 VisitExpr(Node); 1839 OS << " " << (Node->isArrow() ? "->" : ".") << *Node->getMemberDecl(); 1840 dumpPointer(Node->getMemberDecl()); 1841 } 1842 1843 void ASTDumper::VisitExtVectorElementExpr(const ExtVectorElementExpr *Node) { 1844 VisitExpr(Node); 1845 OS << " " << Node->getAccessor().getNameStart(); 1846 } 1847 1848 void ASTDumper::VisitBinaryOperator(const BinaryOperator *Node) { 1849 VisitExpr(Node); 1850 OS << " '" << BinaryOperator::getOpcodeStr(Node->getOpcode()) << "'"; 1851 } 1852 1853 void ASTDumper::VisitCompoundAssignOperator( 1854 const CompoundAssignOperator *Node) { 1855 VisitExpr(Node); 1856 OS << " '" << BinaryOperator::getOpcodeStr(Node->getOpcode()) 1857 << "' ComputeLHSTy="; 1858 dumpBareType(Node->getComputationLHSType()); 1859 OS << " ComputeResultTy="; 1860 dumpBareType(Node->getComputationResultType()); 1861 } 1862 1863 void ASTDumper::VisitBlockExpr(const BlockExpr *Node) { 1864 VisitExpr(Node); 1865 dumpDecl(Node->getBlockDecl()); 1866 } 1867 1868 void ASTDumper::VisitOpaqueValueExpr(const OpaqueValueExpr *Node) { 1869 VisitExpr(Node); 1870 1871 if (Expr *Source = Node->getSourceExpr()) 1872 dumpStmt(Source); 1873 } 1874 1875 // GNU extensions. 1876 1877 void ASTDumper::VisitAddrLabelExpr(const AddrLabelExpr *Node) { 1878 VisitExpr(Node); 1879 OS << " " << Node->getLabel()->getName(); 1880 dumpPointer(Node->getLabel()); 1881 } 1882 1883 //===----------------------------------------------------------------------===// 1884 // C++ Expressions 1885 //===----------------------------------------------------------------------===// 1886 1887 void ASTDumper::VisitCXXNamedCastExpr(const CXXNamedCastExpr *Node) { 1888 VisitExpr(Node); 1889 OS << " " << Node->getCastName() 1890 << "<" << Node->getTypeAsWritten().getAsString() << ">" 1891 << " <" << Node->getCastKindName(); 1892 dumpBasePath(OS, Node); 1893 OS << ">"; 1894 } 1895 1896 void ASTDumper::VisitCXXBoolLiteralExpr(const CXXBoolLiteralExpr *Node) { 1897 VisitExpr(Node); 1898 OS << " " << (Node->getValue() ? "true" : "false"); 1899 } 1900 1901 void ASTDumper::VisitCXXThisExpr(const CXXThisExpr *Node) { 1902 VisitExpr(Node); 1903 OS << " this"; 1904 } 1905 1906 void ASTDumper::VisitCXXFunctionalCastExpr(const CXXFunctionalCastExpr *Node) { 1907 VisitExpr(Node); 1908 OS << " functional cast to " << Node->getTypeAsWritten().getAsString() 1909 << " <" << Node->getCastKindName() << ">"; 1910 } 1911 1912 void ASTDumper::VisitCXXConstructExpr(const CXXConstructExpr *Node) { 1913 VisitExpr(Node); 1914 CXXConstructorDecl *Ctor = Node->getConstructor(); 1915 dumpType(Ctor->getType()); 1916 if (Node->isElidable()) 1917 OS << " elidable"; 1918 if (Node->requiresZeroInitialization()) 1919 OS << " zeroing"; 1920 } 1921 1922 void ASTDumper::VisitCXXBindTemporaryExpr(const CXXBindTemporaryExpr *Node) { 1923 VisitExpr(Node); 1924 OS << " "; 1925 dumpCXXTemporary(Node->getTemporary()); 1926 } 1927 1928 void ASTDumper::VisitCXXNewExpr(const CXXNewExpr *Node) { 1929 VisitExpr(Node); 1930 if (Node->isGlobalNew()) 1931 OS << " global"; 1932 if (Node->isArray()) 1933 OS << " array"; 1934 if (Node->getOperatorNew()) { 1935 OS << ' '; 1936 dumpBareDeclRef(Node->getOperatorNew()); 1937 } 1938 // We could dump the deallocation function used in case of error, but it's 1939 // usually not that interesting. 1940 } 1941 1942 void ASTDumper::VisitCXXDeleteExpr(const CXXDeleteExpr *Node) { 1943 VisitExpr(Node); 1944 if (Node->isGlobalDelete()) 1945 OS << " global"; 1946 if (Node->isArrayForm()) 1947 OS << " array"; 1948 if (Node->getOperatorDelete()) { 1949 OS << ' '; 1950 dumpBareDeclRef(Node->getOperatorDelete()); 1951 } 1952 } 1953 1954 void 1955 ASTDumper::VisitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *Node) { 1956 VisitExpr(Node); 1957 if (const ValueDecl *VD = Node->getExtendingDecl()) { 1958 OS << " extended by "; 1959 dumpBareDeclRef(VD); 1960 } 1961 } 1962 1963 void ASTDumper::VisitExprWithCleanups(const ExprWithCleanups *Node) { 1964 VisitExpr(Node); 1965 for (unsigned i = 0, e = Node->getNumObjects(); i != e; ++i) 1966 dumpDeclRef(Node->getObject(i), "cleanup"); 1967 } 1968 1969 void ASTDumper::dumpCXXTemporary(const CXXTemporary *Temporary) { 1970 OS << "(CXXTemporary"; 1971 dumpPointer(Temporary); 1972 OS << ")"; 1973 } 1974 1975 void ASTDumper::VisitSizeOfPackExpr(const SizeOfPackExpr *Node) { 1976 VisitExpr(Node); 1977 dumpPointer(Node->getPack()); 1978 dumpName(Node->getPack()); 1979 } 1980 1981 1982 //===----------------------------------------------------------------------===// 1983 // Obj-C Expressions 1984 //===----------------------------------------------------------------------===// 1985 1986 void ASTDumper::VisitObjCMessageExpr(const ObjCMessageExpr *Node) { 1987 VisitExpr(Node); 1988 OS << " selector="; 1989 Node->getSelector().print(OS); 1990 switch (Node->getReceiverKind()) { 1991 case ObjCMessageExpr::Instance: 1992 break; 1993 1994 case ObjCMessageExpr::Class: 1995 OS << " class="; 1996 dumpBareType(Node->getClassReceiver()); 1997 break; 1998 1999 case ObjCMessageExpr::SuperInstance: 2000 OS << " super (instance)"; 2001 break; 2002 2003 case ObjCMessageExpr::SuperClass: 2004 OS << " super (class)"; 2005 break; 2006 } 2007 } 2008 2009 void ASTDumper::VisitObjCBoxedExpr(const ObjCBoxedExpr *Node) { 2010 VisitExpr(Node); 2011 OS << " selector="; 2012 Node->getBoxingMethod()->getSelector().print(OS); 2013 } 2014 2015 void ASTDumper::VisitObjCAtCatchStmt(const ObjCAtCatchStmt *Node) { 2016 VisitStmt(Node); 2017 if (const VarDecl *CatchParam = Node->getCatchParamDecl()) 2018 dumpDecl(CatchParam); 2019 else 2020 OS << " catch all"; 2021 } 2022 2023 void ASTDumper::VisitObjCEncodeExpr(const ObjCEncodeExpr *Node) { 2024 VisitExpr(Node); 2025 dumpType(Node->getEncodedType()); 2026 } 2027 2028 void ASTDumper::VisitObjCSelectorExpr(const ObjCSelectorExpr *Node) { 2029 VisitExpr(Node); 2030 2031 OS << " "; 2032 Node->getSelector().print(OS); 2033 } 2034 2035 void ASTDumper::VisitObjCProtocolExpr(const ObjCProtocolExpr *Node) { 2036 VisitExpr(Node); 2037 2038 OS << ' ' << *Node->getProtocol(); 2039 } 2040 2041 void ASTDumper::VisitObjCPropertyRefExpr(const ObjCPropertyRefExpr *Node) { 2042 VisitExpr(Node); 2043 if (Node->isImplicitProperty()) { 2044 OS << " Kind=MethodRef Getter=\""; 2045 if (Node->getImplicitPropertyGetter()) 2046 Node->getImplicitPropertyGetter()->getSelector().print(OS); 2047 else 2048 OS << "(null)"; 2049 2050 OS << "\" Setter=\""; 2051 if (ObjCMethodDecl *Setter = Node->getImplicitPropertySetter()) 2052 Setter->getSelector().print(OS); 2053 else 2054 OS << "(null)"; 2055 OS << "\""; 2056 } else { 2057 OS << " Kind=PropertyRef Property=\"" << *Node->getExplicitProperty() <<'"'; 2058 } 2059 2060 if (Node->isSuperReceiver()) 2061 OS << " super"; 2062 2063 OS << " Messaging="; 2064 if (Node->isMessagingGetter() && Node->isMessagingSetter()) 2065 OS << "Getter&Setter"; 2066 else if (Node->isMessagingGetter()) 2067 OS << "Getter"; 2068 else if (Node->isMessagingSetter()) 2069 OS << "Setter"; 2070 } 2071 2072 void ASTDumper::VisitObjCSubscriptRefExpr(const ObjCSubscriptRefExpr *Node) { 2073 VisitExpr(Node); 2074 if (Node->isArraySubscriptRefExpr()) 2075 OS << " Kind=ArraySubscript GetterForArray=\""; 2076 else 2077 OS << " Kind=DictionarySubscript GetterForDictionary=\""; 2078 if (Node->getAtIndexMethodDecl()) 2079 Node->getAtIndexMethodDecl()->getSelector().print(OS); 2080 else 2081 OS << "(null)"; 2082 2083 if (Node->isArraySubscriptRefExpr()) 2084 OS << "\" SetterForArray=\""; 2085 else 2086 OS << "\" SetterForDictionary=\""; 2087 if (Node->setAtIndexMethodDecl()) 2088 Node->setAtIndexMethodDecl()->getSelector().print(OS); 2089 else 2090 OS << "(null)"; 2091 } 2092 2093 void ASTDumper::VisitObjCBoolLiteralExpr(const ObjCBoolLiteralExpr *Node) { 2094 VisitExpr(Node); 2095 OS << " " << (Node->getValue() ? "__objc_yes" : "__objc_no"); 2096 } 2097 2098 //===----------------------------------------------------------------------===// 2099 // Comments 2100 //===----------------------------------------------------------------------===// 2101 2102 const char *ASTDumper::getCommandName(unsigned CommandID) { 2103 if (Traits) 2104 return Traits->getCommandInfo(CommandID)->Name; 2105 const CommandInfo *Info = CommandTraits::getBuiltinCommandInfo(CommandID); 2106 if (Info) 2107 return Info->Name; 2108 return "<not a builtin command>"; 2109 } 2110 2111 void ASTDumper::dumpFullComment(const FullComment *C) { 2112 if (!C) 2113 return; 2114 2115 FC = C; 2116 dumpComment(C); 2117 FC = nullptr; 2118 } 2119 2120 void ASTDumper::dumpComment(const Comment *C) { 2121 dumpChild([=] { 2122 if (!C) { 2123 ColorScope Color(*this, NullColor); 2124 OS << "<<<NULL>>>"; 2125 return; 2126 } 2127 2128 { 2129 ColorScope Color(*this, CommentColor); 2130 OS << C->getCommentKindName(); 2131 } 2132 dumpPointer(C); 2133 dumpSourceRange(C->getSourceRange()); 2134 ConstCommentVisitor<ASTDumper>::visit(C); 2135 for (Comment::child_iterator I = C->child_begin(), E = C->child_end(); 2136 I != E; ++I) 2137 dumpComment(*I); 2138 }); 2139 } 2140 2141 void ASTDumper::visitTextComment(const TextComment *C) { 2142 OS << " Text=\"" << C->getText() << "\""; 2143 } 2144 2145 void ASTDumper::visitInlineCommandComment(const InlineCommandComment *C) { 2146 OS << " Name=\"" << getCommandName(C->getCommandID()) << "\""; 2147 switch (C->getRenderKind()) { 2148 case InlineCommandComment::RenderNormal: 2149 OS << " RenderNormal"; 2150 break; 2151 case InlineCommandComment::RenderBold: 2152 OS << " RenderBold"; 2153 break; 2154 case InlineCommandComment::RenderMonospaced: 2155 OS << " RenderMonospaced"; 2156 break; 2157 case InlineCommandComment::RenderEmphasized: 2158 OS << " RenderEmphasized"; 2159 break; 2160 } 2161 2162 for (unsigned i = 0, e = C->getNumArgs(); i != e; ++i) 2163 OS << " Arg[" << i << "]=\"" << C->getArgText(i) << "\""; 2164 } 2165 2166 void ASTDumper::visitHTMLStartTagComment(const HTMLStartTagComment *C) { 2167 OS << " Name=\"" << C->getTagName() << "\""; 2168 if (C->getNumAttrs() != 0) { 2169 OS << " Attrs: "; 2170 for (unsigned i = 0, e = C->getNumAttrs(); i != e; ++i) { 2171 const HTMLStartTagComment::Attribute &Attr = C->getAttr(i); 2172 OS << " \"" << Attr.Name << "=\"" << Attr.Value << "\""; 2173 } 2174 } 2175 if (C->isSelfClosing()) 2176 OS << " SelfClosing"; 2177 } 2178 2179 void ASTDumper::visitHTMLEndTagComment(const HTMLEndTagComment *C) { 2180 OS << " Name=\"" << C->getTagName() << "\""; 2181 } 2182 2183 void ASTDumper::visitBlockCommandComment(const BlockCommandComment *C) { 2184 OS << " Name=\"" << getCommandName(C->getCommandID()) << "\""; 2185 for (unsigned i = 0, e = C->getNumArgs(); i != e; ++i) 2186 OS << " Arg[" << i << "]=\"" << C->getArgText(i) << "\""; 2187 } 2188 2189 void ASTDumper::visitParamCommandComment(const ParamCommandComment *C) { 2190 OS << " " << ParamCommandComment::getDirectionAsString(C->getDirection()); 2191 2192 if (C->isDirectionExplicit()) 2193 OS << " explicitly"; 2194 else 2195 OS << " implicitly"; 2196 2197 if (C->hasParamName()) { 2198 if (C->isParamIndexValid()) 2199 OS << " Param=\"" << C->getParamName(FC) << "\""; 2200 else 2201 OS << " Param=\"" << C->getParamNameAsWritten() << "\""; 2202 } 2203 2204 if (C->isParamIndexValid() && !C->isVarArgParam()) 2205 OS << " ParamIndex=" << C->getParamIndex(); 2206 } 2207 2208 void ASTDumper::visitTParamCommandComment(const TParamCommandComment *C) { 2209 if (C->hasParamName()) { 2210 if (C->isPositionValid()) 2211 OS << " Param=\"" << C->getParamName(FC) << "\""; 2212 else 2213 OS << " Param=\"" << C->getParamNameAsWritten() << "\""; 2214 } 2215 2216 if (C->isPositionValid()) { 2217 OS << " Position=<"; 2218 for (unsigned i = 0, e = C->getDepth(); i != e; ++i) { 2219 OS << C->getIndex(i); 2220 if (i != e - 1) 2221 OS << ", "; 2222 } 2223 OS << ">"; 2224 } 2225 } 2226 2227 void ASTDumper::visitVerbatimBlockComment(const VerbatimBlockComment *C) { 2228 OS << " Name=\"" << getCommandName(C->getCommandID()) << "\"" 2229 " CloseName=\"" << C->getCloseName() << "\""; 2230 } 2231 2232 void ASTDumper::visitVerbatimBlockLineComment( 2233 const VerbatimBlockLineComment *C) { 2234 OS << " Text=\"" << C->getText() << "\""; 2235 } 2236 2237 void ASTDumper::visitVerbatimLineComment(const VerbatimLineComment *C) { 2238 OS << " Text=\"" << C->getText() << "\""; 2239 } 2240 2241 //===----------------------------------------------------------------------===// 2242 // Type method implementations 2243 //===----------------------------------------------------------------------===// 2244 2245 void QualType::dump(const char *msg) const { 2246 if (msg) 2247 llvm::errs() << msg << ": "; 2248 dump(); 2249 } 2250 2251 LLVM_DUMP_METHOD void QualType::dump() const { 2252 ASTDumper Dumper(llvm::errs(), nullptr, nullptr); 2253 Dumper.dumpTypeAsChild(*this); 2254 } 2255 2256 LLVM_DUMP_METHOD void Type::dump() const { QualType(this, 0).dump(); } 2257 2258 //===----------------------------------------------------------------------===// 2259 // Decl method implementations 2260 //===----------------------------------------------------------------------===// 2261 2262 LLVM_DUMP_METHOD void Decl::dump() const { dump(llvm::errs()); } 2263 2264 LLVM_DUMP_METHOD void Decl::dump(raw_ostream &OS) const { 2265 ASTDumper P(OS, &getASTContext().getCommentCommandTraits(), 2266 &getASTContext().getSourceManager()); 2267 P.dumpDecl(this); 2268 } 2269 2270 LLVM_DUMP_METHOD void Decl::dumpColor() const { 2271 ASTDumper P(llvm::errs(), &getASTContext().getCommentCommandTraits(), 2272 &getASTContext().getSourceManager(), /*ShowColors*/true); 2273 P.dumpDecl(this); 2274 } 2275 2276 LLVM_DUMP_METHOD void DeclContext::dumpLookups() const { 2277 dumpLookups(llvm::errs()); 2278 } 2279 2280 LLVM_DUMP_METHOD void DeclContext::dumpLookups(raw_ostream &OS, 2281 bool DumpDecls) const { 2282 const DeclContext *DC = this; 2283 while (!DC->isTranslationUnit()) 2284 DC = DC->getParent(); 2285 ASTContext &Ctx = cast<TranslationUnitDecl>(DC)->getASTContext(); 2286 ASTDumper P(OS, &Ctx.getCommentCommandTraits(), &Ctx.getSourceManager()); 2287 P.dumpLookups(this, DumpDecls); 2288 } 2289 2290 //===----------------------------------------------------------------------===// 2291 // Stmt method implementations 2292 //===----------------------------------------------------------------------===// 2293 2294 LLVM_DUMP_METHOD void Stmt::dump(SourceManager &SM) const { 2295 dump(llvm::errs(), SM); 2296 } 2297 2298 LLVM_DUMP_METHOD void Stmt::dump(raw_ostream &OS, SourceManager &SM) const { 2299 ASTDumper P(OS, nullptr, &SM); 2300 P.dumpStmt(this); 2301 } 2302 2303 LLVM_DUMP_METHOD void Stmt::dump(raw_ostream &OS) const { 2304 ASTDumper P(OS, nullptr, nullptr); 2305 P.dumpStmt(this); 2306 } 2307 2308 LLVM_DUMP_METHOD void Stmt::dump() const { 2309 ASTDumper P(llvm::errs(), nullptr, nullptr); 2310 P.dumpStmt(this); 2311 } 2312 2313 LLVM_DUMP_METHOD void Stmt::dumpColor() const { 2314 ASTDumper P(llvm::errs(), nullptr, nullptr, /*ShowColors*/true); 2315 P.dumpStmt(this); 2316 } 2317 2318 //===----------------------------------------------------------------------===// 2319 // Comment method implementations 2320 //===----------------------------------------------------------------------===// 2321 2322 LLVM_DUMP_METHOD void Comment::dump() const { 2323 dump(llvm::errs(), nullptr, nullptr); 2324 } 2325 2326 LLVM_DUMP_METHOD void Comment::dump(const ASTContext &Context) const { 2327 dump(llvm::errs(), &Context.getCommentCommandTraits(), 2328 &Context.getSourceManager()); 2329 } 2330 2331 void Comment::dump(raw_ostream &OS, const CommandTraits *Traits, 2332 const SourceManager *SM) const { 2333 const FullComment *FC = dyn_cast<FullComment>(this); 2334 ASTDumper D(OS, Traits, SM); 2335 D.dumpFullComment(FC); 2336 } 2337 2338 LLVM_DUMP_METHOD void Comment::dumpColor() const { 2339 const FullComment *FC = dyn_cast<FullComment>(this); 2340 ASTDumper D(llvm::errs(), nullptr, nullptr, /*ShowColors*/true); 2341 D.dumpFullComment(FC); 2342 } 2343