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::dump method, which pretty print the
11 // AST back out to C/Objective-C/C++/Objective-C++ code.
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/PrettyPrinter.h"
21 #include "llvm/Support/Compiler.h"
22 #include "llvm/Support/Streams.h"
23 #include "llvm/Support/Format.h"
24 #include "llvm/Support/raw_ostream.h"
25 using namespace clang;
28 class VISIBILITY_HIDDEN DeclPrinter : public DeclVisitor<DeclPrinter> {
29 llvm::raw_ostream &Out;
31 PrintingPolicy Policy;
34 llvm::raw_ostream& Indent();
35 void ProcessDeclGroup(llvm::SmallVectorImpl<Decl*>& Decls);
38 DeclPrinter(llvm::raw_ostream &Out, ASTContext &Context,
39 const PrintingPolicy &Policy,
40 unsigned Indentation = 0)
41 : Out(Out), Context(Context), Policy(Policy), Indentation(Indentation) { }
43 void VisitDeclContext(DeclContext *DC, bool Indent = true);
45 void VisitTranslationUnitDecl(TranslationUnitDecl *D);
46 void VisitTypedefDecl(TypedefDecl *D);
47 void VisitEnumDecl(EnumDecl *D);
48 void VisitRecordDecl(RecordDecl *D);
49 void VisitEnumConstantDecl(EnumConstantDecl *D);
50 void VisitFunctionDecl(FunctionDecl *D);
51 void VisitFieldDecl(FieldDecl *D);
52 void VisitVarDecl(VarDecl *D);
53 void VisitParmVarDecl(ParmVarDecl *D);
54 void VisitOriginalParmVarDecl(OriginalParmVarDecl *D);
55 void VisitFileScopeAsmDecl(FileScopeAsmDecl *D);
56 void VisitOverloadedFunctionDecl(OverloadedFunctionDecl *D);
57 void VisitNamespaceDecl(NamespaceDecl *D);
58 void VisitUsingDirectiveDecl(UsingDirectiveDecl *D);
59 void VisitNamespaceAliasDecl(NamespaceAliasDecl *D);
60 void VisitCXXRecordDecl(CXXRecordDecl *D);
61 void VisitLinkageSpecDecl(LinkageSpecDecl *D);
62 void VisitTemplateDecl(TemplateDecl *D);
63 void VisitObjCMethodDecl(ObjCMethodDecl *D);
64 void VisitObjCClassDecl(ObjCClassDecl *D);
65 void VisitObjCImplementationDecl(ObjCImplementationDecl *D);
66 void VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
67 void VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D);
68 void VisitObjCProtocolDecl(ObjCProtocolDecl *D);
69 void VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
70 void VisitObjCCategoryDecl(ObjCCategoryDecl *D);
71 void VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *D);
72 void VisitObjCPropertyDecl(ObjCPropertyDecl *D);
73 void VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *D);
77 void Decl::print(llvm::raw_ostream &Out, ASTContext &Context,
78 unsigned Indentation) {
79 print(Out, Context, Context.PrintingPolicy, Indentation);
82 void Decl::print(llvm::raw_ostream &Out, ASTContext &Context,
83 const PrintingPolicy &Policy, unsigned Indentation) {
84 DeclPrinter Printer(Out, Context, Policy, Indentation);
88 static QualType GetBaseType(QualType T) {
89 // FIXME: This should be on the Type class!
90 QualType BaseType = T;
91 while (!BaseType->isSpecifierType()) {
92 if (isa<TypedefType>(BaseType))
94 else if (const PointerType* PTy = BaseType->getAsPointerType())
95 BaseType = PTy->getPointeeType();
96 else if (const ArrayType* ATy = dyn_cast<ArrayType>(BaseType))
97 BaseType = ATy->getElementType();
98 else if (const FunctionType* FTy = BaseType->getAsFunctionType())
99 BaseType = FTy->getResultType();
101 assert(0 && "Unknown declarator!");
106 static QualType getDeclType(Decl* D) {
107 if (TypedefDecl* TDD = dyn_cast<TypedefDecl>(D))
108 return TDD->getUnderlyingType();
109 if (ValueDecl* VD = dyn_cast<ValueDecl>(D))
110 return VD->getType();
114 void Decl::printGroup(Decl** Begin, unsigned NumDecls,
115 llvm::raw_ostream &Out, ASTContext &Context,
116 const PrintingPolicy &Policy,
117 unsigned Indentation) {
119 (*Begin)->print(Out, Context, Policy, Indentation);
123 Decl** End = Begin + NumDecls;
124 TagDecl* TD = dyn_cast<TagDecl>(*Begin);
128 PrintingPolicy SubPolicy(Policy);
129 if (TD && TD->isDefinition()) {
130 TD->print(Out, Context, Policy, Indentation);
132 SubPolicy.SuppressTag = true;
136 for ( ; Begin != End; ++Begin) {
138 SubPolicy.SuppressSpecifiers = false;
141 if (!isFirst) Out << ", ";
142 SubPolicy.SuppressSpecifiers = true;
145 (*Begin)->print(Out, Context, SubPolicy, Indentation);
149 void Decl::dump(ASTContext &Context) {
150 print(llvm::errs(), Context);
153 llvm::raw_ostream& DeclPrinter::Indent() {
154 for (unsigned i = 0; i < Indentation; ++i)
159 void DeclPrinter::ProcessDeclGroup(llvm::SmallVectorImpl<Decl*>& Decls) {
161 Decl::printGroup(Decls.data(), Decls.size(), Out, Context,
162 Policy, Indentation);
168 //----------------------------------------------------------------------------
169 // Common C declarations
170 //----------------------------------------------------------------------------
172 void DeclPrinter::VisitDeclContext(DeclContext *DC, bool Indent) {
174 Indentation += Policy.Indentation;
176 llvm::SmallVector<Decl*, 2> Decls;
177 for (DeclContext::decl_iterator D = DC->decls_begin(Context),
178 DEnd = DC->decls_end(Context);
181 // Skip over implicit declarations in pretty-printing mode.
182 if (D->isImplicit()) continue;
183 // FIXME: Ugly hack so we don't pretty-print the builtin declaration
184 // of __builtin_va_list. There should be some other way to check that.
185 if (isa<NamedDecl>(*D) && cast<NamedDecl>(*D)->getNameAsString() ==
190 // The next bits of code handles stuff like "struct {int x;} a,b"; we're
191 // forced to merge the declarations because there's no other way to
192 // refer to the struct in question. This limited merging is safe without
193 // a bunch of other checks because it only merges declarations directly
194 // referring to the tag, not typedefs.
196 // Check whether the current declaration should be grouped with a previous
198 QualType CurDeclType = getDeclType(*D);
199 if (!Decls.empty() && !CurDeclType.isNull()) {
200 QualType BaseType = GetBaseType(CurDeclType);
201 if (!BaseType.isNull() && isa<TagType>(BaseType) &&
202 cast<TagType>(BaseType)->getDecl() == Decls[0]) {
208 // If we have a merged group waiting to be handled, handle it now.
210 ProcessDeclGroup(Decls);
212 // If the current declaration is an unnamed tag type, save it
213 // so we can merge it with the subsequent declaration(s) using it.
214 if (isa<TagDecl>(*D) && !cast<TagDecl>(*D)->getIdentifier()) {
221 // FIXME: Need to be able to tell the DeclPrinter when
222 const char *Terminator = 0;
223 if (isa<FunctionDecl>(*D) &&
224 cast<FunctionDecl>(*D)->isThisDeclarationADefinition())
226 else if (isa<ObjCMethodDecl>(*D) && cast<ObjCMethodDecl>(*D)->getBody())
228 else if (isa<NamespaceDecl>(*D) || isa<LinkageSpecDecl>(*D) ||
229 isa<ObjCImplementationDecl>(*D) ||
230 isa<ObjCInterfaceDecl>(*D) ||
231 isa<ObjCProtocolDecl>(*D) ||
232 isa<ObjCCategoryImplDecl>(*D) ||
233 isa<ObjCCategoryDecl>(*D))
235 else if (isa<EnumConstantDecl>(*D)) {
236 DeclContext::decl_iterator Next = D;
249 ProcessDeclGroup(Decls);
252 Indentation -= Policy.Indentation;
255 void DeclPrinter::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
256 VisitDeclContext(D, false);
259 void DeclPrinter::VisitTypedefDecl(TypedefDecl *D) {
260 std::string S = D->getNameAsString();
261 D->getUnderlyingType().getAsStringInternal(S, Policy);
262 if (!Policy.SuppressSpecifiers)
267 void DeclPrinter::VisitEnumDecl(EnumDecl *D) {
268 Out << "enum " << D->getNameAsString() << " {\n";
273 void DeclPrinter::VisitRecordDecl(RecordDecl *D) {
274 Out << D->getKindName();
275 if (D->getIdentifier()) {
277 Out << D->getNameAsString();
280 if (D->isDefinition()) {
287 void DeclPrinter::VisitEnumConstantDecl(EnumConstantDecl *D) {
288 Out << D->getNameAsString();
289 if (Expr *Init = D->getInitExpr()) {
291 Init->printPretty(Out, Context, 0, Policy, Indentation);
295 void DeclPrinter::VisitFunctionDecl(FunctionDecl *D) {
296 if (!Policy.SuppressSpecifiers) {
297 switch (D->getStorageClass()) {
298 case FunctionDecl::None: break;
299 case FunctionDecl::Extern: Out << "extern "; break;
300 case FunctionDecl::Static: Out << "static "; break;
301 case FunctionDecl::PrivateExtern: Out << "__private_extern__ "; break;
304 if (D->isInline()) Out << "inline ";
305 if (D->isVirtualAsWritten()) Out << "virtual ";
308 PrintingPolicy SubPolicy(Policy);
309 SubPolicy.SuppressSpecifiers = false;
310 std::string Proto = D->getNameAsString();
311 if (isa<FunctionType>(D->getType().getTypePtr())) {
312 const FunctionType *AFT = D->getType()->getAsFunctionType();
314 const FunctionProtoType *FT = 0;
315 if (D->hasWrittenPrototype())
316 FT = dyn_cast<FunctionProtoType>(AFT);
320 llvm::raw_string_ostream POut(Proto);
321 DeclPrinter ParamPrinter(POut, Context, SubPolicy, Indentation);
322 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) {
324 ParamPrinter.VisitParmVarDecl(D->getParamDecl(i));
327 if (FT->isVariadic()) {
328 if (D->getNumParams()) POut << ", ";
331 } else if (D->isThisDeclarationADefinition() && !D->hasPrototype()) {
332 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) {
335 Proto += D->getParamDecl(i)->getNameAsString();
340 AFT->getResultType().getAsStringInternal(Proto, Policy);
342 D->getType().getAsStringInternal(Proto, Policy);
349 else if (D->isDeleted())
351 else if (D->isThisDeclarationADefinition()) {
352 if (!D->hasPrototype() && D->getNumParams()) {
353 // This is a K&R function definition, so we need to print the
356 DeclPrinter ParamPrinter(Out, Context, SubPolicy, Indentation);
357 Indentation += Policy.Indentation;
358 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) {
360 ParamPrinter.VisitParmVarDecl(D->getParamDecl(i));
363 Indentation -= Policy.Indentation;
367 D->getBody(Context)->printPretty(Out, Context, 0, SubPolicy, Indentation);
372 void DeclPrinter::VisitFieldDecl(FieldDecl *D) {
373 if (!Policy.SuppressSpecifiers && D->isMutable())
376 std::string Name = D->getNameAsString();
377 D->getType().getAsStringInternal(Name, Policy);
380 if (D->isBitField()) {
382 D->getBitWidth()->printPretty(Out, Context, 0, Policy, Indentation);
386 void DeclPrinter::VisitVarDecl(VarDecl *D) {
387 if (!Policy.SuppressSpecifiers && D->getStorageClass() != VarDecl::None)
388 Out << VarDecl::getStorageClassSpecifierString(D->getStorageClass()) << " ";
390 if (!Policy.SuppressSpecifiers && D->isThreadSpecified())
393 std::string Name = D->getNameAsString();
394 QualType T = D->getType();
395 if (OriginalParmVarDecl *Parm = dyn_cast<OriginalParmVarDecl>(D))
396 T = Parm->getOriginalType();
397 T.getAsStringInternal(Name, Policy);
400 if (D->hasCXXDirectInitializer())
404 D->getInit()->printPretty(Out, Context, 0, Policy, Indentation);
405 if (D->hasCXXDirectInitializer())
410 void DeclPrinter::VisitParmVarDecl(ParmVarDecl *D) {
414 void DeclPrinter::VisitOriginalParmVarDecl(OriginalParmVarDecl *D) {
418 void DeclPrinter::VisitFileScopeAsmDecl(FileScopeAsmDecl *D) {
420 D->getAsmString()->printPretty(Out, Context, 0, Policy, Indentation);
424 //----------------------------------------------------------------------------
426 //----------------------------------------------------------------------------
427 void DeclPrinter::VisitOverloadedFunctionDecl(OverloadedFunctionDecl *D) {
429 "OverloadedFunctionDecls aren't really decls and are never printed");
432 void DeclPrinter::VisitNamespaceDecl(NamespaceDecl *D) {
433 Out << "namespace " << D->getNameAsString() << " {\n";
438 void DeclPrinter::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
439 Out << "using namespace ";
440 if (D->getQualifier())
441 D->getQualifier()->print(Out, Policy);
442 Out << D->getNominatedNamespace()->getNameAsString();
445 void DeclPrinter::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
446 Out << "namespace " << D->getNameAsString() << " = ";
447 if (D->getQualifier())
448 D->getQualifier()->print(Out, Policy);
449 Out << D->getAliasedNamespace()->getNameAsString();
452 void DeclPrinter::VisitCXXRecordDecl(CXXRecordDecl *D) {
453 Out << D->getKindName();
454 if (D->getIdentifier()) {
456 Out << D->getNameAsString();
459 if (D->isDefinition()) {
460 // Print the base classes
461 if (D->getNumBases()) {
463 for(CXXRecordDecl::base_class_iterator Base = D->bases_begin(),
464 BaseEnd = D->bases_end();
465 Base != BaseEnd; ++Base) {
466 if (Base != D->bases_begin())
469 if (Base->isVirtual())
472 switch(Base->getAccessSpecifierAsWritten()) {
474 case AS_public: Out << "public "; break;
475 case AS_protected: Out << "protected "; break;
476 case AS_private: Out << " private "; break;
479 Out << Base->getType().getAsString(Policy);
483 // Print the class definition
484 // FIXME: Doesn't print access specifiers, e.g., "public:"
491 void DeclPrinter::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
493 if (D->getLanguage() == LinkageSpecDecl::lang_c)
496 assert(D->getLanguage() == LinkageSpecDecl::lang_cxx &&
497 "unknown language in linkage specification");
501 Out << "extern \"" << l << "\" ";
502 if (D->hasBraces()) {
507 Visit(*D->decls_begin(Context));
510 void DeclPrinter::VisitTemplateDecl(TemplateDecl *D) {
513 TemplateParameterList *Params = D->getTemplateParameters();
514 for (unsigned i = 0, e = Params->size(); i != e; ++i) {
518 const Decl *Param = Params->getParam(i);
519 if (const TemplateTypeParmDecl *TTP =
520 dyn_cast<TemplateTypeParmDecl>(Param)) {
523 Context.getTypeDeclType(const_cast<TemplateTypeParmDecl*>(TTP));
525 if (TTP->wasDeclaredWithTypename())
530 Out << ParamType.getAsString(Policy);
532 if (TTP->hasDefaultArgument()) {
534 Out << TTP->getDefaultArgument().getAsString(Policy);
536 } else if (const NonTypeTemplateParmDecl *NTTP =
537 dyn_cast<NonTypeTemplateParmDecl>(Param)) {
538 Out << NTTP->getType().getAsString(Policy);
540 if (IdentifierInfo *Name = NTTP->getIdentifier()) {
542 Out << Name->getName();
545 if (NTTP->hasDefaultArgument()) {
547 NTTP->getDefaultArgument()->printPretty(Out, Context, 0, Policy,
555 Visit(D->getTemplatedDecl());
558 //----------------------------------------------------------------------------
559 // Objective-C declarations
560 //----------------------------------------------------------------------------
562 void DeclPrinter::VisitObjCClassDecl(ObjCClassDecl *D) {
564 for (ObjCClassDecl::iterator I = D->begin(), E = D->end();
566 if (I != D->begin()) Out << ", ";
567 Out << (*I)->getNameAsString();
571 void DeclPrinter::VisitObjCMethodDecl(ObjCMethodDecl *OMD) {
572 if (OMD->isInstanceMethod())
576 if (!OMD->getResultType().isNull())
577 Out << '(' << OMD->getResultType().getAsString(Policy) << ")";
579 std::string name = OMD->getSelector().getAsString();
580 std::string::size_type pos, lastPos = 0;
581 for (ObjCMethodDecl::param_iterator PI = OMD->param_begin(),
582 E = OMD->param_end(); PI != E; ++PI) {
583 // FIXME: selector is missing here!
584 pos = name.find_first_of(":", lastPos);
585 Out << " " << name.substr(lastPos, pos - lastPos);
586 Out << ":(" << (*PI)->getType().getAsString(Policy) << ")"
587 << (*PI)->getNameAsString();
591 if (OMD->param_begin() == OMD->param_end())
594 if (OMD->isVariadic())
597 if (OMD->getBody()) {
599 OMD->getBody()->printPretty(Out, Context, 0, Policy);
604 void DeclPrinter::VisitObjCImplementationDecl(ObjCImplementationDecl *OID) {
605 std::string I = OID->getNameAsString();
606 ObjCInterfaceDecl *SID = OID->getSuperClass();
609 Out << "@implementation " << I << " : " << SID->getNameAsString();
611 Out << "@implementation " << I;
613 VisitDeclContext(OID, false);
617 void DeclPrinter::VisitObjCInterfaceDecl(ObjCInterfaceDecl *OID) {
618 std::string I = OID->getNameAsString();
619 ObjCInterfaceDecl *SID = OID->getSuperClass();
622 Out << "@interface " << I << " : " << SID->getNameAsString();
624 Out << "@interface " << I;
627 const ObjCList<ObjCProtocolDecl> &Protocols = OID->getReferencedProtocols();
628 if (!Protocols.empty()) {
629 for (ObjCList<ObjCProtocolDecl>::iterator I = Protocols.begin(),
630 E = Protocols.end(); I != E; ++I)
631 Out << (I == Protocols.begin() ? '<' : ',') << (*I)->getNameAsString();
634 if (!Protocols.empty())
637 if (OID->ivar_size() > 0) {
639 Indentation += Policy.Indentation;
640 for (ObjCInterfaceDecl::ivar_iterator I = OID->ivar_begin(),
641 E = OID->ivar_end(); I != E; ++I) {
642 Indent() << (*I)->getType().getAsString(Policy)
643 << ' ' << (*I)->getNameAsString() << ";\n";
645 Indentation -= Policy.Indentation;
649 VisitDeclContext(OID, false);
651 // FIXME: implement the rest...
654 void DeclPrinter::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
656 for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(),
657 E = D->protocol_end();
659 if (I != D->protocol_begin()) Out << ", ";
660 Out << (*I)->getNameAsString();
664 void DeclPrinter::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
665 Out << "@protocol " << PID->getNameAsString() << '\n';
666 VisitDeclContext(PID, false);
670 void DeclPrinter::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *PID) {
671 Out << "@implementation "
672 << PID->getClassInterface()->getNameAsString()
673 << '(' << PID->getNameAsString() << ")\n";
675 VisitDeclContext(PID, false);
677 // FIXME: implement the rest...
680 void DeclPrinter::VisitObjCCategoryDecl(ObjCCategoryDecl *PID) {
682 << PID->getClassInterface()->getNameAsString()
683 << '(' << PID->getNameAsString() << ")\n";
684 VisitDeclContext(PID, false);
687 // FIXME: implement the rest...
690 void DeclPrinter::VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *AID) {
691 Out << "@compatibility_alias " << AID->getNameAsString()
692 << ' ' << AID->getClassInterface()->getNameAsString() << ";\n";
695 /// PrintObjCPropertyDecl - print a property declaration.
697 void DeclPrinter::VisitObjCPropertyDecl(ObjCPropertyDecl *PDecl) {
698 if (PDecl->getPropertyImplementation() == ObjCPropertyDecl::Required)
699 Out << "@required\n";
700 else if (PDecl->getPropertyImplementation() == ObjCPropertyDecl::Optional)
701 Out << "@optional\n";
704 if (PDecl->getPropertyAttributes() != ObjCPropertyDecl::OBJC_PR_noattr) {
707 if (PDecl->getPropertyAttributes() &
708 ObjCPropertyDecl::OBJC_PR_readonly) {
709 Out << (first ? ' ' : ',') << "readonly";
713 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_getter) {
714 Out << (first ? ' ' : ',') << "getter = "
715 << PDecl->getGetterName().getAsString();
718 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_setter) {
719 Out << (first ? ' ' : ',') << "setter = "
720 << PDecl->getSetterName().getAsString();
724 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_assign) {
725 Out << (first ? ' ' : ',') << "assign";
729 if (PDecl->getPropertyAttributes() &
730 ObjCPropertyDecl::OBJC_PR_readwrite) {
731 Out << (first ? ' ' : ',') << "readwrite";
735 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_retain) {
736 Out << (first ? ' ' : ',') << "retain";
740 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_copy) {
741 Out << (first ? ' ' : ',') << "copy";
745 if (PDecl->getPropertyAttributes() &
746 ObjCPropertyDecl::OBJC_PR_nonatomic) {
747 Out << (first ? ' ' : ',') << "nonatomic";
752 Out << ' ' << PDecl->getType().getAsString(Policy)
753 << ' ' << PDecl->getNameAsString();
756 void DeclPrinter::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PID) {
757 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize)
758 Out << "@synthesize ";
761 Out << PID->getPropertyDecl()->getNameAsString();
762 if (PID->getPropertyIvarDecl())
763 Out << "=" << PID->getPropertyIvarDecl()->getNameAsString();