ASTContext.cpp revision 736104a7619c53ef92553780273d7357a3cdde81
1//===--- ASTContext.cpp - Context to hold long-lived AST nodes ------------===//
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 implements the ASTContext interface.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/AST/ASTContext.h"
15#include "CXXABI.h"
16#include "clang/AST/ASTMutationListener.h"
17#include "clang/AST/Attr.h"
18#include "clang/AST/CharUnits.h"
19#include "clang/AST/Comment.h"
20#include "clang/AST/CommentCommandTraits.h"
21#include "clang/AST/DeclCXX.h"
22#include "clang/AST/DeclObjC.h"
23#include "clang/AST/DeclTemplate.h"
24#include "clang/AST/Expr.h"
25#include "clang/AST/ExprCXX.h"
26#include "clang/AST/ExternalASTSource.h"
27#include "clang/AST/Mangle.h"
28#include "clang/AST/RecordLayout.h"
29#include "clang/AST/TypeLoc.h"
30#include "clang/Basic/Builtins.h"
31#include "clang/Basic/SourceManager.h"
32#include "clang/Basic/TargetInfo.h"
33#include "llvm/ADT/SmallString.h"
34#include "llvm/ADT/StringExtras.h"
35#include "llvm/Support/Capacity.h"
36#include "llvm/Support/MathExtras.h"
37#include "llvm/Support/raw_ostream.h"
38#include <map>
39
40using namespace clang;
41
42unsigned ASTContext::NumImplicitDefaultConstructors;
43unsigned ASTContext::NumImplicitDefaultConstructorsDeclared;
44unsigned ASTContext::NumImplicitCopyConstructors;
45unsigned ASTContext::NumImplicitCopyConstructorsDeclared;
46unsigned ASTContext::NumImplicitMoveConstructors;
47unsigned ASTContext::NumImplicitMoveConstructorsDeclared;
48unsigned ASTContext::NumImplicitCopyAssignmentOperators;
49unsigned ASTContext::NumImplicitCopyAssignmentOperatorsDeclared;
50unsigned ASTContext::NumImplicitMoveAssignmentOperators;
51unsigned ASTContext::NumImplicitMoveAssignmentOperatorsDeclared;
52unsigned ASTContext::NumImplicitDestructors;
53unsigned ASTContext::NumImplicitDestructorsDeclared;
54
55enum FloatingRank {
56  HalfRank, FloatRank, DoubleRank, LongDoubleRank
57};
58
59RawComment *ASTContext::getRawCommentForDeclNoCache(const Decl *D) const {
60  if (!CommentsLoaded && ExternalSource) {
61    ExternalSource->ReadComments();
62    CommentsLoaded = true;
63  }
64
65  assert(D);
66
67  // User can not attach documentation to implicit declarations.
68  if (D->isImplicit())
69    return NULL;
70
71  // User can not attach documentation to implicit instantiations.
72  if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
73    if (FD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
74      return NULL;
75  }
76
77  if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
78    if (VD->isStaticDataMember() &&
79        VD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
80      return NULL;
81  }
82
83  if (const CXXRecordDecl *CRD = dyn_cast<CXXRecordDecl>(D)) {
84    if (CRD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
85      return NULL;
86  }
87
88  if (const EnumDecl *ED = dyn_cast<EnumDecl>(D)) {
89    if (ED->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
90      return NULL;
91  }
92
93  // TODO: handle comments for function parameters properly.
94  if (isa<ParmVarDecl>(D))
95    return NULL;
96
97  // TODO: we could look up template parameter documentation in the template
98  // documentation.
99  if (isa<TemplateTypeParmDecl>(D) ||
100      isa<NonTypeTemplateParmDecl>(D) ||
101      isa<TemplateTemplateParmDecl>(D))
102    return NULL;
103
104  ArrayRef<RawComment *> RawComments = Comments.getComments();
105
106  // If there are no comments anywhere, we won't find anything.
107  if (RawComments.empty())
108    return NULL;
109
110  // Find declaration location.
111  // For Objective-C declarations we generally don't expect to have multiple
112  // declarators, thus use declaration starting location as the "declaration
113  // location".
114  // For all other declarations multiple declarators are used quite frequently,
115  // so we use the location of the identifier as the "declaration location".
116  SourceLocation DeclLoc;
117  if (isa<ObjCMethodDecl>(D) || isa<ObjCContainerDecl>(D) ||
118      isa<ObjCPropertyDecl>(D) ||
119      isa<RedeclarableTemplateDecl>(D) ||
120      isa<ClassTemplateSpecializationDecl>(D))
121    DeclLoc = D->getLocStart();
122  else
123    DeclLoc = D->getLocation();
124
125  // If the declaration doesn't map directly to a location in a file, we
126  // can't find the comment.
127  if (DeclLoc.isInvalid() || !DeclLoc.isFileID())
128    return NULL;
129
130  // Find the comment that occurs just after this declaration.
131  ArrayRef<RawComment *>::iterator Comment;
132  {
133    // When searching for comments during parsing, the comment we are looking
134    // for is usually among the last two comments we parsed -- check them
135    // first.
136    RawComment CommentAtDeclLoc(SourceMgr, SourceRange(DeclLoc));
137    BeforeThanCompare<RawComment> Compare(SourceMgr);
138    ArrayRef<RawComment *>::iterator MaybeBeforeDecl = RawComments.end() - 1;
139    bool Found = Compare(*MaybeBeforeDecl, &CommentAtDeclLoc);
140    if (!Found && RawComments.size() >= 2) {
141      MaybeBeforeDecl--;
142      Found = Compare(*MaybeBeforeDecl, &CommentAtDeclLoc);
143    }
144
145    if (Found) {
146      Comment = MaybeBeforeDecl + 1;
147      assert(Comment == std::lower_bound(RawComments.begin(), RawComments.end(),
148                                         &CommentAtDeclLoc, Compare));
149    } else {
150      // Slow path.
151      Comment = std::lower_bound(RawComments.begin(), RawComments.end(),
152                                 &CommentAtDeclLoc, Compare);
153    }
154  }
155
156  // Decompose the location for the declaration and find the beginning of the
157  // file buffer.
158  std::pair<FileID, unsigned> DeclLocDecomp = SourceMgr.getDecomposedLoc(DeclLoc);
159
160  // First check whether we have a trailing comment.
161  if (Comment != RawComments.end() &&
162      (*Comment)->isDocumentation() && (*Comment)->isTrailingComment() &&
163      (isa<FieldDecl>(D) || isa<EnumConstantDecl>(D) || isa<VarDecl>(D))) {
164    std::pair<FileID, unsigned> CommentBeginDecomp
165      = SourceMgr.getDecomposedLoc((*Comment)->getSourceRange().getBegin());
166    // Check that Doxygen trailing comment comes after the declaration, starts
167    // on the same line and in the same file as the declaration.
168    if (DeclLocDecomp.first == CommentBeginDecomp.first &&
169        SourceMgr.getLineNumber(DeclLocDecomp.first, DeclLocDecomp.second)
170          == SourceMgr.getLineNumber(CommentBeginDecomp.first,
171                                     CommentBeginDecomp.second)) {
172      return *Comment;
173    }
174  }
175
176  // The comment just after the declaration was not a trailing comment.
177  // Let's look at the previous comment.
178  if (Comment == RawComments.begin())
179    return NULL;
180  --Comment;
181
182  // Check that we actually have a non-member Doxygen comment.
183  if (!(*Comment)->isDocumentation() || (*Comment)->isTrailingComment())
184    return NULL;
185
186  // Decompose the end of the comment.
187  std::pair<FileID, unsigned> CommentEndDecomp
188    = SourceMgr.getDecomposedLoc((*Comment)->getSourceRange().getEnd());
189
190  // If the comment and the declaration aren't in the same file, then they
191  // aren't related.
192  if (DeclLocDecomp.first != CommentEndDecomp.first)
193    return NULL;
194
195  // Get the corresponding buffer.
196  bool Invalid = false;
197  const char *Buffer = SourceMgr.getBufferData(DeclLocDecomp.first,
198                                               &Invalid).data();
199  if (Invalid)
200    return NULL;
201
202  // Extract text between the comment and declaration.
203  StringRef Text(Buffer + CommentEndDecomp.second,
204                 DeclLocDecomp.second - CommentEndDecomp.second);
205
206  // There should be no other declarations or preprocessor directives between
207  // comment and declaration.
208  if (Text.find_first_of(",;{}#@") != StringRef::npos)
209    return NULL;
210
211  return *Comment;
212}
213
214namespace {
215/// If we have a 'templated' declaration for a template, adjust 'D' to
216/// refer to the actual template.
217/// If we have an implicit instantiation, adjust 'D' to refer to template.
218const Decl *adjustDeclToTemplate(const Decl *D) {
219  if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
220    // Is this function declaration part of a function template?
221    if (const FunctionTemplateDecl *FTD = FD->getDescribedFunctionTemplate())
222      return FTD;
223
224    // Nothing to do if function is not an implicit instantiation.
225    if (FD->getTemplateSpecializationKind() != TSK_ImplicitInstantiation)
226      return D;
227
228    // Function is an implicit instantiation of a function template?
229    if (const FunctionTemplateDecl *FTD = FD->getPrimaryTemplate())
230      return FTD;
231
232    // Function is instantiated from a member definition of a class template?
233    if (const FunctionDecl *MemberDecl =
234            FD->getInstantiatedFromMemberFunction())
235      return MemberDecl;
236
237    return D;
238  }
239  if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
240    // Static data member is instantiated from a member definition of a class
241    // template?
242    if (VD->isStaticDataMember())
243      if (const VarDecl *MemberDecl = VD->getInstantiatedFromStaticDataMember())
244        return MemberDecl;
245
246    return D;
247  }
248  if (const CXXRecordDecl *CRD = dyn_cast<CXXRecordDecl>(D)) {
249    // Is this class declaration part of a class template?
250    if (const ClassTemplateDecl *CTD = CRD->getDescribedClassTemplate())
251      return CTD;
252
253    // Class is an implicit instantiation of a class template or partial
254    // specialization?
255    if (const ClassTemplateSpecializationDecl *CTSD =
256            dyn_cast<ClassTemplateSpecializationDecl>(CRD)) {
257      if (CTSD->getSpecializationKind() != TSK_ImplicitInstantiation)
258        return D;
259      llvm::PointerUnion<ClassTemplateDecl *,
260                         ClassTemplatePartialSpecializationDecl *>
261          PU = CTSD->getSpecializedTemplateOrPartial();
262      return PU.is<ClassTemplateDecl*>() ?
263          static_cast<const Decl*>(PU.get<ClassTemplateDecl *>()) :
264          static_cast<const Decl*>(
265              PU.get<ClassTemplatePartialSpecializationDecl *>());
266    }
267
268    // Class is instantiated from a member definition of a class template?
269    if (const MemberSpecializationInfo *Info =
270                   CRD->getMemberSpecializationInfo())
271      return Info->getInstantiatedFrom();
272
273    return D;
274  }
275  if (const EnumDecl *ED = dyn_cast<EnumDecl>(D)) {
276    // Enum is instantiated from a member definition of a class template?
277    if (const EnumDecl *MemberDecl = ED->getInstantiatedFromMemberEnum())
278      return MemberDecl;
279
280    return D;
281  }
282  // FIXME: Adjust alias templates?
283  return D;
284}
285} // unnamed namespace
286
287const RawComment *ASTContext::getRawCommentForAnyRedecl(
288                                                const Decl *D,
289                                                const Decl **OriginalDecl) const {
290  D = adjustDeclToTemplate(D);
291
292  // Check whether we have cached a comment for this declaration already.
293  {
294    llvm::DenseMap<const Decl *, RawCommentAndCacheFlags>::iterator Pos =
295        RedeclComments.find(D);
296    if (Pos != RedeclComments.end()) {
297      const RawCommentAndCacheFlags &Raw = Pos->second;
298      if (Raw.getKind() != RawCommentAndCacheFlags::NoCommentInDecl) {
299        if (OriginalDecl)
300          *OriginalDecl = Raw.getOriginalDecl();
301        return Raw.getRaw();
302      }
303    }
304  }
305
306  // Search for comments attached to declarations in the redeclaration chain.
307  const RawComment *RC = NULL;
308  const Decl *OriginalDeclForRC = NULL;
309  for (Decl::redecl_iterator I = D->redecls_begin(),
310                             E = D->redecls_end();
311       I != E; ++I) {
312    llvm::DenseMap<const Decl *, RawCommentAndCacheFlags>::iterator Pos =
313        RedeclComments.find(*I);
314    if (Pos != RedeclComments.end()) {
315      const RawCommentAndCacheFlags &Raw = Pos->second;
316      if (Raw.getKind() != RawCommentAndCacheFlags::NoCommentInDecl) {
317        RC = Raw.getRaw();
318        OriginalDeclForRC = Raw.getOriginalDecl();
319        break;
320      }
321    } else {
322      RC = getRawCommentForDeclNoCache(*I);
323      OriginalDeclForRC = *I;
324      RawCommentAndCacheFlags Raw;
325      if (RC) {
326        Raw.setRaw(RC);
327        Raw.setKind(RawCommentAndCacheFlags::FromDecl);
328      } else
329        Raw.setKind(RawCommentAndCacheFlags::NoCommentInDecl);
330      Raw.setOriginalDecl(*I);
331      RedeclComments[*I] = Raw;
332      if (RC)
333        break;
334    }
335  }
336
337  // If we found a comment, it should be a documentation comment.
338  assert(!RC || RC->isDocumentation());
339
340  if (OriginalDecl)
341    *OriginalDecl = OriginalDeclForRC;
342
343  // Update cache for every declaration in the redeclaration chain.
344  RawCommentAndCacheFlags Raw;
345  Raw.setRaw(RC);
346  Raw.setKind(RawCommentAndCacheFlags::FromRedecl);
347  Raw.setOriginalDecl(OriginalDeclForRC);
348
349  for (Decl::redecl_iterator I = D->redecls_begin(),
350                             E = D->redecls_end();
351       I != E; ++I) {
352    RawCommentAndCacheFlags &R = RedeclComments[*I];
353    if (R.getKind() == RawCommentAndCacheFlags::NoCommentInDecl)
354      R = Raw;
355  }
356
357  return RC;
358}
359
360static void addRedeclaredMethods(const ObjCMethodDecl *ObjCMethod,
361                   SmallVectorImpl<const NamedDecl *> &Redeclared) {
362  const DeclContext *DC = ObjCMethod->getDeclContext();
363  if (const ObjCImplDecl *IMD = dyn_cast<ObjCImplDecl>(DC)) {
364    const ObjCInterfaceDecl *ID = IMD->getClassInterface();
365    if (!ID)
366      return;
367    // Add redeclared method here.
368    for (const ObjCCategoryDecl *ClsExtDecl = ID->getFirstClassExtension();
369         ClsExtDecl; ClsExtDecl = ClsExtDecl->getNextClassExtension()) {
370      if (ObjCMethodDecl *RedeclaredMethod =
371            ClsExtDecl->getMethod(ObjCMethod->getSelector(),
372                                  ObjCMethod->isInstanceMethod()))
373        Redeclared.push_back(RedeclaredMethod);
374    }
375  }
376}
377
378comments::FullComment *ASTContext::cloneFullComment(comments::FullComment *FC,
379                                                    const Decl *D) const {
380  comments::DeclInfo *ThisDeclInfo = new (*this) comments::DeclInfo;
381  ThisDeclInfo->CommentDecl = D;
382  ThisDeclInfo->IsFilled = false;
383  ThisDeclInfo->fill();
384  ThisDeclInfo->CommentDecl = FC->getDecl();
385  comments::FullComment *CFC =
386    new (*this) comments::FullComment(FC->getBlocks(),
387                                      ThisDeclInfo);
388  return CFC;
389
390}
391
392comments::FullComment *ASTContext::getCommentForDecl(
393                                              const Decl *D,
394                                              const Preprocessor *PP) const {
395  D = adjustDeclToTemplate(D);
396
397  const Decl *Canonical = D->getCanonicalDecl();
398  llvm::DenseMap<const Decl *, comments::FullComment *>::iterator Pos =
399      ParsedComments.find(Canonical);
400
401  if (Pos != ParsedComments.end()) {
402    if (Canonical != D) {
403      comments::FullComment *FC = Pos->second;
404      comments::FullComment *CFC = cloneFullComment(FC, D);
405      return CFC;
406    }
407    return Pos->second;
408  }
409
410  const Decl *OriginalDecl;
411
412  const RawComment *RC = getRawCommentForAnyRedecl(D, &OriginalDecl);
413  if (!RC) {
414    if (isa<ObjCMethodDecl>(D) || isa<FunctionDecl>(D)) {
415      SmallVector<const NamedDecl*, 8> Overridden;
416      if (const ObjCMethodDecl *OMD = dyn_cast<ObjCMethodDecl>(D))
417        addRedeclaredMethods(OMD, Overridden);
418      getOverriddenMethods(dyn_cast<NamedDecl>(D), Overridden);
419      for (unsigned i = 0, e = Overridden.size(); i < e; i++) {
420        if (comments::FullComment *FC = getCommentForDecl(Overridden[i], PP)) {
421          comments::FullComment *CFC = cloneFullComment(FC, D);
422          return CFC;
423        }
424      }
425    }
426    return NULL;
427  }
428
429  // If the RawComment was attached to other redeclaration of this Decl, we
430  // should parse the comment in context of that other Decl.  This is important
431  // because comments can contain references to parameter names which can be
432  // different across redeclarations.
433  if (D != OriginalDecl)
434    return getCommentForDecl(OriginalDecl, PP);
435
436  comments::FullComment *FC = RC->parse(*this, PP, D);
437  ParsedComments[Canonical] = FC;
438  return FC;
439}
440
441void
442ASTContext::CanonicalTemplateTemplateParm::Profile(llvm::FoldingSetNodeID &ID,
443                                               TemplateTemplateParmDecl *Parm) {
444  ID.AddInteger(Parm->getDepth());
445  ID.AddInteger(Parm->getPosition());
446  ID.AddBoolean(Parm->isParameterPack());
447
448  TemplateParameterList *Params = Parm->getTemplateParameters();
449  ID.AddInteger(Params->size());
450  for (TemplateParameterList::const_iterator P = Params->begin(),
451                                          PEnd = Params->end();
452       P != PEnd; ++P) {
453    if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(*P)) {
454      ID.AddInteger(0);
455      ID.AddBoolean(TTP->isParameterPack());
456      continue;
457    }
458
459    if (NonTypeTemplateParmDecl *NTTP = dyn_cast<NonTypeTemplateParmDecl>(*P)) {
460      ID.AddInteger(1);
461      ID.AddBoolean(NTTP->isParameterPack());
462      ID.AddPointer(NTTP->getType().getCanonicalType().getAsOpaquePtr());
463      if (NTTP->isExpandedParameterPack()) {
464        ID.AddBoolean(true);
465        ID.AddInteger(NTTP->getNumExpansionTypes());
466        for (unsigned I = 0, N = NTTP->getNumExpansionTypes(); I != N; ++I) {
467          QualType T = NTTP->getExpansionType(I);
468          ID.AddPointer(T.getCanonicalType().getAsOpaquePtr());
469        }
470      } else
471        ID.AddBoolean(false);
472      continue;
473    }
474
475    TemplateTemplateParmDecl *TTP = cast<TemplateTemplateParmDecl>(*P);
476    ID.AddInteger(2);
477    Profile(ID, TTP);
478  }
479}
480
481TemplateTemplateParmDecl *
482ASTContext::getCanonicalTemplateTemplateParmDecl(
483                                          TemplateTemplateParmDecl *TTP) const {
484  // Check if we already have a canonical template template parameter.
485  llvm::FoldingSetNodeID ID;
486  CanonicalTemplateTemplateParm::Profile(ID, TTP);
487  void *InsertPos = 0;
488  CanonicalTemplateTemplateParm *Canonical
489    = CanonTemplateTemplateParms.FindNodeOrInsertPos(ID, InsertPos);
490  if (Canonical)
491    return Canonical->getParam();
492
493  // Build a canonical template parameter list.
494  TemplateParameterList *Params = TTP->getTemplateParameters();
495  SmallVector<NamedDecl *, 4> CanonParams;
496  CanonParams.reserve(Params->size());
497  for (TemplateParameterList::const_iterator P = Params->begin(),
498                                          PEnd = Params->end();
499       P != PEnd; ++P) {
500    if (TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(*P))
501      CanonParams.push_back(
502                  TemplateTypeParmDecl::Create(*this, getTranslationUnitDecl(),
503                                               SourceLocation(),
504                                               SourceLocation(),
505                                               TTP->getDepth(),
506                                               TTP->getIndex(), 0, false,
507                                               TTP->isParameterPack()));
508    else if (NonTypeTemplateParmDecl *NTTP
509             = dyn_cast<NonTypeTemplateParmDecl>(*P)) {
510      QualType T = getCanonicalType(NTTP->getType());
511      TypeSourceInfo *TInfo = getTrivialTypeSourceInfo(T);
512      NonTypeTemplateParmDecl *Param;
513      if (NTTP->isExpandedParameterPack()) {
514        SmallVector<QualType, 2> ExpandedTypes;
515        SmallVector<TypeSourceInfo *, 2> ExpandedTInfos;
516        for (unsigned I = 0, N = NTTP->getNumExpansionTypes(); I != N; ++I) {
517          ExpandedTypes.push_back(getCanonicalType(NTTP->getExpansionType(I)));
518          ExpandedTInfos.push_back(
519                                getTrivialTypeSourceInfo(ExpandedTypes.back()));
520        }
521
522        Param = NonTypeTemplateParmDecl::Create(*this, getTranslationUnitDecl(),
523                                                SourceLocation(),
524                                                SourceLocation(),
525                                                NTTP->getDepth(),
526                                                NTTP->getPosition(), 0,
527                                                T,
528                                                TInfo,
529                                                ExpandedTypes.data(),
530                                                ExpandedTypes.size(),
531                                                ExpandedTInfos.data());
532      } else {
533        Param = NonTypeTemplateParmDecl::Create(*this, getTranslationUnitDecl(),
534                                                SourceLocation(),
535                                                SourceLocation(),
536                                                NTTP->getDepth(),
537                                                NTTP->getPosition(), 0,
538                                                T,
539                                                NTTP->isParameterPack(),
540                                                TInfo);
541      }
542      CanonParams.push_back(Param);
543
544    } else
545      CanonParams.push_back(getCanonicalTemplateTemplateParmDecl(
546                                           cast<TemplateTemplateParmDecl>(*P)));
547  }
548
549  TemplateTemplateParmDecl *CanonTTP
550    = TemplateTemplateParmDecl::Create(*this, getTranslationUnitDecl(),
551                                       SourceLocation(), TTP->getDepth(),
552                                       TTP->getPosition(),
553                                       TTP->isParameterPack(),
554                                       0,
555                         TemplateParameterList::Create(*this, SourceLocation(),
556                                                       SourceLocation(),
557                                                       CanonParams.data(),
558                                                       CanonParams.size(),
559                                                       SourceLocation()));
560
561  // Get the new insert position for the node we care about.
562  Canonical = CanonTemplateTemplateParms.FindNodeOrInsertPos(ID, InsertPos);
563  assert(Canonical == 0 && "Shouldn't be in the map!");
564  (void)Canonical;
565
566  // Create the canonical template template parameter entry.
567  Canonical = new (*this) CanonicalTemplateTemplateParm(CanonTTP);
568  CanonTemplateTemplateParms.InsertNode(Canonical, InsertPos);
569  return CanonTTP;
570}
571
572CXXABI *ASTContext::createCXXABI(const TargetInfo &T) {
573  if (!LangOpts.CPlusPlus) return 0;
574
575  switch (T.getCXXABI()) {
576  case CXXABI_ARM:
577    return CreateARMCXXABI(*this);
578  case CXXABI_Itanium:
579    return CreateItaniumCXXABI(*this);
580  case CXXABI_Microsoft:
581    return CreateMicrosoftCXXABI(*this);
582  }
583  llvm_unreachable("Invalid CXXABI type!");
584}
585
586static const LangAS::Map *getAddressSpaceMap(const TargetInfo &T,
587                                             const LangOptions &LOpts) {
588  if (LOpts.FakeAddressSpaceMap) {
589    // The fake address space map must have a distinct entry for each
590    // language-specific address space.
591    static const unsigned FakeAddrSpaceMap[] = {
592      1, // opencl_global
593      2, // opencl_local
594      3, // opencl_constant
595      4, // cuda_device
596      5, // cuda_constant
597      6  // cuda_shared
598    };
599    return &FakeAddrSpaceMap;
600  } else {
601    return &T.getAddressSpaceMap();
602  }
603}
604
605ASTContext::ASTContext(LangOptions& LOpts, SourceManager &SM,
606                       const TargetInfo *t,
607                       IdentifierTable &idents, SelectorTable &sels,
608                       Builtin::Context &builtins,
609                       unsigned size_reserve,
610                       bool DelayInitialization)
611  : FunctionProtoTypes(this_()),
612    TemplateSpecializationTypes(this_()),
613    DependentTemplateSpecializationTypes(this_()),
614    SubstTemplateTemplateParmPacks(this_()),
615    GlobalNestedNameSpecifier(0),
616    Int128Decl(0), UInt128Decl(0),
617    BuiltinVaListDecl(0),
618    ObjCIdDecl(0), ObjCSelDecl(0), ObjCClassDecl(0), ObjCProtocolClassDecl(0),
619    BOOLDecl(0),
620    CFConstantStringTypeDecl(0), ObjCInstanceTypeDecl(0),
621    FILEDecl(0),
622    jmp_bufDecl(0), sigjmp_bufDecl(0), ucontext_tDecl(0),
623    BlockDescriptorType(0), BlockDescriptorExtendedType(0),
624    cudaConfigureCallDecl(0),
625    NullTypeSourceInfo(QualType()),
626    FirstLocalImport(), LastLocalImport(),
627    SourceMgr(SM), LangOpts(LOpts),
628    AddrSpaceMap(0), Target(t), PrintingPolicy(LOpts),
629    Idents(idents), Selectors(sels),
630    BuiltinInfo(builtins),
631    DeclarationNames(*this),
632    ExternalSource(0), Listener(0),
633    Comments(SM), CommentsLoaded(false),
634    CommentCommandTraits(BumpAlloc),
635    LastSDM(0, 0),
636    UniqueBlockByRefTypeID(0)
637{
638  if (size_reserve > 0) Types.reserve(size_reserve);
639  TUDecl = TranslationUnitDecl::Create(*this);
640
641  if (!DelayInitialization) {
642    assert(t && "No target supplied for ASTContext initialization");
643    InitBuiltinTypes(*t);
644  }
645}
646
647ASTContext::~ASTContext() {
648  // Release the DenseMaps associated with DeclContext objects.
649  // FIXME: Is this the ideal solution?
650  ReleaseDeclContextMaps();
651
652  // Call all of the deallocation functions.
653  for (unsigned I = 0, N = Deallocations.size(); I != N; ++I)
654    Deallocations[I].first(Deallocations[I].second);
655
656  // ASTRecordLayout objects in ASTRecordLayouts must always be destroyed
657  // because they can contain DenseMaps.
658  for (llvm::DenseMap<const ObjCContainerDecl*,
659       const ASTRecordLayout*>::iterator
660       I = ObjCLayouts.begin(), E = ObjCLayouts.end(); I != E; )
661    // Increment in loop to prevent using deallocated memory.
662    if (ASTRecordLayout *R = const_cast<ASTRecordLayout*>((I++)->second))
663      R->Destroy(*this);
664
665  for (llvm::DenseMap<const RecordDecl*, const ASTRecordLayout*>::iterator
666       I = ASTRecordLayouts.begin(), E = ASTRecordLayouts.end(); I != E; ) {
667    // Increment in loop to prevent using deallocated memory.
668    if (ASTRecordLayout *R = const_cast<ASTRecordLayout*>((I++)->second))
669      R->Destroy(*this);
670  }
671
672  for (llvm::DenseMap<const Decl*, AttrVec*>::iterator A = DeclAttrs.begin(),
673                                                    AEnd = DeclAttrs.end();
674       A != AEnd; ++A)
675    A->second->~AttrVec();
676}
677
678void ASTContext::AddDeallocation(void (*Callback)(void*), void *Data) {
679  Deallocations.push_back(std::make_pair(Callback, Data));
680}
681
682void
683ASTContext::setExternalSource(OwningPtr<ExternalASTSource> &Source) {
684  ExternalSource.reset(Source.take());
685}
686
687void ASTContext::PrintStats() const {
688  llvm::errs() << "\n*** AST Context Stats:\n";
689  llvm::errs() << "  " << Types.size() << " types total.\n";
690
691  unsigned counts[] = {
692#define TYPE(Name, Parent) 0,
693#define ABSTRACT_TYPE(Name, Parent)
694#include "clang/AST/TypeNodes.def"
695    0 // Extra
696  };
697
698  for (unsigned i = 0, e = Types.size(); i != e; ++i) {
699    Type *T = Types[i];
700    counts[(unsigned)T->getTypeClass()]++;
701  }
702
703  unsigned Idx = 0;
704  unsigned TotalBytes = 0;
705#define TYPE(Name, Parent)                                              \
706  if (counts[Idx])                                                      \
707    llvm::errs() << "    " << counts[Idx] << " " << #Name               \
708                 << " types\n";                                         \
709  TotalBytes += counts[Idx] * sizeof(Name##Type);                       \
710  ++Idx;
711#define ABSTRACT_TYPE(Name, Parent)
712#include "clang/AST/TypeNodes.def"
713
714  llvm::errs() << "Total bytes = " << TotalBytes << "\n";
715
716  // Implicit special member functions.
717  llvm::errs() << NumImplicitDefaultConstructorsDeclared << "/"
718               << NumImplicitDefaultConstructors
719               << " implicit default constructors created\n";
720  llvm::errs() << NumImplicitCopyConstructorsDeclared << "/"
721               << NumImplicitCopyConstructors
722               << " implicit copy constructors created\n";
723  if (getLangOpts().CPlusPlus)
724    llvm::errs() << NumImplicitMoveConstructorsDeclared << "/"
725                 << NumImplicitMoveConstructors
726                 << " implicit move constructors created\n";
727  llvm::errs() << NumImplicitCopyAssignmentOperatorsDeclared << "/"
728               << NumImplicitCopyAssignmentOperators
729               << " implicit copy assignment operators created\n";
730  if (getLangOpts().CPlusPlus)
731    llvm::errs() << NumImplicitMoveAssignmentOperatorsDeclared << "/"
732                 << NumImplicitMoveAssignmentOperators
733                 << " implicit move assignment operators created\n";
734  llvm::errs() << NumImplicitDestructorsDeclared << "/"
735               << NumImplicitDestructors
736               << " implicit destructors created\n";
737
738  if (ExternalSource.get()) {
739    llvm::errs() << "\n";
740    ExternalSource->PrintStats();
741  }
742
743  BumpAlloc.PrintStats();
744}
745
746TypedefDecl *ASTContext::getInt128Decl() const {
747  if (!Int128Decl) {
748    TypeSourceInfo *TInfo = getTrivialTypeSourceInfo(Int128Ty);
749    Int128Decl = TypedefDecl::Create(const_cast<ASTContext &>(*this),
750                                     getTranslationUnitDecl(),
751                                     SourceLocation(),
752                                     SourceLocation(),
753                                     &Idents.get("__int128_t"),
754                                     TInfo);
755  }
756
757  return Int128Decl;
758}
759
760TypedefDecl *ASTContext::getUInt128Decl() const {
761  if (!UInt128Decl) {
762    TypeSourceInfo *TInfo = getTrivialTypeSourceInfo(UnsignedInt128Ty);
763    UInt128Decl = TypedefDecl::Create(const_cast<ASTContext &>(*this),
764                                     getTranslationUnitDecl(),
765                                     SourceLocation(),
766                                     SourceLocation(),
767                                     &Idents.get("__uint128_t"),
768                                     TInfo);
769  }
770
771  return UInt128Decl;
772}
773
774void ASTContext::InitBuiltinType(CanQualType &R, BuiltinType::Kind K) {
775  BuiltinType *Ty = new (*this, TypeAlignment) BuiltinType(K);
776  R = CanQualType::CreateUnsafe(QualType(Ty, 0));
777  Types.push_back(Ty);
778}
779
780void ASTContext::InitBuiltinTypes(const TargetInfo &Target) {
781  assert((!this->Target || this->Target == &Target) &&
782         "Incorrect target reinitialization");
783  assert(VoidTy.isNull() && "Context reinitialized?");
784
785  this->Target = &Target;
786
787  ABI.reset(createCXXABI(Target));
788  AddrSpaceMap = getAddressSpaceMap(Target, LangOpts);
789
790  // C99 6.2.5p19.
791  InitBuiltinType(VoidTy,              BuiltinType::Void);
792
793  // C99 6.2.5p2.
794  InitBuiltinType(BoolTy,              BuiltinType::Bool);
795  // C99 6.2.5p3.
796  if (LangOpts.CharIsSigned)
797    InitBuiltinType(CharTy,            BuiltinType::Char_S);
798  else
799    InitBuiltinType(CharTy,            BuiltinType::Char_U);
800  // C99 6.2.5p4.
801  InitBuiltinType(SignedCharTy,        BuiltinType::SChar);
802  InitBuiltinType(ShortTy,             BuiltinType::Short);
803  InitBuiltinType(IntTy,               BuiltinType::Int);
804  InitBuiltinType(LongTy,              BuiltinType::Long);
805  InitBuiltinType(LongLongTy,          BuiltinType::LongLong);
806
807  // C99 6.2.5p6.
808  InitBuiltinType(UnsignedCharTy,      BuiltinType::UChar);
809  InitBuiltinType(UnsignedShortTy,     BuiltinType::UShort);
810  InitBuiltinType(UnsignedIntTy,       BuiltinType::UInt);
811  InitBuiltinType(UnsignedLongTy,      BuiltinType::ULong);
812  InitBuiltinType(UnsignedLongLongTy,  BuiltinType::ULongLong);
813
814  // C99 6.2.5p10.
815  InitBuiltinType(FloatTy,             BuiltinType::Float);
816  InitBuiltinType(DoubleTy,            BuiltinType::Double);
817  InitBuiltinType(LongDoubleTy,        BuiltinType::LongDouble);
818
819  // GNU extension, 128-bit integers.
820  InitBuiltinType(Int128Ty,            BuiltinType::Int128);
821  InitBuiltinType(UnsignedInt128Ty,    BuiltinType::UInt128);
822
823  if (LangOpts.CPlusPlus && LangOpts.WChar) { // C++ 3.9.1p5
824    if (TargetInfo::isTypeSigned(Target.getWCharType()))
825      InitBuiltinType(WCharTy,           BuiltinType::WChar_S);
826    else  // -fshort-wchar makes wchar_t be unsigned.
827      InitBuiltinType(WCharTy,           BuiltinType::WChar_U);
828  } else // C99 (or C++ using -fno-wchar)
829    WCharTy = getFromTargetType(Target.getWCharType());
830
831  WIntTy = getFromTargetType(Target.getWIntType());
832
833  if (LangOpts.CPlusPlus) // C++0x 3.9.1p5, extension for C++
834    InitBuiltinType(Char16Ty,           BuiltinType::Char16);
835  else // C99
836    Char16Ty = getFromTargetType(Target.getChar16Type());
837
838  if (LangOpts.CPlusPlus) // C++0x 3.9.1p5, extension for C++
839    InitBuiltinType(Char32Ty,           BuiltinType::Char32);
840  else // C99
841    Char32Ty = getFromTargetType(Target.getChar32Type());
842
843  // Placeholder type for type-dependent expressions whose type is
844  // completely unknown. No code should ever check a type against
845  // DependentTy and users should never see it; however, it is here to
846  // help diagnose failures to properly check for type-dependent
847  // expressions.
848  InitBuiltinType(DependentTy,         BuiltinType::Dependent);
849
850  // Placeholder type for functions.
851  InitBuiltinType(OverloadTy,          BuiltinType::Overload);
852
853  // Placeholder type for bound members.
854  InitBuiltinType(BoundMemberTy,       BuiltinType::BoundMember);
855
856  // Placeholder type for pseudo-objects.
857  InitBuiltinType(PseudoObjectTy,      BuiltinType::PseudoObject);
858
859  // "any" type; useful for debugger-like clients.
860  InitBuiltinType(UnknownAnyTy,        BuiltinType::UnknownAny);
861
862  // Placeholder type for unbridged ARC casts.
863  InitBuiltinType(ARCUnbridgedCastTy,  BuiltinType::ARCUnbridgedCast);
864
865  // Placeholder type for builtin functions.
866  InitBuiltinType(BuiltinFnTy,  BuiltinType::BuiltinFn);
867
868  // C99 6.2.5p11.
869  FloatComplexTy      = getComplexType(FloatTy);
870  DoubleComplexTy     = getComplexType(DoubleTy);
871  LongDoubleComplexTy = getComplexType(LongDoubleTy);
872
873  // Builtin types for 'id', 'Class', and 'SEL'.
874  InitBuiltinType(ObjCBuiltinIdTy, BuiltinType::ObjCId);
875  InitBuiltinType(ObjCBuiltinClassTy, BuiltinType::ObjCClass);
876  InitBuiltinType(ObjCBuiltinSelTy, BuiltinType::ObjCSel);
877
878  if (LangOpts.OpenCL) {
879    InitBuiltinType(OCLImage1dTy, BuiltinType::OCLImage1d);
880    InitBuiltinType(OCLImage1dArrayTy, BuiltinType::OCLImage1dArray);
881    InitBuiltinType(OCLImage1dBufferTy, BuiltinType::OCLImage1dBuffer);
882    InitBuiltinType(OCLImage2dTy, BuiltinType::OCLImage2d);
883    InitBuiltinType(OCLImage2dArrayTy, BuiltinType::OCLImage2dArray);
884    InitBuiltinType(OCLImage3dTy, BuiltinType::OCLImage3d);
885  }
886
887  // Builtin type for __objc_yes and __objc_no
888  ObjCBuiltinBoolTy = (Target.useSignedCharForObjCBool() ?
889                       SignedCharTy : BoolTy);
890
891  ObjCConstantStringType = QualType();
892
893  // void * type
894  VoidPtrTy = getPointerType(VoidTy);
895
896  // nullptr type (C++0x 2.14.7)
897  InitBuiltinType(NullPtrTy,           BuiltinType::NullPtr);
898
899  // half type (OpenCL 6.1.1.1) / ARM NEON __fp16
900  InitBuiltinType(HalfTy, BuiltinType::Half);
901
902  // Builtin type used to help define __builtin_va_list.
903  VaListTagTy = QualType();
904}
905
906DiagnosticsEngine &ASTContext::getDiagnostics() const {
907  return SourceMgr.getDiagnostics();
908}
909
910AttrVec& ASTContext::getDeclAttrs(const Decl *D) {
911  AttrVec *&Result = DeclAttrs[D];
912  if (!Result) {
913    void *Mem = Allocate(sizeof(AttrVec));
914    Result = new (Mem) AttrVec;
915  }
916
917  return *Result;
918}
919
920/// \brief Erase the attributes corresponding to the given declaration.
921void ASTContext::eraseDeclAttrs(const Decl *D) {
922  llvm::DenseMap<const Decl*, AttrVec*>::iterator Pos = DeclAttrs.find(D);
923  if (Pos != DeclAttrs.end()) {
924    Pos->second->~AttrVec();
925    DeclAttrs.erase(Pos);
926  }
927}
928
929MemberSpecializationInfo *
930ASTContext::getInstantiatedFromStaticDataMember(const VarDecl *Var) {
931  assert(Var->isStaticDataMember() && "Not a static data member");
932  llvm::DenseMap<const VarDecl *, MemberSpecializationInfo *>::iterator Pos
933    = InstantiatedFromStaticDataMember.find(Var);
934  if (Pos == InstantiatedFromStaticDataMember.end())
935    return 0;
936
937  return Pos->second;
938}
939
940void
941ASTContext::setInstantiatedFromStaticDataMember(VarDecl *Inst, VarDecl *Tmpl,
942                                                TemplateSpecializationKind TSK,
943                                          SourceLocation PointOfInstantiation) {
944  assert(Inst->isStaticDataMember() && "Not a static data member");
945  assert(Tmpl->isStaticDataMember() && "Not a static data member");
946  assert(!InstantiatedFromStaticDataMember[Inst] &&
947         "Already noted what static data member was instantiated from");
948  InstantiatedFromStaticDataMember[Inst]
949    = new (*this) MemberSpecializationInfo(Tmpl, TSK, PointOfInstantiation);
950}
951
952FunctionDecl *ASTContext::getClassScopeSpecializationPattern(
953                                                     const FunctionDecl *FD){
954  assert(FD && "Specialization is 0");
955  llvm::DenseMap<const FunctionDecl*, FunctionDecl *>::const_iterator Pos
956    = ClassScopeSpecializationPattern.find(FD);
957  if (Pos == ClassScopeSpecializationPattern.end())
958    return 0;
959
960  return Pos->second;
961}
962
963void ASTContext::setClassScopeSpecializationPattern(FunctionDecl *FD,
964                                        FunctionDecl *Pattern) {
965  assert(FD && "Specialization is 0");
966  assert(Pattern && "Class scope specialization pattern is 0");
967  ClassScopeSpecializationPattern[FD] = Pattern;
968}
969
970NamedDecl *
971ASTContext::getInstantiatedFromUsingDecl(UsingDecl *UUD) {
972  llvm::DenseMap<UsingDecl *, NamedDecl *>::const_iterator Pos
973    = InstantiatedFromUsingDecl.find(UUD);
974  if (Pos == InstantiatedFromUsingDecl.end())
975    return 0;
976
977  return Pos->second;
978}
979
980void
981ASTContext::setInstantiatedFromUsingDecl(UsingDecl *Inst, NamedDecl *Pattern) {
982  assert((isa<UsingDecl>(Pattern) ||
983          isa<UnresolvedUsingValueDecl>(Pattern) ||
984          isa<UnresolvedUsingTypenameDecl>(Pattern)) &&
985         "pattern decl is not a using decl");
986  assert(!InstantiatedFromUsingDecl[Inst] && "pattern already exists");
987  InstantiatedFromUsingDecl[Inst] = Pattern;
988}
989
990UsingShadowDecl *
991ASTContext::getInstantiatedFromUsingShadowDecl(UsingShadowDecl *Inst) {
992  llvm::DenseMap<UsingShadowDecl*, UsingShadowDecl*>::const_iterator Pos
993    = InstantiatedFromUsingShadowDecl.find(Inst);
994  if (Pos == InstantiatedFromUsingShadowDecl.end())
995    return 0;
996
997  return Pos->second;
998}
999
1000void
1001ASTContext::setInstantiatedFromUsingShadowDecl(UsingShadowDecl *Inst,
1002                                               UsingShadowDecl *Pattern) {
1003  assert(!InstantiatedFromUsingShadowDecl[Inst] && "pattern already exists");
1004  InstantiatedFromUsingShadowDecl[Inst] = Pattern;
1005}
1006
1007FieldDecl *ASTContext::getInstantiatedFromUnnamedFieldDecl(FieldDecl *Field) {
1008  llvm::DenseMap<FieldDecl *, FieldDecl *>::iterator Pos
1009    = InstantiatedFromUnnamedFieldDecl.find(Field);
1010  if (Pos == InstantiatedFromUnnamedFieldDecl.end())
1011    return 0;
1012
1013  return Pos->second;
1014}
1015
1016void ASTContext::setInstantiatedFromUnnamedFieldDecl(FieldDecl *Inst,
1017                                                     FieldDecl *Tmpl) {
1018  assert(!Inst->getDeclName() && "Instantiated field decl is not unnamed");
1019  assert(!Tmpl->getDeclName() && "Template field decl is not unnamed");
1020  assert(!InstantiatedFromUnnamedFieldDecl[Inst] &&
1021         "Already noted what unnamed field was instantiated from");
1022
1023  InstantiatedFromUnnamedFieldDecl[Inst] = Tmpl;
1024}
1025
1026bool ASTContext::ZeroBitfieldFollowsNonBitfield(const FieldDecl *FD,
1027                                    const FieldDecl *LastFD) const {
1028  return (FD->isBitField() && LastFD && !LastFD->isBitField() &&
1029          FD->getBitWidthValue(*this) == 0);
1030}
1031
1032bool ASTContext::ZeroBitfieldFollowsBitfield(const FieldDecl *FD,
1033                                             const FieldDecl *LastFD) const {
1034  return (FD->isBitField() && LastFD && LastFD->isBitField() &&
1035          FD->getBitWidthValue(*this) == 0 &&
1036          LastFD->getBitWidthValue(*this) != 0);
1037}
1038
1039bool ASTContext::BitfieldFollowsBitfield(const FieldDecl *FD,
1040                                         const FieldDecl *LastFD) const {
1041  return (FD->isBitField() && LastFD && LastFD->isBitField() &&
1042          FD->getBitWidthValue(*this) &&
1043          LastFD->getBitWidthValue(*this));
1044}
1045
1046bool ASTContext::NonBitfieldFollowsBitfield(const FieldDecl *FD,
1047                                         const FieldDecl *LastFD) const {
1048  return (!FD->isBitField() && LastFD && LastFD->isBitField() &&
1049          LastFD->getBitWidthValue(*this));
1050}
1051
1052bool ASTContext::BitfieldFollowsNonBitfield(const FieldDecl *FD,
1053                                             const FieldDecl *LastFD) const {
1054  return (FD->isBitField() && LastFD && !LastFD->isBitField() &&
1055          FD->getBitWidthValue(*this));
1056}
1057
1058ASTContext::overridden_cxx_method_iterator
1059ASTContext::overridden_methods_begin(const CXXMethodDecl *Method) const {
1060  llvm::DenseMap<const CXXMethodDecl *, CXXMethodVector>::const_iterator Pos
1061    = OverriddenMethods.find(Method->getCanonicalDecl());
1062  if (Pos == OverriddenMethods.end())
1063    return 0;
1064
1065  return Pos->second.begin();
1066}
1067
1068ASTContext::overridden_cxx_method_iterator
1069ASTContext::overridden_methods_end(const CXXMethodDecl *Method) const {
1070  llvm::DenseMap<const CXXMethodDecl *, CXXMethodVector>::const_iterator Pos
1071    = OverriddenMethods.find(Method->getCanonicalDecl());
1072  if (Pos == OverriddenMethods.end())
1073    return 0;
1074
1075  return Pos->second.end();
1076}
1077
1078unsigned
1079ASTContext::overridden_methods_size(const CXXMethodDecl *Method) const {
1080  llvm::DenseMap<const CXXMethodDecl *, CXXMethodVector>::const_iterator Pos
1081    = OverriddenMethods.find(Method->getCanonicalDecl());
1082  if (Pos == OverriddenMethods.end())
1083    return 0;
1084
1085  return Pos->second.size();
1086}
1087
1088void ASTContext::addOverriddenMethod(const CXXMethodDecl *Method,
1089                                     const CXXMethodDecl *Overridden) {
1090  assert(Method->isCanonicalDecl() && Overridden->isCanonicalDecl());
1091  OverriddenMethods[Method].push_back(Overridden);
1092}
1093
1094void ASTContext::getOverriddenMethods(
1095                      const NamedDecl *D,
1096                      SmallVectorImpl<const NamedDecl *> &Overridden) const {
1097  assert(D);
1098
1099  if (const CXXMethodDecl *CXXMethod = dyn_cast<CXXMethodDecl>(D)) {
1100    Overridden.append(CXXMethod->begin_overridden_methods(),
1101                      CXXMethod->end_overridden_methods());
1102    return;
1103  }
1104
1105  const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D);
1106  if (!Method)
1107    return;
1108
1109  SmallVector<const ObjCMethodDecl *, 8> OverDecls;
1110  Method->getOverriddenMethods(OverDecls);
1111  Overridden.append(OverDecls.begin(), OverDecls.end());
1112}
1113
1114void ASTContext::addedLocalImportDecl(ImportDecl *Import) {
1115  assert(!Import->NextLocalImport && "Import declaration already in the chain");
1116  assert(!Import->isFromASTFile() && "Non-local import declaration");
1117  if (!FirstLocalImport) {
1118    FirstLocalImport = Import;
1119    LastLocalImport = Import;
1120    return;
1121  }
1122
1123  LastLocalImport->NextLocalImport = Import;
1124  LastLocalImport = Import;
1125}
1126
1127//===----------------------------------------------------------------------===//
1128//                         Type Sizing and Analysis
1129//===----------------------------------------------------------------------===//
1130
1131/// getFloatTypeSemantics - Return the APFloat 'semantics' for the specified
1132/// scalar floating point type.
1133const llvm::fltSemantics &ASTContext::getFloatTypeSemantics(QualType T) const {
1134  const BuiltinType *BT = T->getAs<BuiltinType>();
1135  assert(BT && "Not a floating point type!");
1136  switch (BT->getKind()) {
1137  default: llvm_unreachable("Not a floating point type!");
1138  case BuiltinType::Half:       return Target->getHalfFormat();
1139  case BuiltinType::Float:      return Target->getFloatFormat();
1140  case BuiltinType::Double:     return Target->getDoubleFormat();
1141  case BuiltinType::LongDouble: return Target->getLongDoubleFormat();
1142  }
1143}
1144
1145/// getDeclAlign - Return a conservative estimate of the alignment of the
1146/// specified decl.  Note that bitfields do not have a valid alignment, so
1147/// this method will assert on them.
1148/// If @p RefAsPointee, references are treated like their underlying type
1149/// (for alignof), else they're treated like pointers (for CodeGen).
1150CharUnits ASTContext::getDeclAlign(const Decl *D, bool RefAsPointee) const {
1151  unsigned Align = Target->getCharWidth();
1152
1153  bool UseAlignAttrOnly = false;
1154  if (unsigned AlignFromAttr = D->getMaxAlignment()) {
1155    Align = AlignFromAttr;
1156
1157    // __attribute__((aligned)) can increase or decrease alignment
1158    // *except* on a struct or struct member, where it only increases
1159    // alignment unless 'packed' is also specified.
1160    //
1161    // It is an error for alignas to decrease alignment, so we can
1162    // ignore that possibility;  Sema should diagnose it.
1163    if (isa<FieldDecl>(D)) {
1164      UseAlignAttrOnly = D->hasAttr<PackedAttr>() ||
1165        cast<FieldDecl>(D)->getParent()->hasAttr<PackedAttr>();
1166    } else {
1167      UseAlignAttrOnly = true;
1168    }
1169  }
1170  else if (isa<FieldDecl>(D))
1171      UseAlignAttrOnly =
1172        D->hasAttr<PackedAttr>() ||
1173        cast<FieldDecl>(D)->getParent()->hasAttr<PackedAttr>();
1174
1175  // If we're using the align attribute only, just ignore everything
1176  // else about the declaration and its type.
1177  if (UseAlignAttrOnly) {
1178    // do nothing
1179
1180  } else if (const ValueDecl *VD = dyn_cast<ValueDecl>(D)) {
1181    QualType T = VD->getType();
1182    if (const ReferenceType* RT = T->getAs<ReferenceType>()) {
1183      if (RefAsPointee)
1184        T = RT->getPointeeType();
1185      else
1186        T = getPointerType(RT->getPointeeType());
1187    }
1188    if (!T->isIncompleteType() && !T->isFunctionType()) {
1189      // Adjust alignments of declarations with array type by the
1190      // large-array alignment on the target.
1191      unsigned MinWidth = Target->getLargeArrayMinWidth();
1192      const ArrayType *arrayType;
1193      if (MinWidth && (arrayType = getAsArrayType(T))) {
1194        if (isa<VariableArrayType>(arrayType))
1195          Align = std::max(Align, Target->getLargeArrayAlign());
1196        else if (isa<ConstantArrayType>(arrayType) &&
1197                 MinWidth <= getTypeSize(cast<ConstantArrayType>(arrayType)))
1198          Align = std::max(Align, Target->getLargeArrayAlign());
1199
1200        // Walk through any array types while we're at it.
1201        T = getBaseElementType(arrayType);
1202      }
1203      Align = std::max(Align, getPreferredTypeAlign(T.getTypePtr()));
1204    }
1205
1206    // Fields can be subject to extra alignment constraints, like if
1207    // the field is packed, the struct is packed, or the struct has a
1208    // a max-field-alignment constraint (#pragma pack).  So calculate
1209    // the actual alignment of the field within the struct, and then
1210    // (as we're expected to) constrain that by the alignment of the type.
1211    if (const FieldDecl *field = dyn_cast<FieldDecl>(VD)) {
1212      // So calculate the alignment of the field.
1213      const ASTRecordLayout &layout = getASTRecordLayout(field->getParent());
1214
1215      // Start with the record's overall alignment.
1216      unsigned fieldAlign = toBits(layout.getAlignment());
1217
1218      // Use the GCD of that and the offset within the record.
1219      uint64_t offset = layout.getFieldOffset(field->getFieldIndex());
1220      if (offset > 0) {
1221        // Alignment is always a power of 2, so the GCD will be a power of 2,
1222        // which means we get to do this crazy thing instead of Euclid's.
1223        uint64_t lowBitOfOffset = offset & (~offset + 1);
1224        if (lowBitOfOffset < fieldAlign)
1225          fieldAlign = static_cast<unsigned>(lowBitOfOffset);
1226      }
1227
1228      Align = std::min(Align, fieldAlign);
1229    }
1230  }
1231
1232  return toCharUnitsFromBits(Align);
1233}
1234
1235// getTypeInfoDataSizeInChars - Return the size of a type, in
1236// chars. If the type is a record, its data size is returned.  This is
1237// the size of the memcpy that's performed when assigning this type
1238// using a trivial copy/move assignment operator.
1239std::pair<CharUnits, CharUnits>
1240ASTContext::getTypeInfoDataSizeInChars(QualType T) const {
1241  std::pair<CharUnits, CharUnits> sizeAndAlign = getTypeInfoInChars(T);
1242
1243  // In C++, objects can sometimes be allocated into the tail padding
1244  // of a base-class subobject.  We decide whether that's possible
1245  // during class layout, so here we can just trust the layout results.
1246  if (getLangOpts().CPlusPlus) {
1247    if (const RecordType *RT = T->getAs<RecordType>()) {
1248      const ASTRecordLayout &layout = getASTRecordLayout(RT->getDecl());
1249      sizeAndAlign.first = layout.getDataSize();
1250    }
1251  }
1252
1253  return sizeAndAlign;
1254}
1255
1256std::pair<CharUnits, CharUnits>
1257ASTContext::getTypeInfoInChars(const Type *T) const {
1258  std::pair<uint64_t, unsigned> Info = getTypeInfo(T);
1259  return std::make_pair(toCharUnitsFromBits(Info.first),
1260                        toCharUnitsFromBits(Info.second));
1261}
1262
1263std::pair<CharUnits, CharUnits>
1264ASTContext::getTypeInfoInChars(QualType T) const {
1265  return getTypeInfoInChars(T.getTypePtr());
1266}
1267
1268std::pair<uint64_t, unsigned> ASTContext::getTypeInfo(const Type *T) const {
1269  TypeInfoMap::iterator it = MemoizedTypeInfo.find(T);
1270  if (it != MemoizedTypeInfo.end())
1271    return it->second;
1272
1273  std::pair<uint64_t, unsigned> Info = getTypeInfoImpl(T);
1274  MemoizedTypeInfo.insert(std::make_pair(T, Info));
1275  return Info;
1276}
1277
1278/// getTypeInfoImpl - Return the size of the specified type, in bits.  This
1279/// method does not work on incomplete types.
1280///
1281/// FIXME: Pointers into different addr spaces could have different sizes and
1282/// alignment requirements: getPointerInfo should take an AddrSpace, this
1283/// should take a QualType, &c.
1284std::pair<uint64_t, unsigned>
1285ASTContext::getTypeInfoImpl(const Type *T) const {
1286  uint64_t Width=0;
1287  unsigned Align=8;
1288  switch (T->getTypeClass()) {
1289#define TYPE(Class, Base)
1290#define ABSTRACT_TYPE(Class, Base)
1291#define NON_CANONICAL_TYPE(Class, Base)
1292#define DEPENDENT_TYPE(Class, Base) case Type::Class:
1293#include "clang/AST/TypeNodes.def"
1294    llvm_unreachable("Should not see dependent types");
1295
1296  case Type::FunctionNoProto:
1297  case Type::FunctionProto:
1298    // GCC extension: alignof(function) = 32 bits
1299    Width = 0;
1300    Align = 32;
1301    break;
1302
1303  case Type::IncompleteArray:
1304  case Type::VariableArray:
1305    Width = 0;
1306    Align = getTypeAlign(cast<ArrayType>(T)->getElementType());
1307    break;
1308
1309  case Type::ConstantArray: {
1310    const ConstantArrayType *CAT = cast<ConstantArrayType>(T);
1311
1312    std::pair<uint64_t, unsigned> EltInfo = getTypeInfo(CAT->getElementType());
1313    uint64_t Size = CAT->getSize().getZExtValue();
1314    assert((Size == 0 || EltInfo.first <= (uint64_t)(-1)/Size) &&
1315           "Overflow in array type bit size evaluation");
1316    Width = EltInfo.first*Size;
1317    Align = EltInfo.second;
1318    Width = llvm::RoundUpToAlignment(Width, Align);
1319    break;
1320  }
1321  case Type::ExtVector:
1322  case Type::Vector: {
1323    const VectorType *VT = cast<VectorType>(T);
1324    std::pair<uint64_t, unsigned> EltInfo = getTypeInfo(VT->getElementType());
1325    Width = EltInfo.first*VT->getNumElements();
1326    Align = Width;
1327    // If the alignment is not a power of 2, round up to the next power of 2.
1328    // This happens for non-power-of-2 length vectors.
1329    if (Align & (Align-1)) {
1330      Align = llvm::NextPowerOf2(Align);
1331      Width = llvm::RoundUpToAlignment(Width, Align);
1332    }
1333    // Adjust the alignment based on the target max.
1334    uint64_t TargetVectorAlign = Target->getMaxVectorAlign();
1335    if (TargetVectorAlign && TargetVectorAlign < Align)
1336      Align = TargetVectorAlign;
1337    break;
1338  }
1339
1340  case Type::Builtin:
1341    switch (cast<BuiltinType>(T)->getKind()) {
1342    default: llvm_unreachable("Unknown builtin type!");
1343    case BuiltinType::Void:
1344      // GCC extension: alignof(void) = 8 bits.
1345      Width = 0;
1346      Align = 8;
1347      break;
1348
1349    case BuiltinType::Bool:
1350      Width = Target->getBoolWidth();
1351      Align = Target->getBoolAlign();
1352      break;
1353    case BuiltinType::Char_S:
1354    case BuiltinType::Char_U:
1355    case BuiltinType::UChar:
1356    case BuiltinType::SChar:
1357      Width = Target->getCharWidth();
1358      Align = Target->getCharAlign();
1359      break;
1360    case BuiltinType::WChar_S:
1361    case BuiltinType::WChar_U:
1362      Width = Target->getWCharWidth();
1363      Align = Target->getWCharAlign();
1364      break;
1365    case BuiltinType::Char16:
1366      Width = Target->getChar16Width();
1367      Align = Target->getChar16Align();
1368      break;
1369    case BuiltinType::Char32:
1370      Width = Target->getChar32Width();
1371      Align = Target->getChar32Align();
1372      break;
1373    case BuiltinType::UShort:
1374    case BuiltinType::Short:
1375      Width = Target->getShortWidth();
1376      Align = Target->getShortAlign();
1377      break;
1378    case BuiltinType::UInt:
1379    case BuiltinType::Int:
1380      Width = Target->getIntWidth();
1381      Align = Target->getIntAlign();
1382      break;
1383    case BuiltinType::ULong:
1384    case BuiltinType::Long:
1385      Width = Target->getLongWidth();
1386      Align = Target->getLongAlign();
1387      break;
1388    case BuiltinType::ULongLong:
1389    case BuiltinType::LongLong:
1390      Width = Target->getLongLongWidth();
1391      Align = Target->getLongLongAlign();
1392      break;
1393    case BuiltinType::Int128:
1394    case BuiltinType::UInt128:
1395      Width = 128;
1396      Align = 128; // int128_t is 128-bit aligned on all targets.
1397      break;
1398    case BuiltinType::Half:
1399      Width = Target->getHalfWidth();
1400      Align = Target->getHalfAlign();
1401      break;
1402    case BuiltinType::Float:
1403      Width = Target->getFloatWidth();
1404      Align = Target->getFloatAlign();
1405      break;
1406    case BuiltinType::Double:
1407      Width = Target->getDoubleWidth();
1408      Align = Target->getDoubleAlign();
1409      break;
1410    case BuiltinType::LongDouble:
1411      Width = Target->getLongDoubleWidth();
1412      Align = Target->getLongDoubleAlign();
1413      break;
1414    case BuiltinType::NullPtr:
1415      Width = Target->getPointerWidth(0); // C++ 3.9.1p11: sizeof(nullptr_t)
1416      Align = Target->getPointerAlign(0); //   == sizeof(void*)
1417      break;
1418    case BuiltinType::ObjCId:
1419    case BuiltinType::ObjCClass:
1420    case BuiltinType::ObjCSel:
1421      Width = Target->getPointerWidth(0);
1422      Align = Target->getPointerAlign(0);
1423      break;
1424    case BuiltinType::OCLImage1d:
1425    case BuiltinType::OCLImage1dArray:
1426    case BuiltinType::OCLImage1dBuffer:
1427    case BuiltinType::OCLImage2d:
1428    case BuiltinType::OCLImage2dArray:
1429    case BuiltinType::OCLImage3d:
1430      // Currently these types are pointers to opaque types.
1431      Width = Target->getPointerWidth(0);
1432      Align = Target->getPointerAlign(0);
1433      break;
1434    }
1435    break;
1436  case Type::ObjCObjectPointer:
1437    Width = Target->getPointerWidth(0);
1438    Align = Target->getPointerAlign(0);
1439    break;
1440  case Type::BlockPointer: {
1441    unsigned AS = getTargetAddressSpace(
1442        cast<BlockPointerType>(T)->getPointeeType());
1443    Width = Target->getPointerWidth(AS);
1444    Align = Target->getPointerAlign(AS);
1445    break;
1446  }
1447  case Type::LValueReference:
1448  case Type::RValueReference: {
1449    // alignof and sizeof should never enter this code path here, so we go
1450    // the pointer route.
1451    unsigned AS = getTargetAddressSpace(
1452        cast<ReferenceType>(T)->getPointeeType());
1453    Width = Target->getPointerWidth(AS);
1454    Align = Target->getPointerAlign(AS);
1455    break;
1456  }
1457  case Type::Pointer: {
1458    unsigned AS = getTargetAddressSpace(cast<PointerType>(T)->getPointeeType());
1459    Width = Target->getPointerWidth(AS);
1460    Align = Target->getPointerAlign(AS);
1461    break;
1462  }
1463  case Type::MemberPointer: {
1464    const MemberPointerType *MPT = cast<MemberPointerType>(T);
1465    std::pair<uint64_t, unsigned> PtrDiffInfo =
1466      getTypeInfo(getPointerDiffType());
1467    Width = PtrDiffInfo.first * ABI->getMemberPointerSize(MPT);
1468    Align = PtrDiffInfo.second;
1469    break;
1470  }
1471  case Type::Complex: {
1472    // Complex types have the same alignment as their elements, but twice the
1473    // size.
1474    std::pair<uint64_t, unsigned> EltInfo =
1475      getTypeInfo(cast<ComplexType>(T)->getElementType());
1476    Width = EltInfo.first*2;
1477    Align = EltInfo.second;
1478    break;
1479  }
1480  case Type::ObjCObject:
1481    return getTypeInfo(cast<ObjCObjectType>(T)->getBaseType().getTypePtr());
1482  case Type::ObjCInterface: {
1483    const ObjCInterfaceType *ObjCI = cast<ObjCInterfaceType>(T);
1484    const ASTRecordLayout &Layout = getASTObjCInterfaceLayout(ObjCI->getDecl());
1485    Width = toBits(Layout.getSize());
1486    Align = toBits(Layout.getAlignment());
1487    break;
1488  }
1489  case Type::Record:
1490  case Type::Enum: {
1491    const TagType *TT = cast<TagType>(T);
1492
1493    if (TT->getDecl()->isInvalidDecl()) {
1494      Width = 8;
1495      Align = 8;
1496      break;
1497    }
1498
1499    if (const EnumType *ET = dyn_cast<EnumType>(TT))
1500      return getTypeInfo(ET->getDecl()->getIntegerType());
1501
1502    const RecordType *RT = cast<RecordType>(TT);
1503    const ASTRecordLayout &Layout = getASTRecordLayout(RT->getDecl());
1504    Width = toBits(Layout.getSize());
1505    Align = toBits(Layout.getAlignment());
1506    break;
1507  }
1508
1509  case Type::SubstTemplateTypeParm:
1510    return getTypeInfo(cast<SubstTemplateTypeParmType>(T)->
1511                       getReplacementType().getTypePtr());
1512
1513  case Type::Auto: {
1514    const AutoType *A = cast<AutoType>(T);
1515    assert(A->isDeduced() && "Cannot request the size of a dependent type");
1516    return getTypeInfo(A->getDeducedType().getTypePtr());
1517  }
1518
1519  case Type::Paren:
1520    return getTypeInfo(cast<ParenType>(T)->getInnerType().getTypePtr());
1521
1522  case Type::Typedef: {
1523    const TypedefNameDecl *Typedef = cast<TypedefType>(T)->getDecl();
1524    std::pair<uint64_t, unsigned> Info
1525      = getTypeInfo(Typedef->getUnderlyingType().getTypePtr());
1526    // If the typedef has an aligned attribute on it, it overrides any computed
1527    // alignment we have.  This violates the GCC documentation (which says that
1528    // attribute(aligned) can only round up) but matches its implementation.
1529    if (unsigned AttrAlign = Typedef->getMaxAlignment())
1530      Align = AttrAlign;
1531    else
1532      Align = Info.second;
1533    Width = Info.first;
1534    break;
1535  }
1536
1537  case Type::TypeOfExpr:
1538    return getTypeInfo(cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType()
1539                         .getTypePtr());
1540
1541  case Type::TypeOf:
1542    return getTypeInfo(cast<TypeOfType>(T)->getUnderlyingType().getTypePtr());
1543
1544  case Type::Decltype:
1545    return getTypeInfo(cast<DecltypeType>(T)->getUnderlyingExpr()->getType()
1546                        .getTypePtr());
1547
1548  case Type::UnaryTransform:
1549    return getTypeInfo(cast<UnaryTransformType>(T)->getUnderlyingType());
1550
1551  case Type::Elaborated:
1552    return getTypeInfo(cast<ElaboratedType>(T)->getNamedType().getTypePtr());
1553
1554  case Type::Attributed:
1555    return getTypeInfo(
1556                  cast<AttributedType>(T)->getEquivalentType().getTypePtr());
1557
1558  case Type::TemplateSpecialization: {
1559    assert(getCanonicalType(T) != T &&
1560           "Cannot request the size of a dependent type");
1561    const TemplateSpecializationType *TST = cast<TemplateSpecializationType>(T);
1562    // A type alias template specialization may refer to a typedef with the
1563    // aligned attribute on it.
1564    if (TST->isTypeAlias())
1565      return getTypeInfo(TST->getAliasedType().getTypePtr());
1566    else
1567      return getTypeInfo(getCanonicalType(T));
1568  }
1569
1570  case Type::Atomic: {
1571    std::pair<uint64_t, unsigned> Info
1572      = getTypeInfo(cast<AtomicType>(T)->getValueType());
1573    Width = Info.first;
1574    Align = Info.second;
1575    if (Width != 0 && Width <= Target->getMaxAtomicPromoteWidth() &&
1576        llvm::isPowerOf2_64(Width)) {
1577      // We can potentially perform lock-free atomic operations for this
1578      // type; promote the alignment appropriately.
1579      // FIXME: We could potentially promote the width here as well...
1580      // is that worthwhile?  (Non-struct atomic types generally have
1581      // power-of-two size anyway, but structs might not.  Requires a bit
1582      // of implementation work to make sure we zero out the extra bits.)
1583      Align = static_cast<unsigned>(Width);
1584    }
1585  }
1586
1587  }
1588
1589  assert(llvm::isPowerOf2_32(Align) && "Alignment must be power of 2");
1590  return std::make_pair(Width, Align);
1591}
1592
1593/// toCharUnitsFromBits - Convert a size in bits to a size in characters.
1594CharUnits ASTContext::toCharUnitsFromBits(int64_t BitSize) const {
1595  return CharUnits::fromQuantity(BitSize / getCharWidth());
1596}
1597
1598/// toBits - Convert a size in characters to a size in characters.
1599int64_t ASTContext::toBits(CharUnits CharSize) const {
1600  return CharSize.getQuantity() * getCharWidth();
1601}
1602
1603/// getTypeSizeInChars - Return the size of the specified type, in characters.
1604/// This method does not work on incomplete types.
1605CharUnits ASTContext::getTypeSizeInChars(QualType T) const {
1606  return toCharUnitsFromBits(getTypeSize(T));
1607}
1608CharUnits ASTContext::getTypeSizeInChars(const Type *T) const {
1609  return toCharUnitsFromBits(getTypeSize(T));
1610}
1611
1612/// getTypeAlignInChars - Return the ABI-specified alignment of a type, in
1613/// characters. This method does not work on incomplete types.
1614CharUnits ASTContext::getTypeAlignInChars(QualType T) const {
1615  return toCharUnitsFromBits(getTypeAlign(T));
1616}
1617CharUnits ASTContext::getTypeAlignInChars(const Type *T) const {
1618  return toCharUnitsFromBits(getTypeAlign(T));
1619}
1620
1621/// getPreferredTypeAlign - Return the "preferred" alignment of the specified
1622/// type for the current target in bits.  This can be different than the ABI
1623/// alignment in cases where it is beneficial for performance to overalign
1624/// a data type.
1625unsigned ASTContext::getPreferredTypeAlign(const Type *T) const {
1626  unsigned ABIAlign = getTypeAlign(T);
1627
1628  // Double and long long should be naturally aligned if possible.
1629  if (const ComplexType* CT = T->getAs<ComplexType>())
1630    T = CT->getElementType().getTypePtr();
1631  if (T->isSpecificBuiltinType(BuiltinType::Double) ||
1632      T->isSpecificBuiltinType(BuiltinType::LongLong) ||
1633      T->isSpecificBuiltinType(BuiltinType::ULongLong))
1634    return std::max(ABIAlign, (unsigned)getTypeSize(T));
1635
1636  return ABIAlign;
1637}
1638
1639/// DeepCollectObjCIvars -
1640/// This routine first collects all declared, but not synthesized, ivars in
1641/// super class and then collects all ivars, including those synthesized for
1642/// current class. This routine is used for implementation of current class
1643/// when all ivars, declared and synthesized are known.
1644///
1645void ASTContext::DeepCollectObjCIvars(const ObjCInterfaceDecl *OI,
1646                                      bool leafClass,
1647                            SmallVectorImpl<const ObjCIvarDecl*> &Ivars) const {
1648  if (const ObjCInterfaceDecl *SuperClass = OI->getSuperClass())
1649    DeepCollectObjCIvars(SuperClass, false, Ivars);
1650  if (!leafClass) {
1651    for (ObjCInterfaceDecl::ivar_iterator I = OI->ivar_begin(),
1652         E = OI->ivar_end(); I != E; ++I)
1653      Ivars.push_back(*I);
1654  } else {
1655    ObjCInterfaceDecl *IDecl = const_cast<ObjCInterfaceDecl *>(OI);
1656    for (const ObjCIvarDecl *Iv = IDecl->all_declared_ivar_begin(); Iv;
1657         Iv= Iv->getNextIvar())
1658      Ivars.push_back(Iv);
1659  }
1660}
1661
1662/// CollectInheritedProtocols - Collect all protocols in current class and
1663/// those inherited by it.
1664void ASTContext::CollectInheritedProtocols(const Decl *CDecl,
1665                          llvm::SmallPtrSet<ObjCProtocolDecl*, 8> &Protocols) {
1666  if (const ObjCInterfaceDecl *OI = dyn_cast<ObjCInterfaceDecl>(CDecl)) {
1667    // We can use protocol_iterator here instead of
1668    // all_referenced_protocol_iterator since we are walking all categories.
1669    for (ObjCInterfaceDecl::all_protocol_iterator P = OI->all_referenced_protocol_begin(),
1670         PE = OI->all_referenced_protocol_end(); P != PE; ++P) {
1671      ObjCProtocolDecl *Proto = (*P);
1672      Protocols.insert(Proto->getCanonicalDecl());
1673      for (ObjCProtocolDecl::protocol_iterator P = Proto->protocol_begin(),
1674           PE = Proto->protocol_end(); P != PE; ++P) {
1675        Protocols.insert((*P)->getCanonicalDecl());
1676        CollectInheritedProtocols(*P, Protocols);
1677      }
1678    }
1679
1680    // Categories of this Interface.
1681    for (const ObjCCategoryDecl *CDeclChain = OI->getCategoryList();
1682         CDeclChain; CDeclChain = CDeclChain->getNextClassCategory())
1683      CollectInheritedProtocols(CDeclChain, Protocols);
1684    if (ObjCInterfaceDecl *SD = OI->getSuperClass())
1685      while (SD) {
1686        CollectInheritedProtocols(SD, Protocols);
1687        SD = SD->getSuperClass();
1688      }
1689  } else if (const ObjCCategoryDecl *OC = dyn_cast<ObjCCategoryDecl>(CDecl)) {
1690    for (ObjCCategoryDecl::protocol_iterator P = OC->protocol_begin(),
1691         PE = OC->protocol_end(); P != PE; ++P) {
1692      ObjCProtocolDecl *Proto = (*P);
1693      Protocols.insert(Proto->getCanonicalDecl());
1694      for (ObjCProtocolDecl::protocol_iterator P = Proto->protocol_begin(),
1695           PE = Proto->protocol_end(); P != PE; ++P)
1696        CollectInheritedProtocols(*P, Protocols);
1697    }
1698  } else if (const ObjCProtocolDecl *OP = dyn_cast<ObjCProtocolDecl>(CDecl)) {
1699    for (ObjCProtocolDecl::protocol_iterator P = OP->protocol_begin(),
1700         PE = OP->protocol_end(); P != PE; ++P) {
1701      ObjCProtocolDecl *Proto = (*P);
1702      Protocols.insert(Proto->getCanonicalDecl());
1703      for (ObjCProtocolDecl::protocol_iterator P = Proto->protocol_begin(),
1704           PE = Proto->protocol_end(); P != PE; ++P)
1705        CollectInheritedProtocols(*P, Protocols);
1706    }
1707  }
1708}
1709
1710unsigned ASTContext::CountNonClassIvars(const ObjCInterfaceDecl *OI) const {
1711  unsigned count = 0;
1712  // Count ivars declared in class extension.
1713  for (const ObjCCategoryDecl *CDecl = OI->getFirstClassExtension(); CDecl;
1714       CDecl = CDecl->getNextClassExtension())
1715    count += CDecl->ivar_size();
1716
1717  // Count ivar defined in this class's implementation.  This
1718  // includes synthesized ivars.
1719  if (ObjCImplementationDecl *ImplDecl = OI->getImplementation())
1720    count += ImplDecl->ivar_size();
1721
1722  return count;
1723}
1724
1725bool ASTContext::isSentinelNullExpr(const Expr *E) {
1726  if (!E)
1727    return false;
1728
1729  // nullptr_t is always treated as null.
1730  if (E->getType()->isNullPtrType()) return true;
1731
1732  if (E->getType()->isAnyPointerType() &&
1733      E->IgnoreParenCasts()->isNullPointerConstant(*this,
1734                                                Expr::NPC_ValueDependentIsNull))
1735    return true;
1736
1737  // Unfortunately, __null has type 'int'.
1738  if (isa<GNUNullExpr>(E)) return true;
1739
1740  return false;
1741}
1742
1743/// \brief Get the implementation of ObjCInterfaceDecl,or NULL if none exists.
1744ObjCImplementationDecl *ASTContext::getObjCImplementation(ObjCInterfaceDecl *D) {
1745  llvm::DenseMap<ObjCContainerDecl*, ObjCImplDecl*>::iterator
1746    I = ObjCImpls.find(D);
1747  if (I != ObjCImpls.end())
1748    return cast<ObjCImplementationDecl>(I->second);
1749  return 0;
1750}
1751/// \brief Get the implementation of ObjCCategoryDecl, or NULL if none exists.
1752ObjCCategoryImplDecl *ASTContext::getObjCImplementation(ObjCCategoryDecl *D) {
1753  llvm::DenseMap<ObjCContainerDecl*, ObjCImplDecl*>::iterator
1754    I = ObjCImpls.find(D);
1755  if (I != ObjCImpls.end())
1756    return cast<ObjCCategoryImplDecl>(I->second);
1757  return 0;
1758}
1759
1760/// \brief Set the implementation of ObjCInterfaceDecl.
1761void ASTContext::setObjCImplementation(ObjCInterfaceDecl *IFaceD,
1762                           ObjCImplementationDecl *ImplD) {
1763  assert(IFaceD && ImplD && "Passed null params");
1764  ObjCImpls[IFaceD] = ImplD;
1765}
1766/// \brief Set the implementation of ObjCCategoryDecl.
1767void ASTContext::setObjCImplementation(ObjCCategoryDecl *CatD,
1768                           ObjCCategoryImplDecl *ImplD) {
1769  assert(CatD && ImplD && "Passed null params");
1770  ObjCImpls[CatD] = ImplD;
1771}
1772
1773ObjCInterfaceDecl *ASTContext::getObjContainingInterface(NamedDecl *ND) const {
1774  if (ObjCInterfaceDecl *ID = dyn_cast<ObjCInterfaceDecl>(ND->getDeclContext()))
1775    return ID;
1776  if (ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(ND->getDeclContext()))
1777    return CD->getClassInterface();
1778  if (ObjCImplDecl *IMD = dyn_cast<ObjCImplDecl>(ND->getDeclContext()))
1779    return IMD->getClassInterface();
1780
1781  return 0;
1782}
1783
1784/// \brief Get the copy initialization expression of VarDecl,or NULL if
1785/// none exists.
1786Expr *ASTContext::getBlockVarCopyInits(const VarDecl*VD) {
1787  assert(VD && "Passed null params");
1788  assert(VD->hasAttr<BlocksAttr>() &&
1789         "getBlockVarCopyInits - not __block var");
1790  llvm::DenseMap<const VarDecl*, Expr*>::iterator
1791    I = BlockVarCopyInits.find(VD);
1792  return (I != BlockVarCopyInits.end()) ? cast<Expr>(I->second) : 0;
1793}
1794
1795/// \brief Set the copy inialization expression of a block var decl.
1796void ASTContext::setBlockVarCopyInits(VarDecl*VD, Expr* Init) {
1797  assert(VD && Init && "Passed null params");
1798  assert(VD->hasAttr<BlocksAttr>() &&
1799         "setBlockVarCopyInits - not __block var");
1800  BlockVarCopyInits[VD] = Init;
1801}
1802
1803TypeSourceInfo *ASTContext::CreateTypeSourceInfo(QualType T,
1804                                                 unsigned DataSize) const {
1805  if (!DataSize)
1806    DataSize = TypeLoc::getFullDataSizeForType(T);
1807  else
1808    assert(DataSize == TypeLoc::getFullDataSizeForType(T) &&
1809           "incorrect data size provided to CreateTypeSourceInfo!");
1810
1811  TypeSourceInfo *TInfo =
1812    (TypeSourceInfo*)BumpAlloc.Allocate(sizeof(TypeSourceInfo) + DataSize, 8);
1813  new (TInfo) TypeSourceInfo(T);
1814  return TInfo;
1815}
1816
1817TypeSourceInfo *ASTContext::getTrivialTypeSourceInfo(QualType T,
1818                                                     SourceLocation L) const {
1819  TypeSourceInfo *DI = CreateTypeSourceInfo(T);
1820  DI->getTypeLoc().initialize(const_cast<ASTContext &>(*this), L);
1821  return DI;
1822}
1823
1824const ASTRecordLayout &
1825ASTContext::getASTObjCInterfaceLayout(const ObjCInterfaceDecl *D) const {
1826  return getObjCLayout(D, 0);
1827}
1828
1829const ASTRecordLayout &
1830ASTContext::getASTObjCImplementationLayout(
1831                                        const ObjCImplementationDecl *D) const {
1832  return getObjCLayout(D->getClassInterface(), D);
1833}
1834
1835//===----------------------------------------------------------------------===//
1836//                   Type creation/memoization methods
1837//===----------------------------------------------------------------------===//
1838
1839QualType
1840ASTContext::getExtQualType(const Type *baseType, Qualifiers quals) const {
1841  unsigned fastQuals = quals.getFastQualifiers();
1842  quals.removeFastQualifiers();
1843
1844  // Check if we've already instantiated this type.
1845  llvm::FoldingSetNodeID ID;
1846  ExtQuals::Profile(ID, baseType, quals);
1847  void *insertPos = 0;
1848  if (ExtQuals *eq = ExtQualNodes.FindNodeOrInsertPos(ID, insertPos)) {
1849    assert(eq->getQualifiers() == quals);
1850    return QualType(eq, fastQuals);
1851  }
1852
1853  // If the base type is not canonical, make the appropriate canonical type.
1854  QualType canon;
1855  if (!baseType->isCanonicalUnqualified()) {
1856    SplitQualType canonSplit = baseType->getCanonicalTypeInternal().split();
1857    canonSplit.Quals.addConsistentQualifiers(quals);
1858    canon = getExtQualType(canonSplit.Ty, canonSplit.Quals);
1859
1860    // Re-find the insert position.
1861    (void) ExtQualNodes.FindNodeOrInsertPos(ID, insertPos);
1862  }
1863
1864  ExtQuals *eq = new (*this, TypeAlignment) ExtQuals(baseType, canon, quals);
1865  ExtQualNodes.InsertNode(eq, insertPos);
1866  return QualType(eq, fastQuals);
1867}
1868
1869QualType
1870ASTContext::getAddrSpaceQualType(QualType T, unsigned AddressSpace) const {
1871  QualType CanT = getCanonicalType(T);
1872  if (CanT.getAddressSpace() == AddressSpace)
1873    return T;
1874
1875  // If we are composing extended qualifiers together, merge together
1876  // into one ExtQuals node.
1877  QualifierCollector Quals;
1878  const Type *TypeNode = Quals.strip(T);
1879
1880  // If this type already has an address space specified, it cannot get
1881  // another one.
1882  assert(!Quals.hasAddressSpace() &&
1883         "Type cannot be in multiple addr spaces!");
1884  Quals.addAddressSpace(AddressSpace);
1885
1886  return getExtQualType(TypeNode, Quals);
1887}
1888
1889QualType ASTContext::getObjCGCQualType(QualType T,
1890                                       Qualifiers::GC GCAttr) const {
1891  QualType CanT = getCanonicalType(T);
1892  if (CanT.getObjCGCAttr() == GCAttr)
1893    return T;
1894
1895  if (const PointerType *ptr = T->getAs<PointerType>()) {
1896    QualType Pointee = ptr->getPointeeType();
1897    if (Pointee->isAnyPointerType()) {
1898      QualType ResultType = getObjCGCQualType(Pointee, GCAttr);
1899      return getPointerType(ResultType);
1900    }
1901  }
1902
1903  // If we are composing extended qualifiers together, merge together
1904  // into one ExtQuals node.
1905  QualifierCollector Quals;
1906  const Type *TypeNode = Quals.strip(T);
1907
1908  // If this type already has an ObjCGC specified, it cannot get
1909  // another one.
1910  assert(!Quals.hasObjCGCAttr() &&
1911         "Type cannot have multiple ObjCGCs!");
1912  Quals.addObjCGCAttr(GCAttr);
1913
1914  return getExtQualType(TypeNode, Quals);
1915}
1916
1917const FunctionType *ASTContext::adjustFunctionType(const FunctionType *T,
1918                                                   FunctionType::ExtInfo Info) {
1919  if (T->getExtInfo() == Info)
1920    return T;
1921
1922  QualType Result;
1923  if (const FunctionNoProtoType *FNPT = dyn_cast<FunctionNoProtoType>(T)) {
1924    Result = getFunctionNoProtoType(FNPT->getResultType(), Info);
1925  } else {
1926    const FunctionProtoType *FPT = cast<FunctionProtoType>(T);
1927    FunctionProtoType::ExtProtoInfo EPI = FPT->getExtProtoInfo();
1928    EPI.ExtInfo = Info;
1929    Result = getFunctionType(FPT->getResultType(), FPT->arg_type_begin(),
1930                             FPT->getNumArgs(), EPI);
1931  }
1932
1933  return cast<FunctionType>(Result.getTypePtr());
1934}
1935
1936/// getComplexType - Return the uniqued reference to the type for a complex
1937/// number with the specified element type.
1938QualType ASTContext::getComplexType(QualType T) const {
1939  // Unique pointers, to guarantee there is only one pointer of a particular
1940  // structure.
1941  llvm::FoldingSetNodeID ID;
1942  ComplexType::Profile(ID, T);
1943
1944  void *InsertPos = 0;
1945  if (ComplexType *CT = ComplexTypes.FindNodeOrInsertPos(ID, InsertPos))
1946    return QualType(CT, 0);
1947
1948  // If the pointee type isn't canonical, this won't be a canonical type either,
1949  // so fill in the canonical type field.
1950  QualType Canonical;
1951  if (!T.isCanonical()) {
1952    Canonical = getComplexType(getCanonicalType(T));
1953
1954    // Get the new insert position for the node we care about.
1955    ComplexType *NewIP = ComplexTypes.FindNodeOrInsertPos(ID, InsertPos);
1956    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
1957  }
1958  ComplexType *New = new (*this, TypeAlignment) ComplexType(T, Canonical);
1959  Types.push_back(New);
1960  ComplexTypes.InsertNode(New, InsertPos);
1961  return QualType(New, 0);
1962}
1963
1964/// getPointerType - Return the uniqued reference to the type for a pointer to
1965/// the specified type.
1966QualType ASTContext::getPointerType(QualType T) const {
1967  // Unique pointers, to guarantee there is only one pointer of a particular
1968  // structure.
1969  llvm::FoldingSetNodeID ID;
1970  PointerType::Profile(ID, T);
1971
1972  void *InsertPos = 0;
1973  if (PointerType *PT = PointerTypes.FindNodeOrInsertPos(ID, InsertPos))
1974    return QualType(PT, 0);
1975
1976  // If the pointee type isn't canonical, this won't be a canonical type either,
1977  // so fill in the canonical type field.
1978  QualType Canonical;
1979  if (!T.isCanonical()) {
1980    Canonical = getPointerType(getCanonicalType(T));
1981
1982    // Get the new insert position for the node we care about.
1983    PointerType *NewIP = PointerTypes.FindNodeOrInsertPos(ID, InsertPos);
1984    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
1985  }
1986  PointerType *New = new (*this, TypeAlignment) PointerType(T, Canonical);
1987  Types.push_back(New);
1988  PointerTypes.InsertNode(New, InsertPos);
1989  return QualType(New, 0);
1990}
1991
1992/// getBlockPointerType - Return the uniqued reference to the type for
1993/// a pointer to the specified block.
1994QualType ASTContext::getBlockPointerType(QualType T) const {
1995  assert(T->isFunctionType() && "block of function types only");
1996  // Unique pointers, to guarantee there is only one block of a particular
1997  // structure.
1998  llvm::FoldingSetNodeID ID;
1999  BlockPointerType::Profile(ID, T);
2000
2001  void *InsertPos = 0;
2002  if (BlockPointerType *PT =
2003        BlockPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
2004    return QualType(PT, 0);
2005
2006  // If the block pointee type isn't canonical, this won't be a canonical
2007  // type either so fill in the canonical type field.
2008  QualType Canonical;
2009  if (!T.isCanonical()) {
2010    Canonical = getBlockPointerType(getCanonicalType(T));
2011
2012    // Get the new insert position for the node we care about.
2013    BlockPointerType *NewIP =
2014      BlockPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
2015    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
2016  }
2017  BlockPointerType *New
2018    = new (*this, TypeAlignment) BlockPointerType(T, Canonical);
2019  Types.push_back(New);
2020  BlockPointerTypes.InsertNode(New, InsertPos);
2021  return QualType(New, 0);
2022}
2023
2024/// getLValueReferenceType - Return the uniqued reference to the type for an
2025/// lvalue reference to the specified type.
2026QualType
2027ASTContext::getLValueReferenceType(QualType T, bool SpelledAsLValue) const {
2028  assert(getCanonicalType(T) != OverloadTy &&
2029         "Unresolved overloaded function type");
2030
2031  // Unique pointers, to guarantee there is only one pointer of a particular
2032  // structure.
2033  llvm::FoldingSetNodeID ID;
2034  ReferenceType::Profile(ID, T, SpelledAsLValue);
2035
2036  void *InsertPos = 0;
2037  if (LValueReferenceType *RT =
2038        LValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos))
2039    return QualType(RT, 0);
2040
2041  const ReferenceType *InnerRef = T->getAs<ReferenceType>();
2042
2043  // If the referencee type isn't canonical, this won't be a canonical type
2044  // either, so fill in the canonical type field.
2045  QualType Canonical;
2046  if (!SpelledAsLValue || InnerRef || !T.isCanonical()) {
2047    QualType PointeeType = (InnerRef ? InnerRef->getPointeeType() : T);
2048    Canonical = getLValueReferenceType(getCanonicalType(PointeeType));
2049
2050    // Get the new insert position for the node we care about.
2051    LValueReferenceType *NewIP =
2052      LValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos);
2053    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
2054  }
2055
2056  LValueReferenceType *New
2057    = new (*this, TypeAlignment) LValueReferenceType(T, Canonical,
2058                                                     SpelledAsLValue);
2059  Types.push_back(New);
2060  LValueReferenceTypes.InsertNode(New, InsertPos);
2061
2062  return QualType(New, 0);
2063}
2064
2065/// getRValueReferenceType - Return the uniqued reference to the type for an
2066/// rvalue reference to the specified type.
2067QualType ASTContext::getRValueReferenceType(QualType T) const {
2068  // Unique pointers, to guarantee there is only one pointer of a particular
2069  // structure.
2070  llvm::FoldingSetNodeID ID;
2071  ReferenceType::Profile(ID, T, false);
2072
2073  void *InsertPos = 0;
2074  if (RValueReferenceType *RT =
2075        RValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos))
2076    return QualType(RT, 0);
2077
2078  const ReferenceType *InnerRef = T->getAs<ReferenceType>();
2079
2080  // If the referencee type isn't canonical, this won't be a canonical type
2081  // either, so fill in the canonical type field.
2082  QualType Canonical;
2083  if (InnerRef || !T.isCanonical()) {
2084    QualType PointeeType = (InnerRef ? InnerRef->getPointeeType() : T);
2085    Canonical = getRValueReferenceType(getCanonicalType(PointeeType));
2086
2087    // Get the new insert position for the node we care about.
2088    RValueReferenceType *NewIP =
2089      RValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos);
2090    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
2091  }
2092
2093  RValueReferenceType *New
2094    = new (*this, TypeAlignment) RValueReferenceType(T, Canonical);
2095  Types.push_back(New);
2096  RValueReferenceTypes.InsertNode(New, InsertPos);
2097  return QualType(New, 0);
2098}
2099
2100/// getMemberPointerType - Return the uniqued reference to the type for a
2101/// member pointer to the specified type, in the specified class.
2102QualType ASTContext::getMemberPointerType(QualType T, const Type *Cls) const {
2103  // Unique pointers, to guarantee there is only one pointer of a particular
2104  // structure.
2105  llvm::FoldingSetNodeID ID;
2106  MemberPointerType::Profile(ID, T, Cls);
2107
2108  void *InsertPos = 0;
2109  if (MemberPointerType *PT =
2110      MemberPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
2111    return QualType(PT, 0);
2112
2113  // If the pointee or class type isn't canonical, this won't be a canonical
2114  // type either, so fill in the canonical type field.
2115  QualType Canonical;
2116  if (!T.isCanonical() || !Cls->isCanonicalUnqualified()) {
2117    Canonical = getMemberPointerType(getCanonicalType(T),getCanonicalType(Cls));
2118
2119    // Get the new insert position for the node we care about.
2120    MemberPointerType *NewIP =
2121      MemberPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
2122    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
2123  }
2124  MemberPointerType *New
2125    = new (*this, TypeAlignment) MemberPointerType(T, Cls, Canonical);
2126  Types.push_back(New);
2127  MemberPointerTypes.InsertNode(New, InsertPos);
2128  return QualType(New, 0);
2129}
2130
2131/// getConstantArrayType - Return the unique reference to the type for an
2132/// array of the specified element type.
2133QualType ASTContext::getConstantArrayType(QualType EltTy,
2134                                          const llvm::APInt &ArySizeIn,
2135                                          ArrayType::ArraySizeModifier ASM,
2136                                          unsigned IndexTypeQuals) const {
2137  assert((EltTy->isDependentType() ||
2138          EltTy->isIncompleteType() || EltTy->isConstantSizeType()) &&
2139         "Constant array of VLAs is illegal!");
2140
2141  // Convert the array size into a canonical width matching the pointer size for
2142  // the target.
2143  llvm::APInt ArySize(ArySizeIn);
2144  ArySize =
2145    ArySize.zextOrTrunc(Target->getPointerWidth(getTargetAddressSpace(EltTy)));
2146
2147  llvm::FoldingSetNodeID ID;
2148  ConstantArrayType::Profile(ID, EltTy, ArySize, ASM, IndexTypeQuals);
2149
2150  void *InsertPos = 0;
2151  if (ConstantArrayType *ATP =
2152      ConstantArrayTypes.FindNodeOrInsertPos(ID, InsertPos))
2153    return QualType(ATP, 0);
2154
2155  // If the element type isn't canonical or has qualifiers, this won't
2156  // be a canonical type either, so fill in the canonical type field.
2157  QualType Canon;
2158  if (!EltTy.isCanonical() || EltTy.hasLocalQualifiers()) {
2159    SplitQualType canonSplit = getCanonicalType(EltTy).split();
2160    Canon = getConstantArrayType(QualType(canonSplit.Ty, 0), ArySize,
2161                                 ASM, IndexTypeQuals);
2162    Canon = getQualifiedType(Canon, canonSplit.Quals);
2163
2164    // Get the new insert position for the node we care about.
2165    ConstantArrayType *NewIP =
2166      ConstantArrayTypes.FindNodeOrInsertPos(ID, InsertPos);
2167    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
2168  }
2169
2170  ConstantArrayType *New = new(*this,TypeAlignment)
2171    ConstantArrayType(EltTy, Canon, ArySize, ASM, IndexTypeQuals);
2172  ConstantArrayTypes.InsertNode(New, InsertPos);
2173  Types.push_back(New);
2174  return QualType(New, 0);
2175}
2176
2177/// getVariableArrayDecayedType - Turns the given type, which may be
2178/// variably-modified, into the corresponding type with all the known
2179/// sizes replaced with [*].
2180QualType ASTContext::getVariableArrayDecayedType(QualType type) const {
2181  // Vastly most common case.
2182  if (!type->isVariablyModifiedType()) return type;
2183
2184  QualType result;
2185
2186  SplitQualType split = type.getSplitDesugaredType();
2187  const Type *ty = split.Ty;
2188  switch (ty->getTypeClass()) {
2189#define TYPE(Class, Base)
2190#define ABSTRACT_TYPE(Class, Base)
2191#define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
2192#include "clang/AST/TypeNodes.def"
2193    llvm_unreachable("didn't desugar past all non-canonical types?");
2194
2195  // These types should never be variably-modified.
2196  case Type::Builtin:
2197  case Type::Complex:
2198  case Type::Vector:
2199  case Type::ExtVector:
2200  case Type::DependentSizedExtVector:
2201  case Type::ObjCObject:
2202  case Type::ObjCInterface:
2203  case Type::ObjCObjectPointer:
2204  case Type::Record:
2205  case Type::Enum:
2206  case Type::UnresolvedUsing:
2207  case Type::TypeOfExpr:
2208  case Type::TypeOf:
2209  case Type::Decltype:
2210  case Type::UnaryTransform:
2211  case Type::DependentName:
2212  case Type::InjectedClassName:
2213  case Type::TemplateSpecialization:
2214  case Type::DependentTemplateSpecialization:
2215  case Type::TemplateTypeParm:
2216  case Type::SubstTemplateTypeParmPack:
2217  case Type::Auto:
2218  case Type::PackExpansion:
2219    llvm_unreachable("type should never be variably-modified");
2220
2221  // These types can be variably-modified but should never need to
2222  // further decay.
2223  case Type::FunctionNoProto:
2224  case Type::FunctionProto:
2225  case Type::BlockPointer:
2226  case Type::MemberPointer:
2227    return type;
2228
2229  // These types can be variably-modified.  All these modifications
2230  // preserve structure except as noted by comments.
2231  // TODO: if we ever care about optimizing VLAs, there are no-op
2232  // optimizations available here.
2233  case Type::Pointer:
2234    result = getPointerType(getVariableArrayDecayedType(
2235                              cast<PointerType>(ty)->getPointeeType()));
2236    break;
2237
2238  case Type::LValueReference: {
2239    const LValueReferenceType *lv = cast<LValueReferenceType>(ty);
2240    result = getLValueReferenceType(
2241                 getVariableArrayDecayedType(lv->getPointeeType()),
2242                                    lv->isSpelledAsLValue());
2243    break;
2244  }
2245
2246  case Type::RValueReference: {
2247    const RValueReferenceType *lv = cast<RValueReferenceType>(ty);
2248    result = getRValueReferenceType(
2249                 getVariableArrayDecayedType(lv->getPointeeType()));
2250    break;
2251  }
2252
2253  case Type::Atomic: {
2254    const AtomicType *at = cast<AtomicType>(ty);
2255    result = getAtomicType(getVariableArrayDecayedType(at->getValueType()));
2256    break;
2257  }
2258
2259  case Type::ConstantArray: {
2260    const ConstantArrayType *cat = cast<ConstantArrayType>(ty);
2261    result = getConstantArrayType(
2262                 getVariableArrayDecayedType(cat->getElementType()),
2263                                  cat->getSize(),
2264                                  cat->getSizeModifier(),
2265                                  cat->getIndexTypeCVRQualifiers());
2266    break;
2267  }
2268
2269  case Type::DependentSizedArray: {
2270    const DependentSizedArrayType *dat = cast<DependentSizedArrayType>(ty);
2271    result = getDependentSizedArrayType(
2272                 getVariableArrayDecayedType(dat->getElementType()),
2273                                        dat->getSizeExpr(),
2274                                        dat->getSizeModifier(),
2275                                        dat->getIndexTypeCVRQualifiers(),
2276                                        dat->getBracketsRange());
2277    break;
2278  }
2279
2280  // Turn incomplete types into [*] types.
2281  case Type::IncompleteArray: {
2282    const IncompleteArrayType *iat = cast<IncompleteArrayType>(ty);
2283    result = getVariableArrayType(
2284                 getVariableArrayDecayedType(iat->getElementType()),
2285                                  /*size*/ 0,
2286                                  ArrayType::Normal,
2287                                  iat->getIndexTypeCVRQualifiers(),
2288                                  SourceRange());
2289    break;
2290  }
2291
2292  // Turn VLA types into [*] types.
2293  case Type::VariableArray: {
2294    const VariableArrayType *vat = cast<VariableArrayType>(ty);
2295    result = getVariableArrayType(
2296                 getVariableArrayDecayedType(vat->getElementType()),
2297                                  /*size*/ 0,
2298                                  ArrayType::Star,
2299                                  vat->getIndexTypeCVRQualifiers(),
2300                                  vat->getBracketsRange());
2301    break;
2302  }
2303  }
2304
2305  // Apply the top-level qualifiers from the original.
2306  return getQualifiedType(result, split.Quals);
2307}
2308
2309/// getVariableArrayType - Returns a non-unique reference to the type for a
2310/// variable array of the specified element type.
2311QualType ASTContext::getVariableArrayType(QualType EltTy,
2312                                          Expr *NumElts,
2313                                          ArrayType::ArraySizeModifier ASM,
2314                                          unsigned IndexTypeQuals,
2315                                          SourceRange Brackets) const {
2316  // Since we don't unique expressions, it isn't possible to unique VLA's
2317  // that have an expression provided for their size.
2318  QualType Canon;
2319
2320  // Be sure to pull qualifiers off the element type.
2321  if (!EltTy.isCanonical() || EltTy.hasLocalQualifiers()) {
2322    SplitQualType canonSplit = getCanonicalType(EltTy).split();
2323    Canon = getVariableArrayType(QualType(canonSplit.Ty, 0), NumElts, ASM,
2324                                 IndexTypeQuals, Brackets);
2325    Canon = getQualifiedType(Canon, canonSplit.Quals);
2326  }
2327
2328  VariableArrayType *New = new(*this, TypeAlignment)
2329    VariableArrayType(EltTy, Canon, NumElts, ASM, IndexTypeQuals, Brackets);
2330
2331  VariableArrayTypes.push_back(New);
2332  Types.push_back(New);
2333  return QualType(New, 0);
2334}
2335
2336/// getDependentSizedArrayType - Returns a non-unique reference to
2337/// the type for a dependently-sized array of the specified element
2338/// type.
2339QualType ASTContext::getDependentSizedArrayType(QualType elementType,
2340                                                Expr *numElements,
2341                                                ArrayType::ArraySizeModifier ASM,
2342                                                unsigned elementTypeQuals,
2343                                                SourceRange brackets) const {
2344  assert((!numElements || numElements->isTypeDependent() ||
2345          numElements->isValueDependent()) &&
2346         "Size must be type- or value-dependent!");
2347
2348  // Dependently-sized array types that do not have a specified number
2349  // of elements will have their sizes deduced from a dependent
2350  // initializer.  We do no canonicalization here at all, which is okay
2351  // because they can't be used in most locations.
2352  if (!numElements) {
2353    DependentSizedArrayType *newType
2354      = new (*this, TypeAlignment)
2355          DependentSizedArrayType(*this, elementType, QualType(),
2356                                  numElements, ASM, elementTypeQuals,
2357                                  brackets);
2358    Types.push_back(newType);
2359    return QualType(newType, 0);
2360  }
2361
2362  // Otherwise, we actually build a new type every time, but we
2363  // also build a canonical type.
2364
2365  SplitQualType canonElementType = getCanonicalType(elementType).split();
2366
2367  void *insertPos = 0;
2368  llvm::FoldingSetNodeID ID;
2369  DependentSizedArrayType::Profile(ID, *this,
2370                                   QualType(canonElementType.Ty, 0),
2371                                   ASM, elementTypeQuals, numElements);
2372
2373  // Look for an existing type with these properties.
2374  DependentSizedArrayType *canonTy =
2375    DependentSizedArrayTypes.FindNodeOrInsertPos(ID, insertPos);
2376
2377  // If we don't have one, build one.
2378  if (!canonTy) {
2379    canonTy = new (*this, TypeAlignment)
2380      DependentSizedArrayType(*this, QualType(canonElementType.Ty, 0),
2381                              QualType(), numElements, ASM, elementTypeQuals,
2382                              brackets);
2383    DependentSizedArrayTypes.InsertNode(canonTy, insertPos);
2384    Types.push_back(canonTy);
2385  }
2386
2387  // Apply qualifiers from the element type to the array.
2388  QualType canon = getQualifiedType(QualType(canonTy,0),
2389                                    canonElementType.Quals);
2390
2391  // If we didn't need extra canonicalization for the element type,
2392  // then just use that as our result.
2393  if (QualType(canonElementType.Ty, 0) == elementType)
2394    return canon;
2395
2396  // Otherwise, we need to build a type which follows the spelling
2397  // of the element type.
2398  DependentSizedArrayType *sugaredType
2399    = new (*this, TypeAlignment)
2400        DependentSizedArrayType(*this, elementType, canon, numElements,
2401                                ASM, elementTypeQuals, brackets);
2402  Types.push_back(sugaredType);
2403  return QualType(sugaredType, 0);
2404}
2405
2406QualType ASTContext::getIncompleteArrayType(QualType elementType,
2407                                            ArrayType::ArraySizeModifier ASM,
2408                                            unsigned elementTypeQuals) const {
2409  llvm::FoldingSetNodeID ID;
2410  IncompleteArrayType::Profile(ID, elementType, ASM, elementTypeQuals);
2411
2412  void *insertPos = 0;
2413  if (IncompleteArrayType *iat =
2414       IncompleteArrayTypes.FindNodeOrInsertPos(ID, insertPos))
2415    return QualType(iat, 0);
2416
2417  // If the element type isn't canonical, this won't be a canonical type
2418  // either, so fill in the canonical type field.  We also have to pull
2419  // qualifiers off the element type.
2420  QualType canon;
2421
2422  if (!elementType.isCanonical() || elementType.hasLocalQualifiers()) {
2423    SplitQualType canonSplit = getCanonicalType(elementType).split();
2424    canon = getIncompleteArrayType(QualType(canonSplit.Ty, 0),
2425                                   ASM, elementTypeQuals);
2426    canon = getQualifiedType(canon, canonSplit.Quals);
2427
2428    // Get the new insert position for the node we care about.
2429    IncompleteArrayType *existing =
2430      IncompleteArrayTypes.FindNodeOrInsertPos(ID, insertPos);
2431    assert(!existing && "Shouldn't be in the map!"); (void) existing;
2432  }
2433
2434  IncompleteArrayType *newType = new (*this, TypeAlignment)
2435    IncompleteArrayType(elementType, canon, ASM, elementTypeQuals);
2436
2437  IncompleteArrayTypes.InsertNode(newType, insertPos);
2438  Types.push_back(newType);
2439  return QualType(newType, 0);
2440}
2441
2442/// getVectorType - Return the unique reference to a vector type of
2443/// the specified element type and size. VectorType must be a built-in type.
2444QualType ASTContext::getVectorType(QualType vecType, unsigned NumElts,
2445                                   VectorType::VectorKind VecKind) const {
2446  assert(vecType->isBuiltinType());
2447
2448  // Check if we've already instantiated a vector of this type.
2449  llvm::FoldingSetNodeID ID;
2450  VectorType::Profile(ID, vecType, NumElts, Type::Vector, VecKind);
2451
2452  void *InsertPos = 0;
2453  if (VectorType *VTP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos))
2454    return QualType(VTP, 0);
2455
2456  // If the element type isn't canonical, this won't be a canonical type either,
2457  // so fill in the canonical type field.
2458  QualType Canonical;
2459  if (!vecType.isCanonical()) {
2460    Canonical = getVectorType(getCanonicalType(vecType), NumElts, VecKind);
2461
2462    // Get the new insert position for the node we care about.
2463    VectorType *NewIP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos);
2464    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
2465  }
2466  VectorType *New = new (*this, TypeAlignment)
2467    VectorType(vecType, NumElts, Canonical, VecKind);
2468  VectorTypes.InsertNode(New, InsertPos);
2469  Types.push_back(New);
2470  return QualType(New, 0);
2471}
2472
2473/// getExtVectorType - Return the unique reference to an extended vector type of
2474/// the specified element type and size. VectorType must be a built-in type.
2475QualType
2476ASTContext::getExtVectorType(QualType vecType, unsigned NumElts) const {
2477  assert(vecType->isBuiltinType() || vecType->isDependentType());
2478
2479  // Check if we've already instantiated a vector of this type.
2480  llvm::FoldingSetNodeID ID;
2481  VectorType::Profile(ID, vecType, NumElts, Type::ExtVector,
2482                      VectorType::GenericVector);
2483  void *InsertPos = 0;
2484  if (VectorType *VTP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos))
2485    return QualType(VTP, 0);
2486
2487  // If the element type isn't canonical, this won't be a canonical type either,
2488  // so fill in the canonical type field.
2489  QualType Canonical;
2490  if (!vecType.isCanonical()) {
2491    Canonical = getExtVectorType(getCanonicalType(vecType), NumElts);
2492
2493    // Get the new insert position for the node we care about.
2494    VectorType *NewIP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos);
2495    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
2496  }
2497  ExtVectorType *New = new (*this, TypeAlignment)
2498    ExtVectorType(vecType, NumElts, Canonical);
2499  VectorTypes.InsertNode(New, InsertPos);
2500  Types.push_back(New);
2501  return QualType(New, 0);
2502}
2503
2504QualType
2505ASTContext::getDependentSizedExtVectorType(QualType vecType,
2506                                           Expr *SizeExpr,
2507                                           SourceLocation AttrLoc) const {
2508  llvm::FoldingSetNodeID ID;
2509  DependentSizedExtVectorType::Profile(ID, *this, getCanonicalType(vecType),
2510                                       SizeExpr);
2511
2512  void *InsertPos = 0;
2513  DependentSizedExtVectorType *Canon
2514    = DependentSizedExtVectorTypes.FindNodeOrInsertPos(ID, InsertPos);
2515  DependentSizedExtVectorType *New;
2516  if (Canon) {
2517    // We already have a canonical version of this array type; use it as
2518    // the canonical type for a newly-built type.
2519    New = new (*this, TypeAlignment)
2520      DependentSizedExtVectorType(*this, vecType, QualType(Canon, 0),
2521                                  SizeExpr, AttrLoc);
2522  } else {
2523    QualType CanonVecTy = getCanonicalType(vecType);
2524    if (CanonVecTy == vecType) {
2525      New = new (*this, TypeAlignment)
2526        DependentSizedExtVectorType(*this, vecType, QualType(), SizeExpr,
2527                                    AttrLoc);
2528
2529      DependentSizedExtVectorType *CanonCheck
2530        = DependentSizedExtVectorTypes.FindNodeOrInsertPos(ID, InsertPos);
2531      assert(!CanonCheck && "Dependent-sized ext_vector canonical type broken");
2532      (void)CanonCheck;
2533      DependentSizedExtVectorTypes.InsertNode(New, InsertPos);
2534    } else {
2535      QualType Canon = getDependentSizedExtVectorType(CanonVecTy, SizeExpr,
2536                                                      SourceLocation());
2537      New = new (*this, TypeAlignment)
2538        DependentSizedExtVectorType(*this, vecType, Canon, SizeExpr, AttrLoc);
2539    }
2540  }
2541
2542  Types.push_back(New);
2543  return QualType(New, 0);
2544}
2545
2546/// getFunctionNoProtoType - Return a K&R style C function type like 'int()'.
2547///
2548QualType
2549ASTContext::getFunctionNoProtoType(QualType ResultTy,
2550                                   const FunctionType::ExtInfo &Info) const {
2551  const CallingConv DefaultCC = Info.getCC();
2552  const CallingConv CallConv = (LangOpts.MRTD && DefaultCC == CC_Default) ?
2553                               CC_X86StdCall : DefaultCC;
2554  // Unique functions, to guarantee there is only one function of a particular
2555  // structure.
2556  llvm::FoldingSetNodeID ID;
2557  FunctionNoProtoType::Profile(ID, ResultTy, Info);
2558
2559  void *InsertPos = 0;
2560  if (FunctionNoProtoType *FT =
2561        FunctionNoProtoTypes.FindNodeOrInsertPos(ID, InsertPos))
2562    return QualType(FT, 0);
2563
2564  QualType Canonical;
2565  if (!ResultTy.isCanonical() ||
2566      getCanonicalCallConv(CallConv) != CallConv) {
2567    Canonical =
2568      getFunctionNoProtoType(getCanonicalType(ResultTy),
2569                     Info.withCallingConv(getCanonicalCallConv(CallConv)));
2570
2571    // Get the new insert position for the node we care about.
2572    FunctionNoProtoType *NewIP =
2573      FunctionNoProtoTypes.FindNodeOrInsertPos(ID, InsertPos);
2574    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
2575  }
2576
2577  FunctionProtoType::ExtInfo newInfo = Info.withCallingConv(CallConv);
2578  FunctionNoProtoType *New = new (*this, TypeAlignment)
2579    FunctionNoProtoType(ResultTy, Canonical, newInfo);
2580  Types.push_back(New);
2581  FunctionNoProtoTypes.InsertNode(New, InsertPos);
2582  return QualType(New, 0);
2583}
2584
2585/// getFunctionType - Return a normal function type with a typed argument
2586/// list.  isVariadic indicates whether the argument list includes '...'.
2587QualType
2588ASTContext::getFunctionType(QualType ResultTy,
2589                            const QualType *ArgArray, unsigned NumArgs,
2590                            const FunctionProtoType::ExtProtoInfo &EPI) const {
2591  // Unique functions, to guarantee there is only one function of a particular
2592  // structure.
2593  llvm::FoldingSetNodeID ID;
2594  FunctionProtoType::Profile(ID, ResultTy, ArgArray, NumArgs, EPI, *this);
2595
2596  void *InsertPos = 0;
2597  if (FunctionProtoType *FTP =
2598        FunctionProtoTypes.FindNodeOrInsertPos(ID, InsertPos))
2599    return QualType(FTP, 0);
2600
2601  // Determine whether the type being created is already canonical or not.
2602  bool isCanonical =
2603    EPI.ExceptionSpecType == EST_None && ResultTy.isCanonical() &&
2604    !EPI.HasTrailingReturn;
2605  for (unsigned i = 0; i != NumArgs && isCanonical; ++i)
2606    if (!ArgArray[i].isCanonicalAsParam())
2607      isCanonical = false;
2608
2609  const CallingConv DefaultCC = EPI.ExtInfo.getCC();
2610  const CallingConv CallConv = (LangOpts.MRTD && DefaultCC == CC_Default) ?
2611                               CC_X86StdCall : DefaultCC;
2612
2613  // If this type isn't canonical, get the canonical version of it.
2614  // The exception spec is not part of the canonical type.
2615  QualType Canonical;
2616  if (!isCanonical || getCanonicalCallConv(CallConv) != CallConv) {
2617    SmallVector<QualType, 16> CanonicalArgs;
2618    CanonicalArgs.reserve(NumArgs);
2619    for (unsigned i = 0; i != NumArgs; ++i)
2620      CanonicalArgs.push_back(getCanonicalParamType(ArgArray[i]));
2621
2622    FunctionProtoType::ExtProtoInfo CanonicalEPI = EPI;
2623    CanonicalEPI.HasTrailingReturn = false;
2624    CanonicalEPI.ExceptionSpecType = EST_None;
2625    CanonicalEPI.NumExceptions = 0;
2626    CanonicalEPI.ExtInfo
2627      = CanonicalEPI.ExtInfo.withCallingConv(getCanonicalCallConv(CallConv));
2628
2629    Canonical = getFunctionType(getCanonicalType(ResultTy),
2630                                CanonicalArgs.data(), NumArgs,
2631                                CanonicalEPI);
2632
2633    // Get the new insert position for the node we care about.
2634    FunctionProtoType *NewIP =
2635      FunctionProtoTypes.FindNodeOrInsertPos(ID, InsertPos);
2636    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
2637  }
2638
2639  // FunctionProtoType objects are allocated with extra bytes after
2640  // them for three variable size arrays at the end:
2641  //  - parameter types
2642  //  - exception types
2643  //  - consumed-arguments flags
2644  // Instead of the exception types, there could be a noexcept
2645  // expression, or information used to resolve the exception
2646  // specification.
2647  size_t Size = sizeof(FunctionProtoType) +
2648                NumArgs * sizeof(QualType);
2649  if (EPI.ExceptionSpecType == EST_Dynamic) {
2650    Size += EPI.NumExceptions * sizeof(QualType);
2651  } else if (EPI.ExceptionSpecType == EST_ComputedNoexcept) {
2652    Size += sizeof(Expr*);
2653  } else if (EPI.ExceptionSpecType == EST_Uninstantiated) {
2654    Size += 2 * sizeof(FunctionDecl*);
2655  } else if (EPI.ExceptionSpecType == EST_Unevaluated) {
2656    Size += sizeof(FunctionDecl*);
2657  }
2658  if (EPI.ConsumedArguments)
2659    Size += NumArgs * sizeof(bool);
2660
2661  FunctionProtoType *FTP = (FunctionProtoType*) Allocate(Size, TypeAlignment);
2662  FunctionProtoType::ExtProtoInfo newEPI = EPI;
2663  newEPI.ExtInfo = EPI.ExtInfo.withCallingConv(CallConv);
2664  new (FTP) FunctionProtoType(ResultTy, ArgArray, NumArgs, Canonical, newEPI);
2665  Types.push_back(FTP);
2666  FunctionProtoTypes.InsertNode(FTP, InsertPos);
2667  return QualType(FTP, 0);
2668}
2669
2670#ifndef NDEBUG
2671static bool NeedsInjectedClassNameType(const RecordDecl *D) {
2672  if (!isa<CXXRecordDecl>(D)) return false;
2673  const CXXRecordDecl *RD = cast<CXXRecordDecl>(D);
2674  if (isa<ClassTemplatePartialSpecializationDecl>(RD))
2675    return true;
2676  if (RD->getDescribedClassTemplate() &&
2677      !isa<ClassTemplateSpecializationDecl>(RD))
2678    return true;
2679  return false;
2680}
2681#endif
2682
2683/// getInjectedClassNameType - Return the unique reference to the
2684/// injected class name type for the specified templated declaration.
2685QualType ASTContext::getInjectedClassNameType(CXXRecordDecl *Decl,
2686                                              QualType TST) const {
2687  assert(NeedsInjectedClassNameType(Decl));
2688  if (Decl->TypeForDecl) {
2689    assert(isa<InjectedClassNameType>(Decl->TypeForDecl));
2690  } else if (CXXRecordDecl *PrevDecl = Decl->getPreviousDecl()) {
2691    assert(PrevDecl->TypeForDecl && "previous declaration has no type");
2692    Decl->TypeForDecl = PrevDecl->TypeForDecl;
2693    assert(isa<InjectedClassNameType>(Decl->TypeForDecl));
2694  } else {
2695    Type *newType =
2696      new (*this, TypeAlignment) InjectedClassNameType(Decl, TST);
2697    Decl->TypeForDecl = newType;
2698    Types.push_back(newType);
2699  }
2700  return QualType(Decl->TypeForDecl, 0);
2701}
2702
2703/// getTypeDeclType - Return the unique reference to the type for the
2704/// specified type declaration.
2705QualType ASTContext::getTypeDeclTypeSlow(const TypeDecl *Decl) const {
2706  assert(Decl && "Passed null for Decl param");
2707  assert(!Decl->TypeForDecl && "TypeForDecl present in slow case");
2708
2709  if (const TypedefNameDecl *Typedef = dyn_cast<TypedefNameDecl>(Decl))
2710    return getTypedefType(Typedef);
2711
2712  assert(!isa<TemplateTypeParmDecl>(Decl) &&
2713         "Template type parameter types are always available.");
2714
2715  if (const RecordDecl *Record = dyn_cast<RecordDecl>(Decl)) {
2716    assert(!Record->getPreviousDecl() &&
2717           "struct/union has previous declaration");
2718    assert(!NeedsInjectedClassNameType(Record));
2719    return getRecordType(Record);
2720  } else if (const EnumDecl *Enum = dyn_cast<EnumDecl>(Decl)) {
2721    assert(!Enum->getPreviousDecl() &&
2722           "enum has previous declaration");
2723    return getEnumType(Enum);
2724  } else if (const UnresolvedUsingTypenameDecl *Using =
2725               dyn_cast<UnresolvedUsingTypenameDecl>(Decl)) {
2726    Type *newType = new (*this, TypeAlignment) UnresolvedUsingType(Using);
2727    Decl->TypeForDecl = newType;
2728    Types.push_back(newType);
2729  } else
2730    llvm_unreachable("TypeDecl without a type?");
2731
2732  return QualType(Decl->TypeForDecl, 0);
2733}
2734
2735/// getTypedefType - Return the unique reference to the type for the
2736/// specified typedef name decl.
2737QualType
2738ASTContext::getTypedefType(const TypedefNameDecl *Decl,
2739                           QualType Canonical) const {
2740  if (Decl->TypeForDecl) return QualType(Decl->TypeForDecl, 0);
2741
2742  if (Canonical.isNull())
2743    Canonical = getCanonicalType(Decl->getUnderlyingType());
2744  TypedefType *newType = new(*this, TypeAlignment)
2745    TypedefType(Type::Typedef, Decl, Canonical);
2746  Decl->TypeForDecl = newType;
2747  Types.push_back(newType);
2748  return QualType(newType, 0);
2749}
2750
2751QualType ASTContext::getRecordType(const RecordDecl *Decl) const {
2752  if (Decl->TypeForDecl) return QualType(Decl->TypeForDecl, 0);
2753
2754  if (const RecordDecl *PrevDecl = Decl->getPreviousDecl())
2755    if (PrevDecl->TypeForDecl)
2756      return QualType(Decl->TypeForDecl = PrevDecl->TypeForDecl, 0);
2757
2758  RecordType *newType = new (*this, TypeAlignment) RecordType(Decl);
2759  Decl->TypeForDecl = newType;
2760  Types.push_back(newType);
2761  return QualType(newType, 0);
2762}
2763
2764QualType ASTContext::getEnumType(const EnumDecl *Decl) const {
2765  if (Decl->TypeForDecl) return QualType(Decl->TypeForDecl, 0);
2766
2767  if (const EnumDecl *PrevDecl = Decl->getPreviousDecl())
2768    if (PrevDecl->TypeForDecl)
2769      return QualType(Decl->TypeForDecl = PrevDecl->TypeForDecl, 0);
2770
2771  EnumType *newType = new (*this, TypeAlignment) EnumType(Decl);
2772  Decl->TypeForDecl = newType;
2773  Types.push_back(newType);
2774  return QualType(newType, 0);
2775}
2776
2777QualType ASTContext::getAttributedType(AttributedType::Kind attrKind,
2778                                       QualType modifiedType,
2779                                       QualType equivalentType) {
2780  llvm::FoldingSetNodeID id;
2781  AttributedType::Profile(id, attrKind, modifiedType, equivalentType);
2782
2783  void *insertPos = 0;
2784  AttributedType *type = AttributedTypes.FindNodeOrInsertPos(id, insertPos);
2785  if (type) return QualType(type, 0);
2786
2787  QualType canon = getCanonicalType(equivalentType);
2788  type = new (*this, TypeAlignment)
2789           AttributedType(canon, attrKind, modifiedType, equivalentType);
2790
2791  Types.push_back(type);
2792  AttributedTypes.InsertNode(type, insertPos);
2793
2794  return QualType(type, 0);
2795}
2796
2797
2798/// \brief Retrieve a substitution-result type.
2799QualType
2800ASTContext::getSubstTemplateTypeParmType(const TemplateTypeParmType *Parm,
2801                                         QualType Replacement) const {
2802  assert(Replacement.isCanonical()
2803         && "replacement types must always be canonical");
2804
2805  llvm::FoldingSetNodeID ID;
2806  SubstTemplateTypeParmType::Profile(ID, Parm, Replacement);
2807  void *InsertPos = 0;
2808  SubstTemplateTypeParmType *SubstParm
2809    = SubstTemplateTypeParmTypes.FindNodeOrInsertPos(ID, InsertPos);
2810
2811  if (!SubstParm) {
2812    SubstParm = new (*this, TypeAlignment)
2813      SubstTemplateTypeParmType(Parm, Replacement);
2814    Types.push_back(SubstParm);
2815    SubstTemplateTypeParmTypes.InsertNode(SubstParm, InsertPos);
2816  }
2817
2818  return QualType(SubstParm, 0);
2819}
2820
2821/// \brief Retrieve a
2822QualType ASTContext::getSubstTemplateTypeParmPackType(
2823                                          const TemplateTypeParmType *Parm,
2824                                              const TemplateArgument &ArgPack) {
2825#ifndef NDEBUG
2826  for (TemplateArgument::pack_iterator P = ArgPack.pack_begin(),
2827                                    PEnd = ArgPack.pack_end();
2828       P != PEnd; ++P) {
2829    assert(P->getKind() == TemplateArgument::Type &&"Pack contains a non-type");
2830    assert(P->getAsType().isCanonical() && "Pack contains non-canonical type");
2831  }
2832#endif
2833
2834  llvm::FoldingSetNodeID ID;
2835  SubstTemplateTypeParmPackType::Profile(ID, Parm, ArgPack);
2836  void *InsertPos = 0;
2837  if (SubstTemplateTypeParmPackType *SubstParm
2838        = SubstTemplateTypeParmPackTypes.FindNodeOrInsertPos(ID, InsertPos))
2839    return QualType(SubstParm, 0);
2840
2841  QualType Canon;
2842  if (!Parm->isCanonicalUnqualified()) {
2843    Canon = getCanonicalType(QualType(Parm, 0));
2844    Canon = getSubstTemplateTypeParmPackType(cast<TemplateTypeParmType>(Canon),
2845                                             ArgPack);
2846    SubstTemplateTypeParmPackTypes.FindNodeOrInsertPos(ID, InsertPos);
2847  }
2848
2849  SubstTemplateTypeParmPackType *SubstParm
2850    = new (*this, TypeAlignment) SubstTemplateTypeParmPackType(Parm, Canon,
2851                                                               ArgPack);
2852  Types.push_back(SubstParm);
2853  SubstTemplateTypeParmTypes.InsertNode(SubstParm, InsertPos);
2854  return QualType(SubstParm, 0);
2855}
2856
2857/// \brief Retrieve the template type parameter type for a template
2858/// parameter or parameter pack with the given depth, index, and (optionally)
2859/// name.
2860QualType ASTContext::getTemplateTypeParmType(unsigned Depth, unsigned Index,
2861                                             bool ParameterPack,
2862                                             TemplateTypeParmDecl *TTPDecl) const {
2863  llvm::FoldingSetNodeID ID;
2864  TemplateTypeParmType::Profile(ID, Depth, Index, ParameterPack, TTPDecl);
2865  void *InsertPos = 0;
2866  TemplateTypeParmType *TypeParm
2867    = TemplateTypeParmTypes.FindNodeOrInsertPos(ID, InsertPos);
2868
2869  if (TypeParm)
2870    return QualType(TypeParm, 0);
2871
2872  if (TTPDecl) {
2873    QualType Canon = getTemplateTypeParmType(Depth, Index, ParameterPack);
2874    TypeParm = new (*this, TypeAlignment) TemplateTypeParmType(TTPDecl, Canon);
2875
2876    TemplateTypeParmType *TypeCheck
2877      = TemplateTypeParmTypes.FindNodeOrInsertPos(ID, InsertPos);
2878    assert(!TypeCheck && "Template type parameter canonical type broken");
2879    (void)TypeCheck;
2880  } else
2881    TypeParm = new (*this, TypeAlignment)
2882      TemplateTypeParmType(Depth, Index, ParameterPack);
2883
2884  Types.push_back(TypeParm);
2885  TemplateTypeParmTypes.InsertNode(TypeParm, InsertPos);
2886
2887  return QualType(TypeParm, 0);
2888}
2889
2890TypeSourceInfo *
2891ASTContext::getTemplateSpecializationTypeInfo(TemplateName Name,
2892                                              SourceLocation NameLoc,
2893                                        const TemplateArgumentListInfo &Args,
2894                                              QualType Underlying) const {
2895  assert(!Name.getAsDependentTemplateName() &&
2896         "No dependent template names here!");
2897  QualType TST = getTemplateSpecializationType(Name, Args, Underlying);
2898
2899  TypeSourceInfo *DI = CreateTypeSourceInfo(TST);
2900  TemplateSpecializationTypeLoc TL
2901    = cast<TemplateSpecializationTypeLoc>(DI->getTypeLoc());
2902  TL.setTemplateKeywordLoc(SourceLocation());
2903  TL.setTemplateNameLoc(NameLoc);
2904  TL.setLAngleLoc(Args.getLAngleLoc());
2905  TL.setRAngleLoc(Args.getRAngleLoc());
2906  for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
2907    TL.setArgLocInfo(i, Args[i].getLocInfo());
2908  return DI;
2909}
2910
2911QualType
2912ASTContext::getTemplateSpecializationType(TemplateName Template,
2913                                          const TemplateArgumentListInfo &Args,
2914                                          QualType Underlying) const {
2915  assert(!Template.getAsDependentTemplateName() &&
2916         "No dependent template names here!");
2917
2918  unsigned NumArgs = Args.size();
2919
2920  SmallVector<TemplateArgument, 4> ArgVec;
2921  ArgVec.reserve(NumArgs);
2922  for (unsigned i = 0; i != NumArgs; ++i)
2923    ArgVec.push_back(Args[i].getArgument());
2924
2925  return getTemplateSpecializationType(Template, ArgVec.data(), NumArgs,
2926                                       Underlying);
2927}
2928
2929#ifndef NDEBUG
2930static bool hasAnyPackExpansions(const TemplateArgument *Args,
2931                                 unsigned NumArgs) {
2932  for (unsigned I = 0; I != NumArgs; ++I)
2933    if (Args[I].isPackExpansion())
2934      return true;
2935
2936  return true;
2937}
2938#endif
2939
2940QualType
2941ASTContext::getTemplateSpecializationType(TemplateName Template,
2942                                          const TemplateArgument *Args,
2943                                          unsigned NumArgs,
2944                                          QualType Underlying) const {
2945  assert(!Template.getAsDependentTemplateName() &&
2946         "No dependent template names here!");
2947  // Look through qualified template names.
2948  if (QualifiedTemplateName *QTN = Template.getAsQualifiedTemplateName())
2949    Template = TemplateName(QTN->getTemplateDecl());
2950
2951  bool IsTypeAlias =
2952    Template.getAsTemplateDecl() &&
2953    isa<TypeAliasTemplateDecl>(Template.getAsTemplateDecl());
2954  QualType CanonType;
2955  if (!Underlying.isNull())
2956    CanonType = getCanonicalType(Underlying);
2957  else {
2958    // We can get here with an alias template when the specialization contains
2959    // a pack expansion that does not match up with a parameter pack.
2960    assert((!IsTypeAlias || hasAnyPackExpansions(Args, NumArgs)) &&
2961           "Caller must compute aliased type");
2962    IsTypeAlias = false;
2963    CanonType = getCanonicalTemplateSpecializationType(Template, Args,
2964                                                       NumArgs);
2965  }
2966
2967  // Allocate the (non-canonical) template specialization type, but don't
2968  // try to unique it: these types typically have location information that
2969  // we don't unique and don't want to lose.
2970  void *Mem = Allocate(sizeof(TemplateSpecializationType) +
2971                       sizeof(TemplateArgument) * NumArgs +
2972                       (IsTypeAlias? sizeof(QualType) : 0),
2973                       TypeAlignment);
2974  TemplateSpecializationType *Spec
2975    = new (Mem) TemplateSpecializationType(Template, Args, NumArgs, CanonType,
2976                                         IsTypeAlias ? Underlying : QualType());
2977
2978  Types.push_back(Spec);
2979  return QualType(Spec, 0);
2980}
2981
2982QualType
2983ASTContext::getCanonicalTemplateSpecializationType(TemplateName Template,
2984                                                   const TemplateArgument *Args,
2985                                                   unsigned NumArgs) const {
2986  assert(!Template.getAsDependentTemplateName() &&
2987         "No dependent template names here!");
2988
2989  // Look through qualified template names.
2990  if (QualifiedTemplateName *QTN = Template.getAsQualifiedTemplateName())
2991    Template = TemplateName(QTN->getTemplateDecl());
2992
2993  // Build the canonical template specialization type.
2994  TemplateName CanonTemplate = getCanonicalTemplateName(Template);
2995  SmallVector<TemplateArgument, 4> CanonArgs;
2996  CanonArgs.reserve(NumArgs);
2997  for (unsigned I = 0; I != NumArgs; ++I)
2998    CanonArgs.push_back(getCanonicalTemplateArgument(Args[I]));
2999
3000  // Determine whether this canonical template specialization type already
3001  // exists.
3002  llvm::FoldingSetNodeID ID;
3003  TemplateSpecializationType::Profile(ID, CanonTemplate,
3004                                      CanonArgs.data(), NumArgs, *this);
3005
3006  void *InsertPos = 0;
3007  TemplateSpecializationType *Spec
3008    = TemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos);
3009
3010  if (!Spec) {
3011    // Allocate a new canonical template specialization type.
3012    void *Mem = Allocate((sizeof(TemplateSpecializationType) +
3013                          sizeof(TemplateArgument) * NumArgs),
3014                         TypeAlignment);
3015    Spec = new (Mem) TemplateSpecializationType(CanonTemplate,
3016                                                CanonArgs.data(), NumArgs,
3017                                                QualType(), QualType());
3018    Types.push_back(Spec);
3019    TemplateSpecializationTypes.InsertNode(Spec, InsertPos);
3020  }
3021
3022  assert(Spec->isDependentType() &&
3023         "Non-dependent template-id type must have a canonical type");
3024  return QualType(Spec, 0);
3025}
3026
3027QualType
3028ASTContext::getElaboratedType(ElaboratedTypeKeyword Keyword,
3029                              NestedNameSpecifier *NNS,
3030                              QualType NamedType) const {
3031  llvm::FoldingSetNodeID ID;
3032  ElaboratedType::Profile(ID, Keyword, NNS, NamedType);
3033
3034  void *InsertPos = 0;
3035  ElaboratedType *T = ElaboratedTypes.FindNodeOrInsertPos(ID, InsertPos);
3036  if (T)
3037    return QualType(T, 0);
3038
3039  QualType Canon = NamedType;
3040  if (!Canon.isCanonical()) {
3041    Canon = getCanonicalType(NamedType);
3042    ElaboratedType *CheckT = ElaboratedTypes.FindNodeOrInsertPos(ID, InsertPos);
3043    assert(!CheckT && "Elaborated canonical type broken");
3044    (void)CheckT;
3045  }
3046
3047  T = new (*this) ElaboratedType(Keyword, NNS, NamedType, Canon);
3048  Types.push_back(T);
3049  ElaboratedTypes.InsertNode(T, InsertPos);
3050  return QualType(T, 0);
3051}
3052
3053QualType
3054ASTContext::getParenType(QualType InnerType) const {
3055  llvm::FoldingSetNodeID ID;
3056  ParenType::Profile(ID, InnerType);
3057
3058  void *InsertPos = 0;
3059  ParenType *T = ParenTypes.FindNodeOrInsertPos(ID, InsertPos);
3060  if (T)
3061    return QualType(T, 0);
3062
3063  QualType Canon = InnerType;
3064  if (!Canon.isCanonical()) {
3065    Canon = getCanonicalType(InnerType);
3066    ParenType *CheckT = ParenTypes.FindNodeOrInsertPos(ID, InsertPos);
3067    assert(!CheckT && "Paren canonical type broken");
3068    (void)CheckT;
3069  }
3070
3071  T = new (*this) ParenType(InnerType, Canon);
3072  Types.push_back(T);
3073  ParenTypes.InsertNode(T, InsertPos);
3074  return QualType(T, 0);
3075}
3076
3077QualType ASTContext::getDependentNameType(ElaboratedTypeKeyword Keyword,
3078                                          NestedNameSpecifier *NNS,
3079                                          const IdentifierInfo *Name,
3080                                          QualType Canon) const {
3081  assert(NNS->isDependent() && "nested-name-specifier must be dependent");
3082
3083  if (Canon.isNull()) {
3084    NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
3085    ElaboratedTypeKeyword CanonKeyword = Keyword;
3086    if (Keyword == ETK_None)
3087      CanonKeyword = ETK_Typename;
3088
3089    if (CanonNNS != NNS || CanonKeyword != Keyword)
3090      Canon = getDependentNameType(CanonKeyword, CanonNNS, Name);
3091  }
3092
3093  llvm::FoldingSetNodeID ID;
3094  DependentNameType::Profile(ID, Keyword, NNS, Name);
3095
3096  void *InsertPos = 0;
3097  DependentNameType *T
3098    = DependentNameTypes.FindNodeOrInsertPos(ID, InsertPos);
3099  if (T)
3100    return QualType(T, 0);
3101
3102  T = new (*this) DependentNameType(Keyword, NNS, Name, Canon);
3103  Types.push_back(T);
3104  DependentNameTypes.InsertNode(T, InsertPos);
3105  return QualType(T, 0);
3106}
3107
3108QualType
3109ASTContext::getDependentTemplateSpecializationType(
3110                                 ElaboratedTypeKeyword Keyword,
3111                                 NestedNameSpecifier *NNS,
3112                                 const IdentifierInfo *Name,
3113                                 const TemplateArgumentListInfo &Args) const {
3114  // TODO: avoid this copy
3115  SmallVector<TemplateArgument, 16> ArgCopy;
3116  for (unsigned I = 0, E = Args.size(); I != E; ++I)
3117    ArgCopy.push_back(Args[I].getArgument());
3118  return getDependentTemplateSpecializationType(Keyword, NNS, Name,
3119                                                ArgCopy.size(),
3120                                                ArgCopy.data());
3121}
3122
3123QualType
3124ASTContext::getDependentTemplateSpecializationType(
3125                                 ElaboratedTypeKeyword Keyword,
3126                                 NestedNameSpecifier *NNS,
3127                                 const IdentifierInfo *Name,
3128                                 unsigned NumArgs,
3129                                 const TemplateArgument *Args) const {
3130  assert((!NNS || NNS->isDependent()) &&
3131         "nested-name-specifier must be dependent");
3132
3133  llvm::FoldingSetNodeID ID;
3134  DependentTemplateSpecializationType::Profile(ID, *this, Keyword, NNS,
3135                                               Name, NumArgs, Args);
3136
3137  void *InsertPos = 0;
3138  DependentTemplateSpecializationType *T
3139    = DependentTemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos);
3140  if (T)
3141    return QualType(T, 0);
3142
3143  NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
3144
3145  ElaboratedTypeKeyword CanonKeyword = Keyword;
3146  if (Keyword == ETK_None) CanonKeyword = ETK_Typename;
3147
3148  bool AnyNonCanonArgs = false;
3149  SmallVector<TemplateArgument, 16> CanonArgs(NumArgs);
3150  for (unsigned I = 0; I != NumArgs; ++I) {
3151    CanonArgs[I] = getCanonicalTemplateArgument(Args[I]);
3152    if (!CanonArgs[I].structurallyEquals(Args[I]))
3153      AnyNonCanonArgs = true;
3154  }
3155
3156  QualType Canon;
3157  if (AnyNonCanonArgs || CanonNNS != NNS || CanonKeyword != Keyword) {
3158    Canon = getDependentTemplateSpecializationType(CanonKeyword, CanonNNS,
3159                                                   Name, NumArgs,
3160                                                   CanonArgs.data());
3161
3162    // Find the insert position again.
3163    DependentTemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos);
3164  }
3165
3166  void *Mem = Allocate((sizeof(DependentTemplateSpecializationType) +
3167                        sizeof(TemplateArgument) * NumArgs),
3168                       TypeAlignment);
3169  T = new (Mem) DependentTemplateSpecializationType(Keyword, NNS,
3170                                                    Name, NumArgs, Args, Canon);
3171  Types.push_back(T);
3172  DependentTemplateSpecializationTypes.InsertNode(T, InsertPos);
3173  return QualType(T, 0);
3174}
3175
3176QualType ASTContext::getPackExpansionType(QualType Pattern,
3177                                      llvm::Optional<unsigned> NumExpansions) {
3178  llvm::FoldingSetNodeID ID;
3179  PackExpansionType::Profile(ID, Pattern, NumExpansions);
3180
3181  assert(Pattern->containsUnexpandedParameterPack() &&
3182         "Pack expansions must expand one or more parameter packs");
3183  void *InsertPos = 0;
3184  PackExpansionType *T
3185    = PackExpansionTypes.FindNodeOrInsertPos(ID, InsertPos);
3186  if (T)
3187    return QualType(T, 0);
3188
3189  QualType Canon;
3190  if (!Pattern.isCanonical()) {
3191    Canon = getCanonicalType(Pattern);
3192    // The canonical type might not contain an unexpanded parameter pack, if it
3193    // contains an alias template specialization which ignores one of its
3194    // parameters.
3195    if (Canon->containsUnexpandedParameterPack()) {
3196      Canon = getPackExpansionType(getCanonicalType(Pattern), NumExpansions);
3197
3198      // Find the insert position again, in case we inserted an element into
3199      // PackExpansionTypes and invalidated our insert position.
3200      PackExpansionTypes.FindNodeOrInsertPos(ID, InsertPos);
3201    }
3202  }
3203
3204  T = new (*this) PackExpansionType(Pattern, Canon, NumExpansions);
3205  Types.push_back(T);
3206  PackExpansionTypes.InsertNode(T, InsertPos);
3207  return QualType(T, 0);
3208}
3209
3210/// CmpProtocolNames - Comparison predicate for sorting protocols
3211/// alphabetically.
3212static bool CmpProtocolNames(const ObjCProtocolDecl *LHS,
3213                            const ObjCProtocolDecl *RHS) {
3214  return LHS->getDeclName() < RHS->getDeclName();
3215}
3216
3217static bool areSortedAndUniqued(ObjCProtocolDecl * const *Protocols,
3218                                unsigned NumProtocols) {
3219  if (NumProtocols == 0) return true;
3220
3221  if (Protocols[0]->getCanonicalDecl() != Protocols[0])
3222    return false;
3223
3224  for (unsigned i = 1; i != NumProtocols; ++i)
3225    if (!CmpProtocolNames(Protocols[i-1], Protocols[i]) ||
3226        Protocols[i]->getCanonicalDecl() != Protocols[i])
3227      return false;
3228  return true;
3229}
3230
3231static void SortAndUniqueProtocols(ObjCProtocolDecl **Protocols,
3232                                   unsigned &NumProtocols) {
3233  ObjCProtocolDecl **ProtocolsEnd = Protocols+NumProtocols;
3234
3235  // Sort protocols, keyed by name.
3236  std::sort(Protocols, Protocols+NumProtocols, CmpProtocolNames);
3237
3238  // Canonicalize.
3239  for (unsigned I = 0, N = NumProtocols; I != N; ++I)
3240    Protocols[I] = Protocols[I]->getCanonicalDecl();
3241
3242  // Remove duplicates.
3243  ProtocolsEnd = std::unique(Protocols, ProtocolsEnd);
3244  NumProtocols = ProtocolsEnd-Protocols;
3245}
3246
3247QualType ASTContext::getObjCObjectType(QualType BaseType,
3248                                       ObjCProtocolDecl * const *Protocols,
3249                                       unsigned NumProtocols) const {
3250  // If the base type is an interface and there aren't any protocols
3251  // to add, then the interface type will do just fine.
3252  if (!NumProtocols && isa<ObjCInterfaceType>(BaseType))
3253    return BaseType;
3254
3255  // Look in the folding set for an existing type.
3256  llvm::FoldingSetNodeID ID;
3257  ObjCObjectTypeImpl::Profile(ID, BaseType, Protocols, NumProtocols);
3258  void *InsertPos = 0;
3259  if (ObjCObjectType *QT = ObjCObjectTypes.FindNodeOrInsertPos(ID, InsertPos))
3260    return QualType(QT, 0);
3261
3262  // Build the canonical type, which has the canonical base type and
3263  // a sorted-and-uniqued list of protocols.
3264  QualType Canonical;
3265  bool ProtocolsSorted = areSortedAndUniqued(Protocols, NumProtocols);
3266  if (!ProtocolsSorted || !BaseType.isCanonical()) {
3267    if (!ProtocolsSorted) {
3268      SmallVector<ObjCProtocolDecl*, 8> Sorted(Protocols,
3269                                                     Protocols + NumProtocols);
3270      unsigned UniqueCount = NumProtocols;
3271
3272      SortAndUniqueProtocols(&Sorted[0], UniqueCount);
3273      Canonical = getObjCObjectType(getCanonicalType(BaseType),
3274                                    &Sorted[0], UniqueCount);
3275    } else {
3276      Canonical = getObjCObjectType(getCanonicalType(BaseType),
3277                                    Protocols, NumProtocols);
3278    }
3279
3280    // Regenerate InsertPos.
3281    ObjCObjectTypes.FindNodeOrInsertPos(ID, InsertPos);
3282  }
3283
3284  unsigned Size = sizeof(ObjCObjectTypeImpl);
3285  Size += NumProtocols * sizeof(ObjCProtocolDecl *);
3286  void *Mem = Allocate(Size, TypeAlignment);
3287  ObjCObjectTypeImpl *T =
3288    new (Mem) ObjCObjectTypeImpl(Canonical, BaseType, Protocols, NumProtocols);
3289
3290  Types.push_back(T);
3291  ObjCObjectTypes.InsertNode(T, InsertPos);
3292  return QualType(T, 0);
3293}
3294
3295/// getObjCObjectPointerType - Return a ObjCObjectPointerType type for
3296/// the given object type.
3297QualType ASTContext::getObjCObjectPointerType(QualType ObjectT) const {
3298  llvm::FoldingSetNodeID ID;
3299  ObjCObjectPointerType::Profile(ID, ObjectT);
3300
3301  void *InsertPos = 0;
3302  if (ObjCObjectPointerType *QT =
3303              ObjCObjectPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
3304    return QualType(QT, 0);
3305
3306  // Find the canonical object type.
3307  QualType Canonical;
3308  if (!ObjectT.isCanonical()) {
3309    Canonical = getObjCObjectPointerType(getCanonicalType(ObjectT));
3310
3311    // Regenerate InsertPos.
3312    ObjCObjectPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
3313  }
3314
3315  // No match.
3316  void *Mem = Allocate(sizeof(ObjCObjectPointerType), TypeAlignment);
3317  ObjCObjectPointerType *QType =
3318    new (Mem) ObjCObjectPointerType(Canonical, ObjectT);
3319
3320  Types.push_back(QType);
3321  ObjCObjectPointerTypes.InsertNode(QType, InsertPos);
3322  return QualType(QType, 0);
3323}
3324
3325/// getObjCInterfaceType - Return the unique reference to the type for the
3326/// specified ObjC interface decl. The list of protocols is optional.
3327QualType ASTContext::getObjCInterfaceType(const ObjCInterfaceDecl *Decl,
3328                                          ObjCInterfaceDecl *PrevDecl) const {
3329  if (Decl->TypeForDecl)
3330    return QualType(Decl->TypeForDecl, 0);
3331
3332  if (PrevDecl) {
3333    assert(PrevDecl->TypeForDecl && "previous decl has no TypeForDecl");
3334    Decl->TypeForDecl = PrevDecl->TypeForDecl;
3335    return QualType(PrevDecl->TypeForDecl, 0);
3336  }
3337
3338  // Prefer the definition, if there is one.
3339  if (const ObjCInterfaceDecl *Def = Decl->getDefinition())
3340    Decl = Def;
3341
3342  void *Mem = Allocate(sizeof(ObjCInterfaceType), TypeAlignment);
3343  ObjCInterfaceType *T = new (Mem) ObjCInterfaceType(Decl);
3344  Decl->TypeForDecl = T;
3345  Types.push_back(T);
3346  return QualType(T, 0);
3347}
3348
3349/// getTypeOfExprType - Unlike many "get<Type>" functions, we can't unique
3350/// TypeOfExprType AST's (since expression's are never shared). For example,
3351/// multiple declarations that refer to "typeof(x)" all contain different
3352/// DeclRefExpr's. This doesn't effect the type checker, since it operates
3353/// on canonical type's (which are always unique).
3354QualType ASTContext::getTypeOfExprType(Expr *tofExpr) const {
3355  TypeOfExprType *toe;
3356  if (tofExpr->isTypeDependent()) {
3357    llvm::FoldingSetNodeID ID;
3358    DependentTypeOfExprType::Profile(ID, *this, tofExpr);
3359
3360    void *InsertPos = 0;
3361    DependentTypeOfExprType *Canon
3362      = DependentTypeOfExprTypes.FindNodeOrInsertPos(ID, InsertPos);
3363    if (Canon) {
3364      // We already have a "canonical" version of an identical, dependent
3365      // typeof(expr) type. Use that as our canonical type.
3366      toe = new (*this, TypeAlignment) TypeOfExprType(tofExpr,
3367                                          QualType((TypeOfExprType*)Canon, 0));
3368    } else {
3369      // Build a new, canonical typeof(expr) type.
3370      Canon
3371        = new (*this, TypeAlignment) DependentTypeOfExprType(*this, tofExpr);
3372      DependentTypeOfExprTypes.InsertNode(Canon, InsertPos);
3373      toe = Canon;
3374    }
3375  } else {
3376    QualType Canonical = getCanonicalType(tofExpr->getType());
3377    toe = new (*this, TypeAlignment) TypeOfExprType(tofExpr, Canonical);
3378  }
3379  Types.push_back(toe);
3380  return QualType(toe, 0);
3381}
3382
3383/// getTypeOfType -  Unlike many "get<Type>" functions, we don't unique
3384/// TypeOfType AST's. The only motivation to unique these nodes would be
3385/// memory savings. Since typeof(t) is fairly uncommon, space shouldn't be
3386/// an issue. This doesn't effect the type checker, since it operates
3387/// on canonical type's (which are always unique).
3388QualType ASTContext::getTypeOfType(QualType tofType) const {
3389  QualType Canonical = getCanonicalType(tofType);
3390  TypeOfType *tot = new (*this, TypeAlignment) TypeOfType(tofType, Canonical);
3391  Types.push_back(tot);
3392  return QualType(tot, 0);
3393}
3394
3395
3396/// getDecltypeType -  Unlike many "get<Type>" functions, we don't unique
3397/// DecltypeType AST's. The only motivation to unique these nodes would be
3398/// memory savings. Since decltype(t) is fairly uncommon, space shouldn't be
3399/// an issue. This doesn't effect the type checker, since it operates
3400/// on canonical types (which are always unique).
3401QualType ASTContext::getDecltypeType(Expr *e, QualType UnderlyingType) const {
3402  DecltypeType *dt;
3403
3404  // C++0x [temp.type]p2:
3405  //   If an expression e involves a template parameter, decltype(e) denotes a
3406  //   unique dependent type. Two such decltype-specifiers refer to the same
3407  //   type only if their expressions are equivalent (14.5.6.1).
3408  if (e->isInstantiationDependent()) {
3409    llvm::FoldingSetNodeID ID;
3410    DependentDecltypeType::Profile(ID, *this, e);
3411
3412    void *InsertPos = 0;
3413    DependentDecltypeType *Canon
3414      = DependentDecltypeTypes.FindNodeOrInsertPos(ID, InsertPos);
3415    if (Canon) {
3416      // We already have a "canonical" version of an equivalent, dependent
3417      // decltype type. Use that as our canonical type.
3418      dt = new (*this, TypeAlignment) DecltypeType(e, UnderlyingType,
3419                                       QualType((DecltypeType*)Canon, 0));
3420    } else {
3421      // Build a new, canonical typeof(expr) type.
3422      Canon = new (*this, TypeAlignment) DependentDecltypeType(*this, e);
3423      DependentDecltypeTypes.InsertNode(Canon, InsertPos);
3424      dt = Canon;
3425    }
3426  } else {
3427    dt = new (*this, TypeAlignment) DecltypeType(e, UnderlyingType,
3428                                      getCanonicalType(UnderlyingType));
3429  }
3430  Types.push_back(dt);
3431  return QualType(dt, 0);
3432}
3433
3434/// getUnaryTransformationType - We don't unique these, since the memory
3435/// savings are minimal and these are rare.
3436QualType ASTContext::getUnaryTransformType(QualType BaseType,
3437                                           QualType UnderlyingType,
3438                                           UnaryTransformType::UTTKind Kind)
3439    const {
3440  UnaryTransformType *Ty =
3441    new (*this, TypeAlignment) UnaryTransformType (BaseType, UnderlyingType,
3442                                                   Kind,
3443                                 UnderlyingType->isDependentType() ?
3444                                 QualType() : getCanonicalType(UnderlyingType));
3445  Types.push_back(Ty);
3446  return QualType(Ty, 0);
3447}
3448
3449/// getAutoType - We only unique auto types after they've been deduced.
3450QualType ASTContext::getAutoType(QualType DeducedType) const {
3451  void *InsertPos = 0;
3452  if (!DeducedType.isNull()) {
3453    // Look in the folding set for an existing type.
3454    llvm::FoldingSetNodeID ID;
3455    AutoType::Profile(ID, DeducedType);
3456    if (AutoType *AT = AutoTypes.FindNodeOrInsertPos(ID, InsertPos))
3457      return QualType(AT, 0);
3458  }
3459
3460  AutoType *AT = new (*this, TypeAlignment) AutoType(DeducedType);
3461  Types.push_back(AT);
3462  if (InsertPos)
3463    AutoTypes.InsertNode(AT, InsertPos);
3464  return QualType(AT, 0);
3465}
3466
3467/// getAtomicType - Return the uniqued reference to the atomic type for
3468/// the given value type.
3469QualType ASTContext::getAtomicType(QualType T) const {
3470  // Unique pointers, to guarantee there is only one pointer of a particular
3471  // structure.
3472  llvm::FoldingSetNodeID ID;
3473  AtomicType::Profile(ID, T);
3474
3475  void *InsertPos = 0;
3476  if (AtomicType *AT = AtomicTypes.FindNodeOrInsertPos(ID, InsertPos))
3477    return QualType(AT, 0);
3478
3479  // If the atomic value type isn't canonical, this won't be a canonical type
3480  // either, so fill in the canonical type field.
3481  QualType Canonical;
3482  if (!T.isCanonical()) {
3483    Canonical = getAtomicType(getCanonicalType(T));
3484
3485    // Get the new insert position for the node we care about.
3486    AtomicType *NewIP = AtomicTypes.FindNodeOrInsertPos(ID, InsertPos);
3487    assert(NewIP == 0 && "Shouldn't be in the map!"); (void)NewIP;
3488  }
3489  AtomicType *New = new (*this, TypeAlignment) AtomicType(T, Canonical);
3490  Types.push_back(New);
3491  AtomicTypes.InsertNode(New, InsertPos);
3492  return QualType(New, 0);
3493}
3494
3495/// getAutoDeductType - Get type pattern for deducing against 'auto'.
3496QualType ASTContext::getAutoDeductType() const {
3497  if (AutoDeductTy.isNull())
3498    AutoDeductTy = getAutoType(QualType());
3499  assert(!AutoDeductTy.isNull() && "can't build 'auto' pattern");
3500  return AutoDeductTy;
3501}
3502
3503/// getAutoRRefDeductType - Get type pattern for deducing against 'auto &&'.
3504QualType ASTContext::getAutoRRefDeductType() const {
3505  if (AutoRRefDeductTy.isNull())
3506    AutoRRefDeductTy = getRValueReferenceType(getAutoDeductType());
3507  assert(!AutoRRefDeductTy.isNull() && "can't build 'auto &&' pattern");
3508  return AutoRRefDeductTy;
3509}
3510
3511/// getTagDeclType - Return the unique reference to the type for the
3512/// specified TagDecl (struct/union/class/enum) decl.
3513QualType ASTContext::getTagDeclType(const TagDecl *Decl) const {
3514  assert (Decl);
3515  // FIXME: What is the design on getTagDeclType when it requires casting
3516  // away const?  mutable?
3517  return getTypeDeclType(const_cast<TagDecl*>(Decl));
3518}
3519
3520/// getSizeType - Return the unique type for "size_t" (C99 7.17), the result
3521/// of the sizeof operator (C99 6.5.3.4p4). The value is target dependent and
3522/// needs to agree with the definition in <stddef.h>.
3523CanQualType ASTContext::getSizeType() const {
3524  return getFromTargetType(Target->getSizeType());
3525}
3526
3527/// getIntMaxType - Return the unique type for "intmax_t" (C99 7.18.1.5).
3528CanQualType ASTContext::getIntMaxType() const {
3529  return getFromTargetType(Target->getIntMaxType());
3530}
3531
3532/// getUIntMaxType - Return the unique type for "uintmax_t" (C99 7.18.1.5).
3533CanQualType ASTContext::getUIntMaxType() const {
3534  return getFromTargetType(Target->getUIntMaxType());
3535}
3536
3537/// getSignedWCharType - Return the type of "signed wchar_t".
3538/// Used when in C++, as a GCC extension.
3539QualType ASTContext::getSignedWCharType() const {
3540  // FIXME: derive from "Target" ?
3541  return WCharTy;
3542}
3543
3544/// getUnsignedWCharType - Return the type of "unsigned wchar_t".
3545/// Used when in C++, as a GCC extension.
3546QualType ASTContext::getUnsignedWCharType() const {
3547  // FIXME: derive from "Target" ?
3548  return UnsignedIntTy;
3549}
3550
3551/// getPointerDiffType - Return the unique type for "ptrdiff_t" (C99 7.17)
3552/// defined in <stddef.h>. Pointer - pointer requires this (C99 6.5.6p9).
3553QualType ASTContext::getPointerDiffType() const {
3554  return getFromTargetType(Target->getPtrDiffType(0));
3555}
3556
3557/// \brief Return the unique type for "pid_t" defined in
3558/// <sys/types.h>. We need this to compute the correct type for vfork().
3559QualType ASTContext::getProcessIDType() const {
3560  return getFromTargetType(Target->getProcessIDType());
3561}
3562
3563//===----------------------------------------------------------------------===//
3564//                              Type Operators
3565//===----------------------------------------------------------------------===//
3566
3567CanQualType ASTContext::getCanonicalParamType(QualType T) const {
3568  // Push qualifiers into arrays, and then discard any remaining
3569  // qualifiers.
3570  T = getCanonicalType(T);
3571  T = getVariableArrayDecayedType(T);
3572  const Type *Ty = T.getTypePtr();
3573  QualType Result;
3574  if (isa<ArrayType>(Ty)) {
3575    Result = getArrayDecayedType(QualType(Ty,0));
3576  } else if (isa<FunctionType>(Ty)) {
3577    Result = getPointerType(QualType(Ty, 0));
3578  } else {
3579    Result = QualType(Ty, 0);
3580  }
3581
3582  return CanQualType::CreateUnsafe(Result);
3583}
3584
3585QualType ASTContext::getUnqualifiedArrayType(QualType type,
3586                                             Qualifiers &quals) {
3587  SplitQualType splitType = type.getSplitUnqualifiedType();
3588
3589  // FIXME: getSplitUnqualifiedType() actually walks all the way to
3590  // the unqualified desugared type and then drops it on the floor.
3591  // We then have to strip that sugar back off with
3592  // getUnqualifiedDesugaredType(), which is silly.
3593  const ArrayType *AT =
3594    dyn_cast<ArrayType>(splitType.Ty->getUnqualifiedDesugaredType());
3595
3596  // If we don't have an array, just use the results in splitType.
3597  if (!AT) {
3598    quals = splitType.Quals;
3599    return QualType(splitType.Ty, 0);
3600  }
3601
3602  // Otherwise, recurse on the array's element type.
3603  QualType elementType = AT->getElementType();
3604  QualType unqualElementType = getUnqualifiedArrayType(elementType, quals);
3605
3606  // If that didn't change the element type, AT has no qualifiers, so we
3607  // can just use the results in splitType.
3608  if (elementType == unqualElementType) {
3609    assert(quals.empty()); // from the recursive call
3610    quals = splitType.Quals;
3611    return QualType(splitType.Ty, 0);
3612  }
3613
3614  // Otherwise, add in the qualifiers from the outermost type, then
3615  // build the type back up.
3616  quals.addConsistentQualifiers(splitType.Quals);
3617
3618  if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(AT)) {
3619    return getConstantArrayType(unqualElementType, CAT->getSize(),
3620                                CAT->getSizeModifier(), 0);
3621  }
3622
3623  if (const IncompleteArrayType *IAT = dyn_cast<IncompleteArrayType>(AT)) {
3624    return getIncompleteArrayType(unqualElementType, IAT->getSizeModifier(), 0);
3625  }
3626
3627  if (const VariableArrayType *VAT = dyn_cast<VariableArrayType>(AT)) {
3628    return getVariableArrayType(unqualElementType,
3629                                VAT->getSizeExpr(),
3630                                VAT->getSizeModifier(),
3631                                VAT->getIndexTypeCVRQualifiers(),
3632                                VAT->getBracketsRange());
3633  }
3634
3635  const DependentSizedArrayType *DSAT = cast<DependentSizedArrayType>(AT);
3636  return getDependentSizedArrayType(unqualElementType, DSAT->getSizeExpr(),
3637                                    DSAT->getSizeModifier(), 0,
3638                                    SourceRange());
3639}
3640
3641/// UnwrapSimilarPointerTypes - If T1 and T2 are pointer types  that
3642/// may be similar (C++ 4.4), replaces T1 and T2 with the type that
3643/// they point to and return true. If T1 and T2 aren't pointer types
3644/// or pointer-to-member types, or if they are not similar at this
3645/// level, returns false and leaves T1 and T2 unchanged. Top-level
3646/// qualifiers on T1 and T2 are ignored. This function will typically
3647/// be called in a loop that successively "unwraps" pointer and
3648/// pointer-to-member types to compare them at each level.
3649bool ASTContext::UnwrapSimilarPointerTypes(QualType &T1, QualType &T2) {
3650  const PointerType *T1PtrType = T1->getAs<PointerType>(),
3651                    *T2PtrType = T2->getAs<PointerType>();
3652  if (T1PtrType && T2PtrType) {
3653    T1 = T1PtrType->getPointeeType();
3654    T2 = T2PtrType->getPointeeType();
3655    return true;
3656  }
3657
3658  const MemberPointerType *T1MPType = T1->getAs<MemberPointerType>(),
3659                          *T2MPType = T2->getAs<MemberPointerType>();
3660  if (T1MPType && T2MPType &&
3661      hasSameUnqualifiedType(QualType(T1MPType->getClass(), 0),
3662                             QualType(T2MPType->getClass(), 0))) {
3663    T1 = T1MPType->getPointeeType();
3664    T2 = T2MPType->getPointeeType();
3665    return true;
3666  }
3667
3668  if (getLangOpts().ObjC1) {
3669    const ObjCObjectPointerType *T1OPType = T1->getAs<ObjCObjectPointerType>(),
3670                                *T2OPType = T2->getAs<ObjCObjectPointerType>();
3671    if (T1OPType && T2OPType) {
3672      T1 = T1OPType->getPointeeType();
3673      T2 = T2OPType->getPointeeType();
3674      return true;
3675    }
3676  }
3677
3678  // FIXME: Block pointers, too?
3679
3680  return false;
3681}
3682
3683DeclarationNameInfo
3684ASTContext::getNameForTemplate(TemplateName Name,
3685                               SourceLocation NameLoc) const {
3686  switch (Name.getKind()) {
3687  case TemplateName::QualifiedTemplate:
3688  case TemplateName::Template:
3689    // DNInfo work in progress: CHECKME: what about DNLoc?
3690    return DeclarationNameInfo(Name.getAsTemplateDecl()->getDeclName(),
3691                               NameLoc);
3692
3693  case TemplateName::OverloadedTemplate: {
3694    OverloadedTemplateStorage *Storage = Name.getAsOverloadedTemplate();
3695    // DNInfo work in progress: CHECKME: what about DNLoc?
3696    return DeclarationNameInfo((*Storage->begin())->getDeclName(), NameLoc);
3697  }
3698
3699  case TemplateName::DependentTemplate: {
3700    DependentTemplateName *DTN = Name.getAsDependentTemplateName();
3701    DeclarationName DName;
3702    if (DTN->isIdentifier()) {
3703      DName = DeclarationNames.getIdentifier(DTN->getIdentifier());
3704      return DeclarationNameInfo(DName, NameLoc);
3705    } else {
3706      DName = DeclarationNames.getCXXOperatorName(DTN->getOperator());
3707      // DNInfo work in progress: FIXME: source locations?
3708      DeclarationNameLoc DNLoc;
3709      DNLoc.CXXOperatorName.BeginOpNameLoc = SourceLocation().getRawEncoding();
3710      DNLoc.CXXOperatorName.EndOpNameLoc = SourceLocation().getRawEncoding();
3711      return DeclarationNameInfo(DName, NameLoc, DNLoc);
3712    }
3713  }
3714
3715  case TemplateName::SubstTemplateTemplateParm: {
3716    SubstTemplateTemplateParmStorage *subst
3717      = Name.getAsSubstTemplateTemplateParm();
3718    return DeclarationNameInfo(subst->getParameter()->getDeclName(),
3719                               NameLoc);
3720  }
3721
3722  case TemplateName::SubstTemplateTemplateParmPack: {
3723    SubstTemplateTemplateParmPackStorage *subst
3724      = Name.getAsSubstTemplateTemplateParmPack();
3725    return DeclarationNameInfo(subst->getParameterPack()->getDeclName(),
3726                               NameLoc);
3727  }
3728  }
3729
3730  llvm_unreachable("bad template name kind!");
3731}
3732
3733TemplateName ASTContext::getCanonicalTemplateName(TemplateName Name) const {
3734  switch (Name.getKind()) {
3735  case TemplateName::QualifiedTemplate:
3736  case TemplateName::Template: {
3737    TemplateDecl *Template = Name.getAsTemplateDecl();
3738    if (TemplateTemplateParmDecl *TTP
3739          = dyn_cast<TemplateTemplateParmDecl>(Template))
3740      Template = getCanonicalTemplateTemplateParmDecl(TTP);
3741
3742    // The canonical template name is the canonical template declaration.
3743    return TemplateName(cast<TemplateDecl>(Template->getCanonicalDecl()));
3744  }
3745
3746  case TemplateName::OverloadedTemplate:
3747    llvm_unreachable("cannot canonicalize overloaded template");
3748
3749  case TemplateName::DependentTemplate: {
3750    DependentTemplateName *DTN = Name.getAsDependentTemplateName();
3751    assert(DTN && "Non-dependent template names must refer to template decls.");
3752    return DTN->CanonicalTemplateName;
3753  }
3754
3755  case TemplateName::SubstTemplateTemplateParm: {
3756    SubstTemplateTemplateParmStorage *subst
3757      = Name.getAsSubstTemplateTemplateParm();
3758    return getCanonicalTemplateName(subst->getReplacement());
3759  }
3760
3761  case TemplateName::SubstTemplateTemplateParmPack: {
3762    SubstTemplateTemplateParmPackStorage *subst
3763                                  = Name.getAsSubstTemplateTemplateParmPack();
3764    TemplateTemplateParmDecl *canonParameter
3765      = getCanonicalTemplateTemplateParmDecl(subst->getParameterPack());
3766    TemplateArgument canonArgPack
3767      = getCanonicalTemplateArgument(subst->getArgumentPack());
3768    return getSubstTemplateTemplateParmPack(canonParameter, canonArgPack);
3769  }
3770  }
3771
3772  llvm_unreachable("bad template name!");
3773}
3774
3775bool ASTContext::hasSameTemplateName(TemplateName X, TemplateName Y) {
3776  X = getCanonicalTemplateName(X);
3777  Y = getCanonicalTemplateName(Y);
3778  return X.getAsVoidPointer() == Y.getAsVoidPointer();
3779}
3780
3781TemplateArgument
3782ASTContext::getCanonicalTemplateArgument(const TemplateArgument &Arg) const {
3783  switch (Arg.getKind()) {
3784    case TemplateArgument::Null:
3785      return Arg;
3786
3787    case TemplateArgument::Expression:
3788      return Arg;
3789
3790    case TemplateArgument::Declaration: {
3791      ValueDecl *D = cast<ValueDecl>(Arg.getAsDecl()->getCanonicalDecl());
3792      return TemplateArgument(D, Arg.isDeclForReferenceParam());
3793    }
3794
3795    case TemplateArgument::NullPtr:
3796      return TemplateArgument(getCanonicalType(Arg.getNullPtrType()),
3797                              /*isNullPtr*/true);
3798
3799    case TemplateArgument::Template:
3800      return TemplateArgument(getCanonicalTemplateName(Arg.getAsTemplate()));
3801
3802    case TemplateArgument::TemplateExpansion:
3803      return TemplateArgument(getCanonicalTemplateName(
3804                                         Arg.getAsTemplateOrTemplatePattern()),
3805                              Arg.getNumTemplateExpansions());
3806
3807    case TemplateArgument::Integral:
3808      return TemplateArgument(Arg, getCanonicalType(Arg.getIntegralType()));
3809
3810    case TemplateArgument::Type:
3811      return TemplateArgument(getCanonicalType(Arg.getAsType()));
3812
3813    case TemplateArgument::Pack: {
3814      if (Arg.pack_size() == 0)
3815        return Arg;
3816
3817      TemplateArgument *CanonArgs
3818        = new (*this) TemplateArgument[Arg.pack_size()];
3819      unsigned Idx = 0;
3820      for (TemplateArgument::pack_iterator A = Arg.pack_begin(),
3821                                        AEnd = Arg.pack_end();
3822           A != AEnd; (void)++A, ++Idx)
3823        CanonArgs[Idx] = getCanonicalTemplateArgument(*A);
3824
3825      return TemplateArgument(CanonArgs, Arg.pack_size());
3826    }
3827  }
3828
3829  // Silence GCC warning
3830  llvm_unreachable("Unhandled template argument kind");
3831}
3832
3833NestedNameSpecifier *
3834ASTContext::getCanonicalNestedNameSpecifier(NestedNameSpecifier *NNS) const {
3835  if (!NNS)
3836    return 0;
3837
3838  switch (NNS->getKind()) {
3839  case NestedNameSpecifier::Identifier:
3840    // Canonicalize the prefix but keep the identifier the same.
3841    return NestedNameSpecifier::Create(*this,
3842                         getCanonicalNestedNameSpecifier(NNS->getPrefix()),
3843                                       NNS->getAsIdentifier());
3844
3845  case NestedNameSpecifier::Namespace:
3846    // A namespace is canonical; build a nested-name-specifier with
3847    // this namespace and no prefix.
3848    return NestedNameSpecifier::Create(*this, 0,
3849                                 NNS->getAsNamespace()->getOriginalNamespace());
3850
3851  case NestedNameSpecifier::NamespaceAlias:
3852    // A namespace is canonical; build a nested-name-specifier with
3853    // this namespace and no prefix.
3854    return NestedNameSpecifier::Create(*this, 0,
3855                                    NNS->getAsNamespaceAlias()->getNamespace()
3856                                                      ->getOriginalNamespace());
3857
3858  case NestedNameSpecifier::TypeSpec:
3859  case NestedNameSpecifier::TypeSpecWithTemplate: {
3860    QualType T = getCanonicalType(QualType(NNS->getAsType(), 0));
3861
3862    // If we have some kind of dependent-named type (e.g., "typename T::type"),
3863    // break it apart into its prefix and identifier, then reconsititute those
3864    // as the canonical nested-name-specifier. This is required to canonicalize
3865    // a dependent nested-name-specifier involving typedefs of dependent-name
3866    // types, e.g.,
3867    //   typedef typename T::type T1;
3868    //   typedef typename T1::type T2;
3869    if (const DependentNameType *DNT = T->getAs<DependentNameType>())
3870      return NestedNameSpecifier::Create(*this, DNT->getQualifier(),
3871                           const_cast<IdentifierInfo *>(DNT->getIdentifier()));
3872
3873    // Otherwise, just canonicalize the type, and force it to be a TypeSpec.
3874    // FIXME: Why are TypeSpec and TypeSpecWithTemplate distinct in the
3875    // first place?
3876    return NestedNameSpecifier::Create(*this, 0, false,
3877                                       const_cast<Type*>(T.getTypePtr()));
3878  }
3879
3880  case NestedNameSpecifier::Global:
3881    // The global specifier is canonical and unique.
3882    return NNS;
3883  }
3884
3885  llvm_unreachable("Invalid NestedNameSpecifier::Kind!");
3886}
3887
3888
3889const ArrayType *ASTContext::getAsArrayType(QualType T) const {
3890  // Handle the non-qualified case efficiently.
3891  if (!T.hasLocalQualifiers()) {
3892    // Handle the common positive case fast.
3893    if (const ArrayType *AT = dyn_cast<ArrayType>(T))
3894      return AT;
3895  }
3896
3897  // Handle the common negative case fast.
3898  if (!isa<ArrayType>(T.getCanonicalType()))
3899    return 0;
3900
3901  // Apply any qualifiers from the array type to the element type.  This
3902  // implements C99 6.7.3p8: "If the specification of an array type includes
3903  // any type qualifiers, the element type is so qualified, not the array type."
3904
3905  // If we get here, we either have type qualifiers on the type, or we have
3906  // sugar such as a typedef in the way.  If we have type qualifiers on the type
3907  // we must propagate them down into the element type.
3908
3909  SplitQualType split = T.getSplitDesugaredType();
3910  Qualifiers qs = split.Quals;
3911
3912  // If we have a simple case, just return now.
3913  const ArrayType *ATy = dyn_cast<ArrayType>(split.Ty);
3914  if (ATy == 0 || qs.empty())
3915    return ATy;
3916
3917  // Otherwise, we have an array and we have qualifiers on it.  Push the
3918  // qualifiers into the array element type and return a new array type.
3919  QualType NewEltTy = getQualifiedType(ATy->getElementType(), qs);
3920
3921  if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(ATy))
3922    return cast<ArrayType>(getConstantArrayType(NewEltTy, CAT->getSize(),
3923                                                CAT->getSizeModifier(),
3924                                           CAT->getIndexTypeCVRQualifiers()));
3925  if (const IncompleteArrayType *IAT = dyn_cast<IncompleteArrayType>(ATy))
3926    return cast<ArrayType>(getIncompleteArrayType(NewEltTy,
3927                                                  IAT->getSizeModifier(),
3928                                           IAT->getIndexTypeCVRQualifiers()));
3929
3930  if (const DependentSizedArrayType *DSAT
3931        = dyn_cast<DependentSizedArrayType>(ATy))
3932    return cast<ArrayType>(
3933                     getDependentSizedArrayType(NewEltTy,
3934                                                DSAT->getSizeExpr(),
3935                                                DSAT->getSizeModifier(),
3936                                              DSAT->getIndexTypeCVRQualifiers(),
3937                                                DSAT->getBracketsRange()));
3938
3939  const VariableArrayType *VAT = cast<VariableArrayType>(ATy);
3940  return cast<ArrayType>(getVariableArrayType(NewEltTy,
3941                                              VAT->getSizeExpr(),
3942                                              VAT->getSizeModifier(),
3943                                              VAT->getIndexTypeCVRQualifiers(),
3944                                              VAT->getBracketsRange()));
3945}
3946
3947QualType ASTContext::getAdjustedParameterType(QualType T) const {
3948  // C99 6.7.5.3p7:
3949  //   A declaration of a parameter as "array of type" shall be
3950  //   adjusted to "qualified pointer to type", where the type
3951  //   qualifiers (if any) are those specified within the [ and ] of
3952  //   the array type derivation.
3953  if (T->isArrayType())
3954    return getArrayDecayedType(T);
3955
3956  // C99 6.7.5.3p8:
3957  //   A declaration of a parameter as "function returning type"
3958  //   shall be adjusted to "pointer to function returning type", as
3959  //   in 6.3.2.1.
3960  if (T->isFunctionType())
3961    return getPointerType(T);
3962
3963  return T;
3964}
3965
3966QualType ASTContext::getSignatureParameterType(QualType T) const {
3967  T = getVariableArrayDecayedType(T);
3968  T = getAdjustedParameterType(T);
3969  return T.getUnqualifiedType();
3970}
3971
3972/// getArrayDecayedType - Return the properly qualified result of decaying the
3973/// specified array type to a pointer.  This operation is non-trivial when
3974/// handling typedefs etc.  The canonical type of "T" must be an array type,
3975/// this returns a pointer to a properly qualified element of the array.
3976///
3977/// See C99 6.7.5.3p7 and C99 6.3.2.1p3.
3978QualType ASTContext::getArrayDecayedType(QualType Ty) const {
3979  // Get the element type with 'getAsArrayType' so that we don't lose any
3980  // typedefs in the element type of the array.  This also handles propagation
3981  // of type qualifiers from the array type into the element type if present
3982  // (C99 6.7.3p8).
3983  const ArrayType *PrettyArrayType = getAsArrayType(Ty);
3984  assert(PrettyArrayType && "Not an array type!");
3985
3986  QualType PtrTy = getPointerType(PrettyArrayType->getElementType());
3987
3988  // int x[restrict 4] ->  int *restrict
3989  return getQualifiedType(PtrTy, PrettyArrayType->getIndexTypeQualifiers());
3990}
3991
3992QualType ASTContext::getBaseElementType(const ArrayType *array) const {
3993  return getBaseElementType(array->getElementType());
3994}
3995
3996QualType ASTContext::getBaseElementType(QualType type) const {
3997  Qualifiers qs;
3998  while (true) {
3999    SplitQualType split = type.getSplitDesugaredType();
4000    const ArrayType *array = split.Ty->getAsArrayTypeUnsafe();
4001    if (!array) break;
4002
4003    type = array->getElementType();
4004    qs.addConsistentQualifiers(split.Quals);
4005  }
4006
4007  return getQualifiedType(type, qs);
4008}
4009
4010/// getConstantArrayElementCount - Returns number of constant array elements.
4011uint64_t
4012ASTContext::getConstantArrayElementCount(const ConstantArrayType *CA)  const {
4013  uint64_t ElementCount = 1;
4014  do {
4015    ElementCount *= CA->getSize().getZExtValue();
4016    CA = dyn_cast_or_null<ConstantArrayType>(
4017      CA->getElementType()->getAsArrayTypeUnsafe());
4018  } while (CA);
4019  return ElementCount;
4020}
4021
4022/// getFloatingRank - Return a relative rank for floating point types.
4023/// This routine will assert if passed a built-in type that isn't a float.
4024static FloatingRank getFloatingRank(QualType T) {
4025  if (const ComplexType *CT = T->getAs<ComplexType>())
4026    return getFloatingRank(CT->getElementType());
4027
4028  assert(T->getAs<BuiltinType>() && "getFloatingRank(): not a floating type");
4029  switch (T->getAs<BuiltinType>()->getKind()) {
4030  default: llvm_unreachable("getFloatingRank(): not a floating type");
4031  case BuiltinType::Half:       return HalfRank;
4032  case BuiltinType::Float:      return FloatRank;
4033  case BuiltinType::Double:     return DoubleRank;
4034  case BuiltinType::LongDouble: return LongDoubleRank;
4035  }
4036}
4037
4038/// getFloatingTypeOfSizeWithinDomain - Returns a real floating
4039/// point or a complex type (based on typeDomain/typeSize).
4040/// 'typeDomain' is a real floating point or complex type.
4041/// 'typeSize' is a real floating point or complex type.
4042QualType ASTContext::getFloatingTypeOfSizeWithinDomain(QualType Size,
4043                                                       QualType Domain) const {
4044  FloatingRank EltRank = getFloatingRank(Size);
4045  if (Domain->isComplexType()) {
4046    switch (EltRank) {
4047    case HalfRank: llvm_unreachable("Complex half is not supported");
4048    case FloatRank:      return FloatComplexTy;
4049    case DoubleRank:     return DoubleComplexTy;
4050    case LongDoubleRank: return LongDoubleComplexTy;
4051    }
4052  }
4053
4054  assert(Domain->isRealFloatingType() && "Unknown domain!");
4055  switch (EltRank) {
4056  case HalfRank: llvm_unreachable("Half ranks are not valid here");
4057  case FloatRank:      return FloatTy;
4058  case DoubleRank:     return DoubleTy;
4059  case LongDoubleRank: return LongDoubleTy;
4060  }
4061  llvm_unreachable("getFloatingRank(): illegal value for rank");
4062}
4063
4064/// getFloatingTypeOrder - Compare the rank of the two specified floating
4065/// point types, ignoring the domain of the type (i.e. 'double' ==
4066/// '_Complex double').  If LHS > RHS, return 1.  If LHS == RHS, return 0. If
4067/// LHS < RHS, return -1.
4068int ASTContext::getFloatingTypeOrder(QualType LHS, QualType RHS) const {
4069  FloatingRank LHSR = getFloatingRank(LHS);
4070  FloatingRank RHSR = getFloatingRank(RHS);
4071
4072  if (LHSR == RHSR)
4073    return 0;
4074  if (LHSR > RHSR)
4075    return 1;
4076  return -1;
4077}
4078
4079/// getIntegerRank - Return an integer conversion rank (C99 6.3.1.1p1). This
4080/// routine will assert if passed a built-in type that isn't an integer or enum,
4081/// or if it is not canonicalized.
4082unsigned ASTContext::getIntegerRank(const Type *T) const {
4083  assert(T->isCanonicalUnqualified() && "T should be canonicalized");
4084
4085  switch (cast<BuiltinType>(T)->getKind()) {
4086  default: llvm_unreachable("getIntegerRank(): not a built-in integer");
4087  case BuiltinType::Bool:
4088    return 1 + (getIntWidth(BoolTy) << 3);
4089  case BuiltinType::Char_S:
4090  case BuiltinType::Char_U:
4091  case BuiltinType::SChar:
4092  case BuiltinType::UChar:
4093    return 2 + (getIntWidth(CharTy) << 3);
4094  case BuiltinType::Short:
4095  case BuiltinType::UShort:
4096    return 3 + (getIntWidth(ShortTy) << 3);
4097  case BuiltinType::Int:
4098  case BuiltinType::UInt:
4099    return 4 + (getIntWidth(IntTy) << 3);
4100  case BuiltinType::Long:
4101  case BuiltinType::ULong:
4102    return 5 + (getIntWidth(LongTy) << 3);
4103  case BuiltinType::LongLong:
4104  case BuiltinType::ULongLong:
4105    return 6 + (getIntWidth(LongLongTy) << 3);
4106  case BuiltinType::Int128:
4107  case BuiltinType::UInt128:
4108    return 7 + (getIntWidth(Int128Ty) << 3);
4109  }
4110}
4111
4112/// \brief Whether this is a promotable bitfield reference according
4113/// to C99 6.3.1.1p2, bullet 2 (and GCC extensions).
4114///
4115/// \returns the type this bit-field will promote to, or NULL if no
4116/// promotion occurs.
4117QualType ASTContext::isPromotableBitField(Expr *E) const {
4118  if (E->isTypeDependent() || E->isValueDependent())
4119    return QualType();
4120
4121  FieldDecl *Field = E->getBitField();
4122  if (!Field)
4123    return QualType();
4124
4125  QualType FT = Field->getType();
4126
4127  uint64_t BitWidth = Field->getBitWidthValue(*this);
4128  uint64_t IntSize = getTypeSize(IntTy);
4129  // GCC extension compatibility: if the bit-field size is less than or equal
4130  // to the size of int, it gets promoted no matter what its type is.
4131  // For instance, unsigned long bf : 4 gets promoted to signed int.
4132  if (BitWidth < IntSize)
4133    return IntTy;
4134
4135  if (BitWidth == IntSize)
4136    return FT->isSignedIntegerType() ? IntTy : UnsignedIntTy;
4137
4138  // Types bigger than int are not subject to promotions, and therefore act
4139  // like the base type.
4140  // FIXME: This doesn't quite match what gcc does, but what gcc does here
4141  // is ridiculous.
4142  return QualType();
4143}
4144
4145/// getPromotedIntegerType - Returns the type that Promotable will
4146/// promote to: C99 6.3.1.1p2, assuming that Promotable is a promotable
4147/// integer type.
4148QualType ASTContext::getPromotedIntegerType(QualType Promotable) const {
4149  assert(!Promotable.isNull());
4150  assert(Promotable->isPromotableIntegerType());
4151  if (const EnumType *ET = Promotable->getAs<EnumType>())
4152    return ET->getDecl()->getPromotionType();
4153
4154  if (const BuiltinType *BT = Promotable->getAs<BuiltinType>()) {
4155    // C++ [conv.prom]: A prvalue of type char16_t, char32_t, or wchar_t
4156    // (3.9.1) can be converted to a prvalue of the first of the following
4157    // types that can represent all the values of its underlying type:
4158    // int, unsigned int, long int, unsigned long int, long long int, or
4159    // unsigned long long int [...]
4160    // FIXME: Is there some better way to compute this?
4161    if (BT->getKind() == BuiltinType::WChar_S ||
4162        BT->getKind() == BuiltinType::WChar_U ||
4163        BT->getKind() == BuiltinType::Char16 ||
4164        BT->getKind() == BuiltinType::Char32) {
4165      bool FromIsSigned = BT->getKind() == BuiltinType::WChar_S;
4166      uint64_t FromSize = getTypeSize(BT);
4167      QualType PromoteTypes[] = { IntTy, UnsignedIntTy, LongTy, UnsignedLongTy,
4168                                  LongLongTy, UnsignedLongLongTy };
4169      for (size_t Idx = 0; Idx < llvm::array_lengthof(PromoteTypes); ++Idx) {
4170        uint64_t ToSize = getTypeSize(PromoteTypes[Idx]);
4171        if (FromSize < ToSize ||
4172            (FromSize == ToSize &&
4173             FromIsSigned == PromoteTypes[Idx]->isSignedIntegerType()))
4174          return PromoteTypes[Idx];
4175      }
4176      llvm_unreachable("char type should fit into long long");
4177    }
4178  }
4179
4180  // At this point, we should have a signed or unsigned integer type.
4181  if (Promotable->isSignedIntegerType())
4182    return IntTy;
4183  uint64_t PromotableSize = getIntWidth(Promotable);
4184  uint64_t IntSize = getIntWidth(IntTy);
4185  assert(Promotable->isUnsignedIntegerType() && PromotableSize <= IntSize);
4186  return (PromotableSize != IntSize) ? IntTy : UnsignedIntTy;
4187}
4188
4189/// \brief Recurses in pointer/array types until it finds an objc retainable
4190/// type and returns its ownership.
4191Qualifiers::ObjCLifetime ASTContext::getInnerObjCOwnership(QualType T) const {
4192  while (!T.isNull()) {
4193    if (T.getObjCLifetime() != Qualifiers::OCL_None)
4194      return T.getObjCLifetime();
4195    if (T->isArrayType())
4196      T = getBaseElementType(T);
4197    else if (const PointerType *PT = T->getAs<PointerType>())
4198      T = PT->getPointeeType();
4199    else if (const ReferenceType *RT = T->getAs<ReferenceType>())
4200      T = RT->getPointeeType();
4201    else
4202      break;
4203  }
4204
4205  return Qualifiers::OCL_None;
4206}
4207
4208/// getIntegerTypeOrder - Returns the highest ranked integer type:
4209/// C99 6.3.1.8p1.  If LHS > RHS, return 1.  If LHS == RHS, return 0. If
4210/// LHS < RHS, return -1.
4211int ASTContext::getIntegerTypeOrder(QualType LHS, QualType RHS) const {
4212  const Type *LHSC = getCanonicalType(LHS).getTypePtr();
4213  const Type *RHSC = getCanonicalType(RHS).getTypePtr();
4214  if (LHSC == RHSC) return 0;
4215
4216  bool LHSUnsigned = LHSC->isUnsignedIntegerType();
4217  bool RHSUnsigned = RHSC->isUnsignedIntegerType();
4218
4219  unsigned LHSRank = getIntegerRank(LHSC);
4220  unsigned RHSRank = getIntegerRank(RHSC);
4221
4222  if (LHSUnsigned == RHSUnsigned) {  // Both signed or both unsigned.
4223    if (LHSRank == RHSRank) return 0;
4224    return LHSRank > RHSRank ? 1 : -1;
4225  }
4226
4227  // Otherwise, the LHS is signed and the RHS is unsigned or visa versa.
4228  if (LHSUnsigned) {
4229    // If the unsigned [LHS] type is larger, return it.
4230    if (LHSRank >= RHSRank)
4231      return 1;
4232
4233    // If the signed type can represent all values of the unsigned type, it
4234    // wins.  Because we are dealing with 2's complement and types that are
4235    // powers of two larger than each other, this is always safe.
4236    return -1;
4237  }
4238
4239  // If the unsigned [RHS] type is larger, return it.
4240  if (RHSRank >= LHSRank)
4241    return -1;
4242
4243  // If the signed type can represent all values of the unsigned type, it
4244  // wins.  Because we are dealing with 2's complement and types that are
4245  // powers of two larger than each other, this is always safe.
4246  return 1;
4247}
4248
4249static RecordDecl *
4250CreateRecordDecl(const ASTContext &Ctx, RecordDecl::TagKind TK,
4251                 DeclContext *DC, IdentifierInfo *Id) {
4252  SourceLocation Loc;
4253  if (Ctx.getLangOpts().CPlusPlus)
4254    return CXXRecordDecl::Create(Ctx, TK, DC, Loc, Loc, Id);
4255  else
4256    return RecordDecl::Create(Ctx, TK, DC, Loc, Loc, Id);
4257}
4258
4259// getCFConstantStringType - Return the type used for constant CFStrings.
4260QualType ASTContext::getCFConstantStringType() const {
4261  if (!CFConstantStringTypeDecl) {
4262    CFConstantStringTypeDecl =
4263      CreateRecordDecl(*this, TTK_Struct, TUDecl,
4264                       &Idents.get("NSConstantString"));
4265    CFConstantStringTypeDecl->startDefinition();
4266
4267    QualType FieldTypes[4];
4268
4269    // const int *isa;
4270    FieldTypes[0] = getPointerType(IntTy.withConst());
4271    // int flags;
4272    FieldTypes[1] = IntTy;
4273    // const char *str;
4274    FieldTypes[2] = getPointerType(CharTy.withConst());
4275    // long length;
4276    FieldTypes[3] = LongTy;
4277
4278    // Create fields
4279    for (unsigned i = 0; i < 4; ++i) {
4280      FieldDecl *Field = FieldDecl::Create(*this, CFConstantStringTypeDecl,
4281                                           SourceLocation(),
4282                                           SourceLocation(), 0,
4283                                           FieldTypes[i], /*TInfo=*/0,
4284                                           /*BitWidth=*/0,
4285                                           /*Mutable=*/false,
4286                                           ICIS_NoInit);
4287      Field->setAccess(AS_public);
4288      CFConstantStringTypeDecl->addDecl(Field);
4289    }
4290
4291    CFConstantStringTypeDecl->completeDefinition();
4292  }
4293
4294  return getTagDeclType(CFConstantStringTypeDecl);
4295}
4296
4297void ASTContext::setCFConstantStringType(QualType T) {
4298  const RecordType *Rec = T->getAs<RecordType>();
4299  assert(Rec && "Invalid CFConstantStringType");
4300  CFConstantStringTypeDecl = Rec->getDecl();
4301}
4302
4303QualType ASTContext::getBlockDescriptorType() const {
4304  if (BlockDescriptorType)
4305    return getTagDeclType(BlockDescriptorType);
4306
4307  RecordDecl *T;
4308  // FIXME: Needs the FlagAppleBlock bit.
4309  T = CreateRecordDecl(*this, TTK_Struct, TUDecl,
4310                       &Idents.get("__block_descriptor"));
4311  T->startDefinition();
4312
4313  QualType FieldTypes[] = {
4314    UnsignedLongTy,
4315    UnsignedLongTy,
4316  };
4317
4318  const char *FieldNames[] = {
4319    "reserved",
4320    "Size"
4321  };
4322
4323  for (size_t i = 0; i < 2; ++i) {
4324    FieldDecl *Field = FieldDecl::Create(*this, T, SourceLocation(),
4325                                         SourceLocation(),
4326                                         &Idents.get(FieldNames[i]),
4327                                         FieldTypes[i], /*TInfo=*/0,
4328                                         /*BitWidth=*/0,
4329                                         /*Mutable=*/false,
4330                                         ICIS_NoInit);
4331    Field->setAccess(AS_public);
4332    T->addDecl(Field);
4333  }
4334
4335  T->completeDefinition();
4336
4337  BlockDescriptorType = T;
4338
4339  return getTagDeclType(BlockDescriptorType);
4340}
4341
4342QualType ASTContext::getBlockDescriptorExtendedType() const {
4343  if (BlockDescriptorExtendedType)
4344    return getTagDeclType(BlockDescriptorExtendedType);
4345
4346  RecordDecl *T;
4347  // FIXME: Needs the FlagAppleBlock bit.
4348  T = CreateRecordDecl(*this, TTK_Struct, TUDecl,
4349                       &Idents.get("__block_descriptor_withcopydispose"));
4350  T->startDefinition();
4351
4352  QualType FieldTypes[] = {
4353    UnsignedLongTy,
4354    UnsignedLongTy,
4355    getPointerType(VoidPtrTy),
4356    getPointerType(VoidPtrTy)
4357  };
4358
4359  const char *FieldNames[] = {
4360    "reserved",
4361    "Size",
4362    "CopyFuncPtr",
4363    "DestroyFuncPtr"
4364  };
4365
4366  for (size_t i = 0; i < 4; ++i) {
4367    FieldDecl *Field = FieldDecl::Create(*this, T, SourceLocation(),
4368                                         SourceLocation(),
4369                                         &Idents.get(FieldNames[i]),
4370                                         FieldTypes[i], /*TInfo=*/0,
4371                                         /*BitWidth=*/0,
4372                                         /*Mutable=*/false,
4373                                         ICIS_NoInit);
4374    Field->setAccess(AS_public);
4375    T->addDecl(Field);
4376  }
4377
4378  T->completeDefinition();
4379
4380  BlockDescriptorExtendedType = T;
4381
4382  return getTagDeclType(BlockDescriptorExtendedType);
4383}
4384
4385/// BlockRequiresCopying - Returns true if byref variable "D" of type "Ty"
4386/// requires copy/dispose. Note that this must match the logic
4387/// in buildByrefHelpers.
4388bool ASTContext::BlockRequiresCopying(QualType Ty,
4389                                      const VarDecl *D) {
4390  if (const CXXRecordDecl *record = Ty->getAsCXXRecordDecl()) {
4391    const Expr *copyExpr = getBlockVarCopyInits(D);
4392    if (!copyExpr && record->hasTrivialDestructor()) return false;
4393
4394    return true;
4395  }
4396
4397  if (!Ty->isObjCRetainableType()) return false;
4398
4399  Qualifiers qs = Ty.getQualifiers();
4400
4401  // If we have lifetime, that dominates.
4402  if (Qualifiers::ObjCLifetime lifetime = qs.getObjCLifetime()) {
4403    assert(getLangOpts().ObjCAutoRefCount);
4404
4405    switch (lifetime) {
4406      case Qualifiers::OCL_None: llvm_unreachable("impossible");
4407
4408      // These are just bits as far as the runtime is concerned.
4409      case Qualifiers::OCL_ExplicitNone:
4410      case Qualifiers::OCL_Autoreleasing:
4411        return false;
4412
4413      // Tell the runtime that this is ARC __weak, called by the
4414      // byref routines.
4415      case Qualifiers::OCL_Weak:
4416      // ARC __strong __block variables need to be retained.
4417      case Qualifiers::OCL_Strong:
4418        return true;
4419    }
4420    llvm_unreachable("fell out of lifetime switch!");
4421  }
4422  return (Ty->isBlockPointerType() || isObjCNSObjectType(Ty) ||
4423          Ty->isObjCObjectPointerType());
4424}
4425
4426bool ASTContext::getByrefLifetime(QualType Ty,
4427                              Qualifiers::ObjCLifetime &LifeTime,
4428                              bool &HasByrefExtendedLayout) const {
4429
4430  if (!getLangOpts().ObjC1 ||
4431      getLangOpts().getGC() != LangOptions::NonGC)
4432    return false;
4433
4434  HasByrefExtendedLayout = false;
4435  if (Ty->isRecordType()) {
4436    HasByrefExtendedLayout = true;
4437    LifeTime = Qualifiers::OCL_None;
4438  }
4439  else if (getLangOpts().ObjCAutoRefCount)
4440    LifeTime = Ty.getObjCLifetime();
4441  // MRR.
4442  else if (Ty->isObjCObjectPointerType() || Ty->isBlockPointerType())
4443    LifeTime = Qualifiers::OCL_ExplicitNone;
4444  else
4445    LifeTime = Qualifiers::OCL_None;
4446  return true;
4447}
4448
4449TypedefDecl *ASTContext::getObjCInstanceTypeDecl() {
4450  if (!ObjCInstanceTypeDecl)
4451    ObjCInstanceTypeDecl = TypedefDecl::Create(*this,
4452                                               getTranslationUnitDecl(),
4453                                               SourceLocation(),
4454                                               SourceLocation(),
4455                                               &Idents.get("instancetype"),
4456                                     getTrivialTypeSourceInfo(getObjCIdType()));
4457  return ObjCInstanceTypeDecl;
4458}
4459
4460// This returns true if a type has been typedefed to BOOL:
4461// typedef <type> BOOL;
4462static bool isTypeTypedefedAsBOOL(QualType T) {
4463  if (const TypedefType *TT = dyn_cast<TypedefType>(T))
4464    if (IdentifierInfo *II = TT->getDecl()->getIdentifier())
4465      return II->isStr("BOOL");
4466
4467  return false;
4468}
4469
4470/// getObjCEncodingTypeSize returns size of type for objective-c encoding
4471/// purpose.
4472CharUnits ASTContext::getObjCEncodingTypeSize(QualType type) const {
4473  if (!type->isIncompleteArrayType() && type->isIncompleteType())
4474    return CharUnits::Zero();
4475
4476  CharUnits sz = getTypeSizeInChars(type);
4477
4478  // Make all integer and enum types at least as large as an int
4479  if (sz.isPositive() && type->isIntegralOrEnumerationType())
4480    sz = std::max(sz, getTypeSizeInChars(IntTy));
4481  // Treat arrays as pointers, since that's how they're passed in.
4482  else if (type->isArrayType())
4483    sz = getTypeSizeInChars(VoidPtrTy);
4484  return sz;
4485}
4486
4487static inline
4488std::string charUnitsToString(const CharUnits &CU) {
4489  return llvm::itostr(CU.getQuantity());
4490}
4491
4492/// getObjCEncodingForBlock - Return the encoded type for this block
4493/// declaration.
4494std::string ASTContext::getObjCEncodingForBlock(const BlockExpr *Expr) const {
4495  std::string S;
4496
4497  const BlockDecl *Decl = Expr->getBlockDecl();
4498  QualType BlockTy =
4499      Expr->getType()->getAs<BlockPointerType>()->getPointeeType();
4500  // Encode result type.
4501  if (getLangOpts().EncodeExtendedBlockSig)
4502    getObjCEncodingForMethodParameter(Decl::OBJC_TQ_None,
4503                            BlockTy->getAs<FunctionType>()->getResultType(),
4504                            S, true /*Extended*/);
4505  else
4506    getObjCEncodingForType(BlockTy->getAs<FunctionType>()->getResultType(),
4507                           S);
4508  // Compute size of all parameters.
4509  // Start with computing size of a pointer in number of bytes.
4510  // FIXME: There might(should) be a better way of doing this computation!
4511  SourceLocation Loc;
4512  CharUnits PtrSize = getTypeSizeInChars(VoidPtrTy);
4513  CharUnits ParmOffset = PtrSize;
4514  for (BlockDecl::param_const_iterator PI = Decl->param_begin(),
4515       E = Decl->param_end(); PI != E; ++PI) {
4516    QualType PType = (*PI)->getType();
4517    CharUnits sz = getObjCEncodingTypeSize(PType);
4518    if (sz.isZero())
4519      continue;
4520    assert (sz.isPositive() && "BlockExpr - Incomplete param type");
4521    ParmOffset += sz;
4522  }
4523  // Size of the argument frame
4524  S += charUnitsToString(ParmOffset);
4525  // Block pointer and offset.
4526  S += "@?0";
4527
4528  // Argument types.
4529  ParmOffset = PtrSize;
4530  for (BlockDecl::param_const_iterator PI = Decl->param_begin(), E =
4531       Decl->param_end(); PI != E; ++PI) {
4532    ParmVarDecl *PVDecl = *PI;
4533    QualType PType = PVDecl->getOriginalType();
4534    if (const ArrayType *AT =
4535          dyn_cast<ArrayType>(PType->getCanonicalTypeInternal())) {
4536      // Use array's original type only if it has known number of
4537      // elements.
4538      if (!isa<ConstantArrayType>(AT))
4539        PType = PVDecl->getType();
4540    } else if (PType->isFunctionType())
4541      PType = PVDecl->getType();
4542    if (getLangOpts().EncodeExtendedBlockSig)
4543      getObjCEncodingForMethodParameter(Decl::OBJC_TQ_None, PType,
4544                                      S, true /*Extended*/);
4545    else
4546      getObjCEncodingForType(PType, S);
4547    S += charUnitsToString(ParmOffset);
4548    ParmOffset += getObjCEncodingTypeSize(PType);
4549  }
4550
4551  return S;
4552}
4553
4554bool ASTContext::getObjCEncodingForFunctionDecl(const FunctionDecl *Decl,
4555                                                std::string& S) {
4556  // Encode result type.
4557  getObjCEncodingForType(Decl->getResultType(), S);
4558  CharUnits ParmOffset;
4559  // Compute size of all parameters.
4560  for (FunctionDecl::param_const_iterator PI = Decl->param_begin(),
4561       E = Decl->param_end(); PI != E; ++PI) {
4562    QualType PType = (*PI)->getType();
4563    CharUnits sz = getObjCEncodingTypeSize(PType);
4564    if (sz.isZero())
4565      continue;
4566
4567    assert (sz.isPositive() &&
4568        "getObjCEncodingForFunctionDecl - Incomplete param type");
4569    ParmOffset += sz;
4570  }
4571  S += charUnitsToString(ParmOffset);
4572  ParmOffset = CharUnits::Zero();
4573
4574  // Argument types.
4575  for (FunctionDecl::param_const_iterator PI = Decl->param_begin(),
4576       E = Decl->param_end(); PI != E; ++PI) {
4577    ParmVarDecl *PVDecl = *PI;
4578    QualType PType = PVDecl->getOriginalType();
4579    if (const ArrayType *AT =
4580          dyn_cast<ArrayType>(PType->getCanonicalTypeInternal())) {
4581      // Use array's original type only if it has known number of
4582      // elements.
4583      if (!isa<ConstantArrayType>(AT))
4584        PType = PVDecl->getType();
4585    } else if (PType->isFunctionType())
4586      PType = PVDecl->getType();
4587    getObjCEncodingForType(PType, S);
4588    S += charUnitsToString(ParmOffset);
4589    ParmOffset += getObjCEncodingTypeSize(PType);
4590  }
4591
4592  return false;
4593}
4594
4595/// getObjCEncodingForMethodParameter - Return the encoded type for a single
4596/// method parameter or return type. If Extended, include class names and
4597/// block object types.
4598void ASTContext::getObjCEncodingForMethodParameter(Decl::ObjCDeclQualifier QT,
4599                                                   QualType T, std::string& S,
4600                                                   bool Extended) const {
4601  // Encode type qualifer, 'in', 'inout', etc. for the parameter.
4602  getObjCEncodingForTypeQualifier(QT, S);
4603  // Encode parameter type.
4604  getObjCEncodingForTypeImpl(T, S, true, true, 0,
4605                             true     /*OutermostType*/,
4606                             false    /*EncodingProperty*/,
4607                             false    /*StructField*/,
4608                             Extended /*EncodeBlockParameters*/,
4609                             Extended /*EncodeClassNames*/);
4610}
4611
4612/// getObjCEncodingForMethodDecl - Return the encoded type for this method
4613/// declaration.
4614bool ASTContext::getObjCEncodingForMethodDecl(const ObjCMethodDecl *Decl,
4615                                              std::string& S,
4616                                              bool Extended) const {
4617  // FIXME: This is not very efficient.
4618  // Encode return type.
4619  getObjCEncodingForMethodParameter(Decl->getObjCDeclQualifier(),
4620                                    Decl->getResultType(), S, Extended);
4621  // Compute size of all parameters.
4622  // Start with computing size of a pointer in number of bytes.
4623  // FIXME: There might(should) be a better way of doing this computation!
4624  SourceLocation Loc;
4625  CharUnits PtrSize = getTypeSizeInChars(VoidPtrTy);
4626  // The first two arguments (self and _cmd) are pointers; account for
4627  // their size.
4628  CharUnits ParmOffset = 2 * PtrSize;
4629  for (ObjCMethodDecl::param_const_iterator PI = Decl->param_begin(),
4630       E = Decl->sel_param_end(); PI != E; ++PI) {
4631    QualType PType = (*PI)->getType();
4632    CharUnits sz = getObjCEncodingTypeSize(PType);
4633    if (sz.isZero())
4634      continue;
4635
4636    assert (sz.isPositive() &&
4637        "getObjCEncodingForMethodDecl - Incomplete param type");
4638    ParmOffset += sz;
4639  }
4640  S += charUnitsToString(ParmOffset);
4641  S += "@0:";
4642  S += charUnitsToString(PtrSize);
4643
4644  // Argument types.
4645  ParmOffset = 2 * PtrSize;
4646  for (ObjCMethodDecl::param_const_iterator PI = Decl->param_begin(),
4647       E = Decl->sel_param_end(); PI != E; ++PI) {
4648    const ParmVarDecl *PVDecl = *PI;
4649    QualType PType = PVDecl->getOriginalType();
4650    if (const ArrayType *AT =
4651          dyn_cast<ArrayType>(PType->getCanonicalTypeInternal())) {
4652      // Use array's original type only if it has known number of
4653      // elements.
4654      if (!isa<ConstantArrayType>(AT))
4655        PType = PVDecl->getType();
4656    } else if (PType->isFunctionType())
4657      PType = PVDecl->getType();
4658    getObjCEncodingForMethodParameter(PVDecl->getObjCDeclQualifier(),
4659                                      PType, S, Extended);
4660    S += charUnitsToString(ParmOffset);
4661    ParmOffset += getObjCEncodingTypeSize(PType);
4662  }
4663
4664  return false;
4665}
4666
4667/// getObjCEncodingForPropertyDecl - Return the encoded type for this
4668/// property declaration. If non-NULL, Container must be either an
4669/// ObjCCategoryImplDecl or ObjCImplementationDecl; it should only be
4670/// NULL when getting encodings for protocol properties.
4671/// Property attributes are stored as a comma-delimited C string. The simple
4672/// attributes readonly and bycopy are encoded as single characters. The
4673/// parametrized attributes, getter=name, setter=name, and ivar=name, are
4674/// encoded as single characters, followed by an identifier. Property types
4675/// are also encoded as a parametrized attribute. The characters used to encode
4676/// these attributes are defined by the following enumeration:
4677/// @code
4678/// enum PropertyAttributes {
4679/// kPropertyReadOnly = 'R',   // property is read-only.
4680/// kPropertyBycopy = 'C',     // property is a copy of the value last assigned
4681/// kPropertyByref = '&',  // property is a reference to the value last assigned
4682/// kPropertyDynamic = 'D',    // property is dynamic
4683/// kPropertyGetter = 'G',     // followed by getter selector name
4684/// kPropertySetter = 'S',     // followed by setter selector name
4685/// kPropertyInstanceVariable = 'V'  // followed by instance variable  name
4686/// kPropertyType = 'T'              // followed by old-style type encoding.
4687/// kPropertyWeak = 'W'              // 'weak' property
4688/// kPropertyStrong = 'P'            // property GC'able
4689/// kPropertyNonAtomic = 'N'         // property non-atomic
4690/// };
4691/// @endcode
4692void ASTContext::getObjCEncodingForPropertyDecl(const ObjCPropertyDecl *PD,
4693                                                const Decl *Container,
4694                                                std::string& S) const {
4695  // Collect information from the property implementation decl(s).
4696  bool Dynamic = false;
4697  ObjCPropertyImplDecl *SynthesizePID = 0;
4698
4699  // FIXME: Duplicated code due to poor abstraction.
4700  if (Container) {
4701    if (const ObjCCategoryImplDecl *CID =
4702        dyn_cast<ObjCCategoryImplDecl>(Container)) {
4703      for (ObjCCategoryImplDecl::propimpl_iterator
4704             i = CID->propimpl_begin(), e = CID->propimpl_end();
4705           i != e; ++i) {
4706        ObjCPropertyImplDecl *PID = *i;
4707        if (PID->getPropertyDecl() == PD) {
4708          if (PID->getPropertyImplementation()==ObjCPropertyImplDecl::Dynamic) {
4709            Dynamic = true;
4710          } else {
4711            SynthesizePID = PID;
4712          }
4713        }
4714      }
4715    } else {
4716      const ObjCImplementationDecl *OID=cast<ObjCImplementationDecl>(Container);
4717      for (ObjCCategoryImplDecl::propimpl_iterator
4718             i = OID->propimpl_begin(), e = OID->propimpl_end();
4719           i != e; ++i) {
4720        ObjCPropertyImplDecl *PID = *i;
4721        if (PID->getPropertyDecl() == PD) {
4722          if (PID->getPropertyImplementation()==ObjCPropertyImplDecl::Dynamic) {
4723            Dynamic = true;
4724          } else {
4725            SynthesizePID = PID;
4726          }
4727        }
4728      }
4729    }
4730  }
4731
4732  // FIXME: This is not very efficient.
4733  S = "T";
4734
4735  // Encode result type.
4736  // GCC has some special rules regarding encoding of properties which
4737  // closely resembles encoding of ivars.
4738  getObjCEncodingForTypeImpl(PD->getType(), S, true, true, 0,
4739                             true /* outermost type */,
4740                             true /* encoding for property */);
4741
4742  if (PD->isReadOnly()) {
4743    S += ",R";
4744  } else {
4745    switch (PD->getSetterKind()) {
4746    case ObjCPropertyDecl::Assign: break;
4747    case ObjCPropertyDecl::Copy:   S += ",C"; break;
4748    case ObjCPropertyDecl::Retain: S += ",&"; break;
4749    case ObjCPropertyDecl::Weak:   S += ",W"; break;
4750    }
4751  }
4752
4753  // It really isn't clear at all what this means, since properties
4754  // are "dynamic by default".
4755  if (Dynamic)
4756    S += ",D";
4757
4758  if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_nonatomic)
4759    S += ",N";
4760
4761  if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_getter) {
4762    S += ",G";
4763    S += PD->getGetterName().getAsString();
4764  }
4765
4766  if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_setter) {
4767    S += ",S";
4768    S += PD->getSetterName().getAsString();
4769  }
4770
4771  if (SynthesizePID) {
4772    const ObjCIvarDecl *OID = SynthesizePID->getPropertyIvarDecl();
4773    S += ",V";
4774    S += OID->getNameAsString();
4775  }
4776
4777  // FIXME: OBJCGC: weak & strong
4778}
4779
4780/// getLegacyIntegralTypeEncoding -
4781/// Another legacy compatibility encoding: 32-bit longs are encoded as
4782/// 'l' or 'L' , but not always.  For typedefs, we need to use
4783/// 'i' or 'I' instead if encoding a struct field, or a pointer!
4784///
4785void ASTContext::getLegacyIntegralTypeEncoding (QualType &PointeeTy) const {
4786  if (isa<TypedefType>(PointeeTy.getTypePtr())) {
4787    if (const BuiltinType *BT = PointeeTy->getAs<BuiltinType>()) {
4788      if (BT->getKind() == BuiltinType::ULong && getIntWidth(PointeeTy) == 32)
4789        PointeeTy = UnsignedIntTy;
4790      else
4791        if (BT->getKind() == BuiltinType::Long && getIntWidth(PointeeTy) == 32)
4792          PointeeTy = IntTy;
4793    }
4794  }
4795}
4796
4797void ASTContext::getObjCEncodingForType(QualType T, std::string& S,
4798                                        const FieldDecl *Field) const {
4799  // We follow the behavior of gcc, expanding structures which are
4800  // directly pointed to, and expanding embedded structures. Note that
4801  // these rules are sufficient to prevent recursive encoding of the
4802  // same type.
4803  getObjCEncodingForTypeImpl(T, S, true, true, Field,
4804                             true /* outermost type */);
4805}
4806
4807static char ObjCEncodingForPrimitiveKind(const ASTContext *C, QualType T) {
4808    switch (T->getAs<BuiltinType>()->getKind()) {
4809    default: llvm_unreachable("Unhandled builtin type kind");
4810    case BuiltinType::Void:       return 'v';
4811    case BuiltinType::Bool:       return 'B';
4812    case BuiltinType::Char_U:
4813    case BuiltinType::UChar:      return 'C';
4814    case BuiltinType::UShort:     return 'S';
4815    case BuiltinType::UInt:       return 'I';
4816    case BuiltinType::ULong:
4817        return C->getIntWidth(T) == 32 ? 'L' : 'Q';
4818    case BuiltinType::UInt128:    return 'T';
4819    case BuiltinType::ULongLong:  return 'Q';
4820    case BuiltinType::Char_S:
4821    case BuiltinType::SChar:      return 'c';
4822    case BuiltinType::Short:      return 's';
4823    case BuiltinType::WChar_S:
4824    case BuiltinType::WChar_U:
4825    case BuiltinType::Int:        return 'i';
4826    case BuiltinType::Long:
4827      return C->getIntWidth(T) == 32 ? 'l' : 'q';
4828    case BuiltinType::LongLong:   return 'q';
4829    case BuiltinType::Int128:     return 't';
4830    case BuiltinType::Float:      return 'f';
4831    case BuiltinType::Double:     return 'd';
4832    case BuiltinType::LongDouble: return 'D';
4833    }
4834}
4835
4836static char ObjCEncodingForEnumType(const ASTContext *C, const EnumType *ET) {
4837  EnumDecl *Enum = ET->getDecl();
4838
4839  // The encoding of an non-fixed enum type is always 'i', regardless of size.
4840  if (!Enum->isFixed())
4841    return 'i';
4842
4843  // The encoding of a fixed enum type matches its fixed underlying type.
4844  return ObjCEncodingForPrimitiveKind(C, Enum->getIntegerType());
4845}
4846
4847static void EncodeBitField(const ASTContext *Ctx, std::string& S,
4848                           QualType T, const FieldDecl *FD) {
4849  assert(FD->isBitField() && "not a bitfield - getObjCEncodingForTypeImpl");
4850  S += 'b';
4851  // The NeXT runtime encodes bit fields as b followed by the number of bits.
4852  // The GNU runtime requires more information; bitfields are encoded as b,
4853  // then the offset (in bits) of the first element, then the type of the
4854  // bitfield, then the size in bits.  For example, in this structure:
4855  //
4856  // struct
4857  // {
4858  //    int integer;
4859  //    int flags:2;
4860  // };
4861  // On a 32-bit system, the encoding for flags would be b2 for the NeXT
4862  // runtime, but b32i2 for the GNU runtime.  The reason for this extra
4863  // information is not especially sensible, but we're stuck with it for
4864  // compatibility with GCC, although providing it breaks anything that
4865  // actually uses runtime introspection and wants to work on both runtimes...
4866  if (Ctx->getLangOpts().ObjCRuntime.isGNUFamily()) {
4867    const RecordDecl *RD = FD->getParent();
4868    const ASTRecordLayout &RL = Ctx->getASTRecordLayout(RD);
4869    S += llvm::utostr(RL.getFieldOffset(FD->getFieldIndex()));
4870    if (const EnumType *ET = T->getAs<EnumType>())
4871      S += ObjCEncodingForEnumType(Ctx, ET);
4872    else
4873      S += ObjCEncodingForPrimitiveKind(Ctx, T);
4874  }
4875  S += llvm::utostr(FD->getBitWidthValue(*Ctx));
4876}
4877
4878// FIXME: Use SmallString for accumulating string.
4879void ASTContext::getObjCEncodingForTypeImpl(QualType T, std::string& S,
4880                                            bool ExpandPointedToStructures,
4881                                            bool ExpandStructures,
4882                                            const FieldDecl *FD,
4883                                            bool OutermostType,
4884                                            bool EncodingProperty,
4885                                            bool StructField,
4886                                            bool EncodeBlockParameters,
4887                                            bool EncodeClassNames) const {
4888  if (T->getAs<BuiltinType>()) {
4889    if (FD && FD->isBitField())
4890      return EncodeBitField(this, S, T, FD);
4891    S += ObjCEncodingForPrimitiveKind(this, T);
4892    return;
4893  }
4894
4895  if (const ComplexType *CT = T->getAs<ComplexType>()) {
4896    S += 'j';
4897    getObjCEncodingForTypeImpl(CT->getElementType(), S, false, false, 0, false,
4898                               false);
4899    return;
4900  }
4901
4902  // encoding for pointer or r3eference types.
4903  QualType PointeeTy;
4904  if (const PointerType *PT = T->getAs<PointerType>()) {
4905    if (PT->isObjCSelType()) {
4906      S += ':';
4907      return;
4908    }
4909    PointeeTy = PT->getPointeeType();
4910  }
4911  else if (const ReferenceType *RT = T->getAs<ReferenceType>())
4912    PointeeTy = RT->getPointeeType();
4913  if (!PointeeTy.isNull()) {
4914    bool isReadOnly = false;
4915    // For historical/compatibility reasons, the read-only qualifier of the
4916    // pointee gets emitted _before_ the '^'.  The read-only qualifier of
4917    // the pointer itself gets ignored, _unless_ we are looking at a typedef!
4918    // Also, do not emit the 'r' for anything but the outermost type!
4919    if (isa<TypedefType>(T.getTypePtr())) {
4920      if (OutermostType && T.isConstQualified()) {
4921        isReadOnly = true;
4922        S += 'r';
4923      }
4924    } else if (OutermostType) {
4925      QualType P = PointeeTy;
4926      while (P->getAs<PointerType>())
4927        P = P->getAs<PointerType>()->getPointeeType();
4928      if (P.isConstQualified()) {
4929        isReadOnly = true;
4930        S += 'r';
4931      }
4932    }
4933    if (isReadOnly) {
4934      // Another legacy compatibility encoding. Some ObjC qualifier and type
4935      // combinations need to be rearranged.
4936      // Rewrite "in const" from "nr" to "rn"
4937      if (StringRef(S).endswith("nr"))
4938        S.replace(S.end()-2, S.end(), "rn");
4939    }
4940
4941    if (PointeeTy->isCharType()) {
4942      // char pointer types should be encoded as '*' unless it is a
4943      // type that has been typedef'd to 'BOOL'.
4944      if (!isTypeTypedefedAsBOOL(PointeeTy)) {
4945        S += '*';
4946        return;
4947      }
4948    } else if (const RecordType *RTy = PointeeTy->getAs<RecordType>()) {
4949      // GCC binary compat: Need to convert "struct objc_class *" to "#".
4950      if (RTy->getDecl()->getIdentifier() == &Idents.get("objc_class")) {
4951        S += '#';
4952        return;
4953      }
4954      // GCC binary compat: Need to convert "struct objc_object *" to "@".
4955      if (RTy->getDecl()->getIdentifier() == &Idents.get("objc_object")) {
4956        S += '@';
4957        return;
4958      }
4959      // fall through...
4960    }
4961    S += '^';
4962    getLegacyIntegralTypeEncoding(PointeeTy);
4963
4964    getObjCEncodingForTypeImpl(PointeeTy, S, false, ExpandPointedToStructures,
4965                               NULL);
4966    return;
4967  }
4968
4969  if (const ArrayType *AT =
4970      // Ignore type qualifiers etc.
4971        dyn_cast<ArrayType>(T->getCanonicalTypeInternal())) {
4972    if (isa<IncompleteArrayType>(AT) && !StructField) {
4973      // Incomplete arrays are encoded as a pointer to the array element.
4974      S += '^';
4975
4976      getObjCEncodingForTypeImpl(AT->getElementType(), S,
4977                                 false, ExpandStructures, FD);
4978    } else {
4979      S += '[';
4980
4981      if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(AT)) {
4982        if (getTypeSize(CAT->getElementType()) == 0)
4983          S += '0';
4984        else
4985          S += llvm::utostr(CAT->getSize().getZExtValue());
4986      } else {
4987        //Variable length arrays are encoded as a regular array with 0 elements.
4988        assert((isa<VariableArrayType>(AT) || isa<IncompleteArrayType>(AT)) &&
4989               "Unknown array type!");
4990        S += '0';
4991      }
4992
4993      getObjCEncodingForTypeImpl(AT->getElementType(), S,
4994                                 false, ExpandStructures, FD);
4995      S += ']';
4996    }
4997    return;
4998  }
4999
5000  if (T->getAs<FunctionType>()) {
5001    S += '?';
5002    return;
5003  }
5004
5005  if (const RecordType *RTy = T->getAs<RecordType>()) {
5006    RecordDecl *RDecl = RTy->getDecl();
5007    S += RDecl->isUnion() ? '(' : '{';
5008    // Anonymous structures print as '?'
5009    if (const IdentifierInfo *II = RDecl->getIdentifier()) {
5010      S += II->getName();
5011      if (ClassTemplateSpecializationDecl *Spec
5012          = dyn_cast<ClassTemplateSpecializationDecl>(RDecl)) {
5013        const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
5014        std::string TemplateArgsStr
5015          = TemplateSpecializationType::PrintTemplateArgumentList(
5016                                            TemplateArgs.data(),
5017                                            TemplateArgs.size(),
5018                                            (*this).getPrintingPolicy());
5019
5020        S += TemplateArgsStr;
5021      }
5022    } else {
5023      S += '?';
5024    }
5025    if (ExpandStructures) {
5026      S += '=';
5027      if (!RDecl->isUnion()) {
5028        getObjCEncodingForStructureImpl(RDecl, S, FD);
5029      } else {
5030        for (RecordDecl::field_iterator Field = RDecl->field_begin(),
5031                                     FieldEnd = RDecl->field_end();
5032             Field != FieldEnd; ++Field) {
5033          if (FD) {
5034            S += '"';
5035            S += Field->getNameAsString();
5036            S += '"';
5037          }
5038
5039          // Special case bit-fields.
5040          if (Field->isBitField()) {
5041            getObjCEncodingForTypeImpl(Field->getType(), S, false, true,
5042                                       *Field);
5043          } else {
5044            QualType qt = Field->getType();
5045            getLegacyIntegralTypeEncoding(qt);
5046            getObjCEncodingForTypeImpl(qt, S, false, true,
5047                                       FD, /*OutermostType*/false,
5048                                       /*EncodingProperty*/false,
5049                                       /*StructField*/true);
5050          }
5051        }
5052      }
5053    }
5054    S += RDecl->isUnion() ? ')' : '}';
5055    return;
5056  }
5057
5058  if (const EnumType *ET = T->getAs<EnumType>()) {
5059    if (FD && FD->isBitField())
5060      EncodeBitField(this, S, T, FD);
5061    else
5062      S += ObjCEncodingForEnumType(this, ET);
5063    return;
5064  }
5065
5066  if (const BlockPointerType *BT = T->getAs<BlockPointerType>()) {
5067    S += "@?"; // Unlike a pointer-to-function, which is "^?".
5068    if (EncodeBlockParameters) {
5069      const FunctionType *FT = BT->getPointeeType()->getAs<FunctionType>();
5070
5071      S += '<';
5072      // Block return type
5073      getObjCEncodingForTypeImpl(FT->getResultType(), S,
5074                                 ExpandPointedToStructures, ExpandStructures,
5075                                 FD,
5076                                 false /* OutermostType */,
5077                                 EncodingProperty,
5078                                 false /* StructField */,
5079                                 EncodeBlockParameters,
5080                                 EncodeClassNames);
5081      // Block self
5082      S += "@?";
5083      // Block parameters
5084      if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(FT)) {
5085        for (FunctionProtoType::arg_type_iterator I = FPT->arg_type_begin(),
5086               E = FPT->arg_type_end(); I && (I != E); ++I) {
5087          getObjCEncodingForTypeImpl(*I, S,
5088                                     ExpandPointedToStructures,
5089                                     ExpandStructures,
5090                                     FD,
5091                                     false /* OutermostType */,
5092                                     EncodingProperty,
5093                                     false /* StructField */,
5094                                     EncodeBlockParameters,
5095                                     EncodeClassNames);
5096        }
5097      }
5098      S += '>';
5099    }
5100    return;
5101  }
5102
5103  // Ignore protocol qualifiers when mangling at this level.
5104  if (const ObjCObjectType *OT = T->getAs<ObjCObjectType>())
5105    T = OT->getBaseType();
5106
5107  if (const ObjCInterfaceType *OIT = T->getAs<ObjCInterfaceType>()) {
5108    // @encode(class_name)
5109    ObjCInterfaceDecl *OI = OIT->getDecl();
5110    S += '{';
5111    const IdentifierInfo *II = OI->getIdentifier();
5112    S += II->getName();
5113    S += '=';
5114    SmallVector<const ObjCIvarDecl*, 32> Ivars;
5115    DeepCollectObjCIvars(OI, true, Ivars);
5116    for (unsigned i = 0, e = Ivars.size(); i != e; ++i) {
5117      const FieldDecl *Field = cast<FieldDecl>(Ivars[i]);
5118      if (Field->isBitField())
5119        getObjCEncodingForTypeImpl(Field->getType(), S, false, true, Field);
5120      else
5121        getObjCEncodingForTypeImpl(Field->getType(), S, false, true, FD);
5122    }
5123    S += '}';
5124    return;
5125  }
5126
5127  if (const ObjCObjectPointerType *OPT = T->getAs<ObjCObjectPointerType>()) {
5128    if (OPT->isObjCIdType()) {
5129      S += '@';
5130      return;
5131    }
5132
5133    if (OPT->isObjCClassType() || OPT->isObjCQualifiedClassType()) {
5134      // FIXME: Consider if we need to output qualifiers for 'Class<p>'.
5135      // Since this is a binary compatibility issue, need to consult with runtime
5136      // folks. Fortunately, this is a *very* obsure construct.
5137      S += '#';
5138      return;
5139    }
5140
5141    if (OPT->isObjCQualifiedIdType()) {
5142      getObjCEncodingForTypeImpl(getObjCIdType(), S,
5143                                 ExpandPointedToStructures,
5144                                 ExpandStructures, FD);
5145      if (FD || EncodingProperty || EncodeClassNames) {
5146        // Note that we do extended encoding of protocol qualifer list
5147        // Only when doing ivar or property encoding.
5148        S += '"';
5149        for (ObjCObjectPointerType::qual_iterator I = OPT->qual_begin(),
5150             E = OPT->qual_end(); I != E; ++I) {
5151          S += '<';
5152          S += (*I)->getNameAsString();
5153          S += '>';
5154        }
5155        S += '"';
5156      }
5157      return;
5158    }
5159
5160    QualType PointeeTy = OPT->getPointeeType();
5161    if (!EncodingProperty &&
5162        isa<TypedefType>(PointeeTy.getTypePtr())) {
5163      // Another historical/compatibility reason.
5164      // We encode the underlying type which comes out as
5165      // {...};
5166      S += '^';
5167      getObjCEncodingForTypeImpl(PointeeTy, S,
5168                                 false, ExpandPointedToStructures,
5169                                 NULL);
5170      return;
5171    }
5172
5173    S += '@';
5174    if (OPT->getInterfaceDecl() &&
5175        (FD || EncodingProperty || EncodeClassNames)) {
5176      S += '"';
5177      S += OPT->getInterfaceDecl()->getIdentifier()->getName();
5178      for (ObjCObjectPointerType::qual_iterator I = OPT->qual_begin(),
5179           E = OPT->qual_end(); I != E; ++I) {
5180        S += '<';
5181        S += (*I)->getNameAsString();
5182        S += '>';
5183      }
5184      S += '"';
5185    }
5186    return;
5187  }
5188
5189  // gcc just blithely ignores member pointers.
5190  // TODO: maybe there should be a mangling for these
5191  if (T->getAs<MemberPointerType>())
5192    return;
5193
5194  if (T->isVectorType()) {
5195    // This matches gcc's encoding, even though technically it is
5196    // insufficient.
5197    // FIXME. We should do a better job than gcc.
5198    return;
5199  }
5200
5201  llvm_unreachable("@encode for type not implemented!");
5202}
5203
5204void ASTContext::getObjCEncodingForStructureImpl(RecordDecl *RDecl,
5205                                                 std::string &S,
5206                                                 const FieldDecl *FD,
5207                                                 bool includeVBases) const {
5208  assert(RDecl && "Expected non-null RecordDecl");
5209  assert(!RDecl->isUnion() && "Should not be called for unions");
5210  if (!RDecl->getDefinition())
5211    return;
5212
5213  CXXRecordDecl *CXXRec = dyn_cast<CXXRecordDecl>(RDecl);
5214  std::multimap<uint64_t, NamedDecl *> FieldOrBaseOffsets;
5215  const ASTRecordLayout &layout = getASTRecordLayout(RDecl);
5216
5217  if (CXXRec) {
5218    for (CXXRecordDecl::base_class_iterator
5219           BI = CXXRec->bases_begin(),
5220           BE = CXXRec->bases_end(); BI != BE; ++BI) {
5221      if (!BI->isVirtual()) {
5222        CXXRecordDecl *base = BI->getType()->getAsCXXRecordDecl();
5223        if (base->isEmpty())
5224          continue;
5225        uint64_t offs = toBits(layout.getBaseClassOffset(base));
5226        FieldOrBaseOffsets.insert(FieldOrBaseOffsets.upper_bound(offs),
5227                                  std::make_pair(offs, base));
5228      }
5229    }
5230  }
5231
5232  unsigned i = 0;
5233  for (RecordDecl::field_iterator Field = RDecl->field_begin(),
5234                               FieldEnd = RDecl->field_end();
5235       Field != FieldEnd; ++Field, ++i) {
5236    uint64_t offs = layout.getFieldOffset(i);
5237    FieldOrBaseOffsets.insert(FieldOrBaseOffsets.upper_bound(offs),
5238                              std::make_pair(offs, *Field));
5239  }
5240
5241  if (CXXRec && includeVBases) {
5242    for (CXXRecordDecl::base_class_iterator
5243           BI = CXXRec->vbases_begin(),
5244           BE = CXXRec->vbases_end(); BI != BE; ++BI) {
5245      CXXRecordDecl *base = BI->getType()->getAsCXXRecordDecl();
5246      if (base->isEmpty())
5247        continue;
5248      uint64_t offs = toBits(layout.getVBaseClassOffset(base));
5249      if (FieldOrBaseOffsets.find(offs) == FieldOrBaseOffsets.end())
5250        FieldOrBaseOffsets.insert(FieldOrBaseOffsets.end(),
5251                                  std::make_pair(offs, base));
5252    }
5253  }
5254
5255  CharUnits size;
5256  if (CXXRec) {
5257    size = includeVBases ? layout.getSize() : layout.getNonVirtualSize();
5258  } else {
5259    size = layout.getSize();
5260  }
5261
5262  uint64_t CurOffs = 0;
5263  std::multimap<uint64_t, NamedDecl *>::iterator
5264    CurLayObj = FieldOrBaseOffsets.begin();
5265
5266  if (CXXRec && CXXRec->isDynamicClass() &&
5267      (CurLayObj == FieldOrBaseOffsets.end() || CurLayObj->first != 0)) {
5268    if (FD) {
5269      S += "\"_vptr$";
5270      std::string recname = CXXRec->getNameAsString();
5271      if (recname.empty()) recname = "?";
5272      S += recname;
5273      S += '"';
5274    }
5275    S += "^^?";
5276    CurOffs += getTypeSize(VoidPtrTy);
5277  }
5278
5279  if (!RDecl->hasFlexibleArrayMember()) {
5280    // Mark the end of the structure.
5281    uint64_t offs = toBits(size);
5282    FieldOrBaseOffsets.insert(FieldOrBaseOffsets.upper_bound(offs),
5283                              std::make_pair(offs, (NamedDecl*)0));
5284  }
5285
5286  for (; CurLayObj != FieldOrBaseOffsets.end(); ++CurLayObj) {
5287    assert(CurOffs <= CurLayObj->first);
5288
5289    if (CurOffs < CurLayObj->first) {
5290      uint64_t padding = CurLayObj->first - CurOffs;
5291      // FIXME: There doesn't seem to be a way to indicate in the encoding that
5292      // packing/alignment of members is different that normal, in which case
5293      // the encoding will be out-of-sync with the real layout.
5294      // If the runtime switches to just consider the size of types without
5295      // taking into account alignment, we could make padding explicit in the
5296      // encoding (e.g. using arrays of chars). The encoding strings would be
5297      // longer then though.
5298      CurOffs += padding;
5299    }
5300
5301    NamedDecl *dcl = CurLayObj->second;
5302    if (dcl == 0)
5303      break; // reached end of structure.
5304
5305    if (CXXRecordDecl *base = dyn_cast<CXXRecordDecl>(dcl)) {
5306      // We expand the bases without their virtual bases since those are going
5307      // in the initial structure. Note that this differs from gcc which
5308      // expands virtual bases each time one is encountered in the hierarchy,
5309      // making the encoding type bigger than it really is.
5310      getObjCEncodingForStructureImpl(base, S, FD, /*includeVBases*/false);
5311      assert(!base->isEmpty());
5312      CurOffs += toBits(getASTRecordLayout(base).getNonVirtualSize());
5313    } else {
5314      FieldDecl *field = cast<FieldDecl>(dcl);
5315      if (FD) {
5316        S += '"';
5317        S += field->getNameAsString();
5318        S += '"';
5319      }
5320
5321      if (field->isBitField()) {
5322        EncodeBitField(this, S, field->getType(), field);
5323        CurOffs += field->getBitWidthValue(*this);
5324      } else {
5325        QualType qt = field->getType();
5326        getLegacyIntegralTypeEncoding(qt);
5327        getObjCEncodingForTypeImpl(qt, S, false, true, FD,
5328                                   /*OutermostType*/false,
5329                                   /*EncodingProperty*/false,
5330                                   /*StructField*/true);
5331        CurOffs += getTypeSize(field->getType());
5332      }
5333    }
5334  }
5335}
5336
5337void ASTContext::getObjCEncodingForTypeQualifier(Decl::ObjCDeclQualifier QT,
5338                                                 std::string& S) const {
5339  if (QT & Decl::OBJC_TQ_In)
5340    S += 'n';
5341  if (QT & Decl::OBJC_TQ_Inout)
5342    S += 'N';
5343  if (QT & Decl::OBJC_TQ_Out)
5344    S += 'o';
5345  if (QT & Decl::OBJC_TQ_Bycopy)
5346    S += 'O';
5347  if (QT & Decl::OBJC_TQ_Byref)
5348    S += 'R';
5349  if (QT & Decl::OBJC_TQ_Oneway)
5350    S += 'V';
5351}
5352
5353TypedefDecl *ASTContext::getObjCIdDecl() const {
5354  if (!ObjCIdDecl) {
5355    QualType T = getObjCObjectType(ObjCBuiltinIdTy, 0, 0);
5356    T = getObjCObjectPointerType(T);
5357    TypeSourceInfo *IdInfo = getTrivialTypeSourceInfo(T);
5358    ObjCIdDecl = TypedefDecl::Create(const_cast<ASTContext &>(*this),
5359                                     getTranslationUnitDecl(),
5360                                     SourceLocation(), SourceLocation(),
5361                                     &Idents.get("id"), IdInfo);
5362  }
5363
5364  return ObjCIdDecl;
5365}
5366
5367TypedefDecl *ASTContext::getObjCSelDecl() const {
5368  if (!ObjCSelDecl) {
5369    QualType SelT = getPointerType(ObjCBuiltinSelTy);
5370    TypeSourceInfo *SelInfo = getTrivialTypeSourceInfo(SelT);
5371    ObjCSelDecl = TypedefDecl::Create(const_cast<ASTContext &>(*this),
5372                                      getTranslationUnitDecl(),
5373                                      SourceLocation(), SourceLocation(),
5374                                      &Idents.get("SEL"), SelInfo);
5375  }
5376  return ObjCSelDecl;
5377}
5378
5379TypedefDecl *ASTContext::getObjCClassDecl() const {
5380  if (!ObjCClassDecl) {
5381    QualType T = getObjCObjectType(ObjCBuiltinClassTy, 0, 0);
5382    T = getObjCObjectPointerType(T);
5383    TypeSourceInfo *ClassInfo = getTrivialTypeSourceInfo(T);
5384    ObjCClassDecl = TypedefDecl::Create(const_cast<ASTContext &>(*this),
5385                                        getTranslationUnitDecl(),
5386                                        SourceLocation(), SourceLocation(),
5387                                        &Idents.get("Class"), ClassInfo);
5388  }
5389
5390  return ObjCClassDecl;
5391}
5392
5393ObjCInterfaceDecl *ASTContext::getObjCProtocolDecl() const {
5394  if (!ObjCProtocolClassDecl) {
5395    ObjCProtocolClassDecl
5396      = ObjCInterfaceDecl::Create(*this, getTranslationUnitDecl(),
5397                                  SourceLocation(),
5398                                  &Idents.get("Protocol"),
5399                                  /*PrevDecl=*/0,
5400                                  SourceLocation(), true);
5401  }
5402
5403  return ObjCProtocolClassDecl;
5404}
5405
5406//===----------------------------------------------------------------------===//
5407// __builtin_va_list Construction Functions
5408//===----------------------------------------------------------------------===//
5409
5410static TypedefDecl *CreateCharPtrBuiltinVaListDecl(const ASTContext *Context) {
5411  // typedef char* __builtin_va_list;
5412  QualType CharPtrType = Context->getPointerType(Context->CharTy);
5413  TypeSourceInfo *TInfo
5414    = Context->getTrivialTypeSourceInfo(CharPtrType);
5415
5416  TypedefDecl *VaListTypeDecl
5417    = TypedefDecl::Create(const_cast<ASTContext &>(*Context),
5418                          Context->getTranslationUnitDecl(),
5419                          SourceLocation(), SourceLocation(),
5420                          &Context->Idents.get("__builtin_va_list"),
5421                          TInfo);
5422  return VaListTypeDecl;
5423}
5424
5425static TypedefDecl *CreateVoidPtrBuiltinVaListDecl(const ASTContext *Context) {
5426  // typedef void* __builtin_va_list;
5427  QualType VoidPtrType = Context->getPointerType(Context->VoidTy);
5428  TypeSourceInfo *TInfo
5429    = Context->getTrivialTypeSourceInfo(VoidPtrType);
5430
5431  TypedefDecl *VaListTypeDecl
5432    = TypedefDecl::Create(const_cast<ASTContext &>(*Context),
5433                          Context->getTranslationUnitDecl(),
5434                          SourceLocation(), SourceLocation(),
5435                          &Context->Idents.get("__builtin_va_list"),
5436                          TInfo);
5437  return VaListTypeDecl;
5438}
5439
5440static TypedefDecl *CreatePowerABIBuiltinVaListDecl(const ASTContext *Context) {
5441  // typedef struct __va_list_tag {
5442  RecordDecl *VaListTagDecl;
5443
5444  VaListTagDecl = CreateRecordDecl(*Context, TTK_Struct,
5445                                   Context->getTranslationUnitDecl(),
5446                                   &Context->Idents.get("__va_list_tag"));
5447  VaListTagDecl->startDefinition();
5448
5449  const size_t NumFields = 5;
5450  QualType FieldTypes[NumFields];
5451  const char *FieldNames[NumFields];
5452
5453  //   unsigned char gpr;
5454  FieldTypes[0] = Context->UnsignedCharTy;
5455  FieldNames[0] = "gpr";
5456
5457  //   unsigned char fpr;
5458  FieldTypes[1] = Context->UnsignedCharTy;
5459  FieldNames[1] = "fpr";
5460
5461  //   unsigned short reserved;
5462  FieldTypes[2] = Context->UnsignedShortTy;
5463  FieldNames[2] = "reserved";
5464
5465  //   void* overflow_arg_area;
5466  FieldTypes[3] = Context->getPointerType(Context->VoidTy);
5467  FieldNames[3] = "overflow_arg_area";
5468
5469  //   void* reg_save_area;
5470  FieldTypes[4] = Context->getPointerType(Context->VoidTy);
5471  FieldNames[4] = "reg_save_area";
5472
5473  // Create fields
5474  for (unsigned i = 0; i < NumFields; ++i) {
5475    FieldDecl *Field = FieldDecl::Create(*Context, VaListTagDecl,
5476                                         SourceLocation(),
5477                                         SourceLocation(),
5478                                         &Context->Idents.get(FieldNames[i]),
5479                                         FieldTypes[i], /*TInfo=*/0,
5480                                         /*BitWidth=*/0,
5481                                         /*Mutable=*/false,
5482                                         ICIS_NoInit);
5483    Field->setAccess(AS_public);
5484    VaListTagDecl->addDecl(Field);
5485  }
5486  VaListTagDecl->completeDefinition();
5487  QualType VaListTagType = Context->getRecordType(VaListTagDecl);
5488  Context->VaListTagTy = VaListTagType;
5489
5490  // } __va_list_tag;
5491  TypedefDecl *VaListTagTypedefDecl
5492    = TypedefDecl::Create(const_cast<ASTContext &>(*Context),
5493                          Context->getTranslationUnitDecl(),
5494                          SourceLocation(), SourceLocation(),
5495                          &Context->Idents.get("__va_list_tag"),
5496                          Context->getTrivialTypeSourceInfo(VaListTagType));
5497  QualType VaListTagTypedefType =
5498    Context->getTypedefType(VaListTagTypedefDecl);
5499
5500  // typedef __va_list_tag __builtin_va_list[1];
5501  llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 1);
5502  QualType VaListTagArrayType
5503    = Context->getConstantArrayType(VaListTagTypedefType,
5504                                    Size, ArrayType::Normal, 0);
5505  TypeSourceInfo *TInfo
5506    = Context->getTrivialTypeSourceInfo(VaListTagArrayType);
5507  TypedefDecl *VaListTypedefDecl
5508    = TypedefDecl::Create(const_cast<ASTContext &>(*Context),
5509                          Context->getTranslationUnitDecl(),
5510                          SourceLocation(), SourceLocation(),
5511                          &Context->Idents.get("__builtin_va_list"),
5512                          TInfo);
5513
5514  return VaListTypedefDecl;
5515}
5516
5517static TypedefDecl *
5518CreateX86_64ABIBuiltinVaListDecl(const ASTContext *Context) {
5519  // typedef struct __va_list_tag {
5520  RecordDecl *VaListTagDecl;
5521  VaListTagDecl = CreateRecordDecl(*Context, TTK_Struct,
5522                                   Context->getTranslationUnitDecl(),
5523                                   &Context->Idents.get("__va_list_tag"));
5524  VaListTagDecl->startDefinition();
5525
5526  const size_t NumFields = 4;
5527  QualType FieldTypes[NumFields];
5528  const char *FieldNames[NumFields];
5529
5530  //   unsigned gp_offset;
5531  FieldTypes[0] = Context->UnsignedIntTy;
5532  FieldNames[0] = "gp_offset";
5533
5534  //   unsigned fp_offset;
5535  FieldTypes[1] = Context->UnsignedIntTy;
5536  FieldNames[1] = "fp_offset";
5537
5538  //   void* overflow_arg_area;
5539  FieldTypes[2] = Context->getPointerType(Context->VoidTy);
5540  FieldNames[2] = "overflow_arg_area";
5541
5542  //   void* reg_save_area;
5543  FieldTypes[3] = Context->getPointerType(Context->VoidTy);
5544  FieldNames[3] = "reg_save_area";
5545
5546  // Create fields
5547  for (unsigned i = 0; i < NumFields; ++i) {
5548    FieldDecl *Field = FieldDecl::Create(const_cast<ASTContext &>(*Context),
5549                                         VaListTagDecl,
5550                                         SourceLocation(),
5551                                         SourceLocation(),
5552                                         &Context->Idents.get(FieldNames[i]),
5553                                         FieldTypes[i], /*TInfo=*/0,
5554                                         /*BitWidth=*/0,
5555                                         /*Mutable=*/false,
5556                                         ICIS_NoInit);
5557    Field->setAccess(AS_public);
5558    VaListTagDecl->addDecl(Field);
5559  }
5560  VaListTagDecl->completeDefinition();
5561  QualType VaListTagType = Context->getRecordType(VaListTagDecl);
5562  Context->VaListTagTy = VaListTagType;
5563
5564  // } __va_list_tag;
5565  TypedefDecl *VaListTagTypedefDecl
5566    = TypedefDecl::Create(const_cast<ASTContext &>(*Context),
5567                          Context->getTranslationUnitDecl(),
5568                          SourceLocation(), SourceLocation(),
5569                          &Context->Idents.get("__va_list_tag"),
5570                          Context->getTrivialTypeSourceInfo(VaListTagType));
5571  QualType VaListTagTypedefType =
5572    Context->getTypedefType(VaListTagTypedefDecl);
5573
5574  // typedef __va_list_tag __builtin_va_list[1];
5575  llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 1);
5576  QualType VaListTagArrayType
5577    = Context->getConstantArrayType(VaListTagTypedefType,
5578                                      Size, ArrayType::Normal,0);
5579  TypeSourceInfo *TInfo
5580    = Context->getTrivialTypeSourceInfo(VaListTagArrayType);
5581  TypedefDecl *VaListTypedefDecl
5582    = TypedefDecl::Create(const_cast<ASTContext &>(*Context),
5583                          Context->getTranslationUnitDecl(),
5584                          SourceLocation(), SourceLocation(),
5585                          &Context->Idents.get("__builtin_va_list"),
5586                          TInfo);
5587
5588  return VaListTypedefDecl;
5589}
5590
5591static TypedefDecl *CreatePNaClABIBuiltinVaListDecl(const ASTContext *Context) {
5592  // typedef int __builtin_va_list[4];
5593  llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 4);
5594  QualType IntArrayType
5595    = Context->getConstantArrayType(Context->IntTy,
5596				    Size, ArrayType::Normal, 0);
5597  TypedefDecl *VaListTypedefDecl
5598    = TypedefDecl::Create(const_cast<ASTContext &>(*Context),
5599                          Context->getTranslationUnitDecl(),
5600                          SourceLocation(), SourceLocation(),
5601                          &Context->Idents.get("__builtin_va_list"),
5602                          Context->getTrivialTypeSourceInfo(IntArrayType));
5603
5604  return VaListTypedefDecl;
5605}
5606
5607static TypedefDecl *
5608CreateAAPCSABIBuiltinVaListDecl(const ASTContext *Context) {
5609  RecordDecl *VaListDecl;
5610  if (Context->getLangOpts().CPlusPlus) {
5611    // namespace std { struct __va_list {
5612    NamespaceDecl *NS;
5613    NS = NamespaceDecl::Create(const_cast<ASTContext &>(*Context),
5614                               Context->getTranslationUnitDecl(),
5615                               /*Inline*/false, SourceLocation(),
5616                               SourceLocation(), &Context->Idents.get("std"),
5617                               /*PrevDecl*/0);
5618
5619    VaListDecl = CXXRecordDecl::Create(*Context, TTK_Struct,
5620                                       Context->getTranslationUnitDecl(),
5621                                       SourceLocation(), SourceLocation(),
5622                                       &Context->Idents.get("__va_list"));
5623
5624    VaListDecl->setDeclContext(NS);
5625
5626  } else {
5627    // struct __va_list {
5628    VaListDecl = CreateRecordDecl(*Context, TTK_Struct,
5629                                  Context->getTranslationUnitDecl(),
5630                                  &Context->Idents.get("__va_list"));
5631  }
5632
5633  VaListDecl->startDefinition();
5634
5635  // void * __ap;
5636  FieldDecl *Field = FieldDecl::Create(const_cast<ASTContext &>(*Context),
5637                                       VaListDecl,
5638                                       SourceLocation(),
5639                                       SourceLocation(),
5640                                       &Context->Idents.get("__ap"),
5641                                       Context->getPointerType(Context->VoidTy),
5642                                       /*TInfo=*/0,
5643                                       /*BitWidth=*/0,
5644                                       /*Mutable=*/false,
5645                                       ICIS_NoInit);
5646  Field->setAccess(AS_public);
5647  VaListDecl->addDecl(Field);
5648
5649  // };
5650  VaListDecl->completeDefinition();
5651
5652  // typedef struct __va_list __builtin_va_list;
5653  TypeSourceInfo *TInfo
5654    = Context->getTrivialTypeSourceInfo(Context->getRecordType(VaListDecl));
5655
5656  TypedefDecl *VaListTypeDecl
5657    = TypedefDecl::Create(const_cast<ASTContext &>(*Context),
5658                          Context->getTranslationUnitDecl(),
5659                          SourceLocation(), SourceLocation(),
5660                          &Context->Idents.get("__builtin_va_list"),
5661                          TInfo);
5662
5663  return VaListTypeDecl;
5664}
5665
5666static TypedefDecl *CreateVaListDecl(const ASTContext *Context,
5667                                     TargetInfo::BuiltinVaListKind Kind) {
5668  switch (Kind) {
5669  case TargetInfo::CharPtrBuiltinVaList:
5670    return CreateCharPtrBuiltinVaListDecl(Context);
5671  case TargetInfo::VoidPtrBuiltinVaList:
5672    return CreateVoidPtrBuiltinVaListDecl(Context);
5673  case TargetInfo::PowerABIBuiltinVaList:
5674    return CreatePowerABIBuiltinVaListDecl(Context);
5675  case TargetInfo::X86_64ABIBuiltinVaList:
5676    return CreateX86_64ABIBuiltinVaListDecl(Context);
5677  case TargetInfo::PNaClABIBuiltinVaList:
5678    return CreatePNaClABIBuiltinVaListDecl(Context);
5679  case TargetInfo::AAPCSABIBuiltinVaList:
5680    return CreateAAPCSABIBuiltinVaListDecl(Context);
5681  }
5682
5683  llvm_unreachable("Unhandled __builtin_va_list type kind");
5684}
5685
5686TypedefDecl *ASTContext::getBuiltinVaListDecl() const {
5687  if (!BuiltinVaListDecl)
5688    BuiltinVaListDecl = CreateVaListDecl(this, Target->getBuiltinVaListKind());
5689
5690  return BuiltinVaListDecl;
5691}
5692
5693QualType ASTContext::getVaListTagType() const {
5694  // Force the creation of VaListTagTy by building the __builtin_va_list
5695  // declaration.
5696  if (VaListTagTy.isNull())
5697    (void) getBuiltinVaListDecl();
5698
5699  return VaListTagTy;
5700}
5701
5702void ASTContext::setObjCConstantStringInterface(ObjCInterfaceDecl *Decl) {
5703  assert(ObjCConstantStringType.isNull() &&
5704         "'NSConstantString' type already set!");
5705
5706  ObjCConstantStringType = getObjCInterfaceType(Decl);
5707}
5708
5709/// \brief Retrieve the template name that corresponds to a non-empty
5710/// lookup.
5711TemplateName
5712ASTContext::getOverloadedTemplateName(UnresolvedSetIterator Begin,
5713                                      UnresolvedSetIterator End) const {
5714  unsigned size = End - Begin;
5715  assert(size > 1 && "set is not overloaded!");
5716
5717  void *memory = Allocate(sizeof(OverloadedTemplateStorage) +
5718                          size * sizeof(FunctionTemplateDecl*));
5719  OverloadedTemplateStorage *OT = new(memory) OverloadedTemplateStorage(size);
5720
5721  NamedDecl **Storage = OT->getStorage();
5722  for (UnresolvedSetIterator I = Begin; I != End; ++I) {
5723    NamedDecl *D = *I;
5724    assert(isa<FunctionTemplateDecl>(D) ||
5725           (isa<UsingShadowDecl>(D) &&
5726            isa<FunctionTemplateDecl>(D->getUnderlyingDecl())));
5727    *Storage++ = D;
5728  }
5729
5730  return TemplateName(OT);
5731}
5732
5733/// \brief Retrieve the template name that represents a qualified
5734/// template name such as \c std::vector.
5735TemplateName
5736ASTContext::getQualifiedTemplateName(NestedNameSpecifier *NNS,
5737                                     bool TemplateKeyword,
5738                                     TemplateDecl *Template) const {
5739  assert(NNS && "Missing nested-name-specifier in qualified template name");
5740
5741  // FIXME: Canonicalization?
5742  llvm::FoldingSetNodeID ID;
5743  QualifiedTemplateName::Profile(ID, NNS, TemplateKeyword, Template);
5744
5745  void *InsertPos = 0;
5746  QualifiedTemplateName *QTN =
5747    QualifiedTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
5748  if (!QTN) {
5749    QTN = new (*this, llvm::alignOf<QualifiedTemplateName>())
5750        QualifiedTemplateName(NNS, TemplateKeyword, Template);
5751    QualifiedTemplateNames.InsertNode(QTN, InsertPos);
5752  }
5753
5754  return TemplateName(QTN);
5755}
5756
5757/// \brief Retrieve the template name that represents a dependent
5758/// template name such as \c MetaFun::template apply.
5759TemplateName
5760ASTContext::getDependentTemplateName(NestedNameSpecifier *NNS,
5761                                     const IdentifierInfo *Name) const {
5762  assert((!NNS || NNS->isDependent()) &&
5763         "Nested name specifier must be dependent");
5764
5765  llvm::FoldingSetNodeID ID;
5766  DependentTemplateName::Profile(ID, NNS, Name);
5767
5768  void *InsertPos = 0;
5769  DependentTemplateName *QTN =
5770    DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
5771
5772  if (QTN)
5773    return TemplateName(QTN);
5774
5775  NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
5776  if (CanonNNS == NNS) {
5777    QTN = new (*this, llvm::alignOf<DependentTemplateName>())
5778        DependentTemplateName(NNS, Name);
5779  } else {
5780    TemplateName Canon = getDependentTemplateName(CanonNNS, Name);
5781    QTN = new (*this, llvm::alignOf<DependentTemplateName>())
5782        DependentTemplateName(NNS, Name, Canon);
5783    DependentTemplateName *CheckQTN =
5784      DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
5785    assert(!CheckQTN && "Dependent type name canonicalization broken");
5786    (void)CheckQTN;
5787  }
5788
5789  DependentTemplateNames.InsertNode(QTN, InsertPos);
5790  return TemplateName(QTN);
5791}
5792
5793/// \brief Retrieve the template name that represents a dependent
5794/// template name such as \c MetaFun::template operator+.
5795TemplateName
5796ASTContext::getDependentTemplateName(NestedNameSpecifier *NNS,
5797                                     OverloadedOperatorKind Operator) const {
5798  assert((!NNS || NNS->isDependent()) &&
5799         "Nested name specifier must be dependent");
5800
5801  llvm::FoldingSetNodeID ID;
5802  DependentTemplateName::Profile(ID, NNS, Operator);
5803
5804  void *InsertPos = 0;
5805  DependentTemplateName *QTN
5806    = DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
5807
5808  if (QTN)
5809    return TemplateName(QTN);
5810
5811  NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
5812  if (CanonNNS == NNS) {
5813    QTN = new (*this, llvm::alignOf<DependentTemplateName>())
5814        DependentTemplateName(NNS, Operator);
5815  } else {
5816    TemplateName Canon = getDependentTemplateName(CanonNNS, Operator);
5817    QTN = new (*this, llvm::alignOf<DependentTemplateName>())
5818        DependentTemplateName(NNS, Operator, Canon);
5819
5820    DependentTemplateName *CheckQTN
5821      = DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
5822    assert(!CheckQTN && "Dependent template name canonicalization broken");
5823    (void)CheckQTN;
5824  }
5825
5826  DependentTemplateNames.InsertNode(QTN, InsertPos);
5827  return TemplateName(QTN);
5828}
5829
5830TemplateName
5831ASTContext::getSubstTemplateTemplateParm(TemplateTemplateParmDecl *param,
5832                                         TemplateName replacement) const {
5833  llvm::FoldingSetNodeID ID;
5834  SubstTemplateTemplateParmStorage::Profile(ID, param, replacement);
5835
5836  void *insertPos = 0;
5837  SubstTemplateTemplateParmStorage *subst
5838    = SubstTemplateTemplateParms.FindNodeOrInsertPos(ID, insertPos);
5839
5840  if (!subst) {
5841    subst = new (*this) SubstTemplateTemplateParmStorage(param, replacement);
5842    SubstTemplateTemplateParms.InsertNode(subst, insertPos);
5843  }
5844
5845  return TemplateName(subst);
5846}
5847
5848TemplateName
5849ASTContext::getSubstTemplateTemplateParmPack(TemplateTemplateParmDecl *Param,
5850                                       const TemplateArgument &ArgPack) const {
5851  ASTContext &Self = const_cast<ASTContext &>(*this);
5852  llvm::FoldingSetNodeID ID;
5853  SubstTemplateTemplateParmPackStorage::Profile(ID, Self, Param, ArgPack);
5854
5855  void *InsertPos = 0;
5856  SubstTemplateTemplateParmPackStorage *Subst
5857    = SubstTemplateTemplateParmPacks.FindNodeOrInsertPos(ID, InsertPos);
5858
5859  if (!Subst) {
5860    Subst = new (*this) SubstTemplateTemplateParmPackStorage(Param,
5861                                                           ArgPack.pack_size(),
5862                                                         ArgPack.pack_begin());
5863    SubstTemplateTemplateParmPacks.InsertNode(Subst, InsertPos);
5864  }
5865
5866  return TemplateName(Subst);
5867}
5868
5869/// getFromTargetType - Given one of the integer types provided by
5870/// TargetInfo, produce the corresponding type. The unsigned @p Type
5871/// is actually a value of type @c TargetInfo::IntType.
5872CanQualType ASTContext::getFromTargetType(unsigned Type) const {
5873  switch (Type) {
5874  case TargetInfo::NoInt: return CanQualType();
5875  case TargetInfo::SignedShort: return ShortTy;
5876  case TargetInfo::UnsignedShort: return UnsignedShortTy;
5877  case TargetInfo::SignedInt: return IntTy;
5878  case TargetInfo::UnsignedInt: return UnsignedIntTy;
5879  case TargetInfo::SignedLong: return LongTy;
5880  case TargetInfo::UnsignedLong: return UnsignedLongTy;
5881  case TargetInfo::SignedLongLong: return LongLongTy;
5882  case TargetInfo::UnsignedLongLong: return UnsignedLongLongTy;
5883  }
5884
5885  llvm_unreachable("Unhandled TargetInfo::IntType value");
5886}
5887
5888//===----------------------------------------------------------------------===//
5889//                        Type Predicates.
5890//===----------------------------------------------------------------------===//
5891
5892/// getObjCGCAttr - Returns one of GCNone, Weak or Strong objc's
5893/// garbage collection attribute.
5894///
5895Qualifiers::GC ASTContext::getObjCGCAttrKind(QualType Ty) const {
5896  if (getLangOpts().getGC() == LangOptions::NonGC)
5897    return Qualifiers::GCNone;
5898
5899  assert(getLangOpts().ObjC1);
5900  Qualifiers::GC GCAttrs = Ty.getObjCGCAttr();
5901
5902  // Default behaviour under objective-C's gc is for ObjC pointers
5903  // (or pointers to them) be treated as though they were declared
5904  // as __strong.
5905  if (GCAttrs == Qualifiers::GCNone) {
5906    if (Ty->isObjCObjectPointerType() || Ty->isBlockPointerType())
5907      return Qualifiers::Strong;
5908    else if (Ty->isPointerType())
5909      return getObjCGCAttrKind(Ty->getAs<PointerType>()->getPointeeType());
5910  } else {
5911    // It's not valid to set GC attributes on anything that isn't a
5912    // pointer.
5913#ifndef NDEBUG
5914    QualType CT = Ty->getCanonicalTypeInternal();
5915    while (const ArrayType *AT = dyn_cast<ArrayType>(CT))
5916      CT = AT->getElementType();
5917    assert(CT->isAnyPointerType() || CT->isBlockPointerType());
5918#endif
5919  }
5920  return GCAttrs;
5921}
5922
5923//===----------------------------------------------------------------------===//
5924//                        Type Compatibility Testing
5925//===----------------------------------------------------------------------===//
5926
5927/// areCompatVectorTypes - Return true if the two specified vector types are
5928/// compatible.
5929static bool areCompatVectorTypes(const VectorType *LHS,
5930                                 const VectorType *RHS) {
5931  assert(LHS->isCanonicalUnqualified() && RHS->isCanonicalUnqualified());
5932  return LHS->getElementType() == RHS->getElementType() &&
5933         LHS->getNumElements() == RHS->getNumElements();
5934}
5935
5936bool ASTContext::areCompatibleVectorTypes(QualType FirstVec,
5937                                          QualType SecondVec) {
5938  assert(FirstVec->isVectorType() && "FirstVec should be a vector type");
5939  assert(SecondVec->isVectorType() && "SecondVec should be a vector type");
5940
5941  if (hasSameUnqualifiedType(FirstVec, SecondVec))
5942    return true;
5943
5944  // Treat Neon vector types and most AltiVec vector types as if they are the
5945  // equivalent GCC vector types.
5946  const VectorType *First = FirstVec->getAs<VectorType>();
5947  const VectorType *Second = SecondVec->getAs<VectorType>();
5948  if (First->getNumElements() == Second->getNumElements() &&
5949      hasSameType(First->getElementType(), Second->getElementType()) &&
5950      First->getVectorKind() != VectorType::AltiVecPixel &&
5951      First->getVectorKind() != VectorType::AltiVecBool &&
5952      Second->getVectorKind() != VectorType::AltiVecPixel &&
5953      Second->getVectorKind() != VectorType::AltiVecBool)
5954    return true;
5955
5956  return false;
5957}
5958
5959//===----------------------------------------------------------------------===//
5960// ObjCQualifiedIdTypesAreCompatible - Compatibility testing for qualified id's.
5961//===----------------------------------------------------------------------===//
5962
5963/// ProtocolCompatibleWithProtocol - return 'true' if 'lProto' is in the
5964/// inheritance hierarchy of 'rProto'.
5965bool
5966ASTContext::ProtocolCompatibleWithProtocol(ObjCProtocolDecl *lProto,
5967                                           ObjCProtocolDecl *rProto) const {
5968  if (declaresSameEntity(lProto, rProto))
5969    return true;
5970  for (ObjCProtocolDecl::protocol_iterator PI = rProto->protocol_begin(),
5971       E = rProto->protocol_end(); PI != E; ++PI)
5972    if (ProtocolCompatibleWithProtocol(lProto, *PI))
5973      return true;
5974  return false;
5975}
5976
5977/// QualifiedIdConformsQualifiedId - compare id<pr,...> with id<pr1,...>
5978/// return true if lhs's protocols conform to rhs's protocol; false
5979/// otherwise.
5980bool ASTContext::QualifiedIdConformsQualifiedId(QualType lhs, QualType rhs) {
5981  if (lhs->isObjCQualifiedIdType() && rhs->isObjCQualifiedIdType())
5982    return ObjCQualifiedIdTypesAreCompatible(lhs, rhs, false);
5983  return false;
5984}
5985
5986/// ObjCQualifiedClassTypesAreCompatible - compare  Class<pr,...> and
5987/// Class<pr1, ...>.
5988bool ASTContext::ObjCQualifiedClassTypesAreCompatible(QualType lhs,
5989                                                      QualType rhs) {
5990  const ObjCObjectPointerType *lhsQID = lhs->getAs<ObjCObjectPointerType>();
5991  const ObjCObjectPointerType *rhsOPT = rhs->getAs<ObjCObjectPointerType>();
5992  assert ((lhsQID && rhsOPT) && "ObjCQualifiedClassTypesAreCompatible");
5993
5994  for (ObjCObjectPointerType::qual_iterator I = lhsQID->qual_begin(),
5995       E = lhsQID->qual_end(); I != E; ++I) {
5996    bool match = false;
5997    ObjCProtocolDecl *lhsProto = *I;
5998    for (ObjCObjectPointerType::qual_iterator J = rhsOPT->qual_begin(),
5999         E = rhsOPT->qual_end(); J != E; ++J) {
6000      ObjCProtocolDecl *rhsProto = *J;
6001      if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto)) {
6002        match = true;
6003        break;
6004      }
6005    }
6006    if (!match)
6007      return false;
6008  }
6009  return true;
6010}
6011
6012/// ObjCQualifiedIdTypesAreCompatible - We know that one of lhs/rhs is an
6013/// ObjCQualifiedIDType.
6014bool ASTContext::ObjCQualifiedIdTypesAreCompatible(QualType lhs, QualType rhs,
6015                                                   bool compare) {
6016  // Allow id<P..> and an 'id' or void* type in all cases.
6017  if (lhs->isVoidPointerType() ||
6018      lhs->isObjCIdType() || lhs->isObjCClassType())
6019    return true;
6020  else if (rhs->isVoidPointerType() ||
6021           rhs->isObjCIdType() || rhs->isObjCClassType())
6022    return true;
6023
6024  if (const ObjCObjectPointerType *lhsQID = lhs->getAsObjCQualifiedIdType()) {
6025    const ObjCObjectPointerType *rhsOPT = rhs->getAs<ObjCObjectPointerType>();
6026
6027    if (!rhsOPT) return false;
6028
6029    if (rhsOPT->qual_empty()) {
6030      // If the RHS is a unqualified interface pointer "NSString*",
6031      // make sure we check the class hierarchy.
6032      if (ObjCInterfaceDecl *rhsID = rhsOPT->getInterfaceDecl()) {
6033        for (ObjCObjectPointerType::qual_iterator I = lhsQID->qual_begin(),
6034             E = lhsQID->qual_end(); I != E; ++I) {
6035          // when comparing an id<P> on lhs with a static type on rhs,
6036          // see if static class implements all of id's protocols, directly or
6037          // through its super class and categories.
6038          if (!rhsID->ClassImplementsProtocol(*I, true))
6039            return false;
6040        }
6041      }
6042      // If there are no qualifiers and no interface, we have an 'id'.
6043      return true;
6044    }
6045    // Both the right and left sides have qualifiers.
6046    for (ObjCObjectPointerType::qual_iterator I = lhsQID->qual_begin(),
6047         E = lhsQID->qual_end(); I != E; ++I) {
6048      ObjCProtocolDecl *lhsProto = *I;
6049      bool match = false;
6050
6051      // when comparing an id<P> on lhs with a static type on rhs,
6052      // see if static class implements all of id's protocols, directly or
6053      // through its super class and categories.
6054      for (ObjCObjectPointerType::qual_iterator J = rhsOPT->qual_begin(),
6055           E = rhsOPT->qual_end(); J != E; ++J) {
6056        ObjCProtocolDecl *rhsProto = *J;
6057        if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto) ||
6058            (compare && ProtocolCompatibleWithProtocol(rhsProto, lhsProto))) {
6059          match = true;
6060          break;
6061        }
6062      }
6063      // If the RHS is a qualified interface pointer "NSString<P>*",
6064      // make sure we check the class hierarchy.
6065      if (ObjCInterfaceDecl *rhsID = rhsOPT->getInterfaceDecl()) {
6066        for (ObjCObjectPointerType::qual_iterator I = lhsQID->qual_begin(),
6067             E = lhsQID->qual_end(); I != E; ++I) {
6068          // when comparing an id<P> on lhs with a static type on rhs,
6069          // see if static class implements all of id's protocols, directly or
6070          // through its super class and categories.
6071          if (rhsID->ClassImplementsProtocol(*I, true)) {
6072            match = true;
6073            break;
6074          }
6075        }
6076      }
6077      if (!match)
6078        return false;
6079    }
6080
6081    return true;
6082  }
6083
6084  const ObjCObjectPointerType *rhsQID = rhs->getAsObjCQualifiedIdType();
6085  assert(rhsQID && "One of the LHS/RHS should be id<x>");
6086
6087  if (const ObjCObjectPointerType *lhsOPT =
6088        lhs->getAsObjCInterfacePointerType()) {
6089    // If both the right and left sides have qualifiers.
6090    for (ObjCObjectPointerType::qual_iterator I = lhsOPT->qual_begin(),
6091         E = lhsOPT->qual_end(); I != E; ++I) {
6092      ObjCProtocolDecl *lhsProto = *I;
6093      bool match = false;
6094
6095      // when comparing an id<P> on rhs with a static type on lhs,
6096      // see if static class implements all of id's protocols, directly or
6097      // through its super class and categories.
6098      // First, lhs protocols in the qualifier list must be found, direct
6099      // or indirect in rhs's qualifier list or it is a mismatch.
6100      for (ObjCObjectPointerType::qual_iterator J = rhsQID->qual_begin(),
6101           E = rhsQID->qual_end(); J != E; ++J) {
6102        ObjCProtocolDecl *rhsProto = *J;
6103        if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto) ||
6104            (compare && ProtocolCompatibleWithProtocol(rhsProto, lhsProto))) {
6105          match = true;
6106          break;
6107        }
6108      }
6109      if (!match)
6110        return false;
6111    }
6112
6113    // Static class's protocols, or its super class or category protocols
6114    // must be found, direct or indirect in rhs's qualifier list or it is a mismatch.
6115    if (ObjCInterfaceDecl *lhsID = lhsOPT->getInterfaceDecl()) {
6116      llvm::SmallPtrSet<ObjCProtocolDecl *, 8> LHSInheritedProtocols;
6117      CollectInheritedProtocols(lhsID, LHSInheritedProtocols);
6118      // This is rather dubious but matches gcc's behavior. If lhs has
6119      // no type qualifier and its class has no static protocol(s)
6120      // assume that it is mismatch.
6121      if (LHSInheritedProtocols.empty() && lhsOPT->qual_empty())
6122        return false;
6123      for (llvm::SmallPtrSet<ObjCProtocolDecl*,8>::iterator I =
6124           LHSInheritedProtocols.begin(),
6125           E = LHSInheritedProtocols.end(); I != E; ++I) {
6126        bool match = false;
6127        ObjCProtocolDecl *lhsProto = (*I);
6128        for (ObjCObjectPointerType::qual_iterator J = rhsQID->qual_begin(),
6129             E = rhsQID->qual_end(); J != E; ++J) {
6130          ObjCProtocolDecl *rhsProto = *J;
6131          if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto) ||
6132              (compare && ProtocolCompatibleWithProtocol(rhsProto, lhsProto))) {
6133            match = true;
6134            break;
6135          }
6136        }
6137        if (!match)
6138          return false;
6139      }
6140    }
6141    return true;
6142  }
6143  return false;
6144}
6145
6146/// canAssignObjCInterfaces - Return true if the two interface types are
6147/// compatible for assignment from RHS to LHS.  This handles validation of any
6148/// protocol qualifiers on the LHS or RHS.
6149///
6150bool ASTContext::canAssignObjCInterfaces(const ObjCObjectPointerType *LHSOPT,
6151                                         const ObjCObjectPointerType *RHSOPT) {
6152  const ObjCObjectType* LHS = LHSOPT->getObjectType();
6153  const ObjCObjectType* RHS = RHSOPT->getObjectType();
6154
6155  // If either type represents the built-in 'id' or 'Class' types, return true.
6156  if (LHS->isObjCUnqualifiedIdOrClass() ||
6157      RHS->isObjCUnqualifiedIdOrClass())
6158    return true;
6159
6160  if (LHS->isObjCQualifiedId() || RHS->isObjCQualifiedId())
6161    return ObjCQualifiedIdTypesAreCompatible(QualType(LHSOPT,0),
6162                                             QualType(RHSOPT,0),
6163                                             false);
6164
6165  if (LHS->isObjCQualifiedClass() && RHS->isObjCQualifiedClass())
6166    return ObjCQualifiedClassTypesAreCompatible(QualType(LHSOPT,0),
6167                                                QualType(RHSOPT,0));
6168
6169  // If we have 2 user-defined types, fall into that path.
6170  if (LHS->getInterface() && RHS->getInterface())
6171    return canAssignObjCInterfaces(LHS, RHS);
6172
6173  return false;
6174}
6175
6176/// canAssignObjCInterfacesInBlockPointer - This routine is specifically written
6177/// for providing type-safety for objective-c pointers used to pass/return
6178/// arguments in block literals. When passed as arguments, passing 'A*' where
6179/// 'id' is expected is not OK. Passing 'Sub *" where 'Super *" is expected is
6180/// not OK. For the return type, the opposite is not OK.
6181bool ASTContext::canAssignObjCInterfacesInBlockPointer(
6182                                         const ObjCObjectPointerType *LHSOPT,
6183                                         const ObjCObjectPointerType *RHSOPT,
6184                                         bool BlockReturnType) {
6185  if (RHSOPT->isObjCBuiltinType() || LHSOPT->isObjCIdType())
6186    return true;
6187
6188  if (LHSOPT->isObjCBuiltinType()) {
6189    return RHSOPT->isObjCBuiltinType() || RHSOPT->isObjCQualifiedIdType();
6190  }
6191
6192  if (LHSOPT->isObjCQualifiedIdType() || RHSOPT->isObjCQualifiedIdType())
6193    return ObjCQualifiedIdTypesAreCompatible(QualType(LHSOPT,0),
6194                                             QualType(RHSOPT,0),
6195                                             false);
6196
6197  const ObjCInterfaceType* LHS = LHSOPT->getInterfaceType();
6198  const ObjCInterfaceType* RHS = RHSOPT->getInterfaceType();
6199  if (LHS && RHS)  { // We have 2 user-defined types.
6200    if (LHS != RHS) {
6201      if (LHS->getDecl()->isSuperClassOf(RHS->getDecl()))
6202        return BlockReturnType;
6203      if (RHS->getDecl()->isSuperClassOf(LHS->getDecl()))
6204        return !BlockReturnType;
6205    }
6206    else
6207      return true;
6208  }
6209  return false;
6210}
6211
6212/// getIntersectionOfProtocols - This routine finds the intersection of set
6213/// of protocols inherited from two distinct objective-c pointer objects.
6214/// It is used to build composite qualifier list of the composite type of
6215/// the conditional expression involving two objective-c pointer objects.
6216static
6217void getIntersectionOfProtocols(ASTContext &Context,
6218                                const ObjCObjectPointerType *LHSOPT,
6219                                const ObjCObjectPointerType *RHSOPT,
6220      SmallVectorImpl<ObjCProtocolDecl *> &IntersectionOfProtocols) {
6221
6222  const ObjCObjectType* LHS = LHSOPT->getObjectType();
6223  const ObjCObjectType* RHS = RHSOPT->getObjectType();
6224  assert(LHS->getInterface() && "LHS must have an interface base");
6225  assert(RHS->getInterface() && "RHS must have an interface base");
6226
6227  llvm::SmallPtrSet<ObjCProtocolDecl *, 8> InheritedProtocolSet;
6228  unsigned LHSNumProtocols = LHS->getNumProtocols();
6229  if (LHSNumProtocols > 0)
6230    InheritedProtocolSet.insert(LHS->qual_begin(), LHS->qual_end());
6231  else {
6232    llvm::SmallPtrSet<ObjCProtocolDecl *, 8> LHSInheritedProtocols;
6233    Context.CollectInheritedProtocols(LHS->getInterface(),
6234                                      LHSInheritedProtocols);
6235    InheritedProtocolSet.insert(LHSInheritedProtocols.begin(),
6236                                LHSInheritedProtocols.end());
6237  }
6238
6239  unsigned RHSNumProtocols = RHS->getNumProtocols();
6240  if (RHSNumProtocols > 0) {
6241    ObjCProtocolDecl **RHSProtocols =
6242      const_cast<ObjCProtocolDecl **>(RHS->qual_begin());
6243    for (unsigned i = 0; i < RHSNumProtocols; ++i)
6244      if (InheritedProtocolSet.count(RHSProtocols[i]))
6245        IntersectionOfProtocols.push_back(RHSProtocols[i]);
6246  } else {
6247    llvm::SmallPtrSet<ObjCProtocolDecl *, 8> RHSInheritedProtocols;
6248    Context.CollectInheritedProtocols(RHS->getInterface(),
6249                                      RHSInheritedProtocols);
6250    for (llvm::SmallPtrSet<ObjCProtocolDecl*,8>::iterator I =
6251         RHSInheritedProtocols.begin(),
6252         E = RHSInheritedProtocols.end(); I != E; ++I)
6253      if (InheritedProtocolSet.count((*I)))
6254        IntersectionOfProtocols.push_back((*I));
6255  }
6256}
6257
6258/// areCommonBaseCompatible - Returns common base class of the two classes if
6259/// one found. Note that this is O'2 algorithm. But it will be called as the
6260/// last type comparison in a ?-exp of ObjC pointer types before a
6261/// warning is issued. So, its invokation is extremely rare.
6262QualType ASTContext::areCommonBaseCompatible(
6263                                          const ObjCObjectPointerType *Lptr,
6264                                          const ObjCObjectPointerType *Rptr) {
6265  const ObjCObjectType *LHS = Lptr->getObjectType();
6266  const ObjCObjectType *RHS = Rptr->getObjectType();
6267  const ObjCInterfaceDecl* LDecl = LHS->getInterface();
6268  const ObjCInterfaceDecl* RDecl = RHS->getInterface();
6269  if (!LDecl || !RDecl || (declaresSameEntity(LDecl, RDecl)))
6270    return QualType();
6271
6272  do {
6273    LHS = cast<ObjCInterfaceType>(getObjCInterfaceType(LDecl));
6274    if (canAssignObjCInterfaces(LHS, RHS)) {
6275      SmallVector<ObjCProtocolDecl *, 8> Protocols;
6276      getIntersectionOfProtocols(*this, Lptr, Rptr, Protocols);
6277
6278      QualType Result = QualType(LHS, 0);
6279      if (!Protocols.empty())
6280        Result = getObjCObjectType(Result, Protocols.data(), Protocols.size());
6281      Result = getObjCObjectPointerType(Result);
6282      return Result;
6283    }
6284  } while ((LDecl = LDecl->getSuperClass()));
6285
6286  return QualType();
6287}
6288
6289bool ASTContext::canAssignObjCInterfaces(const ObjCObjectType *LHS,
6290                                         const ObjCObjectType *RHS) {
6291  assert(LHS->getInterface() && "LHS is not an interface type");
6292  assert(RHS->getInterface() && "RHS is not an interface type");
6293
6294  // Verify that the base decls are compatible: the RHS must be a subclass of
6295  // the LHS.
6296  if (!LHS->getInterface()->isSuperClassOf(RHS->getInterface()))
6297    return false;
6298
6299  // RHS must have a superset of the protocols in the LHS.  If the LHS is not
6300  // protocol qualified at all, then we are good.
6301  if (LHS->getNumProtocols() == 0)
6302    return true;
6303
6304  // Okay, we know the LHS has protocol qualifiers.  If the RHS doesn't,
6305  // more detailed analysis is required.
6306  if (RHS->getNumProtocols() == 0) {
6307    // OK, if LHS is a superclass of RHS *and*
6308    // this superclass is assignment compatible with LHS.
6309    // false otherwise.
6310    bool IsSuperClass =
6311      LHS->getInterface()->isSuperClassOf(RHS->getInterface());
6312    if (IsSuperClass) {
6313      // OK if conversion of LHS to SuperClass results in narrowing of types
6314      // ; i.e., SuperClass may implement at least one of the protocols
6315      // in LHS's protocol list. Example, SuperObj<P1> = lhs<P1,P2> is ok.
6316      // But not SuperObj<P1,P2,P3> = lhs<P1,P2>.
6317      llvm::SmallPtrSet<ObjCProtocolDecl *, 8> SuperClassInheritedProtocols;
6318      CollectInheritedProtocols(RHS->getInterface(), SuperClassInheritedProtocols);
6319      // If super class has no protocols, it is not a match.
6320      if (SuperClassInheritedProtocols.empty())
6321        return false;
6322
6323      for (ObjCObjectType::qual_iterator LHSPI = LHS->qual_begin(),
6324           LHSPE = LHS->qual_end();
6325           LHSPI != LHSPE; LHSPI++) {
6326        bool SuperImplementsProtocol = false;
6327        ObjCProtocolDecl *LHSProto = (*LHSPI);
6328
6329        for (llvm::SmallPtrSet<ObjCProtocolDecl*,8>::iterator I =
6330             SuperClassInheritedProtocols.begin(),
6331             E = SuperClassInheritedProtocols.end(); I != E; ++I) {
6332          ObjCProtocolDecl *SuperClassProto = (*I);
6333          if (SuperClassProto->lookupProtocolNamed(LHSProto->getIdentifier())) {
6334            SuperImplementsProtocol = true;
6335            break;
6336          }
6337        }
6338        if (!SuperImplementsProtocol)
6339          return false;
6340      }
6341      return true;
6342    }
6343    return false;
6344  }
6345
6346  for (ObjCObjectType::qual_iterator LHSPI = LHS->qual_begin(),
6347                                     LHSPE = LHS->qual_end();
6348       LHSPI != LHSPE; LHSPI++) {
6349    bool RHSImplementsProtocol = false;
6350
6351    // If the RHS doesn't implement the protocol on the left, the types
6352    // are incompatible.
6353    for (ObjCObjectType::qual_iterator RHSPI = RHS->qual_begin(),
6354                                       RHSPE = RHS->qual_end();
6355         RHSPI != RHSPE; RHSPI++) {
6356      if ((*RHSPI)->lookupProtocolNamed((*LHSPI)->getIdentifier())) {
6357        RHSImplementsProtocol = true;
6358        break;
6359      }
6360    }
6361    // FIXME: For better diagnostics, consider passing back the protocol name.
6362    if (!RHSImplementsProtocol)
6363      return false;
6364  }
6365  // The RHS implements all protocols listed on the LHS.
6366  return true;
6367}
6368
6369bool ASTContext::areComparableObjCPointerTypes(QualType LHS, QualType RHS) {
6370  // get the "pointed to" types
6371  const ObjCObjectPointerType *LHSOPT = LHS->getAs<ObjCObjectPointerType>();
6372  const ObjCObjectPointerType *RHSOPT = RHS->getAs<ObjCObjectPointerType>();
6373
6374  if (!LHSOPT || !RHSOPT)
6375    return false;
6376
6377  return canAssignObjCInterfaces(LHSOPT, RHSOPT) ||
6378         canAssignObjCInterfaces(RHSOPT, LHSOPT);
6379}
6380
6381bool ASTContext::canBindObjCObjectType(QualType To, QualType From) {
6382  return canAssignObjCInterfaces(
6383                getObjCObjectPointerType(To)->getAs<ObjCObjectPointerType>(),
6384                getObjCObjectPointerType(From)->getAs<ObjCObjectPointerType>());
6385}
6386
6387/// typesAreCompatible - C99 6.7.3p9: For two qualified types to be compatible,
6388/// both shall have the identically qualified version of a compatible type.
6389/// C99 6.2.7p1: Two types have compatible types if their types are the
6390/// same. See 6.7.[2,3,5] for additional rules.
6391bool ASTContext::typesAreCompatible(QualType LHS, QualType RHS,
6392                                    bool CompareUnqualified) {
6393  if (getLangOpts().CPlusPlus)
6394    return hasSameType(LHS, RHS);
6395
6396  return !mergeTypes(LHS, RHS, false, CompareUnqualified).isNull();
6397}
6398
6399bool ASTContext::propertyTypesAreCompatible(QualType LHS, QualType RHS) {
6400  return typesAreCompatible(LHS, RHS);
6401}
6402
6403bool ASTContext::typesAreBlockPointerCompatible(QualType LHS, QualType RHS) {
6404  return !mergeTypes(LHS, RHS, true).isNull();
6405}
6406
6407/// mergeTransparentUnionType - if T is a transparent union type and a member
6408/// of T is compatible with SubType, return the merged type, else return
6409/// QualType()
6410QualType ASTContext::mergeTransparentUnionType(QualType T, QualType SubType,
6411                                               bool OfBlockPointer,
6412                                               bool Unqualified) {
6413  if (const RecordType *UT = T->getAsUnionType()) {
6414    RecordDecl *UD = UT->getDecl();
6415    if (UD->hasAttr<TransparentUnionAttr>()) {
6416      for (RecordDecl::field_iterator it = UD->field_begin(),
6417           itend = UD->field_end(); it != itend; ++it) {
6418        QualType ET = it->getType().getUnqualifiedType();
6419        QualType MT = mergeTypes(ET, SubType, OfBlockPointer, Unqualified);
6420        if (!MT.isNull())
6421          return MT;
6422      }
6423    }
6424  }
6425
6426  return QualType();
6427}
6428
6429/// mergeFunctionArgumentTypes - merge two types which appear as function
6430/// argument types
6431QualType ASTContext::mergeFunctionArgumentTypes(QualType lhs, QualType rhs,
6432                                                bool OfBlockPointer,
6433                                                bool Unqualified) {
6434  // GNU extension: two types are compatible if they appear as a function
6435  // argument, one of the types is a transparent union type and the other
6436  // type is compatible with a union member
6437  QualType lmerge = mergeTransparentUnionType(lhs, rhs, OfBlockPointer,
6438                                              Unqualified);
6439  if (!lmerge.isNull())
6440    return lmerge;
6441
6442  QualType rmerge = mergeTransparentUnionType(rhs, lhs, OfBlockPointer,
6443                                              Unqualified);
6444  if (!rmerge.isNull())
6445    return rmerge;
6446
6447  return mergeTypes(lhs, rhs, OfBlockPointer, Unqualified);
6448}
6449
6450QualType ASTContext::mergeFunctionTypes(QualType lhs, QualType rhs,
6451                                        bool OfBlockPointer,
6452                                        bool Unqualified) {
6453  const FunctionType *lbase = lhs->getAs<FunctionType>();
6454  const FunctionType *rbase = rhs->getAs<FunctionType>();
6455  const FunctionProtoType *lproto = dyn_cast<FunctionProtoType>(lbase);
6456  const FunctionProtoType *rproto = dyn_cast<FunctionProtoType>(rbase);
6457  bool allLTypes = true;
6458  bool allRTypes = true;
6459
6460  // Check return type
6461  QualType retType;
6462  if (OfBlockPointer) {
6463    QualType RHS = rbase->getResultType();
6464    QualType LHS = lbase->getResultType();
6465    bool UnqualifiedResult = Unqualified;
6466    if (!UnqualifiedResult)
6467      UnqualifiedResult = (!RHS.hasQualifiers() && LHS.hasQualifiers());
6468    retType = mergeTypes(LHS, RHS, true, UnqualifiedResult, true);
6469  }
6470  else
6471    retType = mergeTypes(lbase->getResultType(), rbase->getResultType(), false,
6472                         Unqualified);
6473  if (retType.isNull()) return QualType();
6474
6475  if (Unqualified)
6476    retType = retType.getUnqualifiedType();
6477
6478  CanQualType LRetType = getCanonicalType(lbase->getResultType());
6479  CanQualType RRetType = getCanonicalType(rbase->getResultType());
6480  if (Unqualified) {
6481    LRetType = LRetType.getUnqualifiedType();
6482    RRetType = RRetType.getUnqualifiedType();
6483  }
6484
6485  if (getCanonicalType(retType) != LRetType)
6486    allLTypes = false;
6487  if (getCanonicalType(retType) != RRetType)
6488    allRTypes = false;
6489
6490  // FIXME: double check this
6491  // FIXME: should we error if lbase->getRegParmAttr() != 0 &&
6492  //                           rbase->getRegParmAttr() != 0 &&
6493  //                           lbase->getRegParmAttr() != rbase->getRegParmAttr()?
6494  FunctionType::ExtInfo lbaseInfo = lbase->getExtInfo();
6495  FunctionType::ExtInfo rbaseInfo = rbase->getExtInfo();
6496
6497  // Compatible functions must have compatible calling conventions
6498  if (!isSameCallConv(lbaseInfo.getCC(), rbaseInfo.getCC()))
6499    return QualType();
6500
6501  // Regparm is part of the calling convention.
6502  if (lbaseInfo.getHasRegParm() != rbaseInfo.getHasRegParm())
6503    return QualType();
6504  if (lbaseInfo.getRegParm() != rbaseInfo.getRegParm())
6505    return QualType();
6506
6507  if (lbaseInfo.getProducesResult() != rbaseInfo.getProducesResult())
6508    return QualType();
6509
6510  // FIXME: some uses, e.g. conditional exprs, really want this to be 'both'.
6511  bool NoReturn = lbaseInfo.getNoReturn() || rbaseInfo.getNoReturn();
6512
6513  if (lbaseInfo.getNoReturn() != NoReturn)
6514    allLTypes = false;
6515  if (rbaseInfo.getNoReturn() != NoReturn)
6516    allRTypes = false;
6517
6518  FunctionType::ExtInfo einfo = lbaseInfo.withNoReturn(NoReturn);
6519
6520  if (lproto && rproto) { // two C99 style function prototypes
6521    assert(!lproto->hasExceptionSpec() && !rproto->hasExceptionSpec() &&
6522           "C++ shouldn't be here");
6523    unsigned lproto_nargs = lproto->getNumArgs();
6524    unsigned rproto_nargs = rproto->getNumArgs();
6525
6526    // Compatible functions must have the same number of arguments
6527    if (lproto_nargs != rproto_nargs)
6528      return QualType();
6529
6530    // Variadic and non-variadic functions aren't compatible
6531    if (lproto->isVariadic() != rproto->isVariadic())
6532      return QualType();
6533
6534    if (lproto->getTypeQuals() != rproto->getTypeQuals())
6535      return QualType();
6536
6537    if (LangOpts.ObjCAutoRefCount &&
6538        !FunctionTypesMatchOnNSConsumedAttrs(rproto, lproto))
6539      return QualType();
6540
6541    // Check argument compatibility
6542    SmallVector<QualType, 10> types;
6543    for (unsigned i = 0; i < lproto_nargs; i++) {
6544      QualType largtype = lproto->getArgType(i).getUnqualifiedType();
6545      QualType rargtype = rproto->getArgType(i).getUnqualifiedType();
6546      QualType argtype = mergeFunctionArgumentTypes(largtype, rargtype,
6547                                                    OfBlockPointer,
6548                                                    Unqualified);
6549      if (argtype.isNull()) return QualType();
6550
6551      if (Unqualified)
6552        argtype = argtype.getUnqualifiedType();
6553
6554      types.push_back(argtype);
6555      if (Unqualified) {
6556        largtype = largtype.getUnqualifiedType();
6557        rargtype = rargtype.getUnqualifiedType();
6558      }
6559
6560      if (getCanonicalType(argtype) != getCanonicalType(largtype))
6561        allLTypes = false;
6562      if (getCanonicalType(argtype) != getCanonicalType(rargtype))
6563        allRTypes = false;
6564    }
6565
6566    if (allLTypes) return lhs;
6567    if (allRTypes) return rhs;
6568
6569    FunctionProtoType::ExtProtoInfo EPI = lproto->getExtProtoInfo();
6570    EPI.ExtInfo = einfo;
6571    return getFunctionType(retType, types.begin(), types.size(), EPI);
6572  }
6573
6574  if (lproto) allRTypes = false;
6575  if (rproto) allLTypes = false;
6576
6577  const FunctionProtoType *proto = lproto ? lproto : rproto;
6578  if (proto) {
6579    assert(!proto->hasExceptionSpec() && "C++ shouldn't be here");
6580    if (proto->isVariadic()) return QualType();
6581    // Check that the types are compatible with the types that
6582    // would result from default argument promotions (C99 6.7.5.3p15).
6583    // The only types actually affected are promotable integer
6584    // types and floats, which would be passed as a different
6585    // type depending on whether the prototype is visible.
6586    unsigned proto_nargs = proto->getNumArgs();
6587    for (unsigned i = 0; i < proto_nargs; ++i) {
6588      QualType argTy = proto->getArgType(i);
6589
6590      // Look at the converted type of enum types, since that is the type used
6591      // to pass enum values.
6592      if (const EnumType *Enum = argTy->getAs<EnumType>()) {
6593        argTy = Enum->getDecl()->getIntegerType();
6594        if (argTy.isNull())
6595          return QualType();
6596      }
6597
6598      if (argTy->isPromotableIntegerType() ||
6599          getCanonicalType(argTy).getUnqualifiedType() == FloatTy)
6600        return QualType();
6601    }
6602
6603    if (allLTypes) return lhs;
6604    if (allRTypes) return rhs;
6605
6606    FunctionProtoType::ExtProtoInfo EPI = proto->getExtProtoInfo();
6607    EPI.ExtInfo = einfo;
6608    return getFunctionType(retType, proto->arg_type_begin(),
6609                           proto->getNumArgs(), EPI);
6610  }
6611
6612  if (allLTypes) return lhs;
6613  if (allRTypes) return rhs;
6614  return getFunctionNoProtoType(retType, einfo);
6615}
6616
6617QualType ASTContext::mergeTypes(QualType LHS, QualType RHS,
6618                                bool OfBlockPointer,
6619                                bool Unqualified, bool BlockReturnType) {
6620  // C++ [expr]: If an expression initially has the type "reference to T", the
6621  // type is adjusted to "T" prior to any further analysis, the expression
6622  // designates the object or function denoted by the reference, and the
6623  // expression is an lvalue unless the reference is an rvalue reference and
6624  // the expression is a function call (possibly inside parentheses).
6625  assert(!LHS->getAs<ReferenceType>() && "LHS is a reference type?");
6626  assert(!RHS->getAs<ReferenceType>() && "RHS is a reference type?");
6627
6628  if (Unqualified) {
6629    LHS = LHS.getUnqualifiedType();
6630    RHS = RHS.getUnqualifiedType();
6631  }
6632
6633  QualType LHSCan = getCanonicalType(LHS),
6634           RHSCan = getCanonicalType(RHS);
6635
6636  // If two types are identical, they are compatible.
6637  if (LHSCan == RHSCan)
6638    return LHS;
6639
6640  // If the qualifiers are different, the types aren't compatible... mostly.
6641  Qualifiers LQuals = LHSCan.getLocalQualifiers();
6642  Qualifiers RQuals = RHSCan.getLocalQualifiers();
6643  if (LQuals != RQuals) {
6644    // If any of these qualifiers are different, we have a type
6645    // mismatch.
6646    if (LQuals.getCVRQualifiers() != RQuals.getCVRQualifiers() ||
6647        LQuals.getAddressSpace() != RQuals.getAddressSpace() ||
6648        LQuals.getObjCLifetime() != RQuals.getObjCLifetime())
6649      return QualType();
6650
6651    // Exactly one GC qualifier difference is allowed: __strong is
6652    // okay if the other type has no GC qualifier but is an Objective
6653    // C object pointer (i.e. implicitly strong by default).  We fix
6654    // this by pretending that the unqualified type was actually
6655    // qualified __strong.
6656    Qualifiers::GC GC_L = LQuals.getObjCGCAttr();
6657    Qualifiers::GC GC_R = RQuals.getObjCGCAttr();
6658    assert((GC_L != GC_R) && "unequal qualifier sets had only equal elements");
6659
6660    if (GC_L == Qualifiers::Weak || GC_R == Qualifiers::Weak)
6661      return QualType();
6662
6663    if (GC_L == Qualifiers::Strong && RHSCan->isObjCObjectPointerType()) {
6664      return mergeTypes(LHS, getObjCGCQualType(RHS, Qualifiers::Strong));
6665    }
6666    if (GC_R == Qualifiers::Strong && LHSCan->isObjCObjectPointerType()) {
6667      return mergeTypes(getObjCGCQualType(LHS, Qualifiers::Strong), RHS);
6668    }
6669    return QualType();
6670  }
6671
6672  // Okay, qualifiers are equal.
6673
6674  Type::TypeClass LHSClass = LHSCan->getTypeClass();
6675  Type::TypeClass RHSClass = RHSCan->getTypeClass();
6676
6677  // We want to consider the two function types to be the same for these
6678  // comparisons, just force one to the other.
6679  if (LHSClass == Type::FunctionProto) LHSClass = Type::FunctionNoProto;
6680  if (RHSClass == Type::FunctionProto) RHSClass = Type::FunctionNoProto;
6681
6682  // Same as above for arrays
6683  if (LHSClass == Type::VariableArray || LHSClass == Type::IncompleteArray)
6684    LHSClass = Type::ConstantArray;
6685  if (RHSClass == Type::VariableArray || RHSClass == Type::IncompleteArray)
6686    RHSClass = Type::ConstantArray;
6687
6688  // ObjCInterfaces are just specialized ObjCObjects.
6689  if (LHSClass == Type::ObjCInterface) LHSClass = Type::ObjCObject;
6690  if (RHSClass == Type::ObjCInterface) RHSClass = Type::ObjCObject;
6691
6692  // Canonicalize ExtVector -> Vector.
6693  if (LHSClass == Type::ExtVector) LHSClass = Type::Vector;
6694  if (RHSClass == Type::ExtVector) RHSClass = Type::Vector;
6695
6696  // If the canonical type classes don't match.
6697  if (LHSClass != RHSClass) {
6698    // C99 6.7.2.2p4: Each enumerated type shall be compatible with char,
6699    // a signed integer type, or an unsigned integer type.
6700    // Compatibility is based on the underlying type, not the promotion
6701    // type.
6702    if (const EnumType* ETy = LHS->getAs<EnumType>()) {
6703      QualType TINT = ETy->getDecl()->getIntegerType();
6704      if (!TINT.isNull() && hasSameType(TINT, RHSCan.getUnqualifiedType()))
6705        return RHS;
6706    }
6707    if (const EnumType* ETy = RHS->getAs<EnumType>()) {
6708      QualType TINT = ETy->getDecl()->getIntegerType();
6709      if (!TINT.isNull() && hasSameType(TINT, LHSCan.getUnqualifiedType()))
6710        return LHS;
6711    }
6712    // allow block pointer type to match an 'id' type.
6713    if (OfBlockPointer && !BlockReturnType) {
6714       if (LHS->isObjCIdType() && RHS->isBlockPointerType())
6715         return LHS;
6716      if (RHS->isObjCIdType() && LHS->isBlockPointerType())
6717        return RHS;
6718    }
6719
6720    return QualType();
6721  }
6722
6723  // The canonical type classes match.
6724  switch (LHSClass) {
6725#define TYPE(Class, Base)
6726#define ABSTRACT_TYPE(Class, Base)
6727#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base) case Type::Class:
6728#define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
6729#define DEPENDENT_TYPE(Class, Base) case Type::Class:
6730#include "clang/AST/TypeNodes.def"
6731    llvm_unreachable("Non-canonical and dependent types shouldn't get here");
6732
6733  case Type::LValueReference:
6734  case Type::RValueReference:
6735  case Type::MemberPointer:
6736    llvm_unreachable("C++ should never be in mergeTypes");
6737
6738  case Type::ObjCInterface:
6739  case Type::IncompleteArray:
6740  case Type::VariableArray:
6741  case Type::FunctionProto:
6742  case Type::ExtVector:
6743    llvm_unreachable("Types are eliminated above");
6744
6745  case Type::Pointer:
6746  {
6747    // Merge two pointer types, while trying to preserve typedef info
6748    QualType LHSPointee = LHS->getAs<PointerType>()->getPointeeType();
6749    QualType RHSPointee = RHS->getAs<PointerType>()->getPointeeType();
6750    if (Unqualified) {
6751      LHSPointee = LHSPointee.getUnqualifiedType();
6752      RHSPointee = RHSPointee.getUnqualifiedType();
6753    }
6754    QualType ResultType = mergeTypes(LHSPointee, RHSPointee, false,
6755                                     Unqualified);
6756    if (ResultType.isNull()) return QualType();
6757    if (getCanonicalType(LHSPointee) == getCanonicalType(ResultType))
6758      return LHS;
6759    if (getCanonicalType(RHSPointee) == getCanonicalType(ResultType))
6760      return RHS;
6761    return getPointerType(ResultType);
6762  }
6763  case Type::BlockPointer:
6764  {
6765    // Merge two block pointer types, while trying to preserve typedef info
6766    QualType LHSPointee = LHS->getAs<BlockPointerType>()->getPointeeType();
6767    QualType RHSPointee = RHS->getAs<BlockPointerType>()->getPointeeType();
6768    if (Unqualified) {
6769      LHSPointee = LHSPointee.getUnqualifiedType();
6770      RHSPointee = RHSPointee.getUnqualifiedType();
6771    }
6772    QualType ResultType = mergeTypes(LHSPointee, RHSPointee, OfBlockPointer,
6773                                     Unqualified);
6774    if (ResultType.isNull()) return QualType();
6775    if (getCanonicalType(LHSPointee) == getCanonicalType(ResultType))
6776      return LHS;
6777    if (getCanonicalType(RHSPointee) == getCanonicalType(ResultType))
6778      return RHS;
6779    return getBlockPointerType(ResultType);
6780  }
6781  case Type::Atomic:
6782  {
6783    // Merge two pointer types, while trying to preserve typedef info
6784    QualType LHSValue = LHS->getAs<AtomicType>()->getValueType();
6785    QualType RHSValue = RHS->getAs<AtomicType>()->getValueType();
6786    if (Unqualified) {
6787      LHSValue = LHSValue.getUnqualifiedType();
6788      RHSValue = RHSValue.getUnqualifiedType();
6789    }
6790    QualType ResultType = mergeTypes(LHSValue, RHSValue, false,
6791                                     Unqualified);
6792    if (ResultType.isNull()) return QualType();
6793    if (getCanonicalType(LHSValue) == getCanonicalType(ResultType))
6794      return LHS;
6795    if (getCanonicalType(RHSValue) == getCanonicalType(ResultType))
6796      return RHS;
6797    return getAtomicType(ResultType);
6798  }
6799  case Type::ConstantArray:
6800  {
6801    const ConstantArrayType* LCAT = getAsConstantArrayType(LHS);
6802    const ConstantArrayType* RCAT = getAsConstantArrayType(RHS);
6803    if (LCAT && RCAT && RCAT->getSize() != LCAT->getSize())
6804      return QualType();
6805
6806    QualType LHSElem = getAsArrayType(LHS)->getElementType();
6807    QualType RHSElem = getAsArrayType(RHS)->getElementType();
6808    if (Unqualified) {
6809      LHSElem = LHSElem.getUnqualifiedType();
6810      RHSElem = RHSElem.getUnqualifiedType();
6811    }
6812
6813    QualType ResultType = mergeTypes(LHSElem, RHSElem, false, Unqualified);
6814    if (ResultType.isNull()) return QualType();
6815    if (LCAT && getCanonicalType(LHSElem) == getCanonicalType(ResultType))
6816      return LHS;
6817    if (RCAT && getCanonicalType(RHSElem) == getCanonicalType(ResultType))
6818      return RHS;
6819    if (LCAT) return getConstantArrayType(ResultType, LCAT->getSize(),
6820                                          ArrayType::ArraySizeModifier(), 0);
6821    if (RCAT) return getConstantArrayType(ResultType, RCAT->getSize(),
6822                                          ArrayType::ArraySizeModifier(), 0);
6823    const VariableArrayType* LVAT = getAsVariableArrayType(LHS);
6824    const VariableArrayType* RVAT = getAsVariableArrayType(RHS);
6825    if (LVAT && getCanonicalType(LHSElem) == getCanonicalType(ResultType))
6826      return LHS;
6827    if (RVAT && getCanonicalType(RHSElem) == getCanonicalType(ResultType))
6828      return RHS;
6829    if (LVAT) {
6830      // FIXME: This isn't correct! But tricky to implement because
6831      // the array's size has to be the size of LHS, but the type
6832      // has to be different.
6833      return LHS;
6834    }
6835    if (RVAT) {
6836      // FIXME: This isn't correct! But tricky to implement because
6837      // the array's size has to be the size of RHS, but the type
6838      // has to be different.
6839      return RHS;
6840    }
6841    if (getCanonicalType(LHSElem) == getCanonicalType(ResultType)) return LHS;
6842    if (getCanonicalType(RHSElem) == getCanonicalType(ResultType)) return RHS;
6843    return getIncompleteArrayType(ResultType,
6844                                  ArrayType::ArraySizeModifier(), 0);
6845  }
6846  case Type::FunctionNoProto:
6847    return mergeFunctionTypes(LHS, RHS, OfBlockPointer, Unqualified);
6848  case Type::Record:
6849  case Type::Enum:
6850    return QualType();
6851  case Type::Builtin:
6852    // Only exactly equal builtin types are compatible, which is tested above.
6853    return QualType();
6854  case Type::Complex:
6855    // Distinct complex types are incompatible.
6856    return QualType();
6857  case Type::Vector:
6858    // FIXME: The merged type should be an ExtVector!
6859    if (areCompatVectorTypes(LHSCan->getAs<VectorType>(),
6860                             RHSCan->getAs<VectorType>()))
6861      return LHS;
6862    return QualType();
6863  case Type::ObjCObject: {
6864    // Check if the types are assignment compatible.
6865    // FIXME: This should be type compatibility, e.g. whether
6866    // "LHS x; RHS x;" at global scope is legal.
6867    const ObjCObjectType* LHSIface = LHS->getAs<ObjCObjectType>();
6868    const ObjCObjectType* RHSIface = RHS->getAs<ObjCObjectType>();
6869    if (canAssignObjCInterfaces(LHSIface, RHSIface))
6870      return LHS;
6871
6872    return QualType();
6873  }
6874  case Type::ObjCObjectPointer: {
6875    if (OfBlockPointer) {
6876      if (canAssignObjCInterfacesInBlockPointer(
6877                                          LHS->getAs<ObjCObjectPointerType>(),
6878                                          RHS->getAs<ObjCObjectPointerType>(),
6879                                          BlockReturnType))
6880        return LHS;
6881      return QualType();
6882    }
6883    if (canAssignObjCInterfaces(LHS->getAs<ObjCObjectPointerType>(),
6884                                RHS->getAs<ObjCObjectPointerType>()))
6885      return LHS;
6886
6887    return QualType();
6888  }
6889  }
6890
6891  llvm_unreachable("Invalid Type::Class!");
6892}
6893
6894bool ASTContext::FunctionTypesMatchOnNSConsumedAttrs(
6895                   const FunctionProtoType *FromFunctionType,
6896                   const FunctionProtoType *ToFunctionType) {
6897  if (FromFunctionType->hasAnyConsumedArgs() !=
6898      ToFunctionType->hasAnyConsumedArgs())
6899    return false;
6900  FunctionProtoType::ExtProtoInfo FromEPI =
6901    FromFunctionType->getExtProtoInfo();
6902  FunctionProtoType::ExtProtoInfo ToEPI =
6903    ToFunctionType->getExtProtoInfo();
6904  if (FromEPI.ConsumedArguments && ToEPI.ConsumedArguments)
6905    for (unsigned ArgIdx = 0, NumArgs = FromFunctionType->getNumArgs();
6906         ArgIdx != NumArgs; ++ArgIdx)  {
6907      if (FromEPI.ConsumedArguments[ArgIdx] !=
6908          ToEPI.ConsumedArguments[ArgIdx])
6909        return false;
6910    }
6911  return true;
6912}
6913
6914/// mergeObjCGCQualifiers - This routine merges ObjC's GC attribute of 'LHS' and
6915/// 'RHS' attributes and returns the merged version; including for function
6916/// return types.
6917QualType ASTContext::mergeObjCGCQualifiers(QualType LHS, QualType RHS) {
6918  QualType LHSCan = getCanonicalType(LHS),
6919  RHSCan = getCanonicalType(RHS);
6920  // If two types are identical, they are compatible.
6921  if (LHSCan == RHSCan)
6922    return LHS;
6923  if (RHSCan->isFunctionType()) {
6924    if (!LHSCan->isFunctionType())
6925      return QualType();
6926    QualType OldReturnType =
6927      cast<FunctionType>(RHSCan.getTypePtr())->getResultType();
6928    QualType NewReturnType =
6929      cast<FunctionType>(LHSCan.getTypePtr())->getResultType();
6930    QualType ResReturnType =
6931      mergeObjCGCQualifiers(NewReturnType, OldReturnType);
6932    if (ResReturnType.isNull())
6933      return QualType();
6934    if (ResReturnType == NewReturnType || ResReturnType == OldReturnType) {
6935      // id foo(); ... __strong id foo(); or: __strong id foo(); ... id foo();
6936      // In either case, use OldReturnType to build the new function type.
6937      const FunctionType *F = LHS->getAs<FunctionType>();
6938      if (const FunctionProtoType *FPT = cast<FunctionProtoType>(F)) {
6939        FunctionProtoType::ExtProtoInfo EPI = FPT->getExtProtoInfo();
6940        EPI.ExtInfo = getFunctionExtInfo(LHS);
6941        QualType ResultType
6942          = getFunctionType(OldReturnType, FPT->arg_type_begin(),
6943                            FPT->getNumArgs(), EPI);
6944        return ResultType;
6945      }
6946    }
6947    return QualType();
6948  }
6949
6950  // If the qualifiers are different, the types can still be merged.
6951  Qualifiers LQuals = LHSCan.getLocalQualifiers();
6952  Qualifiers RQuals = RHSCan.getLocalQualifiers();
6953  if (LQuals != RQuals) {
6954    // If any of these qualifiers are different, we have a type mismatch.
6955    if (LQuals.getCVRQualifiers() != RQuals.getCVRQualifiers() ||
6956        LQuals.getAddressSpace() != RQuals.getAddressSpace())
6957      return QualType();
6958
6959    // Exactly one GC qualifier difference is allowed: __strong is
6960    // okay if the other type has no GC qualifier but is an Objective
6961    // C object pointer (i.e. implicitly strong by default).  We fix
6962    // this by pretending that the unqualified type was actually
6963    // qualified __strong.
6964    Qualifiers::GC GC_L = LQuals.getObjCGCAttr();
6965    Qualifiers::GC GC_R = RQuals.getObjCGCAttr();
6966    assert((GC_L != GC_R) && "unequal qualifier sets had only equal elements");
6967
6968    if (GC_L == Qualifiers::Weak || GC_R == Qualifiers::Weak)
6969      return QualType();
6970
6971    if (GC_L == Qualifiers::Strong)
6972      return LHS;
6973    if (GC_R == Qualifiers::Strong)
6974      return RHS;
6975    return QualType();
6976  }
6977
6978  if (LHSCan->isObjCObjectPointerType() && RHSCan->isObjCObjectPointerType()) {
6979    QualType LHSBaseQT = LHS->getAs<ObjCObjectPointerType>()->getPointeeType();
6980    QualType RHSBaseQT = RHS->getAs<ObjCObjectPointerType>()->getPointeeType();
6981    QualType ResQT = mergeObjCGCQualifiers(LHSBaseQT, RHSBaseQT);
6982    if (ResQT == LHSBaseQT)
6983      return LHS;
6984    if (ResQT == RHSBaseQT)
6985      return RHS;
6986  }
6987  return QualType();
6988}
6989
6990//===----------------------------------------------------------------------===//
6991//                         Integer Predicates
6992//===----------------------------------------------------------------------===//
6993
6994unsigned ASTContext::getIntWidth(QualType T) const {
6995  if (const EnumType *ET = dyn_cast<EnumType>(T))
6996    T = ET->getDecl()->getIntegerType();
6997  if (T->isBooleanType())
6998    return 1;
6999  // For builtin types, just use the standard type sizing method
7000  return (unsigned)getTypeSize(T);
7001}
7002
7003QualType ASTContext::getCorrespondingUnsignedType(QualType T) const {
7004  assert(T->hasSignedIntegerRepresentation() && "Unexpected type");
7005
7006  // Turn <4 x signed int> -> <4 x unsigned int>
7007  if (const VectorType *VTy = T->getAs<VectorType>())
7008    return getVectorType(getCorrespondingUnsignedType(VTy->getElementType()),
7009                         VTy->getNumElements(), VTy->getVectorKind());
7010
7011  // For enums, we return the unsigned version of the base type.
7012  if (const EnumType *ETy = T->getAs<EnumType>())
7013    T = ETy->getDecl()->getIntegerType();
7014
7015  const BuiltinType *BTy = T->getAs<BuiltinType>();
7016  assert(BTy && "Unexpected signed integer type");
7017  switch (BTy->getKind()) {
7018  case BuiltinType::Char_S:
7019  case BuiltinType::SChar:
7020    return UnsignedCharTy;
7021  case BuiltinType::Short:
7022    return UnsignedShortTy;
7023  case BuiltinType::Int:
7024    return UnsignedIntTy;
7025  case BuiltinType::Long:
7026    return UnsignedLongTy;
7027  case BuiltinType::LongLong:
7028    return UnsignedLongLongTy;
7029  case BuiltinType::Int128:
7030    return UnsignedInt128Ty;
7031  default:
7032    llvm_unreachable("Unexpected signed integer type");
7033  }
7034}
7035
7036ASTMutationListener::~ASTMutationListener() { }
7037
7038
7039//===----------------------------------------------------------------------===//
7040//                          Builtin Type Computation
7041//===----------------------------------------------------------------------===//
7042
7043/// DecodeTypeFromStr - This decodes one type descriptor from Str, advancing the
7044/// pointer over the consumed characters.  This returns the resultant type.  If
7045/// AllowTypeModifiers is false then modifier like * are not parsed, just basic
7046/// types.  This allows "v2i*" to be parsed as a pointer to a v2i instead of
7047/// a vector of "i*".
7048///
7049/// RequiresICE is filled in on return to indicate whether the value is required
7050/// to be an Integer Constant Expression.
7051static QualType DecodeTypeFromStr(const char *&Str, const ASTContext &Context,
7052                                  ASTContext::GetBuiltinTypeError &Error,
7053                                  bool &RequiresICE,
7054                                  bool AllowTypeModifiers) {
7055  // Modifiers.
7056  int HowLong = 0;
7057  bool Signed = false, Unsigned = false;
7058  RequiresICE = false;
7059
7060  // Read the prefixed modifiers first.
7061  bool Done = false;
7062  while (!Done) {
7063    switch (*Str++) {
7064    default: Done = true; --Str; break;
7065    case 'I':
7066      RequiresICE = true;
7067      break;
7068    case 'S':
7069      assert(!Unsigned && "Can't use both 'S' and 'U' modifiers!");
7070      assert(!Signed && "Can't use 'S' modifier multiple times!");
7071      Signed = true;
7072      break;
7073    case 'U':
7074      assert(!Signed && "Can't use both 'S' and 'U' modifiers!");
7075      assert(!Unsigned && "Can't use 'S' modifier multiple times!");
7076      Unsigned = true;
7077      break;
7078    case 'L':
7079      assert(HowLong <= 2 && "Can't have LLLL modifier");
7080      ++HowLong;
7081      break;
7082    }
7083  }
7084
7085  QualType Type;
7086
7087  // Read the base type.
7088  switch (*Str++) {
7089  default: llvm_unreachable("Unknown builtin type letter!");
7090  case 'v':
7091    assert(HowLong == 0 && !Signed && !Unsigned &&
7092           "Bad modifiers used with 'v'!");
7093    Type = Context.VoidTy;
7094    break;
7095  case 'f':
7096    assert(HowLong == 0 && !Signed && !Unsigned &&
7097           "Bad modifiers used with 'f'!");
7098    Type = Context.FloatTy;
7099    break;
7100  case 'd':
7101    assert(HowLong < 2 && !Signed && !Unsigned &&
7102           "Bad modifiers used with 'd'!");
7103    if (HowLong)
7104      Type = Context.LongDoubleTy;
7105    else
7106      Type = Context.DoubleTy;
7107    break;
7108  case 's':
7109    assert(HowLong == 0 && "Bad modifiers used with 's'!");
7110    if (Unsigned)
7111      Type = Context.UnsignedShortTy;
7112    else
7113      Type = Context.ShortTy;
7114    break;
7115  case 'i':
7116    if (HowLong == 3)
7117      Type = Unsigned ? Context.UnsignedInt128Ty : Context.Int128Ty;
7118    else if (HowLong == 2)
7119      Type = Unsigned ? Context.UnsignedLongLongTy : Context.LongLongTy;
7120    else if (HowLong == 1)
7121      Type = Unsigned ? Context.UnsignedLongTy : Context.LongTy;
7122    else
7123      Type = Unsigned ? Context.UnsignedIntTy : Context.IntTy;
7124    break;
7125  case 'c':
7126    assert(HowLong == 0 && "Bad modifiers used with 'c'!");
7127    if (Signed)
7128      Type = Context.SignedCharTy;
7129    else if (Unsigned)
7130      Type = Context.UnsignedCharTy;
7131    else
7132      Type = Context.CharTy;
7133    break;
7134  case 'b': // boolean
7135    assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'b'!");
7136    Type = Context.BoolTy;
7137    break;
7138  case 'z':  // size_t.
7139    assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'z'!");
7140    Type = Context.getSizeType();
7141    break;
7142  case 'F':
7143    Type = Context.getCFConstantStringType();
7144    break;
7145  case 'G':
7146    Type = Context.getObjCIdType();
7147    break;
7148  case 'H':
7149    Type = Context.getObjCSelType();
7150    break;
7151  case 'a':
7152    Type = Context.getBuiltinVaListType();
7153    assert(!Type.isNull() && "builtin va list type not initialized!");
7154    break;
7155  case 'A':
7156    // This is a "reference" to a va_list; however, what exactly
7157    // this means depends on how va_list is defined. There are two
7158    // different kinds of va_list: ones passed by value, and ones
7159    // passed by reference.  An example of a by-value va_list is
7160    // x86, where va_list is a char*. An example of by-ref va_list
7161    // is x86-64, where va_list is a __va_list_tag[1]. For x86,
7162    // we want this argument to be a char*&; for x86-64, we want
7163    // it to be a __va_list_tag*.
7164    Type = Context.getBuiltinVaListType();
7165    assert(!Type.isNull() && "builtin va list type not initialized!");
7166    if (Type->isArrayType())
7167      Type = Context.getArrayDecayedType(Type);
7168    else
7169      Type = Context.getLValueReferenceType(Type);
7170    break;
7171  case 'V': {
7172    char *End;
7173    unsigned NumElements = strtoul(Str, &End, 10);
7174    assert(End != Str && "Missing vector size");
7175    Str = End;
7176
7177    QualType ElementType = DecodeTypeFromStr(Str, Context, Error,
7178                                             RequiresICE, false);
7179    assert(!RequiresICE && "Can't require vector ICE");
7180
7181    // TODO: No way to make AltiVec vectors in builtins yet.
7182    Type = Context.getVectorType(ElementType, NumElements,
7183                                 VectorType::GenericVector);
7184    break;
7185  }
7186  case 'E': {
7187    char *End;
7188
7189    unsigned NumElements = strtoul(Str, &End, 10);
7190    assert(End != Str && "Missing vector size");
7191
7192    Str = End;
7193
7194    QualType ElementType = DecodeTypeFromStr(Str, Context, Error, RequiresICE,
7195                                             false);
7196    Type = Context.getExtVectorType(ElementType, NumElements);
7197    break;
7198  }
7199  case 'X': {
7200    QualType ElementType = DecodeTypeFromStr(Str, Context, Error, RequiresICE,
7201                                             false);
7202    assert(!RequiresICE && "Can't require complex ICE");
7203    Type = Context.getComplexType(ElementType);
7204    break;
7205  }
7206  case 'Y' : {
7207    Type = Context.getPointerDiffType();
7208    break;
7209  }
7210  case 'P':
7211    Type = Context.getFILEType();
7212    if (Type.isNull()) {
7213      Error = ASTContext::GE_Missing_stdio;
7214      return QualType();
7215    }
7216    break;
7217  case 'J':
7218    if (Signed)
7219      Type = Context.getsigjmp_bufType();
7220    else
7221      Type = Context.getjmp_bufType();
7222
7223    if (Type.isNull()) {
7224      Error = ASTContext::GE_Missing_setjmp;
7225      return QualType();
7226    }
7227    break;
7228  case 'K':
7229    assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'K'!");
7230    Type = Context.getucontext_tType();
7231
7232    if (Type.isNull()) {
7233      Error = ASTContext::GE_Missing_ucontext;
7234      return QualType();
7235    }
7236    break;
7237  case 'p':
7238    Type = Context.getProcessIDType();
7239    break;
7240  }
7241
7242  // If there are modifiers and if we're allowed to parse them, go for it.
7243  Done = !AllowTypeModifiers;
7244  while (!Done) {
7245    switch (char c = *Str++) {
7246    default: Done = true; --Str; break;
7247    case '*':
7248    case '&': {
7249      // Both pointers and references can have their pointee types
7250      // qualified with an address space.
7251      char *End;
7252      unsigned AddrSpace = strtoul(Str, &End, 10);
7253      if (End != Str && AddrSpace != 0) {
7254        Type = Context.getAddrSpaceQualType(Type, AddrSpace);
7255        Str = End;
7256      }
7257      if (c == '*')
7258        Type = Context.getPointerType(Type);
7259      else
7260        Type = Context.getLValueReferenceType(Type);
7261      break;
7262    }
7263    // FIXME: There's no way to have a built-in with an rvalue ref arg.
7264    case 'C':
7265      Type = Type.withConst();
7266      break;
7267    case 'D':
7268      Type = Context.getVolatileType(Type);
7269      break;
7270    case 'R':
7271      Type = Type.withRestrict();
7272      break;
7273    }
7274  }
7275
7276  assert((!RequiresICE || Type->isIntegralOrEnumerationType()) &&
7277         "Integer constant 'I' type must be an integer");
7278
7279  return Type;
7280}
7281
7282/// GetBuiltinType - Return the type for the specified builtin.
7283QualType ASTContext::GetBuiltinType(unsigned Id,
7284                                    GetBuiltinTypeError &Error,
7285                                    unsigned *IntegerConstantArgs) const {
7286  const char *TypeStr = BuiltinInfo.GetTypeString(Id);
7287
7288  SmallVector<QualType, 8> ArgTypes;
7289
7290  bool RequiresICE = false;
7291  Error = GE_None;
7292  QualType ResType = DecodeTypeFromStr(TypeStr, *this, Error,
7293                                       RequiresICE, true);
7294  if (Error != GE_None)
7295    return QualType();
7296
7297  assert(!RequiresICE && "Result of intrinsic cannot be required to be an ICE");
7298
7299  while (TypeStr[0] && TypeStr[0] != '.') {
7300    QualType Ty = DecodeTypeFromStr(TypeStr, *this, Error, RequiresICE, true);
7301    if (Error != GE_None)
7302      return QualType();
7303
7304    // If this argument is required to be an IntegerConstantExpression and the
7305    // caller cares, fill in the bitmask we return.
7306    if (RequiresICE && IntegerConstantArgs)
7307      *IntegerConstantArgs |= 1 << ArgTypes.size();
7308
7309    // Do array -> pointer decay.  The builtin should use the decayed type.
7310    if (Ty->isArrayType())
7311      Ty = getArrayDecayedType(Ty);
7312
7313    ArgTypes.push_back(Ty);
7314  }
7315
7316  assert((TypeStr[0] != '.' || TypeStr[1] == 0) &&
7317         "'.' should only occur at end of builtin type list!");
7318
7319  FunctionType::ExtInfo EI;
7320  if (BuiltinInfo.isNoReturn(Id)) EI = EI.withNoReturn(true);
7321
7322  bool Variadic = (TypeStr[0] == '.');
7323
7324  // We really shouldn't be making a no-proto type here, especially in C++.
7325  if (ArgTypes.empty() && Variadic)
7326    return getFunctionNoProtoType(ResType, EI);
7327
7328  FunctionProtoType::ExtProtoInfo EPI;
7329  EPI.ExtInfo = EI;
7330  EPI.Variadic = Variadic;
7331
7332  return getFunctionType(ResType, ArgTypes.data(), ArgTypes.size(), EPI);
7333}
7334
7335GVALinkage ASTContext::GetGVALinkageForFunction(const FunctionDecl *FD) {
7336  GVALinkage External = GVA_StrongExternal;
7337
7338  Linkage L = FD->getLinkage();
7339  switch (L) {
7340  case NoLinkage:
7341  case InternalLinkage:
7342  case UniqueExternalLinkage:
7343    return GVA_Internal;
7344
7345  case ExternalLinkage:
7346    switch (FD->getTemplateSpecializationKind()) {
7347    case TSK_Undeclared:
7348    case TSK_ExplicitSpecialization:
7349      External = GVA_StrongExternal;
7350      break;
7351
7352    case TSK_ExplicitInstantiationDefinition:
7353      return GVA_ExplicitTemplateInstantiation;
7354
7355    case TSK_ExplicitInstantiationDeclaration:
7356    case TSK_ImplicitInstantiation:
7357      External = GVA_TemplateInstantiation;
7358      break;
7359    }
7360  }
7361
7362  if (!FD->isInlined())
7363    return External;
7364
7365  if (!getLangOpts().CPlusPlus || FD->hasAttr<GNUInlineAttr>()) {
7366    // GNU or C99 inline semantics. Determine whether this symbol should be
7367    // externally visible.
7368    if (FD->isInlineDefinitionExternallyVisible())
7369      return External;
7370
7371    // C99 inline semantics, where the symbol is not externally visible.
7372    return GVA_C99Inline;
7373  }
7374
7375  // C++0x [temp.explicit]p9:
7376  //   [ Note: The intent is that an inline function that is the subject of
7377  //   an explicit instantiation declaration will still be implicitly
7378  //   instantiated when used so that the body can be considered for
7379  //   inlining, but that no out-of-line copy of the inline function would be
7380  //   generated in the translation unit. -- end note ]
7381  if (FD->getTemplateSpecializationKind()
7382                                       == TSK_ExplicitInstantiationDeclaration)
7383    return GVA_C99Inline;
7384
7385  return GVA_CXXInline;
7386}
7387
7388GVALinkage ASTContext::GetGVALinkageForVariable(const VarDecl *VD) {
7389  // If this is a static data member, compute the kind of template
7390  // specialization. Otherwise, this variable is not part of a
7391  // template.
7392  TemplateSpecializationKind TSK = TSK_Undeclared;
7393  if (VD->isStaticDataMember())
7394    TSK = VD->getTemplateSpecializationKind();
7395
7396  Linkage L = VD->getLinkage();
7397  if (L == ExternalLinkage && getLangOpts().CPlusPlus &&
7398      VD->getType()->getLinkage() == UniqueExternalLinkage)
7399    L = UniqueExternalLinkage;
7400
7401  switch (L) {
7402  case NoLinkage:
7403  case InternalLinkage:
7404  case UniqueExternalLinkage:
7405    return GVA_Internal;
7406
7407  case ExternalLinkage:
7408    switch (TSK) {
7409    case TSK_Undeclared:
7410    case TSK_ExplicitSpecialization:
7411      return GVA_StrongExternal;
7412
7413    case TSK_ExplicitInstantiationDeclaration:
7414      llvm_unreachable("Variable should not be instantiated");
7415      // Fall through to treat this like any other instantiation.
7416
7417    case TSK_ExplicitInstantiationDefinition:
7418      return GVA_ExplicitTemplateInstantiation;
7419
7420    case TSK_ImplicitInstantiation:
7421      return GVA_TemplateInstantiation;
7422    }
7423  }
7424
7425  llvm_unreachable("Invalid Linkage!");
7426}
7427
7428bool ASTContext::DeclMustBeEmitted(const Decl *D) {
7429  if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
7430    if (!VD->isFileVarDecl())
7431      return false;
7432  } else if (!isa<FunctionDecl>(D))
7433    return false;
7434
7435  // Weak references don't produce any output by themselves.
7436  if (D->hasAttr<WeakRefAttr>())
7437    return false;
7438
7439  // Aliases and used decls are required.
7440  if (D->hasAttr<AliasAttr>() || D->hasAttr<UsedAttr>())
7441    return true;
7442
7443  if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
7444    // Forward declarations aren't required.
7445    if (!FD->doesThisDeclarationHaveABody())
7446      return FD->doesDeclarationForceExternallyVisibleDefinition();
7447
7448    // Constructors and destructors are required.
7449    if (FD->hasAttr<ConstructorAttr>() || FD->hasAttr<DestructorAttr>())
7450      return true;
7451
7452    // The key function for a class is required.
7453    if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) {
7454      const CXXRecordDecl *RD = MD->getParent();
7455      if (MD->isOutOfLine() && RD->isDynamicClass()) {
7456        const CXXMethodDecl *KeyFunc = getKeyFunction(RD);
7457        if (KeyFunc && KeyFunc->getCanonicalDecl() == MD->getCanonicalDecl())
7458          return true;
7459      }
7460    }
7461
7462    GVALinkage Linkage = GetGVALinkageForFunction(FD);
7463
7464    // static, static inline, always_inline, and extern inline functions can
7465    // always be deferred.  Normal inline functions can be deferred in C99/C++.
7466    // Implicit template instantiations can also be deferred in C++.
7467    if (Linkage == GVA_Internal  || Linkage == GVA_C99Inline ||
7468        Linkage == GVA_CXXInline || Linkage == GVA_TemplateInstantiation)
7469      return false;
7470    return true;
7471  }
7472
7473  const VarDecl *VD = cast<VarDecl>(D);
7474  assert(VD->isFileVarDecl() && "Expected file scoped var");
7475
7476  if (VD->isThisDeclarationADefinition() == VarDecl::DeclarationOnly)
7477    return false;
7478
7479  // Variables that can be needed in other TUs are required.
7480  GVALinkage L = GetGVALinkageForVariable(VD);
7481  if (L != GVA_Internal && L != GVA_TemplateInstantiation)
7482    return true;
7483
7484  // Variables that have destruction with side-effects are required.
7485  if (VD->getType().isDestructedType())
7486    return true;
7487
7488  // Variables that have initialization with side-effects are required.
7489  if (VD->getInit() && VD->getInit()->HasSideEffects(*this))
7490    return true;
7491
7492  return false;
7493}
7494
7495CallingConv ASTContext::getDefaultCXXMethodCallConv(bool isVariadic) {
7496  // Pass through to the C++ ABI object
7497  return ABI->getDefaultMethodCallConv(isVariadic);
7498}
7499
7500CallingConv ASTContext::getCanonicalCallConv(CallingConv CC) const {
7501  if (CC == CC_C && !LangOpts.MRTD && getTargetInfo().getCXXABI() != CXXABI_Microsoft)
7502    return CC_Default;
7503  return CC;
7504}
7505
7506bool ASTContext::isNearlyEmpty(const CXXRecordDecl *RD) const {
7507  // Pass through to the C++ ABI object
7508  return ABI->isNearlyEmpty(RD);
7509}
7510
7511MangleContext *ASTContext::createMangleContext() {
7512  switch (Target->getCXXABI()) {
7513  case CXXABI_ARM:
7514  case CXXABI_Itanium:
7515    return createItaniumMangleContext(*this, getDiagnostics());
7516  case CXXABI_Microsoft:
7517    return createMicrosoftMangleContext(*this, getDiagnostics());
7518  }
7519  llvm_unreachable("Unsupported ABI");
7520}
7521
7522CXXABI::~CXXABI() {}
7523
7524size_t ASTContext::getSideTableAllocatedMemory() const {
7525  return ASTRecordLayouts.getMemorySize()
7526    + llvm::capacity_in_bytes(ObjCLayouts)
7527    + llvm::capacity_in_bytes(KeyFunctions)
7528    + llvm::capacity_in_bytes(ObjCImpls)
7529    + llvm::capacity_in_bytes(BlockVarCopyInits)
7530    + llvm::capacity_in_bytes(DeclAttrs)
7531    + llvm::capacity_in_bytes(InstantiatedFromStaticDataMember)
7532    + llvm::capacity_in_bytes(InstantiatedFromUsingDecl)
7533    + llvm::capacity_in_bytes(InstantiatedFromUsingShadowDecl)
7534    + llvm::capacity_in_bytes(InstantiatedFromUnnamedFieldDecl)
7535    + llvm::capacity_in_bytes(OverriddenMethods)
7536    + llvm::capacity_in_bytes(Types)
7537    + llvm::capacity_in_bytes(VariableArrayTypes)
7538    + llvm::capacity_in_bytes(ClassScopeSpecializationPattern);
7539}
7540
7541void ASTContext::addUnnamedTag(const TagDecl *Tag) {
7542  // FIXME: This mangling should be applied to function local classes too
7543  if (!Tag->getName().empty() || Tag->getTypedefNameForAnonDecl() ||
7544      !isa<CXXRecordDecl>(Tag->getParent()) || Tag->getLinkage() != ExternalLinkage)
7545    return;
7546
7547  std::pair<llvm::DenseMap<const DeclContext *, unsigned>::iterator, bool> P =
7548    UnnamedMangleContexts.insert(std::make_pair(Tag->getParent(), 0));
7549  UnnamedMangleNumbers.insert(std::make_pair(Tag, P.first->second++));
7550}
7551
7552int ASTContext::getUnnamedTagManglingNumber(const TagDecl *Tag) const {
7553  llvm::DenseMap<const TagDecl *, unsigned>::const_iterator I =
7554    UnnamedMangleNumbers.find(Tag);
7555  return I != UnnamedMangleNumbers.end() ? I->second : -1;
7556}
7557
7558unsigned ASTContext::getLambdaManglingNumber(CXXMethodDecl *CallOperator) {
7559  CXXRecordDecl *Lambda = CallOperator->getParent();
7560  return LambdaMangleContexts[Lambda->getDeclContext()]
7561           .getManglingNumber(CallOperator);
7562}
7563
7564
7565void ASTContext::setParameterIndex(const ParmVarDecl *D, unsigned int index) {
7566  ParamIndices[D] = index;
7567}
7568
7569unsigned ASTContext::getParameterIndex(const ParmVarDecl *D) const {
7570  ParameterIndexTable::const_iterator I = ParamIndices.find(D);
7571  assert(I != ParamIndices.end() &&
7572         "ParmIndices lacks entry set by ParmVarDecl");
7573  return I->second;
7574}
7575