7#ifndef PXR_BASE_TF_ENUM_H
8#define PXR_BASE_TF_ENUM_H
14#include "pxr/base/arch/defines.h"
17#include "pxr/base/tf/preprocessorUtilsLite.h"
19#include "pxr/base/tf/api.h"
28PXR_NAMESPACE_OPEN_SCOPE
124 : _typeInfo(&typeid(int)), _value(0)
131 std::enable_if_t<std::is_enum<T>::value> * = 0)
132 : _typeInfo(&typeid(T)), _value(int(value))
141 TfEnum(
const std::type_info& ti,
int value)
142 : _typeInfo(&ti), _value(value)
148 return t._value == _value &&
155 return !(*
this == t);
163 return _typeInfo->before(*t._typeInfo) ||
164 (!t._typeInfo->before(*_typeInfo) && _value < t._value);
187 std::enable_if_t<std::is_enum<T>::value,
bool>
189 return int(value) == _value && IsA<T>();
194 std::enable_if_t<std::is_enum<T>::value,
bool>
196 return int(value) != _value || !IsA<T>();
201 friend std::enable_if_t<std::is_enum<T>::value,
bool>
208 friend std::enable_if_t<std::is_enum<T>::value,
bool>
221 bool IsA(
const std::type_info& t)
const {
246 template <
typename T>
249 _FatalGetValueError(
typeid(T));
255 template <
typename T,
256 typename =
typename std::enable_if<
257 std::is_integral<T>::value ||
258 std::is_enum<T>::value>::type
304 TF_API
static std::vector<std::string>
GetAllNames(
const std::type_info &ti);
343 const std::string &name,
344 bool *foundIt = NULL);
357 bool *foundIt = NULL);
375 char const *displayName);
379 _NameIdent(
char const *str =
nullptr) {
return str; }
384 const std::string &displayName=
"")
386 _AddName(val, valName.c_str(), displayName.c_str());
389 template <
typename T>
390 static TfEnum IntegralEnum(T value) {
392 e._typeInfo = &
typeid(T);
393 e._value = int(value);
399 explicit TfEnum(
int value)
400 : _typeInfo(&typeid(int)), _value(value)
405 explicit TfEnum(
size_t value)
406 : _typeInfo(&typeid(size_t)), _value(static_cast<int>(value))
411 void _FatalGetValueError(std::type_info
const& typeInfo)
const;
413 const std::type_info* _typeInfo;
420template <
class HashState,
class Enum>
421std::enable_if_t<std::is_same<Enum, TfEnum>::value>
422TfHashAppend(HashState &h, Enum
const &e)
425 h.Append(e.GetValueAsInt());
457#define TF_ADD_ENUM_NAME(VAL, ...) \
458 TfEnum::_AddName(VAL, TF_PP_STRINGIZE(VAL), \
459 TfEnum::_NameIdent(__VA_ARGS__));
461PXR_NAMESPACE_CLOSE_SCOPE
An enum class that records both enum type and enum value.
static TF_API TfEnum GetValueFromName(const std::type_info &ti, const std::string &name, bool *foundIt=NULL)
Returns the enumerated value for a name.
TfEnum()
Default constructor assigns integer value zero.
bool operator>(const TfEnum &t) const
Greater than operator.
bool operator==(const TfEnum &t) const
True if *this and t have both the same type and value.
static TF_API std::string GetName(TfEnum val)
Returns the name associated with an enumerated value.
TfEnum(const std::type_info &ti, int value)
Initializes value to integral value value with enum type ti.
static void AddName(TfEnum val, const std::string &valName, const std::string &displayName="")
Associates a name with an enumerated value.
const std::type_info & GetType() const
Returns the type of the enum value, as an std::type_info.
static TF_API TfEnum GetValueFromFullName(const std::string &fullname, bool *foundIt=NULL)
Returns the enumerated value for a fully-qualified name.
static TF_API std::vector< std::string > GetAllNames(const std::type_info &ti)
This is an overloaded member function, provided for convenience. It differs from the above function o...
bool operator<(const TfEnum &t) const
Less than comparison.
static T GetValueFromName(const std::string &name, bool *foundIt=NULL)
Returns the enumerated value for a name.
static std::vector< std::string > GetAllNames(TfEnum val)
Returns a vector of all the names associated with an enum type.
static TF_API std::string GetFullName(TfEnum val)
Returns the fully-qualified name for an enumerated value.
bool IsA() const
True if *this has been assigned any enumerated value of type T.
static TF_API void _AddName(TfEnum val, char const *valName, char const *displayName)
Associates a name with an enumerated value.
friend std::enable_if_t< std::is_enum< T >::value, bool > operator!=(T val, TfEnum const &e)
Compare a literal enum value val of enum type T with TfEnum e.
bool operator<=(const TfEnum &t) const
Less than or equal operator.
bool IsA(const std::type_info &t) const
True if *this has been assigned any enumerated value of type T with typeid(T)==t.
friend std::enable_if_t< std::is_enum< T >::value, bool > operator==(T val, TfEnum const &e)
Compare a literal enum value val of enum type T with TfEnum e.
static TF_API bool IsKnownEnumType(const std::string &typeName)
Returns true if typeName is a known enum type.
std::enable_if_t< std::is_enum< T >::value, bool > operator!=(T value) const
False if *this has been assigned with value.
TfEnum(T value, std::enable_if_t< std::is_enum< T >::value > *=0)
Initializes value to enum variable value of enum type T.
bool operator>=(const TfEnum &t) const
Greater than or equal operator.
std::enable_if_t< std::is_enum< T >::value, bool > operator==(T value) const
True if *this has been assigned with value.
bool operator!=(const TfEnum &t) const
Inequality operator.
static TF_API std::string GetDisplayName(TfEnum val)
Returns the display name for an enumerated value.
static std::vector< std::string > GetAllNames()
Returns a vector of all the names associated with an enum type.
static TF_API const std::type_info * GetTypeFromName(const std::string &typeName)
Returns the typeid for a given enum type name.
T GetValue() const
Returns the enum value for the enum type T.
const int & GetValueAsInt() const
Returns the integral value of the enum value.
Demangle C++ typenames generated by the typeid() facility.
GF_API std::ostream & operator<<(std::ostream &, const GfBBox3d &)
Output a GfBBox3d using the format [(range) matrix zeroArea].
Safely compare C++ RTTI type structures.
bool TfSafeTypeCompare(const std::type_info &t1, const std::type_info &t2)
Safely compare std::type_info structures.
TfCStrHashWrapper TfHashAsCStr(char const *cstr)
Indicate that a char pointer is intended to be hashed as a C-style null terminated string.