3 * Copyright (c) 1998-1999, Larry Wall
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.
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.'
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?'
19 * ...the travellers perceived that the floor was paved with stones of many
20 * hues; branching runes and strange devices intertwined beneath their feet.
24 #define PERL_IN_UTF8_C
30 Perl_uv_to_utf8(pTHX_ U8 *d, UV uv)
37 *d++ = (( uv >> 6) | 0xc0);
38 *d++ = (( uv & 0x3f) | 0x80);
42 *d++ = (( uv >> 12) | 0xe0);
43 *d++ = (((uv >> 6) & 0x3f) | 0x80);
44 *d++ = (( uv & 0x3f) | 0x80);
48 *d++ = (( uv >> 18) | 0xf0);
49 *d++ = (((uv >> 12) & 0x3f) | 0x80);
50 *d++ = (((uv >> 6) & 0x3f) | 0x80);
51 *d++ = (( uv & 0x3f) | 0x80);
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);
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);
72 if (uv < 0x2000000000)
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);
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);
100 Perl_utf8_to_uv(pTHX_ U8* s, I32* retlen)
111 if (ckWARN_d(WARN_UTF8))
112 Perl_warner(aTHX_ WARN_UTF8, "Malformed UTF-8 character");
118 if (!(uv & 0x20)) { len = 2; uv &= 0x1f; }
119 else if (!(uv & 0x10)) { len = 3; uv &= 0x0f; }
120 else if (!(uv & 0x08)) { len = 4; uv &= 0x07; }
121 else if (!(uv & 0x04)) { len = 5; uv &= 0x03; }
122 else if (!(uv & 0x02)) { len = 6; uv &= 0x01; }
123 else if (!(uv & 0x01)) { len = 7; uv &= 0x00; }
124 else len = 8; /* whoa! */
131 if ((*s & 0xc0) != 0x80) {
133 if (ckWARN_d(WARN_UTF8))
134 Perl_warner(aTHX_ WARN_UTF8, "Malformed UTF-8 character");
140 uv = (uv << 6) | (*s++ & 0x3f);
145 /* utf8_distance(a,b) is intended to be a - b in pointer arithmetic */
148 Perl_utf8_distance(pTHX_ U8 *a, U8 *b)
166 /* WARNING: do not use the following unless you *know* off is within bounds */
169 Perl_utf8_hop(pTHX_ U8 *s, I32 off)
179 while ((*s & 0xc0) == 0x80)
187 /* XXX NOTHING CALLS THE FOLLOWING TWO ROUTINES YET!!! */
189 * Convert native or reversed UTF-16 to UTF-8.
191 * Destination must be pre-extended to 3/2 source. Do not use in-place.
192 * We optimize for native, for obvious reasons. */
195 Perl_utf16_to_utf8(pTHX_ U16* p, U8* d, I32 bytelen)
197 U16* pend = p + bytelen / 2;
205 *d++ = (( uv >> 6) | 0xc0);
206 *d++ = (( uv & 0x3f) | 0x80);
209 if (uv >= 0xd800 && uv < 0xdbff) { /* surrogates */
212 if (low < 0xdc00 || low >= 0xdfff) {
213 if (ckWARN_d(WARN_UTF8))
214 Perl_warner(aTHX_ WARN_UTF8, "Malformed UTF-16 surrogate");
218 uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
221 *d++ = (( uv >> 12) | 0xe0);
222 *d++ = (((uv >> 6) & 0x3f) | 0x80);
223 *d++ = (( uv & 0x3f) | 0x80);
227 *d++ = (( uv >> 18) | 0xf0);
228 *d++ = (((uv >> 12) & 0x3f) | 0x80);
229 *d++ = (((uv >> 6) & 0x3f) | 0x80);
230 *d++ = (( uv & 0x3f) | 0x80);
237 /* Note: this one is slightly destructive of the source. */
240 Perl_utf16_to_utf8_reversed(pTHX_ U16* p, U8* d, I32 bytelen)
243 U8* send = s + bytelen;
250 return utf16_to_utf8(p, d, bytelen);
253 /* for now these are all defined (inefficiently) in terms of the utf8 versions */
256 Perl_is_uni_alnum(pTHX_ U32 c)
259 uv_to_utf8(tmpbuf, (UV)c);
260 return is_utf8_alnum(tmpbuf);
264 Perl_is_uni_alnumc(pTHX_ U32 c)
267 uv_to_utf8(tmpbuf, (UV)c);
268 return is_utf8_alnumc(tmpbuf);
272 Perl_is_uni_idfirst(pTHX_ U32 c)
275 uv_to_utf8(tmpbuf, (UV)c);
276 return is_utf8_idfirst(tmpbuf);
280 Perl_is_uni_alpha(pTHX_ U32 c)
283 uv_to_utf8(tmpbuf, (UV)c);
284 return is_utf8_alpha(tmpbuf);
288 Perl_is_uni_space(pTHX_ U32 c)
291 uv_to_utf8(tmpbuf, (UV)c);
292 return is_utf8_space(tmpbuf);
296 Perl_is_uni_digit(pTHX_ U32 c)
299 uv_to_utf8(tmpbuf, (UV)c);
300 return is_utf8_digit(tmpbuf);
304 Perl_is_uni_upper(pTHX_ U32 c)
307 uv_to_utf8(tmpbuf, (UV)c);
308 return is_utf8_upper(tmpbuf);
312 Perl_is_uni_lower(pTHX_ U32 c)
315 uv_to_utf8(tmpbuf, (UV)c);
316 return is_utf8_lower(tmpbuf);
320 Perl_is_uni_cntrl(pTHX_ U32 c)
323 uv_to_utf8(tmpbuf, (UV)c);
324 return is_utf8_cntrl(tmpbuf);
328 Perl_is_uni_graph(pTHX_ U32 c)
331 uv_to_utf8(tmpbuf, (UV)c);
332 return is_utf8_graph(tmpbuf);
336 Perl_is_uni_print(pTHX_ U32 c)
339 uv_to_utf8(tmpbuf, (UV)c);
340 return is_utf8_print(tmpbuf);
344 Perl_is_uni_punct(pTHX_ U32 c)
347 uv_to_utf8(tmpbuf, (UV)c);
348 return is_utf8_punct(tmpbuf);
352 Perl_to_uni_upper(pTHX_ U32 c)
355 uv_to_utf8(tmpbuf, (UV)c);
356 return to_utf8_upper(tmpbuf);
360 Perl_to_uni_title(pTHX_ U32 c)
363 uv_to_utf8(tmpbuf, (UV)c);
364 return to_utf8_title(tmpbuf);
368 Perl_to_uni_lower(pTHX_ U32 c)
371 uv_to_utf8(tmpbuf, (UV)c);
372 return to_utf8_lower(tmpbuf);
375 /* for now these all assume no locale info available for Unicode > 255 */
378 Perl_is_uni_alnum_lc(pTHX_ U32 c)
380 return is_uni_alnum(c); /* XXX no locale support yet */
384 Perl_is_uni_alnumc_lc(pTHX_ U32 c)
386 return is_uni_alnumc(c); /* XXX no locale support yet */
390 Perl_is_uni_idfirst_lc(pTHX_ U32 c)
392 return is_uni_idfirst(c); /* XXX no locale support yet */
396 Perl_is_uni_alpha_lc(pTHX_ U32 c)
398 return is_uni_alpha(c); /* XXX no locale support yet */
402 Perl_is_uni_space_lc(pTHX_ U32 c)
404 return is_uni_space(c); /* XXX no locale support yet */
408 Perl_is_uni_digit_lc(pTHX_ U32 c)
410 return is_uni_digit(c); /* XXX no locale support yet */
414 Perl_is_uni_upper_lc(pTHX_ U32 c)
416 return is_uni_upper(c); /* XXX no locale support yet */
420 Perl_is_uni_lower_lc(pTHX_ U32 c)
422 return is_uni_lower(c); /* XXX no locale support yet */
426 Perl_is_uni_cntrl_lc(pTHX_ U32 c)
428 return is_uni_cntrl(c); /* XXX no locale support yet */
432 Perl_is_uni_graph_lc(pTHX_ U32 c)
434 return is_uni_graph(c); /* XXX no locale support yet */
438 Perl_is_uni_print_lc(pTHX_ U32 c)
440 return is_uni_print(c); /* XXX no locale support yet */
444 Perl_is_uni_punct_lc(pTHX_ U32 c)
446 return is_uni_punct(c); /* XXX no locale support yet */
450 Perl_to_uni_upper_lc(pTHX_ U32 c)
452 return to_uni_upper(c); /* XXX no locale support yet */
456 Perl_to_uni_title_lc(pTHX_ U32 c)
458 return to_uni_title(c); /* XXX no locale support yet */
462 Perl_to_uni_lower_lc(pTHX_ U32 c)
464 return to_uni_lower(c); /* XXX no locale support yet */
468 Perl_is_utf8_alnum(pTHX_ U8 *p)
471 PL_utf8_alnum = swash_init("utf8", "IsAlnum", &PL_sv_undef, 0, 0);
472 return swash_fetch(PL_utf8_alnum, p);
473 /* return *p == '_' || is_utf8_alpha(p) || is_utf8_digit(p); */
474 #ifdef SURPRISINGLY_SLOWER /* probably because alpha is usually true */
476 PL_utf8_alnum = swash_init("utf8", "",
477 sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
478 return swash_fetch(PL_utf8_alnum, p);
483 Perl_is_utf8_alnumc(pTHX_ U8 *p)
486 PL_utf8_alnum = swash_init("utf8", "IsAlnumC", &PL_sv_undef, 0, 0);
487 return swash_fetch(PL_utf8_alnum, p);
488 /* return is_utf8_alpha(p) || is_utf8_digit(p); */
489 #ifdef SURPRISINGLY_SLOWER /* probably because alpha is usually true */
491 PL_utf8_alnum = swash_init("utf8", "",
492 sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
493 return swash_fetch(PL_utf8_alnum, p);
498 Perl_is_utf8_idfirst(pTHX_ U8 *p)
500 return *p == '_' || is_utf8_alpha(p);
504 Perl_is_utf8_alpha(pTHX_ U8 *p)
507 PL_utf8_alpha = swash_init("utf8", "IsAlpha", &PL_sv_undef, 0, 0);
508 return swash_fetch(PL_utf8_alpha, p);
512 Perl_is_utf8_ascii(pTHX_ U8 *p)
515 PL_utf8_ascii = swash_init("utf8", "IsAscii", &PL_sv_undef, 0, 0);
516 return swash_fetch(PL_utf8_ascii, p);
520 Perl_is_utf8_space(pTHX_ U8 *p)
523 PL_utf8_space = swash_init("utf8", "IsSpace", &PL_sv_undef, 0, 0);
524 return swash_fetch(PL_utf8_space, p);
528 Perl_is_utf8_digit(pTHX_ U8 *p)
531 PL_utf8_digit = swash_init("utf8", "IsDigit", &PL_sv_undef, 0, 0);
532 return swash_fetch(PL_utf8_digit, p);
536 Perl_is_utf8_upper(pTHX_ U8 *p)
539 PL_utf8_upper = swash_init("utf8", "IsUpper", &PL_sv_undef, 0, 0);
540 return swash_fetch(PL_utf8_upper, p);
544 Perl_is_utf8_lower(pTHX_ U8 *p)
547 PL_utf8_lower = swash_init("utf8", "IsLower", &PL_sv_undef, 0, 0);
548 return swash_fetch(PL_utf8_lower, p);
552 Perl_is_utf8_cntrl(pTHX_ U8 *p)
555 PL_utf8_cntrl = swash_init("utf8", "IsCntrl", &PL_sv_undef, 0, 0);
556 return swash_fetch(PL_utf8_cntrl, p);
560 Perl_is_utf8_graph(pTHX_ U8 *p)
563 PL_utf8_graph = swash_init("utf8", "IsGraph", &PL_sv_undef, 0, 0);
564 return swash_fetch(PL_utf8_graph, p);
568 Perl_is_utf8_print(pTHX_ U8 *p)
571 PL_utf8_print = swash_init("utf8", "IsPrint", &PL_sv_undef, 0, 0);
572 return swash_fetch(PL_utf8_print, p);
576 Perl_is_utf8_punct(pTHX_ U8 *p)
579 PL_utf8_punct = swash_init("utf8", "IsPunct", &PL_sv_undef, 0, 0);
580 return swash_fetch(PL_utf8_punct, p);
584 Perl_is_utf8_xdigit(pTHX_ U8 *p)
587 PL_utf8_xdigit = swash_init("utf8", "IsXDigit", &PL_sv_undef, 0, 0);
588 return swash_fetch(PL_utf8_xdigit, p);
592 Perl_is_utf8_mark(pTHX_ U8 *p)
595 PL_utf8_mark = swash_init("utf8", "IsM", &PL_sv_undef, 0, 0);
596 return swash_fetch(PL_utf8_mark, p);
600 Perl_to_utf8_upper(pTHX_ U8 *p)
604 if (!PL_utf8_toupper)
605 PL_utf8_toupper = swash_init("utf8", "ToUpper", &PL_sv_undef, 4, 0);
606 uv = swash_fetch(PL_utf8_toupper, p);
607 return uv ? uv : utf8_to_uv(p,0);
611 Perl_to_utf8_title(pTHX_ U8 *p)
615 if (!PL_utf8_totitle)
616 PL_utf8_totitle = swash_init("utf8", "ToTitle", &PL_sv_undef, 4, 0);
617 uv = swash_fetch(PL_utf8_totitle, p);
618 return uv ? uv : utf8_to_uv(p,0);
622 Perl_to_utf8_lower(pTHX_ U8 *p)
626 if (!PL_utf8_tolower)
627 PL_utf8_tolower = swash_init("utf8", "ToLower", &PL_sv_undef, 4, 0);
628 uv = swash_fetch(PL_utf8_tolower, p);
629 return uv ? uv : utf8_to_uv(p,0);
632 /* a "swash" is a swatch hash */
635 Perl_swash_init(pTHX_ char* pkg, char* name, SV *listsv, I32 minbits, I32 none)
640 PUSHSTACKi(PERLSI_MAGIC);
643 PUSHs(sv_2mortal(newSVpvn(pkg, strlen(pkg))));
644 PUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
646 PUSHs(sv_2mortal(newSViv(minbits)));
647 PUSHs(sv_2mortal(newSViv(none)));
653 if (PL_curcop == &PL_compiling) /* XXX ought to be handled by lex_start */
654 strncpy(tmpbuf, PL_tokenbuf, sizeof tmpbuf);
655 if (call_method("SWASHNEW", G_SCALAR))
656 retval = newSVsv(*PL_stack_sp--);
658 retval = &PL_sv_undef;
661 if (PL_curcop == &PL_compiling) {
662 strncpy(PL_tokenbuf, tmpbuf, sizeof tmpbuf);
663 PL_curcop->op_private = PL_hints;
665 if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV)
666 Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
671 Perl_swash_fetch(pTHX_ SV *sv, U8 *ptr)
673 HV* hv = (HV*)SvRV(sv);
674 U32 klen = UTF8SKIP(ptr) - 1;
675 U32 off = ptr[klen] & 127; /* NB: 64 bit always 0 when len > 1 */
677 STRLEN needents = (klen ? 64 : 128);
683 * This single-entry cache saves about 1/3 of the utf8 overhead in test
684 * suite. (That is, only 7-8% overall over just a hash cache. Still,
685 * it's nothing to sniff at.) Pity we usually come through at least
686 * two function calls to get here...
688 * NB: this code assumes that swatches are never modified, once generated!
691 if (hv == PL_last_swash_hv &&
692 klen == PL_last_swash_klen &&
693 (!klen || memEQ(ptr,PL_last_swash_key,klen)) )
695 tmps = PL_last_swash_tmps;
696 slen = PL_last_swash_slen;
699 /* Try our second-level swatch cache, kept in a hash. */
700 SV** svp = hv_fetch(hv, (char*)ptr, klen, FALSE);
702 /* If not cached, generate it via utf8::SWASHGET */
703 if (!svp || !SvPOK(*svp) || !(tmps = (U8*)SvPV(*svp, slen))) {
708 PUSHSTACKi(PERLSI_MAGIC);
712 PUSHs(sv_2mortal(newSViv(utf8_to_uv(ptr, 0) & ~(needents - 1))));
713 PUSHs(sv_2mortal(newSViv(needents)));
715 if (call_method("SWASHGET", G_SCALAR))
716 retval = newSVsv(*PL_stack_sp--);
718 retval = &PL_sv_undef;
722 if (PL_curcop == &PL_compiling)
723 PL_curcop->op_private = PL_hints;
725 svp = hv_store(hv, (char*)ptr, klen, retval, 0);
727 if (!svp || !(tmps = (U8*)SvPV(*svp, slen)) || slen < 8)
728 Perl_croak(aTHX_ "SWASHGET didn't return result of proper length");
731 PL_last_swash_hv = hv;
732 PL_last_swash_klen = klen;
733 PL_last_swash_tmps = tmps;
734 PL_last_swash_slen = slen;
736 Copy(ptr, PL_last_swash_key, klen, U8);
739 switch ((slen << 3) / needents) {
741 bit = 1 << (off & 7);
743 return (tmps[off] & bit) != 0;
748 return (tmps[off] << 8) + tmps[off + 1] ;
751 return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
753 Perl_croak(aTHX_ "panic: swash_fetch");