実は非常に美しく実現する方法がある、という話。以下は特にMSVCの話で、GCC他ではまた少し仕様が異なっているのだが、あるライブラリを使えばMSVC、Clang、GCC、Xcodeいずれでも環境の差が吸収され簡単にできるようになる。長々とした説明を読みたくない人は下のmagic_enumという項までスクロールすべし。
enumは単なる整数値に名前を付与する手段の一つだ。パラメータの意味がわかりやすくなる上、処理コストの大きな文字列を使わなくても良い便利な機能である。最近ではenum classの形で使われることが推奨されている。
enum Month { Jan = 1, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec, }; int i = (int)Jan;//i == 1 int j = (int)Oct;//j == 10
ただ例えば標準出力などにその名前の方を出力したいと思っても、ちょっと手間がかかる。enumは本質的にはただの整数値なので、例えばprintfの%sに直接enumを渡すことは出来ない。もし文字列に変換したいのなら、通常はswitch文などを使って値ごとに処理を分岐しなければならない。と一般には思われている。
Month e = Feb; //printf("%s\n", e); これは不可能。 switch (e) { case Jan: printf("Jan"); break; case Feb: printf("Feb"); break; ︙ }
これはCやC++の初心者でも理解できる単純な方法という意味では優れている。しかしswitchなどで分岐する場合は記述コストが大きくなるし、列挙型に新たなメンバを追加した際は修正しなければならない。またenumと文字列を相互に変換することはできない。
std::unordered_mapやboost::bimapsを使って対応付けることで相互変換を実現することは出来るが、メンテナンスコストは大きいままだ。
あるいはマクロを使う手もしばしば提示されるが、これは良くない。マクロはコンパイルの直前に展開されるため、変数の中身は文字列化できないのだ。
#define VarName(name) #name printf("%s", VarName(Jan));//これは正しく"Jan"と出力されるが、 Month e = Feb; printf("%s", VarName(e));//これでは"Feb"ではなく"e"と出力される。
だが実は、他にも方法がある。
enumのメンバ名の文字列を得るためのテクニック
自前で分岐させる他にも、enumの変数名を取得する方法は存在しないわけではないのである。鍵となるのはは__FUNCSIG__（Clang、GCC等では__PRETTY_FUNCTION__）という定義済みマクロだ。これは関数の情報を返してくれるもので、例えば次のようにfuncという関数内でこのマクロの中身を見てみると、
int func(int x) { std::cout << __FUNCSIG__ << std::endl;//int __cdecl func(int) return x; }
このように、マクロの外側の関数についての情報を教えてくれる。これを利用する。次の関数を考えてみよう。
enum Month { Jan = 1, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec, }; template <class M, M m> void func() { std::cout << __FUNCSIG__ << std::endl;//void __cdecl func<enum Month,Jan>(void) }
面白いことに、テンプレートパラメータにenumのメンバを渡すと、__FUNCSIG__の関数名にそのメンバの文字列が含まれるようになるのだ。これはtypeidなどには出来ない芸当である。あとはこの情報から前半と後半に付随する余計な文字を削除すれば、enumから文字列への変換が可能になる。
え、これじゃ実行時変数からは文字列に変換できないじゃんって？そこは配列の出番である。予め"enumの各メンバに対応する文字列を格納した配列"を生成しておき、実行時にそこから適宜取り出せばよい。例えばもし定義した列挙型が0から始まる連続した整数であれば話は早い。とてもいい加減に作ってみると以下のような感じになる。
#include <iostream> #include <string> #include <utility> #include <array> template <size_t N> struct StaticString { StaticString(const char* c) : StaticString(c, std::make_index_sequence<N>()) {} std::string str() const { return std::string(mStr); } private: template <size_t ...Indices> StaticString(const char* c, std::index_sequence<Indices...>) : mStr{ c[Indices]..., '\0' } {} char mStr[N + 1]; }; template <class M, M m> constexpr auto EnumName() { constexpr char name[] = { __FUNCSIG__ }; constexpr size_t N = sizeof(name) - 39; return StaticString<N>(name + 31); } template <class Enum, class Indices> struct EnumNames; template <class Enum, std::underlying_type_t<Enum> ...Indices> struct EnumNames<Enum, std::integer_sequence<std::underlying_type_t<Enum>, Indices...>> { static const std::array<std::string, sizeof...(Indices)> msNames; }; template <class Enum, std::underlying_type_t<Enum> ...Indices> const std::array<std::string, sizeof...(Indices)> EnumNames<Enum, std::integer_sequence<std::underlying_type_t<Enum>, Indices...>>::msNames = { EnumName<Enum, (Enum)(Indices)>().str()... }; template <class Enum, std::underlying_type_t<Enum> Max = 128> std::string GetEnumName(Enum e) { using UType = std::underlying_type_t<Enum>; constexpr size_t Size = Max; static const auto& names = EnumNames<Enum, std::make_integer_sequence<UType, Size>>::msNames; return names[(UType)e]; } enum DoW { Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, }; int main() { std::cout << GetEnumName(Monday) << std::endl;//Monday std::cout << GetEnumName(Saturday) << std::endl;//Saturday return 0; }
この方法の最大の利点は、あらゆるenumに対して使える点である。新たなenumを定義したりメンバを追加したりしても上のコードを書き直す必要がない。
しかし列挙型は場合によっては、0以外から始まる整数、非連続な整数などをメンバとして持つ場合もある。上で出てきたMonthなんてまさに1から始まる12までの整数なので、超適当に実装したGetEnumNameでは対応できない。しかしC++に列挙型の値の一覧を取得する方法が用意されているわけでもないので、これを実装するのはいろいろな小技が必要になり、非常に手間だ。またenum classを用いた場合も若干表示が狂う。しかも上の実装はMSVC用なので、他の環境ではこれまた正常に動作しない。何とかならないのだろうか？
magic_enum
そこで登場するのがmagic_enumである。このあたりのややこしいメタプログラミングを全部実装してくれていて、非常に簡単にenumと文字列の相互変換を可能にしてくれる最高のライブラリだ。相互変換である。上ではenumから文字列への変換しか実装しなかったが、こちらは文字列からenumへの変換まで可能にしてくれる万能っぷり。その実装の美しさはもうコードを読み進めるごとに感動で涙してしまうほどである。シングルヘッダーなのでファイル一つコピペしてincludeするだけで使えるところも素晴らしい。
#include <iostream> #include <magic_enum.hpp> enum Month { Jan = 1, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec, }; int main() { std::cout << magic_enum::enum_name(Jan) << std::endl;//Jan std::cout << magic_enum::enum_cast<Month>("Feb").value() << std::endl;//2 return 0; }
こんなにも簡単に相互変換できてしまう。こんなもん絶賛せずにいられるか。
惜しむらくは、C++17以上でないと利用できないことか。おかげで私は導入したくても出来なかったりする。誰かC++11か14で使えるように改造してくれ。私は面倒だからやりたくない。
