C/C++宏定义中可变参数 __VA_ARGS__ 的理解

最新推荐文章于 2024-06-18 10:44:23 发布

彷徨而立

最新推荐文章于 2024-06-18 10:44:23 发布

阅读量6.9k

点赞数 5

分类专栏： C/C++

本文链接：https://blog.csdn.net/lijian2017/article/details/104836447

版权

C/C++ 专栏收录该内容

30 篇文章 2 订阅

订阅专栏

用可变参数宏(variadic macros)传递可变参数表

你可能很熟悉在函数中使用可变参数表，如:

void printf(const char* format, ...);

一直以来，可变参数表还是只能应用在真正的函数中，不能使用在宏中。

C99编译器标准终于改变了这种局面，它允许你可以定义可变参数宏(variadic macros)，这样你就可以使用拥有可以变化的参数表的宏。可变参数宏就像下面这个样子:

#define debug(...) printf(__VA_ARGS__)

缺省号代表一个可以变化的参数表。使用保留名 __VA_ARGS__把参数传递给宏。当宏的调用展开时，实际的参数就传递给 printf()了。例如:

Debug("Y = %d\n", y); //两个参数

而处理器会把宏的调用替换成：

printf("Y = %d\n", y);

因为debug()是一个可变参数宏，你能在每一次调用中传递不同数目的参数：

Debug("test"); //一个参数

可变参数宏不被ANSI/ISO C++ 所正式支持。因此，你应当检查你的编译器，看它是否支持这项技术。

用GCC和C99的可变参数宏，更方便地打印调试信息

gcc的预处理提供的可变参数宏定义真是好用：

#ifdef DEBUG
#define dbgprint(format,args...)  fprintf(stderr, format, ##args)
#else
#define dbgprint(format,args...)
#endif

如此定义之后，代码中就可以用dbgprint了，
例如dbgprint("aaa %s", FILE);。感觉这个功能比较cool

下面是C99的方法：

#define dgbmsg(fmt,...)  printf(fmt, __VA_ARGS__)

新的C99规范支持了可变参数的宏 __VA_ARGS__

具体使用如下：
以下内容为程序代码:

 #include <stdarg.h> 
 #include <stdio.h>
 #define LOGSTRINGS(fm, ...) printf(fm, __VA_ARGS__)

 int main() 
 {
 	LOGSTRINGS("hello, %d ", 10);      
 	return 0; 
 }

但现在似乎只有gcc才支持（VC从VC2005开始支持）。

可变参数的宏里的‘##’操作说明

带有可变参数的宏（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参数一样，这些参数不是宏的扩展。

怎样写参数个数可变的宏

一种流行的技巧是用一个单独的用括弧括起来的的 “参数” 定义和调用宏, 参数在宏扩展的时候成为类似 printf() 那样的函数的整个参数列表。

#define DEBUG(args) (printf("DEBUG: "), printf args)

if(n != 0) DEBUG(("n is %d\n", n));

明显的缺陷是调用者必须记住使用一对额外的括弧。

gcc 有一个扩展可以让函数式的宏接受可变个数的参数。但这不是标准。另一种可能的解决方案是根据参数个数使用多个宏 (DEBUG1, DEBUG2, 等等), 或者用逗号玩个这样的花招:

#define DEBUG(args) (printf("DEBUG: "), printf(args))
#define _ ,    DEBUG("i = %d" _ i);

C99 引入了对参数个数可变的函数式宏的正式支持。在宏 "原型" 的末尾加上符号 … (就像在参数可变的函数定义中), 宏定义中的伪宏 __VA_ARGS__就会在调用时替换成可变参数。

最后, 你总是可以使用真实的函数, 接受明确定义的可变参数

如果你需要替换宏, 使用一个函数和一个非函数式宏, 如 #define printf myprintf。

自定义调试信息的输出

调试信息的输出方法有很多种, 例如直接用printf, 或者出错时使用perror, fprintf等将信息直接打印到终端上, 在Qt上面一般使用qDebug，而守护进程则一般是使用syslog将调试信息输出到日志文件中等等…
　　使用标准的方法打印调试信息有时候不是很方便, 例如Qt编程, 在调试已有的代码时, 我想在打印调试信息的地方, 把代码位置也打印出来以方便定位错误, 或者需要在调试信息前面加一个前辍, 好方便在调试信息太多的时候可以用grep过滤一下, 仅显示本模块的调试信息, 这时就需要一个一个地修改已有的qDebug, 使其成为以下形式:

qDebug( "[模块名称] 调试信息  File:%s, Line:%d", __FILE__, __LINE__ );

这样的修改比较烦人, 而且一不小心会遗漏某个没改的…
　　为了能方便地管理调试信息的输出，一个比较简单的方法就是自已定义一个打印调试信息的宏, 然后替换原来的，废话就不多说了，直接给出一个现成的，下面是一个例子, 我用WiFi表示当前代码的模块名称，我要求在模块中的所有调试信息前面均带有[WiFi]前辍，这样我就能方便地只需使用命令行

| grep "WiFi"

来过滤掉来自其它模块的调试信息了:

#define qWiFiDebug(format, ...) qDebug("[WiFi] "format" File:%s, Line:%d, Function:%s", \
 	##__VA_ARGS__, __FILE__, __LINE__ , __FUNCTION__);

上面的宏是使用qDebug输出调试信息，在非Qt的程序中也可以改为printf，守护进程则可以改为syslog等等… 其中，决窍其实就是这几个宏 ##__VA_ARGS__, __FILE__, __LINE__ 和__FUNCTION__,下面介绍一下这几个宏:
　　1) __VA_ARGS__是一个可变参数的宏，很少人知道这个宏，这个可变参数的宏是新的C99规范中新增的，目前似乎只有gcc支持（VC6.0的编译器不支持）。宏前面加上 ## 的作用在于，当可变参数的个数为0时，这里的 ## 起到把前面多余的","去掉的作用,否则会编译出错, 你可以试试。
　　2) __FILE__宏在预编译时会替换成当前的源文件名
　　3) __LINE__ 宏在预编译时会替换成当前的行号
　　4) __FUNCTION__宏在预编译时会替换成当前的函数名称
　　有了以上这几个宏，特别是有了__VA_ARGS__，调试信息的输出就变得灵活多了。
　　有时，我们想把调试信息输出到屏幕上，而有时则又想把它输出到一个文件中，可参考下面的例子：

//debug.c
#include 
#include
//开启下面的宏表示程序运行在调试版本, 否则为发行版本, 这里假设只有调试版本才输出调试信息
#define _DEBUG
#ifdef _DEBUG
    //开启下面的宏就把调试信息输出到文件，注释即输出到终端
    #define DEBUG_TO_FILE
    #ifdef DEBUG_TO_FILE
        //调试信息输出到以下文件
        #define DEBUG_FILE "/tmp/debugmsg"
        //调试信息的缓冲长度
        #define DEBUG_BUFFER_MAX 4096
        //将调试信息输出到文件中
        #define printDebugMsg(moduleName, format, ...) {\
            char buffer[DEBUG_BUFFER_MAX+1]={0};\
            snprintf( buffer, DEBUG_BUFFER_MAX \
                    , "[%s] "format" File:%s, Line:%d\n", moduleName, ##__VA_ARGS__, __FILE__, __LINE__ );\
            FILE* fd = fopen(DEBUG_FILE, "a");\
            if ( fd != NULL ) {\
                fwrite( buffer, strlen(buffer), 1, fd );\
                fflush( fd );\
                fclose( fd );\
            }\
        }
    #else
        //将调试信息输出到终端
        #define printDebugMsg(moduleName, format, ...) \
                  printf( "[%s] "format" File:%s, Line:%d\n", moduleName, ##__VA_ARGS__, __FILE__, __LINE__ );
    #endif //end for #ifdef DEBUG_TO_FILE
#else
    //发行版本，什么也不做
    #define printDebugMsg(moduleName, format, ...)
#endif  //end for #ifdef _DEBUG
int main(int argc, char** argv)
{
    int data = 999;
    printDebugMsg( "TestProgram", "data = %d", data );
    return 0;
}

上面也说了，只有支持C99规范的gcc编译器才有__VA_ARGS__这个宏，如果不是gcc编译器，或者所用的gcc编译器版本不支持__VA_ARGS__宏怎么办？可参考下面的代码片段，我们换一种做法，可先将可变参数转换成字符串后，再进行输出即可:

void printDebugMsg( const char* format, ...)
{
    char buffer[DEBUG_BUFFER_MAX_LENGTH + 1]={0};
    va_list arg;
    va_start (arg, format);
    vsnprintf(buffer, DEBUG_BUFFER_MAX_LENGTH, format, arg);
    va_end (arg);
    printf( "%s", buffer );
}

本人在工作中的碰到的一些样例：

使用VS2010 测试下面代码:

#include <stdio.h>
#define ExampleIndex  9

#define _Dbg(...)  printf(__VA_ARGS__)
#define Dbg(fmt, ...) _Dbg("[Example:%d]  "fmt" \n", ExampleIndex, __VA_ARGS__)

int main()
{
	Dbg("hello world");  //compiler error C2059: 语法错误:“)”

	return 0;
}

上面这个例子VS2010编译出错：error C2059: 语法错误:“)”

原因上面也有讲到，

#define TEST(...)  XXX(__VA_ARGS__)

如果宏定义是上面这种格式，对__VA_ARGS__无任何特殊要求。

#define TEST(fmt, ...) XXX(fmt, __VA_ARGS__)

如果宏定义是上面这种格式，对__VA_ARGS__有限制，__VA_ARGS__不能为空，即至少有一个参数，否则宏展开后，宏体里面的 fmt 后面会有个多余的逗号' , ' 这时VS2010编译器会报错：error C2059: 语法错误:“)” 。

根据往常资料和本人测试，上面例子有三种解决方案：

1. 在 TEST(fmt, ...) 使用时，' ... '必须至少有一个参数，没有就手动添加一个参数

#include <stdio.h>

#define ExampleIndex  9

#define _Dbg(...)  printf(__VA_ARGS__)
#define Dbg(fmt, ...) _Dbg("[Example:%d]  "fmt" \n", ExampleIndex, __VA_ARGS__)

int main()
{
	Dbg("hello world", 999);// "hello world" 后面随便增加一个参数就行，实际打印并不输出这个参数

	return 0;
}

编译通过，运行结果如下：

2. 在宏定义中 __VA_ARGS__前面添加操作符 ##

网上资料说，如果可变参数__VA_ARGS__被忽略或为空，‘##’操作将使预处理器（preprocessor）去除掉它前面的那个逗号。格式如下：

#define TEST(fmt, ...) XXX(fmt, ##__VA_ARGS__)

然而VS2010 实际测试中并没卵用，还是报错：error C2059: 语法错误:“)”


#include <stdio.h>

#define ExampleIndex  9

#define _Dbg(...)  printf(__VA_ARGS__)
#define Dbg(fmt, ...) _Dbg("[Example:%d]  "fmt" \n", ExampleIndex, ##__VA_ARGS__)

int main()
{
	Dbg("hello world"); // compiler error C2059: 语法错误:“)”

	getchar();
	return 0;
}

编译失败报错：error C2059: 语法错误:“)”

3. 将嵌套宏的每层宏定义中的可变参数都由 TEST( ...) 改成 TEST(fmt, ...) 格式

#include <stdio.h>

#define ExampleIndex  9

#define _Dbg(fmt, ...)  printf(fmt, __VA_ARGS__)
#define Dbg(fmt, ...) _Dbg("[Example:%d]  "fmt" \n", ExampleIndex, __VA_ARGS__)

int main()
{
	Dbg("hello world");

	getchar();
	return 0;
}

编译通过，运行结果如下：

PS：Dbg(fmt, ...) 此类宏定义中字符串连接有两种方式：

#define TEST(fmt, ...) XXX("[TEST]"fmt"", __VA_ARGS__)

#define TEST(fmt, ...) XXX("[TEST]"##fmt, __VA_ARGS__)

注意，在C语言中字符串中的二个相连的双引号会被自动忽略

VS2010样例：

#include <stdio.h>

#define ExampleIndex  9

#define _Dbg(fmt, ...)  printf(fmt, __VA_ARGS__)
#define Dbg(fmt, ...)  _Dbg("[Dbg ][Example:%d]"fmt" \n", ExampleIndex, __VA_ARGS__)
#define Dbg2(fmt, ...) _Dbg("[Dbg2][Example:%d]"##fmt, ExampleIndex, __VA_ARGS__)

int main()
{
	Dbg("hello world");
	Dbg2("hello world");
	getchar();
	return 0;
}

编译运行结果如下：

PS：Dbg(...) 此类宏定义中字符串连接只有一种方式：

#define TEST(...) XXX("[TEST]"##__VA_ARGS__)

C99中可变参数宏对应的可变参数个数为0时，存在一个众所周知的问题：

#define FOO(...)       printf(__VA_ARGS__)
#define BAR(fmt, ...)  printf(fmt, __VA_ARGS__)

FOO("this works fine");
BAR("this breaks!");

BAR()根据C99标准，上述的使用确实是不正确的，因为它将扩展为：

printf("this breaks!",); // 字符串后面多了一个逗号

请注意结尾的逗号-不可行。

一些编译器（例如：Visual Studio 2010）将悄悄地为您消除尾随的逗号。其他编译器（例如：GCC）也支持放在##前面__VA_ARGS__，例如：

#define BAR(fmt, ...)  printf(fmt, ##__VA_ARGS__)

例子：

// VS2010 （x86）编译测试
#define DD(a)  a
#define EE(a) DD(a,)
#define FF(a) DD(a,100)
	cout<<DD(1,)<<endl;
	cout<<DD(1,100)<<endl;
	cout<<EE(1)<<endl;
	cout<<FF(1)<<endl;

上面代码编译运行正常，四行输出都是1。这说明编译器会自动匹配DD(a)的参数个数，多余的参数或逗号都被编译器去除了

彷徨而立

关注

5
点赞
踩
26

收藏

觉得还不错? 一键收藏
2
评论
C/C++宏定义中可变参数 __VA_ARGS__ 的理解

用可变参数宏(variadic macros)传递可变参数表你可能很熟悉在函数中使用可变参数表，如:void printf(const char* format, ...);一直以来，可变参数表还是只能应用在真正的函数中，不能使用在宏中。C99编译器标准终于改变了这种局面，它允许你可以定义可变参数宏(variadic macros)，这样你就可以使用拥有可以变化的参数表的宏。可...
复制链接

扫一扫