【C语言】如何写一个参数可变的函数

问题提出

在C语言开发中，有时候需要写一个参数可变的函数，类似于print打印函数一样，可以接收多个任意参数。那么，我们应该怎样写呢？答案是：使用stdarg.h头文件。

stdarg.h

stdarg.h头文件正是解决这个问题而生，不过其用法比较繁琐，必须按照如下步骤进行：
1. 一个使用省略号的函数原型；
2. 在函数定义中创建一个va_list类型的变量；
3. 用宏把该变量初始化为一个参数列表；
4. 用宏访问参数列表；
5. 用宏清理

该函数原型必须有一个形参和一个省略号，例如：

void foo1(int lim, ...);                //有效
void foo2(const char *s, int k, ...);   //有效
char foo3(char c1, ... , char c2);      //无效，省略后不在后面
double foo4(...);                       //无效，没有形参

最右边的形参（省略号的前一个形参）有特殊的作用（在标准中用parmN描述这个形参），程序员要手动给该形参传递省略号部分参数的数量。例如：

f1(2, 200, 500);    //两个额外的参数
f2(3, 1, 2, 3);     //三个额外的参数

详细使用步骤

va_list

接下来，声明在stdarg.h中的va_list类型代表一种用于储存形参列表中省略号部分的数据对象。变參函数的定义起始部分类似下面：

double sum(int lim, ...)
{
    va_list ap;    //声明一个储存参数的对象

va_start()

然后，使用va_start()宏，把参数列表拷贝到va_list的变量中。va_list有两个参数：va_list类型的变量和parmN形参。

    va_start(ap, lim);//把ap初始化为参数列表

va_arg()

下一步是访问参数列表的内容，这里用到va_arg()宏。该宏接收两个参数：va_list类型的变量和类型名。
第一次调用时，返回省略号的第一个形参；第二次调用返回第二个，以此类推。

double tic;
int toc;

tic = va_arg(ap, double);//获取第一个参数
toc = va_arg(ap, int);  //获取第二个参数

注意，传入的参数类型必须与传递给省略号的参数相匹配，否则会出错。

va_end()

最后，使用va_end()宏完成清理工作。例如释放动态分配储存参数的内存。该宏接收一个va_list类型的参数。

va_end(ap);

调用va_end(ap)后，只有用va_start重新初始化ap后，才能使用变量ap。

va_copy()

因为va_arg()不提供退回之前参数的方法，所以可能会有保存va_list类型变量的需求。在C99中新增了一个宏处理这样的问题：va_copy()。该宏接受两个va_list类型的形参，它把第二个参数拷贝给第一个参数。

va_list ap;
va_list apcopy;
va_copy(apcopy, ap);

此时，即使删除了ap，也可以从apcopy中检索数据。

程序清单

varargs.c程序示例了如何使用stdarg.h，开发环境是VS2013。

#include "stdafx.h"
#include <stdarg.h>

double sum(int, ...);

int _tmain(int argc, _TCHAR* argv[])
{
    double s, t;

    s = sum(3, 1.1, 2.5, 13.3);
    t = sum(6, 1.1, 2.1, 13.1, 4.1, 5.1, 6.1);
    printf("return value for "
        "sum(3, 1.1, 2.5, 13.3): %g\n", s);
    printf("return value for "
        "sum(6, 1.1, 2.1, 13.1, 4.1, 5.1, 6.1): %g\n", t);

    return 0;
}

double sum(int lim, ...)
{
    va_list ap;
    double tot = 0;
    int i;

    va_start(ap, lim);
    for (i = 0; i < lim; i++){
        tot += va_arg(ap, double);
    }
    va_end(ap);

    return tot;
}

打印：

return value for sum(3, 1.1, 2.5, 13.3): 16.9
return value for sum(6, 1.1, 2.1, 13.1, 4.1, 5.1, 6.1): 31.6

结语

由于本人有单片机的开发经历，于是在ESP8266开发环境下测试了该例程，stdarg.h头文件在ESP8266下是可以使用的，也可以写参数可变的函数，但是要注意ESP8266不支持double类型。另外，我用的ESP8266编译器是Cygwin GCC。当然，Keil环境下也是可以使用stdarg.h的。