// 下文轉(zhuǎn)自網(wǎng)絡(luò)
C語言可變參數(shù)函數(shù)的實(shí)現(xiàn)
一、什么是可變參數(shù)
我們在C語言編程中有時會遇到一些參數(shù)個數(shù)可變的函數(shù),例如printf()函數(shù),其函數(shù)原型為:
int printf( const char* format, ...);
它除了有一個參數(shù)format固定以外,后面跟的參數(shù)的個數(shù)和類型是可變的(用三個點(diǎn)“…”做參數(shù)占位符),實(shí)際調(diào)用時可以有以下的形式: printf("%d",i);
printf("%s",s);
printf("the number is %d ,string is:%s", i, s);
以上這些東西已為大家所熟悉。但是究竟如何寫可變參數(shù)的C函數(shù)以及這些可變參數(shù)的函數(shù)編譯器是如何實(shí)現(xiàn),這個問題卻一直困擾了我好久。本文就這個問題進(jìn)行一些探討,希望能對大家有些幫助.
二、寫一個簡單的可變參數(shù)的C函數(shù)
先看例子程序。該函數(shù)至少有一個整數(shù)參數(shù),其后占位符…,表示后面參數(shù)的個數(shù)不定. 在這個例子里,所有的輸入?yún)?shù)必須都是整數(shù),函數(shù)的功能只是打印所有參數(shù)的值.
函數(shù)代碼如下:
//示例代碼1:可變參數(shù)函數(shù)的使用
#i nclude "stdio.h"
#i nclude "stdarg.h"
void simple_va_fun(int start, ...)
{
va_list arg_ptr;
int nArgValue =start;
int nArgCout=0; //可變參數(shù)的數(shù)目
va_start(arg_ptr,start); //以固定參數(shù)的地址為起點(diǎn)確定變參的內(nèi)存起始地址。
do
{
++nArgCout;
printf("the %d th arg: % d\n",nArgCout,nArgValue); //輸出各參數(shù)的值
nArgValue = va_arg(arg_ptr,int); //得到下一個可變參數(shù)的值
} while(nArgValue != -1);
return;
}
int main(int argc, char* argv[])
{
simple_va_fun(100,-1);
simple_va_fun(100,200,-1);
return 0;
}
下面解釋一下這些代碼
從這個函數(shù)的實(shí)現(xiàn)可以看到,我們使用可變參數(shù)應(yīng)該有以下步驟:
⑴由于在程序中將用到以下這些宏:
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在這里是variable-argument(可變參數(shù))的意思.
這些宏定義在stdarg.h中,所以用到可變參數(shù)的程序應(yīng)該包含這個頭文件.
⑵函數(shù)里首先定義一個va_list型的變量,這里是arg_ptr,這個變
量是存儲參數(shù)地址的指針.因?yàn)榈玫絽?shù)的地址之后,再結(jié)合參數(shù)的類型,才能得到參數(shù)的值。
⑶然后用va_start宏初始化⑵中定義的變量arg_ptr,這個宏的第二個參數(shù)是可變參數(shù)列表的前一個參數(shù),即最后一個固定參數(shù).
⑷然后依次用va_arg宏使arg_ptr返回可變參數(shù)的地址,得到這個地址之后,結(jié)合參數(shù)的類型,就可以得到參數(shù)的值。
⑸設(shè)定結(jié)束條件,這里的條件就是判斷參數(shù)值是否為-1。注意被調(diào)的函數(shù)在調(diào)用時是不知道可變參數(shù)的正確數(shù)目的,程序員必須自己在代碼中指明結(jié)束條件。至于為什么它不會知道參數(shù)的數(shù)目,讀者在看完這幾個宏的內(nèi)部實(shí)現(xiàn)機(jī)制后,自然就會明白。
(二)可變參數(shù)在編譯器中的處理
我們知道va_start, va_arg,va_end是在stdarg.h中被定義成宏的, 由于1)硬件平臺的不同 2)編譯器的不同,所以定義的宏也有所不同,下面看一下VC++6.0中stdarg.h里的代碼(文件的路徑為VC安裝目錄下的\vc98\ include\stdarg.h)
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 )
下面我們解釋這些代碼的含義:
1、首先把va_list被定義成char*,這是因?yàn)樵谖覀兡壳八玫腜C機(jī)上,字符指針類型可以用來存儲內(nèi)存單元地址。而在有的機(jī)器上va_list是被定義成void*的
2、定義_INTSIZEOF(n)主要是為了某些需要內(nèi)存的對齊的系統(tǒng).這個宏的目的是為了得到最后一個固定參數(shù)的實(shí)際內(nèi)存大小。在我的機(jī)器上直接用sizeof運(yùn)算符來代替,對程序的運(yùn)行結(jié)構(gòu)也沒有影響。(后文將看到我自己的實(shí)現(xiàn))。
3、 va_start的定義為 &v+_INTSIZEOF(v) ,這里&v是最后一個固定參數(shù)的起始地址,再加上其實(shí)際占用大小后,就得到了第一個可變參數(shù)的起始內(nèi)存地址。所以我們運(yùn)行va_start (ap, v)以后,ap指向第一個可變參數(shù)在的內(nèi)存地址,有了這個地址,以后的事情就簡單了。
這里要知道兩個事情:
[1]在intel+windows的機(jī)器上,函數(shù)棧的方向是向下的,棧頂指針的內(nèi)存地址低于棧底指針,所以先進(jìn)棧的數(shù)據(jù)是存放在內(nèi)存的高地址處。
[2]在VC等絕大多數(shù)C編譯器中,默認(rèn)情況下,參數(shù)進(jìn)棧的順序是由右向左的,因此,參數(shù)進(jìn)棧以后的內(nèi)存模型如下圖所示:最后一個固定參數(shù)的地址位于第一個可變參數(shù)之下,并且是連續(xù)存儲的。
|——————————————————————————|
| 最后一個可變參數(shù) | ->高內(nèi)存地址處
|——————————————————————————|
...................
|——————————————————————————|
| 第N個可變參數(shù) | ->va_arg(arg_ptr,int)后arg_ptr所指的地方,
| | 即第N個可變參數(shù)的地址。
|——————————————— |
………………………….
|——————————————————————————|
| 第一個可變參數(shù) | ->va_start(arg_ptr,start)后arg_ptr所指的地方
| | 即第一個可變參數(shù)的地址
|——————————————— |
|———————————————————————— ——|
| |
| 最后一個固定參數(shù) | -> start的起始地址
|—————————————— —| .................
|—————————————————————————— |
| |
|——————————————— | -> 低內(nèi)存地址處
4、va_arg():有了va_start的良好基礎(chǔ),我們?nèi)〉昧说谝粋€可變參數(shù)的地址,在va_arg()里的任務(wù)就是根據(jù)指定的參數(shù)類型取得本參數(shù)的值,并且把指針調(diào)到下一個參數(shù)的起始地址。
因此,現(xiàn)在再來看va_arg()的實(shí)現(xiàn)就應(yīng)該心中有數(shù)了:
#define va_arg(ap,t) ( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) )
這個宏做了兩個事情,
①用用戶輸入的類型名對參數(shù)地址進(jìn)行強(qiáng)制類型轉(zhuǎn)換,得到用戶所需要的值
②計(jì)算出本參數(shù)的實(shí)際大小,將指針調(diào)到本參數(shù)的結(jié)尾,也就是下一個參數(shù)的首地址,以便后續(xù)處理。
5、va_end宏的解釋:x86平臺定義為ap=(char*)0;使ap不再指向堆棧,而是跟NULL一樣.有些直接定義為((void*)0),這樣編譯器不會為va_end產(chǎn)生代碼,例如gcc在linux的x86平臺就是這樣定義的. 在這里大家要注意一個問題:由于參數(shù)的地址用于va_start宏,所以參數(shù)不能聲明為寄存器變量或作為函數(shù)或數(shù)組類型. 關(guān)于va_start, va_arg, va_end的描述就是這些了,我們要注意的 是不同的操作系統(tǒng)和硬件平臺的定義有些不同,但原理卻是相似的.
(三)可變參數(shù)在編程中要注意的問題
因?yàn)関a_start, va_arg, va_end等定義成宏,所以它顯得很愚蠢, 可變參數(shù)的類型和個數(shù)完全在該函數(shù)中由程序代碼控制,它并不能智能地識別不同參數(shù)的個數(shù)和類型. 有人會問:那么printf中不是實(shí)現(xiàn)了智能識別參數(shù)嗎?那是因?yàn)楹瘮?shù) printf是從固定參數(shù)format字符串來分析出參數(shù)的類型,再調(diào)用va_arg 的來獲取可變參數(shù)的.也就是說,你想實(shí)現(xiàn)智能識別可變參數(shù)的話是要通過在自己的程序里作判斷來實(shí)現(xiàn)的. 例如,在C的經(jīng)典教材《the c programming language》的7.3節(jié)中就給出了一個printf的可能實(shí)現(xiàn)方式,由于篇幅原因這里不再敘述。
(四)小結(jié):
1、標(biāo)準(zhǔn)C庫的中的三個宏的作用只是用來確定可變參數(shù)列表中每個參數(shù)的內(nèi)存地址,編譯器是不知道參數(shù)的實(shí)際數(shù)目的。
2、在實(shí)際應(yīng)用的代碼中,程序員必須自己考慮確定參數(shù)數(shù)目的辦法,如
⑴在固定參數(shù)中設(shè)標(biāo)志—— printf函數(shù)就是用這個辦法。后面也有例子。
⑵在預(yù)先設(shè)定一個特殊的結(jié)束標(biāo)記,就是說多輸入一個可變參數(shù),調(diào)用時要將最后一個可變參數(shù)的值設(shè)置成這個特殊的值,在函數(shù)體中根據(jù)這個值判斷是否達(dá)到參數(shù)的結(jié)尾。本文前面的代碼就是采用這個辦法.
無論采用哪種辦法,程序員都應(yīng)該在文檔中告訴調(diào)用者自己的約定。
3、實(shí)現(xiàn)可變參數(shù)的要點(diǎn)就是想辦法取得每個參數(shù)的地址,取得地址的辦法由以下幾個因素決定:
①函數(shù)棧的生長方向
②參數(shù)的入棧順序
③CPU的對齊方式
④內(nèi)存地址的表達(dá)方式
結(jié)合源代碼,我們可以看出va_list的實(shí)現(xiàn)是由④決定的,_INTSIZEOF(n)的引入則是由③決定的,他和①②又一起決定了va_start的實(shí)現(xiàn),最后va_end的存在則是良好編程風(fēng)格的體現(xiàn),將不再使用的指針設(shè)為NULL,這樣可以防止以后的誤操作。
4、取得地址后,再結(jié)合參數(shù)的類型,程序員就可以正確的處理參數(shù)了。理解了以上要點(diǎn),相信稍有經(jīng)驗(yàn)的讀者就可以寫出適合于自己機(jī)器的實(shí)現(xiàn)來。
(五)擴(kuò)展——自己實(shí)現(xiàn)簡單的可變參數(shù)的函數(shù)。
下面是一個簡單的printf函數(shù)的實(shí)現(xiàn),參考了<The C Programming Language>中的156頁的例子
#i nclude "stdio.h"
#i nclude "stdlib.h"
void myprintf(char* fmt, ...)//一個簡單的類似于printf的實(shí)現(xiàn),//參數(shù)必須都是int 類型
{
char* pArg=NULL;//等價于原來的va_list
char c;
pArg = (char*) &fmt;//注意不要寫成p = fmt !!因?yàn)檫@里要對//參數(shù)取址,而不是取值
pArg += sizeof(fmt);//等價于原來的va_start
do
{
c =*fmt;
if (c != '%')
{
putchar(c);//照原樣輸出字符
}
else
{
//按格式字符輸出數(shù)據(jù)
switch(*++fmt)
{
case 'd':
printf("%d",*((int*)pArg));
break;
case 'x':
printf("%#x",*((int*)pArg));
break;
default:
break;
}
pArg += sizeof(int); //等價于原來的va_arg
}
++fmt;
}while (*fmt != '\0');
pArg = NULL; //等價于va_end
return;
}
int main(int argc, char* argv[])
{
int i = 1234;
int j = 5678;
myprintf("the first test:i=%d\n",i,j);
myprintf("the secend test:i=%d; %x;j=%d;\n",i,0xabcd,j);
system("pause");
return 0;
}
在intel+win2k+vc6的機(jī)器執(zhí)行結(jié)果如下:
the first test:i=1234
the secend test:i=1234; 0xabcd;j=5678;