magic_enum
v0.9.7
Библиотека C++17 только для заголовков обеспечивает статическое отражение для перечислений, работает с любым типом перечисления без какого-либо макроса или шаблонного кода.
Если вам понравился этот проект, рассмотрите возможность сделать пожертвование в один из фондов помощи жертвам войны в Украине: https://u24.gov.ua.
Базовый
# include < magic_enum/magic_enum.hpp >
# include < iostream >
enum class Color : { RED = - 10 , BLUE = 0 , GREEN = 10 };
int main () {
Color c1 = Color::RED;
std::cout << magic_enum::enum_name (c1) << std::endl; // RED
return 0 ;
}Значение перечисления в строку
Color color = Color::RED;
auto color_name = magic_enum::enum_name(color);
// color_name -> "RED"Строка для перечисления значения
std::string color_name{ " GREEN " };
auto color = magic_enum::enum_cast<Color>(color_name);
if (color.has_value()) {
// color.value() -> Color::GREEN
}
// case insensitive enum_cast
auto color = magic_enum::enum_cast<Color>(value, magic_enum::case_insensitive);
// enum_cast with BinaryPredicate
auto color = magic_enum::enum_cast<Color>(value, []( char lhs, char rhs) { return std::tolower (lhs) == std::tolower (rhs); }
// enum_cast with default
auto color_or_default = magic_enum::enum_cast<Color>(value).value_or(Color::NONE);Целое число для перечисления
int color_integer = 2 ;
auto color = magic_enum::enum_cast<Color>(color_integer);
if (color.has_value()) {
// color.value() -> Color::BLUE
}
auto color_or_default = magic_enum::enum_cast<Color>(value).value_or(Color::NONE);Индексированный доступ к значению перечисления
std:: size_t i = 0 ;
Color color = magic_enum::enum_value<Color>(i);
// color -> Color::REDПоследовательность значений перечисления
constexpr auto colors = magic_enum::enum_values<Color>();
// colors -> {Color::RED, Color::BLUE, Color::GREEN}
// colors[0] -> Color::REDКоличество элементов перечисления
constexpr std:: size_t color_count = magic_enum::enum_count<Color>();
// color_count -> 3Значение перечисления в целое число
Color color = Color::RED;
auto color_integer = magic_enum::enum_integer(color); // or magic_enum::enum_underlying(color);
// color_integer -> 1Последовательность имен перечислений
constexpr auto color_names = magic_enum::enum_names<Color>();
// color_names -> {"RED", "BLUE", "GREEN"}
// color_names[0] -> "RED"Последовательность записей перечисления
constexpr auto color_entries = magic_enum::enum_entries<Color>();
// color_entries -> {{Color::RED, "RED"}, {Color::BLUE, "BLUE"}, {Color::GREEN, "GREEN"}}
// color_entries[0].first -> Color::RED
// color_entries[0].second -> "RED"Объединение перечислений для многоуровневых операторов switch/case
switch (magic_enum::enum_fuse(color, direction).value()) {
case magic_enum::enum_fuse (Color::RED, Directions::Up). value (): // ...
case magic_enum::enum_fuse (Color::BLUE, Directions::Down). value (): // ...
// ...
}Значение времени выполнения переключателя перечисления как константа constexpr
Color color = Color::RED;
magic_enum::enum_switch ([] ( auto val) {
constexpr Color c_color = val;
// ...
}, color);Перечисление для каждого перечисления как константа constexpr
magic_enum::enum_for_each<Color>([] ( auto val) {
constexpr Color c_color = val;
// ...
});Проверьте, содержит ли перечисление
magic_enum::enum_contains (Color::GREEN); // -> true
magic_enum::enum_contains<Color>( 2 ); // -> true
magic_enum::enum_contains<Color>( 123 ); // -> false
magic_enum::enum_contains<Color>( " GREEN " ); // -> true
magic_enum::enum_contains<Color>( " fda " ); // -> falseИндекс перечисления в последовательности
constexpr auto color_index = magic_enum::enum_index(Color::BLUE);
// color_index.value() -> 1
// color_index.has_value() -> trueФункции для флагов
enum Directions : std:: uint64_t {
Left = 1 ,
Down = 2 ,
Up = 4 ,
Right = 8 ,
};
template <>
struct magic_enum ::customize::enum_range<Directions> {
static constexpr bool is_flags = true ;
};
magic_enum::enum_flags_name (Directions::Up | Directions::Right); // -> "Directions::Up|Directions::Right"
magic_enum::enum_flags_contains (Directions::Up | Directions::Right); // -> true
magic_enum::enum_flags_cast ( 3 ); // -> "Directions::Left|Directions::Down"Имя типа перечисления
Color color = Color::RED;
auto type_name = magic_enum::enum_type_name<decltype(color)>();
// type_name -> "Color"Оператор IOstream для перечисления
using magic_enum::iostream_operators:: operator <<; // out-of-the-box ostream operators for enums.
Color color = Color::BLUE;
std::cout << color << std::endl; // "BLUE" using magic_enum::iostream_operators:: operator >>; // out-of-the-box istream operators for enums.
Color color;
std::cin >> color;Побитовый оператор для перечисления
enum class Flags { A = 1 << 0 , B = 1 << 1 , C = 1 << 2 , D = 1 << 3 };
using namespace magic_enum ::bitwise_operators ; // out-of-the-box bitwise operators for enums.
// Support operators: ~, |, &, ^, |=, &=, ^=.
Flags flags = Flags::A | Flags::B & ~Flags::C;Проверяет, является ли тип перечислением без области действия.
enum color { red, green, blue };
enum class direction { left, right };
magic_enum::is_unscoped_enum<color>::value -> true
magic_enum::is_unscoped_enum<direction>::value -> false
magic_enum::is_unscoped_enum< int >::value -> false
// Helper variable template.
magic_enum::is_unscoped_enum_v<color> -> trueПроверяет, является ли тип перечислением с областью действия.
enum color { red, green, blue };
enum class direction { left, right };
magic_enum::is_scoped_enum<color>::value -> false
magic_enum::is_scoped_enum<direction>::value -> true
magic_enum::is_scoped_enum< int >::value -> false
// Helper variable template.
magic_enum::is_scoped_enum_v<direction> -> trueСтатическая переменная перечисления для хранения в строке. Эта версия намного сокращает время компиляции и не ограничена ограничением enum_range.
constexpr Color color = Color::BLUE;
constexpr auto color_name = magic_enum::enum_name<color>();
// color_name -> "BLUE" containers::array для перечислений.
magic_enum::containers::array<Color, RGB> color_rgb_array {};
color_rgb_array[Color::RED] = { 255 , 0 , 0 };
color_rgb_array[Color::GREEN] = { 0 , 255 , 0 };
color_rgb_array[Color::BLUE] = { 0 , 0 , 255 };
magic_enum::containers::get<Color::BLUE>(color_rgb_array) // -> RGB{0, 0, 255} containers::bitset контейнер битсета для перечислений.
constexpr magic_enum::containers::bitset<Color> color_bitset_red_green {Color::RED|Color::GREEN};
bool all = color_bitset_red_green.all();
// all -> false
// Color::BLUE is missing
bool test = color_bitset_red_green.test(Color::RED);
// test -> true containers::set устанавливает контейнер для перечислений.
auto color_set = magic_enum::containers::set<Color>();
bool empty = color_set.empty();
// empty -> true
color_set.insert(Color::GREEN);
color_set.insert(Color::BLUE);
color_set.insert(Color::RED);
std:: size_t size = color_set.size();
// size -> 3Улучшен базовый_тип без UB, «дружественный к SFINAE».
magic_enum::underlying_type<color>::type -> int
// Helper types.
magic_enum:: underlying_type_t <Direction> -> int magic_enum не претендует на роль панацеи для отражения перечислений, он изначально был разработан для небольших перечислений.
Перед использованием ознакомьтесь с ограничениями функционала.
Вам следует добавить необходимый файл Magic_enum.hpp и, при необходимости, другие заголовки из каталога включения или архива выпуска. Альтернативно вы можете собрать библиотеку с помощью CMake.
Если вы используете vcpkg в своем проекте для внешних зависимостей, вы можете использовать пакет Magic-enum.
Если вы используете Conan для управления своими зависимостями, просто добавьте magic_enum/xyz к требованиям вашего Conan, где xyz — это версия выпуска, которую вы хотите использовать.
Если вы используете Build2 для создания зависимостей и управления ими, добавьте depends: magic_enum ^xyz в файл манифеста, где xyz — это версия выпуска, которую вы хотите использовать. Затем вы можете импортировать цель, используя magic_enum%lib{magic_enum} .
Альтернативно вы можете использовать что-то вроде CPM, основанное на модуле Fetch_Content CMake.
CPMAddPackage(
NAME magic_enum
GITHUB_REPOSITORY Neargye/magic_enum
GIT_TAG x.y.z # Where `x.y.z` is the release version you want to use.
)Bazel также поддерживается, просто добавьте в свой файл WORKSPACE:
http_archive(
name = "magic_enum",
strip_prefix = "magic_enum-<commit>",
urls = ["https://github.com/Neargye/magic_enum/archive/<commit>.zip"],
)
Чтобы использовать bazel внутри репозитория, можно сделать:
bazel build //...
bazel test //...
bazel run //example
(Обратите внимание, что вы должны использовать поддерживаемый компилятор или указать его с помощью export CC= <compiler> .)
Если вы используете Ros, вы можете включить этот пакет, добавив <depend>magic_enum</depend> в свой package.xml и включив этот пакет в свою рабочую область. В ваш CMakeLists.txt добавьте следующее:
find_package (magic_enum CONFIG REQUIRED)
...
target_link_libraries (your_executable magic_enum::magic_enum)
