Replacing text macros

预处理器支持文本宏替换和函数式文本宏替换。

语法

说明

#define 指令

#define 指令将 identifier 定义为宏，即指示编译器将所有后续出现的 identifier 替换为 replacement-list ，该替换列表可选择性地进行额外处理。若该标识符已定义为任何类型的宏，则程序非良构，除非定义完全一致。

对象式宏

对象式宏会将所有出现的已定义 标识符 替换为 替换列表 。 #define 指令的版本(1)正是如此运作的。

函数式宏

类函数宏会将每个已定义的 标识符 出现处替换为 替换列表 ，同时接收若干参数，这些参数随后会替换 替换列表 中对应 形参 的所有出现位置。

函数式宏调用的语法与函数调用语法相似：每个宏名称实例后紧跟一个 ( 作为下一个预处理标记时，会引入被替换列表所替换的标记序列。该序列由匹配的 ) 标记终止，同时跳过中间成对匹配的左右括号。

参数数量必须与宏定义中的参数数量相同，否则程序格式错误。若标识符未采用函数表示法（即自身后未跟随圆括号），则完全不会被替换。

版本（2）的 #define 指令定义了一个简单的函数式宏。

版本 (3) 的 #define 指令定义了一个可变参数数量的函数式宏。额外的参数可通过 __VA_ARGS__ 标识符访问，该标识符随后会被替换为与待替换标识符一同提供的参数。

版本 (4) 的 #define 指令定义了一个类似函数的宏，该宏具有可变数量的参数，但不包含常规参数。这些参数只能通过 __VA_ARGS__ 标识符访问，该标识符随后会被替换为与待替换标识符一同提供的参数。

#define F(...) f(0 __VA_OPT__(,) __VA_ARGS__)
F(a, b, c) // replaced by f(0, a, b, c)
F()        // replaced by f(0)
#define G(X, ...) f(0, X __VA_OPT__(,) __VA_ARGS__)
G(a, b, c) // replaced by f(0, a, b, c)
G(a, )     // replaced by f(0, a)
G(a)       // replaced by f(0, a)
#define SDEF(sname, ...) S sname __VA_OPT__(= { __VA_ARGS__ })
SDEF(foo);       // replaced by S foo;
SDEF(bar, 1, 2); // replaced by S bar = { 1, 2 };

注意：如果函数式宏的参数包含未被匹配的左右括号保护的逗号（例如 macro ( array [ x = y, x + 1 ] ) 或 atomic_store ( p, ( struct S ) { a, b } ) ; ），该逗号会被解释为宏参数分隔符，导致因参数数量不匹配而引发编译失败。

# 与 ## 运算符

在函数式宏中， # 运算符置于 替换列表 中的标识符前时，会对该标识符进行参数替换并将结果用引号括起，从而有效创建字符串字面量。此外，预处理器会添加反斜杠来转义嵌入字符串字面量（如果存在）的引号，并视需要将字符串内的反斜杠加倍处理。所有首尾空白符会被移除，文本中间（但不包括嵌入字符串字面量内部）的连续空白符序列会被压缩为单个空格。此操作称为“字符串化”。若字符串化结果不是有效的字符串字面量，则行为未定义。

#define showlist(...) puts(#__VA_ARGS__)
showlist();            // expands to puts("")
showlist(1, "x", int); // expands to puts("1, \"x\", int")

在 替换列表 中任意两个相邻标识符之间的 ## 运算符会对这两个标识符执行参数替换，然后将结果连接起来。此操作称为“连接”或“标记粘贴”。只有能共同构成有效标记的符号方可被粘贴：组成更长标识符的标识符、组成数字的数码，或是组成 += 的运算符 + 和 = 。无法通过粘贴 / 和 * 来创建注释，因为在宏替换处理前注释已从文本中移除。若连接结果不是有效标记，则行为未定义。

注意：某些编译器提供了一个扩展，允许在逗号后和 __VA_ARGS__ 前出现 ## ，在这种情况下当 __VA_ARGS__ 非空时 ## 不执行任何操作，但当 __VA_ARGS__ 为空时会移除逗号：这使得定义诸如 fprintf ( stderr , format, ##__VA_ARGS__) 之类的宏成为可能。

# 和 ## 运算符的求值顺序是未指定的。

#undef 指令

#undef 指令用于取消定义 标识符 ，即撤销之前通过 #define 指令对该 标识符 的定义。如果该标识符没有关联的宏定义，则该指令将被忽略。

预定义宏

以下宏名称在任何翻译单元中都是预定义的：

以下额外的宏名称可能由实现预定义：

这些宏的值（除了 __FILE__ 和 __LINE__ ）在翻译单元内保持恒定。尝试重新定义或取消定义这些宏会导致未定义行为。

示例

#include <stdio.h>
// 创建函数工厂并使用
#define FUNCTION(name, a) int fun_##name(int x) { return (a) * x; }
FUNCTION(quadruple, 4)
FUNCTION(double, 2)
#undef FUNCTION
#define FUNCTION 34
#define OUTPUT(a) puts( #a )
int main(void)
{
    printf("quadruple(13): %d\n", fun_quadruple(13));
    printf("double(21): %d\n", fun_double(21));
    printf("%d\n", FUNCTION);
    OUTPUT(billion); // 注意没有引号
}

quadruple(13): 52
double(21): 42
34
billion

缺陷报告

以下行为变更缺陷报告被追溯应用于先前发布的C标准。

参考文献

参见