magic_enum.hpp File Reference
#include <array>#include <cstddef>#include <cstdint>#include <functional>#include <limits>#include <type_traits>#include <utility>#include <optional>#include <string>#include <string_view>#include <cassert>
Include dependency graph for magic_enum.hpp:Go to the source code of this file.
Classes | |
| class | customize_t |
| struct | enum_range< E > |
| class | case_insensitive< Op > |
| struct | enable_if_enum< bool, R > |
| struct | enable_if_enum< true, R > |
| struct | has_is_flags< T, typename > |
| struct | has_is_flags< T, std::void_t< decltype(customize::enum_range< T >::is_flags)> > |
| struct | is_scoped_enum< T, bool > |
| struct | is_scoped_enum< T, true > |
| struct | is_unscoped_enum< T, bool > |
| struct | is_unscoped_enum< T, true > |
| struct | range_max< T, typename > |
| struct | range_max< T, std::void_t< decltype(customize::enum_range< T >::max)> > |
| struct | range_min< T, typename > |
| struct | range_min< T, std::void_t< decltype(customize::enum_range< T >::min)> > |
| class | static_str< N > |
| class | static_str< 0 > |
| struct | str_view |
| struct | supported< T > |
| struct | underlying_type< T, bool > |
| struct | underlying_type< T, true > |
| struct | valid_count_t< N > |
| struct | is_scoped_enum< T > |
| struct | is_unscoped_enum< T > |
| struct | underlying_type< T > |
Namespaces | |
| magic_enum | |
| magic_enum::bitwise_operators | |
| magic_enum::customize | |
| magic_enum::customize::detail | |
| magic_enum::detail | |
Macros | |
| #define | MAGIC_ENUM_ASSERT(...) assert((__VA_ARGS__)) |
| #define | MAGIC_ENUM_FOR_EACH_256(T) |
| #define | MAGIC_ENUM_RANGE_MAX 127 |
| #define | MAGIC_ENUM_RANGE_MIN -128 |
| #define | MAGIC_ENUM_V(O) |
| #define | MAGIC_ENUM_VERSION_MAJOR 0 |
| #define | MAGIC_ENUM_VERSION_MINOR 9 |
| #define | MAGIC_ENUM_VERSION_PATCH 3 |
Typedefs | |
| using | char_type = string_view::value_type |
| template<typename T , typename R , typename BinaryPredicate = std::equal_to<>, typename D = std::decay_t<T>> | |
| using | enable_if_t = typename enable_if_enum< std::is_enum_v< D > &&std::is_invocable_r_v< bool, BinaryPredicate, char_type, char_type >, R >::type |
| template<typename E , enum_subtype S, typename D = std::decay_t<E>> | |
| using | entries_t = decltype((entries_v< D, S >)) |
| template<typename T > | |
| using | Enum = detail::enum_concept< T > |
| template<typename T , std::enable_if_t< std::is_enum_v< std::decay_t< T >>, int > = 0> | |
| using | enum_concept = T |
| template<auto V, typename E = std::decay_t<decltype(V)>, std::enable_if_t< std::is_enum_v< E >, int > = 0> | |
| using | enum_constant = std::integral_constant< E, V > |
| template<auto V> | |
| using | enum_constant = detail::enum_constant< V > |
| template<typename E , enum_subtype S, typename D = std::decay_t<E>> | |
| using | names_t = decltype((names_v< D, S >)) |
| template<typename T > | |
| using | underlying_type_t = typename underlying_type< T >::type |
| template<typename E , enum_subtype S, typename D = std::decay_t<E>> | |
| using | values_t = decltype((values_v< D, S >)) |
Enumerations | |
| enum | customize_tag { default_tag, invalid_tag, custom_tag } |
| enum | enum_subtype { common, flags } |
Functions | |
| template<typename BinaryPredicate > | |
| constexpr bool | cmp_equal (string_view lhs, string_view rhs, [[maybe_unused]] BinaryPredicate &&p) noexcept(is_nothrow_invocable< BinaryPredicate >()) |
| template<typename L , typename R > | |
| constexpr bool | cmp_less (L lhs, R rhs) noexcept |
| template<typename E , enum_subtype S, std::size_t... I> | |
| constexpr auto | entries (std::index_sequence< I... >) noexcept |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>, typename BinaryPredicate = std::equal_to<>> | |
| constexpr auto | enum_cast (string_view value, [[maybe_unused]] BinaryPredicate p={}) noexcept(detail::is_nothrow_invocable< BinaryPredicate >()) -> detail::enable_if_t< E, optional< std::decay_t< E >>, BinaryPredicate > |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>> | |
| constexpr auto | enum_cast (underlying_type_t< E > value) noexcept -> detail::enable_if_t< E, optional< std::decay_t< E >>> |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>> | |
| constexpr auto | enum_contains (E value) noexcept -> detail::enable_if_t< E, bool > |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>, typename BinaryPredicate = std::equal_to<>> | |
| constexpr auto | enum_contains (string_view value, BinaryPredicate p={}) noexcept(detail::is_nothrow_invocable< BinaryPredicate >()) -> detail::enable_if_t< E, bool, BinaryPredicate > |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>> | |
| constexpr auto | enum_contains (underlying_type_t< E > value) noexcept -> detail::enable_if_t< E, bool > |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>> | |
| constexpr auto | enum_count () noexcept -> detail::enable_if_t< E, std::size_t > |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>> | |
| constexpr auto | enum_entries () noexcept -> detail::enable_if_t< E, detail::entries_t< E, S >> |
| template<auto V, detail::enum_subtype S = detail::subtype_v<std::decay_t<decltype(V)>>> | |
| constexpr auto | enum_index () noexcept -> detail::enable_if_t< decltype(V), std::size_t > |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>> | |
| constexpr auto | enum_index (E value) noexcept -> detail::enable_if_t< E, optional< std::size_t >> |
| template<typename E > | |
| constexpr auto | enum_integer (E value) noexcept -> detail::enable_if_t< E, underlying_type_t< E >> |
| template<typename E , E V> | |
| constexpr auto | enum_name () noexcept |
| template<auto V> | |
| constexpr auto | enum_name () noexcept -> detail::enable_if_t< decltype(V), string_view > |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>> | |
| constexpr auto | enum_name (E value) noexcept -> detail::enable_if_t< E, string_view > |
| template<typename E > | |
| constexpr customize_t | enum_name (E) noexcept |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>> | |
| constexpr auto | enum_names () noexcept -> detail::enable_if_t< E, detail::names_t< E, S >> |
| template<typename E > | |
| constexpr customize_t | enum_type_name () noexcept |
| template<typename E > | |
| constexpr auto | enum_type_name () noexcept -> detail::enable_if_t< E, string_view > |
| template<typename E > | |
| constexpr auto | enum_underlying (E value) noexcept -> detail::enable_if_t< E, underlying_type_t< E >> |
| template<typename E , std::size_t I, detail::enum_subtype S = detail::subtype_v<E>> | |
| constexpr auto | enum_value () noexcept -> detail::enable_if_t< E, std::decay_t< E >> |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>> | |
| constexpr auto | enum_value (std::size_t index) noexcept -> detail::enable_if_t< E, std::decay_t< E >> |
| template<typename E , detail::enum_subtype S = detail::subtype_v<E>> | |
| constexpr auto | enum_values () noexcept -> detail::enable_if_t< E, detail::values_t< E, S >> |
| constexpr std::size_t | find (string_view str, char_type c) noexcept |
| template<typename BinaryPredicate > | |
| constexpr bool | is_default_predicate () noexcept |
| template<typename BinaryPredicate > | |
| constexpr bool | is_nothrow_invocable () |
| template<typename E , enum_subtype S, typename U = std::underlying_type_t<E>> | |
| constexpr bool | is_sparse () noexcept |
| template<typename E , auto V> | |
| constexpr bool | is_valid () noexcept |
| template<typename I > | |
| constexpr I | log2 (I value) noexcept |
| template<typename E > | |
| constexpr auto | n () noexcept |
| template<typename E , enum_subtype S, std::size_t... I> | |
| constexpr auto | names (std::index_sequence< I... >) noexcept |
| template<typename E , detail::enable_if_t< E, int > = 0> | |
| constexpr E | operator& (E lhs, E rhs) noexcept |
| template<typename E , detail::enable_if_t< E, int > = 0> | |
| constexpr E & | operator&= (E &lhs, E rhs) noexcept |
| template<typename E , detail::enable_if_t< E, int > = 0> | |
| constexpr E | operator^ (E lhs, E rhs) noexcept |
| template<typename E , detail::enable_if_t< E, int > = 0> | |
| constexpr E & | operator^= (E &lhs, E rhs) noexcept |
| template<typename E , detail::enable_if_t< E, int > = 0> | |
| constexpr E | operator| (E lhs, E rhs) noexcept |
| template<typename E , detail::enable_if_t< E, int > = 0> | |
| constexpr E & | operator|= (E &lhs, E rhs) noexcept |
| template<typename E , detail::enable_if_t< E, int > = 0> | |
| constexpr E | operator~ (E rhs) noexcept |
| template<typename E , enum_subtype S, typename U = std::underlying_type_t<E>> | |
| constexpr int | reflected_max () noexcept |
| template<typename E , enum_subtype S, typename U = std::underlying_type_t<E>> | |
| constexpr int | reflected_min () noexcept |
| template<typename T > | |
| constexpr enum_subtype | subtype (std::false_type) noexcept |
| template<typename E , typename U = std::underlying_type_t<E>> | |
| constexpr enum_subtype | subtype (std::true_type) noexcept |
| template<typename T , std::size_t N, std::size_t... I> | |
| constexpr std::array< std::remove_cv_t< T >, N > | to_array (T(&a)[N], std::index_sequence< I... >) noexcept |
| template<typename E > | |
| constexpr auto | type_name () noexcept |
| template<typename E , int O, enum_subtype S, typename U = std::underlying_type_t<E>> | |
| constexpr U | ualue (std::size_t i) noexcept |
| template<typename E , enum_subtype S, std::size_t Size, int Min> | |
| constexpr auto | valid_count () noexcept |
| template<typename E , enum_subtype S, std::size_t Size, int Min, std::size_t I> | |
| constexpr void | valid_count (bool *valid, std::size_t &count) noexcept |
| template<typename E , int O, enum_subtype S, typename U = std::underlying_type_t<E>> | |
| constexpr E | value (std::size_t i) noexcept |
| template<typename E , enum_subtype S, std::size_t Size, int Min> | |
| constexpr auto | values () noexcept |
| template<typename E , enum_subtype S, typename U = std::underlying_type_t<E>> | |
| constexpr auto | values () noexcept |
| template<typename E , enum_subtype S, typename U = std::underlying_type_t<E>> | |
| constexpr U | values_ors () noexcept |
Variables | |
| template<typename... T> | |
| constexpr bool | always_false_v = false |
| template<bool AsFlags = true> | |
| constexpr auto | as_common = AsFlags ? detail::enum_subtype::common : detail::enum_subtype::flags |
| template<bool AsFlags = true> | |
| constexpr auto | as_flags = AsFlags ? detail::enum_subtype::flags : detail::enum_subtype::common |
| constexpr auto | case_insensitive = detail::case_insensitive<>{} |
| template<typename E , enum_subtype S> | |
| constexpr auto | count_v = values_v<E, S>.size() |
| constexpr auto | default_tag = customize_t{detail::customize_tag::default_tag} |
| template<typename E , enum_subtype S> | |
| constexpr auto | entries_v = entries<E, S>(std::make_index_sequence<count_v<E, S>>{}) |
| template<typename E , E V> | |
| constexpr auto | enum_name_v = enum_name<E, V>() |
| constexpr auto | invalid_tag = customize_t{detail::customize_tag::invalid_tag} |
| template<typename T > | |
| constexpr bool | is_enum_v = std::is_enum_v<T> && std::is_same_v<T, std::decay_t<T>> |
| constexpr bool | is_magic_enum_supported = detail::supported<void>::value |
| template<typename T > | |
| constexpr bool | is_scoped_enum_v = is_scoped_enum<T>::value |
| template<typename E , enum_subtype S = subtype_v<E>> | |
| constexpr bool | is_sparse_v = is_sparse<E, S>() |
| template<typename T > | |
| constexpr bool | is_unscoped_enum_v = is_unscoped_enum<T>::value |
| template<typename E , enum_subtype S, typename U = std::underlying_type_t<E>> | |
| constexpr auto | max_v = (count_v<E, S> > 0) ? static_cast<U>(values_v<E, S>.back()) : U{0} |
| template<typename E , enum_subtype S, typename U = std::underlying_type_t<E>> | |
| constexpr auto | min_v = (count_v<E, S> > 0) ? static_cast<U>(values_v<E, S>.front()) : U{0} |
| template<typename E , enum_subtype S> | |
| constexpr auto | names_v = names<E, S>(std::make_index_sequence<count_v<E, S>>{}) |
| template<typename E , typename D = std::decay_t<E>> | |
| constexpr auto | subtype_v = subtype<D>(std::is_enum<D>{}) |
| template<typename E > | |
| constexpr auto | type_name_v = type_name<E>() |
| template<typename E , enum_subtype S> | |
| constexpr auto | values_v = values<E, S>() |
Macro Definition Documentation
◆ MAGIC_ENUM_ASSERT
| #define MAGIC_ENUM_ASSERT | ( | ... | ) | assert((__VA_ARGS__)) |
Definition at line 65 of file magic_enum.hpp.
◆ MAGIC_ENUM_FOR_EACH_256
| #define MAGIC_ENUM_FOR_EACH_256 | ( | T | ) |
Value:
T( 0)T( 1)T( 2)T( 3)T( 4)T( 5)T( 6)T( 7)T( 8)T( 9)T( 10)T( 11)T( 12)T( 13)T( 14)T( 15)T( 16)T( 17)T( 18)T( 19)T( 20)T( 21)T( 22)T( 23)T( 24)T( 25)T( 26)T( 27)T( 28)T( 29)T( 30)T( 31) \
T( 32)T( 33)T( 34)T( 35)T( 36)T( 37)T( 38)T( 39)T( 40)T( 41)T( 42)T( 43)T( 44)T( 45)T( 46)T( 47)T( 48)T( 49)T( 50)T( 51)T( 52)T( 53)T( 54)T( 55)T( 56)T( 57)T( 58)T( 59)T( 60)T( 61)T( 62)T( 63) \
T( 64)T( 65)T( 66)T( 67)T( 68)T( 69)T( 70)T( 71)T( 72)T( 73)T( 74)T( 75)T( 76)T( 77)T( 78)T( 79)T( 80)T( 81)T( 82)T( 83)T( 84)T( 85)T( 86)T( 87)T( 88)T( 89)T( 90)T( 91)T( 92)T( 93)T( 94)T( 95) \
T( 96)T( 97)T( 98)T( 99)T(100)T(101)T(102)T(103)T(104)T(105)T(106)T(107)T(108)T(109)T(110)T(111)T(112)T(113)T(114)T(115)T(116)T(117)T(118)T(119)T(120)T(121)T(122)T(123)T(124)T(125)T(126)T(127) \
T(128)T(129)T(130)T(131)T(132)T(133)T(134)T(135)T(136)T(137)T(138)T(139)T(140)T(141)T(142)T(143)T(144)T(145)T(146)T(147)T(148)T(149)T(150)T(151)T(152)T(153)T(154)T(155)T(156)T(157)T(158)T(159) \
T(160)T(161)T(162)T(163)T(164)T(165)T(166)T(167)T(168)T(169)T(170)T(171)T(172)T(173)T(174)T(175)T(176)T(177)T(178)T(179)T(180)T(181)T(182)T(183)T(184)T(185)T(186)T(187)T(188)T(189)T(190)T(191) \
Definition at line 671 of file magic_enum.hpp.
◆ MAGIC_ENUM_RANGE_MAX
| #define MAGIC_ENUM_RANGE_MAX 127 |
Definition at line 104 of file magic_enum.hpp.
◆ MAGIC_ENUM_RANGE_MIN
| #define MAGIC_ENUM_RANGE_MIN -128 |
Definition at line 98 of file magic_enum.hpp.
◆ MAGIC_ENUM_V
| #define MAGIC_ENUM_V | ( | O | ) |
Value:
if constexpr ((I + O) < Size) { \
if constexpr (is_valid<E, ualue<E, Min, S>(I + O)>()) { \
valid[I + O] = true; \
++count; \
} \
}
◆ MAGIC_ENUM_VERSION_MAJOR
| #define MAGIC_ENUM_VERSION_MAJOR 0 |
Definition at line 35 of file magic_enum.hpp.
◆ MAGIC_ENUM_VERSION_MINOR
| #define MAGIC_ENUM_VERSION_MINOR 9 |
Definition at line 36 of file magic_enum.hpp.
◆ MAGIC_ENUM_VERSION_PATCH
| #define MAGIC_ENUM_VERSION_PATCH 3 |
Definition at line 37 of file magic_enum.hpp.
