LLVM API Documentation

llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits > Class Template Reference

#include <PointerIntPair.h>

Inheritance diagram for llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >:
[legend]
Collaboration diagram for llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >:
[legend]

List of all members.

Public Member Functions

 PointerIntPair ()
 PointerIntPair (PointerTy Ptr, IntType Int)
PointerTy getPointer () const
IntType getInt () const
void setPointer (PointerTy Ptr)
void setInt (IntType Int)
void * getOpaqueValue () const
void setFromOpaqueValue (void *Val)
bool operator== (const PointerIntPair &RHS) const
bool operator!= (const PointerIntPair &RHS) const
bool operator< (const PointerIntPair &RHS) const
bool operator> (const PointerIntPair &RHS) const
bool operator<= (const PointerIntPair &RHS) const
bool operator>= (const PointerIntPair &RHS) const

Static Public Member Functions

static PointerIntPair getFromOpaqueValue (void *V)


Detailed Description

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
class llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >

PointerIntPair - This class implements a pair of a pointer and small integer. It is designed to represent this in the space required by one pointer by bitmangling the integer into the low part of the pointer. This can only be done for small integers: typically up to 3 bits, but it depends on the number of bits available according to PointerLikeTypeTraits for the type.

Note that PointerIntPair always puts the Int part in the highest bits possible. For example, PointerIntPair<void*, 1, bool> will put the bit for the bool into bit #2, not bit #0, which allows the low two bits to be used for something else. For example, this allows: PointerIntPair<PointerIntPair<void*, 1, bool>, 1, bool> ... and the two bools will land in different bits.

Definition at line 41 of file PointerIntPair.h.


Constructor & Destructor Documentation

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::PointerIntPair (  )  [inline]

Definition at line 59 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::PointerIntPair ( PointerTy  Ptr,
IntType  Int 
) [inline]

Definition at line 60 of file PointerIntPair.h.


Member Function Documentation

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
PointerTy llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::getPointer (  )  const [inline]

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
IntType llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::getInt (  )  const [inline]

Definition at line 71 of file PointerIntPair.h.

Referenced by llvm::Use::getUser().

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
void llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::setPointer ( PointerTy  Ptr  )  [inline]

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
void llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::setInt ( IntType  Int  )  [inline]

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
void* llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::getOpaqueValue (  )  const [inline]

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
void llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::setFromOpaqueValue ( void *  Val  )  [inline]

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
static PointerIntPair llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::getFromOpaqueValue ( void *  V  )  [inline, static]

Definition at line 95 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::operator== ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits > &  RHS  )  const [inline]

Definition at line 99 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::operator!= ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits > &  RHS  )  const [inline]

Definition at line 100 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::operator< ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits > &  RHS  )  const [inline]

Definition at line 101 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::operator> ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits > &  RHS  )  const [inline]

Definition at line 102 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::operator<= ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits > &  RHS  )  const [inline]

Definition at line 103 of file PointerIntPair.h.

template<typename PointerTy, unsigned IntBits, typename IntType = unsigned, typename PtrTraits = PointerLikeTypeTraits<PointerTy>>
bool llvm::PointerIntPair< PointerTy, IntBits, IntType, PtrTraits >::operator>= ( const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits > &  RHS  )  const [inline]

Definition at line 104 of file PointerIntPair.h.


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