3 * Copyright (c) 1998-2000, 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 < 0x1000000000LL)
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++ = 0x80; /* 6 Reserved bits */
88 *d++ = (((uv >> 60) & 0x0f) | 0x80); /* 2 Reserved bits */
89 *d++ = (((uv >> 54) & 0x3f) | 0x80);
90 *d++ = (((uv >> 48) & 0x3f) | 0x80);
91 *d++ = (((uv >> 42) & 0x3f) | 0x80);
92 *d++ = (((uv >> 36) & 0x3f) | 0x80);
93 *d++ = (((uv >> 30) & 0x3f) | 0x80);
94 *d++ = (((uv >> 24) & 0x3f) | 0x80);
95 *d++ = (((uv >> 18) & 0x3f) | 0x80);
96 *d++ = (((uv >> 12) & 0x3f) | 0x80);
97 *d++ = (((uv >> 6) & 0x3f) | 0x80);
98 *d++ = (( uv & 0x3f) | 0x80);
104 /* Tests if some arbitrary number of bytes begins in a valid UTF-8 character.
105 * The actual number of bytes in the UTF-8 character will be returned if it
106 * is valid, otherwise 0. */
108 Perl_is_utf8_char(pTHX_ U8 *s)
119 if (!(u & 0x20)) { len = 2; }
120 else if (!(u & 0x10)) { len = 3; }
121 else if (!(u & 0x08)) { len = 4; }
122 else if (!(u & 0x04)) { len = 5; }
123 else if (!(u & 0x02)) { len = 6; }
124 else if (!(u & 0x01)) { len = 7; }
125 else { len = 13; } /* whoa! */
130 if ((*s & 0xc0) != 0x80)
138 Perl_utf8_to_uv(pTHX_ U8* s, I32* retlen)
149 if (ckWARN_d(WARN_UTF8))
150 Perl_warner(aTHX_ WARN_UTF8, "Malformed UTF-8 character");
156 if (!(uv & 0x20)) { len = 2; uv &= 0x1f; }
157 else if (!(uv & 0x10)) { len = 3; uv &= 0x0f; }
158 else if (!(uv & 0x08)) { len = 4; uv &= 0x07; }
159 else if (!(uv & 0x04)) { len = 5; uv &= 0x03; }
160 else if (!(uv & 0x02)) { len = 6; uv &= 0x01; }
161 else if (!(uv & 0x01)) { len = 7; uv = 0; }
162 else { len = 13; uv = 0; } /* whoa! */
169 if ((*s & 0xc0) != 0x80) {
171 if (ckWARN_d(WARN_UTF8))
172 Perl_warner(aTHX_ WARN_UTF8, "Malformed UTF-8 character");
178 uv = (uv << 6) | (*s++ & 0x3f);
183 /* utf8_distance(a,b) is intended to be a - b in pointer arithmetic */
186 Perl_utf8_distance(pTHX_ U8 *a, U8 *b)
204 /* WARNING: do not use the following unless you *know* off is within bounds */
207 Perl_utf8_hop(pTHX_ U8 *s, I32 off)
217 while ((*s & 0xc0) == 0x80)
225 /* XXX NOTHING CALLS THE FOLLOWING TWO ROUTINES YET!!! */
227 * Convert native or reversed UTF-16 to UTF-8.
229 * Destination must be pre-extended to 3/2 source. Do not use in-place.
230 * We optimize for native, for obvious reasons. */
233 Perl_utf16_to_utf8(pTHX_ U16* p, U8* d, I32 bytelen)
235 U16* pend = p + bytelen / 2;
243 *d++ = (( uv >> 6) | 0xc0);
244 *d++ = (( uv & 0x3f) | 0x80);
247 if (uv >= 0xd800 && uv < 0xdbff) { /* surrogates */
250 if (low < 0xdc00 || low >= 0xdfff) {
251 if (ckWARN_d(WARN_UTF8))
252 Perl_warner(aTHX_ WARN_UTF8, "Malformed UTF-16 surrogate");
256 uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
259 *d++ = (( uv >> 12) | 0xe0);
260 *d++ = (((uv >> 6) & 0x3f) | 0x80);
261 *d++ = (( uv & 0x3f) | 0x80);
265 *d++ = (( uv >> 18) | 0xf0);
266 *d++ = (((uv >> 12) & 0x3f) | 0x80);
267 *d++ = (((uv >> 6) & 0x3f) | 0x80);
268 *d++ = (( uv & 0x3f) | 0x80);
275 /* Note: this one is slightly destructive of the source. */
278 Perl_utf16_to_utf8_reversed(pTHX_ U16* p, U8* d, I32 bytelen)
281 U8* send = s + bytelen;
288 return utf16_to_utf8(p, d, bytelen);
291 /* for now these are all defined (inefficiently) in terms of the utf8 versions */
294 Perl_is_uni_alnum(pTHX_ U32 c)
296 U8 tmpbuf[UTF8_MAXLEN];
297 uv_to_utf8(tmpbuf, (UV)c);
298 return is_utf8_alnum(tmpbuf);
302 Perl_is_uni_alnumc(pTHX_ U32 c)
304 U8 tmpbuf[UTF8_MAXLEN];
305 uv_to_utf8(tmpbuf, (UV)c);
306 return is_utf8_alnumc(tmpbuf);
310 Perl_is_uni_idfirst(pTHX_ U32 c)
312 U8 tmpbuf[UTF8_MAXLEN];
313 uv_to_utf8(tmpbuf, (UV)c);
314 return is_utf8_idfirst(tmpbuf);
318 Perl_is_uni_alpha(pTHX_ U32 c)
320 U8 tmpbuf[UTF8_MAXLEN];
321 uv_to_utf8(tmpbuf, (UV)c);
322 return is_utf8_alpha(tmpbuf);
326 Perl_is_uni_ascii(pTHX_ U32 c)
328 U8 tmpbuf[UTF8_MAXLEN];
329 uv_to_utf8(tmpbuf, (UV)c);
330 return is_utf8_ascii(tmpbuf);
334 Perl_is_uni_space(pTHX_ U32 c)
336 U8 tmpbuf[UTF8_MAXLEN];
337 uv_to_utf8(tmpbuf, (UV)c);
338 return is_utf8_space(tmpbuf);
342 Perl_is_uni_digit(pTHX_ U32 c)
344 U8 tmpbuf[UTF8_MAXLEN];
345 uv_to_utf8(tmpbuf, (UV)c);
346 return is_utf8_digit(tmpbuf);
350 Perl_is_uni_upper(pTHX_ U32 c)
352 U8 tmpbuf[UTF8_MAXLEN];
353 uv_to_utf8(tmpbuf, (UV)c);
354 return is_utf8_upper(tmpbuf);
358 Perl_is_uni_lower(pTHX_ U32 c)
360 U8 tmpbuf[UTF8_MAXLEN];
361 uv_to_utf8(tmpbuf, (UV)c);
362 return is_utf8_lower(tmpbuf);
366 Perl_is_uni_cntrl(pTHX_ U32 c)
368 U8 tmpbuf[UTF8_MAXLEN];
369 uv_to_utf8(tmpbuf, (UV)c);
370 return is_utf8_cntrl(tmpbuf);
374 Perl_is_uni_graph(pTHX_ U32 c)
376 U8 tmpbuf[UTF8_MAXLEN];
377 uv_to_utf8(tmpbuf, (UV)c);
378 return is_utf8_graph(tmpbuf);
382 Perl_is_uni_print(pTHX_ U32 c)
384 U8 tmpbuf[UTF8_MAXLEN];
385 uv_to_utf8(tmpbuf, (UV)c);
386 return is_utf8_print(tmpbuf);
390 Perl_is_uni_punct(pTHX_ U32 c)
392 U8 tmpbuf[UTF8_MAXLEN];
393 uv_to_utf8(tmpbuf, (UV)c);
394 return is_utf8_punct(tmpbuf);
398 Perl_is_uni_xdigit(pTHX_ U32 c)
400 U8 tmpbuf[UTF8_MAXLEN];
401 uv_to_utf8(tmpbuf, (UV)c);
402 return is_utf8_xdigit(tmpbuf);
406 Perl_to_uni_upper(pTHX_ U32 c)
408 U8 tmpbuf[UTF8_MAXLEN];
409 uv_to_utf8(tmpbuf, (UV)c);
410 return to_utf8_upper(tmpbuf);
414 Perl_to_uni_title(pTHX_ U32 c)
416 U8 tmpbuf[UTF8_MAXLEN];
417 uv_to_utf8(tmpbuf, (UV)c);
418 return to_utf8_title(tmpbuf);
422 Perl_to_uni_lower(pTHX_ U32 c)
424 U8 tmpbuf[UTF8_MAXLEN];
425 uv_to_utf8(tmpbuf, (UV)c);
426 return to_utf8_lower(tmpbuf);
429 /* for now these all assume no locale info available for Unicode > 255 */
432 Perl_is_uni_alnum_lc(pTHX_ U32 c)
434 return is_uni_alnum(c); /* XXX no locale support yet */
438 Perl_is_uni_alnumc_lc(pTHX_ U32 c)
440 return is_uni_alnumc(c); /* XXX no locale support yet */
444 Perl_is_uni_idfirst_lc(pTHX_ U32 c)
446 return is_uni_idfirst(c); /* XXX no locale support yet */
450 Perl_is_uni_alpha_lc(pTHX_ U32 c)
452 return is_uni_alpha(c); /* XXX no locale support yet */
456 Perl_is_uni_ascii_lc(pTHX_ U32 c)
458 return is_uni_ascii(c); /* XXX no locale support yet */
462 Perl_is_uni_space_lc(pTHX_ U32 c)
464 return is_uni_space(c); /* XXX no locale support yet */
468 Perl_is_uni_digit_lc(pTHX_ U32 c)
470 return is_uni_digit(c); /* XXX no locale support yet */
474 Perl_is_uni_upper_lc(pTHX_ U32 c)
476 return is_uni_upper(c); /* XXX no locale support yet */
480 Perl_is_uni_lower_lc(pTHX_ U32 c)
482 return is_uni_lower(c); /* XXX no locale support yet */
486 Perl_is_uni_cntrl_lc(pTHX_ U32 c)
488 return is_uni_cntrl(c); /* XXX no locale support yet */
492 Perl_is_uni_graph_lc(pTHX_ U32 c)
494 return is_uni_graph(c); /* XXX no locale support yet */
498 Perl_is_uni_print_lc(pTHX_ U32 c)
500 return is_uni_print(c); /* XXX no locale support yet */
504 Perl_is_uni_punct_lc(pTHX_ U32 c)
506 return is_uni_punct(c); /* XXX no locale support yet */
510 Perl_is_uni_xdigit_lc(pTHX_ U32 c)
512 return is_uni_xdigit(c); /* XXX no locale support yet */
516 Perl_to_uni_upper_lc(pTHX_ U32 c)
518 return to_uni_upper(c); /* XXX no locale support yet */
522 Perl_to_uni_title_lc(pTHX_ U32 c)
524 return to_uni_title(c); /* XXX no locale support yet */
528 Perl_to_uni_lower_lc(pTHX_ U32 c)
530 return to_uni_lower(c); /* XXX no locale support yet */
534 Perl_is_utf8_alnum(pTHX_ U8 *p)
536 if (!is_utf8_char(p))
539 PL_utf8_alnum = swash_init("utf8", "IsAlnum", &PL_sv_undef, 0, 0);
540 return swash_fetch(PL_utf8_alnum, p);
541 /* return *p == '_' || is_utf8_alpha(p) || is_utf8_digit(p); */
542 #ifdef SURPRISINGLY_SLOWER /* probably because alpha is usually true */
544 PL_utf8_alnum = swash_init("utf8", "",
545 sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
546 return swash_fetch(PL_utf8_alnum, p);
551 Perl_is_utf8_alnumc(pTHX_ U8 *p)
553 if (!is_utf8_char(p))
556 PL_utf8_alnum = swash_init("utf8", "IsAlnumC", &PL_sv_undef, 0, 0);
557 return swash_fetch(PL_utf8_alnum, p);
558 /* return is_utf8_alpha(p) || is_utf8_digit(p); */
559 #ifdef SURPRISINGLY_SLOWER /* probably because alpha is usually true */
561 PL_utf8_alnum = swash_init("utf8", "",
562 sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
563 return swash_fetch(PL_utf8_alnum, p);
568 Perl_is_utf8_idfirst(pTHX_ U8 *p)
570 return *p == '_' || is_utf8_alpha(p);
574 Perl_is_utf8_alpha(pTHX_ U8 *p)
576 if (!is_utf8_char(p))
579 PL_utf8_alpha = swash_init("utf8", "IsAlpha", &PL_sv_undef, 0, 0);
580 return swash_fetch(PL_utf8_alpha, p);
584 Perl_is_utf8_ascii(pTHX_ U8 *p)
586 if (!is_utf8_char(p))
589 PL_utf8_ascii = swash_init("utf8", "IsAscii", &PL_sv_undef, 0, 0);
590 return swash_fetch(PL_utf8_ascii, p);
594 Perl_is_utf8_space(pTHX_ U8 *p)
596 if (!is_utf8_char(p))
599 PL_utf8_space = swash_init("utf8", "IsSpace", &PL_sv_undef, 0, 0);
600 return swash_fetch(PL_utf8_space, p);
604 Perl_is_utf8_digit(pTHX_ U8 *p)
606 if (!is_utf8_char(p))
609 PL_utf8_digit = swash_init("utf8", "IsDigit", &PL_sv_undef, 0, 0);
610 return swash_fetch(PL_utf8_digit, p);
614 Perl_is_utf8_upper(pTHX_ U8 *p)
616 if (!is_utf8_char(p))
619 PL_utf8_upper = swash_init("utf8", "IsUpper", &PL_sv_undef, 0, 0);
620 return swash_fetch(PL_utf8_upper, p);
624 Perl_is_utf8_lower(pTHX_ U8 *p)
626 if (!is_utf8_char(p))
629 PL_utf8_lower = swash_init("utf8", "IsLower", &PL_sv_undef, 0, 0);
630 return swash_fetch(PL_utf8_lower, p);
634 Perl_is_utf8_cntrl(pTHX_ U8 *p)
636 if (!is_utf8_char(p))
639 PL_utf8_cntrl = swash_init("utf8", "IsCntrl", &PL_sv_undef, 0, 0);
640 return swash_fetch(PL_utf8_cntrl, p);
644 Perl_is_utf8_graph(pTHX_ U8 *p)
646 if (!is_utf8_char(p))
649 PL_utf8_graph = swash_init("utf8", "IsGraph", &PL_sv_undef, 0, 0);
650 return swash_fetch(PL_utf8_graph, p);
654 Perl_is_utf8_print(pTHX_ U8 *p)
656 if (!is_utf8_char(p))
659 PL_utf8_print = swash_init("utf8", "IsPrint", &PL_sv_undef, 0, 0);
660 return swash_fetch(PL_utf8_print, p);
664 Perl_is_utf8_punct(pTHX_ U8 *p)
666 if (!is_utf8_char(p))
669 PL_utf8_punct = swash_init("utf8", "IsPunct", &PL_sv_undef, 0, 0);
670 return swash_fetch(PL_utf8_punct, p);
674 Perl_is_utf8_xdigit(pTHX_ U8 *p)
676 if (!is_utf8_char(p))
679 PL_utf8_xdigit = swash_init("utf8", "IsXDigit", &PL_sv_undef, 0, 0);
680 return swash_fetch(PL_utf8_xdigit, p);
684 Perl_is_utf8_mark(pTHX_ U8 *p)
686 if (!is_utf8_char(p))
689 PL_utf8_mark = swash_init("utf8", "IsM", &PL_sv_undef, 0, 0);
690 return swash_fetch(PL_utf8_mark, p);
694 Perl_to_utf8_upper(pTHX_ U8 *p)
698 if (!PL_utf8_toupper)
699 PL_utf8_toupper = swash_init("utf8", "ToUpper", &PL_sv_undef, 4, 0);
700 uv = swash_fetch(PL_utf8_toupper, p);
701 return uv ? uv : utf8_to_uv(p,0);
705 Perl_to_utf8_title(pTHX_ U8 *p)
709 if (!PL_utf8_totitle)
710 PL_utf8_totitle = swash_init("utf8", "ToTitle", &PL_sv_undef, 4, 0);
711 uv = swash_fetch(PL_utf8_totitle, p);
712 return uv ? uv : utf8_to_uv(p,0);
716 Perl_to_utf8_lower(pTHX_ U8 *p)
720 if (!PL_utf8_tolower)
721 PL_utf8_tolower = swash_init("utf8", "ToLower", &PL_sv_undef, 4, 0);
722 uv = swash_fetch(PL_utf8_tolower, p);
723 return uv ? uv : utf8_to_uv(p,0);
726 /* a "swash" is a swatch hash */
729 Perl_swash_init(pTHX_ char* pkg, char* name, SV *listsv, I32 minbits, I32 none)
735 if (!gv_stashpv(pkg, 0)) { /* demand load utf8 */
737 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpv(pkg,0), Nullsv);
741 PUSHSTACKi(PERLSI_MAGIC);
744 PUSHs(sv_2mortal(newSVpvn(pkg, strlen(pkg))));
745 PUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
747 PUSHs(sv_2mortal(newSViv(minbits)));
748 PUSHs(sv_2mortal(newSViv(none)));
754 if (PL_curcop == &PL_compiling) /* XXX ought to be handled by lex_start */
755 strncpy(tmpbuf, PL_tokenbuf, sizeof tmpbuf);
756 if (call_method("SWASHNEW", G_SCALAR))
757 retval = newSVsv(*PL_stack_sp--);
759 retval = &PL_sv_undef;
762 if (PL_curcop == &PL_compiling) {
763 strncpy(PL_tokenbuf, tmpbuf, sizeof tmpbuf);
764 PL_curcop->op_private = PL_hints;
766 if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV)
767 Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
772 Perl_swash_fetch(pTHX_ SV *sv, U8 *ptr)
774 HV* hv = (HV*)SvRV(sv);
775 U32 klen = UTF8SKIP(ptr) - 1;
776 U32 off = ptr[klen] & 127; /* NB: 64 bit always 0 when len > 1 */
778 STRLEN needents = (klen ? 64 : 128);
784 * This single-entry cache saves about 1/3 of the utf8 overhead in test
785 * suite. (That is, only 7-8% overall over just a hash cache. Still,
786 * it's nothing to sniff at.) Pity we usually come through at least
787 * two function calls to get here...
789 * NB: this code assumes that swatches are never modified, once generated!
792 if (hv == PL_last_swash_hv &&
793 klen == PL_last_swash_klen &&
794 (!klen || memEQ(ptr,PL_last_swash_key,klen)) )
796 tmps = PL_last_swash_tmps;
797 slen = PL_last_swash_slen;
800 /* Try our second-level swatch cache, kept in a hash. */
801 SV** svp = hv_fetch(hv, (char*)ptr, klen, FALSE);
803 /* If not cached, generate it via utf8::SWASHGET */
804 if (!svp || !SvPOK(*svp) || !(tmps = (U8*)SvPV(*svp, slen))) {
809 PUSHSTACKi(PERLSI_MAGIC);
813 PUSHs(sv_2mortal(newSViv(utf8_to_uv(ptr, 0) & ~(needents - 1))));
814 PUSHs(sv_2mortal(newSViv(needents)));
816 if (call_method("SWASHGET", G_SCALAR))
817 retval = newSVsv(*PL_stack_sp--);
819 retval = &PL_sv_undef;
823 if (PL_curcop == &PL_compiling)
824 PL_curcop->op_private = PL_hints;
826 svp = hv_store(hv, (char*)ptr, klen, retval, 0);
828 if (!svp || !(tmps = (U8*)SvPV(*svp, slen)) || slen < 8)
829 Perl_croak(aTHX_ "SWASHGET didn't return result of proper length");
832 PL_last_swash_hv = hv;
833 PL_last_swash_klen = klen;
834 PL_last_swash_tmps = tmps;
835 PL_last_swash_slen = slen;
837 Copy(ptr, PL_last_swash_key, klen, U8);
840 switch ((slen << 3) / needents) {
842 bit = 1 << (off & 7);
844 return (tmps[off] & bit) != 0;
849 return (tmps[off] << 8) + tmps[off + 1] ;
852 return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
854 Perl_croak(aTHX_ "panic: swash_fetch");