C/C++变长参数实现log输出

__VA_ARGS__宏

使用说明

#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__宏在预编译时会替换成当前的函数名称

sample code:

 //调试信息输出到以下文件
#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 );\
    }\
}　　有了以上这几个宏，特别是有了__VA_ARGS__ ，调试信息的输出就变得灵活多了。

vsnprintf和snprintf

使用说明

vsnprintf和snprintf是C语言printf家族函数的成员，相关函数列表如下：

#include <stdio.h>
int printf(const char *format, ...); //输出到标准输出
int fprintf(FILE *stream, const char *format, ...); //输出到文件
int sprintf(char *str, const char *format, ...); //输出到字符串str中
int snprintf(char *str, size_t size, const char *format, ...); //按size大小输出到字符串str中

以下函数功能与上面的一一对应相同，只是在函数调用时，把上面的…对应的一个个变量用va_list调用所替代。在函数调用前ap要通过va_start()宏来动态获取。

#include <stdarg.h>
int vprintf(const char *format, va_list ap);
int vfprintf(FILE *stream, const char *format, va_list ap);
int vsprintf(char *str, const char *format, va_list ap);
int vsnprintf(char *str, size_t size, const char *format, va_list ap);

可变参数列表va_list宏说明：

void va_start(va_list ap, last); 
void va_end(va_list ap);

va_start与va_end是成对被调用的，
开始的时候被调用va_start，获得各输出变量地址
结束的时候被调用va_end，释放相应的资源
例，通过vsnprintf()实现snprintf()功能：（更多详情可参阅Linux man va_start手册）

sample code:

#include <stdio.h>
#include <stdarg.h>
int my_snprintf(char *s, int size, const char *fmt, ...) //该自定义函数，与系统提供的snprintf()函数相同。
{
    va_list ap;
    int n=0;
    va_start(ap, fmt); //获得可变参数列表
    n=vsnprintf (s, size, fmt, ap); //写入字符串s
    va_end(ap); //释放资源
    return n; //返回写入的字符个数
}
int main() {
    char str[1024];
    my_snprintf( str, sizeof(str), "%d,%d,%d,%d",5,6,7,8);
    printf("%s\n",str);
    return 0;
}

相关测试源码

#include <stdio.h>
#include <stdarg.h>

#define LOG_WRITE_OUT(level, fmt, ...)              \
    do{                                                 \
        writeLog0(level, fmt, ##__VA_ARGS__);           \
    }while(0);

#define writeLog2(level, format, ...)                           \
    do{                                                         \
        printf("debug:[%s %d]\n", __FUNCTION__, __LINE__);      \
        char str2[512 + 1];                                     \
        snprintf(str2, 512, format, ##__VA_ARGS__);             \
        printf("[Msg level:%d]writeLog2 %s\n", level, str2);    \
    }while(0);

static void writeLog1(int level, const char *format, va_list vl)
{
    printf("debug:[%s %d]\n", __FUNCTION__, __LINE__);

    char str[512 + 1] = "";

    int size = vsnprintf(str, 512, format, vl);
    if (size <= 0) {
        return;
    }
    writeLog2(level, "writeLog1 %s", str); //<--param2 将字符串和格式化输出符号放在一个字符串中。
}

static void writeLog0(int level, const char *format, ...)
{
    printf("debug:[%s %d]\n", __FUNCTION__, __LINE__);

    char str[512 + 1] = "";

    va_list arg_ptr;
    va_start(arg_ptr, format);
    writeLog1(level, format, arg_ptr);
    va_end(arg_ptr);
}

int main(int argc, char** argv)
{
    LOG_WRITE_OUT(1, "test: %s %d", __FUNCTION__, __LINE__);
    LOG_WRITE_OUT(1, "test end");
}

输出结果：

debug:[writeLog0 33]
debug:[writeLog1 20]
debug:[writeLog1 28]
[Msg level:1]writeLog2 writeLog1 test: main 46
debug:[writeLog0 33]
debug:[writeLog1 20]
debug:[writeLog1 28]
[Msg level:1]writeLog2 writeLog1 test end

参考资料

• ChinaUnix: __VA_ARGS__用法
• 百度知道: vsnprintf和snprintf区别