clang  6.0.0svn
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
clang::VarDecl Class Reference

VarDecl - An instance of this class is created to represent a variable declaration or definition. More...

#include "clang/AST/Decl.h"

Inheritance diagram for clang::VarDecl:
Inheritance graph
[legend]
Collaboration diagram for clang::VarDecl:
Collaboration graph
[legend]

Classes

class  NonParmVarDeclBitfields
 
class  ParmVarDeclBitfields
 

Public Types

enum  InitializationStyle { CInit, CallInit, ListInit }
 Initialization styles. More...
 
enum  TLSKind { TLS_None, TLS_Static, TLS_Dynamic }
 Kinds of thread-local storage. More...
 
enum  DefinitionKind { DeclarationOnly, TentativeDefinition, Definition }
 
typedef redeclarable_base::redecl_range redecl_range
 
typedef redeclarable_base::redecl_iterator redecl_iterator
 
- Public Types inherited from clang::NamedDecl
enum  ExplicitVisibilityKind { VisibilityForType, VisibilityForValue }
 Kinds of explicit visibility. More...
 
- Public Types inherited from clang::Decl
enum  Kind
 Lists the kind of concrete classes of Decl. More...
 
enum  IdentifierNamespace {
  IDNS_Label = 0x0001, IDNS_Tag = 0x0002, IDNS_Type = 0x0004, IDNS_Member = 0x0008,
  IDNS_Namespace = 0x0010, IDNS_Ordinary = 0x0020, IDNS_ObjCProtocol = 0x0040, IDNS_OrdinaryFriend = 0x0080,
  IDNS_TagFriend = 0x0100, IDNS_Using = 0x0200, IDNS_NonMemberOperator = 0x0400, IDNS_LocalExtern = 0x0800,
  IDNS_OMPReduction = 0x1000
}
 IdentifierNamespace - The different namespaces in which declarations may appear. More...
 
enum  ObjCDeclQualifier {
  OBJC_TQ_None = 0x0, OBJC_TQ_In = 0x1, OBJC_TQ_Inout = 0x2, OBJC_TQ_Out = 0x4,
  OBJC_TQ_Bycopy = 0x8, OBJC_TQ_Byref = 0x10, OBJC_TQ_Oneway = 0x20, OBJC_TQ_CSNullability = 0x40
}
 ObjCDeclQualifier - 'Qualifiers' written next to the return and parameter types in method declarations. More...
 
enum  ModuleOwnershipKind : unsigned { ModuleOwnershipKind::Unowned, ModuleOwnershipKind::Visible, ModuleOwnershipKind::VisibleWhenImported, ModuleOwnershipKind::ModulePrivate }
 The kind of ownership a declaration has, for visibility purposes. More...
 
enum  FriendObjectKind { FOK_None, FOK_Declared, FOK_Undeclared }
 
typedef AttrVec::const_iterator attr_iterator
 
typedef llvm::iterator_range< attr_iteratorattr_range
 
typedef llvm::iterator_range< redecl_iteratorredecl_range
 
- Public Types inherited from clang::Redeclarable< VarDecl >
typedef llvm::iterator_range< redecl_iterator > redecl_range
 

Public Member Functions

SourceRange getSourceRange () const override LLVM_READONLY
 Source range that this declaration covers. More...
 
StorageClass getStorageClass () const
 Returns the storage class as written in the source. More...
 
void setStorageClass (StorageClass SC)
 
void setTSCSpec (ThreadStorageClassSpecifier TSC)
 
ThreadStorageClassSpecifier getTSCSpec () const
 
TLSKind getTLSKind () const
 
bool hasLocalStorage () const
 hasLocalStorage - Returns true if a variable with function scope is a non-static local variable. More...
 
bool isStaticLocal () const
 isStaticLocal - Returns true if a variable with function scope is a static local variable. More...
 
bool hasExternalStorage () const
 Returns true if a variable has extern or private_extern storage. More...
 
bool hasGlobalStorage () const
 Returns true for all variables that do not have local storage. More...
 
StorageDuration getStorageDuration () const
 Get the storage duration of this variable, per C++ [basic.stc]. More...
 
LanguageLinkage getLanguageLinkage () const
 Compute the language linkage. More...
 
bool isExternC () const
 Determines whether this variable is a variable with external, C linkage. More...
 
bool isInExternCContext () const
 Determines whether this variable's context is, or is nested within, a C++ extern "C" linkage spec. More...
 
bool isInExternCXXContext () const
 Determines whether this variable's context is, or is nested within, a C++ extern "C++" linkage spec. More...
 
bool isLocalVarDecl () const
 isLocalVarDecl - Returns true for local variable declarations other than parameters. More...
 
bool isLocalVarDeclOrParm () const
 Similar to isLocalVarDecl but also includes parameters. More...
 
bool isFunctionOrMethodVarDecl () const
 isFunctionOrMethodVarDecl - Similar to isLocalVarDecl, but excludes variables declared in blocks. More...
 
bool isStaticDataMember () const
 Determines whether this is a static data member. More...
 
VarDeclgetCanonicalDecl () override
 Retrieves the "canonical" declaration of the given declaration. More...
 
const VarDeclgetCanonicalDecl () const
 
DefinitionKind isThisDeclarationADefinition (ASTContext &) const
 Check whether this declaration is a definition. More...
 
DefinitionKind isThisDeclarationADefinition () const
 
DefinitionKind hasDefinition (ASTContext &) const
 Check whether this variable is defined in this translation unit. More...
 
DefinitionKind hasDefinition () const
 
VarDeclgetActingDefinition ()
 Get the tentative definition that acts as the real definition in a TU. More...
 
const VarDeclgetActingDefinition () const
 
VarDeclgetDefinition (ASTContext &)
 Get the real (not just tentative) definition for this declaration. More...
 
const VarDeclgetDefinition (ASTContext &C) const
 
VarDeclgetDefinition ()
 
const VarDeclgetDefinition () const
 
bool isOutOfLine () const override
 Determine whether this is or was instantiated from an out-of-line definition of a static data member. More...
 
bool isFileVarDecl () const
 isFileVarDecl - Returns true for file scoped variable declaration. More...
 
const ExprgetAnyInitializer () const
 getAnyInitializer - Get the initializer for this variable, no matter which declaration it is attached to. More...
 
const ExprgetAnyInitializer (const VarDecl *&D) const
 getAnyInitializer - Get the initializer for this variable, no matter which declaration it is attached to. More...
 
bool hasInit () const
 
const ExprgetInit () const
 
ExprgetInit ()
 
Stmt ** getInitAddress ()
 Retrieve the address of the initializer expression. More...
 
void setInit (Expr *I)
 
bool isUsableInConstantExpressions (ASTContext &C) const
 Determine whether this variable's value can be used in a constant expression, according to the relevant language standard. More...
 
EvaluatedStmtensureEvaluatedStmt () const
 Convert the initializer for this declaration to the elaborated EvaluatedStmt form, which contains extra information on the evaluated value of the initializer. More...
 
APValueevaluateValue () const
 Attempt to evaluate the value of the initializer attached to this declaration, and produce notes explaining why it cannot be evaluated or is not a constant expression. More...
 
APValueevaluateValue (SmallVectorImpl< PartialDiagnosticAt > &Notes) const
 
APValuegetEvaluatedValue () const
 Return the already-evaluated value of this variable's initializer, or NULL if the value is not yet known. More...
 
bool isInitKnownICE () const
 Determines whether it is already known whether the initializer is an integral constant expression or not. More...
 
bool isInitICE () const
 Determines whether the initializer is an integral constant expression, or in C++11, whether the initializer is a constant expression. More...
 
bool checkInitIsICE () const
 Determine whether the value of the initializer attached to this declaration is an integral constant expression. More...
 
void setInitStyle (InitializationStyle Style)
 
InitializationStyle getInitStyle () const
 The style of initialization for this declaration. More...
 
bool isDirectInit () const
 Whether the initializer is a direct-initializer (list or call). More...
 
bool isThisDeclarationADemotedDefinition () const
 If this definition should pretend to be a declaration. More...
 
void demoteThisDefinitionToDeclaration ()
 This is a definition which should be demoted to a declaration. More...
 
bool isExceptionVariable () const
 Determine whether this variable is the exception variable in a C++ catch statememt or an Objective-C @catch statement. More...
 
void setExceptionVariable (bool EV)
 
bool isNRVOVariable () const
 Determine whether this local variable can be used with the named return value optimization (NRVO). More...
 
void setNRVOVariable (bool NRVO)
 
bool isCXXForRangeDecl () const
 Determine whether this variable is the for-range-declaration in a C++0x for-range statement. More...
 
void setCXXForRangeDecl (bool FRD)
 
bool isARCPseudoStrong () const
 Determine whether this variable is an ARC pseudo-__strong variable. More...
 
void setARCPseudoStrong (bool ps)
 
bool isInline () const
 Whether this variable is (C++1z) inline. More...
 
bool isInlineSpecified () const
 
void setInlineSpecified ()
 
void setImplicitlyInline ()
 
bool isConstexpr () const
 Whether this variable is (C++11) constexpr. More...
 
void setConstexpr (bool IC)
 
bool isInitCapture () const
 Whether this variable is the implicit variable for a lambda init-capture. More...
 
void setInitCapture (bool IC)
 
bool isPreviousDeclInSameBlockScope () const
 Whether this local extern variable declaration's previous declaration was declared in the same block scope. More...
 
void setPreviousDeclInSameBlockScope (bool Same)
 
VarDeclgetTemplateInstantiationPattern () const
 Retrieve the variable declaration from which this variable could be instantiated, if it is an instantiation (rather than a non-template). More...
 
VarDeclgetInstantiatedFromStaticDataMember () const
 If this variable is an instantiated static data member of a class template specialization, returns the templated static data member from which it was instantiated. More...
 
TemplateSpecializationKind getTemplateSpecializationKind () const
 If this variable is an instantiation of a variable template or a static data member of a class template, determine what kind of template specialization or instantiation this is. More...
 
SourceLocation getPointOfInstantiation () const
 If this variable is an instantiation of a variable template or a static data member of a class template, determine its point of instantiation. More...
 
MemberSpecializationInfogetMemberSpecializationInfo () const
 If this variable is an instantiation of a static data member of a class template specialization, retrieves the member specialization information. More...
 
void setTemplateSpecializationKind (TemplateSpecializationKind TSK, SourceLocation PointOfInstantiation=SourceLocation())
 For a static data member that was instantiated from a static data member of a class template, set the template specialiation kind. More...
 
void setInstantiationOfStaticDataMember (VarDecl *VD, TemplateSpecializationKind TSK)
 Specify that this variable is an instantiation of the static data member VD. More...
 
VarTemplateDeclgetDescribedVarTemplate () const
 Retrieves the variable template that is described by this variable declaration. More...
 
void setDescribedVarTemplate (VarTemplateDecl *Template)
 
- Public Member Functions inherited from clang::DeclaratorDecl
TypeSourceInfogetTypeSourceInfo () const
 
void setTypeSourceInfo (TypeSourceInfo *TI)
 
SourceLocation getInnerLocStart () const
 getInnerLocStart - Return SourceLocation representing start of source range ignoring outer template declarations. More...
 
void setInnerLocStart (SourceLocation L)
 
SourceLocation getOuterLocStart () const
 getOuterLocStart - Return SourceLocation representing start of source range taking into account any outer template declarations. More...
 
SourceLocation getLocStart () const LLVM_READONLY
 
NestedNameSpecifiergetQualifier () const
 Retrieve the nested-name-specifier that qualifies the name of this declaration, if it was present in the source. More...
 
NestedNameSpecifierLoc getQualifierLoc () const
 Retrieve the nested-name-specifier (with source-location information) that qualifies the name of this declaration, if it was present in the source. More...
 
void setQualifierInfo (NestedNameSpecifierLoc QualifierLoc)
 
unsigned getNumTemplateParameterLists () const
 
TemplateParameterListgetTemplateParameterList (unsigned index) const
 
void setTemplateParameterListsInfo (ASTContext &Context, ArrayRef< TemplateParameterList *> TPLists)
 
SourceLocation getTypeSpecStartLoc () const
 
- Public Member Functions inherited from clang::ValueDecl
QualType getType () const
 
void setType (QualType newType)
 
bool isWeak () const
 Determine whether this symbol is weakly-imported, or declared with the weak or weak-ref attr. More...
 
- Public Member Functions inherited from clang::NamedDecl
IdentifierInfogetIdentifier () const
 getIdentifier - Get the identifier that names this declaration, if there is one. More...
 
StringRef getName () const
 getName - Get the name of identifier for this declaration as a StringRef. More...
 
std::string getNameAsString () const
 getNameAsString - Get a human-readable name for the declaration, even if it is one of the special kinds of names (C++ constructor, Objective-C selector, etc). More...
 
virtual void printName (raw_ostream &os) const
 
DeclarationName getDeclName () const
 getDeclName - Get the actual, stored name of the declaration, which may be a special name. More...
 
void setDeclName (DeclarationName N)
 Set the name of this declaration. More...
 
void printQualifiedName (raw_ostream &OS) const
 printQualifiedName - Returns human-readable qualified name for declaration, like A::B::i, for i being member of namespace A::B. More...
 
void printQualifiedName (raw_ostream &OS, const PrintingPolicy &Policy) const
 
std::string getQualifiedNameAsString () const
 
virtual void getNameForDiagnostic (raw_ostream &OS, const PrintingPolicy &Policy, bool Qualified) const
 getNameForDiagnostic - Appends a human-readable name for this declaration into the given stream. More...
 
bool declarationReplaces (NamedDecl *OldD, bool IsKnownNewer=true) const
 Determine whether this declaration, if known to be well-formed within its context, will replace the declaration OldD if introduced into scope. More...
 
bool hasLinkage () const
 Determine whether this declaration has linkage. More...
 
bool isCXXClassMember () const
 Determine whether this declaration is a C++ class member. More...
 
bool isCXXInstanceMember () const
 Determine whether the given declaration is an instance member of a C++ class. More...
 
Linkage getLinkageInternal () const
 Determine what kind of linkage this entity has. More...
 
Linkage getFormalLinkage () const
 Get the linkage from a semantic point of view. More...
 
bool hasExternalFormalLinkage () const
 True if this decl has external linkage. More...
 
bool isExternallyVisible () const
 
Visibility getVisibility () const
 Determines the visibility of this entity. More...
 
LinkageInfo getLinkageAndVisibility () const
 Determines the linkage and visibility of this entity. More...
 
Optional< VisibilitygetExplicitVisibility (ExplicitVisibilityKind kind) const
 If visibility was explicitly specified for this declaration, return that visibility. More...
 
bool isLinkageValid () const
 True if the computed linkage is valid. More...
 
bool hasLinkageBeenComputed () const
 True if something has required us to compute the linkage of this declaration. More...
 
ModulegetOwningModuleForLinkage () const
 Get the module that owns this declaration for linkage purposes. More...
 
NamedDeclgetUnderlyingDecl ()
 Looks through UsingDecls and ObjCCompatibleAliasDecls for the underlying named decl. More...
 
const NamedDeclgetUnderlyingDecl () const
 
NamedDeclgetMostRecentDecl ()
 
const NamedDeclgetMostRecentDecl () const
 
ObjCStringFormatFamily getObjCFStringFormattingFamily () const
 
- Public Member Functions inherited from clang::Decl
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
SourceLocation getLocation () const
 
void setLocation (SourceLocation L)
 
Kind getKind () const
 
const char * getDeclKindName () const
 
DeclgetNextDeclInContext ()
 
const DeclgetNextDeclInContext () const
 
DeclContextgetDeclContext ()
 
const DeclContextgetDeclContext () const
 
DeclgetNonClosureContext ()
 Find the innermost non-closure ancestor of this declaration, walking up through blocks, lambdas, etc. More...
 
const DeclgetNonClosureContext () const
 
TranslationUnitDeclgetTranslationUnitDecl ()
 
const TranslationUnitDeclgetTranslationUnitDecl () const
 
bool isInAnonymousNamespace () const
 
bool isInStdNamespace () const
 
ASTContextgetASTContext () const LLVM_READONLY
 
void setAccess (AccessSpecifier AS)
 
AccessSpecifier getAccess () const
 
AccessSpecifier getAccessUnsafe () const
 Retrieve the access specifier for this declaration, even though it may not yet have been properly set. More...
 
bool hasAttrs () const
 
void setAttrs (const AttrVec &Attrs)
 
AttrVecgetAttrs ()
 
const AttrVecgetAttrs () const
 
void dropAttrs ()
 
void addAttr (Attr *A)
 
attr_range attrs () const
 
attr_iterator attr_begin () const
 
attr_iterator attr_end () const
 
template<typename T >
void dropAttr ()
 
template<typename T >
llvm::iterator_range< specific_attr_iterator< T > > specific_attrs () const
 
template<typename T >
specific_attr_iterator< T > specific_attr_begin () const
 
template<typename T >
specific_attr_iterator< T > specific_attr_end () const
 
template<typename T >
T * getAttr () const
 
template<typename T >
bool hasAttr () const
 
unsigned getMaxAlignment () const
 getMaxAlignment - return the maximum alignment specified by attributes on this decl, 0 if there are none. More...
 
void setInvalidDecl (bool Invalid=true)
 setInvalidDecl - Indicates the Decl had a semantic error. More...
 
bool isInvalidDecl () const
 
bool isImplicit () const
 isImplicit - Indicates whether the declaration was implicitly generated by the implementation. More...
 
void setImplicit (bool I=true)
 
bool isUsed (bool CheckUsedAttr=true) const
 Whether any (re-)declaration of the entity was used, meaning that a definition is required. More...
 
void setIsUsed ()
 Set whether the declaration is used, in the sense of odr-use. More...
 
void markUsed (ASTContext &C)
 Mark the declaration used, in the sense of odr-use. More...
 
bool isReferenced () const
 Whether any declaration of this entity was referenced. More...
 
bool isThisDeclarationReferenced () const
 Whether this declaration was referenced. More...
 
void setReferenced (bool R=true)
 
bool isTopLevelDeclInObjCContainer () const
 Whether this declaration is a top-level declaration (function, global variable, etc.) that is lexically inside an objc container definition. More...
 
void setTopLevelDeclInObjCContainer (bool V=true)
 
ExternalSourceSymbolAttr * getExternalSourceSymbolAttr () const
 Looks on this and related declarations for an applicable external source symbol attribute. More...
 
bool isModulePrivate () const
 Whether this declaration was marked as being private to the module in which it was defined. More...
 
bool isExported () const
 Whether this declaration is exported (by virtue of being lexically within an ExportDecl or by being a NamespaceDecl). More...
 
bool hasDefiningAttr () const
 Return true if this declaration has an attribute which acts as definition of the entity, such as 'alias' or 'ifunc'. More...
 
const AttrgetDefiningAttr () const
 Return this declaration's defining attribute if it has one. More...
 
AvailabilityResult getAvailability (std::string *Message=nullptr, VersionTuple EnclosingVersion=VersionTuple()) const
 Determine the availability of the given declaration. More...
 
VersionTuple getVersionIntroduced () const
 Retrieve the version of the target platform in which this declaration was introduced. More...
 
bool isDeprecated (std::string *Message=nullptr) const
 Determine whether this declaration is marked 'deprecated'. More...
 
bool isUnavailable (std::string *Message=nullptr) const
 Determine whether this declaration is marked 'unavailable'. More...
 
bool isWeakImported () const
 Determine whether this is a weak-imported symbol. More...
 
bool canBeWeakImported (bool &IsDefinition) const
 Determines whether this symbol can be weak-imported, e.g., whether it would be well-formed to add the weak_import attribute. More...
 
bool isFromASTFile () const
 Determine whether this declaration came from an AST file (such as a precompiled header or module) rather than having been parsed. More...
 
unsigned getGlobalID () const
 Retrieve the global declaration ID associated with this declaration, which specifies where this Decl was loaded from. More...
 
unsigned getOwningModuleID () const
 Retrieve the global ID of the module that owns this particular declaration. More...
 
ModulegetImportedOwningModule () const
 Get the imported owning module, if this decl is from an imported (non-local) module. More...
 
ModulegetLocalOwningModule () const
 Get the local owning module, if known. More...
 
void setLocalOwningModule (Module *M)
 
bool hasOwningModule () const
 Is this declaration owned by some module? More...
 
ModulegetOwningModule () const
 Get the module that owns this declaration (for visibility purposes). More...
 
bool isHidden () const
 Determine whether this declaration might be hidden from name lookup. More...
 
void setVisibleDespiteOwningModule ()
 Set that this declaration is globally visible, even if it came from a module that is not visible. More...
 
ModuleOwnershipKind getModuleOwnershipKind () const
 Get the kind of module ownership for this declaration. More...
 
void setModuleOwnershipKind (ModuleOwnershipKind MOK)
 Set whether this declaration is hidden from name lookup. More...
 
unsigned getIdentifierNamespace () const
 
bool isInIdentifierNamespace (unsigned NS) const
 
bool hasTagIdentifierNamespace () const
 
DeclContextgetLexicalDeclContext ()
 getLexicalDeclContext - The declaration context where this Decl was lexically declared (LexicalDC). More...
 
const DeclContextgetLexicalDeclContext () const
 
void setDeclContext (DeclContext *DC)
 setDeclContext - Set both the semantic and lexical DeclContext to DC. More...
 
void setLexicalDeclContext (DeclContext *DC)
 
bool isDefinedOutsideFunctionOrMethod () const
 isDefinedOutsideFunctionOrMethod - This predicate returns true if this scoped decl is defined outside the current function or method. More...
 
bool isLexicallyWithinFunctionOrMethod () const
 Returns true if this declaration lexically is inside a function. More...
 
const DeclContextgetParentFunctionOrMethod () const
 If this decl is defined inside a function/method/block it returns the corresponding DeclContext, otherwise it returns null. More...
 
DeclContextgetParentFunctionOrMethod ()
 
const DeclgetCanonicalDecl () const
 
bool isCanonicalDecl () const
 Whether this particular Decl is a canonical one. More...
 
redecl_range redecls () const
 Returns an iterator range for all the redeclarations of the same decl. More...
 
redecl_iterator redecls_begin () const
 
redecl_iterator redecls_end () const
 
DeclgetPreviousDecl ()
 Retrieve the previous declaration that declares the same entity as this declaration, or NULL if there is no previous declaration. More...
 
const DeclgetPreviousDecl () const
 Retrieve the most recent declaration that declares the same entity as this declaration, or NULL if there is no previous declaration. More...
 
bool isFirstDecl () const
 True if this is the first declaration in its redeclaration chain. More...
 
DeclgetMostRecentDecl ()
 Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration). More...
 
const DeclgetMostRecentDecl () const
 Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration). More...
 
virtual StmtgetBody () const
 getBody - If this Decl represents a declaration for a body of code, such as a function or method definition, this method returns the top-level Stmt* of that body. More...
 
virtual bool hasBody () const
 Returns true if this Decl represents a declaration for a body of code, such as a function or method definition. More...
 
SourceLocation getBodyRBrace () const
 getBodyRBrace - Gets the right brace of the body, if a body exists. More...
 
bool isTemplateParameter () const
 isTemplateParameter - Determines whether this declaration is a template parameter. More...
 
bool isTemplateParameterPack () const
 isTemplateParameter - Determines whether this declaration is a template parameter pack. More...
 
bool isParameterPack () const
 Whether this declaration is a parameter pack. More...
 
bool isTemplateDecl () const
 returns true if this declaration is a template More...
 
bool isFunctionOrFunctionTemplate () const
 Whether this declaration is a function or function template. More...
 
TemplateDeclgetDescribedTemplate () const
 If this is a declaration that describes some template, this method returns that template declaration. More...
 
FunctionDeclgetAsFunction () LLVM_READONLY
 Returns the function itself, or the templated function if this is a function template. More...
 
const FunctionDeclgetAsFunction () const
 
void setLocalExternDecl ()
 Changes the namespace of this declaration to reflect that it's a function-local extern declaration. More...
 
bool isLocalExternDecl ()
 Determine whether this is a block-scope declaration with linkage. More...
 
void setObjectOfFriendDecl (bool PerformFriendInjection=false)
 Changes the namespace of this declaration to reflect that it's the object of a friend declaration. More...
 
FriendObjectKind getFriendObjectKind () const
 Determines whether this declaration is the object of a friend declaration and, if so, what kind. More...
 
void setNonMemberOperator ()
 Specifies that this declaration is a C++ overloaded non-member. More...
 
void print (raw_ostream &Out, unsigned Indentation=0, bool PrintInstantiation=false) const
 
void print (raw_ostream &Out, const PrintingPolicy &Policy, unsigned Indentation=0, bool PrintInstantiation=false) const
 
void dump () const
 
void dumpColor () const
 
void dump (raw_ostream &Out, bool Deserialize=false) const
 
const FunctionTypegetFunctionType (bool BlocksToo=true) const
 Looks through the Decl's underlying type to extract a FunctionType when possible. More...
 
- Public Member Functions inherited from clang::Redeclarable< VarDecl >
 Redeclarable (const ASTContext &Ctx)
 
VarDeclgetPreviousDecl ()
 Return the previous declaration of this declaration or NULL if this is the first declaration. More...
 
const VarDeclgetPreviousDecl () const
 
VarDeclgetFirstDecl ()
 Return the first declaration of this declaration or itself if this is the only declaration. More...
 
const VarDeclgetFirstDecl () const
 Return the first declaration of this declaration or itself if this is the only declaration. More...
 
bool isFirstDecl () const
 True if this is the first declaration in its redeclaration chain. More...
 
VarDeclgetMostRecentDecl ()
 Returns the most recent (re)declaration of this declaration. More...
 
const VarDeclgetMostRecentDecl () const
 Returns the most recent (re)declaration of this declaration. More...
 
void setPreviousDecl (VarDecl *PrevDecl)
 Set the previous declaration. More...
 
redecl_range redecls () const
 Returns an iterator range for all the redeclarations of the same decl. More...
 
redecl_iterator redecls_begin () const
 
redecl_iterator redecls_end () const
 

Static Public Member Functions

static const char * getStorageClassSpecifierString (StorageClass SC)
 getStorageClassSpecifierString - Return the string used to specify the storage class SC. More...
 
static VarDeclCreate (ASTContext &C, DeclContext *DC, SourceLocation StartLoc, SourceLocation IdLoc, IdentifierInfo *Id, QualType T, TypeSourceInfo *TInfo, StorageClass S)
 
static VarDeclCreateDeserialized (ASTContext &C, unsigned ID)
 
static bool classof (const Decl *D)
 
static bool classofKind (Kind K)
 
- Static Public Member Functions inherited from clang::DeclaratorDecl
static bool classof (const Decl *D)
 
static bool classofKind (Kind K)
 
- Static Public Member Functions inherited from clang::ValueDecl
static bool classof (const Decl *D)
 
static bool classofKind (Kind K)
 
- Static Public Member Functions inherited from clang::NamedDecl
static bool classof (const Decl *D)
 
static bool classofKind (Kind K)
 
- Static Public Member Functions inherited from clang::Decl
static unsigned getIdentifierNamespaceForKind (Kind DK)
 
static bool isTagIdentifierNamespace (unsigned NS)
 
static void add (Kind k)
 
static void EnableStatistics ()
 
static void PrintStats ()
 
static bool classofKind (Kind K)
 
static DeclContextcastToDeclContext (const Decl *)
 
static DeclcastFromDeclContext (const DeclContext *)
 
static void printGroup (Decl **Begin, unsigned NumDecls, raw_ostream &Out, const PrintingPolicy &Policy, unsigned Indentation=0)
 

Protected Types

enum  { NumParameterIndexBits = 8 }
 
enum  DefaultArgKind { DAK_None, DAK_Unparsed, DAK_Uninstantiated, DAK_Normal }
 
typedef llvm::PointerUnion< Stmt *, EvaluatedStmt * > InitType
 
typedef Redeclarable< VarDeclredeclarable_base
 

Protected Member Functions

 VarDecl (Kind DK, ASTContext &C, DeclContext *DC, SourceLocation StartLoc, SourceLocation IdLoc, IdentifierInfo *Id, QualType T, TypeSourceInfo *TInfo, StorageClass SC)
 
VarDeclgetNextRedeclarationImpl () override
 Returns the next redeclaration or itself if this is the only decl. More...
 
VarDeclgetPreviousDeclImpl () override
 Implementation of getPreviousDecl(), to be overridden by any subclass that has a redeclaration chain. More...
 
VarDeclgetMostRecentDeclImpl () override
 Implementation of getMostRecentDecl(), to be overridden by any subclass that has a redeclaration chain. More...
 
- Protected Member Functions inherited from clang::DeclaratorDecl
 DeclaratorDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N, QualType T, TypeSourceInfo *TInfo, SourceLocation StartL)
 
- Protected Member Functions inherited from clang::ValueDecl
 ValueDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N, QualType T)
 
- Protected Member Functions inherited from clang::NamedDecl
 NamedDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N)
 
- Protected Member Functions inherited from clang::Decl
void * operator new (std::size_t Size, const ASTContext &Ctx, unsigned ID, std::size_t Extra=0)
 Allocate memory for a deserialized declaration. More...
 
void * operator new (std::size_t Size, const ASTContext &Ctx, DeclContext *Parent, std::size_t Extra=0)
 Allocate memory for a non-deserialized declaration. More...
 
 Decl (Kind DK, DeclContext *DC, SourceLocation L)
 
 Decl (Kind DK, EmptyShell Empty)
 
virtual ~Decl ()
 
void updateOutOfDate (IdentifierInfo &II) const
 Update a potentially out-of-date declaration. More...
 
Linkage getCachedLinkage () const
 
void setCachedLinkage (Linkage L) const
 
bool hasCachedLinkage () const
 
void setModulePrivate ()
 Specify that this declaration was marked as being private to the module in which it was defined. More...
 
void setOwningModuleID (unsigned ID)
 Set the owning module ID. More...
 
bool hasLocalOwningModuleStorage () const
 
ASTMutationListenergetASTMutationListener () const
 
- Protected Member Functions inherited from clang::Redeclarable< VarDecl >
VarDeclgetNextRedeclaration () const
 

Protected Attributes

InitType Init
 The initializer for this variable or, for a ParmVarDecl, the C++ default argument. More...
 
union {
   unsigned   AllBits
 
   VarDeclBitfields   VarDeclBits
 
   ParmVarDeclBitfields   ParmVarDeclBits
 
   NonParmVarDeclBitfields   NonParmVarDeclBits
 
}; 
 
- Protected Attributes inherited from clang::Decl
llvm::PointerIntPair< Decl *, 2, ModuleOwnershipKindNextInContextAndBits
 The next declaration within the same lexical DeclContext. More...
 
unsigned Access: 2
 Access - Used by C++ decls for the access specifier. More...
 
unsigned FromASTFile: 1
 Whether this declaration was loaded from an AST file. More...
 
unsigned IdentifierNamespace: 13
 IdentifierNamespace - This specifies what IDNS_* namespace this lives in. More...
 
unsigned CacheValidAndLinkage: 3
 If 0, we have not computed the linkage of this declaration. More...
 
- Protected Attributes inherited from clang::Redeclarable< VarDecl >
DeclLink RedeclLink
 Points to the next redeclaration in the chain. More...
 
VarDeclFirst
 

Friends

class ASTDeclReader
 
class StmtIteratorBase
 
class ASTNodeImporter
 

Additional Inherited Members

- Static Protected Member Functions inherited from clang::Redeclarable< VarDecl >
static DeclLink PreviousDeclLink (VarDecl *D)
 
static DeclLink LatestDeclLink (const ASTContext &Ctx)
 

Detailed Description

VarDecl - An instance of this class is created to represent a variable declaration or definition.

Definition at line 762 of file Decl.h.

Member Typedef Documentation

◆ InitType

typedef llvm::PointerUnion<Stmt *, EvaluatedStmt *> clang::VarDecl::InitType
protected

Definition at line 792 of file Decl.h.

◆ redecl_iterator

typedef redeclarable_base::redecl_iterator clang::VarDecl::redecl_iterator

Definition at line 932 of file Decl.h.

◆ redecl_range

Definition at line 931 of file Decl.h.

◆ redeclarable_base

Definition at line 919 of file Decl.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
NumParameterIndexBits 

Definition at line 814 of file Decl.h.

◆ DefaultArgKind

Enumerator
DAK_None 
DAK_Unparsed 
DAK_Uninstantiated 
DAK_Normal 

Definition at line 816 of file Decl.h.

◆ DefinitionKind

Enumerator
DeclarationOnly 

This declaration is only a declaration.

TentativeDefinition 

This declaration is a tentative definition.

Definition 

This declaration is definitely a definition.

Definition at line 1079 of file Decl.h.

◆ InitializationStyle

Initialization styles.

Enumerator
CInit 

C-style initialization with assignment.

CallInit 

Call-style initialization (C++98)

ListInit 

Direct list-initialization (C++11)

Definition at line 771 of file Decl.h.

◆ TLSKind

Kinds of thread-local storage.

Enumerator
TLS_None 

Not a TLS variable.

TLS_Static 

TLS with a known-constant initializer.

TLS_Dynamic 

TLS with a dynamic initializer.

Definition at line 778 of file Decl.h.

Constructor & Destructor Documentation

◆ VarDecl()

VarDecl::VarDecl ( Kind  DK,
ASTContext C,
DeclContext DC,
SourceLocation  StartLoc,
SourceLocation  IdLoc,
IdentifierInfo Id,
QualType  T,
TypeSourceInfo TInfo,
StorageClass  SC 
)
protected

Definition at line 1820 of file Decl.cpp.

References AllBits, and VarDeclBits.

Referenced by CreateDeserialized().

Member Function Documentation

◆ checkInitIsICE()

bool VarDecl::checkInitIsICE ( ) const

◆ classof()

static bool clang::VarDecl::classof ( const Decl D)
inlinestatic

Definition at line 1382 of file Decl.h.

References clang::Decl::getKind().

◆ classofKind()

static bool clang::VarDecl::classofKind ( Kind  K)
inlinestatic

Definition at line 1383 of file Decl.h.

◆ Create()

VarDecl * VarDecl::Create ( ASTContext C,
DeclContext DC,
SourceLocation  StartLoc,
SourceLocation  IdLoc,
IdentifierInfo Id,
QualType  T,
TypeSourceInfo TInfo,
StorageClass  S 
)
static

◆ CreateDeserialized()

VarDecl * VarDecl::CreateDeserialized ( ASTContext C,
unsigned  ID 
)
static

Definition at line 1844 of file Decl.cpp.

References clang::SC_None, and VarDecl().

◆ demoteThisDefinitionToDeclaration()

void clang::VarDecl::demoteThisDefinitionToDeclaration ( )
inline

This is a definition which should be demoted to a declaration.

In some cases (mostly module merging) we can end up with two visible definitions one of which needs to be demoted to a declaration to keep the AST invariants.

Definition at line 1228 of file Decl.h.

Referenced by clang::ASTDeclReader::attachPreviousDeclImpl(), and clang::Sema::checkVarDeclRedefinition().

◆ ensureEvaluatedStmt()

EvaluatedStmt * VarDecl::ensureEvaluatedStmt ( ) const

Convert the initializer for this declaration to the elaborated EvaluatedStmt form, which contains extra information on the evaluated value of the initializer.

Definition at line 2160 of file Decl.cpp.

References clang::Decl::getASTContext(), Init, and clang::EvaluatedStmt::Value.

Referenced by checkInitIsICE(), evaluateValue(), clang::ASTDeclReader::UpdateDecl(), VariableCanNeverBeAConstantExpression(), and clang::ASTDeclReader::VisitVarDeclImpl().

◆ evaluateValue() [1/2]

APValue * VarDecl::evaluateValue ( ) const

Attempt to evaluate the value of the initializer attached to this declaration, and produce notes explaining why it cannot be evaluated or is not a constant expression.

Returns a pointer to the value if evaluation succeeded, 0 otherwise.

Definition at line 2174 of file Decl.cpp.

Referenced by checkInitIsICE(), clang::ASTContext::DeclMustBeEmitted(), evaluateVarDeclInit(), and clang::CodeGen::ConstantEmitter::tryEmitPrivateForVarInit().

◆ evaluateValue() [2/2]

APValue * VarDecl::evaluateValue ( SmallVectorImpl< PartialDiagnosticAt > &  Notes) const

◆ getActingDefinition() [1/2]

VarDecl * VarDecl::getActingDefinition ( )

Get the tentative definition that acts as the real definition in a TU.

Returns null if there is a proper definition available.

Definition at line 2031 of file Decl.cpp.

References clang::Redeclarable< VarDecl >::First, clang::Redeclarable< VarDecl >::getFirstDecl(), isThisDeclarationADefinition(), and TentativeDefinition.

Referenced by getDefinition().

◆ getActingDefinition() [2/2]

const VarDecl* clang::VarDecl::getActingDefinition ( ) const
inline

Definition at line 1103 of file Decl.h.

References getDefinition().

◆ getAnyInitializer() [1/2]

const Expr* clang::VarDecl::getAnyInitializer ( ) const
inline

◆ getAnyInitializer() [2/2]

const Expr * VarDecl::getAnyInitializer ( const VarDecl *&  D) const

getAnyInitializer - Get the initializer for this variable, no matter which declaration it is attached to.

Also get that declaration.

Definition at line 2070 of file Decl.cpp.

◆ getCanonicalDecl() [1/2]

VarDecl * VarDecl::getCanonicalDecl ( )
overridevirtual

◆ getCanonicalDecl() [2/2]

const VarDecl* clang::VarDecl::getCanonicalDecl ( ) const
inline

Definition at line 1075 of file Decl.h.

References getCanonicalDecl().

◆ getDefinition() [1/4]

VarDecl * VarDecl::getDefinition ( ASTContext C)

◆ getDefinition() [2/4]

const VarDecl* clang::VarDecl::getDefinition ( ASTContext C) const
inline

Definition at line 1109 of file Decl.h.

References getDefinition().

◆ getDefinition() [3/4]

VarDecl* clang::VarDecl::getDefinition ( )
inline

Definition at line 1112 of file Decl.h.

References getDefinition().

◆ getDefinition() [4/4]

const VarDecl* clang::VarDecl::getDefinition ( ) const
inline

Definition at line 1115 of file Decl.h.

References getDefinition().

◆ getDescribedVarTemplate()

VarTemplateDecl * VarDecl::getDescribedVarTemplate ( ) const

Retrieves the variable template that is described by this variable declaration.

Every variable template is represented as a VarTemplateDecl and a VarDecl. The former contains template properties (such as the template parameter lists) while the latter contains the actual description of the template's contents. VarTemplateDecl::getTemplatedDecl() retrieves the VarDecl that from a VarTemplateDecl, while getDescribedVarTemplate() retrieves the VarTemplateDecl from a VarDecl.

Definition at line 2362 of file Decl.cpp.

References clang::Decl::getASTContext(), and clang::ASTContext::getTemplateOrSpecializationInfo().

Referenced by clang::Sema::BuildVarTemplateInstantiation(), clang::Sema::checkVarDeclRedefinition(), getTemplateInstantiationPattern(), clang::Sema::MergeVarDecl(), clang::ASTDeclWriter::VisitVarDecl(), and clang::ASTNodeImporter::VisitVarTemplateDecl().

◆ getEvaluatedValue()

APValue * VarDecl::getEvaluatedValue ( ) const

Return the already-evaluated value of this variable's initializer, or NULL if the value is not yet known.

Returns pointer to untyped APValue if the value could not be evaluated.

Definition at line 2225 of file Decl.cpp.

References Init.

Referenced by evaluateVarDeclInit().

◆ getInit() [1/2]

const Expr* clang::VarDecl::getInit ( ) const
inline

Definition at line 1150 of file Decl.h.

Referenced by clang::Sema::ActOnOpenMPDeclareReductionInitializerEnd(), clang::CodeGen::CodeGenFunction::AddInitializerToStaticVarDecl(), clang::Sema::CheckCompleteVariableDeclaration(), checkElementNonNil(), clang::ASTContext::DeclMustBeEmitted(), DiagnoseForRangeConstVariableCopies(), DiagnoseForRangeReferenceVariableCopies(), DiagnoseForRangeVariableCopies(), DiagnoseUninitializedUse(), clang::CodeGen::CodeGenFunction::EmitAutoVarAlloca(), clang::CodeGen::CodeGenFunction::EmitAutoVarInit(), emitCombinerOrInitializer(), clang::CodeGen::CodeGenFunction::EmitCXXGlobalVarDeclInit(), EmitDeclInit(), clang::CodeGen::CodeGenFunction::EmitOMPFirstprivateClause(), clang::CodeGen::CodeGenFunction::EmitOMPLinearClauseInit(), clang::CodeGen::CodeGenFunction::EmitStaticVarDecl(), clang::CodeGen::CodeGenModule::EmitTentativeDefinition(), EvaluateVarDecl(), clang::CodeGen::CodeGenFunction::GenerateCXXGlobalVarDeclInitFunc(), clang::ParmVarDecl::getDefaultArg(), clang::CFGImplicitDtor::getDestructorDecl(), getExistingLazyBinding(), clang::CXXForRangeStmt::getRangeInit(), getSelfInitExpr(), getSourceRange(), clang::CodeGen::VarBypassDetector::Init(), InitCatchParam(), clang::Sema::InstantiateVariableInitializer(), isVarDeclStrongDefinition(), maybeRecoverWithZeroInitialization(), scanToNextArgument(), SuggestInitializationFixit(), tryCaptureAsConstant(), clang::CodeGen::ConstantEmitter::tryEmitPrivateForVarInit(), clang::ASTDeclReader::UpdateDecl(), clang::ASTDeclWriter::VisitParmVarDecl(), clang::ASTDeclWriter::VisitVarDecl(), and clang::consumed::ConsumedStmtVisitor::VisitVarDecl().

◆ getInit() [2/2]

Expr * VarDecl::getInit ( )

Definition at line 2088 of file Decl.cpp.

References hasInit().

◆ getInitAddress()

Stmt ** VarDecl::getInitAddress ( )

Retrieve the address of the initializer expression.

Definition at line 2098 of file Decl.cpp.

References Init.

Referenced by clang::StmtIteratorBase::GetDeclExpr().

◆ getInitStyle()

InitializationStyle clang::VarDecl::getInitStyle ( ) const
inline

The style of initialization for this declaration.

C-style initialization is "int x = 1;". Call-style initialization is a C++98 direct-initializer, e.g. "int x(1);". The Init expression will be the expression inside the parens or a "ClassType(a,b,c)" class constructor expression for class types. List-style initialization is C++11 syntax, e.g. "int x{1};". Clients can distinguish between different forms of initialization by checking this value. In particular, "int x = {1};" is C-style, "int x({1})" is call-style, and "int x{1};" is list-style; the Init expression in all three cases is an InitListExpr.

Definition at line 1209 of file Decl.h.

Referenced by clang::Sema::BuildVariableInstantiation(), clang::Sema::InstantiateVariableInitializer(), clang::ASTDeclWriter::VisitParmVarDecl(), and clang::ASTDeclWriter::VisitVarDecl().

◆ getInstantiatedFromStaticDataMember()

VarDecl * VarDecl::getInstantiatedFromStaticDataMember ( ) const

If this variable is an instantiated static data member of a class template specialization, returns the templated static data member from which it was instantiated.

Definition at line 2335 of file Decl.cpp.

References getMemberSpecializationInfo().

Referenced by getExplicitVisibilityAux(), getTemplateInstantiationPattern(), clang::Sema::InstantiateVariableDefinition(), isInstantiationOfStaticDataMember(), and isOutOfLine().

◆ getLanguageLinkage()

LanguageLinkage VarDecl::getLanguageLinkage ( ) const

Compute the language linkage.

Definition at line 1929 of file Decl.cpp.

References getDeclLanguageLinkage().

Referenced by clang::CodeGen::CodeGenModule::isTypeConstant().

◆ getMemberSpecializationInfo()

MemberSpecializationInfo * VarDecl::getMemberSpecializationInfo ( ) const

◆ getMostRecentDeclImpl()

VarDecl* clang::VarDecl::getMostRecentDeclImpl ( )
inlineoverrideprotectedvirtual

Implementation of getMostRecentDecl(), to be overridden by any subclass that has a redeclaration chain.

Reimplemented from clang::Decl.

Definition at line 926 of file Decl.h.

◆ getNextRedeclarationImpl()

VarDecl* clang::VarDecl::getNextRedeclarationImpl ( )
inlineoverrideprotectedvirtual

Returns the next redeclaration or itself if this is the only decl.

Decl subclasses that can be redeclared should override this method so that Decl::redecl_iterator can iterate over them.

Reimplemented from clang::Decl.

Definition at line 920 of file Decl.h.

◆ getPointOfInstantiation()

SourceLocation VarDecl::getPointOfInstantiation ( ) const

If this variable is an instantiation of a variable template or a static data member of a class template, determine its point of instantiation.

Definition at line 2352 of file Decl.cpp.

References getMemberSpecializationInfo().

Referenced by clang::Sema::InstantiateVariableDefinition().

◆ getPreviousDeclImpl()

VarDecl* clang::VarDecl::getPreviousDeclImpl ( )
inlineoverrideprotectedvirtual

Implementation of getPreviousDecl(), to be overridden by any subclass that has a redeclaration chain.

Reimplemented from clang::Decl.

Definition at line 923 of file Decl.h.

◆ getSourceRange()

SourceRange VarDecl::getSourceRange ( ) const
overridevirtual

◆ getStorageClass()

StorageClass clang::VarDecl::getStorageClass ( ) const
inline

◆ getStorageClassSpecifierString()

const char * VarDecl::getStorageClassSpecifierString ( StorageClass  SC)
static

getStorageClassSpecifierString - Return the string used to specify the storage class SC.

It is illegal to call this function with SC == None.

Definition at line 1807 of file Decl.cpp.

References clang::SC_Auto, clang::SC_Extern, clang::SC_None, clang::SC_PrivateExtern, clang::SC_Register, and clang::SC_Static.

◆ getStorageDuration()

StorageDuration clang::VarDecl::getStorageDuration ( ) const
inline

Get the storage duration of this variable, per C++ [basic.stc].

Definition at line 1012 of file Decl.h.

References isExternC(), clang::SD_Automatic, clang::SD_Static, and clang::SD_Thread.

Referenced by clang::CodeGen::CodeGenFunction::EmitVarDecl(), clang::ASTDeclWriter::VisitVarDecl(), and clang::ASTDeclReader::VisitVarDeclImpl().

◆ getTemplateInstantiationPattern()

VarDecl * VarDecl::getTemplateInstantiationPattern ( ) const

Retrieve the variable declaration from which this variable could be instantiated, if it is an instantiation (rather than a non-template).

Definition at line 2290 of file Decl.cpp.

References getDefinitionOrSelf(), getDescribedVarTemplate(), getInstantiatedFromStaticDataMember(), getMemberSpecializationInfo(), and clang::isTemplateInstantiation().

Referenced by getDefiningModule(), and clang::FunctionDecl::isImplicitlyInstantiable().

◆ getTemplateSpecializationKind()

TemplateSpecializationKind VarDecl::getTemplateSpecializationKind ( ) const

◆ getTLSKind()

VarDecl::TLSKind VarDecl::getTLSKind ( ) const

◆ getTSCSpec()

ThreadStorageClassSpecifier clang::VarDecl::getTSCSpec ( ) const
inline

◆ hasDefinition() [1/2]

VarDecl::DefinitionKind VarDecl::hasDefinition ( ASTContext C) const

◆ hasDefinition() [2/2]

DefinitionKind clang::VarDecl::hasDefinition ( ) const
inline

Definition at line 1096 of file Decl.h.

References hasDefinition().

Referenced by clang::TagDecl::completeDefinition().

◆ hasExternalStorage()

bool clang::VarDecl::hasExternalStorage ( ) const
inline

◆ hasGlobalStorage()

bool clang::VarDecl::hasGlobalStorage ( ) const
inline

Returns true for all variables that do not have local storage.

This includes all global variables as well as static variables declared within a function.

Definition at line 1009 of file Decl.h.

Referenced by clang::Sema::ActOnOpenMPIdExpression(), EmitDeclInit(), clang::Sema::FinalizeDeclaration(), clang::Sema::FinalizeVarWithDestructor(), clang::CodeGen::CodeGenModule::GetAddrOfGlobalVar(), clang::Sema::getShadowedDeclaration(), clang::ento::MemRegionManager::getVarRegion(), isAlwaysAlive(), clang::ento::isPossiblyEscaped(), and isTrackedVar().

◆ hasInit()

bool VarDecl::hasInit ( ) const

◆ hasLocalStorage()

bool clang::VarDecl::hasLocalStorage ( ) const
inline

◆ isARCPseudoStrong()

bool clang::VarDecl::isARCPseudoStrong ( ) const
inline

Determine whether this variable is an ARC pseudo-__strong variable.

A pseudo-__strong variable has a __strong-qualified type but does not actually retain the object written into it. Generally such variables are also 'const' for safety.

Definition at line 1276 of file Decl.h.

Referenced by clang::CodeGen::CodeGenFunction::emitAutoVarTypeCleanup(), clang::CodeGen::CodeGenFunction::EmitParmDecl(), clang::ASTDeclWriter::VisitParmVarDecl(), and clang::ASTDeclWriter::VisitVarDecl().

◆ isConstexpr()

bool clang::VarDecl::isConstexpr ( ) const
inline

◆ isCXXForRangeDecl()

bool clang::VarDecl::isCXXForRangeDecl ( ) const
inline

Determine whether this variable is the for-range-declaration in a C++0x for-range statement.

Definition at line 1264 of file Decl.h.

Referenced by clang::Sema::BuildVariableInstantiation(), clang::Sema::InstantiateVariableInitializer(), and clang::ASTDeclWriter::VisitVarDecl().

◆ isDirectInit()

bool clang::VarDecl::isDirectInit ( ) const
inline

Whether the initializer is a direct-initializer (list or call).

Definition at line 1213 of file Decl.h.

Referenced by clang::Sema::ActOnOpenMPDeclareReductionInitializerEnd(), and clang::Sema::InstantiateVariableInitializer().

◆ isExceptionVariable()

bool clang::VarDecl::isExceptionVariable ( ) const
inline

Determine whether this variable is the exception variable in a C++ catch statememt or an Objective-C @catch statement.

Definition at line 1236 of file Decl.h.

Referenced by clang::CodeGen::CodeGenFunction::EmitAutoVarAlloca(), isTrackedVar(), clang::ASTDeclWriter::VisitParmVarDecl(), and clang::ASTDeclWriter::VisitVarDecl().

◆ isExternC()

bool VarDecl::isExternC ( ) const

Determines whether this variable is a variable with external, C linkage.

Definition at line 1933 of file Decl.cpp.

References isDeclExternC().

Referenced by clang::FunctionDecl::getMemoryFunctionKind().

◆ isFileVarDecl()

bool clang::VarDecl::isFileVarDecl ( ) const
inline

isFileVarDecl - Returns true for file scoped variable declaration.

Definition at line 1124 of file Decl.h.

References getKind(), and isStaticDataMember().

Referenced by clang::ASTContext::DeclMustBeEmitted(), isThisDeclarationADefinition(), and clang::Sema::MergeVarDecl().

◆ isFunctionOrMethodVarDecl()

bool clang::VarDecl::isFunctionOrMethodVarDecl ( ) const
inline

isFunctionOrMethodVarDecl - Similar to isLocalVarDecl, but excludes variables declared in blocks.

Definition at line 1053 of file Decl.h.

References clang::DeclContext::getDeclKind(), getKind(), clang::DeclContext::getRedeclContext(), and clang::DeclContext::isFunctionOrMethod().

◆ isInExternCContext()

bool VarDecl::isInExternCContext ( ) const

Determines whether this variable's context is, or is nested within, a C++ extern "C" linkage spec.

Definition at line 1937 of file Decl.cpp.

References clang::Decl::getLexicalDeclContext(), and clang::DeclContext::isExternCContext().

◆ isInExternCXXContext()

bool VarDecl::isInExternCXXContext ( ) const

Determines whether this variable's context is, or is nested within, a C++ extern "C++" linkage spec.

Definition at line 1941 of file Decl.cpp.

References clang::Decl::getLexicalDeclContext(), and clang::DeclContext::isExternCXXContext().

◆ isInitCapture()

bool clang::VarDecl::isInitCapture ( ) const
inline

◆ isInitICE()

bool VarDecl::isInitICE ( ) const

Determines whether the initializer is an integral constant expression, or in C++11, whether the initializer is a constant expression.

Precondition
isInitKnownICE()

Definition at line 2240 of file Decl.cpp.

References Init, and isInitKnownICE().

Referenced by clang::ASTDeclWriter::VisitVarDecl().

◆ isInitKnownICE()

bool VarDecl::isInitKnownICE ( ) const

Determines whether it is already known whether the initializer is an integral constant expression or not.

Definition at line 2233 of file Decl.cpp.

References Init.

Referenced by isInitICE(), and clang::ASTDeclWriter::VisitVarDecl().

◆ isInline()

bool clang::VarDecl::isInline ( ) const
inline

◆ isInlineSpecified()

bool clang::VarDecl::isInlineSpecified ( ) const
inline

◆ isLocalVarDecl()

bool clang::VarDecl::isLocalVarDecl ( ) const
inline

isLocalVarDecl - Returns true for local variable declarations other than parameters.

Note that this includes static variables inside of functions. It also includes variables inside blocks.

void foo() { int x; static int y; extern int z; }

Definition at line 1038 of file Decl.h.

References getKind().

Referenced by clang::Sema::ActOnForStmt(), clang::Sema::AddInitializerToDecl(), clang::CodeGen::CodeGenFunction::EmitCXXGuardedInitBranch(), clang::CodeGen::CodeGenFunction::EmitDecl(), evaluateLValueAsAllocSize(), and isTrackedVar().

◆ isLocalVarDeclOrParm()

bool clang::VarDecl::isLocalVarDeclOrParm ( ) const
inline

Similar to isLocalVarDecl but also includes parameters.

Definition at line 1047 of file Decl.h.

References getKind().

Referenced by clang::CodeGen::CodeGenFunction::OMPPrivateScope::isGlobalVarCaptured(), and clang::Sema::MergeVarDecl().

◆ isNRVOVariable()

bool clang::VarDecl::isNRVOVariable ( ) const
inline

Determine whether this local variable can be used with the named return value optimization (NRVO).

The named return value optimization (NRVO) works by marking certain non-volatile local variables of class type as NRVO objects. These locals can be allocated within the return slot of their containing function, in which case there is no need to copy the object to the return slot when returning from the function. Within the function body, each return that returns the NRVO object will have this variable as its NRVO candidate.

Definition at line 1254 of file Decl.h.

Referenced by clang::CodeGen::CodeGenFunction::EmitAutoVarAlloca(), clang::ASTDeclWriter::VisitVarDecl(), and clang::TemplateDeclInstantiator::VisitVarDecl().

◆ isOutOfLine()

bool VarDecl::isOutOfLine ( ) const
overridevirtual

◆ isPreviousDeclInSameBlockScope()

bool clang::VarDecl::isPreviousDeclInSameBlockScope ( ) const
inline

Whether this local extern variable declaration's previous declaration was declared in the same block scope.

Only correct in C++.

Definition at line 1322 of file Decl.h.

Referenced by clang::Sema::BuildVariableInstantiation(), and clang::ASTDeclWriter::VisitVarDecl().

◆ isStaticDataMember()

bool clang::VarDecl::isStaticDataMember ( ) const
inline

◆ isStaticLocal()

bool clang::VarDecl::isStaticLocal ( ) const
inline

◆ isThisDeclarationADefinition() [1/2]

VarDecl::DefinitionKind VarDecl::isThisDeclarationADefinition ( ASTContext C) const

◆ isThisDeclarationADefinition() [2/2]

DefinitionKind clang::VarDecl::isThisDeclarationADefinition ( ) const
inline

Definition at line 1089 of file Decl.h.

References hasDefinition().

Referenced by getActingDefinition().

◆ isThisDeclarationADemotedDefinition()

bool clang::VarDecl::isThisDeclarationADemotedDefinition ( ) const
inline

If this definition should pretend to be a declaration.

Definition at line 1218 of file Decl.h.

Referenced by isThisDeclarationADefinition(), clang::ASTDeclWriter::VisitParmVarDecl(), and clang::ASTDeclWriter::VisitVarDecl().

◆ isUsableInConstantExpressions()

bool VarDecl::isUsableInConstantExpressions ( ASTContext C) const

Determine whether this variable's value can be used in a constant expression, according to the relevant language standard.

This only checks properties of the declaration, and does not check whether the initializer is in fact a constant expression.

Definition at line 2130 of file Decl.cpp.

References clang::ASTContext::getLangOpts(), clang::ValueDecl::getType(), and isConstexpr().

Referenced by clang::IsVariableAConstantExpression().

◆ setARCPseudoStrong()

void clang::VarDecl::setARCPseudoStrong ( bool  ps)
inline

Definition at line 1279 of file Decl.h.

Referenced by clang::Sema::ActOnForEachDeclStmt().

◆ setConstexpr()

void clang::VarDecl::setConstexpr ( bool  IC)
inline

Definition at line 1306 of file Decl.h.

Referenced by clang::Sema::BuildVariableInstantiation().

◆ setCXXForRangeDecl()

void clang::VarDecl::setCXXForRangeDecl ( bool  FRD)
inline

◆ setDescribedVarTemplate()

void VarDecl::setDescribedVarTemplate ( VarTemplateDecl Template)

◆ setExceptionVariable()

void clang::VarDecl::setExceptionVariable ( bool  EV)
inline

Definition at line 1239 of file Decl.h.

Referenced by clang::Sema::BuildObjCExceptionDecl().

◆ setImplicitlyInline()

void clang::VarDecl::setImplicitlyInline ( )
inline

◆ setInit()

void VarDecl::setInit ( Expr I)

◆ setInitCapture()

void clang::VarDecl::setInitCapture ( bool  IC)
inline

Definition at line 1315 of file Decl.h.

Referenced by clang::Sema::BuildVariableInstantiation().

◆ setInitStyle()

void clang::VarDecl::setInitStyle ( InitializationStyle  Style)
inline

Definition at line 1195 of file Decl.h.

References clang::format::Style.

Referenced by clang::Sema::BuildVariableInstantiation().

◆ setInlineSpecified()

void clang::VarDecl::setInlineSpecified ( )
inline

Definition at line 1292 of file Decl.h.

Referenced by clang::Sema::InstantiateVariableInitializer().

◆ setInstantiationOfStaticDataMember()

void VarDecl::setInstantiationOfStaticDataMember ( VarDecl VD,
TemplateSpecializationKind  TSK 
)

Specify that this variable is an instantiation of the static data member VD.

Definition at line 2403 of file Decl.cpp.

References clang::Decl::getASTContext(), and clang::ASTContext::setInstantiatedFromStaticDataMember().

Referenced by clang::Sema::BuildVariableInstantiation().

◆ setNRVOVariable()

void clang::VarDecl::setNRVOVariable ( bool  NRVO)
inline

Definition at line 1257 of file Decl.h.

◆ setPreviousDeclInSameBlockScope()

void clang::VarDecl::setPreviousDeclInSameBlockScope ( bool  Same)
inline

Definition at line 1327 of file Decl.h.

References getTemplateSpecializationKind().

Referenced by clang::Sema::BuildVariableInstantiation().

◆ setStorageClass()

void VarDecl::setStorageClass ( StorageClass  SC)

Definition at line 1850 of file Decl.cpp.

References clang::isLegalForVariable(), and VarDeclBits.

◆ setTemplateSpecializationKind()

void VarDecl::setTemplateSpecializationKind ( TemplateSpecializationKind  TSK,
SourceLocation  PointOfInstantiation = SourceLocation() 
)

For a static data member that was instantiated from a static data member of a class template, set the template specialiation kind.

Definition at line 2380 of file Decl.cpp.

References getMemberSpecializationInfo(), clang::SourceLocation::isValid(), and clang::TSK_ExplicitSpecialization.

Referenced by clang::Sema::CheckVarTemplateId(), getVarTemplateSpecialization(), and clang::Sema::InstantiateVariableDefinition().

◆ setTSCSpec()

void clang::VarDecl::setTSCSpec ( ThreadStorageClassSpecifier  TSC)
inline

Definition at line 956 of file Decl.h.

Referenced by clang::Sema::BuildVariableInstantiation().

Friends And Related Function Documentation

◆ ASTDeclReader

friend class ASTDeclReader
friend

Definition at line 809 of file Decl.h.

◆ ASTNodeImporter

friend class ASTNodeImporter
friend

Definition at line 811 of file Decl.h.

◆ StmtIteratorBase

friend class StmtIteratorBase
friend

Definition at line 810 of file Decl.h.

Member Data Documentation

◆ @22

union { ... }

◆ AllBits

unsigned clang::VarDecl::AllBits

Definition at line 909 of file Decl.h.

Referenced by VarDecl().

◆ Init

InitType clang::VarDecl::Init
mutableprotected

◆ NonParmVarDeclBits

NonParmVarDeclBitfields clang::VarDecl::NonParmVarDeclBits

Definition at line 912 of file Decl.h.

Referenced by clang::ASTDeclReader::VisitVarDeclImpl().

◆ ParmVarDeclBits

ParmVarDeclBitfields clang::VarDecl::ParmVarDeclBits

◆ VarDeclBits

VarDeclBitfields clang::VarDecl::VarDeclBits

The documentation for this class was generated from the following files: