1 //===- DeclCXX.h - Classes for representing C++ declarations --*- C++ -*-=====// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 // 9 /// \file 10 /// Defines the C++ Decl subclasses, other than those for templates 11 /// (found in DeclTemplate.h) and friends (in DeclFriend.h). 12 // 13 //===----------------------------------------------------------------------===// 14 15 #ifndef LLVM_CLANG_AST_DECLCXX_H 16 #define LLVM_CLANG_AST_DECLCXX_H 17 18 #include "clang/AST/ASTUnresolvedSet.h" 19 #include "clang/AST/Decl.h" 20 #include "clang/AST/DeclBase.h" 21 #include "clang/AST/DeclarationName.h" 22 #include "clang/AST/Expr.h" 23 #include "clang/AST/ExternalASTSource.h" 24 #include "clang/AST/LambdaCapture.h" 25 #include "clang/AST/NestedNameSpecifier.h" 26 #include "clang/AST/Redeclarable.h" 27 #include "clang/AST/Stmt.h" 28 #include "clang/AST/Type.h" 29 #include "clang/AST/TypeLoc.h" 30 #include "clang/AST/UnresolvedSet.h" 31 #include "clang/Basic/LLVM.h" 32 #include "clang/Basic/Lambda.h" 33 #include "clang/Basic/LangOptions.h" 34 #include "clang/Basic/OperatorKinds.h" 35 #include "clang/Basic/SourceLocation.h" 36 #include "clang/Basic/Specifiers.h" 37 #include "llvm/ADT/ArrayRef.h" 38 #include "llvm/ADT/DenseMap.h" 39 #include "llvm/ADT/PointerIntPair.h" 40 #include "llvm/ADT/PointerUnion.h" 41 #include "llvm/ADT/STLExtras.h" 42 #include "llvm/ADT/TinyPtrVector.h" 43 #include "llvm/ADT/iterator_range.h" 44 #include "llvm/Support/Casting.h" 45 #include "llvm/Support/Compiler.h" 46 #include "llvm/Support/PointerLikeTypeTraits.h" 47 #include "llvm/Support/TrailingObjects.h" 48 #include <cassert> 49 #include <cstddef> 50 #include <iterator> 51 #include <memory> 52 #include <vector> 53 54 namespace clang { 55 56 class ASTContext; 57 class ClassTemplateDecl; 58 class ConstructorUsingShadowDecl; 59 class CXXBasePath; 60 class CXXBasePaths; 61 class CXXConstructorDecl; 62 class CXXDestructorDecl; 63 class CXXFinalOverriderMap; 64 class CXXIndirectPrimaryBaseSet; 65 class CXXMethodDecl; 66 class DecompositionDecl; 67 class DiagnosticBuilder; 68 class FriendDecl; 69 class FunctionTemplateDecl; 70 class IdentifierInfo; 71 class MemberSpecializationInfo; 72 class TemplateDecl; 73 class TemplateParameterList; 74 class UsingDecl; 75 76 /// Represents an access specifier followed by colon ':'. 77 /// 78 /// An objects of this class represents sugar for the syntactic occurrence 79 /// of an access specifier followed by a colon in the list of member 80 /// specifiers of a C++ class definition. 81 /// 82 /// Note that they do not represent other uses of access specifiers, 83 /// such as those occurring in a list of base specifiers. 84 /// Also note that this class has nothing to do with so-called 85 /// "access declarations" (C++98 11.3 [class.access.dcl]). 86 class AccessSpecDecl : public Decl { 87 /// The location of the ':'. 88 SourceLocation ColonLoc; 89 90 AccessSpecDecl(AccessSpecifier AS, DeclContext *DC, 91 SourceLocation ASLoc, SourceLocation ColonLoc) 92 : Decl(AccessSpec, DC, ASLoc), ColonLoc(ColonLoc) { 93 setAccess(AS); 94 } 95 96 AccessSpecDecl(EmptyShell Empty) : Decl(AccessSpec, Empty) {} 97 98 virtual void anchor(); 99 100 public: 101 /// The location of the access specifier. 102 SourceLocation getAccessSpecifierLoc() const { return getLocation(); } 103 104 /// Sets the location of the access specifier. 105 void setAccessSpecifierLoc(SourceLocation ASLoc) { setLocation(ASLoc); } 106 107 /// The location of the colon following the access specifier. 108 SourceLocation getColonLoc() const { return ColonLoc; } 109 110 /// Sets the location of the colon. 111 void setColonLoc(SourceLocation CLoc) { ColonLoc = CLoc; } 112 113 SourceRange getSourceRange() const override LLVM_READONLY { 114 return SourceRange(getAccessSpecifierLoc(), getColonLoc()); 115 } 116 117 static AccessSpecDecl *Create(ASTContext &C, AccessSpecifier AS, 118 DeclContext *DC, SourceLocation ASLoc, 119 SourceLocation ColonLoc) { 120 return new (C, DC) AccessSpecDecl(AS, DC, ASLoc, ColonLoc); 121 } 122 123 static AccessSpecDecl *CreateDeserialized(ASTContext &C, unsigned ID); 124 125 // Implement isa/cast/dyncast/etc. 126 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 127 static bool classofKind(Kind K) { return K == AccessSpec; } 128 }; 129 130 /// Represents a base class of a C++ class. 131 /// 132 /// Each CXXBaseSpecifier represents a single, direct base class (or 133 /// struct) of a C++ class (or struct). It specifies the type of that 134 /// base class, whether it is a virtual or non-virtual base, and what 135 /// level of access (public, protected, private) is used for the 136 /// derivation. For example: 137 /// 138 /// \code 139 /// class A { }; 140 /// class B { }; 141 /// class C : public virtual A, protected B { }; 142 /// \endcode 143 /// 144 /// In this code, C will have two CXXBaseSpecifiers, one for "public 145 /// virtual A" and the other for "protected B". 146 class CXXBaseSpecifier { 147 /// The source code range that covers the full base 148 /// specifier, including the "virtual" (if present) and access 149 /// specifier (if present). 150 SourceRange Range; 151 152 /// The source location of the ellipsis, if this is a pack 153 /// expansion. 154 SourceLocation EllipsisLoc; 155 156 /// Whether this is a virtual base class or not. 157 unsigned Virtual : 1; 158 159 /// Whether this is the base of a class (true) or of a struct (false). 160 /// 161 /// This determines the mapping from the access specifier as written in the 162 /// source code to the access specifier used for semantic analysis. 163 unsigned BaseOfClass : 1; 164 165 /// Access specifier as written in the source code (may be AS_none). 166 /// 167 /// The actual type of data stored here is an AccessSpecifier, but we use 168 /// "unsigned" here to work around a VC++ bug. 169 unsigned Access : 2; 170 171 /// Whether the class contains a using declaration 172 /// to inherit the named class's constructors. 173 unsigned InheritConstructors : 1; 174 175 /// The type of the base class. 176 /// 177 /// This will be a class or struct (or a typedef of such). The source code 178 /// range does not include the \c virtual or the access specifier. 179 TypeSourceInfo *BaseTypeInfo; 180 181 public: 182 CXXBaseSpecifier() = default; 183 CXXBaseSpecifier(SourceRange R, bool V, bool BC, AccessSpecifier A, 184 TypeSourceInfo *TInfo, SourceLocation EllipsisLoc) 185 : Range(R), EllipsisLoc(EllipsisLoc), Virtual(V), BaseOfClass(BC), 186 Access(A), InheritConstructors(false), BaseTypeInfo(TInfo) {} 187 188 /// Retrieves the source range that contains the entire base specifier. 189 SourceRange getSourceRange() const LLVM_READONLY { return Range; } 190 SourceLocation getBeginLoc() const LLVM_READONLY { return Range.getBegin(); } 191 SourceLocation getEndLoc() const LLVM_READONLY { return Range.getEnd(); } 192 193 /// Get the location at which the base class type was written. 194 SourceLocation getBaseTypeLoc() const LLVM_READONLY { 195 return BaseTypeInfo->getTypeLoc().getBeginLoc(); 196 } 197 198 /// Determines whether the base class is a virtual base class (or not). 199 bool isVirtual() const { return Virtual; } 200 201 /// Determine whether this base class is a base of a class declared 202 /// with the 'class' keyword (vs. one declared with the 'struct' keyword). 203 bool isBaseOfClass() const { return BaseOfClass; } 204 205 /// Determine whether this base specifier is a pack expansion. 206 bool isPackExpansion() const { return EllipsisLoc.isValid(); } 207 208 /// Determine whether this base class's constructors get inherited. 209 bool getInheritConstructors() const { return InheritConstructors; } 210 211 /// Set that this base class's constructors should be inherited. 212 void setInheritConstructors(bool Inherit = true) { 213 InheritConstructors = Inherit; 214 } 215 216 /// For a pack expansion, determine the location of the ellipsis. 217 SourceLocation getEllipsisLoc() const { 218 return EllipsisLoc; 219 } 220 221 /// Returns the access specifier for this base specifier. 222 /// 223 /// This is the actual base specifier as used for semantic analysis, so 224 /// the result can never be AS_none. To retrieve the access specifier as 225 /// written in the source code, use getAccessSpecifierAsWritten(). 226 AccessSpecifier getAccessSpecifier() const { 227 if ((AccessSpecifier)Access == AS_none) 228 return BaseOfClass? AS_private : AS_public; 229 else 230 return (AccessSpecifier)Access; 231 } 232 233 /// Retrieves the access specifier as written in the source code 234 /// (which may mean that no access specifier was explicitly written). 235 /// 236 /// Use getAccessSpecifier() to retrieve the access specifier for use in 237 /// semantic analysis. 238 AccessSpecifier getAccessSpecifierAsWritten() const { 239 return (AccessSpecifier)Access; 240 } 241 242 /// Retrieves the type of the base class. 243 /// 244 /// This type will always be an unqualified class type. 245 QualType getType() const { 246 return BaseTypeInfo->getType().getUnqualifiedType(); 247 } 248 249 /// Retrieves the type and source location of the base class. 250 TypeSourceInfo *getTypeSourceInfo() const { return BaseTypeInfo; } 251 }; 252 253 /// Represents a C++ struct/union/class. 254 class CXXRecordDecl : public RecordDecl { 255 friend class ASTDeclReader; 256 friend class ASTDeclWriter; 257 friend class ASTNodeImporter; 258 friend class ASTReader; 259 friend class ASTRecordWriter; 260 friend class ASTWriter; 261 friend class DeclContext; 262 friend class LambdaExpr; 263 264 friend void FunctionDecl::setPure(bool); 265 friend void TagDecl::startDefinition(); 266 267 /// Values used in DefinitionData fields to represent special members. 268 enum SpecialMemberFlags { 269 SMF_DefaultConstructor = 0x1, 270 SMF_CopyConstructor = 0x2, 271 SMF_MoveConstructor = 0x4, 272 SMF_CopyAssignment = 0x8, 273 SMF_MoveAssignment = 0x10, 274 SMF_Destructor = 0x20, 275 SMF_All = 0x3f 276 }; 277 278 struct DefinitionData { 279 #define FIELD(Name, Width, Merge) \ 280 unsigned Name : Width; 281 #include "CXXRecordDeclDefinitionBits.def" 282 283 /// Whether this class describes a C++ lambda. 284 unsigned IsLambda : 1; 285 286 /// Whether we are currently parsing base specifiers. 287 unsigned IsParsingBaseSpecifiers : 1; 288 289 /// True when visible conversion functions are already computed 290 /// and are available. 291 unsigned ComputedVisibleConversions : 1; 292 293 unsigned HasODRHash : 1; 294 295 /// A hash of parts of the class to help in ODR checking. 296 unsigned ODRHash = 0; 297 298 /// The number of base class specifiers in Bases. 299 unsigned NumBases = 0; 300 301 /// The number of virtual base class specifiers in VBases. 302 unsigned NumVBases = 0; 303 304 /// Base classes of this class. 305 /// 306 /// FIXME: This is wasted space for a union. 307 LazyCXXBaseSpecifiersPtr Bases; 308 309 /// direct and indirect virtual base classes of this class. 310 LazyCXXBaseSpecifiersPtr VBases; 311 312 /// The conversion functions of this C++ class (but not its 313 /// inherited conversion functions). 314 /// 315 /// Each of the entries in this overload set is a CXXConversionDecl. 316 LazyASTUnresolvedSet Conversions; 317 318 /// The conversion functions of this C++ class and all those 319 /// inherited conversion functions that are visible in this class. 320 /// 321 /// Each of the entries in this overload set is a CXXConversionDecl or a 322 /// FunctionTemplateDecl. 323 LazyASTUnresolvedSet VisibleConversions; 324 325 /// The declaration which defines this record. 326 CXXRecordDecl *Definition; 327 328 /// The first friend declaration in this class, or null if there 329 /// aren't any. 330 /// 331 /// This is actually currently stored in reverse order. 332 LazyDeclPtr FirstFriend; 333 334 DefinitionData(CXXRecordDecl *D); 335 336 /// Retrieve the set of direct base classes. 337 CXXBaseSpecifier *getBases() const { 338 if (!Bases.isOffset()) 339 return Bases.get(nullptr); 340 return getBasesSlowCase(); 341 } 342 343 /// Retrieve the set of virtual base classes. 344 CXXBaseSpecifier *getVBases() const { 345 if (!VBases.isOffset()) 346 return VBases.get(nullptr); 347 return getVBasesSlowCase(); 348 } 349 350 ArrayRef<CXXBaseSpecifier> bases() const { 351 return llvm::makeArrayRef(getBases(), NumBases); 352 } 353 354 ArrayRef<CXXBaseSpecifier> vbases() const { 355 return llvm::makeArrayRef(getVBases(), NumVBases); 356 } 357 358 private: 359 CXXBaseSpecifier *getBasesSlowCase() const; 360 CXXBaseSpecifier *getVBasesSlowCase() const; 361 }; 362 363 struct DefinitionData *DefinitionData; 364 365 /// Describes a C++ closure type (generated by a lambda expression). 366 struct LambdaDefinitionData : public DefinitionData { 367 using Capture = LambdaCapture; 368 369 /// Whether this lambda is known to be dependent, even if its 370 /// context isn't dependent. 371 /// 372 /// A lambda with a non-dependent context can be dependent if it occurs 373 /// within the default argument of a function template, because the 374 /// lambda will have been created with the enclosing context as its 375 /// declaration context, rather than function. This is an unfortunate 376 /// artifact of having to parse the default arguments before. 377 unsigned Dependent : 1; 378 379 /// Whether this lambda is a generic lambda. 380 unsigned IsGenericLambda : 1; 381 382 /// The Default Capture. 383 unsigned CaptureDefault : 2; 384 385 /// The number of captures in this lambda is limited 2^NumCaptures. 386 unsigned NumCaptures : 15; 387 388 /// The number of explicit captures in this lambda. 389 unsigned NumExplicitCaptures : 13; 390 391 /// Has known `internal` linkage. 392 unsigned HasKnownInternalLinkage : 1; 393 394 /// The number used to indicate this lambda expression for name 395 /// mangling in the Itanium C++ ABI. 396 unsigned ManglingNumber : 31; 397 398 /// The declaration that provides context for this lambda, if the 399 /// actual DeclContext does not suffice. This is used for lambdas that 400 /// occur within default arguments of function parameters within the class 401 /// or within a data member initializer. 402 LazyDeclPtr ContextDecl; 403 404 /// The list of captures, both explicit and implicit, for this 405 /// lambda. 406 Capture *Captures = nullptr; 407 408 /// The type of the call method. 409 TypeSourceInfo *MethodTyInfo; 410 411 LambdaDefinitionData(CXXRecordDecl *D, TypeSourceInfo *Info, bool Dependent, 412 bool IsGeneric, LambdaCaptureDefault CaptureDefault) 413 : DefinitionData(D), Dependent(Dependent), IsGenericLambda(IsGeneric), 414 CaptureDefault(CaptureDefault), NumCaptures(0), 415 NumExplicitCaptures(0), HasKnownInternalLinkage(0), ManglingNumber(0), 416 MethodTyInfo(Info) { 417 IsLambda = true; 418 419 // C++1z [expr.prim.lambda]p4: 420 // This class type is not an aggregate type. 421 Aggregate = false; 422 PlainOldData = false; 423 } 424 }; 425 426 struct DefinitionData *dataPtr() const { 427 // Complete the redecl chain (if necessary). 428 getMostRecentDecl(); 429 return DefinitionData; 430 } 431 432 struct DefinitionData &data() const { 433 auto *DD = dataPtr(); 434 assert(DD && "queried property of class with no definition"); 435 return *DD; 436 } 437 438 struct LambdaDefinitionData &getLambdaData() const { 439 // No update required: a merged definition cannot change any lambda 440 // properties. 441 auto *DD = DefinitionData; 442 assert(DD && DD->IsLambda && "queried lambda property of non-lambda class"); 443 return static_cast<LambdaDefinitionData&>(*DD); 444 } 445 446 /// The template or declaration that this declaration 447 /// describes or was instantiated from, respectively. 448 /// 449 /// For non-templates, this value will be null. For record 450 /// declarations that describe a class template, this will be a 451 /// pointer to a ClassTemplateDecl. For member 452 /// classes of class template specializations, this will be the 453 /// MemberSpecializationInfo referring to the member class that was 454 /// instantiated or specialized. 455 llvm::PointerUnion<ClassTemplateDecl *, MemberSpecializationInfo *> 456 TemplateOrInstantiation; 457 458 /// Called from setBases and addedMember to notify the class that a 459 /// direct or virtual base class or a member of class type has been added. 460 void addedClassSubobject(CXXRecordDecl *Base); 461 462 /// Notify the class that member has been added. 463 /// 464 /// This routine helps maintain information about the class based on which 465 /// members have been added. It will be invoked by DeclContext::addDecl() 466 /// whenever a member is added to this record. 467 void addedMember(Decl *D); 468 469 void markedVirtualFunctionPure(); 470 471 /// Get the head of our list of friend declarations, possibly 472 /// deserializing the friends from an external AST source. 473 FriendDecl *getFirstFriend() const; 474 475 /// Determine whether this class has an empty base class subobject of type X 476 /// or of one of the types that might be at offset 0 within X (per the C++ 477 /// "standard layout" rules). 478 bool hasSubobjectAtOffsetZeroOfEmptyBaseType(ASTContext &Ctx, 479 const CXXRecordDecl *X); 480 481 protected: 482 CXXRecordDecl(Kind K, TagKind TK, const ASTContext &C, DeclContext *DC, 483 SourceLocation StartLoc, SourceLocation IdLoc, 484 IdentifierInfo *Id, CXXRecordDecl *PrevDecl); 485 486 public: 487 /// Iterator that traverses the base classes of a class. 488 using base_class_iterator = CXXBaseSpecifier *; 489 490 /// Iterator that traverses the base classes of a class. 491 using base_class_const_iterator = const CXXBaseSpecifier *; 492 493 CXXRecordDecl *getCanonicalDecl() override { 494 return cast<CXXRecordDecl>(RecordDecl::getCanonicalDecl()); 495 } 496 497 const CXXRecordDecl *getCanonicalDecl() const { 498 return const_cast<CXXRecordDecl*>(this)->getCanonicalDecl(); 499 } 500 501 CXXRecordDecl *getPreviousDecl() { 502 return cast_or_null<CXXRecordDecl>( 503 static_cast<RecordDecl *>(this)->getPreviousDecl()); 504 } 505 506 const CXXRecordDecl *getPreviousDecl() const { 507 return const_cast<CXXRecordDecl*>(this)->getPreviousDecl(); 508 } 509 510 CXXRecordDecl *getMostRecentDecl() { 511 return cast<CXXRecordDecl>( 512 static_cast<RecordDecl *>(this)->getMostRecentDecl()); 513 } 514 515 const CXXRecordDecl *getMostRecentDecl() const { 516 return const_cast<CXXRecordDecl*>(this)->getMostRecentDecl(); 517 } 518 519 CXXRecordDecl *getMostRecentNonInjectedDecl() { 520 CXXRecordDecl *Recent = 521 static_cast<CXXRecordDecl *>(this)->getMostRecentDecl(); 522 while (Recent->isInjectedClassName()) { 523 // FIXME: Does injected class name need to be in the redeclarations chain? 524 assert(Recent->getPreviousDecl()); 525 Recent = Recent->getPreviousDecl(); 526 } 527 return Recent; 528 } 529 530 const CXXRecordDecl *getMostRecentNonInjectedDecl() const { 531 return const_cast<CXXRecordDecl*>(this)->getMostRecentNonInjectedDecl(); 532 } 533 534 CXXRecordDecl *getDefinition() const { 535 // We only need an update if we don't already know which 536 // declaration is the definition. 537 auto *DD = DefinitionData ? DefinitionData : dataPtr(); 538 return DD ? DD->Definition : nullptr; 539 } 540 541 bool hasDefinition() const { return DefinitionData || dataPtr(); } 542 543 static CXXRecordDecl *Create(const ASTContext &C, TagKind TK, DeclContext *DC, 544 SourceLocation StartLoc, SourceLocation IdLoc, 545 IdentifierInfo *Id, 546 CXXRecordDecl *PrevDecl = nullptr, 547 bool DelayTypeCreation = false); 548 static CXXRecordDecl *CreateLambda(const ASTContext &C, DeclContext *DC, 549 TypeSourceInfo *Info, SourceLocation Loc, 550 bool DependentLambda, bool IsGeneric, 551 LambdaCaptureDefault CaptureDefault); 552 static CXXRecordDecl *CreateDeserialized(const ASTContext &C, unsigned ID); 553 554 bool isDynamicClass() const { 555 return data().Polymorphic || data().NumVBases != 0; 556 } 557 558 /// @returns true if class is dynamic or might be dynamic because the 559 /// definition is incomplete of dependent. 560 bool mayBeDynamicClass() const { 561 return !hasDefinition() || isDynamicClass() || hasAnyDependentBases(); 562 } 563 564 /// @returns true if class is non dynamic or might be non dynamic because the 565 /// definition is incomplete of dependent. 566 bool mayBeNonDynamicClass() const { 567 return !hasDefinition() || !isDynamicClass() || hasAnyDependentBases(); 568 } 569 570 void setIsParsingBaseSpecifiers() { data().IsParsingBaseSpecifiers = true; } 571 572 bool isParsingBaseSpecifiers() const { 573 return data().IsParsingBaseSpecifiers; 574 } 575 576 unsigned getODRHash() const; 577 578 /// Sets the base classes of this struct or class. 579 void setBases(CXXBaseSpecifier const * const *Bases, unsigned NumBases); 580 581 /// Retrieves the number of base classes of this class. 582 unsigned getNumBases() const { return data().NumBases; } 583 584 using base_class_range = llvm::iterator_range<base_class_iterator>; 585 using base_class_const_range = 586 llvm::iterator_range<base_class_const_iterator>; 587 588 base_class_range bases() { 589 return base_class_range(bases_begin(), bases_end()); 590 } 591 base_class_const_range bases() const { 592 return base_class_const_range(bases_begin(), bases_end()); 593 } 594 595 base_class_iterator bases_begin() { return data().getBases(); } 596 base_class_const_iterator bases_begin() const { return data().getBases(); } 597 base_class_iterator bases_end() { return bases_begin() + data().NumBases; } 598 base_class_const_iterator bases_end() const { 599 return bases_begin() + data().NumBases; 600 } 601 602 /// Retrieves the number of virtual base classes of this class. 603 unsigned getNumVBases() const { return data().NumVBases; } 604 605 base_class_range vbases() { 606 return base_class_range(vbases_begin(), vbases_end()); 607 } 608 base_class_const_range vbases() const { 609 return base_class_const_range(vbases_begin(), vbases_end()); 610 } 611 612 base_class_iterator vbases_begin() { return data().getVBases(); } 613 base_class_const_iterator vbases_begin() const { return data().getVBases(); } 614 base_class_iterator vbases_end() { return vbases_begin() + data().NumVBases; } 615 base_class_const_iterator vbases_end() const { 616 return vbases_begin() + data().NumVBases; 617 } 618 619 /// Determine whether this class has any dependent base classes which 620 /// are not the current instantiation. 621 bool hasAnyDependentBases() const; 622 623 /// Iterator access to method members. The method iterator visits 624 /// all method members of the class, including non-instance methods, 625 /// special methods, etc. 626 using method_iterator = specific_decl_iterator<CXXMethodDecl>; 627 using method_range = 628 llvm::iterator_range<specific_decl_iterator<CXXMethodDecl>>; 629 630 method_range methods() const { 631 return method_range(method_begin(), method_end()); 632 } 633 634 /// Method begin iterator. Iterates in the order the methods 635 /// were declared. 636 method_iterator method_begin() const { 637 return method_iterator(decls_begin()); 638 } 639 640 /// Method past-the-end iterator. 641 method_iterator method_end() const { 642 return method_iterator(decls_end()); 643 } 644 645 /// Iterator access to constructor members. 646 using ctor_iterator = specific_decl_iterator<CXXConstructorDecl>; 647 using ctor_range = 648 llvm::iterator_range<specific_decl_iterator<CXXConstructorDecl>>; 649 650 ctor_range ctors() const { return ctor_range(ctor_begin(), ctor_end()); } 651 652 ctor_iterator ctor_begin() const { 653 return ctor_iterator(decls_begin()); 654 } 655 656 ctor_iterator ctor_end() const { 657 return ctor_iterator(decls_end()); 658 } 659 660 /// An iterator over friend declarations. All of these are defined 661 /// in DeclFriend.h. 662 class friend_iterator; 663 using friend_range = llvm::iterator_range<friend_iterator>; 664 665 friend_range friends() const; 666 friend_iterator friend_begin() const; 667 friend_iterator friend_end() const; 668 void pushFriendDecl(FriendDecl *FD); 669 670 /// Determines whether this record has any friends. 671 bool hasFriends() const { 672 return data().FirstFriend.isValid(); 673 } 674 675 /// \c true if a defaulted copy constructor for this class would be 676 /// deleted. 677 bool defaultedCopyConstructorIsDeleted() const { 678 assert((!needsOverloadResolutionForCopyConstructor() || 679 (data().DeclaredSpecialMembers & SMF_CopyConstructor)) && 680 "this property has not yet been computed by Sema"); 681 return data().DefaultedCopyConstructorIsDeleted; 682 } 683 684 /// \c true if a defaulted move constructor for this class would be 685 /// deleted. 686 bool defaultedMoveConstructorIsDeleted() const { 687 assert((!needsOverloadResolutionForMoveConstructor() || 688 (data().DeclaredSpecialMembers & SMF_MoveConstructor)) && 689 "this property has not yet been computed by Sema"); 690 return data().DefaultedMoveConstructorIsDeleted; 691 } 692 693 /// \c true if a defaulted destructor for this class would be deleted. 694 bool defaultedDestructorIsDeleted() const { 695 assert((!needsOverloadResolutionForDestructor() || 696 (data().DeclaredSpecialMembers & SMF_Destructor)) && 697 "this property has not yet been computed by Sema"); 698 return data().DefaultedDestructorIsDeleted; 699 } 700 701 /// \c true if we know for sure that this class has a single, 702 /// accessible, unambiguous copy constructor that is not deleted. 703 bool hasSimpleCopyConstructor() const { 704 return !hasUserDeclaredCopyConstructor() && 705 !data().DefaultedCopyConstructorIsDeleted; 706 } 707 708 /// \c true if we know for sure that this class has a single, 709 /// accessible, unambiguous move constructor that is not deleted. 710 bool hasSimpleMoveConstructor() const { 711 return !hasUserDeclaredMoveConstructor() && hasMoveConstructor() && 712 !data().DefaultedMoveConstructorIsDeleted; 713 } 714 715 /// \c true if we know for sure that this class has a single, 716 /// accessible, unambiguous copy assignment operator that is not deleted. 717 bool hasSimpleCopyAssignment() const { 718 return !hasUserDeclaredCopyAssignment() && 719 !data().DefaultedCopyAssignmentIsDeleted; 720 } 721 722 /// \c true if we know for sure that this class has a single, 723 /// accessible, unambiguous move assignment operator that is not deleted. 724 bool hasSimpleMoveAssignment() const { 725 return !hasUserDeclaredMoveAssignment() && hasMoveAssignment() && 726 !data().DefaultedMoveAssignmentIsDeleted; 727 } 728 729 /// \c true if we know for sure that this class has an accessible 730 /// destructor that is not deleted. 731 bool hasSimpleDestructor() const { 732 return !hasUserDeclaredDestructor() && 733 !data().DefaultedDestructorIsDeleted; 734 } 735 736 /// Determine whether this class has any default constructors. 737 bool hasDefaultConstructor() const { 738 return (data().DeclaredSpecialMembers & SMF_DefaultConstructor) || 739 needsImplicitDefaultConstructor(); 740 } 741 742 /// Determine if we need to declare a default constructor for 743 /// this class. 744 /// 745 /// This value is used for lazy creation of default constructors. 746 bool needsImplicitDefaultConstructor() const { 747 return (!data().UserDeclaredConstructor && 748 !(data().DeclaredSpecialMembers & SMF_DefaultConstructor) && 749 (!isLambda() || lambdaIsDefaultConstructibleAndAssignable())) || 750 // FIXME: Proposed fix to core wording issue: if a class inherits 751 // a default constructor and doesn't explicitly declare one, one 752 // is declared implicitly. 753 (data().HasInheritedDefaultConstructor && 754 !(data().DeclaredSpecialMembers & SMF_DefaultConstructor)); 755 } 756 757 /// Determine whether this class has any user-declared constructors. 758 /// 759 /// When true, a default constructor will not be implicitly declared. 760 bool hasUserDeclaredConstructor() const { 761 return data().UserDeclaredConstructor; 762 } 763 764 /// Whether this class has a user-provided default constructor 765 /// per C++11. 766 bool hasUserProvidedDefaultConstructor() const { 767 return data().UserProvidedDefaultConstructor; 768 } 769 770 /// Determine whether this class has a user-declared copy constructor. 771 /// 772 /// When false, a copy constructor will be implicitly declared. 773 bool hasUserDeclaredCopyConstructor() const { 774 return data().UserDeclaredSpecialMembers & SMF_CopyConstructor; 775 } 776 777 /// Determine whether this class needs an implicit copy 778 /// constructor to be lazily declared. 779 bool needsImplicitCopyConstructor() const { 780 return !(data().DeclaredSpecialMembers & SMF_CopyConstructor); 781 } 782 783 /// Determine whether we need to eagerly declare a defaulted copy 784 /// constructor for this class. 785 bool needsOverloadResolutionForCopyConstructor() const { 786 // C++17 [class.copy.ctor]p6: 787 // If the class definition declares a move constructor or move assignment 788 // operator, the implicitly declared copy constructor is defined as 789 // deleted. 790 // In MSVC mode, sometimes a declared move assignment does not delete an 791 // implicit copy constructor, so defer this choice to Sema. 792 if (data().UserDeclaredSpecialMembers & 793 (SMF_MoveConstructor | SMF_MoveAssignment)) 794 return true; 795 return data().NeedOverloadResolutionForCopyConstructor; 796 } 797 798 /// Determine whether an implicit copy constructor for this type 799 /// would have a parameter with a const-qualified reference type. 800 bool implicitCopyConstructorHasConstParam() const { 801 return data().ImplicitCopyConstructorCanHaveConstParamForNonVBase && 802 (isAbstract() || 803 data().ImplicitCopyConstructorCanHaveConstParamForVBase); 804 } 805 806 /// Determine whether this class has a copy constructor with 807 /// a parameter type which is a reference to a const-qualified type. 808 bool hasCopyConstructorWithConstParam() const { 809 return data().HasDeclaredCopyConstructorWithConstParam || 810 (needsImplicitCopyConstructor() && 811 implicitCopyConstructorHasConstParam()); 812 } 813 814 /// Whether this class has a user-declared move constructor or 815 /// assignment operator. 816 /// 817 /// When false, a move constructor and assignment operator may be 818 /// implicitly declared. 819 bool hasUserDeclaredMoveOperation() const { 820 return data().UserDeclaredSpecialMembers & 821 (SMF_MoveConstructor | SMF_MoveAssignment); 822 } 823 824 /// Determine whether this class has had a move constructor 825 /// declared by the user. 826 bool hasUserDeclaredMoveConstructor() const { 827 return data().UserDeclaredSpecialMembers & SMF_MoveConstructor; 828 } 829 830 /// Determine whether this class has a move constructor. 831 bool hasMoveConstructor() const { 832 return (data().DeclaredSpecialMembers & SMF_MoveConstructor) || 833 needsImplicitMoveConstructor(); 834 } 835 836 /// Set that we attempted to declare an implicit copy 837 /// constructor, but overload resolution failed so we deleted it. 838 void setImplicitCopyConstructorIsDeleted() { 839 assert((data().DefaultedCopyConstructorIsDeleted || 840 needsOverloadResolutionForCopyConstructor()) && 841 "Copy constructor should not be deleted"); 842 data().DefaultedCopyConstructorIsDeleted = true; 843 } 844 845 /// Set that we attempted to declare an implicit move 846 /// constructor, but overload resolution failed so we deleted it. 847 void setImplicitMoveConstructorIsDeleted() { 848 assert((data().DefaultedMoveConstructorIsDeleted || 849 needsOverloadResolutionForMoveConstructor()) && 850 "move constructor should not be deleted"); 851 data().DefaultedMoveConstructorIsDeleted = true; 852 } 853 854 /// Set that we attempted to declare an implicit destructor, 855 /// but overload resolution failed so we deleted it. 856 void setImplicitDestructorIsDeleted() { 857 assert((data().DefaultedDestructorIsDeleted || 858 needsOverloadResolutionForDestructor()) && 859 "destructor should not be deleted"); 860 data().DefaultedDestructorIsDeleted = true; 861 } 862 863 /// Determine whether this class should get an implicit move 864 /// constructor or if any existing special member function inhibits this. 865 bool needsImplicitMoveConstructor() const { 866 return !(data().DeclaredSpecialMembers & SMF_MoveConstructor) && 867 !hasUserDeclaredCopyConstructor() && 868 !hasUserDeclaredCopyAssignment() && 869 !hasUserDeclaredMoveAssignment() && 870 !hasUserDeclaredDestructor(); 871 } 872 873 /// Determine whether we need to eagerly declare a defaulted move 874 /// constructor for this class. 875 bool needsOverloadResolutionForMoveConstructor() const { 876 return data().NeedOverloadResolutionForMoveConstructor; 877 } 878 879 /// Determine whether this class has a user-declared copy assignment 880 /// operator. 881 /// 882 /// When false, a copy assignment operator will be implicitly declared. 883 bool hasUserDeclaredCopyAssignment() const { 884 return data().UserDeclaredSpecialMembers & SMF_CopyAssignment; 885 } 886 887 /// Set that we attempted to declare an implicit copy assignment 888 /// operator, but overload resolution failed so we deleted it. 889 void setImplicitCopyAssignmentIsDeleted() { 890 assert((data().DefaultedCopyAssignmentIsDeleted || 891 needsOverloadResolutionForCopyAssignment()) && 892 "copy assignment should not be deleted"); 893 data().DefaultedCopyAssignmentIsDeleted = true; 894 } 895 896 /// Determine whether this class needs an implicit copy 897 /// assignment operator to be lazily declared. 898 bool needsImplicitCopyAssignment() const { 899 return !(data().DeclaredSpecialMembers & SMF_CopyAssignment); 900 } 901 902 /// Determine whether we need to eagerly declare a defaulted copy 903 /// assignment operator for this class. 904 bool needsOverloadResolutionForCopyAssignment() const { 905 // C++20 [class.copy.assign]p2: 906 // If the class definition declares a move constructor or move assignment 907 // operator, the implicitly declared copy assignment operator is defined 908 // as deleted. 909 // In MSVC mode, sometimes a declared move constructor does not delete an 910 // implicit copy assignment, so defer this choice to Sema. 911 if (data().UserDeclaredSpecialMembers & 912 (SMF_MoveConstructor | SMF_MoveAssignment)) 913 return true; 914 return data().NeedOverloadResolutionForCopyAssignment; 915 } 916 917 /// Determine whether an implicit copy assignment operator for this 918 /// type would have a parameter with a const-qualified reference type. 919 bool implicitCopyAssignmentHasConstParam() const { 920 return data().ImplicitCopyAssignmentHasConstParam; 921 } 922 923 /// Determine whether this class has a copy assignment operator with 924 /// a parameter type which is a reference to a const-qualified type or is not 925 /// a reference. 926 bool hasCopyAssignmentWithConstParam() const { 927 return data().HasDeclaredCopyAssignmentWithConstParam || 928 (needsImplicitCopyAssignment() && 929 implicitCopyAssignmentHasConstParam()); 930 } 931 932 /// Determine whether this class has had a move assignment 933 /// declared by the user. 934 bool hasUserDeclaredMoveAssignment() const { 935 return data().UserDeclaredSpecialMembers & SMF_MoveAssignment; 936 } 937 938 /// Determine whether this class has a move assignment operator. 939 bool hasMoveAssignment() const { 940 return (data().DeclaredSpecialMembers & SMF_MoveAssignment) || 941 needsImplicitMoveAssignment(); 942 } 943 944 /// Set that we attempted to declare an implicit move assignment 945 /// operator, but overload resolution failed so we deleted it. 946 void setImplicitMoveAssignmentIsDeleted() { 947 assert((data().DefaultedMoveAssignmentIsDeleted || 948 needsOverloadResolutionForMoveAssignment()) && 949 "move assignment should not be deleted"); 950 data().DefaultedMoveAssignmentIsDeleted = true; 951 } 952 953 /// Determine whether this class should get an implicit move 954 /// assignment operator or if any existing special member function inhibits 955 /// this. 956 bool needsImplicitMoveAssignment() const { 957 return !(data().DeclaredSpecialMembers & SMF_MoveAssignment) && 958 !hasUserDeclaredCopyConstructor() && 959 !hasUserDeclaredCopyAssignment() && 960 !hasUserDeclaredMoveConstructor() && 961 !hasUserDeclaredDestructor() && 962 (!isLambda() || lambdaIsDefaultConstructibleAndAssignable()); 963 } 964 965 /// Determine whether we need to eagerly declare a move assignment 966 /// operator for this class. 967 bool needsOverloadResolutionForMoveAssignment() const { 968 return data().NeedOverloadResolutionForMoveAssignment; 969 } 970 971 /// Determine whether this class has a user-declared destructor. 972 /// 973 /// When false, a destructor will be implicitly declared. 974 bool hasUserDeclaredDestructor() const { 975 return data().UserDeclaredSpecialMembers & SMF_Destructor; 976 } 977 978 /// Determine whether this class needs an implicit destructor to 979 /// be lazily declared. 980 bool needsImplicitDestructor() const { 981 return !(data().DeclaredSpecialMembers & SMF_Destructor); 982 } 983 984 /// Determine whether we need to eagerly declare a destructor for this 985 /// class. 986 bool needsOverloadResolutionForDestructor() const { 987 return data().NeedOverloadResolutionForDestructor; 988 } 989 990 /// Determine whether this class describes a lambda function object. 991 bool isLambda() const { 992 // An update record can't turn a non-lambda into a lambda. 993 auto *DD = DefinitionData; 994 return DD && DD->IsLambda; 995 } 996 997 /// Determine whether this class describes a generic 998 /// lambda function object (i.e. function call operator is 999 /// a template). 1000 bool isGenericLambda() const; 1001 1002 /// Determine whether this lambda should have an implicit default constructor 1003 /// and copy and move assignment operators. 1004 bool lambdaIsDefaultConstructibleAndAssignable() const; 1005 1006 /// Retrieve the lambda call operator of the closure type 1007 /// if this is a closure type. 1008 CXXMethodDecl *getLambdaCallOperator() const; 1009 1010 /// Retrieve the dependent lambda call operator of the closure type 1011 /// if this is a templated closure type. 1012 FunctionTemplateDecl *getDependentLambdaCallOperator() const; 1013 1014 /// Retrieve the lambda static invoker, the address of which 1015 /// is returned by the conversion operator, and the body of which 1016 /// is forwarded to the lambda call operator. The version that does not 1017 /// take a calling convention uses the 'default' calling convention for free 1018 /// functions if the Lambda's calling convention was not modified via 1019 /// attribute. Otherwise, it will return the calling convention specified for 1020 /// the lambda. 1021 CXXMethodDecl *getLambdaStaticInvoker() const; 1022 CXXMethodDecl *getLambdaStaticInvoker(CallingConv CC) const; 1023 1024 /// Retrieve the generic lambda's template parameter list. 1025 /// Returns null if the class does not represent a lambda or a generic 1026 /// lambda. 1027 TemplateParameterList *getGenericLambdaTemplateParameterList() const; 1028 1029 /// Retrieve the lambda template parameters that were specified explicitly. 1030 ArrayRef<NamedDecl *> getLambdaExplicitTemplateParameters() const; 1031 1032 LambdaCaptureDefault getLambdaCaptureDefault() const { 1033 assert(isLambda()); 1034 return static_cast<LambdaCaptureDefault>(getLambdaData().CaptureDefault); 1035 } 1036 1037 /// Set the captures for this lambda closure type. 1038 void setCaptures(ASTContext &Context, ArrayRef<LambdaCapture> Captures); 1039 1040 /// For a closure type, retrieve the mapping from captured 1041 /// variables and \c this to the non-static data members that store the 1042 /// values or references of the captures. 1043 /// 1044 /// \param Captures Will be populated with the mapping from captured 1045 /// variables to the corresponding fields. 1046 /// 1047 /// \param ThisCapture Will be set to the field declaration for the 1048 /// \c this capture. 1049 /// 1050 /// \note No entries will be added for init-captures, as they do not capture 1051 /// variables. 1052 void getCaptureFields(llvm::DenseMap<const VarDecl *, FieldDecl *> &Captures, 1053 FieldDecl *&ThisCapture) const; 1054 1055 using capture_const_iterator = const LambdaCapture *; 1056 using capture_const_range = llvm::iterator_range<capture_const_iterator>; 1057 1058 capture_const_range captures() const { 1059 return capture_const_range(captures_begin(), captures_end()); 1060 } 1061 1062 capture_const_iterator captures_begin() const { 1063 return isLambda() ? getLambdaData().Captures : nullptr; 1064 } 1065 1066 capture_const_iterator captures_end() const { 1067 return isLambda() ? captures_begin() + getLambdaData().NumCaptures 1068 : nullptr; 1069 } 1070 1071 unsigned capture_size() const { return getLambdaData().NumCaptures; } 1072 1073 using conversion_iterator = UnresolvedSetIterator; 1074 1075 conversion_iterator conversion_begin() const { 1076 return data().Conversions.get(getASTContext()).begin(); 1077 } 1078 1079 conversion_iterator conversion_end() const { 1080 return data().Conversions.get(getASTContext()).end(); 1081 } 1082 1083 /// Removes a conversion function from this class. The conversion 1084 /// function must currently be a member of this class. Furthermore, 1085 /// this class must currently be in the process of being defined. 1086 void removeConversion(const NamedDecl *Old); 1087 1088 /// Get all conversion functions visible in current class, 1089 /// including conversion function templates. 1090 llvm::iterator_range<conversion_iterator> 1091 getVisibleConversionFunctions() const; 1092 1093 /// Determine whether this class is an aggregate (C++ [dcl.init.aggr]), 1094 /// which is a class with no user-declared constructors, no private 1095 /// or protected non-static data members, no base classes, and no virtual 1096 /// functions (C++ [dcl.init.aggr]p1). 1097 bool isAggregate() const { return data().Aggregate; } 1098 1099 /// Whether this class has any in-class initializers 1100 /// for non-static data members (including those in anonymous unions or 1101 /// structs). 1102 bool hasInClassInitializer() const { return data().HasInClassInitializer; } 1103 1104 /// Whether this class or any of its subobjects has any members of 1105 /// reference type which would make value-initialization ill-formed. 1106 /// 1107 /// Per C++03 [dcl.init]p5: 1108 /// - if T is a non-union class type without a user-declared constructor, 1109 /// then every non-static data member and base-class component of T is 1110 /// value-initialized [...] A program that calls for [...] 1111 /// value-initialization of an entity of reference type is ill-formed. 1112 bool hasUninitializedReferenceMember() const { 1113 return !isUnion() && !hasUserDeclaredConstructor() && 1114 data().HasUninitializedReferenceMember; 1115 } 1116 1117 /// Whether this class is a POD-type (C++ [class]p4) 1118 /// 1119 /// For purposes of this function a class is POD if it is an aggregate 1120 /// that has no non-static non-POD data members, no reference data 1121 /// members, no user-defined copy assignment operator and no 1122 /// user-defined destructor. 1123 /// 1124 /// Note that this is the C++ TR1 definition of POD. 1125 bool isPOD() const { return data().PlainOldData; } 1126 1127 /// True if this class is C-like, without C++-specific features, e.g. 1128 /// it contains only public fields, no bases, tag kind is not 'class', etc. 1129 bool isCLike() const; 1130 1131 /// Determine whether this is an empty class in the sense of 1132 /// (C++11 [meta.unary.prop]). 1133 /// 1134 /// The CXXRecordDecl is a class type, but not a union type, 1135 /// with no non-static data members other than bit-fields of length 0, 1136 /// no virtual member functions, no virtual base classes, 1137 /// and no base class B for which is_empty<B>::value is false. 1138 /// 1139 /// \note This does NOT include a check for union-ness. 1140 bool isEmpty() const { return data().Empty; } 1141 1142 bool hasPrivateFields() const { 1143 return data().HasPrivateFields; 1144 } 1145 1146 bool hasProtectedFields() const { 1147 return data().HasProtectedFields; 1148 } 1149 1150 /// Determine whether this class has direct non-static data members. 1151 bool hasDirectFields() const { 1152 auto &D = data(); 1153 return D.HasPublicFields || D.HasProtectedFields || D.HasPrivateFields; 1154 } 1155 1156 /// Whether this class is polymorphic (C++ [class.virtual]), 1157 /// which means that the class contains or inherits a virtual function. 1158 bool isPolymorphic() const { return data().Polymorphic; } 1159 1160 /// Determine whether this class has a pure virtual function. 1161 /// 1162 /// The class is is abstract per (C++ [class.abstract]p2) if it declares 1163 /// a pure virtual function or inherits a pure virtual function that is 1164 /// not overridden. 1165 bool isAbstract() const { return data().Abstract; } 1166 1167 /// Determine whether this class is standard-layout per 1168 /// C++ [class]p7. 1169 bool isStandardLayout() const { return data().IsStandardLayout; } 1170 1171 /// Determine whether this class was standard-layout per 1172 /// C++11 [class]p7, specifically using the C++11 rules without any DRs. 1173 bool isCXX11StandardLayout() const { return data().IsCXX11StandardLayout; } 1174 1175 /// Determine whether this class, or any of its class subobjects, 1176 /// contains a mutable field. 1177 bool hasMutableFields() const { return data().HasMutableFields; } 1178 1179 /// Determine whether this class has any variant members. 1180 bool hasVariantMembers() const { return data().HasVariantMembers; } 1181 1182 /// Determine whether this class has a trivial default constructor 1183 /// (C++11 [class.ctor]p5). 1184 bool hasTrivialDefaultConstructor() const { 1185 return hasDefaultConstructor() && 1186 (data().HasTrivialSpecialMembers & SMF_DefaultConstructor); 1187 } 1188 1189 /// Determine whether this class has a non-trivial default constructor 1190 /// (C++11 [class.ctor]p5). 1191 bool hasNonTrivialDefaultConstructor() const { 1192 return (data().DeclaredNonTrivialSpecialMembers & SMF_DefaultConstructor) || 1193 (needsImplicitDefaultConstructor() && 1194 !(data().HasTrivialSpecialMembers & SMF_DefaultConstructor)); 1195 } 1196 1197 /// Determine whether this class has at least one constexpr constructor 1198 /// other than the copy or move constructors. 1199 bool hasConstexprNonCopyMoveConstructor() const { 1200 return data().HasConstexprNonCopyMoveConstructor || 1201 (needsImplicitDefaultConstructor() && 1202 defaultedDefaultConstructorIsConstexpr()); 1203 } 1204 1205 /// Determine whether a defaulted default constructor for this class 1206 /// would be constexpr. 1207 bool defaultedDefaultConstructorIsConstexpr() const { 1208 return data().DefaultedDefaultConstructorIsConstexpr && 1209 (!isUnion() || hasInClassInitializer() || !hasVariantMembers() || 1210 getLangOpts().CPlusPlus20); 1211 } 1212 1213 /// Determine whether this class has a constexpr default constructor. 1214 bool hasConstexprDefaultConstructor() const { 1215 return data().HasConstexprDefaultConstructor || 1216 (needsImplicitDefaultConstructor() && 1217 defaultedDefaultConstructorIsConstexpr()); 1218 } 1219 1220 /// Determine whether this class has a trivial copy constructor 1221 /// (C++ [class.copy]p6, C++11 [class.copy]p12) 1222 bool hasTrivialCopyConstructor() const { 1223 return data().HasTrivialSpecialMembers & SMF_CopyConstructor; 1224 } 1225 1226 bool hasTrivialCopyConstructorForCall() const { 1227 return data().HasTrivialSpecialMembersForCall & SMF_CopyConstructor; 1228 } 1229 1230 /// Determine whether this class has a non-trivial copy constructor 1231 /// (C++ [class.copy]p6, C++11 [class.copy]p12) 1232 bool hasNonTrivialCopyConstructor() const { 1233 return data().DeclaredNonTrivialSpecialMembers & SMF_CopyConstructor || 1234 !hasTrivialCopyConstructor(); 1235 } 1236 1237 bool hasNonTrivialCopyConstructorForCall() const { 1238 return (data().DeclaredNonTrivialSpecialMembersForCall & 1239 SMF_CopyConstructor) || 1240 !hasTrivialCopyConstructorForCall(); 1241 } 1242 1243 /// Determine whether this class has a trivial move constructor 1244 /// (C++11 [class.copy]p12) 1245 bool hasTrivialMoveConstructor() const { 1246 return hasMoveConstructor() && 1247 (data().HasTrivialSpecialMembers & SMF_MoveConstructor); 1248 } 1249 1250 bool hasTrivialMoveConstructorForCall() const { 1251 return hasMoveConstructor() && 1252 (data().HasTrivialSpecialMembersForCall & SMF_MoveConstructor); 1253 } 1254 1255 /// Determine whether this class has a non-trivial move constructor 1256 /// (C++11 [class.copy]p12) 1257 bool hasNonTrivialMoveConstructor() const { 1258 return (data().DeclaredNonTrivialSpecialMembers & SMF_MoveConstructor) || 1259 (needsImplicitMoveConstructor() && 1260 !(data().HasTrivialSpecialMembers & SMF_MoveConstructor)); 1261 } 1262 1263 bool hasNonTrivialMoveConstructorForCall() const { 1264 return (data().DeclaredNonTrivialSpecialMembersForCall & 1265 SMF_MoveConstructor) || 1266 (needsImplicitMoveConstructor() && 1267 !(data().HasTrivialSpecialMembersForCall & SMF_MoveConstructor)); 1268 } 1269 1270 /// Determine whether this class has a trivial copy assignment operator 1271 /// (C++ [class.copy]p11, C++11 [class.copy]p25) 1272 bool hasTrivialCopyAssignment() const { 1273 return data().HasTrivialSpecialMembers & SMF_CopyAssignment; 1274 } 1275 1276 /// Determine whether this class has a non-trivial copy assignment 1277 /// operator (C++ [class.copy]p11, C++11 [class.copy]p25) 1278 bool hasNonTrivialCopyAssignment() const { 1279 return data().DeclaredNonTrivialSpecialMembers & SMF_CopyAssignment || 1280 !hasTrivialCopyAssignment(); 1281 } 1282 1283 /// Determine whether this class has a trivial move assignment operator 1284 /// (C++11 [class.copy]p25) 1285 bool hasTrivialMoveAssignment() const { 1286 return hasMoveAssignment() && 1287 (data().HasTrivialSpecialMembers & SMF_MoveAssignment); 1288 } 1289 1290 /// Determine whether this class has a non-trivial move assignment 1291 /// operator (C++11 [class.copy]p25) 1292 bool hasNonTrivialMoveAssignment() const { 1293 return (data().DeclaredNonTrivialSpecialMembers & SMF_MoveAssignment) || 1294 (needsImplicitMoveAssignment() && 1295 !(data().HasTrivialSpecialMembers & SMF_MoveAssignment)); 1296 } 1297 1298 /// Determine whether a defaulted default constructor for this class 1299 /// would be constexpr. 1300 bool defaultedDestructorIsConstexpr() const { 1301 return data().DefaultedDestructorIsConstexpr && 1302 getLangOpts().CPlusPlus20; 1303 } 1304 1305 /// Determine whether this class has a constexpr destructor. 1306 bool hasConstexprDestructor() const; 1307 1308 /// Determine whether this class has a trivial destructor 1309 /// (C++ [class.dtor]p3) 1310 bool hasTrivialDestructor() const { 1311 return data().HasTrivialSpecialMembers & SMF_Destructor; 1312 } 1313 1314 bool hasTrivialDestructorForCall() const { 1315 return data().HasTrivialSpecialMembersForCall & SMF_Destructor; 1316 } 1317 1318 /// Determine whether this class has a non-trivial destructor 1319 /// (C++ [class.dtor]p3) 1320 bool hasNonTrivialDestructor() const { 1321 return !(data().HasTrivialSpecialMembers & SMF_Destructor); 1322 } 1323 1324 bool hasNonTrivialDestructorForCall() const { 1325 return !(data().HasTrivialSpecialMembersForCall & SMF_Destructor); 1326 } 1327 1328 void setHasTrivialSpecialMemberForCall() { 1329 data().HasTrivialSpecialMembersForCall = 1330 (SMF_CopyConstructor | SMF_MoveConstructor | SMF_Destructor); 1331 } 1332 1333 /// Determine whether declaring a const variable with this type is ok 1334 /// per core issue 253. 1335 bool allowConstDefaultInit() const { 1336 return !data().HasUninitializedFields || 1337 !(data().HasDefaultedDefaultConstructor || 1338 needsImplicitDefaultConstructor()); 1339 } 1340 1341 /// Determine whether this class has a destructor which has no 1342 /// semantic effect. 1343 /// 1344 /// Any such destructor will be trivial, public, defaulted and not deleted, 1345 /// and will call only irrelevant destructors. 1346 bool hasIrrelevantDestructor() const { 1347 return data().HasIrrelevantDestructor; 1348 } 1349 1350 /// Determine whether this class has a non-literal or/ volatile type 1351 /// non-static data member or base class. 1352 bool hasNonLiteralTypeFieldsOrBases() const { 1353 return data().HasNonLiteralTypeFieldsOrBases; 1354 } 1355 1356 /// Determine whether this class has a using-declaration that names 1357 /// a user-declared base class constructor. 1358 bool hasInheritedConstructor() const { 1359 return data().HasInheritedConstructor; 1360 } 1361 1362 /// Determine whether this class has a using-declaration that names 1363 /// a base class assignment operator. 1364 bool hasInheritedAssignment() const { 1365 return data().HasInheritedAssignment; 1366 } 1367 1368 /// Determine whether this class is considered trivially copyable per 1369 /// (C++11 [class]p6). 1370 bool isTriviallyCopyable() const; 1371 1372 /// Determine whether this class is considered trivial. 1373 /// 1374 /// C++11 [class]p6: 1375 /// "A trivial class is a class that has a trivial default constructor and 1376 /// is trivially copyable." 1377 bool isTrivial() const { 1378 return isTriviallyCopyable() && hasTrivialDefaultConstructor(); 1379 } 1380 1381 /// Determine whether this class is a literal type. 1382 /// 1383 /// C++11 [basic.types]p10: 1384 /// A class type that has all the following properties: 1385 /// - it has a trivial destructor 1386 /// - every constructor call and full-expression in the 1387 /// brace-or-equal-intializers for non-static data members (if any) is 1388 /// a constant expression. 1389 /// - it is an aggregate type or has at least one constexpr constructor 1390 /// or constructor template that is not a copy or move constructor, and 1391 /// - all of its non-static data members and base classes are of literal 1392 /// types 1393 /// 1394 /// We resolve DR1361 by ignoring the second bullet. We resolve DR1452 by 1395 /// treating types with trivial default constructors as literal types. 1396 /// 1397 /// Only in C++17 and beyond, are lambdas literal types. 1398 bool isLiteral() const { 1399 const LangOptions &LangOpts = getLangOpts(); 1400 return (LangOpts.CPlusPlus20 ? hasConstexprDestructor() 1401 : hasTrivialDestructor()) && 1402 (!isLambda() || LangOpts.CPlusPlus17) && 1403 !hasNonLiteralTypeFieldsOrBases() && 1404 (isAggregate() || isLambda() || 1405 hasConstexprNonCopyMoveConstructor() || 1406 hasTrivialDefaultConstructor()); 1407 } 1408 1409 /// Determine whether this is a structural type. 1410 bool isStructural() const { 1411 return isLiteral() && data().StructuralIfLiteral; 1412 } 1413 1414 /// If this record is an instantiation of a member class, 1415 /// retrieves the member class from which it was instantiated. 1416 /// 1417 /// This routine will return non-null for (non-templated) member 1418 /// classes of class templates. For example, given: 1419 /// 1420 /// \code 1421 /// template<typename T> 1422 /// struct X { 1423 /// struct A { }; 1424 /// }; 1425 /// \endcode 1426 /// 1427 /// The declaration for X<int>::A is a (non-templated) CXXRecordDecl 1428 /// whose parent is the class template specialization X<int>. For 1429 /// this declaration, getInstantiatedFromMemberClass() will return 1430 /// the CXXRecordDecl X<T>::A. When a complete definition of 1431 /// X<int>::A is required, it will be instantiated from the 1432 /// declaration returned by getInstantiatedFromMemberClass(). 1433 CXXRecordDecl *getInstantiatedFromMemberClass() const; 1434 1435 /// If this class is an instantiation of a member class of a 1436 /// class template specialization, retrieves the member specialization 1437 /// information. 1438 MemberSpecializationInfo *getMemberSpecializationInfo() const; 1439 1440 /// Specify that this record is an instantiation of the 1441 /// member class \p RD. 1442 void setInstantiationOfMemberClass(CXXRecordDecl *RD, 1443 TemplateSpecializationKind TSK); 1444 1445 /// Retrieves the class template that is described by this 1446 /// class declaration. 1447 /// 1448 /// Every class template is represented as a ClassTemplateDecl and a 1449 /// CXXRecordDecl. The former contains template properties (such as 1450 /// the template parameter lists) while the latter contains the 1451 /// actual description of the template's 1452 /// contents. ClassTemplateDecl::getTemplatedDecl() retrieves the 1453 /// CXXRecordDecl that from a ClassTemplateDecl, while 1454 /// getDescribedClassTemplate() retrieves the ClassTemplateDecl from 1455 /// a CXXRecordDecl. 1456 ClassTemplateDecl *getDescribedClassTemplate() const; 1457 1458 void setDescribedClassTemplate(ClassTemplateDecl *Template); 1459 1460 /// Determine whether this particular class is a specialization or 1461 /// instantiation of a class template or member class of a class template, 1462 /// and how it was instantiated or specialized. 1463 TemplateSpecializationKind getTemplateSpecializationKind() const; 1464 1465 /// Set the kind of specialization or template instantiation this is. 1466 void setTemplateSpecializationKind(TemplateSpecializationKind TSK); 1467 1468 /// Retrieve the record declaration from which this record could be 1469 /// instantiated. Returns null if this class is not a template instantiation. 1470 const CXXRecordDecl *getTemplateInstantiationPattern() const; 1471 1472 CXXRecordDecl *getTemplateInstantiationPattern() { 1473 return const_cast<CXXRecordDecl *>(const_cast<const CXXRecordDecl *>(this) 1474 ->getTemplateInstantiationPattern()); 1475 } 1476 1477 /// Returns the destructor decl for this class. 1478 CXXDestructorDecl *getDestructor() const; 1479 1480 /// Returns true if the class destructor, or any implicitly invoked 1481 /// destructors are marked noreturn. 1482 bool isAnyDestructorNoReturn() const; 1483 1484 /// If the class is a local class [class.local], returns 1485 /// the enclosing function declaration. 1486 const FunctionDecl *isLocalClass() const { 1487 if (const auto *RD = dyn_cast<CXXRecordDecl>(getDeclContext())) 1488 return RD->isLocalClass(); 1489 1490 return dyn_cast<FunctionDecl>(getDeclContext()); 1491 } 1492 1493 FunctionDecl *isLocalClass() { 1494 return const_cast<FunctionDecl*>( 1495 const_cast<const CXXRecordDecl*>(this)->isLocalClass()); 1496 } 1497 1498 /// Determine whether this dependent class is a current instantiation, 1499 /// when viewed from within the given context. 1500 bool isCurrentInstantiation(const DeclContext *CurContext) const; 1501 1502 /// Determine whether this class is derived from the class \p Base. 1503 /// 1504 /// This routine only determines whether this class is derived from \p Base, 1505 /// but does not account for factors that may make a Derived -> Base class 1506 /// ill-formed, such as private/protected inheritance or multiple, ambiguous 1507 /// base class subobjects. 1508 /// 1509 /// \param Base the base class we are searching for. 1510 /// 1511 /// \returns true if this class is derived from Base, false otherwise. 1512 bool isDerivedFrom(const CXXRecordDecl *Base) const; 1513 1514 /// Determine whether this class is derived from the type \p Base. 1515 /// 1516 /// This routine only determines whether this class is derived from \p Base, 1517 /// but does not account for factors that may make a Derived -> Base class 1518 /// ill-formed, such as private/protected inheritance or multiple, ambiguous 1519 /// base class subobjects. 1520 /// 1521 /// \param Base the base class we are searching for. 1522 /// 1523 /// \param Paths will contain the paths taken from the current class to the 1524 /// given \p Base class. 1525 /// 1526 /// \returns true if this class is derived from \p Base, false otherwise. 1527 /// 1528 /// \todo add a separate parameter to configure IsDerivedFrom, rather than 1529 /// tangling input and output in \p Paths 1530 bool isDerivedFrom(const CXXRecordDecl *Base, CXXBasePaths &Paths) const; 1531 1532 /// Determine whether this class is virtually derived from 1533 /// the class \p Base. 1534 /// 1535 /// This routine only determines whether this class is virtually 1536 /// derived from \p Base, but does not account for factors that may 1537 /// make a Derived -> Base class ill-formed, such as 1538 /// private/protected inheritance or multiple, ambiguous base class 1539 /// subobjects. 1540 /// 1541 /// \param Base the base class we are searching for. 1542 /// 1543 /// \returns true if this class is virtually derived from Base, 1544 /// false otherwise. 1545 bool isVirtuallyDerivedFrom(const CXXRecordDecl *Base) const; 1546 1547 /// Determine whether this class is provably not derived from 1548 /// the type \p Base. 1549 bool isProvablyNotDerivedFrom(const CXXRecordDecl *Base) const; 1550 1551 /// Function type used by forallBases() as a callback. 1552 /// 1553 /// \param BaseDefinition the definition of the base class 1554 /// 1555 /// \returns true if this base matched the search criteria 1556 using ForallBasesCallback = 1557 llvm::function_ref<bool(const CXXRecordDecl *BaseDefinition)>; 1558 1559 /// Determines if the given callback holds for all the direct 1560 /// or indirect base classes of this type. 1561 /// 1562 /// The class itself does not count as a base class. This routine 1563 /// returns false if the class has non-computable base classes. 1564 /// 1565 /// \param BaseMatches Callback invoked for each (direct or indirect) base 1566 /// class of this type until a call returns false. 1567 bool forallBases(ForallBasesCallback BaseMatches) const; 1568 1569 /// Function type used by lookupInBases() to determine whether a 1570 /// specific base class subobject matches the lookup criteria. 1571 /// 1572 /// \param Specifier the base-class specifier that describes the inheritance 1573 /// from the base class we are trying to match. 1574 /// 1575 /// \param Path the current path, from the most-derived class down to the 1576 /// base named by the \p Specifier. 1577 /// 1578 /// \returns true if this base matched the search criteria, false otherwise. 1579 using BaseMatchesCallback = 1580 llvm::function_ref<bool(const CXXBaseSpecifier *Specifier, 1581 CXXBasePath &Path)>; 1582 1583 /// Look for entities within the base classes of this C++ class, 1584 /// transitively searching all base class subobjects. 1585 /// 1586 /// This routine uses the callback function \p BaseMatches to find base 1587 /// classes meeting some search criteria, walking all base class subobjects 1588 /// and populating the given \p Paths structure with the paths through the 1589 /// inheritance hierarchy that resulted in a match. On a successful search, 1590 /// the \p Paths structure can be queried to retrieve the matching paths and 1591 /// to determine if there were any ambiguities. 1592 /// 1593 /// \param BaseMatches callback function used to determine whether a given 1594 /// base matches the user-defined search criteria. 1595 /// 1596 /// \param Paths used to record the paths from this class to its base class 1597 /// subobjects that match the search criteria. 1598 /// 1599 /// \param LookupInDependent can be set to true to extend the search to 1600 /// dependent base classes. 1601 /// 1602 /// \returns true if there exists any path from this class to a base class 1603 /// subobject that matches the search criteria. 1604 bool lookupInBases(BaseMatchesCallback BaseMatches, CXXBasePaths &Paths, 1605 bool LookupInDependent = false) const; 1606 1607 /// Base-class lookup callback that determines whether the given 1608 /// base class specifier refers to a specific class declaration. 1609 /// 1610 /// This callback can be used with \c lookupInBases() to determine whether 1611 /// a given derived class has is a base class subobject of a particular type. 1612 /// The base record pointer should refer to the canonical CXXRecordDecl of the 1613 /// base class that we are searching for. 1614 static bool FindBaseClass(const CXXBaseSpecifier *Specifier, 1615 CXXBasePath &Path, const CXXRecordDecl *BaseRecord); 1616 1617 /// Base-class lookup callback that determines whether the 1618 /// given base class specifier refers to a specific class 1619 /// declaration and describes virtual derivation. 1620 /// 1621 /// This callback can be used with \c lookupInBases() to determine 1622 /// whether a given derived class has is a virtual base class 1623 /// subobject of a particular type. The base record pointer should 1624 /// refer to the canonical CXXRecordDecl of the base class that we 1625 /// are searching for. 1626 static bool FindVirtualBaseClass(const CXXBaseSpecifier *Specifier, 1627 CXXBasePath &Path, 1628 const CXXRecordDecl *BaseRecord); 1629 1630 /// Retrieve the final overriders for each virtual member 1631 /// function in the class hierarchy where this class is the 1632 /// most-derived class in the class hierarchy. 1633 void getFinalOverriders(CXXFinalOverriderMap &FinaOverriders) const; 1634 1635 /// Get the indirect primary bases for this class. 1636 void getIndirectPrimaryBases(CXXIndirectPrimaryBaseSet& Bases) const; 1637 1638 /// Determine whether this class has a member with the given name, possibly 1639 /// in a non-dependent base class. 1640 /// 1641 /// No check for ambiguity is performed, so this should never be used when 1642 /// implementing language semantics, but it may be appropriate for warnings, 1643 /// static analysis, or similar. 1644 bool hasMemberName(DeclarationName N) const; 1645 1646 /// Performs an imprecise lookup of a dependent name in this class. 1647 /// 1648 /// This function does not follow strict semantic rules and should be used 1649 /// only when lookup rules can be relaxed, e.g. indexing. 1650 std::vector<const NamedDecl *> 1651 lookupDependentName(DeclarationName Name, 1652 llvm::function_ref<bool(const NamedDecl *ND)> Filter); 1653 1654 /// Renders and displays an inheritance diagram 1655 /// for this C++ class and all of its base classes (transitively) using 1656 /// GraphViz. 1657 void viewInheritance(ASTContext& Context) const; 1658 1659 /// Calculates the access of a decl that is reached 1660 /// along a path. 1661 static AccessSpecifier MergeAccess(AccessSpecifier PathAccess, 1662 AccessSpecifier DeclAccess) { 1663 assert(DeclAccess != AS_none); 1664 if (DeclAccess == AS_private) return AS_none; 1665 return (PathAccess > DeclAccess ? PathAccess : DeclAccess); 1666 } 1667 1668 /// Indicates that the declaration of a defaulted or deleted special 1669 /// member function is now complete. 1670 void finishedDefaultedOrDeletedMember(CXXMethodDecl *MD); 1671 1672 void setTrivialForCallFlags(CXXMethodDecl *MD); 1673 1674 /// Indicates that the definition of this class is now complete. 1675 void completeDefinition() override; 1676 1677 /// Indicates that the definition of this class is now complete, 1678 /// and provides a final overrider map to help determine 1679 /// 1680 /// \param FinalOverriders The final overrider map for this class, which can 1681 /// be provided as an optimization for abstract-class checking. If NULL, 1682 /// final overriders will be computed if they are needed to complete the 1683 /// definition. 1684 void completeDefinition(CXXFinalOverriderMap *FinalOverriders); 1685 1686 /// Determine whether this class may end up being abstract, even though 1687 /// it is not yet known to be abstract. 1688 /// 1689 /// \returns true if this class is not known to be abstract but has any 1690 /// base classes that are abstract. In this case, \c completeDefinition() 1691 /// will need to compute final overriders to determine whether the class is 1692 /// actually abstract. 1693 bool mayBeAbstract() const; 1694 1695 /// Determine whether it's impossible for a class to be derived from this 1696 /// class. This is best-effort, and may conservatively return false. 1697 bool isEffectivelyFinal() const; 1698 1699 /// If this is the closure type of a lambda expression, retrieve the 1700 /// number to be used for name mangling in the Itanium C++ ABI. 1701 /// 1702 /// Zero indicates that this closure type has internal linkage, so the 1703 /// mangling number does not matter, while a non-zero value indicates which 1704 /// lambda expression this is in this particular context. 1705 unsigned getLambdaManglingNumber() const { 1706 assert(isLambda() && "Not a lambda closure type!"); 1707 return getLambdaData().ManglingNumber; 1708 } 1709 1710 /// The lambda is known to has internal linkage no matter whether it has name 1711 /// mangling number. 1712 bool hasKnownLambdaInternalLinkage() const { 1713 assert(isLambda() && "Not a lambda closure type!"); 1714 return getLambdaData().HasKnownInternalLinkage; 1715 } 1716 1717 /// Retrieve the declaration that provides additional context for a 1718 /// lambda, when the normal declaration context is not specific enough. 1719 /// 1720 /// Certain contexts (default arguments of in-class function parameters and 1721 /// the initializers of data members) have separate name mangling rules for 1722 /// lambdas within the Itanium C++ ABI. For these cases, this routine provides 1723 /// the declaration in which the lambda occurs, e.g., the function parameter 1724 /// or the non-static data member. Otherwise, it returns NULL to imply that 1725 /// the declaration context suffices. 1726 Decl *getLambdaContextDecl() const; 1727 1728 /// Set the mangling number and context declaration for a lambda 1729 /// class. 1730 void setLambdaMangling(unsigned ManglingNumber, Decl *ContextDecl, 1731 bool HasKnownInternalLinkage = false) { 1732 assert(isLambda() && "Not a lambda closure type!"); 1733 getLambdaData().ManglingNumber = ManglingNumber; 1734 getLambdaData().ContextDecl = ContextDecl; 1735 getLambdaData().HasKnownInternalLinkage = HasKnownInternalLinkage; 1736 } 1737 1738 /// Set the device side mangling number. 1739 void setDeviceLambdaManglingNumber(unsigned Num) const; 1740 1741 /// Retrieve the device side mangling number. 1742 unsigned getDeviceLambdaManglingNumber() const; 1743 1744 /// Returns the inheritance model used for this record. 1745 MSInheritanceModel getMSInheritanceModel() const; 1746 1747 /// Calculate what the inheritance model would be for this class. 1748 MSInheritanceModel calculateInheritanceModel() const; 1749 1750 /// In the Microsoft C++ ABI, use zero for the field offset of a null data 1751 /// member pointer if we can guarantee that zero is not a valid field offset, 1752 /// or if the member pointer has multiple fields. Polymorphic classes have a 1753 /// vfptr at offset zero, so we can use zero for null. If there are multiple 1754 /// fields, we can use zero even if it is a valid field offset because 1755 /// null-ness testing will check the other fields. 1756 bool nullFieldOffsetIsZero() const; 1757 1758 /// Controls when vtordisps will be emitted if this record is used as a 1759 /// virtual base. 1760 MSVtorDispMode getMSVtorDispMode() const; 1761 1762 /// Determine whether this lambda expression was known to be dependent 1763 /// at the time it was created, even if its context does not appear to be 1764 /// dependent. 1765 /// 1766 /// This flag is a workaround for an issue with parsing, where default 1767 /// arguments are parsed before their enclosing function declarations have 1768 /// been created. This means that any lambda expressions within those 1769 /// default arguments will have as their DeclContext the context enclosing 1770 /// the function declaration, which may be non-dependent even when the 1771 /// function declaration itself is dependent. This flag indicates when we 1772 /// know that the lambda is dependent despite that. 1773 bool isDependentLambda() const { 1774 return isLambda() && getLambdaData().Dependent; 1775 } 1776 1777 TypeSourceInfo *getLambdaTypeInfo() const { 1778 return getLambdaData().MethodTyInfo; 1779 } 1780 1781 // Determine whether this type is an Interface Like type for 1782 // __interface inheritance purposes. 1783 bool isInterfaceLike() const; 1784 1785 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1786 static bool classofKind(Kind K) { 1787 return K >= firstCXXRecord && K <= lastCXXRecord; 1788 } 1789 }; 1790 1791 /// Store information needed for an explicit specifier. 1792 /// Used by CXXDeductionGuideDecl, CXXConstructorDecl and CXXConversionDecl. 1793 class ExplicitSpecifier { 1794 llvm::PointerIntPair<Expr *, 2, ExplicitSpecKind> ExplicitSpec{ 1795 nullptr, ExplicitSpecKind::ResolvedFalse}; 1796 1797 public: 1798 ExplicitSpecifier() = default; 1799 ExplicitSpecifier(Expr *Expression, ExplicitSpecKind Kind) 1800 : ExplicitSpec(Expression, Kind) {} 1801 ExplicitSpecKind getKind() const { return ExplicitSpec.getInt(); } 1802 const Expr *getExpr() const { return ExplicitSpec.getPointer(); } 1803 Expr *getExpr() { return ExplicitSpec.getPointer(); } 1804 1805 /// Determine if the declaration had an explicit specifier of any kind. 1806 bool isSpecified() const { 1807 return ExplicitSpec.getInt() != ExplicitSpecKind::ResolvedFalse || 1808 ExplicitSpec.getPointer(); 1809 } 1810 1811 /// Check for equivalence of explicit specifiers. 1812 /// \return true if the explicit specifier are equivalent, false otherwise. 1813 bool isEquivalent(const ExplicitSpecifier Other) const; 1814 /// Determine whether this specifier is known to correspond to an explicit 1815 /// declaration. Returns false if the specifier is absent or has an 1816 /// expression that is value-dependent or evaluates to false. 1817 bool isExplicit() const { 1818 return ExplicitSpec.getInt() == ExplicitSpecKind::ResolvedTrue; 1819 } 1820 /// Determine if the explicit specifier is invalid. 1821 /// This state occurs after a substitution failures. 1822 bool isInvalid() const { 1823 return ExplicitSpec.getInt() == ExplicitSpecKind::Unresolved && 1824 !ExplicitSpec.getPointer(); 1825 } 1826 void setKind(ExplicitSpecKind Kind) { ExplicitSpec.setInt(Kind); } 1827 void setExpr(Expr *E) { ExplicitSpec.setPointer(E); } 1828 // Retrieve the explicit specifier in the given declaration, if any. 1829 static ExplicitSpecifier getFromDecl(FunctionDecl *Function); 1830 static const ExplicitSpecifier getFromDecl(const FunctionDecl *Function) { 1831 return getFromDecl(const_cast<FunctionDecl *>(Function)); 1832 } 1833 static ExplicitSpecifier Invalid() { 1834 return ExplicitSpecifier(nullptr, ExplicitSpecKind::Unresolved); 1835 } 1836 }; 1837 1838 /// Represents a C++ deduction guide declaration. 1839 /// 1840 /// \code 1841 /// template<typename T> struct A { A(); A(T); }; 1842 /// A() -> A<int>; 1843 /// \endcode 1844 /// 1845 /// In this example, there will be an explicit deduction guide from the 1846 /// second line, and implicit deduction guide templates synthesized from 1847 /// the constructors of \c A. 1848 class CXXDeductionGuideDecl : public FunctionDecl { 1849 void anchor() override; 1850 1851 private: 1852 CXXDeductionGuideDecl(ASTContext &C, DeclContext *DC, SourceLocation StartLoc, 1853 ExplicitSpecifier ES, 1854 const DeclarationNameInfo &NameInfo, QualType T, 1855 TypeSourceInfo *TInfo, SourceLocation EndLocation) 1856 : FunctionDecl(CXXDeductionGuide, C, DC, StartLoc, NameInfo, T, TInfo, 1857 SC_None, false, ConstexprSpecKind::Unspecified), 1858 ExplicitSpec(ES) { 1859 if (EndLocation.isValid()) 1860 setRangeEnd(EndLocation); 1861 setIsCopyDeductionCandidate(false); 1862 } 1863 1864 ExplicitSpecifier ExplicitSpec; 1865 void setExplicitSpecifier(ExplicitSpecifier ES) { ExplicitSpec = ES; } 1866 1867 public: 1868 friend class ASTDeclReader; 1869 friend class ASTDeclWriter; 1870 1871 static CXXDeductionGuideDecl * 1872 Create(ASTContext &C, DeclContext *DC, SourceLocation StartLoc, 1873 ExplicitSpecifier ES, const DeclarationNameInfo &NameInfo, QualType T, 1874 TypeSourceInfo *TInfo, SourceLocation EndLocation); 1875 1876 static CXXDeductionGuideDecl *CreateDeserialized(ASTContext &C, unsigned ID); 1877 1878 ExplicitSpecifier getExplicitSpecifier() { return ExplicitSpec; } 1879 const ExplicitSpecifier getExplicitSpecifier() const { return ExplicitSpec; } 1880 1881 /// Return true if the declartion is already resolved to be explicit. 1882 bool isExplicit() const { return ExplicitSpec.isExplicit(); } 1883 1884 /// Get the template for which this guide performs deduction. 1885 TemplateDecl *getDeducedTemplate() const { 1886 return getDeclName().getCXXDeductionGuideTemplate(); 1887 } 1888 1889 void setIsCopyDeductionCandidate(bool isCDC = true) { 1890 FunctionDeclBits.IsCopyDeductionCandidate = isCDC; 1891 } 1892 1893 bool isCopyDeductionCandidate() const { 1894 return FunctionDeclBits.IsCopyDeductionCandidate; 1895 } 1896 1897 // Implement isa/cast/dyncast/etc. 1898 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1899 static bool classofKind(Kind K) { return K == CXXDeductionGuide; } 1900 }; 1901 1902 /// \brief Represents the body of a requires-expression. 1903 /// 1904 /// This decl exists merely to serve as the DeclContext for the local 1905 /// parameters of the requires expression as well as other declarations inside 1906 /// it. 1907 /// 1908 /// \code 1909 /// template<typename T> requires requires (T t) { {t++} -> regular; } 1910 /// \endcode 1911 /// 1912 /// In this example, a RequiresExpr object will be generated for the expression, 1913 /// and a RequiresExprBodyDecl will be created to hold the parameter t and the 1914 /// template argument list imposed by the compound requirement. 1915 class RequiresExprBodyDecl : public Decl, public DeclContext { 1916 RequiresExprBodyDecl(ASTContext &C, DeclContext *DC, SourceLocation StartLoc) 1917 : Decl(RequiresExprBody, DC, StartLoc), DeclContext(RequiresExprBody) {} 1918 1919 public: 1920 friend class ASTDeclReader; 1921 friend class ASTDeclWriter; 1922 1923 static RequiresExprBodyDecl *Create(ASTContext &C, DeclContext *DC, 1924 SourceLocation StartLoc); 1925 1926 static RequiresExprBodyDecl *CreateDeserialized(ASTContext &C, unsigned ID); 1927 1928 // Implement isa/cast/dyncast/etc. 1929 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 1930 static bool classofKind(Kind K) { return K == RequiresExprBody; } 1931 }; 1932 1933 /// Represents a static or instance method of a struct/union/class. 1934 /// 1935 /// In the terminology of the C++ Standard, these are the (static and 1936 /// non-static) member functions, whether virtual or not. 1937 class CXXMethodDecl : public FunctionDecl { 1938 void anchor() override; 1939 1940 protected: 1941 CXXMethodDecl(Kind DK, ASTContext &C, CXXRecordDecl *RD, 1942 SourceLocation StartLoc, const DeclarationNameInfo &NameInfo, 1943 QualType T, TypeSourceInfo *TInfo, StorageClass SC, 1944 bool isInline, ConstexprSpecKind ConstexprKind, 1945 SourceLocation EndLocation, 1946 Expr *TrailingRequiresClause = nullptr) 1947 : FunctionDecl(DK, C, RD, StartLoc, NameInfo, T, TInfo, SC, isInline, 1948 ConstexprKind, TrailingRequiresClause) { 1949 if (EndLocation.isValid()) 1950 setRangeEnd(EndLocation); 1951 } 1952 1953 public: 1954 static CXXMethodDecl *Create(ASTContext &C, CXXRecordDecl *RD, 1955 SourceLocation StartLoc, 1956 const DeclarationNameInfo &NameInfo, QualType T, 1957 TypeSourceInfo *TInfo, StorageClass SC, 1958 bool isInline, ConstexprSpecKind ConstexprKind, 1959 SourceLocation EndLocation, 1960 Expr *TrailingRequiresClause = nullptr); 1961 1962 static CXXMethodDecl *CreateDeserialized(ASTContext &C, unsigned ID); 1963 1964 bool isStatic() const; 1965 bool isInstance() const { return !isStatic(); } 1966 1967 /// Returns true if the given operator is implicitly static in a record 1968 /// context. 1969 static bool isStaticOverloadedOperator(OverloadedOperatorKind OOK) { 1970 // [class.free]p1: 1971 // Any allocation function for a class T is a static member 1972 // (even if not explicitly declared static). 1973 // [class.free]p6 Any deallocation function for a class X is a static member 1974 // (even if not explicitly declared static). 1975 return OOK == OO_New || OOK == OO_Array_New || OOK == OO_Delete || 1976 OOK == OO_Array_Delete; 1977 } 1978 1979 bool isConst() const { return getType()->castAs<FunctionType>()->isConst(); } 1980 bool isVolatile() const { return getType()->castAs<FunctionType>()->isVolatile(); } 1981 1982 bool isVirtual() const { 1983 CXXMethodDecl *CD = const_cast<CXXMethodDecl*>(this)->getCanonicalDecl(); 1984 1985 // Member function is virtual if it is marked explicitly so, or if it is 1986 // declared in __interface -- then it is automatically pure virtual. 1987 if (CD->isVirtualAsWritten() || CD->isPure()) 1988 return true; 1989 1990 return CD->size_overridden_methods() != 0; 1991 } 1992 1993 /// If it's possible to devirtualize a call to this method, return the called 1994 /// function. Otherwise, return null. 1995 1996 /// \param Base The object on which this virtual function is called. 1997 /// \param IsAppleKext True if we are compiling for Apple kext. 1998 CXXMethodDecl *getDevirtualizedMethod(const Expr *Base, bool IsAppleKext); 1999 2000 const CXXMethodDecl *getDevirtualizedMethod(const Expr *Base, 2001 bool IsAppleKext) const { 2002 return const_cast<CXXMethodDecl *>(this)->getDevirtualizedMethod( 2003 Base, IsAppleKext); 2004 } 2005 2006 /// Determine whether this is a usual deallocation function (C++ 2007 /// [basic.stc.dynamic.deallocation]p2), which is an overloaded delete or 2008 /// delete[] operator with a particular signature. Populates \p PreventedBy 2009 /// with the declarations of the functions of the same kind if they were the 2010 /// reason for this function returning false. This is used by 2011 /// Sema::isUsualDeallocationFunction to reconsider the answer based on the 2012 /// context. 2013 bool isUsualDeallocationFunction( 2014 SmallVectorImpl<const FunctionDecl *> &PreventedBy) const; 2015 2016 /// Determine whether this is a copy-assignment operator, regardless 2017 /// of whether it was declared implicitly or explicitly. 2018 bool isCopyAssignmentOperator() const; 2019 2020 /// Determine whether this is a move assignment operator. 2021 bool isMoveAssignmentOperator() const; 2022 2023 CXXMethodDecl *getCanonicalDecl() override { 2024 return cast<CXXMethodDecl>(FunctionDecl::getCanonicalDecl()); 2025 } 2026 const CXXMethodDecl *getCanonicalDecl() const { 2027 return const_cast<CXXMethodDecl*>(this)->getCanonicalDecl(); 2028 } 2029 2030 CXXMethodDecl *getMostRecentDecl() { 2031 return cast<CXXMethodDecl>( 2032 static_cast<FunctionDecl *>(this)->getMostRecentDecl()); 2033 } 2034 const CXXMethodDecl *getMostRecentDecl() const { 2035 return const_cast<CXXMethodDecl*>(this)->getMostRecentDecl(); 2036 } 2037 2038 void addOverriddenMethod(const CXXMethodDecl *MD); 2039 2040 using method_iterator = const CXXMethodDecl *const *; 2041 2042 method_iterator begin_overridden_methods() const; 2043 method_iterator end_overridden_methods() const; 2044 unsigned size_overridden_methods() const; 2045 2046 using overridden_method_range = llvm::iterator_range< 2047 llvm::TinyPtrVector<const CXXMethodDecl *>::const_iterator>; 2048 2049 overridden_method_range overridden_methods() const; 2050 2051 /// Return the parent of this method declaration, which 2052 /// is the class in which this method is defined. 2053 const CXXRecordDecl *getParent() const { 2054 return cast<CXXRecordDecl>(FunctionDecl::getParent()); 2055 } 2056 2057 /// Return the parent of this method declaration, which 2058 /// is the class in which this method is defined. 2059 CXXRecordDecl *getParent() { 2060 return const_cast<CXXRecordDecl *>( 2061 cast<CXXRecordDecl>(FunctionDecl::getParent())); 2062 } 2063 2064 /// Return the type of the \c this pointer. 2065 /// 2066 /// Should only be called for instance (i.e., non-static) methods. Note 2067 /// that for the call operator of a lambda closure type, this returns the 2068 /// desugared 'this' type (a pointer to the closure type), not the captured 2069 /// 'this' type. 2070 QualType getThisType() const; 2071 2072 /// Return the type of the object pointed by \c this. 2073 /// 2074 /// See getThisType() for usage restriction. 2075 QualType getThisObjectType() const; 2076 2077 static QualType getThisType(const FunctionProtoType *FPT, 2078 const CXXRecordDecl *Decl); 2079 2080 static QualType getThisObjectType(const FunctionProtoType *FPT, 2081 const CXXRecordDecl *Decl); 2082 2083 Qualifiers getMethodQualifiers() const { 2084 return getType()->castAs<FunctionProtoType>()->getMethodQuals(); 2085 } 2086 2087 /// Retrieve the ref-qualifier associated with this method. 2088 /// 2089 /// In the following example, \c f() has an lvalue ref-qualifier, \c g() 2090 /// has an rvalue ref-qualifier, and \c h() has no ref-qualifier. 2091 /// @code 2092 /// struct X { 2093 /// void f() &; 2094 /// void g() &&; 2095 /// void h(); 2096 /// }; 2097 /// @endcode 2098 RefQualifierKind getRefQualifier() const { 2099 return getType()->castAs<FunctionProtoType>()->getRefQualifier(); 2100 } 2101 2102 bool hasInlineBody() const; 2103 2104 /// Determine whether this is a lambda closure type's static member 2105 /// function that is used for the result of the lambda's conversion to 2106 /// function pointer (for a lambda with no captures). 2107 /// 2108 /// The function itself, if used, will have a placeholder body that will be 2109 /// supplied by IR generation to either forward to the function call operator 2110 /// or clone the function call operator. 2111 bool isLambdaStaticInvoker() const; 2112 2113 /// Find the method in \p RD that corresponds to this one. 2114 /// 2115 /// Find if \p RD or one of the classes it inherits from override this method. 2116 /// If so, return it. \p RD is assumed to be a subclass of the class defining 2117 /// this method (or be the class itself), unless \p MayBeBase is set to true. 2118 CXXMethodDecl * 2119 getCorrespondingMethodInClass(const CXXRecordDecl *RD, 2120 bool MayBeBase = false); 2121 2122 const CXXMethodDecl * 2123 getCorrespondingMethodInClass(const CXXRecordDecl *RD, 2124 bool MayBeBase = false) const { 2125 return const_cast<CXXMethodDecl *>(this) 2126 ->getCorrespondingMethodInClass(RD, MayBeBase); 2127 } 2128 2129 /// Find if \p RD declares a function that overrides this function, and if so, 2130 /// return it. Does not search base classes. 2131 CXXMethodDecl *getCorrespondingMethodDeclaredInClass(const CXXRecordDecl *RD, 2132 bool MayBeBase = false); 2133 const CXXMethodDecl * 2134 getCorrespondingMethodDeclaredInClass(const CXXRecordDecl *RD, 2135 bool MayBeBase = false) const { 2136 return const_cast<CXXMethodDecl *>(this) 2137 ->getCorrespondingMethodDeclaredInClass(RD, MayBeBase); 2138 } 2139 2140 // Implement isa/cast/dyncast/etc. 2141 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 2142 static bool classofKind(Kind K) { 2143 return K >= firstCXXMethod && K <= lastCXXMethod; 2144 } 2145 }; 2146 2147 /// Represents a C++ base or member initializer. 2148 /// 2149 /// This is part of a constructor initializer that 2150 /// initializes one non-static member variable or one base class. For 2151 /// example, in the following, both 'A(a)' and 'f(3.14159)' are member 2152 /// initializers: 2153 /// 2154 /// \code 2155 /// class A { }; 2156 /// class B : public A { 2157 /// float f; 2158 /// public: 2159 /// B(A& a) : A(a), f(3.14159) { } 2160 /// }; 2161 /// \endcode 2162 class CXXCtorInitializer final { 2163 /// Either the base class name/delegating constructor type (stored as 2164 /// a TypeSourceInfo*), an normal field (FieldDecl), or an anonymous field 2165 /// (IndirectFieldDecl*) being initialized. 2166 llvm::PointerUnion<TypeSourceInfo *, FieldDecl *, IndirectFieldDecl *> 2167 Initializee; 2168 2169 /// The source location for the field name or, for a base initializer 2170 /// pack expansion, the location of the ellipsis. 2171 /// 2172 /// In the case of a delegating 2173 /// constructor, it will still include the type's source location as the 2174 /// Initializee points to the CXXConstructorDecl (to allow loop detection). 2175 SourceLocation MemberOrEllipsisLocation; 2176 2177 /// The argument used to initialize the base or member, which may 2178 /// end up constructing an object (when multiple arguments are involved). 2179 Stmt *Init; 2180 2181 /// Location of the left paren of the ctor-initializer. 2182 SourceLocation LParenLoc; 2183 2184 /// Location of the right paren of the ctor-initializer. 2185 SourceLocation RParenLoc; 2186 2187 /// If the initializee is a type, whether that type makes this 2188 /// a delegating initialization. 2189 unsigned IsDelegating : 1; 2190 2191 /// If the initializer is a base initializer, this keeps track 2192 /// of whether the base is virtual or not. 2193 unsigned IsVirtual : 1; 2194 2195 /// Whether or not the initializer is explicitly written 2196 /// in the sources. 2197 unsigned IsWritten : 1; 2198 2199 /// If IsWritten is true, then this number keeps track of the textual order 2200 /// of this initializer in the original sources, counting from 0. 2201 unsigned SourceOrder : 13; 2202 2203 public: 2204 /// Creates a new base-class initializer. 2205 explicit 2206 CXXCtorInitializer(ASTContext &Context, TypeSourceInfo *TInfo, bool IsVirtual, 2207 SourceLocation L, Expr *Init, SourceLocation R, 2208 SourceLocation EllipsisLoc); 2209 2210 /// Creates a new member initializer. 2211 explicit 2212 CXXCtorInitializer(ASTContext &Context, FieldDecl *Member, 2213 SourceLocation MemberLoc, SourceLocation L, Expr *Init, 2214 SourceLocation R); 2215 2216 /// Creates a new anonymous field initializer. 2217 explicit 2218 CXXCtorInitializer(ASTContext &Context, IndirectFieldDecl *Member, 2219 SourceLocation MemberLoc, SourceLocation L, Expr *Init, 2220 SourceLocation R); 2221 2222 /// Creates a new delegating initializer. 2223 explicit 2224 CXXCtorInitializer(ASTContext &Context, TypeSourceInfo *TInfo, 2225 SourceLocation L, Expr *Init, SourceLocation R); 2226 2227 /// \return Unique reproducible object identifier. 2228 int64_t getID(const ASTContext &Context) const; 2229 2230 /// Determine whether this initializer is initializing a base class. 2231 bool isBaseInitializer() const { 2232 return Initializee.is<TypeSourceInfo*>() && !IsDelegating; 2233 } 2234 2235 /// Determine whether this initializer is initializing a non-static 2236 /// data member. 2237 bool isMemberInitializer() const { return Initializee.is<FieldDecl*>(); } 2238 2239 bool isAnyMemberInitializer() const { 2240 return isMemberInitializer() || isIndirectMemberInitializer(); 2241 } 2242 2243 bool isIndirectMemberInitializer() const { 2244 return Initializee.is<IndirectFieldDecl*>(); 2245 } 2246 2247 /// Determine whether this initializer is an implicit initializer 2248 /// generated for a field with an initializer defined on the member 2249 /// declaration. 2250 /// 2251 /// In-class member initializers (also known as "non-static data member 2252 /// initializations", NSDMIs) were introduced in C++11. 2253 bool isInClassMemberInitializer() const { 2254 return Init->getStmtClass() == Stmt::CXXDefaultInitExprClass; 2255 } 2256 2257 /// Determine whether this initializer is creating a delegating 2258 /// constructor. 2259 bool isDelegatingInitializer() const { 2260 return Initializee.is<TypeSourceInfo*>() && IsDelegating; 2261 } 2262 2263 /// Determine whether this initializer is a pack expansion. 2264 bool isPackExpansion() const { 2265 return isBaseInitializer() && MemberOrEllipsisLocation.isValid(); 2266 } 2267 2268 // For a pack expansion, returns the location of the ellipsis. 2269 SourceLocation getEllipsisLoc() const { 2270 assert(isPackExpansion() && "Initializer is not a pack expansion"); 2271 return MemberOrEllipsisLocation; 2272 } 2273 2274 /// If this is a base class initializer, returns the type of the 2275 /// base class with location information. Otherwise, returns an NULL 2276 /// type location. 2277 TypeLoc getBaseClassLoc() const; 2278 2279 /// If this is a base class initializer, returns the type of the base class. 2280 /// Otherwise, returns null. 2281 const Type *getBaseClass() const; 2282 2283 /// Returns whether the base is virtual or not. 2284 bool isBaseVirtual() const { 2285 assert(isBaseInitializer() && "Must call this on base initializer!"); 2286 2287 return IsVirtual; 2288 } 2289 2290 /// Returns the declarator information for a base class or delegating 2291 /// initializer. 2292 TypeSourceInfo *getTypeSourceInfo() const { 2293 return Initializee.dyn_cast<TypeSourceInfo *>(); 2294 } 2295 2296 /// If this is a member initializer, returns the declaration of the 2297 /// non-static data member being initialized. Otherwise, returns null. 2298 FieldDecl *getMember() const { 2299 if (isMemberInitializer()) 2300 return Initializee.get<FieldDecl*>(); 2301 return nullptr; 2302 } 2303 2304 FieldDecl *getAnyMember() const { 2305 if (isMemberInitializer()) 2306 return Initializee.get<FieldDecl*>(); 2307 if (isIndirectMemberInitializer()) 2308 return Initializee.get<IndirectFieldDecl*>()->getAnonField(); 2309 return nullptr; 2310 } 2311 2312 IndirectFieldDecl *getIndirectMember() const { 2313 if (isIndirectMemberInitializer()) 2314 return Initializee.get<IndirectFieldDecl*>(); 2315 return nullptr; 2316 } 2317 2318 SourceLocation getMemberLocation() const { 2319 return MemberOrEllipsisLocation; 2320 } 2321 2322 /// Determine the source location of the initializer. 2323 SourceLocation getSourceLocation() const; 2324 2325 /// Determine the source range covering the entire initializer. 2326 SourceRange getSourceRange() const LLVM_READONLY; 2327 2328 /// Determine whether this initializer is explicitly written 2329 /// in the source code. 2330 bool isWritten() const { return IsWritten; } 2331 2332 /// Return the source position of the initializer, counting from 0. 2333 /// If the initializer was implicit, -1 is returned. 2334 int getSourceOrder() const { 2335 return IsWritten ? static_cast<int>(SourceOrder) : -1; 2336 } 2337 2338 /// Set the source order of this initializer. 2339 /// 2340 /// This can only be called once for each initializer; it cannot be called 2341 /// on an initializer having a positive number of (implicit) array indices. 2342 /// 2343 /// This assumes that the initializer was written in the source code, and 2344 /// ensures that isWritten() returns true. 2345 void setSourceOrder(int Pos) { 2346 assert(!IsWritten && 2347 "setSourceOrder() used on implicit initializer"); 2348 assert(SourceOrder == 0 && 2349 "calling twice setSourceOrder() on the same initializer"); 2350 assert(Pos >= 0 && 2351 "setSourceOrder() used to make an initializer implicit"); 2352 IsWritten = true; 2353 SourceOrder = static_cast<unsigned>(Pos); 2354 } 2355 2356 SourceLocation getLParenLoc() const { return LParenLoc; } 2357 SourceLocation getRParenLoc() const { return RParenLoc; } 2358 2359 /// Get the initializer. 2360 Expr *getInit() const { return static_cast<Expr *>(Init); } 2361 }; 2362 2363 /// Description of a constructor that was inherited from a base class. 2364 class InheritedConstructor { 2365 ConstructorUsingShadowDecl *Shadow = nullptr; 2366 CXXConstructorDecl *BaseCtor = nullptr; 2367 2368 public: 2369 InheritedConstructor() = default; 2370 InheritedConstructor(ConstructorUsingShadowDecl *Shadow, 2371 CXXConstructorDecl *BaseCtor) 2372 : Shadow(Shadow), BaseCtor(BaseCtor) {} 2373 2374 explicit operator bool() const { return Shadow; } 2375 2376 ConstructorUsingShadowDecl *getShadowDecl() const { return Shadow; } 2377 CXXConstructorDecl *getConstructor() const { return BaseCtor; } 2378 }; 2379 2380 /// Represents a C++ constructor within a class. 2381 /// 2382 /// For example: 2383 /// 2384 /// \code 2385 /// class X { 2386 /// public: 2387 /// explicit X(int); // represented by a CXXConstructorDecl. 2388 /// }; 2389 /// \endcode 2390 class CXXConstructorDecl final 2391 : public CXXMethodDecl, 2392 private llvm::TrailingObjects<CXXConstructorDecl, InheritedConstructor, 2393 ExplicitSpecifier> { 2394 // This class stores some data in DeclContext::CXXConstructorDeclBits 2395 // to save some space. Use the provided accessors to access it. 2396 2397 /// \name Support for base and member initializers. 2398 /// \{ 2399 /// The arguments used to initialize the base or member. 2400 LazyCXXCtorInitializersPtr CtorInitializers; 2401 2402 CXXConstructorDecl(ASTContext &C, CXXRecordDecl *RD, SourceLocation StartLoc, 2403 const DeclarationNameInfo &NameInfo, QualType T, 2404 TypeSourceInfo *TInfo, ExplicitSpecifier ES, bool isInline, 2405 bool isImplicitlyDeclared, ConstexprSpecKind ConstexprKind, 2406 InheritedConstructor Inherited, 2407 Expr *TrailingRequiresClause); 2408 2409 void anchor() override; 2410 2411 size_t numTrailingObjects(OverloadToken<InheritedConstructor>) const { 2412 return CXXConstructorDeclBits.IsInheritingConstructor; 2413 } 2414 size_t numTrailingObjects(OverloadToken<ExplicitSpecifier>) const { 2415 return CXXConstructorDeclBits.HasTrailingExplicitSpecifier; 2416 } 2417 2418 ExplicitSpecifier getExplicitSpecifierInternal() const { 2419 if (CXXConstructorDeclBits.HasTrailingExplicitSpecifier) 2420 return *getTrailingObjects<ExplicitSpecifier>(); 2421 return ExplicitSpecifier( 2422 nullptr, CXXConstructorDeclBits.IsSimpleExplicit 2423 ? ExplicitSpecKind::ResolvedTrue 2424 : ExplicitSpecKind::ResolvedFalse); 2425 } 2426 2427 enum TraillingAllocKind { 2428 TAKInheritsConstructor = 1, 2429 TAKHasTailExplicit = 1 << 1, 2430 }; 2431 2432 uint64_t getTraillingAllocKind() const { 2433 return numTrailingObjects(OverloadToken<InheritedConstructor>()) | 2434 (numTrailingObjects(OverloadToken<ExplicitSpecifier>()) << 1); 2435 } 2436 2437 public: 2438 friend class ASTDeclReader; 2439 friend class ASTDeclWriter; 2440 friend TrailingObjects; 2441 2442 static CXXConstructorDecl *CreateDeserialized(ASTContext &C, unsigned ID, 2443 uint64_t AllocKind); 2444 static CXXConstructorDecl * 2445 Create(ASTContext &C, CXXRecordDecl *RD, SourceLocation StartLoc, 2446 const DeclarationNameInfo &NameInfo, QualType T, TypeSourceInfo *TInfo, 2447 ExplicitSpecifier ES, bool isInline, bool isImplicitlyDeclared, 2448 ConstexprSpecKind ConstexprKind, 2449 InheritedConstructor Inherited = InheritedConstructor(), 2450 Expr *TrailingRequiresClause = nullptr); 2451 2452 void setExplicitSpecifier(ExplicitSpecifier ES) { 2453 assert((!ES.getExpr() || 2454 CXXConstructorDeclBits.HasTrailingExplicitSpecifier) && 2455 "cannot set this explicit specifier. no trail-allocated space for " 2456 "explicit"); 2457 if (ES.getExpr()) 2458 *getCanonicalDecl()->getTrailingObjects<ExplicitSpecifier>() = ES; 2459 else 2460 CXXConstructorDeclBits.IsSimpleExplicit = ES.isExplicit(); 2461 } 2462 2463 ExplicitSpecifier getExplicitSpecifier() { 2464 return getCanonicalDecl()->getExplicitSpecifierInternal(); 2465 } 2466 const ExplicitSpecifier getExplicitSpecifier() const { 2467 return getCanonicalDecl()->getExplicitSpecifierInternal(); 2468 } 2469 2470 /// Return true if the declartion is already resolved to be explicit. 2471 bool isExplicit() const { return getExplicitSpecifier().isExplicit(); } 2472 2473 /// Iterates through the member/base initializer list. 2474 using init_iterator = CXXCtorInitializer **; 2475 2476 /// Iterates through the member/base initializer list. 2477 using init_const_iterator = CXXCtorInitializer *const *; 2478 2479 using init_range = llvm::iterator_range<init_iterator>; 2480 using init_const_range = llvm::iterator_range<init_const_iterator>; 2481 2482 init_range inits() { return init_range(init_begin(), init_end()); } 2483 init_const_range inits() const { 2484 return init_const_range(init_begin(), init_end()); 2485 } 2486 2487 /// Retrieve an iterator to the first initializer. 2488 init_iterator init_begin() { 2489 const auto *ConstThis = this; 2490 return const_cast<init_iterator>(ConstThis->init_begin()); 2491 } 2492 2493 /// Retrieve an iterator to the first initializer. 2494 init_const_iterator init_begin() const; 2495 2496 /// Retrieve an iterator past the last initializer. 2497 init_iterator init_end() { 2498 return init_begin() + getNumCtorInitializers(); 2499 } 2500 2501 /// Retrieve an iterator past the last initializer. 2502 init_const_iterator init_end() const { 2503 return init_begin() + getNumCtorInitializers(); 2504 } 2505 2506 using init_reverse_iterator = std::reverse_iterator<init_iterator>; 2507 using init_const_reverse_iterator = 2508 std::reverse_iterator<init_const_iterator>; 2509 2510 init_reverse_iterator init_rbegin() { 2511 return init_reverse_iterator(init_end()); 2512 } 2513 init_const_reverse_iterator init_rbegin() const { 2514 return init_const_reverse_iterator(init_end()); 2515 } 2516 2517 init_reverse_iterator init_rend() { 2518 return init_reverse_iterator(init_begin()); 2519 } 2520 init_const_reverse_iterator init_rend() const { 2521 return init_const_reverse_iterator(init_begin()); 2522 } 2523 2524 /// Determine the number of arguments used to initialize the member 2525 /// or base. 2526 unsigned getNumCtorInitializers() const { 2527 return CXXConstructorDeclBits.NumCtorInitializers; 2528 } 2529 2530 void setNumCtorInitializers(unsigned numCtorInitializers) { 2531 CXXConstructorDeclBits.NumCtorInitializers = numCtorInitializers; 2532 // This assert added because NumCtorInitializers is stored 2533 // in CXXConstructorDeclBits as a bitfield and its width has 2534 // been shrunk from 32 bits to fit into CXXConstructorDeclBitfields. 2535 assert(CXXConstructorDeclBits.NumCtorInitializers == 2536 numCtorInitializers && "NumCtorInitializers overflow!"); 2537 } 2538 2539 void setCtorInitializers(CXXCtorInitializer **Initializers) { 2540 CtorInitializers = Initializers; 2541 } 2542 2543 /// Determine whether this constructor is a delegating constructor. 2544 bool isDelegatingConstructor() const { 2545 return (getNumCtorInitializers() == 1) && 2546 init_begin()[0]->isDelegatingInitializer(); 2547 } 2548 2549 /// When this constructor delegates to another, retrieve the target. 2550 CXXConstructorDecl *getTargetConstructor() const; 2551 2552 /// Whether this constructor is a default 2553 /// constructor (C++ [class.ctor]p5), which can be used to 2554 /// default-initialize a class of this type. 2555 bool isDefaultConstructor() const; 2556 2557 /// Whether this constructor is a copy constructor (C++ [class.copy]p2, 2558 /// which can be used to copy the class. 2559 /// 2560 /// \p TypeQuals will be set to the qualifiers on the 2561 /// argument type. For example, \p TypeQuals would be set to \c 2562 /// Qualifiers::Const for the following copy constructor: 2563 /// 2564 /// \code 2565 /// class X { 2566 /// public: 2567 /// X(const X&); 2568 /// }; 2569 /// \endcode 2570 bool isCopyConstructor(unsigned &TypeQuals) const; 2571 2572 /// Whether this constructor is a copy 2573 /// constructor (C++ [class.copy]p2, which can be used to copy the 2574 /// class. 2575 bool isCopyConstructor() const { 2576 unsigned TypeQuals = 0; 2577 return isCopyConstructor(TypeQuals); 2578 } 2579 2580 /// Determine whether this constructor is a move constructor 2581 /// (C++11 [class.copy]p3), which can be used to move values of the class. 2582 /// 2583 /// \param TypeQuals If this constructor is a move constructor, will be set 2584 /// to the type qualifiers on the referent of the first parameter's type. 2585 bool isMoveConstructor(unsigned &TypeQuals) const; 2586 2587 /// Determine whether this constructor is a move constructor 2588 /// (C++11 [class.copy]p3), which can be used to move values of the class. 2589 bool isMoveConstructor() const { 2590 unsigned TypeQuals = 0; 2591 return isMoveConstructor(TypeQuals); 2592 } 2593 2594 /// Determine whether this is a copy or move constructor. 2595 /// 2596 /// \param TypeQuals Will be set to the type qualifiers on the reference 2597 /// parameter, if in fact this is a copy or move constructor. 2598 bool isCopyOrMoveConstructor(unsigned &TypeQuals) const; 2599 2600 /// Determine whether this a copy or move constructor. 2601 bool isCopyOrMoveConstructor() const { 2602 unsigned Quals; 2603 return isCopyOrMoveConstructor(Quals); 2604 } 2605 2606 /// Whether this constructor is a 2607 /// converting constructor (C++ [class.conv.ctor]), which can be 2608 /// used for user-defined conversions. 2609 bool isConvertingConstructor(bool AllowExplicit) const; 2610 2611 /// Determine whether this is a member template specialization that 2612 /// would copy the object to itself. Such constructors are never used to copy 2613 /// an object. 2614 bool isSpecializationCopyingObject() const; 2615 2616 /// Determine whether this is an implicit constructor synthesized to 2617 /// model a call to a constructor inherited from a base class. 2618 bool isInheritingConstructor() const { 2619 return CXXConstructorDeclBits.IsInheritingConstructor; 2620 } 2621 2622 /// State that this is an implicit constructor synthesized to 2623 /// model a call to a constructor inherited from a base class. 2624 void setInheritingConstructor(bool isIC = true) { 2625 CXXConstructorDeclBits.IsInheritingConstructor = isIC; 2626 } 2627 2628 /// Get the constructor that this inheriting constructor is based on. 2629 InheritedConstructor getInheritedConstructor() const { 2630 return isInheritingConstructor() ? 2631 *getTrailingObjects<InheritedConstructor>() : InheritedConstructor(); 2632 } 2633 2634 CXXConstructorDecl *getCanonicalDecl() override { 2635 return cast<CXXConstructorDecl>(FunctionDecl::getCanonicalDecl()); 2636 } 2637 const CXXConstructorDecl *getCanonicalDecl() const { 2638 return const_cast<CXXConstructorDecl*>(this)->getCanonicalDecl(); 2639 } 2640 2641 // Implement isa/cast/dyncast/etc. 2642 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 2643 static bool classofKind(Kind K) { return K == CXXConstructor; } 2644 }; 2645 2646 /// Represents a C++ destructor within a class. 2647 /// 2648 /// For example: 2649 /// 2650 /// \code 2651 /// class X { 2652 /// public: 2653 /// ~X(); // represented by a CXXDestructorDecl. 2654 /// }; 2655 /// \endcode 2656 class CXXDestructorDecl : public CXXMethodDecl { 2657 friend class ASTDeclReader; 2658 friend class ASTDeclWriter; 2659 2660 // FIXME: Don't allocate storage for these except in the first declaration 2661 // of a virtual destructor. 2662 FunctionDecl *OperatorDelete = nullptr; 2663 Expr *OperatorDeleteThisArg = nullptr; 2664 2665 CXXDestructorDecl(ASTContext &C, CXXRecordDecl *RD, SourceLocation StartLoc, 2666 const DeclarationNameInfo &NameInfo, QualType T, 2667 TypeSourceInfo *TInfo, bool isInline, 2668 bool isImplicitlyDeclared, ConstexprSpecKind ConstexprKind, 2669 Expr *TrailingRequiresClause = nullptr) 2670 : CXXMethodDecl(CXXDestructor, C, RD, StartLoc, NameInfo, T, TInfo, 2671 SC_None, isInline, ConstexprKind, SourceLocation(), 2672 TrailingRequiresClause) { 2673 setImplicit(isImplicitlyDeclared); 2674 } 2675 2676 void anchor() override; 2677 2678 public: 2679 static CXXDestructorDecl *Create(ASTContext &C, CXXRecordDecl *RD, 2680 SourceLocation StartLoc, 2681 const DeclarationNameInfo &NameInfo, 2682 QualType T, TypeSourceInfo *TInfo, 2683 bool isInline, bool isImplicitlyDeclared, 2684 ConstexprSpecKind ConstexprKind, 2685 Expr *TrailingRequiresClause = nullptr); 2686 static CXXDestructorDecl *CreateDeserialized(ASTContext & C, unsigned ID); 2687 2688 void setOperatorDelete(FunctionDecl *OD, Expr *ThisArg); 2689 2690 const FunctionDecl *getOperatorDelete() const { 2691 return getCanonicalDecl()->OperatorDelete; 2692 } 2693 2694 Expr *getOperatorDeleteThisArg() const { 2695 return getCanonicalDecl()->OperatorDeleteThisArg; 2696 } 2697 2698 CXXDestructorDecl *getCanonicalDecl() override { 2699 return cast<CXXDestructorDecl>(FunctionDecl::getCanonicalDecl()); 2700 } 2701 const CXXDestructorDecl *getCanonicalDecl() const { 2702 return const_cast<CXXDestructorDecl*>(this)->getCanonicalDecl(); 2703 } 2704 2705 // Implement isa/cast/dyncast/etc. 2706 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 2707 static bool classofKind(Kind K) { return K == CXXDestructor; } 2708 }; 2709 2710 /// Represents a C++ conversion function within a class. 2711 /// 2712 /// For example: 2713 /// 2714 /// \code 2715 /// class X { 2716 /// public: 2717 /// operator bool(); 2718 /// }; 2719 /// \endcode 2720 class CXXConversionDecl : public CXXMethodDecl { 2721 CXXConversionDecl(ASTContext &C, CXXRecordDecl *RD, SourceLocation StartLoc, 2722 const DeclarationNameInfo &NameInfo, QualType T, 2723 TypeSourceInfo *TInfo, bool isInline, ExplicitSpecifier ES, 2724 ConstexprSpecKind ConstexprKind, SourceLocation EndLocation, 2725 Expr *TrailingRequiresClause = nullptr) 2726 : CXXMethodDecl(CXXConversion, C, RD, StartLoc, NameInfo, T, TInfo, 2727 SC_None, isInline, ConstexprKind, EndLocation, 2728 TrailingRequiresClause), 2729 ExplicitSpec(ES) {} 2730 void anchor() override; 2731 2732 ExplicitSpecifier ExplicitSpec; 2733 2734 public: 2735 friend class ASTDeclReader; 2736 friend class ASTDeclWriter; 2737 2738 static CXXConversionDecl * 2739 Create(ASTContext &C, CXXRecordDecl *RD, SourceLocation StartLoc, 2740 const DeclarationNameInfo &NameInfo, QualType T, TypeSourceInfo *TInfo, 2741 bool isInline, ExplicitSpecifier ES, ConstexprSpecKind ConstexprKind, 2742 SourceLocation EndLocation, Expr *TrailingRequiresClause = nullptr); 2743 static CXXConversionDecl *CreateDeserialized(ASTContext &C, unsigned ID); 2744 2745 ExplicitSpecifier getExplicitSpecifier() { 2746 return getCanonicalDecl()->ExplicitSpec; 2747 } 2748 2749 const ExplicitSpecifier getExplicitSpecifier() const { 2750 return getCanonicalDecl()->ExplicitSpec; 2751 } 2752 2753 /// Return true if the declartion is already resolved to be explicit. 2754 bool isExplicit() const { return getExplicitSpecifier().isExplicit(); } 2755 void setExplicitSpecifier(ExplicitSpecifier ES) { ExplicitSpec = ES; } 2756 2757 /// Returns the type that this conversion function is converting to. 2758 QualType getConversionType() const { 2759 return getType()->castAs<FunctionType>()->getReturnType(); 2760 } 2761 2762 /// Determine whether this conversion function is a conversion from 2763 /// a lambda closure type to a block pointer. 2764 bool isLambdaToBlockPointerConversion() const; 2765 2766 CXXConversionDecl *getCanonicalDecl() override { 2767 return cast<CXXConversionDecl>(FunctionDecl::getCanonicalDecl()); 2768 } 2769 const CXXConversionDecl *getCanonicalDecl() const { 2770 return const_cast<CXXConversionDecl*>(this)->getCanonicalDecl(); 2771 } 2772 2773 // Implement isa/cast/dyncast/etc. 2774 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 2775 static bool classofKind(Kind K) { return K == CXXConversion; } 2776 }; 2777 2778 /// Represents a linkage specification. 2779 /// 2780 /// For example: 2781 /// \code 2782 /// extern "C" void foo(); 2783 /// \endcode 2784 class LinkageSpecDecl : public Decl, public DeclContext { 2785 virtual void anchor(); 2786 // This class stores some data in DeclContext::LinkageSpecDeclBits to save 2787 // some space. Use the provided accessors to access it. 2788 public: 2789 /// Represents the language in a linkage specification. 2790 /// 2791 /// The values are part of the serialization ABI for 2792 /// ASTs and cannot be changed without altering that ABI. 2793 enum LanguageIDs { lang_c = 1, lang_cxx = 2 }; 2794 2795 private: 2796 /// The source location for the extern keyword. 2797 SourceLocation ExternLoc; 2798 2799 /// The source location for the right brace (if valid). 2800 SourceLocation RBraceLoc; 2801 2802 LinkageSpecDecl(DeclContext *DC, SourceLocation ExternLoc, 2803 SourceLocation LangLoc, LanguageIDs lang, bool HasBraces); 2804 2805 public: 2806 static LinkageSpecDecl *Create(ASTContext &C, DeclContext *DC, 2807 SourceLocation ExternLoc, 2808 SourceLocation LangLoc, LanguageIDs Lang, 2809 bool HasBraces); 2810 static LinkageSpecDecl *CreateDeserialized(ASTContext &C, unsigned ID); 2811 2812 /// Return the language specified by this linkage specification. 2813 LanguageIDs getLanguage() const { 2814 return static_cast<LanguageIDs>(LinkageSpecDeclBits.Language); 2815 } 2816 2817 /// Set the language specified by this linkage specification. 2818 void setLanguage(LanguageIDs L) { LinkageSpecDeclBits.Language = L; } 2819 2820 /// Determines whether this linkage specification had braces in 2821 /// its syntactic form. 2822 bool hasBraces() const { 2823 assert(!RBraceLoc.isValid() || LinkageSpecDeclBits.HasBraces); 2824 return LinkageSpecDeclBits.HasBraces; 2825 } 2826 2827 SourceLocation getExternLoc() const { return ExternLoc; } 2828 SourceLocation getRBraceLoc() const { return RBraceLoc; } 2829 void setExternLoc(SourceLocation L) { ExternLoc = L; } 2830 void setRBraceLoc(SourceLocation L) { 2831 RBraceLoc = L; 2832 LinkageSpecDeclBits.HasBraces = RBraceLoc.isValid(); 2833 } 2834 2835 SourceLocation getEndLoc() const LLVM_READONLY { 2836 if (hasBraces()) 2837 return getRBraceLoc(); 2838 // No braces: get the end location of the (only) declaration in context 2839 // (if present). 2840 return decls_empty() ? getLocation() : decls_begin()->getEndLoc(); 2841 } 2842 2843 SourceRange getSourceRange() const override LLVM_READONLY { 2844 return SourceRange(ExternLoc, getEndLoc()); 2845 } 2846 2847 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 2848 static bool classofKind(Kind K) { return K == LinkageSpec; } 2849 2850 static DeclContext *castToDeclContext(const LinkageSpecDecl *D) { 2851 return static_cast<DeclContext *>(const_cast<LinkageSpecDecl*>(D)); 2852 } 2853 2854 static LinkageSpecDecl *castFromDeclContext(const DeclContext *DC) { 2855 return static_cast<LinkageSpecDecl *>(const_cast<DeclContext*>(DC)); 2856 } 2857 }; 2858 2859 /// Represents C++ using-directive. 2860 /// 2861 /// For example: 2862 /// \code 2863 /// using namespace std; 2864 /// \endcode 2865 /// 2866 /// \note UsingDirectiveDecl should be Decl not NamedDecl, but we provide 2867 /// artificial names for all using-directives in order to store 2868 /// them in DeclContext effectively. 2869 class UsingDirectiveDecl : public NamedDecl { 2870 /// The location of the \c using keyword. 2871 SourceLocation UsingLoc; 2872 2873 /// The location of the \c namespace keyword. 2874 SourceLocation NamespaceLoc; 2875 2876 /// The nested-name-specifier that precedes the namespace. 2877 NestedNameSpecifierLoc QualifierLoc; 2878 2879 /// The namespace nominated by this using-directive. 2880 NamedDecl *NominatedNamespace; 2881 2882 /// Enclosing context containing both using-directive and nominated 2883 /// namespace. 2884 DeclContext *CommonAncestor; 2885 2886 UsingDirectiveDecl(DeclContext *DC, SourceLocation UsingLoc, 2887 SourceLocation NamespcLoc, 2888 NestedNameSpecifierLoc QualifierLoc, 2889 SourceLocation IdentLoc, 2890 NamedDecl *Nominated, 2891 DeclContext *CommonAncestor) 2892 : NamedDecl(UsingDirective, DC, IdentLoc, getName()), UsingLoc(UsingLoc), 2893 NamespaceLoc(NamespcLoc), QualifierLoc(QualifierLoc), 2894 NominatedNamespace(Nominated), CommonAncestor(CommonAncestor) {} 2895 2896 /// Returns special DeclarationName used by using-directives. 2897 /// 2898 /// This is only used by DeclContext for storing UsingDirectiveDecls in 2899 /// its lookup structure. 2900 static DeclarationName getName() { 2901 return DeclarationName::getUsingDirectiveName(); 2902 } 2903 2904 void anchor() override; 2905 2906 public: 2907 friend class ASTDeclReader; 2908 2909 // Friend for getUsingDirectiveName. 2910 friend class DeclContext; 2911 2912 /// Retrieve the nested-name-specifier that qualifies the 2913 /// name of the namespace, with source-location information. 2914 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; } 2915 2916 /// Retrieve the nested-name-specifier that qualifies the 2917 /// name of the namespace. 2918 NestedNameSpecifier *getQualifier() const { 2919 return QualifierLoc.getNestedNameSpecifier(); 2920 } 2921 2922 NamedDecl *getNominatedNamespaceAsWritten() { return NominatedNamespace; } 2923 const NamedDecl *getNominatedNamespaceAsWritten() const { 2924 return NominatedNamespace; 2925 } 2926 2927 /// Returns the namespace nominated by this using-directive. 2928 NamespaceDecl *getNominatedNamespace(); 2929 2930 const NamespaceDecl *getNominatedNamespace() const { 2931 return const_cast<UsingDirectiveDecl*>(this)->getNominatedNamespace(); 2932 } 2933 2934 /// Returns the common ancestor context of this using-directive and 2935 /// its nominated namespace. 2936 DeclContext *getCommonAncestor() { return CommonAncestor; } 2937 const DeclContext *getCommonAncestor() const { return CommonAncestor; } 2938 2939 /// Return the location of the \c using keyword. 2940 SourceLocation getUsingLoc() const { return UsingLoc; } 2941 2942 // FIXME: Could omit 'Key' in name. 2943 /// Returns the location of the \c namespace keyword. 2944 SourceLocation getNamespaceKeyLocation() const { return NamespaceLoc; } 2945 2946 /// Returns the location of this using declaration's identifier. 2947 SourceLocation getIdentLocation() const { return getLocation(); } 2948 2949 static UsingDirectiveDecl *Create(ASTContext &C, DeclContext *DC, 2950 SourceLocation UsingLoc, 2951 SourceLocation NamespaceLoc, 2952 NestedNameSpecifierLoc QualifierLoc, 2953 SourceLocation IdentLoc, 2954 NamedDecl *Nominated, 2955 DeclContext *CommonAncestor); 2956 static UsingDirectiveDecl *CreateDeserialized(ASTContext &C, unsigned ID); 2957 2958 SourceRange getSourceRange() const override LLVM_READONLY { 2959 return SourceRange(UsingLoc, getLocation()); 2960 } 2961 2962 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 2963 static bool classofKind(Kind K) { return K == UsingDirective; } 2964 }; 2965 2966 /// Represents a C++ namespace alias. 2967 /// 2968 /// For example: 2969 /// 2970 /// \code 2971 /// namespace Foo = Bar; 2972 /// \endcode 2973 class NamespaceAliasDecl : public NamedDecl, 2974 public Redeclarable<NamespaceAliasDecl> { 2975 friend class ASTDeclReader; 2976 2977 /// The location of the \c namespace keyword. 2978 SourceLocation NamespaceLoc; 2979 2980 /// The location of the namespace's identifier. 2981 /// 2982 /// This is accessed by TargetNameLoc. 2983 SourceLocation IdentLoc; 2984 2985 /// The nested-name-specifier that precedes the namespace. 2986 NestedNameSpecifierLoc QualifierLoc; 2987 2988 /// The Decl that this alias points to, either a NamespaceDecl or 2989 /// a NamespaceAliasDecl. 2990 NamedDecl *Namespace; 2991 2992 NamespaceAliasDecl(ASTContext &C, DeclContext *DC, 2993 SourceLocation NamespaceLoc, SourceLocation AliasLoc, 2994 IdentifierInfo *Alias, NestedNameSpecifierLoc QualifierLoc, 2995 SourceLocation IdentLoc, NamedDecl *Namespace) 2996 : NamedDecl(NamespaceAlias, DC, AliasLoc, Alias), redeclarable_base(C), 2997 NamespaceLoc(NamespaceLoc), IdentLoc(IdentLoc), 2998 QualifierLoc(QualifierLoc), Namespace(Namespace) {} 2999 3000 void anchor() override; 3001 3002 using redeclarable_base = Redeclarable<NamespaceAliasDecl>; 3003 3004 NamespaceAliasDecl *getNextRedeclarationImpl() override; 3005 NamespaceAliasDecl *getPreviousDeclImpl() override; 3006 NamespaceAliasDecl *getMostRecentDeclImpl() override; 3007 3008 public: 3009 static NamespaceAliasDecl *Create(ASTContext &C, DeclContext *DC, 3010 SourceLocation NamespaceLoc, 3011 SourceLocation AliasLoc, 3012 IdentifierInfo *Alias, 3013 NestedNameSpecifierLoc QualifierLoc, 3014 SourceLocation IdentLoc, 3015 NamedDecl *Namespace); 3016 3017 static NamespaceAliasDecl *CreateDeserialized(ASTContext &C, unsigned ID); 3018 3019 using redecl_range = redeclarable_base::redecl_range; 3020 using redecl_iterator = redeclarable_base::redecl_iterator; 3021 3022 using redeclarable_base::redecls_begin; 3023 using redeclarable_base::redecls_end; 3024 using redeclarable_base::redecls; 3025 using redeclarable_base::getPreviousDecl; 3026 using redeclarable_base::getMostRecentDecl; 3027 3028 NamespaceAliasDecl *getCanonicalDecl() override { 3029 return getFirstDecl(); 3030 } 3031 const NamespaceAliasDecl *getCanonicalDecl() const { 3032 return getFirstDecl(); 3033 } 3034 3035 /// Retrieve the nested-name-specifier that qualifies the 3036 /// name of the namespace, with source-location information. 3037 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; } 3038 3039 /// Retrieve the nested-name-specifier that qualifies the 3040 /// name of the namespace. 3041 NestedNameSpecifier *getQualifier() const { 3042 return QualifierLoc.getNestedNameSpecifier(); 3043 } 3044 3045 /// Retrieve the namespace declaration aliased by this directive. 3046 NamespaceDecl *getNamespace() { 3047 if (auto *AD = dyn_cast<NamespaceAliasDecl>(Namespace)) 3048 return AD->getNamespace(); 3049 3050 return cast<NamespaceDecl>(Namespace); 3051 } 3052 3053 const NamespaceDecl *getNamespace() const { 3054 return const_cast<NamespaceAliasDecl *>(this)->getNamespace(); 3055 } 3056 3057 /// Returns the location of the alias name, i.e. 'foo' in 3058 /// "namespace foo = ns::bar;". 3059 SourceLocation getAliasLoc() const { return getLocation(); } 3060 3061 /// Returns the location of the \c namespace keyword. 3062 SourceLocation getNamespaceLoc() const { return NamespaceLoc; } 3063 3064 /// Returns the location of the identifier in the named namespace. 3065 SourceLocation getTargetNameLoc() const { return IdentLoc; } 3066 3067 /// Retrieve the namespace that this alias refers to, which 3068 /// may either be a NamespaceDecl or a NamespaceAliasDecl. 3069 NamedDecl *getAliasedNamespace() const { return Namespace; } 3070 3071 SourceRange getSourceRange() const override LLVM_READONLY { 3072 return SourceRange(NamespaceLoc, IdentLoc); 3073 } 3074 3075 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 3076 static bool classofKind(Kind K) { return K == NamespaceAlias; } 3077 }; 3078 3079 /// Implicit declaration of a temporary that was materialized by 3080 /// a MaterializeTemporaryExpr and lifetime-extended by a declaration 3081 class LifetimeExtendedTemporaryDecl final 3082 : public Decl, 3083 public Mergeable<LifetimeExtendedTemporaryDecl> { 3084 friend class MaterializeTemporaryExpr; 3085 friend class ASTDeclReader; 3086 3087 Stmt *ExprWithTemporary = nullptr; 3088 3089 /// The declaration which lifetime-extended this reference, if any. 3090 /// Either a VarDecl, or (for a ctor-initializer) a FieldDecl. 3091 ValueDecl *ExtendingDecl = nullptr; 3092 unsigned ManglingNumber; 3093 3094 mutable APValue *Value = nullptr; 3095 3096 virtual void anchor(); 3097 3098 LifetimeExtendedTemporaryDecl(Expr *Temp, ValueDecl *EDecl, unsigned Mangling) 3099 : Decl(Decl::LifetimeExtendedTemporary, EDecl->getDeclContext(), 3100 EDecl->getLocation()), 3101 ExprWithTemporary(Temp), ExtendingDecl(EDecl), 3102 ManglingNumber(Mangling) {} 3103 3104 LifetimeExtendedTemporaryDecl(EmptyShell) 3105 : Decl(Decl::LifetimeExtendedTemporary, EmptyShell{}) {} 3106 3107 public: 3108 static LifetimeExtendedTemporaryDecl *Create(Expr *Temp, ValueDecl *EDec, 3109 unsigned Mangling) { 3110 return new (EDec->getASTContext(), EDec->getDeclContext()) 3111 LifetimeExtendedTemporaryDecl(Temp, EDec, Mangling); 3112 } 3113 static LifetimeExtendedTemporaryDecl *CreateDeserialized(ASTContext &C, 3114 unsigned ID) { 3115 return new (C, ID) LifetimeExtendedTemporaryDecl(EmptyShell{}); 3116 } 3117 3118 ValueDecl *getExtendingDecl() { return ExtendingDecl; } 3119 const ValueDecl *getExtendingDecl() const { return ExtendingDecl; } 3120 3121 /// Retrieve the storage duration for the materialized temporary. 3122 StorageDuration getStorageDuration() const; 3123 3124 /// Retrieve the expression to which the temporary materialization conversion 3125 /// was applied. This isn't necessarily the initializer of the temporary due 3126 /// to the C++98 delayed materialization rules, but 3127 /// skipRValueSubobjectAdjustments can be used to find said initializer within 3128 /// the subexpression. 3129 Expr *getTemporaryExpr() { return cast<Expr>(ExprWithTemporary); } 3130 const Expr *getTemporaryExpr() const { return cast<Expr>(ExprWithTemporary); } 3131 3132 unsigned getManglingNumber() const { return ManglingNumber; } 3133 3134 /// Get the storage for the constant value of a materialized temporary 3135 /// of static storage duration. 3136 APValue *getOrCreateValue(bool MayCreate) const; 3137 3138 APValue *getValue() const { return Value; } 3139 3140 // Iterators 3141 Stmt::child_range childrenExpr() { 3142 return Stmt::child_range(&ExprWithTemporary, &ExprWithTemporary + 1); 3143 } 3144 3145 Stmt::const_child_range childrenExpr() const { 3146 return Stmt::const_child_range(&ExprWithTemporary, &ExprWithTemporary + 1); 3147 } 3148 3149 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 3150 static bool classofKind(Kind K) { 3151 return K == Decl::LifetimeExtendedTemporary; 3152 } 3153 }; 3154 3155 /// Represents a shadow declaration introduced into a scope by a 3156 /// (resolved) using declaration. 3157 /// 3158 /// For example, 3159 /// \code 3160 /// namespace A { 3161 /// void foo(); 3162 /// } 3163 /// namespace B { 3164 /// using A::foo; // <- a UsingDecl 3165 /// // Also creates a UsingShadowDecl for A::foo() in B 3166 /// } 3167 /// \endcode 3168 class UsingShadowDecl : public NamedDecl, public Redeclarable<UsingShadowDecl> { 3169 friend class UsingDecl; 3170 3171 /// The referenced declaration. 3172 NamedDecl *Underlying = nullptr; 3173 3174 /// The using declaration which introduced this decl or the next using 3175 /// shadow declaration contained in the aforementioned using declaration. 3176 NamedDecl *UsingOrNextShadow = nullptr; 3177 3178 void anchor() override; 3179 3180 using redeclarable_base = Redeclarable<UsingShadowDecl>; 3181 3182 UsingShadowDecl *getNextRedeclarationImpl() override { 3183 return getNextRedeclaration(); 3184 } 3185 3186 UsingShadowDecl *getPreviousDeclImpl() override { 3187 return getPreviousDecl(); 3188 } 3189 3190 UsingShadowDecl *getMostRecentDeclImpl() override { 3191 return getMostRecentDecl(); 3192 } 3193 3194 protected: 3195 UsingShadowDecl(Kind K, ASTContext &C, DeclContext *DC, SourceLocation Loc, 3196 UsingDecl *Using, NamedDecl *Target); 3197 UsingShadowDecl(Kind K, ASTContext &C, EmptyShell); 3198 3199 public: 3200 friend class ASTDeclReader; 3201 friend class ASTDeclWriter; 3202 3203 static UsingShadowDecl *Create(ASTContext &C, DeclContext *DC, 3204 SourceLocation Loc, UsingDecl *Using, 3205 NamedDecl *Target) { 3206 return new (C, DC) UsingShadowDecl(UsingShadow, C, DC, Loc, Using, Target); 3207 } 3208 3209 static UsingShadowDecl *CreateDeserialized(ASTContext &C, unsigned ID); 3210 3211 using redecl_range = redeclarable_base::redecl_range; 3212 using redecl_iterator = redeclarable_base::redecl_iterator; 3213 3214 using redeclarable_base::redecls_begin; 3215 using redeclarable_base::redecls_end; 3216 using redeclarable_base::redecls; 3217 using redeclarable_base::getPreviousDecl; 3218 using redeclarable_base::getMostRecentDecl; 3219 using redeclarable_base::isFirstDecl; 3220 3221 UsingShadowDecl *getCanonicalDecl() override { 3222 return getFirstDecl(); 3223 } 3224 const UsingShadowDecl *getCanonicalDecl() const { 3225 return getFirstDecl(); 3226 } 3227 3228 /// Gets the underlying declaration which has been brought into the 3229 /// local scope. 3230 NamedDecl *getTargetDecl() const { return Underlying; } 3231 3232 /// Sets the underlying declaration which has been brought into the 3233 /// local scope. 3234 void setTargetDecl(NamedDecl *ND) { 3235 assert(ND && "Target decl is null!"); 3236 Underlying = ND; 3237 // A UsingShadowDecl is never a friend or local extern declaration, even 3238 // if it is a shadow declaration for one. 3239 IdentifierNamespace = 3240 ND->getIdentifierNamespace() & 3241 ~(IDNS_OrdinaryFriend | IDNS_TagFriend | IDNS_LocalExtern); 3242 } 3243 3244 /// Gets the using declaration to which this declaration is tied. 3245 UsingDecl *getUsingDecl() const; 3246 3247 /// The next using shadow declaration contained in the shadow decl 3248 /// chain of the using declaration which introduced this decl. 3249 UsingShadowDecl *getNextUsingShadowDecl() const { 3250 return dyn_cast_or_null<UsingShadowDecl>(UsingOrNextShadow); 3251 } 3252 3253 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 3254 static bool classofKind(Kind K) { 3255 return K == Decl::UsingShadow || K == Decl::ConstructorUsingShadow; 3256 } 3257 }; 3258 3259 /// Represents a shadow constructor declaration introduced into a 3260 /// class by a C++11 using-declaration that names a constructor. 3261 /// 3262 /// For example: 3263 /// \code 3264 /// struct Base { Base(int); }; 3265 /// struct Derived { 3266 /// using Base::Base; // creates a UsingDecl and a ConstructorUsingShadowDecl 3267 /// }; 3268 /// \endcode 3269 class ConstructorUsingShadowDecl final : public UsingShadowDecl { 3270 /// If this constructor using declaration inherted the constructor 3271 /// from an indirect base class, this is the ConstructorUsingShadowDecl 3272 /// in the named direct base class from which the declaration was inherited. 3273 ConstructorUsingShadowDecl *NominatedBaseClassShadowDecl = nullptr; 3274 3275 /// If this constructor using declaration inherted the constructor 3276 /// from an indirect base class, this is the ConstructorUsingShadowDecl 3277 /// that will be used to construct the unique direct or virtual base class 3278 /// that receives the constructor arguments. 3279 ConstructorUsingShadowDecl *ConstructedBaseClassShadowDecl = nullptr; 3280 3281 /// \c true if the constructor ultimately named by this using shadow 3282 /// declaration is within a virtual base class subobject of the class that 3283 /// contains this declaration. 3284 unsigned IsVirtual : 1; 3285 3286 ConstructorUsingShadowDecl(ASTContext &C, DeclContext *DC, SourceLocation Loc, 3287 UsingDecl *Using, NamedDecl *Target, 3288 bool TargetInVirtualBase) 3289 : UsingShadowDecl(ConstructorUsingShadow, C, DC, Loc, Using, 3290 Target->getUnderlyingDecl()), 3291 NominatedBaseClassShadowDecl( 3292 dyn_cast<ConstructorUsingShadowDecl>(Target)), 3293 ConstructedBaseClassShadowDecl(NominatedBaseClassShadowDecl), 3294 IsVirtual(TargetInVirtualBase) { 3295 // If we found a constructor that chains to a constructor for a virtual 3296 // base, we should directly call that virtual base constructor instead. 3297 // FIXME: This logic belongs in Sema. 3298 if (NominatedBaseClassShadowDecl && 3299 NominatedBaseClassShadowDecl->constructsVirtualBase()) { 3300 ConstructedBaseClassShadowDecl = 3301 NominatedBaseClassShadowDecl->ConstructedBaseClassShadowDecl; 3302 IsVirtual = true; 3303 } 3304 } 3305 3306 ConstructorUsingShadowDecl(ASTContext &C, EmptyShell Empty) 3307 : UsingShadowDecl(ConstructorUsingShadow, C, Empty), IsVirtual(false) {} 3308 3309 void anchor() override; 3310 3311 public: 3312 friend class ASTDeclReader; 3313 friend class ASTDeclWriter; 3314 3315 static ConstructorUsingShadowDecl *Create(ASTContext &C, DeclContext *DC, 3316 SourceLocation Loc, 3317 UsingDecl *Using, NamedDecl *Target, 3318 bool IsVirtual); 3319 static ConstructorUsingShadowDecl *CreateDeserialized(ASTContext &C, 3320 unsigned ID); 3321 3322 /// Returns the parent of this using shadow declaration, which 3323 /// is the class in which this is declared. 3324 //@{ 3325 const CXXRecordDecl *getParent() const { 3326 return cast<CXXRecordDecl>(getDeclContext()); 3327 } 3328 CXXRecordDecl *getParent() { 3329 return cast<CXXRecordDecl>(getDeclContext()); 3330 } 3331 //@} 3332 3333 /// Get the inheriting constructor declaration for the direct base 3334 /// class from which this using shadow declaration was inherited, if there is 3335 /// one. This can be different for each redeclaration of the same shadow decl. 3336 ConstructorUsingShadowDecl *getNominatedBaseClassShadowDecl() const { 3337 return NominatedBaseClassShadowDecl; 3338 } 3339 3340 /// Get the inheriting constructor declaration for the base class 3341 /// for which we don't have an explicit initializer, if there is one. 3342 ConstructorUsingShadowDecl *getConstructedBaseClassShadowDecl() const { 3343 return ConstructedBaseClassShadowDecl; 3344 } 3345 3346 /// Get the base class that was named in the using declaration. This 3347 /// can be different for each redeclaration of this same shadow decl. 3348 CXXRecordDecl *getNominatedBaseClass() const; 3349 3350 /// Get the base class whose constructor or constructor shadow 3351 /// declaration is passed the constructor arguments. 3352 CXXRecordDecl *getConstructedBaseClass() const { 3353 return cast<CXXRecordDecl>((ConstructedBaseClassShadowDecl 3354 ? ConstructedBaseClassShadowDecl 3355 : getTargetDecl()) 3356 ->getDeclContext()); 3357 } 3358 3359 /// Returns \c true if the constructed base class is a virtual base 3360 /// class subobject of this declaration's class. 3361 bool constructsVirtualBase() const { 3362 return IsVirtual; 3363 } 3364 3365 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 3366 static bool classofKind(Kind K) { return K == ConstructorUsingShadow; } 3367 }; 3368 3369 /// Represents a C++ using-declaration. 3370 /// 3371 /// For example: 3372 /// \code 3373 /// using someNameSpace::someIdentifier; 3374 /// \endcode 3375 class UsingDecl : public NamedDecl, public Mergeable<UsingDecl> { 3376 /// The source location of the 'using' keyword itself. 3377 SourceLocation UsingLocation; 3378 3379 /// The nested-name-specifier that precedes the name. 3380 NestedNameSpecifierLoc QualifierLoc; 3381 3382 /// Provides source/type location info for the declaration name 3383 /// embedded in the ValueDecl base class. 3384 DeclarationNameLoc DNLoc; 3385 3386 /// The first shadow declaration of the shadow decl chain associated 3387 /// with this using declaration. 3388 /// 3389 /// The bool member of the pair store whether this decl has the \c typename 3390 /// keyword. 3391 llvm::PointerIntPair<UsingShadowDecl *, 1, bool> FirstUsingShadow; 3392 3393 UsingDecl(DeclContext *DC, SourceLocation UL, 3394 NestedNameSpecifierLoc QualifierLoc, 3395 const DeclarationNameInfo &NameInfo, bool HasTypenameKeyword) 3396 : NamedDecl(Using, DC, NameInfo.getLoc(), NameInfo.getName()), 3397 UsingLocation(UL), QualifierLoc(QualifierLoc), 3398 DNLoc(NameInfo.getInfo()), FirstUsingShadow(nullptr, HasTypenameKeyword) { 3399 } 3400 3401 void anchor() override; 3402 3403 public: 3404 friend class ASTDeclReader; 3405 friend class ASTDeclWriter; 3406 3407 /// Return the source location of the 'using' keyword. 3408 SourceLocation getUsingLoc() const { return UsingLocation; } 3409 3410 /// Set the source location of the 'using' keyword. 3411 void setUsingLoc(SourceLocation L) { UsingLocation = L; } 3412 3413 /// Retrieve the nested-name-specifier that qualifies the name, 3414 /// with source-location information. 3415 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; } 3416 3417 /// Retrieve the nested-name-specifier that qualifies the name. 3418 NestedNameSpecifier *getQualifier() const { 3419 return QualifierLoc.getNestedNameSpecifier(); 3420 } 3421 3422 DeclarationNameInfo getNameInfo() const { 3423 return DeclarationNameInfo(getDeclName(), getLocation(), DNLoc); 3424 } 3425 3426 /// Return true if it is a C++03 access declaration (no 'using'). 3427 bool isAccessDeclaration() const { return UsingLocation.isInvalid(); } 3428 3429 /// Return true if the using declaration has 'typename'. 3430 bool hasTypename() const { return FirstUsingShadow.getInt(); } 3431 3432 /// Sets whether the using declaration has 'typename'. 3433 void setTypename(bool TN) { FirstUsingShadow.setInt(TN); } 3434 3435 /// Iterates through the using shadow declarations associated with 3436 /// this using declaration. 3437 class shadow_iterator { 3438 /// The current using shadow declaration. 3439 UsingShadowDecl *Current = nullptr; 3440 3441 public: 3442 using value_type = UsingShadowDecl *; 3443 using reference = UsingShadowDecl *; 3444 using pointer = UsingShadowDecl *; 3445 using iterator_category = std::forward_iterator_tag; 3446 using difference_type = std::ptrdiff_t; 3447 3448 shadow_iterator() = default; 3449 explicit shadow_iterator(UsingShadowDecl *C) : Current(C) {} 3450 3451 reference operator*() const { return Current; } 3452 pointer operator->() const { return Current; } 3453 3454 shadow_iterator& operator++() { 3455 Current = Current->getNextUsingShadowDecl(); 3456 return *this; 3457 } 3458 3459 shadow_iterator operator++(int) { 3460 shadow_iterator tmp(*this); 3461 ++(*this); 3462 return tmp; 3463 } 3464 3465 friend bool operator==(shadow_iterator x, shadow_iterator y) { 3466 return x.Current == y.Current; 3467 } 3468 friend bool operator!=(shadow_iterator x, shadow_iterator y) { 3469 return x.Current != y.Current; 3470 } 3471 }; 3472 3473 using shadow_range = llvm::iterator_range<shadow_iterator>; 3474 3475 shadow_range shadows() const { 3476 return shadow_range(shadow_begin(), shadow_end()); 3477 } 3478 3479 shadow_iterator shadow_begin() const { 3480 return shadow_iterator(FirstUsingShadow.getPointer()); 3481 } 3482 3483 shadow_iterator shadow_end() const { return shadow_iterator(); } 3484 3485 /// Return the number of shadowed declarations associated with this 3486 /// using declaration. 3487 unsigned shadow_size() const { 3488 return std::distance(shadow_begin(), shadow_end()); 3489 } 3490 3491 void addShadowDecl(UsingShadowDecl *S); 3492 void removeShadowDecl(UsingShadowDecl *S); 3493 3494 static UsingDecl *Create(ASTContext &C, DeclContext *DC, 3495 SourceLocation UsingL, 3496 NestedNameSpecifierLoc QualifierLoc, 3497 const DeclarationNameInfo &NameInfo, 3498 bool HasTypenameKeyword); 3499 3500 static UsingDecl *CreateDeserialized(ASTContext &C, unsigned ID); 3501 3502 SourceRange getSourceRange() const override LLVM_READONLY; 3503 3504 /// Retrieves the canonical declaration of this declaration. 3505 UsingDecl *getCanonicalDecl() override { return getFirstDecl(); } 3506 const UsingDecl *getCanonicalDecl() const { return getFirstDecl(); } 3507 3508 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 3509 static bool classofKind(Kind K) { return K == Using; } 3510 }; 3511 3512 /// Represents a pack of using declarations that a single 3513 /// using-declarator pack-expanded into. 3514 /// 3515 /// \code 3516 /// template<typename ...T> struct X : T... { 3517 /// using T::operator()...; 3518 /// using T::operator T...; 3519 /// }; 3520 /// \endcode 3521 /// 3522 /// In the second case above, the UsingPackDecl will have the name 3523 /// 'operator T' (which contains an unexpanded pack), but the individual 3524 /// UsingDecls and UsingShadowDecls will have more reasonable names. 3525 class UsingPackDecl final 3526 : public NamedDecl, public Mergeable<UsingPackDecl>, 3527 private llvm::TrailingObjects<UsingPackDecl, NamedDecl *> { 3528 /// The UnresolvedUsingValueDecl or UnresolvedUsingTypenameDecl from 3529 /// which this waas instantiated. 3530 NamedDecl *InstantiatedFrom; 3531 3532 /// The number of using-declarations created by this pack expansion. 3533 unsigned NumExpansions; 3534 3535 UsingPackDecl(DeclContext *DC, NamedDecl *InstantiatedFrom, 3536 ArrayRef<NamedDecl *> UsingDecls) 3537 : NamedDecl(UsingPack, DC, 3538 InstantiatedFrom ? InstantiatedFrom->getLocation() 3539 : SourceLocation(), 3540 InstantiatedFrom ? InstantiatedFrom->getDeclName() 3541 : DeclarationName()), 3542 InstantiatedFrom(InstantiatedFrom), NumExpansions(UsingDecls.size()) { 3543 std::uninitialized_copy(UsingDecls.begin(), UsingDecls.end(), 3544 getTrailingObjects<NamedDecl *>()); 3545 } 3546 3547 void anchor() override; 3548 3549 public: 3550 friend class ASTDeclReader; 3551 friend class ASTDeclWriter; 3552 friend TrailingObjects; 3553 3554 /// Get the using declaration from which this was instantiated. This will 3555 /// always be an UnresolvedUsingValueDecl or an UnresolvedUsingTypenameDecl 3556 /// that is a pack expansion. 3557 NamedDecl *getInstantiatedFromUsingDecl() const { return InstantiatedFrom; } 3558 3559 /// Get the set of using declarations that this pack expanded into. Note that 3560 /// some of these may still be unresolved. 3561 ArrayRef<NamedDecl *> expansions() const { 3562 return llvm::makeArrayRef(getTrailingObjects<NamedDecl *>(), NumExpansions); 3563 } 3564 3565 static UsingPackDecl *Create(ASTContext &C, DeclContext *DC, 3566 NamedDecl *InstantiatedFrom, 3567 ArrayRef<NamedDecl *> UsingDecls); 3568 3569 static UsingPackDecl *CreateDeserialized(ASTContext &C, unsigned ID, 3570 unsigned NumExpansions); 3571 3572 SourceRange getSourceRange() const override LLVM_READONLY { 3573 return InstantiatedFrom->getSourceRange(); 3574 } 3575 3576 UsingPackDecl *getCanonicalDecl() override { return getFirstDecl(); } 3577 const UsingPackDecl *getCanonicalDecl() const { return getFirstDecl(); } 3578 3579 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 3580 static bool classofKind(Kind K) { return K == UsingPack; } 3581 }; 3582 3583 /// Represents a dependent using declaration which was not marked with 3584 /// \c typename. 3585 /// 3586 /// Unlike non-dependent using declarations, these *only* bring through 3587 /// non-types; otherwise they would break two-phase lookup. 3588 /// 3589 /// \code 3590 /// template \<class T> class A : public Base<T> { 3591 /// using Base<T>::foo; 3592 /// }; 3593 /// \endcode 3594 class UnresolvedUsingValueDecl : public ValueDecl, 3595 public Mergeable<UnresolvedUsingValueDecl> { 3596 /// The source location of the 'using' keyword 3597 SourceLocation UsingLocation; 3598 3599 /// If this is a pack expansion, the location of the '...'. 3600 SourceLocation EllipsisLoc; 3601 3602 /// The nested-name-specifier that precedes the name. 3603 NestedNameSpecifierLoc QualifierLoc; 3604 3605 /// Provides source/type location info for the declaration name 3606 /// embedded in the ValueDecl base class. 3607 DeclarationNameLoc DNLoc; 3608 3609 UnresolvedUsingValueDecl(DeclContext *DC, QualType Ty, 3610 SourceLocation UsingLoc, 3611 NestedNameSpecifierLoc QualifierLoc, 3612 const DeclarationNameInfo &NameInfo, 3613 SourceLocation EllipsisLoc) 3614 : ValueDecl(UnresolvedUsingValue, DC, 3615 NameInfo.getLoc(), NameInfo.getName(), Ty), 3616 UsingLocation(UsingLoc), EllipsisLoc(EllipsisLoc), 3617 QualifierLoc(QualifierLoc), DNLoc(NameInfo.getInfo()) {} 3618 3619 void anchor() override; 3620 3621 public: 3622 friend class ASTDeclReader; 3623 friend class ASTDeclWriter; 3624 3625 /// Returns the source location of the 'using' keyword. 3626 SourceLocation getUsingLoc() const { return UsingLocation; } 3627 3628 /// Set the source location of the 'using' keyword. 3629 void setUsingLoc(SourceLocation L) { UsingLocation = L; } 3630 3631 /// Return true if it is a C++03 access declaration (no 'using'). 3632 bool isAccessDeclaration() const { return UsingLocation.isInvalid(); } 3633 3634 /// Retrieve the nested-name-specifier that qualifies the name, 3635 /// with source-location information. 3636 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; } 3637 3638 /// Retrieve the nested-name-specifier that qualifies the name. 3639 NestedNameSpecifier *getQualifier() const { 3640 return QualifierLoc.getNestedNameSpecifier(); 3641 } 3642 3643 DeclarationNameInfo getNameInfo() const { 3644 return DeclarationNameInfo(getDeclName(), getLocation(), DNLoc); 3645 } 3646 3647 /// Determine whether this is a pack expansion. 3648 bool isPackExpansion() const { 3649 return EllipsisLoc.isValid(); 3650 } 3651 3652 /// Get the location of the ellipsis if this is a pack expansion. 3653 SourceLocation getEllipsisLoc() const { 3654 return EllipsisLoc; 3655 } 3656 3657 static UnresolvedUsingValueDecl * 3658 Create(ASTContext &C, DeclContext *DC, SourceLocation UsingLoc, 3659 NestedNameSpecifierLoc QualifierLoc, 3660 const DeclarationNameInfo &NameInfo, SourceLocation EllipsisLoc); 3661 3662 static UnresolvedUsingValueDecl * 3663 CreateDeserialized(ASTContext &C, unsigned ID); 3664 3665 SourceRange getSourceRange() const override LLVM_READONLY; 3666 3667 /// Retrieves the canonical declaration of this declaration. 3668 UnresolvedUsingValueDecl *getCanonicalDecl() override { 3669 return getFirstDecl(); 3670 } 3671 const UnresolvedUsingValueDecl *getCanonicalDecl() const { 3672 return getFirstDecl(); 3673 } 3674 3675 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 3676 static bool classofKind(Kind K) { return K == UnresolvedUsingValue; } 3677 }; 3678 3679 /// Represents a dependent using declaration which was marked with 3680 /// \c typename. 3681 /// 3682 /// \code 3683 /// template \<class T> class A : public Base<T> { 3684 /// using typename Base<T>::foo; 3685 /// }; 3686 /// \endcode 3687 /// 3688 /// The type associated with an unresolved using typename decl is 3689 /// currently always a typename type. 3690 class UnresolvedUsingTypenameDecl 3691 : public TypeDecl, 3692 public Mergeable<UnresolvedUsingTypenameDecl> { 3693 friend class ASTDeclReader; 3694 3695 /// The source location of the 'typename' keyword 3696 SourceLocation TypenameLocation; 3697 3698 /// If this is a pack expansion, the location of the '...'. 3699 SourceLocation EllipsisLoc; 3700 3701 /// The nested-name-specifier that precedes the name. 3702 NestedNameSpecifierLoc QualifierLoc; 3703 3704 UnresolvedUsingTypenameDecl(DeclContext *DC, SourceLocation UsingLoc, 3705 SourceLocation TypenameLoc, 3706 NestedNameSpecifierLoc QualifierLoc, 3707 SourceLocation TargetNameLoc, 3708 IdentifierInfo *TargetName, 3709 SourceLocation EllipsisLoc) 3710 : TypeDecl(UnresolvedUsingTypename, DC, TargetNameLoc, TargetName, 3711 UsingLoc), 3712 TypenameLocation(TypenameLoc), EllipsisLoc(EllipsisLoc), 3713 QualifierLoc(QualifierLoc) {} 3714 3715 void anchor() override; 3716 3717 public: 3718 /// Returns the source location of the 'using' keyword. 3719 SourceLocation getUsingLoc() const { return getBeginLoc(); } 3720 3721 /// Returns the source location of the 'typename' keyword. 3722 SourceLocation getTypenameLoc() const { return TypenameLocation; } 3723 3724 /// Retrieve the nested-name-specifier that qualifies the name, 3725 /// with source-location information. 3726 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; } 3727 3728 /// Retrieve the nested-name-specifier that qualifies the name. 3729 NestedNameSpecifier *getQualifier() const { 3730 return QualifierLoc.getNestedNameSpecifier(); 3731 } 3732 3733 DeclarationNameInfo getNameInfo() const { 3734 return DeclarationNameInfo(getDeclName(), getLocation()); 3735 } 3736 3737 /// Determine whether this is a pack expansion. 3738 bool isPackExpansion() const { 3739 return EllipsisLoc.isValid(); 3740 } 3741 3742 /// Get the location of the ellipsis if this is a pack expansion. 3743 SourceLocation getEllipsisLoc() const { 3744 return EllipsisLoc; 3745 } 3746 3747 static UnresolvedUsingTypenameDecl * 3748 Create(ASTContext &C, DeclContext *DC, SourceLocation UsingLoc, 3749 SourceLocation TypenameLoc, NestedNameSpecifierLoc QualifierLoc, 3750 SourceLocation TargetNameLoc, DeclarationName TargetName, 3751 SourceLocation EllipsisLoc); 3752 3753 static UnresolvedUsingTypenameDecl * 3754 CreateDeserialized(ASTContext &C, unsigned ID); 3755 3756 /// Retrieves the canonical declaration of this declaration. 3757 UnresolvedUsingTypenameDecl *getCanonicalDecl() override { 3758 return getFirstDecl(); 3759 } 3760 const UnresolvedUsingTypenameDecl *getCanonicalDecl() const { 3761 return getFirstDecl(); 3762 } 3763 3764 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 3765 static bool classofKind(Kind K) { return K == UnresolvedUsingTypename; } 3766 }; 3767 3768 /// Represents a C++11 static_assert declaration. 3769 class StaticAssertDecl : public Decl { 3770 llvm::PointerIntPair<Expr *, 1, bool> AssertExprAndFailed; 3771 StringLiteral *Message; 3772 SourceLocation RParenLoc; 3773 3774 StaticAssertDecl(DeclContext *DC, SourceLocation StaticAssertLoc, 3775 Expr *AssertExpr, StringLiteral *Message, 3776 SourceLocation RParenLoc, bool Failed) 3777 : Decl(StaticAssert, DC, StaticAssertLoc), 3778 AssertExprAndFailed(AssertExpr, Failed), Message(Message), 3779 RParenLoc(RParenLoc) {} 3780 3781 virtual void anchor(); 3782 3783 public: 3784 friend class ASTDeclReader; 3785 3786 static StaticAssertDecl *Create(ASTContext &C, DeclContext *DC, 3787 SourceLocation StaticAssertLoc, 3788 Expr *AssertExpr, StringLiteral *Message, 3789 SourceLocation RParenLoc, bool Failed); 3790 static StaticAssertDecl *CreateDeserialized(ASTContext &C, unsigned ID); 3791 3792 Expr *getAssertExpr() { return AssertExprAndFailed.getPointer(); } 3793 const Expr *getAssertExpr() const { return AssertExprAndFailed.getPointer(); } 3794 3795 StringLiteral *getMessage() { return Message; } 3796 const StringLiteral *getMessage() const { return Message; } 3797 3798 bool isFailed() const { return AssertExprAndFailed.getInt(); } 3799 3800 SourceLocation getRParenLoc() const { return RParenLoc; } 3801 3802 SourceRange getSourceRange() const override LLVM_READONLY { 3803 return SourceRange(getLocation(), getRParenLoc()); 3804 } 3805 3806 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 3807 static bool classofKind(Kind K) { return K == StaticAssert; } 3808 }; 3809 3810 /// A binding in a decomposition declaration. For instance, given: 3811 /// 3812 /// int n[3]; 3813 /// auto &[a, b, c] = n; 3814 /// 3815 /// a, b, and c are BindingDecls, whose bindings are the expressions 3816 /// x[0], x[1], and x[2] respectively, where x is the implicit 3817 /// DecompositionDecl of type 'int (&)[3]'. 3818 class BindingDecl : public ValueDecl { 3819 /// The declaration that this binding binds to part of. 3820 LazyDeclPtr Decomp; 3821 /// The binding represented by this declaration. References to this 3822 /// declaration are effectively equivalent to this expression (except 3823 /// that it is only evaluated once at the point of declaration of the 3824 /// binding). 3825 Expr *Binding = nullptr; 3826 3827 BindingDecl(DeclContext *DC, SourceLocation IdLoc, IdentifierInfo *Id) 3828 : ValueDecl(Decl::Binding, DC, IdLoc, Id, QualType()) {} 3829 3830 void anchor() override; 3831 3832 public: 3833 friend class ASTDeclReader; 3834 3835 static BindingDecl *Create(ASTContext &C, DeclContext *DC, 3836 SourceLocation IdLoc, IdentifierInfo *Id); 3837 static BindingDecl *CreateDeserialized(ASTContext &C, unsigned ID); 3838 3839 /// Get the expression to which this declaration is bound. This may be null 3840 /// in two different cases: while parsing the initializer for the 3841 /// decomposition declaration, and when the initializer is type-dependent. 3842 Expr *getBinding() const { return Binding; } 3843 3844 /// Get the decomposition declaration that this binding represents a 3845 /// decomposition of. 3846 ValueDecl *getDecomposedDecl() const; 3847 3848 /// Get the variable (if any) that holds the value of evaluating the binding. 3849 /// Only present for user-defined bindings for tuple-like types. 3850 VarDecl *getHoldingVar() const; 3851 3852 /// Set the binding for this BindingDecl, along with its declared type (which 3853 /// should be a possibly-cv-qualified form of the type of the binding, or a 3854 /// reference to such a type). 3855 void setBinding(QualType DeclaredType, Expr *Binding) { 3856 setType(DeclaredType); 3857 this->Binding = Binding; 3858 } 3859 3860 /// Set the decomposed variable for this BindingDecl. 3861 void setDecomposedDecl(ValueDecl *Decomposed) { Decomp = Decomposed; } 3862 3863 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 3864 static bool classofKind(Kind K) { return K == Decl::Binding; } 3865 }; 3866 3867 /// A decomposition declaration. For instance, given: 3868 /// 3869 /// int n[3]; 3870 /// auto &[a, b, c] = n; 3871 /// 3872 /// the second line declares a DecompositionDecl of type 'int (&)[3]', and 3873 /// three BindingDecls (named a, b, and c). An instance of this class is always 3874 /// unnamed, but behaves in almost all other respects like a VarDecl. 3875 class DecompositionDecl final 3876 : public VarDecl, 3877 private llvm::TrailingObjects<DecompositionDecl, BindingDecl *> { 3878 /// The number of BindingDecl*s following this object. 3879 unsigned NumBindings; 3880 3881 DecompositionDecl(ASTContext &C, DeclContext *DC, SourceLocation StartLoc, 3882 SourceLocation LSquareLoc, QualType T, 3883 TypeSourceInfo *TInfo, StorageClass SC, 3884 ArrayRef<BindingDecl *> Bindings) 3885 : VarDecl(Decomposition, C, DC, StartLoc, LSquareLoc, nullptr, T, TInfo, 3886 SC), 3887 NumBindings(Bindings.size()) { 3888 std::uninitialized_copy(Bindings.begin(), Bindings.end(), 3889 getTrailingObjects<BindingDecl *>()); 3890 for (auto *B : Bindings) 3891 B->setDecomposedDecl(this); 3892 } 3893 3894 void anchor() override; 3895 3896 public: 3897 friend class ASTDeclReader; 3898 friend TrailingObjects; 3899 3900 static DecompositionDecl *Create(ASTContext &C, DeclContext *DC, 3901 SourceLocation StartLoc, 3902 SourceLocation LSquareLoc, 3903 QualType T, TypeSourceInfo *TInfo, 3904 StorageClass S, 3905 ArrayRef<BindingDecl *> Bindings); 3906 static DecompositionDecl *CreateDeserialized(ASTContext &C, unsigned ID, 3907 unsigned NumBindings); 3908 3909 ArrayRef<BindingDecl *> bindings() const { 3910 return llvm::makeArrayRef(getTrailingObjects<BindingDecl *>(), NumBindings); 3911 } 3912 3913 void printName(raw_ostream &os) const override; 3914 3915 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 3916 static bool classofKind(Kind K) { return K == Decomposition; } 3917 }; 3918 3919 /// An instance of this class represents the declaration of a property 3920 /// member. This is a Microsoft extension to C++, first introduced in 3921 /// Visual Studio .NET 2003 as a parallel to similar features in C# 3922 /// and Managed C++. 3923 /// 3924 /// A property must always be a non-static class member. 3925 /// 3926 /// A property member superficially resembles a non-static data 3927 /// member, except preceded by a property attribute: 3928 /// __declspec(property(get=GetX, put=PutX)) int x; 3929 /// Either (but not both) of the 'get' and 'put' names may be omitted. 3930 /// 3931 /// A reference to a property is always an lvalue. If the lvalue 3932 /// undergoes lvalue-to-rvalue conversion, then a getter name is 3933 /// required, and that member is called with no arguments. 3934 /// If the lvalue is assigned into, then a setter name is required, 3935 /// and that member is called with one argument, the value assigned. 3936 /// Both operations are potentially overloaded. Compound assignments 3937 /// are permitted, as are the increment and decrement operators. 3938 /// 3939 /// The getter and putter methods are permitted to be overloaded, 3940 /// although their return and parameter types are subject to certain 3941 /// restrictions according to the type of the property. 3942 /// 3943 /// A property declared using an incomplete array type may 3944 /// additionally be subscripted, adding extra parameters to the getter 3945 /// and putter methods. 3946 class MSPropertyDecl : public DeclaratorDecl { 3947 IdentifierInfo *GetterId, *SetterId; 3948 3949 MSPropertyDecl(DeclContext *DC, SourceLocation L, DeclarationName N, 3950 QualType T, TypeSourceInfo *TInfo, SourceLocation StartL, 3951 IdentifierInfo *Getter, IdentifierInfo *Setter) 3952 : DeclaratorDecl(MSProperty, DC, L, N, T, TInfo, StartL), 3953 GetterId(Getter), SetterId(Setter) {} 3954 3955 void anchor() override; 3956 public: 3957 friend class ASTDeclReader; 3958 3959 static MSPropertyDecl *Create(ASTContext &C, DeclContext *DC, 3960 SourceLocation L, DeclarationName N, QualType T, 3961 TypeSourceInfo *TInfo, SourceLocation StartL, 3962 IdentifierInfo *Getter, IdentifierInfo *Setter); 3963 static MSPropertyDecl *CreateDeserialized(ASTContext &C, unsigned ID); 3964 3965 static bool classof(const Decl *D) { return D->getKind() == MSProperty; } 3966 3967 bool hasGetter() const { return GetterId != nullptr; } 3968 IdentifierInfo* getGetterId() const { return GetterId; } 3969 bool hasSetter() const { return SetterId != nullptr; } 3970 IdentifierInfo* getSetterId() const { return SetterId; } 3971 }; 3972 3973 /// Parts of a decomposed MSGuidDecl. Factored out to avoid unnecessary 3974 /// dependencies on DeclCXX.h. 3975 struct MSGuidDeclParts { 3976 /// {01234567-... 3977 uint32_t Part1; 3978 /// ...-89ab-... 3979 uint16_t Part2; 3980 /// ...-cdef-... 3981 uint16_t Part3; 3982 /// ...-0123-456789abcdef} 3983 uint8_t Part4And5[8]; 3984 3985 uint64_t getPart4And5AsUint64() const { 3986 uint64_t Val; 3987 memcpy(&Val, &Part4And5, sizeof(Part4And5)); 3988 return Val; 3989 } 3990 }; 3991 3992 /// A global _GUID constant. These are implicitly created by UuidAttrs. 3993 /// 3994 /// struct _declspec(uuid("01234567-89ab-cdef-0123-456789abcdef")) X{}; 3995 /// 3996 /// X is a CXXRecordDecl that contains a UuidAttr that references the (unique) 3997 /// MSGuidDecl for the specified UUID. 3998 class MSGuidDecl : public ValueDecl, 3999 public Mergeable<MSGuidDecl>, 4000 public llvm::FoldingSetNode { 4001 public: 4002 using Parts = MSGuidDeclParts; 4003 4004 private: 4005 /// The decomposed form of the UUID. 4006 Parts PartVal; 4007 4008 /// The resolved value of the UUID as an APValue. Computed on demand and 4009 /// cached. 4010 mutable APValue APVal; 4011 4012 void anchor() override; 4013 4014 MSGuidDecl(DeclContext *DC, QualType T, Parts P); 4015 4016 static MSGuidDecl *Create(const ASTContext &C, QualType T, Parts P); 4017 static MSGuidDecl *CreateDeserialized(ASTContext &C, unsigned ID); 4018 4019 // Only ASTContext::getMSGuidDecl and deserialization create these. 4020 friend class ASTContext; 4021 friend class ASTReader; 4022 friend class ASTDeclReader; 4023 4024 public: 4025 /// Print this UUID in a human-readable format. 4026 void printName(llvm::raw_ostream &OS) const override; 4027 4028 /// Get the decomposed parts of this declaration. 4029 Parts getParts() const { return PartVal; } 4030 4031 /// Get the value of this MSGuidDecl as an APValue. This may fail and return 4032 /// an absent APValue if the type of the declaration is not of the expected 4033 /// shape. 4034 APValue &getAsAPValue() const; 4035 4036 static void Profile(llvm::FoldingSetNodeID &ID, Parts P) { 4037 ID.AddInteger(P.Part1); 4038 ID.AddInteger(P.Part2); 4039 ID.AddInteger(P.Part3); 4040 ID.AddInteger(P.getPart4And5AsUint64()); 4041 } 4042 void Profile(llvm::FoldingSetNodeID &ID) { Profile(ID, PartVal); } 4043 4044 static bool classof(const Decl *D) { return classofKind(D->getKind()); } 4045 static bool classofKind(Kind K) { return K == Decl::MSGuid; } 4046 }; 4047 4048 /// Insertion operator for diagnostics. This allows sending an AccessSpecifier 4049 /// into a diagnostic with <<. 4050 const StreamingDiagnostic &operator<<(const StreamingDiagnostic &DB, 4051 AccessSpecifier AS); 4052 4053 } // namespace clang 4054 4055 #endif // LLVM_CLANG_AST_DECLCXX_H 4056