open-1.06 > open
open-1.06
Other versions:
5.8.1

名前

open - perl pragma to set default PerlIO layers for input and output

open - 入出力のためのデフォルトの PerlIO 層をセットするための perl プラグマ

概要

    use open IN  => ":crlf", OUT => ":bytes";
    use open OUT => ':utf8';
    use open IO  => ":encoding(iso-8859-7)";

    use open IO  => ':locale';

    use open ':encoding(utf8)';
    use open ':locale';
    use open ':encoding(iso-8859-7)';

    use open ':std';

説明

Full-fledged support for I/O layers is now implemented provided Perl is configured to use PerlIO as its IO system (which is now the default).

Perl が IO システム(現在のデフォルト)として PerlIO を 使うように設定されている場合、I/O 層としての本格的な対応が 実装されています。

The open pragma serves as one of the interfaces to declare default "layers" (also known as "disciplines") for all I/O. Any two-argument open(), readpipe() (aka qx//) and similar operators found within the lexical scope of this pragma will use the declared defaults. Even three-argument opens may be affected by this pragma when they don't specify IO layers in MODE.

open プラグマはすべての I/O のデフォルトの「層」("layer") (「ディシプリン」"disciplines"とも呼ばれます)を宣言するための インターフェースの一つとして働きます。 2 つの引数を取る open()、readpipe()(または qx//) と同様の演算子は、 そのレキシカルスコープでこのプラグマを見つけると、宣言されたデフォルトを 使用します。 3 つの引数を取る open でさえ、MODE に IO 層が指定されていない場合、 このプラグマの影響を受けます。

With the IN subpragma you can declare the default layers of input streams, and with the OUT subpragma you can declare the default layers of output streams. With the IO subpragma you can control both input and output streams simultaneously.

IN サブプラグマを使って入力ストリームのデフォルト層を宣言でき、 OUT サブプラグマを使って出力ストリームのデフォルト層を 宣言できます。 IO サブプラグマを使って入出力の両方を同時に制御できます。

If you have a legacy encoding, you can use the :encoding(...) tag.

レガシーエンコーディングを使っているのなら、:encoding(...) タグが 使えます。

If you want to set your encoding layers based on your locale environment variables, you can use the :locale tag. For example:

ロケールに関する環境変数に基づいてエンコーディング層を設定したい場合、 :locale タグが使えます。 例えば:

    $ENV{LANG} = 'ru_RU.KOI8-R';
    # the :locale will probe the locale environment variables like LANG
    use open OUT => ':locale';
    open(O, ">koi8");
    print O chr(0x430); # Unicode CYRILLIC SMALL LETTER A = KOI8-R 0xc1
    close O;
    open(I, "<koi8");
    printf "%#x\n", ord(<I>), "\n"; # this should print 0xc1
    close I;

These are equivalent

以下の2行は等価です:

    use open ':encoding(utf8)';
    use open IO => ':encoding(utf8)';

as are these

同様に、以下の2行

    use open ':locale';
    use open IO => ':locale';

and these

や以下の2行

    use open ':encoding(iso-8859-7)';
    use open IO => ':encoding(iso-8859-7)';

も等価です。

The matching of encoding names is loose: case does not matter, and many encodings have several aliases. See Encode::Supported for details and the list of supported locales.

エンコーディング名のマッチングは緩やかなものです: 大小文字の違いは 無視され、多くのエンコーディングはいくつかの別名を持っています。 対応しているロケールのリストと詳細は Encode::Supported を 参照してください。

When open() is given an explicit list of layers (with the three-arg syntax), they override the list declared using this pragma.

open() に層のリストが(3 引数文法で)与えられた場合、それらは このプラグマを使って宣言されたリストを上書きします。

The :std subpragma on its own has no effect, but if combined with the :utf8 or :encoding subpragmas, it converts the standard filehandles (STDIN, STDOUT, STDERR) to comply with encoding selected for input/output handles. For example, if both input and out are chosen to be :encoding(utf8), a :std will mean that STDIN, STDOUT, and STDERR are also in :encoding(utf8). On the other hand, if only output is chosen to be in :encoding(koi8r), a :std will cause only the STDOUT and STDERR to be in koi8r. The :locale subpragma implicitly turns on :std.

:std サブプラグマそれ自身は何の効果ももちませんが、:utf8:encoding といったサブプラグマと組み合わせた場合には、 標準ファイルハンドル(STDIN, STDOUT, STDERR)を、選択された入出力ハンドルの エンコーディングに変換します。 たとえば、入力と出力の両方で :encoding(utf8) を選択した場合、 :std は STDIN, STDOUT, STDERR もまた :encoding(utf8) となることを意味します。 一方、出力だけを :encoding(koi8r) と選択した場合には、 :std は STDOUT と STDERR だけを koi8r にします。 :locale サブプラグマは暗黙のうちに :std を有効にします。

The logic of :locale is described in full in encoding, but in short it is first trying nl_langinfo(CODESET) and then guessing from the LC_ALL and LANG locale environment variables.

:locale のロジックは encoding に完全に記述されていますが、 短く言うと、まず nl_langinfo(CODESET) を試して、その後 LC_ALL と LANG のロケール環境変数から推測します。

Directory handles may also support PerlIO layers in the future.

ディレクトリハンドルも将来 PerlIO 層をサポートするでしょう。

非 PerlIO 機能

If Perl is not built to use PerlIO as its IO system then only the two pseudo-layers :bytes and :crlf are available.

Perl がその IO システムとして PerlIO を使うように構築されていなかった場合、 :bytes:crlf の二つの擬似層だけが使用可能です。

The :bytes layer corresponds to "binary mode" and the :crlf layer corresponds to "text mode" on platforms that distinguish between the two modes when opening files (which is many DOS-like platforms, including Windows). These two layers are no-ops on platforms where binmode() is a no-op, but perform their functions everywhere if PerlIO is enabled.

:bytes 層は「バイナリモード」を、:crlf 層は「テキストモード」を、 ファイルをオープンするときにこれら二つのモードを区別する(Windows を 含めた多くの DOS に似たシステム) プラットフォームにおいて表します。 これら二つの層は binmode() が何も行わないプラットフォームでは何も 行いませんが、PerlIO が有効である場合にはこれらの関数はすべての場所で 動作します。

実装の詳細

There is a class method in PerlIO::Layer find which is implemented as XS code. It is called by import to validate the layers:

PerlIO::Layer に、XS コードで実装された find という クラスメソッドがあります。 これは層の確認のために import によって呼び出されます:

   PerlIO::Layer::->find("perlio")

The return value (if defined) is a Perl object, of class PerlIO::Layer which is created by the C code in perlio.c. As yet there is nothing useful you can do with the object at the perl level.

返り値は、(もし定義されていれば) perlio.c の C プログラムによって 作成された PerlIO::Layer クラスの Perl オブジェクトです。 perl レベルでは現在のところこれを使って何か便利なことが できるわけではありません。

SEE ALSO

"binmode" in perlfunc, "open" in perlfunc, perlunicode, PerlIO, encoding