utf8.c

   1 /*    utf8.c
   2  *
   3  *    Copyright (c) 1998-1999, 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 Quad_t
  72     if (uv < 0x2000000000)
  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 Quad_t
  85     {
  86         *d++ =                        0xff;     /* Can't match U+FFFE! */
  87         *d++ = (((uv >> 36) & 0x3f) | 0x80);
  88         *d++ = (((uv >> 30) & 0x3f) | 0x80);
  89         *d++ = (((uv >> 24) & 0x3f) | 0x80);
  90         *d++ = (((uv >> 18) & 0x3f) | 0x80);
  91         *d++ = (((uv >> 12) & 0x3f) | 0x80);
  92         *d++ = (((uv >>  6) & 0x3f) | 0x80);
  93         *d++ = (( uv        & 0x3f) | 0x80);
  94         return d;
  95     }
  96 #endif
  97 }
  98
  99 UV
 100 Perl_utf8_to_uv(pTHX_ U8* s, I32* retlen)
 101 {
 102     UV uv = *s;
 103     int len;
 104     if (!(uv & 0x80)) {
 105         if (retlen)
 106             *retlen = 1;
 107         return *s;
 108     }
 109     if (!(uv & 0x40)) {
 110         Perl_warn(aTHX_ "Malformed UTF-8 character");
 111         if (retlen)
 112             *retlen = 1;
 113         return *s;
 114     }
 115
 116     if      (!(uv & 0x20))      { len = 2; uv &= 0x1f; }
 117     else if (!(uv & 0x10))      { len = 3; uv &= 0x0f; }
 118     else if (!(uv & 0x08))      { len = 4; uv &= 0x07; }
 119     else if (!(uv & 0x04))      { len = 5; uv &= 0x03; }
 120     else if (!(uv & 0x02))      { len = 6; uv &= 0x01; }
 121     else if (!(uv & 0x01))      { len = 7; uv &= 0x00; }
 122     else                          len = 8;      /* whoa! */
 123
 124     if (retlen)
 125         *retlen = len;
 126     --len;
 127     s++;
 128     while (len--) {
 129         if ((*s & 0xc0) != 0x80) {
 130             Perl_warn(aTHX_ "Malformed UTF-8 character");
 131             if (retlen)
 132                 *retlen -= len + 1;
 133             return 0xfffd;
 134         }
 135         else
 136             uv = (uv << 6) | (*s++ & 0x3f);
 137     }
 138     return uv;
 139 }
 140
 141 /* utf8_distance(a,b) is intended to be a - b in pointer arithmetic */
 142
 143 I32
 144 Perl_utf8_distance(pTHX_ U8 *a, U8 *b)
 145 {
 146     I32 off = 0;
 147     if (a < b) {
 148         while (a < b) {
 149             a += UTF8SKIP(a);
 150             off--;
 151         }
 152     }
 153     else {
 154         while (b < a) {
 155             b += UTF8SKIP(b);
 156             off++;
 157         }
 158     }
 159     return off;
 160 }
 161
 162 /* WARNING: do not use the following unless you *know* off is within bounds */
 163
 164 U8 *
 165 Perl_utf8_hop(pTHX_ U8 *s, I32 off)
 166 {
 167     if (off >= 0) {
 168         while (off--)
 169             s += UTF8SKIP(s);
 170     }
 171     else {
 172         while (off++) {
 173             s--;
 174             if (*s & 0x80) {
 175                 while ((*s & 0xc0) == 0x80)
 176                     s--;
 177             }
 178         }
 179     }
 180     return s;
 181 }
 182
 183 /* XXX NOTHING CALLS THE FOLLOWING TWO ROUTINES YET!!! */
 184 /*
 185  * Convert native or reversed UTF-16 to UTF-8.
 186  *
 187  * Destination must be pre-extended to 3/2 source.  Do not use in-place.
 188  * We optimize for native, for obvious reasons. */
 189
 190 U8*
 191 Perl_utf16_to_utf8(pTHX_ U16* p, U8* d, I32 bytelen)
 192 {
 193     U16* pend = p + bytelen / 2;
 194     while (p < pend) {
 195         UV uv = *p++;
 196         if (uv < 0x80) {
 197             *d++ = uv;
 198             continue;
 199         }
 200         if (uv < 0x800) {
 201             *d++ = (( uv >>  6)         | 0xc0);
 202             *d++ = (( uv        & 0x3f) | 0x80);
 203             continue;
 204         }
 205         if (uv >= 0xd800 && uv < 0xdbff) {      /* surrogates */
 206             int low = *p++;
 207             if (low < 0xdc00 || low >= 0xdfff) {
 208                 Perl_warn(aTHX_ "Malformed UTF-16 surrogate");
 209                 p--;
 210                 uv = 0xfffd;
 211             }
 212             uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
 213         }
 214         if (uv < 0x10000) {
 215             *d++ = (( uv >> 12)         | 0xe0);
 216             *d++ = (((uv >>  6) & 0x3f) | 0x80);
 217             *d++ = (( uv        & 0x3f) | 0x80);
 218             continue;
 219         }
 220         else {
 221             *d++ = (( uv >> 18)         | 0xf0);
 222             *d++ = (((uv >> 12) & 0x3f) | 0x80);
 223             *d++ = (((uv >>  6) & 0x3f) | 0x80);
 224             *d++ = (( uv        & 0x3f) | 0x80);
 225             continue;
 226         }
 227     }
 228     return d;
 229 }
 230
 231 /* Note: this one is slightly destructive of the source. */
 232
 233 U8*
 234 Perl_utf16_to_utf8_reversed(pTHX_ U16* p, U8* d, I32 bytelen)
 235 {
 236     U8* s = (U8*)p;
 237     U8* send = s + bytelen;
 238     while (s < send) {
 239         U8 tmp = s[0];
 240         s[0] = s[1];
 241         s[1] = tmp;
 242         s += 2;
 243     }
 244     return utf16_to_utf8(p, d, bytelen);
 245 }
 246
 247 /* for now these are all defined (inefficiently) in terms of the utf8 versions */
 248
 249 bool
 250 Perl_is_uni_alnum(pTHX_ U32 c)
 251 {
 252     U8 tmpbuf[10];
 253     uv_to_utf8(tmpbuf, (UV)c);
 254     return is_utf8_alnum(tmpbuf);
 255 }
 256
 257 bool
 258 Perl_is_uni_alnumc(pTHX_ U32 c)
 259 {
 260     U8 tmpbuf[10];
 261     uv_to_utf8(tmpbuf, (UV)c);
 262     return is_utf8_alnumc(tmpbuf);
 263 }
 264
 265 bool
 266 Perl_is_uni_idfirst(pTHX_ U32 c)
 267 {
 268     U8 tmpbuf[10];
 269     uv_to_utf8(tmpbuf, (UV)c);
 270     return is_utf8_idfirst(tmpbuf);
 271 }
 272
 273 bool
 274 Perl_is_uni_alpha(pTHX_ U32 c)
 275 {
 276     U8 tmpbuf[10];
 277     uv_to_utf8(tmpbuf, (UV)c);
 278     return is_utf8_alpha(tmpbuf);
 279 }
 280
 281 bool
 282 Perl_is_uni_space(pTHX_ U32 c)
 283 {
 284     U8 tmpbuf[10];
 285     uv_to_utf8(tmpbuf, (UV)c);
 286     return is_utf8_space(tmpbuf);
 287 }
 288
 289 bool
 290 Perl_is_uni_digit(pTHX_ U32 c)
 291 {
 292     U8 tmpbuf[10];
 293     uv_to_utf8(tmpbuf, (UV)c);
 294     return is_utf8_digit(tmpbuf);
 295 }
 296
 297 bool
 298 Perl_is_uni_upper(pTHX_ U32 c)
 299 {
 300     U8 tmpbuf[10];
 301     uv_to_utf8(tmpbuf, (UV)c);
 302     return is_utf8_upper(tmpbuf);
 303 }
 304
 305 bool
 306 Perl_is_uni_lower(pTHX_ U32 c)
 307 {
 308     U8 tmpbuf[10];
 309     uv_to_utf8(tmpbuf, (UV)c);
 310     return is_utf8_lower(tmpbuf);
 311 }
 312
 313 bool
 314 Perl_is_uni_cntrl(pTHX_ U32 c)
 315 {
 316     U8 tmpbuf[10];
 317     uv_to_utf8(tmpbuf, (UV)c);
 318     return is_utf8_cntrl(tmpbuf);
 319 }
 320
 321 bool
 322 Perl_is_uni_graph(pTHX_ U32 c)
 323 {
 324     U8 tmpbuf[10];
 325     uv_to_utf8(tmpbuf, (UV)c);
 326     return is_utf8_graph(tmpbuf);
 327 }
 328
 329 bool
 330 Perl_is_uni_print(pTHX_ U32 c)
 331 {
 332     U8 tmpbuf[10];
 333     uv_to_utf8(tmpbuf, (UV)c);
 334     return is_utf8_print(tmpbuf);
 335 }
 336
 337 bool
 338 is_uni_punct(U32 c)
 339 {
 340     U8 tmpbuf[10];
 341     uv_to_utf8(tmpbuf, (UV)c);
 342     return is_utf8_punct(tmpbuf);
 343 }
 344
 345 U32
 346 Perl_to_uni_upper(pTHX_ U32 c)
 347 {
 348     U8 tmpbuf[10];
 349     uv_to_utf8(tmpbuf, (UV)c);
 350     return to_utf8_upper(tmpbuf);
 351 }
 352
 353 U32
 354 Perl_to_uni_title(pTHX_ U32 c)
 355 {
 356     U8 tmpbuf[10];
 357     uv_to_utf8(tmpbuf, (UV)c);
 358     return to_utf8_title(tmpbuf);
 359 }
 360
 361 U32
 362 Perl_to_uni_lower(pTHX_ U32 c)
 363 {
 364     U8 tmpbuf[10];
 365     uv_to_utf8(tmpbuf, (UV)c);
 366     return to_utf8_lower(tmpbuf);
 367 }
 368
 369 /* for now these all assume no locale info available for Unicode > 255 */
 370
 371 bool
 372 Perl_is_uni_alnum_lc(pTHX_ U32 c)
 373 {
 374     return is_uni_alnum(c);     /* XXX no locale support yet */
 375 }
 376
 377 bool
 378 Perl_is_uni_alnumc_lc(pTHX_ U32 c)
 379 {
 380     return is_uni_alnumc(c);    /* XXX no locale support yet */
 381 }
 382
 383 bool
 384 Perl_is_uni_idfirst_lc(pTHX_ U32 c)
 385 {
 386     return is_uni_idfirst(c);   /* XXX no locale support yet */
 387 }
 388
 389 bool
 390 Perl_is_uni_alpha_lc(pTHX_ U32 c)
 391 {
 392     return is_uni_alpha(c);     /* XXX no locale support yet */
 393 }
 394
 395 bool
 396 Perl_is_uni_space_lc(pTHX_ U32 c)
 397 {
 398     return is_uni_space(c);     /* XXX no locale support yet */
 399 }
 400
 401 bool
 402 Perl_is_uni_digit_lc(pTHX_ U32 c)
 403 {
 404     return is_uni_digit(c);     /* XXX no locale support yet */
 405 }
 406
 407 bool
 408 Perl_is_uni_upper_lc(pTHX_ U32 c)
 409 {
 410     return is_uni_upper(c);     /* XXX no locale support yet */
 411 }
 412
 413 bool
 414 Perl_is_uni_lower_lc(pTHX_ U32 c)
 415 {
 416     return is_uni_lower(c);     /* XXX no locale support yet */
 417 }
 418
 419 bool
 420 Perl_is_uni_cntrl_lc(pTHX_ U32 c)
 421 {
 422     return is_uni_cntrl(c);     /* XXX no locale support yet */
 423 }
 424
 425 bool
 426 Perl_is_uni_graph_lc(pTHX_ U32 c)
 427 {
 428     return is_uni_graph(c);     /* XXX no locale support yet */
 429 }
 430
 431 bool
 432 Perl_is_uni_print_lc(pTHX_ U32 c)
 433 {
 434     return is_uni_print(c);     /* XXX no locale support yet */
 435 }
 436
 437 bool
 438 Perl_is_uni_punct_lc(pTHX_ U32 c)
 439 {
 440     return is_uni_punct(c);     /* XXX no locale support yet */
 441 }
 442
 443 U32
 444 Perl_to_uni_upper_lc(pTHX_ U32 c)
 445 {
 446     return to_uni_upper(c);     /* XXX no locale support yet */
 447 }
 448
 449 U32
 450 Perl_to_uni_title_lc(pTHX_ U32 c)
 451 {
 452     return to_uni_title(c);     /* XXX no locale support yet */
 453 }
 454
 455 U32
 456 Perl_to_uni_lower_lc(pTHX_ U32 c)
 457 {
 458     return to_uni_lower(c);     /* XXX no locale support yet */
 459 }
 460
 461 bool
 462 Perl_is_utf8_alnum(pTHX_ U8 *p)
 463 {
 464     if (!PL_utf8_alnum)
 465         PL_utf8_alnum = swash_init("utf8", "IsAlnum", &PL_sv_undef, 0, 0);
 466     return swash_fetch(PL_utf8_alnum, p);
 467 /*    return *p == '_' || is_utf8_alpha(p) || is_utf8_digit(p); */
 468 #ifdef SURPRISINGLY_SLOWER  /* probably because alpha is usually true */
 469     if (!PL_utf8_alnum)
 470         PL_utf8_alnum = swash_init("utf8", "",
 471             sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
 472     return swash_fetch(PL_utf8_alnum, p);
 473 #endif
 474 }
 475
 476 bool
 477 Perl_is_utf8_alnumc(pTHX_ U8 *p)
 478 {
 479     if (!PL_utf8_alnum)
 480         PL_utf8_alnum = swash_init("utf8", "IsAlnumC", &PL_sv_undef, 0, 0);
 481     return swash_fetch(PL_utf8_alnum, p);
 482 /*    return is_utf8_alpha(p) || is_utf8_digit(p); */
 483 #ifdef SURPRISINGLY_SLOWER  /* probably because alpha is usually true */
 484     if (!PL_utf8_alnum)
 485         PL_utf8_alnum = swash_init("utf8", "",
 486             sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
 487     return swash_fetch(PL_utf8_alnum, p);
 488 #endif
 489 }
 490
 491 bool
 492 Perl_is_utf8_idfirst(pTHX_ U8 *p)
 493 {
 494     return *p == '_' || is_utf8_alpha(p);
 495 }
 496
 497 bool
 498 Perl_is_utf8_alpha(pTHX_ U8 *p)
 499 {
 500     if (!PL_utf8_alpha)
 501         PL_utf8_alpha = swash_init("utf8", "IsAlpha", &PL_sv_undef, 0, 0);
 502     return swash_fetch(PL_utf8_alpha, p);
 503 }
 504
 505 bool
 506 Perl_is_utf8_ascii(pTHX_ U8 *p)
 507 {
 508     if (!PL_utf8_ascii)
 509         PL_utf8_ascii = swash_init("utf8", "IsAscii", &PL_sv_undef, 0, 0);
 510     return swash_fetch(PL_utf8_ascii, p);
 511 }
 512
 513 bool
 514 Perl_is_utf8_space(pTHX_ U8 *p)
 515 {
 516     if (!PL_utf8_space)
 517         PL_utf8_space = swash_init("utf8", "IsSpace", &PL_sv_undef, 0, 0);
 518     return swash_fetch(PL_utf8_space, p);
 519 }
 520
 521 bool
 522 Perl_is_utf8_digit(pTHX_ U8 *p)
 523 {
 524     if (!PL_utf8_digit)
 525         PL_utf8_digit = swash_init("utf8", "IsDigit", &PL_sv_undef, 0, 0);
 526     return swash_fetch(PL_utf8_digit, p);
 527 }
 528
 529 bool
 530 Perl_is_utf8_upper(pTHX_ U8 *p)
 531 {
 532     if (!PL_utf8_upper)
 533         PL_utf8_upper = swash_init("utf8", "IsUpper", &PL_sv_undef, 0, 0);
 534     return swash_fetch(PL_utf8_upper, p);
 535 }
 536
 537 bool
 538 Perl_is_utf8_lower(pTHX_ U8 *p)
 539 {
 540     if (!PL_utf8_lower)
 541         PL_utf8_lower = swash_init("utf8", "IsLower", &PL_sv_undef, 0, 0);
 542     return swash_fetch(PL_utf8_lower, p);
 543 }
 544
 545 bool
 546 Perl_is_utf8_cntrl(pTHX_ U8 *p)
 547 {
 548     if (!PL_utf8_cntrl)
 549         PL_utf8_cntrl = swash_init("utf8", "IsCntrl", &PL_sv_undef, 0, 0);
 550     return swash_fetch(PL_utf8_cntrl, p);
 551 }
 552
 553 bool
 554 Perl_is_utf8_graph(pTHX_ U8 *p)
 555 {
 556     if (!PL_utf8_graph)
 557         PL_utf8_graph = swash_init("utf8", "IsGraph", &PL_sv_undef, 0, 0);
 558     return swash_fetch(PL_utf8_graph, p);
 559 }
 560
 561 bool
 562 Perl_is_utf8_print(pTHX_ U8 *p)
 563 {
 564     if (!PL_utf8_print)
 565         PL_utf8_print = swash_init("utf8", "IsPrint", &PL_sv_undef, 0, 0);
 566     return swash_fetch(PL_utf8_print, p);
 567 }
 568
 569 bool
 570 Perl_is_utf8_punct(pTHX_ U8 *p)
 571 {
 572     if (!PL_utf8_punct)
 573         PL_utf8_punct = swash_init("utf8", "IsPunct", &PL_sv_undef, 0, 0);
 574     return swash_fetch(PL_utf8_punct, p);
 575 }
 576
 577 bool
 578 Perl_is_utf8_xdigit(pTHX_ U8 *p)
 579 {
 580     if (!PL_utf8_xdigit)
 581         PL_utf8_xdigit = swash_init("utf8", "IsXDigit", &PL_sv_undef, 0, 0);
 582     return swash_fetch(PL_utf8_xdigit, p);
 583 }
 584
 585 bool
 586 Perl_is_utf8_mark(pTHX_ U8 *p)
 587 {
 588     if (!PL_utf8_mark)
 589         PL_utf8_mark = swash_init("utf8", "IsM", &PL_sv_undef, 0, 0);
 590     return swash_fetch(PL_utf8_mark, p);
 591 }
 592
 593 UV
 594 Perl_to_utf8_upper(pTHX_ U8 *p)
 595 {
 596     UV uv;
 597
 598     if (!PL_utf8_toupper)
 599         PL_utf8_toupper = swash_init("utf8", "ToUpper", &PL_sv_undef, 4, 0);
 600     uv = swash_fetch(PL_utf8_toupper, p);
 601     return uv ? uv : utf8_to_uv(p,0);
 602 }
 603
 604 UV
 605 Perl_to_utf8_title(pTHX_ U8 *p)
 606 {
 607     UV uv;
 608
 609     if (!PL_utf8_totitle)
 610         PL_utf8_totitle = swash_init("utf8", "ToTitle", &PL_sv_undef, 4, 0);
 611     uv = swash_fetch(PL_utf8_totitle, p);
 612     return uv ? uv : utf8_to_uv(p,0);
 613 }
 614
 615 UV
 616 Perl_to_utf8_lower(pTHX_ U8 *p)
 617 {
 618     UV uv;
 619
 620     if (!PL_utf8_tolower)
 621         PL_utf8_tolower = swash_init("utf8", "ToLower", &PL_sv_undef, 4, 0);
 622     uv = swash_fetch(PL_utf8_tolower, p);
 623     return uv ? uv : utf8_to_uv(p,0);
 624 }
 625
 626 /* a "swash" is a swatch hash */
 627
 628 SV*
 629 Perl_swash_init(pTHX_ char* pkg, char* name, SV *listsv, I32 minbits, I32 none)
 630 {
 631     SV* retval;
 632     char tmpbuf[256];
 633     dSP;
 634     PUSHSTACKi(PERLSI_MAGIC);
 635     PUSHMARK(SP);
 636     EXTEND(SP,5);
 637     PUSHs(sv_2mortal(newSVpvn(pkg, strlen(pkg))));
 638     PUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
 639     PUSHs(listsv);
 640     PUSHs(sv_2mortal(newSViv(minbits)));
 641     PUSHs(sv_2mortal(newSViv(none)));
 642     PUTBACK;
 643     ENTER;
 644     SAVEI32(PL_hints);
 645     PL_hints = 0;
 646     save_re_context();
 647     if (PL_curcop == &PL_compiling)     /* XXX ought to be handled by lex_start */
 648         strncpy(tmpbuf, PL_tokenbuf, sizeof tmpbuf);
 649     if (call_method("SWASHNEW", G_SCALAR))
 650         retval = newSVsv(*PL_stack_sp--);
 651     else
 652         retval = &PL_sv_undef;
 653     LEAVE;
 654     POPSTACK;
 655     if (PL_curcop == &PL_compiling) {
 656         strncpy(PL_tokenbuf, tmpbuf, sizeof tmpbuf);
 657         PL_curcop->op_private = PL_hints;
 658     }
 659     if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV)
 660         Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
 661     return retval;
 662 }
 663
 664 UV
 665 Perl_swash_fetch(pTHX_ SV *sv, U8 *ptr)
 666 {
 667     HV* hv = (HV*)SvRV(sv);
 668     U32 klen = UTF8SKIP(ptr) - 1;
 669     U32 off = ptr[klen] & 127;  /* NB: 64 bit always 0 when len > 1 */
 670     STRLEN slen;
 671     STRLEN needents = (klen ? 64 : 128);
 672     U8 *tmps;
 673     U32 bit;
 674     SV *retval;
 675
 676     /*
 677      * This single-entry cache saves about 1/3 of the utf8 overhead in test
 678      * suite.  (That is, only 7-8% overall over just a hash cache.  Still,
 679      * it's nothing to sniff at.)  Pity we usually come through at least
 680      * two function calls to get here...
 681      *
 682      * NB: this code assumes that swatches are never modified, once generated!
 683      */
 684
 685     if (hv == PL_last_swash_hv &&
 686         klen == PL_last_swash_klen &&
 687         (!klen || memEQ(ptr,PL_last_swash_key,klen)) )
 688     {
 689         tmps = PL_last_swash_tmps;
 690         slen = PL_last_swash_slen;
 691     }
 692     else {
 693         /* Try our second-level swatch cache, kept in a hash. */
 694         SV** svp = hv_fetch(hv, (char*)ptr, klen, FALSE);
 695
 696         /* If not cached, generate it via utf8::SWASHGET */
 697         if (!svp || !SvPOK(*svp) || !(tmps = (U8*)SvPV(*svp, slen))) {
 698             dSP;
 699             ENTER;
 700             SAVETMPS;
 701             save_re_context();
 702             PUSHSTACKi(PERLSI_MAGIC);
 703             PUSHMARK(SP);
 704             EXTEND(SP,3);
 705             PUSHs((SV*)sv);
 706             PUSHs(sv_2mortal(newSViv(utf8_to_uv(ptr, 0) & ~(needents - 1))));
 707             PUSHs(sv_2mortal(newSViv(needents)));
 708             PUTBACK;
 709             if (call_method("SWASHGET", G_SCALAR))
 710                 retval = newSVsv(*PL_stack_sp--);
 711             else
 712                 retval = &PL_sv_undef;
 713             POPSTACK;
 714             FREETMPS;
 715             LEAVE;
 716             if (PL_curcop == &PL_compiling)
 717                 PL_curcop->op_private = PL_hints;
 718
 719             svp = hv_store(hv, (char*)ptr, klen, retval, 0);
 720
 721             if (!svp || !(tmps = (U8*)SvPV(*svp, slen)) || slen < 8)
 722                 Perl_croak(aTHX_ "SWASHGET didn't return result of proper length");
 723         }
 724
 725         PL_last_swash_hv = hv;
 726         PL_last_swash_klen = klen;
 727         PL_last_swash_tmps = tmps;
 728         PL_last_swash_slen = slen;
 729         if (klen)
 730             Copy(ptr, PL_last_swash_key, klen, U8);
 731     }
 732
 733     switch ((slen << 3) / needents) {
 734     case 1:
 735         bit = 1 << (off & 7);
 736         off >>= 3;
 737         return (tmps[off] & bit) != 0;
 738     case 8:
 739         return tmps[off];
 740     case 16:
 741         off <<= 1;
 742         return (tmps[off] << 8) + tmps[off + 1] ;
 743     case 32:
 744         off <<= 2;
 745         return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
 746     }
 747     Perl_croak(aTHX_ "panic: swash_fetch");
 748     return 0;
 749 }