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, unsigned Indentation) {
78 print(Out, getASTContext().PrintingPolicy, Indentation);
81 void Decl::print(llvm::raw_ostream &Out, const PrintingPolicy &Policy,
82 unsigned Indentation) {
83 DeclPrinter Printer(Out, getASTContext(), Policy, Indentation);
87 static QualType GetBaseType(QualType T) {
88 // FIXME: This should be on the Type class!
89 QualType BaseType = T;
90 while (!BaseType->isSpecifierType()) {
91 if (isa<TypedefType>(BaseType))
93 else if (const PointerType* PTy = BaseType->getAsPointerType())
94 BaseType = PTy->getPointeeType();
95 else if (const ArrayType* ATy = dyn_cast<ArrayType>(BaseType))
96 BaseType = ATy->getElementType();
97 else if (const FunctionType* FTy = BaseType->getAsFunctionType())
98 BaseType = FTy->getResultType();
99 else if (const VectorType *VTy = BaseType->getAsVectorType())
100 BaseType = VTy->getElementType();
102 assert(0 && "Unknown declarator!");
107 static QualType getDeclType(Decl* D) {
108 if (TypedefDecl* TDD = dyn_cast<TypedefDecl>(D))
109 return TDD->getUnderlyingType();
110 if (ValueDecl* VD = dyn_cast<ValueDecl>(D))
111 return VD->getType();
115 void Decl::printGroup(Decl** Begin, unsigned NumDecls,
116 llvm::raw_ostream &Out, const PrintingPolicy &Policy,
117 unsigned Indentation) {
119 (*Begin)->print(Out, 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, 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, SubPolicy, Indentation);
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, Policy, Indentation);
167 //----------------------------------------------------------------------------
168 // Common C declarations
169 //----------------------------------------------------------------------------
171 void DeclPrinter::VisitDeclContext(DeclContext *DC, bool Indent) {
173 Indentation += Policy.Indentation;
175 llvm::SmallVector<Decl*, 2> Decls;
176 for (DeclContext::decl_iterator D = DC->decls_begin(), DEnd = DC->decls_end();
179 // Skip over implicit declarations in pretty-printing mode.
180 if (D->isImplicit()) continue;
181 // FIXME: Ugly hack so we don't pretty-print the builtin declaration
182 // of __builtin_va_list. There should be some other way to check that.
183 if (isa<NamedDecl>(*D) && cast<NamedDecl>(*D)->getNameAsString() ==
188 // The next bits of code handles stuff like "struct {int x;} a,b"; we're
189 // forced to merge the declarations because there's no other way to
190 // refer to the struct in question. This limited merging is safe without
191 // a bunch of other checks because it only merges declarations directly
192 // referring to the tag, not typedefs.
194 // Check whether the current declaration should be grouped with a previous
196 QualType CurDeclType = getDeclType(*D);
197 if (!Decls.empty() && !CurDeclType.isNull()) {
198 QualType BaseType = GetBaseType(CurDeclType);
199 if (!BaseType.isNull() && isa<TagType>(BaseType) &&
200 cast<TagType>(BaseType)->getDecl() == Decls[0]) {
206 // If we have a merged group waiting to be handled, handle it now.
208 ProcessDeclGroup(Decls);
210 // If the current declaration is an unnamed tag type, save it
211 // so we can merge it with the subsequent declaration(s) using it.
212 if (isa<TagDecl>(*D) && !cast<TagDecl>(*D)->getIdentifier()) {
219 // FIXME: Need to be able to tell the DeclPrinter when
220 const char *Terminator = 0;
221 if (isa<FunctionDecl>(*D) &&
222 cast<FunctionDecl>(*D)->isThisDeclarationADefinition())
224 else if (isa<ObjCMethodDecl>(*D) && cast<ObjCMethodDecl>(*D)->getBody())
226 else if (isa<NamespaceDecl>(*D) || isa<LinkageSpecDecl>(*D) ||
227 isa<ObjCImplementationDecl>(*D) ||
228 isa<ObjCInterfaceDecl>(*D) ||
229 isa<ObjCProtocolDecl>(*D) ||
230 isa<ObjCCategoryImplDecl>(*D) ||
231 isa<ObjCCategoryDecl>(*D))
233 else if (isa<EnumConstantDecl>(*D)) {
234 DeclContext::decl_iterator Next = D;
247 ProcessDeclGroup(Decls);
250 Indentation -= Policy.Indentation;
253 void DeclPrinter::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
254 VisitDeclContext(D, false);
257 void DeclPrinter::VisitTypedefDecl(TypedefDecl *D) {
258 std::string S = D->getNameAsString();
259 D->getUnderlyingType().getAsStringInternal(S, Policy);
260 if (!Policy.SuppressSpecifiers)
265 void DeclPrinter::VisitEnumDecl(EnumDecl *D) {
266 Out << "enum " << D->getNameAsString() << " {\n";
271 void DeclPrinter::VisitRecordDecl(RecordDecl *D) {
272 Out << D->getKindName();
273 if (D->getIdentifier()) {
275 Out << D->getNameAsString();
278 if (D->isDefinition()) {
285 void DeclPrinter::VisitEnumConstantDecl(EnumConstantDecl *D) {
286 Out << D->getNameAsString();
287 if (Expr *Init = D->getInitExpr()) {
289 Init->printPretty(Out, Context, 0, Policy, Indentation);
293 void DeclPrinter::VisitFunctionDecl(FunctionDecl *D) {
294 if (!Policy.SuppressSpecifiers) {
295 switch (D->getStorageClass()) {
296 case FunctionDecl::None: break;
297 case FunctionDecl::Extern: Out << "extern "; break;
298 case FunctionDecl::Static: Out << "static "; break;
299 case FunctionDecl::PrivateExtern: Out << "__private_extern__ "; break;
302 if (D->isInline()) Out << "inline ";
303 if (D->isVirtualAsWritten()) Out << "virtual ";
306 PrintingPolicy SubPolicy(Policy);
307 SubPolicy.SuppressSpecifiers = false;
308 std::string Proto = D->getNameAsString();
309 if (isa<FunctionType>(D->getType().getTypePtr())) {
310 const FunctionType *AFT = D->getType()->getAsFunctionType();
312 const FunctionProtoType *FT = 0;
313 if (D->hasWrittenPrototype())
314 FT = dyn_cast<FunctionProtoType>(AFT);
318 llvm::raw_string_ostream POut(Proto);
319 DeclPrinter ParamPrinter(POut, Context, SubPolicy, Indentation);
320 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) {
322 ParamPrinter.VisitParmVarDecl(D->getParamDecl(i));
325 if (FT->isVariadic()) {
326 if (D->getNumParams()) POut << ", ";
329 } else if (D->isThisDeclarationADefinition() && !D->hasPrototype()) {
330 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) {
333 Proto += D->getParamDecl(i)->getNameAsString();
338 AFT->getResultType().getAsStringInternal(Proto, Policy);
340 D->getType().getAsStringInternal(Proto, Policy);
347 else if (D->isDeleted())
349 else if (D->isThisDeclarationADefinition()) {
350 if (!D->hasPrototype() && D->getNumParams()) {
351 // This is a K&R function definition, so we need to print the
354 DeclPrinter ParamPrinter(Out, Context, SubPolicy, Indentation);
355 Indentation += Policy.Indentation;
356 for (unsigned i = 0, e = D->getNumParams(); i != e; ++i) {
358 ParamPrinter.VisitParmVarDecl(D->getParamDecl(i));
361 Indentation -= Policy.Indentation;
365 D->getBody()->printPretty(Out, Context, 0, SubPolicy, Indentation);
370 void DeclPrinter::VisitFieldDecl(FieldDecl *D) {
371 if (!Policy.SuppressSpecifiers && D->isMutable())
374 std::string Name = D->getNameAsString();
375 D->getType().getAsStringInternal(Name, Policy);
378 if (D->isBitField()) {
380 D->getBitWidth()->printPretty(Out, Context, 0, Policy, Indentation);
384 void DeclPrinter::VisitVarDecl(VarDecl *D) {
385 if (!Policy.SuppressSpecifiers && D->getStorageClass() != VarDecl::None)
386 Out << VarDecl::getStorageClassSpecifierString(D->getStorageClass()) << " ";
388 if (!Policy.SuppressSpecifiers && D->isThreadSpecified())
391 std::string Name = D->getNameAsString();
392 QualType T = D->getType();
393 if (OriginalParmVarDecl *Parm = dyn_cast<OriginalParmVarDecl>(D))
394 T = Parm->getOriginalType();
395 T.getAsStringInternal(Name, Policy);
398 if (D->hasCXXDirectInitializer())
402 D->getInit()->printPretty(Out, Context, 0, Policy, Indentation);
403 if (D->hasCXXDirectInitializer())
408 void DeclPrinter::VisitParmVarDecl(ParmVarDecl *D) {
412 void DeclPrinter::VisitOriginalParmVarDecl(OriginalParmVarDecl *D) {
416 void DeclPrinter::VisitFileScopeAsmDecl(FileScopeAsmDecl *D) {
418 D->getAsmString()->printPretty(Out, Context, 0, Policy, Indentation);
422 //----------------------------------------------------------------------------
424 //----------------------------------------------------------------------------
425 void DeclPrinter::VisitOverloadedFunctionDecl(OverloadedFunctionDecl *D) {
427 "OverloadedFunctionDecls aren't really decls and are never printed");
430 void DeclPrinter::VisitNamespaceDecl(NamespaceDecl *D) {
431 Out << "namespace " << D->getNameAsString() << " {\n";
436 void DeclPrinter::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
437 Out << "using namespace ";
438 if (D->getQualifier())
439 D->getQualifier()->print(Out, Policy);
440 Out << D->getNominatedNamespace()->getNameAsString();
443 void DeclPrinter::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
444 Out << "namespace " << D->getNameAsString() << " = ";
445 if (D->getQualifier())
446 D->getQualifier()->print(Out, Policy);
447 Out << D->getAliasedNamespace()->getNameAsString();
450 void DeclPrinter::VisitCXXRecordDecl(CXXRecordDecl *D) {
451 Out << D->getKindName();
452 if (D->getIdentifier()) {
454 Out << D->getNameAsString();
457 if (D->isDefinition()) {
458 // Print the base classes
459 if (D->getNumBases()) {
461 for(CXXRecordDecl::base_class_iterator Base = D->bases_begin(),
462 BaseEnd = D->bases_end();
463 Base != BaseEnd; ++Base) {
464 if (Base != D->bases_begin())
467 if (Base->isVirtual())
470 switch(Base->getAccessSpecifierAsWritten()) {
472 case AS_public: Out << "public "; break;
473 case AS_protected: Out << "protected "; break;
474 case AS_private: Out << " private "; break;
477 Out << Base->getType().getAsString(Policy);
481 // Print the class definition
482 // FIXME: Doesn't print access specifiers, e.g., "public:"
489 void DeclPrinter::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
491 if (D->getLanguage() == LinkageSpecDecl::lang_c)
494 assert(D->getLanguage() == LinkageSpecDecl::lang_cxx &&
495 "unknown language in linkage specification");
499 Out << "extern \"" << l << "\" ";
500 if (D->hasBraces()) {
505 Visit(*D->decls_begin());
508 void DeclPrinter::VisitTemplateDecl(TemplateDecl *D) {
511 TemplateParameterList *Params = D->getTemplateParameters();
512 for (unsigned i = 0, e = Params->size(); i != e; ++i) {
516 const Decl *Param = Params->getParam(i);
517 if (const TemplateTypeParmDecl *TTP =
518 dyn_cast<TemplateTypeParmDecl>(Param)) {
521 Context.getTypeDeclType(const_cast<TemplateTypeParmDecl*>(TTP));
523 if (TTP->wasDeclaredWithTypename())
528 if (TTP->isParameterPack())
531 Out << ParamType.getAsString(Policy);
533 if (TTP->hasDefaultArgument()) {
535 Out << TTP->getDefaultArgument().getAsString(Policy);
537 } else if (const NonTypeTemplateParmDecl *NTTP =
538 dyn_cast<NonTypeTemplateParmDecl>(Param)) {
539 Out << NTTP->getType().getAsString(Policy);
541 if (IdentifierInfo *Name = NTTP->getIdentifier()) {
543 Out << Name->getName();
546 if (NTTP->hasDefaultArgument()) {
548 NTTP->getDefaultArgument()->printPretty(Out, Context, 0, Policy,
556 Visit(D->getTemplatedDecl());
559 //----------------------------------------------------------------------------
560 // Objective-C declarations
561 //----------------------------------------------------------------------------
563 void DeclPrinter::VisitObjCClassDecl(ObjCClassDecl *D) {
565 for (ObjCClassDecl::iterator I = D->begin(), E = D->end();
567 if (I != D->begin()) Out << ", ";
568 Out << (*I)->getNameAsString();
572 void DeclPrinter::VisitObjCMethodDecl(ObjCMethodDecl *OMD) {
573 if (OMD->isInstanceMethod())
577 if (!OMD->getResultType().isNull())
578 Out << '(' << OMD->getResultType().getAsString(Policy) << ")";
580 std::string name = OMD->getSelector().getAsString();
581 std::string::size_type pos, lastPos = 0;
582 for (ObjCMethodDecl::param_iterator PI = OMD->param_begin(),
583 E = OMD->param_end(); PI != E; ++PI) {
584 // FIXME: selector is missing here!
585 pos = name.find_first_of(":", lastPos);
586 Out << " " << name.substr(lastPos, pos - lastPos);
587 Out << ":(" << (*PI)->getType().getAsString(Policy) << ")"
588 << (*PI)->getNameAsString();
592 if (OMD->param_begin() == OMD->param_end())
595 if (OMD->isVariadic())
598 if (OMD->getBody()) {
600 OMD->getBody()->printPretty(Out, Context, 0, Policy);
605 void DeclPrinter::VisitObjCImplementationDecl(ObjCImplementationDecl *OID) {
606 std::string I = OID->getNameAsString();
607 ObjCInterfaceDecl *SID = OID->getSuperClass();
610 Out << "@implementation " << I << " : " << SID->getNameAsString();
612 Out << "@implementation " << I;
614 VisitDeclContext(OID, false);
618 void DeclPrinter::VisitObjCInterfaceDecl(ObjCInterfaceDecl *OID) {
619 std::string I = OID->getNameAsString();
620 ObjCInterfaceDecl *SID = OID->getSuperClass();
623 Out << "@interface " << I << " : " << SID->getNameAsString();
625 Out << "@interface " << I;
628 const ObjCList<ObjCProtocolDecl> &Protocols = OID->getReferencedProtocols();
629 if (!Protocols.empty()) {
630 for (ObjCList<ObjCProtocolDecl>::iterator I = Protocols.begin(),
631 E = Protocols.end(); I != E; ++I)
632 Out << (I == Protocols.begin() ? '<' : ',') << (*I)->getNameAsString();
635 if (!Protocols.empty())
638 if (OID->ivar_size() > 0) {
640 Indentation += Policy.Indentation;
641 for (ObjCInterfaceDecl::ivar_iterator I = OID->ivar_begin(),
642 E = OID->ivar_end(); I != E; ++I) {
643 Indent() << (*I)->getType().getAsString(Policy)
644 << ' ' << (*I)->getNameAsString() << ";\n";
646 Indentation -= Policy.Indentation;
650 VisitDeclContext(OID, false);
652 // FIXME: implement the rest...
655 void DeclPrinter::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
657 for (ObjCForwardProtocolDecl::protocol_iterator I = D->protocol_begin(),
658 E = D->protocol_end();
660 if (I != D->protocol_begin()) Out << ", ";
661 Out << (*I)->getNameAsString();
665 void DeclPrinter::VisitObjCProtocolDecl(ObjCProtocolDecl *PID) {
666 Out << "@protocol " << PID->getNameAsString() << '\n';
667 VisitDeclContext(PID, false);
671 void DeclPrinter::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *PID) {
672 Out << "@implementation "
673 << PID->getClassInterface()->getNameAsString()
674 << '(' << PID->getNameAsString() << ")\n";
676 VisitDeclContext(PID, false);
678 // FIXME: implement the rest...
681 void DeclPrinter::VisitObjCCategoryDecl(ObjCCategoryDecl *PID) {
683 << PID->getClassInterface()->getNameAsString()
684 << '(' << PID->getNameAsString() << ")\n";
685 VisitDeclContext(PID, false);
688 // FIXME: implement the rest...
691 void DeclPrinter::VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *AID) {
692 Out << "@compatibility_alias " << AID->getNameAsString()
693 << ' ' << AID->getClassInterface()->getNameAsString() << ";\n";
696 /// PrintObjCPropertyDecl - print a property declaration.
698 void DeclPrinter::VisitObjCPropertyDecl(ObjCPropertyDecl *PDecl) {
699 if (PDecl->getPropertyImplementation() == ObjCPropertyDecl::Required)
700 Out << "@required\n";
701 else if (PDecl->getPropertyImplementation() == ObjCPropertyDecl::Optional)
702 Out << "@optional\n";
705 if (PDecl->getPropertyAttributes() != ObjCPropertyDecl::OBJC_PR_noattr) {
708 if (PDecl->getPropertyAttributes() &
709 ObjCPropertyDecl::OBJC_PR_readonly) {
710 Out << (first ? ' ' : ',') << "readonly";
714 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_getter) {
715 Out << (first ? ' ' : ',') << "getter = "
716 << PDecl->getGetterName().getAsString();
719 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_setter) {
720 Out << (first ? ' ' : ',') << "setter = "
721 << PDecl->getSetterName().getAsString();
725 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_assign) {
726 Out << (first ? ' ' : ',') << "assign";
730 if (PDecl->getPropertyAttributes() &
731 ObjCPropertyDecl::OBJC_PR_readwrite) {
732 Out << (first ? ' ' : ',') << "readwrite";
736 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_retain) {
737 Out << (first ? ' ' : ',') << "retain";
741 if (PDecl->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_copy) {
742 Out << (first ? ' ' : ',') << "copy";
746 if (PDecl->getPropertyAttributes() &
747 ObjCPropertyDecl::OBJC_PR_nonatomic) {
748 Out << (first ? ' ' : ',') << "nonatomic";
753 Out << ' ' << PDecl->getType().getAsString(Policy)
754 << ' ' << PDecl->getNameAsString();
757 void DeclPrinter::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *PID) {
758 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize)
759 Out << "@synthesize ";
762 Out << PID->getPropertyDecl()->getNameAsString();
763 if (PID->getPropertyIvarDecl())
764 Out << "=" << PID->getPropertyIvarDecl()->getNameAsString();