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

Answer 1

我个人会选择像

这样的东西

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

Answer 2

是否可以使用这样的辅助宏？

没有。除了编译指示之外，您无法在宏中执行预处理指令。

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

这需要一点点预处理器元编程（这是一个不变的开销;即，随着你添加模块不会有所不同），所以请耐心等待。

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

默认情况下，所有这些宏都扩展为空;您可以通过为ENABLE_PROFILER_FOR_xxx，FOO或BAR的任何子集定义BAZ来扩展为,（或,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是模式匹配器。前两个参数被粘贴在一起，包括模式。默认情况下，此模式被丢弃;但由于间接，如果该模式是像宏一样的对象，和该模式的扩展包含一个逗号，它将移动一个新的第二个参数。例如：< / p>

#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_参数都是可粘贴的（即使没有看到该标记，它也有成为有效的令牌。）

第2b部分：用于安全的组合开关

一个单独的开关就像一个案例陈述，允许你把任何东西推进去;但是当情况需要二元选择（如“启用”或“禁用”）时，将一个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预处理器的可能性。

Answer 3

这样的帮助宏可能吗？

没有。正如评论中所述，您无法通过宏生成宏定义。^*

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

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

每个想要获取性能分析宏的源文件只是#include生成的头。

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

定义具有添加前缀

3 个答案:

第1部分：C预处理器解决方案

第2a部分：它如何运作; SWITCH宏

第2b部分：用于安全的组合开关