Upgrade to Encode 2.00.
[p5sagit/p5-mst-13.2.git] / ext / Encode / JP / JP.pm
CommitLineData
0e567a6c 1package Encode::JP;
0f3b375a 2BEGIN {
3 if (ord("A") == 193) {
4 die "Encode::JP not supported on EBCDIC\n";
5 }
6}
0e567a6c 7use Encode;
7237418a 8our $VERSION = do { my @r = (q$Revision: 2.0 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };
ee981de6 9
0e567a6c 10use XSLoader;
b2704119 11XSLoader::load(__PACKAGE__,$VERSION);
0e567a6c 12
aae85ceb 13use Encode::JP::JIS7;
0e567a6c 14
151;
16__END__
67d7b5ef 17
557e5ea9 18=head1 NAME
19
20Encode::JP - Japanese Encodings
21
22=head1 SYNOPSIS
23
1b2c56c8 24 use Encode qw/encode decode/;
2b217bf7 25 $euc_jp = encode("euc-jp", $utf8); # loads Encode::JP implicitly
ee981de6 26 $utf8 = decode("euc-jp", $euc_jp); # ditto
557e5ea9 27
28=head1 ABSTRACT
29
30This module implements Japanese charset encodings. Encodings
31supported are as follows.
32
fab31126 33 Canonical Alias Description
34 --------------------------------------------------------------------
67d7b5ef 35 euc-jp /\beuc.*jp$/i EUC (Extended Unix Character)
36 /\bjp.*euc/i
37 /\bujis$/i
38 shiftjis /\bshift.*jis$/i Shift JIS (aka MS Kanji)
39 /\bsjis$/i
40 7bit-jis /\bjis$/i 7bit JIS
41 iso-2022-jp ISO-2022-JP [RFC1468]
a999c27c 42 = 7bit JIS with all Halfwidth Kana
43 converted to Fullwidth
67d7b5ef 44 iso-2022-jp-1 ISO-2022-JP-1 [RFC2237]
a999c27c 45 = ISO-2022-JP with JIS X 0212-1990
46 support. See below
47 MacJapanese Shift JIS + Apple vendor mappings
67d7b5ef 48 cp932 Code Page 932
a999c27c 49 = Shift JIS + MS/IBM vendor mappings
f2a2953c 50 jis0201-raw JIS0201, raw format
51 jis0208-raw JIS0201, raw format
52 jis0212-raw JIS0201, raw format
5129552c 53 --------------------------------------------------------------------
557e5ea9 54
55=head1 DESCRIPTION
56
0ab8f81e 57To find out how to use this module in detail, see L<Encode>.
557e5ea9 58
a63c962f 59=head1 Note on ISO-2022-JP(-1)?
60
61ISO-2022-JP-1 (RFC2237) is a superset of ISO-2022-JP (RFC1468) which
62adds support for JIS X 0212-1990. That means you can use the same
63code to decode to utf8 but not vice versa.
64
65 $utf8 = decode('iso-2022-jp-1', $stream);
0ab8f81e 66
67and
68
a63c962f 69 $utf8 = decode('iso-2022-jp', $stream);
70
0ab8f81e 71yield the same result but
a63c962f 72
73 $with_0212 = encode('iso-2022-jp-1', $utf8);
74
75is now different from
76
77 $without_0212 = encode('iso-2022-jp', $utf8 );
78
0ab8f81e 79In the latter case, characters that map to 0212 are first converted
80to U+3013 (0xA2AE in EUC-JP; a white square also known as 'Tofu' or
81'geta mark') then fed to the decoding engine. U+FFFD is not used,
82in order to preserve text layout as much as possible.
a63c962f 83
557e5ea9 84=head1 BUGS
85
0ab8f81e 86The ASCII region (0x00-0x7f) is preserved for all encodings, even
87though this conflicts with mappings by the Unicode Consortium. See
557e5ea9 88
a63c962f 89L<http://www.debian.or.jp/~kubota/unicode-symbols.html.en>
557e5ea9 90
0ab8f81e 91to find out why it is implemented that way.
557e5ea9 92
93=head1 SEE ALSO
94
85982a32 95L<Encode>
557e5ea9 96
97=cut