1. 什么是可变参数函数
在C语言编程中有时会遇到一些参数可变的函数,例如printf()、scanf(),其函数原型为:
int printf(const char* format,…)
int scanf(const char *format,…)
就拿 printf 来说吧,它除了有一个参数 format 固定以外,后面的参数其个数和类型都是可变的,用三个点“…”作为参数占位符。
2. 参数列表的构成
任何一个可变参数的函数都可以分为两部分:固定参数和可选参数。至少要有一个固定参数,其声明与普通函数参数声明相同;可选参数由于数目不定(0个或以上),声明时用"…"表示。固定参数和可选参数共同构成可变参数函数的参数列表。
3. 实现原理
C语言中使用 va_list 系列变参宏实现变参函数,此处va意为variable-argument(可变参数)。
x86平台VC6.0编译器中,stdarg.h头文件内变参宏定义如下:
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。
在不考虑内存的情况下,库函数中的这条语句 (sizeof(n)+ sizeof(int) - 1) & ~(sizeof(int)-1)背后的意义也可以当作一种映射算法。具体上代码:
#include <stdio.h>
#include <stdarg.h>
int my_map(int num, int mask)
{
return ((num + mask - 1) & ( ~(mask - 1)));
}
int main()
{
for (int i=1;i<40;i++)
{
printf("%d ",my_map(i,1));
}
return 0;
}
结果:
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 32 33 34 35 36 37 38 39
#include <stdio.h>
#include <stdarg.h>
int my_map(int num, int mask)
{
return ((num + mask - 1) & ( ~(mask - 1)));
}
int main()
{
for (int i=1;i<40;i++)
{
printf("%d ",my_map(i,2));
}
return 0;
}
结果:
2 2 4 4 6 6 8 8 10 10 12 12 14 14 16 16 18 18 20 20 22 22 24 24 26 26 28 28 30 30 32 32 34 34 36 36 38 38 40
f ( x ) = { 2 , 1 ≤ x ≤ 2 4 , 3 ≤ x ≤ 4 ⋯ , x ∈ N + f\left( x \right) =\left\{ \begin{array}{l} 2\,\,,1\le x\le 2\\ 4\,\,,3\le x\le 4\\ \cdots\\ \end{array} \right. \ \ ,\ x\in \text{N}^+ f(x)=⎩⎨⎧2,1≤x≤24,3≤x≤4⋯ , x∈N+
#include <stdio.h>
#include <stdarg.h>
int my_map(int num, int mask)
{
return ((num + mask - 1) & ( ~(mask - 1)));
}
int main()
{
for (int i=1;i<40;i++)
{
printf("%d ",my_map(i,3));
}
return 0;
}
结果:
1 4 5 4 5 8 9 8 9 12 13 12 13 16 17 16 17 20 21 20 21 24 25 24 25 28 29 28 29 32 33 32 33 36 37 36 37 40 41
结论:没有明显规律
#include <stdio.h>
#include <stdarg.h>
int my_map(int num, int mask)
{
return ((num + mask - 1) & ( ~(mask - 1)));
}
int main()
{
for (int i=1;i<40;i++)
{
printf("%d ",my_map(i,4));
}
return 0;
}
结果:
4 4 4 4 8 8 8 8 12 12 12 12 16 16 16 16 20 20 20 20 24 24 24 24 28 28 28 28 32 32 32 32 36 36 36 36 40 40 40
f ( x ) = { 4 , 1 ≤ x ≤ 4 8 , 5 ≤ x ≤ 8 ⋯ , x ∈ N + f\left( x \right) =\left\{ \begin{array}{l} 4\,\,,1\le x\le 4\\ 8\,\,,5\le x\le 8\\ \cdots\\ \end{array} \right. \ \ ,\ x\in \text{N}^+ f(x)=⎩⎨⎧4,1≤x≤48,5≤x≤8⋯ , x∈N+
#include <stdio.h>
#include <stdarg.h>
int my_map(int num, int mask)
{
return ((num + mask - 1) & ( ~(mask - 1)));
}
int main()
{
for (int i=1;i<40;i++)
{
printf("%d ",my_map(i,8));
}
return 0;
}
结果:
8 8 8 8 8 8 8 8 16 16 16 16 16 16 16 16 24 24 24 24 24 24 24 24 32 32 32 32 32 32 32 32 40 40 40 40 40 40 40
相信大家都看出规律了,这里就不总结了。另外int num,int mask是有符号的,当形参num为负数的时候,或者形参mask为负数的时候,这样就还有三种情况,有的也是有规律的,这里就不赘述了。
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 宏。
4. 代码示例
变参宏无法智能识别可变参数的数目和类型,因此实现变参函数时需自行判断可变参数的数目和类型。所以我们就要想一些办法,比如
-
显式提供变参数目或设定遍历结束条件
-
显式提供变参类型枚举值,或在固定参数中包含足够的类型信息(如printf函数通过分析format字符串即可确定各变参类型)
-
主调函数和被调函数可约定变参的数目和类型
-
…
例1:函数通过固定参数指定可变参数个数,打印所有变参值
#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 个参数: 1
第 2 个参数: 2
第 3 个参数: 3
第 4 个参数: 4
---------------
第 1 个参数: 1
第 2 个参数: 2
第 3 个参数: 3
第 4 个参数: 4
---------------
第 1 个参数: 1
第 2 个参数: 2
第 3 个参数: 3
第 4 个参数: 4
---------------
例2:函数定义一个结束标记(-1),调用时通过最后一个参数传递该标记,打印标记前所有变参值。
#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 个参数: 1
---------------
第 1 个参数: 1
第 2 个参数: 2
第 3 个参数: 3
第 4 个参数: 5
---------------
---------------
需要注意
va_arg(ap, type)宏中的 type 不可指定为以下类型:char、short、float
在C语言中,调用不带原型声明或声明为变参的函数时,主调函数会在传递未显式声明的参数前对其执行缺省参数提升(default argument promotions),将提升后的参数值传递给被调函数。
提升操作如下:
-
float 类型的参数提升为 double 类型
-
char、short 和相应的 signed、unsigned 类型参数提升为 int 类型
-
若 int 类型不能容纳原值,则提升为 unsigned int 类型
最后来一张图,帮助大家理解前文讲的宏。
5. 应用
在嵌入式开发中,经常使用int fputc(int ch, FILE *f)重映射printf()函数,例如重映射到ITM、串口、oled屏幕等,这种方式只能映射到一个地方,不是很方便。下面介绍一个终极方法,实现可变参数任意端口打印。这里以oled为例,代码如下:
/**
* @brief OLED打印字符串
* @param Line 起始行位置,范围:1~4
* @param Column 起始列位置,范围:1~16
* @param pFormat 要显示的字符串,可以%d,%c,%x格式化输出
*/
int OLED_printf(uint8_t Line,uint8_t Column,const char *pFormat, ...)
{
char StrBuf[50] = {'\0'};
va_list aptr;
int result;
va_start(aptr, pFormat);
result = vsprintf((char *)StrBuf, pFormat, aptr);
va_end(aptr);
OLED_ShowString(Line, Column, StrBuf,1);//OLED显示string函数
return result;
}
6. 参考资料
https://blog.csdn.net/longintchar/article/details/85490103
https://www.cnblogs.com/clover-toeic/p/3736748.html