Commit | Line | Data |
59035dcc |
1 | package PerlIO::encoding; |
4b6f7c81 |
2 | |
c657f685 |
3 | use strict; |
56ff7374 |
4 | our $VERSION = '0.09'; |
c657f685 |
5 | our $DEBUG = 0; |
6 | $DEBUG and warn __PACKAGE__, " called by ", join(", ", caller), "\n"; |
7 | |
8 | # |
1982da40 |
9 | # Equivalent of this is done in encoding.xs - do not uncomment. |
c657f685 |
10 | # |
54871a3c |
11 | # use Encode (); |
c657f685 |
12 | |
59035dcc |
13 | use XSLoader (); |
c657f685 |
14 | XSLoader::load(__PACKAGE__, $VERSION); |
15 | |
56ff7374 |
16 | our $fallback = |
17 | Encode::PERLQQ()|Encode::WARN_ON_ERR()|Encode::STOP_AT_PARTIAL(); |
1982da40 |
18 | |
59035dcc |
19 | 1; |
20 | __END__ |
21 | |
22 | =head1 NAME |
23 | |
24 | PerlIO::encoding - encoding layer |
25 | |
26 | =head1 SYNOPSIS |
27 | |
51dfe3f7 |
28 | use PerlIO::encoding; |
29 | |
b89cebd3 |
30 | open($f, "<:encoding(foo)", "infoo"); |
31 | open($f, ">:encoding(bar)", "outbar"); |
59035dcc |
32 | |
c657f685 |
33 | use Encode qw(:fallbacks); |
e7e5539a |
34 | $PerlIO::encoding::fallback = FB_PERLQQ; |
c00aecee |
35 | |
59035dcc |
36 | =head1 DESCRIPTION |
37 | |
51dfe3f7 |
38 | This PerlIO layer opens a filehandle with a transparent encoding filter. |
b89cebd3 |
39 | |
51dfe3f7 |
40 | On input, it converts the bytes expected to be in the specified |
b89cebd3 |
41 | character set and encoding to Perl string data (Unicode and |
51dfe3f7 |
42 | Perl's internal Unicode encoding, UTF-8). On output, it converts |
b89cebd3 |
43 | Perl string data into the specified character set and encoding. |
44 | |
51dfe3f7 |
45 | When the layer is pushed, the current value of C<$PerlIO::encoding::fallback> |
46 | is saved and used as the CHECK argument when calling the Encode methods |
47 | encode() and decode(). |
c00aecee |
48 | |
b89cebd3 |
49 | =head1 SEE ALSO |
50 | |
51 | L<open>, L<Encode>, L<perlfunc/binmode>, L<perluniintro> |
2dc05cb3 |
52 | |
59035dcc |
53 | =cut |