1 //===--- Decl.h - Classes for representing 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 Decl subclasses.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_AST_DECL_H
15 #define LLVM_CLANG_AST_DECL_H
17 #include "clang/AST/APValue.h"
18 #include "clang/AST/DeclBase.h"
19 #include "clang/AST/DeclarationName.h"
20 #include "clang/AST/ExternalASTSource.h"
21 #include "clang/AST/Redeclarable.h"
22 #include "clang/AST/Type.h"
23 #include "clang/Basic/Linkage.h"
24 #include "llvm/ADT/ArrayRef.h"
25 #include "llvm/ADT/Optional.h"
26 #include "llvm/Support/Compiler.h"
27 #include "llvm/Support/raw_ostream.h"
30 struct ASTTemplateArgumentListInfo;
33 class DependentFunctionTemplateSpecializationInfo;
35 class FunctionTemplateDecl;
36 class FunctionTemplateSpecializationInfo;
38 class MemberSpecializationInfo;
40 class NestedNameSpecifier;
43 class TemplateArgumentList;
44 class TemplateParameterList;
46 class UnresolvedSetImpl;
47 class VarTemplateDecl;
49 /// \brief A container of type source information.
51 /// A client can read the relevant info using TypeLoc wrappers, e.g:
53 /// TypeLoc TL = TypeSourceInfo->getTypeLoc();
54 /// if (PointerLoc *PL = dyn_cast<PointerLoc>(&TL))
55 /// PL->getStarLoc().print(OS, SrcMgr);
58 class TypeSourceInfo {
60 // Contains a memory block after the class, used for type source information,
61 // allocated by ASTContext.
62 friend class ASTContext;
63 TypeSourceInfo(QualType ty) : Ty(ty) { }
65 /// \brief Return the type wrapped by this type source info.
66 QualType getType() const { return Ty; }
68 /// \brief Return the TypeLoc wrapper for the type source info.
69 TypeLoc getTypeLoc() const; // implemented in TypeLoc.h
72 /// TranslationUnitDecl - The top declaration context.
73 class TranslationUnitDecl : public Decl, public DeclContext {
74 virtual void anchor();
77 /// The (most recently entered) anonymous namespace for this
78 /// translation unit, if one has been created.
79 NamespaceDecl *AnonymousNamespace;
81 explicit TranslationUnitDecl(ASTContext &ctx)
82 : Decl(TranslationUnit, 0, SourceLocation()),
83 DeclContext(TranslationUnit),
84 Ctx(ctx), AnonymousNamespace(0) {}
86 ASTContext &getASTContext() const { return Ctx; }
88 NamespaceDecl *getAnonymousNamespace() const { return AnonymousNamespace; }
89 void setAnonymousNamespace(NamespaceDecl *D) { AnonymousNamespace = D; }
91 static TranslationUnitDecl *Create(ASTContext &C);
92 // Implement isa/cast/dyncast/etc.
93 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
94 static bool classofKind(Kind K) { return K == TranslationUnit; }
95 static DeclContext *castToDeclContext(const TranslationUnitDecl *D) {
96 return static_cast<DeclContext *>(const_cast<TranslationUnitDecl*>(D));
98 static TranslationUnitDecl *castFromDeclContext(const DeclContext *DC) {
99 return static_cast<TranslationUnitDecl *>(const_cast<DeclContext*>(DC));
103 /// NamedDecl - This represents a decl with a name. Many decls have names such
104 /// as ObjCMethodDecl, but not \@class, etc.
105 class NamedDecl : public Decl {
106 virtual void anchor();
107 /// Name - The name of this declaration, which is typically a normal
108 /// identifier but may also be a special kind of name (C++
109 /// constructor, Objective-C selector, etc.)
110 DeclarationName Name;
113 NamedDecl *getUnderlyingDeclImpl();
116 NamedDecl(Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N)
117 : Decl(DK, DC, L), Name(N) { }
120 /// getIdentifier - Get the identifier that names this declaration,
121 /// if there is one. This will return NULL if this declaration has
122 /// no name (e.g., for an unnamed class) or if the name is a special
123 /// name (C++ constructor, Objective-C selector, etc.).
124 IdentifierInfo *getIdentifier() const { return Name.getAsIdentifierInfo(); }
126 /// getName - Get the name of identifier for this declaration as a StringRef.
127 /// This requires that the declaration have a name and that it be a simple
129 StringRef getName() const {
130 assert(Name.isIdentifier() && "Name is not a simple identifier");
131 return getIdentifier() ? getIdentifier()->getName() : "";
134 /// getNameAsString - Get a human-readable name for the declaration, even if
135 /// it is one of the special kinds of names (C++ constructor, Objective-C
136 /// selector, etc). Creating this name requires expensive string
137 /// manipulation, so it should be called only when performance doesn't matter.
138 /// For simple declarations, getNameAsCString() should suffice.
140 // FIXME: This function should be renamed to indicate that it is not just an
141 // alternate form of getName(), and clients should move as appropriate.
143 // FIXME: Deprecated, move clients to getName().
144 std::string getNameAsString() const { return Name.getAsString(); }
146 void printName(raw_ostream &os) const { os << Name; }
148 /// getDeclName - Get the actual, stored name of the declaration,
149 /// which may be a special name.
150 DeclarationName getDeclName() const { return Name; }
152 /// \brief Set the name of this declaration.
153 void setDeclName(DeclarationName N) { Name = N; }
155 /// printQualifiedName - Returns human-readable qualified name for
156 /// declaration, like A::B::i, for i being member of namespace A::B.
157 /// If declaration is not member of context which can be named (record,
158 /// namespace), it will return same result as printName().
159 /// Creating this name is expensive, so it should be called only when
160 /// performance doesn't matter.
161 void printQualifiedName(raw_ostream &OS) const;
162 void printQualifiedName(raw_ostream &OS, const PrintingPolicy &Policy) const;
164 // FIXME: Remove string versions.
165 std::string getQualifiedNameAsString() const;
166 std::string getQualifiedNameAsString(const PrintingPolicy &Policy) const;
168 /// getNameForDiagnostic - Appends a human-readable name for this
169 /// declaration into the given stream.
171 /// This is the method invoked by Sema when displaying a NamedDecl
172 /// in a diagnostic. It does not necessarily produce the same
173 /// result as printName(); for example, class template
174 /// specializations are printed with their template arguments.
175 virtual void getNameForDiagnostic(raw_ostream &OS,
176 const PrintingPolicy &Policy,
177 bool Qualified) const;
179 /// declarationReplaces - Determine whether this declaration, if
180 /// known to be well-formed within its context, will replace the
181 /// declaration OldD if introduced into scope. A declaration will
182 /// replace another declaration if, for example, it is a
183 /// redeclaration of the same variable or function, but not if it is
184 /// a declaration of a different kind (function vs. class) or an
185 /// overloaded function.
186 bool declarationReplaces(NamedDecl *OldD) const;
188 /// \brief Determine whether this declaration has linkage.
189 bool hasLinkage() const;
191 using Decl::isModulePrivate;
192 using Decl::setModulePrivate;
194 /// \brief Determine whether this declaration is hidden from name lookup.
195 bool isHidden() const { return Hidden; }
197 /// \brief Set whether this declaration is hidden from name lookup.
198 void setHidden(bool Hide) { Hidden = Hide; }
200 /// \brief Determine whether this declaration is a C++ class member.
201 bool isCXXClassMember() const {
202 const DeclContext *DC = getDeclContext();
204 // C++0x [class.mem]p1:
205 // The enumerators of an unscoped enumeration defined in
206 // the class are members of the class.
207 // FIXME: support C++0x scoped enumerations.
208 if (isa<EnumDecl>(DC))
209 DC = DC->getParent();
211 return DC->isRecord();
214 /// \brief Determine whether the given declaration is an instance member of
216 bool isCXXInstanceMember() const;
218 /// \brief Determine what kind of linkage this entity has.
219 /// This is not the linkage as defined by the standard or the codegen notion
220 /// of linkage. It is just an implementation detail that is used to compute
222 Linkage getLinkageInternal() const;
224 /// \brief Get the linkage from a semantic point of view. Entities in
225 /// anonymous namespaces are external (in c++98).
226 Linkage getFormalLinkage() const {
227 return clang::getFormalLinkage(getLinkageInternal());
230 /// \brief True if this decl has external linkage.
231 bool hasExternalFormalLinkage() const {
232 return isExternalFormalLinkage(getLinkageInternal());
235 bool isExternallyVisible() const {
236 return clang::isExternallyVisible(getLinkageInternal());
239 /// \brief Determines the visibility of this entity.
240 Visibility getVisibility() const {
241 return getLinkageAndVisibility().getVisibility();
244 /// \brief Determines the linkage and visibility of this entity.
245 LinkageInfo getLinkageAndVisibility() const;
247 /// Kinds of explicit visibility.
248 enum ExplicitVisibilityKind {
253 /// \brief If visibility was explicitly specified for this
254 /// declaration, return that visibility.
256 getExplicitVisibility(ExplicitVisibilityKind kind) const;
258 /// \brief True if the computed linkage is valid. Used for consistency
259 /// checking. Should always return true.
260 bool isLinkageValid() const;
262 /// \brief Looks through UsingDecls and ObjCCompatibleAliasDecls for
263 /// the underlying named decl.
264 NamedDecl *getUnderlyingDecl() {
265 // Fast-path the common case.
266 if (this->getKind() != UsingShadow &&
267 this->getKind() != ObjCCompatibleAlias)
270 return getUnderlyingDeclImpl();
272 const NamedDecl *getUnderlyingDecl() const {
273 return const_cast<NamedDecl*>(this)->getUnderlyingDecl();
276 NamedDecl *getMostRecentDecl() {
277 return cast<NamedDecl>(static_cast<Decl *>(this)->getMostRecentDecl());
279 const NamedDecl *getMostRecentDecl() const {
280 return const_cast<NamedDecl*>(this)->getMostRecentDecl();
283 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
284 static bool classofKind(Kind K) { return K >= firstNamed && K <= lastNamed; }
287 inline raw_ostream &operator<<(raw_ostream &OS, const NamedDecl &ND) {
292 /// LabelDecl - Represents the declaration of a label. Labels also have a
293 /// corresponding LabelStmt, which indicates the position that the label was
294 /// defined at. For normal labels, the location of the decl is the same as the
295 /// location of the statement. For GNU local labels (__label__), the decl
296 /// location is where the __label__ is.
297 class LabelDecl : public NamedDecl {
298 virtual void anchor();
300 /// LocStart - For normal labels, this is the same as the main declaration
301 /// label, i.e., the location of the identifier; for GNU local labels,
302 /// this is the location of the __label__ keyword.
303 SourceLocation LocStart;
305 LabelDecl(DeclContext *DC, SourceLocation IdentL, IdentifierInfo *II,
306 LabelStmt *S, SourceLocation StartL)
307 : NamedDecl(Label, DC, IdentL, II), TheStmt(S), LocStart(StartL) {}
310 static LabelDecl *Create(ASTContext &C, DeclContext *DC,
311 SourceLocation IdentL, IdentifierInfo *II);
312 static LabelDecl *Create(ASTContext &C, DeclContext *DC,
313 SourceLocation IdentL, IdentifierInfo *II,
314 SourceLocation GnuLabelL);
315 static LabelDecl *CreateDeserialized(ASTContext &C, unsigned ID);
317 LabelStmt *getStmt() const { return TheStmt; }
318 void setStmt(LabelStmt *T) { TheStmt = T; }
320 bool isGnuLocal() const { return LocStart != getLocation(); }
321 void setLocStart(SourceLocation L) { LocStart = L; }
323 SourceRange getSourceRange() const LLVM_READONLY {
324 return SourceRange(LocStart, getLocation());
327 // Implement isa/cast/dyncast/etc.
328 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
329 static bool classofKind(Kind K) { return K == Label; }
332 /// NamespaceDecl - Represent a C++ namespace.
333 class NamespaceDecl : public NamedDecl, public DeclContext,
334 public Redeclarable<NamespaceDecl>
336 virtual void anchor();
338 /// LocStart - The starting location of the source range, pointing
339 /// to either the namespace or the inline keyword.
340 SourceLocation LocStart;
341 /// RBraceLoc - The ending location of the source range.
342 SourceLocation RBraceLoc;
344 /// \brief A pointer to either the anonymous namespace that lives just inside
345 /// this namespace or to the first namespace in the chain (the latter case
346 /// only when this is not the first in the chain), along with a
347 /// boolean value indicating whether this is an inline namespace.
348 llvm::PointerIntPair<NamespaceDecl *, 1, bool> AnonOrFirstNamespaceAndInline;
350 NamespaceDecl(DeclContext *DC, bool Inline, SourceLocation StartLoc,
351 SourceLocation IdLoc, IdentifierInfo *Id,
352 NamespaceDecl *PrevDecl);
354 typedef Redeclarable<NamespaceDecl> redeclarable_base;
355 virtual NamespaceDecl *getNextRedeclaration() {
356 return RedeclLink.getNext();
358 virtual NamespaceDecl *getPreviousDeclImpl() {
359 return getPreviousDecl();
361 virtual NamespaceDecl *getMostRecentDeclImpl() {
362 return getMostRecentDecl();
366 static NamespaceDecl *Create(ASTContext &C, DeclContext *DC,
367 bool Inline, SourceLocation StartLoc,
368 SourceLocation IdLoc, IdentifierInfo *Id,
369 NamespaceDecl *PrevDecl);
371 static NamespaceDecl *CreateDeserialized(ASTContext &C, unsigned ID);
373 typedef redeclarable_base::redecl_iterator redecl_iterator;
374 using redeclarable_base::redecls_begin;
375 using redeclarable_base::redecls_end;
376 using redeclarable_base::getPreviousDecl;
377 using redeclarable_base::getMostRecentDecl;
378 using redeclarable_base::isFirstDecl;
380 /// \brief Returns true if this is an anonymous namespace declaration.
388 /// q.v. C++ [namespace.unnamed]
389 bool isAnonymousNamespace() const {
390 return !getIdentifier();
393 /// \brief Returns true if this is an inline namespace declaration.
394 bool isInline() const {
395 return AnonOrFirstNamespaceAndInline.getInt();
398 /// \brief Set whether this is an inline namespace declaration.
399 void setInline(bool Inline) {
400 AnonOrFirstNamespaceAndInline.setInt(Inline);
403 /// \brief Get the original (first) namespace declaration.
404 NamespaceDecl *getOriginalNamespace() {
408 return AnonOrFirstNamespaceAndInline.getPointer();
411 /// \brief Get the original (first) namespace declaration.
412 const NamespaceDecl *getOriginalNamespace() const {
416 return AnonOrFirstNamespaceAndInline.getPointer();
419 /// \brief Return true if this declaration is an original (first) declaration
420 /// of the namespace. This is false for non-original (subsequent) namespace
421 /// declarations and anonymous namespaces.
422 bool isOriginalNamespace() const { return isFirstDecl(); }
424 /// \brief Retrieve the anonymous namespace nested inside this namespace,
426 NamespaceDecl *getAnonymousNamespace() const {
427 return getOriginalNamespace()->AnonOrFirstNamespaceAndInline.getPointer();
430 void setAnonymousNamespace(NamespaceDecl *D) {
431 getOriginalNamespace()->AnonOrFirstNamespaceAndInline.setPointer(D);
434 /// Retrieves the canonical declaration of this namespace.
435 NamespaceDecl *getCanonicalDecl() {
436 return getOriginalNamespace();
438 const NamespaceDecl *getCanonicalDecl() const {
439 return getOriginalNamespace();
442 virtual SourceRange getSourceRange() const LLVM_READONLY {
443 return SourceRange(LocStart, RBraceLoc);
446 SourceLocation getLocStart() const LLVM_READONLY { return LocStart; }
447 SourceLocation getRBraceLoc() const { return RBraceLoc; }
448 void setLocStart(SourceLocation L) { LocStart = L; }
449 void setRBraceLoc(SourceLocation L) { RBraceLoc = L; }
451 // Implement isa/cast/dyncast/etc.
452 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
453 static bool classofKind(Kind K) { return K == Namespace; }
454 static DeclContext *castToDeclContext(const NamespaceDecl *D) {
455 return static_cast<DeclContext *>(const_cast<NamespaceDecl*>(D));
457 static NamespaceDecl *castFromDeclContext(const DeclContext *DC) {
458 return static_cast<NamespaceDecl *>(const_cast<DeclContext*>(DC));
461 friend class ASTDeclReader;
462 friend class ASTDeclWriter;
465 /// ValueDecl - Represent the declaration of a variable (in which case it is
466 /// an lvalue) a function (in which case it is a function designator) or
467 /// an enum constant.
468 class ValueDecl : public NamedDecl {
469 virtual void anchor();
473 ValueDecl(Kind DK, DeclContext *DC, SourceLocation L,
474 DeclarationName N, QualType T)
475 : NamedDecl(DK, DC, L, N), DeclType(T) {}
477 QualType getType() const { return DeclType; }
478 void setType(QualType newType) { DeclType = newType; }
480 /// \brief Determine whether this symbol is weakly-imported,
481 /// or declared with the weak or weak-ref attr.
484 // Implement isa/cast/dyncast/etc.
485 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
486 static bool classofKind(Kind K) { return K >= firstValue && K <= lastValue; }
489 /// QualifierInfo - A struct with extended info about a syntactic
490 /// name qualifier, to be used for the case of out-of-line declarations.
491 struct QualifierInfo {
492 NestedNameSpecifierLoc QualifierLoc;
494 /// NumTemplParamLists - The number of "outer" template parameter lists.
495 /// The count includes all of the template parameter lists that were matched
496 /// against the template-ids occurring into the NNS and possibly (in the
497 /// case of an explicit specialization) a final "template <>".
498 unsigned NumTemplParamLists;
500 /// TemplParamLists - A new-allocated array of size NumTemplParamLists,
501 /// containing pointers to the "outer" template parameter lists.
502 /// It includes all of the template parameter lists that were matched
503 /// against the template-ids occurring into the NNS and possibly (in the
504 /// case of an explicit specialization) a final "template <>".
505 TemplateParameterList** TemplParamLists;
507 /// Default constructor.
508 QualifierInfo() : QualifierLoc(), NumTemplParamLists(0), TemplParamLists(0) {}
510 /// setTemplateParameterListsInfo - Sets info about "outer" template
512 void setTemplateParameterListsInfo(ASTContext &Context,
514 TemplateParameterList **TPLists);
517 // Copy constructor and copy assignment are disabled.
518 QualifierInfo(const QualifierInfo&) LLVM_DELETED_FUNCTION;
519 QualifierInfo& operator=(const QualifierInfo&) LLVM_DELETED_FUNCTION;
522 /// \brief Represents a ValueDecl that came out of a declarator.
523 /// Contains type source information through TypeSourceInfo.
524 class DeclaratorDecl : public ValueDecl {
525 // A struct representing both a TInfo and a syntactic qualifier,
526 // to be used for the (uncommon) case of out-of-line declarations.
527 struct ExtInfo : public QualifierInfo {
528 TypeSourceInfo *TInfo;
531 llvm::PointerUnion<TypeSourceInfo*, ExtInfo*> DeclInfo;
533 /// InnerLocStart - The start of the source range for this declaration,
534 /// ignoring outer template declarations.
535 SourceLocation InnerLocStart;
537 bool hasExtInfo() const { return DeclInfo.is<ExtInfo*>(); }
538 ExtInfo *getExtInfo() { return DeclInfo.get<ExtInfo*>(); }
539 const ExtInfo *getExtInfo() const { return DeclInfo.get<ExtInfo*>(); }
542 DeclaratorDecl(Kind DK, DeclContext *DC, SourceLocation L,
543 DeclarationName N, QualType T, TypeSourceInfo *TInfo,
544 SourceLocation StartL)
545 : ValueDecl(DK, DC, L, N, T), DeclInfo(TInfo), InnerLocStart(StartL) {
549 TypeSourceInfo *getTypeSourceInfo() const {
551 ? getExtInfo()->TInfo
552 : DeclInfo.get<TypeSourceInfo*>();
554 void setTypeSourceInfo(TypeSourceInfo *TI) {
556 getExtInfo()->TInfo = TI;
561 /// getInnerLocStart - Return SourceLocation representing start of source
562 /// range ignoring outer template declarations.
563 SourceLocation getInnerLocStart() const { return InnerLocStart; }
564 void setInnerLocStart(SourceLocation L) { InnerLocStart = L; }
566 /// getOuterLocStart - Return SourceLocation representing start of source
567 /// range taking into account any outer template declarations.
568 SourceLocation getOuterLocStart() const;
570 virtual SourceRange getSourceRange() const LLVM_READONLY;
571 SourceLocation getLocStart() const LLVM_READONLY {
572 return getOuterLocStart();
575 /// \brief Retrieve the nested-name-specifier that qualifies the name of this
576 /// declaration, if it was present in the source.
577 NestedNameSpecifier *getQualifier() const {
578 return hasExtInfo() ? getExtInfo()->QualifierLoc.getNestedNameSpecifier()
582 /// \brief Retrieve the nested-name-specifier (with source-location
583 /// information) that qualifies the name of this declaration, if it was
584 /// present in the source.
585 NestedNameSpecifierLoc getQualifierLoc() const {
586 return hasExtInfo() ? getExtInfo()->QualifierLoc
587 : NestedNameSpecifierLoc();
590 void setQualifierInfo(NestedNameSpecifierLoc QualifierLoc);
592 unsigned getNumTemplateParameterLists() const {
593 return hasExtInfo() ? getExtInfo()->NumTemplParamLists : 0;
595 TemplateParameterList *getTemplateParameterList(unsigned index) const {
596 assert(index < getNumTemplateParameterLists());
597 return getExtInfo()->TemplParamLists[index];
599 void setTemplateParameterListsInfo(ASTContext &Context, unsigned NumTPLists,
600 TemplateParameterList **TPLists);
602 SourceLocation getTypeSpecStartLoc() const;
604 // Implement isa/cast/dyncast/etc.
605 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
606 static bool classofKind(Kind K) {
607 return K >= firstDeclarator && K <= lastDeclarator;
610 friend class ASTDeclReader;
611 friend class ASTDeclWriter;
614 /// \brief Structure used to store a statement, the constant value to
615 /// which it was evaluated (if any), and whether or not the statement
616 /// is an integral constant expression (if known).
617 struct EvaluatedStmt {
618 EvaluatedStmt() : WasEvaluated(false), IsEvaluating(false), CheckedICE(false),
619 CheckingICE(false), IsICE(false) { }
621 /// \brief Whether this statement was already evaluated.
622 bool WasEvaluated : 1;
624 /// \brief Whether this statement is being evaluated.
625 bool IsEvaluating : 1;
627 /// \brief Whether we already checked whether this statement was an
628 /// integral constant expression.
631 /// \brief Whether we are checking whether this statement is an
632 /// integral constant expression.
633 bool CheckingICE : 1;
635 /// \brief Whether this statement is an integral constant expression,
636 /// or in C++11, whether the statement is a constant expression. Only
637 /// valid if CheckedICE is true.
644 /// VarDecl - An instance of this class is created to represent a variable
645 /// declaration or definition.
646 class VarDecl : public DeclaratorDecl, public Redeclarable<VarDecl> {
648 typedef clang::StorageClass StorageClass;
650 /// getStorageClassSpecifierString - Return the string used to
651 /// specify the storage class \p SC.
653 /// It is illegal to call this function with SC == None.
654 static const char *getStorageClassSpecifierString(StorageClass SC);
656 /// \brief Initialization styles.
657 enum InitializationStyle {
658 CInit, ///< C-style initialization with assignment
659 CallInit, ///< Call-style initialization (C++98)
660 ListInit ///< Direct list-initialization (C++11)
663 /// \brief Kinds of thread-local storage.
665 TLS_None, ///< Not a TLS variable.
666 TLS_Static, ///< TLS with a known-constant initializer.
667 TLS_Dynamic ///< TLS with a dynamic initializer.
671 /// \brief Placeholder type used in Init to denote an unparsed C++ default
673 struct UnparsedDefaultArgument;
675 /// \brief Placeholder type used in Init to denote an uninstantiated C++
676 /// default argument.
677 struct UninstantiatedDefaultArgument;
679 typedef llvm::PointerUnion4<Stmt *, EvaluatedStmt *,
680 UnparsedDefaultArgument *,
681 UninstantiatedDefaultArgument *> InitType;
683 /// \brief The initializer for this variable or, for a ParmVarDecl, the
684 /// C++ default argument.
685 mutable InitType Init;
688 class VarDeclBitfields {
689 friend class VarDecl;
690 friend class ASTDeclReader;
693 unsigned TSCSpec : 2;
694 unsigned InitStyle : 2;
696 /// \brief Whether this variable is the exception variable in a C++ catch
697 /// or an Objective-C @catch statement.
698 unsigned ExceptionVar : 1;
700 /// \brief Whether this local variable could be allocated in the return
701 /// slot of its function, enabling the named return value optimization
703 unsigned NRVOVariable : 1;
705 /// \brief Whether this variable is the for-range-declaration in a C++0x
706 /// for-range statement.
707 unsigned CXXForRangeDecl : 1;
709 /// \brief Whether this variable is an ARC pseudo-__strong
710 /// variable; see isARCPseudoStrong() for details.
711 unsigned ARCPseudoStrong : 1;
713 /// \brief Whether this variable is (C++0x) constexpr.
714 unsigned IsConstexpr : 1;
716 /// \brief Whether this variable is the implicit variable for a lambda
718 unsigned IsInitCapture : 1;
720 /// \brief Whether this local extern variable's previous declaration was
721 /// declared in the same block scope. This controls whether we should merge
722 /// the type of this declaration with its previous declaration.
723 unsigned PreviousDeclInSameBlockScope : 1;
725 enum { NumVarDeclBits = 14 };
727 friend class ASTDeclReader;
728 friend class StmtIteratorBase;
729 friend class ASTNodeImporter;
732 enum { NumParameterIndexBits = 8 };
734 class ParmVarDeclBitfields {
735 friend class ParmVarDecl;
736 friend class ASTDeclReader;
738 unsigned : NumVarDeclBits;
740 /// Whether this parameter inherits a default argument from a
741 /// prior declaration.
742 unsigned HasInheritedDefaultArg : 1;
744 /// Whether this parameter undergoes K&R argument promotion.
745 unsigned IsKNRPromoted : 1;
747 /// Whether this parameter is an ObjC method parameter or not.
748 unsigned IsObjCMethodParam : 1;
750 /// If IsObjCMethodParam, a Decl::ObjCDeclQualifier.
751 /// Otherwise, the number of function parameter scopes enclosing
752 /// the function parameter scope in which this parameter was
754 unsigned ScopeDepthOrObjCQuals : 7;
756 /// The number of parameters preceding this parameter in the
757 /// function parameter scope in which it was declared.
758 unsigned ParameterIndex : NumParameterIndexBits;
763 VarDeclBitfields VarDeclBits;
764 ParmVarDeclBitfields ParmVarDeclBits;
767 VarDecl(Kind DK, DeclContext *DC, SourceLocation StartLoc,
768 SourceLocation IdLoc, IdentifierInfo *Id, QualType T,
769 TypeSourceInfo *TInfo, StorageClass SC);
771 typedef Redeclarable<VarDecl> redeclarable_base;
772 virtual VarDecl *getNextRedeclaration() { return RedeclLink.getNext(); }
773 virtual VarDecl *getPreviousDeclImpl() {
774 return getPreviousDecl();
776 virtual VarDecl *getMostRecentDeclImpl() {
777 return getMostRecentDecl();
781 typedef redeclarable_base::redecl_iterator redecl_iterator;
782 using redeclarable_base::redecls_begin;
783 using redeclarable_base::redecls_end;
784 using redeclarable_base::getPreviousDecl;
785 using redeclarable_base::getMostRecentDecl;
786 using redeclarable_base::isFirstDecl;
788 static VarDecl *Create(ASTContext &C, DeclContext *DC,
789 SourceLocation StartLoc, SourceLocation IdLoc,
790 IdentifierInfo *Id, QualType T, TypeSourceInfo *TInfo,
793 static VarDecl *CreateDeserialized(ASTContext &C, unsigned ID);
795 virtual SourceRange getSourceRange() const LLVM_READONLY;
797 /// \brief Returns the storage class as written in the source. For the
798 /// computed linkage of symbol, see getLinkage.
799 StorageClass getStorageClass() const {
800 return (StorageClass) VarDeclBits.SClass;
802 void setStorageClass(StorageClass SC);
804 void setTSCSpec(ThreadStorageClassSpecifier TSC) {
805 VarDeclBits.TSCSpec = TSC;
807 ThreadStorageClassSpecifier getTSCSpec() const {
808 return static_cast<ThreadStorageClassSpecifier>(VarDeclBits.TSCSpec);
810 TLSKind getTLSKind() const {
811 switch (VarDeclBits.TSCSpec) {
812 case TSCS_unspecified:
814 case TSCS___thread: // Fall through.
815 case TSCS__Thread_local:
817 case TSCS_thread_local:
820 llvm_unreachable("Unknown thread storage class specifier!");
823 /// hasLocalStorage - Returns true if a variable with function scope
824 /// is a non-static local variable.
825 bool hasLocalStorage() const {
826 if (getStorageClass() == SC_None)
827 // Second check is for C++11 [dcl.stc]p4.
828 return !isFileVarDecl() && getTSCSpec() == TSCS_unspecified;
830 // Return true for: Auto, Register.
831 // Return false for: Extern, Static, PrivateExtern, OpenCLWorkGroupLocal.
833 return getStorageClass() >= SC_Auto;
836 /// isStaticLocal - Returns true if a variable with function scope is a
837 /// static local variable.
838 bool isStaticLocal() const {
839 return (getStorageClass() == SC_Static ||
841 (getStorageClass() == SC_None && getTSCSpec() == TSCS_thread_local))
845 /// \brief Returns true if a variable has extern or __private_extern__
847 bool hasExternalStorage() const {
848 return getStorageClass() == SC_Extern ||
849 getStorageClass() == SC_PrivateExtern;
852 /// \brief Returns true for all variables that do not have local storage.
854 /// This includes all global variables as well as static variables declared
855 /// within a function.
856 bool hasGlobalStorage() const { return !hasLocalStorage(); }
858 /// \brief Get the storage duration of this variable, per C++ [basic.stc].
859 StorageDuration getStorageDuration() const {
860 return hasLocalStorage() ? SD_Automatic :
861 getTSCSpec() ? SD_Thread : SD_Static;
864 /// \brief Compute the language linkage.
865 LanguageLinkage getLanguageLinkage() const;
867 /// \brief Determines whether this variable is a variable with
868 /// external, C linkage.
869 bool isExternC() const;
871 /// \brief Determines whether this variable's context is, or is nested within,
872 /// a C++ extern "C" linkage spec.
873 bool isInExternCContext() const;
875 /// \brief Determines whether this variable's context is, or is nested within,
876 /// a C++ extern "C++" linkage spec.
877 bool isInExternCXXContext() const;
879 /// isLocalVarDecl - Returns true for local variable declarations
880 /// other than parameters. Note that this includes static variables
881 /// inside of functions. It also includes variables inside blocks.
883 /// void foo() { int x; static int y; extern int z; }
885 bool isLocalVarDecl() const {
886 if (getKind() != Decl::Var)
888 if (const DeclContext *DC = getLexicalDeclContext())
889 return DC->getRedeclContext()->isFunctionOrMethod();
893 /// isFunctionOrMethodVarDecl - Similar to isLocalVarDecl, but
894 /// excludes variables declared in blocks.
895 bool isFunctionOrMethodVarDecl() const {
896 if (getKind() != Decl::Var)
898 const DeclContext *DC = getLexicalDeclContext()->getRedeclContext();
899 return DC->isFunctionOrMethod() && DC->getDeclKind() != Decl::Block;
902 /// \brief Determines whether this is a static data member.
904 /// This will only be true in C++, and applies to, e.g., the
911 bool isStaticDataMember() const {
912 // If it wasn't static, it would be a FieldDecl.
913 return getKind() != Decl::ParmVar && getDeclContext()->isRecord();
916 virtual VarDecl *getCanonicalDecl();
917 const VarDecl *getCanonicalDecl() const {
918 return const_cast<VarDecl*>(this)->getCanonicalDecl();
921 enum DefinitionKind {
922 DeclarationOnly, ///< This declaration is only a declaration.
923 TentativeDefinition, ///< This declaration is a tentative definition.
924 Definition ///< This declaration is definitely a definition.
927 /// \brief Check whether this declaration is a definition. If this could be
928 /// a tentative definition (in C), don't check whether there's an overriding
930 DefinitionKind isThisDeclarationADefinition(ASTContext &) const;
931 DefinitionKind isThisDeclarationADefinition() const {
932 return isThisDeclarationADefinition(getASTContext());
935 /// \brief Check whether this variable is defined in this
936 /// translation unit.
937 DefinitionKind hasDefinition(ASTContext &) const;
938 DefinitionKind hasDefinition() const {
939 return hasDefinition(getASTContext());
942 /// \brief Get the tentative definition that acts as the real definition in
943 /// a TU. Returns null if there is a proper definition available.
944 VarDecl *getActingDefinition();
945 const VarDecl *getActingDefinition() const {
946 return const_cast<VarDecl*>(this)->getActingDefinition();
949 /// \brief Get the real (not just tentative) definition for this declaration.
950 VarDecl *getDefinition(ASTContext &);
951 const VarDecl *getDefinition(ASTContext &C) const {
952 return const_cast<VarDecl*>(this)->getDefinition(C);
954 VarDecl *getDefinition() {
955 return getDefinition(getASTContext());
957 const VarDecl *getDefinition() const {
958 return const_cast<VarDecl*>(this)->getDefinition();
961 /// \brief Determine whether this is or was instantiated from an out-of-line
962 /// definition of a static data member.
963 virtual bool isOutOfLine() const;
965 /// \brief If this is a static data member, find its out-of-line definition.
966 VarDecl *getOutOfLineDefinition();
968 /// isFileVarDecl - Returns true for file scoped variable declaration.
969 bool isFileVarDecl() const {
971 if (K == ParmVar || K == ImplicitParam)
974 if (getLexicalDeclContext()->getRedeclContext()->isFileContext())
977 if (isStaticDataMember())
983 /// getAnyInitializer - Get the initializer for this variable, no matter which
984 /// declaration it is attached to.
985 const Expr *getAnyInitializer() const {
987 return getAnyInitializer(D);
990 /// getAnyInitializer - Get the initializer for this variable, no matter which
991 /// declaration it is attached to. Also get that declaration.
992 const Expr *getAnyInitializer(const VarDecl *&D) const;
994 bool hasInit() const {
995 return !Init.isNull() && (Init.is<Stmt *>() || Init.is<EvaluatedStmt *>());
997 const Expr *getInit() const {
1001 const Stmt *S = Init.dyn_cast<Stmt *>();
1003 if (EvaluatedStmt *ES = Init.dyn_cast<EvaluatedStmt*>())
1006 return (const Expr*) S;
1012 Stmt *S = Init.dyn_cast<Stmt *>();
1014 if (EvaluatedStmt *ES = Init.dyn_cast<EvaluatedStmt*>())
1021 /// \brief Retrieve the address of the initializer expression.
1022 Stmt **getInitAddress() {
1023 if (EvaluatedStmt *ES = Init.dyn_cast<EvaluatedStmt*>())
1026 // This union hack tip-toes around strict-aliasing rules.
1036 void setInit(Expr *I);
1038 /// \brief Determine whether this variable's value can be used in a
1039 /// constant expression, according to the relevant language standard.
1040 /// This only checks properties of the declaration, and does not check
1041 /// whether the initializer is in fact a constant expression.
1042 bool isUsableInConstantExpressions(ASTContext &C) const;
1044 EvaluatedStmt *ensureEvaluatedStmt() const;
1046 /// \brief Attempt to evaluate the value of the initializer attached to this
1047 /// declaration, and produce notes explaining why it cannot be evaluated or is
1048 /// not a constant expression. Returns a pointer to the value if evaluation
1049 /// succeeded, 0 otherwise.
1050 APValue *evaluateValue() const;
1051 APValue *evaluateValue(SmallVectorImpl<PartialDiagnosticAt> &Notes) const;
1053 /// \brief Return the already-evaluated value of this variable's
1054 /// initializer, or NULL if the value is not yet known. Returns pointer
1055 /// to untyped APValue if the value could not be evaluated.
1056 APValue *getEvaluatedValue() const {
1057 if (EvaluatedStmt *Eval = Init.dyn_cast<EvaluatedStmt *>())
1058 if (Eval->WasEvaluated)
1059 return &Eval->Evaluated;
1064 /// \brief Determines whether it is already known whether the
1065 /// initializer is an integral constant expression or not.
1066 bool isInitKnownICE() const {
1067 if (EvaluatedStmt *Eval = Init.dyn_cast<EvaluatedStmt *>())
1068 return Eval->CheckedICE;
1073 /// \brief Determines whether the initializer is an integral constant
1074 /// expression, or in C++11, whether the initializer is a constant
1077 /// \pre isInitKnownICE()
1078 bool isInitICE() const {
1079 assert(isInitKnownICE() &&
1080 "Check whether we already know that the initializer is an ICE");
1081 return Init.get<EvaluatedStmt *>()->IsICE;
1084 /// \brief Determine whether the value of the initializer attached to this
1085 /// declaration is an integral constant expression.
1086 bool checkInitIsICE() const;
1088 void setInitStyle(InitializationStyle Style) {
1089 VarDeclBits.InitStyle = Style;
1092 /// \brief The style of initialization for this declaration.
1094 /// C-style initialization is "int x = 1;". Call-style initialization is
1095 /// a C++98 direct-initializer, e.g. "int x(1);". The Init expression will be
1096 /// the expression inside the parens or a "ClassType(a,b,c)" class constructor
1097 /// expression for class types. List-style initialization is C++11 syntax,
1098 /// e.g. "int x{1};". Clients can distinguish between different forms of
1099 /// initialization by checking this value. In particular, "int x = {1};" is
1100 /// C-style, "int x({1})" is call-style, and "int x{1};" is list-style; the
1101 /// Init expression in all three cases is an InitListExpr.
1102 InitializationStyle getInitStyle() const {
1103 return static_cast<InitializationStyle>(VarDeclBits.InitStyle);
1106 /// \brief Whether the initializer is a direct-initializer (list or call).
1107 bool isDirectInit() const {
1108 return getInitStyle() != CInit;
1111 /// \brief Determine whether this variable is the exception variable in a
1112 /// C++ catch statememt or an Objective-C \@catch statement.
1113 bool isExceptionVariable() const {
1114 return VarDeclBits.ExceptionVar;
1116 void setExceptionVariable(bool EV) { VarDeclBits.ExceptionVar = EV; }
1118 /// \brief Determine whether this local variable can be used with the named
1119 /// return value optimization (NRVO).
1121 /// The named return value optimization (NRVO) works by marking certain
1122 /// non-volatile local variables of class type as NRVO objects. These
1123 /// locals can be allocated within the return slot of their containing
1124 /// function, in which case there is no need to copy the object to the
1125 /// return slot when returning from the function. Within the function body,
1126 /// each return that returns the NRVO object will have this variable as its
1128 bool isNRVOVariable() const { return VarDeclBits.NRVOVariable; }
1129 void setNRVOVariable(bool NRVO) { VarDeclBits.NRVOVariable = NRVO; }
1131 /// \brief Determine whether this variable is the for-range-declaration in
1132 /// a C++0x for-range statement.
1133 bool isCXXForRangeDecl() const { return VarDeclBits.CXXForRangeDecl; }
1134 void setCXXForRangeDecl(bool FRD) { VarDeclBits.CXXForRangeDecl = FRD; }
1136 /// \brief Determine whether this variable is an ARC pseudo-__strong
1137 /// variable. A pseudo-__strong variable has a __strong-qualified
1138 /// type but does not actually retain the object written into it.
1139 /// Generally such variables are also 'const' for safety.
1140 bool isARCPseudoStrong() const { return VarDeclBits.ARCPseudoStrong; }
1141 void setARCPseudoStrong(bool ps) { VarDeclBits.ARCPseudoStrong = ps; }
1143 /// Whether this variable is (C++11) constexpr.
1144 bool isConstexpr() const { return VarDeclBits.IsConstexpr; }
1145 void setConstexpr(bool IC) { VarDeclBits.IsConstexpr = IC; }
1147 /// Whether this variable is the implicit variable for a lambda init-capture.
1148 bool isInitCapture() const { return VarDeclBits.IsInitCapture; }
1149 void setInitCapture(bool IC) { VarDeclBits.IsInitCapture = IC; }
1151 /// Whether this local extern variable declaration's previous declaration
1152 /// was declared in the same block scope. Only correct in C++.
1153 bool isPreviousDeclInSameBlockScope() const {
1154 return VarDeclBits.PreviousDeclInSameBlockScope;
1156 void setPreviousDeclInSameBlockScope(bool Same) {
1157 VarDeclBits.PreviousDeclInSameBlockScope = Same;
1160 /// \brief If this variable is an instantiated static data member of a
1161 /// class template specialization, returns the templated static data member
1162 /// from which it was instantiated.
1163 VarDecl *getInstantiatedFromStaticDataMember() const;
1165 /// \brief If this variable is an instantiation of a variable template or a
1166 /// static data member of a class template, determine what kind of
1167 /// template specialization or instantiation this is.
1168 TemplateSpecializationKind getTemplateSpecializationKind() const;
1170 /// \brief If this variable is an instantiation of a variable template or a
1171 /// static data member of a class template, determine its point of
1173 SourceLocation getPointOfInstantiation() const;
1175 /// \brief If this variable is an instantiation of a static data member of a
1176 /// class template specialization, retrieves the member specialization
1178 MemberSpecializationInfo *getMemberSpecializationInfo() const;
1180 /// \brief For a static data member that was instantiated from a static
1181 /// data member of a class template, set the template specialiation kind.
1182 void setTemplateSpecializationKind(TemplateSpecializationKind TSK,
1183 SourceLocation PointOfInstantiation = SourceLocation());
1185 /// \brief Specify that this variable is an instantiation of the
1186 /// static data member VD.
1187 void setInstantiationOfStaticDataMember(VarDecl *VD,
1188 TemplateSpecializationKind TSK);
1190 /// \brief Retrieves the variable template that is described by this
1191 /// variable declaration.
1193 /// Every variable template is represented as a VarTemplateDecl and a
1194 /// VarDecl. The former contains template properties (such as
1195 /// the template parameter lists) while the latter contains the
1196 /// actual description of the template's
1197 /// contents. VarTemplateDecl::getTemplatedDecl() retrieves the
1198 /// VarDecl that from a VarTemplateDecl, while
1199 /// getDescribedVarTemplate() retrieves the VarTemplateDecl from
1201 VarTemplateDecl *getDescribedVarTemplate() const;
1203 void setDescribedVarTemplate(VarTemplateDecl *Template);
1205 // Implement isa/cast/dyncast/etc.
1206 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1207 static bool classofKind(Kind K) { return K >= firstVar && K <= lastVar; }
1210 class ImplicitParamDecl : public VarDecl {
1211 virtual void anchor();
1213 static ImplicitParamDecl *Create(ASTContext &C, DeclContext *DC,
1214 SourceLocation IdLoc, IdentifierInfo *Id,
1217 static ImplicitParamDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1219 ImplicitParamDecl(DeclContext *DC, SourceLocation IdLoc,
1220 IdentifierInfo *Id, QualType Type)
1221 : VarDecl(ImplicitParam, DC, IdLoc, IdLoc, Id, Type,
1222 /*tinfo*/ 0, SC_None) {
1226 // Implement isa/cast/dyncast/etc.
1227 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1228 static bool classofKind(Kind K) { return K == ImplicitParam; }
1231 /// ParmVarDecl - Represents a parameter to a function.
1232 class ParmVarDecl : public VarDecl {
1234 enum { MaxFunctionScopeDepth = 255 };
1235 enum { MaxFunctionScopeIndex = 255 };
1238 ParmVarDecl(Kind DK, DeclContext *DC, SourceLocation StartLoc,
1239 SourceLocation IdLoc, IdentifierInfo *Id,
1240 QualType T, TypeSourceInfo *TInfo,
1241 StorageClass S, Expr *DefArg)
1242 : VarDecl(DK, DC, StartLoc, IdLoc, Id, T, TInfo, S) {
1243 assert(ParmVarDeclBits.HasInheritedDefaultArg == false);
1244 assert(ParmVarDeclBits.IsKNRPromoted == false);
1245 assert(ParmVarDeclBits.IsObjCMethodParam == false);
1246 setDefaultArg(DefArg);
1250 static ParmVarDecl *Create(ASTContext &C, DeclContext *DC,
1251 SourceLocation StartLoc,
1252 SourceLocation IdLoc, IdentifierInfo *Id,
1253 QualType T, TypeSourceInfo *TInfo,
1254 StorageClass S, Expr *DefArg);
1256 static ParmVarDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1258 virtual SourceRange getSourceRange() const LLVM_READONLY;
1260 void setObjCMethodScopeInfo(unsigned parameterIndex) {
1261 ParmVarDeclBits.IsObjCMethodParam = true;
1262 setParameterIndex(parameterIndex);
1265 void setScopeInfo(unsigned scopeDepth, unsigned parameterIndex) {
1266 assert(!ParmVarDeclBits.IsObjCMethodParam);
1268 ParmVarDeclBits.ScopeDepthOrObjCQuals = scopeDepth;
1269 assert(ParmVarDeclBits.ScopeDepthOrObjCQuals == scopeDepth
1272 setParameterIndex(parameterIndex);
1275 bool isObjCMethodParameter() const {
1276 return ParmVarDeclBits.IsObjCMethodParam;
1279 unsigned getFunctionScopeDepth() const {
1280 if (ParmVarDeclBits.IsObjCMethodParam) return 0;
1281 return ParmVarDeclBits.ScopeDepthOrObjCQuals;
1284 /// Returns the index of this parameter in its prototype or method scope.
1285 unsigned getFunctionScopeIndex() const {
1286 return getParameterIndex();
1289 ObjCDeclQualifier getObjCDeclQualifier() const {
1290 if (!ParmVarDeclBits.IsObjCMethodParam) return OBJC_TQ_None;
1291 return ObjCDeclQualifier(ParmVarDeclBits.ScopeDepthOrObjCQuals);
1293 void setObjCDeclQualifier(ObjCDeclQualifier QTVal) {
1294 assert(ParmVarDeclBits.IsObjCMethodParam);
1295 ParmVarDeclBits.ScopeDepthOrObjCQuals = QTVal;
1298 /// True if the value passed to this parameter must undergo
1299 /// K&R-style default argument promotion:
1302 /// If the expression that denotes the called function has a type
1303 /// that does not include a prototype, the integer promotions are
1304 /// performed on each argument, and arguments that have type float
1305 /// are promoted to double.
1306 bool isKNRPromoted() const {
1307 return ParmVarDeclBits.IsKNRPromoted;
1309 void setKNRPromoted(bool promoted) {
1310 ParmVarDeclBits.IsKNRPromoted = promoted;
1313 Expr *getDefaultArg();
1314 const Expr *getDefaultArg() const {
1315 return const_cast<ParmVarDecl *>(this)->getDefaultArg();
1318 void setDefaultArg(Expr *defarg) {
1319 Init = reinterpret_cast<Stmt *>(defarg);
1322 /// \brief Retrieve the source range that covers the entire default
1324 SourceRange getDefaultArgRange() const;
1325 void setUninstantiatedDefaultArg(Expr *arg) {
1326 Init = reinterpret_cast<UninstantiatedDefaultArgument *>(arg);
1328 Expr *getUninstantiatedDefaultArg() {
1329 return (Expr *)Init.get<UninstantiatedDefaultArgument *>();
1331 const Expr *getUninstantiatedDefaultArg() const {
1332 return (const Expr *)Init.get<UninstantiatedDefaultArgument *>();
1335 /// hasDefaultArg - Determines whether this parameter has a default argument,
1336 /// either parsed or not.
1337 bool hasDefaultArg() const {
1338 return getInit() || hasUnparsedDefaultArg() ||
1339 hasUninstantiatedDefaultArg();
1342 /// hasUnparsedDefaultArg - Determines whether this parameter has a
1343 /// default argument that has not yet been parsed. This will occur
1344 /// during the processing of a C++ class whose member functions have
1345 /// default arguments, e.g.,
1349 /// void f(int x = 17); // x has an unparsed default argument now
1350 /// }; // x has a regular default argument now
1352 bool hasUnparsedDefaultArg() const {
1353 return Init.is<UnparsedDefaultArgument*>();
1356 bool hasUninstantiatedDefaultArg() const {
1357 return Init.is<UninstantiatedDefaultArgument*>();
1360 /// setUnparsedDefaultArg - Specify that this parameter has an
1361 /// unparsed default argument. The argument will be replaced with a
1362 /// real default argument via setDefaultArg when the class
1363 /// definition enclosing the function declaration that owns this
1364 /// default argument is completed.
1365 void setUnparsedDefaultArg() {
1366 Init = (UnparsedDefaultArgument *)0;
1369 bool hasInheritedDefaultArg() const {
1370 return ParmVarDeclBits.HasInheritedDefaultArg;
1373 void setHasInheritedDefaultArg(bool I = true) {
1374 ParmVarDeclBits.HasInheritedDefaultArg = I;
1377 QualType getOriginalType() const;
1379 /// \brief Determine whether this parameter is actually a function
1381 bool isParameterPack() const;
1383 /// setOwningFunction - Sets the function declaration that owns this
1384 /// ParmVarDecl. Since ParmVarDecls are often created before the
1385 /// FunctionDecls that own them, this routine is required to update
1386 /// the DeclContext appropriately.
1387 void setOwningFunction(DeclContext *FD) { setDeclContext(FD); }
1389 // Implement isa/cast/dyncast/etc.
1390 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1391 static bool classofKind(Kind K) { return K == ParmVar; }
1394 enum { ParameterIndexSentinel = (1 << NumParameterIndexBits) - 1 };
1396 void setParameterIndex(unsigned parameterIndex) {
1397 if (parameterIndex >= ParameterIndexSentinel) {
1398 setParameterIndexLarge(parameterIndex);
1402 ParmVarDeclBits.ParameterIndex = parameterIndex;
1403 assert(ParmVarDeclBits.ParameterIndex == parameterIndex && "truncation!");
1405 unsigned getParameterIndex() const {
1406 unsigned d = ParmVarDeclBits.ParameterIndex;
1407 return d == ParameterIndexSentinel ? getParameterIndexLarge() : d;
1410 void setParameterIndexLarge(unsigned parameterIndex);
1411 unsigned getParameterIndexLarge() const;
1414 /// FunctionDecl - An instance of this class is created to represent a
1415 /// function declaration or definition.
1417 /// Since a given function can be declared several times in a program,
1418 /// there may be several FunctionDecls that correspond to that
1419 /// function. Only one of those FunctionDecls will be found when
1420 /// traversing the list of declarations in the context of the
1421 /// FunctionDecl (e.g., the translation unit); this FunctionDecl
1422 /// contains all of the information known about the function. Other,
1423 /// previous declarations of the function are available via the
1424 /// getPreviousDecl() chain.
1425 class FunctionDecl : public DeclaratorDecl, public DeclContext,
1426 public Redeclarable<FunctionDecl> {
1428 typedef clang::StorageClass StorageClass;
1430 /// \brief The kind of templated function a FunctionDecl can be.
1431 enum TemplatedKind {
1433 TK_FunctionTemplate,
1434 TK_MemberSpecialization,
1435 TK_FunctionTemplateSpecialization,
1436 TK_DependentFunctionTemplateSpecialization
1440 /// ParamInfo - new[]'d array of pointers to VarDecls for the formal
1441 /// parameters of this function. This is null if a prototype or if there are
1443 ParmVarDecl **ParamInfo;
1445 /// DeclsInPrototypeScope - Array of pointers to NamedDecls for
1446 /// decls defined in the function prototype that are not parameters. E.g.
1447 /// 'enum Y' in 'void f(enum Y {AA} x) {}'.
1448 ArrayRef<NamedDecl *> DeclsInPrototypeScope;
1450 LazyDeclStmtPtr Body;
1452 // FIXME: This can be packed into the bitfields in Decl.
1453 // NOTE: VC++ treats enums as signed, avoid using the StorageClass enum
1454 unsigned SClass : 2;
1456 bool IsInlineSpecified : 1;
1457 bool IsVirtualAsWritten : 1;
1459 bool HasInheritedPrototype : 1;
1460 bool HasWrittenPrototype : 1;
1462 bool IsTrivial : 1; // sunk from CXXMethodDecl
1463 bool IsDefaulted : 1; // sunk from CXXMethoDecl
1464 bool IsExplicitlyDefaulted : 1; //sunk from CXXMethodDecl
1465 bool HasImplicitReturnZero : 1;
1466 bool IsLateTemplateParsed : 1;
1467 bool IsConstexpr : 1;
1469 /// \brief Indicates if the function was a definition but its body was
1471 unsigned HasSkippedBody : 1;
1473 /// \brief End part of this FunctionDecl's source range.
1475 /// We could compute the full range in getSourceRange(). However, when we're
1476 /// dealing with a function definition deserialized from a PCH/AST file,
1477 /// we can only compute the full range once the function body has been
1478 /// de-serialized, so it's far better to have the (sometimes-redundant)
1480 SourceLocation EndRangeLoc;
1482 /// \brief The template or declaration that this declaration
1483 /// describes or was instantiated from, respectively.
1485 /// For non-templates, this value will be NULL. For function
1486 /// declarations that describe a function template, this will be a
1487 /// pointer to a FunctionTemplateDecl. For member functions
1488 /// of class template specializations, this will be a MemberSpecializationInfo
1489 /// pointer containing information about the specialization.
1490 /// For function template specializations, this will be a
1491 /// FunctionTemplateSpecializationInfo, which contains information about
1492 /// the template being specialized and the template arguments involved in
1493 /// that specialization.
1494 llvm::PointerUnion4<FunctionTemplateDecl *,
1495 MemberSpecializationInfo *,
1496 FunctionTemplateSpecializationInfo *,
1497 DependentFunctionTemplateSpecializationInfo *>
1498 TemplateOrSpecialization;
1500 /// DNLoc - Provides source/type location info for the
1501 /// declaration name embedded in the DeclaratorDecl base class.
1502 DeclarationNameLoc DNLoc;
1504 /// \brief Specify that this function declaration is actually a function
1505 /// template specialization.
1507 /// \param C the ASTContext.
1509 /// \param Template the function template that this function template
1510 /// specialization specializes.
1512 /// \param TemplateArgs the template arguments that produced this
1513 /// function template specialization from the template.
1515 /// \param InsertPos If non-NULL, the position in the function template
1516 /// specialization set where the function template specialization data will
1519 /// \param TSK the kind of template specialization this is.
1521 /// \param TemplateArgsAsWritten location info of template arguments.
1523 /// \param PointOfInstantiation point at which the function template
1524 /// specialization was first instantiated.
1525 void setFunctionTemplateSpecialization(ASTContext &C,
1526 FunctionTemplateDecl *Template,
1527 const TemplateArgumentList *TemplateArgs,
1529 TemplateSpecializationKind TSK,
1530 const TemplateArgumentListInfo *TemplateArgsAsWritten,
1531 SourceLocation PointOfInstantiation);
1533 /// \brief Specify that this record is an instantiation of the
1534 /// member function FD.
1535 void setInstantiationOfMemberFunction(ASTContext &C, FunctionDecl *FD,
1536 TemplateSpecializationKind TSK);
1538 void setParams(ASTContext &C, ArrayRef<ParmVarDecl *> NewParamInfo);
1541 FunctionDecl(Kind DK, DeclContext *DC, SourceLocation StartLoc,
1542 const DeclarationNameInfo &NameInfo,
1543 QualType T, TypeSourceInfo *TInfo,
1544 StorageClass S, bool isInlineSpecified,
1545 bool isConstexprSpecified)
1546 : DeclaratorDecl(DK, DC, NameInfo.getLoc(), NameInfo.getName(), T, TInfo,
1549 ParamInfo(0), Body(),
1551 IsInline(isInlineSpecified), IsInlineSpecified(isInlineSpecified),
1552 IsVirtualAsWritten(false), IsPure(false), HasInheritedPrototype(false),
1553 HasWrittenPrototype(true), IsDeleted(false), IsTrivial(false),
1554 IsDefaulted(false), IsExplicitlyDefaulted(false),
1555 HasImplicitReturnZero(false), IsLateTemplateParsed(false),
1556 IsConstexpr(isConstexprSpecified), HasSkippedBody(false),
1557 EndRangeLoc(NameInfo.getEndLoc()),
1558 TemplateOrSpecialization(),
1559 DNLoc(NameInfo.getInfo()) {}
1561 typedef Redeclarable<FunctionDecl> redeclarable_base;
1562 virtual FunctionDecl *getNextRedeclaration() { return RedeclLink.getNext(); }
1563 virtual FunctionDecl *getPreviousDeclImpl() {
1564 return getPreviousDecl();
1566 virtual FunctionDecl *getMostRecentDeclImpl() {
1567 return getMostRecentDecl();
1571 typedef redeclarable_base::redecl_iterator redecl_iterator;
1572 using redeclarable_base::redecls_begin;
1573 using redeclarable_base::redecls_end;
1574 using redeclarable_base::getPreviousDecl;
1575 using redeclarable_base::getMostRecentDecl;
1576 using redeclarable_base::isFirstDecl;
1578 static FunctionDecl *Create(ASTContext &C, DeclContext *DC,
1579 SourceLocation StartLoc, SourceLocation NLoc,
1580 DeclarationName N, QualType T,
1581 TypeSourceInfo *TInfo,
1583 bool isInlineSpecified = false,
1584 bool hasWrittenPrototype = true,
1585 bool isConstexprSpecified = false) {
1586 DeclarationNameInfo NameInfo(N, NLoc);
1587 return FunctionDecl::Create(C, DC, StartLoc, NameInfo, T, TInfo,
1589 isInlineSpecified, hasWrittenPrototype,
1590 isConstexprSpecified);
1593 static FunctionDecl *Create(ASTContext &C, DeclContext *DC,
1594 SourceLocation StartLoc,
1595 const DeclarationNameInfo &NameInfo,
1596 QualType T, TypeSourceInfo *TInfo,
1598 bool isInlineSpecified,
1599 bool hasWrittenPrototype,
1600 bool isConstexprSpecified = false);
1602 static FunctionDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1604 DeclarationNameInfo getNameInfo() const {
1605 return DeclarationNameInfo(getDeclName(), getLocation(), DNLoc);
1608 virtual void getNameForDiagnostic(raw_ostream &OS,
1609 const PrintingPolicy &Policy,
1610 bool Qualified) const;
1612 void setRangeEnd(SourceLocation E) { EndRangeLoc = E; }
1614 virtual SourceRange getSourceRange() const LLVM_READONLY;
1616 /// \brief Returns true if the function has a body (definition). The
1617 /// function body might be in any of the (re-)declarations of this
1618 /// function. The variant that accepts a FunctionDecl pointer will
1619 /// set that function declaration to the actual declaration
1620 /// containing the body (if there is one).
1621 bool hasBody(const FunctionDecl *&Definition) const;
1623 virtual bool hasBody() const {
1624 const FunctionDecl* Definition;
1625 return hasBody(Definition);
1628 /// hasTrivialBody - Returns whether the function has a trivial body that does
1629 /// not require any specific codegen.
1630 bool hasTrivialBody() const;
1632 /// isDefined - Returns true if the function is defined at all, including
1633 /// a deleted definition. Except for the behavior when the function is
1634 /// deleted, behaves like hasBody.
1635 bool isDefined(const FunctionDecl *&Definition) const;
1637 virtual bool isDefined() const {
1638 const FunctionDecl* Definition;
1639 return isDefined(Definition);
1642 /// getBody - Retrieve the body (definition) of the function. The
1643 /// function body might be in any of the (re-)declarations of this
1644 /// function. The variant that accepts a FunctionDecl pointer will
1645 /// set that function declaration to the actual declaration
1646 /// containing the body (if there is one).
1647 /// NOTE: For checking if there is a body, use hasBody() instead, to avoid
1648 /// unnecessary AST de-serialization of the body.
1649 Stmt *getBody(const FunctionDecl *&Definition) const;
1651 virtual Stmt *getBody() const {
1652 const FunctionDecl* Definition;
1653 return getBody(Definition);
1656 /// isThisDeclarationADefinition - Returns whether this specific
1657 /// declaration of the function is also a definition. This does not
1658 /// determine whether the function has been defined (e.g., in a
1659 /// previous definition); for that information, use isDefined. Note
1660 /// that this returns false for a defaulted function unless that function
1661 /// has been implicitly defined (possibly as deleted).
1662 bool isThisDeclarationADefinition() const {
1663 return IsDeleted || Body || IsLateTemplateParsed;
1666 /// doesThisDeclarationHaveABody - Returns whether this specific
1667 /// declaration of the function has a body - that is, if it is a non-
1668 /// deleted definition.
1669 bool doesThisDeclarationHaveABody() const {
1670 return Body || IsLateTemplateParsed;
1673 void setBody(Stmt *B);
1674 void setLazyBody(uint64_t Offset) { Body = Offset; }
1676 /// Whether this function is variadic.
1677 bool isVariadic() const;
1679 /// Whether this function is marked as virtual explicitly.
1680 bool isVirtualAsWritten() const { return IsVirtualAsWritten; }
1681 void setVirtualAsWritten(bool V) { IsVirtualAsWritten = V; }
1683 /// Whether this virtual function is pure, i.e. makes the containing class
1685 bool isPure() const { return IsPure; }
1686 void setPure(bool P = true);
1688 /// Whether this templated function will be late parsed.
1689 bool isLateTemplateParsed() const { return IsLateTemplateParsed; }
1690 void setLateTemplateParsed(bool ILT = true) { IsLateTemplateParsed = ILT; }
1692 /// Whether this function is "trivial" in some specialized C++ senses.
1693 /// Can only be true for default constructors, copy constructors,
1694 /// copy assignment operators, and destructors. Not meaningful until
1695 /// the class has been fully built by Sema.
1696 bool isTrivial() const { return IsTrivial; }
1697 void setTrivial(bool IT) { IsTrivial = IT; }
1699 /// Whether this function is defaulted per C++0x. Only valid for
1700 /// special member functions.
1701 bool isDefaulted() const { return IsDefaulted; }
1702 void setDefaulted(bool D = true) { IsDefaulted = D; }
1704 /// Whether this function is explicitly defaulted per C++0x. Only valid
1705 /// for special member functions.
1706 bool isExplicitlyDefaulted() const { return IsExplicitlyDefaulted; }
1707 void setExplicitlyDefaulted(bool ED = true) { IsExplicitlyDefaulted = ED; }
1709 /// Whether falling off this function implicitly returns null/zero.
1710 /// If a more specific implicit return value is required, front-ends
1711 /// should synthesize the appropriate return statements.
1712 bool hasImplicitReturnZero() const { return HasImplicitReturnZero; }
1713 void setHasImplicitReturnZero(bool IRZ) { HasImplicitReturnZero = IRZ; }
1715 /// \brief Whether this function has a prototype, either because one
1716 /// was explicitly written or because it was "inherited" by merging
1717 /// a declaration without a prototype with a declaration that has a
1719 bool hasPrototype() const {
1720 return HasWrittenPrototype || HasInheritedPrototype;
1723 bool hasWrittenPrototype() const { return HasWrittenPrototype; }
1725 /// \brief Whether this function inherited its prototype from a
1726 /// previous declaration.
1727 bool hasInheritedPrototype() const { return HasInheritedPrototype; }
1728 void setHasInheritedPrototype(bool P = true) { HasInheritedPrototype = P; }
1730 /// Whether this is a (C++11) constexpr function or constexpr constructor.
1731 bool isConstexpr() const { return IsConstexpr; }
1732 void setConstexpr(bool IC) { IsConstexpr = IC; }
1734 /// \brief Whether this function has been deleted.
1736 /// A function that is "deleted" (via the C++0x "= delete" syntax)
1737 /// acts like a normal function, except that it cannot actually be
1738 /// called or have its address taken. Deleted functions are
1739 /// typically used in C++ overload resolution to attract arguments
1740 /// whose type or lvalue/rvalue-ness would permit the use of a
1741 /// different overload that would behave incorrectly. For example,
1742 /// one might use deleted functions to ban implicit conversion from
1743 /// a floating-point number to an Integer type:
1746 /// struct Integer {
1747 /// Integer(long); // construct from a long
1748 /// Integer(double) = delete; // no construction from float or double
1749 /// Integer(long double) = delete; // no construction from long double
1752 // If a function is deleted, its first declaration must be.
1753 bool isDeleted() const { return getCanonicalDecl()->IsDeleted; }
1754 bool isDeletedAsWritten() const { return IsDeleted && !IsDefaulted; }
1755 void setDeletedAsWritten(bool D = true) { IsDeleted = D; }
1757 /// \brief Determines whether this function is "main", which is the
1758 /// entry point into an executable program.
1759 bool isMain() const;
1761 /// \brief Determines whether this function is a MSVCRT user defined entry
1763 bool isMSVCRTEntryPoint() const;
1765 /// \brief Determines whether this operator new or delete is one
1766 /// of the reserved global placement operators:
1767 /// void *operator new(size_t, void *);
1768 /// void *operator new[](size_t, void *);
1769 /// void operator delete(void *, void *);
1770 /// void operator delete[](void *, void *);
1771 /// These functions have special behavior under [new.delete.placement]:
1772 /// These functions are reserved, a C++ program may not define
1773 /// functions that displace the versions in the Standard C++ library.
1774 /// The provisions of [basic.stc.dynamic] do not apply to these
1775 /// reserved placement forms of operator new and operator delete.
1777 /// This function must be an allocation or deallocation function.
1778 bool isReservedGlobalPlacementOperator() const;
1780 /// \brief Determines whether this function is one of the replaceable
1781 /// global allocation functions:
1782 /// void *operator new(size_t);
1783 /// void *operator new(size_t, const std::nothrow_t &) noexcept;
1784 /// void *operator new[](size_t);
1785 /// void *operator new[](size_t, const std::nothrow_t &) noexcept;
1786 /// void operator delete(void *) noexcept;
1787 /// void operator delete(void *, std::size_t) noexcept; [C++1y]
1788 /// void operator delete(void *, const std::nothrow_t &) noexcept;
1789 /// void operator delete[](void *) noexcept;
1790 /// void operator delete[](void *, std::size_t) noexcept; [C++1y]
1791 /// void operator delete[](void *, const std::nothrow_t &) noexcept;
1792 /// These functions have special behavior under C++1y [expr.new]:
1793 /// An implementation is allowed to omit a call to a replaceable global
1794 /// allocation function. [...]
1795 bool isReplaceableGlobalAllocationFunction() const;
1797 /// \brief Determine whether this function is a sized global deallocation
1798 /// function in C++1y. If so, find and return the corresponding unsized
1799 /// deallocation function.
1800 FunctionDecl *getCorrespondingUnsizedGlobalDeallocationFunction() const;
1802 /// Compute the language linkage.
1803 LanguageLinkage getLanguageLinkage() const;
1805 /// \brief Determines whether this function is a function with
1806 /// external, C linkage.
1807 bool isExternC() const;
1809 /// \brief Determines whether this function's context is, or is nested within,
1810 /// a C++ extern "C" linkage spec.
1811 bool isInExternCContext() const;
1813 /// \brief Determines whether this function's context is, or is nested within,
1814 /// a C++ extern "C++" linkage spec.
1815 bool isInExternCXXContext() const;
1817 /// \brief Determines whether this is a global function.
1818 bool isGlobal() const;
1820 /// \brief Determines whether this function is known to be 'noreturn', through
1821 /// an attribute on its declaration or its type.
1822 bool isNoReturn() const;
1824 /// \brief True if the function was a definition but its body was skipped.
1825 bool hasSkippedBody() const { return HasSkippedBody; }
1826 void setHasSkippedBody(bool Skipped = true) { HasSkippedBody = Skipped; }
1828 void setPreviousDeclaration(FunctionDecl * PrevDecl);
1830 virtual const FunctionDecl *getCanonicalDecl() const;
1831 virtual FunctionDecl *getCanonicalDecl();
1833 unsigned getBuiltinID() const;
1835 // Iterator access to formal parameters.
1836 unsigned param_size() const { return getNumParams(); }
1837 typedef ParmVarDecl **param_iterator;
1838 typedef ParmVarDecl * const *param_const_iterator;
1840 param_iterator param_begin() { return ParamInfo; }
1841 param_iterator param_end() { return ParamInfo+param_size(); }
1843 param_const_iterator param_begin() const { return ParamInfo; }
1844 param_const_iterator param_end() const { return ParamInfo+param_size(); }
1846 /// getNumParams - Return the number of parameters this function must have
1847 /// based on its FunctionType. This is the length of the ParamInfo array
1848 /// after it has been created.
1849 unsigned getNumParams() const;
1851 const ParmVarDecl *getParamDecl(unsigned i) const {
1852 assert(i < getNumParams() && "Illegal param #");
1853 return ParamInfo[i];
1855 ParmVarDecl *getParamDecl(unsigned i) {
1856 assert(i < getNumParams() && "Illegal param #");
1857 return ParamInfo[i];
1859 void setParams(ArrayRef<ParmVarDecl *> NewParamInfo) {
1860 setParams(getASTContext(), NewParamInfo);
1863 const ArrayRef<NamedDecl *> &getDeclsInPrototypeScope() const {
1864 return DeclsInPrototypeScope;
1866 void setDeclsInPrototypeScope(ArrayRef<NamedDecl *> NewDecls);
1868 /// getMinRequiredArguments - Returns the minimum number of arguments
1869 /// needed to call this function. This may be fewer than the number of
1870 /// function parameters, if some of the parameters have default
1871 /// arguments (in C++).
1872 unsigned getMinRequiredArguments() const;
1874 QualType getResultType() const {
1875 return getType()->getAs<FunctionType>()->getResultType();
1878 /// \brief Determine the type of an expression that calls this function.
1879 QualType getCallResultType() const {
1880 return getType()->getAs<FunctionType>()->getCallResultType(getASTContext());
1883 /// \brief Returns the storage class as written in the source. For the
1884 /// computed linkage of symbol, see getLinkage.
1885 StorageClass getStorageClass() const { return StorageClass(SClass); }
1887 /// \brief Determine whether the "inline" keyword was specified for this
1889 bool isInlineSpecified() const { return IsInlineSpecified; }
1891 /// Set whether the "inline" keyword was specified for this function.
1892 void setInlineSpecified(bool I) {
1893 IsInlineSpecified = I;
1897 /// Flag that this function is implicitly inline.
1898 void setImplicitlyInline() {
1902 /// \brief Determine whether this function should be inlined, because it is
1903 /// either marked "inline" or "constexpr" or is a member function of a class
1904 /// that was defined in the class body.
1905 bool isInlined() const { return IsInline; }
1907 bool isInlineDefinitionExternallyVisible() const;
1909 bool doesDeclarationForceExternallyVisibleDefinition() const;
1911 /// isOverloadedOperator - Whether this function declaration
1912 /// represents an C++ overloaded operator, e.g., "operator+".
1913 bool isOverloadedOperator() const {
1914 return getOverloadedOperator() != OO_None;
1917 OverloadedOperatorKind getOverloadedOperator() const;
1919 const IdentifierInfo *getLiteralIdentifier() const;
1921 /// \brief If this function is an instantiation of a member function
1922 /// of a class template specialization, retrieves the function from
1923 /// which it was instantiated.
1925 /// This routine will return non-NULL for (non-templated) member
1926 /// functions of class templates and for instantiations of function
1927 /// templates. For example, given:
1930 /// template<typename T>
1936 /// The declaration for X<int>::f is a (non-templated) FunctionDecl
1937 /// whose parent is the class template specialization X<int>. For
1938 /// this declaration, getInstantiatedFromFunction() will return
1939 /// the FunctionDecl X<T>::A. When a complete definition of
1940 /// X<int>::A is required, it will be instantiated from the
1941 /// declaration returned by getInstantiatedFromMemberFunction().
1942 FunctionDecl *getInstantiatedFromMemberFunction() const;
1944 /// \brief What kind of templated function this is.
1945 TemplatedKind getTemplatedKind() const;
1947 /// \brief If this function is an instantiation of a member function of a
1948 /// class template specialization, retrieves the member specialization
1950 MemberSpecializationInfo *getMemberSpecializationInfo() const {
1951 return TemplateOrSpecialization.dyn_cast<MemberSpecializationInfo*>();
1954 /// \brief Specify that this record is an instantiation of the
1955 /// member function FD.
1956 void setInstantiationOfMemberFunction(FunctionDecl *FD,
1957 TemplateSpecializationKind TSK) {
1958 setInstantiationOfMemberFunction(getASTContext(), FD, TSK);
1961 /// \brief Retrieves the function template that is described by this
1962 /// function declaration.
1964 /// Every function template is represented as a FunctionTemplateDecl
1965 /// and a FunctionDecl (or something derived from FunctionDecl). The
1966 /// former contains template properties (such as the template
1967 /// parameter lists) while the latter contains the actual
1968 /// description of the template's
1969 /// contents. FunctionTemplateDecl::getTemplatedDecl() retrieves the
1970 /// FunctionDecl that describes the function template,
1971 /// getDescribedFunctionTemplate() retrieves the
1972 /// FunctionTemplateDecl from a FunctionDecl.
1973 FunctionTemplateDecl *getDescribedFunctionTemplate() const {
1974 return TemplateOrSpecialization.dyn_cast<FunctionTemplateDecl*>();
1977 void setDescribedFunctionTemplate(FunctionTemplateDecl *Template) {
1978 TemplateOrSpecialization = Template;
1981 /// \brief Determine whether this function is a function template
1983 bool isFunctionTemplateSpecialization() const {
1984 return getPrimaryTemplate() != 0;
1987 /// \brief Retrieve the class scope template pattern that this function
1988 /// template specialization is instantiated from.
1989 FunctionDecl *getClassScopeSpecializationPattern() const;
1991 /// \brief If this function is actually a function template specialization,
1992 /// retrieve information about this function template specialization.
1993 /// Otherwise, returns NULL.
1994 FunctionTemplateSpecializationInfo *getTemplateSpecializationInfo() const {
1995 return TemplateOrSpecialization.
1996 dyn_cast<FunctionTemplateSpecializationInfo*>();
1999 /// \brief Determines whether this function is a function template
2000 /// specialization or a member of a class template specialization that can
2001 /// be implicitly instantiated.
2002 bool isImplicitlyInstantiable() const;
2004 /// \brief Determines if the given function was instantiated from a
2005 /// function template.
2006 bool isTemplateInstantiation() const;
2008 /// \brief Retrieve the function declaration from which this function could
2009 /// be instantiated, if it is an instantiation (rather than a non-template
2010 /// or a specialization, for example).
2011 FunctionDecl *getTemplateInstantiationPattern() const;
2013 /// \brief Retrieve the primary template that this function template
2014 /// specialization either specializes or was instantiated from.
2016 /// If this function declaration is not a function template specialization,
2018 FunctionTemplateDecl *getPrimaryTemplate() const;
2020 /// \brief Retrieve the template arguments used to produce this function
2021 /// template specialization from the primary template.
2023 /// If this function declaration is not a function template specialization,
2025 const TemplateArgumentList *getTemplateSpecializationArgs() const;
2027 /// \brief Retrieve the template argument list as written in the sources,
2030 /// If this function declaration is not a function template specialization
2031 /// or if it had no explicit template argument list, returns NULL.
2032 /// Note that it an explicit template argument list may be written empty,
2033 /// e.g., template<> void foo<>(char* s);
2034 const ASTTemplateArgumentListInfo*
2035 getTemplateSpecializationArgsAsWritten() const;
2037 /// \brief Specify that this function declaration is actually a function
2038 /// template specialization.
2040 /// \param Template the function template that this function template
2041 /// specialization specializes.
2043 /// \param TemplateArgs the template arguments that produced this
2044 /// function template specialization from the template.
2046 /// \param InsertPos If non-NULL, the position in the function template
2047 /// specialization set where the function template specialization data will
2050 /// \param TSK the kind of template specialization this is.
2052 /// \param TemplateArgsAsWritten location info of template arguments.
2054 /// \param PointOfInstantiation point at which the function template
2055 /// specialization was first instantiated.
2056 void setFunctionTemplateSpecialization(FunctionTemplateDecl *Template,
2057 const TemplateArgumentList *TemplateArgs,
2059 TemplateSpecializationKind TSK = TSK_ImplicitInstantiation,
2060 const TemplateArgumentListInfo *TemplateArgsAsWritten = 0,
2061 SourceLocation PointOfInstantiation = SourceLocation()) {
2062 setFunctionTemplateSpecialization(getASTContext(), Template, TemplateArgs,
2063 InsertPos, TSK, TemplateArgsAsWritten,
2064 PointOfInstantiation);
2067 /// \brief Specifies that this function declaration is actually a
2068 /// dependent function template specialization.
2069 void setDependentTemplateSpecialization(ASTContext &Context,
2070 const UnresolvedSetImpl &Templates,
2071 const TemplateArgumentListInfo &TemplateArgs);
2073 DependentFunctionTemplateSpecializationInfo *
2074 getDependentSpecializationInfo() const {
2075 return TemplateOrSpecialization.
2076 dyn_cast<DependentFunctionTemplateSpecializationInfo*>();
2079 /// \brief Determine what kind of template instantiation this function
2081 TemplateSpecializationKind getTemplateSpecializationKind() const;
2083 /// \brief Determine what kind of template instantiation this function
2085 void setTemplateSpecializationKind(TemplateSpecializationKind TSK,
2086 SourceLocation PointOfInstantiation = SourceLocation());
2088 /// \brief Retrieve the (first) point of instantiation of a function template
2089 /// specialization or a member of a class template specialization.
2091 /// \returns the first point of instantiation, if this function was
2092 /// instantiated from a template; otherwise, returns an invalid source
2094 SourceLocation getPointOfInstantiation() const;
2096 /// \brief Determine whether this is or was instantiated from an out-of-line
2097 /// definition of a member function.
2098 virtual bool isOutOfLine() const;
2100 /// \brief Identify a memory copying or setting function.
2101 /// If the given function is a memory copy or setting function, returns
2102 /// the corresponding Builtin ID. If the function is not a memory function,
2104 unsigned getMemoryFunctionKind() const;
2106 // Implement isa/cast/dyncast/etc.
2107 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2108 static bool classofKind(Kind K) {
2109 return K >= firstFunction && K <= lastFunction;
2111 static DeclContext *castToDeclContext(const FunctionDecl *D) {
2112 return static_cast<DeclContext *>(const_cast<FunctionDecl*>(D));
2114 static FunctionDecl *castFromDeclContext(const DeclContext *DC) {
2115 return static_cast<FunctionDecl *>(const_cast<DeclContext*>(DC));
2118 friend class ASTDeclReader;
2119 friend class ASTDeclWriter;
2123 /// FieldDecl - An instance of this class is created by Sema::ActOnField to
2124 /// represent a member of a struct/union/class.
2125 class FieldDecl : public DeclaratorDecl, public Mergeable<FieldDecl> {
2126 // FIXME: This can be packed into the bitfields in Decl.
2128 mutable unsigned CachedFieldIndex : 31;
2130 /// \brief An InClassInitStyle value, and either a bit width expression (if
2131 /// the InClassInitStyle value is ICIS_NoInit), or a pointer to the in-class
2132 /// initializer for this field (otherwise).
2134 /// We can safely combine these two because in-class initializers are not
2135 /// permitted for bit-fields.
2137 /// If the InClassInitStyle is not ICIS_NoInit and the initializer is null,
2138 /// then this field has an in-class initializer which has not yet been parsed
2140 llvm::PointerIntPair<Expr *, 2, unsigned> InitializerOrBitWidth;
2142 FieldDecl(Kind DK, DeclContext *DC, SourceLocation StartLoc,
2143 SourceLocation IdLoc, IdentifierInfo *Id,
2144 QualType T, TypeSourceInfo *TInfo, Expr *BW, bool Mutable,
2145 InClassInitStyle InitStyle)
2146 : DeclaratorDecl(DK, DC, IdLoc, Id, T, TInfo, StartLoc),
2147 Mutable(Mutable), CachedFieldIndex(0),
2148 InitializerOrBitWidth(BW, InitStyle) {
2149 assert((!BW || InitStyle == ICIS_NoInit) && "got initializer for bitfield");
2153 static FieldDecl *Create(const ASTContext &C, DeclContext *DC,
2154 SourceLocation StartLoc, SourceLocation IdLoc,
2155 IdentifierInfo *Id, QualType T,
2156 TypeSourceInfo *TInfo, Expr *BW, bool Mutable,
2157 InClassInitStyle InitStyle);
2159 static FieldDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2161 /// getFieldIndex - Returns the index of this field within its record,
2162 /// as appropriate for passing to ASTRecordLayout::getFieldOffset.
2163 unsigned getFieldIndex() const;
2165 /// isMutable - Determines whether this field is mutable (C++ only).
2166 bool isMutable() const { return Mutable; }
2168 /// isBitfield - Determines whether this field is a bitfield.
2169 bool isBitField() const {
2170 return getInClassInitStyle() == ICIS_NoInit &&
2171 InitializerOrBitWidth.getPointer();
2174 /// @brief Determines whether this is an unnamed bitfield.
2175 bool isUnnamedBitfield() const { return isBitField() && !getDeclName(); }
2177 /// isAnonymousStructOrUnion - Determines whether this field is a
2178 /// representative for an anonymous struct or union. Such fields are
2179 /// unnamed and are implicitly generated by the implementation to
2180 /// store the data for the anonymous union or struct.
2181 bool isAnonymousStructOrUnion() const;
2183 Expr *getBitWidth() const {
2184 return isBitField() ? InitializerOrBitWidth.getPointer() : 0;
2186 unsigned getBitWidthValue(const ASTContext &Ctx) const;
2188 /// setBitWidth - Set the bit-field width for this member.
2189 // Note: used by some clients (i.e., do not remove it).
2190 void setBitWidth(Expr *Width);
2191 /// removeBitWidth - Remove the bit-field width from this member.
2192 // Note: used by some clients (i.e., do not remove it).
2193 void removeBitWidth() {
2194 assert(isBitField() && "no bitfield width to remove");
2195 InitializerOrBitWidth.setPointer(0);
2198 /// getInClassInitStyle - Get the kind of (C++11) in-class initializer which
2200 InClassInitStyle getInClassInitStyle() const {
2201 return static_cast<InClassInitStyle>(InitializerOrBitWidth.getInt());
2204 /// hasInClassInitializer - Determine whether this member has a C++11 in-class
2206 bool hasInClassInitializer() const {
2207 return getInClassInitStyle() != ICIS_NoInit;
2209 /// getInClassInitializer - Get the C++11 in-class initializer for this
2210 /// member, or null if one has not been set. If a valid declaration has an
2211 /// in-class initializer, but this returns null, then we have not parsed and
2212 /// attached it yet.
2213 Expr *getInClassInitializer() const {
2214 return hasInClassInitializer() ? InitializerOrBitWidth.getPointer() : 0;
2216 /// setInClassInitializer - Set the C++11 in-class initializer for this
2218 void setInClassInitializer(Expr *Init);
2219 /// removeInClassInitializer - Remove the C++11 in-class initializer from this
2221 void removeInClassInitializer() {
2222 assert(hasInClassInitializer() && "no initializer to remove");
2223 InitializerOrBitWidth.setPointer(0);
2224 InitializerOrBitWidth.setInt(ICIS_NoInit);
2227 /// getParent - Returns the parent of this field declaration, which
2228 /// is the struct in which this method is defined.
2229 const RecordDecl *getParent() const {
2230 return cast<RecordDecl>(getDeclContext());
2233 RecordDecl *getParent() {
2234 return cast<RecordDecl>(getDeclContext());
2237 SourceRange getSourceRange() const LLVM_READONLY;
2239 /// Retrieves the canonical declaration of this field.
2240 FieldDecl *getCanonicalDecl() { return getFirstDecl(); }
2241 const FieldDecl *getCanonicalDecl() const { return getFirstDecl(); }
2243 // Implement isa/cast/dyncast/etc.
2244 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2245 static bool classofKind(Kind K) { return K >= firstField && K <= lastField; }
2247 friend class ASTDeclReader;
2248 friend class ASTDeclWriter;
2251 /// EnumConstantDecl - An instance of this object exists for each enum constant
2252 /// that is defined. For example, in "enum X {a,b}", each of a/b are
2253 /// EnumConstantDecl's, X is an instance of EnumDecl, and the type of a/b is a
2254 /// TagType for the X EnumDecl.
2255 class EnumConstantDecl : public ValueDecl, public Mergeable<EnumConstantDecl> {
2256 Stmt *Init; // an integer constant expression
2257 llvm::APSInt Val; // The value.
2259 EnumConstantDecl(DeclContext *DC, SourceLocation L,
2260 IdentifierInfo *Id, QualType T, Expr *E,
2261 const llvm::APSInt &V)
2262 : ValueDecl(EnumConstant, DC, L, Id, T), Init((Stmt*)E), Val(V) {}
2266 static EnumConstantDecl *Create(ASTContext &C, EnumDecl *DC,
2267 SourceLocation L, IdentifierInfo *Id,
2268 QualType T, Expr *E,
2269 const llvm::APSInt &V);
2270 static EnumConstantDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2272 const Expr *getInitExpr() const { return (const Expr*) Init; }
2273 Expr *getInitExpr() { return (Expr*) Init; }
2274 const llvm::APSInt &getInitVal() const { return Val; }
2276 void setInitExpr(Expr *E) { Init = (Stmt*) E; }
2277 void setInitVal(const llvm::APSInt &V) { Val = V; }
2279 SourceRange getSourceRange() const LLVM_READONLY;
2281 /// Retrieves the canonical declaration of this enumerator.
2282 EnumConstantDecl *getCanonicalDecl() { return getFirstDecl(); }
2283 const EnumConstantDecl *getCanonicalDecl() const { return getFirstDecl(); }
2285 // Implement isa/cast/dyncast/etc.
2286 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2287 static bool classofKind(Kind K) { return K == EnumConstant; }
2289 friend class StmtIteratorBase;
2292 /// IndirectFieldDecl - An instance of this class is created to represent a
2293 /// field injected from an anonymous union/struct into the parent scope.
2294 /// IndirectFieldDecl are always implicit.
2295 class IndirectFieldDecl : public ValueDecl {
2296 virtual void anchor();
2297 NamedDecl **Chaining;
2298 unsigned ChainingSize;
2300 IndirectFieldDecl(DeclContext *DC, SourceLocation L,
2301 DeclarationName N, QualType T,
2302 NamedDecl **CH, unsigned CHS)
2303 : ValueDecl(IndirectField, DC, L, N, T), Chaining(CH), ChainingSize(CHS) {}
2306 static IndirectFieldDecl *Create(ASTContext &C, DeclContext *DC,
2307 SourceLocation L, IdentifierInfo *Id,
2308 QualType T, NamedDecl **CH, unsigned CHS);
2310 static IndirectFieldDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2312 typedef NamedDecl * const *chain_iterator;
2313 chain_iterator chain_begin() const { return Chaining; }
2314 chain_iterator chain_end() const { return Chaining+ChainingSize; }
2316 unsigned getChainingSize() const { return ChainingSize; }
2318 FieldDecl *getAnonField() const {
2319 assert(ChainingSize >= 2);
2320 return cast<FieldDecl>(Chaining[ChainingSize - 1]);
2323 VarDecl *getVarDecl() const {
2324 assert(ChainingSize >= 2);
2325 return dyn_cast<VarDecl>(*chain_begin());
2328 // Implement isa/cast/dyncast/etc.
2329 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2330 static bool classofKind(Kind K) { return K == IndirectField; }
2331 friend class ASTDeclReader;
2334 /// TypeDecl - Represents a declaration of a type.
2336 class TypeDecl : public NamedDecl {
2337 virtual void anchor();
2338 /// TypeForDecl - This indicates the Type object that represents
2339 /// this TypeDecl. It is a cache maintained by
2340 /// ASTContext::getTypedefType, ASTContext::getTagDeclType, and
2341 /// ASTContext::getTemplateTypeParmType, and TemplateTypeParmDecl.
2342 mutable const Type *TypeForDecl;
2343 /// LocStart - The start of the source range for this declaration.
2344 SourceLocation LocStart;
2345 friend class ASTContext;
2346 friend class DeclContext;
2347 friend class TagDecl;
2348 friend class TemplateTypeParmDecl;
2349 friend class TagType;
2350 friend class ASTReader;
2353 TypeDecl(Kind DK, DeclContext *DC, SourceLocation L, IdentifierInfo *Id,
2354 SourceLocation StartL = SourceLocation())
2355 : NamedDecl(DK, DC, L, Id), TypeForDecl(0), LocStart(StartL) {}
2358 // Low-level accessor. If you just want the type defined by this node,
2359 // check out ASTContext::getTypeDeclType or one of
2360 // ASTContext::getTypedefType, ASTContext::getRecordType, etc. if you
2361 // already know the specific kind of node this is.
2362 const Type *getTypeForDecl() const { return TypeForDecl; }
2363 void setTypeForDecl(const Type *TD) { TypeForDecl = TD; }
2365 SourceLocation getLocStart() const LLVM_READONLY { return LocStart; }
2366 void setLocStart(SourceLocation L) { LocStart = L; }
2367 virtual SourceRange getSourceRange() const LLVM_READONLY {
2368 if (LocStart.isValid())
2369 return SourceRange(LocStart, getLocation());
2371 return SourceRange(getLocation());
2374 // Implement isa/cast/dyncast/etc.
2375 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2376 static bool classofKind(Kind K) { return K >= firstType && K <= lastType; }
2380 /// Base class for declarations which introduce a typedef-name.
2381 class TypedefNameDecl : public TypeDecl, public Redeclarable<TypedefNameDecl> {
2382 virtual void anchor();
2383 typedef std::pair<TypeSourceInfo*, QualType> ModedTInfo;
2384 llvm::PointerUnion<TypeSourceInfo*, ModedTInfo*> MaybeModedTInfo;
2387 TypedefNameDecl(Kind DK, DeclContext *DC, SourceLocation StartLoc,
2388 SourceLocation IdLoc, IdentifierInfo *Id,
2389 TypeSourceInfo *TInfo)
2390 : TypeDecl(DK, DC, IdLoc, Id, StartLoc), MaybeModedTInfo(TInfo) {}
2392 typedef Redeclarable<TypedefNameDecl> redeclarable_base;
2393 virtual TypedefNameDecl *getNextRedeclaration() {
2394 return RedeclLink.getNext();
2396 virtual TypedefNameDecl *getPreviousDeclImpl() {
2397 return getPreviousDecl();
2399 virtual TypedefNameDecl *getMostRecentDeclImpl() {
2400 return getMostRecentDecl();
2404 typedef redeclarable_base::redecl_iterator redecl_iterator;
2405 using redeclarable_base::redecls_begin;
2406 using redeclarable_base::redecls_end;
2407 using redeclarable_base::getPreviousDecl;
2408 using redeclarable_base::getMostRecentDecl;
2409 using redeclarable_base::isFirstDecl;
2411 bool isModed() const { return MaybeModedTInfo.is<ModedTInfo*>(); }
2413 TypeSourceInfo *getTypeSourceInfo() const {
2415 ? MaybeModedTInfo.get<ModedTInfo*>()->first
2416 : MaybeModedTInfo.get<TypeSourceInfo*>();
2418 QualType getUnderlyingType() const {
2420 ? MaybeModedTInfo.get<ModedTInfo*>()->second
2421 : MaybeModedTInfo.get<TypeSourceInfo*>()->getType();
2423 void setTypeSourceInfo(TypeSourceInfo *newType) {
2424 MaybeModedTInfo = newType;
2426 void setModedTypeSourceInfo(TypeSourceInfo *unmodedTSI, QualType modedTy) {
2427 MaybeModedTInfo = new (getASTContext()) ModedTInfo(unmodedTSI, modedTy);
2430 /// Retrieves the canonical declaration of this typedef-name.
2431 TypedefNameDecl *getCanonicalDecl() { return getFirstDecl(); }
2432 const TypedefNameDecl *getCanonicalDecl() const { return getFirstDecl(); }
2434 // Implement isa/cast/dyncast/etc.
2435 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2436 static bool classofKind(Kind K) {
2437 return K >= firstTypedefName && K <= lastTypedefName;
2441 /// TypedefDecl - Represents the declaration of a typedef-name via the 'typedef'
2443 class TypedefDecl : public TypedefNameDecl {
2444 TypedefDecl(DeclContext *DC, SourceLocation StartLoc, SourceLocation IdLoc,
2445 IdentifierInfo *Id, TypeSourceInfo *TInfo)
2446 : TypedefNameDecl(Typedef, DC, StartLoc, IdLoc, Id, TInfo) {}
2449 static TypedefDecl *Create(ASTContext &C, DeclContext *DC,
2450 SourceLocation StartLoc, SourceLocation IdLoc,
2451 IdentifierInfo *Id, TypeSourceInfo *TInfo);
2452 static TypedefDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2454 SourceRange getSourceRange() const LLVM_READONLY;
2456 // Implement isa/cast/dyncast/etc.
2457 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2458 static bool classofKind(Kind K) { return K == Typedef; }
2461 /// TypeAliasDecl - Represents the declaration of a typedef-name via a C++0x
2462 /// alias-declaration.
2463 class TypeAliasDecl : public TypedefNameDecl {
2464 TypeAliasDecl(DeclContext *DC, SourceLocation StartLoc, SourceLocation IdLoc,
2465 IdentifierInfo *Id, TypeSourceInfo *TInfo)
2466 : TypedefNameDecl(TypeAlias, DC, StartLoc, IdLoc, Id, TInfo) {}
2469 static TypeAliasDecl *Create(ASTContext &C, DeclContext *DC,
2470 SourceLocation StartLoc, SourceLocation IdLoc,
2471 IdentifierInfo *Id, TypeSourceInfo *TInfo);
2472 static TypeAliasDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2474 SourceRange getSourceRange() const LLVM_READONLY;
2476 // Implement isa/cast/dyncast/etc.
2477 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2478 static bool classofKind(Kind K) { return K == TypeAlias; }
2481 /// TagDecl - Represents the declaration of a struct/union/class/enum.
2483 : public TypeDecl, public DeclContext, public Redeclarable<TagDecl> {
2485 // This is really ugly.
2486 typedef TagTypeKind TagKind;
2489 // FIXME: This can be packed into the bitfields in Decl.
2490 /// TagDeclKind - The TagKind enum.
2491 unsigned TagDeclKind : 3;
2493 /// IsCompleteDefinition - True if this is a definition ("struct foo
2494 /// {};"), false if it is a declaration ("struct foo;"). It is not
2495 /// a definition until the definition has been fully processed.
2496 bool IsCompleteDefinition : 1;
2499 /// IsBeingDefined - True if this is currently being defined.
2500 bool IsBeingDefined : 1;
2503 /// IsEmbeddedInDeclarator - True if this tag declaration is
2504 /// "embedded" (i.e., defined or declared for the very first time)
2505 /// in the syntax of a declarator.
2506 bool IsEmbeddedInDeclarator : 1;
2508 /// \brief True if this tag is free standing, e.g. "struct foo;".
2509 bool IsFreeStanding : 1;
2512 // These are used by (and only defined for) EnumDecl.
2513 unsigned NumPositiveBits : 8;
2514 unsigned NumNegativeBits : 8;
2516 /// IsScoped - True if this tag declaration is a scoped enumeration. Only
2517 /// possible in C++11 mode.
2519 /// IsScopedUsingClassTag - If this tag declaration is a scoped enum,
2520 /// then this is true if the scoped enum was declared using the class
2521 /// tag, false if it was declared with the struct tag. No meaning is
2522 /// associated if this tag declaration is not a scoped enum.
2523 bool IsScopedUsingClassTag : 1;
2525 /// IsFixed - True if this is an enumeration with fixed underlying type. Only
2526 /// possible in C++11, Microsoft extensions, or Objective C mode.
2529 /// \brief Indicates whether it is possible for declarations of this kind
2530 /// to have an out-of-date definition.
2532 /// This option is only enabled when modules are enabled.
2533 bool MayHaveOutOfDateDef : 1;
2535 /// Has the full definition of this type been required by a use somewhere in
2537 bool IsCompleteDefinitionRequired : 1;
2539 SourceLocation RBraceLoc;
2541 // A struct representing syntactic qualifier info,
2542 // to be used for the (uncommon) case of out-of-line declarations.
2543 typedef QualifierInfo ExtInfo;
2545 /// \brief If the (out-of-line) tag declaration name
2546 /// is qualified, it points to the qualifier info (nns and range);
2547 /// otherwise, if the tag declaration is anonymous and it is part of
2548 /// a typedef or alias, it points to the TypedefNameDecl (used for mangling);
2549 /// otherwise, if the tag declaration is anonymous and it is used as a
2550 /// declaration specifier for variables, it points to the first VarDecl (used
2552 /// otherwise, it is a null (TypedefNameDecl) pointer.
2553 llvm::PointerUnion<NamedDecl *, ExtInfo *> NamedDeclOrQualifier;
2555 bool hasExtInfo() const { return NamedDeclOrQualifier.is<ExtInfo *>(); }
2556 ExtInfo *getExtInfo() { return NamedDeclOrQualifier.get<ExtInfo *>(); }
2557 const ExtInfo *getExtInfo() const {
2558 return NamedDeclOrQualifier.get<ExtInfo *>();
2562 TagDecl(Kind DK, TagKind TK, DeclContext *DC, SourceLocation L,
2563 IdentifierInfo *Id, TagDecl *PrevDecl, SourceLocation StartL)
2564 : TypeDecl(DK, DC, L, Id, StartL), DeclContext(DK), TagDeclKind(TK),
2565 IsCompleteDefinition(false), IsBeingDefined(false),
2566 IsEmbeddedInDeclarator(false), IsFreeStanding(false),
2567 IsCompleteDefinitionRequired(false),
2568 NamedDeclOrQualifier((NamedDecl *)0) {
2569 assert((DK != Enum || TK == TTK_Enum) &&
2570 "EnumDecl not matched with TTK_Enum");
2571 setPreviousDecl(PrevDecl);
2574 typedef Redeclarable<TagDecl> redeclarable_base;
2575 virtual TagDecl *getNextRedeclaration() { return RedeclLink.getNext(); }
2576 virtual TagDecl *getPreviousDeclImpl() {
2577 return getPreviousDecl();
2579 virtual TagDecl *getMostRecentDeclImpl() {
2580 return getMostRecentDecl();
2583 /// @brief Completes the definition of this tag declaration.
2585 /// This is a helper function for derived classes.
2586 void completeDefinition();
2589 typedef redeclarable_base::redecl_iterator redecl_iterator;
2590 using redeclarable_base::redecls_begin;
2591 using redeclarable_base::redecls_end;
2592 using redeclarable_base::getPreviousDecl;
2593 using redeclarable_base::getMostRecentDecl;
2594 using redeclarable_base::isFirstDecl;
2596 SourceLocation getRBraceLoc() const { return RBraceLoc; }
2597 void setRBraceLoc(SourceLocation L) { RBraceLoc = L; }
2599 /// getInnerLocStart - Return SourceLocation representing start of source
2600 /// range ignoring outer template declarations.
2601 SourceLocation getInnerLocStart() const { return getLocStart(); }
2603 /// getOuterLocStart - Return SourceLocation representing start of source
2604 /// range taking into account any outer template declarations.
2605 SourceLocation getOuterLocStart() const;
2606 virtual SourceRange getSourceRange() const LLVM_READONLY;
2608 virtual TagDecl* getCanonicalDecl();
2609 const TagDecl* getCanonicalDecl() const {
2610 return const_cast<TagDecl*>(this)->getCanonicalDecl();
2613 /// isThisDeclarationADefinition() - Return true if this declaration
2614 /// is a completion definintion of the type. Provided for consistency.
2615 bool isThisDeclarationADefinition() const {
2616 return isCompleteDefinition();
2619 /// isCompleteDefinition - Return true if this decl has its body
2620 /// fully specified.
2621 bool isCompleteDefinition() const {
2622 return IsCompleteDefinition;
2625 /// \brief Return true if this complete decl is
2626 /// required to be complete for some existing use.
2627 bool isCompleteDefinitionRequired() const {
2628 return IsCompleteDefinitionRequired;
2631 /// isBeingDefined - Return true if this decl is currently being defined.
2632 bool isBeingDefined() const {
2633 return IsBeingDefined;
2636 bool isEmbeddedInDeclarator() const {
2637 return IsEmbeddedInDeclarator;
2639 void setEmbeddedInDeclarator(bool isInDeclarator) {
2640 IsEmbeddedInDeclarator = isInDeclarator;
2643 bool isFreeStanding() const { return IsFreeStanding; }
2644 void setFreeStanding(bool isFreeStanding = true) {
2645 IsFreeStanding = isFreeStanding;
2648 /// \brief Whether this declaration declares a type that is
2649 /// dependent, i.e., a type that somehow depends on template
2651 bool isDependentType() const { return isDependentContext(); }
2653 /// @brief Starts the definition of this tag declaration.
2655 /// This method should be invoked at the beginning of the definition
2656 /// of this tag declaration. It will set the tag type into a state
2657 /// where it is in the process of being defined.
2658 void startDefinition();
2660 /// getDefinition - Returns the TagDecl that actually defines this
2661 /// struct/union/class/enum. When determining whether or not a
2662 /// struct/union/class/enum has a definition, one should use this
2663 /// method as opposed to 'isDefinition'. 'isDefinition' indicates
2664 /// whether or not a specific TagDecl is defining declaration, not
2665 /// whether or not the struct/union/class/enum type is defined.
2666 /// This method returns NULL if there is no TagDecl that defines
2667 /// the struct/union/class/enum.
2668 TagDecl *getDefinition() const;
2670 void setCompleteDefinition(bool V) { IsCompleteDefinition = V; }
2672 void setCompleteDefinitionRequired(bool V = true) {
2673 IsCompleteDefinitionRequired = V;
2676 // FIXME: Return StringRef;
2677 const char *getKindName() const {
2678 return TypeWithKeyword::getTagTypeKindName(getTagKind());
2681 TagKind getTagKind() const {
2682 return TagKind(TagDeclKind);
2685 void setTagKind(TagKind TK) { TagDeclKind = TK; }
2687 bool isStruct() const { return getTagKind() == TTK_Struct; }
2688 bool isInterface() const { return getTagKind() == TTK_Interface; }
2689 bool isClass() const { return getTagKind() == TTK_Class; }
2690 bool isUnion() const { return getTagKind() == TTK_Union; }
2691 bool isEnum() const { return getTagKind() == TTK_Enum; }
2693 /// Is this tag type named, either directly or via being defined in
2694 /// a typedef of this type?
2696 /// C++11 [basic.link]p8:
2697 /// A type is said to have linkage if and only if:
2698 /// - it is a class or enumeration type that is named (or has a
2699 /// name for linkage purposes) and the name has linkage; ...
2700 /// C++11 [dcl.typedef]p9:
2701 /// If the typedef declaration defines an unnamed class (or enum),
2702 /// the first typedef-name declared by the declaration to be that
2703 /// class type (or enum type) is used to denote the class type (or
2704 /// enum type) for linkage purposes only.
2706 /// C does not have an analogous rule, but the same concept is
2707 /// nonetheless useful in some places.
2708 bool hasNameForLinkage() const {
2709 return (getDeclName() || getTypedefNameForAnonDecl());
2712 bool hasDeclaratorForAnonDecl() const {
2713 return dyn_cast_or_null<DeclaratorDecl>(
2714 NamedDeclOrQualifier.get<NamedDecl *>());
2716 DeclaratorDecl *getDeclaratorForAnonDecl() const {
2717 return hasExtInfo() ? 0 : dyn_cast_or_null<DeclaratorDecl>(
2718 NamedDeclOrQualifier.get<NamedDecl *>());
2721 TypedefNameDecl *getTypedefNameForAnonDecl() const {
2722 return hasExtInfo() ? 0 : dyn_cast_or_null<TypedefNameDecl>(
2723 NamedDeclOrQualifier.get<NamedDecl *>());
2726 void setDeclaratorForAnonDecl(DeclaratorDecl *DD) { NamedDeclOrQualifier = DD; }
2728 void setTypedefNameForAnonDecl(TypedefNameDecl *TDD);
2730 /// \brief Retrieve the nested-name-specifier that qualifies the name of this
2731 /// declaration, if it was present in the source.
2732 NestedNameSpecifier *getQualifier() const {
2733 return hasExtInfo() ? getExtInfo()->QualifierLoc.getNestedNameSpecifier()
2737 /// \brief Retrieve the nested-name-specifier (with source-location
2738 /// information) that qualifies the name of this declaration, if it was
2739 /// present in the source.
2740 NestedNameSpecifierLoc getQualifierLoc() const {
2741 return hasExtInfo() ? getExtInfo()->QualifierLoc
2742 : NestedNameSpecifierLoc();
2745 void setQualifierInfo(NestedNameSpecifierLoc QualifierLoc);
2747 unsigned getNumTemplateParameterLists() const {
2748 return hasExtInfo() ? getExtInfo()->NumTemplParamLists : 0;
2750 TemplateParameterList *getTemplateParameterList(unsigned i) const {
2751 assert(i < getNumTemplateParameterLists());
2752 return getExtInfo()->TemplParamLists[i];
2754 void setTemplateParameterListsInfo(ASTContext &Context, unsigned NumTPLists,
2755 TemplateParameterList **TPLists);
2757 // Implement isa/cast/dyncast/etc.
2758 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2759 static bool classofKind(Kind K) { return K >= firstTag && K <= lastTag; }
2761 static DeclContext *castToDeclContext(const TagDecl *D) {
2762 return static_cast<DeclContext *>(const_cast<TagDecl*>(D));
2764 static TagDecl *castFromDeclContext(const DeclContext *DC) {
2765 return static_cast<TagDecl *>(const_cast<DeclContext*>(DC));
2768 friend class ASTDeclReader;
2769 friend class ASTDeclWriter;
2772 /// EnumDecl - Represents an enum. In C++11, enums can be forward-declared
2773 /// with a fixed underlying type, and in C we allow them to be forward-declared
2774 /// with no underlying type as an extension.
2775 class EnumDecl : public TagDecl {
2776 virtual void anchor();
2777 /// IntegerType - This represent the integer type that the enum corresponds
2778 /// to for code generation purposes. Note that the enumerator constants may
2779 /// have a different type than this does.
2781 /// If the underlying integer type was explicitly stated in the source
2782 /// code, this is a TypeSourceInfo* for that type. Otherwise this type
2783 /// was automatically deduced somehow, and this is a Type*.
2785 /// Normally if IsFixed(), this would contain a TypeSourceInfo*, but in
2786 /// some cases it won't.
2788 /// The underlying type of an enumeration never has any qualifiers, so
2789 /// we can get away with just storing a raw Type*, and thus save an
2790 /// extra pointer when TypeSourceInfo is needed.
2792 llvm::PointerUnion<const Type*, TypeSourceInfo*> IntegerType;
2794 /// PromotionType - The integer type that values of this type should
2795 /// promote to. In C, enumerators are generally of an integer type
2796 /// directly, but gcc-style large enumerators (and all enumerators
2797 /// in C++) are of the enum type instead.
2798 QualType PromotionType;
2800 /// \brief If this enumeration is an instantiation of a member enumeration
2801 /// of a class template specialization, this is the member specialization
2803 MemberSpecializationInfo *SpecializationInfo;
2805 EnumDecl(DeclContext *DC, SourceLocation StartLoc, SourceLocation IdLoc,
2806 IdentifierInfo *Id, EnumDecl *PrevDecl,
2807 bool Scoped, bool ScopedUsingClassTag, bool Fixed)
2808 : TagDecl(Enum, TTK_Enum, DC, IdLoc, Id, PrevDecl, StartLoc),
2809 SpecializationInfo(0) {
2810 assert(Scoped || !ScopedUsingClassTag);
2811 IntegerType = (const Type*)0;
2812 NumNegativeBits = 0;
2813 NumPositiveBits = 0;
2815 IsScopedUsingClassTag = ScopedUsingClassTag;
2819 void setInstantiationOfMemberEnum(ASTContext &C, EnumDecl *ED,
2820 TemplateSpecializationKind TSK);
2822 EnumDecl *getCanonicalDecl() {
2823 return cast<EnumDecl>(TagDecl::getCanonicalDecl());
2825 const EnumDecl *getCanonicalDecl() const {
2826 return const_cast<EnumDecl*>(this)->getCanonicalDecl();
2829 EnumDecl *getPreviousDecl() {
2830 return cast_or_null<EnumDecl>(
2831 static_cast<TagDecl *>(this)->getPreviousDecl());
2833 const EnumDecl *getPreviousDecl() const {
2834 return const_cast<EnumDecl*>(this)->getPreviousDecl();
2837 EnumDecl *getMostRecentDecl() {
2838 return cast<EnumDecl>(static_cast<TagDecl *>(this)->getMostRecentDecl());
2840 const EnumDecl *getMostRecentDecl() const {
2841 return const_cast<EnumDecl*>(this)->getMostRecentDecl();
2844 EnumDecl *getDefinition() const {
2845 return cast_or_null<EnumDecl>(TagDecl::getDefinition());
2848 static EnumDecl *Create(ASTContext &C, DeclContext *DC,
2849 SourceLocation StartLoc, SourceLocation IdLoc,
2850 IdentifierInfo *Id, EnumDecl *PrevDecl,
2851 bool IsScoped, bool IsScopedUsingClassTag,
2853 static EnumDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2855 /// completeDefinition - When created, the EnumDecl corresponds to a
2856 /// forward-declared enum. This method is used to mark the
2857 /// declaration as being defined; it's enumerators have already been
2858 /// added (via DeclContext::addDecl). NewType is the new underlying
2859 /// type of the enumeration type.
2860 void completeDefinition(QualType NewType,
2861 QualType PromotionType,
2862 unsigned NumPositiveBits,
2863 unsigned NumNegativeBits);
2865 // enumerator_iterator - Iterates through the enumerators of this
2867 typedef specific_decl_iterator<EnumConstantDecl> enumerator_iterator;
2869 enumerator_iterator enumerator_begin() const {
2870 const EnumDecl *E = getDefinition();
2873 return enumerator_iterator(E->decls_begin());
2876 enumerator_iterator enumerator_end() const {
2877 const EnumDecl *E = getDefinition();
2880 return enumerator_iterator(E->decls_end());
2883 /// getPromotionType - Return the integer type that enumerators
2884 /// should promote to.
2885 QualType getPromotionType() const { return PromotionType; }
2887 /// \brief Set the promotion type.
2888 void setPromotionType(QualType T) { PromotionType = T; }
2890 /// getIntegerType - Return the integer type this enum decl corresponds to.
2891 /// This returns a null qualtype for an enum forward definition.
2892 QualType getIntegerType() const {
2895 if (const Type* T = IntegerType.dyn_cast<const Type*>())
2896 return QualType(T, 0);
2897 return IntegerType.get<TypeSourceInfo*>()->getType();
2900 /// \brief Set the underlying integer type.
2901 void setIntegerType(QualType T) { IntegerType = T.getTypePtrOrNull(); }
2903 /// \brief Set the underlying integer type source info.
2904 void setIntegerTypeSourceInfo(TypeSourceInfo* TInfo) { IntegerType = TInfo; }
2906 /// \brief Return the type source info for the underlying integer type,
2907 /// if no type source info exists, return 0.
2908 TypeSourceInfo* getIntegerTypeSourceInfo() const {
2909 return IntegerType.dyn_cast<TypeSourceInfo*>();
2912 /// \brief Returns the width in bits required to store all the
2913 /// non-negative enumerators of this enum.
2914 unsigned getNumPositiveBits() const {
2915 return NumPositiveBits;
2917 void setNumPositiveBits(unsigned Num) {
2918 NumPositiveBits = Num;
2919 assert(NumPositiveBits == Num && "can't store this bitcount");
2922 /// \brief Returns the width in bits required to store all the
2923 /// negative enumerators of this enum. These widths include
2924 /// the rightmost leading 1; that is:
2926 /// MOST NEGATIVE ENUMERATOR PATTERN NUM NEGATIVE BITS
2927 /// ------------------------ ------- -----------------
2931 unsigned getNumNegativeBits() const {
2932 return NumNegativeBits;
2934 void setNumNegativeBits(unsigned Num) {
2935 NumNegativeBits = Num;
2938 /// \brief Returns true if this is a C++11 scoped enumeration.
2939 bool isScoped() const {
2943 /// \brief Returns true if this is a C++11 scoped enumeration.
2944 bool isScopedUsingClassTag() const {
2945 return IsScopedUsingClassTag;
2948 /// \brief Returns true if this is an Objective-C, C++11, or
2949 /// Microsoft-style enumeration with a fixed underlying type.
2950 bool isFixed() const {
2954 /// \brief Returns true if this can be considered a complete type.
2955 bool isComplete() const {
2956 return isCompleteDefinition() || isFixed();
2959 /// \brief Returns the enumeration (declared within the template)
2960 /// from which this enumeration type was instantiated, or NULL if
2961 /// this enumeration was not instantiated from any template.
2962 EnumDecl *getInstantiatedFromMemberEnum() const;
2964 /// \brief If this enumeration is a member of a specialization of a
2965 /// templated class, determine what kind of template specialization
2966 /// or instantiation this is.
2967 TemplateSpecializationKind getTemplateSpecializationKind() const;
2969 /// \brief For an enumeration member that was instantiated from a member
2970 /// enumeration of a templated class, set the template specialiation kind.
2971 void setTemplateSpecializationKind(TemplateSpecializationKind TSK,
2972 SourceLocation PointOfInstantiation = SourceLocation());
2974 /// \brief If this enumeration is an instantiation of a member enumeration of
2975 /// a class template specialization, retrieves the member specialization
2977 MemberSpecializationInfo *getMemberSpecializationInfo() const {
2978 return SpecializationInfo;
2981 /// \brief Specify that this enumeration is an instantiation of the
2982 /// member enumeration ED.
2983 void setInstantiationOfMemberEnum(EnumDecl *ED,
2984 TemplateSpecializationKind TSK) {
2985 setInstantiationOfMemberEnum(getASTContext(), ED, TSK);
2988 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2989 static bool classofKind(Kind K) { return K == Enum; }
2991 friend class ASTDeclReader;
2995 /// RecordDecl - Represents a struct/union/class. For example:
2996 /// struct X; // Forward declaration, no "body".
2997 /// union Y { int A, B; }; // Has body with members A and B (FieldDecls).
2998 /// This decl will be marked invalid if *any* members are invalid.
3000 class RecordDecl : public TagDecl {
3001 // FIXME: This can be packed into the bitfields in Decl.
3002 /// HasFlexibleArrayMember - This is true if this struct ends with a flexible
3003 /// array member (e.g. int X[]) or if this union contains a struct that does.
3004 /// If so, this cannot be contained in arrays or other structs as a member.
3005 bool HasFlexibleArrayMember : 1;
3007 /// AnonymousStructOrUnion - Whether this is the type of an anonymous struct
3009 bool AnonymousStructOrUnion : 1;
3011 /// HasObjectMember - This is true if this struct has at least one member
3012 /// containing an Objective-C object pointer type.
3013 bool HasObjectMember : 1;
3015 /// HasVolatileMember - This is true if struct has at least one member of
3016 /// 'volatile' type.
3017 bool HasVolatileMember : 1;
3019 /// \brief Whether the field declarations of this record have been loaded
3020 /// from external storage. To avoid unnecessary deserialization of
3021 /// methods/nested types we allow deserialization of just the fields
3023 mutable bool LoadedFieldsFromExternalStorage : 1;
3024 friend class DeclContext;
3027 RecordDecl(Kind DK, TagKind TK, DeclContext *DC,
3028 SourceLocation StartLoc, SourceLocation IdLoc,
3029 IdentifierInfo *Id, RecordDecl *PrevDecl);
3032 static RecordDecl *Create(const ASTContext &C, TagKind TK, DeclContext *DC,
3033 SourceLocation StartLoc, SourceLocation IdLoc,
3034 IdentifierInfo *Id, RecordDecl* PrevDecl = 0);
3035 static RecordDecl *CreateDeserialized(const ASTContext &C, unsigned ID);
3037 RecordDecl *getPreviousDecl() {
3038 return cast_or_null<RecordDecl>(
3039 static_cast<TagDecl *>(this)->getPreviousDecl());
3041 const RecordDecl *getPreviousDecl() const {
3042 return const_cast<RecordDecl*>(this)->getPreviousDecl();
3045 RecordDecl *getMostRecentDecl() {
3046 return cast<RecordDecl>(static_cast<TagDecl *>(this)->getMostRecentDecl());
3048 const RecordDecl *getMostRecentDecl() const {
3049 return const_cast<RecordDecl*>(this)->getMostRecentDecl();
3052 bool hasFlexibleArrayMember() const { return HasFlexibleArrayMember; }
3053 void setHasFlexibleArrayMember(bool V) { HasFlexibleArrayMember = V; }
3055 /// isAnonymousStructOrUnion - Whether this is an anonymous struct
3056 /// or union. To be an anonymous struct or union, it must have been
3057 /// declared without a name and there must be no objects of this
3058 /// type declared, e.g.,
3060 /// union { int i; float f; };
3062 /// is an anonymous union but neither of the following are:
3064 /// union X { int i; float f; };
3065 /// union { int i; float f; } obj;
3067 bool isAnonymousStructOrUnion() const { return AnonymousStructOrUnion; }
3068 void setAnonymousStructOrUnion(bool Anon) {
3069 AnonymousStructOrUnion = Anon;
3072 bool hasObjectMember() const { return HasObjectMember; }
3073 void setHasObjectMember (bool val) { HasObjectMember = val; }
3075 bool hasVolatileMember() const { return HasVolatileMember; }
3076 void setHasVolatileMember (bool val) { HasVolatileMember = val; }
3078 /// \brief Determines whether this declaration represents the
3079 /// injected class name.
3081 /// The injected class name in C++ is the name of the class that
3082 /// appears inside the class itself. For example:
3086 /// // C is implicitly declared here as a synonym for the class name.
3089 /// C::C c; // same as "C c;"
3091 bool isInjectedClassName() const;
3093 /// getDefinition - Returns the RecordDecl that actually defines
3094 /// this struct/union/class. When determining whether or not a
3095 /// struct/union/class is completely defined, one should use this
3096 /// method as opposed to 'isCompleteDefinition'.
3097 /// 'isCompleteDefinition' indicates whether or not a specific
3098 /// RecordDecl is a completed definition, not whether or not the
3099 /// record type is defined. This method returns NULL if there is
3100 /// no RecordDecl that defines the struct/union/tag.
3101 RecordDecl *getDefinition() const {
3102 return cast_or_null<RecordDecl>(TagDecl::getDefinition());
3105 // Iterator access to field members. The field iterator only visits
3106 // the non-static data members of this class, ignoring any static
3107 // data members, functions, constructors, destructors, etc.
3108 typedef specific_decl_iterator<FieldDecl> field_iterator;
3110 field_iterator field_begin() const;
3112 field_iterator field_end() const {
3113 return field_iterator(decl_iterator());
3116 // field_empty - Whether there are any fields (non-static data
3117 // members) in this record.
3118 bool field_empty() const {
3119 return field_begin() == field_end();
3122 /// completeDefinition - Notes that the definition of this type is
3124 virtual void completeDefinition();
3126 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3127 static bool classofKind(Kind K) {
3128 return K >= firstRecord && K <= lastRecord;
3131 /// isMsStrust - Get whether or not this is an ms_struct which can
3132 /// be turned on with an attribute, pragma, or -mms-bitfields
3133 /// commandline option.
3134 bool isMsStruct(const ASTContext &C) const;
3137 /// \brief Deserialize just the fields.
3138 void LoadFieldsFromExternalStorage() const;
3141 class FileScopeAsmDecl : public Decl {
3142 virtual void anchor();
3143 StringLiteral *AsmString;
3144 SourceLocation RParenLoc;
3145 FileScopeAsmDecl(DeclContext *DC, StringLiteral *asmstring,
3146 SourceLocation StartL, SourceLocation EndL)
3147 : Decl(FileScopeAsm, DC, StartL), AsmString(asmstring), RParenLoc(EndL) {}
3149 static FileScopeAsmDecl *Create(ASTContext &C, DeclContext *DC,
3150 StringLiteral *Str, SourceLocation AsmLoc,
3151 SourceLocation RParenLoc);
3153 static FileScopeAsmDecl *CreateDeserialized(ASTContext &C, unsigned ID);
3155 SourceLocation getAsmLoc() const { return getLocation(); }
3156 SourceLocation getRParenLoc() const { return RParenLoc; }
3157 void setRParenLoc(SourceLocation L) { RParenLoc = L; }
3158 SourceRange getSourceRange() const LLVM_READONLY {
3159 return SourceRange(getAsmLoc(), getRParenLoc());
3162 const StringLiteral *getAsmString() const { return AsmString; }
3163 StringLiteral *getAsmString() { return AsmString; }
3164 void setAsmString(StringLiteral *Asm) { AsmString = Asm; }
3166 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3167 static bool classofKind(Kind K) { return K == FileScopeAsm; }
3170 /// BlockDecl - This represents a block literal declaration, which is like an
3171 /// unnamed FunctionDecl. For example:
3172 /// ^{ statement-body } or ^(int arg1, float arg2){ statement-body }
3174 class BlockDecl : public Decl, public DeclContext {
3176 /// A class which contains all the information about a particular
3184 /// The variable being captured.
3185 llvm::PointerIntPair<VarDecl*, 2> VariableAndFlags;
3187 /// The copy expression, expressed in terms of a DeclRef (or
3188 /// BlockDeclRef) to the captured variable. Only required if the
3189 /// variable has a C++ class type.
3193 Capture(VarDecl *variable, bool byRef, bool nested, Expr *copy)
3194 : VariableAndFlags(variable,
3195 (byRef ? flag_isByRef : 0) | (nested ? flag_isNested : 0)),
3198 /// The variable being captured.
3199 VarDecl *getVariable() const { return VariableAndFlags.getPointer(); }
3201 /// Whether this is a "by ref" capture, i.e. a capture of a __block
3203 bool isByRef() const { return VariableAndFlags.getInt() & flag_isByRef; }
3205 /// Whether this is a nested capture, i.e. the variable captured
3206 /// is not from outside the immediately enclosing function/block.
3207 bool isNested() const { return VariableAndFlags.getInt() & flag_isNested; }
3209 bool hasCopyExpr() const { return CopyExpr != 0; }
3210 Expr *getCopyExpr() const { return CopyExpr; }
3211 void setCopyExpr(Expr *e) { CopyExpr = e; }
3215 // FIXME: This can be packed into the bitfields in Decl.
3216 bool IsVariadic : 1;
3217 bool CapturesCXXThis : 1;
3218 bool BlockMissingReturnType : 1;
3219 bool IsConversionFromLambda : 1;
3220 /// ParamInfo - new[]'d array of pointers to ParmVarDecls for the formal
3221 /// parameters of this function. This is null if a prototype or if there are
3223 ParmVarDecl **ParamInfo;
3227 TypeSourceInfo *SignatureAsWritten;
3230 unsigned NumCaptures;
3232 unsigned ManglingNumber;
3233 Decl *ManglingContextDecl;
3236 BlockDecl(DeclContext *DC, SourceLocation CaretLoc)
3237 : Decl(Block, DC, CaretLoc), DeclContext(Block),
3238 IsVariadic(false), CapturesCXXThis(false),
3239 BlockMissingReturnType(true), IsConversionFromLambda(false),
3240 ParamInfo(0), NumParams(0), Body(0),
3241 SignatureAsWritten(0), Captures(0), NumCaptures(0),
3242 ManglingNumber(0), ManglingContextDecl(0) {}
3245 static BlockDecl *Create(ASTContext &C, DeclContext *DC, SourceLocation L);
3246 static BlockDecl *CreateDeserialized(ASTContext &C, unsigned ID);
3248 SourceLocation getCaretLocation() const { return getLocation(); }
3250 bool isVariadic() const { return IsVariadic; }
3251 void setIsVariadic(bool value) { IsVariadic = value; }
3253 CompoundStmt *getCompoundBody() const { return (CompoundStmt*) Body; }
3254 Stmt *getBody() const { return (Stmt*) Body; }
3255 void setBody(CompoundStmt *B) { Body = (Stmt*) B; }
3257 void setSignatureAsWritten(TypeSourceInfo *Sig) { SignatureAsWritten = Sig; }
3258 TypeSourceInfo *getSignatureAsWritten() const { return SignatureAsWritten; }
3260 // Iterator access to formal parameters.
3261 unsigned param_size() const { return getNumParams(); }
3262 typedef ParmVarDecl **param_iterator;
3263 typedef ParmVarDecl * const *param_const_iterator;
3265 bool param_empty() const { return NumParams == 0; }
3266 param_iterator param_begin() { return ParamInfo; }
3267 param_iterator param_end() { return ParamInfo+param_size(); }
3269 param_const_iterator param_begin() const { return ParamInfo; }
3270 param_const_iterator param_end() const { return ParamInfo+param_size(); }
3272 unsigned getNumParams() const { return NumParams; }
3273 const ParmVarDecl *getParamDecl(unsigned i) const {
3274 assert(i < getNumParams() && "Illegal param #");
3275 return ParamInfo[i];
3277 ParmVarDecl *getParamDecl(unsigned i) {
3278 assert(i < getNumParams() && "Illegal param #");
3279 return ParamInfo[i];
3281 void setParams(ArrayRef<ParmVarDecl *> NewParamInfo);
3283 /// hasCaptures - True if this block (or its nested blocks) captures
3284 /// anything of local storage from its enclosing scopes.
3285 bool hasCaptures() const { return NumCaptures != 0 || CapturesCXXThis; }
3287 /// getNumCaptures - Returns the number of captured variables.
3288 /// Does not include an entry for 'this'.
3289 unsigned getNumCaptures() const { return NumCaptures; }
3291 typedef const Capture *capture_iterator;
3292 typedef const Capture *capture_const_iterator;
3293 capture_iterator capture_begin() { return Captures; }
3294 capture_iterator capture_end() { return Captures + NumCaptures; }
3295 capture_const_iterator capture_begin() const { return Captures; }
3296 capture_const_iterator capture_end() const { return Captures + NumCaptures; }
3298 bool capturesCXXThis() const { return CapturesCXXThis; }
3299 bool blockMissingReturnType() const { return BlockMissingReturnType; }
3300 void setBlockMissingReturnType(bool val) { BlockMissingReturnType = val; }
3302 bool isConversionFromLambda() const { return IsConversionFromLambda; }
3303 void setIsConversionFromLambda(bool val) { IsConversionFromLambda = val; }
3305 bool capturesVariable(const VarDecl *var) const;
3307 void setCaptures(ASTContext &Context,
3308 const Capture *begin,
3310 bool capturesCXXThis);
3312 unsigned getBlockManglingNumber() const {
3313 return ManglingNumber;
3315 Decl *getBlockManglingContextDecl() const {
3316 return ManglingContextDecl;
3319 void setBlockMangling(unsigned Number, Decl *Ctx) {
3320 ManglingNumber = Number;
3321 ManglingContextDecl = Ctx;
3324 virtual SourceRange getSourceRange() const LLVM_READONLY;
3326 // Implement isa/cast/dyncast/etc.
3327 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3328 static bool classofKind(Kind K) { return K == Block; }
3329 static DeclContext *castToDeclContext(const BlockDecl *D) {
3330 return static_cast<DeclContext *>(const_cast<BlockDecl*>(D));
3332 static BlockDecl *castFromDeclContext(const DeclContext *DC) {
3333 return static_cast<BlockDecl *>(const_cast<DeclContext*>(DC));
3337 /// \brief This represents the body of a CapturedStmt, and serves as its
3339 class CapturedDecl : public Decl, public DeclContext {
3341 /// \brief The number of parameters to the outlined function.
3343 /// \brief The body of the outlined function.
3346 explicit CapturedDecl(DeclContext *DC, unsigned NumParams)
3347 : Decl(Captured, DC, SourceLocation()), DeclContext(Captured),
3348 NumParams(NumParams), Body(0) { }
3350 ImplicitParamDecl **getParams() const {
3351 return reinterpret_cast<ImplicitParamDecl **>(
3352 const_cast<CapturedDecl *>(this) + 1);
3356 static CapturedDecl *Create(ASTContext &C, DeclContext *DC, unsigned NumParams);
3357 static CapturedDecl *CreateDeserialized(ASTContext &C, unsigned ID,
3358 unsigned NumParams);
3360 Stmt *getBody() const { return Body; }
3361 void setBody(Stmt *B) { Body = B; }
3363 unsigned getNumParams() const { return NumParams; }
3365 ImplicitParamDecl *getParam(unsigned i) const {
3366 assert(i < NumParams);
3367 return getParams()[i];
3369 void setParam(unsigned i, ImplicitParamDecl *P) {
3370 assert(i < NumParams);
3374 /// \brief Retrieve the parameter containing captured variables.
3375 ImplicitParamDecl *getContextParam() const { return getParam(0); }
3376 void setContextParam(ImplicitParamDecl *P) { setParam(0, P); }
3378 typedef ImplicitParamDecl **param_iterator;
3379 /// \brief Retrieve an iterator pointing to the first parameter decl.
3380 param_iterator param_begin() const { return getParams(); }
3381 /// \brief Retrieve an iterator one past the last parameter decl.
3382 param_iterator param_end() const { return getParams() + NumParams; }
3384 // Implement isa/cast/dyncast/etc.
3385 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3386 static bool classofKind(Kind K) { return K == Captured; }
3387 static DeclContext *castToDeclContext(const CapturedDecl *D) {
3388 return static_cast<DeclContext *>(const_cast<CapturedDecl *>(D));
3390 static CapturedDecl *castFromDeclContext(const DeclContext *DC) {
3391 return static_cast<CapturedDecl *>(const_cast<DeclContext *>(DC));
3394 friend class ASTDeclReader;
3395 friend class ASTDeclWriter;
3398 /// \brief Describes a module import declaration, which makes the contents
3399 /// of the named module visible in the current translation unit.
3401 /// An import declaration imports the named module (or submodule). For example:
3403 /// @import std.vector;
3406 /// Import declarations can also be implicitly generated from
3407 /// \#include/\#import directives.
3408 class ImportDecl : public Decl {
3409 /// \brief The imported module, along with a bit that indicates whether
3410 /// we have source-location information for each identifier in the module
3413 /// When the bit is false, we only have a single source location for the
3414 /// end of the import declaration.
3415 llvm::PointerIntPair<Module *, 1, bool> ImportedAndComplete;
3417 /// \brief The next import in the list of imports local to the translation
3418 /// unit being parsed (not loaded from an AST file).
3419 ImportDecl *NextLocalImport;
3421 friend class ASTReader;
3422 friend class ASTDeclReader;
3423 friend class ASTContext;
3425 ImportDecl(DeclContext *DC, SourceLocation StartLoc, Module *Imported,
3426 ArrayRef<SourceLocation> IdentifierLocs);
3428 ImportDecl(DeclContext *DC, SourceLocation StartLoc, Module *Imported,
3429 SourceLocation EndLoc);
3431 ImportDecl(EmptyShell Empty) : Decl(Import, Empty), NextLocalImport() { }
3434 /// \brief Create a new module import declaration.
3435 static ImportDecl *Create(ASTContext &C, DeclContext *DC,
3436 SourceLocation StartLoc, Module *Imported,
3437 ArrayRef<SourceLocation> IdentifierLocs);
3439 /// \brief Create a new module import declaration for an implicitly-generated
3441 static ImportDecl *CreateImplicit(ASTContext &C, DeclContext *DC,
3442 SourceLocation StartLoc, Module *Imported,
3443 SourceLocation EndLoc);
3445 /// \brief Create a new, deserialized module import declaration.
3446 static ImportDecl *CreateDeserialized(ASTContext &C, unsigned ID,
3447 unsigned NumLocations);
3449 /// \brief Retrieve the module that was imported by the import declaration.
3450 Module *getImportedModule() const { return ImportedAndComplete.getPointer(); }
3452 /// \brief Retrieves the locations of each of the identifiers that make up
3453 /// the complete module name in the import declaration.
3455 /// This will return an empty array if the locations of the individual
3456 /// identifiers aren't available.
3457 ArrayRef<SourceLocation> getIdentifierLocs() const;
3459 virtual SourceRange getSourceRange() const LLVM_READONLY;
3461 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3462 static bool classofKind(Kind K) { return K == Import; }
3465 /// \brief Represents an empty-declaration.
3466 class EmptyDecl : public Decl {
3467 virtual void anchor();
3468 EmptyDecl(DeclContext *DC, SourceLocation L)
3469 : Decl(Empty, DC, L) { }
3472 static EmptyDecl *Create(ASTContext &C, DeclContext *DC,
3474 static EmptyDecl *CreateDeserialized(ASTContext &C, unsigned ID);
3476 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3477 static bool classofKind(Kind K) { return K == Empty; }
3480 /// Insertion operator for diagnostics. This allows sending NamedDecl's
3481 /// into a diagnostic with <<.
3482 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
3483 const NamedDecl* ND) {
3484 DB.AddTaggedVal(reinterpret_cast<intptr_t>(ND),
3485 DiagnosticsEngine::ak_nameddecl);
3488 inline const PartialDiagnostic &operator<<(const PartialDiagnostic &PD,
3489 const NamedDecl* ND) {
3490 PD.AddTaggedVal(reinterpret_cast<intptr_t>(ND),
3491 DiagnosticsEngine::ak_nameddecl);
3495 template<typename decl_type>
3496 void Redeclarable<decl_type>::setPreviousDecl(decl_type *PrevDecl) {
3497 // Note: This routine is implemented here because we need both NamedDecl
3498 // and Redeclarable to be defined.
3503 // Point to previous. Make sure that this is actually the most recent
3504 // redeclaration, or we can build invalid chains. If the most recent
3505 // redeclaration is invalid, it won't be PrevDecl, but we want it anyway.
3506 First = PrevDecl->getFirstDecl();
3507 assert(First->RedeclLink.NextIsLatest() && "Expected first");
3508 decl_type *MostRecent = First->RedeclLink.getNext();
3509 RedeclLink = PreviousDeclLink(cast<decl_type>(MostRecent));
3511 // If the declaration was previously visible, a redeclaration of it remains
3512 // visible even if it wouldn't be visible by itself.
3513 static_cast<decl_type*>(this)->IdentifierNamespace |=
3514 MostRecent->getIdentifierNamespace() &
3515 (Decl::IDNS_Ordinary | Decl::IDNS_Tag | Decl::IDNS_Type);
3518 First = static_cast<decl_type*>(this);
3521 // First one will point to this one as latest.
3522 First->RedeclLink = LatestDeclLink(static_cast<decl_type*>(this));
3523 assert(!isa<NamedDecl>(static_cast<decl_type*>(this)) ||
3524 cast<NamedDecl>(static_cast<decl_type*>(this))->isLinkageValid());
3527 // Inline function definitions.
3529 /// \brief Check if the given decl is complete.
3531 /// We use this function to break a cycle between the inline definitions in
3532 /// Type.h and Decl.h.
3533 inline bool IsEnumDeclComplete(EnumDecl *ED) {
3534 return ED->isComplete();
3537 /// \brief Check if the given decl is scoped.
3539 /// We use this function to break a cycle between the inline definitions in
3540 /// Type.h and Decl.h.
3541 inline bool IsEnumDeclScoped(EnumDecl *ED) {
3542 return ED->isScoped();
3545 } // end namespace clang