1 //===--- DeclPrinter.cpp - Printing implementation for Decl ASTs ----------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 // This file implements the Decl::print method, which pretty prints the 10 // AST back out to C/Objective-C/C++/Objective-C++ code. 11 // 12 //===----------------------------------------------------------------------===// 13 #include "clang/AST/ASTContext.h" 14 #include "clang/AST/Attr.h" 15 #include "clang/AST/Decl.h" 16 #include "clang/AST/DeclCXX.h" 17 #include "clang/AST/DeclObjC.h" 18 #include "clang/AST/DeclTemplate.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; 26 27 namespace { 28 class DeclPrinter : public DeclVisitor<DeclPrinter> { 29 raw_ostream &Out; 30 PrintingPolicy Policy; 31 const ASTContext &Context; 32 unsigned Indentation; 33 bool PrintInstantiation; 34 35 raw_ostream& Indent() { return Indent(Indentation); } 36 raw_ostream& Indent(unsigned Indentation); 37 void ProcessDeclGroup(SmallVectorImpl<Decl*>& Decls); 38 39 void Print(AccessSpecifier AS); 40 void PrintConstructorInitializers(CXXConstructorDecl *CDecl, 41 std::string &Proto); 42 43 /// Print an Objective-C method type in parentheses. 44 /// 45 /// \param Quals The Objective-C declaration qualifiers. 46 /// \param T The type to print. 47 void PrintObjCMethodType(ASTContext &Ctx, Decl::ObjCDeclQualifier Quals, 48 QualType T); 49 50 void PrintObjCTypeParams(ObjCTypeParamList *Params); 51 52 public: 53 DeclPrinter(raw_ostream &Out, const PrintingPolicy &Policy, 54 const ASTContext &Context, unsigned Indentation = 0, 55 bool PrintInstantiation = false) 56 : Out(Out), Policy(Policy), Context(Context), Indentation(Indentation), 57 PrintInstantiation(PrintInstantiation) {} 58 59 void VisitDeclContext(DeclContext *DC, bool Indent = true); 60 61 void VisitTranslationUnitDecl(TranslationUnitDecl *D); 62 void VisitTypedefDecl(TypedefDecl *D); 63 void VisitTypeAliasDecl(TypeAliasDecl *D); 64 void VisitEnumDecl(EnumDecl *D); 65 void VisitRecordDecl(RecordDecl *D); 66 void VisitEnumConstantDecl(EnumConstantDecl *D); 67 void VisitEmptyDecl(EmptyDecl *D); 68 void VisitFunctionDecl(FunctionDecl *D); 69 void VisitFriendDecl(FriendDecl *D); 70 void VisitFieldDecl(FieldDecl *D); 71 void VisitVarDecl(VarDecl *D); 72 void VisitLabelDecl(LabelDecl *D); 73 void VisitParmVarDecl(ParmVarDecl *D); 74 void VisitFileScopeAsmDecl(FileScopeAsmDecl *D); 75 void VisitImportDecl(ImportDecl *D); 76 void VisitStaticAssertDecl(StaticAssertDecl *D); 77 void VisitNamespaceDecl(NamespaceDecl *D); 78 void VisitUsingDirectiveDecl(UsingDirectiveDecl *D); 79 void VisitNamespaceAliasDecl(NamespaceAliasDecl *D); 80 void VisitCXXRecordDecl(CXXRecordDecl *D); 81 void VisitLinkageSpecDecl(LinkageSpecDecl *D); 82 void VisitTemplateDecl(const TemplateDecl *D); 83 void VisitFunctionTemplateDecl(FunctionTemplateDecl *D); 84 void VisitClassTemplateDecl(ClassTemplateDecl *D); 85 void VisitClassTemplateSpecializationDecl( 86 ClassTemplateSpecializationDecl *D); 87 void VisitClassTemplatePartialSpecializationDecl( 88 ClassTemplatePartialSpecializationDecl *D); 89 void VisitObjCMethodDecl(ObjCMethodDecl *D); 90 void VisitObjCImplementationDecl(ObjCImplementationDecl *D); 91 void VisitObjCInterfaceDecl(ObjCInterfaceDecl *D); 92 void VisitObjCProtocolDecl(ObjCProtocolDecl *D); 93 void VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D); 94 void VisitObjCCategoryDecl(ObjCCategoryDecl *D); 95 void VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *D); 96 void VisitObjCPropertyDecl(ObjCPropertyDecl *D); 97 void VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *D); 98 void VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D); 99 void VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D); 100 void VisitUsingDecl(UsingDecl *D); 101 void VisitUsingShadowDecl(UsingShadowDecl *D); 102 void VisitOMPThreadPrivateDecl(OMPThreadPrivateDecl *D); 103 void VisitOMPAllocateDecl(OMPAllocateDecl *D); 104 void VisitOMPRequiresDecl(OMPRequiresDecl *D); 105 void VisitOMPDeclareReductionDecl(OMPDeclareReductionDecl *D); 106 void VisitOMPDeclareMapperDecl(OMPDeclareMapperDecl *D); 107 void VisitOMPCapturedExprDecl(OMPCapturedExprDecl *D); 108 109 void printTemplateParameters(const TemplateParameterList *Params, 110 bool OmitTemplateKW = false); 111 void printTemplateArguments(llvm::ArrayRef<TemplateArgument> Args); 112 void printTemplateArguments(llvm::ArrayRef<TemplateArgumentLoc> Args); 113 void prettyPrintAttributes(Decl *D); 114 void prettyPrintPragmas(Decl *D); 115 void printDeclType(QualType T, StringRef DeclName, bool Pack = false); 116 }; 117 } 118 119 void Decl::print(raw_ostream &Out, unsigned Indentation, 120 bool PrintInstantiation) const { 121 print(Out, getASTContext().getPrintingPolicy(), Indentation, PrintInstantiation); 122 } 123 124 void Decl::print(raw_ostream &Out, const PrintingPolicy &Policy, 125 unsigned Indentation, bool PrintInstantiation) const { 126 DeclPrinter Printer(Out, Policy, getASTContext(), Indentation, 127 PrintInstantiation); 128 Printer.Visit(const_cast<Decl*>(this)); 129 } 130 131 void TemplateParameterList::print(raw_ostream &Out, const ASTContext &Context, 132 bool OmitTemplateKW) const { 133 print(Out, Context, Context.getPrintingPolicy(), OmitTemplateKW); 134 } 135 136 void TemplateParameterList::print(raw_ostream &Out, const ASTContext &Context, 137 const PrintingPolicy &Policy, 138 bool OmitTemplateKW) const { 139 DeclPrinter Printer(Out, Policy, Context); 140 Printer.printTemplateParameters(this, OmitTemplateKW); 141 } 142 143 static QualType GetBaseType(QualType T) { 144 // FIXME: This should be on the Type class! 145 QualType BaseType = T; 146 while (!BaseType->isSpecifierType()) { 147 if (const PointerType *PTy = BaseType->getAs<PointerType>()) 148 BaseType = PTy->getPointeeType(); 149 else if (const BlockPointerType *BPy = BaseType->getAs<BlockPointerType>()) 150 BaseType = BPy->getPointeeType(); 151 else if (const ArrayType* ATy = dyn_cast<ArrayType>(BaseType)) 152 BaseType = ATy->getElementType(); 153 else if (const FunctionType* FTy = BaseType->getAs<FunctionType>()) 154 BaseType = FTy->getReturnType(); 155 else if (const VectorType *VTy = BaseType->getAs<VectorType>()) 156 BaseType = VTy->getElementType(); 157 else if (const ReferenceType *RTy = BaseType->getAs<ReferenceType>()) 158 BaseType = RTy->getPointeeType(); 159 else if (const AutoType *ATy = BaseType->getAs<AutoType>()) 160 BaseType = ATy->getDeducedType(); 161 else if (const ParenType *PTy = BaseType->getAs<ParenType>()) 162 BaseType = PTy->desugar(); 163 else 164 // This must be a syntax error. 165 break; 166 } 167 return BaseType; 168 } 169 170 static QualType getDeclType(Decl* D) { 171 if (TypedefNameDecl* TDD = dyn_cast<TypedefNameDecl>(D)) 172 return TDD->getUnderlyingType(); 173 if (ValueDecl* VD = dyn_cast<ValueDecl>(D)) 174 return VD->getType(); 175 return QualType(); 176 } 177 178 void Decl::printGroup(Decl** Begin, unsigned NumDecls, 179 raw_ostream &Out, const PrintingPolicy &Policy, 180 unsigned Indentation) { 181 if (NumDecls == 1) { 182 (*Begin)->print(Out, Policy, Indentation); 183 return; 184 } 185 186 Decl** End = Begin + NumDecls; 187 TagDecl* TD = dyn_cast<TagDecl>(*Begin); 188 if (TD) 189 ++Begin; 190 191 PrintingPolicy SubPolicy(Policy); 192 193 bool isFirst = true; 194 for ( ; Begin != End; ++Begin) { 195 if (isFirst) { 196 if(TD) 197 SubPolicy.IncludeTagDefinition = true; 198 SubPolicy.SuppressSpecifiers = false; 199 isFirst = false; 200 } else { 201 if (!isFirst) Out << ", "; 202 SubPolicy.IncludeTagDefinition = false; 203 SubPolicy.SuppressSpecifiers = true; 204 } 205 206 (*Begin)->print(Out, SubPolicy, Indentation); 207 } 208 } 209 210 LLVM_DUMP_METHOD void DeclContext::dumpDeclContext() const { 211 // Get the translation unit 212 const DeclContext *DC = this; 213 while (!DC->isTranslationUnit()) 214 DC = DC->getParent(); 215 216 ASTContext &Ctx = cast<TranslationUnitDecl>(DC)->getASTContext(); 217 DeclPrinter Printer(llvm::errs(), Ctx.getPrintingPolicy(), Ctx, 0); 218 Printer.VisitDeclContext(const_cast<DeclContext *>(this), /*Indent=*/false); 219 } 220 221 raw_ostream& DeclPrinter::Indent(unsigned Indentation) { 222 for (unsigned i = 0; i != Indentation; ++i) 223 Out << " "; 224 return Out; 225 } 226 227 void DeclPrinter::prettyPrintAttributes(Decl *D) { 228 if (Policy.PolishForDeclaration) 229 return; 230 231 if (D->hasAttrs()) { 232 AttrVec &Attrs = D->getAttrs(); 233 for (auto *A : Attrs) { 234 if (A->isInherited() || A->isImplicit()) 235 continue; 236 switch (A->getKind()) { 237 #define ATTR(X) 238 #define PRAGMA_SPELLING_ATTR(X) case attr::X: 239 #include "clang/Basic/AttrList.inc" 240 break; 241 default: 242 A->printPretty(Out, Policy); 243 break; 244 } 245 } 246 } 247 } 248 249 void DeclPrinter::prettyPrintPragmas(Decl *D) { 250 if (Policy.PolishForDeclaration) 251 return; 252 253 if (D->hasAttrs()) { 254 AttrVec &Attrs = D->getAttrs(); 255 for (auto *A : Attrs) { 256 switch (A->getKind()) { 257 #define ATTR(X) 258 #define PRAGMA_SPELLING_ATTR(X) case attr::X: 259 #include "clang/Basic/AttrList.inc" 260 A->printPretty(Out, Policy); 261 Indent(); 262 break; 263 default: 264 break; 265 } 266 } 267 } 268 } 269 270 void DeclPrinter::printDeclType(QualType T, StringRef DeclName, bool Pack) { 271 // Normally, a PackExpansionType is written as T[3]... (for instance, as a 272 // template argument), but if it is the type of a declaration, the ellipsis 273 // is placed before the name being declared. 274 if (auto *PET = T->getAs<PackExpansionType>()) { 275 Pack = true; 276 T = PET->getPattern(); 277 } 278 T.print(Out, Policy, (Pack ? "..." : "") + DeclName, Indentation); 279 } 280 281 void DeclPrinter::ProcessDeclGroup(SmallVectorImpl<Decl*>& Decls) { 282 this->Indent(); 283 Decl::printGroup(Decls.data(), Decls.size(), Out, Policy, Indentation); 284 Out << ";\n"; 285 Decls.clear(); 286 287 } 288 289 void DeclPrinter::Print(AccessSpecifier AS) { 290 switch(AS) { 291 case AS_none: llvm_unreachable("No access specifier!"); 292 case AS_public: Out << "public"; break; 293 case AS_protected: Out << "protected"; break; 294 case AS_private: Out << "private"; break; 295 } 296 } 297 298 void DeclPrinter::PrintConstructorInitializers(CXXConstructorDecl *CDecl, 299 std::string &Proto) { 300 bool HasInitializerList = false; 301 for (const auto *BMInitializer : CDecl->inits()) { 302 if (BMInitializer->isInClassMemberInitializer()) 303 continue; 304 305 if (!HasInitializerList) { 306 Proto += " : "; 307 Out << Proto; 308 Proto.clear(); 309 HasInitializerList = true; 310 } else 311 Out << ", "; 312 313 if (BMInitializer->isAnyMemberInitializer()) { 314 FieldDecl *FD = BMInitializer->getAnyMember(); 315 Out << *FD; 316 } else { 317 Out << QualType(BMInitializer->getBaseClass(), 0).getAsString(Policy); 318 } 319 320 Out << "("; 321 if (!BMInitializer->getInit()) { 322 // Nothing to print 323 } else { 324 Expr *Init = BMInitializer->getInit(); 325 if (ExprWithCleanups *Tmp = dyn_cast<ExprWithCleanups>(Init)) 326 Init = Tmp->getSubExpr(); 327 328 Init = Init->IgnoreParens(); 329 330 Expr *SimpleInit = nullptr; 331 Expr **Args = nullptr; 332 unsigned NumArgs = 0; 333 if (ParenListExpr *ParenList = dyn_cast<ParenListExpr>(Init)) { 334 Args = ParenList->getExprs(); 335 NumArgs = ParenList->getNumExprs(); 336 } else if (CXXConstructExpr *Construct = 337 dyn_cast<CXXConstructExpr>(Init)) { 338 Args = Construct->getArgs(); 339 NumArgs = Construct->getNumArgs(); 340 } else 341 SimpleInit = Init; 342 343 if (SimpleInit) 344 SimpleInit->printPretty(Out, nullptr, Policy, Indentation); 345 else { 346 for (unsigned I = 0; I != NumArgs; ++I) { 347 assert(Args[I] != nullptr && "Expected non-null Expr"); 348 if (isa<CXXDefaultArgExpr>(Args[I])) 349 break; 350 351 if (I) 352 Out << ", "; 353 Args[I]->printPretty(Out, nullptr, Policy, Indentation); 354 } 355 } 356 } 357 Out << ")"; 358 if (BMInitializer->isPackExpansion()) 359 Out << "..."; 360 } 361 } 362 363 //---------------------------------------------------------------------------- 364 // Common C declarations 365 //---------------------------------------------------------------------------- 366 367 void DeclPrinter::VisitDeclContext(DeclContext *DC, bool Indent) { 368 if (Policy.TerseOutput) 369 return; 370 371 if (Indent) 372 Indentation += Policy.Indentation; 373 374 SmallVector<Decl*, 2> Decls; 375 for (DeclContext::decl_iterator D = DC->decls_begin(), DEnd = DC->decls_end(); 376 D != DEnd; ++D) { 377 378 // Don't print ObjCIvarDecls, as they are printed when visiting the 379 // containing ObjCInterfaceDecl. 380 if (isa<ObjCIvarDecl>(*D)) 381 continue; 382 383 // Skip over implicit declarations in pretty-printing mode. 384 if (D->isImplicit()) 385 continue; 386 387 // Don't print implicit specializations, as they are printed when visiting 388 // corresponding templates. 389 if (auto FD = dyn_cast<FunctionDecl>(*D)) 390 if (FD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation && 391 !isa<ClassTemplateSpecializationDecl>(DC)) 392 continue; 393 394 // The next bits of code handle stuff like "struct {int x;} a,b"; we're 395 // forced to merge the declarations because there's no other way to 396 // refer to the struct in question. When that struct is named instead, we 397 // also need to merge to avoid splitting off a stand-alone struct 398 // declaration that produces the warning ext_no_declarators in some 399 // contexts. 400 // 401 // This limited merging is safe without a bunch of other checks because it 402 // only merges declarations directly referring to the tag, not typedefs. 403 // 404 // Check whether the current declaration should be grouped with a previous 405 // non-free-standing tag declaration. 406 QualType CurDeclType = getDeclType(*D); 407 if (!Decls.empty() && !CurDeclType.isNull()) { 408 QualType BaseType = GetBaseType(CurDeclType); 409 if (!BaseType.isNull() && isa<ElaboratedType>(BaseType) && 410 cast<ElaboratedType>(BaseType)->getOwnedTagDecl() == Decls[0]) { 411 Decls.push_back(*D); 412 continue; 413 } 414 } 415 416 // If we have a merged group waiting to be handled, handle it now. 417 if (!Decls.empty()) 418 ProcessDeclGroup(Decls); 419 420 // If the current declaration is not a free standing declaration, save it 421 // so we can merge it with the subsequent declaration(s) using it. 422 if (isa<TagDecl>(*D) && !cast<TagDecl>(*D)->isFreeStanding()) { 423 Decls.push_back(*D); 424 continue; 425 } 426 427 if (isa<AccessSpecDecl>(*D)) { 428 Indentation -= Policy.Indentation; 429 this->Indent(); 430 Print(D->getAccess()); 431 Out << ":\n"; 432 Indentation += Policy.Indentation; 433 continue; 434 } 435 436 this->Indent(); 437 Visit(*D); 438 439 // FIXME: Need to be able to tell the DeclPrinter when 440 const char *Terminator = nullptr; 441 if (isa<OMPThreadPrivateDecl>(*D) || isa<OMPDeclareReductionDecl>(*D) || 442 isa<OMPDeclareMapperDecl>(*D) || isa<OMPRequiresDecl>(*D) || 443 isa<OMPAllocateDecl>(*D)) 444 Terminator = nullptr; 445 else if (isa<ObjCMethodDecl>(*D) && cast<ObjCMethodDecl>(*D)->hasBody()) 446 Terminator = nullptr; 447 else if (auto FD = dyn_cast<FunctionDecl>(*D)) { 448 if (FD->isThisDeclarationADefinition()) 449 Terminator = nullptr; 450 else 451 Terminator = ";"; 452 } else if (auto TD = dyn_cast<FunctionTemplateDecl>(*D)) { 453 if (TD->getTemplatedDecl()->isThisDeclarationADefinition()) 454 Terminator = nullptr; 455 else 456 Terminator = ";"; 457 } else if (isa<NamespaceDecl>(*D) || isa<LinkageSpecDecl>(*D) || 458 isa<ObjCImplementationDecl>(*D) || 459 isa<ObjCInterfaceDecl>(*D) || 460 isa<ObjCProtocolDecl>(*D) || 461 isa<ObjCCategoryImplDecl>(*D) || 462 isa<ObjCCategoryDecl>(*D)) 463 Terminator = nullptr; 464 else if (isa<EnumConstantDecl>(*D)) { 465 DeclContext::decl_iterator Next = D; 466 ++Next; 467 if (Next != DEnd) 468 Terminator = ","; 469 } else 470 Terminator = ";"; 471 472 if (Terminator) 473 Out << Terminator; 474 if (!Policy.TerseOutput && 475 ((isa<FunctionDecl>(*D) && 476 cast<FunctionDecl>(*D)->doesThisDeclarationHaveABody()) || 477 (isa<FunctionTemplateDecl>(*D) && 478 cast<FunctionTemplateDecl>(*D)->getTemplatedDecl()->doesThisDeclarationHaveABody()))) 479 ; // StmtPrinter already added '\n' after CompoundStmt. 480 else 481 Out << "\n"; 482 483 // Declare target attribute is special one, natural spelling for the pragma 484 // assumes "ending" construct so print it here. 485 if (D->hasAttr<OMPDeclareTargetDeclAttr>()) 486 Out << "#pragma omp end declare target\n"; 487 } 488 489 if (!Decls.empty()) 490 ProcessDeclGroup(Decls); 491 492 if (Indent) 493 Indentation -= Policy.Indentation; 494 } 495 496 void DeclPrinter::VisitTranslationUnitDecl(TranslationUnitDecl *D) { 497 VisitDeclContext(D, false); 498 } 499 500 void DeclPrinter::VisitTypedefDecl(TypedefDecl *D) { 501 if (!Policy.SuppressSpecifiers) { 502 Out << "typedef "; 503 504 if (D->isModulePrivate()) 505 Out << "__module_private__ "; 506 } 507 QualType Ty = D->getTypeSourceInfo()->getType(); 508 Ty.print(Out, Policy, D->getName(), Indentation); 509 prettyPrintAttributes(D); 510 } 511 512 void DeclPrinter::VisitTypeAliasDecl(TypeAliasDecl *D) { 513 Out << "using " << *D; 514 prettyPrintAttributes(D); 515 Out << " = " << D->getTypeSourceInfo()->getType().getAsString(Policy); 516 } 517 518 void DeclPrinter::VisitEnumDecl(EnumDecl *D) { 519 if (!Policy.SuppressSpecifiers && D->isModulePrivate()) 520 Out << "__module_private__ "; 521 Out << "enum"; 522 if (D->isScoped()) { 523 if (D->isScopedUsingClassTag()) 524 Out << " class"; 525 else 526 Out << " struct"; 527 } 528 529 prettyPrintAttributes(D); 530 531 Out << ' ' << *D; 532 533 if (D->isFixed() && D->getASTContext().getLangOpts().CPlusPlus11) 534 Out << " : " << D->getIntegerType().stream(Policy); 535 536 if (D->isCompleteDefinition()) { 537 Out << " {\n"; 538 VisitDeclContext(D); 539 Indent() << "}"; 540 } 541 } 542 543 void DeclPrinter::VisitRecordDecl(RecordDecl *D) { 544 if (!Policy.SuppressSpecifiers && D->isModulePrivate()) 545 Out << "__module_private__ "; 546 Out << D->getKindName(); 547 548 prettyPrintAttributes(D); 549 550 if (D->getIdentifier()) 551 Out << ' ' << *D; 552 553 if (D->isCompleteDefinition()) { 554 Out << " {\n"; 555 VisitDeclContext(D); 556 Indent() << "}"; 557 } 558 } 559 560 void DeclPrinter::VisitEnumConstantDecl(EnumConstantDecl *D) { 561 Out << *D; 562 prettyPrintAttributes(D); 563 if (Expr *Init = D->getInitExpr()) { 564 Out << " = "; 565 Init->printPretty(Out, nullptr, Policy, Indentation, "\n", &Context); 566 } 567 } 568 569 static void printExplicitSpecifier(ExplicitSpecifier ES, llvm::raw_ostream &Out, 570 PrintingPolicy &Policy, 571 unsigned Indentation) { 572 std::string Proto = "explicit"; 573 llvm::raw_string_ostream EOut(Proto); 574 if (ES.getExpr()) { 575 EOut << "("; 576 ES.getExpr()->printPretty(EOut, nullptr, Policy, Indentation); 577 EOut << ")"; 578 } 579 EOut << " "; 580 EOut.flush(); 581 Out << EOut.str(); 582 } 583 584 void DeclPrinter::VisitFunctionDecl(FunctionDecl *D) { 585 if (!D->getDescribedFunctionTemplate() && 586 !D->isFunctionTemplateSpecialization()) 587 prettyPrintPragmas(D); 588 589 if (D->isFunctionTemplateSpecialization()) 590 Out << "template<> "; 591 else if (!D->getDescribedFunctionTemplate()) { 592 for (unsigned I = 0, NumTemplateParams = D->getNumTemplateParameterLists(); 593 I < NumTemplateParams; ++I) 594 printTemplateParameters(D->getTemplateParameterList(I)); 595 } 596 597 CXXConstructorDecl *CDecl = dyn_cast<CXXConstructorDecl>(D); 598 CXXConversionDecl *ConversionDecl = dyn_cast<CXXConversionDecl>(D); 599 CXXDeductionGuideDecl *GuideDecl = dyn_cast<CXXDeductionGuideDecl>(D); 600 if (!Policy.SuppressSpecifiers) { 601 switch (D->getStorageClass()) { 602 case SC_None: break; 603 case SC_Extern: Out << "extern "; break; 604 case SC_Static: Out << "static "; break; 605 case SC_PrivateExtern: Out << "__private_extern__ "; break; 606 case SC_Auto: case SC_Register: 607 llvm_unreachable("invalid for functions"); 608 } 609 610 if (D->isInlineSpecified()) Out << "inline "; 611 if (D->isVirtualAsWritten()) Out << "virtual "; 612 if (D->isModulePrivate()) Out << "__module_private__ "; 613 if (D->isConstexprSpecified() && !D->isExplicitlyDefaulted()) 614 Out << "constexpr "; 615 if (D->isConsteval()) Out << "consteval "; 616 ExplicitSpecifier ExplicitSpec = ExplicitSpecifier::getFromDecl(D); 617 if (ExplicitSpec.isSpecified()) 618 printExplicitSpecifier(ExplicitSpec, Out, Policy, Indentation); 619 } 620 621 PrintingPolicy SubPolicy(Policy); 622 SubPolicy.SuppressSpecifiers = false; 623 std::string Proto; 624 625 if (Policy.FullyQualifiedName) { 626 Proto += D->getQualifiedNameAsString(); 627 } else { 628 llvm::raw_string_ostream OS(Proto); 629 if (!Policy.SuppressScope) { 630 if (const NestedNameSpecifier *NS = D->getQualifier()) { 631 NS->print(OS, Policy); 632 } 633 } 634 D->getNameInfo().printName(OS, Policy); 635 } 636 637 if (GuideDecl) 638 Proto = GuideDecl->getDeducedTemplate()->getDeclName().getAsString(); 639 if (D->isFunctionTemplateSpecialization()) { 640 llvm::raw_string_ostream POut(Proto); 641 DeclPrinter TArgPrinter(POut, SubPolicy, Context, Indentation); 642 const auto *TArgAsWritten = D->getTemplateSpecializationArgsAsWritten(); 643 if (TArgAsWritten && !Policy.PrintCanonicalTypes) 644 TArgPrinter.printTemplateArguments(TArgAsWritten->arguments()); 645 else if (const TemplateArgumentList *TArgs = 646 D->getTemplateSpecializationArgs()) 647 TArgPrinter.printTemplateArguments(TArgs->asArray()); 648 } 649 650 QualType Ty = D->getType(); 651 while (const ParenType *PT = dyn_cast<ParenType>(Ty)) { 652 Proto = '(' + Proto + ')'; 653 Ty = PT->getInnerType(); 654 } 655 656 if (const FunctionType *AFT = Ty->getAs<FunctionType>()) { 657 const FunctionProtoType *FT = nullptr; 658 if (D->hasWrittenPrototype()) 659 FT = dyn_cast<FunctionProtoType>(AFT); 660 661 Proto += "("; 662 if (FT) { 663 llvm::raw_string_ostream POut(Proto); 664 DeclPrinter ParamPrinter(POut, SubPolicy, Context, Indentation); 665 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) { 666 if (i) POut << ", "; 667 ParamPrinter.VisitParmVarDecl(D->getParamDecl(i)); 668 } 669 670 if (FT->isVariadic()) { 671 if (D->getNumParams()) POut << ", "; 672 POut << "..."; 673 } 674 } else if (D->doesThisDeclarationHaveABody() && !D->hasPrototype()) { 675 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) { 676 if (i) 677 Proto += ", "; 678 Proto += D->getParamDecl(i)->getNameAsString(); 679 } 680 } 681 682 Proto += ")"; 683 684 if (FT) { 685 if (FT->isConst()) 686 Proto += " const"; 687 if (FT->isVolatile()) 688 Proto += " volatile"; 689 if (FT->isRestrict()) 690 Proto += " restrict"; 691 692 switch (FT->getRefQualifier()) { 693 case RQ_None: 694 break; 695 case RQ_LValue: 696 Proto += " &"; 697 break; 698 case RQ_RValue: 699 Proto += " &&"; 700 break; 701 } 702 } 703 704 if (FT && FT->hasDynamicExceptionSpec()) { 705 Proto += " throw("; 706 if (FT->getExceptionSpecType() == EST_MSAny) 707 Proto += "..."; 708 else 709 for (unsigned I = 0, N = FT->getNumExceptions(); I != N; ++I) { 710 if (I) 711 Proto += ", "; 712 713 Proto += FT->getExceptionType(I).getAsString(SubPolicy); 714 } 715 Proto += ")"; 716 } else if (FT && isNoexceptExceptionSpec(FT->getExceptionSpecType())) { 717 Proto += " noexcept"; 718 if (isComputedNoexcept(FT->getExceptionSpecType())) { 719 Proto += "("; 720 llvm::raw_string_ostream EOut(Proto); 721 FT->getNoexceptExpr()->printPretty(EOut, nullptr, SubPolicy, 722 Indentation); 723 EOut.flush(); 724 Proto += EOut.str(); 725 Proto += ")"; 726 } 727 } 728 729 if (CDecl) { 730 if (!Policy.TerseOutput) 731 PrintConstructorInitializers(CDecl, Proto); 732 } else if (!ConversionDecl && !isa<CXXDestructorDecl>(D)) { 733 if (FT && FT->hasTrailingReturn()) { 734 if (!GuideDecl) 735 Out << "auto "; 736 Out << Proto << " -> "; 737 Proto.clear(); 738 } 739 AFT->getReturnType().print(Out, Policy, Proto); 740 Proto.clear(); 741 } 742 Out << Proto; 743 744 if (Expr *TrailingRequiresClause = D->getTrailingRequiresClause()) { 745 Out << " requires "; 746 TrailingRequiresClause->printPretty(Out, nullptr, SubPolicy, Indentation); 747 } 748 } else { 749 Ty.print(Out, Policy, Proto); 750 } 751 752 prettyPrintAttributes(D); 753 754 if (D->isPure()) 755 Out << " = 0"; 756 else if (D->isDeletedAsWritten()) 757 Out << " = delete"; 758 else if (D->isExplicitlyDefaulted()) 759 Out << " = default"; 760 else if (D->doesThisDeclarationHaveABody()) { 761 if (!Policy.TerseOutput) { 762 if (!D->hasPrototype() && D->getNumParams()) { 763 // This is a K&R function definition, so we need to print the 764 // parameters. 765 Out << '\n'; 766 DeclPrinter ParamPrinter(Out, SubPolicy, Context, Indentation); 767 Indentation += Policy.Indentation; 768 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) { 769 Indent(); 770 ParamPrinter.VisitParmVarDecl(D->getParamDecl(i)); 771 Out << ";\n"; 772 } 773 Indentation -= Policy.Indentation; 774 } else 775 Out << ' '; 776 777 if (D->getBody()) 778 D->getBody()->printPretty(Out, nullptr, SubPolicy, Indentation); 779 } else { 780 if (!Policy.TerseOutput && isa<CXXConstructorDecl>(*D)) 781 Out << " {}"; 782 } 783 } 784 } 785 786 void DeclPrinter::VisitFriendDecl(FriendDecl *D) { 787 if (TypeSourceInfo *TSI = D->getFriendType()) { 788 unsigned NumTPLists = D->getFriendTypeNumTemplateParameterLists(); 789 for (unsigned i = 0; i < NumTPLists; ++i) 790 printTemplateParameters(D->getFriendTypeTemplateParameterList(i)); 791 Out << "friend "; 792 Out << " " << TSI->getType().getAsString(Policy); 793 } 794 else if (FunctionDecl *FD = 795 dyn_cast<FunctionDecl>(D->getFriendDecl())) { 796 Out << "friend "; 797 VisitFunctionDecl(FD); 798 } 799 else if (FunctionTemplateDecl *FTD = 800 dyn_cast<FunctionTemplateDecl>(D->getFriendDecl())) { 801 Out << "friend "; 802 VisitFunctionTemplateDecl(FTD); 803 } 804 else if (ClassTemplateDecl *CTD = 805 dyn_cast<ClassTemplateDecl>(D->getFriendDecl())) { 806 Out << "friend "; 807 VisitRedeclarableTemplateDecl(CTD); 808 } 809 } 810 811 void DeclPrinter::VisitFieldDecl(FieldDecl *D) { 812 // FIXME: add printing of pragma attributes if required. 813 if (!Policy.SuppressSpecifiers && D->isMutable()) 814 Out << "mutable "; 815 if (!Policy.SuppressSpecifiers && D->isModulePrivate()) 816 Out << "__module_private__ "; 817 818 Out << D->getASTContext().getUnqualifiedObjCPointerType(D->getType()). 819 stream(Policy, D->getName(), Indentation); 820 821 if (D->isBitField()) { 822 Out << " : "; 823 D->getBitWidth()->printPretty(Out, nullptr, Policy, Indentation); 824 } 825 826 Expr *Init = D->getInClassInitializer(); 827 if (!Policy.SuppressInitializers && Init) { 828 if (D->getInClassInitStyle() == ICIS_ListInit) 829 Out << " "; 830 else 831 Out << " = "; 832 Init->printPretty(Out, nullptr, Policy, Indentation); 833 } 834 prettyPrintAttributes(D); 835 } 836 837 void DeclPrinter::VisitLabelDecl(LabelDecl *D) { 838 Out << *D << ":"; 839 } 840 841 void DeclPrinter::VisitVarDecl(VarDecl *D) { 842 prettyPrintPragmas(D); 843 844 QualType T = D->getTypeSourceInfo() 845 ? D->getTypeSourceInfo()->getType() 846 : D->getASTContext().getUnqualifiedObjCPointerType(D->getType()); 847 848 if (!Policy.SuppressSpecifiers) { 849 StorageClass SC = D->getStorageClass(); 850 if (SC != SC_None) 851 Out << VarDecl::getStorageClassSpecifierString(SC) << " "; 852 853 switch (D->getTSCSpec()) { 854 case TSCS_unspecified: 855 break; 856 case TSCS___thread: 857 Out << "__thread "; 858 break; 859 case TSCS__Thread_local: 860 Out << "_Thread_local "; 861 break; 862 case TSCS_thread_local: 863 Out << "thread_local "; 864 break; 865 } 866 867 if (D->isModulePrivate()) 868 Out << "__module_private__ "; 869 870 if (D->isConstexpr()) { 871 Out << "constexpr "; 872 T.removeLocalConst(); 873 } 874 } 875 876 printDeclType(T, D->getName()); 877 Expr *Init = D->getInit(); 878 if (!Policy.SuppressInitializers && Init) { 879 bool ImplicitInit = false; 880 if (CXXConstructExpr *Construct = 881 dyn_cast<CXXConstructExpr>(Init->IgnoreImplicit())) { 882 if (D->getInitStyle() == VarDecl::CallInit && 883 !Construct->isListInitialization()) { 884 ImplicitInit = Construct->getNumArgs() == 0 || 885 Construct->getArg(0)->isDefaultArgument(); 886 } 887 } 888 if (!ImplicitInit) { 889 if ((D->getInitStyle() == VarDecl::CallInit) && !isa<ParenListExpr>(Init)) 890 Out << "("; 891 else if (D->getInitStyle() == VarDecl::CInit) { 892 Out << " = "; 893 } 894 PrintingPolicy SubPolicy(Policy); 895 SubPolicy.SuppressSpecifiers = false; 896 SubPolicy.IncludeTagDefinition = false; 897 Init->printPretty(Out, nullptr, SubPolicy, Indentation); 898 if ((D->getInitStyle() == VarDecl::CallInit) && !isa<ParenListExpr>(Init)) 899 Out << ")"; 900 } 901 } 902 prettyPrintAttributes(D); 903 } 904 905 void DeclPrinter::VisitParmVarDecl(ParmVarDecl *D) { 906 VisitVarDecl(D); 907 } 908 909 void DeclPrinter::VisitFileScopeAsmDecl(FileScopeAsmDecl *D) { 910 Out << "__asm ("; 911 D->getAsmString()->printPretty(Out, nullptr, Policy, Indentation); 912 Out << ")"; 913 } 914 915 void DeclPrinter::VisitImportDecl(ImportDecl *D) { 916 Out << "@import " << D->getImportedModule()->getFullModuleName() 917 << ";\n"; 918 } 919 920 void DeclPrinter::VisitStaticAssertDecl(StaticAssertDecl *D) { 921 Out << "static_assert("; 922 D->getAssertExpr()->printPretty(Out, nullptr, Policy, Indentation); 923 if (StringLiteral *SL = D->getMessage()) { 924 Out << ", "; 925 SL->printPretty(Out, nullptr, Policy, Indentation); 926 } 927 Out << ")"; 928 } 929 930 //---------------------------------------------------------------------------- 931 // C++ declarations 932 //---------------------------------------------------------------------------- 933 void DeclPrinter::VisitNamespaceDecl(NamespaceDecl *D) { 934 if (D->isInline()) 935 Out << "inline "; 936 Out << "namespace " << *D << " {\n"; 937 VisitDeclContext(D); 938 Indent() << "}"; 939 } 940 941 void DeclPrinter::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) { 942 Out << "using namespace "; 943 if (D->getQualifier()) 944 D->getQualifier()->print(Out, Policy); 945 Out << *D->getNominatedNamespaceAsWritten(); 946 } 947 948 void DeclPrinter::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) { 949 Out << "namespace " << *D << " = "; 950 if (D->getQualifier()) 951 D->getQualifier()->print(Out, Policy); 952 Out << *D->getAliasedNamespace(); 953 } 954 955 void DeclPrinter::VisitEmptyDecl(EmptyDecl *D) { 956 prettyPrintAttributes(D); 957 } 958 959 void DeclPrinter::VisitCXXRecordDecl(CXXRecordDecl *D) { 960 // FIXME: add printing of pragma attributes if required. 961 if (!Policy.SuppressSpecifiers && D->isModulePrivate()) 962 Out << "__module_private__ "; 963 Out << D->getKindName(); 964 965 prettyPrintAttributes(D); 966 967 if (D->getIdentifier()) { 968 Out << ' ' << *D; 969 970 if (auto S = dyn_cast<ClassTemplateSpecializationDecl>(D)) { 971 ArrayRef<TemplateArgument> Args = S->getTemplateArgs().asArray(); 972 if (!Policy.PrintCanonicalTypes) 973 if (const auto* TSI = S->getTypeAsWritten()) 974 if (const auto *TST = 975 dyn_cast<TemplateSpecializationType>(TSI->getType())) 976 Args = TST->template_arguments(); 977 printTemplateArguments(Args); 978 } 979 } 980 981 if (D->isCompleteDefinition()) { 982 // Print the base classes 983 if (D->getNumBases()) { 984 Out << " : "; 985 for (CXXRecordDecl::base_class_iterator Base = D->bases_begin(), 986 BaseEnd = D->bases_end(); Base != BaseEnd; ++Base) { 987 if (Base != D->bases_begin()) 988 Out << ", "; 989 990 if (Base->isVirtual()) 991 Out << "virtual "; 992 993 AccessSpecifier AS = Base->getAccessSpecifierAsWritten(); 994 if (AS != AS_none) { 995 Print(AS); 996 Out << " "; 997 } 998 Out << Base->getType().getAsString(Policy); 999 1000 if (Base->isPackExpansion()) 1001 Out << "..."; 1002 } 1003 } 1004 1005 // Print the class definition 1006 // FIXME: Doesn't print access specifiers, e.g., "public:" 1007 if (Policy.TerseOutput) { 1008 Out << " {}"; 1009 } else { 1010 Out << " {\n"; 1011 VisitDeclContext(D); 1012 Indent() << "}"; 1013 } 1014 } 1015 } 1016 1017 void DeclPrinter::VisitLinkageSpecDecl(LinkageSpecDecl *D) { 1018 const char *l; 1019 if (D->getLanguage() == LinkageSpecDecl::lang_c) 1020 l = "C"; 1021 else { 1022 assert(D->getLanguage() == LinkageSpecDecl::lang_cxx && 1023 "unknown language in linkage specification"); 1024 l = "C++"; 1025 } 1026 1027 Out << "extern \"" << l << "\" "; 1028 if (D->hasBraces()) { 1029 Out << "{\n"; 1030 VisitDeclContext(D); 1031 Indent() << "}"; 1032 } else 1033 Visit(*D->decls_begin()); 1034 } 1035 1036 void DeclPrinter::printTemplateParameters(const TemplateParameterList *Params, 1037 bool OmitTemplateKW) { 1038 assert(Params); 1039 1040 if (!OmitTemplateKW) 1041 Out << "template "; 1042 Out << '<'; 1043 1044 bool NeedComma = false; 1045 for (const Decl *Param : *Params) { 1046 if (Param->isImplicit()) 1047 continue; 1048 1049 if (NeedComma) 1050 Out << ", "; 1051 else 1052 NeedComma = true; 1053 1054 if (auto TTP = dyn_cast<TemplateTypeParmDecl>(Param)) { 1055 1056 if (const TypeConstraint *TC = TTP->getTypeConstraint()) 1057 TC->print(Out, Policy); 1058 else if (TTP->wasDeclaredWithTypename()) 1059 Out << "typename"; 1060 else 1061 Out << "class"; 1062 1063 if (TTP->isParameterPack()) 1064 Out << " ..."; 1065 else if (!TTP->getName().empty()) 1066 Out << ' '; 1067 1068 Out << *TTP; 1069 1070 if (TTP->hasDefaultArgument()) { 1071 Out << " = "; 1072 Out << TTP->getDefaultArgument().getAsString(Policy); 1073 }; 1074 } else if (auto NTTP = dyn_cast<NonTypeTemplateParmDecl>(Param)) { 1075 StringRef Name; 1076 if (IdentifierInfo *II = NTTP->getIdentifier()) 1077 Name = II->getName(); 1078 printDeclType(NTTP->getType(), Name, NTTP->isParameterPack()); 1079 1080 if (NTTP->hasDefaultArgument()) { 1081 Out << " = "; 1082 NTTP->getDefaultArgument()->printPretty(Out, nullptr, Policy, 1083 Indentation); 1084 } 1085 } else if (auto TTPD = dyn_cast<TemplateTemplateParmDecl>(Param)) { 1086 VisitTemplateDecl(TTPD); 1087 // FIXME: print the default argument, if present. 1088 } 1089 } 1090 1091 Out << '>'; 1092 if (!OmitTemplateKW) 1093 Out << ' '; 1094 } 1095 1096 void DeclPrinter::printTemplateArguments(ArrayRef<TemplateArgument> Args) { 1097 Out << "<"; 1098 for (size_t I = 0, E = Args.size(); I < E; ++I) { 1099 if (I) 1100 Out << ", "; 1101 Args[I].print(Policy, Out); 1102 } 1103 Out << ">"; 1104 } 1105 1106 void DeclPrinter::printTemplateArguments(ArrayRef<TemplateArgumentLoc> Args) { 1107 Out << "<"; 1108 for (size_t I = 0, E = Args.size(); I < E; ++I) { 1109 if (I) 1110 Out << ", "; 1111 Args[I].getArgument().print(Policy, Out); 1112 } 1113 Out << ">"; 1114 } 1115 1116 void DeclPrinter::VisitTemplateDecl(const TemplateDecl *D) { 1117 printTemplateParameters(D->getTemplateParameters()); 1118 1119 if (const TemplateTemplateParmDecl *TTP = 1120 dyn_cast<TemplateTemplateParmDecl>(D)) { 1121 Out << "class "; 1122 if (TTP->isParameterPack()) 1123 Out << "..."; 1124 Out << D->getName(); 1125 } else if (auto *TD = D->getTemplatedDecl()) 1126 Visit(TD); 1127 else if (const auto *Concept = dyn_cast<ConceptDecl>(D)) { 1128 Out << "concept " << Concept->getName() << " = " ; 1129 Concept->getConstraintExpr()->printPretty(Out, nullptr, Policy, 1130 Indentation); 1131 Out << ";"; 1132 } 1133 } 1134 1135 void DeclPrinter::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) { 1136 prettyPrintPragmas(D->getTemplatedDecl()); 1137 // Print any leading template parameter lists. 1138 if (const FunctionDecl *FD = D->getTemplatedDecl()) { 1139 for (unsigned I = 0, NumTemplateParams = FD->getNumTemplateParameterLists(); 1140 I < NumTemplateParams; ++I) 1141 printTemplateParameters(FD->getTemplateParameterList(I)); 1142 } 1143 VisitRedeclarableTemplateDecl(D); 1144 // Declare target attribute is special one, natural spelling for the pragma 1145 // assumes "ending" construct so print it here. 1146 if (D->getTemplatedDecl()->hasAttr<OMPDeclareTargetDeclAttr>()) 1147 Out << "#pragma omp end declare target\n"; 1148 1149 // Never print "instantiations" for deduction guides (they don't really 1150 // have them). 1151 if (PrintInstantiation && 1152 !isa<CXXDeductionGuideDecl>(D->getTemplatedDecl())) { 1153 FunctionDecl *PrevDecl = D->getTemplatedDecl(); 1154 const FunctionDecl *Def; 1155 if (PrevDecl->isDefined(Def) && Def != PrevDecl) 1156 return; 1157 for (auto *I : D->specializations()) 1158 if (I->getTemplateSpecializationKind() == TSK_ImplicitInstantiation) { 1159 if (!PrevDecl->isThisDeclarationADefinition()) 1160 Out << ";\n"; 1161 Indent(); 1162 prettyPrintPragmas(I); 1163 Visit(I); 1164 } 1165 } 1166 } 1167 1168 void DeclPrinter::VisitClassTemplateDecl(ClassTemplateDecl *D) { 1169 VisitRedeclarableTemplateDecl(D); 1170 1171 if (PrintInstantiation) { 1172 for (auto *I : D->specializations()) 1173 if (I->getSpecializationKind() == TSK_ImplicitInstantiation) { 1174 if (D->isThisDeclarationADefinition()) 1175 Out << ";"; 1176 Out << "\n"; 1177 Visit(I); 1178 } 1179 } 1180 } 1181 1182 void DeclPrinter::VisitClassTemplateSpecializationDecl( 1183 ClassTemplateSpecializationDecl *D) { 1184 Out << "template<> "; 1185 VisitCXXRecordDecl(D); 1186 } 1187 1188 void DeclPrinter::VisitClassTemplatePartialSpecializationDecl( 1189 ClassTemplatePartialSpecializationDecl *D) { 1190 printTemplateParameters(D->getTemplateParameters()); 1191 VisitCXXRecordDecl(D); 1192 } 1193 1194 //---------------------------------------------------------------------------- 1195 // Objective-C declarations 1196 //---------------------------------------------------------------------------- 1197 1198 void DeclPrinter::PrintObjCMethodType(ASTContext &Ctx, 1199 Decl::ObjCDeclQualifier Quals, 1200 QualType T) { 1201 Out << '('; 1202 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_In) 1203 Out << "in "; 1204 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_Inout) 1205 Out << "inout "; 1206 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_Out) 1207 Out << "out "; 1208 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_Bycopy) 1209 Out << "bycopy "; 1210 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_Byref) 1211 Out << "byref "; 1212 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_Oneway) 1213 Out << "oneway "; 1214 if (Quals & Decl::ObjCDeclQualifier::OBJC_TQ_CSNullability) { 1215 if (auto nullability = AttributedType::stripOuterNullability(T)) 1216 Out << getNullabilitySpelling(*nullability, true) << ' '; 1217 } 1218 1219 Out << Ctx.getUnqualifiedObjCPointerType(T).getAsString(Policy); 1220 Out << ')'; 1221 } 1222 1223 void DeclPrinter::PrintObjCTypeParams(ObjCTypeParamList *Params) { 1224 Out << "<"; 1225 unsigned First = true; 1226 for (auto *Param : *Params) { 1227 if (First) { 1228 First = false; 1229 } else { 1230 Out << ", "; 1231 } 1232 1233 switch (Param->getVariance()) { 1234 case ObjCTypeParamVariance::Invariant: 1235 break; 1236 1237 case ObjCTypeParamVariance::Covariant: 1238 Out << "__covariant "; 1239 break; 1240 1241 case ObjCTypeParamVariance::Contravariant: 1242 Out << "__contravariant "; 1243 break; 1244 } 1245 1246 Out << Param->getDeclName().getAsString(); 1247 1248 if (Param->hasExplicitBound()) { 1249 Out << " : " << Param->getUnderlyingType().getAsString(Policy); 1250 } 1251 } 1252 Out << ">"; 1253 } 1254 1255 void DeclPrinter::VisitObjCMethodDecl(ObjCMethodDecl *OMD) { 1256 if (OMD->isInstanceMethod()) 1257 Out << "- "; 1258 else 1259 Out << "+ "; 1260 if (!OMD->getReturnType().isNull()) { 1261 PrintObjCMethodType(OMD->getASTContext(), OMD->getObjCDeclQualifier(), 1262 OMD->getReturnType()); 1263 } 1264 1265 std::string name = OMD->getSelector().getAsString(); 1266 std::string::size_type pos, lastPos = 0; 1267 for (const auto *PI : OMD->parameters()) { 1268 // FIXME: selector is missing here! 1269 pos = name.find_first_of(':', lastPos); 1270 if (lastPos != 0) 1271 Out << " "; 1272 Out << name.substr(lastPos, pos - lastPos) << ':'; 1273 PrintObjCMethodType(OMD->getASTContext(), 1274 PI->getObjCDeclQualifier(), 1275 PI->getType()); 1276 Out << *PI; 1277 lastPos = pos + 1; 1278 } 1279 1280 if (OMD->param_begin() == OMD->param_end()) 1281 Out << name; 1282 1283 if (OMD->isVariadic()) 1284 Out << ", ..."; 1285 1286 prettyPrintAttributes(OMD); 1287 1288 if (OMD->getBody() && !Policy.TerseOutput) { 1289 Out << ' '; 1290 OMD->getBody()->printPretty(Out, nullptr, Policy); 1291 } 1292 else if (Policy.PolishForDeclaration) 1293 Out << ';'; 1294 } 1295 1296 void DeclPrinter::VisitObjCImplementationDecl(ObjCImplementationDecl *OID) { 1297 std::string I = OID->getNameAsString(); 1298 ObjCInterfaceDecl *SID = OID->getSuperClass(); 1299 1300 bool eolnOut = false; 1301 if (SID) 1302 Out << "@implementation " << I << " : " << *SID; 1303 else 1304 Out << "@implementation " << I; 1305 1306 if (OID->ivar_size() > 0) { 1307 Out << "{\n"; 1308 eolnOut = true; 1309 Indentation += Policy.Indentation; 1310 for (const auto *I : OID->ivars()) { 1311 Indent() << I->getASTContext().getUnqualifiedObjCPointerType(I->getType()). 1312 getAsString(Policy) << ' ' << *I << ";\n"; 1313 } 1314 Indentation -= Policy.Indentation; 1315 Out << "}\n"; 1316 } 1317 else if (SID || (OID->decls_begin() != OID->decls_end())) { 1318 Out << "\n"; 1319 eolnOut = true; 1320 } 1321 VisitDeclContext(OID, false); 1322 if (!eolnOut) 1323 Out << "\n"; 1324 Out << "@end"; 1325 } 1326 1327 void DeclPrinter::VisitObjCInterfaceDecl(ObjCInterfaceDecl *OID) { 1328 std::string I = OID->getNameAsString(); 1329 ObjCInterfaceDecl *SID = OID->getSuperClass(); 1330 1331 if (!OID->isThisDeclarationADefinition()) { 1332 Out << "@class " << I; 1333 1334 if (auto TypeParams = OID->getTypeParamListAsWritten()) { 1335 PrintObjCTypeParams(TypeParams); 1336 } 1337 1338 Out << ";"; 1339 return; 1340 } 1341 bool eolnOut = false; 1342 Out << "@interface " << I; 1343 1344 if (auto TypeParams = OID->getTypeParamListAsWritten()) { 1345 PrintObjCTypeParams(TypeParams); 1346 } 1347 1348 if (SID) 1349 Out << " : " << QualType(OID->getSuperClassType(), 0).getAsString(Policy); 1350 1351 // Protocols? 1352 const ObjCList<ObjCProtocolDecl> &Protocols = OID->getReferencedProtocols(); 1353 if (!Protocols.empty()) { 1354 for (ObjCList<ObjCProtocolDecl>::iterator I = Protocols.begin(), 1355 E = Protocols.end(); I != E; ++I) 1356 Out << (I == Protocols.begin() ? '<' : ',') << **I; 1357 Out << "> "; 1358 } 1359 1360 if (OID->ivar_size() > 0) { 1361 Out << "{\n"; 1362 eolnOut = true; 1363 Indentation += Policy.Indentation; 1364 for (const auto *I : OID->ivars()) { 1365 Indent() << I->getASTContext() 1366 .getUnqualifiedObjCPointerType(I->getType()) 1367 .getAsString(Policy) << ' ' << *I << ";\n"; 1368 } 1369 Indentation -= Policy.Indentation; 1370 Out << "}\n"; 1371 } 1372 else if (SID || (OID->decls_begin() != OID->decls_end())) { 1373 Out << "\n"; 1374 eolnOut = true; 1375 } 1376 1377 VisitDeclContext(OID, false); 1378 if (!eolnOut) 1379 Out << "\n"; 1380 Out << "@end"; 1381 // FIXME: implement the rest... 1382 } 1383 1384 void DeclPrinter::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) { 1385 if (!PID->isThisDeclarationADefinition()) { 1386 Out << "@protocol " << *PID << ";\n"; 1387 return; 1388 } 1389 // Protocols? 1390 const ObjCList<ObjCProtocolDecl> &Protocols = PID->getReferencedProtocols(); 1391 if (!Protocols.empty()) { 1392 Out << "@protocol " << *PID; 1393 for (ObjCList<ObjCProtocolDecl>::iterator I = Protocols.begin(), 1394 E = Protocols.end(); I != E; ++I) 1395 Out << (I == Protocols.begin() ? '<' : ',') << **I; 1396 Out << ">\n"; 1397 } else 1398 Out << "@protocol " << *PID << '\n'; 1399 VisitDeclContext(PID, false); 1400 Out << "@end"; 1401 } 1402 1403 void DeclPrinter::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *PID) { 1404 Out << "@implementation " << *PID->getClassInterface() << '(' << *PID <<")\n"; 1405 1406 VisitDeclContext(PID, false); 1407 Out << "@end"; 1408 // FIXME: implement the rest... 1409 } 1410 1411 void DeclPrinter::VisitObjCCategoryDecl(ObjCCategoryDecl *PID) { 1412 Out << "@interface " << *PID->getClassInterface(); 1413 if (auto TypeParams = PID->getTypeParamList()) { 1414 PrintObjCTypeParams(TypeParams); 1415 } 1416 Out << "(" << *PID << ")\n"; 1417 if (PID->ivar_size() > 0) { 1418 Out << "{\n"; 1419 Indentation += Policy.Indentation; 1420 for (const auto *I : PID->ivars()) 1421 Indent() << I->getASTContext().getUnqualifiedObjCPointerType(I->getType()). 1422 getAsString(Policy) << ' ' << *I << ";\n"; 1423 Indentation -= Policy.Indentation; 1424 Out << "}\n"; 1425 } 1426 1427 VisitDeclContext(PID, false); 1428 Out << "@end"; 1429 1430 // FIXME: implement the rest... 1431 } 1432 1433 void DeclPrinter::VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *AID) { 1434 Out << "@compatibility_alias " << *AID 1435 << ' ' << *AID->getClassInterface() << ";\n"; 1436 } 1437 1438 /// PrintObjCPropertyDecl - print a property declaration. 1439 /// 1440 /// Print attributes in the following order: 1441 /// - class 1442 /// - nonatomic | atomic 1443 /// - assign | retain | strong | copy | weak | unsafe_unretained 1444 /// - readwrite | readonly 1445 /// - getter & setter 1446 /// - nullability 1447 void DeclPrinter::VisitObjCPropertyDecl(ObjCPropertyDecl *PDecl) { 1448 if (PDecl->getPropertyImplementation() == ObjCPropertyDecl::Required) 1449 Out << "@required\n"; 1450 else if (PDecl->getPropertyImplementation() == ObjCPropertyDecl::Optional) 1451 Out << "@optional\n"; 1452 1453 QualType T = PDecl->getType(); 1454 1455 Out << "@property"; 1456 if (PDecl->getPropertyAttributes() != ObjCPropertyDecl::OBJC_PR_noattr) { 1457 bool first = true; 1458 Out << "("; 1459 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_class) { 1460 Out << (first ? "" : ", ") << "class"; 1461 first = false; 1462 } 1463 1464 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_direct) { 1465 Out << (first ? "" : ", ") << "direct"; 1466 first = false; 1467 } 1468 1469 if (PDecl->getPropertyAttributes() & 1470 ObjCPropertyDecl::OBJC_PR_nonatomic) { 1471 Out << (first ? "" : ", ") << "nonatomic"; 1472 first = false; 1473 } 1474 if (PDecl->getPropertyAttributes() & 1475 ObjCPropertyDecl::OBJC_PR_atomic) { 1476 Out << (first ? "" : ", ") << "atomic"; 1477 first = false; 1478 } 1479 1480 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_assign) { 1481 Out << (first ? "" : ", ") << "assign"; 1482 first = false; 1483 } 1484 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_retain) { 1485 Out << (first ? "" : ", ") << "retain"; 1486 first = false; 1487 } 1488 1489 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_strong) { 1490 Out << (first ? "" : ", ") << "strong"; 1491 first = false; 1492 } 1493 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_copy) { 1494 Out << (first ? "" : ", ") << "copy"; 1495 first = false; 1496 } 1497 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_weak) { 1498 Out << (first ? "" : ", ") << "weak"; 1499 first = false; 1500 } 1501 if (PDecl->getPropertyAttributes() 1502 & ObjCPropertyDecl::OBJC_PR_unsafe_unretained) { 1503 Out << (first ? "" : ", ") << "unsafe_unretained"; 1504 first = false; 1505 } 1506 1507 if (PDecl->getPropertyAttributes() & 1508 ObjCPropertyDecl::OBJC_PR_readwrite) { 1509 Out << (first ? "" : ", ") << "readwrite"; 1510 first = false; 1511 } 1512 if (PDecl->getPropertyAttributes() & 1513 ObjCPropertyDecl::OBJC_PR_readonly) { 1514 Out << (first ? "" : ", ") << "readonly"; 1515 first = false; 1516 } 1517 1518 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_getter) { 1519 Out << (first ? "" : ", ") << "getter = "; 1520 PDecl->getGetterName().print(Out); 1521 first = false; 1522 } 1523 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_setter) { 1524 Out << (first ? "" : ", ") << "setter = "; 1525 PDecl->getSetterName().print(Out); 1526 first = false; 1527 } 1528 1529 if (PDecl->getPropertyAttributes() & 1530 ObjCPropertyDecl::OBJC_PR_nullability) { 1531 if (auto nullability = AttributedType::stripOuterNullability(T)) { 1532 if (*nullability == NullabilityKind::Unspecified && 1533 (PDecl->getPropertyAttributes() & 1534 ObjCPropertyDecl::OBJC_PR_null_resettable)) { 1535 Out << (first ? "" : ", ") << "null_resettable"; 1536 } else { 1537 Out << (first ? "" : ", ") 1538 << getNullabilitySpelling(*nullability, true); 1539 } 1540 first = false; 1541 } 1542 } 1543 1544 (void) first; // Silence dead store warning due to idiomatic code. 1545 Out << ")"; 1546 } 1547 std::string TypeStr = PDecl->getASTContext().getUnqualifiedObjCPointerType(T). 1548 getAsString(Policy); 1549 Out << ' ' << TypeStr; 1550 if (!StringRef(TypeStr).endswith("*")) 1551 Out << ' '; 1552 Out << *PDecl; 1553 if (Policy.PolishForDeclaration) 1554 Out << ';'; 1555 } 1556 1557 void DeclPrinter::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PID) { 1558 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) 1559 Out << "@synthesize "; 1560 else 1561 Out << "@dynamic "; 1562 Out << *PID->getPropertyDecl(); 1563 if (PID->getPropertyIvarDecl()) 1564 Out << '=' << *PID->getPropertyIvarDecl(); 1565 } 1566 1567 void DeclPrinter::VisitUsingDecl(UsingDecl *D) { 1568 if (!D->isAccessDeclaration()) 1569 Out << "using "; 1570 if (D->hasTypename()) 1571 Out << "typename "; 1572 D->getQualifier()->print(Out, Policy); 1573 1574 // Use the correct record name when the using declaration is used for 1575 // inheriting constructors. 1576 for (const auto *Shadow : D->shadows()) { 1577 if (const auto *ConstructorShadow = 1578 dyn_cast<ConstructorUsingShadowDecl>(Shadow)) { 1579 assert(Shadow->getDeclContext() == ConstructorShadow->getDeclContext()); 1580 Out << *ConstructorShadow->getNominatedBaseClass(); 1581 return; 1582 } 1583 } 1584 Out << *D; 1585 } 1586 1587 void 1588 DeclPrinter::VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D) { 1589 Out << "using typename "; 1590 D->getQualifier()->print(Out, Policy); 1591 Out << D->getDeclName(); 1592 } 1593 1594 void DeclPrinter::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) { 1595 if (!D->isAccessDeclaration()) 1596 Out << "using "; 1597 D->getQualifier()->print(Out, Policy); 1598 Out << D->getDeclName(); 1599 } 1600 1601 void DeclPrinter::VisitUsingShadowDecl(UsingShadowDecl *D) { 1602 // ignore 1603 } 1604 1605 void DeclPrinter::VisitOMPThreadPrivateDecl(OMPThreadPrivateDecl *D) { 1606 Out << "#pragma omp threadprivate"; 1607 if (!D->varlist_empty()) { 1608 for (OMPThreadPrivateDecl::varlist_iterator I = D->varlist_begin(), 1609 E = D->varlist_end(); 1610 I != E; ++I) { 1611 Out << (I == D->varlist_begin() ? '(' : ','); 1612 NamedDecl *ND = cast<DeclRefExpr>(*I)->getDecl(); 1613 ND->printQualifiedName(Out); 1614 } 1615 Out << ")"; 1616 } 1617 } 1618 1619 void DeclPrinter::VisitOMPAllocateDecl(OMPAllocateDecl *D) { 1620 Out << "#pragma omp allocate"; 1621 if (!D->varlist_empty()) { 1622 for (OMPAllocateDecl::varlist_iterator I = D->varlist_begin(), 1623 E = D->varlist_end(); 1624 I != E; ++I) { 1625 Out << (I == D->varlist_begin() ? '(' : ','); 1626 NamedDecl *ND = cast<DeclRefExpr>(*I)->getDecl(); 1627 ND->printQualifiedName(Out); 1628 } 1629 Out << ")"; 1630 } 1631 if (!D->clauselist_empty()) { 1632 Out << " "; 1633 OMPClausePrinter Printer(Out, Policy); 1634 for (OMPClause *C : D->clauselists()) 1635 Printer.Visit(C); 1636 } 1637 } 1638 1639 void DeclPrinter::VisitOMPRequiresDecl(OMPRequiresDecl *D) { 1640 Out << "#pragma omp requires "; 1641 if (!D->clauselist_empty()) { 1642 OMPClausePrinter Printer(Out, Policy); 1643 for (auto I = D->clauselist_begin(), E = D->clauselist_end(); I != E; ++I) 1644 Printer.Visit(*I); 1645 } 1646 } 1647 1648 void DeclPrinter::VisitOMPDeclareReductionDecl(OMPDeclareReductionDecl *D) { 1649 if (!D->isInvalidDecl()) { 1650 Out << "#pragma omp declare reduction ("; 1651 if (D->getDeclName().getNameKind() == DeclarationName::CXXOperatorName) { 1652 const char *OpName = 1653 getOperatorSpelling(D->getDeclName().getCXXOverloadedOperator()); 1654 assert(OpName && "not an overloaded operator"); 1655 Out << OpName; 1656 } else { 1657 assert(D->getDeclName().isIdentifier()); 1658 D->printName(Out); 1659 } 1660 Out << " : "; 1661 D->getType().print(Out, Policy); 1662 Out << " : "; 1663 D->getCombiner()->printPretty(Out, nullptr, Policy, 0); 1664 Out << ")"; 1665 if (auto *Init = D->getInitializer()) { 1666 Out << " initializer("; 1667 switch (D->getInitializerKind()) { 1668 case OMPDeclareReductionDecl::DirectInit: 1669 Out << "omp_priv("; 1670 break; 1671 case OMPDeclareReductionDecl::CopyInit: 1672 Out << "omp_priv = "; 1673 break; 1674 case OMPDeclareReductionDecl::CallInit: 1675 break; 1676 } 1677 Init->printPretty(Out, nullptr, Policy, 0); 1678 if (D->getInitializerKind() == OMPDeclareReductionDecl::DirectInit) 1679 Out << ")"; 1680 Out << ")"; 1681 } 1682 } 1683 } 1684 1685 void DeclPrinter::VisitOMPDeclareMapperDecl(OMPDeclareMapperDecl *D) { 1686 if (!D->isInvalidDecl()) { 1687 Out << "#pragma omp declare mapper ("; 1688 D->printName(Out); 1689 Out << " : "; 1690 D->getType().print(Out, Policy); 1691 Out << " "; 1692 Out << D->getVarName(); 1693 Out << ")"; 1694 if (!D->clauselist_empty()) { 1695 OMPClausePrinter Printer(Out, Policy); 1696 for (auto *C : D->clauselists()) { 1697 Out << " "; 1698 Printer.Visit(C); 1699 } 1700 } 1701 } 1702 } 1703 1704 void DeclPrinter::VisitOMPCapturedExprDecl(OMPCapturedExprDecl *D) { 1705 D->getInit()->printPretty(Out, nullptr, Policy, Indentation); 1706 } 1707 1708