DeclBase.cpp revision 7b3f853c6f684c1df423e994482681844c396342 
1//===--- DeclBase.cpp - Declaration AST Node Implementation ---------------===//
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 Decl and DeclContext classes.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/AST/DeclBase.h"
15#include "clang/AST/Decl.h"
16#include "clang/AST/DeclContextInternals.h"
17#include "clang/AST/DeclCXX.h"
18#include "clang/AST/DeclFriend.h"
19#include "clang/AST/DeclObjC.h"
20#include "clang/AST/DeclTemplate.h"
21#include "clang/AST/DependentDiagnostic.h"
22#include "clang/AST/ExternalASTSource.h"
23#include "clang/AST/ASTContext.h"
24#include "clang/AST/Type.h"
25#include "clang/AST/Stmt.h"
26#include "clang/AST/StmtCXX.h"
27#include "clang/AST/ASTMutationListener.h"
28#include "clang/Basic/TargetInfo.h"
29#include "llvm/ADT/DenseMap.h"
30#include "llvm/Support/raw_ostream.h"
31#include <algorithm>
32#include <cstdio>
33using namespace clang;
34
35//===----------------------------------------------------------------------===//
36//  Statistics
37//===----------------------------------------------------------------------===//
38
39#define DECL(DERIVED, BASE) static int n##DERIVED##s = 0;
40#define ABSTRACT_DECL(DECL)
41#include "clang/AST/DeclNodes.inc"
42
43static bool StatSwitch = false;
44
45const char *Decl::getDeclKindName() const {
46  switch (DeclKind) {
47  default: assert(0 && "Declaration not in DeclNodes.inc!");
48#define DECL(DERIVED, BASE) case DERIVED: return #DERIVED;
49#define ABSTRACT_DECL(DECL)
50#include "clang/AST/DeclNodes.inc"
51  }
52}
53
54void Decl::setInvalidDecl(bool Invalid) {
55  InvalidDecl = Invalid;
56  if (Invalid) {
57    // Defensive maneuver for ill-formed code: we're likely not to make it to
58    // a point where we set the access specifier, so default it to "public"
59    // to avoid triggering asserts elsewhere in the front end.
60    setAccess(AS_public);
61  }
62}
63
64const char *DeclContext::getDeclKindName() const {
65  switch (DeclKind) {
66  default: assert(0 && "Declaration context not in DeclNodes.inc!");
67#define DECL(DERIVED, BASE) case Decl::DERIVED: return #DERIVED;
68#define ABSTRACT_DECL(DECL)
69#include "clang/AST/DeclNodes.inc"
70  }
71}
72
73bool Decl::CollectingStats(bool Enable) {
74  if (Enable) StatSwitch = true;
75  return StatSwitch;
76}
77
78void Decl::PrintStats() {
79  fprintf(stderr, "*** Decl Stats:\n");
80
81  int totalDecls = 0;
82#define DECL(DERIVED, BASE) totalDecls += n##DERIVED##s;
83#define ABSTRACT_DECL(DECL)
84#include "clang/AST/DeclNodes.inc"
85  fprintf(stderr, "  %d decls total.\n", totalDecls);
86
87  int totalBytes = 0;
88#define DECL(DERIVED, BASE)                                             \
89  if (n##DERIVED##s > 0) {                                              \
90    totalBytes += (int)(n##DERIVED##s * sizeof(DERIVED##Decl));         \
91    fprintf(stderr, "    %d " #DERIVED " decls, %d each (%d bytes)\n",  \
92            n##DERIVED##s, (int)sizeof(DERIVED##Decl),                  \
93            (int)(n##DERIVED##s * sizeof(DERIVED##Decl)));              \
94  }
95#define ABSTRACT_DECL(DECL)
96#include "clang/AST/DeclNodes.inc"
97
98  fprintf(stderr, "Total bytes = %d\n", totalBytes);
99}
100
101void Decl::add(Kind k) {
102  switch (k) {
103  default: assert(0 && "Declaration not in DeclNodes.inc!");
104#define DECL(DERIVED, BASE) case DERIVED: ++n##DERIVED##s; break;
105#define ABSTRACT_DECL(DECL)
106#include "clang/AST/DeclNodes.inc"
107  }
108}
109
110bool Decl::isTemplateParameterPack() const {
111  if (const TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(this))
112    return TTP->isParameterPack();
113  if (const NonTypeTemplateParmDecl *NTTP
114                                = dyn_cast<NonTypeTemplateParmDecl>(this))
115    return NTTP->isParameterPack();
116  if (const TemplateTemplateParmDecl *TTP
117                                    = dyn_cast<TemplateTemplateParmDecl>(this))
118    return TTP->isParameterPack();
119  return false;
120}
121
122bool Decl::isParameterPack() const {
123  if (const ParmVarDecl *Parm = dyn_cast<ParmVarDecl>(this))
124    return Parm->isParameterPack();
125
126  return isTemplateParameterPack();
127}
128
129bool Decl::isFunctionOrFunctionTemplate() const {
130  if (const UsingShadowDecl *UD = dyn_cast<UsingShadowDecl>(this))
131    return UD->getTargetDecl()->isFunctionOrFunctionTemplate();
132
133  return isa<FunctionDecl>(this) || isa<FunctionTemplateDecl>(this);
134}
135
136bool Decl::isDefinedOutsideFunctionOrMethod() const {
137  for (const DeclContext *DC = getDeclContext();
138       DC && !DC->isTranslationUnit();
139       DC = DC->getParent())
140    if (DC->isFunctionOrMethod())
141      return false;
142
143  return true;
144}
145
146
147//===----------------------------------------------------------------------===//
148// PrettyStackTraceDecl Implementation
149//===----------------------------------------------------------------------===//
150
151void PrettyStackTraceDecl::print(llvm::raw_ostream &OS) const {
152  SourceLocation TheLoc = Loc;
153  if (TheLoc.isInvalid() && TheDecl)
154    TheLoc = TheDecl->getLocation();
155
156  if (TheLoc.isValid()) {
157    TheLoc.print(OS, SM);
158    OS << ": ";
159  }
160
161  OS << Message;
162
163  if (const NamedDecl *DN = dyn_cast_or_null<NamedDecl>(TheDecl))
164    OS << " '" << DN->getQualifiedNameAsString() << '\'';
165  OS << '\n';
166}
167
168//===----------------------------------------------------------------------===//
169// Decl Implementation
170//===----------------------------------------------------------------------===//
171
172// Out-of-line virtual method providing a home for Decl.
173Decl::~Decl() { }
174
175void Decl::setDeclContext(DeclContext *DC) {
176  DeclCtx = DC;
177}
178
179void Decl::setLexicalDeclContext(DeclContext *DC) {
180  if (DC == getLexicalDeclContext())
181    return;
182
183  if (isInSemaDC()) {
184    MultipleDC *MDC = new (getASTContext()) MultipleDC();
185    MDC->SemanticDC = getDeclContext();
186    MDC->LexicalDC = DC;
187    DeclCtx = MDC;
188  } else {
189    getMultipleDC()->LexicalDC = DC;
190  }
191}
192
193bool Decl::isInAnonymousNamespace() const {
194  const DeclContext *DC = getDeclContext();
195  do {
196    if (const NamespaceDecl *ND = dyn_cast<NamespaceDecl>(DC))
197      if (ND->isAnonymousNamespace())
198        return true;
199  } while ((DC = DC->getParent()));
200
201  return false;
202}
203
204TranslationUnitDecl *Decl::getTranslationUnitDecl() {
205  if (TranslationUnitDecl *TUD = dyn_cast<TranslationUnitDecl>(this))
206    return TUD;
207
208  DeclContext *DC = getDeclContext();
209  assert(DC && "This decl is not contained in a translation unit!");
210
211  while (!DC->isTranslationUnit()) {
212    DC = DC->getParent();
213    assert(DC && "This decl is not contained in a translation unit!");
214  }
215
216  return cast<TranslationUnitDecl>(DC);
217}
218
219ASTContext &Decl::getASTContext() const {
220  return getTranslationUnitDecl()->getASTContext();
221}
222
223ASTMutationListener *Decl::getASTMutationListener() const {
224  return getASTContext().getASTMutationListener();
225}
226
227bool Decl::isUsed(bool CheckUsedAttr) const {
228  if (Used)
229    return true;
230
231  // Check for used attribute.
232  if (CheckUsedAttr && hasAttr<UsedAttr>())
233    return true;
234
235  // Check redeclarations for used attribute.
236  for (redecl_iterator I = redecls_begin(), E = redecls_end(); I != E; ++I) {
237    if ((CheckUsedAttr && I->hasAttr<UsedAttr>()) || I->Used)
238      return true;
239  }
240
241  return false;
242}
243
244bool Decl::isReferenced() const {
245  if (Referenced)
246    return true;
247
248  // Check redeclarations.
249  for (redecl_iterator I = redecls_begin(), E = redecls_end(); I != E; ++I)
250    if (I->Referenced)
251      return true;
252
253  return false;
254}
255
256/// \brief Determine the availability of the given declaration based on
257/// the target platform.
258///
259/// When it returns an availability result other than \c AR_Available,
260/// if the \p Message parameter is non-NULL, it will be set to a
261/// string describing why the entity is unavailable.
262///
263/// FIXME: Make these strings localizable, since they end up in
264/// diagnostics.
265static AvailabilityResult CheckAvailability(ASTContext &Context,
266                                            const AvailabilityAttr *A,
267                                            std::string *Message) {
268  llvm::StringRef TargetPlatform = Context.Target.getPlatformName();
269  llvm::StringRef PrettyPlatformName
270    = AvailabilityAttr::getPrettyPlatformName(TargetPlatform);
271  if (PrettyPlatformName.empty())
272    PrettyPlatformName = TargetPlatform;
273
274  VersionTuple TargetMinVersion = Context.Target.getPlatformMinVersion();
275  if (TargetMinVersion.empty())
276    return AR_Available;
277
278  // Match the platform name.
279  if (A->getPlatform()->getName() != TargetPlatform)
280    return AR_Available;
281
282  // Make sure that this declaration has not been marked 'unavailable'.
283  if (A->getUnavailable()) {
284    if (Message) {
285      Message->clear();
286      llvm::raw_string_ostream Out(*Message);
287      Out << "not available on " << PrettyPlatformName;
288    }
289
290    return AR_Unavailable;
291  }
292
293  // Make sure that this declaration has already been introduced.
294  if (!A->getIntroduced().empty() &&
295      TargetMinVersion < A->getIntroduced()) {
296    if (Message) {
297      Message->clear();
298      llvm::raw_string_ostream Out(*Message);
299      Out << "introduced in " << PrettyPlatformName << ' '
300          << A->getIntroduced();
301    }
302
303    return AR_NotYetIntroduced;
304  }
305
306  // Make sure that this declaration hasn't been obsoleted.
307  if (!A->getObsoleted().empty() && TargetMinVersion >= A->getObsoleted()) {
308    if (Message) {
309      Message->clear();
310      llvm::raw_string_ostream Out(*Message);
311      Out << "obsoleted in " << PrettyPlatformName << ' '
312          << A->getObsoleted();
313    }
314
315    return AR_Unavailable;
316  }
317
318  // Make sure that this declaration hasn't been deprecated.
319  if (!A->getDeprecated().empty() && TargetMinVersion >= A->getDeprecated()) {
320    if (Message) {
321      Message->clear();
322      llvm::raw_string_ostream Out(*Message);
323      Out << "first deprecated in " << PrettyPlatformName << ' '
324          << A->getDeprecated();
325    }
326
327    return AR_Deprecated;
328  }
329
330  return AR_Available;
331}
332
333AvailabilityResult Decl::getAvailability(std::string *Message) const {
334  AvailabilityResult Result = AR_Available;
335  std::string ResultMessage;
336
337  for (attr_iterator A = attr_begin(), AEnd = attr_end(); A != AEnd; ++A) {
338    if (DeprecatedAttr *Deprecated = dyn_cast<DeprecatedAttr>(*A)) {
339      if (Result >= AR_Deprecated)
340        continue;
341
342      if (Message)
343        ResultMessage = Deprecated->getMessage();
344
345      Result = AR_Deprecated;
346      continue;
347    }
348
349    if (UnavailableAttr *Unavailable = dyn_cast<UnavailableAttr>(*A)) {
350      if (Message)
351        *Message = Unavailable->getMessage();
352      return AR_Unavailable;
353    }
354
355    if (AvailabilityAttr *Availability = dyn_cast<AvailabilityAttr>(*A)) {
356      AvailabilityResult AR = CheckAvailability(getASTContext(), Availability,
357                                                Message);
358
359      if (AR == AR_Unavailable)
360        return AR_Unavailable;
361
362      if (AR > Result) {
363        Result = AR;
364        if (Message)
365          ResultMessage.swap(*Message);
366      }
367      continue;
368    }
369  }
370
371  if (Message)
372    Message->swap(ResultMessage);
373  return Result;
374}
375
376bool Decl::canBeWeakImported(bool &IsDefinition) const {
377  IsDefinition = false;
378  if (const VarDecl *Var = dyn_cast<VarDecl>(this)) {
379    if (!Var->hasExternalStorage() || Var->getInit()) {
380      IsDefinition = true;
381      return false;
382    }
383  } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(this)) {
384    if (FD->hasBody()) {
385      IsDefinition = true;
386      return false;
387    }
388  } else if (isa<ObjCPropertyDecl>(this) || isa<ObjCMethodDecl>(this))
389    return false;
390  else if (!(getASTContext().getLangOptions().ObjCNonFragileABI &&
391             isa<ObjCInterfaceDecl>(this)))
392    return false;
393
394  return true;
395}
396
397bool Decl::isWeakImported() const {
398  bool IsDefinition;
399  if (!canBeWeakImported(IsDefinition))
400    return false;
401
402  for (attr_iterator A = attr_begin(), AEnd = attr_end(); A != AEnd; ++A) {
403    if (isa<WeakImportAttr>(*A))
404      return true;
405
406    if (AvailabilityAttr *Availability = dyn_cast<AvailabilityAttr>(*A)) {
407      if (CheckAvailability(getASTContext(), Availability, 0)
408                                                         == AR_NotYetIntroduced)
409        return true;
410    }
411  }
412
413  return false;
414}
415
416unsigned Decl::getIdentifierNamespaceForKind(Kind DeclKind) {
417  switch (DeclKind) {
418    case Function:
419    case CXXMethod:
420    case CXXConstructor:
421    case CXXDestructor:
422    case CXXConversion:
423    case EnumConstant:
424    case Var:
425    case ImplicitParam:
426    case ParmVar:
427    case NonTypeTemplateParm:
428    case ObjCMethod:
429    case ObjCProperty:
430      return IDNS_Ordinary;
431    case Label:
432      return IDNS_Label;
433    case IndirectField:
434      return IDNS_Ordinary | IDNS_Member;
435
436    case ObjCCompatibleAlias:
437    case ObjCInterface:
438      return IDNS_Ordinary | IDNS_Type;
439
440    case Typedef:
441    case TypeAlias:
442    case TypeAliasTemplate:
443    case UnresolvedUsingTypename:
444    case TemplateTypeParm:
445      return IDNS_Ordinary | IDNS_Type;
446
447    case UsingShadow:
448      return 0; // we'll actually overwrite this later
449
450    case UnresolvedUsingValue:
451      return IDNS_Ordinary | IDNS_Using;
452
453    case Using:
454      return IDNS_Using;
455
456    case ObjCProtocol:
457      return IDNS_ObjCProtocol;
458
459    case Field:
460    case ObjCAtDefsField:
461    case ObjCIvar:
462      return IDNS_Member;
463
464    case Record:
465    case CXXRecord:
466    case Enum:
467      return IDNS_Tag | IDNS_Type;
468
469    case Namespace:
470    case NamespaceAlias:
471      return IDNS_Namespace;
472
473    case FunctionTemplate:
474      return IDNS_Ordinary;
475
476    case ClassTemplate:
477    case TemplateTemplateParm:
478      return IDNS_Ordinary | IDNS_Tag | IDNS_Type;
479
480    // Never have names.
481    case Friend:
482    case FriendTemplate:
483    case AccessSpec:
484    case LinkageSpec:
485    case FileScopeAsm:
486    case StaticAssert:
487    case ObjCClass:
488    case ObjCPropertyImpl:
489    case ObjCForwardProtocol:
490    case Block:
491    case TranslationUnit:
492
493    case UsingDirective:
494    case ClassTemplateSpecialization:
495    case ClassTemplatePartialSpecialization:
496    case ObjCImplementation:
497    case ObjCCategory:
498    case ObjCCategoryImpl:
499      // Never looked up by name.
500      return 0;
501  }
502
503  return 0;
504}
505
506void Decl::setAttrs(const AttrVec &attrs) {
507  assert(!HasAttrs && "Decl already contains attrs.");
508
509  AttrVec &AttrBlank = getASTContext().getDeclAttrs(this);
510  assert(AttrBlank.empty() && "HasAttrs was wrong?");
511
512  AttrBlank = attrs;
513  HasAttrs = true;
514}
515
516void Decl::dropAttrs() {
517  if (!HasAttrs) return;
518
519  HasAttrs = false;
520  getASTContext().eraseDeclAttrs(this);
521}
522
523const AttrVec &Decl::getAttrs() const {
524  assert(HasAttrs && "No attrs to get!");
525  return getASTContext().getDeclAttrs(this);
526}
527
528void Decl::swapAttrs(Decl *RHS) {
529  bool HasLHSAttr = this->HasAttrs;
530  bool HasRHSAttr = RHS->HasAttrs;
531
532  // Usually, neither decl has attrs, nothing to do.
533  if (!HasLHSAttr && !HasRHSAttr) return;
534
535  // If 'this' has no attrs, swap the other way.
536  if (!HasLHSAttr)
537    return RHS->swapAttrs(this);
538
539  ASTContext &Context = getASTContext();
540
541  // Handle the case when both decls have attrs.
542  if (HasRHSAttr) {
543    std::swap(Context.getDeclAttrs(this), Context.getDeclAttrs(RHS));
544    return;
545  }
546
547  // Otherwise, LHS has an attr and RHS doesn't.
548  Context.getDeclAttrs(RHS) = Context.getDeclAttrs(this);
549  Context.eraseDeclAttrs(this);
550  this->HasAttrs = false;
551  RHS->HasAttrs = true;
552}
553
554Decl *Decl::castFromDeclContext (const DeclContext *D) {
555  Decl::Kind DK = D->getDeclKind();
556  switch(DK) {
557#define DECL(NAME, BASE)
558#define DECL_CONTEXT(NAME) \
559    case Decl::NAME:       \
560      return static_cast<NAME##Decl*>(const_cast<DeclContext*>(D));
561#define DECL_CONTEXT_BASE(NAME)
562#include "clang/AST/DeclNodes.inc"
563    default:
564#define DECL(NAME, BASE)
565#define DECL_CONTEXT_BASE(NAME)                  \
566      if (DK >= first##NAME && DK <= last##NAME) \
567        return static_cast<NAME##Decl*>(const_cast<DeclContext*>(D));
568#include "clang/AST/DeclNodes.inc"
569      assert(false && "a decl that inherits DeclContext isn't handled");
570      return 0;
571  }
572}
573
574DeclContext *Decl::castToDeclContext(const Decl *D) {
575  Decl::Kind DK = D->getKind();
576  switch(DK) {
577#define DECL(NAME, BASE)
578#define DECL_CONTEXT(NAME) \
579    case Decl::NAME:       \
580      return static_cast<NAME##Decl*>(const_cast<Decl*>(D));
581#define DECL_CONTEXT_BASE(NAME)
582#include "clang/AST/DeclNodes.inc"
583    default:
584#define DECL(NAME, BASE)
585#define DECL_CONTEXT_BASE(NAME)                                   \
586      if (DK >= first##NAME && DK <= last##NAME)                  \
587        return static_cast<NAME##Decl*>(const_cast<Decl*>(D));
588#include "clang/AST/DeclNodes.inc"
589      assert(false && "a decl that inherits DeclContext isn't handled");
590      return 0;
591  }
592}
593
594SourceLocation Decl::getBodyRBrace() const {
595  // Special handling of FunctionDecl to avoid de-serializing the body from PCH.
596  // FunctionDecl stores EndRangeLoc for this purpose.
597  if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(this)) {
598    const FunctionDecl *Definition;
599    if (FD->hasBody(Definition))
600      return Definition->getSourceRange().getEnd();
601    return SourceLocation();
602  }
603
604  if (Stmt *Body = getBody())
605    return Body->getSourceRange().getEnd();
606
607  return SourceLocation();
608}
609
610void Decl::CheckAccessDeclContext() const {
611#ifndef NDEBUG
612  // Suppress this check if any of the following hold:
613  // 1. this is the translation unit (and thus has no parent)
614  // 2. this is a template parameter (and thus doesn't belong to its context)
615  // 3. this is a non-type template parameter
616  // 4. the context is not a record
617  // 5. it's invalid
618  // 6. it's a C++0x static_assert.
619  if (isa<TranslationUnitDecl>(this) ||
620      isa<TemplateTypeParmDecl>(this) ||
621      isa<NonTypeTemplateParmDecl>(this) ||
622      !isa<CXXRecordDecl>(getDeclContext()) ||
623      isInvalidDecl() ||
624      isa<StaticAssertDecl>(this) ||
625      // FIXME: a ParmVarDecl can have ClassTemplateSpecialization
626      // as DeclContext (?).
627      isa<ParmVarDecl>(this) ||
628      // FIXME: a ClassTemplateSpecialization or CXXRecordDecl can have
629      // AS_none as access specifier.
630      isa<CXXRecordDecl>(this))
631    return;
632
633  assert(Access != AS_none &&
634         "Access specifier is AS_none inside a record decl");
635#endif
636}
637
638DeclContext *Decl::getNonClosureContext() {
639  DeclContext *DC = getDeclContext();
640
641  // This is basically "while (DC->isClosure()) DC = DC->getParent();"
642  // except that it's significantly more efficient to cast to a known
643  // decl type and call getDeclContext() than to call getParent().
644  while (isa<BlockDecl>(DC))
645    DC = cast<BlockDecl>(DC)->getDeclContext();
646
647  assert(!DC->isClosure());
648  return DC;
649}
650
651//===----------------------------------------------------------------------===//
652// DeclContext Implementation
653//===----------------------------------------------------------------------===//
654
655bool DeclContext::classof(const Decl *D) {
656  switch (D->getKind()) {
657#define DECL(NAME, BASE)
658#define DECL_CONTEXT(NAME) case Decl::NAME:
659#define DECL_CONTEXT_BASE(NAME)
660#include "clang/AST/DeclNodes.inc"
661      return true;
662    default:
663#define DECL(NAME, BASE)
664#define DECL_CONTEXT_BASE(NAME)                 \
665      if (D->getKind() >= Decl::first##NAME &&  \
666          D->getKind() <= Decl::last##NAME)     \
667        return true;
668#include "clang/AST/DeclNodes.inc"
669      return false;
670  }
671}
672
673DeclContext::~DeclContext() { }
674
675/// \brief Find the parent context of this context that will be
676/// used for unqualified name lookup.
677///
678/// Generally, the parent lookup context is the semantic context. However, for
679/// a friend function the parent lookup context is the lexical context, which
680/// is the class in which the friend is declared.
681DeclContext *DeclContext::getLookupParent() {
682  // FIXME: Find a better way to identify friends
683  if (isa<FunctionDecl>(this))
684    if (getParent()->getRedeclContext()->isFileContext() &&
685        getLexicalParent()->getRedeclContext()->isRecord())
686      return getLexicalParent();
687
688  return getParent();
689}
690
691bool DeclContext::isInlineNamespace() const {
692  return isNamespace() &&
693         cast<NamespaceDecl>(this)->isInline();
694}
695
696bool DeclContext::isDependentContext() const {
697  if (isFileContext())
698    return false;
699
700  if (isa<ClassTemplatePartialSpecializationDecl>(this))
701    return true;
702
703  if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(this))
704    if (Record->getDescribedClassTemplate())
705      return true;
706
707  if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(this)) {
708    if (Function->getDescribedFunctionTemplate())
709      return true;
710
711    // Friend function declarations are dependent if their *lexical*
712    // context is dependent.
713    if (cast<Decl>(this)->getFriendObjectKind())
714      return getLexicalParent()->isDependentContext();
715  }
716
717  return getParent() && getParent()->isDependentContext();
718}
719
720bool DeclContext::isTransparentContext() const {
721  if (DeclKind == Decl::Enum)
722    return !cast<EnumDecl>(this)->isScoped();
723  else if (DeclKind == Decl::LinkageSpec)
724    return true;
725
726  return false;
727}
728
729bool DeclContext::isExternCContext() const {
730  const DeclContext *DC = this;
731  while (DC->DeclKind != Decl::TranslationUnit) {
732    if (DC->DeclKind == Decl::LinkageSpec)
733      return cast<LinkageSpecDecl>(DC)->getLanguage()
734        == LinkageSpecDecl::lang_c;
735    DC = DC->getParent();
736  }
737  return false;
738}
739
740bool DeclContext::Encloses(const DeclContext *DC) const {
741  if (getPrimaryContext() != this)
742    return getPrimaryContext()->Encloses(DC);
743
744  for (; DC; DC = DC->getParent())
745    if (DC->getPrimaryContext() == this)
746      return true;
747  return false;
748}
749
750DeclContext *DeclContext::getPrimaryContext() {
751  switch (DeclKind) {
752  case Decl::TranslationUnit:
753  case Decl::LinkageSpec:
754  case Decl::Block:
755    // There is only one DeclContext for these entities.
756    return this;
757
758  case Decl::Namespace:
759    // The original namespace is our primary context.
760    return static_cast<NamespaceDecl*>(this)->getOriginalNamespace();
761
762  case Decl::ObjCMethod:
763    return this;
764
765  case Decl::ObjCInterface:
766  case Decl::ObjCProtocol:
767  case Decl::ObjCCategory:
768    // FIXME: Can Objective-C interfaces be forward-declared?
769    return this;
770
771  case Decl::ObjCImplementation:
772  case Decl::ObjCCategoryImpl:
773    return this;
774
775  default:
776    if (DeclKind >= Decl::firstTag && DeclKind <= Decl::lastTag) {
777      // If this is a tag type that has a definition or is currently
778      // being defined, that definition is our primary context.
779      TagDecl *Tag = cast<TagDecl>(this);
780      assert(isa<TagType>(Tag->TypeForDecl) ||
781             isa<InjectedClassNameType>(Tag->TypeForDecl));
782
783      if (TagDecl *Def = Tag->getDefinition())
784        return Def;
785
786      if (!isa<InjectedClassNameType>(Tag->TypeForDecl)) {
787        const TagType *TagTy = cast<TagType>(Tag->TypeForDecl);
788        if (TagTy->isBeingDefined())
789          // FIXME: is it necessarily being defined in the decl
790          // that owns the type?
791          return TagTy->getDecl();
792      }
793
794      return Tag;
795    }
796
797    assert(DeclKind >= Decl::firstFunction && DeclKind <= Decl::lastFunction &&
798          "Unknown DeclContext kind");
799    return this;
800  }
801}
802
803DeclContext *DeclContext::getNextContext() {
804  switch (DeclKind) {
805  case Decl::Namespace:
806    // Return the next namespace
807    return static_cast<NamespaceDecl*>(this)->getNextNamespace();
808
809  default:
810    return 0;
811  }
812}
813
814std::pair<Decl *, Decl *>
815DeclContext::BuildDeclChain(const llvm::SmallVectorImpl<Decl*> &Decls) {
816  // Build up a chain of declarations via the Decl::NextDeclInContext field.
817  Decl *FirstNewDecl = 0;
818  Decl *PrevDecl = 0;
819  for (unsigned I = 0, N = Decls.size(); I != N; ++I) {
820    Decl *D = Decls[I];
821    if (PrevDecl)
822      PrevDecl->NextDeclInContext = D;
823    else
824      FirstNewDecl = D;
825
826    PrevDecl = D;
827  }
828
829  return std::make_pair(FirstNewDecl, PrevDecl);
830}
831
832/// \brief Load the declarations within this lexical storage from an
833/// external source.
834void
835DeclContext::LoadLexicalDeclsFromExternalStorage() const {
836  ExternalASTSource *Source = getParentASTContext().getExternalSource();
837  assert(hasExternalLexicalStorage() && Source && "No external storage?");
838
839  // Notify that we have a DeclContext that is initializing.
840  ExternalASTSource::Deserializing ADeclContext(Source);
841
842  llvm::SmallVector<Decl*, 64> Decls;
843  if (Source->FindExternalLexicalDecls(this, Decls))
844    return;
845
846  // There is no longer any lexical storage in this context
847  ExternalLexicalStorage = false;
848
849  if (Decls.empty())
850    return;
851
852  // We may have already loaded just the fields of this record, in which case
853  // don't add the decls, just replace the FirstDecl/LastDecl chain.
854  if (const RecordDecl *RD = dyn_cast<RecordDecl>(this))
855    if (RD->LoadedFieldsFromExternalStorage) {
856      llvm::tie(FirstDecl, LastDecl) = BuildDeclChain(Decls);
857      return;
858    }
859
860  // Splice the newly-read declarations into the beginning of the list
861  // of declarations.
862  Decl *ExternalFirst, *ExternalLast;
863  llvm::tie(ExternalFirst, ExternalLast) = BuildDeclChain(Decls);
864  ExternalLast->NextDeclInContext = FirstDecl;
865  FirstDecl = ExternalFirst;
866  if (!LastDecl)
867    LastDecl = ExternalLast;
868}
869
870DeclContext::lookup_result
871ExternalASTSource::SetNoExternalVisibleDeclsForName(const DeclContext *DC,
872                                                    DeclarationName Name) {
873  ASTContext &Context = DC->getParentASTContext();
874  StoredDeclsMap *Map;
875  if (!(Map = DC->LookupPtr))
876    Map = DC->CreateStoredDeclsMap(Context);
877
878  StoredDeclsList &List = (*Map)[Name];
879  assert(List.isNull());
880  (void) List;
881
882  return DeclContext::lookup_result();
883}
884
885DeclContext::lookup_result
886ExternalASTSource::SetExternalVisibleDeclsForName(const DeclContext *DC,
887                                                  DeclarationName Name,
888                                    llvm::SmallVectorImpl<NamedDecl*> &Decls) {
889  ASTContext &Context = DC->getParentASTContext();;
890
891  StoredDeclsMap *Map;
892  if (!(Map = DC->LookupPtr))
893    Map = DC->CreateStoredDeclsMap(Context);
894
895  StoredDeclsList &List = (*Map)[Name];
896  for (unsigned I = 0, N = Decls.size(); I != N; ++I) {
897    if (List.isNull())
898      List.setOnlyValue(Decls[I]);
899    else
900      List.AddSubsequentDecl(Decls[I]);
901  }
902
903  return List.getLookupResult();
904}
905
906void ExternalASTSource::MaterializeVisibleDeclsForName(const DeclContext *DC,
907                                                       DeclarationName Name,
908                                     llvm::SmallVectorImpl<NamedDecl*> &Decls) {
909  assert(DC->LookupPtr);
910  StoredDeclsMap &Map = *DC->LookupPtr;
911
912  // If there's an entry in the table the visible decls for this name have
913  // already been deserialized.
914  if (Map.find(Name) == Map.end()) {
915    StoredDeclsList &List = Map[Name];
916    for (unsigned I = 0, N = Decls.size(); I != N; ++I) {
917      if (List.isNull())
918        List.setOnlyValue(Decls[I]);
919      else
920        List.AddSubsequentDecl(Decls[I]);
921    }
922  }
923}
924
925DeclContext::decl_iterator DeclContext::noload_decls_begin() const {
926  return decl_iterator(FirstDecl);
927}
928
929DeclContext::decl_iterator DeclContext::noload_decls_end() const {
930  return decl_iterator();
931}
932
933DeclContext::decl_iterator DeclContext::decls_begin() const {
934  if (hasExternalLexicalStorage())
935    LoadLexicalDeclsFromExternalStorage();
936
937  // FIXME: Check whether we need to load some declarations from
938  // external storage.
939  return decl_iterator(FirstDecl);
940}
941
942DeclContext::decl_iterator DeclContext::decls_end() const {
943  if (hasExternalLexicalStorage())
944    LoadLexicalDeclsFromExternalStorage();
945
946  return decl_iterator();
947}
948
949bool DeclContext::decls_empty() const {
950  if (hasExternalLexicalStorage())
951    LoadLexicalDeclsFromExternalStorage();
952
953  return !FirstDecl;
954}
955
956void DeclContext::removeDecl(Decl *D) {
957  assert(D->getLexicalDeclContext() == this &&
958         "decl being removed from non-lexical context");
959  assert((D->NextDeclInContext || D == LastDecl) &&
960         "decl is not in decls list");
961
962  // Remove D from the decl chain.  This is O(n) but hopefully rare.
963  if (D == FirstDecl) {
964    if (D == LastDecl)
965      FirstDecl = LastDecl = 0;
966    else
967      FirstDecl = D->NextDeclInContext;
968  } else {
969    for (Decl *I = FirstDecl; true; I = I->NextDeclInContext) {
970      assert(I && "decl not found in linked list");
971      if (I->NextDeclInContext == D) {
972        I->NextDeclInContext = D->NextDeclInContext;
973        if (D == LastDecl) LastDecl = I;
974        break;
975      }
976    }
977  }
978
979  // Mark that D is no longer in the decl chain.
980  D->NextDeclInContext = 0;
981
982  // Remove D from the lookup table if necessary.
983  if (isa<NamedDecl>(D)) {
984    NamedDecl *ND = cast<NamedDecl>(D);
985
986    StoredDeclsMap *Map = getPrimaryContext()->LookupPtr;
987    if (!Map) return;
988
989    StoredDeclsMap::iterator Pos = Map->find(ND->getDeclName());
990    assert(Pos != Map->end() && "no lookup entry for decl");
991    Pos->second.remove(ND);
992  }
993}
994
995void DeclContext::addHiddenDecl(Decl *D) {
996  assert(D->getLexicalDeclContext() == this &&
997         "Decl inserted into wrong lexical context");
998  assert(!D->getNextDeclInContext() && D != LastDecl &&
999         "Decl already inserted into a DeclContext");
1000
1001  if (FirstDecl) {
1002    LastDecl->NextDeclInContext = D;
1003    LastDecl = D;
1004  } else {
1005    FirstDecl = LastDecl = D;
1006  }
1007
1008  // Notify a C++ record declaration that we've added a member, so it can
1009  // update it's class-specific state.
1010  if (CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(this))
1011    Record->addedMember(D);
1012}
1013
1014void DeclContext::addDecl(Decl *D) {
1015  addHiddenDecl(D);
1016
1017  if (NamedDecl *ND = dyn_cast<NamedDecl>(D))
1018    ND->getDeclContext()->makeDeclVisibleInContext(ND);
1019}
1020
1021/// buildLookup - Build the lookup data structure with all of the
1022/// declarations in DCtx (and any other contexts linked to it or
1023/// transparent contexts nested within it).
1024void DeclContext::buildLookup(DeclContext *DCtx) {
1025  for (; DCtx; DCtx = DCtx->getNextContext()) {
1026    for (decl_iterator D = DCtx->decls_begin(),
1027                    DEnd = DCtx->decls_end();
1028         D != DEnd; ++D) {
1029      // Insert this declaration into the lookup structure, but only
1030      // if it's semantically in its decl context.  During non-lazy
1031      // lookup building, this is implicitly enforced by addDecl.
1032      if (NamedDecl *ND = dyn_cast<NamedDecl>(*D))
1033        if (D->getDeclContext() == DCtx)
1034          makeDeclVisibleInContextImpl(ND);
1035
1036      // Insert any forward-declared Objective-C interfaces into the lookup
1037      // data structure.
1038      if (ObjCClassDecl *Class = dyn_cast<ObjCClassDecl>(*D))
1039        for (ObjCClassDecl::iterator I = Class->begin(), IEnd = Class->end();
1040             I != IEnd; ++I)
1041          makeDeclVisibleInContextImpl(I->getInterface());
1042
1043      // If this declaration is itself a transparent declaration context or
1044      // inline namespace, add its members (recursively).
1045      if (DeclContext *InnerCtx = dyn_cast<DeclContext>(*D))
1046        if (InnerCtx->isTransparentContext() || InnerCtx->isInlineNamespace())
1047          buildLookup(InnerCtx->getPrimaryContext());
1048    }
1049  }
1050}
1051
1052DeclContext::lookup_result
1053DeclContext::lookup(DeclarationName Name) {
1054  DeclContext *PrimaryContext = getPrimaryContext();
1055  if (PrimaryContext != this)
1056    return PrimaryContext->lookup(Name);
1057
1058  if (hasExternalVisibleStorage()) {
1059    // Check to see if we've already cached the lookup results.
1060    if (LookupPtr) {
1061      StoredDeclsMap::iterator I = LookupPtr->find(Name);
1062      if (I != LookupPtr->end())
1063        return I->second.getLookupResult();
1064    }
1065
1066    ExternalASTSource *Source = getParentASTContext().getExternalSource();
1067    return Source->FindExternalVisibleDeclsByName(this, Name);
1068  }
1069
1070  /// If there is no lookup data structure, build one now by walking
1071  /// all of the linked DeclContexts (in declaration order!) and
1072  /// inserting their values.
1073  if (!LookupPtr) {
1074    buildLookup(this);
1075
1076    if (!LookupPtr)
1077      return lookup_result(lookup_iterator(0), lookup_iterator(0));
1078  }
1079
1080  StoredDeclsMap::iterator Pos = LookupPtr->find(Name);
1081  if (Pos == LookupPtr->end())
1082    return lookup_result(lookup_iterator(0), lookup_iterator(0));
1083  return Pos->second.getLookupResult();
1084}
1085
1086DeclContext::lookup_const_result
1087DeclContext::lookup(DeclarationName Name) const {
1088  return const_cast<DeclContext*>(this)->lookup(Name);
1089}
1090
1091DeclContext *DeclContext::getRedeclContext() {
1092  DeclContext *Ctx = this;
1093  // Skip through transparent contexts.
1094  while (Ctx->isTransparentContext())
1095    Ctx = Ctx->getParent();
1096  return Ctx;
1097}
1098
1099DeclContext *DeclContext::getEnclosingNamespaceContext() {
1100  DeclContext *Ctx = this;
1101  // Skip through non-namespace, non-translation-unit contexts.
1102  while (!Ctx->isFileContext())
1103    Ctx = Ctx->getParent();
1104  return Ctx->getPrimaryContext();
1105}
1106
1107bool DeclContext::InEnclosingNamespaceSetOf(const DeclContext *O) const {
1108  // For non-file contexts, this is equivalent to Equals.
1109  if (!isFileContext())
1110    return O->Equals(this);
1111
1112  do {
1113    if (O->Equals(this))
1114      return true;
1115
1116    const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(O);
1117    if (!NS || !NS->isInline())
1118      break;
1119    O = NS->getParent();
1120  } while (O);
1121
1122  return false;
1123}
1124
1125void DeclContext::makeDeclVisibleInContext(NamedDecl *D, bool Recoverable) {
1126  // FIXME: This feels like a hack. Should DeclarationName support
1127  // template-ids, or is there a better way to keep specializations
1128  // from being visible?
1129  if (isa<ClassTemplateSpecializationDecl>(D) || D->isTemplateParameter())
1130    return;
1131  if (FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
1132    if (FD->isFunctionTemplateSpecialization())
1133      return;
1134
1135  DeclContext *PrimaryContext = getPrimaryContext();
1136  if (PrimaryContext != this) {
1137    PrimaryContext->makeDeclVisibleInContext(D, Recoverable);
1138    return;
1139  }
1140
1141  // If we already have a lookup data structure, perform the insertion
1142  // into it. If we haven't deserialized externally stored decls, deserialize
1143  // them so we can add the decl. Otherwise, be lazy and don't build that
1144  // structure until someone asks for it.
1145  if (LookupPtr || !Recoverable || hasExternalVisibleStorage())
1146    makeDeclVisibleInContextImpl(D);
1147
1148  // If we are a transparent context or inline namespace, insert into our
1149  // parent context, too. This operation is recursive.
1150  if (isTransparentContext() || isInlineNamespace())
1151    getParent()->makeDeclVisibleInContext(D, Recoverable);
1152
1153  Decl *DCAsDecl = cast<Decl>(this);
1154  // Notify that a decl was made visible unless it's a Tag being defined.
1155  if (!(isa<TagDecl>(DCAsDecl) && cast<TagDecl>(DCAsDecl)->isBeingDefined()))
1156    if (ASTMutationListener *L = DCAsDecl->getASTMutationListener())
1157      L->AddedVisibleDecl(this, D);
1158}
1159
1160void DeclContext::makeDeclVisibleInContextImpl(NamedDecl *D) {
1161  // Skip unnamed declarations.
1162  if (!D->getDeclName())
1163    return;
1164
1165  // Skip entities that can't be found by name lookup into a particular
1166  // context.
1167  if ((D->getIdentifierNamespace() == 0 && !isa<UsingDirectiveDecl>(D)) ||
1168      D->isTemplateParameter())
1169    return;
1170
1171  ASTContext *C = 0;
1172  if (!LookupPtr) {
1173    C = &getParentASTContext();
1174    CreateStoredDeclsMap(*C);
1175  }
1176
1177  // If there is an external AST source, load any declarations it knows about
1178  // with this declaration's name.
1179  // If the lookup table contains an entry about this name it means that we
1180  // have already checked the external source.
1181  if (ExternalASTSource *Source = getParentASTContext().getExternalSource())
1182    if (hasExternalVisibleStorage() &&
1183        LookupPtr->find(D->getDeclName()) == LookupPtr->end())
1184      Source->FindExternalVisibleDeclsByName(this, D->getDeclName());
1185
1186  // Insert this declaration into the map.
1187  StoredDeclsList &DeclNameEntries = (*LookupPtr)[D->getDeclName()];
1188  if (DeclNameEntries.isNull()) {
1189    DeclNameEntries.setOnlyValue(D);
1190    return;
1191  }
1192
1193  // If it is possible that this is a redeclaration, check to see if there is
1194  // already a decl for which declarationReplaces returns true.  If there is
1195  // one, just replace it and return.
1196  if (DeclNameEntries.HandleRedeclaration(D))
1197    return;
1198
1199  // Put this declaration into the appropriate slot.
1200  DeclNameEntries.AddSubsequentDecl(D);
1201}
1202
1203void DeclContext::MaterializeVisibleDeclsFromExternalStorage() {
1204  ExternalASTSource *Source = getParentASTContext().getExternalSource();
1205  assert(hasExternalVisibleStorage() && Source && "No external storage?");
1206
1207  if (!LookupPtr)
1208    CreateStoredDeclsMap(getParentASTContext());
1209  Source->MaterializeVisibleDecls(this);
1210}
1211
1212/// Returns iterator range [First, Last) of UsingDirectiveDecls stored within
1213/// this context.
1214DeclContext::udir_iterator_range
1215DeclContext::getUsingDirectives() const {
1216  lookup_const_result Result = lookup(UsingDirectiveDecl::getName());
1217  return udir_iterator_range(reinterpret_cast<udir_iterator>(Result.first),
1218                             reinterpret_cast<udir_iterator>(Result.second));
1219}
1220
1221//===----------------------------------------------------------------------===//
1222// Creation and Destruction of StoredDeclsMaps.                               //
1223//===----------------------------------------------------------------------===//
1224
1225StoredDeclsMap *DeclContext::CreateStoredDeclsMap(ASTContext &C) const {
1226  assert(!LookupPtr && "context already has a decls map");
1227  assert(getPrimaryContext() == this &&
1228         "creating decls map on non-primary context");
1229
1230  StoredDeclsMap *M;
1231  bool Dependent = isDependentContext();
1232  if (Dependent)
1233    M = new DependentStoredDeclsMap();
1234  else
1235    M = new StoredDeclsMap();
1236  M->Previous = C.LastSDM;
1237  C.LastSDM = llvm::PointerIntPair<StoredDeclsMap*,1>(M, Dependent);
1238  LookupPtr = M;
1239  return M;
1240}
1241
1242void ASTContext::ReleaseDeclContextMaps() {
1243  // It's okay to delete DependentStoredDeclsMaps via a StoredDeclsMap
1244  // pointer because the subclass doesn't add anything that needs to
1245  // be deleted.
1246  StoredDeclsMap::DestroyAll(LastSDM.getPointer(), LastSDM.getInt());
1247}
1248
1249void StoredDeclsMap::DestroyAll(StoredDeclsMap *Map, bool Dependent) {
1250  while (Map) {
1251    // Advance the iteration before we invalidate memory.
1252    llvm::PointerIntPair<StoredDeclsMap*,1> Next = Map->Previous;
1253
1254    if (Dependent)
1255      delete static_cast<DependentStoredDeclsMap*>(Map);
1256    else
1257      delete Map;
1258
1259    Map = Next.getPointer();
1260    Dependent = Next.getInt();
1261  }
1262}
1263
1264DependentDiagnostic *DependentDiagnostic::Create(ASTContext &C,
1265                                                 DeclContext *Parent,
1266                                           const PartialDiagnostic &PDiag) {
1267  assert(Parent->isDependentContext()
1268         && "cannot iterate dependent diagnostics of non-dependent context");
1269  Parent = Parent->getPrimaryContext();
1270  if (!Parent->LookupPtr)
1271    Parent->CreateStoredDeclsMap(C);
1272
1273  DependentStoredDeclsMap *Map
1274    = static_cast<DependentStoredDeclsMap*>(Parent->LookupPtr);
1275
1276  // Allocate the copy of the PartialDiagnostic via the ASTContext's
1277  // BumpPtrAllocator, rather than the ASTContext itself.
1278  PartialDiagnostic::Storage *DiagStorage = 0;
1279  if (PDiag.hasStorage())
1280    DiagStorage = new (C) PartialDiagnostic::Storage;
1281
1282  DependentDiagnostic *DD = new (C) DependentDiagnostic(PDiag, DiagStorage);
1283
1284  // TODO: Maybe we shouldn't reverse the order during insertion.
1285  DD->NextDiagnostic = Map->FirstDiagnostic;
1286  Map->FirstDiagnostic = DD;
1287
1288  return DD;
1289}
1290