contrib/llvm/tools/clang/lib/AST/ASTDumper.cpp

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