release/man3/stdarg.3

   1 .\" Copyright (c) 1990, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the American National Standards Committee X3, on Information
   6 .\" Processing Systems.
   7 .\"
   8 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"     This product includes software developed by the University of
  20 .\"     California, Berkeley and its contributors.
  21 .\" 4. Neither the name of the University nor the names of its contributors
  22 .\"    may be used to endorse or promote products derived from this software
  23 .\"    without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\" %%%LICENSE_END
  37 .\"
  38 .\"     @(#)stdarg.3    6.8 (Berkeley) 6/29/91
  39 .\"
  40 .\" Converted for Linux, Mon Nov 29 15:11:11 1993, faith@cs.unc.edu
  41 .\" Additions, 2001-10-14, aeb
  42 .\"
  43 .\"*******************************************************************
  44 .\"
  45 .\" This file was generated with po4a. Translate the source file.
  46 .\"
  47 .\"*******************************************************************
  48 .TH STDARG 3 2013\-03\-15 "" "Linux Programmer's Manual"
  49 .SH 名前
  50 stdarg, va_start, va_arg, va_end, va_copy \- 個数、型が可変な引数リスト
  51 .SH 書式
  52 \fB#include <stdarg.h>\fP
  53 .sp
  54 \fBvoid va_start(va_list \fP\fIap\fP\fB, \fP\fIlast\fP\fB);\fP
  55 .br
  56 \fItype\fP\fB va_arg(va_list \fP\fIap\fP\fB, \fP\fItype\fP\fB);\fP
  57 .br
  58 \fBvoid va_end(va_list \fP\fIap\fP\fB);\fP
  59 .br
  60 \fBvoid va_copy(va_list \fP\fIdest\fP\fB, va_list \fP\fIsrc\fP\fB);\fP
  61 .SH 説明
  62 関数は呼び出しに際して、個数や型が可変な引数をとることができる。 インクルードファイル \fI<stdarg.h>\fP では
  63 \fIva_list\fP 型が宣言されており、3 つのマクロが定義されている。これらを用いると、
  64 呼び出された関数側では個数や型を知らない引き数のリストを、順に一 つづつ読み込むことができる。
  65 .PP
  66 呼び出される関数では、 \fIva_list\fP 型のオブジェクトが宣言されていなければならない。このオブジェクトが \fBva_start\fP(),
  67 \fBva_arg\fP(), \fBva_end\fP()  の各マクロによって扱われる。
  68 .SS va_start()
  69 \fBva_start\fP()  マクロは最初に呼び出さなければならない。これは \fIap\fP を初期化し、 \fBva_arg\fP()  と
  70 \fBva_end\fP()  で用いることができるようにする。
  71 .PP
  72 引き数 \fIlast\fP は引き数リストのうち、可変な部分の直前に置かれる引き数の名前であ る。つまり呼び出された関数が型を知っている最後の引き数である。
  73 .PP
  74 この引き数はレジスタ変数や関数、配列として 宣言してはならない。この引き数のアドレスが \fBva_start\fP()
  75 マクロで用いられるかもしれないからである。
  76 .SS va_arg()
  77 \fBva_arg\fP()  マクロは、呼び出し時に指定された引き数のうち、 次の位置にあるものを指定した型 \fItype\fP の値として取得する。 引き数
  78 \fIap\fP は \fIva_list\fP \fIap\fP で、 \fBva_start\fP()  によって初期化されている必要がある。 \fBva_arg\fP()
  79 を呼び出すごとに \fIap\fP は変更され、次回の呼び出しの際に、さらに次の引き数を返すようになる。 引き数 \fItype\fP は型の名前である。
  80 \fItype\fP の前に * を付ければ、オブジェクトへの型付きポインタが得られる。
  81 .PP
  82 \fBva_start\fP()  マクロの直後に \fBva_arg\fP()  を最初に実行すると、 \fIlast\fP
  83 の次の引き数が返る。続けて実行すると、残りの引き数がそれぞれ返る。
  84 .PP
  85 次の引き数がなかったり、 \fItype\fP が次の引き数の実際の型と互換でない場合 (デフォルトの引き数変換で扱 えなかった場合)
  86 には、予測できないエラーが起こる。
  87 .PP
  88 \fIap\fP が \fBva_arg(\fP\fIap\fP\fB,\fP\fItype\fP\fB)\fP の形で関数に渡されると、 \fIap\fP
  89 の値は関数から返って来た後は不定となる。
  90 .SS va_end()
  91 \fBva_start\fP()  が実行される毎に、同じ関数内で対応する \fBva_end\fP()  が実行されなければならない。
  92 \fBva_end(\fP\fIap\fP\fB)\fP が呼び出された後、変数 \fIap\fP の値は不定となる。 \fBva_start\fP()  と \fBva_end\fP()
  93 の組を何回も並べて使うことも可能である。 \fBva_end\fP()  はマクロかもしれないし関数かもしれない。
  94 .SS va_copy()
  95 \fBva_copy\fP() マクロは (初期化済みの) 可変長引き数リスト \fIsrc\fP を \fIdest\fP にコピーする。動作は、 \fIlast\fP
  96 引き数に \fIdest\fP を渡して \fBva_start\fP() を \fIdest\fP に適用し、それから \fIsrc\fP
  97 が現在の状態に達するまでに呼び出したのと同じ回数だけ \fBva_arg\fP() を呼び出す、のと同じことを行う。
  98
  99 .\" Proposal from clive@demon.net, 1997-02-28
 100 すぐ分かる \fIva_list\fP の実装は、variadic な関数のスタックフレームのポインタである。 このような場合(ほとんどはそうである)、
 101 単に以下のようにすればいいように思える。
 102 .in +4n
 103 .nf
 104
 105 va_list aq = ap;
 106
 107 .fi
 108 .in
 109 残念ながら、(長さ 1の)ポインタの配列として扱うシステムもある。 そのような場合、以下のようにする必要がある。
 110 .in +4n
 111 .nf
 112
 113 va_list aq;
 114 *aq = *ap;
 115
 116 .fi
 117 .in
 118 最後に、引き数をレジスタで渡すシステムの場合、 \fBva_start\fP()  でメモリを割り当て、引き数を格納し、
 119 次の引き数がどれかを指し示すようにする必要がある。 そして \fBva_arg\fP()  でリストを順番にたどり、 \fBva_end\fP()
 120 で割り当てたメモリを開放する。 このような状況に対応するため、C99 では \fBva_copy\fP()  マクロを追加し、
 121 前述のような割り当ては以下のように置き換えられるようにした。
 122 .in +4n
 123 .nf
 124
 125 va_list aq;
 126 va_copy(aq, ap);
 127 \&...
 128 va_end(aq);
 129
 130 .fi
 131 .in
 132 \fBva_copy\fP()  が実行されるごとに、 対応する \fBva_end\fP()  を同じ関数内で実行しなければならない。 この名前はまだ draft
 133 proposal なので、 \fBva_copy\fP()  の代わりに \fB__va_copy\fP を用いるシステムもある。
 134 .SH 準拠
 135 \fBva_start\fP(), \fBva_arg\fP(), \fBva_end\fP()  マクロは C89 準拠である。 \fBva_copy\fP()  は C99
 136 で定義されている。
 137 .SH 注意
 138 これらのマクロは、以前から用いられてきた同等のマクロ群と 互換では\fIない\fP。過去のものと互換なバージョンは、 インクルードファイル
 139 \fI<varargs.h>\fP に存在する。
 140 .PP
 141 歴史的なセットアップは以下のとおりである。
 142 .in +4n
 143 .nf
 144
 145 #include <varargs.h>
 146
 147 void
 148 foo(va_alist)
 149     va_dcl
 150 {
 151     va_list ap;
 152
 153     va_start(ap);
 154     while (...) {
 155         ...
 156         x = va_arg(ap, type);
 157         ...
 158     }
 159     va_end(ap);
 160 }
 161
 162 .fi
 163 .in
 164 \fIva_start\fP マクロに \(aq}\(aq を含み、 \fIva_end\fP マクロに対応する \(aq{\(aq を含むシステムもあるので、
 165 この二つのマクロは同じ関数になければならない。
 166 .SH バグ
 167 \fBvarargs\fP マクロとは異なり、 \fBstdarg\fP マクロでは固定引き数なしで関数を指定することが許されていない。 これは
 168 \fBvarargs\fP ベースのコードを \fBstdarg\fP のコードに書き換えるときに、面倒な作業のもとになる。 また、すべての引き数を
 169 \fIva_list\fP として可変個指定したいような場合 (\fBvfprintf\fP(3)  など) にも障害となる。
 170 .SH 例
 171 関数 \fIfoo\fP は書式文字からなる文字列を受け入れ、その書式文字に対応する型で可変個の 引き数を読み込み、印字する。
 172 .nf
 173
 174 #include <stdio.h>
 175 #include <stdarg.h>
 176
 177 void
 178 foo(char *fmt, ...)
 179 {
 180     va_list ap;
 181     int d;
 182     char c, *s;
 183
 184     va_start(ap, fmt);
 185     while (*fmt)
 186         switch (*fmt++) {
 187         case \(aqs\(aq:              /* string */
 188             s = va_arg(ap, char *);
 189             printf("string %s\en", s);
 190             break;
 191         case \(aqd\(aq:              /* int */
 192             d = va_arg(ap, int);
 193             printf("int %d\en", d);
 194             break;
 195         case \(aqc\(aq:              /* char */
 196             /* need a cast here since va_arg only
 197                takes fully promoted types */
 198             c = (char) va_arg(ap, int);
 199             printf("char %c\en", c);
 200             break;
 201         }
 202     va_end(ap);
 203 }
 204 .fi
 205 .SH この文書について
 206 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 207 である。プロジェクトの説明とバグ報告に関する情報は
 208 http://www.kernel.org/doc/man\-pages/ に書かれている。