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)
226 =for apidoc Am|U8 *|utf8_to_bytes|U8 *s|STRLEN len
228 Converts a string C<s> of length C<len> from UTF8 into ASCII encoding.
229 Unlike C<bytes_to_utf8>, this over-writes the original string.
230 Returns zero on failure after converting as much as possible.
236 Perl_utf8_to_bytes(pTHX_ U8* s, STRLEN len)
250 UV uv = utf8_to_uv(s, &ulen);
264 =for apidoc Am|U8 *|bytes_to_utf8|U8 *s|STRLEN *len
266 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
267 Returns a pointer to the newly-created string, and sets C<len> to
268 reflect the new length.
274 Perl_bytes_to_utf8(pTHX_ U8* s, STRLEN *len)
282 Newz(801, d, (*len) * 2 + 1, U8);
290 *d++ = (( uv >> 6) | 0xc0);
291 *d++ = (( uv & 0x3f) | 0x80);
299 /* XXX NOTHING CALLS THE FOLLOWING TWO ROUTINES YET!!! */
301 * Convert native or reversed UTF-16 to UTF-8.
303 * Destination must be pre-extended to 3/2 source. Do not use in-place.
304 * We optimize for native, for obvious reasons. */
307 Perl_utf16_to_utf8(pTHX_ U16* p, U8* d, I32 bytelen)
309 U16* pend = p + bytelen / 2;
317 *d++ = (( uv >> 6) | 0xc0);
318 *d++ = (( uv & 0x3f) | 0x80);
321 if (uv >= 0xd800 && uv < 0xdbff) { /* surrogates */
324 if (low < 0xdc00 || low >= 0xdfff) {
325 if (ckWARN_d(WARN_UTF8))
326 Perl_warner(aTHX_ WARN_UTF8, "Malformed UTF-16 surrogate");
330 uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
333 *d++ = (( uv >> 12) | 0xe0);
334 *d++ = (((uv >> 6) & 0x3f) | 0x80);
335 *d++ = (( uv & 0x3f) | 0x80);
339 *d++ = (( uv >> 18) | 0xf0);
340 *d++ = (((uv >> 12) & 0x3f) | 0x80);
341 *d++ = (((uv >> 6) & 0x3f) | 0x80);
342 *d++ = (( uv & 0x3f) | 0x80);
349 /* Note: this one is slightly destructive of the source. */
352 Perl_utf16_to_utf8_reversed(pTHX_ U16* p, U8* d, I32 bytelen)
355 U8* send = s + bytelen;
362 return utf16_to_utf8(p, d, bytelen);
365 /* for now these are all defined (inefficiently) in terms of the utf8 versions */
368 Perl_is_uni_alnum(pTHX_ U32 c)
370 U8 tmpbuf[UTF8_MAXLEN];
371 uv_to_utf8(tmpbuf, (UV)c);
372 return is_utf8_alnum(tmpbuf);
376 Perl_is_uni_alnumc(pTHX_ U32 c)
378 U8 tmpbuf[UTF8_MAXLEN];
379 uv_to_utf8(tmpbuf, (UV)c);
380 return is_utf8_alnumc(tmpbuf);
384 Perl_is_uni_idfirst(pTHX_ U32 c)
386 U8 tmpbuf[UTF8_MAXLEN];
387 uv_to_utf8(tmpbuf, (UV)c);
388 return is_utf8_idfirst(tmpbuf);
392 Perl_is_uni_alpha(pTHX_ U32 c)
394 U8 tmpbuf[UTF8_MAXLEN];
395 uv_to_utf8(tmpbuf, (UV)c);
396 return is_utf8_alpha(tmpbuf);
400 Perl_is_uni_ascii(pTHX_ U32 c)
402 U8 tmpbuf[UTF8_MAXLEN];
403 uv_to_utf8(tmpbuf, (UV)c);
404 return is_utf8_ascii(tmpbuf);
408 Perl_is_uni_space(pTHX_ U32 c)
410 U8 tmpbuf[UTF8_MAXLEN];
411 uv_to_utf8(tmpbuf, (UV)c);
412 return is_utf8_space(tmpbuf);
416 Perl_is_uni_digit(pTHX_ U32 c)
418 U8 tmpbuf[UTF8_MAXLEN];
419 uv_to_utf8(tmpbuf, (UV)c);
420 return is_utf8_digit(tmpbuf);
424 Perl_is_uni_upper(pTHX_ U32 c)
426 U8 tmpbuf[UTF8_MAXLEN];
427 uv_to_utf8(tmpbuf, (UV)c);
428 return is_utf8_upper(tmpbuf);
432 Perl_is_uni_lower(pTHX_ U32 c)
434 U8 tmpbuf[UTF8_MAXLEN];
435 uv_to_utf8(tmpbuf, (UV)c);
436 return is_utf8_lower(tmpbuf);
440 Perl_is_uni_cntrl(pTHX_ U32 c)
442 U8 tmpbuf[UTF8_MAXLEN];
443 uv_to_utf8(tmpbuf, (UV)c);
444 return is_utf8_cntrl(tmpbuf);
448 Perl_is_uni_graph(pTHX_ U32 c)
450 U8 tmpbuf[UTF8_MAXLEN];
451 uv_to_utf8(tmpbuf, (UV)c);
452 return is_utf8_graph(tmpbuf);
456 Perl_is_uni_print(pTHX_ U32 c)
458 U8 tmpbuf[UTF8_MAXLEN];
459 uv_to_utf8(tmpbuf, (UV)c);
460 return is_utf8_print(tmpbuf);
464 Perl_is_uni_punct(pTHX_ U32 c)
466 U8 tmpbuf[UTF8_MAXLEN];
467 uv_to_utf8(tmpbuf, (UV)c);
468 return is_utf8_punct(tmpbuf);
472 Perl_is_uni_xdigit(pTHX_ U32 c)
474 U8 tmpbuf[UTF8_MAXLEN];
475 uv_to_utf8(tmpbuf, (UV)c);
476 return is_utf8_xdigit(tmpbuf);
480 Perl_to_uni_upper(pTHX_ U32 c)
482 U8 tmpbuf[UTF8_MAXLEN];
483 uv_to_utf8(tmpbuf, (UV)c);
484 return to_utf8_upper(tmpbuf);
488 Perl_to_uni_title(pTHX_ U32 c)
490 U8 tmpbuf[UTF8_MAXLEN];
491 uv_to_utf8(tmpbuf, (UV)c);
492 return to_utf8_title(tmpbuf);
496 Perl_to_uni_lower(pTHX_ U32 c)
498 U8 tmpbuf[UTF8_MAXLEN];
499 uv_to_utf8(tmpbuf, (UV)c);
500 return to_utf8_lower(tmpbuf);
503 /* for now these all assume no locale info available for Unicode > 255 */
506 Perl_is_uni_alnum_lc(pTHX_ U32 c)
508 return is_uni_alnum(c); /* XXX no locale support yet */
512 Perl_is_uni_alnumc_lc(pTHX_ U32 c)
514 return is_uni_alnumc(c); /* XXX no locale support yet */
518 Perl_is_uni_idfirst_lc(pTHX_ U32 c)
520 return is_uni_idfirst(c); /* XXX no locale support yet */
524 Perl_is_uni_alpha_lc(pTHX_ U32 c)
526 return is_uni_alpha(c); /* XXX no locale support yet */
530 Perl_is_uni_ascii_lc(pTHX_ U32 c)
532 return is_uni_ascii(c); /* XXX no locale support yet */
536 Perl_is_uni_space_lc(pTHX_ U32 c)
538 return is_uni_space(c); /* XXX no locale support yet */
542 Perl_is_uni_digit_lc(pTHX_ U32 c)
544 return is_uni_digit(c); /* XXX no locale support yet */
548 Perl_is_uni_upper_lc(pTHX_ U32 c)
550 return is_uni_upper(c); /* XXX no locale support yet */
554 Perl_is_uni_lower_lc(pTHX_ U32 c)
556 return is_uni_lower(c); /* XXX no locale support yet */
560 Perl_is_uni_cntrl_lc(pTHX_ U32 c)
562 return is_uni_cntrl(c); /* XXX no locale support yet */
566 Perl_is_uni_graph_lc(pTHX_ U32 c)
568 return is_uni_graph(c); /* XXX no locale support yet */
572 Perl_is_uni_print_lc(pTHX_ U32 c)
574 return is_uni_print(c); /* XXX no locale support yet */
578 Perl_is_uni_punct_lc(pTHX_ U32 c)
580 return is_uni_punct(c); /* XXX no locale support yet */
584 Perl_is_uni_xdigit_lc(pTHX_ U32 c)
586 return is_uni_xdigit(c); /* XXX no locale support yet */
590 Perl_to_uni_upper_lc(pTHX_ U32 c)
592 return to_uni_upper(c); /* XXX no locale support yet */
596 Perl_to_uni_title_lc(pTHX_ U32 c)
598 return to_uni_title(c); /* XXX no locale support yet */
602 Perl_to_uni_lower_lc(pTHX_ U32 c)
604 return to_uni_lower(c); /* XXX no locale support yet */
608 Perl_is_utf8_alnum(pTHX_ U8 *p)
610 if (!is_utf8_char(p))
613 PL_utf8_alnum = swash_init("utf8", "IsAlnum", &PL_sv_undef, 0, 0);
614 return swash_fetch(PL_utf8_alnum, p);
615 /* return *p == '_' || is_utf8_alpha(p) || is_utf8_digit(p); */
616 #ifdef SURPRISINGLY_SLOWER /* probably because alpha is usually true */
618 PL_utf8_alnum = swash_init("utf8", "",
619 sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
620 return swash_fetch(PL_utf8_alnum, p);
625 Perl_is_utf8_alnumc(pTHX_ U8 *p)
627 if (!is_utf8_char(p))
630 PL_utf8_alnum = swash_init("utf8", "IsAlnumC", &PL_sv_undef, 0, 0);
631 return swash_fetch(PL_utf8_alnum, p);
632 /* return is_utf8_alpha(p) || is_utf8_digit(p); */
633 #ifdef SURPRISINGLY_SLOWER /* probably because alpha is usually true */
635 PL_utf8_alnum = swash_init("utf8", "",
636 sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
637 return swash_fetch(PL_utf8_alnum, p);
642 Perl_is_utf8_idfirst(pTHX_ U8 *p)
644 return *p == '_' || is_utf8_alpha(p);
648 Perl_is_utf8_alpha(pTHX_ U8 *p)
650 if (!is_utf8_char(p))
653 PL_utf8_alpha = swash_init("utf8", "IsAlpha", &PL_sv_undef, 0, 0);
654 return swash_fetch(PL_utf8_alpha, p);
658 Perl_is_utf8_ascii(pTHX_ U8 *p)
660 if (!is_utf8_char(p))
663 PL_utf8_ascii = swash_init("utf8", "IsAscii", &PL_sv_undef, 0, 0);
664 return swash_fetch(PL_utf8_ascii, p);
668 Perl_is_utf8_space(pTHX_ U8 *p)
670 if (!is_utf8_char(p))
673 PL_utf8_space = swash_init("utf8", "IsSpace", &PL_sv_undef, 0, 0);
674 return swash_fetch(PL_utf8_space, p);
678 Perl_is_utf8_digit(pTHX_ U8 *p)
680 if (!is_utf8_char(p))
683 PL_utf8_digit = swash_init("utf8", "IsDigit", &PL_sv_undef, 0, 0);
684 return swash_fetch(PL_utf8_digit, p);
688 Perl_is_utf8_upper(pTHX_ U8 *p)
690 if (!is_utf8_char(p))
693 PL_utf8_upper = swash_init("utf8", "IsUpper", &PL_sv_undef, 0, 0);
694 return swash_fetch(PL_utf8_upper, p);
698 Perl_is_utf8_lower(pTHX_ U8 *p)
700 if (!is_utf8_char(p))
703 PL_utf8_lower = swash_init("utf8", "IsLower", &PL_sv_undef, 0, 0);
704 return swash_fetch(PL_utf8_lower, p);
708 Perl_is_utf8_cntrl(pTHX_ U8 *p)
710 if (!is_utf8_char(p))
713 PL_utf8_cntrl = swash_init("utf8", "IsCntrl", &PL_sv_undef, 0, 0);
714 return swash_fetch(PL_utf8_cntrl, p);
718 Perl_is_utf8_graph(pTHX_ U8 *p)
720 if (!is_utf8_char(p))
723 PL_utf8_graph = swash_init("utf8", "IsGraph", &PL_sv_undef, 0, 0);
724 return swash_fetch(PL_utf8_graph, p);
728 Perl_is_utf8_print(pTHX_ U8 *p)
730 if (!is_utf8_char(p))
733 PL_utf8_print = swash_init("utf8", "IsPrint", &PL_sv_undef, 0, 0);
734 return swash_fetch(PL_utf8_print, p);
738 Perl_is_utf8_punct(pTHX_ U8 *p)
740 if (!is_utf8_char(p))
743 PL_utf8_punct = swash_init("utf8", "IsPunct", &PL_sv_undef, 0, 0);
744 return swash_fetch(PL_utf8_punct, p);
748 Perl_is_utf8_xdigit(pTHX_ U8 *p)
750 if (!is_utf8_char(p))
753 PL_utf8_xdigit = swash_init("utf8", "IsXDigit", &PL_sv_undef, 0, 0);
754 return swash_fetch(PL_utf8_xdigit, p);
758 Perl_is_utf8_mark(pTHX_ U8 *p)
760 if (!is_utf8_char(p))
763 PL_utf8_mark = swash_init("utf8", "IsM", &PL_sv_undef, 0, 0);
764 return swash_fetch(PL_utf8_mark, p);
768 Perl_to_utf8_upper(pTHX_ U8 *p)
772 if (!PL_utf8_toupper)
773 PL_utf8_toupper = swash_init("utf8", "ToUpper", &PL_sv_undef, 4, 0);
774 uv = swash_fetch(PL_utf8_toupper, p);
775 return uv ? uv : utf8_to_uv(p,0);
779 Perl_to_utf8_title(pTHX_ U8 *p)
783 if (!PL_utf8_totitle)
784 PL_utf8_totitle = swash_init("utf8", "ToTitle", &PL_sv_undef, 4, 0);
785 uv = swash_fetch(PL_utf8_totitle, p);
786 return uv ? uv : utf8_to_uv(p,0);
790 Perl_to_utf8_lower(pTHX_ U8 *p)
794 if (!PL_utf8_tolower)
795 PL_utf8_tolower = swash_init("utf8", "ToLower", &PL_sv_undef, 4, 0);
796 uv = swash_fetch(PL_utf8_tolower, p);
797 return uv ? uv : utf8_to_uv(p,0);
800 /* a "swash" is a swatch hash */
803 Perl_swash_init(pTHX_ char* pkg, char* name, SV *listsv, I32 minbits, I32 none)
809 if (!gv_stashpv(pkg, 0)) { /* demand load utf8 */
811 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpv(pkg,0), Nullsv);
815 PUSHSTACKi(PERLSI_MAGIC);
818 PUSHs(sv_2mortal(newSVpvn(pkg, strlen(pkg))));
819 PUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
821 PUSHs(sv_2mortal(newSViv(minbits)));
822 PUSHs(sv_2mortal(newSViv(none)));
828 if (PL_curcop == &PL_compiling) /* XXX ought to be handled by lex_start */
829 strncpy(tmpbuf, PL_tokenbuf, sizeof tmpbuf);
830 if (call_method("SWASHNEW", G_SCALAR))
831 retval = newSVsv(*PL_stack_sp--);
833 retval = &PL_sv_undef;
836 if (PL_curcop == &PL_compiling) {
837 strncpy(PL_tokenbuf, tmpbuf, sizeof tmpbuf);
838 PL_curcop->op_private = PL_hints;
840 if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV)
841 Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
846 Perl_swash_fetch(pTHX_ SV *sv, U8 *ptr)
848 HV* hv = (HV*)SvRV(sv);
849 U32 klen = UTF8SKIP(ptr) - 1;
850 U32 off = ptr[klen] & 127; /* NB: 64 bit always 0 when len > 1 */
852 STRLEN needents = (klen ? 64 : 128);
858 * This single-entry cache saves about 1/3 of the utf8 overhead in test
859 * suite. (That is, only 7-8% overall over just a hash cache. Still,
860 * it's nothing to sniff at.) Pity we usually come through at least
861 * two function calls to get here...
863 * NB: this code assumes that swatches are never modified, once generated!
866 if (hv == PL_last_swash_hv &&
867 klen == PL_last_swash_klen &&
868 (!klen || memEQ((char *)ptr,(char *)PL_last_swash_key,klen)) )
870 tmps = PL_last_swash_tmps;
871 slen = PL_last_swash_slen;
874 /* Try our second-level swatch cache, kept in a hash. */
875 SV** svp = hv_fetch(hv, (char*)ptr, klen, FALSE);
877 /* If not cached, generate it via utf8::SWASHGET */
878 if (!svp || !SvPOK(*svp) || !(tmps = (U8*)SvPV(*svp, slen))) {
883 PUSHSTACKi(PERLSI_MAGIC);
887 PUSHs(sv_2mortal(newSViv(utf8_to_uv(ptr, 0) & ~(needents - 1))));
888 PUSHs(sv_2mortal(newSViv(needents)));
890 if (call_method("SWASHGET", G_SCALAR))
891 retval = newSVsv(*PL_stack_sp--);
893 retval = &PL_sv_undef;
897 if (PL_curcop == &PL_compiling)
898 PL_curcop->op_private = PL_hints;
900 svp = hv_store(hv, (char*)ptr, klen, retval, 0);
902 if (!svp || !(tmps = (U8*)SvPV(*svp, slen)) || slen < 8)
903 Perl_croak(aTHX_ "SWASHGET didn't return result of proper length");
906 PL_last_swash_hv = hv;
907 PL_last_swash_klen = klen;
908 PL_last_swash_tmps = tmps;
909 PL_last_swash_slen = slen;
911 Copy(ptr, PL_last_swash_key, klen, U8);
914 switch ((slen << 3) / needents) {
916 bit = 1 << (off & 7);
918 return (tmps[off] & bit) != 0;
923 return (tmps[off] << 8) + tmps[off + 1] ;
926 return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
928 Perl_croak(aTHX_ "panic: swash_fetch");