小粋空間  -  a cheap joke and a play on words site

C++の可変長引数（va_list）の使い方

C++の可変長引数（va_list）の使い方について紹介します。

１．可変長引数とは

可変長引数は、関数宣言および関数定義の最後の引数が省略記号（...）である場合、可変数の引数を受け取ることができるものです。

Func( int i, ... );

上記のように、省略記号が最後の引数で、省略記号（...）の前にカンマにある場合に限り、省略記号が可変長引数となります。

２．サンプル1

下記のサンプルは、関数「hoge」起動時の第1パラメータに可変長引数の総数「5」、第2パラメータ以降（＝可変長引数）に「H」「e」「l」「l」「o」を渡し、表示させるものです。

#include <stdio.h>
#include <stdarg.h>
 
void hoge( int num, ...) {
    va_list args;
    va_start( args, num );
    for( int i = 0; i < num; ++i ) {
        printf( "%c\n", va_arg( args, char* ) );
    }
    va_end( args );
}
 
int main () {
   hoge( 5, 'H', 'e', 'l', 'l', 'o' );
}

各マクロの意味は次のとおりです。

va_start

可変長引数リストを初期化します。

• 第1パラメータ：引数リスト
• 第2パラメータ：指定した引数以降を引数リストに格納

サンプルでは、

va_start( args, num );

となっているので、引数リストargsに、num以降の引数を格納します。

va_arg

引数リストから順番に値を取得します。

• 第1パラメータ：引数リスト
• 第2パラメータ：取得時の型

サンプルでは、

va_arg( args, char* )

となっているので、引数リストargsからchar*型で値を取得します。

va_end

引数リストをクリアします。

• 第1パラメータ：引数リスト

引数リストの操作が終わった後、この処理が必要なようです。

可変長引数マクロでは引数の個数を判断できないため、関数呼び出し時に引数の数を判断できる情報を第1パラメータで渡すのが定石のようです。

前述のサンプルでは、第1パラメータで指定された値をfor文の繰り返し回数に用いて、引数を取得・表示します。

    for( int i = 0; i < num; ++i ) {
        printf( "%c\n", va_arg( args, char* ) );
    }

３．サンプル2

前述のサンプルでは一意の型しか扱えないため、実践で使えそうなサンプルを作ってみました。

#include <stdio.h>
#include <stdarg.h>
 
void hoge( char *types, ...) {
    va_list args;
    va_start( args, types );
    for( int i = 0; types[i] != '\0'; ++i ) {
        printf( "%c:", types[i] );
        switch( types[i] ) {
        case 'i':
            printf( "%i\n", va_arg( args, int ) );
            break;
         case 'f':
            printf( "%f\n", va_arg( args, double ) );
            break;
         case 'c':
             printf( "%c\n", va_arg( args, char* ) );
             break;
         case 's':
             printf( "%s\n", va_arg( args, char* ) );
             break;
         default:
             break;
        }
    }
    va_end( args );
}
 
int main () {
   hoge( "ifcs", 30, 15.7f, 'a', "Hello World!" );
}

このサンプルでは、引数の数および型を第1パラメータで渡し、型によってswitch文で分岐させるようにしています。

４．参考サイト

参考サイトは下記です。ありがとうございました。

• 可変個の引数リストを取る関数 (C++)
• 可変個数の引数リスト va_list (va_start/va_arg/va_end)