utf8.c

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