1 //===--- DeclPrinter.cpp - Printing implementation for Decl 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 Decl::print method, which pretty prints the
11 // AST back out to C/Objective-C/C++/Objective-C++ code.
13 //===----------------------------------------------------------------------===//
14 #include "clang/AST/ASTContext.h"
15 #include "clang/AST/Attr.h"
16 #include "clang/AST/Decl.h"
17 #include "clang/AST/DeclCXX.h"
18 #include "clang/AST/DeclObjC.h"
19 #include "clang/AST/DeclVisitor.h"
20 #include "clang/AST/Expr.h"
21 #include "clang/AST/ExprCXX.h"
22 #include "clang/AST/PrettyPrinter.h"
23 #include "clang/Basic/Module.h"
24 #include "llvm/Support/raw_ostream.h"
25 using namespace clang;
28 class DeclPrinter : public DeclVisitor<DeclPrinter> {
30 PrintingPolicy Policy;
32 bool PrintInstantiation;
34 raw_ostream& Indent() { return Indent(Indentation); }
35 raw_ostream& Indent(unsigned Indentation);
36 void ProcessDeclGroup(SmallVectorImpl<Decl*>& Decls);
38 void Print(AccessSpecifier AS);
40 /// Print an Objective-C method type in parentheses.
42 /// \param Quals The Objective-C declaration qualifiers.
43 /// \param T The type to print.
44 void PrintObjCMethodType(ASTContext &Ctx, Decl::ObjCDeclQualifier Quals,
47 void PrintObjCTypeParams(ObjCTypeParamList *Params);
50 DeclPrinter(raw_ostream &Out, const PrintingPolicy &Policy,
51 unsigned Indentation = 0, bool PrintInstantiation = false)
52 : Out(Out), Policy(Policy), Indentation(Indentation),
53 PrintInstantiation(PrintInstantiation) { }
55 void VisitDeclContext(DeclContext *DC, bool Indent = true);
57 void VisitTranslationUnitDecl(TranslationUnitDecl *D);
58 void VisitTypedefDecl(TypedefDecl *D);
59 void VisitTypeAliasDecl(TypeAliasDecl *D);
60 void VisitEnumDecl(EnumDecl *D);
61 void VisitRecordDecl(RecordDecl *D);
62 void VisitEnumConstantDecl(EnumConstantDecl *D);
63 void VisitEmptyDecl(EmptyDecl *D);
64 void VisitFunctionDecl(FunctionDecl *D);
65 void VisitFriendDecl(FriendDecl *D);
66 void VisitFieldDecl(FieldDecl *D);
67 void VisitVarDecl(VarDecl *D);
68 void VisitLabelDecl(LabelDecl *D);
69 void VisitParmVarDecl(ParmVarDecl *D);
70 void VisitFileScopeAsmDecl(FileScopeAsmDecl *D);
71 void VisitImportDecl(ImportDecl *D);
72 void VisitStaticAssertDecl(StaticAssertDecl *D);
73 void VisitNamespaceDecl(NamespaceDecl *D);
74 void VisitUsingDirectiveDecl(UsingDirectiveDecl *D);
75 void VisitNamespaceAliasDecl(NamespaceAliasDecl *D);
76 void VisitCXXRecordDecl(CXXRecordDecl *D);
77 void VisitLinkageSpecDecl(LinkageSpecDecl *D);
78 void VisitTemplateDecl(const TemplateDecl *D);
79 void VisitFunctionTemplateDecl(FunctionTemplateDecl *D);
80 void VisitClassTemplateDecl(ClassTemplateDecl *D);
81 void VisitClassTemplateSpecializationDecl(
82 ClassTemplateSpecializationDecl *D);
83 void VisitClassTemplatePartialSpecializationDecl(
84 ClassTemplatePartialSpecializationDecl *D);
85 void VisitObjCMethodDecl(ObjCMethodDecl *D);
86 void VisitObjCImplementationDecl(ObjCImplementationDecl *D);
87 void VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
88 void VisitObjCProtocolDecl(ObjCProtocolDecl *D);
89 void VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
90 void VisitObjCCategoryDecl(ObjCCategoryDecl *D);
91 void VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *D);
92 void VisitObjCPropertyDecl(ObjCPropertyDecl *D);
93 void VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *D);
94 void VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D);
95 void VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D);
96 void VisitUsingDecl(UsingDecl *D);
97 void VisitUsingShadowDecl(UsingShadowDecl *D);
98 void VisitOMPThreadPrivateDecl(OMPThreadPrivateDecl *D);
99 void VisitOMPDeclareReductionDecl(OMPDeclareReductionDecl *D);
100 void VisitOMPCapturedExprDecl(OMPCapturedExprDecl *D);
102 void printTemplateParameters(const TemplateParameterList *Params);
103 void printTemplateArguments(const TemplateArgumentList &Args,
104 const TemplateParameterList *Params = nullptr);
105 void prettyPrintAttributes(Decl *D);
106 void prettyPrintPragmas(Decl *D);
107 void printDeclType(QualType T, StringRef DeclName, bool Pack = false);
111 void Decl::print(raw_ostream &Out, unsigned Indentation,
112 bool PrintInstantiation) const {
113 print(Out, getASTContext().getPrintingPolicy(), Indentation, PrintInstantiation);
116 void Decl::print(raw_ostream &Out, const PrintingPolicy &Policy,
117 unsigned Indentation, bool PrintInstantiation) const {
118 DeclPrinter Printer(Out, Policy, Indentation, PrintInstantiation);
119 Printer.Visit(const_cast<Decl*>(this));
122 static QualType GetBaseType(QualType T) {
123 // FIXME: This should be on the Type class!
124 QualType BaseType = T;
125 while (!BaseType->isSpecifierType()) {
126 if (isa<TypedefType>(BaseType))
128 else if (const PointerType* PTy = BaseType->getAs<PointerType>())
129 BaseType = PTy->getPointeeType();
130 else if (const BlockPointerType *BPy = BaseType->getAs<BlockPointerType>())
131 BaseType = BPy->getPointeeType();
132 else if (const ArrayType* ATy = dyn_cast<ArrayType>(BaseType))
133 BaseType = ATy->getElementType();
134 else if (const FunctionType* FTy = BaseType->getAs<FunctionType>())
135 BaseType = FTy->getReturnType();
136 else if (const VectorType *VTy = BaseType->getAs<VectorType>())
137 BaseType = VTy->getElementType();
138 else if (const ReferenceType *RTy = BaseType->getAs<ReferenceType>())
139 BaseType = RTy->getPointeeType();
140 else if (const AutoType *ATy = BaseType->getAs<AutoType>())
141 BaseType = ATy->getDeducedType();
143 llvm_unreachable("Unknown declarator!");
148 static QualType getDeclType(Decl* D) {
149 if (TypedefNameDecl* TDD = dyn_cast<TypedefNameDecl>(D))
150 return TDD->getUnderlyingType();
151 if (ValueDecl* VD = dyn_cast<ValueDecl>(D))
152 return VD->getType();
156 void Decl::printGroup(Decl** Begin, unsigned NumDecls,
157 raw_ostream &Out, const PrintingPolicy &Policy,
158 unsigned Indentation) {
160 (*Begin)->print(Out, Policy, Indentation);
164 Decl** End = Begin + NumDecls;
165 TagDecl* TD = dyn_cast<TagDecl>(*Begin);
169 PrintingPolicy SubPolicy(Policy);
172 for ( ; Begin != End; ++Begin) {
175 SubPolicy.IncludeTagDefinition = true;
176 SubPolicy.SuppressSpecifiers = false;
179 if (!isFirst) Out << ", ";
180 SubPolicy.IncludeTagDefinition = false;
181 SubPolicy.SuppressSpecifiers = true;
184 (*Begin)->print(Out, SubPolicy, Indentation);
188 LLVM_DUMP_METHOD void DeclContext::dumpDeclContext() const {
189 // Get the translation unit
190 const DeclContext *DC = this;
191 while (!DC->isTranslationUnit())
192 DC = DC->getParent();
194 ASTContext &Ctx = cast<TranslationUnitDecl>(DC)->getASTContext();
195 DeclPrinter Printer(llvm::errs(), Ctx.getPrintingPolicy(), 0);
196 Printer.VisitDeclContext(const_cast<DeclContext *>(this), /*Indent=*/false);
199 raw_ostream& DeclPrinter::Indent(unsigned Indentation) {
200 for (unsigned i = 0; i != Indentation; ++i)
205 void DeclPrinter::prettyPrintAttributes(Decl *D) {
206 if (Policy.PolishForDeclaration)
210 AttrVec &Attrs = D->getAttrs();
211 for (auto *A : Attrs) {
212 switch (A->getKind()) {
214 #define PRAGMA_SPELLING_ATTR(X) case attr::X:
215 #include "clang/Basic/AttrList.inc"
218 A->printPretty(Out, Policy);
225 void DeclPrinter::prettyPrintPragmas(Decl *D) {
226 if (Policy.PolishForDeclaration)
230 AttrVec &Attrs = D->getAttrs();
231 for (auto *A : Attrs) {
232 switch (A->getKind()) {
234 #define PRAGMA_SPELLING_ATTR(X) case attr::X:
235 #include "clang/Basic/AttrList.inc"
236 A->printPretty(Out, Policy);
246 void DeclPrinter::printDeclType(QualType T, StringRef DeclName, bool Pack) {
247 // Normally, a PackExpansionType is written as T[3]... (for instance, as a
248 // template argument), but if it is the type of a declaration, the ellipsis
249 // is placed before the name being declared.
250 if (auto *PET = T->getAs<PackExpansionType>()) {
252 T = PET->getPattern();
254 T.print(Out, Policy, (Pack ? "..." : "") + DeclName, Indentation);
257 void DeclPrinter::ProcessDeclGroup(SmallVectorImpl<Decl*>& Decls) {
259 Decl::printGroup(Decls.data(), Decls.size(), Out, Policy, Indentation);
265 void DeclPrinter::Print(AccessSpecifier AS) {
267 case AS_none: llvm_unreachable("No access specifier!");
268 case AS_public: Out << "public"; break;
269 case AS_protected: Out << "protected"; break;
270 case AS_private: Out << "private"; break;
274 //----------------------------------------------------------------------------
275 // Common C declarations
276 //----------------------------------------------------------------------------
278 void DeclPrinter::VisitDeclContext(DeclContext *DC, bool Indent) {
279 if (Policy.TerseOutput)
283 Indentation += Policy.Indentation;
285 SmallVector<Decl*, 2> Decls;
286 for (DeclContext::decl_iterator D = DC->decls_begin(), DEnd = DC->decls_end();
289 // Don't print ObjCIvarDecls, as they are printed when visiting the
290 // containing ObjCInterfaceDecl.
291 if (isa<ObjCIvarDecl>(*D))
294 // Skip over implicit declarations in pretty-printing mode.
298 // Don't print implicit specializations, as they are printed when visiting
299 // corresponding templates.
300 if (auto FD = dyn_cast<FunctionDecl>(*D))
301 if (FD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation &&
302 !isa<ClassTemplateSpecializationDecl>(DC))
305 // The next bits of code handles stuff like "struct {int x;} a,b"; we're
306 // forced to merge the declarations because there's no other way to
307 // refer to the struct in question. This limited merging is safe without
308 // a bunch of other checks because it only merges declarations directly
309 // referring to the tag, not typedefs.
311 // Check whether the current declaration should be grouped with a previous
313 QualType CurDeclType = getDeclType(*D);
314 if (!Decls.empty() && !CurDeclType.isNull()) {
315 QualType BaseType = GetBaseType(CurDeclType);
316 if (!BaseType.isNull() && isa<ElaboratedType>(BaseType))
317 BaseType = cast<ElaboratedType>(BaseType)->getNamedType();
318 if (!BaseType.isNull() && isa<TagType>(BaseType) &&
319 cast<TagType>(BaseType)->getDecl() == Decls[0]) {
325 // If we have a merged group waiting to be handled, handle it now.
327 ProcessDeclGroup(Decls);
329 // If the current declaration is an unnamed tag type, save it
330 // so we can merge it with the subsequent declaration(s) using it.
331 if (isa<TagDecl>(*D) && !cast<TagDecl>(*D)->getIdentifier()) {
336 if (isa<AccessSpecDecl>(*D)) {
337 Indentation -= Policy.Indentation;
339 Print(D->getAccess());
341 Indentation += Policy.Indentation;
348 // FIXME: Need to be able to tell the DeclPrinter when
349 const char *Terminator = nullptr;
350 if (isa<OMPThreadPrivateDecl>(*D) || isa<OMPDeclareReductionDecl>(*D))
351 Terminator = nullptr;
352 else if (isa<ObjCMethodDecl>(*D) && cast<ObjCMethodDecl>(*D)->hasBody())
353 Terminator = nullptr;
354 else if (auto FD = dyn_cast<FunctionDecl>(*D)) {
355 if (FD->isThisDeclarationADefinition())
356 Terminator = nullptr;
359 } else if (auto TD = dyn_cast<FunctionTemplateDecl>(*D)) {
360 if (TD->getTemplatedDecl()->isThisDeclarationADefinition())
361 Terminator = nullptr;
364 } else if (isa<NamespaceDecl>(*D) || isa<LinkageSpecDecl>(*D) ||
365 isa<ObjCImplementationDecl>(*D) ||
366 isa<ObjCInterfaceDecl>(*D) ||
367 isa<ObjCProtocolDecl>(*D) ||
368 isa<ObjCCategoryImplDecl>(*D) ||
369 isa<ObjCCategoryDecl>(*D))
370 Terminator = nullptr;
371 else if (isa<EnumConstantDecl>(*D)) {
372 DeclContext::decl_iterator Next = D;
381 if (!Policy.TerseOutput &&
382 ((isa<FunctionDecl>(*D) &&
383 cast<FunctionDecl>(*D)->doesThisDeclarationHaveABody()) ||
384 (isa<FunctionTemplateDecl>(*D) &&
385 cast<FunctionTemplateDecl>(*D)->getTemplatedDecl()->doesThisDeclarationHaveABody())))
386 ; // StmtPrinter already added '\n' after CompoundStmt.
390 // Declare target attribute is special one, natural spelling for the pragma
391 // assumes "ending" construct so print it here.
392 if (D->hasAttr<OMPDeclareTargetDeclAttr>())
393 Out << "#pragma omp end declare target\n";
397 ProcessDeclGroup(Decls);
400 Indentation -= Policy.Indentation;
403 void DeclPrinter::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
404 VisitDeclContext(D, false);
407 void DeclPrinter::VisitTypedefDecl(TypedefDecl *D) {
408 if (!Policy.SuppressSpecifiers) {
411 if (D->isModulePrivate())
412 Out << "__module_private__ ";
414 QualType Ty = D->getTypeSourceInfo()->getType();
415 Ty.print(Out, Policy, D->getName(), Indentation);
416 prettyPrintAttributes(D);
419 void DeclPrinter::VisitTypeAliasDecl(TypeAliasDecl *D) {
420 Out << "using " << *D;
421 prettyPrintAttributes(D);
422 Out << " = " << D->getTypeSourceInfo()->getType().getAsString(Policy);
425 void DeclPrinter::VisitEnumDecl(EnumDecl *D) {
426 if (!Policy.SuppressSpecifiers && D->isModulePrivate())
427 Out << "__module_private__ ";
430 if (D->isScopedUsingClassTag())
437 if (D->isFixed() && D->getASTContext().getLangOpts().CPlusPlus11)
438 Out << " : " << D->getIntegerType().stream(Policy);
440 if (D->isCompleteDefinition()) {
445 prettyPrintAttributes(D);
448 void DeclPrinter::VisitRecordDecl(RecordDecl *D) {
449 if (!Policy.SuppressSpecifiers && D->isModulePrivate())
450 Out << "__module_private__ ";
451 Out << D->getKindName();
453 prettyPrintAttributes(D);
455 if (D->getIdentifier())
458 if (D->isCompleteDefinition()) {
465 void DeclPrinter::VisitEnumConstantDecl(EnumConstantDecl *D) {
467 if (Expr *Init = D->getInitExpr()) {
469 Init->printPretty(Out, nullptr, Policy, Indentation);
473 void DeclPrinter::VisitFunctionDecl(FunctionDecl *D) {
474 if (!D->getDescribedFunctionTemplate() &&
475 !D->isFunctionTemplateSpecialization())
476 prettyPrintPragmas(D);
478 if (D->isFunctionTemplateSpecialization())
479 Out << "template<> ";
481 CXXConstructorDecl *CDecl = dyn_cast<CXXConstructorDecl>(D);
482 CXXConversionDecl *ConversionDecl = dyn_cast<CXXConversionDecl>(D);
483 if (!Policy.SuppressSpecifiers) {
484 switch (D->getStorageClass()) {
486 case SC_Extern: Out << "extern "; break;
487 case SC_Static: Out << "static "; break;
488 case SC_PrivateExtern: Out << "__private_extern__ "; break;
489 case SC_Auto: case SC_Register:
490 llvm_unreachable("invalid for functions");
493 if (D->isInlineSpecified()) Out << "inline ";
494 if (D->isVirtualAsWritten()) Out << "virtual ";
495 if (D->isModulePrivate()) Out << "__module_private__ ";
496 if (D->isConstexpr() && !D->isExplicitlyDefaulted()) Out << "constexpr ";
497 if ((CDecl && CDecl->isExplicitSpecified()) ||
498 (ConversionDecl && ConversionDecl->isExplicit()))
502 PrintingPolicy SubPolicy(Policy);
503 SubPolicy.SuppressSpecifiers = false;
504 std::string Proto = D->getNameInfo().getAsString();
505 if (const TemplateArgumentList *TArgs = D->getTemplateSpecializationArgs()) {
506 llvm::raw_string_ostream POut(Proto);
507 DeclPrinter TArgPrinter(POut, SubPolicy, Indentation);
508 TArgPrinter.printTemplateArguments(*TArgs);
511 QualType Ty = D->getType();
512 while (const ParenType *PT = dyn_cast<ParenType>(Ty)) {
513 Proto = '(' + Proto + ')';
514 Ty = PT->getInnerType();
517 if (const FunctionType *AFT = Ty->getAs<FunctionType>()) {
518 const FunctionProtoType *FT = nullptr;
519 if (D->hasWrittenPrototype())
520 FT = dyn_cast<FunctionProtoType>(AFT);
524 llvm::raw_string_ostream POut(Proto);
525 DeclPrinter ParamPrinter(POut, SubPolicy, Indentation);
526 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) {
528 ParamPrinter.VisitParmVarDecl(D->getParamDecl(i));
531 if (FT->isVariadic()) {
532 if (D->getNumParams()) POut << ", ";
535 } else if (D->doesThisDeclarationHaveABody() && !D->hasPrototype()) {
536 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) {
539 Proto += D->getParamDecl(i)->getNameAsString();
548 if (FT->isVolatile())
549 Proto += " volatile";
550 if (FT->isRestrict())
551 Proto += " restrict";
553 switch (FT->getRefQualifier()) {
565 if (FT && FT->hasDynamicExceptionSpec()) {
567 if (FT->getExceptionSpecType() == EST_MSAny)
570 for (unsigned I = 0, N = FT->getNumExceptions(); I != N; ++I) {
574 Proto += FT->getExceptionType(I).getAsString(SubPolicy);
577 } else if (FT && isNoexceptExceptionSpec(FT->getExceptionSpecType())) {
578 Proto += " noexcept";
579 if (FT->getExceptionSpecType() == EST_ComputedNoexcept) {
581 llvm::raw_string_ostream EOut(Proto);
582 FT->getNoexceptExpr()->printPretty(EOut, nullptr, SubPolicy,
591 bool HasInitializerList = false;
592 for (const auto *BMInitializer : CDecl->inits()) {
593 if (BMInitializer->isInClassMemberInitializer())
596 if (!HasInitializerList) {
600 HasInitializerList = true;
604 if (BMInitializer->isAnyMemberInitializer()) {
605 FieldDecl *FD = BMInitializer->getAnyMember();
608 Out << QualType(BMInitializer->getBaseClass(), 0).getAsString(Policy);
612 if (!BMInitializer->getInit()) {
615 Expr *Init = BMInitializer->getInit();
616 if (ExprWithCleanups *Tmp = dyn_cast<ExprWithCleanups>(Init))
617 Init = Tmp->getSubExpr();
619 Init = Init->IgnoreParens();
621 Expr *SimpleInit = nullptr;
622 Expr **Args = nullptr;
623 unsigned NumArgs = 0;
624 if (ParenListExpr *ParenList = dyn_cast<ParenListExpr>(Init)) {
625 Args = ParenList->getExprs();
626 NumArgs = ParenList->getNumExprs();
627 } else if (CXXConstructExpr *Construct
628 = dyn_cast<CXXConstructExpr>(Init)) {
629 Args = Construct->getArgs();
630 NumArgs = Construct->getNumArgs();
635 SimpleInit->printPretty(Out, nullptr, Policy, Indentation);
637 for (unsigned I = 0; I != NumArgs; ++I) {
638 assert(Args[I] != nullptr && "Expected non-null Expr");
639 if (isa<CXXDefaultArgExpr>(Args[I]))
644 Args[I]->printPretty(Out, nullptr, Policy, Indentation);
649 if (BMInitializer->isPackExpansion())
652 } else if (!ConversionDecl && !isa<CXXDestructorDecl>(D)) {
653 if (FT && FT->hasTrailingReturn()) {
654 Out << "auto " << Proto << " -> ";
657 AFT->getReturnType().print(Out, Policy, Proto);
662 Ty.print(Out, Policy, Proto);
665 prettyPrintAttributes(D);
669 else if (D->isDeletedAsWritten())
671 else if (D->isExplicitlyDefaulted())
673 else if (D->doesThisDeclarationHaveABody()) {
674 if (!Policy.TerseOutput) {
675 if (!D->hasPrototype() && D->getNumParams()) {
676 // This is a K&R function definition, so we need to print the
679 DeclPrinter ParamPrinter(Out, SubPolicy, Indentation);
680 Indentation += Policy.Indentation;
681 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) {
683 ParamPrinter.VisitParmVarDecl(D->getParamDecl(i));
686 Indentation -= Policy.Indentation;
691 D->getBody()->printPretty(Out, nullptr, SubPolicy, Indentation);
693 if (isa<CXXConstructorDecl>(*D))
699 void DeclPrinter::VisitFriendDecl(FriendDecl *D) {
700 if (TypeSourceInfo *TSI = D->getFriendType()) {
701 unsigned NumTPLists = D->getFriendTypeNumTemplateParameterLists();
702 for (unsigned i = 0; i < NumTPLists; ++i)
703 printTemplateParameters(D->getFriendTypeTemplateParameterList(i));
705 Out << " " << TSI->getType().getAsString(Policy);
707 else if (FunctionDecl *FD =
708 dyn_cast<FunctionDecl>(D->getFriendDecl())) {
710 VisitFunctionDecl(FD);
712 else if (FunctionTemplateDecl *FTD =
713 dyn_cast<FunctionTemplateDecl>(D->getFriendDecl())) {
715 VisitFunctionTemplateDecl(FTD);
717 else if (ClassTemplateDecl *CTD =
718 dyn_cast<ClassTemplateDecl>(D->getFriendDecl())) {
720 VisitRedeclarableTemplateDecl(CTD);
724 void DeclPrinter::VisitFieldDecl(FieldDecl *D) {
725 // FIXME: add printing of pragma attributes if required.
726 if (!Policy.SuppressSpecifiers && D->isMutable())
728 if (!Policy.SuppressSpecifiers && D->isModulePrivate())
729 Out << "__module_private__ ";
731 Out << D->getASTContext().getUnqualifiedObjCPointerType(D->getType()).
732 stream(Policy, D->getName(), Indentation);
734 if (D->isBitField()) {
736 D->getBitWidth()->printPretty(Out, nullptr, Policy, Indentation);
739 Expr *Init = D->getInClassInitializer();
740 if (!Policy.SuppressInitializers && Init) {
741 if (D->getInClassInitStyle() == ICIS_ListInit)
745 Init->printPretty(Out, nullptr, Policy, Indentation);
747 prettyPrintAttributes(D);
750 void DeclPrinter::VisitLabelDecl(LabelDecl *D) {
754 void DeclPrinter::VisitVarDecl(VarDecl *D) {
755 prettyPrintPragmas(D);
757 QualType T = D->getTypeSourceInfo()
758 ? D->getTypeSourceInfo()->getType()
759 : D->getASTContext().getUnqualifiedObjCPointerType(D->getType());
761 if (!Policy.SuppressSpecifiers) {
762 StorageClass SC = D->getStorageClass();
764 Out << VarDecl::getStorageClassSpecifierString(SC) << " ";
766 switch (D->getTSCSpec()) {
767 case TSCS_unspecified:
772 case TSCS__Thread_local:
773 Out << "_Thread_local ";
775 case TSCS_thread_local:
776 Out << "thread_local ";
780 if (D->isModulePrivate())
781 Out << "__module_private__ ";
783 if (D->isConstexpr()) {
785 T.removeLocalConst();
789 printDeclType(T, D->getName());
790 Expr *Init = D->getInit();
791 if (!Policy.SuppressInitializers && Init) {
792 bool ImplicitInit = false;
793 if (CXXConstructExpr *Construct =
794 dyn_cast<CXXConstructExpr>(Init->IgnoreImplicit())) {
795 if (D->getInitStyle() == VarDecl::CallInit &&
796 !Construct->isListInitialization()) {
797 ImplicitInit = Construct->getNumArgs() == 0 ||
798 Construct->getArg(0)->isDefaultArgument();
802 if ((D->getInitStyle() == VarDecl::CallInit) && !isa<ParenListExpr>(Init))
804 else if (D->getInitStyle() == VarDecl::CInit) {
807 PrintingPolicy SubPolicy(Policy);
808 SubPolicy.SuppressSpecifiers = false;
809 SubPolicy.IncludeTagDefinition = false;
810 Init->printPretty(Out, nullptr, SubPolicy, Indentation);
811 if ((D->getInitStyle() == VarDecl::CallInit) && !isa<ParenListExpr>(Init))
815 prettyPrintAttributes(D);
818 void DeclPrinter::VisitParmVarDecl(ParmVarDecl *D) {
822 void DeclPrinter::VisitFileScopeAsmDecl(FileScopeAsmDecl *D) {
824 D->getAsmString()->printPretty(Out, nullptr, Policy, Indentation);
828 void DeclPrinter::VisitImportDecl(ImportDecl *D) {
829 Out << "@import " << D->getImportedModule()->getFullModuleName()
833 void DeclPrinter::VisitStaticAssertDecl(StaticAssertDecl *D) {
834 Out << "static_assert(";
835 D->getAssertExpr()->printPretty(Out, nullptr, Policy, Indentation);
836 if (StringLiteral *SL = D->getMessage()) {
838 SL->printPretty(Out, nullptr, Policy, Indentation);
843 //----------------------------------------------------------------------------
845 //----------------------------------------------------------------------------
846 void DeclPrinter::VisitNamespaceDecl(NamespaceDecl *D) {
849 Out << "namespace " << *D << " {\n";
854 void DeclPrinter::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
855 Out << "using namespace ";
856 if (D->getQualifier())
857 D->getQualifier()->print(Out, Policy);
858 Out << *D->getNominatedNamespaceAsWritten();
861 void DeclPrinter::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
862 Out << "namespace " << *D << " = ";
863 if (D->getQualifier())
864 D->getQualifier()->print(Out, Policy);
865 Out << *D->getAliasedNamespace();
868 void DeclPrinter::VisitEmptyDecl(EmptyDecl *D) {
869 prettyPrintAttributes(D);
872 void DeclPrinter::VisitCXXRecordDecl(CXXRecordDecl *D) {
873 // FIXME: add printing of pragma attributes if required.
874 if (!Policy.SuppressSpecifiers && D->isModulePrivate())
875 Out << "__module_private__ ";
876 Out << D->getKindName();
878 prettyPrintAttributes(D);
880 if (D->getIdentifier()) {
883 if (auto S = dyn_cast<ClassTemplatePartialSpecializationDecl>(D))
884 printTemplateArguments(S->getTemplateArgs(), S->getTemplateParameters());
885 else if (auto S = dyn_cast<ClassTemplateSpecializationDecl>(D))
886 printTemplateArguments(S->getTemplateArgs());
889 if (D->isCompleteDefinition()) {
890 // Print the base classes
891 if (D->getNumBases()) {
893 for (CXXRecordDecl::base_class_iterator Base = D->bases_begin(),
894 BaseEnd = D->bases_end(); Base != BaseEnd; ++Base) {
895 if (Base != D->bases_begin())
898 if (Base->isVirtual())
901 AccessSpecifier AS = Base->getAccessSpecifierAsWritten();
906 Out << Base->getType().getAsString(Policy);
908 if (Base->isPackExpansion())
913 // Print the class definition
914 // FIXME: Doesn't print access specifiers, e.g., "public:"
915 if (Policy.TerseOutput) {
925 void DeclPrinter::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
927 if (D->getLanguage() == LinkageSpecDecl::lang_c)
930 assert(D->getLanguage() == LinkageSpecDecl::lang_cxx &&
931 "unknown language in linkage specification");
935 Out << "extern \"" << l << "\" ";
936 if (D->hasBraces()) {
941 Visit(*D->decls_begin());
944 void DeclPrinter::printTemplateParameters(const TemplateParameterList *Params) {
949 for (unsigned i = 0, e = Params->size(); i != e; ++i) {
953 const Decl *Param = Params->getParam(i);
954 if (auto TTP = dyn_cast<TemplateTypeParmDecl>(Param)) {
956 if (TTP->wasDeclaredWithTypename())
961 if (TTP->isParameterPack())
966 if (TTP->hasDefaultArgument()) {
968 Out << TTP->getDefaultArgument().getAsString(Policy);
970 } else if (auto NTTP = dyn_cast<NonTypeTemplateParmDecl>(Param)) {
972 if (IdentifierInfo *II = NTTP->getIdentifier())
973 Name = II->getName();
974 printDeclType(NTTP->getType(), Name, NTTP->isParameterPack());
976 if (NTTP->hasDefaultArgument()) {
978 NTTP->getDefaultArgument()->printPretty(Out, nullptr, Policy,
981 } else if (auto TTPD = dyn_cast<TemplateTemplateParmDecl>(Param)) {
982 VisitTemplateDecl(TTPD);
983 // FIXME: print the default argument, if present.
990 void DeclPrinter::printTemplateArguments(const TemplateArgumentList &Args,
991 const TemplateParameterList *Params) {
993 for (size_t I = 0, E = Args.size(); I < E; ++I) {
994 const TemplateArgument &A = Args[I];
998 if (A.getKind() == TemplateArgument::Type)
999 if (auto T = A.getAsType()->getAs<TemplateTypeParmType>()) {
1000 auto P = cast<TemplateTypeParmDecl>(Params->getParam(T->getIndex()));
1004 if (A.getKind() == TemplateArgument::Template) {
1005 if (auto T = A.getAsTemplate().getAsTemplateDecl())
1006 if (auto TD = dyn_cast<TemplateTemplateParmDecl>(T)) {
1007 auto P = cast<TemplateTemplateParmDecl>(
1008 Params->getParam(TD->getIndex()));
1013 if (A.getKind() == TemplateArgument::Expression) {
1014 if (auto E = dyn_cast<DeclRefExpr>(A.getAsExpr()))
1015 if (auto N = dyn_cast<NonTypeTemplateParmDecl>(E->getDecl())) {
1016 auto P = cast<NonTypeTemplateParmDecl>(
1017 Params->getParam(N->getIndex()));
1023 A.print(Policy, Out);
1028 void DeclPrinter::VisitTemplateDecl(const TemplateDecl *D) {
1029 printTemplateParameters(D->getTemplateParameters());
1031 if (const TemplateTemplateParmDecl *TTP =
1032 dyn_cast<TemplateTemplateParmDecl>(D)) {
1034 if (TTP->isParameterPack())
1036 Out << D->getName();
1038 Visit(D->getTemplatedDecl());
1042 void DeclPrinter::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
1043 prettyPrintPragmas(D->getTemplatedDecl());
1044 VisitRedeclarableTemplateDecl(D);
1046 if (PrintInstantiation) {
1047 FunctionDecl *PrevDecl = D->getTemplatedDecl();
1048 const FunctionDecl *Def;
1049 if (PrevDecl->isDefined(Def) && Def != PrevDecl)
1051 for (auto *I : D->specializations())
1052 if (I->getTemplateSpecializationKind() == TSK_ImplicitInstantiation) {
1053 if (!PrevDecl->isThisDeclarationADefinition())
1056 prettyPrintPragmas(I);
1062 void DeclPrinter::VisitClassTemplateDecl(ClassTemplateDecl *D) {
1063 VisitRedeclarableTemplateDecl(D);
1065 if (PrintInstantiation) {
1066 for (auto *I : D->specializations())
1067 if (I->getSpecializationKind() == TSK_ImplicitInstantiation) {
1068 if (D->isThisDeclarationADefinition())
1076 void DeclPrinter::VisitClassTemplateSpecializationDecl(
1077 ClassTemplateSpecializationDecl *D) {
1078 Out << "template<> ";
1079 VisitCXXRecordDecl(D);
1082 void DeclPrinter::VisitClassTemplatePartialSpecializationDecl(
1083 ClassTemplatePartialSpecializationDecl *D) {
1084 printTemplateParameters(D->getTemplateParameters());
1085 VisitCXXRecordDecl(D);
1088 //----------------------------------------------------------------------------
1089 // Objective-C declarations
1090 //----------------------------------------------------------------------------
1092 void DeclPrinter::PrintObjCMethodType(ASTContext &Ctx,
1093 Decl::ObjCDeclQualifier Quals,
1096 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_In)
1098 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_Inout)
1100 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_Out)
1102 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_Bycopy)
1104 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_Byref)
1106 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_Oneway)
1108 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_CSNullability) {
1109 if (auto nullability = AttributedType::stripOuterNullability(T))
1110 Out << getNullabilitySpelling(*nullability, true) << ' ';
1113 Out << Ctx.getUnqualifiedObjCPointerType(T).getAsString(Policy);
1117 void DeclPrinter::PrintObjCTypeParams(ObjCTypeParamList *Params) {
1119 unsigned First = true;
1120 for (auto *Param : *Params) {
1127 switch (Param->getVariance()) {
1128 case ObjCTypeParamVariance::Invariant:
1131 case ObjCTypeParamVariance::Covariant:
1132 Out << "__covariant ";
1135 case ObjCTypeParamVariance::Contravariant:
1136 Out << "__contravariant ";
1140 Out << Param->getDeclName().getAsString();
1142 if (Param->hasExplicitBound()) {
1143 Out << " : " << Param->getUnderlyingType().getAsString(Policy);
1149 void DeclPrinter::VisitObjCMethodDecl(ObjCMethodDecl *OMD) {
1150 if (OMD->isInstanceMethod())
1154 if (!OMD->getReturnType().isNull()) {
1155 PrintObjCMethodType(OMD->getASTContext(), OMD->getObjCDeclQualifier(),
1156 OMD->getReturnType());
1159 std::string name = OMD->getSelector().getAsString();
1160 std::string::size_type pos, lastPos = 0;
1161 for (const auto *PI : OMD->parameters()) {
1162 // FIXME: selector is missing here!
1163 pos = name.find_first_of(':', lastPos);
1164 Out << " " << name.substr(lastPos, pos - lastPos) << ':';
1165 PrintObjCMethodType(OMD->getASTContext(),
1166 PI->getObjCDeclQualifier(),
1172 if (OMD->param_begin() == OMD->param_end())
1175 if (OMD->isVariadic())
1178 prettyPrintAttributes(OMD);
1180 if (OMD->getBody() && !Policy.TerseOutput) {
1182 OMD->getBody()->printPretty(Out, nullptr, Policy);
1184 else if (Policy.PolishForDeclaration)
1188 void DeclPrinter::VisitObjCImplementationDecl(ObjCImplementationDecl *OID) {
1189 std::string I = OID->getNameAsString();
1190 ObjCInterfaceDecl *SID = OID->getSuperClass();
1192 bool eolnOut = false;
1194 Out << "@implementation " << I << " : " << *SID;
1196 Out << "@implementation " << I;
1198 if (OID->ivar_size() > 0) {
1201 Indentation += Policy.Indentation;
1202 for (const auto *I : OID->ivars()) {
1203 Indent() << I->getASTContext().getUnqualifiedObjCPointerType(I->getType()).
1204 getAsString(Policy) << ' ' << *I << ";\n";
1206 Indentation -= Policy.Indentation;
1209 else if (SID || (OID->decls_begin() != OID->decls_end())) {
1213 VisitDeclContext(OID, false);
1219 void DeclPrinter::VisitObjCInterfaceDecl(ObjCInterfaceDecl *OID) {
1220 std::string I = OID->getNameAsString();
1221 ObjCInterfaceDecl *SID = OID->getSuperClass();
1223 if (!OID->isThisDeclarationADefinition()) {
1224 Out << "@class " << I;
1226 if (auto TypeParams = OID->getTypeParamListAsWritten()) {
1227 PrintObjCTypeParams(TypeParams);
1233 bool eolnOut = false;
1234 Out << "@interface " << I;
1236 if (auto TypeParams = OID->getTypeParamListAsWritten()) {
1237 PrintObjCTypeParams(TypeParams);
1241 Out << " : " << QualType(OID->getSuperClassType(), 0).getAsString(Policy);
1244 const ObjCList<ObjCProtocolDecl> &Protocols = OID->getReferencedProtocols();
1245 if (!Protocols.empty()) {
1246 for (ObjCList<ObjCProtocolDecl>::iterator I = Protocols.begin(),
1247 E = Protocols.end(); I != E; ++I)
1248 Out << (I == Protocols.begin() ? '<' : ',') << **I;
1252 if (OID->ivar_size() > 0) {
1255 Indentation += Policy.Indentation;
1256 for (const auto *I : OID->ivars()) {
1257 Indent() << I->getASTContext()
1258 .getUnqualifiedObjCPointerType(I->getType())
1259 .getAsString(Policy) << ' ' << *I << ";\n";
1261 Indentation -= Policy.Indentation;
1264 else if (SID || (OID->decls_begin() != OID->decls_end())) {
1269 VisitDeclContext(OID, false);
1273 // FIXME: implement the rest...
1276 void DeclPrinter::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
1277 if (!PID->isThisDeclarationADefinition()) {
1278 Out << "@protocol " << *PID << ";\n";
1282 const ObjCList<ObjCProtocolDecl> &Protocols = PID->getReferencedProtocols();
1283 if (!Protocols.empty()) {
1284 Out << "@protocol " << *PID;
1285 for (ObjCList<ObjCProtocolDecl>::iterator I = Protocols.begin(),
1286 E = Protocols.end(); I != E; ++I)
1287 Out << (I == Protocols.begin() ? '<' : ',') << **I;
1290 Out << "@protocol " << *PID << '\n';
1291 VisitDeclContext(PID, false);
1295 void DeclPrinter::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *PID) {
1296 Out << "@implementation " << *PID->getClassInterface() << '(' << *PID <<")\n";
1298 VisitDeclContext(PID, false);
1300 // FIXME: implement the rest...
1303 void DeclPrinter::VisitObjCCategoryDecl(ObjCCategoryDecl *PID) {
1304 Out << "@interface " << *PID->getClassInterface();
1305 if (auto TypeParams = PID->getTypeParamList()) {
1306 PrintObjCTypeParams(TypeParams);
1308 Out << "(" << *PID << ")\n";
1309 if (PID->ivar_size() > 0) {
1311 Indentation += Policy.Indentation;
1312 for (const auto *I : PID->ivars())
1313 Indent() << I->getASTContext().getUnqualifiedObjCPointerType(I->getType()).
1314 getAsString(Policy) << ' ' << *I << ";\n";
1315 Indentation -= Policy.Indentation;
1319 VisitDeclContext(PID, false);
1322 // FIXME: implement the rest...
1325 void DeclPrinter::VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *AID) {
1326 Out << "@compatibility_alias " << *AID
1327 << ' ' << *AID->getClassInterface() << ";\n";
1330 /// PrintObjCPropertyDecl - print a property declaration.
1332 void DeclPrinter::VisitObjCPropertyDecl(ObjCPropertyDecl *PDecl) {
1333 if (PDecl->getPropertyImplementation() == ObjCPropertyDecl::Required)
1334 Out << "@required\n";
1335 else if (PDecl->getPropertyImplementation() == ObjCPropertyDecl::Optional)
1336 Out << "@optional\n";
1338 QualType T = PDecl->getType();
1341 if (PDecl->getPropertyAttributes() != ObjCPropertyDecl::OBJC_PR_noattr) {
1344 if (PDecl->getPropertyAttributes() &
1345 ObjCPropertyDecl::OBJC_PR_readonly) {
1346 Out << (first ? ' ' : ',') << "readonly";
1350 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_getter) {
1351 Out << (first ? ' ' : ',') << "getter = ";
1352 PDecl->getGetterName().print(Out);
1355 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_setter) {
1356 Out << (first ? ' ' : ',') << "setter = ";
1357 PDecl->getSetterName().print(Out);
1361 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_assign) {
1362 Out << (first ? ' ' : ',') << "assign";
1366 if (PDecl->getPropertyAttributes() &
1367 ObjCPropertyDecl::OBJC_PR_readwrite) {
1368 Out << (first ? ' ' : ',') << "readwrite";
1372 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_retain) {
1373 Out << (first ? ' ' : ',') << "retain";
1377 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_strong) {
1378 Out << (first ? ' ' : ',') << "strong";
1382 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_copy) {
1383 Out << (first ? ' ' : ',') << "copy";
1387 if (PDecl->getPropertyAttributes() &
1388 ObjCPropertyDecl::OBJC_PR_nonatomic) {
1389 Out << (first ? ' ' : ',') << "nonatomic";
1392 if (PDecl->getPropertyAttributes() &
1393 ObjCPropertyDecl::OBJC_PR_atomic) {
1394 Out << (first ? ' ' : ',') << "atomic";
1398 if (PDecl->getPropertyAttributes() &
1399 ObjCPropertyDecl::OBJC_PR_nullability) {
1400 if (auto nullability = AttributedType::stripOuterNullability(T)) {
1401 if (*nullability == NullabilityKind::Unspecified &&
1402 (PDecl->getPropertyAttributes() &
1403 ObjCPropertyDecl::OBJC_PR_null_resettable)) {
1404 Out << (first ? ' ' : ',') << "null_resettable";
1406 Out << (first ? ' ' : ',')
1407 << getNullabilitySpelling(*nullability, true);
1413 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_class) {
1414 Out << (first ? ' ' : ',') << "class";
1418 (void) first; // Silence dead store warning due to idiomatic code.
1421 Out << ' ' << PDecl->getASTContext().getUnqualifiedObjCPointerType(T).
1422 getAsString(Policy) << ' ' << *PDecl;
1423 if (Policy.PolishForDeclaration)
1427 void DeclPrinter::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PID) {
1428 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize)
1429 Out << "@synthesize ";
1432 Out << *PID->getPropertyDecl();
1433 if (PID->getPropertyIvarDecl())
1434 Out << '=' << *PID->getPropertyIvarDecl();
1437 void DeclPrinter::VisitUsingDecl(UsingDecl *D) {
1438 if (!D->isAccessDeclaration())
1440 if (D->hasTypename())
1442 D->getQualifier()->print(Out, Policy);
1444 // Use the correct record name when the using declaration is used for
1445 // inheriting constructors.
1446 for (const auto *Shadow : D->shadows()) {
1447 if (const auto *ConstructorShadow =
1448 dyn_cast<ConstructorUsingShadowDecl>(Shadow)) {
1449 assert(Shadow->getDeclContext() == ConstructorShadow->getDeclContext());
1450 Out << *ConstructorShadow->getNominatedBaseClass();
1458 DeclPrinter::VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D) {
1459 Out << "using typename ";
1460 D->getQualifier()->print(Out, Policy);
1461 Out << D->getDeclName();
1464 void DeclPrinter::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
1465 if (!D->isAccessDeclaration())
1467 D->getQualifier()->print(Out, Policy);
1468 Out << D->getDeclName();
1471 void DeclPrinter::VisitUsingShadowDecl(UsingShadowDecl *D) {
1475 void DeclPrinter::VisitOMPThreadPrivateDecl(OMPThreadPrivateDecl *D) {
1476 Out << "#pragma omp threadprivate";
1477 if (!D->varlist_empty()) {
1478 for (OMPThreadPrivateDecl::varlist_iterator I = D->varlist_begin(),
1479 E = D->varlist_end();
1481 Out << (I == D->varlist_begin() ? '(' : ',');
1482 NamedDecl *ND = cast<NamedDecl>(cast<DeclRefExpr>(*I)->getDecl());
1483 ND->printQualifiedName(Out);
1489 void DeclPrinter::VisitOMPDeclareReductionDecl(OMPDeclareReductionDecl *D) {
1490 if (!D->isInvalidDecl()) {
1491 Out << "#pragma omp declare reduction (";
1492 if (D->getDeclName().getNameKind() == DeclarationName::CXXOperatorName) {
1493 static const char *const OperatorNames[NUM_OVERLOADED_OPERATORS] = {
1495 #define OVERLOADED_OPERATOR(Name, Spelling, Token, Unary, Binary, MemberOnly) \
1497 #include "clang/Basic/OperatorKinds.def"
1499 const char *OpName =
1500 OperatorNames[D->getDeclName().getCXXOverloadedOperator()];
1501 assert(OpName && "not an overloaded operator");
1504 assert(D->getDeclName().isIdentifier());
1508 D->getType().print(Out, Policy);
1510 D->getCombiner()->printPretty(Out, nullptr, Policy, 0);
1512 if (auto *Init = D->getInitializer()) {
1513 Out << " initializer(";
1514 Init->printPretty(Out, nullptr, Policy, 0);
1520 void DeclPrinter::VisitOMPCapturedExprDecl(OMPCapturedExprDecl *D) {
1521 D->getInit()->printPretty(Out, nullptr, Policy, Indentation);