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