LLVM  3.7.0
Public Member Functions | Static Public Member Functions | List of all members
llvm::PointerType Class Reference

PointerType - Class to represent pointers. More...

#include <DerivedTypes.h>

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

Public Member Functions

unsigned getAddressSpace () const
 Return the address space of the Pointer type. More...
 
- Public Member Functions inherited from llvm::SequentialType
TypegetElementType () const
 
- Public Member Functions inherited from llvm::CompositeType
TypegetTypeAtIndex (const Value *V)
 getTypeAtIndex - Given an index value into the type, return the type of the element. More...
 
TypegetTypeAtIndex (unsigned Idx)
 
bool indexValid (const Value *V) const
 
bool indexValid (unsigned Idx) const
 
- Public Member Functions inherited from llvm::Type
void print (raw_ostream &O) const
 
void dump () const
 
LLVMContextgetContext () const
 getContext - Return the LLVMContext in which this type was uniqued. More...
 
TypeID getTypeID () const
 getTypeID - Return the type id for the type. More...
 
bool isVoidTy () const
 isVoidTy - Return true if this is 'void'. More...
 
bool isHalfTy () const
 isHalfTy - Return true if this is 'half', a 16-bit IEEE fp type. More...
 
bool isFloatTy () const
 isFloatTy - Return true if this is 'float', a 32-bit IEEE fp type. More...
 
bool isDoubleTy () const
 isDoubleTy - Return true if this is 'double', a 64-bit IEEE fp type. More...
 
bool isX86_FP80Ty () const
 isX86_FP80Ty - Return true if this is x86 long double. More...
 
bool isFP128Ty () const
 isFP128Ty - Return true if this is 'fp128'. More...
 
bool isPPC_FP128Ty () const
 isPPC_FP128Ty - Return true if this is powerpc long double. More...
 
bool isFloatingPointTy () const
 isFloatingPointTy - Return true if this is one of the six floating point types More...
 
const fltSemanticsgetFltSemantics () const
 
bool isX86_MMXTy () const
 isX86_MMXTy - Return true if this is X86 MMX. More...
 
bool isFPOrFPVectorTy () const
 isFPOrFPVectorTy - Return true if this is a FP type or a vector of FP. More...
 
bool isLabelTy () const
 isLabelTy - Return true if this is 'label'. More...
 
bool isMetadataTy () const
 isMetadataTy - Return true if this is 'metadata'. More...
 
bool isIntegerTy () const
 isIntegerTy - True if this is an instance of IntegerType. More...
 
bool isIntegerTy (unsigned Bitwidth) const
 isIntegerTy - Return true if this is an IntegerType of the given width. More...
 
bool isIntOrIntVectorTy () const
 isIntOrIntVectorTy - Return true if this is an integer type or a vector of integer types. More...
 
bool isFunctionTy () const
 isFunctionTy - True if this is an instance of FunctionType. More...
 
bool isStructTy () const
 isStructTy - True if this is an instance of StructType. More...
 
bool isArrayTy () const
 isArrayTy - True if this is an instance of ArrayType. More...
 
bool isPointerTy () const
 isPointerTy - True if this is an instance of PointerType. More...
 
bool isPtrOrPtrVectorTy () const
 isPtrOrPtrVectorTy - Return true if this is a pointer type or a vector of pointer types. More...
 
bool isVectorTy () const
 isVectorTy - True if this is an instance of VectorType. More...
 
bool canLosslesslyBitCastTo (Type *Ty) const
 canLosslesslyBitCastTo - Return true if this type could be converted with a lossless BitCast to type 'Ty'. More...
 
bool isEmptyTy () const
 isEmptyTy - Return true if this type is empty, that is, it has no elements or all its elements are empty. More...
 
bool isFirstClassType () const
 isFirstClassType - Return true if the type is "first class", meaning it is a valid type for a Value. More...
 
bool isSingleValueType () const
 isSingleValueType - Return true if the type is a valid type for a register in codegen. More...
 
bool isAggregateType () const
 isAggregateType - Return true if the type is an aggregate type. More...
 
bool isSized (SmallPtrSetImpl< const Type * > *Visited=nullptr) const
 isSized - Return true if it makes sense to take the size of this type. More...
 
unsigned getPrimitiveSizeInBits () const LLVM_READONLY
 getPrimitiveSizeInBits - Return the basic size of this type if it is a primitive type. More...
 
unsigned getScalarSizeInBits () const LLVM_READONLY
 getScalarSizeInBits - If this is a vector type, return the getPrimitiveSizeInBits value for the element type. More...
 
int getFPMantissaWidth () const
 getFPMantissaWidth - Return the width of the mantissa of this type. More...
 
const TypegetScalarType () const LLVM_READONLY
 getScalarType - If this is a vector type, return the element type, otherwise return 'this'. More...
 
TypegetScalarType () LLVM_READONLY
 getScalarType - If this is a vector type, return the element type, otherwise return this. More...
 
subtype_iterator subtype_begin () const
 
subtype_iterator subtype_end () const
 
ArrayRef< Type * > subtypes () const
 
subtype_reverse_iterator subtype_rbegin () const
 
subtype_reverse_iterator subtype_rend () const
 
TypegetContainedType (unsigned i) const
 getContainedType - This method is used to implement the type iterator (defined at the end of the file). More...
 
unsigned getNumContainedTypes () const
 getNumContainedTypes - Return the number of types in the derived type. More...
 
unsigned getIntegerBitWidth () const
 
TypegetFunctionParamType (unsigned i) const
 
unsigned getFunctionNumParams () const
 
bool isFunctionVarArg () const
 
StringRef getStructName () const
 
unsigned getStructNumElements () const
 
TypegetStructElementType (unsigned N) const
 
TypegetSequentialElementType () const
 
uint64_t getArrayNumElements () const
 
TypegetArrayElementType () const
 
unsigned getVectorNumElements () const
 
TypegetVectorElementType () const
 
TypegetPointerElementType () const
 
unsigned getPointerAddressSpace () const
 Get the address space of this pointer or pointer vector type. More...
 
PointerTypegetPointerTo (unsigned AddrSpace=0)
 getPointerTo - Return a pointer to the current type. More...
 

Static Public Member Functions

static PointerTypeget (Type *ElementType, unsigned AddressSpace)
 PointerType::get - This constructs a pointer to an object of the specified type in a numbered address space. More...
 
static PointerTypegetUnqual (Type *ElementType)
 PointerType::getUnqual - This constructs a pointer to an object of the specified type in the generic address space (address space zero). More...
 
static bool isValidElementType (Type *ElemTy)
 isValidElementType - Return true if the specified type is valid as a element type. More...
 
static bool isLoadableOrStorableType (Type *ElemTy)
 Return true if we can load or store from a pointer to this type. More...
 
static bool classof (const Type *T)
 Implement support type inquiry through isa, cast, and dyn_cast. More...
 
- Static Public Member Functions inherited from llvm::SequentialType
static bool classof (const Type *T)
 Methods for support type inquiry through isa, cast, and dyn_cast. More...
 
- Static Public Member Functions inherited from llvm::CompositeType
static bool classof (const Type *T)
 Methods for support type inquiry through isa, cast, and dyn_cast. More...
 
- Static Public Member Functions inherited from llvm::Type
static TypegetPrimitiveType (LLVMContext &C, TypeID IDNumber)
 getPrimitiveType - Return a type based on an identifier. More...
 
static TypegetVoidTy (LLVMContext &C)
 
static TypegetLabelTy (LLVMContext &C)
 
static TypegetHalfTy (LLVMContext &C)
 
static TypegetFloatTy (LLVMContext &C)
 
static TypegetDoubleTy (LLVMContext &C)
 
static TypegetMetadataTy (LLVMContext &C)
 
static TypegetX86_FP80Ty (LLVMContext &C)
 
static TypegetFP128Ty (LLVMContext &C)
 
static TypegetPPC_FP128Ty (LLVMContext &C)
 
static TypegetX86_MMXTy (LLVMContext &C)
 
static IntegerTypegetIntNTy (LLVMContext &C, unsigned N)
 
static IntegerTypegetInt1Ty (LLVMContext &C)
 
static IntegerTypegetInt8Ty (LLVMContext &C)
 
static IntegerTypegetInt16Ty (LLVMContext &C)
 
static IntegerTypegetInt32Ty (LLVMContext &C)
 
static IntegerTypegetInt64Ty (LLVMContext &C)
 
static IntegerTypegetInt128Ty (LLVMContext &C)
 
static PointerTypegetHalfPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetFloatPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetDoublePtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetX86_FP80PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetFP128PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetPPC_FP128PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetX86_MMXPtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetIntNPtrTy (LLVMContext &C, unsigned N, unsigned AS=0)
 
static PointerTypegetInt1PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt8PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt16PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt32PtrTy (LLVMContext &C, unsigned AS=0)
 
static PointerTypegetInt64PtrTy (LLVMContext &C, unsigned AS=0)
 

Additional Inherited Members

- Public Types inherited from llvm::Type
enum  TypeID {
  VoidTyID = 0, HalfTyID, FloatTyID, DoubleTyID,
  X86_FP80TyID, FP128TyID, PPC_FP128TyID, LabelTyID,
  MetadataTyID, X86_MMXTyID, IntegerTyID, FunctionTyID,
  StructTyID, ArrayTyID, PointerTyID, VectorTyID
}
 Definitions of all of the base types for the Type system. More...
 
typedef Type *constsubtype_iterator
 
typedef std::reverse_iterator
< subtype_iterator
subtype_reverse_iterator
 
- Protected Member Functions inherited from llvm::SequentialType
 SequentialType (TypeID TID, Type *ElType)
 
- Protected Member Functions inherited from llvm::CompositeType
 CompositeType (LLVMContext &C, TypeID tid)
 
- Protected Member Functions inherited from llvm::Type
 Type (LLVMContext &C, TypeID tid)
 
 ~Type ()=default
 
void setTypeID (TypeID ID)
 
unsigned getSubclassData () const
 
void setSubclassData (unsigned val)
 
- Protected Attributes inherited from llvm::Type
unsigned NumContainedTys
 NumContainedTys - Keeps track of how many Type*'s there are in the ContainedTys list. More...
 
Type *constContainedTys
 ContainedTys - A pointer to the array of Types contained by this Type. More...
 

Detailed Description

PointerType - Class to represent pointers.

Definition at line 449 of file DerivedTypes.h.

Member Function Documentation

static bool llvm::PointerType::classof ( const Type T)
inlinestatic

Implement support type inquiry through isa, cast, and dyn_cast.

Definition at line 475 of file DerivedTypes.h.

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

PointerType * PointerType::get ( Type ElementType,
unsigned  AddressSpace 
)
static
unsigned llvm::PointerType::getAddressSpace ( ) const
inline
static PointerType* llvm::PointerType::getUnqual ( Type ElementType)
inlinestatic
bool PointerType::isLoadableOrStorableType ( Type ElemTy)
static

Return true if we can load or store from a pointer to this type.

Definition at line 773 of file Type.cpp.

References llvm::Type::isFunctionTy(), and isValidElementType().

bool PointerType::isValidElementType ( Type ElemTy)
static

isValidElementType - Return true if the specified type is valid as a element type.

Definition at line 768 of file Type.cpp.

References llvm::Type::isLabelTy(), llvm::Type::isMetadataTy(), and llvm::Type::isVoidTy().

Referenced by get(), and isLoadableOrStorableType().


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