C言語：可変長引数関数の使い方をマスターしよう！

可変長引数関数と va_arg マクロ

可変長引数関数とは、引数の個数が呼び出しごとに異なる関数を指します。printf 関数はその代表的な例です。

printf("Hello, %s!\n", name);
printf("The number is %d.\n", number);

printf 関数は、フォーマット文字列とそれに続く可変個の引数を受け取ります。フォーマット文字列は、どのように引数を解釈して出力するかを指定します。

va_arg マクロは、可変長引数リストから指定された型の引数を取得するために使用されます。

• va_list 型の変数: 可変長引数リストへのポインター
• type: 取得する引数の型

void print_numbers(int n, ...) {
  va_list ap;
  va_start(ap, n);

  for (int i = 0; i < n; i++) {
    int num = va_arg(ap, int);
    printf("%d ", num);
  }

  va_end(ap);
}

この例では、print_numbers 関数は最初の引数 n で指定された個数の整数を受け取ります。

• va_start マクロ: 可変長引数リスト ap を初期化し、最初の引数へのポインターを設定します。
• va_arg マクロ: ap から int 型の引数を取得します。
• va_end マクロ: 可変長引数リスト ap を解放します。

va_arg マクロの注意点

• va_arg マクロは、可変長引数リストから引数を取得する順番に注意する必要があります。
• 取得する引数の型と、実際に渡された引数の型が一致する必要があります。

その他の可変長引数関数関連のマクロ

• va_start: 可変長引数リストを初期化
• va_end: 可変長引数リストを解放
• va_copy: 可変長引数リストをコピー

可変長引数関数を使ったサンプルコード

複数の数値の合計を出力する関数

int sum_numbers(int n, ...) {
  va_list ap;
  va_start(ap, n);

  int sum = 0;
  for (int i = 0; i < n; i++) {
    int num = va_arg(ap, int);
    sum += num;
  }

  va_end(ap);

  return sum;
}

int main() {
  int sum = sum_numbers(3, 1, 2, 3);
  printf("The sum is %d.\n", sum);

  return 0;
}

可変個の文字列を出力する関数

void print_strings(int n, ...) {
  va_list ap;
  va_start(ap, n);

  for (int i = 0; i < n; i++) {
    const char* str = va_arg(ap, const char*);
    printf("%s ", str);
  }

  va_end(ap);

  printf("\n");
}

int main() {
  print_strings(3, "Hello", "World", "!");

  return 0;
}

標準入力から数値を読み込み、合計を出力する関数

int sum_stdin() {
  int sum = 0;
  int num;

  while (scanf("%d", &num) == 1) {
    sum += num;
  }

  return sum;
}

int main() {
  int sum = sum_stdin();
  printf("The sum is %d.\n", sum);

  return 0;
}

ファイルの内容を出力する関数

void print_file(const char* filename) {
  FILE* fp = fopen(filename, "r");
  if (fp == NULL) {
    perror("fopen");
    return;
  }

  char buf[BUFSIZ];
  while (fgets(buf, sizeof(buf), fp)) {
    printf("%s", buf);
  }

  fclose(fp);
}

int main() {
  print_file("sample.txt");

  return 0;
}

任意の型の引数を可変長引数リストとして受け取る関数

void print_any_type(int n, ...) {
  va_list ap;
  va_start(ap, n);

  for (int i = 0; i < n; i++) {
    // 型情報を取得
    va_list ap_copy;
    va_copy(ap_copy, ap);
    int type = va_arg(ap_copy, int);

    // 型に応じて処理
    switch (type) {
      case INT:
        printf("%d ", va_arg(ap, int));
        break;
      case FLOAT:
        printf("%f ", va_arg(ap, double));
        break;
      case CHAR:
        printf("%c ", va_arg(ap, char));
        break;
    }
  }

  va_end(ap);

  printf("\n");
}

int main() {
  print_any_type(3, INT, 1, FLOAT, 3.14, CHAR, 'a');

  return 0;
}

可変長引数関数を扱うその他の方法

可変長引数リストを直接操作する

va_list 型の変数を直接操作することで、可変長引数リストから引数を取得することができます。ただし、この方法は複雑で、誤りやすいので注意が必要です。

配列を使う

可変長引数を配列に格納してから処理することができます。ただし、事前に必要な要素数を予測しておく必要があり、可変長引数の数がわからない場合は使用できません。

構造体を使う

可変長引数を構造体に格納してから処理することができます。ただし、構造体の定義や初期化が複雑になる場合があります。

専用のライブラリを使う

stdarg.h ヘッダーファイルには、可変長引数関数を扱うためのいくつかの関数を提供しています。これらの関数は、va_arg マクロよりも使いやすく、安全です。

C++を使う

C++では、std::va_list クラスと std::va_arg マクロを使って、可変長引数関数を扱うことができます。C言語よりも安全で使いやすい方法です。

• 簡単な処理の場合は、va_arg マクロを使うのが最も簡単です。
• 複雑な処理の場合は、専用ライブラリを使うのが安全です。
• C++を使う場合は、std::va_list クラスと std::va_arg マクロを使うのがおすすめです。

以下は、stdarg.h ヘッダーファイルの va_start、va_arg、va_end 関数を使って可変長引数関数を扱うサンプルコードです。

#include <stdarg.h>

int sum_numbers(int n, ...) {
  va_list ap;
  va_start(ap, n);

  int sum = 0;
  for (int i = 0; i < n; i++) {
    sum += va_arg(ap, int);
  }

  va_end(ap);

  return sum;
}

int main() {
  int sum = sum_numbers(3, 1, 2, 3);
  printf("The sum is %d.\n", sum);

  return 0;
}

可変長引数関数は、引数の個数が呼び出しごとに異なる関数を定義するための便利な機能です。va_arg マクロや専用ライブラリを使って、さまざまな方法で可変長引数関数を扱うことができます。