一个可变参数类型检查的示例

GNU/Linux程序 775 字 次

最近在修正代码警告，发现封装的打印语句不会进行参数的类型检查，而用printf却是可以的。于是上网找了下资料，学习了一下。

对于函数参数类型的检查，在gcc环境中可以使用attribute((format(printf,N,M)))的形式。其中N表示第几个参数是格式化字符串，M指明从第几个参数开始做检查。对于__attribute__，等有空专门学习一下再写篇文章出来。
下面是可变参数的一个简单例子my_printf函数：

1
2
3
4
5
6
7
8
9
10
11
12
13
void my_printf(const char* fmt, ...)
{
#define LINE_SIZE 1024
    char buffer[LINE_SIZE] = {0};
    va_list vl;

    va_start(vl, fmt);

    vsprintf(buffer, fmt, vl);
    fputs(buffer, stdout);

    va_end(vl);
}

代码不复杂，使用了va_list等几个宏和vsprintf来实现可变参数。但调用my_printf不会进行参数类型检查。
测试例子如下：

1
2
3
4
5
6
7
8
void simple_test(void)
{
    int a = 250;
    char* p = NULL;
    my_printf("hehe %d, %s\n", p, a);
    my_printf("ddd: %d\n");
    my_printf("ddd: \n", a);
}

我就乱用整型、指针，甚至多参数少参数，但编译没有警告，原因就是my_printf不够严格，当然对于指针的打印，可以使用%d，但如果使用%s来打印一个整数，就会有段错误，如果在编译阶段就能看到警告，就不会等到运行时才发现，特别是当代码工程大，而打印语句在一定条件下才触发，问题就更难找了。因此，对函数的参数进行严格的检查是很有必要的。上例中，把声明改为：

1
void my_printf(const char* fmt, ...) __attribute__((format(printf,1,2)));

这样就解决问题了。 对于上面的示例，编译会提到有警告，如下：

1
2
3
4
5
test.cpp: In function ‘void simple_test()’:
test.cpp:32: warning: format ‘%d’ expects type ‘int’, but argument 2 has type ‘char*’
test.cpp:32: warning: format ‘%s’ expects type ‘char*’, but argument 3 has type ‘int’
test.cpp:33: warning: too few arguments for format
test.cpp:34: warning: too many arguments for format

使用__attribute__((format(printf,N,M)))的函数形式基本固定，最后的参数是省略号。比如经典的API：

1
2
3
4
5
int printf(const char *format, ...);
int fprintf(FILE *stream, const char *format, ...);
int sprintf(char *str, const char *format, ...);
int snprintf(char *str, size_t size, const char *format, ...);
void syslog(int priority, const char *format, ...);

如果N、M指定的位置不对，编译会报错，提示：

1
error: format string argument not a string type

特别要说明的是在C++类中如使用attribute((format(printf,N,M)))则要注意参数位置，C++默认隐藏有this指针，所以N、M的值要加1。但是类的静态成员没有this指针。 附上使用C++类封装的例子：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class MyPrintf
{
public:
    // 静态成员无this
    static void print(int level, const char* fmt, ...) __attribute__((format(printf,2,3)));
    // 有this指针
    void print(int level, int level2, const char* fmt, ...) __attribute__((format(printf,4,5)));
};

void MyPrintf::print(int level, const char* fmt, ...)
{
#define LINE_SIZE 1024
    char buffer[LINE_SIZE] = {0};
    va_list vl;

    va_start(vl, fmt);

    vsprintf(buffer, fmt, vl);
    printf("[%d] ", level);
    fputs(buffer, stdout);

    va_end(vl);
}

void MyPrintf::print(int level, int level2, const char* fmt, ...)
{
#define LINE_SIZE 1024
    char buffer[LINE_SIZE] = {0};
    va_list vl;

    va_start(vl, fmt);

    vsprintf(buffer, fmt, vl);
    printf("[%d %d] ", level, level2);
    fputs(buffer, stdout);

    va_end(vl);
}

李迟 2015.4.23 周四 中午