ASTContext.cpp revision 632d772a78db7e2cd9b36f8a22aee49d44486fbf
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 "clang/AST/DeclCXX.h"
16#include "clang/AST/DeclObjC.h"
17#include "clang/AST/DeclTemplate.h"
18#include "clang/AST/TypeLoc.h"
19#include "clang/AST/Expr.h"
20#include "clang/AST/ExternalASTSource.h"
21#include "clang/AST/RecordLayout.h"
22#include "clang/Basic/Builtins.h"
23#include "clang/Basic/SourceManager.h"
24#include "clang/Basic/TargetInfo.h"
25#include "llvm/ADT/SmallString.h"
26#include "llvm/ADT/StringExtras.h"
27#include "llvm/Support/MathExtras.h"
28#include "llvm/Support/raw_ostream.h"
29#include "RecordLayoutBuilder.h"
30
31using namespace clang;
32
33enum FloatingRank {
34  FloatRank, DoubleRank, LongDoubleRank
35};
36
37ASTContext::ASTContext(const LangOptions& LOpts, SourceManager &SM,
38                       TargetInfo &t,
39                       IdentifierTable &idents, SelectorTable &sels,
40                       Builtin::Context &builtins,
41                       bool FreeMem, unsigned size_reserve) :
42  GlobalNestedNameSpecifier(0), CFConstantStringTypeDecl(0),
43  ObjCFastEnumerationStateTypeDecl(0), FILEDecl(0), jmp_bufDecl(0),
44  sigjmp_bufDecl(0), BlockDescriptorType(0), BlockDescriptorExtendedType(0),
45  SourceMgr(SM), LangOpts(LOpts),
46  LoadedExternalComments(false), FreeMemory(FreeMem), Target(t),
47  Idents(idents), Selectors(sels),
48  BuiltinInfo(builtins), ExternalSource(0), PrintingPolicy(LOpts) {
49  ObjCIdRedefinitionType = QualType();
50  ObjCClassRedefinitionType = QualType();
51  if (size_reserve > 0) Types.reserve(size_reserve);
52  TUDecl = TranslationUnitDecl::Create(*this);
53  InitBuiltinTypes();
54}
55
56ASTContext::~ASTContext() {
57  // Deallocate all the types.
58  while (!Types.empty()) {
59    Types.back()->Destroy(*this);
60    Types.pop_back();
61  }
62
63  {
64    llvm::FoldingSet<ExtQuals>::iterator
65      I = ExtQualNodes.begin(), E = ExtQualNodes.end();
66    while (I != E)
67      Deallocate(&*I++);
68  }
69
70  {
71    llvm::DenseMap<const RecordDecl*, const ASTRecordLayout*>::iterator
72      I = ASTRecordLayouts.begin(), E = ASTRecordLayouts.end();
73    while (I != E) {
74      ASTRecordLayout *R = const_cast<ASTRecordLayout*>((I++)->second);
75      delete R;
76    }
77  }
78
79  {
80    llvm::DenseMap<const ObjCContainerDecl*, const ASTRecordLayout*>::iterator
81      I = ObjCLayouts.begin(), E = ObjCLayouts.end();
82    while (I != E) {
83      ASTRecordLayout *R = const_cast<ASTRecordLayout*>((I++)->second);
84      delete R;
85    }
86  }
87
88  // Destroy nested-name-specifiers.
89  for (llvm::FoldingSet<NestedNameSpecifier>::iterator
90         NNS = NestedNameSpecifiers.begin(),
91         NNSEnd = NestedNameSpecifiers.end();
92       NNS != NNSEnd;
93       /* Increment in loop */)
94    (*NNS++).Destroy(*this);
95
96  if (GlobalNestedNameSpecifier)
97    GlobalNestedNameSpecifier->Destroy(*this);
98
99  TUDecl->Destroy(*this);
100}
101
102void
103ASTContext::setExternalSource(llvm::OwningPtr<ExternalASTSource> &Source) {
104  ExternalSource.reset(Source.take());
105}
106
107void ASTContext::PrintStats() const {
108  fprintf(stderr, "*** AST Context Stats:\n");
109  fprintf(stderr, "  %d types total.\n", (int)Types.size());
110
111  unsigned counts[] = {
112#define TYPE(Name, Parent) 0,
113#define ABSTRACT_TYPE(Name, Parent)
114#include "clang/AST/TypeNodes.def"
115    0 // Extra
116  };
117
118  for (unsigned i = 0, e = Types.size(); i != e; ++i) {
119    Type *T = Types[i];
120    counts[(unsigned)T->getTypeClass()]++;
121  }
122
123  unsigned Idx = 0;
124  unsigned TotalBytes = 0;
125#define TYPE(Name, Parent)                                              \
126  if (counts[Idx])                                                      \
127    fprintf(stderr, "    %d %s types\n", (int)counts[Idx], #Name);      \
128  TotalBytes += counts[Idx] * sizeof(Name##Type);                       \
129  ++Idx;
130#define ABSTRACT_TYPE(Name, Parent)
131#include "clang/AST/TypeNodes.def"
132
133  fprintf(stderr, "Total bytes = %d\n", int(TotalBytes));
134
135  if (ExternalSource.get()) {
136    fprintf(stderr, "\n");
137    ExternalSource->PrintStats();
138  }
139}
140
141
142void ASTContext::InitBuiltinType(CanQualType &R, BuiltinType::Kind K) {
143  BuiltinType *Ty = new (*this, TypeAlignment) BuiltinType(K);
144  R = CanQualType::CreateUnsafe(QualType(Ty, 0));
145  Types.push_back(Ty);
146}
147
148void ASTContext::InitBuiltinTypes() {
149  assert(VoidTy.isNull() && "Context reinitialized?");
150
151  // C99 6.2.5p19.
152  InitBuiltinType(VoidTy,              BuiltinType::Void);
153
154  // C99 6.2.5p2.
155  InitBuiltinType(BoolTy,              BuiltinType::Bool);
156  // C99 6.2.5p3.
157  if (LangOpts.CharIsSigned)
158    InitBuiltinType(CharTy,            BuiltinType::Char_S);
159  else
160    InitBuiltinType(CharTy,            BuiltinType::Char_U);
161  // C99 6.2.5p4.
162  InitBuiltinType(SignedCharTy,        BuiltinType::SChar);
163  InitBuiltinType(ShortTy,             BuiltinType::Short);
164  InitBuiltinType(IntTy,               BuiltinType::Int);
165  InitBuiltinType(LongTy,              BuiltinType::Long);
166  InitBuiltinType(LongLongTy,          BuiltinType::LongLong);
167
168  // C99 6.2.5p6.
169  InitBuiltinType(UnsignedCharTy,      BuiltinType::UChar);
170  InitBuiltinType(UnsignedShortTy,     BuiltinType::UShort);
171  InitBuiltinType(UnsignedIntTy,       BuiltinType::UInt);
172  InitBuiltinType(UnsignedLongTy,      BuiltinType::ULong);
173  InitBuiltinType(UnsignedLongLongTy,  BuiltinType::ULongLong);
174
175  // C99 6.2.5p10.
176  InitBuiltinType(FloatTy,             BuiltinType::Float);
177  InitBuiltinType(DoubleTy,            BuiltinType::Double);
178  InitBuiltinType(LongDoubleTy,        BuiltinType::LongDouble);
179
180  // GNU extension, 128-bit integers.
181  InitBuiltinType(Int128Ty,            BuiltinType::Int128);
182  InitBuiltinType(UnsignedInt128Ty,    BuiltinType::UInt128);
183
184  if (LangOpts.CPlusPlus) // C++ 3.9.1p5
185    InitBuiltinType(WCharTy,           BuiltinType::WChar);
186  else // C99
187    WCharTy = getFromTargetType(Target.getWCharType());
188
189  if (LangOpts.CPlusPlus) // C++0x 3.9.1p5, extension for C++
190    InitBuiltinType(Char16Ty,           BuiltinType::Char16);
191  else // C99
192    Char16Ty = getFromTargetType(Target.getChar16Type());
193
194  if (LangOpts.CPlusPlus) // C++0x 3.9.1p5, extension for C++
195    InitBuiltinType(Char32Ty,           BuiltinType::Char32);
196  else // C99
197    Char32Ty = getFromTargetType(Target.getChar32Type());
198
199  // Placeholder type for functions.
200  InitBuiltinType(OverloadTy,          BuiltinType::Overload);
201
202  // Placeholder type for type-dependent expressions whose type is
203  // completely unknown. No code should ever check a type against
204  // DependentTy and users should never see it; however, it is here to
205  // help diagnose failures to properly check for type-dependent
206  // expressions.
207  InitBuiltinType(DependentTy,         BuiltinType::Dependent);
208
209  // Placeholder type for C++0x auto declarations whose real type has
210  // not yet been deduced.
211  InitBuiltinType(UndeducedAutoTy, BuiltinType::UndeducedAuto);
212
213  // C99 6.2.5p11.
214  FloatComplexTy      = getComplexType(FloatTy);
215  DoubleComplexTy     = getComplexType(DoubleTy);
216  LongDoubleComplexTy = getComplexType(LongDoubleTy);
217
218  BuiltinVaListType = QualType();
219
220  // "Builtin" typedefs set by Sema::ActOnTranslationUnitScope().
221  ObjCIdTypedefType = QualType();
222  ObjCClassTypedefType = QualType();
223
224  // Builtin types for 'id' and 'Class'.
225  InitBuiltinType(ObjCBuiltinIdTy, BuiltinType::ObjCId);
226  InitBuiltinType(ObjCBuiltinClassTy, BuiltinType::ObjCClass);
227
228  ObjCConstantStringType = QualType();
229
230  // void * type
231  VoidPtrTy = getPointerType(VoidTy);
232
233  // nullptr type (C++0x 2.14.7)
234  InitBuiltinType(NullPtrTy,           BuiltinType::NullPtr);
235}
236
237MemberSpecializationInfo *
238ASTContext::getInstantiatedFromStaticDataMember(const VarDecl *Var) {
239  assert(Var->isStaticDataMember() && "Not a static data member");
240  llvm::DenseMap<const VarDecl *, MemberSpecializationInfo *>::iterator Pos
241    = InstantiatedFromStaticDataMember.find(Var);
242  if (Pos == InstantiatedFromStaticDataMember.end())
243    return 0;
244
245  return Pos->second;
246}
247
248void
249ASTContext::setInstantiatedFromStaticDataMember(VarDecl *Inst, VarDecl *Tmpl,
250                                                TemplateSpecializationKind TSK) {
251  assert(Inst->isStaticDataMember() && "Not a static data member");
252  assert(Tmpl->isStaticDataMember() && "Not a static data member");
253  assert(!InstantiatedFromStaticDataMember[Inst] &&
254         "Already noted what static data member was instantiated from");
255  InstantiatedFromStaticDataMember[Inst]
256    = new (*this) MemberSpecializationInfo(Tmpl, TSK);
257}
258
259UnresolvedUsingDecl *
260ASTContext::getInstantiatedFromUnresolvedUsingDecl(UsingDecl *UUD) {
261  llvm::DenseMap<UsingDecl *, UnresolvedUsingDecl *>::iterator Pos
262    = InstantiatedFromUnresolvedUsingDecl.find(UUD);
263  if (Pos == InstantiatedFromUnresolvedUsingDecl.end())
264    return 0;
265
266  return Pos->second;
267}
268
269void
270ASTContext::setInstantiatedFromUnresolvedUsingDecl(UsingDecl *UD,
271                                                   UnresolvedUsingDecl *UUD) {
272  assert(!InstantiatedFromUnresolvedUsingDecl[UD] &&
273         "Already noted what using decl what instantiated from");
274  InstantiatedFromUnresolvedUsingDecl[UD] = UUD;
275}
276
277FieldDecl *ASTContext::getInstantiatedFromUnnamedFieldDecl(FieldDecl *Field) {
278  llvm::DenseMap<FieldDecl *, FieldDecl *>::iterator Pos
279    = InstantiatedFromUnnamedFieldDecl.find(Field);
280  if (Pos == InstantiatedFromUnnamedFieldDecl.end())
281    return 0;
282
283  return Pos->second;
284}
285
286void ASTContext::setInstantiatedFromUnnamedFieldDecl(FieldDecl *Inst,
287                                                     FieldDecl *Tmpl) {
288  assert(!Inst->getDeclName() && "Instantiated field decl is not unnamed");
289  assert(!Tmpl->getDeclName() && "Template field decl is not unnamed");
290  assert(!InstantiatedFromUnnamedFieldDecl[Inst] &&
291         "Already noted what unnamed field was instantiated from");
292
293  InstantiatedFromUnnamedFieldDecl[Inst] = Tmpl;
294}
295
296namespace {
297  class BeforeInTranslationUnit
298    : std::binary_function<SourceRange, SourceRange, bool> {
299    SourceManager *SourceMgr;
300
301  public:
302    explicit BeforeInTranslationUnit(SourceManager *SM) : SourceMgr(SM) { }
303
304    bool operator()(SourceRange X, SourceRange Y) {
305      return SourceMgr->isBeforeInTranslationUnit(X.getBegin(), Y.getBegin());
306    }
307  };
308}
309
310/// \brief Determine whether the given comment is a Doxygen-style comment.
311///
312/// \param Start the start of the comment text.
313///
314/// \param End the end of the comment text.
315///
316/// \param Member whether we want to check whether this is a member comment
317/// (which requires a < after the Doxygen-comment delimiter). Otherwise,
318/// we only return true when we find a non-member comment.
319static bool
320isDoxygenComment(SourceManager &SourceMgr, SourceRange Comment,
321                 bool Member = false) {
322  const char *BufferStart
323    = SourceMgr.getBufferData(SourceMgr.getFileID(Comment.getBegin())).first;
324  const char *Start = BufferStart + SourceMgr.getFileOffset(Comment.getBegin());
325  const char* End = BufferStart + SourceMgr.getFileOffset(Comment.getEnd());
326
327  if (End - Start < 4)
328    return false;
329
330  assert(Start[0] == '/' && "Not a comment?");
331  if (Start[1] == '*' && !(Start[2] == '!' || Start[2] == '*'))
332    return false;
333  if (Start[1] == '/' && !(Start[2] == '!' || Start[2] == '/'))
334    return false;
335
336  return (Start[3] == '<') == Member;
337}
338
339/// \brief Retrieve the comment associated with the given declaration, if
340/// it has one.
341const char *ASTContext::getCommentForDecl(const Decl *D) {
342  if (!D)
343    return 0;
344
345  // Check whether we have cached a comment string for this declaration
346  // already.
347  llvm::DenseMap<const Decl *, std::string>::iterator Pos
348    = DeclComments.find(D);
349  if (Pos != DeclComments.end())
350    return Pos->second.c_str();
351
352  // If we have an external AST source and have not yet loaded comments from
353  // that source, do so now.
354  if (ExternalSource && !LoadedExternalComments) {
355    std::vector<SourceRange> LoadedComments;
356    ExternalSource->ReadComments(LoadedComments);
357
358    if (!LoadedComments.empty())
359      Comments.insert(Comments.begin(), LoadedComments.begin(),
360                      LoadedComments.end());
361
362    LoadedExternalComments = true;
363  }
364
365  // If there are no comments anywhere, we won't find anything.
366  if (Comments.empty())
367    return 0;
368
369  // If the declaration doesn't map directly to a location in a file, we
370  // can't find the comment.
371  SourceLocation DeclStartLoc = D->getLocStart();
372  if (DeclStartLoc.isInvalid() || !DeclStartLoc.isFileID())
373    return 0;
374
375  // Find the comment that occurs just before this declaration.
376  std::vector<SourceRange>::iterator LastComment
377    = std::lower_bound(Comments.begin(), Comments.end(),
378                       SourceRange(DeclStartLoc),
379                       BeforeInTranslationUnit(&SourceMgr));
380
381  // Decompose the location for the start of the declaration and find the
382  // beginning of the file buffer.
383  std::pair<FileID, unsigned> DeclStartDecomp
384    = SourceMgr.getDecomposedLoc(DeclStartLoc);
385  const char *FileBufferStart
386    = SourceMgr.getBufferData(DeclStartDecomp.first).first;
387
388  // First check whether we have a comment for a member.
389  if (LastComment != Comments.end() &&
390      !isa<TagDecl>(D) && !isa<NamespaceDecl>(D) &&
391      isDoxygenComment(SourceMgr, *LastComment, true)) {
392    std::pair<FileID, unsigned> LastCommentEndDecomp
393      = SourceMgr.getDecomposedLoc(LastComment->getEnd());
394    if (DeclStartDecomp.first == LastCommentEndDecomp.first &&
395        SourceMgr.getLineNumber(DeclStartDecomp.first, DeclStartDecomp.second)
396          == SourceMgr.getLineNumber(LastCommentEndDecomp.first,
397                                     LastCommentEndDecomp.second)) {
398      // The Doxygen member comment comes after the declaration starts and
399      // is on the same line and in the same file as the declaration. This
400      // is the comment we want.
401      std::string &Result = DeclComments[D];
402      Result.append(FileBufferStart +
403                      SourceMgr.getFileOffset(LastComment->getBegin()),
404                    FileBufferStart + LastCommentEndDecomp.second + 1);
405      return Result.c_str();
406    }
407  }
408
409  if (LastComment == Comments.begin())
410    return 0;
411  --LastComment;
412
413  // Decompose the end of the comment.
414  std::pair<FileID, unsigned> LastCommentEndDecomp
415    = SourceMgr.getDecomposedLoc(LastComment->getEnd());
416
417  // If the comment and the declaration aren't in the same file, then they
418  // aren't related.
419  if (DeclStartDecomp.first != LastCommentEndDecomp.first)
420    return 0;
421
422  // Check that we actually have a Doxygen comment.
423  if (!isDoxygenComment(SourceMgr, *LastComment))
424    return 0;
425
426  // Compute the starting line for the declaration and for the end of the
427  // comment (this is expensive).
428  unsigned DeclStartLine
429    = SourceMgr.getLineNumber(DeclStartDecomp.first, DeclStartDecomp.second);
430  unsigned CommentEndLine
431    = SourceMgr.getLineNumber(LastCommentEndDecomp.first,
432                              LastCommentEndDecomp.second);
433
434  // If the comment does not end on the line prior to the declaration, then
435  // the comment is not associated with the declaration at all.
436  if (CommentEndLine + 1 != DeclStartLine)
437    return 0;
438
439  // We have a comment, but there may be more comments on the previous lines.
440  // Keep looking so long as the comments are still Doxygen comments and are
441  // still adjacent.
442  unsigned ExpectedLine
443    = SourceMgr.getSpellingLineNumber(LastComment->getBegin()) - 1;
444  std::vector<SourceRange>::iterator FirstComment = LastComment;
445  while (FirstComment != Comments.begin()) {
446    // Look at the previous comment
447    --FirstComment;
448    std::pair<FileID, unsigned> Decomp
449      = SourceMgr.getDecomposedLoc(FirstComment->getEnd());
450
451    // If this previous comment is in a different file, we're done.
452    if (Decomp.first != DeclStartDecomp.first) {
453      ++FirstComment;
454      break;
455    }
456
457    // If this comment is not a Doxygen comment, we're done.
458    if (!isDoxygenComment(SourceMgr, *FirstComment)) {
459      ++FirstComment;
460      break;
461    }
462
463    // If the line number is not what we expected, we're done.
464    unsigned Line = SourceMgr.getLineNumber(Decomp.first, Decomp.second);
465    if (Line != ExpectedLine) {
466      ++FirstComment;
467      break;
468    }
469
470    // Set the next expected line number.
471    ExpectedLine
472      = SourceMgr.getSpellingLineNumber(FirstComment->getBegin()) - 1;
473  }
474
475  // The iterator range [FirstComment, LastComment] contains all of the
476  // BCPL comments that, together, are associated with this declaration.
477  // Form a single comment block string for this declaration that concatenates
478  // all of these comments.
479  std::string &Result = DeclComments[D];
480  while (FirstComment != LastComment) {
481    std::pair<FileID, unsigned> DecompStart
482      = SourceMgr.getDecomposedLoc(FirstComment->getBegin());
483    std::pair<FileID, unsigned> DecompEnd
484      = SourceMgr.getDecomposedLoc(FirstComment->getEnd());
485    Result.append(FileBufferStart + DecompStart.second,
486                  FileBufferStart + DecompEnd.second + 1);
487    ++FirstComment;
488  }
489
490  // Append the last comment line.
491  Result.append(FileBufferStart +
492                  SourceMgr.getFileOffset(LastComment->getBegin()),
493                FileBufferStart + LastCommentEndDecomp.second + 1);
494  return Result.c_str();
495}
496
497//===----------------------------------------------------------------------===//
498//                         Type Sizing and Analysis
499//===----------------------------------------------------------------------===//
500
501/// getFloatTypeSemantics - Return the APFloat 'semantics' for the specified
502/// scalar floating point type.
503const llvm::fltSemantics &ASTContext::getFloatTypeSemantics(QualType T) const {
504  const BuiltinType *BT = T->getAs<BuiltinType>();
505  assert(BT && "Not a floating point type!");
506  switch (BT->getKind()) {
507  default: assert(0 && "Not a floating point type!");
508  case BuiltinType::Float:      return Target.getFloatFormat();
509  case BuiltinType::Double:     return Target.getDoubleFormat();
510  case BuiltinType::LongDouble: return Target.getLongDoubleFormat();
511  }
512}
513
514/// getDeclAlignInBytes - Return a conservative estimate of the alignment of the
515/// specified decl.  Note that bitfields do not have a valid alignment, so
516/// this method will assert on them.
517unsigned ASTContext::getDeclAlignInBytes(const Decl *D) {
518  unsigned Align = Target.getCharWidth();
519
520  if (const AlignedAttr* AA = D->getAttr<AlignedAttr>())
521    Align = std::max(Align, AA->getAlignment());
522
523  if (const ValueDecl *VD = dyn_cast<ValueDecl>(D)) {
524    QualType T = VD->getType();
525    if (const ReferenceType* RT = T->getAs<ReferenceType>()) {
526      unsigned AS = RT->getPointeeType().getAddressSpace();
527      Align = Target.getPointerAlign(AS);
528    } else if (!T->isIncompleteType() && !T->isFunctionType()) {
529      // Incomplete or function types default to 1.
530      while (isa<VariableArrayType>(T) || isa<IncompleteArrayType>(T))
531        T = cast<ArrayType>(T)->getElementType();
532
533      Align = std::max(Align, getPreferredTypeAlign(T.getTypePtr()));
534    }
535  }
536
537  return Align / Target.getCharWidth();
538}
539
540/// getTypeSize - Return the size of the specified type, in bits.  This method
541/// does not work on incomplete types.
542///
543/// FIXME: Pointers into different addr spaces could have different sizes and
544/// alignment requirements: getPointerInfo should take an AddrSpace, this
545/// should take a QualType, &c.
546std::pair<uint64_t, unsigned>
547ASTContext::getTypeInfo(const Type *T) {
548  uint64_t Width=0;
549  unsigned Align=8;
550  switch (T->getTypeClass()) {
551#define TYPE(Class, Base)
552#define ABSTRACT_TYPE(Class, Base)
553#define NON_CANONICAL_TYPE(Class, Base)
554#define DEPENDENT_TYPE(Class, Base) case Type::Class:
555#include "clang/AST/TypeNodes.def"
556    assert(false && "Should not see dependent types");
557    break;
558
559  case Type::FunctionNoProto:
560  case Type::FunctionProto:
561    // GCC extension: alignof(function) = 32 bits
562    Width = 0;
563    Align = 32;
564    break;
565
566  case Type::IncompleteArray:
567  case Type::VariableArray:
568    Width = 0;
569    Align = getTypeAlign(cast<ArrayType>(T)->getElementType());
570    break;
571
572  case Type::ConstantArray: {
573    const ConstantArrayType *CAT = cast<ConstantArrayType>(T);
574
575    std::pair<uint64_t, unsigned> EltInfo = getTypeInfo(CAT->getElementType());
576    Width = EltInfo.first*CAT->getSize().getZExtValue();
577    Align = EltInfo.second;
578    break;
579  }
580  case Type::ExtVector:
581  case Type::Vector: {
582    const VectorType *VT = cast<VectorType>(T);
583    std::pair<uint64_t, unsigned> EltInfo = getTypeInfo(VT->getElementType());
584    Width = EltInfo.first*VT->getNumElements();
585    Align = Width;
586    // If the alignment is not a power of 2, round up to the next power of 2.
587    // This happens for non-power-of-2 length vectors.
588    if (VT->getNumElements() & (VT->getNumElements()-1)) {
589      Align = llvm::NextPowerOf2(Align);
590      Width = llvm::RoundUpToAlignment(Width, Align);
591    }
592    break;
593  }
594
595  case Type::Builtin:
596    switch (cast<BuiltinType>(T)->getKind()) {
597    default: assert(0 && "Unknown builtin type!");
598    case BuiltinType::Void:
599      // GCC extension: alignof(void) = 8 bits.
600      Width = 0;
601      Align = 8;
602      break;
603
604    case BuiltinType::Bool:
605      Width = Target.getBoolWidth();
606      Align = Target.getBoolAlign();
607      break;
608    case BuiltinType::Char_S:
609    case BuiltinType::Char_U:
610    case BuiltinType::UChar:
611    case BuiltinType::SChar:
612      Width = Target.getCharWidth();
613      Align = Target.getCharAlign();
614      break;
615    case BuiltinType::WChar:
616      Width = Target.getWCharWidth();
617      Align = Target.getWCharAlign();
618      break;
619    case BuiltinType::Char16:
620      Width = Target.getChar16Width();
621      Align = Target.getChar16Align();
622      break;
623    case BuiltinType::Char32:
624      Width = Target.getChar32Width();
625      Align = Target.getChar32Align();
626      break;
627    case BuiltinType::UShort:
628    case BuiltinType::Short:
629      Width = Target.getShortWidth();
630      Align = Target.getShortAlign();
631      break;
632    case BuiltinType::UInt:
633    case BuiltinType::Int:
634      Width = Target.getIntWidth();
635      Align = Target.getIntAlign();
636      break;
637    case BuiltinType::ULong:
638    case BuiltinType::Long:
639      Width = Target.getLongWidth();
640      Align = Target.getLongAlign();
641      break;
642    case BuiltinType::ULongLong:
643    case BuiltinType::LongLong:
644      Width = Target.getLongLongWidth();
645      Align = Target.getLongLongAlign();
646      break;
647    case BuiltinType::Int128:
648    case BuiltinType::UInt128:
649      Width = 128;
650      Align = 128; // int128_t is 128-bit aligned on all targets.
651      break;
652    case BuiltinType::Float:
653      Width = Target.getFloatWidth();
654      Align = Target.getFloatAlign();
655      break;
656    case BuiltinType::Double:
657      Width = Target.getDoubleWidth();
658      Align = Target.getDoubleAlign();
659      break;
660    case BuiltinType::LongDouble:
661      Width = Target.getLongDoubleWidth();
662      Align = Target.getLongDoubleAlign();
663      break;
664    case BuiltinType::NullPtr:
665      Width = Target.getPointerWidth(0); // C++ 3.9.1p11: sizeof(nullptr_t)
666      Align = Target.getPointerAlign(0); //   == sizeof(void*)
667      break;
668    }
669    break;
670  case Type::FixedWidthInt:
671    // FIXME: This isn't precisely correct; the width/alignment should depend
672    // on the available types for the target
673    Width = cast<FixedWidthIntType>(T)->getWidth();
674    Width = std::max(llvm::NextPowerOf2(Width - 1), (uint64_t)8);
675    Align = Width;
676    break;
677  case Type::ObjCObjectPointer:
678    Width = Target.getPointerWidth(0);
679    Align = Target.getPointerAlign(0);
680    break;
681  case Type::BlockPointer: {
682    unsigned AS = cast<BlockPointerType>(T)->getPointeeType().getAddressSpace();
683    Width = Target.getPointerWidth(AS);
684    Align = Target.getPointerAlign(AS);
685    break;
686  }
687  case Type::Pointer: {
688    unsigned AS = cast<PointerType>(T)->getPointeeType().getAddressSpace();
689    Width = Target.getPointerWidth(AS);
690    Align = Target.getPointerAlign(AS);
691    break;
692  }
693  case Type::LValueReference:
694  case Type::RValueReference:
695    // "When applied to a reference or a reference type, the result is the size
696    // of the referenced type." C++98 5.3.3p2: expr.sizeof.
697    // FIXME: This is wrong for struct layout: a reference in a struct has
698    // pointer size.
699    return getTypeInfo(cast<ReferenceType>(T)->getPointeeType());
700  case Type::MemberPointer: {
701    // FIXME: This is ABI dependent. We use the Itanium C++ ABI.
702    // http://www.codesourcery.com/public/cxx-abi/abi.html#member-pointers
703    // If we ever want to support other ABIs this needs to be abstracted.
704
705    QualType Pointee = cast<MemberPointerType>(T)->getPointeeType();
706    std::pair<uint64_t, unsigned> PtrDiffInfo =
707      getTypeInfo(getPointerDiffType());
708    Width = PtrDiffInfo.first;
709    if (Pointee->isFunctionType())
710      Width *= 2;
711    Align = PtrDiffInfo.second;
712    break;
713  }
714  case Type::Complex: {
715    // Complex types have the same alignment as their elements, but twice the
716    // size.
717    std::pair<uint64_t, unsigned> EltInfo =
718      getTypeInfo(cast<ComplexType>(T)->getElementType());
719    Width = EltInfo.first*2;
720    Align = EltInfo.second;
721    break;
722  }
723  case Type::ObjCInterface: {
724    const ObjCInterfaceType *ObjCI = cast<ObjCInterfaceType>(T);
725    const ASTRecordLayout &Layout = getASTObjCInterfaceLayout(ObjCI->getDecl());
726    Width = Layout.getSize();
727    Align = Layout.getAlignment();
728    break;
729  }
730  case Type::Record:
731  case Type::Enum: {
732    const TagType *TT = cast<TagType>(T);
733
734    if (TT->getDecl()->isInvalidDecl()) {
735      Width = 1;
736      Align = 1;
737      break;
738    }
739
740    if (const EnumType *ET = dyn_cast<EnumType>(TT))
741      return getTypeInfo(ET->getDecl()->getIntegerType());
742
743    const RecordType *RT = cast<RecordType>(TT);
744    const ASTRecordLayout &Layout = getASTRecordLayout(RT->getDecl());
745    Width = Layout.getSize();
746    Align = Layout.getAlignment();
747    break;
748  }
749
750  case Type::SubstTemplateTypeParm:
751    return getTypeInfo(cast<SubstTemplateTypeParmType>(T)->
752                       getReplacementType().getTypePtr());
753
754  case Type::Elaborated:
755    return getTypeInfo(cast<ElaboratedType>(T)->getUnderlyingType()
756                         .getTypePtr());
757
758  case Type::Typedef: {
759    const TypedefDecl *Typedef = cast<TypedefType>(T)->getDecl();
760    if (const AlignedAttr *Aligned = Typedef->getAttr<AlignedAttr>()) {
761      Align = Aligned->getAlignment();
762      Width = getTypeSize(Typedef->getUnderlyingType().getTypePtr());
763    } else
764      return getTypeInfo(Typedef->getUnderlyingType().getTypePtr());
765    break;
766  }
767
768  case Type::TypeOfExpr:
769    return getTypeInfo(cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType()
770                         .getTypePtr());
771
772  case Type::TypeOf:
773    return getTypeInfo(cast<TypeOfType>(T)->getUnderlyingType().getTypePtr());
774
775  case Type::Decltype:
776    return getTypeInfo(cast<DecltypeType>(T)->getUnderlyingExpr()->getType()
777                        .getTypePtr());
778
779  case Type::QualifiedName:
780    return getTypeInfo(cast<QualifiedNameType>(T)->getNamedType().getTypePtr());
781
782  case Type::TemplateSpecialization:
783    assert(getCanonicalType(T) != T &&
784           "Cannot request the size of a dependent type");
785    // FIXME: this is likely to be wrong once we support template
786    // aliases, since a template alias could refer to a typedef that
787    // has an __aligned__ attribute on it.
788    return getTypeInfo(getCanonicalType(T));
789  }
790
791  assert(Align && (Align & (Align-1)) == 0 && "Alignment must be power of 2");
792  return std::make_pair(Width, Align);
793}
794
795/// getPreferredTypeAlign - Return the "preferred" alignment of the specified
796/// type for the current target in bits.  This can be different than the ABI
797/// alignment in cases where it is beneficial for performance to overalign
798/// a data type.
799unsigned ASTContext::getPreferredTypeAlign(const Type *T) {
800  unsigned ABIAlign = getTypeAlign(T);
801
802  // Double and long long should be naturally aligned if possible.
803  if (const ComplexType* CT = T->getAs<ComplexType>())
804    T = CT->getElementType().getTypePtr();
805  if (T->isSpecificBuiltinType(BuiltinType::Double) ||
806      T->isSpecificBuiltinType(BuiltinType::LongLong))
807    return std::max(ABIAlign, (unsigned)getTypeSize(T));
808
809  return ABIAlign;
810}
811
812static void CollectLocalObjCIvars(ASTContext *Ctx,
813                                  const ObjCInterfaceDecl *OI,
814                                  llvm::SmallVectorImpl<FieldDecl*> &Fields) {
815  for (ObjCInterfaceDecl::ivar_iterator I = OI->ivar_begin(),
816       E = OI->ivar_end(); I != E; ++I) {
817    ObjCIvarDecl *IVDecl = *I;
818    if (!IVDecl->isInvalidDecl())
819      Fields.push_back(cast<FieldDecl>(IVDecl));
820  }
821}
822
823void ASTContext::CollectObjCIvars(const ObjCInterfaceDecl *OI,
824                             llvm::SmallVectorImpl<FieldDecl*> &Fields) {
825  if (const ObjCInterfaceDecl *SuperClass = OI->getSuperClass())
826    CollectObjCIvars(SuperClass, Fields);
827  CollectLocalObjCIvars(this, OI, Fields);
828}
829
830/// ShallowCollectObjCIvars -
831/// Collect all ivars, including those synthesized, in the current class.
832///
833void ASTContext::ShallowCollectObjCIvars(const ObjCInterfaceDecl *OI,
834                                 llvm::SmallVectorImpl<ObjCIvarDecl*> &Ivars,
835                                 bool CollectSynthesized) {
836  for (ObjCInterfaceDecl::ivar_iterator I = OI->ivar_begin(),
837         E = OI->ivar_end(); I != E; ++I) {
838     Ivars.push_back(*I);
839  }
840  if (CollectSynthesized)
841    CollectSynthesizedIvars(OI, Ivars);
842}
843
844void ASTContext::CollectProtocolSynthesizedIvars(const ObjCProtocolDecl *PD,
845                                llvm::SmallVectorImpl<ObjCIvarDecl*> &Ivars) {
846  for (ObjCContainerDecl::prop_iterator I = PD->prop_begin(),
847       E = PD->prop_end(); I != E; ++I)
848    if (ObjCIvarDecl *Ivar = (*I)->getPropertyIvarDecl())
849      Ivars.push_back(Ivar);
850
851  // Also look into nested protocols.
852  for (ObjCProtocolDecl::protocol_iterator P = PD->protocol_begin(),
853       E = PD->protocol_end(); P != E; ++P)
854    CollectProtocolSynthesizedIvars(*P, Ivars);
855}
856
857/// CollectSynthesizedIvars -
858/// This routine collect synthesized ivars for the designated class.
859///
860void ASTContext::CollectSynthesizedIvars(const ObjCInterfaceDecl *OI,
861                                llvm::SmallVectorImpl<ObjCIvarDecl*> &Ivars) {
862  for (ObjCInterfaceDecl::prop_iterator I = OI->prop_begin(),
863       E = OI->prop_end(); I != E; ++I) {
864    if (ObjCIvarDecl *Ivar = (*I)->getPropertyIvarDecl())
865      Ivars.push_back(Ivar);
866  }
867  // Also look into interface's protocol list for properties declared
868  // in the protocol and whose ivars are synthesized.
869  for (ObjCInterfaceDecl::protocol_iterator P = OI->protocol_begin(),
870       PE = OI->protocol_end(); P != PE; ++P) {
871    ObjCProtocolDecl *PD = (*P);
872    CollectProtocolSynthesizedIvars(PD, Ivars);
873  }
874}
875
876/// CollectInheritedProtocols - Collect all protocols in current class and
877/// those inherited by it.
878void ASTContext::CollectInheritedProtocols(const Decl *CDecl,
879                          llvm::SmallVectorImpl<ObjCProtocolDecl*> &Protocols) {
880  if (const ObjCInterfaceDecl *OI = dyn_cast<ObjCInterfaceDecl>(CDecl)) {
881    for (ObjCInterfaceDecl::protocol_iterator P = OI->protocol_begin(),
882         PE = OI->protocol_end(); P != PE; ++P) {
883      ObjCProtocolDecl *Proto = (*P);
884      Protocols.push_back(Proto);
885      for (ObjCProtocolDecl::protocol_iterator P = Proto->protocol_begin(),
886           PE = Proto->protocol_end(); P != PE; ++P)
887        CollectInheritedProtocols(*P, Protocols);
888      }
889
890    // Categories of this Interface.
891    for (const ObjCCategoryDecl *CDeclChain = OI->getCategoryList();
892         CDeclChain; CDeclChain = CDeclChain->getNextClassCategory())
893      CollectInheritedProtocols(CDeclChain, Protocols);
894    if (ObjCInterfaceDecl *SD = OI->getSuperClass())
895      while (SD) {
896        CollectInheritedProtocols(SD, Protocols);
897        SD = SD->getSuperClass();
898      }
899    return;
900  }
901  if (const ObjCCategoryDecl *OC = dyn_cast<ObjCCategoryDecl>(CDecl)) {
902    for (ObjCInterfaceDecl::protocol_iterator P = OC->protocol_begin(),
903         PE = OC->protocol_end(); P != PE; ++P) {
904      ObjCProtocolDecl *Proto = (*P);
905      Protocols.push_back(Proto);
906      for (ObjCProtocolDecl::protocol_iterator P = Proto->protocol_begin(),
907           PE = Proto->protocol_end(); P != PE; ++P)
908        CollectInheritedProtocols(*P, Protocols);
909    }
910    return;
911  }
912  if (const ObjCProtocolDecl *OP = dyn_cast<ObjCProtocolDecl>(CDecl)) {
913    for (ObjCProtocolDecl::protocol_iterator P = OP->protocol_begin(),
914         PE = OP->protocol_end(); P != PE; ++P) {
915      ObjCProtocolDecl *Proto = (*P);
916      Protocols.push_back(Proto);
917      for (ObjCProtocolDecl::protocol_iterator P = Proto->protocol_begin(),
918           PE = Proto->protocol_end(); P != PE; ++P)
919        CollectInheritedProtocols(*P, Protocols);
920    }
921    return;
922  }
923}
924
925unsigned ASTContext::CountProtocolSynthesizedIvars(const ObjCProtocolDecl *PD) {
926  unsigned count = 0;
927  for (ObjCContainerDecl::prop_iterator I = PD->prop_begin(),
928       E = PD->prop_end(); I != E; ++I)
929    if ((*I)->getPropertyIvarDecl())
930      ++count;
931
932  // Also look into nested protocols.
933  for (ObjCProtocolDecl::protocol_iterator P = PD->protocol_begin(),
934       E = PD->protocol_end(); P != E; ++P)
935    count += CountProtocolSynthesizedIvars(*P);
936  return count;
937}
938
939unsigned ASTContext::CountSynthesizedIvars(const ObjCInterfaceDecl *OI) {
940  unsigned count = 0;
941  for (ObjCInterfaceDecl::prop_iterator I = OI->prop_begin(),
942       E = OI->prop_end(); I != E; ++I) {
943    if ((*I)->getPropertyIvarDecl())
944      ++count;
945  }
946  // Also look into interface's protocol list for properties declared
947  // in the protocol and whose ivars are synthesized.
948  for (ObjCInterfaceDecl::protocol_iterator P = OI->protocol_begin(),
949       PE = OI->protocol_end(); P != PE; ++P) {
950    ObjCProtocolDecl *PD = (*P);
951    count += CountProtocolSynthesizedIvars(PD);
952  }
953  return count;
954}
955
956/// \brief Get the implementation of ObjCInterfaceDecl,or NULL if none exists.
957ObjCImplementationDecl *ASTContext::getObjCImplementation(ObjCInterfaceDecl *D) {
958  llvm::DenseMap<ObjCContainerDecl*, ObjCImplDecl*>::iterator
959    I = ObjCImpls.find(D);
960  if (I != ObjCImpls.end())
961    return cast<ObjCImplementationDecl>(I->second);
962  return 0;
963}
964/// \brief Get the implementation of ObjCCategoryDecl, or NULL if none exists.
965ObjCCategoryImplDecl *ASTContext::getObjCImplementation(ObjCCategoryDecl *D) {
966  llvm::DenseMap<ObjCContainerDecl*, ObjCImplDecl*>::iterator
967    I = ObjCImpls.find(D);
968  if (I != ObjCImpls.end())
969    return cast<ObjCCategoryImplDecl>(I->second);
970  return 0;
971}
972
973/// \brief Set the implementation of ObjCInterfaceDecl.
974void ASTContext::setObjCImplementation(ObjCInterfaceDecl *IFaceD,
975                           ObjCImplementationDecl *ImplD) {
976  assert(IFaceD && ImplD && "Passed null params");
977  ObjCImpls[IFaceD] = ImplD;
978}
979/// \brief Set the implementation of ObjCCategoryDecl.
980void ASTContext::setObjCImplementation(ObjCCategoryDecl *CatD,
981                           ObjCCategoryImplDecl *ImplD) {
982  assert(CatD && ImplD && "Passed null params");
983  ObjCImpls[CatD] = ImplD;
984}
985
986/// \brief Allocate an uninitialized DeclaratorInfo.
987///
988/// The caller should initialize the memory held by DeclaratorInfo using
989/// the TypeLoc wrappers.
990///
991/// \param T the type that will be the basis for type source info. This type
992/// should refer to how the declarator was written in source code, not to
993/// what type semantic analysis resolved the declarator to.
994DeclaratorInfo *ASTContext::CreateDeclaratorInfo(QualType T,
995                                                 unsigned DataSize) {
996  if (!DataSize)
997    DataSize = TypeLoc::getFullDataSizeForType(T);
998  else
999    assert(DataSize == TypeLoc::getFullDataSizeForType(T) &&
1000           "incorrect data size provided to CreateDeclaratorInfo!");
1001
1002  DeclaratorInfo *DInfo =
1003    (DeclaratorInfo*)BumpAlloc.Allocate(sizeof(DeclaratorInfo) + DataSize, 8);
1004  new (DInfo) DeclaratorInfo(T);
1005  return DInfo;
1006}
1007
1008DeclaratorInfo *ASTContext::getTrivialDeclaratorInfo(QualType T,
1009                                                     SourceLocation L) {
1010  DeclaratorInfo *DI = CreateDeclaratorInfo(T);
1011  DI->getTypeLoc().initialize(L);
1012  return DI;
1013}
1014
1015/// getInterfaceLayoutImpl - Get or compute information about the
1016/// layout of the given interface.
1017///
1018/// \param Impl - If given, also include the layout of the interface's
1019/// implementation. This may differ by including synthesized ivars.
1020const ASTRecordLayout &
1021ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
1022                          const ObjCImplementationDecl *Impl) {
1023  assert(!D->isForwardDecl() && "Invalid interface decl!");
1024
1025  // Look up this layout, if already laid out, return what we have.
1026  ObjCContainerDecl *Key =
1027    Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1028  if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1029    return *Entry;
1030
1031  // Add in synthesized ivar count if laying out an implementation.
1032  if (Impl) {
1033    unsigned FieldCount = D->ivar_size();
1034    unsigned SynthCount = CountSynthesizedIvars(D);
1035    FieldCount += SynthCount;
1036    // If there aren't any sythesized ivars then reuse the interface
1037    // entry. Note we can't cache this because we simply free all
1038    // entries later; however we shouldn't look up implementations
1039    // frequently.
1040    if (SynthCount == 0)
1041      return getObjCLayout(D, 0);
1042  }
1043
1044  const ASTRecordLayout *NewEntry =
1045    ASTRecordLayoutBuilder::ComputeLayout(*this, D, Impl);
1046  ObjCLayouts[Key] = NewEntry;
1047
1048  return *NewEntry;
1049}
1050
1051const ASTRecordLayout &
1052ASTContext::getASTObjCInterfaceLayout(const ObjCInterfaceDecl *D) {
1053  return getObjCLayout(D, 0);
1054}
1055
1056const ASTRecordLayout &
1057ASTContext::getASTObjCImplementationLayout(const ObjCImplementationDecl *D) {
1058  return getObjCLayout(D->getClassInterface(), D);
1059}
1060
1061/// getASTRecordLayout - Get or compute information about the layout of the
1062/// specified record (struct/union/class), which indicates its size and field
1063/// position information.
1064const ASTRecordLayout &ASTContext::getASTRecordLayout(const RecordDecl *D) {
1065  D = D->getDefinition(*this);
1066  assert(D && "Cannot get layout of forward declarations!");
1067
1068  // Look up this layout, if already laid out, return what we have.
1069  // Note that we can't save a reference to the entry because this function
1070  // is recursive.
1071  const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1072  if (Entry) return *Entry;
1073
1074  const ASTRecordLayout *NewEntry =
1075    ASTRecordLayoutBuilder::ComputeLayout(*this, D);
1076  ASTRecordLayouts[D] = NewEntry;
1077
1078  return *NewEntry;
1079}
1080
1081//===----------------------------------------------------------------------===//
1082//                   Type creation/memoization methods
1083//===----------------------------------------------------------------------===//
1084
1085QualType ASTContext::getExtQualType(const Type *TypeNode, Qualifiers Quals) {
1086  unsigned Fast = Quals.getFastQualifiers();
1087  Quals.removeFastQualifiers();
1088
1089  // Check if we've already instantiated this type.
1090  llvm::FoldingSetNodeID ID;
1091  ExtQuals::Profile(ID, TypeNode, Quals);
1092  void *InsertPos = 0;
1093  if (ExtQuals *EQ = ExtQualNodes.FindNodeOrInsertPos(ID, InsertPos)) {
1094    assert(EQ->getQualifiers() == Quals);
1095    QualType T = QualType(EQ, Fast);
1096    return T;
1097  }
1098
1099  ExtQuals *New = new (*this, TypeAlignment) ExtQuals(*this, TypeNode, Quals);
1100  ExtQualNodes.InsertNode(New, InsertPos);
1101  QualType T = QualType(New, Fast);
1102  return T;
1103}
1104
1105QualType ASTContext::getVolatileType(QualType T) {
1106  QualType CanT = getCanonicalType(T);
1107  if (CanT.isVolatileQualified()) return T;
1108
1109  QualifierCollector Quals;
1110  const Type *TypeNode = Quals.strip(T);
1111  Quals.addVolatile();
1112
1113  return getExtQualType(TypeNode, Quals);
1114}
1115
1116QualType ASTContext::getAddrSpaceQualType(QualType T, unsigned AddressSpace) {
1117  QualType CanT = getCanonicalType(T);
1118  if (CanT.getAddressSpace() == AddressSpace)
1119    return T;
1120
1121  // If we are composing extended qualifiers together, merge together
1122  // into one ExtQuals node.
1123  QualifierCollector Quals;
1124  const Type *TypeNode = Quals.strip(T);
1125
1126  // If this type already has an address space specified, it cannot get
1127  // another one.
1128  assert(!Quals.hasAddressSpace() &&
1129         "Type cannot be in multiple addr spaces!");
1130  Quals.addAddressSpace(AddressSpace);
1131
1132  return getExtQualType(TypeNode, Quals);
1133}
1134
1135QualType ASTContext::getObjCGCQualType(QualType T,
1136                                       Qualifiers::GC GCAttr) {
1137  QualType CanT = getCanonicalType(T);
1138  if (CanT.getObjCGCAttr() == GCAttr)
1139    return T;
1140
1141  if (T->isPointerType()) {
1142    QualType Pointee = T->getAs<PointerType>()->getPointeeType();
1143    if (Pointee->isAnyPointerType()) {
1144      QualType ResultType = getObjCGCQualType(Pointee, GCAttr);
1145      return getPointerType(ResultType);
1146    }
1147  }
1148
1149  // If we are composing extended qualifiers together, merge together
1150  // into one ExtQuals node.
1151  QualifierCollector Quals;
1152  const Type *TypeNode = Quals.strip(T);
1153
1154  // If this type already has an ObjCGC specified, it cannot get
1155  // another one.
1156  assert(!Quals.hasObjCGCAttr() &&
1157         "Type cannot have multiple ObjCGCs!");
1158  Quals.addObjCGCAttr(GCAttr);
1159
1160  return getExtQualType(TypeNode, Quals);
1161}
1162
1163QualType ASTContext::getNoReturnType(QualType T) {
1164  QualType ResultType;
1165  if (T->isPointerType()) {
1166    QualType Pointee = T->getAs<PointerType>()->getPointeeType();
1167    ResultType = getNoReturnType(Pointee);
1168    ResultType = getPointerType(ResultType);
1169  } else if (T->isBlockPointerType()) {
1170    QualType Pointee = T->getAs<BlockPointerType>()->getPointeeType();
1171    ResultType = getNoReturnType(Pointee);
1172    ResultType = getBlockPointerType(ResultType);
1173  } else {
1174    assert (T->isFunctionType()
1175            && "can't noreturn qualify non-pointer to function or block type");
1176
1177    if (const FunctionNoProtoType *FNPT = T->getAs<FunctionNoProtoType>()) {
1178      ResultType = getFunctionNoProtoType(FNPT->getResultType(), true);
1179    } else {
1180      const FunctionProtoType *F = T->getAs<FunctionProtoType>();
1181      ResultType
1182        = getFunctionType(F->getResultType(), F->arg_type_begin(),
1183                          F->getNumArgs(), F->isVariadic(), F->getTypeQuals(),
1184                          F->hasExceptionSpec(), F->hasAnyExceptionSpec(),
1185                          F->getNumExceptions(), F->exception_begin(), true);
1186    }
1187  }
1188
1189  return getQualifiedType(ResultType, T.getQualifiers());
1190}
1191
1192/// getComplexType - Return the uniqued reference to the type for a complex
1193/// number with the specified element type.
1194QualType ASTContext::getComplexType(QualType T) {
1195  // Unique pointers, to guarantee there is only one pointer of a particular
1196  // structure.
1197  llvm::FoldingSetNodeID ID;
1198  ComplexType::Profile(ID, T);
1199
1200  void *InsertPos = 0;
1201  if (ComplexType *CT = ComplexTypes.FindNodeOrInsertPos(ID, InsertPos))
1202    return QualType(CT, 0);
1203
1204  // If the pointee type isn't canonical, this won't be a canonical type either,
1205  // so fill in the canonical type field.
1206  QualType Canonical;
1207  if (!T.isCanonical()) {
1208    Canonical = getComplexType(getCanonicalType(T));
1209
1210    // Get the new insert position for the node we care about.
1211    ComplexType *NewIP = ComplexTypes.FindNodeOrInsertPos(ID, InsertPos);
1212    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1213  }
1214  ComplexType *New = new (*this, TypeAlignment) ComplexType(T, Canonical);
1215  Types.push_back(New);
1216  ComplexTypes.InsertNode(New, InsertPos);
1217  return QualType(New, 0);
1218}
1219
1220QualType ASTContext::getFixedWidthIntType(unsigned Width, bool Signed) {
1221  llvm::DenseMap<unsigned, FixedWidthIntType*> &Map = Signed ?
1222     SignedFixedWidthIntTypes : UnsignedFixedWidthIntTypes;
1223  FixedWidthIntType *&Entry = Map[Width];
1224  if (!Entry)
1225    Entry = new FixedWidthIntType(Width, Signed);
1226  return QualType(Entry, 0);
1227}
1228
1229/// getPointerType - Return the uniqued reference to the type for a pointer to
1230/// the specified type.
1231QualType ASTContext::getPointerType(QualType T) {
1232  // Unique pointers, to guarantee there is only one pointer of a particular
1233  // structure.
1234  llvm::FoldingSetNodeID ID;
1235  PointerType::Profile(ID, T);
1236
1237  void *InsertPos = 0;
1238  if (PointerType *PT = PointerTypes.FindNodeOrInsertPos(ID, InsertPos))
1239    return QualType(PT, 0);
1240
1241  // If the pointee type isn't canonical, this won't be a canonical type either,
1242  // so fill in the canonical type field.
1243  QualType Canonical;
1244  if (!T.isCanonical()) {
1245    Canonical = getPointerType(getCanonicalType(T));
1246
1247    // Get the new insert position for the node we care about.
1248    PointerType *NewIP = PointerTypes.FindNodeOrInsertPos(ID, InsertPos);
1249    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1250  }
1251  PointerType *New = new (*this, TypeAlignment) PointerType(T, Canonical);
1252  Types.push_back(New);
1253  PointerTypes.InsertNode(New, InsertPos);
1254  return QualType(New, 0);
1255}
1256
1257/// getBlockPointerType - Return the uniqued reference to the type for
1258/// a pointer to the specified block.
1259QualType ASTContext::getBlockPointerType(QualType T) {
1260  assert(T->isFunctionType() && "block of function types only");
1261  // Unique pointers, to guarantee there is only one block of a particular
1262  // structure.
1263  llvm::FoldingSetNodeID ID;
1264  BlockPointerType::Profile(ID, T);
1265
1266  void *InsertPos = 0;
1267  if (BlockPointerType *PT =
1268        BlockPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
1269    return QualType(PT, 0);
1270
1271  // If the block pointee type isn't canonical, this won't be a canonical
1272  // type either so fill in the canonical type field.
1273  QualType Canonical;
1274  if (!T.isCanonical()) {
1275    Canonical = getBlockPointerType(getCanonicalType(T));
1276
1277    // Get the new insert position for the node we care about.
1278    BlockPointerType *NewIP =
1279      BlockPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
1280    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1281  }
1282  BlockPointerType *New
1283    = new (*this, TypeAlignment) BlockPointerType(T, Canonical);
1284  Types.push_back(New);
1285  BlockPointerTypes.InsertNode(New, InsertPos);
1286  return QualType(New, 0);
1287}
1288
1289/// getLValueReferenceType - Return the uniqued reference to the type for an
1290/// lvalue reference to the specified type.
1291QualType ASTContext::getLValueReferenceType(QualType T, bool SpelledAsLValue) {
1292  // Unique pointers, to guarantee there is only one pointer of a particular
1293  // structure.
1294  llvm::FoldingSetNodeID ID;
1295  ReferenceType::Profile(ID, T, SpelledAsLValue);
1296
1297  void *InsertPos = 0;
1298  if (LValueReferenceType *RT =
1299        LValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos))
1300    return QualType(RT, 0);
1301
1302  const ReferenceType *InnerRef = T->getAs<ReferenceType>();
1303
1304  // If the referencee type isn't canonical, this won't be a canonical type
1305  // either, so fill in the canonical type field.
1306  QualType Canonical;
1307  if (!SpelledAsLValue || InnerRef || !T.isCanonical()) {
1308    QualType PointeeType = (InnerRef ? InnerRef->getPointeeType() : T);
1309    Canonical = getLValueReferenceType(getCanonicalType(PointeeType));
1310
1311    // Get the new insert position for the node we care about.
1312    LValueReferenceType *NewIP =
1313      LValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos);
1314    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1315  }
1316
1317  LValueReferenceType *New
1318    = new (*this, TypeAlignment) LValueReferenceType(T, Canonical,
1319                                                     SpelledAsLValue);
1320  Types.push_back(New);
1321  LValueReferenceTypes.InsertNode(New, InsertPos);
1322
1323  return QualType(New, 0);
1324}
1325
1326/// getRValueReferenceType - Return the uniqued reference to the type for an
1327/// rvalue reference to the specified type.
1328QualType ASTContext::getRValueReferenceType(QualType T) {
1329  // Unique pointers, to guarantee there is only one pointer of a particular
1330  // structure.
1331  llvm::FoldingSetNodeID ID;
1332  ReferenceType::Profile(ID, T, false);
1333
1334  void *InsertPos = 0;
1335  if (RValueReferenceType *RT =
1336        RValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos))
1337    return QualType(RT, 0);
1338
1339  const ReferenceType *InnerRef = T->getAs<ReferenceType>();
1340
1341  // If the referencee type isn't canonical, this won't be a canonical type
1342  // either, so fill in the canonical type field.
1343  QualType Canonical;
1344  if (InnerRef || !T.isCanonical()) {
1345    QualType PointeeType = (InnerRef ? InnerRef->getPointeeType() : T);
1346    Canonical = getRValueReferenceType(getCanonicalType(PointeeType));
1347
1348    // Get the new insert position for the node we care about.
1349    RValueReferenceType *NewIP =
1350      RValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos);
1351    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1352  }
1353
1354  RValueReferenceType *New
1355    = new (*this, TypeAlignment) RValueReferenceType(T, Canonical);
1356  Types.push_back(New);
1357  RValueReferenceTypes.InsertNode(New, InsertPos);
1358  return QualType(New, 0);
1359}
1360
1361/// getMemberPointerType - Return the uniqued reference to the type for a
1362/// member pointer to the specified type, in the specified class.
1363QualType ASTContext::getMemberPointerType(QualType T, const Type *Cls) {
1364  // Unique pointers, to guarantee there is only one pointer of a particular
1365  // structure.
1366  llvm::FoldingSetNodeID ID;
1367  MemberPointerType::Profile(ID, T, Cls);
1368
1369  void *InsertPos = 0;
1370  if (MemberPointerType *PT =
1371      MemberPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
1372    return QualType(PT, 0);
1373
1374  // If the pointee or class type isn't canonical, this won't be a canonical
1375  // type either, so fill in the canonical type field.
1376  QualType Canonical;
1377  if (!T.isCanonical() || !Cls->isCanonicalUnqualified()) {
1378    Canonical = getMemberPointerType(getCanonicalType(T),getCanonicalType(Cls));
1379
1380    // Get the new insert position for the node we care about.
1381    MemberPointerType *NewIP =
1382      MemberPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
1383    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1384  }
1385  MemberPointerType *New
1386    = new (*this, TypeAlignment) MemberPointerType(T, Cls, Canonical);
1387  Types.push_back(New);
1388  MemberPointerTypes.InsertNode(New, InsertPos);
1389  return QualType(New, 0);
1390}
1391
1392/// getConstantArrayType - Return the unique reference to the type for an
1393/// array of the specified element type.
1394QualType ASTContext::getConstantArrayType(QualType EltTy,
1395                                          const llvm::APInt &ArySizeIn,
1396                                          ArrayType::ArraySizeModifier ASM,
1397                                          unsigned EltTypeQuals) {
1398  assert((EltTy->isDependentType() ||
1399          EltTy->isIncompleteType() || EltTy->isConstantSizeType()) &&
1400         "Constant array of VLAs is illegal!");
1401
1402  // Convert the array size into a canonical width matching the pointer size for
1403  // the target.
1404  llvm::APInt ArySize(ArySizeIn);
1405  ArySize.zextOrTrunc(Target.getPointerWidth(EltTy.getAddressSpace()));
1406
1407  llvm::FoldingSetNodeID ID;
1408  ConstantArrayType::Profile(ID, EltTy, ArySize, ASM, EltTypeQuals);
1409
1410  void *InsertPos = 0;
1411  if (ConstantArrayType *ATP =
1412      ConstantArrayTypes.FindNodeOrInsertPos(ID, InsertPos))
1413    return QualType(ATP, 0);
1414
1415  // If the element type isn't canonical, this won't be a canonical type either,
1416  // so fill in the canonical type field.
1417  QualType Canonical;
1418  if (!EltTy.isCanonical()) {
1419    Canonical = getConstantArrayType(getCanonicalType(EltTy), ArySize,
1420                                     ASM, EltTypeQuals);
1421    // Get the new insert position for the node we care about.
1422    ConstantArrayType *NewIP =
1423      ConstantArrayTypes.FindNodeOrInsertPos(ID, InsertPos);
1424    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1425  }
1426
1427  ConstantArrayType *New = new(*this,TypeAlignment)
1428    ConstantArrayType(EltTy, Canonical, ArySize, ASM, EltTypeQuals);
1429  ConstantArrayTypes.InsertNode(New, InsertPos);
1430  Types.push_back(New);
1431  return QualType(New, 0);
1432}
1433
1434/// getVariableArrayType - Returns a non-unique reference to the type for a
1435/// variable array of the specified element type.
1436QualType ASTContext::getVariableArrayType(QualType EltTy,
1437                                          Expr *NumElts,
1438                                          ArrayType::ArraySizeModifier ASM,
1439                                          unsigned EltTypeQuals,
1440                                          SourceRange Brackets) {
1441  // Since we don't unique expressions, it isn't possible to unique VLA's
1442  // that have an expression provided for their size.
1443
1444  VariableArrayType *New = new(*this, TypeAlignment)
1445    VariableArrayType(EltTy, QualType(), NumElts, ASM, EltTypeQuals, Brackets);
1446
1447  VariableArrayTypes.push_back(New);
1448  Types.push_back(New);
1449  return QualType(New, 0);
1450}
1451
1452/// getDependentSizedArrayType - Returns a non-unique reference to
1453/// the type for a dependently-sized array of the specified element
1454/// type.
1455QualType ASTContext::getDependentSizedArrayType(QualType EltTy,
1456                                                Expr *NumElts,
1457                                                ArrayType::ArraySizeModifier ASM,
1458                                                unsigned EltTypeQuals,
1459                                                SourceRange Brackets) {
1460  assert((NumElts->isTypeDependent() || NumElts->isValueDependent()) &&
1461         "Size must be type- or value-dependent!");
1462
1463  llvm::FoldingSetNodeID ID;
1464  DependentSizedArrayType::Profile(ID, *this, getCanonicalType(EltTy), ASM,
1465                                   EltTypeQuals, NumElts);
1466
1467  void *InsertPos = 0;
1468  DependentSizedArrayType *Canon
1469    = DependentSizedArrayTypes.FindNodeOrInsertPos(ID, InsertPos);
1470  DependentSizedArrayType *New;
1471  if (Canon) {
1472    // We already have a canonical version of this array type; use it as
1473    // the canonical type for a newly-built type.
1474    New = new (*this, TypeAlignment)
1475      DependentSizedArrayType(*this, EltTy, QualType(Canon, 0),
1476                              NumElts, ASM, EltTypeQuals, Brackets);
1477  } else {
1478    QualType CanonEltTy = getCanonicalType(EltTy);
1479    if (CanonEltTy == EltTy) {
1480      New = new (*this, TypeAlignment)
1481        DependentSizedArrayType(*this, EltTy, QualType(),
1482                                NumElts, ASM, EltTypeQuals, Brackets);
1483      DependentSizedArrayTypes.InsertNode(New, InsertPos);
1484    } else {
1485      QualType Canon = getDependentSizedArrayType(CanonEltTy, NumElts,
1486                                                  ASM, EltTypeQuals,
1487                                                  SourceRange());
1488      New = new (*this, TypeAlignment)
1489        DependentSizedArrayType(*this, EltTy, Canon,
1490                                NumElts, ASM, EltTypeQuals, Brackets);
1491    }
1492  }
1493
1494  Types.push_back(New);
1495  return QualType(New, 0);
1496}
1497
1498QualType ASTContext::getIncompleteArrayType(QualType EltTy,
1499                                            ArrayType::ArraySizeModifier ASM,
1500                                            unsigned EltTypeQuals) {
1501  llvm::FoldingSetNodeID ID;
1502  IncompleteArrayType::Profile(ID, EltTy, ASM, EltTypeQuals);
1503
1504  void *InsertPos = 0;
1505  if (IncompleteArrayType *ATP =
1506       IncompleteArrayTypes.FindNodeOrInsertPos(ID, InsertPos))
1507    return QualType(ATP, 0);
1508
1509  // If the element type isn't canonical, this won't be a canonical type
1510  // either, so fill in the canonical type field.
1511  QualType Canonical;
1512
1513  if (!EltTy.isCanonical()) {
1514    Canonical = getIncompleteArrayType(getCanonicalType(EltTy),
1515                                       ASM, EltTypeQuals);
1516
1517    // Get the new insert position for the node we care about.
1518    IncompleteArrayType *NewIP =
1519      IncompleteArrayTypes.FindNodeOrInsertPos(ID, InsertPos);
1520    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1521  }
1522
1523  IncompleteArrayType *New = new (*this, TypeAlignment)
1524    IncompleteArrayType(EltTy, Canonical, ASM, EltTypeQuals);
1525
1526  IncompleteArrayTypes.InsertNode(New, InsertPos);
1527  Types.push_back(New);
1528  return QualType(New, 0);
1529}
1530
1531/// getVectorType - Return the unique reference to a vector type of
1532/// the specified element type and size. VectorType must be a built-in type.
1533QualType ASTContext::getVectorType(QualType vecType, unsigned NumElts) {
1534  BuiltinType *baseType;
1535
1536  baseType = dyn_cast<BuiltinType>(getCanonicalType(vecType).getTypePtr());
1537  assert(baseType != 0 && "getVectorType(): Expecting a built-in type");
1538
1539  // Check if we've already instantiated a vector of this type.
1540  llvm::FoldingSetNodeID ID;
1541  VectorType::Profile(ID, vecType, NumElts, Type::Vector);
1542  void *InsertPos = 0;
1543  if (VectorType *VTP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos))
1544    return QualType(VTP, 0);
1545
1546  // If the element type isn't canonical, this won't be a canonical type either,
1547  // so fill in the canonical type field.
1548  QualType Canonical;
1549  if (!vecType.isCanonical()) {
1550    Canonical = getVectorType(getCanonicalType(vecType), NumElts);
1551
1552    // Get the new insert position for the node we care about.
1553    VectorType *NewIP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos);
1554    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1555  }
1556  VectorType *New = new (*this, TypeAlignment)
1557    VectorType(vecType, NumElts, Canonical);
1558  VectorTypes.InsertNode(New, InsertPos);
1559  Types.push_back(New);
1560  return QualType(New, 0);
1561}
1562
1563/// getExtVectorType - Return the unique reference to an extended vector type of
1564/// the specified element type and size. VectorType must be a built-in type.
1565QualType ASTContext::getExtVectorType(QualType vecType, unsigned NumElts) {
1566  BuiltinType *baseType;
1567
1568  baseType = dyn_cast<BuiltinType>(getCanonicalType(vecType).getTypePtr());
1569  assert(baseType != 0 && "getExtVectorType(): Expecting a built-in type");
1570
1571  // Check if we've already instantiated a vector of this type.
1572  llvm::FoldingSetNodeID ID;
1573  VectorType::Profile(ID, vecType, NumElts, Type::ExtVector);
1574  void *InsertPos = 0;
1575  if (VectorType *VTP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos))
1576    return QualType(VTP, 0);
1577
1578  // If the element type isn't canonical, this won't be a canonical type either,
1579  // so fill in the canonical type field.
1580  QualType Canonical;
1581  if (!vecType.isCanonical()) {
1582    Canonical = getExtVectorType(getCanonicalType(vecType), NumElts);
1583
1584    // Get the new insert position for the node we care about.
1585    VectorType *NewIP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos);
1586    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1587  }
1588  ExtVectorType *New = new (*this, TypeAlignment)
1589    ExtVectorType(vecType, NumElts, Canonical);
1590  VectorTypes.InsertNode(New, InsertPos);
1591  Types.push_back(New);
1592  return QualType(New, 0);
1593}
1594
1595QualType ASTContext::getDependentSizedExtVectorType(QualType vecType,
1596                                                    Expr *SizeExpr,
1597                                                    SourceLocation AttrLoc) {
1598  llvm::FoldingSetNodeID ID;
1599  DependentSizedExtVectorType::Profile(ID, *this, getCanonicalType(vecType),
1600                                       SizeExpr);
1601
1602  void *InsertPos = 0;
1603  DependentSizedExtVectorType *Canon
1604    = DependentSizedExtVectorTypes.FindNodeOrInsertPos(ID, InsertPos);
1605  DependentSizedExtVectorType *New;
1606  if (Canon) {
1607    // We already have a canonical version of this array type; use it as
1608    // the canonical type for a newly-built type.
1609    New = new (*this, TypeAlignment)
1610      DependentSizedExtVectorType(*this, vecType, QualType(Canon, 0),
1611                                  SizeExpr, AttrLoc);
1612  } else {
1613    QualType CanonVecTy = getCanonicalType(vecType);
1614    if (CanonVecTy == vecType) {
1615      New = new (*this, TypeAlignment)
1616        DependentSizedExtVectorType(*this, vecType, QualType(), SizeExpr,
1617                                    AttrLoc);
1618      DependentSizedExtVectorTypes.InsertNode(New, InsertPos);
1619    } else {
1620      QualType Canon = getDependentSizedExtVectorType(CanonVecTy, SizeExpr,
1621                                                      SourceLocation());
1622      New = new (*this, TypeAlignment)
1623        DependentSizedExtVectorType(*this, vecType, Canon, SizeExpr, AttrLoc);
1624    }
1625  }
1626
1627  Types.push_back(New);
1628  return QualType(New, 0);
1629}
1630
1631/// getFunctionNoProtoType - Return a K&R style C function type like 'int()'.
1632///
1633QualType ASTContext::getFunctionNoProtoType(QualType ResultTy, bool NoReturn) {
1634  // Unique functions, to guarantee there is only one function of a particular
1635  // structure.
1636  llvm::FoldingSetNodeID ID;
1637  FunctionNoProtoType::Profile(ID, ResultTy, NoReturn);
1638
1639  void *InsertPos = 0;
1640  if (FunctionNoProtoType *FT =
1641        FunctionNoProtoTypes.FindNodeOrInsertPos(ID, InsertPos))
1642    return QualType(FT, 0);
1643
1644  QualType Canonical;
1645  if (!ResultTy.isCanonical()) {
1646    Canonical = getFunctionNoProtoType(getCanonicalType(ResultTy), NoReturn);
1647
1648    // Get the new insert position for the node we care about.
1649    FunctionNoProtoType *NewIP =
1650      FunctionNoProtoTypes.FindNodeOrInsertPos(ID, InsertPos);
1651    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1652  }
1653
1654  FunctionNoProtoType *New = new (*this, TypeAlignment)
1655    FunctionNoProtoType(ResultTy, Canonical, NoReturn);
1656  Types.push_back(New);
1657  FunctionNoProtoTypes.InsertNode(New, InsertPos);
1658  return QualType(New, 0);
1659}
1660
1661/// getFunctionType - Return a normal function type with a typed argument
1662/// list.  isVariadic indicates whether the argument list includes '...'.
1663QualType ASTContext::getFunctionType(QualType ResultTy,const QualType *ArgArray,
1664                                     unsigned NumArgs, bool isVariadic,
1665                                     unsigned TypeQuals, bool hasExceptionSpec,
1666                                     bool hasAnyExceptionSpec, unsigned NumExs,
1667                                     const QualType *ExArray, bool NoReturn) {
1668  // Unique functions, to guarantee there is only one function of a particular
1669  // structure.
1670  llvm::FoldingSetNodeID ID;
1671  FunctionProtoType::Profile(ID, ResultTy, ArgArray, NumArgs, isVariadic,
1672                             TypeQuals, hasExceptionSpec, hasAnyExceptionSpec,
1673                             NumExs, ExArray, NoReturn);
1674
1675  void *InsertPos = 0;
1676  if (FunctionProtoType *FTP =
1677        FunctionProtoTypes.FindNodeOrInsertPos(ID, InsertPos))
1678    return QualType(FTP, 0);
1679
1680  // Determine whether the type being created is already canonical or not.
1681  bool isCanonical = !hasExceptionSpec && ResultTy.isCanonical();
1682  for (unsigned i = 0; i != NumArgs && isCanonical; ++i)
1683    if (!ArgArray[i].isCanonicalAsParam())
1684      isCanonical = false;
1685
1686  // If this type isn't canonical, get the canonical version of it.
1687  // The exception spec is not part of the canonical type.
1688  QualType Canonical;
1689  if (!isCanonical) {
1690    llvm::SmallVector<QualType, 16> CanonicalArgs;
1691    CanonicalArgs.reserve(NumArgs);
1692    for (unsigned i = 0; i != NumArgs; ++i)
1693      CanonicalArgs.push_back(getCanonicalParamType(ArgArray[i]));
1694
1695    Canonical = getFunctionType(getCanonicalType(ResultTy),
1696                                CanonicalArgs.data(), NumArgs,
1697                                isVariadic, TypeQuals, false,
1698                                false, 0, 0, NoReturn);
1699
1700    // Get the new insert position for the node we care about.
1701    FunctionProtoType *NewIP =
1702      FunctionProtoTypes.FindNodeOrInsertPos(ID, InsertPos);
1703    assert(NewIP == 0 && "Shouldn't be in the map!"); NewIP = NewIP;
1704  }
1705
1706  // FunctionProtoType objects are allocated with extra bytes after them
1707  // for two variable size arrays (for parameter and exception types) at the
1708  // end of them.
1709  FunctionProtoType *FTP =
1710    (FunctionProtoType*)Allocate(sizeof(FunctionProtoType) +
1711                                 NumArgs*sizeof(QualType) +
1712                                 NumExs*sizeof(QualType), TypeAlignment);
1713  new (FTP) FunctionProtoType(ResultTy, ArgArray, NumArgs, isVariadic,
1714                              TypeQuals, hasExceptionSpec, hasAnyExceptionSpec,
1715                              ExArray, NumExs, Canonical, NoReturn);
1716  Types.push_back(FTP);
1717  FunctionProtoTypes.InsertNode(FTP, InsertPos);
1718  return QualType(FTP, 0);
1719}
1720
1721/// getTypeDeclType - Return the unique reference to the type for the
1722/// specified type declaration.
1723QualType ASTContext::getTypeDeclType(TypeDecl *Decl, TypeDecl* PrevDecl) {
1724  assert(Decl && "Passed null for Decl param");
1725  if (Decl->TypeForDecl) return QualType(Decl->TypeForDecl, 0);
1726
1727  if (TypedefDecl *Typedef = dyn_cast<TypedefDecl>(Decl))
1728    return getTypedefType(Typedef);
1729  else if (isa<TemplateTypeParmDecl>(Decl)) {
1730    assert(false && "Template type parameter types are always available.");
1731  } else if (ObjCInterfaceDecl *ObjCInterface
1732               = dyn_cast<ObjCInterfaceDecl>(Decl))
1733    return getObjCInterfaceType(ObjCInterface);
1734
1735  if (RecordDecl *Record = dyn_cast<RecordDecl>(Decl)) {
1736    if (PrevDecl)
1737      Decl->TypeForDecl = PrevDecl->TypeForDecl;
1738    else
1739      Decl->TypeForDecl = new (*this, TypeAlignment) RecordType(Record);
1740  } else if (EnumDecl *Enum = dyn_cast<EnumDecl>(Decl)) {
1741    if (PrevDecl)
1742      Decl->TypeForDecl = PrevDecl->TypeForDecl;
1743    else
1744      Decl->TypeForDecl = new (*this, TypeAlignment) EnumType(Enum);
1745  } else
1746    assert(false && "TypeDecl without a type?");
1747
1748  if (!PrevDecl) Types.push_back(Decl->TypeForDecl);
1749  return QualType(Decl->TypeForDecl, 0);
1750}
1751
1752/// getTypedefType - Return the unique reference to the type for the
1753/// specified typename decl.
1754QualType ASTContext::getTypedefType(TypedefDecl *Decl) {
1755  if (Decl->TypeForDecl) return QualType(Decl->TypeForDecl, 0);
1756
1757  QualType Canonical = getCanonicalType(Decl->getUnderlyingType());
1758  Decl->TypeForDecl = new(*this, TypeAlignment)
1759    TypedefType(Type::Typedef, Decl, Canonical);
1760  Types.push_back(Decl->TypeForDecl);
1761  return QualType(Decl->TypeForDecl, 0);
1762}
1763
1764/// \brief Retrieve a substitution-result type.
1765QualType
1766ASTContext::getSubstTemplateTypeParmType(const TemplateTypeParmType *Parm,
1767                                         QualType Replacement) {
1768  assert(Replacement.isCanonical()
1769         && "replacement types must always be canonical");
1770
1771  llvm::FoldingSetNodeID ID;
1772  SubstTemplateTypeParmType::Profile(ID, Parm, Replacement);
1773  void *InsertPos = 0;
1774  SubstTemplateTypeParmType *SubstParm
1775    = SubstTemplateTypeParmTypes.FindNodeOrInsertPos(ID, InsertPos);
1776
1777  if (!SubstParm) {
1778    SubstParm = new (*this, TypeAlignment)
1779      SubstTemplateTypeParmType(Parm, Replacement);
1780    Types.push_back(SubstParm);
1781    SubstTemplateTypeParmTypes.InsertNode(SubstParm, InsertPos);
1782  }
1783
1784  return QualType(SubstParm, 0);
1785}
1786
1787/// \brief Retrieve the template type parameter type for a template
1788/// parameter or parameter pack with the given depth, index, and (optionally)
1789/// name.
1790QualType ASTContext::getTemplateTypeParmType(unsigned Depth, unsigned Index,
1791                                             bool ParameterPack,
1792                                             IdentifierInfo *Name) {
1793  llvm::FoldingSetNodeID ID;
1794  TemplateTypeParmType::Profile(ID, Depth, Index, ParameterPack, Name);
1795  void *InsertPos = 0;
1796  TemplateTypeParmType *TypeParm
1797    = TemplateTypeParmTypes.FindNodeOrInsertPos(ID, InsertPos);
1798
1799  if (TypeParm)
1800    return QualType(TypeParm, 0);
1801
1802  if (Name) {
1803    QualType Canon = getTemplateTypeParmType(Depth, Index, ParameterPack);
1804    TypeParm = new (*this, TypeAlignment)
1805      TemplateTypeParmType(Depth, Index, ParameterPack, Name, Canon);
1806  } else
1807    TypeParm = new (*this, TypeAlignment)
1808      TemplateTypeParmType(Depth, Index, ParameterPack);
1809
1810  Types.push_back(TypeParm);
1811  TemplateTypeParmTypes.InsertNode(TypeParm, InsertPos);
1812
1813  return QualType(TypeParm, 0);
1814}
1815
1816QualType
1817ASTContext::getTemplateSpecializationType(TemplateName Template,
1818                                          const TemplateArgumentLoc *Args,
1819                                          unsigned NumArgs,
1820                                          QualType Canon) {
1821  llvm::SmallVector<TemplateArgument, 4> ArgVec;
1822  ArgVec.reserve(NumArgs);
1823  for (unsigned i = 0; i != NumArgs; ++i)
1824    ArgVec.push_back(Args[i].getArgument());
1825
1826  return getTemplateSpecializationType(Template, ArgVec.data(), NumArgs, Canon);
1827}
1828
1829QualType
1830ASTContext::getTemplateSpecializationType(TemplateName Template,
1831                                          const TemplateArgument *Args,
1832                                          unsigned NumArgs,
1833                                          QualType Canon) {
1834  if (!Canon.isNull())
1835    Canon = getCanonicalType(Canon);
1836  else {
1837    // Build the canonical template specialization type.
1838    TemplateName CanonTemplate = getCanonicalTemplateName(Template);
1839    llvm::SmallVector<TemplateArgument, 4> CanonArgs;
1840    CanonArgs.reserve(NumArgs);
1841    for (unsigned I = 0; I != NumArgs; ++I)
1842      CanonArgs.push_back(getCanonicalTemplateArgument(Args[I]));
1843
1844    // Determine whether this canonical template specialization type already
1845    // exists.
1846    llvm::FoldingSetNodeID ID;
1847    TemplateSpecializationType::Profile(ID, CanonTemplate,
1848                                        CanonArgs.data(), NumArgs, *this);
1849
1850    void *InsertPos = 0;
1851    TemplateSpecializationType *Spec
1852      = TemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos);
1853
1854    if (!Spec) {
1855      // Allocate a new canonical template specialization type.
1856      void *Mem = Allocate((sizeof(TemplateSpecializationType) +
1857                            sizeof(TemplateArgument) * NumArgs),
1858                           TypeAlignment);
1859      Spec = new (Mem) TemplateSpecializationType(*this, CanonTemplate,
1860                                                  CanonArgs.data(), NumArgs,
1861                                                  Canon);
1862      Types.push_back(Spec);
1863      TemplateSpecializationTypes.InsertNode(Spec, InsertPos);
1864    }
1865
1866    if (Canon.isNull())
1867      Canon = QualType(Spec, 0);
1868    assert(Canon->isDependentType() &&
1869           "Non-dependent template-id type must have a canonical type");
1870  }
1871
1872  // Allocate the (non-canonical) template specialization type, but don't
1873  // try to unique it: these types typically have location information that
1874  // we don't unique and don't want to lose.
1875  void *Mem = Allocate((sizeof(TemplateSpecializationType) +
1876                        sizeof(TemplateArgument) * NumArgs),
1877                       TypeAlignment);
1878  TemplateSpecializationType *Spec
1879    = new (Mem) TemplateSpecializationType(*this, Template, Args, NumArgs,
1880                                           Canon);
1881
1882  Types.push_back(Spec);
1883  return QualType(Spec, 0);
1884}
1885
1886QualType
1887ASTContext::getQualifiedNameType(NestedNameSpecifier *NNS,
1888                                 QualType NamedType) {
1889  llvm::FoldingSetNodeID ID;
1890  QualifiedNameType::Profile(ID, NNS, NamedType);
1891
1892  void *InsertPos = 0;
1893  QualifiedNameType *T
1894    = QualifiedNameTypes.FindNodeOrInsertPos(ID, InsertPos);
1895  if (T)
1896    return QualType(T, 0);
1897
1898  T = new (*this) QualifiedNameType(NNS, NamedType,
1899                                    getCanonicalType(NamedType));
1900  Types.push_back(T);
1901  QualifiedNameTypes.InsertNode(T, InsertPos);
1902  return QualType(T, 0);
1903}
1904
1905QualType ASTContext::getTypenameType(NestedNameSpecifier *NNS,
1906                                     const IdentifierInfo *Name,
1907                                     QualType Canon) {
1908  assert(NNS->isDependent() && "nested-name-specifier must be dependent");
1909
1910  if (Canon.isNull()) {
1911    NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
1912    if (CanonNNS != NNS)
1913      Canon = getTypenameType(CanonNNS, Name);
1914  }
1915
1916  llvm::FoldingSetNodeID ID;
1917  TypenameType::Profile(ID, NNS, Name);
1918
1919  void *InsertPos = 0;
1920  TypenameType *T
1921    = TypenameTypes.FindNodeOrInsertPos(ID, InsertPos);
1922  if (T)
1923    return QualType(T, 0);
1924
1925  T = new (*this) TypenameType(NNS, Name, Canon);
1926  Types.push_back(T);
1927  TypenameTypes.InsertNode(T, InsertPos);
1928  return QualType(T, 0);
1929}
1930
1931QualType
1932ASTContext::getTypenameType(NestedNameSpecifier *NNS,
1933                            const TemplateSpecializationType *TemplateId,
1934                            QualType Canon) {
1935  assert(NNS->isDependent() && "nested-name-specifier must be dependent");
1936
1937  if (Canon.isNull()) {
1938    NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
1939    QualType CanonType = getCanonicalType(QualType(TemplateId, 0));
1940    if (CanonNNS != NNS || CanonType != QualType(TemplateId, 0)) {
1941      const TemplateSpecializationType *CanonTemplateId
1942        = CanonType->getAs<TemplateSpecializationType>();
1943      assert(CanonTemplateId &&
1944             "Canonical type must also be a template specialization type");
1945      Canon = getTypenameType(CanonNNS, CanonTemplateId);
1946    }
1947  }
1948
1949  llvm::FoldingSetNodeID ID;
1950  TypenameType::Profile(ID, NNS, TemplateId);
1951
1952  void *InsertPos = 0;
1953  TypenameType *T
1954    = TypenameTypes.FindNodeOrInsertPos(ID, InsertPos);
1955  if (T)
1956    return QualType(T, 0);
1957
1958  T = new (*this) TypenameType(NNS, TemplateId, Canon);
1959  Types.push_back(T);
1960  TypenameTypes.InsertNode(T, InsertPos);
1961  return QualType(T, 0);
1962}
1963
1964QualType
1965ASTContext::getElaboratedType(QualType UnderlyingType,
1966                              ElaboratedType::TagKind Tag) {
1967  llvm::FoldingSetNodeID ID;
1968  ElaboratedType::Profile(ID, UnderlyingType, Tag);
1969
1970  void *InsertPos = 0;
1971  ElaboratedType *T = ElaboratedTypes.FindNodeOrInsertPos(ID, InsertPos);
1972  if (T)
1973    return QualType(T, 0);
1974
1975  QualType Canon = getCanonicalType(UnderlyingType);
1976
1977  T = new (*this) ElaboratedType(UnderlyingType, Tag, Canon);
1978  Types.push_back(T);
1979  ElaboratedTypes.InsertNode(T, InsertPos);
1980  return QualType(T, 0);
1981}
1982
1983/// CmpProtocolNames - Comparison predicate for sorting protocols
1984/// alphabetically.
1985static bool CmpProtocolNames(const ObjCProtocolDecl *LHS,
1986                            const ObjCProtocolDecl *RHS) {
1987  return LHS->getDeclName() < RHS->getDeclName();
1988}
1989
1990static bool areSortedAndUniqued(ObjCProtocolDecl **Protocols,
1991                                unsigned NumProtocols) {
1992  if (NumProtocols == 0) return true;
1993
1994  for (unsigned i = 1; i != NumProtocols; ++i)
1995    if (!CmpProtocolNames(Protocols[i-1], Protocols[i]))
1996      return false;
1997  return true;
1998}
1999
2000static void SortAndUniqueProtocols(ObjCProtocolDecl **Protocols,
2001                                   unsigned &NumProtocols) {
2002  ObjCProtocolDecl **ProtocolsEnd = Protocols+NumProtocols;
2003
2004  // Sort protocols, keyed by name.
2005  std::sort(Protocols, Protocols+NumProtocols, CmpProtocolNames);
2006
2007  // Remove duplicates.
2008  ProtocolsEnd = std::unique(Protocols, ProtocolsEnd);
2009  NumProtocols = ProtocolsEnd-Protocols;
2010}
2011
2012/// getObjCObjectPointerType - Return a ObjCObjectPointerType type for
2013/// the given interface decl and the conforming protocol list.
2014QualType ASTContext::getObjCObjectPointerType(QualType InterfaceT,
2015                                              ObjCProtocolDecl **Protocols,
2016                                              unsigned NumProtocols) {
2017  llvm::FoldingSetNodeID ID;
2018  ObjCObjectPointerType::Profile(ID, InterfaceT, Protocols, NumProtocols);
2019
2020  void *InsertPos = 0;
2021  if (ObjCObjectPointerType *QT =
2022              ObjCObjectPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
2023    return QualType(QT, 0);
2024
2025  // Sort the protocol list alphabetically to canonicalize it.
2026  QualType Canonical;
2027  if (!InterfaceT.isCanonical() ||
2028      !areSortedAndUniqued(Protocols, NumProtocols)) {
2029    if (!areSortedAndUniqued(Protocols, NumProtocols)) {
2030      llvm::SmallVector<ObjCProtocolDecl*, 8> Sorted(NumProtocols);
2031      unsigned UniqueCount = NumProtocols;
2032
2033      std::copy(Protocols, Protocols + NumProtocols, Sorted.begin());
2034      SortAndUniqueProtocols(&Sorted[0], UniqueCount);
2035
2036      Canonical = getObjCObjectPointerType(getCanonicalType(InterfaceT),
2037                                           &Sorted[0], UniqueCount);
2038    } else {
2039      Canonical = getObjCObjectPointerType(getCanonicalType(InterfaceT),
2040                                           Protocols, NumProtocols);
2041    }
2042
2043    // Regenerate InsertPos.
2044    ObjCObjectPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
2045  }
2046
2047  // No Match;
2048  ObjCObjectPointerType *QType = new (*this, TypeAlignment)
2049    ObjCObjectPointerType(Canonical, InterfaceT, Protocols, NumProtocols);
2050
2051  Types.push_back(QType);
2052  ObjCObjectPointerTypes.InsertNode(QType, InsertPos);
2053  return QualType(QType, 0);
2054}
2055
2056/// getObjCInterfaceType - Return the unique reference to the type for the
2057/// specified ObjC interface decl. The list of protocols is optional.
2058QualType ASTContext::getObjCInterfaceType(const ObjCInterfaceDecl *Decl,
2059                       ObjCProtocolDecl **Protocols, unsigned NumProtocols) {
2060  llvm::FoldingSetNodeID ID;
2061  ObjCInterfaceType::Profile(ID, Decl, Protocols, NumProtocols);
2062
2063  void *InsertPos = 0;
2064  if (ObjCInterfaceType *QT =
2065      ObjCInterfaceTypes.FindNodeOrInsertPos(ID, InsertPos))
2066    return QualType(QT, 0);
2067
2068  // Sort the protocol list alphabetically to canonicalize it.
2069  QualType Canonical;
2070  if (NumProtocols && !areSortedAndUniqued(Protocols, NumProtocols)) {
2071    llvm::SmallVector<ObjCProtocolDecl*, 8> Sorted(NumProtocols);
2072    std::copy(Protocols, Protocols + NumProtocols, Sorted.begin());
2073
2074    unsigned UniqueCount = NumProtocols;
2075    SortAndUniqueProtocols(&Sorted[0], UniqueCount);
2076
2077    Canonical = getObjCInterfaceType(Decl, &Sorted[0], UniqueCount);
2078
2079    ObjCInterfaceTypes.FindNodeOrInsertPos(ID, InsertPos);
2080  }
2081
2082  ObjCInterfaceType *QType = new (*this, TypeAlignment)
2083    ObjCInterfaceType(Canonical, const_cast<ObjCInterfaceDecl*>(Decl),
2084                      Protocols, NumProtocols);
2085
2086  Types.push_back(QType);
2087  ObjCInterfaceTypes.InsertNode(QType, InsertPos);
2088  return QualType(QType, 0);
2089}
2090
2091/// getTypeOfExprType - Unlike many "get<Type>" functions, we can't unique
2092/// TypeOfExprType AST's (since expression's are never shared). For example,
2093/// multiple declarations that refer to "typeof(x)" all contain different
2094/// DeclRefExpr's. This doesn't effect the type checker, since it operates
2095/// on canonical type's (which are always unique).
2096QualType ASTContext::getTypeOfExprType(Expr *tofExpr) {
2097  TypeOfExprType *toe;
2098  if (tofExpr->isTypeDependent()) {
2099    llvm::FoldingSetNodeID ID;
2100    DependentTypeOfExprType::Profile(ID, *this, tofExpr);
2101
2102    void *InsertPos = 0;
2103    DependentTypeOfExprType *Canon
2104      = DependentTypeOfExprTypes.FindNodeOrInsertPos(ID, InsertPos);
2105    if (Canon) {
2106      // We already have a "canonical" version of an identical, dependent
2107      // typeof(expr) type. Use that as our canonical type.
2108      toe = new (*this, TypeAlignment) TypeOfExprType(tofExpr,
2109                                          QualType((TypeOfExprType*)Canon, 0));
2110    }
2111    else {
2112      // Build a new, canonical typeof(expr) type.
2113      Canon
2114        = new (*this, TypeAlignment) DependentTypeOfExprType(*this, tofExpr);
2115      DependentTypeOfExprTypes.InsertNode(Canon, InsertPos);
2116      toe = Canon;
2117    }
2118  } else {
2119    QualType Canonical = getCanonicalType(tofExpr->getType());
2120    toe = new (*this, TypeAlignment) TypeOfExprType(tofExpr, Canonical);
2121  }
2122  Types.push_back(toe);
2123  return QualType(toe, 0);
2124}
2125
2126/// getTypeOfType -  Unlike many "get<Type>" functions, we don't unique
2127/// TypeOfType AST's. The only motivation to unique these nodes would be
2128/// memory savings. Since typeof(t) is fairly uncommon, space shouldn't be
2129/// an issue. This doesn't effect the type checker, since it operates
2130/// on canonical type's (which are always unique).
2131QualType ASTContext::getTypeOfType(QualType tofType) {
2132  QualType Canonical = getCanonicalType(tofType);
2133  TypeOfType *tot = new (*this, TypeAlignment) TypeOfType(tofType, Canonical);
2134  Types.push_back(tot);
2135  return QualType(tot, 0);
2136}
2137
2138/// getDecltypeForExpr - Given an expr, will return the decltype for that
2139/// expression, according to the rules in C++0x [dcl.type.simple]p4
2140static QualType getDecltypeForExpr(const Expr *e, ASTContext &Context) {
2141  if (e->isTypeDependent())
2142    return Context.DependentTy;
2143
2144  // If e is an id expression or a class member access, decltype(e) is defined
2145  // as the type of the entity named by e.
2146  if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(e)) {
2147    if (const ValueDecl *VD = dyn_cast<ValueDecl>(DRE->getDecl()))
2148      return VD->getType();
2149  }
2150  if (const MemberExpr *ME = dyn_cast<MemberExpr>(e)) {
2151    if (const FieldDecl *FD = dyn_cast<FieldDecl>(ME->getMemberDecl()))
2152      return FD->getType();
2153  }
2154  // If e is a function call or an invocation of an overloaded operator,
2155  // (parentheses around e are ignored), decltype(e) is defined as the
2156  // return type of that function.
2157  if (const CallExpr *CE = dyn_cast<CallExpr>(e->IgnoreParens()))
2158    return CE->getCallReturnType();
2159
2160  QualType T = e->getType();
2161
2162  // Otherwise, where T is the type of e, if e is an lvalue, decltype(e) is
2163  // defined as T&, otherwise decltype(e) is defined as T.
2164  if (e->isLvalue(Context) == Expr::LV_Valid)
2165    T = Context.getLValueReferenceType(T);
2166
2167  return T;
2168}
2169
2170/// getDecltypeType -  Unlike many "get<Type>" functions, we don't unique
2171/// DecltypeType AST's. The only motivation to unique these nodes would be
2172/// memory savings. Since decltype(t) is fairly uncommon, space shouldn't be
2173/// an issue. This doesn't effect the type checker, since it operates
2174/// on canonical type's (which are always unique).
2175QualType ASTContext::getDecltypeType(Expr *e) {
2176  DecltypeType *dt;
2177  if (e->isTypeDependent()) {
2178    llvm::FoldingSetNodeID ID;
2179    DependentDecltypeType::Profile(ID, *this, e);
2180
2181    void *InsertPos = 0;
2182    DependentDecltypeType *Canon
2183      = DependentDecltypeTypes.FindNodeOrInsertPos(ID, InsertPos);
2184    if (Canon) {
2185      // We already have a "canonical" version of an equivalent, dependent
2186      // decltype type. Use that as our canonical type.
2187      dt = new (*this, TypeAlignment) DecltypeType(e, DependentTy,
2188                                       QualType((DecltypeType*)Canon, 0));
2189    }
2190    else {
2191      // Build a new, canonical typeof(expr) type.
2192      Canon = new (*this, TypeAlignment) DependentDecltypeType(*this, e);
2193      DependentDecltypeTypes.InsertNode(Canon, InsertPos);
2194      dt = Canon;
2195    }
2196  } else {
2197    QualType T = getDecltypeForExpr(e, *this);
2198    dt = new (*this, TypeAlignment) DecltypeType(e, T, getCanonicalType(T));
2199  }
2200  Types.push_back(dt);
2201  return QualType(dt, 0);
2202}
2203
2204/// getTagDeclType - Return the unique reference to the type for the
2205/// specified TagDecl (struct/union/class/enum) decl.
2206QualType ASTContext::getTagDeclType(const TagDecl *Decl) {
2207  assert (Decl);
2208  // FIXME: What is the design on getTagDeclType when it requires casting
2209  // away const?  mutable?
2210  return getTypeDeclType(const_cast<TagDecl*>(Decl));
2211}
2212
2213/// getSizeType - Return the unique type for "size_t" (C99 7.17), the result
2214/// of the sizeof operator (C99 6.5.3.4p4). The value is target dependent and
2215/// needs to agree with the definition in <stddef.h>.
2216QualType ASTContext::getSizeType() const {
2217  return getFromTargetType(Target.getSizeType());
2218}
2219
2220/// getSignedWCharType - Return the type of "signed wchar_t".
2221/// Used when in C++, as a GCC extension.
2222QualType ASTContext::getSignedWCharType() const {
2223  // FIXME: derive from "Target" ?
2224  return WCharTy;
2225}
2226
2227/// getUnsignedWCharType - Return the type of "unsigned wchar_t".
2228/// Used when in C++, as a GCC extension.
2229QualType ASTContext::getUnsignedWCharType() const {
2230  // FIXME: derive from "Target" ?
2231  return UnsignedIntTy;
2232}
2233
2234/// getPointerDiffType - Return the unique type for "ptrdiff_t" (ref?)
2235/// defined in <stddef.h>. Pointer - pointer requires this (C99 6.5.6p9).
2236QualType ASTContext::getPointerDiffType() const {
2237  return getFromTargetType(Target.getPtrDiffType(0));
2238}
2239
2240//===----------------------------------------------------------------------===//
2241//                              Type Operators
2242//===----------------------------------------------------------------------===//
2243
2244CanQualType ASTContext::getCanonicalParamType(QualType T) {
2245  // Push qualifiers into arrays, and then discard any remaining
2246  // qualifiers.
2247  T = getCanonicalType(T);
2248  const Type *Ty = T.getTypePtr();
2249
2250  QualType Result;
2251  if (isa<ArrayType>(Ty)) {
2252    Result = getArrayDecayedType(QualType(Ty,0));
2253  } else if (isa<FunctionType>(Ty)) {
2254    Result = getPointerType(QualType(Ty, 0));
2255  } else {
2256    Result = QualType(Ty, 0);
2257  }
2258
2259  return CanQualType::CreateUnsafe(Result);
2260}
2261
2262/// getCanonicalType - Return the canonical (structural) type corresponding to
2263/// the specified potentially non-canonical type.  The non-canonical version
2264/// of a type may have many "decorated" versions of types.  Decorators can
2265/// include typedefs, 'typeof' operators, etc. The returned type is guaranteed
2266/// to be free of any of these, allowing two canonical types to be compared
2267/// for exact equality with a simple pointer comparison.
2268CanQualType ASTContext::getCanonicalType(QualType T) {
2269  QualifierCollector Quals;
2270  const Type *Ptr = Quals.strip(T);
2271  QualType CanType = Ptr->getCanonicalTypeInternal();
2272
2273  // The canonical internal type will be the canonical type *except*
2274  // that we push type qualifiers down through array types.
2275
2276  // If there are no new qualifiers to push down, stop here.
2277  if (!Quals.hasQualifiers())
2278    return CanQualType::CreateUnsafe(CanType);
2279
2280  // If the type qualifiers are on an array type, get the canonical
2281  // type of the array with the qualifiers applied to the element
2282  // type.
2283  ArrayType *AT = dyn_cast<ArrayType>(CanType);
2284  if (!AT)
2285    return CanQualType::CreateUnsafe(getQualifiedType(CanType, Quals));
2286
2287  // Get the canonical version of the element with the extra qualifiers on it.
2288  // This can recursively sink qualifiers through multiple levels of arrays.
2289  QualType NewEltTy = getQualifiedType(AT->getElementType(), Quals);
2290  NewEltTy = getCanonicalType(NewEltTy);
2291
2292  if (ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(AT))
2293    return CanQualType::CreateUnsafe(
2294             getConstantArrayType(NewEltTy, CAT->getSize(),
2295                                  CAT->getSizeModifier(),
2296                                  CAT->getIndexTypeCVRQualifiers()));
2297  if (IncompleteArrayType *IAT = dyn_cast<IncompleteArrayType>(AT))
2298    return CanQualType::CreateUnsafe(
2299             getIncompleteArrayType(NewEltTy, IAT->getSizeModifier(),
2300                                    IAT->getIndexTypeCVRQualifiers()));
2301
2302  if (DependentSizedArrayType *DSAT = dyn_cast<DependentSizedArrayType>(AT))
2303    return CanQualType::CreateUnsafe(
2304             getDependentSizedArrayType(NewEltTy,
2305                                        DSAT->getSizeExpr() ?
2306                                          DSAT->getSizeExpr()->Retain() : 0,
2307                                        DSAT->getSizeModifier(),
2308                                        DSAT->getIndexTypeCVRQualifiers(),
2309                        DSAT->getBracketsRange())->getCanonicalTypeInternal());
2310
2311  VariableArrayType *VAT = cast<VariableArrayType>(AT);
2312  return CanQualType::CreateUnsafe(getVariableArrayType(NewEltTy,
2313                                                        VAT->getSizeExpr() ?
2314                                              VAT->getSizeExpr()->Retain() : 0,
2315                                                        VAT->getSizeModifier(),
2316                                              VAT->getIndexTypeCVRQualifiers(),
2317                                                     VAT->getBracketsRange()));
2318}
2319
2320TemplateName ASTContext::getCanonicalTemplateName(TemplateName Name) {
2321  // If this template name refers to a template, the canonical
2322  // template name merely stores the template itself.
2323  if (TemplateDecl *Template = Name.getAsTemplateDecl())
2324    return TemplateName(cast<TemplateDecl>(Template->getCanonicalDecl()));
2325
2326  // If this template name refers to a set of overloaded function templates,
2327  /// the canonical template name merely stores the set of function templates.
2328  if (OverloadedFunctionDecl *Ovl = Name.getAsOverloadedFunctionDecl()) {
2329    OverloadedFunctionDecl *CanonOvl = 0;
2330    for (OverloadedFunctionDecl::function_iterator F = Ovl->function_begin(),
2331                                                FEnd = Ovl->function_end();
2332         F != FEnd; ++F) {
2333      Decl *Canon = F->get()->getCanonicalDecl();
2334      if (CanonOvl || Canon != F->get()) {
2335        if (!CanonOvl)
2336          CanonOvl = OverloadedFunctionDecl::Create(*this,
2337                                                    Ovl->getDeclContext(),
2338                                                    Ovl->getDeclName());
2339
2340        CanonOvl->addOverload(
2341                    AnyFunctionDecl::getFromNamedDecl(cast<NamedDecl>(Canon)));
2342      }
2343    }
2344
2345    return TemplateName(CanonOvl? CanonOvl : Ovl);
2346  }
2347
2348  DependentTemplateName *DTN = Name.getAsDependentTemplateName();
2349  assert(DTN && "Non-dependent template names must refer to template decls.");
2350  return DTN->CanonicalTemplateName;
2351}
2352
2353TemplateArgument
2354ASTContext::getCanonicalTemplateArgument(const TemplateArgument &Arg) {
2355  switch (Arg.getKind()) {
2356    case TemplateArgument::Null:
2357      return Arg;
2358
2359    case TemplateArgument::Expression:
2360      // FIXME: Build canonical expression?
2361      return Arg;
2362
2363    case TemplateArgument::Declaration:
2364      return TemplateArgument(Arg.getAsDecl()->getCanonicalDecl());
2365
2366    case TemplateArgument::Integral:
2367      return TemplateArgument(*Arg.getAsIntegral(),
2368                              getCanonicalType(Arg.getIntegralType()));
2369
2370    case TemplateArgument::Type:
2371      return TemplateArgument(getCanonicalType(Arg.getAsType()));
2372
2373    case TemplateArgument::Pack: {
2374      // FIXME: Allocate in ASTContext
2375      TemplateArgument *CanonArgs = new TemplateArgument[Arg.pack_size()];
2376      unsigned Idx = 0;
2377      for (TemplateArgument::pack_iterator A = Arg.pack_begin(),
2378                                        AEnd = Arg.pack_end();
2379           A != AEnd; (void)++A, ++Idx)
2380        CanonArgs[Idx] = getCanonicalTemplateArgument(*A);
2381
2382      TemplateArgument Result;
2383      Result.setArgumentPack(CanonArgs, Arg.pack_size(), false);
2384      return Result;
2385    }
2386  }
2387
2388  // Silence GCC warning
2389  assert(false && "Unhandled template argument kind");
2390  return TemplateArgument();
2391}
2392
2393NestedNameSpecifier *
2394ASTContext::getCanonicalNestedNameSpecifier(NestedNameSpecifier *NNS) {
2395  if (!NNS)
2396    return 0;
2397
2398  switch (NNS->getKind()) {
2399  case NestedNameSpecifier::Identifier:
2400    // Canonicalize the prefix but keep the identifier the same.
2401    return NestedNameSpecifier::Create(*this,
2402                         getCanonicalNestedNameSpecifier(NNS->getPrefix()),
2403                                       NNS->getAsIdentifier());
2404
2405  case NestedNameSpecifier::Namespace:
2406    // A namespace is canonical; build a nested-name-specifier with
2407    // this namespace and no prefix.
2408    return NestedNameSpecifier::Create(*this, 0, NNS->getAsNamespace());
2409
2410  case NestedNameSpecifier::TypeSpec:
2411  case NestedNameSpecifier::TypeSpecWithTemplate: {
2412    QualType T = getCanonicalType(QualType(NNS->getAsType(), 0));
2413    return NestedNameSpecifier::Create(*this, 0,
2414                 NNS->getKind() == NestedNameSpecifier::TypeSpecWithTemplate,
2415                                       T.getTypePtr());
2416  }
2417
2418  case NestedNameSpecifier::Global:
2419    // The global specifier is canonical and unique.
2420    return NNS;
2421  }
2422
2423  // Required to silence a GCC warning
2424  return 0;
2425}
2426
2427
2428const ArrayType *ASTContext::getAsArrayType(QualType T) {
2429  // Handle the non-qualified case efficiently.
2430  if (!T.hasQualifiers()) {
2431    // Handle the common positive case fast.
2432    if (const ArrayType *AT = dyn_cast<ArrayType>(T))
2433      return AT;
2434  }
2435
2436  // Handle the common negative case fast.
2437  QualType CType = T->getCanonicalTypeInternal();
2438  if (!isa<ArrayType>(CType))
2439    return 0;
2440
2441  // Apply any qualifiers from the array type to the element type.  This
2442  // implements C99 6.7.3p8: "If the specification of an array type includes
2443  // any type qualifiers, the element type is so qualified, not the array type."
2444
2445  // If we get here, we either have type qualifiers on the type, or we have
2446  // sugar such as a typedef in the way.  If we have type qualifiers on the type
2447  // we must propagate them down into the element type.
2448
2449  QualifierCollector Qs;
2450  const Type *Ty = Qs.strip(T.getDesugaredType());
2451
2452  // If we have a simple case, just return now.
2453  const ArrayType *ATy = dyn_cast<ArrayType>(Ty);
2454  if (ATy == 0 || Qs.empty())
2455    return ATy;
2456
2457  // Otherwise, we have an array and we have qualifiers on it.  Push the
2458  // qualifiers into the array element type and return a new array type.
2459  // Get the canonical version of the element with the extra qualifiers on it.
2460  // This can recursively sink qualifiers through multiple levels of arrays.
2461  QualType NewEltTy = getQualifiedType(ATy->getElementType(), Qs);
2462
2463  if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(ATy))
2464    return cast<ArrayType>(getConstantArrayType(NewEltTy, CAT->getSize(),
2465                                                CAT->getSizeModifier(),
2466                                           CAT->getIndexTypeCVRQualifiers()));
2467  if (const IncompleteArrayType *IAT = dyn_cast<IncompleteArrayType>(ATy))
2468    return cast<ArrayType>(getIncompleteArrayType(NewEltTy,
2469                                                  IAT->getSizeModifier(),
2470                                           IAT->getIndexTypeCVRQualifiers()));
2471
2472  if (const DependentSizedArrayType *DSAT
2473        = dyn_cast<DependentSizedArrayType>(ATy))
2474    return cast<ArrayType>(
2475                     getDependentSizedArrayType(NewEltTy,
2476                                                DSAT->getSizeExpr() ?
2477                                              DSAT->getSizeExpr()->Retain() : 0,
2478                                                DSAT->getSizeModifier(),
2479                                              DSAT->getIndexTypeCVRQualifiers(),
2480                                                DSAT->getBracketsRange()));
2481
2482  const VariableArrayType *VAT = cast<VariableArrayType>(ATy);
2483  return cast<ArrayType>(getVariableArrayType(NewEltTy,
2484                                              VAT->getSizeExpr() ?
2485                                              VAT->getSizeExpr()->Retain() : 0,
2486                                              VAT->getSizeModifier(),
2487                                              VAT->getIndexTypeCVRQualifiers(),
2488                                              VAT->getBracketsRange()));
2489}
2490
2491
2492/// getArrayDecayedType - Return the properly qualified result of decaying the
2493/// specified array type to a pointer.  This operation is non-trivial when
2494/// handling typedefs etc.  The canonical type of "T" must be an array type,
2495/// this returns a pointer to a properly qualified element of the array.
2496///
2497/// See C99 6.7.5.3p7 and C99 6.3.2.1p3.
2498QualType ASTContext::getArrayDecayedType(QualType Ty) {
2499  // Get the element type with 'getAsArrayType' so that we don't lose any
2500  // typedefs in the element type of the array.  This also handles propagation
2501  // of type qualifiers from the array type into the element type if present
2502  // (C99 6.7.3p8).
2503  const ArrayType *PrettyArrayType = getAsArrayType(Ty);
2504  assert(PrettyArrayType && "Not an array type!");
2505
2506  QualType PtrTy = getPointerType(PrettyArrayType->getElementType());
2507
2508  // int x[restrict 4] ->  int *restrict
2509  return getQualifiedType(PtrTy, PrettyArrayType->getIndexTypeQualifiers());
2510}
2511
2512QualType ASTContext::getBaseElementType(QualType QT) {
2513  QualifierCollector Qs;
2514  while (true) {
2515    const Type *UT = Qs.strip(QT);
2516    if (const ArrayType *AT = getAsArrayType(QualType(UT,0))) {
2517      QT = AT->getElementType();
2518    } else {
2519      return Qs.apply(QT);
2520    }
2521  }
2522}
2523
2524QualType ASTContext::getBaseElementType(const ArrayType *AT) {
2525  QualType ElemTy = AT->getElementType();
2526
2527  if (const ArrayType *AT = getAsArrayType(ElemTy))
2528    return getBaseElementType(AT);
2529
2530  return ElemTy;
2531}
2532
2533/// getConstantArrayElementCount - Returns number of constant array elements.
2534uint64_t
2535ASTContext::getConstantArrayElementCount(const ConstantArrayType *CA)  const {
2536  uint64_t ElementCount = 1;
2537  do {
2538    ElementCount *= CA->getSize().getZExtValue();
2539    CA = dyn_cast<ConstantArrayType>(CA->getElementType());
2540  } while (CA);
2541  return ElementCount;
2542}
2543
2544/// getFloatingRank - Return a relative rank for floating point types.
2545/// This routine will assert if passed a built-in type that isn't a float.
2546static FloatingRank getFloatingRank(QualType T) {
2547  if (const ComplexType *CT = T->getAs<ComplexType>())
2548    return getFloatingRank(CT->getElementType());
2549
2550  assert(T->getAs<BuiltinType>() && "getFloatingRank(): not a floating type");
2551  switch (T->getAs<BuiltinType>()->getKind()) {
2552  default: assert(0 && "getFloatingRank(): not a floating type");
2553  case BuiltinType::Float:      return FloatRank;
2554  case BuiltinType::Double:     return DoubleRank;
2555  case BuiltinType::LongDouble: return LongDoubleRank;
2556  }
2557}
2558
2559/// getFloatingTypeOfSizeWithinDomain - Returns a real floating
2560/// point or a complex type (based on typeDomain/typeSize).
2561/// 'typeDomain' is a real floating point or complex type.
2562/// 'typeSize' is a real floating point or complex type.
2563QualType ASTContext::getFloatingTypeOfSizeWithinDomain(QualType Size,
2564                                                       QualType Domain) const {
2565  FloatingRank EltRank = getFloatingRank(Size);
2566  if (Domain->isComplexType()) {
2567    switch (EltRank) {
2568    default: assert(0 && "getFloatingRank(): illegal value for rank");
2569    case FloatRank:      return FloatComplexTy;
2570    case DoubleRank:     return DoubleComplexTy;
2571    case LongDoubleRank: return LongDoubleComplexTy;
2572    }
2573  }
2574
2575  assert(Domain->isRealFloatingType() && "Unknown domain!");
2576  switch (EltRank) {
2577  default: assert(0 && "getFloatingRank(): illegal value for rank");
2578  case FloatRank:      return FloatTy;
2579  case DoubleRank:     return DoubleTy;
2580  case LongDoubleRank: return LongDoubleTy;
2581  }
2582}
2583
2584/// getFloatingTypeOrder - Compare the rank of the two specified floating
2585/// point types, ignoring the domain of the type (i.e. 'double' ==
2586/// '_Complex double').  If LHS > RHS, return 1.  If LHS == RHS, return 0. If
2587/// LHS < RHS, return -1.
2588int ASTContext::getFloatingTypeOrder(QualType LHS, QualType RHS) {
2589  FloatingRank LHSR = getFloatingRank(LHS);
2590  FloatingRank RHSR = getFloatingRank(RHS);
2591
2592  if (LHSR == RHSR)
2593    return 0;
2594  if (LHSR > RHSR)
2595    return 1;
2596  return -1;
2597}
2598
2599/// getIntegerRank - Return an integer conversion rank (C99 6.3.1.1p1). This
2600/// routine will assert if passed a built-in type that isn't an integer or enum,
2601/// or if it is not canonicalized.
2602unsigned ASTContext::getIntegerRank(Type *T) {
2603  assert(T->isCanonicalUnqualified() && "T should be canonicalized");
2604  if (EnumType* ET = dyn_cast<EnumType>(T))
2605    T = ET->getDecl()->getIntegerType().getTypePtr();
2606
2607  if (T->isSpecificBuiltinType(BuiltinType::WChar))
2608    T = getFromTargetType(Target.getWCharType()).getTypePtr();
2609
2610  if (T->isSpecificBuiltinType(BuiltinType::Char16))
2611    T = getFromTargetType(Target.getChar16Type()).getTypePtr();
2612
2613  if (T->isSpecificBuiltinType(BuiltinType::Char32))
2614    T = getFromTargetType(Target.getChar32Type()).getTypePtr();
2615
2616  // There are two things which impact the integer rank: the width, and
2617  // the ordering of builtins.  The builtin ordering is encoded in the
2618  // bottom three bits; the width is encoded in the bits above that.
2619  if (FixedWidthIntType* FWIT = dyn_cast<FixedWidthIntType>(T))
2620    return FWIT->getWidth() << 3;
2621
2622  switch (cast<BuiltinType>(T)->getKind()) {
2623  default: assert(0 && "getIntegerRank(): not a built-in integer");
2624  case BuiltinType::Bool:
2625    return 1 + (getIntWidth(BoolTy) << 3);
2626  case BuiltinType::Char_S:
2627  case BuiltinType::Char_U:
2628  case BuiltinType::SChar:
2629  case BuiltinType::UChar:
2630    return 2 + (getIntWidth(CharTy) << 3);
2631  case BuiltinType::Short:
2632  case BuiltinType::UShort:
2633    return 3 + (getIntWidth(ShortTy) << 3);
2634  case BuiltinType::Int:
2635  case BuiltinType::UInt:
2636    return 4 + (getIntWidth(IntTy) << 3);
2637  case BuiltinType::Long:
2638  case BuiltinType::ULong:
2639    return 5 + (getIntWidth(LongTy) << 3);
2640  case BuiltinType::LongLong:
2641  case BuiltinType::ULongLong:
2642    return 6 + (getIntWidth(LongLongTy) << 3);
2643  case BuiltinType::Int128:
2644  case BuiltinType::UInt128:
2645    return 7 + (getIntWidth(Int128Ty) << 3);
2646  }
2647}
2648
2649/// \brief Whether this is a promotable bitfield reference according
2650/// to C99 6.3.1.1p2, bullet 2 (and GCC extensions).
2651///
2652/// \returns the type this bit-field will promote to, or NULL if no
2653/// promotion occurs.
2654QualType ASTContext::isPromotableBitField(Expr *E) {
2655  FieldDecl *Field = E->getBitField();
2656  if (!Field)
2657    return QualType();
2658
2659  QualType FT = Field->getType();
2660
2661  llvm::APSInt BitWidthAP = Field->getBitWidth()->EvaluateAsInt(*this);
2662  uint64_t BitWidth = BitWidthAP.getZExtValue();
2663  uint64_t IntSize = getTypeSize(IntTy);
2664  // GCC extension compatibility: if the bit-field size is less than or equal
2665  // to the size of int, it gets promoted no matter what its type is.
2666  // For instance, unsigned long bf : 4 gets promoted to signed int.
2667  if (BitWidth < IntSize)
2668    return IntTy;
2669
2670  if (BitWidth == IntSize)
2671    return FT->isSignedIntegerType() ? IntTy : UnsignedIntTy;
2672
2673  // Types bigger than int are not subject to promotions, and therefore act
2674  // like the base type.
2675  // FIXME: This doesn't quite match what gcc does, but what gcc does here
2676  // is ridiculous.
2677  return QualType();
2678}
2679
2680/// getPromotedIntegerType - Returns the type that Promotable will
2681/// promote to: C99 6.3.1.1p2, assuming that Promotable is a promotable
2682/// integer type.
2683QualType ASTContext::getPromotedIntegerType(QualType Promotable) {
2684  assert(!Promotable.isNull());
2685  assert(Promotable->isPromotableIntegerType());
2686  if (Promotable->isSignedIntegerType())
2687    return IntTy;
2688  uint64_t PromotableSize = getTypeSize(Promotable);
2689  uint64_t IntSize = getTypeSize(IntTy);
2690  assert(Promotable->isUnsignedIntegerType() && PromotableSize <= IntSize);
2691  return (PromotableSize != IntSize) ? IntTy : UnsignedIntTy;
2692}
2693
2694/// getIntegerTypeOrder - Returns the highest ranked integer type:
2695/// C99 6.3.1.8p1.  If LHS > RHS, return 1.  If LHS == RHS, return 0. If
2696/// LHS < RHS, return -1.
2697int ASTContext::getIntegerTypeOrder(QualType LHS, QualType RHS) {
2698  Type *LHSC = getCanonicalType(LHS).getTypePtr();
2699  Type *RHSC = getCanonicalType(RHS).getTypePtr();
2700  if (LHSC == RHSC) return 0;
2701
2702  bool LHSUnsigned = LHSC->isUnsignedIntegerType();
2703  bool RHSUnsigned = RHSC->isUnsignedIntegerType();
2704
2705  unsigned LHSRank = getIntegerRank(LHSC);
2706  unsigned RHSRank = getIntegerRank(RHSC);
2707
2708  if (LHSUnsigned == RHSUnsigned) {  // Both signed or both unsigned.
2709    if (LHSRank == RHSRank) return 0;
2710    return LHSRank > RHSRank ? 1 : -1;
2711  }
2712
2713  // Otherwise, the LHS is signed and the RHS is unsigned or visa versa.
2714  if (LHSUnsigned) {
2715    // If the unsigned [LHS] type is larger, return it.
2716    if (LHSRank >= RHSRank)
2717      return 1;
2718
2719    // If the signed type can represent all values of the unsigned type, it
2720    // wins.  Because we are dealing with 2's complement and types that are
2721    // powers of two larger than each other, this is always safe.
2722    return -1;
2723  }
2724
2725  // If the unsigned [RHS] type is larger, return it.
2726  if (RHSRank >= LHSRank)
2727    return -1;
2728
2729  // If the signed type can represent all values of the unsigned type, it
2730  // wins.  Because we are dealing with 2's complement and types that are
2731  // powers of two larger than each other, this is always safe.
2732  return 1;
2733}
2734
2735// getCFConstantStringType - Return the type used for constant CFStrings.
2736QualType ASTContext::getCFConstantStringType() {
2737  if (!CFConstantStringTypeDecl) {
2738    CFConstantStringTypeDecl =
2739      RecordDecl::Create(*this, TagDecl::TK_struct, TUDecl, SourceLocation(),
2740                         &Idents.get("NSConstantString"));
2741    QualType FieldTypes[4];
2742
2743    // const int *isa;
2744    FieldTypes[0] = getPointerType(IntTy.withConst());
2745    // int flags;
2746    FieldTypes[1] = IntTy;
2747    // const char *str;
2748    FieldTypes[2] = getPointerType(CharTy.withConst());
2749    // long length;
2750    FieldTypes[3] = LongTy;
2751
2752    // Create fields
2753    for (unsigned i = 0; i < 4; ++i) {
2754      FieldDecl *Field = FieldDecl::Create(*this, CFConstantStringTypeDecl,
2755                                           SourceLocation(), 0,
2756                                           FieldTypes[i], /*DInfo=*/0,
2757                                           /*BitWidth=*/0,
2758                                           /*Mutable=*/false);
2759      CFConstantStringTypeDecl->addDecl(Field);
2760    }
2761
2762    CFConstantStringTypeDecl->completeDefinition(*this);
2763  }
2764
2765  return getTagDeclType(CFConstantStringTypeDecl);
2766}
2767
2768void ASTContext::setCFConstantStringType(QualType T) {
2769  const RecordType *Rec = T->getAs<RecordType>();
2770  assert(Rec && "Invalid CFConstantStringType");
2771  CFConstantStringTypeDecl = Rec->getDecl();
2772}
2773
2774QualType ASTContext::getObjCFastEnumerationStateType() {
2775  if (!ObjCFastEnumerationStateTypeDecl) {
2776    ObjCFastEnumerationStateTypeDecl =
2777      RecordDecl::Create(*this, TagDecl::TK_struct, TUDecl, SourceLocation(),
2778                         &Idents.get("__objcFastEnumerationState"));
2779
2780    QualType FieldTypes[] = {
2781      UnsignedLongTy,
2782      getPointerType(ObjCIdTypedefType),
2783      getPointerType(UnsignedLongTy),
2784      getConstantArrayType(UnsignedLongTy,
2785                           llvm::APInt(32, 5), ArrayType::Normal, 0)
2786    };
2787
2788    for (size_t i = 0; i < 4; ++i) {
2789      FieldDecl *Field = FieldDecl::Create(*this,
2790                                           ObjCFastEnumerationStateTypeDecl,
2791                                           SourceLocation(), 0,
2792                                           FieldTypes[i], /*DInfo=*/0,
2793                                           /*BitWidth=*/0,
2794                                           /*Mutable=*/false);
2795      ObjCFastEnumerationStateTypeDecl->addDecl(Field);
2796    }
2797
2798    ObjCFastEnumerationStateTypeDecl->completeDefinition(*this);
2799  }
2800
2801  return getTagDeclType(ObjCFastEnumerationStateTypeDecl);
2802}
2803
2804QualType ASTContext::getBlockDescriptorType() {
2805  if (BlockDescriptorType)
2806    return getTagDeclType(BlockDescriptorType);
2807
2808  RecordDecl *T;
2809  // FIXME: Needs the FlagAppleBlock bit.
2810  T = RecordDecl::Create(*this, TagDecl::TK_struct, TUDecl, SourceLocation(),
2811                         &Idents.get("__block_descriptor"));
2812
2813  QualType FieldTypes[] = {
2814    UnsignedLongTy,
2815    UnsignedLongTy,
2816  };
2817
2818  const char *FieldNames[] = {
2819    "reserved",
2820    "Size"
2821  };
2822
2823  for (size_t i = 0; i < 2; ++i) {
2824    FieldDecl *Field = FieldDecl::Create(*this,
2825                                         T,
2826                                         SourceLocation(),
2827                                         &Idents.get(FieldNames[i]),
2828                                         FieldTypes[i], /*DInfo=*/0,
2829                                         /*BitWidth=*/0,
2830                                         /*Mutable=*/false);
2831    T->addDecl(Field);
2832  }
2833
2834  T->completeDefinition(*this);
2835
2836  BlockDescriptorType = T;
2837
2838  return getTagDeclType(BlockDescriptorType);
2839}
2840
2841void ASTContext::setBlockDescriptorType(QualType T) {
2842  const RecordType *Rec = T->getAs<RecordType>();
2843  assert(Rec && "Invalid BlockDescriptorType");
2844  BlockDescriptorType = Rec->getDecl();
2845}
2846
2847QualType ASTContext::getBlockDescriptorExtendedType() {
2848  if (BlockDescriptorExtendedType)
2849    return getTagDeclType(BlockDescriptorExtendedType);
2850
2851  RecordDecl *T;
2852  // FIXME: Needs the FlagAppleBlock bit.
2853  T = RecordDecl::Create(*this, TagDecl::TK_struct, TUDecl, SourceLocation(),
2854                         &Idents.get("__block_descriptor_withcopydispose"));
2855
2856  QualType FieldTypes[] = {
2857    UnsignedLongTy,
2858    UnsignedLongTy,
2859    getPointerType(VoidPtrTy),
2860    getPointerType(VoidPtrTy)
2861  };
2862
2863  const char *FieldNames[] = {
2864    "reserved",
2865    "Size",
2866    "CopyFuncPtr",
2867    "DestroyFuncPtr"
2868  };
2869
2870  for (size_t i = 0; i < 4; ++i) {
2871    FieldDecl *Field = FieldDecl::Create(*this,
2872                                         T,
2873                                         SourceLocation(),
2874                                         &Idents.get(FieldNames[i]),
2875                                         FieldTypes[i], /*DInfo=*/0,
2876                                         /*BitWidth=*/0,
2877                                         /*Mutable=*/false);
2878    T->addDecl(Field);
2879  }
2880
2881  T->completeDefinition(*this);
2882
2883  BlockDescriptorExtendedType = T;
2884
2885  return getTagDeclType(BlockDescriptorExtendedType);
2886}
2887
2888void ASTContext::setBlockDescriptorExtendedType(QualType T) {
2889  const RecordType *Rec = T->getAs<RecordType>();
2890  assert(Rec && "Invalid BlockDescriptorType");
2891  BlockDescriptorExtendedType = Rec->getDecl();
2892}
2893
2894bool ASTContext::BlockRequiresCopying(QualType Ty) {
2895  if (Ty->isBlockPointerType())
2896    return true;
2897  if (isObjCNSObjectType(Ty))
2898    return true;
2899  if (Ty->isObjCObjectPointerType())
2900    return true;
2901  return false;
2902}
2903
2904QualType ASTContext::BuildByRefType(const char *DeclName, QualType Ty) {
2905  //  type = struct __Block_byref_1_X {
2906  //    void *__isa;
2907  //    struct __Block_byref_1_X *__forwarding;
2908  //    unsigned int __flags;
2909  //    unsigned int __size;
2910  //    void *__copy_helper;		// as needed
2911  //    void *__destroy_help		// as needed
2912  //    int X;
2913  //  } *
2914
2915  bool HasCopyAndDispose = BlockRequiresCopying(Ty);
2916
2917  // FIXME: Move up
2918  static unsigned int UniqueBlockByRefTypeID = 0;
2919  llvm::SmallString<36> Name;
2920  llvm::raw_svector_ostream(Name) << "__Block_byref_" <<
2921                                  ++UniqueBlockByRefTypeID << '_' << DeclName;
2922  RecordDecl *T;
2923  T = RecordDecl::Create(*this, TagDecl::TK_struct, TUDecl, SourceLocation(),
2924                         &Idents.get(Name.str()));
2925  T->startDefinition();
2926  QualType Int32Ty = IntTy;
2927  assert(getIntWidth(IntTy) == 32 && "non-32bit int not supported");
2928  QualType FieldTypes[] = {
2929    getPointerType(VoidPtrTy),
2930    getPointerType(getTagDeclType(T)),
2931    Int32Ty,
2932    Int32Ty,
2933    getPointerType(VoidPtrTy),
2934    getPointerType(VoidPtrTy),
2935    Ty
2936  };
2937
2938  const char *FieldNames[] = {
2939    "__isa",
2940    "__forwarding",
2941    "__flags",
2942    "__size",
2943    "__copy_helper",
2944    "__destroy_helper",
2945    DeclName,
2946  };
2947
2948  for (size_t i = 0; i < 7; ++i) {
2949    if (!HasCopyAndDispose && i >=4 && i <= 5)
2950      continue;
2951    FieldDecl *Field = FieldDecl::Create(*this, T, SourceLocation(),
2952                                         &Idents.get(FieldNames[i]),
2953                                         FieldTypes[i], /*DInfo=*/0,
2954                                         /*BitWidth=*/0, /*Mutable=*/false);
2955    T->addDecl(Field);
2956  }
2957
2958  T->completeDefinition(*this);
2959
2960  return getPointerType(getTagDeclType(T));
2961}
2962
2963
2964QualType ASTContext::getBlockParmType(
2965  bool BlockHasCopyDispose,
2966  llvm::SmallVector<const Expr *, 8> &BlockDeclRefDecls) {
2967  // FIXME: Move up
2968  static unsigned int UniqueBlockParmTypeID = 0;
2969  llvm::SmallString<36> Name;
2970  llvm::raw_svector_ostream(Name) << "__block_literal_"
2971                                  << ++UniqueBlockParmTypeID;
2972  RecordDecl *T;
2973  T = RecordDecl::Create(*this, TagDecl::TK_struct, TUDecl, SourceLocation(),
2974                         &Idents.get(Name.str()));
2975  QualType FieldTypes[] = {
2976    getPointerType(VoidPtrTy),
2977    IntTy,
2978    IntTy,
2979    getPointerType(VoidPtrTy),
2980    (BlockHasCopyDispose ?
2981     getPointerType(getBlockDescriptorExtendedType()) :
2982     getPointerType(getBlockDescriptorType()))
2983  };
2984
2985  const char *FieldNames[] = {
2986    "__isa",
2987    "__flags",
2988    "__reserved",
2989    "__FuncPtr",
2990    "__descriptor"
2991  };
2992
2993  for (size_t i = 0; i < 5; ++i) {
2994    FieldDecl *Field = FieldDecl::Create(*this, T, SourceLocation(),
2995                                         &Idents.get(FieldNames[i]),
2996                                         FieldTypes[i], /*DInfo=*/0,
2997                                         /*BitWidth=*/0, /*Mutable=*/false);
2998    T->addDecl(Field);
2999  }
3000
3001  for (size_t i = 0; i < BlockDeclRefDecls.size(); ++i) {
3002    const Expr *E = BlockDeclRefDecls[i];
3003    const BlockDeclRefExpr *BDRE = dyn_cast<BlockDeclRefExpr>(E);
3004    clang::IdentifierInfo *Name = 0;
3005    if (BDRE) {
3006      const ValueDecl *D = BDRE->getDecl();
3007      Name = &Idents.get(D->getName());
3008    }
3009    QualType FieldType = E->getType();
3010
3011    if (BDRE && BDRE->isByRef())
3012      FieldType = BuildByRefType(BDRE->getDecl()->getNameAsCString(),
3013                                 FieldType);
3014
3015    FieldDecl *Field = FieldDecl::Create(*this, T, SourceLocation(),
3016                                         Name, FieldType, /*DInfo=*/0,
3017                                         /*BitWidth=*/0, /*Mutable=*/false);
3018    T->addDecl(Field);
3019  }
3020
3021  T->completeDefinition(*this);
3022
3023  return getPointerType(getTagDeclType(T));
3024}
3025
3026void ASTContext::setObjCFastEnumerationStateType(QualType T) {
3027  const RecordType *Rec = T->getAs<RecordType>();
3028  assert(Rec && "Invalid ObjCFAstEnumerationStateType");
3029  ObjCFastEnumerationStateTypeDecl = Rec->getDecl();
3030}
3031
3032// This returns true if a type has been typedefed to BOOL:
3033// typedef <type> BOOL;
3034static bool isTypeTypedefedAsBOOL(QualType T) {
3035  if (const TypedefType *TT = dyn_cast<TypedefType>(T))
3036    if (IdentifierInfo *II = TT->getDecl()->getIdentifier())
3037      return II->isStr("BOOL");
3038
3039  return false;
3040}
3041
3042/// getObjCEncodingTypeSize returns size of type for objective-c encoding
3043/// purpose.
3044int ASTContext::getObjCEncodingTypeSize(QualType type) {
3045  uint64_t sz = getTypeSize(type);
3046
3047  // Make all integer and enum types at least as large as an int
3048  if (sz > 0 && type->isIntegralType())
3049    sz = std::max(sz, getTypeSize(IntTy));
3050  // Treat arrays as pointers, since that's how they're passed in.
3051  else if (type->isArrayType())
3052    sz = getTypeSize(VoidPtrTy);
3053  return sz / getTypeSize(CharTy);
3054}
3055
3056/// getObjCEncodingForMethodDecl - Return the encoded type for this method
3057/// declaration.
3058void ASTContext::getObjCEncodingForMethodDecl(const ObjCMethodDecl *Decl,
3059                                              std::string& S) {
3060  // FIXME: This is not very efficient.
3061  // Encode type qualifer, 'in', 'inout', etc. for the return type.
3062  getObjCEncodingForTypeQualifier(Decl->getObjCDeclQualifier(), S);
3063  // Encode result type.
3064  getObjCEncodingForType(Decl->getResultType(), S);
3065  // Compute size of all parameters.
3066  // Start with computing size of a pointer in number of bytes.
3067  // FIXME: There might(should) be a better way of doing this computation!
3068  SourceLocation Loc;
3069  int PtrSize = getTypeSize(VoidPtrTy) / getTypeSize(CharTy);
3070  // The first two arguments (self and _cmd) are pointers; account for
3071  // their size.
3072  int ParmOffset = 2 * PtrSize;
3073  for (ObjCMethodDecl::param_iterator PI = Decl->param_begin(),
3074       E = Decl->param_end(); PI != E; ++PI) {
3075    QualType PType = (*PI)->getType();
3076    int sz = getObjCEncodingTypeSize(PType);
3077    assert (sz > 0 && "getObjCEncodingForMethodDecl - Incomplete param type");
3078    ParmOffset += sz;
3079  }
3080  S += llvm::utostr(ParmOffset);
3081  S += "@0:";
3082  S += llvm::utostr(PtrSize);
3083
3084  // Argument types.
3085  ParmOffset = 2 * PtrSize;
3086  for (ObjCMethodDecl::param_iterator PI = Decl->param_begin(),
3087       E = Decl->param_end(); PI != E; ++PI) {
3088    ParmVarDecl *PVDecl = *PI;
3089    QualType PType = PVDecl->getOriginalType();
3090    if (const ArrayType *AT =
3091          dyn_cast<ArrayType>(PType->getCanonicalTypeInternal())) {
3092      // Use array's original type only if it has known number of
3093      // elements.
3094      if (!isa<ConstantArrayType>(AT))
3095        PType = PVDecl->getType();
3096    } else if (PType->isFunctionType())
3097      PType = PVDecl->getType();
3098    // Process argument qualifiers for user supplied arguments; such as,
3099    // 'in', 'inout', etc.
3100    getObjCEncodingForTypeQualifier(PVDecl->getObjCDeclQualifier(), S);
3101    getObjCEncodingForType(PType, S);
3102    S += llvm::utostr(ParmOffset);
3103    ParmOffset += getObjCEncodingTypeSize(PType);
3104  }
3105}
3106
3107/// getObjCEncodingForPropertyDecl - Return the encoded type for this
3108/// property declaration. If non-NULL, Container must be either an
3109/// ObjCCategoryImplDecl or ObjCImplementationDecl; it should only be
3110/// NULL when getting encodings for protocol properties.
3111/// Property attributes are stored as a comma-delimited C string. The simple
3112/// attributes readonly and bycopy are encoded as single characters. The
3113/// parametrized attributes, getter=name, setter=name, and ivar=name, are
3114/// encoded as single characters, followed by an identifier. Property types
3115/// are also encoded as a parametrized attribute. The characters used to encode
3116/// these attributes are defined by the following enumeration:
3117/// @code
3118/// enum PropertyAttributes {
3119/// kPropertyReadOnly = 'R',   // property is read-only.
3120/// kPropertyBycopy = 'C',     // property is a copy of the value last assigned
3121/// kPropertyByref = '&',  // property is a reference to the value last assigned
3122/// kPropertyDynamic = 'D',    // property is dynamic
3123/// kPropertyGetter = 'G',     // followed by getter selector name
3124/// kPropertySetter = 'S',     // followed by setter selector name
3125/// kPropertyInstanceVariable = 'V'  // followed by instance variable  name
3126/// kPropertyType = 't'              // followed by old-style type encoding.
3127/// kPropertyWeak = 'W'              // 'weak' property
3128/// kPropertyStrong = 'P'            // property GC'able
3129/// kPropertyNonAtomic = 'N'         // property non-atomic
3130/// };
3131/// @endcode
3132void ASTContext::getObjCEncodingForPropertyDecl(const ObjCPropertyDecl *PD,
3133                                                const Decl *Container,
3134                                                std::string& S) {
3135  // Collect information from the property implementation decl(s).
3136  bool Dynamic = false;
3137  ObjCPropertyImplDecl *SynthesizePID = 0;
3138
3139  // FIXME: Duplicated code due to poor abstraction.
3140  if (Container) {
3141    if (const ObjCCategoryImplDecl *CID =
3142        dyn_cast<ObjCCategoryImplDecl>(Container)) {
3143      for (ObjCCategoryImplDecl::propimpl_iterator
3144             i = CID->propimpl_begin(), e = CID->propimpl_end();
3145           i != e; ++i) {
3146        ObjCPropertyImplDecl *PID = *i;
3147        if (PID->getPropertyDecl() == PD) {
3148          if (PID->getPropertyImplementation()==ObjCPropertyImplDecl::Dynamic) {
3149            Dynamic = true;
3150          } else {
3151            SynthesizePID = PID;
3152          }
3153        }
3154      }
3155    } else {
3156      const ObjCImplementationDecl *OID=cast<ObjCImplementationDecl>(Container);
3157      for (ObjCCategoryImplDecl::propimpl_iterator
3158             i = OID->propimpl_begin(), e = OID->propimpl_end();
3159           i != e; ++i) {
3160        ObjCPropertyImplDecl *PID = *i;
3161        if (PID->getPropertyDecl() == PD) {
3162          if (PID->getPropertyImplementation()==ObjCPropertyImplDecl::Dynamic) {
3163            Dynamic = true;
3164          } else {
3165            SynthesizePID = PID;
3166          }
3167        }
3168      }
3169    }
3170  }
3171
3172  // FIXME: This is not very efficient.
3173  S = "T";
3174
3175  // Encode result type.
3176  // GCC has some special rules regarding encoding of properties which
3177  // closely resembles encoding of ivars.
3178  getObjCEncodingForTypeImpl(PD->getType(), S, true, true, 0,
3179                             true /* outermost type */,
3180                             true /* encoding for property */);
3181
3182  if (PD->isReadOnly()) {
3183    S += ",R";
3184  } else {
3185    switch (PD->getSetterKind()) {
3186    case ObjCPropertyDecl::Assign: break;
3187    case ObjCPropertyDecl::Copy:   S += ",C"; break;
3188    case ObjCPropertyDecl::Retain: S += ",&"; break;
3189    }
3190  }
3191
3192  // It really isn't clear at all what this means, since properties
3193  // are "dynamic by default".
3194  if (Dynamic)
3195    S += ",D";
3196
3197  if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_nonatomic)
3198    S += ",N";
3199
3200  if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_getter) {
3201    S += ",G";
3202    S += PD->getGetterName().getAsString();
3203  }
3204
3205  if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_setter) {
3206    S += ",S";
3207    S += PD->getSetterName().getAsString();
3208  }
3209
3210  if (SynthesizePID) {
3211    const ObjCIvarDecl *OID = SynthesizePID->getPropertyIvarDecl();
3212    S += ",V";
3213    S += OID->getNameAsString();
3214  }
3215
3216  // FIXME: OBJCGC: weak & strong
3217}
3218
3219/// getLegacyIntegralTypeEncoding -
3220/// Another legacy compatibility encoding: 32-bit longs are encoded as
3221/// 'l' or 'L' , but not always.  For typedefs, we need to use
3222/// 'i' or 'I' instead if encoding a struct field, or a pointer!
3223///
3224void ASTContext::getLegacyIntegralTypeEncoding (QualType &PointeeTy) const {
3225  if (isa<TypedefType>(PointeeTy.getTypePtr())) {
3226    if (const BuiltinType *BT = PointeeTy->getAs<BuiltinType>()) {
3227      if (BT->getKind() == BuiltinType::ULong &&
3228          ((const_cast<ASTContext *>(this))->getIntWidth(PointeeTy) == 32))
3229        PointeeTy = UnsignedIntTy;
3230      else
3231        if (BT->getKind() == BuiltinType::Long &&
3232            ((const_cast<ASTContext *>(this))->getIntWidth(PointeeTy) == 32))
3233          PointeeTy = IntTy;
3234    }
3235  }
3236}
3237
3238void ASTContext::getObjCEncodingForType(QualType T, std::string& S,
3239                                        const FieldDecl *Field) {
3240  // We follow the behavior of gcc, expanding structures which are
3241  // directly pointed to, and expanding embedded structures. Note that
3242  // these rules are sufficient to prevent recursive encoding of the
3243  // same type.
3244  getObjCEncodingForTypeImpl(T, S, true, true, Field,
3245                             true /* outermost type */);
3246}
3247
3248static void EncodeBitField(const ASTContext *Context, std::string& S,
3249                           const FieldDecl *FD) {
3250  const Expr *E = FD->getBitWidth();
3251  assert(E && "bitfield width not there - getObjCEncodingForTypeImpl");
3252  ASTContext *Ctx = const_cast<ASTContext*>(Context);
3253  unsigned N = E->EvaluateAsInt(*Ctx).getZExtValue();
3254  S += 'b';
3255  S += llvm::utostr(N);
3256}
3257
3258// FIXME: Use SmallString for accumulating string.
3259void ASTContext::getObjCEncodingForTypeImpl(QualType T, std::string& S,
3260                                            bool ExpandPointedToStructures,
3261                                            bool ExpandStructures,
3262                                            const FieldDecl *FD,
3263                                            bool OutermostType,
3264                                            bool EncodingProperty) {
3265  if (const BuiltinType *BT = T->getAs<BuiltinType>()) {
3266    if (FD && FD->isBitField())
3267      return EncodeBitField(this, S, FD);
3268    char encoding;
3269    switch (BT->getKind()) {
3270    default: assert(0 && "Unhandled builtin type kind");
3271    case BuiltinType::Void:       encoding = 'v'; break;
3272    case BuiltinType::Bool:       encoding = 'B'; break;
3273    case BuiltinType::Char_U:
3274    case BuiltinType::UChar:      encoding = 'C'; break;
3275    case BuiltinType::UShort:     encoding = 'S'; break;
3276    case BuiltinType::UInt:       encoding = 'I'; break;
3277    case BuiltinType::ULong:
3278        encoding =
3279          (const_cast<ASTContext *>(this))->getIntWidth(T) == 32 ? 'L' : 'Q';
3280        break;
3281    case BuiltinType::UInt128:    encoding = 'T'; break;
3282    case BuiltinType::ULongLong:  encoding = 'Q'; break;
3283    case BuiltinType::Char_S:
3284    case BuiltinType::SChar:      encoding = 'c'; break;
3285    case BuiltinType::Short:      encoding = 's'; break;
3286    case BuiltinType::Int:        encoding = 'i'; break;
3287    case BuiltinType::Long:
3288      encoding =
3289        (const_cast<ASTContext *>(this))->getIntWidth(T) == 32 ? 'l' : 'q';
3290      break;
3291    case BuiltinType::LongLong:   encoding = 'q'; break;
3292    case BuiltinType::Int128:     encoding = 't'; break;
3293    case BuiltinType::Float:      encoding = 'f'; break;
3294    case BuiltinType::Double:     encoding = 'd'; break;
3295    case BuiltinType::LongDouble: encoding = 'd'; break;
3296    }
3297
3298    S += encoding;
3299    return;
3300  }
3301
3302  if (const ComplexType *CT = T->getAs<ComplexType>()) {
3303    S += 'j';
3304    getObjCEncodingForTypeImpl(CT->getElementType(), S, false, false, 0, false,
3305                               false);
3306    return;
3307  }
3308
3309  if (const PointerType *PT = T->getAs<PointerType>()) {
3310    QualType PointeeTy = PT->getPointeeType();
3311    bool isReadOnly = false;
3312    // For historical/compatibility reasons, the read-only qualifier of the
3313    // pointee gets emitted _before_ the '^'.  The read-only qualifier of
3314    // the pointer itself gets ignored, _unless_ we are looking at a typedef!
3315    // Also, do not emit the 'r' for anything but the outermost type!
3316    if (isa<TypedefType>(T.getTypePtr())) {
3317      if (OutermostType && T.isConstQualified()) {
3318        isReadOnly = true;
3319        S += 'r';
3320      }
3321    } else if (OutermostType) {
3322      QualType P = PointeeTy;
3323      while (P->getAs<PointerType>())
3324        P = P->getAs<PointerType>()->getPointeeType();
3325      if (P.isConstQualified()) {
3326        isReadOnly = true;
3327        S += 'r';
3328      }
3329    }
3330    if (isReadOnly) {
3331      // Another legacy compatibility encoding. Some ObjC qualifier and type
3332      // combinations need to be rearranged.
3333      // Rewrite "in const" from "nr" to "rn"
3334      const char * s = S.c_str();
3335      int len = S.length();
3336      if (len >= 2 && s[len-2] == 'n' && s[len-1] == 'r') {
3337        std::string replace = "rn";
3338        S.replace(S.end()-2, S.end(), replace);
3339      }
3340    }
3341    if (isObjCSelType(PointeeTy)) {
3342      S += ':';
3343      return;
3344    }
3345
3346    if (PointeeTy->isCharType()) {
3347      // char pointer types should be encoded as '*' unless it is a
3348      // type that has been typedef'd to 'BOOL'.
3349      if (!isTypeTypedefedAsBOOL(PointeeTy)) {
3350        S += '*';
3351        return;
3352      }
3353    } else if (const RecordType *RTy = PointeeTy->getAs<RecordType>()) {
3354      // GCC binary compat: Need to convert "struct objc_class *" to "#".
3355      if (RTy->getDecl()->getIdentifier() == &Idents.get("objc_class")) {
3356        S += '#';
3357        return;
3358      }
3359      // GCC binary compat: Need to convert "struct objc_object *" to "@".
3360      if (RTy->getDecl()->getIdentifier() == &Idents.get("objc_object")) {
3361        S += '@';
3362        return;
3363      }
3364      // fall through...
3365    }
3366    S += '^';
3367    getLegacyIntegralTypeEncoding(PointeeTy);
3368
3369    getObjCEncodingForTypeImpl(PointeeTy, S, false, ExpandPointedToStructures,
3370                               NULL);
3371    return;
3372  }
3373
3374  if (const ArrayType *AT =
3375      // Ignore type qualifiers etc.
3376        dyn_cast<ArrayType>(T->getCanonicalTypeInternal())) {
3377    if (isa<IncompleteArrayType>(AT)) {
3378      // Incomplete arrays are encoded as a pointer to the array element.
3379      S += '^';
3380
3381      getObjCEncodingForTypeImpl(AT->getElementType(), S,
3382                                 false, ExpandStructures, FD);
3383    } else {
3384      S += '[';
3385
3386      if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(AT))
3387        S += llvm::utostr(CAT->getSize().getZExtValue());
3388      else {
3389        //Variable length arrays are encoded as a regular array with 0 elements.
3390        assert(isa<VariableArrayType>(AT) && "Unknown array type!");
3391        S += '0';
3392      }
3393
3394      getObjCEncodingForTypeImpl(AT->getElementType(), S,
3395                                 false, ExpandStructures, FD);
3396      S += ']';
3397    }
3398    return;
3399  }
3400
3401  if (T->getAs<FunctionType>()) {
3402    S += '?';
3403    return;
3404  }
3405
3406  if (const RecordType *RTy = T->getAs<RecordType>()) {
3407    RecordDecl *RDecl = RTy->getDecl();
3408    S += RDecl->isUnion() ? '(' : '{';
3409    // Anonymous structures print as '?'
3410    if (const IdentifierInfo *II = RDecl->getIdentifier()) {
3411      S += II->getName();
3412    } else {
3413      S += '?';
3414    }
3415    if (ExpandStructures) {
3416      S += '=';
3417      for (RecordDecl::field_iterator Field = RDecl->field_begin(),
3418                                   FieldEnd = RDecl->field_end();
3419           Field != FieldEnd; ++Field) {
3420        if (FD) {
3421          S += '"';
3422          S += Field->getNameAsString();
3423          S += '"';
3424        }
3425
3426        // Special case bit-fields.
3427        if (Field->isBitField()) {
3428          getObjCEncodingForTypeImpl(Field->getType(), S, false, true,
3429                                     (*Field));
3430        } else {
3431          QualType qt = Field->getType();
3432          getLegacyIntegralTypeEncoding(qt);
3433          getObjCEncodingForTypeImpl(qt, S, false, true,
3434                                     FD);
3435        }
3436      }
3437    }
3438    S += RDecl->isUnion() ? ')' : '}';
3439    return;
3440  }
3441
3442  if (T->isEnumeralType()) {
3443    if (FD && FD->isBitField())
3444      EncodeBitField(this, S, FD);
3445    else
3446      S += 'i';
3447    return;
3448  }
3449
3450  if (T->isBlockPointerType()) {
3451    S += "@?"; // Unlike a pointer-to-function, which is "^?".
3452    return;
3453  }
3454
3455  if (const ObjCInterfaceType *OIT = T->getAs<ObjCInterfaceType>()) {
3456    // @encode(class_name)
3457    ObjCInterfaceDecl *OI = OIT->getDecl();
3458    S += '{';
3459    const IdentifierInfo *II = OI->getIdentifier();
3460    S += II->getName();
3461    S += '=';
3462    llvm::SmallVector<FieldDecl*, 32> RecFields;
3463    CollectObjCIvars(OI, RecFields);
3464    for (unsigned i = 0, e = RecFields.size(); i != e; ++i) {
3465      if (RecFields[i]->isBitField())
3466        getObjCEncodingForTypeImpl(RecFields[i]->getType(), S, false, true,
3467                                   RecFields[i]);
3468      else
3469        getObjCEncodingForTypeImpl(RecFields[i]->getType(), S, false, true,
3470                                   FD);
3471    }
3472    S += '}';
3473    return;
3474  }
3475
3476  if (const ObjCObjectPointerType *OPT = T->getAs<ObjCObjectPointerType>()) {
3477    if (OPT->isObjCIdType()) {
3478      S += '@';
3479      return;
3480    }
3481
3482    if (OPT->isObjCClassType() || OPT->isObjCQualifiedClassType()) {
3483      // FIXME: Consider if we need to output qualifiers for 'Class<p>'.
3484      // Since this is a binary compatibility issue, need to consult with runtime
3485      // folks. Fortunately, this is a *very* obsure construct.
3486      S += '#';
3487      return;
3488    }
3489
3490    if (OPT->isObjCQualifiedIdType()) {
3491      getObjCEncodingForTypeImpl(getObjCIdType(), S,
3492                                 ExpandPointedToStructures,
3493                                 ExpandStructures, FD);
3494      if (FD || EncodingProperty) {
3495        // Note that we do extended encoding of protocol qualifer list
3496        // Only when doing ivar or property encoding.
3497        S += '"';
3498        for (ObjCObjectPointerType::qual_iterator I = OPT->qual_begin(),
3499             E = OPT->qual_end(); I != E; ++I) {
3500          S += '<';
3501          S += (*I)->getNameAsString();
3502          S += '>';
3503        }
3504        S += '"';
3505      }
3506      return;
3507    }
3508
3509    QualType PointeeTy = OPT->getPointeeType();
3510    if (!EncodingProperty &&
3511        isa<TypedefType>(PointeeTy.getTypePtr())) {
3512      // Another historical/compatibility reason.
3513      // We encode the underlying type which comes out as
3514      // {...};
3515      S += '^';
3516      getObjCEncodingForTypeImpl(PointeeTy, S,
3517                                 false, ExpandPointedToStructures,
3518                                 NULL);
3519      return;
3520    }
3521
3522    S += '@';
3523    if (OPT->getInterfaceDecl() && (FD || EncodingProperty)) {
3524      S += '"';
3525      S += OPT->getInterfaceDecl()->getIdentifier()->getName();
3526      for (ObjCObjectPointerType::qual_iterator I = OPT->qual_begin(),
3527           E = OPT->qual_end(); I != E; ++I) {
3528        S += '<';
3529        S += (*I)->getNameAsString();
3530        S += '>';
3531      }
3532      S += '"';
3533    }
3534    return;
3535  }
3536
3537  assert(0 && "@encode for type not implemented!");
3538}
3539
3540void ASTContext::getObjCEncodingForTypeQualifier(Decl::ObjCDeclQualifier QT,
3541                                                 std::string& S) const {
3542  if (QT & Decl::OBJC_TQ_In)
3543    S += 'n';
3544  if (QT & Decl::OBJC_TQ_Inout)
3545    S += 'N';
3546  if (QT & Decl::OBJC_TQ_Out)
3547    S += 'o';
3548  if (QT & Decl::OBJC_TQ_Bycopy)
3549    S += 'O';
3550  if (QT & Decl::OBJC_TQ_Byref)
3551    S += 'R';
3552  if (QT & Decl::OBJC_TQ_Oneway)
3553    S += 'V';
3554}
3555
3556void ASTContext::setBuiltinVaListType(QualType T) {
3557  assert(BuiltinVaListType.isNull() && "__builtin_va_list type already set!");
3558
3559  BuiltinVaListType = T;
3560}
3561
3562void ASTContext::setObjCIdType(QualType T) {
3563  ObjCIdTypedefType = T;
3564}
3565
3566void ASTContext::setObjCSelType(QualType T) {
3567  ObjCSelType = T;
3568
3569  const TypedefType *TT = T->getAs<TypedefType>();
3570  if (!TT)
3571    return;
3572  TypedefDecl *TD = TT->getDecl();
3573
3574  // typedef struct objc_selector *SEL;
3575  const PointerType *ptr = TD->getUnderlyingType()->getAs<PointerType>();
3576  if (!ptr)
3577    return;
3578  const RecordType *rec = ptr->getPointeeType()->getAsStructureType();
3579  if (!rec)
3580    return;
3581  SelStructType = rec;
3582}
3583
3584void ASTContext::setObjCProtoType(QualType QT) {
3585  ObjCProtoType = QT;
3586}
3587
3588void ASTContext::setObjCClassType(QualType T) {
3589  ObjCClassTypedefType = T;
3590}
3591
3592void ASTContext::setObjCConstantStringInterface(ObjCInterfaceDecl *Decl) {
3593  assert(ObjCConstantStringType.isNull() &&
3594         "'NSConstantString' type already set!");
3595
3596  ObjCConstantStringType = getObjCInterfaceType(Decl);
3597}
3598
3599/// \brief Retrieve the template name that represents a qualified
3600/// template name such as \c std::vector.
3601TemplateName ASTContext::getQualifiedTemplateName(NestedNameSpecifier *NNS,
3602                                                  bool TemplateKeyword,
3603                                                  TemplateDecl *Template) {
3604  llvm::FoldingSetNodeID ID;
3605  QualifiedTemplateName::Profile(ID, NNS, TemplateKeyword, Template);
3606
3607  void *InsertPos = 0;
3608  QualifiedTemplateName *QTN =
3609    QualifiedTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
3610  if (!QTN) {
3611    QTN = new (*this,4) QualifiedTemplateName(NNS, TemplateKeyword, Template);
3612    QualifiedTemplateNames.InsertNode(QTN, InsertPos);
3613  }
3614
3615  return TemplateName(QTN);
3616}
3617
3618/// \brief Retrieve the template name that represents a qualified
3619/// template name such as \c std::vector.
3620TemplateName ASTContext::getQualifiedTemplateName(NestedNameSpecifier *NNS,
3621                                                  bool TemplateKeyword,
3622                                            OverloadedFunctionDecl *Template) {
3623  llvm::FoldingSetNodeID ID;
3624  QualifiedTemplateName::Profile(ID, NNS, TemplateKeyword, Template);
3625
3626  void *InsertPos = 0;
3627  QualifiedTemplateName *QTN =
3628  QualifiedTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
3629  if (!QTN) {
3630    QTN = new (*this,4) QualifiedTemplateName(NNS, TemplateKeyword, Template);
3631    QualifiedTemplateNames.InsertNode(QTN, InsertPos);
3632  }
3633
3634  return TemplateName(QTN);
3635}
3636
3637/// \brief Retrieve the template name that represents a dependent
3638/// template name such as \c MetaFun::template apply.
3639TemplateName ASTContext::getDependentTemplateName(NestedNameSpecifier *NNS,
3640                                                  const IdentifierInfo *Name) {
3641  assert((!NNS || NNS->isDependent()) &&
3642         "Nested name specifier must be dependent");
3643
3644  llvm::FoldingSetNodeID ID;
3645  DependentTemplateName::Profile(ID, NNS, Name);
3646
3647  void *InsertPos = 0;
3648  DependentTemplateName *QTN =
3649    DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
3650
3651  if (QTN)
3652    return TemplateName(QTN);
3653
3654  NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
3655  if (CanonNNS == NNS) {
3656    QTN = new (*this,4) DependentTemplateName(NNS, Name);
3657  } else {
3658    TemplateName Canon = getDependentTemplateName(CanonNNS, Name);
3659    QTN = new (*this,4) DependentTemplateName(NNS, Name, Canon);
3660  }
3661
3662  DependentTemplateNames.InsertNode(QTN, InsertPos);
3663  return TemplateName(QTN);
3664}
3665
3666/// \brief Retrieve the template name that represents a dependent
3667/// template name such as \c MetaFun::template operator+.
3668TemplateName
3669ASTContext::getDependentTemplateName(NestedNameSpecifier *NNS,
3670                                     OverloadedOperatorKind Operator) {
3671  assert((!NNS || NNS->isDependent()) &&
3672         "Nested name specifier must be dependent");
3673
3674  llvm::FoldingSetNodeID ID;
3675  DependentTemplateName::Profile(ID, NNS, Operator);
3676
3677  void *InsertPos = 0;
3678  DependentTemplateName *QTN =
3679  DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
3680
3681  if (QTN)
3682    return TemplateName(QTN);
3683
3684  NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
3685  if (CanonNNS == NNS) {
3686    QTN = new (*this,4) DependentTemplateName(NNS, Operator);
3687  } else {
3688    TemplateName Canon = getDependentTemplateName(CanonNNS, Operator);
3689    QTN = new (*this,4) DependentTemplateName(NNS, Operator, Canon);
3690  }
3691
3692  DependentTemplateNames.InsertNode(QTN, InsertPos);
3693  return TemplateName(QTN);
3694}
3695
3696/// getFromTargetType - Given one of the integer types provided by
3697/// TargetInfo, produce the corresponding type. The unsigned @p Type
3698/// is actually a value of type @c TargetInfo::IntType.
3699CanQualType ASTContext::getFromTargetType(unsigned Type) const {
3700  switch (Type) {
3701  case TargetInfo::NoInt: return CanQualType();
3702  case TargetInfo::SignedShort: return ShortTy;
3703  case TargetInfo::UnsignedShort: return UnsignedShortTy;
3704  case TargetInfo::SignedInt: return IntTy;
3705  case TargetInfo::UnsignedInt: return UnsignedIntTy;
3706  case TargetInfo::SignedLong: return LongTy;
3707  case TargetInfo::UnsignedLong: return UnsignedLongTy;
3708  case TargetInfo::SignedLongLong: return LongLongTy;
3709  case TargetInfo::UnsignedLongLong: return UnsignedLongLongTy;
3710  }
3711
3712  assert(false && "Unhandled TargetInfo::IntType value");
3713  return CanQualType();
3714}
3715
3716//===----------------------------------------------------------------------===//
3717//                        Type Predicates.
3718//===----------------------------------------------------------------------===//
3719
3720/// isObjCNSObjectType - Return true if this is an NSObject object using
3721/// NSObject attribute on a c-style pointer type.
3722/// FIXME - Make it work directly on types.
3723/// FIXME: Move to Type.
3724///
3725bool ASTContext::isObjCNSObjectType(QualType Ty) const {
3726  if (TypedefType *TDT = dyn_cast<TypedefType>(Ty)) {
3727    if (TypedefDecl *TD = TDT->getDecl())
3728      if (TD->getAttr<ObjCNSObjectAttr>())
3729        return true;
3730  }
3731  return false;
3732}
3733
3734/// getObjCGCAttr - Returns one of GCNone, Weak or Strong objc's
3735/// garbage collection attribute.
3736///
3737Qualifiers::GC ASTContext::getObjCGCAttrKind(const QualType &Ty) const {
3738  Qualifiers::GC GCAttrs = Qualifiers::GCNone;
3739  if (getLangOptions().ObjC1 &&
3740      getLangOptions().getGCMode() != LangOptions::NonGC) {
3741    GCAttrs = Ty.getObjCGCAttr();
3742    // Default behavious under objective-c's gc is for objective-c pointers
3743    // (or pointers to them) be treated as though they were declared
3744    // as __strong.
3745    if (GCAttrs == Qualifiers::GCNone) {
3746      if (Ty->isObjCObjectPointerType() || Ty->isBlockPointerType())
3747        GCAttrs = Qualifiers::Strong;
3748      else if (Ty->isPointerType())
3749        return getObjCGCAttrKind(Ty->getAs<PointerType>()->getPointeeType());
3750    }
3751    // Non-pointers have none gc'able attribute regardless of the attribute
3752    // set on them.
3753    else if (!Ty->isAnyPointerType() && !Ty->isBlockPointerType())
3754      return Qualifiers::GCNone;
3755  }
3756  return GCAttrs;
3757}
3758
3759//===----------------------------------------------------------------------===//
3760//                        Type Compatibility Testing
3761//===----------------------------------------------------------------------===//
3762
3763/// areCompatVectorTypes - Return true if the two specified vector types are
3764/// compatible.
3765static bool areCompatVectorTypes(const VectorType *LHS,
3766                                 const VectorType *RHS) {
3767  assert(LHS->isCanonicalUnqualified() && RHS->isCanonicalUnqualified());
3768  return LHS->getElementType() == RHS->getElementType() &&
3769         LHS->getNumElements() == RHS->getNumElements();
3770}
3771
3772//===----------------------------------------------------------------------===//
3773// ObjCQualifiedIdTypesAreCompatible - Compatibility testing for qualified id's.
3774//===----------------------------------------------------------------------===//
3775
3776/// ProtocolCompatibleWithProtocol - return 'true' if 'lProto' is in the
3777/// inheritance hierarchy of 'rProto'.
3778bool ASTContext::ProtocolCompatibleWithProtocol(ObjCProtocolDecl *lProto,
3779                                                ObjCProtocolDecl *rProto) {
3780  if (lProto == rProto)
3781    return true;
3782  for (ObjCProtocolDecl::protocol_iterator PI = rProto->protocol_begin(),
3783       E = rProto->protocol_end(); PI != E; ++PI)
3784    if (ProtocolCompatibleWithProtocol(lProto, *PI))
3785      return true;
3786  return false;
3787}
3788
3789/// QualifiedIdConformsQualifiedId - compare id<p,...> with id<p1,...>
3790/// return true if lhs's protocols conform to rhs's protocol; false
3791/// otherwise.
3792bool ASTContext::QualifiedIdConformsQualifiedId(QualType lhs, QualType rhs) {
3793  if (lhs->isObjCQualifiedIdType() && rhs->isObjCQualifiedIdType())
3794    return ObjCQualifiedIdTypesAreCompatible(lhs, rhs, false);
3795  return false;
3796}
3797
3798/// ObjCQualifiedIdTypesAreCompatible - We know that one of lhs/rhs is an
3799/// ObjCQualifiedIDType.
3800bool ASTContext::ObjCQualifiedIdTypesAreCompatible(QualType lhs, QualType rhs,
3801                                                   bool compare) {
3802  // Allow id<P..> and an 'id' or void* type in all cases.
3803  if (lhs->isVoidPointerType() ||
3804      lhs->isObjCIdType() || lhs->isObjCClassType())
3805    return true;
3806  else if (rhs->isVoidPointerType() ||
3807           rhs->isObjCIdType() || rhs->isObjCClassType())
3808    return true;
3809
3810  if (const ObjCObjectPointerType *lhsQID = lhs->getAsObjCQualifiedIdType()) {
3811    const ObjCObjectPointerType *rhsOPT = rhs->getAs<ObjCObjectPointerType>();
3812
3813    if (!rhsOPT) return false;
3814
3815    if (rhsOPT->qual_empty()) {
3816      // If the RHS is a unqualified interface pointer "NSString*",
3817      // make sure we check the class hierarchy.
3818      if (ObjCInterfaceDecl *rhsID = rhsOPT->getInterfaceDecl()) {
3819        for (ObjCObjectPointerType::qual_iterator I = lhsQID->qual_begin(),
3820             E = lhsQID->qual_end(); I != E; ++I) {
3821          // when comparing an id<P> on lhs with a static type on rhs,
3822          // see if static class implements all of id's protocols, directly or
3823          // through its super class and categories.
3824          if (!rhsID->ClassImplementsProtocol(*I, true))
3825            return false;
3826        }
3827      }
3828      // If there are no qualifiers and no interface, we have an 'id'.
3829      return true;
3830    }
3831    // Both the right and left sides have qualifiers.
3832    for (ObjCObjectPointerType::qual_iterator I = lhsQID->qual_begin(),
3833         E = lhsQID->qual_end(); I != E; ++I) {
3834      ObjCProtocolDecl *lhsProto = *I;
3835      bool match = false;
3836
3837      // when comparing an id<P> on lhs with a static type on rhs,
3838      // see if static class implements all of id's protocols, directly or
3839      // through its super class and categories.
3840      for (ObjCObjectPointerType::qual_iterator J = rhsOPT->qual_begin(),
3841           E = rhsOPT->qual_end(); J != E; ++J) {
3842        ObjCProtocolDecl *rhsProto = *J;
3843        if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto) ||
3844            (compare && ProtocolCompatibleWithProtocol(rhsProto, lhsProto))) {
3845          match = true;
3846          break;
3847        }
3848      }
3849      // If the RHS is a qualified interface pointer "NSString<P>*",
3850      // make sure we check the class hierarchy.
3851      if (ObjCInterfaceDecl *rhsID = rhsOPT->getInterfaceDecl()) {
3852        for (ObjCObjectPointerType::qual_iterator I = lhsQID->qual_begin(),
3853             E = lhsQID->qual_end(); I != E; ++I) {
3854          // when comparing an id<P> on lhs with a static type on rhs,
3855          // see if static class implements all of id's protocols, directly or
3856          // through its super class and categories.
3857          if (rhsID->ClassImplementsProtocol(*I, true)) {
3858            match = true;
3859            break;
3860          }
3861        }
3862      }
3863      if (!match)
3864        return false;
3865    }
3866
3867    return true;
3868  }
3869
3870  const ObjCObjectPointerType *rhsQID = rhs->getAsObjCQualifiedIdType();
3871  assert(rhsQID && "One of the LHS/RHS should be id<x>");
3872
3873  if (const ObjCObjectPointerType *lhsOPT =
3874        lhs->getAsObjCInterfacePointerType()) {
3875    if (lhsOPT->qual_empty()) {
3876      bool match = false;
3877      if (ObjCInterfaceDecl *lhsID = lhsOPT->getInterfaceDecl()) {
3878        for (ObjCObjectPointerType::qual_iterator I = rhsQID->qual_begin(),
3879             E = rhsQID->qual_end(); I != E; ++I) {
3880          // when comparing an id<P> on lhs with a static type on rhs,
3881          // see if static class implements all of id's protocols, directly or
3882          // through its super class and categories.
3883          if (lhsID->ClassImplementsProtocol(*I, true)) {
3884            match = true;
3885            break;
3886          }
3887        }
3888        if (!match)
3889          return false;
3890      }
3891      return true;
3892    }
3893    // Both the right and left sides have qualifiers.
3894    for (ObjCObjectPointerType::qual_iterator I = lhsOPT->qual_begin(),
3895         E = lhsOPT->qual_end(); I != E; ++I) {
3896      ObjCProtocolDecl *lhsProto = *I;
3897      bool match = false;
3898
3899      // when comparing an id<P> on lhs with a static type on rhs,
3900      // see if static class implements all of id's protocols, directly or
3901      // through its super class and categories.
3902      for (ObjCObjectPointerType::qual_iterator J = rhsQID->qual_begin(),
3903           E = rhsQID->qual_end(); J != E; ++J) {
3904        ObjCProtocolDecl *rhsProto = *J;
3905        if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto) ||
3906            (compare && ProtocolCompatibleWithProtocol(rhsProto, lhsProto))) {
3907          match = true;
3908          break;
3909        }
3910      }
3911      if (!match)
3912        return false;
3913    }
3914    return true;
3915  }
3916  return false;
3917}
3918
3919/// canAssignObjCInterfaces - Return true if the two interface types are
3920/// compatible for assignment from RHS to LHS.  This handles validation of any
3921/// protocol qualifiers on the LHS or RHS.
3922///
3923bool ASTContext::canAssignObjCInterfaces(const ObjCObjectPointerType *LHSOPT,
3924                                         const ObjCObjectPointerType *RHSOPT) {
3925  // If either type represents the built-in 'id' or 'Class' types, return true.
3926  if (LHSOPT->isObjCBuiltinType() || RHSOPT->isObjCBuiltinType())
3927    return true;
3928
3929  if (LHSOPT->isObjCQualifiedIdType() || RHSOPT->isObjCQualifiedIdType())
3930    return ObjCQualifiedIdTypesAreCompatible(QualType(LHSOPT,0),
3931                                             QualType(RHSOPT,0),
3932                                             false);
3933
3934  const ObjCInterfaceType* LHS = LHSOPT->getInterfaceType();
3935  const ObjCInterfaceType* RHS = RHSOPT->getInterfaceType();
3936  if (LHS && RHS) // We have 2 user-defined types.
3937    return canAssignObjCInterfaces(LHS, RHS);
3938
3939  return false;
3940}
3941
3942/// getIntersectionOfProtocols - This routine finds the intersection of set
3943/// of protocols inherited from two distinct objective-c pointer objects.
3944/// It is used to build composite qualifier list of the composite type of
3945/// the conditional expression involving two objective-c pointer objects.
3946static
3947void getIntersectionOfProtocols(ASTContext &Context,
3948                                const ObjCObjectPointerType *LHSOPT,
3949                                const ObjCObjectPointerType *RHSOPT,
3950      llvm::SmallVectorImpl<ObjCProtocolDecl *> &IntersectionOfProtocols) {
3951
3952  const ObjCInterfaceType* LHS = LHSOPT->getInterfaceType();
3953  const ObjCInterfaceType* RHS = RHSOPT->getInterfaceType();
3954
3955  llvm::SmallPtrSet<ObjCProtocolDecl *, 8> InheritedProtocolSet;
3956  unsigned LHSNumProtocols = LHS->getNumProtocols();
3957  if (LHSNumProtocols > 0)
3958    InheritedProtocolSet.insert(LHS->qual_begin(), LHS->qual_end());
3959  else {
3960    llvm::SmallVector<ObjCProtocolDecl *, 8> LHSInheritedProtocols;
3961     Context.CollectInheritedProtocols(LHS->getDecl(), LHSInheritedProtocols);
3962    InheritedProtocolSet.insert(LHSInheritedProtocols.begin(),
3963                                LHSInheritedProtocols.end());
3964  }
3965
3966  unsigned RHSNumProtocols = RHS->getNumProtocols();
3967  if (RHSNumProtocols > 0) {
3968    ObjCProtocolDecl **RHSProtocols = (ObjCProtocolDecl **)RHS->qual_begin();
3969    for (unsigned i = 0; i < RHSNumProtocols; ++i)
3970      if (InheritedProtocolSet.count(RHSProtocols[i]))
3971        IntersectionOfProtocols.push_back(RHSProtocols[i]);
3972  }
3973  else {
3974    llvm::SmallVector<ObjCProtocolDecl *, 8> RHSInheritedProtocols;
3975    Context.CollectInheritedProtocols(RHS->getDecl(), RHSInheritedProtocols);
3976    // FIXME. This may cause duplication of protocols in the list, but should
3977    // be harmless.
3978    for (unsigned i = 0, len = RHSInheritedProtocols.size(); i < len; ++i)
3979      if (InheritedProtocolSet.count(RHSInheritedProtocols[i]))
3980        IntersectionOfProtocols.push_back(RHSInheritedProtocols[i]);
3981  }
3982}
3983
3984/// areCommonBaseCompatible - Returns common base class of the two classes if
3985/// one found. Note that this is O'2 algorithm. But it will be called as the
3986/// last type comparison in a ?-exp of ObjC pointer types before a
3987/// warning is issued. So, its invokation is extremely rare.
3988QualType ASTContext::areCommonBaseCompatible(
3989                                          const ObjCObjectPointerType *LHSOPT,
3990                                          const ObjCObjectPointerType *RHSOPT) {
3991  const ObjCInterfaceType* LHS = LHSOPT->getInterfaceType();
3992  const ObjCInterfaceType* RHS = RHSOPT->getInterfaceType();
3993  if (!LHS || !RHS)
3994    return QualType();
3995
3996  while (const ObjCInterfaceDecl *LHSIDecl = LHS->getDecl()->getSuperClass()) {
3997    QualType LHSTy = getObjCInterfaceType(LHSIDecl);
3998    LHS = LHSTy->getAs<ObjCInterfaceType>();
3999    if (canAssignObjCInterfaces(LHS, RHS)) {
4000      llvm::SmallVector<ObjCProtocolDecl *, 8> IntersectionOfProtocols;
4001      getIntersectionOfProtocols(*this,
4002                                 LHSOPT, RHSOPT, IntersectionOfProtocols);
4003      if (IntersectionOfProtocols.empty())
4004        LHSTy = getObjCObjectPointerType(LHSTy);
4005      else
4006        LHSTy = getObjCObjectPointerType(LHSTy, &IntersectionOfProtocols[0],
4007                                                IntersectionOfProtocols.size());
4008      return LHSTy;
4009    }
4010  }
4011
4012  return QualType();
4013}
4014
4015bool ASTContext::canAssignObjCInterfaces(const ObjCInterfaceType *LHS,
4016                                         const ObjCInterfaceType *RHS) {
4017  // Verify that the base decls are compatible: the RHS must be a subclass of
4018  // the LHS.
4019  if (!LHS->getDecl()->isSuperClassOf(RHS->getDecl()))
4020    return false;
4021
4022  // RHS must have a superset of the protocols in the LHS.  If the LHS is not
4023  // protocol qualified at all, then we are good.
4024  if (LHS->getNumProtocols() == 0)
4025    return true;
4026
4027  // Okay, we know the LHS has protocol qualifiers.  If the RHS doesn't, then it
4028  // isn't a superset.
4029  if (RHS->getNumProtocols() == 0)
4030    return true;  // FIXME: should return false!
4031
4032  for (ObjCInterfaceType::qual_iterator LHSPI = LHS->qual_begin(),
4033                                        LHSPE = LHS->qual_end();
4034       LHSPI != LHSPE; LHSPI++) {
4035    bool RHSImplementsProtocol = false;
4036
4037    // If the RHS doesn't implement the protocol on the left, the types
4038    // are incompatible.
4039    for (ObjCInterfaceType::qual_iterator RHSPI = RHS->qual_begin(),
4040                                          RHSPE = RHS->qual_end();
4041         RHSPI != RHSPE; RHSPI++) {
4042      if ((*RHSPI)->lookupProtocolNamed((*LHSPI)->getIdentifier())) {
4043        RHSImplementsProtocol = true;
4044        break;
4045      }
4046    }
4047    // FIXME: For better diagnostics, consider passing back the protocol name.
4048    if (!RHSImplementsProtocol)
4049      return false;
4050  }
4051  // The RHS implements all protocols listed on the LHS.
4052  return true;
4053}
4054
4055bool ASTContext::areComparableObjCPointerTypes(QualType LHS, QualType RHS) {
4056  // get the "pointed to" types
4057  const ObjCObjectPointerType *LHSOPT = LHS->getAs<ObjCObjectPointerType>();
4058  const ObjCObjectPointerType *RHSOPT = RHS->getAs<ObjCObjectPointerType>();
4059
4060  if (!LHSOPT || !RHSOPT)
4061    return false;
4062
4063  return canAssignObjCInterfaces(LHSOPT, RHSOPT) ||
4064         canAssignObjCInterfaces(RHSOPT, LHSOPT);
4065}
4066
4067/// typesAreCompatible - C99 6.7.3p9: For two qualified types to be compatible,
4068/// both shall have the identically qualified version of a compatible type.
4069/// C99 6.2.7p1: Two types have compatible types if their types are the
4070/// same. See 6.7.[2,3,5] for additional rules.
4071bool ASTContext::typesAreCompatible(QualType LHS, QualType RHS) {
4072  return !mergeTypes(LHS, RHS).isNull();
4073}
4074
4075QualType ASTContext::mergeFunctionTypes(QualType lhs, QualType rhs) {
4076  const FunctionType *lbase = lhs->getAs<FunctionType>();
4077  const FunctionType *rbase = rhs->getAs<FunctionType>();
4078  const FunctionProtoType *lproto = dyn_cast<FunctionProtoType>(lbase);
4079  const FunctionProtoType *rproto = dyn_cast<FunctionProtoType>(rbase);
4080  bool allLTypes = true;
4081  bool allRTypes = true;
4082
4083  // Check return type
4084  QualType retType = mergeTypes(lbase->getResultType(), rbase->getResultType());
4085  if (retType.isNull()) return QualType();
4086  if (getCanonicalType(retType) != getCanonicalType(lbase->getResultType()))
4087    allLTypes = false;
4088  if (getCanonicalType(retType) != getCanonicalType(rbase->getResultType()))
4089    allRTypes = false;
4090  // FIXME: double check this
4091  bool NoReturn = lbase->getNoReturnAttr() || rbase->getNoReturnAttr();
4092  if (NoReturn != lbase->getNoReturnAttr())
4093    allLTypes = false;
4094  if (NoReturn != rbase->getNoReturnAttr())
4095    allRTypes = false;
4096
4097  if (lproto && rproto) { // two C99 style function prototypes
4098    assert(!lproto->hasExceptionSpec() && !rproto->hasExceptionSpec() &&
4099           "C++ shouldn't be here");
4100    unsigned lproto_nargs = lproto->getNumArgs();
4101    unsigned rproto_nargs = rproto->getNumArgs();
4102
4103    // Compatible functions must have the same number of arguments
4104    if (lproto_nargs != rproto_nargs)
4105      return QualType();
4106
4107    // Variadic and non-variadic functions aren't compatible
4108    if (lproto->isVariadic() != rproto->isVariadic())
4109      return QualType();
4110
4111    if (lproto->getTypeQuals() != rproto->getTypeQuals())
4112      return QualType();
4113
4114    // Check argument compatibility
4115    llvm::SmallVector<QualType, 10> types;
4116    for (unsigned i = 0; i < lproto_nargs; i++) {
4117      QualType largtype = lproto->getArgType(i).getUnqualifiedType();
4118      QualType rargtype = rproto->getArgType(i).getUnqualifiedType();
4119      QualType argtype = mergeTypes(largtype, rargtype);
4120      if (argtype.isNull()) return QualType();
4121      types.push_back(argtype);
4122      if (getCanonicalType(argtype) != getCanonicalType(largtype))
4123        allLTypes = false;
4124      if (getCanonicalType(argtype) != getCanonicalType(rargtype))
4125        allRTypes = false;
4126    }
4127    if (allLTypes) return lhs;
4128    if (allRTypes) return rhs;
4129    return getFunctionType(retType, types.begin(), types.size(),
4130                           lproto->isVariadic(), lproto->getTypeQuals(),
4131                           NoReturn);
4132  }
4133
4134  if (lproto) allRTypes = false;
4135  if (rproto) allLTypes = false;
4136
4137  const FunctionProtoType *proto = lproto ? lproto : rproto;
4138  if (proto) {
4139    assert(!proto->hasExceptionSpec() && "C++ shouldn't be here");
4140    if (proto->isVariadic()) return QualType();
4141    // Check that the types are compatible with the types that
4142    // would result from default argument promotions (C99 6.7.5.3p15).
4143    // The only types actually affected are promotable integer
4144    // types and floats, which would be passed as a different
4145    // type depending on whether the prototype is visible.
4146    unsigned proto_nargs = proto->getNumArgs();
4147    for (unsigned i = 0; i < proto_nargs; ++i) {
4148      QualType argTy = proto->getArgType(i);
4149      if (argTy->isPromotableIntegerType() ||
4150          getCanonicalType(argTy).getUnqualifiedType() == FloatTy)
4151        return QualType();
4152    }
4153
4154    if (allLTypes) return lhs;
4155    if (allRTypes) return rhs;
4156    return getFunctionType(retType, proto->arg_type_begin(),
4157                           proto->getNumArgs(), proto->isVariadic(),
4158                           proto->getTypeQuals(), NoReturn);
4159  }
4160
4161  if (allLTypes) return lhs;
4162  if (allRTypes) return rhs;
4163  return getFunctionNoProtoType(retType, NoReturn);
4164}
4165
4166QualType ASTContext::mergeTypes(QualType LHS, QualType RHS) {
4167  // C++ [expr]: If an expression initially has the type "reference to T", the
4168  // type is adjusted to "T" prior to any further analysis, the expression
4169  // designates the object or function denoted by the reference, and the
4170  // expression is an lvalue unless the reference is an rvalue reference and
4171  // the expression is a function call (possibly inside parentheses).
4172  // FIXME: C++ shouldn't be going through here!  The rules are different
4173  // enough that they should be handled separately.
4174  // FIXME: Merging of lvalue and rvalue references is incorrect. C++ *really*
4175  // shouldn't be going through here!
4176  if (const ReferenceType *RT = LHS->getAs<ReferenceType>())
4177    LHS = RT->getPointeeType();
4178  if (const ReferenceType *RT = RHS->getAs<ReferenceType>())
4179    RHS = RT->getPointeeType();
4180
4181  QualType LHSCan = getCanonicalType(LHS),
4182           RHSCan = getCanonicalType(RHS);
4183
4184  // If two types are identical, they are compatible.
4185  if (LHSCan == RHSCan)
4186    return LHS;
4187
4188  // If the qualifiers are different, the types aren't compatible... mostly.
4189  Qualifiers LQuals = LHSCan.getQualifiers();
4190  Qualifiers RQuals = RHSCan.getQualifiers();
4191  if (LQuals != RQuals) {
4192    // If any of these qualifiers are different, we have a type
4193    // mismatch.
4194    if (LQuals.getCVRQualifiers() != RQuals.getCVRQualifiers() ||
4195        LQuals.getAddressSpace() != RQuals.getAddressSpace())
4196      return QualType();
4197
4198    // Exactly one GC qualifier difference is allowed: __strong is
4199    // okay if the other type has no GC qualifier but is an Objective
4200    // C object pointer (i.e. implicitly strong by default).  We fix
4201    // this by pretending that the unqualified type was actually
4202    // qualified __strong.
4203    Qualifiers::GC GC_L = LQuals.getObjCGCAttr();
4204    Qualifiers::GC GC_R = RQuals.getObjCGCAttr();
4205    assert((GC_L != GC_R) && "unequal qualifier sets had only equal elements");
4206
4207    if (GC_L == Qualifiers::Weak || GC_R == Qualifiers::Weak)
4208      return QualType();
4209
4210    if (GC_L == Qualifiers::Strong && RHSCan->isObjCObjectPointerType()) {
4211      return mergeTypes(LHS, getObjCGCQualType(RHS, Qualifiers::Strong));
4212    }
4213    if (GC_R == Qualifiers::Strong && LHSCan->isObjCObjectPointerType()) {
4214      return mergeTypes(getObjCGCQualType(LHS, Qualifiers::Strong), RHS);
4215    }
4216    return QualType();
4217  }
4218
4219  // Okay, qualifiers are equal.
4220
4221  Type::TypeClass LHSClass = LHSCan->getTypeClass();
4222  Type::TypeClass RHSClass = RHSCan->getTypeClass();
4223
4224  // We want to consider the two function types to be the same for these
4225  // comparisons, just force one to the other.
4226  if (LHSClass == Type::FunctionProto) LHSClass = Type::FunctionNoProto;
4227  if (RHSClass == Type::FunctionProto) RHSClass = Type::FunctionNoProto;
4228
4229  // Same as above for arrays
4230  if (LHSClass == Type::VariableArray || LHSClass == Type::IncompleteArray)
4231    LHSClass = Type::ConstantArray;
4232  if (RHSClass == Type::VariableArray || RHSClass == Type::IncompleteArray)
4233    RHSClass = Type::ConstantArray;
4234
4235  // Canonicalize ExtVector -> Vector.
4236  if (LHSClass == Type::ExtVector) LHSClass = Type::Vector;
4237  if (RHSClass == Type::ExtVector) RHSClass = Type::Vector;
4238
4239  // If the canonical type classes don't match.
4240  if (LHSClass != RHSClass) {
4241    // C99 6.7.2.2p4: Each enumerated type shall be compatible with char,
4242    // a signed integer type, or an unsigned integer type.
4243    if (const EnumType* ETy = LHS->getAs<EnumType>()) {
4244      if (ETy->getDecl()->getIntegerType() == RHSCan.getUnqualifiedType())
4245        return RHS;
4246    }
4247    if (const EnumType* ETy = RHS->getAs<EnumType>()) {
4248      if (ETy->getDecl()->getIntegerType() == LHSCan.getUnqualifiedType())
4249        return LHS;
4250    }
4251
4252    return QualType();
4253  }
4254
4255  // The canonical type classes match.
4256  switch (LHSClass) {
4257#define TYPE(Class, Base)
4258#define ABSTRACT_TYPE(Class, Base)
4259#define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
4260#define DEPENDENT_TYPE(Class, Base) case Type::Class:
4261#include "clang/AST/TypeNodes.def"
4262    assert(false && "Non-canonical and dependent types shouldn't get here");
4263    return QualType();
4264
4265  case Type::LValueReference:
4266  case Type::RValueReference:
4267  case Type::MemberPointer:
4268    assert(false && "C++ should never be in mergeTypes");
4269    return QualType();
4270
4271  case Type::IncompleteArray:
4272  case Type::VariableArray:
4273  case Type::FunctionProto:
4274  case Type::ExtVector:
4275    assert(false && "Types are eliminated above");
4276    return QualType();
4277
4278  case Type::Pointer:
4279  {
4280    // Merge two pointer types, while trying to preserve typedef info
4281    QualType LHSPointee = LHS->getAs<PointerType>()->getPointeeType();
4282    QualType RHSPointee = RHS->getAs<PointerType>()->getPointeeType();
4283    QualType ResultType = mergeTypes(LHSPointee, RHSPointee);
4284    if (ResultType.isNull()) return QualType();
4285    if (getCanonicalType(LHSPointee) == getCanonicalType(ResultType))
4286      return LHS;
4287    if (getCanonicalType(RHSPointee) == getCanonicalType(ResultType))
4288      return RHS;
4289    return getPointerType(ResultType);
4290  }
4291  case Type::BlockPointer:
4292  {
4293    // Merge two block pointer types, while trying to preserve typedef info
4294    QualType LHSPointee = LHS->getAs<BlockPointerType>()->getPointeeType();
4295    QualType RHSPointee = RHS->getAs<BlockPointerType>()->getPointeeType();
4296    QualType ResultType = mergeTypes(LHSPointee, RHSPointee);
4297    if (ResultType.isNull()) return QualType();
4298    if (getCanonicalType(LHSPointee) == getCanonicalType(ResultType))
4299      return LHS;
4300    if (getCanonicalType(RHSPointee) == getCanonicalType(ResultType))
4301      return RHS;
4302    return getBlockPointerType(ResultType);
4303  }
4304  case Type::ConstantArray:
4305  {
4306    const ConstantArrayType* LCAT = getAsConstantArrayType(LHS);
4307    const ConstantArrayType* RCAT = getAsConstantArrayType(RHS);
4308    if (LCAT && RCAT && RCAT->getSize() != LCAT->getSize())
4309      return QualType();
4310
4311    QualType LHSElem = getAsArrayType(LHS)->getElementType();
4312    QualType RHSElem = getAsArrayType(RHS)->getElementType();
4313    QualType ResultType = mergeTypes(LHSElem, RHSElem);
4314    if (ResultType.isNull()) return QualType();
4315    if (LCAT && getCanonicalType(LHSElem) == getCanonicalType(ResultType))
4316      return LHS;
4317    if (RCAT && getCanonicalType(RHSElem) == getCanonicalType(ResultType))
4318      return RHS;
4319    if (LCAT) return getConstantArrayType(ResultType, LCAT->getSize(),
4320                                          ArrayType::ArraySizeModifier(), 0);
4321    if (RCAT) return getConstantArrayType(ResultType, RCAT->getSize(),
4322                                          ArrayType::ArraySizeModifier(), 0);
4323    const VariableArrayType* LVAT = getAsVariableArrayType(LHS);
4324    const VariableArrayType* RVAT = getAsVariableArrayType(RHS);
4325    if (LVAT && getCanonicalType(LHSElem) == getCanonicalType(ResultType))
4326      return LHS;
4327    if (RVAT && getCanonicalType(RHSElem) == getCanonicalType(ResultType))
4328      return RHS;
4329    if (LVAT) {
4330      // FIXME: This isn't correct! But tricky to implement because
4331      // the array's size has to be the size of LHS, but the type
4332      // has to be different.
4333      return LHS;
4334    }
4335    if (RVAT) {
4336      // FIXME: This isn't correct! But tricky to implement because
4337      // the array's size has to be the size of RHS, but the type
4338      // has to be different.
4339      return RHS;
4340    }
4341    if (getCanonicalType(LHSElem) == getCanonicalType(ResultType)) return LHS;
4342    if (getCanonicalType(RHSElem) == getCanonicalType(ResultType)) return RHS;
4343    return getIncompleteArrayType(ResultType,
4344                                  ArrayType::ArraySizeModifier(), 0);
4345  }
4346  case Type::FunctionNoProto:
4347    return mergeFunctionTypes(LHS, RHS);
4348  case Type::Record:
4349  case Type::Enum:
4350    return QualType();
4351  case Type::Builtin:
4352    // Only exactly equal builtin types are compatible, which is tested above.
4353    return QualType();
4354  case Type::Complex:
4355    // Distinct complex types are incompatible.
4356    return QualType();
4357  case Type::Vector:
4358    // FIXME: The merged type should be an ExtVector!
4359    if (areCompatVectorTypes(LHS->getAs<VectorType>(), RHS->getAs<VectorType>()))
4360      return LHS;
4361    return QualType();
4362  case Type::ObjCInterface: {
4363    // Check if the interfaces are assignment compatible.
4364    // FIXME: This should be type compatibility, e.g. whether
4365    // "LHS x; RHS x;" at global scope is legal.
4366    const ObjCInterfaceType* LHSIface = LHS->getAs<ObjCInterfaceType>();
4367    const ObjCInterfaceType* RHSIface = RHS->getAs<ObjCInterfaceType>();
4368    if (LHSIface && RHSIface &&
4369        canAssignObjCInterfaces(LHSIface, RHSIface))
4370      return LHS;
4371
4372    return QualType();
4373  }
4374  case Type::ObjCObjectPointer: {
4375    if (canAssignObjCInterfaces(LHS->getAs<ObjCObjectPointerType>(),
4376                                RHS->getAs<ObjCObjectPointerType>()))
4377      return LHS;
4378
4379    return QualType();
4380  }
4381  case Type::FixedWidthInt:
4382    // Distinct fixed-width integers are not compatible.
4383    return QualType();
4384  case Type::TemplateSpecialization:
4385    assert(false && "Dependent types have no size");
4386    break;
4387  }
4388
4389  return QualType();
4390}
4391
4392//===----------------------------------------------------------------------===//
4393//                         Integer Predicates
4394//===----------------------------------------------------------------------===//
4395
4396unsigned ASTContext::getIntWidth(QualType T) {
4397  if (T->isBooleanType())
4398    return 1;
4399  if (FixedWidthIntType *FWIT = dyn_cast<FixedWidthIntType>(T)) {
4400    return FWIT->getWidth();
4401  }
4402  // For builtin types, just use the standard type sizing method
4403  return (unsigned)getTypeSize(T);
4404}
4405
4406QualType ASTContext::getCorrespondingUnsignedType(QualType T) {
4407  assert(T->isSignedIntegerType() && "Unexpected type");
4408
4409  // Turn <4 x signed int> -> <4 x unsigned int>
4410  if (const VectorType *VTy = T->getAs<VectorType>())
4411    return getVectorType(getCorrespondingUnsignedType(VTy->getElementType()),
4412                         VTy->getNumElements());
4413
4414  // For enums, we return the unsigned version of the base type.
4415  if (const EnumType *ETy = T->getAs<EnumType>())
4416    T = ETy->getDecl()->getIntegerType();
4417
4418  const BuiltinType *BTy = T->getAs<BuiltinType>();
4419  assert(BTy && "Unexpected signed integer type");
4420  switch (BTy->getKind()) {
4421  case BuiltinType::Char_S:
4422  case BuiltinType::SChar:
4423    return UnsignedCharTy;
4424  case BuiltinType::Short:
4425    return UnsignedShortTy;
4426  case BuiltinType::Int:
4427    return UnsignedIntTy;
4428  case BuiltinType::Long:
4429    return UnsignedLongTy;
4430  case BuiltinType::LongLong:
4431    return UnsignedLongLongTy;
4432  case BuiltinType::Int128:
4433    return UnsignedInt128Ty;
4434  default:
4435    assert(0 && "Unexpected signed integer type");
4436    return QualType();
4437  }
4438}
4439
4440ExternalASTSource::~ExternalASTSource() { }
4441
4442void ExternalASTSource::PrintStats() { }
4443
4444
4445//===----------------------------------------------------------------------===//
4446//                          Builtin Type Computation
4447//===----------------------------------------------------------------------===//
4448
4449/// DecodeTypeFromStr - This decodes one type descriptor from Str, advancing the
4450/// pointer over the consumed characters.  This returns the resultant type.
4451static QualType DecodeTypeFromStr(const char *&Str, ASTContext &Context,
4452                                  ASTContext::GetBuiltinTypeError &Error,
4453                                  bool AllowTypeModifiers = true) {
4454  // Modifiers.
4455  int HowLong = 0;
4456  bool Signed = false, Unsigned = false;
4457
4458  // Read the modifiers first.
4459  bool Done = false;
4460  while (!Done) {
4461    switch (*Str++) {
4462    default: Done = true; --Str; break;
4463    case 'S':
4464      assert(!Unsigned && "Can't use both 'S' and 'U' modifiers!");
4465      assert(!Signed && "Can't use 'S' modifier multiple times!");
4466      Signed = true;
4467      break;
4468    case 'U':
4469      assert(!Signed && "Can't use both 'S' and 'U' modifiers!");
4470      assert(!Unsigned && "Can't use 'S' modifier multiple times!");
4471      Unsigned = true;
4472      break;
4473    case 'L':
4474      assert(HowLong <= 2 && "Can't have LLLL modifier");
4475      ++HowLong;
4476      break;
4477    }
4478  }
4479
4480  QualType Type;
4481
4482  // Read the base type.
4483  switch (*Str++) {
4484  default: assert(0 && "Unknown builtin type letter!");
4485  case 'v':
4486    assert(HowLong == 0 && !Signed && !Unsigned &&
4487           "Bad modifiers used with 'v'!");
4488    Type = Context.VoidTy;
4489    break;
4490  case 'f':
4491    assert(HowLong == 0 && !Signed && !Unsigned &&
4492           "Bad modifiers used with 'f'!");
4493    Type = Context.FloatTy;
4494    break;
4495  case 'd':
4496    assert(HowLong < 2 && !Signed && !Unsigned &&
4497           "Bad modifiers used with 'd'!");
4498    if (HowLong)
4499      Type = Context.LongDoubleTy;
4500    else
4501      Type = Context.DoubleTy;
4502    break;
4503  case 's':
4504    assert(HowLong == 0 && "Bad modifiers used with 's'!");
4505    if (Unsigned)
4506      Type = Context.UnsignedShortTy;
4507    else
4508      Type = Context.ShortTy;
4509    break;
4510  case 'i':
4511    if (HowLong == 3)
4512      Type = Unsigned ? Context.UnsignedInt128Ty : Context.Int128Ty;
4513    else if (HowLong == 2)
4514      Type = Unsigned ? Context.UnsignedLongLongTy : Context.LongLongTy;
4515    else if (HowLong == 1)
4516      Type = Unsigned ? Context.UnsignedLongTy : Context.LongTy;
4517    else
4518      Type = Unsigned ? Context.UnsignedIntTy : Context.IntTy;
4519    break;
4520  case 'c':
4521    assert(HowLong == 0 && "Bad modifiers used with 'c'!");
4522    if (Signed)
4523      Type = Context.SignedCharTy;
4524    else if (Unsigned)
4525      Type = Context.UnsignedCharTy;
4526    else
4527      Type = Context.CharTy;
4528    break;
4529  case 'b': // boolean
4530    assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'b'!");
4531    Type = Context.BoolTy;
4532    break;
4533  case 'z':  // size_t.
4534    assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'z'!");
4535    Type = Context.getSizeType();
4536    break;
4537  case 'F':
4538    Type = Context.getCFConstantStringType();
4539    break;
4540  case 'a':
4541    Type = Context.getBuiltinVaListType();
4542    assert(!Type.isNull() && "builtin va list type not initialized!");
4543    break;
4544  case 'A':
4545    // This is a "reference" to a va_list; however, what exactly
4546    // this means depends on how va_list is defined. There are two
4547    // different kinds of va_list: ones passed by value, and ones
4548    // passed by reference.  An example of a by-value va_list is
4549    // x86, where va_list is a char*. An example of by-ref va_list
4550    // is x86-64, where va_list is a __va_list_tag[1]. For x86,
4551    // we want this argument to be a char*&; for x86-64, we want
4552    // it to be a __va_list_tag*.
4553    Type = Context.getBuiltinVaListType();
4554    assert(!Type.isNull() && "builtin va list type not initialized!");
4555    if (Type->isArrayType()) {
4556      Type = Context.getArrayDecayedType(Type);
4557    } else {
4558      Type = Context.getLValueReferenceType(Type);
4559    }
4560    break;
4561  case 'V': {
4562    char *End;
4563    unsigned NumElements = strtoul(Str, &End, 10);
4564    assert(End != Str && "Missing vector size");
4565
4566    Str = End;
4567
4568    QualType ElementType = DecodeTypeFromStr(Str, Context, Error, false);
4569    Type = Context.getVectorType(ElementType, NumElements);
4570    break;
4571  }
4572  case 'X': {
4573    QualType ElementType = DecodeTypeFromStr(Str, Context, Error, false);
4574    Type = Context.getComplexType(ElementType);
4575    break;
4576  }
4577  case 'P':
4578    Type = Context.getFILEType();
4579    if (Type.isNull()) {
4580      Error = ASTContext::GE_Missing_stdio;
4581      return QualType();
4582    }
4583    break;
4584  case 'J':
4585    if (Signed)
4586      Type = Context.getsigjmp_bufType();
4587    else
4588      Type = Context.getjmp_bufType();
4589
4590    if (Type.isNull()) {
4591      Error = ASTContext::GE_Missing_setjmp;
4592      return QualType();
4593    }
4594    break;
4595  }
4596
4597  if (!AllowTypeModifiers)
4598    return Type;
4599
4600  Done = false;
4601  while (!Done) {
4602    switch (*Str++) {
4603      default: Done = true; --Str; break;
4604      case '*':
4605        Type = Context.getPointerType(Type);
4606        break;
4607      case '&':
4608        Type = Context.getLValueReferenceType(Type);
4609        break;
4610      // FIXME: There's no way to have a built-in with an rvalue ref arg.
4611      case 'C':
4612        Type = Type.withConst();
4613        break;
4614    }
4615  }
4616
4617  return Type;
4618}
4619
4620/// GetBuiltinType - Return the type for the specified builtin.
4621QualType ASTContext::GetBuiltinType(unsigned id,
4622                                    GetBuiltinTypeError &Error) {
4623  const char *TypeStr = BuiltinInfo.GetTypeString(id);
4624
4625  llvm::SmallVector<QualType, 8> ArgTypes;
4626
4627  Error = GE_None;
4628  QualType ResType = DecodeTypeFromStr(TypeStr, *this, Error);
4629  if (Error != GE_None)
4630    return QualType();
4631  while (TypeStr[0] && TypeStr[0] != '.') {
4632    QualType Ty = DecodeTypeFromStr(TypeStr, *this, Error);
4633    if (Error != GE_None)
4634      return QualType();
4635
4636    // Do array -> pointer decay.  The builtin should use the decayed type.
4637    if (Ty->isArrayType())
4638      Ty = getArrayDecayedType(Ty);
4639
4640    ArgTypes.push_back(Ty);
4641  }
4642
4643  assert((TypeStr[0] != '.' || TypeStr[1] == 0) &&
4644         "'.' should only occur at end of builtin type list!");
4645
4646  // handle untyped/variadic arguments "T c99Style();" or "T cppStyle(...);".
4647  if (ArgTypes.size() == 0 && TypeStr[0] == '.')
4648    return getFunctionNoProtoType(ResType);
4649  return getFunctionType(ResType, ArgTypes.data(), ArgTypes.size(),
4650                         TypeStr[0] == '.', 0);
4651}
4652
4653QualType
4654ASTContext::UsualArithmeticConversionsType(QualType lhs, QualType rhs) {
4655  // Perform the usual unary conversions. We do this early so that
4656  // integral promotions to "int" can allow us to exit early, in the
4657  // lhs == rhs check. Also, for conversion purposes, we ignore any
4658  // qualifiers.  For example, "const float" and "float" are
4659  // equivalent.
4660  if (lhs->isPromotableIntegerType())
4661    lhs = getPromotedIntegerType(lhs);
4662  else
4663    lhs = lhs.getUnqualifiedType();
4664  if (rhs->isPromotableIntegerType())
4665    rhs = getPromotedIntegerType(rhs);
4666  else
4667    rhs = rhs.getUnqualifiedType();
4668
4669  // If both types are identical, no conversion is needed.
4670  if (lhs == rhs)
4671    return lhs;
4672
4673  // If either side is a non-arithmetic type (e.g. a pointer), we are done.
4674  // The caller can deal with this (e.g. pointer + int).
4675  if (!lhs->isArithmeticType() || !rhs->isArithmeticType())
4676    return lhs;
4677
4678  // At this point, we have two different arithmetic types.
4679
4680  // Handle complex types first (C99 6.3.1.8p1).
4681  if (lhs->isComplexType() || rhs->isComplexType()) {
4682    // if we have an integer operand, the result is the complex type.
4683    if (rhs->isIntegerType() || rhs->isComplexIntegerType()) {
4684      // convert the rhs to the lhs complex type.
4685      return lhs;
4686    }
4687    if (lhs->isIntegerType() || lhs->isComplexIntegerType()) {
4688      // convert the lhs to the rhs complex type.
4689      return rhs;
4690    }
4691    // This handles complex/complex, complex/float, or float/complex.
4692    // When both operands are complex, the shorter operand is converted to the
4693    // type of the longer, and that is the type of the result. This corresponds
4694    // to what is done when combining two real floating-point operands.
4695    // The fun begins when size promotion occur across type domains.
4696    // From H&S 6.3.4: When one operand is complex and the other is a real
4697    // floating-point type, the less precise type is converted, within it's
4698    // real or complex domain, to the precision of the other type. For example,
4699    // when combining a "long double" with a "double _Complex", the
4700    // "double _Complex" is promoted to "long double _Complex".
4701    int result = getFloatingTypeOrder(lhs, rhs);
4702
4703    if (result > 0) { // The left side is bigger, convert rhs.
4704      rhs = getFloatingTypeOfSizeWithinDomain(lhs, rhs);
4705    } else if (result < 0) { // The right side is bigger, convert lhs.
4706      lhs = getFloatingTypeOfSizeWithinDomain(rhs, lhs);
4707    }
4708    // At this point, lhs and rhs have the same rank/size. Now, make sure the
4709    // domains match. This is a requirement for our implementation, C99
4710    // does not require this promotion.
4711    if (lhs != rhs) { // Domains don't match, we have complex/float mix.
4712      if (lhs->isRealFloatingType()) { // handle "double, _Complex double".
4713        return rhs;
4714      } else { // handle "_Complex double, double".
4715        return lhs;
4716      }
4717    }
4718    return lhs; // The domain/size match exactly.
4719  }
4720  // Now handle "real" floating types (i.e. float, double, long double).
4721  if (lhs->isRealFloatingType() || rhs->isRealFloatingType()) {
4722    // if we have an integer operand, the result is the real floating type.
4723    if (rhs->isIntegerType()) {
4724      // convert rhs to the lhs floating point type.
4725      return lhs;
4726    }
4727    if (rhs->isComplexIntegerType()) {
4728      // convert rhs to the complex floating point type.
4729      return getComplexType(lhs);
4730    }
4731    if (lhs->isIntegerType()) {
4732      // convert lhs to the rhs floating point type.
4733      return rhs;
4734    }
4735    if (lhs->isComplexIntegerType()) {
4736      // convert lhs to the complex floating point type.
4737      return getComplexType(rhs);
4738    }
4739    // We have two real floating types, float/complex combos were handled above.
4740    // Convert the smaller operand to the bigger result.
4741    int result = getFloatingTypeOrder(lhs, rhs);
4742    if (result > 0) // convert the rhs
4743      return lhs;
4744    assert(result < 0 && "illegal float comparison");
4745    return rhs;   // convert the lhs
4746  }
4747  if (lhs->isComplexIntegerType() || rhs->isComplexIntegerType()) {
4748    // Handle GCC complex int extension.
4749    const ComplexType *lhsComplexInt = lhs->getAsComplexIntegerType();
4750    const ComplexType *rhsComplexInt = rhs->getAsComplexIntegerType();
4751
4752    if (lhsComplexInt && rhsComplexInt) {
4753      if (getIntegerTypeOrder(lhsComplexInt->getElementType(),
4754                              rhsComplexInt->getElementType()) >= 0)
4755        return lhs; // convert the rhs
4756      return rhs;
4757    } else if (lhsComplexInt && rhs->isIntegerType()) {
4758      // convert the rhs to the lhs complex type.
4759      return lhs;
4760    } else if (rhsComplexInt && lhs->isIntegerType()) {
4761      // convert the lhs to the rhs complex type.
4762      return rhs;
4763    }
4764  }
4765  // Finally, we have two differing integer types.
4766  // The rules for this case are in C99 6.3.1.8
4767  int compare = getIntegerTypeOrder(lhs, rhs);
4768  bool lhsSigned = lhs->isSignedIntegerType(),
4769       rhsSigned = rhs->isSignedIntegerType();
4770  QualType destType;
4771  if (lhsSigned == rhsSigned) {
4772    // Same signedness; use the higher-ranked type
4773    destType = compare >= 0 ? lhs : rhs;
4774  } else if (compare != (lhsSigned ? 1 : -1)) {
4775    // The unsigned type has greater than or equal rank to the
4776    // signed type, so use the unsigned type
4777    destType = lhsSigned ? rhs : lhs;
4778  } else if (getIntWidth(lhs) != getIntWidth(rhs)) {
4779    // The two types are different widths; if we are here, that
4780    // means the signed type is larger than the unsigned type, so
4781    // use the signed type.
4782    destType = lhsSigned ? lhs : rhs;
4783  } else {
4784    // The signed type is higher-ranked than the unsigned type,
4785    // but isn't actually any bigger (like unsigned int and long
4786    // on most 32-bit systems).  Use the unsigned type corresponding
4787    // to the signed type.
4788    destType = getCorrespondingUnsignedType(lhsSigned ? lhs : rhs);
4789  }
4790  return destType;
4791}
4792