pod/perlunicode.pod

   1 =head1 NAME
   2
   3 perlunicode - Unicode support in Perl
   4
   5 =head1 DESCRIPTION
   6
   7 =head2 Important Caveats
   8
   9 WARNING: While the implementation of Unicode support in Perl is now
  10 fairly complete it is still evolving to some extent.
  11
  12 In particular the way Unicode is handled on EBCDIC platforms is still
  13 rather experimental. On such a platform references to UTF-8 encoding
  14 in this document and elsewhere should be read as meaning UTF-EBCDIC as
  15 specified in Unicode Technical Report 16 unless ASCII vs EBCDIC issues
  16 are specifically discussed. There is no C<utfebcdic> pragma or
  17 ":utfebcdic" layer, rather "utf8" and ":utf8" are re-used to mean
  18 platform's "natural" 8-bit encoding of Unicode. See L<perlebcdic> for
  19 more discussion of the issues.
  20
  21 The following areas are still under development.
  22
  23 =over 4
  24
  25 =item Input and Output Disciplines
  26
  27 A filehandle can be marked as containing perl's internal Unicode
  28 encoding (UTF-8 or UTF-EBCDIC) by opening it with the ":utf8" layer.
  29 Other encodings can be converted to perl's encoding on input, or from
  30 perl's encoding on output by use of the ":encoding()" layer.  There is
  31 not yet a clean way to mark the Perl source itself as being in an
  32 particular encoding.
  33
  34 =item Regular Expressions
  35
  36 The regular expression compiler does now attempt to produce
  37 polymorphic opcodes.  That is the pattern should now adapt to the data
  38 and automatically switch to the Unicode character scheme when
  39 presented with Unicode data, or a traditional byte scheme when
  40 presented with byte data.  The implementation is still new and
  41 (particularly on EBCDIC platforms) may need further work.
  42
  43 =item C<use utf8> still needed to enable UTF-8/UTF-EBCDIC in scripts
  44
  45 The C<utf8> pragma implements the tables used for Unicode support.
  46 These tables are automatically loaded on demand, so the C<utf8> pragma
  47 need not normally be used.
  48
  49 However, as a compatibility measure, this pragma must be explicitly
  50 used to enable recognition of UTF-8 in the Perl scripts themselves on
  51 ASCII based machines or recognize UTF-EBCDIC on EBCDIC based machines.
  52 B<NOTE: this should be the only place where an explicit C<use utf8> is
  53 needed>.
  54
  55 =back
  56
  57 =head2 Byte and Character semantics
  58
  59 Beginning with version 5.6, Perl uses logically wide characters to
  60 represent strings internally.  This internal representation of strings
  61 uses either the UTF-8 or the UTF-EBCDIC encoding.
  62
  63 In future, Perl-level operations can be expected to work with
  64 characters rather than bytes, in general.
  65
  66 However, as strictly an interim compatibility measure, Perl aims to
  67 provide a safe migration path from byte semantics to character
  68 semantics for programs.  For operations where Perl can unambiguously
  69 decide that the input data is characters, Perl now switches to
  70 character semantics.  For operations where this determination cannot
  71 be made without additional information from the user, Perl decides in
  72 favor of compatibility, and chooses to use byte semantics.
  73
  74 This behavior preserves compatibility with earlier versions of Perl,
  75 which allowed byte semantics in Perl operations, but only as long as
  76 none of the program's inputs are marked as being as source of Unicode
  77 character data.  Such data may come from filehandles, from calls to
  78 external programs, from information provided by the system (such as %ENV),
  79 or from literals and constants in the source text.
  80
  81 If the C<-C> command line switch is used, (or the
  82 ${^WIDE_SYSTEM_CALLS} global flag is set to C<1>), all system calls
  83 will use the corresponding wide character APIs.  Note that this is
  84 currently only implemented on Windows since other platforms API
  85 standard on this area.
  86
  87 Regardless of the above, the C<bytes> pragma can always be used to
  88 force byte semantics in a particular lexical scope.  See L<bytes>.
  89
  90 The C<utf8> pragma is primarily a compatibility device that enables
  91 recognition of UTF-(8|EBCDIC) in literals encountered by the parser.
  92 Note that this pragma is only required until a future version of Perl
  93 in which character semantics will become the default.  This pragma may
  94 then become a no-op.  See L<utf8>.
  95
  96 Unless mentioned otherwise, Perl operators will use character semantics
  97 when they are dealing with Unicode data, and byte semantics otherwise.
  98 Thus, character semantics for these operations apply transparently; if
  99 the input data came from a Unicode source (for example, by adding a
 100 character encoding discipline to the filehandle whence it came, or a
 101 literal UTF-8 string constant in the program), character semantics
 102 apply; otherwise, byte semantics are in effect.  To force byte semantics
 103 on Unicode data, the C<bytes> pragma should be used.
 104
 105 Notice that if you have a string with byte semantics and you then
 106 add character data into it, the bytes will be upgraded I<as if they
 107 were ISO 8859-1 (Latin-1)> (or if in EBCDIC, after a translation
 108 to ISO 8859-1).
 109
 110 Under character semantics, many operations that formerly operated on
 111 bytes change to operating on characters.  For ASCII data this makes no
 112 difference, because UTF-8 stores ASCII in single bytes, but for any
 113 character greater than C<chr(127)>, the character B<may> be stored in
 114 a sequence of two or more bytes, all of which have the high bit set.
 115
 116 For C1 controls or Latin 1 characters on an EBCDIC platform the
 117 character may be stored in a UTF-EBCDIC multi byte sequence.  But by
 118 and large, the user need not worry about this, because Perl hides it
 119 from the user.  A character in Perl is logically just a number ranging
 120 from 0 to 2**32 or so.  Larger characters encode to longer sequences
 121 of bytes internally, but again, this is just an internal detail which
 122 is hidden at the Perl level.
 123
 124 =head2 Effects of character semantics
 125
 126 Character semantics have the following effects:
 127
 128 =over 4
 129
 130 =item *
 131
 132 Strings and patterns may contain characters that have an ordinal value
 133 larger than 255.
 134
 135 Presuming you use a Unicode editor to edit your program, such
 136 characters will typically occur directly within the literal strings as
 137 UTF-8 (or UTF-EBCDIC on EBCDIC platforms) characters, but you can also
 138 specify a particular character with an extension of the C<\x>
 139 notation.  UTF-X characters are specified by putting the hexadecimal
 140 code within curlies after the C<\x>.  For instance, a Unicode smiley
 141 face is C<\x{263A}>.
 142
 143 =item *
 144
 145 Identifiers within the Perl script may contain Unicode alphanumeric
 146 characters, including ideographs.  (You are currently on your own when
 147 it comes to using the canonical forms of characters--Perl doesn't
 148 (yet) attempt to canonicalize variable names for you.)
 149
 150 =item *
 151
 152 Regular expressions match characters instead of bytes.  For instance,
 153 "." matches a character instead of a byte.  (However, the C<\C> pattern
 154 is provided to force a match a single byte ("C<char>" in C, hence C<\C>).)
 155
 156 =item *
 157
 158 Character classes in regular expressions match characters instead of
 159 bytes, and match against the character properties specified in the
 160 Unicode properties database.  So C<\w> can be used to match an
 161 ideograph, for instance.
 162
 163 =item *
 164
 165 Named Unicode properties and block ranges make be used as character
 166 classes via the new C<\p{}> (matches property) and C<\P{}> (doesn't
 167 match property) constructs.  For instance, C<\p{Lu}> matches any
 168 character with the Unicode uppercase property, while C<\p{M}> matches
 169 any mark character.  Single letter properties may omit the brackets,
 170 so that can be written C<\pM> also.  Many predefined character classes
 171 are available, such as C<\p{IsMirrored}> and C<\p{InTibetan}>.
 172 The recommended naming convention of the C<In> classes are the
 173 official Unicode script and block names, but with all non-alphanumeric
 174 characters removed, for example the block name C<"Latin-1 Supplement">
 175 becomes C<\p{InLatin1Supplement}>.  Perl will ignore the case of
 176 letters, and any space or dash can be a space, dash, underbar, or be
 177 missing altogether, so C<\p{ in latin 1 supplement }> will work, too.
 178 You can also negate both C<\p{}> and C<\P{}> by introducing a caret
 179 (^) between the first curly and the property name: C<\p{^InTamil}> is
 180 equal to C<\P{Tamil}>.
 181
 182 Here is the list as of Unicode 3.1.0 (the two-letter classes) and
 183 as defined by Perl (the one-letter classes) (in Unicode materials
 184 what Perl calls C<L> is often called C<L&>):
 185
 186    L  Letter
 187    Lu Letter, Uppercase
 188    Ll Letter, Lowercase
 189    Lt Letter, Titlecase
 190    Lm Letter, Modifier
 191    Lo Letter, Other
 192    M  Mark
 193    Mn Mark, Non-Spacing
 194    Mc Mark, Spacing Combining
 195    Me Mark, Enclosing
 196    N  Number
 197    Nd Number, Decimal Digit
 198    Nl Number, Letter
 199    No Number, Other
 200    P  Punctuation
 201    Pc Punctuation, Connector
 202    Pd Punctuation, Dash
 203    Ps Punctuation, Open
 204    Pe Punctuation, Close
 205    Pi Punctuation, Initial quote
 206        (may behave like Ps or Pe depending on usage)
 207    Pf Punctuation, Final quote
 208        (may behave like Ps or Pe depending on usage)
 209    Po Punctuation, Other
 210    S  Symbol
 211    Sm Symbol, Math
 212    Sc Symbol, Currency
 213    Sk Symbol, Modifier
 214    So Symbol, Other
 215    Z  Separator
 216    Zs Separator, Space
 217    Zl Separator, Line
 218    Zp Separator, Paragraph
 219    C  Other
 220    Cc Other, Control
 221    Cf Other, Format
 222    Cs Other, Surrogate
 223    Co Other, Private Use
 224    Cn Other, Not Assigned (Unicode defines no Cn characters)
 225
 226 Additionally, because scripts differ in their directionality
 227 (for example Hebrew is written right to left), all characters
 228 have their directionality defined:
 229
 230    BidiL   Left-to-Right
 231    BidiLRE Left-to-Right Embedding
 232    BidiLRO Left-to-Right Override
 233    BidiR   Right-to-Left
 234    BidiAL  Right-to-Left Arabic
 235    BidiRLE Right-to-Left Embedding
 236    BidiRLO Right-to-Left Override
 237    BidiPDF Pop Directional Format
 238    BidiEN  European Number
 239    BidiES  European Number Separator
 240    BidiET  European Number Terminator
 241    BidiAN  Arabic Number
 242    BidiCS  Common Number Separator
 243    BidiNSM Non-Spacing Mark
 244    BidiBN  Boundary Neutral
 245    BidiB   Paragraph Separator
 246    BidiS   Segment Separator
 247    BidiWS  Whitespace
 248    BidiON  Other Neutrals
 249
 250 =head2 Scripts
 251
 252 The scripts available for C<\p{In...}> and C<\P{In...}>, for example
 253 \p{InCyrillic>, are as follows, for example C<\p{InLatin}> or C<\P{InHan}>:
 254
 255    Latin
 256    Greek
 257    Cyrillic
 258    Armenian
 259    Hebrew
 260    Arabic
 261    Syriac
 262    Thaana
 263    Devanagari
 264    Bengali
 265    Gurmukhi
 266    Gujarati
 267    Oriya
 268    Tamil
 269    Telugu
 270    Kannada
 271    Malayalam
 272    Sinhala
 273    Thai
 274    Lao
 275    Tibetan
 276    Myanmar
 277    Georgian
 278    Hangul
 279    Ethiopic
 280    Cherokee
 281    CanadianAboriginal
 282    Ogham
 283    Runic
 284    Khmer
 285    Mongolian
 286    Hiragana
 287    Katakana
 288    Bopomofo
 289    Han
 290    Yi
 291    OldItalic
 292    Gothic
 293    Deseret
 294    Inherited
 295
 296 =head2 Blocks
 297
 298 In addition to B<scripts>, Unicode also defines B<blocks> of
 299 characters.  The difference between scripts and blocks is that the
 300 former concept is closer to natural languages, while the latter
 301 concept is more an artificial grouping based on groups of 256 Unicode
 302 characters.  For example, the C<Latin> script contains letters from
 303 many blocks, but it does not contain all the characters from those
 304 blocks, it does not for example contain digits.
 305
 306 For more about scripts see the UTR #24:
 307 http://www.unicode.org/unicode/reports/tr24/
 308 For more about blocks see
 309 http://www.unicode.org/Public/UNIDATA/Blocks.txt
 310
 311 Because there are overlaps in naming (there are, for example, both
 312 a script called C<Katakana> and a block called C<Katakana>, the block
 313 version has C<Block> appended to its name, C<\p{InKatakanaBlock}>.
 314
 315 Notice that this definition was introduced in Perl 5.8.0: in Perl
 316 5.6.0 only the blocks were used; in Perl 5.8.0 scripts became the
 317 preferential character class definition; this meant that the
 318 definitions of some character classes changed (the ones in the
 319 below list that have the C<Block> appended).
 320
 321    BasicLatin
 322    Latin1Supplement
 323    LatinExtendedA
 324    LatinExtendedB
 325    IPAExtensions
 326    SpacingModifierLetters
 327    CombiningDiacriticalMarks
 328    GreekBlock
 329    CyrillicBlock
 330    ArmenianBlock
 331    HebrewBlock
 332    ArabicBlock
 333    SyriacBlock
 334    ThaanaBlock
 335    DevanagariBlock
 336    BengaliBlock
 337    GurmukhiBlock
 338    GujaratiBlock
 339    OriyaBlock
 340    TamilBlock
 341    TeluguBlock
 342    KannadaBlock
 343    MalayalamBlock
 344    SinhalaBlock
 345    ThaiBlock
 346    LaoBlock
 347    TibetanBlock
 348    MyanmarBlock
 349    GeorgianBlock
 350    HangulJamo
 351    EthiopicBlock
 352    CherokeeBlock
 353    UnifiedCanadianAboriginalSyllabics
 354    OghamBlock
 355    RunicBlock
 356    KhmerBlock
 357    MongolianBlock
 358    LatinExtendedAdditional
 359    GreekExtended
 360    GeneralPunctuation
 361    SuperscriptsandSubscripts
 362    CurrencySymbols
 363    CombiningMarksforSymbols
 364    LetterlikeSymbols
 365    NumberForms
 366    Arrows
 367    MathematicalOperators
 368    MiscellaneousTechnical
 369    ControlPictures
 370    OpticalCharacterRecognition
 371    EnclosedAlphanumerics
 372    BoxDrawing
 373    BlockElements
 374    GeometricShapes
 375    MiscellaneousSymbols
 376    Dingbats
 377    BraillePatterns
 378    CJKRadicalsSupplement
 379    KangxiRadicals
 380    IdeographicDescriptionCharacters
 381    CJKSymbolsandPunctuation
 382    HiraganaBlock
 383    KatakanaBlock
 384    BopomofoBlock
 385    HangulCompatibilityJamo
 386    Kanbun
 387    BopomofoExtended
 388    EnclosedCJKLettersandMonths
 389    CJKCompatibility
 390    CJKUnifiedIdeographsExtensionA
 391    CJKUnifiedIdeographs
 392    YiSyllables
 393    YiRadicals
 394    HangulSyllables
 395    HighSurrogates
 396    HighPrivateUseSurrogates
 397    LowSurrogates
 398    PrivateUse
 399    CJKCompatibilityIdeographs
 400    AlphabeticPresentationForms
 401    ArabicPresentationFormsA
 402    CombiningHalfMarks
 403    CJKCompatibilityForms
 404    SmallFormVariants
 405    ArabicPresentationFormsB
 406    Specials
 407    HalfwidthandFullwidthForms
 408    OldItalicBlock
 409    GothicBlock
 410    DeseretBlock
 411    ByzantineMusicalSymbols
 412    MusicalSymbols
 413    MathematicalAlphanumericSymbols
 414    CJKUnifiedIdeographsExtensionB
 415    CJKCompatibilityIdeographsSupplement
 416    Tags
 417
 418 =item *
 419
 420 The special pattern C<\X> match matches any extended Unicode sequence
 421 (a "combining character sequence" in Standardese), where the first
 422 character is a base character and subsequent characters are mark
 423 characters that apply to the base character.  It is equivalent to
 424 C<(?:\PM\pM*)>.
 425
 426 =item *
 427
 428 The C<tr///> operator translates characters instead of bytes.  Note
 429 that the C<tr///CU> functionality has been removed, as the interface
 430 was a mistake.  For similar functionality see pack('U0', ...) and
 431 pack('C0', ...).
 432
 433 =item *
 434
 435 Case translation operators use the Unicode case translation tables
 436 when provided character input.  Note that C<uc()> translates to
 437 uppercase, while C<ucfirst> translates to titlecase (for languages
 438 that make the distinction).  Naturally the corresponding backslash
 439 sequences have the same semantics.
 440
 441 =item *
 442
 443 Most operators that deal with positions or lengths in the string will
 444 automatically switch to using character positions, including
 445 C<chop()>, C<substr()>, C<pos()>, C<index()>, C<rindex()>,
 446 C<sprintf()>, C<write()>, and C<length()>.  Operators that
 447 specifically don't switch include C<vec()>, C<pack()>, and
 448 C<unpack()>.  Operators that really don't care include C<chomp()>, as
 449 well as any other operator that treats a string as a bucket of bits,
 450 such as C<sort()>, and the operators dealing with filenames.
 451
 452 =item *
 453
 454 The C<pack()>/C<unpack()> letters "C<c>" and "C<C>" do I<not> change,
 455 since they're often used for byte-oriented formats.  (Again, think
 456 "C<char>" in the C language.)  However, there is a new "C<U>" specifier
 457 that will convert between UTF-8 characters and integers.  (It works
 458 outside of the utf8 pragma too.)
 459
 460 =item *
 461
 462 The C<chr()> and C<ord()> functions work on characters.  This is like
 463 C<pack("U")> and C<unpack("U")>, not like C<pack("C")> and
 464 C<unpack("C")>.  In fact, the latter are how you now emulate
 465 byte-oriented C<chr()> and C<ord()> for Unicode strings.
 466 (Note that this reveals the internal UTF-8 encoding of strings and
 467 you are not supposed to do that unless you know what you are doing.)
 468
 469 =item *
 470
 471 The bit string operators C<& | ^ ~> can operate on character data.
 472 However, for backward compatibility reasons (bit string operations
 473 when the characters all are less than 256 in ordinal value) one should
 474 not mix C<~> (the bit complement) and characters both less than 256 and
 475 equal or greater than 256.  Most importantly, the DeMorgan's laws
 476 (C<~($x|$y) eq ~$x&~$y>, C<~($x&$y) eq ~$x|~$y>) won't hold.
 477 Another way to look at this is that the complement cannot return
 478 B<both> the 8-bit (byte) wide bit complement B<and> the full character
 479 wide bit complement.
 480
 481 =item *
 482
 483 lc(), uc(), lcfirst(), and ucfirst() work only for some of the
 484 simplest cases, where the mapping goes from a single Unicode character
 485 to another single Unicode character, and where the mapping does not
 486 depend on surrounding characters, or on locales.  More complex cases,
 487 where for example one character maps into several, are not yet
 488 implemented.  See the Unicode Technical Report #21, Case Mappings,
 489 for more details.  The Unicode::UCD module (part of Perl since 5.8.0)
 490 casespec() and casefold() interfaces supply information about the more
 491 complex cases.
 492
 493 =item *
 494
 495 And finally, C<scalar reverse()> reverses by character rather than by byte.
 496
 497 =back
 498
 499 =head2 Character encodings for input and output
 500
 501 See L<Encode>.
 502
 503 =head1 CAVEATS
 504
 505 As of yet, there is no method for automatically coercing input and
 506 output to some encoding other than UTF-8 or UTF-EBCDIC.  This is planned
 507 in the near future, however.
 508
 509 Whether an arbitrary piece of data will be treated as "characters" or
 510 "bytes" by internal operations cannot be divined at the current time.
 511
 512 Use of locales with utf8 may lead to odd results.  Currently there is
 513 some attempt to apply 8-bit locale info to characters in the range
 514 0..255, but this is demonstrably incorrect for locales that use
 515 characters above that range (when mapped into Unicode).  It will also
 516 tend to run slower.  Avoidance of locales is strongly encouraged.
 517
 518 =head1 UNICODE REGULAR EXPRESSION SUPPORT LEVEL
 519
 520 The following list of Unicode regular expression support describes
 521 feature by feature the Unicode support implemented in Perl as of Perl
 522 5.8.0.  The "Level N" and the section numbers refer to the Unicode
 523 Technical Report 18, "Unicode Regular Expression Guidelines".
 524
 525 =over 4
 526
 527 =item *
 528
 529 Level 1 - Basic Unicode Support
 530
 531         2.1 Hex Notation                        - done          [1]
 532                 Named Notation                  - done          [2]
 533         2.2 Categories                          - done          [3][4]
 534         2.3 Subtraction                         - MISSING       [5][6]
 535         2.4 Simple Word Boundaries              - done          [7]
 536         2.5 Simple Loose Matches                - MISSING       [8]
 537         2.6 End of Line                         - MISSING       [9][10]
 538
 539         [ 1] \x{...}
 540         [ 2] \N{...}
 541         [ 3] . \p{Is...} \P{Is...}
 542         [ 4] now scripts (see UTR#24 Script Names) in  addition to blocks
 543         [ 5] have negation
 544         [ 6] can use look-ahead to emulate subtracion
 545         [ 7] include Letters in word characters
 546         [ 8] see UTR#21 Case Mappings
 547         [ 9] see UTR#13 Unicode Newline Guidelines
 548         [10] should do ^ and $ also on \x{2028} and \x{2029}
 549
 550 =item *
 551
 552 Level 2 - Extended Unicode Support
 553
 554         3.1 Surrogates                          - MISSING
 555         3.2 Canonical Equivalents               - MISSING       [11][12]
 556         3.3 Locale-Independent Graphemes        - MISSING       [13]
 557         3.4 Locale-Independent Words            - MISSING       [14]
 558         3.5 Locale-Independent Loose Matches    - MISSING       [15]
 559
 560         [11] see UTR#15 Unicode Normalization
 561         [12] have Unicode::Normalize but not integrated to regexes
 562         [13] have \X but at this level . should equal that
 563         [14] need three classes, not just \w and \W
 564         [15] see UTR#21 Case Mappings
 565
 566 =item *
 567
 568 Level 3 - Locale-Sensitive Support
 569
 570         4.1 Locale-Dependent Categories         - MISSING
 571         4.2 Locale-Dependent Graphemes          - MISSING       [16][17]
 572         4.3 Locale-Dependent Words              - MISSING
 573         4.4 Locale-Dependent Loose Matches      - MISSING
 574         4.5 Locale-Dependent Ranges             - MISSING
 575
 576         [16] see UTR#10 Unicode Collation Algorithms
 577         [17] have Unicode::Collate but not integrated to regexes
 578
 579 =back
 580
 581 =head1 SEE ALSO
 582
 583 L<bytes>, L<utf8>, L<perlretut>, L<perlvar/"${^WIDE_SYSTEM_CALLS}">
 584
 585 =cut