1 //===- DeclBase.cpp - Declaration AST Node Implementation -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Decl and DeclContext classes.
12 //===----------------------------------------------------------------------===//
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/AttrIterator.h"
19 #include "clang/AST/Decl.h"
20 #include "clang/AST/DeclCXX.h"
21 #include "clang/AST/DeclContextInternals.h"
22 #include "clang/AST/DeclFriend.h"
23 #include "clang/AST/DeclObjC.h"
24 #include "clang/AST/DeclOpenMP.h"
25 #include "clang/AST/DeclTemplate.h"
26 #include "clang/AST/DependentDiagnostic.h"
27 #include "clang/AST/ExternalASTSource.h"
28 #include "clang/AST/Stmt.h"
29 #include "clang/AST/Type.h"
30 #include "clang/Basic/IdentifierTable.h"
31 #include "clang/Basic/LLVM.h"
32 #include "clang/Basic/LangOptions.h"
33 #include "clang/Basic/ObjCRuntime.h"
34 #include "clang/Basic/PartialDiagnostic.h"
35 #include "clang/Basic/SourceLocation.h"
36 #include "clang/Basic/TargetInfo.h"
37 #include "llvm/ADT/ArrayRef.h"
38 #include "llvm/ADT/PointerIntPair.h"
39 #include "llvm/ADT/SmallVector.h"
40 #include "llvm/ADT/StringRef.h"
41 #include "llvm/Support/Casting.h"
42 #include "llvm/Support/ErrorHandling.h"
43 #include "llvm/Support/MathExtras.h"
44 #include "llvm/Support/VersionTuple.h"
45 #include "llvm/Support/raw_ostream.h"
53 using namespace clang;
55 //===----------------------------------------------------------------------===//
57 //===----------------------------------------------------------------------===//
59 #define DECL(DERIVED, BASE) static int n##DERIVED##s = 0;
60 #define ABSTRACT_DECL(DECL)
61 #include "clang/AST/DeclNodes.inc"
63 void Decl::updateOutOfDate(IdentifierInfo &II) const {
64 getASTContext().getExternalSource()->updateOutOfDateIdentifier(II);
67 #define DECL(DERIVED, BASE) \
68 static_assert(alignof(Decl) >= alignof(DERIVED##Decl), \
69 "Alignment sufficient after objects prepended to " #DERIVED);
70 #define ABSTRACT_DECL(DECL)
71 #include "clang/AST/DeclNodes.inc"
73 void *Decl::operator new(std::size_t Size, const ASTContext &Context,
74 unsigned ID, std::size_t Extra) {
75 // Allocate an extra 8 bytes worth of storage, which ensures that the
76 // resulting pointer will still be 8-byte aligned.
77 static_assert(sizeof(unsigned) * 2 >= alignof(Decl),
78 "Decl won't be misaligned");
79 void *Start = Context.Allocate(Size + Extra + 8);
80 void *Result = (char*)Start + 8;
82 unsigned *PrefixPtr = (unsigned *)Result - 2;
84 // Zero out the first 4 bytes; this is used to store the owning module ID.
87 // Store the global declaration ID in the second 4 bytes.
93 void *Decl::operator new(std::size_t Size, const ASTContext &Ctx,
94 DeclContext *Parent, std::size_t Extra) {
95 assert(!Parent || &Parent->getParentASTContext() == &Ctx);
96 // With local visibility enabled, we track the owning module even for local
97 // declarations. We create the TU decl early and may not yet know what the
98 // LangOpts are, so conservatively allocate the storage.
99 if (Ctx.getLangOpts().trackLocalOwningModule() || !Parent) {
100 // Ensure required alignment of the resulting object by adding extra
101 // padding at the start if required.
103 llvm::OffsetToAlignment(sizeof(Module *), alignof(Decl));
104 auto *Buffer = reinterpret_cast<char *>(
105 ::operator new(ExtraAlign + sizeof(Module *) + Size + Extra, Ctx));
106 Buffer += ExtraAlign;
108 Parent ? cast<Decl>(Parent)->getOwningModule() : nullptr;
109 return new (Buffer) Module*(ParentModule) + 1;
111 return ::operator new(Size + Extra, Ctx);
114 Module *Decl::getOwningModuleSlow() const {
115 assert(isFromASTFile() && "Not from AST file?");
116 return getASTContext().getExternalSource()->getModule(getOwningModuleID());
119 bool Decl::hasLocalOwningModuleStorage() const {
120 return getASTContext().getLangOpts().trackLocalOwningModule();
123 const char *Decl::getDeclKindName() const {
125 default: llvm_unreachable("Declaration not in DeclNodes.inc!");
126 #define DECL(DERIVED, BASE) case DERIVED: return #DERIVED;
127 #define ABSTRACT_DECL(DECL)
128 #include "clang/AST/DeclNodes.inc"
132 void Decl::setInvalidDecl(bool Invalid) {
133 InvalidDecl = Invalid;
134 assert(!isa<TagDecl>(this) || !cast<TagDecl>(this)->isCompleteDefinition());
139 if (!isa<ParmVarDecl>(this)) {
140 // Defensive maneuver for ill-formed code: we're likely not to make it to
141 // a point where we set the access specifier, so default it to "public"
142 // to avoid triggering asserts elsewhere in the front end.
143 setAccess(AS_public);
146 // Marking a DecompositionDecl as invalid implies all the child BindingDecl's
148 if (auto *DD = dyn_cast<DecompositionDecl>(this)) {
149 for (auto *Binding : DD->bindings()) {
150 Binding->setInvalidDecl();
155 const char *DeclContext::getDeclKindName() const {
156 switch (getDeclKind()) {
157 #define DECL(DERIVED, BASE) case Decl::DERIVED: return #DERIVED;
158 #define ABSTRACT_DECL(DECL)
159 #include "clang/AST/DeclNodes.inc"
161 llvm_unreachable("Declaration context not in DeclNodes.inc!");
164 bool Decl::StatisticsEnabled = false;
165 void Decl::EnableStatistics() {
166 StatisticsEnabled = true;
169 void Decl::PrintStats() {
170 llvm::errs() << "\n*** Decl Stats:\n";
173 #define DECL(DERIVED, BASE) totalDecls += n##DERIVED##s;
174 #define ABSTRACT_DECL(DECL)
175 #include "clang/AST/DeclNodes.inc"
176 llvm::errs() << " " << totalDecls << " decls total.\n";
179 #define DECL(DERIVED, BASE) \
180 if (n##DERIVED##s > 0) { \
181 totalBytes += (int)(n##DERIVED##s * sizeof(DERIVED##Decl)); \
182 llvm::errs() << " " << n##DERIVED##s << " " #DERIVED " decls, " \
183 << sizeof(DERIVED##Decl) << " each (" \
184 << n##DERIVED##s * sizeof(DERIVED##Decl) \
187 #define ABSTRACT_DECL(DECL)
188 #include "clang/AST/DeclNodes.inc"
190 llvm::errs() << "Total bytes = " << totalBytes << "\n";
193 void Decl::add(Kind k) {
195 #define DECL(DERIVED, BASE) case DERIVED: ++n##DERIVED##s; break;
196 #define ABSTRACT_DECL(DECL)
197 #include "clang/AST/DeclNodes.inc"
201 bool Decl::isTemplateParameterPack() const {
202 if (const auto *TTP = dyn_cast<TemplateTypeParmDecl>(this))
203 return TTP->isParameterPack();
204 if (const auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(this))
205 return NTTP->isParameterPack();
206 if (const auto *TTP = dyn_cast<TemplateTemplateParmDecl>(this))
207 return TTP->isParameterPack();
211 bool Decl::isParameterPack() const {
212 if (const auto *Parm = dyn_cast<ParmVarDecl>(this))
213 return Parm->isParameterPack();
215 return isTemplateParameterPack();
218 FunctionDecl *Decl::getAsFunction() {
219 if (auto *FD = dyn_cast<FunctionDecl>(this))
221 if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(this))
222 return FTD->getTemplatedDecl();
226 bool Decl::isTemplateDecl() const {
227 return isa<TemplateDecl>(this);
230 TemplateDecl *Decl::getDescribedTemplate() const {
231 if (auto *FD = dyn_cast<FunctionDecl>(this))
232 return FD->getDescribedFunctionTemplate();
233 else if (auto *RD = dyn_cast<CXXRecordDecl>(this))
234 return RD->getDescribedClassTemplate();
235 else if (auto *VD = dyn_cast<VarDecl>(this))
236 return VD->getDescribedVarTemplate();
237 else if (auto *AD = dyn_cast<TypeAliasDecl>(this))
238 return AD->getDescribedAliasTemplate();
243 bool Decl::isTemplated() const {
244 // A declaration is dependent if it is a template or a template pattern, or
245 // is within (lexcially for a friend, semantically otherwise) a dependent
247 // FIXME: Should local extern declarations be treated like friends?
248 if (auto *AsDC = dyn_cast<DeclContext>(this))
249 return AsDC->isDependentContext();
250 auto *DC = getFriendObjectKind() ? getLexicalDeclContext() : getDeclContext();
251 return DC->isDependentContext() || isTemplateDecl() || getDescribedTemplate();
254 const DeclContext *Decl::getParentFunctionOrMethod() const {
255 for (const DeclContext *DC = getDeclContext();
256 DC && !DC->isTranslationUnit() && !DC->isNamespace();
257 DC = DC->getParent())
258 if (DC->isFunctionOrMethod())
264 //===----------------------------------------------------------------------===//
265 // PrettyStackTraceDecl Implementation
266 //===----------------------------------------------------------------------===//
268 void PrettyStackTraceDecl::print(raw_ostream &OS) const {
269 SourceLocation TheLoc = Loc;
270 if (TheLoc.isInvalid() && TheDecl)
271 TheLoc = TheDecl->getLocation();
273 if (TheLoc.isValid()) {
274 TheLoc.print(OS, SM);
280 if (const auto *DN = dyn_cast_or_null<NamedDecl>(TheDecl)) {
282 DN->printQualifiedName(OS);
288 //===----------------------------------------------------------------------===//
289 // Decl Implementation
290 //===----------------------------------------------------------------------===//
292 // Out-of-line virtual method providing a home for Decl.
293 Decl::~Decl() = default;
295 void Decl::setDeclContext(DeclContext *DC) {
299 void Decl::setLexicalDeclContext(DeclContext *DC) {
300 if (DC == getLexicalDeclContext())
304 setDeclContextsImpl(getDeclContext(), DC, getASTContext());
306 getMultipleDC()->LexicalDC = DC;
309 // FIXME: We shouldn't be changing the lexical context of declarations
310 // imported from AST files.
311 if (!isFromASTFile()) {
312 setModuleOwnershipKind(getModuleOwnershipKindForChildOf(DC));
313 if (hasOwningModule())
314 setLocalOwningModule(cast<Decl>(DC)->getOwningModule());
318 (getModuleOwnershipKind() != ModuleOwnershipKind::VisibleWhenImported ||
319 getOwningModule()) &&
320 "hidden declaration has no owning module");
323 void Decl::setDeclContextsImpl(DeclContext *SemaDC, DeclContext *LexicalDC,
325 if (SemaDC == LexicalDC) {
328 auto *MDC = new (Ctx) Decl::MultipleDC();
329 MDC->SemanticDC = SemaDC;
330 MDC->LexicalDC = LexicalDC;
335 bool Decl::isLexicallyWithinFunctionOrMethod() const {
336 const DeclContext *LDC = getLexicalDeclContext();
338 if (LDC->isFunctionOrMethod())
340 if (!isa<TagDecl>(LDC))
342 LDC = LDC->getLexicalParent();
347 bool Decl::isInAnonymousNamespace() const {
348 for (const DeclContext *DC = getDeclContext(); DC; DC = DC->getParent()) {
349 if (const auto *ND = dyn_cast<NamespaceDecl>(DC))
350 if (ND->isAnonymousNamespace())
357 bool Decl::isInStdNamespace() const {
358 return getDeclContext()->isStdNamespace();
361 TranslationUnitDecl *Decl::getTranslationUnitDecl() {
362 if (auto *TUD = dyn_cast<TranslationUnitDecl>(this))
365 DeclContext *DC = getDeclContext();
366 assert(DC && "This decl is not contained in a translation unit!");
368 while (!DC->isTranslationUnit()) {
369 DC = DC->getParent();
370 assert(DC && "This decl is not contained in a translation unit!");
373 return cast<TranslationUnitDecl>(DC);
376 ASTContext &Decl::getASTContext() const {
377 return getTranslationUnitDecl()->getASTContext();
380 ASTMutationListener *Decl::getASTMutationListener() const {
381 return getASTContext().getASTMutationListener();
384 unsigned Decl::getMaxAlignment() const {
389 const AttrVec &V = getAttrs();
390 ASTContext &Ctx = getASTContext();
391 specific_attr_iterator<AlignedAttr> I(V.begin()), E(V.end());
393 Align = std::max(Align, I->getAlignment(Ctx));
397 bool Decl::isUsed(bool CheckUsedAttr) const {
398 const Decl *CanonD = getCanonicalDecl();
402 // Check for used attribute.
403 // Ask the most recent decl, since attributes accumulate in the redecl chain.
404 if (CheckUsedAttr && getMostRecentDecl()->hasAttr<UsedAttr>())
407 // The information may have not been deserialized yet. Force deserialization
408 // to complete the needed information.
409 return getMostRecentDecl()->getCanonicalDecl()->Used;
412 void Decl::markUsed(ASTContext &C) {
416 if (C.getASTMutationListener())
417 C.getASTMutationListener()->DeclarationMarkedUsed(this);
422 bool Decl::isReferenced() const {
426 // Check redeclarations.
427 for (const auto *I : redecls())
434 bool Decl::isExported() const {
435 if (isModulePrivate())
437 // Namespaces are always exported.
438 if (isa<TranslationUnitDecl>(this) || isa<NamespaceDecl>(this))
440 // Otherwise, this is a strictly lexical check.
441 for (auto *DC = getLexicalDeclContext(); DC; DC = DC->getLexicalParent()) {
442 if (cast<Decl>(DC)->isModulePrivate())
444 if (isa<ExportDecl>(DC))
450 ExternalSourceSymbolAttr *Decl::getExternalSourceSymbolAttr() const {
451 const Decl *Definition = nullptr;
452 if (auto *ID = dyn_cast<ObjCInterfaceDecl>(this)) {
453 Definition = ID->getDefinition();
454 } else if (auto *PD = dyn_cast<ObjCProtocolDecl>(this)) {
455 Definition = PD->getDefinition();
456 } else if (auto *TD = dyn_cast<TagDecl>(this)) {
457 Definition = TD->getDefinition();
462 if (auto *attr = Definition->getAttr<ExternalSourceSymbolAttr>())
464 if (auto *dcd = dyn_cast<Decl>(getDeclContext())) {
465 return dcd->getAttr<ExternalSourceSymbolAttr>();
471 bool Decl::hasDefiningAttr() const {
472 return hasAttr<AliasAttr>() || hasAttr<IFuncAttr>();
475 const Attr *Decl::getDefiningAttr() const {
476 if (auto *AA = getAttr<AliasAttr>())
478 if (auto *IFA = getAttr<IFuncAttr>())
483 static StringRef getRealizedPlatform(const AvailabilityAttr *A,
484 const ASTContext &Context) {
485 // Check if this is an App Extension "platform", and if so chop off
486 // the suffix for matching with the actual platform.
487 StringRef RealizedPlatform = A->getPlatform()->getName();
488 if (!Context.getLangOpts().AppExt)
489 return RealizedPlatform;
490 size_t suffix = RealizedPlatform.rfind("_app_extension");
491 if (suffix != StringRef::npos)
492 return RealizedPlatform.slice(0, suffix);
493 return RealizedPlatform;
496 /// Determine the availability of the given declaration based on
497 /// the target platform.
499 /// When it returns an availability result other than \c AR_Available,
500 /// if the \p Message parameter is non-NULL, it will be set to a
501 /// string describing why the entity is unavailable.
503 /// FIXME: Make these strings localizable, since they end up in
505 static AvailabilityResult CheckAvailability(ASTContext &Context,
506 const AvailabilityAttr *A,
507 std::string *Message,
508 VersionTuple EnclosingVersion) {
509 if (EnclosingVersion.empty())
510 EnclosingVersion = Context.getTargetInfo().getPlatformMinVersion();
512 if (EnclosingVersion.empty())
515 StringRef ActualPlatform = A->getPlatform()->getName();
516 StringRef TargetPlatform = Context.getTargetInfo().getPlatformName();
518 // Match the platform name.
519 if (getRealizedPlatform(A, Context) != TargetPlatform)
522 StringRef PrettyPlatformName
523 = AvailabilityAttr::getPrettyPlatformName(ActualPlatform);
525 if (PrettyPlatformName.empty())
526 PrettyPlatformName = ActualPlatform;
528 std::string HintMessage;
529 if (!A->getMessage().empty()) {
531 HintMessage += A->getMessage();
534 // Make sure that this declaration has not been marked 'unavailable'.
535 if (A->getUnavailable()) {
538 llvm::raw_string_ostream Out(*Message);
539 Out << "not available on " << PrettyPlatformName
543 return AR_Unavailable;
546 // Make sure that this declaration has already been introduced.
547 if (!A->getIntroduced().empty() &&
548 EnclosingVersion < A->getIntroduced()) {
551 llvm::raw_string_ostream Out(*Message);
552 VersionTuple VTI(A->getIntroduced());
553 Out << "introduced in " << PrettyPlatformName << ' '
554 << VTI << HintMessage;
557 return A->getStrict() ? AR_Unavailable : AR_NotYetIntroduced;
560 // Make sure that this declaration hasn't been obsoleted.
561 if (!A->getObsoleted().empty() && EnclosingVersion >= A->getObsoleted()) {
564 llvm::raw_string_ostream Out(*Message);
565 VersionTuple VTO(A->getObsoleted());
566 Out << "obsoleted in " << PrettyPlatformName << ' '
567 << VTO << HintMessage;
570 return AR_Unavailable;
573 // Make sure that this declaration hasn't been deprecated.
574 if (!A->getDeprecated().empty() && EnclosingVersion >= A->getDeprecated()) {
577 llvm::raw_string_ostream Out(*Message);
578 VersionTuple VTD(A->getDeprecated());
579 Out << "first deprecated in " << PrettyPlatformName << ' '
580 << VTD << HintMessage;
583 return AR_Deprecated;
589 AvailabilityResult Decl::getAvailability(std::string *Message,
590 VersionTuple EnclosingVersion,
591 StringRef *RealizedPlatform) const {
592 if (auto *FTD = dyn_cast<FunctionTemplateDecl>(this))
593 return FTD->getTemplatedDecl()->getAvailability(Message, EnclosingVersion,
596 AvailabilityResult Result = AR_Available;
597 std::string ResultMessage;
599 for (const auto *A : attrs()) {
600 if (const auto *Deprecated = dyn_cast<DeprecatedAttr>(A)) {
601 if (Result >= AR_Deprecated)
605 ResultMessage = Deprecated->getMessage();
607 Result = AR_Deprecated;
611 if (const auto *Unavailable = dyn_cast<UnavailableAttr>(A)) {
613 *Message = Unavailable->getMessage();
614 return AR_Unavailable;
617 if (const auto *Availability = dyn_cast<AvailabilityAttr>(A)) {
618 AvailabilityResult AR = CheckAvailability(getASTContext(), Availability,
619 Message, EnclosingVersion);
621 if (AR == AR_Unavailable) {
622 if (RealizedPlatform)
623 *RealizedPlatform = Availability->getPlatform()->getName();
624 return AR_Unavailable;
630 ResultMessage.swap(*Message);
637 Message->swap(ResultMessage);
641 VersionTuple Decl::getVersionIntroduced() const {
642 const ASTContext &Context = getASTContext();
643 StringRef TargetPlatform = Context.getTargetInfo().getPlatformName();
644 for (const auto *A : attrs()) {
645 if (const auto *Availability = dyn_cast<AvailabilityAttr>(A)) {
646 if (getRealizedPlatform(Availability, Context) != TargetPlatform)
648 if (!Availability->getIntroduced().empty())
649 return Availability->getIntroduced();
655 bool Decl::canBeWeakImported(bool &IsDefinition) const {
656 IsDefinition = false;
658 // Variables, if they aren't definitions.
659 if (const auto *Var = dyn_cast<VarDecl>(this)) {
660 if (Var->isThisDeclarationADefinition()) {
666 // Functions, if they aren't definitions.
667 } else if (const auto *FD = dyn_cast<FunctionDecl>(this)) {
674 // Objective-C classes, if this is the non-fragile runtime.
675 } else if (isa<ObjCInterfaceDecl>(this) &&
676 getASTContext().getLangOpts().ObjCRuntime.hasWeakClassImport()) {
685 bool Decl::isWeakImported() const {
687 if (!canBeWeakImported(IsDefinition))
690 for (const auto *A : attrs()) {
691 if (isa<WeakImportAttr>(A))
694 if (const auto *Availability = dyn_cast<AvailabilityAttr>(A)) {
695 if (CheckAvailability(getASTContext(), Availability, nullptr,
696 VersionTuple()) == AR_NotYetIntroduced)
704 unsigned Decl::getIdentifierNamespaceForKind(Kind DeclKind) {
707 case CXXDeductionGuide:
710 case ConstructorUsingShadow:
720 return IDNS_Ordinary;
724 return IDNS_Ordinary | IDNS_Member;
727 case NonTypeTemplateParm:
729 // These (C++-only) declarations are found by redeclaration lookup for
730 // tag types, so we include them in the tag namespace.
731 return IDNS_Ordinary | IDNS_Tag;
733 case ObjCCompatibleAlias:
735 return IDNS_Ordinary | IDNS_Type;
739 case TemplateTypeParm:
741 return IDNS_Ordinary | IDNS_Type;
743 case UnresolvedUsingTypename:
744 return IDNS_Ordinary | IDNS_Type | IDNS_Using;
747 return 0; // we'll actually overwrite this later
749 case UnresolvedUsingValue:
750 return IDNS_Ordinary | IDNS_Using;
757 return IDNS_ObjCProtocol;
760 case ObjCAtDefsField:
767 return IDNS_Tag | IDNS_Type;
771 return IDNS_Namespace;
773 case FunctionTemplate:
774 return IDNS_Ordinary;
777 case TemplateTemplateParm:
778 case TypeAliasTemplate:
779 return IDNS_Ordinary | IDNS_Tag | IDNS_Type;
781 case OMPDeclareReduction:
782 return IDNS_OMPReduction;
792 case ObjCPropertyImpl:
794 case PragmaDetectMismatch:
797 case TranslationUnit:
802 case BuiltinTemplate:
803 case ClassTemplateSpecialization:
804 case ClassTemplatePartialSpecialization:
805 case ClassScopeFunctionSpecialization:
806 case VarTemplateSpecialization:
807 case VarTemplatePartialSpecialization:
808 case ObjCImplementation:
810 case ObjCCategoryImpl:
812 case OMPThreadPrivate:
814 case OMPCapturedExpr:
816 // Never looked up by name.
820 llvm_unreachable("Invalid DeclKind!");
823 void Decl::setAttrsImpl(const AttrVec &attrs, ASTContext &Ctx) {
824 assert(!HasAttrs && "Decl already contains attrs.");
826 AttrVec &AttrBlank = Ctx.getDeclAttrs(this);
827 assert(AttrBlank.empty() && "HasAttrs was wrong?");
833 void Decl::dropAttrs() {
834 if (!HasAttrs) return;
837 getASTContext().eraseDeclAttrs(this);
840 void Decl::addAttr(Attr *A) {
842 setAttrs(AttrVec(1, A));
846 AttrVec &Attrs = getAttrs();
847 if (!A->isInherited()) {
852 // Attribute inheritance is processed after attribute parsing. To keep the
853 // order as in the source code, add inherited attributes before non-inherited
855 auto I = Attrs.begin(), E = Attrs.end();
856 for (; I != E; ++I) {
857 if (!(*I)->isInherited())
863 const AttrVec &Decl::getAttrs() const {
864 assert(HasAttrs && "No attrs to get!");
865 return getASTContext().getDeclAttrs(this);
868 Decl *Decl::castFromDeclContext (const DeclContext *D) {
869 Decl::Kind DK = D->getDeclKind();
871 #define DECL(NAME, BASE)
872 #define DECL_CONTEXT(NAME) \
874 return static_cast<NAME##Decl *>(const_cast<DeclContext *>(D));
875 #define DECL_CONTEXT_BASE(NAME)
876 #include "clang/AST/DeclNodes.inc"
878 #define DECL(NAME, BASE)
879 #define DECL_CONTEXT_BASE(NAME) \
880 if (DK >= first##NAME && DK <= last##NAME) \
881 return static_cast<NAME##Decl *>(const_cast<DeclContext *>(D));
882 #include "clang/AST/DeclNodes.inc"
883 llvm_unreachable("a decl that inherits DeclContext isn't handled");
887 DeclContext *Decl::castToDeclContext(const Decl *D) {
888 Decl::Kind DK = D->getKind();
890 #define DECL(NAME, BASE)
891 #define DECL_CONTEXT(NAME) \
893 return static_cast<NAME##Decl *>(const_cast<Decl *>(D));
894 #define DECL_CONTEXT_BASE(NAME)
895 #include "clang/AST/DeclNodes.inc"
897 #define DECL(NAME, BASE)
898 #define DECL_CONTEXT_BASE(NAME) \
899 if (DK >= first##NAME && DK <= last##NAME) \
900 return static_cast<NAME##Decl *>(const_cast<Decl *>(D));
901 #include "clang/AST/DeclNodes.inc"
902 llvm_unreachable("a decl that inherits DeclContext isn't handled");
906 SourceLocation Decl::getBodyRBrace() const {
907 // Special handling of FunctionDecl to avoid de-serializing the body from PCH.
908 // FunctionDecl stores EndRangeLoc for this purpose.
909 if (const auto *FD = dyn_cast<FunctionDecl>(this)) {
910 const FunctionDecl *Definition;
911 if (FD->hasBody(Definition))
912 return Definition->getSourceRange().getEnd();
916 if (Stmt *Body = getBody())
917 return Body->getSourceRange().getEnd();
922 bool Decl::AccessDeclContextSanity() const {
924 // Suppress this check if any of the following hold:
925 // 1. this is the translation unit (and thus has no parent)
926 // 2. this is a template parameter (and thus doesn't belong to its context)
927 // 3. this is a non-type template parameter
928 // 4. the context is not a record
930 // 6. it's a C++0x static_assert.
931 // 7. it's a block literal declaration
932 if (isa<TranslationUnitDecl>(this) ||
933 isa<TemplateTypeParmDecl>(this) ||
934 isa<NonTypeTemplateParmDecl>(this) ||
935 !isa<CXXRecordDecl>(getDeclContext()) ||
937 isa<StaticAssertDecl>(this) ||
938 isa<BlockDecl>(this) ||
939 // FIXME: a ParmVarDecl can have ClassTemplateSpecialization
940 // as DeclContext (?).
941 isa<ParmVarDecl>(this) ||
942 // FIXME: a ClassTemplateSpecialization or CXXRecordDecl can have
943 // AS_none as access specifier.
944 isa<CXXRecordDecl>(this) ||
945 isa<ClassScopeFunctionSpecializationDecl>(this))
948 assert(Access != AS_none &&
949 "Access specifier is AS_none inside a record decl");
954 static Decl::Kind getKind(const Decl *D) { return D->getKind(); }
955 static Decl::Kind getKind(const DeclContext *DC) { return DC->getDeclKind(); }
957 int64_t Decl::getID() const {
958 return getASTContext().getAllocator().identifyKnownAlignedObject<Decl>(this);
961 const FunctionType *Decl::getFunctionType(bool BlocksToo) const {
963 if (const auto *D = dyn_cast<ValueDecl>(this))
965 else if (const auto *D = dyn_cast<TypedefNameDecl>(this))
966 Ty = D->getUnderlyingType();
970 if (Ty->isFunctionPointerType())
971 Ty = Ty->getAs<PointerType>()->getPointeeType();
972 else if (BlocksToo && Ty->isBlockPointerType())
973 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
975 return Ty->getAs<FunctionType>();
978 /// Starting at a given context (a Decl or DeclContext), look for a
979 /// code context that is not a closure (a lambda, block, etc.).
980 template <class T> static Decl *getNonClosureContext(T *D) {
981 if (getKind(D) == Decl::CXXMethod) {
982 auto *MD = cast<CXXMethodDecl>(D);
983 if (MD->getOverloadedOperator() == OO_Call &&
984 MD->getParent()->isLambda())
985 return getNonClosureContext(MD->getParent()->getParent());
987 } else if (auto *FD = dyn_cast<FunctionDecl>(D))
989 else if (auto *MD = dyn_cast<ObjCMethodDecl>(D))
991 else if (auto *BD = dyn_cast<BlockDecl>(D))
992 return getNonClosureContext(BD->getParent());
993 else if (auto *CD = dyn_cast<CapturedDecl>(D))
994 return getNonClosureContext(CD->getParent());
999 Decl *Decl::getNonClosureContext() {
1000 return ::getNonClosureContext(this);
1003 Decl *DeclContext::getNonClosureAncestor() {
1004 return ::getNonClosureContext(this);
1007 //===----------------------------------------------------------------------===//
1008 // DeclContext Implementation
1009 //===----------------------------------------------------------------------===//
1011 DeclContext::DeclContext(Decl::Kind K) {
1012 DeclContextBits.DeclKind = K;
1013 setHasExternalLexicalStorage(false);
1014 setHasExternalVisibleStorage(false);
1015 setNeedToReconcileExternalVisibleStorage(false);
1016 setHasLazyLocalLexicalLookups(false);
1017 setHasLazyExternalLexicalLookups(false);
1018 setUseQualifiedLookup(false);
1021 bool DeclContext::classof(const Decl *D) {
1022 switch (D->getKind()) {
1023 #define DECL(NAME, BASE)
1024 #define DECL_CONTEXT(NAME) case Decl::NAME:
1025 #define DECL_CONTEXT_BASE(NAME)
1026 #include "clang/AST/DeclNodes.inc"
1029 #define DECL(NAME, BASE)
1030 #define DECL_CONTEXT_BASE(NAME) \
1031 if (D->getKind() >= Decl::first##NAME && \
1032 D->getKind() <= Decl::last##NAME) \
1034 #include "clang/AST/DeclNodes.inc"
1039 DeclContext::~DeclContext() = default;
1041 /// Find the parent context of this context that will be
1042 /// used for unqualified name lookup.
1044 /// Generally, the parent lookup context is the semantic context. However, for
1045 /// a friend function the parent lookup context is the lexical context, which
1046 /// is the class in which the friend is declared.
1047 DeclContext *DeclContext::getLookupParent() {
1048 // FIXME: Find a better way to identify friends.
1049 if (isa<FunctionDecl>(this))
1050 if (getParent()->getRedeclContext()->isFileContext() &&
1051 getLexicalParent()->getRedeclContext()->isRecord())
1052 return getLexicalParent();
1057 bool DeclContext::isInlineNamespace() const {
1058 return isNamespace() &&
1059 cast<NamespaceDecl>(this)->isInline();
1062 bool DeclContext::isStdNamespace() const {
1066 const auto *ND = cast<NamespaceDecl>(this);
1067 if (ND->isInline()) {
1068 return ND->getParent()->isStdNamespace();
1071 if (!getParent()->getRedeclContext()->isTranslationUnit())
1074 const IdentifierInfo *II = ND->getIdentifier();
1075 return II && II->isStr("std");
1078 bool DeclContext::isDependentContext() const {
1079 if (isFileContext())
1082 if (isa<ClassTemplatePartialSpecializationDecl>(this))
1085 if (const auto *Record = dyn_cast<CXXRecordDecl>(this)) {
1086 if (Record->getDescribedClassTemplate())
1089 if (Record->isDependentLambda())
1093 if (const auto *Function = dyn_cast<FunctionDecl>(this)) {
1094 if (Function->getDescribedFunctionTemplate())
1097 // Friend function declarations are dependent if their *lexical*
1098 // context is dependent.
1099 if (cast<Decl>(this)->getFriendObjectKind())
1100 return getLexicalParent()->isDependentContext();
1103 // FIXME: A variable template is a dependent context, but is not a
1104 // DeclContext. A context within it (such as a lambda-expression)
1105 // should be considered dependent.
1107 return getParent() && getParent()->isDependentContext();
1110 bool DeclContext::isTransparentContext() const {
1111 if (getDeclKind() == Decl::Enum)
1112 return !cast<EnumDecl>(this)->isScoped();
1113 else if (getDeclKind() == Decl::LinkageSpec || getDeclKind() == Decl::Export)
1119 static bool isLinkageSpecContext(const DeclContext *DC,
1120 LinkageSpecDecl::LanguageIDs ID) {
1121 while (DC->getDeclKind() != Decl::TranslationUnit) {
1122 if (DC->getDeclKind() == Decl::LinkageSpec)
1123 return cast<LinkageSpecDecl>(DC)->getLanguage() == ID;
1124 DC = DC->getLexicalParent();
1129 bool DeclContext::isExternCContext() const {
1130 return isLinkageSpecContext(this, LinkageSpecDecl::lang_c);
1133 const LinkageSpecDecl *DeclContext::getExternCContext() const {
1134 const DeclContext *DC = this;
1135 while (DC->getDeclKind() != Decl::TranslationUnit) {
1136 if (DC->getDeclKind() == Decl::LinkageSpec &&
1137 cast<LinkageSpecDecl>(DC)->getLanguage() == LinkageSpecDecl::lang_c)
1138 return cast<LinkageSpecDecl>(DC);
1139 DC = DC->getLexicalParent();
1144 bool DeclContext::isExternCXXContext() const {
1145 return isLinkageSpecContext(this, LinkageSpecDecl::lang_cxx);
1148 bool DeclContext::Encloses(const DeclContext *DC) const {
1149 if (getPrimaryContext() != this)
1150 return getPrimaryContext()->Encloses(DC);
1152 for (; DC; DC = DC->getParent())
1153 if (DC->getPrimaryContext() == this)
1158 DeclContext *DeclContext::getPrimaryContext() {
1159 switch (getDeclKind()) {
1160 case Decl::TranslationUnit:
1161 case Decl::ExternCContext:
1162 case Decl::LinkageSpec:
1165 case Decl::Captured:
1166 case Decl::OMPDeclareReduction:
1167 // There is only one DeclContext for these entities.
1170 case Decl::Namespace:
1171 // The original namespace is our primary context.
1172 return static_cast<NamespaceDecl *>(this)->getOriginalNamespace();
1174 case Decl::ObjCMethod:
1177 case Decl::ObjCInterface:
1178 if (auto *Def = cast<ObjCInterfaceDecl>(this)->getDefinition())
1182 case Decl::ObjCProtocol:
1183 if (auto *Def = cast<ObjCProtocolDecl>(this)->getDefinition())
1187 case Decl::ObjCCategory:
1190 case Decl::ObjCImplementation:
1191 case Decl::ObjCCategoryImpl:
1195 if (getDeclKind() >= Decl::firstTag && getDeclKind() <= Decl::lastTag) {
1196 // If this is a tag type that has a definition or is currently
1197 // being defined, that definition is our primary context.
1198 auto *Tag = cast<TagDecl>(this);
1200 if (TagDecl *Def = Tag->getDefinition())
1203 if (const auto *TagTy = dyn_cast<TagType>(Tag->getTypeForDecl())) {
1204 // Note, TagType::getDecl returns the (partial) definition one exists.
1205 TagDecl *PossiblePartialDef = TagTy->getDecl();
1206 if (PossiblePartialDef->isBeingDefined())
1207 return PossiblePartialDef;
1209 assert(isa<InjectedClassNameType>(Tag->getTypeForDecl()));
1215 assert(getDeclKind() >= Decl::firstFunction &&
1216 getDeclKind() <= Decl::lastFunction &&
1217 "Unknown DeclContext kind");
1223 DeclContext::collectAllContexts(SmallVectorImpl<DeclContext *> &Contexts){
1226 if (getDeclKind() != Decl::Namespace) {
1227 Contexts.push_back(this);
1231 auto *Self = static_cast<NamespaceDecl *>(this);
1232 for (NamespaceDecl *N = Self->getMostRecentDecl(); N;
1233 N = N->getPreviousDecl())
1234 Contexts.push_back(N);
1236 std::reverse(Contexts.begin(), Contexts.end());
1239 std::pair<Decl *, Decl *>
1240 DeclContext::BuildDeclChain(ArrayRef<Decl *> Decls,
1241 bool FieldsAlreadyLoaded) {
1242 // Build up a chain of declarations via the Decl::NextInContextAndBits field.
1243 Decl *FirstNewDecl = nullptr;
1244 Decl *PrevDecl = nullptr;
1245 for (auto *D : Decls) {
1246 if (FieldsAlreadyLoaded && isa<FieldDecl>(D))
1250 PrevDecl->NextInContextAndBits.setPointer(D);
1257 return std::make_pair(FirstNewDecl, PrevDecl);
1260 /// We have just acquired external visible storage, and we already have
1261 /// built a lookup map. For every name in the map, pull in the new names from
1262 /// the external storage.
1263 void DeclContext::reconcileExternalVisibleStorage() const {
1264 assert(hasNeedToReconcileExternalVisibleStorage() && LookupPtr);
1265 setNeedToReconcileExternalVisibleStorage(false);
1267 for (auto &Lookup : *LookupPtr)
1268 Lookup.second.setHasExternalDecls();
1271 /// Load the declarations within this lexical storage from an
1272 /// external source.
1273 /// \return \c true if any declarations were added.
1275 DeclContext::LoadLexicalDeclsFromExternalStorage() const {
1276 ExternalASTSource *Source = getParentASTContext().getExternalSource();
1277 assert(hasExternalLexicalStorage() && Source && "No external storage?");
1279 // Notify that we have a DeclContext that is initializing.
1280 ExternalASTSource::Deserializing ADeclContext(Source);
1282 // Load the external declarations, if any.
1283 SmallVector<Decl*, 64> Decls;
1284 setHasExternalLexicalStorage(false);
1285 Source->FindExternalLexicalDecls(this, Decls);
1290 // We may have already loaded just the fields of this record, in which case
1291 // we need to ignore them.
1292 bool FieldsAlreadyLoaded = false;
1293 if (const auto *RD = dyn_cast<RecordDecl>(this))
1294 FieldsAlreadyLoaded = RD->hasLoadedFieldsFromExternalStorage();
1296 // Splice the newly-read declarations into the beginning of the list
1298 Decl *ExternalFirst, *ExternalLast;
1299 std::tie(ExternalFirst, ExternalLast) =
1300 BuildDeclChain(Decls, FieldsAlreadyLoaded);
1301 ExternalLast->NextInContextAndBits.setPointer(FirstDecl);
1302 FirstDecl = ExternalFirst;
1304 LastDecl = ExternalLast;
1308 DeclContext::lookup_result
1309 ExternalASTSource::SetNoExternalVisibleDeclsForName(const DeclContext *DC,
1310 DeclarationName Name) {
1311 ASTContext &Context = DC->getParentASTContext();
1312 StoredDeclsMap *Map;
1313 if (!(Map = DC->LookupPtr))
1314 Map = DC->CreateStoredDeclsMap(Context);
1315 if (DC->hasNeedToReconcileExternalVisibleStorage())
1316 DC->reconcileExternalVisibleStorage();
1318 (*Map)[Name].removeExternalDecls();
1320 return DeclContext::lookup_result();
1323 DeclContext::lookup_result
1324 ExternalASTSource::SetExternalVisibleDeclsForName(const DeclContext *DC,
1325 DeclarationName Name,
1326 ArrayRef<NamedDecl*> Decls) {
1327 ASTContext &Context = DC->getParentASTContext();
1328 StoredDeclsMap *Map;
1329 if (!(Map = DC->LookupPtr))
1330 Map = DC->CreateStoredDeclsMap(Context);
1331 if (DC->hasNeedToReconcileExternalVisibleStorage())
1332 DC->reconcileExternalVisibleStorage();
1334 StoredDeclsList &List = (*Map)[Name];
1336 // Clear out any old external visible declarations, to avoid quadratic
1337 // performance in the redeclaration checks below.
1338 List.removeExternalDecls();
1340 if (!List.isNull()) {
1341 // We have both existing declarations and new declarations for this name.
1342 // Some of the declarations may simply replace existing ones. Handle those
1344 llvm::SmallVector<unsigned, 8> Skip;
1345 for (unsigned I = 0, N = Decls.size(); I != N; ++I)
1346 if (List.HandleRedeclaration(Decls[I], /*IsKnownNewer*/false))
1348 Skip.push_back(Decls.size());
1350 // Add in any new declarations.
1351 unsigned SkipPos = 0;
1352 for (unsigned I = 0, N = Decls.size(); I != N; ++I) {
1353 if (I == Skip[SkipPos])
1356 List.AddSubsequentDecl(Decls[I]);
1359 // Convert the array to a StoredDeclsList.
1360 for (auto *D : Decls) {
1362 List.setOnlyValue(D);
1364 List.AddSubsequentDecl(D);
1368 return List.getLookupResult();
1371 DeclContext::decl_iterator DeclContext::decls_begin() const {
1372 if (hasExternalLexicalStorage())
1373 LoadLexicalDeclsFromExternalStorage();
1374 return decl_iterator(FirstDecl);
1377 bool DeclContext::decls_empty() const {
1378 if (hasExternalLexicalStorage())
1379 LoadLexicalDeclsFromExternalStorage();
1384 bool DeclContext::containsDecl(Decl *D) const {
1385 return (D->getLexicalDeclContext() == this &&
1386 (D->NextInContextAndBits.getPointer() || D == LastDecl));
1389 bool DeclContext::containsDeclAndLoad(Decl *D) const {
1390 if (hasExternalLexicalStorage())
1391 LoadLexicalDeclsFromExternalStorage();
1392 return containsDecl(D);
1395 /// shouldBeHidden - Determine whether a declaration which was declared
1396 /// within its semantic context should be invisible to qualified name lookup.
1397 static bool shouldBeHidden(NamedDecl *D) {
1398 // Skip unnamed declarations.
1399 if (!D->getDeclName())
1402 // Skip entities that can't be found by name lookup into a particular
1404 if ((D->getIdentifierNamespace() == 0 && !isa<UsingDirectiveDecl>(D)) ||
1405 D->isTemplateParameter())
1408 // Skip friends and local extern declarations unless they're the first
1409 // declaration of the entity.
1410 if ((D->isLocalExternDecl() || D->getFriendObjectKind()) &&
1411 D != D->getCanonicalDecl())
1414 // Skip template specializations.
1415 // FIXME: This feels like a hack. Should DeclarationName support
1416 // template-ids, or is there a better way to keep specializations
1417 // from being visible?
1418 if (isa<ClassTemplateSpecializationDecl>(D))
1420 if (auto *FD = dyn_cast<FunctionDecl>(D))
1421 if (FD->isFunctionTemplateSpecialization())
1427 void DeclContext::removeDecl(Decl *D) {
1428 assert(D->getLexicalDeclContext() == this &&
1429 "decl being removed from non-lexical context");
1430 assert((D->NextInContextAndBits.getPointer() || D == LastDecl) &&
1431 "decl is not in decls list");
1433 // Remove D from the decl chain. This is O(n) but hopefully rare.
1434 if (D == FirstDecl) {
1436 FirstDecl = LastDecl = nullptr;
1438 FirstDecl = D->NextInContextAndBits.getPointer();
1440 for (Decl *I = FirstDecl; true; I = I->NextInContextAndBits.getPointer()) {
1441 assert(I && "decl not found in linked list");
1442 if (I->NextInContextAndBits.getPointer() == D) {
1443 I->NextInContextAndBits.setPointer(D->NextInContextAndBits.getPointer());
1444 if (D == LastDecl) LastDecl = I;
1450 // Mark that D is no longer in the decl chain.
1451 D->NextInContextAndBits.setPointer(nullptr);
1453 // Remove D from the lookup table if necessary.
1454 if (isa<NamedDecl>(D)) {
1455 auto *ND = cast<NamedDecl>(D);
1457 // Do not try to remove the declaration if that is invisible to qualified
1458 // lookup. E.g. template specializations are skipped.
1459 if (shouldBeHidden(ND))
1462 // Remove only decls that have a name
1463 if (!ND->getDeclName())
1466 auto *DC = D->getDeclContext();
1468 StoredDeclsMap *Map = DC->getPrimaryContext()->LookupPtr;
1470 StoredDeclsMap::iterator Pos = Map->find(ND->getDeclName());
1471 assert(Pos != Map->end() && "no lookup entry for decl");
1472 // Remove the decl only if it is contained.
1473 StoredDeclsList::DeclsTy *Vec = Pos->second.getAsVector();
1474 if ((Vec && is_contained(*Vec, ND)) || Pos->second.getAsDecl() == ND)
1475 Pos->second.remove(ND);
1477 } while (DC->isTransparentContext() && (DC = DC->getParent()));
1481 void DeclContext::addHiddenDecl(Decl *D) {
1482 assert(D->getLexicalDeclContext() == this &&
1483 "Decl inserted into wrong lexical context");
1484 assert(!D->getNextDeclInContext() && D != LastDecl &&
1485 "Decl already inserted into a DeclContext");
1488 LastDecl->NextInContextAndBits.setPointer(D);
1491 FirstDecl = LastDecl = D;
1494 // Notify a C++ record declaration that we've added a member, so it can
1495 // update its class-specific state.
1496 if (auto *Record = dyn_cast<CXXRecordDecl>(this))
1497 Record->addedMember(D);
1499 // If this is a newly-created (not de-serialized) import declaration, wire
1500 // it in to the list of local import declarations.
1501 if (!D->isFromASTFile()) {
1502 if (auto *Import = dyn_cast<ImportDecl>(D))
1503 D->getASTContext().addedLocalImportDecl(Import);
1507 void DeclContext::addDecl(Decl *D) {
1510 if (auto *ND = dyn_cast<NamedDecl>(D))
1511 ND->getDeclContext()->getPrimaryContext()->
1512 makeDeclVisibleInContextWithFlags(ND, false, true);
1515 void DeclContext::addDeclInternal(Decl *D) {
1518 if (auto *ND = dyn_cast<NamedDecl>(D))
1519 ND->getDeclContext()->getPrimaryContext()->
1520 makeDeclVisibleInContextWithFlags(ND, true, true);
1523 /// buildLookup - Build the lookup data structure with all of the
1524 /// declarations in this DeclContext (and any other contexts linked
1525 /// to it or transparent contexts nested within it) and return it.
1527 /// Note that the produced map may miss out declarations from an
1528 /// external source. If it does, those entries will be marked with
1529 /// the 'hasExternalDecls' flag.
1530 StoredDeclsMap *DeclContext::buildLookup() {
1531 assert(this == getPrimaryContext() && "buildLookup called on non-primary DC");
1533 if (!hasLazyLocalLexicalLookups() &&
1534 !hasLazyExternalLexicalLookups())
1537 SmallVector<DeclContext *, 2> Contexts;
1538 collectAllContexts(Contexts);
1540 if (hasLazyExternalLexicalLookups()) {
1541 setHasLazyExternalLexicalLookups(false);
1542 for (auto *DC : Contexts) {
1543 if (DC->hasExternalLexicalStorage()) {
1544 bool LoadedDecls = DC->LoadLexicalDeclsFromExternalStorage();
1545 setHasLazyLocalLexicalLookups(
1546 hasLazyLocalLexicalLookups() | LoadedDecls );
1550 if (!hasLazyLocalLexicalLookups())
1554 for (auto *DC : Contexts)
1555 buildLookupImpl(DC, hasExternalVisibleStorage());
1557 // We no longer have any lazy decls.
1558 setHasLazyLocalLexicalLookups(false);
1562 /// buildLookupImpl - Build part of the lookup data structure for the
1563 /// declarations contained within DCtx, which will either be this
1564 /// DeclContext, a DeclContext linked to it, or a transparent context
1565 /// nested within it.
1566 void DeclContext::buildLookupImpl(DeclContext *DCtx, bool Internal) {
1567 for (auto *D : DCtx->noload_decls()) {
1568 // Insert this declaration into the lookup structure, but only if
1569 // it's semantically within its decl context. Any other decls which
1570 // should be found in this context are added eagerly.
1572 // If it's from an AST file, don't add it now. It'll get handled by
1573 // FindExternalVisibleDeclsByName if needed. Exception: if we're not
1574 // in C++, we do not track external visible decls for the TU, so in
1575 // that case we need to collect them all here.
1576 if (auto *ND = dyn_cast<NamedDecl>(D))
1577 if (ND->getDeclContext() == DCtx && !shouldBeHidden(ND) &&
1578 (!ND->isFromASTFile() ||
1579 (isTranslationUnit() &&
1580 !getParentASTContext().getLangOpts().CPlusPlus)))
1581 makeDeclVisibleInContextImpl(ND, Internal);
1583 // If this declaration is itself a transparent declaration context
1584 // or inline namespace, add the members of this declaration of that
1585 // context (recursively).
1586 if (auto *InnerCtx = dyn_cast<DeclContext>(D))
1587 if (InnerCtx->isTransparentContext() || InnerCtx->isInlineNamespace())
1588 buildLookupImpl(InnerCtx, Internal);
1592 NamedDecl *const DeclContextLookupResult::SingleElementDummyList = nullptr;
1594 DeclContext::lookup_result
1595 DeclContext::lookup(DeclarationName Name) const {
1596 assert(getDeclKind() != Decl::LinkageSpec &&
1597 getDeclKind() != Decl::Export &&
1598 "should not perform lookups into transparent contexts");
1600 const DeclContext *PrimaryContext = getPrimaryContext();
1601 if (PrimaryContext != this)
1602 return PrimaryContext->lookup(Name);
1604 // If we have an external source, ensure that any later redeclarations of this
1605 // context have been loaded, since they may add names to the result of this
1606 // lookup (or add external visible storage).
1607 ExternalASTSource *Source = getParentASTContext().getExternalSource();
1609 (void)cast<Decl>(this)->getMostRecentDecl();
1611 if (hasExternalVisibleStorage()) {
1612 assert(Source && "external visible storage but no external source?");
1614 if (hasNeedToReconcileExternalVisibleStorage())
1615 reconcileExternalVisibleStorage();
1617 StoredDeclsMap *Map = LookupPtr;
1619 if (hasLazyLocalLexicalLookups() ||
1620 hasLazyExternalLexicalLookups())
1621 // FIXME: Make buildLookup const?
1622 Map = const_cast<DeclContext*>(this)->buildLookup();
1625 Map = CreateStoredDeclsMap(getParentASTContext());
1627 // If we have a lookup result with no external decls, we are done.
1628 std::pair<StoredDeclsMap::iterator, bool> R =
1629 Map->insert(std::make_pair(Name, StoredDeclsList()));
1630 if (!R.second && !R.first->second.hasExternalDecls())
1631 return R.first->second.getLookupResult();
1633 if (Source->FindExternalVisibleDeclsByName(this, Name) || !R.second) {
1634 if (StoredDeclsMap *Map = LookupPtr) {
1635 StoredDeclsMap::iterator I = Map->find(Name);
1636 if (I != Map->end())
1637 return I->second.getLookupResult();
1644 StoredDeclsMap *Map = LookupPtr;
1645 if (hasLazyLocalLexicalLookups() ||
1646 hasLazyExternalLexicalLookups())
1647 Map = const_cast<DeclContext*>(this)->buildLookup();
1652 StoredDeclsMap::iterator I = Map->find(Name);
1653 if (I == Map->end())
1656 return I->second.getLookupResult();
1659 DeclContext::lookup_result
1660 DeclContext::noload_lookup(DeclarationName Name) {
1661 assert(getDeclKind() != Decl::LinkageSpec &&
1662 getDeclKind() != Decl::Export &&
1663 "should not perform lookups into transparent contexts");
1665 DeclContext *PrimaryContext = getPrimaryContext();
1666 if (PrimaryContext != this)
1667 return PrimaryContext->noload_lookup(Name);
1669 loadLazyLocalLexicalLookups();
1670 StoredDeclsMap *Map = LookupPtr;
1674 StoredDeclsMap::iterator I = Map->find(Name);
1675 return I != Map->end() ? I->second.getLookupResult()
1679 // If we have any lazy lexical declarations not in our lookup map, add them
1680 // now. Don't import any external declarations, not even if we know we have
1681 // some missing from the external visible lookups.
1682 void DeclContext::loadLazyLocalLexicalLookups() {
1683 if (hasLazyLocalLexicalLookups()) {
1684 SmallVector<DeclContext *, 2> Contexts;
1685 collectAllContexts(Contexts);
1686 for (auto *Context : Contexts)
1687 buildLookupImpl(Context, hasExternalVisibleStorage());
1688 setHasLazyLocalLexicalLookups(false);
1692 void DeclContext::localUncachedLookup(DeclarationName Name,
1693 SmallVectorImpl<NamedDecl *> &Results) {
1696 // If there's no external storage, just perform a normal lookup and copy
1698 if (!hasExternalVisibleStorage() && !hasExternalLexicalStorage() && Name) {
1699 lookup_result LookupResults = lookup(Name);
1700 Results.insert(Results.end(), LookupResults.begin(), LookupResults.end());
1704 // If we have a lookup table, check there first. Maybe we'll get lucky.
1705 // FIXME: Should we be checking these flags on the primary context?
1706 if (Name && !hasLazyLocalLexicalLookups() &&
1707 !hasLazyExternalLexicalLookups()) {
1708 if (StoredDeclsMap *Map = LookupPtr) {
1709 StoredDeclsMap::iterator Pos = Map->find(Name);
1710 if (Pos != Map->end()) {
1711 Results.insert(Results.end(),
1712 Pos->second.getLookupResult().begin(),
1713 Pos->second.getLookupResult().end());
1719 // Slow case: grovel through the declarations in our chain looking for
1721 // FIXME: If we have lazy external declarations, this will not find them!
1722 // FIXME: Should we CollectAllContexts and walk them all here?
1723 for (Decl *D = FirstDecl; D; D = D->getNextDeclInContext()) {
1724 if (auto *ND = dyn_cast<NamedDecl>(D))
1725 if (ND->getDeclName() == Name)
1726 Results.push_back(ND);
1730 DeclContext *DeclContext::getRedeclContext() {
1731 DeclContext *Ctx = this;
1733 // In C, a record type is the redeclaration context for its fields only. If
1734 // we arrive at a record context after skipping anything else, we should skip
1735 // the record as well. Currently, this means skipping enumerations because
1736 // they're the only transparent context that can exist within a struct or
1738 bool SkipRecords = getDeclKind() == Decl::Kind::Enum &&
1739 !getParentASTContext().getLangOpts().CPlusPlus;
1741 // Skip through contexts to get to the redeclaration context. Transparent
1742 // contexts are always skipped.
1743 while ((SkipRecords && Ctx->isRecord()) || Ctx->isTransparentContext())
1744 Ctx = Ctx->getParent();
1748 DeclContext *DeclContext::getEnclosingNamespaceContext() {
1749 DeclContext *Ctx = this;
1750 // Skip through non-namespace, non-translation-unit contexts.
1751 while (!Ctx->isFileContext())
1752 Ctx = Ctx->getParent();
1753 return Ctx->getPrimaryContext();
1756 RecordDecl *DeclContext::getOuterLexicalRecordContext() {
1757 // Loop until we find a non-record context.
1758 RecordDecl *OutermostRD = nullptr;
1759 DeclContext *DC = this;
1760 while (DC->isRecord()) {
1761 OutermostRD = cast<RecordDecl>(DC);
1762 DC = DC->getLexicalParent();
1767 bool DeclContext::InEnclosingNamespaceSetOf(const DeclContext *O) const {
1768 // For non-file contexts, this is equivalent to Equals.
1769 if (!isFileContext())
1770 return O->Equals(this);
1773 if (O->Equals(this))
1776 const auto *NS = dyn_cast<NamespaceDecl>(O);
1777 if (!NS || !NS->isInline())
1779 O = NS->getParent();
1785 void DeclContext::makeDeclVisibleInContext(NamedDecl *D) {
1786 DeclContext *PrimaryDC = this->getPrimaryContext();
1787 DeclContext *DeclDC = D->getDeclContext()->getPrimaryContext();
1788 // If the decl is being added outside of its semantic decl context, we
1789 // need to ensure that we eagerly build the lookup information for it.
1790 PrimaryDC->makeDeclVisibleInContextWithFlags(D, false, PrimaryDC == DeclDC);
1793 void DeclContext::makeDeclVisibleInContextWithFlags(NamedDecl *D, bool Internal,
1795 assert(this == getPrimaryContext() && "expected a primary DC");
1797 if (!isLookupContext()) {
1798 if (isTransparentContext())
1799 getParent()->getPrimaryContext()
1800 ->makeDeclVisibleInContextWithFlags(D, Internal, Recoverable);
1804 // Skip declarations which should be invisible to name lookup.
1805 if (shouldBeHidden(D))
1808 // If we already have a lookup data structure, perform the insertion into
1809 // it. If we might have externally-stored decls with this name, look them
1810 // up and perform the insertion. If this decl was declared outside its
1811 // semantic context, buildLookup won't add it, so add it now.
1813 // FIXME: As a performance hack, don't add such decls into the translation
1814 // unit unless we're in C++, since qualified lookup into the TU is never
1816 if (LookupPtr || hasExternalVisibleStorage() ||
1817 ((!Recoverable || D->getDeclContext() != D->getLexicalDeclContext()) &&
1818 (getParentASTContext().getLangOpts().CPlusPlus ||
1819 !isTranslationUnit()))) {
1820 // If we have lazily omitted any decls, they might have the same name as
1821 // the decl which we are adding, so build a full lookup table before adding
1824 makeDeclVisibleInContextImpl(D, Internal);
1826 setHasLazyLocalLexicalLookups(true);
1829 // If we are a transparent context or inline namespace, insert into our
1830 // parent context, too. This operation is recursive.
1831 if (isTransparentContext() || isInlineNamespace())
1832 getParent()->getPrimaryContext()->
1833 makeDeclVisibleInContextWithFlags(D, Internal, Recoverable);
1835 auto *DCAsDecl = cast<Decl>(this);
1836 // Notify that a decl was made visible unless we are a Tag being defined.
1837 if (!(isa<TagDecl>(DCAsDecl) && cast<TagDecl>(DCAsDecl)->isBeingDefined()))
1838 if (ASTMutationListener *L = DCAsDecl->getASTMutationListener())
1839 L->AddedVisibleDecl(this, D);
1842 void DeclContext::makeDeclVisibleInContextImpl(NamedDecl *D, bool Internal) {
1843 // Find or create the stored declaration map.
1844 StoredDeclsMap *Map = LookupPtr;
1846 ASTContext *C = &getParentASTContext();
1847 Map = CreateStoredDeclsMap(*C);
1850 // If there is an external AST source, load any declarations it knows about
1851 // with this declaration's name.
1852 // If the lookup table contains an entry about this name it means that we
1853 // have already checked the external source.
1855 if (ExternalASTSource *Source = getParentASTContext().getExternalSource())
1856 if (hasExternalVisibleStorage() &&
1857 Map->find(D->getDeclName()) == Map->end())
1858 Source->FindExternalVisibleDeclsByName(this, D->getDeclName());
1860 // Insert this declaration into the map.
1861 StoredDeclsList &DeclNameEntries = (*Map)[D->getDeclName()];
1864 // If this is being added as part of loading an external declaration,
1865 // this may not be the only external declaration with this name.
1866 // In this case, we never try to replace an existing declaration; we'll
1867 // handle that when we finalize the list of declarations for this name.
1868 DeclNameEntries.setHasExternalDecls();
1869 DeclNameEntries.AddSubsequentDecl(D);
1873 if (DeclNameEntries.isNull()) {
1874 DeclNameEntries.setOnlyValue(D);
1878 if (DeclNameEntries.HandleRedeclaration(D, /*IsKnownNewer*/!Internal)) {
1879 // This declaration has replaced an existing one for which
1880 // declarationReplaces returns true.
1884 // Put this declaration into the appropriate slot.
1885 DeclNameEntries.AddSubsequentDecl(D);
1888 UsingDirectiveDecl *DeclContext::udir_iterator::operator*() const {
1889 return cast<UsingDirectiveDecl>(*I);
1892 /// Returns iterator range [First, Last) of UsingDirectiveDecls stored within
1894 DeclContext::udir_range DeclContext::using_directives() const {
1895 // FIXME: Use something more efficient than normal lookup for using
1896 // directives. In C++, using directives are looked up more than anything else.
1897 lookup_result Result = lookup(UsingDirectiveDecl::getName());
1898 return udir_range(Result.begin(), Result.end());
1901 //===----------------------------------------------------------------------===//
1902 // Creation and Destruction of StoredDeclsMaps. //
1903 //===----------------------------------------------------------------------===//
1905 StoredDeclsMap *DeclContext::CreateStoredDeclsMap(ASTContext &C) const {
1906 assert(!LookupPtr && "context already has a decls map");
1907 assert(getPrimaryContext() == this &&
1908 "creating decls map on non-primary context");
1911 bool Dependent = isDependentContext();
1913 M = new DependentStoredDeclsMap();
1915 M = new StoredDeclsMap();
1916 M->Previous = C.LastSDM;
1917 C.LastSDM = llvm::PointerIntPair<StoredDeclsMap*,1>(M, Dependent);
1922 void ASTContext::ReleaseDeclContextMaps() {
1923 // It's okay to delete DependentStoredDeclsMaps via a StoredDeclsMap
1924 // pointer because the subclass doesn't add anything that needs to
1926 StoredDeclsMap::DestroyAll(LastSDM.getPointer(), LastSDM.getInt());
1929 void StoredDeclsMap::DestroyAll(StoredDeclsMap *Map, bool Dependent) {
1931 // Advance the iteration before we invalidate memory.
1932 llvm::PointerIntPair<StoredDeclsMap*,1> Next = Map->Previous;
1935 delete static_cast<DependentStoredDeclsMap*>(Map);
1939 Map = Next.getPointer();
1940 Dependent = Next.getInt();
1944 DependentDiagnostic *DependentDiagnostic::Create(ASTContext &C,
1945 DeclContext *Parent,
1946 const PartialDiagnostic &PDiag) {
1947 assert(Parent->isDependentContext()
1948 && "cannot iterate dependent diagnostics of non-dependent context");
1949 Parent = Parent->getPrimaryContext();
1950 if (!Parent->LookupPtr)
1951 Parent->CreateStoredDeclsMap(C);
1953 auto *Map = static_cast<DependentStoredDeclsMap *>(Parent->LookupPtr);
1955 // Allocate the copy of the PartialDiagnostic via the ASTContext's
1956 // BumpPtrAllocator, rather than the ASTContext itself.
1957 PartialDiagnostic::Storage *DiagStorage = nullptr;
1958 if (PDiag.hasStorage())
1959 DiagStorage = new (C) PartialDiagnostic::Storage;
1961 auto *DD = new (C) DependentDiagnostic(PDiag, DiagStorage);
1963 // TODO: Maybe we shouldn't reverse the order during insertion.
1964 DD->NextDiagnostic = Map->FirstDiagnostic;
1965 Map->FirstDiagnostic = DD;