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/ASTContext.h"
16 #include "clang/AST/ASTMutationListener.h"
17 #include "clang/AST/Attr.h"
18 #include "clang/AST/Decl.h"
19 #include "clang/AST/DeclCXX.h"
20 #include "clang/AST/DeclContextInternals.h"
21 #include "clang/AST/DeclFriend.h"
22 #include "clang/AST/DeclObjC.h"
23 #include "clang/AST/DeclOpenMP.h"
24 #include "clang/AST/DeclTemplate.h"
25 #include "clang/AST/DependentDiagnostic.h"
26 #include "clang/AST/ExternalASTSource.h"
27 #include "clang/AST/Stmt.h"
28 #include "clang/AST/StmtCXX.h"
29 #include "clang/AST/Type.h"
30 #include "clang/Basic/TargetInfo.h"
31 #include "llvm/ADT/DenseMap.h"
32 #include "llvm/Support/raw_ostream.h"
33 #include <algorithm>
34 using namespace clang;
35 
36 //===----------------------------------------------------------------------===//
37 //  Statistics
38 //===----------------------------------------------------------------------===//
39 
40 #define DECL(DERIVED, BASE) static int n##DERIVED##s = 0;
41 #define ABSTRACT_DECL(DECL)
42 #include "clang/AST/DeclNodes.inc"
43 
44 void Decl::updateOutOfDate(IdentifierInfo &II) const {
45   getASTContext().getExternalSource()->updateOutOfDateIdentifier(II);
46 }
47 
48 #define DECL(DERIVED, BASE)                                                    \
49   static_assert(Decl::DeclObjAlignment >=                                      \
50                     llvm::AlignOf<DERIVED##Decl>::Alignment,                   \
51                 "Alignment sufficient after objects prepended to " #DERIVED);
52 #define ABSTRACT_DECL(DECL)
53 #include "clang/AST/DeclNodes.inc"
54 
55 void *Decl::operator new(std::size_t Size, const ASTContext &Context,
56                          unsigned ID, std::size_t Extra) {
57   // Allocate an extra 8 bytes worth of storage, which ensures that the
58   // resulting pointer will still be 8-byte aligned.
59   static_assert(sizeof(unsigned) * 2 >= DeclObjAlignment,
60                 "Decl won't be misaligned");
61   void *Start = Context.Allocate(Size + Extra + 8);
62   void *Result = (char*)Start + 8;
63 
64   unsigned *PrefixPtr = (unsigned *)Result - 2;
65 
66   // Zero out the first 4 bytes; this is used to store the owning module ID.
67   PrefixPtr[0] = 0;
68 
69   // Store the global declaration ID in the second 4 bytes.
70   PrefixPtr[1] = ID;
71 
72   return Result;
73 }
74 
75 void *Decl::operator new(std::size_t Size, const ASTContext &Ctx,
76                          DeclContext *Parent, std::size_t Extra) {
77   assert(!Parent || &Parent->getParentASTContext() == &Ctx);
78   // With local visibility enabled, we track the owning module even for local
79   // declarations.
80   if (Ctx.getLangOpts().ModulesLocalVisibility) {
81     // Ensure required alignment of the resulting object by adding extra
82     // padding at the start if required.
83     size_t ExtraAlign =
84         llvm::OffsetToAlignment(sizeof(Module *), DeclObjAlignment);
85     char *Buffer = reinterpret_cast<char *>(
86         ::operator new(ExtraAlign + sizeof(Module *) + Size + Extra, Ctx));
87     Buffer += ExtraAlign;
88     return new (Buffer) Module*(nullptr) + 1;
89   }
90   return ::operator new(Size + Extra, Ctx);
91 }
92 
93 Module *Decl::getOwningModuleSlow() const {
94   assert(isFromASTFile() && "Not from AST file?");
95   return getASTContext().getExternalSource()->getModule(getOwningModuleID());
96 }
97 
98 bool Decl::hasLocalOwningModuleStorage() const {
99   return getASTContext().getLangOpts().ModulesLocalVisibility;
100 }
101 
102 const char *Decl::getDeclKindName() const {
103   switch (DeclKind) {
104   default: llvm_unreachable("Declaration not in DeclNodes.inc!");
105 #define DECL(DERIVED, BASE) case DERIVED: return #DERIVED;
106 #define ABSTRACT_DECL(DECL)
107 #include "clang/AST/DeclNodes.inc"
108   }
109 }
110 
111 void Decl::setInvalidDecl(bool Invalid) {
112   InvalidDecl = Invalid;
113   assert(!isa<TagDecl>(this) || !cast<TagDecl>(this)->isCompleteDefinition());
114   if (Invalid && !isa<ParmVarDecl>(this)) {
115     // Defensive maneuver for ill-formed code: we're likely not to make it to
116     // a point where we set the access specifier, so default it to "public"
117     // to avoid triggering asserts elsewhere in the front end.
118     setAccess(AS_public);
119   }
120 }
121 
122 const char *DeclContext::getDeclKindName() const {
123   switch (DeclKind) {
124   default: llvm_unreachable("Declaration context not in DeclNodes.inc!");
125 #define DECL(DERIVED, BASE) case Decl::DERIVED: return #DERIVED;
126 #define ABSTRACT_DECL(DECL)
127 #include "clang/AST/DeclNodes.inc"
128   }
129 }
130 
131 bool Decl::StatisticsEnabled = false;
132 void Decl::EnableStatistics() {
133   StatisticsEnabled = true;
134 }
135 
136 void Decl::PrintStats() {
137   llvm::errs() << "\n*** Decl Stats:\n";
138 
139   int totalDecls = 0;
140 #define DECL(DERIVED, BASE) totalDecls += n##DERIVED##s;
141 #define ABSTRACT_DECL(DECL)
142 #include "clang/AST/DeclNodes.inc"
143   llvm::errs() << "  " << totalDecls << " decls total.\n";
144 
145   int totalBytes = 0;
146 #define DECL(DERIVED, BASE)                                             \
147   if (n##DERIVED##s > 0) {                                              \
148     totalBytes += (int)(n##DERIVED##s * sizeof(DERIVED##Decl));         \
149     llvm::errs() << "    " << n##DERIVED##s << " " #DERIVED " decls, "  \
150                  << sizeof(DERIVED##Decl) << " each ("                  \
151                  << n##DERIVED##s * sizeof(DERIVED##Decl)               \
152                  << " bytes)\n";                                        \
153   }
154 #define ABSTRACT_DECL(DECL)
155 #include "clang/AST/DeclNodes.inc"
156 
157   llvm::errs() << "Total bytes = " << totalBytes << "\n";
158 }
159 
160 void Decl::add(Kind k) {
161   switch (k) {
162 #define DECL(DERIVED, BASE) case DERIVED: ++n##DERIVED##s; break;
163 #define ABSTRACT_DECL(DECL)
164 #include "clang/AST/DeclNodes.inc"
165   }
166 }
167 
168 bool Decl::isTemplateParameterPack() const {
169   if (const TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(this))
170     return TTP->isParameterPack();
171   if (const NonTypeTemplateParmDecl *NTTP
172                                 = dyn_cast<NonTypeTemplateParmDecl>(this))
173     return NTTP->isParameterPack();
174   if (const TemplateTemplateParmDecl *TTP
175                                     = dyn_cast<TemplateTemplateParmDecl>(this))
176     return TTP->isParameterPack();
177   return false;
178 }
179 
180 bool Decl::isParameterPack() const {
181   if (const ParmVarDecl *Parm = dyn_cast<ParmVarDecl>(this))
182     return Parm->isParameterPack();
183 
184   return isTemplateParameterPack();
185 }
186 
187 FunctionDecl *Decl::getAsFunction() {
188   if (FunctionDecl *FD = dyn_cast<FunctionDecl>(this))
189     return FD;
190   if (const FunctionTemplateDecl *FTD = dyn_cast<FunctionTemplateDecl>(this))
191     return FTD->getTemplatedDecl();
192   return nullptr;
193 }
194 
195 bool Decl::isTemplateDecl() const {
196   return isa<TemplateDecl>(this);
197 }
198 
199 const DeclContext *Decl::getParentFunctionOrMethod() const {
200   for (const DeclContext *DC = getDeclContext();
201        DC && !DC->isTranslationUnit() && !DC->isNamespace();
202        DC = DC->getParent())
203     if (DC->isFunctionOrMethod())
204       return DC;
205 
206   return nullptr;
207 }
208 
209 
210 //===----------------------------------------------------------------------===//
211 // PrettyStackTraceDecl Implementation
212 //===----------------------------------------------------------------------===//
213 
214 void PrettyStackTraceDecl::print(raw_ostream &OS) const {
215   SourceLocation TheLoc = Loc;
216   if (TheLoc.isInvalid() && TheDecl)
217     TheLoc = TheDecl->getLocation();
218 
219   if (TheLoc.isValid()) {
220     TheLoc.print(OS, SM);
221     OS << ": ";
222   }
223 
224   OS << Message;
225 
226   if (const NamedDecl *DN = dyn_cast_or_null<NamedDecl>(TheDecl)) {
227     OS << " '";
228     DN->printQualifiedName(OS);
229     OS << '\'';
230   }
231   OS << '\n';
232 }
233 
234 //===----------------------------------------------------------------------===//
235 // Decl Implementation
236 //===----------------------------------------------------------------------===//
237 
238 // Out-of-line virtual method providing a home for Decl.
239 Decl::~Decl() { }
240 
241 void Decl::setDeclContext(DeclContext *DC) {
242   DeclCtx = DC;
243 }
244 
245 void Decl::setLexicalDeclContext(DeclContext *DC) {
246   if (DC == getLexicalDeclContext())
247     return;
248 
249   if (isInSemaDC()) {
250     setDeclContextsImpl(getDeclContext(), DC, getASTContext());
251   } else {
252     getMultipleDC()->LexicalDC = DC;
253   }
254   Hidden = cast<Decl>(DC)->Hidden;
255 }
256 
257 void Decl::setDeclContextsImpl(DeclContext *SemaDC, DeclContext *LexicalDC,
258                                ASTContext &Ctx) {
259   if (SemaDC == LexicalDC) {
260     DeclCtx = SemaDC;
261   } else {
262     Decl::MultipleDC *MDC = new (Ctx) Decl::MultipleDC();
263     MDC->SemanticDC = SemaDC;
264     MDC->LexicalDC = LexicalDC;
265     DeclCtx = MDC;
266   }
267 }
268 
269 bool Decl::isLexicallyWithinFunctionOrMethod() const {
270   const DeclContext *LDC = getLexicalDeclContext();
271   while (true) {
272     if (LDC->isFunctionOrMethod())
273       return true;
274     if (!isa<TagDecl>(LDC))
275       return false;
276     LDC = LDC->getLexicalParent();
277   }
278   return false;
279 }
280 
281 bool Decl::isInAnonymousNamespace() const {
282   const DeclContext *DC = getDeclContext();
283   do {
284     if (const NamespaceDecl *ND = dyn_cast<NamespaceDecl>(DC))
285       if (ND->isAnonymousNamespace())
286         return true;
287   } while ((DC = DC->getParent()));
288 
289   return false;
290 }
291 
292 bool Decl::isInStdNamespace() const {
293   return getDeclContext()->isStdNamespace();
294 }
295 
296 TranslationUnitDecl *Decl::getTranslationUnitDecl() {
297   if (TranslationUnitDecl *TUD = dyn_cast<TranslationUnitDecl>(this))
298     return TUD;
299 
300   DeclContext *DC = getDeclContext();
301   assert(DC && "This decl is not contained in a translation unit!");
302 
303   while (!DC->isTranslationUnit()) {
304     DC = DC->getParent();
305     assert(DC && "This decl is not contained in a translation unit!");
306   }
307 
308   return cast<TranslationUnitDecl>(DC);
309 }
310 
311 ASTContext &Decl::getASTContext() const {
312   return getTranslationUnitDecl()->getASTContext();
313 }
314 
315 ASTMutationListener *Decl::getASTMutationListener() const {
316   return getASTContext().getASTMutationListener();
317 }
318 
319 unsigned Decl::getMaxAlignment() const {
320   if (!hasAttrs())
321     return 0;
322 
323   unsigned Align = 0;
324   const AttrVec &V = getAttrs();
325   ASTContext &Ctx = getASTContext();
326   specific_attr_iterator<AlignedAttr> I(V.begin()), E(V.end());
327   for (; I != E; ++I)
328     Align = std::max(Align, I->getAlignment(Ctx));
329   return Align;
330 }
331 
332 bool Decl::isUsed(bool CheckUsedAttr) const {
333   if (Used)
334     return true;
335 
336   // Check for used attribute.
337   if (CheckUsedAttr && hasAttr<UsedAttr>())
338     return true;
339 
340   return false;
341 }
342 
343 void Decl::markUsed(ASTContext &C) {
344   if (Used)
345     return;
346 
347   if (C.getASTMutationListener())
348     C.getASTMutationListener()->DeclarationMarkedUsed(this);
349 
350   Used = true;
351 }
352 
353 bool Decl::isReferenced() const {
354   if (Referenced)
355     return true;
356 
357   // Check redeclarations.
358   for (auto I : redecls())
359     if (I->Referenced)
360       return true;
361 
362   return false;
363 }
364 
365 bool Decl::hasDefiningAttr() const {
366   return hasAttr<AliasAttr>() || hasAttr<IFuncAttr>();
367 }
368 
369 const Attr *Decl::getDefiningAttr() const {
370   if (AliasAttr *AA = getAttr<AliasAttr>())
371     return AA;
372   if (IFuncAttr *IFA = getAttr<IFuncAttr>())
373     return IFA;
374   return nullptr;
375 }
376 
377 /// \brief Determine the availability of the given declaration based on
378 /// the target platform.
379 ///
380 /// When it returns an availability result other than \c AR_Available,
381 /// if the \p Message parameter is non-NULL, it will be set to a
382 /// string describing why the entity is unavailable.
383 ///
384 /// FIXME: Make these strings localizable, since they end up in
385 /// diagnostics.
386 static AvailabilityResult CheckAvailability(ASTContext &Context,
387                                             const AvailabilityAttr *A,
388                                             std::string *Message) {
389   VersionTuple TargetMinVersion =
390     Context.getTargetInfo().getPlatformMinVersion();
391 
392   if (TargetMinVersion.empty())
393     return AR_Available;
394 
395   // Check if this is an App Extension "platform", and if so chop off
396   // the suffix for matching with the actual platform.
397   StringRef ActualPlatform = A->getPlatform()->getName();
398   StringRef RealizedPlatform = ActualPlatform;
399   if (Context.getLangOpts().AppExt) {
400     size_t suffix = RealizedPlatform.rfind("_app_extension");
401     if (suffix != StringRef::npos)
402       RealizedPlatform = RealizedPlatform.slice(0, suffix);
403   }
404 
405   StringRef TargetPlatform = Context.getTargetInfo().getPlatformName();
406 
407   // Match the platform name.
408   if (RealizedPlatform != TargetPlatform)
409     return AR_Available;
410 
411   StringRef PrettyPlatformName
412     = AvailabilityAttr::getPrettyPlatformName(ActualPlatform);
413 
414   if (PrettyPlatformName.empty())
415     PrettyPlatformName = ActualPlatform;
416 
417   std::string HintMessage;
418   if (!A->getMessage().empty()) {
419     HintMessage = " - ";
420     HintMessage += A->getMessage();
421   }
422 
423   // Make sure that this declaration has not been marked 'unavailable'.
424   if (A->getUnavailable()) {
425     if (Message) {
426       Message->clear();
427       llvm::raw_string_ostream Out(*Message);
428       Out << "not available on " << PrettyPlatformName
429           << HintMessage;
430     }
431 
432     return AR_Unavailable;
433   }
434 
435   // Make sure that this declaration has already been introduced.
436   if (!A->getIntroduced().empty() &&
437       TargetMinVersion < A->getIntroduced()) {
438     if (Message) {
439       Message->clear();
440       llvm::raw_string_ostream Out(*Message);
441       VersionTuple VTI(A->getIntroduced());
442       VTI.UseDotAsSeparator();
443       Out << "introduced in " << PrettyPlatformName << ' '
444           << VTI << HintMessage;
445     }
446 
447     return A->getStrict() ? AR_Unavailable : AR_NotYetIntroduced;
448   }
449 
450   // Make sure that this declaration hasn't been obsoleted.
451   if (!A->getObsoleted().empty() && TargetMinVersion >= A->getObsoleted()) {
452     if (Message) {
453       Message->clear();
454       llvm::raw_string_ostream Out(*Message);
455       VersionTuple VTO(A->getObsoleted());
456       VTO.UseDotAsSeparator();
457       Out << "obsoleted in " << PrettyPlatformName << ' '
458           << VTO << HintMessage;
459     }
460 
461     return AR_Unavailable;
462   }
463 
464   // Make sure that this declaration hasn't been deprecated.
465   if (!A->getDeprecated().empty() && TargetMinVersion >= A->getDeprecated()) {
466     if (Message) {
467       Message->clear();
468       llvm::raw_string_ostream Out(*Message);
469       VersionTuple VTD(A->getDeprecated());
470       VTD.UseDotAsSeparator();
471       Out << "first deprecated in " << PrettyPlatformName << ' '
472           << VTD << HintMessage;
473     }
474 
475     return AR_Deprecated;
476   }
477 
478   return AR_Available;
479 }
480 
481 AvailabilityResult Decl::getAvailability(std::string *Message) const {
482   if (auto *FTD = dyn_cast<FunctionTemplateDecl>(this))
483     return FTD->getTemplatedDecl()->getAvailability(Message);
484 
485   AvailabilityResult Result = AR_Available;
486   std::string ResultMessage;
487 
488   for (const auto *A : attrs()) {
489     if (const auto *Deprecated = dyn_cast<DeprecatedAttr>(A)) {
490       if (Result >= AR_Deprecated)
491         continue;
492 
493       if (Message)
494         ResultMessage = Deprecated->getMessage();
495 
496       Result = AR_Deprecated;
497       continue;
498     }
499 
500     if (const auto *Unavailable = dyn_cast<UnavailableAttr>(A)) {
501       if (Message)
502         *Message = Unavailable->getMessage();
503       return AR_Unavailable;
504     }
505 
506     if (const auto *Availability = dyn_cast<AvailabilityAttr>(A)) {
507       AvailabilityResult AR = CheckAvailability(getASTContext(), Availability,
508                                                 Message);
509 
510       if (AR == AR_Unavailable)
511         return AR_Unavailable;
512 
513       if (AR > Result) {
514         Result = AR;
515         if (Message)
516           ResultMessage.swap(*Message);
517       }
518       continue;
519     }
520   }
521 
522   if (Message)
523     Message->swap(ResultMessage);
524   return Result;
525 }
526 
527 bool Decl::canBeWeakImported(bool &IsDefinition) const {
528   IsDefinition = false;
529 
530   // Variables, if they aren't definitions.
531   if (const VarDecl *Var = dyn_cast<VarDecl>(this)) {
532     if (Var->isThisDeclarationADefinition()) {
533       IsDefinition = true;
534       return false;
535     }
536     return true;
537 
538   // Functions, if they aren't definitions.
539   } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(this)) {
540     if (FD->hasBody()) {
541       IsDefinition = true;
542       return false;
543     }
544     return true;
545 
546   // Objective-C classes, if this is the non-fragile runtime.
547   } else if (isa<ObjCInterfaceDecl>(this) &&
548              getASTContext().getLangOpts().ObjCRuntime.hasWeakClassImport()) {
549     return true;
550 
551   // Nothing else.
552   } else {
553     return false;
554   }
555 }
556 
557 bool Decl::isWeakImported() const {
558   bool IsDefinition;
559   if (!canBeWeakImported(IsDefinition))
560     return false;
561 
562   for (const auto *A : attrs()) {
563     if (isa<WeakImportAttr>(A))
564       return true;
565 
566     if (const auto *Availability = dyn_cast<AvailabilityAttr>(A)) {
567       if (CheckAvailability(getASTContext(), Availability,
568                             nullptr) == AR_NotYetIntroduced)
569         return true;
570     }
571   }
572 
573   return false;
574 }
575 
576 unsigned Decl::getIdentifierNamespaceForKind(Kind DeclKind) {
577   switch (DeclKind) {
578     case Function:
579     case CXXMethod:
580     case CXXConstructor:
581     case CXXDestructor:
582     case CXXConversion:
583     case EnumConstant:
584     case Var:
585     case ImplicitParam:
586     case ParmVar:
587     case ObjCMethod:
588     case ObjCProperty:
589     case MSProperty:
590       return IDNS_Ordinary;
591     case Label:
592       return IDNS_Label;
593     case IndirectField:
594       return IDNS_Ordinary | IDNS_Member;
595 
596     case NonTypeTemplateParm:
597       // Non-type template parameters are not found by lookups that ignore
598       // non-types, but they are found by redeclaration lookups for tag types,
599       // so we include them in the tag namespace.
600       return IDNS_Ordinary | IDNS_Tag;
601 
602     case ObjCCompatibleAlias:
603     case ObjCInterface:
604       return IDNS_Ordinary | IDNS_Type;
605 
606     case Typedef:
607     case TypeAlias:
608     case TypeAliasTemplate:
609     case UnresolvedUsingTypename:
610     case TemplateTypeParm:
611     case ObjCTypeParam:
612       return IDNS_Ordinary | IDNS_Type;
613 
614     case UsingShadow:
615       return 0; // we'll actually overwrite this later
616 
617     case UnresolvedUsingValue:
618       return IDNS_Ordinary | IDNS_Using;
619 
620     case Using:
621       return IDNS_Using;
622 
623     case ObjCProtocol:
624       return IDNS_ObjCProtocol;
625 
626     case Field:
627     case ObjCAtDefsField:
628     case ObjCIvar:
629       return IDNS_Member;
630 
631     case Record:
632     case CXXRecord:
633     case Enum:
634       return IDNS_Tag | IDNS_Type;
635 
636     case Namespace:
637     case NamespaceAlias:
638       return IDNS_Namespace;
639 
640     case FunctionTemplate:
641     case VarTemplate:
642       return IDNS_Ordinary;
643 
644     case ClassTemplate:
645     case TemplateTemplateParm:
646       return IDNS_Ordinary | IDNS_Tag | IDNS_Type;
647 
648     case OMPDeclareReduction:
649       return IDNS_OMPReduction;
650 
651     // Never have names.
652     case Friend:
653     case FriendTemplate:
654     case AccessSpec:
655     case LinkageSpec:
656     case FileScopeAsm:
657     case StaticAssert:
658     case ObjCPropertyImpl:
659     case PragmaComment:
660     case PragmaDetectMismatch:
661     case Block:
662     case Captured:
663     case TranslationUnit:
664     case ExternCContext:
665 
666     case UsingDirective:
667     case BuiltinTemplate:
668     case ClassTemplateSpecialization:
669     case ClassTemplatePartialSpecialization:
670     case ClassScopeFunctionSpecialization:
671     case VarTemplateSpecialization:
672     case VarTemplatePartialSpecialization:
673     case ObjCImplementation:
674     case ObjCCategory:
675     case ObjCCategoryImpl:
676     case Import:
677     case OMPThreadPrivate:
678     case OMPCapturedExpr:
679     case Empty:
680       // Never looked up by name.
681       return 0;
682   }
683 
684   llvm_unreachable("Invalid DeclKind!");
685 }
686 
687 void Decl::setAttrsImpl(const AttrVec &attrs, ASTContext &Ctx) {
688   assert(!HasAttrs && "Decl already contains attrs.");
689 
690   AttrVec &AttrBlank = Ctx.getDeclAttrs(this);
691   assert(AttrBlank.empty() && "HasAttrs was wrong?");
692 
693   AttrBlank = attrs;
694   HasAttrs = true;
695 }
696 
697 void Decl::dropAttrs() {
698   if (!HasAttrs) return;
699 
700   HasAttrs = false;
701   getASTContext().eraseDeclAttrs(this);
702 }
703 
704 const AttrVec &Decl::getAttrs() const {
705   assert(HasAttrs && "No attrs to get!");
706   return getASTContext().getDeclAttrs(this);
707 }
708 
709 Decl *Decl::castFromDeclContext (const DeclContext *D) {
710   Decl::Kind DK = D->getDeclKind();
711   switch(DK) {
712 #define DECL(NAME, BASE)
713 #define DECL_CONTEXT(NAME) \
714     case Decl::NAME:       \
715       return static_cast<NAME##Decl*>(const_cast<DeclContext*>(D));
716 #define DECL_CONTEXT_BASE(NAME)
717 #include "clang/AST/DeclNodes.inc"
718     default:
719 #define DECL(NAME, BASE)
720 #define DECL_CONTEXT_BASE(NAME)                  \
721       if (DK >= first##NAME && DK <= last##NAME) \
722         return static_cast<NAME##Decl*>(const_cast<DeclContext*>(D));
723 #include "clang/AST/DeclNodes.inc"
724       llvm_unreachable("a decl that inherits DeclContext isn't handled");
725   }
726 }
727 
728 DeclContext *Decl::castToDeclContext(const Decl *D) {
729   Decl::Kind DK = D->getKind();
730   switch(DK) {
731 #define DECL(NAME, BASE)
732 #define DECL_CONTEXT(NAME) \
733     case Decl::NAME:       \
734       return static_cast<NAME##Decl*>(const_cast<Decl*>(D));
735 #define DECL_CONTEXT_BASE(NAME)
736 #include "clang/AST/DeclNodes.inc"
737     default:
738 #define DECL(NAME, BASE)
739 #define DECL_CONTEXT_BASE(NAME)                                   \
740       if (DK >= first##NAME && DK <= last##NAME)                  \
741         return static_cast<NAME##Decl*>(const_cast<Decl*>(D));
742 #include "clang/AST/DeclNodes.inc"
743       llvm_unreachable("a decl that inherits DeclContext isn't handled");
744   }
745 }
746 
747 SourceLocation Decl::getBodyRBrace() const {
748   // Special handling of FunctionDecl to avoid de-serializing the body from PCH.
749   // FunctionDecl stores EndRangeLoc for this purpose.
750   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(this)) {
751     const FunctionDecl *Definition;
752     if (FD->hasBody(Definition))
753       return Definition->getSourceRange().getEnd();
754     return SourceLocation();
755   }
756 
757   if (Stmt *Body = getBody())
758     return Body->getSourceRange().getEnd();
759 
760   return SourceLocation();
761 }
762 
763 bool Decl::AccessDeclContextSanity() const {
764 #ifndef NDEBUG
765   // Suppress this check if any of the following hold:
766   // 1. this is the translation unit (and thus has no parent)
767   // 2. this is a template parameter (and thus doesn't belong to its context)
768   // 3. this is a non-type template parameter
769   // 4. the context is not a record
770   // 5. it's invalid
771   // 6. it's a C++0x static_assert.
772   if (isa<TranslationUnitDecl>(this) ||
773       isa<TemplateTypeParmDecl>(this) ||
774       isa<NonTypeTemplateParmDecl>(this) ||
775       !isa<CXXRecordDecl>(getDeclContext()) ||
776       isInvalidDecl() ||
777       isa<StaticAssertDecl>(this) ||
778       // FIXME: a ParmVarDecl can have ClassTemplateSpecialization
779       // as DeclContext (?).
780       isa<ParmVarDecl>(this) ||
781       // FIXME: a ClassTemplateSpecialization or CXXRecordDecl can have
782       // AS_none as access specifier.
783       isa<CXXRecordDecl>(this) ||
784       isa<ClassScopeFunctionSpecializationDecl>(this))
785     return true;
786 
787   assert(Access != AS_none &&
788          "Access specifier is AS_none inside a record decl");
789 #endif
790   return true;
791 }
792 
793 static Decl::Kind getKind(const Decl *D) { return D->getKind(); }
794 static Decl::Kind getKind(const DeclContext *DC) { return DC->getDeclKind(); }
795 
796 const FunctionType *Decl::getFunctionType(bool BlocksToo) const {
797   QualType Ty;
798   if (const ValueDecl *D = dyn_cast<ValueDecl>(this))
799     Ty = D->getType();
800   else if (const TypedefNameDecl *D = dyn_cast<TypedefNameDecl>(this))
801     Ty = D->getUnderlyingType();
802   else
803     return nullptr;
804 
805   if (Ty->isFunctionPointerType())
806     Ty = Ty->getAs<PointerType>()->getPointeeType();
807   else if (BlocksToo && Ty->isBlockPointerType())
808     Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
809 
810   return Ty->getAs<FunctionType>();
811 }
812 
813 
814 /// Starting at a given context (a Decl or DeclContext), look for a
815 /// code context that is not a closure (a lambda, block, etc.).
816 template <class T> static Decl *getNonClosureContext(T *D) {
817   if (getKind(D) == Decl::CXXMethod) {
818     CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
819     if (MD->getOverloadedOperator() == OO_Call &&
820         MD->getParent()->isLambda())
821       return getNonClosureContext(MD->getParent()->getParent());
822     return MD;
823   } else if (FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
824     return FD;
825   } else if (ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
826     return MD;
827   } else if (BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
828     return getNonClosureContext(BD->getParent());
829   } else if (CapturedDecl *CD = dyn_cast<CapturedDecl>(D)) {
830     return getNonClosureContext(CD->getParent());
831   } else {
832     return nullptr;
833   }
834 }
835 
836 Decl *Decl::getNonClosureContext() {
837   return ::getNonClosureContext(this);
838 }
839 
840 Decl *DeclContext::getNonClosureAncestor() {
841   return ::getNonClosureContext(this);
842 }
843 
844 //===----------------------------------------------------------------------===//
845 // DeclContext Implementation
846 //===----------------------------------------------------------------------===//
847 
848 bool DeclContext::classof(const Decl *D) {
849   switch (D->getKind()) {
850 #define DECL(NAME, BASE)
851 #define DECL_CONTEXT(NAME) case Decl::NAME:
852 #define DECL_CONTEXT_BASE(NAME)
853 #include "clang/AST/DeclNodes.inc"
854       return true;
855     default:
856 #define DECL(NAME, BASE)
857 #define DECL_CONTEXT_BASE(NAME)                 \
858       if (D->getKind() >= Decl::first##NAME &&  \
859           D->getKind() <= Decl::last##NAME)     \
860         return true;
861 #include "clang/AST/DeclNodes.inc"
862       return false;
863   }
864 }
865 
866 DeclContext::~DeclContext() { }
867 
868 /// \brief Find the parent context of this context that will be
869 /// used for unqualified name lookup.
870 ///
871 /// Generally, the parent lookup context is the semantic context. However, for
872 /// a friend function the parent lookup context is the lexical context, which
873 /// is the class in which the friend is declared.
874 DeclContext *DeclContext::getLookupParent() {
875   // FIXME: Find a better way to identify friends
876   if (isa<FunctionDecl>(this))
877     if (getParent()->getRedeclContext()->isFileContext() &&
878         getLexicalParent()->getRedeclContext()->isRecord())
879       return getLexicalParent();
880 
881   return getParent();
882 }
883 
884 bool DeclContext::isInlineNamespace() const {
885   return isNamespace() &&
886          cast<NamespaceDecl>(this)->isInline();
887 }
888 
889 bool DeclContext::isStdNamespace() const {
890   if (!isNamespace())
891     return false;
892 
893   const NamespaceDecl *ND = cast<NamespaceDecl>(this);
894   if (ND->isInline()) {
895     return ND->getParent()->isStdNamespace();
896   }
897 
898   if (!getParent()->getRedeclContext()->isTranslationUnit())
899     return false;
900 
901   const IdentifierInfo *II = ND->getIdentifier();
902   return II && II->isStr("std");
903 }
904 
905 bool DeclContext::isDependentContext() const {
906   if (isFileContext())
907     return false;
908 
909   if (isa<ClassTemplatePartialSpecializationDecl>(this))
910     return true;
911 
912   if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(this)) {
913     if (Record->getDescribedClassTemplate())
914       return true;
915 
916     if (Record->isDependentLambda())
917       return true;
918   }
919 
920   if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(this)) {
921     if (Function->getDescribedFunctionTemplate())
922       return true;
923 
924     // Friend function declarations are dependent if their *lexical*
925     // context is dependent.
926     if (cast<Decl>(this)->getFriendObjectKind())
927       return getLexicalParent()->isDependentContext();
928   }
929 
930   // FIXME: A variable template is a dependent context, but is not a
931   // DeclContext. A context within it (such as a lambda-expression)
932   // should be considered dependent.
933 
934   return getParent() && getParent()->isDependentContext();
935 }
936 
937 bool DeclContext::isTransparentContext() const {
938   if (DeclKind == Decl::Enum)
939     return !cast<EnumDecl>(this)->isScoped();
940   else if (DeclKind == Decl::LinkageSpec)
941     return true;
942 
943   return false;
944 }
945 
946 static bool isLinkageSpecContext(const DeclContext *DC,
947                                  LinkageSpecDecl::LanguageIDs ID) {
948   while (DC->getDeclKind() != Decl::TranslationUnit) {
949     if (DC->getDeclKind() == Decl::LinkageSpec)
950       return cast<LinkageSpecDecl>(DC)->getLanguage() == ID;
951     DC = DC->getLexicalParent();
952   }
953   return false;
954 }
955 
956 bool DeclContext::isExternCContext() const {
957   return isLinkageSpecContext(this, clang::LinkageSpecDecl::lang_c);
958 }
959 
960 bool DeclContext::isExternCXXContext() const {
961   return isLinkageSpecContext(this, clang::LinkageSpecDecl::lang_cxx);
962 }
963 
964 bool DeclContext::Encloses(const DeclContext *DC) const {
965   if (getPrimaryContext() != this)
966     return getPrimaryContext()->Encloses(DC);
967 
968   for (; DC; DC = DC->getParent())
969     if (DC->getPrimaryContext() == this)
970       return true;
971   return false;
972 }
973 
974 DeclContext *DeclContext::getPrimaryContext() {
975   switch (DeclKind) {
976   case Decl::TranslationUnit:
977   case Decl::ExternCContext:
978   case Decl::LinkageSpec:
979   case Decl::Block:
980   case Decl::Captured:
981   case Decl::OMPDeclareReduction:
982     // There is only one DeclContext for these entities.
983     return this;
984 
985   case Decl::Namespace:
986     // The original namespace is our primary context.
987     return static_cast<NamespaceDecl*>(this)->getOriginalNamespace();
988 
989   case Decl::ObjCMethod:
990     return this;
991 
992   case Decl::ObjCInterface:
993     if (ObjCInterfaceDecl *Def = cast<ObjCInterfaceDecl>(this)->getDefinition())
994       return Def;
995 
996     return this;
997 
998   case Decl::ObjCProtocol:
999     if (ObjCProtocolDecl *Def = cast<ObjCProtocolDecl>(this)->getDefinition())
1000       return Def;
1001 
1002     return this;
1003 
1004   case Decl::ObjCCategory:
1005     return this;
1006 
1007   case Decl::ObjCImplementation:
1008   case Decl::ObjCCategoryImpl:
1009     return this;
1010 
1011   default:
1012     if (DeclKind >= Decl::firstTag && DeclKind <= Decl::lastTag) {
1013       // If this is a tag type that has a definition or is currently
1014       // being defined, that definition is our primary context.
1015       TagDecl *Tag = cast<TagDecl>(this);
1016 
1017       if (TagDecl *Def = Tag->getDefinition())
1018         return Def;
1019 
1020       if (const TagType *TagTy = dyn_cast<TagType>(Tag->getTypeForDecl())) {
1021         // Note, TagType::getDecl returns the (partial) definition one exists.
1022         TagDecl *PossiblePartialDef = TagTy->getDecl();
1023         if (PossiblePartialDef->isBeingDefined())
1024           return PossiblePartialDef;
1025       } else {
1026         assert(isa<InjectedClassNameType>(Tag->getTypeForDecl()));
1027       }
1028 
1029       return Tag;
1030     }
1031 
1032     assert(DeclKind >= Decl::firstFunction && DeclKind <= Decl::lastFunction &&
1033           "Unknown DeclContext kind");
1034     return this;
1035   }
1036 }
1037 
1038 void
1039 DeclContext::collectAllContexts(SmallVectorImpl<DeclContext *> &Contexts){
1040   Contexts.clear();
1041 
1042   if (DeclKind != Decl::Namespace) {
1043     Contexts.push_back(this);
1044     return;
1045   }
1046 
1047   NamespaceDecl *Self = static_cast<NamespaceDecl *>(this);
1048   for (NamespaceDecl *N = Self->getMostRecentDecl(); N;
1049        N = N->getPreviousDecl())
1050     Contexts.push_back(N);
1051 
1052   std::reverse(Contexts.begin(), Contexts.end());
1053 }
1054 
1055 std::pair<Decl *, Decl *>
1056 DeclContext::BuildDeclChain(ArrayRef<Decl*> Decls,
1057                             bool FieldsAlreadyLoaded) {
1058   // Build up a chain of declarations via the Decl::NextInContextAndBits field.
1059   Decl *FirstNewDecl = nullptr;
1060   Decl *PrevDecl = nullptr;
1061   for (unsigned I = 0, N = Decls.size(); I != N; ++I) {
1062     if (FieldsAlreadyLoaded && isa<FieldDecl>(Decls[I]))
1063       continue;
1064 
1065     Decl *D = Decls[I];
1066     if (PrevDecl)
1067       PrevDecl->NextInContextAndBits.setPointer(D);
1068     else
1069       FirstNewDecl = D;
1070 
1071     PrevDecl = D;
1072   }
1073 
1074   return std::make_pair(FirstNewDecl, PrevDecl);
1075 }
1076 
1077 /// \brief We have just acquired external visible storage, and we already have
1078 /// built a lookup map. For every name in the map, pull in the new names from
1079 /// the external storage.
1080 void DeclContext::reconcileExternalVisibleStorage() const {
1081   assert(NeedToReconcileExternalVisibleStorage && LookupPtr);
1082   NeedToReconcileExternalVisibleStorage = false;
1083 
1084   for (auto &Lookup : *LookupPtr)
1085     Lookup.second.setHasExternalDecls();
1086 }
1087 
1088 /// \brief Load the declarations within this lexical storage from an
1089 /// external source.
1090 /// \return \c true if any declarations were added.
1091 bool
1092 DeclContext::LoadLexicalDeclsFromExternalStorage() const {
1093   ExternalASTSource *Source = getParentASTContext().getExternalSource();
1094   assert(hasExternalLexicalStorage() && Source && "No external storage?");
1095 
1096   // Notify that we have a DeclContext that is initializing.
1097   ExternalASTSource::Deserializing ADeclContext(Source);
1098 
1099   // Load the external declarations, if any.
1100   SmallVector<Decl*, 64> Decls;
1101   ExternalLexicalStorage = false;
1102   Source->FindExternalLexicalDecls(this, Decls);
1103 
1104   if (Decls.empty())
1105     return false;
1106 
1107   // We may have already loaded just the fields of this record, in which case
1108   // we need to ignore them.
1109   bool FieldsAlreadyLoaded = false;
1110   if (const RecordDecl *RD = dyn_cast<RecordDecl>(this))
1111     FieldsAlreadyLoaded = RD->LoadedFieldsFromExternalStorage;
1112 
1113   // Splice the newly-read declarations into the beginning of the list
1114   // of declarations.
1115   Decl *ExternalFirst, *ExternalLast;
1116   std::tie(ExternalFirst, ExternalLast) =
1117       BuildDeclChain(Decls, FieldsAlreadyLoaded);
1118   ExternalLast->NextInContextAndBits.setPointer(FirstDecl);
1119   FirstDecl = ExternalFirst;
1120   if (!LastDecl)
1121     LastDecl = ExternalLast;
1122   return true;
1123 }
1124 
1125 DeclContext::lookup_result
1126 ExternalASTSource::SetNoExternalVisibleDeclsForName(const DeclContext *DC,
1127                                                     DeclarationName Name) {
1128   ASTContext &Context = DC->getParentASTContext();
1129   StoredDeclsMap *Map;
1130   if (!(Map = DC->LookupPtr))
1131     Map = DC->CreateStoredDeclsMap(Context);
1132   if (DC->NeedToReconcileExternalVisibleStorage)
1133     DC->reconcileExternalVisibleStorage();
1134 
1135   (*Map)[Name].removeExternalDecls();
1136 
1137   return DeclContext::lookup_result();
1138 }
1139 
1140 DeclContext::lookup_result
1141 ExternalASTSource::SetExternalVisibleDeclsForName(const DeclContext *DC,
1142                                                   DeclarationName Name,
1143                                                   ArrayRef<NamedDecl*> Decls) {
1144   ASTContext &Context = DC->getParentASTContext();
1145   StoredDeclsMap *Map;
1146   if (!(Map = DC->LookupPtr))
1147     Map = DC->CreateStoredDeclsMap(Context);
1148   if (DC->NeedToReconcileExternalVisibleStorage)
1149     DC->reconcileExternalVisibleStorage();
1150 
1151   StoredDeclsList &List = (*Map)[Name];
1152 
1153   // Clear out any old external visible declarations, to avoid quadratic
1154   // performance in the redeclaration checks below.
1155   List.removeExternalDecls();
1156 
1157   if (!List.isNull()) {
1158     // We have both existing declarations and new declarations for this name.
1159     // Some of the declarations may simply replace existing ones. Handle those
1160     // first.
1161     llvm::SmallVector<unsigned, 8> Skip;
1162     for (unsigned I = 0, N = Decls.size(); I != N; ++I)
1163       if (List.HandleRedeclaration(Decls[I], /*IsKnownNewer*/false))
1164         Skip.push_back(I);
1165     Skip.push_back(Decls.size());
1166 
1167     // Add in any new declarations.
1168     unsigned SkipPos = 0;
1169     for (unsigned I = 0, N = Decls.size(); I != N; ++I) {
1170       if (I == Skip[SkipPos])
1171         ++SkipPos;
1172       else
1173         List.AddSubsequentDecl(Decls[I]);
1174     }
1175   } else {
1176     // Convert the array to a StoredDeclsList.
1177     for (ArrayRef<NamedDecl*>::iterator
1178            I = Decls.begin(), E = Decls.end(); I != E; ++I) {
1179       if (List.isNull())
1180         List.setOnlyValue(*I);
1181       else
1182         List.AddSubsequentDecl(*I);
1183     }
1184   }
1185 
1186   return List.getLookupResult();
1187 }
1188 
1189 DeclContext::decl_iterator DeclContext::decls_begin() const {
1190   if (hasExternalLexicalStorage())
1191     LoadLexicalDeclsFromExternalStorage();
1192   return decl_iterator(FirstDecl);
1193 }
1194 
1195 bool DeclContext::decls_empty() const {
1196   if (hasExternalLexicalStorage())
1197     LoadLexicalDeclsFromExternalStorage();
1198 
1199   return !FirstDecl;
1200 }
1201 
1202 bool DeclContext::containsDecl(Decl *D) const {
1203   return (D->getLexicalDeclContext() == this &&
1204           (D->NextInContextAndBits.getPointer() || D == LastDecl));
1205 }
1206 
1207 void DeclContext::removeDecl(Decl *D) {
1208   assert(D->getLexicalDeclContext() == this &&
1209          "decl being removed from non-lexical context");
1210   assert((D->NextInContextAndBits.getPointer() || D == LastDecl) &&
1211          "decl is not in decls list");
1212 
1213   // Remove D from the decl chain.  This is O(n) but hopefully rare.
1214   if (D == FirstDecl) {
1215     if (D == LastDecl)
1216       FirstDecl = LastDecl = nullptr;
1217     else
1218       FirstDecl = D->NextInContextAndBits.getPointer();
1219   } else {
1220     for (Decl *I = FirstDecl; true; I = I->NextInContextAndBits.getPointer()) {
1221       assert(I && "decl not found in linked list");
1222       if (I->NextInContextAndBits.getPointer() == D) {
1223         I->NextInContextAndBits.setPointer(D->NextInContextAndBits.getPointer());
1224         if (D == LastDecl) LastDecl = I;
1225         break;
1226       }
1227     }
1228   }
1229 
1230   // Mark that D is no longer in the decl chain.
1231   D->NextInContextAndBits.setPointer(nullptr);
1232 
1233   // Remove D from the lookup table if necessary.
1234   if (isa<NamedDecl>(D)) {
1235     NamedDecl *ND = cast<NamedDecl>(D);
1236 
1237     // Remove only decls that have a name
1238     if (!ND->getDeclName()) return;
1239 
1240     auto *DC = this;
1241     do {
1242       StoredDeclsMap *Map = DC->getPrimaryContext()->LookupPtr;
1243       if (Map) {
1244         StoredDeclsMap::iterator Pos = Map->find(ND->getDeclName());
1245         assert(Pos != Map->end() && "no lookup entry for decl");
1246         if (Pos->second.getAsVector() || Pos->second.getAsDecl() == ND)
1247           Pos->second.remove(ND);
1248       }
1249     } while (DC->isTransparentContext() && (DC = DC->getParent()));
1250   }
1251 }
1252 
1253 void DeclContext::addHiddenDecl(Decl *D) {
1254   assert(D->getLexicalDeclContext() == this &&
1255          "Decl inserted into wrong lexical context");
1256   assert(!D->getNextDeclInContext() && D != LastDecl &&
1257          "Decl already inserted into a DeclContext");
1258 
1259   if (FirstDecl) {
1260     LastDecl->NextInContextAndBits.setPointer(D);
1261     LastDecl = D;
1262   } else {
1263     FirstDecl = LastDecl = D;
1264   }
1265 
1266   // Notify a C++ record declaration that we've added a member, so it can
1267   // update its class-specific state.
1268   if (CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(this))
1269     Record->addedMember(D);
1270 
1271   // If this is a newly-created (not de-serialized) import declaration, wire
1272   // it in to the list of local import declarations.
1273   if (!D->isFromASTFile()) {
1274     if (ImportDecl *Import = dyn_cast<ImportDecl>(D))
1275       D->getASTContext().addedLocalImportDecl(Import);
1276   }
1277 }
1278 
1279 void DeclContext::addDecl(Decl *D) {
1280   addHiddenDecl(D);
1281 
1282   if (NamedDecl *ND = dyn_cast<NamedDecl>(D))
1283     ND->getDeclContext()->getPrimaryContext()->
1284         makeDeclVisibleInContextWithFlags(ND, false, true);
1285 }
1286 
1287 void DeclContext::addDeclInternal(Decl *D) {
1288   addHiddenDecl(D);
1289 
1290   if (NamedDecl *ND = dyn_cast<NamedDecl>(D))
1291     ND->getDeclContext()->getPrimaryContext()->
1292         makeDeclVisibleInContextWithFlags(ND, true, true);
1293 }
1294 
1295 /// shouldBeHidden - Determine whether a declaration which was declared
1296 /// within its semantic context should be invisible to qualified name lookup.
1297 static bool shouldBeHidden(NamedDecl *D) {
1298   // Skip unnamed declarations.
1299   if (!D->getDeclName())
1300     return true;
1301 
1302   // Skip entities that can't be found by name lookup into a particular
1303   // context.
1304   if ((D->getIdentifierNamespace() == 0 && !isa<UsingDirectiveDecl>(D)) ||
1305       D->isTemplateParameter())
1306     return true;
1307 
1308   // Skip template specializations.
1309   // FIXME: This feels like a hack. Should DeclarationName support
1310   // template-ids, or is there a better way to keep specializations
1311   // from being visible?
1312   if (isa<ClassTemplateSpecializationDecl>(D))
1313     return true;
1314   if (FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
1315     if (FD->isFunctionTemplateSpecialization())
1316       return true;
1317 
1318   return false;
1319 }
1320 
1321 /// buildLookup - Build the lookup data structure with all of the
1322 /// declarations in this DeclContext (and any other contexts linked
1323 /// to it or transparent contexts nested within it) and return it.
1324 ///
1325 /// Note that the produced map may miss out declarations from an
1326 /// external source. If it does, those entries will be marked with
1327 /// the 'hasExternalDecls' flag.
1328 StoredDeclsMap *DeclContext::buildLookup() {
1329   assert(this == getPrimaryContext() && "buildLookup called on non-primary DC");
1330 
1331   if (!HasLazyLocalLexicalLookups && !HasLazyExternalLexicalLookups)
1332     return LookupPtr;
1333 
1334   SmallVector<DeclContext *, 2> Contexts;
1335   collectAllContexts(Contexts);
1336 
1337   if (HasLazyExternalLexicalLookups) {
1338     HasLazyExternalLexicalLookups = false;
1339     for (auto *DC : Contexts) {
1340       if (DC->hasExternalLexicalStorage())
1341         HasLazyLocalLexicalLookups |=
1342             DC->LoadLexicalDeclsFromExternalStorage();
1343     }
1344 
1345     if (!HasLazyLocalLexicalLookups)
1346       return LookupPtr;
1347   }
1348 
1349   for (auto *DC : Contexts)
1350     buildLookupImpl(DC, hasExternalVisibleStorage());
1351 
1352   // We no longer have any lazy decls.
1353   HasLazyLocalLexicalLookups = false;
1354   return LookupPtr;
1355 }
1356 
1357 /// buildLookupImpl - Build part of the lookup data structure for the
1358 /// declarations contained within DCtx, which will either be this
1359 /// DeclContext, a DeclContext linked to it, or a transparent context
1360 /// nested within it.
1361 void DeclContext::buildLookupImpl(DeclContext *DCtx, bool Internal) {
1362   for (Decl *D : DCtx->noload_decls()) {
1363     // Insert this declaration into the lookup structure, but only if
1364     // it's semantically within its decl context. Any other decls which
1365     // should be found in this context are added eagerly.
1366     //
1367     // If it's from an AST file, don't add it now. It'll get handled by
1368     // FindExternalVisibleDeclsByName if needed. Exception: if we're not
1369     // in C++, we do not track external visible decls for the TU, so in
1370     // that case we need to collect them all here.
1371     if (NamedDecl *ND = dyn_cast<NamedDecl>(D))
1372       if (ND->getDeclContext() == DCtx && !shouldBeHidden(ND) &&
1373           (!ND->isFromASTFile() ||
1374            (isTranslationUnit() &&
1375             !getParentASTContext().getLangOpts().CPlusPlus)))
1376         makeDeclVisibleInContextImpl(ND, Internal);
1377 
1378     // If this declaration is itself a transparent declaration context
1379     // or inline namespace, add the members of this declaration of that
1380     // context (recursively).
1381     if (DeclContext *InnerCtx = dyn_cast<DeclContext>(D))
1382       if (InnerCtx->isTransparentContext() || InnerCtx->isInlineNamespace())
1383         buildLookupImpl(InnerCtx, Internal);
1384   }
1385 }
1386 
1387 NamedDecl *const DeclContextLookupResult::SingleElementDummyList = nullptr;
1388 
1389 DeclContext::lookup_result
1390 DeclContext::lookup(DeclarationName Name) const {
1391   assert(DeclKind != Decl::LinkageSpec &&
1392          "Should not perform lookups into linkage specs!");
1393 
1394   const DeclContext *PrimaryContext = getPrimaryContext();
1395   if (PrimaryContext != this)
1396     return PrimaryContext->lookup(Name);
1397 
1398   // If we have an external source, ensure that any later redeclarations of this
1399   // context have been loaded, since they may add names to the result of this
1400   // lookup (or add external visible storage).
1401   ExternalASTSource *Source = getParentASTContext().getExternalSource();
1402   if (Source)
1403     (void)cast<Decl>(this)->getMostRecentDecl();
1404 
1405   if (hasExternalVisibleStorage()) {
1406     assert(Source && "external visible storage but no external source?");
1407 
1408     if (NeedToReconcileExternalVisibleStorage)
1409       reconcileExternalVisibleStorage();
1410 
1411     StoredDeclsMap *Map = LookupPtr;
1412 
1413     if (HasLazyLocalLexicalLookups || HasLazyExternalLexicalLookups)
1414       // FIXME: Make buildLookup const?
1415       Map = const_cast<DeclContext*>(this)->buildLookup();
1416 
1417     if (!Map)
1418       Map = CreateStoredDeclsMap(getParentASTContext());
1419 
1420     // If we have a lookup result with no external decls, we are done.
1421     std::pair<StoredDeclsMap::iterator, bool> R =
1422         Map->insert(std::make_pair(Name, StoredDeclsList()));
1423     if (!R.second && !R.first->second.hasExternalDecls())
1424       return R.first->second.getLookupResult();
1425 
1426     if (Source->FindExternalVisibleDeclsByName(this, Name) || !R.second) {
1427       if (StoredDeclsMap *Map = LookupPtr) {
1428         StoredDeclsMap::iterator I = Map->find(Name);
1429         if (I != Map->end())
1430           return I->second.getLookupResult();
1431       }
1432     }
1433 
1434     return lookup_result();
1435   }
1436 
1437   StoredDeclsMap *Map = LookupPtr;
1438   if (HasLazyLocalLexicalLookups || HasLazyExternalLexicalLookups)
1439     Map = const_cast<DeclContext*>(this)->buildLookup();
1440 
1441   if (!Map)
1442     return lookup_result();
1443 
1444   StoredDeclsMap::iterator I = Map->find(Name);
1445   if (I == Map->end())
1446     return lookup_result();
1447 
1448   return I->second.getLookupResult();
1449 }
1450 
1451 DeclContext::lookup_result
1452 DeclContext::noload_lookup(DeclarationName Name) {
1453   assert(DeclKind != Decl::LinkageSpec &&
1454          "Should not perform lookups into linkage specs!");
1455 
1456   DeclContext *PrimaryContext = getPrimaryContext();
1457   if (PrimaryContext != this)
1458     return PrimaryContext->noload_lookup(Name);
1459 
1460   // If we have any lazy lexical declarations not in our lookup map, add them
1461   // now. Don't import any external declarations, not even if we know we have
1462   // some missing from the external visible lookups.
1463   if (HasLazyLocalLexicalLookups) {
1464     SmallVector<DeclContext *, 2> Contexts;
1465     collectAllContexts(Contexts);
1466     for (unsigned I = 0, N = Contexts.size(); I != N; ++I)
1467       buildLookupImpl(Contexts[I], hasExternalVisibleStorage());
1468     HasLazyLocalLexicalLookups = false;
1469   }
1470 
1471   StoredDeclsMap *Map = LookupPtr;
1472   if (!Map)
1473     return lookup_result();
1474 
1475   StoredDeclsMap::iterator I = Map->find(Name);
1476   return I != Map->end() ? I->second.getLookupResult()
1477                          : lookup_result();
1478 }
1479 
1480 void DeclContext::localUncachedLookup(DeclarationName Name,
1481                                       SmallVectorImpl<NamedDecl *> &Results) {
1482   Results.clear();
1483 
1484   // If there's no external storage, just perform a normal lookup and copy
1485   // the results.
1486   if (!hasExternalVisibleStorage() && !hasExternalLexicalStorage() && Name) {
1487     lookup_result LookupResults = lookup(Name);
1488     Results.insert(Results.end(), LookupResults.begin(), LookupResults.end());
1489     return;
1490   }
1491 
1492   // If we have a lookup table, check there first. Maybe we'll get lucky.
1493   // FIXME: Should we be checking these flags on the primary context?
1494   if (Name && !HasLazyLocalLexicalLookups && !HasLazyExternalLexicalLookups) {
1495     if (StoredDeclsMap *Map = LookupPtr) {
1496       StoredDeclsMap::iterator Pos = Map->find(Name);
1497       if (Pos != Map->end()) {
1498         Results.insert(Results.end(),
1499                        Pos->second.getLookupResult().begin(),
1500                        Pos->second.getLookupResult().end());
1501         return;
1502       }
1503     }
1504   }
1505 
1506   // Slow case: grovel through the declarations in our chain looking for
1507   // matches.
1508   // FIXME: If we have lazy external declarations, this will not find them!
1509   // FIXME: Should we CollectAllContexts and walk them all here?
1510   for (Decl *D = FirstDecl; D; D = D->getNextDeclInContext()) {
1511     if (NamedDecl *ND = dyn_cast<NamedDecl>(D))
1512       if (ND->getDeclName() == Name)
1513         Results.push_back(ND);
1514   }
1515 }
1516 
1517 DeclContext *DeclContext::getRedeclContext() {
1518   DeclContext *Ctx = this;
1519   // Skip through transparent contexts.
1520   while (Ctx->isTransparentContext())
1521     Ctx = Ctx->getParent();
1522   return Ctx;
1523 }
1524 
1525 DeclContext *DeclContext::getEnclosingNamespaceContext() {
1526   DeclContext *Ctx = this;
1527   // Skip through non-namespace, non-translation-unit contexts.
1528   while (!Ctx->isFileContext())
1529     Ctx = Ctx->getParent();
1530   return Ctx->getPrimaryContext();
1531 }
1532 
1533 RecordDecl *DeclContext::getOuterLexicalRecordContext() {
1534   // Loop until we find a non-record context.
1535   RecordDecl *OutermostRD = nullptr;
1536   DeclContext *DC = this;
1537   while (DC->isRecord()) {
1538     OutermostRD = cast<RecordDecl>(DC);
1539     DC = DC->getLexicalParent();
1540   }
1541   return OutermostRD;
1542 }
1543 
1544 bool DeclContext::InEnclosingNamespaceSetOf(const DeclContext *O) const {
1545   // For non-file contexts, this is equivalent to Equals.
1546   if (!isFileContext())
1547     return O->Equals(this);
1548 
1549   do {
1550     if (O->Equals(this))
1551       return true;
1552 
1553     const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(O);
1554     if (!NS || !NS->isInline())
1555       break;
1556     O = NS->getParent();
1557   } while (O);
1558 
1559   return false;
1560 }
1561 
1562 void DeclContext::makeDeclVisibleInContext(NamedDecl *D) {
1563   DeclContext *PrimaryDC = this->getPrimaryContext();
1564   DeclContext *DeclDC = D->getDeclContext()->getPrimaryContext();
1565   // If the decl is being added outside of its semantic decl context, we
1566   // need to ensure that we eagerly build the lookup information for it.
1567   PrimaryDC->makeDeclVisibleInContextWithFlags(D, false, PrimaryDC == DeclDC);
1568 }
1569 
1570 void DeclContext::makeDeclVisibleInContextWithFlags(NamedDecl *D, bool Internal,
1571                                                     bool Recoverable) {
1572   assert(this == getPrimaryContext() && "expected a primary DC");
1573 
1574   if (!isLookupContext()) {
1575     if (isTransparentContext())
1576       getParent()->getPrimaryContext()
1577         ->makeDeclVisibleInContextWithFlags(D, Internal, Recoverable);
1578     return;
1579   }
1580 
1581   // Skip declarations which should be invisible to name lookup.
1582   if (shouldBeHidden(D))
1583     return;
1584 
1585   // If we already have a lookup data structure, perform the insertion into
1586   // it. If we might have externally-stored decls with this name, look them
1587   // up and perform the insertion. If this decl was declared outside its
1588   // semantic context, buildLookup won't add it, so add it now.
1589   //
1590   // FIXME: As a performance hack, don't add such decls into the translation
1591   // unit unless we're in C++, since qualified lookup into the TU is never
1592   // performed.
1593   if (LookupPtr || hasExternalVisibleStorage() ||
1594       ((!Recoverable || D->getDeclContext() != D->getLexicalDeclContext()) &&
1595        (getParentASTContext().getLangOpts().CPlusPlus ||
1596         !isTranslationUnit()))) {
1597     // If we have lazily omitted any decls, they might have the same name as
1598     // the decl which we are adding, so build a full lookup table before adding
1599     // this decl.
1600     buildLookup();
1601     makeDeclVisibleInContextImpl(D, Internal);
1602   } else {
1603     HasLazyLocalLexicalLookups = true;
1604   }
1605 
1606   // If we are a transparent context or inline namespace, insert into our
1607   // parent context, too. This operation is recursive.
1608   if (isTransparentContext() || isInlineNamespace())
1609     getParent()->getPrimaryContext()->
1610         makeDeclVisibleInContextWithFlags(D, Internal, Recoverable);
1611 
1612   Decl *DCAsDecl = cast<Decl>(this);
1613   // Notify that a decl was made visible unless we are a Tag being defined.
1614   if (!(isa<TagDecl>(DCAsDecl) && cast<TagDecl>(DCAsDecl)->isBeingDefined()))
1615     if (ASTMutationListener *L = DCAsDecl->getASTMutationListener())
1616       L->AddedVisibleDecl(this, D);
1617 }
1618 
1619 void DeclContext::makeDeclVisibleInContextImpl(NamedDecl *D, bool Internal) {
1620   // Find or create the stored declaration map.
1621   StoredDeclsMap *Map = LookupPtr;
1622   if (!Map) {
1623     ASTContext *C = &getParentASTContext();
1624     Map = CreateStoredDeclsMap(*C);
1625   }
1626 
1627   // If there is an external AST source, load any declarations it knows about
1628   // with this declaration's name.
1629   // If the lookup table contains an entry about this name it means that we
1630   // have already checked the external source.
1631   if (!Internal)
1632     if (ExternalASTSource *Source = getParentASTContext().getExternalSource())
1633       if (hasExternalVisibleStorage() &&
1634           Map->find(D->getDeclName()) == Map->end())
1635         Source->FindExternalVisibleDeclsByName(this, D->getDeclName());
1636 
1637   // Insert this declaration into the map.
1638   StoredDeclsList &DeclNameEntries = (*Map)[D->getDeclName()];
1639 
1640   if (Internal) {
1641     // If this is being added as part of loading an external declaration,
1642     // this may not be the only external declaration with this name.
1643     // In this case, we never try to replace an existing declaration; we'll
1644     // handle that when we finalize the list of declarations for this name.
1645     DeclNameEntries.setHasExternalDecls();
1646     DeclNameEntries.AddSubsequentDecl(D);
1647     return;
1648   }
1649 
1650   if (DeclNameEntries.isNull()) {
1651     DeclNameEntries.setOnlyValue(D);
1652     return;
1653   }
1654 
1655   if (DeclNameEntries.HandleRedeclaration(D, /*IsKnownNewer*/!Internal)) {
1656     // This declaration has replaced an existing one for which
1657     // declarationReplaces returns true.
1658     return;
1659   }
1660 
1661   // Put this declaration into the appropriate slot.
1662   DeclNameEntries.AddSubsequentDecl(D);
1663 }
1664 
1665 UsingDirectiveDecl *DeclContext::udir_iterator::operator*() const {
1666   return cast<UsingDirectiveDecl>(*I);
1667 }
1668 
1669 /// Returns iterator range [First, Last) of UsingDirectiveDecls stored within
1670 /// this context.
1671 DeclContext::udir_range DeclContext::using_directives() const {
1672   // FIXME: Use something more efficient than normal lookup for using
1673   // directives. In C++, using directives are looked up more than anything else.
1674   lookup_result Result = lookup(UsingDirectiveDecl::getName());
1675   return udir_range(Result.begin(), Result.end());
1676 }
1677 
1678 //===----------------------------------------------------------------------===//
1679 // Creation and Destruction of StoredDeclsMaps.                               //
1680 //===----------------------------------------------------------------------===//
1681 
1682 StoredDeclsMap *DeclContext::CreateStoredDeclsMap(ASTContext &C) const {
1683   assert(!LookupPtr && "context already has a decls map");
1684   assert(getPrimaryContext() == this &&
1685          "creating decls map on non-primary context");
1686 
1687   StoredDeclsMap *M;
1688   bool Dependent = isDependentContext();
1689   if (Dependent)
1690     M = new DependentStoredDeclsMap();
1691   else
1692     M = new StoredDeclsMap();
1693   M->Previous = C.LastSDM;
1694   C.LastSDM = llvm::PointerIntPair<StoredDeclsMap*,1>(M, Dependent);
1695   LookupPtr = M;
1696   return M;
1697 }
1698 
1699 void ASTContext::ReleaseDeclContextMaps() {
1700   // It's okay to delete DependentStoredDeclsMaps via a StoredDeclsMap
1701   // pointer because the subclass doesn't add anything that needs to
1702   // be deleted.
1703   StoredDeclsMap::DestroyAll(LastSDM.getPointer(), LastSDM.getInt());
1704 }
1705 
1706 void StoredDeclsMap::DestroyAll(StoredDeclsMap *Map, bool Dependent) {
1707   while (Map) {
1708     // Advance the iteration before we invalidate memory.
1709     llvm::PointerIntPair<StoredDeclsMap*,1> Next = Map->Previous;
1710 
1711     if (Dependent)
1712       delete static_cast<DependentStoredDeclsMap*>(Map);
1713     else
1714       delete Map;
1715 
1716     Map = Next.getPointer();
1717     Dependent = Next.getInt();
1718   }
1719 }
1720 
1721 DependentDiagnostic *DependentDiagnostic::Create(ASTContext &C,
1722                                                  DeclContext *Parent,
1723                                            const PartialDiagnostic &PDiag) {
1724   assert(Parent->isDependentContext()
1725          && "cannot iterate dependent diagnostics of non-dependent context");
1726   Parent = Parent->getPrimaryContext();
1727   if (!Parent->LookupPtr)
1728     Parent->CreateStoredDeclsMap(C);
1729 
1730   DependentStoredDeclsMap *Map =
1731       static_cast<DependentStoredDeclsMap *>(Parent->LookupPtr);
1732 
1733   // Allocate the copy of the PartialDiagnostic via the ASTContext's
1734   // BumpPtrAllocator, rather than the ASTContext itself.
1735   PartialDiagnostic::Storage *DiagStorage = nullptr;
1736   if (PDiag.hasStorage())
1737     DiagStorage = new (C) PartialDiagnostic::Storage;
1738 
1739   DependentDiagnostic *DD = new (C) DependentDiagnostic(PDiag, DiagStorage);
1740 
1741   // TODO: Maybe we shouldn't reverse the order during insertion.
1742   DD->NextDiagnostic = Map->FirstDiagnostic;
1743   Map->FirstDiagnostic = DD;
1744 
1745   return DD;
1746 }
1747