root/lang/perl/Encode-JP-Mobile/trunk/lib/Encode/JP/Mobile.pm @ 6445

Revision 6445, 15.3 kB (checked in by tomi-ru, 6 years ago)

InMobileJPPictogramsがPODになかった

  • Property svn:keywords set to Id Revision
Line 
1package Encode::JP::Mobile;
2use strict;
3our $VERSION = "0.24";
4
5use Carp;
6use Encode;
7use XSLoader;
8XSLoader::load(__PACKAGE__, $VERSION);
9
10use base qw( Exporter );
11our @EXPORT_OK = qw( InDoCoMoPictograms InKDDIPictograms InSoftBankPictograms InAirEdgePictograms InMobileJPPictograms InKDDISoftBankConflicts InKDDICP932Pictograms InKDDIAutoPictograms);
12our %EXPORT_TAGS = ( props => [@EXPORT_OK] );
13
14use Encode::Alias;
15
16# sjis-raw
17define_alias( 'x-sjis-imode-raw'         => 'x-sjis-docomo-raw' );
18define_alias( 'x-sjis-airedge-raw'       => 'x-sjis-airh-raw' );
19define_alias( 'x-sjis-vodafone-auto-raw' => 'x-sjis-softbank-auto-raw' );
20
21define_alias( 'x-sjis-kddi'              => 'x-sjis-kddi-cp932-raw' );
22define_alias( 'x-sjis-ezweb'             => 'x-sjis-kddi-cp932-raw' );
23define_alias( 'x-sjis-ezweb-cp932-raw'   => 'x-sjis-kddi-cp932-raw' );
24define_alias( 'x-sjis-ezweb-auto-raw'    => 'x-sjis-kddi-auto-raw' );
25
26# backward compatiblity
27define_alias('shift_jis-kddi'       => 'x-sjis-kddi-cp932-raw');
28
29# utf8
30define_alias( 'x-utf8-imode'    => 'x-utf8-docomo' );
31define_alias( 'x-utf8-ezweb'    => 'x-utf8-kddi' );
32define_alias( 'x-utf8-vodafone' => 'x-utf8-softbank' );
33
34use Encode::JP::Mobile::Vodafone;
35use Encode::JP::Mobile::KDDIJIS;
36use Encode::JP::Mobile::ConvertPictogramSJIS;
37require Encode::JP::Mobile::Fallback;
38require Encode::JP::Mobile::Character;
39
40sub InDoCoMoPictograms {
41    return <<END;
42E63E\tE6A5
43E6AC\tE6AE
44E6B1\tE6B3
45E6B7\tE6BA
46E6CE\tE757
47END
48}
49
50sub InKDDICP932Pictograms {
51    return <<END;
52E468\tE5DF
53EA80\tEB88
54END
55}
56
57
58sub InKDDIAutoPictograms {
59    return <<END;
60EC40\tEC7E
61EC80\tECFC
62ED40\tED7E
63ED80\tED8D
64EF40\tEF7E
65EF80\tEFFC
66F040\tF07E
67F080\tF0FC
68END
69}
70
71sub InKDDIPictograms {
72    return join "\n", InKDDICP932Pictograms(), InKDDIAutoPictograms();
73}
74
75sub InSoftBankPictograms {
76    return <<END;
77E001\tE05A
78E101\tE15A
79E201\tE253
80E255\tE257
81E301\tE34D
82E401\tE44C
83E501\tE537
84END
85}
86
87sub InAirEdgePictograms {
88    return <<END;
89E000\tE096
90E098
91E09A
92E09F
93E0A2
94E0A6
95E0A8
96E0AF
97E0BB
98E0C4
99E0C9
100END
101}
102
103sub InMobileJPPictograms {
104    # +utf8::InDoCoMoPictograms etc. don't work here
105    return join "\n", InDoCoMoPictograms, InKDDIPictograms, InSoftBankPictograms, InAirEdgePictograms;
106}
107
108sub InKDDISoftBankConflicts {
109    return <<END;
110E501\tE537
111END
112}
113
1141;
115__END__
116
117=encoding utf-8
118
119=head1 NAME
120
121Encode::JP::Mobile - 日本の携帯電話向け Shift_JIS (CP932) / UTF-8 エンコーディング
122
123=head1 SYNOPSIS
124
125  use Encode;
126  use Encode::JP::Mobile;
127
128  my $bytes = "\x82\xb1\xf9\x5d\xf8\xa0\x82\xb1"; # NTT DoCoMo 絵文字を含んだ Shift_JIS バイト列
129  my $chars = decode("x-sjis-imode", $bytes);     # \x{3053}\x{e6b9}\x{e63f}\x{3053}
130
131  use Encode::JP::Mobile ':props';
132  if ($chars =~ /\p{InDoCoMoPictograms}/) {
133      warn "It has DoCoMo pictogram characters!";
134  }
135
136
137=head1 DESCRIPTION
138
139Encode::JP::Mobile は Encode 用の拡張モジュールで、日本の携帯電話用絵文字を Unicode の私用領域 (PRIVATE AREA) にマッピングします。
140
141このモジュールの実装は B<EXPERIMENTAL> です。APIや実装は将来のバージョンで変更される可能性があります。
142
143=head1 ENCODINGS
144
145このモジュールは以下のエンコーディングをサポートしています。
146
147=over 4
148
149=item x-sjis-imode
150
151NTT DoCoMo の i-mode 端末用のマッピング。絵文字は Shift_JIS の私用領域でエンコードされ、Unicode の私用領域にマッピングされます。この際の変換ルールは CP932 と同様です。
152
153例えば、C<U+E64E> は I<晴れ> の絵文字で、このエンコーディングでは C<\xF8\X9F> にエンコードされます。
154
155このエンコーディングは CP932 の完全なサブセットです。現状のバージョンでは、(x-sjis-kddi-autoでdecodeした)KDDI/AU の絵文字および SoftBank の絵文字をマップした Unicode 私用領域からDoCoMo 絵文字へのマッピングもサポートしています。例えば、
156
157  my $kddi  = "\xf6\x59"; # KDDI/AU の SJIS で [!]
158  my $char  = decode("x-sjis-kddi-auto-raw", $bytes); # \x{EF59}
159  my $imode = encode("x-sjis-imode", $char); # \xf9\xdc -- DoCoMo の SJIS で [!]
160
161のように相互変換されます。
162
163I<x-sjis-docomo> をエイリアスとして利用できます。
164
165=item x-sjis-softbank
166
167SoftBank 絵文字をエンコードするためのエスケープシーケンスがベースの Shift_JIS エンコーディングです。エンコード・デコードのアルゴリズムは UCM ファイルではなく、Perl コードで実装されています。
168
169I<x-sjis-vodafone> をエイリアスとして利用できます。
170
171例えば、C<U+E001> は I<男の子> の絵文字で、このエンコーディングでは C<\x1b$G!\x0f> のようにエンコードされます。(C<\x1b> がエスケープシーケンス開始、C<\x0f> が終了を示す)
172
173DoCoMo および (x-sjis-kddi-autoでdecodeした)KDDI/AU の絵文字は適切な SoftBank 絵文字にマッピングされます。
174
175=item x-sjis-softbank-auto
176
177Unicode 私用領域にマップされた SoftBank 絵文字と Shift_JIS 私用領域(外字)をマッピングします。このエンコーディングは 3GC 端末を利用して Shift_JIS でエンコードされた Web フォームに絵文字を入力し、サブミットしたときに送信されるエンコードです。実機端末では HTML 内にこのエンコーディングでエンコードした絵文字をデコードして表示できることが確認されています。
178
179I<x-sjis-vodafone-auto> をエイリアスとして利用できます。
180
181Shift_JIS 私用領域のマッピングは CP932 に似ていますが、若干ずれている場所があります。
182
183例えば、 C<U+E001> は I<男の子> 絵文字 (I<x-sjis-softbank> と同様) で、このエンコーディングでは I<\xF9\x41> とエンコードされます。
184
185DoCoMo および KDDI/AU の絵文字は適切な SoftBank 絵文字にマッピングされます。
186
187=item x-sjis-kddi-cp932-raw
188
189KDDI/AU 絵文字のマッピング。(おそらく)CP932 をベースにしていますが、CP932.TXT には含まれない私用領域文字を多く含んでいます。
190
191例えば、I<U+E481> は I<!> (ビックリマーク)絵文字で、このエンコーディングでは I<\xF6\x59> のようにエンコードされ、これは CP932 と同様です。 I<U+EB88> は I<怒る> 絵文字で、I<\xF4\x8D> のようにエンコードされますが、CP932 はこの文字に対するマッピングを含んでいません。
192
193このエンコーディングに含まれる一部の絵文字は、SoftBank の私用領域と重複しています。
194
195このエンコーディングでは、絵文字の相互変換がおこなわれないことに注意してください。これは、KDDI-CP932 の Unicode の領域が SoftBank の絵文字領域と重複しているため、ただしく相互変換することができないためです。絵文字相互変換機能を利用したい場合には x-sjis-kddi-auto を使用してください。
196
197I<x-sjis-ezweb> をエイリアスとして利用できます。
198
199=item x-sjis-kddi-auto
200
201KDDI/AU 絵文字のマッピングで、端末内部の Shift_JIS - UTF-8 間の変換表を元にしています。
202
203KDDI端末から、UTF-8 ページ内の Web フォームに絵文字を入力して送信した場合、x-sjis-kddi でマップされる Unicode 私用領域 (CP932 ベース) とは異なる領域(通称 裏KDDI Unicode)が利用されます。x-sjis-kddi-auto は、この領域と、KDDI 端末の Shift_JIS 外字バイト列とをマッピングしたものです。
204
205現状のバージョンでは、DoCoMo の絵文字をマップした Unicode 私用領域から KDDI/AU 絵文字、SoftBank 絵文字へのマッピングもサポートしています。
206
207C<x-sjis-ezweb-auto> をエイリアスとして利用できます。
208
209=item x-iso-2022-jp-kddi
210
211KDDI/AU の絵文字を Email 内で利用する際のエンコーディング。日本語でメールを送信する際、依然としてデファクトスタンダードである I<iso-2022-jp> をベースにしています。
212
213実際には、ほとんどの KDDI/AU 携帯電話端末は Shift_JIS でエンコードされた Email を受信することができるため、I<x-sjis-kddi> (または -auto)を利用してメールを送信すれば問題はないでしょう。このエンコーディングは携帯端末から送られた絵文字を含むメールを受信し、デコードする際に必要になります。
214
215C<x-iso-2022-jp-ezweb> をエイリアスとして利用できます。
216
217=item x-iso-2022-jp-kddi-auto
218
219I<x-iso-2022-jp-kddi> と同様ですが、絵文字を KDDI-Auto の Unicode 領域にデコードします。
220
221=item x-sjis-airedge
222
223AirEDGE の絵文字をマッピングします。cp932 の完全なサブセットで、I<x-sjis-airh> をエイリアスとして利用できます。
224
225AirEDGE 独自の文字コードでは、絵文字は E000 - E0C9 にマップされ、CP932 と同様のエンコーディングですが、実際にはこのエンコーディングを利用することはまずないと思われます。AirEDGE 端末から「ウェブ用絵文字」を利用して送信したデータは、DoCoMo 用絵文字と同様のエンコーディングで送信され、CP932 互換のマッピングで DoCoMo 用絵文字のコードポイントにマッピングされます。また、AirEDGE 独自の絵文字私用領域は SoftBank の私用領域とも重複しており、相互変換の上でも問題があります。
226
227I<x-sjis-airedge> は I<x-sjis-docomo> の別名、として考えておくとよいでしょう。
228
229SoftBank および KDDI/AU の絵文字は適切な DoCoMo 絵文字(ウェブ入力用絵文字)にマッピングされます。
230
231=item x-utf8-docomo, x-utf8-softbank, x-utf8-kddi
232
233これらのエンコーディングは、Unicode 私用領域にある各キャリアの絵文字を相互変換しながら UTF-8 互換のエンコーディングにエンコードするのに使用します。utf-8 という名前がついていますが、実際にはすべての Unicode 文字をエンコードするわけではなく、サブセットとして、
234
235  cp932 + x-sjis-{キャリア} + (他キャリアからのマッピング)
236
237に含まれる文字セットをエンコードし、他キャリアの分は自動で自キャリアの対応する絵文字に変換します。
238
239例えば、
240
241  # UTF-8 で KDDI の "晴れ" 絵文字
242  my $bytes = "\xEE\xBD\xA0";
243  Encode::from_to($bytes, "utf-8" => "x-utf8-docomo");
244  # $bytes は DoCoMo の "晴れ" 絵文字を UTF-8 でエンコードしたもの
245
246これらのエンコードは基本的にラウンドトリップ可能ですが、UTF-8のサブセットであるため、CP932 および携帯絵文字以外の文字をエンコード・デコードすることはできません。また、各キャリア間で変換不可能な文字についても対応するマッピングが存在しない場合がありますので、C<FB_XMLCREF> などの fallback や、カスタムコールバックなどを利用して代替文字を表示する必要があります。
247
248詳しくは L<http://mobilehacker.g.hatena.ne.jp/tokuhirom/20080116/1200501202>
249や L<http://mobilehacker.g.hatena.ne.jp/tomi-ru/20071116/1195186373> などを参照。
250
251I<x-utf8-airh>, I<x-utf8-airedge> は存在しません。Willcom 端末は utf8 でページを表示している場合には絵文字の表示ができないようです。詳しくは L<http://mobilehacker.g.hatena.ne.jp/tokuhirom/20080118/1200637282> を参照。Willcom 端末で絵文字を表示させたい場合には I<x-sjis-airh>, I<x-sjis-airedge> をご利用ください。
252
253=item x-sjis-docomo-raw, x-sjis-softbank-raw, x-sjis-softbank-auto-raw, x-sjis-kddi-cp932-raw, x-sjis-kddi-auto-raw, x-sjis-airh-raw
254
255x-sjis-* のエンコーディングには -raw suffix がついたバージョンのエンコーディングも用意されています。
256
257これは、FALLBACK によって文字コードを判定するような用途を想定しています。
258
259x-utf8-*-raw が用意されていないのは、utf-8 エンコーディングがそれにあたるからです。
260
261=back
262
263=head1 UNICODE PROPERTIES
264
265モジュールを ':props' フラグつきで import すると、以下のUnicode プロパティが利用できるようになります。
266
267=over 4
268
269=item InMobileJPPictograms
270
271=item InDoCoMoPictograms
272
273=item InKDDIPictograms
274
275=item InSoftBankPictograms
276
277=item InAirEdgePictograms
278
279=item InKDDISoftBankConflicts
280
281=item InKDDICP932Pictograms
282
283=item InKDDIAutoPictograms
284
285=item InMobileJPPictograms
286
287=back
288
289I<InMobileJPPictograms> は Encode::JP::Mobile であつかうすべての絵文字にマッチします。
290
291I<InKDDIPictograms> はCP932ベースと裏KDDI Unicodeの双方を含みます。
292
293入力が Shift_JIS である場合、まずどの x-sjis-* に対応するかを判別した上でデコードし、Unicode コードポイントを得たあとでないとキャリアを見分けることができません。よって入力が UTF-8 である場合や、いったん x-sjis-* を利用してデコードしたものに対して使うと便利でしょう。
294
295InKDDISoftBankConflicts は SoftBank と KDDI (x-sjis-kddi を利用した場合) の Unicode 私用領域の重複する文字列を含んでいます。以下のようなコードで、元々の絵文字が KDDI のものであったか、SoftBank のものであったか判定することが可能です(文字列に含まれる絵文字が重複部分のみの場合、判定することはできません)。
296
297  my $string = ...;
298
299  if ($string =~ /\p{InKDDISoftBankConflicts}/) {
300      eval { Encode::encode("x-sjis-kddi", $string, Encode::FB_CROAK) };
301      if ($@) {
302          # softbank
303      } else {
304          # KDDI
305      }
306  }
307
308I<InKDDICP932Pictograms>, I<InKDDIAutoPictograms> はそれぞれ、I<x-sjis-kddi>, I<x-sjis-kddi-auto> のマッピングによって得られる Unicode 私用領域のレンジをあらわし、InKDDIPictograms はその2つをマージしたものとして扱われます。
309
310=head1 BACKWARD COMPATIBLITY
311
312バージョン 0.07 から、モジュールで利用するエンコーディング名を I<x-sjis-*> のように変更しました。以前の I<shift_jis-*> というエイリアスも残してありますが、将来のリリースで削除される予定です。
313
314バージョン 0.25 から、x-sjis-kddi-cp932-raw(旧称 x-sjis-kddi)は DoCoMo との絵文字相互変換をおこなわなくなりました。
315
316=head1 AUTHORS
317
318Tatsuhiko Miyagawa E<lt>miyagawa@bulknews.netE<gt> with contributions from:
319
320Tokuhiro Matsuno
321
322Naoki Tomita
323
324Masahiro Chiba
325
326=head1 LICENSE
327
328This library is free software, licensed under the same terms with Perl.
329
330=head1 SEE ALSO
331
332L<Encode>, L<HTML::Entities::ImodePictogram>, L<Unicode::Japanese>
333
334L<http://www.nttdocomo.co.jp/service/imode/make/content/pictograph/basic/>
335L<http://www.nttdocomo.co.jp/service/imode/make/content/pictograph/extention/>
336L<http://www.au.kddi.com/ezfactory/tec/spec/3.html>
337L<http://developers.softbankmobile.co.jp/dp/tool_dl/web/picword_top.php>
338L<http://www.willcom-inc.com/ja/service/contents_service/club_air_edge/for_phone/homepage/index.html>
339L<http://www.nttdocomo.co.jp/service/mail/imode_mail/emoji_convert/>
340L<http://www.nttdocomo.co.jp/binary/pdf/service/mail/imode_mail/emoji_convert/pictogram.pdf>
341L<http://broadband.mb.softbank.jp/service/3G/mail/pictogram/convert.pdf>
342
343=cut
Note: See TracBrowser for help on using the browser.