Integrate:

[perl5.git] / ext / PerlIO / encoding / encoding.pm

diff --git a/ext/PerlIO/encoding/encoding.pm b/ext/PerlIO/encoding/encoding.pm
index 63df000..61a116f 100644 (file)
--- a/ext/PerlIO/encoding/encoding.pm
+++ b/ext/PerlIO/encoding/encoding.pm
@@ -1,8 +1,19 @@
 package PerlIO::encoding;
-our $VERSION = '0.01';
+use strict;
+our $VERSION = '0.07';
+our $DEBUG = 0;
+$DEBUG and warn __PACKAGE__, " called by ", join(", ", caller), "\n";
+
+#
+# Equivalent of this is done in encoding.xs - do not uncomment.
+#
+# use Encode ();
+
 use XSLoader ();
-use Encode;
-XSLoader::load 'PerlIO::encoding';
+XSLoader::load(__PACKAGE__, $VERSION);
+
+our $fallback = Encode::PERLQQ()|Encode::WARN_ON_ERR();
+
 1;
 __END__
 
@@ -12,19 +23,28 @@ PerlIO::encoding - encoding layer
 
 =head1 SYNOPSIS
 
-   open($fh, "<",  \$scalar);
-   open($fh, ">",  \$scalar);
-   open($fh, ">>", \$scalar);
+  open($f, "<:encoding(foo)", "infoo");
+  open($f, ">:encoding(bar)", "outbar");
 
-   open($fh, "<...",  \$scalar); # for example open($fh, "<:crlf", \$scalar);
-   open($fh, ">...",  \$scalar); # for example open($fh, ">:utf8", \$scalar);
-   open($fh, ">>..",  \$scalar);
+  use Encode qw(:fallbacks);
+  $PerlIO::encoding::fallback = FB_PERLQQ;
 
 =head1 DESCRIPTION
 
-Open scalars for "in memory" input and output.  The scalars will
-behave as if they were files.
+Open a filehandle with a transparent encoding filter.
 
-=cut
+On input, convert the bytes expected to be in the specified
+character set and encoding to Perl string data (Unicode and
+Perl's internal Unicode encoding, UTF-8).  On output, convert
+Perl string data into the specified character set and encoding.
 
+When the layer is pushed the current value of C<$PerlIO::encoding::fallback>
+is saved and used as the check argument when calling the Encodings
+encode and decode.
+
+=head1 SEE ALSO
+
+L<open>, L<Encode>, L<perlfunc/binmode>, L<perluniintro>
+
+=cut