1 //===--- TypePrinter.cpp - Pretty-Print Clang Types -----------------------===//
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 contains code to print types from Clang's type system.
12 //===----------------------------------------------------------------------===//
14 #include "clang/AST/PrettyPrinter.h"
15 #include "clang/AST/ASTContext.h"
16 #include "clang/AST/Decl.h"
17 #include "clang/AST/DeclObjC.h"
18 #include "clang/AST/DeclTemplate.h"
19 #include "clang/AST/Expr.h"
20 #include "clang/AST/Type.h"
21 #include "clang/Basic/LangOptions.h"
22 #include "clang/Basic/SourceManager.h"
23 #include "llvm/ADT/SmallString.h"
24 #include "llvm/ADT/StringExtras.h"
25 #include "llvm/Support/SaveAndRestore.h"
26 #include "llvm/Support/raw_ostream.h"
27 using namespace clang;
30 /// \brief RAII object that enables printing of the ARC __strong lifetime
32 class IncludeStrongLifetimeRAII {
33 PrintingPolicy &Policy;
37 explicit IncludeStrongLifetimeRAII(PrintingPolicy &Policy)
38 : Policy(Policy), Old(Policy.SuppressStrongLifetime) {
39 Policy.SuppressStrongLifetime = false;
42 ~IncludeStrongLifetimeRAII() {
43 Policy.SuppressStrongLifetime = Old;
47 class ParamPolicyRAII {
48 PrintingPolicy &Policy;
52 explicit ParamPolicyRAII(PrintingPolicy &Policy)
53 : Policy(Policy), Old(Policy.SuppressSpecifiers) {
54 Policy.SuppressSpecifiers = false;
58 Policy.SuppressSpecifiers = Old;
62 class ElaboratedTypePolicyRAII {
63 PrintingPolicy &Policy;
64 bool SuppressTagKeyword;
68 explicit ElaboratedTypePolicyRAII(PrintingPolicy &Policy) : Policy(Policy) {
69 SuppressTagKeyword = Policy.SuppressTagKeyword;
70 SuppressScope = Policy.SuppressScope;
71 Policy.SuppressTagKeyword = true;
72 Policy.SuppressScope = true;
75 ~ElaboratedTypePolicyRAII() {
76 Policy.SuppressTagKeyword = SuppressTagKeyword;
77 Policy.SuppressScope = SuppressScope;
82 PrintingPolicy Policy;
83 bool HasEmptyPlaceHolder;
86 explicit TypePrinter(const PrintingPolicy &Policy)
87 : Policy(Policy), HasEmptyPlaceHolder(false) { }
89 void print(const Type *ty, Qualifiers qs, raw_ostream &OS,
90 StringRef PlaceHolder);
91 void print(QualType T, raw_ostream &OS, StringRef PlaceHolder);
93 static bool canPrefixQualifiers(const Type *T, bool &NeedARCStrongQualifier);
94 void spaceBeforePlaceHolder(raw_ostream &OS);
95 void printTypeSpec(const NamedDecl *D, raw_ostream &OS);
97 void printBefore(const Type *ty, Qualifiers qs, raw_ostream &OS);
98 void printBefore(QualType T, raw_ostream &OS);
99 void printAfter(const Type *ty, Qualifiers qs, raw_ostream &OS);
100 void printAfter(QualType T, raw_ostream &OS);
101 void AppendScope(DeclContext *DC, raw_ostream &OS);
102 void printTag(TagDecl *T, raw_ostream &OS);
103 #define ABSTRACT_TYPE(CLASS, PARENT)
104 #define TYPE(CLASS, PARENT) \
105 void print##CLASS##Before(const CLASS##Type *T, raw_ostream &OS); \
106 void print##CLASS##After(const CLASS##Type *T, raw_ostream &OS);
107 #include "clang/AST/TypeNodes.def"
111 static void AppendTypeQualList(raw_ostream &OS, unsigned TypeQuals) {
112 bool appendSpace = false;
113 if (TypeQuals & Qualifiers::Const) {
117 if (TypeQuals & Qualifiers::Volatile) {
118 if (appendSpace) OS << ' ';
122 if (TypeQuals & Qualifiers::Restrict) {
123 if (appendSpace) OS << ' ';
128 void TypePrinter::spaceBeforePlaceHolder(raw_ostream &OS) {
129 if (!HasEmptyPlaceHolder)
133 void TypePrinter::print(QualType t, raw_ostream &OS, StringRef PlaceHolder) {
134 SplitQualType split = t.split();
135 print(split.Ty, split.Quals, OS, PlaceHolder);
138 void TypePrinter::print(const Type *T, Qualifiers Quals, raw_ostream &OS,
139 StringRef PlaceHolder) {
145 SaveAndRestore<bool> PHVal(HasEmptyPlaceHolder, PlaceHolder.empty());
147 printBefore(T, Quals, OS);
149 printAfter(T, Quals, OS);
152 bool TypePrinter::canPrefixQualifiers(const Type *T,
153 bool &NeedARCStrongQualifier) {
154 // CanPrefixQualifiers - We prefer to print type qualifiers before the type,
155 // so that we get "const int" instead of "int const", but we can't do this if
156 // the type is complex. For example if the type is "int*", we *must* print
157 // "int * const", printing "const int *" is different. Only do this when the
158 // type expands to a simple string.
159 bool CanPrefixQualifiers = false;
160 NeedARCStrongQualifier = false;
161 Type::TypeClass TC = T->getTypeClass();
162 if (const AutoType *AT = dyn_cast<AutoType>(T))
163 TC = AT->desugar()->getTypeClass();
164 if (const SubstTemplateTypeParmType *Subst
165 = dyn_cast<SubstTemplateTypeParmType>(T))
166 TC = Subst->getReplacementType()->getTypeClass();
171 case Type::UnresolvedUsing:
173 case Type::TypeOfExpr:
176 case Type::UnaryTransform:
179 case Type::Elaborated:
180 case Type::TemplateTypeParm:
181 case Type::SubstTemplateTypeParmPack:
182 case Type::TemplateSpecialization:
183 case Type::InjectedClassName:
184 case Type::DependentName:
185 case Type::DependentTemplateSpecialization:
186 case Type::ObjCObject:
187 case Type::ObjCInterface:
189 CanPrefixQualifiers = true;
192 case Type::ObjCObjectPointer:
193 CanPrefixQualifiers = T->isObjCIdType() || T->isObjCClassType() ||
194 T->isObjCQualifiedIdType() || T->isObjCQualifiedClassType();
197 case Type::ConstantArray:
198 case Type::IncompleteArray:
199 case Type::VariableArray:
200 case Type::DependentSizedArray:
201 NeedARCStrongQualifier = true;
205 case Type::BlockPointer:
206 case Type::LValueReference:
207 case Type::RValueReference:
208 case Type::MemberPointer:
209 case Type::DependentSizedExtVector:
211 case Type::ExtVector:
212 case Type::FunctionProto:
213 case Type::FunctionNoProto:
215 case Type::Attributed:
216 case Type::PackExpansion:
217 case Type::SubstTemplateTypeParm:
219 CanPrefixQualifiers = false;
223 return CanPrefixQualifiers;
226 void TypePrinter::printBefore(QualType T, raw_ostream &OS) {
227 SplitQualType Split = T.split();
229 // If we have cv1 T, where T is substituted for cv2 U, only print cv1 - cv2
231 Qualifiers Quals = Split.Quals;
232 if (const SubstTemplateTypeParmType *Subst =
233 dyn_cast<SubstTemplateTypeParmType>(Split.Ty))
234 Quals -= QualType(Subst, 0).getQualifiers();
236 printBefore(Split.Ty, Quals, OS);
239 /// \brief Prints the part of the type string before an identifier, e.g. for
240 /// "int foo[10]" it prints "int ".
241 void TypePrinter::printBefore(const Type *T,Qualifiers Quals, raw_ostream &OS) {
242 if (Policy.SuppressSpecifiers && T->isSpecifierType())
245 SaveAndRestore<bool> PrevPHIsEmpty(HasEmptyPlaceHolder);
247 // Print qualifiers as appropriate.
249 bool CanPrefixQualifiers = false;
250 bool NeedARCStrongQualifier = false;
251 CanPrefixQualifiers = canPrefixQualifiers(T, NeedARCStrongQualifier);
253 if (CanPrefixQualifiers && !Quals.empty()) {
254 if (NeedARCStrongQualifier) {
255 IncludeStrongLifetimeRAII Strong(Policy);
256 Quals.print(OS, Policy, /*appendSpaceIfNonEmpty=*/true);
258 Quals.print(OS, Policy, /*appendSpaceIfNonEmpty=*/true);
262 bool hasAfterQuals = false;
263 if (!CanPrefixQualifiers && !Quals.empty()) {
264 hasAfterQuals = !Quals.isEmptyWhenPrinted(Policy);
266 HasEmptyPlaceHolder = false;
269 switch (T->getTypeClass()) {
270 #define ABSTRACT_TYPE(CLASS, PARENT)
271 #define TYPE(CLASS, PARENT) case Type::CLASS: \
272 print##CLASS##Before(cast<CLASS##Type>(T), OS); \
274 #include "clang/AST/TypeNodes.def"
278 if (NeedARCStrongQualifier) {
279 IncludeStrongLifetimeRAII Strong(Policy);
280 Quals.print(OS, Policy, /*appendSpaceIfNonEmpty=*/!PrevPHIsEmpty.get());
282 Quals.print(OS, Policy, /*appendSpaceIfNonEmpty=*/!PrevPHIsEmpty.get());
287 void TypePrinter::printAfter(QualType t, raw_ostream &OS) {
288 SplitQualType split = t.split();
289 printAfter(split.Ty, split.Quals, OS);
292 /// \brief Prints the part of the type string after an identifier, e.g. for
293 /// "int foo[10]" it prints "[10]".
294 void TypePrinter::printAfter(const Type *T, Qualifiers Quals, raw_ostream &OS) {
295 switch (T->getTypeClass()) {
296 #define ABSTRACT_TYPE(CLASS, PARENT)
297 #define TYPE(CLASS, PARENT) case Type::CLASS: \
298 print##CLASS##After(cast<CLASS##Type>(T), OS); \
300 #include "clang/AST/TypeNodes.def"
304 void TypePrinter::printBuiltinBefore(const BuiltinType *T, raw_ostream &OS) {
305 OS << T->getName(Policy);
306 spaceBeforePlaceHolder(OS);
308 void TypePrinter::printBuiltinAfter(const BuiltinType *T, raw_ostream &OS) { }
310 void TypePrinter::printComplexBefore(const ComplexType *T, raw_ostream &OS) {
312 printBefore(T->getElementType(), OS);
314 void TypePrinter::printComplexAfter(const ComplexType *T, raw_ostream &OS) {
315 printAfter(T->getElementType(), OS);
318 void TypePrinter::printPointerBefore(const PointerType *T, raw_ostream &OS) {
319 IncludeStrongLifetimeRAII Strong(Policy);
320 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
321 printBefore(T->getPointeeType(), OS);
322 // Handle things like 'int (*A)[4];' correctly.
323 // FIXME: this should include vectors, but vectors use attributes I guess.
324 if (isa<ArrayType>(T->getPointeeType()))
328 void TypePrinter::printPointerAfter(const PointerType *T, raw_ostream &OS) {
329 IncludeStrongLifetimeRAII Strong(Policy);
330 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
331 // Handle things like 'int (*A)[4];' correctly.
332 // FIXME: this should include vectors, but vectors use attributes I guess.
333 if (isa<ArrayType>(T->getPointeeType()))
335 printAfter(T->getPointeeType(), OS);
338 void TypePrinter::printBlockPointerBefore(const BlockPointerType *T,
340 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
341 printBefore(T->getPointeeType(), OS);
344 void TypePrinter::printBlockPointerAfter(const BlockPointerType *T,
346 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
347 printAfter(T->getPointeeType(), OS);
350 void TypePrinter::printLValueReferenceBefore(const LValueReferenceType *T,
352 IncludeStrongLifetimeRAII Strong(Policy);
353 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
354 printBefore(T->getPointeeTypeAsWritten(), OS);
355 // Handle things like 'int (&A)[4];' correctly.
356 // FIXME: this should include vectors, but vectors use attributes I guess.
357 if (isa<ArrayType>(T->getPointeeTypeAsWritten()))
361 void TypePrinter::printLValueReferenceAfter(const LValueReferenceType *T,
363 IncludeStrongLifetimeRAII Strong(Policy);
364 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
365 // Handle things like 'int (&A)[4];' correctly.
366 // FIXME: this should include vectors, but vectors use attributes I guess.
367 if (isa<ArrayType>(T->getPointeeTypeAsWritten()))
369 printAfter(T->getPointeeTypeAsWritten(), OS);
372 void TypePrinter::printRValueReferenceBefore(const RValueReferenceType *T,
374 IncludeStrongLifetimeRAII Strong(Policy);
375 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
376 printBefore(T->getPointeeTypeAsWritten(), OS);
377 // Handle things like 'int (&&A)[4];' correctly.
378 // FIXME: this should include vectors, but vectors use attributes I guess.
379 if (isa<ArrayType>(T->getPointeeTypeAsWritten()))
383 void TypePrinter::printRValueReferenceAfter(const RValueReferenceType *T,
385 IncludeStrongLifetimeRAII Strong(Policy);
386 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
387 // Handle things like 'int (&&A)[4];' correctly.
388 // FIXME: this should include vectors, but vectors use attributes I guess.
389 if (isa<ArrayType>(T->getPointeeTypeAsWritten()))
391 printAfter(T->getPointeeTypeAsWritten(), OS);
394 void TypePrinter::printMemberPointerBefore(const MemberPointerType *T,
396 IncludeStrongLifetimeRAII Strong(Policy);
397 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
398 printBefore(T->getPointeeType(), OS);
399 // Handle things like 'int (Cls::*A)[4];' correctly.
400 // FIXME: this should include vectors, but vectors use attributes I guess.
401 if (isa<ArrayType>(T->getPointeeType()))
404 PrintingPolicy InnerPolicy(Policy);
405 InnerPolicy.SuppressTag = false;
406 TypePrinter(InnerPolicy).print(QualType(T->getClass(), 0), OS, StringRef());
410 void TypePrinter::printMemberPointerAfter(const MemberPointerType *T,
412 IncludeStrongLifetimeRAII Strong(Policy);
413 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
414 // Handle things like 'int (Cls::*A)[4];' correctly.
415 // FIXME: this should include vectors, but vectors use attributes I guess.
416 if (isa<ArrayType>(T->getPointeeType()))
418 printAfter(T->getPointeeType(), OS);
421 void TypePrinter::printConstantArrayBefore(const ConstantArrayType *T,
423 IncludeStrongLifetimeRAII Strong(Policy);
424 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
425 printBefore(T->getElementType(), OS);
427 void TypePrinter::printConstantArrayAfter(const ConstantArrayType *T,
429 OS << '[' << T->getSize().getZExtValue() << ']';
430 printAfter(T->getElementType(), OS);
433 void TypePrinter::printIncompleteArrayBefore(const IncompleteArrayType *T,
435 IncludeStrongLifetimeRAII Strong(Policy);
436 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
437 printBefore(T->getElementType(), OS);
439 void TypePrinter::printIncompleteArrayAfter(const IncompleteArrayType *T,
442 printAfter(T->getElementType(), OS);
445 void TypePrinter::printVariableArrayBefore(const VariableArrayType *T,
447 IncludeStrongLifetimeRAII Strong(Policy);
448 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
449 printBefore(T->getElementType(), OS);
451 void TypePrinter::printVariableArrayAfter(const VariableArrayType *T,
454 if (T->getIndexTypeQualifiers().hasQualifiers()) {
455 AppendTypeQualList(OS, T->getIndexTypeCVRQualifiers());
459 if (T->getSizeModifier() == VariableArrayType::Static)
461 else if (T->getSizeModifier() == VariableArrayType::Star)
464 if (T->getSizeExpr())
465 T->getSizeExpr()->printPretty(OS, 0, Policy);
468 printAfter(T->getElementType(), OS);
471 void TypePrinter::printDependentSizedArrayBefore(
472 const DependentSizedArrayType *T,
474 IncludeStrongLifetimeRAII Strong(Policy);
475 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
476 printBefore(T->getElementType(), OS);
478 void TypePrinter::printDependentSizedArrayAfter(
479 const DependentSizedArrayType *T,
482 if (T->getSizeExpr())
483 T->getSizeExpr()->printPretty(OS, 0, Policy);
485 printAfter(T->getElementType(), OS);
488 void TypePrinter::printDependentSizedExtVectorBefore(
489 const DependentSizedExtVectorType *T,
491 printBefore(T->getElementType(), OS);
493 void TypePrinter::printDependentSizedExtVectorAfter(
494 const DependentSizedExtVectorType *T,
496 OS << " __attribute__((ext_vector_type(";
497 if (T->getSizeExpr())
498 T->getSizeExpr()->printPretty(OS, 0, Policy);
500 printAfter(T->getElementType(), OS);
503 void TypePrinter::printVectorBefore(const VectorType *T, raw_ostream &OS) {
504 switch (T->getVectorKind()) {
505 case VectorType::AltiVecPixel:
506 OS << "__vector __pixel ";
508 case VectorType::AltiVecBool:
509 OS << "__vector __bool ";
510 printBefore(T->getElementType(), OS);
512 case VectorType::AltiVecVector:
514 printBefore(T->getElementType(), OS);
516 case VectorType::NeonVector:
517 OS << "__attribute__((neon_vector_type("
518 << T->getNumElements() << "))) ";
519 printBefore(T->getElementType(), OS);
521 case VectorType::NeonPolyVector:
522 OS << "__attribute__((neon_polyvector_type(" <<
523 T->getNumElements() << "))) ";
524 printBefore(T->getElementType(), OS);
526 case VectorType::GenericVector: {
527 // FIXME: We prefer to print the size directly here, but have no way
528 // to get the size of the type.
529 OS << "__attribute__((__vector_size__("
530 << T->getNumElements()
532 print(T->getElementType(), OS, StringRef());
534 printBefore(T->getElementType(), OS);
539 void TypePrinter::printVectorAfter(const VectorType *T, raw_ostream &OS) {
540 printAfter(T->getElementType(), OS);
543 void TypePrinter::printExtVectorBefore(const ExtVectorType *T,
545 printBefore(T->getElementType(), OS);
547 void TypePrinter::printExtVectorAfter(const ExtVectorType *T, raw_ostream &OS) {
548 printAfter(T->getElementType(), OS);
549 OS << " __attribute__((ext_vector_type(";
550 OS << T->getNumElements();
555 FunctionProtoType::printExceptionSpecification(raw_ostream &OS,
556 const PrintingPolicy &Policy)
559 if (hasDynamicExceptionSpec()) {
561 if (getExceptionSpecType() == EST_MSAny)
564 for (unsigned I = 0, N = getNumExceptions(); I != N; ++I) {
568 OS << getExceptionType(I).stream(Policy);
571 } else if (isNoexceptExceptionSpec(getExceptionSpecType())) {
573 if (getExceptionSpecType() == EST_ComputedNoexcept) {
575 getNoexceptExpr()->printPretty(OS, 0, Policy);
581 void TypePrinter::printFunctionProtoBefore(const FunctionProtoType *T,
583 if (T->hasTrailingReturn()) {
585 if (!HasEmptyPlaceHolder)
588 // If needed for precedence reasons, wrap the inner part in grouping parens.
589 SaveAndRestore<bool> PrevPHIsEmpty(HasEmptyPlaceHolder, false);
590 printBefore(T->getResultType(), OS);
591 if (!PrevPHIsEmpty.get())
596 void TypePrinter::printFunctionProtoAfter(const FunctionProtoType *T,
598 // If needed for precedence reasons, wrap the inner part in grouping parens.
599 if (!HasEmptyPlaceHolder)
601 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
605 ParamPolicyRAII ParamPolicy(Policy);
606 for (unsigned i = 0, e = T->getNumArgs(); i != e; ++i) {
608 print(T->getArgType(i), OS, StringRef());
612 if (T->isVariadic()) {
616 } else if (T->getNumArgs() == 0 && !Policy.LangOpts.CPlusPlus) {
617 // Do not emit int() if we have a proto, emit 'int(void)'.
623 FunctionType::ExtInfo Info = T->getExtInfo();
624 switch(Info.getCC()) {
625 case CC_Default: break;
627 OS << " __attribute__((cdecl))";
630 OS << " __attribute__((stdcall))";
633 OS << " __attribute__((fastcall))";
636 OS << " __attribute__((thiscall))";
639 OS << " __attribute__((pascal))";
642 OS << " __attribute__((pcs(\"aapcs\")))";
645 OS << " __attribute__((pcs(\"aapcs-vfp\")))";
648 OS << " __attribute__((pnaclcall))";
650 case CC_IntelOclBicc:
651 OS << " __attribute__((intel_ocl_bicc))";
654 if (Info.getNoReturn())
655 OS << " __attribute__((noreturn))";
656 if (Info.getRegParm())
657 OS << " __attribute__((regparm ("
658 << Info.getRegParm() << ")))";
660 if (unsigned quals = T->getTypeQuals()) {
662 AppendTypeQualList(OS, quals);
665 switch (T->getRefQualifier()) {
677 T->printExceptionSpecification(OS, Policy);
679 if (T->hasTrailingReturn()) {
681 print(T->getResultType(), OS, StringRef());
683 printAfter(T->getResultType(), OS);
686 void TypePrinter::printFunctionNoProtoBefore(const FunctionNoProtoType *T,
688 // If needed for precedence reasons, wrap the inner part in grouping parens.
689 SaveAndRestore<bool> PrevPHIsEmpty(HasEmptyPlaceHolder, false);
690 printBefore(T->getResultType(), OS);
691 if (!PrevPHIsEmpty.get())
694 void TypePrinter::printFunctionNoProtoAfter(const FunctionNoProtoType *T,
696 // If needed for precedence reasons, wrap the inner part in grouping parens.
697 if (!HasEmptyPlaceHolder)
699 SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
702 if (T->getNoReturnAttr())
703 OS << " __attribute__((noreturn))";
704 printAfter(T->getResultType(), OS);
707 void TypePrinter::printTypeSpec(const NamedDecl *D, raw_ostream &OS) {
708 IdentifierInfo *II = D->getIdentifier();
710 spaceBeforePlaceHolder(OS);
713 void TypePrinter::printUnresolvedUsingBefore(const UnresolvedUsingType *T,
715 printTypeSpec(T->getDecl(), OS);
717 void TypePrinter::printUnresolvedUsingAfter(const UnresolvedUsingType *T,
720 void TypePrinter::printTypedefBefore(const TypedefType *T, raw_ostream &OS) {
721 printTypeSpec(T->getDecl(), OS);
723 void TypePrinter::printTypedefAfter(const TypedefType *T, raw_ostream &OS) { }
725 void TypePrinter::printTypeOfExprBefore(const TypeOfExprType *T,
728 T->getUnderlyingExpr()->printPretty(OS, 0, Policy);
729 spaceBeforePlaceHolder(OS);
731 void TypePrinter::printTypeOfExprAfter(const TypeOfExprType *T,
734 void TypePrinter::printTypeOfBefore(const TypeOfType *T, raw_ostream &OS) {
736 print(T->getUnderlyingType(), OS, StringRef());
738 spaceBeforePlaceHolder(OS);
740 void TypePrinter::printTypeOfAfter(const TypeOfType *T, raw_ostream &OS) { }
742 void TypePrinter::printDecltypeBefore(const DecltypeType *T, raw_ostream &OS) {
744 T->getUnderlyingExpr()->printPretty(OS, 0, Policy);
746 spaceBeforePlaceHolder(OS);
748 void TypePrinter::printDecltypeAfter(const DecltypeType *T, raw_ostream &OS) { }
750 void TypePrinter::printUnaryTransformBefore(const UnaryTransformType *T,
752 IncludeStrongLifetimeRAII Strong(Policy);
754 switch (T->getUTTKind()) {
755 case UnaryTransformType::EnumUnderlyingType:
756 OS << "__underlying_type(";
757 print(T->getBaseType(), OS, StringRef());
759 spaceBeforePlaceHolder(OS);
763 printBefore(T->getBaseType(), OS);
765 void TypePrinter::printUnaryTransformAfter(const UnaryTransformType *T,
767 IncludeStrongLifetimeRAII Strong(Policy);
769 switch (T->getUTTKind()) {
770 case UnaryTransformType::EnumUnderlyingType:
774 printAfter(T->getBaseType(), OS);
777 void TypePrinter::printAutoBefore(const AutoType *T, raw_ostream &OS) {
778 // If the type has been deduced, do not print 'auto'.
779 if (!T->getDeducedType().isNull()) {
780 printBefore(T->getDeducedType(), OS);
782 OS << (T->isDecltypeAuto() ? "decltype(auto)" : "auto");
783 spaceBeforePlaceHolder(OS);
786 void TypePrinter::printAutoAfter(const AutoType *T, raw_ostream &OS) {
787 // If the type has been deduced, do not print 'auto'.
788 if (!T->getDeducedType().isNull())
789 printAfter(T->getDeducedType(), OS);
792 void TypePrinter::printAtomicBefore(const AtomicType *T, raw_ostream &OS) {
793 IncludeStrongLifetimeRAII Strong(Policy);
796 print(T->getValueType(), OS, StringRef());
798 spaceBeforePlaceHolder(OS);
800 void TypePrinter::printAtomicAfter(const AtomicType *T, raw_ostream &OS) { }
802 /// Appends the given scope to the end of a string.
803 void TypePrinter::AppendScope(DeclContext *DC, raw_ostream &OS) {
804 if (DC->isTranslationUnit()) return;
805 if (DC->isFunctionOrMethod()) return;
806 AppendScope(DC->getParent(), OS);
808 if (NamespaceDecl *NS = dyn_cast<NamespaceDecl>(DC)) {
809 if (Policy.SuppressUnwrittenScope &&
810 (NS->isAnonymousNamespace() || NS->isInline()))
812 if (NS->getIdentifier())
813 OS << NS->getName() << "::";
815 OS << "<anonymous>::";
816 } else if (ClassTemplateSpecializationDecl *Spec
817 = dyn_cast<ClassTemplateSpecializationDecl>(DC)) {
818 IncludeStrongLifetimeRAII Strong(Policy);
819 OS << Spec->getIdentifier()->getName();
820 const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
821 TemplateSpecializationType::PrintTemplateArgumentList(OS,
826 } else if (TagDecl *Tag = dyn_cast<TagDecl>(DC)) {
827 if (TypedefNameDecl *Typedef = Tag->getTypedefNameForAnonDecl())
828 OS << Typedef->getIdentifier()->getName() << "::";
829 else if (Tag->getIdentifier())
830 OS << Tag->getIdentifier()->getName() << "::";
836 void TypePrinter::printTag(TagDecl *D, raw_ostream &OS) {
837 if (Policy.SuppressTag)
840 bool HasKindDecoration = false;
842 // bool SuppressTagKeyword
843 // = Policy.LangOpts.CPlusPlus || Policy.SuppressTagKeyword;
845 // We don't print tags unless this is an elaborated type.
846 // In C, we just assume every RecordType is an elaborated type.
847 if (!(Policy.LangOpts.CPlusPlus || Policy.SuppressTagKeyword ||
848 D->getTypedefNameForAnonDecl())) {
849 HasKindDecoration = true;
850 OS << D->getKindName();
854 // Compute the full nested-name-specifier for this type.
855 // In C, this will always be empty except when the type
856 // being printed is anonymous within other Record.
857 if (!Policy.SuppressScope)
858 AppendScope(D->getDeclContext(), OS);
860 if (const IdentifierInfo *II = D->getIdentifier())
862 else if (TypedefNameDecl *Typedef = D->getTypedefNameForAnonDecl()) {
863 assert(Typedef->getIdentifier() && "Typedef without identifier?");
864 OS << Typedef->getIdentifier()->getName();
866 // Make an unambiguous representation for anonymous types, e.g.
867 // <anonymous enum at /usr/include/string.h:120:9>
869 if (isa<CXXRecordDecl>(D) && cast<CXXRecordDecl>(D)->isLambda()) {
871 HasKindDecoration = true;
876 if (Policy.AnonymousTagLocations) {
877 // Suppress the redundant tag keyword if we just printed one.
878 // We don't have to worry about ElaboratedTypes here because you can't
879 // refer to an anonymous type with one.
880 if (!HasKindDecoration)
881 OS << " " << D->getKindName();
883 PresumedLoc PLoc = D->getASTContext().getSourceManager().getPresumedLoc(
885 if (PLoc.isValid()) {
886 OS << " at " << PLoc.getFilename()
887 << ':' << PLoc.getLine()
888 << ':' << PLoc.getColumn();
895 // If this is a class template specialization, print the template
897 if (ClassTemplateSpecializationDecl *Spec
898 = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
899 const TemplateArgument *Args;
901 if (TypeSourceInfo *TAW = Spec->getTypeAsWritten()) {
902 const TemplateSpecializationType *TST =
903 cast<TemplateSpecializationType>(TAW->getType());
904 Args = TST->getArgs();
905 NumArgs = TST->getNumArgs();
907 const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
908 Args = TemplateArgs.data();
909 NumArgs = TemplateArgs.size();
911 IncludeStrongLifetimeRAII Strong(Policy);
912 TemplateSpecializationType::PrintTemplateArgumentList(OS,
917 spaceBeforePlaceHolder(OS);
920 void TypePrinter::printRecordBefore(const RecordType *T, raw_ostream &OS) {
921 printTag(T->getDecl(), OS);
923 void TypePrinter::printRecordAfter(const RecordType *T, raw_ostream &OS) { }
925 void TypePrinter::printEnumBefore(const EnumType *T, raw_ostream &OS) {
926 printTag(T->getDecl(), OS);
928 void TypePrinter::printEnumAfter(const EnumType *T, raw_ostream &OS) { }
930 void TypePrinter::printTemplateTypeParmBefore(const TemplateTypeParmType *T,
932 if (IdentifierInfo *Id = T->getIdentifier())
935 OS << "type-parameter-" << T->getDepth() << '-' << T->getIndex();
936 spaceBeforePlaceHolder(OS);
938 void TypePrinter::printTemplateTypeParmAfter(const TemplateTypeParmType *T,
941 void TypePrinter::printSubstTemplateTypeParmBefore(
942 const SubstTemplateTypeParmType *T,
944 IncludeStrongLifetimeRAII Strong(Policy);
945 printBefore(T->getReplacementType(), OS);
947 void TypePrinter::printSubstTemplateTypeParmAfter(
948 const SubstTemplateTypeParmType *T,
950 IncludeStrongLifetimeRAII Strong(Policy);
951 printAfter(T->getReplacementType(), OS);
954 void TypePrinter::printSubstTemplateTypeParmPackBefore(
955 const SubstTemplateTypeParmPackType *T,
957 IncludeStrongLifetimeRAII Strong(Policy);
958 printTemplateTypeParmBefore(T->getReplacedParameter(), OS);
960 void TypePrinter::printSubstTemplateTypeParmPackAfter(
961 const SubstTemplateTypeParmPackType *T,
963 IncludeStrongLifetimeRAII Strong(Policy);
964 printTemplateTypeParmAfter(T->getReplacedParameter(), OS);
967 void TypePrinter::printTemplateSpecializationBefore(
968 const TemplateSpecializationType *T,
970 IncludeStrongLifetimeRAII Strong(Policy);
971 T->getTemplateName().print(OS, Policy);
973 TemplateSpecializationType::PrintTemplateArgumentList(OS,
977 spaceBeforePlaceHolder(OS);
979 void TypePrinter::printTemplateSpecializationAfter(
980 const TemplateSpecializationType *T,
983 void TypePrinter::printInjectedClassNameBefore(const InjectedClassNameType *T,
985 printTemplateSpecializationBefore(T->getInjectedTST(), OS);
987 void TypePrinter::printInjectedClassNameAfter(const InjectedClassNameType *T,
990 void TypePrinter::printElaboratedBefore(const ElaboratedType *T,
992 OS << TypeWithKeyword::getKeywordName(T->getKeyword());
993 if (T->getKeyword() != ETK_None)
995 NestedNameSpecifier* Qualifier = T->getQualifier();
997 Qualifier->print(OS, Policy);
999 ElaboratedTypePolicyRAII PolicyRAII(Policy);
1000 printBefore(T->getNamedType(), OS);
1002 void TypePrinter::printElaboratedAfter(const ElaboratedType *T,
1004 ElaboratedTypePolicyRAII PolicyRAII(Policy);
1005 printAfter(T->getNamedType(), OS);
1008 void TypePrinter::printParenBefore(const ParenType *T, raw_ostream &OS) {
1009 if (!HasEmptyPlaceHolder && !isa<FunctionType>(T->getInnerType())) {
1010 printBefore(T->getInnerType(), OS);
1013 printBefore(T->getInnerType(), OS);
1015 void TypePrinter::printParenAfter(const ParenType *T, raw_ostream &OS) {
1016 if (!HasEmptyPlaceHolder && !isa<FunctionType>(T->getInnerType())) {
1018 printAfter(T->getInnerType(), OS);
1020 printAfter(T->getInnerType(), OS);
1023 void TypePrinter::printDependentNameBefore(const DependentNameType *T,
1025 OS << TypeWithKeyword::getKeywordName(T->getKeyword());
1026 if (T->getKeyword() != ETK_None)
1029 T->getQualifier()->print(OS, Policy);
1031 OS << T->getIdentifier()->getName();
1032 spaceBeforePlaceHolder(OS);
1034 void TypePrinter::printDependentNameAfter(const DependentNameType *T,
1035 raw_ostream &OS) { }
1037 void TypePrinter::printDependentTemplateSpecializationBefore(
1038 const DependentTemplateSpecializationType *T, raw_ostream &OS) {
1039 IncludeStrongLifetimeRAII Strong(Policy);
1041 OS << TypeWithKeyword::getKeywordName(T->getKeyword());
1042 if (T->getKeyword() != ETK_None)
1045 if (T->getQualifier())
1046 T->getQualifier()->print(OS, Policy);
1047 OS << T->getIdentifier()->getName();
1048 TemplateSpecializationType::PrintTemplateArgumentList(OS,
1052 spaceBeforePlaceHolder(OS);
1054 void TypePrinter::printDependentTemplateSpecializationAfter(
1055 const DependentTemplateSpecializationType *T, raw_ostream &OS) { }
1057 void TypePrinter::printPackExpansionBefore(const PackExpansionType *T,
1059 printBefore(T->getPattern(), OS);
1061 void TypePrinter::printPackExpansionAfter(const PackExpansionType *T,
1063 printAfter(T->getPattern(), OS);
1067 void TypePrinter::printAttributedBefore(const AttributedType *T,
1069 // Prefer the macro forms of the GC and ownership qualifiers.
1070 if (T->getAttrKind() == AttributedType::attr_objc_gc ||
1071 T->getAttrKind() == AttributedType::attr_objc_ownership)
1072 return printBefore(T->getEquivalentType(), OS);
1074 printBefore(T->getModifiedType(), OS);
1077 void TypePrinter::printAttributedAfter(const AttributedType *T,
1079 // Prefer the macro forms of the GC and ownership qualifiers.
1080 if (T->getAttrKind() == AttributedType::attr_objc_gc ||
1081 T->getAttrKind() == AttributedType::attr_objc_ownership)
1082 return printAfter(T->getEquivalentType(), OS);
1084 // TODO: not all attributes are GCC-style attributes.
1085 OS << " __attribute__((";
1086 switch (T->getAttrKind()) {
1087 case AttributedType::attr_address_space:
1088 OS << "address_space(";
1089 OS << T->getEquivalentType().getAddressSpace();
1093 case AttributedType::attr_vector_size: {
1094 OS << "__vector_size__(";
1095 if (const VectorType *vector =T->getEquivalentType()->getAs<VectorType>()) {
1096 OS << vector->getNumElements();
1098 print(vector->getElementType(), OS, StringRef());
1105 case AttributedType::attr_neon_vector_type:
1106 case AttributedType::attr_neon_polyvector_type: {
1107 if (T->getAttrKind() == AttributedType::attr_neon_vector_type)
1108 OS << "neon_vector_type(";
1110 OS << "neon_polyvector_type(";
1111 const VectorType *vector = T->getEquivalentType()->getAs<VectorType>();
1112 OS << vector->getNumElements();
1117 case AttributedType::attr_regparm: {
1119 QualType t = T->getEquivalentType();
1120 while (!t->isFunctionType())
1121 t = t->getPointeeType();
1122 OS << t->getAs<FunctionType>()->getRegParmType();
1127 case AttributedType::attr_objc_gc: {
1130 QualType tmp = T->getEquivalentType();
1131 while (tmp.getObjCGCAttr() == Qualifiers::GCNone) {
1132 QualType next = tmp->getPointeeType();
1133 if (next == tmp) break;
1137 if (tmp.isObjCGCWeak())
1145 case AttributedType::attr_objc_ownership:
1146 OS << "objc_ownership(";
1147 switch (T->getEquivalentType().getObjCLifetime()) {
1148 case Qualifiers::OCL_None: llvm_unreachable("no ownership!");
1149 case Qualifiers::OCL_ExplicitNone: OS << "none"; break;
1150 case Qualifiers::OCL_Strong: OS << "strong"; break;
1151 case Qualifiers::OCL_Weak: OS << "weak"; break;
1152 case Qualifiers::OCL_Autoreleasing: OS << "autoreleasing"; break;
1157 case AttributedType::attr_noreturn: OS << "noreturn"; break;
1158 case AttributedType::attr_cdecl: OS << "cdecl"; break;
1159 case AttributedType::attr_fastcall: OS << "fastcall"; break;
1160 case AttributedType::attr_stdcall: OS << "stdcall"; break;
1161 case AttributedType::attr_thiscall: OS << "thiscall"; break;
1162 case AttributedType::attr_pascal: OS << "pascal"; break;
1163 case AttributedType::attr_pcs: {
1165 QualType t = T->getEquivalentType();
1166 while (!t->isFunctionType())
1167 t = t->getPointeeType();
1168 OS << (t->getAs<FunctionType>()->getCallConv() == CC_AAPCS ?
1169 "\"aapcs\"" : "\"aapcs-vfp\"");
1173 case AttributedType::attr_pnaclcall: OS << "pnaclcall"; break;
1174 case AttributedType::attr_inteloclbicc: OS << "inteloclbicc"; break;
1179 void TypePrinter::printObjCInterfaceBefore(const ObjCInterfaceType *T,
1181 OS << T->getDecl()->getName();
1182 spaceBeforePlaceHolder(OS);
1184 void TypePrinter::printObjCInterfaceAfter(const ObjCInterfaceType *T,
1185 raw_ostream &OS) { }
1187 void TypePrinter::printObjCObjectBefore(const ObjCObjectType *T,
1189 if (T->qual_empty())
1190 return printBefore(T->getBaseType(), OS);
1192 print(T->getBaseType(), OS, StringRef());
1194 bool isFirst = true;
1195 for (ObjCObjectType::qual_iterator
1196 I = T->qual_begin(), E = T->qual_end(); I != E; ++I) {
1201 OS << (*I)->getName();
1204 spaceBeforePlaceHolder(OS);
1206 void TypePrinter::printObjCObjectAfter(const ObjCObjectType *T,
1208 if (T->qual_empty())
1209 return printAfter(T->getBaseType(), OS);
1212 void TypePrinter::printObjCObjectPointerBefore(const ObjCObjectPointerType *T,
1214 T->getPointeeType().getLocalQualifiers().print(OS, Policy,
1215 /*appendSpaceIfNonEmpty=*/true);
1217 if (T->isObjCIdType() || T->isObjCQualifiedIdType())
1219 else if (T->isObjCClassType() || T->isObjCQualifiedClassType())
1221 else if (T->isObjCSelType())
1224 OS << T->getInterfaceDecl()->getName();
1226 if (!T->qual_empty()) {
1228 for (ObjCObjectPointerType::qual_iterator I = T->qual_begin(),
1231 OS << (*I)->getName();
1238 if (!T->isObjCIdType() && !T->isObjCQualifiedIdType()) {
1239 OS << " *"; // Don't forget the implicit pointer.
1241 spaceBeforePlaceHolder(OS);
1244 void TypePrinter::printObjCObjectPointerAfter(const ObjCObjectPointerType *T,
1245 raw_ostream &OS) { }
1247 void TemplateSpecializationType::
1248 PrintTemplateArgumentList(raw_ostream &OS,
1249 const TemplateArgumentListInfo &Args,
1250 const PrintingPolicy &Policy) {
1251 return PrintTemplateArgumentList(OS,
1252 Args.getArgumentArray(),
1258 TemplateSpecializationType::PrintTemplateArgumentList(
1260 const TemplateArgument *Args,
1262 const PrintingPolicy &Policy,
1263 bool SkipBrackets) {
1267 bool needSpace = false;
1268 for (unsigned Arg = 0; Arg < NumArgs; ++Arg) {
1272 // Print the argument into a string.
1273 SmallString<128> Buf;
1274 llvm::raw_svector_ostream ArgOS(Buf);
1275 if (Args[Arg].getKind() == TemplateArgument::Pack) {
1276 PrintTemplateArgumentList(ArgOS,
1277 Args[Arg].pack_begin(),
1278 Args[Arg].pack_size(),
1281 Args[Arg].print(Policy, ArgOS);
1283 StringRef ArgString = ArgOS.str();
1285 // If this is the first argument and its string representation
1286 // begins with the global scope specifier ('::foo'), add a space
1287 // to avoid printing the diagraph '<:'.
1288 if (!Arg && !ArgString.empty() && ArgString[0] == ':')
1293 needSpace = (!ArgString.empty() && ArgString.back() == '>');
1296 // If the last character of our string is '>', add another space to
1297 // keep the two '>''s separate tokens. We don't *have* to do this in
1298 // C++0x, but it's still good hygiene.
1306 // Sadly, repeat all that with TemplateArgLoc.
1307 void TemplateSpecializationType::
1308 PrintTemplateArgumentList(raw_ostream &OS,
1309 const TemplateArgumentLoc *Args, unsigned NumArgs,
1310 const PrintingPolicy &Policy) {
1313 bool needSpace = false;
1314 for (unsigned Arg = 0; Arg < NumArgs; ++Arg) {
1318 // Print the argument into a string.
1319 SmallString<128> Buf;
1320 llvm::raw_svector_ostream ArgOS(Buf);
1321 if (Args[Arg].getArgument().getKind() == TemplateArgument::Pack) {
1322 PrintTemplateArgumentList(ArgOS,
1323 Args[Arg].getArgument().pack_begin(),
1324 Args[Arg].getArgument().pack_size(),
1327 Args[Arg].getArgument().print(Policy, ArgOS);
1329 StringRef ArgString = ArgOS.str();
1331 // If this is the first argument and its string representation
1332 // begins with the global scope specifier ('::foo'), add a space
1333 // to avoid printing the diagraph '<:'.
1334 if (!Arg && !ArgString.empty() && ArgString[0] == ':')
1339 needSpace = (!ArgString.empty() && ArgString.back() == '>');
1342 // If the last character of our string is '>', add another space to
1343 // keep the two '>''s separate tokens. We don't *have* to do this in
1344 // C++0x, but it's still good hygiene.
1351 void QualType::dump(const char *msg) const {
1353 llvm::errs() << msg << ": ";
1355 print(llvm::errs(), PrintingPolicy(LO), "identifier");
1356 llvm::errs() << '\n';
1358 void QualType::dump() const {
1362 void Type::dump() const {
1363 QualType(this, 0).dump();
1366 std::string Qualifiers::getAsString() const {
1368 return getAsString(PrintingPolicy(LO));
1371 // Appends qualifiers to the given string, separated by spaces. Will
1372 // prefix a space if the string is non-empty. Will not append a final
1374 std::string Qualifiers::getAsString(const PrintingPolicy &Policy) const {
1375 SmallString<64> Buf;
1376 llvm::raw_svector_ostream StrOS(Buf);
1377 print(StrOS, Policy);
1381 bool Qualifiers::isEmptyWhenPrinted(const PrintingPolicy &Policy) const {
1382 if (getCVRQualifiers())
1385 if (getAddressSpace())
1388 if (getObjCGCAttr())
1391 if (Qualifiers::ObjCLifetime lifetime = getObjCLifetime())
1392 if (!(lifetime == Qualifiers::OCL_Strong && Policy.SuppressStrongLifetime))
1398 // Appends qualifiers to the given string, separated by spaces. Will
1399 // prefix a space if the string is non-empty. Will not append a final
1401 void Qualifiers::print(raw_ostream &OS, const PrintingPolicy& Policy,
1402 bool appendSpaceIfNonEmpty) const {
1403 bool addSpace = false;
1405 unsigned quals = getCVRQualifiers();
1407 AppendTypeQualList(OS, quals);
1410 if (unsigned addrspace = getAddressSpace()) {
1414 switch (addrspace) {
1415 case LangAS::opencl_global:
1418 case LangAS::opencl_local:
1421 case LangAS::opencl_constant:
1425 OS << "__attribute__((address_space(";
1430 if (Qualifiers::GC gc = getObjCGCAttr()) {
1434 if (gc == Qualifiers::Weak)
1439 if (Qualifiers::ObjCLifetime lifetime = getObjCLifetime()) {
1440 if (!(lifetime == Qualifiers::OCL_Strong && Policy.SuppressStrongLifetime)){
1447 case Qualifiers::OCL_None: llvm_unreachable("none but true");
1448 case Qualifiers::OCL_ExplicitNone: OS << "__unsafe_unretained"; break;
1449 case Qualifiers::OCL_Strong:
1450 if (!Policy.SuppressStrongLifetime)
1454 case Qualifiers::OCL_Weak: OS << "__weak"; break;
1455 case Qualifiers::OCL_Autoreleasing: OS << "__autoreleasing"; break;
1459 if (appendSpaceIfNonEmpty && addSpace)
1463 std::string QualType::getAsString(const PrintingPolicy &Policy) const {
1465 getAsStringInternal(S, Policy);
1469 std::string QualType::getAsString(const Type *ty, Qualifiers qs) {
1471 LangOptions options;
1472 getAsStringInternal(ty, qs, buffer, PrintingPolicy(options));
1476 void QualType::print(const Type *ty, Qualifiers qs,
1477 raw_ostream &OS, const PrintingPolicy &policy,
1478 const Twine &PlaceHolder) {
1479 SmallString<128> PHBuf;
1480 StringRef PH = PlaceHolder.toStringRef(PHBuf);
1482 TypePrinter(policy).print(ty, qs, OS, PH);
1485 void QualType::getAsStringInternal(const Type *ty, Qualifiers qs,
1486 std::string &buffer,
1487 const PrintingPolicy &policy) {
1488 SmallString<256> Buf;
1489 llvm::raw_svector_ostream StrOS(Buf);
1490 TypePrinter(policy).print(ty, qs, StrOS, buffer);
1491 std::string str = StrOS.str();