clang::interp::Integral< Bits, Signed > Class Template Reference

Wrapper around numeric types. More...

#include "/home/buildbot/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/AST/ByteCode/Integral.h"

Public Types
using	AsUnsigned = Integral< Bits, false >

Public Member Functions
	Integral ()
	Zero-initializes an integral.
template<unsigned SrcBits, bool SrcSign>
	Integral (Integral< SrcBits, SrcSign > V)
	Constructs an integral from another integral.
	Integral (const APSInt &V)
	Construct an integral from a value based on signedness.
bool	operator< (Integral RHS) const
bool	operator> (Integral RHS) const
bool	operator<= (Integral RHS) const
bool	operator>= (Integral RHS) const
bool	operator== (Integral RHS) const
bool	operator!= (Integral RHS) const
bool	operator> (unsigned RHS) const
Integral	operator- () const
Integral	operator- (const Integral &Other) const
Integral	operator~ () const
template<unsigned DstBits, bool DstSign>
	operator Integral< DstBits, DstSign > () const
template<typename Ty , typename = std::enable_if_t<std::is_integral_v<Ty>>>
	operator Ty () const
APSInt	toAPSInt () const
APSInt	toAPSInt (unsigned BitWidth) const
APInt	toAPInt (unsigned BitWidth) const
APValue	toAPValue (const ASTContext &) const
Integral< Bits, false >	toUnsigned () const
bool	isZero () const
bool	isMin () const
bool	isMinusOne () const
bool	isNegative () const
bool	isPositive () const
ComparisonCategoryResult	compare (const Integral &RHS) const
void	bitcastToMemory (std::byte *Dest) const
std::string	toDiagnosticString (const ASTContext &Ctx) const
unsigned	countLeadingZeros () const
Integral	truncate (unsigned TruncBits) const
void	print (llvm::raw_ostream &OS) const

Static Public Member Functions
static constexpr unsigned	bitWidth ()
static constexpr bool	isSigned ()
static Integral	bitcastFromMemory (const std::byte *Src, unsigned BitWidth)
static Integral	min (unsigned NumBits)
static Integral	max (unsigned NumBits)
template<typename ValT >
static Integral	from (ValT Value)
template<unsigned SrcBits, bool SrcSign>
static std::enable_if_t< SrcBits !=0, Integral >	from (Integral< SrcBits, SrcSign > Value)
static Integral	zero (unsigned BitWidth=0)
template<typename T >
static Integral	from (T Value, unsigned NumBits)
static bool	inRange (int64_t Value, unsigned NumBits)
static bool	increment (Integral A, Integral *R)
static bool	decrement (Integral A, Integral *R)
static bool	add (Integral A, Integral B, unsigned OpBits, Integral *R)
static bool	sub (Integral A, Integral B, unsigned OpBits, Integral *R)
static bool	mul (Integral A, Integral B, unsigned OpBits, Integral *R)
static bool	rem (Integral A, Integral B, unsigned OpBits, Integral *R)
static bool	div (Integral A, Integral B, unsigned OpBits, Integral *R)
static bool	bitAnd (Integral A, Integral B, unsigned OpBits, Integral *R)
static bool	bitOr (Integral A, Integral B, unsigned OpBits, Integral *R)
static bool	bitXor (Integral A, Integral B, unsigned OpBits, Integral *R)
static bool	neg (Integral A, Integral *R)
static bool	comp (Integral A, Integral *R)
template<unsigned RHSBits, bool RHSSign>
static void	shiftLeft (const Integral A, const Integral< RHSBits, RHSSign > B, unsigned OpBits, Integral *R)
template<unsigned RHSBits, bool RHSSign>
static void	shiftRight (const Integral A, const Integral< RHSBits, RHSSign > B, unsigned OpBits, Integral *R)

Friends
template<unsigned OtherBits, bool OtherSigned>
class	Integral

Detailed Description

template<unsigned Bits, bool Signed>
class clang::interp::Integral< Bits, Signed >

Wrapper around numeric types.

These wrappers are required to shared an interface between APSint and builtin primitive numeral types, while optimising for storage and allowing methods operating on primitive type to compile to fast code.

Definition at line 66 of file Integral.h.

Member Typedef Documentation

AsUnsigned

template<unsigned Bits, bool Signed>

using clang::interp::Integral< Bits, Signed >::AsUnsigned = Integral<Bits, false>

Definition at line 83 of file Integral.h.

Constructor & Destructor Documentation

Integral() [1/3]

template<unsigned Bits, bool Signed>

clang::interp::Integral< Bits, Signed >::Integral ( )

inline

Zero-initializes an integral.

Definition at line 86 of file Integral.h.

Integral() [2/3]

template<unsigned Bits, bool Signed>

template<unsigned SrcBits, bool SrcSign>

clang::interp::Integral< Bits, Signed >::Integral ( Integral< SrcBits, SrcSign >  V )

inlineexplicit

Constructs an integral from another integral.

Definition at line 90 of file Integral.h.

Integral() [3/3]

template<unsigned Bits, bool Signed>

clang::interp::Integral< Bits, Signed >::Integral ( const APSInt &  V )

inlineexplicit

Construct an integral from a value based on signedness.

Definition at line 93 of file Integral.h.

Member Function Documentation

add()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::add ( Integral< Bits, Signed >  A, Integral< Bits, Signed >  B, unsigned  OpBits, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 234 of file Integral.h.

Referenced by clang::interp::Integral< Bits, Signed >::increment().

bitAnd()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::bitAnd ( Integral< Bits, Signed >  A, Integral< Bits, Signed >  B, unsigned  OpBits, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 256 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral.

bitcastFromMemory()

template<unsigned Bits, bool Signed>

static Integral clang::interp::Integral< Bits, Signed >::bitcastFromMemory ( const std::byte *  Src, unsigned  BitWidth  )

inlinestatic

Definition at line 164 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral, and V.

bitcastToMemory()

template<unsigned Bits, bool Signed>

void clang::interp::Integral< Bits, Signed >::bitcastToMemory ( std::byte *  Dest ) const

inline

Definition at line 160 of file Integral.h.

References V.

bitOr()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::bitOr ( Integral< Bits, Signed >  A, Integral< Bits, Signed >  B, unsigned  OpBits, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 261 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral.

bitWidth()

template<unsigned Bits, bool Signed>

static constexpr unsigned clang::interp::Integral< Bits, Signed >::bitWidth ( )

inlinestaticconstexpr

Definition at line 143 of file Integral.h.

Referenced by clang::interp::Integral< Bits, Signed >::decrement(), clang::interp::Integral< Bits, Signed >::increment(), and clang::interp::Integral< Bits, Signed >::isMin().

bitXor()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::bitXor ( Integral< Bits, Signed >  A, Integral< Bits, Signed >  B, unsigned  OpBits, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 266 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral.

comp()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::comp ( Integral< Bits, Signed >  A, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 279 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral.

compare()

template<unsigned Bits, bool Signed>

ComparisonCategoryResult clang::interp::Integral< Bits, Signed >::compare ( const Integral< Bits, Signed > &  RHS ) const

inline

Definition at line 156 of file Integral.h.

References clang::interp::Compare(), and V.

countLeadingZeros()

template<unsigned Bits, bool Signed>

unsigned clang::interp::Integral< Bits, Signed >::countLeadingZeros ( ) const

inline

Definition at line 179 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::isPositive(), clang::Signed, and V.

decrement()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::decrement ( Integral< Bits, Signed >  A, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 230 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::bitWidth(), clang::interp::Integral< Bits, Signed >::Integral, and clang::interp::Integral< Bits, Signed >::sub().

div()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::div ( Integral< Bits, Signed >  A, Integral< Bits, Signed >  B, unsigned  OpBits, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 251 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral.

from() [1/3]

template<unsigned Bits, bool Signed>

template<unsigned SrcBits, bool SrcSign>

static std::enable_if_t< SrcBits !=0, Integral > clang::interp::Integral< Bits, Signed >::from ( Integral< SrcBits, SrcSign >  Value )

inlinestatic

Definition at line 212 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral.

from() [2/3]

template<unsigned Bits, bool Signed>

template<typename T >

static Integral clang::interp::Integral< Bits, Signed >::from ( T  Value, unsigned  NumBits  )

inlinestatic

Definition at line 218 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral.

from() [3/3]

template<unsigned Bits, bool Signed>

template<typename ValT >

static Integral clang::interp::Integral< Bits, Signed >::from ( ValT  Value )

inlinestatic

Definition at line 203 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::from(), and clang::interp::Integral< Bits, Signed >::Integral.

Referenced by clang::interp::Integral< Bits, Signed >::from(), clang::interp::Integral< Bits, Signed >::shiftLeft(), clang::interp::Integral< Bits, Signed >::shiftRight(), and clang::interp::Integral< Bits, Signed >::zero().

increment()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::increment ( Integral< Bits, Signed >  A, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 226 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::add(), clang::interp::Integral< Bits, Signed >::bitWidth(), and clang::interp::Integral< Bits, Signed >::Integral.

inRange()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::inRange ( int64_t  Value, unsigned  NumBits  )

inlinestatic

Definition at line 222 of file Integral.h.

isMin()

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::isMin ( ) const

inline

Definition at line 147 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::bitWidth(), and clang::interp::Integral< Bits, Signed >::min().

Referenced by clang::interp::Integral< Bits, Signed >::neg().

isMinusOne()

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::isMinusOne ( ) const

inline

Definition at line 149 of file Integral.h.

References clang::Signed, and V.

isNegative()

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::isNegative ( ) const

inline

Definition at line 153 of file Integral.h.

References V.

Referenced by clang::interp::Integral< Bits, Signed >::isPositive().

isPositive()

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::isPositive ( ) const

inline

Definition at line 154 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::isNegative().

Referenced by clang::interp::Integral< Bits, Signed >::countLeadingZeros().

isSigned()

template<unsigned Bits, bool Signed>

static constexpr bool clang::interp::Integral< Bits, Signed >::isSigned ( )

inlinestaticconstexpr

Definition at line 151 of file Integral.h.

References clang::Signed.

isZero()

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::isZero ( ) const

inline

Definition at line 145 of file Integral.h.

References V.

max()

template<unsigned Bits, bool Signed>

static Integral clang::interp::Integral< Bits, Signed >::max ( unsigned  NumBits )

inlinestatic

Definition at line 201 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral.

min()

template<unsigned Bits, bool Signed>

static Integral clang::interp::Integral< Bits, Signed >::min ( unsigned  NumBits )

inlinestatic

Definition at line 200 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral.

Referenced by clang::interp::Integral< Bits, Signed >::isMin().

mul()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::mul ( Integral< Bits, Signed >  A, Integral< Bits, Signed >  B, unsigned  OpBits, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 242 of file Integral.h.

neg()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::neg ( Integral< Bits, Signed >  A, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 271 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::isMin(), and clang::Signed.

operator Integral< DstBits, DstSign >()

template<unsigned Bits, bool Signed>

template<unsigned DstBits, bool DstSign>

clang::interp::Integral< Bits, Signed >::operator Integral< DstBits, DstSign > ( ) const

inlineexplicit

Definition at line 114 of file Integral.h.

References V.

operator Ty()

template<unsigned Bits, bool Signed>

template<typename Ty , typename = std::enable_if_t<std::is_integral_v<Ty>>>

clang::interp::Integral< Bits, Signed >::operator Ty ( ) const

inlineexplicit

Definition at line 119 of file Integral.h.

References V.

operator!=()

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::operator!= ( Integral< Bits, Signed >  RHS ) const

inline

Definition at line 101 of file Integral.h.

References V.

operator-() [1/2]

template<unsigned Bits, bool Signed>

Integral clang::interp::Integral< Bits, Signed >::operator- ( ) const

inline

Definition at line 107 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral, and V.

operator-() [2/2]

template<unsigned Bits, bool Signed>

Integral clang::interp::Integral< Bits, Signed >::operator- ( const Integral< Bits, Signed > &  Other ) const

inline

Definition at line 108 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral, clang::Other, and V.

operator<()

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::operator< ( Integral< Bits, Signed >  RHS ) const

inline

Definition at line 96 of file Integral.h.

References V.

operator<=()

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::operator<= ( Integral< Bits, Signed >  RHS ) const

inline

Definition at line 98 of file Integral.h.

References V.

operator==()

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::operator== ( Integral< Bits, Signed >  RHS ) const

inline

Definition at line 100 of file Integral.h.

References V.

operator>() [1/2]

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::operator> ( Integral< Bits, Signed >  RHS ) const

inline

Definition at line 97 of file Integral.h.

References V.

operator>() [2/2]

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::operator> ( unsigned  RHS ) const

inline

Definition at line 103 of file Integral.h.

References V.

operator>=()

template<unsigned Bits, bool Signed>

bool clang::interp::Integral< Bits, Signed >::operator>= ( Integral< Bits, Signed >  RHS ) const

inline

Definition at line 99 of file Integral.h.

References V.

operator~()

template<unsigned Bits, bool Signed>

Integral clang::interp::Integral< Bits, Signed >::operator~ ( ) const

inline

Definition at line 111 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral, and V.

print()

template<unsigned Bits, bool Signed>

void clang::interp::Integral< Bits, Signed >::print ( llvm::raw_ostream &  OS ) const

inline

Definition at line 198 of file Integral.h.

References V.

Referenced by clang::interp::operator<<().

rem()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::rem ( Integral< Bits, Signed >  A, Integral< Bits, Signed >  B, unsigned  OpBits, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 246 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral.

shiftLeft()

template<unsigned Bits, bool Signed>

template<unsigned RHSBits, bool RHSSign>

static void clang::interp::Integral< Bits, Signed >::shiftLeft ( const Integral< Bits, Signed >  A, const Integral< RHSBits, RHSSign >  B, unsigned  OpBits, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 285 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::from().

shiftRight()

template<unsigned Bits, bool Signed>

template<unsigned RHSBits, bool RHSSign>

static void clang::interp::Integral< Bits, Signed >::shiftRight ( const Integral< Bits, Signed >  A, const Integral< RHSBits, RHSSign >  B, unsigned  OpBits, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 291 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::from().

sub()

template<unsigned Bits, bool Signed>

static bool clang::interp::Integral< Bits, Signed >::sub ( Integral< Bits, Signed >  A, Integral< Bits, Signed >  B, unsigned  OpBits, Integral< Bits, Signed > *  R  )

inlinestatic

Definition at line 238 of file Integral.h.

Referenced by clang::interp::Integral< Bits, Signed >::decrement().

toAPInt()

template<unsigned Bits, bool Signed>

APInt clang::interp::Integral< Bits, Signed >::toAPInt ( unsigned  BitWidth ) const

inline

Definition at line 129 of file Integral.h.

References clang::Signed, and V.

Referenced by clang::interp::IntegralAP< Signed >::from(), and clang::interp::Integral< Bits, Signed >::toAPSInt().

toAPSInt() [1/2]

template<unsigned Bits, bool Signed>

APSInt clang::interp::Integral< Bits, Signed >::toAPSInt ( ) const

inline

Definition at line 123 of file Integral.h.

References clang::Signed, and V.

Referenced by clang::interp::Integral< Bits, Signed >::toAPValue().

toAPSInt() [2/2]

template<unsigned Bits, bool Signed>

APSInt clang::interp::Integral< Bits, Signed >::toAPSInt ( unsigned  BitWidth ) const

inline

Definition at line 126 of file Integral.h.

References clang::Signed, and clang::interp::Integral< Bits, Signed >::toAPInt().

toAPValue()

template<unsigned Bits, bool Signed>

APValue clang::interp::Integral< Bits, Signed >::toAPValue ( const ASTContext &  ) const

inline

Definition at line 137 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::toAPSInt().

toDiagnosticString()

template<unsigned Bits, bool Signed>

std::string clang::interp::Integral< Bits, Signed >::toDiagnosticString ( const ASTContext &  Ctx ) const

inline

Definition at line 172 of file Integral.h.

References V.

toUnsigned()

template<unsigned Bits, bool Signed>

Integral< Bits, false > clang::interp::Integral< Bits, Signed >::toUnsigned ( ) const

inline

Definition at line 139 of file Integral.h.

truncate()

template<unsigned Bits, bool Signed>

Integral clang::interp::Integral< Bits, Signed >::truncate ( unsigned  TruncBits ) const

inline

Definition at line 188 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::Integral, clang::Signed, and V.

zero()

template<unsigned Bits, bool Signed>

static Integral clang::interp::Integral< Bits, Signed >::zero ( unsigned  BitWidth = 0 )

inlinestatic

Definition at line 216 of file Integral.h.

References clang::interp::Integral< Bits, Signed >::from().

Friends And Related Function Documentation

Integral

template<unsigned Bits, bool Signed>

template<unsigned OtherBits, bool OtherSigned>

friend class Integral

friend

Definition at line 68 of file Integral.h.

Referenced by clang::interp::Integral< Bits, Signed >::bitAnd(), clang::interp::Integral< Bits, Signed >::bitcastFromMemory(), clang::interp::Integral< Bits, Signed >::bitOr(), clang::interp::Integral< Bits, Signed >::bitXor(), clang::interp::Integral< Bits, Signed >::comp(), clang::interp::Integral< Bits, Signed >::decrement(), clang::interp::Integral< Bits, Signed >::div(), clang::interp::Integral< Bits, Signed >::from(), clang::interp::Integral< Bits, Signed >::increment(), clang::interp::Integral< Bits, Signed >::max(), clang::interp::Integral< Bits, Signed >::min(), clang::interp::Integral< Bits, Signed >::operator-(), clang::interp::Integral< Bits, Signed >::operator~(), clang::interp::Integral< Bits, Signed >::rem(), and clang::interp::Integral< Bits, Signed >::truncate().

---

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

• lib/AST/ByteCode/Integral.h