clang  9.0.0svn
Classes | Public Types | Public Member Functions | List of all members
clang::APValue Class Reference

APValue - This class implements a discriminated union of [uninitialized] [APSInt] [APFloat], [Complex APSInt] [Complex APFloat], [Expr + Offset], [Vector: N * APValue], [Array: N * APValue]. More...

#include "clang/AST/APValue.h"

Classes

struct  LV
 
class  LValueBase
 
class  LValuePathEntry
 A non-discriminated union of a base, field, or array index. More...
 
struct  MemberPointerData
 
struct  NoLValuePath
 
struct  UninitArray
 
struct  UninitStruct
 

Public Types

enum  ValueKind {
  Uninitialized, Int, Float, FixedPoint,
  ComplexInt, ComplexFloat, LValue, Vector,
  Array, Struct, Union, MemberPointer,
  AddrLabelDiff
}
 
typedef llvm::PointerIntPair< const Decl *, 1, boolBaseOrMemberType
 A FieldDecl or CXXRecordDecl, along with a flag indicating whether we mean a virtual or non-virtual base class subobject. More...
 

Public Member Functions

 APValue ()
 
 APValue (APSInt I)
 
 APValue (APFloat F)
 
 APValue (APFixedPoint FX)
 
 APValue (const APValue *E, unsigned N)
 
 APValue (APSInt R, APSInt I)
 
 APValue (APFloat R, APFloat I)
 
 APValue (const APValue &RHS)
 
 APValue (APValue &&RHS)
 
 APValue (LValueBase B, const CharUnits &O, NoLValuePath N, bool IsNullPtr=false)
 
 APValue (LValueBase B, const CharUnits &O, ArrayRef< LValuePathEntry > Path, bool OnePastTheEnd, bool IsNullPtr=false)
 
 APValue (UninitArray, unsigned InitElts, unsigned Size)
 
 APValue (UninitStruct, unsigned B, unsigned M)
 
 APValue (const FieldDecl *D, const APValue &V=APValue())
 
 APValue (const ValueDecl *Member, bool IsDerivedMember, ArrayRef< const CXXRecordDecl *> Path)
 
 APValue (const AddrLabelExpr *LHSExpr, const AddrLabelExpr *RHSExpr)
 
 ~APValue ()
 
bool needsCleanup () const
 Returns whether the object performed allocations. More...
 
void swap (APValue &RHS)
 Swaps the contents of this and the given APValue. More...
 
ValueKind getKind () const
 
bool isUninit () const
 
bool isInt () const
 
bool isFloat () const
 
bool isFixedPoint () const
 
bool isComplexInt () const
 
bool isComplexFloat () const
 
bool isLValue () const
 
bool isVector () const
 
bool isArray () const
 
bool isStruct () const
 
bool isUnion () const
 
bool isMemberPointer () const
 
bool isAddrLabelDiff () const
 
void dump () const
 
void dump (raw_ostream &OS) const
 
void printPretty (raw_ostream &OS, ASTContext &Ctx, QualType Ty) const
 
std::string getAsString (ASTContext &Ctx, QualType Ty) const
 
APSInt & getInt ()
 
const APSInt & getInt () const
 
bool toIntegralConstant (APSInt &Result, QualType SrcTy, const ASTContext &Ctx) const
 Try to convert this value to an integral constant. More...
 
APFloat & getFloat ()
 
const APFloat & getFloat () const
 
APFixedPointgetFixedPoint ()
 
const APFixedPointgetFixedPoint () const
 
APSInt & getComplexIntReal ()
 
const APSInt & getComplexIntReal () const
 
APSInt & getComplexIntImag ()
 
const APSInt & getComplexIntImag () const
 
APFloat & getComplexFloatReal ()
 
const APFloat & getComplexFloatReal () const
 
APFloat & getComplexFloatImag ()
 
const APFloat & getComplexFloatImag () const
 
const LValueBase getLValueBase () const
 
CharUnitsgetLValueOffset ()
 
const CharUnitsgetLValueOffset () const
 
bool isLValueOnePastTheEnd () const
 
bool hasLValuePath () const
 
ArrayRef< LValuePathEntrygetLValuePath () const
 
unsigned getLValueCallIndex () const
 
unsigned getLValueVersion () const
 
bool isNullPointer () const
 
APValuegetVectorElt (unsigned I)
 
const APValuegetVectorElt (unsigned I) const
 
unsigned getVectorLength () const
 
APValuegetArrayInitializedElt (unsigned I)
 
const APValuegetArrayInitializedElt (unsigned I) const
 
bool hasArrayFiller () const
 
APValuegetArrayFiller ()
 
const APValuegetArrayFiller () const
 
unsigned getArrayInitializedElts () const
 
unsigned getArraySize () const
 
unsigned getStructNumBases () const
 
unsigned getStructNumFields () const
 
APValuegetStructBase (unsigned i)
 
APValuegetStructField (unsigned i)
 
const APValuegetStructBase (unsigned i) const
 
const APValuegetStructField (unsigned i) const
 
const FieldDeclgetUnionField () const
 
APValuegetUnionValue ()
 
const APValuegetUnionValue () const
 
const ValueDeclgetMemberPointerDecl () const
 
bool isMemberPointerToDerivedMember () const
 
ArrayRef< const CXXRecordDecl * > getMemberPointerPath () const
 
const AddrLabelExprgetAddrLabelDiffLHS () const
 
const AddrLabelExprgetAddrLabelDiffRHS () const
 
void setInt (APSInt I)
 
void setFloat (APFloat F)
 
void setFixedPoint (APFixedPoint FX)
 
void setVector (const APValue *E, unsigned N)
 
void setComplexInt (APSInt R, APSInt I)
 
void setComplexFloat (APFloat R, APFloat I)
 
void setLValue (LValueBase B, const CharUnits &O, NoLValuePath, bool IsNullPtr)
 
void setLValue (LValueBase B, const CharUnits &O, ArrayRef< LValuePathEntry > Path, bool OnePastTheEnd, bool IsNullPtr)
 
void setUnion (const FieldDecl *Field, const APValue &Value)
 
void setAddrLabelDiff (const AddrLabelExpr *LHSExpr, const AddrLabelExpr *RHSExpr)
 
APValueoperator= (APValue RHS)
 Assign by swapping from a copy of the RHS. More...
 

Detailed Description

APValue - This class implements a discriminated union of [uninitialized] [APSInt] [APFloat], [Complex APSInt] [Complex APFloat], [Expr + Offset], [Vector: N * APValue], [Array: N * APValue].

Definition at line 76 of file APValue.h.

Member Typedef Documentation

◆ BaseOrMemberType

typedef llvm::PointerIntPair<const Decl *, 1, bool> clang::APValue::BaseOrMemberType

A FieldDecl or CXXRecordDecl, along with a flag indicating whether we mean a virtual or non-virtual base class subobject.

Definition at line 145 of file APValue.h.

Member Enumeration Documentation

◆ ValueKind

Enumerator
Uninitialized 
Int 
Float 
FixedPoint 
ComplexInt 
ComplexFloat 
LValue 
Vector 
Array 
Struct 
Union 
MemberPointer 
AddrLabelDiff 

Definition at line 80 of file APValue.h.

Constructor & Destructor Documentation

◆ APValue() [1/16]

clang::APValue::APValue ( )
inline

Definition at line 234 of file APValue.h.

◆ APValue() [2/16]

clang::APValue::APValue ( APSInt  I)
inlineexplicit

Definition at line 235 of file APValue.h.

◆ APValue() [3/16]

clang::APValue::APValue ( APFloat  F)
inlineexplicit

Definition at line 238 of file APValue.h.

◆ APValue() [4/16]

clang::APValue::APValue ( APFixedPoint  FX)
inlineexplicit

Definition at line 241 of file APValue.h.

◆ APValue() [5/16]

clang::APValue::APValue ( const APValue E,
unsigned  N 
)
inlineexplicit

Definition at line 244 of file APValue.h.

◆ APValue() [6/16]

clang::APValue::APValue ( APSInt  R,
APSInt  I 
)
inline

Definition at line 247 of file APValue.h.

◆ APValue() [7/16]

clang::APValue::APValue ( APFloat  R,
APFloat  I 
)
inline

Definition at line 250 of file APValue.h.

◆ APValue() [8/16]

APValue::APValue ( const APValue RHS)

◆ APValue() [9/16]

clang::APValue::APValue ( APValue &&  RHS)
inline

Definition at line 254 of file APValue.h.

◆ APValue() [10/16]

clang::APValue::APValue ( LValueBase  B,
const CharUnits O,
NoLValuePath  N,
bool  IsNullPtr = false 
)
inline

Definition at line 255 of file APValue.h.

◆ APValue() [11/16]

clang::APValue::APValue ( LValueBase  B,
const CharUnits O,
ArrayRef< LValuePathEntry Path,
bool  OnePastTheEnd,
bool  IsNullPtr = false 
)
inline

Definition at line 260 of file APValue.h.

◆ APValue() [12/16]

clang::APValue::APValue ( UninitArray  ,
unsigned  InitElts,
unsigned  Size 
)
inline

Definition at line 265 of file APValue.h.

◆ APValue() [13/16]

clang::APValue::APValue ( UninitStruct  ,
unsigned  B,
unsigned  M 
)
inline

Definition at line 268 of file APValue.h.

◆ APValue() [14/16]

clang::APValue::APValue ( const FieldDecl D,
const APValue V = APValue() 
)
inlineexplicit

Definition at line 271 of file APValue.h.

References V.

◆ APValue() [15/16]

clang::APValue::APValue ( const ValueDecl Member,
bool  IsDerivedMember,
ArrayRef< const CXXRecordDecl *>  Path 
)
inline

Definition at line 275 of file APValue.h.

◆ APValue() [16/16]

clang::APValue::APValue ( const AddrLabelExpr LHSExpr,
const AddrLabelExpr RHSExpr 
)
inline

Definition at line 279 of file APValue.h.

◆ ~APValue()

clang::APValue::~APValue ( )
inline

Definition at line 284 of file APValue.h.

Member Function Documentation

◆ dump() [1/2]

LLVM_DUMP_METHOD void APValue::dump ( ) const

Definition at line 364 of file APValue.cpp.

Referenced by dump().

◆ dump() [2/2]

void APValue::dump ( raw_ostream &  OS) const

◆ getAddrLabelDiffLHS()

const AddrLabelExpr* clang::APValue::getAddrLabelDiffLHS ( ) const
inline

Definition at line 473 of file APValue.h.

Referenced by APValue(), and clang::CodeGen::ConstantEmitter::tryEmitPrivate().

◆ getAddrLabelDiffRHS()

const AddrLabelExpr* clang::APValue::getAddrLabelDiffRHS ( ) const
inline

Definition at line 477 of file APValue.h.

Referenced by APValue(), and clang::CodeGen::ConstantEmitter::tryEmitPrivate().

◆ getArrayFiller() [1/2]

APValue& clang::APValue::getArrayFiller ( )
inline

◆ getArrayFiller() [2/2]

const APValue& clang::APValue::getArrayFiller ( ) const
inline

Definition at line 422 of file APValue.h.

◆ getArrayInitializedElt() [1/2]

APValue& clang::APValue::getArrayInitializedElt ( unsigned  I)
inline

◆ getArrayInitializedElt() [2/2]

const APValue& clang::APValue::getArrayInitializedElt ( unsigned  I) const
inline

Definition at line 411 of file APValue.h.

◆ getArrayInitializedElts()

unsigned clang::APValue::getArrayInitializedElts ( ) const
inline

◆ getArraySize()

unsigned clang::APValue::getArraySize ( ) const
inline

Definition at line 429 of file APValue.h.

Referenced by APValue(), dump(), and clang::CodeGen::ConstantEmitter::tryEmitPrivate().

◆ getAsString()

std::string APValue::getAsString ( ASTContext Ctx,
QualType  Ty 
) const

◆ getComplexFloatImag() [1/2]

APFloat& clang::APValue::getComplexFloatImag ( )
inline

◆ getComplexFloatImag() [2/2]

const APFloat& clang::APValue::getComplexFloatImag ( ) const
inline

Definition at line 377 of file APValue.h.

◆ getComplexFloatReal() [1/2]

APFloat& clang::APValue::getComplexFloatReal ( )
inline

◆ getComplexFloatReal() [2/2]

const APFloat& clang::APValue::getComplexFloatReal ( ) const
inline

Definition at line 369 of file APValue.h.

◆ getComplexIntImag() [1/2]

APSInt& clang::APValue::getComplexIntImag ( )
inline

◆ getComplexIntImag() [2/2]

const APSInt& clang::APValue::getComplexIntImag ( ) const
inline

Definition at line 361 of file APValue.h.

◆ getComplexIntReal() [1/2]

APSInt& clang::APValue::getComplexIntReal ( )
inline

◆ getComplexIntReal() [2/2]

const APSInt& clang::APValue::getComplexIntReal ( ) const
inline

Definition at line 353 of file APValue.h.

◆ getFixedPoint() [1/2]

APFixedPoint& clang::APValue::getFixedPoint ( )
inline

◆ getFixedPoint() [2/2]

const APFixedPoint& clang::APValue::getFixedPoint ( ) const
inline

Definition at line 345 of file APValue.h.

◆ getFloat() [1/2]

APFloat& clang::APValue::getFloat ( )
inline

◆ getFloat() [2/2]

const APFloat& clang::APValue::getFloat ( ) const
inline

Definition at line 337 of file APValue.h.

◆ getInt() [1/2]

APSInt& clang::APValue::getInt ( )
inline

◆ getInt() [2/2]

const APSInt& clang::APValue::getInt ( ) const
inline

Definition at line 323 of file APValue.h.

References clang::Result.

◆ getKind()

ValueKind clang::APValue::getKind ( ) const
inline

◆ getLValueBase()

const APValue::LValueBase APValue::getLValueBase ( ) const

◆ getLValueCallIndex()

unsigned APValue::getLValueCallIndex ( ) const

Definition at line 723 of file APValue.cpp.

References isLValue().

◆ getLValueOffset() [1/2]

CharUnits & APValue::getLValueOffset ( )

◆ getLValueOffset() [2/2]

const CharUnits& clang::APValue::getLValueOffset ( ) const
inline

Definition at line 383 of file APValue.h.

◆ getLValuePath()

ArrayRef< APValue::LValuePathEntry > APValue::getLValuePath ( ) const

Definition at line 717 of file APValue.cpp.

References clang::APValue::LV::getPath(), hasLValuePath(), and isLValue().

Referenced by APValue().

◆ getLValueVersion()

unsigned APValue::getLValueVersion ( ) const

Definition at line 728 of file APValue.cpp.

References isLValue().

◆ getMemberPointerDecl()

const ValueDecl * APValue::getMemberPointerDecl ( ) const

◆ getMemberPointerPath()

ArrayRef< const CXXRecordDecl * > APValue::getMemberPointerPath ( ) const

◆ getStructBase() [1/2]

APValue& clang::APValue::getStructBase ( unsigned  i)
inline

Definition at line 442 of file APValue.h.

Referenced by APValue(), CheckConstantExpression(), dump(), and HandleConstructorCall().

◆ getStructBase() [2/2]

const APValue& clang::APValue::getStructBase ( unsigned  i) const
inline

Definition at line 450 of file APValue.h.

◆ getStructField() [1/2]

APValue& clang::APValue::getStructField ( unsigned  i)
inline

◆ getStructField() [2/2]

const APValue& clang::APValue::getStructField ( unsigned  i) const
inline

Definition at line 453 of file APValue.h.

◆ getStructNumBases()

unsigned clang::APValue::getStructNumBases ( ) const
inline

Definition at line 434 of file APValue.h.

Referenced by APValue(), and dump().

◆ getStructNumFields()

unsigned clang::APValue::getStructNumFields ( ) const
inline

Definition at line 438 of file APValue.h.

Referenced by APValue(), and dump().

◆ getUnionField()

const FieldDecl* clang::APValue::getUnionField ( ) const
inline

Definition at line 457 of file APValue.h.

Referenced by APValue(), CheckConstantExpression(), and HandleConstructorCall().

◆ getUnionValue() [1/2]

APValue& clang::APValue::getUnionValue ( )
inline

Definition at line 461 of file APValue.h.

Referenced by APValue(), CheckConstantExpression(), dump(), and HandleConstructorCall().

◆ getUnionValue() [2/2]

const APValue& clang::APValue::getUnionValue ( ) const
inline

Definition at line 465 of file APValue.h.

◆ getVectorElt() [1/2]

APValue& clang::APValue::getVectorElt ( unsigned  I)
inline

◆ getVectorElt() [2/2]

const APValue& clang::APValue::getVectorElt ( unsigned  I) const
inline

Definition at line 398 of file APValue.h.

◆ getVectorLength()

unsigned clang::APValue::getVectorLength ( ) const
inline

◆ hasArrayFiller()

bool clang::APValue::hasArrayFiller ( ) const
inline

◆ hasLValuePath()

bool APValue::hasLValuePath ( ) const

Definition at line 712 of file APValue.cpp.

References isLValue().

Referenced by APValue(), getLValuePath(), and printPretty().

◆ isAddrLabelDiff()

bool clang::APValue::isAddrLabelDiff ( ) const
inline

Definition at line 311 of file APValue.h.

References dump(), and clang::getAsString().

Referenced by GetValueRange().

◆ isArray()

bool clang::APValue::isArray ( ) const
inline

Definition at line 307 of file APValue.h.

Referenced by CheckConstantExpression(), and EvaluateVector().

◆ isComplexFloat()

bool clang::APValue::isComplexFloat ( ) const
inline

Definition at line 304 of file APValue.h.

Referenced by isFormalAccess(), and IsSameFloatAfterCast().

◆ isComplexInt()

bool clang::APValue::isComplexInt ( ) const
inline

Definition at line 303 of file APValue.h.

Referenced by GetValueRange(), and isFormalAccess().

◆ isFixedPoint()

bool clang::APValue::isFixedPoint ( ) const
inline

Definition at line 302 of file APValue.h.

Referenced by EvaluateAsFixedPoint(), and EvaluateFixedPoint().

◆ isFloat()

bool clang::APValue::isFloat ( ) const
inline

◆ isInt()

bool clang::APValue::isInt ( ) const
inline

◆ isLValue()

bool clang::APValue::isLValue ( ) const
inline

◆ isLValueOnePastTheEnd()

bool APValue::isLValueOnePastTheEnd ( ) const

Definition at line 702 of file APValue.cpp.

References isLValue().

Referenced by APValue().

◆ isMemberPointer()

bool clang::APValue::isMemberPointer ( ) const
inline

◆ isMemberPointerToDerivedMember()

bool APValue::isMemberPointerToDerivedMember ( ) const

Definition at line 769 of file APValue.cpp.

References isMemberPointer().

Referenced by APValue(), and clang::CodeGen::CGCXXABI::getMemberPointerPathAdjustment().

◆ isNullPointer()

bool APValue::isNullPointer ( ) const

◆ isStruct()

bool clang::APValue::isStruct ( ) const
inline

Definition at line 308 of file APValue.h.

Referenced by CheckConstantExpression().

◆ isUninit()

bool clang::APValue::isUninit ( ) const
inline

◆ isUnion()

bool clang::APValue::isUnion ( ) const
inline

Definition at line 309 of file APValue.h.

References Union.

Referenced by CheckConstantExpression(), and HandleConstructorCall().

◆ isVector()

bool clang::APValue::isVector ( ) const
inline

◆ needsCleanup()

bool APValue::needsCleanup ( ) const

Returns whether the object performed allocations.

If APValues are constructed via placement new, needsCleanup() indicates whether the destructor must be called in order to correctly free all allocated memory.

Definition at line 319 of file APValue.cpp.

References AddrLabelDiff, Array, ComplexFloat, ComplexInt, FixedPoint, Float, getComplexFloatImag(), getComplexFloatReal(), getComplexIntImag(), getComplexIntReal(), getFixedPoint(), getFloat(), getInt(), getKind(), clang::APFixedPoint::getValue(), Int, LValue, MemberPointer, Struct, Uninitialized, Union, and Vector.

Referenced by clang::VarDecl::evaluateValue().

◆ operator=()

APValue& clang::APValue::operator= ( APValue  RHS)
inline

Assign by swapping from a copy of the RHS.

Definition at line 532 of file APValue.h.

References Uninitialized, and Union.

◆ printPretty()

void APValue::printPretty ( raw_ostream &  OS,
ASTContext Ctx,
QualType  Ty 
) const

◆ setAddrLabelDiff()

void clang::APValue::setAddrLabelDiff ( const AddrLabelExpr LHSExpr,
const AddrLabelExpr RHSExpr 
)
inline

Definition at line 525 of file APValue.h.

Referenced by APValue().

◆ setComplexFloat()

void clang::APValue::setComplexFloat ( APFloat  R,
APFloat  I 
)
inline

Definition at line 508 of file APValue.h.

Referenced by APValue().

◆ setComplexInt()

void clang::APValue::setComplexInt ( APSInt  R,
APSInt  I 
)
inline

Definition at line 501 of file APValue.h.

Referenced by APValue().

◆ setFixedPoint()

void clang::APValue::setFixedPoint ( APFixedPoint  FX)
inline

Definition at line 490 of file APValue.h.

◆ setFloat()

void clang::APValue::setFloat ( APFloat  F)
inline

Definition at line 486 of file APValue.h.

Referenced by APValue().

◆ setInt()

void clang::APValue::setInt ( APSInt  I)
inline

Definition at line 482 of file APValue.h.

Referenced by APValue().

◆ setLValue() [1/2]

void APValue::setLValue ( LValueBase  B,
const CharUnits O,
NoLValuePath  ,
bool  IsNullPtr 
)

Definition at line 738 of file APValue.cpp.

References isLValue(), and clang::APValue::LV::resizePath().

Referenced by APValue().

◆ setLValue() [2/2]

void APValue::setLValue ( LValueBase  B,
const CharUnits O,
ArrayRef< LValuePathEntry Path,
bool  OnePastTheEnd,
bool  IsNullPtr 
)

◆ setUnion()

void clang::APValue::setUnion ( const FieldDecl Field,
const APValue Value 
)
inline

Definition at line 520 of file APValue.h.

Referenced by APValue().

◆ setVector()

void clang::APValue::setVector ( const APValue E,
unsigned  N 
)
inline

Definition at line 494 of file APValue.h.

References isVector().

Referenced by APValue().

◆ swap()

void APValue::swap ( APValue RHS)

Swaps the contents of this and the given APValue.

Definition at line 356 of file APValue.cpp.

References memcpy().

Referenced by extractSubobject(), and isOnePastTheEndOfCompleteObject().

◆ toIntegralConstant()

bool APValue::toIntegralConstant ( APSInt &  Result,
QualType  SrcTy,
const ASTContext Ctx 
) const

Try to convert this value to an integral constant.

This works if it's an integer, null pointer, or offset from a null pointer. Returns true on success.

Definition at line 677 of file APValue.cpp.

References getInt(), getLValueBase(), getLValueOffset(), clang::ASTContext::getTargetNullPointerValue(), isInt(), isLValue(), isNullPointer(), and clang::ASTContext::MakeIntValue().

Referenced by AddVariableConstraints(), and EvaluateComparisonBinaryOperator().


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