命名空间
变体
操作

替换文本宏

来自 cppreference.cn
 
C
 
C 语言
 
预处理器
 

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

内容

[编辑] 语法

#define 标识符 替换列表(可选) (1)
#define 标识符( 参数 ) 替换列表 (2)
#define 标识符( 参数, ... ) 替换列表 (3) (自 C99 起)
#define 标识符( ... ) 替换列表 (4) (自 C99 起)
#undef 标识符 (5)

[编辑] 解释

[编辑] #define 指令

#define 指令将 标识符 定义为宏，也就是说，它们指示编译器将所有后续出现的 标识符 替换为 替换列表，替换列表可以选择性地进行额外处理。如果该标识符已被定义为任何类型的宏，则除非定义完全相同，否则程序是非良构的。

[编辑] 类对象宏

类对象宏将每次出现的已定义 标识符 替换为 替换列表。版本（1）的 #define 指令的行为正是如此。

[编辑] 类函数宏

类函数宏将每次出现的已定义 标识符 替换为 替换列表，此外，它还接受多个参数，这些参数随后会替换 替换列表 中任何参数的相应出现。

类函数宏调用的语法类似于函数调用的语法：宏名称的每个实例后跟一个 ( 作为下一个预处理标记，引入了将被替换列表替换的标记序列。该序列以匹配的 ) 标记终止，跳过中间匹配的左右括号对。

参数的数量必须与宏定义（参数）中的参数数量相同，否则程序是非良构的。如果标识符不是函数表示法，即自身后没有括号，则根本不会被替换。

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

版本（3）的 #define 指令定义了一个具有可变数量参数的类函数宏。可以使用 __VA_ARGS__ 标识符访问额外的参数，然后 __VA_ARGS__ 标识符会被替换为提供给要替换的标识符的参数。

版本（4）的 #define 指令定义了一个具有可变数量参数但没有常规参数的类函数宏。只能使用 __VA_ARGS__ 标识符访问参数，然后 __VA_ARGS__ 标识符会被替换为提供给要替换的标识符的参数。

对于版本（3,4），替换列表 可能包含标记序列 __VA_OPT__ ( 内容 )，如果 __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 };
 (自 C23 起)


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

[编辑] # 和 ## 运算符

在类函数宏中，替换列表中的标识符之前的 # 运算符会对标识符进行参数替换，并将结果用引号括起来，从而有效地创建一个字符串字面量。此外，预处理器会添加反斜杠来转义嵌入式字符串字面量（如果有）周围的引号，并在必要时将字符串中的反斜杠加倍。所有前导和尾随空格都会被删除，文本中间的任何空格序列（但嵌入式字符串字面量内部的空格序列除外）都会被折叠为单个空格。此操作称为“字符串化”。如果字符串化的结果不是有效的字符串字面量，则行为未定义。

当 # 出现在 __VA_ARGS__ 之前时，整个展开的 __VA_ARGS__ 会被括在引号中

#define showlist(...) puts(#__VA_ARGS__)
showlist();            // expands to puts("")
showlist(1, "x", int); // expands to 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 标准的每个版本而增加
  • 199409L (C95)
  • 199901L (C99)
  • 201112L (C11)
  • 201710L (C17)
  • 202311L (C23)
    (宏常量)
__STDC_HOSTED__
(C99)
 如果实现是宿主式（在操作系统下运行），则展开为整数常量 1，如果是独立式（不带操作系统运行），则展开为 0
(宏常量)
__FILE__
 展开为当前文件的名称，作为字符字符串字面量，可以通过 #line 指令更改
(宏常量)
__LINE__
 展开为源文件行号，一个整数常量，可以通过 #line 指令更改
(宏常量)
__DATE__
 展开为翻译日期，形式为 “Mmm dd yyyy” 的字符字符串字面量。月份名称如同由 asctime 生成，如果月份中的日期小于 10，则 “dd” 的第一个字符为空格
(宏常量)
__TIME__
 展开为翻译时间，形式为 “hh:mm:ss” 的字符字符串字面量，如同由 asctime() 生成的时间
(宏常量)
__STDC_UTF_16__
(C23)
 展开为 1 以指示 char16_t 使用 UTF-16 编码
(宏常量)
__STDC_UTF_32__
(C23)
 展开为 1 以指示 char32_t 使用 UTF-32 编码
(宏常量)
__STDC_EMBED_NOT_FOUND____STDC_EMBED_FOUND____STDC_EMBED_EMPTY__
(C23)
 分别展开为 0、1 和 2
(宏常量)

以下附加宏名称可以由实现预定义

__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' 可能为假，例如在使用 Unicode 作为 wchar_t 的基于 EBCDIC 的系统上，则展开为 1
(宏常量)
__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)
 如果不支持变长数组和自动存储期的可变修改类型 (C23 前) 或自动存储期的变长数组 (C23 起)，则展开为 1
(宏常量)
__STDC_IEC_60559_BFP__
(C23)
 如果支持 IEC 60559 二进制浮点算术，则展开为 202311L
(宏常量)
__STDC_IEC_60559_DFP__
(C23)
 如果支持 IEC 60559 十进制浮点算术，则展开为 202311L
(宏常量)
__STDC_IEC_60559_COMPLEX__
(C23)
 如果支持 IEC 60559 复数算术，则展开为 202311L
(宏常量)
__STDC_IEC_60559_TYPES__
(C23)
 如果支持 IEC 60559 互换和扩展类型，则展开为 202311L
(宏常量)

这些宏的值（__FILE__ 和 __LINE__ 除外）在整个翻译单元中保持不变。尝试重新定义或取消定义这些宏会导致未定义的行为。

预定义的变量 __func__（有关详细信息，请参见 函数定义）不是预处理器宏，即使它有时与 __FILE__ 和 __LINE__ 一起使用，例如由 assert 使用。

 (自 C99 起)

[编辑] 示例

运行此代码
#include <stdio.h>
 
// make function factory and use it
#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);               // note the lack of quotes
}

输出

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

[编辑] 缺陷报告

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

DR 应用于 已发布行为 正确行为
DR 321 C99 不清楚 L'x' == 'x' 是否始终成立
在基本字符集中		 为此目的添加了 __STDC_MB_MIGHT_NEQ_WC__

[编辑] 参考

  • C23 标准 (ISO/IEC 9899:2024)
  • 6.10.4 宏替换 (页码: 187-184)
  • 6.10.9 预定义宏名称 (页码: 186-188)
  • C17 标准 (ISO/IEC 9899:2018)
  • 6.10.3 宏替换 (页码: 121-126)
  • 6.10.8 预定义宏名称 (页码: 127-129)
  • C11 标准 (ISO/IEC 9899:2011)
  • 6.10.3 宏替换 (页码: 166-173)
  • 6.10.8 预定义宏名称 (页码: 175-176)
  • C99 标准 (ISO/IEC 9899:1999)
  • 6.10.3 宏替换 (页码: 151-158)
  • 6.10.8 预定义宏名称 (页码: 160-161)
  • C89/C90 标准 (ISO/IEC 9899:1990)
  • 3.8.3 宏替换
  • 3.8.8 预定义宏名称

[编辑] 参见

C++ 文档 关于 替换文本宏
检索自 "https://cppreference.cn/mwiki/index.php?title=c/preprocessor/replace&oldid=179946"