03 预处理阶段能做什么：宏定义和条件编译
你好，我是Chrono。
上一次我讲了在编码阶段要有好的code style，尽量写出“人能够看懂的代码”。今天，我就继续讲讲编码后的预处理阶段，看看这个阶段我们能做哪些事情。
预处理编程
其实，只要写C/C++程序，就会用到预处理，只是大多数时候，你只用到了它的一点点功能。比如，在文件开头写上“#include ”这样的语句，或者用“#define”定义一些常数。只是这些功能都太简单了，没有真正发挥出预处理器的本领，所以你可能几乎感觉不到它的存在。
预处理只能用很少的几个指令，也没有特别严谨的“语法”，但它仍然是一套完整自洽的语言体系，使用预处理也能够实现复杂的编程，解决一些特别的问题——虽然代码可能会显得有些“丑陋”“怪异”。
那么，“预处理编程”到底能干什么呢？
你一定要记住：预处理阶段编程的操作目标是“源码”，用各种指令控制预处理器，把源码改造成另一种形式，就像是捏橡皮泥一样。
把上面的这句话多读几遍，仔细揣摩体会一下，理解了之后，你再去用那些预处理指令就会有不一样的感觉了。
C++语言有近百个关键字，预处理指令只有十来个，实在是少得可怜。而且，常用的也就是#include、#define、#if，所以很容易掌握。不过，有几个小点我还是要特别说一下。
首先，预处理指令都以符号“#”开头，这个你应该很熟悉了。但同时你也应该意识到，虽然都在一个源文件里，但它不属于C++语言，它走的是预处理器，不受C++语法规则的约束。
所以，预处理编程也就不用太遵守C++代码的风格。一般来说，预处理指令不应该受C++代码缩进层次的影响，不管是在函数、类里，还是在if、for等语句里，永远是顶格写。
另外，单独的一个“#”也是一个预处理指令，叫“空指令”，可以当作特别的预处理空行。而“#”与后面的指令之间也可以有空格，从而实现缩进，方便排版。
下面是一个示例，#号都在行首，而且if里面的define有缩进，看起来还是比较清楚的。以后你在写预处理代码的时候，可以参考这个格式。
# // 预处理空行
#if __linux__ // 预处理检查宏是否存在
# define HAS_LINUX 1 // 宏定义，有缩进
#endif // 预处理条件语句结束
# // 预处理空行
预处理程序也有它的特殊性，暂时没有办法调试，不过可以让GCC使用“-E”选项，略过后面的编译链接，只输出预处理后的源码，比如：
多使用这种方式，对比一下源码前后的变化，你就可以更好地理解预处理的工作过程了。
这几个小点有些杂，不过你只要记住“#开头、顶格写”就行了。
包含文件（#include）
先来说说最常用的预处理指令“#include”，它的作用是“包含文件”。注意，不是“包含头文件”，而是可以包含任意的文件。
也就是说，只要你愿意，使用“#include”可以把源码、普通文本，甚至是图片、音频、视频都引进来。当然，出现无法处理的错误就是另外一回事了。
可以看到，“#include”其实是非常“弱”的，不做什么检查，就是“死脑筋”把数据合并进源文件。
所以，在写头文件的时候，为了防止代码被重复包含，通常要加上“Include Guard”，也就是用“#ifndef/#define/#endif”来保护整个头文件，像下面这样：
这个手法虽然比较“原始”，但在目前来说（C++11/14），是唯一有效的方法，而且也向下兼容C语言。所以，我建议你在所有头文件里强制使用。
除了最常用的包含头文件，你还可以利用“#include”的特点玩些“小花样”，编写一些代码片段，存进“*.inc”文件里，然后有选择地加载，用得好的话，可以实现“源码级别的抽象”。
比如说，有一个用于数值计算的大数组，里面有成百上千个数，放在文件里占了很多地方，特别“碍眼”：
static uint32_t calc_table[] = { // 非常大的一个数组，有几十行
0x00000000, 0x77073096, 0xee0e612c, 0x990951ba,
0x076dc419, 0x706af48f, 0xe963a535, 0x9e6495a3,
0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91,
...
};
这个时候，你就可以把它单独摘出来，另存为一个“*.inc”文件，然后再用“#include”替换原来的大批数字。这样就节省了大量的空间，让代码更加整洁。
宏定义（#define/#undef）
接下来要说的是预处理编程里最重要、最核心的指令“#define”，它用来定义一个源码级别的“文本替换”，也就是我们常说的“宏定义”。
“#define”可谓“无所不能”，在预处理阶段可以无视C++语法限制，替换任何文字，定义常量/变量，实现函数功能，为类型起别名（typedef），减少重复代码……
不过，也正是因为它太灵活，如果过于随意地去使用宏来写程序，就有可能把正常的C++代码搞得“千疮百孔”，替换来替换去，都不知道真正有效的代码是什么样子了。
所以，使用宏的时候一定要谨慎，时刻记着以简化代码、清晰易懂为目标，不要“滥用”，避免导致源码混乱不堪，降低可读性。
下面，我就说几个注意事项，帮你用好宏定义。
首先，因为宏的展开、替换发生在预处理阶段，不涉及函数调用、参数传递、指针寻址，没有任何运行期的效率损失，所以对于一些调用频繁的小代码片段来说，用宏来封装的效果比inline关键字要更好，因为它真的是源码级别的无条件内联。
下面有几个示例，摘自Nginx，你可以作为参考：
#define ngx_tolower(c) ((c >= 'A' && c <= 'Z') ? (c | 0x20) : c)
#define ngx_toupper(c) ((c >= 'a' && c <= 'z') ? (c & ~0x20) : c)
#define ngx_memzero(buf, n) (void) memset(buf, 0, n)
其次，你要知道，宏是没有作用域概念的，永远是全局生效。所以，对于一些用来简化代码、起临时作用的宏，最好是用完后尽快用“#undef”取消定义，避免冲突的风险。像下面这样：
#define CUBE(a) (a) * (a) * (a) // 定义一个简单的求立方的宏
cout << CUBE(10) << endl; // 使用宏简化代码
cout << CUBE(15) << endl; // 使用宏简化代码
#undef CUBE // 使用完毕后立即取消定义
另一种做法是宏定义前先检查，如果之前有定义就先undef，然后再重新定义：
#ifdef AUTH_PWD // 检查是否已经有宏定义
# undef AUTH_PWD // 取消宏定义
#endif // 宏定义检查结束
#define AUTH_PWD "xxx" // 重新宏定义
再次，你可以适当使用宏来定义代码中的常量，消除“魔术数字”“魔术字符串”（magic number）。
虽然不少人认为，定义常量更应该使用enum或者const，但我觉得宏定义毕竟用法简单，也是源码级的真正常量，而且还是从C继承下来的传统，用在头文件里还是有些优势的。
这种用法非常普遍，你可能也经常用，我就简单举两个例子吧：
不过你要注意，关键是要“适当”，自己把握好分寸，不要把宏弄得“满天飞”。
除了上面说的三个，如果你开动脑筋，用好“文本替换”的功能，也能发掘出许多新颖的用法。我有一个比较实际的例子，用宏来代替直接定义名字空间（namespace）：
#define BEGIN_NAMESPACE(x) namespace x {
#define END_NAMESPACE(x) }
BEGIN_NAMESPACE(my_own)
... // functions and classes
END_NAMESPACE(my_own)
这里我定义了两个宏：BEGIN_NAMESPACE和END_NAMESPACE，虽然只是简单的文本替换，但它全大写的形式非常醒目，可以很容易地识别出名字空间开始和结束的位置。
条件编译（#if/#else/#endif）
利用“#define”定义出的各种宏，我们还可以在预处理阶段实现分支处理，通过判断宏的数值来产生不同的源码，改变源文件的形态，这就是“条件编译”。
条件编译有两个要点，一个是条件指令“#if”，另一个是后面的“判断依据”，也就是定义好的各种宏，而这个“判断依据”是条件编译里最关键的部分。
通常编译环境都会有一些预定义宏，比如CPU支持的特殊指令集、操作系统/编译器/程序库的版本、语言特性等，使用它们就可以早于运行阶段，提前在预处理阶段做出各种优化，产生出最适合当前系统的源码。
你必须知道的一个宏是“__cplusplus”，它标记了C++语言的版本号，使用它能够判断当前是C还是C++，是C++98还是C++11。你可以看下面这个例子。
#ifdef __cplusplus // 定义了这个宏就是在用C++编译
extern "C" { // 函数按照C的方式去处理
#endif
void a_c_function(int a);
#ifdef __cplusplus // 检查是否是C++编译
} // extern "C" 结束
#endif
#if __cplusplus >= 201402 // 检查C++标准的版本号
cout << "c++14 or later" << endl; // 201402就是C++14
#elif __cplusplus >= 201103 // 检查C++标准的版本号
cout << "c++11 or before" << endl; // 201103是C++11
#else // __cplusplus < 201103 // 199711是C++98
# error "c++ is too old" // 太低则预处理报错
#endif // __cplusplus >= 201402 // 预处理语句结束
除了“__cplusplus”，C++里还有很多其他预定义的宏，像源文件信息的“FILE”“ LINE”“ DATE”，以及一些语言特性测试宏，比如“__cpp_decltype” “__cpp_decltype_auto” “__cpp_lib_make_unique”等。
不过，与优化更密切相关的底层系统信息在C++语言标准里没有定义，但编译器通常都会提供，比如GCC可以使用一条简单的命令查看：
g++ -E -dM - < /dev/null
#define __GNUC__ 5
#define __unix__ 1
#define __x86_64__ 1
#define __UINT64_MAX__ 0xffffffffffffffffUL
...
基于它们，你就可以更精细地根据具体的语言、编译器、系统特性来改变源码，有，就用新特性；没有，就采用变通实现：
#if defined(__cpp_decltype_auto) //检查是否支持decltype(auto)
cout << "decltype(auto) enable" << endl;
#else
cout << "decltype(auto) disable" << endl;
#endif //__cpp_decltype_auto
#if __GNUC__ <= 4
cout << "gcc is too old" << endl;
#else // __GNUC__ > 4
cout << "gcc is good enough" << endl;
#endif // __GNUC__ <= 4
#if defined(__SSE4_2__) && defined(__x86_64)
cout << "we can do more optimization" << endl;
#endif // defined(__SSE4_2__) && defined(__x86_64)
除了这些内置宏，你也可以用其他手段自己定义更多的宏来实现条件编译。比如，Nginx就使用Shell脚本检测外部环境，生成一个包含若干宏的源码配置文件，再条件编译包含不同的头文件，实现操作系统定制化：
#if (NGX_FREEBSD)
# include <ngx_freebsd.h>
#elif (NGX_LINUX)
# include <ngx_linux.h>
#elif (NGX_SOLARIS)
# include <ngx_solaris.h>
#elif (NGX_DARWIN)
# include <ngx_darwin.h>
#endif
条件编译还有一个特殊的用法，那就是，使用“#if 1”“#if 0”来显式启用或者禁用大段代码，要比“/* … */”的注释方式安全得多，也清楚得多，这也是我的一个“不传之秘”。
#if 0 // 0即禁用下面的代码，1则是启用
... // 任意的代码
#endif // 预处理结束
#if 1 // 1启用代码，用来强调下面代码的必要性
... // 任意的代码
#endif // 预处理结束
小结
今天我讲了预处理阶段，现在你是否对我们通常写的程序有了新的认识呢？它实际上是混合了预处理编程和C++编程的两种代码。
预处理编程由预处理器执行，使用#include、#define、#if等指令来实现文件包含、文本替换、条件编译，把编码阶段产生的源码改变为另外一种形式。适当使用的话，可以简化代码、优化性能，但如果是“炫技”式地过分使用，就会导致导致代码混乱，难以维护。
再简单小结一下今天的内容：
- 预处理不属于C++语言，过多的预处理语句会扰乱正常的代码，除非必要，应当少用慎用；
- “#include”可以包含任意文件，所以可以写一些小的代码片段，再引进程序里；
- 头文件应该加上“Include Guard”，防止重复包含；
- “#define”用于宏定义，非常灵活，但滥用文本替换可能会降低代码的可读性；
- “条件编译”其实就是预处理编程里的分支语句，可以改变源码的形态，针对系统生成最合适的代码。
课下作业
最后是课下作业时间，给你留两个思考题：
- 你认为宏的哪些用法可以用其他方式替代，哪些是不可替代的？
- 你用过条件编译吗？分析一下它的优点和缺点。
欢迎你在留言区写下你的思考和答案，如果觉得对你有所帮助，也欢迎分享给你的朋友，我们下节课见。
- sugar 👍（27） 💬（1）
老师，能否讲讲#include 各种头文件的细节，比如尖角和引号 在include时就是不同的。
2020-05-21 - 嵇斌 👍（20） 💬（1）
1. #define PI (3.14) -> constexpr float PI = 3.14 其他貌似不能完全对等。比如内链的代码块，可以用lambda，但是效率如何得看编译器的优化了。比如有些条件编译可以想办法用enable_if来替换实现。到了后面这些替换就不单单是语言方面的实践了，可能涉及软件工程、设计模式。 2. 条件编译自己用还好，自己一般都还清楚自己的套路。条件编译最头疼的就是对着代码定位问题，这个实现到底是哪个代码块呢？尤其是那种跨平台的和OS相关的适配层代码。再聪明的IDE和编译器也还是有点区别的。当然现在可能Clion和VS等都已经比较完善了...
2020-05-12 - 神经旷野舞者 👍（15） 💬（3）
老师 rust很安全，现在大公司很多项目都用rust改写了，cpp还需要学吗，是不是直接学rust呢
2020-05-15 - 怪兽 👍（12） 💬（1）
老师，我在看rapidjson源码时，看到如下代码，不知道有什么作用，为什么不直接使用assert？ #ifndef RAPIDJSON_ASSERT #define RAPIDJSON_ASSERT(x) assert(x) #endif // RAPIDJSON_ASSERT
2020-06-27 - Wynter 👍（7） 💬（3）
老师，我最近在阅读一个事件驱动框架代码libev，源码里就充斥着大量的宏，阅读起来很是费力。所以请教老师，阅读这种宏比较多的源码应该怎么办？
2020-05-12 - Tedeer 👍（6） 💬（2）
在读到这段话时：另存为一个“*.inc”文件，然后再用“#include”替换原来的大批数字。 想起以前开发过程中，曾经在头文件中定义了一个240*160的图片字节数组，现在看来有点蠢，又涨知识了。条件编译在Android系统源码见得比较多，区分不同平台之间代码块的实现。
2020-05-12 - Carlos 👍（6） 💬（5）
先回答老师的问题🤔 1. 就中间那个算立方体的例子来说, 我觉得这个用法可以替换成一个 inline function. 储存常数可以直接用 const, 为了简化可以用 reference 2. 说实话, 我没用过条件编译 😂, 今天头一次学到, 但是我觉得这肯定会让代码变得更加复杂, 冒出很多意料之外的 bugs. 再提两个自己的小问题: 1. 使用宏的条件编译是不是可以用 Cmake 来做呢? (虽然我几乎不会用 Cmake 但是我预感它有这个功能) 2. 上文里面的 extern "C" { 部分我有些没看懂, 这个是预处理语言吗? 希望老师帮助理解.
2020-05-12 - 企鹅君需要充电 👍（4） 💬（1）
1、#include基本不会被替代，但为了避免#define滥用，少用它设置全局变量，const/static/enum处理常量声明还能自带额外信息（例如作用域） 2、debug期间用条件编译方便，但有时候会忽略另一种情况的判断测试，而且写死忘了改回来就gg了
2021-02-23 - sugar 👍（4） 💬（1）
另一个有关include头文件的问题。比如说我看很多例子都是 在单独一个h文件和一个cpp文件中定义了一个类，h里写了类的声明，类的具体实现在cpp里面。其他cpp文件里想引入这个类的时候，就直接include了h文件，并没include cpp文件，按照咱们这一讲 只有声明被预处理时放到实际执行的cpp代码里了，类的实现cpp是怎么引入进来的呢？
2020-05-21 - 廖熊猫 👍（4） 💬（1）
我的一些使用经历： 1. 使用#ifdef __cplusplus这个在用Emscripten编译wasm的时候会跟extern "c" { } 这个一起使用，防止编译后名字被修改掉。 2. 在C语言里直接使用const定义的长度在全局定义数组会报错，但是可以用预处理器来创建。 3. 快速定义一些内容相似的struct还有相关的操作函数，不过在C++里面应该可以使用template来解决这个问题了吧
2020-05-12 - 风清扬 👍（3） 💬（2）
calc_table那个例子有问题，inc里应该是1，2，3，4，这种形式，如果在数组里#iinclude。 示例： header.inc 1,2,3,4, 5,6,7,8, 9,10,11,12, example.cpp #include <iostream> int main() { static uint32_t calc_table[] = { # include "header.inc" }; return 0; } 或者在inc里定义数组，cpp里直接包含
2020-12-16 - 张飞Dear 👍（3） 💬（1）
1，你认为宏的哪些用法可以用其他方式替代，哪些是不可替代的？ 定义一些单个文件使用的常量可以用 const替代。那种多个文件引用的可以使用宏来代替，还有用宏定义来处理一些小函数会比内联来的好用。 2，你用过条件编译吗？分析一下它的优点和缺点。 用过条件编译和有条件编译的库，使用条件编译可以在release 与debug 版本中 输出不同的信息。还有一些库 通过不同的 宏 来链接其中不同的代码，还有就是会生成不同的库。 缺点就是有时候会花里胡哨，只要用明白了就好。
2020-07-29 - EncodedStar 👍（3） 💬（2）
函数式的方法可以用 inline function， 内联inline类似于宏，使用inline时，代码在执行前，编译器先将调用的inline函数替换城那个函数的执行代码。 #if endif 这个是复只能制用宏来做百的 其他方式都不行另外，度编译命令行传问递变量值也只能通过宏来做。 之前写过嵌入式程序，条件编译见得比较多，程序在不同系统下都需要运行时就要条件编译，条件编译百为了提高程序的可移植性，增加程序的灵活性。还有老师提到的“不传之秘”#if 1 #end if也是条件编译，这个注释大段代码调试特别有用。
2020-05-18 - Soda 👍（3） 💬（1）
第一个问题，能想到的就是定义常量用const代替，因为编译器会替我们检查类型。 第二个问题，用过条件编译，很适合在开发嵌入式程序的时候，做一些跨平台的处理😁
2020-05-15 - jxon-H 👍（3） 💬（2）
这节课真是干货满满，我从来都不知道预处理阶段包含这么多知识，我还活在那个以为 # 就是只是和 include 搭配的世界。 预处理阶段内容是那么的充实丰满…… 我满篇文稿的划线标笔记，但是回个头认真思考，这些丰富的经验总结，岂是几根线就可以消化的吗？ 脑子已经处于滞涨状态了…… 我和C++的隔阂太深了……不仅像是深深的代沟，还貌似是有点难以逾越的鸿沟。 但愿我能爬出来！
2020-05-14