C 语言使用宏自定义可打印的枚举（enum） 类型

Posted 2023-02-27 landaliming

1. 前言：

---

说点废话，时间紧的请直接跳过，看后面的实现。

尽管本人很反感 C 语言中的宏定义，特别是滥用宏定义经常会让问题变的扑朔迷离，但是不得不承认，在某些时候，其的确是很好用的，就比如今天的例子。

我们代码中涉及到故障码或者状态机，很多人都会用宏定义或者枚举表示，我个人是比较倾向于后者的，当让是由于其能在编译阶段对重定义等问题的规避。但是呢，C 语言相比于其他的高级语言，对机器的友好更胜过对程序员的友好。常规的枚举类型，在编码阶段虽然比原始的魔幻数字直观很多，但是在调试阶段，不做特殊处理情况下默认打印的数字经常会把人搞晕，所以为了自己调试方便，今天尝试用宏定义实现一个自己的枚举类型，使得定义完成后可以在打印时可以打印出友好的字符串而不是数字。

---

2. 正文

1. 公共代码

// def_enums.h
#ifndef DEF_ENUMS_H
#define DEF_ENUMS_H

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

// 定义枚举类型
#define DEF_ENUM_TYPE(name, ENUMS, start) \\
    enum ENUM_##name                     \\
    name##_START = start,                 \\
    ENUMS(GENERATE_ENUM)                  \\
    name##_END                            \\
    

// 定义枚举类型描述字符串
#define DEF_ENUM_STRING(name, ENUMS)  \\
    const char* name##_STR[] =       \\
        #name##"_start"               \\
        ENUMS(GENERATE_ENUM_STRING)   \\
        #name##"_end"                 \\
    


#endif

2. 使用示例

// main.c
#include <stdio.h>
#include "def_enums.h"

/* 用户使用示例 */

// 头/源文件中定义
#define USER_ENUMS(GENERATE)                     \\
    GENERATE(ENUM_1)                             \\
    GENERATE(ENUM_2)                             \\
    GENERATE(ENUM_3)                             \\
    GENERATE(ENUM_4)                             \\
    GENERATE(ENUM_5)

DEF_ENUM_TYPE(MY_ENUM, USER_ENUMS, 0);
extern const char* MY_ENUM_STR[];

// 在源文件中定义
DEF_ENUM_STRING(MY_ENUM, USER_ENUMS); // 注意要定义在源文件中，不能定义到头文件

int main()

    ENUM_MY_ENUM tmp = ENUM_2;
    printf("tmp = %s\\n", MY_ENUM_STR[tmp]);

    // 循环打印枚举值
    for (int i = MY_ENUM_START; i <= MY_ENUM_END; i++)
    
        printf("%d = %s\\n", i, MY_ENUM_STR[i]);