Re: [perl #32687] Encode::is_utf8 on tainted UTF8 string
[p5sagit/p5-mst-13.2.git] / ext / Encode / JP / JP.pm
index f3d4998..e78e54d 100644 (file)
@@ -1,11 +1,99 @@
 package Encode::JP;
+BEGIN {
+    if ( ord("A") == 193 ) {
+        die "Encode::JP not supported on EBCDIC\n";
+    }
+}
+use strict;
+use warnings;
 use Encode;
-our $VERSION = '0.02';
+our $VERSION = do { my @r = ( q$Revision: 2.3 $ =~ /\d+/g ); sprintf "%d." . "%02d" x $#r, @r };
+
 use XSLoader;
-XSLoader::load('Encode::JP',$VERSION);
+XSLoader::load( __PACKAGE__, $VERSION );
 
-use Encode::JP::JIS;
-use Encode::JP::ISO_2022_JP;
+use Encode::JP::JIS7;
 
 1;
 __END__
+
+=head1 NAME
+
+Encode::JP - Japanese Encodings
+
+=head1 SYNOPSIS
+
+    use Encode qw/encode decode/; 
+    $euc_jp = encode("euc-jp", $utf8);   # loads Encode::JP implicitly
+    $utf8   = decode("euc-jp", $euc_jp); # ditto
+
+=head1 ABSTRACT
+
+This module implements Japanese charset encodings.  Encodings
+supported are as follows.
+
+  Canonical   Alias            Description
+  --------------------------------------------------------------------
+  euc-jp      /\beuc.*jp$/i    EUC (Extended Unix Character)
+              /\bjp.*euc/i   
+          /\bujis$/i
+  shiftjis    /\bshift.*jis$/i Shift JIS (aka MS Kanji)
+          /\bsjis$/i
+  7bit-jis    /\bjis$/i                7bit JIS
+  iso-2022-jp                  ISO-2022-JP                  [RFC1468]
+                = 7bit JIS with all Halfwidth Kana 
+                  converted to Fullwidth
+  iso-2022-jp-1                        ISO-2022-JP-1                [RFC2237]
+                                = ISO-2022-JP with JIS X 0212-1990
+                  support.  See below
+  MacJapanese                  Shift JIS + Apple vendor mappings
+  cp932       /\bwindows-31j$/i Code Page 932
+                                = Shift JIS + MS/IBM vendor mappings
+  jis0201-raw                   JIS0201, raw format
+  jis0208-raw                   JIS0201, raw format
+  jis0212-raw                   JIS0201, raw format
+  --------------------------------------------------------------------
+
+=head1 DESCRIPTION
+
+To find out how to use this module in detail, see L<Encode>.
+
+=head1 Note on ISO-2022-JP(-1)?
+
+ISO-2022-JP-1 (RFC2237) is a superset of ISO-2022-JP (RFC1468) which
+adds support for JIS X 0212-1990.  That means you can use the same
+code to decode to utf8 but not vice versa.
+
+  $utf8 = decode('iso-2022-jp-1', $stream);
+
+and
+
+  $utf8 = decode('iso-2022-jp',   $stream);
+
+yield the same result but
+
+  $with_0212 = encode('iso-2022-jp-1', $utf8);
+
+is now different from
+
+  $without_0212 = encode('iso-2022-jp', $utf8 );
+
+In the latter case, characters that map to 0212 are first converted
+to U+3013 (0xA2AE in EUC-JP; a white square also known as 'Tofu' or
+'geta mark') then fed to the decoding engine.  U+FFFD is not used,
+in order to preserve text layout as much as possible.
+
+=head1 BUGS
+
+The ASCII region (0x00-0x7f) is preserved for all encodings, even
+though this conflicts with mappings by the Unicode Consortium.  See
+
+L<http://www.debian.or.jp/~kubota/unicode-symbols.html.en>
+
+to find out why it is implemented that way.
+
+=head1 SEE ALSO
+
+L<Encode>
+
+=cut