C/C++宏定义的可变参数

编写代码的过程中，经常会输出一些调试信息到屏幕上，一般会调用printf这类的函数。
但是当调试解决之后，我们需要手工将这些地方删除或者注释掉。
再这次的项目中就用到类似问题，为了调试程序，再一些地方输出了很多的信息，随着项目的调试，输出的信息越来越多。于是就面临着，如何处理这些输出信息的语句。
简单删掉，不仅有一定的工作量，而且也不能保证之后就不出现问题，出现问题后这些信息还是有用的。
不去掉，带着调试信息就上线，这是明显不允许的。
于是就想到了一个可行的办法。如下：

void myprintf(char* fmt, …)
{
}
#ifdef DEBUG
#define printf(fmt, args…)myprintf(fmt, ##args)
#endif

调试阶段带着DEBUG调试，正式上线就可以把printf变成一个空函数了。
这样做的一个潜在风险是可能会导致默写glib函数需要调用printf输出错误log也给取消掉了。
令人欣慰的是，大部分glib调用的应该是fprintf。
虽然问题解决了，但是我对args…以及##args还是不太了解。上网找了些gcc手册的资料如下：
带有可变参数的宏（Macros with a Variable Number of Arguments）
在1999年版本的ISO C标准中，宏可以象函数一样，定义时可以带有可变参数。宏的语法和函数的语法类似。下面有个例子：

#define debug(format, …) fprintf(stderr, format, __VA_ARGS__)

这里，‘…’指可变参数。这类宏在被调用时，它（这里指‘…’）被表示成零个或多个符号，包括里面的逗号，一直到到右括弧结束为止。当被调用时，在宏体（macro body）中，那些符号序列集合将代替里面的__VA_ARGS__标识符。更多的信息可以参考CPP手册。
GCC始终支持复杂的宏，它使用一种不同的语法从而可以使你可以给可变参数一个名字，如同其它参数一样。例如下面的例子：

#define debug(format, args…) fprintf(stderr, format, args)

这和上面举的那个ISO C定义的宏例子是完全一样的，但是这么写可读性更强并且更容易进行描述。
GNU CPP还有两种更复杂的宏扩展，支持上面两种格式的定义格式。
在标准C里，你不能省略可变参数，但是你却可以给它传递一个空的参数。例如，下面的宏调用在ISO C里是非法的，因为字符串后面没有逗号：

debug (“A message”)

GNU CPP在这种情况下可以让你完全的忽略可变参数。在上面的例子中，编译器仍然会有问题（complain），因为宏展开后，里面的字符串后面会有个多余的逗号。
为了解决这个问题，CPP使用一个特殊的‘##’操作。书写格式为：

#define debug(format, …) fprintf(stderr, format, ## __VA_ARGS__)

这里，如果可变参数被忽略或为空，‘##’操作将使预处理器（preprocessor）去除掉它前面的那个逗号。如果你在宏调用时，确实提供了一些可变参数，GNU CPP也会工作正常，它会把这些可变参数放到逗号的后面。象其它的pasted macro参数一样，这些参数不是宏的扩展。

示例:

比如说：
#defineDEBUG(fmt, args...) printf(fmt, ##args)
那调用
DEBUG(“test name:%s, age:%d”, “john”, 30);
就相当于调用了printf(“test name:%s, age:%d”, “john”, 30);

// 在实际项目中的应用如下: 
// 假设我有一个输出日志的函数, 用来输出代码出错的详细信息
void LogMessage(
        char const *szFile,             // 文件名
        int nLine,                      // 行号
        const char *szFunction,         // 函数名
        const char *szFormat, ...);

// 为了输出详细的错误信息, 常规应该如下写:
// 但当项目上这样的日志输出非常多的时候,就会发现
// 很繁琐

LogMessgae(
        __XFILE__,      // 文件名
        __LINE__,       // 行号
        __FUNCTION__,   // 函数名
        "ErrorCode: %d, ErrorMsg: %s", 100, "Error1");

LogMessgae(
        __XFILE__,      // 文件名
        __LINE__,       // 行号
        __FUNCTION__,   // 函数名
         "ErrorCode: %d, ErrorMsg: %s", 101, "Error2");

LogMessgae(
        __XFILE__,      // 文件名
        __LINE__,       // 行号
        __FUNCTION__,   // 函数名
         "ErrorCode: %d, ErrorMsg: %s", 102, "Error3");


// 利用上述 "## _VA_ARGS__", 可定义如下的宏

#define LOG_MSG(nLevel, szFormat, ...) \
{ \
LogMessage(__XFILE__, __LINE__, __FUNCTION__, szFormat, ## __VA_ARGS__); \
}\

// 上述日志输出代码替换如下，一下子简洁了许多
LOG_MSG("ErrorCode: %d, ErrorMsg: %s", 100, "Error1");
LOG_MSG("ErrorCode: %d, ErrorMsg: %s", 101, "Error2");
LOG_MSG("ErrorCode: %d, ErrorMsg: %s", 101, "Error3");

 

版权属于：Vimer的程序世界

原文地址：http://www.vimer.cn?p=947