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 //===----------------------------------------------------------------------===//
10 // This file defines the C++ Decl subclasses, other than those for
11 // templates (in DeclTemplate.h) and friends (in DeclFriend.h).
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CLANG_AST_DECLCXX_H
16 #define LLVM_CLANG_AST_DECLCXX_H
18 #include "clang/AST/ASTUnresolvedSet.h"
19 #include "clang/AST/Decl.h"
20 #include "clang/AST/Expr.h"
21 #include "clang/AST/ExprCXX.h"
22 #include "clang/AST/TypeLoc.h"
23 #include "llvm/ADT/DenseMap.h"
24 #include "llvm/ADT/PointerIntPair.h"
25 #include "llvm/ADT/SmallPtrSet.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 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) 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 /// Range - 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 /// BaseOfClass - Whether this is the base of a class (true) or of a
171 /// struct (false). This determines the mapping from the access
172 /// specifier as written in the source code to the access specifier
173 /// used for semantic analysis.
174 bool BaseOfClass : 1;
176 /// Access - Access specifier as written in the source code (which
177 /// may be AS_none). The actual type of data stored here is an
178 /// AccessSpecifier, but we use "unsigned" here to work around a
182 /// InheritConstructors - Whether the class contains a using declaration
183 /// to inherit the named class's constructors.
184 bool InheritConstructors : 1;
186 /// BaseTypeInfo - The type of the base class. This will be a class or struct
187 /// (or a typedef of such). The source code range does not include the
188 /// "virtual" or access specifier.
189 TypeSourceInfo *BaseTypeInfo;
192 CXXBaseSpecifier() { }
194 CXXBaseSpecifier(SourceRange R, bool V, bool BC, AccessSpecifier A,
195 TypeSourceInfo *TInfo, SourceLocation EllipsisLoc)
196 : Range(R), EllipsisLoc(EllipsisLoc), Virtual(V), BaseOfClass(BC),
197 Access(A), InheritConstructors(false), BaseTypeInfo(TInfo) { }
199 /// getSourceRange - Retrieves the source range that contains the
200 /// 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 /// isVirtual - Determines whether the base class is a virtual base
207 bool isVirtual() const { return Virtual; }
209 /// \brief Determine whether this base class is a base of a class declared
210 /// with the 'class' keyword (vs. one declared with the 'struct' keyword).
211 bool isBaseOfClass() const { return BaseOfClass; }
213 /// \brief Determine whether this base specifier is a pack expansion.
214 bool isPackExpansion() const { return EllipsisLoc.isValid(); }
216 /// \brief Determine whether this base class's constructors get inherited.
217 bool getInheritConstructors() const { return InheritConstructors; }
219 /// \brief Set that this base class's constructors should be inherited.
220 void setInheritConstructors(bool Inherit = true) {
221 InheritConstructors = Inherit;
224 /// \brief For a pack expansion, determine the location of the ellipsis.
225 SourceLocation getEllipsisLoc() const {
229 /// getAccessSpecifier - Returns the access specifier for this base
230 /// specifier. This is the actual base specifier as used for
231 /// semantic analysis, so the result can never be AS_none. To
232 /// retrieve the access specifier as written in the source code, use
233 /// getAccessSpecifierAsWritten().
234 AccessSpecifier getAccessSpecifier() const {
235 if ((AccessSpecifier)Access == AS_none)
236 return BaseOfClass? AS_private : AS_public;
238 return (AccessSpecifier)Access;
241 /// getAccessSpecifierAsWritten - Retrieves the access specifier as
242 /// written in the source code (which may mean that no access
243 /// specifier was explicitly written). Use getAccessSpecifier() to
244 /// retrieve the access specifier for use in semantic analysis.
245 AccessSpecifier getAccessSpecifierAsWritten() const {
246 return (AccessSpecifier)Access;
249 /// getType - Retrieves the type of the base class. This type will
250 /// always be an unqualified class type.
251 QualType getType() const { return BaseTypeInfo->getType(); }
253 /// getTypeLoc - Retrieves the type and source location of the base class.
254 TypeSourceInfo *getTypeSourceInfo() const { return BaseTypeInfo; }
257 /// CXXRecordDecl - Represents a C++ struct/union/class.
258 /// FIXME: This class will disappear once we've properly taught RecordDecl
259 /// to deal with C++-specific things.
260 class CXXRecordDecl : public RecordDecl {
262 friend void TagDecl::startDefinition();
264 /// Values used in DefinitionData fields to represent special members.
265 enum SpecialMemberFlags {
266 SMF_DefaultConstructor = 0x1,
267 SMF_CopyConstructor = 0x2,
268 SMF_MoveConstructor = 0x4,
269 SMF_CopyAssignment = 0x8,
270 SMF_MoveAssignment = 0x10,
271 SMF_Destructor = 0x20,
275 struct DefinitionData {
276 DefinitionData(CXXRecordDecl *D);
278 /// \brief True if this class has any user-declared constructors.
279 bool UserDeclaredConstructor : 1;
281 /// The user-declared special members which this class has.
282 unsigned UserDeclaredSpecialMembers : 6;
284 /// Aggregate - True when this class is an aggregate.
287 /// PlainOldData - True when this class is a POD-type.
288 bool PlainOldData : 1;
290 /// Empty - true when this class is empty for traits purposes,
291 /// i.e. has no data members other than 0-width bit-fields, has no
292 /// virtual function/base, and doesn't inherit from a non-empty
293 /// class. Doesn't take union-ness into account.
296 /// Polymorphic - True when this class is polymorphic, i.e. has at
297 /// least one virtual member or derives from a polymorphic class.
298 bool Polymorphic : 1;
300 /// Abstract - True when this class is abstract, i.e. has at least
301 /// one pure virtual function, (that can come from a base class).
304 /// IsStandardLayout - True when this class has standard layout.
306 /// C++0x [class]p7. A standard-layout class is a class that:
307 /// * has no non-static data members of type non-standard-layout class (or
308 /// array of such types) or reference,
309 /// * has no virtual functions (10.3) and no virtual base classes (10.1),
310 /// * has the same access control (Clause 11) for all non-static data
312 /// * has no non-standard-layout base classes,
313 /// * either has no non-static data members in the most derived class and at
314 /// most one base class with non-static data members, or has no base
315 /// classes with non-static data members, and
316 /// * has no base classes of the same type as the first non-static data
318 bool IsStandardLayout : 1;
320 /// HasNoNonEmptyBases - True when there are no non-empty base classes.
322 /// This is a helper bit of state used to implement IsStandardLayout more
324 bool HasNoNonEmptyBases : 1;
326 /// HasPrivateFields - True when there are private non-static data members.
327 bool HasPrivateFields : 1;
329 /// HasProtectedFields - True when there are protected non-static data
331 bool HasProtectedFields : 1;
333 /// HasPublicFields - True when there are private non-static data members.
334 bool HasPublicFields : 1;
336 /// \brief True if this class (or any subobject) has mutable fields.
337 bool HasMutableFields : 1;
339 /// \brief True if there no non-field members declared by the user.
340 bool HasOnlyCMembers : 1;
342 /// \brief True if any field has an in-class initializer.
343 bool HasInClassInitializer : 1;
345 /// \brief True if any field is of reference type, and does not have an
346 /// in-class initializer. In this case, value-initialization of this class
347 /// is illegal in C++98 even if the class has a trivial default constructor.
348 bool HasUninitializedReferenceMember : 1;
350 /// \brief These flags are \c true if a defaulted corresponding special
351 /// member can't be fully analyzed without performing overload resolution.
353 bool NeedOverloadResolutionForMoveConstructor : 1;
354 bool NeedOverloadResolutionForMoveAssignment : 1;
355 bool NeedOverloadResolutionForDestructor : 1;
358 /// \brief These flags are \c true if an implicit defaulted corresponding
359 /// special member would be defined as deleted.
361 bool DefaultedMoveConstructorIsDeleted : 1;
362 bool DefaultedMoveAssignmentIsDeleted : 1;
363 bool DefaultedDestructorIsDeleted : 1;
366 /// \brief The trivial special members which this class has, per
367 /// C++11 [class.ctor]p5, C++11 [class.copy]p12, C++11 [class.copy]p25,
368 /// C++11 [class.dtor]p5, or would have if the member were not suppressed.
370 /// This excludes any user-declared but not user-provided special members
371 /// which have been declared but not yet defined.
372 unsigned HasTrivialSpecialMembers : 6;
374 /// \brief The declared special members of this class which are known to be
377 /// This excludes any user-declared but not user-provided special members
378 /// which have been declared but not yet defined, and any implicit special
379 /// members which have not yet been declared.
380 unsigned DeclaredNonTrivialSpecialMembers : 6;
382 /// HasIrrelevantDestructor - True when this class has a destructor with no
384 bool HasIrrelevantDestructor : 1;
386 /// HasConstexprNonCopyMoveConstructor - True when this class has at least
387 /// one user-declared constexpr constructor which is neither the copy nor
388 /// move constructor.
389 bool HasConstexprNonCopyMoveConstructor : 1;
391 /// DefaultedDefaultConstructorIsConstexpr - True if a defaulted default
392 /// constructor for this class would be constexpr.
393 bool DefaultedDefaultConstructorIsConstexpr : 1;
395 /// HasConstexprDefaultConstructor - True if this class has a constexpr
396 /// default constructor (either user-declared or implicitly declared).
397 bool HasConstexprDefaultConstructor : 1;
399 /// HasNonLiteralTypeFieldsOrBases - True when this class contains at least
400 /// one non-static data member or base class of non-literal or volatile
402 bool HasNonLiteralTypeFieldsOrBases : 1;
404 /// ComputedVisibleConversions - True when visible conversion functions are
405 /// already computed and are available.
406 bool ComputedVisibleConversions : 1;
408 /// \brief Whether we have a C++11 user-provided default constructor (not
409 /// explicitly deleted or defaulted).
410 bool UserProvidedDefaultConstructor : 1;
412 /// \brief The special members which have been declared for this class,
413 /// either by the user or implicitly.
414 unsigned DeclaredSpecialMembers : 6;
416 /// \brief Whether an implicit copy constructor would have a const-qualified
418 bool ImplicitCopyConstructorHasConstParam : 1;
420 /// \brief Whether an implicit copy assignment operator would have a
421 /// const-qualified parameter.
422 bool ImplicitCopyAssignmentHasConstParam : 1;
424 /// \brief Whether any declared copy constructor has a const-qualified
426 bool HasDeclaredCopyConstructorWithConstParam : 1;
428 /// \brief Whether any declared copy assignment operator has either a
429 /// const-qualified reference parameter or a non-reference parameter.
430 bool HasDeclaredCopyAssignmentWithConstParam : 1;
432 /// \brief Whether an implicit move constructor was attempted to be declared
433 /// but would have been deleted.
434 bool FailedImplicitMoveConstructor : 1;
436 /// \brief Whether an implicit move assignment operator was attempted to be
437 /// declared but would have been deleted.
438 bool FailedImplicitMoveAssignment : 1;
440 /// \brief Whether this class describes a C++ lambda.
443 /// NumBases - The number of base class specifiers in Bases.
446 /// NumVBases - The number of virtual base class specifiers in VBases.
449 /// Bases - Base classes of this class.
450 /// FIXME: This is wasted space for a union.
451 LazyCXXBaseSpecifiersPtr Bases;
453 /// VBases - direct and indirect virtual base classes of this class.
454 LazyCXXBaseSpecifiersPtr VBases;
456 /// Conversions - Overload set containing the conversion functions
457 /// of this C++ class (but not its inherited conversion
458 /// functions). Each of the entries in this overload set is a
459 /// CXXConversionDecl.
460 ASTUnresolvedSet Conversions;
462 /// VisibleConversions - Overload set containing the conversion
463 /// functions of this C++ class and all those inherited conversion
464 /// functions that are visible in this class. Each of the entries
465 /// in this overload set is a CXXConversionDecl or a
466 /// FunctionTemplateDecl.
467 ASTUnresolvedSet VisibleConversions;
469 /// Definition - The declaration which defines this record.
470 CXXRecordDecl *Definition;
472 /// FirstFriend - The first friend declaration in this class, or
473 /// null if there aren't any. This is actually currently stored
474 /// in reverse order.
475 FriendDecl *FirstFriend;
477 /// \brief Retrieve the set of direct base classes.
478 CXXBaseSpecifier *getBases() const {
479 if (!Bases.isOffset())
481 return getBasesSlowCase();
484 /// \brief Retrieve the set of virtual base classes.
485 CXXBaseSpecifier *getVBases() const {
486 if (!VBases.isOffset())
487 return VBases.get(0);
488 return getVBasesSlowCase();
492 CXXBaseSpecifier *getBasesSlowCase() const;
493 CXXBaseSpecifier *getVBasesSlowCase() const;
496 /// \brief Describes a C++ closure type (generated by a lambda expression).
497 struct LambdaDefinitionData : public DefinitionData {
498 typedef LambdaExpr::Capture Capture;
500 LambdaDefinitionData(CXXRecordDecl *D, TypeSourceInfo *Info, bool Dependent)
501 : DefinitionData(D), Dependent(Dependent), NumCaptures(0),
502 NumExplicitCaptures(0), ManglingNumber(0), ContextDecl(0), Captures(0),
508 /// \brief Whether this lambda is known to be dependent, even if its
509 /// context isn't dependent.
511 /// A lambda with a non-dependent context can be dependent if it occurs
512 /// within the default argument of a function template, because the
513 /// lambda will have been created with the enclosing context as its
514 /// declaration context, rather than function. This is an unfortunate
515 /// artifact of having to parse the default arguments before
516 unsigned Dependent : 1;
518 /// \brief The number of captures in this lambda.
519 unsigned NumCaptures : 16;
521 /// \brief The number of explicit captures in this lambda.
522 unsigned NumExplicitCaptures : 15;
524 /// \brief The number used to indicate this lambda expression for name
525 /// mangling in the Itanium C++ ABI.
526 unsigned ManglingNumber;
528 /// \brief The declaration that provides context for this lambda, if the
529 /// actual DeclContext does not suffice. This is used for lambdas that
530 /// occur within default arguments of function parameters within the class
531 /// or within a data member initializer.
534 /// \brief The list of captures, both explicit and implicit, for this
538 /// \brief The type of the call method.
539 TypeSourceInfo *MethodTyInfo;
542 struct DefinitionData &data() {
543 assert(DefinitionData && "queried property of class with no definition");
544 return *DefinitionData;
547 const struct DefinitionData &data() const {
548 assert(DefinitionData && "queried property of class with no definition");
549 return *DefinitionData;
552 struct LambdaDefinitionData &getLambdaData() const {
553 assert(DefinitionData && "queried property of lambda with no definition");
554 assert(DefinitionData->IsLambda &&
555 "queried lambda property of non-lambda class");
556 return static_cast<LambdaDefinitionData &>(*DefinitionData);
559 /// \brief The template or declaration that this declaration
560 /// describes or was instantiated from, respectively.
562 /// For non-templates, this value will be NULL. For record
563 /// declarations that describe a class template, this will be a
564 /// pointer to a ClassTemplateDecl. For member
565 /// classes of class template specializations, this will be the
566 /// MemberSpecializationInfo referring to the member class that was
567 /// instantiated or specialized.
568 llvm::PointerUnion<ClassTemplateDecl*, MemberSpecializationInfo*>
569 TemplateOrInstantiation;
571 friend class DeclContext;
572 friend class LambdaExpr;
574 /// \brief Called from setBases and addedMember to notify the class that a
575 /// direct or virtual base class or a member of class type has been added.
576 void addedClassSubobject(CXXRecordDecl *Base);
578 /// \brief Notify the class that member has been added.
580 /// This routine helps maintain information about the class based on which
581 /// members have been added. It will be invoked by DeclContext::addDecl()
582 /// whenever a member is added to this record.
583 void addedMember(Decl *D);
585 void markedVirtualFunctionPure();
586 friend void FunctionDecl::setPure(bool);
588 friend class ASTNodeImporter;
591 CXXRecordDecl(Kind K, TagKind TK, DeclContext *DC,
592 SourceLocation StartLoc, SourceLocation IdLoc,
593 IdentifierInfo *Id, CXXRecordDecl *PrevDecl);
596 /// base_class_iterator - Iterator that traverses the base classes
598 typedef CXXBaseSpecifier* base_class_iterator;
600 /// base_class_const_iterator - Iterator that traverses the base
601 /// classes of a class.
602 typedef const CXXBaseSpecifier* base_class_const_iterator;
604 /// reverse_base_class_iterator = Iterator that traverses the base classes
605 /// of a class in reverse order.
606 typedef std::reverse_iterator<base_class_iterator>
607 reverse_base_class_iterator;
609 /// reverse_base_class_iterator = Iterator that traverses the base classes
610 /// of a class in reverse order.
611 typedef std::reverse_iterator<base_class_const_iterator>
612 reverse_base_class_const_iterator;
614 virtual CXXRecordDecl *getCanonicalDecl() {
615 return cast<CXXRecordDecl>(RecordDecl::getCanonicalDecl());
617 virtual const CXXRecordDecl *getCanonicalDecl() const {
618 return cast<CXXRecordDecl>(RecordDecl::getCanonicalDecl());
621 const CXXRecordDecl *getPreviousDecl() const {
622 return cast_or_null<CXXRecordDecl>(RecordDecl::getPreviousDecl());
624 CXXRecordDecl *getPreviousDecl() {
625 return cast_or_null<CXXRecordDecl>(RecordDecl::getPreviousDecl());
628 const CXXRecordDecl *getMostRecentDecl() const {
629 return cast_or_null<CXXRecordDecl>(RecordDecl::getMostRecentDecl());
631 CXXRecordDecl *getMostRecentDecl() {
632 return cast_or_null<CXXRecordDecl>(RecordDecl::getMostRecentDecl());
635 CXXRecordDecl *getDefinition() const {
636 if (!DefinitionData) return 0;
637 return data().Definition;
640 bool hasDefinition() const { return DefinitionData != 0; }
642 static CXXRecordDecl *Create(const ASTContext &C, TagKind TK, DeclContext *DC,
643 SourceLocation StartLoc, SourceLocation IdLoc,
644 IdentifierInfo *Id, CXXRecordDecl* PrevDecl=0,
645 bool DelayTypeCreation = false);
646 static CXXRecordDecl *CreateLambda(const ASTContext &C, DeclContext *DC,
647 TypeSourceInfo *Info, SourceLocation Loc,
648 bool DependentLambda);
649 static CXXRecordDecl *CreateDeserialized(const ASTContext &C, unsigned ID);
651 bool isDynamicClass() const {
652 return data().Polymorphic || data().NumVBases != 0;
655 /// setBases - Sets the base classes of this struct or class.
656 void setBases(CXXBaseSpecifier const * const *Bases, unsigned NumBases);
658 /// getNumBases - Retrieves the number of base classes of this
660 unsigned getNumBases() const { return data().NumBases; }
662 base_class_iterator bases_begin() { return data().getBases(); }
663 base_class_const_iterator bases_begin() const { return data().getBases(); }
664 base_class_iterator bases_end() { return bases_begin() + data().NumBases; }
665 base_class_const_iterator bases_end() const {
666 return bases_begin() + data().NumBases;
668 reverse_base_class_iterator bases_rbegin() {
669 return reverse_base_class_iterator(bases_end());
671 reverse_base_class_const_iterator bases_rbegin() const {
672 return reverse_base_class_const_iterator(bases_end());
674 reverse_base_class_iterator bases_rend() {
675 return reverse_base_class_iterator(bases_begin());
677 reverse_base_class_const_iterator bases_rend() const {
678 return reverse_base_class_const_iterator(bases_begin());
681 /// getNumVBases - Retrieves the number of virtual base classes of this
683 unsigned getNumVBases() const { return data().NumVBases; }
685 base_class_iterator vbases_begin() { return data().getVBases(); }
686 base_class_const_iterator vbases_begin() const { return data().getVBases(); }
687 base_class_iterator vbases_end() { return vbases_begin() + data().NumVBases; }
688 base_class_const_iterator vbases_end() const {
689 return vbases_begin() + data().NumVBases;
691 reverse_base_class_iterator vbases_rbegin() {
692 return reverse_base_class_iterator(vbases_end());
694 reverse_base_class_const_iterator vbases_rbegin() const {
695 return reverse_base_class_const_iterator(vbases_end());
697 reverse_base_class_iterator vbases_rend() {
698 return reverse_base_class_iterator(vbases_begin());
700 reverse_base_class_const_iterator vbases_rend() const {
701 return reverse_base_class_const_iterator(vbases_begin());
704 /// \brief Determine whether this class has any dependent base classes which
705 /// are not the current instantiation.
706 bool hasAnyDependentBases() const;
708 /// Iterator access to method members. The method iterator visits
709 /// all method members of the class, including non-instance methods,
710 /// special methods, etc.
711 typedef specific_decl_iterator<CXXMethodDecl> method_iterator;
713 /// method_begin - Method begin iterator. Iterates in the order the methods
715 method_iterator method_begin() const {
716 return method_iterator(decls_begin());
718 /// method_end - Method end iterator.
719 method_iterator method_end() const {
720 return method_iterator(decls_end());
723 /// Iterator access to constructor members.
724 typedef specific_decl_iterator<CXXConstructorDecl> ctor_iterator;
726 ctor_iterator ctor_begin() const {
727 return ctor_iterator(decls_begin());
729 ctor_iterator ctor_end() const {
730 return ctor_iterator(decls_end());
733 /// An iterator over friend declarations. All of these are defined
735 class friend_iterator;
736 friend_iterator friend_begin() const;
737 friend_iterator friend_end() const;
738 void pushFriendDecl(FriendDecl *FD);
740 /// Determines whether this record has any friends.
741 bool hasFriends() const {
742 return data().FirstFriend != 0;
745 /// \brief \c true if we know for sure that this class has a single,
746 /// accessible, unambiguous move constructor that is not deleted.
747 bool hasSimpleMoveConstructor() const {
748 return !hasUserDeclaredMoveConstructor() && hasMoveConstructor();
750 /// \brief \c true if we know for sure that this class has a single,
751 /// accessible, unambiguous move assignment operator that is not deleted.
752 bool hasSimpleMoveAssignment() const {
753 return !hasUserDeclaredMoveAssignment() && hasMoveAssignment();
755 /// \brief \c true if we know for sure that this class has an accessible
756 /// destructor that is not deleted.
757 bool hasSimpleDestructor() const {
758 return !hasUserDeclaredDestructor() &&
759 !data().DefaultedDestructorIsDeleted;
762 /// \brief Determine whether this class has any default constructors.
763 bool hasDefaultConstructor() const {
764 return (data().DeclaredSpecialMembers & SMF_DefaultConstructor) ||
765 needsImplicitDefaultConstructor();
768 /// \brief Determine if we need to declare a default constructor for
771 /// This value is used for lazy creation of default constructors.
772 bool needsImplicitDefaultConstructor() const {
773 return !data().UserDeclaredConstructor &&
774 !(data().DeclaredSpecialMembers & SMF_DefaultConstructor);
777 /// hasUserDeclaredConstructor - Whether this class has any
778 /// user-declared constructors. When true, a default constructor
779 /// will not be implicitly declared.
780 bool hasUserDeclaredConstructor() const {
781 return data().UserDeclaredConstructor;
784 /// hasUserProvidedDefaultconstructor - Whether this class has a
785 /// user-provided default constructor per C++0x.
786 bool hasUserProvidedDefaultConstructor() const {
787 return data().UserProvidedDefaultConstructor;
790 /// hasUserDeclaredCopyConstructor - Whether this class has a
791 /// user-declared copy constructor. When false, a copy constructor
792 /// will be implicitly declared.
793 bool hasUserDeclaredCopyConstructor() const {
794 return data().UserDeclaredSpecialMembers & SMF_CopyConstructor;
797 /// \brief Determine whether this class needs an implicit copy
798 /// constructor to be lazily declared.
799 bool needsImplicitCopyConstructor() const {
800 return !(data().DeclaredSpecialMembers & SMF_CopyConstructor);
803 /// \brief Determine whether we need to eagerly declare a defaulted copy
804 /// constructor for this class.
805 bool needsOverloadResolutionForCopyConstructor() const {
806 return data().HasMutableFields;
809 /// \brief Determine whether an implicit copy constructor for this type
810 /// would have a parameter with a const-qualified reference type.
811 bool implicitCopyConstructorHasConstParam() const {
812 return data().ImplicitCopyConstructorHasConstParam;
815 /// \brief Determine whether this class has a copy constructor with
816 /// a parameter type which is a reference to a const-qualified type.
817 bool hasCopyConstructorWithConstParam() const {
818 return data().HasDeclaredCopyConstructorWithConstParam ||
819 (needsImplicitCopyConstructor() &&
820 implicitCopyConstructorHasConstParam());
823 /// hasUserDeclaredMoveOperation - Whether this class has a user-
824 /// declared move constructor or assignment operator. When false, a
825 /// move constructor and assignment operator may be implicitly declared.
826 bool hasUserDeclaredMoveOperation() const {
827 return data().UserDeclaredSpecialMembers &
828 (SMF_MoveConstructor | SMF_MoveAssignment);
831 /// \brief Determine whether this class has had a move constructor
832 /// declared by the user.
833 bool hasUserDeclaredMoveConstructor() const {
834 return data().UserDeclaredSpecialMembers & SMF_MoveConstructor;
837 /// \brief Determine whether this class has a move constructor.
838 bool hasMoveConstructor() const {
839 return (data().DeclaredSpecialMembers & SMF_MoveConstructor) ||
840 needsImplicitMoveConstructor();
843 /// \brief Determine whether implicit move constructor generation for this
844 /// class has failed before.
845 bool hasFailedImplicitMoveConstructor() const {
846 return data().FailedImplicitMoveConstructor;
849 /// \brief Set whether implicit move constructor generation for this class
850 /// has failed before.
851 void setFailedImplicitMoveConstructor(bool Failed = true) {
852 data().FailedImplicitMoveConstructor = Failed;
855 /// \brief Determine whether this class should get an implicit move
856 /// constructor or if any existing special member function inhibits this.
857 bool needsImplicitMoveConstructor() const {
858 return !hasFailedImplicitMoveConstructor() &&
859 !(data().DeclaredSpecialMembers & SMF_MoveConstructor) &&
860 !hasUserDeclaredCopyConstructor() &&
861 !hasUserDeclaredCopyAssignment() &&
862 !hasUserDeclaredMoveAssignment() &&
863 !hasUserDeclaredDestructor() &&
864 !data().DefaultedMoveConstructorIsDeleted;
867 /// \brief Determine whether we need to eagerly declare a defaulted move
868 /// constructor for this class.
869 bool needsOverloadResolutionForMoveConstructor() const {
870 return data().NeedOverloadResolutionForMoveConstructor;
873 /// hasUserDeclaredCopyAssignment - Whether this class has a
874 /// user-declared copy assignment operator. When false, a copy
875 /// assigment operator will be implicitly declared.
876 bool hasUserDeclaredCopyAssignment() const {
877 return data().UserDeclaredSpecialMembers & SMF_CopyAssignment;
880 /// \brief Determine whether this class needs an implicit copy
881 /// assignment operator to be lazily declared.
882 bool needsImplicitCopyAssignment() const {
883 return !(data().DeclaredSpecialMembers & SMF_CopyAssignment);
886 /// \brief Determine whether we need to eagerly declare a defaulted copy
887 /// assignment operator for this class.
888 bool needsOverloadResolutionForCopyAssignment() const {
889 return data().HasMutableFields;
892 /// \brief Determine whether an implicit copy assignment operator for this
893 /// type would have a parameter with a const-qualified reference type.
894 bool implicitCopyAssignmentHasConstParam() const {
895 return data().ImplicitCopyAssignmentHasConstParam;
898 /// \brief Determine whether this class has a copy assignment operator with
899 /// a parameter type which is a reference to a const-qualified type or is not
901 bool hasCopyAssignmentWithConstParam() const {
902 return data().HasDeclaredCopyAssignmentWithConstParam ||
903 (needsImplicitCopyAssignment() &&
904 implicitCopyAssignmentHasConstParam());
907 /// \brief Determine whether this class has had a move assignment
908 /// declared by the user.
909 bool hasUserDeclaredMoveAssignment() const {
910 return data().UserDeclaredSpecialMembers & SMF_MoveAssignment;
913 /// \brief Determine whether this class has a move assignment operator.
914 bool hasMoveAssignment() const {
915 return (data().DeclaredSpecialMembers & SMF_MoveAssignment) ||
916 needsImplicitMoveAssignment();
919 /// \brief Determine whether implicit move assignment generation for this
920 /// class has failed before.
921 bool hasFailedImplicitMoveAssignment() const {
922 return data().FailedImplicitMoveAssignment;
925 /// \brief Set whether implicit move assignment generation for this class
926 /// has failed before.
927 void setFailedImplicitMoveAssignment(bool Failed = true) {
928 data().FailedImplicitMoveAssignment = Failed;
931 /// \brief Determine whether this class should get an implicit move
932 /// assignment operator or if any existing special member function inhibits
934 bool needsImplicitMoveAssignment() const {
935 return !hasFailedImplicitMoveAssignment() &&
936 !(data().DeclaredSpecialMembers & SMF_MoveAssignment) &&
937 !hasUserDeclaredCopyConstructor() &&
938 !hasUserDeclaredCopyAssignment() &&
939 !hasUserDeclaredMoveConstructor() &&
940 !hasUserDeclaredDestructor() &&
941 !data().DefaultedMoveAssignmentIsDeleted;
944 /// \brief Determine whether we need to eagerly declare a move assignment
945 /// operator for this class.
946 bool needsOverloadResolutionForMoveAssignment() const {
947 return data().NeedOverloadResolutionForMoveAssignment;
950 /// hasUserDeclaredDestructor - Whether this class has a
951 /// user-declared destructor. When false, a destructor will be
952 /// implicitly declared.
953 bool hasUserDeclaredDestructor() const {
954 return data().UserDeclaredSpecialMembers & SMF_Destructor;
957 /// \brief Determine whether this class needs an implicit destructor to
958 /// be lazily declared.
959 bool needsImplicitDestructor() const {
960 return !(data().DeclaredSpecialMembers & SMF_Destructor);
963 /// \brief Determine whether we need to eagerly declare a destructor for this
965 bool needsOverloadResolutionForDestructor() const {
966 return data().NeedOverloadResolutionForDestructor;
969 /// \brief Determine whether this class describes a lambda function object.
970 bool isLambda() const { return hasDefinition() && data().IsLambda; }
972 /// \brief For a closure type, retrieve the mapping from captured
973 /// variables and this to the non-static data members that store the
974 /// values or references of the captures.
976 /// \param Captures Will be populated with the mapping from captured
977 /// variables to the corresponding fields.
979 /// \param ThisCapture Will be set to the field declaration for the
981 void getCaptureFields(llvm::DenseMap<const VarDecl *, FieldDecl *> &Captures,
982 FieldDecl *&ThisCapture) const;
984 typedef const LambdaExpr::Capture* capture_const_iterator;
985 capture_const_iterator captures_begin() const {
986 return isLambda() ? getLambdaData().Captures : NULL;
988 capture_const_iterator captures_end() const {
989 return isLambda() ? captures_begin() + getLambdaData().NumCaptures : NULL;
992 typedef UnresolvedSetIterator conversion_iterator;
993 conversion_iterator conversion_begin() const {
994 return data().Conversions.begin();
996 conversion_iterator conversion_end() const {
997 return data().Conversions.end();
1000 /// Removes a conversion function from this class. The conversion
1001 /// function must currently be a member of this class. Furthermore,
1002 /// this class must currently be in the process of being defined.
1003 void removeConversion(const NamedDecl *Old);
1005 /// getVisibleConversionFunctions - get all conversion functions visible
1006 /// in current class; including conversion function templates.
1007 std::pair<conversion_iterator, conversion_iterator>
1008 getVisibleConversionFunctions();
1010 /// isAggregate - Whether this class is an aggregate (C++
1011 /// [dcl.init.aggr]), which is a class with no user-declared
1012 /// constructors, no private or protected non-static data members,
1013 /// no base classes, and no virtual functions (C++ [dcl.init.aggr]p1).
1014 bool isAggregate() const { return data().Aggregate; }
1016 /// hasInClassInitializer - Whether this class has any in-class initializers
1017 /// for non-static data members.
1018 bool hasInClassInitializer() const { return data().HasInClassInitializer; }
1020 /// \brief Whether this class or any of its subobjects has any members of
1021 /// reference type which would make value-initialization ill-formed, per
1022 /// C++03 [dcl.init]p5:
1023 /// -- if T is a non-union class type without a user-declared constructor,
1024 /// then every non-static data member and base-class component of T is
1025 /// value-initialized
1027 /// A program that calls for [...] value-initialization of an entity of
1028 /// reference type is ill-formed.
1029 bool hasUninitializedReferenceMember() const {
1030 return !isUnion() && !hasUserDeclaredConstructor() &&
1031 data().HasUninitializedReferenceMember;
1034 /// isPOD - Whether this class is a POD-type (C++ [class]p4), which is a class
1035 /// that is an aggregate that has no non-static non-POD data members, no
1036 /// reference data members, no user-defined copy assignment operator and no
1037 /// user-defined destructor.
1039 /// Note that this is the C++ TR1 definition of POD.
1040 bool isPOD() const { return data().PlainOldData; }
1042 /// \brief True if this class is C-like, without C++-specific features, e.g.
1043 /// it contains only public fields, no bases, tag kind is not 'class', etc.
1044 bool isCLike() const;
1046 /// isEmpty - Whether this class is empty (C++0x [meta.unary.prop]), which
1047 /// means it has a virtual function, virtual base, data member (other than
1048 /// 0-width bit-field) or inherits from a non-empty class. Does NOT include
1049 /// a check for union-ness.
1050 bool isEmpty() const { return data().Empty; }
1052 /// isPolymorphic - Whether this class is polymorphic (C++ [class.virtual]),
1053 /// which means that the class contains or inherits a virtual function.
1054 bool isPolymorphic() const { return data().Polymorphic; }
1056 /// isAbstract - Whether this class is abstract (C++ [class.abstract]),
1057 /// which means that the class contains or inherits a pure virtual function.
1058 bool isAbstract() const { return data().Abstract; }
1060 /// isStandardLayout - Whether this class has standard layout
1062 bool isStandardLayout() const { return data().IsStandardLayout; }
1064 /// \brief Whether this class, or any of its class subobjects, contains a
1066 bool hasMutableFields() const { return data().HasMutableFields; }
1068 /// \brief Determine whether this class has a trivial default constructor
1069 /// (C++11 [class.ctor]p5).
1070 bool hasTrivialDefaultConstructor() const {
1071 return hasDefaultConstructor() &&
1072 (data().HasTrivialSpecialMembers & SMF_DefaultConstructor);
1075 /// \brief Determine whether this class has a non-trivial default constructor
1076 /// (C++11 [class.ctor]p5).
1077 bool hasNonTrivialDefaultConstructor() const {
1078 return (data().DeclaredNonTrivialSpecialMembers & SMF_DefaultConstructor) ||
1079 (needsImplicitDefaultConstructor() &&
1080 !(data().HasTrivialSpecialMembers & SMF_DefaultConstructor));
1083 /// \brief Determine whether this class has at least one constexpr constructor
1084 /// other than the copy or move constructors.
1085 bool hasConstexprNonCopyMoveConstructor() const {
1086 return data().HasConstexprNonCopyMoveConstructor ||
1087 (needsImplicitDefaultConstructor() &&
1088 defaultedDefaultConstructorIsConstexpr());
1091 /// \brief Determine whether a defaulted default constructor for this class
1092 /// would be constexpr.
1093 bool defaultedDefaultConstructorIsConstexpr() const {
1094 return data().DefaultedDefaultConstructorIsConstexpr &&
1095 (!isUnion() || hasInClassInitializer());
1098 /// \brief Determine whether this class has a constexpr default constructor.
1099 bool hasConstexprDefaultConstructor() const {
1100 return data().HasConstexprDefaultConstructor ||
1101 (needsImplicitDefaultConstructor() &&
1102 defaultedDefaultConstructorIsConstexpr());
1105 /// \brief Determine whether this class has a trivial copy constructor
1106 /// (C++ [class.copy]p6, C++11 [class.copy]p12)
1107 bool hasTrivialCopyConstructor() const {
1108 return data().HasTrivialSpecialMembers & SMF_CopyConstructor;
1111 /// \brief Determine whether this class has a non-trivial copy constructor
1112 /// (C++ [class.copy]p6, C++11 [class.copy]p12)
1113 bool hasNonTrivialCopyConstructor() const {
1114 return data().DeclaredNonTrivialSpecialMembers & SMF_CopyConstructor ||
1115 !hasTrivialCopyConstructor();
1118 /// \brief Determine whether this class has a trivial move constructor
1119 /// (C++11 [class.copy]p12)
1120 bool hasTrivialMoveConstructor() const {
1121 return hasMoveConstructor() &&
1122 (data().HasTrivialSpecialMembers & SMF_MoveConstructor);
1125 /// \brief Determine whether this class has a non-trivial move constructor
1126 /// (C++11 [class.copy]p12)
1127 bool hasNonTrivialMoveConstructor() const {
1128 return (data().DeclaredNonTrivialSpecialMembers & SMF_MoveConstructor) ||
1129 (needsImplicitMoveConstructor() &&
1130 !(data().HasTrivialSpecialMembers & SMF_MoveConstructor));
1133 /// \brief Determine whether this class has a trivial copy assignment operator
1134 /// (C++ [class.copy]p11, C++11 [class.copy]p25)
1135 bool hasTrivialCopyAssignment() const {
1136 return data().HasTrivialSpecialMembers & SMF_CopyAssignment;
1139 /// \brief Determine whether this class has a non-trivial copy assignment
1140 /// operator (C++ [class.copy]p11, C++11 [class.copy]p25)
1141 bool hasNonTrivialCopyAssignment() const {
1142 return data().DeclaredNonTrivialSpecialMembers & SMF_CopyAssignment ||
1143 !hasTrivialCopyAssignment();
1146 /// \brief Determine whether this class has a trivial move assignment operator
1147 /// (C++11 [class.copy]p25)
1148 bool hasTrivialMoveAssignment() const {
1149 return hasMoveAssignment() &&
1150 (data().HasTrivialSpecialMembers & SMF_MoveAssignment);
1153 /// \brief Determine whether this class has a non-trivial move assignment
1154 /// operator (C++11 [class.copy]p25)
1155 bool hasNonTrivialMoveAssignment() const {
1156 return (data().DeclaredNonTrivialSpecialMembers & SMF_MoveAssignment) ||
1157 (needsImplicitMoveAssignment() &&
1158 !(data().HasTrivialSpecialMembers & SMF_MoveAssignment));
1161 /// \brief Determine whether this class has a trivial destructor
1162 /// (C++ [class.dtor]p3)
1163 bool hasTrivialDestructor() const {
1164 return data().HasTrivialSpecialMembers & SMF_Destructor;
1167 /// \brief Determine whether this class has a non-trivial destructor
1168 /// (C++ [class.dtor]p3)
1169 bool hasNonTrivialDestructor() const {
1170 return !(data().HasTrivialSpecialMembers & SMF_Destructor);
1173 // hasIrrelevantDestructor - Whether this class has a destructor which has no
1174 // semantic effect. Any such destructor will be trivial, public, defaulted
1175 // and not deleted, and will call only irrelevant destructors.
1176 bool hasIrrelevantDestructor() const {
1177 return data().HasIrrelevantDestructor;
1180 // hasNonLiteralTypeFieldsOrBases - Whether this class has a non-literal or
1181 // volatile type non-static data member or base class.
1182 bool hasNonLiteralTypeFieldsOrBases() const {
1183 return data().HasNonLiteralTypeFieldsOrBases;
1186 // isTriviallyCopyable - Whether this class is considered trivially copyable
1187 // (C++0x [class]p6).
1188 bool isTriviallyCopyable() const;
1190 // isTrivial - Whether this class is considered trivial
1193 // A trivial class is a class that has a trivial default constructor and
1194 // is trivially copiable.
1195 bool isTrivial() const {
1196 return isTriviallyCopyable() && hasTrivialDefaultConstructor();
1199 // isLiteral - Whether this class is a literal type.
1201 // C++11 [basic.types]p10
1202 // A class type that has all the following properties:
1203 // -- it has a trivial destructor
1204 // -- every constructor call and full-expression in the
1205 // brace-or-equal-intializers for non-static data members (if any) is
1206 // a constant expression.
1207 // -- it is an aggregate type or has at least one constexpr constructor or
1208 // constructor template that is not a copy or move constructor, and
1209 // -- all of its non-static data members and base classes are of literal
1212 // We resolve DR1361 by ignoring the second bullet. We resolve DR1452 by
1213 // treating types with trivial default constructors as literal types.
1214 bool isLiteral() const {
1215 return hasTrivialDestructor() &&
1216 (isAggregate() || hasConstexprNonCopyMoveConstructor() ||
1217 hasTrivialDefaultConstructor()) &&
1218 !hasNonLiteralTypeFieldsOrBases();
1221 /// \brief If this record is an instantiation of a member class,
1222 /// retrieves the member class from which it was instantiated.
1224 /// This routine will return non-NULL for (non-templated) member
1225 /// classes of class templates. For example, given:
1228 /// template<typename T>
1234 /// The declaration for X<int>::A is a (non-templated) CXXRecordDecl
1235 /// whose parent is the class template specialization X<int>. For
1236 /// this declaration, getInstantiatedFromMemberClass() will return
1237 /// the CXXRecordDecl X<T>::A. When a complete definition of
1238 /// X<int>::A is required, it will be instantiated from the
1239 /// declaration returned by getInstantiatedFromMemberClass().
1240 CXXRecordDecl *getInstantiatedFromMemberClass() const;
1242 /// \brief If this class is an instantiation of a member class of a
1243 /// class template specialization, retrieves the member specialization
1245 MemberSpecializationInfo *getMemberSpecializationInfo() const {
1246 return TemplateOrInstantiation.dyn_cast<MemberSpecializationInfo *>();
1249 /// \brief Specify that this record is an instantiation of the
1250 /// member class RD.
1251 void setInstantiationOfMemberClass(CXXRecordDecl *RD,
1252 TemplateSpecializationKind TSK);
1254 /// \brief Retrieves the class template that is described by this
1255 /// class declaration.
1257 /// Every class template is represented as a ClassTemplateDecl and a
1258 /// CXXRecordDecl. The former contains template properties (such as
1259 /// the template parameter lists) while the latter contains the
1260 /// actual description of the template's
1261 /// contents. ClassTemplateDecl::getTemplatedDecl() retrieves the
1262 /// CXXRecordDecl that from a ClassTemplateDecl, while
1263 /// getDescribedClassTemplate() retrieves the ClassTemplateDecl from
1264 /// a CXXRecordDecl.
1265 ClassTemplateDecl *getDescribedClassTemplate() const {
1266 return TemplateOrInstantiation.dyn_cast<ClassTemplateDecl*>();
1269 void setDescribedClassTemplate(ClassTemplateDecl *Template) {
1270 TemplateOrInstantiation = Template;
1273 /// \brief Determine whether this particular class is a specialization or
1274 /// instantiation of a class template or member class of a class template,
1275 /// and how it was instantiated or specialized.
1276 TemplateSpecializationKind getTemplateSpecializationKind() const;
1278 /// \brief Set the kind of specialization or template instantiation this is.
1279 void setTemplateSpecializationKind(TemplateSpecializationKind TSK);
1281 /// getDestructor - Returns the destructor decl for this class.
1282 CXXDestructorDecl *getDestructor() const;
1284 /// isLocalClass - If the class is a local class [class.local], returns
1285 /// the enclosing function declaration.
1286 const FunctionDecl *isLocalClass() const {
1287 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(getDeclContext()))
1288 return RD->isLocalClass();
1290 return dyn_cast<FunctionDecl>(getDeclContext());
1293 /// \brief Determine whether this dependent class is a current instantiation,
1294 /// when viewed from within the given context.
1295 bool isCurrentInstantiation(const DeclContext *CurContext) const;
1297 /// \brief Determine whether this class is derived from the class \p Base.
1299 /// This routine only determines whether this class is derived from \p Base,
1300 /// but does not account for factors that may make a Derived -> Base class
1301 /// ill-formed, such as private/protected inheritance or multiple, ambiguous
1302 /// base class subobjects.
1304 /// \param Base the base class we are searching for.
1306 /// \returns true if this class is derived from Base, false otherwise.
1307 bool isDerivedFrom(const CXXRecordDecl *Base) const;
1309 /// \brief Determine whether this class is derived from the type \p Base.
1311 /// This routine only determines whether this class is derived from \p Base,
1312 /// but does not account for factors that may make a Derived -> Base class
1313 /// ill-formed, such as private/protected inheritance or multiple, ambiguous
1314 /// base class subobjects.
1316 /// \param Base the base class we are searching for.
1318 /// \param Paths will contain the paths taken from the current class to the
1319 /// given \p Base class.
1321 /// \returns true if this class is derived from Base, false otherwise.
1323 /// \todo add a separate paramaeter to configure IsDerivedFrom, rather than
1324 /// tangling input and output in \p Paths
1325 bool isDerivedFrom(const CXXRecordDecl *Base, CXXBasePaths &Paths) const;
1327 /// \brief Determine whether this class is virtually derived from
1328 /// the class \p Base.
1330 /// This routine only determines whether this class is virtually
1331 /// derived from \p Base, but does not account for factors that may
1332 /// make a Derived -> Base class ill-formed, such as
1333 /// private/protected inheritance or multiple, ambiguous base class
1336 /// \param Base the base class we are searching for.
1338 /// \returns true if this class is virtually derived from Base,
1339 /// false otherwise.
1340 bool isVirtuallyDerivedFrom(const CXXRecordDecl *Base) const;
1342 /// \brief Determine whether this class is provably not derived from
1343 /// the type \p Base.
1344 bool isProvablyNotDerivedFrom(const CXXRecordDecl *Base) const;
1346 /// \brief Function type used by forallBases() as a callback.
1348 /// \param BaseDefinition the definition of the base class
1350 /// \returns true if this base matched the search criteria
1351 typedef bool ForallBasesCallback(const CXXRecordDecl *BaseDefinition,
1354 /// \brief Determines if the given callback holds for all the direct
1355 /// or indirect base classes of this type.
1357 /// The class itself does not count as a base class. This routine
1358 /// returns false if the class has non-computable base classes.
1360 /// \param AllowShortCircuit if false, forces the callback to be called
1361 /// for every base class, even if a dependent or non-matching base was
1363 bool forallBases(ForallBasesCallback *BaseMatches, void *UserData,
1364 bool AllowShortCircuit = true) const;
1366 /// \brief Function type used by lookupInBases() to determine whether a
1367 /// specific base class subobject matches the lookup criteria.
1369 /// \param Specifier the base-class specifier that describes the inheritance
1370 /// from the base class we are trying to match.
1372 /// \param Path the current path, from the most-derived class down to the
1373 /// base named by the \p Specifier.
1375 /// \param UserData a single pointer to user-specified data, provided to
1376 /// lookupInBases().
1378 /// \returns true if this base matched the search criteria, false otherwise.
1379 typedef bool BaseMatchesCallback(const CXXBaseSpecifier *Specifier,
1383 /// \brief Look for entities within the base classes of this C++ class,
1384 /// transitively searching all base class subobjects.
1386 /// This routine uses the callback function \p BaseMatches to find base
1387 /// classes meeting some search criteria, walking all base class subobjects
1388 /// and populating the given \p Paths structure with the paths through the
1389 /// inheritance hierarchy that resulted in a match. On a successful search,
1390 /// the \p Paths structure can be queried to retrieve the matching paths and
1391 /// to determine if there were any ambiguities.
1393 /// \param BaseMatches callback function used to determine whether a given
1394 /// base matches the user-defined search criteria.
1396 /// \param UserData user data pointer that will be provided to \p BaseMatches.
1398 /// \param Paths used to record the paths from this class to its base class
1399 /// subobjects that match the search criteria.
1401 /// \returns true if there exists any path from this class to a base class
1402 /// subobject that matches the search criteria.
1403 bool lookupInBases(BaseMatchesCallback *BaseMatches, void *UserData,
1404 CXXBasePaths &Paths) const;
1406 /// \brief Base-class lookup callback that determines whether the given
1407 /// base class specifier refers to a specific class declaration.
1409 /// This callback can be used with \c lookupInBases() to determine whether
1410 /// a given derived class has is a base class subobject of a particular type.
1411 /// The user data pointer should refer to the canonical CXXRecordDecl of the
1412 /// base class that we are searching for.
1413 static bool FindBaseClass(const CXXBaseSpecifier *Specifier,
1414 CXXBasePath &Path, void *BaseRecord);
1416 /// \brief Base-class lookup callback that determines whether the
1417 /// given base class specifier refers to a specific class
1418 /// declaration and describes virtual derivation.
1420 /// This callback can be used with \c lookupInBases() to determine
1421 /// whether a given derived class has is a virtual base class
1422 /// subobject of a particular type. The user data pointer should
1423 /// refer to the canonical CXXRecordDecl of the base class that we
1424 /// are searching for.
1425 static bool FindVirtualBaseClass(const CXXBaseSpecifier *Specifier,
1426 CXXBasePath &Path, void *BaseRecord);
1428 /// \brief Base-class lookup callback that determines whether there exists
1429 /// a tag with the given name.
1431 /// This callback can be used with \c lookupInBases() to find tag members
1432 /// of the given name within a C++ class hierarchy. The user data pointer
1433 /// is an opaque \c DeclarationName pointer.
1434 static bool FindTagMember(const CXXBaseSpecifier *Specifier,
1435 CXXBasePath &Path, void *Name);
1437 /// \brief Base-class lookup callback that determines whether there exists
1438 /// a member with the given name.
1440 /// This callback can be used with \c lookupInBases() to find members
1441 /// of the given name within a C++ class hierarchy. The user data pointer
1442 /// is an opaque \c DeclarationName pointer.
1443 static bool FindOrdinaryMember(const CXXBaseSpecifier *Specifier,
1444 CXXBasePath &Path, void *Name);
1446 /// \brief Base-class lookup callback that determines whether there exists
1447 /// a member with the given name that can be used in a nested-name-specifier.
1449 /// This callback can be used with \c lookupInBases() to find membes of
1450 /// the given name within a C++ class hierarchy that can occur within
1451 /// nested-name-specifiers.
1452 static bool FindNestedNameSpecifierMember(const CXXBaseSpecifier *Specifier,
1456 /// \brief Retrieve the final overriders for each virtual member
1457 /// function in the class hierarchy where this class is the
1458 /// most-derived class in the class hierarchy.
1459 void getFinalOverriders(CXXFinalOverriderMap &FinaOverriders) const;
1461 /// \brief Get the indirect primary bases for this class.
1462 void getIndirectPrimaryBases(CXXIndirectPrimaryBaseSet& Bases) const;
1464 /// viewInheritance - Renders and displays an inheritance diagram
1465 /// for this C++ class and all of its base classes (transitively) using
1467 void viewInheritance(ASTContext& Context) const;
1469 /// MergeAccess - Calculates the access of a decl that is reached
1471 static AccessSpecifier MergeAccess(AccessSpecifier PathAccess,
1472 AccessSpecifier DeclAccess) {
1473 assert(DeclAccess != AS_none);
1474 if (DeclAccess == AS_private) return AS_none;
1475 return (PathAccess > DeclAccess ? PathAccess : DeclAccess);
1478 /// \brief Indicates that the declaration of a defaulted or deleted special
1479 /// member function is now complete.
1480 void finishedDefaultedOrDeletedMember(CXXMethodDecl *MD);
1482 /// \brief Indicates that the definition of this class is now complete.
1483 virtual void completeDefinition();
1485 /// \brief Indicates that the definition of this class is now complete,
1486 /// and provides a final overrider map to help determine
1488 /// \param FinalOverriders The final overrider map for this class, which can
1489 /// be provided as an optimization for abstract-class checking. If NULL,
1490 /// final overriders will be computed if they are needed to complete the
1492 void completeDefinition(CXXFinalOverriderMap *FinalOverriders);
1494 /// \brief Determine whether this class may end up being abstract, even though
1495 /// it is not yet known to be abstract.
1497 /// \returns true if this class is not known to be abstract but has any
1498 /// base classes that are abstract. In this case, \c completeDefinition()
1499 /// will need to compute final overriders to determine whether the class is
1500 /// actually abstract.
1501 bool mayBeAbstract() const;
1503 /// \brief If this is the closure type of a lambda expression, retrieve the
1504 /// number to be used for name mangling in the Itanium C++ ABI.
1506 /// Zero indicates that this closure type has internal linkage, so the
1507 /// mangling number does not matter, while a non-zero value indicates which
1508 /// lambda expression this is in this particular context.
1509 unsigned getLambdaManglingNumber() const {
1510 assert(isLambda() && "Not a lambda closure type!");
1511 return getLambdaData().ManglingNumber;
1514 /// \brief Retrieve the declaration that provides additional context for a
1515 /// lambda, when the normal declaration context is not specific enough.
1517 /// Certain contexts (default arguments of in-class function parameters and
1518 /// the initializers of data members) have separate name mangling rules for
1519 /// lambdas within the Itanium C++ ABI. For these cases, this routine provides
1520 /// the declaration in which the lambda occurs, e.g., the function parameter
1521 /// or the non-static data member. Otherwise, it returns NULL to imply that
1522 /// the declaration context suffices.
1523 Decl *getLambdaContextDecl() const {
1524 assert(isLambda() && "Not a lambda closure type!");
1525 return getLambdaData().ContextDecl;
1528 /// \brief Set the mangling number and context declaration for a lambda
1530 void setLambdaMangling(unsigned ManglingNumber, Decl *ContextDecl) {
1531 getLambdaData().ManglingNumber = ManglingNumber;
1532 getLambdaData().ContextDecl = ContextDecl;
1535 /// \brief Returns the inheritance model used for this record.
1536 MSInheritanceModel getMSInheritanceModel() const;
1538 /// \brief Determine whether this lambda expression was known to be dependent
1539 /// at the time it was created, even if its context does not appear to be
1542 /// This flag is a workaround for an issue with parsing, where default
1543 /// arguments are parsed before their enclosing function declarations have
1544 /// been created. This means that any lambda expressions within those
1545 /// default arguments will have as their DeclContext the context enclosing
1546 /// the function declaration, which may be non-dependent even when the
1547 /// function declaration itself is dependent. This flag indicates when we
1548 /// know that the lambda is dependent despite that.
1549 bool isDependentLambda() const {
1550 return isLambda() && getLambdaData().Dependent;
1553 TypeSourceInfo *getLambdaTypeInfo() const {
1554 return getLambdaData().MethodTyInfo;
1557 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1558 static bool classofKind(Kind K) {
1559 return K >= firstCXXRecord && K <= lastCXXRecord;
1562 friend class ASTDeclReader;
1563 friend class ASTDeclWriter;
1564 friend class ASTReader;
1565 friend class ASTWriter;
1568 /// CXXMethodDecl - Represents a static or instance method of a
1569 /// struct/union/class.
1570 class CXXMethodDecl : public FunctionDecl {
1571 virtual void anchor();
1573 CXXMethodDecl(Kind DK, CXXRecordDecl *RD, SourceLocation StartLoc,
1574 const DeclarationNameInfo &NameInfo,
1575 QualType T, TypeSourceInfo *TInfo,
1576 StorageClass SC, bool isInline,
1577 bool isConstexpr, SourceLocation EndLocation)
1578 : FunctionDecl(DK, RD, StartLoc, NameInfo, T, TInfo,
1579 SC, isInline, isConstexpr) {
1580 if (EndLocation.isValid())
1581 setRangeEnd(EndLocation);
1585 static CXXMethodDecl *Create(ASTContext &C, CXXRecordDecl *RD,
1586 SourceLocation StartLoc,
1587 const DeclarationNameInfo &NameInfo,
1588 QualType T, TypeSourceInfo *TInfo,
1592 SourceLocation EndLocation);
1594 static CXXMethodDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1596 bool isStatic() const;
1597 bool isInstance() const { return !isStatic(); }
1599 bool isConst() const { return getType()->castAs<FunctionType>()->isConst(); }
1600 bool isVolatile() const { return getType()->castAs<FunctionType>()->isVolatile(); }
1602 bool isVirtual() const {
1604 cast<CXXMethodDecl>(const_cast<CXXMethodDecl*>(this)->getCanonicalDecl());
1606 // Methods declared in interfaces are automatically (pure) virtual.
1607 if (CD->isVirtualAsWritten() ||
1608 (CD->getParent()->isInterface() && CD->isUserProvided()))
1611 return (CD->begin_overridden_methods() != CD->end_overridden_methods());
1614 /// \brief Determine whether this is a usual deallocation function
1615 /// (C++ [basic.stc.dynamic.deallocation]p2), which is an overloaded
1616 /// delete or delete[] operator with a particular signature.
1617 bool isUsualDeallocationFunction() const;
1619 /// \brief Determine whether this is a copy-assignment operator, regardless
1620 /// of whether it was declared implicitly or explicitly.
1621 bool isCopyAssignmentOperator() const;
1623 /// \brief Determine whether this is a move assignment operator.
1624 bool isMoveAssignmentOperator() const;
1626 const CXXMethodDecl *getCanonicalDecl() const {
1627 return cast<CXXMethodDecl>(FunctionDecl::getCanonicalDecl());
1629 CXXMethodDecl *getCanonicalDecl() {
1630 return cast<CXXMethodDecl>(FunctionDecl::getCanonicalDecl());
1633 /// isUserProvided - True if this method is user-declared and was not
1634 /// deleted or defaulted on its first declaration.
1635 bool isUserProvided() const {
1636 return !(isDeleted() || getCanonicalDecl()->isDefaulted());
1640 void addOverriddenMethod(const CXXMethodDecl *MD);
1642 typedef const CXXMethodDecl *const* method_iterator;
1644 method_iterator begin_overridden_methods() const;
1645 method_iterator end_overridden_methods() const;
1646 unsigned size_overridden_methods() const;
1648 /// getParent - Returns the parent of this method declaration, which
1649 /// is the class in which this method is defined.
1650 const CXXRecordDecl *getParent() const {
1651 return cast<CXXRecordDecl>(FunctionDecl::getParent());
1654 /// getParent - Returns the parent of this method declaration, which
1655 /// is the class in which this method is defined.
1656 CXXRecordDecl *getParent() {
1657 return const_cast<CXXRecordDecl *>(
1658 cast<CXXRecordDecl>(FunctionDecl::getParent()));
1661 /// getThisType - Returns the type of 'this' pointer.
1662 /// Should only be called for instance methods.
1663 QualType getThisType(ASTContext &C) const;
1665 unsigned getTypeQualifiers() const {
1666 return getType()->getAs<FunctionProtoType>()->getTypeQuals();
1669 /// \brief Retrieve the ref-qualifier associated with this method.
1671 /// In the following example, \c f() has an lvalue ref-qualifier, \c g()
1672 /// has an rvalue ref-qualifier, and \c h() has no ref-qualifier.
1680 RefQualifierKind getRefQualifier() const {
1681 return getType()->getAs<FunctionProtoType>()->getRefQualifier();
1684 bool hasInlineBody() const;
1686 /// \brief Determine whether this is a lambda closure type's static member
1687 /// function that is used for the result of the lambda's conversion to
1688 /// function pointer (for a lambda with no captures).
1690 /// The function itself, if used, will have a placeholder body that will be
1691 /// supplied by IR generation to either forward to the function call operator
1692 /// or clone the function call operator.
1693 bool isLambdaStaticInvoker() const;
1695 /// \brief Find the method in RD that corresponds to this one.
1697 /// Find if RD or one of the classes it inherits from override this method.
1698 /// If so, return it. RD is assumed to be a subclass of the class defining
1699 /// this method (or be the class itself), unless MayBeBase is set to true.
1701 getCorrespondingMethodInClass(const CXXRecordDecl *RD,
1702 bool MayBeBase = false);
1704 const CXXMethodDecl *
1705 getCorrespondingMethodInClass(const CXXRecordDecl *RD,
1706 bool MayBeBase = false) const {
1707 return const_cast<CXXMethodDecl *>(this)
1708 ->getCorrespondingMethodInClass(RD, MayBeBase);
1711 // Implement isa/cast/dyncast/etc.
1712 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1713 static bool classofKind(Kind K) {
1714 return K >= firstCXXMethod && K <= lastCXXMethod;
1718 /// CXXCtorInitializer - Represents a C++ base or member
1719 /// initializer, which is part of a constructor initializer that
1720 /// initializes one non-static member variable or one base class. For
1721 /// example, in the following, both 'A(a)' and 'f(3.14159)' are member
1726 /// class B : public A {
1729 /// B(A& a) : A(a), f(3.14159) { }
1732 class CXXCtorInitializer {
1733 /// \brief Either the base class name/delegating constructor type (stored as
1734 /// a TypeSourceInfo*), an normal field (FieldDecl), or an anonymous field
1735 /// (IndirectFieldDecl*) being initialized.
1736 llvm::PointerUnion3<TypeSourceInfo *, FieldDecl *, IndirectFieldDecl *>
1739 /// \brief The source location for the field name or, for a base initializer
1740 /// pack expansion, the location of the ellipsis. In the case of a delegating
1741 /// constructor, it will still include the type's source location as the
1742 /// Initializee points to the CXXConstructorDecl (to allow loop detection).
1743 SourceLocation MemberOrEllipsisLocation;
1745 /// \brief The argument used to initialize the base or member, which may
1746 /// end up constructing an object (when multiple arguments are involved).
1747 /// If 0, this is a field initializer, and the in-class member initializer
1751 /// LParenLoc - Location of the left paren of the ctor-initializer.
1752 SourceLocation LParenLoc;
1754 /// RParenLoc - Location of the right paren of the ctor-initializer.
1755 SourceLocation RParenLoc;
1757 /// \brief If the initializee is a type, whether that type makes this
1758 /// a delegating initialization.
1759 bool IsDelegating : 1;
1761 /// IsVirtual - If the initializer is a base initializer, this keeps track
1762 /// of whether the base is virtual or not.
1765 /// IsWritten - Whether or not the initializer is explicitly written
1769 /// SourceOrderOrNumArrayIndices - If IsWritten is true, then this
1770 /// number keeps track of the textual order of this initializer in the
1771 /// original sources, counting from 0; otherwise, if IsWritten is false,
1772 /// it stores the number of array index variables stored after this
1773 /// object in memory.
1774 unsigned SourceOrderOrNumArrayIndices : 13;
1776 CXXCtorInitializer(ASTContext &Context, FieldDecl *Member,
1777 SourceLocation MemberLoc, SourceLocation L, Expr *Init,
1778 SourceLocation R, VarDecl **Indices, unsigned NumIndices);
1781 /// CXXCtorInitializer - Creates a new base-class initializer.
1783 CXXCtorInitializer(ASTContext &Context, TypeSourceInfo *TInfo, bool IsVirtual,
1784 SourceLocation L, Expr *Init, SourceLocation R,
1785 SourceLocation EllipsisLoc);
1787 /// CXXCtorInitializer - Creates a new member initializer.
1789 CXXCtorInitializer(ASTContext &Context, FieldDecl *Member,
1790 SourceLocation MemberLoc, SourceLocation L, Expr *Init,
1793 /// CXXCtorInitializer - Creates a new anonymous field initializer.
1795 CXXCtorInitializer(ASTContext &Context, IndirectFieldDecl *Member,
1796 SourceLocation MemberLoc, SourceLocation L, Expr *Init,
1799 /// CXXCtorInitializer - Creates a new delegating Initializer.
1801 CXXCtorInitializer(ASTContext &Context, TypeSourceInfo *TInfo,
1802 SourceLocation L, Expr *Init, SourceLocation R);
1804 /// \brief Creates a new member initializer that optionally contains
1805 /// array indices used to describe an elementwise initialization.
1806 static CXXCtorInitializer *Create(ASTContext &Context, FieldDecl *Member,
1807 SourceLocation MemberLoc, SourceLocation L,
1808 Expr *Init, SourceLocation R,
1809 VarDecl **Indices, unsigned NumIndices);
1811 /// isBaseInitializer - Returns true when this initializer is
1812 /// initializing a base class.
1813 bool isBaseInitializer() const {
1814 return Initializee.is<TypeSourceInfo*>() && !IsDelegating;
1817 /// isMemberInitializer - Returns true when this initializer is
1818 /// initializing a non-static data member.
1819 bool isMemberInitializer() const { return Initializee.is<FieldDecl*>(); }
1821 bool isAnyMemberInitializer() const {
1822 return isMemberInitializer() || isIndirectMemberInitializer();
1825 bool isIndirectMemberInitializer() const {
1826 return Initializee.is<IndirectFieldDecl*>();
1829 /// isInClassMemberInitializer - Returns true when this initializer is an
1830 /// implicit ctor initializer generated for a field with an initializer
1831 /// defined on the member declaration.
1832 bool isInClassMemberInitializer() const {
1836 /// isDelegatingInitializer - Returns true when this initializer is creating
1837 /// a delegating constructor.
1838 bool isDelegatingInitializer() const {
1839 return Initializee.is<TypeSourceInfo*>() && IsDelegating;
1842 /// \brief Determine whether this initializer is a pack expansion.
1843 bool isPackExpansion() const {
1844 return isBaseInitializer() && MemberOrEllipsisLocation.isValid();
1847 // \brief For a pack expansion, returns the location of the ellipsis.
1848 SourceLocation getEllipsisLoc() const {
1849 assert(isPackExpansion() && "Initializer is not a pack expansion");
1850 return MemberOrEllipsisLocation;
1853 /// If this is a base class initializer, returns the type of the
1854 /// base class with location information. Otherwise, returns an NULL
1856 TypeLoc getBaseClassLoc() const;
1858 /// If this is a base class initializer, returns the type of the base class.
1859 /// Otherwise, returns NULL.
1860 const Type *getBaseClass() const;
1862 /// Returns whether the base is virtual or not.
1863 bool isBaseVirtual() const {
1864 assert(isBaseInitializer() && "Must call this on base initializer!");
1869 /// \brief Returns the declarator information for a base class or delegating
1871 TypeSourceInfo *getTypeSourceInfo() const {
1872 return Initializee.dyn_cast<TypeSourceInfo *>();
1875 /// getMember - If this is a member initializer, returns the
1876 /// declaration of the non-static data member being
1877 /// initialized. Otherwise, returns NULL.
1878 FieldDecl *getMember() const {
1879 if (isMemberInitializer())
1880 return Initializee.get<FieldDecl*>();
1883 FieldDecl *getAnyMember() const {
1884 if (isMemberInitializer())
1885 return Initializee.get<FieldDecl*>();
1886 if (isIndirectMemberInitializer())
1887 return Initializee.get<IndirectFieldDecl*>()->getAnonField();
1891 IndirectFieldDecl *getIndirectMember() const {
1892 if (isIndirectMemberInitializer())
1893 return Initializee.get<IndirectFieldDecl*>();
1897 SourceLocation getMemberLocation() const {
1898 return MemberOrEllipsisLocation;
1901 /// \brief Determine the source location of the initializer.
1902 SourceLocation getSourceLocation() const;
1904 /// \brief Determine the source range covering the entire initializer.
1905 SourceRange getSourceRange() const LLVM_READONLY;
1907 /// isWritten - Returns true if this initializer is explicitly written
1908 /// in the source code.
1909 bool isWritten() const { return IsWritten; }
1911 /// \brief Return the source position of the initializer, counting from 0.
1912 /// If the initializer was implicit, -1 is returned.
1913 int getSourceOrder() const {
1914 return IsWritten ? static_cast<int>(SourceOrderOrNumArrayIndices) : -1;
1917 /// \brief Set the source order of this initializer. This method can only
1918 /// be called once for each initializer; it cannot be called on an
1919 /// initializer having a positive number of (implicit) array indices.
1920 void setSourceOrder(int pos) {
1921 assert(!IsWritten &&
1922 "calling twice setSourceOrder() on the same initializer");
1923 assert(SourceOrderOrNumArrayIndices == 0 &&
1924 "setSourceOrder() used when there are implicit array indices");
1926 "setSourceOrder() used to make an initializer implicit");
1928 SourceOrderOrNumArrayIndices = static_cast<unsigned>(pos);
1931 SourceLocation getLParenLoc() const { return LParenLoc; }
1932 SourceLocation getRParenLoc() const { return RParenLoc; }
1934 /// \brief Determine the number of implicit array indices used while
1935 /// described an array member initialization.
1936 unsigned getNumArrayIndices() const {
1937 return IsWritten ? 0 : SourceOrderOrNumArrayIndices;
1940 /// \brief Retrieve a particular array index variable used to
1941 /// describe an array member initialization.
1942 VarDecl *getArrayIndex(unsigned I) {
1943 assert(I < getNumArrayIndices() && "Out of bounds member array index");
1944 return reinterpret_cast<VarDecl **>(this + 1)[I];
1946 const VarDecl *getArrayIndex(unsigned I) const {
1947 assert(I < getNumArrayIndices() && "Out of bounds member array index");
1948 return reinterpret_cast<const VarDecl * const *>(this + 1)[I];
1950 void setArrayIndex(unsigned I, VarDecl *Index) {
1951 assert(I < getNumArrayIndices() && "Out of bounds member array index");
1952 reinterpret_cast<VarDecl **>(this + 1)[I] = Index;
1954 ArrayRef<VarDecl *> getArrayIndexes() {
1955 assert(getNumArrayIndices() != 0 && "Getting indexes for non-array init");
1956 return ArrayRef<VarDecl *>(reinterpret_cast<VarDecl **>(this + 1),
1957 getNumArrayIndices());
1960 /// \brief Get the initializer. This is 0 if this is an in-class initializer
1961 /// for a non-static data member which has not yet been parsed.
1962 Expr *getInit() const {
1964 return getAnyMember()->getInClassInitializer();
1966 return static_cast<Expr*>(Init);
1970 /// CXXConstructorDecl - Represents a C++ constructor within a
1971 /// class. For example:
1976 /// explicit X(int); // represented by a CXXConstructorDecl.
1979 class CXXConstructorDecl : public CXXMethodDecl {
1980 virtual void anchor();
1981 /// IsExplicitSpecified - Whether this constructor declaration has the
1982 /// 'explicit' keyword specified.
1983 bool IsExplicitSpecified : 1;
1985 /// ImplicitlyDefined - Whether this constructor was implicitly
1986 /// defined by the compiler. When false, the constructor was defined
1987 /// by the user. In C++03, this flag will have the same value as
1988 /// Implicit. In C++0x, however, a constructor that is
1989 /// explicitly defaulted (i.e., defined with " = default") will have
1990 /// @c !Implicit && ImplicitlyDefined.
1991 bool ImplicitlyDefined : 1;
1993 /// Support for base and member initializers.
1994 /// CtorInitializers - The arguments used to initialize the base
1996 CXXCtorInitializer **CtorInitializers;
1997 unsigned NumCtorInitializers;
1999 CXXConstructorDecl(CXXRecordDecl *RD, SourceLocation StartLoc,
2000 const DeclarationNameInfo &NameInfo,
2001 QualType T, TypeSourceInfo *TInfo,
2002 bool isExplicitSpecified, bool isInline,
2003 bool isImplicitlyDeclared, bool isConstexpr)
2004 : CXXMethodDecl(CXXConstructor, RD, StartLoc, NameInfo, T, TInfo,
2005 SC_None, isInline, isConstexpr, SourceLocation()),
2006 IsExplicitSpecified(isExplicitSpecified), ImplicitlyDefined(false),
2007 CtorInitializers(0), NumCtorInitializers(0) {
2008 setImplicit(isImplicitlyDeclared);
2012 static CXXConstructorDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2013 static CXXConstructorDecl *Create(ASTContext &C, CXXRecordDecl *RD,
2014 SourceLocation StartLoc,
2015 const DeclarationNameInfo &NameInfo,
2016 QualType T, TypeSourceInfo *TInfo,
2018 bool isInline, bool isImplicitlyDeclared,
2021 /// isExplicitSpecified - Whether this constructor declaration has the
2022 /// 'explicit' keyword specified.
2023 bool isExplicitSpecified() const { return IsExplicitSpecified; }
2025 /// isExplicit - Whether this constructor was marked "explicit" or not.
2026 bool isExplicit() const {
2027 return cast<CXXConstructorDecl>(getFirstDeclaration())
2028 ->isExplicitSpecified();
2031 /// isImplicitlyDefined - Whether this constructor was implicitly
2032 /// defined. If false, then this constructor was defined by the
2033 /// user. This operation can only be invoked if the constructor has
2034 /// already been defined.
2035 bool isImplicitlyDefined() const {
2036 assert(isThisDeclarationADefinition() &&
2037 "Can only get the implicit-definition flag once the "
2038 "constructor has been defined");
2039 return ImplicitlyDefined;
2042 /// setImplicitlyDefined - Set whether this constructor was
2043 /// implicitly defined or not.
2044 void setImplicitlyDefined(bool ID) {
2045 assert(isThisDeclarationADefinition() &&
2046 "Can only set the implicit-definition flag once the constructor "
2047 "has been defined");
2048 ImplicitlyDefined = ID;
2051 /// init_iterator - Iterates through the member/base initializer list.
2052 typedef CXXCtorInitializer **init_iterator;
2054 /// init_const_iterator - Iterates through the memberbase initializer list.
2055 typedef CXXCtorInitializer * const * init_const_iterator;
2057 /// init_begin() - Retrieve an iterator to the first initializer.
2058 init_iterator init_begin() { return CtorInitializers; }
2059 /// begin() - Retrieve an iterator to the first initializer.
2060 init_const_iterator init_begin() const { return CtorInitializers; }
2062 /// init_end() - Retrieve an iterator past the last initializer.
2063 init_iterator init_end() {
2064 return CtorInitializers + NumCtorInitializers;
2066 /// end() - Retrieve an iterator past the last initializer.
2067 init_const_iterator init_end() const {
2068 return CtorInitializers + NumCtorInitializers;
2071 typedef std::reverse_iterator<init_iterator> init_reverse_iterator;
2072 typedef std::reverse_iterator<init_const_iterator>
2073 init_const_reverse_iterator;
2075 init_reverse_iterator init_rbegin() {
2076 return init_reverse_iterator(init_end());
2078 init_const_reverse_iterator init_rbegin() const {
2079 return init_const_reverse_iterator(init_end());
2082 init_reverse_iterator init_rend() {
2083 return init_reverse_iterator(init_begin());
2085 init_const_reverse_iterator init_rend() const {
2086 return init_const_reverse_iterator(init_begin());
2089 /// getNumArgs - Determine the number of arguments used to
2090 /// initialize the member or base.
2091 unsigned getNumCtorInitializers() const {
2092 return NumCtorInitializers;
2095 void setNumCtorInitializers(unsigned numCtorInitializers) {
2096 NumCtorInitializers = numCtorInitializers;
2099 void setCtorInitializers(CXXCtorInitializer ** initializers) {
2100 CtorInitializers = initializers;
2103 /// isDelegatingConstructor - Whether this constructor is a
2104 /// delegating constructor
2105 bool isDelegatingConstructor() const {
2106 return (getNumCtorInitializers() == 1) &&
2107 CtorInitializers[0]->isDelegatingInitializer();
2110 /// getTargetConstructor - When this constructor delegates to
2111 /// another, retrieve the target
2112 CXXConstructorDecl *getTargetConstructor() const;
2114 /// isDefaultConstructor - Whether this constructor is a default
2115 /// constructor (C++ [class.ctor]p5), which can be used to
2116 /// default-initialize a class of this type.
2117 bool isDefaultConstructor() const;
2119 /// isCopyConstructor - Whether this constructor is a copy
2120 /// constructor (C++ [class.copy]p2, which can be used to copy the
2121 /// class. @p TypeQuals will be set to the qualifiers on the
2122 /// argument type. For example, @p TypeQuals would be set to @c
2123 /// Qualifiers::Const for the following copy constructor:
2131 bool isCopyConstructor(unsigned &TypeQuals) const;
2133 /// isCopyConstructor - Whether this constructor is a copy
2134 /// constructor (C++ [class.copy]p2, which can be used to copy the
2136 bool isCopyConstructor() const {
2137 unsigned TypeQuals = 0;
2138 return isCopyConstructor(TypeQuals);
2141 /// \brief Determine whether this constructor is a move constructor
2142 /// (C++0x [class.copy]p3), which can be used to move values of the class.
2144 /// \param TypeQuals If this constructor is a move constructor, will be set
2145 /// to the type qualifiers on the referent of the first parameter's type.
2146 bool isMoveConstructor(unsigned &TypeQuals) const;
2148 /// \brief Determine whether this constructor is a move constructor
2149 /// (C++0x [class.copy]p3), which can be used to move values of the class.
2150 bool isMoveConstructor() const {
2151 unsigned TypeQuals = 0;
2152 return isMoveConstructor(TypeQuals);
2155 /// \brief Determine whether this is a copy or move constructor.
2157 /// \param TypeQuals Will be set to the type qualifiers on the reference
2158 /// parameter, if in fact this is a copy or move constructor.
2159 bool isCopyOrMoveConstructor(unsigned &TypeQuals) const;
2161 /// \brief Determine whether this a copy or move constructor.
2162 bool isCopyOrMoveConstructor() const {
2164 return isCopyOrMoveConstructor(Quals);
2167 /// isConvertingConstructor - Whether this constructor is a
2168 /// converting constructor (C++ [class.conv.ctor]), which can be
2169 /// used for user-defined conversions.
2170 bool isConvertingConstructor(bool AllowExplicit) const;
2172 /// \brief Determine whether this is a member template specialization that
2173 /// would copy the object to itself. Such constructors are never used to copy
2175 bool isSpecializationCopyingObject() const;
2177 /// \brief Get the constructor that this inheriting constructor is based on.
2178 const CXXConstructorDecl *getInheritedConstructor() const;
2180 /// \brief Set the constructor that this inheriting constructor is based on.
2181 void setInheritedConstructor(const CXXConstructorDecl *BaseCtor);
2183 const CXXConstructorDecl *getCanonicalDecl() const {
2184 return cast<CXXConstructorDecl>(FunctionDecl::getCanonicalDecl());
2186 CXXConstructorDecl *getCanonicalDecl() {
2187 return cast<CXXConstructorDecl>(FunctionDecl::getCanonicalDecl());
2190 // Implement isa/cast/dyncast/etc.
2191 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2192 static bool classofKind(Kind K) { return K == CXXConstructor; }
2194 friend class ASTDeclReader;
2195 friend class ASTDeclWriter;
2198 /// CXXDestructorDecl - Represents a C++ destructor within a
2199 /// class. For example:
2204 /// ~X(); // represented by a CXXDestructorDecl.
2207 class CXXDestructorDecl : public CXXMethodDecl {
2208 virtual void anchor();
2209 /// ImplicitlyDefined - Whether this destructor was implicitly
2210 /// defined by the compiler. When false, the destructor was defined
2211 /// by the user. In C++03, this flag will have the same value as
2212 /// Implicit. In C++0x, however, a destructor that is
2213 /// explicitly defaulted (i.e., defined with " = default") will have
2214 /// @c !Implicit && ImplicitlyDefined.
2215 bool ImplicitlyDefined : 1;
2217 FunctionDecl *OperatorDelete;
2219 CXXDestructorDecl(CXXRecordDecl *RD, SourceLocation StartLoc,
2220 const DeclarationNameInfo &NameInfo,
2221 QualType T, TypeSourceInfo *TInfo,
2222 bool isInline, bool isImplicitlyDeclared)
2223 : CXXMethodDecl(CXXDestructor, RD, StartLoc, NameInfo, T, TInfo,
2224 SC_None, isInline, /*isConstexpr=*/false, SourceLocation()),
2225 ImplicitlyDefined(false), OperatorDelete(0) {
2226 setImplicit(isImplicitlyDeclared);
2230 static CXXDestructorDecl *Create(ASTContext &C, CXXRecordDecl *RD,
2231 SourceLocation StartLoc,
2232 const DeclarationNameInfo &NameInfo,
2233 QualType T, TypeSourceInfo* TInfo,
2235 bool isImplicitlyDeclared);
2236 static CXXDestructorDecl *CreateDeserialized(ASTContext & C, unsigned ID);
2238 /// isImplicitlyDefined - Whether this destructor was implicitly
2239 /// defined. If false, then this destructor was defined by the
2240 /// user. This operation can only be invoked if the destructor has
2241 /// already been defined.
2242 bool isImplicitlyDefined() const {
2243 assert(isThisDeclarationADefinition() &&
2244 "Can only get the implicit-definition flag once the destructor has "
2246 return ImplicitlyDefined;
2249 /// setImplicitlyDefined - Set whether this destructor was
2250 /// implicitly defined or not.
2251 void setImplicitlyDefined(bool ID) {
2252 assert(isThisDeclarationADefinition() &&
2253 "Can only set the implicit-definition flag once the destructor has "
2255 ImplicitlyDefined = ID;
2258 void setOperatorDelete(FunctionDecl *OD) { OperatorDelete = OD; }
2259 const FunctionDecl *getOperatorDelete() const { return OperatorDelete; }
2261 // Implement isa/cast/dyncast/etc.
2262 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2263 static bool classofKind(Kind K) { return K == CXXDestructor; }
2265 friend class ASTDeclReader;
2266 friend class ASTDeclWriter;
2269 /// CXXConversionDecl - Represents a C++ conversion function within a
2270 /// class. For example:
2275 /// operator bool();
2278 class CXXConversionDecl : public CXXMethodDecl {
2279 virtual void anchor();
2280 /// IsExplicitSpecified - Whether this conversion function declaration is
2281 /// marked "explicit", meaning that it can only be applied when the user
2282 /// explicitly wrote a cast. This is a C++0x feature.
2283 bool IsExplicitSpecified : 1;
2285 CXXConversionDecl(CXXRecordDecl *RD, SourceLocation StartLoc,
2286 const DeclarationNameInfo &NameInfo,
2287 QualType T, TypeSourceInfo *TInfo,
2288 bool isInline, bool isExplicitSpecified,
2289 bool isConstexpr, SourceLocation EndLocation)
2290 : CXXMethodDecl(CXXConversion, RD, StartLoc, NameInfo, T, TInfo,
2291 SC_None, isInline, isConstexpr, EndLocation),
2292 IsExplicitSpecified(isExplicitSpecified) { }
2295 static CXXConversionDecl *Create(ASTContext &C, CXXRecordDecl *RD,
2296 SourceLocation StartLoc,
2297 const DeclarationNameInfo &NameInfo,
2298 QualType T, TypeSourceInfo *TInfo,
2299 bool isInline, bool isExplicit,
2301 SourceLocation EndLocation);
2302 static CXXConversionDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2304 /// IsExplicitSpecified - Whether this conversion function declaration is
2305 /// marked "explicit", meaning that it can only be applied when the user
2306 /// explicitly wrote a cast. This is a C++0x feature.
2307 bool isExplicitSpecified() const { return IsExplicitSpecified; }
2309 /// isExplicit - Whether this is an explicit conversion operator
2310 /// (C++0x only). Explicit conversion operators are only considered
2311 /// when the user has explicitly written a cast.
2312 bool isExplicit() const {
2313 return cast<CXXConversionDecl>(getFirstDeclaration())
2314 ->isExplicitSpecified();
2317 /// getConversionType - Returns the type that this conversion
2318 /// function is converting to.
2319 QualType getConversionType() const {
2320 return getType()->getAs<FunctionType>()->getResultType();
2323 /// \brief Determine whether this conversion function is a conversion from
2324 /// a lambda closure type to a block pointer.
2325 bool isLambdaToBlockPointerConversion() const;
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 == CXXConversion; }
2331 friend class ASTDeclReader;
2332 friend class ASTDeclWriter;
2335 /// LinkageSpecDecl - This represents a linkage specification. For example:
2336 /// extern "C" void foo();
2338 class LinkageSpecDecl : public Decl, public DeclContext {
2339 virtual void anchor();
2341 /// LanguageIDs - Used to represent the language in a linkage
2342 /// specification. The values are part of the serialization abi for
2343 /// ASTs and cannot be changed without altering that abi. To help
2344 /// ensure a stable abi for this, we choose the DW_LANG_ encodings
2345 /// from the dwarf standard.
2347 lang_c = /* DW_LANG_C */ 0x0002,
2348 lang_cxx = /* DW_LANG_C_plus_plus */ 0x0004
2351 /// Language - The language for this linkage specification.
2352 LanguageIDs Language;
2353 /// ExternLoc - The source location for the extern keyword.
2354 SourceLocation ExternLoc;
2355 /// RBraceLoc - The source location for the right brace (if valid).
2356 SourceLocation RBraceLoc;
2358 LinkageSpecDecl(DeclContext *DC, SourceLocation ExternLoc,
2359 SourceLocation LangLoc, LanguageIDs lang,
2360 SourceLocation RBLoc)
2361 : Decl(LinkageSpec, DC, LangLoc), DeclContext(LinkageSpec),
2362 Language(lang), ExternLoc(ExternLoc), RBraceLoc(RBLoc) { }
2365 static LinkageSpecDecl *Create(ASTContext &C, DeclContext *DC,
2366 SourceLocation ExternLoc,
2367 SourceLocation LangLoc, LanguageIDs Lang,
2368 SourceLocation RBraceLoc = SourceLocation());
2369 static LinkageSpecDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2371 /// \brief Return the language specified by this linkage specification.
2372 LanguageIDs getLanguage() const { return Language; }
2373 /// \brief Set the language specified by this linkage specification.
2374 void setLanguage(LanguageIDs L) { Language = L; }
2376 /// \brief Determines whether this linkage specification had braces in
2377 /// its syntactic form.
2378 bool hasBraces() const { return RBraceLoc.isValid(); }
2380 SourceLocation getExternLoc() const { return ExternLoc; }
2381 SourceLocation getRBraceLoc() const { return RBraceLoc; }
2382 void setExternLoc(SourceLocation L) { ExternLoc = L; }
2383 void setRBraceLoc(SourceLocation L) { RBraceLoc = L; }
2385 SourceLocation getLocEnd() const LLVM_READONLY {
2387 return getRBraceLoc();
2388 // No braces: get the end location of the (only) declaration in context
2390 return decls_empty() ? getLocation() : decls_begin()->getLocEnd();
2393 SourceRange getSourceRange() const LLVM_READONLY {
2394 return SourceRange(ExternLoc, getLocEnd());
2397 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2398 static bool classofKind(Kind K) { return K == LinkageSpec; }
2399 static DeclContext *castToDeclContext(const LinkageSpecDecl *D) {
2400 return static_cast<DeclContext *>(const_cast<LinkageSpecDecl*>(D));
2402 static LinkageSpecDecl *castFromDeclContext(const DeclContext *DC) {
2403 return static_cast<LinkageSpecDecl *>(const_cast<DeclContext*>(DC));
2407 /// UsingDirectiveDecl - Represents C++ using-directive. For example:
2409 /// using namespace std;
2411 // NB: UsingDirectiveDecl should be Decl not NamedDecl, but we provide
2412 // artificial names for all using-directives in order to store
2413 // them in DeclContext effectively.
2414 class UsingDirectiveDecl : public NamedDecl {
2415 virtual void anchor();
2416 /// \brief The location of the "using" keyword.
2417 SourceLocation UsingLoc;
2419 /// SourceLocation - Location of 'namespace' token.
2420 SourceLocation NamespaceLoc;
2422 /// \brief The nested-name-specifier that precedes the namespace.
2423 NestedNameSpecifierLoc QualifierLoc;
2425 /// NominatedNamespace - Namespace nominated by using-directive.
2426 NamedDecl *NominatedNamespace;
2428 /// Enclosing context containing both using-directive and nominated
2430 DeclContext *CommonAncestor;
2432 /// getUsingDirectiveName - Returns special DeclarationName used by
2433 /// using-directives. This is only used by DeclContext for storing
2434 /// UsingDirectiveDecls in its lookup structure.
2435 static DeclarationName getName() {
2436 return DeclarationName::getUsingDirectiveName();
2439 UsingDirectiveDecl(DeclContext *DC, SourceLocation UsingLoc,
2440 SourceLocation NamespcLoc,
2441 NestedNameSpecifierLoc QualifierLoc,
2442 SourceLocation IdentLoc,
2443 NamedDecl *Nominated,
2444 DeclContext *CommonAncestor)
2445 : NamedDecl(UsingDirective, DC, IdentLoc, getName()), UsingLoc(UsingLoc),
2446 NamespaceLoc(NamespcLoc), QualifierLoc(QualifierLoc),
2447 NominatedNamespace(Nominated), CommonAncestor(CommonAncestor) { }
2450 /// \brief Retrieve the nested-name-specifier that qualifies the
2451 /// name of the namespace, with source-location information.
2452 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; }
2454 /// \brief Retrieve the nested-name-specifier that qualifies the
2455 /// name of the namespace.
2456 NestedNameSpecifier *getQualifier() const {
2457 return QualifierLoc.getNestedNameSpecifier();
2460 NamedDecl *getNominatedNamespaceAsWritten() { return NominatedNamespace; }
2461 const NamedDecl *getNominatedNamespaceAsWritten() const {
2462 return NominatedNamespace;
2465 /// getNominatedNamespace - Returns namespace nominated by using-directive.
2466 NamespaceDecl *getNominatedNamespace();
2468 const NamespaceDecl *getNominatedNamespace() const {
2469 return const_cast<UsingDirectiveDecl*>(this)->getNominatedNamespace();
2472 /// \brief Returns the common ancestor context of this using-directive and
2473 /// its nominated namespace.
2474 DeclContext *getCommonAncestor() { return CommonAncestor; }
2475 const DeclContext *getCommonAncestor() const { return CommonAncestor; }
2477 /// \brief Return the location of the "using" keyword.
2478 SourceLocation getUsingLoc() const { return UsingLoc; }
2480 // FIXME: Could omit 'Key' in name.
2481 /// getNamespaceKeyLocation - Returns location of namespace keyword.
2482 SourceLocation getNamespaceKeyLocation() const { return NamespaceLoc; }
2484 /// getIdentLocation - Returns location of identifier.
2485 SourceLocation getIdentLocation() const { return getLocation(); }
2487 static UsingDirectiveDecl *Create(ASTContext &C, DeclContext *DC,
2488 SourceLocation UsingLoc,
2489 SourceLocation NamespaceLoc,
2490 NestedNameSpecifierLoc QualifierLoc,
2491 SourceLocation IdentLoc,
2492 NamedDecl *Nominated,
2493 DeclContext *CommonAncestor);
2494 static UsingDirectiveDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2496 SourceRange getSourceRange() const LLVM_READONLY {
2497 return SourceRange(UsingLoc, getLocation());
2500 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2501 static bool classofKind(Kind K) { return K == UsingDirective; }
2503 // Friend for getUsingDirectiveName.
2504 friend class DeclContext;
2506 friend class ASTDeclReader;
2509 /// \brief Represents a C++ namespace alias.
2514 /// namespace Foo = Bar;
2516 class NamespaceAliasDecl : public NamedDecl {
2517 virtual void anchor();
2519 /// \brief The location of the "namespace" keyword.
2520 SourceLocation NamespaceLoc;
2522 /// IdentLoc - Location of namespace identifier. Accessed by TargetNameLoc.
2523 SourceLocation IdentLoc;
2525 /// \brief The nested-name-specifier that precedes the namespace.
2526 NestedNameSpecifierLoc QualifierLoc;
2528 /// Namespace - The Decl that this alias points to. Can either be a
2529 /// NamespaceDecl or a NamespaceAliasDecl.
2530 NamedDecl *Namespace;
2532 NamespaceAliasDecl(DeclContext *DC, SourceLocation NamespaceLoc,
2533 SourceLocation AliasLoc, IdentifierInfo *Alias,
2534 NestedNameSpecifierLoc QualifierLoc,
2535 SourceLocation IdentLoc, NamedDecl *Namespace)
2536 : NamedDecl(NamespaceAlias, DC, AliasLoc, Alias),
2537 NamespaceLoc(NamespaceLoc), IdentLoc(IdentLoc),
2538 QualifierLoc(QualifierLoc), Namespace(Namespace) { }
2540 friend class ASTDeclReader;
2543 /// \brief Retrieve the nested-name-specifier that qualifies the
2544 /// name of the namespace, with source-location information.
2545 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; }
2547 /// \brief Retrieve the nested-name-specifier that qualifies the
2548 /// name of the namespace.
2549 NestedNameSpecifier *getQualifier() const {
2550 return QualifierLoc.getNestedNameSpecifier();
2553 /// \brief Retrieve the namespace declaration aliased by this directive.
2554 NamespaceDecl *getNamespace() {
2555 if (NamespaceAliasDecl *AD = dyn_cast<NamespaceAliasDecl>(Namespace))
2556 return AD->getNamespace();
2558 return cast<NamespaceDecl>(Namespace);
2561 const NamespaceDecl *getNamespace() const {
2562 return const_cast<NamespaceAliasDecl*>(this)->getNamespace();
2565 /// Returns the location of the alias name, i.e. 'foo' in
2566 /// "namespace foo = ns::bar;".
2567 SourceLocation getAliasLoc() const { return getLocation(); }
2569 /// Returns the location of the 'namespace' keyword.
2570 SourceLocation getNamespaceLoc() const { return NamespaceLoc; }
2572 /// Returns the location of the identifier in the named namespace.
2573 SourceLocation getTargetNameLoc() const { return IdentLoc; }
2575 /// \brief Retrieve the namespace that this alias refers to, which
2576 /// may either be a NamespaceDecl or a NamespaceAliasDecl.
2577 NamedDecl *getAliasedNamespace() const { return Namespace; }
2579 static NamespaceAliasDecl *Create(ASTContext &C, DeclContext *DC,
2580 SourceLocation NamespaceLoc,
2581 SourceLocation AliasLoc,
2582 IdentifierInfo *Alias,
2583 NestedNameSpecifierLoc QualifierLoc,
2584 SourceLocation IdentLoc,
2585 NamedDecl *Namespace);
2587 static NamespaceAliasDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2589 virtual SourceRange getSourceRange() const LLVM_READONLY {
2590 return SourceRange(NamespaceLoc, IdentLoc);
2593 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2594 static bool classofKind(Kind K) { return K == NamespaceAlias; }
2597 /// \brief Represents a shadow declaration introduced into a scope by a
2598 /// (resolved) using declaration.
2606 /// using A::foo; // <- a UsingDecl
2607 /// // Also creates a UsingShadowDecl for A::foo() in B
2610 class UsingShadowDecl : public NamedDecl {
2611 virtual void anchor();
2613 /// The referenced declaration.
2614 NamedDecl *Underlying;
2616 /// \brief The using declaration which introduced this decl or the next using
2617 /// shadow declaration contained in the aforementioned using declaration.
2618 NamedDecl *UsingOrNextShadow;
2619 friend class UsingDecl;
2621 UsingShadowDecl(DeclContext *DC, SourceLocation Loc, UsingDecl *Using,
2623 : NamedDecl(UsingShadow, DC, Loc, DeclarationName()),
2625 UsingOrNextShadow(reinterpret_cast<NamedDecl *>(Using)) {
2627 setDeclName(Target->getDeclName());
2628 IdentifierNamespace = Target->getIdentifierNamespace();
2634 static UsingShadowDecl *Create(ASTContext &C, DeclContext *DC,
2635 SourceLocation Loc, UsingDecl *Using,
2636 NamedDecl *Target) {
2637 return new (C) UsingShadowDecl(DC, Loc, Using, Target);
2640 static UsingShadowDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2642 /// \brief Gets the underlying declaration which has been brought into the
2644 NamedDecl *getTargetDecl() const { return Underlying; }
2646 /// \brief Sets the underlying declaration which has been brought into the
2648 void setTargetDecl(NamedDecl* ND) {
2649 assert(ND && "Target decl is null!");
2651 IdentifierNamespace = ND->getIdentifierNamespace();
2654 /// \brief Gets the using declaration to which this declaration is tied.
2655 UsingDecl *getUsingDecl() const;
2657 /// \brief The next using shadow declaration contained in the shadow decl
2658 /// chain of the using declaration which introduced this decl.
2659 UsingShadowDecl *getNextUsingShadowDecl() const {
2660 return dyn_cast_or_null<UsingShadowDecl>(UsingOrNextShadow);
2663 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2664 static bool classofKind(Kind K) { return K == Decl::UsingShadow; }
2666 friend class ASTDeclReader;
2667 friend class ASTDeclWriter;
2670 /// \brief Represents a C++ using-declaration.
2674 /// using someNameSpace::someIdentifier;
2676 class UsingDecl : public NamedDecl {
2677 virtual void anchor();
2679 /// \brief The source location of the "using" location itself.
2680 SourceLocation UsingLocation;
2682 /// \brief The nested-name-specifier that precedes the name.
2683 NestedNameSpecifierLoc QualifierLoc;
2685 /// DNLoc - Provides source/type location info for the
2686 /// declaration name embedded in the ValueDecl base class.
2687 DeclarationNameLoc DNLoc;
2689 /// \brief The first shadow declaration of the shadow decl chain associated
2690 /// with this using declaration.
2692 /// The bool member of the pair store whether this decl has the \c typename
2694 llvm::PointerIntPair<UsingShadowDecl *, 1, bool> FirstUsingShadow;
2696 UsingDecl(DeclContext *DC, SourceLocation UL,
2697 NestedNameSpecifierLoc QualifierLoc,
2698 const DeclarationNameInfo &NameInfo, bool IsTypeNameArg)
2699 : NamedDecl(Using, DC, NameInfo.getLoc(), NameInfo.getName()),
2700 UsingLocation(UL), QualifierLoc(QualifierLoc),
2701 DNLoc(NameInfo.getInfo()), FirstUsingShadow(0, IsTypeNameArg) {
2705 /// \brief Returns the source location of the "using" keyword.
2706 SourceLocation getUsingLocation() const { return UsingLocation; }
2708 /// \brief Set the source location of the 'using' keyword.
2709 void setUsingLocation(SourceLocation L) { UsingLocation = L; }
2711 /// \brief Retrieve the nested-name-specifier that qualifies the name,
2712 /// with source-location information.
2713 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; }
2715 /// \brief Retrieve the nested-name-specifier that qualifies the name.
2716 NestedNameSpecifier *getQualifier() const {
2717 return QualifierLoc.getNestedNameSpecifier();
2720 DeclarationNameInfo getNameInfo() const {
2721 return DeclarationNameInfo(getDeclName(), getLocation(), DNLoc);
2724 /// \brief Return true if the using declaration has 'typename'.
2725 bool isTypeName() const { return FirstUsingShadow.getInt(); }
2727 /// \brief Sets whether the using declaration has 'typename'.
2728 void setTypeName(bool TN) { FirstUsingShadow.setInt(TN); }
2730 /// \brief Iterates through the using shadow declarations assosiated with
2731 /// this using declaration.
2732 class shadow_iterator {
2733 /// \brief The current using shadow declaration.
2734 UsingShadowDecl *Current;
2737 typedef UsingShadowDecl* value_type;
2738 typedef UsingShadowDecl* reference;
2739 typedef UsingShadowDecl* pointer;
2740 typedef std::forward_iterator_tag iterator_category;
2741 typedef std::ptrdiff_t difference_type;
2743 shadow_iterator() : Current(0) { }
2744 explicit shadow_iterator(UsingShadowDecl *C) : Current(C) { }
2746 reference operator*() const { return Current; }
2747 pointer operator->() const { return Current; }
2749 shadow_iterator& operator++() {
2750 Current = Current->getNextUsingShadowDecl();
2754 shadow_iterator operator++(int) {
2755 shadow_iterator tmp(*this);
2760 friend bool operator==(shadow_iterator x, shadow_iterator y) {
2761 return x.Current == y.Current;
2763 friend bool operator!=(shadow_iterator x, shadow_iterator y) {
2764 return x.Current != y.Current;
2768 shadow_iterator shadow_begin() const {
2769 return shadow_iterator(FirstUsingShadow.getPointer());
2771 shadow_iterator shadow_end() const { return shadow_iterator(); }
2773 /// \brief Return the number of shadowed declarations associated with this
2774 /// using declaration.
2775 unsigned shadow_size() const {
2776 return std::distance(shadow_begin(), shadow_end());
2779 void addShadowDecl(UsingShadowDecl *S);
2780 void removeShadowDecl(UsingShadowDecl *S);
2782 static UsingDecl *Create(ASTContext &C, DeclContext *DC,
2783 SourceLocation UsingL,
2784 NestedNameSpecifierLoc QualifierLoc,
2785 const DeclarationNameInfo &NameInfo,
2786 bool IsTypeNameArg);
2788 static UsingDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2790 SourceRange getSourceRange() const LLVM_READONLY {
2791 return SourceRange(UsingLocation, getNameInfo().getEndLoc());
2794 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2795 static bool classofKind(Kind K) { return K == Using; }
2797 friend class ASTDeclReader;
2798 friend class ASTDeclWriter;
2801 /// \brief Represents a dependent using declaration which was not marked with
2804 /// Unlike non-dependent using declarations, these *only* bring through
2805 /// non-types; otherwise they would break two-phase lookup.
2808 /// template \<class T> class A : public Base<T> {
2809 /// using Base<T>::foo;
2812 class UnresolvedUsingValueDecl : public ValueDecl {
2813 virtual void anchor();
2815 /// \brief The source location of the 'using' keyword
2816 SourceLocation UsingLocation;
2818 /// \brief The nested-name-specifier that precedes the name.
2819 NestedNameSpecifierLoc QualifierLoc;
2821 /// DNLoc - Provides source/type location info for the
2822 /// declaration name embedded in the ValueDecl base class.
2823 DeclarationNameLoc DNLoc;
2825 UnresolvedUsingValueDecl(DeclContext *DC, QualType Ty,
2826 SourceLocation UsingLoc,
2827 NestedNameSpecifierLoc QualifierLoc,
2828 const DeclarationNameInfo &NameInfo)
2829 : ValueDecl(UnresolvedUsingValue, DC,
2830 NameInfo.getLoc(), NameInfo.getName(), Ty),
2831 UsingLocation(UsingLoc), QualifierLoc(QualifierLoc),
2832 DNLoc(NameInfo.getInfo())
2836 /// \brief Returns the source location of the 'using' keyword.
2837 SourceLocation getUsingLoc() const { return UsingLocation; }
2839 /// \brief Set the source location of the 'using' keyword.
2840 void setUsingLoc(SourceLocation L) { UsingLocation = L; }
2842 /// \brief Retrieve the nested-name-specifier that qualifies the name,
2843 /// with source-location information.
2844 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; }
2846 /// \brief Retrieve the nested-name-specifier that qualifies the name.
2847 NestedNameSpecifier *getQualifier() const {
2848 return QualifierLoc.getNestedNameSpecifier();
2851 DeclarationNameInfo getNameInfo() const {
2852 return DeclarationNameInfo(getDeclName(), getLocation(), DNLoc);
2855 static UnresolvedUsingValueDecl *
2856 Create(ASTContext &C, DeclContext *DC, SourceLocation UsingLoc,
2857 NestedNameSpecifierLoc QualifierLoc,
2858 const DeclarationNameInfo &NameInfo);
2860 static UnresolvedUsingValueDecl *
2861 CreateDeserialized(ASTContext &C, unsigned ID);
2863 SourceRange getSourceRange() const LLVM_READONLY {
2864 return SourceRange(UsingLocation, getNameInfo().getEndLoc());
2867 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2868 static bool classofKind(Kind K) { return K == UnresolvedUsingValue; }
2870 friend class ASTDeclReader;
2871 friend class ASTDeclWriter;
2874 /// @brief Represents a dependent using declaration which was marked with
2878 /// template \<class T> class A : public Base<T> {
2879 /// using typename Base<T>::foo;
2883 /// The type associated with an unresolved using typename decl is
2884 /// currently always a typename type.
2885 class UnresolvedUsingTypenameDecl : public TypeDecl {
2886 virtual void anchor();
2888 /// \brief The source location of the 'using' keyword
2889 SourceLocation UsingLocation;
2891 /// \brief The source location of the 'typename' keyword
2892 SourceLocation TypenameLocation;
2894 /// \brief The nested-name-specifier that precedes the name.
2895 NestedNameSpecifierLoc QualifierLoc;
2897 UnresolvedUsingTypenameDecl(DeclContext *DC, SourceLocation UsingLoc,
2898 SourceLocation TypenameLoc,
2899 NestedNameSpecifierLoc QualifierLoc,
2900 SourceLocation TargetNameLoc,
2901 IdentifierInfo *TargetName)
2902 : TypeDecl(UnresolvedUsingTypename, DC, TargetNameLoc, TargetName,
2904 TypenameLocation(TypenameLoc), QualifierLoc(QualifierLoc) { }
2906 friend class ASTDeclReader;
2909 /// \brief Returns the source location of the 'using' keyword.
2910 SourceLocation getUsingLoc() const { return getLocStart(); }
2912 /// \brief Returns the source location of the 'typename' keyword.
2913 SourceLocation getTypenameLoc() const { return TypenameLocation; }
2915 /// \brief Retrieve the nested-name-specifier that qualifies the name,
2916 /// with source-location information.
2917 NestedNameSpecifierLoc getQualifierLoc() const { return QualifierLoc; }
2919 /// \brief Retrieve the nested-name-specifier that qualifies the name.
2920 NestedNameSpecifier *getQualifier() const {
2921 return QualifierLoc.getNestedNameSpecifier();
2924 static UnresolvedUsingTypenameDecl *
2925 Create(ASTContext &C, DeclContext *DC, SourceLocation UsingLoc,
2926 SourceLocation TypenameLoc, NestedNameSpecifierLoc QualifierLoc,
2927 SourceLocation TargetNameLoc, DeclarationName TargetName);
2929 static UnresolvedUsingTypenameDecl *
2930 CreateDeserialized(ASTContext &C, unsigned ID);
2932 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2933 static bool classofKind(Kind K) { return K == UnresolvedUsingTypename; }
2936 /// \brief Represents a C++11 static_assert declaration.
2937 class StaticAssertDecl : public Decl {
2938 virtual void anchor();
2939 llvm::PointerIntPair<Expr *, 1, bool> AssertExprAndFailed;
2940 StringLiteral *Message;
2941 SourceLocation RParenLoc;
2943 StaticAssertDecl(DeclContext *DC, SourceLocation StaticAssertLoc,
2944 Expr *AssertExpr, StringLiteral *Message,
2945 SourceLocation RParenLoc, bool Failed)
2946 : Decl(StaticAssert, DC, StaticAssertLoc),
2947 AssertExprAndFailed(AssertExpr, Failed), Message(Message),
2948 RParenLoc(RParenLoc) { }
2951 static StaticAssertDecl *Create(ASTContext &C, DeclContext *DC,
2952 SourceLocation StaticAssertLoc,
2953 Expr *AssertExpr, StringLiteral *Message,
2954 SourceLocation RParenLoc, bool Failed);
2955 static StaticAssertDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2957 Expr *getAssertExpr() { return AssertExprAndFailed.getPointer(); }
2958 const Expr *getAssertExpr() const { return AssertExprAndFailed.getPointer(); }
2960 StringLiteral *getMessage() { return Message; }
2961 const StringLiteral *getMessage() const { return Message; }
2963 bool isFailed() const { return AssertExprAndFailed.getInt(); }
2965 SourceLocation getRParenLoc() const { return RParenLoc; }
2967 SourceRange getSourceRange() const LLVM_READONLY {
2968 return SourceRange(getLocation(), getRParenLoc());
2971 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2972 static bool classofKind(Kind K) { return K == StaticAssert; }
2974 friend class ASTDeclReader;
2977 /// Insertion operator for diagnostics. This allows sending an AccessSpecifier
2978 /// into a diagnostic with <<.
2979 const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
2980 AccessSpecifier AS);
2982 const PartialDiagnostic &operator<<(const PartialDiagnostic &DB,
2983 AccessSpecifier AS);
2985 } // end namespace clang