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) /* the d must be UTF8_MAXLEN+1 deep */
38 *d++ = (( uv >> 6) | 0xc0);
39 *d++ = (( uv & 0x3f) | 0x80);
44 *d++ = (( uv >> 12) | 0xe0);
45 *d++ = (((uv >> 6) & 0x3f) | 0x80);
46 *d++ = (( uv & 0x3f) | 0x80);
51 *d++ = (( uv >> 18) | 0xf0);
52 *d++ = (((uv >> 12) & 0x3f) | 0x80);
53 *d++ = (((uv >> 6) & 0x3f) | 0x80);
54 *d++ = (( uv & 0x3f) | 0x80);
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);
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);
78 if (uv < UTF8_QUAD_MAX)
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);
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);
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. */
116 Perl_is_utf8_char(pTHX_ U8 *s)
125 if (u >= 0x80 && u <= 0xbf)
130 if (len < 2 || (u >= 0xc0 && u <= 0xfd && s[1] < 0x80))
138 if ((*s & 0xc0) != 0x80)
140 uv = (uv << 6) | (*s & 0x3f);
147 if (UNISKIP(uv) < len)
154 =for apidoc Am|is_utf8_string|U8 *s|STRLEN len
156 Returns true if first C<len> bytes of the given string form valid a UTF8
157 string, false otherwise.
163 Perl_is_utf8_string(pTHX_ U8 *s, STRLEN len)
182 =for apidoc Am|U8* s|utf8_to_uv|STRLEN curlen|STRLEN *retlen|U32 flags
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.
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. The C<flags> can also contain
193 various flags to allow deviations from the strict UTF-8 encoding
199 Perl_utf8_to_uv(pTHX_ U8* s, STRLEN curlen, STRLEN* retlen, U32 flags)
206 bool dowarn = ckWARN_d(WARN_UTF8);
208 STRLEN expectlen = 0;
212 Perl_warner(aTHX_ WARN_UTF8,
213 "Malformed UTF-8 character (an empty string)");
217 if (uv <= 0x7f) { /* Pure ASCII. */
223 if ((uv >= 0x80 && uv <= 0xbf) &&
224 !(flags & UTF8_ALLOW_CONTINUATION)) {
226 Perl_warner(aTHX_ WARN_UTF8,
227 "Malformed UTF-8 character (unexpected continuation byte 0x%02"UVxf")",
232 if ((uv >= 0xc0 && uv <= 0xfd && curlen > 1 && s[1] < 0x80) &&
233 !(flags & UTF8_ALLOW_NON_CONTINUATION)) {
235 Perl_warner(aTHX_ WARN_UTF8,
236 "Malformed UTF-8 character (unexpected non-continuation byte 0x%02"UVxf" after byte 0x%02"UVxf")",
241 if ((uv == 0xfe || uv == 0xff) &&
242 !(flags & UTF8_ALLOW_FE_FF)) {
244 Perl_warner(aTHX_ WARN_UTF8,
245 "Malformed UTF-8 character (byte 0x%02"UVxf")",
250 if (!(uv & 0x20)) { len = 2; uv &= 0x1f; }
251 else if (!(uv & 0x10)) { len = 3; uv &= 0x0f; }
252 else if (!(uv & 0x08)) { len = 4; uv &= 0x07; }
253 else if (!(uv & 0x04)) { len = 5; uv &= 0x03; }
254 else if (!(uv & 0x02)) { len = 6; uv &= 0x01; }
255 else if (!(uv & 0x01)) { len = 7; uv = 0; }
256 else { len = 13; uv = 0; } /* whoa! */
263 if ((curlen < expectlen) &&
264 !(flags & UTF8_ALLOW_SHORT)) {
266 Perl_warner(aTHX_ WARN_UTF8,
267 "Malformed UTF-8 character (%d byte%s, need %d)",
268 curlen, curlen == 1 ? "" : "s", expectlen);
277 if ((*s & 0xc0) != 0x80) {
279 Perl_warner(aTHX_ WARN_UTF8,
280 "Malformed UTF-8 character (unexpected continuation byte 0x%02x)",
285 uv = (uv << 6) | (*s & 0x3f);
287 /* This cannot be allowed. */
289 Perl_warner(aTHX_ WARN_UTF8,
290 "Malformed UTF-8 character (overflow at 0x%"UVxf", byte 0x%02x)",
298 if ((uv >= 0xd800 && uv <= 0xdfff) &&
299 !(flags & UTF8_ALLOW_SURROGATE)) {
301 Perl_warner(aTHX_ WARN_UTF8,
302 "Malformed UTF-8 character (UTF-16 surrogate 0x%04"UVxf")",
305 } else if ((uv == 0xfffe) &&
306 !(flags & UTF8_ALLOW_BOM)) {
308 Perl_warner(aTHX_ WARN_UTF8,
309 "Malformed UTF-8 character (byte order mark 0x%04"UVxf")",
312 } else if ((uv == 0xffff) &&
313 !(flags & UTF8_ALLOW_FFFF)) {
315 Perl_warner(aTHX_ WARN_UTF8,
316 "Malformed UTF-8 character (character 0x%04"UVxf")",
319 } else if ((expectlen > UNISKIP(uv)) &&
320 !(flags & UTF8_ALLOW_LONG)) {
322 Perl_warner(aTHX_ WARN_UTF8,
323 "Malformed UTF-8 character (%d byte%s, need %d)",
324 expectlen, expectlen == 1 ? "": "s", UNISKIP(uv));
332 if (flags & UTF8_CHECK_ONLY) {
339 *retlen = expectlen ? expectlen : len;
341 return UNICODE_REPLACEMENT_CHARACTER;
345 =for apidoc Am|U8* s|utf8_to_uv_simple|STRLEN *retlen
347 Returns the character value of the first character in the string C<s>
348 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
349 length, in bytes, of that character, and the pointer C<s> will be
350 advanced to the end of the character.
352 If C<s> does not point to a well-formed UTF8 character, zero is
353 returned and retlen is set, if possible, to -1.
359 Perl_utf8_to_uv_simple(pTHX_ U8* s, STRLEN* retlen)
361 return Perl_utf8_to_uv(aTHX_ s, UTF8_MAXLEN, retlen, 0);
365 =for apidoc|utf8_length|U8 *s|U8 *e
367 Return the length of the UTF-8 char encoded string C<s> in characters.
368 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
369 up past C<e>, croaks.
375 Perl_utf8_length(pTHX_ U8* s, U8* e)
380 Perl_croak(aTHX_ "panic: utf8_length: unexpected end");
385 Perl_croak(aTHX_ "panic: utf8_length: unaligned end");
393 /* utf8_distance(a,b) returns the number of UTF8 characters between
394 the pointers a and b */
397 Perl_utf8_distance(pTHX_ U8 *a, U8 *b)
406 Perl_croak(aTHX_ "panic: utf8_distance: unaligned end");
416 Perl_croak(aTHX_ "panic: utf8_distance: unaligned end");
425 /* WARNING: do not use the following unless you *know* off is within bounds */
428 Perl_utf8_hop(pTHX_ U8 *s, I32 off)
438 while ((*s & 0xc0) == 0x80)
447 =for apidoc Am|U8 *|utf8_to_bytes|U8 *s|STRLEN *len
449 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
450 Unlike C<bytes_to_utf8>, this over-writes the original string, and
451 updates len to contain the new length.
452 Returns zero on failure, setting C<len> to -1.
458 Perl_utf8_to_bytes(pTHX_ U8* s, STRLEN *len)
464 /* ensure valid UTF8 and chars < 256 before updating string */
465 for (send = s + *len; s < send; ) {
470 ((*s++ & 0xc0) != 0x80) || ((c & 0xfe) != 0xc2))) {
483 *d++ = (U8)utf8_to_uv_simple(s, &ulen);
493 =for apidoc Am|U8 *|bytes_to_utf8|U8 *s|STRLEN *len
495 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
496 Returns a pointer to the newly-created string, and sets C<len> to
497 reflect the new length.
503 Perl_bytes_to_utf8(pTHX_ U8* s, STRLEN *len)
510 Newz(801, d, (*len) * 2 + 1, U8);
518 *d++ = (( uv >> 6) | 0xc0);
519 *d++ = (( uv & 0x3f) | 0x80);
528 * Convert native (big-endian) or reversed (little-endian) UTF-16 to UTF-8.
530 * Destination must be pre-extended to 3/2 source. Do not use in-place.
531 * We optimize for native, for obvious reasons. */
534 Perl_utf16_to_utf8(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
540 Perl_croak(aTHX_ "panic: utf16_to_utf8: odd bytelen");
545 UV uv = (p[0] << 8) + p[1]; /* UTF-16BE */
552 *d++ = (( uv >> 6) | 0xc0);
553 *d++ = (( uv & 0x3f) | 0x80);
556 if (uv >= 0xd800 && uv < 0xdbff) { /* surrogates */
558 if (low < 0xdc00 || low >= 0xdfff)
559 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
560 uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
563 *d++ = (( uv >> 12) | 0xe0);
564 *d++ = (((uv >> 6) & 0x3f) | 0x80);
565 *d++ = (( uv & 0x3f) | 0x80);
569 *d++ = (( uv >> 18) | 0xf0);
570 *d++ = (((uv >> 12) & 0x3f) | 0x80);
571 *d++ = (((uv >> 6) & 0x3f) | 0x80);
572 *d++ = (( uv & 0x3f) | 0x80);
576 *newlen = d - dstart;
580 /* Note: this one is slightly destructive of the source. */
583 Perl_utf16_to_utf8_reversed(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
586 U8* send = s + bytelen;
593 return utf16_to_utf8(p, d, bytelen, newlen);
596 /* for now these are all defined (inefficiently) in terms of the utf8 versions */
599 Perl_is_uni_alnum(pTHX_ U32 c)
601 U8 tmpbuf[UTF8_MAXLEN+1];
602 uv_to_utf8(tmpbuf, (UV)c);
603 return is_utf8_alnum(tmpbuf);
607 Perl_is_uni_alnumc(pTHX_ U32 c)
609 U8 tmpbuf[UTF8_MAXLEN+1];
610 uv_to_utf8(tmpbuf, (UV)c);
611 return is_utf8_alnumc(tmpbuf);
615 Perl_is_uni_idfirst(pTHX_ U32 c)
617 U8 tmpbuf[UTF8_MAXLEN+1];
618 uv_to_utf8(tmpbuf, (UV)c);
619 return is_utf8_idfirst(tmpbuf);
623 Perl_is_uni_alpha(pTHX_ U32 c)
625 U8 tmpbuf[UTF8_MAXLEN+1];
626 uv_to_utf8(tmpbuf, (UV)c);
627 return is_utf8_alpha(tmpbuf);
631 Perl_is_uni_ascii(pTHX_ U32 c)
633 U8 tmpbuf[UTF8_MAXLEN+1];
634 uv_to_utf8(tmpbuf, (UV)c);
635 return is_utf8_ascii(tmpbuf);
639 Perl_is_uni_space(pTHX_ U32 c)
641 U8 tmpbuf[UTF8_MAXLEN+1];
642 uv_to_utf8(tmpbuf, (UV)c);
643 return is_utf8_space(tmpbuf);
647 Perl_is_uni_digit(pTHX_ U32 c)
649 U8 tmpbuf[UTF8_MAXLEN+1];
650 uv_to_utf8(tmpbuf, (UV)c);
651 return is_utf8_digit(tmpbuf);
655 Perl_is_uni_upper(pTHX_ U32 c)
657 U8 tmpbuf[UTF8_MAXLEN+1];
658 uv_to_utf8(tmpbuf, (UV)c);
659 return is_utf8_upper(tmpbuf);
663 Perl_is_uni_lower(pTHX_ U32 c)
665 U8 tmpbuf[UTF8_MAXLEN+1];
666 uv_to_utf8(tmpbuf, (UV)c);
667 return is_utf8_lower(tmpbuf);
671 Perl_is_uni_cntrl(pTHX_ U32 c)
673 U8 tmpbuf[UTF8_MAXLEN+1];
674 uv_to_utf8(tmpbuf, (UV)c);
675 return is_utf8_cntrl(tmpbuf);
679 Perl_is_uni_graph(pTHX_ U32 c)
681 U8 tmpbuf[UTF8_MAXLEN+1];
682 uv_to_utf8(tmpbuf, (UV)c);
683 return is_utf8_graph(tmpbuf);
687 Perl_is_uni_print(pTHX_ U32 c)
689 U8 tmpbuf[UTF8_MAXLEN+1];
690 uv_to_utf8(tmpbuf, (UV)c);
691 return is_utf8_print(tmpbuf);
695 Perl_is_uni_punct(pTHX_ U32 c)
697 U8 tmpbuf[UTF8_MAXLEN+1];
698 uv_to_utf8(tmpbuf, (UV)c);
699 return is_utf8_punct(tmpbuf);
703 Perl_is_uni_xdigit(pTHX_ U32 c)
705 U8 tmpbuf[UTF8_MAXLEN+1];
706 uv_to_utf8(tmpbuf, (UV)c);
707 return is_utf8_xdigit(tmpbuf);
711 Perl_to_uni_upper(pTHX_ U32 c)
713 U8 tmpbuf[UTF8_MAXLEN+1];
714 uv_to_utf8(tmpbuf, (UV)c);
715 return to_utf8_upper(tmpbuf);
719 Perl_to_uni_title(pTHX_ U32 c)
721 U8 tmpbuf[UTF8_MAXLEN+1];
722 uv_to_utf8(tmpbuf, (UV)c);
723 return to_utf8_title(tmpbuf);
727 Perl_to_uni_lower(pTHX_ U32 c)
729 U8 tmpbuf[UTF8_MAXLEN+1];
730 uv_to_utf8(tmpbuf, (UV)c);
731 return to_utf8_lower(tmpbuf);
734 /* for now these all assume no locale info available for Unicode > 255 */
737 Perl_is_uni_alnum_lc(pTHX_ U32 c)
739 return is_uni_alnum(c); /* XXX no locale support yet */
743 Perl_is_uni_alnumc_lc(pTHX_ U32 c)
745 return is_uni_alnumc(c); /* XXX no locale support yet */
749 Perl_is_uni_idfirst_lc(pTHX_ U32 c)
751 return is_uni_idfirst(c); /* XXX no locale support yet */
755 Perl_is_uni_alpha_lc(pTHX_ U32 c)
757 return is_uni_alpha(c); /* XXX no locale support yet */
761 Perl_is_uni_ascii_lc(pTHX_ U32 c)
763 return is_uni_ascii(c); /* XXX no locale support yet */
767 Perl_is_uni_space_lc(pTHX_ U32 c)
769 return is_uni_space(c); /* XXX no locale support yet */
773 Perl_is_uni_digit_lc(pTHX_ U32 c)
775 return is_uni_digit(c); /* XXX no locale support yet */
779 Perl_is_uni_upper_lc(pTHX_ U32 c)
781 return is_uni_upper(c); /* XXX no locale support yet */
785 Perl_is_uni_lower_lc(pTHX_ U32 c)
787 return is_uni_lower(c); /* XXX no locale support yet */
791 Perl_is_uni_cntrl_lc(pTHX_ U32 c)
793 return is_uni_cntrl(c); /* XXX no locale support yet */
797 Perl_is_uni_graph_lc(pTHX_ U32 c)
799 return is_uni_graph(c); /* XXX no locale support yet */
803 Perl_is_uni_print_lc(pTHX_ U32 c)
805 return is_uni_print(c); /* XXX no locale support yet */
809 Perl_is_uni_punct_lc(pTHX_ U32 c)
811 return is_uni_punct(c); /* XXX no locale support yet */
815 Perl_is_uni_xdigit_lc(pTHX_ U32 c)
817 return is_uni_xdigit(c); /* XXX no locale support yet */
821 Perl_to_uni_upper_lc(pTHX_ U32 c)
823 return to_uni_upper(c); /* XXX no locale support yet */
827 Perl_to_uni_title_lc(pTHX_ U32 c)
829 return to_uni_title(c); /* XXX no locale support yet */
833 Perl_to_uni_lower_lc(pTHX_ U32 c)
835 return to_uni_lower(c); /* XXX no locale support yet */
839 Perl_is_utf8_alnum(pTHX_ U8 *p)
841 if (!is_utf8_char(p))
844 /* NOTE: "IsWord", not "IsAlnum", since Alnum is a true
845 * descendant of isalnum(3), in other words, it doesn't
846 * contain the '_'. --jhi */
847 PL_utf8_alnum = swash_init("utf8", "IsWord", &PL_sv_undef, 0, 0);
848 return swash_fetch(PL_utf8_alnum, p);
849 /* return *p == '_' || is_utf8_alpha(p) || is_utf8_digit(p); */
850 #ifdef SURPRISINGLY_SLOWER /* probably because alpha is usually true */
852 PL_utf8_alnum = swash_init("utf8", "",
853 sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
854 return swash_fetch(PL_utf8_alnum, p);
859 Perl_is_utf8_alnumc(pTHX_ U8 *p)
861 if (!is_utf8_char(p))
864 PL_utf8_alnum = swash_init("utf8", "IsAlnumC", &PL_sv_undef, 0, 0);
865 return swash_fetch(PL_utf8_alnum, p);
866 /* return is_utf8_alpha(p) || is_utf8_digit(p); */
867 #ifdef SURPRISINGLY_SLOWER /* probably because alpha is usually true */
869 PL_utf8_alnum = swash_init("utf8", "",
870 sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
871 return swash_fetch(PL_utf8_alnum, p);
876 Perl_is_utf8_idfirst(pTHX_ U8 *p)
878 return *p == '_' || is_utf8_alpha(p);
882 Perl_is_utf8_alpha(pTHX_ U8 *p)
884 if (!is_utf8_char(p))
887 PL_utf8_alpha = swash_init("utf8", "IsAlpha", &PL_sv_undef, 0, 0);
888 return swash_fetch(PL_utf8_alpha, p);
892 Perl_is_utf8_ascii(pTHX_ U8 *p)
894 if (!is_utf8_char(p))
897 PL_utf8_ascii = swash_init("utf8", "IsAscii", &PL_sv_undef, 0, 0);
898 return swash_fetch(PL_utf8_ascii, p);
902 Perl_is_utf8_space(pTHX_ U8 *p)
904 if (!is_utf8_char(p))
907 PL_utf8_space = swash_init("utf8", "IsSpacePerl", &PL_sv_undef, 0, 0);
908 return swash_fetch(PL_utf8_space, p);
912 Perl_is_utf8_digit(pTHX_ U8 *p)
914 if (!is_utf8_char(p))
917 PL_utf8_digit = swash_init("utf8", "IsDigit", &PL_sv_undef, 0, 0);
918 return swash_fetch(PL_utf8_digit, p);
922 Perl_is_utf8_upper(pTHX_ U8 *p)
924 if (!is_utf8_char(p))
927 PL_utf8_upper = swash_init("utf8", "IsUpper", &PL_sv_undef, 0, 0);
928 return swash_fetch(PL_utf8_upper, p);
932 Perl_is_utf8_lower(pTHX_ U8 *p)
934 if (!is_utf8_char(p))
937 PL_utf8_lower = swash_init("utf8", "IsLower", &PL_sv_undef, 0, 0);
938 return swash_fetch(PL_utf8_lower, p);
942 Perl_is_utf8_cntrl(pTHX_ U8 *p)
944 if (!is_utf8_char(p))
947 PL_utf8_cntrl = swash_init("utf8", "IsCntrl", &PL_sv_undef, 0, 0);
948 return swash_fetch(PL_utf8_cntrl, p);
952 Perl_is_utf8_graph(pTHX_ U8 *p)
954 if (!is_utf8_char(p))
957 PL_utf8_graph = swash_init("utf8", "IsGraph", &PL_sv_undef, 0, 0);
958 return swash_fetch(PL_utf8_graph, p);
962 Perl_is_utf8_print(pTHX_ U8 *p)
964 if (!is_utf8_char(p))
967 PL_utf8_print = swash_init("utf8", "IsPrint", &PL_sv_undef, 0, 0);
968 return swash_fetch(PL_utf8_print, p);
972 Perl_is_utf8_punct(pTHX_ U8 *p)
974 if (!is_utf8_char(p))
977 PL_utf8_punct = swash_init("utf8", "IsPunct", &PL_sv_undef, 0, 0);
978 return swash_fetch(PL_utf8_punct, p);
982 Perl_is_utf8_xdigit(pTHX_ U8 *p)
984 if (!is_utf8_char(p))
987 PL_utf8_xdigit = swash_init("utf8", "IsXDigit", &PL_sv_undef, 0, 0);
988 return swash_fetch(PL_utf8_xdigit, p);
992 Perl_is_utf8_mark(pTHX_ U8 *p)
994 if (!is_utf8_char(p))
997 PL_utf8_mark = swash_init("utf8", "IsM", &PL_sv_undef, 0, 0);
998 return swash_fetch(PL_utf8_mark, p);
1002 Perl_to_utf8_upper(pTHX_ U8 *p)
1006 if (!PL_utf8_toupper)
1007 PL_utf8_toupper = swash_init("utf8", "ToUpper", &PL_sv_undef, 4, 0);
1008 uv = swash_fetch(PL_utf8_toupper, p);
1009 return uv ? uv : utf8_to_uv(p,UTF8_MAXLEN,0,0);
1013 Perl_to_utf8_title(pTHX_ U8 *p)
1017 if (!PL_utf8_totitle)
1018 PL_utf8_totitle = swash_init("utf8", "ToTitle", &PL_sv_undef, 4, 0);
1019 uv = swash_fetch(PL_utf8_totitle, p);
1020 return uv ? uv : utf8_to_uv(p,UTF8_MAXLEN,0,0);
1024 Perl_to_utf8_lower(pTHX_ U8 *p)
1028 if (!PL_utf8_tolower)
1029 PL_utf8_tolower = swash_init("utf8", "ToLower", &PL_sv_undef, 4, 0);
1030 uv = swash_fetch(PL_utf8_tolower, p);
1031 return uv ? uv : utf8_to_uv(p,UTF8_MAXLEN,0,0);
1034 /* a "swash" is a swatch hash */
1037 Perl_swash_init(pTHX_ char* pkg, char* name, SV *listsv, I32 minbits, I32 none)
1043 if (!gv_stashpv(pkg, 0)) { /* demand load utf8 */
1045 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpv(pkg,0), Nullsv);
1049 PUSHSTACKi(PERLSI_MAGIC);
1052 PUSHs(sv_2mortal(newSVpvn(pkg, strlen(pkg))));
1053 PUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
1055 PUSHs(sv_2mortal(newSViv(minbits)));
1056 PUSHs(sv_2mortal(newSViv(none)));
1062 if (PL_curcop == &PL_compiling) /* XXX ought to be handled by lex_start */
1063 strncpy(tmpbuf, PL_tokenbuf, sizeof tmpbuf);
1064 if (call_method("SWASHNEW", G_SCALAR))
1065 retval = newSVsv(*PL_stack_sp--);
1067 retval = &PL_sv_undef;
1070 if (PL_curcop == &PL_compiling) {
1071 strncpy(PL_tokenbuf, tmpbuf, sizeof tmpbuf);
1072 PL_curcop->op_private = PL_hints;
1074 if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV)
1075 Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
1080 Perl_swash_fetch(pTHX_ SV *sv, U8 *ptr)
1082 HV* hv = (HV*)SvRV(sv);
1083 U32 klen = UTF8SKIP(ptr) - 1;
1084 U32 off = ptr[klen] & 127; /* NB: 64 bit always 0 when len > 1 */
1086 STRLEN needents = (klen ? 64 : 128);
1092 * This single-entry cache saves about 1/3 of the utf8 overhead in test
1093 * suite. (That is, only 7-8% overall over just a hash cache. Still,
1094 * it's nothing to sniff at.) Pity we usually come through at least
1095 * two function calls to get here...
1097 * NB: this code assumes that swatches are never modified, once generated!
1100 if (hv == PL_last_swash_hv &&
1101 klen == PL_last_swash_klen &&
1102 (!klen || memEQ((char *)ptr,(char *)PL_last_swash_key,klen)) )
1104 tmps = PL_last_swash_tmps;
1105 slen = PL_last_swash_slen;
1108 /* Try our second-level swatch cache, kept in a hash. */
1109 SV** svp = hv_fetch(hv, (char*)ptr, klen, FALSE);
1111 /* If not cached, generate it via utf8::SWASHGET */
1112 if (!svp || !SvPOK(*svp) || !(tmps = (U8*)SvPV(*svp, slen))) {
1117 PUSHSTACKi(PERLSI_MAGIC);
1121 PUSHs(sv_2mortal(newSViv(utf8_to_uv(ptr, UTF8_MAXLEN, 0, 0) & ~(needents - 1))));
1122 PUSHs(sv_2mortal(newSViv(needents)));
1124 if (call_method("SWASHGET", G_SCALAR))
1125 retval = newSVsv(*PL_stack_sp--);
1127 retval = &PL_sv_undef;
1131 if (PL_curcop == &PL_compiling)
1132 PL_curcop->op_private = PL_hints;
1134 svp = hv_store(hv, (char*)ptr, klen, retval, 0);
1136 if (!svp || !(tmps = (U8*)SvPV(*svp, slen)) || slen < 8)
1137 Perl_croak(aTHX_ "SWASHGET didn't return result of proper length");
1140 PL_last_swash_hv = hv;
1141 PL_last_swash_klen = klen;
1142 PL_last_swash_tmps = tmps;
1143 PL_last_swash_slen = slen;
1145 Copy(ptr, PL_last_swash_key, klen, U8);
1148 switch ((int)((slen << 3) / needents)) {
1150 bit = 1 << (off & 7);
1152 return (tmps[off] & bit) != 0;
1157 return (tmps[off] << 8) + tmps[off + 1] ;
1160 return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
1162 Perl_croak(aTHX_ "panic: swash_fetch");