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 < 0x1000000000LL)
  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 int
 108 Perl_is_utf8_char(pTHX_ U8 *s)
 109 {
 110     U8 u = *s;
 111     int slen, len;
 112
 113     if (!(u & 0x80))
 114         return 1;
 115
 116     if (!(u & 0x40))
 117         return 0;
 118
 119     if      (!(u & 0x20))       { len = 2; }
 120     else if (!(u & 0x10))       { len = 3; }
 121     else if (!(u & 0x08))       { len = 4; }
 122     else if (!(u & 0x04))       { len = 5; }
 123     else if (!(u & 0x02))       { len = 6; }
 124     else if (!(u & 0x01))       { len = 7; }
 125     else                        { len = 13; } /* whoa! */
 126
 127     slen = len - 1;
 128     s++;
 129     while (slen--) {
 130         if ((*s & 0xc0) != 0x80)
 131             return 0;
 132         s++;
 133     }
 134     return len;
 135 }
 136
 137 /*
 138 =for apidoc Am|bool_utf8_string|U8 *s|STRLEN len
 139
 140 Returns true if first C<len> bytes of the given string form valid a UTF8
 141 string, false otherwise.
 142
 143 =cut
 144 */
 145
 146 bool
 147 Perl_is_utf8_string(pTHX_ U8 *s, STRLEN len)
 148 {
 149     U8* x=s;
 150     U8* send=s+len;
 151     int c;
 152     while (x < send) {
 153         c = is_utf8_char(x);
 154         x += c;
 155         if (!c || x > send)
 156             return 0;
 157     }
 158     return 1;
 159 }
 160
 161 UV
 162 Perl_utf8_to_uv(pTHX_ U8* s, I32* retlen)
 163 {
 164     UV uv = *s;
 165     int len;
 166     if (!(uv & 0x80)) {
 167         if (retlen)
 168             *retlen = 1;
 169         return *s;
 170     }
 171     if (!(uv & 0x40)) {
 172         dTHR;
 173         if (ckWARN_d(WARN_UTF8))
 174             Perl_warner(aTHX_ WARN_UTF8, "Malformed UTF-8 character");
 175         if (retlen)
 176             *retlen = 1;
 177         return *s;
 178     }
 179
 180     if      (!(uv & 0x20))      { len = 2; uv &= 0x1f; }
 181     else if (!(uv & 0x10))      { len = 3; uv &= 0x0f; }
 182     else if (!(uv & 0x08))      { len = 4; uv &= 0x07; }
 183     else if (!(uv & 0x04))      { len = 5; uv &= 0x03; }
 184     else if (!(uv & 0x02))      { len = 6; uv &= 0x01; }
 185     else if (!(uv & 0x01))      { len = 7;  uv = 0; }
 186     else                        { len = 13; uv = 0; } /* whoa! */
 187
 188     if (retlen)
 189         *retlen = len;
 190     --len;
 191     s++;
 192     while (len--) {
 193         if ((*s & 0xc0) != 0x80) {
 194             dTHR;
 195             if (ckWARN_d(WARN_UTF8))
 196                 Perl_warner(aTHX_ WARN_UTF8, "Malformed UTF-8 character");
 197             if (retlen)
 198                 *retlen -= len + 1;
 199             return 0xfffd;
 200         }
 201         else
 202             uv = (uv << 6) | (*s++ & 0x3f);
 203     }
 204     return uv;
 205 }
 206
 207 /* utf8_distance(a,b) is intended to be a - b in pointer arithmetic */
 208
 209 I32
 210 Perl_utf8_distance(pTHX_ U8 *a, U8 *b)
 211 {
 212     I32 off = 0;
 213     if (a < b) {
 214         while (a < b) {
 215             a += UTF8SKIP(a);
 216             off--;
 217         }
 218     }
 219     else {
 220         while (b < a) {
 221             b += UTF8SKIP(b);
 222             off++;
 223         }
 224     }
 225     return off;
 226 }
 227
 228 /* WARNING: do not use the following unless you *know* off is within bounds */
 229
 230 U8 *
 231 Perl_utf8_hop(pTHX_ U8 *s, I32 off)
 232 {
 233     if (off >= 0) {
 234         while (off--)
 235             s += UTF8SKIP(s);
 236     }
 237     else {
 238         while (off++) {
 239             s--;
 240             if (*s & 0x80) {
 241                 while ((*s & 0xc0) == 0x80)
 242                     s--;
 243             }
 244         }
 245     }
 246     return s;
 247 }
 248
 249 /*
 250 =for apidoc Am|U8 *|utf8_to_bytes|U8 *s|STRLEN len
 251
 252 Converts a string C<s> of length C<len> from UTF8 into ASCII encoding.
 253 Unlike C<bytes_to_utf8>, this over-writes the original string.
 254 Returns zero on failure after converting as much as possible.
 255
 256 =cut
 257 */
 258
 259 U8 *
 260 Perl_utf8_to_bytes(pTHX_ U8* s, STRLEN len)
 261 {
 262     dTHR;
 263     U8 *send;
 264     U8 *d;
 265     U8 *save;
 266
 267     send = s + len;
 268     d = save = s;
 269     while (s < send) {
 270         if (*s < 0x80)
 271             *d++ = *s++;
 272         else {
 273             I32 ulen;
 274             UV uv = utf8_to_uv(s, &ulen);
 275             if (uv > 255) {
 276                 *d = '\0';
 277                 return 0;
 278             }
 279             s += ulen;
 280             *d++ = (U8)uv;
 281         }
 282     }
 283     *d = '\0';
 284     return save;
 285 }
 286
 287 /*
 288 =for apidoc Am|U8 *|bytes_to_utf8|U8 *s|STRLEN *len
 289
 290 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
 291 Returns a pointer to the newly-created string, and sets C<len> to
 292 reflect the new length.
 293
 294 =cut
 295 */
 296
 297 U8*
 298 Perl_bytes_to_utf8(pTHX_ U8* s, STRLEN *len)
 299 {
 300     dTHR;
 301     U8 *send;
 302     U8 *d;
 303     U8 *dst;
 304     send = s + (*len);
 305
 306     Newz(801, d, (*len) * 2 + 1, U8);
 307     dst = d;
 308
 309     while (s < send) {
 310         if (*s < 0x80)
 311             *d++ = *s++;
 312         else {
 313             UV uv = *s++;
 314             *d++ = (( uv >>  6)         | 0xc0);
 315             *d++ = (( uv        & 0x3f) | 0x80);
 316         }
 317     }
 318     *d = '\0';
 319     *len = d-dst;
 320     return dst;
 321 }
 322
 323 /* XXX NOTHING CALLS THE FOLLOWING TWO ROUTINES YET!!! */
 324 /*
 325  * Convert native or reversed UTF-16 to UTF-8.
 326  *
 327  * Destination must be pre-extended to 3/2 source.  Do not use in-place.
 328  * We optimize for native, for obvious reasons. */
 329
 330 U8*
 331 Perl_utf16_to_utf8(pTHX_ U16* p, U8* d, I32 bytelen)
 332 {
 333     U16* pend = p + bytelen / 2;
 334     while (p < pend) {
 335         UV uv = *p++;
 336         if (uv < 0x80) {
 337             *d++ = uv;
 338             continue;
 339         }
 340         if (uv < 0x800) {
 341             *d++ = (( uv >>  6)         | 0xc0);
 342             *d++ = (( uv        & 0x3f) | 0x80);
 343             continue;
 344         }
 345         if (uv >= 0xd800 && uv < 0xdbff) {      /* surrogates */
 346             dTHR;
 347             int low = *p++;
 348             if (low < 0xdc00 || low >= 0xdfff) {
 349                 if (ckWARN_d(WARN_UTF8))
 350                     Perl_warner(aTHX_ WARN_UTF8, "Malformed UTF-16 surrogate");
 351                 p--;
 352                 uv = 0xfffd;
 353             }
 354             uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
 355         }
 356         if (uv < 0x10000) {
 357             *d++ = (( uv >> 12)         | 0xe0);
 358             *d++ = (((uv >>  6) & 0x3f) | 0x80);
 359             *d++ = (( uv        & 0x3f) | 0x80);
 360             continue;
 361         }
 362         else {
 363             *d++ = (( uv >> 18)         | 0xf0);
 364             *d++ = (((uv >> 12) & 0x3f) | 0x80);
 365             *d++ = (((uv >>  6) & 0x3f) | 0x80);
 366             *d++ = (( uv        & 0x3f) | 0x80);
 367             continue;
 368         }
 369     }
 370     return d;
 371 }
 372
 373 /* Note: this one is slightly destructive of the source. */
 374
 375 U8*
 376 Perl_utf16_to_utf8_reversed(pTHX_ U16* p, U8* d, I32 bytelen)
 377 {
 378     U8* s = (U8*)p;
 379     U8* send = s + bytelen;
 380     while (s < send) {
 381         U8 tmp = s[0];
 382         s[0] = s[1];
 383         s[1] = tmp;
 384         s += 2;
 385     }
 386     return utf16_to_utf8(p, d, bytelen);
 387 }
 388
 389 /* for now these are all defined (inefficiently) in terms of the utf8 versions */
 390
 391 bool
 392 Perl_is_uni_alnum(pTHX_ U32 c)
 393 {
 394     U8 tmpbuf[UTF8_MAXLEN];
 395     uv_to_utf8(tmpbuf, (UV)c);
 396     return is_utf8_alnum(tmpbuf);
 397 }
 398
 399 bool
 400 Perl_is_uni_alnumc(pTHX_ U32 c)
 401 {
 402     U8 tmpbuf[UTF8_MAXLEN];
 403     uv_to_utf8(tmpbuf, (UV)c);
 404     return is_utf8_alnumc(tmpbuf);
 405 }
 406
 407 bool
 408 Perl_is_uni_idfirst(pTHX_ U32 c)
 409 {
 410     U8 tmpbuf[UTF8_MAXLEN];
 411     uv_to_utf8(tmpbuf, (UV)c);
 412     return is_utf8_idfirst(tmpbuf);
 413 }
 414
 415 bool
 416 Perl_is_uni_alpha(pTHX_ U32 c)
 417 {
 418     U8 tmpbuf[UTF8_MAXLEN];
 419     uv_to_utf8(tmpbuf, (UV)c);
 420     return is_utf8_alpha(tmpbuf);
 421 }
 422
 423 bool
 424 Perl_is_uni_ascii(pTHX_ U32 c)
 425 {
 426     U8 tmpbuf[UTF8_MAXLEN];
 427     uv_to_utf8(tmpbuf, (UV)c);
 428     return is_utf8_ascii(tmpbuf);
 429 }
 430
 431 bool
 432 Perl_is_uni_space(pTHX_ U32 c)
 433 {
 434     U8 tmpbuf[UTF8_MAXLEN];
 435     uv_to_utf8(tmpbuf, (UV)c);
 436     return is_utf8_space(tmpbuf);
 437 }
 438
 439 bool
 440 Perl_is_uni_digit(pTHX_ U32 c)
 441 {
 442     U8 tmpbuf[UTF8_MAXLEN];
 443     uv_to_utf8(tmpbuf, (UV)c);
 444     return is_utf8_digit(tmpbuf);
 445 }
 446
 447 bool
 448 Perl_is_uni_upper(pTHX_ U32 c)
 449 {
 450     U8 tmpbuf[UTF8_MAXLEN];
 451     uv_to_utf8(tmpbuf, (UV)c);
 452     return is_utf8_upper(tmpbuf);
 453 }
 454
 455 bool
 456 Perl_is_uni_lower(pTHX_ U32 c)
 457 {
 458     U8 tmpbuf[UTF8_MAXLEN];
 459     uv_to_utf8(tmpbuf, (UV)c);
 460     return is_utf8_lower(tmpbuf);
 461 }
 462
 463 bool
 464 Perl_is_uni_cntrl(pTHX_ U32 c)
 465 {
 466     U8 tmpbuf[UTF8_MAXLEN];
 467     uv_to_utf8(tmpbuf, (UV)c);
 468     return is_utf8_cntrl(tmpbuf);
 469 }
 470
 471 bool
 472 Perl_is_uni_graph(pTHX_ U32 c)
 473 {
 474     U8 tmpbuf[UTF8_MAXLEN];
 475     uv_to_utf8(tmpbuf, (UV)c);
 476     return is_utf8_graph(tmpbuf);
 477 }
 478
 479 bool
 480 Perl_is_uni_print(pTHX_ U32 c)
 481 {
 482     U8 tmpbuf[UTF8_MAXLEN];
 483     uv_to_utf8(tmpbuf, (UV)c);
 484     return is_utf8_print(tmpbuf);
 485 }
 486
 487 bool
 488 Perl_is_uni_punct(pTHX_ U32 c)
 489 {
 490     U8 tmpbuf[UTF8_MAXLEN];
 491     uv_to_utf8(tmpbuf, (UV)c);
 492     return is_utf8_punct(tmpbuf);
 493 }
 494
 495 bool
 496 Perl_is_uni_xdigit(pTHX_ U32 c)
 497 {
 498     U8 tmpbuf[UTF8_MAXLEN];
 499     uv_to_utf8(tmpbuf, (UV)c);
 500     return is_utf8_xdigit(tmpbuf);
 501 }
 502
 503 U32
 504 Perl_to_uni_upper(pTHX_ U32 c)
 505 {
 506     U8 tmpbuf[UTF8_MAXLEN];
 507     uv_to_utf8(tmpbuf, (UV)c);
 508     return to_utf8_upper(tmpbuf);
 509 }
 510
 511 U32
 512 Perl_to_uni_title(pTHX_ U32 c)
 513 {
 514     U8 tmpbuf[UTF8_MAXLEN];
 515     uv_to_utf8(tmpbuf, (UV)c);
 516     return to_utf8_title(tmpbuf);
 517 }
 518
 519 U32
 520 Perl_to_uni_lower(pTHX_ U32 c)
 521 {
 522     U8 tmpbuf[UTF8_MAXLEN];
 523     uv_to_utf8(tmpbuf, (UV)c);
 524     return to_utf8_lower(tmpbuf);
 525 }
 526
 527 /* for now these all assume no locale info available for Unicode > 255 */
 528
 529 bool
 530 Perl_is_uni_alnum_lc(pTHX_ U32 c)
 531 {
 532     return is_uni_alnum(c);     /* XXX no locale support yet */
 533 }
 534
 535 bool
 536 Perl_is_uni_alnumc_lc(pTHX_ U32 c)
 537 {
 538     return is_uni_alnumc(c);    /* XXX no locale support yet */
 539 }
 540
 541 bool
 542 Perl_is_uni_idfirst_lc(pTHX_ U32 c)
 543 {
 544     return is_uni_idfirst(c);   /* XXX no locale support yet */
 545 }
 546
 547 bool
 548 Perl_is_uni_alpha_lc(pTHX_ U32 c)
 549 {
 550     return is_uni_alpha(c);     /* XXX no locale support yet */
 551 }
 552
 553 bool
 554 Perl_is_uni_ascii_lc(pTHX_ U32 c)
 555 {
 556     return is_uni_ascii(c);     /* XXX no locale support yet */
 557 }
 558
 559 bool
 560 Perl_is_uni_space_lc(pTHX_ U32 c)
 561 {
 562     return is_uni_space(c);     /* XXX no locale support yet */
 563 }
 564
 565 bool
 566 Perl_is_uni_digit_lc(pTHX_ U32 c)
 567 {
 568     return is_uni_digit(c);     /* XXX no locale support yet */
 569 }
 570
 571 bool
 572 Perl_is_uni_upper_lc(pTHX_ U32 c)
 573 {
 574     return is_uni_upper(c);     /* XXX no locale support yet */
 575 }
 576
 577 bool
 578 Perl_is_uni_lower_lc(pTHX_ U32 c)
 579 {
 580     return is_uni_lower(c);     /* XXX no locale support yet */
 581 }
 582
 583 bool
 584 Perl_is_uni_cntrl_lc(pTHX_ U32 c)
 585 {
 586     return is_uni_cntrl(c);     /* XXX no locale support yet */
 587 }
 588
 589 bool
 590 Perl_is_uni_graph_lc(pTHX_ U32 c)
 591 {
 592     return is_uni_graph(c);     /* XXX no locale support yet */
 593 }
 594
 595 bool
 596 Perl_is_uni_print_lc(pTHX_ U32 c)
 597 {
 598     return is_uni_print(c);     /* XXX no locale support yet */
 599 }
 600
 601 bool
 602 Perl_is_uni_punct_lc(pTHX_ U32 c)
 603 {
 604     return is_uni_punct(c);     /* XXX no locale support yet */
 605 }
 606
 607 bool
 608 Perl_is_uni_xdigit_lc(pTHX_ U32 c)
 609 {
 610     return is_uni_xdigit(c);    /* XXX no locale support yet */
 611 }
 612
 613 U32
 614 Perl_to_uni_upper_lc(pTHX_ U32 c)
 615 {
 616     return to_uni_upper(c);     /* XXX no locale support yet */
 617 }
 618
 619 U32
 620 Perl_to_uni_title_lc(pTHX_ U32 c)
 621 {
 622     return to_uni_title(c);     /* XXX no locale support yet */
 623 }
 624
 625 U32
 626 Perl_to_uni_lower_lc(pTHX_ U32 c)
 627 {
 628     return to_uni_lower(c);     /* XXX no locale support yet */
 629 }
 630
 631 bool
 632 Perl_is_utf8_alnum(pTHX_ U8 *p)
 633 {
 634     if (!is_utf8_char(p))
 635         return FALSE;
 636     if (!PL_utf8_alnum)
 637         PL_utf8_alnum = swash_init("utf8", "IsAlnum", &PL_sv_undef, 0, 0);
 638     return swash_fetch(PL_utf8_alnum, p);
 639 /*    return *p == '_' || is_utf8_alpha(p) || is_utf8_digit(p); */
 640 #ifdef SURPRISINGLY_SLOWER  /* probably because alpha is usually true */
 641     if (!PL_utf8_alnum)
 642         PL_utf8_alnum = swash_init("utf8", "",
 643             sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
 644     return swash_fetch(PL_utf8_alnum, p);
 645 #endif
 646 }
 647
 648 bool
 649 Perl_is_utf8_alnumc(pTHX_ U8 *p)
 650 {
 651     if (!is_utf8_char(p))
 652         return FALSE;
 653     if (!PL_utf8_alnum)
 654         PL_utf8_alnum = swash_init("utf8", "IsAlnumC", &PL_sv_undef, 0, 0);
 655     return swash_fetch(PL_utf8_alnum, p);
 656 /*    return is_utf8_alpha(p) || is_utf8_digit(p); */
 657 #ifdef SURPRISINGLY_SLOWER  /* probably because alpha is usually true */
 658     if (!PL_utf8_alnum)
 659         PL_utf8_alnum = swash_init("utf8", "",
 660             sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
 661     return swash_fetch(PL_utf8_alnum, p);
 662 #endif
 663 }
 664
 665 bool
 666 Perl_is_utf8_idfirst(pTHX_ U8 *p)
 667 {
 668     return *p == '_' || is_utf8_alpha(p);
 669 }
 670
 671 bool
 672 Perl_is_utf8_alpha(pTHX_ U8 *p)
 673 {
 674     if (!is_utf8_char(p))
 675         return FALSE;
 676     if (!PL_utf8_alpha)
 677         PL_utf8_alpha = swash_init("utf8", "IsAlpha", &PL_sv_undef, 0, 0);
 678     return swash_fetch(PL_utf8_alpha, p);
 679 }
 680
 681 bool
 682 Perl_is_utf8_ascii(pTHX_ U8 *p)
 683 {
 684     if (!is_utf8_char(p))
 685         return FALSE;
 686     if (!PL_utf8_ascii)
 687         PL_utf8_ascii = swash_init("utf8", "IsAscii", &PL_sv_undef, 0, 0);
 688     return swash_fetch(PL_utf8_ascii, p);
 689 }
 690
 691 bool
 692 Perl_is_utf8_space(pTHX_ U8 *p)
 693 {
 694     if (!is_utf8_char(p))
 695         return FALSE;
 696     if (!PL_utf8_space)
 697         PL_utf8_space = swash_init("utf8", "IsSpace", &PL_sv_undef, 0, 0);
 698     return swash_fetch(PL_utf8_space, p);
 699 }
 700
 701 bool
 702 Perl_is_utf8_digit(pTHX_ U8 *p)
 703 {
 704     if (!is_utf8_char(p))
 705         return FALSE;
 706     if (!PL_utf8_digit)
 707         PL_utf8_digit = swash_init("utf8", "IsDigit", &PL_sv_undef, 0, 0);
 708     return swash_fetch(PL_utf8_digit, p);
 709 }
 710
 711 bool
 712 Perl_is_utf8_upper(pTHX_ U8 *p)
 713 {
 714     if (!is_utf8_char(p))
 715         return FALSE;
 716     if (!PL_utf8_upper)
 717         PL_utf8_upper = swash_init("utf8", "IsUpper", &PL_sv_undef, 0, 0);
 718     return swash_fetch(PL_utf8_upper, p);
 719 }
 720
 721 bool
 722 Perl_is_utf8_lower(pTHX_ U8 *p)
 723 {
 724     if (!is_utf8_char(p))
 725         return FALSE;
 726     if (!PL_utf8_lower)
 727         PL_utf8_lower = swash_init("utf8", "IsLower", &PL_sv_undef, 0, 0);
 728     return swash_fetch(PL_utf8_lower, p);
 729 }
 730
 731 bool
 732 Perl_is_utf8_cntrl(pTHX_ U8 *p)
 733 {
 734     if (!is_utf8_char(p))
 735         return FALSE;
 736     if (!PL_utf8_cntrl)
 737         PL_utf8_cntrl = swash_init("utf8", "IsCntrl", &PL_sv_undef, 0, 0);
 738     return swash_fetch(PL_utf8_cntrl, p);
 739 }
 740
 741 bool
 742 Perl_is_utf8_graph(pTHX_ U8 *p)
 743 {
 744     if (!is_utf8_char(p))
 745         return FALSE;
 746     if (!PL_utf8_graph)
 747         PL_utf8_graph = swash_init("utf8", "IsGraph", &PL_sv_undef, 0, 0);
 748     return swash_fetch(PL_utf8_graph, p);
 749 }
 750
 751 bool
 752 Perl_is_utf8_print(pTHX_ U8 *p)
 753 {
 754     if (!is_utf8_char(p))
 755         return FALSE;
 756     if (!PL_utf8_print)
 757         PL_utf8_print = swash_init("utf8", "IsPrint", &PL_sv_undef, 0, 0);
 758     return swash_fetch(PL_utf8_print, p);
 759 }
 760
 761 bool
 762 Perl_is_utf8_punct(pTHX_ U8 *p)
 763 {
 764     if (!is_utf8_char(p))
 765         return FALSE;
 766     if (!PL_utf8_punct)
 767         PL_utf8_punct = swash_init("utf8", "IsPunct", &PL_sv_undef, 0, 0);
 768     return swash_fetch(PL_utf8_punct, p);
 769 }
 770
 771 bool
 772 Perl_is_utf8_xdigit(pTHX_ U8 *p)
 773 {
 774     if (!is_utf8_char(p))
 775         return FALSE;
 776     if (!PL_utf8_xdigit)
 777         PL_utf8_xdigit = swash_init("utf8", "IsXDigit", &PL_sv_undef, 0, 0);
 778     return swash_fetch(PL_utf8_xdigit, p);
 779 }
 780
 781 bool
 782 Perl_is_utf8_mark(pTHX_ U8 *p)
 783 {
 784     if (!is_utf8_char(p))
 785         return FALSE;
 786     if (!PL_utf8_mark)
 787         PL_utf8_mark = swash_init("utf8", "IsM", &PL_sv_undef, 0, 0);
 788     return swash_fetch(PL_utf8_mark, p);
 789 }
 790
 791 UV
 792 Perl_to_utf8_upper(pTHX_ U8 *p)
 793 {
 794     UV uv;
 795
 796     if (!PL_utf8_toupper)
 797         PL_utf8_toupper = swash_init("utf8", "ToUpper", &PL_sv_undef, 4, 0);
 798     uv = swash_fetch(PL_utf8_toupper, p);
 799     return uv ? uv : utf8_to_uv(p,0);
 800 }
 801
 802 UV
 803 Perl_to_utf8_title(pTHX_ U8 *p)
 804 {
 805     UV uv;
 806
 807     if (!PL_utf8_totitle)
 808         PL_utf8_totitle = swash_init("utf8", "ToTitle", &PL_sv_undef, 4, 0);
 809     uv = swash_fetch(PL_utf8_totitle, p);
 810     return uv ? uv : utf8_to_uv(p,0);
 811 }
 812
 813 UV
 814 Perl_to_utf8_lower(pTHX_ U8 *p)
 815 {
 816     UV uv;
 817
 818     if (!PL_utf8_tolower)
 819         PL_utf8_tolower = swash_init("utf8", "ToLower", &PL_sv_undef, 4, 0);
 820     uv = swash_fetch(PL_utf8_tolower, p);
 821     return uv ? uv : utf8_to_uv(p,0);
 822 }
 823
 824 /* a "swash" is a swatch hash */
 825
 826 SV*
 827 Perl_swash_init(pTHX_ char* pkg, char* name, SV *listsv, I32 minbits, I32 none)
 828 {
 829     SV* retval;
 830     char tmpbuf[256];
 831     dSP;
 832
 833     if (!gv_stashpv(pkg, 0)) {  /* demand load utf8 */
 834         ENTER;
 835         Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpv(pkg,0), Nullsv);
 836         LEAVE;
 837     }
 838     SPAGAIN;
 839     PUSHSTACKi(PERLSI_MAGIC);
 840     PUSHMARK(SP);
 841     EXTEND(SP,5);
 842     PUSHs(sv_2mortal(newSVpvn(pkg, strlen(pkg))));
 843     PUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
 844     PUSHs(listsv);
 845     PUSHs(sv_2mortal(newSViv(minbits)));
 846     PUSHs(sv_2mortal(newSViv(none)));
 847     PUTBACK;
 848     ENTER;
 849     SAVEI32(PL_hints);
 850     PL_hints = 0;
 851     save_re_context();
 852     if (PL_curcop == &PL_compiling)     /* XXX ought to be handled by lex_start */
 853         strncpy(tmpbuf, PL_tokenbuf, sizeof tmpbuf);
 854     if (call_method("SWASHNEW", G_SCALAR))
 855         retval = newSVsv(*PL_stack_sp--);
 856     else
 857         retval = &PL_sv_undef;
 858     LEAVE;
 859     POPSTACK;
 860     if (PL_curcop == &PL_compiling) {
 861         strncpy(PL_tokenbuf, tmpbuf, sizeof tmpbuf);
 862         PL_curcop->op_private = PL_hints;
 863     }
 864     if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV)
 865         Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
 866     return retval;
 867 }
 868
 869 UV
 870 Perl_swash_fetch(pTHX_ SV *sv, U8 *ptr)
 871 {
 872     HV* hv = (HV*)SvRV(sv);
 873     U32 klen = UTF8SKIP(ptr) - 1;
 874     U32 off = ptr[klen] & 127;  /* NB: 64 bit always 0 when len > 1 */
 875     STRLEN slen;
 876     STRLEN needents = (klen ? 64 : 128);
 877     U8 *tmps;
 878     U32 bit;
 879     SV *retval;
 880
 881     /*
 882      * This single-entry cache saves about 1/3 of the utf8 overhead in test
 883      * suite.  (That is, only 7-8% overall over just a hash cache.  Still,
 884      * it's nothing to sniff at.)  Pity we usually come through at least
 885      * two function calls to get here...
 886      *
 887      * NB: this code assumes that swatches are never modified, once generated!
 888      */
 889
 890     if (hv == PL_last_swash_hv &&
 891         klen == PL_last_swash_klen &&
 892         (!klen || memEQ((char *)ptr,(char *)PL_last_swash_key,klen)) )
 893     {
 894         tmps = PL_last_swash_tmps;
 895         slen = PL_last_swash_slen;
 896     }
 897     else {
 898         /* Try our second-level swatch cache, kept in a hash. */
 899         SV** svp = hv_fetch(hv, (char*)ptr, klen, FALSE);
 900
 901         /* If not cached, generate it via utf8::SWASHGET */
 902         if (!svp || !SvPOK(*svp) || !(tmps = (U8*)SvPV(*svp, slen))) {
 903             dSP;
 904             ENTER;
 905             SAVETMPS;
 906             save_re_context();
 907             PUSHSTACKi(PERLSI_MAGIC);
 908             PUSHMARK(SP);
 909             EXTEND(SP,3);
 910             PUSHs((SV*)sv);
 911             PUSHs(sv_2mortal(newSViv(utf8_to_uv(ptr, 0) & ~(needents - 1))));
 912             PUSHs(sv_2mortal(newSViv(needents)));
 913             PUTBACK;
 914             if (call_method("SWASHGET", G_SCALAR))
 915                 retval = newSVsv(*PL_stack_sp--);
 916             else
 917                 retval = &PL_sv_undef;
 918             POPSTACK;
 919             FREETMPS;
 920             LEAVE;
 921             if (PL_curcop == &PL_compiling)
 922                 PL_curcop->op_private = PL_hints;
 923
 924             svp = hv_store(hv, (char*)ptr, klen, retval, 0);
 925
 926             if (!svp || !(tmps = (U8*)SvPV(*svp, slen)) || slen < 8)
 927                 Perl_croak(aTHX_ "SWASHGET didn't return result of proper length");
 928         }
 929
 930         PL_last_swash_hv = hv;
 931         PL_last_swash_klen = klen;
 932         PL_last_swash_tmps = tmps;
 933         PL_last_swash_slen = slen;
 934         if (klen)
 935             Copy(ptr, PL_last_swash_key, klen, U8);
 936     }
 937
 938     switch ((slen << 3) / needents) {
 939     case 1:
 940         bit = 1 << (off & 7);
 941         off >>= 3;
 942         return (tmps[off] & bit) != 0;
 943     case 8:
 944         return tmps[off];
 945     case 16:
 946         off <<= 1;
 947         return (tmps[off] << 8) + tmps[off + 1] ;
 948     case 32:
 949         off <<= 2;
 950         return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
 951     }
 952     Perl_croak(aTHX_ "panic: swash_fetch");
 953     return 0;
 954 }