Home | History | Annotate | Download | only in AST
      1 //===-- DeclBase.h - Base Classes for representing declarations -*- C++ -*-===//
      2 //
      3 //                     The LLVM Compiler Infrastructure
      4 //
      5 // This file is distributed under the University of Illinois Open Source
      6 // License. See LICENSE.TXT for details.
      7 //
      8 //===----------------------------------------------------------------------===//
      9 //
     10 //  This file defines the Decl and DeclContext interfaces.
     11 //
     12 //===----------------------------------------------------------------------===//
     13 
     14 #ifndef LLVM_CLANG_AST_DECLBASE_H
     15 #define LLVM_CLANG_AST_DECLBASE_H
     16 
     17 #include "clang/AST/Attr.h"
     18 #include "clang/AST/Type.h"
     19 #include "clang/Basic/Specifiers.h"
     20 #include "llvm/ADT/PointerUnion.h"
     21 #include "llvm/Support/Compiler.h"
     22 #include "llvm/Support/PrettyStackTrace.h"
     23 
     24 namespace clang {
     25 class DeclContext;
     26 class TranslationUnitDecl;
     27 class NamespaceDecl;
     28 class UsingDirectiveDecl;
     29 class NamedDecl;
     30 class FunctionDecl;
     31 class CXXRecordDecl;
     32 class EnumDecl;
     33 class ObjCMethodDecl;
     34 class ObjCContainerDecl;
     35 class ObjCInterfaceDecl;
     36 class ObjCCategoryDecl;
     37 class ObjCProtocolDecl;
     38 class ObjCImplementationDecl;
     39 class ObjCCategoryImplDecl;
     40 class ObjCImplDecl;
     41 class LinkageSpecDecl;
     42 class BlockDecl;
     43 class DeclarationName;
     44 class CompoundStmt;
     45 class StoredDeclsMap;
     46 class DependentDiagnostic;
     47 class ASTMutationListener;
     48 }
     49 
     50 namespace llvm {
     51 // DeclContext* is only 4-byte aligned on 32-bit systems.
     52 template<>
     53   class PointerLikeTypeTraits<clang::DeclContext*> {
     54   typedef clang::DeclContext* PT;
     55 public:
     56   static inline void *getAsVoidPointer(PT P) { return P; }
     57   static inline PT getFromVoidPointer(void *P) {
     58     return static_cast<PT>(P);
     59   }
     60   enum { NumLowBitsAvailable = 2 };
     61 };
     62 }
     63 
     64 namespace clang {
     65 
     66   /// \brief Captures the result of checking the availability of a
     67   /// declaration.
     68   enum AvailabilityResult {
     69     AR_Available = 0,
     70     AR_NotYetIntroduced,
     71     AR_Deprecated,
     72     AR_Unavailable
     73   };
     74 
     75 /// Decl - This represents one declaration (or definition), e.g. a variable,
     76 /// typedef, function, struct, etc.
     77 ///
     78 class Decl {
     79 public:
     80   /// \brief Lists the kind of concrete classes of Decl.
     81   enum Kind {
     82 #define DECL(DERIVED, BASE) DERIVED,
     83 #define ABSTRACT_DECL(DECL)
     84 #define DECL_RANGE(BASE, START, END) \
     85         first##BASE = START, last##BASE = END,
     86 #define LAST_DECL_RANGE(BASE, START, END) \
     87         first##BASE = START, last##BASE = END
     88 #include "clang/AST/DeclNodes.inc"
     89   };
     90 
     91   /// \brief A placeholder type used to construct an empty shell of a
     92   /// decl-derived type that will be filled in later (e.g., by some
     93   /// deserialization method).
     94   struct EmptyShell { };
     95 
     96   /// IdentifierNamespace - The different namespaces in which
     97   /// declarations may appear.  According to C99 6.2.3, there are
     98   /// four namespaces, labels, tags, members and ordinary
     99   /// identifiers.  C++ describes lookup completely differently:
    100   /// certain lookups merely "ignore" certain kinds of declarations,
    101   /// usually based on whether the declaration is of a type, etc.
    102   ///
    103   /// These are meant as bitmasks, so that searches in
    104   /// C++ can look into the "tag" namespace during ordinary lookup.
    105   ///
    106   /// Decl currently provides 15 bits of IDNS bits.
    107   enum IdentifierNamespace {
    108     /// Labels, declared with 'x:' and referenced with 'goto x'.
    109     IDNS_Label               = 0x0001,
    110 
    111     /// Tags, declared with 'struct foo;' and referenced with
    112     /// 'struct foo'.  All tags are also types.  This is what
    113     /// elaborated-type-specifiers look for in C.
    114     IDNS_Tag                 = 0x0002,
    115 
    116     /// Types, declared with 'struct foo', typedefs, etc.
    117     /// This is what elaborated-type-specifiers look for in C++,
    118     /// but note that it's ill-formed to find a non-tag.
    119     IDNS_Type                = 0x0004,
    120 
    121     /// Members, declared with object declarations within tag
    122     /// definitions.  In C, these can only be found by "qualified"
    123     /// lookup in member expressions.  In C++, they're found by
    124     /// normal lookup.
    125     IDNS_Member              = 0x0008,
    126 
    127     /// Namespaces, declared with 'namespace foo {}'.
    128     /// Lookup for nested-name-specifiers find these.
    129     IDNS_Namespace           = 0x0010,
    130 
    131     /// Ordinary names.  In C, everything that's not a label, tag,
    132     /// or member ends up here.
    133     IDNS_Ordinary            = 0x0020,
    134 
    135     /// Objective C @protocol.
    136     IDNS_ObjCProtocol        = 0x0040,
    137 
    138     /// This declaration is a friend function.  A friend function
    139     /// declaration is always in this namespace but may also be in
    140     /// IDNS_Ordinary if it was previously declared.
    141     IDNS_OrdinaryFriend      = 0x0080,
    142 
    143     /// This declaration is a friend class.  A friend class
    144     /// declaration is always in this namespace but may also be in
    145     /// IDNS_Tag|IDNS_Type if it was previously declared.
    146     IDNS_TagFriend           = 0x0100,
    147 
    148     /// This declaration is a using declaration.  A using declaration
    149     /// *introduces* a number of other declarations into the current
    150     /// scope, and those declarations use the IDNS of their targets,
    151     /// but the actual using declarations go in this namespace.
    152     IDNS_Using               = 0x0200,
    153 
    154     /// This declaration is a C++ operator declared in a non-class
    155     /// context.  All such operators are also in IDNS_Ordinary.
    156     /// C++ lexical operator lookup looks for these.
    157     IDNS_NonMemberOperator   = 0x0400
    158   };
    159 
    160   /// ObjCDeclQualifier - 'Qualifiers' written next to the return and
    161   /// parameter types in method declarations.  Other than remembering
    162   /// them and mangling them into the method's signature string, these
    163   /// are ignored by the compiler; they are consumed by certain
    164   /// remote-messaging frameworks.
    165   ///
    166   /// in, inout, and out are mutually exclusive and apply only to
    167   /// method parameters.  bycopy and byref are mutually exclusive and
    168   /// apply only to method parameters (?).  oneway applies only to
    169   /// results.  All of these expect their corresponding parameter to
    170   /// have a particular type.  None of this is currently enforced by
    171   /// clang.
    172   ///
    173   /// This should be kept in sync with ObjCDeclSpec::ObjCDeclQualifier.
    174   enum ObjCDeclQualifier {
    175     OBJC_TQ_None = 0x0,
    176     OBJC_TQ_In = 0x1,
    177     OBJC_TQ_Inout = 0x2,
    178     OBJC_TQ_Out = 0x4,
    179     OBJC_TQ_Bycopy = 0x8,
    180     OBJC_TQ_Byref = 0x10,
    181     OBJC_TQ_Oneway = 0x20
    182   };
    183 
    184 protected:
    185   // Enumeration values used in the bits stored in NextInContextAndBits.
    186   enum {
    187     /// \brief Whether this declaration is a top-level declaration (function,
    188     /// global variable, etc.) that is lexically inside an objc container
    189     /// definition.
    190     TopLevelDeclInObjCContainerFlag = 0x01,
    191 
    192     /// \brief Whether this declaration is private to the module in which it was
    193     /// defined.
    194     ModulePrivateFlag = 0x02
    195   };
    196 
    197   /// \brief The next declaration within the same lexical
    198   /// DeclContext. These pointers form the linked list that is
    199   /// traversed via DeclContext's decls_begin()/decls_end().
    200   ///
    201   /// The extra two bits are used for the TopLevelDeclInObjCContainer and
    202   /// ModulePrivate bits.
    203   llvm::PointerIntPair<Decl *, 2, unsigned> NextInContextAndBits;
    204 
    205 private:
    206   friend class DeclContext;
    207 
    208   struct MultipleDC {
    209     DeclContext *SemanticDC;
    210     DeclContext *LexicalDC;
    211   };
    212 
    213 
    214   /// DeclCtx - Holds either a DeclContext* or a MultipleDC*.
    215   /// For declarations that don't contain C++ scope specifiers, it contains
    216   /// the DeclContext where the Decl was declared.
    217   /// For declarations with C++ scope specifiers, it contains a MultipleDC*
    218   /// with the context where it semantically belongs (SemanticDC) and the
    219   /// context where it was lexically declared (LexicalDC).
    220   /// e.g.:
    221   ///
    222   ///   namespace A {
    223   ///      void f(); // SemanticDC == LexicalDC == 'namespace A'
    224   ///   }
    225   ///   void A::f(); // SemanticDC == namespace 'A'
    226   ///                // LexicalDC == global namespace
    227   llvm::PointerUnion<DeclContext*, MultipleDC*> DeclCtx;
    228 
    229   inline bool isInSemaDC() const    { return DeclCtx.is<DeclContext*>(); }
    230   inline bool isOutOfSemaDC() const { return DeclCtx.is<MultipleDC*>(); }
    231   inline MultipleDC *getMultipleDC() const {
    232     return DeclCtx.get<MultipleDC*>();
    233   }
    234   inline DeclContext *getSemanticDC() const {
    235     return DeclCtx.get<DeclContext*>();
    236   }
    237 
    238   /// Loc - The location of this decl.
    239   SourceLocation Loc;
    240 
    241   /// DeclKind - This indicates which class this is.
    242   unsigned DeclKind : 8;
    243 
    244   /// InvalidDecl - This indicates a semantic error occurred.
    245   unsigned InvalidDecl :  1;
    246 
    247   /// HasAttrs - This indicates whether the decl has attributes or not.
    248   unsigned HasAttrs : 1;
    249 
    250   /// Implicit - Whether this declaration was implicitly generated by
    251   /// the implementation rather than explicitly written by the user.
    252   unsigned Implicit : 1;
    253 
    254   /// \brief Whether this declaration was "used", meaning that a definition is
    255   /// required.
    256   unsigned Used : 1;
    257 
    258   /// \brief Whether this declaration was "referenced".
    259   /// The difference with 'Used' is whether the reference appears in a
    260   /// evaluated context or not, e.g. functions used in uninstantiated templates
    261   /// are regarded as "referenced" but not "used".
    262   unsigned Referenced : 1;
    263 
    264   /// \brief Whether statistic collection is enabled.
    265   static bool StatisticsEnabled;
    266 
    267 protected:
    268   /// Access - Used by C++ decls for the access specifier.
    269   // NOTE: VC++ treats enums as signed, avoid using the AccessSpecifier enum
    270   unsigned Access : 2;
    271   friend class CXXClassMemberWrapper;
    272 
    273   /// \brief Whether this declaration was loaded from an AST file.
    274   unsigned FromASTFile : 1;
    275 
    276   /// \brief Whether this declaration is hidden from normal name lookup, e.g.,
    277   /// because it is was loaded from an AST file is either module-private or
    278   /// because its submodule has not been made visible.
    279   unsigned Hidden : 1;
    280 
    281   /// IdentifierNamespace - This specifies what IDNS_* namespace this lives in.
    282   unsigned IdentifierNamespace : 12;
    283 
    284   /// \brief Whether the \c CachedLinkage field is active.
    285   ///
    286   /// This field is only valid for NamedDecls subclasses.
    287   mutable unsigned HasCachedLinkage : 1;
    288 
    289   /// \brief If \c HasCachedLinkage, the linkage of this declaration.
    290   ///
    291   /// This field is only valid for NamedDecls subclasses.
    292   mutable unsigned CachedLinkage : 2;
    293 
    294   friend class ASTDeclWriter;
    295   friend class ASTDeclReader;
    296   friend class ASTReader;
    297 
    298 private:
    299   void CheckAccessDeclContext() const;
    300 
    301 protected:
    302 
    303   Decl(Kind DK, DeclContext *DC, SourceLocation L)
    304     : NextInContextAndBits(), DeclCtx(DC),
    305       Loc(L), DeclKind(DK), InvalidDecl(0),
    306       HasAttrs(false), Implicit(false), Used(false), Referenced(false),
    307       Access(AS_none), FromASTFile(0), Hidden(0),
    308       IdentifierNamespace(getIdentifierNamespaceForKind(DK)),
    309       HasCachedLinkage(0)
    310   {
    311     if (StatisticsEnabled) add(DK);
    312   }
    313 
    314   Decl(Kind DK, EmptyShell Empty)
    315     : NextInContextAndBits(), DeclKind(DK), InvalidDecl(0),
    316       HasAttrs(false), Implicit(false), Used(false), Referenced(false),
    317       Access(AS_none), FromASTFile(0), Hidden(0),
    318       IdentifierNamespace(getIdentifierNamespaceForKind(DK)),
    319       HasCachedLinkage(0)
    320   {
    321     if (StatisticsEnabled) add(DK);
    322   }
    323 
    324   virtual ~Decl();
    325 
    326   /// \brief Allocate memory for a deserialized declaration.
    327   ///
    328   /// This routine must be used to allocate memory for any declaration that is
    329   /// deserialized from a module file.
    330   ///
    331   /// \param Context The context in which we will allocate memory.
    332   /// \param ID The global ID of the deserialized declaration.
    333   /// \param Size The size of the allocated object.
    334   static void *AllocateDeserializedDecl(const ASTContext &Context,
    335                                         unsigned ID,
    336                                         unsigned Size);
    337 
    338 public:
    339 
    340   /// \brief Source range that this declaration covers.
    341   virtual SourceRange getSourceRange() const LLVM_READONLY {
    342     return SourceRange(getLocation(), getLocation());
    343   }
    344   SourceLocation getLocStart() const LLVM_READONLY {
    345     return getSourceRange().getBegin();
    346   }
    347   SourceLocation getLocEnd() const LLVM_READONLY {
    348     return getSourceRange().getEnd();
    349   }
    350 
    351   SourceLocation getLocation() const { return Loc; }
    352   void setLocation(SourceLocation L) { Loc = L; }
    353 
    354   Kind getKind() const { return static_cast<Kind>(DeclKind); }
    355   const char *getDeclKindName() const;
    356 
    357   Decl *getNextDeclInContext() { return NextInContextAndBits.getPointer(); }
    358   const Decl *getNextDeclInContext() const {return NextInContextAndBits.getPointer();}
    359 
    360   DeclContext *getDeclContext() {
    361     if (isInSemaDC())
    362       return getSemanticDC();
    363     return getMultipleDC()->SemanticDC;
    364   }
    365   const DeclContext *getDeclContext() const {
    366     return const_cast<Decl*>(this)->getDeclContext();
    367   }
    368 
    369   /// Finds the innermost non-closure context of this declaration.
    370   /// That is, walk out the DeclContext chain, skipping any blocks.
    371   DeclContext *getNonClosureContext();
    372   const DeclContext *getNonClosureContext() const {
    373     return const_cast<Decl*>(this)->getNonClosureContext();
    374   }
    375 
    376   TranslationUnitDecl *getTranslationUnitDecl();
    377   const TranslationUnitDecl *getTranslationUnitDecl() const {
    378     return const_cast<Decl*>(this)->getTranslationUnitDecl();
    379   }
    380 
    381   bool isInAnonymousNamespace() const;
    382 
    383   ASTContext &getASTContext() const LLVM_READONLY;
    384 
    385   void setAccess(AccessSpecifier AS) {
    386     Access = AS;
    387 #ifndef NDEBUG
    388     CheckAccessDeclContext();
    389 #endif
    390   }
    391 
    392   AccessSpecifier getAccess() const {
    393 #ifndef NDEBUG
    394     CheckAccessDeclContext();
    395 #endif
    396     return AccessSpecifier(Access);
    397   }
    398 
    399   bool hasAttrs() const { return HasAttrs; }
    400   void setAttrs(const AttrVec& Attrs) {
    401     return setAttrsImpl(Attrs, getASTContext());
    402   }
    403   AttrVec &getAttrs() {
    404     return const_cast<AttrVec&>(const_cast<const Decl*>(this)->getAttrs());
    405   }
    406   const AttrVec &getAttrs() const;
    407   void swapAttrs(Decl *D);
    408   void dropAttrs();
    409 
    410   void addAttr(Attr *A) {
    411     if (hasAttrs())
    412       getAttrs().push_back(A);
    413     else
    414       setAttrs(AttrVec(1, A));
    415   }
    416 
    417   typedef AttrVec::const_iterator attr_iterator;
    418 
    419   // FIXME: Do not rely on iterators having comparable singular values.
    420   //        Note that this should error out if they do not.
    421   attr_iterator attr_begin() const {
    422     return hasAttrs() ? getAttrs().begin() : 0;
    423   }
    424   attr_iterator attr_end() const {
    425     return hasAttrs() ? getAttrs().end() : 0;
    426   }
    427 
    428   template <typename T>
    429   void dropAttr() {
    430     if (!HasAttrs) return;
    431 
    432     AttrVec &Attrs = getAttrs();
    433     for (unsigned i = 0, e = Attrs.size(); i != e; /* in loop */) {
    434       if (isa<T>(Attrs[i])) {
    435         Attrs.erase(Attrs.begin() + i);
    436         --e;
    437       }
    438       else
    439         ++i;
    440     }
    441     if (Attrs.empty())
    442       HasAttrs = false;
    443   }
    444 
    445   template <typename T>
    446   specific_attr_iterator<T> specific_attr_begin() const {
    447     return specific_attr_iterator<T>(attr_begin());
    448   }
    449   template <typename T>
    450   specific_attr_iterator<T> specific_attr_end() const {
    451     return specific_attr_iterator<T>(attr_end());
    452   }
    453 
    454   template<typename T> T *getAttr() const {
    455     return hasAttrs() ? getSpecificAttr<T>(getAttrs()) : 0;
    456   }
    457   template<typename T> bool hasAttr() const {
    458     return hasAttrs() && hasSpecificAttr<T>(getAttrs());
    459   }
    460 
    461   /// getMaxAlignment - return the maximum alignment specified by attributes
    462   /// on this decl, 0 if there are none.
    463   unsigned getMaxAlignment() const {
    464     return hasAttrs() ? getMaxAttrAlignment(getAttrs(), getASTContext()) : 0;
    465   }
    466 
    467   /// setInvalidDecl - Indicates the Decl had a semantic error. This
    468   /// allows for graceful error recovery.
    469   void setInvalidDecl(bool Invalid = true);
    470   bool isInvalidDecl() const { return (bool) InvalidDecl; }
    471 
    472   /// isImplicit - Indicates whether the declaration was implicitly
    473   /// generated by the implementation. If false, this declaration
    474   /// was written explicitly in the source code.
    475   bool isImplicit() const { return Implicit; }
    476   void setImplicit(bool I = true) { Implicit = I; }
    477 
    478   /// \brief Whether this declaration was used, meaning that a definition
    479   /// is required.
    480   ///
    481   /// \param CheckUsedAttr When true, also consider the "used" attribute
    482   /// (in addition to the "used" bit set by \c setUsed()) when determining
    483   /// whether the function is used.
    484   bool isUsed(bool CheckUsedAttr = true) const;
    485 
    486   void setUsed(bool U = true) { Used = U; }
    487 
    488   /// \brief Whether this declaration was referenced.
    489   bool isReferenced() const;
    490 
    491   void setReferenced(bool R = true) { Referenced = R; }
    492 
    493   /// \brief Whether this declaration is a top-level declaration (function,
    494   /// global variable, etc.) that is lexically inside an objc container
    495   /// definition.
    496   bool isTopLevelDeclInObjCContainer() const {
    497     return NextInContextAndBits.getInt() & TopLevelDeclInObjCContainerFlag;
    498   }
    499 
    500   void setTopLevelDeclInObjCContainer(bool V = true) {
    501     unsigned Bits = NextInContextAndBits.getInt();
    502     if (V)
    503       Bits |= TopLevelDeclInObjCContainerFlag;
    504     else
    505       Bits &= ~TopLevelDeclInObjCContainerFlag;
    506     NextInContextAndBits.setInt(Bits);
    507   }
    508 
    509 protected:
    510   /// \brief Whether this declaration was marked as being private to the
    511   /// module in which it was defined.
    512   bool isModulePrivate() const {
    513     return NextInContextAndBits.getInt() & ModulePrivateFlag;
    514   }
    515 
    516   /// \brief Specify whether this declaration was marked as being private
    517   /// to the module in which it was defined.
    518   void setModulePrivate(bool MP = true) {
    519     unsigned Bits = NextInContextAndBits.getInt();
    520     if (MP)
    521       Bits |= ModulePrivateFlag;
    522     else
    523       Bits &= ~ModulePrivateFlag;
    524     NextInContextAndBits.setInt(Bits);
    525   }
    526 
    527   /// \brief Set the owning module ID.
    528   void setOwningModuleID(unsigned ID) {
    529     assert(isFromASTFile() && "Only works on a deserialized declaration");
    530     *((unsigned*)this - 2) = ID;
    531   }
    532 
    533 public:
    534 
    535   /// \brief Determine the availability of the given declaration.
    536   ///
    537   /// This routine will determine the most restrictive availability of
    538   /// the given declaration (e.g., preferring 'unavailable' to
    539   /// 'deprecated').
    540   ///
    541   /// \param Message If non-NULL and the result is not \c
    542   /// AR_Available, will be set to a (possibly empty) message
    543   /// describing why the declaration has not been introduced, is
    544   /// deprecated, or is unavailable.
    545   AvailabilityResult getAvailability(std::string *Message = 0) const;
    546 
    547   /// \brief Determine whether this declaration is marked 'deprecated'.
    548   ///
    549   /// \param Message If non-NULL and the declaration is deprecated,
    550   /// this will be set to the message describing why the declaration
    551   /// was deprecated (which may be empty).
    552   bool isDeprecated(std::string *Message = 0) const {
    553     return getAvailability(Message) == AR_Deprecated;
    554   }
    555 
    556   /// \brief Determine whether this declaration is marked 'unavailable'.
    557   ///
    558   /// \param Message If non-NULL and the declaration is unavailable,
    559   /// this will be set to the message describing why the declaration
    560   /// was made unavailable (which may be empty).
    561   bool isUnavailable(std::string *Message = 0) const {
    562     return getAvailability(Message) == AR_Unavailable;
    563   }
    564 
    565   /// \brief Determine whether this is a weak-imported symbol.
    566   ///
    567   /// Weak-imported symbols are typically marked with the
    568   /// 'weak_import' attribute, but may also be marked with an
    569   /// 'availability' attribute where we're targing a platform prior to
    570   /// the introduction of this feature.
    571   bool isWeakImported() const;
    572 
    573   /// \brief Determines whether this symbol can be weak-imported,
    574   /// e.g., whether it would be well-formed to add the weak_import
    575   /// attribute.
    576   ///
    577   /// \param IsDefinition Set to \c true to indicate that this
    578   /// declaration cannot be weak-imported because it has a definition.
    579   bool canBeWeakImported(bool &IsDefinition) const;
    580 
    581   /// \brief Determine whether this declaration came from an AST file (such as
    582   /// a precompiled header or module) rather than having been parsed.
    583   bool isFromASTFile() const { return FromASTFile; }
    584 
    585   /// \brief Retrieve the global declaration ID associated with this
    586   /// declaration, which specifies where in the
    587   unsigned getGlobalID() const {
    588     if (isFromASTFile())
    589       return *((const unsigned*)this - 1);
    590     return 0;
    591   }
    592 
    593   /// \brief Retrieve the global ID of the module that owns this particular
    594   /// declaration.
    595   unsigned getOwningModuleID() const {
    596     if (isFromASTFile())
    597       return *((const unsigned*)this - 2);
    598 
    599     return 0;
    600   }
    601 
    602   unsigned getIdentifierNamespace() const {
    603     return IdentifierNamespace;
    604   }
    605   bool isInIdentifierNamespace(unsigned NS) const {
    606     return getIdentifierNamespace() & NS;
    607   }
    608   static unsigned getIdentifierNamespaceForKind(Kind DK);
    609 
    610   bool hasTagIdentifierNamespace() const {
    611     return isTagIdentifierNamespace(getIdentifierNamespace());
    612   }
    613   static bool isTagIdentifierNamespace(unsigned NS) {
    614     // TagDecls have Tag and Type set and may also have TagFriend.
    615     return (NS & ~IDNS_TagFriend) == (IDNS_Tag | IDNS_Type);
    616   }
    617 
    618   /// getLexicalDeclContext - The declaration context where this Decl was
    619   /// lexically declared (LexicalDC). May be different from
    620   /// getDeclContext() (SemanticDC).
    621   /// e.g.:
    622   ///
    623   ///   namespace A {
    624   ///      void f(); // SemanticDC == LexicalDC == 'namespace A'
    625   ///   }
    626   ///   void A::f(); // SemanticDC == namespace 'A'
    627   ///                // LexicalDC == global namespace
    628   DeclContext *getLexicalDeclContext() {
    629     if (isInSemaDC())
    630       return getSemanticDC();
    631     return getMultipleDC()->LexicalDC;
    632   }
    633   const DeclContext *getLexicalDeclContext() const {
    634     return const_cast<Decl*>(this)->getLexicalDeclContext();
    635   }
    636 
    637   virtual bool isOutOfLine() const {
    638     return getLexicalDeclContext() != getDeclContext();
    639   }
    640 
    641   /// setDeclContext - Set both the semantic and lexical DeclContext
    642   /// to DC.
    643   void setDeclContext(DeclContext *DC);
    644 
    645   void setLexicalDeclContext(DeclContext *DC);
    646 
    647   /// isDefinedOutsideFunctionOrMethod - This predicate returns true if this
    648   /// scoped decl is defined outside the current function or method.  This is
    649   /// roughly global variables and functions, but also handles enums (which
    650   /// could be defined inside or outside a function etc).
    651   bool isDefinedOutsideFunctionOrMethod() const {
    652     return getParentFunctionOrMethod() == 0;
    653   }
    654 
    655   /// \brief If this decl is defined inside a function/method/block it returns
    656   /// the corresponding DeclContext, otherwise it returns null.
    657   const DeclContext *getParentFunctionOrMethod() const;
    658   DeclContext *getParentFunctionOrMethod() {
    659     return const_cast<DeclContext*>(
    660                     const_cast<const Decl*>(this)->getParentFunctionOrMethod());
    661   }
    662 
    663   /// \brief Retrieves the "canonical" declaration of the given declaration.
    664   virtual Decl *getCanonicalDecl() { return this; }
    665   const Decl *getCanonicalDecl() const {
    666     return const_cast<Decl*>(this)->getCanonicalDecl();
    667   }
    668 
    669   /// \brief Whether this particular Decl is a canonical one.
    670   bool isCanonicalDecl() const { return getCanonicalDecl() == this; }
    671 
    672 protected:
    673   /// \brief Returns the next redeclaration or itself if this is the only decl.
    674   ///
    675   /// Decl subclasses that can be redeclared should override this method so that
    676   /// Decl::redecl_iterator can iterate over them.
    677   virtual Decl *getNextRedeclaration() { return this; }
    678 
    679   /// \brief Implementation of getPreviousDecl(), to be overridden by any
    680   /// subclass that has a redeclaration chain.
    681   virtual Decl *getPreviousDeclImpl() { return 0; }
    682 
    683   /// \brief Implementation of getMostRecentDecl(), to be overridden by any
    684   /// subclass that has a redeclaration chain.
    685   virtual Decl *getMostRecentDeclImpl() { return this; }
    686 
    687 public:
    688   /// \brief Iterates through all the redeclarations of the same decl.
    689   class redecl_iterator {
    690     /// Current - The current declaration.
    691     Decl *Current;
    692     Decl *Starter;
    693 
    694   public:
    695     typedef Decl*                     value_type;
    696     typedef Decl*                     reference;
    697     typedef Decl*                     pointer;
    698     typedef std::forward_iterator_tag iterator_category;
    699     typedef std::ptrdiff_t            difference_type;
    700 
    701     redecl_iterator() : Current(0) { }
    702     explicit redecl_iterator(Decl *C) : Current(C), Starter(C) { }
    703 
    704     reference operator*() const { return Current; }
    705     pointer operator->() const { return Current; }
    706 
    707     redecl_iterator& operator++() {
    708       assert(Current && "Advancing while iterator has reached end");
    709       // Get either previous decl or latest decl.
    710       Decl *Next = Current->getNextRedeclaration();
    711       assert(Next && "Should return next redeclaration or itself, never null!");
    712       Current = (Next != Starter ? Next : 0);
    713       return *this;
    714     }
    715 
    716     redecl_iterator operator++(int) {
    717       redecl_iterator tmp(*this);
    718       ++(*this);
    719       return tmp;
    720     }
    721 
    722     friend bool operator==(redecl_iterator x, redecl_iterator y) {
    723       return x.Current == y.Current;
    724     }
    725     friend bool operator!=(redecl_iterator x, redecl_iterator y) {
    726       return x.Current != y.Current;
    727     }
    728   };
    729 
    730   /// \brief Returns iterator for all the redeclarations of the same decl.
    731   /// It will iterate at least once (when this decl is the only one).
    732   redecl_iterator redecls_begin() const {
    733     return redecl_iterator(const_cast<Decl*>(this));
    734   }
    735   redecl_iterator redecls_end() const { return redecl_iterator(); }
    736 
    737   /// \brief Retrieve the previous declaration that declares the same entity
    738   /// as this declaration, or NULL if there is no previous declaration.
    739   Decl *getPreviousDecl() { return getPreviousDeclImpl(); }
    740 
    741   /// \brief Retrieve the most recent declaration that declares the same entity
    742   /// as this declaration, or NULL if there is no previous declaration.
    743   const Decl *getPreviousDecl() const {
    744     return const_cast<Decl *>(this)->getPreviousDeclImpl();
    745   }
    746 
    747   /// \brief Retrieve the most recent declaration that declares the same entity
    748   /// as this declaration (which may be this declaration).
    749   Decl *getMostRecentDecl() { return getMostRecentDeclImpl(); }
    750 
    751   /// \brief Retrieve the most recent declaration that declares the same entity
    752   /// as this declaration (which may be this declaration).
    753   const Decl *getMostRecentDecl() const {
    754     return const_cast<Decl *>(this)->getMostRecentDeclImpl();
    755   }
    756 
    757   /// getBody - If this Decl represents a declaration for a body of code,
    758   ///  such as a function or method definition, this method returns the
    759   ///  top-level Stmt* of that body.  Otherwise this method returns null.
    760   virtual Stmt* getBody() const { return 0; }
    761 
    762   /// \brief Returns true if this Decl represents a declaration for a body of
    763   /// code, such as a function or method definition.
    764   virtual bool hasBody() const { return getBody() != 0; }
    765 
    766   /// getBodyRBrace - Gets the right brace of the body, if a body exists.
    767   /// This works whether the body is a CompoundStmt or a CXXTryStmt.
    768   SourceLocation getBodyRBrace() const;
    769 
    770   // global temp stats (until we have a per-module visitor)
    771   static void add(Kind k);
    772   static void EnableStatistics();
    773   static void PrintStats();
    774 
    775   /// isTemplateParameter - Determines whether this declaration is a
    776   /// template parameter.
    777   bool isTemplateParameter() const;
    778 
    779   /// isTemplateParameter - Determines whether this declaration is a
    780   /// template parameter pack.
    781   bool isTemplateParameterPack() const;
    782 
    783   /// \brief Whether this declaration is a parameter pack.
    784   bool isParameterPack() const;
    785 
    786   /// \brief returns true if this declaration is a template
    787   bool isTemplateDecl() const;
    788 
    789   /// \brief Whether this declaration is a function or function template.
    790   bool isFunctionOrFunctionTemplate() const;
    791 
    792   /// \brief Changes the namespace of this declaration to reflect that it's
    793   /// the object of a friend declaration.
    794   ///
    795   /// These declarations appear in the lexical context of the friending
    796   /// class, but in the semantic context of the actual entity.  This property
    797   /// applies only to a specific decl object;  other redeclarations of the
    798   /// same entity may not (and probably don't) share this property.
    799   void setObjectOfFriendDecl(bool PreviouslyDeclared) {
    800     unsigned OldNS = IdentifierNamespace;
    801     assert((OldNS & (IDNS_Tag | IDNS_Ordinary |
    802                      IDNS_TagFriend | IDNS_OrdinaryFriend)) &&
    803            "namespace includes neither ordinary nor tag");
    804     assert(!(OldNS & ~(IDNS_Tag | IDNS_Ordinary | IDNS_Type |
    805                        IDNS_TagFriend | IDNS_OrdinaryFriend)) &&
    806            "namespace includes other than ordinary or tag");
    807 
    808     IdentifierNamespace = 0;
    809     if (OldNS & (IDNS_Tag | IDNS_TagFriend)) {
    810       IdentifierNamespace |= IDNS_TagFriend;
    811       if (PreviouslyDeclared) IdentifierNamespace |= IDNS_Tag | IDNS_Type;
    812     }
    813 
    814     if (OldNS & (IDNS_Ordinary | IDNS_OrdinaryFriend)) {
    815       IdentifierNamespace |= IDNS_OrdinaryFriend;
    816       if (PreviouslyDeclared) IdentifierNamespace |= IDNS_Ordinary;
    817     }
    818   }
    819 
    820   enum FriendObjectKind {
    821     FOK_None, // not a friend object
    822     FOK_Declared, // a friend of a previously-declared entity
    823     FOK_Undeclared // a friend of a previously-undeclared entity
    824   };
    825 
    826   /// \brief Determines whether this declaration is the object of a
    827   /// friend declaration and, if so, what kind.
    828   ///
    829   /// There is currently no direct way to find the associated FriendDecl.
    830   FriendObjectKind getFriendObjectKind() const {
    831     unsigned mask
    832       = (IdentifierNamespace & (IDNS_TagFriend | IDNS_OrdinaryFriend));
    833     if (!mask) return FOK_None;
    834     return (IdentifierNamespace & (IDNS_Tag | IDNS_Ordinary) ?
    835               FOK_Declared : FOK_Undeclared);
    836   }
    837 
    838   /// Specifies that this declaration is a C++ overloaded non-member.
    839   void setNonMemberOperator() {
    840     assert(getKind() == Function || getKind() == FunctionTemplate);
    841     assert((IdentifierNamespace & IDNS_Ordinary) &&
    842            "visible non-member operators should be in ordinary namespace");
    843     IdentifierNamespace |= IDNS_NonMemberOperator;
    844   }
    845 
    846   // Implement isa/cast/dyncast/etc.
    847   static bool classof(const Decl *) { return true; }
    848   static bool classofKind(Kind K) { return true; }
    849   static DeclContext *castToDeclContext(const Decl *);
    850   static Decl *castFromDeclContext(const DeclContext *);
    851 
    852   void print(raw_ostream &Out, unsigned Indentation = 0,
    853              bool PrintInstantiation = false) const;
    854   void print(raw_ostream &Out, const PrintingPolicy &Policy,
    855              unsigned Indentation = 0, bool PrintInstantiation = false) const;
    856   static void printGroup(Decl** Begin, unsigned NumDecls,
    857                          raw_ostream &Out, const PrintingPolicy &Policy,
    858                          unsigned Indentation = 0);
    859   LLVM_ATTRIBUTE_USED void dump() const;
    860   LLVM_ATTRIBUTE_USED void dumpXML() const;
    861   void dumpXML(raw_ostream &OS) const;
    862 
    863 private:
    864   void setAttrsImpl(const AttrVec& Attrs, ASTContext &Ctx);
    865   void setDeclContextsImpl(DeclContext *SemaDC, DeclContext *LexicalDC,
    866                            ASTContext &Ctx);
    867 
    868 protected:
    869   ASTMutationListener *getASTMutationListener() const;
    870 };
    871 
    872 /// \brief Determine whether two declarations declare the same entity.
    873 inline bool declaresSameEntity(const Decl *D1, const Decl *D2) {
    874   if (!D1 || !D2)
    875     return false;
    876 
    877   if (D1 == D2)
    878     return true;
    879 
    880   return D1->getCanonicalDecl() == D2->getCanonicalDecl();
    881 }
    882 
    883 /// PrettyStackTraceDecl - If a crash occurs, indicate that it happened when
    884 /// doing something to a specific decl.
    885 class PrettyStackTraceDecl : public llvm::PrettyStackTraceEntry {
    886   const Decl *TheDecl;
    887   SourceLocation Loc;
    888   SourceManager &SM;
    889   const char *Message;
    890 public:
    891   PrettyStackTraceDecl(const Decl *theDecl, SourceLocation L,
    892                        SourceManager &sm, const char *Msg)
    893   : TheDecl(theDecl), Loc(L), SM(sm), Message(Msg) {}
    894 
    895   virtual void print(raw_ostream &OS) const;
    896 };
    897 
    898 class DeclContextLookupResult
    899   : public std::pair<NamedDecl**,NamedDecl**> {
    900 public:
    901   DeclContextLookupResult(NamedDecl **I, NamedDecl **E)
    902     : std::pair<NamedDecl**,NamedDecl**>(I, E) {}
    903   DeclContextLookupResult()
    904     : std::pair<NamedDecl**,NamedDecl**>() {}
    905 
    906   using std::pair<NamedDecl**,NamedDecl**>::operator=;
    907 };
    908 
    909 class DeclContextLookupConstResult
    910   : public std::pair<NamedDecl*const*, NamedDecl*const*> {
    911 public:
    912   DeclContextLookupConstResult(std::pair<NamedDecl**,NamedDecl**> R)
    913     : std::pair<NamedDecl*const*, NamedDecl*const*>(R) {}
    914   DeclContextLookupConstResult(NamedDecl * const *I, NamedDecl * const *E)
    915     : std::pair<NamedDecl*const*, NamedDecl*const*>(I, E) {}
    916   DeclContextLookupConstResult()
    917     : std::pair<NamedDecl*const*, NamedDecl*const*>() {}
    918 
    919   using std::pair<NamedDecl*const*,NamedDecl*const*>::operator=;
    920 };
    921 
    922 /// DeclContext - This is used only as base class of specific decl types that
    923 /// can act as declaration contexts. These decls are (only the top classes
    924 /// that directly derive from DeclContext are mentioned, not their subclasses):
    925 ///
    926 ///   TranslationUnitDecl
    927 ///   NamespaceDecl
    928 ///   FunctionDecl
    929 ///   TagDecl
    930 ///   ObjCMethodDecl
    931 ///   ObjCContainerDecl
    932 ///   LinkageSpecDecl
    933 ///   BlockDecl
    934 ///
    935 class DeclContext {
    936   /// DeclKind - This indicates which class this is.
    937   unsigned DeclKind : 8;
    938 
    939   /// \brief Whether this declaration context also has some external
    940   /// storage that contains additional declarations that are lexically
    941   /// part of this context.
    942   mutable unsigned ExternalLexicalStorage : 1;
    943 
    944   /// \brief Whether this declaration context also has some external
    945   /// storage that contains additional declarations that are visible
    946   /// in this context.
    947   mutable unsigned ExternalVisibleStorage : 1;
    948 
    949   /// \brief Pointer to the data structure used to lookup declarations
    950   /// within this context (or a DependentStoredDeclsMap if this is a
    951   /// dependent context), and a bool indicating whether we have lazily
    952   /// omitted any declarations from the map. We maintain the invariant
    953   /// that, if the map contains an entry for a DeclarationName, then it
    954   /// contains all relevant entries for that name.
    955   mutable llvm::PointerIntPair<StoredDeclsMap*, 1, bool> LookupPtr;
    956 
    957 protected:
    958   /// FirstDecl - The first declaration stored within this declaration
    959   /// context.
    960   mutable Decl *FirstDecl;
    961 
    962   /// LastDecl - The last declaration stored within this declaration
    963   /// context. FIXME: We could probably cache this value somewhere
    964   /// outside of the DeclContext, to reduce the size of DeclContext by
    965   /// another pointer.
    966   mutable Decl *LastDecl;
    967 
    968   friend class ExternalASTSource;
    969   friend class ASTWriter;
    970 
    971   /// \brief Build up a chain of declarations.
    972   ///
    973   /// \returns the first/last pair of declarations.
    974   static std::pair<Decl *, Decl *>
    975   BuildDeclChain(ArrayRef<Decl*> Decls, bool FieldsAlreadyLoaded);
    976 
    977    DeclContext(Decl::Kind K)
    978      : DeclKind(K), ExternalLexicalStorage(false),
    979        ExternalVisibleStorage(false), LookupPtr(0, false), FirstDecl(0),
    980        LastDecl(0) { }
    981 
    982 public:
    983   ~DeclContext();
    984 
    985   Decl::Kind getDeclKind() const {
    986     return static_cast<Decl::Kind>(DeclKind);
    987   }
    988   const char *getDeclKindName() const;
    989 
    990   /// getParent - Returns the containing DeclContext.
    991   DeclContext *getParent() {
    992     return cast<Decl>(this)->getDeclContext();
    993   }
    994   const DeclContext *getParent() const {
    995     return const_cast<DeclContext*>(this)->getParent();
    996   }
    997 
    998   /// getLexicalParent - Returns the containing lexical DeclContext. May be
    999   /// different from getParent, e.g.:
   1000   ///
   1001   ///   namespace A {
   1002   ///      struct S;
   1003   ///   }
   1004   ///   struct A::S {}; // getParent() == namespace 'A'
   1005   ///                   // getLexicalParent() == translation unit
   1006   ///
   1007   DeclContext *getLexicalParent() {
   1008     return cast<Decl>(this)->getLexicalDeclContext();
   1009   }
   1010   const DeclContext *getLexicalParent() const {
   1011     return const_cast<DeclContext*>(this)->getLexicalParent();
   1012   }
   1013 
   1014   DeclContext *getLookupParent();
   1015 
   1016   const DeclContext *getLookupParent() const {
   1017     return const_cast<DeclContext*>(this)->getLookupParent();
   1018   }
   1019 
   1020   ASTContext &getParentASTContext() const {
   1021     return cast<Decl>(this)->getASTContext();
   1022   }
   1023 
   1024   bool isClosure() const {
   1025     return DeclKind == Decl::Block;
   1026   }
   1027 
   1028   bool isObjCContainer() const {
   1029     switch (DeclKind) {
   1030         case Decl::ObjCCategory:
   1031         case Decl::ObjCCategoryImpl:
   1032         case Decl::ObjCImplementation:
   1033         case Decl::ObjCInterface:
   1034         case Decl::ObjCProtocol:
   1035             return true;
   1036     }
   1037     return false;
   1038   }
   1039 
   1040   bool isFunctionOrMethod() const {
   1041     switch (DeclKind) {
   1042     case Decl::Block:
   1043     case Decl::ObjCMethod:
   1044       return true;
   1045     default:
   1046       return DeclKind >= Decl::firstFunction && DeclKind <= Decl::lastFunction;
   1047     }
   1048   }
   1049 
   1050   bool isFileContext() const {
   1051     return DeclKind == Decl::TranslationUnit || DeclKind == Decl::Namespace;
   1052   }
   1053 
   1054   bool isTranslationUnit() const {
   1055     return DeclKind == Decl::TranslationUnit;
   1056   }
   1057 
   1058   bool isRecord() const {
   1059     return DeclKind >= Decl::firstRecord && DeclKind <= Decl::lastRecord;
   1060   }
   1061 
   1062   bool isNamespace() const {
   1063     return DeclKind == Decl::Namespace;
   1064   }
   1065 
   1066   bool isInlineNamespace() const;
   1067 
   1068   /// \brief Determines whether this context is dependent on a
   1069   /// template parameter.
   1070   bool isDependentContext() const;
   1071 
   1072   /// isTransparentContext - Determines whether this context is a
   1073   /// "transparent" context, meaning that the members declared in this
   1074   /// context are semantically declared in the nearest enclosing
   1075   /// non-transparent (opaque) context but are lexically declared in
   1076   /// this context. For example, consider the enumerators of an
   1077   /// enumeration type:
   1078   /// @code
   1079   /// enum E {
   1080   ///   Val1
   1081   /// };
   1082   /// @endcode
   1083   /// Here, E is a transparent context, so its enumerator (Val1) will
   1084   /// appear (semantically) that it is in the same context of E.
   1085   /// Examples of transparent contexts include: enumerations (except for
   1086   /// C++0x scoped enums), and C++ linkage specifications.
   1087   bool isTransparentContext() const;
   1088 
   1089   /// \brief Determines whether this context is, or is nested within,
   1090   /// a C++ extern "C" linkage spec.
   1091   bool isExternCContext() const;
   1092 
   1093   /// \brief Determine whether this declaration context is equivalent
   1094   /// to the declaration context DC.
   1095   bool Equals(const DeclContext *DC) const {
   1096     return DC && this->getPrimaryContext() == DC->getPrimaryContext();
   1097   }
   1098 
   1099   /// \brief Determine whether this declaration context encloses the
   1100   /// declaration context DC.
   1101   bool Encloses(const DeclContext *DC) const;
   1102 
   1103   /// \brief Find the nearest non-closure ancestor of this context,
   1104   /// i.e. the innermost semantic parent of this context which is not
   1105   /// a closure.  A context may be its own non-closure ancestor.
   1106   DeclContext *getNonClosureAncestor();
   1107   const DeclContext *getNonClosureAncestor() const {
   1108     return const_cast<DeclContext*>(this)->getNonClosureAncestor();
   1109   }
   1110 
   1111   /// getPrimaryContext - There may be many different
   1112   /// declarations of the same entity (including forward declarations
   1113   /// of classes, multiple definitions of namespaces, etc.), each with
   1114   /// a different set of declarations. This routine returns the
   1115   /// "primary" DeclContext structure, which will contain the
   1116   /// information needed to perform name lookup into this context.
   1117   DeclContext *getPrimaryContext();
   1118   const DeclContext *getPrimaryContext() const {
   1119     return const_cast<DeclContext*>(this)->getPrimaryContext();
   1120   }
   1121 
   1122   /// getRedeclContext - Retrieve the context in which an entity conflicts with
   1123   /// other entities of the same name, or where it is a redeclaration if the
   1124   /// two entities are compatible. This skips through transparent contexts.
   1125   DeclContext *getRedeclContext();
   1126   const DeclContext *getRedeclContext() const {
   1127     return const_cast<DeclContext *>(this)->getRedeclContext();
   1128   }
   1129 
   1130   /// \brief Retrieve the nearest enclosing namespace context.
   1131   DeclContext *getEnclosingNamespaceContext();
   1132   const DeclContext *getEnclosingNamespaceContext() const {
   1133     return const_cast<DeclContext *>(this)->getEnclosingNamespaceContext();
   1134   }
   1135 
   1136   /// \brief Test if this context is part of the enclosing namespace set of
   1137   /// the context NS, as defined in C++0x [namespace.def]p9. If either context
   1138   /// isn't a namespace, this is equivalent to Equals().
   1139   ///
   1140   /// The enclosing namespace set of a namespace is the namespace and, if it is
   1141   /// inline, its enclosing namespace, recursively.
   1142   bool InEnclosingNamespaceSetOf(const DeclContext *NS) const;
   1143 
   1144   /// \\brief Collects all of the declaration contexts that are semantically
   1145   /// connected to this declaration context.
   1146   ///
   1147   /// For declaration contexts that have multiple semantically connected but
   1148   /// syntactically distinct contexts, such as C++ namespaces, this routine
   1149   /// retrieves the complete set of such declaration contexts in source order.
   1150   /// For example, given:
   1151   ///
   1152   /// \code
   1153   /// namespace N {
   1154   ///   int x;
   1155   /// }
   1156   /// namespace N {
   1157   ///   int y;
   1158   /// }
   1159   /// \endcode
   1160   ///
   1161   /// The \c Contexts parameter will contain both definitions of N.
   1162   ///
   1163   /// \param Contexts Will be cleared and set to the set of declaration
   1164   /// contexts that are semanticaly connected to this declaration context,
   1165   /// in source order, including this context (which may be the only result,
   1166   /// for non-namespace contexts).
   1167   void collectAllContexts(llvm::SmallVectorImpl<DeclContext *> &Contexts);
   1168 
   1169   /// decl_iterator - Iterates through the declarations stored
   1170   /// within this context.
   1171   class decl_iterator {
   1172     /// Current - The current declaration.
   1173     Decl *Current;
   1174 
   1175   public:
   1176     typedef Decl*                     value_type;
   1177     typedef Decl*                     reference;
   1178     typedef Decl*                     pointer;
   1179     typedef std::forward_iterator_tag iterator_category;
   1180     typedef std::ptrdiff_t            difference_type;
   1181 
   1182     decl_iterator() : Current(0) { }
   1183     explicit decl_iterator(Decl *C) : Current(C) { }
   1184 
   1185     reference operator*() const { return Current; }
   1186     pointer operator->() const { return Current; }
   1187 
   1188     decl_iterator& operator++() {
   1189       Current = Current->getNextDeclInContext();
   1190       return *this;
   1191     }
   1192 
   1193     decl_iterator operator++(int) {
   1194       decl_iterator tmp(*this);
   1195       ++(*this);
   1196       return tmp;
   1197     }
   1198 
   1199     friend bool operator==(decl_iterator x, decl_iterator y) {
   1200       return x.Current == y.Current;
   1201     }
   1202     friend bool operator!=(decl_iterator x, decl_iterator y) {
   1203       return x.Current != y.Current;
   1204     }
   1205   };
   1206 
   1207   /// decls_begin/decls_end - Iterate over the declarations stored in
   1208   /// this context.
   1209   decl_iterator decls_begin() const;
   1210   decl_iterator decls_end() const;
   1211   bool decls_empty() const;
   1212 
   1213   /// noload_decls_begin/end - Iterate over the declarations stored in this
   1214   /// context that are currently loaded; don't attempt to retrieve anything
   1215   /// from an external source.
   1216   decl_iterator noload_decls_begin() const;
   1217   decl_iterator noload_decls_end() const;
   1218 
   1219   /// specific_decl_iterator - Iterates over a subrange of
   1220   /// declarations stored in a DeclContext, providing only those that
   1221   /// are of type SpecificDecl (or a class derived from it). This
   1222   /// iterator is used, for example, to provide iteration over just
   1223   /// the fields within a RecordDecl (with SpecificDecl = FieldDecl).
   1224   template<typename SpecificDecl>
   1225   class specific_decl_iterator {
   1226     /// Current - The current, underlying declaration iterator, which
   1227     /// will either be NULL or will point to a declaration of
   1228     /// type SpecificDecl.
   1229     DeclContext::decl_iterator Current;
   1230 
   1231     /// SkipToNextDecl - Advances the current position up to the next
   1232     /// declaration of type SpecificDecl that also meets the criteria
   1233     /// required by Acceptable.
   1234     void SkipToNextDecl() {
   1235       while (*Current && !isa<SpecificDecl>(*Current))
   1236         ++Current;
   1237     }
   1238 
   1239   public:
   1240     typedef SpecificDecl* value_type;
   1241     typedef SpecificDecl* reference;
   1242     typedef SpecificDecl* pointer;
   1243     typedef std::iterator_traits<DeclContext::decl_iterator>::difference_type
   1244       difference_type;
   1245     typedef std::forward_iterator_tag iterator_category;
   1246 
   1247     specific_decl_iterator() : Current() { }
   1248 
   1249     /// specific_decl_iterator - Construct a new iterator over a
   1250     /// subset of the declarations the range [C,
   1251     /// end-of-declarations). If A is non-NULL, it is a pointer to a
   1252     /// member function of SpecificDecl that should return true for
   1253     /// all of the SpecificDecl instances that will be in the subset
   1254     /// of iterators. For example, if you want Objective-C instance
   1255     /// methods, SpecificDecl will be ObjCMethodDecl and A will be
   1256     /// &ObjCMethodDecl::isInstanceMethod.
   1257     explicit specific_decl_iterator(DeclContext::decl_iterator C) : Current(C) {
   1258       SkipToNextDecl();
   1259     }
   1260 
   1261     reference operator*() const { return cast<SpecificDecl>(*Current); }
   1262     pointer operator->() const { return cast<SpecificDecl>(*Current); }
   1263 
   1264     specific_decl_iterator& operator++() {
   1265       ++Current;
   1266       SkipToNextDecl();
   1267       return *this;
   1268     }
   1269 
   1270     specific_decl_iterator operator++(int) {
   1271       specific_decl_iterator tmp(*this);
   1272       ++(*this);
   1273       return tmp;
   1274     }
   1275 
   1276     friend bool operator==(const specific_decl_iterator& x,
   1277                            const specific_decl_iterator& y) {
   1278       return x.Current == y.Current;
   1279     }
   1280 
   1281     friend bool operator!=(const specific_decl_iterator& x,
   1282                            const specific_decl_iterator& y) {
   1283       return x.Current != y.Current;
   1284     }
   1285   };
   1286 
   1287   /// \brief Iterates over a filtered subrange of declarations stored
   1288   /// in a DeclContext.
   1289   ///
   1290   /// This iterator visits only those declarations that are of type
   1291   /// SpecificDecl (or a class derived from it) and that meet some
   1292   /// additional run-time criteria. This iterator is used, for
   1293   /// example, to provide access to the instance methods within an
   1294   /// Objective-C interface (with SpecificDecl = ObjCMethodDecl and
   1295   /// Acceptable = ObjCMethodDecl::isInstanceMethod).
   1296   template<typename SpecificDecl, bool (SpecificDecl::*Acceptable)() const>
   1297   class filtered_decl_iterator {
   1298     /// Current - The current, underlying declaration iterator, which
   1299     /// will either be NULL or will point to a declaration of
   1300     /// type SpecificDecl.
   1301     DeclContext::decl_iterator Current;
   1302 
   1303     /// SkipToNextDecl - Advances the current position up to the next
   1304     /// declaration of type SpecificDecl that also meets the criteria
   1305     /// required by Acceptable.
   1306     void SkipToNextDecl() {
   1307       while (*Current &&
   1308              (!isa<SpecificDecl>(*Current) ||
   1309               (Acceptable && !(cast<SpecificDecl>(*Current)->*Acceptable)())))
   1310         ++Current;
   1311     }
   1312 
   1313   public:
   1314     typedef SpecificDecl* value_type;
   1315     typedef SpecificDecl* reference;
   1316     typedef SpecificDecl* pointer;
   1317     typedef std::iterator_traits<DeclContext::decl_iterator>::difference_type
   1318       difference_type;
   1319     typedef std::forward_iterator_tag iterator_category;
   1320 
   1321     filtered_decl_iterator() : Current() { }
   1322 
   1323     /// specific_decl_iterator - Construct a new iterator over a
   1324     /// subset of the declarations the range [C,
   1325     /// end-of-declarations). If A is non-NULL, it is a pointer to a
   1326     /// member function of SpecificDecl that should return true for
   1327     /// all of the SpecificDecl instances that will be in the subset
   1328     /// of iterators. For example, if you want Objective-C instance
   1329     /// methods, SpecificDecl will be ObjCMethodDecl and A will be
   1330     /// &ObjCMethodDecl::isInstanceMethod.
   1331     explicit filtered_decl_iterator(DeclContext::decl_iterator C) : Current(C) {
   1332       SkipToNextDecl();
   1333     }
   1334 
   1335     reference operator*() const { return cast<SpecificDecl>(*Current); }
   1336     pointer operator->() const { return cast<SpecificDecl>(*Current); }
   1337 
   1338     filtered_decl_iterator& operator++() {
   1339       ++Current;
   1340       SkipToNextDecl();
   1341       return *this;
   1342     }
   1343 
   1344     filtered_decl_iterator operator++(int) {
   1345       filtered_decl_iterator tmp(*this);
   1346       ++(*this);
   1347       return tmp;
   1348     }
   1349 
   1350     friend bool operator==(const filtered_decl_iterator& x,
   1351                            const filtered_decl_iterator& y) {
   1352       return x.Current == y.Current;
   1353     }
   1354 
   1355     friend bool operator!=(const filtered_decl_iterator& x,
   1356                            const filtered_decl_iterator& y) {
   1357       return x.Current != y.Current;
   1358     }
   1359   };
   1360 
   1361   /// @brief Add the declaration D into this context.
   1362   ///
   1363   /// This routine should be invoked when the declaration D has first
   1364   /// been declared, to place D into the context where it was
   1365   /// (lexically) defined. Every declaration must be added to one
   1366   /// (and only one!) context, where it can be visited via
   1367   /// [decls_begin(), decls_end()). Once a declaration has been added
   1368   /// to its lexical context, the corresponding DeclContext owns the
   1369   /// declaration.
   1370   ///
   1371   /// If D is also a NamedDecl, it will be made visible within its
   1372   /// semantic context via makeDeclVisibleInContext.
   1373   void addDecl(Decl *D);
   1374 
   1375   /// @brief Add the declaration D into this context, but suppress
   1376   /// searches for external declarations with the same name.
   1377   ///
   1378   /// Although analogous in function to addDecl, this removes an
   1379   /// important check.  This is only useful if the Decl is being
   1380   /// added in response to an external search; in all other cases,
   1381   /// addDecl() is the right function to use.
   1382   /// See the ASTImporter for use cases.
   1383   void addDeclInternal(Decl *D);
   1384 
   1385   /// @brief Add the declaration D to this context without modifying
   1386   /// any lookup tables.
   1387   ///
   1388   /// This is useful for some operations in dependent contexts where
   1389   /// the semantic context might not be dependent;  this basically
   1390   /// only happens with friends.
   1391   void addHiddenDecl(Decl *D);
   1392 
   1393   /// @brief Removes a declaration from this context.
   1394   void removeDecl(Decl *D);
   1395 
   1396   /// lookup_iterator - An iterator that provides access to the results
   1397   /// of looking up a name within this context.
   1398   typedef NamedDecl **lookup_iterator;
   1399 
   1400   /// lookup_const_iterator - An iterator that provides non-mutable
   1401   /// access to the results of lookup up a name within this context.
   1402   typedef NamedDecl * const * lookup_const_iterator;
   1403 
   1404   typedef DeclContextLookupResult lookup_result;
   1405   typedef DeclContextLookupConstResult lookup_const_result;
   1406 
   1407   /// lookup - Find the declarations (if any) with the given Name in
   1408   /// this context. Returns a range of iterators that contains all of
   1409   /// the declarations with this name, with object, function, member,
   1410   /// and enumerator names preceding any tag name. Note that this
   1411   /// routine will not look into parent contexts.
   1412   lookup_result lookup(DeclarationName Name);
   1413   lookup_const_result lookup(DeclarationName Name) const;
   1414 
   1415   /// \brief A simplistic name lookup mechanism that performs name lookup
   1416   /// into this declaration context without consulting the external source.
   1417   ///
   1418   /// This function should almost never be used, because it subverts the
   1419   /// usual relationship between a DeclContext and the external source.
   1420   /// See the ASTImporter for the (few, but important) use cases.
   1421   void localUncachedLookup(DeclarationName Name,
   1422                            llvm::SmallVectorImpl<NamedDecl *> &Results);
   1423 
   1424   /// @brief Makes a declaration visible within this context.
   1425   ///
   1426   /// This routine makes the declaration D visible to name lookup
   1427   /// within this context and, if this is a transparent context,
   1428   /// within its parent contexts up to the first enclosing
   1429   /// non-transparent context. Making a declaration visible within a
   1430   /// context does not transfer ownership of a declaration, and a
   1431   /// declaration can be visible in many contexts that aren't its
   1432   /// lexical context.
   1433   ///
   1434   /// If D is a redeclaration of an existing declaration that is
   1435   /// visible from this context, as determined by
   1436   /// NamedDecl::declarationReplaces, the previous declaration will be
   1437   /// replaced with D.
   1438   void makeDeclVisibleInContext(NamedDecl *D);
   1439 
   1440   /// all_lookups_iterator - An iterator that provides a view over the results
   1441   /// of looking up every possible name.
   1442   class all_lookups_iterator;
   1443 
   1444   all_lookups_iterator lookups_begin() const;
   1445 
   1446   all_lookups_iterator lookups_end() const;
   1447 
   1448   /// udir_iterator - Iterates through the using-directives stored
   1449   /// within this context.
   1450   typedef UsingDirectiveDecl * const * udir_iterator;
   1451 
   1452   typedef std::pair<udir_iterator, udir_iterator> udir_iterator_range;
   1453 
   1454   udir_iterator_range getUsingDirectives() const;
   1455 
   1456   udir_iterator using_directives_begin() const {
   1457     return getUsingDirectives().first;
   1458   }
   1459 
   1460   udir_iterator using_directives_end() const {
   1461     return getUsingDirectives().second;
   1462   }
   1463 
   1464   // These are all defined in DependentDiagnostic.h.
   1465   class ddiag_iterator;
   1466   inline ddiag_iterator ddiag_begin() const;
   1467   inline ddiag_iterator ddiag_end() const;
   1468 
   1469   // Low-level accessors
   1470 
   1471   /// \brief Retrieve the internal representation of the lookup structure.
   1472   /// This may omit some names if we are lazily building the structure.
   1473   StoredDeclsMap *getLookupPtr() const { return LookupPtr.getPointer(); }
   1474 
   1475   /// \brief Ensure the lookup structure is fully-built and return it.
   1476   StoredDeclsMap *buildLookup();
   1477 
   1478   /// \brief Whether this DeclContext has external storage containing
   1479   /// additional declarations that are lexically in this context.
   1480   bool hasExternalLexicalStorage() const { return ExternalLexicalStorage; }
   1481 
   1482   /// \brief State whether this DeclContext has external storage for
   1483   /// declarations lexically in this context.
   1484   void setHasExternalLexicalStorage(bool ES = true) {
   1485     ExternalLexicalStorage = ES;
   1486   }
   1487 
   1488   /// \brief Whether this DeclContext has external storage containing
   1489   /// additional declarations that are visible in this context.
   1490   bool hasExternalVisibleStorage() const { return ExternalVisibleStorage; }
   1491 
   1492   /// \brief State whether this DeclContext has external storage for
   1493   /// declarations visible in this context.
   1494   void setHasExternalVisibleStorage(bool ES = true) {
   1495     ExternalVisibleStorage = ES;
   1496   }
   1497 
   1498   /// \brief Determine whether the given declaration is stored in the list of
   1499   /// declarations lexically within this context.
   1500   bool isDeclInLexicalTraversal(const Decl *D) const {
   1501     return D && (D->NextInContextAndBits.getPointer() || D == FirstDecl ||
   1502                  D == LastDecl);
   1503   }
   1504 
   1505   static bool classof(const Decl *D);
   1506   static bool classof(const DeclContext *D) { return true; }
   1507 #define DECL(NAME, BASE)
   1508 #define DECL_CONTEXT(NAME) \
   1509   static bool classof(const NAME##Decl *D) { return true; }
   1510 #include "clang/AST/DeclNodes.inc"
   1511 
   1512   LLVM_ATTRIBUTE_USED void dumpDeclContext() const;
   1513 
   1514 private:
   1515   void LoadLexicalDeclsFromExternalStorage() const;
   1516 
   1517   /// @brief Makes a declaration visible within this context, but
   1518   /// suppresses searches for external declarations with the same
   1519   /// name.
   1520   ///
   1521   /// Analogous to makeDeclVisibleInContext, but for the exclusive
   1522   /// use of addDeclInternal().
   1523   void makeDeclVisibleInContextInternal(NamedDecl *D);
   1524 
   1525   friend class DependentDiagnostic;
   1526   StoredDeclsMap *CreateStoredDeclsMap(ASTContext &C) const;
   1527 
   1528   void buildLookupImpl(DeclContext *DCtx);
   1529   void makeDeclVisibleInContextWithFlags(NamedDecl *D, bool Internal,
   1530                                          bool Rediscoverable);
   1531   void makeDeclVisibleInContextImpl(NamedDecl *D, bool Internal);
   1532 };
   1533 
   1534 inline bool Decl::isTemplateParameter() const {
   1535   return getKind() == TemplateTypeParm || getKind() == NonTypeTemplateParm ||
   1536          getKind() == TemplateTemplateParm;
   1537 }
   1538 
   1539 // Specialization selected when ToTy is not a known subclass of DeclContext.
   1540 template <class ToTy,
   1541           bool IsKnownSubtype = ::llvm::is_base_of< DeclContext, ToTy>::value>
   1542 struct cast_convert_decl_context {
   1543   static const ToTy *doit(const DeclContext *Val) {
   1544     return static_cast<const ToTy*>(Decl::castFromDeclContext(Val));
   1545   }
   1546 
   1547   static ToTy *doit(DeclContext *Val) {
   1548     return static_cast<ToTy*>(Decl::castFromDeclContext(Val));
   1549   }
   1550 };
   1551 
   1552 // Specialization selected when ToTy is a known subclass of DeclContext.
   1553 template <class ToTy>
   1554 struct cast_convert_decl_context<ToTy, true> {
   1555   static const ToTy *doit(const DeclContext *Val) {
   1556     return static_cast<const ToTy*>(Val);
   1557   }
   1558 
   1559   static ToTy *doit(DeclContext *Val) {
   1560     return static_cast<ToTy*>(Val);
   1561   }
   1562 };
   1563 
   1564 
   1565 } // end clang.
   1566 
   1567 namespace llvm {
   1568 
   1569 /// isa<T>(DeclContext*)
   1570 template <typename To>
   1571 struct isa_impl<To, ::clang::DeclContext> {
   1572   static bool doit(const ::clang::DeclContext &Val) {
   1573     return To::classofKind(Val.getDeclKind());
   1574   }
   1575 };
   1576 
   1577 /// cast<T>(DeclContext*)
   1578 template<class ToTy>
   1579 struct cast_convert_val<ToTy,
   1580                         const ::clang::DeclContext,const ::clang::DeclContext> {
   1581   static const ToTy &doit(const ::clang::DeclContext &Val) {
   1582     return *::clang::cast_convert_decl_context<ToTy>::doit(&Val);
   1583   }
   1584 };
   1585 template<class ToTy>
   1586 struct cast_convert_val<ToTy, ::clang::DeclContext, ::clang::DeclContext> {
   1587   static ToTy &doit(::clang::DeclContext &Val) {
   1588     return *::clang::cast_convert_decl_context<ToTy>::doit(&Val);
   1589   }
   1590 };
   1591 template<class ToTy>
   1592 struct cast_convert_val<ToTy,
   1593                      const ::clang::DeclContext*, const ::clang::DeclContext*> {
   1594   static const ToTy *doit(const ::clang::DeclContext *Val) {
   1595     return ::clang::cast_convert_decl_context<ToTy>::doit(Val);
   1596   }
   1597 };
   1598 template<class ToTy>
   1599 struct cast_convert_val<ToTy, ::clang::DeclContext*, ::clang::DeclContext*> {
   1600   static ToTy *doit(::clang::DeclContext *Val) {
   1601     return ::clang::cast_convert_decl_context<ToTy>::doit(Val);
   1602   }
   1603 };
   1604 
   1605 /// Implement cast_convert_val for Decl -> DeclContext conversions.
   1606 template<class FromTy>
   1607 struct cast_convert_val< ::clang::DeclContext, FromTy, FromTy> {
   1608   static ::clang::DeclContext &doit(const FromTy &Val) {
   1609     return *FromTy::castToDeclContext(&Val);
   1610   }
   1611 };
   1612 
   1613 template<class FromTy>
   1614 struct cast_convert_val< ::clang::DeclContext, FromTy*, FromTy*> {
   1615   static ::clang::DeclContext *doit(const FromTy *Val) {
   1616     return FromTy::castToDeclContext(Val);
   1617   }
   1618 };
   1619 
   1620 template<class FromTy>
   1621 struct cast_convert_val< const ::clang::DeclContext, FromTy, FromTy> {
   1622   static const ::clang::DeclContext &doit(const FromTy &Val) {
   1623     return *FromTy::castToDeclContext(&Val);
   1624   }
   1625 };
   1626 
   1627 template<class FromTy>
   1628 struct cast_convert_val< const ::clang::DeclContext, FromTy*, FromTy*> {
   1629   static const ::clang::DeclContext *doit(const FromTy *Val) {
   1630     return FromTy::castToDeclContext(Val);
   1631   }
   1632 };
   1633 
   1634 } // end namespace llvm
   1635 
   1636 #endif
   1637