1 //===- DeclBase.h - Base Classes for representing declarations --*- C++ -*-===//
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 defines the Decl and DeclContext interfaces.
11 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_CLANG_AST_DECLBASE_H
14 #define LLVM_CLANG_AST_DECLBASE_H
16 #include "clang/AST/ASTDumperUtils.h"
17 #include "clang/AST/AttrIterator.h"
18 #include "clang/AST/DeclarationName.h"
19 #include "clang/Basic/IdentifierTable.h"
20 #include "clang/Basic/LLVM.h"
21 #include "clang/Basic/SourceLocation.h"
22 #include "clang/Basic/Specifiers.h"
23 #include "llvm/ADT/ArrayRef.h"
24 #include "llvm/ADT/PointerIntPair.h"
25 #include "llvm/ADT/PointerUnion.h"
26 #include "llvm/ADT/iterator.h"
27 #include "llvm/ADT/iterator_range.h"
28 #include "llvm/Support/Casting.h"
29 #include "llvm/Support/Compiler.h"
30 #include "llvm/Support/PrettyStackTrace.h"
31 #include "llvm/Support/VersionTuple.h"
37 #include <type_traits>
43 class ASTMutationListener;
47 class ExternalSourceSymbolAttr;
51 enum Linkage : unsigned char;
52 class LinkageSpecDecl;
55 class ObjCCategoryDecl;
56 class ObjCCategoryImplDecl;
57 class ObjCContainerDecl;
59 class ObjCImplementationDecl;
60 class ObjCInterfaceDecl;
62 class ObjCProtocolDecl;
63 struct PrintingPolicy;
69 class TranslationUnitDecl;
70 class UsingDirectiveDecl;
72 /// Captures the result of checking the availability of a
74 enum AvailabilityResult {
81 /// Decl - This represents one declaration (or definition), e.g. a variable,
82 /// typedef, function, struct, etc.
84 /// Note: There are objects tacked on before the *beginning* of Decl
85 /// (and its subclasses) in its Decl::operator new(). Proper alignment
86 /// of all subclasses (not requiring more than the alignment of Decl) is
87 /// asserted in DeclBase.cpp.
88 class alignas(8) Decl {
90 /// Lists the kind of concrete classes of Decl.
92 #define DECL(DERIVED, BASE) DERIVED,
93 #define ABSTRACT_DECL(DECL)
94 #define DECL_RANGE(BASE, START, END) \
95 first##BASE = START, last##BASE = END,
96 #define LAST_DECL_RANGE(BASE, START, END) \
97 first##BASE = START, last##BASE = END
98 #include "clang/AST/DeclNodes.inc"
101 /// A placeholder type used to construct an empty shell of a
102 /// decl-derived type that will be filled in later (e.g., by some
103 /// deserialization method).
104 struct EmptyShell {};
106 /// IdentifierNamespace - The different namespaces in which
107 /// declarations may appear. According to C99 6.2.3, there are
108 /// four namespaces, labels, tags, members and ordinary
109 /// identifiers. C++ describes lookup completely differently:
110 /// certain lookups merely "ignore" certain kinds of declarations,
111 /// usually based on whether the declaration is of a type, etc.
113 /// These are meant as bitmasks, so that searches in
114 /// C++ can look into the "tag" namespace during ordinary lookup.
116 /// Decl currently provides 15 bits of IDNS bits.
117 enum IdentifierNamespace {
118 /// Labels, declared with 'x:' and referenced with 'goto x'.
121 /// Tags, declared with 'struct foo;' and referenced with
122 /// 'struct foo'. All tags are also types. This is what
123 /// elaborated-type-specifiers look for in C.
124 /// This also contains names that conflict with tags in the
125 /// same scope but that are otherwise ordinary names (non-type
126 /// template parameters and indirect field declarations).
129 /// Types, declared with 'struct foo', typedefs, etc.
130 /// This is what elaborated-type-specifiers look for in C++,
131 /// but note that it's ill-formed to find a non-tag.
134 /// Members, declared with object declarations within tag
135 /// definitions. In C, these can only be found by "qualified"
136 /// lookup in member expressions. In C++, they're found by
138 IDNS_Member = 0x0008,
140 /// Namespaces, declared with 'namespace foo {}'.
141 /// Lookup for nested-name-specifiers find these.
142 IDNS_Namespace = 0x0010,
144 /// Ordinary names. In C, everything that's not a label, tag,
145 /// member, or function-local extern ends up here.
146 IDNS_Ordinary = 0x0020,
148 /// Objective C \@protocol.
149 IDNS_ObjCProtocol = 0x0040,
151 /// This declaration is a friend function. A friend function
152 /// declaration is always in this namespace but may also be in
153 /// IDNS_Ordinary if it was previously declared.
154 IDNS_OrdinaryFriend = 0x0080,
156 /// This declaration is a friend class. A friend class
157 /// declaration is always in this namespace but may also be in
158 /// IDNS_Tag|IDNS_Type if it was previously declared.
159 IDNS_TagFriend = 0x0100,
161 /// This declaration is a using declaration. A using declaration
162 /// *introduces* a number of other declarations into the current
163 /// scope, and those declarations use the IDNS of their targets,
164 /// but the actual using declarations go in this namespace.
167 /// This declaration is a C++ operator declared in a non-class
168 /// context. All such operators are also in IDNS_Ordinary.
169 /// C++ lexical operator lookup looks for these.
170 IDNS_NonMemberOperator = 0x0400,
172 /// This declaration is a function-local extern declaration of a
173 /// variable or function. This may also be IDNS_Ordinary if it
174 /// has been declared outside any function. These act mostly like
175 /// invisible friend declarations, but are also visible to unqualified
176 /// lookup within the scope of the declaring function.
177 IDNS_LocalExtern = 0x0800,
179 /// This declaration is an OpenMP user defined reduction construction.
180 IDNS_OMPReduction = 0x1000,
182 /// This declaration is an OpenMP user defined mapper.
183 IDNS_OMPMapper = 0x2000,
186 /// ObjCDeclQualifier - 'Qualifiers' written next to the return and
187 /// parameter types in method declarations. Other than remembering
188 /// them and mangling them into the method's signature string, these
189 /// are ignored by the compiler; they are consumed by certain
190 /// remote-messaging frameworks.
192 /// in, inout, and out are mutually exclusive and apply only to
193 /// method parameters. bycopy and byref are mutually exclusive and
194 /// apply only to method parameters (?). oneway applies only to
195 /// results. All of these expect their corresponding parameter to
196 /// have a particular type. None of this is currently enforced by
199 /// This should be kept in sync with ObjCDeclSpec::ObjCDeclQualifier.
200 enum ObjCDeclQualifier {
205 OBJC_TQ_Bycopy = 0x8,
206 OBJC_TQ_Byref = 0x10,
207 OBJC_TQ_Oneway = 0x20,
209 /// The nullability qualifier is set when the nullability of the
210 /// result or parameter was expressed via a context-sensitive
212 OBJC_TQ_CSNullability = 0x40
215 /// The kind of ownership a declaration has, for visibility purposes.
216 /// This enumeration is designed such that higher values represent higher
217 /// levels of name hiding.
218 enum class ModuleOwnershipKind : unsigned {
219 /// This declaration is not owned by a module.
222 /// This declaration has an owning module, but is globally visible
223 /// (typically because its owning module is visible and we know that
224 /// modules cannot later become hidden in this compilation).
225 /// After serialization and deserialization, this will be converted
226 /// to VisibleWhenImported.
229 /// This declaration has an owning module, and is visible when that
230 /// module is imported.
233 /// This declaration has an owning module, but is only visible to
234 /// lookups that occur within that module.
239 /// The next declaration within the same lexical
240 /// DeclContext. These pointers form the linked list that is
241 /// traversed via DeclContext's decls_begin()/decls_end().
243 /// The extra two bits are used for the ModuleOwnershipKind.
244 llvm::PointerIntPair<Decl *, 2, ModuleOwnershipKind> NextInContextAndBits;
247 friend class DeclContext;
250 DeclContext *SemanticDC;
251 DeclContext *LexicalDC;
254 /// DeclCtx - Holds either a DeclContext* or a MultipleDC*.
255 /// For declarations that don't contain C++ scope specifiers, it contains
256 /// the DeclContext where the Decl was declared.
257 /// For declarations with C++ scope specifiers, it contains a MultipleDC*
258 /// with the context where it semantically belongs (SemanticDC) and the
259 /// context where it was lexically declared (LexicalDC).
263 /// void f(); // SemanticDC == LexicalDC == 'namespace A'
265 /// void A::f(); // SemanticDC == namespace 'A'
266 /// // LexicalDC == global namespace
267 llvm::PointerUnion<DeclContext*, MultipleDC*> DeclCtx;
269 bool isInSemaDC() const { return DeclCtx.is<DeclContext*>(); }
270 bool isOutOfSemaDC() const { return DeclCtx.is<MultipleDC*>(); }
272 MultipleDC *getMultipleDC() const {
273 return DeclCtx.get<MultipleDC*>();
276 DeclContext *getSemanticDC() const {
277 return DeclCtx.get<DeclContext*>();
280 /// Loc - The location of this decl.
283 /// DeclKind - This indicates which class this is.
284 unsigned DeclKind : 7;
286 /// InvalidDecl - This indicates a semantic error occurred.
287 unsigned InvalidDecl : 1;
289 /// HasAttrs - This indicates whether the decl has attributes or not.
290 unsigned HasAttrs : 1;
292 /// Implicit - Whether this declaration was implicitly generated by
293 /// the implementation rather than explicitly written by the user.
294 unsigned Implicit : 1;
296 /// Whether this declaration was "used", meaning that a definition is
300 /// Whether this declaration was "referenced".
301 /// The difference with 'Used' is whether the reference appears in a
302 /// evaluated context or not, e.g. functions used in uninstantiated templates
303 /// are regarded as "referenced" but not "used".
304 unsigned Referenced : 1;
306 /// Whether this declaration is a top-level declaration (function,
307 /// global variable, etc.) that is lexically inside an objc container
309 unsigned TopLevelDeclInObjCContainer : 1;
311 /// Whether statistic collection is enabled.
312 static bool StatisticsEnabled;
315 friend class ASTDeclReader;
316 friend class ASTDeclWriter;
317 friend class ASTNodeImporter;
318 friend class ASTReader;
319 friend class CXXClassMemberWrapper;
320 friend class LinkageComputer;
321 template<typename decl_type> friend class Redeclarable;
323 /// Access - Used by C++ decls for the access specifier.
324 // NOTE: VC++ treats enums as signed, avoid using the AccessSpecifier enum
327 /// Whether this declaration was loaded from an AST file.
328 unsigned FromASTFile : 1;
330 /// IdentifierNamespace - This specifies what IDNS_* namespace this lives in.
331 unsigned IdentifierNamespace : 14;
333 /// If 0, we have not computed the linkage of this declaration.
334 /// Otherwise, it is the linkage + 1.
335 mutable unsigned CacheValidAndLinkage : 3;
337 /// Allocate memory for a deserialized declaration.
339 /// This routine must be used to allocate memory for any declaration that is
340 /// deserialized from a module file.
342 /// \param Size The size of the allocated object.
343 /// \param Ctx The context in which we will allocate memory.
344 /// \param ID The global ID of the deserialized declaration.
345 /// \param Extra The amount of extra space to allocate after the object.
346 void *operator new(std::size_t Size, const ASTContext &Ctx, unsigned ID,
347 std::size_t Extra = 0);
349 /// Allocate memory for a non-deserialized declaration.
350 void *operator new(std::size_t Size, const ASTContext &Ctx,
351 DeclContext *Parent, std::size_t Extra = 0);
354 bool AccessDeclContextSanity() const;
356 /// Get the module ownership kind to use for a local lexical child of \p DC,
357 /// which may be either a local or (rarely) an imported declaration.
358 static ModuleOwnershipKind getModuleOwnershipKindForChildOf(DeclContext *DC) {
360 auto *D = cast<Decl>(DC);
361 auto MOK = D->getModuleOwnershipKind();
362 if (MOK != ModuleOwnershipKind::Unowned &&
363 (!D->isFromASTFile() || D->hasLocalOwningModuleStorage()))
365 // If D is not local and we have no local module storage, then we don't
366 // need to track module ownership at all.
368 return ModuleOwnershipKind::Unowned;
373 Decl(const Decl&) = delete;
374 Decl(Decl &&) = delete;
375 Decl &operator=(const Decl&) = delete;
376 Decl &operator=(Decl&&) = delete;
379 Decl(Kind DK, DeclContext *DC, SourceLocation L)
380 : NextInContextAndBits(nullptr, getModuleOwnershipKindForChildOf(DC)),
381 DeclCtx(DC), Loc(L), DeclKind(DK), InvalidDecl(false), HasAttrs(false),
382 Implicit(false), Used(false), Referenced(false),
383 TopLevelDeclInObjCContainer(false), Access(AS_none), FromASTFile(0),
384 IdentifierNamespace(getIdentifierNamespaceForKind(DK)),
385 CacheValidAndLinkage(0) {
386 if (StatisticsEnabled) add(DK);
389 Decl(Kind DK, EmptyShell Empty)
390 : DeclKind(DK), InvalidDecl(false), HasAttrs(false), Implicit(false),
391 Used(false), Referenced(false), TopLevelDeclInObjCContainer(false),
392 Access(AS_none), FromASTFile(0),
393 IdentifierNamespace(getIdentifierNamespaceForKind(DK)),
394 CacheValidAndLinkage(0) {
395 if (StatisticsEnabled) add(DK);
400 /// Update a potentially out-of-date declaration.
401 void updateOutOfDate(IdentifierInfo &II) const;
403 Linkage getCachedLinkage() const {
404 return Linkage(CacheValidAndLinkage - 1);
407 void setCachedLinkage(Linkage L) const {
408 CacheValidAndLinkage = L + 1;
411 bool hasCachedLinkage() const {
412 return CacheValidAndLinkage;
416 /// Source range that this declaration covers.
417 virtual SourceRange getSourceRange() const LLVM_READONLY {
418 return SourceRange(getLocation(), getLocation());
421 SourceLocation getBeginLoc() const LLVM_READONLY {
422 return getSourceRange().getBegin();
425 SourceLocation getEndLoc() const LLVM_READONLY {
426 return getSourceRange().getEnd();
429 SourceLocation getLocation() const { return Loc; }
430 void setLocation(SourceLocation L) { Loc = L; }
432 Kind getKind() const { return static_cast<Kind>(DeclKind); }
433 const char *getDeclKindName() const;
435 Decl *getNextDeclInContext() { return NextInContextAndBits.getPointer(); }
436 const Decl *getNextDeclInContext() const {return NextInContextAndBits.getPointer();}
438 DeclContext *getDeclContext() {
440 return getSemanticDC();
441 return getMultipleDC()->SemanticDC;
443 const DeclContext *getDeclContext() const {
444 return const_cast<Decl*>(this)->getDeclContext();
447 /// Find the innermost non-closure ancestor of this declaration,
448 /// walking up through blocks, lambdas, etc. If that ancestor is
449 /// not a code context (!isFunctionOrMethod()), returns null.
451 /// A declaration may be its own non-closure context.
452 Decl *getNonClosureContext();
453 const Decl *getNonClosureContext() const {
454 return const_cast<Decl*>(this)->getNonClosureContext();
457 TranslationUnitDecl *getTranslationUnitDecl();
458 const TranslationUnitDecl *getTranslationUnitDecl() const {
459 return const_cast<Decl*>(this)->getTranslationUnitDecl();
462 bool isInAnonymousNamespace() const;
464 bool isInStdNamespace() const;
466 ASTContext &getASTContext() const LLVM_READONLY;
468 void setAccess(AccessSpecifier AS) {
470 assert(AccessDeclContextSanity());
473 AccessSpecifier getAccess() const {
474 assert(AccessDeclContextSanity());
475 return AccessSpecifier(Access);
478 /// Retrieve the access specifier for this declaration, even though
479 /// it may not yet have been properly set.
480 AccessSpecifier getAccessUnsafe() const {
481 return AccessSpecifier(Access);
484 bool hasAttrs() const { return HasAttrs; }
486 void setAttrs(const AttrVec& Attrs) {
487 return setAttrsImpl(Attrs, getASTContext());
490 AttrVec &getAttrs() {
491 return const_cast<AttrVec&>(const_cast<const Decl*>(this)->getAttrs());
494 const AttrVec &getAttrs() const;
496 void addAttr(Attr *A);
498 using attr_iterator = AttrVec::const_iterator;
499 using attr_range = llvm::iterator_range<attr_iterator>;
501 attr_range attrs() const {
502 return attr_range(attr_begin(), attr_end());
505 attr_iterator attr_begin() const {
506 return hasAttrs() ? getAttrs().begin() : nullptr;
508 attr_iterator attr_end() const {
509 return hasAttrs() ? getAttrs().end() : nullptr;
512 template <typename T>
514 if (!HasAttrs) return;
516 AttrVec &Vec = getAttrs();
517 Vec.erase(std::remove_if(Vec.begin(), Vec.end(), isa<T, Attr*>), Vec.end());
523 template <typename T>
524 llvm::iterator_range<specific_attr_iterator<T>> specific_attrs() const {
525 return llvm::make_range(specific_attr_begin<T>(), specific_attr_end<T>());
528 template <typename T>
529 specific_attr_iterator<T> specific_attr_begin() const {
530 return specific_attr_iterator<T>(attr_begin());
533 template <typename T>
534 specific_attr_iterator<T> specific_attr_end() const {
535 return specific_attr_iterator<T>(attr_end());
538 template<typename T> T *getAttr() const {
539 return hasAttrs() ? getSpecificAttr<T>(getAttrs()) : nullptr;
542 template<typename T> bool hasAttr() const {
543 return hasAttrs() && hasSpecificAttr<T>(getAttrs());
546 /// getMaxAlignment - return the maximum alignment specified by attributes
547 /// on this decl, 0 if there are none.
548 unsigned getMaxAlignment() const;
550 /// setInvalidDecl - Indicates the Decl had a semantic error. This
551 /// allows for graceful error recovery.
552 void setInvalidDecl(bool Invalid = true);
553 bool isInvalidDecl() const { return (bool) InvalidDecl; }
555 /// isImplicit - Indicates whether the declaration was implicitly
556 /// generated by the implementation. If false, this declaration
557 /// was written explicitly in the source code.
558 bool isImplicit() const { return Implicit; }
559 void setImplicit(bool I = true) { Implicit = I; }
561 /// Whether *any* (re-)declaration of the entity was used, meaning that
562 /// a definition is required.
564 /// \param CheckUsedAttr When true, also consider the "used" attribute
565 /// (in addition to the "used" bit set by \c setUsed()) when determining
566 /// whether the function is used.
567 bool isUsed(bool CheckUsedAttr = true) const;
569 /// Set whether the declaration is used, in the sense of odr-use.
571 /// This should only be used immediately after creating a declaration.
572 /// It intentionally doesn't notify any listeners.
573 void setIsUsed() { getCanonicalDecl()->Used = true; }
575 /// Mark the declaration used, in the sense of odr-use.
577 /// This notifies any mutation listeners in addition to setting a bit
578 /// indicating the declaration is used.
579 void markUsed(ASTContext &C);
581 /// Whether any declaration of this entity was referenced.
582 bool isReferenced() const;
584 /// Whether this declaration was referenced. This should not be relied
585 /// upon for anything other than debugging.
586 bool isThisDeclarationReferenced() const { return Referenced; }
588 void setReferenced(bool R = true) { Referenced = R; }
590 /// Whether this declaration is a top-level declaration (function,
591 /// global variable, etc.) that is lexically inside an objc container
593 bool isTopLevelDeclInObjCContainer() const {
594 return TopLevelDeclInObjCContainer;
597 void setTopLevelDeclInObjCContainer(bool V = true) {
598 TopLevelDeclInObjCContainer = V;
601 /// Looks on this and related declarations for an applicable
602 /// external source symbol attribute.
603 ExternalSourceSymbolAttr *getExternalSourceSymbolAttr() const;
605 /// Whether this declaration was marked as being private to the
606 /// module in which it was defined.
607 bool isModulePrivate() const {
608 return getModuleOwnershipKind() == ModuleOwnershipKind::ModulePrivate;
611 /// Return true if this declaration has an attribute which acts as
612 /// definition of the entity, such as 'alias' or 'ifunc'.
613 bool hasDefiningAttr() const;
615 /// Return this declaration's defining attribute if it has one.
616 const Attr *getDefiningAttr() const;
619 /// Specify that this declaration was marked as being private
620 /// to the module in which it was defined.
621 void setModulePrivate() {
622 // The module-private specifier has no effect on unowned declarations.
623 // FIXME: We should track this in some way for source fidelity.
624 if (getModuleOwnershipKind() == ModuleOwnershipKind::Unowned)
626 setModuleOwnershipKind(ModuleOwnershipKind::ModulePrivate);
629 /// Set the owning module ID.
630 void setOwningModuleID(unsigned ID) {
631 assert(isFromASTFile() && "Only works on a deserialized declaration");
632 *((unsigned*)this - 2) = ID;
636 /// Determine the availability of the given declaration.
638 /// This routine will determine the most restrictive availability of
639 /// the given declaration (e.g., preferring 'unavailable' to
642 /// \param Message If non-NULL and the result is not \c
643 /// AR_Available, will be set to a (possibly empty) message
644 /// describing why the declaration has not been introduced, is
645 /// deprecated, or is unavailable.
647 /// \param EnclosingVersion The version to compare with. If empty, assume the
648 /// deployment target version.
650 /// \param RealizedPlatform If non-NULL and the availability result is found
651 /// in an available attribute it will set to the platform which is written in
652 /// the available attribute.
654 getAvailability(std::string *Message = nullptr,
655 VersionTuple EnclosingVersion = VersionTuple(),
656 StringRef *RealizedPlatform = nullptr) const;
658 /// Retrieve the version of the target platform in which this
659 /// declaration was introduced.
661 /// \returns An empty version tuple if this declaration has no 'introduced'
662 /// availability attributes, or the version tuple that's specified in the
663 /// attribute otherwise.
664 VersionTuple getVersionIntroduced() const;
666 /// Determine whether this declaration is marked 'deprecated'.
668 /// \param Message If non-NULL and the declaration is deprecated,
669 /// this will be set to the message describing why the declaration
670 /// was deprecated (which may be empty).
671 bool isDeprecated(std::string *Message = nullptr) const {
672 return getAvailability(Message) == AR_Deprecated;
675 /// Determine whether this declaration is marked 'unavailable'.
677 /// \param Message If non-NULL and the declaration is unavailable,
678 /// this will be set to the message describing why the declaration
679 /// was made unavailable (which may be empty).
680 bool isUnavailable(std::string *Message = nullptr) const {
681 return getAvailability(Message) == AR_Unavailable;
684 /// Determine whether this is a weak-imported symbol.
686 /// Weak-imported symbols are typically marked with the
687 /// 'weak_import' attribute, but may also be marked with an
688 /// 'availability' attribute where we're targing a platform prior to
689 /// the introduction of this feature.
690 bool isWeakImported() const;
692 /// Determines whether this symbol can be weak-imported,
693 /// e.g., whether it would be well-formed to add the weak_import
696 /// \param IsDefinition Set to \c true to indicate that this
697 /// declaration cannot be weak-imported because it has a definition.
698 bool canBeWeakImported(bool &IsDefinition) const;
700 /// Determine whether this declaration came from an AST file (such as
701 /// a precompiled header or module) rather than having been parsed.
702 bool isFromASTFile() const { return FromASTFile; }
704 /// Retrieve the global declaration ID associated with this
705 /// declaration, which specifies where this Decl was loaded from.
706 unsigned getGlobalID() const {
708 return *((const unsigned*)this - 1);
712 /// Retrieve the global ID of the module that owns this particular
714 unsigned getOwningModuleID() const {
716 return *((const unsigned*)this - 2);
721 Module *getOwningModuleSlow() const;
724 bool hasLocalOwningModuleStorage() const;
727 /// Get the imported owning module, if this decl is from an imported
728 /// (non-local) module.
729 Module *getImportedOwningModule() const {
730 if (!isFromASTFile() || !hasOwningModule())
733 return getOwningModuleSlow();
736 /// Get the local owning module, if known. Returns nullptr if owner is
737 /// not yet known or declaration is not from a module.
738 Module *getLocalOwningModule() const {
739 if (isFromASTFile() || !hasOwningModule())
742 assert(hasLocalOwningModuleStorage() &&
743 "owned local decl but no local module storage");
744 return reinterpret_cast<Module *const *>(this)[-1];
746 void setLocalOwningModule(Module *M) {
747 assert(!isFromASTFile() && hasOwningModule() &&
748 hasLocalOwningModuleStorage() &&
749 "should not have a cached owning module");
750 reinterpret_cast<Module **>(this)[-1] = M;
753 /// Is this declaration owned by some module?
754 bool hasOwningModule() const {
755 return getModuleOwnershipKind() != ModuleOwnershipKind::Unowned;
758 /// Get the module that owns this declaration (for visibility purposes).
759 Module *getOwningModule() const {
760 return isFromASTFile() ? getImportedOwningModule() : getLocalOwningModule();
763 /// Get the module that owns this declaration for linkage purposes.
764 /// There only ever is such a module under the C++ Modules TS.
766 /// \param IgnoreLinkage Ignore the linkage of the entity; assume that
767 /// all declarations in a global module fragment are unowned.
768 Module *getOwningModuleForLinkage(bool IgnoreLinkage = false) const;
770 /// Determine whether this declaration might be hidden from name
771 /// lookup. Note that the declaration might be visible even if this returns
772 /// \c false, if the owning module is visible within the query context.
773 // FIXME: Rename this to make it clearer what it does.
774 bool isHidden() const {
775 return (int)getModuleOwnershipKind() > (int)ModuleOwnershipKind::Visible;
778 /// Set that this declaration is globally visible, even if it came from a
779 /// module that is not visible.
780 void setVisibleDespiteOwningModule() {
782 setModuleOwnershipKind(ModuleOwnershipKind::Visible);
785 /// Get the kind of module ownership for this declaration.
786 ModuleOwnershipKind getModuleOwnershipKind() const {
787 return NextInContextAndBits.getInt();
790 /// Set whether this declaration is hidden from name lookup.
791 void setModuleOwnershipKind(ModuleOwnershipKind MOK) {
792 assert(!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned &&
793 MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() &&
794 !hasLocalOwningModuleStorage()) &&
795 "no storage available for owning module for this declaration");
796 NextInContextAndBits.setInt(MOK);
799 unsigned getIdentifierNamespace() const {
800 return IdentifierNamespace;
803 bool isInIdentifierNamespace(unsigned NS) const {
804 return getIdentifierNamespace() & NS;
807 static unsigned getIdentifierNamespaceForKind(Kind DK);
809 bool hasTagIdentifierNamespace() const {
810 return isTagIdentifierNamespace(getIdentifierNamespace());
813 static bool isTagIdentifierNamespace(unsigned NS) {
814 // TagDecls have Tag and Type set and may also have TagFriend.
815 return (NS & ~IDNS_TagFriend) == (IDNS_Tag | IDNS_Type);
818 /// getLexicalDeclContext - The declaration context where this Decl was
819 /// lexically declared (LexicalDC). May be different from
820 /// getDeclContext() (SemanticDC).
824 /// void f(); // SemanticDC == LexicalDC == 'namespace A'
826 /// void A::f(); // SemanticDC == namespace 'A'
827 /// // LexicalDC == global namespace
828 DeclContext *getLexicalDeclContext() {
830 return getSemanticDC();
831 return getMultipleDC()->LexicalDC;
833 const DeclContext *getLexicalDeclContext() const {
834 return const_cast<Decl*>(this)->getLexicalDeclContext();
837 /// Determine whether this declaration is declared out of line (outside its
838 /// semantic context).
839 virtual bool isOutOfLine() const;
841 /// setDeclContext - Set both the semantic and lexical DeclContext
843 void setDeclContext(DeclContext *DC);
845 void setLexicalDeclContext(DeclContext *DC);
847 /// Determine whether this declaration is a templated entity (whether it is
848 // within the scope of a template parameter).
849 bool isTemplated() const;
851 /// isDefinedOutsideFunctionOrMethod - This predicate returns true if this
852 /// scoped decl is defined outside the current function or method. This is
853 /// roughly global variables and functions, but also handles enums (which
854 /// could be defined inside or outside a function etc).
855 bool isDefinedOutsideFunctionOrMethod() const {
856 return getParentFunctionOrMethod() == nullptr;
859 /// Returns true if this declaration lexically is inside a function.
860 /// It recognizes non-defining declarations as well as members of local
863 /// void foo() { void bar(); }
864 /// void foo2() { class ABC { void bar(); }; }
866 bool isLexicallyWithinFunctionOrMethod() const;
868 /// If this decl is defined inside a function/method/block it returns
869 /// the corresponding DeclContext, otherwise it returns null.
870 const DeclContext *getParentFunctionOrMethod() const;
871 DeclContext *getParentFunctionOrMethod() {
872 return const_cast<DeclContext*>(
873 const_cast<const Decl*>(this)->getParentFunctionOrMethod());
876 /// Retrieves the "canonical" declaration of the given declaration.
877 virtual Decl *getCanonicalDecl() { return this; }
878 const Decl *getCanonicalDecl() const {
879 return const_cast<Decl*>(this)->getCanonicalDecl();
882 /// Whether this particular Decl is a canonical one.
883 bool isCanonicalDecl() const { return getCanonicalDecl() == this; }
886 /// Returns the next redeclaration or itself if this is the only decl.
888 /// Decl subclasses that can be redeclared should override this method so that
889 /// Decl::redecl_iterator can iterate over them.
890 virtual Decl *getNextRedeclarationImpl() { return this; }
892 /// Implementation of getPreviousDecl(), to be overridden by any
893 /// subclass that has a redeclaration chain.
894 virtual Decl *getPreviousDeclImpl() { return nullptr; }
896 /// Implementation of getMostRecentDecl(), to be overridden by any
897 /// subclass that has a redeclaration chain.
898 virtual Decl *getMostRecentDeclImpl() { return this; }
901 /// Iterates through all the redeclarations of the same decl.
902 class redecl_iterator {
903 /// Current - The current declaration.
904 Decl *Current = nullptr;
908 using value_type = Decl *;
909 using reference = const value_type &;
910 using pointer = const value_type *;
911 using iterator_category = std::forward_iterator_tag;
912 using difference_type = std::ptrdiff_t;
914 redecl_iterator() = default;
915 explicit redecl_iterator(Decl *C) : Current(C), Starter(C) {}
917 reference operator*() const { return Current; }
918 value_type operator->() const { return Current; }
920 redecl_iterator& operator++() {
921 assert(Current && "Advancing while iterator has reached end");
922 // Get either previous decl or latest decl.
923 Decl *Next = Current->getNextRedeclarationImpl();
924 assert(Next && "Should return next redeclaration or itself, never null!");
925 Current = (Next != Starter) ? Next : nullptr;
929 redecl_iterator operator++(int) {
930 redecl_iterator tmp(*this);
935 friend bool operator==(redecl_iterator x, redecl_iterator y) {
936 return x.Current == y.Current;
939 friend bool operator!=(redecl_iterator x, redecl_iterator y) {
940 return x.Current != y.Current;
944 using redecl_range = llvm::iterator_range<redecl_iterator>;
946 /// Returns an iterator range for all the redeclarations of the same
947 /// decl. It will iterate at least once (when this decl is the only one).
948 redecl_range redecls() const {
949 return redecl_range(redecls_begin(), redecls_end());
952 redecl_iterator redecls_begin() const {
953 return redecl_iterator(const_cast<Decl *>(this));
956 redecl_iterator redecls_end() const { return redecl_iterator(); }
958 /// Retrieve the previous declaration that declares the same entity
959 /// as this declaration, or NULL if there is no previous declaration.
960 Decl *getPreviousDecl() { return getPreviousDeclImpl(); }
962 /// Retrieve the most recent declaration that declares the same entity
963 /// as this declaration, or NULL if there is no previous declaration.
964 const Decl *getPreviousDecl() const {
965 return const_cast<Decl *>(this)->getPreviousDeclImpl();
968 /// True if this is the first declaration in its redeclaration chain.
969 bool isFirstDecl() const {
970 return getPreviousDecl() == nullptr;
973 /// Retrieve the most recent declaration that declares the same entity
974 /// as this declaration (which may be this declaration).
975 Decl *getMostRecentDecl() { return getMostRecentDeclImpl(); }
977 /// Retrieve the most recent declaration that declares the same entity
978 /// as this declaration (which may be this declaration).
979 const Decl *getMostRecentDecl() const {
980 return const_cast<Decl *>(this)->getMostRecentDeclImpl();
983 /// getBody - If this Decl represents a declaration for a body of code,
984 /// such as a function or method definition, this method returns the
985 /// top-level Stmt* of that body. Otherwise this method returns null.
986 virtual Stmt* getBody() const { return nullptr; }
988 /// Returns true if this \c Decl represents a declaration for a body of
989 /// code, such as a function or method definition.
990 /// Note that \c hasBody can also return true if any redeclaration of this
991 /// \c Decl represents a declaration for a body of code.
992 virtual bool hasBody() const { return getBody() != nullptr; }
994 /// getBodyRBrace - Gets the right brace of the body, if a body exists.
995 /// This works whether the body is a CompoundStmt or a CXXTryStmt.
996 SourceLocation getBodyRBrace() const;
998 // global temp stats (until we have a per-module visitor)
999 static void add(Kind k);
1000 static void EnableStatistics();
1001 static void PrintStats();
1003 /// isTemplateParameter - Determines whether this declaration is a
1004 /// template parameter.
1005 bool isTemplateParameter() const;
1007 /// isTemplateParameter - Determines whether this declaration is a
1008 /// template parameter pack.
1009 bool isTemplateParameterPack() const;
1011 /// Whether this declaration is a parameter pack.
1012 bool isParameterPack() const;
1014 /// returns true if this declaration is a template
1015 bool isTemplateDecl() const;
1017 /// Whether this declaration is a function or function template.
1018 bool isFunctionOrFunctionTemplate() const {
1019 return (DeclKind >= Decl::firstFunction &&
1020 DeclKind <= Decl::lastFunction) ||
1021 DeclKind == FunctionTemplate;
1024 /// If this is a declaration that describes some template, this
1025 /// method returns that template declaration.
1026 TemplateDecl *getDescribedTemplate() const;
1028 /// Returns the function itself, or the templated function if this is a
1029 /// function template.
1030 FunctionDecl *getAsFunction() LLVM_READONLY;
1032 const FunctionDecl *getAsFunction() const {
1033 return const_cast<Decl *>(this)->getAsFunction();
1036 /// Changes the namespace of this declaration to reflect that it's
1037 /// a function-local extern declaration.
1039 /// These declarations appear in the lexical context of the extern
1040 /// declaration, but in the semantic context of the enclosing namespace
1042 void setLocalExternDecl() {
1043 Decl *Prev = getPreviousDecl();
1044 IdentifierNamespace &= ~IDNS_Ordinary;
1046 // It's OK for the declaration to still have the "invisible friend" flag or
1047 // the "conflicts with tag declarations in this scope" flag for the outer
1049 assert((IdentifierNamespace & ~(IDNS_OrdinaryFriend | IDNS_Tag)) == 0 &&
1050 "namespace is not ordinary");
1052 IdentifierNamespace |= IDNS_LocalExtern;
1053 if (Prev && Prev->getIdentifierNamespace() & IDNS_Ordinary)
1054 IdentifierNamespace |= IDNS_Ordinary;
1057 /// Determine whether this is a block-scope declaration with linkage.
1058 /// This will either be a local variable declaration declared 'extern', or a
1059 /// local function declaration.
1060 bool isLocalExternDecl() {
1061 return IdentifierNamespace & IDNS_LocalExtern;
1064 /// Changes the namespace of this declaration to reflect that it's
1065 /// the object of a friend declaration.
1067 /// These declarations appear in the lexical context of the friending
1068 /// class, but in the semantic context of the actual entity. This property
1069 /// applies only to a specific decl object; other redeclarations of the
1070 /// same entity may not (and probably don't) share this property.
1071 void setObjectOfFriendDecl(bool PerformFriendInjection = false) {
1072 unsigned OldNS = IdentifierNamespace;
1073 assert((OldNS & (IDNS_Tag | IDNS_Ordinary |
1074 IDNS_TagFriend | IDNS_OrdinaryFriend |
1075 IDNS_LocalExtern | IDNS_NonMemberOperator)) &&
1076 "namespace includes neither ordinary nor tag");
1077 assert(!(OldNS & ~(IDNS_Tag | IDNS_Ordinary | IDNS_Type |
1078 IDNS_TagFriend | IDNS_OrdinaryFriend |
1079 IDNS_LocalExtern | IDNS_NonMemberOperator)) &&
1080 "namespace includes other than ordinary or tag");
1082 Decl *Prev = getPreviousDecl();
1083 IdentifierNamespace &= ~(IDNS_Ordinary | IDNS_Tag | IDNS_Type);
1085 if (OldNS & (IDNS_Tag | IDNS_TagFriend)) {
1086 IdentifierNamespace |= IDNS_TagFriend;
1087 if (PerformFriendInjection ||
1088 (Prev && Prev->getIdentifierNamespace() & IDNS_Tag))
1089 IdentifierNamespace |= IDNS_Tag | IDNS_Type;
1092 if (OldNS & (IDNS_Ordinary | IDNS_OrdinaryFriend |
1093 IDNS_LocalExtern | IDNS_NonMemberOperator)) {
1094 IdentifierNamespace |= IDNS_OrdinaryFriend;
1095 if (PerformFriendInjection ||
1096 (Prev && Prev->getIdentifierNamespace() & IDNS_Ordinary))
1097 IdentifierNamespace |= IDNS_Ordinary;
1101 enum FriendObjectKind {
1102 FOK_None, ///< Not a friend object.
1103 FOK_Declared, ///< A friend of a previously-declared entity.
1104 FOK_Undeclared ///< A friend of a previously-undeclared entity.
1107 /// Determines whether this declaration is the object of a
1108 /// friend declaration and, if so, what kind.
1110 /// There is currently no direct way to find the associated FriendDecl.
1111 FriendObjectKind getFriendObjectKind() const {
1113 (IdentifierNamespace & (IDNS_TagFriend | IDNS_OrdinaryFriend));
1114 if (!mask) return FOK_None;
1115 return (IdentifierNamespace & (IDNS_Tag | IDNS_Ordinary) ? FOK_Declared
1119 /// Specifies that this declaration is a C++ overloaded non-member.
1120 void setNonMemberOperator() {
1121 assert(getKind() == Function || getKind() == FunctionTemplate);
1122 assert((IdentifierNamespace & IDNS_Ordinary) &&
1123 "visible non-member operators should be in ordinary namespace");
1124 IdentifierNamespace |= IDNS_NonMemberOperator;
1127 static bool classofKind(Kind K) { return true; }
1128 static DeclContext *castToDeclContext(const Decl *);
1129 static Decl *castFromDeclContext(const DeclContext *);
1131 void print(raw_ostream &Out, unsigned Indentation = 0,
1132 bool PrintInstantiation = false) const;
1133 void print(raw_ostream &Out, const PrintingPolicy &Policy,
1134 unsigned Indentation = 0, bool PrintInstantiation = false) const;
1135 static void printGroup(Decl** Begin, unsigned NumDecls,
1136 raw_ostream &Out, const PrintingPolicy &Policy,
1137 unsigned Indentation = 0);
1139 // Debuggers don't usually respect default arguments.
1142 // Same as dump(), but forces color printing.
1143 void dumpColor() const;
1145 void dump(raw_ostream &Out, bool Deserialize = false,
1146 ASTDumpOutputFormat OutputFormat = ADOF_Default) const;
1148 /// \return Unique reproducible object identifier
1149 int64_t getID() const;
1151 /// Looks through the Decl's underlying type to extract a FunctionType
1152 /// when possible. Will return null if the type underlying the Decl does not
1153 /// have a FunctionType.
1154 const FunctionType *getFunctionType(bool BlocksToo = true) const;
1157 void setAttrsImpl(const AttrVec& Attrs, ASTContext &Ctx);
1158 void setDeclContextsImpl(DeclContext *SemaDC, DeclContext *LexicalDC,
1162 ASTMutationListener *getASTMutationListener() const;
1165 /// Determine whether two declarations declare the same entity.
1166 inline bool declaresSameEntity(const Decl *D1, const Decl *D2) {
1173 return D1->getCanonicalDecl() == D2->getCanonicalDecl();
1176 /// PrettyStackTraceDecl - If a crash occurs, indicate that it happened when
1177 /// doing something to a specific decl.
1178 class PrettyStackTraceDecl : public llvm::PrettyStackTraceEntry {
1179 const Decl *TheDecl;
1182 const char *Message;
1185 PrettyStackTraceDecl(const Decl *theDecl, SourceLocation L,
1186 SourceManager &sm, const char *Msg)
1187 : TheDecl(theDecl), Loc(L), SM(sm), Message(Msg) {}
1189 void print(raw_ostream &OS) const override;
1192 /// The results of name lookup within a DeclContext. This is either a
1193 /// single result (with no stable storage) or a collection of results (with
1194 /// stable storage provided by the lookup table).
1195 class DeclContextLookupResult {
1196 using ResultTy = ArrayRef<NamedDecl *>;
1200 // If there is only one lookup result, it would be invalidated by
1201 // reallocations of the name table, so store it separately.
1202 NamedDecl *Single = nullptr;
1204 static NamedDecl *const SingleElementDummyList;
1207 DeclContextLookupResult() = default;
1208 DeclContextLookupResult(ArrayRef<NamedDecl *> Result)
1210 DeclContextLookupResult(NamedDecl *Single)
1211 : Result(SingleElementDummyList), Single(Single) {}
1215 using IteratorBase =
1216 llvm::iterator_adaptor_base<iterator, ResultTy::iterator,
1217 std::random_access_iterator_tag,
1220 class iterator : public IteratorBase {
1221 value_type SingleElement;
1224 explicit iterator(pointer Pos, value_type Single = nullptr)
1225 : IteratorBase(Pos), SingleElement(Single) {}
1227 reference operator*() const {
1228 return SingleElement ? SingleElement : IteratorBase::operator*();
1232 using const_iterator = iterator;
1233 using pointer = iterator::pointer;
1234 using reference = iterator::reference;
1236 iterator begin() const { return iterator(Result.begin(), Single); }
1237 iterator end() const { return iterator(Result.end(), Single); }
1239 bool empty() const { return Result.empty(); }
1240 pointer data() const { return Single ? &Single : Result.data(); }
1241 size_t size() const { return Single ? 1 : Result.size(); }
1242 reference front() const { return Single ? Single : Result.front(); }
1243 reference back() const { return Single ? Single : Result.back(); }
1244 reference operator[](size_t N) const { return Single ? Single : Result[N]; }
1246 // FIXME: Remove this from the interface
1247 DeclContextLookupResult slice(size_t N) const {
1248 DeclContextLookupResult Sliced = Result.slice(N);
1249 Sliced.Single = Single;
1254 /// DeclContext - This is used only as base class of specific decl types that
1255 /// can act as declaration contexts. These decls are (only the top classes
1256 /// that directly derive from DeclContext are mentioned, not their subclasses):
1258 /// TranslationUnitDecl
1262 /// OMPDeclareReductionDecl
1263 /// OMPDeclareMapperDecl
1266 /// ObjCContainerDecl
1272 /// For makeDeclVisibleInContextImpl
1273 friend class ASTDeclReader;
1274 /// For reconcileExternalVisibleStorage, CreateStoredDeclsMap,
1275 /// hasNeedToReconcileExternalVisibleStorage
1276 friend class ExternalASTSource;
1277 /// For CreateStoredDeclsMap
1278 friend class DependentDiagnostic;
1279 /// For hasNeedToReconcileExternalVisibleStorage,
1280 /// hasLazyLocalLexicalLookups, hasLazyExternalLexicalLookups
1281 friend class ASTWriter;
1283 // We use uint64_t in the bit-fields below since some bit-fields
1284 // cross the unsigned boundary and this breaks the packing.
1286 /// Stores the bits used by DeclContext.
1287 /// If modified NumDeclContextBit, the ctor of DeclContext and the accessor
1288 /// methods in DeclContext should be updated appropriately.
1289 class DeclContextBitfields {
1290 friend class DeclContext;
1291 /// DeclKind - This indicates which class this is.
1292 uint64_t DeclKind : 7;
1294 /// Whether this declaration context also has some external
1295 /// storage that contains additional declarations that are lexically
1296 /// part of this context.
1297 mutable uint64_t ExternalLexicalStorage : 1;
1299 /// Whether this declaration context also has some external
1300 /// storage that contains additional declarations that are visible
1301 /// in this context.
1302 mutable uint64_t ExternalVisibleStorage : 1;
1304 /// Whether this declaration context has had externally visible
1305 /// storage added since the last lookup. In this case, \c LookupPtr's
1306 /// invariant may not hold and needs to be fixed before we perform
1308 mutable uint64_t NeedToReconcileExternalVisibleStorage : 1;
1310 /// If \c true, this context may have local lexical declarations
1311 /// that are missing from the lookup table.
1312 mutable uint64_t HasLazyLocalLexicalLookups : 1;
1314 /// If \c true, the external source may have lexical declarations
1315 /// that are missing from the lookup table.
1316 mutable uint64_t HasLazyExternalLexicalLookups : 1;
1318 /// If \c true, lookups should only return identifier from
1319 /// DeclContext scope (for example TranslationUnit). Used in
1320 /// LookupQualifiedName()
1321 mutable uint64_t UseQualifiedLookup : 1;
1324 /// Number of bits in DeclContextBitfields.
1325 enum { NumDeclContextBits = 13 };
1327 /// Stores the bits used by TagDecl.
1328 /// If modified NumTagDeclBits and the accessor
1329 /// methods in TagDecl should be updated appropriately.
1330 class TagDeclBitfields {
1331 friend class TagDecl;
1332 /// For the bits in DeclContextBitfields
1333 uint64_t : NumDeclContextBits;
1335 /// The TagKind enum.
1336 uint64_t TagDeclKind : 3;
1338 /// True if this is a definition ("struct foo {};"), false if it is a
1339 /// declaration ("struct foo;"). It is not considered a definition
1340 /// until the definition has been fully processed.
1341 uint64_t IsCompleteDefinition : 1;
1343 /// True if this is currently being defined.
1344 uint64_t IsBeingDefined : 1;
1346 /// True if this tag declaration is "embedded" (i.e., defined or declared
1347 /// for the very first time) in the syntax of a declarator.
1348 uint64_t IsEmbeddedInDeclarator : 1;
1350 /// True if this tag is free standing, e.g. "struct foo;".
1351 uint64_t IsFreeStanding : 1;
1353 /// Indicates whether it is possible for declarations of this kind
1354 /// to have an out-of-date definition.
1356 /// This option is only enabled when modules are enabled.
1357 uint64_t MayHaveOutOfDateDef : 1;
1359 /// Has the full definition of this type been required by a use somewhere in
1361 uint64_t IsCompleteDefinitionRequired : 1;
1364 /// Number of non-inherited bits in TagDeclBitfields.
1365 enum { NumTagDeclBits = 9 };
1367 /// Stores the bits used by EnumDecl.
1368 /// If modified NumEnumDeclBit and the accessor
1369 /// methods in EnumDecl should be updated appropriately.
1370 class EnumDeclBitfields {
1371 friend class EnumDecl;
1372 /// For the bits in DeclContextBitfields.
1373 uint64_t : NumDeclContextBits;
1374 /// For the bits in TagDeclBitfields.
1375 uint64_t : NumTagDeclBits;
1377 /// Width in bits required to store all the non-negative
1378 /// enumerators of this enum.
1379 uint64_t NumPositiveBits : 8;
1381 /// Width in bits required to store all the negative
1382 /// enumerators of this enum.
1383 uint64_t NumNegativeBits : 8;
1385 /// True if this tag declaration is a scoped enumeration. Only
1386 /// possible in C++11 mode.
1387 uint64_t IsScoped : 1;
1389 /// If this tag declaration is a scoped enum,
1390 /// then this is true if the scoped enum was declared using the class
1391 /// tag, false if it was declared with the struct tag. No meaning is
1392 /// associated if this tag declaration is not a scoped enum.
1393 uint64_t IsScopedUsingClassTag : 1;
1395 /// True if this is an enumeration with fixed underlying type. Only
1396 /// possible in C++11, Microsoft extensions, or Objective C mode.
1397 uint64_t IsFixed : 1;
1399 /// True if a valid hash is stored in ODRHash.
1400 uint64_t HasODRHash : 1;
1403 /// Number of non-inherited bits in EnumDeclBitfields.
1404 enum { NumEnumDeclBits = 20 };
1406 /// Stores the bits used by RecordDecl.
1407 /// If modified NumRecordDeclBits and the accessor
1408 /// methods in RecordDecl should be updated appropriately.
1409 class RecordDeclBitfields {
1410 friend class RecordDecl;
1411 /// For the bits in DeclContextBitfields.
1412 uint64_t : NumDeclContextBits;
1413 /// For the bits in TagDeclBitfields.
1414 uint64_t : NumTagDeclBits;
1416 /// This is true if this struct ends with a flexible
1417 /// array member (e.g. int X[]) or if this union contains a struct that does.
1418 /// If so, this cannot be contained in arrays or other structs as a member.
1419 uint64_t HasFlexibleArrayMember : 1;
1421 /// Whether this is the type of an anonymous struct or union.
1422 uint64_t AnonymousStructOrUnion : 1;
1424 /// This is true if this struct has at least one member
1425 /// containing an Objective-C object pointer type.
1426 uint64_t HasObjectMember : 1;
1428 /// This is true if struct has at least one member of
1429 /// 'volatile' type.
1430 uint64_t HasVolatileMember : 1;
1432 /// Whether the field declarations of this record have been loaded
1433 /// from external storage. To avoid unnecessary deserialization of
1434 /// methods/nested types we allow deserialization of just the fields
1436 mutable uint64_t LoadedFieldsFromExternalStorage : 1;
1438 /// Basic properties of non-trivial C structs.
1439 uint64_t NonTrivialToPrimitiveDefaultInitialize : 1;
1440 uint64_t NonTrivialToPrimitiveCopy : 1;
1441 uint64_t NonTrivialToPrimitiveDestroy : 1;
1443 /// The following bits indicate whether this is or contains a C union that
1444 /// is non-trivial to default-initialize, destruct, or copy. These bits
1445 /// imply the associated basic non-triviality predicates declared above.
1446 uint64_t HasNonTrivialToPrimitiveDefaultInitializeCUnion : 1;
1447 uint64_t HasNonTrivialToPrimitiveDestructCUnion : 1;
1448 uint64_t HasNonTrivialToPrimitiveCopyCUnion : 1;
1450 /// Indicates whether this struct is destroyed in the callee.
1451 uint64_t ParamDestroyedInCallee : 1;
1453 /// Represents the way this type is passed to a function.
1454 uint64_t ArgPassingRestrictions : 2;
1457 /// Number of non-inherited bits in RecordDeclBitfields.
1458 enum { NumRecordDeclBits = 14 };
1460 /// Stores the bits used by OMPDeclareReductionDecl.
1461 /// If modified NumOMPDeclareReductionDeclBits and the accessor
1462 /// methods in OMPDeclareReductionDecl should be updated appropriately.
1463 class OMPDeclareReductionDeclBitfields {
1464 friend class OMPDeclareReductionDecl;
1465 /// For the bits in DeclContextBitfields
1466 uint64_t : NumDeclContextBits;
1468 /// Kind of initializer,
1469 /// function call or omp_priv<init_expr> initializtion.
1470 uint64_t InitializerKind : 2;
1473 /// Number of non-inherited bits in OMPDeclareReductionDeclBitfields.
1474 enum { NumOMPDeclareReductionDeclBits = 2 };
1476 /// Stores the bits used by FunctionDecl.
1477 /// If modified NumFunctionDeclBits and the accessor
1478 /// methods in FunctionDecl and CXXDeductionGuideDecl
1479 /// (for IsCopyDeductionCandidate) should be updated appropriately.
1480 class FunctionDeclBitfields {
1481 friend class FunctionDecl;
1482 /// For IsCopyDeductionCandidate
1483 friend class CXXDeductionGuideDecl;
1484 /// For the bits in DeclContextBitfields.
1485 uint64_t : NumDeclContextBits;
1487 uint64_t SClass : 3;
1488 uint64_t IsInline : 1;
1489 uint64_t IsInlineSpecified : 1;
1491 uint64_t IsVirtualAsWritten : 1;
1492 uint64_t IsPure : 1;
1493 uint64_t HasInheritedPrototype : 1;
1494 uint64_t HasWrittenPrototype : 1;
1495 uint64_t IsDeleted : 1;
1496 /// Used by CXXMethodDecl
1497 uint64_t IsTrivial : 1;
1499 /// This flag indicates whether this function is trivial for the purpose of
1500 /// calls. This is meaningful only when this function is a copy/move
1501 /// constructor or a destructor.
1502 uint64_t IsTrivialForCall : 1;
1504 /// Used by CXXMethodDecl
1505 uint64_t IsDefaulted : 1;
1506 /// Used by CXXMethodDecl
1507 uint64_t IsExplicitlyDefaulted : 1;
1508 uint64_t HasImplicitReturnZero : 1;
1509 uint64_t IsLateTemplateParsed : 1;
1511 /// Kind of contexpr specifier as defined by ConstexprSpecKind.
1512 uint64_t ConstexprKind : 2;
1513 uint64_t InstantiationIsPending : 1;
1515 /// Indicates if the function uses __try.
1516 uint64_t UsesSEHTry : 1;
1518 /// Indicates if the function was a definition
1519 /// but its body was skipped.
1520 uint64_t HasSkippedBody : 1;
1522 /// Indicates if the function declaration will
1523 /// have a body, once we're done parsing it.
1524 uint64_t WillHaveBody : 1;
1526 /// Indicates that this function is a multiversioned
1527 /// function using attribute 'target'.
1528 uint64_t IsMultiVersion : 1;
1530 /// [C++17] Only used by CXXDeductionGuideDecl. Indicates that
1531 /// the Deduction Guide is the implicitly generated 'copy
1532 /// deduction candidate' (is used during overload resolution).
1533 uint64_t IsCopyDeductionCandidate : 1;
1535 /// Store the ODRHash after first calculation.
1536 uint64_t HasODRHash : 1;
1539 /// Number of non-inherited bits in FunctionDeclBitfields.
1540 enum { NumFunctionDeclBits = 25 };
1542 /// Stores the bits used by CXXConstructorDecl. If modified
1543 /// NumCXXConstructorDeclBits and the accessor
1544 /// methods in CXXConstructorDecl should be updated appropriately.
1545 class CXXConstructorDeclBitfields {
1546 friend class CXXConstructorDecl;
1547 /// For the bits in DeclContextBitfields.
1548 uint64_t : NumDeclContextBits;
1549 /// For the bits in FunctionDeclBitfields.
1550 uint64_t : NumFunctionDeclBits;
1552 /// 24 bits to fit in the remaining available space.
1553 /// Note that this makes CXXConstructorDeclBitfields take
1554 /// exactly 64 bits and thus the width of NumCtorInitializers
1555 /// will need to be shrunk if some bit is added to NumDeclContextBitfields,
1556 /// NumFunctionDeclBitfields or CXXConstructorDeclBitfields.
1557 uint64_t NumCtorInitializers : 23;
1558 uint64_t IsInheritingConstructor : 1;
1560 /// Whether this constructor has a trail-allocated explicit specifier.
1561 uint64_t HasTrailingExplicitSpecifier : 1;
1562 /// If this constructor does't have a trail-allocated explicit specifier.
1563 /// Whether this constructor is explicit specified.
1564 uint64_t IsSimpleExplicit : 1;
1567 /// Number of non-inherited bits in CXXConstructorDeclBitfields.
1569 NumCXXConstructorDeclBits = 64 - NumDeclContextBits - NumFunctionDeclBits
1572 /// Stores the bits used by ObjCMethodDecl.
1573 /// If modified NumObjCMethodDeclBits and the accessor
1574 /// methods in ObjCMethodDecl should be updated appropriately.
1575 class ObjCMethodDeclBitfields {
1576 friend class ObjCMethodDecl;
1578 /// For the bits in DeclContextBitfields.
1579 uint64_t : NumDeclContextBits;
1581 /// The conventional meaning of this method; an ObjCMethodFamily.
1582 /// This is not serialized; instead, it is computed on demand and
1584 mutable uint64_t Family : ObjCMethodFamilyBitWidth;
1586 /// instance (true) or class (false) method.
1587 uint64_t IsInstance : 1;
1588 uint64_t IsVariadic : 1;
1590 /// True if this method is the getter or setter for an explicit property.
1591 uint64_t IsPropertyAccessor : 1;
1593 /// Method has a definition.
1594 uint64_t IsDefined : 1;
1596 /// Method redeclaration in the same interface.
1597 uint64_t IsRedeclaration : 1;
1599 /// Is redeclared in the same interface.
1600 mutable uint64_t HasRedeclaration : 1;
1602 /// \@required/\@optional
1603 uint64_t DeclImplementation : 2;
1606 uint64_t objcDeclQualifier : 7;
1608 /// Indicates whether this method has a related result type.
1609 uint64_t RelatedResultType : 1;
1611 /// Whether the locations of the selector identifiers are in a
1612 /// "standard" position, a enum SelectorLocationsKind.
1613 uint64_t SelLocsKind : 2;
1615 /// Whether this method overrides any other in the class hierarchy.
1617 /// A method is said to override any method in the class's
1618 /// base classes, its protocols, or its categories' protocols, that has
1619 /// the same selector and is of the same kind (class or instance).
1620 /// A method in an implementation is not considered as overriding the same
1621 /// method in the interface or its categories.
1622 uint64_t IsOverriding : 1;
1624 /// Indicates if the method was a definition but its body was skipped.
1625 uint64_t HasSkippedBody : 1;
1628 /// Number of non-inherited bits in ObjCMethodDeclBitfields.
1629 enum { NumObjCMethodDeclBits = 24 };
1631 /// Stores the bits used by ObjCContainerDecl.
1632 /// If modified NumObjCContainerDeclBits and the accessor
1633 /// methods in ObjCContainerDecl should be updated appropriately.
1634 class ObjCContainerDeclBitfields {
1635 friend class ObjCContainerDecl;
1636 /// For the bits in DeclContextBitfields
1637 uint32_t : NumDeclContextBits;
1639 // Not a bitfield but this saves space.
1640 // Note that ObjCContainerDeclBitfields is full.
1641 SourceLocation AtStart;
1644 /// Number of non-inherited bits in ObjCContainerDeclBitfields.
1645 /// Note that here we rely on the fact that SourceLocation is 32 bits
1646 /// wide. We check this with the static_assert in the ctor of DeclContext.
1647 enum { NumObjCContainerDeclBits = 64 - NumDeclContextBits };
1649 /// Stores the bits used by LinkageSpecDecl.
1650 /// If modified NumLinkageSpecDeclBits and the accessor
1651 /// methods in LinkageSpecDecl should be updated appropriately.
1652 class LinkageSpecDeclBitfields {
1653 friend class LinkageSpecDecl;
1654 /// For the bits in DeclContextBitfields.
1655 uint64_t : NumDeclContextBits;
1657 /// The language for this linkage specification with values
1658 /// in the enum LinkageSpecDecl::LanguageIDs.
1659 uint64_t Language : 3;
1661 /// True if this linkage spec has braces.
1662 /// This is needed so that hasBraces() returns the correct result while the
1663 /// linkage spec body is being parsed. Once RBraceLoc has been set this is
1664 /// not used, so it doesn't need to be serialized.
1665 uint64_t HasBraces : 1;
1668 /// Number of non-inherited bits in LinkageSpecDeclBitfields.
1669 enum { NumLinkageSpecDeclBits = 4 };
1671 /// Stores the bits used by BlockDecl.
1672 /// If modified NumBlockDeclBits and the accessor
1673 /// methods in BlockDecl should be updated appropriately.
1674 class BlockDeclBitfields {
1675 friend class BlockDecl;
1676 /// For the bits in DeclContextBitfields.
1677 uint64_t : NumDeclContextBits;
1679 uint64_t IsVariadic : 1;
1680 uint64_t CapturesCXXThis : 1;
1681 uint64_t BlockMissingReturnType : 1;
1682 uint64_t IsConversionFromLambda : 1;
1684 /// A bit that indicates this block is passed directly to a function as a
1685 /// non-escaping parameter.
1686 uint64_t DoesNotEscape : 1;
1688 /// A bit that indicates whether it's possible to avoid coying this block to
1689 /// the heap when it initializes or is assigned to a local variable with
1690 /// automatic storage.
1691 uint64_t CanAvoidCopyToHeap : 1;
1694 /// Number of non-inherited bits in BlockDeclBitfields.
1695 enum { NumBlockDeclBits = 5 };
1697 /// Pointer to the data structure used to lookup declarations
1698 /// within this context (or a DependentStoredDeclsMap if this is a
1699 /// dependent context). We maintain the invariant that, if the map
1700 /// contains an entry for a DeclarationName (and we haven't lazily
1701 /// omitted anything), then it contains all relevant entries for that
1702 /// name (modulo the hasExternalDecls() flag).
1703 mutable StoredDeclsMap *LookupPtr = nullptr;
1706 /// This anonymous union stores the bits belonging to DeclContext and classes
1707 /// deriving from it. The goal is to use otherwise wasted
1708 /// space in DeclContext to store data belonging to derived classes.
1709 /// The space saved is especially significient when pointers are aligned
1710 /// to 8 bytes. In this case due to alignment requirements we have a
1711 /// little less than 8 bytes free in DeclContext which we can use.
1712 /// We check that none of the classes in this union is larger than
1713 /// 8 bytes with static_asserts in the ctor of DeclContext.
1715 DeclContextBitfields DeclContextBits;
1716 TagDeclBitfields TagDeclBits;
1717 EnumDeclBitfields EnumDeclBits;
1718 RecordDeclBitfields RecordDeclBits;
1719 OMPDeclareReductionDeclBitfields OMPDeclareReductionDeclBits;
1720 FunctionDeclBitfields FunctionDeclBits;
1721 CXXConstructorDeclBitfields CXXConstructorDeclBits;
1722 ObjCMethodDeclBitfields ObjCMethodDeclBits;
1723 ObjCContainerDeclBitfields ObjCContainerDeclBits;
1724 LinkageSpecDeclBitfields LinkageSpecDeclBits;
1725 BlockDeclBitfields BlockDeclBits;
1728 static_assert(sizeof(DeclContextBitfields) <= 8,
1729 "DeclContextBitfields is larger than 8 bytes!");
1730 static_assert(sizeof(TagDeclBitfields) <= 8,
1731 "TagDeclBitfields is larger than 8 bytes!");
1732 static_assert(sizeof(EnumDeclBitfields) <= 8,
1733 "EnumDeclBitfields is larger than 8 bytes!");
1734 static_assert(sizeof(RecordDeclBitfields) <= 8,
1735 "RecordDeclBitfields is larger than 8 bytes!");
1736 static_assert(sizeof(OMPDeclareReductionDeclBitfields) <= 8,
1737 "OMPDeclareReductionDeclBitfields is larger than 8 bytes!");
1738 static_assert(sizeof(FunctionDeclBitfields) <= 8,
1739 "FunctionDeclBitfields is larger than 8 bytes!");
1740 static_assert(sizeof(CXXConstructorDeclBitfields) <= 8,
1741 "CXXConstructorDeclBitfields is larger than 8 bytes!");
1742 static_assert(sizeof(ObjCMethodDeclBitfields) <= 8,
1743 "ObjCMethodDeclBitfields is larger than 8 bytes!");
1744 static_assert(sizeof(ObjCContainerDeclBitfields) <= 8,
1745 "ObjCContainerDeclBitfields is larger than 8 bytes!");
1746 static_assert(sizeof(LinkageSpecDeclBitfields) <= 8,
1747 "LinkageSpecDeclBitfields is larger than 8 bytes!");
1748 static_assert(sizeof(BlockDeclBitfields) <= 8,
1749 "BlockDeclBitfields is larger than 8 bytes!");
1751 /// FirstDecl - The first declaration stored within this declaration
1753 mutable Decl *FirstDecl = nullptr;
1755 /// LastDecl - The last declaration stored within this declaration
1756 /// context. FIXME: We could probably cache this value somewhere
1757 /// outside of the DeclContext, to reduce the size of DeclContext by
1758 /// another pointer.
1759 mutable Decl *LastDecl = nullptr;
1761 /// Build up a chain of declarations.
1763 /// \returns the first/last pair of declarations.
1764 static std::pair<Decl *, Decl *>
1765 BuildDeclChain(ArrayRef<Decl*> Decls, bool FieldsAlreadyLoaded);
1767 DeclContext(Decl::Kind K);
1772 Decl::Kind getDeclKind() const {
1773 return static_cast<Decl::Kind>(DeclContextBits.DeclKind);
1776 const char *getDeclKindName() const;
1778 /// getParent - Returns the containing DeclContext.
1779 DeclContext *getParent() {
1780 return cast<Decl>(this)->getDeclContext();
1782 const DeclContext *getParent() const {
1783 return const_cast<DeclContext*>(this)->getParent();
1786 /// getLexicalParent - Returns the containing lexical DeclContext. May be
1787 /// different from getParent, e.g.:
1792 /// struct A::S {}; // getParent() == namespace 'A'
1793 /// // getLexicalParent() == translation unit
1795 DeclContext *getLexicalParent() {
1796 return cast<Decl>(this)->getLexicalDeclContext();
1798 const DeclContext *getLexicalParent() const {
1799 return const_cast<DeclContext*>(this)->getLexicalParent();
1802 DeclContext *getLookupParent();
1804 const DeclContext *getLookupParent() const {
1805 return const_cast<DeclContext*>(this)->getLookupParent();
1808 ASTContext &getParentASTContext() const {
1809 return cast<Decl>(this)->getASTContext();
1812 bool isClosure() const { return getDeclKind() == Decl::Block; }
1814 /// Return this DeclContext if it is a BlockDecl. Otherwise, return the
1815 /// innermost enclosing BlockDecl or null if there are no enclosing blocks.
1816 const BlockDecl *getInnermostBlockDecl() const;
1818 bool isObjCContainer() const {
1819 switch (getDeclKind()) {
1820 case Decl::ObjCCategory:
1821 case Decl::ObjCCategoryImpl:
1822 case Decl::ObjCImplementation:
1823 case Decl::ObjCInterface:
1824 case Decl::ObjCProtocol:
1831 bool isFunctionOrMethod() const {
1832 switch (getDeclKind()) {
1834 case Decl::Captured:
1835 case Decl::ObjCMethod:
1838 return getDeclKind() >= Decl::firstFunction &&
1839 getDeclKind() <= Decl::lastFunction;
1843 /// Test whether the context supports looking up names.
1844 bool isLookupContext() const {
1845 return !isFunctionOrMethod() && getDeclKind() != Decl::LinkageSpec &&
1846 getDeclKind() != Decl::Export;
1849 bool isFileContext() const {
1850 return getDeclKind() == Decl::TranslationUnit ||
1851 getDeclKind() == Decl::Namespace;
1854 bool isTranslationUnit() const {
1855 return getDeclKind() == Decl::TranslationUnit;
1858 bool isRecord() const {
1859 return getDeclKind() >= Decl::firstRecord &&
1860 getDeclKind() <= Decl::lastRecord;
1863 bool isNamespace() const { return getDeclKind() == Decl::Namespace; }
1865 bool isStdNamespace() const;
1867 bool isInlineNamespace() const;
1869 /// Determines whether this context is dependent on a
1870 /// template parameter.
1871 bool isDependentContext() const;
1873 /// isTransparentContext - Determines whether this context is a
1874 /// "transparent" context, meaning that the members declared in this
1875 /// context are semantically declared in the nearest enclosing
1876 /// non-transparent (opaque) context but are lexically declared in
1877 /// this context. For example, consider the enumerators of an
1878 /// enumeration type:
1884 /// Here, E is a transparent context, so its enumerator (Val1) will
1885 /// appear (semantically) that it is in the same context of E.
1886 /// Examples of transparent contexts include: enumerations (except for
1887 /// C++0x scoped enums), and C++ linkage specifications.
1888 bool isTransparentContext() const;
1890 /// Determines whether this context or some of its ancestors is a
1891 /// linkage specification context that specifies C linkage.
1892 bool isExternCContext() const;
1894 /// Retrieve the nearest enclosing C linkage specification context.
1895 const LinkageSpecDecl *getExternCContext() const;
1897 /// Determines whether this context or some of its ancestors is a
1898 /// linkage specification context that specifies C++ linkage.
1899 bool isExternCXXContext() const;
1901 /// Determine whether this declaration context is equivalent
1902 /// to the declaration context DC.
1903 bool Equals(const DeclContext *DC) const {
1904 return DC && this->getPrimaryContext() == DC->getPrimaryContext();
1907 /// Determine whether this declaration context encloses the
1908 /// declaration context DC.
1909 bool Encloses(const DeclContext *DC) const;
1911 /// Find the nearest non-closure ancestor of this context,
1912 /// i.e. the innermost semantic parent of this context which is not
1913 /// a closure. A context may be its own non-closure ancestor.
1914 Decl *getNonClosureAncestor();
1915 const Decl *getNonClosureAncestor() const {
1916 return const_cast<DeclContext*>(this)->getNonClosureAncestor();
1919 /// getPrimaryContext - There may be many different
1920 /// declarations of the same entity (including forward declarations
1921 /// of classes, multiple definitions of namespaces, etc.), each with
1922 /// a different set of declarations. This routine returns the
1923 /// "primary" DeclContext structure, which will contain the
1924 /// information needed to perform name lookup into this context.
1925 DeclContext *getPrimaryContext();
1926 const DeclContext *getPrimaryContext() const {
1927 return const_cast<DeclContext*>(this)->getPrimaryContext();
1930 /// getRedeclContext - Retrieve the context in which an entity conflicts with
1931 /// other entities of the same name, or where it is a redeclaration if the
1932 /// two entities are compatible. This skips through transparent contexts.
1933 DeclContext *getRedeclContext();
1934 const DeclContext *getRedeclContext() const {
1935 return const_cast<DeclContext *>(this)->getRedeclContext();
1938 /// Retrieve the nearest enclosing namespace context.
1939 DeclContext *getEnclosingNamespaceContext();
1940 const DeclContext *getEnclosingNamespaceContext() const {
1941 return const_cast<DeclContext *>(this)->getEnclosingNamespaceContext();
1944 /// Retrieve the outermost lexically enclosing record context.
1945 RecordDecl *getOuterLexicalRecordContext();
1946 const RecordDecl *getOuterLexicalRecordContext() const {
1947 return const_cast<DeclContext *>(this)->getOuterLexicalRecordContext();
1950 /// Test if this context is part of the enclosing namespace set of
1951 /// the context NS, as defined in C++0x [namespace.def]p9. If either context
1952 /// isn't a namespace, this is equivalent to Equals().
1954 /// The enclosing namespace set of a namespace is the namespace and, if it is
1955 /// inline, its enclosing namespace, recursively.
1956 bool InEnclosingNamespaceSetOf(const DeclContext *NS) const;
1958 /// Collects all of the declaration contexts that are semantically
1959 /// connected to this declaration context.
1961 /// For declaration contexts that have multiple semantically connected but
1962 /// syntactically distinct contexts, such as C++ namespaces, this routine
1963 /// retrieves the complete set of such declaration contexts in source order.
1964 /// For example, given:
1975 /// The \c Contexts parameter will contain both definitions of N.
1977 /// \param Contexts Will be cleared and set to the set of declaration
1978 /// contexts that are semanticaly connected to this declaration context,
1979 /// in source order, including this context (which may be the only result,
1980 /// for non-namespace contexts).
1981 void collectAllContexts(SmallVectorImpl<DeclContext *> &Contexts);
1983 /// decl_iterator - Iterates through the declarations stored
1984 /// within this context.
1985 class decl_iterator {
1986 /// Current - The current declaration.
1987 Decl *Current = nullptr;
1990 using value_type = Decl *;
1991 using reference = const value_type &;
1992 using pointer = const value_type *;
1993 using iterator_category = std::forward_iterator_tag;
1994 using difference_type = std::ptrdiff_t;
1996 decl_iterator() = default;
1997 explicit decl_iterator(Decl *C) : Current(C) {}
1999 reference operator*() const { return Current; }
2001 // This doesn't meet the iterator requirements, but it's convenient
2002 value_type operator->() const { return Current; }
2004 decl_iterator& operator++() {
2005 Current = Current->getNextDeclInContext();
2009 decl_iterator operator++(int) {
2010 decl_iterator tmp(*this);
2015 friend bool operator==(decl_iterator x, decl_iterator y) {
2016 return x.Current == y.Current;
2019 friend bool operator!=(decl_iterator x, decl_iterator y) {
2020 return x.Current != y.Current;
2024 using decl_range = llvm::iterator_range<decl_iterator>;
2026 /// decls_begin/decls_end - Iterate over the declarations stored in
2028 decl_range decls() const { return decl_range(decls_begin(), decls_end()); }
2029 decl_iterator decls_begin() const;
2030 decl_iterator decls_end() const { return decl_iterator(); }
2031 bool decls_empty() const;
2033 /// noload_decls_begin/end - Iterate over the declarations stored in this
2034 /// context that are currently loaded; don't attempt to retrieve anything
2035 /// from an external source.
2036 decl_range noload_decls() const {
2037 return decl_range(noload_decls_begin(), noload_decls_end());
2039 decl_iterator noload_decls_begin() const { return decl_iterator(FirstDecl); }
2040 decl_iterator noload_decls_end() const { return decl_iterator(); }
2042 /// specific_decl_iterator - Iterates over a subrange of
2043 /// declarations stored in a DeclContext, providing only those that
2044 /// are of type SpecificDecl (or a class derived from it). This
2045 /// iterator is used, for example, to provide iteration over just
2046 /// the fields within a RecordDecl (with SpecificDecl = FieldDecl).
2047 template<typename SpecificDecl>
2048 class specific_decl_iterator {
2049 /// Current - The current, underlying declaration iterator, which
2050 /// will either be NULL or will point to a declaration of
2051 /// type SpecificDecl.
2052 DeclContext::decl_iterator Current;
2054 /// SkipToNextDecl - Advances the current position up to the next
2055 /// declaration of type SpecificDecl that also meets the criteria
2056 /// required by Acceptable.
2057 void SkipToNextDecl() {
2058 while (*Current && !isa<SpecificDecl>(*Current))
2063 using value_type = SpecificDecl *;
2064 // TODO: Add reference and pointer types (with some appropriate proxy type)
2065 // if we ever have a need for them.
2066 using reference = void;
2067 using pointer = void;
2068 using difference_type =
2069 std::iterator_traits<DeclContext::decl_iterator>::difference_type;
2070 using iterator_category = std::forward_iterator_tag;
2072 specific_decl_iterator() = default;
2074 /// specific_decl_iterator - Construct a new iterator over a
2075 /// subset of the declarations the range [C,
2076 /// end-of-declarations). If A is non-NULL, it is a pointer to a
2077 /// member function of SpecificDecl that should return true for
2078 /// all of the SpecificDecl instances that will be in the subset
2079 /// of iterators. For example, if you want Objective-C instance
2080 /// methods, SpecificDecl will be ObjCMethodDecl and A will be
2081 /// &ObjCMethodDecl::isInstanceMethod.
2082 explicit specific_decl_iterator(DeclContext::decl_iterator C) : Current(C) {
2086 value_type operator*() const { return cast<SpecificDecl>(*Current); }
2088 // This doesn't meet the iterator requirements, but it's convenient
2089 value_type operator->() const { return **this; }
2091 specific_decl_iterator& operator++() {
2097 specific_decl_iterator operator++(int) {
2098 specific_decl_iterator tmp(*this);
2103 friend bool operator==(const specific_decl_iterator& x,
2104 const specific_decl_iterator& y) {
2105 return x.Current == y.Current;
2108 friend bool operator!=(const specific_decl_iterator& x,
2109 const specific_decl_iterator& y) {
2110 return x.Current != y.Current;
2114 /// Iterates over a filtered subrange of declarations stored
2115 /// in a DeclContext.
2117 /// This iterator visits only those declarations that are of type
2118 /// SpecificDecl (or a class derived from it) and that meet some
2119 /// additional run-time criteria. This iterator is used, for
2120 /// example, to provide access to the instance methods within an
2121 /// Objective-C interface (with SpecificDecl = ObjCMethodDecl and
2122 /// Acceptable = ObjCMethodDecl::isInstanceMethod).
2123 template<typename SpecificDecl, bool (SpecificDecl::*Acceptable)() const>
2124 class filtered_decl_iterator {
2125 /// Current - The current, underlying declaration iterator, which
2126 /// will either be NULL or will point to a declaration of
2127 /// type SpecificDecl.
2128 DeclContext::decl_iterator Current;
2130 /// SkipToNextDecl - Advances the current position up to the next
2131 /// declaration of type SpecificDecl that also meets the criteria
2132 /// required by Acceptable.
2133 void SkipToNextDecl() {
2135 (!isa<SpecificDecl>(*Current) ||
2136 (Acceptable && !(cast<SpecificDecl>(*Current)->*Acceptable)())))
2141 using value_type = SpecificDecl *;
2142 // TODO: Add reference and pointer types (with some appropriate proxy type)
2143 // if we ever have a need for them.
2144 using reference = void;
2145 using pointer = void;
2146 using difference_type =
2147 std::iterator_traits<DeclContext::decl_iterator>::difference_type;
2148 using iterator_category = std::forward_iterator_tag;
2150 filtered_decl_iterator() = default;
2152 /// filtered_decl_iterator - Construct a new iterator over a
2153 /// subset of the declarations the range [C,
2154 /// end-of-declarations). If A is non-NULL, it is a pointer to a
2155 /// member function of SpecificDecl that should return true for
2156 /// all of the SpecificDecl instances that will be in the subset
2157 /// of iterators. For example, if you want Objective-C instance
2158 /// methods, SpecificDecl will be ObjCMethodDecl and A will be
2159 /// &ObjCMethodDecl::isInstanceMethod.
2160 explicit filtered_decl_iterator(DeclContext::decl_iterator C) : Current(C) {
2164 value_type operator*() const { return cast<SpecificDecl>(*Current); }
2165 value_type operator->() const { return cast<SpecificDecl>(*Current); }
2167 filtered_decl_iterator& operator++() {
2173 filtered_decl_iterator operator++(int) {
2174 filtered_decl_iterator tmp(*this);
2179 friend bool operator==(const filtered_decl_iterator& x,
2180 const filtered_decl_iterator& y) {
2181 return x.Current == y.Current;
2184 friend bool operator!=(const filtered_decl_iterator& x,
2185 const filtered_decl_iterator& y) {
2186 return x.Current != y.Current;
2190 /// Add the declaration D into this context.
2192 /// This routine should be invoked when the declaration D has first
2193 /// been declared, to place D into the context where it was
2194 /// (lexically) defined. Every declaration must be added to one
2195 /// (and only one!) context, where it can be visited via
2196 /// [decls_begin(), decls_end()). Once a declaration has been added
2197 /// to its lexical context, the corresponding DeclContext owns the
2200 /// If D is also a NamedDecl, it will be made visible within its
2201 /// semantic context via makeDeclVisibleInContext.
2202 void addDecl(Decl *D);
2204 /// Add the declaration D into this context, but suppress
2205 /// searches for external declarations with the same name.
2207 /// Although analogous in function to addDecl, this removes an
2208 /// important check. This is only useful if the Decl is being
2209 /// added in response to an external search; in all other cases,
2210 /// addDecl() is the right function to use.
2211 /// See the ASTImporter for use cases.
2212 void addDeclInternal(Decl *D);
2214 /// Add the declaration D to this context without modifying
2215 /// any lookup tables.
2217 /// This is useful for some operations in dependent contexts where
2218 /// the semantic context might not be dependent; this basically
2219 /// only happens with friends.
2220 void addHiddenDecl(Decl *D);
2222 /// Removes a declaration from this context.
2223 void removeDecl(Decl *D);
2225 /// Checks whether a declaration is in this context.
2226 bool containsDecl(Decl *D) const;
2228 /// Checks whether a declaration is in this context.
2229 /// This also loads the Decls from the external source before the check.
2230 bool containsDeclAndLoad(Decl *D) const;
2232 using lookup_result = DeclContextLookupResult;
2233 using lookup_iterator = lookup_result::iterator;
2235 /// lookup - Find the declarations (if any) with the given Name in
2236 /// this context. Returns a range of iterators that contains all of
2237 /// the declarations with this name, with object, function, member,
2238 /// and enumerator names preceding any tag name. Note that this
2239 /// routine will not look into parent contexts.
2240 lookup_result lookup(DeclarationName Name) const;
2242 /// Find the declarations with the given name that are visible
2243 /// within this context; don't attempt to retrieve anything from an
2244 /// external source.
2245 lookup_result noload_lookup(DeclarationName Name);
2247 /// A simplistic name lookup mechanism that performs name lookup
2248 /// into this declaration context without consulting the external source.
2250 /// This function should almost never be used, because it subverts the
2251 /// usual relationship between a DeclContext and the external source.
2252 /// See the ASTImporter for the (few, but important) use cases.
2254 /// FIXME: This is very inefficient; replace uses of it with uses of
2256 void localUncachedLookup(DeclarationName Name,
2257 SmallVectorImpl<NamedDecl *> &Results);
2259 /// Makes a declaration visible within this context.
2261 /// This routine makes the declaration D visible to name lookup
2262 /// within this context and, if this is a transparent context,
2263 /// within its parent contexts up to the first enclosing
2264 /// non-transparent context. Making a declaration visible within a
2265 /// context does not transfer ownership of a declaration, and a
2266 /// declaration can be visible in many contexts that aren't its
2267 /// lexical context.
2269 /// If D is a redeclaration of an existing declaration that is
2270 /// visible from this context, as determined by
2271 /// NamedDecl::declarationReplaces, the previous declaration will be
2272 /// replaced with D.
2273 void makeDeclVisibleInContext(NamedDecl *D);
2275 /// all_lookups_iterator - An iterator that provides a view over the results
2276 /// of looking up every possible name.
2277 class all_lookups_iterator;
2279 using lookups_range = llvm::iterator_range<all_lookups_iterator>;
2281 lookups_range lookups() const;
2282 // Like lookups(), but avoids loading external declarations.
2283 // If PreserveInternalState, avoids building lookup data structures too.
2284 lookups_range noload_lookups(bool PreserveInternalState) const;
2286 /// Iterators over all possible lookups within this context.
2287 all_lookups_iterator lookups_begin() const;
2288 all_lookups_iterator lookups_end() const;
2290 /// Iterators over all possible lookups within this context that are
2291 /// currently loaded; don't attempt to retrieve anything from an external
2293 all_lookups_iterator noload_lookups_begin() const;
2294 all_lookups_iterator noload_lookups_end() const;
2296 struct udir_iterator;
2298 using udir_iterator_base =
2299 llvm::iterator_adaptor_base<udir_iterator, lookup_iterator,
2300 std::random_access_iterator_tag,
2301 UsingDirectiveDecl *>;
2303 struct udir_iterator : udir_iterator_base {
2304 udir_iterator(lookup_iterator I) : udir_iterator_base(I) {}
2306 UsingDirectiveDecl *operator*() const;
2309 using udir_range = llvm::iterator_range<udir_iterator>;
2311 udir_range using_directives() const;
2313 // These are all defined in DependentDiagnostic.h.
2314 class ddiag_iterator;
2316 using ddiag_range = llvm::iterator_range<DeclContext::ddiag_iterator>;
2318 inline ddiag_range ddiags() const;
2320 // Low-level accessors
2322 /// Mark that there are external lexical declarations that we need
2323 /// to include in our lookup table (and that are not available as external
2324 /// visible lookups). These extra lookup results will be found by walking
2325 /// the lexical declarations of this context. This should be used only if
2326 /// setHasExternalLexicalStorage() has been called on any decl context for
2327 /// which this is the primary context.
2328 void setMustBuildLookupTable() {
2329 assert(this == getPrimaryContext() &&
2330 "should only be called on primary context");
2331 DeclContextBits.HasLazyExternalLexicalLookups = true;
2334 /// Retrieve the internal representation of the lookup structure.
2335 /// This may omit some names if we are lazily building the structure.
2336 StoredDeclsMap *getLookupPtr() const { return LookupPtr; }
2338 /// Ensure the lookup structure is fully-built and return it.
2339 StoredDeclsMap *buildLookup();
2341 /// Whether this DeclContext has external storage containing
2342 /// additional declarations that are lexically in this context.
2343 bool hasExternalLexicalStorage() const {
2344 return DeclContextBits.ExternalLexicalStorage;
2347 /// State whether this DeclContext has external storage for
2348 /// declarations lexically in this context.
2349 void setHasExternalLexicalStorage(bool ES = true) const {
2350 DeclContextBits.ExternalLexicalStorage = ES;
2353 /// Whether this DeclContext has external storage containing
2354 /// additional declarations that are visible in this context.
2355 bool hasExternalVisibleStorage() const {
2356 return DeclContextBits.ExternalVisibleStorage;
2359 /// State whether this DeclContext has external storage for
2360 /// declarations visible in this context.
2361 void setHasExternalVisibleStorage(bool ES = true) const {
2362 DeclContextBits.ExternalVisibleStorage = ES;
2363 if (ES && LookupPtr)
2364 DeclContextBits.NeedToReconcileExternalVisibleStorage = true;
2367 /// Determine whether the given declaration is stored in the list of
2368 /// declarations lexically within this context.
2369 bool isDeclInLexicalTraversal(const Decl *D) const {
2370 return D && (D->NextInContextAndBits.getPointer() || D == FirstDecl ||
2374 bool setUseQualifiedLookup(bool use = true) const {
2375 bool old_value = DeclContextBits.UseQualifiedLookup;
2376 DeclContextBits.UseQualifiedLookup = use;
2380 bool shouldUseQualifiedLookup() const {
2381 return DeclContextBits.UseQualifiedLookup;
2384 static bool classof(const Decl *D);
2385 static bool classof(const DeclContext *D) { return true; }
2387 void dumpDeclContext() const;
2388 void dumpLookups() const;
2389 void dumpLookups(llvm::raw_ostream &OS, bool DumpDecls = false,
2390 bool Deserialize = false) const;
2393 /// Whether this declaration context has had externally visible
2394 /// storage added since the last lookup. In this case, \c LookupPtr's
2395 /// invariant may not hold and needs to be fixed before we perform
2397 bool hasNeedToReconcileExternalVisibleStorage() const {
2398 return DeclContextBits.NeedToReconcileExternalVisibleStorage;
2401 /// State that this declaration context has had externally visible
2402 /// storage added since the last lookup. In this case, \c LookupPtr's
2403 /// invariant may not hold and needs to be fixed before we perform
2405 void setNeedToReconcileExternalVisibleStorage(bool Need = true) const {
2406 DeclContextBits.NeedToReconcileExternalVisibleStorage = Need;
2409 /// If \c true, this context may have local lexical declarations
2410 /// that are missing from the lookup table.
2411 bool hasLazyLocalLexicalLookups() const {
2412 return DeclContextBits.HasLazyLocalLexicalLookups;
2415 /// If \c true, this context may have local lexical declarations
2416 /// that are missing from the lookup table.
2417 void setHasLazyLocalLexicalLookups(bool HasLLLL = true) const {
2418 DeclContextBits.HasLazyLocalLexicalLookups = HasLLLL;
2421 /// If \c true, the external source may have lexical declarations
2422 /// that are missing from the lookup table.
2423 bool hasLazyExternalLexicalLookups() const {
2424 return DeclContextBits.HasLazyExternalLexicalLookups;
2427 /// If \c true, the external source may have lexical declarations
2428 /// that are missing from the lookup table.
2429 void setHasLazyExternalLexicalLookups(bool HasLELL = true) const {
2430 DeclContextBits.HasLazyExternalLexicalLookups = HasLELL;
2433 void reconcileExternalVisibleStorage() const;
2434 bool LoadLexicalDeclsFromExternalStorage() const;
2436 /// Makes a declaration visible within this context, but
2437 /// suppresses searches for external declarations with the same
2440 /// Analogous to makeDeclVisibleInContext, but for the exclusive
2441 /// use of addDeclInternal().
2442 void makeDeclVisibleInContextInternal(NamedDecl *D);
2444 StoredDeclsMap *CreateStoredDeclsMap(ASTContext &C) const;
2446 void loadLazyLocalLexicalLookups();
2447 void buildLookupImpl(DeclContext *DCtx, bool Internal);
2448 void makeDeclVisibleInContextWithFlags(NamedDecl *D, bool Internal,
2449 bool Rediscoverable);
2450 void makeDeclVisibleInContextImpl(NamedDecl *D, bool Internal);
2453 inline bool Decl::isTemplateParameter() const {
2454 return getKind() == TemplateTypeParm || getKind() == NonTypeTemplateParm ||
2455 getKind() == TemplateTemplateParm;
2458 // Specialization selected when ToTy is not a known subclass of DeclContext.
2459 template <class ToTy,
2460 bool IsKnownSubtype = ::std::is_base_of<DeclContext, ToTy>::value>
2461 struct cast_convert_decl_context {
2462 static const ToTy *doit(const DeclContext *Val) {
2463 return static_cast<const ToTy*>(Decl::castFromDeclContext(Val));
2466 static ToTy *doit(DeclContext *Val) {
2467 return static_cast<ToTy*>(Decl::castFromDeclContext(Val));
2471 // Specialization selected when ToTy is a known subclass of DeclContext.
2472 template <class ToTy>
2473 struct cast_convert_decl_context<ToTy, true> {
2474 static const ToTy *doit(const DeclContext *Val) {
2475 return static_cast<const ToTy*>(Val);
2478 static ToTy *doit(DeclContext *Val) {
2479 return static_cast<ToTy*>(Val);
2483 } // namespace clang
2487 /// isa<T>(DeclContext*)
2488 template <typename To>
2489 struct isa_impl<To, ::clang::DeclContext> {
2490 static bool doit(const ::clang::DeclContext &Val) {
2491 return To::classofKind(Val.getDeclKind());
2495 /// cast<T>(DeclContext*)
2496 template<class ToTy>
2497 struct cast_convert_val<ToTy,
2498 const ::clang::DeclContext,const ::clang::DeclContext> {
2499 static const ToTy &doit(const ::clang::DeclContext &Val) {
2500 return *::clang::cast_convert_decl_context<ToTy>::doit(&Val);
2504 template<class ToTy>
2505 struct cast_convert_val<ToTy, ::clang::DeclContext, ::clang::DeclContext> {
2506 static ToTy &doit(::clang::DeclContext &Val) {
2507 return *::clang::cast_convert_decl_context<ToTy>::doit(&Val);
2511 template<class ToTy>
2512 struct cast_convert_val<ToTy,
2513 const ::clang::DeclContext*, const ::clang::DeclContext*> {
2514 static const ToTy *doit(const ::clang::DeclContext *Val) {
2515 return ::clang::cast_convert_decl_context<ToTy>::doit(Val);
2519 template<class ToTy>
2520 struct cast_convert_val<ToTy, ::clang::DeclContext*, ::clang::DeclContext*> {
2521 static ToTy *doit(::clang::DeclContext *Val) {
2522 return ::clang::cast_convert_decl_context<ToTy>::doit(Val);
2526 /// Implement cast_convert_val for Decl -> DeclContext conversions.
2527 template<class FromTy>
2528 struct cast_convert_val< ::clang::DeclContext, FromTy, FromTy> {
2529 static ::clang::DeclContext &doit(const FromTy &Val) {
2530 return *FromTy::castToDeclContext(&Val);
2534 template<class FromTy>
2535 struct cast_convert_val< ::clang::DeclContext, FromTy*, FromTy*> {
2536 static ::clang::DeclContext *doit(const FromTy *Val) {
2537 return FromTy::castToDeclContext(Val);
2541 template<class FromTy>
2542 struct cast_convert_val< const ::clang::DeclContext, FromTy, FromTy> {
2543 static const ::clang::DeclContext &doit(const FromTy &Val) {
2544 return *FromTy::castToDeclContext(&Val);
2548 template<class FromTy>
2549 struct cast_convert_val< const ::clang::DeclContext, FromTy*, FromTy*> {
2550 static const ::clang::DeclContext *doit(const FromTy *Val) {
2551 return FromTy::castToDeclContext(Val);
2557 #endif // LLVM_CLANG_AST_DECLBASE_H