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