Upgrade to Encode 1.51, from Dan Kogai.
[p5sagit/p5-mst-13.2.git] / pod / perluniintro.pod
CommitLineData
ba62762e 1=head1 NAME
2
07fcf8ff 3perluniintro - Perl Unicode introduction
ba62762e 4
5=head1 DESCRIPTION
6
7This document gives a general idea of Unicode and how to use Unicode
8in Perl.
9
10=head2 Unicode
11
12Unicode is a character set standard with plans to cover all of the
13writing systems of the world, plus many other symbols.
14
15Unicode and ISO/IEC 10646 are coordinated standards that provide code
16points for the characters in almost all modern character set standards,
17covering more than 30 writing systems and hundreds of languages,
18including all commercially important modern languages. All characters
19in the largest Chinese, Japanese, and Korean dictionaries are also
20encoded. The standards will eventually cover almost all characters in
21more than 250 writing systems and thousands of languages.
22
23A Unicode I<character> is an abstract entity. It is not bound to any
24particular integer width, and especially not to the C language C<char>.
25Unicode is language neutral and display neutral: it doesn't encode the
26language of the text, and it doesn't define fonts or other graphical
27layout details. Unicode operates on characters and on text built from
28those characters.
29
30Unicode defines characters like C<LATIN CAPITAL LETTER A> or C<GREEK
31SMALL LETTER ALPHA>, and then unique numbers for those, hexadecimal
320x0041 or 0x03B1 for those particular characters. Such unique
33numbers are called I<code points>.
34
35The Unicode standard prefers using hexadecimal notation for the code
36points. (In case this notation, numbers like 0x0041, is unfamiliar to
37you, take a peek at a later section, L</"Hexadecimal Notation">.)
38The Unicode standard uses the notation C<U+0041 LATIN CAPITAL LETTER A>,
39which gives the hexadecimal code point, and the normative name of
40the character.
41
42Unicode also defines various I<properties> for the characters, like
43"uppercase" or "lowercase", "decimal digit", or "punctuation":
44these properties are independent of the names of the characters.
45Furthermore, various operations on the characters like uppercasing,
46lowercasing, and collating (sorting), are defined.
47
48A Unicode character consists either of a single code point, or a
49I<base character> (like C<LATIN CAPITAL LETTER A>), followed by one or
50more I<modifiers> (like C<COMBINING ACUTE ACCENT>). This sequence of
51a base character and modifiers is called a I<combining character
52sequence>.
53
a5f0baef 54Whether to call these combining character sequences, as a whole,
55"characters" depends on your point of view. If you are a programmer,
56you probably would tend towards seeing each element in the sequences
57as one unit, one "character", but from the user viewpoint, the
58sequence as a whole is probably considered one "character", since
59that's probably what it looks like in the context of the user's
60language.
ba62762e 61
62With this "as a whole" view of characters, the number of characters is
a5f0baef 63open-ended. But in the programmer's "one unit is one character" point
64of view, the concept of "characters" is more deterministic, and so we
65take that point of view in this document: one "character" is one
66Unicode code point, be it a base character or a combining character.
ba62762e 67
68For some of the combinations there are I<precomposed> characters,
69for example C<LATIN CAPITAL LETTER A WITH ACUTE> is defined as
70a single code point. These precomposed characters are, however,
71often available only for some combinations, and mainly they are
72meant to support round-trip conversions between Unicode and legacy
73standards (like the ISO 8859), and in general case the composing
74method is more extensible. To support conversion between the
75different compositions of the characters, various I<normalization
76forms> are also defined.
77
78Because of backward compatibility with legacy encodings, the "a unique
79number for every character" breaks down a bit: "at least one number
80for every character" is closer to truth. (This happens when the same
81character has been encoded in several legacy encodings.) The converse
82is also not true: not every code point has an assigned character.
83Firstly, there are unallocated code points within otherwise used
84blocks. Secondly, there are special Unicode control characters that
85do not represent true characters.
86
87A common myth about Unicode is that it would be "16-bit", that is,
880x10000 (or 65536) characters from 0x0000 to 0xFFFF. B<This is untrue.>
89Since Unicode 2.0 Unicode has been defined all the way up to 21 bits
90(0x10FFFF), and since 3.1 characters have been defined beyond 0xFFFF.
91The first 0x10000 characters are called the I<Plane 0>, or the I<Basic
92Multilingual Plane> (BMP). With the Unicode 3.1, 17 planes in all are
93defined (but nowhere near full of defined characters yet).
94
95Another myth is that the 256-character blocks have something to do
96with languages: a block per language. B<Also this is untrue.>
97The division into the blocks exists but it is almost completely
98accidental, an artifact of how the characters have been historically
99allocated. Instead, there is a concept called I<scripts>, which may
100be more useful: there is C<Latin> script, C<Greek> script, and so on.
101Scripts usually span several parts of several blocks. For further
102information see L<Unicode::UCD>.
103
104The Unicode code points are just abstract numbers. To input and
105output these abstract numbers, the numbers must be I<encoded> somehow.
106Unicode defines several I<character encoding forms>, of which I<UTF-8>
107is perhaps the most popular. UTF-8 is a variable length encoding that
108encodes Unicode characters as 1 to 6 bytes (only 4 with the currently
8baee566 109defined characters). Other encodings include UTF-16 and UTF-32 and their
ba62762e 110big and little endian variants (UTF-8 is byteorder independent).
111The ISO/IEC 10646 defines the UCS-2 and UCS-4 encoding forms.
112
113For more information about encodings, for example to learn what
114I<surrogates> and I<byte order marks> (BOMs) are, see L<perlunicode>.
115
116=head2 Perl's Unicode Support
117
118Starting from Perl 5.6.0, Perl has had the capability of handling
119Unicode natively. The first recommended release for serious Unicode
120work is Perl 5.8.0, however. The maintenance release 5.6.1 fixed many
121of the problems of the initial implementation of Unicode, but for
122example regular expressions didn't really work with Unicode.
123
124B<Starting from Perl 5.8.0, the use of C<use utf8> is no longer
125necessary.> In earlier releases the C<utf8> pragma was used to declare
126that operations in the current block or file would be Unicode-aware.
127This model was found to be wrong, or at least clumsy: the Unicodeness
128is now carried with the data, not attached to the operations. (There
129is one remaining case where an explicit C<use utf8> is needed: if your
a5f0baef 130Perl script itself is encoded in UTF-8, you can use UTF-8 in your
c20e2abd 131identifier names, and in your string and regular expression literals,
132by saying C<use utf8>. This is not the default because that would
133break existing scripts having legacy 8-bit data in them.)
ba62762e 134
135=head2 Perl's Unicode Model
136
137Perl supports both the old, pre-5.6, model of strings of eight-bit
138native bytes, and strings of Unicode characters. The principle is
139that Perl tries to keep its data as eight-bit bytes for as long as
140possible, but as soon as Unicodeness cannot be avoided, the data is
141transparently upgraded to Unicode.
142
4192de81 143Internally, Perl currently uses either whatever the native eight-bit
144character set of the platform (for example Latin-1) or UTF-8 to encode
145Unicode strings. Specifically, if all code points in the string are
a5f0baef 1460xFF or less, Perl uses the native eight-bit character set.
147Otherwise, it uses UTF-8.
4192de81 148
7ca610e8 149A user of Perl does not normally need to know nor care how Perl
20ba30f4 150happens to encode its internal strings, but it becomes relevant when
7ca610e8 151outputting Unicode strings to a stream without a discipline (one with
152the "default default"). In such a case, the raw bytes used internally
153(the native character set or UTF-8, as appropriate for each string)
154will be used, and a "Wide character" warning will be issued if those
155strings contain a character beyond 0x00FF.
4192de81 156
157For example,
158
7ca610e8 159 perl -e 'print "\x{DF}\n", "\x{0100}\x{DF}\n"'
4192de81 160
161produces a fairly useless mixture of native bytes and UTF-8, as well
162as a warning.
163
164To output UTF-8 always, use the ":utf8" output discipline. Prepending
165
166 binmode(STDOUT, ":utf8");
167
168to this sample program ensures the output is completely UTF-8, and
4049dcd4 169of course, removes the warning.
ba62762e 170
b310b053 171If your locale environment variables (LANGUAGE, LC_ALL, LC_CTYPE, LANG)
172contain the strings 'UTF-8' or 'UTF8' (case-insensitive matching),
173the default encoding of your STDIN, STDOUT, and STDERR, and of
174B<any subsequent file open>, is UTF-8.
175
64c66fb6 176=head2 Unicode and EBCDIC
177
178Perl 5.8.0 also supports Unicode on EBCDIC platforms. There,
179the Unicode support is somewhat more complex to implement since
180additional conversions are needed at every step. Some problems
dc4af4bb 181remain, see L<perlebcdic> for details.
64c66fb6 182
183In any case, the Unicode support on EBCDIC platforms is better than
184in the 5.6 series, which didn't work much at all for EBCDIC platform.
185On EBCDIC platforms, the internal Unicode encoding form is UTF-EBCDIC
186instead of UTF-8 (the difference is that as UTF-8 is "ASCII-safe" in
187that ASCII characters encode to UTF-8 as-is, UTF-EBCDIC is
188"EBCDIC-safe").
ba62762e 189
190=head2 Creating Unicode
191
a5f0baef 192To create Unicode characters in literals for code points above 0xFF,
193use the C<\x{...}> notation in doublequoted strings:
ba62762e 194
195 my $smiley = "\x{263a}";
196
8baee566 197Similarly in regular expression literals
ba62762e 198
199 $smiley =~ /\x{263a}/;
200
201At run-time you can use C<chr()>:
202
203 my $hebrew_alef = chr(0x05d0);
204
205(See L</"Further Resources"> for how to find all these numeric codes.)
206
207Naturally, C<ord()> will do the reverse: turn a character to a code point.
208
a5f0baef 209Note that C<\x..> (no C<{}> and only two hexadecimal digits),
210C<\x{...}>, and C<chr(...)> for arguments less than 0x100 (decimal
211256) generate an eight-bit character for backward compatibility with
212older Perls. For arguments of 0x100 or more, Unicode characters are
213always produced. If you want to force the production of Unicode
214characters regardless of the numeric value, use C<pack("U", ...)>
215instead of C<\x..>, C<\x{...}>, or C<chr()>.
ba62762e 216
217You can also use the C<charnames> pragma to invoke characters
218by name in doublequoted strings:
219
220 use charnames ':full';
221 my $arabic_alef = "\N{ARABIC LETTER ALEF}";
222
223And, as mentioned above, you can also C<pack()> numbers into Unicode
224characters:
225
226 my $georgian_an = pack("U", 0x10a0);
227
8a5e5dd5 228Note that both C<\x{...}> and C<\N{...}> are compile-time string
229constants: you cannot use variables in them. if you want similar
230run-time functionality, use C<chr()> and C<charnames::vianame()>.
231
1eda90df 232Also note that if all the code points for pack "U" are below 0x100,
233bytes will be generated, just like if you were using C<chr()>.
234
235 my $bytes = pack("U*", 0x80, 0xFF);
236
237If you want to force the result to Unicode characters, use the special
238C<"U0"> prefix. It consumes no arguments but forces the result to be
239in Unicode characters, instead of bytes.
240
241 my $chars = pack("U0U*", 0x80, 0xFF);
242
ba62762e 243=head2 Handling Unicode
244
245Handling Unicode is for the most part transparent: just use the
246strings as usual. Functions like C<index()>, C<length()>, and
247C<substr()> will work on the Unicode characters; regular expressions
248will work on the Unicode characters (see L<perlunicode> and L<perlretut>).
249
250Note that Perl does B<not> consider combining character sequences
251to be characters, such for example
252
253 use charnames ':full';
254 print length("\N{LATIN CAPITAL LETTER A}\N{COMBINING ACUTE ACCENT}"), "\n";
255
256will print 2, not 1. The only exception is that regular expressions
257have C<\X> for matching a combining character sequence.
258
259When life is not quite so transparent is working with legacy
260encodings, and I/O, and certain special cases.
261
262=head2 Legacy Encodings
263
264When you combine legacy data and Unicode the legacy data needs
265to be upgraded to Unicode. Normally ISO 8859-1 (or EBCDIC, if
266applicable) is assumed. You can override this assumption by
267using the C<encoding> pragma, for example
268
269 use encoding 'latin2'; # ISO 8859-2
270
271in which case literals (string or regular expression) and chr/ord
272in your whole script are assumed to produce Unicode characters from
273ISO 8859-2 code points. Note that the matching for the encoding
274names is forgiving: instead of C<latin2> you could have said
275C<Latin 2>, or C<iso8859-2>, and so forth. With just
276
277 use encoding;
278
279first the environment variable C<PERL_ENCODING> will be consulted,
280and if that doesn't exist, ISO 8859-1 (Latin 1) will be assumed.
281
282The C<Encode> module knows about many encodings and it has interfaces
283for doing conversions between those encodings:
284
285 use Encode 'from_to';
286 from_to($data, "iso-8859-3", "utf-8"); # from legacy to utf-8
287
288=head2 Unicode I/O
289
8baee566 290Normally, writing out Unicode data
ba62762e 291
8baee566 292 print FH $some_string_with_unicode, "\n";
ba62762e 293
8baee566 294produces raw bytes that Perl happens to use to internally encode the
a5f0baef 295Unicode string (which depends on the system, as well as what
296characters happen to be in the string at the time). If any of the
7ca610e8 297characters are at code points 0x100 or above, you will get a warning.
298To ensure that the output is explicitly rendered in the encoding you
299desire (and to avoid the warning), open the stream with the desired
300encoding. Some examples:
ba62762e 301
8baee566 302 open FH, ">:ucs2", "file"
303 open FH, ">:utf8", "file";
304 open FH, ">:Shift-JIS", "file";
1d7919c5 305
306and on already open streams use C<binmode()>:
307
8baee566 308 binmode(STDOUT, ":ucs2");
1d7919c5 309 binmode(STDOUT, ":utf8");
8baee566 310 binmode(STDOUT, ":Shift-JIS");
1d7919c5 311
8baee566 312See documentation for the C<Encode> module for many supported encodings.
ba62762e 313
a5f0baef 314Reading in a file that you know happens to be encoded in one of the
315Unicode encodings does not magically turn the data into Unicode in
316Perl's eyes. To do that, specify the appropriate discipline when
317opening files
ba62762e 318
319 open(my $fh,'<:utf8', 'anything');
8baee566 320 my $line_of_unicode = <$fh>;
321
322 open(my $fh,'<:Big5', 'anything');
323 my $line_of_unicode = <$fh>;
ba62762e 324
325The I/O disciplines can also be specified more flexibly with
326the C<open> pragma; see L<open>:
327
1d7919c5 328 use open ':utf8'; # input and output default discipline will be UTF-8
329 open X, ">file";
330 print X chr(0x100), "\n";
ba62762e 331 close X;
1d7919c5 332 open Y, "<file";
ba62762e 333 printf "%#x\n", ord(<Y>); # this should print 0x100
334 close Y;
335
336With the C<open> pragma you can use the C<:locale> discipline
337
1ecefa54 338 $ENV{LC_ALL} = $ENV{LANG} = 'ru_RU.KOI8-R';
339 # the :locale will probe the locale environment variables like LC_ALL
ba62762e 340 use open OUT => ':locale'; # russki parusski
341 open(O, ">koi8");
342 print O chr(0x430); # Unicode CYRILLIC SMALL LETTER A = KOI8-R 0xc1
343 close O;
344 open(I, "<koi8");
345 printf "%#x\n", ord(<I>), "\n"; # this should print 0xc1
346 close I;
347
348or you can also use the C<':encoding(...)'> discipline
349
350 open(my $epic,'<:encoding(iso-8859-7)','iliad.greek');
8baee566 351 my $line_of_unicode = <$epic>;
ba62762e 352
8baee566 353These methods install a transparent filter on the I/O stream that
354converts data from the specified encoding when it is read in from the
a5f0baef 355stream. The result is always Unicode.
ba62762e 356
357The L<open> pragma affects all the C<open()> calls after the pragma by
358setting default disciplines. If you want to affect only certain
359streams, use explicit disciplines directly in the C<open()> call.
360
361You can switch encodings on an already opened stream by using
8baee566 362C<binmode()>; see L<perlfunc/binmode>.
ba62762e 363
1ecefa54 364The C<:locale> does not currently (as of Perl 5.8.0) work with
365C<open()> and C<binmode()>, only with the C<open> pragma. The
8baee566 366C<:utf8> and C<:encoding(...)> methods do work with all of C<open()>,
1ecefa54 367C<binmode()>, and the C<open> pragma.
ba62762e 368
8baee566 369Similarly, you may use these I/O disciplines on output streams to
a5f0baef 370automatically convert Unicode to the specified encoding when it is
371written to the stream. For example, the following snippet copies the
372contents of the file "text.jis" (encoded as ISO-2022-JP, aka JIS) to
373the file "text.utf8", encoded as UTF-8:
ba62762e 374
8baee566 375 open(my $nihongo, '<:encoding(iso2022-jp)', 'text.jis');
376 open(my $unicode, '>:utf8', 'text.utf8');
377 while (<$nihongo>) { print $unicode }
ba62762e 378
379The naming of encodings, both by the C<open()> and by the C<open>
380pragma, is similarly understanding as with the C<encoding> pragma:
381C<koi8-r> and C<KOI8R> will both be understood.
382
383Common encodings recognized by ISO, MIME, IANA, and various other
8baee566 384standardisation organisations are recognised; for a more detailed
ba62762e 385list see L<Encode>.
386
387C<read()> reads characters and returns the number of characters.
388C<seek()> and C<tell()> operate on byte counts, as do C<sysread()>
389and C<sysseek()>.
390
8baee566 391Notice that because of the default behaviour of not doing any
392conversion upon input if there is no default discipline,
ba62762e 393it is easy to mistakenly write code that keeps on expanding a file
8baee566 394by repeatedly encoding:
ba62762e 395
396 # BAD CODE WARNING
397 open F, "file";
8baee566 398 local $/; ## read in the whole file of 8-bit characters
ba62762e 399 $t = <F>;
400 close F;
401 open F, ">:utf8", "file";
8baee566 402 print F $t; ## convert to UTF-8 on output
ba62762e 403 close F;
404
405If you run this code twice, the contents of the F<file> will be twice
1d7919c5 406UTF-8 encoded. A C<use open ':utf8'> would have avoided the bug, or
407explicitly opening also the F<file> for input as UTF-8.
ba62762e 408
0c901d84 409B<NOTE>: the C<:utf8> and C<:encoding> features work only if your
410Perl has been built with the new "perlio" feature. Almost all
411Perl 5.8 platforms do use "perlio", though: you can see whether
412yours is by running "perl -V" and looking for C<useperlio=define>.
413
1ecefa54 414=head2 Displaying Unicode As Text
415
416Sometimes you might want to display Perl scalars containing Unicode as
8baee566 417simple ASCII (or EBCDIC) text. The following subroutine converts
1ecefa54 418its argument so that Unicode characters with code points greater than
419255 are displayed as "\x{...}", control characters (like "\n") are
8baee566 420displayed as "\x..", and the rest of the characters as themselves:
1ecefa54 421
58c274a1 422 sub nice_string {
423 join("",
424 map { $_ > 255 ? # if wide character...
8baee566 425 sprintf("\\x{%04X}", $_) : # \x{...}
58c274a1 426 chr($_) =~ /[[:cntrl:]]/ ? # else if control character ...
8baee566 427 sprintf("\\x%02X", $_) : # \x..
58c274a1 428 chr($_) # else as themselves
429 } unpack("U*", $_[0])); # unpack Unicode characters
430 }
431
432For example,
433
434 nice_string("foo\x{100}bar\n")
435
8baee566 436returns:
58c274a1 437
8baee566 438 "foo\x{0100}bar\x0A"
1ecefa54 439
ba62762e 440=head2 Special Cases
441
442=over 4
443
444=item *
445
446Bit Complement Operator ~ And vec()
447
1d9bf7bb 448The bit complement operator C<~> may produce surprising results if used on
449strings containing characters with ordinal values above 255. In such a
450case, the results are consistent with the internal encoding of the
451characters, but not with much else. So don't do that. Similarly for vec():
452you will be operating on the internally encoded bit patterns of the Unicode
453characters, not on the code point values, which is very probably not what
454you want.
ba62762e 455
456=item *
457
8baee566 458Peeking At Perl's Internal Encoding
459
460Normal users of Perl should never care how Perl encodes any particular
a5f0baef 461Unicode string (because the normal ways to get at the contents of a
462string with Unicode -- via input and output -- should always be via
463explicitly-defined I/O disciplines). But if you must, there are two
464ways of looking behind the scenes.
ba62762e 465
466One way of peeking inside the internal encoding of Unicode characters
467is to use C<unpack("C*", ...> to get the bytes, or C<unpack("H*", ...)>
468to display the bytes:
469
8baee566 470 # this prints c4 80 for the UTF-8 bytes 0xc4 0x80
ba62762e 471 print join(" ", unpack("H*", pack("U", 0x100))), "\n";
472
473Yet another way would be to use the Devel::Peek module:
474
475 perl -MDevel::Peek -e 'Dump(chr(0x100))'
476
8baee566 477That shows the UTF8 flag in FLAGS and both the UTF-8 bytes
ba62762e 478and Unicode characters in PV. See also later in this document
479the discussion about the C<is_utf8> function of the C<Encode> module.
480
481=back
482
483=head2 Advanced Topics
484
485=over 4
486
487=item *
488
489String Equivalence
490
491The question of string equivalence turns somewhat complicated
492in Unicode: what do you mean by equal?
493
07698885 494(Is C<LATIN CAPITAL LETTER A WITH ACUTE> equal to
495C<LATIN CAPITAL LETTER A>?)
ba62762e 496
a5f0baef 497The short answer is that by default Perl compares equivalence (C<eq>,
498C<ne>) based only on code points of the characters. In the above
499case, the answer is no (because 0x00C1 != 0x0041). But sometimes any
ba62762e 500CAPITAL LETTER As being considered equal, or even any As of any case,
501would be desirable.
502
503The long answer is that you need to consider character normalization
504and casing issues: see L<Unicode::Normalize>, and Unicode Technical
505Reports #15 and #21, I<Unicode Normalization Forms> and I<Case
506Mappings>, http://www.unicode.org/unicode/reports/tr15/
507http://www.unicode.org/unicode/reports/tr21/
508
58c274a1 509As of Perl 5.8.0, regular expression case-ignoring matching
ba62762e 510implements only 1:1 semantics: one character matches one character.
511In I<Case Mappings> both 1:N and N:1 matches are defined.
512
513=item *
514
515String Collation
516
517People like to see their strings nicely sorted, or as Unicode
518parlance goes, collated. But again, what do you mean by collate?
519
07698885 520(Does C<LATIN CAPITAL LETTER A WITH ACUTE> come before or after
521C<LATIN CAPITAL LETTER A WITH GRAVE>?)
ba62762e 522
58c274a1 523The short answer is that by default, Perl compares strings (C<lt>,
ba62762e 524C<le>, C<cmp>, C<ge>, C<gt>) based only on the code points of the
58c274a1 525characters. In the above case, the answer is "after", since 0x00C1 > 0x00C0.
ba62762e 526
527The long answer is that "it depends", and a good answer cannot be
528given without knowing (at the very least) the language context.
529See L<Unicode::Collate>, and I<Unicode Collation Algorithm>
530http://www.unicode.org/unicode/reports/tr10/
531
532=back
533
534=head2 Miscellaneous
535
536=over 4
537
538=item *
539
3ff56b75 540Character Ranges and Classes
ba62762e 541
542Character ranges in regular expression character classes (C</[a-z]/>)
543and in the C<tr///> (also known as C<y///>) operator are not magically
58c274a1 544Unicode-aware. What this means that C<[A-Za-z]> will not magically start
ba62762e 545to mean "all alphabetic letters" (not that it does mean that even for
3ff56b75 5468-bit characters, you should be using C</[[:alpha:]]/> for that).
ba62762e 547
a5f0baef 548For specifying things like that in regular expressions, you can use
549the various Unicode properties, C<\pL> or perhaps C<\p{Alphabetic}>,
550in this particular case. You can use Unicode code points as the end
551points of character ranges, but that means that particular code point
3ff56b75 552range, nothing more. For further information (there are dozens
553of Unicode character classes), see L<perlunicode>.
ba62762e 554
555=item *
556
557String-To-Number Conversions
558
559Unicode does define several other decimal (and numeric) characters
560than just the familiar 0 to 9, such as the Arabic and Indic digits.
561Perl does not support string-to-number conversion for digits other
58c274a1 562than ASCII 0 to 9 (and ASCII a to f for hexadecimal).
ba62762e 563
564=back
565
566=head2 Questions With Answers
567
568=over 4
569
5cb3728c 570=item
571
572Will My Old Scripts Break?
ba62762e 573
574Very probably not. Unless you are generating Unicode characters
575somehow, any old behaviour should be preserved. About the only
576behaviour that has changed and which could start generating Unicode
577is the old behaviour of C<chr()> where supplying an argument more
578than 255 produced a character modulo 255 (for example, C<chr(300)>
579was equal to C<chr(45)>).
580
5cb3728c 581=item
582
583How Do I Make My Scripts Work With Unicode?
ba62762e 584
585Very little work should be needed since nothing changes until you
586somehow generate Unicode data. The greatest trick will be getting
587input as Unicode, and for that see the earlier I/O discussion.
588
5cb3728c 589=item
590
591How Do I Know Whether My String Is In Unicode?
ba62762e 592
593You shouldn't care. No, you really shouldn't. If you have
594to care (beyond the cases described above), it means that we
595didn't get the transparency of Unicode quite right.
596
597Okay, if you insist:
598
599 use Encode 'is_utf8';
600 print is_utf8($string) ? 1 : 0, "\n";
601
602But note that this doesn't mean that any of the characters in the
603string are necessary UTF-8 encoded, or that any of the characters have
604code points greater than 0xFF (255) or even 0x80 (128), or that the
605string has any characters at all. All the C<is_utf8()> does is to
606return the value of the internal "utf8ness" flag attached to the
3c1c8017 607$string. If the flag is off, the bytes in the scalar are interpreted
608as a single byte encoding. If the flag is on, the bytes in the scalar
609are interpreted as the (multibyte, variable-length) UTF-8 encoded code
610points of the characters. Bytes added to an UTF-8 encoded string are
611automatically upgraded to UTF-8. If mixed non-UTF8 and UTF-8 scalars
612are merged (doublequoted interpolation, explicit concatenation, and
613printf/sprintf parameter substitution), the result will be UTF-8 encoded
614as if copies of the byte strings were upgraded to UTF-8: for example,
615
616 $a = "ab\x80c";
617 $b = "\x{100}";
618 print "$a = $b\n";
619
620the output string will be UTF-8-encoded "ab\x80c\x{100}\n", but note
621that C<$a> will stay single byte encoded.
ba62762e 622
623Sometimes you might really need to know the byte length of a string
624instead of the character length. For that use the C<bytes> pragma
625and its only defined function C<length()>:
626
627 my $unicode = chr(0x100);
628 print length($unicode), "\n"; # will print 1
629 use bytes;
630 print length($unicode), "\n"; # will print 2 (the 0xC4 0x80 of the UTF-8)
631
5cb3728c 632=item
633
634How Do I Detect Data That's Not Valid In a Particular Encoding?
ba62762e 635
8baee566 636Use the C<Encode> package to try converting it.
637For example,
ba62762e 638
639 use Encode 'encode_utf8';
8baee566 640 if (encode_utf8($string_of_bytes_that_I_think_is_utf8)) {
ba62762e 641 # valid
642 } else {
643 # invalid
644 }
645
8baee566 646For UTF-8 only, you can use:
ba62762e 647
648 use warnings;
8baee566 649 @chars = unpack("U0U*", $string_of_bytes_that_I_think_is_utf8);
ba62762e 650
8baee566 651If invalid, a C<Malformed UTF-8 character (byte 0x##) in
652unpack> is produced. The "U0" means "expect strictly UTF-8
1eda90df 653encoded Unicode". Without that the C<unpack("U*", ...)>
654would accept also data like C<chr(0xFF>), similarly to the
655C<pack> as we saw earlier.
ba62762e 656
5cb3728c 657=item
658
659How Do I Convert Binary Data Into a Particular Encoding, Or Vice Versa?
ba62762e 660
8baee566 661This probably isn't as useful as you might think.
662Normally, you shouldn't need to.
ba62762e 663
a5f0baef 664In one sense, what you are asking doesn't make much sense: Encodings
665are for characters, and binary data is not "characters", so converting
666"data" into some encoding isn't meaningful unless you know in what
667character set and encoding the binary data is in, in which case it's
668not binary data, now is it?
8baee566 669
670If you have a raw sequence of bytes that you know should be interpreted via
671a particular encoding, you can use C<Encode>:
ba62762e 672
673 use Encode 'from_to';
674 from_to($data, "iso-8859-1", "utf-8"); # from latin-1 to utf-8
675
8baee566 676The call to from_to() changes the bytes in $data, but nothing material
677about the nature of the string has changed as far as Perl is concerned.
678Both before and after the call, the string $data contains just a bunch of
6798-bit bytes. As far as Perl is concerned, the encoding of the string (as
680Perl sees it) remains as "system-native 8-bit bytes".
681
682You might relate this to a fictional 'Translate' module:
683
684 use Translate;
685 my $phrase = "Yes";
686 Translate::from_to($phrase, 'english', 'deutsch');
687 ## phrase now contains "Ja"
ba62762e 688
8baee566 689The contents of the string changes, but not the nature of the string.
690Perl doesn't know any more after the call than before that the contents
691of the string indicates the affirmative.
ba62762e 692
a5f0baef 693Back to converting data, if you have (or want) data in your system's
694native 8-bit encoding (e.g. Latin-1, EBCDIC, etc.), you can use
695pack/unpack to convert to/from Unicode.
ba62762e 696
8baee566 697 $native_string = pack("C*", unpack("U*", $Unicode_string));
698 $Unicode_string = pack("U*", unpack("C*", $native_string));
ba62762e 699
700If you have a sequence of bytes you B<know> is valid UTF-8,
701but Perl doesn't know it yet, you can make Perl a believer, too:
702
703 use Encode 'decode_utf8';
8baee566 704 $Unicode = decode_utf8($bytes);
ba62762e 705
706You can convert well-formed UTF-8 to a sequence of bytes, but if
707you just want to convert random binary data into UTF-8, you can't.
708Any random collection of bytes isn't well-formed UTF-8. You can
709use C<unpack("C*", $string)> for the former, and you can create
8baee566 710well-formed Unicode data by C<pack("U*", 0xff, ...)>.
ba62762e 711
5cb3728c 712=item
713
714How Do I Display Unicode? How Do I Input Unicode?
ba62762e 715
716See http://www.hclrss.demon.co.uk/unicode/ and
717http://www.cl.cam.ac.uk/~mgk25/unicode.html
718
5cb3728c 719=item
720
721How Does Unicode Work With Traditional Locales?
ba62762e 722
723In Perl, not very well. Avoid using locales through the C<locale>
724pragma. Use only one or the other.
725
726=back
727
728=head2 Hexadecimal Notation
729
730The Unicode standard prefers using hexadecimal notation because that
731shows better the division of Unicode into blocks of 256 characters.
732Hexadecimal is also simply shorter than decimal. You can use decimal
733notation, too, but learning to use hexadecimal just makes life easier
734with the Unicode standard.
735
736The C<0x> prefix means a hexadecimal number, the digits are 0-9 I<and>
737a-f (or A-F, case doesn't matter). Each hexadecimal digit represents
738four bits, or half a byte. C<print 0x..., "\n"> will show a
739hexadecimal number in decimal, and C<printf "%x\n", $decimal> will
740show a decimal number in hexadecimal. If you have just the
a5f0baef 741"hexdigits" of a hexadecimal number, you can use the C<hex()> function.
ba62762e 742
743 print 0x0009, "\n"; # 9
744 print 0x000a, "\n"; # 10
745 print 0x000f, "\n"; # 15
746 print 0x0010, "\n"; # 16
747 print 0x0011, "\n"; # 17
748 print 0x0100, "\n"; # 256
749
750 print 0x0041, "\n"; # 65
751
752 printf "%x\n", 65; # 41
753 printf "%#x\n", 65; # 0x41
754
755 print hex("41"), "\n"; # 65
756
757=head2 Further Resources
758
759=over 4
760
761=item *
762
763Unicode Consortium
764
765 http://www.unicode.org/
766
767=item *
768
769Unicode FAQ
770
771 http://www.unicode.org/unicode/faq/
772
773=item *
774
775Unicode Glossary
776
777 http://www.unicode.org/glossary/
778
779=item *
780
781Unicode Useful Resources
782
783 http://www.unicode.org/unicode/onlinedat/resources.html
784
785=item *
786
787Unicode and Multilingual Support in HTML, Fonts, Web Browsers and Other Applications
788
789 http://www.hclrss.demon.co.uk/unicode/
790
791=item *
792
793UTF-8 and Unicode FAQ for Unix/Linux
794
795 http://www.cl.cam.ac.uk/~mgk25/unicode.html
796
797=item *
798
799Legacy Character Sets
800
801 http://www.czyborra.com/
802 http://www.eki.ee/letter/
803
804=item *
805
806The Unicode support files live within the Perl installation in the
807directory
808
809 $Config{installprivlib}/unicore
810
811in Perl 5.8.0 or newer, and
812
813 $Config{installprivlib}/unicode
814
815in the Perl 5.6 series. (The renaming to F<lib/unicore> was done to
816avoid naming conflicts with lib/Unicode in case-insensitive filesystems.)
551b6b6f 817The main Unicode data file is F<UnicodeData.txt> (or F<Unicode.301> in
ba62762e 818Perl 5.6.1.) You can find the C<$Config{installprivlib}> by
819
820 perl "-V:installprivlib"
821
822Note that some of the files have been renamed from the Unicode
823standard since the Perl installation tries to live by the "8.3"
824filenaming restrictions. The renamings are shown in the
825accompanying F<rename> file.
826
827You can explore various information from the Unicode data files using
828the C<Unicode::UCD> module.
829
830=back
831
f6edf83b 832=head1 UNICODE IN OLDER PERLS
833
834If you cannot upgrade your Perl to 5.8.0 or later, you can still
835do some Unicode processing by using the modules C<Unicode::String>,
836C<Unicode::Map8>, and C<Unicode::Map>, available from CPAN.
837If you have the GNU recode installed, you can also use the
838Perl frontend C<Convert::Recode> for character conversions.
839
aaef10c5 840The following are fast conversions from ISO 8859-1 (Latin-1) bytes
841to UTF-8 bytes, the code works even with older Perl 5 versions.
842
843 # ISO 8859-1 to UTF-8
844 s/([\x80-\xFF])/chr(0xC0|ord($1)>>6).chr(0x80|ord($1)&0x3F)/eg;
845
846 # UTF-8 to ISO 8859-1
847 s/([\xC2\xC3])([\x80-\xBF])/chr(ord($1)<<6&0xC0|ord($2)&0x3F)/eg;
848
ba62762e 849=head1 SEE ALSO
850
851L<perlunicode>, L<Encode>, L<encoding>, L<open>, L<utf8>, L<bytes>,
852L<perlretut>, L<Unicode::Collate>, L<Unicode::Normalize>, L<Unicode::UCD>
853
854=head1 ACKNOWLEDGEMENTS
855
856Thanks to the kind readers of the perl5-porters@perl.org,
857perl-unicode@perl.org, linux-utf8@nl.linux.org, and unicore@unicode.org
858mailing lists for their valuable feedback.
859
860=head1 AUTHOR, COPYRIGHT, AND LICENSE
861
be3c0a43 862Copyright 2001-2002 Jarkko Hietaniemi <jhi@iki.fi>
ba62762e 863
864This document may be distributed under the same terms as Perl itself.