Cで列挙名を文字列に変換する方法

Question 1

Cで列挙子名を文字列に変換する可能性はありますか？

Question 2

1つの方法は、プリプロセッサーに処理を行わせることです。また、列挙型と文字列が同期していることも確認します。

#define FOREACH_FRUIT(FRUIT) \
        FRUIT(apple)   \
        FRUIT(orange)  \
        FRUIT(grape)   \
        FRUIT(banana)  \

#define GENERATE_ENUM(ENUM) ENUM,
#define GENERATE_STRING(STRING) #STRING,

enum FRUIT_ENUM {
    FOREACH_FRUIT(GENERATE_ENUM)
};

static const char *FRUIT_STRING[] = {
    FOREACH_FRUIT(GENERATE_STRING)
};

プリプロセッサが完了すると、次のようになります。

enum FRUIT_ENUM {
    apple, orange, grape, banana,
};

static const char *FRUIT_STRING[] = {
    "apple", "orange", "grape", "banana",
};

それからあなたは次のようなことをすることができます：

printf("enum apple as a string: %s\n",FRUIT_STRING[apple]);

ユースケースが文字通り列挙名を出力するだけの場合は、次のマクロを追加します。

#define str(x) #x
#define xstr(x) str(x)

次に行います：

printf("enum apple as a string: %s\n", xstr(apple));

この場合、2レベルのマクロは不必要に思えるかもしれませんが、Cでの文字列化の仕組みにより、場合によっては必要になります。たとえば、列挙型で#defineを使用するとします。

#define foo apple

int main() {
    printf("%s\n", str(foo));
    printf("%s\n", xstr(foo));
}

出力は次のようになります。

foo
apple

これは、strが入力fooをAppleに展開するのではなく、文字列化するためです。xstrを使用することにより、マクロ展開が最初に行われ、次にその結果が文字列化されます。

詳細については、文字列化を参照してください。

Question 3

あなたがこれを持っている状況では：

enum fruit {
    apple, 
    orange, 
    grape,
    banana,
    // etc.
};

これを、列挙型が定義されているヘッダーファイルに挿入します。

static inline char *stringFromFruit(enum fruit f)
{
    static const char *strings[] = { "apple", "orange", "grape", "banana", /* continue for rest of values */ };

    return strings[f];
}

Question 4

これを直接達成する簡単な方法はありません。ただし、P99には、そのようなタイプの関数を自動的に作成できるマクロがあります。

 P99_DECLARE_ENUM(color, red, green, blue);

ヘッダーファイル内

 P99_DEFINE_ENUM(color);

1つのコンパイル単位（.cファイル）でトリックを実行する必要がありますcolor_getname。この例では、関数が呼び出されます。

Question 5

専用の配列文字列を宣言せずに同じ仕事をしているCプリプロセッサトリックを見つけました（出典：http : //userpage.fu-berlin.de/~ram/pub/pub_jf47ht81Ht/c_preprocessor_applications_en）。

順次列挙

ステファンラムの発明に続いて、次のenum {foo=-1, foo1 = 1}ような天才的なトリックのように（たとえば、明示的にインデックスを指定せずに）列挙型を実現できます。

#include <stdio.h>

#define NAMES C(RED)C(GREEN)C(BLUE)
#define C(x) x,
enum color { NAMES TOP };
#undef C

#define C(x) #x,    
const char * const color_name[] = { NAMES };

これにより、次の結果が得られます。

int main( void )  { 
    printf( "The color is %s.\n", color_name[ RED ]);  
    printf( "There are %d colors.\n", TOP ); 
}

色は赤です。
3色ございます。

非順次列挙型

エラーコード定義を配列文字列にマップして、生のエラー定義をエラーコード（例：）に追加できるようにしたいので"The error is 3 (LC_FT_DEVICE_NOT_OPENED)."、それぞれの列挙値に必要なインデックスを簡単に決定できるようにコードを拡張しました：

#define LOOPN(n,a) LOOP##n(a)
#define LOOPF ,
#define LOOP2(a) a LOOPF a LOOPF
#define LOOP3(a) a LOOPF a LOOPF a LOOPF
#define LOOP4(a) a LOOPF a LOOPF a LOOPF a LOOPF
#define LOOP5(a) a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF
#define LOOP6(a) a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF
#define LOOP7(a) a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF
#define LOOP8(a) a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF
#define LOOP9(a) a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF a LOOPF


#define LC_ERRORS_NAMES \
    Cn(LC_RESPONSE_PLUGIN_OK, -10) \
    Cw(8) \
    Cn(LC_RESPONSE_GENERIC_ERROR, -1) \
    Cn(LC_FT_OK, 0) \
    Ci(LC_FT_INVALID_HANDLE) \
    Ci(LC_FT_DEVICE_NOT_FOUND) \
    Ci(LC_FT_DEVICE_NOT_OPENED) \
    Ci(LC_FT_IO_ERROR) \
    Ci(LC_FT_INSUFFICIENT_RESOURCES) \
    Ci(LC_FT_INVALID_PARAMETER) \
    Ci(LC_FT_INVALID_BAUD_RATE) \
    Ci(LC_FT_DEVICE_NOT_OPENED_FOR_ERASE) \
    Ci(LC_FT_DEVICE_NOT_OPENED_FOR_WRITE) \
    Ci(LC_FT_FAILED_TO_WRITE_DEVICE) \
    Ci(LC_FT_EEPROM_READ_FAILED) \
    Ci(LC_FT_EEPROM_WRITE_FAILED) \
    Ci(LC_FT_EEPROM_ERASE_FAILED) \
    Ci(LC_FT_EEPROM_NOT_PRESENT) \
    Ci(LC_FT_EEPROM_NOT_PROGRAMMED) \
    Ci(LC_FT_INVALID_ARGS) \
    Ci(LC_FT_NOT_SUPPORTED) \
    Ci(LC_FT_OTHER_ERROR) \
    Ci(LC_FT_DEVICE_LIST_NOT_READY)


#define Cn(x,y) x=y,
#define Ci(x) x,
#define Cw(x)
enum LC_errors { LC_ERRORS_NAMES TOP };
#undef Cn
#undef Ci
#undef Cw
#define Cn(x,y) #x,
#define Ci(x) #x,
#define Cw(x) LOOPN(x,"")
static const char* __LC_errors__strings[] = { LC_ERRORS_NAMES };
static const char** LC_errors__strings = &__LC_errors__strings[10];

この例では、Cプリプロセッサは次のコードを生成します。

enum LC_errors { LC_RESPONSE_PLUGIN_OK=-10,  LC_RESPONSE_GENERIC_ERROR=-1, LC_FT_OK=0, LC_FT_INVALID_HANDLE, LC_FT_DEVICE_NOT_FOUND, LC_FT_DEVICE_NOT_OPENED, LC_FT_IO_ERROR, LC_FT_INSUFFICIENT_RESOURCES, LC_FT_INVALID_PARAMETER, LC_FT_INVALID_BAUD_RATE, LC_FT_DEVICE_NOT_OPENED_FOR_ERASE, LC_FT_DEVICE_NOT_OPENED_FOR_WRITE, LC_FT_FAILED_TO_WRITE_DEVICE, LC_FT_EEPROM_READ_FAILED, LC_FT_EEPROM_WRITE_FAILED, LC_FT_EEPROM_ERASE_FAILED, LC_FT_EEPROM_NOT_PRESENT, LC_FT_EEPROM_NOT_PROGRAMMED, LC_FT_INVALID_ARGS, LC_FT_NOT_SUPPORTED, LC_FT_OTHER_ERROR, LC_FT_DEVICE_LIST_NOT_READY, TOP };

static const char* __LC_errors__strings[] = { "LC_RESPONSE_PLUGIN_OK", "" , "" , "" , "" , "" , "" , "" , "" "LC_RESPONSE_GENERIC_ERROR", "LC_FT_OK", "LC_FT_INVALID_HANDLE", "LC_FT_DEVICE_NOT_FOUND", "LC_FT_DEVICE_NOT_OPENED", "LC_FT_IO_ERROR", "LC_FT_INSUFFICIENT_RESOURCES", "LC_FT_INVALID_PARAMETER", "LC_FT_INVALID_BAUD_RATE", "LC_FT_DEVICE_NOT_OPENED_FOR_ERASE", "LC_FT_DEVICE_NOT_OPENED_FOR_WRITE", "LC_FT_FAILED_TO_WRITE_DEVICE", "LC_FT_EEPROM_READ_FAILED", "LC_FT_EEPROM_WRITE_FAILED", "LC_FT_EEPROM_ERASE_FAILED", "LC_FT_EEPROM_NOT_PRESENT", "LC_FT_EEPROM_NOT_PROGRAMMED", "LC_FT_INVALID_ARGS", "LC_FT_NOT_SUPPORTED", "LC_FT_OTHER_ERROR", "LC_FT_DEVICE_LIST_NOT_READY", };

これにより、次の実装機能が実現します。

LC_errors__strings [-1] ==> LC_errors__strings [LC_RESPONSE_GENERIC_ERROR] ==> "LC_RESPONSE_GENERIC_ERROR"

Question 6

列挙型と文字列が同期していることを確認するために、プリプロセッサに依存する必要はありません。マクロを使用すると、コードが読みにくくなる傾向があります。

Enumと文字列の配列の使用

enum fruit                                                                   
{
    APPLE = 0, 
    ORANGE, 
    GRAPE,
    BANANA,
    /* etc. */
    FRUIT_MAX                                                                                                                
};   

const char * const fruit_str[] =
{
    [BANANA] = "banana",
    [ORANGE] = "orange",
    [GRAPE]  = "grape",
    [APPLE]  = "apple",
    /* etc. */  
};

注：fruit_str配列内の文字列は、列挙型項目と同じ順序で宣言する必要はありません。

どうやって使うのですか

printf("enum apple as a string: %s\n", fruit_str[APPLE]);

コンパイル時チェックの追加

1つの文字列を忘れないようにする場合は、次のチェックを追加できます。

#define ASSERT_ENUM_TO_STR(sarray, max) \                                       
  typedef char assert_sizeof_##max[(sizeof(sarray)/sizeof(sarray[0]) == (max)) ? 1 : -1]

ASSERT_ENUM_TO_STR(fruit_str, FRUIT_MAX);

enumアイテムの量が配列内の文字列の量と一致しない場合、コンパイル時にエラーが報告されます。

Question 7

enumを検証しないそのような関数はささいな危険です。switchステートメントの使用をお勧めします。別の利点は、これが、値が1、2、4、8、16などのフラグの場合など、定義された値を持つ列挙型に使用できることです。

また、すべての列挙型文字列を1つの配列にまとめます。

static const char * allEnums[] = {
    "Undefined",
    "apple",
    "orange"
    /* etc */
};

ヘッダーファイルでインデックスを定義します。

#define ID_undefined       0
#define ID_fruit_apple     1
#define ID_fruit_orange    2
/* etc */

これにより、たとえば、プログラムの国際バージョンを他の言語で作成したい場合などに、異なるバージョンを簡単に作成できます。

ヘッダーファイルでもマクロを使用：

#define CASE(type,val) case val: index = ID_##type##_##val; break;

switchステートメントで関数を作成します。これはconst char *、文字列static constsが原因でaを返すはずです：-

const char * FruitString(enum fruit e){

    unsigned int index;

    switch(e){
        CASE(fruit, apple)
        CASE(fruit, orange)
        CASE(fruit, banana)
        /* etc */
        default: index = ID_undefined;
    }
    return allEnums[index];
}

Windowsでプログラミングする場合、ID_値はリソース値にすることができます。

（C ++を使用している場合、すべての関数に同じ名前を付けることができます。

string EnumToString(fruit e);

）

Question 8

指示子を使用して文字列配列をインスタンス化することに基づく、Hokyoの「Non-Sequential enums」の回答のより簡単な代替方法：

#define NAMES C(RED, 10)C(GREEN, 20)C(BLUE, 30)
#define C(k, v) k = v,
enum color { NAMES };
#undef C

#define C(k, v) [v] = #k,    
const char * const color_name[] = { NAMES };

Question 9

私は通常これを行います：

#define COLOR_STR(color)                            \
    (RED       == color ? "red"    :                \
     (BLUE     == color ? "blue"   :                \
      (GREEN   == color ? "green"  :                \
       (YELLOW == color ? "yellow" : "unknown"))))