定义带有添加前缀的新宏的宏答案

【问题标题】：macro which defines new macros with an added prefix定义带有添加前缀的新宏的宏
【发布时间】：2017-10-26 13:42:09
【问题描述】：

我们有一个分析框架，可以在编译时启用和禁用。

对框架的所有各种调用都是通过宏完成的，例如：

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;
}

【问题讨论】：

不要垃圾标签！这显然不是 C。
@Olaf 它是关于 C 预处理器的，所以在 C 中工作的任何东西都可以在这里工作。如果您觉得这是垃圾邮件，请道歉，那不是我的意图
@Olaf 对我来说，不能在宏中创建宏并不明显，我不确定你指的是什么？我也不确定你说我们不是咨询网站是什么意思
@Olaf 将代码更新为 C，以更好地反映我的问题
看C #define macro for debug printing的讨论。尽管这是关于调试代码，但它很容易适应分析代码或任何其他特殊情况。就个人而言，我可能会在#define PROFILE_START(component, msg) … 上使用一个变体，该组件可以在条件等条件下使用。也许#define PROFILE_START(component, msg) (profile_ ## component ? currentProfiler().start(msg) : (void)0) 或类似的。假设您已定义 profile_BAR 等（作为宏？）。

标签： c++ macros c-preprocessor boost-preprocessor

【解决方案1】：

这样的辅助宏可能吗？

没有。除了 pragma 之外，您不能在宏中执行预处理指令。

您可以使用模式匹配做一些非常相似的事情。通过取出宏名称的不同部分，并将其放入宏本身，您可以制作一个允许启用/禁用任意名称的表单。

这需要一点预处理元编程（这是一个恒定的开销；即，不会随着您添加模块而变化），所以请耐心等待。

第 1 部分：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；或在makefile中； 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 语句；其“case”是具有匹配前缀的类对象宏，并且具有默认值。

请注意，预处理器中的模式匹配使用移位参数，因此使用逗号（主要技巧是通过忽略参数来丢弃不匹配的标记，并通过将所需的替换移入来应用匹配的标记）。同样对于这个SWITCH 宏的最一般情况，您至少需要确保所有PREFIX_/PATTERN_ 参数都是可粘贴的（即使没有看到该令牌，它也必须是有效的令牌） .

第 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) 设为空；否则，将调用原始宏。

有没有更好的方法来实现我正在寻找的东西？

取决于您要查找的内容。这种方法展示了 C 预处理器的可能性。

【讨论】：

哇，太棒了！非常感谢！

【解决方案2】：

这样的辅助宏可能吗？

没有。如 cmets 所述，您无法通过宏生成宏定义。^*

有没有更好的方法来实现我的目标？

由于宏观想法行不通，^*可行的任何替代方案都会更好。基本上，您正在寻找一个代码生成器——一个将模块列表作为输入并生成包含所有模块的所有分析宏定义的输出 C 源代码（可能是头文件）的程序。你可以用几乎任何语言编写这样的程序——C、python、perl、shell 脚本等等。根据您的技术偏好和项目环境，您甚至可以使用 XSLT 之类的东西。

每个想要获取分析宏的源文件然后只需 #includes 生成的头文件。

^*事实上，您可以使用 C 预处理器，通过在不同的专用输入文件上执行单独的独立运行。但是当您编译要使用它们的源文件时，您无法就地生成宏。

【讨论】：

【解决方案3】：

我个人会选择类似的东西

#include <stdio.h>

#define FOO_ENABLED 1
#define BAR_ENABLED 0

#define PROFILE_START(FLAG, msg) \
   { if (FLAG) printf("start(%s)\n", msg); }

int main()
{
    PROFILE_START(FOO_ENABLED, "foo")
    PROFILE_START(BAR_ENABLED, "bar")
    return 0;
}

无论如何，任何体面的编译器都不会为 if 语句生成任何指令。

【讨论】：