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