名前¶

perlapio - perl の抽象入出力インターフェース

概要¶

  #define PERLIO_NOT_STDIO 0    /* For co-existence with stdio only */
  #include <perlio.h>           /* Usually via #include <perl.h> */

  PerlIO *PerlIO_stdin(void);
  PerlIO *PerlIO_stdout(void);
  PerlIO *PerlIO_stderr(void);

  PerlIO *PerlIO_open(const char *path,const char *mode);
  PerlIO *PerlIO_fdopen(int fd, const char *mode);
  PerlIO *PerlIO_reopen(const char *path, /* deprecated */
          const char *mode, PerlIO *old);
  int     PerlIO_close(PerlIO *f);

  int     PerlIO_stdoutf(const char *fmt,...)
  int     PerlIO_puts(PerlIO *f,const char *string);
  int     PerlIO_putc(PerlIO *f,int ch);
  SSize_t PerlIO_write(PerlIO *f,const void *buf,size_t numbytes);
  int     PerlIO_printf(PerlIO *f, const char *fmt,...);
  int     PerlIO_vprintf(PerlIO *f, const char *fmt, va_list args);
  int     PerlIO_flush(PerlIO *f);

  int     PerlIO_fill(PerlIO *f);
  int     PerlIO_eof(PerlIO *f);
  int     PerlIO_error(PerlIO *f);
  void    PerlIO_clearerr(PerlIO *f);

  int     PerlIO_getc(PerlIO *d);
  int     PerlIO_ungetc(PerlIO *f,int ch);
  SSize_t PerlIO_read(PerlIO *f, void *buf, size_t numbytes);
  Size_t  PerlIO_unread(PerlIO *f,const void *vbuf, size_t count

  int     PerlIO_fileno(PerlIO *f);

  void    PerlIO_setlinebuf(PerlIO *f);

  Off_t   PerlIO_tell(PerlIO *f);
  int     PerlIO_seek(PerlIO *f, Off_t offset, int whence);
  void    PerlIO_rewind(PerlIO *f);

  int     PerlIO_getpos(PerlIO *f, SV *save);    /* prototype changed */
  int     PerlIO_setpos(PerlIO *f, SV *saved);   /* prototype changed */

  int     PerlIO_fast_gets(PerlIO *f);
  int     PerlIO_has_cntptr(PerlIO *f);
  SSize_t PerlIO_get_cnt(PerlIO *f);
  char   *PerlIO_get_ptr(PerlIO *f);
  void    PerlIO_set_ptrcnt(PerlIO *f, char *ptr, SSize_t count);

  int     PerlIO_canset_cnt(PerlIO *f);              /* deprecated */
  void    PerlIO_set_cnt(PerlIO *f, int count);      /* deprecated */

  int     PerlIO_has_base(PerlIO *f);
  char   *PerlIO_get_base(PerlIO *f);
  SSize_t PerlIO_get_bufsiz(PerlIO *f);

  PerlIO *PerlIO_importFILE(FILE *stdio, const char *mode);
  FILE   *PerlIO_exportFILE(PerlIO *f, const char *mode);
  FILE   *PerlIO_findFILE(PerlIO *f);
  void    PerlIO_releaseFILE(PerlIO *f,FILE *stdio);

  int     PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode,
                                                    const char *layers);
  int     PerlIO_binmode(pTHX_ PerlIO *f, int ptype, int imode,
                                                    const char *layers);
  void    PerlIO_debug(const char *fmt,...);

説明¶

Perl のソースコードと、最大の移植性を求めるエクステンションでは、 ANSI C の stdio.h にある関数ではなく上記の関数を使うべきです。 perl のヘッダ (特に "perlio.h") が Configure の実行時に選択した I/O 機構へ #define します。

これらの関数は stdio.h にあるものがモデルになっていますが、 それに渡すパラメーターは「ちょっとばかし整頓」されています。

PerlIO * は FILE * のようなものです。 FILE * と同様に、これは不透明なものとして扱われます(これを何かへの ポインタとして仮定することはおそらく安全です)。

現在のところ二つの実装があります:

1. USE_STDIO

All above are #define'd to stdio functions or are trivial wrapper functions which call stdio. In this case only PerlIO * is a FILE *. This has been the default implementation since the abstraction was introduced in perl5.003_02.

上記の全ては stdio 関数への #define か、stdio を呼び出すためのありふれた ラッパ関数です。 この場合 のみ、PerlIO * は FILE * です。 抽象化が導入された perl5.003_02 以来、これがデフォルトの実装でした。

2. USE_PERLIO

Introduced just after perl5.7.0, this is a re-implementation of the above abstraction which allows perl more control over how IO is done as it decouples IO from the way the operating system and C library choose to do things. For USE_PERLIO PerlIO * has an extra layer of indirection - it is a pointer-to-a-pointer. This allows the PerlIO * to remain with a known value while swapping the implementation around underneath at run time. In this case all the above are true (but very simple) functions which call the underlying implementation.

これは perl5.7.0 の直後に導入された、上述の抽象化の再実装です; これによって IO を OS と C ライブラリが物事を行うための選択と切り離すために、 IO がどのように行われるかを perl がより制御できるようになります。 USE_PERLIO では、PerlIO * は間接化の追加の層を持ちます - これは点対点です。 これにより、PerlIO * は既知の値のまま、基礎となる実装を 実行時に 交換することができます。 この場合上述の全ては基礎となる実装を呼び出す本当の(しかしとても単純な) 関数です。

This is the only implementation for which PerlIO_apply_layers() does anything "interesting".

これは PerlIO_apply_layers() が何か「興味ある」ことを行う唯一の 実装です。

The USE_PERLIO implementation is described in perliol.

USE_PERLIO 実装については perliol に記述されています。

"perlio.h" は(効率のために)薄い層になっているので、これらの関数の意味は 基礎となる実装に若干依存しています。 変化があると分かっているところは以下に言及しています。

特に注意がなければ、関数は成功時に 0 を返し、エラー時には負数(普通は -1 の値を持つ EOF)を返して errno をセットします。

PerlIO_stdin(), PerlIO_stdout(), PerlIO_stderr()

Use these rather than stdin, stdout, stderr. They are written to look like "function calls" rather than variables because this makes it easier to make them function calls if platform cannot export data to loaded modules, or if (say) different "threads" might have different values.

stdin, stdout, stderr の代わりに使ってください。 これらは変数でなく“関数呼び出し”のように記述されていますが、 これは使用するプラットフォームにおいてロードモジュールに対するデータの エクスポートができなかったり、あるいは異なる“スレッド”が異なる値を 持つ可能性があるといったときに、これらを 関数呼び出しにする のが 簡単になるからです。

PerlIO_open(path, mode), PerlIO_fdopen(fd,mode)

These correspond to fopen()/fdopen() and the arguments are the same. Return NULL and set errno if there is an error. There may be an implementation limit on the number of open handles, which may be lower than the limit on the number of open files - errno may not be set when NULL is returned if this limit is exceeded.

fopen()/fdopen() に対応し、同じ引数を取ります。 エラーの場合は NULL を返し、errno をセットします。 オープンするハンドルの数には実装の制限があるかもしれず、これはオープンする ファイルの数の制限より低いかもしれません - この制限を越えて NULL を返されると、errno はセットされません。

PerlIO_reopen(path,mode,f)

While this currently exists in both implementations, perl itself does not use it. As perl does not use it, it is not well tested.

これは現在のところ両方の実装に存在していますが、perl 自身はこれを 使っていません。 perl が使っていないので、十分にテストされていません。

Perl prefers to dup the new low-level descriptor to the descriptor used by the existing PerlIO. This may become the behaviour of this function in the future.

Perl は存在する PerlIO によって使われている記述子よりも、新しい低レベル 記述子を dup することを好みます。 これは将来この関数の振る舞いになるかもしれません。

PerlIO_printf(f,fmt,...), PerlIO_vprintf(f,fmt,a)

These are fprintf()/vfprintf() equivalents.

fprintf()/vfprintf() と等価です。

PerlIO_stdoutf(fmt,...)

This is printf() equivalent. printf is #defined to this function, so it is (currently) legal to use printf(fmt,...) in perl sources.

これは printf() と等価です。 printf はこの関数に対する #define となっていますから、 (現時点では) Perl のソースコード中で printf(fmt,...) とすることは 合法です。

PerlIO_read(f,buf,count), PerlIO_write(f,buf,count)

These correspond functionally to fread() and fwrite() but the arguments and return values are different. The PerlIO_read() and PerlIO_write() signatures have been modeled on the more sane low level read() and write() functions instead: The "file" argument is passed first, there is only one "count", and the return value can distinguish between error and EOF.

fread() および fwrite() に対応する機能を持ちますが、引数と 返り値は異なります。 PerlIO_read() と PerlIO_write() のシグネチャは、代わりによりまともな 低レベルの read() と write() の関数をモデルにしています: "file" 引数は最初に渡され、count" は 1 つだけで、返り値はエラーと EOF とで区別できます。

Returns a byte count if successful (which may be zero or positive), returns negative value and sets errno on error. Depending on implementation errno may be EINTR if operation was interrupted by a signal.

成功時にはバイトカウント(ゼロか正の数です)を返し、エラー時には負の数を 返して errno をセットします。 実装によっては、操作がシグナルで中断した場合 errno は EINTR に なることがあります。

PerlIO_fill(f)

Fills the buffer associated with f with data from the layer below. PerlIO_read calls this as part of its normal operation. Returns 0 upon success; -1 on failure.

f に関連づけられたバッファを下の層からのデータで埋めます。 PerlIO_read はこれを通常の操作の一部として呼び出します。 成功すると 0 を返します; 失敗すると -1 です。

PerlIO_close(f)

Depending on implementation errno may be EINTR if operation was interrupted by a signal.

実装によっては、操作がシグナルで中断した場合 errno は EINTR に なることがあります。

PerlIO_puts(f,s), PerlIO_putc(f,c)

These correspond to fputs() and fputc(). Note that arguments have been revised to have "file" first.

fputs() および fputc() に対応します。 最初の引数に "file" が来るということに注意してください。

PerlIO_ungetc(f,c)

This corresponds to ungetc(). Note that arguments have been revised to have "file" first. Arranges that next read operation will return the byte c. Despite the implied "character" in the name only values in the range 0..0xFF are defined. Returns the byte c on success or -1 (EOF) on error. The number of bytes that can be "pushed back" may vary, only 1 character is certain, and then only if it is the last character that was read from the handle.

ungetc() に対応します。 最初の引数に "file" が来るということに注意してください。 次の読み込み操作でバイト c を返すように準備します。 名前の "character" が暗示しているものに関わらず、0..0xFF の範囲の値のみが 定義されています。 成功にはバイト c が、エラー時には -1 (EOF) が返されます。 「押し返す」ことができるバイト数は異なります; 1 文字だけというのは確実で、 従ってハンドルから読み込んだ最後の文字だけということです。

PerlIO_unread(f,buf,count)

This allows one to unget more than a single byte. It effectively unshifts count bytes onto the beginning of the buffer buf, so that the next read operation(s) will return them before anything else that was in the buffer.

これにより、単一バイト以上のものを unget できます。 これは事実上 count バイト分をバッファ buf の先頭に逆シフトするので、 次の読み込み操作は、バッファにあったものより先にこれらを返します。

Returns the number of unread bytes.

unread したバイト数を返します。

PerlIO_getc(f)

This corresponds to getc(). Despite the c in the name only byte range 0..0xFF is supported. Returns the character read or -1 (EOF) on error.

getc() に対応します。 名前に c がありますが、バイトの範囲 0..0xFF にのみ対応しています。 読み込んだ文字か、エラーの場合は -1 (EOF) を返します。

PerlIO_eof(f)

This corresponds to feof(). Returns a true/false indication of whether the handle is at end of file. For terminal devices this may or may not be "sticky" depending on the implementation. The flag is cleared by PerlIO_seek(), or PerlIO_rewind().

feof() に対応します。 ハンドルがファイルの最後かどうかを示す真か偽を返します。 端末デバイスでは、実装に依存して、これは "sticky" かもしれませんし、 そうではないかもしれません。 フラグは PerlIO_seek() か PerlIO_rewind() で解除されます。

PerlIO_error(f)

This corresponds to ferror(). Returns a true/false indication of whether there has been an IO error on the handle.

ferror()に対応します。 ハンドルに IO エラーがあるかどうかを真偽値で返します。

PerlIO_fileno(f)

This corresponds to fileno(), note that on some platforms, the meaning of "fileno" may not match Unix. Returns -1 if the handle has no open descriptor associated with it.

fileno() に対応します; 一部のプラットフォームにおいては、"fileno" の 意味するところが Unix とは違うということに注意してください。 ハンドルが開かれた記述子と関連づけられていない場合は -1 を返します。

PerlIO_clearerr(f)

This corresponds to clearerr(), i.e., clears 'error' and (usually) 'eof' flags for the "stream". Does not return a value.

clearerr() に対応し、「ストリーム」の 'error' や (普通は) 'eof' といった フラグをクリアします。 値を返しません。

PerlIO_flush(f)

This corresponds to fflush(). Sends any buffered write data to the underlying file. If called with NULL this may flush all open streams (or core dump with some USE_STDIO implementations). Calling on a handle open for read only, or on which last operation was a read of some kind may lead to undefined behaviour on some USE_STDIO implementations. The USE_PERLIO (layers) implementation tries to behave better: it flushes all open streams when passed NULL, and attempts to retain data on read streams either in the buffer or by seeking the handle to the current logical position.

fflush() に対応します。 バッファリングされた書き込みデータをファイルに送ります。 引数 NULL で呼び出すと、オープンしている全てのストリームを フラッシュします(USE_STDIO 実装にはコアダンプするものもあります)。 読み込み専用でオープンしているか、最後の操作がなんらかの読み込みである ハンドルで呼び出すと、USE_STDIO 実装には未定義の振る舞いとなるものが あります。 USE_PERLIO (層) 実装はよりよく振る舞おうとします: NULL が渡されると オープンしている全てのストリームをフラッシュし、バッファの中か、現在の 論理位置にハンドルをシークすることで、読み込みストリームのデータを 維持しようとします。

PerlIO_seek(f,offset,whence)

This corresponds to fseek(). Sends buffered write data to the underlying file, or discards any buffered read data, then positions the file descriptor as specified by offset and whence (sic). This is the correct thing to do when switching between read and write on the same handle (see issues with PerlIO_flush() above). Offset is of type Off_t which is a perl Configure value which may not be same as stdio's off_t.

fseek() に対応します。 バッファリングされた書き込みデータを対応するファイルに送るか、 バッファリングした読み込みデータを捨ててから、ファイル記述子の位置を <offset> と whence で指定された場所にします(シークします)。 これは同じハンドルの読み込みと書き込みを切り替えるときにするべき 正しいことです(上述の PerlIO_flush() の問題を参照してください)。 offset は perl の Configure 値である Off_t 型で、stdio の off_t とは 異なるかもしれません。

PerlIO_tell(f)

This corresponds to ftell(). Returns the current file position, or (Off_t) -1 on error. May just return value system "knows" without making a system call or checking the underlying file descriptor (so use on shared file descriptors is not safe without a PerlIO_seek()). Return value is of type Off_t which is a perl Configure value which may not be same as stdio's off_t.

ftell() に対応します。 現在のファイル位置か、エラーの場合は (Off_t) -1 が返されます。 システムコールや、基礎となるファイル記述子のチェックなしに、システムが 「知っている」値を返すかもしれません (従って、共有ファイル記述子での使用は、 PerlIO_seek() なしでは安全ではありません)。 返り値は perl の Configure 値である Off_t 型で、stdio の off_t とは 異なるかもしれません。

PerlIO_getpos(f,p), PerlIO_setpos(f,p)

These correspond (loosely) to fgetpos() and fsetpos(). Rather than stdio's Fpos_t they expect a "Perl Scalar Value" to be passed. What is stored there should be considered opaque. The layout of the data may vary from handle to handle. When not using stdio or if platform does not have the stdio calls then they are implemented in terms of PerlIO_tell() and PerlIO_seek().

それぞれ (大まかに) ftgetpos() と fsetpos() に対応します。 stdio のFpos_t と違って、これらは「Perl スカラ値」が渡されることを 想定しています。 ここで保存されるものは内部が見えないものとみなれさます。 データのレイアウトはハンドルによってさまざまです。 stdio を使わない場合や、プラットフォームが stdio 呼び出しを持っていない 場合にはこれらの関数は PerlIO_tell()、PerlIO_seek() によって実装されます。

PerlIO_rewind(f)

This corresponds to rewind(). It is usually defined as being

rewind() に対応します。 これは普通以下のように定義されています:

    PerlIO_seek(f,(Off_t)0L, SEEK_SET);
    PerlIO_clearerr(f);

PerlIO_tmpfile()

This corresponds to tmpfile(), i.e., returns an anonymous PerlIO or NULL on error. The system will attempt to automatically delete the file when closed. On Unix the file is usually unlink-ed just after it is created so it does not matter how it gets closed. On other systems the file may only be deleted if closed via PerlIO_close() and/or the program exits via exit. Depending on the implementation there may be "race conditions" which allow other processes access to the file, though in general it will be safer in this regard than ad. hoc. schemes.

tmpfile() に対応し、無名 PerlIO (エラー時は NULL) を返します。 システムはファイルがクローズされると自動的にファイルを削除しようとします。 Unix では、ファイルは普通作成された直後に unlink されるので、どうやって クローズされるかは気にされません。 その他のシステムでは、ファイルは PerlIO_close() で閉じられるか、プログラムが exit で終了されたときにのみ削除されます。 実装に依存して、他のプロセスがこのファイルにアクセスできるという 「競合条件」が起こりえますが、一般的にはその場限りの仕組みよりこれの方が より安全でしょう。

PerlIO_setlinebuf(f)

This corresponds to setlinebuf(). Does not return a value. What constitutes a "line" is implementation dependent but usually means that writing "\n" flushes the buffer. What happens with things like "this\nthat" is uncertain. (Perl core uses it only when "dumping"; it has nothing to do with $| auto-flush.)

これは setlinebuf() に対応します。 値を返しません。 何が「行」を構成するかは実装依存ですが、普通は "\n" を書くとバッファを フラッシュします。 "this\nthat" のようなものに対して何が起こるかは不明確です。 (Perl core は "dumping" が $| の自動フラッシュに 関係していない ときにのみ これを使います。)

stdio との共存¶

PerlIO と stdio との共存をサポートするためのアウトラインがあります。 PerlIO が stdio を使って実装されているのであれば、明らかに問題はありません。 しかし、その他の場合では stdio 呼び出しを使おうとするライブラリコードに 渡すことができる FILE * を作成する機構がなければなりません。

最初のステップは以下の行を追加することです:

   #define PERLIO_NOT_STDIO 0

あらゆる perl ヘッダファイルをインクルードする 前 に行います。 (これはおそらくある時点でデフォルトになります。) これにより "perlio.h" が stdio を PerlIO 関数に #define しようとするのを 妨げます。

XS コードは、もし FILE * 引数を想定しているなら、おそらく"typemap" を 使ったほうがよいでしょう。 標準の typemap は、この分野でのあらゆる変更を把握するために調整されます。

PerlIO_importFILE(f,mode)

Used to get a PerlIO * from a FILE *.

FILE * から PerlIO * を得るのに使います。

The mode argument should be a string as would be passed to fopen/PerlIO_open. If it is NULL then - for legacy support - the code will (depending upon the platform and the implementation) either attempt to empirically determine the mode in which f is open, or use "r+" to indicate a read/write stream.

mode 引数は fopen/PerlIO_open に渡される文字列です。 もしこれが NULL なら - レガシーサポートのために - コードは (プラットフォームと実装に依存して) f がオープンされるモードを経験的に 決定しようとするか、読み書きストリームを示すために "r+" が使われます。

Once called the FILE * should ONLY be closed by calling PerlIO_close() on the returned PerlIO *.

一度呼び出されると、この FILE * は返された PerlIO * で PerlIO_close() を 呼び出すことによって のみ クローズされるべきです。

The PerlIO is set to textmode. Use PerlIO_binmode if this is not the desired mode.

PerlIO はテキストモードにセットされます。 これが希望しているモードでない場合は、PerlIO_binmode を使います。

This is not the reverse of PerlIO_exportFILE().

これは PerlIO_exportFILE() の逆 ではありません 。

PerlIO_exportFILE(f,mode)

Given a PerlIO * create a 'native' FILE * suitable for passing to code expecting to be compiled and linked with ANSI C stdio.h. The mode argument should be a string as would be passed to fopen/PerlIO_open. If it is NULL then - for legacy support - the FILE * is opened in same mode as the PerlIO *.

PerlIO * を取り、ANSI C の stdio.h と共にコンパイルされ、リンクされる ことが想定されるコードに渡すのに適した‘ネイティブ’な FILE * 構造体を 作成します。 mode 引数は fopen/PerlIO_open に渡される文字列です。 これが NULL の場合は - レガシー対応のために - FILE * は PerlIO * と同じ モードでオープンします。

The fact that such a FILE * has been 'exported' is recorded, (normally by pushing a new :stdio "layer" onto the PerlIO *), which may affect future PerlIO operations on the original PerlIO *. You should not call fclose() on the file unless you call PerlIO_releaseFILE() to disassociate it from the PerlIO *. (Do not use PerlIO_importFILE() for doing the disassociation.)

‘export’された FILE * は(通常は新しい :stdio 「層」を PerlIO * に プッシュすることで)記録され、それ以後のオリジナルの PerlIO * に対する PerlIO 操作に影響を及ぼす可能性があります。 PerlIO * との関連付けを解除するために PerlIO_releaseFILE() を 呼び出さずに fclose() を呼び出すべきではありません。 (関連付けの解除のために PerlIO_importFILE() を使ってはいけません。)

Calling this function repeatedly will create a FILE * on each call (and will push an :stdio layer each time as well).

この関数を複数回呼び出すと、呼び出し毎に FILE * を作成します(そして 毎回 :stdio 層にプッシュします)。

PerlIO_releaseFILE(p,f)

Calling PerlIO_releaseFILE informs PerlIO that all use of FILE * is complete. It is removed from the list of 'exported' FILE *s, and the associated PerlIO * should revert to its original behaviour.

PerlIO_releaseFILE は、PerlIO にすべてのFILE * の使用が完了したことを 知らせます。 完了したものは‘export’された FILE * のリストから削除されます; そして、 それに結び付けられている PerlIO * は元々の振る舞いに戻ります。

Use this to disassociate a file from a PerlIO * that was associated using PerlIO_exportFILE().

PerlIO_exportFILE() を使って PerlIO * に結び付けられたファイルを 分離するためにこれを使います。

PerlIO_findFILE(f)

Returns a native FILE * used by a stdio layer. If there is none, it will create one with PerlIO_exportFILE. In either case the FILE * should be considered as belonging to PerlIO subsystem and should only be closed by calling PerlIO_close().

stdio 層で使われるネイティブな FILE * を返します。 もしそれがなければ、PerlIO_exportFILE を使って作成されます。 どちらの場合でも、FILE * は PerlIO サブシステムに従うと考えられ、 PerlIO_close() を呼び出すことによってのみクローズされるべきです。

"Fast gets" 関数¶

上述した標準風の API に加えて、perl が PerlIO の内部で扱うことが できるようにする「実装」インターフェースがあります。 以下に挙げる呼び出しは、それぞれ Configure (あるいはその他の実装では これと等価なもの) で定義される FILE_xxx マクロに対応しています。 このセクションでは、perl-core の振る舞いの詳細、PerlIO のマッピングの実装、 また perl がする同じ方法で IO システムによって行われている 「先行読み込み」を使えるようなコードを書くことについてのみ注目します。 これらのインターフェースを使うコードは、もしハンドルがこれらに 対応していないなら、伝統的な方法で準備しておく必要があることに 注意してください。

PerlIO_fast_gets(f)

Returns true if implementation has all the interfaces required to allow perl's sv_gets to "bypass" normal IO mechanism. This can vary from handle to handle.

もし実装が通常の IO 機構を「回避」するために perl の sv_gets が 使えるために要求される全てのインターフェースを持っているなら真を返します。 これはハンドルによって異なる可能性があります。

  PerlIO_fast_gets(f) = PerlIO_has_cntptr(f) && \
                        PerlIO_canset_cnt(f) && \
                        'Can set pointer into buffer'

PerlIO_has_cntptr(f)

Implementation can return pointer to current position in the "buffer" and a count of bytes available in the buffer. Do not use this - use PerlIO_fast_gets.

“バッファ”中のカレントポジションへのポインターとバッファにある バイト数を返すことのできる実装です。 これは使わないでください - PerlIO_fast_gets を使ってください。

PerlIO_get_cnt(f)

Return count of readable bytes in the buffer. Zero or negative return means no more bytes available.

バッファ中の読み出すことのできるバイト数を返します。 0 や負数が返ると、もう読み出せないことを意味します。

PerlIO_get_ptr(f)

Return pointer to next readable byte in buffer, accessing via the pointer (dereferencing) is only safe if PerlIO_get_cnt() has returned a positive value. Only positive offsets up to value returned by PerlIO_get_cnt() are allowed.

バッファ中にある次の読み出し可能バイトへのポインターを返します; ポインタ経由のアクセス(デリファレンス)は、PerlIO_get_cnt() が 正の数を返した場合にのみ安全です。 PerlIO_get_cnt() で返される値以下の正の数のオフセットのみが使えます。

PerlIO_set_ptrcnt(f,p,c)

Set pointer into buffer, and a count of bytes still in the buffer. Should be used only to set pointer to within range implied by previous calls to PerlIO_get_ptr and PerlIO_get_cnt. The two values must be consistent with each other (implementation may only use one or the other or may require both).

ポインターをバッファにセットし、バッファにあるバイト数はそのままです。 以前の PerlIO_get_ptr と PerlIO_get_cnt の呼び出しから 推測される範囲内のポインターをセットすることのみに使うべきでしょう。 2 つの値は互いに 一貫していなければなりません (実装はどちらか片方だけを使うかもしれませんし、両方が必要かもしれません)。

PerlIO_canset_cnt(f)

Implementation can adjust its idea of number of bytes in the buffer. Do not use this - use PerlIO_fast_gets.

バッファにあるバイト数を調整することのできる実装です。 これは使わないでください - PerlIO_fast_gets を使ってください。

PerlIO_set_cnt(f,c)

Obscure - set count of bytes in the buffer. Deprecated. Only usable if PerlIO_canset_cnt() returns true. Currently used in only doio.c to force count less than -1 to -1. Perhaps should be PerlIO_set_empty or similar. This call may actually do nothing if "count" is deduced from pointer and a "limit". Do not use this - use PerlIO_set_ptrcnt().

不明瞭 - バッファにあるバイト数をセットします。 非推奨です。 PerlIO_canset_cnt() は真を返す場合にのみ利用できます。 現在これは、doio.c でのみ -1 未満の count を 強制的に -1 にするために 使われています。 おそらく PerlIO_set_empty やそれに類するものがあるべきでしょう。 この呼び出しは、“count”がポインターと“limit”から導き出される場合には 実際にはなにもしません。 これは使わないでください - PerlIO_set_ptrcnt() を使ってください。

PerlIO_has_base(f)

Returns true if implementation has a buffer, and can return pointer to whole buffer and its size. Used by perl for -T / -B tests. Other uses would be very obscure...

実装がバッファを持っていて、バッファ全体へのポインターやその大きさを 返すことができるなら真を返します。 -T/-B テストのために perl によって使われます。 そのほかのものは非常にはっきりしない形で使われます…

PerlIO_get_base(f)

Return start of buffer. Access only positive offsets in the buffer up to the value returned by PerlIO_get_bufsiz().

バッファの 開始位置 を返します。 バッファの中で、PerlIO_get_bufsiz() で返される値以下の正数のオフセットで のみアクセスできます。

PerlIO_get_bufsiz(f)

Return the total number of bytes in the buffer, this is neither the number that can be read, nor the amount of memory allocated to the buffer. Rather it is what the operating system and/or implementation happened to read() (or whatever) last time IO was requested.

バッファの 合計バイト数 を返します; これは読み込み可能な数や、バッファに割り当てられたメモリ量ではありません。 むしろ、最後に I/O が要求されたときに OS や 実装が read() (あるいは そのようなもの) を行ったものです。

その他の関数¶

PerlIO_apply_layers(aTHX_ f,mode,layers)

The new interface to the USE_PERLIO implementation. The layers ":crlf" and ":raw" are the only ones allowed for other implementations and those are silently ignored. (As of perl5.8 ":raw" is deprecated.) Use PerlIO_binmode() below for the portable case.

USE_PERLIO 実装への新しいインターフェースです。 ":crlf" と ":raw" の層はその他の実装では一つだけが許可され、これらは暗黙に 無視されます。 (perl5.8 から、":raw" は非推奨です。) 移植性が問題になる場合は後述する PerlIO_binmode() を使ってください。

PerlIO_binmode(aTHX_ f,ptype,imode,layers)

The hook used by perl's binmode operator. ptype is perl's character for the kind of IO:

perl の binmode 演算子で使われるフックです。 ptype は入出力の種類を示す perl の文字です:

'<' read

'>' write

'+' read/write

imode is O_BINARY or O_TEXT.

imode は O_BINARY か O_TEXT です。

layers is a string of layers to apply; only ":crlf" makes sense in the non-USE_PERLIO case. (As of perl5.8 ":raw" is deprecated in favour of passing NULL.)

layers は適用される層の文字列で、USE_PERLIO 以外の場合では ":crlf" のみが 意味を持ちます。 (perl5.8 以降、":raw" は非推奨で、NULL を渡すことが好まれます。)

Portable cases are:

移植性のある場合は:

    PerlIO_binmode(aTHX_ f,ptype,O_BINARY,NULL);
and
    PerlIO_binmode(aTHX_ f,ptype,O_TEXT,":crlf");

On Unix these calls probably have no effect whatsoever. Elsewhere they alter "\n" to CR,LF translation and possibly cause a special text "end of file" indicator to be written or honoured on read. The effect of making the call after doing any IO to the handle depends on the implementation. (It may be ignored, affect any data which is already buffered as well, or only apply to subsequent data.)

Unix ではこれらの呼び出しはおそらく何の効果もありません。 それ以外では "\n" を CR,LF に変換し、特別なテキスト「ファイル終端」指示子を 読み書き時に使います。 ハンドルに対して I/O を行った後に呼び出した場合の効果は実装に依存します。 (無視されるかもしれませんし、既にバッファに入っているデータにも 適用されるかもしれませんし、以後のデータにだけ適用されるかもしれません。)

PerlIO_debug(fmt,...)

PerlIO_debug is a printf()-like function which can be used for debugging. No return value. Its main use is inside PerlIO where using real printf, warn() etc. would recursively call PerlIO and be a problem.

PerlIO_debug は、デバッグに使える printf() 風の関数です。 返り値はありません。 主な用途は、実 printf, warn() などが使っている PerlIO の内部で、PerlIO の 再帰呼び出しが問題になるようなところです。

PerlIO_debug writes to the file named by $ENV{'PERLIO_DEBUG'} or defaults to stderr if the environment variable is not defined. Typical use might be

PerlIO_debug は $ENV{'PERLIO_DEBUG'} で指定されたファイルか、 環境変数が定義されていない場合はデフォルトの stderr に書き込みます。 典型的な使い方は:

  Bourne shells (sh, ksh, bash, zsh, ash, ...):
   PERLIO_DEBUG=/tmp/perliodebug.log ./perl -Di somescript some args

  Csh/Tcsh:
   setenv PERLIO_DEBUG /tmp/perliodebug.log
   ./perl -Di somescript some args

  If you have the "env" utility:
   env PERLIO_DEBUG=/tmp/perliodebug.log ./perl -Di somescript args

  Win32:
   set PERLIO_DEBUG=perliodebug.log
   perl -Di somescript some args

On a Perl built without -DDEBUGGING, or when the -Di command-line switch is not specified, or under taint, PerlIO_debug() is a no-op.

-DDEBUGGING なしでビルドされた Perl か、-Di コマンドラインオプションが 指定されていないか、汚染モードの場合、PerlIO_debug() は何もしません。