我們在C語言編程中會遇到一些參數(shù)個數(shù)可變的函數(shù),例如printf()這個函數(shù),這里將介紹可變函數(shù)的寫法以及原理.
* 1. 可變參數(shù)的宏
一般在調(diào)試打印Debug 信息的時候, 需要可變參數(shù)的宏. 從C99開始可以使編譯器標準支持可變參數(shù)宏(variadic macros), 另外GCC 也支持可變參數(shù)宏, 但是兩種在細節(jié)上可能存在區(qū)別.
1. __VA_ARGS__
__VA_ARGS__ 將"..." 傳遞給宏.如
#define debug(format, ...) fprintf(stderr, fmt, __VA_ARGS__)
在GCC中也支持這類表示, 但是在G++ 中不支持這個表示.
2. GCC 的復雜宏
GCC使用一種不同的語法從而可以使你可以給可變參數(shù)一個名字，如同其它參數(shù)一樣。
#define debug(format, args...) fprintf (stderr, format, args)
這和上面舉的那個定義的宏例子是完全一樣的，但是這么寫可讀性更強并且更容易進行描述。
3. ##__VA_ARGS__
上面兩個定義的宏, 如果出現(xiàn)debug("A Message") 的時候, 由于宏展開后有個多余的逗號, 所以將導致編譯錯誤. 為了解決這個問題，CPP使用一個特殊的‘##’操作。
#define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
這里，如果可變參數(shù)被忽略或為空，‘##’操作將使預處理器（preprocessor）去除掉它前面的那個逗號。如果你在宏調(diào)用時，確實提供了一些可變參數(shù)，GNU CPP也會工作正常，它會把這些可變參數(shù)放到逗號的后面。
4. 其他方法
一種流行的技巧是用一個單獨的用括弧括起來的的 "參數(shù)" 定義和調(diào)用宏, 參數(shù)在宏擴展的時候成為類似 printf() 那樣的函數(shù)的整個參數(shù)列表。
#define DEBUG(args) (printf("DEBUG: "), printf(args))
* 2. 可變參數(shù)的函數(shù)
寫可變參數(shù)的C函數(shù)要在程序中用到以下這些宏:
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ù)的函數(shù),該函數(shù)至少有一個整數(shù)參數(shù),第二個參數(shù)也是整數(shù),是可選的.函數(shù)只是打印這兩個參數(shù)的值.
void simple_va_fun(int i, ...)
{
?? ?va_list arg_ptr;
?? ?int j=0;
?? ?
?? ?va_start(arg_ptr, i);
?? ?j=va_arg(arg_ptr, int);
?? ?va_end(arg_ptr);
?? ?printf("%d %d\n", i, j);
?? ?return;
}
在程序中可以這樣調(diào)用:
simple_va_fun(100);
simple_va_fun(100,200);
從這個函數(shù)的實現(xiàn)可以看到,使用可變參數(shù)應該有以下步驟:
1)首先在函數(shù)里定義一個va_list型的變量,這里是arg_ptr,這個變量是指向參數(shù)的指針.
2)然后用va_start宏初始化變量arg_ptr,這個宏的第二個參數(shù)是第一個可變參數(shù)的前一個參數(shù),是一個固定的參數(shù).
3)然后用va_arg返回可變的參數(shù),并賦值給整數(shù)j. va_arg的第二個參數(shù)是你要返回的參數(shù)的類型,這里是int型.
4)最后用va_end宏結束可變參數(shù)的獲取.然后你就可以在函數(shù)里使用第二個參數(shù)了.如果函數(shù)有多個可變參數(shù)的,依次調(diào)用va_arg獲取各個參數(shù).
如果我們用下面三種方法調(diào)用的話,都是合法的,但結果卻不一樣:
1)simple_va_fun(100);
結果是:100 -123456789(會變的值)
2)simple_va_fun(100,200);
結果是:100 200
3)simple_va_fun(100,200,300);
結果是:100 200
我們看到第一種調(diào)用有錯誤,第二種調(diào)用正確,第三種調(diào)用盡管結果正確,但和我們函數(shù)最初的設計有沖突.下面一節(jié)我們探討出現(xiàn)這些結果的原因和可變參數(shù)在編譯器中是如何處理的.
* 3. 可變參數(shù)函數(shù)原理
va_start,va_arg,va_end是在stdarg.h中被定義成宏的,由于硬件平臺的不同,編譯器的不同,所以定義的宏也有所不同,下面以VC++中stdarg.h里x86平臺的宏定義摘錄如下:
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(n)主要是為了內(nèi)存對齊,C語言的函數(shù)是從右向左壓入堆棧的(設數(shù)據(jù)進棧方向為從高地址向低地址發(fā)展,即首先壓入的數(shù)據(jù)在高地址). 下圖是函數(shù)的參數(shù)在堆棧中的分布位置:
低地址?? ?|-----------------------------|<-- &v
?? ??? ?|第n-1個參數(shù)(最后一個固定參數(shù))|
?? ??? ?|-----------------------------|<--va_start后ap指向
?? ??? ?|第n個參數(shù)(第一個可變參數(shù)) |
?? ??? ?|-----------------------------|
?? ??? ?|....... |
?? ??? ?|-----------------------------|
?? ??? ?|函數(shù)返回地址 |
高地址? |-----------------------------|
1. va_list 被定義為char *
2. va_start 將地址ap定義為 &v+_INTSIZEOF(v),而&v是固定參數(shù)在堆棧的地址,所以va_start(ap, v)以后,ap指向第一個可變參數(shù)在堆棧的地址
3. va_arg 取得類型t的可變參數(shù)值,以int型為例,va_arg取int型的返回值:
?? j= ( *(int*)((ap += _INTSIZEOF(int))-_INTSIZEOF(int)) );
4. va_end 使ap不再指向堆棧,而是跟NULL一樣.這樣編譯器不會為va_end產(chǎn)生代碼.
在不同的操作系統(tǒng)和硬件平臺的定義有些不同,但原理卻是相似的.
* 4. 小結
對于可變參數(shù)的函數(shù),因為va_start, va_arg, va_end等定義成宏,所以它顯得很愚蠢,可變參數(shù)的類型和個數(shù)需要在該函數(shù)中由程序代碼控制;另外,編譯器對可變參數(shù)的函數(shù)的原型檢查不夠嚴格,對編程查錯不利.
所以我們寫一個可變函數(shù)的C函數(shù)時,有利也有弊,所以在不必要的場合,無需用到可變參數(shù).如果在C++里,我們應該利用C++的多態(tài)性來實現(xiàn)可變參數(shù)的功能,盡量避免用C語言的方式來實現(xiàn).
* 5. 附一些代碼
#define debug(format, ...) fprintf(stderr, fmt, __VA_ARGS__)
#define debug(format, args...) fprintf (stderr, format, args)
#define debug(format, ...) fprintf (stderr, format, ## __VA_ARGS__)
// 使用va... 實現(xiàn)
void debug(const char *fmt, ...)
{
??? int nBuf;
??? char szBuffer[1024];
??? va_list args;
??? va_start(args, fmt);
??? nBuf = vsprintf(szBuffer, fmt, args) ;
??? assert(nBuf >= 0);
??? printf("QDOGC ERROR:%s\n",szBuffer);
??? va_end(args);
}