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