1 //===--- ASTDumper.cpp - Dumping implementation for ASTs ------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the AST dump methods, which dump out the
11 // AST in a form that exposes type details and other fields.
13 //===----------------------------------------------------------------------===//
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/DeclOpenMP.h"
22 #include "clang/AST/DeclVisitor.h"
23 #include "clang/AST/LocInfoType.h"
24 #include "clang/AST/StmtVisitor.h"
25 #include "clang/AST/TypeVisitor.h"
26 #include "clang/Basic/Builtins.h"
27 #include "clang/Basic/Module.h"
28 #include "clang/Basic/SourceManager.h"
29 #include "llvm/Support/raw_ostream.h"
30 using namespace clang;
31 using namespace clang::comments;
33 //===----------------------------------------------------------------------===//
35 //===----------------------------------------------------------------------===//
38 // Colors used for various parts of the AST dump
39 // Do not use bold yellow for any text. It is hard to read on white screens.
41 struct TerminalColor {
42 raw_ostream::Colors Color;
48 // Bold Green - DeclKindNameColor, UndeserializedColor
49 // Yellow - AddressColor, LocationColor
50 // Blue - CommentColor, NullColor, IndentColor
51 // Bold Blue - AttrColor
52 // Bold Magenta - StmtColor
53 // Cyan - ValueKindColor, ObjectKindColor
54 // Bold Cyan - ValueColor, DeclNameColor
56 // Decl kind names (VarDecl, FunctionDecl, etc)
57 static const TerminalColor DeclKindNameColor = { raw_ostream::GREEN, true };
58 // Attr names (CleanupAttr, GuardedByAttr, etc)
59 static const TerminalColor AttrColor = { raw_ostream::BLUE, true };
60 // Statement names (DeclStmt, ImplicitCastExpr, etc)
61 static const TerminalColor StmtColor = { raw_ostream::MAGENTA, true };
62 // Comment names (FullComment, ParagraphComment, TextComment, etc)
63 static const TerminalColor CommentColor = { raw_ostream::BLUE, false };
65 // Type names (int, float, etc, plus user defined types)
66 static const TerminalColor TypeColor = { raw_ostream::GREEN, false };
69 static const TerminalColor AddressColor = { raw_ostream::YELLOW, false };
71 static const TerminalColor LocationColor = { raw_ostream::YELLOW, false };
74 static const TerminalColor ValueKindColor = { raw_ostream::CYAN, false };
75 // bitfield/objcproperty/objcsubscript/vectorcomponent
76 static const TerminalColor ObjectKindColor = { raw_ostream::CYAN, false };
79 static const TerminalColor NullColor = { raw_ostream::BLUE, false };
81 // Undeserialized entities
82 static const TerminalColor UndeserializedColor = { raw_ostream::GREEN, true };
84 // CastKind from CastExpr's
85 static const TerminalColor CastColor = { raw_ostream::RED, false };
87 // Value of the statement
88 static const TerminalColor ValueColor = { raw_ostream::CYAN, true };
90 static const TerminalColor DeclNameColor = { raw_ostream::CYAN, true };
92 // Indents ( `, -. | )
93 static const TerminalColor IndentColor = { raw_ostream::BLUE, false };
96 : public ConstDeclVisitor<ASTDumper>, public ConstStmtVisitor<ASTDumper>,
97 public ConstCommentVisitor<ASTDumper>, public TypeVisitor<ASTDumper> {
99 const CommandTraits *Traits;
100 const SourceManager *SM;
102 /// The policy to use for printing; can be defaulted.
103 PrintingPolicy PrintPolicy;
105 /// Pending[i] is an action to dump an entity at level i.
106 llvm::SmallVector<std::function<void(bool isLastChild)>, 32> Pending;
108 /// Indicates whether we should trigger deserialization of nodes that had
109 /// not already been loaded.
110 bool Deserialize = false;
112 /// Indicates whether we're at the top level.
113 bool TopLevel = true;
115 /// Indicates if we're handling the first child after entering a new depth.
116 bool FirstChild = true;
118 /// Prefix for currently-being-dumped entity.
121 /// Keep track of the last location we print out so that we can
122 /// print out deltas from then on out.
123 const char *LastLocFilename = "";
124 unsigned LastLocLine = ~0U;
126 /// The \c FullComment parent of the comment being dumped.
127 const FullComment *FC = nullptr;
131 /// Dump a child of the current node.
132 template<typename Fn> void dumpChild(Fn doDumpChild) {
133 // If we're at the top level, there's nothing interesting to do; just
138 while (!Pending.empty()) {
139 Pending.back()(true);
148 const FullComment *OrigFC = FC;
149 auto dumpWithIndent = [this, doDumpChild, OrigFC](bool isLastChild) {
150 // Print out the appropriate tree structure and work out the prefix for
151 // children of this node. For instance:
155 // | `-C Prefix = "| "
157 // |-E Prefix = " | "
161 // Note that the first level gets no prefix.
164 ColorScope Color(*this, IndentColor);
165 OS << Prefix << (isLastChild ? '`' : '|') << '-';
166 this->Prefix.push_back(isLastChild ? ' ' : '|');
167 this->Prefix.push_back(' ');
171 unsigned Depth = Pending.size();
176 // If any children are left, they're the last at their nesting level.
177 // Dump those ones out now.
178 while (Depth < Pending.size()) {
179 Pending.back()(true);
180 this->Pending.pop_back();
183 // Restore the old prefix.
184 this->Prefix.resize(Prefix.size() - 2);
188 Pending.push_back(std::move(dumpWithIndent));
190 Pending.back()(false);
191 Pending.back() = std::move(dumpWithIndent);
199 ColorScope(ASTDumper &Dumper, TerminalColor Color)
201 if (Dumper.ShowColors)
202 Dumper.OS.changeColor(Color.Color, Color.Bold);
205 if (Dumper.ShowColors)
206 Dumper.OS.resetColor();
211 ASTDumper(raw_ostream &OS, const CommandTraits *Traits,
212 const SourceManager *SM)
213 : ASTDumper(OS, Traits, SM,
214 SM && SM->getDiagnostics().getShowColors()) {}
216 ASTDumper(raw_ostream &OS, const CommandTraits *Traits,
217 const SourceManager *SM, bool ShowColors)
218 : ASTDumper(OS, Traits, SM, ShowColors, LangOptions()) {}
219 ASTDumper(raw_ostream &OS, const CommandTraits *Traits,
220 const SourceManager *SM, bool ShowColors,
221 const PrintingPolicy &PrintPolicy)
222 : OS(OS), Traits(Traits), SM(SM), PrintPolicy(PrintPolicy),
223 ShowColors(ShowColors) {}
225 void setDeserialize(bool D) { Deserialize = D; }
227 void dumpDecl(const Decl *D);
228 void dumpStmt(const Stmt *S);
229 void dumpFullComment(const FullComment *C);
232 void dumpPointer(const void *Ptr);
233 void dumpSourceRange(SourceRange R);
234 void dumpLocation(SourceLocation Loc);
235 void dumpBareType(QualType T, bool Desugar = true);
236 void dumpType(QualType T);
237 void dumpTypeAsChild(QualType T);
238 void dumpTypeAsChild(const Type *T);
239 void dumpBareDeclRef(const Decl *Node);
240 void dumpDeclRef(const Decl *Node, const char *Label = nullptr);
241 void dumpName(const NamedDecl *D);
242 bool hasNodes(const DeclContext *DC);
243 void dumpDeclContext(const DeclContext *DC);
244 void dumpLookups(const DeclContext *DC, bool DumpDecls);
245 void dumpAttr(const Attr *A);
248 void dumpAccessSpecifier(AccessSpecifier AS);
249 void dumpCXXCtorInitializer(const CXXCtorInitializer *Init);
250 void dumpTemplateParameters(const TemplateParameterList *TPL);
251 void dumpTemplateArgumentListInfo(const TemplateArgumentListInfo &TALI);
252 void dumpTemplateArgumentLoc(const TemplateArgumentLoc &A);
253 void dumpTemplateArgumentList(const TemplateArgumentList &TAL);
254 void dumpTemplateArgument(const TemplateArgument &A,
255 SourceRange R = SourceRange());
257 // Objective-C utilities.
258 void dumpObjCTypeParamList(const ObjCTypeParamList *typeParams);
261 void VisitComplexType(const ComplexType *T) {
262 dumpTypeAsChild(T->getElementType());
264 void VisitPointerType(const PointerType *T) {
265 dumpTypeAsChild(T->getPointeeType());
267 void VisitBlockPointerType(const BlockPointerType *T) {
268 dumpTypeAsChild(T->getPointeeType());
270 void VisitReferenceType(const ReferenceType *T) {
271 dumpTypeAsChild(T->getPointeeType());
273 void VisitRValueReferenceType(const ReferenceType *T) {
274 if (T->isSpelledAsLValue())
275 OS << " written as lvalue reference";
276 VisitReferenceType(T);
278 void VisitMemberPointerType(const MemberPointerType *T) {
279 dumpTypeAsChild(T->getClass());
280 dumpTypeAsChild(T->getPointeeType());
282 void VisitArrayType(const ArrayType *T) {
283 switch (T->getSizeModifier()) {
284 case ArrayType::Normal: break;
285 case ArrayType::Static: OS << " static"; break;
286 case ArrayType::Star: OS << " *"; break;
288 OS << " " << T->getIndexTypeQualifiers().getAsString();
289 dumpTypeAsChild(T->getElementType());
291 void VisitConstantArrayType(const ConstantArrayType *T) {
292 OS << " " << T->getSize();
295 void VisitVariableArrayType(const VariableArrayType *T) {
297 dumpSourceRange(T->getBracketsRange());
299 dumpStmt(T->getSizeExpr());
301 void VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
304 dumpSourceRange(T->getBracketsRange());
305 dumpStmt(T->getSizeExpr());
307 void VisitDependentSizedExtVectorType(
308 const DependentSizedExtVectorType *T) {
310 dumpLocation(T->getAttributeLoc());
311 dumpTypeAsChild(T->getElementType());
312 dumpStmt(T->getSizeExpr());
314 void VisitVectorType(const VectorType *T) {
315 switch (T->getVectorKind()) {
316 case VectorType::GenericVector: break;
317 case VectorType::AltiVecVector: OS << " altivec"; break;
318 case VectorType::AltiVecPixel: OS << " altivec pixel"; break;
319 case VectorType::AltiVecBool: OS << " altivec bool"; break;
320 case VectorType::NeonVector: OS << " neon"; break;
321 case VectorType::NeonPolyVector: OS << " neon poly"; break;
323 OS << " " << T->getNumElements();
324 dumpTypeAsChild(T->getElementType());
326 void VisitFunctionType(const FunctionType *T) {
327 auto EI = T->getExtInfo();
328 if (EI.getNoReturn()) OS << " noreturn";
329 if (EI.getProducesResult()) OS << " produces_result";
330 if (EI.getHasRegParm()) OS << " regparm " << EI.getRegParm();
331 OS << " " << FunctionType::getNameForCallConv(EI.getCC());
332 dumpTypeAsChild(T->getReturnType());
334 void VisitFunctionProtoType(const FunctionProtoType *T) {
335 auto EPI = T->getExtProtoInfo();
336 if (EPI.HasTrailingReturn) OS << " trailing_return";
337 if (T->isConst()) OS << " const";
338 if (T->isVolatile()) OS << " volatile";
339 if (T->isRestrict()) OS << " restrict";
340 switch (EPI.RefQualifier) {
342 case RQ_LValue: OS << " &"; break;
343 case RQ_RValue: OS << " &&"; break;
345 // FIXME: Exception specification.
346 // FIXME: Consumed parameters.
347 VisitFunctionType(T);
348 for (QualType PT : T->getParamTypes())
351 dumpChild([=] { OS << "..."; });
353 void VisitUnresolvedUsingType(const UnresolvedUsingType *T) {
354 dumpDeclRef(T->getDecl());
356 void VisitTypedefType(const TypedefType *T) {
357 dumpDeclRef(T->getDecl());
359 void VisitTypeOfExprType(const TypeOfExprType *T) {
360 dumpStmt(T->getUnderlyingExpr());
362 void VisitDecltypeType(const DecltypeType *T) {
363 dumpStmt(T->getUnderlyingExpr());
365 void VisitUnaryTransformType(const UnaryTransformType *T) {
366 switch (T->getUTTKind()) {
367 case UnaryTransformType::EnumUnderlyingType:
368 OS << " underlying_type";
371 dumpTypeAsChild(T->getBaseType());
373 void VisitTagType(const TagType *T) {
374 dumpDeclRef(T->getDecl());
376 void VisitAttributedType(const AttributedType *T) {
378 dumpTypeAsChild(T->getModifiedType());
380 void VisitTemplateTypeParmType(const TemplateTypeParmType *T) {
381 OS << " depth " << T->getDepth() << " index " << T->getIndex();
382 if (T->isParameterPack()) OS << " pack";
383 dumpDeclRef(T->getDecl());
385 void VisitSubstTemplateTypeParmType(const SubstTemplateTypeParmType *T) {
386 dumpTypeAsChild(T->getReplacedParameter());
388 void VisitSubstTemplateTypeParmPackType(
389 const SubstTemplateTypeParmPackType *T) {
390 dumpTypeAsChild(T->getReplacedParameter());
391 dumpTemplateArgument(T->getArgumentPack());
393 void VisitAutoType(const AutoType *T) {
394 if (T->isDecltypeAuto()) OS << " decltype(auto)";
398 void VisitTemplateSpecializationType(const TemplateSpecializationType *T) {
399 if (T->isTypeAlias()) OS << " alias";
400 OS << " "; T->getTemplateName().dump(OS);
402 dumpTemplateArgument(Arg);
403 if (T->isTypeAlias())
404 dumpTypeAsChild(T->getAliasedType());
406 void VisitInjectedClassNameType(const InjectedClassNameType *T) {
407 dumpDeclRef(T->getDecl());
409 void VisitObjCInterfaceType(const ObjCInterfaceType *T) {
410 dumpDeclRef(T->getDecl());
412 void VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
413 dumpTypeAsChild(T->getPointeeType());
415 void VisitAtomicType(const AtomicType *T) {
416 dumpTypeAsChild(T->getValueType());
418 void VisitPipeType(const PipeType *T) {
419 dumpTypeAsChild(T->getElementType());
421 void VisitAdjustedType(const AdjustedType *T) {
422 dumpTypeAsChild(T->getOriginalType());
424 void VisitPackExpansionType(const PackExpansionType *T) {
425 if (auto N = T->getNumExpansions()) OS << " expansions " << *N;
427 dumpTypeAsChild(T->getPattern());
429 // FIXME: ElaboratedType, DependentNameType,
430 // DependentTemplateSpecializationType, ObjCObjectType
433 void VisitLabelDecl(const LabelDecl *D);
434 void VisitTypedefDecl(const TypedefDecl *D);
435 void VisitEnumDecl(const EnumDecl *D);
436 void VisitRecordDecl(const RecordDecl *D);
437 void VisitEnumConstantDecl(const EnumConstantDecl *D);
438 void VisitIndirectFieldDecl(const IndirectFieldDecl *D);
439 void VisitFunctionDecl(const FunctionDecl *D);
440 void VisitFieldDecl(const FieldDecl *D);
441 void VisitVarDecl(const VarDecl *D);
442 void VisitDecompositionDecl(const DecompositionDecl *D);
443 void VisitBindingDecl(const BindingDecl *D);
444 void VisitFileScopeAsmDecl(const FileScopeAsmDecl *D);
445 void VisitImportDecl(const ImportDecl *D);
446 void VisitPragmaCommentDecl(const PragmaCommentDecl *D);
447 void VisitPragmaDetectMismatchDecl(const PragmaDetectMismatchDecl *D);
448 void VisitCapturedDecl(const CapturedDecl *D);
451 void VisitOMPThreadPrivateDecl(const OMPThreadPrivateDecl *D);
452 void VisitOMPDeclareReductionDecl(const OMPDeclareReductionDecl *D);
453 void VisitOMPCapturedExprDecl(const OMPCapturedExprDecl *D);
456 void VisitNamespaceDecl(const NamespaceDecl *D);
457 void VisitUsingDirectiveDecl(const UsingDirectiveDecl *D);
458 void VisitNamespaceAliasDecl(const NamespaceAliasDecl *D);
459 void VisitTypeAliasDecl(const TypeAliasDecl *D);
460 void VisitTypeAliasTemplateDecl(const TypeAliasTemplateDecl *D);
461 void VisitCXXRecordDecl(const CXXRecordDecl *D);
462 void VisitStaticAssertDecl(const StaticAssertDecl *D);
463 template<typename SpecializationDecl>
464 void VisitTemplateDeclSpecialization(const SpecializationDecl *D,
465 bool DumpExplicitInst,
467 template<typename TemplateDecl>
468 void VisitTemplateDecl(const TemplateDecl *D, bool DumpExplicitInst);
469 void VisitFunctionTemplateDecl(const FunctionTemplateDecl *D);
470 void VisitClassTemplateDecl(const ClassTemplateDecl *D);
471 void VisitClassTemplateSpecializationDecl(
472 const ClassTemplateSpecializationDecl *D);
473 void VisitClassTemplatePartialSpecializationDecl(
474 const ClassTemplatePartialSpecializationDecl *D);
475 void VisitClassScopeFunctionSpecializationDecl(
476 const ClassScopeFunctionSpecializationDecl *D);
477 void VisitBuiltinTemplateDecl(const BuiltinTemplateDecl *D);
478 void VisitVarTemplateDecl(const VarTemplateDecl *D);
479 void VisitVarTemplateSpecializationDecl(
480 const VarTemplateSpecializationDecl *D);
481 void VisitVarTemplatePartialSpecializationDecl(
482 const VarTemplatePartialSpecializationDecl *D);
483 void VisitTemplateTypeParmDecl(const TemplateTypeParmDecl *D);
484 void VisitNonTypeTemplateParmDecl(const NonTypeTemplateParmDecl *D);
485 void VisitTemplateTemplateParmDecl(const TemplateTemplateParmDecl *D);
486 void VisitUsingDecl(const UsingDecl *D);
487 void VisitUnresolvedUsingTypenameDecl(const UnresolvedUsingTypenameDecl *D);
488 void VisitUnresolvedUsingValueDecl(const UnresolvedUsingValueDecl *D);
489 void VisitUsingShadowDecl(const UsingShadowDecl *D);
490 void VisitConstructorUsingShadowDecl(const ConstructorUsingShadowDecl *D);
491 void VisitLinkageSpecDecl(const LinkageSpecDecl *D);
492 void VisitAccessSpecDecl(const AccessSpecDecl *D);
493 void VisitFriendDecl(const FriendDecl *D);
496 void VisitObjCIvarDecl(const ObjCIvarDecl *D);
497 void VisitObjCMethodDecl(const ObjCMethodDecl *D);
498 void VisitObjCTypeParamDecl(const ObjCTypeParamDecl *D);
499 void VisitObjCCategoryDecl(const ObjCCategoryDecl *D);
500 void VisitObjCCategoryImplDecl(const ObjCCategoryImplDecl *D);
501 void VisitObjCProtocolDecl(const ObjCProtocolDecl *D);
502 void VisitObjCInterfaceDecl(const ObjCInterfaceDecl *D);
503 void VisitObjCImplementationDecl(const ObjCImplementationDecl *D);
504 void VisitObjCCompatibleAliasDecl(const ObjCCompatibleAliasDecl *D);
505 void VisitObjCPropertyDecl(const ObjCPropertyDecl *D);
506 void VisitObjCPropertyImplDecl(const ObjCPropertyImplDecl *D);
507 void VisitBlockDecl(const BlockDecl *D);
510 void VisitStmt(const Stmt *Node);
511 void VisitDeclStmt(const DeclStmt *Node);
512 void VisitAttributedStmt(const AttributedStmt *Node);
513 void VisitLabelStmt(const LabelStmt *Node);
514 void VisitGotoStmt(const GotoStmt *Node);
515 void VisitCXXCatchStmt(const CXXCatchStmt *Node);
516 void VisitCapturedStmt(const CapturedStmt *Node);
519 void VisitOMPExecutableDirective(const OMPExecutableDirective *Node);
522 void VisitExpr(const Expr *Node);
523 void VisitCastExpr(const CastExpr *Node);
524 void VisitImplicitCastExpr(const ImplicitCastExpr *Node);
525 void VisitDeclRefExpr(const DeclRefExpr *Node);
526 void VisitPredefinedExpr(const PredefinedExpr *Node);
527 void VisitCharacterLiteral(const CharacterLiteral *Node);
528 void VisitIntegerLiteral(const IntegerLiteral *Node);
529 void VisitFixedPointLiteral(const FixedPointLiteral *Node);
530 void VisitFloatingLiteral(const FloatingLiteral *Node);
531 void VisitStringLiteral(const StringLiteral *Str);
532 void VisitInitListExpr(const InitListExpr *ILE);
533 void VisitArrayInitLoopExpr(const ArrayInitLoopExpr *ILE);
534 void VisitArrayInitIndexExpr(const ArrayInitIndexExpr *ILE);
535 void VisitUnaryOperator(const UnaryOperator *Node);
536 void VisitUnaryExprOrTypeTraitExpr(const UnaryExprOrTypeTraitExpr *Node);
537 void VisitMemberExpr(const MemberExpr *Node);
538 void VisitExtVectorElementExpr(const ExtVectorElementExpr *Node);
539 void VisitBinaryOperator(const BinaryOperator *Node);
540 void VisitCompoundAssignOperator(const CompoundAssignOperator *Node);
541 void VisitAddrLabelExpr(const AddrLabelExpr *Node);
542 void VisitBlockExpr(const BlockExpr *Node);
543 void VisitOpaqueValueExpr(const OpaqueValueExpr *Node);
544 void VisitGenericSelectionExpr(const GenericSelectionExpr *E);
547 void VisitCXXNamedCastExpr(const CXXNamedCastExpr *Node);
548 void VisitCXXBoolLiteralExpr(const CXXBoolLiteralExpr *Node);
549 void VisitCXXThisExpr(const CXXThisExpr *Node);
550 void VisitCXXFunctionalCastExpr(const CXXFunctionalCastExpr *Node);
551 void VisitCXXUnresolvedConstructExpr(const CXXUnresolvedConstructExpr *Node);
552 void VisitCXXConstructExpr(const CXXConstructExpr *Node);
553 void VisitCXXBindTemporaryExpr(const CXXBindTemporaryExpr *Node);
554 void VisitCXXNewExpr(const CXXNewExpr *Node);
555 void VisitCXXDeleteExpr(const CXXDeleteExpr *Node);
556 void VisitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *Node);
557 void VisitExprWithCleanups(const ExprWithCleanups *Node);
558 void VisitUnresolvedLookupExpr(const UnresolvedLookupExpr *Node);
559 void dumpCXXTemporary(const CXXTemporary *Temporary);
560 void VisitLambdaExpr(const LambdaExpr *Node) {
562 dumpDecl(Node->getLambdaClass());
564 void VisitSizeOfPackExpr(const SizeOfPackExpr *Node);
566 VisitCXXDependentScopeMemberExpr(const CXXDependentScopeMemberExpr *Node);
569 void VisitObjCAtCatchStmt(const ObjCAtCatchStmt *Node);
570 void VisitObjCEncodeExpr(const ObjCEncodeExpr *Node);
571 void VisitObjCMessageExpr(const ObjCMessageExpr *Node);
572 void VisitObjCBoxedExpr(const ObjCBoxedExpr *Node);
573 void VisitObjCSelectorExpr(const ObjCSelectorExpr *Node);
574 void VisitObjCProtocolExpr(const ObjCProtocolExpr *Node);
575 void VisitObjCPropertyRefExpr(const ObjCPropertyRefExpr *Node);
576 void VisitObjCSubscriptRefExpr(const ObjCSubscriptRefExpr *Node);
577 void VisitObjCIvarRefExpr(const ObjCIvarRefExpr *Node);
578 void VisitObjCBoolLiteralExpr(const ObjCBoolLiteralExpr *Node);
581 const char *getCommandName(unsigned CommandID);
582 void dumpComment(const Comment *C);
585 void visitTextComment(const TextComment *C);
586 void visitInlineCommandComment(const InlineCommandComment *C);
587 void visitHTMLStartTagComment(const HTMLStartTagComment *C);
588 void visitHTMLEndTagComment(const HTMLEndTagComment *C);
591 void visitBlockCommandComment(const BlockCommandComment *C);
592 void visitParamCommandComment(const ParamCommandComment *C);
593 void visitTParamCommandComment(const TParamCommandComment *C);
594 void visitVerbatimBlockComment(const VerbatimBlockComment *C);
595 void visitVerbatimBlockLineComment(const VerbatimBlockLineComment *C);
596 void visitVerbatimLineComment(const VerbatimLineComment *C);
600 //===----------------------------------------------------------------------===//
602 //===----------------------------------------------------------------------===//
604 void ASTDumper::dumpPointer(const void *Ptr) {
605 ColorScope Color(*this, AddressColor);
609 void ASTDumper::dumpLocation(SourceLocation Loc) {
613 ColorScope Color(*this, LocationColor);
614 SourceLocation SpellingLoc = SM->getSpellingLoc(Loc);
616 // The general format we print out is filename:line:col, but we drop pieces
617 // that haven't changed since the last loc printed.
618 PresumedLoc PLoc = SM->getPresumedLoc(SpellingLoc);
620 if (PLoc.isInvalid()) {
621 OS << "<invalid sloc>";
625 if (strcmp(PLoc.getFilename(), LastLocFilename) != 0) {
626 OS << PLoc.getFilename() << ':' << PLoc.getLine()
627 << ':' << PLoc.getColumn();
628 LastLocFilename = PLoc.getFilename();
629 LastLocLine = PLoc.getLine();
630 } else if (PLoc.getLine() != LastLocLine) {
631 OS << "line" << ':' << PLoc.getLine()
632 << ':' << PLoc.getColumn();
633 LastLocLine = PLoc.getLine();
635 OS << "col" << ':' << PLoc.getColumn();
639 void ASTDumper::dumpSourceRange(SourceRange R) {
640 // Can't translate locations if a SourceManager isn't available.
645 dumpLocation(R.getBegin());
646 if (R.getBegin() != R.getEnd()) {
648 dumpLocation(R.getEnd());
652 // <t2.c:123:421[blah], t2.c:412:321>
656 void ASTDumper::dumpBareType(QualType T, bool Desugar) {
657 ColorScope Color(*this, TypeColor);
659 SplitQualType T_split = T.split();
660 OS << "'" << QualType::getAsString(T_split, PrintPolicy) << "'";
662 if (Desugar && !T.isNull()) {
663 // If the type is sugared, also dump a (shallow) desugared type.
664 SplitQualType D_split = T.getSplitDesugaredType();
665 if (T_split != D_split)
666 OS << ":'" << QualType::getAsString(D_split, PrintPolicy) << "'";
670 void ASTDumper::dumpType(QualType T) {
675 void ASTDumper::dumpTypeAsChild(QualType T) {
676 SplitQualType SQT = T.split();
677 if (!SQT.Quals.hasQualifiers())
678 return dumpTypeAsChild(SQT.Ty);
682 dumpPointer(T.getAsOpaquePtr());
684 dumpBareType(T, false);
685 OS << " " << T.split().Quals.getAsString();
686 dumpTypeAsChild(T.split().Ty);
690 void ASTDumper::dumpTypeAsChild(const Type *T) {
693 ColorScope Color(*this, NullColor);
697 if (const LocInfoType *LIT = llvm::dyn_cast<LocInfoType>(T)) {
699 ColorScope Color(*this, TypeColor);
700 OS << "LocInfo Type";
703 dumpTypeAsChild(LIT->getTypeSourceInfo()->getType());
708 ColorScope Color(*this, TypeColor);
709 OS << T->getTypeClassName() << "Type";
713 dumpBareType(QualType(T, 0), false);
715 QualType SingleStepDesugar =
716 T->getLocallyUnqualifiedSingleStepDesugaredType();
717 if (SingleStepDesugar != QualType(T, 0))
719 if (T->isDependentType())
721 else if (T->isInstantiationDependentType())
722 OS << " instantiation_dependent";
723 if (T->isVariablyModifiedType())
724 OS << " variably_modified";
725 if (T->containsUnexpandedParameterPack())
726 OS << " contains_unexpanded_pack";
730 TypeVisitor<ASTDumper>::Visit(T);
732 if (SingleStepDesugar != QualType(T, 0))
733 dumpTypeAsChild(SingleStepDesugar);
737 void ASTDumper::dumpBareDeclRef(const Decl *D) {
739 ColorScope Color(*this, NullColor);
745 ColorScope Color(*this, DeclKindNameColor);
746 OS << D->getDeclKindName();
750 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D)) {
751 ColorScope Color(*this, DeclNameColor);
752 OS << " '" << ND->getDeclName() << '\'';
755 if (const ValueDecl *VD = dyn_cast<ValueDecl>(D))
756 dumpType(VD->getType());
759 void ASTDumper::dumpDeclRef(const Decl *D, const char *Label) {
770 void ASTDumper::dumpName(const NamedDecl *ND) {
771 if (ND->getDeclName()) {
772 ColorScope Color(*this, DeclNameColor);
773 OS << ' ' << ND->getNameAsString();
777 bool ASTDumper::hasNodes(const DeclContext *DC) {
781 return DC->hasExternalLexicalStorage() ||
782 (Deserialize ? DC->decls_begin() != DC->decls_end()
783 : DC->noload_decls_begin() != DC->noload_decls_end());
786 void ASTDumper::dumpDeclContext(const DeclContext *DC) {
790 for (auto *D : (Deserialize ? DC->decls() : DC->noload_decls()))
793 if (DC->hasExternalLexicalStorage()) {
795 ColorScope Color(*this, UndeserializedColor);
796 OS << "<undeserialized declarations>";
801 void ASTDumper::dumpLookups(const DeclContext *DC, bool DumpDecls) {
803 OS << "StoredDeclsMap ";
804 dumpBareDeclRef(cast<Decl>(DC));
806 const DeclContext *Primary = DC->getPrimaryContext();
809 dumpPointer(cast<Decl>(Primary));
812 bool HasUndeserializedLookups = Primary->hasExternalVisibleStorage();
814 auto Range = Deserialize
816 : Primary->noload_lookups(/*PreserveInternalState=*/true);
817 for (auto I = Range.begin(), E = Range.end(); I != E; ++I) {
818 DeclarationName Name = I.getLookupName();
819 DeclContextLookupResult R = *I;
822 OS << "DeclarationName ";
824 ColorScope Color(*this, DeclNameColor);
825 OS << '\'' << Name << '\'';
828 for (DeclContextLookupResult::iterator RI = R.begin(), RE = R.end();
831 dumpBareDeclRef(*RI);
833 if ((*RI)->isHidden())
836 // If requested, dump the redecl chain for this lookup.
838 // Dump earliest decl first.
839 std::function<void(Decl *)> DumpWithPrev = [&](Decl *D) {
840 if (Decl *Prev = D->getPreviousDecl())
851 if (HasUndeserializedLookups) {
853 ColorScope Color(*this, UndeserializedColor);
854 OS << "<undeserialized lookups>";
860 void ASTDumper::dumpAttr(const Attr *A) {
863 ColorScope Color(*this, AttrColor);
865 switch (A->getKind()) {
866 #define ATTR(X) case attr::X: OS << #X; break;
867 #include "clang/Basic/AttrList.inc"
872 dumpSourceRange(A->getRange());
873 if (A->isInherited())
877 #include "clang/AST/AttrDump.inc"
881 static void dumpPreviousDeclImpl(raw_ostream &OS, ...) {}
884 static void dumpPreviousDeclImpl(raw_ostream &OS, const Mergeable<T> *D) {
885 const T *First = D->getFirstDecl();
887 OS << " first " << First;
891 static void dumpPreviousDeclImpl(raw_ostream &OS, const Redeclarable<T> *D) {
892 const T *Prev = D->getPreviousDecl();
894 OS << " prev " << Prev;
897 /// Dump the previous declaration in the redeclaration chain for a declaration,
899 static void dumpPreviousDecl(raw_ostream &OS, const Decl *D) {
900 switch (D->getKind()) {
901 #define DECL(DERIVED, BASE) \
902 case Decl::DERIVED: \
903 return dumpPreviousDeclImpl(OS, cast<DERIVED##Decl>(D));
904 #define ABSTRACT_DECL(DECL)
905 #include "clang/AST/DeclNodes.inc"
907 llvm_unreachable("Decl that isn't part of DeclNodes.inc!");
910 //===----------------------------------------------------------------------===//
912 //===----------------------------------------------------------------------===//
914 void ASTDumper::dumpAccessSpecifier(AccessSpecifier AS) {
930 void ASTDumper::dumpCXXCtorInitializer(const CXXCtorInitializer *Init) {
932 OS << "CXXCtorInitializer";
933 if (Init->isAnyMemberInitializer()) {
935 dumpBareDeclRef(Init->getAnyMember());
936 } else if (Init->isBaseInitializer()) {
937 dumpType(QualType(Init->getBaseClass(), 0));
938 } else if (Init->isDelegatingInitializer()) {
939 dumpType(Init->getTypeSourceInfo()->getType());
941 llvm_unreachable("Unknown initializer type");
943 dumpStmt(Init->getInit());
947 void ASTDumper::dumpTemplateParameters(const TemplateParameterList *TPL) {
951 for (TemplateParameterList::const_iterator I = TPL->begin(), E = TPL->end();
956 void ASTDumper::dumpTemplateArgumentListInfo(
957 const TemplateArgumentListInfo &TALI) {
958 for (unsigned i = 0, e = TALI.size(); i < e; ++i)
959 dumpTemplateArgumentLoc(TALI[i]);
962 void ASTDumper::dumpTemplateArgumentLoc(const TemplateArgumentLoc &A) {
963 dumpTemplateArgument(A.getArgument(), A.getSourceRange());
966 void ASTDumper::dumpTemplateArgumentList(const TemplateArgumentList &TAL) {
967 for (unsigned i = 0, e = TAL.size(); i < e; ++i)
968 dumpTemplateArgument(TAL[i]);
971 void ASTDumper::dumpTemplateArgument(const TemplateArgument &A, SourceRange R) {
973 OS << "TemplateArgument";
977 switch (A.getKind()) {
978 case TemplateArgument::Null:
981 case TemplateArgument::Type:
983 dumpType(A.getAsType());
985 case TemplateArgument::Declaration:
987 dumpDeclRef(A.getAsDecl());
989 case TemplateArgument::NullPtr:
992 case TemplateArgument::Integral:
993 OS << " integral " << A.getAsIntegral();
995 case TemplateArgument::Template:
997 A.getAsTemplate().dump(OS);
999 case TemplateArgument::TemplateExpansion:
1000 OS << " template expansion";
1001 A.getAsTemplateOrTemplatePattern().dump(OS);
1003 case TemplateArgument::Expression:
1005 dumpStmt(A.getAsExpr());
1007 case TemplateArgument::Pack:
1009 for (TemplateArgument::pack_iterator I = A.pack_begin(), E = A.pack_end();
1011 dumpTemplateArgument(*I);
1017 //===----------------------------------------------------------------------===//
1018 // Objective-C Utilities
1019 //===----------------------------------------------------------------------===//
1020 void ASTDumper::dumpObjCTypeParamList(const ObjCTypeParamList *typeParams) {
1024 for (auto typeParam : *typeParams) {
1025 dumpDecl(typeParam);
1029 //===----------------------------------------------------------------------===//
1030 // Decl dumping methods.
1031 //===----------------------------------------------------------------------===//
1033 void ASTDumper::dumpDecl(const Decl *D) {
1036 ColorScope Color(*this, NullColor);
1042 ColorScope Color(*this, DeclKindNameColor);
1043 OS << D->getDeclKindName() << "Decl";
1046 if (D->getLexicalDeclContext() != D->getDeclContext())
1047 OS << " parent " << cast<Decl>(D->getDeclContext());
1048 dumpPreviousDecl(OS, D);
1049 dumpSourceRange(D->getSourceRange());
1051 dumpLocation(D->getLocation());
1052 if (D->isFromASTFile())
1054 if (Module *M = D->getOwningModule())
1055 OS << " in " << M->getFullModuleName();
1056 if (auto *ND = dyn_cast<NamedDecl>(D))
1057 for (Module *M : D->getASTContext().getModulesWithMergedDefinition(
1058 const_cast<NamedDecl *>(ND)))
1059 dumpChild([=] { OS << "also in " << M->getFullModuleName(); });
1060 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
1063 if (D->isImplicit())
1067 else if (D->isThisDeclarationReferenced())
1068 OS << " referenced";
1069 if (D->isInvalidDecl())
1071 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
1072 if (FD->isConstexpr())
1076 ConstDeclVisitor<ASTDumper>::Visit(D);
1078 for (Decl::attr_iterator I = D->attr_begin(), E = D->attr_end(); I != E;
1082 if (const FullComment *Comment =
1083 D->getASTContext().getLocalCommentForDeclUncached(D))
1084 dumpFullComment(Comment);
1086 // Decls within functions are visited by the body.
1087 if (!isa<FunctionDecl>(*D) && !isa<ObjCMethodDecl>(*D) &&
1088 hasNodes(dyn_cast<DeclContext>(D)))
1089 dumpDeclContext(cast<DeclContext>(D));
1093 void ASTDumper::VisitLabelDecl(const LabelDecl *D) {
1097 void ASTDumper::VisitTypedefDecl(const TypedefDecl *D) {
1099 dumpType(D->getUnderlyingType());
1100 if (D->isModulePrivate())
1101 OS << " __module_private__";
1102 dumpTypeAsChild(D->getUnderlyingType());
1105 void ASTDumper::VisitEnumDecl(const EnumDecl *D) {
1106 if (D->isScoped()) {
1107 if (D->isScopedUsingClassTag())
1113 if (D->isModulePrivate())
1114 OS << " __module_private__";
1116 dumpType(D->getIntegerType());
1119 void ASTDumper::VisitRecordDecl(const RecordDecl *D) {
1120 OS << ' ' << D->getKindName();
1122 if (D->isModulePrivate())
1123 OS << " __module_private__";
1124 if (D->isCompleteDefinition())
1125 OS << " definition";
1128 void ASTDumper::VisitEnumConstantDecl(const EnumConstantDecl *D) {
1130 dumpType(D->getType());
1131 if (const Expr *Init = D->getInitExpr())
1135 void ASTDumper::VisitIndirectFieldDecl(const IndirectFieldDecl *D) {
1137 dumpType(D->getType());
1139 for (auto *Child : D->chain())
1143 void ASTDumper::VisitFunctionDecl(const FunctionDecl *D) {
1145 dumpType(D->getType());
1147 StorageClass SC = D->getStorageClass();
1149 OS << ' ' << VarDecl::getStorageClassSpecifierString(SC);
1150 if (D->isInlineSpecified())
1152 if (D->isVirtualAsWritten())
1154 if (D->isModulePrivate())
1155 OS << " __module_private__";
1159 if (D->isDefaulted()) {
1164 if (D->isDeletedAsWritten())
1169 if (const FunctionProtoType *FPT = D->getType()->getAs<FunctionProtoType>()) {
1170 FunctionProtoType::ExtProtoInfo EPI = FPT->getExtProtoInfo();
1171 switch (EPI.ExceptionSpec.Type) {
1173 case EST_Unevaluated:
1174 OS << " noexcept-unevaluated " << EPI.ExceptionSpec.SourceDecl;
1176 case EST_Uninstantiated:
1177 OS << " noexcept-uninstantiated " << EPI.ExceptionSpec.SourceTemplate;
1182 if (const FunctionTemplateSpecializationInfo *FTSI =
1183 D->getTemplateSpecializationInfo())
1184 dumpTemplateArgumentList(*FTSI->TemplateArguments);
1186 if (!D->param_begin() && D->getNumParams())
1187 dumpChild([=] { OS << "<<NULL params x " << D->getNumParams() << ">>"; });
1189 for (const ParmVarDecl *Parameter : D->parameters())
1190 dumpDecl(Parameter);
1192 if (const CXXConstructorDecl *C = dyn_cast<CXXConstructorDecl>(D))
1193 for (CXXConstructorDecl::init_const_iterator I = C->init_begin(),
1196 dumpCXXCtorInitializer(*I);
1198 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(D)) {
1199 if (MD->size_overridden_methods() != 0) {
1200 auto dumpOverride = [=](const CXXMethodDecl *D) {
1201 SplitQualType T_split = D->getType().split();
1202 OS << D << " " << D->getParent()->getName()
1203 << "::" << D->getNameAsString() << " '"
1204 << QualType::getAsString(T_split, PrintPolicy) << "'";
1208 auto Overrides = MD->overridden_methods();
1209 OS << "Overrides: [ ";
1210 dumpOverride(*Overrides.begin());
1211 for (const auto *Override :
1212 llvm::make_range(Overrides.begin() + 1, Overrides.end())) {
1214 dumpOverride(Override);
1221 if (D->doesThisDeclarationHaveABody())
1222 dumpStmt(D->getBody());
1225 void ASTDumper::VisitFieldDecl(const FieldDecl *D) {
1227 dumpType(D->getType());
1230 if (D->isModulePrivate())
1231 OS << " __module_private__";
1233 if (D->isBitField())
1234 dumpStmt(D->getBitWidth());
1235 if (Expr *Init = D->getInClassInitializer())
1239 void ASTDumper::VisitVarDecl(const VarDecl *D) {
1241 dumpType(D->getType());
1242 StorageClass SC = D->getStorageClass();
1244 OS << ' ' << VarDecl::getStorageClassSpecifierString(SC);
1245 switch (D->getTLSKind()) {
1246 case VarDecl::TLS_None: break;
1247 case VarDecl::TLS_Static: OS << " tls"; break;
1248 case VarDecl::TLS_Dynamic: OS << " tls_dynamic"; break;
1250 if (D->isModulePrivate())
1251 OS << " __module_private__";
1252 if (D->isNRVOVariable())
1256 if (D->isConstexpr())
1259 switch (D->getInitStyle()) {
1260 case VarDecl::CInit: OS << " cinit"; break;
1261 case VarDecl::CallInit: OS << " callinit"; break;
1262 case VarDecl::ListInit: OS << " listinit"; break;
1264 dumpStmt(D->getInit());
1268 void ASTDumper::VisitDecompositionDecl(const DecompositionDecl *D) {
1270 for (auto *B : D->bindings())
1274 void ASTDumper::VisitBindingDecl(const BindingDecl *D) {
1276 dumpType(D->getType());
1277 if (auto *E = D->getBinding())
1281 void ASTDumper::VisitFileScopeAsmDecl(const FileScopeAsmDecl *D) {
1282 dumpStmt(D->getAsmString());
1285 void ASTDumper::VisitImportDecl(const ImportDecl *D) {
1286 OS << ' ' << D->getImportedModule()->getFullModuleName();
1289 void ASTDumper::VisitPragmaCommentDecl(const PragmaCommentDecl *D) {
1291 switch (D->getCommentKind()) {
1292 case PCK_Unknown: llvm_unreachable("unexpected pragma comment kind");
1293 case PCK_Compiler: OS << "compiler"; break;
1294 case PCK_ExeStr: OS << "exestr"; break;
1295 case PCK_Lib: OS << "lib"; break;
1296 case PCK_Linker: OS << "linker"; break;
1297 case PCK_User: OS << "user"; break;
1299 StringRef Arg = D->getArg();
1301 OS << " \"" << Arg << "\"";
1304 void ASTDumper::VisitPragmaDetectMismatchDecl(
1305 const PragmaDetectMismatchDecl *D) {
1306 OS << " \"" << D->getName() << "\" \"" << D->getValue() << "\"";
1309 void ASTDumper::VisitCapturedDecl(const CapturedDecl *D) {
1310 dumpStmt(D->getBody());
1313 //===----------------------------------------------------------------------===//
1314 // OpenMP Declarations
1315 //===----------------------------------------------------------------------===//
1317 void ASTDumper::VisitOMPThreadPrivateDecl(const OMPThreadPrivateDecl *D) {
1318 for (auto *E : D->varlists())
1322 void ASTDumper::VisitOMPDeclareReductionDecl(const OMPDeclareReductionDecl *D) {
1324 dumpType(D->getType());
1326 dumpStmt(D->getCombiner());
1327 if (auto *Initializer = D->getInitializer()) {
1328 OS << " initializer";
1329 switch (D->getInitializerKind()) {
1330 case OMPDeclareReductionDecl::DirectInit:
1331 OS << " omp_priv = ";
1333 case OMPDeclareReductionDecl::CopyInit:
1334 OS << " omp_priv ()";
1336 case OMPDeclareReductionDecl::CallInit:
1339 dumpStmt(Initializer);
1343 void ASTDumper::VisitOMPCapturedExprDecl(const OMPCapturedExprDecl *D) {
1345 dumpType(D->getType());
1346 dumpStmt(D->getInit());
1349 //===----------------------------------------------------------------------===//
1351 //===----------------------------------------------------------------------===//
1353 void ASTDumper::VisitNamespaceDecl(const NamespaceDecl *D) {
1357 if (!D->isOriginalNamespace())
1358 dumpDeclRef(D->getOriginalNamespace(), "original");
1361 void ASTDumper::VisitUsingDirectiveDecl(const UsingDirectiveDecl *D) {
1363 dumpBareDeclRef(D->getNominatedNamespace());
1366 void ASTDumper::VisitNamespaceAliasDecl(const NamespaceAliasDecl *D) {
1368 dumpDeclRef(D->getAliasedNamespace());
1371 void ASTDumper::VisitTypeAliasDecl(const TypeAliasDecl *D) {
1373 dumpType(D->getUnderlyingType());
1374 dumpTypeAsChild(D->getUnderlyingType());
1377 void ASTDumper::VisitTypeAliasTemplateDecl(const TypeAliasTemplateDecl *D) {
1379 dumpTemplateParameters(D->getTemplateParameters());
1380 dumpDecl(D->getTemplatedDecl());
1383 void ASTDumper::VisitCXXRecordDecl(const CXXRecordDecl *D) {
1385 if (!D->isCompleteDefinition())
1390 ColorScope Color(*this, DeclKindNameColor);
1391 OS << "DefinitionData";
1393 #define FLAG(fn, name) if (D->fn()) OS << " " #name;
1394 FLAG(isParsingBaseSpecifiers, parsing_base_specifiers);
1396 FLAG(isGenericLambda, generic);
1397 FLAG(isLambda, lambda);
1399 FLAG(canPassInRegisters, pass_in_registers);
1400 FLAG(isEmpty, empty);
1401 FLAG(isAggregate, aggregate);
1402 FLAG(isStandardLayout, standard_layout);
1403 FLAG(isTriviallyCopyable, trivially_copyable);
1405 FLAG(isTrivial, trivial);
1406 FLAG(isPolymorphic, polymorphic);
1407 FLAG(isAbstract, abstract);
1408 FLAG(isLiteral, literal);
1410 FLAG(hasUserDeclaredConstructor, has_user_declared_ctor);
1411 FLAG(hasConstexprNonCopyMoveConstructor, has_constexpr_non_copy_move_ctor);
1412 FLAG(hasMutableFields, has_mutable_fields);
1413 FLAG(hasVariantMembers, has_variant_members);
1414 FLAG(allowConstDefaultInit, can_const_default_init);
1418 ColorScope Color(*this, DeclKindNameColor);
1419 OS << "DefaultConstructor";
1421 FLAG(hasDefaultConstructor, exists);
1422 FLAG(hasTrivialDefaultConstructor, trivial);
1423 FLAG(hasNonTrivialDefaultConstructor, non_trivial);
1424 FLAG(hasUserProvidedDefaultConstructor, user_provided);
1425 FLAG(hasConstexprDefaultConstructor, constexpr);
1426 FLAG(needsImplicitDefaultConstructor, needs_implicit);
1427 FLAG(defaultedDefaultConstructorIsConstexpr, defaulted_is_constexpr);
1432 ColorScope Color(*this, DeclKindNameColor);
1433 OS << "CopyConstructor";
1435 FLAG(hasSimpleCopyConstructor, simple);
1436 FLAG(hasTrivialCopyConstructor, trivial);
1437 FLAG(hasNonTrivialCopyConstructor, non_trivial);
1438 FLAG(hasUserDeclaredCopyConstructor, user_declared);
1439 FLAG(hasCopyConstructorWithConstParam, has_const_param);
1440 FLAG(needsImplicitCopyConstructor, needs_implicit);
1441 FLAG(needsOverloadResolutionForCopyConstructor,
1442 needs_overload_resolution);
1443 if (!D->needsOverloadResolutionForCopyConstructor())
1444 FLAG(defaultedCopyConstructorIsDeleted, defaulted_is_deleted);
1445 FLAG(implicitCopyConstructorHasConstParam, implicit_has_const_param);
1450 ColorScope Color(*this, DeclKindNameColor);
1451 OS << "MoveConstructor";
1453 FLAG(hasMoveConstructor, exists);
1454 FLAG(hasSimpleMoveConstructor, simple);
1455 FLAG(hasTrivialMoveConstructor, trivial);
1456 FLAG(hasNonTrivialMoveConstructor, non_trivial);
1457 FLAG(hasUserDeclaredMoveConstructor, user_declared);
1458 FLAG(needsImplicitMoveConstructor, needs_implicit);
1459 FLAG(needsOverloadResolutionForMoveConstructor,
1460 needs_overload_resolution);
1461 if (!D->needsOverloadResolutionForMoveConstructor())
1462 FLAG(defaultedMoveConstructorIsDeleted, defaulted_is_deleted);
1467 ColorScope Color(*this, DeclKindNameColor);
1468 OS << "CopyAssignment";
1470 FLAG(hasTrivialCopyAssignment, trivial);
1471 FLAG(hasNonTrivialCopyAssignment, non_trivial);
1472 FLAG(hasCopyAssignmentWithConstParam, has_const_param);
1473 FLAG(hasUserDeclaredCopyAssignment, user_declared);
1474 FLAG(needsImplicitCopyAssignment, needs_implicit);
1475 FLAG(needsOverloadResolutionForCopyAssignment, needs_overload_resolution);
1476 FLAG(implicitCopyAssignmentHasConstParam, implicit_has_const_param);
1481 ColorScope Color(*this, DeclKindNameColor);
1482 OS << "MoveAssignment";
1484 FLAG(hasMoveAssignment, exists);
1485 FLAG(hasSimpleMoveAssignment, simple);
1486 FLAG(hasTrivialMoveAssignment, trivial);
1487 FLAG(hasNonTrivialMoveAssignment, non_trivial);
1488 FLAG(hasUserDeclaredMoveAssignment, user_declared);
1489 FLAG(needsImplicitMoveAssignment, needs_implicit);
1490 FLAG(needsOverloadResolutionForMoveAssignment, needs_overload_resolution);
1495 ColorScope Color(*this, DeclKindNameColor);
1498 FLAG(hasSimpleDestructor, simple);
1499 FLAG(hasIrrelevantDestructor, irrelevant);
1500 FLAG(hasTrivialDestructor, trivial);
1501 FLAG(hasNonTrivialDestructor, non_trivial);
1502 FLAG(hasUserDeclaredDestructor, user_declared);
1503 FLAG(needsImplicitDestructor, needs_implicit);
1504 FLAG(needsOverloadResolutionForDestructor, needs_overload_resolution);
1505 if (!D->needsOverloadResolutionForDestructor())
1506 FLAG(defaultedDestructorIsDeleted, defaulted_is_deleted);
1510 for (const auto &I : D->bases()) {
1514 dumpAccessSpecifier(I.getAccessSpecifier());
1515 dumpType(I.getType());
1516 if (I.isPackExpansion())
1522 void ASTDumper::VisitStaticAssertDecl(const StaticAssertDecl *D) {
1523 dumpStmt(D->getAssertExpr());
1524 dumpStmt(D->getMessage());
1527 template<typename SpecializationDecl>
1528 void ASTDumper::VisitTemplateDeclSpecialization(const SpecializationDecl *D,
1529 bool DumpExplicitInst,
1531 bool DumpedAny = false;
1532 for (auto *RedeclWithBadType : D->redecls()) {
1533 // FIXME: The redecls() range sometimes has elements of a less-specific
1534 // type. (In particular, ClassTemplateSpecializationDecl::redecls() gives
1535 // us TagDecls, and should give CXXRecordDecls).
1536 auto *Redecl = dyn_cast<SpecializationDecl>(RedeclWithBadType);
1538 // Found the injected-class-name for a class template. This will be dumped
1539 // as part of its surrounding class so we don't need to dump it here.
1540 assert(isa<CXXRecordDecl>(RedeclWithBadType) &&
1541 "expected an injected-class-name");
1545 switch (Redecl->getTemplateSpecializationKind()) {
1546 case TSK_ExplicitInstantiationDeclaration:
1547 case TSK_ExplicitInstantiationDefinition:
1548 if (!DumpExplicitInst)
1551 case TSK_Undeclared:
1552 case TSK_ImplicitInstantiation:
1554 dumpDeclRef(Redecl);
1559 case TSK_ExplicitSpecialization:
1564 // Ensure we dump at least one decl for each specialization.
1569 template<typename TemplateDecl>
1570 void ASTDumper::VisitTemplateDecl(const TemplateDecl *D,
1571 bool DumpExplicitInst) {
1573 dumpTemplateParameters(D->getTemplateParameters());
1575 dumpDecl(D->getTemplatedDecl());
1577 for (auto *Child : D->specializations())
1578 VisitTemplateDeclSpecialization(Child, DumpExplicitInst,
1579 !D->isCanonicalDecl());
1582 void ASTDumper::VisitFunctionTemplateDecl(const FunctionTemplateDecl *D) {
1583 // FIXME: We don't add a declaration of a function template specialization
1584 // to its context when it's explicitly instantiated, so dump explicit
1585 // instantiations when we dump the template itself.
1586 VisitTemplateDecl(D, true);
1589 void ASTDumper::VisitClassTemplateDecl(const ClassTemplateDecl *D) {
1590 VisitTemplateDecl(D, false);
1593 void ASTDumper::VisitClassTemplateSpecializationDecl(
1594 const ClassTemplateSpecializationDecl *D) {
1595 VisitCXXRecordDecl(D);
1596 dumpTemplateArgumentList(D->getTemplateArgs());
1599 void ASTDumper::VisitClassTemplatePartialSpecializationDecl(
1600 const ClassTemplatePartialSpecializationDecl *D) {
1601 VisitClassTemplateSpecializationDecl(D);
1602 dumpTemplateParameters(D->getTemplateParameters());
1605 void ASTDumper::VisitClassScopeFunctionSpecializationDecl(
1606 const ClassScopeFunctionSpecializationDecl *D) {
1607 dumpDecl(D->getSpecialization());
1608 if (D->hasExplicitTemplateArgs())
1609 dumpTemplateArgumentListInfo(D->templateArgs());
1612 void ASTDumper::VisitVarTemplateDecl(const VarTemplateDecl *D) {
1613 VisitTemplateDecl(D, false);
1616 void ASTDumper::VisitBuiltinTemplateDecl(const BuiltinTemplateDecl *D) {
1618 dumpTemplateParameters(D->getTemplateParameters());
1621 void ASTDumper::VisitVarTemplateSpecializationDecl(
1622 const VarTemplateSpecializationDecl *D) {
1623 dumpTemplateArgumentList(D->getTemplateArgs());
1627 void ASTDumper::VisitVarTemplatePartialSpecializationDecl(
1628 const VarTemplatePartialSpecializationDecl *D) {
1629 dumpTemplateParameters(D->getTemplateParameters());
1630 VisitVarTemplateSpecializationDecl(D);
1633 void ASTDumper::VisitTemplateTypeParmDecl(const TemplateTypeParmDecl *D) {
1634 if (D->wasDeclaredWithTypename())
1638 OS << " depth " << D->getDepth() << " index " << D->getIndex();
1639 if (D->isParameterPack())
1642 if (D->hasDefaultArgument())
1643 dumpTemplateArgument(D->getDefaultArgument());
1646 void ASTDumper::VisitNonTypeTemplateParmDecl(const NonTypeTemplateParmDecl *D) {
1647 dumpType(D->getType());
1648 OS << " depth " << D->getDepth() << " index " << D->getIndex();
1649 if (D->isParameterPack())
1652 if (D->hasDefaultArgument())
1653 dumpTemplateArgument(D->getDefaultArgument());
1656 void ASTDumper::VisitTemplateTemplateParmDecl(
1657 const TemplateTemplateParmDecl *D) {
1658 OS << " depth " << D->getDepth() << " index " << D->getIndex();
1659 if (D->isParameterPack())
1662 dumpTemplateParameters(D->getTemplateParameters());
1663 if (D->hasDefaultArgument())
1664 dumpTemplateArgumentLoc(D->getDefaultArgument());
1667 void ASTDumper::VisitUsingDecl(const UsingDecl *D) {
1669 if (D->getQualifier())
1670 D->getQualifier()->print(OS, D->getASTContext().getPrintingPolicy());
1671 OS << D->getNameAsString();
1674 void ASTDumper::VisitUnresolvedUsingTypenameDecl(
1675 const UnresolvedUsingTypenameDecl *D) {
1677 if (D->getQualifier())
1678 D->getQualifier()->print(OS, D->getASTContext().getPrintingPolicy());
1679 OS << D->getNameAsString();
1682 void ASTDumper::VisitUnresolvedUsingValueDecl(const UnresolvedUsingValueDecl *D) {
1684 if (D->getQualifier())
1685 D->getQualifier()->print(OS, D->getASTContext().getPrintingPolicy());
1686 OS << D->getNameAsString();
1687 dumpType(D->getType());
1690 void ASTDumper::VisitUsingShadowDecl(const UsingShadowDecl *D) {
1692 dumpBareDeclRef(D->getTargetDecl());
1693 if (auto *TD = dyn_cast<TypeDecl>(D->getUnderlyingDecl()))
1694 dumpTypeAsChild(TD->getTypeForDecl());
1697 void ASTDumper::VisitConstructorUsingShadowDecl(
1698 const ConstructorUsingShadowDecl *D) {
1699 if (D->constructsVirtualBase())
1704 dumpBareDeclRef(D->getTargetDecl());
1709 dumpBareDeclRef(D->getNominatedBaseClass());
1711 dumpBareDeclRef(D->getNominatedBaseClassShadowDecl());
1715 OS << "constructed ";
1716 dumpBareDeclRef(D->getConstructedBaseClass());
1718 dumpBareDeclRef(D->getConstructedBaseClassShadowDecl());
1722 void ASTDumper::VisitLinkageSpecDecl(const LinkageSpecDecl *D) {
1723 switch (D->getLanguage()) {
1724 case LinkageSpecDecl::lang_c: OS << " C"; break;
1725 case LinkageSpecDecl::lang_cxx: OS << " C++"; break;
1729 void ASTDumper::VisitAccessSpecDecl(const AccessSpecDecl *D) {
1731 dumpAccessSpecifier(D->getAccess());
1734 void ASTDumper::VisitFriendDecl(const FriendDecl *D) {
1735 if (TypeSourceInfo *T = D->getFriendType())
1736 dumpType(T->getType());
1738 dumpDecl(D->getFriendDecl());
1741 //===----------------------------------------------------------------------===//
1742 // Obj-C Declarations
1743 //===----------------------------------------------------------------------===//
1745 void ASTDumper::VisitObjCIvarDecl(const ObjCIvarDecl *D) {
1747 dumpType(D->getType());
1748 if (D->getSynthesize())
1749 OS << " synthesize";
1751 switch (D->getAccessControl()) {
1752 case ObjCIvarDecl::None:
1755 case ObjCIvarDecl::Private:
1758 case ObjCIvarDecl::Protected:
1761 case ObjCIvarDecl::Public:
1764 case ObjCIvarDecl::Package:
1770 void ASTDumper::VisitObjCMethodDecl(const ObjCMethodDecl *D) {
1771 if (D->isInstanceMethod())
1776 dumpType(D->getReturnType());
1778 if (D->isThisDeclarationADefinition()) {
1781 for (const ParmVarDecl *Parameter : D->parameters())
1782 dumpDecl(Parameter);
1785 if (D->isVariadic())
1786 dumpChild([=] { OS << "..."; });
1789 dumpStmt(D->getBody());
1792 void ASTDumper::VisitObjCTypeParamDecl(const ObjCTypeParamDecl *D) {
1794 switch (D->getVariance()) {
1795 case ObjCTypeParamVariance::Invariant:
1798 case ObjCTypeParamVariance::Covariant:
1802 case ObjCTypeParamVariance::Contravariant:
1803 OS << " contravariant";
1807 if (D->hasExplicitBound())
1809 dumpType(D->getUnderlyingType());
1812 void ASTDumper::VisitObjCCategoryDecl(const ObjCCategoryDecl *D) {
1814 dumpDeclRef(D->getClassInterface());
1815 dumpObjCTypeParamList(D->getTypeParamList());
1816 dumpDeclRef(D->getImplementation());
1817 for (ObjCCategoryDecl::protocol_iterator I = D->protocol_begin(),
1818 E = D->protocol_end();
1823 void ASTDumper::VisitObjCCategoryImplDecl(const ObjCCategoryImplDecl *D) {
1825 dumpDeclRef(D->getClassInterface());
1826 dumpDeclRef(D->getCategoryDecl());
1829 void ASTDumper::VisitObjCProtocolDecl(const ObjCProtocolDecl *D) {
1832 for (auto *Child : D->protocols())
1836 void ASTDumper::VisitObjCInterfaceDecl(const ObjCInterfaceDecl *D) {
1838 dumpObjCTypeParamList(D->getTypeParamListAsWritten());
1839 dumpDeclRef(D->getSuperClass(), "super");
1841 dumpDeclRef(D->getImplementation());
1842 for (auto *Child : D->protocols())
1846 void ASTDumper::VisitObjCImplementationDecl(const ObjCImplementationDecl *D) {
1848 dumpDeclRef(D->getSuperClass(), "super");
1849 dumpDeclRef(D->getClassInterface());
1850 for (ObjCImplementationDecl::init_const_iterator I = D->init_begin(),
1853 dumpCXXCtorInitializer(*I);
1856 void ASTDumper::VisitObjCCompatibleAliasDecl(const ObjCCompatibleAliasDecl *D) {
1858 dumpDeclRef(D->getClassInterface());
1861 void ASTDumper::VisitObjCPropertyDecl(const ObjCPropertyDecl *D) {
1863 dumpType(D->getType());
1865 if (D->getPropertyImplementation() == ObjCPropertyDecl::Required)
1867 else if (D->getPropertyImplementation() == ObjCPropertyDecl::Optional)
1870 ObjCPropertyDecl::PropertyAttributeKind Attrs = D->getPropertyAttributes();
1871 if (Attrs != ObjCPropertyDecl::OBJC_PR_noattr) {
1872 if (Attrs & ObjCPropertyDecl::OBJC_PR_readonly)
1874 if (Attrs & ObjCPropertyDecl::OBJC_PR_assign)
1876 if (Attrs & ObjCPropertyDecl::OBJC_PR_readwrite)
1878 if (Attrs & ObjCPropertyDecl::OBJC_PR_retain)
1880 if (Attrs & ObjCPropertyDecl::OBJC_PR_copy)
1882 if (Attrs & ObjCPropertyDecl::OBJC_PR_nonatomic)
1884 if (Attrs & ObjCPropertyDecl::OBJC_PR_atomic)
1886 if (Attrs & ObjCPropertyDecl::OBJC_PR_weak)
1888 if (Attrs & ObjCPropertyDecl::OBJC_PR_strong)
1890 if (Attrs & ObjCPropertyDecl::OBJC_PR_unsafe_unretained)
1891 OS << " unsafe_unretained";
1892 if (Attrs & ObjCPropertyDecl::OBJC_PR_class)
1894 if (Attrs & ObjCPropertyDecl::OBJC_PR_getter)
1895 dumpDeclRef(D->getGetterMethodDecl(), "getter");
1896 if (Attrs & ObjCPropertyDecl::OBJC_PR_setter)
1897 dumpDeclRef(D->getSetterMethodDecl(), "setter");
1901 void ASTDumper::VisitObjCPropertyImplDecl(const ObjCPropertyImplDecl *D) {
1902 dumpName(D->getPropertyDecl());
1903 if (D->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize)
1904 OS << " synthesize";
1907 dumpDeclRef(D->getPropertyDecl());
1908 dumpDeclRef(D->getPropertyIvarDecl());
1911 void ASTDumper::VisitBlockDecl(const BlockDecl *D) {
1912 for (auto I : D->parameters())
1915 if (D->isVariadic())
1916 dumpChild([=]{ OS << "..."; });
1918 if (D->capturesCXXThis())
1919 dumpChild([=]{ OS << "capture this"; });
1921 for (const auto &I : D->captures()) {
1928 if (I.getVariable()) {
1930 dumpBareDeclRef(I.getVariable());
1932 if (I.hasCopyExpr())
1933 dumpStmt(I.getCopyExpr());
1936 dumpStmt(D->getBody());
1939 //===----------------------------------------------------------------------===//
1940 // Stmt dumping methods.
1941 //===----------------------------------------------------------------------===//
1943 void ASTDumper::dumpStmt(const Stmt *S) {
1946 ColorScope Color(*this, NullColor);
1951 // Some statements have custom mechanisms for dumping their children.
1952 if (const DeclStmt *DS = dyn_cast<DeclStmt>(S)) {
1956 if (const GenericSelectionExpr *GSE = dyn_cast<GenericSelectionExpr>(S)) {
1957 VisitGenericSelectionExpr(GSE);
1961 ConstStmtVisitor<ASTDumper>::Visit(S);
1963 for (const Stmt *SubStmt : S->children())
1968 void ASTDumper::VisitStmt(const Stmt *Node) {
1970 ColorScope Color(*this, StmtColor);
1971 OS << Node->getStmtClassName();
1974 dumpSourceRange(Node->getSourceRange());
1977 void ASTDumper::VisitDeclStmt(const DeclStmt *Node) {
1979 for (DeclStmt::const_decl_iterator I = Node->decl_begin(),
1980 E = Node->decl_end();
1985 void ASTDumper::VisitAttributedStmt(const AttributedStmt *Node) {
1987 for (ArrayRef<const Attr *>::iterator I = Node->getAttrs().begin(),
1988 E = Node->getAttrs().end();
1993 void ASTDumper::VisitLabelStmt(const LabelStmt *Node) {
1995 OS << " '" << Node->getName() << "'";
1998 void ASTDumper::VisitGotoStmt(const GotoStmt *Node) {
2000 OS << " '" << Node->getLabel()->getName() << "'";
2001 dumpPointer(Node->getLabel());
2004 void ASTDumper::VisitCXXCatchStmt(const CXXCatchStmt *Node) {
2006 dumpDecl(Node->getExceptionDecl());
2009 void ASTDumper::VisitCapturedStmt(const CapturedStmt *Node) {
2011 dumpDecl(Node->getCapturedDecl());
2014 //===----------------------------------------------------------------------===//
2015 // OpenMP dumping methods.
2016 //===----------------------------------------------------------------------===//
2018 void ASTDumper::VisitOMPExecutableDirective(
2019 const OMPExecutableDirective *Node) {
2021 for (auto *C : Node->clauses()) {
2024 ColorScope Color(*this, NullColor);
2025 OS << "<<<NULL>>> OMPClause";
2029 ColorScope Color(*this, AttrColor);
2030 StringRef ClauseName(getOpenMPClauseName(C->getClauseKind()));
2031 OS << "OMP" << ClauseName.substr(/*Start=*/0, /*N=*/1).upper()
2032 << ClauseName.drop_front() << "Clause";
2035 dumpSourceRange(SourceRange(C->getLocStart(), C->getLocEnd()));
2036 if (C->isImplicit())
2037 OS << " <implicit>";
2038 for (auto *S : C->children())
2044 //===----------------------------------------------------------------------===//
2045 // Expr dumping methods.
2046 //===----------------------------------------------------------------------===//
2048 void ASTDumper::VisitExpr(const Expr *Node) {
2050 dumpType(Node->getType());
2053 ColorScope Color(*this, ValueKindColor);
2054 switch (Node->getValueKind()) {
2067 ColorScope Color(*this, ObjectKindColor);
2068 switch (Node->getObjectKind()) {
2074 case OK_ObjCProperty:
2075 OS << " objcproperty";
2077 case OK_ObjCSubscript:
2078 OS << " objcsubscript";
2080 case OK_VectorComponent:
2081 OS << " vectorcomponent";
2087 static void dumpBasePath(raw_ostream &OS, const CastExpr *Node) {
2088 if (Node->path_empty())
2093 for (CastExpr::path_const_iterator I = Node->path_begin(),
2094 E = Node->path_end();
2096 const CXXBaseSpecifier *Base = *I;
2100 const CXXRecordDecl *RD =
2101 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
2103 if (Base->isVirtual())
2105 OS << RD->getName();
2112 void ASTDumper::VisitCastExpr(const CastExpr *Node) {
2116 ColorScope Color(*this, CastColor);
2117 OS << Node->getCastKindName();
2119 dumpBasePath(OS, Node);
2123 void ASTDumper::VisitImplicitCastExpr(const ImplicitCastExpr *Node) {
2124 VisitCastExpr(Node);
2125 if (Node->isPartOfExplicitCast())
2126 OS << " part_of_explicit_cast";
2129 void ASTDumper::VisitDeclRefExpr(const DeclRefExpr *Node) {
2133 dumpBareDeclRef(Node->getDecl());
2134 if (Node->getDecl() != Node->getFoundDecl()) {
2136 dumpBareDeclRef(Node->getFoundDecl());
2141 void ASTDumper::VisitUnresolvedLookupExpr(const UnresolvedLookupExpr *Node) {
2144 if (!Node->requiresADL())
2146 OS << "ADL) = '" << Node->getName() << '\'';
2148 UnresolvedLookupExpr::decls_iterator
2149 I = Node->decls_begin(), E = Node->decls_end();
2156 void ASTDumper::VisitObjCIvarRefExpr(const ObjCIvarRefExpr *Node) {
2160 ColorScope Color(*this, DeclKindNameColor);
2161 OS << " " << Node->getDecl()->getDeclKindName() << "Decl";
2163 OS << "='" << *Node->getDecl() << "'";
2164 dumpPointer(Node->getDecl());
2165 if (Node->isFreeIvar())
2166 OS << " isFreeIvar";
2169 void ASTDumper::VisitPredefinedExpr(const PredefinedExpr *Node) {
2171 OS << " " << PredefinedExpr::getIdentTypeName(Node->getIdentType());
2174 void ASTDumper::VisitCharacterLiteral(const CharacterLiteral *Node) {
2176 ColorScope Color(*this, ValueColor);
2177 OS << " " << Node->getValue();
2180 void ASTDumper::VisitIntegerLiteral(const IntegerLiteral *Node) {
2183 bool isSigned = Node->getType()->isSignedIntegerType();
2184 ColorScope Color(*this, ValueColor);
2185 OS << " " << Node->getValue().toString(10, isSigned);
2188 void ASTDumper::VisitFixedPointLiteral(const FixedPointLiteral *Node) {
2191 ColorScope Color(*this, ValueColor);
2192 OS << " " << Node->getValueAsString(/*Radix=*/10);
2195 void ASTDumper::VisitFloatingLiteral(const FloatingLiteral *Node) {
2197 ColorScope Color(*this, ValueColor);
2198 OS << " " << Node->getValueAsApproximateDouble();
2201 void ASTDumper::VisitStringLiteral(const StringLiteral *Str) {
2203 ColorScope Color(*this, ValueColor);
2205 Str->outputString(OS);
2208 void ASTDumper::VisitInitListExpr(const InitListExpr *ILE) {
2210 if (auto *Filler = ILE->getArrayFiller()) {
2212 OS << "array filler";
2216 if (auto *Field = ILE->getInitializedFieldInUnion()) {
2218 dumpBareDeclRef(Field);
2222 void ASTDumper::VisitArrayInitLoopExpr(const ArrayInitLoopExpr *E) {
2226 void ASTDumper::VisitArrayInitIndexExpr(const ArrayInitIndexExpr *E) {
2230 void ASTDumper::VisitUnaryOperator(const UnaryOperator *Node) {
2232 OS << " " << (Node->isPostfix() ? "postfix" : "prefix")
2233 << " '" << UnaryOperator::getOpcodeStr(Node->getOpcode()) << "'";
2234 if (!Node->canOverflow())
2235 OS << " cannot overflow";
2238 void ASTDumper::VisitUnaryExprOrTypeTraitExpr(
2239 const UnaryExprOrTypeTraitExpr *Node) {
2241 switch(Node->getKind()) {
2251 case UETT_OpenMPRequiredSimdAlign:
2252 OS << " __builtin_omp_required_simd_align";
2255 if (Node->isArgumentType())
2256 dumpType(Node->getArgumentType());
2259 void ASTDumper::VisitMemberExpr(const MemberExpr *Node) {
2261 OS << " " << (Node->isArrow() ? "->" : ".") << *Node->getMemberDecl();
2262 dumpPointer(Node->getMemberDecl());
2265 void ASTDumper::VisitExtVectorElementExpr(const ExtVectorElementExpr *Node) {
2267 OS << " " << Node->getAccessor().getNameStart();
2270 void ASTDumper::VisitBinaryOperator(const BinaryOperator *Node) {
2272 OS << " '" << BinaryOperator::getOpcodeStr(Node->getOpcode()) << "'";
2275 void ASTDumper::VisitCompoundAssignOperator(
2276 const CompoundAssignOperator *Node) {
2278 OS << " '" << BinaryOperator::getOpcodeStr(Node->getOpcode())
2279 << "' ComputeLHSTy=";
2280 dumpBareType(Node->getComputationLHSType());
2281 OS << " ComputeResultTy=";
2282 dumpBareType(Node->getComputationResultType());
2285 void ASTDumper::VisitBlockExpr(const BlockExpr *Node) {
2287 dumpDecl(Node->getBlockDecl());
2290 void ASTDumper::VisitOpaqueValueExpr(const OpaqueValueExpr *Node) {
2293 if (Expr *Source = Node->getSourceExpr())
2297 void ASTDumper::VisitGenericSelectionExpr(const GenericSelectionExpr *E) {
2299 if (E->isResultDependent())
2300 OS << " result_dependent";
2301 dumpStmt(E->getControllingExpr());
2302 dumpTypeAsChild(E->getControllingExpr()->getType()); // FIXME: remove
2304 for (unsigned I = 0, N = E->getNumAssocs(); I != N; ++I) {
2306 if (const TypeSourceInfo *TSI = E->getAssocTypeSourceInfo(I)) {
2308 dumpType(TSI->getType());
2313 if (!E->isResultDependent() && E->getResultIndex() == I)
2316 if (const TypeSourceInfo *TSI = E->getAssocTypeSourceInfo(I))
2317 dumpTypeAsChild(TSI->getType());
2318 dumpStmt(E->getAssocExpr(I));
2325 void ASTDumper::VisitAddrLabelExpr(const AddrLabelExpr *Node) {
2327 OS << " " << Node->getLabel()->getName();
2328 dumpPointer(Node->getLabel());
2331 //===----------------------------------------------------------------------===//
2333 //===----------------------------------------------------------------------===//
2335 void ASTDumper::VisitCXXNamedCastExpr(const CXXNamedCastExpr *Node) {
2337 OS << " " << Node->getCastName()
2338 << "<" << Node->getTypeAsWritten().getAsString() << ">"
2339 << " <" << Node->getCastKindName();
2340 dumpBasePath(OS, Node);
2344 void ASTDumper::VisitCXXBoolLiteralExpr(const CXXBoolLiteralExpr *Node) {
2346 OS << " " << (Node->getValue() ? "true" : "false");
2349 void ASTDumper::VisitCXXThisExpr(const CXXThisExpr *Node) {
2354 void ASTDumper::VisitCXXFunctionalCastExpr(const CXXFunctionalCastExpr *Node) {
2356 OS << " functional cast to " << Node->getTypeAsWritten().getAsString()
2357 << " <" << Node->getCastKindName() << ">";
2360 void ASTDumper::VisitCXXUnresolvedConstructExpr(
2361 const CXXUnresolvedConstructExpr *Node) {
2363 dumpType(Node->getTypeAsWritten());
2364 if (Node->isListInitialization())
2368 void ASTDumper::VisitCXXConstructExpr(const CXXConstructExpr *Node) {
2370 CXXConstructorDecl *Ctor = Node->getConstructor();
2371 dumpType(Ctor->getType());
2372 if (Node->isElidable())
2374 if (Node->isListInitialization())
2376 if (Node->isStdInitListInitialization())
2377 OS << " std::initializer_list";
2378 if (Node->requiresZeroInitialization())
2382 void ASTDumper::VisitCXXBindTemporaryExpr(const CXXBindTemporaryExpr *Node) {
2385 dumpCXXTemporary(Node->getTemporary());
2388 void ASTDumper::VisitCXXNewExpr(const CXXNewExpr *Node) {
2390 if (Node->isGlobalNew())
2392 if (Node->isArray())
2394 if (Node->getOperatorNew()) {
2396 dumpBareDeclRef(Node->getOperatorNew());
2398 // We could dump the deallocation function used in case of error, but it's
2399 // usually not that interesting.
2402 void ASTDumper::VisitCXXDeleteExpr(const CXXDeleteExpr *Node) {
2404 if (Node->isGlobalDelete())
2406 if (Node->isArrayForm())
2408 if (Node->getOperatorDelete()) {
2410 dumpBareDeclRef(Node->getOperatorDelete());
2415 ASTDumper::VisitMaterializeTemporaryExpr(const MaterializeTemporaryExpr *Node) {
2417 if (const ValueDecl *VD = Node->getExtendingDecl()) {
2418 OS << " extended by ";
2419 dumpBareDeclRef(VD);
2423 void ASTDumper::VisitExprWithCleanups(const ExprWithCleanups *Node) {
2425 for (unsigned i = 0, e = Node->getNumObjects(); i != e; ++i)
2426 dumpDeclRef(Node->getObject(i), "cleanup");
2429 void ASTDumper::dumpCXXTemporary(const CXXTemporary *Temporary) {
2430 OS << "(CXXTemporary";
2431 dumpPointer(Temporary);
2435 void ASTDumper::VisitSizeOfPackExpr(const SizeOfPackExpr *Node) {
2437 dumpPointer(Node->getPack());
2438 dumpName(Node->getPack());
2439 if (Node->isPartiallySubstituted())
2440 for (const auto &A : Node->getPartialArguments())
2441 dumpTemplateArgument(A);
2444 void ASTDumper::VisitCXXDependentScopeMemberExpr(
2445 const CXXDependentScopeMemberExpr *Node) {
2447 OS << " " << (Node->isArrow() ? "->" : ".") << Node->getMember();
2450 //===----------------------------------------------------------------------===//
2451 // Obj-C Expressions
2452 //===----------------------------------------------------------------------===//
2454 void ASTDumper::VisitObjCMessageExpr(const ObjCMessageExpr *Node) {
2457 Node->getSelector().print(OS);
2458 switch (Node->getReceiverKind()) {
2459 case ObjCMessageExpr::Instance:
2462 case ObjCMessageExpr::Class:
2464 dumpBareType(Node->getClassReceiver());
2467 case ObjCMessageExpr::SuperInstance:
2468 OS << " super (instance)";
2471 case ObjCMessageExpr::SuperClass:
2472 OS << " super (class)";
2477 void ASTDumper::VisitObjCBoxedExpr(const ObjCBoxedExpr *Node) {
2479 if (auto *BoxingMethod = Node->getBoxingMethod()) {
2481 BoxingMethod->getSelector().print(OS);
2485 void ASTDumper::VisitObjCAtCatchStmt(const ObjCAtCatchStmt *Node) {
2487 if (const VarDecl *CatchParam = Node->getCatchParamDecl())
2488 dumpDecl(CatchParam);
2493 void ASTDumper::VisitObjCEncodeExpr(const ObjCEncodeExpr *Node) {
2495 dumpType(Node->getEncodedType());
2498 void ASTDumper::VisitObjCSelectorExpr(const ObjCSelectorExpr *Node) {
2502 Node->getSelector().print(OS);
2505 void ASTDumper::VisitObjCProtocolExpr(const ObjCProtocolExpr *Node) {
2508 OS << ' ' << *Node->getProtocol();
2511 void ASTDumper::VisitObjCPropertyRefExpr(const ObjCPropertyRefExpr *Node) {
2513 if (Node->isImplicitProperty()) {
2514 OS << " Kind=MethodRef Getter=\"";
2515 if (Node->getImplicitPropertyGetter())
2516 Node->getImplicitPropertyGetter()->getSelector().print(OS);
2520 OS << "\" Setter=\"";
2521 if (ObjCMethodDecl *Setter = Node->getImplicitPropertySetter())
2522 Setter->getSelector().print(OS);
2527 OS << " Kind=PropertyRef Property=\"" << *Node->getExplicitProperty() <<'"';
2530 if (Node->isSuperReceiver())
2533 OS << " Messaging=";
2534 if (Node->isMessagingGetter() && Node->isMessagingSetter())
2535 OS << "Getter&Setter";
2536 else if (Node->isMessagingGetter())
2538 else if (Node->isMessagingSetter())
2542 void ASTDumper::VisitObjCSubscriptRefExpr(const ObjCSubscriptRefExpr *Node) {
2544 if (Node->isArraySubscriptRefExpr())
2545 OS << " Kind=ArraySubscript GetterForArray=\"";
2547 OS << " Kind=DictionarySubscript GetterForDictionary=\"";
2548 if (Node->getAtIndexMethodDecl())
2549 Node->getAtIndexMethodDecl()->getSelector().print(OS);
2553 if (Node->isArraySubscriptRefExpr())
2554 OS << "\" SetterForArray=\"";
2556 OS << "\" SetterForDictionary=\"";
2557 if (Node->setAtIndexMethodDecl())
2558 Node->setAtIndexMethodDecl()->getSelector().print(OS);
2563 void ASTDumper::VisitObjCBoolLiteralExpr(const ObjCBoolLiteralExpr *Node) {
2565 OS << " " << (Node->getValue() ? "__objc_yes" : "__objc_no");
2568 //===----------------------------------------------------------------------===//
2570 //===----------------------------------------------------------------------===//
2572 const char *ASTDumper::getCommandName(unsigned CommandID) {
2574 return Traits->getCommandInfo(CommandID)->Name;
2575 const CommandInfo *Info = CommandTraits::getBuiltinCommandInfo(CommandID);
2578 return "<not a builtin command>";
2581 void ASTDumper::dumpFullComment(const FullComment *C) {
2590 void ASTDumper::dumpComment(const Comment *C) {
2593 ColorScope Color(*this, NullColor);
2599 ColorScope Color(*this, CommentColor);
2600 OS << C->getCommentKindName();
2603 dumpSourceRange(C->getSourceRange());
2604 ConstCommentVisitor<ASTDumper>::visit(C);
2605 for (Comment::child_iterator I = C->child_begin(), E = C->child_end();
2611 void ASTDumper::visitTextComment(const TextComment *C) {
2612 OS << " Text=\"" << C->getText() << "\"";
2615 void ASTDumper::visitInlineCommandComment(const InlineCommandComment *C) {
2616 OS << " Name=\"" << getCommandName(C->getCommandID()) << "\"";
2617 switch (C->getRenderKind()) {
2618 case InlineCommandComment::RenderNormal:
2619 OS << " RenderNormal";
2621 case InlineCommandComment::RenderBold:
2622 OS << " RenderBold";
2624 case InlineCommandComment::RenderMonospaced:
2625 OS << " RenderMonospaced";
2627 case InlineCommandComment::RenderEmphasized:
2628 OS << " RenderEmphasized";
2632 for (unsigned i = 0, e = C->getNumArgs(); i != e; ++i)
2633 OS << " Arg[" << i << "]=\"" << C->getArgText(i) << "\"";
2636 void ASTDumper::visitHTMLStartTagComment(const HTMLStartTagComment *C) {
2637 OS << " Name=\"" << C->getTagName() << "\"";
2638 if (C->getNumAttrs() != 0) {
2640 for (unsigned i = 0, e = C->getNumAttrs(); i != e; ++i) {
2641 const HTMLStartTagComment::Attribute &Attr = C->getAttr(i);
2642 OS << " \"" << Attr.Name << "=\"" << Attr.Value << "\"";
2645 if (C->isSelfClosing())
2646 OS << " SelfClosing";
2649 void ASTDumper::visitHTMLEndTagComment(const HTMLEndTagComment *C) {
2650 OS << " Name=\"" << C->getTagName() << "\"";
2653 void ASTDumper::visitBlockCommandComment(const BlockCommandComment *C) {
2654 OS << " Name=\"" << getCommandName(C->getCommandID()) << "\"";
2655 for (unsigned i = 0, e = C->getNumArgs(); i != e; ++i)
2656 OS << " Arg[" << i << "]=\"" << C->getArgText(i) << "\"";
2659 void ASTDumper::visitParamCommandComment(const ParamCommandComment *C) {
2660 OS << " " << ParamCommandComment::getDirectionAsString(C->getDirection());
2662 if (C->isDirectionExplicit())
2663 OS << " explicitly";
2665 OS << " implicitly";
2667 if (C->hasParamName()) {
2668 if (C->isParamIndexValid())
2669 OS << " Param=\"" << C->getParamName(FC) << "\"";
2671 OS << " Param=\"" << C->getParamNameAsWritten() << "\"";
2674 if (C->isParamIndexValid() && !C->isVarArgParam())
2675 OS << " ParamIndex=" << C->getParamIndex();
2678 void ASTDumper::visitTParamCommandComment(const TParamCommandComment *C) {
2679 if (C->hasParamName()) {
2680 if (C->isPositionValid())
2681 OS << " Param=\"" << C->getParamName(FC) << "\"";
2683 OS << " Param=\"" << C->getParamNameAsWritten() << "\"";
2686 if (C->isPositionValid()) {
2687 OS << " Position=<";
2688 for (unsigned i = 0, e = C->getDepth(); i != e; ++i) {
2689 OS << C->getIndex(i);
2697 void ASTDumper::visitVerbatimBlockComment(const VerbatimBlockComment *C) {
2698 OS << " Name=\"" << getCommandName(C->getCommandID()) << "\""
2699 " CloseName=\"" << C->getCloseName() << "\"";
2702 void ASTDumper::visitVerbatimBlockLineComment(
2703 const VerbatimBlockLineComment *C) {
2704 OS << " Text=\"" << C->getText() << "\"";
2707 void ASTDumper::visitVerbatimLineComment(const VerbatimLineComment *C) {
2708 OS << " Text=\"" << C->getText() << "\"";
2711 //===----------------------------------------------------------------------===//
2712 // Type method implementations
2713 //===----------------------------------------------------------------------===//
2715 void QualType::dump(const char *msg) const {
2717 llvm::errs() << msg << ": ";
2721 LLVM_DUMP_METHOD void QualType::dump() const { dump(llvm::errs()); }
2723 LLVM_DUMP_METHOD void QualType::dump(llvm::raw_ostream &OS) const {
2724 ASTDumper Dumper(OS, nullptr, nullptr);
2725 Dumper.dumpTypeAsChild(*this);
2728 LLVM_DUMP_METHOD void Type::dump() const { dump(llvm::errs()); }
2730 LLVM_DUMP_METHOD void Type::dump(llvm::raw_ostream &OS) const {
2731 QualType(this, 0).dump(OS);
2734 //===----------------------------------------------------------------------===//
2735 // Decl method implementations
2736 //===----------------------------------------------------------------------===//
2738 LLVM_DUMP_METHOD void Decl::dump() const { dump(llvm::errs()); }
2740 LLVM_DUMP_METHOD void Decl::dump(raw_ostream &OS, bool Deserialize) const {
2741 const ASTContext &Ctx = getASTContext();
2742 const SourceManager &SM = Ctx.getSourceManager();
2743 ASTDumper P(OS, &Ctx.getCommentCommandTraits(), &SM,
2744 SM.getDiagnostics().getShowColors(), Ctx.getPrintingPolicy());
2745 P.setDeserialize(Deserialize);
2749 LLVM_DUMP_METHOD void Decl::dumpColor() const {
2750 const ASTContext &Ctx = getASTContext();
2751 ASTDumper P(llvm::errs(), &Ctx.getCommentCommandTraits(),
2752 &Ctx.getSourceManager(), /*ShowColors*/ true,
2753 Ctx.getPrintingPolicy());
2757 LLVM_DUMP_METHOD void DeclContext::dumpLookups() const {
2758 dumpLookups(llvm::errs());
2761 LLVM_DUMP_METHOD void DeclContext::dumpLookups(raw_ostream &OS,
2763 bool Deserialize) const {
2764 const DeclContext *DC = this;
2765 while (!DC->isTranslationUnit())
2766 DC = DC->getParent();
2767 ASTContext &Ctx = cast<TranslationUnitDecl>(DC)->getASTContext();
2768 const SourceManager &SM = Ctx.getSourceManager();
2769 ASTDumper P(OS, &Ctx.getCommentCommandTraits(), &Ctx.getSourceManager(),
2770 SM.getDiagnostics().getShowColors(), Ctx.getPrintingPolicy());
2771 P.setDeserialize(Deserialize);
2772 P.dumpLookups(this, DumpDecls);
2775 //===----------------------------------------------------------------------===//
2776 // Stmt method implementations
2777 //===----------------------------------------------------------------------===//
2779 LLVM_DUMP_METHOD void Stmt::dump(SourceManager &SM) const {
2780 dump(llvm::errs(), SM);
2783 LLVM_DUMP_METHOD void Stmt::dump(raw_ostream &OS, SourceManager &SM) const {
2784 ASTDumper P(OS, nullptr, &SM);
2788 LLVM_DUMP_METHOD void Stmt::dump(raw_ostream &OS) const {
2789 ASTDumper P(OS, nullptr, nullptr);
2793 LLVM_DUMP_METHOD void Stmt::dump() const {
2794 ASTDumper P(llvm::errs(), nullptr, nullptr);
2798 LLVM_DUMP_METHOD void Stmt::dumpColor() const {
2799 ASTDumper P(llvm::errs(), nullptr, nullptr, /*ShowColors*/true);
2803 //===----------------------------------------------------------------------===//
2804 // Comment method implementations
2805 //===----------------------------------------------------------------------===//
2807 LLVM_DUMP_METHOD void Comment::dump() const {
2808 dump(llvm::errs(), nullptr, nullptr);
2811 LLVM_DUMP_METHOD void Comment::dump(const ASTContext &Context) const {
2812 dump(llvm::errs(), &Context.getCommentCommandTraits(),
2813 &Context.getSourceManager());
2816 void Comment::dump(raw_ostream &OS, const CommandTraits *Traits,
2817 const SourceManager *SM) const {
2818 const FullComment *FC = dyn_cast<FullComment>(this);
2819 ASTDumper D(OS, Traits, SM);
2820 D.dumpFullComment(FC);
2823 LLVM_DUMP_METHOD void Comment::dumpColor() const {
2824 const FullComment *FC = dyn_cast<FullComment>(this);
2825 ASTDumper D(llvm::errs(), nullptr, nullptr, /*ShowColors*/true);
2826 D.dumpFullComment(FC);