This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document the flip of problematic code points handling
[perl5.git] / pod / perlunicode.pod
1 =head1 NAME
2
3 perlunicode - Unicode support in Perl
4
5 =head1 DESCRIPTION
6
7 =head2 Important Caveats
8
9 Unicode support is an extensive requirement. While Perl does not
10 implement the Unicode standard or the accompanying technical reports
11 from cover to cover, Perl does support many Unicode features.
12
13 People who want to learn to use Unicode in Perl, should probably read
14 the L<Perl Unicode tutorial, perlunitut|perlunitut>, before reading
15 this reference document.
16
17 Also, the use of Unicode may present security issues that aren't obvious.
18 Read L<Unicode Security Considerations|http://www.unicode.org/reports/tr36>.
19
20 =over 4
21
22 =item Input and Output Layers
23
24 Perl knows when a filehandle uses Perl's internal Unicode encodings
25 (UTF-8, or UTF-EBCDIC if in EBCDIC) if the filehandle is opened with
26 the ":encoding(utf8)" layer.  Other encodings can be converted to Perl's
27 encoding on input or from Perl's encoding on output by use of the
28 ":encoding(...)"  layer.  See L<open>.
29
30 To indicate that Perl source itself is in UTF-8, use C<use utf8;>.
31
32 =item Regular Expressions
33
34 The regular expression compiler produces polymorphic opcodes.  That is,
35 the pattern adapts to the data and automatically switches to the Unicode
36 character scheme when presented with data that is internally encoded in
37 UTF-8, or instead uses a traditional byte scheme when presented with
38 byte data.
39
40 =item C<use utf8> still needed to enable UTF-8/UTF-EBCDIC in scripts
41
42 As a compatibility measure, the C<use utf8> pragma must be explicitly
43 included to enable recognition of UTF-8 in the Perl scripts themselves
44 (in string or regular expression literals, or in identifier names) on
45 ASCII-based machines or to recognize UTF-EBCDIC on EBCDIC-based
46 machines.  B<These are the only times when an explicit C<use utf8>
47 is needed.>  See L<utf8>.
48
49 =item BOM-marked scripts and UTF-16 scripts autodetected
50
51 If a Perl script begins marked with the Unicode BOM (UTF-16LE, UTF16-BE,
52 or UTF-8), or if the script looks like non-BOM-marked UTF-16 of either
53 endianness, Perl will correctly read in the script as Unicode.
54 (BOMless UTF-8 cannot be effectively recognized or differentiated from
55 ISO 8859-1 or other eight-bit encodings.)
56
57 =item C<use encoding> needed to upgrade non-Latin-1 byte strings
58
59 By default, there is a fundamental asymmetry in Perl's Unicode model:
60 implicit upgrading from byte strings to Unicode strings assumes that
61 they were encoded in I<ISO 8859-1 (Latin-1)>, but Unicode strings are
62 downgraded with UTF-8 encoding.  This happens because the first 256
63 codepoints in Unicode happens to agree with Latin-1.
64
65 See L</"Byte and Character Semantics"> for more details.
66
67 =back
68
69 =head2 Byte and Character Semantics
70
71 Beginning with version 5.6, Perl uses logically-wide characters to
72 represent strings internally.
73
74 In future, Perl-level operations will be expected to work with
75 characters rather than bytes.
76
77 However, as an interim compatibility measure, Perl aims to
78 provide a safe migration path from byte semantics to character
79 semantics for programs.  For operations where Perl can unambiguously
80 decide that the input data are characters, Perl switches to
81 character semantics.  For operations where this determination cannot
82 be made without additional information from the user, Perl decides in
83 favor of compatibility and chooses to use byte semantics.
84
85 Under byte semantics, when C<use locale> is in effect, Perl uses the
86 semantics associated with the current locale.  Absent a C<use locale>, and
87 absent a C<use feature 'unicode_strings'> pragma, Perl currently uses US-ASCII
88 (or Basic Latin in Unicode terminology) byte semantics, meaning that characters
89 whose ordinal numbers are in the range 128 - 255 are undefined except for their
90 ordinal numbers.  This means that none have case (upper and lower), nor are any
91 a member of character classes, like C<[:alpha:]> or C<\w>.  (But all do belong
92 to the C<\W> class or the Perl regular expression extension C<[:^alpha:]>.)
93
94 This behavior preserves compatibility with earlier versions of Perl,
95 which allowed byte semantics in Perl operations only if
96 none of the program's inputs were marked as being a source of Unicode
97 character data.  Such data may come from filehandles, from calls to
98 external programs, from information provided by the system (such as %ENV),
99 or from literals and constants in the source text.
100
101 The C<bytes> pragma will always, regardless of platform, force byte
102 semantics in a particular lexical scope.  See L<bytes>.
103
104 The C<use feature 'unicode_strings'> pragma is intended always,
105 regardless of platform, to force character (Unicode) semantics in a
106 particular lexical scope.
107 See L</The "Unicode Bug"> below.
108
109 The C<utf8> pragma is primarily a compatibility device that enables
110 recognition of UTF-(8|EBCDIC) in literals encountered by the parser.
111 Note that this pragma is only required while Perl defaults to byte
112 semantics; when character semantics become the default, this pragma
113 may become a no-op.  See L<utf8>.
114
115 Unless explicitly stated, Perl operators use character semantics
116 for Unicode data and byte semantics for non-Unicode data.
117 The decision to use character semantics is made transparently.  If
118 input data comes from a Unicode source--for example, if a character
119 encoding layer is added to a filehandle or a literal Unicode
120 string constant appears in a program--character semantics apply.
121 Otherwise, byte semantics are in effect.  The C<bytes> pragma should
122 be used to force byte semantics on Unicode data, and the C<use feature
123 'unicode_strings'> pragma to force Unicode semantics on byte data (though in
124 5.12 it isn't fully implemented).
125
126 If strings operating under byte semantics and strings with Unicode
127 character data are concatenated, the new string will have
128 character semantics.  This can cause surprises: See L</BUGS>, below.
129 You can choose to be warned when this happens.  See L<encoding::warnings>.
130
131 Under character semantics, many operations that formerly operated on
132 bytes now operate on characters. A character in Perl is
133 logically just a number ranging from 0 to 2**31 or so. Larger
134 characters may encode into longer sequences of bytes internally, but
135 this internal detail is mostly hidden for Perl code.
136 See L<perluniintro> for more.
137
138 =head2 Effects of Character Semantics
139
140 Character semantics have the following effects:
141
142 =over 4
143
144 =item *
145
146 Strings--including hash keys--and regular expression patterns may
147 contain characters that have an ordinal value larger than 255.
148
149 If you use a Unicode editor to edit your program, Unicode characters may
150 occur directly within the literal strings in UTF-8 encoding, or UTF-16.
151 (The former requires a BOM or C<use utf8>, the latter requires a BOM.)
152
153 Unicode characters can also be added to a string by using the C<\N{U+...}>
154 notation.  The Unicode code for the desired character, in hexadecimal,
155 should be placed in the braces, after the C<U>. For instance, a smiley face is
156 C<\N{U+263A}>.
157
158 Alternatively, you can use the C<\x{...}> notation for characters 0x100 and
159 above.  For characters below 0x100 you may get byte semantics instead of
160 character semantics;  see L</The "Unicode Bug">.  On EBCDIC machines there is
161 the additional problem that the value for such characters gives the EBCDIC
162 character rather than the Unicode one.
163
164 Additionally, if you
165
166    use charnames ':full';
167
168 you can use the C<\N{...}> notation and put the official Unicode
169 character name within the braces, such as C<\N{WHITE SMILING FACE}>.
170 See L<charnames>.
171
172 =item *
173
174 If an appropriate L<encoding> is specified, identifiers within the
175 Perl script may contain Unicode alphanumeric characters, including
176 ideographs.  Perl does not currently attempt to canonicalize variable
177 names.
178
179 =item *
180
181 Regular expressions match characters instead of bytes.  "." matches
182 a character instead of a byte.
183
184 =item *
185
186 Bracketed character classes in regular expressions match characters instead of
187 bytes and match against the character properties specified in the
188 Unicode properties database.  C<\w> can be used to match a Japanese
189 ideograph, for instance.
190
191 =item *
192
193 Named Unicode properties, scripts, and block ranges may be used (like bracketed
194 character classes) by using the C<\p{}> "matches property" construct and
195 the C<\P{}> negation, "doesn't match property".
196 See L</"Unicode Character Properties"> for more details.
197
198 You can define your own character properties and use them
199 in the regular expression with the C<\p{}> or C<\P{}> construct.
200 See L</"User-Defined Character Properties"> for more details.
201
202 =item *
203
204 The special pattern C<\X> matches a logical character, an "extended grapheme
205 cluster" in Standardese.  In Unicode what appears to the user to be a single
206 character, for example an accented C<G>, may in fact be composed of a sequence
207 of characters, in this case a C<G> followed by an accent character.  C<\X>
208 will match the entire sequence.
209
210 =item *
211
212 The C<tr///> operator translates characters instead of bytes.  Note
213 that the C<tr///CU> functionality has been removed.  For similar
214 functionality see pack('U0', ...) and pack('C0', ...).
215
216 =item *
217
218 Case translation operators use the Unicode case translation tables
219 when character input is provided.  Note that C<uc()>, or C<\U> in
220 interpolated strings, translates to uppercase, while C<ucfirst>,
221 or C<\u> in interpolated strings, translates to titlecase in languages
222 that make the distinction (which is equivalent to uppercase in languages
223 without the distinction).
224
225 =item *
226
227 Most operators that deal with positions or lengths in a string will
228 automatically switch to using character positions, including
229 C<chop()>, C<chomp()>, C<substr()>, C<pos()>, C<index()>, C<rindex()>,
230 C<sprintf()>, C<write()>, and C<length()>.  An operator that
231 specifically does not switch is C<vec()>.  Operators that really don't
232 care include operators that treat strings as a bucket of bits such as
233 C<sort()>, and operators dealing with filenames.
234
235 =item *
236
237 The C<pack()>/C<unpack()> letter C<C> does I<not> change, since it is often
238 used for byte-oriented formats.  Again, think C<char> in the C language.
239
240 There is a new C<U> specifier that converts between Unicode characters
241 and code points. There is also a C<W> specifier that is the equivalent of
242 C<chr>/C<ord> and properly handles character values even if they are above 255.
243
244 =item *
245
246 The C<chr()> and C<ord()> functions work on characters, similar to
247 C<pack("W")> and C<unpack("W")>, I<not> C<pack("C")> and
248 C<unpack("C")>.  C<pack("C")> and C<unpack("C")> are methods for
249 emulating byte-oriented C<chr()> and C<ord()> on Unicode strings.
250 While these methods reveal the internal encoding of Unicode strings,
251 that is not something one normally needs to care about at all.
252
253 =item *
254
255 The bit string operators, C<& | ^ ~>, can operate on character data.
256 However, for backward compatibility, such as when using bit string
257 operations when characters are all less than 256 in ordinal value, one
258 should not use C<~> (the bit complement) with characters of both
259 values less than 256 and values greater than 256.  Most importantly,
260 DeMorgan's laws (C<~($x|$y) eq ~$x&~$y> and C<~($x&$y) eq ~$x|~$y>)
261 will not hold.  The reason for this mathematical I<faux pas> is that
262 the complement cannot return B<both> the 8-bit (byte-wide) bit
263 complement B<and> the full character-wide bit complement.
264
265 =item *
266
267 You can define your own mappings to be used in C<lc()>,
268 C<lcfirst()>, C<uc()>, and C<ucfirst()> (or their double-quoted string inlined
269 versions such as C<\U>). See
270 L<User-Defined Case-Mappings|/"User-Defined Case Mappings (for serious hackers only)">
271 for more details.
272
273 =back
274
275 =over 4
276
277 =item *
278
279 And finally, C<scalar reverse()> reverses by character rather than by byte.
280
281 =back
282
283 =head2 Unicode Character Properties
284
285 Most Unicode character properties are accessible by using regular expressions.
286 They are used (like bracketed character classes) by using the C<\p{}> "matches
287 property" construct and the C<\P{}> negation, "doesn't match property".
288
289 Note that the only time that Perl considers a sequence of individual code
290 points as a single logical character is in the C<\X> construct, already
291 mentioned above.   Therefore "character" in this discussion means a single
292 Unicode code point.
293
294 For instance, C<\p{Uppercase}> matches any single character with the Unicode
295 "Uppercase" property, while C<\p{L}> matches any character with a
296 General_Category of "L" (letter) property.  Brackets are not
297 required for single letter property names, so C<\p{L}> is equivalent to C<\pL>.
298
299 More formally, C<\p{Uppercase}> matches any single character whose Unicode
300 Uppercase property value is True, and C<\P{Uppercase}> matches any character
301 whose Uppercase property value is False, and they could have been written as
302 C<\p{Uppercase=True}> and C<\p{Uppercase=False}>, respectively.
303
304 This formality is needed when properties are not binary, that is if they can
305 take on more values than just True and False.  For example, the Bidi_Class (see
306 L</"Bidirectional Character Types"> below), can take on a number of different
307 values, such as Left, Right, Whitespace, and others.  To match these, one needs
308 to specify the property name (Bidi_Class), and the value being matched against
309 (Left, Right, etc.).  This is done, as in the examples above, by having the
310 two components separated by an equal sign (or interchangeably, a colon), like
311 C<\p{Bidi_Class: Left}>.
312
313 All Unicode-defined character properties may be written in these compound forms
314 of C<\p{property=value}> or C<\p{property:value}>, but Perl provides some
315 additional properties that are written only in the single form, as well as
316 single-form short-cuts for all binary properties and certain others described
317 below, in which you may omit the property name and the equals or colon
318 separator.
319
320 Most Unicode character properties have at least two synonyms (or aliases if you
321 prefer), a short one that is easier to type, and a longer one which is more
322 descriptive and hence it is easier to understand what it means.  Thus the "L"
323 and "Letter" above are equivalent and can be used interchangeably.  Likewise,
324 "Upper" is a synonym for "Uppercase", and we could have written
325 C<\p{Uppercase}> equivalently as C<\p{Upper}>.  Also, there are typically
326 various synonyms for the values the property can be.   For binary properties,
327 "True" has 3 synonyms: "T", "Yes", and "Y"; and "False has correspondingly "F",
328 "No", and "N".  But be careful.  A short form of a value for one property may
329 not mean the same thing as the same short form for another.  Thus, for the
330 General_Category property, "L" means "Letter", but for the Bidi_Class property,
331 "L" means "Left".  A complete list of properties and synonyms is in
332 L<perluniprops>.
333
334 Upper/lower case differences in the property names and values are irrelevant,
335 thus C<\p{Upper}> means the same thing as C<\p{upper}> or even C<\p{UpPeR}>.
336 Similarly, you can add or subtract underscores anywhere in the middle of a
337 word, so that these are also equivalent to C<\p{U_p_p_e_r}>.  And white space
338 is irrelevant adjacent to non-word characters, such as the braces and the equals
339 or colon separators so C<\p{   Upper  }> and C<\p{ Upper_case : Y }> are
340 equivalent to these as well.  In fact, in most cases, white space and even
341 hyphens can be added or deleted anywhere.  So even C<\p{ Up-per case = Yes}> is
342 equivalent.  All this is called "loose-matching" by Unicode.  The few places
343 where stricter matching is employed is in the middle of numbers, and the Perl
344 extension properties that begin or end with an underscore.  Stricter matching
345 cares about white space (except adjacent to the non-word characters) and
346 hyphens, and non-interior underscores.
347
348 You can also use negation in both C<\p{}> and C<\P{}> by introducing a caret
349 (^) between the first brace and the property name: C<\p{^Tamil}> is
350 equal to C<\P{Tamil}>.
351
352 =head3 B<General_Category>
353
354 Every Unicode character is assigned a general category, which is the "most
355 usual categorization of a character" (from
356 L<http://www.unicode.org/reports/tr44>).
357
358 The compound way of writing these is like C<\p{General_Category=Number}>
359 (short, C<\p{gc:n}>).  But Perl furnishes shortcuts in which everything up
360 through the equal or colon separator is omitted.  So you can instead just write
361 C<\pN>.
362
363 Here are the short and long forms of the General Category properties:
364
365     Short       Long
366
367     L           Letter
368     LC, L&      Cased_Letter (that is: [\p{Ll}\p{Lu}\p{Lt}])
369     Lu          Uppercase_Letter
370     Ll          Lowercase_Letter
371     Lt          Titlecase_Letter
372     Lm          Modifier_Letter
373     Lo          Other_Letter
374
375     M           Mark
376     Mn          Nonspacing_Mark
377     Mc          Spacing_Mark
378     Me          Enclosing_Mark
379
380     N           Number
381     Nd          Decimal_Number (also Digit)
382     Nl          Letter_Number
383     No          Other_Number
384
385     P           Punctuation (also Punct)
386     Pc          Connector_Punctuation
387     Pd          Dash_Punctuation
388     Ps          Open_Punctuation
389     Pe          Close_Punctuation
390     Pi          Initial_Punctuation
391                 (may behave like Ps or Pe depending on usage)
392     Pf          Final_Punctuation
393                 (may behave like Ps or Pe depending on usage)
394     Po          Other_Punctuation
395
396     S           Symbol
397     Sm          Math_Symbol
398     Sc          Currency_Symbol
399     Sk          Modifier_Symbol
400     So          Other_Symbol
401
402     Z           Separator
403     Zs          Space_Separator
404     Zl          Line_Separator
405     Zp          Paragraph_Separator
406
407     C           Other
408     Cc          Control (also Cntrl)
409     Cf          Format
410     Cs          Surrogate
411     Co          Private_Use
412     Cn          Unassigned
413
414 Single-letter properties match all characters in any of the
415 two-letter sub-properties starting with the same letter.
416 C<LC> and C<L&> are special cases, which are both aliases for the set consisting of everything matched by C<Ll>, C<Lu>, and C<Lt>.
417
418 =head3 B<Bidirectional Character Types>
419
420 Because scripts differ in their directionality (Hebrew is
421 written right to left, for example) Unicode supplies these properties in
422 the Bidi_Class class:
423
424     Property    Meaning
425
426     L           Left-to-Right
427     LRE         Left-to-Right Embedding
428     LRO         Left-to-Right Override
429     R           Right-to-Left
430     AL          Arabic Letter
431     RLE         Right-to-Left Embedding
432     RLO         Right-to-Left Override
433     PDF         Pop Directional Format
434     EN          European Number
435     ES          European Separator
436     ET          European Terminator
437     AN          Arabic Number
438     CS          Common Separator
439     NSM         Non-Spacing Mark
440     BN          Boundary Neutral
441     B           Paragraph Separator
442     S           Segment Separator
443     WS          Whitespace
444     ON          Other Neutrals
445
446 This property is always written in the compound form.
447 For example, C<\p{Bidi_Class:R}> matches characters that are normally
448 written right to left.
449
450 =head3 B<Scripts>
451
452 The world's languages are written in a number of scripts.  This sentence
453 (unless you're reading it in translation) is written in Latin, while Russian is
454 written in Cyrillic, and Greek is written in, well, Greek; Japanese mainly in
455 Hiragana or Katakana.  There are many more.
456
457 The Unicode Script property gives what script a given character is in,
458 and the property can be specified with the compound form like
459 C<\p{Script=Hebrew}> (short: C<\p{sc=hebr}>).  Perl furnishes shortcuts for all
460 script names.  You can omit everything up through the equals (or colon), and
461 simply write C<\p{Latin}> or C<\P{Cyrillic}>.
462
463 A complete list of scripts and their shortcuts is in L<perluniprops>.
464
465 =head3 B<Use of "Is" Prefix>
466
467 For backward compatibility (with Perl 5.6), all properties mentioned
468 so far may have C<Is> or C<Is_> prepended to their name, so C<\P{Is_Lu}>, for
469 example, is equal to C<\P{Lu}>, and C<\p{IsScript:Arabic}> is equal to
470 C<\p{Arabic}>.
471
472 =head3 B<Blocks>
473
474 In addition to B<scripts>, Unicode also defines B<blocks> of
475 characters.  The difference between scripts and blocks is that the
476 concept of scripts is closer to natural languages, while the concept
477 of blocks is more of an artificial grouping based on groups of Unicode
478 characters with consecutive ordinal values. For example, the "Basic Latin"
479 block is all characters whose ordinals are between 0 and 127, inclusive, in
480 other words, the ASCII characters.  The "Latin" script contains some letters
481 from this block as well as several more, like "Latin-1 Supplement",
482 "Latin Extended-A", etc., but it does not contain all the characters from
483 those blocks. It does not, for example, contain digits, because digits are
484 shared across many scripts. Digits and similar groups, like punctuation, are in
485 the script called C<Common>.  There is also a script called C<Inherited> for
486 characters that modify other characters, and inherit the script value of the
487 controlling character.
488
489 For more about scripts versus blocks, see UAX#24 "Unicode Script Property":
490 L<http://www.unicode.org/reports/tr24>
491
492 The Script property is likely to be the one you want to use when processing
493 natural language; the Block property may be useful in working with the nuts and
494 bolts of Unicode.
495
496 Block names are matched in the compound form, like C<\p{Block: Arrows}> or
497 C<\p{Blk=Hebrew}>.  Unlike most other properties only a few block names have a
498 Unicode-defined short name.  But Perl does provide a (slight) shortcut:  You
499 can say, for example C<\p{In_Arrows}> or C<\p{In_Hebrew}>.  For backwards
500 compatibility, the C<In> prefix may be omitted if there is no naming conflict
501 with a script or any other property, and you can even use an C<Is> prefix
502 instead in those cases.  But it is not a good idea to do this, for a couple
503 reasons:
504
505 =over 4
506
507 =item 1
508
509 It is confusing.  There are many naming conflicts, and you may forget some.
510 For example, C<\p{Hebrew}> means the I<script> Hebrew, and NOT the I<block>
511 Hebrew.  But would you remember that 6 months from now?
512
513 =item 2
514
515 It is unstable.  A new version of Unicode may pre-empt the current meaning by
516 creating a property with the same name.  There was a time in very early Unicode
517 releases when C<\p{Hebrew}> would have matched the I<block> Hebrew; now it
518 doesn't.
519
520 =back
521
522 Some people just prefer to always use C<\p{Block: foo}> and C<\p{Script: bar}>
523 instead of the shortcuts, for clarity, and because they can't remember the
524 difference between 'In' and 'Is' anyway (or aren't confident that those who
525 eventually will read their code will know).
526
527 A complete list of blocks and their shortcuts is in L<perluniprops>.
528
529 =head3 B<Other Properties>
530
531 There are many more properties than the very basic ones described here.
532 A complete list is in L<perluniprops>.
533
534 Unicode defines all its properties in the compound form, so all single-form
535 properties are Perl extensions.  A number of these are just synonyms for the
536 Unicode ones, but some are genunine extensions, including a couple that are in
537 the compound form.  And quite a few of these are actually recommended by Unicode
538 (in L<http://www.unicode.org/reports/tr18>).
539
540 This section gives some details on all the extensions that aren't synonyms for
541 compound-form Unicode properties (for those, you'll have to refer to the
542 L<Unicode Standard|http://www.unicode.org/reports/tr44>.
543
544 =over
545
546 =item B<C<\p{All}>>
547
548 This matches any of the 1_114_112 Unicode code points.  It is a synonym for
549 C<\p{Any}>.
550
551 =item B<C<\p{Alnum}>>
552
553 This matches any C<\p{Alphabetic}> or C<\p{Decimal_Number}> character.
554
555 =item B<C<\p{Any}>>
556
557 This matches any of the 1_114_112 Unicode code points.  It is a synonym for
558 C<\p{All}>.
559
560 =item B<C<\p{Assigned}>>
561
562 This matches any assigned code point; that is, any code point whose general
563 category is not Unassigned (or equivalently, not Cn).
564
565 =item B<C<\p{Blank}>>
566
567 This is the same as C<\h> and C<\p{HorizSpace}>:  A character that changes the
568 spacing horizontally.
569
570 =item B<C<\p{Decomposition_Type: Non_Canonical}>>    (Short: C<\p{Dt=NonCanon}>)
571
572 Matches a character that has a non-canonical decomposition.
573
574 To understand the use of this rarely used property=value combination, it is
575 necessary to know some basics about decomposition.
576 Consider a character, say H.  It could appear with various marks around it,
577 such as an acute accent, or a circumflex, or various hooks, circles, arrows,
578 I<etc.>, above, below, to one side and/or the other, etc.  There are many
579 possibilities among the world's languages.  The number of combinations is
580 astronomical, and if there were a character for each combination, it would
581 soon exhaust Unicode's more than a million possible characters.  So Unicode
582 took a different approach: there is a character for the base H, and a
583 character for each of the possible marks, and they can be combined variously
584 to get a final logical character.  So a logical character--what appears to be a
585 single character--can be a sequence of more than one individual characters.
586 This is called an "extended grapheme cluster".  (Perl furnishes the C<\X>
587 construct to match such sequences.)
588
589 But Unicode's intent is to unify the existing character set standards and
590 practices, and a number of pre-existing standards have single characters that
591 mean the same thing as some of these combinations.  An example is ISO-8859-1,
592 which has quite a few of these in the Latin-1 range, an example being "LATIN
593 CAPITAL LETTER E WITH ACUTE".  Because this character was in this pre-existing
594 standard, Unicode added it to its repertoire.  But this character is considered
595 by Unicode to be equivalent to the sequence consisting of first the character
596 "LATIN CAPITAL LETTER E", then the character "COMBINING ACUTE ACCENT".
597
598 "LATIN CAPITAL LETTER E WITH ACUTE" is called a "pre-composed" character, and
599 the equivalence with the sequence is called canonical equivalence.  All
600 pre-composed characters are said to have a decomposition (into the equivalent
601 sequence) and the decomposition type is also called canonical.
602
603 However, many more characters have a different type of decomposition, a
604 "compatible" or "non-canonical" decomposition.  The sequences that form these
605 decompositions are not considered canonically equivalent to the pre-composed
606 character.  An example, again in the Latin-1 range, is the "SUPERSCRIPT ONE".
607 It is kind of like a regular digit 1, but not exactly; its decomposition
608 into the digit 1 is called a "compatible" decomposition, specifically a
609 "super" decomposition.  There are several such compatibility
610 decompositions (see L<http://www.unicode.org/reports/tr44>), including one
611 called "compat" which means some miscellaneous type of decomposition
612 that doesn't fit into the decomposition categories that Unicode has chosen. 
613
614 Note that most Unicode characters don't have a decomposition, so their
615 decomposition type is "None".
616
617 Perl has added the C<Non_Canonical> type, for your convenience, to mean any of
618 the compatibility decompositions.
619
620 =item B<C<\p{Graph}>>
621
622 Matches any character that is graphic.  Theoretically, this means a character
623 that on a printer would cause ink to be used.
624
625 =item B<C<\p{HorizSpace}>>
626
627 This is the same as C<\h> and C<\p{Blank}>:  A character that changes the
628 spacing horizontally.
629
630 =item B<C<\p{In=*}>> 
631
632 This is a synonym for C<\p{Present_In=*}>
633
634 =item B<C<\p{PerlSpace}>>
635
636 This is the same as C<\s>, restricted to ASCII, namely C<S<[ \f\n\r\t]>>.
637
638 Mnemonic: Perl's (original) space
639
640 =item B<C<\p{PerlWord}>>
641
642 This is the same as C<\w>, restricted to ASCII, namely C<[A-Za-z0-9_]>
643
644 Mnemonic: Perl's (original) word.
645
646 =item B<C<\p{PosixAlnum}>>
647
648 This matches any alphanumeric character in the ASCII range, namely
649 C<[A-Za-z0-9]>.
650
651 =item B<C<\p{PosixAlpha}>>
652
653 This matches any alphabetic character in the ASCII range, namely C<[A-Za-z]>.
654
655 =item B<C<\p{PosixBlank}>>
656
657 This matches any blank character in the ASCII range, namely C<S<[ \t]>>.
658
659 =item B<C<\p{PosixCntrl}>>
660
661 This matches any control character in the ASCII range, namely C<[\x00-\x1F\x7F]>
662
663 =item B<C<\p{PosixDigit}>>
664
665 This matches any digit character in the ASCII range, namely C<[0-9]>.
666
667 =item B<C<\p{PosixGraph}>>
668
669 This matches any graphical character in the ASCII range, namely C<[\x21-\x7E]>.
670
671 =item B<C<\p{PosixLower}>>
672
673 This matches any lowercase character in the ASCII range, namely C<[a-z]>.
674
675 =item B<C<\p{PosixPrint}>>
676
677 This matches any printable character in the ASCII range, namely C<[\x20-\x7E]>.
678 These are the graphical characters plus SPACE.
679
680 =item B<C<\p{PosixPunct}>>
681
682 This matches any punctuation character in the ASCII range, namely
683 C<[\x21-\x2F\x3A-\x40\x5B-\x60\x7B-\x7E]>.  These are the
684 graphical characters that aren't word characters.  Note that the Posix standard
685 includes in its definition of punctuation, those characters that Unicode calls
686 "symbols."
687
688 =item B<C<\p{PosixSpace}>>
689
690 This matches any space character in the ASCII range, namely
691 C<S<[ \f\n\r\t\x0B]>> (the last being a vertical tab).
692
693 =item B<C<\p{PosixUpper}>>
694
695 This matches any uppercase character in the ASCII range, namely C<[A-Z]>.
696
697 =item B<C<\p{Present_In: *}>>    (Short: C<\p{In=*}>)
698
699 This property is used when you need to know in what Unicode version(s) a
700 character is.
701
702 The "*" above stands for some two digit Unicode version number, such as
703 C<1.1> or C<4.0>; or the "*" can also be C<Unassigned>.  This property will
704 match the code points whose final disposition has been settled as of the
705 Unicode release given by the version number; C<\p{Present_In: Unassigned}>
706 will match those code points whose meaning has yet to be assigned.
707
708 For example, C<U+0041> "LATIN CAPITAL LETTER A" was present in the very first
709 Unicode release available, which is C<1.1>, so this property is true for all
710 valid "*" versions.  On the other hand, C<U+1EFF> was not assigned until version
711 5.1 when it became "LATIN SMALL LETTER Y WITH LOOP", so the only "*" that
712 would match it are 5.1, 5.2, and later.
713
714 Unicode furnishes the C<Age> property from which this is derived.  The problem
715 with Age is that a strict interpretation of it (which Perl takes) has it
716 matching the precise release a code point's meaning is introduced in.  Thus
717 C<U+0041> would match only 1.1; and C<U+1EFF> only 5.1.  This is not usually what
718 you want.
719
720 Some non-Perl implementations of the Age property may change its meaning to be
721 the same as the Perl Present_In property; just be aware of that.
722
723 Another confusion with both these properties is that the definition is not
724 that the code point has been assigned, but that the meaning of the code point
725 has been determined.  This is because 66 code points will always be
726 unassigned, and, so the Age for them is the Unicode version the decision to
727 make them so was made in.  For example, C<U+FDD0> is to be permanently
728 unassigned to a character, and the decision to do that was made in version 3.1,
729 so C<\p{Age=3.1}> matches this character and C<\p{Present_In: 3.1}> and up
730 matches as well.
731
732 =item B<C<\p{Print}>>
733
734 This matches any character that is graphical or blank, except controls.
735
736 =item B<C<\p{SpacePerl}>>
737
738 This is the same as C<\s>, including beyond ASCII.
739
740 Mnemonic: Space, as modified by Perl.  (It doesn't include the vertical tab
741 which both the Posix standard and Unicode consider to be space.)
742
743 =item B<C<\p{VertSpace}>>
744
745 This is the same as C<\v>:  A character that changes the spacing vertically.
746
747 =item B<C<\p{Word}>>
748
749 This is the same as C<\w>, including beyond ASCII.
750
751 =back
752
753 =head2 User-Defined Character Properties
754
755 You can define your own binary character properties by defining subroutines
756 whose names begin with "In" or "Is".  The subroutines can be defined in any
757 package.  The user-defined properties can be used in the regular expression
758 C<\p> and C<\P> constructs; if you are using a user-defined property from a
759 package other than the one you are in, you must specify its package in the
760 C<\p> or C<\P> construct.
761
762     # assuming property Is_Foreign defined in Lang::
763     package main;  # property package name required
764     if ($txt =~ /\p{Lang::IsForeign}+/) { ... }
765
766     package Lang;  # property package name not required
767     if ($txt =~ /\p{IsForeign}+/) { ... }
768
769
770 Note that the effect is compile-time and immutable once defined.
771
772 The subroutines must return a specially-formatted string, with one
773 or more newline-separated lines.  Each line must be one of the following:
774
775 =over 4
776
777 =item *
778
779 A single hexadecimal number denoting a Unicode code point to include.
780
781 =item *
782
783 Two hexadecimal numbers separated by horizontal whitespace (space or
784 tabular characters) denoting a range of Unicode code points to include.
785
786 =item *
787
788 Something to include, prefixed by "+": a built-in character
789 property (prefixed by "utf8::") or a user-defined character property,
790 to represent all the characters in that property; two hexadecimal code
791 points for a range; or a single hexadecimal code point.
792
793 =item *
794
795 Something to exclude, prefixed by "-": an existing character
796 property (prefixed by "utf8::") or a user-defined character property,
797 to represent all the characters in that property; two hexadecimal code
798 points for a range; or a single hexadecimal code point.
799
800 =item *
801
802 Something to negate, prefixed "!": an existing character
803 property (prefixed by "utf8::") or a user-defined character property,
804 to represent all the characters in that property; two hexadecimal code
805 points for a range; or a single hexadecimal code point.
806
807 =item *
808
809 Something to intersect with, prefixed by "&": an existing character
810 property (prefixed by "utf8::") or a user-defined character property,
811 for all the characters except the characters in the property; two
812 hexadecimal code points for a range; or a single hexadecimal code point.
813
814 =back
815
816 For example, to define a property that covers both the Japanese
817 syllabaries (hiragana and katakana), you can define
818
819     sub InKana {
820         return <<END;
821     3040\t309F
822     30A0\t30FF
823     END
824     }
825
826 Imagine that the here-doc end marker is at the beginning of the line.
827 Now you can use C<\p{InKana}> and C<\P{InKana}>.
828
829 You could also have used the existing block property names:
830
831     sub InKana {
832         return <<'END';
833     +utf8::InHiragana
834     +utf8::InKatakana
835     END
836     }
837
838 Suppose you wanted to match only the allocated characters,
839 not the raw block ranges: in other words, you want to remove
840 the non-characters:
841
842     sub InKana {
843         return <<'END';
844     +utf8::InHiragana
845     +utf8::InKatakana
846     -utf8::IsCn
847     END
848     }
849
850 The negation is useful for defining (surprise!) negated classes.
851
852     sub InNotKana {
853         return <<'END';
854     !utf8::InHiragana
855     -utf8::InKatakana
856     +utf8::IsCn
857     END
858     }
859
860 Intersection is useful for getting the common characters matched by
861 two (or more) classes.
862
863     sub InFooAndBar {
864         return <<'END';
865     +main::Foo
866     &main::Bar
867     END
868     }
869
870 It's important to remember not to use "&" for the first set; that
871 would be intersecting with nothing (resulting in an empty set).
872
873 =head2 User-Defined Case Mappings (for serious hackers only)
874
875 You can also define your own mappings to be used in C<lc()>,
876 C<lcfirst()>, C<uc()>, and C<ucfirst()> (or their string-inlined versions,
877 C<\L>, C<\l>, C<\U>, and C<\u>).  The mappings are currently only valid
878 on strings encoded in UTF-8, but see below for a partial workaround for
879 this restriction.
880
881 The principle is similar to that of user-defined character
882 properties: define subroutines that do the mappings.
883 C<ToLower> is used for C<lc()>, C<\L>, C<lcfirst()>, and C<\l>; C<ToTitle> for
884 C<ucfirst()> and C<\u>; and C<ToUpper> for C<uc()> and C<\U>.
885
886 C<ToUpper()> should look something like this:
887
888     sub ToUpper {
889         return <<END;
890     0061\t007A\t0041
891     0101\t\t0100
892     END
893     }
894
895 This sample C<ToUpper()> has the effect of mapping "a-z" to "A-Z", 0x101
896 to 0x100, and all other characters map to themselves.  The first
897 returned line means to map the code point at 0x61 ("a") to 0x41 ("A"),
898 the code point at 0x62 ("b") to 0x42 ("B"),  ..., 0x7A ("z") to 0x5A
899 ("Z").  The second line maps just the code point 0x101 to 0x100.  Since
900 there are no other mappings defined, all other code points map to
901 themselves.
902
903 This mechanism is not well behaved as far as affecting other packages
904 and scopes.  All non-threaded programs have exactly one uppercasing
905 behavior, one lowercasing behavior, and one titlecasing behavior in
906 effect for utf8-encoded strings for the duration of the program.  Each
907 of these behaviors is irrevocably determined the first time the
908 corresponding function is called to change a utf8-encoded string's case.
909 If a corresponding C<To-> function has been defined in the package that
910 makes that first call, the mapping defined by that function will be the
911 mapping used for the duration of the program's execution across all
912 packages and scopes.  If no corresponding C<To-> function has been
913 defined in that package, the standard official mapping will be used for
914 all packages and scopes, and any corresponding C<To-> function anywhere
915 will be ignored.  Threaded programs have similar behavior.  If the
916 program's casing behavior has been decided at the time of a thread's
917 creation, the thread will inherit that behavior.  But, if the behavior
918 hasn't been decided, the thread gets to decide for itself, and its
919 decision does not affect other threads nor its creator.
920
921 As shown by the example above, you have to furnish a complete mapping;
922 you can't just override a couple of characters and leave the rest
923 unchanged.  You can find all the official mappings in the directory
924 C<$Config{privlib}>F</unicore/To/>.  The mapping data is returned as the
925 here-document.  The C<utf8::ToSpecI<Foo>> hashes in those files are special
926 exception mappings derived from
927 C<$Config{privlib}>F</unicore/SpecialCasing.txt>.  (The "Digit" and
928 "Fold" mappings that one can see in the directory are not directly
929 user-accessible, one can use either the L<Unicode::UCD> module, or just match
930 case-insensitively, which is what uses the "Fold" mapping.  Neither are user
931 overridable.)
932
933 If you have many mappings to change, you can take the official mapping data,
934 change by hand the affected code points, and place the whole thing into your
935 subroutine.  But this will only be valid on Perls that use the same Unicode
936 version.  Another option would be to have your subroutine read the official
937 mapping file(s) and overwrite the affected code points.
938
939 If you have only a few mappings to change you can use the
940 following trick (but see below for a big caveat), here illustrated for
941 Turkish:
942
943     use Config;
944     use charnames ":full";
945
946     sub ToUpper {
947         my $official = do "$Config{privlib}/unicore/To/Upper.pl";
948         $utf8::ToSpecUpper{'i'} =
949                            "\N{LATIN CAPITAL LETTER I WITH DOT ABOVE}";
950         return $official;
951     }
952
953 This takes the official mappings and overrides just one, for "LATIN SMALL
954 LETTER I".  Each hash key must be the string of bytes that form the UTF-8
955 (on EBCDIC platforms, UTF-EBCDIC) of the character, as illustrated by
956 the inverse function.
957
958     sub ToLower {
959         my $official = do $lower;
960         $utf8::ToSpecLower{"\xc4\xb0"} = "i";
961         return $official;
962     }
963
964 This example is for an ASCII platform, and C<\xc4\xb0> is the string of
965 bytes that together form the UTF-8 that represents C<\N{LATIN CAPITAL
966 LETTER I WITH DOT ABOVE}>, C<U+0130>.  You can avoid having to figure out
967 these bytes, and at the same time make it work on all platforms by
968 instead writing:
969
970     sub ToLower {
971         my $official = do $lower;
972         my $sequence = "\N{LATIN CAPITAL LETTER I WITH DOT ABOVE}";
973         utf8::encode($sequence);
974         $utf8::ToSpecLower{$sequence} = "i";
975         return $official;
976     }
977
978 This works because C<utf8::encode()> takes the single character and
979 converts it to the sequence of bytes that constitute it.  Note that we took
980 advantage of the fact that C<"i"> is the same in UTF-8 or UTF_EBCIDIC as not;
981 otherwise we would have had to write
982
983         $utf8::ToSpecLower{$sequence} = "\N{LATIN SMALL LETTER I}";
984
985 in the ToLower example, and in the ToUpper example, use
986
987         my $sequence = "\N{LATIN SMALL LETTER I}";
988         utf8::encode($sequence);
989
990 A big caveat to the above trick, and to this whole mechanism in general,
991 is that they work only on strings encoded in UTF-8.  You can partially
992 get around this by using C<use subs>.  For example:
993
994  use subs qw(uc ucfirst lc lcfirst);
995
996  sub uc($) {
997      my $string = shift;
998      utf8::upgrade($string);
999      return CORE::uc($string);
1000  }
1001
1002  sub lc($) {
1003      my $string = shift;
1004      utf8::upgrade($string);
1005
1006      # Unless an I is before a dot_above, it turns into a dotless i.
1007      # (The character class with the combining classes matches non-above
1008      # marks following the I.  Any number of these may be between the 'I' and
1009      # the dot_above, and the dot_above will still apply to the 'I'.
1010      use charnames ":full";
1011      $string =~
1012              s/I
1013                (?! [^\p{ccc=0}\p{ccc=Above}]* \N{COMBINING DOT ABOVE} )
1014               /\N{LATIN SMALL LETTER DOTLESS I}/gx;
1015
1016      # But when the I is followed by a dot_above, remove the
1017      # dot_above so the end result will be i.
1018      $string =~ s/I
1019                     ([^\p{ccc=0}\p{ccc=Above}]* )
1020                     \N{COMBINING DOT ABOVE}
1021                  /i$1/gx;
1022      return CORE::lc($string);
1023  }
1024
1025 These examples (also for Turkish) make sure the input is in UTF-8, and then
1026 call the corresponding official function, which will use the C<ToUpper()> and
1027 C<ToLower()> functions you have defined.
1028 (For Turkish, there are other required functions: C<ucfirst>, C<lcfirst>,
1029 and C<ToTitle>. These are very similar to the ones given above.)
1030
1031 The reason this is a partial work-around is that it doesn't affect the C<\l>,
1032 C<\L>, C<\u>, and C<\U> case change operations, which still require the source
1033 to be encoded in utf8 (see L</The "Unicode Bug">).
1034
1035 The C<lc()> example shows how you can add context-dependent casing. Note
1036 that context-dependent casing suffers from the problem that the string
1037 passed to the casing function may not have sufficient context to make
1038 the proper choice. And, it will not be called for C<\l>, C<\L>, C<\u>,
1039 and C<\U>.
1040
1041 =head2 Character Encodings for Input and Output
1042
1043 See L<Encode>.
1044
1045 =head2 Unicode Regular Expression Support Level
1046
1047 The following list of Unicode support for regular expressions describes
1048 all the features currently supported.  The references to "Level N"
1049 and the section numbers refer to the Unicode Technical Standard #18,
1050 "Unicode Regular Expressions", version 11, in May 2005.
1051
1052 =over 4
1053
1054 =item *
1055
1056 Level 1 - Basic Unicode Support
1057
1058         RL1.1   Hex Notation                     - done          [1]
1059         RL1.2   Properties                       - done          [2][3]
1060         RL1.2a  Compatibility Properties         - done          [4]
1061         RL1.3   Subtraction and Intersection     - MISSING       [5]
1062         RL1.4   Simple Word Boundaries           - done          [6]
1063         RL1.5   Simple Loose Matches             - done          [7]
1064         RL1.6   Line Boundaries                  - MISSING       [8]
1065         RL1.7   Supplementary Code Points        - done          [9]
1066
1067         [1]  \x{...}
1068         [2]  \p{...} \P{...}
1069         [3]  supports not only minimal list, but all Unicode character
1070              properties (see L</Unicode Character Properties>)
1071         [4]  \d \D \s \S \w \W \X [:prop:] [:^prop:]
1072         [5]  can use regular expression look-ahead [a] or
1073              user-defined character properties [b] to emulate set
1074              operations
1075         [6]  \b \B
1076         [7]  note that Perl does Full case-folding in matching (but with
1077              bugs), not Simple: for example U+1F88 is equivalent to
1078              U+1F00 U+03B9, not with 1F80.  This difference matters
1079              mainly for certain Greek capital letters with certain
1080              modifiers: the Full case-folding decomposes the letter,
1081              while the Simple case-folding would map it to a single
1082              character.
1083         [8]  should do ^ and $ also on U+000B (\v in C), FF (\f), CR
1084              (\r), CRLF (\r\n), NEL (U+0085), LS (U+2028), and PS
1085              (U+2029); should also affect <>, $., and script line
1086              numbers; should not split lines within CRLF [c] (i.e. there
1087              is no empty line between \r and \n)
1088         [9]  UTF-8/UTF-EBDDIC used in perl allows not only U+10000 to
1089              U+10FFFF but also beyond U+10FFFF [d]
1090
1091 [a] You can mimic class subtraction using lookahead.
1092 For example, what UTS#18 might write as
1093
1094     [{Greek}-[{UNASSIGNED}]]
1095
1096 in Perl can be written as:
1097
1098     (?!\p{Unassigned})\p{InGreekAndCoptic}
1099     (?=\p{Assigned})\p{InGreekAndCoptic}
1100
1101 But in this particular example, you probably really want
1102
1103     \p{GreekAndCoptic}
1104
1105 which will match assigned characters known to be part of the Greek script.
1106
1107 Also see the Unicode::Regex::Set module, it does implement the full
1108 UTS#18 grouping, intersection, union, and removal (subtraction) syntax.
1109
1110 [b] '+' for union, '-' for removal (set-difference), '&' for intersection
1111 (see L</"User-Defined Character Properties">)
1112
1113 [c] Try the C<:crlf> layer (see L<PerlIO>).
1114
1115 [d] U+FFFF will currently generate a warning message if 'utf8' warnings are
1116     enabled
1117
1118 =item *
1119
1120 Level 2 - Extended Unicode Support
1121
1122         RL2.1   Canonical Equivalents           - MISSING       [10][11]
1123         RL2.2   Default Grapheme Clusters       - MISSING       [12]
1124         RL2.3   Default Word Boundaries         - MISSING       [14]
1125         RL2.4   Default Loose Matches           - MISSING       [15]
1126         RL2.5   Name Properties                 - MISSING       [16]
1127         RL2.6   Wildcard Properties             - MISSING
1128
1129         [10] see UAX#15 "Unicode Normalization Forms"
1130         [11] have Unicode::Normalize but not integrated to regexes
1131         [12] have \X but we don't have a "Grapheme Cluster Mode"
1132         [14] see UAX#29, Word Boundaries
1133         [15] see UAX#21 "Case Mappings"
1134         [16] missing loose match [e]
1135
1136 [e] C<\N{...}> allows namespaces (see L<charnames>).
1137
1138 =item *
1139
1140 Level 3 - Tailored Support
1141
1142         RL3.1   Tailored Punctuation            - MISSING
1143         RL3.2   Tailored Grapheme Clusters      - MISSING       [17][18]
1144         RL3.3   Tailored Word Boundaries        - MISSING
1145         RL3.4   Tailored Loose Matches          - MISSING
1146         RL3.5   Tailored Ranges                 - MISSING
1147         RL3.6   Context Matching                - MISSING       [19]
1148         RL3.7   Incremental Matches             - MISSING
1149       ( RL3.8   Unicode Set Sharing )
1150         RL3.9   Possible Match Sets             - MISSING
1151         RL3.10  Folded Matching                 - MISSING       [20]
1152         RL3.11  Submatchers                     - MISSING
1153
1154         [17] see UAX#10 "Unicode Collation Algorithms"
1155         [18] have Unicode::Collate but not integrated to regexes
1156         [19] have (?<=x) and (?=x), but look-aheads or look-behinds
1157              should see outside of the target substring
1158         [20] need insensitive matching for linguistic features other
1159              than case; for example, hiragana to katakana, wide and
1160              narrow, simplified Han to traditional Han (see UTR#30
1161              "Character Foldings")
1162
1163 =back
1164
1165 =head2 Unicode Encodings
1166
1167 Unicode characters are assigned to I<code points>, which are abstract
1168 numbers.  To use these numbers, various encodings are needed.
1169
1170 =over 4
1171
1172 =item *
1173
1174 UTF-8
1175
1176 UTF-8 is a variable-length (1 to 4 bytes), byte-order independent
1177 encoding. For ASCII (and we really do mean 7-bit ASCII, not another
1178 8-bit encoding), UTF-8 is transparent.
1179
1180 The following table is from Unicode 3.2.
1181
1182  Code Points            1st Byte  2nd Byte  3rd Byte  4th Byte
1183
1184    U+0000..U+007F       00..7F
1185    U+0080..U+07FF     * C2..DF    80..BF
1186    U+0800..U+0FFF       E0      * A0..BF    80..BF
1187    U+1000..U+CFFF       E1..EC    80..BF    80..BF
1188    U+D000..U+D7FF       ED        80..9F    80..BF
1189    U+D800..U+DFFF       +++++++ utf16 surrogates, not legal utf8 +++++++
1190    U+E000..U+FFFF       EE..EF    80..BF    80..BF
1191   U+10000..U+3FFFF      F0      * 90..BF    80..BF    80..BF
1192   U+40000..U+FFFFF      F1..F3    80..BF    80..BF    80..BF
1193  U+100000..U+10FFFF     F4        80..8F    80..BF    80..BF
1194
1195 Note the gaps before several of the byte entries above marked by '*'.  These are
1196 caused by legal UTF-8 avoiding non-shortest encodings: it is technically
1197 possible to UTF-8-encode a single code point in different ways, but that is
1198 explicitly forbidden, and the shortest possible encoding should always be used
1199 (and that is what Perl does).
1200
1201 Another way to look at it is via bits:
1202
1203  Code Points                    1st Byte   2nd Byte  3rd Byte  4th Byte
1204
1205                     0aaaaaaa     0aaaaaaa
1206             00000bbbbbaaaaaa     110bbbbb  10aaaaaa
1207             ccccbbbbbbaaaaaa     1110cccc  10bbbbbb  10aaaaaa
1208   00000dddccccccbbbbbbaaaaaa     11110ddd  10cccccc  10bbbbbb  10aaaaaa
1209
1210 As you can see, the continuation bytes all begin with "10", and the
1211 leading bits of the start byte tell how many bytes there are in the
1212 encoded character.
1213
1214 The original UTF-8 specification allowed up to 6 bytes, to allow
1215 encoding of numbers up to 0x7FFF_FFFF.  Perl continues to allow those,
1216 and has extended that up to 13 bytes to encode code points up to what
1217 can fit in a 64-bit word.  However, Perl will warn if you output any of
1218 these, as being non-portable; and under strict UTF-8 input protocols,
1219 they are forbidden.
1220
1221 The Unicode non-character code points are also disallowed in UTF-8 in
1222 "open interchange".  See L</Non-character code points>.
1223
1224 =item *
1225
1226 UTF-EBCDIC
1227
1228 Like UTF-8 but EBCDIC-safe, in the way that UTF-8 is ASCII-safe.
1229
1230 =item *
1231
1232 UTF-16, UTF-16BE, UTF-16LE, Surrogates, and BOMs (Byte Order Marks)
1233
1234 The followings items are mostly for reference and general Unicode
1235 knowledge, Perl doesn't use these constructs internally.
1236
1237 UTF-16 is a 2 or 4 byte encoding.  The Unicode code points
1238 C<U+0000..U+FFFF> are stored in a single 16-bit unit, and the code
1239 points C<U+10000..U+10FFFF> in two 16-bit units.  The latter case is
1240 using I<surrogates>, the first 16-bit unit being the I<high
1241 surrogate>, and the second being the I<low surrogate>.
1242
1243 Surrogates are code points set aside to encode the C<U+10000..U+10FFFF>
1244 range of Unicode code points in pairs of 16-bit units.  The I<high
1245 surrogates> are the range C<U+D800..U+DBFF> and the I<low surrogates>
1246 are the range C<U+DC00..U+DFFF>.  The surrogate encoding is
1247
1248     $hi = ($uni - 0x10000) / 0x400 + 0xD800;
1249     $lo = ($uni - 0x10000) % 0x400 + 0xDC00;
1250
1251 and the decoding is
1252
1253     $uni = 0x10000 + ($hi - 0xD800) * 0x400 + ($lo - 0xDC00);
1254
1255 Because of the 16-bitness, UTF-16 is byte-order dependent.  UTF-16
1256 itself can be used for in-memory computations, but if storage or
1257 transfer is required either UTF-16BE (big-endian) or UTF-16LE
1258 (little-endian) encodings must be chosen.
1259
1260 This introduces another problem: what if you just know that your data
1261 is UTF-16, but you don't know which endianness?  Byte Order Marks, or
1262 BOMs, are a solution to this.  A special character has been reserved
1263 in Unicode to function as a byte order marker: the character with the
1264 code point C<U+FEFF> is the BOM.
1265
1266 The trick is that if you read a BOM, you will know the byte order,
1267 since if it was written on a big-endian platform, you will read the
1268 bytes C<0xFE 0xFF>, but if it was written on a little-endian platform,
1269 you will read the bytes C<0xFF 0xFE>.  (And if the originating platform
1270 was writing in UTF-8, you will read the bytes C<0xEF 0xBB 0xBF>.)
1271
1272 The way this trick works is that the character with the code point
1273 C<U+FFFE> is not supposed to be in input streams, so the
1274 sequence of bytes C<0xFF 0xFE> is unambiguously "BOM, represented in
1275 little-endian format" and cannot be C<U+FFFE>, represented in big-endian
1276 format".
1277
1278 Surrogates have no meaning in Unicode outside their use in pairs to
1279 represent other code points.  However, Perl allows them to be
1280 represented individually internally, for example by saying
1281 C<chr(0xD801)>, so that the all code points, not just Unicode ones, are
1282 representable.  Unicode does define semantics for them, such as their
1283 General Category is "Cs".  But because their use is somewhat dangerous,
1284 Perl will warn (using the warning category UTF8) if an attempt is made
1285 to do things like take the lower case of one, or match
1286 case-insensitively, or to output them.  (But don't try this on Perls
1287 before 5.14.)
1288
1289 =item *
1290
1291 UTF-32, UTF-32BE, UTF-32LE
1292
1293 The UTF-32 family is pretty much like the UTF-16 family, expect that
1294 the units are 32-bit, and therefore the surrogate scheme is not
1295 needed.  The BOM signatures will be C<0x00 0x00 0xFE 0xFF> for BE and
1296 C<0xFF 0xFE 0x00 0x00> for LE.
1297
1298 =item *
1299
1300 UCS-2, UCS-4
1301
1302 Encodings defined by the ISO 10646 standard.  UCS-2 is a 16-bit
1303 encoding.  Unlike UTF-16, UCS-2 is not extensible beyond C<U+FFFF>,
1304 because it does not use surrogates.  UCS-4 is a 32-bit encoding,
1305 functionally identical to UTF-32.
1306
1307 =item *
1308
1309 UTF-7
1310
1311 A seven-bit safe (non-eight-bit) encoding, which is useful if the
1312 transport or storage is not eight-bit safe.  Defined by RFC 2152.
1313
1314 =back
1315
1316 =head2 Non-character code points
1317
1318 66 code points are set aside in Unicode as "non-character code points".
1319 These all have the Unassigned (Cn) General Category, and they never will
1320 be assigned.  These are never supposed to be in legal Unicode input
1321 streams, so that code can use them as sentinels that can be mixed in
1322 with character data, and they always will be distinguishable from that data.
1323 To keep them out of Perl input streams, strict UTF-8 should be
1324 specified, such as by using the layer C<:encoding('UTF-8')>.  The
1325 non-character code points are the 32 between U+FDD0 and U+FDEF, and the
1326 34 code points U+FFFE, U+FFFF, U+1FFFE, U+1FFFF, ... U+10FFFE, U+10FFFF.
1327 Some people are under the mistaken impression that these are "illegal",
1328 but that is not true.  An application or cooperating set of applications
1329 can legally use them at will internally; but these code points are
1330 "illegal for open interchange".
1331
1332 =head2 Security Implications of Unicode
1333
1334 Read L<Unicode Security Considerations|http://www.unicode.org/reports/tr36>.
1335 Also, note the following:
1336
1337 =over 4
1338
1339 =item *
1340
1341 Malformed UTF-8
1342
1343 Unfortunately, the specification of UTF-8 leaves some room for
1344 interpretation of how many bytes of encoded output one should generate
1345 from one input Unicode character.  Strictly speaking, the shortest
1346 possible sequence of UTF-8 bytes should be generated,
1347 because otherwise there is potential for an input buffer overflow at
1348 the receiving end of a UTF-8 connection.  Perl always generates the
1349 shortest length UTF-8, and with warnings on, Perl will warn about
1350 non-shortest length UTF-8 along with other malformations, such as the
1351 surrogates, which are not real Unicode code points.
1352
1353 =item *
1354
1355 Regular expressions behave slightly differently between byte data and
1356 character (Unicode) data.  For example, the "word character" character
1357 class C<\w> will work differently depending on if data is eight-bit bytes
1358 or Unicode.
1359
1360 In the first case, the set of C<\w> characters is either small--the
1361 default set of alphabetic characters, digits, and the "_"--or, if you
1362 are using a locale (see L<perllocale>), the C<\w> might contain a few
1363 more letters according to your language and country.
1364
1365 In the second case, the C<\w> set of characters is much, much larger.
1366 Most importantly, even in the set of the first 256 characters, it will
1367 probably match different characters: unlike most locales, which are
1368 specific to a language and country pair, Unicode classifies all the
1369 characters that are letters I<somewhere> as C<\w>.  For example, your
1370 locale might not think that LATIN SMALL LETTER ETH is a letter (unless
1371 you happen to speak Icelandic), but Unicode does.
1372
1373 As discussed elsewhere, Perl has one foot (two hooves?) planted in
1374 each of two worlds: the old world of bytes and the new world of
1375 characters, upgrading from bytes to characters when necessary.
1376 If your legacy code does not explicitly use Unicode, no automatic
1377 switch-over to characters should happen.  Characters shouldn't get
1378 downgraded to bytes, either.  It is possible to accidentally mix bytes
1379 and characters, however (see L<perluniintro>), in which case C<\w> in
1380 regular expressions might start behaving differently.  Review your
1381 code.  Use warnings and the C<strict> pragma.
1382
1383 =back
1384
1385 =head2 Unicode in Perl on EBCDIC
1386
1387 The way Unicode is handled on EBCDIC platforms is still
1388 experimental.  On such platforms, references to UTF-8 encoding in this
1389 document and elsewhere should be read as meaning the UTF-EBCDIC
1390 specified in Unicode Technical Report 16, unless ASCII vs. EBCDIC issues
1391 are specifically discussed. There is no C<utfebcdic> pragma or
1392 ":utfebcdic" layer; rather, "utf8" and ":utf8" are reused to mean
1393 the platform's "natural" 8-bit encoding of Unicode. See L<perlebcdic>
1394 for more discussion of the issues.
1395
1396 =head2 Locales
1397
1398 Usually locale settings and Unicode do not affect each other, but
1399 there are exceptions:
1400
1401 =over 4
1402
1403 =item *
1404
1405 You can enable automatic UTF-8-ification of your standard file
1406 handles, default C<open()> layer, and C<@ARGV> by using either
1407 the C<-C> command line switch or the C<PERL_UNICODE> environment
1408 variable, see L<perlrun> for the documentation of the C<-C> switch.
1409
1410 =item *
1411
1412 Perl tries really hard to work both with Unicode and the old
1413 byte-oriented world. Most often this is nice, but sometimes Perl's
1414 straddling of the proverbial fence causes problems.  Here's an example
1415 of how things can go wrong.  A locale can define a code point to be
1416 anything it wants.  It could make 'A' into a control character, for example.
1417 But strings encoded in utf8 always have Unicode semantics, so an 'A' in
1418 such a string is always an uppercase letter, never a control, no matter
1419 what the locale says it should be.
1420
1421 =back
1422
1423 =head2 When Unicode Does Not Happen
1424
1425 While Perl does have extensive ways to input and output in Unicode,
1426 and few other 'entry points' like the @ARGV which can be interpreted
1427 as Unicode (UTF-8), there still are many places where Unicode (in some
1428 encoding or another) could be given as arguments or received as
1429 results, or both, but it is not.
1430
1431 The following are such interfaces.  Also, see L</The "Unicode Bug">.
1432 For all of these interfaces Perl
1433 currently (as of 5.8.3) simply assumes byte strings both as arguments
1434 and results, or UTF-8 strings if the C<encoding> pragma has been used.
1435
1436 One reason why Perl does not attempt to resolve the role of Unicode in
1437 these cases is that the answers are highly dependent on the operating
1438 system and the file system(s).  For example, whether filenames can be
1439 in Unicode, and in exactly what kind of encoding, is not exactly a
1440 portable concept.  Similarly for the qx and system: how well will the
1441 'command line interface' (and which of them?) handle Unicode?
1442
1443 =over 4
1444
1445 =item *
1446
1447 chdir, chmod, chown, chroot, exec, link, lstat, mkdir,
1448 rename, rmdir, stat, symlink, truncate, unlink, utime, -X
1449
1450 =item *
1451
1452 %ENV
1453
1454 =item *
1455
1456 glob (aka the <*>)
1457
1458 =item *
1459
1460 open, opendir, sysopen
1461
1462 =item *
1463
1464 qx (aka the backtick operator), system
1465
1466 =item *
1467
1468 readdir, readlink
1469
1470 =back
1471
1472 =head2 The "Unicode Bug"
1473
1474 The term, the "Unicode bug" has been applied to an inconsistency with the
1475 Unicode characters whose ordinals are in the Latin-1 Supplement block, that
1476 is, between 128 and 255.  Without a locale specified, unlike all other
1477 characters or code points, these characters have very different semantics in
1478 byte semantics versus character semantics, unless
1479 C<use feature 'unicode_strings'> is specified.
1480
1481 In character semantics they are interpreted as Unicode code points, which means
1482 they have the same semantics as Latin-1 (ISO-8859-1).
1483
1484 In byte semantics, they are considered to be unassigned characters, meaning
1485 that the only semantics they have is their ordinal numbers, and that they are
1486 not members of various character classes.  None are considered to match C<\w>
1487 for example, but all match C<\W>.  (On EBCDIC platforms, the behavior may
1488 be different from this, depending on the underlying C language library
1489 functions.)
1490
1491 The behavior is known to have effects on these areas:
1492
1493 =over 4
1494
1495 =item *
1496
1497 Changing the case of a scalar, that is, using C<uc()>, C<ucfirst()>, C<lc()>,
1498 and C<lcfirst()>, or C<\L>, C<\U>, C<\u> and C<\l> in regular expression
1499 substitutions.
1500
1501 =item *
1502
1503 Using caseless (C</i>) regular expression matching
1504
1505 =item *
1506
1507 Matching a number of properties in regular expressions, namely C<\b>,
1508 C<\B>, C<\s>, C<\S>, C<\w>, C<\W>, and all the Posix character classes
1509 I<except> C<[[:ascii:]]>.
1510
1511 =item *
1512
1513 User-defined case change mappings.  You can create a C<ToUpper()> function, for
1514 example, which overrides Perl's built-in case mappings.  The scalar must be
1515 encoded in utf8 for your function to actually be invoked.
1516
1517 =back
1518
1519 This behavior can lead to unexpected results in which a string's semantics
1520 suddenly change if a code point above 255 is appended to or removed from it,
1521 which changes the string's semantics from byte to character or vice versa.  As
1522 an example, consider the following program and its output:
1523
1524  $ perl -le'
1525      $s1 = "\xC2";
1526      $s2 = "\x{2660}";
1527      for ($s1, $s2, $s1.$s2) {
1528          print /\w/ || 0;
1529      }
1530  '
1531  0
1532  0
1533  1
1534
1535 If there's no C<\w> in C<s1> or in C<s2>, why does their concatenation have one?
1536
1537 This anomaly stems from Perl's attempt to not disturb older programs that
1538 didn't use Unicode, and hence had no semantics for characters outside of the
1539 ASCII range (except in a locale), along with Perl's desire to add Unicode
1540 support seamlessly.  The result wasn't seamless: these characters were
1541 orphaned.
1542
1543 Starting in Perl 5.14, C<use feature 'unicode_strings'> can be used to
1544 cause Perl to use Unicode semantics on all string operations within the
1545 scope of the feature subpragma.  Regular expressions compiled in its
1546 scope retain that behavior even when executed or compiled into larger
1547 regular expressions outside the scope.  (The pragma does not, however,
1548 affect user-defined case changing operations.  These still require a
1549 UTF-8 encoded string to operate.)
1550
1551 In Perl 5.12, the subpragma affected casing changes, but not regular
1552 expressions.  See L<perlfunc/lc> for details on how this pragma works in
1553 combination with various others for casing.
1554
1555 For earlier Perls, or when a string is passed to a function outside the
1556 subpragma's scope, a workaround is to always call C<utf8::upgrade($string)>,
1557 or to use the standard module L<Encode>.   Also, a scalar that has any characters
1558 whose ordinal is above 0x100, or which were specified using either of the
1559 C<\N{...}> notations will automatically have character semantics.
1560
1561 =head2 Forcing Unicode in Perl (Or Unforcing Unicode in Perl)
1562
1563 Sometimes (see L</"When Unicode Does Not Happen"> or L</The "Unicode Bug">)
1564 there are situations where you simply need to force a byte
1565 string into UTF-8, or vice versa.  The low-level calls
1566 utf8::upgrade($bytestring) and utf8::downgrade($utf8string[, FAIL_OK]) are
1567 the answers.
1568
1569 Note that utf8::downgrade() can fail if the string contains characters
1570 that don't fit into a byte.
1571
1572 Calling either function on a string that already is in the desired state is a
1573 no-op.
1574
1575 =head2 Using Unicode in XS
1576
1577 If you want to handle Perl Unicode in XS extensions, you may find the
1578 following C APIs useful.  See also L<perlguts/"Unicode Support"> for an
1579 explanation about Unicode at the XS level, and L<perlapi> for the API
1580 details.
1581
1582 =over 4
1583
1584 =item *
1585
1586 C<DO_UTF8(sv)> returns true if the C<UTF8> flag is on and the bytes
1587 pragma is not in effect.  C<SvUTF8(sv)> returns true if the C<UTF8>
1588 flag is on; the bytes pragma is ignored.  The C<UTF8> flag being on
1589 does B<not> mean that there are any characters of code points greater
1590 than 255 (or 127) in the scalar or that there are even any characters
1591 in the scalar.  What the C<UTF8> flag means is that the sequence of
1592 octets in the representation of the scalar is the sequence of UTF-8
1593 encoded code points of the characters of a string.  The C<UTF8> flag
1594 being off means that each octet in this representation encodes a
1595 single character with code point 0..255 within the string.  Perl's
1596 Unicode model is not to use UTF-8 until it is absolutely necessary.
1597
1598 =item *
1599
1600 C<uvchr_to_utf8(buf, chr)> writes a Unicode character code point into
1601 a buffer encoding the code point as UTF-8, and returns a pointer
1602 pointing after the UTF-8 bytes.  It works appropriately on EBCDIC machines.
1603
1604 =item *
1605
1606 C<utf8_to_uvchr(buf, lenp)> reads UTF-8 encoded bytes from a buffer and
1607 returns the Unicode character code point and, optionally, the length of
1608 the UTF-8 byte sequence.  It works appropriately on EBCDIC machines.
1609
1610 =item *
1611
1612 C<utf8_length(start, end)> returns the length of the UTF-8 encoded buffer
1613 in characters.  C<sv_len_utf8(sv)> returns the length of the UTF-8 encoded
1614 scalar.
1615
1616 =item *
1617
1618 C<sv_utf8_upgrade(sv)> converts the string of the scalar to its UTF-8
1619 encoded form.  C<sv_utf8_downgrade(sv)> does the opposite, if
1620 possible.  C<sv_utf8_encode(sv)> is like sv_utf8_upgrade except that
1621 it does not set the C<UTF8> flag.  C<sv_utf8_decode()> does the
1622 opposite of C<sv_utf8_encode()>.  Note that none of these are to be
1623 used as general-purpose encoding or decoding interfaces: C<use Encode>
1624 for that.  C<sv_utf8_upgrade()> is affected by the encoding pragma
1625 but C<sv_utf8_downgrade()> is not (since the encoding pragma is
1626 designed to be a one-way street).
1627
1628 =item *
1629
1630 C<is_utf8_char(s)> returns true if the pointer points to a valid UTF-8
1631 character.
1632
1633 =item *
1634
1635 C<is_utf8_string(buf, len)> returns true if C<len> bytes of the buffer
1636 are valid UTF-8.
1637
1638 =item *
1639
1640 C<UTF8SKIP(buf)> will return the number of bytes in the UTF-8 encoded
1641 character in the buffer.  C<UNISKIP(chr)> will return the number of bytes
1642 required to UTF-8-encode the Unicode character code point.  C<UTF8SKIP()>
1643 is useful for example for iterating over the characters of a UTF-8
1644 encoded buffer; C<UNISKIP()> is useful, for example, in computing
1645 the size required for a UTF-8 encoded buffer.
1646
1647 =item *
1648
1649 C<utf8_distance(a, b)> will tell the distance in characters between the
1650 two pointers pointing to the same UTF-8 encoded buffer.
1651
1652 =item *
1653
1654 C<utf8_hop(s, off)> will return a pointer to a UTF-8 encoded buffer
1655 that is C<off> (positive or negative) Unicode characters displaced
1656 from the UTF-8 buffer C<s>.  Be careful not to overstep the buffer:
1657 C<utf8_hop()> will merrily run off the end or the beginning of the
1658 buffer if told to do so.
1659
1660 =item *
1661
1662 C<pv_uni_display(dsv, spv, len, pvlim, flags)> and
1663 C<sv_uni_display(dsv, ssv, pvlim, flags)> are useful for debugging the
1664 output of Unicode strings and scalars.  By default they are useful
1665 only for debugging--they display B<all> characters as hexadecimal code
1666 points--but with the flags C<UNI_DISPLAY_ISPRINT>,
1667 C<UNI_DISPLAY_BACKSLASH>, and C<UNI_DISPLAY_QQ> you can make the
1668 output more readable.
1669
1670 =item *
1671
1672 C<foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2)> can be used to
1673 compare two strings case-insensitively in Unicode.  For case-sensitive
1674 comparisons you can just use C<memEQ()> and C<memNE()> as usual, except
1675 if one string is in utf8 and the other isn't.
1676
1677 =back
1678
1679 For more information, see L<perlapi>, and F<utf8.c> and F<utf8.h>
1680 in the Perl source code distribution.
1681
1682 =head2 Hacking Perl to work on earlier Unicode versions (for very serious hackers only)
1683
1684 Perl by default comes with the latest supported Unicode version built in, but
1685 you can change to use any earlier one.
1686
1687 Download the files in the version of Unicode that you want from the Unicode web
1688 site L<http://www.unicode.org>).  These should replace the existing files in
1689 C<\$Config{privlib}>/F<unicore>.  (C<\%Config> is available from the Config
1690 module.)  Follow the instructions in F<README.perl> in that directory to change
1691 some of their names, and then run F<make>.
1692
1693 It is even possible to download them to a different directory, and then change
1694 F<utf8_heavy.pl> in the directory C<\$Config{privlib}> to point to the new
1695 directory, or maybe make a copy of that directory before making the change, and
1696 using C<@INC> or the C<-I> run-time flag to switch between versions at will
1697 (but because of caching, not in the middle of a process), but all this is
1698 beyond the scope of these instructions.
1699
1700 =head1 BUGS
1701
1702 =head2 Interaction with Locales
1703
1704 Use of locales with Unicode data may lead to odd results.  Currently,
1705 Perl attempts to attach 8-bit locale info to characters in the range
1706 0..255, but this technique is demonstrably incorrect for locales that
1707 use characters above that range when mapped into Unicode.  Perl's
1708 Unicode support will also tend to run slower.  Use of locales with
1709 Unicode is discouraged.
1710
1711 =head2 Problems with characters in the Latin-1 Supplement range
1712
1713 See L</The "Unicode Bug">
1714
1715 =head2 Problems with case-insensitive regular expression matching
1716
1717 There are problems with case-insensitive matches, including those involving
1718 character classes (enclosed in [square brackets]), characters whose fold
1719 is to multiple characters (such as the single character LATIN SMALL LIGATURE
1720 FFL matches case-insensitively with the 3-character string C<ffl>), and
1721 characters in the Latin-1 Supplement.
1722
1723 =head2 Interaction with Extensions
1724
1725 When Perl exchanges data with an extension, the extension should be
1726 able to understand the UTF8 flag and act accordingly. If the
1727 extension doesn't know about the flag, it's likely that the extension
1728 will return incorrectly-flagged data.
1729
1730 So if you're working with Unicode data, consult the documentation of
1731 every module you're using if there are any issues with Unicode data
1732 exchange. If the documentation does not talk about Unicode at all,
1733 suspect the worst and probably look at the source to learn how the
1734 module is implemented. Modules written completely in Perl shouldn't
1735 cause problems. Modules that directly or indirectly access code written
1736 in other programming languages are at risk.
1737
1738 For affected functions, the simple strategy to avoid data corruption is
1739 to always make the encoding of the exchanged data explicit. Choose an
1740 encoding that you know the extension can handle. Convert arguments passed
1741 to the extensions to that encoding and convert results back from that
1742 encoding. Write wrapper functions that do the conversions for you, so
1743 you can later change the functions when the extension catches up.
1744
1745 To provide an example, let's say the popular Foo::Bar::escape_html
1746 function doesn't deal with Unicode data yet. The wrapper function
1747 would convert the argument to raw UTF-8 and convert the result back to
1748 Perl's internal representation like so:
1749
1750     sub my_escape_html ($) {
1751         my($what) = shift;
1752         return unless defined $what;
1753         Encode::decode_utf8(Foo::Bar::escape_html(
1754                                          Encode::encode_utf8($what)));
1755     }
1756
1757 Sometimes, when the extension does not convert data but just stores
1758 and retrieves them, you will be in a position to use the otherwise
1759 dangerous Encode::_utf8_on() function. Let's say the popular
1760 C<Foo::Bar> extension, written in C, provides a C<param> method that
1761 lets you store and retrieve data according to these prototypes:
1762
1763     $self->param($name, $value);            # set a scalar
1764     $value = $self->param($name);           # retrieve a scalar
1765
1766 If it does not yet provide support for any encoding, one could write a
1767 derived class with such a C<param> method:
1768
1769     sub param {
1770       my($self,$name,$value) = @_;
1771       utf8::upgrade($name);     # make sure it is UTF-8 encoded
1772       if (defined $value) {
1773         utf8::upgrade($value);  # make sure it is UTF-8 encoded
1774         return $self->SUPER::param($name,$value);
1775       } else {
1776         my $ret = $self->SUPER::param($name);
1777         Encode::_utf8_on($ret); # we know, it is UTF-8 encoded
1778         return $ret;
1779       }
1780     }
1781
1782 Some extensions provide filters on data entry/exit points, such as
1783 DB_File::filter_store_key and family. Look out for such filters in
1784 the documentation of your extensions, they can make the transition to
1785 Unicode data much easier.
1786
1787 =head2 Speed
1788
1789 Some functions are slower when working on UTF-8 encoded strings than
1790 on byte encoded strings.  All functions that need to hop over
1791 characters such as length(), substr() or index(), or matching regular
1792 expressions can work B<much> faster when the underlying data are
1793 byte-encoded.
1794
1795 In Perl 5.8.0 the slowness was often quite spectacular; in Perl 5.8.1
1796 a caching scheme was introduced which will hopefully make the slowness
1797 somewhat less spectacular, at least for some operations.  In general,
1798 operations with UTF-8 encoded strings are still slower. As an example,
1799 the Unicode properties (character classes) like C<\p{Nd}> are known to
1800 be quite a bit slower (5-20 times) than their simpler counterparts
1801 like C<\d> (then again, there 268 Unicode characters matching C<Nd>
1802 compared with the 10 ASCII characters matching C<d>).
1803
1804 =head2 Problems on EBCDIC platforms
1805
1806 There are a number of known problems with Perl on EBCDIC platforms.  If you
1807 want to use Perl there, send email to perlbug@perl.org.
1808
1809 In earlier versions, when byte and character data were concatenated,
1810 the new string was sometimes created by
1811 decoding the byte strings as I<ISO 8859-1 (Latin-1)>, even if the
1812 old Unicode string used EBCDIC.
1813
1814 If you find any of these, please report them as bugs.
1815
1816 =head2 Porting code from perl-5.6.X
1817
1818 Perl 5.8 has a different Unicode model from 5.6. In 5.6 the programmer
1819 was required to use the C<utf8> pragma to declare that a given scope
1820 expected to deal with Unicode data and had to make sure that only
1821 Unicode data were reaching that scope. If you have code that is
1822 working with 5.6, you will need some of the following adjustments to
1823 your code. The examples are written such that the code will continue
1824 to work under 5.6, so you should be safe to try them out.
1825
1826 =over 4
1827
1828 =item *
1829
1830 A filehandle that should read or write UTF-8
1831
1832   if ($] > 5.007) {
1833     binmode $fh, ":encoding(utf8)";
1834   }
1835
1836 =item *
1837
1838 A scalar that is going to be passed to some extension
1839
1840 Be it Compress::Zlib, Apache::Request or any extension that has no
1841 mention of Unicode in the manpage, you need to make sure that the
1842 UTF8 flag is stripped off. Note that at the time of this writing
1843 (October 2002) the mentioned modules are not UTF-8-aware. Please
1844 check the documentation to verify if this is still true.
1845
1846   if ($] > 5.007) {
1847     require Encode;
1848     $val = Encode::encode_utf8($val); # make octets
1849   }
1850
1851 =item *
1852
1853 A scalar we got back from an extension
1854
1855 If you believe the scalar comes back as UTF-8, you will most likely
1856 want the UTF8 flag restored:
1857
1858   if ($] > 5.007) {
1859     require Encode;
1860     $val = Encode::decode_utf8($val);
1861   }
1862
1863 =item *
1864
1865 Same thing, if you are really sure it is UTF-8
1866
1867   if ($] > 5.007) {
1868     require Encode;
1869     Encode::_utf8_on($val);
1870   }
1871
1872 =item *
1873
1874 A wrapper for fetchrow_array and fetchrow_hashref
1875
1876 When the database contains only UTF-8, a wrapper function or method is
1877 a convenient way to replace all your fetchrow_array and
1878 fetchrow_hashref calls. A wrapper function will also make it easier to
1879 adapt to future enhancements in your database driver. Note that at the
1880 time of this writing (October 2002), the DBI has no standardized way
1881 to deal with UTF-8 data. Please check the documentation to verify if
1882 that is still true.
1883
1884   sub fetchrow {
1885     # $what is one of fetchrow_{array,hashref}
1886     my($self, $sth, $what) = @_;
1887     if ($] < 5.007) {
1888       return $sth->$what;
1889     } else {
1890       require Encode;
1891       if (wantarray) {
1892         my @arr = $sth->$what;
1893         for (@arr) {
1894           defined && /[^\000-\177]/ && Encode::_utf8_on($_);
1895         }
1896         return @arr;
1897       } else {
1898         my $ret = $sth->$what;
1899         if (ref $ret) {
1900           for my $k (keys %$ret) {
1901             defined
1902             && /[^\000-\177]/
1903             && Encode::_utf8_on($_) for $ret->{$k};
1904           }
1905           return $ret;
1906         } else {
1907           defined && /[^\000-\177]/ && Encode::_utf8_on($_) for $ret;
1908           return $ret;
1909         }
1910       }
1911     }
1912   }
1913
1914
1915 =item *
1916
1917 A large scalar that you know can only contain ASCII
1918
1919 Scalars that contain only ASCII and are marked as UTF-8 are sometimes
1920 a drag to your program. If you recognize such a situation, just remove
1921 the UTF8 flag:
1922
1923   utf8::downgrade($val) if $] > 5.007;
1924
1925 =back
1926
1927 =head1 SEE ALSO
1928
1929 L<perlunitut>, L<perluniintro>, L<perluniprops>, L<Encode>, L<open>, L<utf8>, L<bytes>,
1930 L<perlretut>, L<perlvar/"${^UNICODE}">
1931 L<http://www.unicode.org/reports/tr44>).
1932
1933 =cut