C/C++ 的宏和预编译器（笔记）

                     

贡献者： addis

1. 基础

• C++ 的宏功能几乎完全是从 C 语言直接沿用过来的。
• 宏是给预编译器的指令。预编译器本质上就是对代码中的宏指令进行文本替换操作。
• 行首如果有 # (前后都可以有空格) 的叫做预处理指令（preprocessor directive），是给预编译器看的。预编译器同样会无视注释。
• 最常见的 #include 头文件 指令就是让预编译器把头文件中的代码原封不动地插入到当前位置。
• 所以从编译器（不是预编译器）看来，每个 cpp 文件其实都是单个文件，无论它的 include 有多复杂。
• #define 宏名 代码 把一个宏定义为一串别的代码。代码 如果要换行，可以用 \。
• 在使用预编译器之前还会有 translation phase，会把代码中所有 “\ 紧接一个换行符” 进行删除处理，哪怕它在字符串中间或者变量名中间（但这是很不推荐的）。况且许多地方换行并不需要什么特殊符号，所以这个功能一般用于把一个较长的宏写为多行。所以对预编译器来说，每个 preprocessor directive 仍然只能有一行（它看不到 \）。
• #define 宏名 仅仅定义一个宏，也可以理解为 代码 为空。
• 命名规范：宏名应该全部使用大写字母和下划线。不要用下划线开头（下划线开头的宏保留给编译器和基本的库去定义）。若要避免冲突，可以你定义的所有宏前面加上一个特殊的前缀。例如 前缀_宏名，如果你在写库，通常这个前缀是库的名字。
• #ifdef 宏 ... #else ... #endif 可以判断宏是否存在，类似地，有 #ifndef 宏。（注意每一个 # 都要换行。
• 更一般地，有 #if 条件 ... #elif ... #else ... #endif。例如条件可以是 #if defined(宏) 相当于 #ifdef，#if !defined(宏) 相当于 #ifndef。预编译器会删除不满足条件的 ... 中的代码，编译器将看不到它的存在。
• 取决于代码风格，可以选择把 #if ... #elif ... #endif 之间的其他宏全部缩进，如果不缩进也可以用注释表明对应关系。
• defined() 函数是一个特殊的存在，没有其他类似的函数了（除了下文的宏函数）。
• 条件中可以用 &&，||，可以用括号，可以用 >, <=, ==, != 等比较数值的大小，可以用 +,-,*,/,% 等算符。注意运算和比较仅限于整数。
• 不可以在 # 中使用 constexpr，如 #if sizeof(Int) == 4
• 用 g++ -E 源文件.cpp 可以输出预编译的结果（将把所有宏都进行替换）。
• #undef 宏 可以在之后的代码中取消某个宏的定义，否则该宏将在定义后的所有位置有定义，而且会覆盖函数名和变量名。所以使用宏时要特别小心，一般会严格遵循特定的命名规则以防止和其他变量或宏发生冲突。
• #error 错误 信息 可以让预编译器产生错误停止编译
• #warning 警告 信息 可以让预编译器产生警告
• 一个宏在一个 cpp 文件（包括它使用的头文件）中不能有多次定义。另外如果需要找一个宏定义的位置，可以故意多次定义，然后编辑器的错误提示中就会包含它之前定义的位置。
• translation phase 也会把每个注释替换成一个空格，所以 int/*评论*/x; 相当于 int x;。

2. C++ 标准中常用的宏

• __cplusplus 用于判断是否在使用 C++（而不是 C），以及判断使用的 C++ 标准，例如 #if __cplusplus >= 201103L（L 表示这是一个 long 的 literal）
• __FILE__ 会替换为当前的文件名（一个字符串 literal）。
• __LINE__ 会替换为当前的行号（一个 int 的 literal）。
• __DATE__ "Mmm dd yyyy" (e.g., "Apr 18 2023")
• __TIME__ "hh:mm:ss"
• __func__ 是当前函数名，但这并不是一个宏，而是每个函数都会在开始默认定义的一个 const char[]，存有当前函数名。

3. 宏函数

• FUN(参数) #参数 在参数两边加双引号。
• 若宏函数的参数不是宏，那么它就被作为字符串替换到宏函数中。记住预编译器不懂 C++ 语法，不知道什么是变量。
• 如果宏函数的参数也是宏，那么会先对参数的宏进行展开（但未必会完全展开)，然后再代入宏函数的函数体中。
• 多加一层 trivial 的宏函数有助于让作为参数的宏先完全展开：例如 #define FOO(x) BAR(x)，#define BAR(x) #x。那么 BAR(1+1) 就是 "1+1"，但是 FOO(1+1) 就是 "2"。
• #宏 只能用于宏参数前面，用于其他宏名，更不能直接在宏定义外面用。一个常用的宏函数是 #define STRINGIFY(x) #x

  #include <iostream>
  
  using namespace std;
  
  #define ITEM wi383uk33 "abcde
  
  #define STRINGIFY(x) #x
  #define STRINGIFY2(x) STRINGIFY(x)
  
  int main()
  {
  	cout << STRINGIFY(ITEM) << endl; // "ITEM"
  	cout << STRINGIFY2(ITEM) << endl; // R"(ITEM wi383uk33 "abcde)"
  }
  

• ## 可以用于拼接代码（两边可以有或没有空格）例如 #define MY_VAR(x) ab ## x ## cde。调用 MY_VAR(2) 展开为 ab2cde。
• 宏函数可作为另一个宏函数的参数，例如

  #define OP_FUNCTIONS(XX) \
  XX(my_func1) \
  XX(my_func2) \
  XX(my_func3) \
  
  #define XX(name) void *name();
  OP_FUNCTIONS(XX)
  #undef XX
  
  void print_funcs()
  {
  #define XX(name) printf(#name "\n");
  OP_FUNCTIONS(XX)
  #undef XX
  }
  
  void call_funcs()
  {
  #define XX(name) name();
  OP_FUNCTIONS(XX)
  #undef XX
  }
  

  会展开为

  void *my_func1();
  void *my_func2();
  void *my_func3();
  
  void print_funcs()
  {
  printf("my_func1\n");
  printf("my_func2\n");
  printf("my_func3\n");
  }
  
  void call_funcs()
  {
  my_func1();
  my_func2();
  my_func3();
  }
  

• 宏函数不能在代码中不加括号使用