__attribute__((sentinel))
的作用是提醒程序员:“此可变参数函数需要一个NULL作为最后一个参数。”,而这个NULL参数一般被叫做“哨兵参数”。
比如下面这段程序:
#include <stdio.h>
#include <stdarg.h>
#include <string.h>
#include <malloc.h>
void foo(char *first, ...)
{
char *p = (char *)malloc(100), *q = first;
va_list args;
va_start(args, first);
while(q)
{
strcat(p, q);
q = va_arg(args, char *);
}
va_end(args);
printf("%s\n", p);
free(p);
return ;
}
int main(void)
{
foo("Hello", "World");
return 0;
}
使用
gcc main.c -Wall
编译没有任何警告。但是很显然,调用foo()时最后一个参数应该是个NULL以表明“可变参数就这么多”。
程序的运行结果:
HelloWorldm1�i�
显然是错误的。
另:这段程序在某些时候可能运行正常,那是因为在当时的情况下内存中存放”World”字符串的后面正好是个0(也就是NULL)。
将调用foo()的地方改为
foo("Hello", "World", NULL);
才是正确的写法。
但是为什么这种问题编译器不发出警告?那是因为你没有让编译器发出这类问题的警告,因为不是所有可变参数函数都需要哨兵参数,比如printf()。
/* 第一个参数中规定了有两个待打印项,所以打印时会取"string"和1,
* 多写的"another_string"会被忽略。
* printf()在被调用时明确知道此次调用需要多少个参数,所以也就无需哨兵参数的帮忙。
*/
printf("%s %d\n", "string", 1,"another_string");
所以__attribute__((sentinel))
的功能就在于此。我们把上面的程序改一下,加一句foo()的声明:
void foo(char *first, ...) __attribute__((sentinel));
这样你再不写哨兵参数,在编译时编译器就会发出警告了:
main.c: In function ‘main’:
main.c:28:5: warning: missing sentinel in function call [-Wformat=]
foo(“Hello”, “World”);
^