clang  6.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
 
union  LValuePathEntry
 
struct  MemberPointerData
 
struct  NoLValuePath
 
struct  UninitArray
 
struct  UninitStruct
 

Public Types

enum  ValueKind {
  Uninitialized, Int, Float, ComplexInt,
  ComplexFloat, LValue, Vector, Array,
  Struct, Union, MemberPointer, AddrLabelDiff
}
 
typedef llvm::PointerUnion< const ValueDecl *, const Expr * > LValueBase
 
typedef llvm::PointerIntPair< const Decl *, 1, boolBaseOrMemberType
 

Public Member Functions

 APValue ()
 
 APValue (APSInt I)
 
 APValue (APFloat F)
 
 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, unsigned CallIndex, bool IsNullPtr=false)
 
 APValue (LValueBase B, const CharUnits &O, ArrayRef< LValuePathEntry > Path, bool OnePastTheEnd, unsigned CallIndex, 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 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
 
APFloat & getFloat ()
 
const APFloat & getFloat () 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
 
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 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, unsigned CallIndex, bool IsNullPtr)
 
void setLValue (LValueBase B, const CharUnits &O, ArrayRef< LValuePathEntry > Path, bool OnePastTheEnd, unsigned CallIndex, 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 38 of file APValue.h.

Member Typedef Documentation

◆ BaseOrMemberType

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

Definition at line 57 of file APValue.h.

◆ LValueBase

typedef llvm::PointerUnion<const ValueDecl *, const Expr *> clang::APValue::LValueBase

Definition at line 56 of file APValue.h.

Member Enumeration Documentation

◆ ValueKind

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

Definition at line 42 of file APValue.h.

Constructor & Destructor Documentation

◆ APValue() [1/15]

clang::APValue::APValue ( )
inline

Definition at line 120 of file APValue.h.

◆ APValue() [2/15]

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

Definition at line 121 of file APValue.h.

◆ APValue() [3/15]

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

Definition at line 124 of file APValue.h.

References setFloat().

◆ APValue() [4/15]

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

Definition at line 127 of file APValue.h.

◆ APValue() [5/15]

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

Definition at line 130 of file APValue.h.

◆ APValue() [6/15]

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

Definition at line 133 of file APValue.h.

◆ APValue() [7/15]

APValue::APValue ( const APValue RHS)

◆ APValue() [8/15]

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

Definition at line 137 of file APValue.h.

References swap().

◆ APValue() [9/15]

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

Definition at line 138 of file APValue.h.

References setLValue().

◆ APValue() [10/15]

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

Definition at line 143 of file APValue.h.

References setLValue().

◆ APValue() [11/15]

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

Definition at line 148 of file APValue.h.

◆ APValue() [12/15]

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

Definition at line 151 of file APValue.h.

◆ APValue() [13/15]

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

Definition at line 154 of file APValue.h.

References setUnion().

◆ APValue() [14/15]

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

Definition at line 158 of file APValue.h.

◆ APValue() [15/15]

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

Definition at line 162 of file APValue.h.

References setAddrLabelDiff().

◆ ~APValue()

clang::APValue::~APValue ( )
inline

Definition at line 167 of file APValue.h.

References needsCleanup(), and swap().

Member Function Documentation

◆ dump() [1/2]

LLVM_DUMP_METHOD void APValue::dump ( ) const

Definition at line 258 of file APValue.cpp.

Referenced by dump(), and isAddrLabelDiff().

◆ dump() [2/2]

void APValue::dump ( raw_ostream &  OS) const

◆ getAddrLabelDiffLHS()

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

Definition at line 340 of file APValue.h.

References isAddrLabelDiff().

◆ getAddrLabelDiffRHS()

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

Definition at line 344 of file APValue.h.

References isAddrLabelDiff().

◆ getArrayFiller() [1/2]

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

Definition at line 284 of file APValue.h.

References getArrayInitializedElts(), hasArrayFiller(), and isArray().

Referenced by EvaluateVector(), and getArrayFiller().

◆ getArrayFiller() [2/2]

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

Definition at line 289 of file APValue.h.

References getArrayFiller().

◆ getArrayInitializedElt() [1/2]

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

Definition at line 273 of file APValue.h.

◆ getArrayInitializedElt() [2/2]

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

Definition at line 278 of file APValue.h.

◆ getArrayInitializedElts()

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

Definition at line 292 of file APValue.h.

References isArray().

Referenced by APValue(), expandArray(), getArrayFiller(), and hasArrayFiller().

◆ getArraySize()

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

Definition at line 296 of file APValue.h.

References isArray().

Referenced by APValue(), expandArray(), and hasArrayFiller().

◆ 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 245 of file APValue.h.

References getComplexFloatImag(), getLValueBase(), and getLValueOffset().

◆ getComplexFloatReal() [1/2]

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

◆ getComplexFloatReal() [2/2]

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

Definition at line 237 of file APValue.h.

References getComplexFloatReal().

◆ getComplexIntImag() [1/2]

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

◆ getComplexIntImag() [2/2]

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

Definition at line 229 of file APValue.h.

References getComplexIntImag().

◆ getComplexIntReal() [1/2]

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

◆ getComplexIntReal() [2/2]

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

Definition at line 221 of file APValue.h.

References getComplexIntReal().

◆ getFloat() [1/2]

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

◆ getFloat() [2/2]

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

Definition at line 213 of file APValue.h.

References getFloat().

◆ getInt() [1/2]

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

◆ getInt() [2/2]

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

Definition at line 205 of file APValue.h.

References getInt().

◆ getKind()

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

◆ getLValueBase()

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

◆ getLValueCallIndex()

unsigned APValue::getLValueCallIndex ( ) const

Definition at line 579 of file APValue.cpp.

References isLValue().

Referenced by APValue(), and getLValueOffset().

◆ getLValueOffset() [1/2]

CharUnits & APValue::getLValueOffset ( )

◆ getLValueOffset() [2/2]

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

◆ getLValuePath()

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

Definition at line 573 of file APValue.cpp.

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

Referenced by APValue(), and getLValueOffset().

◆ 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 309 of file APValue.h.

References isStruct().

Referenced by getStructBase().

◆ getStructBase() [2/2]

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

Definition at line 317 of file APValue.h.

References getStructBase().

◆ getStructField() [1/2]

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

Definition at line 313 of file APValue.h.

References getStructNumBases(), and isStruct().

Referenced by getStructField().

◆ getStructField() [2/2]

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

Definition at line 320 of file APValue.h.

References getStructField().

◆ getStructNumBases()

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

Definition at line 301 of file APValue.h.

References isStruct().

Referenced by getStructField().

◆ getStructNumFields()

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

Definition at line 305 of file APValue.h.

References isStruct().

◆ getUnionField()

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

Definition at line 324 of file APValue.h.

References isUnion().

◆ getUnionValue() [1/2]

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

Definition at line 328 of file APValue.h.

References isUnion().

Referenced by getUnionValue().

◆ getUnionValue() [2/2]

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

◆ getVectorElt() [1/2]

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

Definition at line 260 of file APValue.h.

Referenced by dump(), EvalAndBitcastToAPInt(), EvaluateVector(), and printPretty().

◆ getVectorElt() [2/2]

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

Definition at line 265 of file APValue.h.

◆ getVectorLength()

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

◆ hasArrayFiller()

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

Definition at line 281 of file APValue.h.

References getArrayInitializedElts(), and getArraySize().

Referenced by EvaluateVector(), and getArrayFiller().

◆ hasLValuePath()

bool APValue::hasLValuePath ( ) const

Definition at line 568 of file APValue.cpp.

References isLValue().

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

◆ isAddrLabelDiff()

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

Definition at line 193 of file APValue.h.

References AddrLabelDiff, dump(), getAsString(), and printPretty().

Referenced by getAddrLabelDiffLHS(), and getAddrLabelDiffRHS().

◆ isArray()

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

◆ isComplexFloat()

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

Definition at line 186 of file APValue.h.

References ComplexFloat.

Referenced by getComplexFloatImag(), and getComplexFloatReal().

◆ isComplexInt()

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

Definition at line 185 of file APValue.h.

References ComplexInt.

Referenced by getComplexIntImag(), and getComplexIntReal().

◆ 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 558 of file APValue.cpp.

References isLValue().

Referenced by APValue(), and getLValueOffset().

◆ isMemberPointer()

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

Definition at line 192 of file APValue.h.

References MemberPointer.

Referenced by getMemberPointerDecl(), getMemberPointerPath(), and isMemberPointerToDerivedMember().

◆ isMemberPointerToDerivedMember()

bool APValue::isMemberPointerToDerivedMember ( ) const

◆ isNullPointer()

bool APValue::isNullPointer ( ) const

◆ isStruct()

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

Definition at line 190 of file APValue.h.

References Struct.

Referenced by getStructBase(), getStructField(), getStructNumBases(), and getStructNumFields().

◆ isUninit()

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

◆ isUnion()

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

Definition at line 191 of file APValue.h.

References Union.

Referenced by getUnionField(), getUnionValue(), and setUnion().

◆ isVector()

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

Definition at line 188 of file APValue.h.

References Vector.

Referenced by EvalAndBitcastToAPInt(), EvaluateTemporary(), and getVectorLength().

◆ 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 215 of file APValue.cpp.

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

Referenced by clang::VarDecl::evaluateValue(), and ~APValue().

◆ operator=()

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

Assign by swapping from a copy of the RHS.

Definition at line 395 of file APValue.h.

References AddrLabelDiff, ComplexFloat, ComplexInt, Float, Int, isUninit(), Struct, swap(), Uninitialized, Union, and Vector.

◆ 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 388 of file APValue.h.

Referenced by APValue().

◆ setComplexFloat()

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

Definition at line 371 of file APValue.h.

Referenced by APValue().

◆ setComplexInt()

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

Definition at line 364 of file APValue.h.

Referenced by APValue().

◆ setFloat()

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

Definition at line 353 of file APValue.h.

References isFloat().

Referenced by APValue().

◆ setInt()

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

Definition at line 349 of file APValue.h.

Referenced by APValue().

◆ setLValue() [1/2]

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

Definition at line 589 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,
unsigned  CallIndex,
bool  IsNullPtr 
)

◆ setUnion()

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

Definition at line 383 of file APValue.h.

References isUnion().

Referenced by APValue().

◆ setVector()

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

Definition at line 357 of file APValue.h.

Referenced by APValue().

◆ swap()

void APValue::swap ( APValue RHS)

Swaps the contents of this and the given APValue.

Definition at line 250 of file APValue.cpp.

Referenced by APValue(), isOnePastTheEndOfCompleteObject(), operator=(), and ~APValue().


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