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
34 #include "inline_invlist.c"
35 #include "charclass_invlists.h"
37 static const char unees[] =
38 "Malformed UTF-8 character (unexpected end of string)";
41 =head1 Unicode Support
42 These are various utility functions for manipulating UTF8-encoded
43 strings. For the uninitiated, this is a method of representing arbitrary
44 Unicode characters as a variable number of bytes, in such a way that
45 characters in the ASCII range are unmodified, and a zero byte never appears
46 within non-zero characters.
52 =for apidoc is_ascii_string
54 Returns true if the first C<len> bytes of the string C<s> are the same whether
55 or not the string is encoded in UTF-8 (or UTF-EBCDIC on EBCDIC machines). That
56 is, if they are invariant. On ASCII-ish machines, only ASCII characters
57 fit this definition, hence the function's name.
59 If C<len> is 0, it will be calculated using C<strlen(s)>, (which means if you
60 use this option, that C<s> can't have embedded C<NUL> characters and has to
61 have a terminating C<NUL> byte).
63 See also L</is_utf8_string>(), L</is_utf8_string_loclen>(), and L</is_utf8_string_loc>().
69 Perl_is_ascii_string(const U8 *s, STRLEN len)
71 const U8* const send = s + (len ? len : strlen((const char *)s));
74 PERL_ARGS_ASSERT_IS_ASCII_STRING;
76 for (; x < send; ++x) {
77 if (!UTF8_IS_INVARIANT(*x))
85 =for apidoc uvoffuni_to_utf8_flags
87 THIS FUNCTION SHOULD BE USED IN ONLY VERY SPECIALIZED CIRCUMSTANCES.
88 Instead, B<Almost all code should use L</uvchr_to_utf8> or
89 L</uvchr_to_utf8_flags>>.
91 This function is like them, but the input is a strict Unicode
92 (as opposed to native) code point. Only in very rare circumstances should code
93 not be using the native code point.
95 For details, see the description for L</uvchr_to_utf8_flags>>.
101 Perl_uvoffuni_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
103 PERL_ARGS_ASSERT_UVOFFUNI_TO_UTF8_FLAGS;
105 if (UNI_IS_INVARIANT(uv)) {
106 *d++ = (U8) LATIN1_TO_NATIVE(uv);
111 /* Not representable in UTF-EBCDIC */
112 flags |= UNICODE_DISALLOW_FE_FF;
115 /* The first problematic code point is the first surrogate */
116 if (uv >= UNICODE_SURROGATE_FIRST
117 && ckWARN3_d(WARN_SURROGATE, WARN_NON_UNICODE, WARN_NONCHAR))
119 if (UNICODE_IS_SURROGATE(uv)) {
120 if (flags & UNICODE_WARN_SURROGATE) {
121 Perl_ck_warner_d(aTHX_ packWARN(WARN_SURROGATE),
122 "UTF-16 surrogate U+%04"UVXf, uv);
124 if (flags & UNICODE_DISALLOW_SURROGATE) {
128 else if (UNICODE_IS_SUPER(uv)) {
129 if (flags & UNICODE_WARN_SUPER
130 || (UNICODE_IS_FE_FF(uv) && (flags & UNICODE_WARN_FE_FF)))
132 Perl_ck_warner_d(aTHX_ packWARN(WARN_NON_UNICODE),
133 "Code point 0x%04"UVXf" is not Unicode, may not be portable", uv);
135 if (flags & UNICODE_DISALLOW_SUPER
136 || (UNICODE_IS_FE_FF(uv) && (flags & UNICODE_DISALLOW_FE_FF)))
139 Perl_die(aTHX_ "Can't represent character for Ox%"UVXf" on this platform", uv);
145 else if (UNICODE_IS_NONCHAR(uv)) {
146 if (flags & UNICODE_WARN_NONCHAR) {
147 Perl_ck_warner_d(aTHX_ packWARN(WARN_NONCHAR),
148 "Unicode non-character U+%04"UVXf" is illegal for open interchange",
151 if (flags & UNICODE_DISALLOW_NONCHAR) {
159 STRLEN len = OFFUNISKIP(uv);
162 *p-- = (U8) I8_TO_NATIVE_UTF8((uv & UTF_CONTINUATION_MASK) | UTF_CONTINUATION_MARK);
163 uv >>= UTF_ACCUMULATION_SHIFT;
165 *p = (U8) I8_TO_NATIVE_UTF8((uv & UTF_START_MASK(len)) | UTF_START_MARK(len));
168 #else /* Non loop style */
170 *d++ = (U8)(( uv >> 6) | 0xc0);
171 *d++ = (U8)(( uv & 0x3f) | 0x80);
175 *d++ = (U8)(( uv >> 12) | 0xe0);
176 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
177 *d++ = (U8)(( uv & 0x3f) | 0x80);
181 *d++ = (U8)(( uv >> 18) | 0xf0);
182 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
183 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
184 *d++ = (U8)(( uv & 0x3f) | 0x80);
187 if (uv < 0x4000000) {
188 *d++ = (U8)(( uv >> 24) | 0xf8);
189 *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
190 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
191 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
192 *d++ = (U8)(( uv & 0x3f) | 0x80);
195 if (uv < 0x80000000) {
196 *d++ = (U8)(( uv >> 30) | 0xfc);
197 *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
198 *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
199 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
200 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
201 *d++ = (U8)(( uv & 0x3f) | 0x80);
205 if (uv < UTF8_QUAD_MAX)
208 *d++ = 0xfe; /* Can't match U+FEFF! */
209 *d++ = (U8)(((uv >> 30) & 0x3f) | 0x80);
210 *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
211 *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
212 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
213 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
214 *d++ = (U8)(( uv & 0x3f) | 0x80);
219 *d++ = 0xff; /* Can't match U+FFFE! */
220 *d++ = 0x80; /* 6 Reserved bits */
221 *d++ = (U8)(((uv >> 60) & 0x0f) | 0x80); /* 2 Reserved bits */
222 *d++ = (U8)(((uv >> 54) & 0x3f) | 0x80);
223 *d++ = (U8)(((uv >> 48) & 0x3f) | 0x80);
224 *d++ = (U8)(((uv >> 42) & 0x3f) | 0x80);
225 *d++ = (U8)(((uv >> 36) & 0x3f) | 0x80);
226 *d++ = (U8)(((uv >> 30) & 0x3f) | 0x80);
227 *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
228 *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
229 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
230 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
231 *d++ = (U8)(( uv & 0x3f) | 0x80);
235 #endif /* Non loop style */
238 =for apidoc uvchr_to_utf8
240 Adds the UTF-8 representation of the native code point C<uv> to the end
241 of the string C<d>; C<d> should have at least C<UNISKIP(uv)+1> (up to
242 C<UTF8_MAXBYTES+1>) free bytes available. The return value is the pointer to
243 the byte after the end of the new character. In other words,
245 d = uvchr_to_utf8(d, uv);
247 is the recommended wide native character-aware way of saying
251 This function accepts any UV as input. To forbid or warn on non-Unicode code
252 points, or those that may be problematic, see L</uvchr_to_utf8_flags>.
257 /* This is also a macro */
258 PERL_CALLCONV U8* Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv);
261 Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv)
263 return uvchr_to_utf8(d, uv);
267 =for apidoc uvchr_to_utf8_flags
269 Adds the UTF-8 representation of the native code point C<uv> to the end
270 of the string C<d>; C<d> should have at least C<UNISKIP(uv)+1> (up to
271 C<UTF8_MAXBYTES+1>) free bytes available. The return value is the pointer to
272 the byte after the end of the new character. In other words,
274 d = uvchr_to_utf8_flags(d, uv, flags);
278 d = uvchr_to_utf8_flags(d, uv, 0);
280 This is the Unicode-aware way of saying
284 This function will convert to UTF-8 (and not warn) even code points that aren't
285 legal Unicode or are problematic, unless C<flags> contains one or more of the
288 If C<uv> is a Unicode surrogate code point and UNICODE_WARN_SURROGATE is set,
289 the function will raise a warning, provided UTF8 warnings are enabled. If instead
290 UNICODE_DISALLOW_SURROGATE is set, the function will fail and return NULL.
291 If both flags are set, the function will both warn and return NULL.
293 The UNICODE_WARN_NONCHAR and UNICODE_DISALLOW_NONCHAR flags
294 affect how the function handles a Unicode non-character. And likewise, the
295 UNICODE_WARN_SUPER and UNICODE_DISALLOW_SUPER flags affect the handling of
297 above the Unicode maximum of 0x10FFFF. Code points above 0x7FFF_FFFF (which are
298 even less portable) can be warned and/or disallowed even if other above-Unicode
299 code points are accepted, by the UNICODE_WARN_FE_FF and UNICODE_DISALLOW_FE_FF
302 And finally, the flag UNICODE_WARN_ILLEGAL_INTERCHANGE selects all four of the
303 above WARN flags; and UNICODE_DISALLOW_ILLEGAL_INTERCHANGE selects all four
309 /* This is also a macro */
310 PERL_CALLCONV U8* Perl_uvchr_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags);
313 Perl_uvchr_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
315 return uvchr_to_utf8_flags(d, uv, flags);
319 =for apidoc is_utf8_char_buf
321 This is identical to the macro L</isUTF8_CHAR>.
326 Perl_is_utf8_char_buf(const U8 *buf, const U8* buf_end)
329 PERL_ARGS_ASSERT_IS_UTF8_CHAR_BUF;
331 return isUTF8_CHAR(buf, buf_end);
335 =for apidoc is_utf8_string
337 Returns true if the first C<len> bytes of string C<s> form a valid
338 UTF-8 string, false otherwise. If C<len> is 0, it will be calculated
339 using C<strlen(s)> (which means if you use this option, that C<s> can't have
340 embedded C<NUL> characters and has to have a terminating C<NUL> byte). Note
341 that all characters being ASCII constitute 'a valid UTF-8 string'.
343 See also L</is_ascii_string>(), L</is_utf8_string_loclen>(), and L</is_utf8_string_loc>().
349 Perl_is_utf8_string(const U8 *s, STRLEN len)
351 const U8* const send = s + (len ? len : strlen((const char *)s));
354 PERL_ARGS_ASSERT_IS_UTF8_STRING;
357 STRLEN len = isUTF8_CHAR(x, send);
358 if (UNLIKELY(! len)) {
368 Implemented as a macro in utf8.h
370 =for apidoc is_utf8_string_loc
372 Like L</is_utf8_string> but stores the location of the failure (in the
373 case of "utf8ness failure") or the location C<s>+C<len> (in the case of
374 "utf8ness success") in the C<ep>.
376 See also L</is_utf8_string_loclen>() and L</is_utf8_string>().
378 =for apidoc is_utf8_string_loclen
380 Like L</is_utf8_string>() but stores the location of the failure (in the
381 case of "utf8ness failure") or the location C<s>+C<len> (in the case of
382 "utf8ness success") in the C<ep>, and the number of UTF-8
383 encoded characters in the C<el>.
385 See also L</is_utf8_string_loc>() and L</is_utf8_string>().
391 Perl_is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
393 const U8* const send = s + (len ? len : strlen((const char *)s));
397 PERL_ARGS_ASSERT_IS_UTF8_STRING_LOCLEN;
400 STRLEN len = isUTF8_CHAR(x, send);
401 if (UNLIKELY(! len)) {
419 =for apidoc utf8n_to_uvchr
421 THIS FUNCTION SHOULD BE USED IN ONLY VERY SPECIALIZED CIRCUMSTANCES.
422 Most code should use L</utf8_to_uvchr_buf>() rather than call this directly.
424 Bottom level UTF-8 decode routine.
425 Returns the native code point value of the first character in the string C<s>,
426 which is assumed to be in UTF-8 (or UTF-EBCDIC) encoding, and no longer than
427 C<curlen> bytes; C<*retlen> (if C<retlen> isn't NULL) will be set to
428 the length, in bytes, of that character.
430 The value of C<flags> determines the behavior when C<s> does not point to a
431 well-formed UTF-8 character. If C<flags> is 0, when a malformation is found,
432 zero is returned and C<*retlen> is set so that (S<C<s> + C<*retlen>>) is the
433 next possible position in C<s> that could begin a non-malformed character.
434 Also, if UTF-8 warnings haven't been lexically disabled, a warning is raised.
436 Various ALLOW flags can be set in C<flags> to allow (and not warn on)
437 individual types of malformations, such as the sequence being overlong (that
438 is, when there is a shorter sequence that can express the same code point;
439 overlong sequences are expressly forbidden in the UTF-8 standard due to
440 potential security issues). Another malformation example is the first byte of
441 a character not being a legal first byte. See F<utf8.h> for the list of such
442 flags. For allowed 0 length strings, this function returns 0; for allowed
443 overlong sequences, the computed code point is returned; for all other allowed
444 malformations, the Unicode REPLACEMENT CHARACTER is returned, as these have no
445 determinable reasonable value.
447 The UTF8_CHECK_ONLY flag overrides the behavior when a non-allowed (by other
448 flags) malformation is found. If this flag is set, the routine assumes that
449 the caller will raise a warning, and this function will silently just set
450 C<retlen> to C<-1> (cast to C<STRLEN>) and return zero.
452 Note that this API requires disambiguation between successful decoding a C<NUL>
453 character, and an error return (unless the UTF8_CHECK_ONLY flag is set), as
454 in both cases, 0 is returned. To disambiguate, upon a zero return, see if the
455 first byte of C<s> is 0 as well. If so, the input was a C<NUL>; if not, the
458 Certain code points are considered problematic. These are Unicode surrogates,
459 Unicode non-characters, and code points above the Unicode maximum of 0x10FFFF.
460 By default these are considered regular code points, but certain situations
461 warrant special handling for them. If C<flags> contains
462 UTF8_DISALLOW_ILLEGAL_INTERCHANGE, all three classes are treated as
463 malformations and handled as such. The flags UTF8_DISALLOW_SURROGATE,
464 UTF8_DISALLOW_NONCHAR, and UTF8_DISALLOW_SUPER (meaning above the legal Unicode
465 maximum) can be set to disallow these categories individually.
467 The flags UTF8_WARN_ILLEGAL_INTERCHANGE, UTF8_WARN_SURROGATE,
468 UTF8_WARN_NONCHAR, and UTF8_WARN_SUPER will cause warning messages to be raised
469 for their respective categories, but otherwise the code points are considered
470 valid (not malformations). To get a category to both be treated as a
471 malformation and raise a warning, specify both the WARN and DISALLOW flags.
472 (But note that warnings are not raised if lexically disabled nor if
473 UTF8_CHECK_ONLY is also specified.)
475 Very large code points (above 0x7FFF_FFFF) are considered more problematic than
476 the others that are above the Unicode legal maximum. There are several
477 reasons: they requre at least 32 bits to represent them on ASCII platforms, are
478 not representable at all on EBCDIC platforms, and the original UTF-8
479 specification never went above this number (the current 0x10FFFF limit was
480 imposed later). (The smaller ones, those that fit into 32 bits, are
481 representable by a UV on ASCII platforms, but not by an IV, which means that
482 the number of operations that can be performed on them is quite restricted.)
483 The UTF-8 encoding on ASCII platforms for these large code points begins with a
484 byte containing 0xFE or 0xFF. The UTF8_DISALLOW_FE_FF flag will cause them to
485 be treated as malformations, while allowing smaller above-Unicode code points.
486 (Of course UTF8_DISALLOW_SUPER will treat all above-Unicode code points,
487 including these, as malformations.)
488 Similarly, UTF8_WARN_FE_FF acts just like
489 the other WARN flags, but applies just to these code points.
491 All other code points corresponding to Unicode characters, including private
492 use and those yet to be assigned, are never considered malformed and never
499 Perl_utf8n_to_uvchr(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
501 const U8 * const s0 = s;
502 U8 overflow_byte = '\0'; /* Save byte in case of overflow */
507 UV outlier_ret = 0; /* return value when input is in error or problematic
509 UV pack_warn = 0; /* Save result of packWARN() for later */
510 bool unexpected_non_continuation = FALSE;
511 bool overflowed = FALSE;
512 bool do_overlong_test = TRUE; /* May have to skip this test */
514 const char* const malformed_text = "Malformed UTF-8 character";
516 PERL_ARGS_ASSERT_UTF8N_TO_UVCHR;
518 /* The order of malformation tests here is important. We should consume as
519 * few bytes as possible in order to not skip any valid character. This is
520 * required by the Unicode Standard (section 3.9 of Unicode 6.0); see also
521 * http://unicode.org/reports/tr36 for more discussion as to why. For
522 * example, once we've done a UTF8SKIP, we can tell the expected number of
523 * bytes, and could fail right off the bat if the input parameters indicate
524 * that there are too few available. But it could be that just that first
525 * byte is garbled, and the intended character occupies fewer bytes. If we
526 * blindly assumed that the first byte is correct, and skipped based on
527 * that number, we could skip over a valid input character. So instead, we
528 * always examine the sequence byte-by-byte.
530 * We also should not consume too few bytes, otherwise someone could inject
531 * things. For example, an input could be deliberately designed to
532 * overflow, and if this code bailed out immediately upon discovering that,
533 * returning to the caller C<*retlen> pointing to the very next byte (one
534 * which is actually part of of the overflowing sequence), that could look
535 * legitimate to the caller, which could discard the initial partial
536 * sequence and process the rest, inappropriately */
538 /* Zero length strings, if allowed, of necessity are zero */
539 if (UNLIKELY(curlen == 0)) {
544 if (flags & UTF8_ALLOW_EMPTY) {
547 if (! (flags & UTF8_CHECK_ONLY)) {
548 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "%s (empty string)", malformed_text));
553 expectlen = UTF8SKIP(s);
555 /* A well-formed UTF-8 character, as the vast majority of calls to this
556 * function will be for, has this expected length. For efficiency, set
557 * things up here to return it. It will be overriden only in those rare
558 * cases where a malformation is found */
563 /* An invariant is trivially well-formed */
564 if (UTF8_IS_INVARIANT(uv)) {
568 /* A continuation character can't start a valid sequence */
569 if (UNLIKELY(UTF8_IS_CONTINUATION(uv))) {
570 if (flags & UTF8_ALLOW_CONTINUATION) {
574 return UNICODE_REPLACEMENT;
577 if (! (flags & UTF8_CHECK_ONLY)) {
578 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "%s (unexpected continuation byte 0x%02x, with no preceding start byte)", malformed_text, *s0));
584 /* Here is not a continuation byte, nor an invariant. The only thing left
585 * is a start byte (possibly for an overlong) */
588 uv = NATIVE_UTF8_TO_I8(uv);
591 /* Remove the leading bits that indicate the number of bytes in the
592 * character's whole UTF-8 sequence, leaving just the bits that are part of
594 uv &= UTF_START_MASK(expectlen);
596 /* Now, loop through the remaining bytes in the character's sequence,
597 * accumulating each into the working value as we go. Be sure to not look
598 * past the end of the input string */
599 send = (U8*) s0 + ((expectlen <= curlen) ? expectlen : curlen);
601 for (s = s0 + 1; s < send; s++) {
602 if (LIKELY(UTF8_IS_CONTINUATION(*s))) {
603 #ifndef EBCDIC /* Can't overflow in EBCDIC */
604 if (uv & UTF_ACCUMULATION_OVERFLOW_MASK) {
606 /* The original implementors viewed this malformation as more
607 * serious than the others (though I, khw, don't understand
608 * why, since other malformations also give very very wrong
609 * results), so there is no way to turn off checking for it.
610 * Set a flag, but keep going in the loop, so that we absorb
611 * the rest of the bytes that comprise the character. */
613 overflow_byte = *s; /* Save for warning message's use */
616 uv = UTF8_ACCUMULATE(uv, *s);
619 /* Here, found a non-continuation before processing all expected
620 * bytes. This byte begins a new character, so quit, even if
621 * allowing this malformation. */
622 unexpected_non_continuation = TRUE;
625 } /* End of loop through the character's bytes */
627 /* Save how many bytes were actually in the character */
630 /* The loop above finds two types of malformations: non-continuation and/or
631 * overflow. The non-continuation malformation is really a too-short
632 * malformation, as it means that the current character ended before it was
633 * expected to (being terminated prematurely by the beginning of the next
634 * character, whereas in the too-short malformation there just are too few
635 * bytes available to hold the character. In both cases, the check below
636 * that we have found the expected number of bytes would fail if executed.)
637 * Thus the non-continuation malformation is really unnecessary, being a
638 * subset of the too-short malformation. But there may be existing
639 * applications that are expecting the non-continuation type, so we retain
640 * it, and return it in preference to the too-short malformation. (If this
641 * code were being written from scratch, the two types might be collapsed
642 * into one.) I, khw, am also giving priority to returning the
643 * non-continuation and too-short malformations over overflow when multiple
644 * ones are present. I don't know of any real reason to prefer one over
645 * the other, except that it seems to me that multiple-byte errors trumps
646 * errors from a single byte */
647 if (UNLIKELY(unexpected_non_continuation)) {
648 if (!(flags & UTF8_ALLOW_NON_CONTINUATION)) {
649 if (! (flags & UTF8_CHECK_ONLY)) {
651 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "%s (unexpected non-continuation byte 0x%02x, immediately after start byte 0x%02x)", malformed_text, *s, *s0));
654 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "%s (unexpected non-continuation byte 0x%02x, %d bytes after start byte 0x%02x, expected %d bytes)", malformed_text, *s, (int) curlen, *s0, (int)expectlen));
659 uv = UNICODE_REPLACEMENT;
661 /* Skip testing for overlongs, as the REPLACEMENT may not be the same
662 * as what the original expectations were. */
663 do_overlong_test = FALSE;
668 else if (UNLIKELY(curlen < expectlen)) {
669 if (! (flags & UTF8_ALLOW_SHORT)) {
670 if (! (flags & UTF8_CHECK_ONLY)) {
671 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "%s (%d byte%s, need %d, after start byte 0x%02x)", malformed_text, (int)curlen, curlen == 1 ? "" : "s", (int)expectlen, *s0));
675 uv = UNICODE_REPLACEMENT;
676 do_overlong_test = FALSE;
682 #ifndef EBCDIC /* EBCDIC can't overflow */
683 if (UNLIKELY(overflowed)) {
684 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "%s (overflow at byte 0x%02x, after start byte 0x%02x)", malformed_text, overflow_byte, *s0));
690 && expectlen > (STRLEN) OFFUNISKIP(uv)
691 && ! (flags & UTF8_ALLOW_LONG))
693 /* The overlong malformation has lower precedence than the others.
694 * Note that if this malformation is allowed, we return the actual
695 * value, instead of the replacement character. This is because this
696 * value is actually well-defined. */
697 if (! (flags & UTF8_CHECK_ONLY)) {
698 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "%s (%d byte%s, need %d, after start byte 0x%02x)", malformed_text, (int)expectlen, expectlen == 1 ? "": "s", OFFUNISKIP(uv), *s0));
703 /* Here, the input is considered to be well-formed, but it still could be a
704 * problematic code point that is not allowed by the input parameters. */
705 if (uv >= UNICODE_SURROGATE_FIRST /* isn't problematic if < this */
706 && (flags & (UTF8_DISALLOW_ILLEGAL_INTERCHANGE
707 |UTF8_WARN_ILLEGAL_INTERCHANGE)))
709 if (UNICODE_IS_SURROGATE(uv)) {
711 /* By adding UTF8_CHECK_ONLY to the test, we avoid unnecessary
712 * generation of the sv, since no warnings are raised under CHECK */
713 if ((flags & (UTF8_WARN_SURROGATE|UTF8_CHECK_ONLY)) == UTF8_WARN_SURROGATE
714 && ckWARN_d(WARN_SURROGATE))
716 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "UTF-16 surrogate U+%04"UVXf"", uv));
717 pack_warn = packWARN(WARN_SURROGATE);
719 if (flags & UTF8_DISALLOW_SURROGATE) {
723 else if ((uv > PERL_UNICODE_MAX)) {
724 if ((flags & (UTF8_WARN_SUPER|UTF8_CHECK_ONLY)) == UTF8_WARN_SUPER
725 && ckWARN_d(WARN_NON_UNICODE))
727 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "Code point 0x%04"UVXf" is not Unicode, may not be portable", uv));
728 pack_warn = packWARN(WARN_NON_UNICODE);
730 #ifndef EBCDIC /* EBCDIC always allows FE, FF */
732 /* The first byte being 0xFE or 0xFF is a subset of the SUPER code
733 * points. We test for these after the regular SUPER ones, and
734 * before possibly bailing out, so that the more dire warning
735 * overrides the regular one, if applicable */
736 if ((*s0 & 0xFE) == 0xFE /* matches both FE, FF */
737 && (flags & (UTF8_WARN_FE_FF|UTF8_DISALLOW_FE_FF)))
739 if ((flags & (UTF8_WARN_FE_FF|UTF8_CHECK_ONLY))
741 && ckWARN_d(WARN_UTF8))
743 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "Code point 0x%"UVXf" is not Unicode, and not portable", uv));
744 pack_warn = packWARN(WARN_UTF8);
746 if (flags & UTF8_DISALLOW_FE_FF) {
751 if (flags & UTF8_DISALLOW_SUPER) {
755 else if (UNICODE_IS_NONCHAR(uv)) {
756 if ((flags & (UTF8_WARN_NONCHAR|UTF8_CHECK_ONLY)) == UTF8_WARN_NONCHAR
757 && ckWARN_d(WARN_NONCHAR))
759 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "Unicode non-character U+%04"UVXf" is illegal for open interchange", uv));
760 pack_warn = packWARN(WARN_NONCHAR);
762 if (flags & UTF8_DISALLOW_NONCHAR) {
768 outlier_ret = uv; /* Note we don't bother to convert to native,
769 as all the outlier code points are the same
770 in both ASCII and EBCDIC */
774 /* Here, this is not considered a malformed character, so drop through
778 return UNI_TO_NATIVE(uv);
780 /* There are three cases which get to beyond this point. In all 3 cases:
781 * <sv> if not null points to a string to print as a warning.
782 * <curlen> is what <*retlen> should be set to if UTF8_CHECK_ONLY isn't
784 * <outlier_ret> is what return value to use if UTF8_CHECK_ONLY isn't set.
785 * This is done by initializing it to 0, and changing it only
788 * 1) The input is valid but problematic, and to be warned about. The
789 * return value is the resultant code point; <*retlen> is set to
790 * <curlen>, the number of bytes that comprise the code point.
791 * <pack_warn> contains the result of packWARN() for the warning
792 * types. The entry point for this case is the label <do_warn>;
793 * 2) The input is a valid code point but disallowed by the parameters to
794 * this function. The return value is 0. If UTF8_CHECK_ONLY is set,
795 * <*relen> is -1; otherwise it is <curlen>, the number of bytes that
796 * comprise the code point. <pack_warn> contains the result of
797 * packWARN() for the warning types. The entry point for this case is
798 * the label <disallowed>.
799 * 3) The input is malformed. The return value is 0. If UTF8_CHECK_ONLY
800 * is set, <*relen> is -1; otherwise it is <curlen>, the number of
801 * bytes that comprise the malformation. All such malformations are
802 * assumed to be warning type <utf8>. The entry point for this case
803 * is the label <malformed>.
808 if (sv && ckWARN_d(WARN_UTF8)) {
809 pack_warn = packWARN(WARN_UTF8);
814 if (flags & UTF8_CHECK_ONLY) {
816 *retlen = ((STRLEN) -1);
822 if (pack_warn) { /* <pack_warn> was initialized to 0, and changed only
823 if warnings are to be raised. */
824 const char * const string = SvPVX_const(sv);
827 Perl_warner(aTHX_ pack_warn, "%s in %s", string, OP_DESC(PL_op));
829 Perl_warner(aTHX_ pack_warn, "%s", string);
840 =for apidoc utf8_to_uvchr_buf
842 Returns the native code point of the first character in the string C<s> which
843 is assumed to be in UTF-8 encoding; C<send> points to 1 beyond the end of C<s>.
844 C<*retlen> will be set to the length, in bytes, of that character.
846 If C<s> does not point to a well-formed UTF-8 character and UTF8 warnings are
847 enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
848 NULL) to -1. If those warnings are off, the computed value, if well-defined
849 (or the Unicode REPLACEMENT CHARACTER if not), is silently returned, and
850 C<*retlen> is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is
851 the next possible position in C<s> that could begin a non-malformed character.
852 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is
860 Perl_utf8_to_uvchr_buf(pTHX_ const U8 *s, const U8 *send, STRLEN *retlen)
864 return utf8n_to_uvchr(s, send - s, retlen,
865 ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY);
868 /* Like L</utf8_to_uvchr_buf>(), but should only be called when it is known that
869 * there are no malformations in the input UTF-8 string C<s>. surrogates,
870 * non-character code points, and non-Unicode code points are allowed. */
873 Perl_valid_utf8_to_uvchr(pTHX_ const U8 *s, STRLEN *retlen)
875 UV expectlen = UTF8SKIP(s);
876 const U8* send = s + expectlen;
879 PERL_ARGS_ASSERT_VALID_UTF8_TO_UVCHR;
886 /* An invariant is trivially returned */
887 if (expectlen == 1) {
892 uv = NATIVE_UTF8_TO_I8(uv);
895 /* Remove the leading bits that indicate the number of bytes, leaving just
896 * the bits that are part of the value */
897 uv &= UTF_START_MASK(expectlen);
899 /* Now, loop through the remaining bytes, accumulating each into the
900 * working total as we go. (I khw tried unrolling the loop for up to 4
901 * bytes, but there was no performance improvement) */
902 for (++s; s < send; s++) {
903 uv = UTF8_ACCUMULATE(uv, *s);
906 return UNI_TO_NATIVE(uv);
911 =for apidoc utf8_to_uvuni_buf
913 Only in very rare circumstances should code need to be dealing in Unicode
914 (as opposed to native) code points. In those few cases, use
915 C<L<NATIVE_TO_UNI(utf8_to_uvchr_buf(...))|/utf8_to_uvchr_buf>> instead.
917 Returns the Unicode (not-native) code point of the first character in the
919 is assumed to be in UTF-8 encoding; C<send> points to 1 beyond the end of C<s>.
920 C<retlen> will be set to the length, in bytes, of that character.
922 If C<s> does not point to a well-formed UTF-8 character and UTF8 warnings are
923 enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
924 NULL) to -1. If those warnings are off, the computed value if well-defined (or
925 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
926 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
927 next possible position in C<s> that could begin a non-malformed character.
928 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
934 Perl_utf8_to_uvuni_buf(pTHX_ const U8 *s, const U8 *send, STRLEN *retlen)
936 PERL_ARGS_ASSERT_UTF8_TO_UVUNI_BUF;
940 /* Call the low level routine asking for checks */
941 return NATIVE_TO_UNI(Perl_utf8n_to_uvchr(aTHX_ s, send -s, retlen,
942 ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY));
946 =for apidoc utf8_length
948 Return the length of the UTF-8 char encoded string C<s> in characters.
949 Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
950 up past C<e>, croaks.
956 Perl_utf8_length(pTHX_ const U8 *s, const U8 *e)
960 PERL_ARGS_ASSERT_UTF8_LENGTH;
962 /* Note: cannot use UTF8_IS_...() too eagerly here since e.g.
963 * the bitops (especially ~) can create illegal UTF-8.
964 * In other words: in Perl UTF-8 is not just for Unicode. */
967 goto warn_and_return;
977 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
978 "%s in %s", unees, OP_DESC(PL_op));
980 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8), "%s", unees);
987 =for apidoc utf8_distance
989 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
992 WARNING: use only if you *know* that the pointers point inside the
999 Perl_utf8_distance(pTHX_ const U8 *a, const U8 *b)
1001 PERL_ARGS_ASSERT_UTF8_DISTANCE;
1003 return (a < b) ? -1 * (IV) utf8_length(a, b) : (IV) utf8_length(b, a);
1007 =for apidoc utf8_hop
1009 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
1010 forward or backward.
1012 WARNING: do not use the following unless you *know* C<off> is within
1013 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
1014 on the first byte of character or just after the last byte of a character.
1020 Perl_utf8_hop(const U8 *s, I32 off)
1022 PERL_ARGS_ASSERT_UTF8_HOP;
1024 /* Note: cannot use UTF8_IS_...() too eagerly here since e.g
1025 * the bitops (especially ~) can create illegal UTF-8.
1026 * In other words: in Perl UTF-8 is not just for Unicode. */
1035 while (UTF8_IS_CONTINUATION(*s))
1043 =for apidoc bytes_cmp_utf8
1045 Compares the sequence of characters (stored as octets) in C<b>, C<blen> with the
1046 sequence of characters (stored as UTF-8)
1047 in C<u>, C<ulen>. Returns 0 if they are
1048 equal, -1 or -2 if the first string is less than the second string, +1 or +2
1049 if the first string is greater than the second string.
1051 -1 or +1 is returned if the shorter string was identical to the start of the
1052 longer string. -2 or +2 is returned if
1053 there was a difference between characters
1060 Perl_bytes_cmp_utf8(pTHX_ const U8 *b, STRLEN blen, const U8 *u, STRLEN ulen)
1062 const U8 *const bend = b + blen;
1063 const U8 *const uend = u + ulen;
1065 PERL_ARGS_ASSERT_BYTES_CMP_UTF8;
1067 while (b < bend && u < uend) {
1069 if (!UTF8_IS_INVARIANT(c)) {
1070 if (UTF8_IS_DOWNGRADEABLE_START(c)) {
1073 if (UTF8_IS_CONTINUATION(c1)) {
1074 c = TWO_BYTE_UTF8_TO_NATIVE(c, c1);
1076 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
1077 "Malformed UTF-8 character "
1078 "(unexpected non-continuation byte 0x%02x"
1079 ", immediately after start byte 0x%02x)"
1080 /* Dear diag.t, it's in the pod. */
1082 PL_op ? " in " : "",
1083 PL_op ? OP_DESC(PL_op) : "");
1088 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
1089 "%s in %s", unees, OP_DESC(PL_op));
1091 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8), "%s", unees);
1092 return -2; /* Really want to return undef :-) */
1099 return *b < c ? -2 : +2;
1104 if (b == bend && u == uend)
1107 return b < bend ? +1 : -1;
1111 =for apidoc utf8_to_bytes
1113 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
1114 Unlike L</bytes_to_utf8>, this over-writes the original string, and
1115 updates C<len> to contain the new length.
1116 Returns zero on failure, setting C<len> to -1.
1118 If you need a copy of the string, see L</bytes_from_utf8>.
1124 Perl_utf8_to_bytes(pTHX_ U8 *s, STRLEN *len)
1126 U8 * const save = s;
1127 U8 * const send = s + *len;
1130 PERL_ARGS_ASSERT_UTF8_TO_BYTES;
1131 PERL_UNUSED_CONTEXT;
1133 /* ensure valid UTF-8 and chars < 256 before updating string */
1135 if (! UTF8_IS_INVARIANT(*s)) {
1136 if (! UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, send)) {
1137 *len = ((STRLEN) -1);
1148 if (! UTF8_IS_INVARIANT(c)) {
1149 /* Then it is two-byte encoded */
1150 c = TWO_BYTE_UTF8_TO_NATIVE(c, *s);
1161 =for apidoc bytes_from_utf8
1163 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
1164 Unlike L</utf8_to_bytes> but like L</bytes_to_utf8>, returns a pointer to
1165 the newly-created string, and updates C<len> to contain the new
1166 length. Returns the original string if no conversion occurs, C<len>
1167 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
1168 0 if C<s> is converted or consisted entirely of characters that are invariant
1169 in utf8 (i.e., US-ASCII on non-EBCDIC machines).
1175 Perl_bytes_from_utf8(pTHX_ const U8 *s, STRLEN *len, bool *is_utf8)
1178 const U8 *start = s;
1182 PERL_ARGS_ASSERT_BYTES_FROM_UTF8;
1183 PERL_UNUSED_CONTEXT;
1187 /* ensure valid UTF-8 and chars < 256 before converting string */
1188 for (send = s + *len; s < send;) {
1189 if (! UTF8_IS_INVARIANT(*s)) {
1190 if (! UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, send)) {
1201 Newx(d, (*len) - count + 1, U8);
1202 s = start; start = d;
1205 if (! UTF8_IS_INVARIANT(c)) {
1206 /* Then it is two-byte encoded */
1207 c = TWO_BYTE_UTF8_TO_NATIVE(c, *s);
1218 =for apidoc bytes_to_utf8
1220 Converts a string C<s> of length C<len> bytes from the native encoding into
1222 Returns a pointer to the newly-created string, and sets C<len> to
1223 reflect the new length in bytes.
1225 A C<NUL> character will be written after the end of the string.
1227 If you want to convert to UTF-8 from encodings other than
1228 the native (Latin1 or EBCDIC),
1229 see L</sv_recode_to_utf8>().
1234 /* This logic is duplicated in sv_catpvn_flags, so any bug fixes will
1235 likewise need duplication. */
1238 Perl_bytes_to_utf8(pTHX_ const U8 *s, STRLEN *len)
1240 const U8 * const send = s + (*len);
1244 PERL_ARGS_ASSERT_BYTES_TO_UTF8;
1245 PERL_UNUSED_CONTEXT;
1247 Newx(d, (*len) * 2 + 1, U8);
1251 append_utf8_from_native_byte(*s, &d);
1260 * Convert native (big-endian) or reversed (little-endian) UTF-16 to UTF-8.
1262 * Destination must be pre-extended to 3/2 source. Do not use in-place.
1263 * We optimize for native, for obvious reasons. */
1266 Perl_utf16_to_utf8(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
1271 PERL_ARGS_ASSERT_UTF16_TO_UTF8;
1274 Perl_croak(aTHX_ "panic: utf16_to_utf8: odd bytelen %"UVuf, (UV)bytelen);
1279 UV uv = (p[0] << 8) + p[1]; /* UTF-16BE */
1281 if (UNI_IS_INVARIANT(uv)) {
1282 *d++ = LATIN1_TO_NATIVE((U8) uv);
1285 if (uv <= MAX_UTF8_TWO_BYTE) {
1286 *d++ = UTF8_TWO_BYTE_HI(UNI_TO_NATIVE(uv));
1287 *d++ = UTF8_TWO_BYTE_LO(UNI_TO_NATIVE(uv));
1290 #define FIRST_HIGH_SURROGATE UNICODE_SURROGATE_FIRST
1291 #define LAST_HIGH_SURROGATE 0xDBFF
1292 #define FIRST_LOW_SURROGATE 0xDC00
1293 #define LAST_LOW_SURROGATE UNICODE_SURROGATE_LAST
1294 if (uv >= FIRST_HIGH_SURROGATE && uv <= LAST_HIGH_SURROGATE) {
1296 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
1298 UV low = (p[0] << 8) + p[1];
1300 if (low < FIRST_LOW_SURROGATE || low > LAST_LOW_SURROGATE)
1301 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
1302 uv = ((uv - FIRST_HIGH_SURROGATE) << 10)
1303 + (low - FIRST_LOW_SURROGATE) + 0x10000;
1305 } else if (uv >= FIRST_LOW_SURROGATE && uv <= LAST_LOW_SURROGATE) {
1306 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
1309 d = uvoffuni_to_utf8_flags(d, uv, 0);
1312 *d++ = (U8)(( uv >> 12) | 0xe0);
1313 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
1314 *d++ = (U8)(( uv & 0x3f) | 0x80);
1318 *d++ = (U8)(( uv >> 18) | 0xf0);
1319 *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
1320 *d++ = (U8)(((uv >> 6) & 0x3f) | 0x80);
1321 *d++ = (U8)(( uv & 0x3f) | 0x80);
1326 *newlen = d - dstart;
1330 /* Note: this one is slightly destructive of the source. */
1333 Perl_utf16_to_utf8_reversed(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
1336 U8* const send = s + bytelen;
1338 PERL_ARGS_ASSERT_UTF16_TO_UTF8_REVERSED;
1341 Perl_croak(aTHX_ "panic: utf16_to_utf8_reversed: odd bytelen %"UVuf,
1345 const U8 tmp = s[0];
1350 return utf16_to_utf8(p, d, bytelen, newlen);
1354 Perl__is_uni_FOO(pTHX_ const U8 classnum, const UV c)
1356 U8 tmpbuf[UTF8_MAXBYTES+1];
1357 uvchr_to_utf8(tmpbuf, c);
1358 return _is_utf8_FOO(classnum, tmpbuf);
1361 /* Internal function so we can deprecate the external one, and call
1362 this one from other deprecated functions in this file */
1365 Perl__is_utf8_idstart(pTHX_ const U8 *p)
1367 PERL_ARGS_ASSERT__IS_UTF8_IDSTART;
1371 return is_utf8_common(p, &PL_utf8_idstart, "IdStart", NULL);
1375 Perl__is_uni_perl_idcont(pTHX_ UV c)
1377 U8 tmpbuf[UTF8_MAXBYTES+1];
1378 uvchr_to_utf8(tmpbuf, c);
1379 return _is_utf8_perl_idcont(tmpbuf);
1383 Perl__is_uni_perl_idstart(pTHX_ UV c)
1385 U8 tmpbuf[UTF8_MAXBYTES+1];
1386 uvchr_to_utf8(tmpbuf, c);
1387 return _is_utf8_perl_idstart(tmpbuf);
1391 Perl__to_upper_title_latin1(pTHX_ const U8 c, U8* p, STRLEN *lenp, const char S_or_s)
1393 /* We have the latin1-range values compiled into the core, so just use
1394 * those, converting the result to utf8. The only difference between upper
1395 * and title case in this range is that LATIN_SMALL_LETTER_SHARP_S is
1396 * either "SS" or "Ss". Which one to use is passed into the routine in
1397 * 'S_or_s' to avoid a test */
1399 UV converted = toUPPER_LATIN1_MOD(c);
1401 PERL_ARGS_ASSERT__TO_UPPER_TITLE_LATIN1;
1403 assert(S_or_s == 'S' || S_or_s == 's');
1405 if (UVCHR_IS_INVARIANT(converted)) { /* No difference between the two for
1406 characters in this range */
1407 *p = (U8) converted;
1412 /* toUPPER_LATIN1_MOD gives the correct results except for three outliers,
1413 * which it maps to one of them, so as to only have to have one check for
1414 * it in the main case */
1415 if (UNLIKELY(converted == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS)) {
1417 case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
1418 converted = LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS;
1421 converted = GREEK_CAPITAL_LETTER_MU;
1423 case LATIN_SMALL_LETTER_SHARP_S:
1429 Perl_croak(aTHX_ "panic: to_upper_title_latin1 did not expect '%c' to map to '%c'", c, LATIN_SMALL_LETTER_Y_WITH_DIAERESIS);
1430 assert(0); /* NOTREACHED */
1434 *(p)++ = UTF8_TWO_BYTE_HI(converted);
1435 *p = UTF8_TWO_BYTE_LO(converted);
1441 /* Call the function to convert a UTF-8 encoded character to the specified case.
1442 * Note that there may be more than one character in the result.
1443 * INP is a pointer to the first byte of the input character
1444 * OUTP will be set to the first byte of the string of changed characters. It
1445 * needs to have space for UTF8_MAXBYTES_CASE+1 bytes
1446 * LENP will be set to the length in bytes of the string of changed characters
1448 * The functions return the ordinal of the first character in the string of OUTP */
1449 #define CALL_UPPER_CASE(INP, OUTP, LENP) Perl_to_utf8_case(aTHX_ INP, OUTP, LENP, &PL_utf8_toupper, "ToUc", "")
1450 #define CALL_TITLE_CASE(INP, OUTP, LENP) Perl_to_utf8_case(aTHX_ INP, OUTP, LENP, &PL_utf8_totitle, "ToTc", "")
1451 #define CALL_LOWER_CASE(INP, OUTP, LENP) Perl_to_utf8_case(aTHX_ INP, OUTP, LENP, &PL_utf8_tolower, "ToLc", "")
1453 /* This additionally has the input parameter SPECIALS, which if non-zero will
1454 * cause this to use the SPECIALS hash for folding (meaning get full case
1455 * folding); otherwise, when zero, this implies a simple case fold */
1456 #define CALL_FOLD_CASE(INP, OUTP, LENP, SPECIALS) Perl_to_utf8_case(aTHX_ INP, OUTP, LENP, &PL_utf8_tofold, "ToCf", (SPECIALS) ? "" : NULL)
1459 Perl_to_uni_upper(pTHX_ UV c, U8* p, STRLEN *lenp)
1461 /* Convert the Unicode character whose ordinal is <c> to its uppercase
1462 * version and store that in UTF-8 in <p> and its length in bytes in <lenp>.
1463 * Note that the <p> needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
1464 * the changed version may be longer than the original character.
1466 * The ordinal of the first character of the changed version is returned
1467 * (but note, as explained above, that there may be more.) */
1469 PERL_ARGS_ASSERT_TO_UNI_UPPER;
1472 return _to_upper_title_latin1((U8) c, p, lenp, 'S');
1475 uvchr_to_utf8(p, c);
1476 return CALL_UPPER_CASE(p, p, lenp);
1480 Perl_to_uni_title(pTHX_ UV c, U8* p, STRLEN *lenp)
1482 PERL_ARGS_ASSERT_TO_UNI_TITLE;
1485 return _to_upper_title_latin1((U8) c, p, lenp, 's');
1488 uvchr_to_utf8(p, c);
1489 return CALL_TITLE_CASE(p, p, lenp);
1493 S_to_lower_latin1(const U8 c, U8* p, STRLEN *lenp)
1495 /* We have the latin1-range values compiled into the core, so just use
1496 * those, converting the result to utf8. Since the result is always just
1497 * one character, we allow <p> to be NULL */
1499 U8 converted = toLOWER_LATIN1(c);
1502 if (NATIVE_BYTE_IS_INVARIANT(converted)) {
1507 /* Result is known to always be < 256, so can use the EIGHT_BIT
1509 *p = UTF8_EIGHT_BIT_HI(converted);
1510 *(p+1) = UTF8_EIGHT_BIT_LO(converted);
1518 Perl_to_uni_lower(pTHX_ UV c, U8* p, STRLEN *lenp)
1520 PERL_ARGS_ASSERT_TO_UNI_LOWER;
1523 return to_lower_latin1((U8) c, p, lenp);
1526 uvchr_to_utf8(p, c);
1527 return CALL_LOWER_CASE(p, p, lenp);
1531 Perl__to_fold_latin1(pTHX_ const U8 c, U8* p, STRLEN *lenp, const unsigned int flags)
1533 /* Corresponds to to_lower_latin1(); <flags> bits meanings:
1534 * FOLD_FLAGS_NOMIX_ASCII iff non-ASCII to ASCII folds are prohibited
1535 * FOLD_FLAGS_FULL iff full folding is to be used;
1537 * Not to be used for locale folds
1542 PERL_ARGS_ASSERT__TO_FOLD_LATIN1;
1543 PERL_UNUSED_CONTEXT;
1545 assert (! (flags & FOLD_FLAGS_LOCALE));
1547 if (c == MICRO_SIGN) {
1548 converted = GREEK_SMALL_LETTER_MU;
1550 else if ((flags & FOLD_FLAGS_FULL) && c == LATIN_SMALL_LETTER_SHARP_S) {
1552 /* If can't cross 127/128 boundary, can't return "ss"; instead return
1553 * two U+017F characters, as fc("\df") should eq fc("\x{17f}\x{17f}")
1554 * under those circumstances. */
1555 if (flags & FOLD_FLAGS_NOMIX_ASCII) {
1556 *lenp = 2 * sizeof(LATIN_SMALL_LETTER_LONG_S_UTF8) - 2;
1557 Copy(LATIN_SMALL_LETTER_LONG_S_UTF8 LATIN_SMALL_LETTER_LONG_S_UTF8,
1559 return LATIN_SMALL_LETTER_LONG_S;
1568 else { /* In this range the fold of all other characters is their lower
1570 converted = toLOWER_LATIN1(c);
1573 if (UVCHR_IS_INVARIANT(converted)) {
1574 *p = (U8) converted;
1578 *(p)++ = UTF8_TWO_BYTE_HI(converted);
1579 *p = UTF8_TWO_BYTE_LO(converted);
1587 Perl__to_uni_fold_flags(pTHX_ UV c, U8* p, STRLEN *lenp, U8 flags)
1590 /* Not currently externally documented, and subject to change
1591 * <flags> bits meanings:
1592 * FOLD_FLAGS_FULL iff full folding is to be used;
1593 * FOLD_FLAGS_LOCALE is set iff the rules from the current underlying
1594 * locale are to be used.
1595 * FOLD_FLAGS_NOMIX_ASCII iff non-ASCII to ASCII folds are prohibited
1598 PERL_ARGS_ASSERT__TO_UNI_FOLD_FLAGS;
1600 /* Tread a UTF-8 locale as not being in locale at all */
1601 if (IN_UTF8_CTYPE_LOCALE) {
1602 flags &= ~FOLD_FLAGS_LOCALE;
1606 UV result = _to_fold_latin1((U8) c, p, lenp,
1607 flags & (FOLD_FLAGS_FULL | FOLD_FLAGS_NOMIX_ASCII));
1608 /* It is illegal for the fold to cross the 255/256 boundary under
1609 * locale; in this case return the original */
1610 return (result > 256 && flags & FOLD_FLAGS_LOCALE)
1615 /* If no special needs, just use the macro */
1616 if ( ! (flags & (FOLD_FLAGS_LOCALE|FOLD_FLAGS_NOMIX_ASCII))) {
1617 uvchr_to_utf8(p, c);
1618 return CALL_FOLD_CASE(p, p, lenp, flags & FOLD_FLAGS_FULL);
1620 else { /* Otherwise, _to_utf8_fold_flags has the intelligence to deal with
1621 the special flags. */
1622 U8 utf8_c[UTF8_MAXBYTES + 1];
1623 uvchr_to_utf8(utf8_c, c);
1624 return _to_utf8_fold_flags(utf8_c, p, lenp, flags);
1628 PERL_STATIC_INLINE bool
1629 S_is_utf8_common(pTHX_ const U8 *const p, SV **swash,
1630 const char *const swashname, SV* const invlist)
1632 /* returns a boolean giving whether or not the UTF8-encoded character that
1633 * starts at <p> is in the swash indicated by <swashname>. <swash>
1634 * contains a pointer to where the swash indicated by <swashname>
1635 * is to be stored; which this routine will do, so that future calls will
1636 * look at <*swash> and only generate a swash if it is not null. <invlist>
1637 * is NULL or an inversion list that defines the swash. If not null, it
1638 * saves time during initialization of the swash.
1640 * Note that it is assumed that the buffer length of <p> is enough to
1641 * contain all the bytes that comprise the character. Thus, <*p> should
1642 * have been checked before this call for mal-formedness enough to assure
1645 PERL_ARGS_ASSERT_IS_UTF8_COMMON;
1647 /* The API should have included a length for the UTF-8 character in <p>,
1648 * but it doesn't. We therefore assume that p has been validated at least
1649 * as far as there being enough bytes available in it to accommodate the
1650 * character without reading beyond the end, and pass that number on to the
1651 * validating routine */
1652 if (! isUTF8_CHAR(p, p + UTF8SKIP(p))) {
1653 if (ckWARN_d(WARN_UTF8)) {
1654 Perl_warner(aTHX_ packWARN2(WARN_DEPRECATED,WARN_UTF8),
1655 "Passing malformed UTF-8 to \"%s\" is deprecated", swashname);
1656 if (ckWARN(WARN_UTF8)) { /* This will output details as to the
1657 what the malformation is */
1658 utf8_to_uvchr_buf(p, p + UTF8SKIP(p), NULL);
1664 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
1665 *swash = _core_swash_init("utf8",
1667 /* Only use the name if there is no inversion
1668 * list; otherwise will go out to disk */
1669 (invlist) ? "" : swashname,
1671 &PL_sv_undef, 1, 0, invlist, &flags);
1674 return swash_fetch(*swash, p, TRUE) != 0;
1678 Perl__is_utf8_FOO(pTHX_ const U8 classnum, const U8 *p)
1680 PERL_ARGS_ASSERT__IS_UTF8_FOO;
1682 assert(classnum < _FIRST_NON_SWASH_CC);
1684 return is_utf8_common(p,
1685 &PL_utf8_swash_ptrs[classnum],
1686 swash_property_names[classnum],
1687 PL_XPosix_ptrs[classnum]);
1691 Perl__is_utf8_perl_idstart(pTHX_ const U8 *p)
1695 PERL_ARGS_ASSERT__IS_UTF8_PERL_IDSTART;
1697 if (! PL_utf8_perl_idstart) {
1698 invlist = _new_invlist_C_array(_Perl_IDStart_invlist);
1700 return is_utf8_common(p, &PL_utf8_perl_idstart, "_Perl_IDStart", invlist);
1704 Perl__is_utf8_xidstart(pTHX_ const U8 *p)
1706 PERL_ARGS_ASSERT__IS_UTF8_XIDSTART;
1710 return is_utf8_common(p, &PL_utf8_xidstart, "XIdStart", NULL);
1714 Perl__is_utf8_perl_idcont(pTHX_ const U8 *p)
1718 PERL_ARGS_ASSERT__IS_UTF8_PERL_IDCONT;
1720 if (! PL_utf8_perl_idcont) {
1721 invlist = _new_invlist_C_array(_Perl_IDCont_invlist);
1723 return is_utf8_common(p, &PL_utf8_perl_idcont, "_Perl_IDCont", invlist);
1727 Perl__is_utf8_idcont(pTHX_ const U8 *p)
1729 PERL_ARGS_ASSERT__IS_UTF8_IDCONT;
1731 return is_utf8_common(p, &PL_utf8_idcont, "IdContinue", NULL);
1735 Perl__is_utf8_xidcont(pTHX_ const U8 *p)
1737 PERL_ARGS_ASSERT__IS_UTF8_XIDCONT;
1739 return is_utf8_common(p, &PL_utf8_idcont, "XIdContinue", NULL);
1743 Perl__is_utf8_mark(pTHX_ const U8 *p)
1745 PERL_ARGS_ASSERT__IS_UTF8_MARK;
1747 return is_utf8_common(p, &PL_utf8_mark, "IsM", NULL);
1751 =for apidoc to_utf8_case
1753 C<p> contains the pointer to the UTF-8 string encoding
1754 the character that is being converted. This routine assumes that the character
1755 at C<p> is well-formed.
1757 C<ustrp> is a pointer to the character buffer to put the
1758 conversion result to. C<lenp> is a pointer to the length
1761 C<swashp> is a pointer to the swash to use.
1763 Both the special and normal mappings are stored in F<lib/unicore/To/Foo.pl>,
1764 and loaded by SWASHNEW, using F<lib/utf8_heavy.pl>. C<special> (usually,
1765 but not always, a multicharacter mapping), is tried first.
1767 C<special> is a string, normally C<NULL> or C<"">. C<NULL> means to not use
1768 any special mappings; C<""> means to use the special mappings. Values other
1769 than these two are treated as the name of the hash containing the special
1770 mappings, like C<"utf8::ToSpecLower">.
1772 C<normal> is a string like "ToLower" which means the swash
1778 Perl_to_utf8_case(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp,
1779 SV **swashp, const char *normal, const char *special)
1782 const UV uv1 = valid_utf8_to_uvchr(p, NULL);
1784 PERL_ARGS_ASSERT_TO_UTF8_CASE;
1786 /* Note that swash_fetch() doesn't output warnings for these because it
1787 * assumes we will */
1788 if (uv1 >= UNICODE_SURROGATE_FIRST) {
1789 if (uv1 <= UNICODE_SURROGATE_LAST) {
1790 if (ckWARN_d(WARN_SURROGATE)) {
1791 const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
1792 Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
1793 "Operation \"%s\" returns its argument for UTF-16 surrogate U+%04"UVXf"", desc, uv1);
1796 else if (UNICODE_IS_SUPER(uv1)) {
1797 if (ckWARN_d(WARN_NON_UNICODE)) {
1798 const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
1799 Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
1800 "Operation \"%s\" returns its argument for non-Unicode code point 0x%04"UVXf"", desc, uv1);
1804 /* Note that non-characters are perfectly legal, so no warning should
1808 if (!*swashp) /* load on-demand */
1809 *swashp = _core_swash_init("utf8", normal, &PL_sv_undef, 4, 0, NULL, NULL);
1812 /* It might be "special" (sometimes, but not always,
1813 * a multicharacter mapping) */
1817 /* If passed in the specials name, use that; otherwise use any
1818 * given in the swash */
1819 if (*special != '\0') {
1820 hv = get_hv(special, 0);
1823 svp = hv_fetchs(MUTABLE_HV(SvRV(*swashp)), "SPECIALS", 0);
1825 hv = MUTABLE_HV(SvRV(*svp));
1830 && (svp = hv_fetch(hv, (const char*)p, UNISKIP(uv1), FALSE))
1835 s = SvPV_const(*svp, len);
1838 len = uvchr_to_utf8(ustrp, *(U8*)s) - ustrp;
1840 Copy(s, ustrp, len, U8);
1845 if (!len && *swashp) {
1846 const UV uv2 = swash_fetch(*swashp, p, TRUE /* => is utf8 */);
1849 /* It was "normal" (a single character mapping). */
1850 len = uvchr_to_utf8(ustrp, uv2) - ustrp;
1858 return valid_utf8_to_uvchr(ustrp, 0);
1861 /* Here, there was no mapping defined, which means that the code point maps
1862 * to itself. Return the inputs */
1864 if (p != ustrp) { /* Don't copy onto itself */
1865 Copy(p, ustrp, len, U8);
1876 S_check_locale_boundary_crossing(pTHX_ const char * const func_name, const U8* const p, const UV result, U8* const ustrp, STRLEN *lenp)
1878 /* This is called when changing the case of a utf8-encoded character above
1879 * the Latin1 range, and the operation is in a non-UTF-8 locale. If the
1880 * result contains a character that crosses the 255/256 boundary, disallow
1881 * the change, and return the original code point. See L<perlfunc/lc> for
1884 * p points to the original string whose case was changed; assumed
1885 * by this routine to be well-formed
1886 * result the code point of the first character in the changed-case string
1887 * ustrp points to the changed-case string (<result> represents its first char)
1888 * lenp points to the length of <ustrp> */
1890 UV original; /* To store the first code point of <p> */
1892 PERL_ARGS_ASSERT_CHECK_LOCALE_BOUNDARY_CROSSING;
1894 assert(UTF8_IS_ABOVE_LATIN1(*p));
1896 /* We know immediately if the first character in the string crosses the
1897 * boundary, so can skip */
1900 /* Look at every character in the result; if any cross the
1901 * boundary, the whole thing is disallowed */
1902 U8* s = ustrp + UTF8SKIP(ustrp);
1903 U8* e = ustrp + *lenp;
1905 if (! UTF8_IS_ABOVE_LATIN1(*s)) {
1911 /* Here, no characters crossed, result is ok as-is */
1917 /* Failed, have to return the original */
1918 original = valid_utf8_to_uvchr(p, lenp);
1920 /* diag_listed_as: Can't do %s("%s") on non-UTF-8 locale; resolved to "%s". */
1921 Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
1922 "Can't do %s(\"\\x{%"UVXf"}\") on non-UTF-8 locale; "
1923 "resolved to \"\\x{%"UVXf"}\".",
1927 Copy(p, ustrp, *lenp, char);
1932 =for apidoc to_utf8_upper
1934 Instead use L</toUPPER_utf8>.
1938 /* Not currently externally documented, and subject to change:
1939 * <flags> is set iff iff the rules from the current underlying locale are to
1943 Perl__to_utf8_upper_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, bool flags)
1947 PERL_ARGS_ASSERT__TO_UTF8_UPPER_FLAGS;
1949 if (flags && IN_UTF8_CTYPE_LOCALE) {
1953 if (UTF8_IS_INVARIANT(*p)) {
1955 result = toUPPER_LC(*p);
1958 return _to_upper_title_latin1(*p, ustrp, lenp, 'S');
1961 else if UTF8_IS_DOWNGRADEABLE_START(*p) {
1963 U8 c = TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1));
1964 result = toUPPER_LC(c);
1967 return _to_upper_title_latin1(TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1)),
1971 else { /* utf8, ord above 255 */
1972 result = CALL_UPPER_CASE(p, ustrp, lenp);
1975 result = check_locale_boundary_crossing("uc", p, result, ustrp, lenp);
1980 /* Here, used locale rules. Convert back to utf8 */
1981 if (UTF8_IS_INVARIANT(result)) {
1982 *ustrp = (U8) result;
1986 *ustrp = UTF8_EIGHT_BIT_HI((U8) result);
1987 *(ustrp + 1) = UTF8_EIGHT_BIT_LO((U8) result);
1995 =for apidoc to_utf8_title
1997 Instead use L</toTITLE_utf8>.
2001 /* Not currently externally documented, and subject to change:
2002 * <flags> is set iff the rules from the current underlying locale are to be
2003 * used. Since titlecase is not defined in POSIX, for other than a
2004 * UTF-8 locale, uppercase is used instead for code points < 256.
2008 Perl__to_utf8_title_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, bool flags)
2012 PERL_ARGS_ASSERT__TO_UTF8_TITLE_FLAGS;
2014 if (flags && IN_UTF8_CTYPE_LOCALE) {
2018 if (UTF8_IS_INVARIANT(*p)) {
2020 result = toUPPER_LC(*p);
2023 return _to_upper_title_latin1(*p, ustrp, lenp, 's');
2026 else if UTF8_IS_DOWNGRADEABLE_START(*p) {
2028 U8 c = TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1));
2029 result = toUPPER_LC(c);
2032 return _to_upper_title_latin1(TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1)),
2036 else { /* utf8, ord above 255 */
2037 result = CALL_TITLE_CASE(p, ustrp, lenp);
2040 result = check_locale_boundary_crossing("ucfirst", p, result, ustrp, lenp);
2045 /* Here, used locale rules. Convert back to utf8 */
2046 if (UTF8_IS_INVARIANT(result)) {
2047 *ustrp = (U8) result;
2051 *ustrp = UTF8_EIGHT_BIT_HI((U8) result);
2052 *(ustrp + 1) = UTF8_EIGHT_BIT_LO((U8) result);
2060 =for apidoc to_utf8_lower
2062 Instead use L</toLOWER_utf8>.
2066 /* Not currently externally documented, and subject to change:
2067 * <flags> is set iff iff the rules from the current underlying locale are to
2072 Perl__to_utf8_lower_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, bool flags)
2076 PERL_ARGS_ASSERT__TO_UTF8_LOWER_FLAGS;
2078 if (flags && IN_UTF8_CTYPE_LOCALE) {
2082 if (UTF8_IS_INVARIANT(*p)) {
2084 result = toLOWER_LC(*p);
2087 return to_lower_latin1(*p, ustrp, lenp);
2090 else if UTF8_IS_DOWNGRADEABLE_START(*p) {
2092 U8 c = TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1));
2093 result = toLOWER_LC(c);
2096 return to_lower_latin1(TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1)),
2100 else { /* utf8, ord above 255 */
2101 result = CALL_LOWER_CASE(p, ustrp, lenp);
2104 result = check_locale_boundary_crossing("lc", p, result, ustrp, lenp);
2110 /* Here, used locale rules. Convert back to utf8 */
2111 if (UTF8_IS_INVARIANT(result)) {
2112 *ustrp = (U8) result;
2116 *ustrp = UTF8_EIGHT_BIT_HI((U8) result);
2117 *(ustrp + 1) = UTF8_EIGHT_BIT_LO((U8) result);
2125 =for apidoc to_utf8_fold
2127 Instead use L</toFOLD_utf8>.
2131 /* Not currently externally documented, and subject to change,
2133 * bit FOLD_FLAGS_LOCALE is set iff the rules from the current underlying
2134 * locale are to be used.
2135 * bit FOLD_FLAGS_FULL is set iff full case folds are to be used;
2136 * otherwise simple folds
2137 * bit FOLD_FLAGS_NOMIX_ASCII is set iff folds of non-ASCII to ASCII are
2142 Perl__to_utf8_fold_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, U8 flags)
2146 PERL_ARGS_ASSERT__TO_UTF8_FOLD_FLAGS;
2148 /* These are mutually exclusive */
2149 assert (! ((flags & FOLD_FLAGS_LOCALE) && (flags & FOLD_FLAGS_NOMIX_ASCII)));
2151 assert(p != ustrp); /* Otherwise overwrites */
2153 if (flags & FOLD_FLAGS_LOCALE && IN_UTF8_CTYPE_LOCALE) {
2154 flags &= ~FOLD_FLAGS_LOCALE;
2157 if (UTF8_IS_INVARIANT(*p)) {
2158 if (flags & FOLD_FLAGS_LOCALE) {
2159 result = toFOLD_LC(*p);
2162 return _to_fold_latin1(*p, ustrp, lenp,
2163 flags & (FOLD_FLAGS_FULL | FOLD_FLAGS_NOMIX_ASCII));
2166 else if UTF8_IS_DOWNGRADEABLE_START(*p) {
2167 if (flags & FOLD_FLAGS_LOCALE) {
2168 U8 c = TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1));
2169 result = toFOLD_LC(c);
2172 return _to_fold_latin1(TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1)),
2174 flags & (FOLD_FLAGS_FULL | FOLD_FLAGS_NOMIX_ASCII));
2177 else { /* utf8, ord above 255 */
2178 result = CALL_FOLD_CASE(p, ustrp, lenp, flags & FOLD_FLAGS_FULL);
2180 if (flags & FOLD_FLAGS_LOCALE) {
2182 /* Special case these two characters, as what normally gets
2183 * returned under locale doesn't work */
2184 if (UTF8SKIP(p) == sizeof(LATIN_CAPITAL_LETTER_SHARP_S_UTF8) - 1
2185 && memEQ((char *) p, LATIN_CAPITAL_LETTER_SHARP_S_UTF8,
2186 sizeof(LATIN_CAPITAL_LETTER_SHARP_S_UTF8) - 1))
2188 /* diag_listed_as: Can't do %s("%s") on non-UTF-8 locale; resolved to "%s". */
2189 Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
2190 "Can't do fc(\"\\x{1E9E}\") on non-UTF-8 locale; "
2191 "resolved to \"\\x{17F}\\x{17F}\".");
2194 else if (UTF8SKIP(p) == sizeof(LATIN_SMALL_LIGATURE_LONG_S_T) - 1
2195 && memEQ((char *) p, LATIN_SMALL_LIGATURE_LONG_S_T_UTF8,
2196 sizeof(LATIN_SMALL_LIGATURE_LONG_S_T_UTF8) - 1))
2198 /* diag_listed_as: Can't do %s("%s") on non-UTF-8 locale; resolved to "%s". */
2199 Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
2200 "Can't do fc(\"\\x{FB05}\") on non-UTF-8 locale; "
2201 "resolved to \"\\x{FB06}\".");
2202 goto return_ligature_st;
2204 return check_locale_boundary_crossing("fc", p, result, ustrp, lenp);
2206 else if (! (flags & FOLD_FLAGS_NOMIX_ASCII)) {
2210 /* This is called when changing the case of a utf8-encoded
2211 * character above the ASCII range, and the result should not
2212 * contain an ASCII character. */
2214 UV original; /* To store the first code point of <p> */
2216 /* Look at every character in the result; if any cross the
2217 * boundary, the whole thing is disallowed */
2219 U8* e = ustrp + *lenp;
2222 /* Crossed, have to return the original */
2223 original = valid_utf8_to_uvchr(p, lenp);
2225 /* But in these instances, there is an alternative we can
2226 * return that is valid */
2227 if (original == LATIN_CAPITAL_LETTER_SHARP_S
2228 || original == LATIN_SMALL_LETTER_SHARP_S)
2232 else if (original == LATIN_SMALL_LIGATURE_LONG_S_T) {
2233 goto return_ligature_st;
2235 Copy(p, ustrp, *lenp, char);
2241 /* Here, no characters crossed, result is ok as-is */
2246 /* Here, used locale rules. Convert back to utf8 */
2247 if (UTF8_IS_INVARIANT(result)) {
2248 *ustrp = (U8) result;
2252 *ustrp = UTF8_EIGHT_BIT_HI((U8) result);
2253 *(ustrp + 1) = UTF8_EIGHT_BIT_LO((U8) result);
2260 /* Certain folds to 'ss' are prohibited by the options, but they do allow
2261 * folds to a string of two of these characters. By returning this
2262 * instead, then, e.g.,
2263 * fc("\x{1E9E}") eq fc("\x{17F}\x{17F}")
2266 *lenp = 2 * sizeof(LATIN_SMALL_LETTER_LONG_S_UTF8) - 2;
2267 Copy(LATIN_SMALL_LETTER_LONG_S_UTF8 LATIN_SMALL_LETTER_LONG_S_UTF8,
2269 return LATIN_SMALL_LETTER_LONG_S;
2272 /* Two folds to 'st' are prohibited by the options; instead we pick one and
2273 * have the other one fold to it */
2275 *lenp = sizeof(LATIN_SMALL_LIGATURE_ST_UTF8) - 1;
2276 Copy(LATIN_SMALL_LIGATURE_ST_UTF8, ustrp, *lenp, U8);
2277 return LATIN_SMALL_LIGATURE_ST;
2281 * Returns a "swash" which is a hash described in utf8.c:Perl_swash_fetch().
2282 * C<pkg> is a pointer to a package name for SWASHNEW, should be "utf8".
2283 * For other parameters, see utf8::SWASHNEW in lib/utf8_heavy.pl.
2287 Perl_swash_init(pTHX_ const char* pkg, const char* name, SV *listsv, I32 minbits, I32 none)
2289 PERL_ARGS_ASSERT_SWASH_INIT;
2291 /* Returns a copy of a swash initiated by the called function. This is the
2292 * public interface, and returning a copy prevents others from doing
2293 * mischief on the original */
2295 return newSVsv(_core_swash_init(pkg, name, listsv, minbits, none, NULL, NULL));
2299 Perl__core_swash_init(pTHX_ const char* pkg, const char* name, SV *listsv, I32 minbits, I32 none, SV* invlist, U8* const flags_p)
2302 /*NOTE NOTE NOTE - If you want to use "return" in this routine you MUST
2303 * use the following define */
2305 #define CORE_SWASH_INIT_RETURN(x) \
2306 PL_curpm= old_PL_curpm; \
2309 /* Initialize and return a swash, creating it if necessary. It does this
2310 * by calling utf8_heavy.pl in the general case. The returned value may be
2311 * the swash's inversion list instead if the input parameters allow it.
2312 * Which is returned should be immaterial to callers, as the only
2313 * operations permitted on a swash, swash_fetch(), _get_swash_invlist(),
2314 * and swash_to_invlist() handle both these transparently.
2316 * This interface should only be used by functions that won't destroy or
2317 * adversely change the swash, as doing so affects all other uses of the
2318 * swash in the program; the general public should use 'Perl_swash_init'
2321 * pkg is the name of the package that <name> should be in.
2322 * name is the name of the swash to find. Typically it is a Unicode
2323 * property name, including user-defined ones
2324 * listsv is a string to initialize the swash with. It must be of the form
2325 * documented as the subroutine return value in
2326 * L<perlunicode/User-Defined Character Properties>
2327 * minbits is the number of bits required to represent each data element.
2328 * It is '1' for binary properties.
2329 * none I (khw) do not understand this one, but it is used only in tr///.
2330 * invlist is an inversion list to initialize the swash with (or NULL)
2331 * flags_p if non-NULL is the address of various input and output flag bits
2332 * to the routine, as follows: ('I' means is input to the routine;
2333 * 'O' means output from the routine. Only flags marked O are
2334 * meaningful on return.)
2335 * _CORE_SWASH_INIT_USER_DEFINED_PROPERTY indicates if the swash
2336 * came from a user-defined property. (I O)
2337 * _CORE_SWASH_INIT_RETURN_IF_UNDEF indicates that instead of croaking
2338 * when the swash cannot be located, to simply return NULL. (I)
2339 * _CORE_SWASH_INIT_ACCEPT_INVLIST indicates that the caller will accept a
2340 * return of an inversion list instead of a swash hash if this routine
2341 * thinks that would result in faster execution of swash_fetch() later
2344 * Thus there are three possible inputs to find the swash: <name>,
2345 * <listsv>, and <invlist>. At least one must be specified. The result
2346 * will be the union of the specified ones, although <listsv>'s various
2347 * actions can intersect, etc. what <name> gives. To avoid going out to
2348 * disk at all, <invlist> should specify completely what the swash should
2349 * have, and <listsv> should be &PL_sv_undef and <name> should be "".
2351 * <invlist> is only valid for binary properties */
2353 PMOP *old_PL_curpm= PL_curpm; /* save away the old PL_curpm */
2355 SV* retval = &PL_sv_undef;
2356 HV* swash_hv = NULL;
2357 const int invlist_swash_boundary =
2358 (flags_p && *flags_p & _CORE_SWASH_INIT_ACCEPT_INVLIST)
2359 ? 512 /* Based on some benchmarking, but not extensive, see commit
2361 : -1; /* Never return just an inversion list */
2363 assert(listsv != &PL_sv_undef || strNE(name, "") || invlist);
2364 assert(! invlist || minbits == 1);
2366 PL_curpm= NULL; /* reset PL_curpm so that we dont get confused between the regex
2367 that triggered the swash init and the swash init perl logic itself.
2370 /* If data was passed in to go out to utf8_heavy to find the swash of, do
2372 if (listsv != &PL_sv_undef || strNE(name, "")) {
2374 const size_t pkg_len = strlen(pkg);
2375 const size_t name_len = strlen(name);
2376 HV * const stash = gv_stashpvn(pkg, pkg_len, 0);
2380 PERL_ARGS_ASSERT__CORE_SWASH_INIT;
2382 PUSHSTACKi(PERLSI_MAGIC);
2385 /* We might get here via a subroutine signature which uses a utf8
2386 * parameter name, at which point PL_subname will have been set
2387 * but not yet used. */
2388 save_item(PL_subname);
2389 if (PL_parser && PL_parser->error_count)
2390 SAVEI8(PL_parser->error_count), PL_parser->error_count = 0;
2391 method = gv_fetchmeth(stash, "SWASHNEW", 8, -1);
2392 if (!method) { /* demand load utf8 */
2394 if ((errsv_save = GvSV(PL_errgv))) SAVEFREESV(errsv_save);
2395 GvSV(PL_errgv) = NULL;
2396 #ifndef NO_TAINT_SUPPORT
2397 /* It is assumed that callers of this routine are not passing in
2398 * any user derived data. */
2399 SAVEBOOL(TAINT_get);
2402 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpvn(pkg,pkg_len),
2405 /* Not ERRSV, as there is no need to vivify a scalar we are
2406 about to discard. */
2407 SV * const errsv = GvSV(PL_errgv);
2408 if (!SvTRUE(errsv)) {
2409 GvSV(PL_errgv) = SvREFCNT_inc_simple(errsv_save);
2410 SvREFCNT_dec(errsv);
2418 mPUSHp(pkg, pkg_len);
2419 mPUSHp(name, name_len);
2424 if ((errsv_save = GvSV(PL_errgv))) SAVEFREESV(errsv_save);
2425 GvSV(PL_errgv) = NULL;
2426 /* If we already have a pointer to the method, no need to use
2427 * call_method() to repeat the lookup. */
2429 ? call_sv(MUTABLE_SV(method), G_SCALAR)
2430 : call_sv(newSVpvs_flags("SWASHNEW", SVs_TEMP), G_SCALAR | G_METHOD))
2432 retval = *PL_stack_sp--;
2433 SvREFCNT_inc(retval);
2436 /* Not ERRSV. See above. */
2437 SV * const errsv = GvSV(PL_errgv);
2438 if (!SvTRUE(errsv)) {
2439 GvSV(PL_errgv) = SvREFCNT_inc_simple(errsv_save);
2440 SvREFCNT_dec(errsv);
2445 if (IN_PERL_COMPILETIME) {
2446 CopHINTS_set(PL_curcop, PL_hints);
2448 if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV) {
2451 /* If caller wants to handle missing properties, let them */
2452 if (flags_p && *flags_p & _CORE_SWASH_INIT_RETURN_IF_UNDEF) {
2453 CORE_SWASH_INIT_RETURN(NULL);
2456 "Can't find Unicode property definition \"%"SVf"\"",
2458 NOT_REACHED; /* NOTREACHED */
2460 } /* End of calling the module to find the swash */
2462 /* If this operation fetched a swash, and we will need it later, get it */
2463 if (retval != &PL_sv_undef
2464 && (minbits == 1 || (flags_p
2466 & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY))))
2468 swash_hv = MUTABLE_HV(SvRV(retval));
2470 /* If we don't already know that there is a user-defined component to
2471 * this swash, and the user has indicated they wish to know if there is
2472 * one (by passing <flags_p>), find out */
2473 if (flags_p && ! (*flags_p & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY)) {
2474 SV** user_defined = hv_fetchs(swash_hv, "USER_DEFINED", FALSE);
2475 if (user_defined && SvUV(*user_defined)) {
2476 *flags_p |= _CORE_SWASH_INIT_USER_DEFINED_PROPERTY;
2481 /* Make sure there is an inversion list for binary properties */
2483 SV** swash_invlistsvp = NULL;
2484 SV* swash_invlist = NULL;
2485 bool invlist_in_swash_is_valid = FALSE;
2486 bool swash_invlist_unclaimed = FALSE; /* whether swash_invlist has
2487 an unclaimed reference count */
2489 /* If this operation fetched a swash, get its already existing
2490 * inversion list, or create one for it */
2493 swash_invlistsvp = hv_fetchs(swash_hv, "V", FALSE);
2494 if (swash_invlistsvp) {
2495 swash_invlist = *swash_invlistsvp;
2496 invlist_in_swash_is_valid = TRUE;
2499 swash_invlist = _swash_to_invlist(retval);
2500 swash_invlist_unclaimed = TRUE;
2504 /* If an inversion list was passed in, have to include it */
2507 /* Any fetched swash will by now have an inversion list in it;
2508 * otherwise <swash_invlist> will be NULL, indicating that we
2509 * didn't fetch a swash */
2510 if (swash_invlist) {
2512 /* Add the passed-in inversion list, which invalidates the one
2513 * already stored in the swash */
2514 invlist_in_swash_is_valid = FALSE;
2515 _invlist_union(invlist, swash_invlist, &swash_invlist);
2519 /* Here, there is no swash already. Set up a minimal one, if
2520 * we are going to return a swash */
2521 if ((int) _invlist_len(invlist) > invlist_swash_boundary) {
2523 retval = newRV_noinc(MUTABLE_SV(swash_hv));
2525 swash_invlist = invlist;
2529 /* Here, we have computed the union of all the passed-in data. It may
2530 * be that there was an inversion list in the swash which didn't get
2531 * touched; otherwise save the computed one */
2532 if (! invlist_in_swash_is_valid
2533 && (int) _invlist_len(swash_invlist) > invlist_swash_boundary)
2535 if (! hv_stores(MUTABLE_HV(SvRV(retval)), "V", swash_invlist))
2537 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2539 /* We just stole a reference count. */
2540 if (swash_invlist_unclaimed) swash_invlist_unclaimed = FALSE;
2541 else SvREFCNT_inc_simple_void_NN(swash_invlist);
2544 SvREADONLY_on(swash_invlist);
2546 /* Use the inversion list stand-alone if small enough */
2547 if ((int) _invlist_len(swash_invlist) <= invlist_swash_boundary) {
2548 SvREFCNT_dec(retval);
2549 if (!swash_invlist_unclaimed)
2550 SvREFCNT_inc_simple_void_NN(swash_invlist);
2551 retval = newRV_noinc(swash_invlist);
2555 CORE_SWASH_INIT_RETURN(retval);
2556 #undef CORE_SWASH_INIT_RETURN
2560 /* This API is wrong for special case conversions since we may need to
2561 * return several Unicode characters for a single Unicode character
2562 * (see lib/unicore/SpecCase.txt) The SWASHGET in lib/utf8_heavy.pl is
2563 * the lower-level routine, and it is similarly broken for returning
2564 * multiple values. --jhi
2565 * For those, you should use to_utf8_case() instead */
2566 /* Now SWASHGET is recasted into S_swatch_get in this file. */
2569 * Returns the value of property/mapping C<swash> for the first character
2570 * of the string C<ptr>. If C<do_utf8> is true, the string C<ptr> is
2571 * assumed to be in well-formed utf8. If C<do_utf8> is false, the string C<ptr>
2572 * is assumed to be in native 8-bit encoding. Caches the swatch in C<swash>.
2574 * A "swash" is a hash which contains initially the keys/values set up by
2575 * SWASHNEW. The purpose is to be able to completely represent a Unicode
2576 * property for all possible code points. Things are stored in a compact form
2577 * (see utf8_heavy.pl) so that calculation is required to find the actual
2578 * property value for a given code point. As code points are looked up, new
2579 * key/value pairs are added to the hash, so that the calculation doesn't have
2580 * to ever be re-done. Further, each calculation is done, not just for the
2581 * desired one, but for a whole block of code points adjacent to that one.
2582 * For binary properties on ASCII machines, the block is usually for 64 code
2583 * points, starting with a code point evenly divisible by 64. Thus if the
2584 * property value for code point 257 is requested, the code goes out and
2585 * calculates the property values for all 64 code points between 256 and 319,
2586 * and stores these as a single 64-bit long bit vector, called a "swatch",
2587 * under the key for code point 256. The key is the UTF-8 encoding for code
2588 * point 256, minus the final byte. Thus, if the length of the UTF-8 encoding
2589 * for a code point is 13 bytes, the key will be 12 bytes long. If the value
2590 * for code point 258 is then requested, this code realizes that it would be
2591 * stored under the key for 256, and would find that value and extract the
2592 * relevant bit, offset from 256.
2594 * Non-binary properties are stored in as many bits as necessary to represent
2595 * their values (32 currently, though the code is more general than that), not
2596 * as single bits, but the principal is the same: the value for each key is a
2597 * vector that encompasses the property values for all code points whose UTF-8
2598 * representations are represented by the key. That is, for all code points
2599 * whose UTF-8 representations are length N bytes, and the key is the first N-1
2603 Perl_swash_fetch(pTHX_ SV *swash, const U8 *ptr, bool do_utf8)
2605 HV *const hv = MUTABLE_HV(SvRV(swash));
2610 const U8 *tmps = NULL;
2614 PERL_ARGS_ASSERT_SWASH_FETCH;
2616 /* If it really isn't a hash, it isn't really swash; must be an inversion
2618 if (SvTYPE(hv) != SVt_PVHV) {
2619 return _invlist_contains_cp((SV*)hv,
2621 ? valid_utf8_to_uvchr(ptr, NULL)
2625 /* We store the values in a "swatch" which is a vec() value in a swash
2626 * hash. Code points 0-255 are a single vec() stored with key length
2627 * (klen) 0. All other code points have a UTF-8 representation
2628 * 0xAA..0xYY,0xZZ. A vec() is constructed containing all of them which
2629 * share 0xAA..0xYY, which is the key in the hash to that vec. So the key
2630 * length for them is the length of the encoded char - 1. ptr[klen] is the
2631 * final byte in the sequence representing the character */
2632 if (!do_utf8 || UTF8_IS_INVARIANT(c)) {
2637 else if (UTF8_IS_DOWNGRADEABLE_START(c)) {
2640 off = TWO_BYTE_UTF8_TO_NATIVE(c, *(ptr + 1));
2643 klen = UTF8SKIP(ptr) - 1;
2645 /* Each vec() stores 2**UTF_ACCUMULATION_SHIFT values. The offset into
2646 * the vec is the final byte in the sequence. (In EBCDIC this is
2647 * converted to I8 to get consecutive values.) To help you visualize
2649 * Straight 1047 After final byte
2650 * UTF-8 UTF-EBCDIC I8 transform
2651 * U+0400: \xD0\x80 \xB8\x41\x41 \xB8\x41\xA0
2652 * U+0401: \xD0\x81 \xB8\x41\x42 \xB8\x41\xA1
2654 * U+0409: \xD0\x89 \xB8\x41\x4A \xB8\x41\xA9
2655 * U+040A: \xD0\x8A \xB8\x41\x51 \xB8\x41\xAA
2657 * U+0412: \xD0\x92 \xB8\x41\x59 \xB8\x41\xB2
2658 * U+0413: \xD0\x93 \xB8\x41\x62 \xB8\x41\xB3
2660 * U+041B: \xD0\x9B \xB8\x41\x6A \xB8\x41\xBB
2661 * U+041C: \xD0\x9C \xB8\x41\x70 \xB8\x41\xBC
2663 * U+041F: \xD0\x9F \xB8\x41\x73 \xB8\x41\xBF
2664 * U+0420: \xD0\xA0 \xB8\x42\x41 \xB8\x42\x41
2666 * (There are no discontinuities in the elided (...) entries.)
2667 * The UTF-8 key for these 33 code points is '\xD0' (which also is the
2668 * key for the next 31, up through U+043F, whose UTF-8 final byte is
2669 * \xBF). Thus in UTF-8, each key is for a vec() for 64 code points.
2670 * The final UTF-8 byte, which ranges between \x80 and \xBF, is an
2671 * index into the vec() swatch (after subtracting 0x80, which we
2672 * actually do with an '&').
2673 * In UTF-EBCDIC, each key is for a 32 code point vec(). The first 32
2674 * code points above have key '\xB8\x41'. The final UTF-EBCDIC byte has
2675 * dicontinuities which go away by transforming it into I8, and we
2676 * effectively subtract 0xA0 to get the index. */
2677 needents = (1 << UTF_ACCUMULATION_SHIFT);
2678 off = NATIVE_UTF8_TO_I8(ptr[klen]) & UTF_CONTINUATION_MASK;
2682 * This single-entry cache saves about 1/3 of the utf8 overhead in test
2683 * suite. (That is, only 7-8% overall over just a hash cache. Still,
2684 * it's nothing to sniff at.) Pity we usually come through at least
2685 * two function calls to get here...
2687 * NB: this code assumes that swatches are never modified, once generated!
2690 if (hv == PL_last_swash_hv &&
2691 klen == PL_last_swash_klen &&
2692 (!klen || memEQ((char *)ptr, (char *)PL_last_swash_key, klen)) )
2694 tmps = PL_last_swash_tmps;
2695 slen = PL_last_swash_slen;
2698 /* Try our second-level swatch cache, kept in a hash. */
2699 SV** svp = hv_fetch(hv, (const char*)ptr, klen, FALSE);
2701 /* If not cached, generate it via swatch_get */
2702 if (!svp || !SvPOK(*svp)
2703 || !(tmps = (const U8*)SvPV_const(*svp, slen)))
2706 const UV code_point = valid_utf8_to_uvchr(ptr, NULL);
2707 swatch = swatch_get(swash,
2708 code_point & ~((UV)needents - 1),
2711 else { /* For the first 256 code points, the swatch has a key of
2713 swatch = swatch_get(swash, 0, needents);
2716 if (IN_PERL_COMPILETIME)
2717 CopHINTS_set(PL_curcop, PL_hints);
2719 svp = hv_store(hv, (const char *)ptr, klen, swatch, 0);
2721 if (!svp || !(tmps = (U8*)SvPV(*svp, slen))
2722 || (slen << 3) < needents)
2723 Perl_croak(aTHX_ "panic: swash_fetch got improper swatch, "
2724 "svp=%p, tmps=%p, slen=%"UVuf", needents=%"UVuf,
2725 svp, tmps, (UV)slen, (UV)needents);
2728 PL_last_swash_hv = hv;
2729 assert(klen <= sizeof(PL_last_swash_key));
2730 PL_last_swash_klen = (U8)klen;
2731 /* FIXME change interpvar.h? */
2732 PL_last_swash_tmps = (U8 *) tmps;
2733 PL_last_swash_slen = slen;
2735 Copy(ptr, PL_last_swash_key, klen, U8);
2738 switch ((int)((slen << 3) / needents)) {
2740 return ((UV) tmps[off >> 3] & (1 << (off & 7))) != 0;
2742 return ((UV) tmps[off]);
2746 ((UV) tmps[off ] << 8) +
2747 ((UV) tmps[off + 1]);
2751 ((UV) tmps[off ] << 24) +
2752 ((UV) tmps[off + 1] << 16) +
2753 ((UV) tmps[off + 2] << 8) +
2754 ((UV) tmps[off + 3]);
2756 Perl_croak(aTHX_ "panic: swash_fetch got swatch of unexpected bit width, "
2757 "slen=%"UVuf", needents=%"UVuf, (UV)slen, (UV)needents);
2758 NORETURN_FUNCTION_END;
2761 /* Read a single line of the main body of the swash input text. These are of
2764 * where each number is hex. The first two numbers form the minimum and
2765 * maximum of a range, and the third is the value associated with the range.
2766 * Not all swashes should have a third number
2768 * On input: l points to the beginning of the line to be examined; it points
2769 * to somewhere in the string of the whole input text, and is
2770 * terminated by a \n or the null string terminator.
2771 * lend points to the null terminator of that string
2772 * wants_value is non-zero if the swash expects a third number
2773 * typestr is the name of the swash's mapping, like 'ToLower'
2774 * On output: *min, *max, and *val are set to the values read from the line.
2775 * returns a pointer just beyond the line examined. If there was no
2776 * valid min number on the line, returns lend+1
2780 S_swash_scan_list_line(pTHX_ U8* l, U8* const lend, UV* min, UV* max, UV* val,
2781 const bool wants_value, const U8* const typestr)
2783 const int typeto = typestr[0] == 'T' && typestr[1] == 'o';
2784 STRLEN numlen; /* Length of the number */
2785 I32 flags = PERL_SCAN_SILENT_ILLDIGIT
2786 | PERL_SCAN_DISALLOW_PREFIX
2787 | PERL_SCAN_SILENT_NON_PORTABLE;
2789 /* nl points to the next \n in the scan */
2790 U8* const nl = (U8*)memchr(l, '\n', lend - l);
2792 PERL_ARGS_ASSERT_SWASH_SCAN_LIST_LINE;
2794 /* Get the first number on the line: the range minimum */
2796 *min = grok_hex((char *)l, &numlen, &flags, NULL);
2797 *max = *min; /* So can never return without setting max */
2798 if (numlen) /* If found a hex number, position past it */
2800 else if (nl) { /* Else, go handle next line, if any */
2801 return nl + 1; /* 1 is length of "\n" */
2803 else { /* Else, no next line */
2804 return lend + 1; /* to LIST's end at which \n is not found */
2807 /* The max range value follows, separated by a BLANK */
2810 flags = PERL_SCAN_SILENT_ILLDIGIT
2811 | PERL_SCAN_DISALLOW_PREFIX
2812 | PERL_SCAN_SILENT_NON_PORTABLE;
2814 *max = grok_hex((char *)l, &numlen, &flags, NULL);
2817 else /* If no value here, it is a single element range */
2820 /* Non-binary tables have a third entry: what the first element of the
2821 * range maps to. The map for those currently read here is in hex */
2825 flags = PERL_SCAN_SILENT_ILLDIGIT
2826 | PERL_SCAN_DISALLOW_PREFIX
2827 | PERL_SCAN_SILENT_NON_PORTABLE;
2829 *val = grok_hex((char *)l, &numlen, &flags, NULL);
2838 /* diag_listed_as: To%s: illegal mapping '%s' */
2839 Perl_croak(aTHX_ "%s: illegal mapping '%s'",
2845 *val = 0; /* bits == 1, then any val should be ignored */
2847 else { /* Nothing following range min, should be single element with no
2852 /* diag_listed_as: To%s: illegal mapping '%s' */
2853 Perl_croak(aTHX_ "%s: illegal mapping '%s'", typestr, l);
2857 *val = 0; /* bits == 1, then val should be ignored */
2860 /* Position to next line if any, or EOF */
2870 * Returns a swatch (a bit vector string) for a code point sequence
2871 * that starts from the value C<start> and comprises the number C<span>.
2872 * A C<swash> must be an object created by SWASHNEW (see lib/utf8_heavy.pl).
2873 * Should be used via swash_fetch, which will cache the swatch in C<swash>.
2876 S_swatch_get(pTHX_ SV* swash, UV start, UV span)
2879 U8 *l, *lend, *x, *xend, *s, *send;
2880 STRLEN lcur, xcur, scur;
2881 HV *const hv = MUTABLE_HV(SvRV(swash));
2882 SV** const invlistsvp = hv_fetchs(hv, "V", FALSE);
2884 SV** listsvp = NULL; /* The string containing the main body of the table */
2885 SV** extssvp = NULL;
2886 SV** invert_it_svp = NULL;
2889 STRLEN octets; /* if bits == 1, then octets == 0 */
2891 UV end = start + span;
2893 if (invlistsvp == NULL) {
2894 SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2895 SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
2896 SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
2897 extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
2898 listsvp = hv_fetchs(hv, "LIST", FALSE);
2899 invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
2901 bits = SvUV(*bitssvp);
2902 none = SvUV(*nonesvp);
2903 typestr = (U8*)SvPV_nolen(*typesvp);
2909 octets = bits >> 3; /* if bits == 1, then octets == 0 */
2911 PERL_ARGS_ASSERT_SWATCH_GET;
2913 if (bits != 1 && bits != 8 && bits != 16 && bits != 32) {
2914 Perl_croak(aTHX_ "panic: swatch_get doesn't expect bits %"UVuf,
2918 /* If overflowed, use the max possible */
2924 /* create and initialize $swatch */
2925 scur = octets ? (span * octets) : (span + 7) / 8;
2926 swatch = newSV(scur);
2928 s = (U8*)SvPVX(swatch);
2929 if (octets && none) {
2930 const U8* const e = s + scur;
2933 *s++ = (U8)(none & 0xff);
2934 else if (bits == 16) {
2935 *s++ = (U8)((none >> 8) & 0xff);
2936 *s++ = (U8)( none & 0xff);
2938 else if (bits == 32) {
2939 *s++ = (U8)((none >> 24) & 0xff);
2940 *s++ = (U8)((none >> 16) & 0xff);
2941 *s++ = (U8)((none >> 8) & 0xff);
2942 *s++ = (U8)( none & 0xff);
2948 (void)memzero((U8*)s, scur + 1);
2950 SvCUR_set(swatch, scur);
2951 s = (U8*)SvPVX(swatch);
2953 if (invlistsvp) { /* If has an inversion list set up use that */
2954 _invlist_populate_swatch(*invlistsvp, start, end, s);
2958 /* read $swash->{LIST} */
2959 l = (U8*)SvPV(*listsvp, lcur);
2962 UV min, max, val, upper;
2963 l = swash_scan_list_line(l, lend, &min, &max, &val,
2964 cBOOL(octets), typestr);
2969 /* If looking for something beyond this range, go try the next one */
2973 /* <end> is generally 1 beyond where we want to set things, but at the
2974 * platform's infinity, where we can't go any higher, we want to
2975 * include the code point at <end> */
2978 : (max != UV_MAX || end != UV_MAX)
2985 if (!none || val < none) {
2990 for (key = min; key <= upper; key++) {
2992 /* offset must be non-negative (start <= min <= key < end) */
2993 offset = octets * (key - start);
2995 s[offset] = (U8)(val & 0xff);
2996 else if (bits == 16) {
2997 s[offset ] = (U8)((val >> 8) & 0xff);
2998 s[offset + 1] = (U8)( val & 0xff);
3000 else if (bits == 32) {
3001 s[offset ] = (U8)((val >> 24) & 0xff);
3002 s[offset + 1] = (U8)((val >> 16) & 0xff);
3003 s[offset + 2] = (U8)((val >> 8) & 0xff);
3004 s[offset + 3] = (U8)( val & 0xff);
3007 if (!none || val < none)
3011 else { /* bits == 1, then val should be ignored */
3016 for (key = min; key <= upper; key++) {
3017 const STRLEN offset = (STRLEN)(key - start);
3018 s[offset >> 3] |= 1 << (offset & 7);
3023 /* Invert if the data says it should be. Assumes that bits == 1 */
3024 if (invert_it_svp && SvUV(*invert_it_svp)) {
3026 /* Unicode properties should come with all bits above PERL_UNICODE_MAX
3027 * be 0, and their inversion should also be 0, as we don't succeed any
3028 * Unicode property matches for non-Unicode code points */
3029 if (start <= PERL_UNICODE_MAX) {
3031 /* The code below assumes that we never cross the
3032 * Unicode/above-Unicode boundary in a range, as otherwise we would
3033 * have to figure out where to stop flipping the bits. Since this
3034 * boundary is divisible by a large power of 2, and swatches comes
3035 * in small powers of 2, this should be a valid assumption */
3036 assert(start + span - 1 <= PERL_UNICODE_MAX);
3046 /* read $swash->{EXTRAS}
3047 * This code also copied to swash_to_invlist() below */
3048 x = (U8*)SvPV(*extssvp, xcur);
3056 SV **otherbitssvp, *other;
3060 const U8 opc = *x++;
3064 nl = (U8*)memchr(x, '\n', xend - x);
3066 if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
3068 x = nl + 1; /* 1 is length of "\n" */
3072 x = xend; /* to EXTRAS' end at which \n is not found */
3079 namelen = nl - namestr;
3083 namelen = xend - namestr;
3087 othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
3088 otherhv = MUTABLE_HV(SvRV(*othersvp));
3089 otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
3090 otherbits = (STRLEN)SvUV(*otherbitssvp);
3091 if (bits < otherbits)
3092 Perl_croak(aTHX_ "panic: swatch_get found swatch size mismatch, "
3093 "bits=%"UVuf", otherbits=%"UVuf, (UV)bits, (UV)otherbits);
3095 /* The "other" swatch must be destroyed after. */
3096 other = swatch_get(*othersvp, start, span);
3097 o = (U8*)SvPV(other, olen);
3100 Perl_croak(aTHX_ "panic: swatch_get got improper swatch");
3102 s = (U8*)SvPV(swatch, slen);
3103 if (bits == 1 && otherbits == 1) {
3105 Perl_croak(aTHX_ "panic: swatch_get found swatch length "
3106 "mismatch, slen=%"UVuf", olen=%"UVuf,
3107 (UV)slen, (UV)olen);
3131 STRLEN otheroctets = otherbits >> 3;
3133 U8* const send = s + slen;
3138 if (otherbits == 1) {
3139 otherval = (o[offset >> 3] >> (offset & 7)) & 1;
3143 STRLEN vlen = otheroctets;
3151 if (opc == '+' && otherval)
3152 NOOP; /* replace with otherval */
3153 else if (opc == '!' && !otherval)
3155 else if (opc == '-' && otherval)
3157 else if (opc == '&' && !otherval)
3160 s += octets; /* no replacement */
3165 *s++ = (U8)( otherval & 0xff);
3166 else if (bits == 16) {
3167 *s++ = (U8)((otherval >> 8) & 0xff);
3168 *s++ = (U8)( otherval & 0xff);
3170 else if (bits == 32) {
3171 *s++ = (U8)((otherval >> 24) & 0xff);
3172 *s++ = (U8)((otherval >> 16) & 0xff);
3173 *s++ = (U8)((otherval >> 8) & 0xff);
3174 *s++ = (U8)( otherval & 0xff);
3178 sv_free(other); /* through with it! */
3184 Perl__swash_inversion_hash(pTHX_ SV* const swash)
3187 /* Subject to change or removal. For use only in regcomp.c and regexec.c
3188 * Can't be used on a property that is subject to user override, as it
3189 * relies on the value of SPECIALS in the swash which would be set by
3190 * utf8_heavy.pl to the hash in the non-overriden file, and hence is not set
3191 * for overridden properties
3193 * Returns a hash which is the inversion and closure of a swash mapping.
3194 * For example, consider the input lines:
3199 * The returned hash would have two keys, the utf8 for 006B and the utf8 for
3200 * 006C. The value for each key is an array. For 006C, the array would
3201 * have two elements, the utf8 for itself, and for 004C. For 006B, there
3202 * would be three elements in its array, the utf8 for 006B, 004B and 212A.
3204 * Note that there are no elements in the hash for 004B, 004C, 212A. The
3205 * keys are only code points that are folded-to, so it isn't a full closure.
3207 * Essentially, for any code point, it gives all the code points that map to
3208 * it, or the list of 'froms' for that point.
3210 * Currently it ignores any additions or deletions from other swashes,
3211 * looking at just the main body of the swash, and if there are SPECIALS
3212 * in the swash, at that hash
3214 * The specials hash can be extra code points, and most likely consists of
3215 * maps from single code points to multiple ones (each expressed as a string
3216 * of utf8 characters). This function currently returns only 1-1 mappings.
3217 * However consider this possible input in the specials hash:
3218 * "\xEF\xAC\x85" => "\x{0073}\x{0074}", # U+FB05 => 0073 0074
3219 * "\xEF\xAC\x86" => "\x{0073}\x{0074}", # U+FB06 => 0073 0074
3221 * Both FB05 and FB06 map to the same multi-char sequence, which we don't
3222 * currently handle. But it also means that FB05 and FB06 are equivalent in
3223 * a 1-1 mapping which we should handle, and this relationship may not be in
3224 * the main table. Therefore this function examines all the multi-char
3225 * sequences and adds the 1-1 mappings that come out of that. */
3229 HV *const hv = MUTABLE_HV(SvRV(swash));
3231 /* The string containing the main body of the table. This will have its
3232 * assertion fail if the swash has been converted to its inversion list */
3233 SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
3235 SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
3236 SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
3237 SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
3238 /*SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);*/
3239 const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
3240 const STRLEN bits = SvUV(*bitssvp);
3241 const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
3242 const UV none = SvUV(*nonesvp);
3243 SV **specials_p = hv_fetchs(hv, "SPECIALS", 0);
3247 PERL_ARGS_ASSERT__SWASH_INVERSION_HASH;
3249 /* Must have at least 8 bits to get the mappings */
3250 if (bits != 8 && bits != 16 && bits != 32) {
3251 Perl_croak(aTHX_ "panic: swash_inversion_hash doesn't expect bits %"UVuf,
3255 if (specials_p) { /* It might be "special" (sometimes, but not always, a
3256 mapping to more than one character */
3258 /* Construct an inverse mapping hash for the specials */
3259 HV * const specials_hv = MUTABLE_HV(SvRV(*specials_p));
3260 HV * specials_inverse = newHV();
3261 char *char_from; /* the lhs of the map */
3262 I32 from_len; /* its byte length */
3263 char *char_to; /* the rhs of the map */
3264 I32 to_len; /* its byte length */
3265 SV *sv_to; /* and in a sv */
3266 AV* from_list; /* list of things that map to each 'to' */
3268 hv_iterinit(specials_hv);
3270 /* The keys are the characters (in utf8) that map to the corresponding
3271 * utf8 string value. Iterate through the list creating the inverse
3273 while ((sv_to = hv_iternextsv(specials_hv, &char_from, &from_len))) {
3275 if (! SvPOK(sv_to)) {
3276 Perl_croak(aTHX_ "panic: value returned from hv_iternextsv() "
3277 "unexpectedly is not a string, flags=%lu",
3278 (unsigned long)SvFLAGS(sv_to));
3280 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Found mapping from %"UVXf", First char of to is %"UVXf"\n", valid_utf8_to_uvchr((U8*) char_from, 0), valid_utf8_to_uvchr((U8*) SvPVX(sv_to), 0)));*/
3282 /* Each key in the inverse list is a mapped-to value, and the key's
3283 * hash value is a list of the strings (each in utf8) that map to
3284 * it. Those strings are all one character long */
3285 if ((listp = hv_fetch(specials_inverse,
3289 from_list = (AV*) *listp;
3291 else { /* No entry yet for it: create one */
3292 from_list = newAV();
3293 if (! hv_store(specials_inverse,
3296 (SV*) from_list, 0))
3298 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
3302 /* Here have the list associated with this 'to' (perhaps newly
3303 * created and empty). Just add to it. Note that we ASSUME that
3304 * the input is guaranteed to not have duplications, so we don't
3305 * check for that. Duplications just slow down execution time. */
3306 av_push(from_list, newSVpvn_utf8(char_from, from_len, TRUE));
3309 /* Here, 'specials_inverse' contains the inverse mapping. Go through
3310 * it looking for cases like the FB05/FB06 examples above. There would
3311 * be an entry in the hash like
3312 * 'st' => [ FB05, FB06 ]
3313 * In this example we will create two lists that get stored in the
3314 * returned hash, 'ret':
3315 * FB05 => [ FB05, FB06 ]
3316 * FB06 => [ FB05, FB06 ]
3318 * Note that there is nothing to do if the array only has one element.
3319 * (In the normal 1-1 case handled below, we don't have to worry about
3320 * two lists, as everything gets tied to the single list that is
3321 * generated for the single character 'to'. But here, we are omitting
3322 * that list, ('st' in the example), so must have multiple lists.) */
3323 while ((from_list = (AV *) hv_iternextsv(specials_inverse,
3324 &char_to, &to_len)))
3326 if (av_tindex(from_list) > 0) {
3329 /* We iterate over all combinations of i,j to place each code
3330 * point on each list */
3331 for (i = 0; i <= av_tindex(from_list); i++) {
3333 AV* i_list = newAV();
3334 SV** entryp = av_fetch(from_list, i, FALSE);
3335 if (entryp == NULL) {
3336 Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
3338 if (hv_fetch(ret, SvPVX(*entryp), SvCUR(*entryp), FALSE)) {
3339 Perl_croak(aTHX_ "panic: unexpected entry for %s", SvPVX(*entryp));
3341 if (! hv_store(ret, SvPVX(*entryp), SvCUR(*entryp),
3342 (SV*) i_list, FALSE))
3344 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
3347 /* For DEBUG_U: UV u = valid_utf8_to_uvchr((U8*) SvPVX(*entryp), 0);*/
3348 for (j = 0; j <= av_tindex(from_list); j++) {
3349 entryp = av_fetch(from_list, j, FALSE);
3350 if (entryp == NULL) {
3351 Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
3354 /* When i==j this adds itself to the list */
3355 av_push(i_list, newSVuv(utf8_to_uvchr_buf(
3356 (U8*) SvPVX(*entryp),
3357 (U8*) SvPVX(*entryp) + SvCUR(*entryp),
3359 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "%s: %d: Adding %"UVXf" to list for %"UVXf"\n", __FILE__, __LINE__, valid_utf8_to_uvchr((U8*) SvPVX(*entryp), 0), u));*/
3364 SvREFCNT_dec(specials_inverse); /* done with it */
3365 } /* End of specials */
3367 /* read $swash->{LIST} */
3368 l = (U8*)SvPV(*listsvp, lcur);
3371 /* Go through each input line */
3375 l = swash_scan_list_line(l, lend, &min, &max, &val,
3376 cBOOL(octets), typestr);
3381 /* Each element in the range is to be inverted */
3382 for (inverse = min; inverse <= max; inverse++) {
3386 bool found_key = FALSE;
3387 bool found_inverse = FALSE;
3389 /* The key is the inverse mapping */
3390 char key[UTF8_MAXBYTES+1];
3391 char* key_end = (char *) uvchr_to_utf8((U8*) key, val);
3392 STRLEN key_len = key_end - key;
3394 /* Get the list for the map */
3395 if ((listp = hv_fetch(ret, key, key_len, FALSE))) {
3396 list = (AV*) *listp;
3398 else { /* No entry yet for it: create one */
3400 if (! hv_store(ret, key, key_len, (SV*) list, FALSE)) {
3401 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
3405 /* Look through list to see if this inverse mapping already is
3406 * listed, or if there is a mapping to itself already */
3407 for (i = 0; i <= av_tindex(list); i++) {
3408 SV** entryp = av_fetch(list, i, FALSE);
3411 if (entryp == NULL) {
3412 Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
3416 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "list for %"UVXf" contains %"UVXf"\n", val, uv));*/
3420 if (uv == inverse) {
3421 found_inverse = TRUE;
3424 /* No need to continue searching if found everything we are
3426 if (found_key && found_inverse) {
3431 /* Make sure there is a mapping to itself on the list */
3433 av_push(list, newSVuv(val));
3434 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "%s: %d: Adding %"UVXf" to list for %"UVXf"\n", __FILE__, __LINE__, val, val));*/
3438 /* Simply add the value to the list */
3439 if (! found_inverse) {
3440 av_push(list, newSVuv(inverse));
3441 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "%s: %d: Adding %"UVXf" to list for %"UVXf"\n", __FILE__, __LINE__, inverse, val));*/
3444 /* swatch_get() increments the value of val for each element in the
3445 * range. That makes more compact tables possible. You can
3446 * express the capitalization, for example, of all consecutive
3447 * letters with a single line: 0061\t007A\t0041 This maps 0061 to
3448 * 0041, 0062 to 0042, etc. I (khw) have never understood 'none',
3449 * and it's not documented; it appears to be used only in
3450 * implementing tr//; I copied the semantics from swatch_get(), just
3452 if (!none || val < none) {
3462 Perl__swash_to_invlist(pTHX_ SV* const swash)
3465 /* Subject to change or removal. For use only in one place in regcomp.c.
3466 * Ownership is given to one reference count in the returned SV* */
3471 HV *const hv = MUTABLE_HV(SvRV(swash));
3472 UV elements = 0; /* Number of elements in the inversion list */
3482 STRLEN octets; /* if bits == 1, then octets == 0 */
3488 PERL_ARGS_ASSERT__SWASH_TO_INVLIST;
3490 /* If not a hash, it must be the swash's inversion list instead */
3491 if (SvTYPE(hv) != SVt_PVHV) {
3492 return SvREFCNT_inc_simple_NN((SV*) hv);
3495 /* The string containing the main body of the table */
3496 listsvp = hv_fetchs(hv, "LIST", FALSE);
3497 typesvp = hv_fetchs(hv, "TYPE", FALSE);
3498 bitssvp = hv_fetchs(hv, "BITS", FALSE);
3499 extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
3500 invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
3502 typestr = (U8*)SvPV_nolen(*typesvp);
3503 bits = SvUV(*bitssvp);
3504 octets = bits >> 3; /* if bits == 1, then octets == 0 */
3506 /* read $swash->{LIST} */
3507 if (SvPOK(*listsvp)) {
3508 l = (U8*)SvPV(*listsvp, lcur);
3511 /* LIST legitimately doesn't contain a string during compilation phases
3512 * of Perl itself, before the Unicode tables are generated. In this
3513 * case, just fake things up by creating an empty list */
3520 if (*l == 'V') { /* Inversion list format */
3521 const char *after_atou = (char *) lend;
3523 UV* other_elements_ptr;
3525 /* The first number is a count of the rest */
3527 elements = grok_atou((const char *)l, &after_atou);
3528 if (elements == 0) {
3529 invlist = _new_invlist(0);
3532 while (isSPACE(*l)) l++;
3533 l = (U8 *) after_atou;
3535 /* Get the 0th element, which is needed to setup the inversion list */
3536 while (isSPACE(*l)) l++;
3537 element0 = (UV) grok_atou((const char *)l, &after_atou);
3538 l = (U8 *) after_atou;
3539 invlist = _setup_canned_invlist(elements, element0, &other_elements_ptr);
3542 /* Then just populate the rest of the input */
3543 while (elements-- > 0) {
3545 Perl_croak(aTHX_ "panic: Expecting %"UVuf" more elements than available", elements);
3547 while (isSPACE(*l)) l++;
3548 *other_elements_ptr++ = (UV) grok_atou((const char *)l, &after_atou);
3549 l = (U8 *) after_atou;
3555 /* Scan the input to count the number of lines to preallocate array
3556 * size based on worst possible case, which is each line in the input
3557 * creates 2 elements in the inversion list: 1) the beginning of a
3558 * range in the list; 2) the beginning of a range not in the list. */
3559 while ((loc = (strchr(loc, '\n'))) != NULL) {
3564 /* If the ending is somehow corrupt and isn't a new line, add another
3565 * element for the final range that isn't in the inversion list */
3566 if (! (*lend == '\n'
3567 || (*lend == '\0' && (lcur == 0 || *(lend - 1) == '\n'))))
3572 invlist = _new_invlist(elements);
3574 /* Now go through the input again, adding each range to the list */
3577 UV val; /* Not used by this function */
3579 l = swash_scan_list_line(l, lend, &start, &end, &val,
3580 cBOOL(octets), typestr);
3586 invlist = _add_range_to_invlist(invlist, start, end);
3590 /* Invert if the data says it should be */
3591 if (invert_it_svp && SvUV(*invert_it_svp)) {
3592 _invlist_invert(invlist);
3595 /* This code is copied from swatch_get()
3596 * read $swash->{EXTRAS} */
3597 x = (U8*)SvPV(*extssvp, xcur);
3605 SV **otherbitssvp, *other;
3608 const U8 opc = *x++;
3612 nl = (U8*)memchr(x, '\n', xend - x);
3614 if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
3616 x = nl + 1; /* 1 is length of "\n" */
3620 x = xend; /* to EXTRAS' end at which \n is not found */
3627 namelen = nl - namestr;
3631 namelen = xend - namestr;
3635 othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
3636 otherhv = MUTABLE_HV(SvRV(*othersvp));
3637 otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
3638 otherbits = (STRLEN)SvUV(*otherbitssvp);
3640 if (bits != otherbits || bits != 1) {
3641 Perl_croak(aTHX_ "panic: _swash_to_invlist only operates on boolean "
3642 "properties, bits=%"UVuf", otherbits=%"UVuf,
3643 (UV)bits, (UV)otherbits);
3646 /* The "other" swatch must be destroyed after. */
3647 other = _swash_to_invlist((SV *)*othersvp);
3649 /* End of code copied from swatch_get() */
3652 _invlist_union(invlist, other, &invlist);
3655 _invlist_union_maybe_complement_2nd(invlist, other, TRUE, &invlist);
3658 _invlist_subtract(invlist, other, &invlist);
3661 _invlist_intersection(invlist, other, &invlist);
3666 sv_free(other); /* through with it! */
3669 SvREADONLY_on(invlist);
3674 Perl__get_swash_invlist(pTHX_ SV* const swash)
3678 PERL_ARGS_ASSERT__GET_SWASH_INVLIST;
3680 if (! SvROK(swash)) {
3684 /* If it really isn't a hash, it isn't really swash; must be an inversion
3686 if (SvTYPE(SvRV(swash)) != SVt_PVHV) {
3690 ptr = hv_fetchs(MUTABLE_HV(SvRV(swash)), "V", FALSE);
3699 Perl_check_utf8_print(pTHX_ const U8* s, const STRLEN len)
3701 /* May change: warns if surrogates, non-character code points, or
3702 * non-Unicode code points are in s which has length len bytes. Returns
3703 * TRUE if none found; FALSE otherwise. The only other validity check is
3704 * to make sure that this won't exceed the string's length */
3706 const U8* const e = s + len;
3709 PERL_ARGS_ASSERT_CHECK_UTF8_PRINT;
3712 if (UTF8SKIP(s) > len) {
3713 Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
3714 "%s in %s", unees, PL_op ? OP_DESC(PL_op) : "print");
3717 if (UNLIKELY(*s >= UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE)) {
3719 if (UTF8_IS_SUPER(s)) {
3720 if (ckWARN_d(WARN_NON_UNICODE)) {
3721 UV uv = utf8_to_uvchr_buf(s, e, &char_len);
3722 Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
3723 "Code point 0x%04"UVXf" is not Unicode, may not be portable", uv);
3727 else if (UTF8_IS_SURROGATE(s)) {
3728 if (ckWARN_d(WARN_SURROGATE)) {
3729 UV uv = utf8_to_uvchr_buf(s, e, &char_len);
3730 Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
3731 "Unicode surrogate U+%04"UVXf" is illegal in UTF-8", uv);
3736 ((UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s))
3737 && (ckWARN_d(WARN_NONCHAR)))
3739 UV uv = utf8_to_uvchr_buf(s, e, &char_len);
3740 Perl_warner(aTHX_ packWARN(WARN_NONCHAR),
3741 "Unicode non-character U+%04"UVXf" is illegal for open interchange", uv);
3752 =for apidoc pv_uni_display
3754 Build to the scalar C<dsv> a displayable version of the string C<spv>,
3755 length C<len>, the displayable version being at most C<pvlim> bytes long
3756 (if longer, the rest is truncated and "..." will be appended).
3758 The C<flags> argument can have UNI_DISPLAY_ISPRINT set to display
3759 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
3760 to display the \\[nrfta\\] as the backslashed versions (like '\n')
3761 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
3762 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
3763 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
3765 The pointer to the PV of the C<dsv> is returned.
3769 Perl_pv_uni_display(pTHX_ SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
3774 PERL_ARGS_ASSERT_PV_UNI_DISPLAY;
3778 for (s = (const char *)spv, e = s + len; s < e; s += UTF8SKIP(s)) {
3780 /* This serves double duty as a flag and a character to print after
3781 a \ when flags & UNI_DISPLAY_BACKSLASH is true.
3785 if (pvlim && SvCUR(dsv) >= pvlim) {
3789 u = utf8_to_uvchr_buf((U8*)s, (U8*)e, 0);
3791 const unsigned char c = (unsigned char)u & 0xFF;
3792 if (flags & UNI_DISPLAY_BACKSLASH) {
3809 const char string = ok;
3810 sv_catpvs(dsv, "\\");
3811 sv_catpvn(dsv, &string, 1);
3814 /* isPRINT() is the locale-blind version. */
3815 if (!ok && (flags & UNI_DISPLAY_ISPRINT) && isPRINT(c)) {
3816 const char string = c;
3817 sv_catpvn(dsv, &string, 1);
3822 Perl_sv_catpvf(aTHX_ dsv, "\\x{%"UVxf"}", u);
3825 sv_catpvs(dsv, "...");
3831 =for apidoc sv_uni_display
3833 Build to the scalar C<dsv> a displayable version of the scalar C<sv>,
3834 the displayable version being at most C<pvlim> bytes long
3835 (if longer, the rest is truncated and "..." will be appended).
3837 The C<flags> argument is as in L</pv_uni_display>().
3839 The pointer to the PV of the C<dsv> is returned.
3844 Perl_sv_uni_display(pTHX_ SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
3846 const char * const ptr =
3847 isREGEXP(ssv) ? RX_WRAPPED((REGEXP*)ssv) : SvPVX_const(ssv);
3849 PERL_ARGS_ASSERT_SV_UNI_DISPLAY;
3851 return Perl_pv_uni_display(aTHX_ dsv, (const U8*)ptr,
3852 SvCUR(ssv), pvlim, flags);
3856 =for apidoc foldEQ_utf8
3858 Returns true if the leading portions of the strings C<s1> and C<s2> (either or both
3859 of which may be in UTF-8) are the same case-insensitively; false otherwise.
3860 How far into the strings to compare is determined by other input parameters.
3862 If C<u1> is true, the string C<s1> is assumed to be in UTF-8-encoded Unicode;
3863 otherwise it is assumed to be in native 8-bit encoding. Correspondingly for C<u2>
3864 with respect to C<s2>.
3866 If the byte length C<l1> is non-zero, it says how far into C<s1> to check for fold
3867 equality. In other words, C<s1>+C<l1> will be used as a goal to reach. The
3868 scan will not be considered to be a match unless the goal is reached, and
3869 scanning won't continue past that goal. Correspondingly for C<l2> with respect to
3872 If C<pe1> is non-NULL and the pointer it points to is not NULL, that pointer is
3873 considered an end pointer to the position 1 byte past the maximum point
3874 in C<s1> beyond which scanning will not continue under any circumstances.
3875 (This routine assumes that UTF-8 encoded input strings are not malformed;
3876 malformed input can cause it to read past C<pe1>).
3877 This means that if both C<l1> and C<pe1> are specified, and C<pe1>
3878 is less than C<s1>+C<l1>, the match will never be successful because it can
3880 get as far as its goal (and in fact is asserted against). Correspondingly for
3881 C<pe2> with respect to C<s2>.
3883 At least one of C<s1> and C<s2> must have a goal (at least one of C<l1> and
3884 C<l2> must be non-zero), and if both do, both have to be
3885 reached for a successful match. Also, if the fold of a character is multiple
3886 characters, all of them must be matched (see tr21 reference below for
3889 Upon a successful match, if C<pe1> is non-NULL,
3890 it will be set to point to the beginning of the I<next> character of C<s1>
3891 beyond what was matched. Correspondingly for C<pe2> and C<s2>.
3893 For case-insensitiveness, the "casefolding" of Unicode is used
3894 instead of upper/lowercasing both the characters, see
3895 L<http://www.unicode.org/unicode/reports/tr21/> (Case Mappings).
3899 /* A flags parameter has been added which may change, and hence isn't
3900 * externally documented. Currently it is:
3901 * 0 for as-documented above
3902 * FOLDEQ_UTF8_NOMIX_ASCII meaning that if a non-ASCII character folds to an
3903 ASCII one, to not match
3904 * FOLDEQ_LOCALE is set iff the rules from the current underlying
3905 * locale are to be used.
3906 * FOLDEQ_S1_ALREADY_FOLDED s1 has already been folded before calling this
3907 * routine. This allows that step to be skipped.
3908 * FOLDEQ_S2_ALREADY_FOLDED Similarly.
3911 Perl_foldEQ_utf8_flags(pTHX_ const char *s1, char **pe1, UV l1, bool u1, const char *s2, char **pe2, UV l2, bool u2, U32 flags)
3913 const U8 *p1 = (const U8*)s1; /* Point to current char */
3914 const U8 *p2 = (const U8*)s2;
3915 const U8 *g1 = NULL; /* goal for s1 */
3916 const U8 *g2 = NULL;
3917 const U8 *e1 = NULL; /* Don't scan s1 past this */
3918 U8 *f1 = NULL; /* Point to current folded */
3919 const U8 *e2 = NULL;
3921 STRLEN n1 = 0, n2 = 0; /* Number of bytes in current char */
3922 U8 foldbuf1[UTF8_MAXBYTES_CASE+1];
3923 U8 foldbuf2[UTF8_MAXBYTES_CASE+1];
3925 PERL_ARGS_ASSERT_FOLDEQ_UTF8_FLAGS;
3927 assert( ! ((flags & (FOLDEQ_UTF8_NOMIX_ASCII | FOLDEQ_LOCALE))
3928 && (flags & (FOLDEQ_S1_ALREADY_FOLDED | FOLDEQ_S2_ALREADY_FOLDED))));
3929 /* The algorithm is to trial the folds without regard to the flags on
3930 * the first line of the above assert(), and then see if the result
3931 * violates them. This means that the inputs can't be pre-folded to a
3932 * violating result, hence the assert. This could be changed, with the
3933 * addition of extra tests here for the already-folded case, which would
3934 * slow it down. That cost is more than any possible gain for when these
3935 * flags are specified, as the flags indicate /il or /iaa matching which
3936 * is less common than /iu, and I (khw) also believe that real-world /il
3937 * and /iaa matches are most likely to involve code points 0-255, and this
3938 * function only under rare conditions gets called for 0-255. */
3940 if (IN_UTF8_CTYPE_LOCALE) {
3941 flags &= ~FOLDEQ_LOCALE;
3949 g1 = (const U8*)s1 + l1;
3957 g2 = (const U8*)s2 + l2;
3960 /* Must have at least one goal */
3965 /* Will never match if goal is out-of-bounds */
3966 assert(! e1 || e1 >= g1);
3968 /* Here, there isn't an end pointer, or it is beyond the goal. We
3969 * only go as far as the goal */
3973 assert(e1); /* Must have an end for looking at s1 */
3976 /* Same for goal for s2 */
3978 assert(! e2 || e2 >= g2);
3985 /* If both operands are already folded, we could just do a memEQ on the
3986 * whole strings at once, but it would be better if the caller realized
3987 * this and didn't even call us */
3989 /* Look through both strings, a character at a time */
3990 while (p1 < e1 && p2 < e2) {
3992 /* If at the beginning of a new character in s1, get its fold to use
3993 * and the length of the fold. (exception: locale rules just get the
3994 * character to a single byte) */
3996 if (flags & FOLDEQ_S1_ALREADY_FOLDED) {
4001 /* If in locale matching, we use two sets of rules, depending
4002 * on if the code point is above or below 255. Here, we test
4003 * for and handle locale rules */
4004 if ((flags & FOLDEQ_LOCALE)
4005 && (! u1 || ! UTF8_IS_ABOVE_LATIN1(*p1)))
4007 /* There is no mixing of code points above and below 255. */
4008 if (u2 && UTF8_IS_ABOVE_LATIN1(*p2)) {
4012 /* We handle locale rules by converting, if necessary, the
4013 * code point to a single byte. */
4014 if (! u1 || UTF8_IS_INVARIANT(*p1)) {
4018 *foldbuf1 = TWO_BYTE_UTF8_TO_NATIVE(*p1, *(p1 + 1));
4022 else if (isASCII(*p1)) { /* Note, that here won't be both
4023 ASCII and using locale rules */
4025 /* If trying to mix non- with ASCII, and not supposed to,
4027 if ((flags & FOLDEQ_UTF8_NOMIX_ASCII) && ! isASCII(*p2)) {
4031 *foldbuf1 = toFOLD(*p1);
4034 to_utf8_fold(p1, foldbuf1, &n1);
4036 else { /* Not utf8, get utf8 fold */
4037 to_uni_fold(*p1, foldbuf1, &n1);
4043 if (n2 == 0) { /* Same for s2 */
4044 if (flags & FOLDEQ_S2_ALREADY_FOLDED) {
4049 if ((flags & FOLDEQ_LOCALE)
4050 && (! u2 || ! UTF8_IS_ABOVE_LATIN1(*p2)))
4052 /* Here, the next char in s2 is < 256. We've already
4053 * worked on s1, and if it isn't also < 256, can't match */
4054 if (u1 && UTF8_IS_ABOVE_LATIN1(*p1)) {
4057 if (! u2 || UTF8_IS_INVARIANT(*p2)) {
4061 *foldbuf2 = TWO_BYTE_UTF8_TO_NATIVE(*p2, *(p2 + 1));
4064 /* Use another function to handle locale rules. We've made
4065 * sure that both characters to compare are single bytes */
4066 if (! foldEQ_locale((char *) f1, (char *) foldbuf2, 1)) {
4071 else if (isASCII(*p2)) {
4072 if ((flags & FOLDEQ_UTF8_NOMIX_ASCII) && ! isASCII(*p1)) {
4076 *foldbuf2 = toFOLD(*p2);
4079 to_utf8_fold(p2, foldbuf2, &n2);
4082 to_uni_fold(*p2, foldbuf2, &n2);
4088 /* Here f1 and f2 point to the beginning of the strings to compare.
4089 * These strings are the folds of the next character from each input
4090 * string, stored in utf8. */
4092 /* While there is more to look for in both folds, see if they
4093 * continue to match */
4095 U8 fold_length = UTF8SKIP(f1);
4096 if (fold_length != UTF8SKIP(f2)
4097 || (fold_length == 1 && *f1 != *f2) /* Short circuit memNE
4098 function call for single
4100 || memNE((char*)f1, (char*)f2, fold_length))
4102 return 0; /* mismatch */
4105 /* Here, they matched, advance past them */
4112 /* When reach the end of any fold, advance the input past it */
4114 p1 += u1 ? UTF8SKIP(p1) : 1;
4117 p2 += u2 ? UTF8SKIP(p2) : 1;
4119 } /* End of loop through both strings */
4121 /* A match is defined by each scan that specified an explicit length
4122 * reaching its final goal, and the other not having matched a partial
4123 * character (which can happen when the fold of a character is more than one
4125 if (! ((g1 == 0 || p1 == g1) && (g2 == 0 || p2 == g2)) || n1 || n2) {
4129 /* Successful match. Set output pointers */
4139 /* XXX The next two functions should likely be moved to mathoms.c once all
4140 * occurrences of them are removed from the core; some cpan-upstream modules
4144 Perl_uvuni_to_utf8(pTHX_ U8 *d, UV uv)
4146 PERL_ARGS_ASSERT_UVUNI_TO_UTF8;
4148 return Perl_uvoffuni_to_utf8_flags(aTHX_ d, uv, 0);
4152 =for apidoc utf8n_to_uvuni
4154 Instead use L</utf8_to_uvchr_buf>, or rarely, L</utf8n_to_uvchr>.
4156 This function was useful for code that wanted to handle both EBCDIC and
4157 ASCII platforms with Unicode properties, but starting in Perl v5.20, the
4158 distinctions between the platforms have mostly been made invisible to most
4159 code, so this function is quite unlikely to be what you want. If you do need
4160 this precise functionality, use instead
4161 C<L<NATIVE_TO_UNI(utf8_to_uvchr_buf(...))|/utf8_to_uvchr_buf>>
4162 or C<L<NATIVE_TO_UNI(utf8n_to_uvchr(...))|/utf8n_to_uvchr>>.
4168 Perl_utf8n_to_uvuni(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
4170 PERL_ARGS_ASSERT_UTF8N_TO_UVUNI;
4172 return NATIVE_TO_UNI(utf8n_to_uvchr(s, curlen, retlen, flags));
4176 =for apidoc uvuni_to_utf8_flags
4178 Instead you almost certainly want to use L</uvchr_to_utf8> or
4179 L</uvchr_to_utf8_flags>>.
4181 This function is a deprecated synonym for L</uvoffuni_to_utf8_flags>,
4182 which itself, while not deprecated, should be used only in isolated
4183 circumstances. These functions were useful for code that wanted to handle
4184 both EBCDIC and ASCII platforms with Unicode properties, but starting in Perl
4185 v5.20, the distinctions between the platforms have mostly been made invisible
4186 to most code, so this function is quite unlikely to be what you want.
4192 Perl_uvuni_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
4194 PERL_ARGS_ASSERT_UVUNI_TO_UTF8_FLAGS;
4196 return uvoffuni_to_utf8_flags(d, uv, flags);
4201 * c-indentation-style: bsd
4203 * indent-tabs-mode: nil
4206 * ex: set ts=8 sts=4 sw=4 et: