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