DeclPrinter.cpp revision 581deb3da481053c4993c7600f97acf7768caac5
1//===--- DeclPrinter.cpp - Printing implementation for Decl ASTs ----------===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file implements the Decl::dump method, which pretty print the 11// AST back out to C/Objective-C/C++/Objective-C++ code. 12// 13//===----------------------------------------------------------------------===// 14#include "clang/AST/ASTContext.h" 15#include "clang/AST/DeclVisitor.h" 16#include "clang/AST/Decl.h" 17#include "clang/AST/DeclCXX.h" 18#include "clang/AST/DeclObjC.h" 19#include "clang/AST/Expr.h" 20#include "clang/AST/ExprCXX.h" 21#include "clang/AST/PrettyPrinter.h" 22#include "clang/Basic/Module.h" 23#include "llvm/Support/raw_ostream.h" 24using namespace clang; 25 26namespace { 27 class DeclPrinter : public DeclVisitor<DeclPrinter> { 28 raw_ostream &Out; 29 ASTContext &Context; 30 PrintingPolicy Policy; 31 unsigned Indentation; 32 bool PrintInstantiation; 33 34 raw_ostream& Indent() { return Indent(Indentation); } 35 raw_ostream& Indent(unsigned Indentation); 36 void ProcessDeclGroup(SmallVectorImpl<Decl*>& Decls); 37 38 void Print(AccessSpecifier AS); 39 40 public: 41 DeclPrinter(raw_ostream &Out, ASTContext &Context, 42 const PrintingPolicy &Policy, 43 unsigned Indentation = 0, 44 bool PrintInstantiation = false) 45 : Out(Out), Context(Context), Policy(Policy), Indentation(Indentation), 46 PrintInstantiation(PrintInstantiation) { } 47 48 void VisitDeclContext(DeclContext *DC, bool Indent = true); 49 50 void VisitTranslationUnitDecl(TranslationUnitDecl *D); 51 void VisitTypedefDecl(TypedefDecl *D); 52 void VisitTypeAliasDecl(TypeAliasDecl *D); 53 void VisitEnumDecl(EnumDecl *D); 54 void VisitRecordDecl(RecordDecl *D); 55 void VisitEnumConstantDecl(EnumConstantDecl *D); 56 void VisitFunctionDecl(FunctionDecl *D); 57 void VisitFieldDecl(FieldDecl *D); 58 void VisitVarDecl(VarDecl *D); 59 void VisitLabelDecl(LabelDecl *D); 60 void VisitParmVarDecl(ParmVarDecl *D); 61 void VisitFileScopeAsmDecl(FileScopeAsmDecl *D); 62 void VisitImportDecl(ImportDecl *D); 63 void VisitStaticAssertDecl(StaticAssertDecl *D); 64 void VisitNamespaceDecl(NamespaceDecl *D); 65 void VisitUsingDirectiveDecl(UsingDirectiveDecl *D); 66 void VisitNamespaceAliasDecl(NamespaceAliasDecl *D); 67 void VisitCXXRecordDecl(CXXRecordDecl *D); 68 void VisitLinkageSpecDecl(LinkageSpecDecl *D); 69 void VisitTemplateDecl(const TemplateDecl *D); 70 void VisitFunctionTemplateDecl(FunctionTemplateDecl *D); 71 void VisitClassTemplateDecl(ClassTemplateDecl *D); 72 void VisitObjCMethodDecl(ObjCMethodDecl *D); 73 void VisitObjCImplementationDecl(ObjCImplementationDecl *D); 74 void VisitObjCInterfaceDecl(ObjCInterfaceDecl *D); 75 void VisitObjCProtocolDecl(ObjCProtocolDecl *D); 76 void VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D); 77 void VisitObjCCategoryDecl(ObjCCategoryDecl *D); 78 void VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *D); 79 void VisitObjCPropertyDecl(ObjCPropertyDecl *D); 80 void VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *D); 81 void VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D); 82 void VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D); 83 void VisitUsingDecl(UsingDecl *D); 84 void VisitUsingShadowDecl(UsingShadowDecl *D); 85 86 void PrintTemplateParameters(const TemplateParameterList *Params, 87 const TemplateArgumentList *Args); 88 void prettyPrintAttributes(Decl *D); 89 }; 90} 91 92void Decl::print(raw_ostream &Out, unsigned Indentation, 93 bool PrintInstantiation) const { 94 print(Out, getASTContext().getPrintingPolicy(), Indentation, PrintInstantiation); 95} 96 97void Decl::print(raw_ostream &Out, const PrintingPolicy &Policy, 98 unsigned Indentation, bool PrintInstantiation) const { 99 DeclPrinter Printer(Out, getASTContext(), Policy, Indentation, PrintInstantiation); 100 Printer.Visit(const_cast<Decl*>(this)); 101} 102 103static QualType GetBaseType(QualType T) { 104 // FIXME: This should be on the Type class! 105 QualType BaseType = T; 106 while (!BaseType->isSpecifierType()) { 107 if (isa<TypedefType>(BaseType)) 108 break; 109 else if (const PointerType* PTy = BaseType->getAs<PointerType>()) 110 BaseType = PTy->getPointeeType(); 111 else if (const ArrayType* ATy = dyn_cast<ArrayType>(BaseType)) 112 BaseType = ATy->getElementType(); 113 else if (const FunctionType* FTy = BaseType->getAs<FunctionType>()) 114 BaseType = FTy->getResultType(); 115 else if (const VectorType *VTy = BaseType->getAs<VectorType>()) 116 BaseType = VTy->getElementType(); 117 else 118 llvm_unreachable("Unknown declarator!"); 119 } 120 return BaseType; 121} 122 123static QualType getDeclType(Decl* D) { 124 if (TypedefNameDecl* TDD = dyn_cast<TypedefNameDecl>(D)) 125 return TDD->getUnderlyingType(); 126 if (ValueDecl* VD = dyn_cast<ValueDecl>(D)) 127 return VD->getType(); 128 return QualType(); 129} 130 131void Decl::printGroup(Decl** Begin, unsigned NumDecls, 132 raw_ostream &Out, const PrintingPolicy &Policy, 133 unsigned Indentation) { 134 if (NumDecls == 1) { 135 (*Begin)->print(Out, Policy, Indentation); 136 return; 137 } 138 139 Decl** End = Begin + NumDecls; 140 TagDecl* TD = dyn_cast<TagDecl>(*Begin); 141 if (TD) 142 ++Begin; 143 144 PrintingPolicy SubPolicy(Policy); 145 if (TD && TD->isCompleteDefinition()) { 146 TD->print(Out, Policy, Indentation); 147 Out << " "; 148 SubPolicy.SuppressTag = true; 149 } 150 151 bool isFirst = true; 152 for ( ; Begin != End; ++Begin) { 153 if (isFirst) { 154 SubPolicy.SuppressSpecifiers = false; 155 isFirst = false; 156 } else { 157 if (!isFirst) Out << ", "; 158 SubPolicy.SuppressSpecifiers = true; 159 } 160 161 (*Begin)->print(Out, SubPolicy, Indentation); 162 } 163} 164 165void DeclContext::dumpDeclContext() const { 166 // Get the translation unit 167 const DeclContext *DC = this; 168 while (!DC->isTranslationUnit()) 169 DC = DC->getParent(); 170 171 ASTContext &Ctx = cast<TranslationUnitDecl>(DC)->getASTContext(); 172 DeclPrinter Printer(llvm::errs(), Ctx, Ctx.getPrintingPolicy(), 0); 173 Printer.VisitDeclContext(const_cast<DeclContext *>(this), /*Indent=*/false); 174} 175 176void Decl::dump() const { 177 print(llvm::errs()); 178} 179 180raw_ostream& DeclPrinter::Indent(unsigned Indentation) { 181 for (unsigned i = 0; i != Indentation; ++i) 182 Out << " "; 183 return Out; 184} 185 186void DeclPrinter::prettyPrintAttributes(Decl *D) { 187 if (D->hasAttrs()) { 188 AttrVec &Attrs = D->getAttrs(); 189 for (AttrVec::const_iterator i=Attrs.begin(), e=Attrs.end(); i!=e; ++i) { 190 Attr *A = *i; 191 A->printPretty(Out, Context); 192 } 193 } 194} 195 196void DeclPrinter::ProcessDeclGroup(SmallVectorImpl<Decl*>& Decls) { 197 this->Indent(); 198 Decl::printGroup(Decls.data(), Decls.size(), Out, Policy, Indentation); 199 Out << ";\n"; 200 Decls.clear(); 201 202} 203 204void DeclPrinter::Print(AccessSpecifier AS) { 205 switch(AS) { 206 case AS_none: llvm_unreachable("No access specifier!"); 207 case AS_public: Out << "public"; break; 208 case AS_protected: Out << "protected"; break; 209 case AS_private: Out << "private"; break; 210 } 211} 212 213//---------------------------------------------------------------------------- 214// Common C declarations 215//---------------------------------------------------------------------------- 216 217void DeclPrinter::VisitDeclContext(DeclContext *DC, bool Indent) { 218 if (Indent) 219 Indentation += Policy.Indentation; 220 221 SmallVector<Decl*, 2> Decls; 222 for (DeclContext::decl_iterator D = DC->decls_begin(), DEnd = DC->decls_end(); 223 D != DEnd; ++D) { 224 225 // Don't print ObjCIvarDecls, as they are printed when visiting the 226 // containing ObjCInterfaceDecl. 227 if (isa<ObjCIvarDecl>(*D)) 228 continue; 229 230 if (!Policy.Dump) { 231 // Skip over implicit declarations in pretty-printing mode. 232 if (D->isImplicit()) continue; 233 // FIXME: Ugly hack so we don't pretty-print the builtin declaration 234 // of __builtin_va_list or __[u]int128_t. There should be some other way 235 // to check that. 236 if (NamedDecl *ND = dyn_cast<NamedDecl>(*D)) { 237 if (IdentifierInfo *II = ND->getIdentifier()) { 238 if (II->isStr("__builtin_va_list") || 239 II->isStr("__int128_t") || II->isStr("__uint128_t")) 240 continue; 241 } 242 } 243 } 244 245 // The next bits of code handles stuff like "struct {int x;} a,b"; we're 246 // forced to merge the declarations because there's no other way to 247 // refer to the struct in question. This limited merging is safe without 248 // a bunch of other checks because it only merges declarations directly 249 // referring to the tag, not typedefs. 250 // 251 // Check whether the current declaration should be grouped with a previous 252 // unnamed struct. 253 QualType CurDeclType = getDeclType(*D); 254 if (!Decls.empty() && !CurDeclType.isNull()) { 255 QualType BaseType = GetBaseType(CurDeclType); 256 if (!BaseType.isNull() && isa<TagType>(BaseType) && 257 cast<TagType>(BaseType)->getDecl() == Decls[0]) { 258 Decls.push_back(*D); 259 continue; 260 } 261 } 262 263 // If we have a merged group waiting to be handled, handle it now. 264 if (!Decls.empty()) 265 ProcessDeclGroup(Decls); 266 267 // If the current declaration is an unnamed tag type, save it 268 // so we can merge it with the subsequent declaration(s) using it. 269 if (isa<TagDecl>(*D) && !cast<TagDecl>(*D)->getIdentifier()) { 270 Decls.push_back(*D); 271 continue; 272 } 273 274 if (isa<AccessSpecDecl>(*D)) { 275 Indentation -= Policy.Indentation; 276 this->Indent(); 277 Print(D->getAccess()); 278 Out << ":\n"; 279 Indentation += Policy.Indentation; 280 continue; 281 } 282 283 this->Indent(); 284 Visit(*D); 285 286 // FIXME: Need to be able to tell the DeclPrinter when 287 const char *Terminator = 0; 288 if (isa<FunctionDecl>(*D) && 289 cast<FunctionDecl>(*D)->isThisDeclarationADefinition()) 290 Terminator = 0; 291 else if (isa<ObjCMethodDecl>(*D) && cast<ObjCMethodDecl>(*D)->getBody()) 292 Terminator = 0; 293 else if (isa<NamespaceDecl>(*D) || isa<LinkageSpecDecl>(*D) || 294 isa<ObjCImplementationDecl>(*D) || 295 isa<ObjCInterfaceDecl>(*D) || 296 isa<ObjCProtocolDecl>(*D) || 297 isa<ObjCCategoryImplDecl>(*D) || 298 isa<ObjCCategoryDecl>(*D)) 299 Terminator = 0; 300 else if (isa<EnumConstantDecl>(*D)) { 301 DeclContext::decl_iterator Next = D; 302 ++Next; 303 if (Next != DEnd) 304 Terminator = ","; 305 } else 306 Terminator = ";"; 307 308 if (Terminator) 309 Out << Terminator; 310 Out << "\n"; 311 } 312 313 if (!Decls.empty()) 314 ProcessDeclGroup(Decls); 315 316 if (Indent) 317 Indentation -= Policy.Indentation; 318} 319 320void DeclPrinter::VisitTranslationUnitDecl(TranslationUnitDecl *D) { 321 VisitDeclContext(D, false); 322} 323 324void DeclPrinter::VisitTypedefDecl(TypedefDecl *D) { 325 if (!Policy.SuppressSpecifiers) { 326 Out << "typedef "; 327 328 if (D->isModulePrivate()) 329 Out << "__module_private__ "; 330 } 331 D->getUnderlyingType().print(Out, Policy, D->getName()); 332 prettyPrintAttributes(D); 333} 334 335void DeclPrinter::VisitTypeAliasDecl(TypeAliasDecl *D) { 336 Out << "using " << *D << " = " << D->getUnderlyingType().getAsString(Policy); 337} 338 339void DeclPrinter::VisitEnumDecl(EnumDecl *D) { 340 if (!Policy.SuppressSpecifiers && D->isModulePrivate()) 341 Out << "__module_private__ "; 342 Out << "enum "; 343 if (D->isScoped()) { 344 if (D->isScopedUsingClassTag()) 345 Out << "class "; 346 else 347 Out << "struct "; 348 } 349 Out << *D; 350 351 if (D->isFixed()) 352 Out << " : " << D->getIntegerType().stream(Policy); 353 354 if (D->isCompleteDefinition()) { 355 Out << " {\n"; 356 VisitDeclContext(D); 357 Indent() << "}"; 358 } 359 prettyPrintAttributes(D); 360} 361 362void DeclPrinter::VisitRecordDecl(RecordDecl *D) { 363 if (!Policy.SuppressSpecifiers && D->isModulePrivate()) 364 Out << "__module_private__ "; 365 Out << D->getKindName(); 366 if (D->getIdentifier()) 367 Out << ' ' << *D; 368 369 if (D->isCompleteDefinition()) { 370 Out << " {\n"; 371 VisitDeclContext(D); 372 Indent() << "}"; 373 } 374} 375 376void DeclPrinter::VisitEnumConstantDecl(EnumConstantDecl *D) { 377 Out << *D; 378 if (Expr *Init = D->getInitExpr()) { 379 Out << " = "; 380 Init->printPretty(Out, Context, 0, Policy, Indentation); 381 } 382} 383 384void DeclPrinter::VisitFunctionDecl(FunctionDecl *D) { 385 if (!Policy.SuppressSpecifiers) { 386 switch (D->getStorageClassAsWritten()) { 387 case SC_None: break; 388 case SC_Extern: Out << "extern "; break; 389 case SC_Static: Out << "static "; break; 390 case SC_PrivateExtern: Out << "__private_extern__ "; break; 391 case SC_Auto: case SC_Register: case SC_OpenCLWorkGroupLocal: 392 llvm_unreachable("invalid for functions"); 393 } 394 395 if (D->isInlineSpecified()) Out << "inline "; 396 if (D->isVirtualAsWritten()) Out << "virtual "; 397 if (D->isModulePrivate()) Out << "__module_private__ "; 398 } 399 400 PrintingPolicy SubPolicy(Policy); 401 SubPolicy.SuppressSpecifiers = false; 402 std::string Proto = D->getNameInfo().getAsString(); 403 404 QualType Ty = D->getType(); 405 while (const ParenType *PT = dyn_cast<ParenType>(Ty)) { 406 Proto = '(' + Proto + ')'; 407 Ty = PT->getInnerType(); 408 } 409 410 if (isa<FunctionType>(Ty)) { 411 const FunctionType *AFT = Ty->getAs<FunctionType>(); 412 const FunctionProtoType *FT = 0; 413 if (D->hasWrittenPrototype()) 414 FT = dyn_cast<FunctionProtoType>(AFT); 415 416 Proto += "("; 417 if (FT) { 418 llvm::raw_string_ostream POut(Proto); 419 DeclPrinter ParamPrinter(POut, Context, SubPolicy, Indentation); 420 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) { 421 if (i) POut << ", "; 422 ParamPrinter.VisitParmVarDecl(D->getParamDecl(i)); 423 } 424 425 if (FT->isVariadic()) { 426 if (D->getNumParams()) POut << ", "; 427 POut << "..."; 428 } 429 } else if (D->doesThisDeclarationHaveABody() && !D->hasPrototype()) { 430 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) { 431 if (i) 432 Proto += ", "; 433 Proto += D->getParamDecl(i)->getNameAsString(); 434 } 435 } 436 437 Proto += ")"; 438 439 if (FT && FT->getTypeQuals()) { 440 unsigned TypeQuals = FT->getTypeQuals(); 441 if (TypeQuals & Qualifiers::Const) 442 Proto += " const"; 443 if (TypeQuals & Qualifiers::Volatile) 444 Proto += " volatile"; 445 if (TypeQuals & Qualifiers::Restrict) 446 Proto += " restrict"; 447 } 448 449 if (FT && FT->hasDynamicExceptionSpec()) { 450 Proto += " throw("; 451 if (FT->getExceptionSpecType() == EST_MSAny) 452 Proto += "..."; 453 else 454 for (unsigned I = 0, N = FT->getNumExceptions(); I != N; ++I) { 455 if (I) 456 Proto += ", "; 457 458 Proto += FT->getExceptionType(I).getAsString(SubPolicy);; 459 } 460 Proto += ")"; 461 } else if (FT && isNoexceptExceptionSpec(FT->getExceptionSpecType())) { 462 Proto += " noexcept"; 463 if (FT->getExceptionSpecType() == EST_ComputedNoexcept) { 464 Proto += "("; 465 llvm::raw_string_ostream EOut(Proto); 466 FT->getNoexceptExpr()->printPretty(EOut, Context, 0, SubPolicy, 467 Indentation); 468 EOut.flush(); 469 Proto += EOut.str(); 470 Proto += ")"; 471 } 472 } 473 474 if (CXXConstructorDecl *CDecl = dyn_cast<CXXConstructorDecl>(D)) { 475 bool HasInitializerList = false; 476 for (CXXConstructorDecl::init_const_iterator B = CDecl->init_begin(), 477 E = CDecl->init_end(); 478 B != E; ++B) { 479 CXXCtorInitializer * BMInitializer = (*B); 480 if (BMInitializer->isInClassMemberInitializer()) 481 continue; 482 483 if (!HasInitializerList) { 484 Proto += " : "; 485 Out << Proto; 486 Proto.clear(); 487 HasInitializerList = true; 488 } else 489 Out << ", "; 490 491 if (BMInitializer->isAnyMemberInitializer()) { 492 FieldDecl *FD = BMInitializer->getAnyMember(); 493 Out << *FD; 494 } else { 495 Out << QualType(BMInitializer->getBaseClass(), 0).getAsString(Policy); 496 } 497 498 Out << "("; 499 if (!BMInitializer->getInit()) { 500 // Nothing to print 501 } else { 502 Expr *Init = BMInitializer->getInit(); 503 if (ExprWithCleanups *Tmp = dyn_cast<ExprWithCleanups>(Init)) 504 Init = Tmp->getSubExpr(); 505 506 Init = Init->IgnoreParens(); 507 508 Expr *SimpleInit = 0; 509 Expr **Args = 0; 510 unsigned NumArgs = 0; 511 if (ParenListExpr *ParenList = dyn_cast<ParenListExpr>(Init)) { 512 Args = ParenList->getExprs(); 513 NumArgs = ParenList->getNumExprs(); 514 } else if (CXXConstructExpr *Construct 515 = dyn_cast<CXXConstructExpr>(Init)) { 516 Args = Construct->getArgs(); 517 NumArgs = Construct->getNumArgs(); 518 } else 519 SimpleInit = Init; 520 521 if (SimpleInit) 522 SimpleInit->printPretty(Out, Context, 0, Policy, Indentation); 523 else { 524 for (unsigned I = 0; I != NumArgs; ++I) { 525 if (isa<CXXDefaultArgExpr>(Args[I])) 526 break; 527 528 if (I) 529 Out << ", "; 530 Args[I]->printPretty(Out, Context, 0, Policy, Indentation); 531 } 532 } 533 } 534 Out << ")"; 535 } 536 } 537 else 538 AFT->getResultType().print(Out, Policy, Proto); 539 } else { 540 Ty.print(Out, Policy, Proto); 541 } 542 543 prettyPrintAttributes(D); 544 545 if (D->isPure()) 546 Out << " = 0"; 547 else if (D->isDeletedAsWritten()) 548 Out << " = delete"; 549 else if (D->doesThisDeclarationHaveABody()) { 550 if (!D->hasPrototype() && D->getNumParams()) { 551 // This is a K&R function definition, so we need to print the 552 // parameters. 553 Out << '\n'; 554 DeclPrinter ParamPrinter(Out, Context, SubPolicy, Indentation); 555 Indentation += Policy.Indentation; 556 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) { 557 Indent(); 558 ParamPrinter.VisitParmVarDecl(D->getParamDecl(i)); 559 Out << ";\n"; 560 } 561 Indentation -= Policy.Indentation; 562 } else 563 Out << ' '; 564 565 D->getBody()->printPretty(Out, Context, 0, SubPolicy, Indentation); 566 Out << '\n'; 567 } 568} 569 570void DeclPrinter::VisitFieldDecl(FieldDecl *D) { 571 if (!Policy.SuppressSpecifiers && D->isMutable()) 572 Out << "mutable "; 573 if (!Policy.SuppressSpecifiers && D->isModulePrivate()) 574 Out << "__module_private__ "; 575 576 Out << D->getType().stream(Policy, D->getName()); 577 578 if (D->isBitField()) { 579 Out << " : "; 580 D->getBitWidth()->printPretty(Out, Context, 0, Policy, Indentation); 581 } 582 583 Expr *Init = D->getInClassInitializer(); 584 if (!Policy.SuppressInitializers && Init) { 585 Out << " = "; 586 Init->printPretty(Out, Context, 0, Policy, Indentation); 587 } 588 prettyPrintAttributes(D); 589} 590 591void DeclPrinter::VisitLabelDecl(LabelDecl *D) { 592 Out << *D << ":"; 593} 594 595 596void DeclPrinter::VisitVarDecl(VarDecl *D) { 597 StorageClass SCAsWritten = D->getStorageClassAsWritten(); 598 if (!Policy.SuppressSpecifiers && SCAsWritten != SC_None) 599 Out << VarDecl::getStorageClassSpecifierString(SCAsWritten) << " "; 600 601 if (!Policy.SuppressSpecifiers && D->isThreadSpecified()) 602 Out << "__thread "; 603 if (!Policy.SuppressSpecifiers && D->isModulePrivate()) 604 Out << "__module_private__ "; 605 606 QualType T = D->getType(); 607 if (ParmVarDecl *Parm = dyn_cast<ParmVarDecl>(D)) 608 T = Parm->getOriginalType(); 609 T.print(Out, Policy, D->getName()); 610 Expr *Init = D->getInit(); 611 if (!Policy.SuppressInitializers && Init) { 612 bool ImplicitInit = false; 613 if (CXXConstructExpr *Construct = dyn_cast<CXXConstructExpr>(Init)) 614 ImplicitInit = D->getInitStyle() == VarDecl::CallInit && 615 Construct->getNumArgs() == 0 && !Construct->isListInitialization(); 616 if (!ImplicitInit) { 617 if (D->getInitStyle() == VarDecl::CallInit) 618 Out << "("; 619 else if (D->getInitStyle() == VarDecl::CInit) { 620 Out << " = "; 621 } 622 Init->printPretty(Out, Context, 0, Policy, Indentation); 623 if (D->getInitStyle() == VarDecl::CallInit) 624 Out << ")"; 625 } 626 } 627 prettyPrintAttributes(D); 628} 629 630void DeclPrinter::VisitParmVarDecl(ParmVarDecl *D) { 631 VisitVarDecl(D); 632} 633 634void DeclPrinter::VisitFileScopeAsmDecl(FileScopeAsmDecl *D) { 635 Out << "__asm ("; 636 D->getAsmString()->printPretty(Out, Context, 0, Policy, Indentation); 637 Out << ")"; 638} 639 640void DeclPrinter::VisitImportDecl(ImportDecl *D) { 641 Out << "@__experimental_modules_import " << D->getImportedModule()->getFullModuleName() 642 << ";\n"; 643} 644 645void DeclPrinter::VisitStaticAssertDecl(StaticAssertDecl *D) { 646 Out << "static_assert("; 647 D->getAssertExpr()->printPretty(Out, Context, 0, Policy, Indentation); 648 Out << ", "; 649 D->getMessage()->printPretty(Out, Context, 0, Policy, Indentation); 650 Out << ")"; 651} 652 653//---------------------------------------------------------------------------- 654// C++ declarations 655//---------------------------------------------------------------------------- 656void DeclPrinter::VisitNamespaceDecl(NamespaceDecl *D) { 657 if (D->isInline()) 658 Out << "inline "; 659 Out << "namespace " << *D << " {\n"; 660 VisitDeclContext(D); 661 Indent() << "}"; 662} 663 664void DeclPrinter::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) { 665 Out << "using namespace "; 666 if (D->getQualifier()) 667 D->getQualifier()->print(Out, Policy); 668 Out << *D->getNominatedNamespaceAsWritten(); 669} 670 671void DeclPrinter::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) { 672 Out << "namespace " << *D << " = "; 673 if (D->getQualifier()) 674 D->getQualifier()->print(Out, Policy); 675 Out << *D->getAliasedNamespace(); 676} 677 678void DeclPrinter::VisitCXXRecordDecl(CXXRecordDecl *D) { 679 if (!Policy.SuppressSpecifiers && D->isModulePrivate()) 680 Out << "__module_private__ "; 681 Out << D->getKindName(); 682 if (D->getIdentifier()) 683 Out << ' ' << *D; 684 685 if (D->isCompleteDefinition()) { 686 // Print the base classes 687 if (D->getNumBases()) { 688 Out << " : "; 689 for (CXXRecordDecl::base_class_iterator Base = D->bases_begin(), 690 BaseEnd = D->bases_end(); Base != BaseEnd; ++Base) { 691 if (Base != D->bases_begin()) 692 Out << ", "; 693 694 if (Base->isVirtual()) 695 Out << "virtual "; 696 697 AccessSpecifier AS = Base->getAccessSpecifierAsWritten(); 698 if (AS != AS_none) 699 Print(AS); 700 Out << " " << Base->getType().getAsString(Policy); 701 702 if (Base->isPackExpansion()) 703 Out << "..."; 704 } 705 } 706 707 // Print the class definition 708 // FIXME: Doesn't print access specifiers, e.g., "public:" 709 Out << " {\n"; 710 VisitDeclContext(D); 711 Indent() << "}"; 712 } 713} 714 715void DeclPrinter::VisitLinkageSpecDecl(LinkageSpecDecl *D) { 716 const char *l; 717 if (D->getLanguage() == LinkageSpecDecl::lang_c) 718 l = "C"; 719 else { 720 assert(D->getLanguage() == LinkageSpecDecl::lang_cxx && 721 "unknown language in linkage specification"); 722 l = "C++"; 723 } 724 725 Out << "extern \"" << l << "\" "; 726 if (D->hasBraces()) { 727 Out << "{\n"; 728 VisitDeclContext(D); 729 Indent() << "}"; 730 } else 731 Visit(*D->decls_begin()); 732} 733 734void DeclPrinter::PrintTemplateParameters( 735 const TemplateParameterList *Params, const TemplateArgumentList *Args = 0) { 736 assert(Params); 737 assert(!Args || Params->size() == Args->size()); 738 739 Out << "template <"; 740 741 for (unsigned i = 0, e = Params->size(); i != e; ++i) { 742 if (i != 0) 743 Out << ", "; 744 745 const Decl *Param = Params->getParam(i); 746 if (const TemplateTypeParmDecl *TTP = 747 dyn_cast<TemplateTypeParmDecl>(Param)) { 748 749 if (TTP->wasDeclaredWithTypename()) 750 Out << "typename "; 751 else 752 Out << "class "; 753 754 if (TTP->isParameterPack()) 755 Out << "... "; 756 757 Out << *TTP; 758 759 if (Args) { 760 Out << " = "; 761 Args->get(i).print(Policy, Out); 762 } else if (TTP->hasDefaultArgument()) { 763 Out << " = "; 764 Out << TTP->getDefaultArgument().getAsString(Policy); 765 }; 766 } else if (const NonTypeTemplateParmDecl *NTTP = 767 dyn_cast<NonTypeTemplateParmDecl>(Param)) { 768 Out << NTTP->getType().getAsString(Policy); 769 770 if (NTTP->isParameterPack() && !isa<PackExpansionType>(NTTP->getType())) 771 Out << "..."; 772 773 if (IdentifierInfo *Name = NTTP->getIdentifier()) { 774 Out << ' '; 775 Out << Name->getName(); 776 } 777 778 if (Args) { 779 Out << " = "; 780 Args->get(i).print(Policy, Out); 781 } else if (NTTP->hasDefaultArgument()) { 782 Out << " = "; 783 NTTP->getDefaultArgument()->printPretty(Out, Context, 0, Policy, 784 Indentation); 785 } 786 } else if (const TemplateTemplateParmDecl *TTPD = 787 dyn_cast<TemplateTemplateParmDecl>(Param)) { 788 VisitTemplateDecl(TTPD); 789 // FIXME: print the default argument, if present. 790 } 791 } 792 793 Out << "> "; 794} 795 796void DeclPrinter::VisitTemplateDecl(const TemplateDecl *D) { 797 PrintTemplateParameters(D->getTemplateParameters()); 798 799 if (const TemplateTemplateParmDecl *TTP = 800 dyn_cast<TemplateTemplateParmDecl>(D)) { 801 Out << "class "; 802 if (TTP->isParameterPack()) 803 Out << "..."; 804 Out << D->getName(); 805 } else { 806 Visit(D->getTemplatedDecl()); 807 } 808} 809 810void DeclPrinter::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) { 811 if (PrintInstantiation) { 812 TemplateParameterList *Params = D->getTemplateParameters(); 813 for (FunctionTemplateDecl::spec_iterator I = D->spec_begin(), E = D->spec_end(); 814 I != E; ++I) { 815 PrintTemplateParameters(Params, (*I)->getTemplateSpecializationArgs()); 816 Visit(*I); 817 } 818 } 819 820 return VisitRedeclarableTemplateDecl(D); 821} 822 823void DeclPrinter::VisitClassTemplateDecl(ClassTemplateDecl *D) { 824 if (PrintInstantiation) { 825 TemplateParameterList *Params = D->getTemplateParameters(); 826 for (ClassTemplateDecl::spec_iterator I = D->spec_begin(), E = D->spec_end(); 827 I != E; ++I) { 828 PrintTemplateParameters(Params, &(*I)->getTemplateArgs()); 829 Visit(*I); 830 Out << '\n'; 831 } 832 } 833 834 return VisitRedeclarableTemplateDecl(D); 835} 836 837//---------------------------------------------------------------------------- 838// Objective-C declarations 839//---------------------------------------------------------------------------- 840 841void DeclPrinter::VisitObjCMethodDecl(ObjCMethodDecl *OMD) { 842 if (OMD->isInstanceMethod()) 843 Out << "- "; 844 else 845 Out << "+ "; 846 if (!OMD->getResultType().isNull()) 847 Out << '(' << OMD->getResultType().getAsString(Policy) << ")"; 848 849 std::string name = OMD->getSelector().getAsString(); 850 std::string::size_type pos, lastPos = 0; 851 for (ObjCMethodDecl::param_iterator PI = OMD->param_begin(), 852 E = OMD->param_end(); PI != E; ++PI) { 853 // FIXME: selector is missing here! 854 pos = name.find_first_of(':', lastPos); 855 Out << " " << name.substr(lastPos, pos - lastPos); 856 Out << ":(" << (*PI)->getType().getAsString(Policy) << ')' << **PI; 857 lastPos = pos + 1; 858 } 859 860 if (OMD->param_begin() == OMD->param_end()) 861 Out << " " << name; 862 863 if (OMD->isVariadic()) 864 Out << ", ..."; 865 866 if (OMD->getBody()) { 867 Out << ' '; 868 OMD->getBody()->printPretty(Out, Context, 0, Policy); 869 Out << '\n'; 870 } 871} 872 873void DeclPrinter::VisitObjCImplementationDecl(ObjCImplementationDecl *OID) { 874 std::string I = OID->getNameAsString(); 875 ObjCInterfaceDecl *SID = OID->getSuperClass(); 876 877 if (SID) 878 Out << "@implementation " << I << " : " << *SID; 879 else 880 Out << "@implementation " << I; 881 Out << "\n"; 882 VisitDeclContext(OID, false); 883 Out << "@end"; 884} 885 886void DeclPrinter::VisitObjCInterfaceDecl(ObjCInterfaceDecl *OID) { 887 std::string I = OID->getNameAsString(); 888 ObjCInterfaceDecl *SID = OID->getSuperClass(); 889 890 if (!OID->isThisDeclarationADefinition()) { 891 Out << "@class " << I << ";"; 892 return; 893 } 894 895 if (SID) 896 Out << "@interface " << I << " : " << *SID; 897 else 898 Out << "@interface " << I; 899 900 // Protocols? 901 const ObjCList<ObjCProtocolDecl> &Protocols = OID->getReferencedProtocols(); 902 if (!Protocols.empty()) { 903 for (ObjCList<ObjCProtocolDecl>::iterator I = Protocols.begin(), 904 E = Protocols.end(); I != E; ++I) 905 Out << (I == Protocols.begin() ? '<' : ',') << **I; 906 } 907 908 if (!Protocols.empty()) 909 Out << "> "; 910 911 if (OID->ivar_size() > 0) { 912 Out << "{\n"; 913 Indentation += Policy.Indentation; 914 for (ObjCInterfaceDecl::ivar_iterator I = OID->ivar_begin(), 915 E = OID->ivar_end(); I != E; ++I) { 916 Indent() << I->getType().getAsString(Policy) << ' ' << **I << ";\n"; 917 } 918 Indentation -= Policy.Indentation; 919 Out << "}\n"; 920 } 921 922 VisitDeclContext(OID, false); 923 Out << "@end"; 924 // FIXME: implement the rest... 925} 926 927void DeclPrinter::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) { 928 if (!PID->isThisDeclarationADefinition()) { 929 Out << "@protocol " << PID->getIdentifier() << ";\n"; 930 return; 931 } 932 933 Out << "@protocol " << *PID << '\n'; 934 VisitDeclContext(PID, false); 935 Out << "@end"; 936} 937 938void DeclPrinter::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *PID) { 939 Out << "@implementation " << *PID->getClassInterface() << '(' << *PID <<")\n"; 940 941 VisitDeclContext(PID, false); 942 Out << "@end"; 943 // FIXME: implement the rest... 944} 945 946void DeclPrinter::VisitObjCCategoryDecl(ObjCCategoryDecl *PID) { 947 Out << "@interface " << *PID->getClassInterface() << '(' << *PID << ")\n"; 948 VisitDeclContext(PID, false); 949 Out << "@end"; 950 951 // FIXME: implement the rest... 952} 953 954void DeclPrinter::VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *AID) { 955 Out << "@compatibility_alias " << *AID 956 << ' ' << *AID->getClassInterface() << ";\n"; 957} 958 959/// PrintObjCPropertyDecl - print a property declaration. 960/// 961void DeclPrinter::VisitObjCPropertyDecl(ObjCPropertyDecl *PDecl) { 962 if (PDecl->getPropertyImplementation() == ObjCPropertyDecl::Required) 963 Out << "@required\n"; 964 else if (PDecl->getPropertyImplementation() == ObjCPropertyDecl::Optional) 965 Out << "@optional\n"; 966 967 Out << "@property"; 968 if (PDecl->getPropertyAttributes() != ObjCPropertyDecl::OBJC_PR_noattr) { 969 bool first = true; 970 Out << " ("; 971 if (PDecl->getPropertyAttributes() & 972 ObjCPropertyDecl::OBJC_PR_readonly) { 973 Out << (first ? ' ' : ',') << "readonly"; 974 first = false; 975 } 976 977 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_getter) { 978 Out << (first ? ' ' : ',') << "getter = " 979 << PDecl->getGetterName().getAsString(); 980 first = false; 981 } 982 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_setter) { 983 Out << (first ? ' ' : ',') << "setter = " 984 << PDecl->getSetterName().getAsString(); 985 first = false; 986 } 987 988 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_assign) { 989 Out << (first ? ' ' : ',') << "assign"; 990 first = false; 991 } 992 993 if (PDecl->getPropertyAttributes() & 994 ObjCPropertyDecl::OBJC_PR_readwrite) { 995 Out << (first ? ' ' : ',') << "readwrite"; 996 first = false; 997 } 998 999 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_retain) { 1000 Out << (first ? ' ' : ',') << "retain"; 1001 first = false; 1002 } 1003 1004 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_strong) { 1005 Out << (first ? ' ' : ',') << "strong"; 1006 first = false; 1007 } 1008 1009 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_copy) { 1010 Out << (first ? ' ' : ',') << "copy"; 1011 first = false; 1012 } 1013 1014 if (PDecl->getPropertyAttributes() & 1015 ObjCPropertyDecl::OBJC_PR_nonatomic) { 1016 Out << (first ? ' ' : ',') << "nonatomic"; 1017 first = false; 1018 } 1019 if (PDecl->getPropertyAttributes() & 1020 ObjCPropertyDecl::OBJC_PR_atomic) { 1021 Out << (first ? ' ' : ',') << "atomic"; 1022 first = false; 1023 } 1024 1025 (void) first; // Silence dead store warning due to idiomatic code. 1026 Out << " )"; 1027 } 1028 Out << ' ' << PDecl->getType().getAsString(Policy) << ' ' << *PDecl; 1029} 1030 1031void DeclPrinter::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PID) { 1032 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) 1033 Out << "@synthesize "; 1034 else 1035 Out << "@dynamic "; 1036 Out << *PID->getPropertyDecl(); 1037 if (PID->getPropertyIvarDecl()) 1038 Out << '=' << *PID->getPropertyIvarDecl(); 1039} 1040 1041void DeclPrinter::VisitUsingDecl(UsingDecl *D) { 1042 Out << "using "; 1043 D->getQualifier()->print(Out, Policy); 1044 Out << *D; 1045} 1046 1047void 1048DeclPrinter::VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D) { 1049 Out << "using typename "; 1050 D->getQualifier()->print(Out, Policy); 1051 Out << D->getDeclName(); 1052} 1053 1054void DeclPrinter::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) { 1055 Out << "using "; 1056 D->getQualifier()->print(Out, Policy); 1057 Out << D->getDeclName(); 1058} 1059 1060void DeclPrinter::VisitUsingShadowDecl(UsingShadowDecl *D) { 1061 // ignore 1062} 1063