Magic_enum项目使用限制与解决方案详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00244/article/details/148505241

Magic_enum项目使用限制与解决方案详解

magic_enum Static reflection for enums (to string, from string, iteration) for modern C++, work with any enum type without any macro or boilerplate code 项目地址: https://gitcode.com/gh_mirrors/ma/magic_enum

前言

Magic_enum是一个基于现代C++的枚举反射库，它能够在编译时获取枚举类型的名称和值信息。然而，由于其实现依赖于特定的编译器特性，在使用过程中存在一些限制和注意事项。本文将全面解析这些限制，并提供相应的解决方案。

编译器支持性

Magic_enum的核心实现依赖于编译器的__PRETTY_FUNCTION__或__FUNCSIG__特性，这是一种编译器特定的hack方法。

检查编译器支持

开发者可以通过以下方式检查当前编译器是否支持magic_enum：

// 使用宏检查
#if defined(MAGIC_ENUM_SUPPORTED)
// 支持magic_enum
#endif

// 或使用constexpr常量检查
if constexpr (magic_enum::is_magic_enum_supported) {
    // 支持magic_enum
}

如果当前编译器不支持magic_enum，使用该库会导致编译错误。若需要强制在不支持的编译器上使用，可以定义宏MAGIC_ENUM_NO_CHECK_SUPPORT来抑制错误。

前向声明限制

Magic_enum无法处理枚举的前向声明情况，这意味着所有需要反射的枚举类型必须在使用前完整定义。

枚举标志位处理

对于表示标志位的枚举类型，需要进行特殊处理。

标志位枚举配置

要将一个枚举类型标记为标志位枚举，需要在magic_enum::customize命名空间中特化enum_range模板：

enum class Directions { 
    Up = 1 << 0, 
    Down = 1 << 1, 
    Right = 1 << 2, 
    Left = 1 << 3 
};

template <>
struct magic_enum::customize::enum_range<Directions> {
    static constexpr bool is_flags = true;
};

标志位枚举的特殊性

MAGIC_ENUM_RANGE_MAX和MAGIC_ENUM_RANGE_MIN宏不会影响标志位枚举的最大数量
被声明为标志位的枚举，其零值不会被反射

枚举值范围限制

Magic_enum要求枚举值必须位于特定范围内，默认范围是[-128, 127]。

全局范围调整

如果需要修改所有枚举类型的默认范围，可以重新定义宏：

#define MAGIC_ENUM_RANGE_MIN 0
#define MAGIC_ENUM_RANGE_MAX 256
#include <magic_enum.hpp>

特定枚举范围调整

对于特定枚举类型，可以通过特化enum_range来设置自定义范围：

enum class number { one = 100, two = 200, three = 300 };

template <>
struct magic_enum::customize::enum_range<number> {
    static constexpr int min = 100;
    static constexpr int max = 300;
    // 注意：max - min必须小于UINT16_MAX
};

枚举别名问题

Magic_enum在处理枚举别名时存在限制，具体行为取决于编译器实现。

别名问题示例

enum ShapeKind {
  ConvexBegin = 0,
  Box = 0, // 不会正常工作
  Sphere = 1,
  ConvexEnd = 2,
  Donut = 2, // 也不会正常工作
  Banana = 3,
  COUNT = 4
};

在这种情况下，magic_enum::enum_cast<ShapeKind>("Box")将返回nullopt，而magic_enum::enum_name(ShapeKind::Box)会返回"ConvexBegin"。

解决方案

将需要反射的枚举值定义在别名之前：

enum ShapeKind {
  Box = 0,
  Sphere = 1,
  Donut = 2,
  Banana = 3,
  COUNT = Banana + 1,
  
  // 非反射别名
  ConvexBegin = Box,
  ConvexEnd = Sphere + 1
};

编译器差异

在某些编译器上（如Visual Studio 2017），枚举别名完全不被支持，此时宏MAGIC_ENUM_SUPPORTED_ALIASES将不会被定义。

编译器相关问题

常量表达式评估限制

如果遇到类似"constexpr evaluation hit maximum step limit"的错误，需要调整编译器的constexpr评估限制：

MSVC: 使用/constexpr:depthN和/constexpr:stepsN选项
Clang: 使用-fconstexpr-depth=N和-fconstexpr-steps=N选项
GCC: 使用-fconstexpr-depth=N、-fconstexpr-loop-limit=N和-fconstexpr-ops-limit=N选项