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 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>).
201 Perl_utf8_to_uv(pTHX_ U8* s, STRLEN curlen, STRLEN* retlen, U32 flags)
208 bool dowarn = ckWARN_d(WARN_UTF8);
210 STRLEN expectlen = 0;
214 Perl_warner(aTHX_ WARN_UTF8,
215 "Malformed UTF-8 character (an empty string)");
219 if (uv <= 0x7f) { /* Pure ASCII. */
225 if ((uv >= 0x80 && uv <= 0xbf) &&
226 !(flags & UTF8_ALLOW_CONTINUATION)) {
228 Perl_warner(aTHX_ WARN_UTF8,
229 "Malformed UTF-8 character (unexpected continuation byte 0x%02"UVxf")",
234 if ((uv >= 0xc0 && uv <= 0xfd && curlen > 1 && s[1] < 0x80) &&
235 !(flags & UTF8_ALLOW_NON_CONTINUATION)) {
237 Perl_warner(aTHX_ WARN_UTF8,
238 "Malformed UTF-8 character (unexpected non-continuation byte 0x%02"UVxf" after byte 0x%02"UVxf")",
243 if ((uv == 0xfe || uv == 0xff) &&
244 !(flags & UTF8_ALLOW_FE_FF)) {
246 Perl_warner(aTHX_ WARN_UTF8,
247 "Malformed UTF-8 character (byte 0x%02"UVxf")",
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! */
265 if ((curlen < expectlen) &&
266 !(flags & UTF8_ALLOW_SHORT)) {
268 Perl_warner(aTHX_ WARN_UTF8,
269 "Malformed UTF-8 character (%d byte%s, need %d)",
270 curlen, curlen == 1 ? "" : "s", expectlen);
279 if ((*s & 0xc0) != 0x80) {
281 Perl_warner(aTHX_ WARN_UTF8,
282 "Malformed UTF-8 character (unexpected continuation byte 0x%02x)",
287 uv = (uv << 6) | (*s & 0x3f);
289 /* This cannot be allowed. */
291 Perl_warner(aTHX_ WARN_UTF8,
292 "Malformed UTF-8 character (overflow at 0x%"UVxf", byte 0x%02x)",
300 if ((uv >= 0xd800 && uv <= 0xdfff) &&
301 !(flags & UTF8_ALLOW_SURROGATE)) {
303 Perl_warner(aTHX_ WARN_UTF8,
304 "Malformed UTF-8 character (UTF-16 surrogate 0x%04"UVxf")",
307 } else if ((uv == 0xfffe) &&
308 !(flags & UTF8_ALLOW_BOM)) {
310 Perl_warner(aTHX_ WARN_UTF8,
311 "Malformed UTF-8 character (byte order mark 0x%04"UVxf")",
314 } else if ((expectlen > UNISKIP(uv)) &&
315 !(flags & UTF8_ALLOW_LONG)) {
317 Perl_warner(aTHX_ WARN_UTF8,
318 "Malformed UTF-8 character (%d byte%s, need %d)",
319 expectlen, expectlen == 1 ? "": "s", UNISKIP(uv));
321 } else if ((uv == 0xffff) &&
322 !(flags & UTF8_ALLOW_FFFF)) {
324 Perl_warner(aTHX_ WARN_UTF8,
325 "Malformed UTF-8 character (character 0x%04"UVxf")",
334 if (flags & UTF8_CHECK_ONLY) {
343 return UNICODE_REPLACEMENT_CHARACTER;
347 =for apidoc Am|U8* s|utf8_to_uv_simple|STRLEN *retlen
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.
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.
361 Perl_utf8_to_uv_simple(pTHX_ U8* s, STRLEN* retlen)
363 return Perl_utf8_to_uv(aTHX_ s, UTF8_MAXLEN, retlen, 0);
367 =for apidoc Am|STRLEN|utf8_length|U8* s|U8 *e
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.
377 Perl_utf8_length(pTHX_ U8* s, U8* e)
382 Perl_croak(aTHX_ "panic: utf8_length: unexpected end");
387 Perl_croak(aTHX_ "panic: utf8_length: unaligned end");
396 =for apidoc Am|IV|utf8_distance|U8 *a|U8 *b
398 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
401 WARNING: use only if you *know* that the pointers point inside the
407 Perl_utf8_distance(pTHX_ U8 *a, U8 *b)
416 Perl_croak(aTHX_ "panic: utf8_distance: unaligned end");
426 Perl_croak(aTHX_ "panic: utf8_distance: unaligned end");
436 =for apidoc Am|U8*|utf8_hop|U8 *s|I32 off
438 Move the C<s> pointing to UTF-8 data by C<off> characters, either forward
441 WARNING: do not use the following unless you *know* C<off> is within
442 the UTF-8 buffer pointed to by C<s>.
447 Perl_utf8_hop(pTHX_ U8 *s, I32 off)
457 while ((*s & 0xc0) == 0x80)
466 =for apidoc Am|U8 *|utf8_to_bytes|U8 *s|STRLEN *len
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.
477 Perl_utf8_to_bytes(pTHX_ U8* s, STRLEN *len)
483 /* ensure valid UTF8 and chars < 256 before updating string */
484 for (send = s + *len; s < send; ) {
489 ((*s++ & 0xc0) != 0x80) || ((c & 0xfe) != 0xc2))) {
502 *d++ = (U8)utf8_to_uv_simple(s, &ulen);
512 =for apidoc Am|U8 *|bytes_to_utf8|U8 *s|STRLEN *len
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.
522 Perl_bytes_to_utf8(pTHX_ U8* s, STRLEN *len)
529 Newz(801, d, (*len) * 2 + 1, U8);
537 *d++ = (( uv >> 6) | 0xc0);
538 *d++ = (( uv & 0x3f) | 0x80);
547 * Convert native (big-endian) or reversed (little-endian) UTF-16 to UTF-8.
549 * Destination must be pre-extended to 3/2 source. Do not use in-place.
550 * We optimize for native, for obvious reasons. */
553 Perl_utf16_to_utf8(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
559 Perl_croak(aTHX_ "panic: utf16_to_utf8: odd bytelen");
564 UV uv = (p[0] << 8) + p[1]; /* UTF-16BE */
571 *d++ = (( uv >> 6) | 0xc0);
572 *d++ = (( uv & 0x3f) | 0x80);
575 if (uv >= 0xd800 && uv < 0xdbff) { /* surrogates */
577 if (low < 0xdc00 || low >= 0xdfff)
578 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
579 uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
582 *d++ = (( uv >> 12) | 0xe0);
583 *d++ = (((uv >> 6) & 0x3f) | 0x80);
584 *d++ = (( uv & 0x3f) | 0x80);
588 *d++ = (( uv >> 18) | 0xf0);
589 *d++ = (((uv >> 12) & 0x3f) | 0x80);
590 *d++ = (((uv >> 6) & 0x3f) | 0x80);
591 *d++ = (( uv & 0x3f) | 0x80);
595 *newlen = d - dstart;
599 /* Note: this one is slightly destructive of the source. */
602 Perl_utf16_to_utf8_reversed(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
605 U8* send = s + bytelen;
612 return utf16_to_utf8(p, d, bytelen, newlen);
615 /* for now these are all defined (inefficiently) in terms of the utf8 versions */
618 Perl_is_uni_alnum(pTHX_ U32 c)
620 U8 tmpbuf[UTF8_MAXLEN+1];
621 uv_to_utf8(tmpbuf, (UV)c);
622 return is_utf8_alnum(tmpbuf);
626 Perl_is_uni_alnumc(pTHX_ U32 c)
628 U8 tmpbuf[UTF8_MAXLEN+1];
629 uv_to_utf8(tmpbuf, (UV)c);
630 return is_utf8_alnumc(tmpbuf);
634 Perl_is_uni_idfirst(pTHX_ U32 c)
636 U8 tmpbuf[UTF8_MAXLEN+1];
637 uv_to_utf8(tmpbuf, (UV)c);
638 return is_utf8_idfirst(tmpbuf);
642 Perl_is_uni_alpha(pTHX_ U32 c)
644 U8 tmpbuf[UTF8_MAXLEN+1];
645 uv_to_utf8(tmpbuf, (UV)c);
646 return is_utf8_alpha(tmpbuf);
650 Perl_is_uni_ascii(pTHX_ U32 c)
652 U8 tmpbuf[UTF8_MAXLEN+1];
653 uv_to_utf8(tmpbuf, (UV)c);
654 return is_utf8_ascii(tmpbuf);
658 Perl_is_uni_space(pTHX_ U32 c)
660 U8 tmpbuf[UTF8_MAXLEN+1];
661 uv_to_utf8(tmpbuf, (UV)c);
662 return is_utf8_space(tmpbuf);
666 Perl_is_uni_digit(pTHX_ U32 c)
668 U8 tmpbuf[UTF8_MAXLEN+1];
669 uv_to_utf8(tmpbuf, (UV)c);
670 return is_utf8_digit(tmpbuf);
674 Perl_is_uni_upper(pTHX_ U32 c)
676 U8 tmpbuf[UTF8_MAXLEN+1];
677 uv_to_utf8(tmpbuf, (UV)c);
678 return is_utf8_upper(tmpbuf);
682 Perl_is_uni_lower(pTHX_ U32 c)
684 U8 tmpbuf[UTF8_MAXLEN+1];
685 uv_to_utf8(tmpbuf, (UV)c);
686 return is_utf8_lower(tmpbuf);
690 Perl_is_uni_cntrl(pTHX_ U32 c)
692 U8 tmpbuf[UTF8_MAXLEN+1];
693 uv_to_utf8(tmpbuf, (UV)c);
694 return is_utf8_cntrl(tmpbuf);
698 Perl_is_uni_graph(pTHX_ U32 c)
700 U8 tmpbuf[UTF8_MAXLEN+1];
701 uv_to_utf8(tmpbuf, (UV)c);
702 return is_utf8_graph(tmpbuf);
706 Perl_is_uni_print(pTHX_ U32 c)
708 U8 tmpbuf[UTF8_MAXLEN+1];
709 uv_to_utf8(tmpbuf, (UV)c);
710 return is_utf8_print(tmpbuf);
714 Perl_is_uni_punct(pTHX_ U32 c)
716 U8 tmpbuf[UTF8_MAXLEN+1];
717 uv_to_utf8(tmpbuf, (UV)c);
718 return is_utf8_punct(tmpbuf);
722 Perl_is_uni_xdigit(pTHX_ U32 c)
724 U8 tmpbuf[UTF8_MAXLEN+1];
725 uv_to_utf8(tmpbuf, (UV)c);
726 return is_utf8_xdigit(tmpbuf);
730 Perl_to_uni_upper(pTHX_ U32 c)
732 U8 tmpbuf[UTF8_MAXLEN+1];
733 uv_to_utf8(tmpbuf, (UV)c);
734 return to_utf8_upper(tmpbuf);
738 Perl_to_uni_title(pTHX_ U32 c)
740 U8 tmpbuf[UTF8_MAXLEN+1];
741 uv_to_utf8(tmpbuf, (UV)c);
742 return to_utf8_title(tmpbuf);
746 Perl_to_uni_lower(pTHX_ U32 c)
748 U8 tmpbuf[UTF8_MAXLEN+1];
749 uv_to_utf8(tmpbuf, (UV)c);
750 return to_utf8_lower(tmpbuf);
753 /* for now these all assume no locale info available for Unicode > 255 */
756 Perl_is_uni_alnum_lc(pTHX_ U32 c)
758 return is_uni_alnum(c); /* XXX no locale support yet */
762 Perl_is_uni_alnumc_lc(pTHX_ U32 c)
764 return is_uni_alnumc(c); /* XXX no locale support yet */
768 Perl_is_uni_idfirst_lc(pTHX_ U32 c)
770 return is_uni_idfirst(c); /* XXX no locale support yet */
774 Perl_is_uni_alpha_lc(pTHX_ U32 c)
776 return is_uni_alpha(c); /* XXX no locale support yet */
780 Perl_is_uni_ascii_lc(pTHX_ U32 c)
782 return is_uni_ascii(c); /* XXX no locale support yet */
786 Perl_is_uni_space_lc(pTHX_ U32 c)
788 return is_uni_space(c); /* XXX no locale support yet */
792 Perl_is_uni_digit_lc(pTHX_ U32 c)
794 return is_uni_digit(c); /* XXX no locale support yet */
798 Perl_is_uni_upper_lc(pTHX_ U32 c)
800 return is_uni_upper(c); /* XXX no locale support yet */
804 Perl_is_uni_lower_lc(pTHX_ U32 c)
806 return is_uni_lower(c); /* XXX no locale support yet */
810 Perl_is_uni_cntrl_lc(pTHX_ U32 c)
812 return is_uni_cntrl(c); /* XXX no locale support yet */
816 Perl_is_uni_graph_lc(pTHX_ U32 c)
818 return is_uni_graph(c); /* XXX no locale support yet */
822 Perl_is_uni_print_lc(pTHX_ U32 c)
824 return is_uni_print(c); /* XXX no locale support yet */
828 Perl_is_uni_punct_lc(pTHX_ U32 c)
830 return is_uni_punct(c); /* XXX no locale support yet */
834 Perl_is_uni_xdigit_lc(pTHX_ U32 c)
836 return is_uni_xdigit(c); /* XXX no locale support yet */
840 Perl_to_uni_upper_lc(pTHX_ U32 c)
842 return to_uni_upper(c); /* XXX no locale support yet */
846 Perl_to_uni_title_lc(pTHX_ U32 c)
848 return to_uni_title(c); /* XXX no locale support yet */
852 Perl_to_uni_lower_lc(pTHX_ U32 c)
854 return to_uni_lower(c); /* XXX no locale support yet */
858 Perl_is_utf8_alnum(pTHX_ U8 *p)
860 if (!is_utf8_char(p))
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 */
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);
878 Perl_is_utf8_alnumc(pTHX_ U8 *p)
880 if (!is_utf8_char(p))
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 */
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);
895 Perl_is_utf8_idfirst(pTHX_ U8 *p)
897 return *p == '_' || is_utf8_alpha(p);
901 Perl_is_utf8_alpha(pTHX_ U8 *p)
903 if (!is_utf8_char(p))
906 PL_utf8_alpha = swash_init("utf8", "IsAlpha", &PL_sv_undef, 0, 0);
907 return swash_fetch(PL_utf8_alpha, p);
911 Perl_is_utf8_ascii(pTHX_ U8 *p)
913 if (!is_utf8_char(p))
916 PL_utf8_ascii = swash_init("utf8", "IsAscii", &PL_sv_undef, 0, 0);
917 return swash_fetch(PL_utf8_ascii, p);
921 Perl_is_utf8_space(pTHX_ U8 *p)
923 if (!is_utf8_char(p))
926 PL_utf8_space = swash_init("utf8", "IsSpacePerl", &PL_sv_undef, 0, 0);
927 return swash_fetch(PL_utf8_space, p);
931 Perl_is_utf8_digit(pTHX_ U8 *p)
933 if (!is_utf8_char(p))
936 PL_utf8_digit = swash_init("utf8", "IsDigit", &PL_sv_undef, 0, 0);
937 return swash_fetch(PL_utf8_digit, p);
941 Perl_is_utf8_upper(pTHX_ U8 *p)
943 if (!is_utf8_char(p))
946 PL_utf8_upper = swash_init("utf8", "IsUpper", &PL_sv_undef, 0, 0);
947 return swash_fetch(PL_utf8_upper, p);
951 Perl_is_utf8_lower(pTHX_ U8 *p)
953 if (!is_utf8_char(p))
956 PL_utf8_lower = swash_init("utf8", "IsLower", &PL_sv_undef, 0, 0);
957 return swash_fetch(PL_utf8_lower, p);
961 Perl_is_utf8_cntrl(pTHX_ U8 *p)
963 if (!is_utf8_char(p))
966 PL_utf8_cntrl = swash_init("utf8", "IsCntrl", &PL_sv_undef, 0, 0);
967 return swash_fetch(PL_utf8_cntrl, p);
971 Perl_is_utf8_graph(pTHX_ U8 *p)
973 if (!is_utf8_char(p))
976 PL_utf8_graph = swash_init("utf8", "IsGraph", &PL_sv_undef, 0, 0);
977 return swash_fetch(PL_utf8_graph, p);
981 Perl_is_utf8_print(pTHX_ U8 *p)
983 if (!is_utf8_char(p))
986 PL_utf8_print = swash_init("utf8", "IsPrint", &PL_sv_undef, 0, 0);
987 return swash_fetch(PL_utf8_print, p);
991 Perl_is_utf8_punct(pTHX_ U8 *p)
993 if (!is_utf8_char(p))
996 PL_utf8_punct = swash_init("utf8", "IsPunct", &PL_sv_undef, 0, 0);
997 return swash_fetch(PL_utf8_punct, p);
1001 Perl_is_utf8_xdigit(pTHX_ U8 *p)
1003 if (!is_utf8_char(p))
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);
1011 Perl_is_utf8_mark(pTHX_ U8 *p)
1013 if (!is_utf8_char(p))
1016 PL_utf8_mark = swash_init("utf8", "IsM", &PL_sv_undef, 0, 0);
1017 return swash_fetch(PL_utf8_mark, p);
1021 Perl_to_utf8_upper(pTHX_ U8 *p)
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);
1032 Perl_to_utf8_title(pTHX_ U8 *p)
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);
1043 Perl_to_utf8_lower(pTHX_ U8 *p)
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);
1053 /* a "swash" is a swatch hash */
1056 Perl_swash_init(pTHX_ char* pkg, char* name, SV *listsv, I32 minbits, I32 none)
1062 if (!gv_stashpv(pkg, 0)) { /* demand load utf8 */
1064 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpv(pkg,0), Nullsv);
1068 PUSHSTACKi(PERLSI_MAGIC);
1071 PUSHs(sv_2mortal(newSVpvn(pkg, strlen(pkg))));
1072 PUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
1074 PUSHs(sv_2mortal(newSViv(minbits)));
1075 PUSHs(sv_2mortal(newSViv(none)));
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--);
1086 retval = &PL_sv_undef;
1089 if (PL_curcop == &PL_compiling) {
1090 strncpy(PL_tokenbuf, tmpbuf, sizeof tmpbuf);
1091 PL_curcop->op_private = PL_hints;
1093 if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV)
1094 Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
1099 Perl_swash_fetch(pTHX_ SV *sv, U8 *ptr)
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 */
1105 STRLEN needents = (klen ? 64 : 128);
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...
1116 * NB: this code assumes that swatches are never modified, once generated!
1119 if (hv == PL_last_swash_hv &&
1120 klen == PL_last_swash_klen &&
1121 (!klen || memEQ((char *)ptr,(char *)PL_last_swash_key,klen)) )
1123 tmps = PL_last_swash_tmps;
1124 slen = PL_last_swash_slen;
1127 /* Try our second-level swatch cache, kept in a hash. */
1128 SV** svp = hv_fetch(hv, (char*)ptr, klen, FALSE);
1130 /* If not cached, generate it via utf8::SWASHGET */
1131 if (!svp || !SvPOK(*svp) || !(tmps = (U8*)SvPV(*svp, slen))) {
1136 PUSHSTACKi(PERLSI_MAGIC);
1140 PUSHs(sv_2mortal(newSViv(utf8_to_uv(ptr, UTF8_MAXLEN, 0, 0) & ~(needents - 1))));
1141 PUSHs(sv_2mortal(newSViv(needents)));
1143 if (call_method("SWASHGET", G_SCALAR))
1144 retval = newSVsv(*PL_stack_sp--);
1146 retval = &PL_sv_undef;
1150 if (PL_curcop == &PL_compiling)
1151 PL_curcop->op_private = PL_hints;
1153 svp = hv_store(hv, (char*)ptr, klen, retval, 0);
1155 if (!svp || !(tmps = (U8*)SvPV(*svp, slen)) || slen < 8)
1156 Perl_croak(aTHX_ "SWASHGET didn't return result of proper length");
1159 PL_last_swash_hv = hv;
1160 PL_last_swash_klen = klen;
1161 PL_last_swash_tmps = tmps;
1162 PL_last_swash_slen = slen;
1164 Copy(ptr, PL_last_swash_key, klen, U8);
1167 switch ((int)((slen << 3) / needents)) {
1169 bit = 1 << (off & 7);
1171 return (tmps[off] & bit) != 0;
1176 return (tmps[off] << 8) + tmps[off + 1] ;
1179 return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
1181 Perl_croak(aTHX_ "panic: swash_fetch");