A reference to a declared variable, function, enum, etc. More...

#include "clang/AST/Expr.h"

Inheritance diagram for clang::DeclRefExpr:

[legend]

Collaboration diagram for clang::DeclRefExpr:

[legend]

Public Member Functions
	DeclRefExpr (const ASTContext &Ctx, ValueDecl *D, bool RefersToEnclosingVariableOrCapture, QualType T, ExprValueKind VK, SourceLocation L, const DeclarationNameLoc &LocInfo=DeclarationNameLoc(), NonOdrUseReason NOUR=NOUR_None)

ValueDecl *	getDecl ()

const ValueDecl *	getDecl () const

void	setDecl (ValueDecl *NewD)

DeclarationNameInfo	getNameInfo () const

SourceLocation	getLocation () const

void	setLocation (SourceLocation L)

SourceLocation	getBeginLoc () const LLVM_READONLY

SourceLocation	getEndLoc () const LLVM_READONLY

bool	hasQualifier () const
	Determine whether this declaration reference was preceded by a C++ nested-name-specifier, e.g., `N::foo`.

NestedNameSpecifierLoc	getQualifierLoc () const
	If the name was qualified, retrieves the nested-name-specifier that precedes the name, with source-location information.

NestedNameSpecifier *	getQualifier () const
	If the name was qualified, retrieves the nested-name-specifier that precedes the name.

NamedDecl *	getFoundDecl ()
	Get the NamedDecl through which this reference occurred.

const NamedDecl *	getFoundDecl () const
	Get the NamedDecl through which this reference occurred.

bool	hasTemplateKWAndArgsInfo () const

SourceLocation	getTemplateKeywordLoc () const
	Retrieve the location of the template keyword preceding this name, if any.

SourceLocation	getLAngleLoc () const
	Retrieve the location of the left angle bracket starting the explicit template argument list following the name, if any.

SourceLocation	getRAngleLoc () const
	Retrieve the location of the right angle bracket ending the explicit template argument list following the name, if any.

bool	hasTemplateKeyword () const
	Determines whether the name in this declaration reference was preceded by the template keyword.

bool	hasExplicitTemplateArgs () const
	Determines whether this declaration reference was followed by an explicit template argument list.

void	copyTemplateArgumentsInto (TemplateArgumentListInfo &List) const
	Copies the template arguments (if present) into the given structure.

const TemplateArgumentLoc *	getTemplateArgs () const
	Retrieve the template arguments provided as part of this template-id.

unsigned	getNumTemplateArgs () const
	Retrieve the number of template arguments provided as part of this template-id.

ArrayRef< TemplateArgumentLoc >	template_arguments () const

bool	hadMultipleCandidates () const
	Returns true if this expression refers to a function that was resolved from an overloaded set having size greater than 1.

void	setHadMultipleCandidates (bool V=true)
	Sets the flag telling whether this expression refers to a function that was resolved from an overloaded set having size greater than 1.

NonOdrUseReason	isNonOdrUse () const
	Is this expression a non-odr-use reference, and if so, why?

bool	refersToEnclosingVariableOrCapture () const
	Does this DeclRefExpr refer to an enclosing local or a captured variable?

child_range	children ()

const_child_range	children () const

Public Member Functions inherited from clang::Expr
	Expr ()=delete

	Expr (const Expr &)=delete

	Expr (Expr &&)=delete

Expr &	operator= (const Expr &)=delete

Expr &	operator= (Expr &&)=delete

QualType	getType () const

void	setType (QualType t)

ExprDependence	getDependence () const

bool	isValueDependent () const
	Determines whether the value of this expression depends on.

bool	isTypeDependent () const
	Determines whether the type of this expression depends on.

bool	isInstantiationDependent () const
	Whether this expression is instantiation-dependent, meaning that it depends in some way on.

bool	containsUnexpandedParameterPack () const
	Whether this expression contains an unexpanded parameter pack (for C++11 variadic templates).

bool	containsErrors () const
	Whether this expression contains subexpressions which had errors, e.g.

SourceLocation	getExprLoc () const LLVM_READONLY
	getExprLoc - Return the preferred location for the arrow when diagnosing a problem with a generic expression.

bool	isReadIfDiscardedInCPlusPlus11 () const
	Determine whether an lvalue-to-rvalue conversion should implicitly be applied to this expression if it appears as a discarded-value expression in C++11 onwards.

bool	isUnusedResultAWarning (const Expr *&WarnExpr, SourceLocation &Loc, SourceRange &R1, SourceRange &R2, ASTContext &Ctx) const
	isUnusedResultAWarning - Return true if this immediate expression should be warned about if the result is unused.

bool	isLValue () const
	isLValue - True if this expression is an "l-value" according to the rules of the current language.

bool	isPRValue () const

bool	isXValue () const

bool	isGLValue () const

LValueClassification	ClassifyLValue (ASTContext &Ctx) const
	Reasons why an expression might not be an l-value.

isModifiableLvalueResult	isModifiableLvalue (ASTContext &Ctx, SourceLocation *Loc=nullptr) const
	isModifiableLvalue - C99 6.3.2.1: an lvalue that does not have array type, does not have an incomplete type, does not have a const-qualified type, and if it is a structure or union, does not have any member (including, recursively, any member or element of all contained aggregates or unions) with a const-qualified type.

Classification	Classify (ASTContext &Ctx) const
	Classify - Classify this expression according to the C++11 expression taxonomy.

Classification	ClassifyModifiable (ASTContext &Ctx, SourceLocation &Loc) const
	ClassifyModifiable - Classify this expression according to the C++11 expression taxonomy, and see if it is valid on the left side of an assignment.

FPOptions	getFPFeaturesInEffect (const LangOptions &LO) const
	Returns the set of floating point options that apply to this expression.

ExprValueKind	getValueKind () const
	getValueKind - The value kind that this expression produces.

ExprObjectKind	getObjectKind () const
	getObjectKind - The object kind that this expression produces.

bool	isOrdinaryOrBitFieldObject () const

void	setValueKind (ExprValueKind Cat)
	setValueKind - Set the value kind produced by this expression.

void	setObjectKind (ExprObjectKind Cat)
	setObjectKind - Set the object kind produced by this expression.

bool	refersToBitField () const
	Returns true if this expression is a gl-value that potentially refers to a bit-field.

FieldDecl *	getSourceBitField ()
	If this expression refers to a bit-field, retrieve the declaration of that bit-field.

const FieldDecl *	getSourceBitField () const

Decl *	getReferencedDeclOfCallee ()

const Decl *	getReferencedDeclOfCallee () const

const ObjCPropertyRefExpr *	getObjCProperty () const
	If this expression is an l-value for an Objective C property, find the underlying property reference expression.

bool	isObjCSelfExpr () const
	Check if this expression is the ObjC 'self' implicit parameter.

bool	refersToVectorElement () const
	Returns whether this expression refers to a vector element.

bool	refersToMatrixElement () const
	Returns whether this expression refers to a matrix element.

bool	refersToGlobalRegisterVar () const
	Returns whether this expression refers to a global register variable.

bool	hasPlaceholderType () const
	Returns whether this expression has a placeholder type.

bool	hasPlaceholderType (BuiltinType::Kind K) const
	Returns whether this expression has a specific placeholder type.

bool	isKnownToHaveBooleanValue (bool Semantic=true) const
	isKnownToHaveBooleanValue - Return true if this is an integer expression that is known to return 0 or 1.

bool	isFlexibleArrayMemberLike (ASTContext &Context, LangOptions::StrictFlexArraysLevelKind StrictFlexArraysLevel, bool IgnoreTemplateOrMacroSubstitution=false) const
	Check whether this array fits the idiom of a flexible array member, depending on the value of -fstrict-flex-array.

std::optional< llvm::APSInt >	getIntegerConstantExpr (const ASTContext &Ctx, SourceLocation *Loc=nullptr, bool isEvaluated=true) const
	isIntegerConstantExpr - Return the value if this expression is a valid integer constant expression.

bool	isIntegerConstantExpr (const ASTContext &Ctx, SourceLocation *Loc=nullptr) const

bool	isCXX98IntegralConstantExpr (const ASTContext &Ctx) const
	isCXX98IntegralConstantExpr - Return true if this expression is an integral constant expression in C++98.

bool	isCXX11ConstantExpr (const ASTContext &Ctx, APValue Result=nullptr, SourceLocation Loc=nullptr) const
	isCXX11ConstantExpr - Return true if this expression is a constant expression in C++11.

bool	isConstantInitializer (ASTContext &Ctx, bool ForRef, const Expr **Culprit=nullptr) const
	isConstantInitializer - Returns true if this expression can be emitted to IR as a constant, and thus can be used as a constant initializer in C.

const ValueDecl *	getAsBuiltinConstantDeclRef (const ASTContext &Context) const
	If this expression is an unambiguous reference to a single declaration, in the style of __builtin_function_start, return that declaration.

bool	EvaluateAsRValue (EvalResult &Result, const ASTContext &Ctx, bool InConstantContext=false) const
	EvaluateAsRValue - Return true if this is a constant which we can fold to an rvalue using any crazy technique (that has nothing to do with language standards) that we want to, even if the expression has side-effects.

bool	EvaluateAsBooleanCondition (bool &Result, const ASTContext &Ctx, bool InConstantContext=false) const
	EvaluateAsBooleanCondition - Return true if this is a constant which we can fold and convert to a boolean condition using any crazy technique that we want to, even if the expression has side-effects.

bool	EvaluateAsInt (EvalResult &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects, bool InConstantContext=false) const
	EvaluateAsInt - Return true if this is a constant which we can fold and convert to an integer, using any crazy technique that we want to.

bool	EvaluateAsFloat (llvm::APFloat &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects, bool InConstantContext=false) const
	EvaluateAsFloat - Return true if this is a constant which we can fold and convert to a floating point value, using any crazy technique that we want to.

bool	EvaluateAsFixedPoint (EvalResult &Result, const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects, bool InConstantContext=false) const
	EvaluateAsFixedPoint - Return true if this is a constant which we can fold and convert to a fixed point value.

bool	isEvaluatable (const ASTContext &Ctx, SideEffectsKind AllowSideEffects=SE_NoSideEffects) const
	isEvaluatable - Call EvaluateAsRValue to see if this expression can be constant folded without side-effects, but discard the result.

bool	HasSideEffects (const ASTContext &Ctx, bool IncludePossibleEffects=true) const
	HasSideEffects - This routine returns true for all those expressions which have any effect other than producing a value.

bool	hasNonTrivialCall (const ASTContext &Ctx) const
	Determine whether this expression involves a call to any function that is not trivial.

llvm::APSInt	EvaluateKnownConstInt (const ASTContext &Ctx, SmallVectorImpl< PartialDiagnosticAt > *Diag=nullptr) const
	EvaluateKnownConstInt - Call EvaluateAsRValue and return the folded integer.

llvm::APSInt	EvaluateKnownConstIntCheckOverflow (const ASTContext &Ctx, SmallVectorImpl< PartialDiagnosticAt > *Diag=nullptr) const

void	EvaluateForOverflow (const ASTContext &Ctx) const

bool	EvaluateAsLValue (EvalResult &Result, const ASTContext &Ctx, bool InConstantContext=false) const
	EvaluateAsLValue - Evaluate an expression to see if we can fold it to an lvalue with link time known address, with no side-effects.

bool	EvaluateAsInitializer (APValue &Result, const ASTContext &Ctx, const VarDecl *VD, SmallVectorImpl< PartialDiagnosticAt > &Notes, bool IsConstantInitializer) const
	EvaluateAsInitializer - Evaluate an expression as if it were the initializer of the given declaration.

bool	EvaluateWithSubstitution (APValue &Value, ASTContext &Ctx, const FunctionDecl Callee, ArrayRef< const Expr > Args, const Expr *This=nullptr) const
	EvaluateWithSubstitution - Evaluate an expression as if from the context of a call to the given function with the given arguments, inside an unevaluated context.

bool	EvaluateAsConstantExpr (EvalResult &Result, const ASTContext &Ctx, ConstantExprKind Kind=ConstantExprKind::Normal) const
	Evaluate an expression that is required to be a constant expression.

bool	tryEvaluateObjectSize (uint64_t &Result, ASTContext &Ctx, unsigned Type) const
	If the current Expr is a pointer, this will try to statically determine the number of bytes available where the pointer is pointing.

bool	tryEvaluateStrLen (uint64_t &Result, ASTContext &Ctx) const
	If the current Expr is a pointer, this will try to statically determine the strlen of the string pointed to.

NullPointerConstantKind	isNullPointerConstant (ASTContext &Ctx, NullPointerConstantValueDependence NPC) const
	isNullPointerConstant - C99 6.3.2.3p3 - Test if this reduces down to a Null pointer constant.

bool	isOBJCGCCandidate (ASTContext &Ctx) const
	isOBJCGCCandidate - Return true if this expression may be used in a read/ write barrier.

bool	isBoundMemberFunction (ASTContext &Ctx) const
	Returns true if this expression is a bound member function.

Expr *	IgnoreUnlessSpelledInSource ()
	Skip past any invisble AST nodes which might surround this statement, such as ExprWithCleanups or ImplicitCastExpr nodes, but also injected CXXMemberExpr and CXXConstructExpr which represent implicit conversions.

const Expr *	IgnoreUnlessSpelledInSource () const

Expr *	IgnoreImpCasts () LLVM_READONLY
	Skip past any implicit casts which might surround this expression until reaching a fixed point.

const Expr *	IgnoreImpCasts () const

Expr *	IgnoreCasts () LLVM_READONLY
	Skip past any casts which might surround this expression until reaching a fixed point.

const Expr *	IgnoreCasts () const

Expr *	IgnoreImplicit () LLVM_READONLY
	Skip past any implicit AST nodes which might surround this expression until reaching a fixed point.

const Expr *	IgnoreImplicit () const

Expr *	IgnoreImplicitAsWritten () LLVM_READONLY
	Skip past any implicit AST nodes which might surround this expression until reaching a fixed point.

const Expr *	IgnoreImplicitAsWritten () const

Expr *	IgnoreParens () LLVM_READONLY
	Skip past any parentheses which might surround this expression until reaching a fixed point.

const Expr *	IgnoreParens () const

Expr *	IgnoreParenImpCasts () LLVM_READONLY
	Skip past any parentheses and implicit casts which might surround this expression until reaching a fixed point.

const Expr *	IgnoreParenImpCasts () const

Expr *	IgnoreParenCasts () LLVM_READONLY
	Skip past any parentheses and casts which might surround this expression until reaching a fixed point.

const Expr *	IgnoreParenCasts () const

Expr *	IgnoreConversionOperatorSingleStep () LLVM_READONLY
	Skip conversion operators.

const Expr *	IgnoreConversionOperatorSingleStep () const

Expr *	IgnoreParenLValueCasts () LLVM_READONLY
	Skip past any parentheses and lvalue casts which might surround this expression until reaching a fixed point.

const Expr *	IgnoreParenLValueCasts () const

Expr *	IgnoreParenNoopCasts (const ASTContext &Ctx) LLVM_READONLY
	Skip past any parenthese and casts which do not change the value (including ptr->int casts of the same size) until reaching a fixed point.

const Expr *	IgnoreParenNoopCasts (const ASTContext &Ctx) const

Expr *	IgnoreParenBaseCasts () LLVM_READONLY
	Skip past any parentheses and derived-to-base casts until reaching a fixed point.

const Expr *	IgnoreParenBaseCasts () const

bool	isDefaultArgument () const
	Determine whether this expression is a default function argument.

bool	isTemporaryObject (ASTContext &Ctx, const CXXRecordDecl *TempTy) const
	Determine whether the result of this expression is a temporary object of the given class type.

bool	isImplicitCXXThis () const
	Whether this expression is an implicit reference to 'this' in C++.

const CXXRecordDecl *	getBestDynamicClassType () const
	For an expression of class type or pointer to class type, return the most derived class decl the expression is known to refer to.

const Expr *	getBestDynamicClassTypeExpr () const
	Get the inner expression that determines the best dynamic class.

const Expr *	skipRValueSubobjectAdjustments (SmallVectorImpl< const Expr * > &CommaLHS, SmallVectorImpl< SubobjectAdjustment > &Adjustments) const
	Walk outwards from an expression we want to bind a reference to and find the expression whose lifetime needs to be extended.

const Expr *	skipRValueSubobjectAdjustments () const

Public Member Functions inherited from clang::ValueStmt
const Expr *	getExprStmt () const

Expr *	getExprStmt ()

Public Member Functions inherited from clang::Stmt
void *	operator new (size_t bytes, const ASTContext &C, unsigned alignment=8)

void *	operator new (size_t bytes, const ASTContext *C, unsigned alignment=8)

void *	operator new (size_t bytes, void *mem) noexcept

void	operator delete (void *, const ASTContext &, unsigned) noexcept

void	operator delete (void , const ASTContext , unsigned) noexcept

void	operator delete (void *, size_t) noexcept

void	operator delete (void , void ) noexcept

	Stmt ()=delete

	Stmt (const Stmt &)=delete

	Stmt (Stmt &&)=delete

Stmt &	operator= (const Stmt &)=delete

Stmt &	operator= (Stmt &&)=delete

	Stmt (StmtClass SC)

StmtClass	getStmtClass () const

const char *	getStmtClassName () const

SourceRange	getSourceRange () const LLVM_READONLY
	SourceLocation tokens are not useful in isolation - they are low level value objects created/interpreted by SourceManager.

SourceLocation	getBeginLoc () const LLVM_READONLY

SourceLocation	getEndLoc () const LLVM_READONLY

void	dump () const
	Dumps the specified AST fragment and all subtrees to `llvm::errs()`.

void	dump (raw_ostream &OS, const ASTContext &Context) const

int64_t	getID (const ASTContext &Context) const

void	dumpColor () const
	dumpColor - same as dump(), but forces color highlighting.

void	dumpPretty (const ASTContext &Context) const
	dumpPretty/printPretty - These two methods do a "pretty print" of the AST back to its original source language syntax.

void	printPretty (raw_ostream &OS, PrinterHelper Helper, const PrintingPolicy &Policy, unsigned Indentation=0, StringRef NewlineSymbol="\n", const ASTContext Context=nullptr) const

void	printPrettyControlled (raw_ostream &OS, PrinterHelper Helper, const PrintingPolicy &Policy, unsigned Indentation=0, StringRef NewlineSymbol="\n", const ASTContext Context=nullptr) const

void	printJson (raw_ostream &Out, PrinterHelper *Helper, const PrintingPolicy &Policy, bool AddQuotes) const
	Pretty-prints in JSON format.

void	viewAST () const
	viewAST - Visualize an AST rooted at this Stmt* using GraphViz.

Stmt *	IgnoreContainers (bool IgnoreCaptured=false)
	Skip no-op (attributed, compound) container stmts and skip captured stmt at the top, if IgnoreCaptured is true.

const Stmt *	IgnoreContainers (bool IgnoreCaptured=false) const

const Stmt *	stripLabelLikeStatements () const
	Strip off all label-like statements.

Stmt *	stripLabelLikeStatements ()

child_range	children ()

const_child_range	children () const

child_iterator	child_begin ()

child_iterator	child_end ()

const_child_iterator	child_begin () const

const_child_iterator	child_end () const

void	Profile (llvm::FoldingSetNodeID &ID, const ASTContext &Context, bool Canonical) const
	Produce a unique representation of the given statement.

void	ProcessODRHash (llvm::FoldingSetNodeID &ID, ODRHash &Hash) const
	Calculate a unique representation for a statement that is stable across compiler invocations.

Static Public Member Functions
static DeclRefExpr *	Create (const ASTContext &Context, NestedNameSpecifierLoc QualifierLoc, SourceLocation TemplateKWLoc, ValueDecl D, bool RefersToEnclosingVariableOrCapture, SourceLocation NameLoc, QualType T, ExprValueKind VK, NamedDecl FoundD=nullptr, const TemplateArgumentListInfo *TemplateArgs=nullptr, NonOdrUseReason NOUR=NOUR_None)

static DeclRefExpr *	Create (const ASTContext &Context, NestedNameSpecifierLoc QualifierLoc, SourceLocation TemplateKWLoc, ValueDecl D, bool RefersToEnclosingVariableOrCapture, const DeclarationNameInfo &NameInfo, QualType T, ExprValueKind VK, NamedDecl FoundD=nullptr, const TemplateArgumentListInfo *TemplateArgs=nullptr, NonOdrUseReason NOUR=NOUR_None)

static DeclRefExpr *	CreateEmpty (const ASTContext &Context, bool HasQualifier, bool HasFoundDecl, bool HasTemplateKWAndArgsInfo, unsigned NumTemplateArgs)
	Construct an empty declaration reference expression.

static bool	classof (const Stmt *T)

Static Public Member Functions inherited from clang::Expr
static ExprValueKind	getValueKindForType (QualType T)
	getValueKindForType - Given a formal return or parameter type, give its value kind.

static bool	isPotentialConstantExpr (const FunctionDecl *FD, SmallVectorImpl< PartialDiagnosticAt > &Diags)
	isPotentialConstantExpr - Return true if this function's definition might be usable in a constant expression in C++11, if it were marked constexpr.

static bool	isPotentialConstantExprUnevaluated (Expr E, const FunctionDecl FD, SmallVectorImpl< PartialDiagnosticAt > &Diags)
	isPotentialConstantExprUnevaluted - Return true if this expression might be usable in a constant expression in C++11 in an unevaluated context, if it were in function FD marked constexpr.

static QualType	findBoundMemberType (const Expr *expr)
	Given an expression of bound-member type, find the type of the member.

static bool	hasAnyTypeDependentArguments (ArrayRef< Expr * > Exprs)
	hasAnyTypeDependentArguments - Determines if any of the expressions in Exprs is type-dependent.

static bool	isSameComparisonOperand (const Expr E1, const Expr E2)
	Checks that the two Expr's will refer to the same value as a comparison operand.

static bool	classof (const Stmt *T)

Static Public Member Functions inherited from clang::ValueStmt
static bool	classof (const Stmt *T)

Static Public Member Functions inherited from clang::Stmt
static void	addStmtClass (const StmtClass s)

static void	EnableStatistics ()

static void	PrintStats ()

static Likelihood	getLikelihood (ArrayRef< const Attr * > Attrs)

static Likelihood	getLikelihood (const Stmt *S)

static const Attr *	getLikelihoodAttr (const Stmt *S)

static Likelihood	getLikelihood (const Stmt Then, const Stmt Else)

static std::tuple< bool, const Attr , const Attr >	determineLikelihoodConflict (const Stmt Then, const Stmt Else)

Friends
class	ASTStmtReader

class	ASTStmtWriter

Additional Inherited Members
Public Types inherited from clang::Expr
enum	LValueClassification { LV_Valid , LV_NotObjectType , LV_IncompleteVoidType , LV_DuplicateVectorComponents , LV_InvalidExpression , LV_InvalidMessageExpression , LV_MemberFunction , LV_SubObjCPropertySetting , LV_ClassTemporary , LV_ArrayTemporary }

enum	isModifiableLvalueResult { MLV_Valid , MLV_NotObjectType , MLV_IncompleteVoidType , MLV_DuplicateVectorComponents , MLV_InvalidExpression , MLV_LValueCast , MLV_IncompleteType , MLV_ConstQualified , MLV_ConstQualifiedField , MLV_ConstAddrSpace , MLV_ArrayType , MLV_NoSetterProperty , MLV_MemberFunction , MLV_SubObjCPropertySetting , MLV_InvalidMessageExpression , MLV_ClassTemporary , MLV_ArrayTemporary }

enum	SideEffectsKind { SE_NoSideEffects , SE_AllowUndefinedBehavior , SE_AllowSideEffects }

enum class	ConstantExprKind { Normal , NonClassTemplateArgument , ClassTemplateArgument , ImmediateInvocation }

enum	NullPointerConstantKind { NPCK_NotNull = 0 , NPCK_ZeroExpression , NPCK_ZeroLiteral , NPCK_CXX11_nullptr , NPCK_GNUNull }
	Enumeration used to describe the kind of Null pointer constant returned from `isNullPointerConstant()`. More...

enum	NullPointerConstantValueDependence { NPC_NeverValueDependent = 0 , NPC_ValueDependentIsNull , NPC_ValueDependentIsNotNull }
	Enumeration used to describe how `isNullPointerConstant()` should cope with value-dependent expressions. More...

Public Types inherited from clang::Stmt
enum	StmtClass { NoStmtClass = 0 }

enum	Likelihood { LH_Unlikely = -1 , LH_None , LH_Likely }
	The likelihood of a branch being taken. More...

using	child_iterator = StmtIterator
	Child Iterators: All subclasses must implement 'children' to permit easy iteration over the substatements/subexpressions of an AST node.

using	const_child_iterator = ConstStmtIterator

using	child_range = llvm::iterator_range< child_iterator >

using	const_child_range = llvm::iterator_range< const_child_iterator >

Protected Types inherited from clang::Stmt
enum	{ NumStmtBits = 8 }

enum	{ NumExprBits = NumStmtBits + 5 + llvm::BitWidth<ExprDependence> }

enum	{ NumCallExprBits = 32 }

enum	{ NumOverloadExprBits = NumExprBits + 1 }

template<typename T >
using	ConstCastIterator = CastIterator< T, const T const, const Stmt const >
	Const iterator for iterating over Stmt * arrays that contain only T *.

using	ExprIterator = CastIterator< Expr >

using	ConstExprIterator = ConstCastIterator< Expr >

Protected Member Functions inherited from clang::Expr
	Expr (StmtClass SC, QualType T, ExprValueKind VK, ExprObjectKind OK)

	Expr (StmtClass SC, EmptyShell)
	Construct an empty expression.

void	setDependence (ExprDependence Deps)
	Each concrete expr subclass is expected to compute its dependence and call this in the constructor.

Protected Member Functions inherited from clang::ValueStmt
	Stmt (StmtClass SC, EmptyShell)
	Construct an empty statement.

	Stmt ()=delete

	Stmt (const Stmt &)=delete

	Stmt (Stmt &&)=delete

	Stmt (StmtClass SC)

Protected Member Functions inherited from clang::Stmt
void *	operator new (size_t bytes) noexcept

void	operator delete (void *data) noexcept

	Stmt (StmtClass SC, EmptyShell)
	Construct an empty statement.

Protected Attributes inherited from clang::Stmt
union {
StmtBitfields StmtBits

NullStmtBitfields NullStmtBits

CompoundStmtBitfields CompoundStmtBits

LabelStmtBitfields LabelStmtBits

AttributedStmtBitfields AttributedStmtBits

IfStmtBitfields IfStmtBits

SwitchStmtBitfields SwitchStmtBits

WhileStmtBitfields WhileStmtBits

DoStmtBitfields DoStmtBits

ForStmtBitfields ForStmtBits

GotoStmtBitfields GotoStmtBits

ContinueStmtBitfields ContinueStmtBits

BreakStmtBitfields BreakStmtBits

ReturnStmtBitfields ReturnStmtBits

SwitchCaseBitfields SwitchCaseBits

ExprBitfields ExprBits

ConstantExprBitfields ConstantExprBits

PredefinedExprBitfields PredefinedExprBits

DeclRefExprBitfields DeclRefExprBits

FloatingLiteralBitfields FloatingLiteralBits

StringLiteralBitfields StringLiteralBits

CharacterLiteralBitfields CharacterLiteralBits

UnaryOperatorBitfields UnaryOperatorBits

UnaryExprOrTypeTraitExprBitfields UnaryExprOrTypeTraitExprBits

ArrayOrMatrixSubscriptExprBitfields ArrayOrMatrixSubscriptExprBits

CallExprBitfields CallExprBits

MemberExprBitfields MemberExprBits

CastExprBitfields CastExprBits

BinaryOperatorBitfields BinaryOperatorBits

InitListExprBitfields InitListExprBits

ParenListExprBitfields ParenListExprBits

GenericSelectionExprBitfields GenericSelectionExprBits

PseudoObjectExprBitfields PseudoObjectExprBits

SourceLocExprBitfields SourceLocExprBits

StmtExprBitfields StmtExprBits

CXXOperatorCallExprBitfields CXXOperatorCallExprBits

CXXRewrittenBinaryOperatorBitfields CXXRewrittenBinaryOperatorBits

CXXBoolLiteralExprBitfields CXXBoolLiteralExprBits

CXXNullPtrLiteralExprBitfields CXXNullPtrLiteralExprBits

CXXThisExprBitfields CXXThisExprBits

CXXThrowExprBitfields CXXThrowExprBits

CXXDefaultArgExprBitfields CXXDefaultArgExprBits

CXXDefaultInitExprBitfields CXXDefaultInitExprBits

CXXScalarValueInitExprBitfields CXXScalarValueInitExprBits

CXXNewExprBitfields CXXNewExprBits

CXXDeleteExprBitfields CXXDeleteExprBits

TypeTraitExprBitfields TypeTraitExprBits

DependentScopeDeclRefExprBitfields DependentScopeDeclRefExprBits

CXXConstructExprBitfields CXXConstructExprBits

ExprWithCleanupsBitfields ExprWithCleanupsBits

CXXUnresolvedConstructExprBitfields CXXUnresolvedConstructExprBits

CXXDependentScopeMemberExprBitfields CXXDependentScopeMemberExprBits

OverloadExprBitfields OverloadExprBits

UnresolvedLookupExprBitfields UnresolvedLookupExprBits

UnresolvedMemberExprBitfields UnresolvedMemberExprBits

CXXNoexceptExprBitfields CXXNoexceptExprBits

SubstNonTypeTemplateParmExprBitfields SubstNonTypeTemplateParmExprBits

LambdaExprBitfields LambdaExprBits

RequiresExprBitfields RequiresExprBits

CoawaitExprBitfields CoawaitBits

ObjCIndirectCopyRestoreExprBitfields ObjCIndirectCopyRestoreExprBits

OpaqueValueExprBitfields OpaqueValueExprBits

};

Detailed Description

A reference to a declared variable, function, enum, etc.

[C99 6.5.1p2]

This encodes all the information about how a declaration is referenced within an expression.

There are several optional constructs attached to DeclRefExprs only when they apply in order to conserve memory. These are laid out past the end of the object, and flags in the DeclRefExprBitfield track whether they exist:

DeclRefExprBits.HasQualifier: Specifies when this declaration reference expression has a C++ nested-name-specifier. DeclRefExprBits.HasFoundDecl: Specifies when this declaration reference expression has a record of a NamedDecl (different from the referenced ValueDecl) which was found during name lookup and/or overload resolution. DeclRefExprBits.HasTemplateKWAndArgsInfo: Specifies when this declaration reference expression has an explicit C++ template keyword and/or template argument list. DeclRefExprBits.RefersToEnclosingVariableOrCapture Specifies when this declaration reference expression (validly) refers to an enclosed local or a captured variable.

Definition at line 1234 of file Expr.h.

Constructor & Destructor Documentation

◆ DeclRefExpr()

DeclRefExpr::DeclRefExpr	(	const ASTContext &	Ctx,
		ValueDecl *	D,
		bool	RefersToEnclosingVariableOrCapture,
		QualType	T,
		ExprValueKind	VK,
		SourceLocation	L,
		const DeclarationNameLoc &	LocInfo = `DeclarationNameLoc()`,
		NonOdrUseReason	NOUR = `NOUR_None`
	)

Definition at line 482 of file Expr.cpp.

References clang::computeDependence(), clang::Stmt::DeclRefExprBits, and clang::Expr::setDependence().

Member Function Documentation

◆ children() [1/2]

child_range clang::DeclRefExpr::children ( )

inline

Definition at line 1445 of file Expr.h.

◆ children() [2/2]

const_child_range clang::DeclRefExpr::children ( ) const

inline

Definition at line 1449 of file Expr.h.

◆ classof()

static bool clang::DeclRefExpr::classof ( const Stmt * T )

inlinestatic

Definition at line 1440 of file Expr.h.

References clang::Stmt::getStmtClass().

◆ copyTemplateArgumentsInto()

void clang::DeclRefExpr::copyTemplateArgumentsInto ( TemplateArgumentListInfo & List ) const

inline

Copies the template arguments (if present) into the given structure.

Definition at line 1391 of file Expr.h.

References hasExplicitTemplateArgs().

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

◆ Create() [1/2]

DeclRefExpr * DeclRefExpr::Create	(	const ASTContext &	Context,
		NestedNameSpecifierLoc	QualifierLoc,
		SourceLocation	TemplateKWLoc,
		ValueDecl *	D,
		bool	RefersToEnclosingVariableOrCapture,
		const DeclarationNameInfo &	NameInfo,
		QualType	T,
		ExprValueKind	VK,
		NamedDecl *	FoundD = `nullptr`,
		const TemplateArgumentListInfo *	TemplateArgs = `nullptr`,
		NonOdrUseReason	NOUR = `NOUR_None`
	)

static

Definition at line 550 of file Expr.cpp.

References clang::ASTContext::Allocate(), clang::SourceLocation::isValid(), and clang::TemplateArgumentListInfo::size().

◆ Create() [2/2]

DeclRefExpr * DeclRefExpr::Create	(	const ASTContext &	Context,
		NestedNameSpecifierLoc	QualifierLoc,
		SourceLocation	TemplateKWLoc,
		ValueDecl *	D,
		bool	RefersToEnclosingVariableOrCapture,
		SourceLocation	NameLoc,
		QualType	T,
		ExprValueKind	VK,
		NamedDecl *	FoundD = `nullptr`,
		const TemplateArgumentListInfo *	TemplateArgs = `nullptr`,
		NonOdrUseReason	NOUR = `NOUR_None`
	)

static

Definition at line 536 of file Expr.cpp.

References Create(), and clang::NamedDecl::getDeclName().

Referenced by clang::Sema::ActOnFinishedFunctionDefinitionInOpenMPDeclareVariantScope(), clang::Sema::ActOnOpenMPIdExpression(), clang::Sema::BuildCallExpr(), buildDeclRefExpr(), clang::Sema::BuildDeclRefExpr(), BuildImplicitBaseInitializer(), BuildImplicitMemberInitializer(), Create(), create_call_once_lambda_call(), createImplicitFirstprivateForType(), instantiateOMPDeclareVariantAttr(), rebuildPotentialResultsAsNonOdrUsed(), tryToConvertMemberExprToDeclRefExpr(), and clang::ASTNodeImporter::VisitDeclRefExpr().

◆ CreateEmpty()

DeclRefExpr * DeclRefExpr::CreateEmpty	(	const ASTContext &	Context,
		bool	HasQualifier,
		bool	HasFoundDecl,
		bool	HasTemplateKWAndArgsInfo,
		unsigned	NumTemplateArgs
	)

static

Construct an empty declaration reference expression.

Definition at line 577 of file Expr.cpp.

References clang::ASTContext::Allocate().

◆ getBeginLoc()

SourceLocation DeclRefExpr::getBeginLoc ( ) const

Definition at line 599 of file Expr.cpp.

References clang::DeclarationNameInfo::getBeginLoc(), clang::NestedNameSpecifierLoc::getBeginLoc(), getNameInfo(), getQualifierLoc(), and hasQualifier().

Referenced by clang::Sema::ActOnOpenMPTileDirective(), clang::Sema::BuildDeclRefExpr(), DiagnoseSelfAssignment(), and clang::Sema::DiagnoseSelfMove().

◆ getDecl() [1/2]

ValueDecl * clang::DeclRefExpr::getDecl ( )

inline

Definition at line 1306 of file Expr.h.

Referenced by actOnOMPReductionKindClause(), clang::Sema::ActOnOpenMPDetachClause(), clang::Sema::ActOnOpenMPFirstprivateClause(), clang::Sema::ActOnOpenMPLastprivateClause(), clang::Sema::ActOnOpenMPLinearClause(), clang::Sema::ActOnOpenMPLoopInitialization(), clang::Sema::ActOnOpenMPTileDirective(), clang::Sema::ActOnOpenMPUsesAllocatorClause(), AddVariableConstraints(), clang::Sema::BuildCXXForRangeStmt(), buildLoopVarFunc(), clang::Sema::CheckAddressOfOperand(), clang::Sema::CheckAssignmentOperands(), checkFormatStringExpr(), CheckForModifiableLvalue(), CheckForReference(), CheckIdentityFieldAssignment(), CheckImplicitConversion(), CheckMoveOnConstruction(), clang::Sema::CheckPlaceholderExpr(), CheckTemplateArgumentPointerToMember(), clang::computeDependence(), clang::ento::containsEnum(), clang::ento::containsStaticLocal(), DiagnoseSelfAssignment(), clang::Sema::DiagnoseSelfMove(), EmitOMPHelperVar(), clang::CodeGen::CGOpenMPRuntime::emitSingleReductionCombiner(), FindTypeTagExpr(), getBaseDecl(), DerefSimplePtrArithFixableGadget::getFixits(), getNameInfo(), getSelfInitExpr(), groupFixablesByVar(), groupWarningGadgetsByVar(), handleCleanupAttr(), handleNSErrorDomain(), clang::ento::isCapturedByReference(), isEnumConstant(), isIdenticalStmt(), clang::Expr::isObjCSelfExpr(), clang::Sema::isOpenMPCapturedDecl(), clang::Sema::isOpenMPDeclareMapperVarDeclAllowed(), clang::ento::isPossiblyEscaped(), isReferenceToNonConstCapture(), isTemplateArgumentTemplateParameter(), mapParam(), clang::Sema::MarkDeclRefReferenced(), MaybeDecrementCount(), RecordModifiableNonNullParam(), clang::Sema::RefersToMemberWithReducedAlignment(), shouldExtendReceiverForInnerPointerMessage(), ValidDuplicateEnum(), clang::consumed::ConsumedStmtVisitor::VisitDeclRefExpr(), clang::JSONNodeDumper::VisitDeclRefExpr(), clang::interp::ByteCodeExprGen< Emitter >::VisitDeclRefExpr(), clang::ASTNodeImporter::VisitDeclRefExpr(), clang::UsedDeclVisitor< Derived >::VisitDeclRefExpr(), clang::ento::ConditionBRVisitor::VisitTrueTest(), and clang::Sema::WarnOnPendingNoDerefs().

◆ getDecl() [2/2]

const ValueDecl * clang::DeclRefExpr::getDecl ( ) const

inline

Definition at line 1307 of file Expr.h.

◆ getEndLoc()

SourceLocation DeclRefExpr::getEndLoc ( ) const

Definition at line 604 of file Expr.cpp.

References clang::DeclarationNameInfo::getEndLoc(), getNameInfo(), getRAngleLoc(), and hasExplicitTemplateArgs().

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

◆ getFoundDecl() [1/2]

NamedDecl * clang::DeclRefExpr::getFoundDecl ( )

inline

Get the NamedDecl through which this reference occurred.

This Decl may be different from the ValueDecl actually referred to in the presence of using declarations, etc. It always returns non-NULL, and may simple return the ValueDecl when appropriate.

Definition at line 1343 of file Expr.h.

Referenced by clang::Sema::CheckPlaceholderExpr(), clang::JSONNodeDumper::VisitDeclRefExpr(), and clang::ASTNodeImporter::VisitDeclRefExpr().

◆ getFoundDecl() [2/2]

const NamedDecl * clang::DeclRefExpr::getFoundDecl ( ) const

inline

Get the NamedDecl through which this reference occurred.

See non-const variant.

Definition at line 1349 of file Expr.h.

◆ getLAngleLoc()

SourceLocation clang::DeclRefExpr::getLAngleLoc ( ) const

inline

Retrieve the location of the left angle bracket starting the explicit template argument list following the name, if any.

Definition at line 1367 of file Expr.h.

References hasTemplateKWAndArgsInfo().

Referenced by hasExplicitTemplateArgs(), and clang::ASTNodeImporter::VisitDeclRefExpr().

◆ getLocation()

SourceLocation clang::DeclRefExpr::getLocation ( ) const

inline

Definition at line 1314 of file Expr.h.

References clang::Stmt::DeclRefExprBits.

Referenced by DiagnosedUnqualifiedCallsToStdFunctions(), DiagnoseSelfAssignment(), getNameInfo(), clang::Sema::MarkDeclRefReferenced(), clang::ASTNodeImporter::VisitDeclRefExpr(), and clang::UsedDeclVisitor< Derived >::VisitDeclRefExpr().

◆ getNameInfo()

DeclarationNameInfo clang::DeclRefExpr::getNameInfo ( ) const

inline

Definition at line 1310 of file Expr.h.

References getDecl(), and getLocation().

Referenced by clang::Sema::CheckPlaceholderExpr(), getBeginLoc(), getEndLoc(), and handleCleanupAttr().

◆ getNumTemplateArgs()

unsigned clang::DeclRefExpr::getNumTemplateArgs ( ) const

inline

Retrieve the number of template arguments provided as part of this template-id.

Definition at line 1407 of file Expr.h.

References hasExplicitTemplateArgs().

Referenced by clang::computeDependence(), and template_arguments().

◆ getQualifier()

NestedNameSpecifier * clang::DeclRefExpr::getQualifier ( ) const

inline

If the name was qualified, retrieves the nested-name-specifier that precedes the name.

Otherwise, returns NULL.

Definition at line 1333 of file Expr.h.

References clang::NestedNameSpecifierLoc::getNestedNameSpecifier(), and getQualifierLoc().

Referenced by clang::Sema::CheckAddressOfOperand(), CheckTemplateArgumentPointerToMember(), clang::computeDependence(), and DiagnosedUnqualifiedCallsToStdFunctions().

◆ getQualifierLoc()

NestedNameSpecifierLoc clang::DeclRefExpr::getQualifierLoc ( ) const

inline

If the name was qualified, retrieves the nested-name-specifier that precedes the name, with source-location information.

Definition at line 1325 of file Expr.h.

References hasQualifier().

Referenced by clang::Sema::CheckPlaceholderExpr(), getBeginLoc(), getQualifier(), and clang::ASTNodeImporter::VisitDeclRefExpr().

◆ getRAngleLoc()

SourceLocation clang::DeclRefExpr::getRAngleLoc ( ) const

inline

Retrieve the location of the right angle bracket ending the explicit template argument list following the name, if any.

Definition at line 1375 of file Expr.h.

References hasTemplateKWAndArgsInfo().

Referenced by getEndLoc(), and clang::ASTNodeImporter::VisitDeclRefExpr().

◆ getTemplateArgs()

const TemplateArgumentLoc * clang::DeclRefExpr::getTemplateArgs ( ) const

inline

Retrieve the template arguments provided as part of this template-id.

Definition at line 1399 of file Expr.h.

References hasExplicitTemplateArgs().

Referenced by clang::computeDependence(), and template_arguments().

◆ getTemplateKeywordLoc()

SourceLocation clang::DeclRefExpr::getTemplateKeywordLoc ( ) const

inline

Retrieve the location of the template keyword preceding this name, if any.

Definition at line 1359 of file Expr.h.

References hasTemplateKWAndArgsInfo().

Referenced by clang::Sema::CheckPlaceholderExpr(), hasTemplateKeyword(), and clang::ASTNodeImporter::VisitDeclRefExpr().

◆ hadMultipleCandidates()

bool clang::DeclRefExpr::hadMultipleCandidates ( ) const

inline

Returns true if this expression refers to a function that was resolved from an overloaded set having size greater than 1.

Definition at line 1419 of file Expr.h.

References clang::Stmt::DeclRefExprBits.

Referenced by clang::ASTNodeImporter::VisitDeclRefExpr().

◆ hasExplicitTemplateArgs()

bool clang::DeclRefExpr::hasExplicitTemplateArgs ( ) const

inline

Determines whether this declaration reference was followed by an explicit template argument list.

Definition at line 1387 of file Expr.h.

References getLAngleLoc(), and clang::SourceLocation::isValid().

Referenced by clang::Sema::CheckPlaceholderExpr(), copyTemplateArgumentsInto(), getEndLoc(), getNumTemplateArgs(), getTemplateArgs(), and clang::ASTNodeImporter::VisitDeclRefExpr().

◆ hasQualifier()

bool clang::DeclRefExpr::hasQualifier ( ) const

inline

Determine whether this declaration reference was preceded by a C++ nested-name-specifier, e.g., N::foo.

Definition at line 1321 of file Expr.h.

References clang::Stmt::DeclRefExprBits.

Referenced by clang::Sema::CheckPlaceholderExpr(), getBeginLoc(), getQualifierLoc(), and handleCleanupAttr().

◆ hasTemplateKeyword()

bool clang::DeclRefExpr::hasTemplateKeyword ( ) const

inline

Determines whether the name in this declaration reference was preceded by the template keyword.

Definition at line 1383 of file Expr.h.

References getTemplateKeywordLoc(), and clang::SourceLocation::isValid().

◆ hasTemplateKWAndArgsInfo()

bool clang::DeclRefExpr::hasTemplateKWAndArgsInfo ( ) const

inline

Definition at line 1353 of file Expr.h.

References clang::Stmt::DeclRefExprBits.

Referenced by getLAngleLoc(), getRAngleLoc(), and getTemplateKeywordLoc().

◆ isNonOdrUse()

NonOdrUseReason clang::DeclRefExpr::isNonOdrUse ( ) const

inline

Is this expression a non-odr-use reference, and if so, why?

Definition at line 1430 of file Expr.h.

References clang::Stmt::DeclRefExprBits.

Referenced by clang::JSONNodeDumper::VisitDeclRefExpr(), and clang::ASTNodeImporter::VisitDeclRefExpr().

◆ refersToEnclosingVariableOrCapture()

bool clang::DeclRefExpr::refersToEnclosingVariableOrCapture ( ) const

inline

Does this DeclRefExpr refer to an enclosing local or a captured variable?

Definition at line 1436 of file Expr.h.

References clang::Stmt::DeclRefExprBits.

Referenced by canEmitSpuriousReferenceToVariable(), CheckMoveOnConstruction(), clang::ento::isCapturedByReference(), clang::ento::isPossiblyEscaped(), isReferenceToNonConstCapture(), and clang::ASTNodeImporter::VisitDeclRefExpr().

◆ setDecl()

void DeclRefExpr::setDecl ( ValueDecl * NewD )

Definition at line 592 of file Expr.cpp.

References clang::computeDependence(), clang::Decl::getASTContext(), clang::ValueDecl::getType(), clang::Expr::getType(), clang::Expr::setDependence(), and clang::Expr::setType().

◆ setHadMultipleCandidates()

void clang::DeclRefExpr::setHadMultipleCandidates ( bool V = true )

inline

Sets the flag telling whether this expression refers to a function that was resolved from an overloaded set having size greater than 1.

Definition at line 1425 of file Expr.h.

References clang::Stmt::DeclRefExprBits, and V.

Referenced by CreateFunctionRefExpr(), and clang::Sema::FixOverloadedFunctionReference().

◆ setLocation()

void clang::DeclRefExpr::setLocation ( SourceLocation L )

inline

Definition at line 1315 of file Expr.h.

References clang::Stmt::DeclRefExprBits.

◆ template_arguments()

ArrayRef< TemplateArgumentLoc > clang::DeclRefExpr::template_arguments ( ) const

inline

Definition at line 1413 of file Expr.h.

References getNumTemplateArgs(), and getTemplateArgs().

Referenced by clang::ASTNodeImporter::VisitDeclRefExpr().

Friends And Related Function Documentation

◆ ASTStmtReader

friend class ASTStmtReader

friend

Definition at line 1239 of file Expr.h.

◆ ASTStmtWriter

friend class ASTStmtWriter

friend

Definition at line 1240 of file Expr.h.

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

include/clang/AST/Expr.h
lib/AST/Expr.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DeclRefExpr()

Member Function Documentation

◆ children() [1/2]

◆ children() [2/2]

◆ classof()

◆ copyTemplateArgumentsInto()

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateEmpty()

◆ getBeginLoc()

◆ getDecl() [1/2]

◆ getDecl() [2/2]

◆ getEndLoc()

◆ getFoundDecl() [1/2]

◆ getFoundDecl() [2/2]

◆ getLAngleLoc()

◆ getLocation()

◆ getNameInfo()

◆ getNumTemplateArgs()

◆ getQualifier()

◆ getQualifierLoc()

◆ getRAngleLoc()

◆ getTemplateArgs()

◆ getTemplateKeywordLoc()

◆ hadMultipleCandidates()

◆ hasExplicitTemplateArgs()

◆ hasQualifier()

◆ hasTemplateKeyword()

◆ hasTemplateKWAndArgsInfo()

◆ isNonOdrUse()

◆ refersToEnclosingVariableOrCapture()

◆ setDecl()

◆ setHadMultipleCandidates()

◆ setLocation()

◆ template_arguments()

Friends And Related Function Documentation

◆ ASTStmtReader

◆ ASTStmtWriter