LLVM  6.0.0svn
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::PointerSumType< TagT, MemberTs > Class Template Reference

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

#include "llvm/ADT/PointerSumType.h"

Public Member Functions

constexpr PointerSumType ()=default
 
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
 
 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. More...
 

Protected Member Functions

void * getImpl () 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.

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 63 of file PointerSumType.h.

Constructor & Destructor Documentation

◆ PointerSumType()

template<typename TagT , typename... MemberTs>
constexpr llvm::PointerSumType< TagT, MemberTs >::PointerSumType ( )
default

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 93 of file PointerSumType.h.

References assert(), and getImpl().

◆ 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 74 of file PointerSumType.h.

References assert().

◆ get()

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

Definition at line 87 of file PointerSumType.h.

References getImpl(), and P.

◆ getImpl()

template<typename TagT , typename... MemberTs>
void* llvm::PointerSumType< TagT, MemberTs >::getImpl ( ) const
inlineprotected

Definition at line 109 of file PointerSumType.h.

◆ getOpaqueValue()

template<typename TagT , typename... MemberTs>
uintptr_t llvm::PointerSumType< TagT, MemberTs >::getOpaqueValue ( ) const
inline

Definition at line 106 of file PointerSumType.h.

◆ getTag()

template<typename TagT , typename... MemberTs>
TagT llvm::PointerSumType< TagT, MemberTs >::getTag ( ) const
inline

Definition at line 83 of file PointerSumType.h.

◆ is()

template<typename TagT , typename... MemberTs>
template<TagT N>
bool llvm::PointerSumType< TagT, MemberTs >::is ( ) const
inline

Definition at line 85 of file PointerSumType.h.

References getTag().

◆ operator bool()

template<typename TagT , typename... MemberTs>
llvm::PointerSumType< TagT, MemberTs >::operator bool ( ) const
inlineexplicit

Definition at line 98 of file PointerSumType.h.

◆ operator!=()

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

Definition at line 100 of file PointerSumType.h.

◆ operator<()

template<typename TagT , typename... MemberTs>
bool llvm::PointerSumType< TagT, MemberTs >::operator< ( const PointerSumType< TagT, MemberTs > &  R) const
inline

Definition at line 101 of file PointerSumType.h.

◆ operator<=()

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

Definition at line 103 of file PointerSumType.h.

◆ operator==()

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

Definition at line 99 of file PointerSumType.h.

◆ operator>()

template<typename TagT , typename... MemberTs>
bool llvm::PointerSumType< TagT, MemberTs >::operator> ( const PointerSumType< TagT, MemberTs > &  R) const
inline

Definition at line 102 of file PointerSumType.h.

◆ operator>=()

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

Definition at line 104 of file PointerSumType.h.


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