NAME

Encode::PerlIO -- a detailed document on Encode and PerlIO

Overview

It is very common to want to do encoding transformations when reading or writing files, network connections, pipes etc. If Perl is configured to use the new 'perlio' IO system then Encode provides a "layer" (See PerlIO) which can transform data as it is read or written.

Here is how the blind poet would modernise the encoding:

    use Encode;
    open(my $iliad,'<:encoding(iso-8859-7)','iliad.greek');
    open(my $utf8,'>:utf8','iliad.utf8');
    my @epic = <$iliad>;
    print $utf8 @epic;
    close($utf8);
    close($illiad);

In addition the new IO system can also be configured to read/write UTF-8 encoded characters (as noted above this is efficient):

    open(my $fh,'>:utf8','anything');
    print $fh "Any \x{0021} string \N{SMILEY FACE}\n";

Either of the above forms of "layer" specifications can be made the default for a lexical scope with the use open ... pragma. See open.

Once a handle is open is layers can be altered using binmode.

Without any such configuration, or if Perl itself is built using system's own IO, then write operations assume that file handle accepts only bytes and will die if a character larger than 255 is written to the handle. When reading, each octet from the handle becomes a byte-in-a-character. Note that this default is the same behaviour as bytes-only languages (including Perl before v5.6) would have, and is sufficient to handle native 8-bit encodings e.g. iso-8859-1, EBCDIC etc. and any legacy mechanisms for handling other encodings and binary data.

In other cases it is the programs responsibility to transform characters into bytes using the API above before doing writes, and to transform the bytes read from a handle into characters before doing "character operations" (e.g. lc, /\W+/, ...).

You can also use PerlIO to convert larger amounts of data you don't want to bring into memory. For example to convert between ISO-8859-1 (Latin 1) and UTF-8 (or UTF-EBCDIC in EBCDIC machines):

    open(F, "<:encoding(iso-8859-1)", "data.txt") or die $!;
    open(G, ">:utf8",                 "data.utf") or die $!;
    while (<F>) { print G }

    # Could also do "print G <F>" but that would pull
    # the whole file into memory just to write it out again.

More examples:

    open(my $f, "<:encoding(cp1252)")
    open(my $g, ">:encoding(iso-8859-2)")
    open(my $h, ">:encoding(latin9)")       # iso-8859-15

See also encoding for how to change the default encoding of the data in your script.

How does it work?

Here is a crude diagram of how filehandle, PerlIO, and Encode interact.

  filehandle <-> PerlIO       PerlIO <-> scalar (read/printed)
                       \     /
                        Encode   

When PerlIO receives data from either direction, it fills in the buffer (currently with 1024 bytes) and pass the buffer to Encode. Encode tries to convert the valid part and pass it back to PerlIO, leaving invalid parts (usually partial character) in buffer. PerlIO then appends more data in buffer, call Encode, and so on until the data stream ends.

To do so, PerlIO always calls (de|en)code methods with CHECK set to 1. this ensures that the method stops at the right place when it encounters partial character. The following is what happens when PerlIO and Encode tries to encode (from utf8) more than 1024 bytes long and the buffer boundary happens to be between a character.

   A   B   C   ....   ~     \x{3000}    ....
  41  42  43   ....  7E   e3   80   80  ....
  <- buffer --------------->
  << encoded >>>>>>>>>>
                       <- next buffer ------

Encode converts from the beginning to \x7E, leaving \xe3 in the buffer because it is invalid (partial character).

Unfortunately, this scheme does not work well with escape-based encoding such as ISO-2022-JP. Let's see what happens in that case in the next chapter.

BUGS

Now let's see what happens when you try to decode form ISO-2022-JP and the buffer cuts in the middle of a character

                          JIS208-ESC   \x{5f3e}
   A   B   C   ....   ~   \e   $   B  |DAN | ....
  41  42  43   ....  7E   1b  24  41  43  46 ....
  <- buffer --------------------------->
  << encoded >>>>>>>>>>>>>>>>>>>>>>>

As you see, the next buffer begins with \x43. But \x43 is 'C' in ASCII, which is wrong in this case because we are now in JISX 0208 area so it has to convert \x43\x46, not \x43. Unlike utf8 and EUC, in escape-based encoding you can't tell if it a given octed is a whole character or just part of it.

There are actually several ways to solve this problem but none of which is fast enough to be practical. From Encode's point of view the easiest solution is for PerlIO to implement line buffer instead of fixed-length buffer but that makes PerlIO really complicated.

So for the time being, using escape-based encodings in ":encoding()" layer of PerlIO does not work well.

Workaround

If you still insist, you can at least use ":encoding()" by making sure the buffer never gets full. Here is an example.

  use FileHandle;
  binmode(STDOUT, ":encoding(7bit-jis)");
  STDOUT->autoflush(1); # don't forget this!
  for my $l (@lines){   # $l cannot be longer than 1023 bytes
    print $l;
  } 

How can you tell my encoding fully supports PerlIO ?

As of this writing, Any encoding which class belongs to Encode::XS and Encode::Unicode works. Encode module has perlio_ok method so you can use it before appling PerlIO encoding to the filehandle. Here is an example;

  my $use_perlio = perlio_ok($enc);
  my $layer = $use_perlio ? "<:raw" : "<:encoding($enc)";
  open my $fh, $layer, $file or die "$file : $!";
  while(<$fh>){
    $_ = decode($enc, $_) unless $use_perlio;
    # .... 
  }

SEE ALSO

Encode::Encoding, Encode::Supported, Encode::PerlIO, encoding, perlebcdic, "open" in perlfunc, perlunicode, utf8, the Perl Unicode Mailing List <perl-unicode@perl.org>

cpanm Encode

perl -MCPAN -e shell
install Encode