C的可变参数

1 使用:
一直以来习惯了使用printf函数,但是对于可变参数没有深入研究过,觉得可变参数是一个神奇的技术^0^。。。
工作闲下来的时候,想研究研究看可变参数的使用和原理。
目前C提供的可变参数的申明为
void function(const char *format, ...);
这样就可以在function中使用可变参数
C提供了几个宏用于使用可变参数
va_list
va_start
va_arg
va_end
其中
va_list用于定义一个变量获取可变参数指针
va_start用于将va_list定义的指针进行初始化
va_arg用于获取对应指针的真实类型数据
va_end用于清空va_list定义的指针

好了,光说不练假把式,来一个例子吧。嗯,什么样的例子比较好呢?
对了,在c的printf中不支持c++的std::string,就自己实现一个支持std::string的printf吧。
例子:
void Puts(const char *pstr)
{
while(*pstr)
putchar(*pstr++);
}

// Printf函数支持可变类型为
// %c->char
// %d->int
// %s->char*
// %S->std::string
// Bug:不支持'"'等转义符
// 处理%%等出现问题
void Printf(const char *_Format, ……)
{
va_list arg_ptr;
va_start(arg_ptr,_Format);
const char *pWork = _Format;
while(*pWork != '"0')
{
if(pWork == _Format)
{
if(*pWork != '%')
putchar(*pWork);
}
else
{
if(*(pWork-1) == '%')
{
switch(*pWork)
{
case 'c':
{
char cvalue = va_arg(arg_ptr,char);
putchar(cvalue);
break;
}
case 'd':
{
int ivalue = va_arg(arg_ptr,int);
char buffer[32];
_itoa(ivalue, buffer, 10);
Puts(buffer);
break;
}
case 's':
{
char* psvalue = va_arg(arg_ptr,char*);
Puts(psvalue);
break;
}
case 'S':
{
std::string pstringvalue = va_arg(arg_ptr,std::string);
Puts(pstringvalue.c_str());
break;
}
default:
putchar('%');
putchar(*pWork);
}
}
else if(*pWork != '%')
{
putchar(*pWork);
}
}
pWork++;
}
va_end(arg_ptr);
}


调用代码:
std::string s = "abc";
Printf("%cyPrint %cunction %s:%d, Support C++ std::string %S……version %d",'M','F',"Version",1, s, 2);
输出结果为:
MyPrint Function Version:1, Support C++ std::string abc...version 2

可变参数真是神奇的很啊。。。


2 原理:
我们来看看这几个宏到底干了什么
typedef char * va_list; // 这个仅仅是个重定义而已。。。

// 获取v的地址
#define _ADDRESSOF(v) ( &(v) ) 
// n的整数字节的大小,必须是sizeof(int)的整数倍。如sizeof(n)为5的话,_INTSIZEOF(n)为8(假设为32位机器的话)
#define _INTSIZEOF(n) ( (sizeof(n) + sizeof(int) - 1) & ~(sizeof(int) - 1) )
// 给v的地址加上v的大小 
#define va_start(ap,v) ( ap = (va_list)_ADDRESSOF(v) + _INTSIZEOF(v) ) 

// 给ap自增t的大小,并且获取原有ap的地址的数据,强制转型为t类型
// 这个相当于 ( *(t *)ap )
// (ap += _INTSIZEOF(t))
// 这一个宏相当于完成两件事情
#define va_arg(ap,t) ( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) )

// 给ap置0
#define va_end(ap) ( ap = (va_list)0 )

我们有必要了解一下C函数的调用规则了,在调用一个函数之前,调用方会将这个函数参数push(修改ESP指针),并且push规则是先push最后一个参数,最后push第一个参数,因此ESP指针最后应该是指向第一个参数。可变参数就是利用了这一点,一旦获取到第一个参数的地址后,就能够通过地址向前查找所有的参数。(注意:x86上的堆栈是反向的,push会使ESP的值减少,而不是增加)
上面的宏就是帮助用户查找所有的可变参数。

问题:
printf以及Printf都不是类型安全的。调用方必须保证参数个数的正确,以及参数类型的正确,否则将会发生不可预期的错误。

3 探索
是否可以写一个没有固定参数的函数,比如
int f (...);
据ANSI C说不行,但是我的vc8可行。
问题是写出这样的函数,va_start就用不上了,因为它需要可变参之前的那个固定参数。
其实我们可以自己从ESP中获取相关参数。 
例子:
// 获取第一个参数值的指针
// 函数在访问的过程中最重要的事情就是要确保堆栈的平衡,而在win32(vc8)的环境下保持平衡的办法是这样的:
// 1.让EBP保存ESP的值;
// push ebp
// mov ebp, esp
// 2.在结束的时候调用
// mov esp,ebp
// pop ebp
// retn
// 下面这个宏将ebp(原esp)中的指针+8放入ap中
// 注意:给ebp加8是因为中间隔着一个ebp和一个函数返回地址
#define va_start_get_first_parameter(ap) \
__asm mov eax, ebp \
__asm add eax, 8 \
__asm mov ap,eax


void NoFirstParameterPrintf()
{
va_list arg_ptr;
va_start_get_first_parameter(arg_ptr);

int first = va_arg(arg_ptr,int);
int second = va_arg(arg_ptr,int);
int third = va_arg(arg_ptr,int);
printf("First=%d"nSecond=%d"nThird=%d"n",first,second,third);

va_end(arg_ptr);
}
调用代码:
NoFirstParameterPrintf(3, 5, 7);

输出结果:
First=3
Second=5
Third=7

这样完全是可以获取第一个参数的地址的。问题是,由于没有类型信息和类型个数等信息(类似于printf中的%c等信息),所以这样的例子貌似意义不是很大。

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;     /* 存放取出的字符串参数 */  
                    /* argp指向传入的第一个可选参数,   msg是最后一个确定的参数 */  
va_start( 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;  
}


void 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获 
取各个参数.

二、可变参类型陷井

下面的代码是错误的,运行时得不到预期的结果:

view plaincopy to clipboardprint?
va_start(pArg, plotNo); 
fValue = va_arg(pArg, float); // 类型应改为double,不支持float 
va_end(pArg); 
va_start(pArg, plotNo);
fValue = va_arg(pArg, float); // 类型应改为double,不支持float
va_end(pArg);

下面列出va_arg(argp, type)宏中不支持的type:

—— char、signed char、unsigned char
—— short、unsigned short
—— signed short、short int、signed short int、unsigned short int
—— float

在C语言中,调用一个不带原型声明的函数时,调用者会对每个参数执行“默认实际参数提升(default argument promotions)”。该规则同样适用于可变参数函数——对可变长参数列表超出最后一个有类型声明的形式参数之后的每一个实际参数,也将执行上述提升工作。

提升工作如下:
——float类型的实际参数将提升到double
——char、short和相应的signed、unsigned类型的实际参数提升到int
——如果int不能存储原值,则提升到unsigned int

然后,调用者将提升后的参数传递给被调用者。

所以,可变参函数内是绝对无法接收到上述类型的实际参数的。


关于该陷井,C/C++著作中有以下描述:


在《C语言程序设计》对可变长参数列表的相关章节中,并没有提到这个陷阱。但是有提到默认实际参数提升的规则:
在没有函数原型的情况下,char与short类型都将被转换为int类型,float类型将被转换为double类型。
——《C语言程序设计》第2版 2.7 类型转换 p36

在其他一些书籍中,也有提到这个规则:

事情很清楚,如果一个参数没有声明,编译器就没有信息去对它执行标准的类型检查和转换。
在这种情况下,一个char或short将作为int传递,float将作为double传递。
这些做未必是程序员所期望的。
脚注:这些都是由C语言继承来的标准提升。
对于由省略号表示的参数,其实际参数在传递之前总执行这些提升(如果它们属于需要提升的类型),将提升后的值传递给有关的函数。——译者注
——《C++程序设计语言》第3版-特别版 7.6 p138

…… float类型的参数会自动转换为double类型,short或char类型的参数会自动转换为int类型 ……
——《C陷阱与缺陷》 4.4 形参、实参与返回值 p73

这里有一个陷阱需要避免:
va_arg宏的第2个参数不能被指定为char、short或者float类型。
因为char和short类型的参数会被转换为int类型,而float类型的参数会被转换为double类型 ……
例如,这样写肯定是不对的:
c = va_arg(ap,char);
因为我们无法传递一个char类型参数,如果传递了,它将会被自动转化为int类型。上面的式子应该写成:
c = va_arg(ap,int);
——《C陷阱与缺陷》p164


























發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章