1 / 4概念
Feature: Preprocessor
预处理器在语法分析之前运行:它按行识别 # 指令,替换记号,拼接文本,然后把结果交给编译器。它不知道类型、作用域与表达式语义,所以宏的每个缺陷都要到运行期才暴露。
1 概念
1.1 一句话定义
C 预处理器是翻译的第一阶段:处理 #include、#define、条件编译等指令,把源文件变成记号序列,宏展开是记号级的文本替换而不是函数调用。
1.2 它解决什么问题
- 条件编译:同一份源码按平台、编译器与构建类型裁剪。
- 消除重复:字段列表、错误码表、指令表只写一份,展开成枚举、字符串表与解析代码。
- 头文件复用:声明通过文本包含共享,不需要模块系统。
- 编译期开关:调试日志、断言、实验特性用宏零成本开启或关闭。
- 编译期诊断:
#error与_Static_assert在构建阶段拦住错误配置。 - 跨平台适配:用预定义宏区分编译器与目标架构。
代价是宏没有类型、没有作用域、调试信息不友好,且展开结果依赖定义顺序。
1.3 不属于本页的内容
| 主题 | 去哪 |
|---|---|
| 宏作为切面手段的取舍 | AOP |
-I、-D、-E 与构建流程 | Toolchain |
| 类型、布局与转换 | Type |
| 链接与符号解析 | Runtime: Linking and Loading |
1.4 关键术语
| 术语 | 含义 | 容易混淆的点 |
|---|---|---|
| 翻译单元 | 预处理完成后的记号序列 | 不是源文件 |
| 对象式宏 | 不带参数的宏 | 与常量不同,没有类型 |
| 函数式宏 | 带参数的宏 | 不是函数,可能双求值 |
| 字符串化 | #x 把记号变成字符串 | 参数不会先展开 |
| 记号粘贴 | ## 把两个记号拼成一个 | 结果必须是合法记号 |
| 空指令 | 只有 # 的一行 | 不是注释 |
| X-macro | 用一份列表展开多次 | 不是语言特性 |
| 预定义宏 | __FILE__、__LINE__ 等 | __func__ 不是宏 |
2 机制
2.1 心智模型
预处理器只认记号,不认语义。 展开函数式宏时,实参先被展开(除非出现在 # 或 ## 旁边),然后替换到宏体,替换结果再与后续记号一起重新扫描。宏不会展开自身,这避免了无限递归,也意味着“间接递归”要靠额外一层宏名。
2.2 机制拆解
- 指令:以
#开头,前面可有空白;反斜杠续行;指令在行尾结束。 - 展开顺序:先展开实参,再替换宏体,最后重新扫描;
#与##的操作数不做预展开。 - 字符串化两层:
#define STR_(x) #x与#define STR(x) STR_(x);直接STR(MACRO)得到宏名本身,两层才得到展开后的值。 - 记号粘贴:
##生成一个新记号,必须是合法的预处理记号;粘贴出+-这类组合是未定义行为。 - include 搜索:引号形式先查当前文件目录,再查
-I,最后查系统目录;尖括号形式跳过当前目录。 - 条件编译:
#if的表达式只允许整数常量、defined与宏;未定义的标识符按 0 处理,拼写错误不会报错。 - 头文件卫生:用 guard 或
#pragma once防止重复包含;头文件应自包含,不依赖调用方的包含顺序。 - 预定义宏:
__FILE__、__LINE__、__DATE__、__TIME__、__STDC__、__STDC_VERSION__;__func__是预定义标识符,不是宏。
2.3 完整枚举
C23 的预处理指令,这是完整集合:
| 指令 | 作用 | 备注 |
|---|---|---|
#define | 定义对象式或函数式宏 | 可带变参 ... |
#undef | 取消宏定义 | 常与条件编译配对 |
#include | 文本包含 | 引号与尖括号搜索顺序不同 |
#if | 条件编译 | 表达式为整数常量 |
#ifdef | 宏已定义时编译 | 等价于 defined |
#ifndef | 宏未定义时编译 | 常用于 include guard |
#elif | 条件链的下一支 | 可重复 |
#else | 条件链的兜底 | 每个 #if 至多一个 |
#endif | 结束条件块 | 与最近的 #if 配对 |
#line | 改写行号与文件名 | 供生成代码使用 |
#error | 主动报错并停止 | 用于不支持的平台 |
#pragma | 实现定义的行为 | #pragma once 最常见 |
# | 空指令 | 不产生任何效果 |
#elifdef | C23 的 #elif defined | 减少重复 |
#elifndef | C23 的 #elif !defined | 减少重复 |
#embed | C23 把文件内容变成初始化器 | 替代手写字节数组 |
#warning | C23 发出警告并继续 | 不终止编译 |
3 实践
3.1 最小示例与追踪
示例用 X-macro 让颜色表只写一份,同时生成枚举与名字数组。
#define COLOR_LIST(X) \
X(RED, 0xff0000) \
X(GREEN, 0x00ff00) \
X(BLUE, 0x0000ff)
#define AS_ENUM(name, value) COLOR_##name,
enum color { COLOR_LIST(AS_ENUM) COLOR_COUNT };
#define AS_NAME(name, value) [COLOR_##name] = #name,
static const char *const color_name[COLOR_COUNT] = { COLOR_LIST(AS_NAME) };
#define STR_(x) #x
#define STR(x) STR_(x)
#define CAT_(a, b) a##b
#define CAT(a, b) CAT_(a, b)
追踪:COLOR_LIST(AS_ENUM) 把三行分别替换成 COLOR_RED,、COLOR_GREEN,、COLOR_BLUE,,所以 enum color 的值是 0、1、2、3(COLOR_COUNT)。COLOR_LIST(AS_NAME) 生成三个指定初始化器,下标由枚举值决定;中间插入新颜色时,数组会自动跟着枚举走,不会错位。STR(CAT(RED, _STOP)) 先展开 CAT 得到 RED_STOP,再字符串化,结果是 "RED_STOP";若直接写 STR_(CAT(RED, _STOP)),因为参数在 # 旁边不展开,得到的是 "CAT(RED, _STOP)"。CAT(+, -) 试图粘贴出 +-,不是合法记号,属于未定义行为。
3.2 选型矩阵
| 需求 | 方案 | 优势 | 代价 |
|---|---|---|---|
| 常量 | enum 或 static const | 有类型、可调试 | 不能用于 #if |
| 小函数 | static inline | 单次求值、类型检查 | 需要 C99 |
| 重复代码生成 | 函数式宏或 X-macro | 零运行时、可生成声明 | 难调试、易污染 |
| 头文件防重 | include guard | 可移植 | 名字要唯一 |
| 头文件防重 | #pragma once | 简洁 | 依赖文件路径识别 |
| 编译期开关 | #if | 不生成代码 | 组合爆炸 |
| 运行期开关 | if | 可测试 | 有分支成本 |
3.3 决策规则
- 能用
static inline就不用函数式宏;宏只用于需要记号、字符串或声明的地方。 - 宏参数在宏体里每次出现都加括号,整个宏体也加括号;
do { ... } while (0)包多条语句。 - 需要字符串化展开结果时用两层宏;需要粘贴时确认结果是合法记号。
- 头文件只放声明、类型与
static inline;不要放会生成外部符号的定义。 #if里只写配置宏;拼写错误按 0 处理,必要时加#error兜底。
4 边界
4.1 典型故障
| 症状 | 根因 | 诊断 | 修复 |
|---|---|---|---|
| 计数器多加一次 | 宏参数被求值两次 | cc -E 看展开结果 | 改 static inline 或先存变量 |
SQUARE(a + b) 结果偏小 | 宏体缺括号 | 手算展开后的优先级 | ((x) * (x)) |
| 宏展开后语法错误 | 宏体带了分号或多条语句 | 看报错指向调用行 | 用 do { } while (0) |
#if 分支永远不生效 | 宏名拼错,未定义按 0 | cc -dM -E 查定义 | 加 #error 或拼写检查 |
| 粘贴后编译报错 | ## 生成了非法记号 | 预处理输出里定位 | 拆成两层或改用枚举 |
| 宏名与变量冲突 | 宏无作用域 | -Wmacro-redefined | 加项目前缀,减少全局宏 |
| 头文件单独编译失败 | 头文件不自包含 | 单独编译一个只包含它的 .c | 补齐依赖包含 |
| 构建结果不可复现 | __DATE__、__TIME__、__FILE__ 绝对路径 | 对比两次构建产物 | 禁用或改用固定值 |
4.2 安全 / 性能 / 一致性边界
- 安全边界:宏展开可能把未加括号的表达式带进危险位置;
assert在NDEBUG下消失,不能把副作用写进断言。 - 可调试边界:宏没有栈帧,调试器只能看到展开后的行;错误信息指向调用点而非宏定义。
- 一致性边界:宏定义顺序影响结果;同一名字在不同头文件里定义不同值时,行为随包含顺序变化。
- 构建边界:
__DATE__、__TIME__与绝对路径破坏可复现构建;构建流程的细节归 Toolchain 页。