clang 23.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
clang::interp::IntegralAP< Signed > Class Template Reference

If an IntegralAP is constructed from Memory, it DOES NOT OWN THAT MEMORY. More...

#include "/work/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/AST/ByteCode/IntegralAP.h"

Inheritance diagram for clang::interp::IntegralAP< Signed >:
[legend]

Public Types

using AsUnsigned = IntegralAP<false>

Public Member Functions

APInt getValue () const
void take (uint64_t *NewMemory)
void copy (const APInt &V)
 IntegralAP ()=default
 IntegralAP (unsigned BitWidth)
 Zeroed, single-word IntegralAP of the given bitwidth.
 IntegralAP (uint64_t *Memory, unsigned BitWidth)
 IntegralAP (const APInt &V)
IntegralAP operator- () const
bool operator> (const IntegralAP &RHS) const
bool operator>= (unsigned RHS) const
bool operator< (IntegralAP RHS) const
template<typename Ty, typename = std::enable_if_t<std::is_integral_v<Ty>>>
 operator Ty () const
constexpr uint32_t bitWidth () const
constexpr unsigned numWords () const
constexpr bool singleWord () const
APSInt toAPSInt (unsigned Bits=0) const
APValue toAPValue (const ASTContext &) const
bool isZero () const
bool isPositive () const
bool isNegative () const
bool isMin () const
bool isMax () const
bool isMinusOne () const
unsigned countLeadingZeros () const
void print (llvm::raw_ostream &OS) const
std::string toDiagnosticString (const ASTContext &Ctx) const
IntegralAP truncate (unsigned BitWidth) const
IntegralAP< false > toUnsigned () const
void bitcastToMemory (std::byte *Dest) const
ComparisonCategoryResult compare (const IntegralAP &RHS) const
size_t bytesToSerialize () const
void serialize (std::byte *Buff) const

Static Public Member Functions

template<typename T, bool InputSigned>
static T truncateCast (const APInt &V)
template<typename T>
static IntegralAP from (T Value, unsigned NumBits=0)
static constexpr bool isNumber ()
static constexpr bool isSigned ()
static void bitcastFromMemory (const std::byte *Src, unsigned BitWidth, IntegralAP *Result)
static bool increment (IntegralAP A, IntegralAP *R)
static bool decrement (IntegralAP A, IntegralAP *R)
static bool add (IntegralAP A, IntegralAP B, unsigned OpBits, IntegralAP *R)
static bool sub (IntegralAP A, IntegralAP B, unsigned OpBits, IntegralAP *R)
static bool mul (IntegralAP A, IntegralAP B, unsigned OpBits, IntegralAP *R)
static bool rem (IntegralAP A, IntegralAP B, unsigned OpBits, IntegralAP *R)
static bool div (IntegralAP A, IntegralAP B, unsigned OpBits, IntegralAP *R)
static bool bitAnd (IntegralAP A, IntegralAP B, unsigned OpBits, IntegralAP *R)
static bool bitOr (IntegralAP A, IntegralAP B, unsigned OpBits, IntegralAP *R)
static bool bitXor (IntegralAP A, IntegralAP B, unsigned OpBits, IntegralAP *R)
static bool neg (const IntegralAP &A, IntegralAP *R)
static bool comp (IntegralAP A, IntegralAP *R)
static void shiftLeft (const IntegralAP A, const IntegralAP B, unsigned OpBits, IntegralAP *R)
static void shiftRight (const IntegralAP A, const IntegralAP B, unsigned OpBits, IntegralAP *R)
static uint32_t deserializeSize (const std::byte *Buff)
static void deserialize (const std::byte *Buff, IntegralAP< Signed > *Result)

Public Attributes

union { 
   uint64_t *   Memory = nullptr 
   uint64_t   Val 
}; 
uint32_t BitWidth = 0
friend IntegralAP<!Signed >

Detailed Description

template<bool Signed>
class clang::interp::IntegralAP< Signed >

If an IntegralAP is constructed from Memory, it DOES NOT OWN THAT MEMORY.

It will NOT copy the memory (unless, of course, copy() is called) and it won't alllocate anything. The allocation should happen via InterpState or Program.

Definition at line 36 of file IntegralAP.h.

Member Typedef Documentation

◆ AsUnsigned

template<bool Signed>
using clang::interp::IntegralAP< Signed >::AsUnsigned = IntegralAP<false>

Definition at line 70 of file IntegralAP.h.

Constructor & Destructor Documentation

◆ IntegralAP() [1/4]

template<bool Signed>
clang::interp::IntegralAP< Signed >::IntegralAP ( )
default

Referenced by clang::interp::IntegralAP< false >::from(), clang::interp::IntegralAP< false >::operator-(), clang::interp::IntegralAP< false >::shiftLeft(), and clang::interp::IntegralAP< false >::truncate().

◆ IntegralAP() [2/4]

template<bool Signed>
clang::interp::IntegralAP< Signed >::IntegralAP ( unsigned BitWidth)
inline

Zeroed, single-word IntegralAP of the given bitwidth.

Definition at line 95 of file IntegralAP.h.

◆ IntegralAP() [3/4]

template<bool Signed>
clang::interp::IntegralAP< Signed >::IntegralAP ( uint64_t * Memory,
unsigned BitWidth )
inline

Definition at line 98 of file IntegralAP.h.

◆ IntegralAP() [4/4]

template<bool Signed>
clang::interp::IntegralAP< Signed >::IntegralAP ( const APInt & V)
inline

Definition at line 100 of file IntegralAP.h.

Member Function Documentation

◆ add()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::add ( IntegralAP< Signed > A,
IntegralAP< Signed > B,
unsigned OpBits,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 245 of file IntegralAP.h.

Referenced by clang::interp::IntegralAP< false >::increment().

◆ bitAnd()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::bitAnd ( IntegralAP< Signed > A,
IntegralAP< Signed > B,
unsigned OpBits,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 273 of file IntegralAP.h.

◆ bitcastFromMemory()

template<bool Signed>
void clang::interp::IntegralAP< Signed >::bitcastFromMemory ( const std::byte * Src,
unsigned BitWidth,
IntegralAP< Signed > * Result )
inlinestatic

Definition at line 207 of file IntegralAP.h.

Referenced by clang::interp::DoBitCastPtr().

◆ bitcastToMemory()

template<bool Signed>
void clang::interp::IntegralAP< Signed >::bitcastToMemory ( std::byte * Dest) const
inline

Definition at line 203 of file IntegralAP.h.

◆ bitOr()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::bitOr ( IntegralAP< Signed > A,
IntegralAP< Signed > B,
unsigned OpBits,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 279 of file IntegralAP.h.

◆ bitWidth()

template<bool Signed>
uint32_t clang::interp::IntegralAP< Signed >::bitWidth ( ) const
inlineconstexpr

Definition at line 139 of file IntegralAP.h.

Referenced by clang::interp::IntegralAP< false >::bitcastToMemory(), clang::interp::IntegralAP< false >::compare(), clang::interp::IntegralAP< false >::decrement(), clang::interp::IntegralAP< false >::increment(), clang::interp::IntegralAP< false >::toAPSInt(), and clang::interp::IntegralAP< false >::truncate().

◆ bitXor()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::bitXor ( IntegralAP< Signed > A,
IntegralAP< Signed > B,
unsigned OpBits,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 285 of file IntegralAP.h.

◆ bytesToSerialize()

template<bool Signed>
size_t clang::interp::IntegralAP< Signed >::bytesToSerialize ( ) const
inline

Definition at line 318 of file IntegralAP.h.

◆ comp()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::comp ( IntegralAP< Signed > A,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 298 of file IntegralAP.h.

◆ compare()

template<bool Signed>
ComparisonCategoryResult clang::interp::IntegralAP< Signed >::compare ( const IntegralAP< Signed > & RHS) const
inline

Definition at line 214 of file IntegralAP.h.

◆ copy()

template<bool Signed>
void clang::interp::IntegralAP< Signed >::copy ( const APInt & V)
inline

Definition at line 78 of file IntegralAP.h.

Referenced by clang::interp::CastFloatingIntegralAP(), and clang::interp::CastFloatingIntegralAPS().

◆ countLeadingZeros()

template<bool Signed>
unsigned clang::interp::IntegralAP< Signed >::countLeadingZeros ( ) const
inline

Definition at line 180 of file IntegralAP.h.

◆ decrement()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::decrement ( IntegralAP< Signed > A,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 240 of file IntegralAP.h.

◆ deserialize()

template<bool Signed>
void clang::interp::IntegralAP< Signed >::deserialize ( const std::byte * Buff,
IntegralAP< Signed > * Result )
inlinestatic

Definition at line 337 of file IntegralAP.h.

◆ deserializeSize()

template<bool Signed>
uint32_t clang::interp::IntegralAP< Signed >::deserializeSize ( const std::byte * Buff)
inlinestatic

Definition at line 333 of file IntegralAP.h.

◆ div()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::div ( IntegralAP< Signed > A,
IntegralAP< Signed > B,
unsigned OpBits,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 265 of file IntegralAP.h.

◆ from()

template<bool Signed>
template<typename T>
IntegralAP clang::interp::IntegralAP< Signed >::from ( T Value,
unsigned NumBits = 0 )
inlinestatic

Definition at line 130 of file IntegralAP.h.

◆ getValue()

template<bool Signed>
APInt clang::interp::IntegralAP< Signed >::getValue ( ) const
inline

Definition at line 62 of file IntegralAP.h.

Referenced by clang::interp::IntegralAP< false >::bitAnd(), clang::interp::IntegralAP< false >::bitcastToMemory(), clang::interp::IntegralAP< false >::bitOr(), clang::interp::IntegralAP< false >::bitXor(), clang::interp::IntegralAP< false >::comp(), clang::interp::IntegralAP< false >::compare(), clang::interp::IntegralAP< false >::countLeadingZeros(), clang::interp::IntegralAP< false >::div(), clang::interp::IntegralAP< false >::isMax(), clang::interp::IntegralAP< false >::isMin(), clang::interp::IntegralAP< false >::isMinusOne(), clang::interp::IntegralAP< false >::isNegative(), clang::interp::IntegralAP< false >::isPositive(), clang::interp::IntegralAP< false >::isZero(), clang::interp::IntegralAP< false >::neg(), clang::interp::IntegralAP< false >::operator Ty(), clang::interp::IntegralAP< false >::operator-(), clang::interp::IntegralAP< false >::operator<(), clang::interp::IntegralAP< false >::operator>(), clang::interp::IntegralAP< false >::operator>=(), clang::interp::IntegralAP< false >::print(), clang::interp::IntegralAP< false >::rem(), clang::interp::IntegralAP< false >::shiftLeft(), clang::interp::IntegralAP< false >::shiftRight(), clang::interp::IntegralAP< false >::toAPSInt(), and clang::interp::IntegralAP< false >::truncate().

◆ increment()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::increment ( IntegralAP< Signed > A,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 235 of file IntegralAP.h.

◆ isMax()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::isMax ( ) const
inline

Definition at line 172 of file IntegralAP.h.

◆ isMin()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::isMin ( ) const
inline

Definition at line 167 of file IntegralAP.h.

◆ isMinusOne()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::isMinusOne ( ) const
inline

Definition at line 178 of file IntegralAP.h.

◆ isNegative()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::isNegative ( ) const
inline

Definition at line 162 of file IntegralAP.h.

◆ isNumber()

template<bool Signed>
constexpr bool clang::interp::IntegralAP< Signed >::isNumber ( )
inlinestaticconstexpr

Definition at line 142 of file IntegralAP.h.

◆ isPositive()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::isPositive ( ) const
inline

Definition at line 157 of file IntegralAP.h.

◆ isSigned()

template<bool Signed>
constexpr bool clang::interp::IntegralAP< Signed >::isSigned ( )
inlinestaticconstexpr

Definition at line 177 of file IntegralAP.h.

Referenced by clang::interp::IntegralAP< false >::compare().

◆ isZero()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::isZero ( ) const
inline

Definition at line 156 of file IntegralAP.h.

◆ mul()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::mul ( IntegralAP< Signed > A,
IntegralAP< Signed > B,
unsigned OpBits,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 253 of file IntegralAP.h.

◆ neg()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::neg ( const IntegralAP< Signed > & A,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 291 of file IntegralAP.h.

◆ numWords()

template<bool Signed>
unsigned clang::interp::IntegralAP< Signed >::numWords ( ) const
inlineconstexpr

Definition at line 140 of file IntegralAP.h.

Referenced by clang::interp::IntegralAP< false >::bytesToSerialize(), clang::interp::IntegralAP< false >::copy(), clang::interp::IntegralAP< false >::serialize(), clang::interp::IntegralAP< false >::singleWord(), and clang::interp::IntegralAP< false >::take().

◆ operator Ty()

template<bool Signed>
template<typename Ty, typename = std::enable_if_t<std::is_integral_v<Ty>>>
clang::interp::IntegralAP< Signed >::operator Ty ( ) const
inlineexplicit

Definition at line 126 of file IntegralAP.h.

◆ operator-()

template<bool Signed>
IntegralAP clang::interp::IntegralAP< Signed >::operator- ( ) const
inline

Definition at line 108 of file IntegralAP.h.

◆ operator<()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::operator< ( IntegralAP< Signed > RHS) const
inline

Definition at line 119 of file IntegralAP.h.

◆ operator>()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::operator> ( const IntegralAP< Signed > & RHS) const
inline

Definition at line 109 of file IntegralAP.h.

◆ operator>=()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::operator>= ( unsigned RHS) const
inline

Definition at line 114 of file IntegralAP.h.

◆ print()

template<bool Signed>
void clang::interp::IntegralAP< Signed >::print ( llvm::raw_ostream & OS) const
inline

Definition at line 182 of file IntegralAP.h.

Referenced by clang::interp::operator<<(), and clang::interp::IntegralAP< false >::toDiagnosticString().

◆ rem()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::rem ( IntegralAP< Signed > A,
IntegralAP< Signed > B,
unsigned OpBits,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 257 of file IntegralAP.h.

◆ serialize()

template<bool Signed>
void clang::interp::IntegralAP< Signed >::serialize ( std::byte * Buff) const
inline

Definition at line 323 of file IntegralAP.h.

◆ shiftLeft()

template<bool Signed>
void clang::interp::IntegralAP< Signed >::shiftLeft ( const IntegralAP< Signed > A,
const IntegralAP< Signed > B,
unsigned OpBits,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 303 of file IntegralAP.h.

◆ shiftRight()

template<bool Signed>
void clang::interp::IntegralAP< Signed >::shiftRight ( const IntegralAP< Signed > A,
const IntegralAP< Signed > B,
unsigned OpBits,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 308 of file IntegralAP.h.

◆ singleWord()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::singleWord ( ) const
inlineconstexpr

Definition at line 141 of file IntegralAP.h.

Referenced by clang::interp::IntegralAP< false >::getValue(), clang::interp::IntegralAP< false >::IntegralAP(), clang::interp::IntegralAP< false >::serialize(), and clang::interp::IntegralAP< false >::take().

◆ sub()

template<bool Signed>
bool clang::interp::IntegralAP< Signed >::sub ( IntegralAP< Signed > A,
IntegralAP< Signed > B,
unsigned OpBits,
IntegralAP< Signed > * R )
inlinestatic

Definition at line 249 of file IntegralAP.h.

Referenced by clang::interp::IntegralAP< false >::decrement().

◆ take()

template<bool Signed>
void clang::interp::IntegralAP< Signed >::take ( uint64_t * NewMemory)
inline

Definition at line 72 of file IntegralAP.h.

◆ toAPSInt()

template<bool Signed>
APSInt clang::interp::IntegralAP< Signed >::toAPSInt ( unsigned Bits = 0) const
inline

Definition at line 144 of file IntegralAP.h.

Referenced by clang::interp::IntegralAP< false >::toAPValue().

◆ toAPValue()

template<bool Signed>
APValue clang::interp::IntegralAP< Signed >::toAPValue ( const ASTContext & ) const
inline

Definition at line 154 of file IntegralAP.h.

◆ toDiagnosticString()

template<bool Signed>
std::string clang::interp::IntegralAP< Signed >::toDiagnosticString ( const ASTContext & Ctx) const
inline

Definition at line 183 of file IntegralAP.h.

◆ toUnsigned()

template<bool Signed>
IntegralAP< false > clang::interp::IntegralAP< Signed >::toUnsigned ( ) const
inline

Definition at line 199 of file IntegralAP.h.

◆ truncate()

template<bool Signed>
IntegralAP clang::interp::IntegralAP< Signed >::truncate ( unsigned BitWidth) const
inline

Definition at line 190 of file IntegralAP.h.

◆ truncateCast()

template<bool Signed>
template<typename T, bool InputSigned>
T clang::interp::IntegralAP< Signed >::truncateCast ( const APInt & V)
inlinestatic

Definition at line 46 of file IntegralAP.h.

Referenced by clang::interp::IntegralAP< false >::operator Ty().

Member Data Documentation

◆ [union]

union { ... } clang::interp::IntegralAP< Signed >

◆ BitWidth

template<bool Signed>
uint32_t clang::interp::IntegralAP< Signed >::BitWidth = 0

Definition at line 42 of file IntegralAP.h.

◆ IntegralAP<!Signed >

template<bool Signed>
friend clang::interp::IntegralAP< Signed >::IntegralAP<!Signed >

Definition at line 43 of file IntegralAP.h.

◆ Memory

template<bool Signed>
uint64_t* clang::interp::IntegralAP< Signed >::Memory = nullptr

Definition at line 39 of file IntegralAP.h.

◆ Val

template<bool Signed>
uint64_t clang::interp::IntegralAP< Signed >::Val

Definition at line 40 of file IntegralAP.h.

The documentation for this class was generated from the following files:
Generated on for clang by doxygen 1.14.0