3 perlunicode - Unicode support in Perl
7 =head2 Important Caveats
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.
15 =item Input and Output Disciplines
17 A filehandle can be marked as containing perl's internal Unicode
18 encoding (UTF-8 or UTF-EBCDIC) by opening it with the ":utf8" layer.
19 Other encodings can be converted to perl's encoding on input, or from
20 perl's encoding on output by use of the ":encoding(...)" layer.
23 To mark the Perl source itself as being in a particular encoding,
26 =item Regular Expressions
28 The regular expression compiler produces polymorphic opcodes. That is,
29 the pattern adapts to the data and automatically switch to the Unicode
30 character scheme when presented with Unicode data, or a traditional
31 byte scheme when presented with byte data.
33 =item C<use utf8> still needed to enable UTF-8/UTF-EBCDIC in scripts
35 As a compatibility measure, this pragma must be explicitly used to
36 enable recognition of UTF-8 in the Perl scripts themselves on ASCII
37 based machines, or to recognize UTF-EBCDIC on EBCDIC based machines.
38 B<NOTE: this should be the only place where an explicit C<use utf8>
41 You can also use the C<encoding> pragma to change the default encoding
42 of the data in your script; see L<encoding>.
46 =head2 Byte and Character semantics
48 Beginning with version 5.6, Perl uses logically wide characters to
49 represent strings internally.
51 In future, Perl-level operations can be expected to work with
52 characters rather than bytes, in general.
54 However, as strictly an interim compatibility measure, Perl aims to
55 provide a safe migration path from byte semantics to character
56 semantics for programs. For operations where Perl can unambiguously
57 decide that the input data is characters, Perl now switches to
58 character semantics. For operations where this determination cannot
59 be made without additional information from the user, Perl decides in
60 favor of compatibility, and chooses to use byte semantics.
62 This behavior preserves compatibility with earlier versions of Perl,
63 which allowed byte semantics in Perl operations, but only as long as
64 none of the program's inputs are marked as being as source of Unicode
65 character data. Such data may come from filehandles, from calls to
66 external programs, from information provided by the system (such as %ENV),
67 or from literals and constants in the source text.
69 On Windows platforms, if the C<-C> command line switch is used, (or the
70 ${^WIDE_SYSTEM_CALLS} global flag is set to C<1>), all system calls
71 will use the corresponding wide character APIs. Note that this is
72 currently only implemented on Windows since other platforms lack an
73 API standard on this area.
75 Regardless of the above, the C<bytes> pragma can always be used to
76 force byte semantics in a particular lexical scope. See L<bytes>.
78 The C<utf8> pragma is primarily a compatibility device that enables
79 recognition of UTF-(8|EBCDIC) in literals encountered by the parser.
80 Note that this pragma is only required until a future version of Perl
81 in which character semantics will become the default. This pragma may
82 then become a no-op. See L<utf8>.
84 Unless mentioned otherwise, Perl operators will use character semantics
85 when they are dealing with Unicode data, and byte semantics otherwise.
86 Thus, character semantics for these operations apply transparently; if
87 the input data came from a Unicode source (for example, by adding a
88 character encoding discipline to the filehandle whence it came, or a
89 literal Unicode string constant in the program), character semantics
90 apply; otherwise, byte semantics are in effect. To force byte semantics
91 on Unicode data, the C<bytes> pragma should be used.
93 Notice that if you concatenate strings with byte semantics and strings
94 with Unicode character data, the bytes will by default be upgraded
95 I<as if they were ISO 8859-1 (Latin-1)> (or if in EBCDIC, after a
96 translation to ISO 8859-1). This is done without regard to the
97 system's native 8-bit encoding, so to change this for systems with
98 non-Latin-1 (or non-EBCDIC) native encodings, use the C<encoding>
99 pragma, see L<encoding>.
101 Under character semantics, many operations that formerly operated on
102 bytes change to operating on characters. A character in Perl is
103 logically just a number ranging from 0 to 2**31 or so. Larger
104 characters may encode to longer sequences of bytes internally, but
105 this is just an internal detail which is hidden at the Perl level.
106 See L<perluniintro> for more on this.
108 =head2 Effects of character semantics
110 Character semantics have the following effects:
116 Strings (including hash keys) and regular expression patterns may
117 contain characters that have an ordinal value larger than 255.
119 If you use a Unicode editor to edit your program, Unicode characters
120 may occur directly within the literal strings in one of the various
121 Unicode encodings (UTF-8, UTF-EBCDIC, UCS-2, etc.), but are recognized
122 as such (and converted to Perl's internal representation) only if the
123 appropriate L<encoding> is specified.
125 You can also get Unicode characters into a string by using the C<\x{...}>
126 notation, putting the Unicode code for the desired character, in
127 hexadecimal, into the curlies. For instance, a smiley face is C<\x{263A}>.
128 This works only for characters with a code 0x100 and above.
132 use charnames ':full';
134 you can use the C<\N{...}> notation, putting the official Unicode character
135 name within the curlies. For example, C<\N{WHITE SMILING FACE}>.
136 This works for all characters that have names.
140 If an appropriate L<encoding> is specified, identifiers within the
141 Perl script may contain Unicode alphanumeric characters, including
142 ideographs. (You are currently on your own when it comes to using the
143 canonical forms of characters--Perl doesn't (yet) attempt to
144 canonicalize variable names for you.)
148 Regular expressions match characters instead of bytes. For instance,
149 "." matches a character instead of a byte. (However, the C<\C> pattern
150 is provided to force a match a single byte ("C<char>" in C, hence C<\C>).)
154 Character classes in regular expressions match characters instead of
155 bytes, and match against the character properties specified in the
156 Unicode properties database. So C<\w> can be used to match an
157 ideograph, for instance.
161 Named Unicode properties, scripts, and block ranges may be used like
162 character classes via the new C<\p{}> (matches property) and C<\P{}>
163 (doesn't match property) constructs. For instance, C<\p{Lu}> matches any
164 character with the Unicode "Lu" (Letter, uppercase) property, while
165 C<\p{M}> matches any character with a "M" (mark -- accents and such)
166 property. Single letter properties may omit the brackets, so that can be
167 written C<\pM> also. Many predefined properties are available, such
168 as C<\p{Mirrored}> and C<\p{Tibetan}>.
170 The official Unicode script and block names have spaces and dashes as
171 separators, but for convenience you can have dashes, spaces, and underbars
172 at every word division, and you need not care about correct casing. It is
173 recommended, however, that for consistency you use the following naming:
174 the official Unicode script, block, or property name (see below for the
175 additional rules that apply to block names), with whitespace and dashes
176 removed, and the words "uppercase-first-lowercase-rest". That is, "Latin-1
177 Supplement" becomes "Latin1Supplement".
179 You can also negate both C<\p{}> and C<\P{}> by introducing a caret
180 (^) between the first curly and the property name: C<\p{^Tamil}> is
181 equal to C<\P{Tamil}>.
183 Here are the basic Unicode General Category properties, followed by their
184 long form (you can use either, e.g. C<\p{Lu}> and C<\p{LowercaseLetter}>
207 Pc ConnectorPunctuation
211 Pi InitialPunctuation
212 (may behave like Ps or Pe depending on usage)
214 (may behave like Ps or Pe depending on usage)
226 Zp ParagraphSeparator
231 Cs Surrogate (not usable)
235 The single-letter properties match all characters in any of the
236 two-letter sub-properties starting with the same letter.
237 There's also C<L&> which is an alias for C<Ll>, C<Lu>, and C<Lt>.
239 Because Perl hides the need for the user to understand the internal
240 representation of Unicode characters, it has no need to support the
241 somewhat messy concept of surrogates. Therefore, the C<Cs> property is not
244 Because scripts differ in their directionality (for example Hebrew is
245 written right to left), Unicode supplies these properties:
250 BidiLRE Left-to-Right Embedding
251 BidiLRO Left-to-Right Override
253 BidiAL Right-to-Left Arabic
254 BidiRLE Right-to-Left Embedding
255 BidiRLO Right-to-Left Override
256 BidiPDF Pop Directional Format
257 BidiEN European Number
258 BidiES European Number Separator
259 BidiET European Number Terminator
261 BidiCS Common Number Separator
262 BidiNSM Non-Spacing Mark
263 BidiBN Boundary Neutral
264 BidiB Paragraph Separator
265 BidiS Segment Separator
267 BidiON Other Neutrals
269 For example, C<\p{BidiR}> matches all characters that are normally
270 written right to left.
276 The scripts available via C<\p{...}> and C<\P{...}>, for example
277 C<\p{Latin}> or C<\p{Cyrillic}>, are as follows:
324 There are also extended property classes that supplement the basic
325 properties, defined by the F<PropList> Unicode database:
340 LogicalOrderException
341 NoncharacterCodePoint
343 OtherDefaultIgnorableCodePoint
355 and further derived properties:
357 Alphabetic Lu + Ll + Lt + Lm + Lo + OtherAlphabetic
358 Lowercase Ll + OtherLowercase
359 Uppercase Lu + OtherUppercase
362 ID_Start Lu + Ll + Lt + Lm + Lo + Nl
363 ID_Continue ID_Start + Mn + Mc + Nd + Pc
366 Assigned Any non-Cn character (i.e. synonym for \P{Cn})
367 Unassigned Synonym for \p{Cn}
368 Common Any character (or unassigned code point)
369 not explicitly assigned to a script
371 For backward compatibility, all properties mentioned so far may have C<Is>
372 prepended to their name (e.g. C<\P{IsLu}> is equal to C<\P{Lu}>).
376 In addition to B<scripts>, Unicode also defines B<blocks> of characters.
377 The difference between scripts and blocks is that the scripts concept is
378 closer to natural languages, while the blocks concept is more an artificial
379 grouping based on groups of mostly 256 Unicode characters. For example, the
380 C<Latin> script contains letters from many blocks. On the other hand, the
381 C<Latin> script does not contain all the characters from those blocks. It
382 does not, for example, contain digits because digits are shared across many
383 scripts. Digits and other similar groups, like punctuation, are in a
384 category called C<Common>.
386 For more about scripts, see the UTR #24:
388 http://www.unicode.org/unicode/reports/tr24/
390 For more about blocks, see:
392 http://www.unicode.org/Public/UNIDATA/Blocks.txt
394 Blocks names are given with the C<In> prefix. For example, the
395 Katakana block is referenced via C<\p{InKatakana}>. The C<In>
396 prefix may be omitted if there is no naming conflict with a script
397 or any other property, but it is recommended that C<In> always be used
400 These block names are supported:
402 InAlphabeticPresentationForms
404 InArabicPresentationFormsA
405 InArabicPresentationFormsB
416 InByzantineMusicalSymbols
418 InCJKCompatibilityForms
419 InCJKCompatibilityIdeographs
420 InCJKCompatibilityIdeographsSupplement
421 InCJKRadicalsSupplement
422 InCJKSymbolsAndPunctuation
423 InCJKUnifiedIdeographs
424 InCJKUnifiedIdeographsExtensionA
425 InCJKUnifiedIdeographsExtensionB
427 InCombiningDiacriticalMarks
428 InCombiningDiacriticalMarksforSymbols
433 InCyrillicSupplementary
437 InEnclosedAlphanumerics
438 InEnclosedCJKLettersAndMonths
448 InHalfwidthAndFullwidthForms
449 InHangulCompatibilityJamo
454 InHighPrivateUseSurrogates
458 InIdeographicDescriptionCharacters
463 InKatakanaPhoneticExtensions
468 InLatinExtendedAdditional
473 InMathematicalAlphanumericSymbols
474 InMathematicalOperators
475 InMiscellaneousMathematicalSymbolsA
476 InMiscellaneousMathematicalSymbolsB
477 InMiscellaneousSymbols
478 InMiscellaneousTechnical
485 InOpticalCharacterRecognition
491 InSpacingModifierLetters
493 InSuperscriptsAndSubscripts
494 InSupplementalArrowsA
495 InSupplementalArrowsB
496 InSupplementalMathematicalOperators
497 InSupplementaryPrivateUseAreaA
498 InSupplementaryPrivateUseAreaB
508 InUnifiedCanadianAboriginalSyllabics
517 The special pattern C<\X> matches any extended Unicode sequence
518 (a "combining character sequence" in Standardese), where the first
519 character is a base character and subsequent characters are mark
520 characters that apply to the base character. It is equivalent to
525 The C<tr///> operator translates characters instead of bytes. Note
526 that the C<tr///CU> functionality has been removed, as the interface
527 was a mistake. For similar functionality see pack('U0', ...) and
532 Case translation operators use the Unicode case translation tables
533 when provided character input. Note that C<uc()> (also known as C<\U>
534 in doublequoted strings) translates to uppercase, while C<ucfirst>
535 (also known as C<\u> in doublequoted strings) translates to titlecase
536 (for languages that make the distinction). Naturally the
537 corresponding backslash sequences have the same semantics.
541 Most operators that deal with positions or lengths in the string will
542 automatically switch to using character positions, including
543 C<chop()>, C<substr()>, C<pos()>, C<index()>, C<rindex()>,
544 C<sprintf()>, C<write()>, and C<length()>. Operators that
545 specifically don't switch include C<vec()>, C<pack()>, and
546 C<unpack()>. Operators that really don't care include C<chomp()>, as
547 well as any other operator that treats a string as a bucket of bits,
548 such as C<sort()>, and the operators dealing with filenames.
552 The C<pack()>/C<unpack()> letters "C<c>" and "C<C>" do I<not> change,
553 since they're often used for byte-oriented formats. (Again, think
554 "C<char>" in the C language.) However, there is a new "C<U>" specifier
555 that will convert between Unicode characters and integers.
559 The C<chr()> and C<ord()> functions work on characters. This is like
560 C<pack("U")> and C<unpack("U")>, not like C<pack("C")> and
561 C<unpack("C")>. In fact, the latter are how you now emulate
562 byte-oriented C<chr()> and C<ord()> for Unicode strings.
563 (Note that this reveals the internal encoding of Unicode strings,
564 which is not something one normally needs to care about at all.)
568 The bit string operators C<& | ^ ~> can operate on character data.
569 However, for backward compatibility reasons (bit string operations
570 when the characters all are less than 256 in ordinal value) one should
571 not mix C<~> (the bit complement) and characters both less than 256 and
572 equal or greater than 256. Most importantly, the DeMorgan's laws
573 (C<~($x|$y) eq ~$x&~$y>, C<~($x&$y) eq ~$x|~$y>) won't hold.
574 Another way to look at this is that the complement cannot return
575 B<both> the 8-bit (byte) wide bit complement B<and> the full character
580 lc(), uc(), lcfirst(), and ucfirst() work for the following cases:
586 the case mapping is from a single Unicode character to another
587 single Unicode character
591 the case mapping is from a single Unicode character to more
592 than one Unicode character
596 What doesn't yet work are the following cases:
602 the "final sigma" (Greek)
606 anything to with locales (Lithuanian, Turkish, Azeri)
610 See the Unicode Technical Report #21, Case Mappings, for more details.
614 And finally, C<scalar reverse()> reverses by character rather than by byte.
618 =head2 Character encodings for input and output
622 =head2 Unicode Regular Expression Support Level
624 The following list of Unicode regular expression support describes
625 feature by feature the Unicode support implemented in Perl as of Perl
626 5.8.0. The "Level N" and the section numbers refer to the Unicode
627 Technical Report 18, "Unicode Regular Expression Guidelines".
633 Level 1 - Basic Unicode Support
635 2.1 Hex Notation - done [1]
636 Named Notation - done [2]
637 2.2 Categories - done [3][4]
638 2.3 Subtraction - MISSING [5][6]
639 2.4 Simple Word Boundaries - done [7]
640 2.5 Simple Loose Matches - done [8]
641 2.6 End of Line - MISSING [9][10]
645 [ 3] . \p{...} \P{...}
646 [ 4] now scripts (see UTR#24 Script Names) in addition to blocks
648 [ 6] can use look-ahead to emulate subtraction (*)
649 [ 7] include Letters in word characters
650 [ 8] note that perl does Full casefolding in matching, not Simple:
651 for example U+1F88 is equivalent with U+1F000 U+03B9,
652 not with 1F80. This difference matters for certain Greek
653 capital letters with certain modifiers: the Full casefolding
654 decomposes the letter, while the Simple casefolding would map
655 it to a single character.
656 [ 9] see UTR#13 Unicode Newline Guidelines
657 [10] should do ^ and $ also on \x{85}, \x{2028} and \x{2029})
658 (should also affect <>, $., and script line numbers)
659 (the \x{85}, \x{2028} and \x{2029} do match \s)
661 (*) You can mimic class subtraction using lookahead.
662 For example, what TR18 might write as
664 [{Greek}-[{UNASSIGNED}]]
666 in Perl can be written as:
668 (?!\p{Unassigned})\p{InGreekAndCoptic}
669 (?=\p{Assigned})\p{InGreekAndCoptic}
671 But in this particular example, you probably really want
675 which will match assigned characters known to be part of the Greek script.
679 Level 2 - Extended Unicode Support
681 3.1 Surrogates - MISSING
682 3.2 Canonical Equivalents - MISSING [11][12]
683 3.3 Locale-Independent Graphemes - MISSING [13]
684 3.4 Locale-Independent Words - MISSING [14]
685 3.5 Locale-Independent Loose Matches - MISSING [15]
687 [11] see UTR#15 Unicode Normalization
688 [12] have Unicode::Normalize but not integrated to regexes
689 [13] have \X but at this level . should equal that
690 [14] need three classes, not just \w and \W
691 [15] see UTR#21 Case Mappings
695 Level 3 - Locale-Sensitive Support
697 4.1 Locale-Dependent Categories - MISSING
698 4.2 Locale-Dependent Graphemes - MISSING [16][17]
699 4.3 Locale-Dependent Words - MISSING
700 4.4 Locale-Dependent Loose Matches - MISSING
701 4.5 Locale-Dependent Ranges - MISSING
703 [16] see UTR#10 Unicode Collation Algorithms
704 [17] have Unicode::Collate but not integrated to regexes
708 =head2 Unicode Encodings
710 Unicode characters are assigned to I<code points> which are abstract
711 numbers. To use these numbers various encodings are needed.
719 UTF-8 is a variable-length (1 to 6 bytes, current character allocations
720 require 4 bytes), byteorder independent encoding. For ASCII, UTF-8 is
721 transparent (and we really do mean 7-bit ASCII, not another 8-bit encoding).
723 The following table is from Unicode 3.2.
725 Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte
727 U+0000..U+007F 00..7F
728 U+0080..U+07FF C2..DF 80..BF
729 U+0800..U+0FFF E0 A0..BF 80..BFÂ Â
730 U+1000..U+CFFF E1..EC 80..BF 80..BFÂ Â
731 U+D000..U+D7FF ED 80..9F 80..BFÂ Â
732 U+D800..U+DFFF ******* ill-formed *******
733 U+E000..U+FFFF EE..EF 80..BF 80..BFÂ Â
734 U+10000..U+3FFFF F0 90..BF 80..BF 80..BF
735 U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF
736 U+100000..U+10FFFF F4 80..8F 80..BF 80..BF
738 Note the A0..BF in U+0800..U+0FFF, the 80..9F in U+D000...U+D7FF,
739 the 90..BF in U+10000..U+3FFFF, and the 80...8F in U+100000..U+10FFFF.
740 The "gaps" are caused by legal UTF-8 avoiding non-shortest encodings:
741 it is technically possible to UTF-8-encode a single code point in different
742 ways, but that is explicitly forbidden, and the shortest possible encoding
743 should always be used (and that is what Perl does).
745 Or, another way to look at it, as bits:
747 Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte
750 00000bbbbbaaaaaa 110bbbbb 10aaaaaa
751 ccccbbbbbbaaaaaa 1110cccc 10bbbbbb 10aaaaaa
752 00000dddccccccbbbbbbaaaaaa 11110ddd 10cccccc 10bbbbbb 10aaaaaa
754 As you can see, the continuation bytes all begin with C<10>, and the
755 leading bits of the start byte tell how many bytes the are in the
762 Like UTF-8, but EBCDIC-safe, as UTF-8 is ASCII-safe.
766 UTF-16, UTF-16BE, UTF16-LE, Surrogates, and BOMs (Byte Order Marks)
768 (The followings items are mostly for reference, Perl doesn't
769 use them internally.)
771 UTF-16 is a 2 or 4 byte encoding. The Unicode code points
772 0x0000..0xFFFF are stored in two 16-bit units, and the code points
773 0x010000..0x10FFFF in two 16-bit units. The latter case is
774 using I<surrogates>, the first 16-bit unit being the I<high
775 surrogate>, and the second being the I<low surrogate>.
777 Surrogates are code points set aside to encode the 0x01000..0x10FFFF
778 range of Unicode code points in pairs of 16-bit units. The I<high
779 surrogates> are the range 0xD800..0xDBFF, and the I<low surrogates>
780 are the range 0xDC00..0xDFFFF. The surrogate encoding is
782 $hi = ($uni - 0x10000) / 0x400 + 0xD800;
783 $lo = ($uni - 0x10000) % 0x400 + 0xDC00;
787 $uni = 0x10000 + ($hi - 0xD800) * 0x400 + ($lo - 0xDC00);
789 If you try to generate surrogates (for example by using chr()), you
790 will get a warning if warnings are turned on (C<-w> or C<use
791 warnings;>) because those code points are not valid for a Unicode
794 Because of the 16-bitness, UTF-16 is byteorder dependent. UTF-16
795 itself can be used for in-memory computations, but if storage or
796 transfer is required, either UTF-16BE (Big Endian) or UTF-16LE
797 (Little Endian) must be chosen.
799 This introduces another problem: what if you just know that your data
800 is UTF-16, but you don't know which endianness? Byte Order Marks
801 (BOMs) are a solution to this. A special character has been reserved
802 in Unicode to function as a byte order marker: the character with the
803 code point 0xFEFF is the BOM.
805 The trick is that if you read a BOM, you will know the byte order,
806 since if it was written on a big endian platform, you will read the
807 bytes 0xFE 0xFF, but if it was written on a little endian platform,
808 you will read the bytes 0xFF 0xFE. (And if the originating platform
809 was writing in UTF-8, you will read the bytes 0xEF 0xBB 0xBF.)
811 The way this trick works is that the character with the code point
812 0xFFFE is guaranteed not to be a valid Unicode character, so the
813 sequence of bytes 0xFF 0xFE is unambiguously "BOM, represented in
814 little-endian format" and cannot be "0xFFFE, represented in big-endian
819 UTF-32, UTF-32BE, UTF32-LE
821 The UTF-32 family is pretty much like the UTF-16 family, expect that
822 the units are 32-bit, and therefore the surrogate scheme is not
823 needed. The BOM signatures will be 0x00 0x00 0xFE 0xFF for BE and
824 0xFF 0xFE 0x00 0x00 for LE.
830 Encodings defined by the ISO 10646 standard. UCS-2 is a 16-bit
831 encoding, UCS-4 is a 32-bit encoding. Unlike UTF-16, UCS-2
832 is not extensible beyond 0xFFFF, because it does not use surrogates.
838 A seven-bit safe (non-eight-bit) encoding, useful if the
839 transport/storage is not eight-bit safe. Defined by RFC 2152.
843 =head2 Security Implications of Unicode
851 Unfortunately, the specification of UTF-8 leaves some room for
852 interpretation of how many bytes of encoded output one should generate
853 from one input Unicode character. Strictly speaking, one is supposed
854 to always generate the shortest possible sequence of UTF-8 bytes,
855 because otherwise there is potential for input buffer overflow at
856 the receiving end of a UTF-8 connection. Perl always generates the
857 shortest length UTF-8, and with warnings on (C<-w> or C<use
858 warnings;>) Perl will warn about non-shortest length UTF-8 (and other
859 malformations, too, such as the surrogates, which are not real
860 Unicode code points.)
864 Regular expressions behave slightly differently between byte data and
865 character (Unicode data). For example, the "word character" character
866 class C<\w> will work differently when the data is all eight-bit bytes
867 or when the data is Unicode.
869 In the first case, the set of C<\w> characters is either small (the
870 default set of alphabetic characters, digits, and the "_"), or, if you
871 are using a locale (see L<perllocale>), the C<\w> might contain a few
872 more letters according to your language and country.
874 In the second case, the C<\w> set of characters is much, much larger,
875 and most importantly, even in the set of the first 256 characters, it
876 will most probably be different: as opposed to most locales (which are
877 specific to a language and country pair) Unicode classifies all the
878 characters that are letters as C<\w>. For example: your locale might
879 not think that LATIN SMALL LETTER ETH is a letter (unless you happen
880 to speak Icelandic), but Unicode does.
882 As discussed elsewhere, Perl tries to stand one leg (two legs, being
883 a quadruped camel?) in two worlds: the old world of byte and the new
884 world of characters, upgrading from bytes to characters when necessary.
885 If your legacy code is not explicitly using Unicode, no automatic
886 switchover to characters should happen, and characters shouldn't get
887 downgraded back to bytes, either. It is possible to accidentally mix
888 bytes and characters, however (see L<perluniintro>), in which case the
889 C<\w> might start behaving differently. Review your code.
893 =head2 Unicode in Perl on EBCDIC
895 The way Unicode is handled on EBCDIC platforms is still rather
896 experimental. On such a platform, references to UTF-8 encoding in this
897 document and elsewhere should be read as meaning UTF-EBCDIC as
898 specified in Unicode Technical Report 16 unless ASCII vs EBCDIC issues
899 are specifically discussed. There is no C<utfebcdic> pragma or
900 ":utfebcdic" layer, rather, "utf8" and ":utf8" are re-used to mean
901 the platform's "natural" 8-bit encoding of Unicode. See L<perlebcdic>
902 for more discussion of the issues.
906 Usually locale settings and Unicode do not affect each other, but
907 there are a couple of exceptions:
913 If your locale environment variables (LANGUAGE, LC_ALL, LC_CTYPE, LANG)
914 contain the strings 'UTF-8' or 'UTF8' (case-insensitive matching),
915 the default encoding of your STDIN, STDOUT, and STDERR, and of
916 B<any subsequent file open>, is UTF-8.
920 Perl tries really hard to work both with Unicode and the old byte
921 oriented world: most often this is nice, but sometimes this causes
926 =head2 Using Unicode in XS
928 If you want to handle Perl Unicode in XS extensions, you may find
929 the following C APIs useful (see perlapi for details):
935 DO_UTF8(sv) returns true if the UTF8 flag is on and the bytes pragma
936 is not in effect. SvUTF8(sv) returns true is the UTF8 flag is on, the
937 bytes pragma is ignored. The UTF8 flag being on does B<not> mean that
938 there are any characters of code points greater than 255 (or 127) in
939 the scalar, or that there even are any characters in the scalar.
940 What the UTF8 flag means is that the sequence of octets in the
941 representation of the scalar is the sequence of UTF-8 encoded
942 code points of the characters of a string. The UTF8 flag being
943 off means that each octet in this representation encodes a single
944 character with codepoint 0..255 within the string. Perl's Unicode
945 model is not to use UTF-8 until it's really necessary.
949 uvuni_to_utf8(buf, chr) writes a Unicode character code point into a
950 buffer encoding the code point as UTF-8, and returns a pointer
951 pointing after the UTF-8 bytes.
955 utf8_to_uvuni(buf, lenp) reads UTF-8 encoded bytes from a buffer and
956 returns the Unicode character code point (and optionally the length of
957 the UTF-8 byte sequence).
961 utf8_length(start, end) returns the length of the UTF-8 encoded buffer
962 in characters. sv_len_utf8(sv) returns the length of the UTF-8 encoded
967 sv_utf8_upgrade(sv) converts the string of the scalar to its UTF-8
968 encoded form. sv_utf8_downgrade(sv) does the opposite (if possible).
969 sv_utf8_encode(sv) is like sv_utf8_upgrade but the UTF8 flag does not
970 get turned on. sv_utf8_decode() does the opposite of sv_utf8_encode().
971 Note that none of these are to be used as general purpose encoding/decoding
972 interfaces: use Encode for that. sv_utf8_upgrade() is affected by the
973 encoding pragma, but sv_utf8_downgrade() is not (since the encoding
974 pragma is designed to be a one-way street).
978 is_utf8_char(s) returns true if the pointer points to a valid UTF-8
983 is_utf8_string(buf, len) returns true if the len bytes of the buffer
988 UTF8SKIP(buf) will return the number of bytes in the UTF-8 encoded
989 character in the buffer. UNISKIP(chr) will return the number of bytes
990 required to UTF-8-encode the Unicode character code point. UTF8SKIP()
991 is useful for example for iterating over the characters of a UTF-8
992 encoded buffer; UNISKIP() is useful for example in computing
993 the size required for a UTF-8 encoded buffer.
997 utf8_distance(a, b) will tell the distance in characters between the
998 two pointers pointing to the same UTF-8 encoded buffer.
1002 utf8_hop(s, off) will return a pointer to an UTF-8 encoded buffer that
1003 is C<off> (positive or negative) Unicode characters displaced from the
1004 UTF-8 buffer C<s>. Be careful not to overstep the buffer: utf8_hop()
1005 will merrily run off the end or the beginning if told to do so.
1009 pv_uni_display(dsv, spv, len, pvlim, flags) and sv_uni_display(dsv,
1010 ssv, pvlim, flags) are useful for debug output of Unicode strings and
1011 scalars. By default they are useful only for debug: they display
1012 B<all> characters as hexadecimal code points, but with the flags
1013 UNI_DISPLAY_ISPRINT and UNI_DISPLAY_BACKSLASH you can make the output
1018 ibcmp_utf8(s1, pe1, u1, l1, u1, s2, pe2, l2, u2) can be used to
1019 compare two strings case-insensitively in Unicode.
1020 (For case-sensitive comparisons you can just use memEQ() and memNE()
1025 For more information, see L<perlapi>, and F<utf8.c> and F<utf8.h>
1026 in the Perl source code distribution.
1030 =head2 Interaction with locales
1032 Use of locales with Unicode data may lead to odd results. Currently
1033 there is some attempt to apply 8-bit locale info to characters in the
1034 range 0..255, but this is demonstrably incorrect for locales that use
1035 characters above that range when mapped into Unicode. It will also
1036 tend to run slower. Use of locales with Unicode is discouraged.
1038 =head2 Interaction with extensions
1040 When perl exchanges data with an extension, the extension should be
1041 able to understand the UTF-8 flag and act accordingly. If the
1042 extension doesn't know about the flag, the risk is high that it will
1043 return data that are incorrectly flagged.
1045 So if you're working with Unicode data, consult the documentation of
1046 every module you're using if there are any issues with Unicode data
1047 exchange. If the documentation does not talk about Unicode at all,
1048 suspect the worst and probably look at the source how the module is
1049 implemented. Modules written completely in perl shouldn't cause
1050 problems. Modules that directly or indirectly access code written in
1051 other programming languages are at risk.
1053 For affected functions the simple strategy to avoid data corruption is
1054 to always make the encoding of the exchanged data explicit. Choose an
1055 encoding you know the extension can handle. Convert arguments passed
1056 to the extensions to that encoding and convert results back from that
1057 encoding. Write wrapper functions that do the conversions for you, so
1058 you can later change the functions when the extension catches up.
1060 To provide an example let's say the popular Foo::Bar::escape_html
1061 function doesn't deal with Unicode data yet. The wrapper function
1062 would convert the argument to raw UTF-8 and convert the result back to
1063 perl's internal representation like so:
1065 sub my_escape_html ($) {
1067 return unless defined $what;
1068 Encode::decode_utf8(Foo::Bar::escape_html(Encode::encode_utf8($what)));
1071 Sometimes, when the extension does not convert data but just stores
1072 and retrieves them, you will be in a position to use the otherwise
1073 dangerous Encode::_utf8_on() function. Let's say the popular
1074 C<Foo::Bar> extension, written in C, provides a C<param> method that
1075 lets you store and retrieve data according to these prototypes:
1077 $self->param($name, $value); # set a scalar
1078 $value = $self->param($name); # retrieve a scalar
1080 If it does not yet provide support for any encoding, one could write a
1081 derived class with such a C<param> method:
1084 my($self,$name,$value) = @_;
1085 utf8::upgrade($name); # make sure it is UTF-8 encoded
1087 utf8::upgrade($value); # make sure it is UTF-8 encoded
1088 return $self->SUPER::param($name,$value);
1090 my $ret = $self->SUPER::param($name);
1091 Encode::_utf8_on($ret); # we know, it is UTF-8 encoded
1096 Some extensions provide filters on data entry/exit points, as e.g.
1097 DB_File::filter_store_key and family. Watch out for such filters in
1098 the documentation of your extensions, they can make the transition to
1099 Unicode data much easier.
1103 Some functions are slower when working on UTF-8 encoded strings than
1104 on byte encoded strings. All functions that need to hop over
1105 characters such as length(), substr() or index() can work B<much>
1106 faster when the underlying data are byte-encoded. Witness the
1107 following benchmark:
1113 our $u = our $b = "x" x $l;
1114 substr($u,0,1) = "\x{100}";
1116 LENGTH_B => q{ length($b) },
1117 LENGTH_U => q{ length($u) },
1118 SUBSTR_B => q{ substr($b, $l/4, $l/2) },
1119 SUBSTR_U => q{ substr($u, $l/4, $l/2) },
1122 Benchmark: running LENGTH_B, LENGTH_U, SUBSTR_B, SUBSTR_U for at least 2 CPU seconds...
1123 LENGTH_B: 2 wallclock secs ( 2.36 usr + 0.00 sys = 2.36 CPU) @ 5649983.05/s (n=13333960)
1124 LENGTH_U: 2 wallclock secs ( 2.11 usr + 0.00 sys = 2.11 CPU) @ 12155.45/s (n=25648)
1125 SUBSTR_B: 3 wallclock secs ( 2.16 usr + 0.00 sys = 2.16 CPU) @ 374480.09/s (n=808877)
1126 SUBSTR_U: 2 wallclock secs ( 2.11 usr + 0.00 sys = 2.11 CPU) @ 6791.00/s (n=14329)
1128 The numbers show an incredible slowness on long UTF-8 strings and you
1129 should carefully avoid to use these functions within tight loops. For
1130 example if you want to iterate over characters, it is infinitely
1131 better to split into an array than to use substr, as the following
1138 our $u = our $b = "x" x $l;
1139 substr($u,0,1) = "\x{100}";
1141 SPLIT_B => q{ for my $c (split //, $b){} },
1142 SPLIT_U => q{ for my $c (split //, $u){} },
1143 SUBSTR_B => q{ for my $i (0..length($b)-1){my $c = substr($b,$i,1);} },
1144 SUBSTR_U => q{ for my $i (0..length($u)-1){my $c = substr($u,$i,1);} },
1147 Benchmark: running SPLIT_B, SPLIT_U, SUBSTR_B, SUBSTR_U for at least 5 CPU seconds...
1148 SPLIT_B: 6 wallclock secs ( 5.29 usr + 0.00 sys = 5.29 CPU) @ 56.14/s (n=297)
1149 SPLIT_U: 5 wallclock secs ( 5.17 usr + 0.01 sys = 5.18 CPU) @ 55.21/s (n=286)
1150 SUBSTR_B: 5 wallclock secs ( 5.34 usr + 0.00 sys = 5.34 CPU) @ 123.22/s (n=658)
1151 SUBSTR_U: 7 wallclock secs ( 6.20 usr + 0.00 sys = 6.20 CPU) @ 0.81/s (n=5)
1153 You see, the algorithm based on substr() was faster with byte encoded
1154 data but it is pathologically slow with UTF-8 data.
1158 L<perluniintro>, L<encoding>, L<Encode>, L<open>, L<utf8>, L<bytes>,
1159 L<perlretut>, L<perlvar/"${^WIDE_SYSTEM_CALLS}">
https://perl5.git.perl.org / perl5.git / blob