3 * Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
4 * by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'What a fix!' said Sam. 'That's the one place in all the lands we've ever
13 * heard of that we don't want to see any closer; and that's the one place
14 * we're trying to get to! And that's just where we can't get, nohow.'
16 * [p.603 of _The Lord of the Rings_, IV/I: "The Taming of Sméagol"]
18 * 'Well do I understand your speech,' he answered in the same language;
19 * 'yet few strangers do so. Why then do you not speak in the Common Tongue,
20 * as is the custom in the West, if you wish to be answered?'
21 * --Gandalf, addressing Théoden's door wardens
23 * [p.508 of _The Lord of the Rings_, III/vi: "The King of the Golden Hall"]
25 * ...the travellers perceived that the floor was paved with stones of many
26 * hues; branching runes and strange devices intertwined beneath their feet.
28 * [p.512 of _The Lord of the Rings_, III/vi: "The King of the Golden Hall"]
32 #define PERL_IN_UTF8_C
36 /* Separate prototypes needed because in ASCII systems these are
37 * usually macros but they still are compiled as code, too. */
38 PERL_CALLCONV UV Perl_utf8n_to_uvchr(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags);
39 PERL_CALLCONV U8* Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv);
42 static const char unees[] =
43 "Malformed UTF-8 character (unexpected end of string)";
46 =head1 Unicode Support
48 This file contains various utility functions for manipulating UTF8-encoded
49 strings. For the uninitiated, this is a method of representing arbitrary
50 Unicode characters as a variable number of bytes, in such a way that
51 characters in the ASCII range are unmodified, and a zero byte never appears
52 within non-zero characters.
58 =for apidoc is_ascii_string
60 Returns true if the first C<len> bytes of the given string are the same whether
61 or not the string is encoded in UTF-8 (or UTF-EBCDIC on EBCDIC machines). That
62 is, if they are invariant. On ASCII-ish machines, only ASCII characters
63 fit this definition, hence the function's name.
65 If C<len> is 0, it will be calculated using C<strlen(s)>.
67 See also is_utf8_string(), is_utf8_string_loclen(), and is_utf8_string_loc().
73 Perl_is_ascii_string(const U8 *s, STRLEN len)
75 const U8* const send = s + (len ? len : strlen((const char *)s));
78 PERL_ARGS_ASSERT_IS_ASCII_STRING;
80 for (; x < send; ++x) {
81 if (!UTF8_IS_INVARIANT(*x))
89 =for apidoc uvuni_to_utf8_flags
91 Adds the UTF-8 representation of the code point C<uv> to the end
92 of the string C<d>; C<d> should have at least C<UTF8_MAXBYTES+1> free
93 bytes available. The return value is the pointer to the byte after the
94 end of the new character. In other words,
96 d = uvuni_to_utf8_flags(d, uv, flags);
100 d = uvuni_to_utf8(d, uv);
102 (which is equivalent to)
104 d = uvuni_to_utf8_flags(d, uv, 0);
106 This is the recommended Unicode-aware way of saying
110 This function will convert to UTF-8 (and not warn) even code points that aren't
111 legal Unicode or are problematic, unless C<flags> contains one or more of the
113 If C<uv> is a Unicode surrogate code point and UNICODE_WARN_SURROGATE is set,
114 the function will raise a warning, provided UTF8 warnings are enabled. If instead
115 UNICODE_DISALLOW_SURROGATE is set, the function will fail and return NULL.
116 If both flags are set, the function will both warn and return NULL.
118 The UNICODE_WARN_NONCHAR and UNICODE_DISALLOW_NONCHAR flags correspondingly
119 affect how the function handles a Unicode non-character. And, likewise for the
120 UNICODE_WARN_SUPER and UNICODE_DISALLOW_SUPER flags, and code points that are
121 above the Unicode maximum of 0x10FFFF. Code points above 0x7FFF_FFFF (which are
122 even less portable) can be warned and/or disallowed even if other above-Unicode
123 code points are accepted by the UNICODE_WARN_FE_FF and UNICODE_DISALLOW_FE_FF
126 And finally, the flag UNICODE_WARN_ILLEGAL_INTERCHANGE selects all four of the
127 above WARN flags; and UNICODE_DISALLOW_ILLEGAL_INTERCHANGE selects all four
135 Perl_uvuni_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
137 PERL_ARGS_ASSERT_UVUNI_TO_UTF8_FLAGS;
139 if (ckWARN_d(WARN_UTF8)) {
140 if (UNICODE_IS_SURROGATE(uv)) {
141 if (flags & UNICODE_WARN_SURROGATE) {
142 Perl_ck_warner_d(aTHX_ packWARN(WARN_SURROGATE),
143 "UTF-16 surrogate U+%04"UVXf, uv);
145 if (flags & UNICODE_DISALLOW_SURROGATE) {
149 else if (UNICODE_IS_SUPER(uv)) {
150 if (flags & UNICODE_WARN_SUPER
151 || (UNICODE_IS_FE_FF(uv) && (flags & UNICODE_WARN_FE_FF)))
153 Perl_ck_warner_d(aTHX_ packWARN(WARN_NON_UNICODE),
154 "Code point 0x%04"UVXf" is not Unicode, may not be portable", uv);
156 if (flags & UNICODE_DISALLOW_SUPER
157 || (UNICODE_IS_FE_FF(uv) && (flags & UNICODE_DISALLOW_FE_FF)))
162 else if (UNICODE_IS_NONCHAR(uv)) {
163 if (flags & UNICODE_WARN_NONCHAR) {
164 Perl_ck_warner_d(aTHX_ packWARN(WARN_NONCHAR),
165 "Unicode non-character U+%04"UVXf" is illegal for open interchange",
168 if (flags & UNICODE_DISALLOW_NONCHAR) {
173 if (UNI_IS_INVARIANT(uv)) {
174 *d++ = (U8)UTF_TO_NATIVE(uv);
179 STRLEN len = UNISKIP(uv);
182 *p-- = (U8)UTF_TO_NATIVE((uv & UTF_CONTINUATION_MASK) | UTF_CONTINUATION_MARK);
183 uv >>= UTF_ACCUMULATION_SHIFT;
185 *p = (U8)UTF_TO_NATIVE((uv & UTF_START_MASK(len)) | UTF_START_MARK(len));
188 #else /* Non loop style */
190 *d++ = (U8)(( uv >> 6) | 0xc0);
191 *d++ = (U8)(( uv & 0x3f) | 0x80);
195 *d++ = (U8)(( uv >> 12) | 0xe0);
196 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
197 *d++ = (U8)(( uv & 0x3f) | 0x80);
201 *d++ = (U8)(( uv >> 18) | 0xf0);
202 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
203 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
204 *d++ = (U8)(( uv & 0x3f) | 0x80);
207 if (uv < 0x4000000) {
208 *d++ = (U8)(( uv >> 24) | 0xf8);
209 *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
210 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
211 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
212 *d++ = (U8)(( uv & 0x3f) | 0x80);
215 if (uv < 0x80000000) {
216 *d++ = (U8)(( uv >> 30) | 0xfc);
217 *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
218 *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
219 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
220 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
221 *d++ = (U8)(( uv & 0x3f) | 0x80);
225 if (uv < UTF8_QUAD_MAX)
228 *d++ = 0xfe; /* Can't match U+FEFF! */
229 *d++ = (U8)(((uv >> 30) & 0x3f) | 0x80);
230 *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
231 *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
232 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
233 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
234 *d++ = (U8)(( uv & 0x3f) | 0x80);
239 *d++ = 0xff; /* Can't match U+FFFE! */
240 *d++ = 0x80; /* 6 Reserved bits */
241 *d++ = (U8)(((uv >> 60) & 0x0f) | 0x80); /* 2 Reserved bits */
242 *d++ = (U8)(((uv >> 54) & 0x3f) | 0x80);
243 *d++ = (U8)(((uv >> 48) & 0x3f) | 0x80);
244 *d++ = (U8)(((uv >> 42) & 0x3f) | 0x80);
245 *d++ = (U8)(((uv >> 36) & 0x3f) | 0x80);
246 *d++ = (U8)(((uv >> 30) & 0x3f) | 0x80);
247 *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
248 *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
249 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
250 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
251 *d++ = (U8)(( uv & 0x3f) | 0x80);
255 #endif /* Loop style */
260 Tests if some arbitrary number of bytes begins in a valid UTF-8
261 character. Note that an INVARIANT (i.e. ASCII) character is a valid
262 UTF-8 character. The actual number of bytes in the UTF-8 character
263 will be returned if it is valid, otherwise 0.
265 This is the "slow" version as opposed to the "fast" version which is
266 the "unrolled" IS_UTF8_CHAR(). E.g. for t/uni/class.t the speed
267 difference is a factor of 2 to 3. For lengths (UTF8SKIP(s)) of four
268 or less you should use the IS_UTF8_CHAR(), for lengths of five or more
269 you should use the _slow(). In practice this means that the _slow()
270 will be used very rarely, since the maximum Unicode code point (as of
271 Unicode 4.1) is U+10FFFF, which encodes in UTF-8 to four bytes. Only
272 the "Perl extended UTF-8" (the infamous 'v-strings') will encode into
277 S_is_utf8_char_slow(const U8 *s, const STRLEN len)
283 PERL_ARGS_ASSERT_IS_UTF8_CHAR_SLOW;
285 if (UTF8_IS_INVARIANT(u))
288 if (!UTF8_IS_START(u))
291 if (len < 2 || !UTF8_IS_CONTINUATION(s[1]))
297 u = NATIVE_TO_UTF(u);
299 u &= UTF_START_MASK(len);
303 if (!UTF8_IS_CONTINUATION(*s))
305 uv = UTF8_ACCUMULATE(uv, *s);
312 if ((STRLEN)UNISKIP(uv) < len)
319 =for apidoc is_utf8_char
321 Tests if some arbitrary number of bytes begins in a valid UTF-8
322 character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
323 character is a valid UTF-8 character. The actual number of bytes in the UTF-8
324 character will be returned if it is valid, otherwise 0.
328 Perl_is_utf8_char(const U8 *s)
330 const STRLEN len = UTF8SKIP(s);
332 PERL_ARGS_ASSERT_IS_UTF8_CHAR;
334 if (IS_UTF8_CHAR_FAST(len))
335 return IS_UTF8_CHAR(s, len) ? len : 0;
336 #endif /* #ifdef IS_UTF8_CHAR */
337 return is_utf8_char_slow(s, len);
342 =for apidoc is_utf8_string
344 Returns true if first C<len> bytes of the given string form a valid
345 UTF-8 string, false otherwise. If C<len> is 0, it will be calculated
346 using C<strlen(s)>. Note that 'a valid UTF-8 string' does not mean 'a
347 string that contains code points above 0x7F encoded in UTF-8' because a
348 valid ASCII string is a valid UTF-8 string.
350 See also is_ascii_string(), is_utf8_string_loclen(), and is_utf8_string_loc().
356 Perl_is_utf8_string(const U8 *s, STRLEN len)
358 const U8* const send = s + (len ? len : strlen((const char *)s));
361 PERL_ARGS_ASSERT_IS_UTF8_STRING;
365 /* Inline the easy bits of is_utf8_char() here for speed... */
366 if (UTF8_IS_INVARIANT(*x))
368 else if (!UTF8_IS_START(*x))
371 /* ... and call is_utf8_char() only if really needed. */
374 if (IS_UTF8_CHAR_FAST(c)) {
375 if (!IS_UTF8_CHAR(x, c))
379 c = is_utf8_char_slow(x, c);
382 #endif /* #ifdef IS_UTF8_CHAR */
397 Implemented as a macro in utf8.h
399 =for apidoc is_utf8_string_loc
401 Like is_utf8_string() but stores the location of the failure (in the
402 case of "utf8ness failure") or the location s+len (in the case of
403 "utf8ness success") in the C<ep>.
405 See also is_utf8_string_loclen() and is_utf8_string().
407 =for apidoc is_utf8_string_loclen
409 Like is_utf8_string() but stores the location of the failure (in the
410 case of "utf8ness failure") or the location s+len (in the case of
411 "utf8ness success") in the C<ep>, and the number of UTF-8
412 encoded characters in the C<el>.
414 See also is_utf8_string_loc() and is_utf8_string().
420 Perl_is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
422 const U8* const send = s + (len ? len : strlen((const char *)s));
427 PERL_ARGS_ASSERT_IS_UTF8_STRING_LOCLEN;
430 /* Inline the easy bits of is_utf8_char() here for speed... */
431 if (UTF8_IS_INVARIANT(*x))
433 else if (!UTF8_IS_START(*x))
436 /* ... and call is_utf8_char() only if really needed. */
439 if (IS_UTF8_CHAR_FAST(c)) {
440 if (!IS_UTF8_CHAR(x, c))
443 c = is_utf8_char_slow(x, c);
446 #endif /* #ifdef IS_UTF8_CHAR */
465 =for apidoc utf8n_to_uvuni
467 Bottom level UTF-8 decode routine.
468 Returns the code point value of the first character in the string C<s>
469 which is assumed to be in UTF-8 (or UTF-EBCDIC) encoding and no longer than
470 C<curlen> bytes; C<retlen> will be set to the length, in bytes, of that
473 The value of C<flags> determines the behavior when C<s> does not point to a
474 well-formed UTF-8 character. If C<flags> is 0, when a malformation is found,
475 C<retlen> is set to the expected length of the UTF-8 character in bytes, zero
476 is returned, and if UTF-8 warnings haven't been lexically disabled, a warning
479 Various ALLOW flags can be set in C<flags> to allow (and not warn on)
480 individual types of malformations, such as the sequence being overlong (that
481 is, when there is a shorter sequence that can express the same code point;
482 overlong sequences are expressly forbidden in the UTF-8 standard due to
483 potential security issues). Another malformation example is the first byte of
484 a character not being a legal first byte. See F<utf8.h> for the list of such
485 flags. Of course, the value returned by this function under such conditions is
488 The UTF8_CHECK_ONLY flag overrides the behavior when a non-allowed (by other
489 flags) malformation is found. If this flag is set, the routine assumes that
490 the caller will raise a warning, and this function will silently just set
491 C<retlen> to C<-1> and return zero.
493 Certain code points are considered problematic. These are Unicode surrogates,
494 Unicode non-characters, and code points above the Unicode maximum of 0x10FFF.
495 By default these are considered regular code points, but certain situations
496 warrant special handling for them. if C<flags> contains
497 UTF8_DISALLOW_ILLEGAL_INTERCHANGE, all three classes are treated as
498 malformations and handled as such. The flags UTF8_DISALLOW_SURROGATE,
499 UTF8_DISALLOW_NONCHAR, and UTF8_DISALLOW_SUPER (meaning above the legal Unicode
500 maximum) can be set to disallow these categories individually.
502 The flags UTF8_WARN_ILLEGAL_INTERCHANGE, UTF8_WARN_SURROGATE,
503 UTF8_WARN_NONCHAR, and UTF8_WARN_SUPER will cause warning messages to be raised
504 for their respective categories, but otherwise the code points are considered
505 valid (not malformations). To get a category to both be treated as a
506 malformation and raise a warning, specify both the WARN and DISALLOW flags.
507 (But note that warnings are not raised if lexically disabled nor if
508 UTF8_CHECK_ONLY is also specified.)
510 Very large code points (above 0x7FFF_FFFF) are considered more problematic than
511 the others that are above the Unicode legal maximum. There are several
512 reasons, one of which is that the original UTF-8 specification never went above
513 this number (the current 0x10FFF limit was imposed later). The UTF-8 encoding
514 on ASCII platforms for these large code point begins with a byte containing
515 0xFE or 0xFF. The UTF8_DISALLOW_FE_FF flag will cause them to be treated as
516 malformations, while allowing smaller above-Unicode code points. (Of course
517 UTF8_DISALLOW_SUPER will treat all above-Unicode code points, including these,
518 as malformations.) Similarly, UTF8_WARN_FE_FF acts just like the other WARN
519 flags, but applies just to these code points.
521 All other code points corresponding to Unicode characters, including private
522 use and those yet to be assigned, are never considered malformed and never
525 Most code should use utf8_to_uvchr() rather than call this directly.
531 Perl_utf8n_to_uvuni(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
534 const U8 * const s0 = s;
537 bool dowarn = ckWARN_d(WARN_UTF8);
538 const UV startbyte = *s;
539 STRLEN expectlen = 0;
543 PERL_ARGS_ASSERT_UTF8N_TO_UVUNI;
545 /* This list is a superset of the UTF8_ALLOW_XXX. */
547 #define UTF8_WARN_EMPTY 1
548 #define UTF8_WARN_CONTINUATION 2
549 #define UTF8_WARN_NON_CONTINUATION 3
550 #define UTF8_WARN_SHORT 4
551 #define UTF8_WARN_OVERFLOW 5
552 #define UTF8_WARN_LONG 6
555 !(flags & UTF8_ALLOW_EMPTY)) {
556 warning = UTF8_WARN_EMPTY;
560 if (UTF8_IS_INVARIANT(uv)) {
563 return (UV) (NATIVE_TO_UTF(*s));
566 if (UTF8_IS_CONTINUATION(uv) &&
567 !(flags & UTF8_ALLOW_CONTINUATION)) {
568 warning = UTF8_WARN_CONTINUATION;
572 if (UTF8_IS_START(uv) && curlen > 1 && !UTF8_IS_CONTINUATION(s[1]) &&
573 !(flags & UTF8_ALLOW_NON_CONTINUATION)) {
574 warning = UTF8_WARN_NON_CONTINUATION;
579 uv = NATIVE_TO_UTF(uv);
581 if (uv == 0xfe || uv == 0xff) {
582 if (flags & (UTF8_WARN_SUPER|UTF8_WARN_FE_FF)) {
583 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "Code point beginning with byte 0x%02"UVXf" is not Unicode, and not portable", uv));
584 flags &= ~UTF8_WARN_SUPER; /* Only warn once on this problem */
586 if (flags & (UTF8_DISALLOW_SUPER|UTF8_DISALLOW_FE_FF)) {
592 if (!(uv & 0x20)) { len = 2; uv &= 0x1f; }
593 else if (!(uv & 0x10)) { len = 3; uv &= 0x0f; }
594 else if (!(uv & 0x08)) { len = 4; uv &= 0x07; }
595 else if (!(uv & 0x04)) { len = 5; uv &= 0x03; }
597 else if (!(uv & 0x02)) { len = 6; uv &= 0x01; }
598 else { len = 7; uv &= 0x01; }
600 else if (!(uv & 0x02)) { len = 6; uv &= 0x01; }
601 else if (!(uv & 0x01)) { len = 7; uv = 0; }
602 else { len = 13; uv = 0; } /* whoa! */
610 if ((curlen < expectlen) &&
611 !(flags & UTF8_ALLOW_SHORT)) {
612 warning = UTF8_WARN_SHORT;
618 ouv = uv; /* ouv is the value from the previous iteration */
621 if (!UTF8_IS_CONTINUATION(*s) &&
622 !(flags & UTF8_ALLOW_NON_CONTINUATION)) {
624 warning = UTF8_WARN_NON_CONTINUATION;
628 uv = UTF8_ACCUMULATE(uv, *s);
629 if (!(uv > ouv)) { /* If the value didn't grow from the previous
630 iteration, something is horribly wrong */
631 /* These cannot be allowed. */
633 if (expectlen != 13 && !(flags & UTF8_ALLOW_LONG)) {
634 warning = UTF8_WARN_LONG;
638 else { /* uv < ouv */
639 /* This cannot be allowed. */
640 warning = UTF8_WARN_OVERFLOW;
648 if ((expectlen > (STRLEN)UNISKIP(uv)) && !(flags & UTF8_ALLOW_LONG)) {
649 warning = UTF8_WARN_LONG;
651 } else if (flags & (UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE)) {
652 if (UNICODE_IS_SURROGATE(uv)) {
653 if ((flags & (UTF8_WARN_SURROGATE|UTF8_CHECK_ONLY)) == UTF8_WARN_SURROGATE) {
654 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "UTF-16 surrogate U+%04"UVXf"", uv));
656 if (flags & UTF8_DISALLOW_SURROGATE) {
660 else if (UNICODE_IS_NONCHAR(uv)) {
661 if ((flags & (UTF8_WARN_NONCHAR|UTF8_CHECK_ONLY)) == UTF8_WARN_NONCHAR ) {
662 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "Unicode non-character U+%04"UVXf" is illegal for open interchange", uv));
664 if (flags & UTF8_DISALLOW_NONCHAR) {
668 else if ((uv > PERL_UNICODE_MAX)) {
669 if ((flags & (UTF8_WARN_SUPER|UTF8_CHECK_ONLY)) == UTF8_WARN_SUPER) {
670 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "Code point 0x%04"UVXf" is not Unicode, may not be portable", uv));
672 if (flags & UTF8_DISALLOW_SUPER) {
677 /* Here, this is not considered a malformed character, so drop through
683 disallowed: /* Is disallowed, but otherwise not malformed. 'sv' will have been
684 set if there is to be a warning. */
691 if (flags & UTF8_CHECK_ONLY) {
693 *retlen = ((STRLEN) -1);
699 sv = newSVpvs_flags("Malformed UTF-8 character ", SVs_TEMP);
703 case 0: /* Intentionally empty. */ break;
704 case UTF8_WARN_EMPTY:
705 sv_catpvs(sv, "(empty string)");
707 case UTF8_WARN_CONTINUATION:
708 Perl_sv_catpvf(aTHX_ sv, "(unexpected continuation byte 0x%02"UVxf", with no preceding start byte)", uv);
710 case UTF8_WARN_NON_CONTINUATION:
712 Perl_sv_catpvf(aTHX_ sv, "(unexpected non-continuation byte 0x%02"UVxf", immediately after start byte 0x%02"UVxf")",
713 (UV)s[1], startbyte);
715 const int len = (int)(s-s0);
716 Perl_sv_catpvf(aTHX_ sv, "(unexpected non-continuation byte 0x%02"UVxf", %d byte%s after start byte 0x%02"UVxf", expected %d bytes)",
717 (UV)s[1], len, len > 1 ? "s" : "", startbyte, (int)expectlen);
721 case UTF8_WARN_SHORT:
722 Perl_sv_catpvf(aTHX_ sv, "(%d byte%s, need %d, after start byte 0x%02"UVxf")",
723 (int)curlen, curlen == 1 ? "" : "s", (int)expectlen, startbyte);
724 expectlen = curlen; /* distance for caller to skip */
726 case UTF8_WARN_OVERFLOW:
727 Perl_sv_catpvf(aTHX_ sv, "(overflow at 0x%"UVxf", byte 0x%02x, after start byte 0x%02"UVxf")",
731 Perl_sv_catpvf(aTHX_ sv, "(%d byte%s, need %d, after start byte 0x%02"UVxf")",
732 (int)expectlen, expectlen == 1 ? "": "s", UNISKIP(uv), startbyte);
735 sv_catpvs(sv, "(unknown reason)");
740 const char * const s = SvPVX_const(sv);
743 Perl_warner(aTHX_ packWARN(WARN_UTF8),
744 "%s in %s", s, OP_DESC(PL_op));
746 Perl_warner(aTHX_ packWARN(WARN_UTF8), "%s", s);
751 *retlen = expectlen ? expectlen : len;
757 =for apidoc utf8_to_uvchr
759 Returns the native code point of the first character in the string C<s>
760 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
761 length, in bytes, of that character.
763 If C<s> does not point to a well-formed UTF-8 character, zero is
764 returned and retlen is set, if possible, to -1.
771 Perl_utf8_to_uvchr(pTHX_ const U8 *s, STRLEN *retlen)
773 PERL_ARGS_ASSERT_UTF8_TO_UVCHR;
775 return utf8n_to_uvchr(s, UTF8_MAXBYTES, retlen,
776 ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY);
780 =for apidoc utf8_to_uvuni
782 Returns the Unicode code point of the first character in the string C<s>
783 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
784 length, in bytes, of that character.
786 This function should only be used when the returned UV is considered
787 an index into the Unicode semantic tables (e.g. swashes).
789 If C<s> does not point to a well-formed UTF-8 character, zero is
790 returned and retlen is set, if possible, to -1.
796 Perl_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
798 PERL_ARGS_ASSERT_UTF8_TO_UVUNI;
800 /* Call the low level routine asking for checks */
801 return Perl_utf8n_to_uvuni(aTHX_ s, UTF8_MAXBYTES, retlen,
802 ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY);
806 =for apidoc utf8_length
808 Return the length of the UTF-8 char encoded string C<s> in characters.
809 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
810 up past C<e>, croaks.
816 Perl_utf8_length(pTHX_ const U8 *s, const U8 *e)
821 PERL_ARGS_ASSERT_UTF8_LENGTH;
823 /* Note: cannot use UTF8_IS_...() too eagerly here since e.g.
824 * the bitops (especially ~) can create illegal UTF-8.
825 * In other words: in Perl UTF-8 is not just for Unicode. */
828 goto warn_and_return;
830 if (!UTF8_IS_INVARIANT(*s))
841 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
842 "%s in %s", unees, OP_DESC(PL_op));
844 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8), "%s", unees);
851 =for apidoc utf8_distance
853 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
856 WARNING: use only if you *know* that the pointers point inside the
863 Perl_utf8_distance(pTHX_ const U8 *a, const U8 *b)
865 PERL_ARGS_ASSERT_UTF8_DISTANCE;
867 return (a < b) ? -1 * (IV) utf8_length(a, b) : (IV) utf8_length(b, a);
873 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
876 WARNING: do not use the following unless you *know* C<off> is within
877 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
878 on the first byte of character or just after the last byte of a character.
884 Perl_utf8_hop(pTHX_ const U8 *s, I32 off)
886 PERL_ARGS_ASSERT_UTF8_HOP;
889 /* Note: cannot use UTF8_IS_...() too eagerly here since e.g
890 * the bitops (especially ~) can create illegal UTF-8.
891 * In other words: in Perl UTF-8 is not just for Unicode. */
900 while (UTF8_IS_CONTINUATION(*s))
908 =for apidoc bytes_cmp_utf8
910 Compares the sequence of characters (stored as octets) in b, blen with the
911 sequence of characters (stored as UTF-8) in u, ulen. Returns 0 if they are
912 equal, -1 or -2 if the first string is less than the second string, +1 or +2
913 if the first string is greater than the second string.
915 -1 or +1 is returned if the shorter string was identical to the start of the
916 longer string. -2 or +2 is returned if the was a difference between characters
923 Perl_bytes_cmp_utf8(pTHX_ const U8 *b, STRLEN blen, const U8 *u, STRLEN ulen)
925 const U8 *const bend = b + blen;
926 const U8 *const uend = u + ulen;
928 PERL_ARGS_ASSERT_BYTES_CMP_UTF8;
932 while (b < bend && u < uend) {
934 if (!UTF8_IS_INVARIANT(c)) {
935 if (UTF8_IS_DOWNGRADEABLE_START(c)) {
938 if (UTF8_IS_CONTINUATION(c1)) {
939 c = UNI_TO_NATIVE(TWO_BYTE_UTF8_TO_UNI(c, c1));
941 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
942 "Malformed UTF-8 character "
943 "(unexpected non-continuation byte 0x%02x"
944 ", immediately after start byte 0x%02x)"
945 /* Dear diag.t, it's in the pod. */
948 PL_op ? OP_DESC(PL_op) : "");
953 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
954 "%s in %s", unees, OP_DESC(PL_op));
956 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8), "%s", unees);
957 return -2; /* Really want to return undef :-) */
964 return *b < c ? -2 : +2;
969 if (b == bend && u == uend)
972 return b < bend ? +1 : -1;
976 =for apidoc utf8_to_bytes
978 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
979 Unlike C<bytes_to_utf8>, this over-writes the original string, and
980 updates len to contain the new length.
981 Returns zero on failure, setting C<len> to -1.
983 If you need a copy of the string, see C<bytes_from_utf8>.
989 Perl_utf8_to_bytes(pTHX_ U8 *s, STRLEN *len)
992 U8 * const send = s + *len;
995 PERL_ARGS_ASSERT_UTF8_TO_BYTES;
997 /* ensure valid UTF-8 and chars < 256 before updating string */
1001 if (!UTF8_IS_INVARIANT(c) &&
1002 (!UTF8_IS_DOWNGRADEABLE_START(c) || (s >= send)
1003 || !(c = *s++) || !UTF8_IS_CONTINUATION(c))) {
1004 *len = ((STRLEN) -1);
1012 *d++ = (U8)utf8_to_uvchr(s, &ulen);
1021 =for apidoc bytes_from_utf8
1023 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
1024 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
1025 the newly-created string, and updates C<len> to contain the new
1026 length. Returns the original string if no conversion occurs, C<len>
1027 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
1028 0 if C<s> is converted or consisted entirely of characters that are invariant
1029 in utf8 (i.e., US-ASCII on non-EBCDIC machines).
1035 Perl_bytes_from_utf8(pTHX_ const U8 *s, STRLEN *len, bool *is_utf8)
1038 const U8 *start = s;
1042 PERL_ARGS_ASSERT_BYTES_FROM_UTF8;
1044 PERL_UNUSED_CONTEXT;
1048 /* ensure valid UTF-8 and chars < 256 before converting string */
1049 for (send = s + *len; s < send;) {
1051 if (!UTF8_IS_INVARIANT(c)) {
1052 if (UTF8_IS_DOWNGRADEABLE_START(c) && s < send &&
1053 (c = *s++) && UTF8_IS_CONTINUATION(c))
1062 Newx(d, (*len) - count + 1, U8);
1063 s = start; start = d;
1066 if (!UTF8_IS_INVARIANT(c)) {
1067 /* Then it is two-byte encoded */
1068 c = UNI_TO_NATIVE(TWO_BYTE_UTF8_TO_UNI(c, *s++));
1078 =for apidoc bytes_to_utf8
1080 Converts a string C<s> of length C<len> bytes from the native encoding into
1082 Returns a pointer to the newly-created string, and sets C<len> to
1083 reflect the new length in bytes.
1085 A NUL character will be written after the end of the string.
1087 If you want to convert to UTF-8 from encodings other than
1088 the native (Latin1 or EBCDIC),
1089 see sv_recode_to_utf8().
1095 Perl_bytes_to_utf8(pTHX_ const U8 *s, STRLEN *len)
1097 const U8 * const send = s + (*len);
1101 PERL_ARGS_ASSERT_BYTES_TO_UTF8;
1102 PERL_UNUSED_CONTEXT;
1104 Newx(d, (*len) * 2 + 1, U8);
1108 const UV uv = NATIVE_TO_ASCII(*s++);
1109 if (UNI_IS_INVARIANT(uv))
1110 *d++ = (U8)UTF_TO_NATIVE(uv);
1112 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
1113 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
1122 * Convert native (big-endian) or reversed (little-endian) UTF-16 to UTF-8.
1124 * Destination must be pre-extended to 3/2 source. Do not use in-place.
1125 * We optimize for native, for obvious reasons. */
1128 Perl_utf16_to_utf8(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
1133 PERL_ARGS_ASSERT_UTF16_TO_UTF8;
1136 Perl_croak(aTHX_ "panic: utf16_to_utf8: odd bytelen %"UVuf, (UV)bytelen);
1141 UV uv = (p[0] << 8) + p[1]; /* UTF-16BE */
1145 *d++ = UNI_TO_NATIVE(uv);
1152 *d++ = (U8)(( uv >> 6) | 0xc0);
1153 *d++ = (U8)(( uv & 0x3f) | 0x80);
1156 if (uv >= 0xd800 && uv <= 0xdbff) { /* surrogates */
1158 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
1160 UV low = (p[0] << 8) + p[1];
1162 if (low < 0xdc00 || low > 0xdfff)
1163 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
1164 uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
1166 } else if (uv >= 0xdc00 && uv <= 0xdfff) {
1167 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
1170 *d++ = (U8)(( uv >> 12) | 0xe0);
1171 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
1172 *d++ = (U8)(( uv & 0x3f) | 0x80);
1176 *d++ = (U8)(( uv >> 18) | 0xf0);
1177 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
1178 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
1179 *d++ = (U8)(( uv & 0x3f) | 0x80);
1183 *newlen = d - dstart;
1187 /* Note: this one is slightly destructive of the source. */
1190 Perl_utf16_to_utf8_reversed(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
1193 U8* const send = s + bytelen;
1195 PERL_ARGS_ASSERT_UTF16_TO_UTF8_REVERSED;
1198 Perl_croak(aTHX_ "panic: utf16_to_utf8_reversed: odd bytelen %"UVuf,
1202 const U8 tmp = s[0];
1207 return utf16_to_utf8(p, d, bytelen, newlen);
1210 /* for now these are all defined (inefficiently) in terms of the utf8 versions */
1213 Perl_is_uni_alnum(pTHX_ UV c)
1215 U8 tmpbuf[UTF8_MAXBYTES+1];
1216 uvchr_to_utf8(tmpbuf, c);
1217 return is_utf8_alnum(tmpbuf);
1221 Perl_is_uni_idfirst(pTHX_ UV c)
1223 U8 tmpbuf[UTF8_MAXBYTES+1];
1224 uvchr_to_utf8(tmpbuf, c);
1225 return is_utf8_idfirst(tmpbuf);
1229 Perl_is_uni_alpha(pTHX_ UV c)
1231 U8 tmpbuf[UTF8_MAXBYTES+1];
1232 uvchr_to_utf8(tmpbuf, c);
1233 return is_utf8_alpha(tmpbuf);
1237 Perl_is_uni_ascii(pTHX_ UV c)
1239 U8 tmpbuf[UTF8_MAXBYTES+1];
1240 uvchr_to_utf8(tmpbuf, c);
1241 return is_utf8_ascii(tmpbuf);
1245 Perl_is_uni_space(pTHX_ UV c)
1247 U8 tmpbuf[UTF8_MAXBYTES+1];
1248 uvchr_to_utf8(tmpbuf, c);
1249 return is_utf8_space(tmpbuf);
1253 Perl_is_uni_digit(pTHX_ UV c)
1255 U8 tmpbuf[UTF8_MAXBYTES+1];
1256 uvchr_to_utf8(tmpbuf, c);
1257 return is_utf8_digit(tmpbuf);
1261 Perl_is_uni_upper(pTHX_ UV c)
1263 U8 tmpbuf[UTF8_MAXBYTES+1];
1264 uvchr_to_utf8(tmpbuf, c);
1265 return is_utf8_upper(tmpbuf);
1269 Perl_is_uni_lower(pTHX_ UV c)
1271 U8 tmpbuf[UTF8_MAXBYTES+1];
1272 uvchr_to_utf8(tmpbuf, c);
1273 return is_utf8_lower(tmpbuf);
1277 Perl_is_uni_cntrl(pTHX_ UV c)
1279 U8 tmpbuf[UTF8_MAXBYTES+1];
1280 uvchr_to_utf8(tmpbuf, c);
1281 return is_utf8_cntrl(tmpbuf);
1285 Perl_is_uni_graph(pTHX_ UV c)
1287 U8 tmpbuf[UTF8_MAXBYTES+1];
1288 uvchr_to_utf8(tmpbuf, c);
1289 return is_utf8_graph(tmpbuf);
1293 Perl_is_uni_print(pTHX_ UV c)
1295 U8 tmpbuf[UTF8_MAXBYTES+1];
1296 uvchr_to_utf8(tmpbuf, c);
1297 return is_utf8_print(tmpbuf);
1301 Perl_is_uni_punct(pTHX_ UV c)
1303 U8 tmpbuf[UTF8_MAXBYTES+1];
1304 uvchr_to_utf8(tmpbuf, c);
1305 return is_utf8_punct(tmpbuf);
1309 Perl_is_uni_xdigit(pTHX_ UV c)
1311 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1312 uvchr_to_utf8(tmpbuf, c);
1313 return is_utf8_xdigit(tmpbuf);
1317 Perl_to_uni_upper(pTHX_ UV c, U8* p, STRLEN *lenp)
1319 PERL_ARGS_ASSERT_TO_UNI_UPPER;
1321 uvchr_to_utf8(p, c);
1322 return to_utf8_upper(p, p, lenp);
1326 Perl_to_uni_title(pTHX_ UV c, U8* p, STRLEN *lenp)
1328 PERL_ARGS_ASSERT_TO_UNI_TITLE;
1330 uvchr_to_utf8(p, c);
1331 return to_utf8_title(p, p, lenp);
1335 Perl_to_uni_lower(pTHX_ UV c, U8* p, STRLEN *lenp)
1337 PERL_ARGS_ASSERT_TO_UNI_LOWER;
1339 uvchr_to_utf8(p, c);
1340 return to_utf8_lower(p, p, lenp);
1344 Perl__to_uni_fold_flags(pTHX_ UV c, U8* p, STRLEN *lenp, U8 flags)
1346 PERL_ARGS_ASSERT__TO_UNI_FOLD_FLAGS;
1348 uvchr_to_utf8(p, c);
1349 return _to_utf8_fold_flags(p, p, lenp, flags);
1352 /* for now these all assume no locale info available for Unicode > 255 */
1355 Perl_is_uni_alnum_lc(pTHX_ UV c)
1357 return is_uni_alnum(c); /* XXX no locale support yet */
1361 Perl_is_uni_idfirst_lc(pTHX_ UV c)
1363 return is_uni_idfirst(c); /* XXX no locale support yet */
1367 Perl_is_uni_alpha_lc(pTHX_ UV c)
1369 return is_uni_alpha(c); /* XXX no locale support yet */
1373 Perl_is_uni_ascii_lc(pTHX_ UV c)
1375 return is_uni_ascii(c); /* XXX no locale support yet */
1379 Perl_is_uni_space_lc(pTHX_ UV c)
1381 return is_uni_space(c); /* XXX no locale support yet */
1385 Perl_is_uni_digit_lc(pTHX_ UV c)
1387 return is_uni_digit(c); /* XXX no locale support yet */
1391 Perl_is_uni_upper_lc(pTHX_ UV c)
1393 return is_uni_upper(c); /* XXX no locale support yet */
1397 Perl_is_uni_lower_lc(pTHX_ UV c)
1399 return is_uni_lower(c); /* XXX no locale support yet */
1403 Perl_is_uni_cntrl_lc(pTHX_ UV c)
1405 return is_uni_cntrl(c); /* XXX no locale support yet */
1409 Perl_is_uni_graph_lc(pTHX_ UV c)
1411 return is_uni_graph(c); /* XXX no locale support yet */
1415 Perl_is_uni_print_lc(pTHX_ UV c)
1417 return is_uni_print(c); /* XXX no locale support yet */
1421 Perl_is_uni_punct_lc(pTHX_ UV c)
1423 return is_uni_punct(c); /* XXX no locale support yet */
1427 Perl_is_uni_xdigit_lc(pTHX_ UV c)
1429 return is_uni_xdigit(c); /* XXX no locale support yet */
1433 Perl_to_uni_upper_lc(pTHX_ U32 c)
1435 /* XXX returns only the first character -- do not use XXX */
1436 /* XXX no locale support yet */
1438 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1439 return (U32)to_uni_upper(c, tmpbuf, &len);
1443 Perl_to_uni_title_lc(pTHX_ U32 c)
1445 /* XXX returns only the first character XXX -- do not use XXX */
1446 /* XXX no locale support yet */
1448 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1449 return (U32)to_uni_title(c, tmpbuf, &len);
1453 Perl_to_uni_lower_lc(pTHX_ U32 c)
1455 /* XXX returns only the first character -- do not use XXX */
1456 /* XXX no locale support yet */
1458 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1459 return (U32)to_uni_lower(c, tmpbuf, &len);
1463 S_is_utf8_common(pTHX_ const U8 *const p, SV **swash,
1464 const char *const swashname)
1468 PERL_ARGS_ASSERT_IS_UTF8_COMMON;
1470 if (!is_utf8_char(p))
1473 *swash = swash_init("utf8", swashname, &PL_sv_undef, 1, 0);
1474 return swash_fetch(*swash, p, TRUE) != 0;
1478 Perl_is_utf8_alnum(pTHX_ const U8 *p)
1482 PERL_ARGS_ASSERT_IS_UTF8_ALNUM;
1484 /* NOTE: "IsWord", not "IsAlnum", since Alnum is a true
1485 * descendant of isalnum(3), in other words, it doesn't
1486 * contain the '_'. --jhi */
1487 return is_utf8_common(p, &PL_utf8_alnum, "IsWord");
1491 Perl_is_utf8_idfirst(pTHX_ const U8 *p) /* The naming is historical. */
1495 PERL_ARGS_ASSERT_IS_UTF8_IDFIRST;
1499 /* is_utf8_idstart would be more logical. */
1500 return is_utf8_common(p, &PL_utf8_idstart, "IdStart");
1504 Perl_is_utf8_xidfirst(pTHX_ const U8 *p) /* The naming is historical. */
1508 PERL_ARGS_ASSERT_IS_UTF8_XIDFIRST;
1512 /* is_utf8_idstart would be more logical. */
1513 return is_utf8_common(p, &PL_utf8_xidstart, "XIdStart");
1517 Perl_is_utf8_idcont(pTHX_ const U8 *p)
1521 PERL_ARGS_ASSERT_IS_UTF8_IDCONT;
1525 return is_utf8_common(p, &PL_utf8_idcont, "IdContinue");
1529 Perl_is_utf8_xidcont(pTHX_ const U8 *p)
1533 PERL_ARGS_ASSERT_IS_UTF8_XIDCONT;
1537 return is_utf8_common(p, &PL_utf8_idcont, "XIdContinue");
1541 Perl_is_utf8_alpha(pTHX_ const U8 *p)
1545 PERL_ARGS_ASSERT_IS_UTF8_ALPHA;
1547 return is_utf8_common(p, &PL_utf8_alpha, "IsAlpha");
1551 Perl_is_utf8_ascii(pTHX_ const U8 *p)
1555 PERL_ARGS_ASSERT_IS_UTF8_ASCII;
1557 return is_utf8_common(p, &PL_utf8_ascii, "IsAscii");
1561 Perl_is_utf8_space(pTHX_ const U8 *p)
1565 PERL_ARGS_ASSERT_IS_UTF8_SPACE;
1567 return is_utf8_common(p, &PL_utf8_space, "IsSpacePerl");
1571 Perl_is_utf8_perl_space(pTHX_ const U8 *p)
1575 PERL_ARGS_ASSERT_IS_UTF8_PERL_SPACE;
1577 return is_utf8_common(p, &PL_utf8_perl_space, "IsPerlSpace");
1581 Perl_is_utf8_perl_word(pTHX_ const U8 *p)
1585 PERL_ARGS_ASSERT_IS_UTF8_PERL_WORD;
1587 return is_utf8_common(p, &PL_utf8_perl_word, "IsPerlWord");
1591 Perl_is_utf8_digit(pTHX_ const U8 *p)
1595 PERL_ARGS_ASSERT_IS_UTF8_DIGIT;
1597 return is_utf8_common(p, &PL_utf8_digit, "IsDigit");
1601 Perl_is_utf8_posix_digit(pTHX_ const U8 *p)
1605 PERL_ARGS_ASSERT_IS_UTF8_POSIX_DIGIT;
1607 return is_utf8_common(p, &PL_utf8_posix_digit, "IsPosixDigit");
1611 Perl_is_utf8_upper(pTHX_ const U8 *p)
1615 PERL_ARGS_ASSERT_IS_UTF8_UPPER;
1617 return is_utf8_common(p, &PL_utf8_upper, "IsUppercase");
1621 Perl_is_utf8_lower(pTHX_ const U8 *p)
1625 PERL_ARGS_ASSERT_IS_UTF8_LOWER;
1627 return is_utf8_common(p, &PL_utf8_lower, "IsLowercase");
1631 Perl_is_utf8_cntrl(pTHX_ const U8 *p)
1635 PERL_ARGS_ASSERT_IS_UTF8_CNTRL;
1637 return is_utf8_common(p, &PL_utf8_cntrl, "IsCntrl");
1641 Perl_is_utf8_graph(pTHX_ const U8 *p)
1645 PERL_ARGS_ASSERT_IS_UTF8_GRAPH;
1647 return is_utf8_common(p, &PL_utf8_graph, "IsGraph");
1651 Perl_is_utf8_print(pTHX_ const U8 *p)
1655 PERL_ARGS_ASSERT_IS_UTF8_PRINT;
1657 return is_utf8_common(p, &PL_utf8_print, "IsPrint");
1661 Perl_is_utf8_punct(pTHX_ const U8 *p)
1665 PERL_ARGS_ASSERT_IS_UTF8_PUNCT;
1667 return is_utf8_common(p, &PL_utf8_punct, "IsPunct");
1671 Perl_is_utf8_xdigit(pTHX_ const U8 *p)
1675 PERL_ARGS_ASSERT_IS_UTF8_XDIGIT;
1677 return is_utf8_common(p, &PL_utf8_xdigit, "IsXDigit");
1681 Perl_is_utf8_mark(pTHX_ const U8 *p)
1685 PERL_ARGS_ASSERT_IS_UTF8_MARK;
1687 return is_utf8_common(p, &PL_utf8_mark, "IsM");
1691 Perl_is_utf8_X_begin(pTHX_ const U8 *p)
1695 PERL_ARGS_ASSERT_IS_UTF8_X_BEGIN;
1697 return is_utf8_common(p, &PL_utf8_X_begin, "_X_Begin");
1701 Perl_is_utf8_X_extend(pTHX_ const U8 *p)
1705 PERL_ARGS_ASSERT_IS_UTF8_X_EXTEND;
1707 return is_utf8_common(p, &PL_utf8_X_extend, "_X_Extend");
1711 Perl_is_utf8_X_prepend(pTHX_ const U8 *p)
1715 PERL_ARGS_ASSERT_IS_UTF8_X_PREPEND;
1717 return is_utf8_common(p, &PL_utf8_X_prepend, "GCB=Prepend");
1721 Perl_is_utf8_X_non_hangul(pTHX_ const U8 *p)
1725 PERL_ARGS_ASSERT_IS_UTF8_X_NON_HANGUL;
1727 return is_utf8_common(p, &PL_utf8_X_non_hangul, "HST=Not_Applicable");
1731 Perl_is_utf8_X_L(pTHX_ const U8 *p)
1735 PERL_ARGS_ASSERT_IS_UTF8_X_L;
1737 return is_utf8_common(p, &PL_utf8_X_L, "GCB=L");
1741 Perl_is_utf8_X_LV(pTHX_ const U8 *p)
1745 PERL_ARGS_ASSERT_IS_UTF8_X_LV;
1747 return is_utf8_common(p, &PL_utf8_X_LV, "GCB=LV");
1751 Perl_is_utf8_X_LVT(pTHX_ const U8 *p)
1755 PERL_ARGS_ASSERT_IS_UTF8_X_LVT;
1757 return is_utf8_common(p, &PL_utf8_X_LVT, "GCB=LVT");
1761 Perl_is_utf8_X_T(pTHX_ const U8 *p)
1765 PERL_ARGS_ASSERT_IS_UTF8_X_T;
1767 return is_utf8_common(p, &PL_utf8_X_T, "GCB=T");
1771 Perl_is_utf8_X_V(pTHX_ const U8 *p)
1775 PERL_ARGS_ASSERT_IS_UTF8_X_V;
1777 return is_utf8_common(p, &PL_utf8_X_V, "GCB=V");
1781 Perl_is_utf8_X_LV_LVT_V(pTHX_ const U8 *p)
1785 PERL_ARGS_ASSERT_IS_UTF8_X_LV_LVT_V;
1787 return is_utf8_common(p, &PL_utf8_X_LV_LVT_V, "_X_LV_LVT_V");
1791 =for apidoc to_utf8_case
1793 The "p" contains the pointer to the UTF-8 string encoding
1794 the character that is being converted.
1796 The "ustrp" is a pointer to the character buffer to put the
1797 conversion result to. The "lenp" is a pointer to the length
1800 The "swashp" is a pointer to the swash to use.
1802 Both the special and normal mappings are stored in lib/unicore/To/Foo.pl,
1803 and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
1804 but not always, a multicharacter mapping), is tried first.
1806 The "special" is a string like "utf8::ToSpecLower", which means the
1807 hash %utf8::ToSpecLower. The access to the hash is through
1808 Perl_to_utf8_case().
1810 The "normal" is a string like "ToLower" which means the swash
1816 Perl_to_utf8_case(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp,
1817 SV **swashp, const char *normal, const char *special)
1820 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1822 const UV uv0 = utf8_to_uvchr(p, NULL);
1823 /* The NATIVE_TO_UNI() and UNI_TO_NATIVE() mappings
1824 * are necessary in EBCDIC, they are redundant no-ops
1825 * in ASCII-ish platforms, and hopefully optimized away. */
1826 const UV uv1 = NATIVE_TO_UNI(uv0);
1828 PERL_ARGS_ASSERT_TO_UTF8_CASE;
1830 /* Note that swash_fetch() doesn't output warnings for these because it
1831 * assumes we will */
1832 if (uv1 >= UNICODE_SURROGATE_FIRST) {
1833 if (uv1 <= UNICODE_SURROGATE_LAST) {
1834 if (ckWARN_d(WARN_SURROGATE)) {
1835 const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
1836 Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
1837 "Operation \"%s\" returns its argument for UTF-16 surrogate U+%04"UVXf"", desc, uv1);
1840 else if (UNICODE_IS_SUPER(uv1)) {
1841 if (ckWARN_d(WARN_NON_UNICODE)) {
1842 const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
1843 Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
1844 "Operation \"%s\" returns its argument for non-Unicode code point 0x%04"UVXf"", desc, uv1);
1848 /* Note that non-characters are perfectly legal, so no warning should
1852 uvuni_to_utf8(tmpbuf, uv1);
1854 if (!*swashp) /* load on-demand */
1855 *swashp = swash_init("utf8", normal, &PL_sv_undef, 4, 0);
1858 /* It might be "special" (sometimes, but not always,
1859 * a multicharacter mapping) */
1860 HV * const hv = get_hv(special, 0);
1864 (svp = hv_fetch(hv, (const char*)tmpbuf, UNISKIP(uv1), FALSE)) &&
1868 s = SvPV_const(*svp, len);
1870 len = uvuni_to_utf8(ustrp, NATIVE_TO_UNI(*(U8*)s)) - ustrp;
1873 /* If we have EBCDIC we need to remap the characters
1874 * since any characters in the low 256 are Unicode
1875 * code points, not EBCDIC. */
1876 U8 *t = (U8*)s, *tend = t + len, *d;
1883 const UV c = utf8_to_uvchr(t, &tlen);
1885 d = uvchr_to_utf8(d, UNI_TO_NATIVE(c));
1894 d = uvchr_to_utf8(d, UNI_TO_NATIVE(*t));
1899 Copy(tmpbuf, ustrp, len, U8);
1901 Copy(s, ustrp, len, U8);
1907 if (!len && *swashp) {
1908 const UV uv2 = swash_fetch(*swashp, tmpbuf, TRUE);
1911 /* It was "normal" (a single character mapping). */
1912 const UV uv3 = UNI_TO_NATIVE(uv2);
1913 len = uvchr_to_utf8(ustrp, uv3) - ustrp;
1917 if (!len) /* Neither: just copy. In other words, there was no mapping
1918 defined, which means that the code point maps to itself */
1919 len = uvchr_to_utf8(ustrp, uv0) - ustrp;
1924 return len ? utf8_to_uvchr(ustrp, 0) : 0;
1928 =for apidoc to_utf8_upper
1930 Convert the UTF-8 encoded character at p to its uppercase version and
1931 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
1932 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
1933 the uppercase version may be longer than the original character.
1935 The first character of the uppercased version is returned
1936 (but note, as explained above, that there may be more.)
1941 Perl_to_utf8_upper(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1945 PERL_ARGS_ASSERT_TO_UTF8_UPPER;
1947 return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
1948 &PL_utf8_toupper, "ToUpper", "utf8::ToSpecUpper");
1952 =for apidoc to_utf8_title
1954 Convert the UTF-8 encoded character at p to its titlecase version and
1955 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
1956 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
1957 titlecase version may be longer than the original character.
1959 The first character of the titlecased version is returned
1960 (but note, as explained above, that there may be more.)
1965 Perl_to_utf8_title(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1969 PERL_ARGS_ASSERT_TO_UTF8_TITLE;
1971 return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
1972 &PL_utf8_totitle, "ToTitle", "utf8::ToSpecTitle");
1976 =for apidoc to_utf8_lower
1978 Convert the UTF-8 encoded character at p to its lowercase version and
1979 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
1980 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
1981 lowercase version may be longer than the original character.
1983 The first character of the lowercased version is returned
1984 (but note, as explained above, that there may be more.)
1989 Perl_to_utf8_lower(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1993 PERL_ARGS_ASSERT_TO_UTF8_LOWER;
1995 return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
1996 &PL_utf8_tolower, "ToLower", "utf8::ToSpecLower");
2000 =for apidoc to_utf8_fold
2002 Convert the UTF-8 encoded character at p to its foldcase version and
2003 store that in UTF-8 in ustrp and its length in bytes in lenp. Note
2004 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
2005 foldcase version may be longer than the original character (up to
2008 The first character of the foldcased version is returned
2009 (but note, as explained above, that there may be more.)
2013 /* Not currently externally documented is 'flags', which currently is non-zero
2014 * if full case folds are to be used; otherwise simple folds */
2017 Perl__to_utf8_fold_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, U8 flags)
2019 const char *specials = (flags) ? "utf8::ToSpecFold" : NULL;
2023 PERL_ARGS_ASSERT__TO_UTF8_FOLD_FLAGS;
2025 return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
2026 &PL_utf8_tofold, "ToFold", specials);
2030 * A "swash" is a swatch hash.
2031 * A "swatch" is a bit vector generated by utf8.c:S_swash_get().
2032 * C<pkg> is a pointer to a package name for SWASHNEW, should be "utf8".
2033 * For other parameters, see utf8::SWASHNEW in lib/utf8_heavy.pl.
2036 Perl_swash_init(pTHX_ const char* pkg, const char* name, SV *listsv, I32 minbits, I32 none)
2041 const size_t pkg_len = strlen(pkg);
2042 const size_t name_len = strlen(name);
2043 HV * const stash = gv_stashpvn(pkg, pkg_len, 0);
2047 PERL_ARGS_ASSERT_SWASH_INIT;
2049 PUSHSTACKi(PERLSI_MAGIC);
2053 method = gv_fetchmeth(stash, "SWASHNEW", 8, -1);
2054 if (!method) { /* demand load utf8 */
2056 errsv_save = newSVsv(ERRSV);
2057 /* It is assumed that callers of this routine are not passing in any
2058 user derived data. */
2059 /* Need to do this after save_re_context() as it will set PL_tainted to
2060 1 while saving $1 etc (see the code after getrx: in Perl_magic_get).
2061 Even line to create errsv_save can turn on PL_tainted. */
2062 SAVEBOOL(PL_tainted);
2064 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpvn(pkg,pkg_len),
2067 sv_setsv(ERRSV, errsv_save);
2068 SvREFCNT_dec(errsv_save);
2074 mPUSHp(pkg, pkg_len);
2075 mPUSHp(name, name_len);
2080 errsv_save = newSVsv(ERRSV);
2081 /* If we already have a pointer to the method, no need to use call_method()
2082 to repeat the lookup. */
2083 if (method ? call_sv(MUTABLE_SV(method), G_SCALAR)
2084 : call_sv(newSVpvs_flags("SWASHNEW", SVs_TEMP), G_SCALAR | G_METHOD))
2085 retval = newSVsv(*PL_stack_sp--);
2087 retval = &PL_sv_undef;
2089 sv_setsv(ERRSV, errsv_save);
2090 SvREFCNT_dec(errsv_save);
2093 if (IN_PERL_COMPILETIME) {
2094 CopHINTS_set(PL_curcop, PL_hints);
2096 if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV) {
2098 Perl_croak(aTHX_ "Can't find Unicode property definition \"%"SVf"\"",
2100 Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
2106 /* This API is wrong for special case conversions since we may need to
2107 * return several Unicode characters for a single Unicode character
2108 * (see lib/unicore/SpecCase.txt) The SWASHGET in lib/utf8_heavy.pl is
2109 * the lower-level routine, and it is similarly broken for returning
2110 * multiple values. --jhi
2111 * For those, you should use to_utf8_case() instead */
2112 /* Now SWASHGET is recasted into S_swash_get in this file. */
2115 * Returns the value of property/mapping C<swash> for the first character
2116 * of the string C<ptr>. If C<do_utf8> is true, the string C<ptr> is
2117 * assumed to be in utf8. If C<do_utf8> is false, the string C<ptr> is
2118 * assumed to be in native 8-bit encoding. Caches the swatch in C<swash>.
2121 Perl_swash_fetch(pTHX_ SV *swash, const U8 *ptr, bool do_utf8)
2124 HV *const hv = MUTABLE_HV(SvRV(swash));
2129 const U8 *tmps = NULL;
2133 const UV c = NATIVE_TO_ASCII(*ptr);
2135 PERL_ARGS_ASSERT_SWASH_FETCH;
2137 if (!do_utf8 && !UNI_IS_INVARIANT(c)) {
2138 tmputf8[0] = (U8)UTF8_EIGHT_BIT_HI(c);
2139 tmputf8[1] = (U8)UTF8_EIGHT_BIT_LO(c);
2142 /* Given a UTF-X encoded char 0xAA..0xYY,0xZZ
2143 * then the "swatch" is a vec() for all the chars which start
2145 * So the key in the hash (klen) is length of encoded char -1
2147 klen = UTF8SKIP(ptr) - 1;
2151 /* If char is invariant then swatch is for all the invariant chars
2152 * In both UTF-8 and UTF-8-MOD that happens to be UTF_CONTINUATION_MARK
2154 needents = UTF_CONTINUATION_MARK;
2155 off = NATIVE_TO_UTF(ptr[klen]);
2158 /* If char is encoded then swatch is for the prefix */
2159 needents = (1 << UTF_ACCUMULATION_SHIFT);
2160 off = NATIVE_TO_UTF(ptr[klen]) & UTF_CONTINUATION_MASK;
2161 if (UTF8_IS_SUPER(ptr) && ckWARN_d(WARN_NON_UNICODE)) {
2162 const UV code_point = utf8n_to_uvuni(ptr, UTF8_MAXBYTES, 0, 0);
2164 /* This outputs warnings for binary properties only, assuming that
2165 * to_utf8_case() will output any. Also, surrogates aren't checked
2166 * for, as that would warn on things like /\p{Gc=Cs}/ */
2167 SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2168 if (SvUV(*bitssvp) == 1) {
2169 Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
2170 "Code point 0x%04"UVXf" is not Unicode, no properties match it; all inverse properties do", code_point);
2176 * This single-entry cache saves about 1/3 of the utf8 overhead in test
2177 * suite. (That is, only 7-8% overall over just a hash cache. Still,
2178 * it's nothing to sniff at.) Pity we usually come through at least
2179 * two function calls to get here...
2181 * NB: this code assumes that swatches are never modified, once generated!
2184 if (hv == PL_last_swash_hv &&
2185 klen == PL_last_swash_klen &&
2186 (!klen || memEQ((char *)ptr, (char *)PL_last_swash_key, klen)) )
2188 tmps = PL_last_swash_tmps;
2189 slen = PL_last_swash_slen;
2192 /* Try our second-level swatch cache, kept in a hash. */
2193 SV** svp = hv_fetch(hv, (const char*)ptr, klen, FALSE);
2195 /* If not cached, generate it via swash_get */
2196 if (!svp || !SvPOK(*svp)
2197 || !(tmps = (const U8*)SvPV_const(*svp, slen))) {
2198 /* We use utf8n_to_uvuni() as we want an index into
2199 Unicode tables, not a native character number.
2201 const UV code_point = utf8n_to_uvuni(ptr, UTF8_MAXBYTES, 0,
2203 0 : UTF8_ALLOW_ANY);
2204 swatch = swash_get(swash,
2205 /* On EBCDIC & ~(0xA0-1) isn't a useful thing to do */
2206 (klen) ? (code_point & ~(needents - 1)) : 0,
2209 if (IN_PERL_COMPILETIME)
2210 CopHINTS_set(PL_curcop, PL_hints);
2212 svp = hv_store(hv, (const char *)ptr, klen, swatch, 0);
2214 if (!svp || !(tmps = (U8*)SvPV(*svp, slen))
2215 || (slen << 3) < needents)
2216 Perl_croak(aTHX_ "panic: swash_fetch got improper swatch");
2219 PL_last_swash_hv = hv;
2220 assert(klen <= sizeof(PL_last_swash_key));
2221 PL_last_swash_klen = (U8)klen;
2222 /* FIXME change interpvar.h? */
2223 PL_last_swash_tmps = (U8 *) tmps;
2224 PL_last_swash_slen = slen;
2226 Copy(ptr, PL_last_swash_key, klen, U8);
2229 switch ((int)((slen << 3) / needents)) {
2231 bit = 1 << (off & 7);
2233 return (tmps[off] & bit) != 0;
2238 return (tmps[off] << 8) + tmps[off + 1] ;
2241 return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
2243 Perl_croak(aTHX_ "panic: swash_fetch got swatch of unexpected bit width");
2244 NORETURN_FUNCTION_END;
2247 /* Read a single line of the main body of the swash input text. These are of
2250 * where each number is hex. The first two numbers form the minimum and
2251 * maximum of a range, and the third is the value associated with the range.
2252 * Not all swashes should have a third number
2254 * On input: l points to the beginning of the line to be examined; it points
2255 * to somewhere in the string of the whole input text, and is
2256 * terminated by a \n or the null string terminator.
2257 * lend points to the null terminator of that string
2258 * wants_value is non-zero if the swash expects a third number
2259 * typestr is the name of the swash's mapping, like 'ToLower'
2260 * On output: *min, *max, and *val are set to the values read from the line.
2261 * returns a pointer just beyond the line examined. If there was no
2262 * valid min number on the line, returns lend+1
2266 S_swash_scan_list_line(pTHX_ U8* l, U8* const lend, UV* min, UV* max, UV* val,
2267 const bool wants_value, const U8* const typestr)
2269 const int typeto = typestr[0] == 'T' && typestr[1] == 'o';
2270 STRLEN numlen; /* Length of the number */
2271 I32 flags = PERL_SCAN_SILENT_ILLDIGIT
2272 | PERL_SCAN_DISALLOW_PREFIX
2273 | PERL_SCAN_SILENT_NON_PORTABLE;
2275 /* nl points to the next \n in the scan */
2276 U8* const nl = (U8*)memchr(l, '\n', lend - l);
2278 /* Get the first number on the line: the range minimum */
2280 *min = grok_hex((char *)l, &numlen, &flags, NULL);
2281 if (numlen) /* If found a hex number, position past it */
2283 else if (nl) { /* Else, go handle next line, if any */
2284 return nl + 1; /* 1 is length of "\n" */
2286 else { /* Else, no next line */
2287 return lend + 1; /* to LIST's end at which \n is not found */
2290 /* The max range value follows, separated by a BLANK */
2293 flags = PERL_SCAN_SILENT_ILLDIGIT
2294 | PERL_SCAN_DISALLOW_PREFIX
2295 | PERL_SCAN_SILENT_NON_PORTABLE;
2297 *max = grok_hex((char *)l, &numlen, &flags, NULL);
2300 else /* If no value here, it is a single element range */
2303 /* Non-binary tables have a third entry: what the first element of the
2308 flags = PERL_SCAN_SILENT_ILLDIGIT
2309 | PERL_SCAN_DISALLOW_PREFIX
2310 | PERL_SCAN_SILENT_NON_PORTABLE;
2312 *val = grok_hex((char *)l, &numlen, &flags, NULL);
2321 Perl_croak(aTHX_ "%s: illegal mapping '%s'",
2327 *val = 0; /* bits == 1, then any val should be ignored */
2329 else { /* Nothing following range min, should be single element with no
2335 Perl_croak(aTHX_ "%s: illegal mapping '%s'", typestr, l);
2339 *val = 0; /* bits == 1, then val should be ignored */
2342 /* Position to next line if any, or EOF */
2352 * Returns a swatch (a bit vector string) for a code point sequence
2353 * that starts from the value C<start> and comprises the number C<span>.
2354 * A C<swash> must be an object created by SWASHNEW (see lib/utf8_heavy.pl).
2355 * Should be used via swash_fetch, which will cache the swatch in C<swash>.
2358 S_swash_get(pTHX_ SV* swash, UV start, UV span)
2361 U8 *l, *lend, *x, *xend, *s, *send;
2362 STRLEN lcur, xcur, scur;
2363 HV *const hv = MUTABLE_HV(SvRV(swash));
2365 /* The string containing the main body of the table */
2366 SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
2368 SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
2369 SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2370 SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
2371 SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
2372 SV** const invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
2373 const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
2374 const STRLEN bits = SvUV(*bitssvp);
2375 const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
2376 const UV none = SvUV(*nonesvp);
2377 const UV end = start + span;
2379 PERL_ARGS_ASSERT_SWASH_GET;
2381 if (bits != 1 && bits != 8 && bits != 16 && bits != 32) {
2382 Perl_croak(aTHX_ "panic: swash_get doesn't expect bits %"UVuf,
2386 /* create and initialize $swatch */
2387 scur = octets ? (span * octets) : (span + 7) / 8;
2388 swatch = newSV(scur);
2390 s = (U8*)SvPVX(swatch);
2391 if (octets && none) {
2392 const U8* const e = s + scur;
2395 *s++ = (U8)(none & 0xff);
2396 else if (bits == 16) {
2397 *s++ = (U8)((none >> 8) & 0xff);
2398 *s++ = (U8)( none & 0xff);
2400 else if (bits == 32) {
2401 *s++ = (U8)((none >> 24) & 0xff);
2402 *s++ = (U8)((none >> 16) & 0xff);
2403 *s++ = (U8)((none >> 8) & 0xff);
2404 *s++ = (U8)( none & 0xff);
2410 (void)memzero((U8*)s, scur + 1);
2412 SvCUR_set(swatch, scur);
2413 s = (U8*)SvPVX(swatch);
2415 /* read $swash->{LIST} */
2416 l = (U8*)SvPV(*listsvp, lcur);
2420 l = S_swash_scan_list_line(aTHX_ l, lend, &min, &max, &val,
2421 cBOOL(octets), typestr);
2426 /* If looking for something beyond this range, go try the next one */
2433 if (!none || val < none) {
2438 for (key = min; key <= max; key++) {
2442 /* offset must be non-negative (start <= min <= key < end) */
2443 offset = octets * (key - start);
2445 s[offset] = (U8)(val & 0xff);
2446 else if (bits == 16) {
2447 s[offset ] = (U8)((val >> 8) & 0xff);
2448 s[offset + 1] = (U8)( val & 0xff);
2450 else if (bits == 32) {
2451 s[offset ] = (U8)((val >> 24) & 0xff);
2452 s[offset + 1] = (U8)((val >> 16) & 0xff);
2453 s[offset + 2] = (U8)((val >> 8) & 0xff);
2454 s[offset + 3] = (U8)( val & 0xff);
2457 if (!none || val < none)
2461 else { /* bits == 1, then val should be ignored */
2465 for (key = min; key <= max; key++) {
2466 const STRLEN offset = (STRLEN)(key - start);
2469 s[offset >> 3] |= 1 << (offset & 7);
2475 /* Invert if the data says it should be */
2476 if (invert_it_svp && SvUV(*invert_it_svp)) {
2484 /* read $swash->{EXTRAS}
2485 * This code also copied to swash_to_invlist() below */
2486 x = (U8*)SvPV(*extssvp, xcur);
2494 SV **otherbitssvp, *other;
2498 const U8 opc = *x++;
2502 nl = (U8*)memchr(x, '\n', xend - x);
2504 if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
2506 x = nl + 1; /* 1 is length of "\n" */
2510 x = xend; /* to EXTRAS' end at which \n is not found */
2517 namelen = nl - namestr;
2521 namelen = xend - namestr;
2525 othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
2526 otherhv = MUTABLE_HV(SvRV(*othersvp));
2527 otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
2528 otherbits = (STRLEN)SvUV(*otherbitssvp);
2529 if (bits < otherbits)
2530 Perl_croak(aTHX_ "panic: swash_get found swatch size mismatch");
2532 /* The "other" swatch must be destroyed after. */
2533 other = swash_get(*othersvp, start, span);
2534 o = (U8*)SvPV(other, olen);
2537 Perl_croak(aTHX_ "panic: swash_get got improper swatch");
2539 s = (U8*)SvPV(swatch, slen);
2540 if (bits == 1 && otherbits == 1) {
2542 Perl_croak(aTHX_ "panic: swash_get found swatch length mismatch");
2566 STRLEN otheroctets = otherbits >> 3;
2568 U8* const send = s + slen;
2573 if (otherbits == 1) {
2574 otherval = (o[offset >> 3] >> (offset & 7)) & 1;
2578 STRLEN vlen = otheroctets;
2586 if (opc == '+' && otherval)
2587 NOOP; /* replace with otherval */
2588 else if (opc == '!' && !otherval)
2590 else if (opc == '-' && otherval)
2592 else if (opc == '&' && !otherval)
2595 s += octets; /* no replacement */
2600 *s++ = (U8)( otherval & 0xff);
2601 else if (bits == 16) {
2602 *s++ = (U8)((otherval >> 8) & 0xff);
2603 *s++ = (U8)( otherval & 0xff);
2605 else if (bits == 32) {
2606 *s++ = (U8)((otherval >> 24) & 0xff);
2607 *s++ = (U8)((otherval >> 16) & 0xff);
2608 *s++ = (U8)((otherval >> 8) & 0xff);
2609 *s++ = (U8)( otherval & 0xff);
2613 sv_free(other); /* through with it! */
2619 Perl__swash_inversion_hash(pTHX_ SV* const swash)
2622 /* Subject to change or removal. For use only in one place in regcomp.c.
2623 * Can't be used on a property that is subject to user override, as it
2624 * relies on the value of SPECIALS in the swash which would be set by
2625 * utf8_heavy.pl to the hash in the non-overriden file, and hence is not set
2626 * for overridden properties
2628 * Returns a hash which is the inversion and closure of a swash mapping.
2629 * For example, consider the input lines:
2634 * The returned hash would have two keys, the utf8 for 006B and the utf8 for
2635 * 006C. The value for each key is an array. For 006C, the array would
2636 * have a two elements, the utf8 for itself, and for 004C. For 006B, there
2637 * would be three elements in its array, the utf8 for 006B, 004B and 212A.
2639 * Essentially, for any code point, it gives all the code points that map to
2640 * it, or the list of 'froms' for that point.
2642 * Currently it ignores any additions or deletions from other swashes,
2643 * looking at just the main body of the swash, and if there are SPECIALS
2644 * in the swash, at that hash
2646 * The specials hash can be extra code points, and most likely consists of
2647 * maps from single code points to multiple ones (each expressed as a string
2648 * of utf8 characters). This function currently returns only 1-1 mappings.
2649 * However consider this possible input in the specials hash:
2650 * "\xEF\xAC\x85" => "\x{0073}\x{0074}", # U+FB05 => 0073 0074
2651 * "\xEF\xAC\x86" => "\x{0073}\x{0074}", # U+FB06 => 0073 0074
2653 * Both FB05 and FB06 map to the same multi-char sequence, which we don't
2654 * currently handle. But it also means that FB05 and FB06 are equivalent in
2655 * a 1-1 mapping which we should handle, and this relationship may not be in
2656 * the main table. Therefore this function examines all the multi-char
2657 * sequences and adds the 1-1 mappings that come out of that. */
2661 HV *const hv = MUTABLE_HV(SvRV(swash));
2663 /* The string containing the main body of the table */
2664 SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
2666 SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
2667 SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2668 SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
2669 /*SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);*/
2670 const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
2671 const STRLEN bits = SvUV(*bitssvp);
2672 const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
2673 const UV none = SvUV(*nonesvp);
2674 SV **specials_p = hv_fetchs(hv, "SPECIALS", 0);
2678 PERL_ARGS_ASSERT__SWASH_INVERSION_HASH;
2680 /* Must have at least 8 bits to get the mappings */
2681 if (bits != 8 && bits != 16 && bits != 32) {
2682 Perl_croak(aTHX_ "panic: swash_inversion_hash doesn't expect bits %"UVuf,
2686 if (specials_p) { /* It might be "special" (sometimes, but not always, a
2687 mapping to more than one character */
2689 /* Construct an inverse mapping hash for the specials */
2690 HV * const specials_hv = MUTABLE_HV(SvRV(*specials_p));
2691 HV * specials_inverse = newHV();
2692 char *char_from; /* the lhs of the map */
2693 I32 from_len; /* its byte length */
2694 char *char_to; /* the rhs of the map */
2695 I32 to_len; /* its byte length */
2696 SV *sv_to; /* and in a sv */
2697 AV* from_list; /* list of things that map to each 'to' */
2699 hv_iterinit(specials_hv);
2701 /* The keys are the characters (in utf8) that map to the corresponding
2702 * utf8 string value. Iterate through the list creating the inverse
2704 while ((sv_to = hv_iternextsv(specials_hv, &char_from, &from_len))) {
2706 if (! SvPOK(sv_to)) {
2707 Perl_croak(aTHX_ "panic: value returned from hv_iternextsv() unexpectedly is not a string");
2709 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Found mapping from %"UVXf", First char of to is %"UVXf"\n", utf8_to_uvchr((U8*) char_from, 0), utf8_to_uvchr((U8*) SvPVX(sv_to), 0)));*/
2711 /* Each key in the inverse list is a mapped-to value, and the key's
2712 * hash value is a list of the strings (each in utf8) that map to
2713 * it. Those strings are all one character long */
2714 if ((listp = hv_fetch(specials_inverse,
2718 from_list = (AV*) *listp;
2720 else { /* No entry yet for it: create one */
2721 from_list = newAV();
2722 if (! hv_store(specials_inverse,
2725 (SV*) from_list, 0))
2727 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2731 /* Here have the list associated with this 'to' (perhaps newly
2732 * created and empty). Just add to it. Note that we ASSUME that
2733 * the input is guaranteed to not have duplications, so we don't
2734 * check for that. Duplications just slow down execution time. */
2735 av_push(from_list, newSVpvn_utf8(char_from, from_len, TRUE));
2738 /* Here, 'specials_inverse' contains the inverse mapping. Go through
2739 * it looking for cases like the FB05/FB06 examples above. There would
2740 * be an entry in the hash like
2741 * 'st' => [ FB05, FB06 ]
2742 * In this example we will create two lists that get stored in the
2743 * returned hash, 'ret':
2744 * FB05 => [ FB05, FB06 ]
2745 * FB06 => [ FB05, FB06 ]
2747 * Note that there is nothing to do if the array only has one element.
2748 * (In the normal 1-1 case handled below, we don't have to worry about
2749 * two lists, as everything gets tied to the single list that is
2750 * generated for the single character 'to'. But here, we are omitting
2751 * that list, ('st' in the example), so must have multiple lists.) */
2752 while ((from_list = (AV *) hv_iternextsv(specials_inverse,
2753 &char_to, &to_len)))
2755 if (av_len(from_list) > 0) {
2758 /* We iterate over all combinations of i,j to place each code
2759 * point on each list */
2760 for (i = 0; i <= av_len(from_list); i++) {
2762 AV* i_list = newAV();
2763 SV** entryp = av_fetch(from_list, i, FALSE);
2764 if (entryp == NULL) {
2765 Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
2767 if (hv_fetch(ret, SvPVX(*entryp), SvCUR(*entryp), FALSE)) {
2768 Perl_croak(aTHX_ "panic: unexpected entry for %s", SvPVX(*entryp));
2770 if (! hv_store(ret, SvPVX(*entryp), SvCUR(*entryp),
2771 (SV*) i_list, FALSE))
2773 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2776 /* For debugging: UV u = utf8_to_uvchr((U8*) SvPVX(*entryp), 0);*/
2777 for (j = 0; j <= av_len(from_list); j++) {
2778 entryp = av_fetch(from_list, j, FALSE);
2779 if (entryp == NULL) {
2780 Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
2783 /* When i==j this adds itself to the list */
2784 av_push(i_list, newSVuv(utf8_to_uvchr(
2785 (U8*) SvPVX(*entryp), 0)));
2786 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Adding %"UVXf" to list for %"UVXf"\n", utf8_to_uvchr((U8*) SvPVX(*entryp), 0), u));*/
2791 SvREFCNT_dec(specials_inverse); /* done with it */
2792 } /* End of specials */
2794 /* read $swash->{LIST} */
2795 l = (U8*)SvPV(*listsvp, lcur);
2798 /* Go through each input line */
2802 l = S_swash_scan_list_line(aTHX_ l, lend, &min, &max, &val,
2803 cBOOL(octets), typestr);
2808 /* Each element in the range is to be inverted */
2809 for (inverse = min; inverse <= max; inverse++) {
2813 bool found_key = FALSE;
2814 bool found_inverse = FALSE;
2816 /* The key is the inverse mapping */
2817 char key[UTF8_MAXBYTES+1];
2818 char* key_end = (char *) uvuni_to_utf8((U8*) key, val);
2819 STRLEN key_len = key_end - key;
2821 /* Get the list for the map */
2822 if ((listp = hv_fetch(ret, key, key_len, FALSE))) {
2823 list = (AV*) *listp;
2825 else { /* No entry yet for it: create one */
2827 if (! hv_store(ret, key, key_len, (SV*) list, FALSE)) {
2828 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2832 /* Look through list to see if this inverse mapping already is
2833 * listed, or if there is a mapping to itself already */
2834 for (i = 0; i <= av_len(list); i++) {
2835 SV** entryp = av_fetch(list, i, FALSE);
2837 if (entryp == NULL) {
2838 Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
2841 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "list for %"UVXf" contains %"UVXf"\n", val, SvUV(entry)));*/
2842 if (SvUV(entry) == val) {
2845 if (SvUV(entry) == inverse) {
2846 found_inverse = TRUE;
2849 /* No need to continue searching if found everything we are
2851 if (found_key && found_inverse) {
2856 /* Make sure there is a mapping to itself on the list */
2858 av_push(list, newSVuv(val));
2859 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Adding %"UVXf" to list for %"UVXf"\n", val, val));*/
2863 /* Simply add the value to the list */
2864 if (! found_inverse) {
2865 av_push(list, newSVuv(inverse));
2866 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Adding %"UVXf" to list for %"UVXf"\n", inverse, val));*/
2869 /* swash_get() increments the value of val for each element in the
2870 * range. That makes more compact tables possible. You can
2871 * express the capitalization, for example, of all consecutive
2872 * letters with a single line: 0061\t007A\t0041 This maps 0061 to
2873 * 0041, 0062 to 0042, etc. I (khw) have never understood 'none',
2874 * and it's not documented; it appears to be used only in
2875 * implementing tr//; I copied the semantics from swash_get(), just
2877 if (!none || val < none) {
2887 Perl__swash_to_invlist(pTHX_ SV* const swash)
2890 /* Subject to change or removal. For use only in one place in regcomp.c */
2895 HV *const hv = MUTABLE_HV(SvRV(swash));
2896 UV elements = 0; /* Number of elements in the inversion list */
2899 /* The string containing the main body of the table */
2900 SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
2901 SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
2902 SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2903 SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
2904 SV** const invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
2906 const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
2907 const STRLEN bits = SvUV(*bitssvp);
2908 const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
2914 PERL_ARGS_ASSERT__SWASH_TO_INVLIST;
2916 /* read $swash->{LIST} */
2917 if (SvPOK(*listsvp)) {
2918 l = (U8*)SvPV(*listsvp, lcur);
2921 /* LIST legitimately doesn't contain a string during compilation phases
2922 * of Perl itself, before the Unicode tables are generated. In this
2923 * case, just fake things up by creating an empty list */
2930 /* Scan the input to count the number of lines to preallocate array size
2931 * based on worst possible case, which is each line in the input creates 2
2932 * elements in the inversion list: 1) the beginning of a range in the list;
2933 * 2) the beginning of a range not in the list. */
2934 while ((loc = (strchr(loc, '\n'))) != NULL) {
2939 /* If the ending is somehow corrupt and isn't a new line, add another
2940 * element for the final range that isn't in the inversion list */
2941 if (! (*lend == '\n' || (*lend == '\0' && *(lend - 1) == '\n'))) {
2945 invlist = _new_invlist(elements);
2947 /* Now go through the input again, adding each range to the list */
2950 UV val; /* Not used by this function */
2952 l = S_swash_scan_list_line(aTHX_ l, lend, &start, &end, &val,
2953 cBOOL(octets), typestr);
2959 _append_range_to_invlist(invlist, start, end);
2962 /* Invert if the data says it should be */
2963 if (invert_it_svp && SvUV(*invert_it_svp)) {
2964 _invlist_invert(invlist);
2967 /* This code is copied from swash_get()
2968 * read $swash->{EXTRAS} */
2969 x = (U8*)SvPV(*extssvp, xcur);
2977 SV **otherbitssvp, *other;
2980 const U8 opc = *x++;
2984 nl = (U8*)memchr(x, '\n', xend - x);
2986 if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
2988 x = nl + 1; /* 1 is length of "\n" */
2992 x = xend; /* to EXTRAS' end at which \n is not found */
2999 namelen = nl - namestr;
3003 namelen = xend - namestr;
3007 othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
3008 otherhv = MUTABLE_HV(SvRV(*othersvp));
3009 otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
3010 otherbits = (STRLEN)SvUV(*otherbitssvp);
3012 if (bits != otherbits || bits != 1) {
3013 Perl_croak(aTHX_ "panic: _swash_to_invlist only operates on boolean properties");
3016 /* The "other" swatch must be destroyed after. */
3017 other = _swash_to_invlist((SV *)*othersvp);
3019 /* End of code copied from swash_get() */
3022 _invlist_union(invlist, other, &invlist);
3025 _invlist_invert(other);
3026 _invlist_union(invlist, other, &invlist);
3029 _invlist_subtract(invlist, other, &invlist);
3032 _invlist_intersection(invlist, other, &invlist);
3037 sv_free(other); /* through with it! */
3044 =for apidoc uvchr_to_utf8
3046 Adds the UTF-8 representation of the Native code point C<uv> to the end
3047 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
3048 bytes available. The return value is the pointer to the byte after the
3049 end of the new character. In other words,
3051 d = uvchr_to_utf8(d, uv);
3053 is the recommended wide native character-aware way of saying
3060 /* On ASCII machines this is normally a macro but we want a
3061 real function in case XS code wants it
3064 Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv)
3066 PERL_ARGS_ASSERT_UVCHR_TO_UTF8;
3068 return Perl_uvuni_to_utf8_flags(aTHX_ d, NATIVE_TO_UNI(uv), 0);
3072 Perl_uvchr_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
3074 PERL_ARGS_ASSERT_UVCHR_TO_UTF8_FLAGS;
3076 return Perl_uvuni_to_utf8_flags(aTHX_ d, NATIVE_TO_UNI(uv), flags);
3080 =for apidoc utf8n_to_uvchr
3082 Returns the native character value of the first character in the string
3084 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
3085 length, in bytes, of that character.
3087 length and flags are the same as utf8n_to_uvuni().
3091 /* On ASCII machines this is normally a macro but we want
3092 a real function in case XS code wants it
3095 Perl_utf8n_to_uvchr(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen,
3098 const UV uv = Perl_utf8n_to_uvuni(aTHX_ s, curlen, retlen, flags);
3100 PERL_ARGS_ASSERT_UTF8N_TO_UVCHR;
3102 return UNI_TO_NATIVE(uv);
3106 Perl_check_utf8_print(pTHX_ register const U8* s, const STRLEN len)
3108 /* May change: warns if surrogates, non-character code points, or
3109 * non-Unicode code points are in s which has length len. Returns TRUE if
3110 * none found; FALSE otherwise. The only other validity check is to make
3111 * sure that this won't exceed the string's length */
3113 const U8* const e = s + len;
3116 PERL_ARGS_ASSERT_CHECK_UTF8_PRINT;
3119 if (UTF8SKIP(s) > len) {
3120 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
3121 "%s in %s", unees, PL_op ? OP_DESC(PL_op) : "print");
3124 if (*s >= UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE) {
3126 if (UTF8_IS_SUPER(s)) {
3127 if (ckWARN_d(WARN_NON_UNICODE)) {
3128 UV uv = utf8_to_uvchr(s, &char_len);
3129 Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
3130 "Code point 0x%04"UVXf" is not Unicode, may not be portable", uv);
3134 else if (UTF8_IS_SURROGATE(s)) {
3135 if (ckWARN_d(WARN_SURROGATE)) {
3136 UV uv = utf8_to_uvchr(s, &char_len);
3137 Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
3138 "Unicode surrogate U+%04"UVXf" is illegal in UTF-8", uv);
3143 ((UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s))
3144 && (ckWARN_d(WARN_NONCHAR)))
3146 UV uv = utf8_to_uvchr(s, &char_len);
3147 Perl_warner(aTHX_ packWARN(WARN_NONCHAR),
3148 "Unicode non-character U+%04"UVXf" is illegal for open interchange", uv);
3159 =for apidoc pv_uni_display
3161 Build to the scalar dsv a displayable version of the string spv,
3162 length len, the displayable version being at most pvlim bytes long
3163 (if longer, the rest is truncated and "..." will be appended).
3165 The flags argument can have UNI_DISPLAY_ISPRINT set to display
3166 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
3167 to display the \\[nrfta\\] as the backslashed versions (like '\n')
3168 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
3169 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
3170 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
3172 The pointer to the PV of the dsv is returned.
3176 Perl_pv_uni_display(pTHX_ SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
3181 PERL_ARGS_ASSERT_PV_UNI_DISPLAY;
3185 for (s = (const char *)spv, e = s + len; s < e; s += UTF8SKIP(s)) {
3187 /* This serves double duty as a flag and a character to print after
3188 a \ when flags & UNI_DISPLAY_BACKSLASH is true.
3192 if (pvlim && SvCUR(dsv) >= pvlim) {
3196 u = utf8_to_uvchr((U8*)s, 0);
3198 const unsigned char c = (unsigned char)u & 0xFF;
3199 if (flags & UNI_DISPLAY_BACKSLASH) {
3216 const char string = ok;
3217 sv_catpvs(dsv, "\\");
3218 sv_catpvn(dsv, &string, 1);
3221 /* isPRINT() is the locale-blind version. */
3222 if (!ok && (flags & UNI_DISPLAY_ISPRINT) && isPRINT(c)) {
3223 const char string = c;
3224 sv_catpvn(dsv, &string, 1);
3229 Perl_sv_catpvf(aTHX_ dsv, "\\x{%"UVxf"}", u);
3232 sv_catpvs(dsv, "...");
3238 =for apidoc sv_uni_display
3240 Build to the scalar dsv a displayable version of the scalar sv,
3241 the displayable version being at most pvlim bytes long
3242 (if longer, the rest is truncated and "..." will be appended).
3244 The flags argument is as in pv_uni_display().
3246 The pointer to the PV of the dsv is returned.
3251 Perl_sv_uni_display(pTHX_ SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
3253 PERL_ARGS_ASSERT_SV_UNI_DISPLAY;
3255 return Perl_pv_uni_display(aTHX_ dsv, (const U8*)SvPVX_const(ssv),
3256 SvCUR(ssv), pvlim, flags);
3260 =for apidoc foldEQ_utf8
3262 Returns true if the leading portions of the strings s1 and s2 (either or both
3263 of which may be in UTF-8) are the same case-insensitively; false otherwise.
3264 How far into the strings to compare is determined by other input parameters.
3266 If u1 is true, the string s1 is assumed to be in UTF-8-encoded Unicode;
3267 otherwise it is assumed to be in native 8-bit encoding. Correspondingly for u2
3270 If the byte length l1 is non-zero, it says how far into s1 to check for fold
3271 equality. In other words, s1+l1 will be used as a goal to reach. The
3272 scan will not be considered to be a match unless the goal is reached, and
3273 scanning won't continue past that goal. Correspondingly for l2 with respect to
3276 If pe1 is non-NULL and the pointer it points to is not NULL, that pointer is
3277 considered an end pointer beyond which scanning of s1 will not continue under
3278 any circumstances. This means that if both l1 and pe1 are specified, and pe1
3279 is less than s1+l1, the match will never be successful because it can never
3280 get as far as its goal (and in fact is asserted against). Correspondingly for
3281 pe2 with respect to s2.
3283 At least one of s1 and s2 must have a goal (at least one of l1 and l2 must be
3284 non-zero), and if both do, both have to be
3285 reached for a successful match. Also, if the fold of a character is multiple
3286 characters, all of them must be matched (see tr21 reference below for
3289 Upon a successful match, if pe1 is non-NULL,
3290 it will be set to point to the beginning of the I<next> character of s1 beyond
3291 what was matched. Correspondingly for pe2 and s2.
3293 For case-insensitiveness, the "casefolding" of Unicode is used
3294 instead of upper/lowercasing both the characters, see
3295 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
3299 /* A flags parameter has been added which may change, and hence isn't
3300 * externally documented. Currently it is:
3301 * 0 for as-documented above
3302 * FOLDEQ_UTF8_NOMIX_ASCII meaning that if a non-ASCII character folds to an
3303 ASCII one, to not match
3304 * FOLDEQ_UTF8_LOCALE meaning that locale rules are to be used for code
3305 * points below 256; unicode rules for above 255; and
3306 * folds that cross those boundaries are disallowed,
3307 * like the NOMIX_ASCII option
3310 Perl_foldEQ_utf8_flags(pTHX_ const char *s1, char **pe1, register UV l1, bool u1, const char *s2, char **pe2, register UV l2, bool u2, U32 flags)
3313 register const U8 *p1 = (const U8*)s1; /* Point to current char */
3314 register const U8 *p2 = (const U8*)s2;
3315 register const U8 *g1 = NULL; /* goal for s1 */
3316 register const U8 *g2 = NULL;
3317 register const U8 *e1 = NULL; /* Don't scan s1 past this */
3318 register U8 *f1 = NULL; /* Point to current folded */
3319 register const U8 *e2 = NULL;
3320 register U8 *f2 = NULL;
3321 STRLEN n1 = 0, n2 = 0; /* Number of bytes in current char */
3322 U8 foldbuf1[UTF8_MAXBYTES_CASE+1];
3323 U8 foldbuf2[UTF8_MAXBYTES_CASE+1];
3324 U8 natbuf[2]; /* Holds native 8-bit char converted to utf8;
3325 these always fit in 2 bytes */
3327 PERL_ARGS_ASSERT_FOLDEQ_UTF8_FLAGS;
3334 g1 = (const U8*)s1 + l1;
3342 g2 = (const U8*)s2 + l2;
3345 /* Must have at least one goal */
3350 /* Will never match if goal is out-of-bounds */
3351 assert(! e1 || e1 >= g1);
3353 /* Here, there isn't an end pointer, or it is beyond the goal. We
3354 * only go as far as the goal */
3358 assert(e1); /* Must have an end for looking at s1 */
3361 /* Same for goal for s2 */
3363 assert(! e2 || e2 >= g2);
3370 /* Look through both strings, a character at a time */
3371 while (p1 < e1 && p2 < e2) {
3373 /* If at the beginning of a new character in s1, get its fold to use
3374 * and the length of the fold. (exception: locale rules just get the
3375 * character to a single byte) */
3378 /* If in locale matching, we use two sets of rules, depending on if
3379 * the code point is above or below 255. Here, we test for and
3380 * handle locale rules */
3381 if ((flags & FOLDEQ_UTF8_LOCALE)
3382 && (! u1 || UTF8_IS_INVARIANT(*p1) || UTF8_IS_DOWNGRADEABLE_START(*p1)))
3384 /* There is no mixing of code points above and below 255. */
3385 if (u2 && (! UTF8_IS_INVARIANT(*p2)
3386 && ! UTF8_IS_DOWNGRADEABLE_START(*p2)))
3391 /* We handle locale rules by converting, if necessary, the code
3392 * point to a single byte. */
3393 if (! u1 || UTF8_IS_INVARIANT(*p1)) {
3397 *foldbuf1 = TWO_BYTE_UTF8_TO_UNI(*p1, *(p1 + 1));
3401 else if (isASCII(*p1)) { /* Note, that here won't be both ASCII
3402 and using locale rules */
3404 /* If trying to mix non- with ASCII, and not supposed to, fail */
3405 if ((flags & FOLDEQ_UTF8_NOMIX_ASCII) && ! isASCII(*p2)) {
3409 *foldbuf1 = toLOWER(*p1); /* Folds in the ASCII range are
3413 to_utf8_fold(p1, foldbuf1, &n1);
3415 else { /* Not utf8, convert to it first and then get fold */
3416 uvuni_to_utf8(natbuf, (UV) NATIVE_TO_UNI(((UV)*p1)));
3417 to_utf8_fold(natbuf, foldbuf1, &n1);
3422 if (n2 == 0) { /* Same for s2 */
3423 if ((flags & FOLDEQ_UTF8_LOCALE)
3424 && (! u2 || UTF8_IS_INVARIANT(*p2) || UTF8_IS_DOWNGRADEABLE_START(*p2)))
3426 /* Here, the next char in s2 is < 256. We've already worked on
3427 * s1, and if it isn't also < 256, can't match */
3428 if (u1 && (! UTF8_IS_INVARIANT(*p1)
3429 && ! UTF8_IS_DOWNGRADEABLE_START(*p1)))
3433 if (! u2 || UTF8_IS_INVARIANT(*p2)) {
3437 *foldbuf2 = TWO_BYTE_UTF8_TO_UNI(*p2, *(p2 + 1));
3440 /* Use another function to handle locale rules. We've made
3441 * sure that both characters to compare are single bytes */
3442 if (! foldEQ_locale((char *) f1, (char *) foldbuf2, 1)) {
3447 else if (isASCII(*p2)) {
3448 if (flags && ! isASCII(*p1)) {
3452 *foldbuf2 = toLOWER(*p2);
3455 to_utf8_fold(p2, foldbuf2, &n2);
3458 uvuni_to_utf8(natbuf, (UV) NATIVE_TO_UNI(((UV)*p2)));
3459 to_utf8_fold(natbuf, foldbuf2, &n2);
3464 /* Here f1 and f2 point to the beginning of the strings to compare.
3465 * These strings are the folds of the input characters, stored in utf8.
3468 /* While there is more to look for in both folds, see if they
3469 * continue to match */
3471 U8 fold_length = UTF8SKIP(f1);
3472 if (fold_length != UTF8SKIP(f2)
3473 || (fold_length == 1 && *f1 != *f2) /* Short circuit memNE
3474 function call for single
3476 || memNE((char*)f1, (char*)f2, fold_length))
3478 return 0; /* mismatch */
3481 /* Here, they matched, advance past them */
3488 /* When reach the end of any fold, advance the input past it */
3490 p1 += u1 ? UTF8SKIP(p1) : 1;
3493 p2 += u2 ? UTF8SKIP(p2) : 1;
3495 } /* End of loop through both strings */
3497 /* A match is defined by each scan that specified an explicit length
3498 * reaching its final goal, and the other not having matched a partial
3499 * character (which can happen when the fold of a character is more than one
3501 if (! ((g1 == 0 || p1 == g1) && (g2 == 0 || p2 == g2)) || n1 || n2) {
3505 /* Successful match. Set output pointers */
3517 * c-indentation-style: bsd
3519 * indent-tabs-mode: t
3522 * ex: set ts=8 sts=4 sw=4 noet: