C语言可变参数

可变参数

可变参数顾名思义，就是函数参数列表的参数数量是可变的，我们常见的使用可变参数的函数有 scanf 和 printf

可变参数的使用

我们先看一个带有可变参数的函数：

void func(int num, ...)
{
    ;
}

第一个参数 num 还是一个固定参数，后面的 ... 就表示可变参数。通常来说，我们需要在传参时传一个固定参数，来标识可变参数的个数，这对我们使用可变参数的宏是很重要的。

下面是使用可变参数的几个相关宏：

typedef char * va_list; // 可变参数列表

// 获取类型n的大小，但要向上为取整int的整数倍，用于内存地址对齐
#define _INTSIZEOF(n)       ( (sizeof(n)+sizeof(int)-1) & ~(sizeof(int)-1) )

// 初始化 ap 指针，ap即为可变参数列表;使其指向第一个可变参数。v 是变参列表的前一个参数，即最后一个固定参数
#define va_start(ap,v)      ( ap = (va_list)&v + _INTSIZEOF(v) )

// 该宏返回当前变参值,并使 ap 指向列表中的下个变参
#define va_arg(ap, type)    ( *(type *)((ap += _INTSIZEOF(type)) - _INTSIZEOF(type)) )

// /将指针 ap 置为无效，结束变参的获取
#define va_end(ap)             ( ap = (va_list)0 )

_INTSIZEOF(n)

_INTSIZEOF宏考虑到某些系统需要内存地址对齐。从宏名看应按照sizeof(int)即栈粒度对齐，参数在内存中的地址均为sizeof(int)=4的倍数。

例如，若1≤sizeof(n)≤4，则_INTSIZEOF(n)＝4；若5≤sizeof(n)≤8，则_INTSIZEOF(n)=8。

va_start(ap,v)

va_start 初始化可变参数列表 ap ，v 是可变参数的前一个参数，(va_list)&v + _INTSIZEOF(v) 即取出 v 的地址，再跳过该地址，到达下一个地址，即参数列表的第一个地址

va_arg(ap, type)

返回 ap 当前指向的变量，ap 指向下一个变量。首先 ap += _INTSIZEOF(type) ，即 ap 指向下一个变量，然后返回更新后 ap - _INTSIZEOF(type) 的结果，即原 ap 指向的变量

va_end(ap)

va_end 宏使 ap 不再指向有效的内存地址。该宏的某些实现定义为((void*)0)，编译时不会为其产生代码，调用与否并无区别。但某些实现中 va_end 宏用于在函数返回前完成一些必要的清理工作：如 va_start 宏可能以某种方式修改栈，导致返回操作无法完成，va_end 宏可将有关修改复原；又如 va_start 宏可能为参数列表动态分配内存以便于遍历，va_end 宏可释放此内存。因此，从使用 va_start 宏的函数中退出之前，必须调用一次 va_end 宏。

使用技巧

变参宏无法智能识别可变参数的数目和类型，因此实现变参函数时需自行判断可变参数的数目和类型。所以我们就要想一些办法，比如

1. 显式提供变参数目或设定遍历结束条件
2. 显式提供变参类型枚举值，或在固定参数中包含足够的类型信息(如 printf 函数通过分析 format 字符串即可确定各变参类型)
3. 主调函数和被调函数可约定变参的数目和类型
4. …

示例

函数通过传入固定参数指定可变参数的个数，获取所有参数相加的结果：

// 第一个参数为可变参数的个数
int sum(int num, ...)
{
    va_list ap;
    va_start(ap, num);

    int sum = 0;
    for (int i = 0; i < num; ++i)
    {
        sum += va_arg(ap, int);
    }

    va_end(ap);

    return sum;
}

int main()
{
    int ret = sum(3, 2, 1, 2);
    printf("%d\n", ret);

    return 0;
}