This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re: Change 15637: Behaviour (make viacode 0xFFFE to return BYTE ORDER MARK,
[perl5.git] / lib / open.pm
index 6be8b97..a5c337a 100644 (file)
@@ -1,4 +1,5 @@
 package open;
+use warnings;
 use Carp;
 $open::hint_bits = 0x20000;
 
@@ -6,19 +7,20 @@ our $VERSION = '1.01';
 
 my $locale_encoding;
 
-sub in_locale { $^H & $locale::hint_bits }
+sub in_locale { $^H & ($locale::hint_bits || 0)}
 
 sub _get_locale_encoding {
     unless (defined $locale_encoding) {
+       # I18N::Langinfo isn't available everywhere
        eval {
-           # I18N::Langinfo isn't available everywhere
            require I18N::Langinfo;
-           I18N::Langinfo->import('langinfo', 'CODESET');
-       };
-       unless ($@) {
+           I18N::Langinfo->import(qw(langinfo CODESET));
            $locale_encoding = langinfo(CODESET());
-       }
+       };
        my $country_language;
+
+       no warnings 'uninitialized';
+
         if (not $locale_encoding && in_locale()) {
            if ($ENV{LC_ALL} =~ /^([^.]+)\.([^.]+)$/) {
                ($country_language, $locale_encoding) = ($1, $2);
@@ -44,6 +46,8 @@ sub _get_locale_encoding {
                $locale_encoding = 'euc-jp';
            } elsif ($country_language =~ /^ko_KR|korean?$/i) {
                $locale_encoding = 'euc-kr';
+           } elsif ($country_language =~ /^zh_CN|chin(?:a|ese)?$/i) {
+               $locale_encoding = 'euc-cn';
            } elsif ($country_language =~ /^zh_TW|taiwan(?:ese)?$/i) {
                $locale_encoding = 'euc-tw';
            }
@@ -56,6 +60,7 @@ sub _get_locale_encoding {
 sub import {
     my ($class,@args) = @_;
     croak("`use open' needs explicit list of disciplines") unless @args;
+    my $std;
     $^H |= $open::hint_bits;
     my ($in,$out) = split(/\0/,(${^OPEN} || "\0"), -1);
     while (@args) {
@@ -64,8 +69,11 @@ sub import {
        if ($type =~ /^:?(utf8|locale|encoding\(.+\))$/) {
            $type = 'IO';
            $dscp = ":$1";
+       } elsif ($type eq ':std') {
+           $std = 1;
+           next;
        } else {
-           $dscp = shift(@args);
+           $dscp = shift(@args) || '';
        }
        my @val;
        foreach my $layer (split(/\s+/,$dscp)) {
@@ -74,16 +82,20 @@ sub import {
                use Encode;
                _get_locale_encoding()
                    unless defined $locale_encoding;
-               croak "Cannot figure out an encoding to use"
+               (warnings::warnif("layer", "Cannot figure out an encoding to use"), last)
                    unless defined $locale_encoding;
                if ($locale_encoding =~ /^utf-?8$/i) {
                    $layer = "utf8";
                } else {
                    $layer = "encoding($locale_encoding)";
                }
+               $std = 1;
            } else {
-               unless(PerlIO::Layer::->find($layer)) {
-                   carp("Unknown discipline layer '$layer'");
+               my $target = $layer;            # the layer name itself
+               $target =~ s/^(\w+)\(.+\)$/$1/; # strip parameters
+
+               unless(PerlIO::Layer::->find($target)) {
+                   warnings::warnif("layer", "Unknown discipline layer '$layer'");
                }
            }
            push(@val,":$layer");
@@ -91,7 +103,6 @@ sub import {
                $^H{"open_$type"} = $layer;
            }
        }
-       # print "# type = $type, val = @val\n";
        if ($type eq 'IN') {
            $in  = join(' ',@val);
        }
@@ -105,7 +116,25 @@ sub import {
            croak "Unknown discipline class '$type'";
        }
     }
-    ${^OPEN} = join("\0",$in,$out);
+    ${^OPEN} = join("\0",$in,$out) if $in or $out;
+    if ($std) {
+       if ($in) {
+           if ($in =~ /:utf8\b/) {
+                   binmode(STDIN,  ":utf8");
+               } elsif ($in =~ /(\w+\(.+\))/) {
+                   binmode(STDIN,  ":$1");
+               }
+       }
+       if ($out) {
+           if ($out =~ /:utf8\b/) {
+               binmode(STDOUT,  ":utf8");
+               binmode(STDERR,  ":utf8");
+           } elsif ($out =~ /(\w+\(.+\))/) {
+               binmode(STDOUT,  ":$1");
+               binmode(STDERR,  ":$1");
+           }
+       }
+    }
 }
 
 1;
@@ -122,11 +151,13 @@ open - perl pragma to set default disciplines for input and output
     use open IO  => ":encoding(iso-8859-7)";
 
     use open IO  => ':locale';
-  
+
     use open ':utf8';
     use open ':locale';
     use open ':encoding(iso-8859-7)';
 
+    use open ':std';
+
 =head1 DESCRIPTION
 
 Full-fledged support for I/O disciplines is now implemented provided
@@ -142,7 +173,7 @@ operators found within the lexical scope of this pragma will use the
 declared defaults.
 
 With the C<IN> subpragma you can declare the default layers
-of input sterams, and with the C<OUT> subpragma you can declare
+of input streams, and with the C<OUT> subpragma you can declare
 the default layers of output streams.  With the C<IO>  subpragma
 you can control both input and output streams simultaneously.
 
@@ -156,10 +187,10 @@ For example:
     # 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
+    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
+    printf "%#x\n", ord(<I>), "\n"; # this should print 0xc1
     close I;
 
 These are equivalent
@@ -180,6 +211,46 @@ and these
 When open() is given an explicit list of layers they are appended to
 the list declared using this pragma.
 
+The C<:std> subpragma on its own has no effect, but if combined with
+the C<:utf8> or C<: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 C<:utf8>, a C<:std> will mean that STDIN, STDOUT, and
+STDERR are also in C<:utf8>.  On the other hand, if only output is
+chosen to be in C<< :encoding(koi8r) >>, a C<:std> will cause only the
+STDOUT and STDERR to be in C<koi8r>.  The C<:locale> subpragma
+implicitly turns on C<:std>.
+
+The logic of C<:locale> is as follows:
+
+=over 4
+
+=item 1.
+
+If the platform supports the langinfo(CODESET) interface, the codeset
+returned is used as the default encoding for the open pragma.
+
+=item 2.
+
+If 1. didn't work but we are under the locale pragma, the environment
+variables LC_ALL and LANG (in that order) are matched for encodings
+(the part after C<.>, if any), and if any found, that is used 
+as the default encoding for the open pragma.
+
+=item 3.
+
+If 1. and 2. didn't work, the environment variables LC_ALL and LANG
+(in that order) are matched for anything looking like UTF-8, and if
+any found, C<:utf8> is used as the default encoding for the open
+pragma.
+
+=back
+
+If your locale environment variables (LANGUAGE, LC_ALL, LC_CTYPE, LANG)
+contain the strings 'UTF-8' or 'UTF8' (case-insensitive matching),
+the default encoding of your STDIN, STDOUT, and STDERR, and of
+B<any subsequent file open>, is UTF-8.
+
 Directory handles may also support disciplines in future.
 
 =head1 NONPERLIO FUNCTIONALITY