我们有一个分析框架,可以在编译时启用和禁用。
所有对框架的各种调用都是通过宏完成的,例如:
PROFILE_START(msg)
PROFILE_END(msg)
然后宏会在启用分析时解析为实际的分析器调用,而在禁用时则为空
#ifdef PROFILING_ENABLED
# define PROFILE_START(msg) currentProfiler().start(msg)
# define PROFILE_END(msg) currentProfiler().end(msg)
#else
# define PROFILE_START(msg)
# define PROFILE_END(msg)
#endif
我们的框架中有各种不同的组件,我想在每个组件中启用分析。
我希望能够有选择地在每个组件中启用分析。
我的想法是在所有分析器宏前加上组件名称,例如:
FOO_PROFILE_START(msg)
FOO_PROFILE_END(msg)
BAR_PROFILE_START(msg)
BAR_PROFILE_END(msg)
我可以手动创建
#ifdef ENABLE_FOO_PROFILING
# define FOO_PROFILE_START(msg) PROFILE_START(msg)
# define FOO_PROFILE_END(msg) PROFILE_END(msg)
#else
# define FOO_PROFILE_START(msg)
# define FOO_PROFILE_END(msg)
#endif
#ifdef ENABLE_BAR_PROFILING
# define BAR_PROFILE_START(msg) PROFILE_START(msg)
# define BAR_PROFILE_END(msg) PROFILE_END(msg)
#else
# define BAR_PROFILE_START(msg)
# define BAR_PROFILE_END(msg)
#endif
但是,这既乏味又容易出错。
每当向分析框架添加新功能时,我都必须找到我所有的特定于组件的宏,并为每个宏添加一个新宏。
我正在寻找一种自动生成组件前缀宏的方法。
#ifdef ENABLE_FOO_PROFILING
ADD_PREFIX_TO_ENABLED_PROFILING_MACROS(FOO)
#else
ADD_PREFIX_TO_DISABLED_PROFILING_MACROS(FOO)
#endif
上述的最终结果将是创建我手动完成的所有 FOO_PROFILE_XXX
宏。
问题:
- 这样的辅助宏是否可能?
- 是否有更好的方法来实现我的目标?
如有必要,我很乐意使用 BOOST_PP。
在发布这个问题之前,我试着自己解决这个问题,我想出的代码如下,这可能有助于显示我正在走的路
#include <stdio.h>
#define PROFILE_START(msg) printf("start(%s)\n", msg);
#define PROFILE_END(msg) printf("end(%s)\n", msg);
#define ENABLE(prefix) \
#define prefix ## _PROFILE_START PROFILE_START \
#define prefix ## _PROFILE_END PROFILE_END
#define DISABLE(prefix) \
#define prefix ## _PROFILE_START \
#define prefix ## _PROFILE_END
#define ENABLE_FOO
#ifdef ENABLE_FOO
ENABLE(FOO)
#else
DISABLE(FOO)
#endif
#ifdef ENABLE_BAR
ENABLE(BAR)
#else
DISABLE(BAR)
#endif
int main()
{
FOO_PROFILE_START("foo");
FOO_PROFILE_END("foo");
BAR_PROFILE_START("bar");
BAR_PROFILE_END("bar");
return 0;
}
最佳答案
Is such a helper macro possible?
没有。除了编译指示外,您不能在宏中执行预处理指令。
您可以使用模式匹配来做一些非常相似的事情。通过将宏名称的不同部分 取出,并将其放入宏本身,您可以创建一个允许启用/禁用任意名称的表单。
这需要一点预处理器元编程(这是一个恒定的开销;即,不会随着您添加模块而变化),所以请耐心等待。
第 1 部分:A C 预处理器解决方案
使用这组宏:
#define GLUE(A,B) GLUE_I(A,B)
#define GLUE_I(A,B) A##B
#define SECOND(...) SECOND_I(__VA_ARGS__,,)
#define SECOND_I(_,X,...) X
#define SWITCH(PREFIX_,PATTERN_,DEFAULT_) SECOND(GLUE(PREFIX_,PATTERN_),DEFAULT_)
#define EAT(...)
#define PROFILER_UTILITY(MODULE_) SWITCH(ENABLE_PROFILER_FOR_,MODULE_,DISABLED)
#define PROFILER_IS_DISABLED ,EAT
#define PROFILE_START_FOR(MODULE_, msg) SWITCH(PROFILER_IS_,PROFILER_UTILITY(MODULE_),PROFILE_START)(msg)
#define PROFILE_END_FOR(MODULE_, msg) SWITCH(PROFILER_IS_,PROFILER_UTILITY(MODULE_),PROFILE_END)(msg)
...您可以将其包含在每个模块中,您将获得执行此操作的能力:
PROFILE_START_FOR(FOO,msg)
PROFILE_END_FOR(FOO,msg)
PROFILE_START_FOR(BAR,msg)
PROFILE_END_FOR(BAR,msg)
PROFILE_START_FOR(BAZ,msg)
PROFILE_END_FOR(BAZ,msg)
默认情况下,所有这些宏都展开为空;您可以通过为 FOO
、BAR
或 BAZ
的任何子集定义 ENABLE_PROFILER_FOR_xxx
来更改它以扩展为 ,
(或者 ,ON
如果这样看起来更好),在这种情况下,相应的宏 将扩展(最初,在您自己的宏出现之前)到 PROFILE_START(msg)
/PROFILE_END(msg)
;其余的将继续扩展到零。
以 FOO 模块为例,您可以使用“控制文件”来完成此操作:#define ENABLE_PROFILER_FOR_FOO ,ON
;命令行:... -DENABLE_PROFILER_FOR_FOO=,ON
;或在生成文件中; CFLAGS += -DENABLE_PROFILER_FOR_FOO=,ON
。
第 2a 部分:它是如何工作的; SWITCH 宏
#define GLUE(A,B) GLUE_I(A,B)
#define GLUE_I(A,B) A##B
#define SECOND(...) SECOND_I(__VA_ARGS__,,)
#define SECOND_I(_,X,...) X
#define SWITCH(PREFIX_,PATTERN_,DEFAULT_) SECOND(GLUE(PREFIX_,PATTERN_),DEFAULT_)
GLUE
这是典型的间接粘贴宏(允许扩展参数)。 SECOND
是返回第二个参数的间接可变参数宏。
SWITCH
是模式匹配器。前两个参数粘贴在一起,构成模式。默认情况下,该模式被丢弃;但由于间接性,如果该模式是一个类似于宏的对象,并且该模式的扩展包含一个逗号,它将移入一个新的第二个参数。例如:
#define ORDINAL(N_) GLUE(N_, SWITCH(ORDINAL_SUFFIX_,N_,th))
#define ORDINAL_SUFFIX_1 ,st
#define ORDINAL_SUFFIX_2 ,nd
#define ORDINAL_SUFFIX_3 ,rd
ORDINAL(1) ORDINAL(2) ORDINAL(3) ORDINAL(4) ORDINAL(5) ORDINAL(6)
...将扩展为:
1st 2nd 3rd 4th 5th 6th
以这种方式,SWITCH
宏的行为类似于 switch 语句;其“案例”是具有匹配前缀的类似对象的宏,并且具有默认值。
请注意,预处理器中的模式匹配使用移位参数,因此使用逗号(主要技巧是通过忽略参数来丢弃不匹配的标记,并通过将所需的替换项移入来应用匹配的标记)。同样对于使用此 SWITCH
宏的最一般情况,您至少需要确保所有 PREFIX_
/PATTERN_
参数都是可粘贴的(即使没有看到该 token ,它必须是有效的 token )。
第 2b 部分:安全组合开关
一个单独的 switch 就像一个 case 语句,允许你把任何东西推进去;但是当情况需要二元选择(如“启用”或“禁用”)时,将一个 SWITCH
嵌套在另一个中会有所帮助。这使得模式匹配不那么脆弱。
在这种情况下,实现:
#define PROFILER_UTILITY(MODULE_) SWITCH(ENABLE_PROFILER_FOR_,MODULE_,DISABLED)
#define PROFILER_IS_DISABLED ,EAT
#define PROFILE_START_FOR(MODULE_, msg) SWITCH(PROFILER_IS_,PROFILER_UTILITY(MODULE_),PROFILE_START)(msg)
#define PROFILE_END_FOR(MODULE_, msg) SWITCH(PROFILER_IS_,PROFILER_UTILITY(MODULE_),PROFILE_END)(msg)
...使用 PROFILER_UTILITY
作为内部开关。默认情况下,这会扩展为 DISABLED
。这使得 SWITCH(PROFILER_IS_,PROFILER_UTILITY(MODULE_),PROFILE_START)
中的模式默认为 PROFILER_IS_DISABLED
,这会插入 EAT
。在 PROFILER_UTILITY
的非默认情况下,外部开关启动使其扩展为 PROFILE_START
。 PROFILE_END_FOR
的工作方式类似。
EAT
宏在这两种情况下都将 (msg)
置为空;否则,将调用原始宏。
Is there a better way of achieving what I'm looking for?
取决于您要查找的内容。这种方法展示了 C 预处理器的可能性。
关于c++ - 定义带有添加前缀的新宏的宏,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/44188416/