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