Type.h revision 4c67aa96401b67b5200e701cff87485067ab0792
1//===--- Type.h - C Language Family Type Representation ---------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10//  This file defines the Type interface and subclasses.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_AST_TYPE_H
15#define LLVM_CLANG_AST_TYPE_H
16
17#include "clang/AST/NestedNameSpecifier.h"
18#include "clang/AST/TemplateName.h"
19#include "clang/Basic/Diagnostic.h"
20#include "clang/Basic/ExceptionSpecificationType.h"
21#include "clang/Basic/IdentifierTable.h"
22#include "clang/Basic/LLVM.h"
23#include "clang/Basic/Linkage.h"
24#include "clang/Basic/PartialDiagnostic.h"
25#include "clang/Basic/Specifiers.h"
26#include "clang/Basic/Visibility.h"
27#include "llvm/ADT/APSInt.h"
28#include "llvm/ADT/FoldingSet.h"
29#include "llvm/ADT/Optional.h"
30#include "llvm/ADT/PointerIntPair.h"
31#include "llvm/ADT/PointerUnion.h"
32#include "llvm/ADT/Twine.h"
33#include "llvm/Support/ErrorHandling.h"
34#include "llvm/Support/type_traits.h"
35
36namespace clang {
37  enum {
38    TypeAlignmentInBits = 4,
39    TypeAlignment = 1 << TypeAlignmentInBits
40  };
41  class Type;
42  class ExtQuals;
43  class QualType;
44}
45
46namespace llvm {
47  template <typename T>
48  class PointerLikeTypeTraits;
49  template<>
50  class PointerLikeTypeTraits< ::clang::Type*> {
51  public:
52    static inline void *getAsVoidPointer(::clang::Type *P) { return P; }
53    static inline ::clang::Type *getFromVoidPointer(void *P) {
54      return static_cast< ::clang::Type*>(P);
55    }
56    enum { NumLowBitsAvailable = clang::TypeAlignmentInBits };
57  };
58  template<>
59  class PointerLikeTypeTraits< ::clang::ExtQuals*> {
60  public:
61    static inline void *getAsVoidPointer(::clang::ExtQuals *P) { return P; }
62    static inline ::clang::ExtQuals *getFromVoidPointer(void *P) {
63      return static_cast< ::clang::ExtQuals*>(P);
64    }
65    enum { NumLowBitsAvailable = clang::TypeAlignmentInBits };
66  };
67
68  template <>
69  struct isPodLike<clang::QualType> { static const bool value = true; };
70}
71
72namespace clang {
73  class ASTContext;
74  class TypedefNameDecl;
75  class TemplateDecl;
76  class TemplateTypeParmDecl;
77  class NonTypeTemplateParmDecl;
78  class TemplateTemplateParmDecl;
79  class TagDecl;
80  class RecordDecl;
81  class CXXRecordDecl;
82  class EnumDecl;
83  class FieldDecl;
84  class FunctionDecl;
85  class ObjCInterfaceDecl;
86  class ObjCProtocolDecl;
87  class ObjCMethodDecl;
88  class UnresolvedUsingTypenameDecl;
89  class Expr;
90  class Stmt;
91  class SourceLocation;
92  class StmtIteratorBase;
93  class TemplateArgument;
94  class TemplateArgumentLoc;
95  class TemplateArgumentListInfo;
96  class ElaboratedType;
97  class ExtQuals;
98  class ExtQualsTypeCommonBase;
99  struct PrintingPolicy;
100
101  template <typename> class CanQual;
102  typedef CanQual<Type> CanQualType;
103
104  // Provide forward declarations for all of the *Type classes
105#define TYPE(Class, Base) class Class##Type;
106#include "clang/AST/TypeNodes.def"
107
108/// Qualifiers - The collection of all-type qualifiers we support.
109/// Clang supports five independent qualifiers:
110/// * C99: const, volatile, and restrict
111/// * Embedded C (TR18037): address spaces
112/// * Objective C: the GC attributes (none, weak, or strong)
113class Qualifiers {
114public:
115  enum TQ { // NOTE: These flags must be kept in sync with DeclSpec::TQ.
116    Const    = 0x1,
117    Restrict = 0x2,
118    Volatile = 0x4,
119    CVRMask = Const | Volatile | Restrict
120  };
121
122  enum GC {
123    GCNone = 0,
124    Weak,
125    Strong
126  };
127
128  enum ObjCLifetime {
129    /// There is no lifetime qualification on this type.
130    OCL_None,
131
132    /// This object can be modified without requiring retains or
133    /// releases.
134    OCL_ExplicitNone,
135
136    /// Assigning into this object requires the old value to be
137    /// released and the new value to be retained.  The timing of the
138    /// release of the old value is inexact: it may be moved to
139    /// immediately after the last known point where the value is
140    /// live.
141    OCL_Strong,
142
143    /// Reading or writing from this object requires a barrier call.
144    OCL_Weak,
145
146    /// Assigning into this object requires a lifetime extension.
147    OCL_Autoreleasing
148  };
149
150  enum {
151    /// The maximum supported address space number.
152    /// 24 bits should be enough for anyone.
153    MaxAddressSpace = 0xffffffu,
154
155    /// The width of the "fast" qualifier mask.
156    FastWidth = 3,
157
158    /// The fast qualifier mask.
159    FastMask = (1 << FastWidth) - 1
160  };
161
162  Qualifiers() : Mask(0) {}
163
164  /// \brief Returns the common set of qualifiers while removing them from
165  /// the given sets.
166  static Qualifiers removeCommonQualifiers(Qualifiers &L, Qualifiers &R) {
167    // If both are only CVR-qualified, bit operations are sufficient.
168    if (!(L.Mask & ~CVRMask) && !(R.Mask & ~CVRMask)) {
169      Qualifiers Q;
170      Q.Mask = L.Mask & R.Mask;
171      L.Mask &= ~Q.Mask;
172      R.Mask &= ~Q.Mask;
173      return Q;
174    }
175
176    Qualifiers Q;
177    unsigned CommonCRV = L.getCVRQualifiers() & R.getCVRQualifiers();
178    Q.addCVRQualifiers(CommonCRV);
179    L.removeCVRQualifiers(CommonCRV);
180    R.removeCVRQualifiers(CommonCRV);
181
182    if (L.getObjCGCAttr() == R.getObjCGCAttr()) {
183      Q.setObjCGCAttr(L.getObjCGCAttr());
184      L.removeObjCGCAttr();
185      R.removeObjCGCAttr();
186    }
187
188    if (L.getObjCLifetime() == R.getObjCLifetime()) {
189      Q.setObjCLifetime(L.getObjCLifetime());
190      L.removeObjCLifetime();
191      R.removeObjCLifetime();
192    }
193
194    if (L.getAddressSpace() == R.getAddressSpace()) {
195      Q.setAddressSpace(L.getAddressSpace());
196      L.removeAddressSpace();
197      R.removeAddressSpace();
198    }
199    return Q;
200  }
201
202  static Qualifiers fromFastMask(unsigned Mask) {
203    Qualifiers Qs;
204    Qs.addFastQualifiers(Mask);
205    return Qs;
206  }
207
208  static Qualifiers fromCVRMask(unsigned CVR) {
209    Qualifiers Qs;
210    Qs.addCVRQualifiers(CVR);
211    return Qs;
212  }
213
214  // Deserialize qualifiers from an opaque representation.
215  static Qualifiers fromOpaqueValue(unsigned opaque) {
216    Qualifiers Qs;
217    Qs.Mask = opaque;
218    return Qs;
219  }
220
221  // Serialize these qualifiers into an opaque representation.
222  unsigned getAsOpaqueValue() const {
223    return Mask;
224  }
225
226  bool hasConst() const { return Mask & Const; }
227  void setConst(bool flag) {
228    Mask = (Mask & ~Const) | (flag ? Const : 0);
229  }
230  void removeConst() { Mask &= ~Const; }
231  void addConst() { Mask |= Const; }
232
233  bool hasVolatile() const { return Mask & Volatile; }
234  void setVolatile(bool flag) {
235    Mask = (Mask & ~Volatile) | (flag ? Volatile : 0);
236  }
237  void removeVolatile() { Mask &= ~Volatile; }
238  void addVolatile() { Mask |= Volatile; }
239
240  bool hasRestrict() const { return Mask & Restrict; }
241  void setRestrict(bool flag) {
242    Mask = (Mask & ~Restrict) | (flag ? Restrict : 0);
243  }
244  void removeRestrict() { Mask &= ~Restrict; }
245  void addRestrict() { Mask |= Restrict; }
246
247  bool hasCVRQualifiers() const { return getCVRQualifiers(); }
248  unsigned getCVRQualifiers() const { return Mask & CVRMask; }
249  void setCVRQualifiers(unsigned mask) {
250    assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits");
251    Mask = (Mask & ~CVRMask) | mask;
252  }
253  void removeCVRQualifiers(unsigned mask) {
254    assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits");
255    Mask &= ~mask;
256  }
257  void removeCVRQualifiers() {
258    removeCVRQualifiers(CVRMask);
259  }
260  void addCVRQualifiers(unsigned mask) {
261    assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits");
262    Mask |= mask;
263  }
264
265  bool hasObjCGCAttr() const { return Mask & GCAttrMask; }
266  GC getObjCGCAttr() const { return GC((Mask & GCAttrMask) >> GCAttrShift); }
267  void setObjCGCAttr(GC type) {
268    Mask = (Mask & ~GCAttrMask) | (type << GCAttrShift);
269  }
270  void removeObjCGCAttr() { setObjCGCAttr(GCNone); }
271  void addObjCGCAttr(GC type) {
272    assert(type);
273    setObjCGCAttr(type);
274  }
275  Qualifiers withoutObjCGCAttr() const {
276    Qualifiers qs = *this;
277    qs.removeObjCGCAttr();
278    return qs;
279  }
280  Qualifiers withoutObjCLifetime() const {
281    Qualifiers qs = *this;
282    qs.removeObjCLifetime();
283    return qs;
284  }
285
286  bool hasObjCLifetime() const { return Mask & LifetimeMask; }
287  ObjCLifetime getObjCLifetime() const {
288    return ObjCLifetime((Mask & LifetimeMask) >> LifetimeShift);
289  }
290  void setObjCLifetime(ObjCLifetime type) {
291    Mask = (Mask & ~LifetimeMask) | (type << LifetimeShift);
292  }
293  void removeObjCLifetime() { setObjCLifetime(OCL_None); }
294  void addObjCLifetime(ObjCLifetime type) {
295    assert(type);
296    assert(!hasObjCLifetime());
297    Mask |= (type << LifetimeShift);
298  }
299
300  /// True if the lifetime is neither None or ExplicitNone.
301  bool hasNonTrivialObjCLifetime() const {
302    ObjCLifetime lifetime = getObjCLifetime();
303    return (lifetime > OCL_ExplicitNone);
304  }
305
306  /// True if the lifetime is either strong or weak.
307  bool hasStrongOrWeakObjCLifetime() const {
308    ObjCLifetime lifetime = getObjCLifetime();
309    return (lifetime == OCL_Strong || lifetime == OCL_Weak);
310  }
311
312  bool hasAddressSpace() const { return Mask & AddressSpaceMask; }
313  unsigned getAddressSpace() const { return Mask >> AddressSpaceShift; }
314  void setAddressSpace(unsigned space) {
315    assert(space <= MaxAddressSpace);
316    Mask = (Mask & ~AddressSpaceMask)
317         | (((uint32_t) space) << AddressSpaceShift);
318  }
319  void removeAddressSpace() { setAddressSpace(0); }
320  void addAddressSpace(unsigned space) {
321    assert(space);
322    setAddressSpace(space);
323  }
324
325  // Fast qualifiers are those that can be allocated directly
326  // on a QualType object.
327  bool hasFastQualifiers() const { return getFastQualifiers(); }
328  unsigned getFastQualifiers() const { return Mask & FastMask; }
329  void setFastQualifiers(unsigned mask) {
330    assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits");
331    Mask = (Mask & ~FastMask) | mask;
332  }
333  void removeFastQualifiers(unsigned mask) {
334    assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits");
335    Mask &= ~mask;
336  }
337  void removeFastQualifiers() {
338    removeFastQualifiers(FastMask);
339  }
340  void addFastQualifiers(unsigned mask) {
341    assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits");
342    Mask |= mask;
343  }
344
345  /// hasNonFastQualifiers - Return true if the set contains any
346  /// qualifiers which require an ExtQuals node to be allocated.
347  bool hasNonFastQualifiers() const { return Mask & ~FastMask; }
348  Qualifiers getNonFastQualifiers() const {
349    Qualifiers Quals = *this;
350    Quals.setFastQualifiers(0);
351    return Quals;
352  }
353
354  /// hasQualifiers - Return true if the set contains any qualifiers.
355  bool hasQualifiers() const { return Mask; }
356  bool empty() const { return !Mask; }
357
358  /// \brief Add the qualifiers from the given set to this set.
359  void addQualifiers(Qualifiers Q) {
360    // If the other set doesn't have any non-boolean qualifiers, just
361    // bit-or it in.
362    if (!(Q.Mask & ~CVRMask))
363      Mask |= Q.Mask;
364    else {
365      Mask |= (Q.Mask & CVRMask);
366      if (Q.hasAddressSpace())
367        addAddressSpace(Q.getAddressSpace());
368      if (Q.hasObjCGCAttr())
369        addObjCGCAttr(Q.getObjCGCAttr());
370      if (Q.hasObjCLifetime())
371        addObjCLifetime(Q.getObjCLifetime());
372    }
373  }
374
375  /// \brief Remove the qualifiers from the given set from this set.
376  void removeQualifiers(Qualifiers Q) {
377    // If the other set doesn't have any non-boolean qualifiers, just
378    // bit-and the inverse in.
379    if (!(Q.Mask & ~CVRMask))
380      Mask &= ~Q.Mask;
381    else {
382      Mask &= ~(Q.Mask & CVRMask);
383      if (getObjCGCAttr() == Q.getObjCGCAttr())
384        removeObjCGCAttr();
385      if (getObjCLifetime() == Q.getObjCLifetime())
386        removeObjCLifetime();
387      if (getAddressSpace() == Q.getAddressSpace())
388        removeAddressSpace();
389    }
390  }
391
392  /// \brief Add the qualifiers from the given set to this set, given that
393  /// they don't conflict.
394  void addConsistentQualifiers(Qualifiers qs) {
395    assert(getAddressSpace() == qs.getAddressSpace() ||
396           !hasAddressSpace() || !qs.hasAddressSpace());
397    assert(getObjCGCAttr() == qs.getObjCGCAttr() ||
398           !hasObjCGCAttr() || !qs.hasObjCGCAttr());
399    assert(getObjCLifetime() == qs.getObjCLifetime() ||
400           !hasObjCLifetime() || !qs.hasObjCLifetime());
401    Mask |= qs.Mask;
402  }
403
404  /// \brief Determines if these qualifiers compatibly include another set.
405  /// Generally this answers the question of whether an object with the other
406  /// qualifiers can be safely used as an object with these qualifiers.
407  bool compatiblyIncludes(Qualifiers other) const {
408    return
409      // Address spaces must match exactly.
410      getAddressSpace() == other.getAddressSpace() &&
411      // ObjC GC qualifiers can match, be added, or be removed, but can't be
412      // changed.
413      (getObjCGCAttr() == other.getObjCGCAttr() ||
414       !hasObjCGCAttr() || !other.hasObjCGCAttr()) &&
415      // ObjC lifetime qualifiers must match exactly.
416      getObjCLifetime() == other.getObjCLifetime() &&
417      // CVR qualifiers may subset.
418      (((Mask & CVRMask) | (other.Mask & CVRMask)) == (Mask & CVRMask));
419  }
420
421  /// \brief Determines if these qualifiers compatibly include another set of
422  /// qualifiers from the narrow perspective of Objective-C ARC lifetime.
423  ///
424  /// One set of Objective-C lifetime qualifiers compatibly includes the other
425  /// if the lifetime qualifiers match, or if both are non-__weak and the
426  /// including set also contains the 'const' qualifier.
427  bool compatiblyIncludesObjCLifetime(Qualifiers other) const {
428    if (getObjCLifetime() == other.getObjCLifetime())
429      return true;
430
431    if (getObjCLifetime() == OCL_Weak || other.getObjCLifetime() == OCL_Weak)
432      return false;
433
434    return hasConst();
435  }
436
437  /// \brief Determine whether this set of qualifiers is a strict superset of
438  /// another set of qualifiers, not considering qualifier compatibility.
439  bool isStrictSupersetOf(Qualifiers Other) const;
440
441  bool operator==(Qualifiers Other) const { return Mask == Other.Mask; }
442  bool operator!=(Qualifiers Other) const { return Mask != Other.Mask; }
443
444  operator bool() const { return hasQualifiers(); }
445
446  Qualifiers &operator+=(Qualifiers R) {
447    addQualifiers(R);
448    return *this;
449  }
450
451  // Union two qualifier sets.  If an enumerated qualifier appears
452  // in both sets, use the one from the right.
453  friend Qualifiers operator+(Qualifiers L, Qualifiers R) {
454    L += R;
455    return L;
456  }
457
458  Qualifiers &operator-=(Qualifiers R) {
459    removeQualifiers(R);
460    return *this;
461  }
462
463  /// \brief Compute the difference between two qualifier sets.
464  friend Qualifiers operator-(Qualifiers L, Qualifiers R) {
465    L -= R;
466    return L;
467  }
468
469  std::string getAsString() const;
470  std::string getAsString(const PrintingPolicy &Policy) const;
471
472  bool isEmptyWhenPrinted(const PrintingPolicy &Policy) const;
473  void print(raw_ostream &OS, const PrintingPolicy &Policy,
474             bool appendSpaceIfNonEmpty = false) const;
475
476  void Profile(llvm::FoldingSetNodeID &ID) const {
477    ID.AddInteger(Mask);
478  }
479
480private:
481
482  // bits:     |0 1 2|3 .. 4|5  ..  7|8   ...   31|
483  //           |C R V|GCAttr|Lifetime|AddressSpace|
484  uint32_t Mask;
485
486  static const uint32_t GCAttrMask = 0x18;
487  static const uint32_t GCAttrShift = 3;
488  static const uint32_t LifetimeMask = 0xE0;
489  static const uint32_t LifetimeShift = 5;
490  static const uint32_t AddressSpaceMask = ~(CVRMask|GCAttrMask|LifetimeMask);
491  static const uint32_t AddressSpaceShift = 8;
492};
493
494/// A std::pair-like structure for storing a qualified type split
495/// into its local qualifiers and its locally-unqualified type.
496struct SplitQualType {
497  /// The locally-unqualified type.
498  const Type *Ty;
499
500  /// The local qualifiers.
501  Qualifiers Quals;
502
503  SplitQualType() : Ty(0), Quals() {}
504  SplitQualType(const Type *ty, Qualifiers qs) : Ty(ty), Quals(qs) {}
505
506  SplitQualType getSingleStepDesugaredType() const; // end of this file
507
508  // Make llvm::tie work.
509  operator std::pair<const Type *,Qualifiers>() const {
510    return std::pair<const Type *,Qualifiers>(Ty, Quals);
511  }
512
513  friend bool operator==(SplitQualType a, SplitQualType b) {
514    return a.Ty == b.Ty && a.Quals == b.Quals;
515  }
516  friend bool operator!=(SplitQualType a, SplitQualType b) {
517    return a.Ty != b.Ty || a.Quals != b.Quals;
518  }
519};
520
521/// QualType - For efficiency, we don't store CV-qualified types as nodes on
522/// their own: instead each reference to a type stores the qualifiers.  This
523/// greatly reduces the number of nodes we need to allocate for types (for
524/// example we only need one for 'int', 'const int', 'volatile int',
525/// 'const volatile int', etc).
526///
527/// As an added efficiency bonus, instead of making this a pair, we
528/// just store the two bits we care about in the low bits of the
529/// pointer.  To handle the packing/unpacking, we make QualType be a
530/// simple wrapper class that acts like a smart pointer.  A third bit
531/// indicates whether there are extended qualifiers present, in which
532/// case the pointer points to a special structure.
533class QualType {
534  // Thankfully, these are efficiently composable.
535  llvm::PointerIntPair<llvm::PointerUnion<const Type*,const ExtQuals*>,
536                       Qualifiers::FastWidth> Value;
537
538  const ExtQuals *getExtQualsUnsafe() const {
539    return Value.getPointer().get<const ExtQuals*>();
540  }
541
542  const Type *getTypePtrUnsafe() const {
543    return Value.getPointer().get<const Type*>();
544  }
545
546  const ExtQualsTypeCommonBase *getCommonPtr() const {
547    assert(!isNull() && "Cannot retrieve a NULL type pointer");
548    uintptr_t CommonPtrVal
549      = reinterpret_cast<uintptr_t>(Value.getOpaqueValue());
550    CommonPtrVal &= ~(uintptr_t)((1 << TypeAlignmentInBits) - 1);
551    return reinterpret_cast<ExtQualsTypeCommonBase*>(CommonPtrVal);
552  }
553
554  friend class QualifierCollector;
555public:
556  QualType() {}
557
558  QualType(const Type *Ptr, unsigned Quals)
559    : Value(Ptr, Quals) {}
560  QualType(const ExtQuals *Ptr, unsigned Quals)
561    : Value(Ptr, Quals) {}
562
563  unsigned getLocalFastQualifiers() const { return Value.getInt(); }
564  void setLocalFastQualifiers(unsigned Quals) { Value.setInt(Quals); }
565
566  /// Retrieves a pointer to the underlying (unqualified) type.
567  ///
568  /// This function requires that the type not be NULL. If the type might be
569  /// NULL, use the (slightly less efficient) \c getTypePtrOrNull().
570  const Type *getTypePtr() const;
571
572  const Type *getTypePtrOrNull() const;
573
574  /// Retrieves a pointer to the name of the base type.
575  const IdentifierInfo *getBaseTypeIdentifier() const;
576
577  /// Divides a QualType into its unqualified type and a set of local
578  /// qualifiers.
579  SplitQualType split() const;
580
581  void *getAsOpaquePtr() const { return Value.getOpaqueValue(); }
582  static QualType getFromOpaquePtr(const void *Ptr) {
583    QualType T;
584    T.Value.setFromOpaqueValue(const_cast<void*>(Ptr));
585    return T;
586  }
587
588  const Type &operator*() const {
589    return *getTypePtr();
590  }
591
592  const Type *operator->() const {
593    return getTypePtr();
594  }
595
596  bool isCanonical() const;
597  bool isCanonicalAsParam() const;
598
599  /// isNull - Return true if this QualType doesn't point to a type yet.
600  bool isNull() const {
601    return Value.getPointer().isNull();
602  }
603
604  /// \brief Determine whether this particular QualType instance has the
605  /// "const" qualifier set, without looking through typedefs that may have
606  /// added "const" at a different level.
607  bool isLocalConstQualified() const {
608    return (getLocalFastQualifiers() & Qualifiers::Const);
609  }
610
611  /// \brief Determine whether this type is const-qualified.
612  bool isConstQualified() const;
613
614  /// \brief Determine whether this particular QualType instance has the
615  /// "restrict" qualifier set, without looking through typedefs that may have
616  /// added "restrict" at a different level.
617  bool isLocalRestrictQualified() const {
618    return (getLocalFastQualifiers() & Qualifiers::Restrict);
619  }
620
621  /// \brief Determine whether this type is restrict-qualified.
622  bool isRestrictQualified() const;
623
624  /// \brief Determine whether this particular QualType instance has the
625  /// "volatile" qualifier set, without looking through typedefs that may have
626  /// added "volatile" at a different level.
627  bool isLocalVolatileQualified() const {
628    return (getLocalFastQualifiers() & Qualifiers::Volatile);
629  }
630
631  /// \brief Determine whether this type is volatile-qualified.
632  bool isVolatileQualified() const;
633
634  /// \brief Determine whether this particular QualType instance has any
635  /// qualifiers, without looking through any typedefs that might add
636  /// qualifiers at a different level.
637  bool hasLocalQualifiers() const {
638    return getLocalFastQualifiers() || hasLocalNonFastQualifiers();
639  }
640
641  /// \brief Determine whether this type has any qualifiers.
642  bool hasQualifiers() const;
643
644  /// \brief Determine whether this particular QualType instance has any
645  /// "non-fast" qualifiers, e.g., those that are stored in an ExtQualType
646  /// instance.
647  bool hasLocalNonFastQualifiers() const {
648    return Value.getPointer().is<const ExtQuals*>();
649  }
650
651  /// \brief Retrieve the set of qualifiers local to this particular QualType
652  /// instance, not including any qualifiers acquired through typedefs or
653  /// other sugar.
654  Qualifiers getLocalQualifiers() const;
655
656  /// \brief Retrieve the set of qualifiers applied to this type.
657  Qualifiers getQualifiers() const;
658
659  /// \brief Retrieve the set of CVR (const-volatile-restrict) qualifiers
660  /// local to this particular QualType instance, not including any qualifiers
661  /// acquired through typedefs or other sugar.
662  unsigned getLocalCVRQualifiers() const {
663    return getLocalFastQualifiers();
664  }
665
666  /// \brief Retrieve the set of CVR (const-volatile-restrict) qualifiers
667  /// applied to this type.
668  unsigned getCVRQualifiers() const;
669
670  bool isConstant(ASTContext& Ctx) const {
671    return QualType::isConstant(*this, Ctx);
672  }
673
674  /// \brief Determine whether this is a Plain Old Data (POD) type (C++ 3.9p10).
675  bool isPODType(ASTContext &Context) const;
676
677  /// isCXX98PODType() - Return true if this is a POD type according to the
678  /// rules of the C++98 standard, regardless of the current compilation's
679  /// language.
680  bool isCXX98PODType(ASTContext &Context) const;
681
682  /// isCXX11PODType() - Return true if this is a POD type according to the
683  /// more relaxed rules of the C++11 standard, regardless of the current
684  /// compilation's language.
685  /// (C++0x [basic.types]p9)
686  bool isCXX11PODType(ASTContext &Context) const;
687
688  /// isTrivialType - Return true if this is a trivial type
689  /// (C++0x [basic.types]p9)
690  bool isTrivialType(ASTContext &Context) const;
691
692  /// isTriviallyCopyableType - Return true if this is a trivially
693  /// copyable type (C++0x [basic.types]p9)
694  bool isTriviallyCopyableType(ASTContext &Context) const;
695
696  // Don't promise in the API that anything besides 'const' can be
697  // easily added.
698
699  /// addConst - add the specified type qualifier to this QualType.
700  void addConst() {
701    addFastQualifiers(Qualifiers::Const);
702  }
703  QualType withConst() const {
704    return withFastQualifiers(Qualifiers::Const);
705  }
706
707  /// addVolatile - add the specified type qualifier to this QualType.
708  void addVolatile() {
709    addFastQualifiers(Qualifiers::Volatile);
710  }
711  QualType withVolatile() const {
712    return withFastQualifiers(Qualifiers::Volatile);
713  }
714
715  /// Add the restrict qualifier to this QualType.
716  void addRestrict() {
717    addFastQualifiers(Qualifiers::Restrict);
718  }
719  QualType withRestrict() const {
720    return withFastQualifiers(Qualifiers::Restrict);
721  }
722
723  QualType withCVRQualifiers(unsigned CVR) const {
724    return withFastQualifiers(CVR);
725  }
726
727  void addFastQualifiers(unsigned TQs) {
728    assert(!(TQs & ~Qualifiers::FastMask)
729           && "non-fast qualifier bits set in mask!");
730    Value.setInt(Value.getInt() | TQs);
731  }
732
733  void removeLocalConst();
734  void removeLocalVolatile();
735  void removeLocalRestrict();
736  void removeLocalCVRQualifiers(unsigned Mask);
737
738  void removeLocalFastQualifiers() { Value.setInt(0); }
739  void removeLocalFastQualifiers(unsigned Mask) {
740    assert(!(Mask & ~Qualifiers::FastMask) && "mask has non-fast qualifiers");
741    Value.setInt(Value.getInt() & ~Mask);
742  }
743
744  // Creates a type with the given qualifiers in addition to any
745  // qualifiers already on this type.
746  QualType withFastQualifiers(unsigned TQs) const {
747    QualType T = *this;
748    T.addFastQualifiers(TQs);
749    return T;
750  }
751
752  // Creates a type with exactly the given fast qualifiers, removing
753  // any existing fast qualifiers.
754  QualType withExactLocalFastQualifiers(unsigned TQs) const {
755    return withoutLocalFastQualifiers().withFastQualifiers(TQs);
756  }
757
758  // Removes fast qualifiers, but leaves any extended qualifiers in place.
759  QualType withoutLocalFastQualifiers() const {
760    QualType T = *this;
761    T.removeLocalFastQualifiers();
762    return T;
763  }
764
765  QualType getCanonicalType() const;
766
767  /// \brief Return this type with all of the instance-specific qualifiers
768  /// removed, but without removing any qualifiers that may have been applied
769  /// through typedefs.
770  QualType getLocalUnqualifiedType() const { return QualType(getTypePtr(), 0); }
771
772  /// \brief Retrieve the unqualified variant of the given type,
773  /// removing as little sugar as possible.
774  ///
775  /// This routine looks through various kinds of sugar to find the
776  /// least-desugared type that is unqualified. For example, given:
777  ///
778  /// \code
779  /// typedef int Integer;
780  /// typedef const Integer CInteger;
781  /// typedef CInteger DifferenceType;
782  /// \endcode
783  ///
784  /// Executing \c getUnqualifiedType() on the type \c DifferenceType will
785  /// desugar until we hit the type \c Integer, which has no qualifiers on it.
786  ///
787  /// The resulting type might still be qualified if it's sugar for an array
788  /// type.  To strip qualifiers even from within a sugared array type, use
789  /// ASTContext::getUnqualifiedArrayType.
790  inline QualType getUnqualifiedType() const;
791
792  /// getSplitUnqualifiedType - Retrieve the unqualified variant of the
793  /// given type, removing as little sugar as possible.
794  ///
795  /// Like getUnqualifiedType(), but also returns the set of
796  /// qualifiers that were built up.
797  ///
798  /// The resulting type might still be qualified if it's sugar for an array
799  /// type.  To strip qualifiers even from within a sugared array type, use
800  /// ASTContext::getUnqualifiedArrayType.
801  inline SplitQualType getSplitUnqualifiedType() const;
802
803  /// \brief Determine whether this type is more qualified than the other
804  /// given type, requiring exact equality for non-CVR qualifiers.
805  bool isMoreQualifiedThan(QualType Other) const;
806
807  /// \brief Determine whether this type is at least as qualified as the other
808  /// given type, requiring exact equality for non-CVR qualifiers.
809  bool isAtLeastAsQualifiedAs(QualType Other) const;
810
811  QualType getNonReferenceType() const;
812
813  /// \brief Determine the type of a (typically non-lvalue) expression with the
814  /// specified result type.
815  ///
816  /// This routine should be used for expressions for which the return type is
817  /// explicitly specified (e.g., in a cast or call) and isn't necessarily
818  /// an lvalue. It removes a top-level reference (since there are no
819  /// expressions of reference type) and deletes top-level cvr-qualifiers
820  /// from non-class types (in C++) or all types (in C).
821  QualType getNonLValueExprType(ASTContext &Context) const;
822
823  /// getDesugaredType - Return the specified type with any "sugar" removed from
824  /// the type.  This takes off typedefs, typeof's etc.  If the outer level of
825  /// the type is already concrete, it returns it unmodified.  This is similar
826  /// to getting the canonical type, but it doesn't remove *all* typedefs.  For
827  /// example, it returns "T*" as "T*", (not as "int*"), because the pointer is
828  /// concrete.
829  ///
830  /// Qualifiers are left in place.
831  QualType getDesugaredType(const ASTContext &Context) const {
832    return getDesugaredType(*this, Context);
833  }
834
835  SplitQualType getSplitDesugaredType() const {
836    return getSplitDesugaredType(*this);
837  }
838
839  /// \brief Return the specified type with one level of "sugar" removed from
840  /// the type.
841  ///
842  /// This routine takes off the first typedef, typeof, etc. If the outer level
843  /// of the type is already concrete, it returns it unmodified.
844  QualType getSingleStepDesugaredType(const ASTContext &Context) const {
845    return getSingleStepDesugaredTypeImpl(*this, Context);
846  }
847
848  /// IgnoreParens - Returns the specified type after dropping any
849  /// outer-level parentheses.
850  QualType IgnoreParens() const {
851    if (isa<ParenType>(*this))
852      return QualType::IgnoreParens(*this);
853    return *this;
854  }
855
856  /// operator==/!= - Indicate whether the specified types and qualifiers are
857  /// identical.
858  friend bool operator==(const QualType &LHS, const QualType &RHS) {
859    return LHS.Value == RHS.Value;
860  }
861  friend bool operator!=(const QualType &LHS, const QualType &RHS) {
862    return LHS.Value != RHS.Value;
863  }
864  std::string getAsString() const {
865    return getAsString(split());
866  }
867  static std::string getAsString(SplitQualType split) {
868    return getAsString(split.Ty, split.Quals);
869  }
870  static std::string getAsString(const Type *ty, Qualifiers qs);
871
872  std::string getAsString(const PrintingPolicy &Policy) const;
873
874  void print(raw_ostream &OS, const PrintingPolicy &Policy,
875             const Twine &PlaceHolder = Twine()) const {
876    print(split(), OS, Policy, PlaceHolder);
877  }
878  static void print(SplitQualType split, raw_ostream &OS,
879                    const PrintingPolicy &policy, const Twine &PlaceHolder) {
880    return print(split.Ty, split.Quals, OS, policy, PlaceHolder);
881  }
882  static void print(const Type *ty, Qualifiers qs,
883                    raw_ostream &OS, const PrintingPolicy &policy,
884                    const Twine &PlaceHolder);
885
886  void getAsStringInternal(std::string &Str,
887                           const PrintingPolicy &Policy) const {
888    return getAsStringInternal(split(), Str, Policy);
889  }
890  static void getAsStringInternal(SplitQualType split, std::string &out,
891                                  const PrintingPolicy &policy) {
892    return getAsStringInternal(split.Ty, split.Quals, out, policy);
893  }
894  static void getAsStringInternal(const Type *ty, Qualifiers qs,
895                                  std::string &out,
896                                  const PrintingPolicy &policy);
897
898  class StreamedQualTypeHelper {
899    const QualType &T;
900    const PrintingPolicy &Policy;
901    const Twine &PlaceHolder;
902  public:
903    StreamedQualTypeHelper(const QualType &T, const PrintingPolicy &Policy,
904                           const Twine &PlaceHolder)
905      : T(T), Policy(Policy), PlaceHolder(PlaceHolder) { }
906
907    friend raw_ostream &operator<<(raw_ostream &OS,
908                                   const StreamedQualTypeHelper &SQT) {
909      SQT.T.print(OS, SQT.Policy, SQT.PlaceHolder);
910      return OS;
911    }
912  };
913
914  StreamedQualTypeHelper stream(const PrintingPolicy &Policy,
915                                const Twine &PlaceHolder = Twine()) const {
916    return StreamedQualTypeHelper(*this, Policy, PlaceHolder);
917  }
918
919  void dump(const char *s) const;
920  void dump() const;
921
922  void Profile(llvm::FoldingSetNodeID &ID) const {
923    ID.AddPointer(getAsOpaquePtr());
924  }
925
926  /// getAddressSpace - Return the address space of this type.
927  inline unsigned getAddressSpace() const;
928
929  /// getObjCGCAttr - Returns gc attribute of this type.
930  inline Qualifiers::GC getObjCGCAttr() const;
931
932  /// isObjCGCWeak true when Type is objc's weak.
933  bool isObjCGCWeak() const {
934    return getObjCGCAttr() == Qualifiers::Weak;
935  }
936
937  /// isObjCGCStrong true when Type is objc's strong.
938  bool isObjCGCStrong() const {
939    return getObjCGCAttr() == Qualifiers::Strong;
940  }
941
942  /// getObjCLifetime - Returns lifetime attribute of this type.
943  Qualifiers::ObjCLifetime getObjCLifetime() const {
944    return getQualifiers().getObjCLifetime();
945  }
946
947  bool hasNonTrivialObjCLifetime() const {
948    return getQualifiers().hasNonTrivialObjCLifetime();
949  }
950
951  bool hasStrongOrWeakObjCLifetime() const {
952    return getQualifiers().hasStrongOrWeakObjCLifetime();
953  }
954
955  enum DestructionKind {
956    DK_none,
957    DK_cxx_destructor,
958    DK_objc_strong_lifetime,
959    DK_objc_weak_lifetime
960  };
961
962  /// isDestructedType - nonzero if objects of this type require
963  /// non-trivial work to clean up after.  Non-zero because it's
964  /// conceivable that qualifiers (objc_gc(weak)?) could make
965  /// something require destruction.
966  DestructionKind isDestructedType() const {
967    return isDestructedTypeImpl(*this);
968  }
969
970  /// \brief Determine whether expressions of the given type are forbidden
971  /// from being lvalues in C.
972  ///
973  /// The expression types that are forbidden to be lvalues are:
974  ///   - 'void', but not qualified void
975  ///   - function types
976  ///
977  /// The exact rule here is C99 6.3.2.1:
978  ///   An lvalue is an expression with an object type or an incomplete
979  ///   type other than void.
980  bool isCForbiddenLValueType() const;
981
982private:
983  // These methods are implemented in a separate translation unit;
984  // "static"-ize them to avoid creating temporary QualTypes in the
985  // caller.
986  static bool isConstant(QualType T, ASTContext& Ctx);
987  static QualType getDesugaredType(QualType T, const ASTContext &Context);
988  static SplitQualType getSplitDesugaredType(QualType T);
989  static SplitQualType getSplitUnqualifiedTypeImpl(QualType type);
990  static QualType getSingleStepDesugaredTypeImpl(QualType type,
991                                                 const ASTContext &C);
992  static QualType IgnoreParens(QualType T);
993  static DestructionKind isDestructedTypeImpl(QualType type);
994};
995
996} // end clang.
997
998namespace llvm {
999/// Implement simplify_type for QualType, so that we can dyn_cast from QualType
1000/// to a specific Type class.
1001template<> struct simplify_type<const ::clang::QualType> {
1002  typedef const ::clang::Type *SimpleType;
1003  static SimpleType getSimplifiedValue(const ::clang::QualType &Val) {
1004    return Val.getTypePtr();
1005  }
1006};
1007template<> struct simplify_type< ::clang::QualType>
1008  : public simplify_type<const ::clang::QualType> {};
1009
1010// Teach SmallPtrSet that QualType is "basically a pointer".
1011template<>
1012class PointerLikeTypeTraits<clang::QualType> {
1013public:
1014  static inline void *getAsVoidPointer(clang::QualType P) {
1015    return P.getAsOpaquePtr();
1016  }
1017  static inline clang::QualType getFromVoidPointer(void *P) {
1018    return clang::QualType::getFromOpaquePtr(P);
1019  }
1020  // Various qualifiers go in low bits.
1021  enum { NumLowBitsAvailable = 0 };
1022};
1023
1024} // end namespace llvm
1025
1026namespace clang {
1027
1028/// \brief Base class that is common to both the \c ExtQuals and \c Type
1029/// classes, which allows \c QualType to access the common fields between the
1030/// two.
1031///
1032class ExtQualsTypeCommonBase {
1033  ExtQualsTypeCommonBase(const Type *baseType, QualType canon)
1034    : BaseType(baseType), CanonicalType(canon) {}
1035
1036  /// \brief The "base" type of an extended qualifiers type (\c ExtQuals) or
1037  /// a self-referential pointer (for \c Type).
1038  ///
1039  /// This pointer allows an efficient mapping from a QualType to its
1040  /// underlying type pointer.
1041  const Type *const BaseType;
1042
1043  /// \brief The canonical type of this type.  A QualType.
1044  QualType CanonicalType;
1045
1046  friend class QualType;
1047  friend class Type;
1048  friend class ExtQuals;
1049};
1050
1051/// ExtQuals - We can encode up to four bits in the low bits of a
1052/// type pointer, but there are many more type qualifiers that we want
1053/// to be able to apply to an arbitrary type.  Therefore we have this
1054/// struct, intended to be heap-allocated and used by QualType to
1055/// store qualifiers.
1056///
1057/// The current design tags the 'const', 'restrict', and 'volatile' qualifiers
1058/// in three low bits on the QualType pointer; a fourth bit records whether
1059/// the pointer is an ExtQuals node. The extended qualifiers (address spaces,
1060/// Objective-C GC attributes) are much more rare.
1061class ExtQuals : public ExtQualsTypeCommonBase, public llvm::FoldingSetNode {
1062  // NOTE: changing the fast qualifiers should be straightforward as
1063  // long as you don't make 'const' non-fast.
1064  // 1. Qualifiers:
1065  //    a) Modify the bitmasks (Qualifiers::TQ and DeclSpec::TQ).
1066  //       Fast qualifiers must occupy the low-order bits.
1067  //    b) Update Qualifiers::FastWidth and FastMask.
1068  // 2. QualType:
1069  //    a) Update is{Volatile,Restrict}Qualified(), defined inline.
1070  //    b) Update remove{Volatile,Restrict}, defined near the end of
1071  //       this header.
1072  // 3. ASTContext:
1073  //    a) Update get{Volatile,Restrict}Type.
1074
1075  /// Quals - the immutable set of qualifiers applied by this
1076  /// node;  always contains extended qualifiers.
1077  Qualifiers Quals;
1078
1079  ExtQuals *this_() { return this; }
1080
1081public:
1082  ExtQuals(const Type *baseType, QualType canon, Qualifiers quals)
1083    : ExtQualsTypeCommonBase(baseType,
1084                             canon.isNull() ? QualType(this_(), 0) : canon),
1085      Quals(quals)
1086  {
1087    assert(Quals.hasNonFastQualifiers()
1088           && "ExtQuals created with no fast qualifiers");
1089    assert(!Quals.hasFastQualifiers()
1090           && "ExtQuals created with fast qualifiers");
1091  }
1092
1093  Qualifiers getQualifiers() const { return Quals; }
1094
1095  bool hasObjCGCAttr() const { return Quals.hasObjCGCAttr(); }
1096  Qualifiers::GC getObjCGCAttr() const { return Quals.getObjCGCAttr(); }
1097
1098  bool hasObjCLifetime() const { return Quals.hasObjCLifetime(); }
1099  Qualifiers::ObjCLifetime getObjCLifetime() const {
1100    return Quals.getObjCLifetime();
1101  }
1102
1103  bool hasAddressSpace() const { return Quals.hasAddressSpace(); }
1104  unsigned getAddressSpace() const { return Quals.getAddressSpace(); }
1105
1106  const Type *getBaseType() const { return BaseType; }
1107
1108public:
1109  void Profile(llvm::FoldingSetNodeID &ID) const {
1110    Profile(ID, getBaseType(), Quals);
1111  }
1112  static void Profile(llvm::FoldingSetNodeID &ID,
1113                      const Type *BaseType,
1114                      Qualifiers Quals) {
1115    assert(!Quals.hasFastQualifiers() && "fast qualifiers in ExtQuals hash!");
1116    ID.AddPointer(BaseType);
1117    Quals.Profile(ID);
1118  }
1119};
1120
1121/// \brief The kind of C++0x ref-qualifier associated with a function type,
1122/// which determines whether a member function's "this" object can be an
1123/// lvalue, rvalue, or neither.
1124enum RefQualifierKind {
1125  /// \brief No ref-qualifier was provided.
1126  RQ_None = 0,
1127  /// \brief An lvalue ref-qualifier was provided (\c &).
1128  RQ_LValue,
1129  /// \brief An rvalue ref-qualifier was provided (\c &&).
1130  RQ_RValue
1131};
1132
1133/// Type - This is the base class of the type hierarchy.  A central concept
1134/// with types is that each type always has a canonical type.  A canonical type
1135/// is the type with any typedef names stripped out of it or the types it
1136/// references.  For example, consider:
1137///
1138///  typedef int  foo;
1139///  typedef foo* bar;
1140///    'int *'    'foo *'    'bar'
1141///
1142/// There will be a Type object created for 'int'.  Since int is canonical, its
1143/// canonicaltype pointer points to itself.  There is also a Type for 'foo' (a
1144/// TypedefType).  Its CanonicalType pointer points to the 'int' Type.  Next
1145/// there is a PointerType that represents 'int*', which, like 'int', is
1146/// canonical.  Finally, there is a PointerType type for 'foo*' whose canonical
1147/// type is 'int*', and there is a TypedefType for 'bar', whose canonical type
1148/// is also 'int*'.
1149///
1150/// Non-canonical types are useful for emitting diagnostics, without losing
1151/// information about typedefs being used.  Canonical types are useful for type
1152/// comparisons (they allow by-pointer equality tests) and useful for reasoning
1153/// about whether something has a particular form (e.g. is a function type),
1154/// because they implicitly, recursively, strip all typedefs out of a type.
1155///
1156/// Types, once created, are immutable.
1157///
1158class Type : public ExtQualsTypeCommonBase {
1159public:
1160  enum TypeClass {
1161#define TYPE(Class, Base) Class,
1162#define LAST_TYPE(Class) TypeLast = Class,
1163#define ABSTRACT_TYPE(Class, Base)
1164#include "clang/AST/TypeNodes.def"
1165    TagFirst = Record, TagLast = Enum
1166  };
1167
1168private:
1169  Type(const Type &) LLVM_DELETED_FUNCTION;
1170  void operator=(const Type &) LLVM_DELETED_FUNCTION;
1171
1172  /// Bitfields required by the Type class.
1173  class TypeBitfields {
1174    friend class Type;
1175    template <class T> friend class TypePropertyCache;
1176
1177    /// TypeClass bitfield - Enum that specifies what subclass this belongs to.
1178    unsigned TC : 8;
1179
1180    /// Dependent - Whether this type is a dependent type (C++ [temp.dep.type]).
1181    unsigned Dependent : 1;
1182
1183    /// \brief Whether this type somehow involves a template parameter, even
1184    /// if the resolution of the type does not depend on a template parameter.
1185    unsigned InstantiationDependent : 1;
1186
1187    /// \brief Whether this type is a variably-modified type (C99 6.7.5).
1188    unsigned VariablyModified : 1;
1189
1190    /// \brief Whether this type contains an unexpanded parameter pack
1191    /// (for C++0x variadic templates).
1192    unsigned ContainsUnexpandedParameterPack : 1;
1193
1194    /// \brief Nonzero if the cache (i.e. the bitfields here starting
1195    /// with 'Cache') is valid.  If so, then this is a
1196    /// LangOptions::VisibilityMode+1.
1197    mutable unsigned CacheValidAndVisibility : 2;
1198
1199    /// \brief True if the visibility was set explicitly in the source code.
1200    mutable unsigned CachedExplicitVisibility : 1;
1201
1202    /// \brief Linkage of this type.
1203    mutable unsigned CachedLinkage : 2;
1204
1205    /// \brief Whether this type involves and local or unnamed types.
1206    mutable unsigned CachedLocalOrUnnamed : 1;
1207
1208    /// \brief FromAST - Whether this type comes from an AST file.
1209    mutable unsigned FromAST : 1;
1210
1211    bool isCacheValid() const {
1212      return (CacheValidAndVisibility != 0);
1213    }
1214    Visibility getVisibility() const {
1215      assert(isCacheValid() && "getting linkage from invalid cache");
1216      return static_cast<Visibility>(CacheValidAndVisibility-1);
1217    }
1218    bool isVisibilityExplicit() const {
1219      assert(isCacheValid() && "getting linkage from invalid cache");
1220      return CachedExplicitVisibility;
1221    }
1222    Linkage getLinkage() const {
1223      assert(isCacheValid() && "getting linkage from invalid cache");
1224      return static_cast<Linkage>(CachedLinkage);
1225    }
1226    bool hasLocalOrUnnamedType() const {
1227      assert(isCacheValid() && "getting linkage from invalid cache");
1228      return CachedLocalOrUnnamed;
1229    }
1230  };
1231  enum { NumTypeBits = 19 };
1232
1233protected:
1234  // These classes allow subclasses to somewhat cleanly pack bitfields
1235  // into Type.
1236
1237  class ArrayTypeBitfields {
1238    friend class ArrayType;
1239
1240    unsigned : NumTypeBits;
1241
1242    /// IndexTypeQuals - CVR qualifiers from declarations like
1243    /// 'int X[static restrict 4]'. For function parameters only.
1244    unsigned IndexTypeQuals : 3;
1245
1246    /// SizeModifier - storage class qualifiers from declarations like
1247    /// 'int X[static restrict 4]'. For function parameters only.
1248    /// Actually an ArrayType::ArraySizeModifier.
1249    unsigned SizeModifier : 3;
1250  };
1251
1252  class BuiltinTypeBitfields {
1253    friend class BuiltinType;
1254
1255    unsigned : NumTypeBits;
1256
1257    /// The kind (BuiltinType::Kind) of builtin type this is.
1258    unsigned Kind : 8;
1259  };
1260
1261  class FunctionTypeBitfields {
1262    friend class FunctionType;
1263
1264    unsigned : NumTypeBits;
1265
1266    /// Extra information which affects how the function is called, like
1267    /// regparm and the calling convention.
1268    unsigned ExtInfo : 9;
1269
1270    /// TypeQuals - Used only by FunctionProtoType, put here to pack with the
1271    /// other bitfields.
1272    /// The qualifiers are part of FunctionProtoType because...
1273    ///
1274    /// C++ 8.3.5p4: The return type, the parameter type list and the
1275    /// cv-qualifier-seq, [...], are part of the function type.
1276    unsigned TypeQuals : 3;
1277  };
1278
1279  class ObjCObjectTypeBitfields {
1280    friend class ObjCObjectType;
1281
1282    unsigned : NumTypeBits;
1283
1284    /// NumProtocols - The number of protocols stored directly on this
1285    /// object type.
1286    unsigned NumProtocols : 32 - NumTypeBits;
1287  };
1288
1289  class ReferenceTypeBitfields {
1290    friend class ReferenceType;
1291
1292    unsigned : NumTypeBits;
1293
1294    /// True if the type was originally spelled with an lvalue sigil.
1295    /// This is never true of rvalue references but can also be false
1296    /// on lvalue references because of C++0x [dcl.typedef]p9,
1297    /// as follows:
1298    ///
1299    ///   typedef int &ref;    // lvalue, spelled lvalue
1300    ///   typedef int &&rvref; // rvalue
1301    ///   ref &a;              // lvalue, inner ref, spelled lvalue
1302    ///   ref &&a;             // lvalue, inner ref
1303    ///   rvref &a;            // lvalue, inner ref, spelled lvalue
1304    ///   rvref &&a;           // rvalue, inner ref
1305    unsigned SpelledAsLValue : 1;
1306
1307    /// True if the inner type is a reference type.  This only happens
1308    /// in non-canonical forms.
1309    unsigned InnerRef : 1;
1310  };
1311
1312  class TypeWithKeywordBitfields {
1313    friend class TypeWithKeyword;
1314
1315    unsigned : NumTypeBits;
1316
1317    /// An ElaboratedTypeKeyword.  8 bits for efficient access.
1318    unsigned Keyword : 8;
1319  };
1320
1321  class VectorTypeBitfields {
1322    friend class VectorType;
1323
1324    unsigned : NumTypeBits;
1325
1326    /// VecKind - The kind of vector, either a generic vector type or some
1327    /// target-specific vector type such as for AltiVec or Neon.
1328    unsigned VecKind : 3;
1329
1330    /// NumElements - The number of elements in the vector.
1331    unsigned NumElements : 29 - NumTypeBits;
1332  };
1333
1334  class AttributedTypeBitfields {
1335    friend class AttributedType;
1336
1337    unsigned : NumTypeBits;
1338
1339    /// AttrKind - an AttributedType::Kind
1340    unsigned AttrKind : 32 - NumTypeBits;
1341  };
1342
1343  union {
1344    TypeBitfields TypeBits;
1345    ArrayTypeBitfields ArrayTypeBits;
1346    AttributedTypeBitfields AttributedTypeBits;
1347    BuiltinTypeBitfields BuiltinTypeBits;
1348    FunctionTypeBitfields FunctionTypeBits;
1349    ObjCObjectTypeBitfields ObjCObjectTypeBits;
1350    ReferenceTypeBitfields ReferenceTypeBits;
1351    TypeWithKeywordBitfields TypeWithKeywordBits;
1352    VectorTypeBitfields VectorTypeBits;
1353  };
1354
1355private:
1356  /// \brief Set whether this type comes from an AST file.
1357  void setFromAST(bool V = true) const {
1358    TypeBits.FromAST = V;
1359  }
1360
1361  template <class T> friend class TypePropertyCache;
1362
1363protected:
1364  // silence VC++ warning C4355: 'this' : used in base member initializer list
1365  Type *this_() { return this; }
1366  Type(TypeClass tc, QualType canon, bool Dependent,
1367       bool InstantiationDependent, bool VariablyModified,
1368       bool ContainsUnexpandedParameterPack)
1369    : ExtQualsTypeCommonBase(this,
1370                             canon.isNull() ? QualType(this_(), 0) : canon) {
1371    TypeBits.TC = tc;
1372    TypeBits.Dependent = Dependent;
1373    TypeBits.InstantiationDependent = Dependent || InstantiationDependent;
1374    TypeBits.VariablyModified = VariablyModified;
1375    TypeBits.ContainsUnexpandedParameterPack = ContainsUnexpandedParameterPack;
1376    TypeBits.CacheValidAndVisibility = 0;
1377    TypeBits.CachedExplicitVisibility = false;
1378    TypeBits.CachedLocalOrUnnamed = false;
1379    TypeBits.CachedLinkage = NoLinkage;
1380    TypeBits.FromAST = false;
1381  }
1382  friend class ASTContext;
1383
1384  void setDependent(bool D = true) {
1385    TypeBits.Dependent = D;
1386    if (D)
1387      TypeBits.InstantiationDependent = true;
1388  }
1389  void setInstantiationDependent(bool D = true) {
1390    TypeBits.InstantiationDependent = D; }
1391  void setVariablyModified(bool VM = true) { TypeBits.VariablyModified = VM;
1392  }
1393  void setContainsUnexpandedParameterPack(bool PP = true) {
1394    TypeBits.ContainsUnexpandedParameterPack = PP;
1395  }
1396
1397public:
1398  TypeClass getTypeClass() const { return static_cast<TypeClass>(TypeBits.TC); }
1399
1400  /// \brief Whether this type comes from an AST file.
1401  bool isFromAST() const { return TypeBits.FromAST; }
1402
1403  /// \brief Whether this type is or contains an unexpanded parameter
1404  /// pack, used to support C++0x variadic templates.
1405  ///
1406  /// A type that contains a parameter pack shall be expanded by the
1407  /// ellipsis operator at some point. For example, the typedef in the
1408  /// following example contains an unexpanded parameter pack 'T':
1409  ///
1410  /// \code
1411  /// template<typename ...T>
1412  /// struct X {
1413  ///   typedef T* pointer_types; // ill-formed; T is a parameter pack.
1414  /// };
1415  /// \endcode
1416  ///
1417  /// Note that this routine does not specify which
1418  bool containsUnexpandedParameterPack() const {
1419    return TypeBits.ContainsUnexpandedParameterPack;
1420  }
1421
1422  /// Determines if this type would be canonical if it had no further
1423  /// qualification.
1424  bool isCanonicalUnqualified() const {
1425    return CanonicalType == QualType(this, 0);
1426  }
1427
1428  /// Pull a single level of sugar off of this locally-unqualified type.
1429  /// Users should generally prefer SplitQualType::getSingleStepDesugaredType()
1430  /// or QualType::getSingleStepDesugaredType(const ASTContext&).
1431  QualType getLocallyUnqualifiedSingleStepDesugaredType() const;
1432
1433  /// Types are partitioned into 3 broad categories (C99 6.2.5p1):
1434  /// object types, function types, and incomplete types.
1435
1436  /// isIncompleteType - Return true if this is an incomplete type.
1437  /// A type that can describe objects, but which lacks information needed to
1438  /// determine its size (e.g. void, or a fwd declared struct). Clients of this
1439  /// routine will need to determine if the size is actually required.
1440  ///
1441  /// \brief Def If non-NULL, and the type refers to some kind of declaration
1442  /// that can be completed (such as a C struct, C++ class, or Objective-C
1443  /// class), will be set to the declaration.
1444  bool isIncompleteType(NamedDecl **Def = 0) const;
1445
1446  /// isIncompleteOrObjectType - Return true if this is an incomplete or object
1447  /// type, in other words, not a function type.
1448  bool isIncompleteOrObjectType() const {
1449    return !isFunctionType();
1450  }
1451
1452  /// \brief Determine whether this type is an object type.
1453  bool isObjectType() const {
1454    // C++ [basic.types]p8:
1455    //   An object type is a (possibly cv-qualified) type that is not a
1456    //   function type, not a reference type, and not a void type.
1457    return !isReferenceType() && !isFunctionType() && !isVoidType();
1458  }
1459
1460  /// isLiteralType - Return true if this is a literal type
1461  /// (C++0x [basic.types]p10)
1462  bool isLiteralType() const;
1463
1464  /// \brief Test if this type is a standard-layout type.
1465  /// (C++0x [basic.type]p9)
1466  bool isStandardLayoutType() const;
1467
1468  /// Helper methods to distinguish type categories. All type predicates
1469  /// operate on the canonical type, ignoring typedefs and qualifiers.
1470
1471  /// isBuiltinType - returns true if the type is a builtin type.
1472  bool isBuiltinType() const;
1473
1474  /// isSpecificBuiltinType - Test for a particular builtin type.
1475  bool isSpecificBuiltinType(unsigned K) const;
1476
1477  /// isPlaceholderType - Test for a type which does not represent an
1478  /// actual type-system type but is instead used as a placeholder for
1479  /// various convenient purposes within Clang.  All such types are
1480  /// BuiltinTypes.
1481  bool isPlaceholderType() const;
1482  const BuiltinType *getAsPlaceholderType() const;
1483
1484  /// isSpecificPlaceholderType - Test for a specific placeholder type.
1485  bool isSpecificPlaceholderType(unsigned K) const;
1486
1487  /// isNonOverloadPlaceholderType - Test for a placeholder type
1488  /// other than Overload;  see BuiltinType::isNonOverloadPlaceholderType.
1489  bool isNonOverloadPlaceholderType() const;
1490
1491  /// isIntegerType() does *not* include complex integers (a GCC extension).
1492  /// isComplexIntegerType() can be used to test for complex integers.
1493  bool isIntegerType() const;     // C99 6.2.5p17 (int, char, bool, enum)
1494  bool isEnumeralType() const;
1495  bool isBooleanType() const;
1496  bool isCharType() const;
1497  bool isWideCharType() const;
1498  bool isChar16Type() const;
1499  bool isChar32Type() const;
1500  bool isAnyCharacterType() const;
1501  bool isIntegralType(ASTContext &Ctx) const;
1502
1503  /// \brief Determine whether this type is an integral or enumeration type.
1504  bool isIntegralOrEnumerationType() const;
1505  /// \brief Determine whether this type is an integral or unscoped enumeration
1506  /// type.
1507  bool isIntegralOrUnscopedEnumerationType() const;
1508
1509  /// Floating point categories.
1510  bool isRealFloatingType() const; // C99 6.2.5p10 (float, double, long double)
1511  /// isComplexType() does *not* include complex integers (a GCC extension).
1512  /// isComplexIntegerType() can be used to test for complex integers.
1513  bool isComplexType() const;      // C99 6.2.5p11 (complex)
1514  bool isAnyComplexType() const;   // C99 6.2.5p11 (complex) + Complex Int.
1515  bool isFloatingType() const;     // C99 6.2.5p11 (real floating + complex)
1516  bool isHalfType() const;         // OpenCL 6.1.1.1, NEON (IEEE 754-2008 half)
1517  bool isRealType() const;         // C99 6.2.5p17 (real floating + integer)
1518  bool isArithmeticType() const;   // C99 6.2.5p18 (integer + floating)
1519  bool isVoidType() const;         // C99 6.2.5p19
1520  bool isDerivedType() const;      // C99 6.2.5p20
1521  bool isScalarType() const;       // C99 6.2.5p21 (arithmetic + pointers)
1522  bool isAggregateType() const;
1523  bool isFundamentalType() const;
1524  bool isCompoundType() const;
1525
1526  // Type Predicates: Check to see if this type is structurally the specified
1527  // type, ignoring typedefs and qualifiers.
1528  bool isFunctionType() const;
1529  bool isFunctionNoProtoType() const { return getAs<FunctionNoProtoType>(); }
1530  bool isFunctionProtoType() const { return getAs<FunctionProtoType>(); }
1531  bool isPointerType() const;
1532  bool isAnyPointerType() const;   // Any C pointer or ObjC object pointer
1533  bool isBlockPointerType() const;
1534  bool isVoidPointerType() const;
1535  bool isReferenceType() const;
1536  bool isLValueReferenceType() const;
1537  bool isRValueReferenceType() const;
1538  bool isFunctionPointerType() const;
1539  bool isMemberPointerType() const;
1540  bool isMemberFunctionPointerType() const;
1541  bool isMemberDataPointerType() const;
1542  bool isArrayType() const;
1543  bool isConstantArrayType() const;
1544  bool isIncompleteArrayType() const;
1545  bool isVariableArrayType() const;
1546  bool isDependentSizedArrayType() const;
1547  bool isRecordType() const;
1548  bool isClassType() const;
1549  bool isStructureType() const;
1550  bool isInterfaceType() const;
1551  bool isStructureOrClassType() const;
1552  bool isUnionType() const;
1553  bool isComplexIntegerType() const;            // GCC _Complex integer type.
1554  bool isVectorType() const;                    // GCC vector type.
1555  bool isExtVectorType() const;                 // Extended vector type.
1556  bool isObjCObjectPointerType() const;         // pointer to ObjC object
1557  bool isObjCRetainableType() const;            // ObjC object or block pointer
1558  bool isObjCLifetimeType() const;              // (array of)* retainable type
1559  bool isObjCIndirectLifetimeType() const;      // (pointer to)* lifetime type
1560  bool isObjCNSObjectType() const;              // __attribute__((NSObject))
1561  // FIXME: change this to 'raw' interface type, so we can used 'interface' type
1562  // for the common case.
1563  bool isObjCObjectType() const;                // NSString or typeof(*(id)0)
1564  bool isObjCQualifiedInterfaceType() const;    // NSString<foo>
1565  bool isObjCQualifiedIdType() const;           // id<foo>
1566  bool isObjCQualifiedClassType() const;        // Class<foo>
1567  bool isObjCObjectOrInterfaceType() const;
1568  bool isObjCIdType() const;                    // id
1569  bool isObjCClassType() const;                 // Class
1570  bool isObjCSelType() const;                 // Class
1571  bool isObjCBuiltinType() const;               // 'id' or 'Class'
1572  bool isObjCARCBridgableType() const;
1573  bool isCARCBridgableType() const;
1574  bool isTemplateTypeParmType() const;          // C++ template type parameter
1575  bool isNullPtrType() const;                   // C++0x nullptr_t
1576  bool isAtomicType() const;                    // C11 _Atomic()
1577
1578  bool isImage1dT() const;                      // OpenCL image1d_t
1579  bool isImage1dArrayT() const;                 // OpenCL image1d_array_t
1580  bool isImage1dBufferT() const;                // OpenCL image1d_buffer_t
1581  bool isImage2dT() const;                      // OpenCL image2d_t
1582  bool isImage2dArrayT() const;                 // OpenCL image2d_array_t
1583  bool isImage3dT() const;                      // OpenCL image3d_t
1584
1585  bool isImageType() const;                     // Any OpenCL image type
1586
1587  bool isSamplerT() const;                      // OpenCL sampler_t
1588  bool isEventT() const;                        // OpenCL event_t
1589
1590  bool isOpenCLSpecificType() const;            // Any OpenCL specific type
1591
1592  /// Determines if this type, which must satisfy
1593  /// isObjCLifetimeType(), is implicitly __unsafe_unretained rather
1594  /// than implicitly __strong.
1595  bool isObjCARCImplicitlyUnretainedType() const;
1596
1597  /// Return the implicit lifetime for this type, which must not be dependent.
1598  Qualifiers::ObjCLifetime getObjCARCImplicitLifetime() const;
1599
1600  enum ScalarTypeKind {
1601    STK_CPointer,
1602    STK_BlockPointer,
1603    STK_ObjCObjectPointer,
1604    STK_MemberPointer,
1605    STK_Bool,
1606    STK_Integral,
1607    STK_Floating,
1608    STK_IntegralComplex,
1609    STK_FloatingComplex
1610  };
1611  /// getScalarTypeKind - Given that this is a scalar type, classify it.
1612  ScalarTypeKind getScalarTypeKind() const;
1613
1614  /// isDependentType - Whether this type is a dependent type, meaning
1615  /// that its definition somehow depends on a template parameter
1616  /// (C++ [temp.dep.type]).
1617  bool isDependentType() const { return TypeBits.Dependent; }
1618
1619  /// \brief Determine whether this type is an instantiation-dependent type,
1620  /// meaning that the type involves a template parameter (even if the
1621  /// definition does not actually depend on the type substituted for that
1622  /// template parameter).
1623  bool isInstantiationDependentType() const {
1624    return TypeBits.InstantiationDependent;
1625  }
1626
1627  /// \brief Whether this type is a variably-modified type (C99 6.7.5).
1628  bool isVariablyModifiedType() const { return TypeBits.VariablyModified; }
1629
1630  /// \brief Whether this type involves a variable-length array type
1631  /// with a definite size.
1632  bool hasSizedVLAType() const;
1633
1634  /// \brief Whether this type is or contains a local or unnamed type.
1635  bool hasUnnamedOrLocalType() const;
1636
1637  bool isOverloadableType() const;
1638
1639  /// \brief Determine wither this type is a C++ elaborated-type-specifier.
1640  bool isElaboratedTypeSpecifier() const;
1641
1642  bool canDecayToPointerType() const;
1643
1644  /// hasPointerRepresentation - Whether this type is represented
1645  /// natively as a pointer; this includes pointers, references, block
1646  /// pointers, and Objective-C interface, qualified id, and qualified
1647  /// interface types, as well as nullptr_t.
1648  bool hasPointerRepresentation() const;
1649
1650  /// hasObjCPointerRepresentation - Whether this type can represent
1651  /// an objective pointer type for the purpose of GC'ability
1652  bool hasObjCPointerRepresentation() const;
1653
1654  /// \brief Determine whether this type has an integer representation
1655  /// of some sort, e.g., it is an integer type or a vector.
1656  bool hasIntegerRepresentation() const;
1657
1658  /// \brief Determine whether this type has an signed integer representation
1659  /// of some sort, e.g., it is an signed integer type or a vector.
1660  bool hasSignedIntegerRepresentation() const;
1661
1662  /// \brief Determine whether this type has an unsigned integer representation
1663  /// of some sort, e.g., it is an unsigned integer type or a vector.
1664  bool hasUnsignedIntegerRepresentation() const;
1665
1666  /// \brief Determine whether this type has a floating-point representation
1667  /// of some sort, e.g., it is a floating-point type or a vector thereof.
1668  bool hasFloatingRepresentation() const;
1669
1670  // Type Checking Functions: Check to see if this type is structurally the
1671  // specified type, ignoring typedefs and qualifiers, and return a pointer to
1672  // the best type we can.
1673  const RecordType *getAsStructureType() const;
1674  /// NOTE: getAs*ArrayType are methods on ASTContext.
1675  const RecordType *getAsUnionType() const;
1676  const ComplexType *getAsComplexIntegerType() const; // GCC complex int type.
1677  // The following is a convenience method that returns an ObjCObjectPointerType
1678  // for object declared using an interface.
1679  const ObjCObjectPointerType *getAsObjCInterfacePointerType() const;
1680  const ObjCObjectPointerType *getAsObjCQualifiedIdType() const;
1681  const ObjCObjectPointerType *getAsObjCQualifiedClassType() const;
1682  const ObjCObjectType *getAsObjCQualifiedInterfaceType() const;
1683
1684  /// \brief Retrieves the CXXRecordDecl that this type refers to, either
1685  /// because the type is a RecordType or because it is the injected-class-name
1686  /// type of a class template or class template partial specialization.
1687  CXXRecordDecl *getAsCXXRecordDecl() const;
1688
1689  /// If this is a pointer or reference to a RecordType, return the
1690  /// CXXRecordDecl that that type refers to.
1691  ///
1692  /// If this is not a pointer or reference, or the type being pointed to does
1693  /// not refer to a CXXRecordDecl, returns NULL.
1694  const CXXRecordDecl *getPointeeCXXRecordDecl() const;
1695
1696  /// \brief Get the AutoType whose type will be deduced for a variable with
1697  /// an initializer of this type. This looks through declarators like pointer
1698  /// types, but not through decltype or typedefs.
1699  AutoType *getContainedAutoType() const;
1700
1701  /// Member-template getAs<specific type>'.  Look through sugar for
1702  /// an instance of \<specific type>.   This scheme will eventually
1703  /// replace the specific getAsXXXX methods above.
1704  ///
1705  /// There are some specializations of this member template listed
1706  /// immediately following this class.
1707  template <typename T> const T *getAs() const;
1708
1709  /// A variant of getAs<> for array types which silently discards
1710  /// qualifiers from the outermost type.
1711  const ArrayType *getAsArrayTypeUnsafe() const;
1712
1713  /// Member-template castAs<specific type>.  Look through sugar for
1714  /// the underlying instance of \<specific type>.
1715  ///
1716  /// This method has the same relationship to getAs<T> as cast<T> has
1717  /// to dyn_cast<T>; which is to say, the underlying type *must*
1718  /// have the intended type, and this method will never return null.
1719  template <typename T> const T *castAs() const;
1720
1721  /// A variant of castAs<> for array type which silently discards
1722  /// qualifiers from the outermost type.
1723  const ArrayType *castAsArrayTypeUnsafe() const;
1724
1725  /// getBaseElementTypeUnsafe - Get the base element type of this
1726  /// type, potentially discarding type qualifiers.  This method
1727  /// should never be used when type qualifiers are meaningful.
1728  const Type *getBaseElementTypeUnsafe() const;
1729
1730  /// getArrayElementTypeNoTypeQual - If this is an array type, return the
1731  /// element type of the array, potentially with type qualifiers missing.
1732  /// This method should never be used when type qualifiers are meaningful.
1733  const Type *getArrayElementTypeNoTypeQual() const;
1734
1735  /// getPointeeType - If this is a pointer, ObjC object pointer, or block
1736  /// pointer, this returns the respective pointee.
1737  QualType getPointeeType() const;
1738
1739  /// getUnqualifiedDesugaredType() - Return the specified type with
1740  /// any "sugar" removed from the type, removing any typedefs,
1741  /// typeofs, etc., as well as any qualifiers.
1742  const Type *getUnqualifiedDesugaredType() const;
1743
1744  /// More type predicates useful for type checking/promotion
1745  bool isPromotableIntegerType() const; // C99 6.3.1.1p2
1746
1747  /// isSignedIntegerType - Return true if this is an integer type that is
1748  /// signed, according to C99 6.2.5p4 [char, signed char, short, int, long..],
1749  /// or an enum decl which has a signed representation.
1750  bool isSignedIntegerType() const;
1751
1752  /// isUnsignedIntegerType - Return true if this is an integer type that is
1753  /// unsigned, according to C99 6.2.5p6 [which returns true for _Bool],
1754  /// or an enum decl which has an unsigned representation.
1755  bool isUnsignedIntegerType() const;
1756
1757  /// Determines whether this is an integer type that is signed or an
1758  /// enumeration types whose underlying type is a signed integer type.
1759  bool isSignedIntegerOrEnumerationType() const;
1760
1761  /// Determines whether this is an integer type that is unsigned or an
1762  /// enumeration types whose underlying type is a unsigned integer type.
1763  bool isUnsignedIntegerOrEnumerationType() const;
1764
1765  /// isConstantSizeType - Return true if this is not a variable sized type,
1766  /// according to the rules of C99 6.7.5p3.  It is not legal to call this on
1767  /// incomplete types.
1768  bool isConstantSizeType() const;
1769
1770  /// isSpecifierType - Returns true if this type can be represented by some
1771  /// set of type specifiers.
1772  bool isSpecifierType() const;
1773
1774  /// \brief Determine the linkage of this type.
1775  Linkage getLinkage() const;
1776
1777  /// \brief Determine the visibility of this type.
1778  Visibility getVisibility() const;
1779
1780  /// \brief Return true if the visibility was explicitly set is the code.
1781  bool isVisibilityExplicit() const;
1782
1783  /// \brief Determine the linkage and visibility of this type.
1784  std::pair<Linkage,Visibility> getLinkageAndVisibility() const;
1785
1786  /// \brief Note that the linkage is no longer known.
1787  void ClearLinkageCache();
1788
1789  const char *getTypeClassName() const;
1790
1791  QualType getCanonicalTypeInternal() const {
1792    return CanonicalType;
1793  }
1794  CanQualType getCanonicalTypeUnqualified() const; // in CanonicalType.h
1795  LLVM_ATTRIBUTE_USED void dump() const;
1796
1797  friend class ASTReader;
1798  friend class ASTWriter;
1799};
1800
1801/// \brief This will check for a TypedefType by removing any existing sugar
1802/// until it reaches a TypedefType or a non-sugared type.
1803template <> const TypedefType *Type::getAs() const;
1804
1805/// \brief This will check for a TemplateSpecializationType by removing any
1806/// existing sugar until it reaches a TemplateSpecializationType or a
1807/// non-sugared type.
1808template <> const TemplateSpecializationType *Type::getAs() const;
1809
1810// We can do canonical leaf types faster, because we don't have to
1811// worry about preserving child type decoration.
1812#define TYPE(Class, Base)
1813#define LEAF_TYPE(Class) \
1814template <> inline const Class##Type *Type::getAs() const { \
1815  return dyn_cast<Class##Type>(CanonicalType); \
1816} \
1817template <> inline const Class##Type *Type::castAs() const { \
1818  return cast<Class##Type>(CanonicalType); \
1819}
1820#include "clang/AST/TypeNodes.def"
1821
1822
1823/// BuiltinType - This class is used for builtin types like 'int'.  Builtin
1824/// types are always canonical and have a literal name field.
1825class BuiltinType : public Type {
1826public:
1827  enum Kind {
1828#define BUILTIN_TYPE(Id, SingletonId) Id,
1829#define LAST_BUILTIN_TYPE(Id) LastKind = Id
1830#include "clang/AST/BuiltinTypes.def"
1831  };
1832
1833public:
1834  BuiltinType(Kind K)
1835    : Type(Builtin, QualType(), /*Dependent=*/(K == Dependent),
1836           /*InstantiationDependent=*/(K == Dependent),
1837           /*VariablyModified=*/false,
1838           /*Unexpanded paramter pack=*/false) {
1839    BuiltinTypeBits.Kind = K;
1840  }
1841
1842  Kind getKind() const { return static_cast<Kind>(BuiltinTypeBits.Kind); }
1843  StringRef getName(const PrintingPolicy &Policy) const;
1844  const char *getNameAsCString(const PrintingPolicy &Policy) const {
1845    // The StringRef is null-terminated.
1846    StringRef str = getName(Policy);
1847    assert(!str.empty() && str.data()[str.size()] == '\0');
1848    return str.data();
1849  }
1850
1851  bool isSugared() const { return false; }
1852  QualType desugar() const { return QualType(this, 0); }
1853
1854  bool isInteger() const {
1855    return getKind() >= Bool && getKind() <= Int128;
1856  }
1857
1858  bool isSignedInteger() const {
1859    return getKind() >= Char_S && getKind() <= Int128;
1860  }
1861
1862  bool isUnsignedInteger() const {
1863    return getKind() >= Bool && getKind() <= UInt128;
1864  }
1865
1866  bool isFloatingPoint() const {
1867    return getKind() >= Half && getKind() <= LongDouble;
1868  }
1869
1870  /// Determines whether the given kind corresponds to a placeholder type.
1871  static bool isPlaceholderTypeKind(Kind K) {
1872    return K >= Overload;
1873  }
1874
1875  /// Determines whether this type is a placeholder type, i.e. a type
1876  /// which cannot appear in arbitrary positions in a fully-formed
1877  /// expression.
1878  bool isPlaceholderType() const {
1879    return isPlaceholderTypeKind(getKind());
1880  }
1881
1882  /// Determines whether this type is a placeholder type other than
1883  /// Overload.  Most placeholder types require only syntactic
1884  /// information about their context in order to be resolved (e.g.
1885  /// whether it is a call expression), which means they can (and
1886  /// should) be resolved in an earlier "phase" of analysis.
1887  /// Overload expressions sometimes pick up further information
1888  /// from their context, like whether the context expects a
1889  /// specific function-pointer type, and so frequently need
1890  /// special treatment.
1891  bool isNonOverloadPlaceholderType() const {
1892    return getKind() > Overload;
1893  }
1894
1895  static bool classof(const Type *T) { return T->getTypeClass() == Builtin; }
1896};
1897
1898/// ComplexType - C99 6.2.5p11 - Complex values.  This supports the C99 complex
1899/// types (_Complex float etc) as well as the GCC integer complex extensions.
1900///
1901class ComplexType : public Type, public llvm::FoldingSetNode {
1902  QualType ElementType;
1903  ComplexType(QualType Element, QualType CanonicalPtr) :
1904    Type(Complex, CanonicalPtr, Element->isDependentType(),
1905         Element->isInstantiationDependentType(),
1906         Element->isVariablyModifiedType(),
1907         Element->containsUnexpandedParameterPack()),
1908    ElementType(Element) {
1909  }
1910  friend class ASTContext;  // ASTContext creates these.
1911
1912public:
1913  QualType getElementType() const { return ElementType; }
1914
1915  bool isSugared() const { return false; }
1916  QualType desugar() const { return QualType(this, 0); }
1917
1918  void Profile(llvm::FoldingSetNodeID &ID) {
1919    Profile(ID, getElementType());
1920  }
1921  static void Profile(llvm::FoldingSetNodeID &ID, QualType Element) {
1922    ID.AddPointer(Element.getAsOpaquePtr());
1923  }
1924
1925  static bool classof(const Type *T) { return T->getTypeClass() == Complex; }
1926};
1927
1928/// ParenType - Sugar for parentheses used when specifying types.
1929///
1930class ParenType : public Type, public llvm::FoldingSetNode {
1931  QualType Inner;
1932
1933  ParenType(QualType InnerType, QualType CanonType) :
1934    Type(Paren, CanonType, InnerType->isDependentType(),
1935         InnerType->isInstantiationDependentType(),
1936         InnerType->isVariablyModifiedType(),
1937         InnerType->containsUnexpandedParameterPack()),
1938    Inner(InnerType) {
1939  }
1940  friend class ASTContext;  // ASTContext creates these.
1941
1942public:
1943
1944  QualType getInnerType() const { return Inner; }
1945
1946  bool isSugared() const { return true; }
1947  QualType desugar() const { return getInnerType(); }
1948
1949  void Profile(llvm::FoldingSetNodeID &ID) {
1950    Profile(ID, getInnerType());
1951  }
1952  static void Profile(llvm::FoldingSetNodeID &ID, QualType Inner) {
1953    Inner.Profile(ID);
1954  }
1955
1956  static bool classof(const Type *T) { return T->getTypeClass() == Paren; }
1957};
1958
1959/// PointerType - C99 6.7.5.1 - Pointer Declarators.
1960///
1961class PointerType : public Type, public llvm::FoldingSetNode {
1962  QualType PointeeType;
1963
1964  PointerType(QualType Pointee, QualType CanonicalPtr) :
1965    Type(Pointer, CanonicalPtr, Pointee->isDependentType(),
1966         Pointee->isInstantiationDependentType(),
1967         Pointee->isVariablyModifiedType(),
1968         Pointee->containsUnexpandedParameterPack()),
1969    PointeeType(Pointee) {
1970  }
1971  friend class ASTContext;  // ASTContext creates these.
1972
1973public:
1974
1975  QualType getPointeeType() const { return PointeeType; }
1976
1977  bool isSugared() const { return false; }
1978  QualType desugar() const { return QualType(this, 0); }
1979
1980  void Profile(llvm::FoldingSetNodeID &ID) {
1981    Profile(ID, getPointeeType());
1982  }
1983  static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee) {
1984    ID.AddPointer(Pointee.getAsOpaquePtr());
1985  }
1986
1987  static bool classof(const Type *T) { return T->getTypeClass() == Pointer; }
1988};
1989
1990/// BlockPointerType - pointer to a block type.
1991/// This type is to represent types syntactically represented as
1992/// "void (^)(int)", etc. Pointee is required to always be a function type.
1993///
1994class BlockPointerType : public Type, public llvm::FoldingSetNode {
1995  QualType PointeeType;  // Block is some kind of pointer type
1996  BlockPointerType(QualType Pointee, QualType CanonicalCls) :
1997    Type(BlockPointer, CanonicalCls, Pointee->isDependentType(),
1998         Pointee->isInstantiationDependentType(),
1999         Pointee->isVariablyModifiedType(),
2000         Pointee->containsUnexpandedParameterPack()),
2001    PointeeType(Pointee) {
2002  }
2003  friend class ASTContext;  // ASTContext creates these.
2004
2005public:
2006
2007  // Get the pointee type. Pointee is required to always be a function type.
2008  QualType getPointeeType() const { return PointeeType; }
2009
2010  bool isSugared() const { return false; }
2011  QualType desugar() const { return QualType(this, 0); }
2012
2013  void Profile(llvm::FoldingSetNodeID &ID) {
2014      Profile(ID, getPointeeType());
2015  }
2016  static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee) {
2017      ID.AddPointer(Pointee.getAsOpaquePtr());
2018  }
2019
2020  static bool classof(const Type *T) {
2021    return T->getTypeClass() == BlockPointer;
2022  }
2023};
2024
2025/// ReferenceType - Base for LValueReferenceType and RValueReferenceType
2026///
2027class ReferenceType : public Type, public llvm::FoldingSetNode {
2028  QualType PointeeType;
2029
2030protected:
2031  ReferenceType(TypeClass tc, QualType Referencee, QualType CanonicalRef,
2032                bool SpelledAsLValue) :
2033    Type(tc, CanonicalRef, Referencee->isDependentType(),
2034         Referencee->isInstantiationDependentType(),
2035         Referencee->isVariablyModifiedType(),
2036         Referencee->containsUnexpandedParameterPack()),
2037    PointeeType(Referencee)
2038  {
2039    ReferenceTypeBits.SpelledAsLValue = SpelledAsLValue;
2040    ReferenceTypeBits.InnerRef = Referencee->isReferenceType();
2041  }
2042
2043public:
2044  bool isSpelledAsLValue() const { return ReferenceTypeBits.SpelledAsLValue; }
2045  bool isInnerRef() const { return ReferenceTypeBits.InnerRef; }
2046
2047  QualType getPointeeTypeAsWritten() const { return PointeeType; }
2048  QualType getPointeeType() const {
2049    // FIXME: this might strip inner qualifiers; okay?
2050    const ReferenceType *T = this;
2051    while (T->isInnerRef())
2052      T = T->PointeeType->castAs<ReferenceType>();
2053    return T->PointeeType;
2054  }
2055
2056  void Profile(llvm::FoldingSetNodeID &ID) {
2057    Profile(ID, PointeeType, isSpelledAsLValue());
2058  }
2059  static void Profile(llvm::FoldingSetNodeID &ID,
2060                      QualType Referencee,
2061                      bool SpelledAsLValue) {
2062    ID.AddPointer(Referencee.getAsOpaquePtr());
2063    ID.AddBoolean(SpelledAsLValue);
2064  }
2065
2066  static bool classof(const Type *T) {
2067    return T->getTypeClass() == LValueReference ||
2068           T->getTypeClass() == RValueReference;
2069  }
2070};
2071
2072/// LValueReferenceType - C++ [dcl.ref] - Lvalue reference
2073///
2074class LValueReferenceType : public ReferenceType {
2075  LValueReferenceType(QualType Referencee, QualType CanonicalRef,
2076                      bool SpelledAsLValue) :
2077    ReferenceType(LValueReference, Referencee, CanonicalRef, SpelledAsLValue)
2078  {}
2079  friend class ASTContext; // ASTContext creates these
2080public:
2081  bool isSugared() const { return false; }
2082  QualType desugar() const { return QualType(this, 0); }
2083
2084  static bool classof(const Type *T) {
2085    return T->getTypeClass() == LValueReference;
2086  }
2087};
2088
2089/// RValueReferenceType - C++0x [dcl.ref] - Rvalue reference
2090///
2091class RValueReferenceType : public ReferenceType {
2092  RValueReferenceType(QualType Referencee, QualType CanonicalRef) :
2093    ReferenceType(RValueReference, Referencee, CanonicalRef, false) {
2094  }
2095  friend class ASTContext; // ASTContext creates these
2096public:
2097  bool isSugared() const { return false; }
2098  QualType desugar() const { return QualType(this, 0); }
2099
2100  static bool classof(const Type *T) {
2101    return T->getTypeClass() == RValueReference;
2102  }
2103};
2104
2105/// MemberPointerType - C++ 8.3.3 - Pointers to members
2106///
2107class MemberPointerType : public Type, public llvm::FoldingSetNode {
2108  QualType PointeeType;
2109  /// The class of which the pointee is a member. Must ultimately be a
2110  /// RecordType, but could be a typedef or a template parameter too.
2111  const Type *Class;
2112
2113  MemberPointerType(QualType Pointee, const Type *Cls, QualType CanonicalPtr) :
2114    Type(MemberPointer, CanonicalPtr,
2115         Cls->isDependentType() || Pointee->isDependentType(),
2116         (Cls->isInstantiationDependentType() ||
2117          Pointee->isInstantiationDependentType()),
2118         Pointee->isVariablyModifiedType(),
2119         (Cls->containsUnexpandedParameterPack() ||
2120          Pointee->containsUnexpandedParameterPack())),
2121    PointeeType(Pointee), Class(Cls) {
2122  }
2123  friend class ASTContext; // ASTContext creates these.
2124
2125public:
2126  QualType getPointeeType() const { return PointeeType; }
2127
2128  /// Returns true if the member type (i.e. the pointee type) is a
2129  /// function type rather than a data-member type.
2130  bool isMemberFunctionPointer() const {
2131    return PointeeType->isFunctionProtoType();
2132  }
2133
2134  /// Returns true if the member type (i.e. the pointee type) is a
2135  /// data type rather than a function type.
2136  bool isMemberDataPointer() const {
2137    return !PointeeType->isFunctionProtoType();
2138  }
2139
2140  const Type *getClass() const { return Class; }
2141
2142  bool isSugared() const { return false; }
2143  QualType desugar() const { return QualType(this, 0); }
2144
2145  void Profile(llvm::FoldingSetNodeID &ID) {
2146    Profile(ID, getPointeeType(), getClass());
2147  }
2148  static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee,
2149                      const Type *Class) {
2150    ID.AddPointer(Pointee.getAsOpaquePtr());
2151    ID.AddPointer(Class);
2152  }
2153
2154  static bool classof(const Type *T) {
2155    return T->getTypeClass() == MemberPointer;
2156  }
2157};
2158
2159/// ArrayType - C99 6.7.5.2 - Array Declarators.
2160///
2161class ArrayType : public Type, public llvm::FoldingSetNode {
2162public:
2163  /// ArraySizeModifier - Capture whether this is a normal array (e.g. int X[4])
2164  /// an array with a static size (e.g. int X[static 4]), or an array
2165  /// with a star size (e.g. int X[*]).
2166  /// 'static' is only allowed on function parameters.
2167  enum ArraySizeModifier {
2168    Normal, Static, Star
2169  };
2170private:
2171  /// ElementType - The element type of the array.
2172  QualType ElementType;
2173
2174protected:
2175  // C++ [temp.dep.type]p1:
2176  //   A type is dependent if it is...
2177  //     - an array type constructed from any dependent type or whose
2178  //       size is specified by a constant expression that is
2179  //       value-dependent,
2180  ArrayType(TypeClass tc, QualType et, QualType can,
2181            ArraySizeModifier sm, unsigned tq,
2182            bool ContainsUnexpandedParameterPack)
2183    : Type(tc, can, et->isDependentType() || tc == DependentSizedArray,
2184           et->isInstantiationDependentType() || tc == DependentSizedArray,
2185           (tc == VariableArray || et->isVariablyModifiedType()),
2186           ContainsUnexpandedParameterPack),
2187      ElementType(et) {
2188    ArrayTypeBits.IndexTypeQuals = tq;
2189    ArrayTypeBits.SizeModifier = sm;
2190  }
2191
2192  friend class ASTContext;  // ASTContext creates these.
2193
2194public:
2195  QualType getElementType() const { return ElementType; }
2196  ArraySizeModifier getSizeModifier() const {
2197    return ArraySizeModifier(ArrayTypeBits.SizeModifier);
2198  }
2199  Qualifiers getIndexTypeQualifiers() const {
2200    return Qualifiers::fromCVRMask(getIndexTypeCVRQualifiers());
2201  }
2202  unsigned getIndexTypeCVRQualifiers() const {
2203    return ArrayTypeBits.IndexTypeQuals;
2204  }
2205
2206  static bool classof(const Type *T) {
2207    return T->getTypeClass() == ConstantArray ||
2208           T->getTypeClass() == VariableArray ||
2209           T->getTypeClass() == IncompleteArray ||
2210           T->getTypeClass() == DependentSizedArray;
2211  }
2212};
2213
2214/// ConstantArrayType - This class represents the canonical version of
2215/// C arrays with a specified constant size.  For example, the canonical
2216/// type for 'int A[4 + 4*100]' is a ConstantArrayType where the element
2217/// type is 'int' and the size is 404.
2218class ConstantArrayType : public ArrayType {
2219  llvm::APInt Size; // Allows us to unique the type.
2220
2221  ConstantArrayType(QualType et, QualType can, const llvm::APInt &size,
2222                    ArraySizeModifier sm, unsigned tq)
2223    : ArrayType(ConstantArray, et, can, sm, tq,
2224                et->containsUnexpandedParameterPack()),
2225      Size(size) {}
2226protected:
2227  ConstantArrayType(TypeClass tc, QualType et, QualType can,
2228                    const llvm::APInt &size, ArraySizeModifier sm, unsigned tq)
2229    : ArrayType(tc, et, can, sm, tq, et->containsUnexpandedParameterPack()),
2230      Size(size) {}
2231  friend class ASTContext;  // ASTContext creates these.
2232public:
2233  const llvm::APInt &getSize() const { return Size; }
2234  bool isSugared() const { return false; }
2235  QualType desugar() const { return QualType(this, 0); }
2236
2237
2238  /// \brief Determine the number of bits required to address a member of
2239  // an array with the given element type and number of elements.
2240  static unsigned getNumAddressingBits(ASTContext &Context,
2241                                       QualType ElementType,
2242                                       const llvm::APInt &NumElements);
2243
2244  /// \brief Determine the maximum number of active bits that an array's size
2245  /// can require, which limits the maximum size of the array.
2246  static unsigned getMaxSizeBits(ASTContext &Context);
2247
2248  void Profile(llvm::FoldingSetNodeID &ID) {
2249    Profile(ID, getElementType(), getSize(),
2250            getSizeModifier(), getIndexTypeCVRQualifiers());
2251  }
2252  static void Profile(llvm::FoldingSetNodeID &ID, QualType ET,
2253                      const llvm::APInt &ArraySize, ArraySizeModifier SizeMod,
2254                      unsigned TypeQuals) {
2255    ID.AddPointer(ET.getAsOpaquePtr());
2256    ID.AddInteger(ArraySize.getZExtValue());
2257    ID.AddInteger(SizeMod);
2258    ID.AddInteger(TypeQuals);
2259  }
2260  static bool classof(const Type *T) {
2261    return T->getTypeClass() == ConstantArray;
2262  }
2263};
2264
2265/// IncompleteArrayType - This class represents C arrays with an unspecified
2266/// size.  For example 'int A[]' has an IncompleteArrayType where the element
2267/// type is 'int' and the size is unspecified.
2268class IncompleteArrayType : public ArrayType {
2269
2270  IncompleteArrayType(QualType et, QualType can,
2271                      ArraySizeModifier sm, unsigned tq)
2272    : ArrayType(IncompleteArray, et, can, sm, tq,
2273                et->containsUnexpandedParameterPack()) {}
2274  friend class ASTContext;  // ASTContext creates these.
2275public:
2276  bool isSugared() const { return false; }
2277  QualType desugar() const { return QualType(this, 0); }
2278
2279  static bool classof(const Type *T) {
2280    return T->getTypeClass() == IncompleteArray;
2281  }
2282
2283  friend class StmtIteratorBase;
2284
2285  void Profile(llvm::FoldingSetNodeID &ID) {
2286    Profile(ID, getElementType(), getSizeModifier(),
2287            getIndexTypeCVRQualifiers());
2288  }
2289
2290  static void Profile(llvm::FoldingSetNodeID &ID, QualType ET,
2291                      ArraySizeModifier SizeMod, unsigned TypeQuals) {
2292    ID.AddPointer(ET.getAsOpaquePtr());
2293    ID.AddInteger(SizeMod);
2294    ID.AddInteger(TypeQuals);
2295  }
2296};
2297
2298/// VariableArrayType - This class represents C arrays with a specified size
2299/// which is not an integer-constant-expression.  For example, 'int s[x+foo()]'.
2300/// Since the size expression is an arbitrary expression, we store it as such.
2301///
2302/// Note: VariableArrayType's aren't uniqued (since the expressions aren't) and
2303/// should not be: two lexically equivalent variable array types could mean
2304/// different things, for example, these variables do not have the same type
2305/// dynamically:
2306///
2307/// void foo(int x) {
2308///   int Y[x];
2309///   ++x;
2310///   int Z[x];
2311/// }
2312///
2313class VariableArrayType : public ArrayType {
2314  /// SizeExpr - An assignment expression. VLA's are only permitted within
2315  /// a function block.
2316  Stmt *SizeExpr;
2317  /// Brackets - The left and right array brackets.
2318  SourceRange Brackets;
2319
2320  VariableArrayType(QualType et, QualType can, Expr *e,
2321                    ArraySizeModifier sm, unsigned tq,
2322                    SourceRange brackets)
2323    : ArrayType(VariableArray, et, can, sm, tq,
2324                et->containsUnexpandedParameterPack()),
2325      SizeExpr((Stmt*) e), Brackets(brackets) {}
2326  friend class ASTContext;  // ASTContext creates these.
2327
2328public:
2329  Expr *getSizeExpr() const {
2330    // We use C-style casts instead of cast<> here because we do not wish
2331    // to have a dependency of Type.h on Stmt.h/Expr.h.
2332    return (Expr*) SizeExpr;
2333  }
2334  SourceRange getBracketsRange() const { return Brackets; }
2335  SourceLocation getLBracketLoc() const { return Brackets.getBegin(); }
2336  SourceLocation getRBracketLoc() const { return Brackets.getEnd(); }
2337
2338  bool isSugared() const { return false; }
2339  QualType desugar() const { return QualType(this, 0); }
2340
2341  static bool classof(const Type *T) {
2342    return T->getTypeClass() == VariableArray;
2343  }
2344
2345  friend class StmtIteratorBase;
2346
2347  void Profile(llvm::FoldingSetNodeID &ID) {
2348    llvm_unreachable("Cannot unique VariableArrayTypes.");
2349  }
2350};
2351
2352/// DependentSizedArrayType - This type represents an array type in
2353/// C++ whose size is a value-dependent expression. For example:
2354///
2355/// \code
2356/// template<typename T, int Size>
2357/// class array {
2358///   T data[Size];
2359/// };
2360/// \endcode
2361///
2362/// For these types, we won't actually know what the array bound is
2363/// until template instantiation occurs, at which point this will
2364/// become either a ConstantArrayType or a VariableArrayType.
2365class DependentSizedArrayType : public ArrayType {
2366  const ASTContext &Context;
2367
2368  /// \brief An assignment expression that will instantiate to the
2369  /// size of the array.
2370  ///
2371  /// The expression itself might be NULL, in which case the array
2372  /// type will have its size deduced from an initializer.
2373  Stmt *SizeExpr;
2374
2375  /// Brackets - The left and right array brackets.
2376  SourceRange Brackets;
2377
2378  DependentSizedArrayType(const ASTContext &Context, QualType et, QualType can,
2379                          Expr *e, ArraySizeModifier sm, unsigned tq,
2380                          SourceRange brackets);
2381
2382  friend class ASTContext;  // ASTContext creates these.
2383
2384public:
2385  Expr *getSizeExpr() const {
2386    // We use C-style casts instead of cast<> here because we do not wish
2387    // to have a dependency of Type.h on Stmt.h/Expr.h.
2388    return (Expr*) SizeExpr;
2389  }
2390  SourceRange getBracketsRange() const { return Brackets; }
2391  SourceLocation getLBracketLoc() const { return Brackets.getBegin(); }
2392  SourceLocation getRBracketLoc() const { return Brackets.getEnd(); }
2393
2394  bool isSugared() const { return false; }
2395  QualType desugar() const { return QualType(this, 0); }
2396
2397  static bool classof(const Type *T) {
2398    return T->getTypeClass() == DependentSizedArray;
2399  }
2400
2401  friend class StmtIteratorBase;
2402
2403
2404  void Profile(llvm::FoldingSetNodeID &ID) {
2405    Profile(ID, Context, getElementType(),
2406            getSizeModifier(), getIndexTypeCVRQualifiers(), getSizeExpr());
2407  }
2408
2409  static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
2410                      QualType ET, ArraySizeModifier SizeMod,
2411                      unsigned TypeQuals, Expr *E);
2412};
2413
2414/// DependentSizedExtVectorType - This type represent an extended vector type
2415/// where either the type or size is dependent. For example:
2416/// @code
2417/// template<typename T, int Size>
2418/// class vector {
2419///   typedef T __attribute__((ext_vector_type(Size))) type;
2420/// }
2421/// @endcode
2422class DependentSizedExtVectorType : public Type, public llvm::FoldingSetNode {
2423  const ASTContext &Context;
2424  Expr *SizeExpr;
2425  /// ElementType - The element type of the array.
2426  QualType ElementType;
2427  SourceLocation loc;
2428
2429  DependentSizedExtVectorType(const ASTContext &Context, QualType ElementType,
2430                              QualType can, Expr *SizeExpr, SourceLocation loc);
2431
2432  friend class ASTContext;
2433
2434public:
2435  Expr *getSizeExpr() const { return SizeExpr; }
2436  QualType getElementType() const { return ElementType; }
2437  SourceLocation getAttributeLoc() const { return loc; }
2438
2439  bool isSugared() const { return false; }
2440  QualType desugar() const { return QualType(this, 0); }
2441
2442  static bool classof(const Type *T) {
2443    return T->getTypeClass() == DependentSizedExtVector;
2444  }
2445
2446  void Profile(llvm::FoldingSetNodeID &ID) {
2447    Profile(ID, Context, getElementType(), getSizeExpr());
2448  }
2449
2450  static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
2451                      QualType ElementType, Expr *SizeExpr);
2452};
2453
2454
2455/// VectorType - GCC generic vector type. This type is created using
2456/// __attribute__((vector_size(n)), where "n" specifies the vector size in
2457/// bytes; or from an Altivec __vector or vector declaration.
2458/// Since the constructor takes the number of vector elements, the
2459/// client is responsible for converting the size into the number of elements.
2460class VectorType : public Type, public llvm::FoldingSetNode {
2461public:
2462  enum VectorKind {
2463    GenericVector,  // not a target-specific vector type
2464    AltiVecVector,  // is AltiVec vector
2465    AltiVecPixel,   // is AltiVec 'vector Pixel'
2466    AltiVecBool,    // is AltiVec 'vector bool ...'
2467    NeonVector,     // is ARM Neon vector
2468    NeonPolyVector  // is ARM Neon polynomial vector
2469  };
2470protected:
2471  /// ElementType - The element type of the vector.
2472  QualType ElementType;
2473
2474  VectorType(QualType vecType, unsigned nElements, QualType canonType,
2475             VectorKind vecKind);
2476
2477  VectorType(TypeClass tc, QualType vecType, unsigned nElements,
2478             QualType canonType, VectorKind vecKind);
2479
2480  friend class ASTContext;  // ASTContext creates these.
2481
2482public:
2483
2484  QualType getElementType() const { return ElementType; }
2485  unsigned getNumElements() const { return VectorTypeBits.NumElements; }
2486
2487  bool isSugared() const { return false; }
2488  QualType desugar() const { return QualType(this, 0); }
2489
2490  VectorKind getVectorKind() const {
2491    return VectorKind(VectorTypeBits.VecKind);
2492  }
2493
2494  void Profile(llvm::FoldingSetNodeID &ID) {
2495    Profile(ID, getElementType(), getNumElements(),
2496            getTypeClass(), getVectorKind());
2497  }
2498  static void Profile(llvm::FoldingSetNodeID &ID, QualType ElementType,
2499                      unsigned NumElements, TypeClass TypeClass,
2500                      VectorKind VecKind) {
2501    ID.AddPointer(ElementType.getAsOpaquePtr());
2502    ID.AddInteger(NumElements);
2503    ID.AddInteger(TypeClass);
2504    ID.AddInteger(VecKind);
2505  }
2506
2507  static bool classof(const Type *T) {
2508    return T->getTypeClass() == Vector || T->getTypeClass() == ExtVector;
2509  }
2510};
2511
2512/// ExtVectorType - Extended vector type. This type is created using
2513/// __attribute__((ext_vector_type(n)), where "n" is the number of elements.
2514/// Unlike vector_size, ext_vector_type is only allowed on typedef's. This
2515/// class enables syntactic extensions, like Vector Components for accessing
2516/// points, colors, and textures (modeled after OpenGL Shading Language).
2517class ExtVectorType : public VectorType {
2518  ExtVectorType(QualType vecType, unsigned nElements, QualType canonType) :
2519    VectorType(ExtVector, vecType, nElements, canonType, GenericVector) {}
2520  friend class ASTContext;  // ASTContext creates these.
2521public:
2522  static int getPointAccessorIdx(char c) {
2523    switch (c) {
2524    default: return -1;
2525    case 'x': return 0;
2526    case 'y': return 1;
2527    case 'z': return 2;
2528    case 'w': return 3;
2529    }
2530  }
2531  static int getNumericAccessorIdx(char c) {
2532    switch (c) {
2533      default: return -1;
2534      case '0': return 0;
2535      case '1': return 1;
2536      case '2': return 2;
2537      case '3': return 3;
2538      case '4': return 4;
2539      case '5': return 5;
2540      case '6': return 6;
2541      case '7': return 7;
2542      case '8': return 8;
2543      case '9': return 9;
2544      case 'A':
2545      case 'a': return 10;
2546      case 'B':
2547      case 'b': return 11;
2548      case 'C':
2549      case 'c': return 12;
2550      case 'D':
2551      case 'd': return 13;
2552      case 'E':
2553      case 'e': return 14;
2554      case 'F':
2555      case 'f': return 15;
2556    }
2557  }
2558
2559  static int getAccessorIdx(char c) {
2560    if (int idx = getPointAccessorIdx(c)+1) return idx-1;
2561    return getNumericAccessorIdx(c);
2562  }
2563
2564  bool isAccessorWithinNumElements(char c) const {
2565    if (int idx = getAccessorIdx(c)+1)
2566      return unsigned(idx-1) < getNumElements();
2567    return false;
2568  }
2569  bool isSugared() const { return false; }
2570  QualType desugar() const { return QualType(this, 0); }
2571
2572  static bool classof(const Type *T) {
2573    return T->getTypeClass() == ExtVector;
2574  }
2575};
2576
2577/// FunctionType - C99 6.7.5.3 - Function Declarators.  This is the common base
2578/// class of FunctionNoProtoType and FunctionProtoType.
2579///
2580class FunctionType : public Type {
2581  // The type returned by the function.
2582  QualType ResultType;
2583
2584 public:
2585  /// ExtInfo - A class which abstracts out some details necessary for
2586  /// making a call.
2587  ///
2588  /// It is not actually used directly for storing this information in
2589  /// a FunctionType, although FunctionType does currently use the
2590  /// same bit-pattern.
2591  ///
2592  // If you add a field (say Foo), other than the obvious places (both,
2593  // constructors, compile failures), what you need to update is
2594  // * Operator==
2595  // * getFoo
2596  // * withFoo
2597  // * functionType. Add Foo, getFoo.
2598  // * ASTContext::getFooType
2599  // * ASTContext::mergeFunctionTypes
2600  // * FunctionNoProtoType::Profile
2601  // * FunctionProtoType::Profile
2602  // * TypePrinter::PrintFunctionProto
2603  // * AST read and write
2604  // * Codegen
2605  class ExtInfo {
2606    // Feel free to rearrange or add bits, but if you go over 9,
2607    // you'll need to adjust both the Bits field below and
2608    // Type::FunctionTypeBitfields.
2609
2610    //   |  CC  |noreturn|produces|regparm|
2611    //   |0 .. 3|   4    |    5   | 6 .. 8|
2612    //
2613    // regparm is either 0 (no regparm attribute) or the regparm value+1.
2614    enum { CallConvMask = 0xF };
2615    enum { NoReturnMask = 0x10 };
2616    enum { ProducesResultMask = 0x20 };
2617    enum { RegParmMask = ~(CallConvMask | NoReturnMask | ProducesResultMask),
2618           RegParmOffset = 6 }; // Assumed to be the last field
2619
2620    uint16_t Bits;
2621
2622    ExtInfo(unsigned Bits) : Bits(static_cast<uint16_t>(Bits)) {}
2623
2624    friend class FunctionType;
2625
2626   public:
2627    // Constructor with no defaults. Use this when you know that you
2628    // have all the elements (when reading an AST file for example).
2629    ExtInfo(bool noReturn, bool hasRegParm, unsigned regParm, CallingConv cc,
2630            bool producesResult) {
2631      assert((!hasRegParm || regParm < 7) && "Invalid regparm value");
2632      Bits = ((unsigned) cc) |
2633             (noReturn ? NoReturnMask : 0) |
2634             (producesResult ? ProducesResultMask : 0) |
2635             (hasRegParm ? ((regParm + 1) << RegParmOffset) : 0);
2636    }
2637
2638    // Constructor with all defaults. Use when for example creating a
2639    // function know to use defaults.
2640    ExtInfo() : Bits(0) {}
2641
2642    bool getNoReturn() const { return Bits & NoReturnMask; }
2643    bool getProducesResult() const { return Bits & ProducesResultMask; }
2644    bool getHasRegParm() const { return (Bits >> RegParmOffset) != 0; }
2645    unsigned getRegParm() const {
2646      unsigned RegParm = Bits >> RegParmOffset;
2647      if (RegParm > 0)
2648        --RegParm;
2649      return RegParm;
2650    }
2651    CallingConv getCC() const { return CallingConv(Bits & CallConvMask); }
2652
2653    bool operator==(ExtInfo Other) const {
2654      return Bits == Other.Bits;
2655    }
2656    bool operator!=(ExtInfo Other) const {
2657      return Bits != Other.Bits;
2658    }
2659
2660    // Note that we don't have setters. That is by design, use
2661    // the following with methods instead of mutating these objects.
2662
2663    ExtInfo withNoReturn(bool noReturn) const {
2664      if (noReturn)
2665        return ExtInfo(Bits | NoReturnMask);
2666      else
2667        return ExtInfo(Bits & ~NoReturnMask);
2668    }
2669
2670    ExtInfo withProducesResult(bool producesResult) const {
2671      if (producesResult)
2672        return ExtInfo(Bits | ProducesResultMask);
2673      else
2674        return ExtInfo(Bits & ~ProducesResultMask);
2675    }
2676
2677    ExtInfo withRegParm(unsigned RegParm) const {
2678      assert(RegParm < 7 && "Invalid regparm value");
2679      return ExtInfo((Bits & ~RegParmMask) |
2680                     ((RegParm + 1) << RegParmOffset));
2681    }
2682
2683    ExtInfo withCallingConv(CallingConv cc) const {
2684      return ExtInfo((Bits & ~CallConvMask) | (unsigned) cc);
2685    }
2686
2687    void Profile(llvm::FoldingSetNodeID &ID) const {
2688      ID.AddInteger(Bits);
2689    }
2690  };
2691
2692protected:
2693  FunctionType(TypeClass tc, QualType res,
2694               unsigned typeQuals, QualType Canonical, bool Dependent,
2695               bool InstantiationDependent,
2696               bool VariablyModified, bool ContainsUnexpandedParameterPack,
2697               ExtInfo Info)
2698    : Type(tc, Canonical, Dependent, InstantiationDependent, VariablyModified,
2699           ContainsUnexpandedParameterPack),
2700      ResultType(res) {
2701    FunctionTypeBits.ExtInfo = Info.Bits;
2702    FunctionTypeBits.TypeQuals = typeQuals;
2703  }
2704  unsigned getTypeQuals() const { return FunctionTypeBits.TypeQuals; }
2705
2706public:
2707
2708  QualType getResultType() const { return ResultType; }
2709
2710  bool getHasRegParm() const { return getExtInfo().getHasRegParm(); }
2711  unsigned getRegParmType() const { return getExtInfo().getRegParm(); }
2712  /// \brief Determine whether this function type includes the GNU noreturn
2713  /// attribute. The C++11 [[noreturn]] attribute does not affect the function
2714  /// type.
2715  bool getNoReturnAttr() const { return getExtInfo().getNoReturn(); }
2716  CallingConv getCallConv() const { return getExtInfo().getCC(); }
2717  ExtInfo getExtInfo() const { return ExtInfo(FunctionTypeBits.ExtInfo); }
2718  bool isConst() const { return getTypeQuals() & Qualifiers::Const; }
2719  bool isVolatile() const { return getTypeQuals() & Qualifiers::Volatile; }
2720  bool isRestrict() const { return getTypeQuals() & Qualifiers::Restrict; }
2721
2722  /// \brief Determine the type of an expression that calls a function of
2723  /// this type.
2724  QualType getCallResultType(ASTContext &Context) const {
2725    return getResultType().getNonLValueExprType(Context);
2726  }
2727
2728  static StringRef getNameForCallConv(CallingConv CC);
2729
2730  static bool classof(const Type *T) {
2731    return T->getTypeClass() == FunctionNoProto ||
2732           T->getTypeClass() == FunctionProto;
2733  }
2734};
2735
2736/// FunctionNoProtoType - Represents a K&R-style 'int foo()' function, which has
2737/// no information available about its arguments.
2738class FunctionNoProtoType : public FunctionType, public llvm::FoldingSetNode {
2739  FunctionNoProtoType(QualType Result, QualType Canonical, ExtInfo Info)
2740    : FunctionType(FunctionNoProto, Result, 0, Canonical,
2741                   /*Dependent=*/false, /*InstantiationDependent=*/false,
2742                   Result->isVariablyModifiedType(),
2743                   /*ContainsUnexpandedParameterPack=*/false, Info) {}
2744
2745  friend class ASTContext;  // ASTContext creates these.
2746
2747public:
2748  // No additional state past what FunctionType provides.
2749
2750  bool isSugared() const { return false; }
2751  QualType desugar() const { return QualType(this, 0); }
2752
2753  void Profile(llvm::FoldingSetNodeID &ID) {
2754    Profile(ID, getResultType(), getExtInfo());
2755  }
2756  static void Profile(llvm::FoldingSetNodeID &ID, QualType ResultType,
2757                      ExtInfo Info) {
2758    Info.Profile(ID);
2759    ID.AddPointer(ResultType.getAsOpaquePtr());
2760  }
2761
2762  static bool classof(const Type *T) {
2763    return T->getTypeClass() == FunctionNoProto;
2764  }
2765};
2766
2767/// FunctionProtoType - Represents a prototype with argument type info, e.g.
2768/// 'int foo(int)' or 'int foo(void)'.  'void' is represented as having no
2769/// arguments, not as having a single void argument. Such a type can have an
2770/// exception specification, but this specification is not part of the canonical
2771/// type.
2772class FunctionProtoType : public FunctionType, public llvm::FoldingSetNode {
2773public:
2774  /// ExtProtoInfo - Extra information about a function prototype.
2775  struct ExtProtoInfo {
2776    ExtProtoInfo() :
2777      Variadic(false), HasTrailingReturn(false), TypeQuals(0),
2778      ExceptionSpecType(EST_None), RefQualifier(RQ_None),
2779      NumExceptions(0), Exceptions(0), NoexceptExpr(0),
2780      ExceptionSpecDecl(0), ExceptionSpecTemplate(0),
2781      ConsumedArguments(0) {}
2782
2783    FunctionType::ExtInfo ExtInfo;
2784    bool Variadic : 1;
2785    bool HasTrailingReturn : 1;
2786    unsigned char TypeQuals;
2787    ExceptionSpecificationType ExceptionSpecType;
2788    RefQualifierKind RefQualifier;
2789    unsigned NumExceptions;
2790    const QualType *Exceptions;
2791    Expr *NoexceptExpr;
2792    FunctionDecl *ExceptionSpecDecl;
2793    FunctionDecl *ExceptionSpecTemplate;
2794    const bool *ConsumedArguments;
2795  };
2796
2797private:
2798  /// \brief Determine whether there are any argument types that
2799  /// contain an unexpanded parameter pack.
2800  static bool containsAnyUnexpandedParameterPack(const QualType *ArgArray,
2801                                                 unsigned numArgs) {
2802    for (unsigned Idx = 0; Idx < numArgs; ++Idx)
2803      if (ArgArray[Idx]->containsUnexpandedParameterPack())
2804        return true;
2805
2806    return false;
2807  }
2808
2809  FunctionProtoType(QualType result, const QualType *args, unsigned numArgs,
2810                    QualType canonical, const ExtProtoInfo &epi);
2811
2812  /// NumArgs - The number of arguments this function has, not counting '...'.
2813  unsigned NumArgs : 15;
2814
2815  /// NumExceptions - The number of types in the exception spec, if any.
2816  unsigned NumExceptions : 9;
2817
2818  /// ExceptionSpecType - The type of exception specification this function has.
2819  unsigned ExceptionSpecType : 3;
2820
2821  /// HasAnyConsumedArgs - Whether this function has any consumed arguments.
2822  unsigned HasAnyConsumedArgs : 1;
2823
2824  /// Variadic - Whether the function is variadic.
2825  unsigned Variadic : 1;
2826
2827  /// HasTrailingReturn - Whether this function has a trailing return type.
2828  unsigned HasTrailingReturn : 1;
2829
2830  /// \brief The ref-qualifier associated with a \c FunctionProtoType.
2831  ///
2832  /// This is a value of type \c RefQualifierKind.
2833  unsigned RefQualifier : 2;
2834
2835  // ArgInfo - There is an variable size array after the class in memory that
2836  // holds the argument types.
2837
2838  // Exceptions - There is another variable size array after ArgInfo that
2839  // holds the exception types.
2840
2841  // NoexceptExpr - Instead of Exceptions, there may be a single Expr* pointing
2842  // to the expression in the noexcept() specifier.
2843
2844  // ExceptionSpecDecl, ExceptionSpecTemplate - Instead of Exceptions, there may
2845  // be a pair of FunctionDecl* pointing to the function which should be used to
2846  // instantiate this function type's exception specification, and the function
2847  // from which it should be instantiated.
2848
2849  // ConsumedArgs - A variable size array, following Exceptions
2850  // and of length NumArgs, holding flags indicating which arguments
2851  // are consumed.  This only appears if HasAnyConsumedArgs is true.
2852
2853  friend class ASTContext;  // ASTContext creates these.
2854
2855  const bool *getConsumedArgsBuffer() const {
2856    assert(hasAnyConsumedArgs());
2857
2858    // Find the end of the exceptions.
2859    Expr * const *eh_end = reinterpret_cast<Expr * const *>(arg_type_end());
2860    if (getExceptionSpecType() != EST_ComputedNoexcept)
2861      eh_end += NumExceptions;
2862    else
2863      eh_end += 1; // NoexceptExpr
2864
2865    return reinterpret_cast<const bool*>(eh_end);
2866  }
2867
2868public:
2869  unsigned getNumArgs() const { return NumArgs; }
2870  QualType getArgType(unsigned i) const {
2871    assert(i < NumArgs && "Invalid argument number!");
2872    return arg_type_begin()[i];
2873  }
2874
2875  ExtProtoInfo getExtProtoInfo() const {
2876    ExtProtoInfo EPI;
2877    EPI.ExtInfo = getExtInfo();
2878    EPI.Variadic = isVariadic();
2879    EPI.HasTrailingReturn = hasTrailingReturn();
2880    EPI.ExceptionSpecType = getExceptionSpecType();
2881    EPI.TypeQuals = static_cast<unsigned char>(getTypeQuals());
2882    EPI.RefQualifier = getRefQualifier();
2883    if (EPI.ExceptionSpecType == EST_Dynamic) {
2884      EPI.NumExceptions = NumExceptions;
2885      EPI.Exceptions = exception_begin();
2886    } else if (EPI.ExceptionSpecType == EST_ComputedNoexcept) {
2887      EPI.NoexceptExpr = getNoexceptExpr();
2888    } else if (EPI.ExceptionSpecType == EST_Uninstantiated) {
2889      EPI.ExceptionSpecDecl = getExceptionSpecDecl();
2890      EPI.ExceptionSpecTemplate = getExceptionSpecTemplate();
2891    } else if (EPI.ExceptionSpecType == EST_Unevaluated) {
2892      EPI.ExceptionSpecDecl = getExceptionSpecDecl();
2893    }
2894    if (hasAnyConsumedArgs())
2895      EPI.ConsumedArguments = getConsumedArgsBuffer();
2896    return EPI;
2897  }
2898
2899  /// \brief Get the kind of exception specification on this function.
2900  ExceptionSpecificationType getExceptionSpecType() const {
2901    return static_cast<ExceptionSpecificationType>(ExceptionSpecType);
2902  }
2903  /// \brief Return whether this function has any kind of exception spec.
2904  bool hasExceptionSpec() const {
2905    return getExceptionSpecType() != EST_None;
2906  }
2907  /// \brief Return whether this function has a dynamic (throw) exception spec.
2908  bool hasDynamicExceptionSpec() const {
2909    return isDynamicExceptionSpec(getExceptionSpecType());
2910  }
2911  /// \brief Return whether this function has a noexcept exception spec.
2912  bool hasNoexceptExceptionSpec() const {
2913    return isNoexceptExceptionSpec(getExceptionSpecType());
2914  }
2915  /// \brief Result type of getNoexceptSpec().
2916  enum NoexceptResult {
2917    NR_NoNoexcept,  ///< There is no noexcept specifier.
2918    NR_BadNoexcept, ///< The noexcept specifier has a bad expression.
2919    NR_Dependent,   ///< The noexcept specifier is dependent.
2920    NR_Throw,       ///< The noexcept specifier evaluates to false.
2921    NR_Nothrow      ///< The noexcept specifier evaluates to true.
2922  };
2923  /// \brief Get the meaning of the noexcept spec on this function, if any.
2924  NoexceptResult getNoexceptSpec(ASTContext &Ctx) const;
2925  unsigned getNumExceptions() const { return NumExceptions; }
2926  QualType getExceptionType(unsigned i) const {
2927    assert(i < NumExceptions && "Invalid exception number!");
2928    return exception_begin()[i];
2929  }
2930  Expr *getNoexceptExpr() const {
2931    if (getExceptionSpecType() != EST_ComputedNoexcept)
2932      return 0;
2933    // NoexceptExpr sits where the arguments end.
2934    return *reinterpret_cast<Expr *const *>(arg_type_end());
2935  }
2936  /// \brief If this function type has an exception specification which hasn't
2937  /// been determined yet (either because it has not been evaluated or because
2938  /// it has not been instantiated), this is the function whose exception
2939  /// specification is represented by this type.
2940  FunctionDecl *getExceptionSpecDecl() const {
2941    if (getExceptionSpecType() != EST_Uninstantiated &&
2942        getExceptionSpecType() != EST_Unevaluated)
2943      return 0;
2944    return reinterpret_cast<FunctionDecl * const *>(arg_type_end())[0];
2945  }
2946  /// \brief If this function type has an uninstantiated exception
2947  /// specification, this is the function whose exception specification
2948  /// should be instantiated to find the exception specification for
2949  /// this type.
2950  FunctionDecl *getExceptionSpecTemplate() const {
2951    if (getExceptionSpecType() != EST_Uninstantiated)
2952      return 0;
2953    return reinterpret_cast<FunctionDecl * const *>(arg_type_end())[1];
2954  }
2955  bool isNothrow(ASTContext &Ctx) const {
2956    ExceptionSpecificationType EST = getExceptionSpecType();
2957    assert(EST != EST_Unevaluated && EST != EST_Uninstantiated);
2958    if (EST == EST_DynamicNone || EST == EST_BasicNoexcept)
2959      return true;
2960    if (EST != EST_ComputedNoexcept)
2961      return false;
2962    return getNoexceptSpec(Ctx) == NR_Nothrow;
2963  }
2964
2965  bool isVariadic() const { return Variadic; }
2966
2967  /// \brief Determines whether this function prototype contains a
2968  /// parameter pack at the end.
2969  ///
2970  /// A function template whose last parameter is a parameter pack can be
2971  /// called with an arbitrary number of arguments, much like a variadic
2972  /// function.
2973  bool isTemplateVariadic() const;
2974
2975  bool hasTrailingReturn() const { return HasTrailingReturn; }
2976
2977  unsigned getTypeQuals() const { return FunctionType::getTypeQuals(); }
2978
2979
2980  /// \brief Retrieve the ref-qualifier associated with this function type.
2981  RefQualifierKind getRefQualifier() const {
2982    return static_cast<RefQualifierKind>(RefQualifier);
2983  }
2984
2985  typedef const QualType *arg_type_iterator;
2986  arg_type_iterator arg_type_begin() const {
2987    return reinterpret_cast<const QualType *>(this+1);
2988  }
2989  arg_type_iterator arg_type_end() const { return arg_type_begin()+NumArgs; }
2990
2991  typedef const QualType *exception_iterator;
2992  exception_iterator exception_begin() const {
2993    // exceptions begin where arguments end
2994    return arg_type_end();
2995  }
2996  exception_iterator exception_end() const {
2997    if (getExceptionSpecType() != EST_Dynamic)
2998      return exception_begin();
2999    return exception_begin() + NumExceptions;
3000  }
3001
3002  bool hasAnyConsumedArgs() const {
3003    return HasAnyConsumedArgs;
3004  }
3005  bool isArgConsumed(unsigned I) const {
3006    assert(I < getNumArgs() && "argument index out of range!");
3007    if (hasAnyConsumedArgs())
3008      return getConsumedArgsBuffer()[I];
3009    return false;
3010  }
3011
3012  bool isSugared() const { return false; }
3013  QualType desugar() const { return QualType(this, 0); }
3014
3015  void printExceptionSpecification(raw_ostream &OS,
3016                                   const PrintingPolicy &Policy) const;
3017
3018  static bool classof(const Type *T) {
3019    return T->getTypeClass() == FunctionProto;
3020  }
3021
3022  void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Ctx);
3023  static void Profile(llvm::FoldingSetNodeID &ID, QualType Result,
3024                      arg_type_iterator ArgTys, unsigned NumArgs,
3025                      const ExtProtoInfo &EPI, const ASTContext &Context);
3026};
3027
3028
3029/// \brief Represents the dependent type named by a dependently-scoped
3030/// typename using declaration, e.g.
3031///   using typename Base<T>::foo;
3032/// Template instantiation turns these into the underlying type.
3033class UnresolvedUsingType : public Type {
3034  UnresolvedUsingTypenameDecl *Decl;
3035
3036  UnresolvedUsingType(const UnresolvedUsingTypenameDecl *D)
3037    : Type(UnresolvedUsing, QualType(), true, true, false,
3038           /*ContainsUnexpandedParameterPack=*/false),
3039      Decl(const_cast<UnresolvedUsingTypenameDecl*>(D)) {}
3040  friend class ASTContext; // ASTContext creates these.
3041public:
3042
3043  UnresolvedUsingTypenameDecl *getDecl() const { return Decl; }
3044
3045  bool isSugared() const { return false; }
3046  QualType desugar() const { return QualType(this, 0); }
3047
3048  static bool classof(const Type *T) {
3049    return T->getTypeClass() == UnresolvedUsing;
3050  }
3051
3052  void Profile(llvm::FoldingSetNodeID &ID) {
3053    return Profile(ID, Decl);
3054  }
3055  static void Profile(llvm::FoldingSetNodeID &ID,
3056                      UnresolvedUsingTypenameDecl *D) {
3057    ID.AddPointer(D);
3058  }
3059};
3060
3061
3062class TypedefType : public Type {
3063  TypedefNameDecl *Decl;
3064protected:
3065  TypedefType(TypeClass tc, const TypedefNameDecl *D, QualType can)
3066    : Type(tc, can, can->isDependentType(),
3067           can->isInstantiationDependentType(),
3068           can->isVariablyModifiedType(),
3069           /*ContainsUnexpandedParameterPack=*/false),
3070      Decl(const_cast<TypedefNameDecl*>(D)) {
3071    assert(!isa<TypedefType>(can) && "Invalid canonical type");
3072  }
3073  friend class ASTContext;  // ASTContext creates these.
3074public:
3075
3076  TypedefNameDecl *getDecl() const { return Decl; }
3077
3078  bool isSugared() const { return true; }
3079  QualType desugar() const;
3080
3081  static bool classof(const Type *T) { return T->getTypeClass() == Typedef; }
3082};
3083
3084/// TypeOfExprType (GCC extension).
3085class TypeOfExprType : public Type {
3086  Expr *TOExpr;
3087
3088protected:
3089  TypeOfExprType(Expr *E, QualType can = QualType());
3090  friend class ASTContext;  // ASTContext creates these.
3091public:
3092  Expr *getUnderlyingExpr() const { return TOExpr; }
3093
3094  /// \brief Remove a single level of sugar.
3095  QualType desugar() const;
3096
3097  /// \brief Returns whether this type directly provides sugar.
3098  bool isSugared() const;
3099
3100  static bool classof(const Type *T) { return T->getTypeClass() == TypeOfExpr; }
3101};
3102
3103/// \brief Internal representation of canonical, dependent
3104/// typeof(expr) types.
3105///
3106/// This class is used internally by the ASTContext to manage
3107/// canonical, dependent types, only. Clients will only see instances
3108/// of this class via TypeOfExprType nodes.
3109class DependentTypeOfExprType
3110  : public TypeOfExprType, public llvm::FoldingSetNode {
3111  const ASTContext &Context;
3112
3113public:
3114  DependentTypeOfExprType(const ASTContext &Context, Expr *E)
3115    : TypeOfExprType(E), Context(Context) { }
3116
3117  void Profile(llvm::FoldingSetNodeID &ID) {
3118    Profile(ID, Context, getUnderlyingExpr());
3119  }
3120
3121  static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
3122                      Expr *E);
3123};
3124
3125/// TypeOfType (GCC extension).
3126class TypeOfType : public Type {
3127  QualType TOType;
3128  TypeOfType(QualType T, QualType can)
3129    : Type(TypeOf, can, T->isDependentType(),
3130           T->isInstantiationDependentType(),
3131           T->isVariablyModifiedType(),
3132           T->containsUnexpandedParameterPack()),
3133      TOType(T) {
3134    assert(!isa<TypedefType>(can) && "Invalid canonical type");
3135  }
3136  friend class ASTContext;  // ASTContext creates these.
3137public:
3138  QualType getUnderlyingType() const { return TOType; }
3139
3140  /// \brief Remove a single level of sugar.
3141  QualType desugar() const { return getUnderlyingType(); }
3142
3143  /// \brief Returns whether this type directly provides sugar.
3144  bool isSugared() const { return true; }
3145
3146  static bool classof(const Type *T) { return T->getTypeClass() == TypeOf; }
3147};
3148
3149/// DecltypeType (C++0x)
3150class DecltypeType : public Type {
3151  Expr *E;
3152  QualType UnderlyingType;
3153
3154protected:
3155  DecltypeType(Expr *E, QualType underlyingType, QualType can = QualType());
3156  friend class ASTContext;  // ASTContext creates these.
3157public:
3158  Expr *getUnderlyingExpr() const { return E; }
3159  QualType getUnderlyingType() const { return UnderlyingType; }
3160
3161  /// \brief Remove a single level of sugar.
3162  QualType desugar() const;
3163
3164  /// \brief Returns whether this type directly provides sugar.
3165  bool isSugared() const;
3166
3167  static bool classof(const Type *T) { return T->getTypeClass() == Decltype; }
3168};
3169
3170/// \brief Internal representation of canonical, dependent
3171/// decltype(expr) types.
3172///
3173/// This class is used internally by the ASTContext to manage
3174/// canonical, dependent types, only. Clients will only see instances
3175/// of this class via DecltypeType nodes.
3176class DependentDecltypeType : public DecltypeType, public llvm::FoldingSetNode {
3177  const ASTContext &Context;
3178
3179public:
3180  DependentDecltypeType(const ASTContext &Context, Expr *E);
3181
3182  void Profile(llvm::FoldingSetNodeID &ID) {
3183    Profile(ID, Context, getUnderlyingExpr());
3184  }
3185
3186  static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
3187                      Expr *E);
3188};
3189
3190/// \brief A unary type transform, which is a type constructed from another
3191class UnaryTransformType : public Type {
3192public:
3193  enum UTTKind {
3194    EnumUnderlyingType
3195  };
3196
3197private:
3198  /// The untransformed type.
3199  QualType BaseType;
3200  /// The transformed type if not dependent, otherwise the same as BaseType.
3201  QualType UnderlyingType;
3202
3203  UTTKind UKind;
3204protected:
3205  UnaryTransformType(QualType BaseTy, QualType UnderlyingTy, UTTKind UKind,
3206                     QualType CanonicalTy);
3207  friend class ASTContext;
3208public:
3209  bool isSugared() const { return !isDependentType(); }
3210  QualType desugar() const { return UnderlyingType; }
3211
3212  QualType getUnderlyingType() const { return UnderlyingType; }
3213  QualType getBaseType() const { return BaseType; }
3214
3215  UTTKind getUTTKind() const { return UKind; }
3216
3217  static bool classof(const Type *T) {
3218    return T->getTypeClass() == UnaryTransform;
3219  }
3220};
3221
3222class TagType : public Type {
3223  /// Stores the TagDecl associated with this type. The decl may point to any
3224  /// TagDecl that declares the entity.
3225  TagDecl * decl;
3226
3227  friend class ASTReader;
3228
3229protected:
3230  TagType(TypeClass TC, const TagDecl *D, QualType can);
3231
3232public:
3233  TagDecl *getDecl() const;
3234
3235  /// @brief Determines whether this type is in the process of being
3236  /// defined.
3237  bool isBeingDefined() const;
3238
3239  static bool classof(const Type *T) {
3240    return T->getTypeClass() >= TagFirst && T->getTypeClass() <= TagLast;
3241  }
3242};
3243
3244/// RecordType - This is a helper class that allows the use of isa/cast/dyncast
3245/// to detect TagType objects of structs/unions/classes.
3246class RecordType : public TagType {
3247protected:
3248  explicit RecordType(const RecordDecl *D)
3249    : TagType(Record, reinterpret_cast<const TagDecl*>(D), QualType()) { }
3250  explicit RecordType(TypeClass TC, RecordDecl *D)
3251    : TagType(TC, reinterpret_cast<const TagDecl*>(D), QualType()) { }
3252  friend class ASTContext;   // ASTContext creates these.
3253public:
3254
3255  RecordDecl *getDecl() const {
3256    return reinterpret_cast<RecordDecl*>(TagType::getDecl());
3257  }
3258
3259  // FIXME: This predicate is a helper to QualType/Type. It needs to
3260  // recursively check all fields for const-ness. If any field is declared
3261  // const, it needs to return false.
3262  bool hasConstFields() const { return false; }
3263
3264  bool isSugared() const { return false; }
3265  QualType desugar() const { return QualType(this, 0); }
3266
3267  static bool classof(const Type *T) { return T->getTypeClass() == Record; }
3268};
3269
3270/// EnumType - This is a helper class that allows the use of isa/cast/dyncast
3271/// to detect TagType objects of enums.
3272class EnumType : public TagType {
3273  explicit EnumType(const EnumDecl *D)
3274    : TagType(Enum, reinterpret_cast<const TagDecl*>(D), QualType()) { }
3275  friend class ASTContext;   // ASTContext creates these.
3276public:
3277
3278  EnumDecl *getDecl() const {
3279    return reinterpret_cast<EnumDecl*>(TagType::getDecl());
3280  }
3281
3282  bool isSugared() const { return false; }
3283  QualType desugar() const { return QualType(this, 0); }
3284
3285  static bool classof(const Type *T) { return T->getTypeClass() == Enum; }
3286};
3287
3288/// AttributedType - An attributed type is a type to which a type
3289/// attribute has been applied.  The "modified type" is the
3290/// fully-sugared type to which the attributed type was applied;
3291/// generally it is not canonically equivalent to the attributed type.
3292/// The "equivalent type" is the minimally-desugared type which the
3293/// type is canonically equivalent to.
3294///
3295/// For example, in the following attributed type:
3296///     int32_t __attribute__((vector_size(16)))
3297///   - the modified type is the TypedefType for int32_t
3298///   - the equivalent type is VectorType(16, int32_t)
3299///   - the canonical type is VectorType(16, int)
3300class AttributedType : public Type, public llvm::FoldingSetNode {
3301public:
3302  // It is really silly to have yet another attribute-kind enum, but
3303  // clang::attr::Kind doesn't currently cover the pure type attrs.
3304  enum Kind {
3305    // Expression operand.
3306    attr_address_space,
3307    attr_regparm,
3308    attr_vector_size,
3309    attr_neon_vector_type,
3310    attr_neon_polyvector_type,
3311
3312    FirstExprOperandKind = attr_address_space,
3313    LastExprOperandKind = attr_neon_polyvector_type,
3314
3315    // Enumerated operand (string or keyword).
3316    attr_objc_gc,
3317    attr_objc_ownership,
3318    attr_pcs,
3319
3320    FirstEnumOperandKind = attr_objc_gc,
3321    LastEnumOperandKind = attr_pcs,
3322
3323    // No operand.
3324    attr_noreturn,
3325    attr_cdecl,
3326    attr_coldcc,
3327    attr_fastcall,
3328    attr_stdcall,
3329    attr_thiscall,
3330    attr_pascal,
3331    attr_pnaclcall,
3332    attr_inteloclbicc
3333  };
3334
3335private:
3336  QualType ModifiedType;
3337  QualType EquivalentType;
3338
3339  friend class ASTContext; // creates these
3340
3341  AttributedType(QualType canon, Kind attrKind,
3342                 QualType modified, QualType equivalent)
3343    : Type(Attributed, canon, canon->isDependentType(),
3344           canon->isInstantiationDependentType(),
3345           canon->isVariablyModifiedType(),
3346           canon->containsUnexpandedParameterPack()),
3347      ModifiedType(modified), EquivalentType(equivalent) {
3348    AttributedTypeBits.AttrKind = attrKind;
3349  }
3350
3351public:
3352  Kind getAttrKind() const {
3353    return static_cast<Kind>(AttributedTypeBits.AttrKind);
3354  }
3355
3356  QualType getModifiedType() const { return ModifiedType; }
3357  QualType getEquivalentType() const { return EquivalentType; }
3358
3359  bool isSugared() const { return true; }
3360  QualType desugar() const { return getEquivalentType(); }
3361
3362  void Profile(llvm::FoldingSetNodeID &ID) {
3363    Profile(ID, getAttrKind(), ModifiedType, EquivalentType);
3364  }
3365
3366  static void Profile(llvm::FoldingSetNodeID &ID, Kind attrKind,
3367                      QualType modified, QualType equivalent) {
3368    ID.AddInteger(attrKind);
3369    ID.AddPointer(modified.getAsOpaquePtr());
3370    ID.AddPointer(equivalent.getAsOpaquePtr());
3371  }
3372
3373  static bool classof(const Type *T) {
3374    return T->getTypeClass() == Attributed;
3375  }
3376};
3377
3378class TemplateTypeParmType : public Type, public llvm::FoldingSetNode {
3379  // Helper data collector for canonical types.
3380  struct CanonicalTTPTInfo {
3381    unsigned Depth : 15;
3382    unsigned ParameterPack : 1;
3383    unsigned Index : 16;
3384  };
3385
3386  union {
3387    // Info for the canonical type.
3388    CanonicalTTPTInfo CanTTPTInfo;
3389    // Info for the non-canonical type.
3390    TemplateTypeParmDecl *TTPDecl;
3391  };
3392
3393  /// Build a non-canonical type.
3394  TemplateTypeParmType(TemplateTypeParmDecl *TTPDecl, QualType Canon)
3395    : Type(TemplateTypeParm, Canon, /*Dependent=*/true,
3396           /*InstantiationDependent=*/true,
3397           /*VariablyModified=*/false,
3398           Canon->containsUnexpandedParameterPack()),
3399      TTPDecl(TTPDecl) { }
3400
3401  /// Build the canonical type.
3402  TemplateTypeParmType(unsigned D, unsigned I, bool PP)
3403    : Type(TemplateTypeParm, QualType(this, 0),
3404           /*Dependent=*/true,
3405           /*InstantiationDependent=*/true,
3406           /*VariablyModified=*/false, PP) {
3407    CanTTPTInfo.Depth = D;
3408    CanTTPTInfo.Index = I;
3409    CanTTPTInfo.ParameterPack = PP;
3410  }
3411
3412  friend class ASTContext;  // ASTContext creates these
3413
3414  const CanonicalTTPTInfo& getCanTTPTInfo() const {
3415    QualType Can = getCanonicalTypeInternal();
3416    return Can->castAs<TemplateTypeParmType>()->CanTTPTInfo;
3417  }
3418
3419public:
3420  unsigned getDepth() const { return getCanTTPTInfo().Depth; }
3421  unsigned getIndex() const { return getCanTTPTInfo().Index; }
3422  bool isParameterPack() const { return getCanTTPTInfo().ParameterPack; }
3423
3424  TemplateTypeParmDecl *getDecl() const {
3425    return isCanonicalUnqualified() ? 0 : TTPDecl;
3426  }
3427
3428  IdentifierInfo *getIdentifier() const;
3429
3430  bool isSugared() const { return false; }
3431  QualType desugar() const { return QualType(this, 0); }
3432
3433  void Profile(llvm::FoldingSetNodeID &ID) {
3434    Profile(ID, getDepth(), getIndex(), isParameterPack(), getDecl());
3435  }
3436
3437  static void Profile(llvm::FoldingSetNodeID &ID, unsigned Depth,
3438                      unsigned Index, bool ParameterPack,
3439                      TemplateTypeParmDecl *TTPDecl) {
3440    ID.AddInteger(Depth);
3441    ID.AddInteger(Index);
3442    ID.AddBoolean(ParameterPack);
3443    ID.AddPointer(TTPDecl);
3444  }
3445
3446  static bool classof(const Type *T) {
3447    return T->getTypeClass() == TemplateTypeParm;
3448  }
3449};
3450
3451/// \brief Represents the result of substituting a type for a template
3452/// type parameter.
3453///
3454/// Within an instantiated template, all template type parameters have
3455/// been replaced with these.  They are used solely to record that a
3456/// type was originally written as a template type parameter;
3457/// therefore they are never canonical.
3458class SubstTemplateTypeParmType : public Type, public llvm::FoldingSetNode {
3459  // The original type parameter.
3460  const TemplateTypeParmType *Replaced;
3461
3462  SubstTemplateTypeParmType(const TemplateTypeParmType *Param, QualType Canon)
3463    : Type(SubstTemplateTypeParm, Canon, Canon->isDependentType(),
3464           Canon->isInstantiationDependentType(),
3465           Canon->isVariablyModifiedType(),
3466           Canon->containsUnexpandedParameterPack()),
3467      Replaced(Param) { }
3468
3469  friend class ASTContext;
3470
3471public:
3472  /// Gets the template parameter that was substituted for.
3473  const TemplateTypeParmType *getReplacedParameter() const {
3474    return Replaced;
3475  }
3476
3477  /// Gets the type that was substituted for the template
3478  /// parameter.
3479  QualType getReplacementType() const {
3480    return getCanonicalTypeInternal();
3481  }
3482
3483  bool isSugared() const { return true; }
3484  QualType desugar() const { return getReplacementType(); }
3485
3486  void Profile(llvm::FoldingSetNodeID &ID) {
3487    Profile(ID, getReplacedParameter(), getReplacementType());
3488  }
3489  static void Profile(llvm::FoldingSetNodeID &ID,
3490                      const TemplateTypeParmType *Replaced,
3491                      QualType Replacement) {
3492    ID.AddPointer(Replaced);
3493    ID.AddPointer(Replacement.getAsOpaquePtr());
3494  }
3495
3496  static bool classof(const Type *T) {
3497    return T->getTypeClass() == SubstTemplateTypeParm;
3498  }
3499};
3500
3501/// \brief Represents the result of substituting a set of types for a template
3502/// type parameter pack.
3503///
3504/// When a pack expansion in the source code contains multiple parameter packs
3505/// and those parameter packs correspond to different levels of template
3506/// parameter lists, this type node is used to represent a template type
3507/// parameter pack from an outer level, which has already had its argument pack
3508/// substituted but that still lives within a pack expansion that itself
3509/// could not be instantiated. When actually performing a substitution into
3510/// that pack expansion (e.g., when all template parameters have corresponding
3511/// arguments), this type will be replaced with the \c SubstTemplateTypeParmType
3512/// at the current pack substitution index.
3513class SubstTemplateTypeParmPackType : public Type, public llvm::FoldingSetNode {
3514  /// \brief The original type parameter.
3515  const TemplateTypeParmType *Replaced;
3516
3517  /// \brief A pointer to the set of template arguments that this
3518  /// parameter pack is instantiated with.
3519  const TemplateArgument *Arguments;
3520
3521  /// \brief The number of template arguments in \c Arguments.
3522  unsigned NumArguments;
3523
3524  SubstTemplateTypeParmPackType(const TemplateTypeParmType *Param,
3525                                QualType Canon,
3526                                const TemplateArgument &ArgPack);
3527
3528  friend class ASTContext;
3529
3530public:
3531  IdentifierInfo *getIdentifier() const { return Replaced->getIdentifier(); }
3532
3533  /// Gets the template parameter that was substituted for.
3534  const TemplateTypeParmType *getReplacedParameter() const {
3535    return Replaced;
3536  }
3537
3538  bool isSugared() const { return false; }
3539  QualType desugar() const { return QualType(this, 0); }
3540
3541  TemplateArgument getArgumentPack() const;
3542
3543  void Profile(llvm::FoldingSetNodeID &ID);
3544  static void Profile(llvm::FoldingSetNodeID &ID,
3545                      const TemplateTypeParmType *Replaced,
3546                      const TemplateArgument &ArgPack);
3547
3548  static bool classof(const Type *T) {
3549    return T->getTypeClass() == SubstTemplateTypeParmPack;
3550  }
3551};
3552
3553/// \brief Represents a C++0x auto type.
3554///
3555/// These types are usually a placeholder for a deduced type. However, within
3556/// templates and before the initializer is attached, there is no deduced type
3557/// and an auto type is type-dependent and canonical.
3558class AutoType : public Type, public llvm::FoldingSetNode {
3559  AutoType(QualType DeducedType)
3560    : Type(Auto, DeducedType.isNull() ? QualType(this, 0) : DeducedType,
3561           /*Dependent=*/DeducedType.isNull(),
3562           /*InstantiationDependent=*/DeducedType.isNull(),
3563           /*VariablyModified=*/false, /*ContainsParameterPack=*/false) {
3564    assert((DeducedType.isNull() || !DeducedType->isDependentType()) &&
3565           "deduced a dependent type for auto");
3566  }
3567
3568  friend class ASTContext;  // ASTContext creates these
3569
3570public:
3571  bool isSugared() const { return isDeduced(); }
3572  QualType desugar() const { return getCanonicalTypeInternal(); }
3573
3574  QualType getDeducedType() const {
3575    return isDeduced() ? getCanonicalTypeInternal() : QualType();
3576  }
3577  bool isDeduced() const {
3578    return !isDependentType();
3579  }
3580
3581  void Profile(llvm::FoldingSetNodeID &ID) {
3582    Profile(ID, getDeducedType());
3583  }
3584
3585  static void Profile(llvm::FoldingSetNodeID &ID,
3586                      QualType Deduced) {
3587    ID.AddPointer(Deduced.getAsOpaquePtr());
3588  }
3589
3590  static bool classof(const Type *T) {
3591    return T->getTypeClass() == Auto;
3592  }
3593};
3594
3595/// \brief Represents a type template specialization; the template
3596/// must be a class template, a type alias template, or a template
3597/// template parameter.  A template which cannot be resolved to one of
3598/// these, e.g. because it is written with a dependent scope
3599/// specifier, is instead represented as a
3600/// @c DependentTemplateSpecializationType.
3601///
3602/// A non-dependent template specialization type is always "sugar",
3603/// typically for a @c RecordType.  For example, a class template
3604/// specialization type of @c vector<int> will refer to a tag type for
3605/// the instantiation @c std::vector<int, std::allocator<int>>
3606///
3607/// Template specializations are dependent if either the template or
3608/// any of the template arguments are dependent, in which case the
3609/// type may also be canonical.
3610///
3611/// Instances of this type are allocated with a trailing array of
3612/// TemplateArguments, followed by a QualType representing the
3613/// non-canonical aliased type when the template is a type alias
3614/// template.
3615class TemplateSpecializationType
3616  : public Type, public llvm::FoldingSetNode {
3617  /// \brief The name of the template being specialized.  This is
3618  /// either a TemplateName::Template (in which case it is a
3619  /// ClassTemplateDecl*, a TemplateTemplateParmDecl*, or a
3620  /// TypeAliasTemplateDecl*), a
3621  /// TemplateName::SubstTemplateTemplateParmPack, or a
3622  /// TemplateName::SubstTemplateTemplateParm (in which case the
3623  /// replacement must, recursively, be one of these).
3624  TemplateName Template;
3625
3626  /// \brief - The number of template arguments named in this class
3627  /// template specialization.
3628  unsigned NumArgs : 31;
3629
3630  /// \brief Whether this template specialization type is a substituted
3631  /// type alias.
3632  bool TypeAlias : 1;
3633
3634  TemplateSpecializationType(TemplateName T,
3635                             const TemplateArgument *Args,
3636                             unsigned NumArgs, QualType Canon,
3637                             QualType Aliased);
3638
3639  friend class ASTContext;  // ASTContext creates these
3640
3641public:
3642  /// \brief Determine whether any of the given template arguments are
3643  /// dependent.
3644  static bool anyDependentTemplateArguments(const TemplateArgument *Args,
3645                                            unsigned NumArgs,
3646                                            bool &InstantiationDependent);
3647
3648  static bool anyDependentTemplateArguments(const TemplateArgumentLoc *Args,
3649                                            unsigned NumArgs,
3650                                            bool &InstantiationDependent);
3651
3652  static bool anyDependentTemplateArguments(const TemplateArgumentListInfo &,
3653                                            bool &InstantiationDependent);
3654
3655  /// \brief Print a template argument list, including the '<' and '>'
3656  /// enclosing the template arguments.
3657  static void PrintTemplateArgumentList(raw_ostream &OS,
3658                                        const TemplateArgument *Args,
3659                                        unsigned NumArgs,
3660                                        const PrintingPolicy &Policy,
3661                                        bool SkipBrackets = false);
3662
3663  static void PrintTemplateArgumentList(raw_ostream &OS,
3664                                        const TemplateArgumentLoc *Args,
3665                                        unsigned NumArgs,
3666                                        const PrintingPolicy &Policy);
3667
3668  static void PrintTemplateArgumentList(raw_ostream &OS,
3669                                        const TemplateArgumentListInfo &,
3670                                        const PrintingPolicy &Policy);
3671
3672  /// True if this template specialization type matches a current
3673  /// instantiation in the context in which it is found.
3674  bool isCurrentInstantiation() const {
3675    return isa<InjectedClassNameType>(getCanonicalTypeInternal());
3676  }
3677
3678  /// \brief Determine if this template specialization type is for a type alias
3679  /// template that has been substituted.
3680  ///
3681  /// Nearly every template specialization type whose template is an alias
3682  /// template will be substituted. However, this is not the case when
3683  /// the specialization contains a pack expansion but the template alias
3684  /// does not have a corresponding parameter pack, e.g.,
3685  ///
3686  /// \code
3687  /// template<typename T, typename U, typename V> struct S;
3688  /// template<typename T, typename U> using A = S<T, int, U>;
3689  /// template<typename... Ts> struct X {
3690  ///   typedef A<Ts...> type; // not a type alias
3691  /// };
3692  /// \endcode
3693  bool isTypeAlias() const { return TypeAlias; }
3694
3695  /// Get the aliased type, if this is a specialization of a type alias
3696  /// template.
3697  QualType getAliasedType() const {
3698    assert(isTypeAlias() && "not a type alias template specialization");
3699    return *reinterpret_cast<const QualType*>(end());
3700  }
3701
3702  typedef const TemplateArgument * iterator;
3703
3704  iterator begin() const { return getArgs(); }
3705  iterator end() const; // defined inline in TemplateBase.h
3706
3707  /// \brief Retrieve the name of the template that we are specializing.
3708  TemplateName getTemplateName() const { return Template; }
3709
3710  /// \brief Retrieve the template arguments.
3711  const TemplateArgument *getArgs() const {
3712    return reinterpret_cast<const TemplateArgument *>(this + 1);
3713  }
3714
3715  /// \brief Retrieve the number of template arguments.
3716  unsigned getNumArgs() const { return NumArgs; }
3717
3718  /// \brief Retrieve a specific template argument as a type.
3719  /// \pre @c isArgType(Arg)
3720  const TemplateArgument &getArg(unsigned Idx) const; // in TemplateBase.h
3721
3722  bool isSugared() const {
3723    return !isDependentType() || isCurrentInstantiation() || isTypeAlias();
3724  }
3725  QualType desugar() const { return getCanonicalTypeInternal(); }
3726
3727  void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Ctx) {
3728    Profile(ID, Template, getArgs(), NumArgs, Ctx);
3729    if (isTypeAlias())
3730      getAliasedType().Profile(ID);
3731  }
3732
3733  static void Profile(llvm::FoldingSetNodeID &ID, TemplateName T,
3734                      const TemplateArgument *Args,
3735                      unsigned NumArgs,
3736                      const ASTContext &Context);
3737
3738  static bool classof(const Type *T) {
3739    return T->getTypeClass() == TemplateSpecialization;
3740  }
3741};
3742
3743/// \brief The injected class name of a C++ class template or class
3744/// template partial specialization.  Used to record that a type was
3745/// spelled with a bare identifier rather than as a template-id; the
3746/// equivalent for non-templated classes is just RecordType.
3747///
3748/// Injected class name types are always dependent.  Template
3749/// instantiation turns these into RecordTypes.
3750///
3751/// Injected class name types are always canonical.  This works
3752/// because it is impossible to compare an injected class name type
3753/// with the corresponding non-injected template type, for the same
3754/// reason that it is impossible to directly compare template
3755/// parameters from different dependent contexts: injected class name
3756/// types can only occur within the scope of a particular templated
3757/// declaration, and within that scope every template specialization
3758/// will canonicalize to the injected class name (when appropriate
3759/// according to the rules of the language).
3760class InjectedClassNameType : public Type {
3761  CXXRecordDecl *Decl;
3762
3763  /// The template specialization which this type represents.
3764  /// For example, in
3765  ///   template <class T> class A { ... };
3766  /// this is A<T>, whereas in
3767  ///   template <class X, class Y> class A<B<X,Y> > { ... };
3768  /// this is A<B<X,Y> >.
3769  ///
3770  /// It is always unqualified, always a template specialization type,
3771  /// and always dependent.
3772  QualType InjectedType;
3773
3774  friend class ASTContext; // ASTContext creates these.
3775  friend class ASTReader; // FIXME: ASTContext::getInjectedClassNameType is not
3776                          // currently suitable for AST reading, too much
3777                          // interdependencies.
3778  InjectedClassNameType(CXXRecordDecl *D, QualType TST)
3779    : Type(InjectedClassName, QualType(), /*Dependent=*/true,
3780           /*InstantiationDependent=*/true,
3781           /*VariablyModified=*/false,
3782           /*ContainsUnexpandedParameterPack=*/false),
3783      Decl(D), InjectedType(TST) {
3784    assert(isa<TemplateSpecializationType>(TST));
3785    assert(!TST.hasQualifiers());
3786    assert(TST->isDependentType());
3787  }
3788
3789public:
3790  QualType getInjectedSpecializationType() const { return InjectedType; }
3791  const TemplateSpecializationType *getInjectedTST() const {
3792    return cast<TemplateSpecializationType>(InjectedType.getTypePtr());
3793  }
3794
3795  CXXRecordDecl *getDecl() const;
3796
3797  bool isSugared() const { return false; }
3798  QualType desugar() const { return QualType(this, 0); }
3799
3800  static bool classof(const Type *T) {
3801    return T->getTypeClass() == InjectedClassName;
3802  }
3803};
3804
3805/// \brief The kind of a tag type.
3806enum TagTypeKind {
3807  /// \brief The "struct" keyword.
3808  TTK_Struct,
3809  /// \brief The "__interface" keyword.
3810  TTK_Interface,
3811  /// \brief The "union" keyword.
3812  TTK_Union,
3813  /// \brief The "class" keyword.
3814  TTK_Class,
3815  /// \brief The "enum" keyword.
3816  TTK_Enum
3817};
3818
3819/// \brief The elaboration keyword that precedes a qualified type name or
3820/// introduces an elaborated-type-specifier.
3821enum ElaboratedTypeKeyword {
3822  /// \brief The "struct" keyword introduces the elaborated-type-specifier.
3823  ETK_Struct,
3824  /// \brief The "__interface" keyword introduces the elaborated-type-specifier.
3825  ETK_Interface,
3826  /// \brief The "union" keyword introduces the elaborated-type-specifier.
3827  ETK_Union,
3828  /// \brief The "class" keyword introduces the elaborated-type-specifier.
3829  ETK_Class,
3830  /// \brief The "enum" keyword introduces the elaborated-type-specifier.
3831  ETK_Enum,
3832  /// \brief The "typename" keyword precedes the qualified type name, e.g.,
3833  /// \c typename T::type.
3834  ETK_Typename,
3835  /// \brief No keyword precedes the qualified type name.
3836  ETK_None
3837};
3838
3839/// A helper class for Type nodes having an ElaboratedTypeKeyword.
3840/// The keyword in stored in the free bits of the base class.
3841/// Also provides a few static helpers for converting and printing
3842/// elaborated type keyword and tag type kind enumerations.
3843class TypeWithKeyword : public Type {
3844protected:
3845  TypeWithKeyword(ElaboratedTypeKeyword Keyword, TypeClass tc,
3846                  QualType Canonical, bool Dependent,
3847                  bool InstantiationDependent, bool VariablyModified,
3848                  bool ContainsUnexpandedParameterPack)
3849  : Type(tc, Canonical, Dependent, InstantiationDependent, VariablyModified,
3850         ContainsUnexpandedParameterPack) {
3851    TypeWithKeywordBits.Keyword = Keyword;
3852  }
3853
3854public:
3855  ElaboratedTypeKeyword getKeyword() const {
3856    return static_cast<ElaboratedTypeKeyword>(TypeWithKeywordBits.Keyword);
3857  }
3858
3859  /// getKeywordForTypeSpec - Converts a type specifier (DeclSpec::TST)
3860  /// into an elaborated type keyword.
3861  static ElaboratedTypeKeyword getKeywordForTypeSpec(unsigned TypeSpec);
3862
3863  /// getTagTypeKindForTypeSpec - Converts a type specifier (DeclSpec::TST)
3864  /// into a tag type kind.  It is an error to provide a type specifier
3865  /// which *isn't* a tag kind here.
3866  static TagTypeKind getTagTypeKindForTypeSpec(unsigned TypeSpec);
3867
3868  /// getKeywordForTagDeclKind - Converts a TagTypeKind into an
3869  /// elaborated type keyword.
3870  static ElaboratedTypeKeyword getKeywordForTagTypeKind(TagTypeKind Tag);
3871
3872  /// getTagTypeKindForKeyword - Converts an elaborated type keyword into
3873  // a TagTypeKind. It is an error to provide an elaborated type keyword
3874  /// which *isn't* a tag kind here.
3875  static TagTypeKind getTagTypeKindForKeyword(ElaboratedTypeKeyword Keyword);
3876
3877  static bool KeywordIsTagTypeKind(ElaboratedTypeKeyword Keyword);
3878
3879  static const char *getKeywordName(ElaboratedTypeKeyword Keyword);
3880
3881  static const char *getTagTypeKindName(TagTypeKind Kind) {
3882    return getKeywordName(getKeywordForTagTypeKind(Kind));
3883  }
3884
3885  class CannotCastToThisType {};
3886  static CannotCastToThisType classof(const Type *);
3887};
3888
3889/// \brief Represents a type that was referred to using an elaborated type
3890/// keyword, e.g., struct S, or via a qualified name, e.g., N::M::type,
3891/// or both.
3892///
3893/// This type is used to keep track of a type name as written in the
3894/// source code, including tag keywords and any nested-name-specifiers.
3895/// The type itself is always "sugar", used to express what was written
3896/// in the source code but containing no additional semantic information.
3897class ElaboratedType : public TypeWithKeyword, public llvm::FoldingSetNode {
3898
3899  /// \brief The nested name specifier containing the qualifier.
3900  NestedNameSpecifier *NNS;
3901
3902  /// \brief The type that this qualified name refers to.
3903  QualType NamedType;
3904
3905  ElaboratedType(ElaboratedTypeKeyword Keyword, NestedNameSpecifier *NNS,
3906                 QualType NamedType, QualType CanonType)
3907    : TypeWithKeyword(Keyword, Elaborated, CanonType,
3908                      NamedType->isDependentType(),
3909                      NamedType->isInstantiationDependentType(),
3910                      NamedType->isVariablyModifiedType(),
3911                      NamedType->containsUnexpandedParameterPack()),
3912      NNS(NNS), NamedType(NamedType) {
3913    assert(!(Keyword == ETK_None && NNS == 0) &&
3914           "ElaboratedType cannot have elaborated type keyword "
3915           "and name qualifier both null.");
3916  }
3917
3918  friend class ASTContext;  // ASTContext creates these
3919
3920public:
3921  ~ElaboratedType();
3922
3923  /// \brief Retrieve the qualification on this type.
3924  NestedNameSpecifier *getQualifier() const { return NNS; }
3925
3926  /// \brief Retrieve the type named by the qualified-id.
3927  QualType getNamedType() const { return NamedType; }
3928
3929  /// \brief Remove a single level of sugar.
3930  QualType desugar() const { return getNamedType(); }
3931
3932  /// \brief Returns whether this type directly provides sugar.
3933  bool isSugared() const { return true; }
3934
3935  void Profile(llvm::FoldingSetNodeID &ID) {
3936    Profile(ID, getKeyword(), NNS, NamedType);
3937  }
3938
3939  static void Profile(llvm::FoldingSetNodeID &ID, ElaboratedTypeKeyword Keyword,
3940                      NestedNameSpecifier *NNS, QualType NamedType) {
3941    ID.AddInteger(Keyword);
3942    ID.AddPointer(NNS);
3943    NamedType.Profile(ID);
3944  }
3945
3946  static bool classof(const Type *T) {
3947    return T->getTypeClass() == Elaborated;
3948  }
3949};
3950
3951/// \brief Represents a qualified type name for which the type name is
3952/// dependent.
3953///
3954/// DependentNameType represents a class of dependent types that involve a
3955/// dependent nested-name-specifier (e.g., "T::") followed by a (dependent)
3956/// name of a type. The DependentNameType may start with a "typename" (for a
3957/// typename-specifier), "class", "struct", "union", or "enum" (for a
3958/// dependent elaborated-type-specifier), or nothing (in contexts where we
3959/// know that we must be referring to a type, e.g., in a base class specifier).
3960class DependentNameType : public TypeWithKeyword, public llvm::FoldingSetNode {
3961
3962  /// \brief The nested name specifier containing the qualifier.
3963  NestedNameSpecifier *NNS;
3964
3965  /// \brief The type that this typename specifier refers to.
3966  const IdentifierInfo *Name;
3967
3968  DependentNameType(ElaboratedTypeKeyword Keyword, NestedNameSpecifier *NNS,
3969                    const IdentifierInfo *Name, QualType CanonType)
3970    : TypeWithKeyword(Keyword, DependentName, CanonType, /*Dependent=*/true,
3971                      /*InstantiationDependent=*/true,
3972                      /*VariablyModified=*/false,
3973                      NNS->containsUnexpandedParameterPack()),
3974      NNS(NNS), Name(Name) {
3975    assert(NNS->isDependent() &&
3976           "DependentNameType requires a dependent nested-name-specifier");
3977  }
3978
3979  friend class ASTContext;  // ASTContext creates these
3980
3981public:
3982  /// \brief Retrieve the qualification on this type.
3983  NestedNameSpecifier *getQualifier() const { return NNS; }
3984
3985  /// \brief Retrieve the type named by the typename specifier as an
3986  /// identifier.
3987  ///
3988  /// This routine will return a non-NULL identifier pointer when the
3989  /// form of the original typename was terminated by an identifier,
3990  /// e.g., "typename T::type".
3991  const IdentifierInfo *getIdentifier() const {
3992    return Name;
3993  }
3994
3995  bool isSugared() const { return false; }
3996  QualType desugar() const { return QualType(this, 0); }
3997
3998  void Profile(llvm::FoldingSetNodeID &ID) {
3999    Profile(ID, getKeyword(), NNS, Name);
4000  }
4001
4002  static void Profile(llvm::FoldingSetNodeID &ID, ElaboratedTypeKeyword Keyword,
4003                      NestedNameSpecifier *NNS, const IdentifierInfo *Name) {
4004    ID.AddInteger(Keyword);
4005    ID.AddPointer(NNS);
4006    ID.AddPointer(Name);
4007  }
4008
4009  static bool classof(const Type *T) {
4010    return T->getTypeClass() == DependentName;
4011  }
4012};
4013
4014/// DependentTemplateSpecializationType - Represents a template
4015/// specialization type whose template cannot be resolved, e.g.
4016///   A<T>::template B<T>
4017class DependentTemplateSpecializationType :
4018  public TypeWithKeyword, public llvm::FoldingSetNode {
4019
4020  /// \brief The nested name specifier containing the qualifier.
4021  NestedNameSpecifier *NNS;
4022
4023  /// \brief The identifier of the template.
4024  const IdentifierInfo *Name;
4025
4026  /// \brief - The number of template arguments named in this class
4027  /// template specialization.
4028  unsigned NumArgs;
4029
4030  const TemplateArgument *getArgBuffer() const {
4031    return reinterpret_cast<const TemplateArgument*>(this+1);
4032  }
4033  TemplateArgument *getArgBuffer() {
4034    return reinterpret_cast<TemplateArgument*>(this+1);
4035  }
4036
4037  DependentTemplateSpecializationType(ElaboratedTypeKeyword Keyword,
4038                                      NestedNameSpecifier *NNS,
4039                                      const IdentifierInfo *Name,
4040                                      unsigned NumArgs,
4041                                      const TemplateArgument *Args,
4042                                      QualType Canon);
4043
4044  friend class ASTContext;  // ASTContext creates these
4045
4046public:
4047  NestedNameSpecifier *getQualifier() const { return NNS; }
4048  const IdentifierInfo *getIdentifier() const { return Name; }
4049
4050  /// \brief Retrieve the template arguments.
4051  const TemplateArgument *getArgs() const {
4052    return getArgBuffer();
4053  }
4054
4055  /// \brief Retrieve the number of template arguments.
4056  unsigned getNumArgs() const { return NumArgs; }
4057
4058  const TemplateArgument &getArg(unsigned Idx) const; // in TemplateBase.h
4059
4060  typedef const TemplateArgument * iterator;
4061  iterator begin() const { return getArgs(); }
4062  iterator end() const; // inline in TemplateBase.h
4063
4064  bool isSugared() const { return false; }
4065  QualType desugar() const { return QualType(this, 0); }
4066
4067  void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context) {
4068    Profile(ID, Context, getKeyword(), NNS, Name, NumArgs, getArgs());
4069  }
4070
4071  static void Profile(llvm::FoldingSetNodeID &ID,
4072                      const ASTContext &Context,
4073                      ElaboratedTypeKeyword Keyword,
4074                      NestedNameSpecifier *Qualifier,
4075                      const IdentifierInfo *Name,
4076                      unsigned NumArgs,
4077                      const TemplateArgument *Args);
4078
4079  static bool classof(const Type *T) {
4080    return T->getTypeClass() == DependentTemplateSpecialization;
4081  }
4082};
4083
4084/// \brief Represents a pack expansion of types.
4085///
4086/// Pack expansions are part of C++0x variadic templates. A pack
4087/// expansion contains a pattern, which itself contains one or more
4088/// "unexpanded" parameter packs. When instantiated, a pack expansion
4089/// produces a series of types, each instantiated from the pattern of
4090/// the expansion, where the Ith instantiation of the pattern uses the
4091/// Ith arguments bound to each of the unexpanded parameter packs. The
4092/// pack expansion is considered to "expand" these unexpanded
4093/// parameter packs.
4094///
4095/// \code
4096/// template<typename ...Types> struct tuple;
4097///
4098/// template<typename ...Types>
4099/// struct tuple_of_references {
4100///   typedef tuple<Types&...> type;
4101/// };
4102/// \endcode
4103///
4104/// Here, the pack expansion \c Types&... is represented via a
4105/// PackExpansionType whose pattern is Types&.
4106class PackExpansionType : public Type, public llvm::FoldingSetNode {
4107  /// \brief The pattern of the pack expansion.
4108  QualType Pattern;
4109
4110  /// \brief The number of expansions that this pack expansion will
4111  /// generate when substituted (+1), or indicates that
4112  ///
4113  /// This field will only have a non-zero value when some of the parameter
4114  /// packs that occur within the pattern have been substituted but others have
4115  /// not.
4116  unsigned NumExpansions;
4117
4118  PackExpansionType(QualType Pattern, QualType Canon,
4119                    Optional<unsigned> NumExpansions)
4120    : Type(PackExpansion, Canon, /*Dependent=*/Pattern->isDependentType(),
4121           /*InstantiationDependent=*/true,
4122           /*VariableModified=*/Pattern->isVariablyModifiedType(),
4123           /*ContainsUnexpandedParameterPack=*/false),
4124      Pattern(Pattern),
4125      NumExpansions(NumExpansions? *NumExpansions + 1: 0) { }
4126
4127  friend class ASTContext;  // ASTContext creates these
4128
4129public:
4130  /// \brief Retrieve the pattern of this pack expansion, which is the
4131  /// type that will be repeatedly instantiated when instantiating the
4132  /// pack expansion itself.
4133  QualType getPattern() const { return Pattern; }
4134
4135  /// \brief Retrieve the number of expansions that this pack expansion will
4136  /// generate, if known.
4137  Optional<unsigned> getNumExpansions() const {
4138    if (NumExpansions)
4139      return NumExpansions - 1;
4140
4141    return None;
4142  }
4143
4144  bool isSugared() const { return false; }
4145  QualType desugar() const { return QualType(this, 0); }
4146
4147  void Profile(llvm::FoldingSetNodeID &ID) {
4148    Profile(ID, getPattern(), getNumExpansions());
4149  }
4150
4151  static void Profile(llvm::FoldingSetNodeID &ID, QualType Pattern,
4152                      Optional<unsigned> NumExpansions) {
4153    ID.AddPointer(Pattern.getAsOpaquePtr());
4154    ID.AddBoolean(NumExpansions.hasValue());
4155    if (NumExpansions)
4156      ID.AddInteger(*NumExpansions);
4157  }
4158
4159  static bool classof(const Type *T) {
4160    return T->getTypeClass() == PackExpansion;
4161  }
4162};
4163
4164/// ObjCObjectType - Represents a class type in Objective C.
4165/// Every Objective C type is a combination of a base type and a
4166/// list of protocols.
4167///
4168/// Given the following declarations:
4169/// \code
4170///   \@class C;
4171///   \@protocol P;
4172/// \endcode
4173///
4174/// 'C' is an ObjCInterfaceType C.  It is sugar for an ObjCObjectType
4175/// with base C and no protocols.
4176///
4177/// 'C<P>' is an ObjCObjectType with base C and protocol list [P].
4178///
4179/// 'id' is a TypedefType which is sugar for an ObjCPointerType whose
4180/// pointee is an ObjCObjectType with base BuiltinType::ObjCIdType
4181/// and no protocols.
4182///
4183/// 'id<P>' is an ObjCPointerType whose pointee is an ObjCObjecType
4184/// with base BuiltinType::ObjCIdType and protocol list [P].  Eventually
4185/// this should get its own sugar class to better represent the source.
4186class ObjCObjectType : public Type {
4187  // ObjCObjectType.NumProtocols - the number of protocols stored
4188  // after the ObjCObjectPointerType node.
4189  //
4190  // These protocols are those written directly on the type.  If
4191  // protocol qualifiers ever become additive, the iterators will need
4192  // to get kindof complicated.
4193  //
4194  // In the canonical object type, these are sorted alphabetically
4195  // and uniqued.
4196
4197  /// Either a BuiltinType or an InterfaceType or sugar for either.
4198  QualType BaseType;
4199
4200  ObjCProtocolDecl * const *getProtocolStorage() const {
4201    return const_cast<ObjCObjectType*>(this)->getProtocolStorage();
4202  }
4203
4204  ObjCProtocolDecl **getProtocolStorage();
4205
4206protected:
4207  ObjCObjectType(QualType Canonical, QualType Base,
4208                 ObjCProtocolDecl * const *Protocols, unsigned NumProtocols);
4209
4210  enum Nonce_ObjCInterface { Nonce_ObjCInterface };
4211  ObjCObjectType(enum Nonce_ObjCInterface)
4212        : Type(ObjCInterface, QualType(), false, false, false, false),
4213      BaseType(QualType(this_(), 0)) {
4214    ObjCObjectTypeBits.NumProtocols = 0;
4215  }
4216
4217public:
4218  /// getBaseType - Gets the base type of this object type.  This is
4219  /// always (possibly sugar for) one of:
4220  ///  - the 'id' builtin type (as opposed to the 'id' type visible to the
4221  ///    user, which is a typedef for an ObjCPointerType)
4222  ///  - the 'Class' builtin type (same caveat)
4223  ///  - an ObjCObjectType (currently always an ObjCInterfaceType)
4224  QualType getBaseType() const { return BaseType; }
4225
4226  bool isObjCId() const {
4227    return getBaseType()->isSpecificBuiltinType(BuiltinType::ObjCId);
4228  }
4229  bool isObjCClass() const {
4230    return getBaseType()->isSpecificBuiltinType(BuiltinType::ObjCClass);
4231  }
4232  bool isObjCUnqualifiedId() const { return qual_empty() && isObjCId(); }
4233  bool isObjCUnqualifiedClass() const { return qual_empty() && isObjCClass(); }
4234  bool isObjCUnqualifiedIdOrClass() const {
4235    if (!qual_empty()) return false;
4236    if (const BuiltinType *T = getBaseType()->getAs<BuiltinType>())
4237      return T->getKind() == BuiltinType::ObjCId ||
4238             T->getKind() == BuiltinType::ObjCClass;
4239    return false;
4240  }
4241  bool isObjCQualifiedId() const { return !qual_empty() && isObjCId(); }
4242  bool isObjCQualifiedClass() const { return !qual_empty() && isObjCClass(); }
4243
4244  /// Gets the interface declaration for this object type, if the base type
4245  /// really is an interface.
4246  ObjCInterfaceDecl *getInterface() const;
4247
4248  typedef ObjCProtocolDecl * const *qual_iterator;
4249
4250  qual_iterator qual_begin() const { return getProtocolStorage(); }
4251  qual_iterator qual_end() const { return qual_begin() + getNumProtocols(); }
4252
4253  bool qual_empty() const { return getNumProtocols() == 0; }
4254
4255  /// getNumProtocols - Return the number of qualifying protocols in this
4256  /// interface type, or 0 if there are none.
4257  unsigned getNumProtocols() const { return ObjCObjectTypeBits.NumProtocols; }
4258
4259  /// \brief Fetch a protocol by index.
4260  ObjCProtocolDecl *getProtocol(unsigned I) const {
4261    assert(I < getNumProtocols() && "Out-of-range protocol access");
4262    return qual_begin()[I];
4263  }
4264
4265  bool isSugared() const { return false; }
4266  QualType desugar() const { return QualType(this, 0); }
4267
4268  static bool classof(const Type *T) {
4269    return T->getTypeClass() == ObjCObject ||
4270           T->getTypeClass() == ObjCInterface;
4271  }
4272};
4273
4274/// ObjCObjectTypeImpl - A class providing a concrete implementation
4275/// of ObjCObjectType, so as to not increase the footprint of
4276/// ObjCInterfaceType.  Code outside of ASTContext and the core type
4277/// system should not reference this type.
4278class ObjCObjectTypeImpl : public ObjCObjectType, public llvm::FoldingSetNode {
4279  friend class ASTContext;
4280
4281  // If anyone adds fields here, ObjCObjectType::getProtocolStorage()
4282  // will need to be modified.
4283
4284  ObjCObjectTypeImpl(QualType Canonical, QualType Base,
4285                     ObjCProtocolDecl * const *Protocols,
4286                     unsigned NumProtocols)
4287    : ObjCObjectType(Canonical, Base, Protocols, NumProtocols) {}
4288
4289public:
4290  void Profile(llvm::FoldingSetNodeID &ID);
4291  static void Profile(llvm::FoldingSetNodeID &ID,
4292                      QualType Base,
4293                      ObjCProtocolDecl *const *protocols,
4294                      unsigned NumProtocols);
4295};
4296
4297inline ObjCProtocolDecl **ObjCObjectType::getProtocolStorage() {
4298  return reinterpret_cast<ObjCProtocolDecl**>(
4299            static_cast<ObjCObjectTypeImpl*>(this) + 1);
4300}
4301
4302/// ObjCInterfaceType - Interfaces are the core concept in Objective-C for
4303/// object oriented design.  They basically correspond to C++ classes.  There
4304/// are two kinds of interface types, normal interfaces like "NSString" and
4305/// qualified interfaces, which are qualified with a protocol list like
4306/// "NSString<NSCopyable, NSAmazing>".
4307///
4308/// ObjCInterfaceType guarantees the following properties when considered
4309/// as a subtype of its superclass, ObjCObjectType:
4310///   - There are no protocol qualifiers.  To reinforce this, code which
4311///     tries to invoke the protocol methods via an ObjCInterfaceType will
4312///     fail to compile.
4313///   - It is its own base type.  That is, if T is an ObjCInterfaceType*,
4314///     T->getBaseType() == QualType(T, 0).
4315class ObjCInterfaceType : public ObjCObjectType {
4316  mutable ObjCInterfaceDecl *Decl;
4317
4318  ObjCInterfaceType(const ObjCInterfaceDecl *D)
4319    : ObjCObjectType(Nonce_ObjCInterface),
4320      Decl(const_cast<ObjCInterfaceDecl*>(D)) {}
4321  friend class ASTContext;  // ASTContext creates these.
4322  friend class ASTReader;
4323  friend class ObjCInterfaceDecl;
4324
4325public:
4326  /// getDecl - Get the declaration of this interface.
4327  ObjCInterfaceDecl *getDecl() const { return Decl; }
4328
4329  bool isSugared() const { return false; }
4330  QualType desugar() const { return QualType(this, 0); }
4331
4332  static bool classof(const Type *T) {
4333    return T->getTypeClass() == ObjCInterface;
4334  }
4335
4336  // Nonsense to "hide" certain members of ObjCObjectType within this
4337  // class.  People asking for protocols on an ObjCInterfaceType are
4338  // not going to get what they want: ObjCInterfaceTypes are
4339  // guaranteed to have no protocols.
4340  enum {
4341    qual_iterator,
4342    qual_begin,
4343    qual_end,
4344    getNumProtocols,
4345    getProtocol
4346  };
4347};
4348
4349inline ObjCInterfaceDecl *ObjCObjectType::getInterface() const {
4350  if (const ObjCInterfaceType *T =
4351        getBaseType()->getAs<ObjCInterfaceType>())
4352    return T->getDecl();
4353  return 0;
4354}
4355
4356/// ObjCObjectPointerType - Used to represent a pointer to an
4357/// Objective C object.  These are constructed from pointer
4358/// declarators when the pointee type is an ObjCObjectType (or sugar
4359/// for one).  In addition, the 'id' and 'Class' types are typedefs
4360/// for these, and the protocol-qualified types 'id<P>' and 'Class<P>'
4361/// are translated into these.
4362///
4363/// Pointers to pointers to Objective C objects are still PointerTypes;
4364/// only the first level of pointer gets it own type implementation.
4365class ObjCObjectPointerType : public Type, public llvm::FoldingSetNode {
4366  QualType PointeeType;
4367
4368  ObjCObjectPointerType(QualType Canonical, QualType Pointee)
4369    : Type(ObjCObjectPointer, Canonical, false, false, false, false),
4370      PointeeType(Pointee) {}
4371  friend class ASTContext;  // ASTContext creates these.
4372
4373public:
4374  /// getPointeeType - Gets the type pointed to by this ObjC pointer.
4375  /// The result will always be an ObjCObjectType or sugar thereof.
4376  QualType getPointeeType() const { return PointeeType; }
4377
4378  /// getObjCObjectType - Gets the type pointed to by this ObjC
4379  /// pointer.  This method always returns non-null.
4380  ///
4381  /// This method is equivalent to getPointeeType() except that
4382  /// it discards any typedefs (or other sugar) between this
4383  /// type and the "outermost" object type.  So for:
4384  /// \code
4385  ///   \@class A; \@protocol P; \@protocol Q;
4386  ///   typedef A<P> AP;
4387  ///   typedef A A1;
4388  ///   typedef A1<P> A1P;
4389  ///   typedef A1P<Q> A1PQ;
4390  /// \endcode
4391  /// For 'A*', getObjectType() will return 'A'.
4392  /// For 'A<P>*', getObjectType() will return 'A<P>'.
4393  /// For 'AP*', getObjectType() will return 'A<P>'.
4394  /// For 'A1*', getObjectType() will return 'A'.
4395  /// For 'A1<P>*', getObjectType() will return 'A1<P>'.
4396  /// For 'A1P*', getObjectType() will return 'A1<P>'.
4397  /// For 'A1PQ*', getObjectType() will return 'A1<Q>', because
4398  ///   adding protocols to a protocol-qualified base discards the
4399  ///   old qualifiers (for now).  But if it didn't, getObjectType()
4400  ///   would return 'A1P<Q>' (and we'd have to make iterating over
4401  ///   qualifiers more complicated).
4402  const ObjCObjectType *getObjectType() const {
4403    return PointeeType->castAs<ObjCObjectType>();
4404  }
4405
4406  /// getInterfaceType - If this pointer points to an Objective C
4407  /// \@interface type, gets the type for that interface.  Any protocol
4408  /// qualifiers on the interface are ignored.
4409  ///
4410  /// \return null if the base type for this pointer is 'id' or 'Class'
4411  const ObjCInterfaceType *getInterfaceType() const {
4412    return getObjectType()->getBaseType()->getAs<ObjCInterfaceType>();
4413  }
4414
4415  /// getInterfaceDecl - If this pointer points to an Objective \@interface
4416  /// type, gets the declaration for that interface.
4417  ///
4418  /// \return null if the base type for this pointer is 'id' or 'Class'
4419  ObjCInterfaceDecl *getInterfaceDecl() const {
4420    return getObjectType()->getInterface();
4421  }
4422
4423  /// isObjCIdType - True if this is equivalent to the 'id' type, i.e. if
4424  /// its object type is the primitive 'id' type with no protocols.
4425  bool isObjCIdType() const {
4426    return getObjectType()->isObjCUnqualifiedId();
4427  }
4428
4429  /// isObjCClassType - True if this is equivalent to the 'Class' type,
4430  /// i.e. if its object tive is the primitive 'Class' type with no protocols.
4431  bool isObjCClassType() const {
4432    return getObjectType()->isObjCUnqualifiedClass();
4433  }
4434
4435  /// isObjCQualifiedIdType - True if this is equivalent to 'id<P>' for some
4436  /// non-empty set of protocols.
4437  bool isObjCQualifiedIdType() const {
4438    return getObjectType()->isObjCQualifiedId();
4439  }
4440
4441  /// isObjCQualifiedClassType - True if this is equivalent to 'Class<P>' for
4442  /// some non-empty set of protocols.
4443  bool isObjCQualifiedClassType() const {
4444    return getObjectType()->isObjCQualifiedClass();
4445  }
4446
4447  /// An iterator over the qualifiers on the object type.  Provided
4448  /// for convenience.  This will always iterate over the full set of
4449  /// protocols on a type, not just those provided directly.
4450  typedef ObjCObjectType::qual_iterator qual_iterator;
4451
4452  qual_iterator qual_begin() const {
4453    return getObjectType()->qual_begin();
4454  }
4455  qual_iterator qual_end() const {
4456    return getObjectType()->qual_end();
4457  }
4458  bool qual_empty() const { return getObjectType()->qual_empty(); }
4459
4460  /// getNumProtocols - Return the number of qualifying protocols on
4461  /// the object type.
4462  unsigned getNumProtocols() const {
4463    return getObjectType()->getNumProtocols();
4464  }
4465
4466  /// \brief Retrieve a qualifying protocol by index on the object
4467  /// type.
4468  ObjCProtocolDecl *getProtocol(unsigned I) const {
4469    return getObjectType()->getProtocol(I);
4470  }
4471
4472  bool isSugared() const { return false; }
4473  QualType desugar() const { return QualType(this, 0); }
4474
4475  void Profile(llvm::FoldingSetNodeID &ID) {
4476    Profile(ID, getPointeeType());
4477  }
4478  static void Profile(llvm::FoldingSetNodeID &ID, QualType T) {
4479    ID.AddPointer(T.getAsOpaquePtr());
4480  }
4481  static bool classof(const Type *T) {
4482    return T->getTypeClass() == ObjCObjectPointer;
4483  }
4484};
4485
4486class AtomicType : public Type, public llvm::FoldingSetNode {
4487  QualType ValueType;
4488
4489  AtomicType(QualType ValTy, QualType Canonical)
4490    : Type(Atomic, Canonical, ValTy->isDependentType(),
4491           ValTy->isInstantiationDependentType(),
4492           ValTy->isVariablyModifiedType(),
4493           ValTy->containsUnexpandedParameterPack()),
4494      ValueType(ValTy) {}
4495  friend class ASTContext;  // ASTContext creates these.
4496
4497  public:
4498  /// getValueType - Gets the type contained by this atomic type, i.e.
4499  /// the type returned by performing an atomic load of this atomic type.
4500  QualType getValueType() const { return ValueType; }
4501
4502  bool isSugared() const { return false; }
4503  QualType desugar() const { return QualType(this, 0); }
4504
4505  void Profile(llvm::FoldingSetNodeID &ID) {
4506    Profile(ID, getValueType());
4507  }
4508  static void Profile(llvm::FoldingSetNodeID &ID, QualType T) {
4509    ID.AddPointer(T.getAsOpaquePtr());
4510  }
4511  static bool classof(const Type *T) {
4512    return T->getTypeClass() == Atomic;
4513  }
4514};
4515
4516/// A qualifier set is used to build a set of qualifiers.
4517class QualifierCollector : public Qualifiers {
4518public:
4519  QualifierCollector(Qualifiers Qs = Qualifiers()) : Qualifiers(Qs) {}
4520
4521  /// Collect any qualifiers on the given type and return an
4522  /// unqualified type.  The qualifiers are assumed to be consistent
4523  /// with those already in the type.
4524  const Type *strip(QualType type) {
4525    addFastQualifiers(type.getLocalFastQualifiers());
4526    if (!type.hasLocalNonFastQualifiers())
4527      return type.getTypePtrUnsafe();
4528
4529    const ExtQuals *extQuals = type.getExtQualsUnsafe();
4530    addConsistentQualifiers(extQuals->getQualifiers());
4531    return extQuals->getBaseType();
4532  }
4533
4534  /// Apply the collected qualifiers to the given type.
4535  QualType apply(const ASTContext &Context, QualType QT) const;
4536
4537  /// Apply the collected qualifiers to the given type.
4538  QualType apply(const ASTContext &Context, const Type* T) const;
4539};
4540
4541
4542// Inline function definitions.
4543
4544inline SplitQualType SplitQualType::getSingleStepDesugaredType() const {
4545  SplitQualType desugar =
4546    Ty->getLocallyUnqualifiedSingleStepDesugaredType().split();
4547  desugar.Quals.addConsistentQualifiers(Quals);
4548  return desugar;
4549}
4550
4551inline const Type *QualType::getTypePtr() const {
4552  return getCommonPtr()->BaseType;
4553}
4554
4555inline const Type *QualType::getTypePtrOrNull() const {
4556  return (isNull() ? 0 : getCommonPtr()->BaseType);
4557}
4558
4559inline SplitQualType QualType::split() const {
4560  if (!hasLocalNonFastQualifiers())
4561    return SplitQualType(getTypePtrUnsafe(),
4562                         Qualifiers::fromFastMask(getLocalFastQualifiers()));
4563
4564  const ExtQuals *eq = getExtQualsUnsafe();
4565  Qualifiers qs = eq->getQualifiers();
4566  qs.addFastQualifiers(getLocalFastQualifiers());
4567  return SplitQualType(eq->getBaseType(), qs);
4568}
4569
4570inline Qualifiers QualType::getLocalQualifiers() const {
4571  Qualifiers Quals;
4572  if (hasLocalNonFastQualifiers())
4573    Quals = getExtQualsUnsafe()->getQualifiers();
4574  Quals.addFastQualifiers(getLocalFastQualifiers());
4575  return Quals;
4576}
4577
4578inline Qualifiers QualType::getQualifiers() const {
4579  Qualifiers quals = getCommonPtr()->CanonicalType.getLocalQualifiers();
4580  quals.addFastQualifiers(getLocalFastQualifiers());
4581  return quals;
4582}
4583
4584inline unsigned QualType::getCVRQualifiers() const {
4585  unsigned cvr = getCommonPtr()->CanonicalType.getLocalCVRQualifiers();
4586  cvr |= getLocalCVRQualifiers();
4587  return cvr;
4588}
4589
4590inline QualType QualType::getCanonicalType() const {
4591  QualType canon = getCommonPtr()->CanonicalType;
4592  return canon.withFastQualifiers(getLocalFastQualifiers());
4593}
4594
4595inline bool QualType::isCanonical() const {
4596  return getTypePtr()->isCanonicalUnqualified();
4597}
4598
4599inline bool QualType::isCanonicalAsParam() const {
4600  if (!isCanonical()) return false;
4601  if (hasLocalQualifiers()) return false;
4602
4603  const Type *T = getTypePtr();
4604  if (T->isVariablyModifiedType() && T->hasSizedVLAType())
4605    return false;
4606
4607  return !isa<FunctionType>(T) && !isa<ArrayType>(T);
4608}
4609
4610inline bool QualType::isConstQualified() const {
4611  return isLocalConstQualified() ||
4612         getCommonPtr()->CanonicalType.isLocalConstQualified();
4613}
4614
4615inline bool QualType::isRestrictQualified() const {
4616  return isLocalRestrictQualified() ||
4617         getCommonPtr()->CanonicalType.isLocalRestrictQualified();
4618}
4619
4620
4621inline bool QualType::isVolatileQualified() const {
4622  return isLocalVolatileQualified() ||
4623         getCommonPtr()->CanonicalType.isLocalVolatileQualified();
4624}
4625
4626inline bool QualType::hasQualifiers() const {
4627  return hasLocalQualifiers() ||
4628         getCommonPtr()->CanonicalType.hasLocalQualifiers();
4629}
4630
4631inline QualType QualType::getUnqualifiedType() const {
4632  if (!getTypePtr()->getCanonicalTypeInternal().hasLocalQualifiers())
4633    return QualType(getTypePtr(), 0);
4634
4635  return QualType(getSplitUnqualifiedTypeImpl(*this).Ty, 0);
4636}
4637
4638inline SplitQualType QualType::getSplitUnqualifiedType() const {
4639  if (!getTypePtr()->getCanonicalTypeInternal().hasLocalQualifiers())
4640    return split();
4641
4642  return getSplitUnqualifiedTypeImpl(*this);
4643}
4644
4645inline void QualType::removeLocalConst() {
4646  removeLocalFastQualifiers(Qualifiers::Const);
4647}
4648
4649inline void QualType::removeLocalRestrict() {
4650  removeLocalFastQualifiers(Qualifiers::Restrict);
4651}
4652
4653inline void QualType::removeLocalVolatile() {
4654  removeLocalFastQualifiers(Qualifiers::Volatile);
4655}
4656
4657inline void QualType::removeLocalCVRQualifiers(unsigned Mask) {
4658  assert(!(Mask & ~Qualifiers::CVRMask) && "mask has non-CVR bits");
4659  assert((int)Qualifiers::CVRMask == (int)Qualifiers::FastMask);
4660
4661  // Fast path: we don't need to touch the slow qualifiers.
4662  removeLocalFastQualifiers(Mask);
4663}
4664
4665/// getAddressSpace - Return the address space of this type.
4666inline unsigned QualType::getAddressSpace() const {
4667  return getQualifiers().getAddressSpace();
4668}
4669
4670/// getObjCGCAttr - Return the gc attribute of this type.
4671inline Qualifiers::GC QualType::getObjCGCAttr() const {
4672  return getQualifiers().getObjCGCAttr();
4673}
4674
4675inline FunctionType::ExtInfo getFunctionExtInfo(const Type &t) {
4676  if (const PointerType *PT = t.getAs<PointerType>()) {
4677    if (const FunctionType *FT = PT->getPointeeType()->getAs<FunctionType>())
4678      return FT->getExtInfo();
4679  } else if (const FunctionType *FT = t.getAs<FunctionType>())
4680    return FT->getExtInfo();
4681
4682  return FunctionType::ExtInfo();
4683}
4684
4685inline FunctionType::ExtInfo getFunctionExtInfo(QualType t) {
4686  return getFunctionExtInfo(*t);
4687}
4688
4689/// isMoreQualifiedThan - Determine whether this type is more
4690/// qualified than the Other type. For example, "const volatile int"
4691/// is more qualified than "const int", "volatile int", and
4692/// "int". However, it is not more qualified than "const volatile
4693/// int".
4694inline bool QualType::isMoreQualifiedThan(QualType other) const {
4695  Qualifiers myQuals = getQualifiers();
4696  Qualifiers otherQuals = other.getQualifiers();
4697  return (myQuals != otherQuals && myQuals.compatiblyIncludes(otherQuals));
4698}
4699
4700/// isAtLeastAsQualifiedAs - Determine whether this type is at last
4701/// as qualified as the Other type. For example, "const volatile
4702/// int" is at least as qualified as "const int", "volatile int",
4703/// "int", and "const volatile int".
4704inline bool QualType::isAtLeastAsQualifiedAs(QualType other) const {
4705  return getQualifiers().compatiblyIncludes(other.getQualifiers());
4706}
4707
4708/// getNonReferenceType - If Type is a reference type (e.g., const
4709/// int&), returns the type that the reference refers to ("const
4710/// int"). Otherwise, returns the type itself. This routine is used
4711/// throughout Sema to implement C++ 5p6:
4712///
4713///   If an expression initially has the type "reference to T" (8.3.2,
4714///   8.5.3), the type is adjusted to "T" prior to any further
4715///   analysis, the expression designates the object or function
4716///   denoted by the reference, and the expression is an lvalue.
4717inline QualType QualType::getNonReferenceType() const {
4718  if (const ReferenceType *RefType = (*this)->getAs<ReferenceType>())
4719    return RefType->getPointeeType();
4720  else
4721    return *this;
4722}
4723
4724inline bool QualType::isCForbiddenLValueType() const {
4725  return ((getTypePtr()->isVoidType() && !hasQualifiers()) ||
4726          getTypePtr()->isFunctionType());
4727}
4728
4729/// \brief Tests whether the type is categorized as a fundamental type.
4730///
4731/// \returns True for types specified in C++0x [basic.fundamental].
4732inline bool Type::isFundamentalType() const {
4733  return isVoidType() ||
4734         // FIXME: It's really annoying that we don't have an
4735         // 'isArithmeticType()' which agrees with the standard definition.
4736         (isArithmeticType() && !isEnumeralType());
4737}
4738
4739/// \brief Tests whether the type is categorized as a compound type.
4740///
4741/// \returns True for types specified in C++0x [basic.compound].
4742inline bool Type::isCompoundType() const {
4743  // C++0x [basic.compound]p1:
4744  //   Compound types can be constructed in the following ways:
4745  //    -- arrays of objects of a given type [...];
4746  return isArrayType() ||
4747  //    -- functions, which have parameters of given types [...];
4748         isFunctionType() ||
4749  //    -- pointers to void or objects or functions [...];
4750         isPointerType() ||
4751  //    -- references to objects or functions of a given type. [...]
4752         isReferenceType() ||
4753  //    -- classes containing a sequence of objects of various types, [...];
4754         isRecordType() ||
4755  //    -- unions, which are classes capable of containing objects of different
4756  //               types at different times;
4757         isUnionType() ||
4758  //    -- enumerations, which comprise a set of named constant values. [...];
4759         isEnumeralType() ||
4760  //    -- pointers to non-static class members, [...].
4761         isMemberPointerType();
4762}
4763
4764inline bool Type::isFunctionType() const {
4765  return isa<FunctionType>(CanonicalType);
4766}
4767inline bool Type::isPointerType() const {
4768  return isa<PointerType>(CanonicalType);
4769}
4770inline bool Type::isAnyPointerType() const {
4771  return isPointerType() || isObjCObjectPointerType();
4772}
4773inline bool Type::isBlockPointerType() const {
4774  return isa<BlockPointerType>(CanonicalType);
4775}
4776inline bool Type::isReferenceType() const {
4777  return isa<ReferenceType>(CanonicalType);
4778}
4779inline bool Type::isLValueReferenceType() const {
4780  return isa<LValueReferenceType>(CanonicalType);
4781}
4782inline bool Type::isRValueReferenceType() const {
4783  return isa<RValueReferenceType>(CanonicalType);
4784}
4785inline bool Type::isFunctionPointerType() const {
4786  if (const PointerType *T = getAs<PointerType>())
4787    return T->getPointeeType()->isFunctionType();
4788  else
4789    return false;
4790}
4791inline bool Type::isMemberPointerType() const {
4792  return isa<MemberPointerType>(CanonicalType);
4793}
4794inline bool Type::isMemberFunctionPointerType() const {
4795  if (const MemberPointerType* T = getAs<MemberPointerType>())
4796    return T->isMemberFunctionPointer();
4797  else
4798    return false;
4799}
4800inline bool Type::isMemberDataPointerType() const {
4801  if (const MemberPointerType* T = getAs<MemberPointerType>())
4802    return T->isMemberDataPointer();
4803  else
4804    return false;
4805}
4806inline bool Type::isArrayType() const {
4807  return isa<ArrayType>(CanonicalType);
4808}
4809inline bool Type::isConstantArrayType() const {
4810  return isa<ConstantArrayType>(CanonicalType);
4811}
4812inline bool Type::isIncompleteArrayType() const {
4813  return isa<IncompleteArrayType>(CanonicalType);
4814}
4815inline bool Type::isVariableArrayType() const {
4816  return isa<VariableArrayType>(CanonicalType);
4817}
4818inline bool Type::isDependentSizedArrayType() const {
4819  return isa<DependentSizedArrayType>(CanonicalType);
4820}
4821inline bool Type::isBuiltinType() const {
4822  return isa<BuiltinType>(CanonicalType);
4823}
4824inline bool Type::isRecordType() const {
4825  return isa<RecordType>(CanonicalType);
4826}
4827inline bool Type::isEnumeralType() const {
4828  return isa<EnumType>(CanonicalType);
4829}
4830inline bool Type::isAnyComplexType() const {
4831  return isa<ComplexType>(CanonicalType);
4832}
4833inline bool Type::isVectorType() const {
4834  return isa<VectorType>(CanonicalType);
4835}
4836inline bool Type::isExtVectorType() const {
4837  return isa<ExtVectorType>(CanonicalType);
4838}
4839inline bool Type::isObjCObjectPointerType() const {
4840  return isa<ObjCObjectPointerType>(CanonicalType);
4841}
4842inline bool Type::isObjCObjectType() const {
4843  return isa<ObjCObjectType>(CanonicalType);
4844}
4845inline bool Type::isObjCObjectOrInterfaceType() const {
4846  return isa<ObjCInterfaceType>(CanonicalType) ||
4847    isa<ObjCObjectType>(CanonicalType);
4848}
4849inline bool Type::isAtomicType() const {
4850  return isa<AtomicType>(CanonicalType);
4851}
4852
4853inline bool Type::isObjCQualifiedIdType() const {
4854  if (const ObjCObjectPointerType *OPT = getAs<ObjCObjectPointerType>())
4855    return OPT->isObjCQualifiedIdType();
4856  return false;
4857}
4858inline bool Type::isObjCQualifiedClassType() const {
4859  if (const ObjCObjectPointerType *OPT = getAs<ObjCObjectPointerType>())
4860    return OPT->isObjCQualifiedClassType();
4861  return false;
4862}
4863inline bool Type::isObjCIdType() const {
4864  if (const ObjCObjectPointerType *OPT = getAs<ObjCObjectPointerType>())
4865    return OPT->isObjCIdType();
4866  return false;
4867}
4868inline bool Type::isObjCClassType() const {
4869  if (const ObjCObjectPointerType *OPT = getAs<ObjCObjectPointerType>())
4870    return OPT->isObjCClassType();
4871  return false;
4872}
4873inline bool Type::isObjCSelType() const {
4874  if (const PointerType *OPT = getAs<PointerType>())
4875    return OPT->getPointeeType()->isSpecificBuiltinType(BuiltinType::ObjCSel);
4876  return false;
4877}
4878inline bool Type::isObjCBuiltinType() const {
4879  return isObjCIdType() || isObjCClassType() || isObjCSelType();
4880}
4881
4882inline bool Type::isImage1dT() const {
4883  return isSpecificBuiltinType(BuiltinType::OCLImage1d);
4884}
4885
4886inline bool Type::isImage1dArrayT() const {
4887  return isSpecificBuiltinType(BuiltinType::OCLImage1dArray);
4888}
4889
4890inline bool Type::isImage1dBufferT() const {
4891  return isSpecificBuiltinType(BuiltinType::OCLImage1dBuffer);
4892}
4893
4894inline bool Type::isImage2dT() const {
4895  return isSpecificBuiltinType(BuiltinType::OCLImage2d);
4896}
4897
4898inline bool Type::isImage2dArrayT() const {
4899  return isSpecificBuiltinType(BuiltinType::OCLImage2dArray);
4900}
4901
4902inline bool Type::isImage3dT() const {
4903  return isSpecificBuiltinType(BuiltinType::OCLImage3d);
4904}
4905
4906inline bool Type::isSamplerT() const {
4907  return isSpecificBuiltinType(BuiltinType::OCLSampler);
4908}
4909
4910inline bool Type::isEventT() const {
4911  return isSpecificBuiltinType(BuiltinType::OCLEvent);
4912}
4913
4914inline bool Type::isImageType() const {
4915  return isImage3dT() ||
4916         isImage2dT() || isImage2dArrayT() ||
4917         isImage1dT() || isImage1dArrayT() || isImage1dBufferT();
4918}
4919
4920inline bool Type::isOpenCLSpecificType() const {
4921  return isSamplerT() || isEventT() || isImageType();
4922}
4923
4924inline bool Type::isTemplateTypeParmType() const {
4925  return isa<TemplateTypeParmType>(CanonicalType);
4926}
4927
4928inline bool Type::isSpecificBuiltinType(unsigned K) const {
4929  if (const BuiltinType *BT = getAs<BuiltinType>())
4930    if (BT->getKind() == (BuiltinType::Kind) K)
4931      return true;
4932  return false;
4933}
4934
4935inline bool Type::isPlaceholderType() const {
4936  if (const BuiltinType *BT = dyn_cast<BuiltinType>(this))
4937    return BT->isPlaceholderType();
4938  return false;
4939}
4940
4941inline const BuiltinType *Type::getAsPlaceholderType() const {
4942  if (const BuiltinType *BT = dyn_cast<BuiltinType>(this))
4943    if (BT->isPlaceholderType())
4944      return BT;
4945  return 0;
4946}
4947
4948inline bool Type::isSpecificPlaceholderType(unsigned K) const {
4949  assert(BuiltinType::isPlaceholderTypeKind((BuiltinType::Kind) K));
4950  if (const BuiltinType *BT = dyn_cast<BuiltinType>(this))
4951    return (BT->getKind() == (BuiltinType::Kind) K);
4952  return false;
4953}
4954
4955inline bool Type::isNonOverloadPlaceholderType() const {
4956  if (const BuiltinType *BT = dyn_cast<BuiltinType>(this))
4957    return BT->isNonOverloadPlaceholderType();
4958  return false;
4959}
4960
4961inline bool Type::isVoidType() const {
4962  if (const BuiltinType *BT = dyn_cast<BuiltinType>(CanonicalType))
4963    return BT->getKind() == BuiltinType::Void;
4964  return false;
4965}
4966
4967inline bool Type::isHalfType() const {
4968  if (const BuiltinType *BT = dyn_cast<BuiltinType>(CanonicalType))
4969    return BT->getKind() == BuiltinType::Half;
4970  // FIXME: Should we allow complex __fp16? Probably not.
4971  return false;
4972}
4973
4974inline bool Type::isNullPtrType() const {
4975  if (const BuiltinType *BT = getAs<BuiltinType>())
4976    return BT->getKind() == BuiltinType::NullPtr;
4977  return false;
4978}
4979
4980extern bool IsEnumDeclComplete(EnumDecl *);
4981extern bool IsEnumDeclScoped(EnumDecl *);
4982
4983inline bool Type::isIntegerType() const {
4984  if (const BuiltinType *BT = dyn_cast<BuiltinType>(CanonicalType))
4985    return BT->getKind() >= BuiltinType::Bool &&
4986           BT->getKind() <= BuiltinType::Int128;
4987  if (const EnumType *ET = dyn_cast<EnumType>(CanonicalType)) {
4988    // Incomplete enum types are not treated as integer types.
4989    // FIXME: In C++, enum types are never integer types.
4990    return IsEnumDeclComplete(ET->getDecl()) &&
4991      !IsEnumDeclScoped(ET->getDecl());
4992  }
4993  return false;
4994}
4995
4996inline bool Type::isScalarType() const {
4997  if (const BuiltinType *BT = dyn_cast<BuiltinType>(CanonicalType))
4998    return BT->getKind() > BuiltinType::Void &&
4999           BT->getKind() <= BuiltinType::NullPtr;
5000  if (const EnumType *ET = dyn_cast<EnumType>(CanonicalType))
5001    // Enums are scalar types, but only if they are defined.  Incomplete enums
5002    // are not treated as scalar types.
5003    return IsEnumDeclComplete(ET->getDecl());
5004  return isa<PointerType>(CanonicalType) ||
5005         isa<BlockPointerType>(CanonicalType) ||
5006         isa<MemberPointerType>(CanonicalType) ||
5007         isa<ComplexType>(CanonicalType) ||
5008         isa<ObjCObjectPointerType>(CanonicalType);
5009}
5010
5011inline bool Type::isIntegralOrEnumerationType() const {
5012  if (const BuiltinType *BT = dyn_cast<BuiltinType>(CanonicalType))
5013    return BT->getKind() >= BuiltinType::Bool &&
5014           BT->getKind() <= BuiltinType::Int128;
5015
5016  // Check for a complete enum type; incomplete enum types are not properly an
5017  // enumeration type in the sense required here.
5018  if (const EnumType *ET = dyn_cast<EnumType>(CanonicalType))
5019    return IsEnumDeclComplete(ET->getDecl());
5020
5021  return false;
5022}
5023
5024inline bool Type::isBooleanType() const {
5025  if (const BuiltinType *BT = dyn_cast<BuiltinType>(CanonicalType))
5026    return BT->getKind() == BuiltinType::Bool;
5027  return false;
5028}
5029
5030/// \brief Determines whether this is a type for which one can define
5031/// an overloaded operator.
5032inline bool Type::isOverloadableType() const {
5033  return isDependentType() || isRecordType() || isEnumeralType();
5034}
5035
5036/// \brief Determines whether this type can decay to a pointer type.
5037inline bool Type::canDecayToPointerType() const {
5038  return isFunctionType() || isArrayType();
5039}
5040
5041inline bool Type::hasPointerRepresentation() const {
5042  return (isPointerType() || isReferenceType() || isBlockPointerType() ||
5043          isObjCObjectPointerType() || isNullPtrType());
5044}
5045
5046inline bool Type::hasObjCPointerRepresentation() const {
5047  return isObjCObjectPointerType();
5048}
5049
5050inline const Type *Type::getBaseElementTypeUnsafe() const {
5051  const Type *type = this;
5052  while (const ArrayType *arrayType = type->getAsArrayTypeUnsafe())
5053    type = arrayType->getElementType().getTypePtr();
5054  return type;
5055}
5056
5057/// Insertion operator for diagnostics.  This allows sending QualType's into a
5058/// diagnostic with <<.
5059inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
5060                                           QualType T) {
5061  DB.AddTaggedVal(reinterpret_cast<intptr_t>(T.getAsOpaquePtr()),
5062                  DiagnosticsEngine::ak_qualtype);
5063  return DB;
5064}
5065
5066/// Insertion operator for partial diagnostics.  This allows sending QualType's
5067/// into a diagnostic with <<.
5068inline const PartialDiagnostic &operator<<(const PartialDiagnostic &PD,
5069                                           QualType T) {
5070  PD.AddTaggedVal(reinterpret_cast<intptr_t>(T.getAsOpaquePtr()),
5071                  DiagnosticsEngine::ak_qualtype);
5072  return PD;
5073}
5074
5075// Helper class template that is used by Type::getAs to ensure that one does
5076// not try to look through a qualified type to get to an array type.
5077template<typename T,
5078         bool isArrayType = (llvm::is_same<T, ArrayType>::value ||
5079                             llvm::is_base_of<ArrayType, T>::value)>
5080struct ArrayType_cannot_be_used_with_getAs { };
5081
5082template<typename T>
5083struct ArrayType_cannot_be_used_with_getAs<T, true>;
5084
5085// Member-template getAs<specific type>'.
5086template <typename T> const T *Type::getAs() const {
5087  ArrayType_cannot_be_used_with_getAs<T> at;
5088  (void)at;
5089
5090  // If this is directly a T type, return it.
5091  if (const T *Ty = dyn_cast<T>(this))
5092    return Ty;
5093
5094  // If the canonical form of this type isn't the right kind, reject it.
5095  if (!isa<T>(CanonicalType))
5096    return 0;
5097
5098  // If this is a typedef for the type, strip the typedef off without
5099  // losing all typedef information.
5100  return cast<T>(getUnqualifiedDesugaredType());
5101}
5102
5103inline const ArrayType *Type::getAsArrayTypeUnsafe() const {
5104  // If this is directly an array type, return it.
5105  if (const ArrayType *arr = dyn_cast<ArrayType>(this))
5106    return arr;
5107
5108  // If the canonical form of this type isn't the right kind, reject it.
5109  if (!isa<ArrayType>(CanonicalType))
5110    return 0;
5111
5112  // If this is a typedef for the type, strip the typedef off without
5113  // losing all typedef information.
5114  return cast<ArrayType>(getUnqualifiedDesugaredType());
5115}
5116
5117template <typename T> const T *Type::castAs() const {
5118  ArrayType_cannot_be_used_with_getAs<T> at;
5119  (void) at;
5120
5121  assert(isa<T>(CanonicalType));
5122  if (const T *ty = dyn_cast<T>(this)) return ty;
5123  return cast<T>(getUnqualifiedDesugaredType());
5124}
5125
5126inline const ArrayType *Type::castAsArrayTypeUnsafe() const {
5127  assert(isa<ArrayType>(CanonicalType));
5128  if (const ArrayType *arr = dyn_cast<ArrayType>(this)) return arr;
5129  return cast<ArrayType>(getUnqualifiedDesugaredType());
5130}
5131
5132}  // end namespace clang
5133
5134#endif
5135