magic_enumダウンロード - magic_enumソースコードのダウンロード

magic_enum

C/C++

v0.9.7

ダウンロード

Magic Enum C++

ヘッダーのみの 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

enum 要素の数

 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"

Enum エントリのシーケンス

 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 ステートメントの Enum 融合

 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 定数としての Enum スイッチのランタイム値

Color color = Color::RED;
magic_enum::enum_switch ([] ( auto val) {
  constexpr Color c_color = val;
  // ...
}, color);

enum は各 enum を constexpr 定数として反復します

magic_enum::enum_for_each<Color>([] ( auto val) {
  constexpr Color c_color = val;
  // ...
});

enum に次のものが含まれているかどうかを確認する

 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"

enum の 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 のビット演算子

 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 変数から文字列へこのバージョンはコンパイル時間が大幅に軽くなり、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 フレンドリーな」underlying_type。

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を使用している場合は、conanの要件にmagic_enum/xyzを追加するだけですxyz使用したいリリースバージョンです。
Build2 を使用して依存関係を構築および管理している場合は、マニフェストファイルにdepends: magic_enum ^xyzを追加します。ここで、 xyz使用するリリースバージョンです。その後、 magic_enum%lib{magic_enum}使用してターゲットをインポートできます。

あるいは、CMake のFetch_Contentモジュールに基づく CPM などを使用することもできます。

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)
```