va_list,va_start,va_arg,va_end使用说明

在ANSI C中,这些宏的定义位于stdarg.h中,典型的实现如下:

typedef char *va_list;

va_start宏,获取可变参数列表的第一个参数的地址(list是类型为va_list的指针,param1是可变参数最左边的参数):

#define va_start(list,param1) ( list = (va_list)&param1+ sizeof(param1) )

va_arg宏,获取可变参数的当前参数,返回指定类型并将指针指向下一参数(mode参数描述了当前参数的类型):

#define va_arg(list,mode) ( (mode *) ( list += sizeof(mode) ) )[-1]

va_end宏,清空va_list可变参数列表:

#define va_end(list) ( list = (va_list)0 )

注:以上sizeof()只是为了说明工作原理,实际实现中,增加的字节数需保证为为int的整数倍

如:#define _INTSIZEOF(n) ( (sizeof(n) + sizeof(int) - 1) & ~(sizeof(int) - 1) )

为了理解这些宏的作用,我们必须先搞清楚:C语言中函数参数的内存布局。首先,函数参数是存储在栈中的,函数参数从右往左依次入栈。

以下面函数为讨论对象:

1
2
3
4
5
6
void test(char *para1,char *param2,char *param3, char *param4)
{
va_list list;
......
return;
}

在linux中,栈由高地址往低地址生长,调用test函数时,其参数入栈情况如下:

img

当调用va_start(list,param1) 时:list指针指向情况对应下图:

img

最复杂的宏是va_arg。它必须返回一个由va_list所指向的恰当的类型的数值,同时递增va_list,使它指向参数列表中的一个参数(即递增的大小等于与va_arg宏所返回的数值具有相同类型的对象的长度)。因为类型转换的结果不能作为赋值运算的目标,所以va_arg宏首先使用sizeof来确定需要递增的大小,然后把它直接加到va_list上,这样得到的指针再被转换为要求的类型。因为该指针现在指向的位置”过”了一个类型单位的大小,所以我们使用了下标-1来存取正确的返回参数。

下面是实际用例:

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
#include <stdio.h>
#include <stdarg.h>

void var_test(char *format, ...)
{
va_list list;
va_start(list,format);

char *ch;
while(1)
{
ch = va_arg(list, char *);

if(strcmp(ch,"") == 0)
{
printf("\n");
break;
}
printf("%s ",ch);
}
va_end(list);
}

int main()
{
var_test("test","this","is","a","test","");
return 0;
}

附:可变参数应用实例

1.printf实现

1
2
3
4
5
6
7
8
9
10
11
12
#include <stdarg.h>

int printf(char *format, ...)
{
va_list ap;
int n;

va_start(ap, format);
n = vprintf(format, ap);
va_end(ap);
return n;
}

2.定制错误打印函数error

1
2
3
4
5
6
7
8
9
10
11
12
13
#include  <stdio.h>
#include <stdarg.h>

void error(char *format, ...)
{
va_list ap;
va_start(ap, format);
fprintf(stderr, "Error: ");
vfprintf(stderr, format, ap);
va_end(ap);
fprintf(stderr, "\n");
return;
}

原文