宏 define 的高级特性：预处理运算符 “#” 及 “##”

2016-07-17

最近在对一段代码进行重构的时候，发现宏 define 能发挥很大作用。关于其在代码重构方面的使用，本文会举一个具体的例子。首先，我们来看一下其高级特性：Stringize （字符串化）及 Token Pasting。

Stringize

ANSI C 允许在字符串中包含宏参数。# 符号用作一个预处理运算符，它可以把语言符号转化成字符串。如下例所示（在 VS 及 GCC 下最终结果均一样）：

#include <stdio.h>

#define STRINGIZE(a)	#a

int main()
{
	char *str = STRINGIZE(Hello World!);
	printf("%s\n", str);
	return 0;
}

Token Pasting

## 预运算符可以把两个语言符号组合成单个语言符号。如下例所示（在 VS 及 GCC 下最终结果均一样）：

#include <stdio.h>

#define CONCAT(a, b)	a##b
#define AB	1

int main()
{
	int a[] = { 0, 1, 2 };
	printf("a[%d] = %d\n", CONCAT(A, B), a[CONCAT(A, B)]);
	return 0;
}

输出：a[1] = 1

我们再来看一个例子（在 VS 可编译成功，在 GCC 下出错）：

#define GETMEMBER(stru, mem)	stru.##mem	

typedef struct Test{
	char *name;
	int age;
}Test;


int main()
{	
	Test test = { "XHF", 18 };
	printf("My name is %s.\n", GETMEMBER(test, name));
	printf("I'm %d years old.\n", GETMEMBER(test, age));	
	return 0;
}

这个例子在 VS 下可以正确输出结果，但在 GCC 下会输出如下错误提示：

解决这个问题很简单，只需要将第一行代码中的 stru.##mem 中的 ## 去掉即可，即改为：

1 2	// 下式对 VS 及 GCC 均适用 #define GETMEMBER(stru, mem) stru.mem

实际上，对 GCC 而言，在要使用 ## 的地方，如果它的前边已经有运算符（如 . ( ) [ ] ），我们都需要删除掉它，因为这些运算符已经起到它的作用（即起到分割 Token 的作用）。

#、## 在代码重构中的作用

我们先来看一段代码：

request[First_Node_In_The_Network] = ptr->get_request_param(environ, First_Node_In_The_Network, "Get First Node In The Network");
request[Second_Node_In_The_Network] = ptr->get_request_param(environ, Second_Node_In_The_Network, "Get Second Node In The Network");
request[Third_Node_In_The_Network] = ptr->get_request_param(environ, Third_Node_In_The_Network, "Get Third Node In The Network");
request[Fourth_Node_In_The_Network] = ptr->get_request_param(environ, Fourth_Node_In_The_Network, "Get Fourth Node In The Network");
request[Fifth_Node_In_The_Network] = ptr->get_request_param(environ, Fifth_Node_In_The_Network, "Get Fifth Node In The Network");
request[Sixth_Node_In_The_Network] = ptr->get_request_param(environ, Sixth_Node_In_The_Network, "Get Sixth Node In The Network");
......

很明显这段代码的所有行的结构都是一样的，但这种写法却容易出错，也不方便后续维护，因为我们选择对他进行重构。重构之后的代码如下：

#define GETREQUEST(seq)	request[seq##_Node_In_The_Network] = ptr->get_request_param(environ, seq##_Node_In_The_Network, "Get " #seq " Node In The Network")
GETREQUEST(First)
GETREQUEST(Second)
GETREQUEST(Third)
GETREQUEST(Fourth)
GETREQUEST(Fifth)
GETREQUEST(Sixth)
......

这样一来，代码就清晰很多，而且维护起来也更加方便。我们可以测试一下这个宏是否正确：

#include <stdio.h>

#define GETREQUEST(seq)	request[seq##_Node_In_The_Network] = ptr->get_request_param(environ, seq##_Node_In_The_Network, "Get " #seq " Node In The Network")
// 测试宏是否正确额外定义的两个宏
#define d(a)	#a
#define s(a)	d(a)

int main()
{	
	puts(d(GETREQUEST(First)));
	return 0;
}

输出结果如下：

说明这个宏是正确的。

注：

左中括号 “[” 已经起到分割 Token 的作用，所以，左中括号和 seq 之间不用再加 ##（在 VS 环境中可以加，GCC 环境中不行）
上图中的 “Get “ “First” “ Node In The Network” 其实跟 “Get First Node In The Network” 是等价的

Stringize

Token Pasting

#、## 在代码重构中的作用

参考资料