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