clang  3.9.0
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 <Decl.h>

Inheritance diagram for clang::VarDecl:
[legend]
Collaboration diagram for clang::VarDecl:
[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::Redeclarable< VarDecl >
typedef llvm::iterator_range
< redecl_iterator > 
redecl_range
 

Public Member Functions

SourceRange getSourceRange () const override LLVM_READONLY
 
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
 
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 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)
 
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...
 
SourceRange getSourceRange () const override LLVM_READONLY
 
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...
 
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 isHidden () const
 Determine whether this declaration is hidden from name lookup. More...
 
void setHidden (bool Hide)
 Set whether this declaration is hidden from name lookup. 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...
 
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::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)
 

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
 
VarDeclgetPreviousDeclImpl () override
 
VarDeclgetMostRecentDeclImpl () override
 
- 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::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::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 768 of file Decl.h.

Member Typedef Documentation

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

Definition at line 798 of file Decl.h.

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

Definition at line 928 of file Decl.h.

Definition at line 927 of file Decl.h.

Definition at line 915 of file Decl.h.

Member Enumeration Documentation

anonymous enum
protected
Enumerator
NumParameterIndexBits 

Definition at line 820 of file Decl.h.

Enumerator
DAK_None 
DAK_Unparsed 
DAK_Uninstantiated 
DAK_Normal 

Definition at line 822 of file Decl.h.

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 1068 of file Decl.h.

Initialization styles.

Enumerator
CInit 

C-style initialization with assignment.

CallInit 

Call-style initialization (C++98)

ListInit 

Direct list-initialization (C++11)

Definition at line 777 of file Decl.h.

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 784 of file Decl.h.

Constructor & Destructor Documentation

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

Definition at line 1783 of file Decl.cpp.

References AllBits, and VarDeclBits.

Referenced by Create(), and CreateDeserialized().

Member Function Documentation

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

Definition at line 1351 of file Decl.h.

References classofKind().

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

Definition at line 1352 of file Decl.h.

Referenced by classof().

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

Definition at line 1807 of file Decl.cpp.

References ID, clang::SC_None, and VarDecl().

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 2120 of file Decl.cpp.

References Init, and clang::EvaluatedStmt::Value.

Referenced by checkInitIsICE(), evaluateValue(), IsVariableNonDependentAndAConstantExpression(), VariableCanNeverBeAConstantExpression(), clang::ASTNodeImporter::VisitVarDecl(), and clang::ASTDeclReader::VisitVarDeclImpl().

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 2134 of file Decl.cpp.

Referenced by clang::Sema::CheckCompleteVariableDeclaration(), checkInitIsICE(), clang::ASTContext::DeclMustBeEmitted(), clang::CodeGen::CodeGenModule::EmitConstantInit(), and evaluateVarDeclInit().

APValue * VarDecl::evaluateValue ( SmallVectorImpl< PartialDiagnosticAt > &  Notes) const
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 1991 of file Decl.cpp.

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

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), getActingDefinition(), and getDefinition().

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

Definition at line 1092 of file Decl.h.

References getActingDefinition().

const Expr* clang::VarDecl::getAnyInitializer ( ) const
inline
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 2030 of file Decl.cpp.

References I, and clang::Redeclarable< VarDecl >::redecls().

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

Definition at line 1064 of file Decl.h.

References getCanonicalDecl().

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

Definition at line 1098 of file Decl.h.

References getDefinition().

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

Definition at line 1104 of file Decl.h.

References getDefinition().

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 2276 of file Decl.cpp.

Referenced by clang::Sema::ActOnVariableDeclarator(), clang::Sema::AddInitializerToDecl(), clang::Sema::BuildVarTemplateInstantiation(), clang::Sema::FinalizeDeclaration(), clang::Sema::MergeVarDecl(), clang::ASTDeclWriter::VisitVarDecl(), and clang::ASTNodeImporter::VisitVarTemplateDecl().

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 2192 of file Decl.cpp.

References Init.

Referenced by evaluateVarDeclInit().

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

Definition at line 1139 of file Decl.h.

Referenced by clang::Sema::ActOnOpenMPReductionClause(), clang::Sema::AddInitializerToDecl(), clang::CodeGen::CodeGenFunction::AddInitializerToStaticVarDecl(), clang::Sema::BuildCXXDefaultArgExpr(), clang::Sema::BuildDeclaratorGroup(), clang::Sema::buildInitCaptureField(), clang::Sema::CheckCompleteVariableDeclaration(), checkElementNonNil(), clang::ASTContext::DeclMustBeEmitted(), DiagnoseForRangeConstVariableCopies(), DiagnoseForRangeReferenceVariableCopies(), DiagnoseForRangeVariableCopies(), DiagnoseUninitializedUse(), clang::CodeGen::CodeGenFunction::EmitAutoVarAlloca(), clang::CodeGen::CodeGenFunction::EmitAutoVarInit(), clang::CodeGen::CodeGenModule::EmitConstantInit(), clang::CodeGen::CodeGenFunction::EmitCXXGlobalVarDeclInit(), EmitDeclInit(), clang::CodeGen::CodeGenFunction::EmitOMPFirstprivateClause(), clang::CodeGen::CodeGenFunction::EmitOMPLinearClauseInit(), clang::CodeGen::CodeGenFunction::EmitStaticVarDecl(), clang::CodeGen::CodeGenModule::EmitTentativeDefinition(), clang::Sema::FinalizeDeclaration(), clang::CodeGen::CodeGenFunction::GenerateCXXGlobalVarDeclInitFunc(), clang::ParmVarDecl::getDefaultArg(), clang::ParmVarDecl::getDefaultArgRange(), clang::CFGImplicitDtor::getDestructorDecl(), clang::CXXForRangeStmt::getRangeInit(), getSelfInitExpr(), getSourceRange(), InitCatchParam(), clang::Sema::InstantiateVariableInitializer(), isVarDeclStrongDefinition(), maybeRecoverWithZeroInitialization(), clang::Sema::MergeCXXFunctionDecl(), SuggestInitializationFixit(), tryCaptureAsConstant(), clang::ento::ExprEngine::VisitDeclStmt(), clang::ento::FindLastStoreBRVisitor::VisitNode(), clang::ento::ExprEngine::VisitObjCForCollectionStmt(), clang::ASTDeclWriter::VisitParmVarDecl(), clang::ASTDeclWriter::VisitVarDecl(), and clang::consumed::ConsumedStmtVisitor::VisitVarDecl().

Expr * VarDecl::getInit ( )

Definition at line 2048 of file Decl.cpp.

References hasInit(), Init, and S.

Stmt ** VarDecl::getInitAddress ( )

Retrieve the address of the initializer expression.

Definition at line 2058 of file Decl.cpp.

References Init.

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

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 1198 of file Decl.h.

References VarDeclBits.

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

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 2249 of file Decl.cpp.

References getMemberSpecializationInfo().

Referenced by clang::Sema::ActOnExplicitInstantiation(), clang::Sema::CheckMemberSpecialization(), getExplicitVisibilityAux(), clang::Sema::InstantiateClassMembers(), clang::Sema::InstantiateVariableDefinition(), isInstantiationOfStaticDataMember(), and isOutOfLine().

LanguageLinkage VarDecl::getLanguageLinkage ( ) const

Compute the language linkage.

Definition at line 1892 of file Decl.cpp.

References getDeclLanguageLinkage().

MemberSpecializationInfo * VarDecl::getMemberSpecializationInfo ( ) const

If this variable is an instantiation of a static data member of a class template specialization, retrieves the member specialization information.

Definition at line 2285 of file Decl.cpp.

References isStaticDataMember().

Referenced by clang::Sema::CheckMemberSpecialization(), getInstantiatedFromStaticDataMember(), getPointOfInstantiation(), getTemplateSpecializationKind(), clang::Sema::InstantiateClassMembers(), setTemplateSpecializationKind(), and clang::ASTDeclWriter::VisitVarDecl().

VarDecl* clang::VarDecl::getMostRecentDeclImpl ( )
inlineoverrideprotected

Definition at line 922 of file Decl.h.

References clang::Redeclarable< VarDecl >::getMostRecentDecl().

VarDecl* clang::VarDecl::getNextRedeclarationImpl ( )
inlineoverrideprotected

Definition at line 916 of file Decl.h.

References clang::Redeclarable< VarDecl >::getNextRedeclaration().

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 2266 of file Decl.cpp.

References getMemberSpecializationInfo().

Referenced by clang::Sema::ActOnExplicitInstantiation(), DoMarkVarDeclReferenced(), and clang::Sema::InstantiateVariableDefinition().

VarDecl* clang::VarDecl::getPreviousDeclImpl ( )
inlineoverrideprotected

Definition at line 919 of file Decl.h.

References clang::Redeclarable< VarDecl >::getPreviousDecl().

SourceRange VarDecl::getSourceRange ( ) const
override
StorageClass clang::VarDecl::getStorageClass ( ) const
inline
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 1770 of file Decl.cpp.

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

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

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

Definition at line 1001 of file Decl.h.

References getTSCSpec(), hasLocalStorage(), clang::SD_Automatic, clang::SD_Static, and clang::SD_Thread.

TemplateSpecializationKind VarDecl::getTemplateSpecializationKind ( ) const
VarDecl::TLSKind VarDecl::getTLSKind ( ) const
ThreadStorageClassSpecifier clang::VarDecl::getTSCSpec ( ) const
inline
VarDecl::DefinitionKind VarDecl::hasDefinition ( ASTContext C) const

Check whether this variable is defined in this translation unit.

Definition at line 2017 of file Decl.cpp.

References DeclarationOnly, Definition, clang::Redeclarable< VarDecl >::First, clang::Redeclarable< VarDecl >::getFirstDecl(), I, max(), and clang::Redeclarable< decl_type >::redecls().

Referenced by findCompleteObject(), and clang::MarkVarDeclODRUsed().

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

Definition at line 1085 of file Decl.h.

bool clang::VarDecl::hasExternalStorage ( ) const
inline
bool clang::VarDecl::hasGlobalStorage ( ) const
inline
bool VarDecl::hasInit ( ) const
bool clang::VarDecl::hasLocalStorage ( ) const
inline
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 1249 of file Decl.h.

References NonParmVarDeclBits.

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

bool clang::VarDecl::isConstexpr ( ) const
inline
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 1237 of file Decl.h.

References NonParmVarDeclBits.

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

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

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

Definition at line 1203 of file Decl.h.

References CInit, and getInitStyle().

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

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 1209 of file Decl.h.

References NonParmVarDeclBits.

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

bool VarDecl::isExternC ( ) const

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

Definition at line 1896 of file Decl.cpp.

References isDeclExternC().

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

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

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

Definition at line 1042 of file Decl.h.

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

bool VarDecl::isInExternCContext ( ) const

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

Definition at line 1900 of file Decl.cpp.

bool VarDecl::isInExternCXXContext ( ) const

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

Definition at line 1904 of file Decl.cpp.

bool clang::VarDecl::isInitCapture ( ) const
inline
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 2207 of file Decl.cpp.

References Init, and isInitKnownICE().

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

bool VarDecl::isInitKnownICE ( ) const

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

Definition at line 2200 of file Decl.cpp.

References Init.

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

bool clang::VarDecl::isInline ( ) const
inline
bool clang::VarDecl::isInlineSpecified ( ) const
inline
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 1027 of file Decl.h.

References getKind().

Referenced by clang::Sema::ActOnForStmt(), clang::Sema::ActOnVariableDeclarator(), clang::Sema::AddInitializerToDecl(), clang::CodeGen::CodeGenFunction::EmitDecl(), isLocalVarDeclOrParm(), isTrackedVar(), and clang::Sema::MergeVarDeclTypes().

bool clang::VarDecl::isLocalVarDeclOrParm ( ) const
inline
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 1227 of file Decl.h.

References NonParmVarDeclBits.

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

bool VarDecl::isOutOfLine ( ) const
override
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 1295 of file Decl.h.

References NonParmVarDeclBits.

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

bool clang::VarDecl::isStaticDataMember ( ) const
inline
bool clang::VarDecl::isStaticLocal ( ) const
inline
VarDecl::DefinitionKind VarDecl::isThisDeclarationADefinition ( ASTContext C) const
DefinitionKind clang::VarDecl::isThisDeclarationADefinition ( ) const
inline

Definition at line 1078 of file Decl.h.

Referenced by getActingDefinition().

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 2090 of file Decl.cpp.

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

Referenced by clang::Sema::CheckCompleteVariableDeclaration(), DoMarkVarDeclReferenced(), and clang::IsVariableAConstantExpression().

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

Definition at line 1252 of file Decl.h.

References NonParmVarDeclBits.

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

void clang::VarDecl::setConstexpr ( bool  IC)
inline
void clang::VarDecl::setCXXForRangeDecl ( bool  FRD)
inline
void VarDecl::setDescribedVarTemplate ( VarTemplateDecl Template)
void clang::VarDecl::setExceptionVariable ( bool  EV)
inline
void clang::VarDecl::setImplicitlyInline ( )
inline
void VarDecl::setInit ( Expr I)
void clang::VarDecl::setInitCapture ( bool  IC)
inline
void clang::VarDecl::setInitStyle ( InitializationStyle  Style)
inline
void clang::VarDecl::setInlineSpecified ( )
inline
void VarDecl::setInstantiationOfStaticDataMember ( VarDecl VD,
TemplateSpecializationKind  TSK 
)

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

Definition at line 2317 of file Decl.cpp.

Referenced by clang::Sema::ActOnVarTemplateSpecialization(), and clang::Sema::BuildVariableInstantiation().

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

Definition at line 1230 of file Decl.h.

References NonParmVarDeclBits.

void clang::VarDecl::setPreviousDeclInSameBlockScope ( bool  Same)
inline
void VarDecl::setStorageClass ( StorageClass  SC)

Definition at line 1813 of file Decl.cpp.

References clang::isLegalForVariable(), and VarDeclBits.

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

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 2294 of file Decl.cpp.

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

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

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

Definition at line 952 of file Decl.h.

References VarDeclBits.

Referenced by clang::Sema::ActOnVariableDeclarator(), and clang::Sema::BuildVariableInstantiation().

Friends And Related Function Documentation

friend class ASTDeclReader
friend

Definition at line 815 of file Decl.h.

friend class ASTNodeImporter
friend

Definition at line 817 of file Decl.h.

friend class StmtIteratorBase
friend

Definition at line 816 of file Decl.h.

Member Data Documentation

union { ... }
unsigned clang::VarDecl::AllBits

Definition at line 905 of file Decl.h.

Referenced by VarDecl().

InitType clang::VarDecl::Init
mutableprotected
NonParmVarDeclBitfields clang::VarDecl::NonParmVarDeclBits
ParmVarDeclBitfields clang::VarDecl::ParmVarDeclBits
VarDeclBitfields clang::VarDecl::VarDeclBits

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