【C语言学习笔记】40. 可变参数

前言

有时，您可能会碰到这样的情况，您希望函数带有可变数量的参数，而不是预定义数量的参数。

可变参数

有时，您可能会碰到这样的情况，您希望函数带有可变数量的参数，而不是预定义数量的参数。C 语言为这种情况提供了一个解决方案，它允许您定义一个函数，能根据具体的需求接受可变数量的参数。下面的实例演示了这种函数的定义。

int func(int, ... ) 
{
   .
   .
   .
}
 
int main()
{
   func(2, 2, 3);
   func(3, 2, 3, 4);
}

请注意，函数 func() 最后一个参数写成省略号，即三个点号（…），省略号之前的那个参数是 int，代表了要传递的可变参数的总数。为了使用这个功能，您需要使用 stdarg.h 头文件，该文件提供了实现可变参数功能的函数和宏。具体步骤如下：

1. 定义一个函数，最后一个参数为省略号，省略号前面可以设置自定义参数。
2. 在函数定义中创建一个 va_list 类型变量，该类型是在 stdarg.h 头文件中定义的。
3. 使用 int 参数和 va_start 宏来初始化 va_list 变量为一个参数列表。宏 va_start 是在 stdarg.h 头文件中定义的。
4. 使用 va_arg 宏和 va_list 变量来访问参数列表中的每个项。
5. 使用宏 va_end 来清理赋予 va_list 变量的内存。

现在让我们按照上面的步骤，来编写一个带有可变数量参数的函数，并返回它们的平均值：

实例

#include <stdio.h>
#include <stdarg.h>
 
double average(int num,...)
{
 
    va_list valist;
    double sum = 0.0;
    int i;
 
    /* 为 num 个参数初始化 valist */
    va_start(valist, num);
 
    /* 访问所有赋给 valist 的参数 */
    for (i = 0; i < num; i++)
    {
       sum += va_arg(valist, int);
    }
    /* 清理为 valist 保留的内存 */
    va_end(valist);
 
    return sum/num;
}
 
int main()
{
   printf("Average of 2, 3, 4, 5 = %f\n", average(4, 2,3,4,5));
   printf("Average of 5, 10, 15 = %f\n", average(3, 5,10,15));
}

当上面的代码被编译和执行时，它会产生下列结果。应该指出的是，函数 average() 被调用两次，每次第一个参数都是表示被传的可变参数的总数。省略号被用来传递可变数量的参数。

Average of 2, 3, 4, 5 = 3.500000
Average of 5, 10, 15 = 10.000000

可变参数的工作原理

可变参数的工作原理,以32位机为例:

1.函数参数的传递存储在栈中,从右至左压入栈中,压栈过程为递减。
2.参数的传递以4字节对齐,float/double这里不讨论。

#include <stdio.h>

void debug_arg(unsigned int num, ...) 
{
    unsigned int i = 0;
    unsigned int *addr = &num;
    for (i = 0; i <= num; i++) 
    {
        /* *(addr + i) 从左往右依次取出传递进来的参数,类似于出栈过程 */
        printf("i=%d,value=%d\r\n", i, *(addr + i));
    }
}
int main(void)
{
    debug_arg(3, 66, 88, 666);
    return 0;
}

C 函数要在程序中用到以下这些宏:

void va_start( va_list arg_ptr, prev_param );
type va_arg( va_list arg_ptr, type );
void va_end( va_list arg_ptr );

va_list: 用来保存宏va_start、va_arg和va_end所需信息的一种类型。为了访问变长参数列表中的参数，必须声明 va_list 类型的一个对象，定义： typedef char * va_list;

va_start: 访问变长参数列表中的参数之前使用的宏，它初始化用 va_list 声明的对象，初始化结果供宏 va_arg 和 va_end 使用；

va_arg: 展开成一个表达式的宏，该表达式具有变长参数列表中下一个参数的值和类型。每次调用 va_arg 都会修改用 va_list 声明的对象，从而使该对象指向参数列表中的下一个参数；

va_end: 该宏使程序能够从变长参数列表用宏 va_start 引用的函数中正常返回。

va 在这里是 variable-argument(可变参数) 的意思。

这些宏定义在 stdarg.h 中，所以用到可变参数的程序应该包含这个头文件。

下面我们写一个简单的可变参数的函数，改函数至少有一个整数参数，第二个参数也是整数，是可选的。函数只是打印这两个参数的值。

#include <stdio.h>;  
#include <string.h>;  
#include <stdarg.h>;  

/* ANSI标准形式的声明方式，括号内的省略号表示可选参数 */  
int demo(char *msg, ... )  
{  
    va_list argp;                    /* 定义保存函数参数的结构 */  
    int argno = 0;                    /* 纪录参数个数 */  
    char *para;                        /* 存放取出的字符串参数 */                                      
    va_start( argp, msg );          /* argp指向传入的第一个可选参数，      msg是最后一个确定的参数 */  
    
    while (1) 
    {  
        para = va_arg( argp, char *);                 /*      取出当前的参数，类型为char *. */  
        if ( strcmp( para, "/0") == 0 )  
                                                      /* 采用空串指示参数输入结束 */  
            break;  
        printf("Parameter #%d is: %s/n", argno, para);  
        argno++;  
    }  
    va_end( argp );                                   /* 将argp置为NULL */  
    return 0;  
}

int main( void )  
{  
    demo("DEMO", "This", "is", "a", "demo!" ,"333333", "/0");  
}    

从这个函数的实现可以看到,我们使用可变参数应该有以下步骤:

1)首先在函数里定义一个 va_list 型的变量,这里是 arg_ptr，这个变量是指向参数的指针。
2)然后用 va_start 宏初始化变量 arg_ptr，这个宏的第二个参数是第一个可变参数的前一个参数，是一个固定的参数。
3)然后用 va_arg 返回可变的参数，并赋值给整数 j。va_arg 的第二个参数是你要返回的参数的类型，这里是int型。
4)最后用 va_end 宏结束可变参数的获取。然后你就可以在函数里使用第二个参数了。如果函数有多个可变参数的，依次调用 va_arg 获取各个参数。

stdarg.h 中的函数源码注释

// 本质上，va_list 类型，就是「char指针」类型，指向 1B 大小的内存地址
typedef char* va_list;
// 把 n 圆整到 sizeof(int) 的倍数，和内存的边界对齐有关，下面移动指针、计算地址时会用到
// 函数的参数都是压栈传递，在内存中连续分布，每个参数的地址均为 sizeof(int) 的整数倍
#define _INTSIZEOF(n) ( (sizeof(n)+sizeof(int)-1) & ~(sizeof(int)-1) )
// 初始化 ap 指针，使其指向第一个可变参数。v 是变参列表的前一个参数
// 对参数 v 取地址，转成 char* 类型的地址，再加上 v 的大小，ap 就指向了下一个参数地址，
// 即第一个「可变参数」的地址
#define va_start(ap,v) ( ap = (va_list)&v + _INTSIZEOF(v) )
// 该宏返回「当前变参值」,并使 ap 指向列表中的「下个变参」
// 把当前 ap 所指参数称为「第i个参数」
// 获取「第i个参数」的大小，圆整到 int 大小的整数倍（为了边界对齐）：_INTSIZEOF(type)
// 为 ap 加上「圆整后的大小」，使 ap 更新，指向「第i+1个参数」的地址
// 此刻，「更新后的 ap 」减「圆整后的大小」，就是「第i个参数」的地址，类型为 char*
// 「第i个参数」的地址转为「type*」类型：(type*)
// 再用 * 对「转换类型后的地址」取值
// 最终，就得到了「第i个参数」，同时 ap 也指向了「第i+1个参数」地址
#define va_arg(ap, type) ( \*(type\*)((ap += _INTSIZEOF(type)) - _INTSIZEOF(type)) )
// 将指针 ap 置为无效，结束变参的获取
// 本质上就是将一个 char* 指针指向 0 地址
#define va_end(ap) ( ap = (va_list)0 )

// 64 位机器用 8 字节对齐, 32 位 4 位对齐
#ifdef X64
#defin t long long
#else
#define t int
#endif

//VA_LIST套宏中可以使用，用来改变INTSIZEOF中t的类型
//固定参数详见
void test(int a, double b, char* c)
{
    char *p = (char*)&a;
    //因为&a = void 类型 需要转换,void * =&a 不需要转换但是使用时要转换
    printf("%p %p %p\n", &a, &b, &c);
    //观察地址变化
    printf("%p %s",(p+8),*(char**)(p+8+8));//64位机器时加8内存大小8字节对齐
    return;
}

//可变参数实验
void test1(char* s,char *st,...)
{
    char *ppt =(char*)&s;
    //printf("%p %p %p %p,",ppt,&s,&st,(char*)ppt+8);
    printf("%p %p %p %p\n", ppt, &s, &st, ppt + 8);
    printf("%s\n", *(char**)(ppt+4));
    printf(" %d\n",*(int*)(ppt + 4+4));//当是X64就加8 X86就加4因为内存对齐规则
    return;
}

int main()
{
    char *p = "Hello world";
    test1("111","eee",45234,23);
    //test(2, 2.2, "Hello world");x
    void *s = &p;
    printf("%s", *(char**)s);
    return 0;
}