C语言可变参数函数
crazyang Lv1

可变参数函数概念

C99中,出现了函数变长参数特性,例如:printf 就可以接受任意长度的参数列表。看一下 printf 函数的定义:

1
int printf (const char* format, ...);

可以看到可变参数除了有一个 format 固定外,其他参数的个数和类型就是可变的,用三个点 ... 作为参数占位符,代表可变参数。

任何一个可变参数的函数都可以分为两部分:固定参数和可选参数。至少要有一个固定参数,其声明与普通函数参数声明相同。可选参数由于数目不定(0个或以上),声明时用 ... 表示。固定参数和可选参数共同构成可变参数函数的参数列表。

由于参数数目不定,使用可变参数函数通常能缩短编码,灵活性和易用性较高。上面的 printf 函数除了format 固定外,其他参数都可以变化。实际调用可以是如下方式:

1
2
3
printf("%d", i); 
printf("%s", s);
printf("number is %d, string is:%s", i, s);

可变参数函数原理

C 语言中,使用 va_list 系列变长宏实现可变参数函数,va 开头代表 variable-argument (可变参数)。典型的用法如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
//以固定参数的地址为起点依次确定各变参的内存起始地址
int VaArgFunc(int dwArgCnt, ...)
{
//定义va_list类型的指针pArgs,用于存储参数地址
va_list pArgs;
//该宏返回变参列表中的当前变参值并使pArgs指向列表中的下个变参。
//该宏第二个参数是要返回的当前变参类型
va_start(pArgs, dwArgCnt);
//若函数有多个可变参数,则依次调用va_arg宏获取各个变参
int dwVal = va_arg(pArgs, int);
//将指针pArgs置为无效,结束变参的获取
va_end(pArgs);
}

Linux 在 varargs.h 头文件中定义变长宏,变参宏的定义和实现因操作系统、硬件平台及编译器而异(但原理相似)。

X86 平台的 VC6.0 编译器中,stdarg.h头文件内变参宏定义如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
typedef char * va_list;

// 把 n 圆整到 sizeof(int) 的倍数,
#define _INTSIZEOF(n) ( (sizeof(n)+sizeof(int)-1) & ~(sizeof(int)-1) )

// 初始化 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 宏首先根据 (va_list)&v 得到参数 v 在栈中的内存地址,加上 _INTSIZEOF(v) 即 v 所占内存大小后,使 ap 指向 v 的下一个参数。在使用的时候,一般用这个宏初始化 ap 指针,v 是变参列表的前一个参数,即最后一个固定参数,初始化的结果是 ap 指向第一个变参。

va_arg(ap, type)
这个宏取得 type 类型的可变参数值。首先 ap += _INTSIZEOF(type),即 ap 跳过当前可变参数而指向下个变参的地址;然后 ap - _INTSIZEOF(type) 得到当前变参的内存地址,类型转换后解引用,最后返回当前变参值。

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. 主调函数和被调函数可约定变参的数目和类型等。

例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
29
30
31
#include <iostream>
#include <stdarg.h>
#include <stdio.h>

void parse_valist_by_num(int arg_cnt, ...);

int main(void)
{
parse_valist_by_num(4, 1, 2, 3, 4);
parse_valist_by_num(4, 1, 2, 3);
parse_valist_by_num(4, 1, 2, 3, 4, 5); //多余的变参被忽略
}

//第一个参数定义可变参数的个数
void parse_valist_by_num(int arg_cnt, ...)
{

va_list p_args;
va_start(p_args, arg_cnt);

int idx;
int val;

for (idx = 1; idx <= arg_cnt; ++idx)
{
val = va_arg(p_args, int);
printf("第 %d 个参数: %d\n", idx, val);
}
printf("---------------\n");
va_end(p_args);
}

运行结果:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
$ ./test 
第 1 个参数: 1
第 2 个参数: 2
第 3 个参数: 3
第 4 个参数: 4
---------------
第 1 个参数: 1
第 2 个参数: 2
第 3 个参数: 3
第 4 个参数: 3440
---------------
第 1 个参数: 1
第 2 个参数: 2
第 3 个参数: 3
第 4 个参数: 4

例2:函数定义一个结束标记 (-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
29
#include <stdarg.h>
#include <stdio.h>

void parse_valist_by_flag(int num_1, ...);

int main(void)
{
parse_valist_by_flag(1, -1);
parse_valist_by_flag(1, 2, 3, 5, -1);
parse_valist_by_flag(-1);
}

//函数定义一个结束标记(-1),调用时通过最后一个参数传递该标记,以结束变参的遍历打印。
//最后一个参数作为变参结束符(-1),用于循环获取变参内容
void parse_valist_by_flag(int num_1, ...)
{
va_list p_args;
va_start(p_args, num_1);
int idx = 0;
int val = num_1;
while (val != -1)
{
++idx;
printf("第 %d 个参数: %d\n", idx, val);
val = va_arg(p_args, int); //得到下个变参值
}
va_end(p_args);
printf("---------------\n");
}

运行结果:

1
2
3
4
5
6
7
8
9
$ ./test 
第 1 个参数: 1
---------------
第 1 个参数: 1
第 2 个参数: 2
第 3 个参数: 3
第 4 个参数: 5
---------------
---------------

可变参数函数注意事项

可变参数函数在编程中应注意以下问题:

  1. 编译器对可变参数函数的原型检查不够严格,不利于编程查错。

  2. va_arg(ap, type) 宏获取变参时,type不可指定为以下类型:char、short、float

  3. 在C语言中,调用不带原型声明或声明为变参的函数时,主调函数会在传递未显式声明的参数前对其执行缺省参数提升(default argument promotions),将提升后的参数值传递给被调函数。

    提升操作如下:

    float 类型的参数提升为 double 类型。

    char、short 和相应的 signed、unsigned 类型参数提升为 int 类型。

    若 int 类型不能容纳原值,则提升为 unsigned int 类型。

参考链接:

  • 本文标题:C语言可变参数函数
  • 本文作者:crazyang
  • 创建时间:2020-04-13 21:55:14
  • 本文链接:https://blog.codepeak.cn/2020/04/13/C语言可变参数函数/
  • 版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!
 评论