1 //===- DeclBase.cpp - Declaration AST Node Implementation -----------------===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // This file implements the Decl and DeclContext classes.
11 //===----------------------------------------------------------------------===//
13 #include "clang/AST/DeclBase.h"
14 #include "clang/AST/ASTContext.h"
15 #include "clang/AST/ASTLambda.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 *), llvm::Align(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 *Var = dyn_cast<VarDecl>(this))
213 return Var->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 const DeclContext *DC = getDeclContext();
359 return DC && DC->isStdNamespace();
362 TranslationUnitDecl *Decl::getTranslationUnitDecl() {
363 if (auto *TUD = dyn_cast<TranslationUnitDecl>(this))
366 DeclContext *DC = getDeclContext();
367 assert(DC && "This decl is not contained in a translation unit!");
369 while (!DC->isTranslationUnit()) {
370 DC = DC->getParent();
371 assert(DC && "This decl is not contained in a translation unit!");
374 return cast<TranslationUnitDecl>(DC);
377 ASTContext &Decl::getASTContext() const {
378 return getTranslationUnitDecl()->getASTContext();
381 ASTMutationListener *Decl::getASTMutationListener() const {
382 return getASTContext().getASTMutationListener();
385 unsigned Decl::getMaxAlignment() const {
390 const AttrVec &V = getAttrs();
391 ASTContext &Ctx = getASTContext();
392 specific_attr_iterator<AlignedAttr> I(V.begin()), E(V.end());
394 Align = std::max(Align, I->getAlignment(Ctx));
398 bool Decl::isUsed(bool CheckUsedAttr) const {
399 const Decl *CanonD = getCanonicalDecl();
403 // Check for used attribute.
404 // Ask the most recent decl, since attributes accumulate in the redecl chain.
405 if (CheckUsedAttr && getMostRecentDecl()->hasAttr<UsedAttr>())
408 // The information may have not been deserialized yet. Force deserialization
409 // to complete the needed information.
410 return getMostRecentDecl()->getCanonicalDecl()->Used;
413 void Decl::markUsed(ASTContext &C) {
417 if (C.getASTMutationListener())
418 C.getASTMutationListener()->DeclarationMarkedUsed(this);
423 bool Decl::isReferenced() const {
427 // Check redeclarations.
428 for (const auto *I : redecls())
435 ExternalSourceSymbolAttr *Decl::getExternalSourceSymbolAttr() const {
436 const Decl *Definition = nullptr;
437 if (auto *ID = dyn_cast<ObjCInterfaceDecl>(this)) {
438 Definition = ID->getDefinition();
439 } else if (auto *PD = dyn_cast<ObjCProtocolDecl>(this)) {
440 Definition = PD->getDefinition();
441 } else if (auto *TD = dyn_cast<TagDecl>(this)) {
442 Definition = TD->getDefinition();
447 if (auto *attr = Definition->getAttr<ExternalSourceSymbolAttr>())
449 if (auto *dcd = dyn_cast<Decl>(getDeclContext())) {
450 return dcd->getAttr<ExternalSourceSymbolAttr>();
456 bool Decl::hasDefiningAttr() const {
457 return hasAttr<AliasAttr>() || hasAttr<IFuncAttr>();
460 const Attr *Decl::getDefiningAttr() const {
461 if (auto *AA = getAttr<AliasAttr>())
463 if (auto *IFA = getAttr<IFuncAttr>())
468 static StringRef getRealizedPlatform(const AvailabilityAttr *A,
469 const ASTContext &Context) {
470 // Check if this is an App Extension "platform", and if so chop off
471 // the suffix for matching with the actual platform.
472 StringRef RealizedPlatform = A->getPlatform()->getName();
473 if (!Context.getLangOpts().AppExt)
474 return RealizedPlatform;
475 size_t suffix = RealizedPlatform.rfind("_app_extension");
476 if (suffix != StringRef::npos)
477 return RealizedPlatform.slice(0, suffix);
478 return RealizedPlatform;
481 /// Determine the availability of the given declaration based on
482 /// the target platform.
484 /// When it returns an availability result other than \c AR_Available,
485 /// if the \p Message parameter is non-NULL, it will be set to a
486 /// string describing why the entity is unavailable.
488 /// FIXME: Make these strings localizable, since they end up in
490 static AvailabilityResult CheckAvailability(ASTContext &Context,
491 const AvailabilityAttr *A,
492 std::string *Message,
493 VersionTuple EnclosingVersion) {
494 if (EnclosingVersion.empty())
495 EnclosingVersion = Context.getTargetInfo().getPlatformMinVersion();
497 if (EnclosingVersion.empty())
500 StringRef ActualPlatform = A->getPlatform()->getName();
501 StringRef TargetPlatform = Context.getTargetInfo().getPlatformName();
503 // Match the platform name.
504 if (getRealizedPlatform(A, Context) != TargetPlatform)
507 StringRef PrettyPlatformName
508 = AvailabilityAttr::getPrettyPlatformName(ActualPlatform);
510 if (PrettyPlatformName.empty())
511 PrettyPlatformName = ActualPlatform;
513 std::string HintMessage;
514 if (!A->getMessage().empty()) {
516 HintMessage += A->getMessage();
519 // Make sure that this declaration has not been marked 'unavailable'.
520 if (A->getUnavailable()) {
523 llvm::raw_string_ostream Out(*Message);
524 Out << "not available on " << PrettyPlatformName
528 return AR_Unavailable;
531 // Make sure that this declaration has already been introduced.
532 if (!A->getIntroduced().empty() &&
533 EnclosingVersion < A->getIntroduced()) {
536 llvm::raw_string_ostream Out(*Message);
537 VersionTuple VTI(A->getIntroduced());
538 Out << "introduced in " << PrettyPlatformName << ' '
539 << VTI << HintMessage;
542 return A->getStrict() ? AR_Unavailable : AR_NotYetIntroduced;
545 // Make sure that this declaration hasn't been obsoleted.
546 if (!A->getObsoleted().empty() && EnclosingVersion >= A->getObsoleted()) {
549 llvm::raw_string_ostream Out(*Message);
550 VersionTuple VTO(A->getObsoleted());
551 Out << "obsoleted in " << PrettyPlatformName << ' '
552 << VTO << HintMessage;
555 return AR_Unavailable;
558 // Make sure that this declaration hasn't been deprecated.
559 if (!A->getDeprecated().empty() && EnclosingVersion >= A->getDeprecated()) {
562 llvm::raw_string_ostream Out(*Message);
563 VersionTuple VTD(A->getDeprecated());
564 Out << "first deprecated in " << PrettyPlatformName << ' '
565 << VTD << HintMessage;
568 return AR_Deprecated;
574 AvailabilityResult Decl::getAvailability(std::string *Message,
575 VersionTuple EnclosingVersion,
576 StringRef *RealizedPlatform) const {
577 if (auto *FTD = dyn_cast<FunctionTemplateDecl>(this))
578 return FTD->getTemplatedDecl()->getAvailability(Message, EnclosingVersion,
581 AvailabilityResult Result = AR_Available;
582 std::string ResultMessage;
584 for (const auto *A : attrs()) {
585 if (const auto *Deprecated = dyn_cast<DeprecatedAttr>(A)) {
586 if (Result >= AR_Deprecated)
590 ResultMessage = Deprecated->getMessage();
592 Result = AR_Deprecated;
596 if (const auto *Unavailable = dyn_cast<UnavailableAttr>(A)) {
598 *Message = Unavailable->getMessage();
599 return AR_Unavailable;
602 if (const auto *Availability = dyn_cast<AvailabilityAttr>(A)) {
603 AvailabilityResult AR = CheckAvailability(getASTContext(), Availability,
604 Message, EnclosingVersion);
606 if (AR == AR_Unavailable) {
607 if (RealizedPlatform)
608 *RealizedPlatform = Availability->getPlatform()->getName();
609 return AR_Unavailable;
615 ResultMessage.swap(*Message);
622 Message->swap(ResultMessage);
626 VersionTuple Decl::getVersionIntroduced() const {
627 const ASTContext &Context = getASTContext();
628 StringRef TargetPlatform = Context.getTargetInfo().getPlatformName();
629 for (const auto *A : attrs()) {
630 if (const auto *Availability = dyn_cast<AvailabilityAttr>(A)) {
631 if (getRealizedPlatform(Availability, Context) != TargetPlatform)
633 if (!Availability->getIntroduced().empty())
634 return Availability->getIntroduced();
640 bool Decl::canBeWeakImported(bool &IsDefinition) const {
641 IsDefinition = false;
643 // Variables, if they aren't definitions.
644 if (const auto *Var = dyn_cast<VarDecl>(this)) {
645 if (Var->isThisDeclarationADefinition()) {
651 // Functions, if they aren't definitions.
652 } else if (const auto *FD = dyn_cast<FunctionDecl>(this)) {
659 // Objective-C classes, if this is the non-fragile runtime.
660 } else if (isa<ObjCInterfaceDecl>(this) &&
661 getASTContext().getLangOpts().ObjCRuntime.hasWeakClassImport()) {
670 bool Decl::isWeakImported() const {
672 if (!canBeWeakImported(IsDefinition))
675 for (const auto *A : attrs()) {
676 if (isa<WeakImportAttr>(A))
679 if (const auto *Availability = dyn_cast<AvailabilityAttr>(A)) {
680 if (CheckAvailability(getASTContext(), Availability, nullptr,
681 VersionTuple()) == AR_NotYetIntroduced)
689 unsigned Decl::getIdentifierNamespaceForKind(Kind DeclKind) {
692 case CXXDeductionGuide:
695 case ConstructorUsingShadow:
705 return IDNS_Ordinary;
709 return IDNS_Ordinary | IDNS_Member;
712 case NonTypeTemplateParm:
715 // These (C++-only) declarations are found by redeclaration lookup for
716 // tag types, so we include them in the tag namespace.
717 return IDNS_Ordinary | IDNS_Tag;
719 case ObjCCompatibleAlias:
721 return IDNS_Ordinary | IDNS_Type;
725 case TemplateTypeParm:
727 return IDNS_Ordinary | IDNS_Type;
729 case UnresolvedUsingTypename:
730 return IDNS_Ordinary | IDNS_Type | IDNS_Using;
733 return 0; // we'll actually overwrite this later
735 case UnresolvedUsingValue:
736 return IDNS_Ordinary | IDNS_Using;
743 return IDNS_ObjCProtocol;
746 case ObjCAtDefsField:
753 return IDNS_Tag | IDNS_Type;
757 return IDNS_Namespace;
759 case FunctionTemplate:
760 return IDNS_Ordinary;
763 case TemplateTemplateParm:
764 case TypeAliasTemplate:
765 return IDNS_Ordinary | IDNS_Tag | IDNS_Type;
767 case OMPDeclareReduction:
768 return IDNS_OMPReduction;
770 case OMPDeclareMapper:
771 return IDNS_OMPMapper;
781 case ObjCPropertyImpl:
783 case PragmaDetectMismatch:
786 case TranslationUnit:
791 case BuiltinTemplate:
792 case ClassTemplateSpecialization:
793 case ClassTemplatePartialSpecialization:
794 case ClassScopeFunctionSpecialization:
795 case VarTemplateSpecialization:
796 case VarTemplatePartialSpecialization:
797 case ObjCImplementation:
799 case ObjCCategoryImpl:
801 case OMPThreadPrivate:
804 case OMPCapturedExpr:
806 // Never looked up by name.
810 llvm_unreachable("Invalid DeclKind!");
813 void Decl::setAttrsImpl(const AttrVec &attrs, ASTContext &Ctx) {
814 assert(!HasAttrs && "Decl already contains attrs.");
816 AttrVec &AttrBlank = Ctx.getDeclAttrs(this);
817 assert(AttrBlank.empty() && "HasAttrs was wrong?");
823 void Decl::dropAttrs() {
824 if (!HasAttrs) return;
827 getASTContext().eraseDeclAttrs(this);
830 void Decl::addAttr(Attr *A) {
832 setAttrs(AttrVec(1, A));
836 AttrVec &Attrs = getAttrs();
837 if (!A->isInherited()) {
842 // Attribute inheritance is processed after attribute parsing. To keep the
843 // order as in the source code, add inherited attributes before non-inherited
845 auto I = Attrs.begin(), E = Attrs.end();
846 for (; I != E; ++I) {
847 if (!(*I)->isInherited())
853 const AttrVec &Decl::getAttrs() const {
854 assert(HasAttrs && "No attrs to get!");
855 return getASTContext().getDeclAttrs(this);
858 Decl *Decl::castFromDeclContext (const DeclContext *D) {
859 Decl::Kind DK = D->getDeclKind();
861 #define DECL(NAME, BASE)
862 #define DECL_CONTEXT(NAME) \
864 return static_cast<NAME##Decl *>(const_cast<DeclContext *>(D));
865 #define DECL_CONTEXT_BASE(NAME)
866 #include "clang/AST/DeclNodes.inc"
868 #define DECL(NAME, BASE)
869 #define DECL_CONTEXT_BASE(NAME) \
870 if (DK >= first##NAME && DK <= last##NAME) \
871 return static_cast<NAME##Decl *>(const_cast<DeclContext *>(D));
872 #include "clang/AST/DeclNodes.inc"
873 llvm_unreachable("a decl that inherits DeclContext isn't handled");
877 DeclContext *Decl::castToDeclContext(const Decl *D) {
878 Decl::Kind DK = D->getKind();
880 #define DECL(NAME, BASE)
881 #define DECL_CONTEXT(NAME) \
883 return static_cast<NAME##Decl *>(const_cast<Decl *>(D));
884 #define DECL_CONTEXT_BASE(NAME)
885 #include "clang/AST/DeclNodes.inc"
887 #define DECL(NAME, BASE)
888 #define DECL_CONTEXT_BASE(NAME) \
889 if (DK >= first##NAME && DK <= last##NAME) \
890 return static_cast<NAME##Decl *>(const_cast<Decl *>(D));
891 #include "clang/AST/DeclNodes.inc"
892 llvm_unreachable("a decl that inherits DeclContext isn't handled");
896 SourceLocation Decl::getBodyRBrace() const {
897 // Special handling of FunctionDecl to avoid de-serializing the body from PCH.
898 // FunctionDecl stores EndRangeLoc for this purpose.
899 if (const auto *FD = dyn_cast<FunctionDecl>(this)) {
900 const FunctionDecl *Definition;
901 if (FD->hasBody(Definition))
902 return Definition->getSourceRange().getEnd();
906 if (Stmt *Body = getBody())
907 return Body->getSourceRange().getEnd();
912 bool Decl::AccessDeclContextSanity() const {
914 // Suppress this check if any of the following hold:
915 // 1. this is the translation unit (and thus has no parent)
916 // 2. this is a template parameter (and thus doesn't belong to its context)
917 // 3. this is a non-type template parameter
918 // 4. the context is not a record
920 // 6. it's a C++0x static_assert.
921 // 7. it's a block literal declaration
922 if (isa<TranslationUnitDecl>(this) ||
923 isa<TemplateTypeParmDecl>(this) ||
924 isa<NonTypeTemplateParmDecl>(this) ||
926 !isa<CXXRecordDecl>(getDeclContext()) ||
928 isa<StaticAssertDecl>(this) ||
929 isa<BlockDecl>(this) ||
930 // FIXME: a ParmVarDecl can have ClassTemplateSpecialization
931 // as DeclContext (?).
932 isa<ParmVarDecl>(this) ||
933 // FIXME: a ClassTemplateSpecialization or CXXRecordDecl can have
934 // AS_none as access specifier.
935 isa<CXXRecordDecl>(this) ||
936 isa<ClassScopeFunctionSpecializationDecl>(this))
939 assert(Access != AS_none &&
940 "Access specifier is AS_none inside a record decl");
945 static Decl::Kind getKind(const Decl *D) { return D->getKind(); }
946 static Decl::Kind getKind(const DeclContext *DC) { return DC->getDeclKind(); }
948 int64_t Decl::getID() const {
949 return getASTContext().getAllocator().identifyKnownAlignedObject<Decl>(this);
952 const FunctionType *Decl::getFunctionType(bool BlocksToo) const {
954 if (const auto *D = dyn_cast<ValueDecl>(this))
956 else if (const auto *D = dyn_cast<TypedefNameDecl>(this))
957 Ty = D->getUnderlyingType();
961 if (Ty->isFunctionPointerType())
962 Ty = Ty->castAs<PointerType>()->getPointeeType();
963 else if (Ty->isFunctionReferenceType())
964 Ty = Ty->castAs<ReferenceType>()->getPointeeType();
965 else if (BlocksToo && Ty->isBlockPointerType())
966 Ty = Ty->castAs<BlockPointerType>()->getPointeeType();
968 return Ty->getAs<FunctionType>();
971 /// Starting at a given context (a Decl or DeclContext), look for a
972 /// code context that is not a closure (a lambda, block, etc.).
973 template <class T> static Decl *getNonClosureContext(T *D) {
974 if (getKind(D) == Decl::CXXMethod) {
975 auto *MD = cast<CXXMethodDecl>(D);
976 if (MD->getOverloadedOperator() == OO_Call &&
977 MD->getParent()->isLambda())
978 return getNonClosureContext(MD->getParent()->getParent());
980 } else if (auto *FD = dyn_cast<FunctionDecl>(D))
982 else if (auto *MD = dyn_cast<ObjCMethodDecl>(D))
984 else if (auto *BD = dyn_cast<BlockDecl>(D))
985 return getNonClosureContext(BD->getParent());
986 else if (auto *CD = dyn_cast<CapturedDecl>(D))
987 return getNonClosureContext(CD->getParent());
992 Decl *Decl::getNonClosureContext() {
993 return ::getNonClosureContext(this);
996 Decl *DeclContext::getNonClosureAncestor() {
997 return ::getNonClosureContext(this);
1000 //===----------------------------------------------------------------------===//
1001 // DeclContext Implementation
1002 //===----------------------------------------------------------------------===//
1004 DeclContext::DeclContext(Decl::Kind K) {
1005 DeclContextBits.DeclKind = K;
1006 setHasExternalLexicalStorage(false);
1007 setHasExternalVisibleStorage(false);
1008 setNeedToReconcileExternalVisibleStorage(false);
1009 setHasLazyLocalLexicalLookups(false);
1010 setHasLazyExternalLexicalLookups(false);
1011 setUseQualifiedLookup(false);
1014 bool DeclContext::classof(const Decl *D) {
1015 switch (D->getKind()) {
1016 #define DECL(NAME, BASE)
1017 #define DECL_CONTEXT(NAME) case Decl::NAME:
1018 #define DECL_CONTEXT_BASE(NAME)
1019 #include "clang/AST/DeclNodes.inc"
1022 #define DECL(NAME, BASE)
1023 #define DECL_CONTEXT_BASE(NAME) \
1024 if (D->getKind() >= Decl::first##NAME && \
1025 D->getKind() <= Decl::last##NAME) \
1027 #include "clang/AST/DeclNodes.inc"
1032 DeclContext::~DeclContext() = default;
1034 /// Find the parent context of this context that will be
1035 /// used for unqualified name lookup.
1037 /// Generally, the parent lookup context is the semantic context. However, for
1038 /// a friend function the parent lookup context is the lexical context, which
1039 /// is the class in which the friend is declared.
1040 DeclContext *DeclContext::getLookupParent() {
1041 // FIXME: Find a better way to identify friends.
1042 if (isa<FunctionDecl>(this))
1043 if (getParent()->getRedeclContext()->isFileContext() &&
1044 getLexicalParent()->getRedeclContext()->isRecord())
1045 return getLexicalParent();
1047 // A lookup within the call operator of a lambda never looks in the lambda
1048 // class; instead, skip to the context in which that closure type is
1050 if (isLambdaCallOperator(this))
1051 return getParent()->getParent();
1056 const BlockDecl *DeclContext::getInnermostBlockDecl() const {
1057 const DeclContext *Ctx = this;
1060 if (Ctx->isClosure())
1061 return cast<BlockDecl>(Ctx);
1062 Ctx = Ctx->getParent();
1068 bool DeclContext::isInlineNamespace() const {
1069 return isNamespace() &&
1070 cast<NamespaceDecl>(this)->isInline();
1073 bool DeclContext::isStdNamespace() const {
1077 const auto *ND = cast<NamespaceDecl>(this);
1078 if (ND->isInline()) {
1079 return ND->getParent()->isStdNamespace();
1082 if (!getParent()->getRedeclContext()->isTranslationUnit())
1085 const IdentifierInfo *II = ND->getIdentifier();
1086 return II && II->isStr("std");
1089 bool DeclContext::isDependentContext() const {
1090 if (isFileContext())
1093 if (isa<ClassTemplatePartialSpecializationDecl>(this))
1096 if (const auto *Record = dyn_cast<CXXRecordDecl>(this)) {
1097 if (Record->getDescribedClassTemplate())
1100 if (Record->isDependentLambda())
1104 if (const auto *Function = dyn_cast<FunctionDecl>(this)) {
1105 if (Function->getDescribedFunctionTemplate())
1108 // Friend function declarations are dependent if their *lexical*
1109 // context is dependent.
1110 if (cast<Decl>(this)->getFriendObjectKind())
1111 return getLexicalParent()->isDependentContext();
1114 // FIXME: A variable template is a dependent context, but is not a
1115 // DeclContext. A context within it (such as a lambda-expression)
1116 // should be considered dependent.
1118 return getParent() && getParent()->isDependentContext();
1121 bool DeclContext::isTransparentContext() const {
1122 if (getDeclKind() == Decl::Enum)
1123 return !cast<EnumDecl>(this)->isScoped();
1124 else if (getDeclKind() == Decl::LinkageSpec || getDeclKind() == Decl::Export)
1130 static bool isLinkageSpecContext(const DeclContext *DC,
1131 LinkageSpecDecl::LanguageIDs ID) {
1132 while (DC->getDeclKind() != Decl::TranslationUnit) {
1133 if (DC->getDeclKind() == Decl::LinkageSpec)
1134 return cast<LinkageSpecDecl>(DC)->getLanguage() == ID;
1135 DC = DC->getLexicalParent();
1140 bool DeclContext::isExternCContext() const {
1141 return isLinkageSpecContext(this, LinkageSpecDecl::lang_c);
1144 const LinkageSpecDecl *DeclContext::getExternCContext() const {
1145 const DeclContext *DC = this;
1146 while (DC->getDeclKind() != Decl::TranslationUnit) {
1147 if (DC->getDeclKind() == Decl::LinkageSpec &&
1148 cast<LinkageSpecDecl>(DC)->getLanguage() == LinkageSpecDecl::lang_c)
1149 return cast<LinkageSpecDecl>(DC);
1150 DC = DC->getLexicalParent();
1155 bool DeclContext::isExternCXXContext() const {
1156 return isLinkageSpecContext(this, LinkageSpecDecl::lang_cxx);
1159 bool DeclContext::Encloses(const DeclContext *DC) const {
1160 if (getPrimaryContext() != this)
1161 return getPrimaryContext()->Encloses(DC);
1163 for (; DC; DC = DC->getParent())
1164 if (DC->getPrimaryContext() == this)
1169 DeclContext *DeclContext::getPrimaryContext() {
1170 switch (getDeclKind()) {
1171 case Decl::TranslationUnit:
1172 case Decl::ExternCContext:
1173 case Decl::LinkageSpec:
1176 case Decl::Captured:
1177 case Decl::OMPDeclareReduction:
1178 case Decl::OMPDeclareMapper:
1179 // There is only one DeclContext for these entities.
1182 case Decl::Namespace:
1183 // The original namespace is our primary context.
1184 return static_cast<NamespaceDecl *>(this)->getOriginalNamespace();
1186 case Decl::ObjCMethod:
1189 case Decl::ObjCInterface:
1190 if (auto *OID = dyn_cast<ObjCInterfaceDecl>(this))
1191 if (auto *Def = OID->getDefinition())
1195 case Decl::ObjCProtocol:
1196 if (auto *OPD = dyn_cast<ObjCProtocolDecl>(this))
1197 if (auto *Def = OPD->getDefinition())
1201 case Decl::ObjCCategory:
1204 case Decl::ObjCImplementation:
1205 case Decl::ObjCCategoryImpl:
1209 if (getDeclKind() >= Decl::firstTag && getDeclKind() <= Decl::lastTag) {
1210 // If this is a tag type that has a definition or is currently
1211 // being defined, that definition is our primary context.
1212 auto *Tag = cast<TagDecl>(this);
1214 if (TagDecl *Def = Tag->getDefinition())
1217 if (const auto *TagTy = dyn_cast<TagType>(Tag->getTypeForDecl())) {
1218 // Note, TagType::getDecl returns the (partial) definition one exists.
1219 TagDecl *PossiblePartialDef = TagTy->getDecl();
1220 if (PossiblePartialDef->isBeingDefined())
1221 return PossiblePartialDef;
1223 assert(isa<InjectedClassNameType>(Tag->getTypeForDecl()));
1229 assert(getDeclKind() >= Decl::firstFunction &&
1230 getDeclKind() <= Decl::lastFunction &&
1231 "Unknown DeclContext kind");
1237 DeclContext::collectAllContexts(SmallVectorImpl<DeclContext *> &Contexts){
1240 if (getDeclKind() != Decl::Namespace) {
1241 Contexts.push_back(this);
1245 auto *Self = static_cast<NamespaceDecl *>(this);
1246 for (NamespaceDecl *N = Self->getMostRecentDecl(); N;
1247 N = N->getPreviousDecl())
1248 Contexts.push_back(N);
1250 std::reverse(Contexts.begin(), Contexts.end());
1253 std::pair<Decl *, Decl *>
1254 DeclContext::BuildDeclChain(ArrayRef<Decl *> Decls,
1255 bool FieldsAlreadyLoaded) {
1256 // Build up a chain of declarations via the Decl::NextInContextAndBits field.
1257 Decl *FirstNewDecl = nullptr;
1258 Decl *PrevDecl = nullptr;
1259 for (auto *D : Decls) {
1260 if (FieldsAlreadyLoaded && isa<FieldDecl>(D))
1264 PrevDecl->NextInContextAndBits.setPointer(D);
1271 return std::make_pair(FirstNewDecl, PrevDecl);
1274 /// We have just acquired external visible storage, and we already have
1275 /// built a lookup map. For every name in the map, pull in the new names from
1276 /// the external storage.
1277 void DeclContext::reconcileExternalVisibleStorage() const {
1278 assert(hasNeedToReconcileExternalVisibleStorage() && LookupPtr);
1279 setNeedToReconcileExternalVisibleStorage(false);
1281 for (auto &Lookup : *LookupPtr)
1282 Lookup.second.setHasExternalDecls();
1285 /// Load the declarations within this lexical storage from an
1286 /// external source.
1287 /// \return \c true if any declarations were added.
1289 DeclContext::LoadLexicalDeclsFromExternalStorage() const {
1290 ExternalASTSource *Source = getParentASTContext().getExternalSource();
1291 assert(hasExternalLexicalStorage() && Source && "No external storage?");
1293 // Notify that we have a DeclContext that is initializing.
1294 ExternalASTSource::Deserializing ADeclContext(Source);
1296 // Load the external declarations, if any.
1297 SmallVector<Decl*, 64> Decls;
1298 setHasExternalLexicalStorage(false);
1299 Source->FindExternalLexicalDecls(this, Decls);
1304 // We may have already loaded just the fields of this record, in which case
1305 // we need to ignore them.
1306 bool FieldsAlreadyLoaded = false;
1307 if (const auto *RD = dyn_cast<RecordDecl>(this))
1308 FieldsAlreadyLoaded = RD->hasLoadedFieldsFromExternalStorage();
1310 // Splice the newly-read declarations into the beginning of the list
1312 Decl *ExternalFirst, *ExternalLast;
1313 std::tie(ExternalFirst, ExternalLast) =
1314 BuildDeclChain(Decls, FieldsAlreadyLoaded);
1315 ExternalLast->NextInContextAndBits.setPointer(FirstDecl);
1316 FirstDecl = ExternalFirst;
1318 LastDecl = ExternalLast;
1322 DeclContext::lookup_result
1323 ExternalASTSource::SetNoExternalVisibleDeclsForName(const DeclContext *DC,
1324 DeclarationName Name) {
1325 ASTContext &Context = DC->getParentASTContext();
1326 StoredDeclsMap *Map;
1327 if (!(Map = DC->LookupPtr))
1328 Map = DC->CreateStoredDeclsMap(Context);
1329 if (DC->hasNeedToReconcileExternalVisibleStorage())
1330 DC->reconcileExternalVisibleStorage();
1332 (*Map)[Name].removeExternalDecls();
1334 return DeclContext::lookup_result();
1337 DeclContext::lookup_result
1338 ExternalASTSource::SetExternalVisibleDeclsForName(const DeclContext *DC,
1339 DeclarationName Name,
1340 ArrayRef<NamedDecl*> Decls) {
1341 ASTContext &Context = DC->getParentASTContext();
1342 StoredDeclsMap *Map;
1343 if (!(Map = DC->LookupPtr))
1344 Map = DC->CreateStoredDeclsMap(Context);
1345 if (DC->hasNeedToReconcileExternalVisibleStorage())
1346 DC->reconcileExternalVisibleStorage();
1348 StoredDeclsList &List = (*Map)[Name];
1350 // Clear out any old external visible declarations, to avoid quadratic
1351 // performance in the redeclaration checks below.
1352 List.removeExternalDecls();
1354 if (!List.isNull()) {
1355 // We have both existing declarations and new declarations for this name.
1356 // Some of the declarations may simply replace existing ones. Handle those
1358 llvm::SmallVector<unsigned, 8> Skip;
1359 for (unsigned I = 0, N = Decls.size(); I != N; ++I)
1360 if (List.HandleRedeclaration(Decls[I], /*IsKnownNewer*/false))
1362 Skip.push_back(Decls.size());
1364 // Add in any new declarations.
1365 unsigned SkipPos = 0;
1366 for (unsigned I = 0, N = Decls.size(); I != N; ++I) {
1367 if (I == Skip[SkipPos])
1370 List.AddSubsequentDecl(Decls[I]);
1373 // Convert the array to a StoredDeclsList.
1374 for (auto *D : Decls) {
1376 List.setOnlyValue(D);
1378 List.AddSubsequentDecl(D);
1382 return List.getLookupResult();
1385 DeclContext::decl_iterator DeclContext::decls_begin() const {
1386 if (hasExternalLexicalStorage())
1387 LoadLexicalDeclsFromExternalStorage();
1388 return decl_iterator(FirstDecl);
1391 bool DeclContext::decls_empty() const {
1392 if (hasExternalLexicalStorage())
1393 LoadLexicalDeclsFromExternalStorage();
1398 bool DeclContext::containsDecl(Decl *D) const {
1399 return (D->getLexicalDeclContext() == this &&
1400 (D->NextInContextAndBits.getPointer() || D == LastDecl));
1403 bool DeclContext::containsDeclAndLoad(Decl *D) const {
1404 if (hasExternalLexicalStorage())
1405 LoadLexicalDeclsFromExternalStorage();
1406 return containsDecl(D);
1409 /// shouldBeHidden - Determine whether a declaration which was declared
1410 /// within its semantic context should be invisible to qualified name lookup.
1411 static bool shouldBeHidden(NamedDecl *D) {
1412 // Skip unnamed declarations.
1413 if (!D->getDeclName())
1416 // Skip entities that can't be found by name lookup into a particular
1418 if ((D->getIdentifierNamespace() == 0 && !isa<UsingDirectiveDecl>(D)) ||
1419 D->isTemplateParameter())
1422 // Skip friends and local extern declarations unless they're the first
1423 // declaration of the entity.
1424 if ((D->isLocalExternDecl() || D->getFriendObjectKind()) &&
1425 D != D->getCanonicalDecl())
1428 // Skip template specializations.
1429 // FIXME: This feels like a hack. Should DeclarationName support
1430 // template-ids, or is there a better way to keep specializations
1431 // from being visible?
1432 if (isa<ClassTemplateSpecializationDecl>(D))
1434 if (auto *FD = dyn_cast<FunctionDecl>(D))
1435 if (FD->isFunctionTemplateSpecialization())
1441 void DeclContext::removeDecl(Decl *D) {
1442 assert(D->getLexicalDeclContext() == this &&
1443 "decl being removed from non-lexical context");
1444 assert((D->NextInContextAndBits.getPointer() || D == LastDecl) &&
1445 "decl is not in decls list");
1447 // Remove D from the decl chain. This is O(n) but hopefully rare.
1448 if (D == FirstDecl) {
1450 FirstDecl = LastDecl = nullptr;
1452 FirstDecl = D->NextInContextAndBits.getPointer();
1454 for (Decl *I = FirstDecl; true; I = I->NextInContextAndBits.getPointer()) {
1455 assert(I && "decl not found in linked list");
1456 if (I->NextInContextAndBits.getPointer() == D) {
1457 I->NextInContextAndBits.setPointer(D->NextInContextAndBits.getPointer());
1458 if (D == LastDecl) LastDecl = I;
1464 // Mark that D is no longer in the decl chain.
1465 D->NextInContextAndBits.setPointer(nullptr);
1467 // Remove D from the lookup table if necessary.
1468 if (isa<NamedDecl>(D)) {
1469 auto *ND = cast<NamedDecl>(D);
1471 // Do not try to remove the declaration if that is invisible to qualified
1472 // lookup. E.g. template specializations are skipped.
1473 if (shouldBeHidden(ND))
1476 // Remove only decls that have a name
1477 if (!ND->getDeclName())
1480 auto *DC = D->getDeclContext();
1482 StoredDeclsMap *Map = DC->getPrimaryContext()->LookupPtr;
1484 StoredDeclsMap::iterator Pos = Map->find(ND->getDeclName());
1485 assert(Pos != Map->end() && "no lookup entry for decl");
1486 // Remove the decl only if it is contained.
1487 StoredDeclsList::DeclsTy *Vec = Pos->second.getAsVector();
1488 if ((Vec && is_contained(*Vec, ND)) || Pos->second.getAsDecl() == ND)
1489 Pos->second.remove(ND);
1491 } while (DC->isTransparentContext() && (DC = DC->getParent()));
1495 void DeclContext::addHiddenDecl(Decl *D) {
1496 assert(D->getLexicalDeclContext() == this &&
1497 "Decl inserted into wrong lexical context");
1498 assert(!D->getNextDeclInContext() && D != LastDecl &&
1499 "Decl already inserted into a DeclContext");
1502 LastDecl->NextInContextAndBits.setPointer(D);
1505 FirstDecl = LastDecl = D;
1508 // Notify a C++ record declaration that we've added a member, so it can
1509 // update its class-specific state.
1510 if (auto *Record = dyn_cast<CXXRecordDecl>(this))
1511 Record->addedMember(D);
1513 // If this is a newly-created (not de-serialized) import declaration, wire
1514 // it in to the list of local import declarations.
1515 if (!D->isFromASTFile()) {
1516 if (auto *Import = dyn_cast<ImportDecl>(D))
1517 D->getASTContext().addedLocalImportDecl(Import);
1521 void DeclContext::addDecl(Decl *D) {
1524 if (auto *ND = dyn_cast<NamedDecl>(D))
1525 ND->getDeclContext()->getPrimaryContext()->
1526 makeDeclVisibleInContextWithFlags(ND, false, true);
1529 void DeclContext::addDeclInternal(Decl *D) {
1532 if (auto *ND = dyn_cast<NamedDecl>(D))
1533 ND->getDeclContext()->getPrimaryContext()->
1534 makeDeclVisibleInContextWithFlags(ND, true, true);
1537 /// buildLookup - Build the lookup data structure with all of the
1538 /// declarations in this DeclContext (and any other contexts linked
1539 /// to it or transparent contexts nested within it) and return it.
1541 /// Note that the produced map may miss out declarations from an
1542 /// external source. If it does, those entries will be marked with
1543 /// the 'hasExternalDecls' flag.
1544 StoredDeclsMap *DeclContext::buildLookup() {
1545 assert(this == getPrimaryContext() && "buildLookup called on non-primary DC");
1547 if (!hasLazyLocalLexicalLookups() &&
1548 !hasLazyExternalLexicalLookups())
1551 SmallVector<DeclContext *, 2> Contexts;
1552 collectAllContexts(Contexts);
1554 if (hasLazyExternalLexicalLookups()) {
1555 setHasLazyExternalLexicalLookups(false);
1556 for (auto *DC : Contexts) {
1557 if (DC->hasExternalLexicalStorage()) {
1558 bool LoadedDecls = DC->LoadLexicalDeclsFromExternalStorage();
1559 setHasLazyLocalLexicalLookups(
1560 hasLazyLocalLexicalLookups() | LoadedDecls );
1564 if (!hasLazyLocalLexicalLookups())
1568 for (auto *DC : Contexts)
1569 buildLookupImpl(DC, hasExternalVisibleStorage());
1571 // We no longer have any lazy decls.
1572 setHasLazyLocalLexicalLookups(false);
1576 /// buildLookupImpl - Build part of the lookup data structure for the
1577 /// declarations contained within DCtx, which will either be this
1578 /// DeclContext, a DeclContext linked to it, or a transparent context
1579 /// nested within it.
1580 void DeclContext::buildLookupImpl(DeclContext *DCtx, bool Internal) {
1581 for (auto *D : DCtx->noload_decls()) {
1582 // Insert this declaration into the lookup structure, but only if
1583 // it's semantically within its decl context. Any other decls which
1584 // should be found in this context are added eagerly.
1586 // If it's from an AST file, don't add it now. It'll get handled by
1587 // FindExternalVisibleDeclsByName if needed. Exception: if we're not
1588 // in C++, we do not track external visible decls for the TU, so in
1589 // that case we need to collect them all here.
1590 if (auto *ND = dyn_cast<NamedDecl>(D))
1591 if (ND->getDeclContext() == DCtx && !shouldBeHidden(ND) &&
1592 (!ND->isFromASTFile() ||
1593 (isTranslationUnit() &&
1594 !getParentASTContext().getLangOpts().CPlusPlus)))
1595 makeDeclVisibleInContextImpl(ND, Internal);
1597 // If this declaration is itself a transparent declaration context
1598 // or inline namespace, add the members of this declaration of that
1599 // context (recursively).
1600 if (auto *InnerCtx = dyn_cast<DeclContext>(D))
1601 if (InnerCtx->isTransparentContext() || InnerCtx->isInlineNamespace())
1602 buildLookupImpl(InnerCtx, Internal);
1606 NamedDecl *const DeclContextLookupResult::SingleElementDummyList = nullptr;
1608 DeclContext::lookup_result
1609 DeclContext::lookup(DeclarationName Name) const {
1610 assert(getDeclKind() != Decl::LinkageSpec &&
1611 getDeclKind() != Decl::Export &&
1612 "should not perform lookups into transparent contexts");
1614 const DeclContext *PrimaryContext = getPrimaryContext();
1615 if (PrimaryContext != this)
1616 return PrimaryContext->lookup(Name);
1618 // If we have an external source, ensure that any later redeclarations of this
1619 // context have been loaded, since they may add names to the result of this
1620 // lookup (or add external visible storage).
1621 ExternalASTSource *Source = getParentASTContext().getExternalSource();
1623 (void)cast<Decl>(this)->getMostRecentDecl();
1625 if (hasExternalVisibleStorage()) {
1626 assert(Source && "external visible storage but no external source?");
1628 if (hasNeedToReconcileExternalVisibleStorage())
1629 reconcileExternalVisibleStorage();
1631 StoredDeclsMap *Map = LookupPtr;
1633 if (hasLazyLocalLexicalLookups() ||
1634 hasLazyExternalLexicalLookups())
1635 // FIXME: Make buildLookup const?
1636 Map = const_cast<DeclContext*>(this)->buildLookup();
1639 Map = CreateStoredDeclsMap(getParentASTContext());
1641 // If we have a lookup result with no external decls, we are done.
1642 std::pair<StoredDeclsMap::iterator, bool> R =
1643 Map->insert(std::make_pair(Name, StoredDeclsList()));
1644 if (!R.second && !R.first->second.hasExternalDecls())
1645 return R.first->second.getLookupResult();
1647 if (Source->FindExternalVisibleDeclsByName(this, Name) || !R.second) {
1648 if (StoredDeclsMap *Map = LookupPtr) {
1649 StoredDeclsMap::iterator I = Map->find(Name);
1650 if (I != Map->end())
1651 return I->second.getLookupResult();
1658 StoredDeclsMap *Map = LookupPtr;
1659 if (hasLazyLocalLexicalLookups() ||
1660 hasLazyExternalLexicalLookups())
1661 Map = const_cast<DeclContext*>(this)->buildLookup();
1666 StoredDeclsMap::iterator I = Map->find(Name);
1667 if (I == Map->end())
1670 return I->second.getLookupResult();
1673 DeclContext::lookup_result
1674 DeclContext::noload_lookup(DeclarationName Name) {
1675 assert(getDeclKind() != Decl::LinkageSpec &&
1676 getDeclKind() != Decl::Export &&
1677 "should not perform lookups into transparent contexts");
1679 DeclContext *PrimaryContext = getPrimaryContext();
1680 if (PrimaryContext != this)
1681 return PrimaryContext->noload_lookup(Name);
1683 loadLazyLocalLexicalLookups();
1684 StoredDeclsMap *Map = LookupPtr;
1688 StoredDeclsMap::iterator I = Map->find(Name);
1689 return I != Map->end() ? I->second.getLookupResult()
1693 // If we have any lazy lexical declarations not in our lookup map, add them
1694 // now. Don't import any external declarations, not even if we know we have
1695 // some missing from the external visible lookups.
1696 void DeclContext::loadLazyLocalLexicalLookups() {
1697 if (hasLazyLocalLexicalLookups()) {
1698 SmallVector<DeclContext *, 2> Contexts;
1699 collectAllContexts(Contexts);
1700 for (auto *Context : Contexts)
1701 buildLookupImpl(Context, hasExternalVisibleStorage());
1702 setHasLazyLocalLexicalLookups(false);
1706 void DeclContext::localUncachedLookup(DeclarationName Name,
1707 SmallVectorImpl<NamedDecl *> &Results) {
1710 // If there's no external storage, just perform a normal lookup and copy
1712 if (!hasExternalVisibleStorage() && !hasExternalLexicalStorage() && Name) {
1713 lookup_result LookupResults = lookup(Name);
1714 Results.insert(Results.end(), LookupResults.begin(), LookupResults.end());
1718 // If we have a lookup table, check there first. Maybe we'll get lucky.
1719 // FIXME: Should we be checking these flags on the primary context?
1720 if (Name && !hasLazyLocalLexicalLookups() &&
1721 !hasLazyExternalLexicalLookups()) {
1722 if (StoredDeclsMap *Map = LookupPtr) {
1723 StoredDeclsMap::iterator Pos = Map->find(Name);
1724 if (Pos != Map->end()) {
1725 Results.insert(Results.end(),
1726 Pos->second.getLookupResult().begin(),
1727 Pos->second.getLookupResult().end());
1733 // Slow case: grovel through the declarations in our chain looking for
1735 // FIXME: If we have lazy external declarations, this will not find them!
1736 // FIXME: Should we CollectAllContexts and walk them all here?
1737 for (Decl *D = FirstDecl; D; D = D->getNextDeclInContext()) {
1738 if (auto *ND = dyn_cast<NamedDecl>(D))
1739 if (ND->getDeclName() == Name)
1740 Results.push_back(ND);
1744 DeclContext *DeclContext::getRedeclContext() {
1745 DeclContext *Ctx = this;
1747 // In C, a record type is the redeclaration context for its fields only. If
1748 // we arrive at a record context after skipping anything else, we should skip
1749 // the record as well. Currently, this means skipping enumerations because
1750 // they're the only transparent context that can exist within a struct or
1752 bool SkipRecords = getDeclKind() == Decl::Kind::Enum &&
1753 !getParentASTContext().getLangOpts().CPlusPlus;
1755 // Skip through contexts to get to the redeclaration context. Transparent
1756 // contexts are always skipped.
1757 while ((SkipRecords && Ctx->isRecord()) || Ctx->isTransparentContext())
1758 Ctx = Ctx->getParent();
1762 DeclContext *DeclContext::getEnclosingNamespaceContext() {
1763 DeclContext *Ctx = this;
1764 // Skip through non-namespace, non-translation-unit contexts.
1765 while (!Ctx->isFileContext())
1766 Ctx = Ctx->getParent();
1767 return Ctx->getPrimaryContext();
1770 RecordDecl *DeclContext::getOuterLexicalRecordContext() {
1771 // Loop until we find a non-record context.
1772 RecordDecl *OutermostRD = nullptr;
1773 DeclContext *DC = this;
1774 while (DC->isRecord()) {
1775 OutermostRD = cast<RecordDecl>(DC);
1776 DC = DC->getLexicalParent();
1781 bool DeclContext::InEnclosingNamespaceSetOf(const DeclContext *O) const {
1782 // For non-file contexts, this is equivalent to Equals.
1783 if (!isFileContext())
1784 return O->Equals(this);
1787 if (O->Equals(this))
1790 const auto *NS = dyn_cast<NamespaceDecl>(O);
1791 if (!NS || !NS->isInline())
1793 O = NS->getParent();
1799 void DeclContext::makeDeclVisibleInContext(NamedDecl *D) {
1800 DeclContext *PrimaryDC = this->getPrimaryContext();
1801 DeclContext *DeclDC = D->getDeclContext()->getPrimaryContext();
1802 // If the decl is being added outside of its semantic decl context, we
1803 // need to ensure that we eagerly build the lookup information for it.
1804 PrimaryDC->makeDeclVisibleInContextWithFlags(D, false, PrimaryDC == DeclDC);
1807 void DeclContext::makeDeclVisibleInContextWithFlags(NamedDecl *D, bool Internal,
1809 assert(this == getPrimaryContext() && "expected a primary DC");
1811 if (!isLookupContext()) {
1812 if (isTransparentContext())
1813 getParent()->getPrimaryContext()
1814 ->makeDeclVisibleInContextWithFlags(D, Internal, Recoverable);
1818 // Skip declarations which should be invisible to name lookup.
1819 if (shouldBeHidden(D))
1822 // If we already have a lookup data structure, perform the insertion into
1823 // it. If we might have externally-stored decls with this name, look them
1824 // up and perform the insertion. If this decl was declared outside its
1825 // semantic context, buildLookup won't add it, so add it now.
1827 // FIXME: As a performance hack, don't add such decls into the translation
1828 // unit unless we're in C++, since qualified lookup into the TU is never
1830 if (LookupPtr || hasExternalVisibleStorage() ||
1831 ((!Recoverable || D->getDeclContext() != D->getLexicalDeclContext()) &&
1832 (getParentASTContext().getLangOpts().CPlusPlus ||
1833 !isTranslationUnit()))) {
1834 // If we have lazily omitted any decls, they might have the same name as
1835 // the decl which we are adding, so build a full lookup table before adding
1838 makeDeclVisibleInContextImpl(D, Internal);
1840 setHasLazyLocalLexicalLookups(true);
1843 // If we are a transparent context or inline namespace, insert into our
1844 // parent context, too. This operation is recursive.
1845 if (isTransparentContext() || isInlineNamespace())
1846 getParent()->getPrimaryContext()->
1847 makeDeclVisibleInContextWithFlags(D, Internal, Recoverable);
1849 auto *DCAsDecl = cast<Decl>(this);
1850 // Notify that a decl was made visible unless we are a Tag being defined.
1851 if (!(isa<TagDecl>(DCAsDecl) && cast<TagDecl>(DCAsDecl)->isBeingDefined()))
1852 if (ASTMutationListener *L = DCAsDecl->getASTMutationListener())
1853 L->AddedVisibleDecl(this, D);
1856 void DeclContext::makeDeclVisibleInContextImpl(NamedDecl *D, bool Internal) {
1857 // Find or create the stored declaration map.
1858 StoredDeclsMap *Map = LookupPtr;
1860 ASTContext *C = &getParentASTContext();
1861 Map = CreateStoredDeclsMap(*C);
1864 // If there is an external AST source, load any declarations it knows about
1865 // with this declaration's name.
1866 // If the lookup table contains an entry about this name it means that we
1867 // have already checked the external source.
1869 if (ExternalASTSource *Source = getParentASTContext().getExternalSource())
1870 if (hasExternalVisibleStorage() &&
1871 Map->find(D->getDeclName()) == Map->end())
1872 Source->FindExternalVisibleDeclsByName(this, D->getDeclName());
1874 // Insert this declaration into the map.
1875 StoredDeclsList &DeclNameEntries = (*Map)[D->getDeclName()];
1878 // If this is being added as part of loading an external declaration,
1879 // this may not be the only external declaration with this name.
1880 // In this case, we never try to replace an existing declaration; we'll
1881 // handle that when we finalize the list of declarations for this name.
1882 DeclNameEntries.setHasExternalDecls();
1883 DeclNameEntries.AddSubsequentDecl(D);
1887 if (DeclNameEntries.isNull()) {
1888 DeclNameEntries.setOnlyValue(D);
1892 if (DeclNameEntries.HandleRedeclaration(D, /*IsKnownNewer*/!Internal)) {
1893 // This declaration has replaced an existing one for which
1894 // declarationReplaces returns true.
1898 // Put this declaration into the appropriate slot.
1899 DeclNameEntries.AddSubsequentDecl(D);
1902 UsingDirectiveDecl *DeclContext::udir_iterator::operator*() const {
1903 return cast<UsingDirectiveDecl>(*I);
1906 /// Returns iterator range [First, Last) of UsingDirectiveDecls stored within
1908 DeclContext::udir_range DeclContext::using_directives() const {
1909 // FIXME: Use something more efficient than normal lookup for using
1910 // directives. In C++, using directives are looked up more than anything else.
1911 lookup_result Result = lookup(UsingDirectiveDecl::getName());
1912 return udir_range(Result.begin(), Result.end());
1915 //===----------------------------------------------------------------------===//
1916 // Creation and Destruction of StoredDeclsMaps. //
1917 //===----------------------------------------------------------------------===//
1919 StoredDeclsMap *DeclContext::CreateStoredDeclsMap(ASTContext &C) const {
1920 assert(!LookupPtr && "context already has a decls map");
1921 assert(getPrimaryContext() == this &&
1922 "creating decls map on non-primary context");
1925 bool Dependent = isDependentContext();
1927 M = new DependentStoredDeclsMap();
1929 M = new StoredDeclsMap();
1930 M->Previous = C.LastSDM;
1931 C.LastSDM = llvm::PointerIntPair<StoredDeclsMap*,1>(M, Dependent);
1936 void ASTContext::ReleaseDeclContextMaps() {
1937 // It's okay to delete DependentStoredDeclsMaps via a StoredDeclsMap
1938 // pointer because the subclass doesn't add anything that needs to
1940 StoredDeclsMap::DestroyAll(LastSDM.getPointer(), LastSDM.getInt());
1943 void StoredDeclsMap::DestroyAll(StoredDeclsMap *Map, bool Dependent) {
1945 // Advance the iteration before we invalidate memory.
1946 llvm::PointerIntPair<StoredDeclsMap*,1> Next = Map->Previous;
1949 delete static_cast<DependentStoredDeclsMap*>(Map);
1953 Map = Next.getPointer();
1954 Dependent = Next.getInt();
1958 DependentDiagnostic *DependentDiagnostic::Create(ASTContext &C,
1959 DeclContext *Parent,
1960 const PartialDiagnostic &PDiag) {
1961 assert(Parent->isDependentContext()
1962 && "cannot iterate dependent diagnostics of non-dependent context");
1963 Parent = Parent->getPrimaryContext();
1964 if (!Parent->LookupPtr)
1965 Parent->CreateStoredDeclsMap(C);
1967 auto *Map = static_cast<DependentStoredDeclsMap *>(Parent->LookupPtr);
1969 // Allocate the copy of the PartialDiagnostic via the ASTContext's
1970 // BumpPtrAllocator, rather than the ASTContext itself.
1971 PartialDiagnostic::Storage *DiagStorage = nullptr;
1972 if (PDiag.hasStorage())
1973 DiagStorage = new (C) PartialDiagnostic::Storage;
1975 auto *DD = new (C) DependentDiagnostic(PDiag, DiagStorage);
1977 // TODO: Maybe we shouldn't reverse the order during insertion.
1978 DD->NextDiagnostic = Map->FirstDiagnostic;
1979 Map->FirstDiagnostic = DD;