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