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