宏定义了一个带有前缀的新宏。

Question

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

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

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

- Steve Lorimer

---

不要滥用标签！这显然不是C语言。 - too honest for this site

关于 C 预处理器的问题，任何在 C 中有效的内容在这里都可以使用。如果您觉得这是垃圾信息，请原谅，这并不是我的意图。 - Steve Lorimer

@Olaf，我并不认为无法在宏中创建宏，我不确定你指的是什么？当你说我们不是咨询网站时，我也不太明白你的意思。 - Steve Lorimer

@Olaf 更新了代码，使其成为 C 语言，以更好地反映我提出的问题。 - Steve Lorimer

请看C #define macro for debug printing中的讨论。虽然该讨论是关于调试代码的，但很容易适应于性能分析代码或其他特殊情况。个人而言，我可能会选择一个#define PROFILE_START(component, msg) … 的变体，其中 component 可以用于条件等。也许是 #define PROFILE_START(component, msg) (profile_ ## component ? currentProfiler().start(msg) : (void)0) 或类似的定义。这假设你已经定义了 profile_BAR 等宏（？）。 - Jonathan Leffler

Answer 1

“是否可能创建这样的宏助手？”

不可以。除了编译指示，您无法在宏中执行预处理指令。

您可以使用模式匹配来实现非常类似的功能。通过将可变部分从宏名称中移到宏本身内部，可以创建一种允许为任意名称启用/禁用的形式。

这需要一些预处理器元编程（这是一个常数开销；即，随着您添加模块而变化），所以请耐心等待。

第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。

第二部分a：它是如何工作的；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_参数都是可粘贴的（即使看不到该标记，它也必须是有效的标记）。

第二部分b：组合开关以确保安全性

单独的开关类似于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预处理器所能实现的功能。

- H Walters

---

哇，太棒了！非常感谢！ - Steve Lorimer

Answer 2

我个人会选择类似这样的东西：

#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语句生成任何指令。

- user1620443

Answer 3

这样的辅助宏可能存在吗？

不可能。正如评论中所述，您无法通过宏生成宏定义。

有更好的方法来实现我想要的吗？

既然宏的想法行不通，任何其他可行的替代方案都是更好的选择。基本上，您正在寻找一个代码生成器——一个程序，它将作为输入接受模块列表，并生成包含所有模块的分析宏定义的C源代码（也许是头文件）作为输出。您可以使用几乎任何语言编写这样的程序——C、Python、Perl、Shell脚本等。根据您的技术偏好和项目背景，您甚至可以选择类似XSLT之类的东西。

然后，每个想要获取分析宏的源文件只需包含生成的头文件即可。

---

^*实际上，您可以使用C预处理器，在不同的、专门用于此目的的输入文件上执行单独的、独立的运行。但是，您不能在编译想要使用它们的源文件时就直接生成宏。

- John Bollinger