[AST] Remove DeclCXX.h dep on ASTContext.h
[lldb.git] / clang / include / clang / AST / DeclBase.h
1 //===- DeclBase.h - Base Classes for representing declarations --*- C++ -*-===//
2 //
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
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 //  This file defines the Decl and DeclContext interfaces.
10 //
11 //===----------------------------------------------------------------------===//
12
13 #ifndef LLVM_CLANG_AST_DECLBASE_H
14 #define LLVM_CLANG_AST_DECLBASE_H
15
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"
32 #include <algorithm>
33 #include <cassert>
34 #include <cstddef>
35 #include <iterator>
36 #include <string>
37 #include <type_traits>
38 #include <utility>
39
40 namespace clang {
41
42 class ASTContext;
43 class ASTMutationListener;
44 class Attr;
45 class BlockDecl;
46 class DeclContext;
47 class ExternalSourceSymbolAttr;
48 class FunctionDecl;
49 class FunctionType;
50 class IdentifierInfo;
51 enum Linkage : unsigned char;
52 class LinkageSpecDecl;
53 class Module;
54 class NamedDecl;
55 class ObjCCategoryDecl;
56 class ObjCCategoryImplDecl;
57 class ObjCContainerDecl;
58 class ObjCImplDecl;
59 class ObjCImplementationDecl;
60 class ObjCInterfaceDecl;
61 class ObjCMethodDecl;
62 class ObjCProtocolDecl;
63 struct PrintingPolicy;
64 class RecordDecl;
65 class SourceManager;
66 class Stmt;
67 class StoredDeclsMap;
68 class TemplateDecl;
69 class TranslationUnitDecl;
70 class UsingDirectiveDecl;
71
72 /// Captures the result of checking the availability of a
73 /// declaration.
74 enum AvailabilityResult {
75   AR_Available = 0,
76   AR_NotYetIntroduced,
77   AR_Deprecated,
78   AR_Unavailable
79 };
80
81 /// Decl - This represents one declaration (or definition), e.g. a variable,
82 /// typedef, function, struct, etc.
83 ///
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 {
89 public:
90   /// Lists the kind of concrete classes of Decl.
91   enum Kind {
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"
99   };
100
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 {};
105
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.
112   ///
113   /// These are meant as bitmasks, so that searches in
114   /// C++ can look into the "tag" namespace during ordinary lookup.
115   ///
116   /// Decl currently provides 15 bits of IDNS bits.
117   enum IdentifierNamespace {
118     /// Labels, declared with 'x:' and referenced with 'goto x'.
119     IDNS_Label               = 0x0001,
120
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).
127     IDNS_Tag                 = 0x0002,
128
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.
132     IDNS_Type                = 0x0004,
133
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
137     /// normal lookup.
138     IDNS_Member              = 0x0008,
139
140     /// Namespaces, declared with 'namespace foo {}'.
141     /// Lookup for nested-name-specifiers find these.
142     IDNS_Namespace           = 0x0010,
143
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,
147
148     /// Objective C \@protocol.
149     IDNS_ObjCProtocol        = 0x0040,
150
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,
155
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,
160
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.
165     IDNS_Using               = 0x0200,
166
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,
171
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,
178
179     /// This declaration is an OpenMP user defined reduction construction.
180     IDNS_OMPReduction        = 0x1000,
181
182     /// This declaration is an OpenMP user defined mapper.
183     IDNS_OMPMapper           = 0x2000,
184   };
185
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.
191   ///
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
197   /// clang.
198   ///
199   /// This should be kept in sync with ObjCDeclSpec::ObjCDeclQualifier.
200   enum ObjCDeclQualifier {
201     OBJC_TQ_None = 0x0,
202     OBJC_TQ_In = 0x1,
203     OBJC_TQ_Inout = 0x2,
204     OBJC_TQ_Out = 0x4,
205     OBJC_TQ_Bycopy = 0x8,
206     OBJC_TQ_Byref = 0x10,
207     OBJC_TQ_Oneway = 0x20,
208
209     /// The nullability qualifier is set when the nullability of the
210     /// result or parameter was expressed via a context-sensitive
211     /// keyword.
212     OBJC_TQ_CSNullability = 0x40
213   };
214
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.
220     Unowned,
221
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.
227     Visible,
228
229     /// This declaration has an owning module, and is visible when that
230     /// module is imported.
231     VisibleWhenImported,
232
233     /// This declaration has an owning module, but is only visible to
234     /// lookups that occur within that module.
235     ModulePrivate
236   };
237
238 protected:
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().
242   ///
243   /// The extra two bits are used for the ModuleOwnershipKind.
244   llvm::PointerIntPair<Decl *, 2, ModuleOwnershipKind> NextInContextAndBits;
245
246 private:
247   friend class DeclContext;
248
249   struct MultipleDC {
250     DeclContext *SemanticDC;
251     DeclContext *LexicalDC;
252   };
253
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).
260   /// e.g.:
261   ///
262   ///   namespace A {
263   ///      void f(); // SemanticDC == LexicalDC == 'namespace A'
264   ///   }
265   ///   void A::f(); // SemanticDC == namespace 'A'
266   ///                // LexicalDC == global namespace
267   llvm::PointerUnion<DeclContext*, MultipleDC*> DeclCtx;
268
269   bool isInSemaDC() const { return DeclCtx.is<DeclContext*>(); }
270   bool isOutOfSemaDC() const { return DeclCtx.is<MultipleDC*>(); }
271
272   MultipleDC *getMultipleDC() const {
273     return DeclCtx.get<MultipleDC*>();
274   }
275
276   DeclContext *getSemanticDC() const {
277     return DeclCtx.get<DeclContext*>();
278   }
279
280   /// Loc - The location of this decl.
281   SourceLocation Loc;
282
283   /// DeclKind - This indicates which class this is.
284   unsigned DeclKind : 7;
285
286   /// InvalidDecl - This indicates a semantic error occurred.
287   unsigned InvalidDecl :  1;
288
289   /// HasAttrs - This indicates whether the decl has attributes or not.
290   unsigned HasAttrs : 1;
291
292   /// Implicit - Whether this declaration was implicitly generated by
293   /// the implementation rather than explicitly written by the user.
294   unsigned Implicit : 1;
295
296   /// Whether this declaration was "used", meaning that a definition is
297   /// required.
298   unsigned Used : 1;
299
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;
305
306   /// Whether this declaration is a top-level declaration (function,
307   /// global variable, etc.) that is lexically inside an objc container
308   /// definition.
309   unsigned TopLevelDeclInObjCContainer : 1;
310
311   /// Whether statistic collection is enabled.
312   static bool StatisticsEnabled;
313
314 protected:
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;
322
323   /// Access - Used by C++ decls for the access specifier.
324   // NOTE: VC++ treats enums as signed, avoid using the AccessSpecifier enum
325   unsigned Access : 2;
326
327   /// Whether this declaration was loaded from an AST file.
328   unsigned FromASTFile : 1;
329
330   /// IdentifierNamespace - This specifies what IDNS_* namespace this lives in.
331   unsigned IdentifierNamespace : 14;
332
333   /// If 0, we have not computed the linkage of this declaration.
334   /// Otherwise, it is the linkage + 1.
335   mutable unsigned CacheValidAndLinkage : 3;
336
337   /// Allocate memory for a deserialized declaration.
338   ///
339   /// This routine must be used to allocate memory for any declaration that is
340   /// deserialized from a module file.
341   ///
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);
348
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);
352
353 private:
354   bool AccessDeclContextSanity() const;
355
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) {
359     if (DC) {
360       auto *D = cast<Decl>(DC);
361       auto MOK = D->getModuleOwnershipKind();
362       if (MOK != ModuleOwnershipKind::Unowned &&
363           (!D->isFromASTFile() || D->hasLocalOwningModuleStorage()))
364         return MOK;
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.
367     }
368     return ModuleOwnershipKind::Unowned;
369   }
370
371 public:
372   Decl() = delete;
373   Decl(const Decl&) = delete;
374   Decl(Decl &&) = delete;
375   Decl &operator=(const Decl&) = delete;
376   Decl &operator=(Decl&&) = delete;
377
378 protected:
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);
387   }
388
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);
396   }
397
398   virtual ~Decl();
399
400   /// Update a potentially out-of-date declaration.
401   void updateOutOfDate(IdentifierInfo &II) const;
402
403   Linkage getCachedLinkage() const {
404     return Linkage(CacheValidAndLinkage - 1);
405   }
406
407   void setCachedLinkage(Linkage L) const {
408     CacheValidAndLinkage = L + 1;
409   }
410
411   bool hasCachedLinkage() const {
412     return CacheValidAndLinkage;
413   }
414
415 public:
416   /// Source range that this declaration covers.
417   virtual SourceRange getSourceRange() const LLVM_READONLY {
418     return SourceRange(getLocation(), getLocation());
419   }
420
421   SourceLocation getBeginLoc() const LLVM_READONLY {
422     return getSourceRange().getBegin();
423   }
424
425   SourceLocation getEndLoc() const LLVM_READONLY {
426     return getSourceRange().getEnd();
427   }
428
429   SourceLocation getLocation() const { return Loc; }
430   void setLocation(SourceLocation L) { Loc = L; }
431
432   Kind getKind() const { return static_cast<Kind>(DeclKind); }
433   const char *getDeclKindName() const;
434
435   Decl *getNextDeclInContext() { return NextInContextAndBits.getPointer(); }
436   const Decl *getNextDeclInContext() const {return NextInContextAndBits.getPointer();}
437
438   DeclContext *getDeclContext() {
439     if (isInSemaDC())
440       return getSemanticDC();
441     return getMultipleDC()->SemanticDC;
442   }
443   const DeclContext *getDeclContext() const {
444     return const_cast<Decl*>(this)->getDeclContext();
445   }
446
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.
450   ///
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();
455   }
456
457   TranslationUnitDecl *getTranslationUnitDecl();
458   const TranslationUnitDecl *getTranslationUnitDecl() const {
459     return const_cast<Decl*>(this)->getTranslationUnitDecl();
460   }
461
462   bool isInAnonymousNamespace() const;
463
464   bool isInStdNamespace() const;
465
466   ASTContext &getASTContext() const LLVM_READONLY;
467
468   /// Helper to get the language options from the ASTContext.
469   /// Defined out of line to avoid depending on ASTContext.h.
470   const LangOptions &getLangOpts() const LLVM_READONLY;
471
472   void setAccess(AccessSpecifier AS) {
473     Access = AS;
474     assert(AccessDeclContextSanity());
475   }
476
477   AccessSpecifier getAccess() const {
478     assert(AccessDeclContextSanity());
479     return AccessSpecifier(Access);
480   }
481
482   /// Retrieve the access specifier for this declaration, even though
483   /// it may not yet have been properly set.
484   AccessSpecifier getAccessUnsafe() const {
485     return AccessSpecifier(Access);
486   }
487
488   bool hasAttrs() const { return HasAttrs; }
489
490   void setAttrs(const AttrVec& Attrs) {
491     return setAttrsImpl(Attrs, getASTContext());
492   }
493
494   AttrVec &getAttrs() {
495     return const_cast<AttrVec&>(const_cast<const Decl*>(this)->getAttrs());
496   }
497
498   const AttrVec &getAttrs() const;
499   void dropAttrs();
500   void addAttr(Attr *A);
501
502   using attr_iterator = AttrVec::const_iterator;
503   using attr_range = llvm::iterator_range<attr_iterator>;
504
505   attr_range attrs() const {
506     return attr_range(attr_begin(), attr_end());
507   }
508
509   attr_iterator attr_begin() const {
510     return hasAttrs() ? getAttrs().begin() : nullptr;
511   }
512   attr_iterator attr_end() const {
513     return hasAttrs() ? getAttrs().end() : nullptr;
514   }
515
516   template <typename T>
517   void dropAttr() {
518     if (!HasAttrs) return;
519
520     AttrVec &Vec = getAttrs();
521     Vec.erase(std::remove_if(Vec.begin(), Vec.end(), isa<T, Attr*>), Vec.end());
522
523     if (Vec.empty())
524       HasAttrs = false;
525   }
526
527   template <typename T>
528   llvm::iterator_range<specific_attr_iterator<T>> specific_attrs() const {
529     return llvm::make_range(specific_attr_begin<T>(), specific_attr_end<T>());
530   }
531
532   template <typename T>
533   specific_attr_iterator<T> specific_attr_begin() const {
534     return specific_attr_iterator<T>(attr_begin());
535   }
536
537   template <typename T>
538   specific_attr_iterator<T> specific_attr_end() const {
539     return specific_attr_iterator<T>(attr_end());
540   }
541
542   template<typename T> T *getAttr() const {
543     return hasAttrs() ? getSpecificAttr<T>(getAttrs()) : nullptr;
544   }
545
546   template<typename T> bool hasAttr() const {
547     return hasAttrs() && hasSpecificAttr<T>(getAttrs());
548   }
549
550   /// getMaxAlignment - return the maximum alignment specified by attributes
551   /// on this decl, 0 if there are none.
552   unsigned getMaxAlignment() const;
553
554   /// setInvalidDecl - Indicates the Decl had a semantic error. This
555   /// allows for graceful error recovery.
556   void setInvalidDecl(bool Invalid = true);
557   bool isInvalidDecl() const { return (bool) InvalidDecl; }
558
559   /// isImplicit - Indicates whether the declaration was implicitly
560   /// generated by the implementation. If false, this declaration
561   /// was written explicitly in the source code.
562   bool isImplicit() const { return Implicit; }
563   void setImplicit(bool I = true) { Implicit = I; }
564
565   /// Whether *any* (re-)declaration of the entity was used, meaning that
566   /// a definition is required.
567   ///
568   /// \param CheckUsedAttr When true, also consider the "used" attribute
569   /// (in addition to the "used" bit set by \c setUsed()) when determining
570   /// whether the function is used.
571   bool isUsed(bool CheckUsedAttr = true) const;
572
573   /// Set whether the declaration is used, in the sense of odr-use.
574   ///
575   /// This should only be used immediately after creating a declaration.
576   /// It intentionally doesn't notify any listeners.
577   void setIsUsed() { getCanonicalDecl()->Used = true; }
578
579   /// Mark the declaration used, in the sense of odr-use.
580   ///
581   /// This notifies any mutation listeners in addition to setting a bit
582   /// indicating the declaration is used.
583   void markUsed(ASTContext &C);
584
585   /// Whether any declaration of this entity was referenced.
586   bool isReferenced() const;
587
588   /// Whether this declaration was referenced. This should not be relied
589   /// upon for anything other than debugging.
590   bool isThisDeclarationReferenced() const { return Referenced; }
591
592   void setReferenced(bool R = true) { Referenced = R; }
593
594   /// Whether this declaration is a top-level declaration (function,
595   /// global variable, etc.) that is lexically inside an objc container
596   /// definition.
597   bool isTopLevelDeclInObjCContainer() const {
598     return TopLevelDeclInObjCContainer;
599   }
600
601   void setTopLevelDeclInObjCContainer(bool V = true) {
602     TopLevelDeclInObjCContainer = V;
603   }
604
605   /// Looks on this and related declarations for an applicable
606   /// external source symbol attribute.
607   ExternalSourceSymbolAttr *getExternalSourceSymbolAttr() const;
608
609   /// Whether this declaration was marked as being private to the
610   /// module in which it was defined.
611   bool isModulePrivate() const {
612     return getModuleOwnershipKind() == ModuleOwnershipKind::ModulePrivate;
613   }
614
615   /// Return true if this declaration has an attribute which acts as
616   /// definition of the entity, such as 'alias' or 'ifunc'.
617   bool hasDefiningAttr() const;
618
619   /// Return this declaration's defining attribute if it has one.
620   const Attr *getDefiningAttr() const;
621
622 protected:
623   /// Specify that this declaration was marked as being private
624   /// to the module in which it was defined.
625   void setModulePrivate() {
626     // The module-private specifier has no effect on unowned declarations.
627     // FIXME: We should track this in some way for source fidelity.
628     if (getModuleOwnershipKind() == ModuleOwnershipKind::Unowned)
629       return;
630     setModuleOwnershipKind(ModuleOwnershipKind::ModulePrivate);
631   }
632
633 public:
634   /// Set the FromASTFile flag. This indicates that this declaration
635   /// was deserialized and not parsed from source code and enables
636   /// features such as module ownership information.
637   void setFromASTFile() {
638     FromASTFile = true;
639   }
640
641   /// Set the owning module ID.  This may only be called for
642   /// deserialized Decls.
643   void setOwningModuleID(unsigned ID) {
644     assert(isFromASTFile() && "Only works on a deserialized declaration");
645     *((unsigned*)this - 2) = ID;
646   }
647
648 public:
649   /// Determine the availability of the given declaration.
650   ///
651   /// This routine will determine the most restrictive availability of
652   /// the given declaration (e.g., preferring 'unavailable' to
653   /// 'deprecated').
654   ///
655   /// \param Message If non-NULL and the result is not \c
656   /// AR_Available, will be set to a (possibly empty) message
657   /// describing why the declaration has not been introduced, is
658   /// deprecated, or is unavailable.
659   ///
660   /// \param EnclosingVersion The version to compare with. If empty, assume the
661   /// deployment target version.
662   ///
663   /// \param RealizedPlatform If non-NULL and the availability result is found
664   /// in an available attribute it will set to the platform which is written in
665   /// the available attribute.
666   AvailabilityResult
667   getAvailability(std::string *Message = nullptr,
668                   VersionTuple EnclosingVersion = VersionTuple(),
669                   StringRef *RealizedPlatform = nullptr) const;
670
671   /// Retrieve the version of the target platform in which this
672   /// declaration was introduced.
673   ///
674   /// \returns An empty version tuple if this declaration has no 'introduced'
675   /// availability attributes, or the version tuple that's specified in the
676   /// attribute otherwise.
677   VersionTuple getVersionIntroduced() const;
678
679   /// Determine whether this declaration is marked 'deprecated'.
680   ///
681   /// \param Message If non-NULL and the declaration is deprecated,
682   /// this will be set to the message describing why the declaration
683   /// was deprecated (which may be empty).
684   bool isDeprecated(std::string *Message = nullptr) const {
685     return getAvailability(Message) == AR_Deprecated;
686   }
687
688   /// Determine whether this declaration is marked 'unavailable'.
689   ///
690   /// \param Message If non-NULL and the declaration is unavailable,
691   /// this will be set to the message describing why the declaration
692   /// was made unavailable (which may be empty).
693   bool isUnavailable(std::string *Message = nullptr) const {
694     return getAvailability(Message) == AR_Unavailable;
695   }
696
697   /// Determine whether this is a weak-imported symbol.
698   ///
699   /// Weak-imported symbols are typically marked with the
700   /// 'weak_import' attribute, but may also be marked with an
701   /// 'availability' attribute where we're targing a platform prior to
702   /// the introduction of this feature.
703   bool isWeakImported() const;
704
705   /// Determines whether this symbol can be weak-imported,
706   /// e.g., whether it would be well-formed to add the weak_import
707   /// attribute.
708   ///
709   /// \param IsDefinition Set to \c true to indicate that this
710   /// declaration cannot be weak-imported because it has a definition.
711   bool canBeWeakImported(bool &IsDefinition) const;
712
713   /// Determine whether this declaration came from an AST file (such as
714   /// a precompiled header or module) rather than having been parsed.
715   bool isFromASTFile() const { return FromASTFile; }
716
717   /// Retrieve the global declaration ID associated with this
718   /// declaration, which specifies where this Decl was loaded from.
719   unsigned getGlobalID() const {
720     if (isFromASTFile())
721       return *((const unsigned*)this - 1);
722     return 0;
723   }
724
725   /// Retrieve the global ID of the module that owns this particular
726   /// declaration.
727   unsigned getOwningModuleID() const {
728     if (isFromASTFile())
729       return *((const unsigned*)this - 2);
730     return 0;
731   }
732
733 private:
734   Module *getOwningModuleSlow() const;
735
736 protected:
737   bool hasLocalOwningModuleStorage() const;
738
739 public:
740   /// Get the imported owning module, if this decl is from an imported
741   /// (non-local) module.
742   Module *getImportedOwningModule() const {
743     if (!isFromASTFile() || !hasOwningModule())
744       return nullptr;
745
746     return getOwningModuleSlow();
747   }
748
749   /// Get the local owning module, if known. Returns nullptr if owner is
750   /// not yet known or declaration is not from a module.
751   Module *getLocalOwningModule() const {
752     if (isFromASTFile() || !hasOwningModule())
753       return nullptr;
754
755     assert(hasLocalOwningModuleStorage() &&
756            "owned local decl but no local module storage");
757     return reinterpret_cast<Module *const *>(this)[-1];
758   }
759   void setLocalOwningModule(Module *M) {
760     assert(!isFromASTFile() && hasOwningModule() &&
761            hasLocalOwningModuleStorage() &&
762            "should not have a cached owning module");
763     reinterpret_cast<Module **>(this)[-1] = M;
764   }
765
766   /// Is this declaration owned by some module?
767   bool hasOwningModule() const {
768     return getModuleOwnershipKind() != ModuleOwnershipKind::Unowned;
769   }
770
771   /// Get the module that owns this declaration (for visibility purposes).
772   Module *getOwningModule() const {
773     return isFromASTFile() ? getImportedOwningModule() : getLocalOwningModule();
774   }
775
776   /// Get the module that owns this declaration for linkage purposes.
777   /// There only ever is such a module under the C++ Modules TS.
778   ///
779   /// \param IgnoreLinkage Ignore the linkage of the entity; assume that
780   /// all declarations in a global module fragment are unowned.
781   Module *getOwningModuleForLinkage(bool IgnoreLinkage = false) const;
782
783   /// Determine whether this declaration might be hidden from name
784   /// lookup. Note that the declaration might be visible even if this returns
785   /// \c false, if the owning module is visible within the query context.
786   // FIXME: Rename this to make it clearer what it does.
787   bool isHidden() const {
788     return (int)getModuleOwnershipKind() > (int)ModuleOwnershipKind::Visible;
789   }
790
791   /// Set that this declaration is globally visible, even if it came from a
792   /// module that is not visible.
793   void setVisibleDespiteOwningModule() {
794     if (isHidden())
795       setModuleOwnershipKind(ModuleOwnershipKind::Visible);
796   }
797
798   /// Get the kind of module ownership for this declaration.
799   ModuleOwnershipKind getModuleOwnershipKind() const {
800     return NextInContextAndBits.getInt();
801   }
802
803   /// Set whether this declaration is hidden from name lookup.
804   void setModuleOwnershipKind(ModuleOwnershipKind MOK) {
805     assert(!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned &&
806              MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() &&
807              !hasLocalOwningModuleStorage()) &&
808            "no storage available for owning module for this declaration");
809     NextInContextAndBits.setInt(MOK);
810   }
811
812   unsigned getIdentifierNamespace() const {
813     return IdentifierNamespace;
814   }
815
816   bool isInIdentifierNamespace(unsigned NS) const {
817     return getIdentifierNamespace() & NS;
818   }
819
820   static unsigned getIdentifierNamespaceForKind(Kind DK);
821
822   bool hasTagIdentifierNamespace() const {
823     return isTagIdentifierNamespace(getIdentifierNamespace());
824   }
825
826   static bool isTagIdentifierNamespace(unsigned NS) {
827     // TagDecls have Tag and Type set and may also have TagFriend.
828     return (NS & ~IDNS_TagFriend) == (IDNS_Tag | IDNS_Type);
829   }
830
831   /// getLexicalDeclContext - The declaration context where this Decl was
832   /// lexically declared (LexicalDC). May be different from
833   /// getDeclContext() (SemanticDC).
834   /// e.g.:
835   ///
836   ///   namespace A {
837   ///      void f(); // SemanticDC == LexicalDC == 'namespace A'
838   ///   }
839   ///   void A::f(); // SemanticDC == namespace 'A'
840   ///                // LexicalDC == global namespace
841   DeclContext *getLexicalDeclContext() {
842     if (isInSemaDC())
843       return getSemanticDC();
844     return getMultipleDC()->LexicalDC;
845   }
846   const DeclContext *getLexicalDeclContext() const {
847     return const_cast<Decl*>(this)->getLexicalDeclContext();
848   }
849
850   /// Determine whether this declaration is declared out of line (outside its
851   /// semantic context).
852   virtual bool isOutOfLine() const;
853
854   /// setDeclContext - Set both the semantic and lexical DeclContext
855   /// to DC.
856   void setDeclContext(DeclContext *DC);
857
858   void setLexicalDeclContext(DeclContext *DC);
859
860   /// Determine whether this declaration is a templated entity (whether it is
861   // within the scope of a template parameter).
862   bool isTemplated() const;
863
864   /// isDefinedOutsideFunctionOrMethod - This predicate returns true if this
865   /// scoped decl is defined outside the current function or method.  This is
866   /// roughly global variables and functions, but also handles enums (which
867   /// could be defined inside or outside a function etc).
868   bool isDefinedOutsideFunctionOrMethod() const {
869     return getParentFunctionOrMethod() == nullptr;
870   }
871
872   /// Returns true if this declaration lexically is inside a function.
873   /// It recognizes non-defining declarations as well as members of local
874   /// classes:
875   /// \code
876   ///     void foo() { void bar(); }
877   ///     void foo2() { class ABC { void bar(); }; }
878   /// \endcode
879   bool isLexicallyWithinFunctionOrMethod() const;
880
881   /// If this decl is defined inside a function/method/block it returns
882   /// the corresponding DeclContext, otherwise it returns null.
883   const DeclContext *getParentFunctionOrMethod() const;
884   DeclContext *getParentFunctionOrMethod() {
885     return const_cast<DeclContext*>(
886                     const_cast<const Decl*>(this)->getParentFunctionOrMethod());
887   }
888
889   /// Retrieves the "canonical" declaration of the given declaration.
890   virtual Decl *getCanonicalDecl() { return this; }
891   const Decl *getCanonicalDecl() const {
892     return const_cast<Decl*>(this)->getCanonicalDecl();
893   }
894
895   /// Whether this particular Decl is a canonical one.
896   bool isCanonicalDecl() const { return getCanonicalDecl() == this; }
897
898 protected:
899   /// Returns the next redeclaration or itself if this is the only decl.
900   ///
901   /// Decl subclasses that can be redeclared should override this method so that
902   /// Decl::redecl_iterator can iterate over them.
903   virtual Decl *getNextRedeclarationImpl() { return this; }
904
905   /// Implementation of getPreviousDecl(), to be overridden by any
906   /// subclass that has a redeclaration chain.
907   virtual Decl *getPreviousDeclImpl() { return nullptr; }
908
909   /// Implementation of getMostRecentDecl(), to be overridden by any
910   /// subclass that has a redeclaration chain.
911   virtual Decl *getMostRecentDeclImpl() { return this; }
912
913 public:
914   /// Iterates through all the redeclarations of the same decl.
915   class redecl_iterator {
916     /// Current - The current declaration.
917     Decl *Current = nullptr;
918     Decl *Starter;
919
920   public:
921     using value_type = Decl *;
922     using reference = const value_type &;
923     using pointer = const value_type *;
924     using iterator_category = std::forward_iterator_tag;
925     using difference_type = std::ptrdiff_t;
926
927     redecl_iterator() = default;
928     explicit redecl_iterator(Decl *C) : Current(C), Starter(C) {}
929
930     reference operator*() const { return Current; }
931     value_type operator->() const { return Current; }
932
933     redecl_iterator& operator++() {
934       assert(Current && "Advancing while iterator has reached end");
935       // Get either previous decl or latest decl.
936       Decl *Next = Current->getNextRedeclarationImpl();
937       assert(Next && "Should return next redeclaration or itself, never null!");
938       Current = (Next != Starter) ? Next : nullptr;
939       return *this;
940     }
941
942     redecl_iterator operator++(int) {
943       redecl_iterator tmp(*this);
944       ++(*this);
945       return tmp;
946     }
947
948     friend bool operator==(redecl_iterator x, redecl_iterator y) {
949       return x.Current == y.Current;
950     }
951
952     friend bool operator!=(redecl_iterator x, redecl_iterator y) {
953       return x.Current != y.Current;
954     }
955   };
956
957   using redecl_range = llvm::iterator_range<redecl_iterator>;
958
959   /// Returns an iterator range for all the redeclarations of the same
960   /// decl. It will iterate at least once (when this decl is the only one).
961   redecl_range redecls() const {
962     return redecl_range(redecls_begin(), redecls_end());
963   }
964
965   redecl_iterator redecls_begin() const {
966     return redecl_iterator(const_cast<Decl *>(this));
967   }
968
969   redecl_iterator redecls_end() const { return redecl_iterator(); }
970
971   /// Retrieve the previous declaration that declares the same entity
972   /// as this declaration, or NULL if there is no previous declaration.
973   Decl *getPreviousDecl() { return getPreviousDeclImpl(); }
974
975   /// Retrieve the previous declaration that declares the same entity
976   /// as this declaration, or NULL if there is no previous declaration.
977   const Decl *getPreviousDecl() const {
978     return const_cast<Decl *>(this)->getPreviousDeclImpl();
979   }
980
981   /// True if this is the first declaration in its redeclaration chain.
982   bool isFirstDecl() const {
983     return getPreviousDecl() == nullptr;
984   }
985
986   /// Retrieve the most recent declaration that declares the same entity
987   /// as this declaration (which may be this declaration).
988   Decl *getMostRecentDecl() { return getMostRecentDeclImpl(); }
989
990   /// Retrieve the most recent declaration that declares the same entity
991   /// as this declaration (which may be this declaration).
992   const Decl *getMostRecentDecl() const {
993     return const_cast<Decl *>(this)->getMostRecentDeclImpl();
994   }
995
996   /// getBody - If this Decl represents a declaration for a body of code,
997   ///  such as a function or method definition, this method returns the
998   ///  top-level Stmt* of that body.  Otherwise this method returns null.
999   virtual Stmt* getBody() const { return nullptr; }
1000
1001   /// Returns true if this \c Decl represents a declaration for a body of
1002   /// code, such as a function or method definition.
1003   /// Note that \c hasBody can also return true if any redeclaration of this
1004   /// \c Decl represents a declaration for a body of code.
1005   virtual bool hasBody() const { return getBody() != nullptr; }
1006
1007   /// getBodyRBrace - Gets the right brace of the body, if a body exists.
1008   /// This works whether the body is a CompoundStmt or a CXXTryStmt.
1009   SourceLocation getBodyRBrace() const;
1010
1011   // global temp stats (until we have a per-module visitor)
1012   static void add(Kind k);
1013   static void EnableStatistics();
1014   static void PrintStats();
1015
1016   /// isTemplateParameter - Determines whether this declaration is a
1017   /// template parameter.
1018   bool isTemplateParameter() const;
1019
1020   /// isTemplateParameter - Determines whether this declaration is a
1021   /// template parameter pack.
1022   bool isTemplateParameterPack() const;
1023
1024   /// Whether this declaration is a parameter pack.
1025   bool isParameterPack() const;
1026
1027   /// returns true if this declaration is a template
1028   bool isTemplateDecl() const;
1029
1030   /// Whether this declaration is a function or function template.
1031   bool isFunctionOrFunctionTemplate() const {
1032     return (DeclKind >= Decl::firstFunction &&
1033             DeclKind <= Decl::lastFunction) ||
1034            DeclKind == FunctionTemplate;
1035   }
1036
1037   /// If this is a declaration that describes some template, this
1038   /// method returns that template declaration.
1039   TemplateDecl *getDescribedTemplate() const;
1040
1041   /// Returns the function itself, or the templated function if this is a
1042   /// function template.
1043   FunctionDecl *getAsFunction() LLVM_READONLY;
1044
1045   const FunctionDecl *getAsFunction() const {
1046     return const_cast<Decl *>(this)->getAsFunction();
1047   }
1048
1049   /// Changes the namespace of this declaration to reflect that it's
1050   /// a function-local extern declaration.
1051   ///
1052   /// These declarations appear in the lexical context of the extern
1053   /// declaration, but in the semantic context of the enclosing namespace
1054   /// scope.
1055   void setLocalExternDecl() {
1056     Decl *Prev = getPreviousDecl();
1057     IdentifierNamespace &= ~IDNS_Ordinary;
1058
1059     // It's OK for the declaration to still have the "invisible friend" flag or
1060     // the "conflicts with tag declarations in this scope" flag for the outer
1061     // scope.
1062     assert((IdentifierNamespace & ~(IDNS_OrdinaryFriend | IDNS_Tag)) == 0 &&
1063            "namespace is not ordinary");
1064
1065     IdentifierNamespace |= IDNS_LocalExtern;
1066     if (Prev && Prev->getIdentifierNamespace() & IDNS_Ordinary)
1067       IdentifierNamespace |= IDNS_Ordinary;
1068   }
1069
1070   /// Determine whether this is a block-scope declaration with linkage.
1071   /// This will either be a local variable declaration declared 'extern', or a
1072   /// local function declaration.
1073   bool isLocalExternDecl() {
1074     return IdentifierNamespace & IDNS_LocalExtern;
1075   }
1076
1077   /// Changes the namespace of this declaration to reflect that it's
1078   /// the object of a friend declaration.
1079   ///
1080   /// These declarations appear in the lexical context of the friending
1081   /// class, but in the semantic context of the actual entity.  This property
1082   /// applies only to a specific decl object;  other redeclarations of the
1083   /// same entity may not (and probably don't) share this property.
1084   void setObjectOfFriendDecl(bool PerformFriendInjection = false) {
1085     unsigned OldNS = IdentifierNamespace;
1086     assert((OldNS & (IDNS_Tag | IDNS_Ordinary |
1087                      IDNS_TagFriend | IDNS_OrdinaryFriend |
1088                      IDNS_LocalExtern | IDNS_NonMemberOperator)) &&
1089            "namespace includes neither ordinary nor tag");
1090     assert(!(OldNS & ~(IDNS_Tag | IDNS_Ordinary | IDNS_Type |
1091                        IDNS_TagFriend | IDNS_OrdinaryFriend |
1092                        IDNS_LocalExtern | IDNS_NonMemberOperator)) &&
1093            "namespace includes other than ordinary or tag");
1094
1095     Decl *Prev = getPreviousDecl();
1096     IdentifierNamespace &= ~(IDNS_Ordinary | IDNS_Tag | IDNS_Type);
1097
1098     if (OldNS & (IDNS_Tag | IDNS_TagFriend)) {
1099       IdentifierNamespace |= IDNS_TagFriend;
1100       if (PerformFriendInjection ||
1101           (Prev && Prev->getIdentifierNamespace() & IDNS_Tag))
1102         IdentifierNamespace |= IDNS_Tag | IDNS_Type;
1103     }
1104
1105     if (OldNS & (IDNS_Ordinary | IDNS_OrdinaryFriend |
1106                  IDNS_LocalExtern | IDNS_NonMemberOperator)) {
1107       IdentifierNamespace |= IDNS_OrdinaryFriend;
1108       if (PerformFriendInjection ||
1109           (Prev && Prev->getIdentifierNamespace() & IDNS_Ordinary))
1110         IdentifierNamespace |= IDNS_Ordinary;
1111     }
1112   }
1113
1114   enum FriendObjectKind {
1115     FOK_None,      ///< Not a friend object.
1116     FOK_Declared,  ///< A friend of a previously-declared entity.
1117     FOK_Undeclared ///< A friend of a previously-undeclared entity.
1118   };
1119
1120   /// Determines whether this declaration is the object of a
1121   /// friend declaration and, if so, what kind.
1122   ///
1123   /// There is currently no direct way to find the associated FriendDecl.
1124   FriendObjectKind getFriendObjectKind() const {
1125     unsigned mask =
1126         (IdentifierNamespace & (IDNS_TagFriend | IDNS_OrdinaryFriend));
1127     if (!mask) return FOK_None;
1128     return (IdentifierNamespace & (IDNS_Tag | IDNS_Ordinary) ? FOK_Declared
1129                                                              : FOK_Undeclared);
1130   }
1131
1132   /// Specifies that this declaration is a C++ overloaded non-member.
1133   void setNonMemberOperator() {
1134     assert(getKind() == Function || getKind() == FunctionTemplate);
1135     assert((IdentifierNamespace & IDNS_Ordinary) &&
1136            "visible non-member operators should be in ordinary namespace");
1137     IdentifierNamespace |= IDNS_NonMemberOperator;
1138   }
1139
1140   static bool classofKind(Kind K) { return true; }
1141   static DeclContext *castToDeclContext(const Decl *);
1142   static Decl *castFromDeclContext(const DeclContext *);
1143
1144   void print(raw_ostream &Out, unsigned Indentation = 0,
1145              bool PrintInstantiation = false) const;
1146   void print(raw_ostream &Out, const PrintingPolicy &Policy,
1147              unsigned Indentation = 0, bool PrintInstantiation = false) const;
1148   static void printGroup(Decl** Begin, unsigned NumDecls,
1149                          raw_ostream &Out, const PrintingPolicy &Policy,
1150                          unsigned Indentation = 0);
1151
1152   // Debuggers don't usually respect default arguments.
1153   void dump() const;
1154
1155   // Same as dump(), but forces color printing.
1156   void dumpColor() const;
1157
1158   void dump(raw_ostream &Out, bool Deserialize = false,
1159             ASTDumpOutputFormat OutputFormat = ADOF_Default) const;
1160
1161   /// \return Unique reproducible object identifier
1162   int64_t getID() const;
1163
1164   /// Looks through the Decl's underlying type to extract a FunctionType
1165   /// when possible. Will return null if the type underlying the Decl does not
1166   /// have a FunctionType.
1167   const FunctionType *getFunctionType(bool BlocksToo = true) const;
1168
1169 private:
1170   void setAttrsImpl(const AttrVec& Attrs, ASTContext &Ctx);
1171   void setDeclContextsImpl(DeclContext *SemaDC, DeclContext *LexicalDC,
1172                            ASTContext &Ctx);
1173
1174 protected:
1175   ASTMutationListener *getASTMutationListener() const;
1176 };
1177
1178 /// Determine whether two declarations declare the same entity.
1179 inline bool declaresSameEntity(const Decl *D1, const Decl *D2) {
1180   if (!D1 || !D2)
1181     return false;
1182
1183   if (D1 == D2)
1184     return true;
1185
1186   return D1->getCanonicalDecl() == D2->getCanonicalDecl();
1187 }
1188
1189 /// PrettyStackTraceDecl - If a crash occurs, indicate that it happened when
1190 /// doing something to a specific decl.
1191 class PrettyStackTraceDecl : public llvm::PrettyStackTraceEntry {
1192   const Decl *TheDecl;
1193   SourceLocation Loc;
1194   SourceManager &SM;
1195   const char *Message;
1196
1197 public:
1198   PrettyStackTraceDecl(const Decl *theDecl, SourceLocation L,
1199                        SourceManager &sm, const char *Msg)
1200       : TheDecl(theDecl), Loc(L), SM(sm), Message(Msg) {}
1201
1202   void print(raw_ostream &OS) const override;
1203 };
1204
1205 /// The results of name lookup within a DeclContext. This is either a
1206 /// single result (with no stable storage) or a collection of results (with
1207 /// stable storage provided by the lookup table).
1208 class DeclContextLookupResult {
1209   using ResultTy = ArrayRef<NamedDecl *>;
1210
1211   ResultTy Result;
1212
1213   // If there is only one lookup result, it would be invalidated by
1214   // reallocations of the name table, so store it separately.
1215   NamedDecl *Single = nullptr;
1216
1217   static NamedDecl *const SingleElementDummyList;
1218
1219 public:
1220   DeclContextLookupResult() = default;
1221   DeclContextLookupResult(ArrayRef<NamedDecl *> Result)
1222       : Result(Result) {}
1223   DeclContextLookupResult(NamedDecl *Single)
1224       : Result(SingleElementDummyList), Single(Single) {}
1225
1226   class iterator;
1227
1228   using IteratorBase =
1229       llvm::iterator_adaptor_base<iterator, ResultTy::iterator,
1230                                   std::random_access_iterator_tag,
1231                                   NamedDecl *const>;
1232
1233   class iterator : public IteratorBase {
1234     value_type SingleElement;
1235
1236   public:
1237     explicit iterator(pointer Pos, value_type Single = nullptr)
1238         : IteratorBase(Pos), SingleElement(Single) {}
1239
1240     reference operator*() const {
1241       return SingleElement ? SingleElement : IteratorBase::operator*();
1242     }
1243   };
1244
1245   using const_iterator = iterator;
1246   using pointer = iterator::pointer;
1247   using reference = iterator::reference;
1248
1249   iterator begin() const { return iterator(Result.begin(), Single); }
1250   iterator end() const { return iterator(Result.end(), Single); }
1251
1252   bool empty() const { return Result.empty(); }
1253   pointer data() const { return Single ? &Single : Result.data(); }
1254   size_t size() const { return Single ? 1 : Result.size(); }
1255   reference front() const { return Single ? Single : Result.front(); }
1256   reference back() const { return Single ? Single : Result.back(); }
1257   reference operator[](size_t N) const { return Single ? Single : Result[N]; }
1258
1259   // FIXME: Remove this from the interface
1260   DeclContextLookupResult slice(size_t N) const {
1261     DeclContextLookupResult Sliced = Result.slice(N);
1262     Sliced.Single = Single;
1263     return Sliced;
1264   }
1265 };
1266
1267 /// DeclContext - This is used only as base class of specific decl types that
1268 /// can act as declaration contexts. These decls are (only the top classes
1269 /// that directly derive from DeclContext are mentioned, not their subclasses):
1270 ///
1271 ///   TranslationUnitDecl
1272 ///   ExternCContext
1273 ///   NamespaceDecl
1274 ///   TagDecl
1275 ///   OMPDeclareReductionDecl
1276 ///   OMPDeclareMapperDecl
1277 ///   FunctionDecl
1278 ///   ObjCMethodDecl
1279 ///   ObjCContainerDecl
1280 ///   LinkageSpecDecl
1281 ///   ExportDecl
1282 ///   BlockDecl
1283 ///   CapturedDecl
1284 class DeclContext {
1285   /// For makeDeclVisibleInContextImpl
1286   friend class ASTDeclReader;
1287   /// For reconcileExternalVisibleStorage, CreateStoredDeclsMap,
1288   /// hasNeedToReconcileExternalVisibleStorage
1289   friend class ExternalASTSource;
1290   /// For CreateStoredDeclsMap
1291   friend class DependentDiagnostic;
1292   /// For hasNeedToReconcileExternalVisibleStorage,
1293   /// hasLazyLocalLexicalLookups, hasLazyExternalLexicalLookups
1294   friend class ASTWriter;
1295
1296   // We use uint64_t in the bit-fields below since some bit-fields
1297   // cross the unsigned boundary and this breaks the packing.
1298
1299   /// Stores the bits used by DeclContext.
1300   /// If modified NumDeclContextBit, the ctor of DeclContext and the accessor
1301   /// methods in DeclContext should be updated appropriately.
1302   class DeclContextBitfields {
1303     friend class DeclContext;
1304     /// DeclKind - This indicates which class this is.
1305     uint64_t DeclKind : 7;
1306
1307     /// Whether this declaration context also has some external
1308     /// storage that contains additional declarations that are lexically
1309     /// part of this context.
1310     mutable uint64_t ExternalLexicalStorage : 1;
1311
1312     /// Whether this declaration context also has some external
1313     /// storage that contains additional declarations that are visible
1314     /// in this context.
1315     mutable uint64_t ExternalVisibleStorage : 1;
1316
1317     /// Whether this declaration context has had externally visible
1318     /// storage added since the last lookup. In this case, \c LookupPtr's
1319     /// invariant may not hold and needs to be fixed before we perform
1320     /// another lookup.
1321     mutable uint64_t NeedToReconcileExternalVisibleStorage : 1;
1322
1323     /// If \c true, this context may have local lexical declarations
1324     /// that are missing from the lookup table.
1325     mutable uint64_t HasLazyLocalLexicalLookups : 1;
1326
1327     /// If \c true, the external source may have lexical declarations
1328     /// that are missing from the lookup table.
1329     mutable uint64_t HasLazyExternalLexicalLookups : 1;
1330
1331     /// If \c true, lookups should only return identifier from
1332     /// DeclContext scope (for example TranslationUnit). Used in
1333     /// LookupQualifiedName()
1334     mutable uint64_t UseQualifiedLookup : 1;
1335   };
1336
1337   /// Number of bits in DeclContextBitfields.
1338   enum { NumDeclContextBits = 13 };
1339
1340   /// Stores the bits used by TagDecl.
1341   /// If modified NumTagDeclBits and the accessor
1342   /// methods in TagDecl should be updated appropriately.
1343   class TagDeclBitfields {
1344     friend class TagDecl;
1345     /// For the bits in DeclContextBitfields
1346     uint64_t : NumDeclContextBits;
1347
1348     /// The TagKind enum.
1349     uint64_t TagDeclKind : 3;
1350
1351     /// True if this is a definition ("struct foo {};"), false if it is a
1352     /// declaration ("struct foo;").  It is not considered a definition
1353     /// until the definition has been fully processed.
1354     uint64_t IsCompleteDefinition : 1;
1355
1356     /// True if this is currently being defined.
1357     uint64_t IsBeingDefined : 1;
1358
1359     /// True if this tag declaration is "embedded" (i.e., defined or declared
1360     /// for the very first time) in the syntax of a declarator.
1361     uint64_t IsEmbeddedInDeclarator : 1;
1362
1363     /// True if this tag is free standing, e.g. "struct foo;".
1364     uint64_t IsFreeStanding : 1;
1365
1366     /// Indicates whether it is possible for declarations of this kind
1367     /// to have an out-of-date definition.
1368     ///
1369     /// This option is only enabled when modules are enabled.
1370     uint64_t MayHaveOutOfDateDef : 1;
1371
1372     /// Has the full definition of this type been required by a use somewhere in
1373     /// the TU.
1374     uint64_t IsCompleteDefinitionRequired : 1;
1375   };
1376
1377   /// Number of non-inherited bits in TagDeclBitfields.
1378   enum { NumTagDeclBits = 9 };
1379
1380   /// Stores the bits used by EnumDecl.
1381   /// If modified NumEnumDeclBit and the accessor
1382   /// methods in EnumDecl should be updated appropriately.
1383   class EnumDeclBitfields {
1384     friend class EnumDecl;
1385     /// For the bits in DeclContextBitfields.
1386     uint64_t : NumDeclContextBits;
1387     /// For the bits in TagDeclBitfields.
1388     uint64_t : NumTagDeclBits;
1389
1390     /// Width in bits required to store all the non-negative
1391     /// enumerators of this enum.
1392     uint64_t NumPositiveBits : 8;
1393
1394     /// Width in bits required to store all the negative
1395     /// enumerators of this enum.
1396     uint64_t NumNegativeBits : 8;
1397
1398     /// True if this tag declaration is a scoped enumeration. Only
1399     /// possible in C++11 mode.
1400     uint64_t IsScoped : 1;
1401
1402     /// If this tag declaration is a scoped enum,
1403     /// then this is true if the scoped enum was declared using the class
1404     /// tag, false if it was declared with the struct tag. No meaning is
1405     /// associated if this tag declaration is not a scoped enum.
1406     uint64_t IsScopedUsingClassTag : 1;
1407
1408     /// True if this is an enumeration with fixed underlying type. Only
1409     /// possible in C++11, Microsoft extensions, or Objective C mode.
1410     uint64_t IsFixed : 1;
1411
1412     /// True if a valid hash is stored in ODRHash.
1413     uint64_t HasODRHash : 1;
1414   };
1415
1416   /// Number of non-inherited bits in EnumDeclBitfields.
1417   enum { NumEnumDeclBits = 20 };
1418
1419   /// Stores the bits used by RecordDecl.
1420   /// If modified NumRecordDeclBits and the accessor
1421   /// methods in RecordDecl should be updated appropriately.
1422   class RecordDeclBitfields {
1423     friend class RecordDecl;
1424     /// For the bits in DeclContextBitfields.
1425     uint64_t : NumDeclContextBits;
1426     /// For the bits in TagDeclBitfields.
1427     uint64_t : NumTagDeclBits;
1428
1429     /// This is true if this struct ends with a flexible
1430     /// array member (e.g. int X[]) or if this union contains a struct that does.
1431     /// If so, this cannot be contained in arrays or other structs as a member.
1432     uint64_t HasFlexibleArrayMember : 1;
1433
1434     /// Whether this is the type of an anonymous struct or union.
1435     uint64_t AnonymousStructOrUnion : 1;
1436
1437     /// This is true if this struct has at least one member
1438     /// containing an Objective-C object pointer type.
1439     uint64_t HasObjectMember : 1;
1440
1441     /// This is true if struct has at least one member of
1442     /// 'volatile' type.
1443     uint64_t HasVolatileMember : 1;
1444
1445     /// Whether the field declarations of this record have been loaded
1446     /// from external storage. To avoid unnecessary deserialization of
1447     /// methods/nested types we allow deserialization of just the fields
1448     /// when needed.
1449     mutable uint64_t LoadedFieldsFromExternalStorage : 1;
1450
1451     /// Basic properties of non-trivial C structs.
1452     uint64_t NonTrivialToPrimitiveDefaultInitialize : 1;
1453     uint64_t NonTrivialToPrimitiveCopy : 1;
1454     uint64_t NonTrivialToPrimitiveDestroy : 1;
1455
1456     /// The following bits indicate whether this is or contains a C union that
1457     /// is non-trivial to default-initialize, destruct, or copy. These bits
1458     /// imply the associated basic non-triviality predicates declared above.
1459     uint64_t HasNonTrivialToPrimitiveDefaultInitializeCUnion : 1;
1460     uint64_t HasNonTrivialToPrimitiveDestructCUnion : 1;
1461     uint64_t HasNonTrivialToPrimitiveCopyCUnion : 1;
1462
1463     /// Indicates whether this struct is destroyed in the callee.
1464     uint64_t ParamDestroyedInCallee : 1;
1465
1466     /// Represents the way this type is passed to a function.
1467     uint64_t ArgPassingRestrictions : 2;
1468   };
1469
1470   /// Number of non-inherited bits in RecordDeclBitfields.
1471   enum { NumRecordDeclBits = 14 };
1472
1473   /// Stores the bits used by OMPDeclareReductionDecl.
1474   /// If modified NumOMPDeclareReductionDeclBits and the accessor
1475   /// methods in OMPDeclareReductionDecl should be updated appropriately.
1476   class OMPDeclareReductionDeclBitfields {
1477     friend class OMPDeclareReductionDecl;
1478     /// For the bits in DeclContextBitfields
1479     uint64_t : NumDeclContextBits;
1480
1481     /// Kind of initializer,
1482     /// function call or omp_priv<init_expr> initializtion.
1483     uint64_t InitializerKind : 2;
1484   };
1485
1486   /// Number of non-inherited bits in OMPDeclareReductionDeclBitfields.
1487   enum { NumOMPDeclareReductionDeclBits = 2 };
1488
1489   /// Stores the bits used by FunctionDecl.
1490   /// If modified NumFunctionDeclBits and the accessor
1491   /// methods in FunctionDecl and CXXDeductionGuideDecl
1492   /// (for IsCopyDeductionCandidate) should be updated appropriately.
1493   class FunctionDeclBitfields {
1494     friend class FunctionDecl;
1495     /// For IsCopyDeductionCandidate
1496     friend class CXXDeductionGuideDecl;
1497     /// For the bits in DeclContextBitfields.
1498     uint64_t : NumDeclContextBits;
1499
1500     uint64_t SClass : 3;
1501     uint64_t IsInline : 1;
1502     uint64_t IsInlineSpecified : 1;
1503
1504     uint64_t IsVirtualAsWritten : 1;
1505     uint64_t IsPure : 1;
1506     uint64_t HasInheritedPrototype : 1;
1507     uint64_t HasWrittenPrototype : 1;
1508     uint64_t IsDeleted : 1;
1509     /// Used by CXXMethodDecl
1510     uint64_t IsTrivial : 1;
1511
1512     /// This flag indicates whether this function is trivial for the purpose of
1513     /// calls. This is meaningful only when this function is a copy/move
1514     /// constructor or a destructor.
1515     uint64_t IsTrivialForCall : 1;
1516
1517     uint64_t IsDefaulted : 1;
1518     uint64_t IsExplicitlyDefaulted : 1;
1519     uint64_t HasDefaultedFunctionInfo : 1;
1520     uint64_t HasImplicitReturnZero : 1;
1521     uint64_t IsLateTemplateParsed : 1;
1522
1523     /// Kind of contexpr specifier as defined by ConstexprSpecKind.
1524     uint64_t ConstexprKind : 2;
1525     uint64_t InstantiationIsPending : 1;
1526
1527     /// Indicates if the function uses __try.
1528     uint64_t UsesSEHTry : 1;
1529
1530     /// Indicates if the function was a definition
1531     /// but its body was skipped.
1532     uint64_t HasSkippedBody : 1;
1533
1534     /// Indicates if the function declaration will
1535     /// have a body, once we're done parsing it.
1536     uint64_t WillHaveBody : 1;
1537
1538     /// Indicates that this function is a multiversioned
1539     /// function using attribute 'target'.
1540     uint64_t IsMultiVersion : 1;
1541
1542     /// [C++17] Only used by CXXDeductionGuideDecl. Indicates that
1543     /// the Deduction Guide is the implicitly generated 'copy
1544     /// deduction candidate' (is used during overload resolution).
1545     uint64_t IsCopyDeductionCandidate : 1;
1546
1547     /// Store the ODRHash after first calculation.
1548     uint64_t HasODRHash : 1;
1549
1550     /// Indicates if the function uses Floating Point Constrained Intrinsics
1551     uint64_t UsesFPIntrin : 1;
1552   };
1553
1554   /// Number of non-inherited bits in FunctionDeclBitfields.
1555   enum { NumFunctionDeclBits = 27 };
1556
1557   /// Stores the bits used by CXXConstructorDecl. If modified
1558   /// NumCXXConstructorDeclBits and the accessor
1559   /// methods in CXXConstructorDecl should be updated appropriately.
1560   class CXXConstructorDeclBitfields {
1561     friend class CXXConstructorDecl;
1562     /// For the bits in DeclContextBitfields.
1563     uint64_t : NumDeclContextBits;
1564     /// For the bits in FunctionDeclBitfields.
1565     uint64_t : NumFunctionDeclBits;
1566
1567     /// 24 bits to fit in the remaining available space.
1568     /// Note that this makes CXXConstructorDeclBitfields take
1569     /// exactly 64 bits and thus the width of NumCtorInitializers
1570     /// will need to be shrunk if some bit is added to NumDeclContextBitfields,
1571     /// NumFunctionDeclBitfields or CXXConstructorDeclBitfields.
1572     uint64_t NumCtorInitializers : 21;
1573     uint64_t IsInheritingConstructor : 1;
1574
1575     /// Whether this constructor has a trail-allocated explicit specifier.
1576     uint64_t HasTrailingExplicitSpecifier : 1;
1577     /// If this constructor does't have a trail-allocated explicit specifier.
1578     /// Whether this constructor is explicit specified.
1579     uint64_t IsSimpleExplicit : 1;
1580   };
1581
1582   /// Number of non-inherited bits in CXXConstructorDeclBitfields.
1583   enum {
1584     NumCXXConstructorDeclBits = 64 - NumDeclContextBits - NumFunctionDeclBits
1585   };
1586
1587   /// Stores the bits used by ObjCMethodDecl.
1588   /// If modified NumObjCMethodDeclBits and the accessor
1589   /// methods in ObjCMethodDecl should be updated appropriately.
1590   class ObjCMethodDeclBitfields {
1591     friend class ObjCMethodDecl;
1592
1593     /// For the bits in DeclContextBitfields.
1594     uint64_t : NumDeclContextBits;
1595
1596     /// The conventional meaning of this method; an ObjCMethodFamily.
1597     /// This is not serialized; instead, it is computed on demand and
1598     /// cached.
1599     mutable uint64_t Family : ObjCMethodFamilyBitWidth;
1600
1601     /// instance (true) or class (false) method.
1602     uint64_t IsInstance : 1;
1603     uint64_t IsVariadic : 1;
1604
1605     /// True if this method is the getter or setter for an explicit property.
1606     uint64_t IsPropertyAccessor : 1;
1607
1608     /// True if this method is a synthesized property accessor stub.
1609     uint64_t IsSynthesizedAccessorStub : 1;
1610
1611     /// Method has a definition.
1612     uint64_t IsDefined : 1;
1613
1614     /// Method redeclaration in the same interface.
1615     uint64_t IsRedeclaration : 1;
1616
1617     /// Is redeclared in the same interface.
1618     mutable uint64_t HasRedeclaration : 1;
1619
1620     /// \@required/\@optional
1621     uint64_t DeclImplementation : 2;
1622
1623     /// in, inout, etc.
1624     uint64_t objcDeclQualifier : 7;
1625
1626     /// Indicates whether this method has a related result type.
1627     uint64_t RelatedResultType : 1;
1628
1629     /// Whether the locations of the selector identifiers are in a
1630     /// "standard" position, a enum SelectorLocationsKind.
1631     uint64_t SelLocsKind : 2;
1632
1633     /// Whether this method overrides any other in the class hierarchy.
1634     ///
1635     /// A method is said to override any method in the class's
1636     /// base classes, its protocols, or its categories' protocols, that has
1637     /// the same selector and is of the same kind (class or instance).
1638     /// A method in an implementation is not considered as overriding the same
1639     /// method in the interface or its categories.
1640     uint64_t IsOverriding : 1;
1641
1642     /// Indicates if the method was a definition but its body was skipped.
1643     uint64_t HasSkippedBody : 1;
1644   };
1645
1646   /// Number of non-inherited bits in ObjCMethodDeclBitfields.
1647   enum { NumObjCMethodDeclBits = 24 };
1648
1649   /// Stores the bits used by ObjCContainerDecl.
1650   /// If modified NumObjCContainerDeclBits and the accessor
1651   /// methods in ObjCContainerDecl should be updated appropriately.
1652   class ObjCContainerDeclBitfields {
1653     friend class ObjCContainerDecl;
1654     /// For the bits in DeclContextBitfields
1655     uint32_t : NumDeclContextBits;
1656
1657     // Not a bitfield but this saves space.
1658     // Note that ObjCContainerDeclBitfields is full.
1659     SourceLocation AtStart;
1660   };
1661
1662   /// Number of non-inherited bits in ObjCContainerDeclBitfields.
1663   /// Note that here we rely on the fact that SourceLocation is 32 bits
1664   /// wide. We check this with the static_assert in the ctor of DeclContext.
1665   enum { NumObjCContainerDeclBits = 64 - NumDeclContextBits };
1666
1667   /// Stores the bits used by LinkageSpecDecl.
1668   /// If modified NumLinkageSpecDeclBits and the accessor
1669   /// methods in LinkageSpecDecl should be updated appropriately.
1670   class LinkageSpecDeclBitfields {
1671     friend class LinkageSpecDecl;
1672     /// For the bits in DeclContextBitfields.
1673     uint64_t : NumDeclContextBits;
1674
1675     /// The language for this linkage specification with values
1676     /// in the enum LinkageSpecDecl::LanguageIDs.
1677     uint64_t Language : 3;
1678
1679     /// True if this linkage spec has braces.
1680     /// This is needed so that hasBraces() returns the correct result while the
1681     /// linkage spec body is being parsed.  Once RBraceLoc has been set this is
1682     /// not used, so it doesn't need to be serialized.
1683     uint64_t HasBraces : 1;
1684   };
1685
1686   /// Number of non-inherited bits in LinkageSpecDeclBitfields.
1687   enum { NumLinkageSpecDeclBits = 4 };
1688
1689   /// Stores the bits used by BlockDecl.
1690   /// If modified NumBlockDeclBits and the accessor
1691   /// methods in BlockDecl should be updated appropriately.
1692   class BlockDeclBitfields {
1693     friend class BlockDecl;
1694     /// For the bits in DeclContextBitfields.
1695     uint64_t : NumDeclContextBits;
1696
1697     uint64_t IsVariadic : 1;
1698     uint64_t CapturesCXXThis : 1;
1699     uint64_t BlockMissingReturnType : 1;
1700     uint64_t IsConversionFromLambda : 1;
1701
1702     /// A bit that indicates this block is passed directly to a function as a
1703     /// non-escaping parameter.
1704     uint64_t DoesNotEscape : 1;
1705
1706     /// A bit that indicates whether it's possible to avoid coying this block to
1707     /// the heap when it initializes or is assigned to a local variable with
1708     /// automatic storage.
1709     uint64_t CanAvoidCopyToHeap : 1;
1710   };
1711
1712   /// Number of non-inherited bits in BlockDeclBitfields.
1713   enum { NumBlockDeclBits = 5 };
1714
1715   /// Pointer to the data structure used to lookup declarations
1716   /// within this context (or a DependentStoredDeclsMap if this is a
1717   /// dependent context). We maintain the invariant that, if the map
1718   /// contains an entry for a DeclarationName (and we haven't lazily
1719   /// omitted anything), then it contains all relevant entries for that
1720   /// name (modulo the hasExternalDecls() flag).
1721   mutable StoredDeclsMap *LookupPtr = nullptr;
1722
1723 protected:
1724   /// This anonymous union stores the bits belonging to DeclContext and classes
1725   /// deriving from it. The goal is to use otherwise wasted
1726   /// space in DeclContext to store data belonging to derived classes.
1727   /// The space saved is especially significient when pointers are aligned
1728   /// to 8 bytes. In this case due to alignment requirements we have a
1729   /// little less than 8 bytes free in DeclContext which we can use.
1730   /// We check that none of the classes in this union is larger than
1731   /// 8 bytes with static_asserts in the ctor of DeclContext.
1732   union {
1733     DeclContextBitfields DeclContextBits;
1734     TagDeclBitfields TagDeclBits;
1735     EnumDeclBitfields EnumDeclBits;
1736     RecordDeclBitfields RecordDeclBits;
1737     OMPDeclareReductionDeclBitfields OMPDeclareReductionDeclBits;
1738     FunctionDeclBitfields FunctionDeclBits;
1739     CXXConstructorDeclBitfields CXXConstructorDeclBits;
1740     ObjCMethodDeclBitfields ObjCMethodDeclBits;
1741     ObjCContainerDeclBitfields ObjCContainerDeclBits;
1742     LinkageSpecDeclBitfields LinkageSpecDeclBits;
1743     BlockDeclBitfields BlockDeclBits;
1744
1745     static_assert(sizeof(DeclContextBitfields) <= 8,
1746                   "DeclContextBitfields is larger than 8 bytes!");
1747     static_assert(sizeof(TagDeclBitfields) <= 8,
1748                   "TagDeclBitfields is larger than 8 bytes!");
1749     static_assert(sizeof(EnumDeclBitfields) <= 8,
1750                   "EnumDeclBitfields is larger than 8 bytes!");
1751     static_assert(sizeof(RecordDeclBitfields) <= 8,
1752                   "RecordDeclBitfields is larger than 8 bytes!");
1753     static_assert(sizeof(OMPDeclareReductionDeclBitfields) <= 8,
1754                   "OMPDeclareReductionDeclBitfields is larger than 8 bytes!");
1755     static_assert(sizeof(FunctionDeclBitfields) <= 8,
1756                   "FunctionDeclBitfields is larger than 8 bytes!");
1757     static_assert(sizeof(CXXConstructorDeclBitfields) <= 8,
1758                   "CXXConstructorDeclBitfields is larger than 8 bytes!");
1759     static_assert(sizeof(ObjCMethodDeclBitfields) <= 8,
1760                   "ObjCMethodDeclBitfields is larger than 8 bytes!");
1761     static_assert(sizeof(ObjCContainerDeclBitfields) <= 8,
1762                   "ObjCContainerDeclBitfields is larger than 8 bytes!");
1763     static_assert(sizeof(LinkageSpecDeclBitfields) <= 8,
1764                   "LinkageSpecDeclBitfields is larger than 8 bytes!");
1765     static_assert(sizeof(BlockDeclBitfields) <= 8,
1766                   "BlockDeclBitfields is larger than 8 bytes!");
1767   };
1768
1769   /// FirstDecl - The first declaration stored within this declaration
1770   /// context.
1771   mutable Decl *FirstDecl = nullptr;
1772
1773   /// LastDecl - The last declaration stored within this declaration
1774   /// context. FIXME: We could probably cache this value somewhere
1775   /// outside of the DeclContext, to reduce the size of DeclContext by
1776   /// another pointer.
1777   mutable Decl *LastDecl = nullptr;
1778
1779   /// Build up a chain of declarations.
1780   ///
1781   /// \returns the first/last pair of declarations.
1782   static std::pair<Decl *, Decl *>
1783   BuildDeclChain(ArrayRef<Decl*> Decls, bool FieldsAlreadyLoaded);
1784
1785   DeclContext(Decl::Kind K);
1786
1787 public:
1788   ~DeclContext();
1789
1790   Decl::Kind getDeclKind() const {
1791     return static_cast<Decl::Kind>(DeclContextBits.DeclKind);
1792   }
1793
1794   const char *getDeclKindName() const;
1795
1796   /// getParent - Returns the containing DeclContext.
1797   DeclContext *getParent() {
1798     return cast<Decl>(this)->getDeclContext();
1799   }
1800   const DeclContext *getParent() const {
1801     return const_cast<DeclContext*>(this)->getParent();
1802   }
1803
1804   /// getLexicalParent - Returns the containing lexical DeclContext. May be
1805   /// different from getParent, e.g.:
1806   ///
1807   ///   namespace A {
1808   ///      struct S;
1809   ///   }
1810   ///   struct A::S {}; // getParent() == namespace 'A'
1811   ///                   // getLexicalParent() == translation unit
1812   ///
1813   DeclContext *getLexicalParent() {
1814     return cast<Decl>(this)->getLexicalDeclContext();
1815   }
1816   const DeclContext *getLexicalParent() const {
1817     return const_cast<DeclContext*>(this)->getLexicalParent();
1818   }
1819
1820   DeclContext *getLookupParent();
1821
1822   const DeclContext *getLookupParent() const {
1823     return const_cast<DeclContext*>(this)->getLookupParent();
1824   }
1825
1826   ASTContext &getParentASTContext() const {
1827     return cast<Decl>(this)->getASTContext();
1828   }
1829
1830   bool isClosure() const { return getDeclKind() == Decl::Block; }
1831
1832   /// Return this DeclContext if it is a BlockDecl. Otherwise, return the
1833   /// innermost enclosing BlockDecl or null if there are no enclosing blocks.
1834   const BlockDecl *getInnermostBlockDecl() const;
1835
1836   bool isObjCContainer() const {
1837     switch (getDeclKind()) {
1838     case Decl::ObjCCategory:
1839     case Decl::ObjCCategoryImpl:
1840     case Decl::ObjCImplementation:
1841     case Decl::ObjCInterface:
1842     case Decl::ObjCProtocol:
1843       return true;
1844     default:
1845       return false;
1846     }
1847   }
1848
1849   bool isFunctionOrMethod() const {
1850     switch (getDeclKind()) {
1851     case Decl::Block:
1852     case Decl::Captured:
1853     case Decl::ObjCMethod:
1854       return true;
1855     default:
1856       return getDeclKind() >= Decl::firstFunction &&
1857              getDeclKind() <= Decl::lastFunction;
1858     }
1859   }
1860
1861   /// Test whether the context supports looking up names.
1862   bool isLookupContext() const {
1863     return !isFunctionOrMethod() && getDeclKind() != Decl::LinkageSpec &&
1864            getDeclKind() != Decl::Export;
1865   }
1866
1867   bool isFileContext() const {
1868     return getDeclKind() == Decl::TranslationUnit ||
1869            getDeclKind() == Decl::Namespace;
1870   }
1871
1872   bool isTranslationUnit() const {
1873     return getDeclKind() == Decl::TranslationUnit;
1874   }
1875
1876   bool isRecord() const {
1877     return getDeclKind() >= Decl::firstRecord &&
1878            getDeclKind() <= Decl::lastRecord;
1879   }
1880
1881   bool isNamespace() const { return getDeclKind() == Decl::Namespace; }
1882
1883   bool isStdNamespace() const;
1884
1885   bool isInlineNamespace() const;
1886
1887   /// Determines whether this context is dependent on a
1888   /// template parameter.
1889   bool isDependentContext() const;
1890
1891   /// isTransparentContext - Determines whether this context is a
1892   /// "transparent" context, meaning that the members declared in this
1893   /// context are semantically declared in the nearest enclosing
1894   /// non-transparent (opaque) context but are lexically declared in
1895   /// this context. For example, consider the enumerators of an
1896   /// enumeration type:
1897   /// @code
1898   /// enum E {
1899   ///   Val1
1900   /// };
1901   /// @endcode
1902   /// Here, E is a transparent context, so its enumerator (Val1) will
1903   /// appear (semantically) that it is in the same context of E.
1904   /// Examples of transparent contexts include: enumerations (except for
1905   /// C++0x scoped enums), and C++ linkage specifications.
1906   bool isTransparentContext() const;
1907
1908   /// Determines whether this context or some of its ancestors is a
1909   /// linkage specification context that specifies C linkage.
1910   bool isExternCContext() const;
1911
1912   /// Retrieve the nearest enclosing C linkage specification context.
1913   const LinkageSpecDecl *getExternCContext() const;
1914
1915   /// Determines whether this context or some of its ancestors is a
1916   /// linkage specification context that specifies C++ linkage.
1917   bool isExternCXXContext() const;
1918
1919   /// Determine whether this declaration context is equivalent
1920   /// to the declaration context DC.
1921   bool Equals(const DeclContext *DC) const {
1922     return DC && this->getPrimaryContext() == DC->getPrimaryContext();
1923   }
1924
1925   /// Determine whether this declaration context encloses the
1926   /// declaration context DC.
1927   bool Encloses(const DeclContext *DC) const;
1928
1929   /// Find the nearest non-closure ancestor of this context,
1930   /// i.e. the innermost semantic parent of this context which is not
1931   /// a closure.  A context may be its own non-closure ancestor.
1932   Decl *getNonClosureAncestor();
1933   const Decl *getNonClosureAncestor() const {
1934     return const_cast<DeclContext*>(this)->getNonClosureAncestor();
1935   }
1936
1937   /// getPrimaryContext - There may be many different
1938   /// declarations of the same entity (including forward declarations
1939   /// of classes, multiple definitions of namespaces, etc.), each with
1940   /// a different set of declarations. This routine returns the
1941   /// "primary" DeclContext structure, which will contain the
1942   /// information needed to perform name lookup into this context.
1943   DeclContext *getPrimaryContext();
1944   const DeclContext *getPrimaryContext() const {
1945     return const_cast<DeclContext*>(this)->getPrimaryContext();
1946   }
1947
1948   /// getRedeclContext - Retrieve the context in which an entity conflicts with
1949   /// other entities of the same name, or where it is a redeclaration if the
1950   /// two entities are compatible. This skips through transparent contexts.
1951   DeclContext *getRedeclContext();
1952   const DeclContext *getRedeclContext() const {
1953     return const_cast<DeclContext *>(this)->getRedeclContext();
1954   }
1955
1956   /// Retrieve the nearest enclosing namespace context.
1957   DeclContext *getEnclosingNamespaceContext();
1958   const DeclContext *getEnclosingNamespaceContext() const {
1959     return const_cast<DeclContext *>(this)->getEnclosingNamespaceContext();
1960   }
1961
1962   /// Retrieve the outermost lexically enclosing record context.
1963   RecordDecl *getOuterLexicalRecordContext();
1964   const RecordDecl *getOuterLexicalRecordContext() const {
1965     return const_cast<DeclContext *>(this)->getOuterLexicalRecordContext();
1966   }
1967
1968   /// Test if this context is part of the enclosing namespace set of
1969   /// the context NS, as defined in C++0x [namespace.def]p9. If either context
1970   /// isn't a namespace, this is equivalent to Equals().
1971   ///
1972   /// The enclosing namespace set of a namespace is the namespace and, if it is
1973   /// inline, its enclosing namespace, recursively.
1974   bool InEnclosingNamespaceSetOf(const DeclContext *NS) const;
1975
1976   /// Collects all of the declaration contexts that are semantically
1977   /// connected to this declaration context.
1978   ///
1979   /// For declaration contexts that have multiple semantically connected but
1980   /// syntactically distinct contexts, such as C++ namespaces, this routine
1981   /// retrieves the complete set of such declaration contexts in source order.
1982   /// For example, given:
1983   ///
1984   /// \code
1985   /// namespace N {
1986   ///   int x;
1987   /// }
1988   /// namespace N {
1989   ///   int y;
1990   /// }
1991   /// \endcode
1992   ///
1993   /// The \c Contexts parameter will contain both definitions of N.
1994   ///
1995   /// \param Contexts Will be cleared and set to the set of declaration
1996   /// contexts that are semanticaly connected to this declaration context,
1997   /// in source order, including this context (which may be the only result,
1998   /// for non-namespace contexts).
1999   void collectAllContexts(SmallVectorImpl<DeclContext *> &Contexts);
2000
2001   /// decl_iterator - Iterates through the declarations stored
2002   /// within this context.
2003   class decl_iterator {
2004     /// Current - The current declaration.
2005     Decl *Current = nullptr;
2006
2007   public:
2008     using value_type = Decl *;
2009     using reference = const value_type &;
2010     using pointer = const value_type *;
2011     using iterator_category = std::forward_iterator_tag;
2012     using difference_type = std::ptrdiff_t;
2013
2014     decl_iterator() = default;
2015     explicit decl_iterator(Decl *C) : Current(C) {}
2016
2017     reference operator*() const { return Current; }
2018
2019     // This doesn't meet the iterator requirements, but it's convenient
2020     value_type operator->() const { return Current; }
2021
2022     decl_iterator& operator++() {
2023       Current = Current->getNextDeclInContext();
2024       return *this;
2025     }
2026
2027     decl_iterator operator++(int) {
2028       decl_iterator tmp(*this);
2029       ++(*this);
2030       return tmp;
2031     }
2032
2033     friend bool operator==(decl_iterator x, decl_iterator y) {
2034       return x.Current == y.Current;
2035     }
2036
2037     friend bool operator!=(decl_iterator x, decl_iterator y) {
2038       return x.Current != y.Current;
2039     }
2040   };
2041
2042   using decl_range = llvm::iterator_range<decl_iterator>;
2043
2044   /// decls_begin/decls_end - Iterate over the declarations stored in
2045   /// this context.
2046   decl_range decls() const { return decl_range(decls_begin(), decls_end()); }
2047   decl_iterator decls_begin() const;
2048   decl_iterator decls_end() const { return decl_iterator(); }
2049   bool decls_empty() const;
2050
2051   /// noload_decls_begin/end - Iterate over the declarations stored in this
2052   /// context that are currently loaded; don't attempt to retrieve anything
2053   /// from an external source.
2054   decl_range noload_decls() const {
2055     return decl_range(noload_decls_begin(), noload_decls_end());
2056   }
2057   decl_iterator noload_decls_begin() const { return decl_iterator(FirstDecl); }
2058   decl_iterator noload_decls_end() const { return decl_iterator(); }
2059
2060   /// specific_decl_iterator - Iterates over a subrange of
2061   /// declarations stored in a DeclContext, providing only those that
2062   /// are of type SpecificDecl (or a class derived from it). This
2063   /// iterator is used, for example, to provide iteration over just
2064   /// the fields within a RecordDecl (with SpecificDecl = FieldDecl).
2065   template<typename SpecificDecl>
2066   class specific_decl_iterator {
2067     /// Current - The current, underlying declaration iterator, which
2068     /// will either be NULL or will point to a declaration of
2069     /// type SpecificDecl.
2070     DeclContext::decl_iterator Current;
2071
2072     /// SkipToNextDecl - Advances the current position up to the next
2073     /// declaration of type SpecificDecl that also meets the criteria
2074     /// required by Acceptable.
2075     void SkipToNextDecl() {
2076       while (*Current && !isa<SpecificDecl>(*Current))
2077         ++Current;
2078     }
2079
2080   public:
2081     using value_type = SpecificDecl *;
2082     // TODO: Add reference and pointer types (with some appropriate proxy type)
2083     // if we ever have a need for them.
2084     using reference = void;
2085     using pointer = void;
2086     using difference_type =
2087         std::iterator_traits<DeclContext::decl_iterator>::difference_type;
2088     using iterator_category = std::forward_iterator_tag;
2089
2090     specific_decl_iterator() = default;
2091
2092     /// specific_decl_iterator - Construct a new iterator over a
2093     /// subset of the declarations the range [C,
2094     /// end-of-declarations). If A is non-NULL, it is a pointer to a
2095     /// member function of SpecificDecl that should return true for
2096     /// all of the SpecificDecl instances that will be in the subset
2097     /// of iterators. For example, if you want Objective-C instance
2098     /// methods, SpecificDecl will be ObjCMethodDecl and A will be
2099     /// &ObjCMethodDecl::isInstanceMethod.
2100     explicit specific_decl_iterator(DeclContext::decl_iterator C) : Current(C) {
2101       SkipToNextDecl();
2102     }
2103
2104     value_type operator*() const { return cast<SpecificDecl>(*Current); }
2105
2106     // This doesn't meet the iterator requirements, but it's convenient
2107     value_type operator->() const { return **this; }
2108
2109     specific_decl_iterator& operator++() {
2110       ++Current;
2111       SkipToNextDecl();
2112       return *this;
2113     }
2114
2115     specific_decl_iterator operator++(int) {
2116       specific_decl_iterator tmp(*this);
2117       ++(*this);
2118       return tmp;
2119     }
2120
2121     friend bool operator==(const specific_decl_iterator& x,
2122                            const specific_decl_iterator& y) {
2123       return x.Current == y.Current;
2124     }
2125
2126     friend bool operator!=(const specific_decl_iterator& x,
2127                            const specific_decl_iterator& y) {
2128       return x.Current != y.Current;
2129     }
2130   };
2131
2132   /// Iterates over a filtered subrange of declarations stored
2133   /// in a DeclContext.
2134   ///
2135   /// This iterator visits only those declarations that are of type
2136   /// SpecificDecl (or a class derived from it) and that meet some
2137   /// additional run-time criteria. This iterator is used, for
2138   /// example, to provide access to the instance methods within an
2139   /// Objective-C interface (with SpecificDecl = ObjCMethodDecl and
2140   /// Acceptable = ObjCMethodDecl::isInstanceMethod).
2141   template<typename SpecificDecl, bool (SpecificDecl::*Acceptable)() const>
2142   class filtered_decl_iterator {
2143     /// Current - The current, underlying declaration iterator, which
2144     /// will either be NULL or will point to a declaration of
2145     /// type SpecificDecl.
2146     DeclContext::decl_iterator Current;
2147
2148     /// SkipToNextDecl - Advances the current position up to the next
2149     /// declaration of type SpecificDecl that also meets the criteria
2150     /// required by Acceptable.
2151     void SkipToNextDecl() {
2152       while (*Current &&
2153              (!isa<SpecificDecl>(*Current) ||
2154               (Acceptable && !(cast<SpecificDecl>(*Current)->*Acceptable)())))
2155         ++Current;
2156     }
2157
2158   public:
2159     using value_type = SpecificDecl *;
2160     // TODO: Add reference and pointer types (with some appropriate proxy type)
2161     // if we ever have a need for them.
2162     using reference = void;
2163     using pointer = void;
2164     using difference_type =
2165         std::iterator_traits<DeclContext::decl_iterator>::difference_type;
2166     using iterator_category = std::forward_iterator_tag;
2167
2168     filtered_decl_iterator() = default;
2169
2170     /// filtered_decl_iterator - Construct a new iterator over a
2171     /// subset of the declarations the range [C,
2172     /// end-of-declarations). If A is non-NULL, it is a pointer to a
2173     /// member function of SpecificDecl that should return true for
2174     /// all of the SpecificDecl instances that will be in the subset
2175     /// of iterators. For example, if you want Objective-C instance
2176     /// methods, SpecificDecl will be ObjCMethodDecl and A will be
2177     /// &ObjCMethodDecl::isInstanceMethod.
2178     explicit filtered_decl_iterator(DeclContext::decl_iterator C) : Current(C) {
2179       SkipToNextDecl();
2180     }
2181
2182     value_type operator*() const { return cast<SpecificDecl>(*Current); }
2183     value_type operator->() const { return cast<SpecificDecl>(*Current); }
2184
2185     filtered_decl_iterator& operator++() {
2186       ++Current;
2187       SkipToNextDecl();
2188       return *this;
2189     }
2190
2191     filtered_decl_iterator operator++(int) {
2192       filtered_decl_iterator tmp(*this);
2193       ++(*this);
2194       return tmp;
2195     }
2196
2197     friend bool operator==(const filtered_decl_iterator& x,
2198                            const filtered_decl_iterator& y) {
2199       return x.Current == y.Current;
2200     }
2201
2202     friend bool operator!=(const filtered_decl_iterator& x,
2203                            const filtered_decl_iterator& y) {
2204       return x.Current != y.Current;
2205     }
2206   };
2207
2208   /// Add the declaration D into this context.
2209   ///
2210   /// This routine should be invoked when the declaration D has first
2211   /// been declared, to place D into the context where it was
2212   /// (lexically) defined. Every declaration must be added to one
2213   /// (and only one!) context, where it can be visited via
2214   /// [decls_begin(), decls_end()). Once a declaration has been added
2215   /// to its lexical context, the corresponding DeclContext owns the
2216   /// declaration.
2217   ///
2218   /// If D is also a NamedDecl, it will be made visible within its
2219   /// semantic context via makeDeclVisibleInContext.
2220   void addDecl(Decl *D);
2221
2222   /// Add the declaration D into this context, but suppress
2223   /// searches for external declarations with the same name.
2224   ///
2225   /// Although analogous in function to addDecl, this removes an
2226   /// important check.  This is only useful if the Decl is being
2227   /// added in response to an external search; in all other cases,
2228   /// addDecl() is the right function to use.
2229   /// See the ASTImporter for use cases.
2230   void addDeclInternal(Decl *D);
2231
2232   /// Add the declaration D to this context without modifying
2233   /// any lookup tables.
2234   ///
2235   /// This is useful for some operations in dependent contexts where
2236   /// the semantic context might not be dependent;  this basically
2237   /// only happens with friends.
2238   void addHiddenDecl(Decl *D);
2239
2240   /// Removes a declaration from this context.
2241   void removeDecl(Decl *D);
2242
2243   /// Checks whether a declaration is in this context.
2244   bool containsDecl(Decl *D) const;
2245
2246   /// Checks whether a declaration is in this context.
2247   /// This also loads the Decls from the external source before the check.
2248   bool containsDeclAndLoad(Decl *D) const;
2249
2250   using lookup_result = DeclContextLookupResult;
2251   using lookup_iterator = lookup_result::iterator;
2252
2253   /// lookup - Find the declarations (if any) with the given Name in
2254   /// this context. Returns a range of iterators that contains all of
2255   /// the declarations with this name, with object, function, member,
2256   /// and enumerator names preceding any tag name. Note that this
2257   /// routine will not look into parent contexts.
2258   lookup_result lookup(DeclarationName Name) const;
2259
2260   /// Find the declarations with the given name that are visible
2261   /// within this context; don't attempt to retrieve anything from an
2262   /// external source.
2263   lookup_result noload_lookup(DeclarationName Name);
2264
2265   /// A simplistic name lookup mechanism that performs name lookup
2266   /// into this declaration context without consulting the external source.
2267   ///
2268   /// This function should almost never be used, because it subverts the
2269   /// usual relationship between a DeclContext and the external source.
2270   /// See the ASTImporter for the (few, but important) use cases.
2271   ///
2272   /// FIXME: This is very inefficient; replace uses of it with uses of
2273   /// noload_lookup.
2274   void localUncachedLookup(DeclarationName Name,
2275                            SmallVectorImpl<NamedDecl *> &Results);
2276
2277   /// Makes a declaration visible within this context.
2278   ///
2279   /// This routine makes the declaration D visible to name lookup
2280   /// within this context and, if this is a transparent context,
2281   /// within its parent contexts up to the first enclosing
2282   /// non-transparent context. Making a declaration visible within a
2283   /// context does not transfer ownership of a declaration, and a
2284   /// declaration can be visible in many contexts that aren't its
2285   /// lexical context.
2286   ///
2287   /// If D is a redeclaration of an existing declaration that is
2288   /// visible from this context, as determined by
2289   /// NamedDecl::declarationReplaces, the previous declaration will be
2290   /// replaced with D.
2291   void makeDeclVisibleInContext(NamedDecl *D);
2292
2293   /// all_lookups_iterator - An iterator that provides a view over the results
2294   /// of looking up every possible name.
2295   class all_lookups_iterator;
2296
2297   using lookups_range = llvm::iterator_range<all_lookups_iterator>;
2298
2299   lookups_range lookups() const;
2300   // Like lookups(), but avoids loading external declarations.
2301   // If PreserveInternalState, avoids building lookup data structures too.
2302   lookups_range noload_lookups(bool PreserveInternalState) const;
2303
2304   /// Iterators over all possible lookups within this context.
2305   all_lookups_iterator lookups_begin() const;
2306   all_lookups_iterator lookups_end() const;
2307
2308   /// Iterators over all possible lookups within this context that are
2309   /// currently loaded; don't attempt to retrieve anything from an external
2310   /// source.
2311   all_lookups_iterator noload_lookups_begin() const;
2312   all_lookups_iterator noload_lookups_end() const;
2313
2314   struct udir_iterator;
2315
2316   using udir_iterator_base =
2317       llvm::iterator_adaptor_base<udir_iterator, lookup_iterator,
2318                                   std::random_access_iterator_tag,
2319                                   UsingDirectiveDecl *>;
2320
2321   struct udir_iterator : udir_iterator_base {
2322     udir_iterator(lookup_iterator I) : udir_iterator_base(I) {}
2323
2324     UsingDirectiveDecl *operator*() const;
2325   };
2326
2327   using udir_range = llvm::iterator_range<udir_iterator>;
2328
2329   udir_range using_directives() const;
2330
2331   // These are all defined in DependentDiagnostic.h.
2332   class ddiag_iterator;
2333
2334   using ddiag_range = llvm::iterator_range<DeclContext::ddiag_iterator>;
2335
2336   inline ddiag_range ddiags() const;
2337
2338   // Low-level accessors
2339
2340   /// Mark that there are external lexical declarations that we need
2341   /// to include in our lookup table (and that are not available as external
2342   /// visible lookups). These extra lookup results will be found by walking
2343   /// the lexical declarations of this context. This should be used only if
2344   /// setHasExternalLexicalStorage() has been called on any decl context for
2345   /// which this is the primary context.
2346   void setMustBuildLookupTable() {
2347     assert(this == getPrimaryContext() &&
2348            "should only be called on primary context");
2349     DeclContextBits.HasLazyExternalLexicalLookups = true;
2350   }
2351
2352   /// Retrieve the internal representation of the lookup structure.
2353   /// This may omit some names if we are lazily building the structure.
2354   StoredDeclsMap *getLookupPtr() const { return LookupPtr; }
2355
2356   /// Ensure the lookup structure is fully-built and return it.
2357   StoredDeclsMap *buildLookup();
2358
2359   /// Whether this DeclContext has external storage containing
2360   /// additional declarations that are lexically in this context.
2361   bool hasExternalLexicalStorage() const {
2362     return DeclContextBits.ExternalLexicalStorage;
2363   }
2364
2365   /// State whether this DeclContext has external storage for
2366   /// declarations lexically in this context.
2367   void setHasExternalLexicalStorage(bool ES = true) const {
2368     DeclContextBits.ExternalLexicalStorage = ES;
2369   }
2370
2371   /// Whether this DeclContext has external storage containing
2372   /// additional declarations that are visible in this context.
2373   bool hasExternalVisibleStorage() const {
2374     return DeclContextBits.ExternalVisibleStorage;
2375   }
2376
2377   /// State whether this DeclContext has external storage for
2378   /// declarations visible in this context.
2379   void setHasExternalVisibleStorage(bool ES = true) const {
2380     DeclContextBits.ExternalVisibleStorage = ES;
2381     if (ES && LookupPtr)
2382       DeclContextBits.NeedToReconcileExternalVisibleStorage = true;
2383   }
2384
2385   /// Determine whether the given declaration is stored in the list of
2386   /// declarations lexically within this context.
2387   bool isDeclInLexicalTraversal(const Decl *D) const {
2388     return D && (D->NextInContextAndBits.getPointer() || D == FirstDecl ||
2389                  D == LastDecl);
2390   }
2391
2392   bool setUseQualifiedLookup(bool use = true) const {
2393     bool old_value = DeclContextBits.UseQualifiedLookup;
2394     DeclContextBits.UseQualifiedLookup = use;
2395     return old_value;
2396   }
2397
2398   bool shouldUseQualifiedLookup() const {
2399     return DeclContextBits.UseQualifiedLookup;
2400   }
2401
2402   static bool classof(const Decl *D);
2403   static bool classof(const DeclContext *D) { return true; }
2404
2405   void dumpDeclContext() const;
2406   void dumpLookups() const;
2407   void dumpLookups(llvm::raw_ostream &OS, bool DumpDecls = false,
2408                    bool Deserialize = false) const;
2409
2410 private:
2411   /// Whether this declaration context has had externally visible
2412   /// storage added since the last lookup. In this case, \c LookupPtr's
2413   /// invariant may not hold and needs to be fixed before we perform
2414   /// another lookup.
2415   bool hasNeedToReconcileExternalVisibleStorage() const {
2416     return DeclContextBits.NeedToReconcileExternalVisibleStorage;
2417   }
2418
2419   /// State that this declaration context has had externally visible
2420   /// storage added since the last lookup. In this case, \c LookupPtr's
2421   /// invariant may not hold and needs to be fixed before we perform
2422   /// another lookup.
2423   void setNeedToReconcileExternalVisibleStorage(bool Need = true) const {
2424     DeclContextBits.NeedToReconcileExternalVisibleStorage = Need;
2425   }
2426
2427   /// If \c true, this context may have local lexical declarations
2428   /// that are missing from the lookup table.
2429   bool hasLazyLocalLexicalLookups() const {
2430     return DeclContextBits.HasLazyLocalLexicalLookups;
2431   }
2432
2433   /// If \c true, this context may have local lexical declarations
2434   /// that are missing from the lookup table.
2435   void setHasLazyLocalLexicalLookups(bool HasLLLL = true) const {
2436     DeclContextBits.HasLazyLocalLexicalLookups = HasLLLL;
2437   }
2438
2439   /// If \c true, the external source may have lexical declarations
2440   /// that are missing from the lookup table.
2441   bool hasLazyExternalLexicalLookups() const {
2442     return DeclContextBits.HasLazyExternalLexicalLookups;
2443   }
2444
2445   /// If \c true, the external source may have lexical declarations
2446   /// that are missing from the lookup table.
2447   void setHasLazyExternalLexicalLookups(bool HasLELL = true) const {
2448     DeclContextBits.HasLazyExternalLexicalLookups = HasLELL;
2449   }
2450
2451   void reconcileExternalVisibleStorage() const;
2452   bool LoadLexicalDeclsFromExternalStorage() const;
2453
2454   /// Makes a declaration visible within this context, but
2455   /// suppresses searches for external declarations with the same
2456   /// name.
2457   ///
2458   /// Analogous to makeDeclVisibleInContext, but for the exclusive
2459   /// use of addDeclInternal().
2460   void makeDeclVisibleInContextInternal(NamedDecl *D);
2461
2462   StoredDeclsMap *CreateStoredDeclsMap(ASTContext &C) const;
2463
2464   void loadLazyLocalLexicalLookups();
2465   void buildLookupImpl(DeclContext *DCtx, bool Internal);
2466   void makeDeclVisibleInContextWithFlags(NamedDecl *D, bool Internal,
2467                                          bool Rediscoverable);
2468   void makeDeclVisibleInContextImpl(NamedDecl *D, bool Internal);
2469 };
2470
2471 inline bool Decl::isTemplateParameter() const {
2472   return getKind() == TemplateTypeParm || getKind() == NonTypeTemplateParm ||
2473          getKind() == TemplateTemplateParm;
2474 }
2475
2476 // Specialization selected when ToTy is not a known subclass of DeclContext.
2477 template <class ToTy,
2478           bool IsKnownSubtype = ::std::is_base_of<DeclContext, ToTy>::value>
2479 struct cast_convert_decl_context {
2480   static const ToTy *doit(const DeclContext *Val) {
2481     return static_cast<const ToTy*>(Decl::castFromDeclContext(Val));
2482   }
2483
2484   static ToTy *doit(DeclContext *Val) {
2485     return static_cast<ToTy*>(Decl::castFromDeclContext(Val));
2486   }
2487 };
2488
2489 // Specialization selected when ToTy is a known subclass of DeclContext.
2490 template <class ToTy>
2491 struct cast_convert_decl_context<ToTy, true> {
2492   static const ToTy *doit(const DeclContext *Val) {
2493     return static_cast<const ToTy*>(Val);
2494   }
2495
2496   static ToTy *doit(DeclContext *Val) {
2497     return static_cast<ToTy*>(Val);
2498   }
2499 };
2500
2501 } // namespace clang
2502
2503 namespace llvm {
2504
2505 /// isa<T>(DeclContext*)
2506 template <typename To>
2507 struct isa_impl<To, ::clang::DeclContext> {
2508   static bool doit(const ::clang::DeclContext &Val) {
2509     return To::classofKind(Val.getDeclKind());
2510   }
2511 };
2512
2513 /// cast<T>(DeclContext*)
2514 template<class ToTy>
2515 struct cast_convert_val<ToTy,
2516                         const ::clang::DeclContext,const ::clang::DeclContext> {
2517   static const ToTy &doit(const ::clang::DeclContext &Val) {
2518     return *::clang::cast_convert_decl_context<ToTy>::doit(&Val);
2519   }
2520 };
2521
2522 template<class ToTy>
2523 struct cast_convert_val<ToTy, ::clang::DeclContext, ::clang::DeclContext> {
2524   static ToTy &doit(::clang::DeclContext &Val) {
2525     return *::clang::cast_convert_decl_context<ToTy>::doit(&Val);
2526   }
2527 };
2528
2529 template<class ToTy>
2530 struct cast_convert_val<ToTy,
2531                      const ::clang::DeclContext*, const ::clang::DeclContext*> {
2532   static const ToTy *doit(const ::clang::DeclContext *Val) {
2533     return ::clang::cast_convert_decl_context<ToTy>::doit(Val);
2534   }
2535 };
2536
2537 template<class ToTy>
2538 struct cast_convert_val<ToTy, ::clang::DeclContext*, ::clang::DeclContext*> {
2539   static ToTy *doit(::clang::DeclContext *Val) {
2540     return ::clang::cast_convert_decl_context<ToTy>::doit(Val);
2541   }
2542 };
2543
2544 /// Implement cast_convert_val for Decl -> DeclContext conversions.
2545 template<class FromTy>
2546 struct cast_convert_val< ::clang::DeclContext, FromTy, FromTy> {
2547   static ::clang::DeclContext &doit(const FromTy &Val) {
2548     return *FromTy::castToDeclContext(&Val);
2549   }
2550 };
2551
2552 template<class FromTy>
2553 struct cast_convert_val< ::clang::DeclContext, FromTy*, FromTy*> {
2554   static ::clang::DeclContext *doit(const FromTy *Val) {
2555     return FromTy::castToDeclContext(Val);
2556   }
2557 };
2558
2559 template<class FromTy>
2560 struct cast_convert_val< const ::clang::DeclContext, FromTy, FromTy> {
2561   static const ::clang::DeclContext &doit(const FromTy &Val) {
2562     return *FromTy::castToDeclContext(&Val);
2563   }
2564 };
2565
2566 template<class FromTy>
2567 struct cast_convert_val< const ::clang::DeclContext, FromTy*, FromTy*> {
2568   static const ::clang::DeclContext *doit(const FromTy *Val) {
2569     return FromTy::castToDeclContext(Val);
2570   }
2571 };
2572
2573 } // namespace llvm
2574
2575 #endif // LLVM_CLANG_AST_DECLBASE_H