引用另一模板的宏_C/C++ 宏编程的艺术

1c6951582bd653cd2c42229c873e3424.png
原文:《C/C++ 宏编程的艺术》,公众号 BOTManJL~

904bbe96d28761c00e1019b17a50823b.png
可以言传者,物之粗也;可以意致者,物之精也。——《庄子·秋水》

写在前面

之前写过几篇关于 C/C++ (macro) 和 C++ 元编程 (metaprogramming) 的文章:
  • 令人头疼的 宏定义 污染 列举了两个 宏相关的 ,并从 绕开污染源/阻止污染扩散/缩小污染范围 的角度 尝试解决
  • 浅谈 C++ 元编程 介绍了 模板元编程 的相关问题
  • 简单的 C++ 结构体字段 反射 利用模板元编程(和极少的宏),实现 非侵入式、声明式、零开销 结构体 静态反射

C++ 模板元编程 (template metaprogramming) 虽然功能强大,但也有 局限性

  • 不能通过 模板展开 生成新的 标识符 (identifier)
  • 例如 生成新的 函数名、类名、名字空间名 等
  • 使用者 只能使用 预先定义的标识符
  • 不能通过 模板参数 获取 符号/标记 (token)字面量 (literal)
  • 例如 在反射中获取 实参参数名的字面量,在断言中获取 表达式的字面量
  • 使用者 只能通过 传递字符串参数 绕开

所以,在需要直接 操作标识符 的情况下,还需要借助 ,进行 预处理阶段的元编程

  • 编译时 (compile-time)模板 展开不同, 在编译前的 预处理(preprocess) 阶段全部展开 —— 狭义上,编译器 看不到且不处理 宏代码
  • 通过 #define/TOKEN1##TOKEN2/#TOKEN 定义 宏对象 (object-like macro)宏函数 (function-like macro),可以实现 替换文本、拼接标识符、获取字面量 等功能

最近,需要在单元测试中 自动生成调用 gmock 的代码:

  • 由于不便引入其他工具链,不能使用 代码生成器 (code generator)
  • 生成的代码 需要调用 gmock 的宏函数,也不能使用 C++ 模板元编程
  • 所以,只能借助 宏编程 的魔法

本文使用的代码 链接(在线演示)

d2969e39c58d096fcd0442c29159c69f.png

如何调试

介绍宏编程之前,先聊聊调试的问题。

很多人因为 “宏编程” 无法调试,而直接 “从入门到放弃” —— 不经意的 符号拼写错误参数个数错误,导致文本 不能正确替换,从而带来 满屏的编译错误,最后 难以定位 问题所在 ——

  • 最坏的情况下,编译器 只会告诉你 cpp 文件 编译时出现 语法错误
  • 最好的情况下,编译器 可能告诉你 XXX 宏 展开结果里包含 语法错误
  • 而永远 不会告诉你 是因为 XXX 宏展开成什么样,导致 YYY 宏展开失败
  • 最后 只能看到 ZZZ 宏展开错误

由于宏代码会 在编译前全部展开,我们可以:

  • 让编译器 仅输出预处理结果
  • gcc -E 让编译器 在预处理结束后停止,不进行 编译、链接
  • gcc -P 屏蔽编译器 输出预处理结果的 行标记 (linemarker),减少干扰
  • 另外,由于输出结果没有格式化,建议先传给 clang-format 格式化后再输出
  • 屏蔽 无关的 头文件
  • 临时删掉 不影响宏展开的 #include
  • 避免多余的 引用展开,导致实际关注的宏代码 “被淹没”

于是,展开错误一目了然(很容易发现 _REMOVE_PARENS_IMPL 的展开错误):

7e36e6f5e115dc890c3b4792bf29e37c.png

特殊符号

和模板元编程不一样,宏编程 没有类型 的概念,输入和输出都是 符号 —— 不涉及编译时的 C++ 语法,只进行编译前的 文本替换

  • 一个 宏参数 是一个任意的 符号序列 (token sequence),不同宏参数之间 用逗号分隔
  • 每个参数可以是 空序列,且空白字符会被忽略(例如 a + 1a+1 相同)
  • 在一个参数内,不能出现 逗号 (comma) 或 不配对的 括号 (parenthesis)(例如 FOO(bool, std::pair<int, int>) 被认为是 FOO() 有三个参数:bool / std::pair<int / int>

如果需要把 std::pair<int, int> 作为一个参数,一种方法是使用 C++ 的 类型别名 (type alias)(例如 using IntPair = std::pair<int, int>;),避免 参数中出现逗号(即 FOO(bool, IntPair) 只有两个参数)。

更通用的方法是使用 括号对 封装每个参数(下文称为 元组),并在最终展开时 移除括号(元组解包)即可:

#define PP_REMOVE_PARENS(T) PP_REMOVE_PARENS_IMPL T
#define PP_REMOVE_PARENS_IMPL(...) __VA_ARGS__

#define FOO(A, B) int foo(A x, B y)
#define BAR(A, B) FOO(PP_REMOVE_PARENS(A), PP_REMOVE_PARENS(B))

FOO(bool, IntPair)                  // -> int foo(bool x, IntPair y)
BAR((bool), (std::pair<int, int>))  // -> int foo(bool x, std::pair<int, int> y)
  • PP_REMOVE_PARENS(T) 展开为 PP_REMOVE_PARENS_IMPL T 的形式
  • 如果参数 T 是一个 括号对,那么展开结果会变成 调用宏函数 PP_REMOVE_PARENS_IMPL (...) 的形式
  • 接着,PP_REMOVE_PARENS_IMPL(...) 再展开为参数本身 __VA_ARGS__(下文提到的 变长参数),即元组 T 的内容

另外,常用宏函数 代替 特殊符号,用于下文提到的 惰性求值

#define PP_COMMA() ,
#define PP_LPAREN() (
#define PP_RPAREN() )
#define PP_EMPTY()

符号拼接

在宏编程中,拼接标识符 (identifier concatenation / token pasting) 通过 ## 将宏函数的参数 拼接成其他符号,再进一步 展开为目标结果,是宏编程的 实现基础

然而,如果一个 宏参数 用于 拼接标识符(或 获取字面量),那么它不会被展开(例如 BAR() 在拼接前不会展开为 bar):

#define FOO(SYMBOL) foo_ ## SYMBOL
#define BAR() bar

FOO(bar)    // -> foo_bar
FOO(BAR())  // -> foo_BAR()

一种通用的方法是 延迟拼接操作(或 延迟 获取字面量 操作):

#define PP_CONCAT(A, B) PP_CONCAT_IMPL(A, B)
#define PP_CONCAT_IMPL(A, B) A##B

#define FOO(N) PP_CONCAT(foo_, N)

FOO(bar)    // -> foo_bar
FOO(BAR())  // -> foo_bar
  • 在进入宏函数前,所有 宏参数 会先进行一次 预扫描 (prescan),完全展开 未用于 拼接标识符 或 获取字面量 的所有参数
  • 在宏函数展开时,用(预扫描展开后的)参数替换 展开目标里的 同名符号
  • 在宏函数展开后,替换后的文本会进行 二次扫描 (scan twice),继续展开 结果里出现的宏
  • 所以,PP_CONCAT() 先展开参数,再传递给 PP_CONCAT_IMPL() 进行 实际拼接
延伸阅读: 使用 C++ 宏嵌套实现窄字符转换为宽字符by bingoli提到了Win32 的 TEXT() 宏的原理。

另外,在 预扫描前后,宏函数都要求 参数个数必须匹配,否则无法展开:

PP_CONCAT(x PP_COMMA() y)  // too few arguments (before prescan)
PP_CONCAT(x, PP_COMMA())   // too many arguments (after prescan)
  • 预扫描前,x PP_COMMA() y 是一个参数
  • 预扫描后,x, PP_COMMA() 是三个参数

自增自减

借助 PP_CONCAT(),我们可以实现 非负整数增减(即 INC(N) = N + 1 / DEC(N) = N - 1):

#define PP_INC(N) PP_CONCAT(PP_INC_, N)
#define PP_INC_0 1
#define PP_INC_1 2
// ...
#define PP_INC_254 255
#define PP_INC_255 256

#define PP_DEC(N) PP_CONCAT(PP_DEC_, N)
#define PP_DEC_256 255
#define PP_DEC_255 254
// ...
#define PP_DEC_2 1
#define PP_DEC_1 0

PP_INC(1)    // -> 2
PP_DEC(2)    // -> 1
PP_INC(256)  // -> PP_INC_256 (overflow)
PP_DEC(0)    // -> PP_DEC_0  (underflow)
  • PP_INC(N)/PP_DEC(N) 先展开为 PP_INC_N/PP_DEC_N,再经过 二次扫描 展开为对应数值 N + 1/N - 1 的符号
  • 但上述操作有上限,若超出则无法继续展开(例如BOOST_PP 数值操作的上限是 256)

逻辑运算

借助 PP_CONCAT(),我们可以实现 布尔类型01)的 逻辑运算(与/或/非/异或/同或):

#define PP_NOT(N) PP_CONCAT(PP_NOT_, N)
#define PP_NOT_0 1
#define PP_NOT_1 0

#define PP_AND(A, B) PP_CONCAT(PP_AND_, PP_CONCAT(A, B))
#define PP_AND_00 0
#define PP_AND_01 0
#define PP_AND_10 0
#define PP_AND_11 1

PP_AND(PP_NOT(0), 1)  // -> 1
PP_AND(PP_NOT(2), 0)  // -> PP_AND_PP_NOT_20
  • 原理和 PP_INC()/PP_DEC() 类似(符号拼接 + 二次展开)
  • 但上述操作不支持 非负整数 的通用逻辑运算(仅支持 01
  • 如果通过定义 PP_NOT_2 来支持 PP_NOT(2),宏代码会急剧膨胀
  • 一元运算 PP_NOT() 需要考虑 $N$ 种组合
  • 二元运算 PP_AND() 则要考虑 $N^2$ 种组合

布尔转换

为了支持更通用的 非负整数 的逻辑运算,可以先 将整数 转换成 布尔类型,而不是扩展 布尔类型 的逻辑运算:

#define PP_BOOL(N) PP_CONCAT(PP_BOOL_, N)
#define PP_BOOL_0 0
#define PP_BOOL_1 1
#define PP_BOOL_2 1
// ...

PP_AND(PP_NOT(PP_BOOL(2)), PP_BOOL(0))  // -> 0
PP_NOT(PP_BOOL(1000))                   // -> PP_NOT_PP_BOOL_1000
  • 原理和 PP_INC()/PP_DEC() 类似(符号拼接 + 二次展开)
  • 同理,上述操作也有上限,若超出则无法继续展开

条件选择

借助 PP_CONCAT()PP_BOOL(),我们可以实现通用的 条件选择 表达式(PRED ? THEN : ELSE,其中 PRED 可以是 任意非负整数):

#define PP_IF(PRED, THEN, ELSE) PP_CONCAT(PP_IF_, PP_BOOL(PRED))(THEN, ELSE)
#define PP_IF_1(THEN, ELSE) THEN
#define PP_IF_0(THEN, ELSE) ELSE

#define DEC_SAFE(N) PP_IF(N, PP_DEC(N), 0)

DEC_SAFE(2)  // -> 1
DEC_SAFE(1)  // -> 0
DEC_SAFE(0)  // -> 0
  • PP_IF() 先会根据转换后的条件 PP_BOOL(PRED) 选择 PP_IF_1PP_IF_0 符号
  • PP_IF_1()/PP_IF_0() 接受相同的参数,但分别展开为 THENELSE 参数

惰性求值

需要注意 PP_IF() 的参数会在 预扫描 阶段被完全展开(例如 PP_COMMA() 会被立即展开为逗号,导致参数个数错误):

#define PP_COMMA_IF(N) PP_IF(N, PP_COMMA(), PP_EMPTY())

PP_COMMA_IF(1)  // -> PP_IF(1, , , ) (too many arguments after prescan)

常用的技巧是 惰性求值 (lazy evaluation),即 条件选择先 返回宏函数,再传递参数 延迟调用

#define PP_COMMA_IF(N) PP_IF(N, PP_COMMA, PP_EMPTY)()

PP_COMMA_IF(0)  // (empty)
PP_COMMA_IF(1)  // -> ,
PP_COMMA_IF(2)  // -> ,

#define SURROUND(N) PP_IF(N, PP_LPAREN, [ PP_EMPTY)() 
                    N                                 
                    PP_IF(N, PP_RPAREN, ] PP_EMPTY)()

SURROUND(0)  // -> [0]
SURROUND(1)  // -> (1)
SURROUND(2)  // -> (2)
  • PP_COMMA_IF() 先借助 PP_IF() 返回 PP_COMMAPP_EMPTY 符号
  • PP_COMMA/PP_EMPTY 和后边的括号对 组成 PP_COMMA()/PP_EMPTY(),再继续展开为 逗号
  • 如果需要展开为 其他符号 SYMBOL,可以使用 SYMBOL PP_EMPTY 作为参数,和后边的括号对 组成 PP_EMPTY()(例如 SURROUND() 使用的 []

变长参数

从 C++ 11 开始,宏函数支持了 变长参数 ...,接受任意个 宏参数(用逗号分隔):

  • 传入的变长参数可以用 __VA_ARGS__ 获取(也可以通过 #__VA_ARGS__ 获取 逗号+空格分隔 的参数字面量)
  • 另外,允许传递 空参数,即 __VA_ARGS__ 替换为空

对于空参数,展开时需要处理 多余逗号 的问题:

#define log(format, ...) printf("LOG: " format, __VA_ARGS__)

log("%d%f", 1, .2);    // -> printf("LOG: %d%f", 1, .2);
log("hello world");    // -> printf("LOG: hello world", );
log("hello world", );  // -> printf("LOG: hello world", );
  • 后两种调用 分别对应 不传变长参数变长参数为空 的情况
  • 展开结果会 多出一个逗号,导致 C/C++ 编译错误(而不是 宏展开错误)

为了解决这个问题,一些编译器(例如 gcc/clang)扩展了 , ## __VA_ARGS__ 的用法 —— 如果 不传变长参数,则省略前面的逗号:

#define log(format, ...) printf("LOG: " format, ## __VA_ARGS__)

log("%d%f", 1, .2);    // -> printf("LOG: %d%f", 1, .2);
log("hello world");    // -> printf("LOG: hello world");
log("hello world", );  // -> printf("LOG: hello world", );

为了进一步处理 变长参数为空 的情况,C++ 20 引入了 __VA_OPT__ 标识符 —— 如果变长参数是空参数,不展开该符号(不仅限于逗号):

#define log(format, ...) printf("LOG: " format __VA_OPT__(,) __VA_ARGS__)

log("%d%f", 1, .2);    // -> printf("LOG: %d%f", 1, .2);
log("hello world");    // -> printf("LOG: hello world");
log("hello world", );  // -> printf("LOG: hello world");

下文将借助 长度判空遍历访问,实现 __VA_OPT__(,) 的功能。

下标访问

借助 PP_CONCAT(),我们可以通过 下标访问 变长参数的 特定元素

#define PP_GET_N(N, ...) PP_CONCAT(PP_GET_N_, N)(__VA_ARGS__)
#define PP_GET_N_0(_0, ...) _0
#define PP_GET_N_1(_0, _1, ...) _1
#define PP_GET_N_2(_0, _1, _2, ...) _2
// ...
#define PP_GET_N_8(_0, _1, _2, _3, _4, _5, _6, _7, _8, ...) _8

PP_GET_N(0, foo, bar)  // -> foo
PP_GET_N(1, foo, bar)  // -> bar
  • PP_GET_N() 的参数分为两部分:下标 N 和 变长参数 ...
  • 先通过 PP_CONCAT() 选择下标 I(从 0 开始)对应的 PP_GET_N_I 符号
  • PP_GET_N_I() 接受至少 I + 1 个参数(其余的参数是变长参数),并返回第 I + 1 个参数(其余的变长参数直接丢弃)

借助 PP_REMOVE_PARENS(),我们还可以通过 下标访问 元组 的特定元素:

#define PP_GET_TUPLE(N, T) PP_GET_N(N, PP_REMOVE_PARENS(T))

PP_GET_TUPLE(0, (foo, bar))  // -> foo
PP_GET_TUPLE(1, (foo, bar))  // -> bar

需要注意 变长参数的 长度必须大于 N,否则无法展开:

#define FOO(P, T) PP_IF(P, PP_GET_TUPLE(1, T), PP_GET_TUPLE(0, T))

FOO(0, (foo, bar))  // -> foo
FOO(1, (foo, bar))  // -> bar
FOO(0, (baz))       // -> PP_GET_N_1(baz) (too few arguments)
  • 对于 P == 0 的情况,FOO() 只返回 T 的第一个元素
  • 但是另一个分支里的 PP_GET_TUPLE(1, T) 仍会被展开,从而要求 T 有至少两个元素

类似的,我们可以借助 惰性求值 避免该问题:

#define FOO(P, T) PP_IF(P, PP_GET_N_1, PP_GET_N_0) T

FOO(0, (foo, bar))  // -> foo
FOO(1, (foo, bar))  // -> bar
FOO(0, (baz))       // -> baz
  • PP_IF() 先返回 PP_GET_N_1PP_GET_N_0 符号
  • 类似 PP_REMOVE_PARENS(),再用 PP_GET_N_I (...) 元组解包
  • 对于 P == 0 的情况,不会展开 PP_GET_N_1()

长度判空

借助 PP_GET_N(),我们可以检查 变长参数是否为空

#define PP_IS_EMPTY(...)                                      
  PP_AND(PP_AND(PP_NOT(PP_HAS_COMMA(__VA_ARGS__)),            
                PP_NOT(PP_HAS_COMMA(__VA_ARGS__()))),         
         PP_AND(PP_NOT(PP_HAS_COMMA(PP_COMMA_V __VA_ARGS__)), 
                PP_HAS_COMMA(PP_COMMA_V __VA_ARGS__())))
#define PP_HAS_COMMA(...) PP_GET_N_8(__VA_ARGS__, 1, 1, 1, 1, 1, 1, 1, 0, 0)
#define PP_COMMA_V(...) ,

PP_IS_EMPTY()          // -> 1
PP_IS_EMPTY(foo)       // -> 0
PP_IS_EMPTY(foo())     // -> 0
PP_IS_EMPTY(())        // -> 0
PP_IS_EMPTY(()foo)     // -> 0
PP_IS_EMPTY(PP_EMPTY)  // -> 0
PP_IS_EMPTY(PP_COMMA)  // -> 0
PP_IS_EMPTY(, )        // -> 0
PP_IS_EMPTY(foo, bar)  // -> 0
PP_IS_EMPTY(, , , )    // -> 0
  • 先定义两个辅助宏:
  • PP_HAS_COMMA() 用于检查变长参数里 有没有逗号(原理类似下文的 PP_NARG()
  • PP_COMMA_V() 用于 吃掉 (eat) 变长参数,并返回一个 逗号
  • 如果变长参数为空,需要满足以下条件:
  • PP_COMMA_V __VA_ARGS__() 展开为逗号,即构成 PP_COMMA_V() 的形式
  • __VA_ARGS____VA_ARGS__()PP_COMMA_V __VA_ARGS__ 展开结果里 没有逗号,排除对上一个条件的干扰

借助 PP_COMMA_IF()PP_IS_EMPTY(),我们可以实现 C++ 20 的 __VA_OPT__(,) 功能:

#define PP_VA_OPT_COMMA(...) PP_COMMA_IF(PP_NOT(PP_IS_EMPTY(__VA_ARGS__)))
#define log(format, ...) 
  printf("LOG: " format PP_VA_OPT_COMMA(__VA_ARGS__) __VA_ARGS__)

log("%d%f", 1, .2);    // -> printf("LOG: %d%f", 1, .2);
log("hello world");    // -> printf("LOG: hello world");
log("hello world", );  // -> printf("LOG: hello world");

长度计算

借助 PP_GET_N()PP_VA_OPT_COMMA(),我们可以计算 变长参数的个数(长度)

#define PP_NARG(...)                                                           
  PP_GET_N(8, __VA_ARGS__ PP_VA_OPT_COMMA(__VA_ARGS__) 8, 7, 6, 5, 4, 3, 2, 1, 
           0)

PP_NARG()          // -> 0
PP_NARG(foo)       // -> 1
PP_NARG(foo())     // -> 1
PP_NARG(())        // -> 1
PP_NARG(()foo)     // -> 1
PP_NARG(PP_EMPTY)  // -> 1
PP_NARG(PP_COMMA)  // -> 1
PP_NARG(, )        // -> 2
PP_NARG(foo, bar)  // -> 2
PP_NARG(, , , )    // -> 4
  • __VA_ARGS__ PP_VA_OPT_COMMA(__VA_ARGS__)8, ..., 0 一起传给 PP_GET_N(8, ...)
  • 如果 __VA_ARGS__ 为空,等价与 PP_GET_N(8, 8, ..., 0),直接返回 第九个元素 0
  • 如果 __VA_ARGS__ 非空,等价于 PP_GET_N(8, __VA_ARGS__, 8, ..., 0),变长参数 __VA_ARGS__8, ..., 0 向后推移,使得返回的 第九个元素 刚好是 __VA_ARGS__ 的参数个数
  • 然而,上述操作有上限(例如 此处支持的最大长度为 8

另外,这里只能用 PP_GET_N(8, ...),而不能用 PP_GET_N_8()

PP_GET_N(0, 1 PP_COMMA() 2)  // -> 1
PP_GET_N_0(1 PP_COMMA() 2)   // -> 1 , 2
  • 如果使用 PP_GET_N_8(),没被展开的 __VA_ARGS__ PP_VA_OPT_COMMA(__VA_ARGS__) 8 会被当成 包含逗号一个参数,而不是 多个参数
  • PP_GET_N() 在把 __VA_ARGS__ 转发给 PP_GET_N_8() 时,会把 上述参数 展开为 多个参数

遍历访问

借助 PP_CONCAT()PP_NARG(),我们可以 遍历 (traverse) 变长参数:

#define PP_FOR_EACH(DO, CTX, ...) 
  PP_CONCAT(PP_FOR_EACH_, PP_NARG(__VA_ARGS__))(DO, CTX, 0, __VA_ARGS__)
#define PP_FOR_EACH_0(DO, CTX, IDX, ...)
#define PP_FOR_EACH_1(DO, CTX, IDX, VAR, ...) DO(VAR, IDX, CTX)
#define PP_FOR_EACH_2(DO, CTX, IDX, VAR, ...) 
  DO(VAR, IDX, CTX)                           
  PP_FOR_EACH_1(DO, CTX, PP_INC(IDX), __VA_ARGS__)
#define PP_FOR_EACH_3(DO, CTX, IDX, VAR, ...) 
  DO(VAR, IDX, CTX)                           
  PP_FOR_EACH_2(DO, CTX, PP_INC(IDX), __VA_ARGS__)
// ...

#define DO_EACH(VAR, IDX, CTX) PP_COMMA_IF(IDX) CTX VAR

PP_FOR_EACH(DO_EACH, void, )        // (empty)
PP_FOR_EACH(DO_EACH, int, a, b, c)  // -> int a, int b, int c
PP_FOR_EACH(DO_EACH, bool, x)       // -> bool x
  • PP_FOR_EACH() 的参数分为三部分:元素的转换操作 DO、遍历的上下文参数 CTX 和 变长参数 ...
  • 其中 DO() 接受三个参数:当前元素 VAR、对应下标 IDX 和 遍历的上下文 CTX,并返回元素 VAR 转换后的结果
  • 先通过 PP_CONCAT()PP_NARG() 选择 变长参数长度 对应的 PP_FOR_EACH_I 符号
  • PP_FOR_EACH_I() 的参数分为四部分:元素的转换操作 DO、遍历的上下文参数 CTX、当前元素下标 IDX 和 变长参数 ...
  • 展开为两部分:变长参数 第一个元素 的转换 DO() 和 变长参数 剩余元素 递归调用 I - 1 宏(下标更新为 IDX + 1
  • I == 0 时,展开为空,递归终止

借助 PP_FOR_EACH() 和 上边的 DO_EACH()(借助其 PP_COMMA_IF(),并忽略 CTX),我们可以实现等效于 PP_VA_OPT_COMMA() 的功能:

#define log(format, ...) 
  printf("LOG: " format PP_FOR_EACH(DO_EACH, , __VA_ARGS__))

log("%d%f", 1, .2);    // -> printf("LOG: %d%f", 1, .2);
log("hello world");    // -> printf("LOG: hello world");
log("hello world", );  // -> printf("LOG: hello world");

符号匹配

借助 PP_CONCAT()PP_IS_EMPTY(),我们可以 匹配任意的特定符号

#define PP_IS_SYMBOL(PREFIX, SYMBOL) PP_IS_EMPTY(PP_CONCAT(PREFIX, SYMBOL))
#define IS_VOID_void

PP_IS_SYMBOL(IS_VOID_, void)            // -> 1
PP_IS_SYMBOL(IS_VOID_, )                // -> 0
PP_IS_SYMBOL(IS_VOID_, int)             // -> 0
PP_IS_SYMBOL(IS_VOID_, void*)           // -> 0
PP_IS_SYMBOL(IS_VOID_, void x)          // -> 0
PP_IS_SYMBOL(IS_VOID_, void(int, int))  // -> 0
  • 先定义一个辅助宏 IS_VOID_void:字面量是前缀 IS_VOID_ 和 目标结果 void 的拼接,展开为空
  • 再通过 PP_CONCAT(PREFIX, SYMBOL) 把 前缀 和 参数 拼接为新的符号,并用 PP_IS_EMPTY() 检查拼接结果 展开后是否为空
  • 只有 SYMBOL 是单个符号 void,才能展开为空
  • 但该方法不支持 模式匹配 (如果大家有什么好想法,欢迎提出~)

借助 PP_IS_EMPTY(),我们还可以 检查符号序列 是否是元组

#define PP_EMPTY_V(...)
#define PP_IS_PARENS(SYMBOL) PP_IS_EMPTY(PP_EMPTY_V SYMBOL)

PP_IS_PARENS()                // -> 0
PP_IS_PARENS(foo)             // -> 0
PP_IS_PARENS(foo())           // -> 0
PP_IS_PARENS(()foo)           // -> 0
PP_IS_PARENS(())              // -> 1
PP_IS_PARENS((foo))           // -> 1
PP_IS_PARENS(((), foo, bar))  // -> 1
  • 先定义一个辅助宏 PP_EMPTY_V():用于 吃掉 变长参数,展开为空
  • 再通过 PP_IS_EMPTY() 检查 PP_EMPTY_V SYMBOL 拼接结果 展开后是否为空
  • 只有 SYMBOL 符合 (...) 的形式,PP_EMPTY_V (...) 才能展开为空

在 gmock-1.10.0 中,MOCK_METHOD() 借助 PP_IS_PARENS()自动识别 参数是不是元组,再进行 选择性的 元组解包 —— 使用时可以只把 包含逗号的参数 变为元组,而其他参数保持不变:

#define PP_IDENTITY(N) N
#define TRY_REMOVE_PARENS(T) 
  PP_IF(PP_IS_PARENS(T), PP_REMOVE_PARENS, PP_IDENTITY)(T)

#define FOO(A, B) int foo(A x, B y)
#define BAR(A, B) FOO(TRY_REMOVE_PARENS(A), TRY_REMOVE_PARENS(B))

FOO(bool, IntPair)                // -> int foo(bool x, IntPair y)
BAR(bool, IntPair)                // -> int foo(bool x, IntPair y)
BAR(bool, (std::pair<int, int>))  // -> int foo(bool x, std::pair<int, int> y)

数据结构

由于 变长参数 只能表示 一维数据,如果需要处理 嵌套的多维数据,还需要高级的数据结构(例如 列表的每一项 包含多个属性,而每个属性 又是一个列表;参考 下文的 递归重入 提到的 嵌套元组)。

BOOST_PP 定义了四种数据结构:

  • 元组 (tuple) 的每个元素 通过 逗号分隔,所有元素放到一个 括号对
  • 序列 (sequence) 的每个元素 放到一个元组里,组成多个 连续的元组
  • 列表 (list) 是一个 递归定义的二元组,第一个元素是 当前元素,第二个元素是 后续列表,并通过 nil 标识结束符
  • 数组 (array) = 元组实际长度 + 元组 组成的二元组(已过时,直接使用 元组 即可)

例如,一组数据的三个元素 分别是 f(12) / a + 1 / foo

  • 元组 表示为 (f(12), a + 1, foo)
  • 序列 表示为 (f(12))(a + 1)(foo)
  • 列表 表示为 (f(12), (a + 1, (foo, PP_NIL)))
  • 数组 表示为 (3, (f(12), a + 1, foo))

另外,元组 () 表示 包含一个空元素的 一元组,而不是 不包含任何元素的 空元组(序列、列表、数组 不涉及这个问题)。

关于上述数据结构的基本运算(下标访问、长度计算、遍历访问、增删元素、类型转换),推荐阅读 BOOST_PP 源码。

递归重入

因为自参照宏(self referential macro)不会被展开 —— 在展开一个宏时,如果遇到 当前宏 的符号,则不会继续展开,避免无限展开(infinite expansion)—— 所以宏不支持 递归/重入

例如,PP_FOR_EACH() 在遍历 两层嵌套元组 时,DO_EACH_1() 无法展开 内层元组,结果保留 PP_FOR_EACH(...) 的形式:

#define OUTER(N, T) PP_FOR_EACH(DO_EACH_1, N, PP_REMOVE_PARENS(T))
#define DO_EACH_1(VAR, IDX, CTX)                   
  PP_FOR_EACH(DO_EACH_2, CTX.PP_GET_TUPLE(0, VAR), 
              PP_REMOVE_PARENS(PP_GET_TUPLE(1, VAR)))
#define DO_EACH_2(VAR, IDX, CTX) CTX .VAR = VAR;

// -> PP_FOR_EACH(DO_EACH_2, obj.x, x1, x2) PP_FOR_EACH(DO_EACH_2, obj.y, y1)
OUTER(obj, ((x, (x1, x2)), (y, (y1))))

一种解决方法是,在 预扫描 阶段,先展开 内层元组,再把展开结果 作为参数,传递给 外层元组,从而避免 递归调用(但不一定适用于所有场景):

#define OUTER(N, T) PP_FOR_EACH(DO_EACH_1, N, PP_REMOVE_PARENS(T))
#define DO_EACH_1(VAR, IDX, CTX) CTX.VAR;
#define INNER(N, T) PP_FOR_EACH(DO_EACH_2, N, PP_REMOVE_PARENS(T))
#define DO_EACH_2(VAR, IDX, CTX) PP_COMMA_IF(IDX) CTX .VAR = VAR

// -> obj.x.x1 = x1; obj.x.x2 = x2; obj.y.y1 = y1;
OUTER(obj, (INNER(x, (x1, x2)), INNER(y, (y1))))

另一种解决方法是,定义另一个相同功能的宏 PP_FOR_EACH_INNER(),用于内层循环,从而避免和外层循环冲突(如果遍历三层嵌套,则需要再定义一个类似的宏):

#define PP_FOR_EACH_INNER(DO, CTX, ...)               
  PP_CONCAT(PP_FOR_EACH_INNER_, PP_NARG(__VA_ARGS__)) 
  (DO, CTX, 0, __VA_ARGS__)
#define PP_FOR_EACH_INNER_0(DO, CTX, IDX, ...)
#define PP_FOR_EACH_INNER_1(DO, CTX, IDX, VAR, ...) DO(VAR, IDX, CTX)
#define PP_FOR_EACH_INNER_2(DO, CTX, IDX, VAR, ...) 
  DO(VAR, IDX, CTX)                                 
  PP_FOR_EACH_INNER_1(DO, CTX, PP_INC(IDX), __VA_ARGS__)
// ...

#define OUTER(N, T) PP_FOR_EACH(DO_EACH_1, N, PP_REMOVE_PARENS(T))
#define DO_EACH_1(VAR, IDX, CTX)                         
  PP_FOR_EACH_INNER(DO_EACH_2, CTX.PP_GET_TUPLE(0, VAR), 
                    PP_REMOVE_PARENS(PP_GET_TUPLE(1, VAR)))
#define DO_EACH_2(VAR, IDX, CTX) CTX .VAR = VAR;

// -> obj.x.x1 = x1; obj.x.x2 = x2; obj.y.y1 = y1;
OUTER(obj, ((x, (x1, x2)), (y, (y1))))

条件循环

上文提到的 PP_FOR_EACH() 主要用于 遍历 变长参数的元素,输出长度和输入相同。但有时候,我们仍需要一个用于 迭代 (iterate)条件循环 PP_WHILE(),最后只输出一个结果:

#define PP_WHILE PP_WHILE_1
#define PP_WHILE_1(PRED, OP, VAL)              
  PP_IF(PRED(VAL), PP_WHILE_2, VAL PP_EMPTY_V) 
  (PRED, OP, PP_IF(PRED(VAL), OP, PP_EMPTY_V)(VAL))
#define PP_WHILE_2(PRED, OP, VAL)              
  PP_IF(PRED(VAL), PP_WHILE_3, VAL PP_EMPTY_V) 
  (PRED, OP, PP_IF(PRED(VAL), OP, PP_EMPTY_V)(VAL))
#define PP_WHILE_3(PRED, OP, VAL)              
  PP_IF(PRED(VAL), PP_WHILE_4, VAL PP_EMPTY_V) 
  (PRED, OP, PP_IF(PRED(VAL), OP, PP_EMPTY_V)(VAL))
#define PP_WHILE_4(PRED, OP, VAL)              
  PP_IF(PRED(VAL), PP_WHILE_5, VAL PP_EMPTY_V) 
  (PRED, OP, PP_IF(PRED(VAL), OP, PP_EMPTY_V)(VAL))
// ...

#define PRED(VAL) PP_GET_TUPLE(1, VAL)
#define OP(VAL) 
  (PP_GET_TUPLE(0, VAL) + PP_GET_TUPLE(1, VAL), PP_DEC(PP_GET_TUPLE(1, VAL)))

PP_GET_TUPLE(0, PP_WHILE(PRED, OP, (x, 2)))  // -> x + 2 + 1
  • PP_WHILE() 接受三个参数:循环条件谓词 PRED、迭代操作运算 OP 和 初始值 VAL
  • 其中 PRED() 接受 当前值 VAL 作为参数,并返回 非负整数
  • 其中 OP() 接受 当前值 VAL 作为参数,并返回 迭代后的下一个 VAL
  • 原理和 PP_FOR_EACH() 类似,PP_WHILE_I() 根据 PRED(VAL) 选择展开方式
  • 如果 PRED(VAL) != 0,递归调用 I + 1 宏,并传入 OP(VAL) 作为 下一轮迭代 的 当前值
  • 如果 PRED(VAL) == 0,展开为 VAL,并 跳过 OP(VAL)递归终止
  • PP_WHILEPP_WHILE_1 开始迭代

PP_FOR_EACH() 不同,不需要定义 PP_WHILE_INNER(),就可以在循环展开时重入 —— 如果 当前递归状态I,重入代码可以使用 任意 I 以后的宏:

  • 例如 当展开 PP_WHILE_2() 时,只有 PP_WHILE_1PP_WHILE_2 正在展开,所以 PRED()/OP() 可以使用 PP_WHILE_3() 及以后的宏
  • 由于 PRED(VAL)/OP(VAL) 只在参数里展开,在下一轮迭代的 PP_WHILE_3() 展开时,不会构成递归调用

为了支持方便的递归调用,BOOST_PP 提出了自动推导当前递归状态的方法:

#define PP_WHILE PP_CONCAT(PP_WHILE_, PP_AUTO_DIM(PP_WHILE_CHECK))

#define PP_AUTO_DIM(CHECK) 
  PP_IF(CHECK(2), PP_AUTO_DIM_12, PP_AUTO_DIM_34)(CHECK)
#define PP_AUTO_DIM_12(CHECK) PP_IF(CHECK(1), 1, 2)
#define PP_AUTO_DIM_34(CHECK) PP_IF(CHECK(3), 3, 4)

#define PP_WHILE_CHECK(N) 
  PP_CONCAT(PP_WHILE_CHECK_, PP_WHILE_##N(0 PP_EMPTY_V, , 1))
#define PP_WHILE_CHECK_1 1
#define PP_WHILE_CHECK_PP_WHILE_1(PRED, OP, VAL) 0
#define PP_WHILE_CHECK_PP_WHILE_2(PRED, OP, VAL) 0
#define PP_WHILE_CHECK_PP_WHILE_3(PRED, OP, VAL) 0
#define PP_WHILE_CHECK_PP_WHILE_4(PRED, OP, VAL) 0
// ...

#define OP_1(VAL)                                                        
  (PP_GET_TUPLE(0, PP_WHILE(PRED, OP_2,                                  
                            (PP_GET_TUPLE(0, VAL), PP_GET_TUPLE(1, VAL), 
                             PP_GET_TUPLE(1, VAL)))),                    
   PP_DEC(PP_GET_TUPLE(1, VAL)))
#define OP_2(VAL)                                                      
  (PP_GET_TUPLE(0, VAL) + PP_GET_TUPLE(2, VAL) * PP_GET_TUPLE(1, VAL), 
   PP_DEC(PP_GET_TUPLE(1, VAL)), PP_GET_TUPLE(2, VAL))

PP_GET_TUPLE(0, PP_WHILE(PRED, OP_1, (x, 2)))  // -> x + 2 * 2 + 2 * 1 + 1 * 1
  • 定义辅助宏 PP_WHILE_CHECK(I) 用于检查 I 对应的 PP_WHILE_I() 是否可用
  • 使用 0 PP_EMPTY_V 作为谓词,调用 PP_WHILE_I()
  • 如果 PP_WHILE_I() 正在展开,此处不会再被展开,和前缀 PP_WHILE_CHECK_ 拼接为 PP_WHILE_CHECK_PP_WHILE_I(0 PP_EMPTY_V, , 1) 的形式,最后展开为 0
  • 如果 PP_WHILE_I() 没有使用,此处先被展开为 1,再和前缀 PP_WHILE_CHECK_ 拼接为 PP_WHILE_CHECK_1 的形式,最后展开为 1
  • 定义辅助宏 PP_AUTO_DIM() 用于推导 最小可用的递归状态 I
  • 使用 二分查找 (binary search) 的方法,时间复杂度可以降到 $O(log_{2}n)$
  • 假设 下标最大值4,那么先检查 2 是否可用;如果可用再尝试 1,否则检查 3
  • PP_WHILE 通过 PP_AUTO_DIM(PP_WHILE_CHECK) 推导出的 PP_WHILE_I 保证总是可用

不过,在展开PP_WHILE()时,当前递归状态总是确定的,实际上不需要推导。所以 BOOST_PP 建议尽量传递状态,而不是自动推导:

  • PP_WHILE_I() 展开时,把 下一个状态的下标 I + 1(连同当前 VAL)传给 PRED(PP_INC(I), VAL)OP(PP_INC(I), VAL)
  • PRED()/OP() 可以直接使用 I + 1 对应的宏(及 I + 1 以后的宏),无需再用 PP_AUTO_DIM() 推导可用的下标

当然,自动推导传递状态 也可以用于实现 PP_FOR_EACH() 的递归重入:

  • 先将 PP_FOR_EACH 定义为 PP_AUTO_DIM(PP_FOR_EACH_CHECK) 推导出的 PP_FOR_EACH_D 符号(自动推导
  • 每组 PP_FOR_EACH_D 再定义 不同变长参数个数 I 对应的 PP_FOR_EACH_D_I,然后用 上文提到的方法 遍历所有参数
  • 在展开 DO() 时,可以额外传递 下一个状态的下标 D + 1传递状态
  • BOOST_PP 支持 3 层循环嵌套,每层循环可以遍历 256 个变长参数,需要定义 3×256 个 PP_FOR_EACH_D_I 重载

延迟展开

CHAOS_PP 提出了一种基于延迟展开的递归调用方法:

#define PP_WHILE_RECURSIVE(PRED, OP, VAL)          
  PP_IF(PRED(VAL), PP_WHILE_DEFER, VAL PP_EMPTY_V) 
  (PRED, OP, PP_IF(PRED(VAL), OP, PP_EMPTY_V)(VAL))
#define PP_WHILE_INDIRECT() PP_WHILE_RECURSIVE
#define PP_WHILE_DEFER PP_WHILE_INDIRECT PP_EMPTY PP_EMPTY PP_EMPTY()()()()

// -> PP_WHILE_INDIRECT PP_EMPTY PP_EMPTY()()()
PP_WHILE_DEFER
// -> PP_WHILE_INDIRECT PP_EMPTY()()
PP_IDENTITY(PP_WHILE_DEFER)
// -> PP_WHILE_INDIRECT ()
PP_IF(1, PP_WHILE_DEFER, )
// -> PP_WHILE_RECURSIVE
PP_IDENTITY(PP_IF(1, PP_WHILE_DEFER, ))
  • PP_WHILE_I() 类似,PP_WHILE_RECURSIVE()PRED(VAL) != 0 的情况下,展开为调用 PP_WHILE_DEFER 宏(即 PP_WHILE_INDIRECT PP_EMPTY PP_EMPTY PP_EMPTY()()()())的形式
  • 其中的 PP_EMPTY() 起到了 延迟展开 的作用
  • PP_WHILE_DEFER 会被原地展开为 PP_WHILE_INDIRECT PP_EMPTY PP_EMPTY()()(),即其中一组 PP_EMPTY() 展开为空,然后 停止展开
  • PP_WHILE_DEFER 作为参数传给 PP_IF() 时,一组 PP_EMPTY() 再展开为空;再作为 PP_IF() 的结果传出时,一组 PP_EMPTY() 又展开为空;最后得到 PP_WHILE_INDIRECT(),然后 停止展开
  • 所以,在当前场景下,需要至少 3 组 PP_EMPTY()
  • PP_WHILE_RECURSIVE() 展开时
  • 如果 PP_WHILE_DEFER 内的 PP_EMPTY() 数量不足,就不会形成 PP_WHILE_INDIRECT(),而直接变为 PP_WHILE_RECURSIVE
  • 然而,自参照的宏符号 PP_WHILE_RECURSIVE 不能继续展开,即使使用下文提到的 PP_EXPAND() 也不行

在每次循环结束后,得到的 PP_WHILE_INDIRECT(),需要先 手动展开PP_WHILE_RECURSIVE,再进入下一轮迭代,直到 PRED(VAL) == 0 为止:

#define PP_EXPAND(...) __VA_ARGS__

// -> PP_WHILE_INDIRECT() (PRED, OP, (x + 2, 1))
PP_WHILE_RECURSIVE(PRED, OP, (x, 2))
// -> PP_WHILE_INDIRECT() (PRED, OP, (x + 2 + 1, 0))
PP_EXPAND(PP_WHILE_RECURSIVE(PRED, OP, (x, 2)))
// -> (x + 2 + 1, 0)
PP_EXPAND(PP_EXPAND(PP_WHILE_RECURSIVE(PRED, OP, (x, 2))))
  • 需要展开几轮 PP_WHILE_RECURSIVE(),就需要嵌套几次 PP_EXPAND()
  • 所以,可以定义一个嵌套层数为 最大循环次数 的辅助宏,专门用于 PP_WHILE_RECURSIVE() 的延迟展开机制

需要注意 上述方法 不一定适用于所有编译器,一般建议使用 PP_WHILE()

数值运算

借助 PP_WHILE()PP_INC()/PP_DEC(),我们可以实现 非负整数加法

#define PP_ADD(X, Y) PP_GET_TUPLE(0, PP_WHILE(PP_ADD_P, PP_ADD_O, (X, Y)))
#define PP_ADD_P(V) PP_GET_TUPLE(1, V)
#define PP_ADD_O(V) (PP_INC(PP_GET_TUPLE(0, V)), PP_DEC(PP_GET_TUPLE(1, V)))

PP_ADD(0, 2)  // -> 2
PP_ADD(1, 1)  // -> 2
PP_ADD(2, 0)  // -> 2
  • PP_ADD() 从二元组 (X, Y) 开始迭代
  • 迭代操作 PP_ADD_O() 返回 (X + 1, Y - 1)
  • 终止条件 PP_ADD_P()Y == 0,此时的 X 为所求(可能上溢)

借助 PP_WHILE()PP_DEC(),我们还可以实现 非负整数减法

#define PP_SUB(X, Y) PP_GET_TUPLE(0, PP_WHILE(PP_SUB_P, PP_SUB_O, (X, Y)))
#define PP_SUB_P(V) PP_GET_TUPLE(1, V)
#define PP_SUB_O(V) (PP_DEC(PP_GET_TUPLE(0, V)), PP_DEC(PP_GET_TUPLE(1, V)))

PP_SUB(2, 2)  // -> 0
PP_SUB(2, 1)  // -> 1
PP_SUB(2, 0)  // -> 2
  • PP_SUB() 从二元组 (X, Y) 开始迭代
  • 迭代操作 PP_SUB_O() 返回 (X - 1, Y - 1)
  • 终止条件 PP_SUB_P()Y == 0,此时的 X 为所求(可能下溢)

借助 PP_WHILE()PP_ADD(),我们可以实现 非负整数乘法

#define PP_MUL(X, Y) PP_GET_TUPLE(0, PP_WHILE(PP_MUL_P, PP_MUL_O, (0, X, Y)))
#define PP_MUL_P(V) PP_GET_TUPLE(2, V)
#define PP_MUL_O(V)                                                    
  (PP_ADD(PP_GET_TUPLE(0, V), PP_GET_TUPLE(1, V)), PP_GET_TUPLE(1, V), 
   PP_DEC(PP_GET_TUPLE(2, V)))

PP_MUL(1, 2)  // -> 2
PP_MUL(2, 1)  // -> 2
PP_MUL(2, 0)  // -> 0
PP_MUL(0, 2)  // -> 0
  • PP_MUL() 从三元组 (R, X, Y) 开始迭代(R 初始值为 0
  • 迭代操作 PP_MUL_O() 返回 (R + X, X, Y - 1)(此处的 PP_ADD() 内部调用 PP_WHILE() 宏,构成 递归重入
  • 终止条件 PP_MUL_P()Y == 0,此时的 R 为所求(可能上溢)
除法和取模运算 基于 数值比较,见下文。

数值比较

借助 PP_WHILE()PP_DEC(),我们还可以实现 等于比较

#define PP_CMP(X, Y) PP_WHILE(PP_CMP_P, PP_CMP_O, (X, Y))
#define PP_CMP_P(V) 
  PP_AND(PP_BOOL(PP_GET_TUPLE(0, V)), PP_BOOL(PP_GET_TUPLE(1, V)))
#define PP_CMP_O(V) (PP_DEC(PP_GET_TUPLE(0, V)), PP_DEC(PP_GET_TUPLE(1, V)))

#define PP_EQUAL(X, Y) PP_IDENTITY(PP_EQUAL_IMPL PP_CMP(X, Y))
#define PP_EQUAL_IMPL(RX, RY) PP_AND(PP_NOT(PP_BOOL(RX)), PP_NOT(PP_BOOL(RY)))

PP_EQUAL(1, 2)  // -> 0
PP_EQUAL(1, 1)  // -> 1
PP_EQUAL(1, 0)  // -> 0
  • PP_CMP() 从二元组 (X, Y) 开始迭代
  • 迭代操作 PP_CMP_O() 返回 (X - 1, Y - 1)(同 PP_SUB_O()
  • 终止条件 PP_CMP_P()X == 0 || Y == 0,此时的 (X, Y) 为所求(不会下溢)
  • 最终结果 (RX, RY) 只有三种情况:RX == 0 && RY == 0 / RX != 0 && RY == 0 / RX == 0 && RY != 0
  • PP_EQUAL() 返回 RX == 0 && RY == 0 的布尔值
  • 类似 PP_WHILE_RECURSIVE()PP_EQUAL_IMPL PP_CMP(X, Y)PP_CMP() 展开为 (RX, RY) 后,仍需要借助 PP_IDENTITY() 手动展开 PP_EQUAL_IMPL(RX, RY)

类似的,我们还可以实现 小于比较

#define PP_LESS(X, Y) PP_IDENTITY(PP_LESS_IMPL PP_CMP(X, Y))
#define PP_LESS_IMPL(RX, RY) PP_AND(PP_NOT(PP_BOOL(RX)), PP_BOOL(RY))

PP_LESS(0, 1)  // -> 1
PP_LESS(1, 2)  // -> 1
PP_LESS(1, 1)  // -> 0
PP_LESS(2, 1)  // -> 0
  • 借助 PP_CMP() 的结果,PP_LESS() 返回 RX == 0 && RY != 0 的布尔值
其他比较方式( 不等于、大于、小于等于、大于等于)可以通过 PP_EQUAL()/ PP_LESS() 的 布尔运算 得到。

借助 PP_IF()PP_LESS(),我们可以获取 最大值/最小值

#define PP_MIN(X, Y) PP_IF(PP_LESS(X, Y), X, Y)
#define PP_MAX(X, Y) PP_IF(PP_LESS(X, Y), Y, X)

PP_MIN(0, 1)  // -> 0
PP_MIN(1, 1)  // -> 1
PP_MAX(1, 2)  // -> 2
PP_MAX(2, 1)  // -> 2

借助 PP_WHILE()PP_SUB()/PP_LESS(),我们可以实现 非负整数除法/取模

#define PP_DIV_BASE(X, Y) PP_WHILE(PP_DIV_BASE_P, PP_DIV_BASE_O, (0, X, Y))
#define PP_DIV_BASE_P(V) 
  PP_NOT(PP_LESS(PP_GET_TUPLE(1, V), PP_GET_TUPLE(2, V)))  // X >= Y
#define PP_DIV_BASE_O(V)                                                       
  (PP_INC(PP_GET_TUPLE(0, V)), PP_SUB(PP_GET_TUPLE(1, V), PP_GET_TUPLE(2, V)), 
   PP_GET_TUPLE(2, V))

#define PP_DIV(X, Y) PP_GET_TUPLE(0, PP_DIV_BASE(X, Y))
#define PP_MOD(X, Y) PP_GET_TUPLE(1, PP_DIV_BASE(X, Y))

PP_DIV(2, 1), PP_MOD(2, 1)  // -> 2, 0
PP_DIV(1, 1), PP_MOD(1, 1)  // -> 1, 0
PP_DIV(0, 1), PP_MOD(0, 1)  // -> 0, 0
PP_DIV(1, 2), PP_MOD(1, 2)  // -> 0, 1
  • PP_DIV_BASE() 从三元组 (R, X, Y) 开始迭代(R 初始值为 0
  • 迭代操作 PP_DIV_BASE_O() 返回 (R + 1, X - Y, Y)(此处的 PP_SUB() 内部调用 PP_WHILE() 宏,构成 递归重入
  • 终止条件 PP_DIV_BASE_P()X >= Y,此时的 R 为商、X 为余数(R 可能上溢,X 不会下溢)

结合模板

有时候,可以使用 C++ 模板 处理 类型,不必完全依赖于宏。例如把函数的 class 类型参数转为 const T&,而其他类型参数保持 T

template <typename T, bool Condition = std::is_class_v<T>>
using maybe_cref_t =
    std::conditional_t<Condition,
                       std::add_lvalue_reference_t<std::add_const_t<T>>,
                       T>;

#define MAKE_ARG(TYPE, IDX, _) 
  PP_COMMA_IF(IDX) maybe_cref_t<TYPE> PP_CONCAT(v, IDX)

// -> void foo(maybe_cref_t<int> v0, maybe_cref_t<std::string> v1);
// -> void foo(int v0, const std::string& v1);
void foo(PP_FOR_EACH(MAKE_ARG, , int, std::string));
  • 宏 展开结果为 maybe_cref_t<int>maybe_cref_t<std::string>
  • C++ 模板 展开结果为 intconst std::string&
  • 如果只用宏,很难完成这项任务

参考资料

本文的用法 主要参考 以下资料:

  • BOOST_PP:目前流行的 预处理库 (preprocessor library)(导读:Appendix A - An Introduction to Preprocessor Metaprogramming by David Abrahams and Aleksey Gurtovoy)
  • CHAOS_PP:BOOST_PP 的前身(by Vesa Karvonen/Paul Mensonides)
  • GMOCK_PP:BOOST_PP 精简版,在 gmock-1.10.0 中用于 MOCK_METHOD() 自动推导 参数个数
  • ORDER_PP:CHAOS_PP 的衍生(Vesa 设计的 ORDER 语言)
  • pfultz2/Cloak:CHAOS_PP 的精选(导读:C Preprocessor tricks, tips, and idioms)

写在最后

本文主要介绍了宏编程的常用方法,但可能存在不足:

  • 不一定适用于所有编译器(例如 BOOST_PP 源码针对 MSVC 做了很多兼容处理)
  • 部分代码没考虑到某些特殊场景(例如 PP_IS_SYMBOL() 不能检查 以非标识符开头的参数)

实际应用场景中,建议使用成熟的预处理库。

如果有什么问题,欢迎交流

Delivered under MIT License © 2020, BOT Man

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值