C語言可變參數的使用

概要

衆所周知，C++支出函數重載，而C語言默認是不支持。但是，c語言可以通過可變參數實現類似函數重載的功能。

如 Linux C 的open()函數，這個函數有2個版本。有一個可選的第三個參數時只需要文件可能被創建。第三個參數描述了使用新文件的權限設置。

#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>

int open(const char *pathname, int flags);
int open(const char *pathname, int flags, mode_t mode);

那麼我們如何指定一個可選的額外參數給C函數呢？這是一種C版本的函數重載。顯然它不是由C++的”碾壓”技術實現的，而是可以使用va_args包。

此函數的實現需要三個參數，最後一個參數爲可選的可變參數，而需要使用可選的第三個參數時，需要藉助第二個參數某個特定的值：

#include <stdio.h>
#include <stdarg.h>//va_list

void va_overload2(int p1, int p2)
{
    printf("va_overload2 %d %d\n", p1, p2);
}

void va_overload3(int p1, int p2, int p3)
{
    printf("va_overload3 %d %d %d\n", p1, p2, p3);
}

//第三個參數爲可變參數，使用...表示
static void va_overload(int p1, int p2, ...)
{
    if (p2 == 7)
    {
        va_list v;
        va_start(v, p2);

        int p3 = va_arg(v, int);
        va_end(v);
        va_overload3(p1, p2, p3);

        return;
    }

    va_overload2(p1, p2);
}

在上面的代碼中，我們通過解析參數，然後選擇調用 va_overload2() 或 va_overload3()。POSIX open()函數的原理和這個過程類似。

可變參數說明

#include <stdarg.h>//可變參數使用所需頭文件
#include <stdio.h>

//可變參數( ... )的前面，必須需要一個有名字的變量，通常值爲可變參數的個數
void func(int a, int n, ...)
{
    int i = 0;
    va_list ap; //可變參數列表

    //獲得不定參數的首地址
    //第一個參數爲可變參數列表變量
    //第二個參數必須爲可變參數前面的最後一個參數值，如這裏的n
    va_start(ap, n);

    for(i = 0; i < n; ++i)
    {
        // 獲得每一個可變參數
        // 每次調用va_arg都會改變ap值，使得後續的參數值能被依次添加
        //第一個參數爲可變參數列表變量
        //第二個參數爲類型
        int num = va_arg(ap, int);
        printf("num = %d\n", num);
    }

    //參數獲取完畢
    va_end(ap);
}

int main()
{
    func(1, 3, 10, 20, 30);

    return 0;
}

程序運行結果如下： 

上述的宏原型如下所示：

#include <stdarg.h>
void va_start(va_list ap, last_parm);
type va_arg(va_list ap, type);
void va_end(va_list ap);

 

va_list是在C語言中解決變參問題的一組宏，用於獲取不確定個數的參數。

在函數定義中，可變參數表之前必須有一個或多個已知參數，其中最右者爲last_parm。在調用va_start()時，last_parm名被用作第二個參數。

任何可變長度的變元被訪問之前，必須先用va_start()初始化變元指針ap。初始化ap後，經過對va_arg()的調用，以作爲下一個參數類型的參數類型，返回參數。最後取完所有參數並從函數返回之前,必須調用va_end()。由此確保堆棧的正確恢復。

案例

案例1

#include <stdarg.h>
#include <stdio.h>

//可變參數( ... )的前面，必須需要一個有名字的變量，通常值爲可變參數的個數
int sum(int n, ...)
{
    int i = 0;
    int all = 0;
    va_list ap; //可變參數列表

    //獲得不定參數的首地址
    //第一個參數爲可變參數列表變量
    //第二個參數必須爲可變參數前面的最後一個參數值，如這裏的n
    va_start(ap, n);

    for(i = 0; i < n; ++i)
    {
        // 獲得每一個可變參數
        // 每次調用va_arg都會改變ap值，使得後續的參數值能被依次添加
        //第一個參數爲可變參數列表變量
        //第二個參數爲類型
        int num = va_arg(ap, int);
        all += num; //累加
    }

    //參數獲取完畢
    va_end(ap);

    return all;
}

int main()
{
    //第一個參數爲可變參數個數
    int num = sum(5, 1, 2, 3, 4, 5);
    printf("num = %d\n", num);

    return 0;
}

案例2

#include <stdarg.h>
#include <stdio.h>

//可變參數( ... )的前面，必須需要一個有名字的變量
void my_print(const char *s, ...)
{
    const char *arg = s;
    va_list ap; //可變參數列表

    //獲得不定參數的首地址
    va_start(ap, s);

    while(arg)
    {
        // 獲得每一個可變參數
        // 每次調用va_arg都會改變ap值，使得後續的參數值能被依次添加
        // 第一個參數爲可變參數列表變量
        // 第二個參數爲類型
        printf("%s\n", arg);
        arg = va_arg(ap, const char*);
    }

    //參數獲取完畢
    va_end(ap);
}

int main()
{
    //最後一個參數爲NULL，作爲可變參數的結束符
    my_print("hello", "mike", "jiang", NULL);

    return 0;
}

案例3

#include <stdarg.h>
#include <stdio.h>

//C99規範支持了可變參數的宏
//'...'指可變參數, 這類宏在被調用時，它(這裏指'...')被表示成零個或多個符號，包括裏面的逗號，一直到到右括弧結束爲止
//當被調用時，在宏體(macro body)中，那些符號序列集合將代替裏面的__VA_ARGS__標識符
#define debug1(fmt, ...) printf(fmt, __VA_ARGS__)

#define debug2(format, arg...) printf("[%s: %d] " format, __FILE__, __LINE__, ##arg)

#define debug3(fmt, ...) my_print(__FILE__, __LINE__, fmt, __VA_ARGS__)
void my_print(const char* filename, int line, const char* fmt, ...)
{
    printf("[%s: %d] ", filename, line);
    va_list ap;
    va_start(ap, fmt);
    vprintf(fmt, ap);
    va_end(ap);
}

int main()
{
    debug1("hello %s, a = %d\n", "mike", 250);
    debug2("hello %s, a = %d\n", "mike", 250);
    debug3("hello %s, a = %d\n", "mike", 250);

    return 0;
}

程序運行結果如下：