A sum type over pointer-like types. More...

#include "llvm/ADT/PointerSumType.h"

Inheritance diagram for llvm::PointerSumType< TagT, MemberTs >:

Public Member Functions
constexpr	PointerSumType ()=default

template<TagT N>
void	set (typename HelperT::template Lookup< N >::PointerT Pointer)
	A typed setter to a given tagged member of the sum type.

void	clear ()
	Clear the value to null with the min tag type.

TagT	getTag () const

template<TagT N>
bool	is () const

template<TagT N>
HelperT::template Lookup< N >::PointerT	get () const

template<TagT N>
HelperT::template Lookup< N >::PointerT	cast () const

HelperT::template Lookup< HelperT::MinTag >::PointerT const *	getAddrOfZeroTagPointer () const
	If the tag is zero and the pointer's value isn't changed when being stored, get the address of the stored value type-punned to the zero-tag's pointer type.

HelperT::template Lookup< HelperT::MinTag >::PointerT *	getAddrOfZeroTagPointer ()
	If the tag is zero and the pointer's value isn't changed when being stored, get the address of the stored value type-punned to the zero-tag's pointer type.

	operator bool () const

bool	operator== (const PointerSumType &R) const

bool	operator!= (const PointerSumType &R) const

bool	operator< (const PointerSumType &R) const

bool	operator> (const PointerSumType &R) const

bool	operator<= (const PointerSumType &R) const

bool	operator>= (const PointerSumType &R) const

uintptr_t	getOpaqueValue () const

Static Public Member Functions
template<TagT N>
static PointerSumType	create (typename HelperT::template Lookup< N >::PointerT Pointer)
	A typed constructor for a specific tagged member of the sum type.

Protected Member Functions
void *	getVoidPtr () const

Detailed Description

template<typename TagT, typename... MemberTs>
class llvm::PointerSumType< TagT, MemberTs >

A sum type over pointer-like types.

This is a normal tagged union across pointer-like types that uses the low bits of the pointers to store the tag.

Each member of the sum type is specified by passing a PointerSumTypeMember specialization in the variadic member argument list. This allows the user to control the particular tag value associated with a particular type, use the same type for multiple different tags, and customize the pointer-like traits used for a particular member. Note that these must be specializations of PointerSumTypeMember, no other type will suffice, even if it provides a compatible interface.

This type implements all of the comparison operators and even hash table support by comparing the underlying storage of the pointer values. It doesn't support delegating to particular members for comparisons.

It also default constructs to a zero tag with a null pointer, whatever that would be. This means that the zero value for the tag type is significant and may be desirable to set to a state that is particularly desirable to default construct.

Having a supported zero-valued tag also enables getting the address of a pointer stored with that tag provided it is stored in its natural bit representation. This works because in the case of a zero-valued tag, the pointer's value is directly stored into this object and we can expose the address of that internal storage. This is especially useful when building an ArrayRef of a single pointer stored in a sum type.

There is no support for constructing or accessing with a dynamic tag as that would fundamentally violate the type safety provided by the sum type.

Definition at line 70 of file PointerSumType.h.

Constructor & Destructor Documentation

◆ PointerSumType()

template<typename TagT , typename... MemberTs>

constexpr llvm::PointerSumType< TagT, MemberTs >::PointerSumType ( )

constexprdefault

Member Function Documentation

◆ cast()

template<typename TagT , typename... MemberTs>

template<TagT N>

HelperT::template Lookup< N >::PointerT llvm::PointerSumType< TagT, MemberTs >::cast ( ) const

inline

Definition at line 131 of file PointerSumType.h.

References assert(), and llvm::PointerSumType< TagT, MemberTs >::getVoidPtr().

◆ clear()

template<typename TagT , typename... MemberTs>

void llvm::PointerSumType< TagT, MemberTs >::clear ( )

inline

Clear the value to null with the min tag type.

Definition at line 117 of file PointerSumType.h.

◆ create()

template<typename TagT , typename... MemberTs>

template<TagT N>

static PointerSumType llvm::PointerSumType< TagT, MemberTs >::create ( typename HelperT::template Lookup< N >::PointerT Pointer )

inlinestatic

A typed constructor for a specific tagged member of the sum type.

Definition at line 110 of file PointerSumType.h.

References N.

◆ get()

template<typename TagT , typename... MemberTs>

template<TagT N>

HelperT::template Lookup< N >::PointerT llvm::PointerSumType< TagT, MemberTs >::get ( ) const

inline

Definition at line 125 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getVoidPtr(), and P.

◆ getAddrOfZeroTagPointer() [1/2]

template<typename TagT , typename... MemberTs>

HelperT::template Lookup< HelperT::MinTag >::PointerT * llvm::PointerSumType< TagT, MemberTs >::getAddrOfZeroTagPointer ( )

inline

If the tag is zero and the pointer's value isn't changed when being stored, get the address of the stored value type-punned to the zero-tag's pointer type.

Definition at line 149 of file PointerSumType.h.

References assert(), and llvm::detail::PointerSumTypeHelper< TagT, MemberTs >::MinTag.

◆ getAddrOfZeroTagPointer() [2/2]

template<typename TagT , typename... MemberTs>

HelperT::template Lookup< HelperT::MinTag >::PointerT const * llvm::PointerSumType< TagT, MemberTs >::getAddrOfZeroTagPointer ( ) const

inline

If the tag is zero and the pointer's value isn't changed when being stored, get the address of the stored value type-punned to the zero-tag's pointer type.

Definition at line 141 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getAddrOfZeroTagPointer().

Referenced by llvm::PointerSumType< TagT, MemberTs >::getAddrOfZeroTagPointer().

◆ getOpaqueValue()

template<typename TagT , typename... MemberTs>

uintptr_t llvm::PointerSumType< TagT, MemberTs >::getOpaqueValue ( ) const

inline

Definition at line 188 of file PointerSumType.h.

◆ getTag()

template<typename TagT , typename... MemberTs>

TagT llvm::PointerSumType< TagT, MemberTs >::getTag ( ) const

inline

Definition at line 119 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getOpaqueValue(), and llvm::detail::PointerSumTypeHelper< TagT, MemberTs >::TagMask.

Referenced by llvm::PointerSumType< TagT, MemberTs >::is().

◆ getVoidPtr()

template<typename TagT , typename... MemberTs>

void * llvm::PointerSumType< TagT, MemberTs >::getVoidPtr ( ) const

inlineprotected

Definition at line 195 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getOpaqueValue(), and llvm::detail::PointerSumTypeHelper< TagT, MemberTs >::PointerMask.

Referenced by llvm::PointerSumType< TagT, MemberTs >::cast(), and llvm::PointerSumType< TagT, MemberTs >::get().

◆ is()

template<typename TagT , typename... MemberTs>

template<TagT N>

bool llvm::PointerSumType< TagT, MemberTs >::is ( ) const

inline

Definition at line 123 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getTag(), and N.

◆ operator bool()

template<typename TagT , typename... MemberTs>

llvm::PointerSumType< TagT, MemberTs >::operator bool ( ) const

inlineexplicit

Definition at line 166 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getOpaqueValue(), and llvm::detail::PointerSumTypeHelper< TagT, MemberTs >::PointerMask.

◆ operator!=()

template<typename TagT , typename... MemberTs>

bool llvm::PointerSumType< TagT, MemberTs >::operator!= ( const PointerSumType< TagT, MemberTs > & R ) const

inline

Definition at line 172 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getOpaqueValue().

◆ operator<()

template<typename TagT , typename... MemberTs>

bool llvm::PointerSumType< TagT, MemberTs >::operator< ( const PointerSumType< TagT, MemberTs > & R ) const

inline

Definition at line 175 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getOpaqueValue().

◆ operator<=()

template<typename TagT , typename... MemberTs>

bool llvm::PointerSumType< TagT, MemberTs >::operator<= ( const PointerSumType< TagT, MemberTs > & R ) const

inline

Definition at line 181 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getOpaqueValue().

◆ operator==()

template<typename TagT , typename... MemberTs>

bool llvm::PointerSumType< TagT, MemberTs >::operator== ( const PointerSumType< TagT, MemberTs > & R ) const

inline

Definition at line 169 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getOpaqueValue().

◆ operator>()

template<typename TagT , typename... MemberTs>

bool llvm::PointerSumType< TagT, MemberTs >::operator> ( const PointerSumType< TagT, MemberTs > & R ) const

inline

Definition at line 178 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getOpaqueValue().

◆ operator>=()

template<typename TagT , typename... MemberTs>

bool llvm::PointerSumType< TagT, MemberTs >::operator>= ( const PointerSumType< TagT, MemberTs > & R ) const

inline

Definition at line 184 of file PointerSumType.h.

References llvm::PointerSumType< TagT, MemberTs >::getOpaqueValue().

◆ set()

template<typename TagT , typename... MemberTs>

template<TagT N>

void llvm::PointerSumType< TagT, MemberTs >::set ( typename HelperT::template Lookup< N >::PointerT Pointer )

inline

A typed setter to a given tagged member of the sum type.

Definition at line 100 of file PointerSumType.h.

References assert(), N, and llvm::detail::PointerSumTypeHelper< TagT, MemberTs >::TagMask.

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

include/llvm/ADT/PointerSumType.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PointerSumType()

Member Function Documentation

◆ cast()

◆ clear()

◆ create()

◆ get()

◆ getAddrOfZeroTagPointer() [1/2]

◆ getAddrOfZeroTagPointer() [2/2]

◆ getOpaqueValue()

◆ getTag()

◆ getVoidPtr()

◆ is()

◆ operator bool()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ set()