draft/man3/fmemopen.3

   1 .\" Copyright 2005 walter harms (walter.harms@informatik.uni-oldenburg.de),
   2 .\" and Copyright 2005, 2012 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   5 .\" Distributed under the GPL.
   6 .\" %%%LICENSE_END
   7 .\"
   8 .\" 2008-12-04, Petr Baudis <pasky@suse.cz>: Document open_wmemstream()
   9 .\"
  10 .\"*******************************************************************
  11 .\"
  12 .\" This file was generated with po4a. Translate the source file.
  13 .\"
  14 .\"*******************************************************************
  15 .\"
  16 .\" Japanese Version Copyright (c) 2005, 2006 Akihiro MOTOKI
  17 .\"                     all rights reserved.
  18 .\" Translated 2005-12-26, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  19 .\" Updated 2006-01-20, Akihiro MOTOKI
  20 .\" Updated 2006-07-20, Akihiro MOTOKI
  21 .\" Updated 2008-11-08, Akihiro MOTOKI, LDP v3.13
  22 .\" Updated 2010-04-18, Akihiro MOTOKI, LDP v3.24
  23 .\" Updated 2012-05-30, Akihiro MOTOKI <amotoki@gmail.com>
  24 .\"
  25 .TH FMEMOPEN 3 2012\-04\-28 GNU "Linux Programmer's Manual"
  26 .SH 名前
  27 fmemopen, open_memstream, open_wmemstream \- メモリをストリームとしてオープンする
  28 .SH 書式
  29 .nf
  30 \fB#include <stdio.h>\fP
  31
  32 \fBFILE *fmemopen(void *\fP\fIbuf\fP\fB, size_t \fP\fIsize\fP\fB, const char *\fP\fImode\fP\fB);\fP
  33
  34 \fBFILE *open_memstream(char **\fP\fIptr\fP\fB, size_t *\fP\fIsizeloc\fP\fB);\fP
  35
  36 \fB#include <wchar.h>\fP
  37
  38 \fBFILE *open_wmemstream(wchar_t **\fP\fIptr\fP\fB, size_t *\fP\fIsizeloc\fP\fB);\fP
  39 .fi
  40 .sp
  41 .in -4n
  42 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  43 .in
  44 .sp
  45 \fBfmemopen\fP(), \fBopen_memstream\fP(), \fBopen_wmemstream\fP():
  46 .PD 0
  47 .ad l
  48 .RS 4
  49 .TP  4
  50 glibc 2.10 以降:
  51 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  52 .TP
  53 glibc 2.10 より前:
  54 _GNU_SOURCE
  55 .RE
  56 .ad
  57 .PD
  58 .SH 説明
  59 \fBfmemopen\fP()  関数は、ストリームをオープンし、そのストリームに \fImode\fP で指定されたアクセス許可を設定する。
  60 そのストリームを通じて、 \fIbuf\fP で指定された文字列やメモリバッファへの読み書きができる。 このバッファは少なくとも \fIsize\fP
  61 バイトの長さでなければならない。
  62 .PP
  63 引き数 \fImode\fP は \fBfopen\fP(3) の場合と同じである。 \fImode\fP で追記モード
  64 (append mode) が指定された場合、ファイル位置の初期値は バッファ中の
  65 最初の NULL バイト (\(aq\e0\(aq) の位置に設定される。
  66 それ以外の場合は、ファイル位置の初期値はバッファの先頭になる。
  67 glibc 2.9 以降では、文字 \(aqb\(aq を \fImode\fP の二番目の文字として指定
  68 することができる。 この文字は「バイナリ」モードを指定するものである。
  69 このモードでは、書き込み時に文字列終端のヌルバイトが黙って追加 される
  70 ことはない。また、 \fBfseek\fP(3) \fBSEEK_END\fP は、文字列の長さからの相対値
  71 ではなく、バッファの末尾 (\fIsize\fP で指定した値) からの相対値となる。
  72 .PP
  73 書き込み用にオープンされたストリームをフラッシュ (\fBfflush\fP(3))  やクローズ (\fBfclose\fP(3))  した時に、
  74 (バッファに空きがあれば) NULL バイトがバッファの末尾に書き込まれる。 このようにするためには、呼び出し元は バッファに 1バイト余裕を作る
  75 (\fIsize\fP にこの 1バイトを含めた値を指定する) 必要がある。
  76
  77 .\" See http://sourceware.org/bugzilla/show_bug.cgi?id=1995
  78 .\" and
  79 .\" http://sources.redhat.com/ml/libc-alpha/2006-04/msg00064.html
  80 バッファに \fIsize\fP バイトよりたくさん書き込もうとした場合には、エラーとなる。 (デフォルトでは、このようなエラーが見えるのは \fIstdio\fP
  81 バッファがフラッシュされた時だけである。 \fIsetbuf(fp,\ NULL)\fP を使ってバッファリングを無効にする方法は、
  82 出力操作を行った時点でエラーを検出するのに役立つ。 別の方法としては、 \fIsetbuffer(fp, buf, size)\fP
  83 を使って、呼び出し側が明示的に stdio ストリームバッファとして \fIbuf\fP を指定し、バッファの指定時にバッファのサイズを stdio
  84 に教える方法がある。)
  85 .PP
  86 読み出し用にオープンされたストリームでは、 バッファ内に NULL バイト (\(aq\e0\(aq) があっても 読み出し操作がファイル末尾
  87 (end\-of\-file) を返すことはない。 バッファからの読み出しでファイル末尾が返るのは、 ファイルポインタがバッファの先頭から \fIsize\fP
  88 バイトを越えて先に進もうとした場合だけである。
  89 .PP
  90 \fIbuf\fP に NULL が指定された場合、 \fBfmemopen\fP()  は動的に \fIsize\fP バイトの長さのバッファを確保する。
  91 この方法は、一時バッファにデータの書き込みを行ってから、 その内容を再度読み出すようなアプリケーションで有用である。
  92 このバッファはストリームがクローズされるときに自動的に解放される。 呼び出し元からはこの関数が割り当てた一時バッファへのポインタ値を
  93 知る方法は存在しない点に注意 (下記の \fBopen_memstream\fP()  も参照)。
  94
  95 \fBopen_memstream\fP()  関数は、バッファへの書き込み用にストリームをオープンする。 バッファは (\fBmalloc\fP(3)
  96 を使って) 動的に割り当てられ、必要に応じて自動的に伸長する。 ストリームをクローズした後で、呼び出し元はこのバッファを \fBfree\fP(3)
  97 すべきである。
  98
  99 このストリームが クローズ (\fBfclose\fP(3))  されたりフラッシュ (\fBfflush\fP(3))  された時に、 \fIptr\fP と
 100 \fIsizeloc\fP の値はそれぞれバッファへのポインタとそのサイズに更新される。 これらの値は、呼び出し元がそのストリームに新たな書き込みを
 101 行わない場合に限り有効である。 ストリームに書き込みを行った際には、これらの変数を参照する前に ストリームを再度フラッシュしなければならない。
 102
 103 バッファ末尾の NULL バイトは保持される。 この NULL バイトは \fIsizeloc\fP に格納されるサイズには「含まれない」。
 104
 105 ストリームのファイル位置は \fBfseek\fP(3)  や \fBfseeko\fP(3)  で変更できる。
 106 すでにデータが書き込まれた領域の末尾より先にファイル位置を動かすと、 その間の領域は 0 で埋められる。
 107
 108 \fBopen_wmemstream\fP()  は \fBopen_memstream\fP()
 109 と同様だが、バイトではなくワイド文字に対して操作を行う点が異なる。
 110 .SH 返り値
 111 成功して終了した場合には、 \fBfmemopen\fP(), \fBopen_memstream\fP(), \fBopen_wmemstream\fP()  は
 112 \fIFILE\fP ポインタを返す。 失敗した場合は、 NULL を返し、 \fIerrno\fP にエラーを示す値をセットする。
 113 .SH バージョン
 114 \fBfmemopen\fP()  と \fBopen_memstream\fP()  は glibc 1.0.x ですでに利用可能であった。
 115 \fBopen_wmemstream\fP()  は glibc 2.4 以降で利用可能である。
 116 .SH 準拠
 117 POSIX.1\-2008.  これらの関数は POSIX.1\-2001 では規定れていないが、 Linux 以外のシステムで広く利用可能である。
 118
 119 .\" http://austingroupbugs.net/view.php?id=396
 120 POSIX.1\-2008 では \fImode\fP の \(aqb\(aq は無視されるべきだと規定されて
 121 いる。一方、Technical Corrigendum (正誤表) 1 では、\fImode\fP の
 122 \(aqb\(aq が指定された場合の扱いは実装依存であることを許容するように
 123 標準規格が修正されており、glibc の \(aqb\(aq の扱いは許されている。
 124 .SH 注意
 125 これらの関数が返すファイルストリームに対応するファイル ディスクリプタはない (つまり、返されたストリームに対して \fBfileno\fP(3)
 126 を呼び出すとエラーが返ることになる)。
 127 .SH バグ
 128 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=1996
 129 バージョン 2.7 より前の glibc では、 \fBopen_memstream\fP()
 130 で作成されたストリームの末尾より先にファイル位置を動かしても、 バッファが伸長されず、 \fBfseek\fP(3)  が失敗し \-1 が返る。
 131
 132 .\" FIXME http://sourceware.org/bugzilla/show_bug.cgi?id=11216
 133 \fIsize\fP に 0 が指定された場合、 \fBfmemopen\fP() はエラー \fBEINVAL\fP で失敗
 134 する。この場合にはストリームの作成に成功して、最初の読み出しを行った際に
 135 EOF (end of file) が返される方が、ストリームの扱いの一貫性が増すだろう。
 136 また、 POSIX.1\-2008 ではこの場合のエラーは規定されていない。
 137
 138 .\" FIXME http://sourceware.org/bugzilla/show_bug.cgi?id=13152
 139 \fBfmemopen\fP() に追記モード ("a" や "a+") を指定すると、
 140 ファイル位置の初期値は最初の NULL バイトに設定されるが、(ファイル
 141 オフセットをストリームの末尾以外の位置に再設定した場合)それ以降の
 142 書き込みではストリームの末尾への追記が行われる訳ではない。
 143
 144 .\" FIXME http://sourceware.org/bugzilla/show_bug.cgi?id=13151
 145 \fBfmemopen\fP() の \fImode\fP 引き数に追記モード ("a" や "a+") を指定し、
 146 \fIsize\fP 引き数で指定した範囲の \fIbuf\fP 内に NULL バイトがない場合、
 147 POSIX.1\-2008 では、ファイル位置の初期値はバッファの末尾の直後の
 148 バイトに設定すべきとされている。しかし、glibc の \fBfmemopen\fP() では
 149 この場合ファイル位置は \-1 に設定される。
 150
 151 .\" FIXME http://sourceware.org/bugzilla/show_bug.cgi?id=12836
 152 \fBfmemopen\fP() でバイナリモードを指定するには、
 153 \(aqb\(aq は \fImode\fP の \fI2 文字目\fP でなければならない。
 154 例えば、 "wb+" は意図通りの効果になるが、 "w+b" はそうではない。
 155 これは \fBfopen\fP(3) の \fImode\fP の扱いとは異なる。
 156
 157 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=6544
 158 glibc 2.9 での \fBfmemopen\fP() の「バイナリ」モードの追加は、
 159 ABI (Application Binary Interface) が黙って変更された。
 160 それ以前の \fBfmemopen\fP() では \fImode\fP 内の \(aqb\(aq は無視されていた。
 161 .SH 例
 162 このプログラムは \fBfmemopen\fP()  を使って出力バッファをオープンし、 \fBopen_memstream\fP()
 163 を使って動的にサイズが変化する出力バッファをオープンしている。 (プログラムの第一コマンドライン引き数から取った) 入力文字列を
 164 スキャンして整数を読み込み、これらの整数の二乗を出力バッファに書き出す。 このプログラムの実行例は以下のようになる。
 165 .in +4n
 166 .nf
 167
 168 $\fB ./a.out \(aq1 23 43\(aq\fP
 169 size=11; ptr=1 529 1849
 170 .fi
 171 .in
 172 .SS プログラムのソース
 173 \&
 174 .nf
 175 #define _GNU_SOURCE
 176 #include <string.h>
 177 #include <stdio.h>
 178 #include <stdlib.h>
 179
 180 #define handle_error(msg) \e
 181     do { perror(msg); exit(EXIT_FAILURE); } while (0)
 182
 183 int
 184 main(int argc, char *argv[])
 185 {
 186     FILE *out, *in;
 187     int v, s;
 188     size_t size;
 189     char *ptr;
 190
 191     if (argc != 2) {
 192         fprintf(stderr, "Usage: %s <file>\en", argv[0]);
 193         exit(EXIT_FAILURE);
 194     }
 195
 196     in = fmemopen(argv[1], strlen(argv[1]), "r");
 197     if (in == NULL)
 198         handle_error("fmemopen");
 199
 200     out = open_memstream(&ptr, &size);
 201     if (out == NULL)
 202         handle_error("open_memstream");
 203
 204     for (;;) {
 205         s = fscanf(in, "%d", &v);
 206         if (s <= 0)
 207             break;
 208
 209         s = fprintf(out, "%d ", v * v);
 210         if (s == \-1)
 211             handle_error("fprintf");
 212     }
 213     fclose(in);
 214     fclose(out);
 215     printf("size=%ld; ptr=%s\en", (long) size, ptr);
 216     free(ptr);
 217     exit(EXIT_SUCCESS);
 218 }
 219 .fi
 220 .SH 関連項目
 221 \fBfopen\fP(3), \fBfopencookie\fP(3)
 222 .SH この文書について
 223 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 224 である。プロジェクトの説明とバグ報告に関する情報は
 225 http://www.kernel.org/doc/man\-pages/ に書かれている。