X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Fopen.pm;h=32c5118be9db4b17cbe7e5d882eab8ebb86a5b79;hb=78e38bb6033b96ad3fdd5f4f7bd08f6fedae70cb;hp=53ae308310ea001b9182b6df5c95af482bec76b5;hpb=847a5fae45dac396d0f9e1bb61d5b4ff9d94cdcd;p=p5sagit%2Fp5-mst-13.2.git diff --git a/lib/open.pm b/lib/open.pm index 53ae308..32c5118 100644 --- a/lib/open.pm +++ b/lib/open.pm @@ -1,31 +1,103 @@ package open; +use warnings; use Carp; -$open::hint_bits = 0x20000; +$open::hint_bits = 0x20000; # HINT_LOCALIZE_HH -use vars qw(%layers @layers); +our $VERSION = '1.03'; -# Populate hash in non-PerlIO case -%layers = (crlf => 1, raw => 0) unless (@layers); +my $locale_encoding; -# warn join(',',keys %layers); +sub in_locale { $^H & ($locale::hint_bits || 0)} -our $VERSION = '1.00'; +sub _get_locale_encoding { + unless (defined $locale_encoding) { + # I18N::Langinfo isn't available everywhere + eval { + require I18N::Langinfo; + 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); + } elsif ($ENV{LANG} =~ /^([^.]+)\.([^.]+)$/) { + ($country_language, $locale_encoding) = ($1, $2); + } + # LANGUAGE affects only LC_MESSAGES only on glibc + } elsif (not $locale_encoding) { + if ($ENV{LC_ALL} =~ /\butf-?8\b/i || + $ENV{LANG} =~ /\butf-?8\b/i) { + $locale_encoding = 'utf8'; + } + # Could do more heuristics based on the country and language + # parts of LC_ALL and LANG (the parts before the dot (if any)), + # since we have Locale::Country and Locale::Language available. + # TODO: get a database of Language -> Encoding mappings + # (the Estonian database at http://www.eki.ee/letter/ + # would be excellent!) --jhi + } + if (defined $locale_encoding && + lc($locale_encoding) eq 'euc' && + defined $country_language) { + if ($country_language =~ /^ja_JP|japan(?:ese)?$/i) { + $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'; + } else { + croak "Locale encoding 'euc' too ambiguous"; + } + } + } +} sub import { my ($class,@args) = @_; - croak("`use open' needs explicit list of disciplines") unless @args; + croak("`use open' needs explicit list of PerlIO layers") unless @args; + my $std; $^H |= $open::hint_bits; - my ($in,$out) = split(/\0/,(${^OPEN} || '\0')); - my @in = split(/\s+/,$in); - my @out = split(/\s+/,$out); + my ($in,$out) = split(/\0/,(${^OPEN} || "\0"), -1); while (@args) { my $type = shift(@args); - my $discp = shift(@args); + my $dscp; + if ($type =~ /^:?(utf8|locale|encoding\(.+\))$/) { + $type = 'IO'; + $dscp = ":$1"; + } elsif ($type eq ':std') { + $std = 1; + next; + } else { + $dscp = shift(@args) || ''; + } my @val; - foreach my $layer (split(/\s+/,$discp)) { + foreach my $layer (split(/\s+/,$dscp)) { $layer =~ s/^://; - unless(exists $layers{$layer}) { - carp("Unknown discipline layer '$layer'"); + if ($layer eq 'locale') { + require Encode; + _get_locale_encoding() + unless defined $locale_encoding; + (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 { + my $target = $layer; # the layer name itself + $target =~ s/^(\w+)\(.+\)$/$1/; # strip parameters + + unless(PerlIO::Layer::->find($target,1)) { + warnings::warnif("layer", "Unknown PerlIO layer '$target'"); + } } push(@val,":$layer"); if ($layer =~ /^(crlf|raw)$/) { @@ -38,11 +110,32 @@ sub import { elsif ($type eq 'OUT') { $out = join(' ',@val); } + elsif ($type eq 'IO') { + $in = $out = join(' ',@val); + } else { - croak "Unknown discipline class '$type'"; + croak "Unknown PerlIO layer class '$type'"; + } + } + ${^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"); + } } } - ${^OPEN} = join('\0',$in,$out); } 1; @@ -50,52 +143,152 @@ __END__ =head1 NAME -open - perl pragma to set default disciplines for input and output +open - perl pragma to set default PerlIO layers for input and output =head1 SYNOPSIS - use open IN => ":crlf", OUT => ":raw"; + use open IN => ":crlf", OUT => ":bytes"; + use open OUT => ':utf8'; + 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 -The open pragma is used to declare one or more default disciplines for -I/O operations. Any open() and readpipe() (aka qx//) operators found -within the lexical scope of this pragma will use the declared defaults. -Neither open() with an explicit set of disciplines, nor sysopen() are -influenced by this pragma. +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). -Only the two pseudo-disciplines ":raw" and ":crlf" are currently -available. +The C 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. +Three-argument opens are not affected by this pragma since there you +(can) explicitly specify the layers and are supposed to know what you +are doing. -The ":raw" discipline corresponds to "binary mode" and the ":crlf" -discipline 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 disciplines are currently -no-ops on platforms where binmode() is a no-op, but will be -supported everywhere in future. +With the C subpragma you can declare the default layers +of input streams, and with the C subpragma you can declare +the default layers of output streams. With the C subpragma +you can control both input and output streams simultaneously. + +If you have a legacy encoding, you can use the C<:encoding(...)> tag. + +if you want to set your encoding layers based on your +locale environment variables, you can use the C<:locale> tag. +For example: + + $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, "), "\n"; # this should print 0xc1 + close I; -=head1 UNIMPLEMENTED FUNCTIONALITY +These are equivalent -Full-fledged support for I/O disciplines is currently unimplemented. -When they are eventually supported, this pragma will serve as one of -the interfaces to declare default disciplines for all I/O. + use open ':utf8'; + use open IO => ':utf8'; + +as are these + + use open ':locale'; + use open IO => ':locale'; + +and these + + 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 L for +details and the list of supported locales. + +Note that C<:utf8> PerlIO layer must always be specified exactly like +that, it is not subject to the loose matching of encoding names. + +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. 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 (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, is UTF-8. + +Directory handles may also support PerlIO layers in the future. + +=head1 NONPERLIO FUNCTIONALITY + +If Perl is not built to use PerlIO as its IO system then only the two +pseudo-layers C<:bytes> and C<:crlf> are available. + +The C<:bytes> layer corresponds to "binary mode" and the C<: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. -In future, any default disciplines declared by this pragma will be -available by the special discipline name ":DEFAULT", and could be used -within handle constructors that allow disciplines to be specified. -This would make it possible to stack new disciplines over the default -ones. +=head1 IMPLEMENTATION DETAILS - open FH, "<:para :DEFAULT", $file or die "can't open $file: $!"; +There is a class method in C C which is +implemented as XS code. It is called by C to validate the +layers: -Socket and directory handles will also support disciplines in -future. + PerlIO::Layer::->find("perlio") -Full support for I/O disciplines will enable all of the supported -disciplines to work on all platforms. +The return value (if defined) is a Perl object, of class +C which is created by the C code in F. As +yet there is nothing useful you can do with the object at the perl +level. =head1 SEE ALSO -L, L, L +L, L, L, L, +L =cut