LLVM API Documentation

llvm::IntegerType Class Reference

Integer representation type. More...

#include <DerivedTypes.h>

Inheritance diagram for llvm::IntegerType:
[legend]
Collaboration diagram for llvm::IntegerType:
[legend]

List of all members.

Public Types

enum  { MIN_INT_BITS = 1, MAX_INT_BITS = (1<<23)-1 }
 This enum is just used to hold constants we need for IntegerType. More...

Public Member Functions

unsigned getBitWidth () const
 Get the number of bits in this IntegerType.
uint64_t getBitMask () const
uint64_t getSignBit () const
APInt getMask () const
 Get a bit mask for this type.
bool isPowerOf2ByteWidth () const
 Is this a power-of-2 byte-width IntegerType ?

Static Public Member Functions

static const IntegerType * get (LLVMContext &C, unsigned NumBits)
 Get or create an IntegerType instance.
static bool classof (const IntegerType *)
static bool classof (const Type *T)
 Methods for support type inquiry through isa, cast, and dyn_cast:.

Protected Member Functions

 IntegerType (LLVMContext &C, unsigned NumBits)

Friends

class LLVMContextImpl
class TypeMap< IntegerValType, IntegerType >


Detailed Description

Integer representation type.

Class to represent integer types. Note that this class is also used to represent the built-in integer types: Int1Ty, Int8Ty, Int16Ty, Int32Ty and Int64Ty.

Definition at line 85 of file DerivedTypes.h.


Member Enumeration Documentation

anonymous enum

This enum is just used to hold constants we need for IntegerType.

Enumerator:
MIN_INT_BITS  Minimum number of bits that can be specified.
MAX_INT_BITS  Maximum number of bits that can be specified Note that bit width is stored in the Type classes SubclassData field which has 23 bits. This yields a maximum bit width of 8,388,607 bits.

Definition at line 96 of file DerivedTypes.h.


Constructor & Destructor Documentation

llvm::IntegerType::IntegerType ( LLVMContext &  C,
unsigned  NumBits 
) [inline, explicit, protected]

Definition at line 89 of file DerivedTypes.h.

References llvm::Type::setSubclassData().

Referenced by get().


Member Function Documentation

const IntegerType * IntegerType::get ( LLVMContext &  C,
unsigned  NumBits 
) [static]

unsigned llvm::IntegerType::getBitWidth (  )  const [inline]

uint64_t llvm::IntegerType::getBitMask (  )  const [inline]

getBitMask - Return a bitmask with ones set for all of the bits that can be set by an unsigned version of this type. This is 0xFF for i8, 0xFFFF for i16, etc.

Definition at line 116 of file DerivedTypes.h.

References getBitWidth().

uint64_t llvm::IntegerType::getSignBit (  )  const [inline]

getSignBit - Return a uint64_t with just the most significant bit set (the sign bit, if the value is treated as a signed number).

Definition at line 122 of file DerivedTypes.h.

References getBitWidth().

APInt IntegerType::getMask (  )  const

Get a bit mask for this type.

For example, this is 0xFF for an 8 bit integer, 0xFFFF for i16, etc.

Returns:
a bit mask with ones set for all the bits of this type.

Definition at line 769 of file Type.cpp.

References llvm::APInt::getAllOnesValue(), and getBitWidth().

bool IntegerType::isPowerOf2ByteWidth (  )  const

Is this a power-of-2 byte-width IntegerType ?

This method determines if the width of this IntegerType is a power-of-2 in terms of 8 bit bytes.

Returns:
true if this is a power-of-2 byte width.

Definition at line 764 of file Type.cpp.

References getBitWidth(), and llvm::isPowerOf2_32().

static bool llvm::IntegerType::classof ( const IntegerType *   )  [inline, static]

Definition at line 138 of file DerivedTypes.h.

static bool llvm::IntegerType::classof ( const Type *   )  [inline, static]

Methods for support type inquiry through isa, cast, and dyn_cast:.

Reimplemented from llvm::DerivedType.

Definition at line 139 of file DerivedTypes.h.

References llvm::Type::getTypeID(), and llvm::Type::IntegerTyID.


Friends And Related Function Documentation

friend class LLVMContextImpl [friend]

Reimplemented from llvm::Type.

Definition at line 86 of file DerivedTypes.h.

friend class TypeMap< IntegerValType, IntegerType > [friend]

Definition at line 93 of file DerivedTypes.h.


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