utf8.c

   1 /*    utf8.c
   2  *
   3  *    Copyright (c) 1998-2000, Larry Wall
   4  *
   5  *    You may distribute under the terms of either the GNU General Public
   6  *    License or the Artistic License, as specified in the README file.
   7  *
   8  */
   9
  10 /*
  11  * 'What a fix!' said Sam. 'That's the one place in all the lands we've ever
  12  * heard of that we don't want to see any closer; and that's the one place
  13  * we're trying to get to!  And that's just where we can't get, nohow.'
  14  *
  15  * 'Well do I understand your speech,' he answered in the same language;
  16  * 'yet few strangers do so.  Why then do you not speak in the Common Tongue,
  17  * as is the custom in the West, if you wish to be answered?'
  18  *
  19  * ...the travellers perceived that the floor was paved with stones of many
  20  * hues; branching runes and strange devices intertwined beneath their feet.
  21  */
  22
  23 #include "EXTERN.h"
  24 #define PERL_IN_UTF8_C
  25 #include "perl.h"
  26
  27 /* Unicode support */
  28
  29 U8 *
  30 Perl_uv_to_utf8(pTHX_ U8 *d, UV uv)
  31 {
  32     if (uv < 0x80) {
  33         *d++ = uv;
  34         return d;
  35     }
  36     if (uv < 0x800) {
  37         *d++ = (( uv >>  6)         | 0xc0);
  38         *d++ = (( uv        & 0x3f) | 0x80);
  39         return d;
  40     }
  41     if (uv < 0x10000) {
  42         *d++ = (( uv >> 12)         | 0xe0);
  43         *d++ = (((uv >>  6) & 0x3f) | 0x80);
  44         *d++ = (( uv        & 0x3f) | 0x80);
  45         return d;
  46     }
  47     if (uv < 0x200000) {
  48         *d++ = (( uv >> 18)         | 0xf0);
  49         *d++ = (((uv >> 12) & 0x3f) | 0x80);
  50         *d++ = (((uv >>  6) & 0x3f) | 0x80);
  51         *d++ = (( uv        & 0x3f) | 0x80);
  52         return d;
  53     }
  54     if (uv < 0x4000000) {
  55         *d++ = (( uv >> 24)         | 0xf8);
  56         *d++ = (((uv >> 18) & 0x3f) | 0x80);
  57         *d++ = (((uv >> 12) & 0x3f) | 0x80);
  58         *d++ = (((uv >>  6) & 0x3f) | 0x80);
  59         *d++ = (( uv        & 0x3f) | 0x80);
  60         return d;
  61     }
  62     if (uv < 0x80000000) {
  63         *d++ = (( uv >> 30)         | 0xfc);
  64         *d++ = (((uv >> 24) & 0x3f) | 0x80);
  65         *d++ = (((uv >> 18) & 0x3f) | 0x80);
  66         *d++ = (((uv >> 12) & 0x3f) | 0x80);
  67         *d++ = (((uv >>  6) & 0x3f) | 0x80);
  68         *d++ = (( uv        & 0x3f) | 0x80);
  69         return d;
  70     }
  71 #ifdef HAS_QUAD
  72     if (uv < UTF8_QUAD_MAX)
  73 #endif
  74     {
  75         *d++ =                        0xfe;     /* Can't match U+FEFF! */
  76         *d++ = (((uv >> 30) & 0x3f) | 0x80);
  77         *d++ = (((uv >> 24) & 0x3f) | 0x80);
  78         *d++ = (((uv >> 18) & 0x3f) | 0x80);
  79         *d++ = (((uv >> 12) & 0x3f) | 0x80);
  80         *d++ = (((uv >>  6) & 0x3f) | 0x80);
  81         *d++ = (( uv        & 0x3f) | 0x80);
  82         return d;
  83     }
  84 #ifdef HAS_QUAD
  85     {
  86         *d++ =                        0xff;     /* Can't match U+FFFE! */
  87         *d++ =                        0x80;     /* 6 Reserved bits */
  88         *d++ = (((uv >> 60) & 0x0f) | 0x80);    /* 2 Reserved bits */
  89         *d++ = (((uv >> 54) & 0x3f) | 0x80);
  90         *d++ = (((uv >> 48) & 0x3f) | 0x80);
  91         *d++ = (((uv >> 42) & 0x3f) | 0x80);
  92         *d++ = (((uv >> 36) & 0x3f) | 0x80);
  93         *d++ = (((uv >> 30) & 0x3f) | 0x80);
  94         *d++ = (((uv >> 24) & 0x3f) | 0x80);
  95         *d++ = (((uv >> 18) & 0x3f) | 0x80);
  96         *d++ = (((uv >> 12) & 0x3f) | 0x80);
  97         *d++ = (((uv >>  6) & 0x3f) | 0x80);
  98         *d++ = (( uv        & 0x3f) | 0x80);
  99         return d;
 100     }
 101 #endif
 102 }
 103
 104 /* Tests if some arbitrary number of bytes begins in a valid UTF-8 character.
 105  * The actual number of bytes in the UTF-8 character will be returned if it
 106  * is valid, otherwise 0. */
 107 STRLEN
 108 Perl_is_utf8_char(pTHX_ U8 *s)
 109 {
 110     U8 u = *s;
 111     STRLEN slen, len;
 112     UV uv, ouv;
 113
 114     if (u <= 0x7f)
 115         return 1;
 116
 117     if (u >= 0x80 && u <= 0xbf)
 118         return 0;
 119
 120     len = UTF8SKIP(s);
 121
 122     if (len < 2 || (u >= 0xc0 && u <= 0xfd && s[1] < 0x80))
 123         return 0;
 124
 125     slen = len - 1;
 126     s++;
 127     uv = u;
 128     ouv = uv;
 129     while (slen--) {
 130         if ((*s & 0xc0) != 0x80)
 131             return 0;
 132         uv = (uv << 6) | (*s & 0x3f);
 133         if (uv < ouv)
 134             return 0;
 135         ouv = uv;
 136         s++;
 137     }
 138
 139     if (UNISKIP(uv) < len)
 140         return 0;
 141
 142     return len;
 143 }
 144
 145 /*
 146 =for apidoc Am|is_utf8_string|U8 *s|STRLEN len
 147
 148 Returns true if first C<len> bytes of the given string form valid a UTF8
 149 string, false otherwise.
 150
 151 =cut
 152 */
 153
 154 bool
 155 Perl_is_utf8_string(pTHX_ U8 *s, STRLEN len)
 156 {
 157     U8* x = s;
 158     U8* send = s + len;
 159     STRLEN c;
 160
 161     while (x < send) {
 162         c = is_utf8_char(x);
 163         if (!c)
 164             return FALSE;
 165         x += c;
 166         if (x > send)
 167             return FALSE;
 168     }
 169
 170     return TRUE;
 171 }
 172
 173 /*
 174 =for apidoc Am|U8* s|utf8_to_uv|STRLEN curlen|I32 *retlen|U32 flags
 175
 176 Returns the character value of the first character in the string C<s>
 177 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
 178 C<retlen> will be set to the length, in bytes, of that character,
 179 and the pointer C<s> will be advanced to the end of the character.
 180
 181 If C<s> does not point to a well-formed UTF8 character, the behaviour
 182 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
 183 it is assumed that the caller will raise a warning, and this function
 184 will set C<retlen> to C<-1> and return.  The C<flags> can also contain
 185 various flags to allow deviations from the strict UTF-8 encoding.
 186
 187 =cut */
 188
 189 UV
 190 Perl_utf8_to_uv(pTHX_ U8* s, STRLEN curlen, STRLEN* retlen, U32 flags)
 191 {
 192     dTHR;
 193     UV uv = *s, ouv;
 194     STRLEN len = 1;
 195 #ifdef EBCDIC
 196     bool dowarn = 0;
 197 #else
 198     bool dowarn = ckWARN_d(WARN_UTF8);
 199 #endif
 200     STRLEN expectlen = 0;
 201
 202     if (curlen == 0) {
 203         if (dowarn)
 204             Perl_warner(aTHX_ WARN_UTF8,
 205                         "Malformed UTF-8 character (an empty string)");
 206         goto malformed;
 207     }
 208
 209     if (uv <= 0x7f) { /* Pure ASCII. */
 210         if (retlen)
 211             *retlen = 1;
 212         return *s;
 213     }
 214
 215     if ((uv >= 0x80 && uv <= 0xbf) &&
 216         !(flags & UTF8_ALLOW_CONTINUATION)) {
 217         if (dowarn)
 218             Perl_warner(aTHX_ WARN_UTF8,
 219                         "Malformed UTF-8 character (unexpected continuation byte 0x%02"UVxf")",
 220                         uv);
 221         goto malformed;
 222     }
 223
 224     if ((uv >= 0xc0 && uv <= 0xfd && curlen > 1 && s[1] < 0x80) &&
 225         !(flags & UTF8_ALLOW_NON_CONTINUATION)) {
 226         if (dowarn)
 227             Perl_warner(aTHX_ WARN_UTF8,
 228                         "Malformed UTF-8 character (unexpected non-continuation byte 0x%02"UVxf" after byte 0x%02"UVxf")",
 229                         (UV)s[1], uv);
 230         goto malformed;
 231     }
 232
 233     if ((uv == 0xfe || uv == 0xff) &&
 234         !(flags & UTF8_ALLOW_FE_FF)) {
 235         if (dowarn)
 236             Perl_warner(aTHX_ WARN_UTF8,
 237                         "Malformed UTF-8 character (byte 0x%02"UVxf")",
 238                         uv);
 239         goto malformed;
 240     }
 241
 242     if      (!(uv & 0x20))      { len =  2; uv &= 0x1f; }
 243     else if (!(uv & 0x10))      { len =  3; uv &= 0x0f; }
 244     else if (!(uv & 0x08))      { len =  4; uv &= 0x07; }
 245     else if (!(uv & 0x04))      { len =  5; uv &= 0x03; }
 246     else if (!(uv & 0x02))      { len =  6; uv &= 0x01; }
 247     else if (!(uv & 0x01))      { len =  7; uv = 0; }
 248     else                        { len = 13; uv = 0; } /* whoa! */
 249
 250     if (retlen)
 251         *retlen = len;
 252
 253     expectlen = len;
 254
 255     if ((curlen < expectlen) &&
 256         !(flags & UTF8_ALLOW_SHORT)) {
 257         if (dowarn)
 258             Perl_warner(aTHX_ WARN_UTF8,
 259                         "Malformed UTF-8 character (%d byte%s, need %d)",
 260                         curlen, curlen == 1 ? "" : "s", expectlen);
 261         goto malformed;
 262     }
 263
 264     len--;
 265     s++;
 266     ouv = uv;
 267
 268     while (len--) {
 269         if ((*s & 0xc0) != 0x80) {
 270             if (dowarn)
 271                 Perl_warner(aTHX_ WARN_UTF8,
 272                             "Malformed UTF-8 character (unexpected continuation byte 0x%02x)",
 273                             *s);
 274             goto malformed;
 275         }
 276         else
 277             uv = (uv << 6) | (*s & 0x3f);
 278         if (uv < ouv) {
 279             /* This cannot be allowed. */
 280             if (dowarn)
 281                 Perl_warner(aTHX_ WARN_UTF8,
 282                             "Malformed UTF-8 character (overflow at 0x%"UVxf", byte 0x%02x)",
 283                             ouv, *s);
 284             goto malformed;
 285         }
 286         s++;
 287         ouv = uv;
 288     }
 289
 290     if ((uv >= 0xd800 && uv <= 0xdfff) &&
 291         !(flags & UTF8_ALLOW_SURROGATE)) {
 292         if (dowarn)
 293             Perl_warner(aTHX_ WARN_UTF8,
 294                         "Malformed UTF-8 character (UTF-16 surrogate 0x%04"UVxf")",
 295                         uv);
 296         goto malformed;
 297     } else if ((uv == 0xfffe) &&
 298                !(flags & UTF8_ALLOW_BOM)) {
 299         if (dowarn)
 300             Perl_warner(aTHX_ WARN_UTF8,
 301                         "Malformed UTF-8 character (byte order mark 0x%04"UVxf")",
 302                         uv);
 303         goto malformed;
 304     } else if ((uv == 0xffff) &&
 305                !(flags & UTF8_ALLOW_FFFF)) {
 306         if (dowarn)
 307             Perl_warner(aTHX_ WARN_UTF8,
 308                         "Malformed UTF-8 character (character 0x%04"UVxf")",
 309                         uv);
 310         goto malformed;
 311     } else if ((expectlen > UNISKIP(uv)) &&
 312                !(flags & UTF8_ALLOW_LONG)) {
 313         if (dowarn)
 314             Perl_warner(aTHX_ WARN_UTF8,
 315                         "Malformed UTF-8 character (%d byte%s, need %d)",
 316                         expectlen, expectlen == 1 ? "": "s", UNISKIP(uv));
 317         goto malformed;
 318     }
 319
 320     return uv;
 321
 322 malformed:
 323
 324     if (flags & UTF8_CHECK_ONLY) {
 325         if (retlen)
 326             *retlen = -1;
 327         return 0;
 328     }
 329
 330     if (retlen)
 331         *retlen = expectlen ? expectlen : len;
 332
 333     return UNICODE_REPLACEMENT_CHARACTER;
 334 }
 335
 336 /*
 337 =for apidoc Am|U8* s|utf8_to_uv_simple|STRLEN *retlen
 338
 339 Returns the character value of the first character in the string C<s>
 340 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
 341 length, in bytes, of that character, and the pointer C<s> will be
 342 advanced to the end of the character.
 343
 344 If C<s> does not point to a well-formed UTF8 character, zero is
 345 returned and retlen is set, if possible, to -1.
 346
 347 =cut
 348 */
 349
 350 UV
 351 Perl_utf8_to_uv_simple(pTHX_ U8* s, STRLEN* retlen)
 352 {
 353     return Perl_utf8_to_uv(aTHX_ s, (STRLEN)-1, retlen, 0);
 354 }
 355
 356 /*
 357 =for apidoc|utf8_length|U8 *s|U8 *e
 358
 359 Return the length of the UTF-8 char encoded string C<s> in characters.
 360 Stops at string C<e>.  If C<e E<lt> s> or if the scan would end up
 361 past C<e>, return -1.
 362
 363 =cut
 364 */
 365
 366 STRLEN
 367 Perl_utf8_length(pTHX_ U8* s, U8* e)
 368 {
 369     STRLEN len = 0;
 370
 371     if (e < s)
 372         return -1;
 373     while (s < e) {
 374         STRLEN t = UTF8SKIP(s);
 375
 376         if (e - s < t)
 377             return -1;
 378         s += t;
 379         len++;
 380     }
 381
 382     return len;
 383 }
 384
 385 /* utf8_distance(a,b) returns the number of UTF8 characters between
 386    the pointers a and b                                                 */
 387
 388 I32
 389 Perl_utf8_distance(pTHX_ U8 *a, U8 *b)
 390 {
 391     I32 off = 0;
 392     if (a < b) {
 393         while (a < b) {
 394             a += UTF8SKIP(a);
 395             off--;
 396         }
 397     }
 398     else {
 399         while (b < a) {
 400             b += UTF8SKIP(b);
 401             off++;
 402         }
 403     }
 404     return off;
 405 }
 406
 407 /* WARNING: do not use the following unless you *know* off is within bounds */
 408
 409 U8 *
 410 Perl_utf8_hop(pTHX_ U8 *s, I32 off)
 411 {
 412     if (off >= 0) {
 413         while (off--)
 414             s += UTF8SKIP(s);
 415     }
 416     else {
 417         while (off++) {
 418             s--;
 419             if (*s & 0x80) {
 420                 while ((*s & 0xc0) == 0x80)
 421                     s--;
 422             }
 423         }
 424     }
 425     return s;
 426 }
 427
 428 /*
 429 =for apidoc Am|U8 *|utf8_to_bytes|U8 *s|STRLEN *len
 430
 431 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
 432 Unlike C<bytes_to_utf8>, this over-writes the original string, and
 433 updates len to contain the new length.
 434 Returns zero on failure, setting C<len> to -1.
 435
 436 =cut
 437 */
 438
 439 U8 *
 440 Perl_utf8_to_bytes(pTHX_ U8* s, STRLEN *len)
 441 {
 442     U8 *send;
 443     U8 *d;
 444     U8 *save = s;
 445
 446     /* ensure valid UTF8 and chars < 256 before updating string */
 447     for (send = s + *len; s < send; ) {
 448         U8 c = *s++;
 449
 450         if (c >= 0x80 &&
 451             ((s >= send) ||
 452              ((*s++ & 0xc0) != 0x80) || ((c & 0xfe) != 0xc2))) {
 453             *len = -1;
 454             return 0;
 455         }
 456     }
 457
 458     d = s = save;
 459     while (s < send) {
 460         if (*s < 0x80) {
 461             *d++ = *s++;
 462         }
 463         else {
 464             STRLEN ulen;
 465             *d++ = (U8)utf8_to_uv_simple(s, &ulen);
 466             s += ulen;
 467         }
 468     }
 469     *d = '\0';
 470     *len = d - save;
 471     return save;
 472 }
 473
 474 /*
 475 =for apidoc Am|U8 *|bytes_to_utf8|U8 *s|STRLEN *len
 476
 477 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
 478 Returns a pointer to the newly-created string, and sets C<len> to
 479 reflect the new length.
 480
 481 =cut
 482 */
 483
 484 U8*
 485 Perl_bytes_to_utf8(pTHX_ U8* s, STRLEN *len)
 486 {
 487     dTHR;
 488     U8 *send;
 489     U8 *d;
 490     U8 *dst;
 491     send = s + (*len);
 492
 493     Newz(801, d, (*len) * 2 + 1, U8);
 494     dst = d;
 495
 496     while (s < send) {
 497         if (*s < 0x80)
 498             *d++ = *s++;
 499         else {
 500             UV uv = *s++;
 501             *d++ = (( uv >>  6)         | 0xc0);
 502             *d++ = (( uv        & 0x3f) | 0x80);
 503         }
 504     }
 505     *d = '\0';
 506     *len = d-dst;
 507     return dst;
 508 }
 509
 510 /*
 511  * Convert native (big-endian) or reversed (little-endian) UTF-16 to UTF-8.
 512  *
 513  * Destination must be pre-extended to 3/2 source.  Do not use in-place.
 514  * We optimize for native, for obvious reasons. */
 515
 516 U8*
 517 Perl_utf16_to_utf8(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
 518 {
 519     U8* pend;
 520     U8* dstart = d;
 521
 522     if (bytelen & 1)
 523         Perl_croak(aTHX_ "panic: utf16_to_utf8: odd bytelen");
 524
 525     pend = p + bytelen;
 526
 527     while (p < pend) {
 528         UV uv = (p[0] << 8) + p[1]; /* UTF-16BE */
 529         p += 2;
 530         if (uv < 0x80) {
 531             *d++ = uv;
 532             continue;
 533         }
 534         if (uv < 0x800) {
 535             *d++ = (( uv >>  6)         | 0xc0);
 536             *d++ = (( uv        & 0x3f) | 0x80);
 537             continue;
 538         }
 539         if (uv >= 0xd800 && uv < 0xdbff) {      /* surrogates */
 540             dTHR;
 541             UV low = *p++;
 542             if (low < 0xdc00 || low >= 0xdfff)
 543                 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
 544             uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
 545         }
 546         if (uv < 0x10000) {
 547             *d++ = (( uv >> 12)         | 0xe0);
 548             *d++ = (((uv >>  6) & 0x3f) | 0x80);
 549             *d++ = (( uv        & 0x3f) | 0x80);
 550             continue;
 551         }
 552         else {
 553             *d++ = (( uv >> 18)         | 0xf0);
 554             *d++ = (((uv >> 12) & 0x3f) | 0x80);
 555             *d++ = (((uv >>  6) & 0x3f) | 0x80);
 556             *d++ = (( uv        & 0x3f) | 0x80);
 557             continue;
 558         }
 559     }
 560     *newlen = d - dstart;
 561     return d;
 562 }
 563
 564 /* Note: this one is slightly destructive of the source. */
 565
 566 U8*
 567 Perl_utf16_to_utf8_reversed(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
 568 {
 569     U8* s = (U8*)p;
 570     U8* send = s + bytelen;
 571     while (s < send) {
 572         U8 tmp = s[0];
 573         s[0] = s[1];
 574         s[1] = tmp;
 575         s += 2;
 576     }
 577     return utf16_to_utf8(p, d, bytelen, newlen);
 578 }
 579
 580 /* for now these are all defined (inefficiently) in terms of the utf8 versions */
 581
 582 bool
 583 Perl_is_uni_alnum(pTHX_ U32 c)
 584 {
 585     U8 tmpbuf[UTF8_MAXLEN];
 586     uv_to_utf8(tmpbuf, (UV)c);
 587     return is_utf8_alnum(tmpbuf);
 588 }
 589
 590 bool
 591 Perl_is_uni_alnumc(pTHX_ U32 c)
 592 {
 593     U8 tmpbuf[UTF8_MAXLEN];
 594     uv_to_utf8(tmpbuf, (UV)c);
 595     return is_utf8_alnumc(tmpbuf);
 596 }
 597
 598 bool
 599 Perl_is_uni_idfirst(pTHX_ U32 c)
 600 {
 601     U8 tmpbuf[UTF8_MAXLEN];
 602     uv_to_utf8(tmpbuf, (UV)c);
 603     return is_utf8_idfirst(tmpbuf);
 604 }
 605
 606 bool
 607 Perl_is_uni_alpha(pTHX_ U32 c)
 608 {
 609     U8 tmpbuf[UTF8_MAXLEN];
 610     uv_to_utf8(tmpbuf, (UV)c);
 611     return is_utf8_alpha(tmpbuf);
 612 }
 613
 614 bool
 615 Perl_is_uni_ascii(pTHX_ U32 c)
 616 {
 617     U8 tmpbuf[UTF8_MAXLEN];
 618     uv_to_utf8(tmpbuf, (UV)c);
 619     return is_utf8_ascii(tmpbuf);
 620 }
 621
 622 bool
 623 Perl_is_uni_space(pTHX_ U32 c)
 624 {
 625     U8 tmpbuf[UTF8_MAXLEN];
 626     uv_to_utf8(tmpbuf, (UV)c);
 627     return is_utf8_space(tmpbuf);
 628 }
 629
 630 bool
 631 Perl_is_uni_digit(pTHX_ U32 c)
 632 {
 633     U8 tmpbuf[UTF8_MAXLEN];
 634     uv_to_utf8(tmpbuf, (UV)c);
 635     return is_utf8_digit(tmpbuf);
 636 }
 637
 638 bool
 639 Perl_is_uni_upper(pTHX_ U32 c)
 640 {
 641     U8 tmpbuf[UTF8_MAXLEN];
 642     uv_to_utf8(tmpbuf, (UV)c);
 643     return is_utf8_upper(tmpbuf);
 644 }
 645
 646 bool
 647 Perl_is_uni_lower(pTHX_ U32 c)
 648 {
 649     U8 tmpbuf[UTF8_MAXLEN];
 650     uv_to_utf8(tmpbuf, (UV)c);
 651     return is_utf8_lower(tmpbuf);
 652 }
 653
 654 bool
 655 Perl_is_uni_cntrl(pTHX_ U32 c)
 656 {
 657     U8 tmpbuf[UTF8_MAXLEN];
 658     uv_to_utf8(tmpbuf, (UV)c);
 659     return is_utf8_cntrl(tmpbuf);
 660 }
 661
 662 bool
 663 Perl_is_uni_graph(pTHX_ U32 c)
 664 {
 665     U8 tmpbuf[UTF8_MAXLEN];
 666     uv_to_utf8(tmpbuf, (UV)c);
 667     return is_utf8_graph(tmpbuf);
 668 }
 669
 670 bool
 671 Perl_is_uni_print(pTHX_ U32 c)
 672 {
 673     U8 tmpbuf[UTF8_MAXLEN];
 674     uv_to_utf8(tmpbuf, (UV)c);
 675     return is_utf8_print(tmpbuf);
 676 }
 677
 678 bool
 679 Perl_is_uni_punct(pTHX_ U32 c)
 680 {
 681     U8 tmpbuf[UTF8_MAXLEN];
 682     uv_to_utf8(tmpbuf, (UV)c);
 683     return is_utf8_punct(tmpbuf);
 684 }
 685
 686 bool
 687 Perl_is_uni_xdigit(pTHX_ U32 c)
 688 {
 689     U8 tmpbuf[UTF8_MAXLEN];
 690     uv_to_utf8(tmpbuf, (UV)c);
 691     return is_utf8_xdigit(tmpbuf);
 692 }
 693
 694 U32
 695 Perl_to_uni_upper(pTHX_ U32 c)
 696 {
 697     U8 tmpbuf[UTF8_MAXLEN];
 698     uv_to_utf8(tmpbuf, (UV)c);
 699     return to_utf8_upper(tmpbuf);
 700 }
 701
 702 U32
 703 Perl_to_uni_title(pTHX_ U32 c)
 704 {
 705     U8 tmpbuf[UTF8_MAXLEN];
 706     uv_to_utf8(tmpbuf, (UV)c);
 707     return to_utf8_title(tmpbuf);
 708 }
 709
 710 U32
 711 Perl_to_uni_lower(pTHX_ U32 c)
 712 {
 713     U8 tmpbuf[UTF8_MAXLEN];
 714     uv_to_utf8(tmpbuf, (UV)c);
 715     return to_utf8_lower(tmpbuf);
 716 }
 717
 718 /* for now these all assume no locale info available for Unicode > 255 */
 719
 720 bool
 721 Perl_is_uni_alnum_lc(pTHX_ U32 c)
 722 {
 723     return is_uni_alnum(c);     /* XXX no locale support yet */
 724 }
 725
 726 bool
 727 Perl_is_uni_alnumc_lc(pTHX_ U32 c)
 728 {
 729     return is_uni_alnumc(c);    /* XXX no locale support yet */
 730 }
 731
 732 bool
 733 Perl_is_uni_idfirst_lc(pTHX_ U32 c)
 734 {
 735     return is_uni_idfirst(c);   /* XXX no locale support yet */
 736 }
 737
 738 bool
 739 Perl_is_uni_alpha_lc(pTHX_ U32 c)
 740 {
 741     return is_uni_alpha(c);     /* XXX no locale support yet */
 742 }
 743
 744 bool
 745 Perl_is_uni_ascii_lc(pTHX_ U32 c)
 746 {
 747     return is_uni_ascii(c);     /* XXX no locale support yet */
 748 }
 749
 750 bool
 751 Perl_is_uni_space_lc(pTHX_ U32 c)
 752 {
 753     return is_uni_space(c);     /* XXX no locale support yet */
 754 }
 755
 756 bool
 757 Perl_is_uni_digit_lc(pTHX_ U32 c)
 758 {
 759     return is_uni_digit(c);     /* XXX no locale support yet */
 760 }
 761
 762 bool
 763 Perl_is_uni_upper_lc(pTHX_ U32 c)
 764 {
 765     return is_uni_upper(c);     /* XXX no locale support yet */
 766 }
 767
 768 bool
 769 Perl_is_uni_lower_lc(pTHX_ U32 c)
 770 {
 771     return is_uni_lower(c);     /* XXX no locale support yet */
 772 }
 773
 774 bool
 775 Perl_is_uni_cntrl_lc(pTHX_ U32 c)
 776 {
 777     return is_uni_cntrl(c);     /* XXX no locale support yet */
 778 }
 779
 780 bool
 781 Perl_is_uni_graph_lc(pTHX_ U32 c)
 782 {
 783     return is_uni_graph(c);     /* XXX no locale support yet */
 784 }
 785
 786 bool
 787 Perl_is_uni_print_lc(pTHX_ U32 c)
 788 {
 789     return is_uni_print(c);     /* XXX no locale support yet */
 790 }
 791
 792 bool
 793 Perl_is_uni_punct_lc(pTHX_ U32 c)
 794 {
 795     return is_uni_punct(c);     /* XXX no locale support yet */
 796 }
 797
 798 bool
 799 Perl_is_uni_xdigit_lc(pTHX_ U32 c)
 800 {
 801     return is_uni_xdigit(c);    /* XXX no locale support yet */
 802 }
 803
 804 U32
 805 Perl_to_uni_upper_lc(pTHX_ U32 c)
 806 {
 807     return to_uni_upper(c);     /* XXX no locale support yet */
 808 }
 809
 810 U32
 811 Perl_to_uni_title_lc(pTHX_ U32 c)
 812 {
 813     return to_uni_title(c);     /* XXX no locale support yet */
 814 }
 815
 816 U32
 817 Perl_to_uni_lower_lc(pTHX_ U32 c)
 818 {
 819     return to_uni_lower(c);     /* XXX no locale support yet */
 820 }
 821
 822 bool
 823 Perl_is_utf8_alnum(pTHX_ U8 *p)
 824 {
 825     if (!is_utf8_char(p))
 826         return FALSE;
 827     if (!PL_utf8_alnum)
 828         /* NOTE: "IsWord", not "IsAlnum", since Alnum is a true
 829          * descendant of isalnum(3), in other words, it doesn't
 830          * contain the '_'. --jhi */
 831         PL_utf8_alnum = swash_init("utf8", "IsWord", &PL_sv_undef, 0, 0);
 832     return swash_fetch(PL_utf8_alnum, p);
 833 /*    return *p == '_' || is_utf8_alpha(p) || is_utf8_digit(p); */
 834 #ifdef SURPRISINGLY_SLOWER  /* probably because alpha is usually true */
 835     if (!PL_utf8_alnum)
 836         PL_utf8_alnum = swash_init("utf8", "",
 837             sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
 838     return swash_fetch(PL_utf8_alnum, p);
 839 #endif
 840 }
 841
 842 bool
 843 Perl_is_utf8_alnumc(pTHX_ U8 *p)
 844 {
 845     if (!is_utf8_char(p))
 846         return FALSE;
 847     if (!PL_utf8_alnum)
 848         PL_utf8_alnum = swash_init("utf8", "IsAlnumC", &PL_sv_undef, 0, 0);
 849     return swash_fetch(PL_utf8_alnum, p);
 850 /*    return is_utf8_alpha(p) || is_utf8_digit(p); */
 851 #ifdef SURPRISINGLY_SLOWER  /* probably because alpha is usually true */
 852     if (!PL_utf8_alnum)
 853         PL_utf8_alnum = swash_init("utf8", "",
 854             sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
 855     return swash_fetch(PL_utf8_alnum, p);
 856 #endif
 857 }
 858
 859 bool
 860 Perl_is_utf8_idfirst(pTHX_ U8 *p)
 861 {
 862     return *p == '_' || is_utf8_alpha(p);
 863 }
 864
 865 bool
 866 Perl_is_utf8_alpha(pTHX_ U8 *p)
 867 {
 868     if (!is_utf8_char(p))
 869         return FALSE;
 870     if (!PL_utf8_alpha)
 871         PL_utf8_alpha = swash_init("utf8", "IsAlpha", &PL_sv_undef, 0, 0);
 872     return swash_fetch(PL_utf8_alpha, p);
 873 }
 874
 875 bool
 876 Perl_is_utf8_ascii(pTHX_ U8 *p)
 877 {
 878     if (!is_utf8_char(p))
 879         return FALSE;
 880     if (!PL_utf8_ascii)
 881         PL_utf8_ascii = swash_init("utf8", "IsAscii", &PL_sv_undef, 0, 0);
 882     return swash_fetch(PL_utf8_ascii, p);
 883 }
 884
 885 bool
 886 Perl_is_utf8_space(pTHX_ U8 *p)
 887 {
 888     if (!is_utf8_char(p))
 889         return FALSE;
 890     if (!PL_utf8_space)
 891         PL_utf8_space = swash_init("utf8", "IsSpace", &PL_sv_undef, 0, 0);
 892     return swash_fetch(PL_utf8_space, p);
 893 }
 894
 895 bool
 896 Perl_is_utf8_digit(pTHX_ U8 *p)
 897 {
 898     if (!is_utf8_char(p))
 899         return FALSE;
 900     if (!PL_utf8_digit)
 901         PL_utf8_digit = swash_init("utf8", "IsDigit", &PL_sv_undef, 0, 0);
 902     return swash_fetch(PL_utf8_digit, p);
 903 }
 904
 905 bool
 906 Perl_is_utf8_upper(pTHX_ U8 *p)
 907 {
 908     if (!is_utf8_char(p))
 909         return FALSE;
 910     if (!PL_utf8_upper)
 911         PL_utf8_upper = swash_init("utf8", "IsUpper", &PL_sv_undef, 0, 0);
 912     return swash_fetch(PL_utf8_upper, p);
 913 }
 914
 915 bool
 916 Perl_is_utf8_lower(pTHX_ U8 *p)
 917 {
 918     if (!is_utf8_char(p))
 919         return FALSE;
 920     if (!PL_utf8_lower)
 921         PL_utf8_lower = swash_init("utf8", "IsLower", &PL_sv_undef, 0, 0);
 922     return swash_fetch(PL_utf8_lower, p);
 923 }
 924
 925 bool
 926 Perl_is_utf8_cntrl(pTHX_ U8 *p)
 927 {
 928     if (!is_utf8_char(p))
 929         return FALSE;
 930     if (!PL_utf8_cntrl)
 931         PL_utf8_cntrl = swash_init("utf8", "IsCntrl", &PL_sv_undef, 0, 0);
 932     return swash_fetch(PL_utf8_cntrl, p);
 933 }
 934
 935 bool
 936 Perl_is_utf8_graph(pTHX_ U8 *p)
 937 {
 938     if (!is_utf8_char(p))
 939         return FALSE;
 940     if (!PL_utf8_graph)
 941         PL_utf8_graph = swash_init("utf8", "IsGraph", &PL_sv_undef, 0, 0);
 942     return swash_fetch(PL_utf8_graph, p);
 943 }
 944
 945 bool
 946 Perl_is_utf8_print(pTHX_ U8 *p)
 947 {
 948     if (!is_utf8_char(p))
 949         return FALSE;
 950     if (!PL_utf8_print)
 951         PL_utf8_print = swash_init("utf8", "IsPrint", &PL_sv_undef, 0, 0);
 952     return swash_fetch(PL_utf8_print, p);
 953 }
 954
 955 bool
 956 Perl_is_utf8_punct(pTHX_ U8 *p)
 957 {
 958     if (!is_utf8_char(p))
 959         return FALSE;
 960     if (!PL_utf8_punct)
 961         PL_utf8_punct = swash_init("utf8", "IsPunct", &PL_sv_undef, 0, 0);
 962     return swash_fetch(PL_utf8_punct, p);
 963 }
 964
 965 bool
 966 Perl_is_utf8_xdigit(pTHX_ U8 *p)
 967 {
 968     if (!is_utf8_char(p))
 969         return FALSE;
 970     if (!PL_utf8_xdigit)
 971         PL_utf8_xdigit = swash_init("utf8", "IsXDigit", &PL_sv_undef, 0, 0);
 972     return swash_fetch(PL_utf8_xdigit, p);
 973 }
 974
 975 bool
 976 Perl_is_utf8_mark(pTHX_ U8 *p)
 977 {
 978     if (!is_utf8_char(p))
 979         return FALSE;
 980     if (!PL_utf8_mark)
 981         PL_utf8_mark = swash_init("utf8", "IsM", &PL_sv_undef, 0, 0);
 982     return swash_fetch(PL_utf8_mark, p);
 983 }
 984
 985 UV
 986 Perl_to_utf8_upper(pTHX_ U8 *p)
 987 {
 988     UV uv;
 989
 990     if (!PL_utf8_toupper)
 991         PL_utf8_toupper = swash_init("utf8", "ToUpper", &PL_sv_undef, 4, 0);
 992     uv = swash_fetch(PL_utf8_toupper, p);
 993     return uv ? uv : utf8_to_uv(p,STRLEN_MAX,0,0);
 994 }
 995
 996 UV
 997 Perl_to_utf8_title(pTHX_ U8 *p)
 998 {
 999     UV uv;
1000
1001     if (!PL_utf8_totitle)
1002         PL_utf8_totitle = swash_init("utf8", "ToTitle", &PL_sv_undef, 4, 0);
1003     uv = swash_fetch(PL_utf8_totitle, p);
1004     return uv ? uv : utf8_to_uv(p,STRLEN_MAX,0,0);
1005 }
1006
1007 UV
1008 Perl_to_utf8_lower(pTHX_ U8 *p)
1009 {
1010     UV uv;
1011
1012     if (!PL_utf8_tolower)
1013         PL_utf8_tolower = swash_init("utf8", "ToLower", &PL_sv_undef, 4, 0);
1014     uv = swash_fetch(PL_utf8_tolower, p);
1015     return uv ? uv : utf8_to_uv(p,STRLEN_MAX,0,0);
1016 }
1017
1018 /* a "swash" is a swatch hash */
1019
1020 SV*
1021 Perl_swash_init(pTHX_ char* pkg, char* name, SV *listsv, I32 minbits, I32 none)
1022 {
1023     SV* retval;
1024     char tmpbuf[256];
1025     dSP;
1026
1027     if (!gv_stashpv(pkg, 0)) {  /* demand load utf8 */
1028         ENTER;
1029         Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpv(pkg,0), Nullsv);
1030         LEAVE;
1031     }
1032     SPAGAIN;
1033     PUSHSTACKi(PERLSI_MAGIC);
1034     PUSHMARK(SP);
1035     EXTEND(SP,5);
1036     PUSHs(sv_2mortal(newSVpvn(pkg, strlen(pkg))));
1037     PUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
1038     PUSHs(listsv);
1039     PUSHs(sv_2mortal(newSViv(minbits)));
1040     PUSHs(sv_2mortal(newSViv(none)));
1041     PUTBACK;
1042     ENTER;
1043     SAVEI32(PL_hints);
1044     PL_hints = 0;
1045     save_re_context();
1046     if (PL_curcop == &PL_compiling)     /* XXX ought to be handled by lex_start */
1047         strncpy(tmpbuf, PL_tokenbuf, sizeof tmpbuf);
1048     if (call_method("SWASHNEW", G_SCALAR))
1049         retval = newSVsv(*PL_stack_sp--);
1050     else
1051         retval = &PL_sv_undef;
1052     LEAVE;
1053     POPSTACK;
1054     if (PL_curcop == &PL_compiling) {
1055         strncpy(PL_tokenbuf, tmpbuf, sizeof tmpbuf);
1056         PL_curcop->op_private = PL_hints;
1057     }
1058     if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV)
1059         Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
1060     return retval;
1061 }
1062
1063 UV
1064 Perl_swash_fetch(pTHX_ SV *sv, U8 *ptr)
1065 {
1066     HV* hv = (HV*)SvRV(sv);
1067     U32 klen = UTF8SKIP(ptr) - 1;
1068     U32 off = ptr[klen] & 127;  /* NB: 64 bit always 0 when len > 1 */
1069     STRLEN slen;
1070     STRLEN needents = (klen ? 64 : 128);
1071     U8 *tmps;
1072     U32 bit;
1073     SV *retval;
1074
1075     /*
1076      * This single-entry cache saves about 1/3 of the utf8 overhead in test
1077      * suite.  (That is, only 7-8% overall over just a hash cache.  Still,
1078      * it's nothing to sniff at.)  Pity we usually come through at least
1079      * two function calls to get here...
1080      *
1081      * NB: this code assumes that swatches are never modified, once generated!
1082      */
1083
1084     if (hv == PL_last_swash_hv &&
1085         klen == PL_last_swash_klen &&
1086         (!klen || memEQ((char *)ptr,(char *)PL_last_swash_key,klen)) )
1087     {
1088         tmps = PL_last_swash_tmps;
1089         slen = PL_last_swash_slen;
1090     }
1091     else {
1092         /* Try our second-level swatch cache, kept in a hash. */
1093         SV** svp = hv_fetch(hv, (char*)ptr, klen, FALSE);
1094
1095         /* If not cached, generate it via utf8::SWASHGET */
1096         if (!svp || !SvPOK(*svp) || !(tmps = (U8*)SvPV(*svp, slen))) {
1097             dSP;
1098             ENTER;
1099             SAVETMPS;
1100             save_re_context();
1101             PUSHSTACKi(PERLSI_MAGIC);
1102             PUSHMARK(SP);
1103             EXTEND(SP,3);
1104             PUSHs((SV*)sv);
1105             PUSHs(sv_2mortal(newSViv(utf8_to_uv(ptr, STRLEN_MAX, 0, 0) & ~(needents - 1))));
1106             PUSHs(sv_2mortal(newSViv(needents)));
1107             PUTBACK;
1108             if (call_method("SWASHGET", G_SCALAR))
1109                 retval = newSVsv(*PL_stack_sp--);
1110             else
1111                 retval = &PL_sv_undef;
1112             POPSTACK;
1113             FREETMPS;
1114             LEAVE;
1115             if (PL_curcop == &PL_compiling)
1116                 PL_curcop->op_private = PL_hints;
1117
1118             svp = hv_store(hv, (char*)ptr, klen, retval, 0);
1119
1120             if (!svp || !(tmps = (U8*)SvPV(*svp, slen)) || slen < 8)
1121                 Perl_croak(aTHX_ "SWASHGET didn't return result of proper length");
1122         }
1123
1124         PL_last_swash_hv = hv;
1125         PL_last_swash_klen = klen;
1126         PL_last_swash_tmps = tmps;
1127         PL_last_swash_slen = slen;
1128         if (klen)
1129             Copy(ptr, PL_last_swash_key, klen, U8);
1130     }
1131
1132     switch ((int)((slen << 3) / needents)) {
1133     case 1:
1134         bit = 1 << (off & 7);
1135         off >>= 3;
1136         return (tmps[off] & bit) != 0;
1137     case 8:
1138         return tmps[off];
1139     case 16:
1140         off <<= 1;
1141         return (tmps[off] << 8) + tmps[off + 1] ;
1142     case 32:
1143         off <<= 2;
1144         return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
1145     }
1146     Perl_croak(aTHX_ "panic: swash_fetch");
1147     return 0;
1148 }