DeclBase.h revision 341785ec52f87c0803ba52dc88faac4e136f8593
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 return setAttrsImpl(Attrs, getASTContext()); 394 } 395 AttrVec &getAttrs() { 396 return const_cast<AttrVec&>(const_cast<const Decl*>(this)->getAttrs()); 397 } 398 const AttrVec &getAttrs() const; 399 void swapAttrs(Decl *D); 400 void dropAttrs(); 401 402 void addAttr(Attr *A) { 403 if (hasAttrs()) 404 getAttrs().push_back(A); 405 else 406 setAttrs(AttrVec(1, A)); 407 } 408 409 typedef AttrVec::const_iterator attr_iterator; 410 411 // FIXME: Do not rely on iterators having comparable singular values. 412 // Note that this should error out if they do not. 413 attr_iterator attr_begin() const { 414 return hasAttrs() ? getAttrs().begin() : 0; 415 } 416 attr_iterator attr_end() const { 417 return hasAttrs() ? getAttrs().end() : 0; 418 } 419 420 template <typename T> 421 void dropAttr() { 422 if (!HasAttrs) return; 423 424 AttrVec &Attrs = getAttrs(); 425 for (unsigned i = 0, e = Attrs.size(); i != e; /* in loop */) { 426 if (isa<T>(Attrs[i])) { 427 Attrs.erase(Attrs.begin() + i); 428 --e; 429 } 430 else 431 ++i; 432 } 433 if (Attrs.empty()) 434 HasAttrs = false; 435 } 436 437 template <typename T> 438 specific_attr_iterator<T> specific_attr_begin() const { 439 return specific_attr_iterator<T>(attr_begin()); 440 } 441 template <typename T> 442 specific_attr_iterator<T> specific_attr_end() const { 443 return specific_attr_iterator<T>(attr_end()); 444 } 445 446 template<typename T> T *getAttr() const { 447 return hasAttrs() ? getSpecificAttr<T>(getAttrs()) : 0; 448 } 449 template<typename T> bool hasAttr() const { 450 return hasAttrs() && hasSpecificAttr<T>(getAttrs()); 451 } 452 453 /// getMaxAlignment - return the maximum alignment specified by attributes 454 /// on this decl, 0 if there are none. 455 unsigned getMaxAlignment() const { 456 return hasAttrs() ? getMaxAttrAlignment(getAttrs(), getASTContext()) : 0; 457 } 458 459 /// setInvalidDecl - Indicates the Decl had a semantic error. This 460 /// allows for graceful error recovery. 461 void setInvalidDecl(bool Invalid = true); 462 bool isInvalidDecl() const { return (bool) InvalidDecl; } 463 464 /// isImplicit - Indicates whether the declaration was implicitly 465 /// generated by the implementation. If false, this declaration 466 /// was written explicitly in the source code. 467 bool isImplicit() const { return Implicit; } 468 void setImplicit(bool I = true) { Implicit = I; } 469 470 /// \brief Whether this declaration was used, meaning that a definition 471 /// is required. 472 /// 473 /// \param CheckUsedAttr When true, also consider the "used" attribute 474 /// (in addition to the "used" bit set by \c setUsed()) when determining 475 /// whether the function is used. 476 bool isUsed(bool CheckUsedAttr = true) const; 477 478 void setUsed(bool U = true) { Used = U; } 479 480 /// \brief Whether this declaration was referenced. 481 bool isReferenced() const; 482 483 void setReferenced(bool R = true) { Referenced = R; } 484 485 /// \brief Whether this declaration is a top-level declaration (function, 486 /// global variable, etc.) that is lexically inside an objc container 487 /// definition. 488 bool isTopLevelDeclInObjCContainer() const { 489 return NextInContextAndBits.getInt() & TopLevelDeclInObjCContainerFlag; 490 } 491 492 void setTopLevelDeclInObjCContainer(bool V = true) { 493 unsigned Bits = NextInContextAndBits.getInt(); 494 if (V) 495 Bits |= TopLevelDeclInObjCContainerFlag; 496 else 497 Bits &= ~TopLevelDeclInObjCContainerFlag; 498 NextInContextAndBits.setInt(Bits); 499 } 500 501protected: 502 /// \brief Whether this declaration was marked as being private to the 503 /// module in which it was defined. 504 bool isModulePrivate() const { 505 return NextInContextAndBits.getInt() & ModulePrivateFlag; 506 } 507 508 /// \brief Specify whether this declaration was marked as being private 509 /// to the module in which it was defined. 510 void setModulePrivate(bool MP = true) { 511 unsigned Bits = NextInContextAndBits.getInt(); 512 if (MP) 513 Bits |= ModulePrivateFlag; 514 else 515 Bits &= ~ModulePrivateFlag; 516 NextInContextAndBits.setInt(Bits); 517 } 518 519 /// \brief Set the owning module ID. 520 void setOwningModuleID(unsigned ID) { 521 assert(isFromASTFile() && "Only works on a deserialized declaration"); 522 *((unsigned*)this - 2) = ID; 523 } 524 525public: 526 527 /// \brief Determine the availability of the given declaration. 528 /// 529 /// This routine will determine the most restrictive availability of 530 /// the given declaration (e.g., preferring 'unavailable' to 531 /// 'deprecated'). 532 /// 533 /// \param Message If non-NULL and the result is not \c 534 /// AR_Available, will be set to a (possibly empty) message 535 /// describing why the declaration has not been introduced, is 536 /// deprecated, or is unavailable. 537 AvailabilityResult getAvailability(std::string *Message = 0) const; 538 539 /// \brief Determine whether this declaration is marked 'deprecated'. 540 /// 541 /// \param Message If non-NULL and the declaration is deprecated, 542 /// this will be set to the message describing why the declaration 543 /// was deprecated (which may be empty). 544 bool isDeprecated(std::string *Message = 0) const { 545 return getAvailability(Message) == AR_Deprecated; 546 } 547 548 /// \brief Determine whether this declaration is marked 'unavailable'. 549 /// 550 /// \param Message If non-NULL and the declaration is unavailable, 551 /// this will be set to the message describing why the declaration 552 /// was made unavailable (which may be empty). 553 bool isUnavailable(std::string *Message = 0) const { 554 return getAvailability(Message) == AR_Unavailable; 555 } 556 557 /// \brief Determine whether this is a weak-imported symbol. 558 /// 559 /// Weak-imported symbols are typically marked with the 560 /// 'weak_import' attribute, but may also be marked with an 561 /// 'availability' attribute where we're targing a platform prior to 562 /// the introduction of this feature. 563 bool isWeakImported() const; 564 565 /// \brief Determines whether this symbol can be weak-imported, 566 /// e.g., whether it would be well-formed to add the weak_import 567 /// attribute. 568 /// 569 /// \param IsDefinition Set to \c true to indicate that this 570 /// declaration cannot be weak-imported because it has a definition. 571 bool canBeWeakImported(bool &IsDefinition) const; 572 573 /// \brief Determine whether this declaration came from an AST file (such as 574 /// a precompiled header or module) rather than having been parsed. 575 bool isFromASTFile() const { return FromASTFile; } 576 577 /// \brief Retrieve the global declaration ID associated with this 578 /// declaration, which specifies where in the 579 unsigned getGlobalID() const { 580 if (isFromASTFile()) 581 return *((const unsigned*)this - 1); 582 return 0; 583 } 584 585 /// \brief Retrieve the global ID of the module that owns this particular 586 /// declaration. 587 unsigned getOwningModuleID() const { 588 if (isFromASTFile()) 589 return *((const unsigned*)this - 2); 590 591 return 0; 592 } 593 594 unsigned getIdentifierNamespace() const { 595 return IdentifierNamespace; 596 } 597 bool isInIdentifierNamespace(unsigned NS) const { 598 return getIdentifierNamespace() & NS; 599 } 600 static unsigned getIdentifierNamespaceForKind(Kind DK); 601 602 bool hasTagIdentifierNamespace() const { 603 return isTagIdentifierNamespace(getIdentifierNamespace()); 604 } 605 static bool isTagIdentifierNamespace(unsigned NS) { 606 // TagDecls have Tag and Type set and may also have TagFriend. 607 return (NS & ~IDNS_TagFriend) == (IDNS_Tag | IDNS_Type); 608 } 609 610 /// getLexicalDeclContext - The declaration context where this Decl was 611 /// lexically declared (LexicalDC). May be different from 612 /// getDeclContext() (SemanticDC). 613 /// e.g.: 614 /// 615 /// namespace A { 616 /// void f(); // SemanticDC == LexicalDC == 'namespace A' 617 /// } 618 /// void A::f(); // SemanticDC == namespace 'A' 619 /// // LexicalDC == global namespace 620 DeclContext *getLexicalDeclContext() { 621 if (isInSemaDC()) 622 return getSemanticDC(); 623 return getMultipleDC()->LexicalDC; 624 } 625 const DeclContext *getLexicalDeclContext() const { 626 return const_cast<Decl*>(this)->getLexicalDeclContext(); 627 } 628 629 virtual bool isOutOfLine() const { 630 return getLexicalDeclContext() != getDeclContext(); 631 } 632 633 /// setDeclContext - Set both the semantic and lexical DeclContext 634 /// to DC. 635 void setDeclContext(DeclContext *DC); 636 637 void setLexicalDeclContext(DeclContext *DC); 638 639 /// isDefinedOutsideFunctionOrMethod - This predicate returns true if this 640 /// scoped decl is defined outside the current function or method. This is 641 /// roughly global variables and functions, but also handles enums (which 642 /// could be defined inside or outside a function etc). 643 bool isDefinedOutsideFunctionOrMethod() const { 644 return getParentFunctionOrMethod() == 0; 645 } 646 647 /// \brief If this decl is defined inside a function/method/block it returns 648 /// the corresponding DeclContext, otherwise it returns null. 649 const DeclContext *getParentFunctionOrMethod() const; 650 DeclContext *getParentFunctionOrMethod() { 651 return const_cast<DeclContext*>( 652 const_cast<const Decl*>(this)->getParentFunctionOrMethod()); 653 } 654 655 /// \brief Retrieves the "canonical" declaration of the given declaration. 656 virtual Decl *getCanonicalDecl() { return this; } 657 const Decl *getCanonicalDecl() const { 658 return const_cast<Decl*>(this)->getCanonicalDecl(); 659 } 660 661 /// \brief Whether this particular Decl is a canonical one. 662 bool isCanonicalDecl() const { return getCanonicalDecl() == this; } 663 664protected: 665 /// \brief Returns the next redeclaration or itself if this is the only decl. 666 /// 667 /// Decl subclasses that can be redeclared should override this method so that 668 /// Decl::redecl_iterator can iterate over them. 669 virtual Decl *getNextRedeclaration() { return this; } 670 671 /// \brief Implementation of getPreviousDecl(), to be overridden by any 672 /// subclass that has a redeclaration chain. 673 virtual Decl *getPreviousDeclImpl() { return 0; } 674 675 /// \brief Implementation of getMostRecentDecl(), to be overridden by any 676 /// subclass that has a redeclaration chain. 677 virtual Decl *getMostRecentDeclImpl() { return this; } 678 679public: 680 /// \brief Iterates through all the redeclarations of the same decl. 681 class redecl_iterator { 682 /// Current - The current declaration. 683 Decl *Current; 684 Decl *Starter; 685 686 public: 687 typedef Decl* value_type; 688 typedef Decl* reference; 689 typedef Decl* pointer; 690 typedef std::forward_iterator_tag iterator_category; 691 typedef std::ptrdiff_t difference_type; 692 693 redecl_iterator() : Current(0) { } 694 explicit redecl_iterator(Decl *C) : Current(C), Starter(C) { } 695 696 reference operator*() const { return Current; } 697 pointer operator->() const { return Current; } 698 699 redecl_iterator& operator++() { 700 assert(Current && "Advancing while iterator has reached end"); 701 // Get either previous decl or latest decl. 702 Decl *Next = Current->getNextRedeclaration(); 703 assert(Next && "Should return next redeclaration or itself, never null!"); 704 Current = (Next != Starter ? Next : 0); 705 return *this; 706 } 707 708 redecl_iterator operator++(int) { 709 redecl_iterator tmp(*this); 710 ++(*this); 711 return tmp; 712 } 713 714 friend bool operator==(redecl_iterator x, redecl_iterator y) { 715 return x.Current == y.Current; 716 } 717 friend bool operator!=(redecl_iterator x, redecl_iterator y) { 718 return x.Current != y.Current; 719 } 720 }; 721 722 /// \brief Returns iterator for all the redeclarations of the same decl. 723 /// It will iterate at least once (when this decl is the only one). 724 redecl_iterator redecls_begin() const { 725 return redecl_iterator(const_cast<Decl*>(this)); 726 } 727 redecl_iterator redecls_end() const { return redecl_iterator(); } 728 729 /// \brief Retrieve the previous declaration that declares the same entity 730 /// as this declaration, or NULL if there is no previous declaration. 731 Decl *getPreviousDecl() { return getPreviousDeclImpl(); } 732 733 /// \brief Retrieve the most recent declaration that declares the same entity 734 /// as this declaration, or NULL if there is no previous declaration. 735 const Decl *getPreviousDecl() const { 736 return const_cast<Decl *>(this)->getPreviousDeclImpl(); 737 } 738 739 /// \brief Retrieve the most recent declaration that declares the same entity 740 /// as this declaration (which may be this declaration). 741 Decl *getMostRecentDecl() { return getMostRecentDeclImpl(); } 742 743 /// \brief Retrieve the most recent declaration that declares the same entity 744 /// as this declaration (which may be this declaration). 745 const Decl *getMostRecentDecl() const { 746 return const_cast<Decl *>(this)->getMostRecentDeclImpl(); 747 } 748 749 /// getBody - If this Decl represents a declaration for a body of code, 750 /// such as a function or method definition, this method returns the 751 /// top-level Stmt* of that body. Otherwise this method returns null. 752 virtual Stmt* getBody() const { return 0; } 753 754 /// \brief Returns true if this Decl represents a declaration for a body of 755 /// code, such as a function or method definition. 756 virtual bool hasBody() const { return getBody() != 0; } 757 758 /// getBodyRBrace - Gets the right brace of the body, if a body exists. 759 /// This works whether the body is a CompoundStmt or a CXXTryStmt. 760 SourceLocation getBodyRBrace() const; 761 762 // global temp stats (until we have a per-module visitor) 763 static void add(Kind k); 764 static bool CollectingStats(bool Enable = false); 765 static void PrintStats(); 766 767 /// isTemplateParameter - Determines whether this declaration is a 768 /// template parameter. 769 bool isTemplateParameter() const; 770 771 /// isTemplateParameter - Determines whether this declaration is a 772 /// template parameter pack. 773 bool isTemplateParameterPack() const; 774 775 /// \brief Whether this declaration is a parameter pack. 776 bool isParameterPack() const; 777 778 /// \brief returns true if this declaration is a template 779 bool isTemplateDecl() const; 780 781 /// \brief Whether this declaration is a function or function template. 782 bool isFunctionOrFunctionTemplate() const; 783 784 /// \brief Changes the namespace of this declaration to reflect that it's 785 /// the object of a friend declaration. 786 /// 787 /// These declarations appear in the lexical context of the friending 788 /// class, but in the semantic context of the actual entity. This property 789 /// applies only to a specific decl object; other redeclarations of the 790 /// same entity may not (and probably don't) share this property. 791 void setObjectOfFriendDecl(bool PreviouslyDeclared) { 792 unsigned OldNS = IdentifierNamespace; 793 assert((OldNS & (IDNS_Tag | IDNS_Ordinary | 794 IDNS_TagFriend | IDNS_OrdinaryFriend)) && 795 "namespace includes neither ordinary nor tag"); 796 assert(!(OldNS & ~(IDNS_Tag | IDNS_Ordinary | IDNS_Type | 797 IDNS_TagFriend | IDNS_OrdinaryFriend)) && 798 "namespace includes other than ordinary or tag"); 799 800 IdentifierNamespace = 0; 801 if (OldNS & (IDNS_Tag | IDNS_TagFriend)) { 802 IdentifierNamespace |= IDNS_TagFriend; 803 if (PreviouslyDeclared) IdentifierNamespace |= IDNS_Tag | IDNS_Type; 804 } 805 806 if (OldNS & (IDNS_Ordinary | IDNS_OrdinaryFriend)) { 807 IdentifierNamespace |= IDNS_OrdinaryFriend; 808 if (PreviouslyDeclared) IdentifierNamespace |= IDNS_Ordinary; 809 } 810 } 811 812 enum FriendObjectKind { 813 FOK_None, // not a friend object 814 FOK_Declared, // a friend of a previously-declared entity 815 FOK_Undeclared // a friend of a previously-undeclared entity 816 }; 817 818 /// \brief Determines whether this declaration is the object of a 819 /// friend declaration and, if so, what kind. 820 /// 821 /// There is currently no direct way to find the associated FriendDecl. 822 FriendObjectKind getFriendObjectKind() const { 823 unsigned mask 824 = (IdentifierNamespace & (IDNS_TagFriend | IDNS_OrdinaryFriend)); 825 if (!mask) return FOK_None; 826 return (IdentifierNamespace & (IDNS_Tag | IDNS_Ordinary) ? 827 FOK_Declared : FOK_Undeclared); 828 } 829 830 /// Specifies that this declaration is a C++ overloaded non-member. 831 void setNonMemberOperator() { 832 assert(getKind() == Function || getKind() == FunctionTemplate); 833 assert((IdentifierNamespace & IDNS_Ordinary) && 834 "visible non-member operators should be in ordinary namespace"); 835 IdentifierNamespace |= IDNS_NonMemberOperator; 836 } 837 838 // Implement isa/cast/dyncast/etc. 839 static bool classof(const Decl *) { return true; } 840 static bool classofKind(Kind K) { return true; } 841 static DeclContext *castToDeclContext(const Decl *); 842 static Decl *castFromDeclContext(const DeclContext *); 843 844 void print(raw_ostream &Out, unsigned Indentation = 0, 845 bool PrintInstantiation = false) const; 846 void print(raw_ostream &Out, const PrintingPolicy &Policy, 847 unsigned Indentation = 0, bool PrintInstantiation = false) const; 848 static void printGroup(Decl** Begin, unsigned NumDecls, 849 raw_ostream &Out, const PrintingPolicy &Policy, 850 unsigned Indentation = 0); 851 LLVM_ATTRIBUTE_USED void dump() const; 852 LLVM_ATTRIBUTE_USED void dumpXML() const; 853 void dumpXML(raw_ostream &OS) const; 854 855private: 856 const Attr *getAttrsImpl() const; 857 void setAttrsImpl(const AttrVec& Attrs, ASTContext &Ctx); 858 void setDeclContextsImpl(DeclContext *SemaDC, DeclContext *LexicalDC, 859 ASTContext &Ctx); 860 861protected: 862 ASTMutationListener *getASTMutationListener() const; 863}; 864 865/// \brief Determine whether two declarations declare the same entity. 866inline bool declaresSameEntity(const Decl *D1, const Decl *D2) { 867 if (!D1 || !D2) 868 return false; 869 870 if (D1 == D2) 871 return true; 872 873 return D1->getCanonicalDecl() == D2->getCanonicalDecl(); 874} 875 876/// PrettyStackTraceDecl - If a crash occurs, indicate that it happened when 877/// doing something to a specific decl. 878class PrettyStackTraceDecl : public llvm::PrettyStackTraceEntry { 879 const Decl *TheDecl; 880 SourceLocation Loc; 881 SourceManager &SM; 882 const char *Message; 883public: 884 PrettyStackTraceDecl(const Decl *theDecl, SourceLocation L, 885 SourceManager &sm, const char *Msg) 886 : TheDecl(theDecl), Loc(L), SM(sm), Message(Msg) {} 887 888 virtual void print(raw_ostream &OS) const; 889}; 890 891class DeclContextLookupResult 892 : public std::pair<NamedDecl**,NamedDecl**> { 893public: 894 DeclContextLookupResult(NamedDecl **I, NamedDecl **E) 895 : std::pair<NamedDecl**,NamedDecl**>(I, E) {} 896 DeclContextLookupResult() 897 : std::pair<NamedDecl**,NamedDecl**>() {} 898 899 using std::pair<NamedDecl**,NamedDecl**>::operator=; 900}; 901 902class DeclContextLookupConstResult 903 : public std::pair<NamedDecl*const*, NamedDecl*const*> { 904public: 905 DeclContextLookupConstResult(std::pair<NamedDecl**,NamedDecl**> R) 906 : std::pair<NamedDecl*const*, NamedDecl*const*>(R) {} 907 DeclContextLookupConstResult(NamedDecl * const *I, NamedDecl * const *E) 908 : std::pair<NamedDecl*const*, NamedDecl*const*>(I, E) {} 909 DeclContextLookupConstResult() 910 : std::pair<NamedDecl*const*, NamedDecl*const*>() {} 911 912 using std::pair<NamedDecl*const*,NamedDecl*const*>::operator=; 913}; 914 915/// DeclContext - This is used only as base class of specific decl types that 916/// can act as declaration contexts. These decls are (only the top classes 917/// that directly derive from DeclContext are mentioned, not their subclasses): 918/// 919/// TranslationUnitDecl 920/// NamespaceDecl 921/// FunctionDecl 922/// TagDecl 923/// ObjCMethodDecl 924/// ObjCContainerDecl 925/// LinkageSpecDecl 926/// BlockDecl 927/// 928class DeclContext { 929 /// DeclKind - This indicates which class this is. 930 unsigned DeclKind : 8; 931 932 /// \brief Whether this declaration context also has some external 933 /// storage that contains additional declarations that are lexically 934 /// part of this context. 935 mutable unsigned ExternalLexicalStorage : 1; 936 937 /// \brief Whether this declaration context also has some external 938 /// storage that contains additional declarations that are visible 939 /// in this context. 940 mutable unsigned ExternalVisibleStorage : 1; 941 942 /// \brief Pointer to the data structure used to lookup declarations 943 /// within this context (or a DependentStoredDeclsMap if this is a 944 /// dependent context). 945 mutable StoredDeclsMap *LookupPtr; 946 947protected: 948 /// FirstDecl - The first declaration stored within this declaration 949 /// context. 950 mutable Decl *FirstDecl; 951 952 /// LastDecl - The last declaration stored within this declaration 953 /// context. FIXME: We could probably cache this value somewhere 954 /// outside of the DeclContext, to reduce the size of DeclContext by 955 /// another pointer. 956 mutable Decl *LastDecl; 957 958 friend class ExternalASTSource; 959 960 /// \brief Build up a chain of declarations. 961 /// 962 /// \returns the first/last pair of declarations. 963 static std::pair<Decl *, Decl *> 964 BuildDeclChain(ArrayRef<Decl*> Decls, bool FieldsAlreadyLoaded); 965 966 DeclContext(Decl::Kind K) 967 : DeclKind(K), ExternalLexicalStorage(false), 968 ExternalVisibleStorage(false), LookupPtr(0), FirstDecl(0), 969 LastDecl(0) { } 970 971public: 972 ~DeclContext(); 973 974 Decl::Kind getDeclKind() const { 975 return static_cast<Decl::Kind>(DeclKind); 976 } 977 const char *getDeclKindName() const; 978 979 /// getParent - Returns the containing DeclContext. 980 DeclContext *getParent() { 981 return cast<Decl>(this)->getDeclContext(); 982 } 983 const DeclContext *getParent() const { 984 return const_cast<DeclContext*>(this)->getParent(); 985 } 986 987 /// getLexicalParent - Returns the containing lexical DeclContext. May be 988 /// different from getParent, e.g.: 989 /// 990 /// namespace A { 991 /// struct S; 992 /// } 993 /// struct A::S {}; // getParent() == namespace 'A' 994 /// // getLexicalParent() == translation unit 995 /// 996 DeclContext *getLexicalParent() { 997 return cast<Decl>(this)->getLexicalDeclContext(); 998 } 999 const DeclContext *getLexicalParent() const { 1000 return const_cast<DeclContext*>(this)->getLexicalParent(); 1001 } 1002 1003 DeclContext *getLookupParent(); 1004 1005 const DeclContext *getLookupParent() const { 1006 return const_cast<DeclContext*>(this)->getLookupParent(); 1007 } 1008 1009 ASTContext &getParentASTContext() const { 1010 return cast<Decl>(this)->getASTContext(); 1011 } 1012 1013 bool isClosure() const { 1014 return DeclKind == Decl::Block; 1015 } 1016 1017 bool isObjCContainer() const { 1018 switch (DeclKind) { 1019 case Decl::ObjCCategory: 1020 case Decl::ObjCCategoryImpl: 1021 case Decl::ObjCImplementation: 1022 case Decl::ObjCInterface: 1023 case Decl::ObjCProtocol: 1024 return true; 1025 } 1026 return false; 1027 } 1028 1029 bool isFunctionOrMethod() const { 1030 switch (DeclKind) { 1031 case Decl::Block: 1032 case Decl::ObjCMethod: 1033 return true; 1034 default: 1035 return DeclKind >= Decl::firstFunction && DeclKind <= Decl::lastFunction; 1036 } 1037 } 1038 1039 bool isFileContext() const { 1040 return DeclKind == Decl::TranslationUnit || DeclKind == Decl::Namespace; 1041 } 1042 1043 bool isTranslationUnit() const { 1044 return DeclKind == Decl::TranslationUnit; 1045 } 1046 1047 bool isRecord() const { 1048 return DeclKind >= Decl::firstRecord && DeclKind <= Decl::lastRecord; 1049 } 1050 1051 bool isNamespace() const { 1052 return DeclKind == Decl::Namespace; 1053 } 1054 1055 bool isInlineNamespace() const; 1056 1057 /// \brief Determines whether this context is dependent on a 1058 /// template parameter. 1059 bool isDependentContext() const; 1060 1061 /// isTransparentContext - Determines whether this context is a 1062 /// "transparent" context, meaning that the members declared in this 1063 /// context are semantically declared in the nearest enclosing 1064 /// non-transparent (opaque) context but are lexically declared in 1065 /// this context. For example, consider the enumerators of an 1066 /// enumeration type: 1067 /// @code 1068 /// enum E { 1069 /// Val1 1070 /// }; 1071 /// @endcode 1072 /// Here, E is a transparent context, so its enumerator (Val1) will 1073 /// appear (semantically) that it is in the same context of E. 1074 /// Examples of transparent contexts include: enumerations (except for 1075 /// C++0x scoped enums), and C++ linkage specifications. 1076 bool isTransparentContext() const; 1077 1078 /// \brief Determines whether this context is, or is nested within, 1079 /// a C++ extern "C" linkage spec. 1080 bool isExternCContext() const; 1081 1082 /// \brief Determine whether this declaration context is equivalent 1083 /// to the declaration context DC. 1084 bool Equals(const DeclContext *DC) const { 1085 return DC && this->getPrimaryContext() == DC->getPrimaryContext(); 1086 } 1087 1088 /// \brief Determine whether this declaration context encloses the 1089 /// declaration context DC. 1090 bool Encloses(const DeclContext *DC) const; 1091 1092 /// \brief Find the nearest non-closure ancestor of this context, 1093 /// i.e. the innermost semantic parent of this context which is not 1094 /// a closure. A context may be its own non-closure ancestor. 1095 DeclContext *getNonClosureAncestor(); 1096 const DeclContext *getNonClosureAncestor() const { 1097 return const_cast<DeclContext*>(this)->getNonClosureAncestor(); 1098 } 1099 1100 /// getPrimaryContext - There may be many different 1101 /// declarations of the same entity (including forward declarations 1102 /// of classes, multiple definitions of namespaces, etc.), each with 1103 /// a different set of declarations. This routine returns the 1104 /// "primary" DeclContext structure, which will contain the 1105 /// information needed to perform name lookup into this context. 1106 DeclContext *getPrimaryContext(); 1107 const DeclContext *getPrimaryContext() const { 1108 return const_cast<DeclContext*>(this)->getPrimaryContext(); 1109 } 1110 1111 /// getRedeclContext - Retrieve the context in which an entity conflicts with 1112 /// other entities of the same name, or where it is a redeclaration if the 1113 /// two entities are compatible. This skips through transparent contexts. 1114 DeclContext *getRedeclContext(); 1115 const DeclContext *getRedeclContext() const { 1116 return const_cast<DeclContext *>(this)->getRedeclContext(); 1117 } 1118 1119 /// \brief Retrieve the nearest enclosing namespace context. 1120 DeclContext *getEnclosingNamespaceContext(); 1121 const DeclContext *getEnclosingNamespaceContext() const { 1122 return const_cast<DeclContext *>(this)->getEnclosingNamespaceContext(); 1123 } 1124 1125 /// \brief Test if this context is part of the enclosing namespace set of 1126 /// the context NS, as defined in C++0x [namespace.def]p9. If either context 1127 /// isn't a namespace, this is equivalent to Equals(). 1128 /// 1129 /// The enclosing namespace set of a namespace is the namespace and, if it is 1130 /// inline, its enclosing namespace, recursively. 1131 bool InEnclosingNamespaceSetOf(const DeclContext *NS) const; 1132 1133 /// \\brief Collects all of the declaration contexts that are semantically 1134 /// connected to this declaration context. 1135 /// 1136 /// For declaration contexts that have multiple semantically connected but 1137 /// syntactically distinct contexts, such as C++ namespaces, this routine 1138 /// retrieves the complete set of such declaration contexts in source order. 1139 /// For example, given: 1140 /// 1141 /// \code 1142 /// namespace N { 1143 /// int x; 1144 /// } 1145 /// namespace N { 1146 /// int y; 1147 /// } 1148 /// \endcode 1149 /// 1150 /// The \c Contexts parameter will contain both definitions of N. 1151 /// 1152 /// \param Contexts Will be cleared and set to the set of declaration 1153 /// contexts that are semanticaly connected to this declaration context, 1154 /// in source order, including this context (which may be the only result, 1155 /// for non-namespace contexts). 1156 void collectAllContexts(llvm::SmallVectorImpl<DeclContext *> &Contexts); 1157 1158 /// decl_iterator - Iterates through the declarations stored 1159 /// within this context. 1160 class decl_iterator { 1161 /// Current - The current declaration. 1162 Decl *Current; 1163 1164 public: 1165 typedef Decl* value_type; 1166 typedef Decl* reference; 1167 typedef Decl* pointer; 1168 typedef std::forward_iterator_tag iterator_category; 1169 typedef std::ptrdiff_t difference_type; 1170 1171 decl_iterator() : Current(0) { } 1172 explicit decl_iterator(Decl *C) : Current(C) { } 1173 1174 reference operator*() const { return Current; } 1175 pointer operator->() const { return Current; } 1176 1177 decl_iterator& operator++() { 1178 Current = Current->getNextDeclInContext(); 1179 return *this; 1180 } 1181 1182 decl_iterator operator++(int) { 1183 decl_iterator tmp(*this); 1184 ++(*this); 1185 return tmp; 1186 } 1187 1188 friend bool operator==(decl_iterator x, decl_iterator y) { 1189 return x.Current == y.Current; 1190 } 1191 friend bool operator!=(decl_iterator x, decl_iterator y) { 1192 return x.Current != y.Current; 1193 } 1194 }; 1195 1196 /// decls_begin/decls_end - Iterate over the declarations stored in 1197 /// this context. 1198 decl_iterator decls_begin() const; 1199 decl_iterator decls_end() const; 1200 bool decls_empty() const; 1201 1202 /// noload_decls_begin/end - Iterate over the declarations stored in this 1203 /// context that are currently loaded; don't attempt to retrieve anything 1204 /// from an external source. 1205 decl_iterator noload_decls_begin() const; 1206 decl_iterator noload_decls_end() const; 1207 1208 /// specific_decl_iterator - Iterates over a subrange of 1209 /// declarations stored in a DeclContext, providing only those that 1210 /// are of type SpecificDecl (or a class derived from it). This 1211 /// iterator is used, for example, to provide iteration over just 1212 /// the fields within a RecordDecl (with SpecificDecl = FieldDecl). 1213 template<typename SpecificDecl> 1214 class specific_decl_iterator { 1215 /// Current - The current, underlying declaration iterator, which 1216 /// will either be NULL or will point to a declaration of 1217 /// type SpecificDecl. 1218 DeclContext::decl_iterator Current; 1219 1220 /// SkipToNextDecl - Advances the current position up to the next 1221 /// declaration of type SpecificDecl that also meets the criteria 1222 /// required by Acceptable. 1223 void SkipToNextDecl() { 1224 while (*Current && !isa<SpecificDecl>(*Current)) 1225 ++Current; 1226 } 1227 1228 public: 1229 typedef SpecificDecl* value_type; 1230 typedef SpecificDecl* reference; 1231 typedef SpecificDecl* pointer; 1232 typedef std::iterator_traits<DeclContext::decl_iterator>::difference_type 1233 difference_type; 1234 typedef std::forward_iterator_tag iterator_category; 1235 1236 specific_decl_iterator() : Current() { } 1237 1238 /// specific_decl_iterator - Construct a new iterator over a 1239 /// subset of the declarations the range [C, 1240 /// end-of-declarations). If A is non-NULL, it is a pointer to a 1241 /// member function of SpecificDecl that should return true for 1242 /// all of the SpecificDecl instances that will be in the subset 1243 /// of iterators. For example, if you want Objective-C instance 1244 /// methods, SpecificDecl will be ObjCMethodDecl and A will be 1245 /// &ObjCMethodDecl::isInstanceMethod. 1246 explicit specific_decl_iterator(DeclContext::decl_iterator C) : Current(C) { 1247 SkipToNextDecl(); 1248 } 1249 1250 reference operator*() const { return cast<SpecificDecl>(*Current); } 1251 pointer operator->() const { return cast<SpecificDecl>(*Current); } 1252 1253 specific_decl_iterator& operator++() { 1254 ++Current; 1255 SkipToNextDecl(); 1256 return *this; 1257 } 1258 1259 specific_decl_iterator operator++(int) { 1260 specific_decl_iterator tmp(*this); 1261 ++(*this); 1262 return tmp; 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 friend bool operator!=(const specific_decl_iterator& x, 1271 const specific_decl_iterator& y) { 1272 return x.Current != y.Current; 1273 } 1274 }; 1275 1276 /// \brief Iterates over a filtered subrange of declarations stored 1277 /// in a DeclContext. 1278 /// 1279 /// This iterator visits only those declarations that are of type 1280 /// SpecificDecl (or a class derived from it) and that meet some 1281 /// additional run-time criteria. This iterator is used, for 1282 /// example, to provide access to the instance methods within an 1283 /// Objective-C interface (with SpecificDecl = ObjCMethodDecl and 1284 /// Acceptable = ObjCMethodDecl::isInstanceMethod). 1285 template<typename SpecificDecl, bool (SpecificDecl::*Acceptable)() const> 1286 class filtered_decl_iterator { 1287 /// Current - The current, underlying declaration iterator, which 1288 /// will either be NULL or will point to a declaration of 1289 /// type SpecificDecl. 1290 DeclContext::decl_iterator Current; 1291 1292 /// SkipToNextDecl - Advances the current position up to the next 1293 /// declaration of type SpecificDecl that also meets the criteria 1294 /// required by Acceptable. 1295 void SkipToNextDecl() { 1296 while (*Current && 1297 (!isa<SpecificDecl>(*Current) || 1298 (Acceptable && !(cast<SpecificDecl>(*Current)->*Acceptable)()))) 1299 ++Current; 1300 } 1301 1302 public: 1303 typedef SpecificDecl* value_type; 1304 typedef SpecificDecl* reference; 1305 typedef SpecificDecl* pointer; 1306 typedef std::iterator_traits<DeclContext::decl_iterator>::difference_type 1307 difference_type; 1308 typedef std::forward_iterator_tag iterator_category; 1309 1310 filtered_decl_iterator() : Current() { } 1311 1312 /// specific_decl_iterator - Construct a new iterator over a 1313 /// subset of the declarations the range [C, 1314 /// end-of-declarations). If A is non-NULL, it is a pointer to a 1315 /// member function of SpecificDecl that should return true for 1316 /// all of the SpecificDecl instances that will be in the subset 1317 /// of iterators. For example, if you want Objective-C instance 1318 /// methods, SpecificDecl will be ObjCMethodDecl and A will be 1319 /// &ObjCMethodDecl::isInstanceMethod. 1320 explicit filtered_decl_iterator(DeclContext::decl_iterator C) : Current(C) { 1321 SkipToNextDecl(); 1322 } 1323 1324 reference operator*() const { return cast<SpecificDecl>(*Current); } 1325 pointer operator->() const { return cast<SpecificDecl>(*Current); } 1326 1327 filtered_decl_iterator& operator++() { 1328 ++Current; 1329 SkipToNextDecl(); 1330 return *this; 1331 } 1332 1333 filtered_decl_iterator operator++(int) { 1334 filtered_decl_iterator tmp(*this); 1335 ++(*this); 1336 return tmp; 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 friend bool operator!=(const filtered_decl_iterator& x, 1345 const filtered_decl_iterator& y) { 1346 return x.Current != y.Current; 1347 } 1348 }; 1349 1350 /// @brief Add the declaration D into this context. 1351 /// 1352 /// This routine should be invoked when the declaration D has first 1353 /// been declared, to place D into the context where it was 1354 /// (lexically) defined. Every declaration must be added to one 1355 /// (and only one!) context, where it can be visited via 1356 /// [decls_begin(), decls_end()). Once a declaration has been added 1357 /// to its lexical context, the corresponding DeclContext owns the 1358 /// declaration. 1359 /// 1360 /// If D is also a NamedDecl, it will be made visible within its 1361 /// semantic context via makeDeclVisibleInContext. 1362 void addDecl(Decl *D); 1363 1364 /// @brief Add the declaration D into this context, but suppress 1365 /// searches for external declarations with the same name. 1366 /// 1367 /// Although analogous in function to addDecl, this removes an 1368 /// important check. This is only useful if the Decl is being 1369 /// added in response to an external search; in all other cases, 1370 /// addDecl() is the right function to use. 1371 /// See the ASTImporter for use cases. 1372 void addDeclInternal(Decl *D); 1373 1374 /// @brief Add the declaration D to this context without modifying 1375 /// any lookup tables. 1376 /// 1377 /// This is useful for some operations in dependent contexts where 1378 /// the semantic context might not be dependent; this basically 1379 /// only happens with friends. 1380 void addHiddenDecl(Decl *D); 1381 1382 /// @brief Removes a declaration from this context. 1383 void removeDecl(Decl *D); 1384 1385 /// lookup_iterator - An iterator that provides access to the results 1386 /// of looking up a name within this context. 1387 typedef NamedDecl **lookup_iterator; 1388 1389 /// lookup_const_iterator - An iterator that provides non-mutable 1390 /// access to the results of lookup up a name within this context. 1391 typedef NamedDecl * const * lookup_const_iterator; 1392 1393 typedef DeclContextLookupResult lookup_result; 1394 typedef DeclContextLookupConstResult lookup_const_result; 1395 1396 /// lookup - Find the declarations (if any) with the given Name in 1397 /// this context. Returns a range of iterators that contains all of 1398 /// the declarations with this name, with object, function, member, 1399 /// and enumerator names preceding any tag name. Note that this 1400 /// routine will not look into parent contexts. 1401 lookup_result lookup(DeclarationName Name); 1402 lookup_const_result lookup(DeclarationName Name) const; 1403 1404 /// \brief A simplistic name lookup mechanism that performs name lookup 1405 /// into this declaration context without consulting the external source. 1406 /// 1407 /// This function should almost never be used, because it subverts the 1408 /// usual relationship between a DeclContext and the external source. 1409 /// See the ASTImporter for the (few, but important) use cases. 1410 void localUncachedLookup(DeclarationName Name, 1411 llvm::SmallVectorImpl<NamedDecl *> &Results); 1412 1413 /// @brief Makes a declaration visible within this context. 1414 /// 1415 /// This routine makes the declaration D visible to name lookup 1416 /// within this context and, if this is a transparent context, 1417 /// within its parent contexts up to the first enclosing 1418 /// non-transparent context. Making a declaration visible within a 1419 /// context does not transfer ownership of a declaration, and a 1420 /// declaration can be visible in many contexts that aren't its 1421 /// lexical context. 1422 /// 1423 /// If D is a redeclaration of an existing declaration that is 1424 /// visible from this context, as determined by 1425 /// NamedDecl::declarationReplaces, the previous declaration will be 1426 /// replaced with D. 1427 /// 1428 /// @param Recoverable true if it's okay to not add this decl to 1429 /// the lookup tables because it can be easily recovered by walking 1430 /// the declaration chains. 1431 void makeDeclVisibleInContext(NamedDecl *D, bool Recoverable = true); 1432 1433 /// udir_iterator - Iterates through the using-directives stored 1434 /// within this context. 1435 typedef UsingDirectiveDecl * const * udir_iterator; 1436 1437 typedef std::pair<udir_iterator, udir_iterator> udir_iterator_range; 1438 1439 udir_iterator_range getUsingDirectives() const; 1440 1441 udir_iterator using_directives_begin() const { 1442 return getUsingDirectives().first; 1443 } 1444 1445 udir_iterator using_directives_end() const { 1446 return getUsingDirectives().second; 1447 } 1448 1449 // These are all defined in DependentDiagnostic.h. 1450 class ddiag_iterator; 1451 inline ddiag_iterator ddiag_begin() const; 1452 inline ddiag_iterator ddiag_end() const; 1453 1454 // Low-level accessors 1455 1456 /// \brief Retrieve the internal representation of the lookup structure. 1457 StoredDeclsMap* getLookupPtr() const { return LookupPtr; } 1458 1459 /// \brief Whether this DeclContext has external storage containing 1460 /// additional declarations that are lexically in this context. 1461 bool hasExternalLexicalStorage() const { return ExternalLexicalStorage; } 1462 1463 /// \brief State whether this DeclContext has external storage for 1464 /// declarations lexically in this context. 1465 void setHasExternalLexicalStorage(bool ES = true) { 1466 ExternalLexicalStorage = ES; 1467 } 1468 1469 /// \brief Whether this DeclContext has external storage containing 1470 /// additional declarations that are visible in this context. 1471 bool hasExternalVisibleStorage() const { return ExternalVisibleStorage; } 1472 1473 /// \brief State whether this DeclContext has external storage for 1474 /// declarations visible in this context. 1475 void setHasExternalVisibleStorage(bool ES = true) { 1476 ExternalVisibleStorage = ES; 1477 } 1478 1479 /// \brief Determine whether the given declaration is stored in the list of 1480 /// declarations lexically within this context. 1481 bool isDeclInLexicalTraversal(const Decl *D) const { 1482 return D && (D->NextInContextAndBits.getPointer() || D == FirstDecl || 1483 D == LastDecl); 1484 } 1485 1486 static bool classof(const Decl *D); 1487 static bool classof(const DeclContext *D) { return true; } 1488#define DECL(NAME, BASE) 1489#define DECL_CONTEXT(NAME) \ 1490 static bool classof(const NAME##Decl *D) { return true; } 1491#include "clang/AST/DeclNodes.inc" 1492 1493 LLVM_ATTRIBUTE_USED void dumpDeclContext() const; 1494 1495private: 1496 void LoadLexicalDeclsFromExternalStorage() const; 1497 1498 /// @brief Makes a declaration visible within this context, but 1499 /// suppresses searches for external declarations with the same 1500 /// name. 1501 /// 1502 /// Analogous to makeDeclVisibleInContext, but for the exclusive 1503 /// use of addDeclInternal(). 1504 void makeDeclVisibleInContextInternal(NamedDecl *D, 1505 bool Recoverable = true); 1506 1507 friend class DependentDiagnostic; 1508 StoredDeclsMap *CreateStoredDeclsMap(ASTContext &C) const; 1509 1510 void buildLookup(DeclContext *DCtx); 1511 void makeDeclVisibleInContextWithFlags(NamedDecl *D, bool Internal, 1512 bool Recoverable); 1513 void makeDeclVisibleInContextImpl(NamedDecl *D, bool Internal); 1514}; 1515 1516inline bool Decl::isTemplateParameter() const { 1517 return getKind() == TemplateTypeParm || getKind() == NonTypeTemplateParm || 1518 getKind() == TemplateTemplateParm; 1519} 1520 1521// Specialization selected when ToTy is not a known subclass of DeclContext. 1522template <class ToTy, 1523 bool IsKnownSubtype = ::llvm::is_base_of< DeclContext, ToTy>::value> 1524struct cast_convert_decl_context { 1525 static const ToTy *doit(const DeclContext *Val) { 1526 return static_cast<const ToTy*>(Decl::castFromDeclContext(Val)); 1527 } 1528 1529 static ToTy *doit(DeclContext *Val) { 1530 return static_cast<ToTy*>(Decl::castFromDeclContext(Val)); 1531 } 1532}; 1533 1534// Specialization selected when ToTy is a known subclass of DeclContext. 1535template <class ToTy> 1536struct cast_convert_decl_context<ToTy, true> { 1537 static const ToTy *doit(const DeclContext *Val) { 1538 return static_cast<const ToTy*>(Val); 1539 } 1540 1541 static ToTy *doit(DeclContext *Val) { 1542 return static_cast<ToTy*>(Val); 1543 } 1544}; 1545 1546 1547} // end clang. 1548 1549namespace llvm { 1550 1551/// isa<T>(DeclContext*) 1552template <typename To> 1553struct isa_impl<To, ::clang::DeclContext> { 1554 static bool doit(const ::clang::DeclContext &Val) { 1555 return To::classofKind(Val.getDeclKind()); 1556 } 1557}; 1558 1559/// cast<T>(DeclContext*) 1560template<class ToTy> 1561struct cast_convert_val<ToTy, 1562 const ::clang::DeclContext,const ::clang::DeclContext> { 1563 static const ToTy &doit(const ::clang::DeclContext &Val) { 1564 return *::clang::cast_convert_decl_context<ToTy>::doit(&Val); 1565 } 1566}; 1567template<class ToTy> 1568struct cast_convert_val<ToTy, ::clang::DeclContext, ::clang::DeclContext> { 1569 static ToTy &doit(::clang::DeclContext &Val) { 1570 return *::clang::cast_convert_decl_context<ToTy>::doit(&Val); 1571 } 1572}; 1573template<class ToTy> 1574struct cast_convert_val<ToTy, 1575 const ::clang::DeclContext*, const ::clang::DeclContext*> { 1576 static const ToTy *doit(const ::clang::DeclContext *Val) { 1577 return ::clang::cast_convert_decl_context<ToTy>::doit(Val); 1578 } 1579}; 1580template<class ToTy> 1581struct cast_convert_val<ToTy, ::clang::DeclContext*, ::clang::DeclContext*> { 1582 static ToTy *doit(::clang::DeclContext *Val) { 1583 return ::clang::cast_convert_decl_context<ToTy>::doit(Val); 1584 } 1585}; 1586 1587/// Implement cast_convert_val for Decl -> DeclContext conversions. 1588template<class FromTy> 1589struct cast_convert_val< ::clang::DeclContext, FromTy, FromTy> { 1590 static ::clang::DeclContext &doit(const FromTy &Val) { 1591 return *FromTy::castToDeclContext(&Val); 1592 } 1593}; 1594 1595template<class FromTy> 1596struct cast_convert_val< ::clang::DeclContext, FromTy*, FromTy*> { 1597 static ::clang::DeclContext *doit(const FromTy *Val) { 1598 return FromTy::castToDeclContext(Val); 1599 } 1600}; 1601 1602template<class FromTy> 1603struct cast_convert_val< const ::clang::DeclContext, FromTy, FromTy> { 1604 static const ::clang::DeclContext &doit(const FromTy &Val) { 1605 return *FromTy::castToDeclContext(&Val); 1606 } 1607}; 1608 1609template<class FromTy> 1610struct cast_convert_val< const ::clang::DeclContext, FromTy*, FromTy*> { 1611 static const ::clang::DeclContext *doit(const FromTy *Val) { 1612 return FromTy::castToDeclContext(Val); 1613 } 1614}; 1615 1616} // end namespace llvm 1617 1618#endif 1619