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