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