首页 > 代码库 > C/C++中的可变参函数

C/C++中的可变参函数

可变参函数最好的实例:printf();参数可变

包含的头文件:

C语言中:#include<stdarg.h>

C++中的可变参的头文件:#include<cstdarg>,它其实就是包含了C语言中的可变参头文件stdarg.h

试想一下我们假如想定义一个函数,我们在调用之前(在运行期之前)根本不知道我到底要调用几个参数,并且不知道这些参数是个什么类型,例如我们想定义一个函数:
  int max(int n, ...);
  用来返回一串随意长度输入参数的最大值,例如调用
  max(3, 10, 20, 30)的时候,可以返回(n=3)个数 10,20,30 的最大值30。
  并且还可以接受任意个参数的输入,例如:
  max(6, 20, 40, 10, 50, 30, 40)也应该是被接受的,返回最大值50。
  这怎么达到呢?
  其实这样的例子我们肯定见过,最典型的就是 printf 函数,可以看 printf 函数的原形:
  int printf(char*, ...);
  它接受一个格式字符串,并且后面跟随任意指定的参数,根据实际需要而确定入参的个数。
  实际上它的实现要依赖于一个标准 C 库 <stdarg.h>,stdandard argument(标准参数) 的意思。下面先稍为介绍一下 <stdarg.h>,或者在 C++ 中的 <cstdarg> 的功效:

首先是参数的内存存放格式:参数存放在内存的堆栈段中,在执行函数的时候,从最后一个开始入栈。因此栈底高地址,栈顶低地址,举个例子如下:
  void func(int x, float y, char z);
  那么,调用函数的时候,实参 char z 先进栈,然后是 float y,最后是 int x,因此在内存中变量的存放次序是 x->y->z,因此,从理论上说,我们只要探测到任意一个变量的地址,并且知道其他变量的类型,通过指针移位运算,则总可以顺藤摸瓜找到其他的输入变量。
  然后是可变入参表格式,省略的参数用 ... 代替,但必须注意:
1. 只能有一个 ... 并且它必须是最后一个参数;
2. 不要只用一个 ... 作为所有的参数,因为从后面可以知道,这样你无法确定入参表的地址。
  举个例子,声明函数如下:
  void func(int x, int y, ...);
  然后调用:func(3, 5, ‘c‘, 2.1f, 6);
  于是在调用参数的时候,编译器则不会检查实际输入的是什么参数,只管把所有参数按照上面描述的方法,变成实参堆放在内存中,在本例中,内存中依次存放 x=3, y=5, ‘c‘, 2.1f, 6
  但是有一个需要注意的地方,这些东西只是紧挨着堆放在内存中,于是想要正确调用这些参数,必须知道他们确切的类型,并且我们也关心这个参数表实际的长度,然而不幸的是,这些我们无从得知。因此,这个解决办法决不是高明的,从某种程度上说,这甚至是一个严重的漏洞。因此,C++ 很不提倡去使用它。

不过缺点归缺点,万不得已的时候我们还是得用,但是我们对里面输入变量的时候,应该对入参的类型有一个清醒的认识,否则这样的操作是很危险的。
  下面是 <stdarg.h> 对上面这一个思路的实现,里面重要的几个宏定义如下:
  typedef char* va_list;  /*可以理解为int main(int argc,char *argv[])中的argv数组*/
  void va_start ( va_list ap, prev_param ); /* ANSI version */
  type va_arg ( va_list ap, type ); /*获取最前面的一个参数,需要指定参数类型*/
  void va_end ( va_list ap ); /*实际是将va_list置空*/
  其中,va_list 是一个字符指针,可以理解为指向当前参数的一个指针,取参必须通过这个指针进行。

  支持可变参数函数的所有宏都定义在stdarg.h 和 varargs.h中。例如标准ANSI形式下,这些宏的定义是:

  typedef char * va_list; //字符串指针

  #define _INTSIZEOF(n) ( (sizeof(n) + sizeof(int) - 1) & ~(sizeof(int) - 1) )

  #define va_start(ap,v) ( ap = (va_list)&v + _INTSIZEOF(v) )

  #define va_arg(ap,t) ( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) )

  #define va_end(ap) ( ap = (va_list)0 )

  使用宏_INTSIZEOF是为了按照整数字节对齐指针,因为c调用协议下面,参数入栈都是整数字节(指针或者值)。

<Step 1> 在调用参数表之前,应该定义一个 va_list 类型的变量,以供后用(下面假设这个 va_list 类型变量被定义为ap);
<Step 2> 然后应该对 ap 进行初始化,让它指向可变参数表里面的第一个参数,这是通过 va_start 来实现的,第一个参数是 ap 本身,第二个参数是在变参表前面紧挨着的一个变量;
<Step 3> 然后是获取参数,调用 va_arg,它的第一个参数是 ap,第二个参数是要获取的参数的指定类型,然后返回这个指定类型的值,并且把 ap 的位置指向变参表的下一个变量位置;
<Step 4> 获取所有的参数之后,我们有必要将这个 ap 指针关掉,以免发生危险,方法是调用 va_end,他是输入的参数 ap 置为 NULL,应该养成获取完参数表之后关闭指针的习惯

例如开始的例子 int max(int n, ...); 其函数内部应该如此实现:
int max(int n, ...) {                   // 定参 n 表示后面变参数量,定界用,输入时切勿搞错
  va_list ap;                            // 定义一个 va_list 指针来访问参数表
  va_start(ap, n);                       // 初始化 ap,让它指向第一个变参
  int maximum = -0x7FFFFFFF;            // 这是一个最小的整数
  int temp;
  for(int i = 0; i < n; i++) {
    temp = va_arg(ap, int);             // 获取一个 int 型参数,必须要指定类型,否则会出错,并且 ap 指向下一个参数
    if(maximum < temp) maximum = temp;
  }
  va_end(ap);                            // 善后工作,关闭 ap,释放va_list
  return max;
}
// 在主函数中测试 max 函数的行为(C++ 格式)
int main() {
  cout << max(3, 10, 20, 30) << endl;
  cout << max(6, 20, 40, 10, 50, 30, 40) << endl;
}

 

可变参数函数在不同的系统下,采用不同的形式定义。

  用ANSI标准形式时,参数个数可变的函数的原型声明是:

  type funcname(type para1, type para2, …);

关于这个定义,有三点需要说明:

一般来说,这种形式至少需要一个普通的形式参数,可变参数就是通过三个’.‘来定义的。所以”…”不表示省略,而是函数原型的一部分。type是函数返回值和形式参数的类型。 例如:

  int MyPrintf(char const* fmt, …);

但是,我们也可以这样定义函数:

  void MyFunc(…);

但是,这样的话,我们就无法使用函数的参数了,因为无法通过上面所讲的宏来提取每个参数。所以除非你的函数代码中的确没有用到参数表中的任何参数,否则必须在参数表中使用至少一个普通参数。

注意,可变参数只能位于函数参数表的最后。不能这样:

void MyFunc(…, int i);


  基本用法阐述至此,可以看到,这个方法存在两处极严重的漏洞:其一,输入参数的类型随意性,使得参数很容易以一个不正确的类型获取一个值(譬如输入一个float,却以int型去获取他),这样做会出现莫名其妙的运行结果;其二,变参表的大小并不能在运行时获取,这样就存在一个访问越界的可能性,导致后果严重的 RUNTIME ERROR。作为建议,在 C++ 环境中尽量不要使用这种方法,如有需要,尽量先考虑使用类或者重载来代替,这样可以很好地弥补这种方法的漏洞。

 

#define _CRT_SECURE_NO_WARNINGS#include <stdio.h>#include <string.h>#include <stdarg.h>#include <stdlib.h>/* 函数原型声明,至少需要一个确定的参数,注意括号内的省略号 */int demo(char *,...);void main(void){    demo("DEMO", "This", "is", "a", "demo", "\0");}int demo(char *msg,...){    va_list argp; /* 定义保存函数参数的结构 */    int argno = 0; /* 纪录参数个数 */    char *para; /* 存放取出的字符串参数 */    // 使用宏va_start, 使argp指向传入的第一个可选参数,    // 注意 msg是参数表中最后一个确定的参数,并非参数表中第一个参数    va_start(argp, msg);    while (1)    {        //取出当前的参数,类型为char *        //如果不给出正确的类型,将得到错误的参数        para = va_arg(argp, char *);        if (strcmp(para, "\0") == 0) /* 采用空串指示参数输入结束 */            break;        printf("参数 #%d是: %s\n", argno, para);        argno++;//注意:栈底在高地址,栈顶在低地址,所以这里是++    }    va_end(argp); /* 将argp置为NULL */    system("pause");    return 0;}

 

以上内容转载至牛人博客:http://foggy-elves.blog.sohu.com/

 

C/C++中的可变参函数