1 //===- TypePrinter.cpp - Pretty-Print Clang Types -------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This contains code to print types from Clang's type system.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "clang/AST/ASTContext.h"
14 #include "clang/AST/Attr.h"
15 #include "clang/AST/Decl.h"
16 #include "clang/AST/DeclBase.h"
17 #include "clang/AST/DeclCXX.h"
18 #include "clang/AST/DeclObjC.h"
19 #include "clang/AST/DeclTemplate.h"
20 #include "clang/AST/Expr.h"
21 #include "clang/AST/NestedNameSpecifier.h"
22 #include "clang/AST/PrettyPrinter.h"
23 #include "clang/AST/TemplateBase.h"
24 #include "clang/AST/TemplateName.h"
25 #include "clang/AST/Type.h"
26 #include "clang/Basic/AddressSpaces.h"
27 #include "clang/Basic/ExceptionSpecificationType.h"
28 #include "clang/Basic/IdentifierTable.h"
29 #include "clang/Basic/LLVM.h"
30 #include "clang/Basic/LangOptions.h"
31 #include "clang/Basic/SourceLocation.h"
32 #include "clang/Basic/SourceManager.h"
33 #include "clang/Basic/Specifiers.h"
34 #include "llvm/ADT/ArrayRef.h"
35 #include "llvm/ADT/SmallString.h"
36 #include "llvm/ADT/StringRef.h"
37 #include "llvm/ADT/Twine.h"
38 #include "llvm/Support/Casting.h"
39 #include "llvm/Support/Compiler.h"
40 #include "llvm/Support/ErrorHandling.h"
41 #include "llvm/Support/SaveAndRestore.h"
42 #include "llvm/Support/raw_ostream.h"
43 #include <cassert>
44 #include <string>
45 
46 using namespace clang;
47 
48 namespace {
49 
50   /// RAII object that enables printing of the ARC __strong lifetime
51   /// qualifier.
52   class IncludeStrongLifetimeRAII {
53     PrintingPolicy &Policy;
54     bool Old;
55 
56   public:
57     explicit IncludeStrongLifetimeRAII(PrintingPolicy &Policy)
58         : Policy(Policy), Old(Policy.SuppressStrongLifetime) {
59         if (!Policy.SuppressLifetimeQualifiers)
60           Policy.SuppressStrongLifetime = false;
61     }
62 
63     ~IncludeStrongLifetimeRAII() {
64       Policy.SuppressStrongLifetime = Old;
65     }
66   };
67 
68   class ParamPolicyRAII {
69     PrintingPolicy &Policy;
70     bool Old;
71 
72   public:
73     explicit ParamPolicyRAII(PrintingPolicy &Policy)
74         : Policy(Policy), Old(Policy.SuppressSpecifiers) {
75       Policy.SuppressSpecifiers = false;
76     }
77 
78     ~ParamPolicyRAII() {
79       Policy.SuppressSpecifiers = Old;
80     }
81   };
82 
83   class ElaboratedTypePolicyRAII {
84     PrintingPolicy &Policy;
85     bool SuppressTagKeyword;
86     bool SuppressScope;
87 
88   public:
89     explicit ElaboratedTypePolicyRAII(PrintingPolicy &Policy) : Policy(Policy) {
90       SuppressTagKeyword = Policy.SuppressTagKeyword;
91       SuppressScope = Policy.SuppressScope;
92       Policy.SuppressTagKeyword = true;
93       Policy.SuppressScope = true;
94     }
95 
96     ~ElaboratedTypePolicyRAII() {
97       Policy.SuppressTagKeyword = SuppressTagKeyword;
98       Policy.SuppressScope = SuppressScope;
99     }
100   };
101 
102   class TypePrinter {
103     PrintingPolicy Policy;
104     unsigned Indentation;
105     bool HasEmptyPlaceHolder = false;
106     bool InsideCCAttribute = false;
107 
108   public:
109     explicit TypePrinter(const PrintingPolicy &Policy, unsigned Indentation = 0)
110         : Policy(Policy), Indentation(Indentation) {}
111 
112     void print(const Type *ty, Qualifiers qs, raw_ostream &OS,
113                StringRef PlaceHolder);
114     void print(QualType T, raw_ostream &OS, StringRef PlaceHolder);
115 
116     static bool canPrefixQualifiers(const Type *T, bool &NeedARCStrongQualifier);
117     void spaceBeforePlaceHolder(raw_ostream &OS);
118     void printTypeSpec(NamedDecl *D, raw_ostream &OS);
119     void printTemplateId(const TemplateSpecializationType *T, raw_ostream &OS,
120                          bool FullyQualify);
121 
122     void printBefore(QualType T, raw_ostream &OS);
123     void printAfter(QualType T, raw_ostream &OS);
124     void AppendScope(DeclContext *DC, raw_ostream &OS,
125                      DeclarationName NameInScope);
126     void printTag(TagDecl *T, raw_ostream &OS);
127     void printFunctionAfter(const FunctionType::ExtInfo &Info, raw_ostream &OS);
128 #define ABSTRACT_TYPE(CLASS, PARENT)
129 #define TYPE(CLASS, PARENT) \
130     void print##CLASS##Before(const CLASS##Type *T, raw_ostream &OS); \
131     void print##CLASS##After(const CLASS##Type *T, raw_ostream &OS);
132 #include "clang/AST/TypeNodes.inc"
133 
134   private:
135     void printBefore(const Type *ty, Qualifiers qs, raw_ostream &OS);
136     void printAfter(const Type *ty, Qualifiers qs, raw_ostream &OS);
137   };
138 
139 } // namespace
140 
141 static void AppendTypeQualList(raw_ostream &OS, unsigned TypeQuals,
142                                bool HasRestrictKeyword) {
143   bool appendSpace = false;
144   if (TypeQuals & Qualifiers::Const) {
145     OS << "const";
146     appendSpace = true;
147   }
148   if (TypeQuals & Qualifiers::Volatile) {
149     if (appendSpace) OS << ' ';
150     OS << "volatile";
151     appendSpace = true;
152   }
153   if (TypeQuals & Qualifiers::Restrict) {
154     if (appendSpace) OS << ' ';
155     if (HasRestrictKeyword) {
156       OS << "restrict";
157     } else {
158       OS << "__restrict";
159     }
160   }
161 }
162 
163 void TypePrinter::spaceBeforePlaceHolder(raw_ostream &OS) {
164   if (!HasEmptyPlaceHolder)
165     OS << ' ';
166 }
167 
168 static SplitQualType splitAccordingToPolicy(QualType QT,
169                                             const PrintingPolicy &Policy) {
170   if (Policy.PrintCanonicalTypes)
171     QT = QT.getCanonicalType();
172   return QT.split();
173 }
174 
175 void TypePrinter::print(QualType t, raw_ostream &OS, StringRef PlaceHolder) {
176   SplitQualType split = splitAccordingToPolicy(t, Policy);
177   print(split.Ty, split.Quals, OS, PlaceHolder);
178 }
179 
180 void TypePrinter::print(const Type *T, Qualifiers Quals, raw_ostream &OS,
181                         StringRef PlaceHolder) {
182   if (!T) {
183     OS << "NULL TYPE";
184     return;
185   }
186 
187   SaveAndRestore<bool> PHVal(HasEmptyPlaceHolder, PlaceHolder.empty());
188 
189   printBefore(T, Quals, OS);
190   OS << PlaceHolder;
191   printAfter(T, Quals, OS);
192 }
193 
194 bool TypePrinter::canPrefixQualifiers(const Type *T,
195                                       bool &NeedARCStrongQualifier) {
196   // CanPrefixQualifiers - We prefer to print type qualifiers before the type,
197   // so that we get "const int" instead of "int const", but we can't do this if
198   // the type is complex.  For example if the type is "int*", we *must* print
199   // "int * const", printing "const int *" is different.  Only do this when the
200   // type expands to a simple string.
201   bool CanPrefixQualifiers = false;
202   NeedARCStrongQualifier = false;
203   Type::TypeClass TC = T->getTypeClass();
204   if (const auto *AT = dyn_cast<AutoType>(T))
205     TC = AT->desugar()->getTypeClass();
206   if (const auto *Subst = dyn_cast<SubstTemplateTypeParmType>(T))
207     TC = Subst->getReplacementType()->getTypeClass();
208 
209   switch (TC) {
210     case Type::Auto:
211     case Type::Builtin:
212     case Type::Complex:
213     case Type::UnresolvedUsing:
214     case Type::Typedef:
215     case Type::TypeOfExpr:
216     case Type::TypeOf:
217     case Type::Decltype:
218     case Type::UnaryTransform:
219     case Type::Record:
220     case Type::Enum:
221     case Type::Elaborated:
222     case Type::TemplateTypeParm:
223     case Type::SubstTemplateTypeParmPack:
224     case Type::DeducedTemplateSpecialization:
225     case Type::TemplateSpecialization:
226     case Type::InjectedClassName:
227     case Type::DependentName:
228     case Type::DependentTemplateSpecialization:
229     case Type::ObjCObject:
230     case Type::ObjCTypeParam:
231     case Type::ObjCInterface:
232     case Type::Atomic:
233     case Type::Pipe:
234     case Type::ExtInt:
235     case Type::DependentExtInt:
236       CanPrefixQualifiers = true;
237       break;
238 
239     case Type::ObjCObjectPointer:
240       CanPrefixQualifiers = T->isObjCIdType() || T->isObjCClassType() ||
241         T->isObjCQualifiedIdType() || T->isObjCQualifiedClassType();
242       break;
243 
244     case Type::ConstantArray:
245     case Type::IncompleteArray:
246     case Type::VariableArray:
247     case Type::DependentSizedArray:
248       NeedARCStrongQualifier = true;
249       LLVM_FALLTHROUGH;
250 
251     case Type::Adjusted:
252     case Type::Decayed:
253     case Type::Pointer:
254     case Type::BlockPointer:
255     case Type::LValueReference:
256     case Type::RValueReference:
257     case Type::MemberPointer:
258     case Type::DependentAddressSpace:
259     case Type::DependentVector:
260     case Type::DependentSizedExtVector:
261     case Type::Vector:
262     case Type::ExtVector:
263     case Type::ConstantMatrix:
264     case Type::DependentSizedMatrix:
265     case Type::FunctionProto:
266     case Type::FunctionNoProto:
267     case Type::Paren:
268     case Type::PackExpansion:
269     case Type::SubstTemplateTypeParm:
270     case Type::MacroQualified:
271       CanPrefixQualifiers = false;
272       break;
273 
274     case Type::Attributed: {
275       // We still want to print the address_space before the type if it is an
276       // address_space attribute.
277       const auto *AttrTy = cast<AttributedType>(T);
278       CanPrefixQualifiers = AttrTy->getAttrKind() == attr::AddressSpace;
279     }
280   }
281 
282   return CanPrefixQualifiers;
283 }
284 
285 void TypePrinter::printBefore(QualType T, raw_ostream &OS) {
286   SplitQualType Split = splitAccordingToPolicy(T, Policy);
287 
288   // If we have cv1 T, where T is substituted for cv2 U, only print cv1 - cv2
289   // at this level.
290   Qualifiers Quals = Split.Quals;
291   if (const auto *Subst = dyn_cast<SubstTemplateTypeParmType>(Split.Ty))
292     Quals -= QualType(Subst, 0).getQualifiers();
293 
294   printBefore(Split.Ty, Quals, OS);
295 }
296 
297 /// Prints the part of the type string before an identifier, e.g. for
298 /// "int foo[10]" it prints "int ".
299 void TypePrinter::printBefore(const Type *T,Qualifiers Quals, raw_ostream &OS) {
300   if (Policy.SuppressSpecifiers && T->isSpecifierType())
301     return;
302 
303   SaveAndRestore<bool> PrevPHIsEmpty(HasEmptyPlaceHolder);
304 
305   // Print qualifiers as appropriate.
306 
307   bool CanPrefixQualifiers = false;
308   bool NeedARCStrongQualifier = false;
309   CanPrefixQualifiers = canPrefixQualifiers(T, NeedARCStrongQualifier);
310 
311   if (CanPrefixQualifiers && !Quals.empty()) {
312     if (NeedARCStrongQualifier) {
313       IncludeStrongLifetimeRAII Strong(Policy);
314       Quals.print(OS, Policy, /*appendSpaceIfNonEmpty=*/true);
315     } else {
316       Quals.print(OS, Policy, /*appendSpaceIfNonEmpty=*/true);
317     }
318   }
319 
320   bool hasAfterQuals = false;
321   if (!CanPrefixQualifiers && !Quals.empty()) {
322     hasAfterQuals = !Quals.isEmptyWhenPrinted(Policy);
323     if (hasAfterQuals)
324       HasEmptyPlaceHolder = false;
325   }
326 
327   switch (T->getTypeClass()) {
328 #define ABSTRACT_TYPE(CLASS, PARENT)
329 #define TYPE(CLASS, PARENT) case Type::CLASS: \
330     print##CLASS##Before(cast<CLASS##Type>(T), OS); \
331     break;
332 #include "clang/AST/TypeNodes.inc"
333   }
334 
335   if (hasAfterQuals) {
336     if (NeedARCStrongQualifier) {
337       IncludeStrongLifetimeRAII Strong(Policy);
338       Quals.print(OS, Policy, /*appendSpaceIfNonEmpty=*/!PrevPHIsEmpty.get());
339     } else {
340       Quals.print(OS, Policy, /*appendSpaceIfNonEmpty=*/!PrevPHIsEmpty.get());
341     }
342   }
343 }
344 
345 void TypePrinter::printAfter(QualType t, raw_ostream &OS) {
346   SplitQualType split = splitAccordingToPolicy(t, Policy);
347   printAfter(split.Ty, split.Quals, OS);
348 }
349 
350 /// Prints the part of the type string after an identifier, e.g. for
351 /// "int foo[10]" it prints "[10]".
352 void TypePrinter::printAfter(const Type *T, Qualifiers Quals, raw_ostream &OS) {
353   switch (T->getTypeClass()) {
354 #define ABSTRACT_TYPE(CLASS, PARENT)
355 #define TYPE(CLASS, PARENT) case Type::CLASS: \
356     print##CLASS##After(cast<CLASS##Type>(T), OS); \
357     break;
358 #include "clang/AST/TypeNodes.inc"
359   }
360 }
361 
362 void TypePrinter::printBuiltinBefore(const BuiltinType *T, raw_ostream &OS) {
363   OS << T->getName(Policy);
364   spaceBeforePlaceHolder(OS);
365 }
366 
367 void TypePrinter::printBuiltinAfter(const BuiltinType *T, raw_ostream &OS) {}
368 
369 void TypePrinter::printComplexBefore(const ComplexType *T, raw_ostream &OS) {
370   OS << "_Complex ";
371   printBefore(T->getElementType(), OS);
372 }
373 
374 void TypePrinter::printComplexAfter(const ComplexType *T, raw_ostream &OS) {
375   printAfter(T->getElementType(), OS);
376 }
377 
378 void TypePrinter::printPointerBefore(const PointerType *T, raw_ostream &OS) {
379   IncludeStrongLifetimeRAII Strong(Policy);
380   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
381   printBefore(T->getPointeeType(), OS);
382   // Handle things like 'int (*A)[4];' correctly.
383   // FIXME: this should include vectors, but vectors use attributes I guess.
384   if (isa<ArrayType>(T->getPointeeType()))
385     OS << '(';
386   OS << '*';
387 }
388 
389 void TypePrinter::printPointerAfter(const PointerType *T, raw_ostream &OS) {
390   IncludeStrongLifetimeRAII Strong(Policy);
391   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
392   // Handle things like 'int (*A)[4];' correctly.
393   // FIXME: this should include vectors, but vectors use attributes I guess.
394   if (isa<ArrayType>(T->getPointeeType()))
395     OS << ')';
396   printAfter(T->getPointeeType(), OS);
397 }
398 
399 void TypePrinter::printBlockPointerBefore(const BlockPointerType *T,
400                                           raw_ostream &OS) {
401   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
402   printBefore(T->getPointeeType(), OS);
403   OS << '^';
404 }
405 
406 void TypePrinter::printBlockPointerAfter(const BlockPointerType *T,
407                                           raw_ostream &OS) {
408   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
409   printAfter(T->getPointeeType(), OS);
410 }
411 
412 // When printing a reference, the referenced type might also be a reference.
413 // If so, we want to skip that before printing the inner type.
414 static QualType skipTopLevelReferences(QualType T) {
415   if (auto *Ref = T->getAs<ReferenceType>())
416     return skipTopLevelReferences(Ref->getPointeeTypeAsWritten());
417   return T;
418 }
419 
420 void TypePrinter::printLValueReferenceBefore(const LValueReferenceType *T,
421                                              raw_ostream &OS) {
422   IncludeStrongLifetimeRAII Strong(Policy);
423   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
424   QualType Inner = skipTopLevelReferences(T->getPointeeTypeAsWritten());
425   printBefore(Inner, OS);
426   // Handle things like 'int (&A)[4];' correctly.
427   // FIXME: this should include vectors, but vectors use attributes I guess.
428   if (isa<ArrayType>(Inner))
429     OS << '(';
430   OS << '&';
431 }
432 
433 void TypePrinter::printLValueReferenceAfter(const LValueReferenceType *T,
434                                             raw_ostream &OS) {
435   IncludeStrongLifetimeRAII Strong(Policy);
436   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
437   QualType Inner = skipTopLevelReferences(T->getPointeeTypeAsWritten());
438   // Handle things like 'int (&A)[4];' correctly.
439   // FIXME: this should include vectors, but vectors use attributes I guess.
440   if (isa<ArrayType>(Inner))
441     OS << ')';
442   printAfter(Inner, OS);
443 }
444 
445 void TypePrinter::printRValueReferenceBefore(const RValueReferenceType *T,
446                                              raw_ostream &OS) {
447   IncludeStrongLifetimeRAII Strong(Policy);
448   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
449   QualType Inner = skipTopLevelReferences(T->getPointeeTypeAsWritten());
450   printBefore(Inner, OS);
451   // Handle things like 'int (&&A)[4];' correctly.
452   // FIXME: this should include vectors, but vectors use attributes I guess.
453   if (isa<ArrayType>(Inner))
454     OS << '(';
455   OS << "&&";
456 }
457 
458 void TypePrinter::printRValueReferenceAfter(const RValueReferenceType *T,
459                                             raw_ostream &OS) {
460   IncludeStrongLifetimeRAII Strong(Policy);
461   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
462   QualType Inner = skipTopLevelReferences(T->getPointeeTypeAsWritten());
463   // Handle things like 'int (&&A)[4];' correctly.
464   // FIXME: this should include vectors, but vectors use attributes I guess.
465   if (isa<ArrayType>(Inner))
466     OS << ')';
467   printAfter(Inner, OS);
468 }
469 
470 void TypePrinter::printMemberPointerBefore(const MemberPointerType *T,
471                                            raw_ostream &OS) {
472   IncludeStrongLifetimeRAII Strong(Policy);
473   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
474   printBefore(T->getPointeeType(), OS);
475   // Handle things like 'int (Cls::*A)[4];' correctly.
476   // FIXME: this should include vectors, but vectors use attributes I guess.
477   if (isa<ArrayType>(T->getPointeeType()))
478     OS << '(';
479 
480   PrintingPolicy InnerPolicy(Policy);
481   InnerPolicy.IncludeTagDefinition = false;
482   TypePrinter(InnerPolicy).print(QualType(T->getClass(), 0), OS, StringRef());
483 
484   OS << "::*";
485 }
486 
487 void TypePrinter::printMemberPointerAfter(const MemberPointerType *T,
488                                           raw_ostream &OS) {
489   IncludeStrongLifetimeRAII Strong(Policy);
490   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
491   // Handle things like 'int (Cls::*A)[4];' correctly.
492   // FIXME: this should include vectors, but vectors use attributes I guess.
493   if (isa<ArrayType>(T->getPointeeType()))
494     OS << ')';
495   printAfter(T->getPointeeType(), OS);
496 }
497 
498 void TypePrinter::printConstantArrayBefore(const ConstantArrayType *T,
499                                            raw_ostream &OS) {
500   IncludeStrongLifetimeRAII Strong(Policy);
501   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
502   printBefore(T->getElementType(), OS);
503 }
504 
505 void TypePrinter::printConstantArrayAfter(const ConstantArrayType *T,
506                                           raw_ostream &OS) {
507   OS << '[';
508   if (T->getIndexTypeQualifiers().hasQualifiers()) {
509     AppendTypeQualList(OS, T->getIndexTypeCVRQualifiers(),
510                        Policy.Restrict);
511     OS << ' ';
512   }
513 
514   if (T->getSizeModifier() == ArrayType::Static)
515     OS << "static ";
516 
517   OS << T->getSize().getZExtValue() << ']';
518   printAfter(T->getElementType(), OS);
519 }
520 
521 void TypePrinter::printIncompleteArrayBefore(const IncompleteArrayType *T,
522                                              raw_ostream &OS) {
523   IncludeStrongLifetimeRAII Strong(Policy);
524   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
525   printBefore(T->getElementType(), OS);
526 }
527 
528 void TypePrinter::printIncompleteArrayAfter(const IncompleteArrayType *T,
529                                             raw_ostream &OS) {
530   OS << "[]";
531   printAfter(T->getElementType(), OS);
532 }
533 
534 void TypePrinter::printVariableArrayBefore(const VariableArrayType *T,
535                                            raw_ostream &OS) {
536   IncludeStrongLifetimeRAII Strong(Policy);
537   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
538   printBefore(T->getElementType(), OS);
539 }
540 
541 void TypePrinter::printVariableArrayAfter(const VariableArrayType *T,
542                                           raw_ostream &OS) {
543   OS << '[';
544   if (T->getIndexTypeQualifiers().hasQualifiers()) {
545     AppendTypeQualList(OS, T->getIndexTypeCVRQualifiers(), Policy.Restrict);
546     OS << ' ';
547   }
548 
549   if (T->getSizeModifier() == VariableArrayType::Static)
550     OS << "static ";
551   else if (T->getSizeModifier() == VariableArrayType::Star)
552     OS << '*';
553 
554   if (T->getSizeExpr())
555     T->getSizeExpr()->printPretty(OS, nullptr, Policy);
556   OS << ']';
557 
558   printAfter(T->getElementType(), OS);
559 }
560 
561 void TypePrinter::printAdjustedBefore(const AdjustedType *T, raw_ostream &OS) {
562   // Print the adjusted representation, otherwise the adjustment will be
563   // invisible.
564   printBefore(T->getAdjustedType(), OS);
565 }
566 
567 void TypePrinter::printAdjustedAfter(const AdjustedType *T, raw_ostream &OS) {
568   printAfter(T->getAdjustedType(), OS);
569 }
570 
571 void TypePrinter::printDecayedBefore(const DecayedType *T, raw_ostream &OS) {
572   // Print as though it's a pointer.
573   printAdjustedBefore(T, OS);
574 }
575 
576 void TypePrinter::printDecayedAfter(const DecayedType *T, raw_ostream &OS) {
577   printAdjustedAfter(T, OS);
578 }
579 
580 void TypePrinter::printDependentSizedArrayBefore(
581                                                const DependentSizedArrayType *T,
582                                                raw_ostream &OS) {
583   IncludeStrongLifetimeRAII Strong(Policy);
584   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
585   printBefore(T->getElementType(), OS);
586 }
587 
588 void TypePrinter::printDependentSizedArrayAfter(
589                                                const DependentSizedArrayType *T,
590                                                raw_ostream &OS) {
591   OS << '[';
592   if (T->getSizeExpr())
593     T->getSizeExpr()->printPretty(OS, nullptr, Policy);
594   OS << ']';
595   printAfter(T->getElementType(), OS);
596 }
597 
598 void TypePrinter::printDependentAddressSpaceBefore(
599     const DependentAddressSpaceType *T, raw_ostream &OS) {
600   printBefore(T->getPointeeType(), OS);
601 }
602 
603 void TypePrinter::printDependentAddressSpaceAfter(
604     const DependentAddressSpaceType *T, raw_ostream &OS) {
605   OS << " __attribute__((address_space(";
606   if (T->getAddrSpaceExpr())
607     T->getAddrSpaceExpr()->printPretty(OS, nullptr, Policy);
608   OS << ")))";
609   printAfter(T->getPointeeType(), OS);
610 }
611 
612 void TypePrinter::printDependentSizedExtVectorBefore(
613                                           const DependentSizedExtVectorType *T,
614                                           raw_ostream &OS) {
615   printBefore(T->getElementType(), OS);
616 }
617 
618 void TypePrinter::printDependentSizedExtVectorAfter(
619                                           const DependentSizedExtVectorType *T,
620                                           raw_ostream &OS) {
621   OS << " __attribute__((ext_vector_type(";
622   if (T->getSizeExpr())
623     T->getSizeExpr()->printPretty(OS, nullptr, Policy);
624   OS << ")))";
625   printAfter(T->getElementType(), OS);
626 }
627 
628 void TypePrinter::printVectorBefore(const VectorType *T, raw_ostream &OS) {
629   switch (T->getVectorKind()) {
630   case VectorType::AltiVecPixel:
631     OS << "__vector __pixel ";
632     break;
633   case VectorType::AltiVecBool:
634     OS << "__vector __bool ";
635     printBefore(T->getElementType(), OS);
636     break;
637   case VectorType::AltiVecVector:
638     OS << "__vector ";
639     printBefore(T->getElementType(), OS);
640     break;
641   case VectorType::NeonVector:
642     OS << "__attribute__((neon_vector_type("
643        << T->getNumElements() << "))) ";
644     printBefore(T->getElementType(), OS);
645     break;
646   case VectorType::NeonPolyVector:
647     OS << "__attribute__((neon_polyvector_type(" <<
648           T->getNumElements() << "))) ";
649     printBefore(T->getElementType(), OS);
650     break;
651   case VectorType::GenericVector: {
652     // FIXME: We prefer to print the size directly here, but have no way
653     // to get the size of the type.
654     OS << "__attribute__((__vector_size__("
655        << T->getNumElements()
656        << " * sizeof(";
657     print(T->getElementType(), OS, StringRef());
658     OS << ")))) ";
659     printBefore(T->getElementType(), OS);
660     break;
661   }
662   case VectorType::SveFixedLengthDataVector:
663   case VectorType::SveFixedLengthPredicateVector:
664     // FIXME: We prefer to print the size directly here, but have no way
665     // to get the size of the type.
666     OS << "__attribute__((__arm_sve_vector_bits__(";
667 
668     if (T->getVectorKind() == VectorType::SveFixedLengthPredicateVector)
669       // Predicates take a bit per byte of the vector size, multiply by 8 to
670       // get the number of bits passed to the attribute.
671       OS << T->getNumElements() * 8;
672     else
673       OS << T->getNumElements();
674 
675     OS << " * sizeof(";
676     print(T->getElementType(), OS, StringRef());
677     // Multiply by 8 for the number of bits.
678     OS << ") * 8))) ";
679     printBefore(T->getElementType(), OS);
680   }
681 }
682 
683 void TypePrinter::printVectorAfter(const VectorType *T, raw_ostream &OS) {
684   printAfter(T->getElementType(), OS);
685 }
686 
687 void TypePrinter::printDependentVectorBefore(
688     const DependentVectorType *T, raw_ostream &OS) {
689   switch (T->getVectorKind()) {
690   case VectorType::AltiVecPixel:
691     OS << "__vector __pixel ";
692     break;
693   case VectorType::AltiVecBool:
694     OS << "__vector __bool ";
695     printBefore(T->getElementType(), OS);
696     break;
697   case VectorType::AltiVecVector:
698     OS << "__vector ";
699     printBefore(T->getElementType(), OS);
700     break;
701   case VectorType::NeonVector:
702     OS << "__attribute__((neon_vector_type(";
703     if (T->getSizeExpr())
704       T->getSizeExpr()->printPretty(OS, nullptr, Policy);
705     OS << "))) ";
706     printBefore(T->getElementType(), OS);
707     break;
708   case VectorType::NeonPolyVector:
709     OS << "__attribute__((neon_polyvector_type(";
710     if (T->getSizeExpr())
711       T->getSizeExpr()->printPretty(OS, nullptr, Policy);
712     OS << "))) ";
713     printBefore(T->getElementType(), OS);
714     break;
715   case VectorType::GenericVector: {
716     // FIXME: We prefer to print the size directly here, but have no way
717     // to get the size of the type.
718     OS << "__attribute__((__vector_size__(";
719     if (T->getSizeExpr())
720       T->getSizeExpr()->printPretty(OS, nullptr, Policy);
721     OS << " * sizeof(";
722     print(T->getElementType(), OS, StringRef());
723     OS << ")))) ";
724     printBefore(T->getElementType(), OS);
725     break;
726   }
727   case VectorType::SveFixedLengthDataVector:
728   case VectorType::SveFixedLengthPredicateVector:
729     // FIXME: We prefer to print the size directly here, but have no way
730     // to get the size of the type.
731     OS << "__attribute__((__arm_sve_vector_bits__(";
732     if (T->getSizeExpr()) {
733       T->getSizeExpr()->printPretty(OS, nullptr, Policy);
734       if (T->getVectorKind() == VectorType::SveFixedLengthPredicateVector)
735         // Predicates take a bit per byte of the vector size, multiply by 8 to
736         // get the number of bits passed to the attribute.
737         OS << " * 8";
738       OS << " * sizeof(";
739       print(T->getElementType(), OS, StringRef());
740       // Multiply by 8 for the number of bits.
741       OS << ") * 8";
742     }
743     OS << "))) ";
744     printBefore(T->getElementType(), OS);
745   }
746 }
747 
748 void TypePrinter::printDependentVectorAfter(
749     const DependentVectorType *T, raw_ostream &OS) {
750   printAfter(T->getElementType(), OS);
751 }
752 
753 void TypePrinter::printExtVectorBefore(const ExtVectorType *T,
754                                        raw_ostream &OS) {
755   printBefore(T->getElementType(), OS);
756 }
757 
758 void TypePrinter::printExtVectorAfter(const ExtVectorType *T, raw_ostream &OS) {
759   printAfter(T->getElementType(), OS);
760   OS << " __attribute__((ext_vector_type(";
761   OS << T->getNumElements();
762   OS << ")))";
763 }
764 
765 void TypePrinter::printConstantMatrixBefore(const ConstantMatrixType *T,
766                                             raw_ostream &OS) {
767   printBefore(T->getElementType(), OS);
768   OS << " __attribute__((matrix_type(";
769   OS << T->getNumRows() << ", " << T->getNumColumns();
770   OS << ")))";
771 }
772 
773 void TypePrinter::printConstantMatrixAfter(const ConstantMatrixType *T,
774                                            raw_ostream &OS) {
775   printAfter(T->getElementType(), OS);
776 }
777 
778 void TypePrinter::printDependentSizedMatrixBefore(
779     const DependentSizedMatrixType *T, raw_ostream &OS) {
780   printBefore(T->getElementType(), OS);
781   OS << " __attribute__((matrix_type(";
782   if (T->getRowExpr()) {
783     T->getRowExpr()->printPretty(OS, nullptr, Policy);
784   }
785   OS << ", ";
786   if (T->getColumnExpr()) {
787     T->getColumnExpr()->printPretty(OS, nullptr, Policy);
788   }
789   OS << ")))";
790 }
791 
792 void TypePrinter::printDependentSizedMatrixAfter(
793     const DependentSizedMatrixType *T, raw_ostream &OS) {
794   printAfter(T->getElementType(), OS);
795 }
796 
797 void
798 FunctionProtoType::printExceptionSpecification(raw_ostream &OS,
799                                                const PrintingPolicy &Policy)
800                                                                          const {
801   if (hasDynamicExceptionSpec()) {
802     OS << " throw(";
803     if (getExceptionSpecType() == EST_MSAny)
804       OS << "...";
805     else
806       for (unsigned I = 0, N = getNumExceptions(); I != N; ++I) {
807         if (I)
808           OS << ", ";
809 
810         OS << getExceptionType(I).stream(Policy);
811       }
812     OS << ')';
813   } else if (EST_NoThrow == getExceptionSpecType()) {
814     OS << " __attribute__((nothrow))";
815   } else if (isNoexceptExceptionSpec(getExceptionSpecType())) {
816     OS << " noexcept";
817     // FIXME:Is it useful to print out the expression for a non-dependent
818     // noexcept specification?
819     if (isComputedNoexcept(getExceptionSpecType())) {
820       OS << '(';
821       if (getNoexceptExpr())
822         getNoexceptExpr()->printPretty(OS, nullptr, Policy);
823       OS << ')';
824     }
825   }
826 }
827 
828 void TypePrinter::printFunctionProtoBefore(const FunctionProtoType *T,
829                                            raw_ostream &OS) {
830   if (T->hasTrailingReturn()) {
831     OS << "auto ";
832     if (!HasEmptyPlaceHolder)
833       OS << '(';
834   } else {
835     // If needed for precedence reasons, wrap the inner part in grouping parens.
836     SaveAndRestore<bool> PrevPHIsEmpty(HasEmptyPlaceHolder, false);
837     printBefore(T->getReturnType(), OS);
838     if (!PrevPHIsEmpty.get())
839       OS << '(';
840   }
841 }
842 
843 StringRef clang::getParameterABISpelling(ParameterABI ABI) {
844   switch (ABI) {
845   case ParameterABI::Ordinary:
846     llvm_unreachable("asking for spelling of ordinary parameter ABI");
847   case ParameterABI::SwiftContext:
848     return "swift_context";
849   case ParameterABI::SwiftErrorResult:
850     return "swift_error_result";
851   case ParameterABI::SwiftIndirectResult:
852     return "swift_indirect_result";
853   }
854   llvm_unreachable("bad parameter ABI kind");
855 }
856 
857 void TypePrinter::printFunctionProtoAfter(const FunctionProtoType *T,
858                                           raw_ostream &OS) {
859   // If needed for precedence reasons, wrap the inner part in grouping parens.
860   if (!HasEmptyPlaceHolder)
861     OS << ')';
862   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
863 
864   OS << '(';
865   {
866     ParamPolicyRAII ParamPolicy(Policy);
867     for (unsigned i = 0, e = T->getNumParams(); i != e; ++i) {
868       if (i) OS << ", ";
869 
870       auto EPI = T->getExtParameterInfo(i);
871       if (EPI.isConsumed()) OS << "__attribute__((ns_consumed)) ";
872       if (EPI.isNoEscape())
873         OS << "__attribute__((noescape)) ";
874       auto ABI = EPI.getABI();
875       if (ABI != ParameterABI::Ordinary)
876         OS << "__attribute__((" << getParameterABISpelling(ABI) << ")) ";
877 
878       print(T->getParamType(i), OS, StringRef());
879     }
880   }
881 
882   if (T->isVariadic()) {
883     if (T->getNumParams())
884       OS << ", ";
885     OS << "...";
886   } else if (T->getNumParams() == 0 && Policy.UseVoidForZeroParams) {
887     // Do not emit int() if we have a proto, emit 'int(void)'.
888     OS << "void";
889   }
890 
891   OS << ')';
892 
893   FunctionType::ExtInfo Info = T->getExtInfo();
894 
895   printFunctionAfter(Info, OS);
896 
897   if (!T->getMethodQuals().empty())
898     OS << " " << T->getMethodQuals().getAsString();
899 
900   switch (T->getRefQualifier()) {
901   case RQ_None:
902     break;
903 
904   case RQ_LValue:
905     OS << " &";
906     break;
907 
908   case RQ_RValue:
909     OS << " &&";
910     break;
911   }
912   T->printExceptionSpecification(OS, Policy);
913 
914   if (T->hasTrailingReturn()) {
915     OS << " -> ";
916     print(T->getReturnType(), OS, StringRef());
917   } else
918     printAfter(T->getReturnType(), OS);
919 }
920 
921 void TypePrinter::printFunctionAfter(const FunctionType::ExtInfo &Info,
922                                      raw_ostream &OS) {
923   if (!InsideCCAttribute) {
924     switch (Info.getCC()) {
925     case CC_C:
926       // The C calling convention is the default on the vast majority of platforms
927       // we support.  If the user wrote it explicitly, it will usually be printed
928       // while traversing the AttributedType.  If the type has been desugared, let
929       // the canonical spelling be the implicit calling convention.
930       // FIXME: It would be better to be explicit in certain contexts, such as a
931       // cdecl function typedef used to declare a member function with the
932       // Microsoft C++ ABI.
933       break;
934     case CC_X86StdCall:
935       OS << " __attribute__((stdcall))";
936       break;
937     case CC_X86FastCall:
938       OS << " __attribute__((fastcall))";
939       break;
940     case CC_X86ThisCall:
941       OS << " __attribute__((thiscall))";
942       break;
943     case CC_X86VectorCall:
944       OS << " __attribute__((vectorcall))";
945       break;
946     case CC_X86Pascal:
947       OS << " __attribute__((pascal))";
948       break;
949     case CC_AAPCS:
950       OS << " __attribute__((pcs(\"aapcs\")))";
951       break;
952     case CC_AAPCS_VFP:
953       OS << " __attribute__((pcs(\"aapcs-vfp\")))";
954       break;
955     case CC_AArch64VectorCall:
956       OS << "__attribute__((aarch64_vector_pcs))";
957       break;
958     case CC_IntelOclBicc:
959       OS << " __attribute__((intel_ocl_bicc))";
960       break;
961     case CC_Win64:
962       OS << " __attribute__((ms_abi))";
963       break;
964     case CC_X86_64SysV:
965       OS << " __attribute__((sysv_abi))";
966       break;
967     case CC_X86RegCall:
968       OS << " __attribute__((regcall))";
969       break;
970     case CC_SpirFunction:
971     case CC_OpenCLKernel:
972       // Do nothing. These CCs are not available as attributes.
973       break;
974     case CC_Swift:
975       OS << " __attribute__((swiftcall))";
976       break;
977     case CC_PreserveMost:
978       OS << " __attribute__((preserve_most))";
979       break;
980     case CC_PreserveAll:
981       OS << " __attribute__((preserve_all))";
982       break;
983     }
984   }
985 
986   if (Info.getNoReturn())
987     OS << " __attribute__((noreturn))";
988   if (Info.getCmseNSCall())
989     OS << " __attribute__((cmse_nonsecure_call))";
990   if (Info.getProducesResult())
991     OS << " __attribute__((ns_returns_retained))";
992   if (Info.getRegParm())
993     OS << " __attribute__((regparm ("
994        << Info.getRegParm() << ")))";
995   if (Info.getNoCallerSavedRegs())
996     OS << " __attribute__((no_caller_saved_registers))";
997   if (Info.getNoCfCheck())
998     OS << " __attribute__((nocf_check))";
999 }
1000 
1001 void TypePrinter::printFunctionNoProtoBefore(const FunctionNoProtoType *T,
1002                                              raw_ostream &OS) {
1003   // If needed for precedence reasons, wrap the inner part in grouping parens.
1004   SaveAndRestore<bool> PrevPHIsEmpty(HasEmptyPlaceHolder, false);
1005   printBefore(T->getReturnType(), OS);
1006   if (!PrevPHIsEmpty.get())
1007     OS << '(';
1008 }
1009 
1010 void TypePrinter::printFunctionNoProtoAfter(const FunctionNoProtoType *T,
1011                                             raw_ostream &OS) {
1012   // If needed for precedence reasons, wrap the inner part in grouping parens.
1013   if (!HasEmptyPlaceHolder)
1014     OS << ')';
1015   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
1016 
1017   OS << "()";
1018   printFunctionAfter(T->getExtInfo(), OS);
1019   printAfter(T->getReturnType(), OS);
1020 }
1021 
1022 void TypePrinter::printTypeSpec(NamedDecl *D, raw_ostream &OS) {
1023 
1024   // Compute the full nested-name-specifier for this type.
1025   // In C, this will always be empty except when the type
1026   // being printed is anonymous within other Record.
1027   if (!Policy.SuppressScope)
1028     AppendScope(D->getDeclContext(), OS, D->getDeclName());
1029 
1030   IdentifierInfo *II = D->getIdentifier();
1031   OS << II->getName();
1032   spaceBeforePlaceHolder(OS);
1033 }
1034 
1035 void TypePrinter::printUnresolvedUsingBefore(const UnresolvedUsingType *T,
1036                                              raw_ostream &OS) {
1037   printTypeSpec(T->getDecl(), OS);
1038 }
1039 
1040 void TypePrinter::printUnresolvedUsingAfter(const UnresolvedUsingType *T,
1041                                             raw_ostream &OS) {}
1042 
1043 void TypePrinter::printTypedefBefore(const TypedefType *T, raw_ostream &OS) {
1044   printTypeSpec(T->getDecl(), OS);
1045 }
1046 
1047 void TypePrinter::printMacroQualifiedBefore(const MacroQualifiedType *T,
1048                                             raw_ostream &OS) {
1049   StringRef MacroName = T->getMacroIdentifier()->getName();
1050   OS << MacroName << " ";
1051 
1052   // Since this type is meant to print the macro instead of the whole attribute,
1053   // we trim any attributes and go directly to the original modified type.
1054   printBefore(T->getModifiedType(), OS);
1055 }
1056 
1057 void TypePrinter::printMacroQualifiedAfter(const MacroQualifiedType *T,
1058                                            raw_ostream &OS) {
1059   printAfter(T->getModifiedType(), OS);
1060 }
1061 
1062 void TypePrinter::printTypedefAfter(const TypedefType *T, raw_ostream &OS) {}
1063 
1064 void TypePrinter::printTypeOfExprBefore(const TypeOfExprType *T,
1065                                         raw_ostream &OS) {
1066   OS << "typeof ";
1067   if (T->getUnderlyingExpr())
1068     T->getUnderlyingExpr()->printPretty(OS, nullptr, Policy);
1069   spaceBeforePlaceHolder(OS);
1070 }
1071 
1072 void TypePrinter::printTypeOfExprAfter(const TypeOfExprType *T,
1073                                        raw_ostream &OS) {}
1074 
1075 void TypePrinter::printTypeOfBefore(const TypeOfType *T, raw_ostream &OS) {
1076   OS << "typeof(";
1077   print(T->getUnderlyingType(), OS, StringRef());
1078   OS << ')';
1079   spaceBeforePlaceHolder(OS);
1080 }
1081 
1082 void TypePrinter::printTypeOfAfter(const TypeOfType *T, raw_ostream &OS) {}
1083 
1084 void TypePrinter::printDecltypeBefore(const DecltypeType *T, raw_ostream &OS) {
1085   OS << "decltype(";
1086   if (T->getUnderlyingExpr())
1087     T->getUnderlyingExpr()->printPretty(OS, nullptr, Policy);
1088   OS << ')';
1089   spaceBeforePlaceHolder(OS);
1090 }
1091 
1092 void TypePrinter::printDecltypeAfter(const DecltypeType *T, raw_ostream &OS) {}
1093 
1094 void TypePrinter::printUnaryTransformBefore(const UnaryTransformType *T,
1095                                             raw_ostream &OS) {
1096   IncludeStrongLifetimeRAII Strong(Policy);
1097 
1098   switch (T->getUTTKind()) {
1099     case UnaryTransformType::EnumUnderlyingType:
1100       OS << "__underlying_type(";
1101       print(T->getBaseType(), OS, StringRef());
1102       OS << ')';
1103       spaceBeforePlaceHolder(OS);
1104       return;
1105   }
1106 
1107   printBefore(T->getBaseType(), OS);
1108 }
1109 
1110 void TypePrinter::printUnaryTransformAfter(const UnaryTransformType *T,
1111                                            raw_ostream &OS) {
1112   IncludeStrongLifetimeRAII Strong(Policy);
1113 
1114   switch (T->getUTTKind()) {
1115     case UnaryTransformType::EnumUnderlyingType:
1116       return;
1117   }
1118 
1119   printAfter(T->getBaseType(), OS);
1120 }
1121 
1122 void TypePrinter::printAutoBefore(const AutoType *T, raw_ostream &OS) {
1123   // If the type has been deduced, do not print 'auto'.
1124   if (!T->getDeducedType().isNull()) {
1125     printBefore(T->getDeducedType(), OS);
1126   } else {
1127     if (T->isConstrained()) {
1128       OS << T->getTypeConstraintConcept()->getName();
1129       auto Args = T->getTypeConstraintArguments();
1130       if (!Args.empty())
1131         printTemplateArgumentList(
1132             OS, Args, Policy,
1133             T->getTypeConstraintConcept()->getTemplateParameters());
1134       OS << ' ';
1135     }
1136     switch (T->getKeyword()) {
1137     case AutoTypeKeyword::Auto: OS << "auto"; break;
1138     case AutoTypeKeyword::DecltypeAuto: OS << "decltype(auto)"; break;
1139     case AutoTypeKeyword::GNUAutoType: OS << "__auto_type"; break;
1140     }
1141     spaceBeforePlaceHolder(OS);
1142   }
1143 }
1144 
1145 void TypePrinter::printAutoAfter(const AutoType *T, raw_ostream &OS) {
1146   // If the type has been deduced, do not print 'auto'.
1147   if (!T->getDeducedType().isNull())
1148     printAfter(T->getDeducedType(), OS);
1149 }
1150 
1151 void TypePrinter::printDeducedTemplateSpecializationBefore(
1152     const DeducedTemplateSpecializationType *T, raw_ostream &OS) {
1153   // If the type has been deduced, print the deduced type.
1154   if (!T->getDeducedType().isNull()) {
1155     printBefore(T->getDeducedType(), OS);
1156   } else {
1157     IncludeStrongLifetimeRAII Strong(Policy);
1158     T->getTemplateName().print(OS, Policy);
1159     spaceBeforePlaceHolder(OS);
1160   }
1161 }
1162 
1163 void TypePrinter::printDeducedTemplateSpecializationAfter(
1164     const DeducedTemplateSpecializationType *T, raw_ostream &OS) {
1165   // If the type has been deduced, print the deduced type.
1166   if (!T->getDeducedType().isNull())
1167     printAfter(T->getDeducedType(), OS);
1168 }
1169 
1170 void TypePrinter::printAtomicBefore(const AtomicType *T, raw_ostream &OS) {
1171   IncludeStrongLifetimeRAII Strong(Policy);
1172 
1173   OS << "_Atomic(";
1174   print(T->getValueType(), OS, StringRef());
1175   OS << ')';
1176   spaceBeforePlaceHolder(OS);
1177 }
1178 
1179 void TypePrinter::printAtomicAfter(const AtomicType *T, raw_ostream &OS) {}
1180 
1181 void TypePrinter::printPipeBefore(const PipeType *T, raw_ostream &OS) {
1182   IncludeStrongLifetimeRAII Strong(Policy);
1183 
1184   if (T->isReadOnly())
1185     OS << "read_only ";
1186   else
1187     OS << "write_only ";
1188   OS << "pipe ";
1189   print(T->getElementType(), OS, StringRef());
1190   spaceBeforePlaceHolder(OS);
1191 }
1192 
1193 void TypePrinter::printPipeAfter(const PipeType *T, raw_ostream &OS) {}
1194 
1195 void TypePrinter::printExtIntBefore(const ExtIntType *T, raw_ostream &OS) {
1196   if (T->isUnsigned())
1197     OS << "unsigned ";
1198   OS << "_ExtInt(" << T->getNumBits() << ")";
1199   spaceBeforePlaceHolder(OS);
1200 }
1201 
1202 void TypePrinter::printExtIntAfter(const ExtIntType *T, raw_ostream &OS) {}
1203 
1204 void TypePrinter::printDependentExtIntBefore(const DependentExtIntType *T,
1205                                              raw_ostream &OS) {
1206   if (T->isUnsigned())
1207     OS << "unsigned ";
1208   OS << "_ExtInt(";
1209   T->getNumBitsExpr()->printPretty(OS, nullptr, Policy);
1210   OS << ")";
1211   spaceBeforePlaceHolder(OS);
1212 }
1213 
1214 void TypePrinter::printDependentExtIntAfter(const DependentExtIntType *T,
1215                                             raw_ostream &OS) {}
1216 
1217 /// Appends the given scope to the end of a string.
1218 void TypePrinter::AppendScope(DeclContext *DC, raw_ostream &OS,
1219                               DeclarationName NameInScope) {
1220   if (DC->isTranslationUnit())
1221     return;
1222 
1223   // FIXME: Consider replacing this with NamedDecl::printNestedNameSpecifier,
1224   // which can also print names for function and method scopes.
1225   if (DC->isFunctionOrMethod())
1226     return;
1227 
1228   if (const auto *NS = dyn_cast<NamespaceDecl>(DC)) {
1229     if (Policy.SuppressUnwrittenScope && NS->isAnonymousNamespace())
1230       return AppendScope(DC->getParent(), OS, NameInScope);
1231 
1232     // Only suppress an inline namespace if the name has the same lookup
1233     // results in the enclosing namespace.
1234     if (Policy.SuppressInlineNamespace && NS->isInline() && NameInScope &&
1235         DC->getParent()->lookup(NameInScope).size() ==
1236             DC->lookup(NameInScope).size())
1237       return AppendScope(DC->getParent(), OS, NameInScope);
1238 
1239     AppendScope(DC->getParent(), OS, NS->getDeclName());
1240     if (NS->getIdentifier())
1241       OS << NS->getName() << "::";
1242     else
1243       OS << "(anonymous namespace)::";
1244   } else if (const auto *Spec = dyn_cast<ClassTemplateSpecializationDecl>(DC)) {
1245     AppendScope(DC->getParent(), OS, Spec->getDeclName());
1246     IncludeStrongLifetimeRAII Strong(Policy);
1247     OS << Spec->getIdentifier()->getName();
1248     const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
1249     printTemplateArgumentList(
1250         OS, TemplateArgs.asArray(), Policy,
1251         Spec->getSpecializedTemplate()->getTemplateParameters());
1252     OS << "::";
1253   } else if (const auto *Tag = dyn_cast<TagDecl>(DC)) {
1254     AppendScope(DC->getParent(), OS, Tag->getDeclName());
1255     if (TypedefNameDecl *Typedef = Tag->getTypedefNameForAnonDecl())
1256       OS << Typedef->getIdentifier()->getName() << "::";
1257     else if (Tag->getIdentifier())
1258       OS << Tag->getIdentifier()->getName() << "::";
1259     else
1260       return;
1261   } else {
1262     AppendScope(DC->getParent(), OS, NameInScope);
1263   }
1264 }
1265 
1266 void TypePrinter::printTag(TagDecl *D, raw_ostream &OS) {
1267   if (Policy.IncludeTagDefinition) {
1268     PrintingPolicy SubPolicy = Policy;
1269     SubPolicy.IncludeTagDefinition = false;
1270     D->print(OS, SubPolicy, Indentation);
1271     spaceBeforePlaceHolder(OS);
1272     return;
1273   }
1274 
1275   bool HasKindDecoration = false;
1276 
1277   // We don't print tags unless this is an elaborated type.
1278   // In C, we just assume every RecordType is an elaborated type.
1279   if (!Policy.SuppressTagKeyword && !D->getTypedefNameForAnonDecl()) {
1280     HasKindDecoration = true;
1281     OS << D->getKindName();
1282     OS << ' ';
1283   }
1284 
1285   // Compute the full nested-name-specifier for this type.
1286   // In C, this will always be empty except when the type
1287   // being printed is anonymous within other Record.
1288   if (!Policy.SuppressScope)
1289     AppendScope(D->getDeclContext(), OS, D->getDeclName());
1290 
1291   if (const IdentifierInfo *II = D->getIdentifier())
1292     OS << II->getName();
1293   else if (TypedefNameDecl *Typedef = D->getTypedefNameForAnonDecl()) {
1294     assert(Typedef->getIdentifier() && "Typedef without identifier?");
1295     OS << Typedef->getIdentifier()->getName();
1296   } else {
1297     // Make an unambiguous representation for anonymous types, e.g.
1298     //   (anonymous enum at /usr/include/string.h:120:9)
1299     OS << (Policy.MSVCFormatting ? '`' : '(');
1300 
1301     if (isa<CXXRecordDecl>(D) && cast<CXXRecordDecl>(D)->isLambda()) {
1302       OS << "lambda";
1303       HasKindDecoration = true;
1304     } else {
1305       OS << "anonymous";
1306     }
1307 
1308     if (Policy.AnonymousTagLocations) {
1309       // Suppress the redundant tag keyword if we just printed one.
1310       // We don't have to worry about ElaboratedTypes here because you can't
1311       // refer to an anonymous type with one.
1312       if (!HasKindDecoration)
1313         OS << " " << D->getKindName();
1314 
1315       PresumedLoc PLoc = D->getASTContext().getSourceManager().getPresumedLoc(
1316           D->getLocation());
1317       if (PLoc.isValid()) {
1318         OS << " at ";
1319         StringRef File = PLoc.getFilename();
1320         if (auto *Callbacks = Policy.Callbacks)
1321           OS << Callbacks->remapPath(File);
1322         else
1323           OS << File;
1324         OS << ':' << PLoc.getLine() << ':' << PLoc.getColumn();
1325       }
1326     }
1327 
1328     OS << (Policy.MSVCFormatting ? '\'' : ')');
1329   }
1330 
1331   // If this is a class template specialization, print the template
1332   // arguments.
1333   if (const auto *Spec = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
1334     ArrayRef<TemplateArgument> Args;
1335     TypeSourceInfo *TAW = Spec->getTypeAsWritten();
1336     if (!Policy.PrintCanonicalTypes && TAW) {
1337       const TemplateSpecializationType *TST =
1338         cast<TemplateSpecializationType>(TAW->getType());
1339       Args = TST->template_arguments();
1340     } else {
1341       const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
1342       Args = TemplateArgs.asArray();
1343     }
1344     IncludeStrongLifetimeRAII Strong(Policy);
1345     printTemplateArgumentList(
1346         OS, Args, Policy,
1347         Spec->getSpecializedTemplate()->getTemplateParameters());
1348   }
1349 
1350   spaceBeforePlaceHolder(OS);
1351 }
1352 
1353 void TypePrinter::printRecordBefore(const RecordType *T, raw_ostream &OS) {
1354   // Print the preferred name if we have one for this type.
1355   for (const auto *PNA : T->getDecl()->specific_attrs<PreferredNameAttr>()) {
1356     if (declaresSameEntity(PNA->getTypedefType()->getAsCXXRecordDecl(),
1357                            T->getDecl())) {
1358       // Find the outermost typedef or alias template.
1359       QualType T = PNA->getTypedefType();
1360       while (true) {
1361         if (auto *TT = dyn_cast<TypedefType>(T))
1362           return printTypeSpec(TT->getDecl(), OS);
1363         if (auto *TST = dyn_cast<TemplateSpecializationType>(T))
1364           return printTemplateId(TST, OS, /*FullyQualify=*/true);
1365         T = T->getLocallyUnqualifiedSingleStepDesugaredType();
1366       }
1367     }
1368   }
1369 
1370   printTag(T->getDecl(), OS);
1371 }
1372 
1373 void TypePrinter::printRecordAfter(const RecordType *T, raw_ostream &OS) {}
1374 
1375 void TypePrinter::printEnumBefore(const EnumType *T, raw_ostream &OS) {
1376   printTag(T->getDecl(), OS);
1377 }
1378 
1379 void TypePrinter::printEnumAfter(const EnumType *T, raw_ostream &OS) {}
1380 
1381 void TypePrinter::printTemplateTypeParmBefore(const TemplateTypeParmType *T,
1382                                               raw_ostream &OS) {
1383   TemplateTypeParmDecl *D = T->getDecl();
1384   if (D && D->isImplicit()) {
1385     if (auto *TC = D->getTypeConstraint()) {
1386       TC->print(OS, Policy);
1387       OS << ' ';
1388     }
1389     OS << "auto";
1390   } else if (IdentifierInfo *Id = T->getIdentifier())
1391     OS << Id->getName();
1392   else
1393     OS << "type-parameter-" << T->getDepth() << '-' << T->getIndex();
1394 
1395   spaceBeforePlaceHolder(OS);
1396 }
1397 
1398 void TypePrinter::printTemplateTypeParmAfter(const TemplateTypeParmType *T,
1399                                              raw_ostream &OS) {}
1400 
1401 void TypePrinter::printSubstTemplateTypeParmBefore(
1402                                              const SubstTemplateTypeParmType *T,
1403                                              raw_ostream &OS) {
1404   IncludeStrongLifetimeRAII Strong(Policy);
1405   printBefore(T->getReplacementType(), OS);
1406 }
1407 
1408 void TypePrinter::printSubstTemplateTypeParmAfter(
1409                                              const SubstTemplateTypeParmType *T,
1410                                              raw_ostream &OS) {
1411   IncludeStrongLifetimeRAII Strong(Policy);
1412   printAfter(T->getReplacementType(), OS);
1413 }
1414 
1415 void TypePrinter::printSubstTemplateTypeParmPackBefore(
1416                                         const SubstTemplateTypeParmPackType *T,
1417                                         raw_ostream &OS) {
1418   IncludeStrongLifetimeRAII Strong(Policy);
1419   printTemplateTypeParmBefore(T->getReplacedParameter(), OS);
1420 }
1421 
1422 void TypePrinter::printSubstTemplateTypeParmPackAfter(
1423                                         const SubstTemplateTypeParmPackType *T,
1424                                         raw_ostream &OS) {
1425   IncludeStrongLifetimeRAII Strong(Policy);
1426   printTemplateTypeParmAfter(T->getReplacedParameter(), OS);
1427 }
1428 
1429 void TypePrinter::printTemplateId(const TemplateSpecializationType *T,
1430                                   raw_ostream &OS, bool FullyQualify) {
1431   IncludeStrongLifetimeRAII Strong(Policy);
1432 
1433   TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl();
1434   if (FullyQualify && TD) {
1435     if (!Policy.SuppressScope)
1436       AppendScope(TD->getDeclContext(), OS, TD->getDeclName());
1437 
1438     IdentifierInfo *II = TD->getIdentifier();
1439     OS << II->getName();
1440   } else {
1441     T->getTemplateName().print(OS, Policy);
1442   }
1443 
1444   const TemplateParameterList *TPL = TD ? TD->getTemplateParameters() : nullptr;
1445   printTemplateArgumentList(OS, T->template_arguments(), Policy, TPL);
1446   spaceBeforePlaceHolder(OS);
1447 }
1448 
1449 void TypePrinter::printTemplateSpecializationBefore(
1450                                             const TemplateSpecializationType *T,
1451                                             raw_ostream &OS) {
1452   printTemplateId(T, OS, false);
1453 }
1454 
1455 void TypePrinter::printTemplateSpecializationAfter(
1456                                             const TemplateSpecializationType *T,
1457                                             raw_ostream &OS) {}
1458 
1459 void TypePrinter::printInjectedClassNameBefore(const InjectedClassNameType *T,
1460                                                raw_ostream &OS) {
1461   if (Policy.PrintInjectedClassNameWithArguments)
1462     return printTemplateSpecializationBefore(T->getInjectedTST(), OS);
1463 
1464   IncludeStrongLifetimeRAII Strong(Policy);
1465   T->getTemplateName().print(OS, Policy);
1466   spaceBeforePlaceHolder(OS);
1467 }
1468 
1469 void TypePrinter::printInjectedClassNameAfter(const InjectedClassNameType *T,
1470                                                raw_ostream &OS) {}
1471 
1472 void TypePrinter::printElaboratedBefore(const ElaboratedType *T,
1473                                         raw_ostream &OS) {
1474   if (Policy.IncludeTagDefinition && T->getOwnedTagDecl()) {
1475     TagDecl *OwnedTagDecl = T->getOwnedTagDecl();
1476     assert(OwnedTagDecl->getTypeForDecl() == T->getNamedType().getTypePtr() &&
1477            "OwnedTagDecl expected to be a declaration for the type");
1478     PrintingPolicy SubPolicy = Policy;
1479     SubPolicy.IncludeTagDefinition = false;
1480     OwnedTagDecl->print(OS, SubPolicy, Indentation);
1481     spaceBeforePlaceHolder(OS);
1482     return;
1483   }
1484 
1485   // The tag definition will take care of these.
1486   if (!Policy.IncludeTagDefinition)
1487   {
1488     OS << TypeWithKeyword::getKeywordName(T->getKeyword());
1489     if (T->getKeyword() != ETK_None)
1490       OS << " ";
1491     NestedNameSpecifier *Qualifier = T->getQualifier();
1492     if (Qualifier)
1493       Qualifier->print(OS, Policy);
1494   }
1495 
1496   ElaboratedTypePolicyRAII PolicyRAII(Policy);
1497   printBefore(T->getNamedType(), OS);
1498 }
1499 
1500 void TypePrinter::printElaboratedAfter(const ElaboratedType *T,
1501                                         raw_ostream &OS) {
1502   if (Policy.IncludeTagDefinition && T->getOwnedTagDecl())
1503     return;
1504   ElaboratedTypePolicyRAII PolicyRAII(Policy);
1505   printAfter(T->getNamedType(), OS);
1506 }
1507 
1508 void TypePrinter::printParenBefore(const ParenType *T, raw_ostream &OS) {
1509   if (!HasEmptyPlaceHolder && !isa<FunctionType>(T->getInnerType())) {
1510     printBefore(T->getInnerType(), OS);
1511     OS << '(';
1512   } else
1513     printBefore(T->getInnerType(), OS);
1514 }
1515 
1516 void TypePrinter::printParenAfter(const ParenType *T, raw_ostream &OS) {
1517   if (!HasEmptyPlaceHolder && !isa<FunctionType>(T->getInnerType())) {
1518     OS << ')';
1519     printAfter(T->getInnerType(), OS);
1520   } else
1521     printAfter(T->getInnerType(), OS);
1522 }
1523 
1524 void TypePrinter::printDependentNameBefore(const DependentNameType *T,
1525                                            raw_ostream &OS) {
1526   OS << TypeWithKeyword::getKeywordName(T->getKeyword());
1527   if (T->getKeyword() != ETK_None)
1528     OS << " ";
1529 
1530   T->getQualifier()->print(OS, Policy);
1531 
1532   OS << T->getIdentifier()->getName();
1533   spaceBeforePlaceHolder(OS);
1534 }
1535 
1536 void TypePrinter::printDependentNameAfter(const DependentNameType *T,
1537                                           raw_ostream &OS) {}
1538 
1539 void TypePrinter::printDependentTemplateSpecializationBefore(
1540         const DependentTemplateSpecializationType *T, raw_ostream &OS) {
1541   IncludeStrongLifetimeRAII Strong(Policy);
1542 
1543   OS << TypeWithKeyword::getKeywordName(T->getKeyword());
1544   if (T->getKeyword() != ETK_None)
1545     OS << " ";
1546 
1547   if (T->getQualifier())
1548     T->getQualifier()->print(OS, Policy);
1549   OS << "template " << T->getIdentifier()->getName();
1550   printTemplateArgumentList(OS, T->template_arguments(), Policy);
1551   spaceBeforePlaceHolder(OS);
1552 }
1553 
1554 void TypePrinter::printDependentTemplateSpecializationAfter(
1555         const DependentTemplateSpecializationType *T, raw_ostream &OS) {}
1556 
1557 void TypePrinter::printPackExpansionBefore(const PackExpansionType *T,
1558                                            raw_ostream &OS) {
1559   printBefore(T->getPattern(), OS);
1560 }
1561 
1562 void TypePrinter::printPackExpansionAfter(const PackExpansionType *T,
1563                                           raw_ostream &OS) {
1564   printAfter(T->getPattern(), OS);
1565   OS << "...";
1566 }
1567 
1568 void TypePrinter::printAttributedBefore(const AttributedType *T,
1569                                         raw_ostream &OS) {
1570   // FIXME: Generate this with TableGen.
1571 
1572   // Prefer the macro forms of the GC and ownership qualifiers.
1573   if (T->getAttrKind() == attr::ObjCGC ||
1574       T->getAttrKind() == attr::ObjCOwnership)
1575     return printBefore(T->getEquivalentType(), OS);
1576 
1577   if (T->getAttrKind() == attr::ObjCKindOf)
1578     OS << "__kindof ";
1579 
1580   if (T->getAttrKind() == attr::AddressSpace)
1581     printBefore(T->getEquivalentType(), OS);
1582   else
1583     printBefore(T->getModifiedType(), OS);
1584 
1585   if (T->isMSTypeSpec()) {
1586     switch (T->getAttrKind()) {
1587     default: return;
1588     case attr::Ptr32: OS << " __ptr32"; break;
1589     case attr::Ptr64: OS << " __ptr64"; break;
1590     case attr::SPtr: OS << " __sptr"; break;
1591     case attr::UPtr: OS << " __uptr"; break;
1592     }
1593     spaceBeforePlaceHolder(OS);
1594   }
1595 
1596   // Print nullability type specifiers.
1597   if (T->getImmediateNullability()) {
1598     if (T->getAttrKind() == attr::TypeNonNull)
1599       OS << " _Nonnull";
1600     else if (T->getAttrKind() == attr::TypeNullable)
1601       OS << " _Nullable";
1602     else if (T->getAttrKind() == attr::TypeNullUnspecified)
1603       OS << " _Null_unspecified";
1604     else if (T->getAttrKind() == attr::TypeNullableResult)
1605       OS << " _Nullable_result";
1606     else
1607       llvm_unreachable("unhandled nullability");
1608     spaceBeforePlaceHolder(OS);
1609   }
1610 }
1611 
1612 void TypePrinter::printAttributedAfter(const AttributedType *T,
1613                                        raw_ostream &OS) {
1614   // FIXME: Generate this with TableGen.
1615 
1616   // Prefer the macro forms of the GC and ownership qualifiers.
1617   if (T->getAttrKind() == attr::ObjCGC ||
1618       T->getAttrKind() == attr::ObjCOwnership)
1619     return printAfter(T->getEquivalentType(), OS);
1620 
1621   // If this is a calling convention attribute, don't print the implicit CC from
1622   // the modified type.
1623   SaveAndRestore<bool> MaybeSuppressCC(InsideCCAttribute, T->isCallingConv());
1624 
1625   printAfter(T->getModifiedType(), OS);
1626 
1627   // Some attributes are printed as qualifiers before the type, so we have
1628   // nothing left to do.
1629   if (T->getAttrKind() == attr::ObjCKindOf ||
1630       T->isMSTypeSpec() || T->getImmediateNullability())
1631     return;
1632 
1633   // Don't print the inert __unsafe_unretained attribute at all.
1634   if (T->getAttrKind() == attr::ObjCInertUnsafeUnretained)
1635     return;
1636 
1637   // Don't print ns_returns_retained unless it had an effect.
1638   if (T->getAttrKind() == attr::NSReturnsRetained &&
1639       !T->getEquivalentType()->castAs<FunctionType>()
1640                              ->getExtInfo().getProducesResult())
1641     return;
1642 
1643   if (T->getAttrKind() == attr::LifetimeBound) {
1644     OS << " [[clang::lifetimebound]]";
1645     return;
1646   }
1647 
1648   // The printing of the address_space attribute is handled by the qualifier
1649   // since it is still stored in the qualifier. Return early to prevent printing
1650   // this twice.
1651   if (T->getAttrKind() == attr::AddressSpace)
1652     return;
1653 
1654   OS << " __attribute__((";
1655   switch (T->getAttrKind()) {
1656 #define TYPE_ATTR(NAME)
1657 #define DECL_OR_TYPE_ATTR(NAME)
1658 #define ATTR(NAME) case attr::NAME:
1659 #include "clang/Basic/AttrList.inc"
1660     llvm_unreachable("non-type attribute attached to type");
1661 
1662   case attr::OpenCLPrivateAddressSpace:
1663   case attr::OpenCLGlobalAddressSpace:
1664   case attr::OpenCLGlobalDeviceAddressSpace:
1665   case attr::OpenCLGlobalHostAddressSpace:
1666   case attr::OpenCLLocalAddressSpace:
1667   case attr::OpenCLConstantAddressSpace:
1668   case attr::OpenCLGenericAddressSpace:
1669     // FIXME: Update printAttributedBefore to print these once we generate
1670     // AttributedType nodes for them.
1671     break;
1672 
1673   case attr::LifetimeBound:
1674   case attr::TypeNonNull:
1675   case attr::TypeNullable:
1676   case attr::TypeNullableResult:
1677   case attr::TypeNullUnspecified:
1678   case attr::ObjCGC:
1679   case attr::ObjCInertUnsafeUnretained:
1680   case attr::ObjCKindOf:
1681   case attr::ObjCOwnership:
1682   case attr::Ptr32:
1683   case attr::Ptr64:
1684   case attr::SPtr:
1685   case attr::UPtr:
1686   case attr::AddressSpace:
1687   case attr::CmseNSCall:
1688     llvm_unreachable("This attribute should have been handled already");
1689 
1690   case attr::NSReturnsRetained:
1691     OS << "ns_returns_retained";
1692     break;
1693 
1694   // FIXME: When Sema learns to form this AttributedType, avoid printing the
1695   // attribute again in printFunctionProtoAfter.
1696   case attr::AnyX86NoCfCheck: OS << "nocf_check"; break;
1697   case attr::CDecl: OS << "cdecl"; break;
1698   case attr::FastCall: OS << "fastcall"; break;
1699   case attr::StdCall: OS << "stdcall"; break;
1700   case attr::ThisCall: OS << "thiscall"; break;
1701   case attr::SwiftCall: OS << "swiftcall"; break;
1702   case attr::VectorCall: OS << "vectorcall"; break;
1703   case attr::Pascal: OS << "pascal"; break;
1704   case attr::MSABI: OS << "ms_abi"; break;
1705   case attr::SysVABI: OS << "sysv_abi"; break;
1706   case attr::RegCall: OS << "regcall"; break;
1707   case attr::Pcs: {
1708     OS << "pcs(";
1709    QualType t = T->getEquivalentType();
1710    while (!t->isFunctionType())
1711      t = t->getPointeeType();
1712    OS << (t->castAs<FunctionType>()->getCallConv() == CC_AAPCS ?
1713          "\"aapcs\"" : "\"aapcs-vfp\"");
1714    OS << ')';
1715    break;
1716   }
1717   case attr::AArch64VectorPcs: OS << "aarch64_vector_pcs"; break;
1718   case attr::IntelOclBicc: OS << "inteloclbicc"; break;
1719   case attr::PreserveMost:
1720     OS << "preserve_most";
1721     break;
1722 
1723   case attr::PreserveAll:
1724     OS << "preserve_all";
1725     break;
1726   case attr::NoDeref:
1727     OS << "noderef";
1728     break;
1729   case attr::AcquireHandle:
1730     OS << "acquire_handle";
1731     break;
1732   case attr::ArmMveStrictPolymorphism:
1733     OS << "__clang_arm_mve_strict_polymorphism";
1734     break;
1735   }
1736   OS << "))";
1737 }
1738 
1739 void TypePrinter::printObjCInterfaceBefore(const ObjCInterfaceType *T,
1740                                            raw_ostream &OS) {
1741   OS << T->getDecl()->getName();
1742   spaceBeforePlaceHolder(OS);
1743 }
1744 
1745 void TypePrinter::printObjCInterfaceAfter(const ObjCInterfaceType *T,
1746                                           raw_ostream &OS) {}
1747 
1748 void TypePrinter::printObjCTypeParamBefore(const ObjCTypeParamType *T,
1749                                           raw_ostream &OS) {
1750   OS << T->getDecl()->getName();
1751   if (!T->qual_empty()) {
1752     bool isFirst = true;
1753     OS << '<';
1754     for (const auto *I : T->quals()) {
1755       if (isFirst)
1756         isFirst = false;
1757       else
1758         OS << ',';
1759       OS << I->getName();
1760     }
1761     OS << '>';
1762   }
1763 
1764   spaceBeforePlaceHolder(OS);
1765 }
1766 
1767 void TypePrinter::printObjCTypeParamAfter(const ObjCTypeParamType *T,
1768                                           raw_ostream &OS) {}
1769 
1770 void TypePrinter::printObjCObjectBefore(const ObjCObjectType *T,
1771                                         raw_ostream &OS) {
1772   if (T->qual_empty() && T->isUnspecializedAsWritten() &&
1773       !T->isKindOfTypeAsWritten())
1774     return printBefore(T->getBaseType(), OS);
1775 
1776   if (T->isKindOfTypeAsWritten())
1777     OS << "__kindof ";
1778 
1779   print(T->getBaseType(), OS, StringRef());
1780 
1781   if (T->isSpecializedAsWritten()) {
1782     bool isFirst = true;
1783     OS << '<';
1784     for (auto typeArg : T->getTypeArgsAsWritten()) {
1785       if (isFirst)
1786         isFirst = false;
1787       else
1788         OS << ",";
1789 
1790       print(typeArg, OS, StringRef());
1791     }
1792     OS << '>';
1793   }
1794 
1795   if (!T->qual_empty()) {
1796     bool isFirst = true;
1797     OS << '<';
1798     for (const auto *I : T->quals()) {
1799       if (isFirst)
1800         isFirst = false;
1801       else
1802         OS << ',';
1803       OS << I->getName();
1804     }
1805     OS << '>';
1806   }
1807 
1808   spaceBeforePlaceHolder(OS);
1809 }
1810 
1811 void TypePrinter::printObjCObjectAfter(const ObjCObjectType *T,
1812                                         raw_ostream &OS) {
1813   if (T->qual_empty() && T->isUnspecializedAsWritten() &&
1814       !T->isKindOfTypeAsWritten())
1815     return printAfter(T->getBaseType(), OS);
1816 }
1817 
1818 void TypePrinter::printObjCObjectPointerBefore(const ObjCObjectPointerType *T,
1819                                                raw_ostream &OS) {
1820   printBefore(T->getPointeeType(), OS);
1821 
1822   // If we need to print the pointer, print it now.
1823   if (!T->isObjCIdType() && !T->isObjCQualifiedIdType() &&
1824       !T->isObjCClassType() && !T->isObjCQualifiedClassType()) {
1825     if (HasEmptyPlaceHolder)
1826       OS << ' ';
1827     OS << '*';
1828   }
1829 }
1830 
1831 void TypePrinter::printObjCObjectPointerAfter(const ObjCObjectPointerType *T,
1832                                               raw_ostream &OS) {}
1833 
1834 static
1835 const TemplateArgument &getArgument(const TemplateArgument &A) { return A; }
1836 
1837 static const TemplateArgument &getArgument(const TemplateArgumentLoc &A) {
1838   return A.getArgument();
1839 }
1840 
1841 static void printArgument(const TemplateArgument &A, const PrintingPolicy &PP,
1842                           llvm::raw_ostream &OS) {
1843   A.print(PP, OS);
1844 }
1845 
1846 static void printArgument(const TemplateArgumentLoc &A,
1847                           const PrintingPolicy &PP, llvm::raw_ostream &OS) {
1848   const TemplateArgument::ArgKind &Kind = A.getArgument().getKind();
1849   if (Kind == TemplateArgument::ArgKind::Type)
1850     return A.getTypeSourceInfo()->getType().print(OS, PP);
1851   return A.getArgument().print(PP, OS);
1852 }
1853 
1854 static bool isSubstitutedTemplateArgument(ASTContext &Ctx, TemplateArgument Arg,
1855                                           TemplateArgument Pattern,
1856                                           ArrayRef<TemplateArgument> Args,
1857                                           unsigned Depth);
1858 
1859 static bool isSubstitutedType(ASTContext &Ctx, QualType T, QualType Pattern,
1860                               ArrayRef<TemplateArgument> Args, unsigned Depth) {
1861   if (Ctx.hasSameType(T, Pattern))
1862     return true;
1863 
1864   // A type parameter matches its argument.
1865   if (auto *TTPT = Pattern->getAs<TemplateTypeParmType>()) {
1866     if (TTPT->getDepth() == Depth && TTPT->getIndex() < Args.size() &&
1867         Args[TTPT->getIndex()].getKind() == TemplateArgument::Type) {
1868       QualType SubstArg = Ctx.getQualifiedType(
1869           Args[TTPT->getIndex()].getAsType(), Pattern.getQualifiers());
1870       return Ctx.hasSameType(SubstArg, T);
1871     }
1872     return false;
1873   }
1874 
1875   // FIXME: Recurse into array types.
1876 
1877   // All other cases will need the types to be identically qualified.
1878   Qualifiers TQual, PatQual;
1879   T = Ctx.getUnqualifiedArrayType(T, TQual);
1880   Pattern = Ctx.getUnqualifiedArrayType(Pattern, PatQual);
1881   if (TQual != PatQual)
1882     return false;
1883 
1884   // Recurse into pointer-like types.
1885   {
1886     QualType TPointee = T->getPointeeType();
1887     QualType PPointee = Pattern->getPointeeType();
1888     if (!TPointee.isNull() && !PPointee.isNull())
1889       return T->getTypeClass() == Pattern->getTypeClass() &&
1890              isSubstitutedType(Ctx, TPointee, PPointee, Args, Depth);
1891   }
1892 
1893   // Recurse into template specialization types.
1894   if (auto *PTST =
1895           Pattern.getCanonicalType()->getAs<TemplateSpecializationType>()) {
1896     TemplateName Template;
1897     ArrayRef<TemplateArgument> TemplateArgs;
1898     if (auto *TTST = T->getAs<TemplateSpecializationType>()) {
1899       Template = TTST->getTemplateName();
1900       TemplateArgs = TTST->template_arguments();
1901     } else if (auto *CTSD = dyn_cast_or_null<ClassTemplateSpecializationDecl>(
1902                    T->getAsCXXRecordDecl())) {
1903       Template = TemplateName(CTSD->getSpecializedTemplate());
1904       TemplateArgs = CTSD->getTemplateArgs().asArray();
1905     } else {
1906       return false;
1907     }
1908 
1909     if (!isSubstitutedTemplateArgument(Ctx, Template, PTST->getTemplateName(),
1910                                        Args, Depth))
1911       return false;
1912     if (TemplateArgs.size() != PTST->getNumArgs())
1913       return false;
1914     for (unsigned I = 0, N = TemplateArgs.size(); I != N; ++I)
1915       if (!isSubstitutedTemplateArgument(Ctx, TemplateArgs[I], PTST->getArg(I),
1916                                          Args, Depth))
1917         return false;
1918     return true;
1919   }
1920 
1921   // FIXME: Handle more cases.
1922   return false;
1923 }
1924 
1925 static bool isSubstitutedTemplateArgument(ASTContext &Ctx, TemplateArgument Arg,
1926                                           TemplateArgument Pattern,
1927                                           ArrayRef<TemplateArgument> Args,
1928                                           unsigned Depth) {
1929   Arg = Ctx.getCanonicalTemplateArgument(Arg);
1930   Pattern = Ctx.getCanonicalTemplateArgument(Pattern);
1931   if (Arg.structurallyEquals(Pattern))
1932     return true;
1933 
1934   if (Pattern.getKind() == TemplateArgument::Expression) {
1935     if (auto *DRE =
1936             dyn_cast<DeclRefExpr>(Pattern.getAsExpr()->IgnoreParenImpCasts())) {
1937       if (auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(DRE->getDecl()))
1938         return NTTP->getDepth() == Depth && Args.size() > NTTP->getIndex() &&
1939                Args[NTTP->getIndex()].structurallyEquals(Arg);
1940     }
1941   }
1942 
1943   if (Arg.getKind() != Pattern.getKind())
1944     return false;
1945 
1946   if (Arg.getKind() == TemplateArgument::Type)
1947     return isSubstitutedType(Ctx, Arg.getAsType(), Pattern.getAsType(), Args,
1948                              Depth);
1949 
1950   if (Arg.getKind() == TemplateArgument::Template) {
1951     TemplateDecl *PatTD = Pattern.getAsTemplate().getAsTemplateDecl();
1952     if (auto *TTPD = dyn_cast_or_null<TemplateTemplateParmDecl>(PatTD))
1953       return TTPD->getDepth() == Depth && Args.size() > TTPD->getIndex() &&
1954              Ctx.getCanonicalTemplateArgument(Args[TTPD->getIndex()])
1955                  .structurallyEquals(Arg);
1956   }
1957 
1958   // FIXME: Handle more cases.
1959   return false;
1960 }
1961 
1962 /// Make a best-effort determination of whether the type T can be produced by
1963 /// substituting Args into the default argument of Param.
1964 static bool isSubstitutedDefaultArgument(ASTContext &Ctx, TemplateArgument Arg,
1965                                          const NamedDecl *Param,
1966                                          ArrayRef<TemplateArgument> Args,
1967                                          unsigned Depth) {
1968   // An empty pack is equivalent to not providing a pack argument.
1969   if (Arg.getKind() == TemplateArgument::Pack && Arg.pack_size() == 0)
1970     return true;
1971 
1972   if (auto *TTPD = dyn_cast<TemplateTypeParmDecl>(Param)) {
1973     return TTPD->hasDefaultArgument() &&
1974            isSubstitutedTemplateArgument(Ctx, Arg, TTPD->getDefaultArgument(),
1975                                          Args, Depth);
1976   } else if (auto *TTPD = dyn_cast<TemplateTemplateParmDecl>(Param)) {
1977     return TTPD->hasDefaultArgument() &&
1978            isSubstitutedTemplateArgument(
1979                Ctx, Arg, TTPD->getDefaultArgument().getArgument(), Args, Depth);
1980   } else if (auto *NTTPD = dyn_cast<NonTypeTemplateParmDecl>(Param)) {
1981     return NTTPD->hasDefaultArgument() &&
1982            isSubstitutedTemplateArgument(Ctx, Arg, NTTPD->getDefaultArgument(),
1983                                          Args, Depth);
1984   }
1985   return false;
1986 }
1987 
1988 template<typename TA>
1989 static void printTo(raw_ostream &OS, ArrayRef<TA> Args,
1990                     const PrintingPolicy &Policy, bool SkipBrackets,
1991                     const TemplateParameterList *TPL) {
1992   // Drop trailing template arguments that match default arguments.
1993   if (TPL && Policy.SuppressDefaultTemplateArgs &&
1994       !Policy.PrintCanonicalTypes && !Args.empty() &&
1995       Args.size() <= TPL->size()) {
1996     ASTContext &Ctx = TPL->getParam(0)->getASTContext();
1997     llvm::SmallVector<TemplateArgument, 8> OrigArgs;
1998     for (const TA &A : Args)
1999       OrigArgs.push_back(getArgument(A));
2000     while (!Args.empty() &&
2001            isSubstitutedDefaultArgument(Ctx, getArgument(Args.back()),
2002                                         TPL->getParam(Args.size() - 1),
2003                                         OrigArgs, TPL->getDepth()))
2004       Args = Args.drop_back();
2005   }
2006 
2007   const char *Comma = Policy.MSVCFormatting ? "," : ", ";
2008   if (!SkipBrackets)
2009     OS << '<';
2010 
2011   bool NeedSpace = false;
2012   bool FirstArg = true;
2013   for (const auto &Arg : Args) {
2014     // Print the argument into a string.
2015     SmallString<128> Buf;
2016     llvm::raw_svector_ostream ArgOS(Buf);
2017     const TemplateArgument &Argument = getArgument(Arg);
2018     if (Argument.getKind() == TemplateArgument::Pack) {
2019       if (Argument.pack_size() && !FirstArg)
2020         OS << Comma;
2021       printTo(ArgOS, Argument.getPackAsArray(), Policy, true, nullptr);
2022     } else {
2023       if (!FirstArg)
2024         OS << Comma;
2025       // Tries to print the argument with location info if exists.
2026       printArgument(Arg, Policy, ArgOS);
2027     }
2028     StringRef ArgString = ArgOS.str();
2029 
2030     // If this is the first argument and its string representation
2031     // begins with the global scope specifier ('::foo'), add a space
2032     // to avoid printing the diagraph '<:'.
2033     if (FirstArg && !ArgString.empty() && ArgString[0] == ':')
2034       OS << ' ';
2035 
2036     OS << ArgString;
2037 
2038     // If the last character of our string is '>', add another space to
2039     // keep the two '>''s separate tokens.
2040     NeedSpace = Policy.SplitTemplateClosers && !ArgString.empty() &&
2041                 ArgString.back() == '>';
2042     FirstArg = false;
2043   }
2044 
2045   if (NeedSpace)
2046     OS << ' ';
2047 
2048   if (!SkipBrackets)
2049     OS << '>';
2050 }
2051 
2052 void clang::printTemplateArgumentList(raw_ostream &OS,
2053                                       const TemplateArgumentListInfo &Args,
2054                                       const PrintingPolicy &Policy,
2055                                       const TemplateParameterList *TPL) {
2056   printTemplateArgumentList(OS, Args.arguments(), Policy, TPL);
2057 }
2058 
2059 void clang::printTemplateArgumentList(raw_ostream &OS,
2060                                       ArrayRef<TemplateArgument> Args,
2061                                       const PrintingPolicy &Policy,
2062                                       const TemplateParameterList *TPL) {
2063   printTo(OS, Args, Policy, false, TPL);
2064 }
2065 
2066 void clang::printTemplateArgumentList(raw_ostream &OS,
2067                                       ArrayRef<TemplateArgumentLoc> Args,
2068                                       const PrintingPolicy &Policy,
2069                                       const TemplateParameterList *TPL) {
2070   printTo(OS, Args, Policy, false, TPL);
2071 }
2072 
2073 std::string Qualifiers::getAsString() const {
2074   LangOptions LO;
2075   return getAsString(PrintingPolicy(LO));
2076 }
2077 
2078 // Appends qualifiers to the given string, separated by spaces.  Will
2079 // prefix a space if the string is non-empty.  Will not append a final
2080 // space.
2081 std::string Qualifiers::getAsString(const PrintingPolicy &Policy) const {
2082   SmallString<64> Buf;
2083   llvm::raw_svector_ostream StrOS(Buf);
2084   print(StrOS, Policy);
2085   return std::string(StrOS.str());
2086 }
2087 
2088 bool Qualifiers::isEmptyWhenPrinted(const PrintingPolicy &Policy) const {
2089   if (getCVRQualifiers())
2090     return false;
2091 
2092   if (getAddressSpace() != LangAS::Default)
2093     return false;
2094 
2095   if (getObjCGCAttr())
2096     return false;
2097 
2098   if (Qualifiers::ObjCLifetime lifetime = getObjCLifetime())
2099     if (!(lifetime == Qualifiers::OCL_Strong && Policy.SuppressStrongLifetime))
2100       return false;
2101 
2102   return true;
2103 }
2104 
2105 std::string Qualifiers::getAddrSpaceAsString(LangAS AS) {
2106   switch (AS) {
2107   case LangAS::Default:
2108     return "";
2109   case LangAS::opencl_global:
2110     return "__global";
2111   case LangAS::opencl_local:
2112     return "__local";
2113   case LangAS::opencl_private:
2114     return "__private";
2115   case LangAS::opencl_constant:
2116     return "__constant";
2117   case LangAS::opencl_generic:
2118     return "__generic";
2119   case LangAS::opencl_global_device:
2120     return "__global_device";
2121   case LangAS::opencl_global_host:
2122     return "__global_host";
2123   case LangAS::cuda_device:
2124     return "__device__";
2125   case LangAS::cuda_constant:
2126     return "__constant__";
2127   case LangAS::cuda_shared:
2128     return "__shared__";
2129   case LangAS::ptr32_sptr:
2130     return "__sptr __ptr32";
2131   case LangAS::ptr32_uptr:
2132     return "__uptr __ptr32";
2133   case LangAS::ptr64:
2134     return "__ptr64";
2135   default:
2136     return std::to_string(toTargetAddressSpace(AS));
2137   }
2138 }
2139 
2140 // Appends qualifiers to the given string, separated by spaces.  Will
2141 // prefix a space if the string is non-empty.  Will not append a final
2142 // space.
2143 void Qualifiers::print(raw_ostream &OS, const PrintingPolicy& Policy,
2144                        bool appendSpaceIfNonEmpty) const {
2145   bool addSpace = false;
2146 
2147   unsigned quals = getCVRQualifiers();
2148   if (quals) {
2149     AppendTypeQualList(OS, quals, Policy.Restrict);
2150     addSpace = true;
2151   }
2152   if (hasUnaligned()) {
2153     if (addSpace)
2154       OS << ' ';
2155     OS << "__unaligned";
2156     addSpace = true;
2157   }
2158   auto ASStr = getAddrSpaceAsString(getAddressSpace());
2159   if (!ASStr.empty()) {
2160     if (addSpace)
2161       OS << ' ';
2162     addSpace = true;
2163     // Wrap target address space into an attribute syntax
2164     if (isTargetAddressSpace(getAddressSpace()))
2165       OS << "__attribute__((address_space(" << ASStr << ")))";
2166     else
2167       OS << ASStr;
2168   }
2169 
2170   if (Qualifiers::GC gc = getObjCGCAttr()) {
2171     if (addSpace)
2172       OS << ' ';
2173     addSpace = true;
2174     if (gc == Qualifiers::Weak)
2175       OS << "__weak";
2176     else
2177       OS << "__strong";
2178   }
2179   if (Qualifiers::ObjCLifetime lifetime = getObjCLifetime()) {
2180     if (!(lifetime == Qualifiers::OCL_Strong && Policy.SuppressStrongLifetime)){
2181       if (addSpace)
2182         OS << ' ';
2183       addSpace = true;
2184     }
2185 
2186     switch (lifetime) {
2187     case Qualifiers::OCL_None: llvm_unreachable("none but true");
2188     case Qualifiers::OCL_ExplicitNone: OS << "__unsafe_unretained"; break;
2189     case Qualifiers::OCL_Strong:
2190       if (!Policy.SuppressStrongLifetime)
2191         OS << "__strong";
2192       break;
2193 
2194     case Qualifiers::OCL_Weak: OS << "__weak"; break;
2195     case Qualifiers::OCL_Autoreleasing: OS << "__autoreleasing"; break;
2196     }
2197   }
2198 
2199   if (appendSpaceIfNonEmpty && addSpace)
2200     OS << ' ';
2201 }
2202 
2203 std::string QualType::getAsString() const {
2204   return getAsString(split(), LangOptions());
2205 }
2206 
2207 std::string QualType::getAsString(const PrintingPolicy &Policy) const {
2208   std::string S;
2209   getAsStringInternal(S, Policy);
2210   return S;
2211 }
2212 
2213 std::string QualType::getAsString(const Type *ty, Qualifiers qs,
2214                                   const PrintingPolicy &Policy) {
2215   std::string buffer;
2216   getAsStringInternal(ty, qs, buffer, Policy);
2217   return buffer;
2218 }
2219 
2220 void QualType::print(raw_ostream &OS, const PrintingPolicy &Policy,
2221                      const Twine &PlaceHolder, unsigned Indentation) const {
2222   print(splitAccordingToPolicy(*this, Policy), OS, Policy, PlaceHolder,
2223         Indentation);
2224 }
2225 
2226 void QualType::print(const Type *ty, Qualifiers qs,
2227                      raw_ostream &OS, const PrintingPolicy &policy,
2228                      const Twine &PlaceHolder, unsigned Indentation) {
2229   SmallString<128> PHBuf;
2230   StringRef PH = PlaceHolder.toStringRef(PHBuf);
2231 
2232   TypePrinter(policy, Indentation).print(ty, qs, OS, PH);
2233 }
2234 
2235 void QualType::getAsStringInternal(std::string &Str,
2236                                    const PrintingPolicy &Policy) const {
2237   return getAsStringInternal(splitAccordingToPolicy(*this, Policy), Str,
2238                              Policy);
2239 }
2240 
2241 void QualType::getAsStringInternal(const Type *ty, Qualifiers qs,
2242                                    std::string &buffer,
2243                                    const PrintingPolicy &policy) {
2244   SmallString<256> Buf;
2245   llvm::raw_svector_ostream StrOS(Buf);
2246   TypePrinter(policy).print(ty, qs, StrOS, buffer);
2247   std::string str = std::string(StrOS.str());
2248   buffer.swap(str);
2249 }
2250