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