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