c与c++的X宏

我们经常会想要给enum类型匹配一定的数据，比如我们在处理http数据的时候，需要考虑http的请求类型，请求类型有许多种，假设我们只考虑GET,POST,DELETE，于是我们建立一个枚举类型来表示请求类型:

enum HttpMethod{
  GET,
  POST,
  DELETE,
  UNEXPECT
};

于是我们在打印数据的时候就会写出如下所示的代码:

void print_http_method(HttpMethod method)
{
  switch(method)
  {
      case GET:
        cout << "GET" <<endl;
        break;
      case POST:
        cout << "POST" << endl;
      case DELETE:
         break;
        cout << "DELETE" << endl;
      default:
        cout << "Unexpect Method" << endl;
  }
}

在解析http信息的时候需要用到类似下面的代码:

HttpMethod parse_method_from_str(const char* in_str)
{
  if(strcmp(in_str,"GET") == 0)
    return GET;
  if(strcmp(in_str,"POST") == 0)
    return POST;
  if(strcmp(in_str,"DELETE") == 0)
    return GET;
  return UNEXPECT;
}

这就造成一个问题那就是若要加入一个新的请求类型，就需要修改三处代码，这不但很麻烦也很容易出错。不过在Rust里这个问题就要好得多，因为Rust里enum是自带数据的，如下:

// rust 代码
enum {
  GET(String),
  POST(String),
  DELETE(String),
}

那么在c++里我们如何将这enum和数据联系起来呢?下面就介绍一下所谓的 "X宏"方法。

X 宏方法论

X宏本质也是编译期替换，比如你列出你所需要的数据的联系像下面这样:

#define HTTP_METHOD_MAP(XX)                                                    \ 
  XX(0, GET, "GET")                                                          \
  XX(1, POST, "POST")                                                            \
  XX(2, DELETE, "DELETE")                                                      \

以上面的代码为例，这行的意思是若遇到 "HTTP_METHOD_MAP(XX)" 就将其替换为下面3行代码。

那么X宏怎么用呢?

比如我们想定义一个类似前文所说的枚举，于是我们这样定义:

enum HttpMethod {
#define XX(num, name, string) HTTP_##name = num, // 这里define新的模板
  HTTP_METHOD_MAP(XX)
#undef XX // 这之后取消前面的模板
      HTTP_UNEXPECT_METHOD
};

我们将前面的define列表替换进来，就得到了下面的式子:

enum HttpMethod{
  HTTP_GET =  0,
  HTTP_POST = 1,
  HTTP_DELETE = 2，
  HTTP_UNEXPECT_METHOD
};

看到了把，之前定义的列表很快就根据相应的模板展开为我们想要的格式了。在这里XX只是一个中间字符串，我们把它定义为其它也同样可以。

这样，你就学会了X宏的使用了，接下来我们来解决前面的问题吧!

如何将字符串转换为枚举，写下面的函数就可以:

/*str 转换为enum型*/
enum HttpMethod http_method_enum(const char *str) {
#define XX(num, name, string)                                                  \ 
  if (strcmp(string, str) == 0)                                                \
    return HTTP_##name;                                                        // 模板
  HTTP_METHOD_MAP(XX)
#undef XX
  return HTTP_UNEXPECT_METHOD;
}

看到了吧，我们只是用模板来规范列表的格式，列表有多少行，在这里就会用if写多少句。
替换的结果是下面这样:

enum HttpMethod http_method_enum(const char *str) {                                  
  if (strcmp("GET", str) == 0)                                    
    return HTTP_GET;
  if(strcmp("POST",str) == 0)
    return HTTP_POST;
  if(strcmp("DELETE", str) == 0)
    return HTTP_DELETE;
  return HTTP_UNEXPECT_METHOD;
}

如何将枚举转换为字符串? 看看下面的代码:

const char *http_method_str(HttpMethod method) {
  switch (method) {
#define XX(num, name, string)                                                  \
  case HTTP_##name:                                                            \
    return string;                                                              //模板
    HTTP_METHOD_MAP(XX)
#undef XX
  default:
    return "<unexpect>";
  }
}

于是在这里列表有多少行，就会生成多少个case语句。
替换的结果是下面这样:

const char *http_method_str(HttpMethod method) {
  switch (method) {
  case HTTP_GET:
    return "GET";
  case HTTP_POST:
    return "POST";
  case HTTP_DELETE:
    return "DELETE";
  default:
    return "<unexpect>";
  }
}

总结

在c++中由于枚举不能绑定数据，我们可以利用“X宏”的方法来实现枚举和数据的绑定，所谓的“X宏”并不是特定的术语，而是一种用宏替换的一种方法论，它的原理也并不是真的将枚举和数据绑定，根本上仍然是编译期的替换。

参考资料

[1] What are X-macros? – Arthur O'Dwyer – Stuff mostly about C++ (quuxplusone.github.io)
[2] https://stackoverflow.com/a/202511

最后编辑于：2022.07.14 16:55:10