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::SwiftAsyncContext:
850     return "swift_async_context";
851   case ParameterABI::SwiftErrorResult:
852     return "swift_error_result";
853   case ParameterABI::SwiftIndirectResult:
854     return "swift_indirect_result";
855   }
856   llvm_unreachable("bad parameter ABI kind");
857 }
858 
859 void TypePrinter::printFunctionProtoAfter(const FunctionProtoType *T,
860                                           raw_ostream &OS) {
861   // If needed for precedence reasons, wrap the inner part in grouping parens.
862   if (!HasEmptyPlaceHolder)
863     OS << ')';
864   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
865 
866   OS << '(';
867   {
868     ParamPolicyRAII ParamPolicy(Policy);
869     for (unsigned i = 0, e = T->getNumParams(); i != e; ++i) {
870       if (i) OS << ", ";
871 
872       auto EPI = T->getExtParameterInfo(i);
873       if (EPI.isConsumed()) OS << "__attribute__((ns_consumed)) ";
874       if (EPI.isNoEscape())
875         OS << "__attribute__((noescape)) ";
876       auto ABI = EPI.getABI();
877       if (ABI != ParameterABI::Ordinary)
878         OS << "__attribute__((" << getParameterABISpelling(ABI) << ")) ";
879 
880       print(T->getParamType(i), OS, StringRef());
881     }
882   }
883 
884   if (T->isVariadic()) {
885     if (T->getNumParams())
886       OS << ", ";
887     OS << "...";
888   } else if (T->getNumParams() == 0 && Policy.UseVoidForZeroParams) {
889     // Do not emit int() if we have a proto, emit 'int(void)'.
890     OS << "void";
891   }
892 
893   OS << ')';
894 
895   FunctionType::ExtInfo Info = T->getExtInfo();
896 
897   printFunctionAfter(Info, OS);
898 
899   if (!T->getMethodQuals().empty())
900     OS << " " << T->getMethodQuals().getAsString();
901 
902   switch (T->getRefQualifier()) {
903   case RQ_None:
904     break;
905 
906   case RQ_LValue:
907     OS << " &";
908     break;
909 
910   case RQ_RValue:
911     OS << " &&";
912     break;
913   }
914   T->printExceptionSpecification(OS, Policy);
915 
916   if (T->hasTrailingReturn()) {
917     OS << " -> ";
918     print(T->getReturnType(), OS, StringRef());
919   } else
920     printAfter(T->getReturnType(), OS);
921 }
922 
923 void TypePrinter::printFunctionAfter(const FunctionType::ExtInfo &Info,
924                                      raw_ostream &OS) {
925   if (!InsideCCAttribute) {
926     switch (Info.getCC()) {
927     case CC_C:
928       // The C calling convention is the default on the vast majority of platforms
929       // we support.  If the user wrote it explicitly, it will usually be printed
930       // while traversing the AttributedType.  If the type has been desugared, let
931       // the canonical spelling be the implicit calling convention.
932       // FIXME: It would be better to be explicit in certain contexts, such as a
933       // cdecl function typedef used to declare a member function with the
934       // Microsoft C++ ABI.
935       break;
936     case CC_X86StdCall:
937       OS << " __attribute__((stdcall))";
938       break;
939     case CC_X86FastCall:
940       OS << " __attribute__((fastcall))";
941       break;
942     case CC_X86ThisCall:
943       OS << " __attribute__((thiscall))";
944       break;
945     case CC_X86VectorCall:
946       OS << " __attribute__((vectorcall))";
947       break;
948     case CC_X86Pascal:
949       OS << " __attribute__((pascal))";
950       break;
951     case CC_AAPCS:
952       OS << " __attribute__((pcs(\"aapcs\")))";
953       break;
954     case CC_AAPCS_VFP:
955       OS << " __attribute__((pcs(\"aapcs-vfp\")))";
956       break;
957     case CC_AArch64VectorCall:
958       OS << "__attribute__((aarch64_vector_pcs))";
959       break;
960     case CC_IntelOclBicc:
961       OS << " __attribute__((intel_ocl_bicc))";
962       break;
963     case CC_Win64:
964       OS << " __attribute__((ms_abi))";
965       break;
966     case CC_X86_64SysV:
967       OS << " __attribute__((sysv_abi))";
968       break;
969     case CC_X86RegCall:
970       OS << " __attribute__((regcall))";
971       break;
972     case CC_SpirFunction:
973     case CC_OpenCLKernel:
974       // Do nothing. These CCs are not available as attributes.
975       break;
976     case CC_Swift:
977       OS << " __attribute__((swiftcall))";
978       break;
979     case CC_PreserveMost:
980       OS << " __attribute__((preserve_most))";
981       break;
982     case CC_PreserveAll:
983       OS << " __attribute__((preserve_all))";
984       break;
985     }
986   }
987 
988   if (Info.getNoReturn())
989     OS << " __attribute__((noreturn))";
990   if (Info.getCmseNSCall())
991     OS << " __attribute__((cmse_nonsecure_call))";
992   if (Info.getProducesResult())
993     OS << " __attribute__((ns_returns_retained))";
994   if (Info.getRegParm())
995     OS << " __attribute__((regparm ("
996        << Info.getRegParm() << ")))";
997   if (Info.getNoCallerSavedRegs())
998     OS << " __attribute__((no_caller_saved_registers))";
999   if (Info.getNoCfCheck())
1000     OS << " __attribute__((nocf_check))";
1001 }
1002 
1003 void TypePrinter::printFunctionNoProtoBefore(const FunctionNoProtoType *T,
1004                                              raw_ostream &OS) {
1005   // If needed for precedence reasons, wrap the inner part in grouping parens.
1006   SaveAndRestore<bool> PrevPHIsEmpty(HasEmptyPlaceHolder, false);
1007   printBefore(T->getReturnType(), OS);
1008   if (!PrevPHIsEmpty.get())
1009     OS << '(';
1010 }
1011 
1012 void TypePrinter::printFunctionNoProtoAfter(const FunctionNoProtoType *T,
1013                                             raw_ostream &OS) {
1014   // If needed for precedence reasons, wrap the inner part in grouping parens.
1015   if (!HasEmptyPlaceHolder)
1016     OS << ')';
1017   SaveAndRestore<bool> NonEmptyPH(HasEmptyPlaceHolder, false);
1018 
1019   OS << "()";
1020   printFunctionAfter(T->getExtInfo(), OS);
1021   printAfter(T->getReturnType(), OS);
1022 }
1023 
1024 void TypePrinter::printTypeSpec(NamedDecl *D, raw_ostream &OS) {
1025 
1026   // Compute the full nested-name-specifier for this type.
1027   // In C, this will always be empty except when the type
1028   // being printed is anonymous within other Record.
1029   if (!Policy.SuppressScope)
1030     AppendScope(D->getDeclContext(), OS, D->getDeclName());
1031 
1032   IdentifierInfo *II = D->getIdentifier();
1033   OS << II->getName();
1034   spaceBeforePlaceHolder(OS);
1035 }
1036 
1037 void TypePrinter::printUnresolvedUsingBefore(const UnresolvedUsingType *T,
1038                                              raw_ostream &OS) {
1039   printTypeSpec(T->getDecl(), OS);
1040 }
1041 
1042 void TypePrinter::printUnresolvedUsingAfter(const UnresolvedUsingType *T,
1043                                             raw_ostream &OS) {}
1044 
1045 void TypePrinter::printTypedefBefore(const TypedefType *T, raw_ostream &OS) {
1046   printTypeSpec(T->getDecl(), OS);
1047 }
1048 
1049 void TypePrinter::printMacroQualifiedBefore(const MacroQualifiedType *T,
1050                                             raw_ostream &OS) {
1051   StringRef MacroName = T->getMacroIdentifier()->getName();
1052   OS << MacroName << " ";
1053 
1054   // Since this type is meant to print the macro instead of the whole attribute,
1055   // we trim any attributes and go directly to the original modified type.
1056   printBefore(T->getModifiedType(), OS);
1057 }
1058 
1059 void TypePrinter::printMacroQualifiedAfter(const MacroQualifiedType *T,
1060                                            raw_ostream &OS) {
1061   printAfter(T->getModifiedType(), OS);
1062 }
1063 
1064 void TypePrinter::printTypedefAfter(const TypedefType *T, raw_ostream &OS) {}
1065 
1066 void TypePrinter::printTypeOfExprBefore(const TypeOfExprType *T,
1067                                         raw_ostream &OS) {
1068   OS << "typeof ";
1069   if (T->getUnderlyingExpr())
1070     T->getUnderlyingExpr()->printPretty(OS, nullptr, Policy);
1071   spaceBeforePlaceHolder(OS);
1072 }
1073 
1074 void TypePrinter::printTypeOfExprAfter(const TypeOfExprType *T,
1075                                        raw_ostream &OS) {}
1076 
1077 void TypePrinter::printTypeOfBefore(const TypeOfType *T, raw_ostream &OS) {
1078   OS << "typeof(";
1079   print(T->getUnderlyingType(), OS, StringRef());
1080   OS << ')';
1081   spaceBeforePlaceHolder(OS);
1082 }
1083 
1084 void TypePrinter::printTypeOfAfter(const TypeOfType *T, raw_ostream &OS) {}
1085 
1086 void TypePrinter::printDecltypeBefore(const DecltypeType *T, raw_ostream &OS) {
1087   OS << "decltype(";
1088   if (T->getUnderlyingExpr())
1089     T->getUnderlyingExpr()->printPretty(OS, nullptr, Policy);
1090   OS << ')';
1091   spaceBeforePlaceHolder(OS);
1092 }
1093 
1094 void TypePrinter::printDecltypeAfter(const DecltypeType *T, raw_ostream &OS) {}
1095 
1096 void TypePrinter::printUnaryTransformBefore(const UnaryTransformType *T,
1097                                             raw_ostream &OS) {
1098   IncludeStrongLifetimeRAII Strong(Policy);
1099 
1100   switch (T->getUTTKind()) {
1101     case UnaryTransformType::EnumUnderlyingType:
1102       OS << "__underlying_type(";
1103       print(T->getBaseType(), OS, StringRef());
1104       OS << ')';
1105       spaceBeforePlaceHolder(OS);
1106       return;
1107   }
1108 
1109   printBefore(T->getBaseType(), OS);
1110 }
1111 
1112 void TypePrinter::printUnaryTransformAfter(const UnaryTransformType *T,
1113                                            raw_ostream &OS) {
1114   IncludeStrongLifetimeRAII Strong(Policy);
1115 
1116   switch (T->getUTTKind()) {
1117     case UnaryTransformType::EnumUnderlyingType:
1118       return;
1119   }
1120 
1121   printAfter(T->getBaseType(), OS);
1122 }
1123 
1124 void TypePrinter::printAutoBefore(const AutoType *T, raw_ostream &OS) {
1125   // If the type has been deduced, do not print 'auto'.
1126   if (!T->getDeducedType().isNull()) {
1127     printBefore(T->getDeducedType(), OS);
1128   } else {
1129     if (T->isConstrained()) {
1130       // FIXME: Track a TypeConstraint as type sugar, so that we can print the
1131       // type as it was written.
1132       T->getTypeConstraintConcept()->getDeclName().print(OS, Policy);
1133       auto Args = T->getTypeConstraintArguments();
1134       if (!Args.empty())
1135         printTemplateArgumentList(
1136             OS, Args, Policy,
1137             T->getTypeConstraintConcept()->getTemplateParameters());
1138       OS << ' ';
1139     }
1140     switch (T->getKeyword()) {
1141     case AutoTypeKeyword::Auto: OS << "auto"; break;
1142     case AutoTypeKeyword::DecltypeAuto: OS << "decltype(auto)"; break;
1143     case AutoTypeKeyword::GNUAutoType: OS << "__auto_type"; break;
1144     }
1145     spaceBeforePlaceHolder(OS);
1146   }
1147 }
1148 
1149 void TypePrinter::printAutoAfter(const AutoType *T, raw_ostream &OS) {
1150   // If the type has been deduced, do not print 'auto'.
1151   if (!T->getDeducedType().isNull())
1152     printAfter(T->getDeducedType(), OS);
1153 }
1154 
1155 void TypePrinter::printDeducedTemplateSpecializationBefore(
1156     const DeducedTemplateSpecializationType *T, raw_ostream &OS) {
1157   // If the type has been deduced, print the deduced type.
1158   if (!T->getDeducedType().isNull()) {
1159     printBefore(T->getDeducedType(), OS);
1160   } else {
1161     IncludeStrongLifetimeRAII Strong(Policy);
1162     T->getTemplateName().print(OS, Policy);
1163     spaceBeforePlaceHolder(OS);
1164   }
1165 }
1166 
1167 void TypePrinter::printDeducedTemplateSpecializationAfter(
1168     const DeducedTemplateSpecializationType *T, raw_ostream &OS) {
1169   // If the type has been deduced, print the deduced type.
1170   if (!T->getDeducedType().isNull())
1171     printAfter(T->getDeducedType(), OS);
1172 }
1173 
1174 void TypePrinter::printAtomicBefore(const AtomicType *T, raw_ostream &OS) {
1175   IncludeStrongLifetimeRAII Strong(Policy);
1176 
1177   OS << "_Atomic(";
1178   print(T->getValueType(), OS, StringRef());
1179   OS << ')';
1180   spaceBeforePlaceHolder(OS);
1181 }
1182 
1183 void TypePrinter::printAtomicAfter(const AtomicType *T, raw_ostream &OS) {}
1184 
1185 void TypePrinter::printPipeBefore(const PipeType *T, raw_ostream &OS) {
1186   IncludeStrongLifetimeRAII Strong(Policy);
1187 
1188   if (T->isReadOnly())
1189     OS << "read_only ";
1190   else
1191     OS << "write_only ";
1192   OS << "pipe ";
1193   print(T->getElementType(), OS, StringRef());
1194   spaceBeforePlaceHolder(OS);
1195 }
1196 
1197 void TypePrinter::printPipeAfter(const PipeType *T, raw_ostream &OS) {}
1198 
1199 void TypePrinter::printExtIntBefore(const ExtIntType *T, raw_ostream &OS) {
1200   if (T->isUnsigned())
1201     OS << "unsigned ";
1202   OS << "_ExtInt(" << T->getNumBits() << ")";
1203   spaceBeforePlaceHolder(OS);
1204 }
1205 
1206 void TypePrinter::printExtIntAfter(const ExtIntType *T, raw_ostream &OS) {}
1207 
1208 void TypePrinter::printDependentExtIntBefore(const DependentExtIntType *T,
1209                                              raw_ostream &OS) {
1210   if (T->isUnsigned())
1211     OS << "unsigned ";
1212   OS << "_ExtInt(";
1213   T->getNumBitsExpr()->printPretty(OS, nullptr, Policy);
1214   OS << ")";
1215   spaceBeforePlaceHolder(OS);
1216 }
1217 
1218 void TypePrinter::printDependentExtIntAfter(const DependentExtIntType *T,
1219                                             raw_ostream &OS) {}
1220 
1221 /// Appends the given scope to the end of a string.
1222 void TypePrinter::AppendScope(DeclContext *DC, raw_ostream &OS,
1223                               DeclarationName NameInScope) {
1224   if (DC->isTranslationUnit())
1225     return;
1226 
1227   // FIXME: Consider replacing this with NamedDecl::printNestedNameSpecifier,
1228   // which can also print names for function and method scopes.
1229   if (DC->isFunctionOrMethod())
1230     return;
1231 
1232   if (Policy.Callbacks && Policy.Callbacks->isScopeVisible(DC))
1233     return;
1234 
1235   if (const auto *NS = dyn_cast<NamespaceDecl>(DC)) {
1236     if (Policy.SuppressUnwrittenScope && NS->isAnonymousNamespace())
1237       return AppendScope(DC->getParent(), OS, NameInScope);
1238 
1239     // Only suppress an inline namespace if the name has the same lookup
1240     // results in the enclosing namespace.
1241     if (Policy.SuppressInlineNamespace && NS->isInline() && NameInScope &&
1242         NS->isRedundantInlineQualifierFor(NameInScope))
1243       return AppendScope(DC->getParent(), OS, NameInScope);
1244 
1245     AppendScope(DC->getParent(), OS, NS->getDeclName());
1246     if (NS->getIdentifier())
1247       OS << NS->getName() << "::";
1248     else
1249       OS << "(anonymous namespace)::";
1250   } else if (const auto *Spec = dyn_cast<ClassTemplateSpecializationDecl>(DC)) {
1251     AppendScope(DC->getParent(), OS, Spec->getDeclName());
1252     IncludeStrongLifetimeRAII Strong(Policy);
1253     OS << Spec->getIdentifier()->getName();
1254     const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
1255     printTemplateArgumentList(
1256         OS, TemplateArgs.asArray(), Policy,
1257         Spec->getSpecializedTemplate()->getTemplateParameters());
1258     OS << "::";
1259   } else if (const auto *Tag = dyn_cast<TagDecl>(DC)) {
1260     AppendScope(DC->getParent(), OS, Tag->getDeclName());
1261     if (TypedefNameDecl *Typedef = Tag->getTypedefNameForAnonDecl())
1262       OS << Typedef->getIdentifier()->getName() << "::";
1263     else if (Tag->getIdentifier())
1264       OS << Tag->getIdentifier()->getName() << "::";
1265     else
1266       return;
1267   } else {
1268     AppendScope(DC->getParent(), OS, NameInScope);
1269   }
1270 }
1271 
1272 void TypePrinter::printTag(TagDecl *D, raw_ostream &OS) {
1273   if (Policy.IncludeTagDefinition) {
1274     PrintingPolicy SubPolicy = Policy;
1275     SubPolicy.IncludeTagDefinition = false;
1276     D->print(OS, SubPolicy, Indentation);
1277     spaceBeforePlaceHolder(OS);
1278     return;
1279   }
1280 
1281   bool HasKindDecoration = false;
1282 
1283   // We don't print tags unless this is an elaborated type.
1284   // In C, we just assume every RecordType is an elaborated type.
1285   if (!Policy.SuppressTagKeyword && !D->getTypedefNameForAnonDecl()) {
1286     HasKindDecoration = true;
1287     OS << D->getKindName();
1288     OS << ' ';
1289   }
1290 
1291   // Compute the full nested-name-specifier for this type.
1292   // In C, this will always be empty except when the type
1293   // being printed is anonymous within other Record.
1294   if (!Policy.SuppressScope)
1295     AppendScope(D->getDeclContext(), OS, D->getDeclName());
1296 
1297   if (const IdentifierInfo *II = D->getIdentifier())
1298     OS << II->getName();
1299   else if (TypedefNameDecl *Typedef = D->getTypedefNameForAnonDecl()) {
1300     assert(Typedef->getIdentifier() && "Typedef without identifier?");
1301     OS << Typedef->getIdentifier()->getName();
1302   } else {
1303     // Make an unambiguous representation for anonymous types, e.g.
1304     //   (anonymous enum at /usr/include/string.h:120:9)
1305     OS << (Policy.MSVCFormatting ? '`' : '(');
1306 
1307     if (isa<CXXRecordDecl>(D) && cast<CXXRecordDecl>(D)->isLambda()) {
1308       OS << "lambda";
1309       HasKindDecoration = true;
1310     } else if ((isa<RecordDecl>(D) && cast<RecordDecl>(D)->isAnonymousStructOrUnion())) {
1311       OS << "anonymous";
1312     } else {
1313       OS << "unnamed";
1314     }
1315 
1316     if (Policy.AnonymousTagLocations) {
1317       // Suppress the redundant tag keyword if we just printed one.
1318       // We don't have to worry about ElaboratedTypes here because you can't
1319       // refer to an anonymous type with one.
1320       if (!HasKindDecoration)
1321         OS << " " << D->getKindName();
1322 
1323       PresumedLoc PLoc = D->getASTContext().getSourceManager().getPresumedLoc(
1324           D->getLocation());
1325       if (PLoc.isValid()) {
1326         OS << " at ";
1327         StringRef File = PLoc.getFilename();
1328         if (auto *Callbacks = Policy.Callbacks)
1329           OS << Callbacks->remapPath(File);
1330         else
1331           OS << File;
1332         OS << ':' << PLoc.getLine() << ':' << PLoc.getColumn();
1333       }
1334     }
1335 
1336     OS << (Policy.MSVCFormatting ? '\'' : ')');
1337   }
1338 
1339   // If this is a class template specialization, print the template
1340   // arguments.
1341   if (const auto *Spec = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
1342     ArrayRef<TemplateArgument> Args;
1343     TypeSourceInfo *TAW = Spec->getTypeAsWritten();
1344     if (!Policy.PrintCanonicalTypes && TAW) {
1345       const TemplateSpecializationType *TST =
1346         cast<TemplateSpecializationType>(TAW->getType());
1347       Args = TST->template_arguments();
1348     } else {
1349       const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
1350       Args = TemplateArgs.asArray();
1351     }
1352     IncludeStrongLifetimeRAII Strong(Policy);
1353     printTemplateArgumentList(
1354         OS, Args, Policy,
1355         Spec->getSpecializedTemplate()->getTemplateParameters());
1356   }
1357 
1358   spaceBeforePlaceHolder(OS);
1359 }
1360 
1361 void TypePrinter::printRecordBefore(const RecordType *T, raw_ostream &OS) {
1362   // Print the preferred name if we have one for this type.
1363   for (const auto *PNA : T->getDecl()->specific_attrs<PreferredNameAttr>()) {
1364     if (declaresSameEntity(PNA->getTypedefType()->getAsCXXRecordDecl(),
1365                            T->getDecl())) {
1366       // Find the outermost typedef or alias template.
1367       QualType T = PNA->getTypedefType();
1368       while (true) {
1369         if (auto *TT = dyn_cast<TypedefType>(T))
1370           return printTypeSpec(TT->getDecl(), OS);
1371         if (auto *TST = dyn_cast<TemplateSpecializationType>(T))
1372           return printTemplateId(TST, OS, /*FullyQualify=*/true);
1373         T = T->getLocallyUnqualifiedSingleStepDesugaredType();
1374       }
1375     }
1376   }
1377 
1378   printTag(T->getDecl(), OS);
1379 }
1380 
1381 void TypePrinter::printRecordAfter(const RecordType *T, raw_ostream &OS) {}
1382 
1383 void TypePrinter::printEnumBefore(const EnumType *T, raw_ostream &OS) {
1384   printTag(T->getDecl(), OS);
1385 }
1386 
1387 void TypePrinter::printEnumAfter(const EnumType *T, raw_ostream &OS) {}
1388 
1389 void TypePrinter::printTemplateTypeParmBefore(const TemplateTypeParmType *T,
1390                                               raw_ostream &OS) {
1391   TemplateTypeParmDecl *D = T->getDecl();
1392   if (D && D->isImplicit()) {
1393     if (auto *TC = D->getTypeConstraint()) {
1394       TC->print(OS, Policy);
1395       OS << ' ';
1396     }
1397     OS << "auto";
1398   } else if (IdentifierInfo *Id = T->getIdentifier())
1399     OS << Id->getName();
1400   else
1401     OS << "type-parameter-" << T->getDepth() << '-' << T->getIndex();
1402 
1403   spaceBeforePlaceHolder(OS);
1404 }
1405 
1406 void TypePrinter::printTemplateTypeParmAfter(const TemplateTypeParmType *T,
1407                                              raw_ostream &OS) {}
1408 
1409 void TypePrinter::printSubstTemplateTypeParmBefore(
1410                                              const SubstTemplateTypeParmType *T,
1411                                              raw_ostream &OS) {
1412   IncludeStrongLifetimeRAII Strong(Policy);
1413   printBefore(T->getReplacementType(), OS);
1414 }
1415 
1416 void TypePrinter::printSubstTemplateTypeParmAfter(
1417                                              const SubstTemplateTypeParmType *T,
1418                                              raw_ostream &OS) {
1419   IncludeStrongLifetimeRAII Strong(Policy);
1420   printAfter(T->getReplacementType(), OS);
1421 }
1422 
1423 void TypePrinter::printSubstTemplateTypeParmPackBefore(
1424                                         const SubstTemplateTypeParmPackType *T,
1425                                         raw_ostream &OS) {
1426   IncludeStrongLifetimeRAII Strong(Policy);
1427   printTemplateTypeParmBefore(T->getReplacedParameter(), OS);
1428 }
1429 
1430 void TypePrinter::printSubstTemplateTypeParmPackAfter(
1431                                         const SubstTemplateTypeParmPackType *T,
1432                                         raw_ostream &OS) {
1433   IncludeStrongLifetimeRAII Strong(Policy);
1434   printTemplateTypeParmAfter(T->getReplacedParameter(), OS);
1435 }
1436 
1437 void TypePrinter::printTemplateId(const TemplateSpecializationType *T,
1438                                   raw_ostream &OS, bool FullyQualify) {
1439   IncludeStrongLifetimeRAII Strong(Policy);
1440 
1441   TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl();
1442   if (FullyQualify && TD) {
1443     if (!Policy.SuppressScope)
1444       AppendScope(TD->getDeclContext(), OS, TD->getDeclName());
1445 
1446     IdentifierInfo *II = TD->getIdentifier();
1447     OS << II->getName();
1448   } else {
1449     T->getTemplateName().print(OS, Policy);
1450   }
1451 
1452   const TemplateParameterList *TPL = TD ? TD->getTemplateParameters() : nullptr;
1453   printTemplateArgumentList(OS, T->template_arguments(), Policy, TPL);
1454   spaceBeforePlaceHolder(OS);
1455 }
1456 
1457 void TypePrinter::printTemplateSpecializationBefore(
1458                                             const TemplateSpecializationType *T,
1459                                             raw_ostream &OS) {
1460   printTemplateId(T, OS, false);
1461 }
1462 
1463 void TypePrinter::printTemplateSpecializationAfter(
1464                                             const TemplateSpecializationType *T,
1465                                             raw_ostream &OS) {}
1466 
1467 void TypePrinter::printInjectedClassNameBefore(const InjectedClassNameType *T,
1468                                                raw_ostream &OS) {
1469   if (Policy.PrintInjectedClassNameWithArguments)
1470     return printTemplateSpecializationBefore(T->getInjectedTST(), OS);
1471 
1472   IncludeStrongLifetimeRAII Strong(Policy);
1473   T->getTemplateName().print(OS, Policy);
1474   spaceBeforePlaceHolder(OS);
1475 }
1476 
1477 void TypePrinter::printInjectedClassNameAfter(const InjectedClassNameType *T,
1478                                                raw_ostream &OS) {}
1479 
1480 void TypePrinter::printElaboratedBefore(const ElaboratedType *T,
1481                                         raw_ostream &OS) {
1482   if (Policy.IncludeTagDefinition && T->getOwnedTagDecl()) {
1483     TagDecl *OwnedTagDecl = T->getOwnedTagDecl();
1484     assert(OwnedTagDecl->getTypeForDecl() == T->getNamedType().getTypePtr() &&
1485            "OwnedTagDecl expected to be a declaration for the type");
1486     PrintingPolicy SubPolicy = Policy;
1487     SubPolicy.IncludeTagDefinition = false;
1488     OwnedTagDecl->print(OS, SubPolicy, Indentation);
1489     spaceBeforePlaceHolder(OS);
1490     return;
1491   }
1492 
1493   // The tag definition will take care of these.
1494   if (!Policy.IncludeTagDefinition)
1495   {
1496     OS << TypeWithKeyword::getKeywordName(T->getKeyword());
1497     if (T->getKeyword() != ETK_None)
1498       OS << " ";
1499     NestedNameSpecifier *Qualifier = T->getQualifier();
1500     if (Qualifier)
1501       Qualifier->print(OS, Policy);
1502   }
1503 
1504   ElaboratedTypePolicyRAII PolicyRAII(Policy);
1505   printBefore(T->getNamedType(), OS);
1506 }
1507 
1508 void TypePrinter::printElaboratedAfter(const ElaboratedType *T,
1509                                         raw_ostream &OS) {
1510   if (Policy.IncludeTagDefinition && T->getOwnedTagDecl())
1511     return;
1512   ElaboratedTypePolicyRAII PolicyRAII(Policy);
1513   printAfter(T->getNamedType(), OS);
1514 }
1515 
1516 void TypePrinter::printParenBefore(const ParenType *T, raw_ostream &OS) {
1517   if (!HasEmptyPlaceHolder && !isa<FunctionType>(T->getInnerType())) {
1518     printBefore(T->getInnerType(), OS);
1519     OS << '(';
1520   } else
1521     printBefore(T->getInnerType(), OS);
1522 }
1523 
1524 void TypePrinter::printParenAfter(const ParenType *T, raw_ostream &OS) {
1525   if (!HasEmptyPlaceHolder && !isa<FunctionType>(T->getInnerType())) {
1526     OS << ')';
1527     printAfter(T->getInnerType(), OS);
1528   } else
1529     printAfter(T->getInnerType(), OS);
1530 }
1531 
1532 void TypePrinter::printDependentNameBefore(const DependentNameType *T,
1533                                            raw_ostream &OS) {
1534   OS << TypeWithKeyword::getKeywordName(T->getKeyword());
1535   if (T->getKeyword() != ETK_None)
1536     OS << " ";
1537 
1538   T->getQualifier()->print(OS, Policy);
1539 
1540   OS << T->getIdentifier()->getName();
1541   spaceBeforePlaceHolder(OS);
1542 }
1543 
1544 void TypePrinter::printDependentNameAfter(const DependentNameType *T,
1545                                           raw_ostream &OS) {}
1546 
1547 void TypePrinter::printDependentTemplateSpecializationBefore(
1548         const DependentTemplateSpecializationType *T, raw_ostream &OS) {
1549   IncludeStrongLifetimeRAII Strong(Policy);
1550 
1551   OS << TypeWithKeyword::getKeywordName(T->getKeyword());
1552   if (T->getKeyword() != ETK_None)
1553     OS << " ";
1554 
1555   if (T->getQualifier())
1556     T->getQualifier()->print(OS, Policy);
1557   OS << "template " << T->getIdentifier()->getName();
1558   printTemplateArgumentList(OS, T->template_arguments(), Policy);
1559   spaceBeforePlaceHolder(OS);
1560 }
1561 
1562 void TypePrinter::printDependentTemplateSpecializationAfter(
1563         const DependentTemplateSpecializationType *T, raw_ostream &OS) {}
1564 
1565 void TypePrinter::printPackExpansionBefore(const PackExpansionType *T,
1566                                            raw_ostream &OS) {
1567   printBefore(T->getPattern(), OS);
1568 }
1569 
1570 void TypePrinter::printPackExpansionAfter(const PackExpansionType *T,
1571                                           raw_ostream &OS) {
1572   printAfter(T->getPattern(), OS);
1573   OS << "...";
1574 }
1575 
1576 void TypePrinter::printAttributedBefore(const AttributedType *T,
1577                                         raw_ostream &OS) {
1578   // FIXME: Generate this with TableGen.
1579 
1580   // Prefer the macro forms of the GC and ownership qualifiers.
1581   if (T->getAttrKind() == attr::ObjCGC ||
1582       T->getAttrKind() == attr::ObjCOwnership)
1583     return printBefore(T->getEquivalentType(), OS);
1584 
1585   if (T->getAttrKind() == attr::ObjCKindOf)
1586     OS << "__kindof ";
1587 
1588   if (T->getAttrKind() == attr::AddressSpace)
1589     printBefore(T->getEquivalentType(), OS);
1590   else
1591     printBefore(T->getModifiedType(), OS);
1592 
1593   if (T->isMSTypeSpec()) {
1594     switch (T->getAttrKind()) {
1595     default: return;
1596     case attr::Ptr32: OS << " __ptr32"; break;
1597     case attr::Ptr64: OS << " __ptr64"; break;
1598     case attr::SPtr: OS << " __sptr"; break;
1599     case attr::UPtr: OS << " __uptr"; break;
1600     }
1601     spaceBeforePlaceHolder(OS);
1602   }
1603 
1604   // Print nullability type specifiers.
1605   if (T->getImmediateNullability()) {
1606     if (T->getAttrKind() == attr::TypeNonNull)
1607       OS << " _Nonnull";
1608     else if (T->getAttrKind() == attr::TypeNullable)
1609       OS << " _Nullable";
1610     else if (T->getAttrKind() == attr::TypeNullUnspecified)
1611       OS << " _Null_unspecified";
1612     else if (T->getAttrKind() == attr::TypeNullableResult)
1613       OS << " _Nullable_result";
1614     else
1615       llvm_unreachable("unhandled nullability");
1616     spaceBeforePlaceHolder(OS);
1617   }
1618 }
1619 
1620 void TypePrinter::printAttributedAfter(const AttributedType *T,
1621                                        raw_ostream &OS) {
1622   // FIXME: Generate this with TableGen.
1623 
1624   // Prefer the macro forms of the GC and ownership qualifiers.
1625   if (T->getAttrKind() == attr::ObjCGC ||
1626       T->getAttrKind() == attr::ObjCOwnership)
1627     return printAfter(T->getEquivalentType(), OS);
1628 
1629   // If this is a calling convention attribute, don't print the implicit CC from
1630   // the modified type.
1631   SaveAndRestore<bool> MaybeSuppressCC(InsideCCAttribute, T->isCallingConv());
1632 
1633   printAfter(T->getModifiedType(), OS);
1634 
1635   // Some attributes are printed as qualifiers before the type, so we have
1636   // nothing left to do.
1637   if (T->getAttrKind() == attr::ObjCKindOf ||
1638       T->isMSTypeSpec() || T->getImmediateNullability())
1639     return;
1640 
1641   // Don't print the inert __unsafe_unretained attribute at all.
1642   if (T->getAttrKind() == attr::ObjCInertUnsafeUnretained)
1643     return;
1644 
1645   // Don't print ns_returns_retained unless it had an effect.
1646   if (T->getAttrKind() == attr::NSReturnsRetained &&
1647       !T->getEquivalentType()->castAs<FunctionType>()
1648                              ->getExtInfo().getProducesResult())
1649     return;
1650 
1651   if (T->getAttrKind() == attr::LifetimeBound) {
1652     OS << " [[clang::lifetimebound]]";
1653     return;
1654   }
1655 
1656   // The printing of the address_space attribute is handled by the qualifier
1657   // since it is still stored in the qualifier. Return early to prevent printing
1658   // this twice.
1659   if (T->getAttrKind() == attr::AddressSpace)
1660     return;
1661 
1662   OS << " __attribute__((";
1663   switch (T->getAttrKind()) {
1664 #define TYPE_ATTR(NAME)
1665 #define DECL_OR_TYPE_ATTR(NAME)
1666 #define ATTR(NAME) case attr::NAME:
1667 #include "clang/Basic/AttrList.inc"
1668     llvm_unreachable("non-type attribute attached to type");
1669 
1670   case attr::OpenCLPrivateAddressSpace:
1671   case attr::OpenCLGlobalAddressSpace:
1672   case attr::OpenCLGlobalDeviceAddressSpace:
1673   case attr::OpenCLGlobalHostAddressSpace:
1674   case attr::OpenCLLocalAddressSpace:
1675   case attr::OpenCLConstantAddressSpace:
1676   case attr::OpenCLGenericAddressSpace:
1677     // FIXME: Update printAttributedBefore to print these once we generate
1678     // AttributedType nodes for them.
1679     break;
1680 
1681   case attr::LifetimeBound:
1682   case attr::TypeNonNull:
1683   case attr::TypeNullable:
1684   case attr::TypeNullableResult:
1685   case attr::TypeNullUnspecified:
1686   case attr::ObjCGC:
1687   case attr::ObjCInertUnsafeUnretained:
1688   case attr::ObjCKindOf:
1689   case attr::ObjCOwnership:
1690   case attr::Ptr32:
1691   case attr::Ptr64:
1692   case attr::SPtr:
1693   case attr::UPtr:
1694   case attr::AddressSpace:
1695   case attr::CmseNSCall:
1696     llvm_unreachable("This attribute should have been handled already");
1697 
1698   case attr::NSReturnsRetained:
1699     OS << "ns_returns_retained";
1700     break;
1701 
1702   // FIXME: When Sema learns to form this AttributedType, avoid printing the
1703   // attribute again in printFunctionProtoAfter.
1704   case attr::AnyX86NoCfCheck: OS << "nocf_check"; break;
1705   case attr::CDecl: OS << "cdecl"; break;
1706   case attr::FastCall: OS << "fastcall"; break;
1707   case attr::StdCall: OS << "stdcall"; break;
1708   case attr::ThisCall: OS << "thiscall"; break;
1709   case attr::SwiftCall: OS << "swiftcall"; break;
1710   case attr::VectorCall: OS << "vectorcall"; break;
1711   case attr::Pascal: OS << "pascal"; break;
1712   case attr::MSABI: OS << "ms_abi"; break;
1713   case attr::SysVABI: OS << "sysv_abi"; break;
1714   case attr::RegCall: OS << "regcall"; break;
1715   case attr::Pcs: {
1716     OS << "pcs(";
1717    QualType t = T->getEquivalentType();
1718    while (!t->isFunctionType())
1719      t = t->getPointeeType();
1720    OS << (t->castAs<FunctionType>()->getCallConv() == CC_AAPCS ?
1721          "\"aapcs\"" : "\"aapcs-vfp\"");
1722    OS << ')';
1723    break;
1724   }
1725   case attr::AArch64VectorPcs: OS << "aarch64_vector_pcs"; break;
1726   case attr::IntelOclBicc: OS << "inteloclbicc"; break;
1727   case attr::PreserveMost:
1728     OS << "preserve_most";
1729     break;
1730 
1731   case attr::PreserveAll:
1732     OS << "preserve_all";
1733     break;
1734   case attr::NoDeref:
1735     OS << "noderef";
1736     break;
1737   case attr::AcquireHandle:
1738     OS << "acquire_handle";
1739     break;
1740   case attr::ArmMveStrictPolymorphism:
1741     OS << "__clang_arm_mve_strict_polymorphism";
1742     break;
1743   }
1744   OS << "))";
1745 }
1746 
1747 void TypePrinter::printObjCInterfaceBefore(const ObjCInterfaceType *T,
1748                                            raw_ostream &OS) {
1749   OS << T->getDecl()->getName();
1750   spaceBeforePlaceHolder(OS);
1751 }
1752 
1753 void TypePrinter::printObjCInterfaceAfter(const ObjCInterfaceType *T,
1754                                           raw_ostream &OS) {}
1755 
1756 void TypePrinter::printObjCTypeParamBefore(const ObjCTypeParamType *T,
1757                                           raw_ostream &OS) {
1758   OS << T->getDecl()->getName();
1759   if (!T->qual_empty()) {
1760     bool isFirst = true;
1761     OS << '<';
1762     for (const auto *I : T->quals()) {
1763       if (isFirst)
1764         isFirst = false;
1765       else
1766         OS << ',';
1767       OS << I->getName();
1768     }
1769     OS << '>';
1770   }
1771 
1772   spaceBeforePlaceHolder(OS);
1773 }
1774 
1775 void TypePrinter::printObjCTypeParamAfter(const ObjCTypeParamType *T,
1776                                           raw_ostream &OS) {}
1777 
1778 void TypePrinter::printObjCObjectBefore(const ObjCObjectType *T,
1779                                         raw_ostream &OS) {
1780   if (T->qual_empty() && T->isUnspecializedAsWritten() &&
1781       !T->isKindOfTypeAsWritten())
1782     return printBefore(T->getBaseType(), OS);
1783 
1784   if (T->isKindOfTypeAsWritten())
1785     OS << "__kindof ";
1786 
1787   print(T->getBaseType(), OS, StringRef());
1788 
1789   if (T->isSpecializedAsWritten()) {
1790     bool isFirst = true;
1791     OS << '<';
1792     for (auto typeArg : T->getTypeArgsAsWritten()) {
1793       if (isFirst)
1794         isFirst = false;
1795       else
1796         OS << ",";
1797 
1798       print(typeArg, OS, StringRef());
1799     }
1800     OS << '>';
1801   }
1802 
1803   if (!T->qual_empty()) {
1804     bool isFirst = true;
1805     OS << '<';
1806     for (const auto *I : T->quals()) {
1807       if (isFirst)
1808         isFirst = false;
1809       else
1810         OS << ',';
1811       OS << I->getName();
1812     }
1813     OS << '>';
1814   }
1815 
1816   spaceBeforePlaceHolder(OS);
1817 }
1818 
1819 void TypePrinter::printObjCObjectAfter(const ObjCObjectType *T,
1820                                         raw_ostream &OS) {
1821   if (T->qual_empty() && T->isUnspecializedAsWritten() &&
1822       !T->isKindOfTypeAsWritten())
1823     return printAfter(T->getBaseType(), OS);
1824 }
1825 
1826 void TypePrinter::printObjCObjectPointerBefore(const ObjCObjectPointerType *T,
1827                                                raw_ostream &OS) {
1828   printBefore(T->getPointeeType(), OS);
1829 
1830   // If we need to print the pointer, print it now.
1831   if (!T->isObjCIdType() && !T->isObjCQualifiedIdType() &&
1832       !T->isObjCClassType() && !T->isObjCQualifiedClassType()) {
1833     if (HasEmptyPlaceHolder)
1834       OS << ' ';
1835     OS << '*';
1836   }
1837 }
1838 
1839 void TypePrinter::printObjCObjectPointerAfter(const ObjCObjectPointerType *T,
1840                                               raw_ostream &OS) {}
1841 
1842 static
1843 const TemplateArgument &getArgument(const TemplateArgument &A) { return A; }
1844 
1845 static const TemplateArgument &getArgument(const TemplateArgumentLoc &A) {
1846   return A.getArgument();
1847 }
1848 
1849 static void printArgument(const TemplateArgument &A, const PrintingPolicy &PP,
1850                           llvm::raw_ostream &OS, bool IncludeType) {
1851   A.print(PP, OS, IncludeType);
1852 }
1853 
1854 static void printArgument(const TemplateArgumentLoc &A,
1855                           const PrintingPolicy &PP, llvm::raw_ostream &OS,
1856                           bool IncludeType) {
1857   const TemplateArgument::ArgKind &Kind = A.getArgument().getKind();
1858   if (Kind == TemplateArgument::ArgKind::Type)
1859     return A.getTypeSourceInfo()->getType().print(OS, PP);
1860   return A.getArgument().print(PP, OS, IncludeType);
1861 }
1862 
1863 static bool isSubstitutedTemplateArgument(ASTContext &Ctx, TemplateArgument Arg,
1864                                           TemplateArgument Pattern,
1865                                           ArrayRef<TemplateArgument> Args,
1866                                           unsigned Depth);
1867 
1868 static bool isSubstitutedType(ASTContext &Ctx, QualType T, QualType Pattern,
1869                               ArrayRef<TemplateArgument> Args, unsigned Depth) {
1870   if (Ctx.hasSameType(T, Pattern))
1871     return true;
1872 
1873   // A type parameter matches its argument.
1874   if (auto *TTPT = Pattern->getAs<TemplateTypeParmType>()) {
1875     if (TTPT->getDepth() == Depth && TTPT->getIndex() < Args.size() &&
1876         Args[TTPT->getIndex()].getKind() == TemplateArgument::Type) {
1877       QualType SubstArg = Ctx.getQualifiedType(
1878           Args[TTPT->getIndex()].getAsType(), Pattern.getQualifiers());
1879       return Ctx.hasSameType(SubstArg, T);
1880     }
1881     return false;
1882   }
1883 
1884   // FIXME: Recurse into array types.
1885 
1886   // All other cases will need the types to be identically qualified.
1887   Qualifiers TQual, PatQual;
1888   T = Ctx.getUnqualifiedArrayType(T, TQual);
1889   Pattern = Ctx.getUnqualifiedArrayType(Pattern, PatQual);
1890   if (TQual != PatQual)
1891     return false;
1892 
1893   // Recurse into pointer-like types.
1894   {
1895     QualType TPointee = T->getPointeeType();
1896     QualType PPointee = Pattern->getPointeeType();
1897     if (!TPointee.isNull() && !PPointee.isNull())
1898       return T->getTypeClass() == Pattern->getTypeClass() &&
1899              isSubstitutedType(Ctx, TPointee, PPointee, Args, Depth);
1900   }
1901 
1902   // Recurse into template specialization types.
1903   if (auto *PTST =
1904           Pattern.getCanonicalType()->getAs<TemplateSpecializationType>()) {
1905     TemplateName Template;
1906     ArrayRef<TemplateArgument> TemplateArgs;
1907     if (auto *TTST = T->getAs<TemplateSpecializationType>()) {
1908       Template = TTST->getTemplateName();
1909       TemplateArgs = TTST->template_arguments();
1910     } else if (auto *CTSD = dyn_cast_or_null<ClassTemplateSpecializationDecl>(
1911                    T->getAsCXXRecordDecl())) {
1912       Template = TemplateName(CTSD->getSpecializedTemplate());
1913       TemplateArgs = CTSD->getTemplateArgs().asArray();
1914     } else {
1915       return false;
1916     }
1917 
1918     if (!isSubstitutedTemplateArgument(Ctx, Template, PTST->getTemplateName(),
1919                                        Args, Depth))
1920       return false;
1921     if (TemplateArgs.size() != PTST->getNumArgs())
1922       return false;
1923     for (unsigned I = 0, N = TemplateArgs.size(); I != N; ++I)
1924       if (!isSubstitutedTemplateArgument(Ctx, TemplateArgs[I], PTST->getArg(I),
1925                                          Args, Depth))
1926         return false;
1927     return true;
1928   }
1929 
1930   // FIXME: Handle more cases.
1931   return false;
1932 }
1933 
1934 static bool isSubstitutedTemplateArgument(ASTContext &Ctx, TemplateArgument Arg,
1935                                           TemplateArgument Pattern,
1936                                           ArrayRef<TemplateArgument> Args,
1937                                           unsigned Depth) {
1938   Arg = Ctx.getCanonicalTemplateArgument(Arg);
1939   Pattern = Ctx.getCanonicalTemplateArgument(Pattern);
1940   if (Arg.structurallyEquals(Pattern))
1941     return true;
1942 
1943   if (Pattern.getKind() == TemplateArgument::Expression) {
1944     if (auto *DRE =
1945             dyn_cast<DeclRefExpr>(Pattern.getAsExpr()->IgnoreParenImpCasts())) {
1946       if (auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(DRE->getDecl()))
1947         return NTTP->getDepth() == Depth && Args.size() > NTTP->getIndex() &&
1948                Args[NTTP->getIndex()].structurallyEquals(Arg);
1949     }
1950   }
1951 
1952   if (Arg.getKind() != Pattern.getKind())
1953     return false;
1954 
1955   if (Arg.getKind() == TemplateArgument::Type)
1956     return isSubstitutedType(Ctx, Arg.getAsType(), Pattern.getAsType(), Args,
1957                              Depth);
1958 
1959   if (Arg.getKind() == TemplateArgument::Template) {
1960     TemplateDecl *PatTD = Pattern.getAsTemplate().getAsTemplateDecl();
1961     if (auto *TTPD = dyn_cast_or_null<TemplateTemplateParmDecl>(PatTD))
1962       return TTPD->getDepth() == Depth && Args.size() > TTPD->getIndex() &&
1963              Ctx.getCanonicalTemplateArgument(Args[TTPD->getIndex()])
1964                  .structurallyEquals(Arg);
1965   }
1966 
1967   // FIXME: Handle more cases.
1968   return false;
1969 }
1970 
1971 /// Make a best-effort determination of whether the type T can be produced by
1972 /// substituting Args into the default argument of Param.
1973 static bool isSubstitutedDefaultArgument(ASTContext &Ctx, TemplateArgument Arg,
1974                                          const NamedDecl *Param,
1975                                          ArrayRef<TemplateArgument> Args,
1976                                          unsigned Depth) {
1977   // An empty pack is equivalent to not providing a pack argument.
1978   if (Arg.getKind() == TemplateArgument::Pack && Arg.pack_size() == 0)
1979     return true;
1980 
1981   if (auto *TTPD = dyn_cast<TemplateTypeParmDecl>(Param)) {
1982     return TTPD->hasDefaultArgument() &&
1983            isSubstitutedTemplateArgument(Ctx, Arg, TTPD->getDefaultArgument(),
1984                                          Args, Depth);
1985   } else if (auto *TTPD = dyn_cast<TemplateTemplateParmDecl>(Param)) {
1986     return TTPD->hasDefaultArgument() &&
1987            isSubstitutedTemplateArgument(
1988                Ctx, Arg, TTPD->getDefaultArgument().getArgument(), Args, Depth);
1989   } else if (auto *NTTPD = dyn_cast<NonTypeTemplateParmDecl>(Param)) {
1990     return NTTPD->hasDefaultArgument() &&
1991            isSubstitutedTemplateArgument(Ctx, Arg, NTTPD->getDefaultArgument(),
1992                                          Args, Depth);
1993   }
1994   return false;
1995 }
1996 
1997 template <typename TA>
1998 static void printTo(raw_ostream &OS, ArrayRef<TA> Args,
1999                     const PrintingPolicy &Policy, bool SkipBrackets,
2000                     const TemplateParameterList *TPL, bool IsPack,
2001                     unsigned ParmIndex) {
2002   // Drop trailing template arguments that match default arguments.
2003   if (TPL && Policy.SuppressDefaultTemplateArgs &&
2004       !Policy.PrintCanonicalTypes && !Args.empty() && !IsPack &&
2005       Args.size() <= TPL->size()) {
2006     ASTContext &Ctx = TPL->getParam(0)->getASTContext();
2007     llvm::SmallVector<TemplateArgument, 8> OrigArgs;
2008     for (const TA &A : Args)
2009       OrigArgs.push_back(getArgument(A));
2010     while (!Args.empty() &&
2011            isSubstitutedDefaultArgument(Ctx, getArgument(Args.back()),
2012                                         TPL->getParam(Args.size() - 1),
2013                                         OrigArgs, TPL->getDepth()))
2014       Args = Args.drop_back();
2015   }
2016 
2017   const char *Comma = Policy.MSVCFormatting ? "," : ", ";
2018   if (!SkipBrackets)
2019     OS << '<';
2020 
2021   bool NeedSpace = false;
2022   bool FirstArg = true;
2023   for (const auto &Arg : Args) {
2024     // Print the argument into a string.
2025     SmallString<128> Buf;
2026     llvm::raw_svector_ostream ArgOS(Buf);
2027     const TemplateArgument &Argument = getArgument(Arg);
2028     if (Argument.getKind() == TemplateArgument::Pack) {
2029       if (Argument.pack_size() && !FirstArg)
2030         OS << Comma;
2031       printTo(ArgOS, Argument.getPackAsArray(), Policy, true, TPL,
2032               /*IsPack*/ true, ParmIndex);
2033     } else {
2034       if (!FirstArg)
2035         OS << Comma;
2036       // Tries to print the argument with location info if exists.
2037       printArgument(
2038           Arg, Policy, ArgOS,
2039           TemplateParameterList::shouldIncludeTypeForArgument(TPL, ParmIndex));
2040     }
2041     StringRef ArgString = ArgOS.str();
2042 
2043     // If this is the first argument and its string representation
2044     // begins with the global scope specifier ('::foo'), add a space
2045     // to avoid printing the diagraph '<:'.
2046     if (FirstArg && !ArgString.empty() && ArgString[0] == ':')
2047       OS << ' ';
2048 
2049     OS << ArgString;
2050 
2051     // If the last character of our string is '>', add another space to
2052     // keep the two '>''s separate tokens.
2053     NeedSpace = Policy.SplitTemplateClosers && !ArgString.empty() &&
2054                 ArgString.back() == '>';
2055     FirstArg = false;
2056 
2057     // Use same template parameter for all elements of Pack
2058     if (!IsPack)
2059       ParmIndex++;
2060   }
2061 
2062   if (NeedSpace)
2063     OS << ' ';
2064 
2065   if (!SkipBrackets)
2066     OS << '>';
2067 }
2068 
2069 void clang::printTemplateArgumentList(raw_ostream &OS,
2070                                       const TemplateArgumentListInfo &Args,
2071                                       const PrintingPolicy &Policy,
2072                                       const TemplateParameterList *TPL) {
2073   printTemplateArgumentList(OS, Args.arguments(), Policy, TPL);
2074 }
2075 
2076 void clang::printTemplateArgumentList(raw_ostream &OS,
2077                                       ArrayRef<TemplateArgument> Args,
2078                                       const PrintingPolicy &Policy,
2079                                       const TemplateParameterList *TPL) {
2080   printTo(OS, Args, Policy, false, TPL, /*isPack*/ false, /*parmIndex*/ 0);
2081 }
2082 
2083 void clang::printTemplateArgumentList(raw_ostream &OS,
2084                                       ArrayRef<TemplateArgumentLoc> Args,
2085                                       const PrintingPolicy &Policy,
2086                                       const TemplateParameterList *TPL) {
2087   printTo(OS, Args, Policy, false, TPL, /*isPack*/ false, /*parmIndex*/ 0);
2088 }
2089 
2090 std::string Qualifiers::getAsString() const {
2091   LangOptions LO;
2092   return getAsString(PrintingPolicy(LO));
2093 }
2094 
2095 // Appends qualifiers to the given string, separated by spaces.  Will
2096 // prefix a space if the string is non-empty.  Will not append a final
2097 // space.
2098 std::string Qualifiers::getAsString(const PrintingPolicy &Policy) const {
2099   SmallString<64> Buf;
2100   llvm::raw_svector_ostream StrOS(Buf);
2101   print(StrOS, Policy);
2102   return std::string(StrOS.str());
2103 }
2104 
2105 bool Qualifiers::isEmptyWhenPrinted(const PrintingPolicy &Policy) const {
2106   if (getCVRQualifiers())
2107     return false;
2108 
2109   if (getAddressSpace() != LangAS::Default)
2110     return false;
2111 
2112   if (getObjCGCAttr())
2113     return false;
2114 
2115   if (Qualifiers::ObjCLifetime lifetime = getObjCLifetime())
2116     if (!(lifetime == Qualifiers::OCL_Strong && Policy.SuppressStrongLifetime))
2117       return false;
2118 
2119   return true;
2120 }
2121 
2122 std::string Qualifiers::getAddrSpaceAsString(LangAS AS) {
2123   switch (AS) {
2124   case LangAS::Default:
2125     return "";
2126   case LangAS::opencl_global:
2127   case LangAS::sycl_global:
2128     return "__global";
2129   case LangAS::opencl_local:
2130   case LangAS::sycl_local:
2131     return "__local";
2132   case LangAS::opencl_private:
2133   case LangAS::sycl_private:
2134     return "__private";
2135   case LangAS::opencl_constant:
2136     return "__constant";
2137   case LangAS::opencl_generic:
2138     return "__generic";
2139   case LangAS::opencl_global_device:
2140   case LangAS::sycl_global_device:
2141     return "__global_device";
2142   case LangAS::opencl_global_host:
2143   case LangAS::sycl_global_host:
2144     return "__global_host";
2145   case LangAS::cuda_device:
2146     return "__device__";
2147   case LangAS::cuda_constant:
2148     return "__constant__";
2149   case LangAS::cuda_shared:
2150     return "__shared__";
2151   case LangAS::ptr32_sptr:
2152     return "__sptr __ptr32";
2153   case LangAS::ptr32_uptr:
2154     return "__uptr __ptr32";
2155   case LangAS::ptr64:
2156     return "__ptr64";
2157   default:
2158     return std::to_string(toTargetAddressSpace(AS));
2159   }
2160 }
2161 
2162 // Appends qualifiers to the given string, separated by spaces.  Will
2163 // prefix a space if the string is non-empty.  Will not append a final
2164 // space.
2165 void Qualifiers::print(raw_ostream &OS, const PrintingPolicy& Policy,
2166                        bool appendSpaceIfNonEmpty) const {
2167   bool addSpace = false;
2168 
2169   unsigned quals = getCVRQualifiers();
2170   if (quals) {
2171     AppendTypeQualList(OS, quals, Policy.Restrict);
2172     addSpace = true;
2173   }
2174   if (hasUnaligned()) {
2175     if (addSpace)
2176       OS << ' ';
2177     OS << "__unaligned";
2178     addSpace = true;
2179   }
2180   auto ASStr = getAddrSpaceAsString(getAddressSpace());
2181   if (!ASStr.empty()) {
2182     if (addSpace)
2183       OS << ' ';
2184     addSpace = true;
2185     // Wrap target address space into an attribute syntax
2186     if (isTargetAddressSpace(getAddressSpace()))
2187       OS << "__attribute__((address_space(" << ASStr << ")))";
2188     else
2189       OS << ASStr;
2190   }
2191 
2192   if (Qualifiers::GC gc = getObjCGCAttr()) {
2193     if (addSpace)
2194       OS << ' ';
2195     addSpace = true;
2196     if (gc == Qualifiers::Weak)
2197       OS << "__weak";
2198     else
2199       OS << "__strong";
2200   }
2201   if (Qualifiers::ObjCLifetime lifetime = getObjCLifetime()) {
2202     if (!(lifetime == Qualifiers::OCL_Strong && Policy.SuppressStrongLifetime)){
2203       if (addSpace)
2204         OS << ' ';
2205       addSpace = true;
2206     }
2207 
2208     switch (lifetime) {
2209     case Qualifiers::OCL_None: llvm_unreachable("none but true");
2210     case Qualifiers::OCL_ExplicitNone: OS << "__unsafe_unretained"; break;
2211     case Qualifiers::OCL_Strong:
2212       if (!Policy.SuppressStrongLifetime)
2213         OS << "__strong";
2214       break;
2215 
2216     case Qualifiers::OCL_Weak: OS << "__weak"; break;
2217     case Qualifiers::OCL_Autoreleasing: OS << "__autoreleasing"; break;
2218     }
2219   }
2220 
2221   if (appendSpaceIfNonEmpty && addSpace)
2222     OS << ' ';
2223 }
2224 
2225 std::string QualType::getAsString() const {
2226   return getAsString(split(), LangOptions());
2227 }
2228 
2229 std::string QualType::getAsString(const PrintingPolicy &Policy) const {
2230   std::string S;
2231   getAsStringInternal(S, Policy);
2232   return S;
2233 }
2234 
2235 std::string QualType::getAsString(const Type *ty, Qualifiers qs,
2236                                   const PrintingPolicy &Policy) {
2237   std::string buffer;
2238   getAsStringInternal(ty, qs, buffer, Policy);
2239   return buffer;
2240 }
2241 
2242 void QualType::print(raw_ostream &OS, const PrintingPolicy &Policy,
2243                      const Twine &PlaceHolder, unsigned Indentation) const {
2244   print(splitAccordingToPolicy(*this, Policy), OS, Policy, PlaceHolder,
2245         Indentation);
2246 }
2247 
2248 void QualType::print(const Type *ty, Qualifiers qs,
2249                      raw_ostream &OS, const PrintingPolicy &policy,
2250                      const Twine &PlaceHolder, unsigned Indentation) {
2251   SmallString<128> PHBuf;
2252   StringRef PH = PlaceHolder.toStringRef(PHBuf);
2253 
2254   TypePrinter(policy, Indentation).print(ty, qs, OS, PH);
2255 }
2256 
2257 void QualType::getAsStringInternal(std::string &Str,
2258                                    const PrintingPolicy &Policy) const {
2259   return getAsStringInternal(splitAccordingToPolicy(*this, Policy), Str,
2260                              Policy);
2261 }
2262 
2263 void QualType::getAsStringInternal(const Type *ty, Qualifiers qs,
2264                                    std::string &buffer,
2265                                    const PrintingPolicy &policy) {
2266   SmallString<256> Buf;
2267   llvm::raw_svector_ostream StrOS(Buf);
2268   TypePrinter(policy).print(ty, qs, StrOS, buffer);
2269   std::string str = std::string(StrOS.str());
2270   buffer.swap(str);
2271 }
2272