替换文本宏
预处理器支持文本宏替换及类函数文本宏替换。
语法
#define 标识符 替换列表(可选)
|
(1) | ||||||||
#define 标识符( 形参 ) 替换列表
|
(2) | ||||||||
#define 标识符( 形参, ... ) 替换列表
|
(3) | (C99 起) | |||||||
#define 标识符( ... ) 替换列表
|
(4) | (C99 起) | |||||||
#undef 标识符
|
(5) | ||||||||
解释
#define
指令
#define
指令定义 标识符 为宏,即它们指示编译器将所有 标识符 的后继出现替换为 替换列表 ,可以可选地附加地处理。若已定义该标识符为任何类型的宏,则程序为病式,除非定义相同。
仿对象宏
仿对象宏将所定义的 标识符 的每次出现替换为 替换列表 。 #define
指令的版本 (1) 准确地如此表现。
仿函数宏
仿函数宏将所定义的 标识符 的每次出现替换为 替换列表 ,额外地接受数个参数,它们会替换 替换列表 中任何 形参 的对应出现。
仿函数宏的调用语法与函数调用语法相似:每个宏名实例后跟一个作为下个预处理记号的 ( ,引入被 替换列表 所替换的记号序列,序列由匹配的 ) 记号终止,跳过中间已匹配的左右括号对。
实参数量必须与宏定义中( 形参 )的实参数量相同,否则程序为病式。若标识符不在函数记号中,即它自身不后随括号,则决不替换它。
#define
指令的版本 (2) 定义简单的仿函数宏。
#define
指令的版本 (3) 定义有可变数量实参的仿函数宏。能用 __VA_ARGS__
标识符访问额外实参,然后该标识符被实参替换。
#define
指令的版本 (4) 定义有可变数量实参的仿函数宏,但没有常规参数。只能用 __VA_ARGS__
标识符访问实参,然后该标识符被实参替换。
注意:若仿函数宏的实参包含逗号,且未为匹配的左右括号对所保护(例如 macro(array[x = y, x + 1]) 或 atomic_store (p, (struct S){ a, b }); ),则将逗号转译为宏实参分隔符,这导致编译失败,原因为实参数量不合。
#
与 ##
运算符
在仿函数宏中, 替换列表 中标识符前的 #
运算符对标识符做形参替换,并将结果环绕在引号中,等效地创建一个字符串字面量。而且,预处理器会添加反斜杠,以转义环绕内嵌字符串字面量的引号,若存在,并按需在字符串中双写反斜杠。它移除所有前导和尾随空白符,且将任何文本中部的空白符序列(但非内嵌字符串字面量中的)缩减成单个空格。此运算被称作“字符串化”。若字符串化的结果不是合法字符串字面量,则行为未定义。
#define showlist(...) puts(#__VA_ARGS__) showlist(); // 展开成 puts("") showlist(1, "x", int); // 展开成 puts("1, \"x\", int") |
(C99 起) |
替换列表 中任意二个相继标识符间的 ##
运算符对二个标识符进行参数替换,然后连接结果。此运算被称作“连接”或“记号粘贴”。只可以粘贴有一同组成合法记号的记号:组成较长标识符的标识符、组成数字的数位或组成 +=
的运算符 +
与 =
。不能通过粘贴 /
与 *
创建注释,因为注释被认为在宏替换前移除。若连接的结果不是合法记号,则行为未定义。
注意:一些编译器提供允许 ## 出现在逗号后和 __VA_ARGS__ 前的扩展,在此情况下 ## 在 __VA_ARGS__ 非空时无效,但在 __VA_ARGS__ 为空时移除逗号:这使得可以定义如 fprintf (stderr, format, ##__VA_ARGS__)
的宏。
#undef
指令
#undef
指令解除定义 标识符 ,即它取消先前 #define
对 标识符 的定义。若标识符无与之关联的宏,则忽略此指令。
预定义宏
下列宏名称预定义于任意翻译单元中:
__STDC__ |
展开成整数常量 1 。 此宏是用以指示一致实现的 (宏常量) |
__STDC_VERSION__ (C95) |
展开成 long 类型的整数常量,其值随着 C 标准的每个版本递增:
|
__STDC_HOSTED__ (C99) |
若实现有宿主(在操作系统下运行),则展开成整数常量 1 ,若为独立的(不在操作系统中运行)则展开成 0 (宏常量) |
__FILE__ |
展开成当前文件名,为字符串字面量,可用 #line 指令更改 (宏常量) |
__LINE__ |
展开成源文件行号,为整数常量,可用 #line 指令更改 (宏常量) |
__DATE__ |
展开成翻译的日期,格式为 "Mmm dd yyyy" 的字符串字面量。月份名如同以 asctime 生成,而若月之日期小于 10 则 "dd" 的首字符为空格 (宏常量) |
__TIME__ |
展开成翻译的时间,格式为 "hh:mm:ss" 的字符串字面量,如同 asctime() 所生成 (宏常量) |
实现可能预定义下列额外宏名:
__STDC_ISO_10646__ (C99) |
若 wchar_t 使用 Unicode ,则展开成形式为 yyyymmL 的整数常量,日期指示受支持的 Unicode 最近版本 (宏常量) |
__STDC_IEC_559__ (C99) |
若支持 IEC 60559 则展开成 1 (弃用) (C23 起) (宏常量) |
__STDC_IEC_559_COMPLEX__ (C99) |
若支持 IEC 60559 复数算术则展开成 1 (弃用) (C23 起) (宏常量) |
__STDC_UTF_16__ (C11) |
若 char16_t 使用 UTF-16 则展开成 1 (宏常量) |
__STDC_UTF_32__ (C11) |
若 char32_t 使用 UTF-32 则展开成 1 (宏常量) |
__STDC_MB_MIGHT_NEQ_WC__ (C99) |
若 'x' == L'x' 可能对基础字符集的成员为 false 则展开成 1 ,例如在基于 EBCDIC 的, wchar_t 使用 Unicode 的系统上 (宏常量) |
__STDC_ANALYZABLE__ (C11) |
若支持可分析性则展开成 1 (宏常量) |
__STDC_LIB_EXT1__ (C11) |
若支持边界检查接口则展开成整数常量 201112L (宏常量) |
__STDC_NO_ATOMICS__ (C11) |
若不支持原子类型和原子操作库则展开成 1 (宏常量) |
__STDC_NO_COMPLEX__ (C11) |
若不支持复数类型和复数运算库则展开成 1 (宏常量) |
__STDC_NO_THREADS__ (C11) |
若不支持多线程则展开成 1 (宏常量) |
__STDC_NO_VLA__ (C11) |
若不支持非常量长度数组则展开成 1 (宏常量) |
__STDC_IEC_60559_BFP__ (C23) |
若支持 IEC 60559 二进制浮点算术则展开成 202ymmL (日期待定) (宏常量) |
__STDC_IEC_60559_DFP__ (C23) |
若支持 IEC 60559 十进制浮点算术则展开成 202ymmL (日期待定) (宏常量) |
__STDC_IEC_60559_COMPLEX__ (C23) |
若支持 IEC 60559 复数算术则展开成 202ymmL (日期待定) (宏常量) |
这些宏的值(除了 __FILE__
和 __LINE__
)在整个翻译单元中保持常量。尝试重定义或解除定义这些宏导致未定义行为。
预定义对象 __func__ (细节见函数定义)不是预处理器宏,尽管有时与 |
(C99 起) |
示例
#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(million); // 注意缺少引号 }
输出:
quadruple(13): 52 double(21): 42 34 million
引用
- C17 标准(ISO/IEC 9899:2018):
- 6.10.3 Macro replacement (p: 121-126)
- 6.10.8 Predefined macro names (p: 127-129)
- C11 标准(ISO/IEC 9899:2011):
- 6.10.3 Macro replacement (p: 166-173)
- 6.10.8 Predefined macro names (p: 175-176)
- C99 标准(ISO/IEC 9899:1999):
- 6.10.3 Macro replacement (p: 151-158)
- 6.10.8 Predefined macro names (p: 160-161)
- C89/C90 标准(ISO/IEC 9899:1990):
- 3.8.3 Macro replacement
- 3.8.8 Predefined macro names