1 //===-- DeclCXX.h - Classes for representing C++ declarations -*- C++ -*-=====//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief Defines the C++ Decl subclasses, other than those for templates
12 /// (found in DeclTemplate.h) and friends (in DeclFriend.h).
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CLANG_AST_DECLCXX_H
17 #define LLVM_CLANG_AST_DECLCXX_H
19 #include "clang/AST/ASTUnresolvedSet.h"
20 #include "clang/AST/Attr.h"
21 #include "clang/AST/Decl.h"
22 #include "clang/AST/Expr.h"
23 #include "clang/AST/LambdaCapture.h"
24 #include "llvm/ADT/DenseMap.h"
25 #include "llvm/ADT/PointerIntPair.h"
26 #include "llvm/Support/Compiler.h"
30 class ClassTemplateDecl;
31 class ClassTemplateSpecializationDecl;
34 class CXXConstructorDecl;
35 class CXXConversionDecl;
36 class CXXDestructorDecl;
39 class CXXMemberLookupCriteria;
40 class CXXFinalOverriderMap;
41 class CXXIndirectPrimaryBaseSet;
46 /// \brief Represents any kind of function declaration, whether it is a
47 /// concrete function or a function template.
48 class AnyFunctionDecl {
51 AnyFunctionDecl(NamedDecl *ND) : Function(ND) { }
54 AnyFunctionDecl(FunctionDecl *FD) : Function(FD) { }
55 AnyFunctionDecl(FunctionTemplateDecl *FTD);
57 /// \brief Implicily converts any function or function template into a
58 /// named declaration.
59 operator NamedDecl *() const { return Function; }
61 /// \brief Retrieve the underlying function or function template.
62 NamedDecl *get() const { return Function; }
64 static AnyFunctionDecl getFromNamedDecl(NamedDecl *ND) {
65 return AnyFunctionDecl(ND);
69 } // end namespace clang
72 // Provide PointerLikeTypeTraits for non-cvr pointers.
74 class PointerLikeTypeTraits< ::clang::AnyFunctionDecl> {
76 static inline void *getAsVoidPointer(::clang::AnyFunctionDecl F) {
79 static inline ::clang::AnyFunctionDecl getFromVoidPointer(void *P) {
80 return ::clang::AnyFunctionDecl::getFromNamedDecl(
81 static_cast< ::clang::NamedDecl*>(P));
84 enum { NumLowBitsAvailable = 2 };
87 } // end namespace llvm
91 /// \brief Represents an access specifier followed by colon ':'.
93 /// An objects of this class represents sugar for the syntactic occurrence
94 /// of an access specifier followed by a colon in the list of member
95 /// specifiers of a C++ class definition.
97 /// Note that they do not represent other uses of access specifiers,
98 /// such as those occurring in a list of base specifiers.
99 /// Also note that this class has nothing to do with so-called
100 /// "access declarations" (C++98 11.3 [class.access.dcl]).
101 class AccessSpecDecl : public Decl {
102 virtual void anchor();
103 /// \brief The location of the ':'.
104 SourceLocation ColonLoc;
106 AccessSpecDecl(AccessSpecifier AS, DeclContext *DC,
107 SourceLocation ASLoc, SourceLocation ColonLoc)
108 : Decl(AccessSpec, DC, ASLoc), ColonLoc(ColonLoc) {
111 AccessSpecDecl(EmptyShell Empty)
112 : Decl(AccessSpec, Empty) { }
114 /// \brief The location of the access specifier.
115 SourceLocation getAccessSpecifierLoc() const { return getLocation(); }
116 /// \brief Sets the location of the access specifier.
117 void setAccessSpecifierLoc(SourceLocation ASLoc) { setLocation(ASLoc); }
119 /// \brief The location of the colon following the access specifier.
120 SourceLocation getColonLoc() const { return ColonLoc; }
121 /// \brief Sets the location of the colon.
122 void setColonLoc(SourceLocation CLoc) { ColonLoc = CLoc; }
124 SourceRange getSourceRange() const override LLVM_READONLY {
125 return SourceRange(getAccessSpecifierLoc(), getColonLoc());
128 static AccessSpecDecl *Create(ASTContext &C, AccessSpecifier AS,
129 DeclContext *DC, SourceLocation ASLoc,
130 SourceLocation ColonLoc) {
131 return new (C, DC) AccessSpecDecl(AS, DC, ASLoc, ColonLoc);
133 static AccessSpecDecl *CreateDeserialized(ASTContext &C, unsigned ID);
135 // Implement isa/cast/dyncast/etc.
136 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
137 static bool classofKind(Kind K) { return K == AccessSpec; }
141 /// \brief Represents a base class of a C++ class.
143 /// Each CXXBaseSpecifier represents a single, direct base class (or
144 /// struct) of a C++ class (or struct). It specifies the type of that
145 /// base class, whether it is a virtual or non-virtual base, and what
146 /// level of access (public, protected, private) is used for the
147 /// derivation. For example:
152 /// class C : public virtual A, protected B { };
155 /// In this code, C will have two CXXBaseSpecifiers, one for "public
156 /// virtual A" and the other for "protected B".
157 class CXXBaseSpecifier {
158 /// \brief The source code range that covers the full base
159 /// specifier, including the "virtual" (if present) and access
160 /// specifier (if present).
163 /// \brief The source location of the ellipsis, if this is a pack
165 SourceLocation EllipsisLoc;
167 /// \brief Whether this is a virtual base class or not.
170 /// \brief Whether this is the base of a class (true) or of a struct (false).
172 /// This determines the mapping from the access specifier as written in the
173 /// source code to the access specifier used for semantic analysis.
174 bool BaseOfClass : 1;
176 /// \brief Access specifier as written in the source code (may be AS_none).
178 /// The actual type of data stored here is an AccessSpecifier, but we use
179 /// "unsigned" here to work around a VC++ bug.
182 /// \brief Whether the class contains a using declaration
183 /// to inherit the named class's constructors.
184 bool InheritConstructors : 1;
186 /// \brief The type of the base class.
188 /// This will be a class or struct (or a typedef of such). The source code
189 /// range does not include the \c virtual or the access specifier.
190 TypeSourceInfo *BaseTypeInfo;
193 CXXBaseSpecifier() { }
195 CXXBaseSpecifier(SourceRange R, bool V, bool BC, AccessSpecifier A,
196 TypeSourceInfo *TInfo, SourceLocation EllipsisLoc)
197 : Range(R), EllipsisLoc(EllipsisLoc), Virtual(V), BaseOfClass(BC),
198 Access(A), InheritConstructors(false), BaseTypeInfo(TInfo) { }
200 /// \brief Retrieves the source range that contains the entire base specifier.
201 SourceRange getSourceRange() const LLVM_READONLY { return Range; }
202 SourceLocation getLocStart() const LLVM_READONLY { return Range.getBegin(); }
203 SourceLocation getLocEnd() const LLVM_READONLY { return Range.getEnd(); }
205 /// \brief Determines whether the base class is a virtual base class (or not).
206 bool isVirtual() const { return Virtual; }
208 /// \brief Determine whether this base class is a base of a class declared
209 /// with the 'class' keyword (vs. one declared with the 'struct' keyword).
210 bool isBaseOfClass() const { return BaseOfClass; }
212 /// \brief Determine whether this base specifier is a pack expansion.
213 bool isPackExpansion() const { return EllipsisLoc.isValid(); }
215 /// \brief Determine whether this base class's constructors get inherited.
216 bool getInheritConstructors() const { return InheritConstructors; }
218 /// \brief Set that this base class's constructors should be inherited.
219 void setInheritConstructors(bool Inherit = true) {
220 InheritConstructors = Inherit;
223 /// \brief For a pack expansion, determine the location of the ellipsis.
224 SourceLocation getEllipsisLoc() const {
228 /// \brief Returns the access specifier for this base specifier.
230 /// This is the actual base specifier as used for semantic analysis, so
231 /// the result can never be AS_none. To retrieve the access specifier as
232 /// written in the source code, use getAccessSpecifierAsWritten().
233 AccessSpecifier getAccessSpecifier() const {
234 if ((AccessSpecifier)Access == AS_none)
235 return BaseOfClass? AS_private : AS_public;
237 return (AccessSpecifier)Access;
240 /// \brief Retrieves the access specifier as written in the source code
241 /// (which may mean that no access specifier was explicitly written).
243 /// Use getAccessSpecifier() to retrieve the access specifier for use in
244 /// semantic analysis.
245 AccessSpecifier getAccessSpecifierAsWritten() const {
246 return (AccessSpecifier)Access;
249 /// \brief Retrieves the type of the base class.
251 /// This type will always be an unqualified class type.
252 QualType getType() const {
253 return BaseTypeInfo->getType().getUnqualifiedType();
256 /// \brief Retrieves the type and source location of the base class.
257 TypeSourceInfo *getTypeSourceInfo() const { return BaseTypeInfo; }
260 /// \brief A lazy pointer to the definition data for a declaration.
261 /// FIXME: This is a little CXXRecordDecl-specific that the moment.
262 template<typename Decl, typename T> class LazyDefinitionDataPtr {
263 llvm::PointerUnion<T *, Decl *> DataOrCanonicalDecl;
265 LazyDefinitionDataPtr update() {
266 if (Decl *Canon = DataOrCanonicalDecl.template dyn_cast<Decl*>()) {
267 if (Canon->isCanonicalDecl())
268 Canon->getMostRecentDecl();
270 // Declaration isn't canonical any more;
271 // update it and perform path compression.
272 *this = Canon->getPreviousDecl()->DefinitionData.update();
278 LazyDefinitionDataPtr(Decl *Canon) : DataOrCanonicalDecl(Canon) {}
279 LazyDefinitionDataPtr(T *Data) : DataOrCanonicalDecl(Data) {}
280 T *getNotUpdated() { return DataOrCanonicalDecl.template dyn_cast<T*>(); }
281 T *get() { return update().getNotUpdated(); }
284 /// \brief Represents a C++ struct/union/class.
285 class CXXRecordDecl : public RecordDecl {
287 friend void TagDecl::startDefinition();
289 /// Values used in DefinitionData fields to represent special members.
290 enum SpecialMemberFlags {
291 SMF_DefaultConstructor = 0x1,
292 SMF_CopyConstructor = 0x2,
293 SMF_MoveConstructor = 0x4,
294 SMF_CopyAssignment = 0x8,
295 SMF_MoveAssignment = 0x10,
296 SMF_Destructor = 0x20,
300 struct DefinitionData {
301 DefinitionData(CXXRecordDecl *D);
303 /// \brief True if this class has any user-declared constructors.
304 bool UserDeclaredConstructor : 1;
306 /// \brief The user-declared special members which this class has.
307 unsigned UserDeclaredSpecialMembers : 6;
309 /// \brief True when this class is an aggregate.
312 /// \brief True when this class is a POD-type.
313 bool PlainOldData : 1;
315 /// true when this class is empty for traits purposes,
316 /// i.e. has no data members other than 0-width bit-fields, has no
317 /// virtual function/base, and doesn't inherit from a non-empty
318 /// class. Doesn't take union-ness into account.
321 /// \brief True when this class is polymorphic, i.e., has at
322 /// least one virtual member or derives from a polymorphic class.
323 bool Polymorphic : 1;
325 /// \brief True when this class is abstract, i.e., has at least
326 /// one pure virtual function, (that can come from a base class).
329 /// \brief True when this class has standard layout.
331 /// C++11 [class]p7. A standard-layout class is a class that:
332 /// * has no non-static data members of type non-standard-layout class (or
333 /// array of such types) or reference,
334 /// * has no virtual functions (10.3) and no virtual base classes (10.1),
335 /// * has the same access control (Clause 11) for all non-static data
337 /// * has no non-standard-layout base classes,
338 /// * either has no non-static data members in the most derived class and at
339 /// most one base class with non-static data members, or has no base
340 /// classes with non-static data members, and
341 /// * has no base classes of the same type as the first non-static data
343 bool IsStandardLayout : 1;
345 /// \brief True when there are no non-empty base classes.
347 /// This is a helper bit of state used to implement IsStandardLayout more
349 bool HasNoNonEmptyBases : 1;
351 /// \brief True when there are private non-static data members.
352 bool HasPrivateFields : 1;
354 /// \brief True when there are protected non-static data members.
355 bool HasProtectedFields : 1;
357 /// \brief True when there are private non-static data members.
358 bool HasPublicFields : 1;
360 /// \brief True if this class (or any subobject) has mutable fields.
361 bool HasMutableFields : 1;
363 /// \brief True if this class (or any nested anonymous struct or union)
364 /// has variant members.
365 bool HasVariantMembers : 1;
367 /// \brief True if there no non-field members declared by the user.
368 bool HasOnlyCMembers : 1;
370 /// \brief True if any field has an in-class initializer, including those
371 /// within anonymous unions or structs.
372 bool HasInClassInitializer : 1;
374 /// \brief True if any field is of reference type, and does not have an
375 /// in-class initializer.
377 /// In this case, value-initialization of this class is illegal in C++98
378 /// even if the class has a trivial default constructor.
379 bool HasUninitializedReferenceMember : 1;
381 /// \brief These flags are \c true if a defaulted corresponding special
382 /// member can't be fully analyzed without performing overload resolution.
384 bool NeedOverloadResolutionForMoveConstructor : 1;
385 bool NeedOverloadResolutionForMoveAssignment : 1;
386 bool NeedOverloadResolutionForDestructor : 1;
389 /// \brief These flags are \c true if an implicit defaulted corresponding
390 /// special member would be defined as deleted.
392 bool DefaultedMoveConstructorIsDeleted : 1;
393 bool DefaultedMoveAssignmentIsDeleted : 1;
394 bool DefaultedDestructorIsDeleted : 1;
397 /// \brief The trivial special members which this class has, per
398 /// C++11 [class.ctor]p5, C++11 [class.copy]p12, C++11 [class.copy]p25,
399 /// C++11 [class.dtor]p5, or would have if the member were not suppressed.
401 /// This excludes any user-declared but not user-provided special members
402 /// which have been declared but not yet defined.
403 unsigned HasTrivialSpecialMembers : 6;
405 /// \brief The declared special members of this class which are known to be
408 /// This excludes any user-declared but not user-provided special members
409 /// which have been declared but not yet defined, and any implicit special
410 /// members which have not yet been declared.
411 unsigned DeclaredNonTrivialSpecialMembers : 6;
413 /// \brief True when this class has a destructor with no semantic effect.
414 bool HasIrrelevantDestructor : 1;
416 /// \brief True when this class has at least one user-declared constexpr
417 /// constructor which is neither the copy nor move constructor.
418 bool HasConstexprNonCopyMoveConstructor : 1;
420 /// \brief True if a defaulted default constructor for this class would
422 bool DefaultedDefaultConstructorIsConstexpr : 1;
424 /// \brief True if this class has a constexpr default constructor.
426 /// This is true for either a user-declared constexpr default constructor
427 /// or an implicitly declared constexpr default constructor.
428 bool HasConstexprDefaultConstructor : 1;
430 /// \brief True when this class contains at least one non-static data
431 /// member or base class of non-literal or volatile type.
432 bool HasNonLiteralTypeFieldsOrBases : 1;
434 /// \brief True when visible conversion functions are already computed
435 /// and are available.
436 bool ComputedVisibleConversions : 1;
438 /// \brief Whether we have a C++11 user-provided default constructor (not
439 /// explicitly deleted or defaulted).
440 bool UserProvidedDefaultConstructor : 1;
442 /// \brief The special members which have been declared for this class,
443 /// either by the user or implicitly.
444 unsigned DeclaredSpecialMembers : 6;
446 /// \brief Whether an implicit copy constructor would have a const-qualified
448 bool ImplicitCopyConstructorHasConstParam : 1;
450 /// \brief Whether an implicit copy assignment operator would have a
451 /// const-qualified parameter.
452 bool ImplicitCopyAssignmentHasConstParam : 1;
454 /// \brief Whether any declared copy constructor has a const-qualified
456 bool HasDeclaredCopyConstructorWithConstParam : 1;
458 /// \brief Whether any declared copy assignment operator has either a
459 /// const-qualified reference parameter or a non-reference parameter.
460 bool HasDeclaredCopyAssignmentWithConstParam : 1;
462 /// \brief Whether this class describes a C++ lambda.
465 /// \brief Whether we are currently parsing base specifiers.
466 bool IsParsingBaseSpecifiers : 1;
468 /// \brief The number of base class specifiers in Bases.
471 /// \brief The number of virtual base class specifiers in VBases.
474 /// \brief Base classes of this class.
476 /// FIXME: This is wasted space for a union.
477 LazyCXXBaseSpecifiersPtr Bases;
479 /// \brief direct and indirect virtual base classes of this class.
480 LazyCXXBaseSpecifiersPtr VBases;
482 /// \brief The conversion functions of this C++ class (but not its
483 /// inherited conversion functions).
485 /// Each of the entries in this overload set is a CXXConversionDecl.
486 LazyASTUnresolvedSet Conversions;
488 /// \brief The conversion functions of this C++ class and all those
489 /// inherited conversion functions that are visible in this class.
491 /// Each of the entries in this overload set is a CXXConversionDecl or a
492 /// FunctionTemplateDecl.
493 LazyASTUnresolvedSet VisibleConversions;
495 /// \brief The declaration which defines this record.
496 CXXRecordDecl *Definition;
498 /// \brief The first friend declaration in this class, or null if there
501 /// This is actually currently stored in reverse order.
502 LazyDeclPtr FirstFriend;
504 /// \brief Retrieve the set of direct base classes.
505 CXXBaseSpecifier *getBases() const {
506 if (!Bases.isOffset())
507 return Bases.get(nullptr);
508 return getBasesSlowCase();
511 /// \brief Retrieve the set of virtual base classes.
512 CXXBaseSpecifier *getVBases() const {
513 if (!VBases.isOffset())
514 return VBases.get(nullptr);
515 return getVBasesSlowCase();
519 CXXBaseSpecifier *getBasesSlowCase() const;
520 CXXBaseSpecifier *getVBasesSlowCase() const;
523 typedef LazyDefinitionDataPtr<CXXRecordDecl, struct DefinitionData>
525 friend class LazyDefinitionDataPtr<CXXRecordDecl, struct DefinitionData>;
527 mutable DefinitionDataPtr DefinitionData;
529 /// \brief Describes a C++ closure type (generated by a lambda expression).
530 struct LambdaDefinitionData : public DefinitionData {
531 typedef LambdaCapture Capture;
533 LambdaDefinitionData(CXXRecordDecl *D, TypeSourceInfo *Info,
534 bool Dependent, bool IsGeneric,
535 LambdaCaptureDefault CaptureDefault)
536 : DefinitionData(D), Dependent(Dependent), IsGenericLambda(IsGeneric),
537 CaptureDefault(CaptureDefault), NumCaptures(0), NumExplicitCaptures(0),
538 ManglingNumber(0), ContextDecl(nullptr), Captures(nullptr),
542 // C++11 [expr.prim.lambda]p3:
543 // This class type is neither an aggregate nor a literal type.
545 PlainOldData = false;
546 HasNonLiteralTypeFieldsOrBases = true;
549 /// \brief Whether this lambda is known to be dependent, even if its
550 /// context isn't dependent.
552 /// A lambda with a non-dependent context can be dependent if it occurs
553 /// within the default argument of a function template, because the
554 /// lambda will have been created with the enclosing context as its
555 /// declaration context, rather than function. This is an unfortunate
556 /// artifact of having to parse the default arguments before.
557 unsigned Dependent : 1;
559 /// \brief Whether this lambda is a generic lambda.
560 unsigned IsGenericLambda : 1;
562 /// \brief The Default Capture.
563 unsigned CaptureDefault : 2;
565 /// \brief The number of captures in this lambda is limited 2^NumCaptures.
566 unsigned NumCaptures : 15;
568 /// \brief The number of explicit captures in this lambda.
569 unsigned NumExplicitCaptures : 13;
571 /// \brief The number used to indicate this lambda expression for name
572 /// mangling in the Itanium C++ ABI.
573 unsigned ManglingNumber;
575 /// \brief The declaration that provides context for this lambda, if the
576 /// actual DeclContext does not suffice. This is used for lambdas that
577 /// occur within default arguments of function parameters within the class
578 /// or within a data member initializer.
581 /// \brief The list of captures, both explicit and implicit, for this
585 /// \brief The type of the call method.
586 TypeSourceInfo *MethodTyInfo;
590 struct DefinitionData &data() const {
591 auto *DD = DefinitionData.get();
592 assert(DD && "queried property of class with no definition");
596 struct LambdaDefinitionData &getLambdaData() const {
597 // No update required: a merged definition cannot change any lambda
599 auto *DD = DefinitionData.getNotUpdated();
600 assert(DD && DD->IsLambda && "queried lambda property of non-lambda class");
601 return static_cast<LambdaDefinitionData&>(*DD);
604 /// \brief The template or declaration that this declaration
605 /// describes or was instantiated from, respectively.
607 /// For non-templates, this value will be null. For record
608 /// declarations that describe a class template, this will be a
609 /// pointer to a ClassTemplateDecl. For member
610 /// classes of class template specializations, this will be the
611 /// MemberSpecializationInfo referring to the member class that was
612 /// instantiated or specialized.
613 llvm::PointerUnion<ClassTemplateDecl*, MemberSpecializationInfo*>
614 TemplateOrInstantiation;
616 friend class DeclContext;
617 friend class LambdaExpr;
619 /// \brief Called from setBases and addedMember to notify the class that a
620 /// direct or virtual base class or a member of class type has been added.
621 void addedClassSubobject(CXXRecordDecl *Base);
623 /// \brief Notify the class that member has been added.
625 /// This routine helps maintain information about the class based on which
626 /// members have been added. It will be invoked by DeclContext::addDecl()
627 /// whenever a member is added to this record.
628 void addedMember(Decl *D);
630 void markedVirtualFunctionPure();
631 friend void FunctionDecl::setPure(bool);
633 friend class ASTNodeImporter;
635 /// \brief Get the head of our list of friend declarations, possibly
636 /// deserializing the friends from an external AST source.
637 FriendDecl *getFirstFriend() const;
640 CXXRecordDecl(Kind K, TagKind TK, const ASTContext &C, DeclContext *DC,
641 SourceLocation StartLoc, SourceLocation IdLoc,
642 IdentifierInfo *Id, CXXRecordDecl *PrevDecl);
645 /// \brief Iterator that traverses the base classes of a class.
646 typedef CXXBaseSpecifier* base_class_iterator;
648 /// \brief Iterator that traverses the base classes of a class.
649 typedef const CXXBaseSpecifier* base_class_const_iterator;
651 CXXRecordDecl *getCanonicalDecl() override {
652 return cast<CXXRecordDecl>(RecordDecl::getCanonicalDecl());
654 const CXXRecordDecl *getCanonicalDecl() const {
655 return const_cast<CXXRecordDecl*>(this)->getCanonicalDecl();
658 CXXRecordDecl *getPreviousDecl() {
659 return cast_or_null<CXXRecordDecl>(
660 static_cast<RecordDecl *>(this)->getPreviousDecl());
662 const CXXRecordDecl *getPreviousDecl() const {
663 return const_cast<CXXRecordDecl*>(this)->getPreviousDecl();
666 CXXRecordDecl *getMostRecentDecl() {
667 return cast<CXXRecordDecl>(
668 static_cast<RecordDecl *>(this)->getMostRecentDecl());
671 const CXXRecordDecl *getMostRecentDecl() const {
672 return const_cast<CXXRecordDecl*>(this)->getMostRecentDecl();
675 CXXRecordDecl *getDefinition() const {
676 auto *DD = DefinitionData.get();
677 return DD ? DD->Definition : nullptr;
680 bool hasDefinition() const { return DefinitionData.get(); }
682 static CXXRecordDecl *Create(const ASTContext &C, TagKind TK, DeclContext *DC,
683 SourceLocation StartLoc, SourceLocation IdLoc,
685 CXXRecordDecl *PrevDecl = nullptr,
686 bool DelayTypeCreation = false);
687 static CXXRecordDecl *CreateLambda(const ASTContext &C, DeclContext *DC,
688 TypeSourceInfo *Info, SourceLocation Loc,
689 bool DependentLambda, bool IsGeneric,
690 LambdaCaptureDefault CaptureDefault);
691 static CXXRecordDecl *CreateDeserialized(const ASTContext &C, unsigned ID);
693 bool isDynamicClass() const {
694 return data().Polymorphic || data().NumVBases != 0;
697 void setIsParsingBaseSpecifiers() { data().IsParsingBaseSpecifiers = true; }
699 bool isParsingBaseSpecifiers() const {
700 return data().IsParsingBaseSpecifiers;
703 /// \brief Sets the base classes of this struct or class.
704 void setBases(CXXBaseSpecifier const * const *Bases, unsigned NumBases);
706 /// \brief Retrieves the number of base classes of this class.
707 unsigned getNumBases() const { return data().NumBases; }
709 typedef llvm::iterator_range<base_class_iterator> base_class_range;
710 typedef llvm::iterator_range<base_class_const_iterator>
711 base_class_const_range;
713 base_class_range bases() {
714 return base_class_range(bases_begin(), bases_end());
716 base_class_const_range bases() const {
717 return base_class_const_range(bases_begin(), bases_end());
720 base_class_iterator bases_begin() { return data().getBases(); }
721 base_class_const_iterator bases_begin() const { return data().getBases(); }
722 base_class_iterator bases_end() { return bases_begin() + data().NumBases; }
723 base_class_const_iterator bases_end() const {
724 return bases_begin() + data().NumBases;
727 /// \brief Retrieves the number of virtual base classes of this class.
728 unsigned getNumVBases() const { return data().NumVBases; }
730 base_class_range vbases() {
731 return base_class_range(vbases_begin(), vbases_end());
733 base_class_const_range vbases() const {
734 return base_class_const_range(vbases_begin(), vbases_end());
737 base_class_iterator vbases_begin() { return data().getVBases(); }
738 base_class_const_iterator vbases_begin() const { return data().getVBases(); }
739 base_class_iterator vbases_end() { return vbases_begin() + data().NumVBases; }
740 base_class_const_iterator vbases_end() const {
741 return vbases_begin() + data().NumVBases;
744 /// \brief Determine whether this class has any dependent base classes which
745 /// are not the current instantiation.
746 bool hasAnyDependentBases() const;
748 /// Iterator access to method members. The method iterator visits
749 /// all method members of the class, including non-instance methods,
750 /// special methods, etc.
751 typedef specific_decl_iterator<CXXMethodDecl> method_iterator;
752 typedef llvm::iterator_range<specific_decl_iterator<CXXMethodDecl>>
755 method_range methods() const {
756 return method_range(method_begin(), method_end());
759 /// \brief Method begin iterator. Iterates in the order the methods
761 method_iterator method_begin() const {
762 return method_iterator(decls_begin());
764 /// \brief Method past-the-end iterator.
765 method_iterator method_end() const {
766 return method_iterator(decls_end());
769 /// Iterator access to constructor members.
770 typedef specific_decl_iterator<CXXConstructorDecl> ctor_iterator;
771 typedef llvm::iterator_range<specific_decl_iterator<CXXConstructorDecl>>
774 ctor_range ctors() const { return ctor_range(ctor_begin(), ctor_end()); }
776 ctor_iterator ctor_begin() const {
777 return ctor_iterator(decls_begin());
779 ctor_iterator ctor_end() const {
780 return ctor_iterator(decls_end());
783 /// An iterator over friend declarations. All of these are defined
785 class friend_iterator;
786 typedef llvm::iterator_range<friend_iterator> friend_range;
788 friend_range friends() const;
789 friend_iterator friend_begin() const;
790 friend_iterator friend_end() const;
791 void pushFriendDecl(FriendDecl *FD);
793 /// Determines whether this record has any friends.
794 bool hasFriends() const {
795 return data().FirstFriend.isValid();
798 /// \brief \c true if we know for sure that this class has a single,
799 /// accessible, unambiguous move constructor that is not deleted.
800 bool hasSimpleMoveConstructor() const {
801 return !hasUserDeclaredMoveConstructor() && hasMoveConstructor() &&
802 !data().DefaultedMoveConstructorIsDeleted;
804 /// \brief \c true if we know for sure that this class has a single,
805 /// accessible, unambiguous move assignment operator that is not deleted.
806 bool hasSimpleMoveAssignment() const {
807 return !hasUserDeclaredMoveAssignment() && hasMoveAssignment() &&
808 !data().DefaultedMoveAssignmentIsDeleted;
810 /// \brief \c true if we know for sure that this class has an accessible
811 /// destructor that is not deleted.
812 bool hasSimpleDestructor() const {
813 return !hasUserDeclaredDestructor() &&
814 !data().DefaultedDestructorIsDeleted;
817 /// \brief Determine whether this class has any default constructors.
818 bool hasDefaultConstructor() const {
819 return (data().DeclaredSpecialMembers & SMF_DefaultConstructor) ||
820 needsImplicitDefaultConstructor();
823 /// \brief Determine if we need to declare a default constructor for
826 /// This value is used for lazy creation of default constructors.
827 bool needsImplicitDefaultConstructor() const {
828 return !data().UserDeclaredConstructor &&
829 !(data().DeclaredSpecialMembers & SMF_DefaultConstructor) &&
830 // C++14 [expr.prim.lambda]p20:
831 // The closure type associated with a lambda-expression has no
832 // default constructor.
836 /// \brief Determine whether this class has any user-declared constructors.
838 /// When true, a default constructor will not be implicitly declared.
839 bool hasUserDeclaredConstructor() const {
840 return data().UserDeclaredConstructor;
843 /// \brief Whether this class has a user-provided default constructor
845 bool hasUserProvidedDefaultConstructor() const {
846 return data().UserProvidedDefaultConstructor;
849 /// \brief Determine whether this class has a user-declared copy constructor.
851 /// When false, a copy constructor will be implicitly declared.
852 bool hasUserDeclaredCopyConstructor() const {
853 return data().UserDeclaredSpecialMembers & SMF_CopyConstructor;
856 /// \brief Determine whether this class needs an implicit copy
857 /// constructor to be lazily declared.
858 bool needsImplicitCopyConstructor() const {
859 return !(data().DeclaredSpecialMembers & SMF_CopyConstructor);
862 /// \brief Determine whether we need to eagerly declare a defaulted copy
863 /// constructor for this class.
864 bool needsOverloadResolutionForCopyConstructor() const {
865 return data().HasMutableFields;
868 /// \brief Determine whether an implicit copy constructor for this type
869 /// would have a parameter with a const-qualified reference type.
870 bool implicitCopyConstructorHasConstParam() const {
871 return data().ImplicitCopyConstructorHasConstParam;
874 /// \brief Determine whether this class has a copy constructor with
875 /// a parameter type which is a reference to a const-qualified type.
876 bool hasCopyConstructorWithConstParam() const {
877 return data().HasDeclaredCopyConstructorWithConstParam ||
878 (needsImplicitCopyConstructor() &&
879 implicitCopyConstructorHasConstParam());
882 /// \brief Whether this class has a user-declared move constructor or
883 /// assignment operator.
885 /// When false, a move constructor and assignment operator may be
886 /// implicitly declared.
887 bool hasUserDeclaredMoveOperation() const {
888 return data().UserDeclaredSpecialMembers &
889 (SMF_MoveConstructor | SMF_MoveAssignment);
892 /// \brief Determine whether this class has had a move constructor
893 /// declared by the user.
894 bool hasUserDeclaredMoveConstructor() const {
895 return data().UserDeclaredSpecialMembers & SMF_MoveConstructor;
898 /// \brief Determine whether this class has a move constructor.
899 bool hasMoveConstructor() const {
900 return (data().DeclaredSpecialMembers & SMF_MoveConstructor) ||
901 needsImplicitMoveConstructor();
904 /// \brief Set that we attempted to declare an implicitly move
905 /// constructor, but overload resolution failed so we deleted it.
906 void setImplicitMoveConstructorIsDeleted() {
907 assert((data().DefaultedMoveConstructorIsDeleted ||
908 needsOverloadResolutionForMoveConstructor()) &&
909 "move constructor should not be deleted");
910 data().DefaultedMoveConstructorIsDeleted = true;
913 /// \brief Determine whether this class should get an implicit move
914 /// constructor or if any existing special member function inhibits this.
915 bool needsImplicitMoveConstructor() const {
916 return !(data().DeclaredSpecialMembers & SMF_MoveConstructor) &&
917 !hasUserDeclaredCopyConstructor() &&
918 !hasUserDeclaredCopyAssignment() &&
919 !hasUserDeclaredMoveAssignment() &&
920 !hasUserDeclaredDestructor();
923 /// \brief Determine whether we need to eagerly declare a defaulted move
924 /// constructor for this class.
925 bool needsOverloadResolutionForMoveConstructor() const {
926 return data().NeedOverloadResolutionForMoveConstructor;
929 /// \brief Determine whether this class has a user-declared copy assignment
932 /// When false, a copy assigment operator will be implicitly declared.
933 bool hasUserDeclaredCopyAssignment() const {
934 return data().UserDeclaredSpecialMembers & SMF_CopyAssignment;
937 /// \brief Determine whether this class needs an implicit copy
938 /// assignment operator to be lazily declared.
939 bool needsImplicitCopyAssignment() const {
940 return !(data().DeclaredSpecialMembers & SMF_CopyAssignment);
943 /// \brief Determine whether we need to eagerly declare a defaulted copy
944 /// assignment operator for this class.
945 bool needsOverloadResolutionForCopyAssignment() const {
946 return data().HasMutableFields;
949 /// \brief Determine whether an implicit copy assignment operator for this
950 /// type would have a parameter with a const-qualified reference type.
951 bool implicitCopyAssignmentHasConstParam() const {
952 return data().ImplicitCopyAssignmentHasConstParam;
955 /// \brief Determine whether this class has a copy assignment operator with
956 /// a parameter type which is a reference to a const-qualified type or is not
958 bool hasCopyAssignmentWithConstParam() const {
959 return data().HasDeclaredCopyAssignmentWithConstParam ||
960 (needsImplicitCopyAssignment() &&
961 implicitCopyAssignmentHasConstParam());
964 /// \brief Determine whether this class has had a move assignment
965 /// declared by the user.
966 bool hasUserDeclaredMoveAssignment() const {
967 return data().UserDeclaredSpecialMembers & SMF_MoveAssignment;
970 /// \brief Determine whether this class has a move assignment operator.
971 bool hasMoveAssignment() const {
972 return (data().DeclaredSpecialMembers & SMF_MoveAssignment) ||
973 needsImplicitMoveAssignment();
976 /// \brief Set that we attempted to declare an implicit move assignment
977 /// operator, but overload resolution failed so we deleted it.
978 void setImplicitMoveAssignmentIsDeleted() {
979 assert((data().DefaultedMoveAssignmentIsDeleted ||
980 needsOverloadResolutionForMoveAssignment()) &&
981 "move assignment should not be deleted");
982 data().DefaultedMoveAssignmentIsDeleted = true;
985 /// \brief Determine whether this class should get an implicit move
986 /// assignment operator or if any existing special member function inhibits
988 bool needsImplicitMoveAssignment() const {
989 return !(data().DeclaredSpecialMembers & SMF_MoveAssignment) &&
990 !hasUserDeclaredCopyConstructor() &&
991 !hasUserDeclaredCopyAssignment() &&
992 !hasUserDeclaredMoveConstructor() &&
993 !hasUserDeclaredDestructor();
996 /// \brief Determine whether we need to eagerly declare a move assignment
997 /// operator for this class.
998 bool needsOverloadResolutionForMoveAssignment() const {
999 return data().NeedOverloadResolutionForMoveAssignment;
1002 /// \brief Determine whether this class has a user-declared destructor.
1004 /// When false, a destructor will be implicitly declared.
1005 bool hasUserDeclaredDestructor() const {
1006 return data().UserDeclaredSpecialMembers & SMF_Destructor;
1009 /// \brief Determine whether this class needs an implicit destructor to
1010 /// be lazily declared.
1011 bool needsImplicitDestructor() const {
1012 return !(data().DeclaredSpecialMembers & SMF_Destructor);
1015 /// \brief Determine whether we need to eagerly declare a destructor for this
1017 bool needsOverloadResolutionForDestructor() const {
1018 return data().NeedOverloadResolutionForDestructor;
1021 /// \brief Determine whether this class describes a lambda function object.
1022 bool isLambda() const {
1023 // An update record can't turn a non-lambda into a lambda.
1024 auto *DD = DefinitionData.getNotUpdated();
1025 return DD && DD->IsLambda;
1028 /// \brief Determine whether this class describes a generic
1029 /// lambda function object (i.e. function call operator is
1031 bool isGenericLambda() const;
1033 /// \brief Retrieve the lambda call operator of the closure type
1034 /// if this is a closure type.
1035 CXXMethodDecl *getLambdaCallOperator() const;
1037 /// \brief Retrieve the lambda static invoker, the address of which
1038 /// is returned by the conversion operator, and the body of which
1039 /// is forwarded to the lambda call operator.
1040 CXXMethodDecl *getLambdaStaticInvoker() const;
1042 /// \brief Retrieve the generic lambda's template parameter list.
1043 /// Returns null if the class does not represent a lambda or a generic
1045 TemplateParameterList *getGenericLambdaTemplateParameterList() const;
1047 LambdaCaptureDefault getLambdaCaptureDefault() const {
1049 return static_cast<LambdaCaptureDefault>(getLambdaData().CaptureDefault);
1052 /// \brief For a closure type, retrieve the mapping from captured
1053 /// variables and \c this to the non-static data members that store the
1054 /// values or references of the captures.
1056 /// \param Captures Will be populated with the mapping from captured
1057 /// variables to the corresponding fields.
1059 /// \param ThisCapture Will be set to the field declaration for the
1060 /// \c this capture.
1062 /// \note No entries will be added for init-captures, as they do not capture
1064 void getCaptureFields(llvm::DenseMap<const VarDecl *, FieldDecl *> &Captures,
1065 FieldDecl *&ThisCapture) const;
1067 typedef const LambdaCapture *capture_const_iterator;
1068 typedef llvm::iterator_range<capture_const_iterator> capture_const_range;
1070 capture_const_range captures() const {
1071 return capture_const_range(captures_begin(), captures_end());
1073 capture_const_iterator captures_begin() const {
1074 return isLambda() ? getLambdaData().Captures : nullptr;
1076 capture_const_iterator captures_end() const {
1077 return isLambda() ? captures_begin() + getLambdaData().NumCaptures
1081 typedef UnresolvedSetIterator conversion_iterator;
1082 conversion_iterator conversion_begin() const {
1083 return data().Conversions.get(getASTContext()).begin();
1085 conversion_iterator conversion_end() const {
1086 return data().Conversions.get(getASTContext()).end();
1089 /// Removes a conversion function from this class. The conversion
1090 /// function must currently be a member of this class. Furthermore,
1091 /// this class must currently be in the process of being defined.
1092 void removeConversion(const NamedDecl *Old);
1094 /// \brief Get all conversion functions visible in current class,
1095 /// including conversion function templates.
1096 llvm::iterator_range<conversion_iterator> getVisibleConversionFunctions();
1098 /// Determine whether this class is an aggregate (C++ [dcl.init.aggr]),
1099 /// which is a class with no user-declared constructors, no private
1100 /// or protected non-static data members, no base classes, and no virtual
1101 /// functions (C++ [dcl.init.aggr]p1).
1102 bool isAggregate() const { return data().Aggregate; }
1104 /// \brief Whether this class has any in-class initializers
1105 /// for non-static data members (including those in anonymous unions or
1107 bool hasInClassInitializer() const { return data().HasInClassInitializer; }
1109 /// \brief Whether this class or any of its subobjects has any members of
1110 /// reference type which would make value-initialization ill-formed.
1112 /// Per C++03 [dcl.init]p5:
1113 /// - if T is a non-union class type without a user-declared constructor,
1114 /// then every non-static data member and base-class component of T is
1115 /// value-initialized [...] A program that calls for [...]
1116 /// value-initialization of an entity of reference type is ill-formed.
1117 bool hasUninitializedReferenceMember() const {
1118 return !isUnion() && !hasUserDeclaredConstructor() &&
1119 data().HasUninitializedReferenceMember;
1122 /// \brief Whether this class is a POD-type (C++ [class]p4)
1124 /// For purposes of this function a class is POD if it is an aggregate
1125 /// that has no non-static non-POD data members, no reference data
1126 /// members, no user-defined copy assignment operator and no
1127 /// user-defined destructor.
1129 /// Note that this is the C++ TR1 definition of POD.
1130 bool isPOD() const { return data().PlainOldData; }
1132 /// \brief True if this class is C-like, without C++-specific features, e.g.
1133 /// it contains only public fields, no bases, tag kind is not 'class', etc.
1134 bool isCLike() const;
1136 /// \brief Determine whether this is an empty class in the sense of
1137 /// (C++11 [meta.unary.prop]).
1139 /// A non-union class is empty iff it has a virtual function, virtual base,
1140 /// data member (other than 0-width bit-field) or inherits from a non-empty
1143 /// \note This does NOT include a check for union-ness.
1144 bool isEmpty() const { return data().Empty; }
1146 /// Whether this class is polymorphic (C++ [class.virtual]),
1147 /// which means that the class contains or inherits a virtual function.
1148 bool isPolymorphic() const { return data().Polymorphic; }
1150 /// \brief Determine whether this class has a pure virtual function.
1152 /// The class is is abstract per (C++ [class.abstract]p2) if it declares
1153 /// a pure virtual function or inherits a pure virtual function that is
1155 bool isAbstract() const { return data().Abstract; }
1157 /// \brief Determine whether this class has standard layout per
1159 bool isStandardLayout() const { return data().IsStandardLayout; }
1161 /// \brief Determine whether this class, or any of its class subobjects,
1162 /// contains a mutable field.
1163 bool hasMutableFields() const { return data().HasMutableFields; }
1165 /// \brief Determine whether this class has any variant members.
1166 bool hasVariantMembers() const { return data().HasVariantMembers; }
1168 /// \brief Determine whether this class has a trivial default constructor
1169 /// (C++11 [class.ctor]p5).
1170 bool hasTrivialDefaultConstructor() const {
1171 return hasDefaultConstructor() &&
1172 (data().HasTrivialSpecialMembers & SMF_DefaultConstructor);
1175 /// \brief Determine whether this class has a non-trivial default constructor
1176 /// (C++11 [class.ctor]p5).
1177 bool hasNonTrivialDefaultConstructor() const {
1178 return (data().DeclaredNonTrivialSpecialMembers & SMF_DefaultConstructor) ||
1179 (needsImplicitDefaultConstructor() &&
1180 !(data().HasTrivialSpecialMembers & SMF_DefaultConstructor));
1183 /// \brief Determine whether this class has at least one constexpr constructor
1184 /// other than the copy or move constructors.
1185 bool hasConstexprNonCopyMoveConstructor() const {
1186 return data().HasConstexprNonCopyMoveConstructor ||
1187 (needsImplicitDefaultConstructor() &&
1188 defaultedDefaultConstructorIsConstexpr());
1191 /// \brief Determine whether a defaulted default constructor for this class
1192 /// would be constexpr.
1193 bool defaultedDefaultConstructorIsConstexpr() const {
1194 return data().DefaultedDefaultConstructorIsConstexpr &&
1195 (!isUnion() || hasInClassInitializer() || !hasVariantMembers());
1198 /// \brief Determine whether this class has a constexpr default constructor.
1199 bool hasConstexprDefaultConstructor() const {
1200 return data().HasConstexprDefaultConstructor ||
1201 (needsImplicitDefaultConstructor() &&
1202 defaultedDefaultConstructorIsConstexpr());
1205 /// \brief Determine whether this class has a trivial copy constructor
1206 /// (C++ [class.copy]p6, C++11 [class.copy]p12)
1207 bool hasTrivialCopyConstructor() const {
1208 return data().HasTrivialSpecialMembers & SMF_CopyConstructor;
1211 /// \brief Determine whether this class has a non-trivial copy constructor
1212 /// (C++ [class.copy]p6, C++11 [class.copy]p12)
1213 bool hasNonTrivialCopyConstructor() const {
1214 return data().DeclaredNonTrivialSpecialMembers & SMF_CopyConstructor ||
1215 !hasTrivialCopyConstructor();
1218 /// \brief Determine whether this class has a trivial move constructor
1219 /// (C++11 [class.copy]p12)
1220 bool hasTrivialMoveConstructor() const {
1221 return hasMoveConstructor() &&
1222 (data().HasTrivialSpecialMembers & SMF_MoveConstructor);
1225 /// \brief Determine whether this class has a non-trivial move constructor
1226 /// (C++11 [class.copy]p12)
1227 bool hasNonTrivialMoveConstructor() const {
1228 return (data().DeclaredNonTrivialSpecialMembers & SMF_MoveConstructor) ||
1229 (needsImplicitMoveConstructor() &&
1230 !(data().HasTrivialSpecialMembers & SMF_MoveConstructor));
1233 /// \brief Determine whether this class has a trivial copy assignment operator
1234 /// (C++ [class.copy]p11, C++11 [class.copy]p25)
1235 bool hasTrivialCopyAssignment() const {
1236 return data().HasTrivialSpecialMembers & SMF_CopyAssignment;
1239 /// \brief Determine whether this class has a non-trivial copy assignment
1240 /// operator (C++ [class.copy]p11, C++11 [class.copy]p25)
1241 bool hasNonTrivialCopyAssignment() const {
1242 return data().DeclaredNonTrivialSpecialMembers & SMF_CopyAssignment ||
1243 !hasTrivialCopyAssignment();
1246 /// \brief Determine whether this class has a trivial move assignment operator
1247 /// (C++11 [class.copy]p25)
1248 bool hasTrivialMoveAssignment() const {
1249 return hasMoveAssignment() &&
1250 (data().HasTrivialSpecialMembers & SMF_MoveAssignment);
1253 /// \brief Determine whether this class has a non-trivial move assignment
1254 /// operator (C++11 [class.copy]p25)
1255 bool hasNonTrivialMoveAssignment() const {
1256 return (data().DeclaredNonTrivialSpecialMembers & SMF_MoveAssignment) ||
1257 (needsImplicitMoveAssignment() &&
1258 !(data().HasTrivialSpecialMembers & SMF_MoveAssignment));
1261 /// \brief Determine whether this class has a trivial destructor
1262 /// (C++ [class.dtor]p3)
1263 bool hasTrivialDestructor() const {
1264 return data().HasTrivialSpecialMembers & SMF_Destructor;
1267 /// \brief Determine whether this class has a non-trivial destructor
1268 /// (C++ [class.dtor]p3)
1269 bool hasNonTrivialDestructor() const {
1270 return !(data().HasTrivialSpecialMembers & SMF_Destructor);
1273 /// \brief Determine whether this class has a destructor which has no
1274 /// semantic effect.
1276 /// Any such destructor will be trivial, public, defaulted and not deleted,
1277 /// and will call only irrelevant destructors.
1278 bool hasIrrelevantDestructor() const {
1279 return data().HasIrrelevantDestructor;
1282 /// \brief Determine whether this class has a non-literal or/ volatile type
1283 /// non-static data member or base class.
1284 bool hasNonLiteralTypeFieldsOrBases() const {
1285 return data().HasNonLiteralTypeFieldsOrBases;
1288 /// \brief Determine whether this class is considered trivially copyable per
1289 /// (C++11 [class]p6).
1290 bool isTriviallyCopyable() const;
1292 /// \brief Determine whether this class is considered trivial.
1294 /// C++11 [class]p6:
1295 /// "A trivial class is a class that has a trivial default constructor and
1296 /// is trivially copiable."
1297 bool isTrivial() const {
1298 return isTriviallyCopyable() && hasTrivialDefaultConstructor();
1301 /// \brief Determine whether this class is a literal type.
1303 /// C++11 [basic.types]p10:
1304 /// A class type that has all the following properties:
1305 /// - it has a trivial destructor
1306 /// - every constructor call and full-expression in the
1307 /// brace-or-equal-intializers for non-static data members (if any) is
1308 /// a constant expression.
1309 /// - it is an aggregate type or has at least one constexpr constructor
1310 /// or constructor template that is not a copy or move constructor, and
1311 /// - all of its non-static data members and base classes are of literal
1314 /// We resolve DR1361 by ignoring the second bullet. We resolve DR1452 by
1315 /// treating types with trivial default constructors as literal types.
1316 bool isLiteral() const {
1317 return hasTrivialDestructor() &&
1318 (isAggregate() || hasConstexprNonCopyMoveConstructor() ||
1319 hasTrivialDefaultConstructor()) &&
1320 !hasNonLiteralTypeFieldsOrBases();
1323 /// \brief If this record is an instantiation of a member class,
1324 /// retrieves the member class from which it was instantiated.
1326 /// This routine will return non-null for (non-templated) member
1327 /// classes of class templates. For example, given:
1330 /// template<typename T>
1336 /// The declaration for X<int>::A is a (non-templated) CXXRecordDecl
1337 /// whose parent is the class template specialization X<int>. For
1338 /// this declaration, getInstantiatedFromMemberClass() will return
1339 /// the CXXRecordDecl X<T>::A. When a complete definition of
1340 /// X<int>::A is required, it will be instantiated from the
1341 /// declaration returned by getInstantiatedFromMemberClass().
1342 CXXRecordDecl *getInstantiatedFromMemberClass() const;
1344 /// \brief If this class is an instantiation of a member class of a
1345 /// class template specialization, retrieves the member specialization
1347 MemberSpecializationInfo *getMemberSpecializationInfo() const;
1349 /// \brief Specify that this record is an instantiation of the
1350 /// member class \p RD.
1351 void setInstantiationOfMemberClass(CXXRecordDecl *RD,
1352 TemplateSpecializationKind TSK);
1354 /// \brief Retrieves the class template that is described by this
1355 /// class declaration.
1357 /// Every class template is represented as a ClassTemplateDecl and a
1358 /// CXXRecordDecl. The former contains template properties (such as
1359 /// the template parameter lists) while the latter contains the
1360 /// actual description of the template's
1361 /// contents. ClassTemplateDecl::getTemplatedDecl() retrieves the
1362 /// CXXRecordDecl that from a ClassTemplateDecl, while
1363 /// getDescribedClassTemplate() retrieves the ClassTemplateDecl from
1364 /// a CXXRecordDecl.
1365 ClassTemplateDecl *getDescribedClassTemplate() const;
1367 void setDescribedClassTemplate(ClassTemplateDecl *Template);
1369 /// \brief Determine whether this particular class is a specialization or
1370 /// instantiation of a class template or member class of a class template,
1371 /// and how it was instantiated or specialized.
1372 TemplateSpecializationKind getTemplateSpecializationKind() const;
1374 /// \brief Set the kind of specialization or template instantiation this is.
1375 void setTemplateSpecializationKind(TemplateSpecializationKind TSK);
1377 /// \brief Retrieve the record declaration from which this record could be
1378 /// instantiated. Returns null if this class is not a template instantiation.
1379 const CXXRecordDecl *getTemplateInstantiationPattern() const;
1381 CXXRecordDecl *getTemplateInstantiationPattern() {
1382 return const_cast<CXXRecordDecl *>(const_cast<const CXXRecordDecl *>(this)
1383 ->getTemplateInstantiationPattern());
1386 /// \brief Returns the destructor decl for this class.
1387 CXXDestructorDecl *getDestructor() const;
1389 /// \brief Returns true if the class destructor, or any implicitly invoked
1390 /// destructors are marked noreturn.
1391 bool isAnyDestructorNoReturn() const;
1393 /// \brief If the class is a local class [class.local], returns
1394 /// the enclosing function declaration.
1395 const FunctionDecl *isLocalClass() const {
1396 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(getDeclContext()))
1397 return RD->isLocalClass();
1399 return dyn_cast<FunctionDecl>(getDeclContext());
1402 FunctionDecl *isLocalClass() {
1403 return const_cast<FunctionDecl*>(
1404 const_cast<const CXXRecordDecl*>(this)->isLocalClass());
1407 /// \brief Determine whether this dependent class is a current instantiation,
1408 /// when viewed from within the given context.
1409 bool isCurrentInstantiation(const DeclContext *CurContext) const;
1411 /// \brief Determine whether this class is derived from the class \p Base.
1413 /// This routine only determines whether this class is derived from \p Base,
1414 /// but does not account for factors that may make a Derived -> Base class
1415 /// ill-formed, such as private/protected inheritance or multiple, ambiguous
1416 /// base class subobjects.
1418 /// \param Base the base class we are searching for.
1420 /// \returns true if this class is derived from Base, false otherwise.
1421 bool isDerivedFrom(const CXXRecordDecl *Base) const;
1423 /// \brief Determine whether this class is derived from the type \p Base.
1425 /// This routine only determines whether this class is derived from \p Base,
1426 /// but does not account for factors that may make a Derived -> Base class
1427 /// ill-formed, such as private/protected inheritance or multiple, ambiguous
1428 /// base class subobjects.
1430 /// \param Base the base class we are searching for.
1432 /// \param Paths will contain the paths taken from the current class to the
1433 /// given \p Base class.
1435 /// \returns true if this class is derived from \p Base, false otherwise.
1437 /// \todo add a separate parameter to configure IsDerivedFrom, rather than
1438 /// tangling input and output in \p Paths
1439 bool isDerivedFrom(const CXXRecordDecl *Base, CXXBasePaths &Paths) const;
1441 /// \brief Determine whether this class is virtually derived from
1442 /// the class \p Base.
1444 /// This routine only determines whether this class is virtually
1445 /// derived from \p Base, but does not account for factors that may
1446 /// make a Derived -> Base class ill-formed, such as
1447 /// private/protected inheritance or multiple, ambiguous base class
1450 /// \param Base the base class we are searching for.
1452 /// \returns true if this class is virtually derived from Base,
1453 /// false otherwise.
1454 bool isVirtuallyDerivedFrom(const CXXRecordDecl *Base) const;
1456 /// \brief Determine whether this class is provably not derived from
1457 /// the type \p Base.
1458 bool isProvablyNotDerivedFrom(const CXXRecordDecl *Base) const;
1460 /// \brief Function type used by forallBases() as a callback.
1462 /// \param BaseDefinition the definition of the base class
1464 /// \returns true if this base matched the search criteria
1465 typedef llvm::function_ref<bool(const CXXRecordDecl *BaseDefinition)>
1466 ForallBasesCallback;
1468 /// \brief Determines if the given callback holds for all the direct
1469 /// or indirect base classes of this type.
1471 /// The class itself does not count as a base class. This routine
1472 /// returns false if the class has non-computable base classes.
1474 /// \param BaseMatches Callback invoked for each (direct or indirect) base
1475 /// class of this type, or if \p AllowShortCircuit is true then until a call
1478 /// \param AllowShortCircuit if false, forces the callback to be called
1479 /// for every base class, even if a dependent or non-matching base was
1481 bool forallBases(ForallBasesCallback BaseMatches,
1482 bool AllowShortCircuit = true) const;
1484 /// \brief Function type used by lookupInBases() to determine whether a
1485 /// specific base class subobject matches the lookup criteria.
1487 /// \param Specifier the base-class specifier that describes the inheritance
1488 /// from the base class we are trying to match.
1490 /// \param Path the current path, from the most-derived class down to the
1491 /// base named by the \p Specifier.
1493 /// \returns true if this base matched the search criteria, false otherwise.
1494 typedef llvm::function_ref<bool(const CXXBaseSpecifier *Specifier,
1495 CXXBasePath &Path)> BaseMatchesCallback;
1497 /// \brief Look for entities within the base classes of this C++ class,
1498 /// transitively searching all base class subobjects.
1500 /// This routine uses the callback function \p BaseMatches to find base
1501 /// classes meeting some search criteria, walking all base class subobjects
1502 /// and populating the given \p Paths structure with the paths through the
1503 /// inheritance hierarchy that resulted in a match. On a successful search,
1504 /// the \p Paths structure can be queried to retrieve the matching paths and
1505 /// to determine if there were any ambiguities.
1507 /// \param BaseMatches callback function used to determine whether a given
1508 /// base matches the user-defined search criteria.
1510 /// \param Paths used to record the paths from this class to its base class
1511 /// subobjects that match the search criteria.
1513 /// \returns true if there exists any path from this class to a base class
1514 /// subobject that matches the search criteria.
1515 bool lookupInBases(BaseMatchesCallback BaseMatches,
1516 CXXBasePaths &Paths) const;
1518 /// \brief Base-class lookup callback that determines whether the given
1519 /// base class specifier refers to a specific class declaration.
1521 /// This callback can be used with \c lookupInBases() to determine whether
1522 /// a given derived class has is a base class subobject of a particular type.
1523 /// The base record pointer should refer to the canonical CXXRecordDecl of the
1524 /// base class that we are searching for.
1525 static bool FindBaseClass(const CXXBaseSpecifier *Specifier,
1526 CXXBasePath &Path, const CXXRecordDecl *BaseRecord);
1528 /// \brief Base-class lookup callback that determines whether the
1529 /// given base class specifier refers to a specific class
1530 /// declaration and describes virtual derivation.
1532 /// This callback can be used with \c lookupInBases() to determine
1533 /// whether a given derived class has is a virtual base class
1534 /// subobject of a particular type. The base record pointer should
1535 /// refer to the canonical CXXRecordDecl of the base class that we
1536 /// are searching for.
1537 static bool FindVirtualBaseClass(const CXXBaseSpecifier *Specifier,
1539 const CXXRecordDecl *BaseRecord);
1541 /// \brief Base-class lookup callback that determines whether there exists
1542 /// a tag with the given name.
1544 /// This callback can be used with \c lookupInBases() to find tag members
1545 /// of the given name within a C++ class hierarchy.
1546 static bool FindTagMember(const CXXBaseSpecifier *Specifier,
1547 CXXBasePath &Path, DeclarationName Name);
1549 /// \brief Base-class lookup callback that determines whether there exists
1550 /// a member with the given name.
1552 /// This callback can be used with \c lookupInBases() to find members
1553 /// of the given name within a C++ class hierarchy.
1554 static bool FindOrdinaryMember(const CXXBaseSpecifier *Specifier,
1555 CXXBasePath &Path, DeclarationName Name);
1557 /// \brief Base-class lookup callback that determines whether there exists
1558 /// a member with the given name that can be used in a nested-name-specifier.
1560 /// This callback can be used with \c lookupInBases() to find members of
1561 /// the given name within a C++ class hierarchy that can occur within
1562 /// nested-name-specifiers.
1563 static bool FindNestedNameSpecifierMember(const CXXBaseSpecifier *Specifier,
1565 DeclarationName Name);
1567 /// \brief Retrieve the final overriders for each virtual member
1568 /// function in the class hierarchy where this class is the
1569 /// most-derived class in the class hierarchy.
1570 void getFinalOverriders(CXXFinalOverriderMap &FinaOverriders) const;
1572 /// \brief Get the indirect primary bases for this class.
1573 void getIndirectPrimaryBases(CXXIndirectPrimaryBaseSet& Bases) const;
1575 /// Renders and displays an inheritance diagram
1576 /// for this C++ class and all of its base classes (transitively) using
1578 void viewInheritance(ASTContext& Context) const;
1580 /// \brief Calculates the access of a decl that is reached
1582 static AccessSpecifier MergeAccess(AccessSpecifier PathAccess,
1583 AccessSpecifier DeclAccess) {
1584 assert(DeclAccess != AS_none);
1585 if (DeclAccess == AS_private) return AS_none;
1586 return (PathAccess > DeclAccess ? PathAccess : DeclAccess);
1589 /// \brief Indicates that the declaration of a defaulted or deleted special
1590 /// member function is now complete.
1591 void finishedDefaultedOrDeletedMember(CXXMethodDecl *MD);
1593 /// \brief Indicates that the definition of this class is now complete.
1594 void completeDefinition() override;
1596 /// \brief Indicates that the definition of this class is now complete,
1597 /// and provides a final overrider map to help determine
1599 /// \param FinalOverriders The final overrider map for this class, which can
1600 /// be provided as an optimization for abstract-class checking. If NULL,
1601 /// final overriders will be computed if they are needed to complete the
1603 void completeDefinition(CXXFinalOverriderMap *FinalOverriders);
1605 /// \brief Determine whether this class may end up being abstract, even though
1606 /// it is not yet known to be abstract.
1608 /// \returns true if this class is not known to be abstract but has any
1609 /// base classes that are abstract. In this case, \c completeDefinition()
1610 /// will need to compute final overriders to determine whether the class is
1611 /// actually abstract.
1612 bool mayBeAbstract() const;
1614 /// \brief If this is the closure type of a lambda expression, retrieve the
1615 /// number to be used for name mangling in the Itanium C++ ABI.
1617 /// Zero indicates that this closure type has internal linkage, so the
1618 /// mangling number does not matter, while a non-zero value indicates which
1619 /// lambda expression this is in this particular context.
1620 unsigned getLambdaManglingNumber() const {
1621 assert(isLambda() && "Not a lambda closure type!");
1622 return getLambdaData().ManglingNumber;
1625 /// \brief Retrieve the declaration that provides additional context for a
1626 /// lambda, when the normal declaration context is not specific enough.
1628 /// Certain contexts (default arguments of in-class function parameters and
1629 /// the initializers of data members) have separate name mangling rules for
1630 /// lambdas within the Itanium C++ ABI. For these cases, this routine provides
1631 /// the declaration in which the lambda occurs, e.g., the function parameter
1632 /// or the non-static data member. Otherwise, it returns NULL to imply that
1633 /// the declaration context suffices.
1634 Decl *getLambdaContextDecl() const {
1635 assert(isLambda() && "Not a lambda closure type!");
1636 return getLambdaData().ContextDecl;
1639 /// \brief Set the mangling number and context declaration for a lambda
1641 void setLambdaMangling(unsigned ManglingNumber, Decl *ContextDecl) {
1642 getLambdaData().ManglingNumber = ManglingNumber;
1643 getLambdaData().ContextDecl = ContextDecl;
1646 /// \brief Returns the inheritance model used for this record.
1647 MSInheritanceAttr::Spelling getMSInheritanceModel() const;
1648 /// \brief Calculate what the inheritance model would be for this class.
1649 MSInheritanceAttr::Spelling calculateInheritanceModel() const;
1651 /// In the Microsoft C++ ABI, use zero for the field offset of a null data
1652 /// member pointer if we can guarantee that zero is not a valid field offset,
1653 /// or if the member pointer has multiple fields. Polymorphic classes have a
1654 /// vfptr at offset zero, so we can use zero for null. If there are multiple
1655 /// fields, we can use zero even if it is a valid field offset because
1656 /// null-ness testing will check the other fields.
1657 bool nullFieldOffsetIsZero() const {
1658 return !MSInheritanceAttr::hasOnlyOneField(/*IsMemberFunction=*/false,
1659 getMSInheritanceModel()) ||
1660 (hasDefinition() && isPolymorphic());
1663 /// \brief Controls when vtordisps will be emitted if this record is used as a
1665 MSVtorDispAttr::Mode getMSVtorDispMode() const;
1667 /// \brief Determine whether this lambda expression was known to be dependent
1668 /// at the time it was created, even if its context does not appear to be
1671 /// This flag is a workaround for an issue with parsing, where default
1672 /// arguments are parsed before their enclosing function declarations have
1673 /// been created. This means that any lambda expressions within those
1674 /// default arguments will have as their DeclContext the context enclosing
1675 /// the function declaration, which may be non-dependent even when the
1676 /// function declaration itself is dependent. This flag indicates when we
1677 /// know that the lambda is dependent despite that.
1678 bool isDependentLambda() const {
1679 return isLambda() && getLambdaData().Dependent;
1682 TypeSourceInfo *getLambdaTypeInfo() const {
1683 return getLambdaData().MethodTyInfo;
1686 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1687 static bool classofKind(Kind K) {
1688 return K >= firstCXXRecord && K <= lastCXXRecord;
1691 friend class ASTDeclReader;
1692 friend class ASTDeclWriter;
1693 friend class ASTReader;
1694 friend class ASTWriter;
1697 /// \brief Represents a static or instance method of a struct/union/class.
1699 /// In the terminology of the C++ Standard, these are the (static and
1700 /// non-static) member functions, whether virtual or not.
1701 class CXXMethodDecl : public FunctionDecl {
1702 void anchor() override;
1704 CXXMethodDecl(Kind DK, ASTContext &C, CXXRecordDecl *RD,
1705 SourceLocation StartLoc, const DeclarationNameInfo &NameInfo,
1706 QualType T, TypeSourceInfo *TInfo,
1707 StorageClass SC, bool isInline,
1708 bool isConstexpr, SourceLocation EndLocation)
1709 : FunctionDecl(DK, C, RD, StartLoc, NameInfo, T, TInfo,
1710 SC, isInline, isConstexpr) {
1711 if (EndLocation.isValid())
1712 setRangeEnd(EndLocation);
1716 static CXXMethodDecl *Create(ASTContext &C, CXXRecordDecl *RD,
1717 SourceLocation StartLoc,
1718 const DeclarationNameInfo &NameInfo,
1719 QualType T, TypeSourceInfo *TInfo,
1723 SourceLocation EndLocation);
1725 static CXXMethodDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1727 bool isStatic() const;
1728 bool isInstance() const { return !isStatic(); }
1730 /// Returns true if the given operator is implicitly static in a record
1732 static bool isStaticOverloadedOperator(OverloadedOperatorKind OOK) {
1734 // Any allocation function for a class T is a static member
1735 // (even if not explicitly declared static).
1736 // [class.free]p6 Any deallocation function for a class X is a static member
1737 // (even if not explicitly declared static).
1738 return OOK == OO_New || OOK == OO_Array_New || OOK == OO_Delete ||
1739 OOK == OO_Array_Delete;
1742 bool isConst() const { return getType()->castAs<FunctionType>()->isConst(); }
1743 bool isVolatile() const { return getType()->castAs<FunctionType>()->isVolatile(); }
1745 bool isVirtual() const {
1747 cast<CXXMethodDecl>(const_cast<CXXMethodDecl*>(this)->getCanonicalDecl());
1749 // Member function is virtual if it is marked explicitly so, or if it is
1750 // declared in __interface -- then it is automatically pure virtual.
1751 if (CD->isVirtualAsWritten() || CD->isPure())
1754 return (CD->begin_overridden_methods() != CD->end_overridden_methods());
1757 /// \brief Determine whether this is a usual deallocation function
1758 /// (C++ [basic.stc.dynamic.deallocation]p2), which is an overloaded
1759 /// delete or delete[] operator with a particular signature.
1760 bool isUsualDeallocationFunction() const;
1762 /// \brief Determine whether this is a copy-assignment operator, regardless
1763 /// of whether it was declared implicitly or explicitly.
1764 bool isCopyAssignmentOperator() const;
1766 /// \brief Determine whether this is a move assignment operator.
1767 bool isMoveAssignmentOperator() const;
1769 CXXMethodDecl *getCanonicalDecl() override {
1770 return cast<CXXMethodDecl>(FunctionDecl::getCanonicalDecl());
1772 const CXXMethodDecl *getCanonicalDecl() const {
1773 return const_cast<CXXMethodDecl*>(this)->getCanonicalDecl();
1776 CXXMethodDecl *getMostRecentDecl() {
1777 return cast<CXXMethodDecl>(
1778 static_cast<FunctionDecl *>(this)->getMostRecentDecl());
1780 const CXXMethodDecl *getMostRecentDecl() const {
1781 return const_cast<CXXMethodDecl*>(this)->getMostRecentDecl();
1784 /// True if this method is user-declared and was not
1785 /// deleted or defaulted on its first declaration.
1786 bool isUserProvided() const {
1787 return !(isDeleted() || getCanonicalDecl()->isDefaulted());
1791 void addOverriddenMethod(const CXXMethodDecl *MD);
1793 typedef const CXXMethodDecl *const* method_iterator;
1795 method_iterator begin_overridden_methods() const;
1796 method_iterator end_overridden_methods() const;
1797 unsigned size_overridden_methods() const;
1799 /// Returns the parent of this method declaration, which
1800 /// is the class in which this method is defined.
1801 const CXXRecordDecl *getParent() const {
1802 return cast<CXXRecordDecl>(FunctionDecl::getParent());
1805 /// Returns the parent of this method declaration, which
1806 /// is the class in which this method is defined.
1807 CXXRecordDecl *getParent() {
1808 return const_cast<CXXRecordDecl *>(
1809 cast<CXXRecordDecl>(FunctionDecl::getParent()));
1812 /// \brief Returns the type of the \c this pointer.
1814 /// Should only be called for instance (i.e., non-static) methods.
1815 QualType getThisType(ASTContext &C) const;
1817 unsigned getTypeQualifiers() const {
1818 return getType()->getAs<FunctionProtoType>()->getTypeQuals();
1821 /// \brief Retrieve the ref-qualifier associated with this method.
1823 /// In the following example, \c f() has an lvalue ref-qualifier, \c g()
1824 /// has an rvalue ref-qualifier, and \c h() has no ref-qualifier.
1832 RefQualifierKind getRefQualifier() const {
1833 return getType()->getAs<FunctionProtoType>()->getRefQualifier();
1836 bool hasInlineBody() const;
1838 /// \brief Determine whether this is a lambda closure type's static member
1839 /// function that is used for the result of the lambda's conversion to
1840 /// function pointer (for a lambda with no captures).
1842 /// The function itself, if used, will have a placeholder body that will be
1843 /// supplied by IR generation to either forward to the function call operator
1844 /// or clone the function call operator.
1845 bool isLambdaStaticInvoker() const;
1847 /// \brief Find the method in \p RD that corresponds to this one.
1849 /// Find if \p RD or one of the classes it inherits from override this method.
1850 /// If so, return it. \p RD is assumed to be a subclass of the class defining
1851 /// this method (or be the class itself), unless \p MayBeBase is set to true.
1853 getCorrespondingMethodInClass(const CXXRecordDecl *RD,
1854 bool MayBeBase = false);
1856 const CXXMethodDecl *
1857 getCorrespondingMethodInClass(const CXXRecordDecl *RD,
1858 bool MayBeBase = false) const {
1859 return const_cast<CXXMethodDecl *>(this)
1860 ->getCorrespondingMethodInClass(RD, MayBeBase);
1863 // Implement isa/cast/dyncast/etc.
1864 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1865 static bool classofKind(Kind K) {
1866 return K >= firstCXXMethod && K <= lastCXXMethod;
1870 /// \brief Represents a C++ base or member initializer.
1872 /// This is part of a constructor initializer that
1873 /// initializes one non-static member variable or one base class. For
1874 /// example, in the following, both 'A(a)' and 'f(3.14159)' are member
1879 /// class B : public A {
1882 /// B(A& a) : A(a), f(3.14159) { }
1885 class CXXCtorInitializer final
1886 : private llvm::TrailingObjects<CXXCtorInitializer, VarDecl *> {
1887 /// \brief Either the base class name/delegating constructor type (stored as
1888 /// a TypeSourceInfo*), an normal field (FieldDecl), or an anonymous field
1889 /// (IndirectFieldDecl*) being initialized.
1890 llvm::PointerUnion3<TypeSourceInfo *, FieldDecl *, IndirectFieldDecl *>
1893 /// \brief The source location for the field name or, for a base initializer
1894 /// pack expansion, the location of the ellipsis.
1896 /// In the case of a delegating
1897 /// constructor, it will still include the type's source location as the
1898 /// Initializee points to the CXXConstructorDecl (to allow loop detection).
1899 SourceLocation MemberOrEllipsisLocation;
1901 /// \brief The argument used to initialize the base or member, which may
1902 /// end up constructing an object (when multiple arguments are involved).
1905 /// \brief Location of the left paren of the ctor-initializer.
1906 SourceLocation LParenLoc;
1908 /// \brief Location of the right paren of the ctor-initializer.
1909 SourceLocation RParenLoc;
1911 /// \brief If the initializee is a type, whether that type makes this
1912 /// a delegating initialization.
1913 bool IsDelegating : 1;
1915 /// \brief If the initializer is a base initializer, this keeps track
1916 /// of whether the base is virtual or not.
1919 /// \brief Whether or not the initializer is explicitly written
1923 /// If IsWritten is true, then this number keeps track of the textual order
1924 /// of this initializer in the original sources, counting from 0; otherwise,
1925 /// it stores the number of array index variables stored after this object
1927 unsigned SourceOrderOrNumArrayIndices : 13;
1929 CXXCtorInitializer(ASTContext &Context, FieldDecl *Member,
1930 SourceLocation MemberLoc, SourceLocation L, Expr *Init,
1931 SourceLocation R, VarDecl **Indices, unsigned NumIndices);
1934 /// \brief Creates a new base-class initializer.
1936 CXXCtorInitializer(ASTContext &Context, TypeSourceInfo *TInfo, bool IsVirtual,
1937 SourceLocation L, Expr *Init, SourceLocation R,
1938 SourceLocation EllipsisLoc);
1940 /// \brief Creates a new member initializer.
1942 CXXCtorInitializer(ASTContext &Context, FieldDecl *Member,
1943 SourceLocation MemberLoc, SourceLocation L, Expr *Init,
1946 /// \brief Creates a new anonymous field initializer.
1948 CXXCtorInitializer(ASTContext &Context, IndirectFieldDecl *Member,
1949 SourceLocation MemberLoc, SourceLocation L, Expr *Init,
1952 /// \brief Creates a new delegating initializer.
1954 CXXCtorInitializer(ASTContext &Context, TypeSourceInfo *TInfo,
1955 SourceLocation L, Expr *Init, SourceLocation R);
1957 /// \brief Creates a new member initializer that optionally contains
1958 /// array indices used to describe an elementwise initialization.
1959 static CXXCtorInitializer *Create(ASTContext &Context, FieldDecl *Member,
1960 SourceLocation MemberLoc, SourceLocation L,
1961 Expr *Init, SourceLocation R,
1962 VarDecl **Indices, unsigned NumIndices);
1964 /// \brief Determine whether this initializer is initializing a base class.
1965 bool isBaseInitializer() const {
1966 return Initializee.is<TypeSourceInfo*>() && !IsDelegating;
1969 /// \brief Determine whether this initializer is initializing a non-static
1971 bool isMemberInitializer() const { return Initializee.is<FieldDecl*>(); }
1973 bool isAnyMemberInitializer() const {
1974 return isMemberInitializer() || isIndirectMemberInitializer();
1977 bool isIndirectMemberInitializer() const {
1978 return Initializee.is<IndirectFieldDecl*>();
1981 /// \brief Determine whether this initializer is an implicit initializer
1982 /// generated for a field with an initializer defined on the member
1985 /// In-class member initializers (also known as "non-static data member
1986 /// initializations", NSDMIs) were introduced in C++11.
1987 bool isInClassMemberInitializer() const {
1988 return Init->getStmtClass() == Stmt::CXXDefaultInitExprClass;
1991 /// \brief Determine whether this initializer is creating a delegating
1993 bool isDelegatingInitializer() const {
1994 return Initializee.is<TypeSourceInfo*>() && IsDelegating;
1997 /// \brief Determine whether this initializer is a pack expansion.
1998 bool isPackExpansion() const {
1999 return isBaseInitializer() && MemberOrEllipsisLocation.isValid();
2002 // \brief For a pack expansion, returns the location of the ellipsis.
2003 SourceLocation getEllipsisLoc() const {
2004 assert(isPackExpansion() && "Initializer is not a pack expansion");
2005 return MemberOrEllipsisLocation;
2008 /// If this is a base class initializer, returns the type of the
2009 /// base class with location information. Otherwise, returns an NULL
2011 TypeLoc getBaseClassLoc() const;
2013 /// If this is a base class initializer, returns the type of the base class.
2014 /// Otherwise, returns null.
2015 const Type *getBaseClass() const;
2017 /// Returns whether the base is virtual or not.
2018 bool isBaseVirtual() const {
2019 assert(isBaseInitializer() && "Must call this on base initializer!");
2024 /// \brief Returns the declarator information for a base class or delegating
2026 TypeSourceInfo *getTypeSourceInfo() const {
2027 return Initializee.dyn_cast<TypeSourceInfo *>();
2030 /// \brief If this is a member initializer, returns the declaration of the
2031 /// non-static data member being initialized. Otherwise, returns null.
2032 FieldDecl *getMember() const {
2033 if (isMemberInitializer())
2034 return Initializee.get<FieldDecl*>();
2037 FieldDecl *getAnyMember() const {
2038 if (isMemberInitializer())
2039 return Initializee.get<FieldDecl*>();
2040 if (isIndirectMemberInitializer())
2041 return Initializee.get<IndirectFieldDecl*>()->getAnonField();
2045 IndirectFieldDecl *getIndirectMember() const {
2046 if (isIndirectMemberInitializer())
2047 return Initializee.get<IndirectFieldDecl*>();
2051 SourceLocation getMemberLocation() const {
2052 return MemberOrEllipsisLocation;
2055 /// \brief Determine the source location of the initializer.
2056 SourceLocation getSourceLocation() const;
2058 /// \brief Determine the source range covering the entire initializer.
2059 SourceRange getSourceRange() const LLVM_READONLY;
2061 /// \brief Determine whether this initializer is explicitly written
2062 /// in the source code.
2063 bool isWritten() const { return IsWritten; }
2065 /// \brief Return the source position of the initializer, counting from 0.
2066 /// If the initializer was implicit, -1 is returned.
2067 int getSourceOrder() const {
2068 return IsWritten ? static_cast<int>(SourceOrderOrNumArrayIndices) : -1;
2071 /// \brief Set the source order of this initializer.
2073 /// This can only be called once for each initializer; it cannot be called
2074 /// on an initializer having a positive number of (implicit) array indices.
2076 /// This assumes that the initializer was written in the source code, and
2077 /// ensures that isWritten() returns true.
2078 void setSourceOrder(int pos) {
2079 assert(!IsWritten &&
2080 "calling twice setSourceOrder() on the same initializer");
2081 assert(SourceOrderOrNumArrayIndices == 0 &&
2082 "setSourceOrder() used when there are implicit array indices");
2084 "setSourceOrder() used to make an initializer implicit");
2086 SourceOrderOrNumArrayIndices = static_cast<unsigned>(pos);
2089 SourceLocation getLParenLoc() const { return LParenLoc; }
2090 SourceLocation getRParenLoc() const { return RParenLoc; }
2092 /// \brief Determine the number of implicit array indices used while
2093 /// described an array member initialization.
2094 unsigned getNumArrayIndices() const {
2095 return IsWritten ? 0 : SourceOrderOrNumArrayIndices;
2098 /// \brief Retrieve a particular array index variable used to
2099 /// describe an array member initialization.
2100 VarDecl *getArrayIndex(unsigned I) {
2101 assert(I < getNumArrayIndices() && "Out of bounds member array index");
2102 return getTrailingObjects<VarDecl *>()[I];
2104 const VarDecl *getArrayIndex(unsigned I) const {
2105 assert(I < getNumArrayIndices() && "Out of bounds member array index");
2106 return getTrailingObjects<VarDecl *>()[I];
2108 void setArrayIndex(unsigned I, VarDecl *Index) {
2109 assert(I < getNumArrayIndices() && "Out of bounds member array index");
2110 getTrailingObjects<VarDecl *>()[I] = Index;
2112 ArrayRef<VarDecl *> getArrayIndexes() {
2113 assert(getNumArrayIndices() != 0 && "Getting indexes for non-array init");
2114 return llvm::makeArrayRef(getTrailingObjects<VarDecl *>(),
2115 getNumArrayIndices());
2118 /// \brief Get the initializer.
2119 Expr *getInit() const { return static_cast<Expr*>(Init); }
2121 friend TrailingObjects;
2124 /// \brief Represents a C++ constructor within a class.
2131 /// explicit X(int); // represented by a CXXConstructorDecl.
2134 class CXXConstructorDecl : public CXXMethodDecl {
2135 void anchor() override;
2136 /// \brief Whether this constructor declaration has the \c explicit keyword
2138 bool IsExplicitSpecified : 1;
2140 /// \name Support for base and member initializers.
2142 /// \brief The arguments used to initialize the base or member.
2143 LazyCXXCtorInitializersPtr CtorInitializers;
2144 unsigned NumCtorInitializers;
2147 CXXConstructorDecl(ASTContext &C, CXXRecordDecl *RD, SourceLocation StartLoc,
2148 const DeclarationNameInfo &NameInfo,
2149 QualType T, TypeSourceInfo *TInfo,
2150 bool isExplicitSpecified, bool isInline,
2151 bool isImplicitlyDeclared, bool isConstexpr)
2152 : CXXMethodDecl(CXXConstructor, C, RD, StartLoc, NameInfo, T, TInfo,
2153 SC_None, isInline, isConstexpr, SourceLocation()),
2154 IsExplicitSpecified(isExplicitSpecified), CtorInitializers(nullptr),
2155 NumCtorInitializers(0) {
2156 setImplicit(isImplicitlyDeclared);
2160 static CXXConstructorDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2161 static CXXConstructorDecl *Create(ASTContext &C, CXXRecordDecl *RD,
2162 SourceLocation StartLoc,
2163 const DeclarationNameInfo &NameInfo,
2164 QualType T, TypeSourceInfo *TInfo,
2166 bool isInline, bool isImplicitlyDeclared,
2169 /// \brief Determine whether this constructor declaration has the
2170 /// \c explicit keyword specified.
2171 bool isExplicitSpecified() const { return IsExplicitSpecified; }
2173 /// \brief Determine whether this constructor was marked "explicit" or not.
2174 bool isExplicit() const {
2175 return cast<CXXConstructorDecl>(getFirstDecl())->isExplicitSpecified();
2178 /// \brief Iterates through the member/base initializer list.
2179 typedef CXXCtorInitializer **init_iterator;
2181 /// \brief Iterates through the member/base initializer list.
2182 typedef CXXCtorInitializer *const *init_const_iterator;
2184 typedef llvm::iterator_range<init_iterator> init_range;
2185 typedef llvm::iterator_range<init_const_iterator> init_const_range;
2187 init_range inits() { return init_range(init_begin(), init_end()); }
2188 init_const_range inits() const {
2189 return init_const_range(init_begin(), init_end());
2192 /// \brief Retrieve an iterator to the first initializer.
2193 init_iterator init_begin() {
2194 const auto *ConstThis = this;
2195 return const_cast<init_iterator>(ConstThis->init_begin());
2197 /// \brief Retrieve an iterator to the first initializer.
2198 init_const_iterator init_begin() const;
2200 /// \brief Retrieve an iterator past the last initializer.
2201 init_iterator init_end() {
2202 return init_begin() + NumCtorInitializers;
2204 /// \brief Retrieve an iterator past the last initializer.
2205 init_const_iterator init_end() const {
2206 return init_begin() + NumCtorInitializers;
2209 typedef std::reverse_iterator<init_iterator> init_reverse_iterator;
2210 typedef std::reverse_iterator<init_const_iterator>
2211 init_const_reverse_iterator;
2213 init_reverse_iterator init_rbegin() {
2214 return init_reverse_iterator(init_end());
2216 init_const_reverse_iterator init_rbegin() const {
2217 return init_const_reverse_iterator(init_end());
2220 init_reverse_iterator init_rend() {
2221 return init_reverse_iterator(init_begin());
2223 init_const_reverse_iterator init_rend() const {
2224 return init_const_reverse_iterator(init_begin());
2227 /// \brief Determine the number of arguments used to initialize the member
2229 unsigned getNumCtorInitializers() const {
2230 return NumCtorInitializers;
2233 void setNumCtorInitializers(unsigned numCtorInitializers) {
2234 NumCtorInitializers = numCtorInitializers;
2237 void setCtorInitializers(CXXCtorInitializer **Initializers) {
2238 CtorInitializers = Initializers;
2241 /// \brief Determine whether this constructor is a delegating constructor.
2242 bool isDelegatingConstructor() const {
2243 return (getNumCtorInitializers() == 1) &&
2244 init_begin()[0]->isDelegatingInitializer();
2247 /// \brief When this constructor delegates to another, retrieve the target.
2248 CXXConstructorDecl *getTargetConstructor() const;
2250 /// Whether this constructor is a default
2251 /// constructor (C++ [class.ctor]p5), which can be used to
2252 /// default-initialize a class of this type.
2253 bool isDefaultConstructor() const;
2255 /// \brief Whether this constructor is a copy constructor (C++ [class.copy]p2,
2256 /// which can be used to copy the class.
2258 /// \p TypeQuals will be set to the qualifiers on the
2259 /// argument type. For example, \p TypeQuals would be set to \c
2260 /// Qualifiers::Const for the following copy constructor:
2268 bool isCopyConstructor(unsigned &TypeQuals) const;
2270 /// Whether this constructor is a copy
2271 /// constructor (C++ [class.copy]p2, which can be used to copy the
2273 bool isCopyConstructor() const {
2274 unsigned TypeQuals = 0;
2275 return isCopyConstructor(TypeQuals);
2278 /// \brief Determine whether this constructor is a move constructor
2279 /// (C++11 [class.copy]p3), which can be used to move values of the class.
2281 /// \param TypeQuals If this constructor is a move constructor, will be set
2282 /// to the type qualifiers on the referent of the first parameter's type.
2283 bool isMoveConstructor(unsigned &TypeQuals) const;
2285 /// \brief Determine whether this constructor is a move constructor
2286 /// (C++11 [class.copy]p3), which can be used to move values of the class.
2287 bool isMoveConstructor() const {
2288 unsigned TypeQuals = 0;
2289 return isMoveConstructor(TypeQuals);
2292 /// \brief Determine whether this is a copy or move constructor.
2294 /// \param TypeQuals Will be set to the type qualifiers on the reference
2295 /// parameter, if in fact this is a copy or move constructor.
2296 bool isCopyOrMoveConstructor(unsigned &TypeQuals) const;
2298 /// \brief Determine whether this a copy or move constructor.
2299 bool isCopyOrMoveConstructor() const {
2301 return isCopyOrMoveConstructor(Quals);
2304 /// Whether this constructor is a
2305 /// converting constructor (C++ [class.conv.ctor]), which can be
2306 /// used for user-defined conversions.
2307 bool isConvertingConstructor(bool AllowExplicit) const;
2309 /// \brief Determine whether this is a member template specialization that
2310 /// would copy the object to itself. Such constructors are never used to copy
2312 bool isSpecializationCopyingObject() const;
2314 /// \brief Get the constructor that this inheriting constructor is based on.
2315 const CXXConstructorDecl *getInheritedConstructor() const;
2317 /// \brief Set the constructor that this inheriting constructor is based on.
2318 void setInheritedConstructor(const CXXConstructorDecl *BaseCtor);
2320 CXXConstructorDecl *getCanonicalDecl() override {
2321 return cast<CXXConstructorDecl>(FunctionDecl::getCanonicalDecl());
2323 const CXXConstructorDecl *getCanonicalDecl() const {
2324 return const_cast<CXXConstructorDecl*>(this)->getCanonicalDecl();
2327 // Implement isa/cast/dyncast/etc.
2328 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2329 static bool classofKind(Kind K) { return K == CXXConstructor; }
2331 friend class ASTDeclReader;
2332 friend class ASTDeclWriter;
2335 /// \brief Represents a C++ destructor within a class.
2342 /// ~X(); // represented by a CXXDestructorDecl.
2345 class CXXDestructorDecl : public CXXMethodDecl {
2346 void anchor() override;
2348 FunctionDecl *OperatorDelete;
2350 CXXDestructorDecl(ASTContext &C, CXXRecordDecl *RD, SourceLocation StartLoc,
2351 const DeclarationNameInfo &NameInfo,
2352 QualType T, TypeSourceInfo *TInfo,
2353 bool isInline, bool isImplicitlyDeclared)
2354 : CXXMethodDecl(CXXDestructor, C, RD, StartLoc, NameInfo, T, TInfo,
2355 SC_None, isInline, /*isConstexpr=*/false, SourceLocation()),
2356 OperatorDelete(nullptr) {
2357 setImplicit(isImplicitlyDeclared);
2361 static CXXDestructorDecl *Create(ASTContext &C, CXXRecordDecl *RD,
2362 SourceLocation StartLoc,
2363 const DeclarationNameInfo &NameInfo,
2364 QualType T, TypeSourceInfo* TInfo,
2366 bool isImplicitlyDeclared);
2367 static CXXDestructorDecl *CreateDeserialized(ASTContext & C, unsigned ID);
2369 void setOperatorDelete(FunctionDecl *OD);
2370 const FunctionDecl *getOperatorDelete() const {
2371 return cast<CXXDestructorDecl>(getFirstDecl())->OperatorDelete;
2374 // Implement isa/cast/dyncast/etc.
2375 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2376 static bool classofKind(Kind K) { return K == CXXDestructor; }
2378 friend class ASTDeclReader;
2379 friend class ASTDeclWriter;
2382 /// \brief Represents a C++ conversion function within a class.
2389 /// operator bool();
2392 class CXXConversionDecl : public CXXMethodDecl {
2393 void anchor() override;
2394 /// Whether this conversion function declaration is marked
2395 /// "explicit", meaning that it can only be applied when the user
2396 /// explicitly wrote a cast. This is a C++11 feature.
2397 bool IsExplicitSpecified : 1;
2399 CXXConversionDecl(ASTContext &C, CXXRecordDecl *RD, SourceLocation StartLoc,
2400 const DeclarationNameInfo &NameInfo,
2401 QualType T, TypeSourceInfo *TInfo,
2402 bool isInline, bool isExplicitSpecified,
2403 bool isConstexpr, SourceLocation EndLocation)
2404 : CXXMethodDecl(CXXConversion, C, RD, StartLoc, NameInfo, T, TInfo,
2405 SC_None, isInline, isConstexpr, EndLocation),
2406 IsExplicitSpecified(isExplicitSpecified) { }
2409 static CXXConversionDecl *Create(ASTContext &C, CXXRecordDecl *RD,
2410 SourceLocation StartLoc,
2411 const DeclarationNameInfo &NameInfo,
2412 QualType T, TypeSourceInfo *TInfo,
2413 bool isInline, bool isExplicit,
2415 SourceLocation EndLocation);
2416 static CXXConversionDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2418 /// Whether this conversion function declaration is marked
2419 /// "explicit", meaning that it can only be used for direct initialization
2420 /// (including explitly written casts). This is a C++11 feature.
2421 bool isExplicitSpecified() const { return IsExplicitSpecified; }
2423 /// \brief Whether this is an explicit conversion operator (C++11 and later).
2425 /// Explicit conversion operators are only considered for direct
2426 /// initialization, e.g., when the user has explicitly written a cast.
2427 bool isExplicit() const {
2428 return cast<CXXConversionDecl>(getFirstDecl())->isExplicitSpecified();
2431 /// \brief Returns the type that this conversion function is converting to.
2432 QualType getConversionType() const {
2433 return getType()->getAs<FunctionType>()->getReturnType();
2436 /// \brief Determine whether this conversion function is a conversion from
2437 /// a lambda closure type to a block pointer.
2438 bool isLambdaToBlockPointerConversion() const;
2440 // Implement isa/cast/dyncast/etc.
2441 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2442 static bool classofKind(Kind K) { return K == CXXConversion; }
2444 friend class ASTDeclReader;
2445 friend class ASTDeclWriter;
2448 /// \brief Represents a linkage specification.
2452 /// extern "C" void foo();
2454 class LinkageSpecDecl : public Decl, public DeclContext {
2455 virtual void anchor();
2457 /// \brief Represents the language in a linkage specification.
2459 /// The values are part of the serialization ABI for
2460 /// ASTs and cannot be changed without altering that ABI. To help
2461 /// ensure a stable ABI for this, we choose the DW_LANG_ encodings
2462 /// from the dwarf standard.
2464 lang_c = /* DW_LANG_C */ 0x0002,
2465 lang_cxx = /* DW_LANG_C_plus_plus */ 0x0004
2468 /// \brief The language for this linkage specification.
2469 unsigned Language : 3;
2470 /// \brief True if this linkage spec has braces.
2472 /// This is needed so that hasBraces() returns the correct result while the
2473 /// linkage spec body is being parsed. Once RBraceLoc has been set this is
2474 /// not used, so it doesn't need to be serialized.
2475 unsigned HasBraces : 1;
2476 /// \brief The source location for the extern keyword.
2477 SourceLocation ExternLoc;
2478 /// \brief The source location for the right brace (if valid).
2479 SourceLocation RBraceLoc;
2481 LinkageSpecDecl(DeclContext *DC, SourceLocation ExternLoc,
2482 SourceLocation LangLoc, LanguageIDs lang, bool HasBraces)
2483 : Decl(LinkageSpec, DC, LangLoc), DeclContext(LinkageSpec),
2484 Language(lang), HasBraces(HasBraces), ExternLoc(ExternLoc),
2485 RBraceLoc(SourceLocation()) { }
2488 static LinkageSpecDecl *Create(ASTContext &C, DeclContext *DC,
2489 SourceLocation ExternLoc,
2490 SourceLocation LangLoc, LanguageIDs Lang,
2492 static LinkageSpecDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2494 /// \brief Return the language specified by this linkage specification.
2495 LanguageIDs getLanguage() const { return LanguageIDs(Language); }
2496 /// \brief Set the language specified by this linkage specification.
2497 void setLanguage(LanguageIDs L) { Language = L; }
2499 /// \brief Determines whether this linkage specification had braces in
2500 /// its syntactic form.
2501 bool hasBraces() const {
2502 assert(!RBraceLoc.isValid() || HasBraces);
2506 SourceLocation getExternLoc() const { return ExternLoc; }
2507 SourceLocation getRBraceLoc() const { return RBraceLoc; }
2508 void setExternLoc(SourceLocation L) { ExternLoc = L; }
2509 void setRBraceLoc(SourceLocation L) {
2511 HasBraces = RBraceLoc.isValid();
2514 SourceLocation getLocEnd() const LLVM_READONLY {
2516 return getRBraceLoc();
2517 // No braces: get the end location of the (only) declaration in context
2519 return decls_empty() ? getLocation() : decls_begin()->getLocEnd();
2522 SourceRange getSourceRange() const override LLVM_READONLY {
2523 return SourceRange(ExternLoc, getLocEnd());
2526 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2527 static bool classofKind(Kind K) { return K == LinkageSpec; }
2528 static DeclContext *castToDeclContext(const LinkageSpecDecl *D) {
2529 return static_cast<DeclContext *>(const_cast<LinkageSpecDecl*>(D));
2531 static LinkageSpecDecl *castFromDeclContext(const DeclContext *DC) {
2532 return static_cast<LinkageSpecDecl *>(const_cast<DeclContext*>(DC));
2536 /// \brief Represents C++ using-directive.
2540 /// using namespace std;
2543 /// \note UsingDirectiveDecl should be Decl not NamedDecl, but we provide
2544 /// artificial names for all using-directives in order to store
2545 /// them in DeclContext effectively.
2546 class UsingDirectiveDecl : public NamedDecl {
2547 void anchor() override;
2548 /// \brief The location of the \c using keyword.
2549 SourceLocation UsingLoc;
2551 /// \brief The location of the \c namespace keyword.
2552 SourceLocation NamespaceLoc;
2554 /// \brief The nested-name-specifier that precedes the namespace.
2555 NestedNameSpecifierLoc QualifierLoc;
2557 /// \brief The namespace nominated by this using-directive.
2558 NamedDecl *NominatedNamespace;
2560 /// Enclosing context containing both using-directive and nominated
2562 DeclContext *CommonAncestor;
2564 /// \brief Returns special DeclarationName used by using-directives.
2566 /// This is only used by DeclContext for storing UsingDirectiveDecls in
2567 /// its lookup structure.
2568 static DeclarationName getName() {
2569 return DeclarationName::getUsingDirectiveName();
2572 UsingDirectiveDecl(DeclContext *DC, SourceLocation UsingLoc,
2573 SourceLocation NamespcLoc,
2574 NestedNameSpecifierLoc QualifierLoc,
2575 SourceLocation IdentLoc,
2576 NamedDecl *Nominated,
2577 DeclContext *CommonAncestor)
2578 : NamedDecl(UsingDirective, DC, IdentLoc, getName()), UsingLoc(UsingLoc),
2579 NamespaceLoc(NamespcLoc), QualifierLoc(QualifierLoc),
2580 NominatedNamespace(Nominated), CommonAncestor(CommonAncestor) { }
2583 /// \brief Retrieve the nested-name-specifier that qualifies the
2584 /// name of the namespace, with source-location information.
2585 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; }
2587 /// \brief Retrieve the nested-name-specifier that qualifies the
2588 /// name of the namespace.
2589 NestedNameSpecifier *getQualifier() const {
2590 return QualifierLoc.getNestedNameSpecifier();
2593 NamedDecl *getNominatedNamespaceAsWritten() { return NominatedNamespace; }
2594 const NamedDecl *getNominatedNamespaceAsWritten() const {
2595 return NominatedNamespace;
2598 /// \brief Returns the namespace nominated by this using-directive.
2599 NamespaceDecl *getNominatedNamespace();
2601 const NamespaceDecl *getNominatedNamespace() const {
2602 return const_cast<UsingDirectiveDecl*>(this)->getNominatedNamespace();
2605 /// \brief Returns the common ancestor context of this using-directive and
2606 /// its nominated namespace.
2607 DeclContext *getCommonAncestor() { return CommonAncestor; }
2608 const DeclContext *getCommonAncestor() const { return CommonAncestor; }
2610 /// \brief Return the location of the \c using keyword.
2611 SourceLocation getUsingLoc() const { return UsingLoc; }
2613 // FIXME: Could omit 'Key' in name.
2614 /// \brief Returns the location of the \c namespace keyword.
2615 SourceLocation getNamespaceKeyLocation() const { return NamespaceLoc; }
2617 /// \brief Returns the location of this using declaration's identifier.
2618 SourceLocation getIdentLocation() const { return getLocation(); }
2620 static UsingDirectiveDecl *Create(ASTContext &C, DeclContext *DC,
2621 SourceLocation UsingLoc,
2622 SourceLocation NamespaceLoc,
2623 NestedNameSpecifierLoc QualifierLoc,
2624 SourceLocation IdentLoc,
2625 NamedDecl *Nominated,
2626 DeclContext *CommonAncestor);
2627 static UsingDirectiveDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2629 SourceRange getSourceRange() const override LLVM_READONLY {
2630 return SourceRange(UsingLoc, getLocation());
2633 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2634 static bool classofKind(Kind K) { return K == UsingDirective; }
2636 // Friend for getUsingDirectiveName.
2637 friend class DeclContext;
2639 friend class ASTDeclReader;
2642 /// \brief Represents a C++ namespace alias.
2647 /// namespace Foo = Bar;
2649 class NamespaceAliasDecl : public NamedDecl,
2650 public Redeclarable<NamespaceAliasDecl> {
2651 void anchor() override;
2653 /// \brief The location of the \c namespace keyword.
2654 SourceLocation NamespaceLoc;
2656 /// \brief The location of the namespace's identifier.
2658 /// This is accessed by TargetNameLoc.
2659 SourceLocation IdentLoc;
2661 /// \brief The nested-name-specifier that precedes the namespace.
2662 NestedNameSpecifierLoc QualifierLoc;
2664 /// \brief The Decl that this alias points to, either a NamespaceDecl or
2665 /// a NamespaceAliasDecl.
2666 NamedDecl *Namespace;
2668 NamespaceAliasDecl(ASTContext &C, DeclContext *DC,
2669 SourceLocation NamespaceLoc, SourceLocation AliasLoc,
2670 IdentifierInfo *Alias, NestedNameSpecifierLoc QualifierLoc,
2671 SourceLocation IdentLoc, NamedDecl *Namespace)
2672 : NamedDecl(NamespaceAlias, DC, AliasLoc, Alias), redeclarable_base(C),
2673 NamespaceLoc(NamespaceLoc), IdentLoc(IdentLoc),
2674 QualifierLoc(QualifierLoc), Namespace(Namespace) {}
2676 typedef Redeclarable<NamespaceAliasDecl> redeclarable_base;
2677 NamespaceAliasDecl *getNextRedeclarationImpl() override;
2678 NamespaceAliasDecl *getPreviousDeclImpl() override;
2679 NamespaceAliasDecl *getMostRecentDeclImpl() override;
2681 friend class ASTDeclReader;
2684 static NamespaceAliasDecl *Create(ASTContext &C, DeclContext *DC,
2685 SourceLocation NamespaceLoc,
2686 SourceLocation AliasLoc,
2687 IdentifierInfo *Alias,
2688 NestedNameSpecifierLoc QualifierLoc,
2689 SourceLocation IdentLoc,
2690 NamedDecl *Namespace);
2692 static NamespaceAliasDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2694 typedef redeclarable_base::redecl_range redecl_range;
2695 typedef redeclarable_base::redecl_iterator redecl_iterator;
2696 using redeclarable_base::redecls_begin;
2697 using redeclarable_base::redecls_end;
2698 using redeclarable_base::redecls;
2699 using redeclarable_base::getPreviousDecl;
2700 using redeclarable_base::getMostRecentDecl;
2702 NamespaceAliasDecl *getCanonicalDecl() override {
2703 return getFirstDecl();
2705 const NamespaceAliasDecl *getCanonicalDecl() const {
2706 return getFirstDecl();
2709 /// \brief Retrieve the nested-name-specifier that qualifies the
2710 /// name of the namespace, with source-location information.
2711 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; }
2713 /// \brief Retrieve the nested-name-specifier that qualifies the
2714 /// name of the namespace.
2715 NestedNameSpecifier *getQualifier() const {
2716 return QualifierLoc.getNestedNameSpecifier();
2719 /// \brief Retrieve the namespace declaration aliased by this directive.
2720 NamespaceDecl *getNamespace() {
2721 if (NamespaceAliasDecl *AD = dyn_cast<NamespaceAliasDecl>(Namespace))
2722 return AD->getNamespace();
2724 return cast<NamespaceDecl>(Namespace);
2727 const NamespaceDecl *getNamespace() const {
2728 return const_cast<NamespaceAliasDecl*>(this)->getNamespace();
2731 /// Returns the location of the alias name, i.e. 'foo' in
2732 /// "namespace foo = ns::bar;".
2733 SourceLocation getAliasLoc() const { return getLocation(); }
2735 /// Returns the location of the \c namespace keyword.
2736 SourceLocation getNamespaceLoc() const { return NamespaceLoc; }
2738 /// Returns the location of the identifier in the named namespace.
2739 SourceLocation getTargetNameLoc() const { return IdentLoc; }
2741 /// \brief Retrieve the namespace that this alias refers to, which
2742 /// may either be a NamespaceDecl or a NamespaceAliasDecl.
2743 NamedDecl *getAliasedNamespace() const { return Namespace; }
2745 SourceRange getSourceRange() const override LLVM_READONLY {
2746 return SourceRange(NamespaceLoc, IdentLoc);
2749 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2750 static bool classofKind(Kind K) { return K == NamespaceAlias; }
2753 /// \brief Represents a shadow declaration introduced into a scope by a
2754 /// (resolved) using declaration.
2762 /// using A::foo; // <- a UsingDecl
2763 /// // Also creates a UsingShadowDecl for A::foo() in B
2766 class UsingShadowDecl : public NamedDecl, public Redeclarable<UsingShadowDecl> {
2767 void anchor() override;
2769 /// The referenced declaration.
2770 NamedDecl *Underlying;
2772 /// \brief The using declaration which introduced this decl or the next using
2773 /// shadow declaration contained in the aforementioned using declaration.
2774 NamedDecl *UsingOrNextShadow;
2775 friend class UsingDecl;
2777 UsingShadowDecl(ASTContext &C, DeclContext *DC, SourceLocation Loc,
2778 UsingDecl *Using, NamedDecl *Target)
2779 : NamedDecl(UsingShadow, DC, Loc, DeclarationName()),
2780 redeclarable_base(C), Underlying(Target),
2781 UsingOrNextShadow(reinterpret_cast<NamedDecl *>(Using)) {
2783 setDeclName(Target->getDeclName());
2784 IdentifierNamespace = Target->getIdentifierNamespace();
2789 typedef Redeclarable<UsingShadowDecl> redeclarable_base;
2790 UsingShadowDecl *getNextRedeclarationImpl() override {
2791 return getNextRedeclaration();
2793 UsingShadowDecl *getPreviousDeclImpl() override {
2794 return getPreviousDecl();
2796 UsingShadowDecl *getMostRecentDeclImpl() override {
2797 return getMostRecentDecl();
2801 static UsingShadowDecl *Create(ASTContext &C, DeclContext *DC,
2802 SourceLocation Loc, UsingDecl *Using,
2803 NamedDecl *Target) {
2804 return new (C, DC) UsingShadowDecl(C, DC, Loc, Using, Target);
2807 static UsingShadowDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2809 typedef redeclarable_base::redecl_range redecl_range;
2810 typedef redeclarable_base::redecl_iterator redecl_iterator;
2811 using redeclarable_base::redecls_begin;
2812 using redeclarable_base::redecls_end;
2813 using redeclarable_base::redecls;
2814 using redeclarable_base::getPreviousDecl;
2815 using redeclarable_base::getMostRecentDecl;
2817 UsingShadowDecl *getCanonicalDecl() override {
2818 return getFirstDecl();
2820 const UsingShadowDecl *getCanonicalDecl() const {
2821 return getFirstDecl();
2824 /// \brief Gets the underlying declaration which has been brought into the
2826 NamedDecl *getTargetDecl() const { return Underlying; }
2828 /// \brief Sets the underlying declaration which has been brought into the
2830 void setTargetDecl(NamedDecl* ND) {
2831 assert(ND && "Target decl is null!");
2833 IdentifierNamespace = ND->getIdentifierNamespace();
2836 /// \brief Gets the using declaration to which this declaration is tied.
2837 UsingDecl *getUsingDecl() const;
2839 /// \brief The next using shadow declaration contained in the shadow decl
2840 /// chain of the using declaration which introduced this decl.
2841 UsingShadowDecl *getNextUsingShadowDecl() const {
2842 return dyn_cast_or_null<UsingShadowDecl>(UsingOrNextShadow);
2845 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2846 static bool classofKind(Kind K) { return K == Decl::UsingShadow; }
2848 friend class ASTDeclReader;
2849 friend class ASTDeclWriter;
2852 /// \brief Represents a C++ using-declaration.
2856 /// using someNameSpace::someIdentifier;
2858 class UsingDecl : public NamedDecl, public Mergeable<UsingDecl> {
2859 void anchor() override;
2861 /// \brief The source location of the 'using' keyword itself.
2862 SourceLocation UsingLocation;
2864 /// \brief The nested-name-specifier that precedes the name.
2865 NestedNameSpecifierLoc QualifierLoc;
2867 /// \brief Provides source/type location info for the declaration name
2868 /// embedded in the ValueDecl base class.
2869 DeclarationNameLoc DNLoc;
2871 /// \brief The first shadow declaration of the shadow decl chain associated
2872 /// with this using declaration.
2874 /// The bool member of the pair store whether this decl has the \c typename
2876 llvm::PointerIntPair<UsingShadowDecl *, 1, bool> FirstUsingShadow;
2878 UsingDecl(DeclContext *DC, SourceLocation UL,
2879 NestedNameSpecifierLoc QualifierLoc,
2880 const DeclarationNameInfo &NameInfo, bool HasTypenameKeyword)
2881 : NamedDecl(Using, DC, NameInfo.getLoc(), NameInfo.getName()),
2882 UsingLocation(UL), QualifierLoc(QualifierLoc),
2883 DNLoc(NameInfo.getInfo()), FirstUsingShadow(nullptr, HasTypenameKeyword) {
2887 /// \brief Return the source location of the 'using' keyword.
2888 SourceLocation getUsingLoc() const { return UsingLocation; }
2890 /// \brief Set the source location of the 'using' keyword.
2891 void setUsingLoc(SourceLocation L) { UsingLocation = L; }
2893 /// \brief Retrieve the nested-name-specifier that qualifies the name,
2894 /// with source-location information.
2895 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; }
2897 /// \brief Retrieve the nested-name-specifier that qualifies the name.
2898 NestedNameSpecifier *getQualifier() const {
2899 return QualifierLoc.getNestedNameSpecifier();
2902 DeclarationNameInfo getNameInfo() const {
2903 return DeclarationNameInfo(getDeclName(), getLocation(), DNLoc);
2906 /// \brief Return true if it is a C++03 access declaration (no 'using').
2907 bool isAccessDeclaration() const { return UsingLocation.isInvalid(); }
2909 /// \brief Return true if the using declaration has 'typename'.
2910 bool hasTypename() const { return FirstUsingShadow.getInt(); }
2912 /// \brief Sets whether the using declaration has 'typename'.
2913 void setTypename(bool TN) { FirstUsingShadow.setInt(TN); }
2915 /// \brief Iterates through the using shadow declarations associated with
2916 /// this using declaration.
2917 class shadow_iterator {
2918 /// \brief The current using shadow declaration.
2919 UsingShadowDecl *Current;
2922 typedef UsingShadowDecl* value_type;
2923 typedef UsingShadowDecl* reference;
2924 typedef UsingShadowDecl* pointer;
2925 typedef std::forward_iterator_tag iterator_category;
2926 typedef std::ptrdiff_t difference_type;
2928 shadow_iterator() : Current(nullptr) { }
2929 explicit shadow_iterator(UsingShadowDecl *C) : Current(C) { }
2931 reference operator*() const { return Current; }
2932 pointer operator->() const { return Current; }
2934 shadow_iterator& operator++() {
2935 Current = Current->getNextUsingShadowDecl();
2939 shadow_iterator operator++(int) {
2940 shadow_iterator tmp(*this);
2945 friend bool operator==(shadow_iterator x, shadow_iterator y) {
2946 return x.Current == y.Current;
2948 friend bool operator!=(shadow_iterator x, shadow_iterator y) {
2949 return x.Current != y.Current;
2953 typedef llvm::iterator_range<shadow_iterator> shadow_range;
2955 shadow_range shadows() const {
2956 return shadow_range(shadow_begin(), shadow_end());
2958 shadow_iterator shadow_begin() const {
2959 return shadow_iterator(FirstUsingShadow.getPointer());
2961 shadow_iterator shadow_end() const { return shadow_iterator(); }
2963 /// \brief Return the number of shadowed declarations associated with this
2964 /// using declaration.
2965 unsigned shadow_size() const {
2966 return std::distance(shadow_begin(), shadow_end());
2969 void addShadowDecl(UsingShadowDecl *S);
2970 void removeShadowDecl(UsingShadowDecl *S);
2972 static UsingDecl *Create(ASTContext &C, DeclContext *DC,
2973 SourceLocation UsingL,
2974 NestedNameSpecifierLoc QualifierLoc,
2975 const DeclarationNameInfo &NameInfo,
2976 bool HasTypenameKeyword);
2978 static UsingDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2980 SourceRange getSourceRange() const override LLVM_READONLY;
2982 /// Retrieves the canonical declaration of this declaration.
2983 UsingDecl *getCanonicalDecl() override { return getFirstDecl(); }
2984 const UsingDecl *getCanonicalDecl() const { return getFirstDecl(); }
2986 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2987 static bool classofKind(Kind K) { return K == Using; }
2989 friend class ASTDeclReader;
2990 friend class ASTDeclWriter;
2993 /// \brief Represents a dependent using declaration which was not marked with
2996 /// Unlike non-dependent using declarations, these *only* bring through
2997 /// non-types; otherwise they would break two-phase lookup.
3000 /// template \<class T> class A : public Base<T> {
3001 /// using Base<T>::foo;
3004 class UnresolvedUsingValueDecl : public ValueDecl,
3005 public Mergeable<UnresolvedUsingValueDecl> {
3006 void anchor() override;
3008 /// \brief The source location of the 'using' keyword
3009 SourceLocation UsingLocation;
3011 /// \brief The nested-name-specifier that precedes the name.
3012 NestedNameSpecifierLoc QualifierLoc;
3014 /// \brief Provides source/type location info for the declaration name
3015 /// embedded in the ValueDecl base class.
3016 DeclarationNameLoc DNLoc;
3018 UnresolvedUsingValueDecl(DeclContext *DC, QualType Ty,
3019 SourceLocation UsingLoc,
3020 NestedNameSpecifierLoc QualifierLoc,
3021 const DeclarationNameInfo &NameInfo)
3022 : ValueDecl(UnresolvedUsingValue, DC,
3023 NameInfo.getLoc(), NameInfo.getName(), Ty),
3024 UsingLocation(UsingLoc), QualifierLoc(QualifierLoc),
3025 DNLoc(NameInfo.getInfo())
3029 /// \brief Returns the source location of the 'using' keyword.
3030 SourceLocation getUsingLoc() const { return UsingLocation; }
3032 /// \brief Set the source location of the 'using' keyword.
3033 void setUsingLoc(SourceLocation L) { UsingLocation = L; }
3035 /// \brief Return true if it is a C++03 access declaration (no 'using').
3036 bool isAccessDeclaration() const { return UsingLocation.isInvalid(); }
3038 /// \brief Retrieve the nested-name-specifier that qualifies the name,
3039 /// with source-location information.
3040 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; }
3042 /// \brief Retrieve the nested-name-specifier that qualifies the name.
3043 NestedNameSpecifier *getQualifier() const {
3044 return QualifierLoc.getNestedNameSpecifier();
3047 DeclarationNameInfo getNameInfo() const {
3048 return DeclarationNameInfo(getDeclName(), getLocation(), DNLoc);
3051 static UnresolvedUsingValueDecl *
3052 Create(ASTContext &C, DeclContext *DC, SourceLocation UsingLoc,
3053 NestedNameSpecifierLoc QualifierLoc,
3054 const DeclarationNameInfo &NameInfo);
3056 static UnresolvedUsingValueDecl *
3057 CreateDeserialized(ASTContext &C, unsigned ID);
3059 SourceRange getSourceRange() const override LLVM_READONLY;
3061 /// Retrieves the canonical declaration of this declaration.
3062 UnresolvedUsingValueDecl *getCanonicalDecl() override {
3063 return getFirstDecl();
3065 const UnresolvedUsingValueDecl *getCanonicalDecl() const {
3066 return getFirstDecl();
3069 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3070 static bool classofKind(Kind K) { return K == UnresolvedUsingValue; }
3072 friend class ASTDeclReader;
3073 friend class ASTDeclWriter;
3076 /// \brief Represents a dependent using declaration which was marked with
3080 /// template \<class T> class A : public Base<T> {
3081 /// using typename Base<T>::foo;
3085 /// The type associated with an unresolved using typename decl is
3086 /// currently always a typename type.
3087 class UnresolvedUsingTypenameDecl
3089 public Mergeable<UnresolvedUsingTypenameDecl> {
3090 void anchor() override;
3092 /// \brief The source location of the 'typename' keyword
3093 SourceLocation TypenameLocation;
3095 /// \brief The nested-name-specifier that precedes the name.
3096 NestedNameSpecifierLoc QualifierLoc;
3098 UnresolvedUsingTypenameDecl(DeclContext *DC, SourceLocation UsingLoc,
3099 SourceLocation TypenameLoc,
3100 NestedNameSpecifierLoc QualifierLoc,
3101 SourceLocation TargetNameLoc,
3102 IdentifierInfo *TargetName)
3103 : TypeDecl(UnresolvedUsingTypename, DC, TargetNameLoc, TargetName,
3105 TypenameLocation(TypenameLoc), QualifierLoc(QualifierLoc) { }
3107 friend class ASTDeclReader;
3110 /// \brief Returns the source location of the 'using' keyword.
3111 SourceLocation getUsingLoc() const { return getLocStart(); }
3113 /// \brief Returns the source location of the 'typename' keyword.
3114 SourceLocation getTypenameLoc() const { return TypenameLocation; }
3116 /// \brief Retrieve the nested-name-specifier that qualifies the name,
3117 /// with source-location information.
3118 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; }
3120 /// \brief Retrieve the nested-name-specifier that qualifies the name.
3121 NestedNameSpecifier *getQualifier() const {
3122 return QualifierLoc.getNestedNameSpecifier();
3125 static UnresolvedUsingTypenameDecl *
3126 Create(ASTContext &C, DeclContext *DC, SourceLocation UsingLoc,
3127 SourceLocation TypenameLoc, NestedNameSpecifierLoc QualifierLoc,
3128 SourceLocation TargetNameLoc, DeclarationName TargetName);
3130 static UnresolvedUsingTypenameDecl *
3131 CreateDeserialized(ASTContext &C, unsigned ID);
3133 /// Retrieves the canonical declaration of this declaration.
3134 UnresolvedUsingTypenameDecl *getCanonicalDecl() override {
3135 return getFirstDecl();
3137 const UnresolvedUsingTypenameDecl *getCanonicalDecl() const {
3138 return getFirstDecl();
3141 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3142 static bool classofKind(Kind K) { return K == UnresolvedUsingTypename; }
3145 /// \brief Represents a C++11 static_assert declaration.
3146 class StaticAssertDecl : public Decl {
3147 virtual void anchor();
3148 llvm::PointerIntPair<Expr *, 1, bool> AssertExprAndFailed;
3149 StringLiteral *Message;
3150 SourceLocation RParenLoc;
3152 StaticAssertDecl(DeclContext *DC, SourceLocation StaticAssertLoc,
3153 Expr *AssertExpr, StringLiteral *Message,
3154 SourceLocation RParenLoc, bool Failed)
3155 : Decl(StaticAssert, DC, StaticAssertLoc),
3156 AssertExprAndFailed(AssertExpr, Failed), Message(Message),
3157 RParenLoc(RParenLoc) { }
3160 static StaticAssertDecl *Create(ASTContext &C, DeclContext *DC,
3161 SourceLocation StaticAssertLoc,
3162 Expr *AssertExpr, StringLiteral *Message,
3163 SourceLocation RParenLoc, bool Failed);
3164 static StaticAssertDecl *CreateDeserialized(ASTContext &C, unsigned ID);
3166 Expr *getAssertExpr() { return AssertExprAndFailed.getPointer(); }
3167 const Expr *getAssertExpr() const { return AssertExprAndFailed.getPointer(); }
3169 StringLiteral *getMessage() { return Message; }
3170 const StringLiteral *getMessage() const { return Message; }
3172 bool isFailed() const { return AssertExprAndFailed.getInt(); }
3174 SourceLocation getRParenLoc() const { return RParenLoc; }
3176 SourceRange getSourceRange() const override LLVM_READONLY {
3177 return SourceRange(getLocation(), getRParenLoc());
3180 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3181 static bool classofKind(Kind K) { return K == StaticAssert; }
3183 friend class ASTDeclReader;
3186 /// An instance of this class represents the declaration of a property
3187 /// member. This is a Microsoft extension to C++, first introduced in
3188 /// Visual Studio .NET 2003 as a parallel to similar features in C#
3189 /// and Managed C++.
3191 /// A property must always be a non-static class member.
3193 /// A property member superficially resembles a non-static data
3194 /// member, except preceded by a property attribute:
3195 /// __declspec(property(get=GetX, put=PutX)) int x;
3196 /// Either (but not both) of the 'get' and 'put' names may be omitted.
3198 /// A reference to a property is always an lvalue. If the lvalue
3199 /// undergoes lvalue-to-rvalue conversion, then a getter name is
3200 /// required, and that member is called with no arguments.
3201 /// If the lvalue is assigned into, then a setter name is required,
3202 /// and that member is called with one argument, the value assigned.
3203 /// Both operations are potentially overloaded. Compound assignments
3204 /// are permitted, as are the increment and decrement operators.
3206 /// The getter and putter methods are permitted to be overloaded,
3207 /// although their return and parameter types are subject to certain
3208 /// restrictions according to the type of the property.
3210 /// A property declared using an incomplete array type may
3211 /// additionally be subscripted, adding extra parameters to the getter
3212 /// and putter methods.
3213 class MSPropertyDecl : public DeclaratorDecl {
3214 IdentifierInfo *GetterId, *SetterId;
3216 MSPropertyDecl(DeclContext *DC, SourceLocation L, DeclarationName N,
3217 QualType T, TypeSourceInfo *TInfo, SourceLocation StartL,
3218 IdentifierInfo *Getter, IdentifierInfo *Setter)
3219 : DeclaratorDecl(MSProperty, DC, L, N, T, TInfo, StartL),
3220 GetterId(Getter), SetterId(Setter) {}
3223 static MSPropertyDecl *Create(ASTContext &C, DeclContext *DC,
3224 SourceLocation L, DeclarationName N, QualType T,
3225 TypeSourceInfo *TInfo, SourceLocation StartL,
3226 IdentifierInfo *Getter, IdentifierInfo *Setter);
3227 static MSPropertyDecl *CreateDeserialized(ASTContext &C, unsigned ID);
3229 static bool classof(const Decl *D) { return D->getKind() == MSProperty; }
3231 bool hasGetter() const { return GetterId != nullptr; }
3232 IdentifierInfo* getGetterId() const { return GetterId; }
3233 bool hasSetter() const { return SetterId != nullptr; }
3234 IdentifierInfo* getSetterId() const { return SetterId; }
3236 friend class ASTDeclReader;
3239 /// Insertion operator for diagnostics. This allows sending an AccessSpecifier
3240 /// into a diagnostic with <<.
3241 const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
3242 AccessSpecifier AS);
3244 const PartialDiagnostic &operator<<(const PartialDiagnostic &DB,
3245 AccessSpecifier AS);
3247 } // end namespace clang