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