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