24 #ifndef PXR_BASE_TF_ENUM_H
25 #define PXR_BASE_TF_ENUM_H
31 #include "pxr/base/arch/defines.h"
35 #include "pxr/base/tf/preprocessorUtilsLite.h"
37 #include "pxr/base/tf/api.h"
39 #include <boost/operators.hpp>
40 #include <boost/preprocessor/punctuation/comma_if.hpp>
45 #include <type_traits>
48 PXR_NAMESPACE_OPEN_SCOPE
139 class TfEnum : boost::totally_ordered<TfEnum>
144 : _typeInfo(&typeid(int)), _value(0)
151 std::enable_if_t<std::is_enum<T>::value> * = 0)
152 : _typeInfo(&typeid(T)), _value(int(value))
161 TfEnum(
const std::type_info& ti,
int value)
162 : _typeInfo(&ti), _value(value)
168 return t._value == _value &&
177 return _typeInfo->before(*t._typeInfo) ||
178 (!t._typeInfo->before(*_typeInfo) && _value < t._value);
183 std::enable_if_t<std::is_enum<T>::value,
bool>
185 return int(value) == _value && IsA<T>();
190 std::enable_if_t<std::is_enum<T>::value,
bool>
192 return int(value) != _value || !IsA<T>();
197 friend std::enable_if_t<std::is_enum<T>::value,
bool>
204 friend std::enable_if_t<std::is_enum<T>::value,
bool>
217 bool IsA(
const std::type_info& t)
const {
242 template <
typename T>
245 _FatalGetValueError(
typeid(T));
251 template <
typename T,
252 typename =
typename std::enable_if<
253 std::is_integral<T>::value ||
254 std::is_enum<T>::value>::type
300 TF_API
static std::vector<std::string>
GetAllNames(
const std::type_info &ti);
321 static const std::type_info *
GetTypeFromName(
const std::string& typeName);
339 const std::string &name,
340 bool *foundIt = NULL);
353 bool *foundIt = NULL);
371 const std::string &displayName=
"");
376 const std::string &displayName=
"")
378 _AddName(val, valName, displayName);
381 template <
typename T>
382 static TfEnum IntegralEnum(T value) {
384 e._typeInfo = &
typeid(T);
385 e._value = int(value);
391 explicit TfEnum(
int value)
392 : _typeInfo(&typeid(int)), _value(value)
397 explicit TfEnum(
size_t value)
398 : _typeInfo(&typeid(size_t)), _value(static_cast<int>(value))
403 void _FatalGetValueError(std::type_info
const& typeInfo)
const;
405 const std::type_info* _typeInfo;
412 template <
class HashState,
class Enum>
413 std::enable_if_t<std::is_same<Enum, TfEnum>::value>
414 TfHashAppend(HashState &h, Enum
const &e)
417 h.Append(e.GetValueAsInt());
449 #define TF_ADD_ENUM_NAME(VAL, ...) \
450 TfEnum::_AddName(VAL, \
451 TF_PP_STRINGIZE(VAL) \
452 BOOST_PP_COMMA_IF(TF_NUM_ARGS(__VA_ARGS__)) \
455 PXR_NAMESPACE_CLOSE_SCOPE
457 #endif // PXR_BASE_TF_ENUM_H
static std::vector< std::string > GetAllNames(TfEnum val)
Returns a vector of all the names associated with an enum type.
T GetValue() const
Returns the enum value for the enum type T.
Safely compare C++ RTTI type structures.
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.
const std::type_info & GetType() const
Returns the type of the enum value, as an std::type_info.
static TF_API bool IsKnownEnumType(const std::string &typeName)
Returns true if typeName is a known enum type.
bool IsA(const std::type_info &t) const
True if *this has been assigned any enumerated value of type T with typeid(T)==t. ...
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.
An enum class that records both enum type and enum value.
bool operator<(const TfEnum &t) const
Less than comparison.
static void AddName(TfEnum val, const std::string &valName, const std::string &displayName="")
Associates a name with an enumerated value.
Demangle C++ typenames generated by the typeid() facility.
static TF_API std::string GetDisplayName(TfEnum val)
Returns the display name for an enumerated value.
TfEnum(const std::type_info &ti, int value)
Initializes value to integral value value with enum type ti.
static TF_API std::string GetName(TfEnum val)
Returns the name associated with an enumerated value.
static TF_API TfEnum GetValueFromFullName(const std::string &fullname, bool *foundIt=NULL)
Returns the enumerated value for a fully-qualified name.
std::enable_if_t< std::is_enum< T >::value, bool > operator==(T value) const
True 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.
static TF_API std::string GetFullName(TfEnum val)
Returns the fully-qualified name for an enumerated value.
GF_API std::ostream & operator<<(std::ostream &, const GfBBox3d &)
Output a GfBBox3d using the format [(range) matrix zeroArea].
std::enable_if_t< std::is_enum< T >::value, bool > operator!=(T value) const
False if *this has been assigned with value.
static T GetValueFromName(const std::string &name, bool *foundIt=NULL)
Returns the enumerated value for a name.
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.
TfEnum()
Default constructor assigns integer value zero.
static TF_API void _AddName(TfEnum val, const std::string &valName, const std::string &displayName="")
Associates a name with an enumerated value.
bool IsA() const
True if *this has been assigned any enumerated value of type T.
bool operator==(const TfEnum &t) const
True if *this and t have both the same type and value.
const int & GetValueAsInt() const
Returns the integral value of the enum value.
TfCStrHashWrapper TfHashAsCStr(char const *cstr)
Indicate that a char pointer is intended to be hashed as a C-style null terminated string...
bool TfSafeTypeCompare(const std::type_info &t1, const std::type_info &t2)
Safely compare std::type_info structures.