stdargのヘルプ・マニュアル
日本語 英語
stdarg --help
man stdarg
STDARG(3) Linux Programmer’s Manual STDARG(3)
名前
stdarg, va_start, va_arg, va_end, va_copy - 個数・型が可変な引数リスト
書式
#include
void va_start(va_list ap, last);
type va_arg(va_list ap, type);
void va_end(va_list ap);
void va_copy(va_list dest, va_list src);
説明
関 数は呼び出しに際して、個数や型が可変な引数をとることができる。インク
ルードファイル では va_list 型が宣言されており、3 つのマクロ
が 定義されている。これらを用いると、呼び出された関数側では個数や型を知
らない引き数のリストを、順に一つづつ読み込むことができる。
呼び出される関数では、 va_list 型のオブジェクトが宣言されていなければな
ら ない。このオブジェクトが va_start(), va_arg(), va_end() の各マクロに
よって扱われる。
va_start()
va_start() マクロは最初に呼び出さなければならない。これは ap を初期化し
、 va_arg() と va_end() で用いることができるようにする。
引 き数 last は引き数リストのうち、可変な部分の直前に置かれる引き数の名
前である。つまり呼び出された関数が型を知っている最後の引き数である。
この引き数はレジスタ変数や関数、配列として宣言してはならない。この引 き
数のアドレスが va_start() マクロで用いられるかもしれないからである。
va_arg()
va_arg() マクロは、呼び出し時に指定された引き数のうち、次の位置にあるも
のを指定した型 type の値として取得する。引き数 ap は va_list ap で 、
va_start() によって初期化されている必要がある。 va_arg() を呼び出すごと
に ap は変更され、次回の呼び出しの際に、さらに次の引き数を返すように な
る。引き数 type は型の名前である。 type の前に * を付ければ、オブジェク
トへの型付きポインタが得られる。
va_start() マクロの直後に va_arg() を最初に実行すると、 last の次の引き
数が返る。続けて実行すると、残りの引き数がそれぞれ返る。
次 の引き数がなかったり、 type が次の引き数の実際の型と互換でない場合 (
デフォルトの引き数変換で扱えなかった場合) には、予測できないエラーが 起
こる。
ap が va_arg(ap,type) の形で関数に渡されると、 ap の値は関数から返って
来た後は不定となる。
va_end()
va_start() が実行される毎に、同じ関数内で対応する va_end() が実行されな
け ればならない。 va_end(ap) が呼び出された後、変数 ap の値は不定となる
。 va_start() と va_end() の組を何回も並べて使うことも可 能 で あ る 。
va_end() はマクロかもしれないし関数かもしれない。
va_copy()
す ぐ分かる va_list の実装は、variadic な関数のスタックフレームのポイン
タである。このような場合(ほとんどはそうである)、単に以下のようにすれ ば
いいように思える。
va_list aq = ap;
残 念ながら、(長さ 1の)ポインタの配列として扱うシステムもある。そのよう
な場合、以下のようにする必要がある。
va_list aq;
*aq = *ap;
最後に、引き数をレジスタで渡すシステムの場合、 va_start() でメモリを 割
り 当て、引き数を格納し、次の引き数がどれかを指し示すようにする必要があ
る。そして va_arg() でリストを順番にたどり、 va_end() で割り当てたメ モ
リを開放する。このような状況に対応するため、C99 では va_copy() マクロを
追加し、前述のような割り当ては以下のように置き換えられるようにした。
va_list aq;
va_copy(aq, ap);
...
va_end(aq);
va_copy() が実行されるごとに、対応する va_end() を同じ関数内で実行しなければな
ら ない。この名前はまだ draft proposal なので、 va_copy() の代わりに __va_copy
を用いるシステムもある。
準拠
va_start(), va_arg(), va_end() マクロは C89 準拠である。 va_copy() は
C99 で定義されている。
注意
こ れらのマクロは、以前から用いられてきた同等のマクロ群と互換ではない。
過去のものと互換なバージョンは、インクルードファイル に存在
する。
歴史的なセットアップは以下のとおりである。
#include
void
foo(va_alist)
va_dcl
{
va_list ap;
va_start(ap);
while (...) {
...
x = va_arg(ap, type);
...
}
va_end(ap);
}
va_start マクロに '}' を含み、 va_end マクロに対応する '{' を含むシステ
ムもあるので、この二つのマクロは同じ関数になければならない。
バグ
varargs マクロとは異なり、 stdarg マクロでは固定引き数なしで関数を指 定
することが許されていない。これは varargs ベースのコードを stdarg のコー
ドに書き換えるときに、面倒な作業のもとになる。また、すべての引 き 数 を
va_list として可変個指定したいような場合 (vfprintf(3) など) にも障害と
なる。
例
関数 foo は書式文字からなる文字列を受け入れ、その書式文字に対応する型で
可変個の引き数を読み込み、印字する。
#include
#include
void
foo(char *fmt, ...)
{
va_list ap;
int d;
char c, *s;
va_start(ap, fmt);
while (*fmt)
switch (*fmt++) {
case 's': /* string */
s = va_arg(ap, char *);
printf("string %s\n", s);
break;
case 'd': /* int */
d = va_arg(ap, int);
printf("int %d\n", d);
break;
case 'c': /* char */
/* need a cast here since va_arg only
takes fully promoted types */
c = (char) va_arg(ap, int);
printf("char %c\n", c);
break;
}
va_end(ap);
}
2001-10-14 STDARG(3)
STDARG(3) Linux Programmer’s Manual STDARG(3)
NAME
stdarg, va_start, va_arg, va_end, va_copy - variable argument lists
SYNOPSIS
#include
void va_start(va_list ap, last);
type va_arg(va_list ap, type);
void va_end(va_list ap);
void va_copy(va_list dest, va_list src);
DESCRIPTION
A function may be called with a varying number of arguments of varying
types. The include file declares a type va_list and defines
three macros for stepping through a list of arguments whose number and
types are not known to the called function.
The called function must declare an object of type va_list which is
used by the macros va_start(), va_arg(), and va_end().
va_start()
The va_start() macro initializes ap for subsequent use by va_arg() and
va_end(), and must be called first.
The argument last is the name of the last argument before the variable
argument list, that is, the last argument of which the calling function
knows the type.
Because the address of this argument may be used in the va_start()
macro, it should not be declared as a register variable, or as a func-
tion or an array type.
va_arg()
The va_arg() macro expands to an expression that has the type and value
of the next argument in the call. The argument ap is the va_list ap
initialized by va_start(). Each call to va_arg() modifies ap so that
the next call returns the next argument. The argument type is a type
name specified so that the type of a pointer to an object that has the
specified type can be obtained simply by adding a * to type.
The first use of the va_arg() macro after that of the va_start() macro
returns the argument after last. Successive invocations return the
values of the remaining arguments.
If there is no next argument, or if type is not compatible with the
type of the actual next argument (as promoted according to the default
argument promotions), random errors will occur.
If ap is passed to a function that uses va_arg(ap,type) then the value
of ap is undefined after the return of that function.
va_end()
Each invocation of va_start() must be matched by a corresponding invo-
cation of va_end() in the same function. After the call va_end(ap) the
variable ap is undefined. Multiple traversals of the list, each brack-
eted by va_start() and va_end() are possible. va_end() may be a macro
or a function.
va_copy()
An obvious implementation would have a va_list be a pointer to the
stack frame of the variadic function. In such a setup (by far the most
common) there seems nothing against an assignment
va_list aq = ap;
Unfortunately, there are also systems that make it an array of pointers
(of length 1), and there one needs
va_list aq;
*aq = *ap;
Finally, on systems where arguments are passed in registers, it may be
necessary for va_start() to allocate memory, store the arguments there,
and also an indication of which argument is next, so that va_arg() can
step through the list. Now va_end() can free the allocated memory
again. To accommodate this situation, C99 adds a macro va_copy(), so
that the above assignment can be replaced by
va_list aq;
va_copy(aq, ap);
...
va_end(aq);
Each invocation of va_copy() must be matched by a corresponding invoca-
tion of va_end() in the same function. Some systems that do not supply
va_copy() have __va_copy instead, since that was the name used in the
draft proposal.
CONFORMING TO
The va_start(), va_arg(), and va_end() macros conform to C89. C99
defines the va_copy() macro.
NOTES
These macros are not compatible with the historic macros they replace.
A backward compatible version can be found in the include file
.
The historic setup is:
#include
void
foo(va_alist)
va_dcl
{
va_list ap;
va_start(ap);
while (...) {
...
x = va_arg(ap, type);
...
}
va_end(ap);
}
On some systems, va_end contains a closing '}' matching a '{' in
va_start, so that both macros must occur in the same function, and in a
way that allows this.
BUGS
Unlike the varargs macros, the stdarg macros do not permit programmers
to code a function with no fixed arguments. This problem generates
work mainly when converting varargs code to stdarg code, but it also
creates difficulties for variadic functions that wish to pass all of
their arguments on to a function that takes a va_list argument, such as
vfprintf(3).
EXAMPLE
The function foo takes a string of format characters and prints out the
argument associated with each format character based on the type.
#include
#include
void
foo(char *fmt, ...)
{
va_list ap;
int d;
char c, *s;
va_start(ap, fmt);
while (*fmt)
switch (*fmt++) {
case 's': /* string */
s = va_arg(ap, char *);
printf("string %s\n", s);
break;
case 'd': /* int */
d = va_arg(ap, int);
printf("int %d\n", d);
break;
case 'c': /* char */
/* need a cast here since va_arg only
takes fully promoted types */
c = (char) va_arg(ap, int);
printf("char %c\n", c);
break;
}
va_end(ap);
}
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
2001-10-14 STDARG(3)