This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Move isUTF8_CHAR helper function, and reimplement it
[perl5.git] / utf8.c
1 /*    utf8.c
2  *
3  *    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
4  *    by Larry Wall and others
5  *
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.
8  *
9  */
10
11 /*
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.'
15  *
16  *     [p.603 of _The Lord of the Rings_, IV/I: "The Taming of Sméagol"]
17  *
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
22  *
23  *     [p.508 of _The Lord of the Rings_, III/vi: "The King of the Golden Hall"]
24  *
25  * ...the travellers perceived that the floor was paved with stones of many
26  * hues; branching runes and strange devices intertwined beneath their feet.
27  *
28  *     [p.512 of _The Lord of the Rings_, III/vi: "The King of the Golden Hall"]
29  */
30
31 #include "EXTERN.h"
32 #define PERL_IN_UTF8_C
33 #include "perl.h"
34 #include "invlist_inline.h"
35
36 static const char unees[] =
37     "Malformed UTF-8 character (unexpected end of string)";
38 static const char cp_above_legal_max[] =
39  "Use of code point 0x%"UVXf" is deprecated; the permissible max is 0x%"UVXf"";
40
41 #define MAX_NON_DEPRECATED_CP ((UV) (IV_MAX))
42
43 /*
44 =head1 Unicode Support
45 These are various utility functions for manipulating UTF8-encoded
46 strings.  For the uninitiated, this is a method of representing arbitrary
47 Unicode characters as a variable number of bytes, in such a way that
48 characters in the ASCII range are unmodified, and a zero byte never appears
49 within non-zero characters.
50
51 =cut
52 */
53
54 /*
55 =for apidoc uvoffuni_to_utf8_flags
56
57 THIS FUNCTION SHOULD BE USED IN ONLY VERY SPECIALIZED CIRCUMSTANCES.
58 Instead, B<Almost all code should use L</uvchr_to_utf8> or
59 L</uvchr_to_utf8_flags>>.
60
61 This function is like them, but the input is a strict Unicode
62 (as opposed to native) code point.  Only in very rare circumstances should code
63 not be using the native code point.
64
65 For details, see the description for L</uvchr_to_utf8_flags>.
66
67 =cut
68 */
69
70 #define HANDLE_UNICODE_SURROGATE(uv, flags)                         \
71     STMT_START {                                                    \
72         if (flags & UNICODE_WARN_SURROGATE) {                       \
73             Perl_ck_warner_d(aTHX_ packWARN(WARN_SURROGATE),        \
74                                 "UTF-16 surrogate U+%04"UVXf, uv);  \
75         }                                                           \
76         if (flags & UNICODE_DISALLOW_SURROGATE) {                   \
77             return NULL;                                            \
78         }                                                           \
79     } STMT_END;
80
81 #define HANDLE_UNICODE_NONCHAR(uv, flags)                           \
82     STMT_START {                                                    \
83         if (flags & UNICODE_WARN_NONCHAR) {                         \
84             Perl_ck_warner_d(aTHX_ packWARN(WARN_NONCHAR),          \
85                  "Unicode non-character U+%04"UVXf" is not "        \
86                  "recommended for open interchange", uv);           \
87         }                                                           \
88         if (flags & UNICODE_DISALLOW_NONCHAR) {                     \
89             return NULL;                                            \
90         }                                                           \
91     } STMT_END;
92
93 /*  Use shorter names internally in this file */
94 #define SHIFT   UTF_ACCUMULATION_SHIFT
95 #undef  MARK
96 #define MARK    UTF_CONTINUATION_MARK
97 #define MASK    UTF_CONTINUATION_MASK
98
99 U8 *
100 Perl_uvoffuni_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
101 {
102     PERL_ARGS_ASSERT_UVOFFUNI_TO_UTF8_FLAGS;
103
104     if (OFFUNI_IS_INVARIANT(uv)) {
105         *d++ = LATIN1_TO_NATIVE(uv);
106         return d;
107     }
108
109     if (uv <= MAX_UTF8_TWO_BYTE) {
110         *d++ = I8_TO_NATIVE_UTF8(( uv >> SHIFT) | UTF_START_MARK(2));
111         *d++ = I8_TO_NATIVE_UTF8(( uv           & MASK) |   MARK);
112         return d;
113     }
114
115     /* Not 2-byte; test for and handle 3-byte result.   In the test immediately
116      * below, the 16 is for start bytes E0-EF (which are all the possible ones
117      * for 3 byte characters).  The 2 is for 2 continuation bytes; these each
118      * contribute SHIFT bits.  This yields 0x4000 on EBCDIC platforms, 0x1_0000
119      * on ASCII; so 3 bytes covers the range 0x400-0x3FFF on EBCDIC;
120      * 0x800-0xFFFF on ASCII */
121     if (uv < (16 * (1U << (2 * SHIFT)))) {
122         *d++ = I8_TO_NATIVE_UTF8(( uv >> ((3 - 1) * SHIFT)) | UTF_START_MARK(3));
123         *d++ = I8_TO_NATIVE_UTF8(((uv >> ((2 - 1) * SHIFT)) & MASK) |   MARK);
124         *d++ = I8_TO_NATIVE_UTF8(( uv  /* (1 - 1) */        & MASK) |   MARK);
125
126 #ifndef EBCDIC  /* These problematic code points are 4 bytes on EBCDIC, so
127                    aren't tested here */
128         /* The most likely code points in this range are below the surrogates.
129          * Do an extra test to quickly exclude those. */
130         if (UNLIKELY(uv >= UNICODE_SURROGATE_FIRST)) {
131             if (UNLIKELY(   UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv)
132                          || UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv)))
133             {
134                 HANDLE_UNICODE_NONCHAR(uv, flags);
135             }
136             else if (UNLIKELY(UNICODE_IS_SURROGATE(uv))) {
137                 HANDLE_UNICODE_SURROGATE(uv, flags);
138             }
139         }
140 #endif
141         return d;
142     }
143
144     /* Not 3-byte; that means the code point is at least 0x1_0000 on ASCII
145      * platforms, and 0x4000 on EBCDIC.  There are problematic cases that can
146      * happen starting with 4-byte characters on ASCII platforms.  We unify the
147      * code for these with EBCDIC, even though some of them require 5-bytes on
148      * those, because khw believes the code saving is worth the very slight
149      * performance hit on these high EBCDIC code points. */
150
151     if (UNLIKELY(UNICODE_IS_SUPER(uv))) {
152         if (   UNLIKELY(uv > MAX_NON_DEPRECATED_CP)
153             && ckWARN_d(WARN_DEPRECATED))
154         {
155             Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
156                         cp_above_legal_max, uv, MAX_NON_DEPRECATED_CP);
157         }
158         if (   (flags & UNICODE_WARN_SUPER)
159             || (   UNICODE_IS_ABOVE_31_BIT(uv)
160                 && (flags & UNICODE_WARN_ABOVE_31_BIT)))
161         {
162             Perl_ck_warner_d(aTHX_ packWARN(WARN_NON_UNICODE),
163
164               /* Choose the more dire applicable warning */
165               (UNICODE_IS_ABOVE_31_BIT(uv))
166               ? "Code point 0x%"UVXf" is not Unicode, and not portable"
167               : "Code point 0x%"UVXf" is not Unicode, may not be portable",
168              uv);
169         }
170         if (flags & UNICODE_DISALLOW_SUPER
171             || (   UNICODE_IS_ABOVE_31_BIT(uv)
172                 && (flags & UNICODE_DISALLOW_ABOVE_31_BIT)))
173         {
174             return NULL;
175         }
176     }
177     else if (UNLIKELY(UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv))) {
178         HANDLE_UNICODE_NONCHAR(uv, flags);
179     }
180
181     /* Test for and handle 4-byte result.   In the test immediately below, the
182      * 8 is for start bytes F0-F7 (which are all the possible ones for 4 byte
183      * characters).  The 3 is for 3 continuation bytes; these each contribute
184      * SHIFT bits.  This yields 0x4_0000 on EBCDIC platforms, 0x20_0000 on
185      * ASCII, so 4 bytes covers the range 0x4000-0x3_FFFF on EBCDIC;
186      * 0x1_0000-0x1F_FFFF on ASCII */
187     if (uv < (8 * (1U << (3 * SHIFT)))) {
188         *d++ = I8_TO_NATIVE_UTF8(( uv >> ((4 - 1) * SHIFT)) | UTF_START_MARK(4));
189         *d++ = I8_TO_NATIVE_UTF8(((uv >> ((3 - 1) * SHIFT)) & MASK) |   MARK);
190         *d++ = I8_TO_NATIVE_UTF8(((uv >> ((2 - 1) * SHIFT)) & MASK) |   MARK);
191         *d++ = I8_TO_NATIVE_UTF8(( uv  /* (1 - 1) */        & MASK) |   MARK);
192
193 #ifdef EBCDIC   /* These were handled on ASCII platforms in the code for 3-byte
194                    characters.  The end-plane non-characters for EBCDIC were
195                    handled just above */
196         if (UNLIKELY(UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv))) {
197             HANDLE_UNICODE_NONCHAR(uv, flags);
198         }
199         else if (UNLIKELY(UNICODE_IS_SURROGATE(uv))) {
200             HANDLE_UNICODE_SURROGATE(uv, flags);
201         }
202 #endif
203
204         return d;
205     }
206
207     /* Not 4-byte; that means the code point is at least 0x20_0000 on ASCII
208      * platforms, and 0x4000 on EBCDIC.  At this point we switch to a loop
209      * format.  The unrolled version above turns out to not save all that much
210      * time, and at these high code points (well above the legal Unicode range
211      * on ASCII platforms, and well above anything in common use in EBCDIC),
212      * khw believes that less code outweighs slight performance gains. */
213
214     {
215         STRLEN len  = OFFUNISKIP(uv);
216         U8 *p = d+len-1;
217         while (p > d) {
218             *p-- = I8_TO_NATIVE_UTF8((uv & UTF_CONTINUATION_MASK) | UTF_CONTINUATION_MARK);
219             uv >>= UTF_ACCUMULATION_SHIFT;
220         }
221         *p = I8_TO_NATIVE_UTF8((uv & UTF_START_MASK(len)) | UTF_START_MARK(len));
222         return d+len;
223     }
224 }
225
226 /*
227 =for apidoc uvchr_to_utf8
228
229 Adds the UTF-8 representation of the native code point C<uv> to the end
230 of the string C<d>; C<d> should have at least C<UVCHR_SKIP(uv)+1> (up to
231 C<UTF8_MAXBYTES+1>) free bytes available.  The return value is the pointer to
232 the byte after the end of the new character.  In other words,
233
234     d = uvchr_to_utf8(d, uv);
235
236 is the recommended wide native character-aware way of saying
237
238     *(d++) = uv;
239
240 This function accepts any UV as input, but very high code points (above
241 C<IV_MAX> on the platform)  will raise a deprecation warning.  This is
242 typically 0x7FFF_FFFF in a 32-bit word.
243
244 It is possible to forbid or warn on non-Unicode code points, or those that may
245 be problematic by using L</uvchr_to_utf8_flags>.
246
247 =cut
248 */
249
250 /* This is also a macro */
251 PERL_CALLCONV U8*       Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv);
252
253 U8 *
254 Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv)
255 {
256     return uvchr_to_utf8(d, uv);
257 }
258
259 /*
260 =for apidoc uvchr_to_utf8_flags
261
262 Adds the UTF-8 representation of the native code point C<uv> to the end
263 of the string C<d>; C<d> should have at least C<UVCHR_SKIP(uv)+1> (up to
264 C<UTF8_MAXBYTES+1>) free bytes available.  The return value is the pointer to
265 the byte after the end of the new character.  In other words,
266
267     d = uvchr_to_utf8_flags(d, uv, flags);
268
269 or, in most cases,
270
271     d = uvchr_to_utf8_flags(d, uv, 0);
272
273 This is the Unicode-aware way of saying
274
275     *(d++) = uv;
276
277 If C<flags> is 0, this function accepts any UV as input, but very high code
278 points (above C<IV_MAX> for the platform)  will raise a deprecation warning.
279 This is typically 0x7FFF_FFFF in a 32-bit word.
280
281 Specifying C<flags> can further restrict what is allowed and not warned on, as
282 follows:
283
284 If C<uv> is a Unicode surrogate code point and C<UNICODE_WARN_SURROGATE> is set,
285 the function will raise a warning, provided UTF8 warnings are enabled.  If
286 instead C<UNICODE_DISALLOW_SURROGATE> is set, the function will fail and return
287 NULL.  If both flags are set, the function will both warn and return NULL.
288
289 Similarly, the C<UNICODE_WARN_NONCHAR> and C<UNICODE_DISALLOW_NONCHAR> flags
290 affect how the function handles a Unicode non-character.
291
292 And likewise, the C<UNICODE_WARN_SUPER> and C<UNICODE_DISALLOW_SUPER> flags
293 affect the handling of code points that are above the Unicode maximum of
294 0x10FFFF.  Languages other than Perl may not be able to accept files that
295 contain these.
296
297 The flag C<UNICODE_WARN_ILLEGAL_INTERCHANGE> selects all three of
298 the above WARN flags; and C<UNICODE_DISALLOW_ILLEGAL_INTERCHANGE> selects all
299 three DISALLOW flags.
300
301 Code points above 0x7FFF_FFFF (2**31 - 1) were never specified in any standard,
302 so using them is more problematic than other above-Unicode code points.  Perl
303 invented an extension to UTF-8 to represent the ones above 2**36-1, so it is
304 likely that non-Perl languages will not be able to read files that contain
305 these that written by the perl interpreter; nor would Perl understand files
306 written by something that uses a different extension.  For these reasons, there
307 is a separate set of flags that can warn and/or disallow these extremely high
308 code points, even if other above-Unicode ones are accepted.  These are the
309 C<UNICODE_WARN_ABOVE_31_BIT> and C<UNICODE_DISALLOW_ABOVE_31_BIT> flags.  These
310 are entirely independent from the deprecation warning for code points above
311 C<IV_MAX>.  On 32-bit machines, it will eventually be forbidden to have any
312 code point that needs more than 31 bits to represent.  When that happens,
313 effectively the C<UNICODE_DISALLOW_ABOVE_31_BIT> flag will always be set on
314 32-bit machines.  (Of course C<UNICODE_DISALLOW_SUPER> will treat all
315 above-Unicode code points, including these, as malformations; and
316 C<UNICODE_WARN_SUPER> warns on these.)
317
318 On EBCDIC platforms starting in Perl v5.24, the Perl extension for representing
319 extremely high code points kicks in at 0x3FFF_FFFF (2**30 -1), which is lower
320 than on ASCII.  Prior to that, code points 2**31 and higher were simply
321 unrepresentable, and a different, incompatible method was used to represent
322 code points between 2**30 and 2**31 - 1.  The flags C<UNICODE_WARN_ABOVE_31_BIT>
323 and C<UNICODE_DISALLOW_ABOVE_31_BIT> have the same function as on ASCII
324 platforms, warning and disallowing 2**31 and higher.
325
326 =cut
327 */
328
329 /* This is also a macro */
330 PERL_CALLCONV U8*       Perl_uvchr_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags);
331
332 U8 *
333 Perl_uvchr_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
334 {
335     return uvchr_to_utf8_flags(d, uv, flags);
336 }
337
338 /*
339
340 A helper function for the macro isUTF8_CHAR(), which should be used instead of
341 this function.  The macro will handle smaller code points directly saving time,
342 using this function as a fall-back for higher code points.  This function
343 assumes that it is not called with an invariant character, and that
344 's + len - 1' is within bounds of the string 's'.
345
346 Tests if the string C<s> of at least length 'len' is a valid variant UTF-8
347 character.  0 is returned if not, otherwise, 'len' is returned.
348
349 */
350
351 STRLEN
352 Perl__is_utf8_char_slow(const U8 * const s, const STRLEN len)
353 {
354     const U8 *e;
355     const U8 *x, *y;
356
357     PERL_ARGS_ASSERT__IS_UTF8_CHAR_SLOW;
358
359     if (UNLIKELY(! UTF8_IS_START(*s))) {
360         return 0;
361     }
362
363     e = s + len;
364
365     for (x = s + 1; x < e; x++) {
366         if (UNLIKELY(! UTF8_IS_CONTINUATION(*x))) {
367             return 0;
368         }
369     }
370
371 #ifndef EBCDIC
372
373     /* Here is syntactically valid.  Make sure this isn't the start of an
374      * overlong.  These values were found by manually inspecting the UTF-8
375      * patterns.  See the tables in utf8.h and utfebcdic.h */
376
377     /* This is not needed on modern perls where C0 and C1 are not considered
378      * start bytes. */
379 #if 0
380     if (UNLIKELY(*s < 0xC2)) {
381         return 0;
382     }
383 #endif
384
385     if (len > 1) {
386         if (   (*s == 0xE0 && UNLIKELY(s[1] < 0xA0))
387             || (*s == 0xF0 && UNLIKELY(s[1] < 0x90))
388             || (*s == 0xF8 && UNLIKELY(s[1] < 0x88))
389             || (*s == 0xFC && UNLIKELY(s[1] < 0x84))
390             || (*s == 0xFE && UNLIKELY(s[1] < 0x82)))
391         {
392             return 0;
393         }
394         if ((len > 6 && UNLIKELY(*s == 0xFF) && UNLIKELY(s[6] < 0x81))) {
395             return 0;
396         }
397     }
398
399 #else   /* For EBCDIC, we use I8, which is the same on all code pages */
400     {
401         const U8 s0 = NATIVE_UTF8_TO_I8(*s);
402
403         /* On modern perls C0-C4 aren't considered start bytes */
404         if ( /* s0 < 0xC5 || */ s0 == 0xE0) {
405             return 0;
406         }
407
408         if (len >= 1) {
409             const U8 s1 = NATIVE_UTF8_TO_I8(s[1]);
410
411             if (   (s0 == 0xF0 && UNLIKELY(s1 < 0xB0))
412                 || (s0 == 0xF8 && UNLIKELY(s1 < 0xA8))
413                 || (s0 == 0xFC && UNLIKELY(s1 < 0xA4))
414                 || (s0 == 0xFE && UNLIKELY(s1 < 0x82)))
415             {
416                 return 0;
417             }
418             if ((len > 7 && UNLIKELY(s0 == 0xFF) && UNLIKELY(s[7] < 0xA1))) {
419                 return 0;
420             }
421         }
422     }
423
424 #endif
425
426     /* Now see if this would overflow a UV on this platform.  See if the UTF8
427      * for this code point is larger than that for the highest representable
428      * code point */
429     y = (const U8 *) HIGHEST_REPRESENTABLE_UTF8;
430
431     for (x = s; x < e; x++, y++) {
432
433         /* If the same at this byte, go on to the next */
434         if (UNLIKELY(NATIVE_UTF8_TO_I8(*x) == *y)) {
435             continue;
436         }
437
438         /* If this is larger, it overflows */
439         if (UNLIKELY(NATIVE_UTF8_TO_I8(*x) > *y)) {
440             return 0;
441         }
442
443         /* But if smaller, it won't */
444         break;
445     }
446
447     return len;
448 }
449
450 /*
451
452 =for apidoc utf8n_to_uvchr
453
454 THIS FUNCTION SHOULD BE USED IN ONLY VERY SPECIALIZED CIRCUMSTANCES.
455 Most code should use L</utf8_to_uvchr_buf>() rather than call this directly.
456
457 Bottom level UTF-8 decode routine.
458 Returns the native code point value of the first character in the string C<s>,
459 which is assumed to be in UTF-8 (or UTF-EBCDIC) encoding, and no longer than
460 C<curlen> bytes; C<*retlen> (if C<retlen> isn't NULL) will be set to
461 the length, in bytes, of that character.
462
463 The value of C<flags> determines the behavior when C<s> does not point to a
464 well-formed UTF-8 character.  If C<flags> is 0, when a malformation is found,
465 zero is returned and C<*retlen> is set so that (S<C<s> + C<*retlen>>) is the
466 next possible position in C<s> that could begin a non-malformed character.
467 Also, if UTF-8 warnings haven't been lexically disabled, a warning is raised.
468
469 Various ALLOW flags can be set in C<flags> to allow (and not warn on)
470 individual types of malformations, such as the sequence being overlong (that
471 is, when there is a shorter sequence that can express the same code point;
472 overlong sequences are expressly forbidden in the UTF-8 standard due to
473 potential security issues).  Another malformation example is the first byte of
474 a character not being a legal first byte.  See F<utf8.h> for the list of such
475 flags.  For allowed 0 length strings, this function returns 0; for allowed
476 overlong sequences, the computed code point is returned; for all other allowed
477 malformations, the Unicode REPLACEMENT CHARACTER is returned, as these have no
478 determinable reasonable value.
479
480 The C<UTF8_CHECK_ONLY> flag overrides the behavior when a non-allowed (by other
481 flags) malformation is found.  If this flag is set, the routine assumes that
482 the caller will raise a warning, and this function will silently just set
483 C<retlen> to C<-1> (cast to C<STRLEN>) and return zero.
484
485 Note that this API requires disambiguation between successful decoding a C<NUL>
486 character, and an error return (unless the C<UTF8_CHECK_ONLY> flag is set), as
487 in both cases, 0 is returned.  To disambiguate, upon a zero return, see if the
488 first byte of C<s> is 0 as well.  If so, the input was a C<NUL>; if not, the
489 input had an error.
490
491 Certain code points are considered problematic.  These are Unicode surrogates,
492 Unicode non-characters, and code points above the Unicode maximum of 0x10FFFF.
493 By default these are considered regular code points, but certain situations
494 warrant special handling for them.  If C<flags> contains
495 C<UTF8_DISALLOW_ILLEGAL_INTERCHANGE>, all three classes are treated as
496 malformations and handled as such.  The flags C<UTF8_DISALLOW_SURROGATE>,
497 C<UTF8_DISALLOW_NONCHAR>, and C<UTF8_DISALLOW_SUPER> (meaning above the legal
498 Unicode maximum) can be set to disallow these categories individually.
499
500 The flags C<UTF8_WARN_ILLEGAL_INTERCHANGE>, C<UTF8_WARN_SURROGATE>,
501 C<UTF8_WARN_NONCHAR>, and C<UTF8_WARN_SUPER> will cause warning messages to be
502 raised for their respective categories, but otherwise the code points are
503 considered valid (not malformations).  To get a category to both be treated as
504 a malformation and raise a warning, specify both the WARN and DISALLOW flags.
505 (But note that warnings are not raised if lexically disabled nor if
506 C<UTF8_CHECK_ONLY> is also specified.)
507
508 It is now deprecated to have very high code points (above C<IV_MAX> on the
509 platforms) and this function will raise a deprecation warning for these (unless
510 such warnings are turned off).  This value, is typically 0x7FFF_FFFF (2**31 -1)
511 in a 32-bit word.
512
513 Code points above 0x7FFF_FFFF (2**31 - 1) were never specified in any standard,
514 so using them is more problematic than other above-Unicode code points.  Perl
515 invented an extension to UTF-8 to represent the ones above 2**36-1, so it is
516 likely that non-Perl languages will not be able to read files that contain
517 these that written by the perl interpreter; nor would Perl understand files
518 written by something that uses a different extension.  For these reasons, there
519 is a separate set of flags that can warn and/or disallow these extremely high
520 code points, even if other above-Unicode ones are accepted.  These are the
521 C<UTF8_WARN_ABOVE_31_BIT> and C<UTF8_DISALLOW_ABOVE_31_BIT> flags.  These
522 are entirely independent from the deprecation warning for code points above
523 C<IV_MAX>.  On 32-bit machines, it will eventually be forbidden to have any
524 code point that needs more than 31 bits to represent.  When that happens,
525 effectively the C<UTF8_DISALLOW_ABOVE_31_BIT> flag will always be set on
526 32-bit machines.  (Of course C<UTF8_DISALLOW_SUPER> will treat all
527 above-Unicode code points, including these, as malformations; and
528 C<UTF8_WARN_SUPER> warns on these.)
529
530 On EBCDIC platforms starting in Perl v5.24, the Perl extension for representing
531 extremely high code points kicks in at 0x3FFF_FFFF (2**30 -1), which is lower
532 than on ASCII.  Prior to that, code points 2**31 and higher were simply
533 unrepresentable, and a different, incompatible method was used to represent
534 code points between 2**30 and 2**31 - 1.  The flags C<UTF8_WARN_ABOVE_31_BIT>
535 and C<UTF8_DISALLOW_ABOVE_31_BIT> have the same function as on ASCII
536 platforms, warning and disallowing 2**31 and higher.
537
538 All other code points corresponding to Unicode characters, including private
539 use and those yet to be assigned, are never considered malformed and never
540 warn.
541
542 =cut
543 */
544
545 UV
546 Perl_utf8n_to_uvchr(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
547 {
548     const U8 * const s0 = s;
549     U8 overflow_byte = '\0';    /* Save byte in case of overflow */
550     U8 * send;
551     UV uv = *s;
552     STRLEN expectlen;
553     SV* sv = NULL;
554     UV outlier_ret = 0; /* return value when input is in error or problematic
555                          */
556     UV pack_warn = 0;   /* Save result of packWARN() for later */
557     bool unexpected_non_continuation = FALSE;
558     bool overflowed = FALSE;
559     bool do_overlong_test = TRUE;   /* May have to skip this test */
560
561     const char* const malformed_text = "Malformed UTF-8 character";
562
563     PERL_ARGS_ASSERT_UTF8N_TO_UVCHR;
564
565     /* The order of malformation tests here is important.  We should consume as
566      * few bytes as possible in order to not skip any valid character.  This is
567      * required by the Unicode Standard (section 3.9 of Unicode 6.0); see also
568      * http://unicode.org/reports/tr36 for more discussion as to why.  For
569      * example, once we've done a UTF8SKIP, we can tell the expected number of
570      * bytes, and could fail right off the bat if the input parameters indicate
571      * that there are too few available.  But it could be that just that first
572      * byte is garbled, and the intended character occupies fewer bytes.  If we
573      * blindly assumed that the first byte is correct, and skipped based on
574      * that number, we could skip over a valid input character.  So instead, we
575      * always examine the sequence byte-by-byte.
576      *
577      * We also should not consume too few bytes, otherwise someone could inject
578      * things.  For example, an input could be deliberately designed to
579      * overflow, and if this code bailed out immediately upon discovering that,
580      * returning to the caller C<*retlen> pointing to the very next byte (one
581      * which is actually part of of the overflowing sequence), that could look
582      * legitimate to the caller, which could discard the initial partial
583      * sequence and process the rest, inappropriately */
584
585     /* Zero length strings, if allowed, of necessity are zero */
586     if (UNLIKELY(curlen == 0)) {
587         if (retlen) {
588             *retlen = 0;
589         }
590
591         if (flags & UTF8_ALLOW_EMPTY) {
592             return 0;
593         }
594         if (! (flags & UTF8_CHECK_ONLY)) {
595             sv = sv_2mortal(Perl_newSVpvf(aTHX_ "%s (empty string)", malformed_text));
596         }
597         goto malformed;
598     }
599
600     expectlen = UTF8SKIP(s);
601
602     /* A well-formed UTF-8 character, as the vast majority of calls to this
603      * function will be for, has this expected length.  For efficiency, set
604      * things up here to return it.  It will be overriden only in those rare
605      * cases where a malformation is found */
606     if (retlen) {
607         *retlen = expectlen;
608     }
609
610     /* An invariant is trivially well-formed */
611     if (UTF8_IS_INVARIANT(uv)) {
612         return uv;
613     }
614
615     /* A continuation character can't start a valid sequence */
616     if (UNLIKELY(UTF8_IS_CONTINUATION(uv))) {
617         if (flags & UTF8_ALLOW_CONTINUATION) {
618             if (retlen) {
619                 *retlen = 1;
620             }
621             return UNICODE_REPLACEMENT;
622         }
623
624         if (! (flags & UTF8_CHECK_ONLY)) {
625             sv = sv_2mortal(Perl_newSVpvf(aTHX_ "%s (unexpected continuation byte 0x%02x, with no preceding start byte)", malformed_text, *s0));
626         }
627         curlen = 1;
628         goto malformed;
629     }
630
631     /* Here is not a continuation byte, nor an invariant.  The only thing left
632      * is a start byte (possibly for an overlong) */
633
634     /* Convert to I8 on EBCDIC (no-op on ASCII), then remove the leading bits
635      * that indicate the number of bytes in the character's whole UTF-8
636      * sequence, leaving just the bits that are part of the value.  */
637     uv = NATIVE_UTF8_TO_I8(uv) & UTF_START_MASK(expectlen);
638
639     /* Now, loop through the remaining bytes in the character's sequence,
640      * accumulating each into the working value as we go.  Be sure to not look
641      * past the end of the input string */
642     send =  (U8*) s0 + ((expectlen <= curlen) ? expectlen : curlen);
643
644     for (s = s0 + 1; s < send; s++) {
645         if (LIKELY(UTF8_IS_CONTINUATION(*s))) {
646             if (uv & UTF_ACCUMULATION_OVERFLOW_MASK) {
647
648                 /* The original implementors viewed this malformation as more
649                  * serious than the others (though I, khw, don't understand
650                  * why, since other malformations also give very very wrong
651                  * results), so there is no way to turn off checking for it.
652                  * Set a flag, but keep going in the loop, so that we absorb
653                  * the rest of the bytes that comprise the character. */
654                 overflowed = TRUE;
655                 overflow_byte = *s; /* Save for warning message's use */
656             }
657             uv = UTF8_ACCUMULATE(uv, *s);
658         }
659         else {
660             /* Here, found a non-continuation before processing all expected
661              * bytes.  This byte begins a new character, so quit, even if
662              * allowing this malformation. */
663             unexpected_non_continuation = TRUE;
664             break;
665         }
666     } /* End of loop through the character's bytes */
667
668     /* Save how many bytes were actually in the character */
669     curlen = s - s0;
670
671     /* The loop above finds two types of malformations: non-continuation and/or
672      * overflow.  The non-continuation malformation is really a too-short
673      * malformation, as it means that the current character ended before it was
674      * expected to (being terminated prematurely by the beginning of the next
675      * character, whereas in the too-short malformation there just are too few
676      * bytes available to hold the character.  In both cases, the check below
677      * that we have found the expected number of bytes would fail if executed.)
678      * Thus the non-continuation malformation is really unnecessary, being a
679      * subset of the too-short malformation.  But there may be existing
680      * applications that are expecting the non-continuation type, so we retain
681      * it, and return it in preference to the too-short malformation.  (If this
682      * code were being written from scratch, the two types might be collapsed
683      * into one.)  I, khw, am also giving priority to returning the
684      * non-continuation and too-short malformations over overflow when multiple
685      * ones are present.  I don't know of any real reason to prefer one over
686      * the other, except that it seems to me that multiple-byte errors trumps
687      * errors from a single byte */
688     if (UNLIKELY(unexpected_non_continuation)) {
689         if (!(flags & UTF8_ALLOW_NON_CONTINUATION)) {
690             if (! (flags & UTF8_CHECK_ONLY)) {
691                 if (curlen == 1) {
692                     sv = sv_2mortal(Perl_newSVpvf(aTHX_ "%s (unexpected non-continuation byte 0x%02x, immediately after start byte 0x%02x)", malformed_text, *s, *s0));
693                 }
694                 else {
695                     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));
696                 }
697             }
698             goto malformed;
699         }
700         uv = UNICODE_REPLACEMENT;
701
702         /* Skip testing for overlongs, as the REPLACEMENT may not be the same
703          * as what the original expectations were. */
704         do_overlong_test = FALSE;
705         if (retlen) {
706             *retlen = curlen;
707         }
708     }
709     else if (UNLIKELY(curlen < expectlen)) {
710         if (! (flags & UTF8_ALLOW_SHORT)) {
711             if (! (flags & UTF8_CHECK_ONLY)) {
712                 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));
713             }
714             goto malformed;
715         }
716         uv = UNICODE_REPLACEMENT;
717         do_overlong_test = FALSE;
718         if (retlen) {
719             *retlen = curlen;
720         }
721     }
722
723     if (UNLIKELY(overflowed)) {
724         sv = sv_2mortal(Perl_newSVpvf(aTHX_ "%s (overflow at byte 0x%02x, after start byte 0x%02x)", malformed_text, overflow_byte, *s0));
725         goto malformed;
726     }
727
728     if (do_overlong_test
729         && expectlen > (STRLEN) OFFUNISKIP(uv)
730         && ! (flags & UTF8_ALLOW_LONG))
731     {
732         /* The overlong malformation has lower precedence than the others.
733          * Note that if this malformation is allowed, we return the actual
734          * value, instead of the replacement character.  This is because this
735          * value is actually well-defined. */
736         if (! (flags & UTF8_CHECK_ONLY)) {
737             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));
738         }
739         goto malformed;
740     }
741
742     /* Here, the input is considered to be well-formed, but it still could be a
743      * problematic code point that is not allowed by the input parameters. */
744     if (uv >= UNICODE_SURROGATE_FIRST /* isn't problematic if < this */
745         && ((flags & ( UTF8_DISALLOW_NONCHAR
746                       |UTF8_DISALLOW_SURROGATE
747                       |UTF8_DISALLOW_SUPER
748                       |UTF8_DISALLOW_ABOVE_31_BIT
749                       |UTF8_WARN_NONCHAR
750                       |UTF8_WARN_SURROGATE
751                       |UTF8_WARN_SUPER
752                       |UTF8_WARN_ABOVE_31_BIT))
753             || (   UNLIKELY(uv > MAX_NON_DEPRECATED_CP)
754                 && ckWARN_d(WARN_DEPRECATED))))
755     {
756         if (UNICODE_IS_SURROGATE(uv)) {
757
758             /* By adding UTF8_CHECK_ONLY to the test, we avoid unnecessary
759              * generation of the sv, since no warnings are raised under CHECK */
760             if ((flags & (UTF8_WARN_SURROGATE|UTF8_CHECK_ONLY)) == UTF8_WARN_SURROGATE
761                 && ckWARN_d(WARN_SURROGATE))
762             {
763                 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "UTF-16 surrogate U+%04"UVXf"", uv));
764                 pack_warn = packWARN(WARN_SURROGATE);
765             }
766             if (flags & UTF8_DISALLOW_SURROGATE) {
767                 goto disallowed;
768             }
769         }
770         else if ((uv > PERL_UNICODE_MAX)) {
771             if ((flags & (UTF8_WARN_SUPER|UTF8_CHECK_ONLY)) == UTF8_WARN_SUPER
772                 && ckWARN_d(WARN_NON_UNICODE))
773             {
774                 sv = sv_2mortal(Perl_newSVpvf(aTHX_
775                    "Code point 0x%04"UVXf" is not Unicode, may not be portable",
776                    uv));
777                 pack_warn = packWARN(WARN_NON_UNICODE);
778             }
779
780             /* The maximum code point ever specified by a standard was
781              * 2**31 - 1.  Anything larger than that is a Perl extension that
782              * very well may not be understood by other applications (including
783              * earlier perl versions on EBCDIC platforms).  On ASCII platforms,
784              * these code points are indicated by the first UTF-8 byte being
785              * 0xFE or 0xFF.  We test for these after the regular SUPER ones,
786              * and before possibly bailing out, so that the slightly more dire
787              * warning will override the regular one. */
788             if (
789 #ifndef EBCDIC
790                 (*s0 & 0xFE) == 0xFE    /* matches both FE, FF */
791 #else
792                  /* The I8 for 2**31 (U+80000000) is
793                   *   \xFF\xA0\xA0\xA0\xA0\xA0\xA0\xA2\xA0\xA0\xA0\xA0\xA0\xA0
794                   * and it turns out that on all EBCDIC pages recognized that
795                   * the UTF-EBCDIC for that code point is
796                   *   \xFE\x41\x41\x41\x41\x41\x41\x43\x41\x41\x41\x41\x41\x41
797                   * For the next lower code point, the 1047 UTF-EBCDIC is
798                   *   \xFE\x41\x41\x41\x41\x41\x41\x42\x73\x73\x73\x73\x73\x73
799                   * The other code pages differ only in the bytes following
800                   * \x42.  Thus the following works (the minimum continuation
801                   * byte is \x41). */
802                 *s0 == 0xFE && send - s0 > 7 && (   s0[1] > 0x41
803                                                  || s0[2] > 0x41
804                                                  || s0[3] > 0x41
805                                                  || s0[4] > 0x41
806                                                  || s0[5] > 0x41
807                                                  || s0[6] > 0x41
808                                                  || s0[7] > 0x42)
809 #endif
810                 && (flags & (UTF8_WARN_ABOVE_31_BIT|UTF8_WARN_SUPER
811                             |UTF8_DISALLOW_ABOVE_31_BIT)))
812             {
813                 if (  ! (flags & UTF8_CHECK_ONLY)
814                     &&  (flags & (UTF8_WARN_ABOVE_31_BIT|UTF8_WARN_SUPER))
815                     &&  ckWARN_d(WARN_UTF8))
816                 {
817                     sv = sv_2mortal(Perl_newSVpvf(aTHX_
818                         "Code point 0x%"UVXf" is not Unicode, and not portable",
819                         uv));
820                     pack_warn = packWARN(WARN_UTF8);
821                 }
822                 if (flags & UTF8_DISALLOW_ABOVE_31_BIT) {
823                     goto disallowed;
824                 }
825             }
826
827             if (flags & UTF8_DISALLOW_SUPER) {
828                 goto disallowed;
829             }
830
831             /* The deprecated warning overrides any non-deprecated one */
832             if (UNLIKELY(uv > MAX_NON_DEPRECATED_CP) && ckWARN_d(WARN_DEPRECATED))
833             {
834                 sv = sv_2mortal(Perl_newSVpvf(aTHX_ cp_above_legal_max,
835                                               uv, MAX_NON_DEPRECATED_CP));
836                 pack_warn = packWARN(WARN_DEPRECATED);
837             }
838         }
839         else if (UNICODE_IS_NONCHAR(uv)) {
840             if ((flags & (UTF8_WARN_NONCHAR|UTF8_CHECK_ONLY)) == UTF8_WARN_NONCHAR
841                 && ckWARN_d(WARN_NONCHAR))
842             {
843                 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "Unicode non-character U+%04"UVXf" is not recommended for open interchange", uv));
844                 pack_warn = packWARN(WARN_NONCHAR);
845             }
846             if (flags & UTF8_DISALLOW_NONCHAR) {
847                 goto disallowed;
848             }
849         }
850
851         if (sv) {
852             outlier_ret = uv;   /* Note we don't bother to convert to native,
853                                    as all the outlier code points are the same
854                                    in both ASCII and EBCDIC */
855             goto do_warn;
856         }
857
858         /* Here, this is not considered a malformed character, so drop through
859          * to return it */
860     }
861
862     return UNI_TO_NATIVE(uv);
863
864     /* There are three cases which get to beyond this point.  In all 3 cases:
865      * <sv>         if not null points to a string to print as a warning.
866      * <curlen>     is what <*retlen> should be set to if UTF8_CHECK_ONLY isn't
867      *              set.
868      * <outlier_ret> is what return value to use if UTF8_CHECK_ONLY isn't set.
869      *              This is done by initializing it to 0, and changing it only
870      *              for case 1).
871      * The 3 cases are:
872      * 1)   The input is valid but problematic, and to be warned about.  The
873      *      return value is the resultant code point; <*retlen> is set to
874      *      <curlen>, the number of bytes that comprise the code point.
875      *      <pack_warn> contains the result of packWARN() for the warning
876      *      types.  The entry point for this case is the label <do_warn>;
877      * 2)   The input is a valid code point but disallowed by the parameters to
878      *      this function.  The return value is 0.  If UTF8_CHECK_ONLY is set,
879      *      <*relen> is -1; otherwise it is <curlen>, the number of bytes that
880      *      comprise the code point.  <pack_warn> contains the result of
881      *      packWARN() for the warning types.  The entry point for this case is
882      *      the label <disallowed>.
883      * 3)   The input is malformed.  The return value is 0.  If UTF8_CHECK_ONLY
884      *      is set, <*relen> is -1; otherwise it is <curlen>, the number of
885      *      bytes that comprise the malformation.  All such malformations are
886      *      assumed to be warning type <utf8>.  The entry point for this case
887      *      is the label <malformed>.
888      */
889
890   malformed:
891
892     if (sv && ckWARN_d(WARN_UTF8)) {
893         pack_warn = packWARN(WARN_UTF8);
894     }
895
896   disallowed:
897
898     if (flags & UTF8_CHECK_ONLY) {
899         if (retlen)
900             *retlen = ((STRLEN) -1);
901         return 0;
902     }
903
904   do_warn:
905
906     if (pack_warn) {    /* <pack_warn> was initialized to 0, and changed only
907                            if warnings are to be raised. */
908         const char * const string = SvPVX_const(sv);
909
910         if (PL_op)
911             Perl_warner(aTHX_ pack_warn, "%s in %s", string,  OP_DESC(PL_op));
912         else
913             Perl_warner(aTHX_ pack_warn, "%s", string);
914     }
915
916     if (retlen) {
917         *retlen = curlen;
918     }
919
920     return outlier_ret;
921 }
922
923 /*
924 =for apidoc utf8_to_uvchr_buf
925
926 Returns the native code point of the first character in the string C<s> which
927 is assumed to be in UTF-8 encoding; C<send> points to 1 beyond the end of C<s>.
928 C<*retlen> will be set to the length, in bytes, of that character.
929
930 If C<s> does not point to a well-formed UTF-8 character and UTF8 warnings are
931 enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
932 C<NULL>) to -1.  If those warnings are off, the computed value, if well-defined
933 (or the Unicode REPLACEMENT CHARACTER if not), is silently returned, and
934 C<*retlen> is set (if C<retlen> isn't C<NULL>) so that (S<C<s> + C<*retlen>>) is
935 the next possible position in C<s> that could begin a non-malformed character.
936 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is
937 returned.
938
939 Code points above the platform's C<IV_MAX> will raise a deprecation warning,
940 unless those are turned off.
941
942 =cut
943 */
944
945
946 UV
947 Perl_utf8_to_uvchr_buf(pTHX_ const U8 *s, const U8 *send, STRLEN *retlen)
948 {
949     assert(s < send);
950
951     return utf8n_to_uvchr(s, send - s, retlen,
952                           ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY);
953 }
954
955 /*
956 =for apidoc utf8_to_uvuni_buf
957
958 Only in very rare circumstances should code need to be dealing in Unicode
959 (as opposed to native) code points.  In those few cases, use
960 C<L<NATIVE_TO_UNI(utf8_to_uvchr_buf(...))|/utf8_to_uvchr_buf>> instead.
961
962 Returns the Unicode (not-native) code point of the first character in the
963 string C<s> which
964 is assumed to be in UTF-8 encoding; C<send> points to 1 beyond the end of C<s>.
965 C<retlen> will be set to the length, in bytes, of that character.
966
967 If C<s> does not point to a well-formed UTF-8 character and UTF8 warnings are
968 enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
969 NULL) to -1.  If those warnings are off, the computed value if well-defined (or
970 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
971 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
972 next possible position in C<s> that could begin a non-malformed character.
973 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
974
975 Code points above the platform's C<IV_MAX> will raise a deprecation warning,
976 unless those are turned off.
977
978 =cut
979 */
980
981 UV
982 Perl_utf8_to_uvuni_buf(pTHX_ const U8 *s, const U8 *send, STRLEN *retlen)
983 {
984     PERL_ARGS_ASSERT_UTF8_TO_UVUNI_BUF;
985
986     assert(send > s);
987
988     /* Call the low level routine, asking for checks */
989     return NATIVE_TO_UNI(utf8_to_uvchr_buf(s, send, retlen));
990 }
991
992 /*
993 =for apidoc utf8_length
994
995 Return the length of the UTF-8 char encoded string C<s> in characters.
996 Stops at C<e> (inclusive).  If C<e E<lt> s> or if the scan would end
997 up past C<e>, croaks.
998
999 =cut
1000 */
1001
1002 STRLEN
1003 Perl_utf8_length(pTHX_ const U8 *s, const U8 *e)
1004 {
1005     STRLEN len = 0;
1006
1007     PERL_ARGS_ASSERT_UTF8_LENGTH;
1008
1009     /* Note: cannot use UTF8_IS_...() too eagerly here since e.g.
1010      * the bitops (especially ~) can create illegal UTF-8.
1011      * In other words: in Perl UTF-8 is not just for Unicode. */
1012
1013     if (e < s)
1014         goto warn_and_return;
1015     while (s < e) {
1016         s += UTF8SKIP(s);
1017         len++;
1018     }
1019
1020     if (e != s) {
1021         len--;
1022         warn_and_return:
1023         if (PL_op)
1024             Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
1025                              "%s in %s", unees, OP_DESC(PL_op));
1026         else
1027             Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8), "%s", unees);
1028     }
1029
1030     return len;
1031 }
1032
1033 /*
1034 =for apidoc bytes_cmp_utf8
1035
1036 Compares the sequence of characters (stored as octets) in C<b>, C<blen> with the
1037 sequence of characters (stored as UTF-8)
1038 in C<u>, C<ulen>.  Returns 0 if they are
1039 equal, -1 or -2 if the first string is less than the second string, +1 or +2
1040 if the first string is greater than the second string.
1041
1042 -1 or +1 is returned if the shorter string was identical to the start of the
1043 longer string.  -2 or +2 is returned if
1044 there was a difference between characters
1045 within the strings.
1046
1047 =cut
1048 */
1049
1050 int
1051 Perl_bytes_cmp_utf8(pTHX_ const U8 *b, STRLEN blen, const U8 *u, STRLEN ulen)
1052 {
1053     const U8 *const bend = b + blen;
1054     const U8 *const uend = u + ulen;
1055
1056     PERL_ARGS_ASSERT_BYTES_CMP_UTF8;
1057
1058     while (b < bend && u < uend) {
1059         U8 c = *u++;
1060         if (!UTF8_IS_INVARIANT(c)) {
1061             if (UTF8_IS_DOWNGRADEABLE_START(c)) {
1062                 if (u < uend) {
1063                     U8 c1 = *u++;
1064                     if (UTF8_IS_CONTINUATION(c1)) {
1065                         c = EIGHT_BIT_UTF8_TO_NATIVE(c, c1);
1066                     } else {
1067                         Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
1068                                          "Malformed UTF-8 character "
1069                                          "(unexpected non-continuation byte 0x%02x"
1070                                          ", immediately after start byte 0x%02x)"
1071                                          /* Dear diag.t, it's in the pod.  */
1072                                          "%s%s", c1, c,
1073                                          PL_op ? " in " : "",
1074                                          PL_op ? OP_DESC(PL_op) : "");
1075                         return -2;
1076                     }
1077                 } else {
1078                     if (PL_op)
1079                         Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
1080                                          "%s in %s", unees, OP_DESC(PL_op));
1081                     else
1082                         Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8), "%s", unees);
1083                     return -2; /* Really want to return undef :-)  */
1084                 }
1085             } else {
1086                 return -2;
1087             }
1088         }
1089         if (*b != c) {
1090             return *b < c ? -2 : +2;
1091         }
1092         ++b;
1093     }
1094
1095     if (b == bend && u == uend)
1096         return 0;
1097
1098     return b < bend ? +1 : -1;
1099 }
1100
1101 /*
1102 =for apidoc utf8_to_bytes
1103
1104 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
1105 Unlike L</bytes_to_utf8>, this over-writes the original string, and
1106 updates C<len> to contain the new length.
1107 Returns zero on failure, setting C<len> to -1.
1108
1109 If you need a copy of the string, see L</bytes_from_utf8>.
1110
1111 =cut
1112 */
1113
1114 U8 *
1115 Perl_utf8_to_bytes(pTHX_ U8 *s, STRLEN *len)
1116 {
1117     U8 * const save = s;
1118     U8 * const send = s + *len;
1119     U8 *d;
1120
1121     PERL_ARGS_ASSERT_UTF8_TO_BYTES;
1122     PERL_UNUSED_CONTEXT;
1123
1124     /* ensure valid UTF-8 and chars < 256 before updating string */
1125     while (s < send) {
1126         if (! UTF8_IS_INVARIANT(*s)) {
1127             if (! UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, send)) {
1128                 *len = ((STRLEN) -1);
1129                 return 0;
1130             }
1131             s++;
1132         }
1133         s++;
1134     }
1135
1136     d = s = save;
1137     while (s < send) {
1138         U8 c = *s++;
1139         if (! UTF8_IS_INVARIANT(c)) {
1140             /* Then it is two-byte encoded */
1141             c = EIGHT_BIT_UTF8_TO_NATIVE(c, *s);
1142             s++;
1143         }
1144         *d++ = c;
1145     }
1146     *d = '\0';
1147     *len = d - save;
1148     return save;
1149 }
1150
1151 /*
1152 =for apidoc bytes_from_utf8
1153
1154 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
1155 Unlike L</utf8_to_bytes> but like L</bytes_to_utf8>, returns a pointer to
1156 the newly-created string, and updates C<len> to contain the new
1157 length.  Returns the original string if no conversion occurs, C<len>
1158 is unchanged.  Do nothing if C<is_utf8> points to 0.  Sets C<is_utf8> to
1159 0 if C<s> is converted or consisted entirely of characters that are invariant
1160 in UTF-8 (i.e., US-ASCII on non-EBCDIC machines).
1161
1162 =cut
1163 */
1164
1165 U8 *
1166 Perl_bytes_from_utf8(pTHX_ const U8 *s, STRLEN *len, bool *is_utf8)
1167 {
1168     U8 *d;
1169     const U8 *start = s;
1170     const U8 *send;
1171     I32 count = 0;
1172
1173     PERL_ARGS_ASSERT_BYTES_FROM_UTF8;
1174     PERL_UNUSED_CONTEXT;
1175     if (!*is_utf8)
1176         return (U8 *)start;
1177
1178     /* ensure valid UTF-8 and chars < 256 before converting string */
1179     for (send = s + *len; s < send;) {
1180         if (! UTF8_IS_INVARIANT(*s)) {
1181             if (! UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, send)) {
1182                 return (U8 *)start;
1183             }
1184             count++;
1185             s++;
1186         }
1187         s++;
1188     }
1189
1190     *is_utf8 = FALSE;
1191
1192     Newx(d, (*len) - count + 1, U8);
1193     s = start; start = d;
1194     while (s < send) {
1195         U8 c = *s++;
1196         if (! UTF8_IS_INVARIANT(c)) {
1197             /* Then it is two-byte encoded */
1198             c = EIGHT_BIT_UTF8_TO_NATIVE(c, *s);
1199             s++;
1200         }
1201         *d++ = c;
1202     }
1203     *d = '\0';
1204     *len = d - start;
1205     return (U8 *)start;
1206 }
1207
1208 /*
1209 =for apidoc bytes_to_utf8
1210
1211 Converts a string C<s> of length C<len> bytes from the native encoding into
1212 UTF-8.
1213 Returns a pointer to the newly-created string, and sets C<len> to
1214 reflect the new length in bytes.
1215
1216 A C<NUL> character will be written after the end of the string.
1217
1218 If you want to convert to UTF-8 from encodings other than
1219 the native (Latin1 or EBCDIC),
1220 see L</sv_recode_to_utf8>().
1221
1222 =cut
1223 */
1224
1225 /* This logic is duplicated in sv_catpvn_flags, so any bug fixes will
1226    likewise need duplication. */
1227
1228 U8*
1229 Perl_bytes_to_utf8(pTHX_ const U8 *s, STRLEN *len)
1230 {
1231     const U8 * const send = s + (*len);
1232     U8 *d;
1233     U8 *dst;
1234
1235     PERL_ARGS_ASSERT_BYTES_TO_UTF8;
1236     PERL_UNUSED_CONTEXT;
1237
1238     Newx(d, (*len) * 2 + 1, U8);
1239     dst = d;
1240
1241     while (s < send) {
1242         append_utf8_from_native_byte(*s, &d);
1243         s++;
1244     }
1245     *d = '\0';
1246     *len = d-dst;
1247     return dst;
1248 }
1249
1250 /*
1251  * Convert native (big-endian) or reversed (little-endian) UTF-16 to UTF-8.
1252  *
1253  * Destination must be pre-extended to 3/2 source.  Do not use in-place.
1254  * We optimize for native, for obvious reasons. */
1255
1256 U8*
1257 Perl_utf16_to_utf8(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
1258 {
1259     U8* pend;
1260     U8* dstart = d;
1261
1262     PERL_ARGS_ASSERT_UTF16_TO_UTF8;
1263
1264     if (bytelen & 1)
1265         Perl_croak(aTHX_ "panic: utf16_to_utf8: odd bytelen %"UVuf, (UV)bytelen);
1266
1267     pend = p + bytelen;
1268
1269     while (p < pend) {
1270         UV uv = (p[0] << 8) + p[1]; /* UTF-16BE */
1271         p += 2;
1272         if (OFFUNI_IS_INVARIANT(uv)) {
1273             *d++ = LATIN1_TO_NATIVE((U8) uv);
1274             continue;
1275         }
1276         if (uv <= MAX_UTF8_TWO_BYTE) {
1277             *d++ = UTF8_TWO_BYTE_HI(UNI_TO_NATIVE(uv));
1278             *d++ = UTF8_TWO_BYTE_LO(UNI_TO_NATIVE(uv));
1279             continue;
1280         }
1281 #define FIRST_HIGH_SURROGATE UNICODE_SURROGATE_FIRST
1282 #define LAST_HIGH_SURROGATE  0xDBFF
1283 #define FIRST_LOW_SURROGATE  0xDC00
1284 #define LAST_LOW_SURROGATE   UNICODE_SURROGATE_LAST
1285
1286         /* This assumes that most uses will be in the first Unicode plane, not
1287          * needing surrogates */
1288         if (UNLIKELY(uv >= UNICODE_SURROGATE_FIRST
1289                   && uv <= UNICODE_SURROGATE_LAST))
1290         {
1291             if (UNLIKELY(p >= pend) || UNLIKELY(uv > LAST_HIGH_SURROGATE)) {
1292                 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
1293             }
1294             else {
1295                 UV low = (p[0] << 8) + p[1];
1296                 if (   UNLIKELY(low < FIRST_LOW_SURROGATE)
1297                     || UNLIKELY(low > LAST_LOW_SURROGATE))
1298                 {
1299                     Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
1300                 }
1301                 p += 2;
1302                 uv = ((uv - FIRST_HIGH_SURROGATE) << 10)
1303                                        + (low - FIRST_LOW_SURROGATE) + 0x10000;
1304             }
1305         }
1306 #ifdef EBCDIC
1307         d = uvoffuni_to_utf8_flags(d, uv, 0);
1308 #else
1309         if (uv < 0x10000) {
1310             *d++ = (U8)(( uv >> 12)         | 0xe0);
1311             *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
1312             *d++ = (U8)(( uv        & 0x3f) | 0x80);
1313             continue;
1314         }
1315         else {
1316             *d++ = (U8)(( uv >> 18)         | 0xf0);
1317             *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
1318             *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
1319             *d++ = (U8)(( uv        & 0x3f) | 0x80);
1320             continue;
1321         }
1322 #endif
1323     }
1324     *newlen = d - dstart;
1325     return d;
1326 }
1327
1328 /* Note: this one is slightly destructive of the source. */
1329
1330 U8*
1331 Perl_utf16_to_utf8_reversed(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
1332 {
1333     U8* s = (U8*)p;
1334     U8* const send = s + bytelen;
1335
1336     PERL_ARGS_ASSERT_UTF16_TO_UTF8_REVERSED;
1337
1338     if (bytelen & 1)
1339         Perl_croak(aTHX_ "panic: utf16_to_utf8_reversed: odd bytelen %"UVuf,
1340                    (UV)bytelen);
1341
1342     while (s < send) {
1343         const U8 tmp = s[0];
1344         s[0] = s[1];
1345         s[1] = tmp;
1346         s += 2;
1347     }
1348     return utf16_to_utf8(p, d, bytelen, newlen);
1349 }
1350
1351 bool
1352 Perl__is_uni_FOO(pTHX_ const U8 classnum, const UV c)
1353 {
1354     U8 tmpbuf[UTF8_MAXBYTES+1];
1355     uvchr_to_utf8(tmpbuf, c);
1356     return _is_utf8_FOO(classnum, tmpbuf);
1357 }
1358
1359 /* Internal function so we can deprecate the external one, and call
1360    this one from other deprecated functions in this file */
1361
1362 bool
1363 Perl__is_utf8_idstart(pTHX_ const U8 *p)
1364 {
1365     PERL_ARGS_ASSERT__IS_UTF8_IDSTART;
1366
1367     if (*p == '_')
1368         return TRUE;
1369     return is_utf8_common(p, &PL_utf8_idstart, "IdStart", NULL);
1370 }
1371
1372 bool
1373 Perl__is_uni_perl_idcont(pTHX_ UV c)
1374 {
1375     U8 tmpbuf[UTF8_MAXBYTES+1];
1376     uvchr_to_utf8(tmpbuf, c);
1377     return _is_utf8_perl_idcont(tmpbuf);
1378 }
1379
1380 bool
1381 Perl__is_uni_perl_idstart(pTHX_ UV c)
1382 {
1383     U8 tmpbuf[UTF8_MAXBYTES+1];
1384     uvchr_to_utf8(tmpbuf, c);
1385     return _is_utf8_perl_idstart(tmpbuf);
1386 }
1387
1388 UV
1389 Perl__to_upper_title_latin1(pTHX_ const U8 c, U8* p, STRLEN *lenp, const char S_or_s)
1390 {
1391     /* We have the latin1-range values compiled into the core, so just use
1392      * those, converting the result to UTF-8.  The only difference between upper
1393      * and title case in this range is that LATIN_SMALL_LETTER_SHARP_S is
1394      * either "SS" or "Ss".  Which one to use is passed into the routine in
1395      * 'S_or_s' to avoid a test */
1396
1397     UV converted = toUPPER_LATIN1_MOD(c);
1398
1399     PERL_ARGS_ASSERT__TO_UPPER_TITLE_LATIN1;
1400
1401     assert(S_or_s == 'S' || S_or_s == 's');
1402
1403     if (UVCHR_IS_INVARIANT(converted)) { /* No difference between the two for
1404                                              characters in this range */
1405         *p = (U8) converted;
1406         *lenp = 1;
1407         return converted;
1408     }
1409
1410     /* toUPPER_LATIN1_MOD gives the correct results except for three outliers,
1411      * which it maps to one of them, so as to only have to have one check for
1412      * it in the main case */
1413     if (UNLIKELY(converted == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS)) {
1414         switch (c) {
1415             case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
1416                 converted = LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS;
1417                 break;
1418             case MICRO_SIGN:
1419                 converted = GREEK_CAPITAL_LETTER_MU;
1420                 break;
1421 #if    UNICODE_MAJOR_VERSION > 2                                        \
1422    || (UNICODE_MAJOR_VERSION == 2 && UNICODE_DOT_VERSION >= 1           \
1423                                   && UNICODE_DOT_DOT_VERSION >= 8)
1424             case LATIN_SMALL_LETTER_SHARP_S:
1425                 *(p)++ = 'S';
1426                 *p = S_or_s;
1427                 *lenp = 2;
1428                 return 'S';
1429 #endif
1430             default:
1431                 Perl_croak(aTHX_ "panic: to_upper_title_latin1 did not expect '%c' to map to '%c'", c, LATIN_SMALL_LETTER_Y_WITH_DIAERESIS);
1432                 NOT_REACHED; /* NOTREACHED */
1433         }
1434     }
1435
1436     *(p)++ = UTF8_TWO_BYTE_HI(converted);
1437     *p = UTF8_TWO_BYTE_LO(converted);
1438     *lenp = 2;
1439
1440     return converted;
1441 }
1442
1443 /* Call the function to convert a UTF-8 encoded character to the specified case.
1444  * Note that there may be more than one character in the result.
1445  * INP is a pointer to the first byte of the input character
1446  * OUTP will be set to the first byte of the string of changed characters.  It
1447  *      needs to have space for UTF8_MAXBYTES_CASE+1 bytes
1448  * LENP will be set to the length in bytes of the string of changed characters
1449  *
1450  * The functions return the ordinal of the first character in the string of OUTP */
1451 #define CALL_UPPER_CASE(uv, s, d, lenp) _to_utf8_case(uv, s, d, lenp, &PL_utf8_toupper, "ToUc", "")
1452 #define CALL_TITLE_CASE(uv, s, d, lenp) _to_utf8_case(uv, s, d, lenp, &PL_utf8_totitle, "ToTc", "")
1453 #define CALL_LOWER_CASE(uv, s, d, lenp) _to_utf8_case(uv, s, d, lenp, &PL_utf8_tolower, "ToLc", "")
1454
1455 /* This additionally has the input parameter 'specials', which if non-zero will
1456  * cause this to use the specials hash for folding (meaning get full case
1457  * folding); otherwise, when zero, this implies a simple case fold */
1458 #define CALL_FOLD_CASE(uv, s, d, lenp, specials) _to_utf8_case(uv, s, d, lenp, &PL_utf8_tofold, "ToCf", (specials) ? "" : NULL)
1459
1460 UV
1461 Perl_to_uni_upper(pTHX_ UV c, U8* p, STRLEN *lenp)
1462 {
1463     /* Convert the Unicode character whose ordinal is <c> to its uppercase
1464      * version and store that in UTF-8 in <p> and its length in bytes in <lenp>.
1465      * Note that the <p> needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
1466      * the changed version may be longer than the original character.
1467      *
1468      * The ordinal of the first character of the changed version is returned
1469      * (but note, as explained above, that there may be more.) */
1470
1471     PERL_ARGS_ASSERT_TO_UNI_UPPER;
1472
1473     if (c < 256) {
1474         return _to_upper_title_latin1((U8) c, p, lenp, 'S');
1475     }
1476
1477     uvchr_to_utf8(p, c);
1478     return CALL_UPPER_CASE(c, p, p, lenp);
1479 }
1480
1481 UV
1482 Perl_to_uni_title(pTHX_ UV c, U8* p, STRLEN *lenp)
1483 {
1484     PERL_ARGS_ASSERT_TO_UNI_TITLE;
1485
1486     if (c < 256) {
1487         return _to_upper_title_latin1((U8) c, p, lenp, 's');
1488     }
1489
1490     uvchr_to_utf8(p, c);
1491     return CALL_TITLE_CASE(c, p, p, lenp);
1492 }
1493
1494 STATIC U8
1495 S_to_lower_latin1(const U8 c, U8* p, STRLEN *lenp)
1496 {
1497     /* We have the latin1-range values compiled into the core, so just use
1498      * those, converting the result to UTF-8.  Since the result is always just
1499      * one character, we allow <p> to be NULL */
1500
1501     U8 converted = toLOWER_LATIN1(c);
1502
1503     if (p != NULL) {
1504         if (NATIVE_BYTE_IS_INVARIANT(converted)) {
1505             *p = converted;
1506             *lenp = 1;
1507         }
1508         else {
1509             /* Result is known to always be < 256, so can use the EIGHT_BIT
1510              * macros */
1511             *p = UTF8_EIGHT_BIT_HI(converted);
1512             *(p+1) = UTF8_EIGHT_BIT_LO(converted);
1513             *lenp = 2;
1514         }
1515     }
1516     return converted;
1517 }
1518
1519 UV
1520 Perl_to_uni_lower(pTHX_ UV c, U8* p, STRLEN *lenp)
1521 {
1522     PERL_ARGS_ASSERT_TO_UNI_LOWER;
1523
1524     if (c < 256) {
1525         return to_lower_latin1((U8) c, p, lenp);
1526     }
1527
1528     uvchr_to_utf8(p, c);
1529     return CALL_LOWER_CASE(c, p, p, lenp);
1530 }
1531
1532 UV
1533 Perl__to_fold_latin1(pTHX_ const U8 c, U8* p, STRLEN *lenp, const unsigned int flags)
1534 {
1535     /* Corresponds to to_lower_latin1(); <flags> bits meanings:
1536      *      FOLD_FLAGS_NOMIX_ASCII iff non-ASCII to ASCII folds are prohibited
1537      *      FOLD_FLAGS_FULL  iff full folding is to be used;
1538      *
1539      *  Not to be used for locale folds
1540      */
1541
1542     UV converted;
1543
1544     PERL_ARGS_ASSERT__TO_FOLD_LATIN1;
1545     PERL_UNUSED_CONTEXT;
1546
1547     assert (! (flags & FOLD_FLAGS_LOCALE));
1548
1549     if (UNLIKELY(c == MICRO_SIGN)) {
1550         converted = GREEK_SMALL_LETTER_MU;
1551     }
1552 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
1553    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
1554                                       || UNICODE_DOT_DOT_VERSION > 0)
1555     else if (   (flags & FOLD_FLAGS_FULL)
1556              && UNLIKELY(c == LATIN_SMALL_LETTER_SHARP_S))
1557     {
1558         /* If can't cross 127/128 boundary, can't return "ss"; instead return
1559          * two U+017F characters, as fc("\df") should eq fc("\x{17f}\x{17f}")
1560          * under those circumstances. */
1561         if (flags & FOLD_FLAGS_NOMIX_ASCII) {
1562             *lenp = 2 * sizeof(LATIN_SMALL_LETTER_LONG_S_UTF8) - 2;
1563             Copy(LATIN_SMALL_LETTER_LONG_S_UTF8 LATIN_SMALL_LETTER_LONG_S_UTF8,
1564                  p, *lenp, U8);
1565             return LATIN_SMALL_LETTER_LONG_S;
1566         }
1567         else {
1568             *(p)++ = 's';
1569             *p = 's';
1570             *lenp = 2;
1571             return 's';
1572         }
1573     }
1574 #endif
1575     else { /* In this range the fold of all other characters is their lower
1576               case */
1577         converted = toLOWER_LATIN1(c);
1578     }
1579
1580     if (UVCHR_IS_INVARIANT(converted)) {
1581         *p = (U8) converted;
1582         *lenp = 1;
1583     }
1584     else {
1585         *(p)++ = UTF8_TWO_BYTE_HI(converted);
1586         *p = UTF8_TWO_BYTE_LO(converted);
1587         *lenp = 2;
1588     }
1589
1590     return converted;
1591 }
1592
1593 UV
1594 Perl__to_uni_fold_flags(pTHX_ UV c, U8* p, STRLEN *lenp, U8 flags)
1595 {
1596
1597     /* Not currently externally documented, and subject to change
1598      *  <flags> bits meanings:
1599      *      FOLD_FLAGS_FULL  iff full folding is to be used;
1600      *      FOLD_FLAGS_LOCALE is set iff the rules from the current underlying
1601      *                        locale are to be used.
1602      *      FOLD_FLAGS_NOMIX_ASCII iff non-ASCII to ASCII folds are prohibited
1603      */
1604
1605     PERL_ARGS_ASSERT__TO_UNI_FOLD_FLAGS;
1606
1607     if (flags & FOLD_FLAGS_LOCALE) {
1608         /* Treat a UTF-8 locale as not being in locale at all */
1609         if (IN_UTF8_CTYPE_LOCALE) {
1610             flags &= ~FOLD_FLAGS_LOCALE;
1611         }
1612         else {
1613             _CHECK_AND_WARN_PROBLEMATIC_LOCALE;
1614             goto needs_full_generality;
1615         }
1616     }
1617
1618     if (c < 256) {
1619         return _to_fold_latin1((U8) c, p, lenp,
1620                             flags & (FOLD_FLAGS_FULL | FOLD_FLAGS_NOMIX_ASCII));
1621     }
1622
1623     /* Here, above 255.  If no special needs, just use the macro */
1624     if ( ! (flags & (FOLD_FLAGS_LOCALE|FOLD_FLAGS_NOMIX_ASCII))) {
1625         uvchr_to_utf8(p, c);
1626         return CALL_FOLD_CASE(c, p, p, lenp, flags & FOLD_FLAGS_FULL);
1627     }
1628     else {  /* Otherwise, _to_utf8_fold_flags has the intelligence to deal with
1629                the special flags. */
1630         U8 utf8_c[UTF8_MAXBYTES + 1];
1631
1632       needs_full_generality:
1633         uvchr_to_utf8(utf8_c, c);
1634         return _to_utf8_fold_flags(utf8_c, p, lenp, flags);
1635     }
1636 }
1637
1638 PERL_STATIC_INLINE bool
1639 S_is_utf8_common(pTHX_ const U8 *const p, SV **swash,
1640                  const char *const swashname, SV* const invlist)
1641 {
1642     /* returns a boolean giving whether or not the UTF8-encoded character that
1643      * starts at <p> is in the swash indicated by <swashname>.  <swash>
1644      * contains a pointer to where the swash indicated by <swashname>
1645      * is to be stored; which this routine will do, so that future calls will
1646      * look at <*swash> and only generate a swash if it is not null.  <invlist>
1647      * is NULL or an inversion list that defines the swash.  If not null, it
1648      * saves time during initialization of the swash.
1649      *
1650      * Note that it is assumed that the buffer length of <p> is enough to
1651      * contain all the bytes that comprise the character.  Thus, <*p> should
1652      * have been checked before this call for mal-formedness enough to assure
1653      * that. */
1654
1655     PERL_ARGS_ASSERT_IS_UTF8_COMMON;
1656
1657     /* The API should have included a length for the UTF-8 character in <p>,
1658      * but it doesn't.  We therefore assume that p has been validated at least
1659      * as far as there being enough bytes available in it to accommodate the
1660      * character without reading beyond the end, and pass that number on to the
1661      * validating routine */
1662     if (! isUTF8_CHAR(p, p + UTF8SKIP(p))) {
1663         if (ckWARN_d(WARN_UTF8)) {
1664             Perl_warner(aTHX_ packWARN2(WARN_DEPRECATED,WARN_UTF8),
1665                     "Passing malformed UTF-8 to \"%s\" is deprecated", swashname);
1666             if (ckWARN(WARN_UTF8)) {    /* This will output details as to the
1667                                            what the malformation is */
1668                 utf8_to_uvchr_buf(p, p + UTF8SKIP(p), NULL);
1669             }
1670         }
1671         return FALSE;
1672     }
1673     if (!*swash) {
1674         U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
1675         *swash = _core_swash_init("utf8",
1676
1677                                   /* Only use the name if there is no inversion
1678                                    * list; otherwise will go out to disk */
1679                                   (invlist) ? "" : swashname,
1680
1681                                   &PL_sv_undef, 1, 0, invlist, &flags);
1682     }
1683
1684     return swash_fetch(*swash, p, TRUE) != 0;
1685 }
1686
1687 bool
1688 Perl__is_utf8_FOO(pTHX_ const U8 classnum, const U8 *p)
1689 {
1690     PERL_ARGS_ASSERT__IS_UTF8_FOO;
1691
1692     assert(classnum < _FIRST_NON_SWASH_CC);
1693
1694     return is_utf8_common(p,
1695                           &PL_utf8_swash_ptrs[classnum],
1696                           swash_property_names[classnum],
1697                           PL_XPosix_ptrs[classnum]);
1698 }
1699
1700 bool
1701 Perl__is_utf8_perl_idstart(pTHX_ const U8 *p)
1702 {
1703     SV* invlist = NULL;
1704
1705     PERL_ARGS_ASSERT__IS_UTF8_PERL_IDSTART;
1706
1707     if (! PL_utf8_perl_idstart) {
1708         invlist = _new_invlist_C_array(_Perl_IDStart_invlist);
1709     }
1710     return is_utf8_common(p, &PL_utf8_perl_idstart, "_Perl_IDStart", invlist);
1711 }
1712
1713 bool
1714 Perl__is_utf8_xidstart(pTHX_ const U8 *p)
1715 {
1716     PERL_ARGS_ASSERT__IS_UTF8_XIDSTART;
1717
1718     if (*p == '_')
1719         return TRUE;
1720     return is_utf8_common(p, &PL_utf8_xidstart, "XIdStart", NULL);
1721 }
1722
1723 bool
1724 Perl__is_utf8_perl_idcont(pTHX_ const U8 *p)
1725 {
1726     SV* invlist = NULL;
1727
1728     PERL_ARGS_ASSERT__IS_UTF8_PERL_IDCONT;
1729
1730     if (! PL_utf8_perl_idcont) {
1731         invlist = _new_invlist_C_array(_Perl_IDCont_invlist);
1732     }
1733     return is_utf8_common(p, &PL_utf8_perl_idcont, "_Perl_IDCont", invlist);
1734 }
1735
1736 bool
1737 Perl__is_utf8_idcont(pTHX_ const U8 *p)
1738 {
1739     PERL_ARGS_ASSERT__IS_UTF8_IDCONT;
1740
1741     return is_utf8_common(p, &PL_utf8_idcont, "IdContinue", NULL);
1742 }
1743
1744 bool
1745 Perl__is_utf8_xidcont(pTHX_ const U8 *p)
1746 {
1747     PERL_ARGS_ASSERT__IS_UTF8_XIDCONT;
1748
1749     return is_utf8_common(p, &PL_utf8_idcont, "XIdContinue", NULL);
1750 }
1751
1752 bool
1753 Perl__is_utf8_mark(pTHX_ const U8 *p)
1754 {
1755     PERL_ARGS_ASSERT__IS_UTF8_MARK;
1756
1757     return is_utf8_common(p, &PL_utf8_mark, "IsM", NULL);
1758 }
1759
1760 /*
1761 =for apidoc to_utf8_case
1762
1763 Instead use the appropriate one of L</toUPPER_utf8>,
1764 L</toTITLE_utf8>,
1765 L</toLOWER_utf8>,
1766 or L</toFOLD_utf8>.
1767
1768 C<p> contains the pointer to the UTF-8 string encoding
1769 the character that is being converted.  This routine assumes that the character
1770 at C<p> is well-formed.
1771
1772 C<ustrp> is a pointer to the character buffer to put the
1773 conversion result to.  C<lenp> is a pointer to the length
1774 of the result.
1775
1776 C<swashp> is a pointer to the swash to use.
1777
1778 Both the special and normal mappings are stored in F<lib/unicore/To/Foo.pl>,
1779 and loaded by C<SWASHNEW>, using F<lib/utf8_heavy.pl>.  C<special> (usually,
1780 but not always, a multicharacter mapping), is tried first.
1781
1782 C<special> is a string, normally C<NULL> or C<"">.  C<NULL> means to not use
1783 any special mappings; C<""> means to use the special mappings.  Values other
1784 than these two are treated as the name of the hash containing the special
1785 mappings, like C<"utf8::ToSpecLower">.
1786
1787 C<normal> is a string like C<"ToLower"> which means the swash
1788 C<%utf8::ToLower>.
1789
1790 Code points above the platform's C<IV_MAX> will raise a deprecation warning,
1791 unless those are turned off.
1792
1793 =cut */
1794
1795 UV
1796 Perl_to_utf8_case(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp,
1797                         SV **swashp, const char *normal, const char *special)
1798 {
1799     PERL_ARGS_ASSERT_TO_UTF8_CASE;
1800
1801     return _to_utf8_case(valid_utf8_to_uvchr(p, NULL), p, ustrp, lenp, swashp, normal, special);
1802 }
1803
1804     /* change namve uv1 to 'from' */
1805 STATIC UV
1806 S__to_utf8_case(pTHX_ const UV uv1, const U8 *p, U8* ustrp, STRLEN *lenp,
1807                 SV **swashp, const char *normal, const char *special)
1808 {
1809     STRLEN len = 0;
1810
1811     PERL_ARGS_ASSERT__TO_UTF8_CASE;
1812
1813     /* For code points that don't change case, we already know that the output
1814      * of this function is the unchanged input, so we can skip doing look-ups
1815      * for them.  Unfortunately the case-changing code points are scattered
1816      * around.  But there are some long consecutive ranges where there are no
1817      * case changing code points.  By adding tests, we can eliminate the lookup
1818      * for all the ones in such ranges.  This is currently done here only for
1819      * just a few cases where the scripts are in common use in modern commerce
1820      * (and scripts adjacent to those which can be included without additional
1821      * tests). */
1822
1823     if (uv1 >= 0x0590) {
1824         /* This keeps from needing further processing the code points most
1825          * likely to be used in the following non-cased scripts: Hebrew,
1826          * Arabic, Syriac, Thaana, NKo, Samaritan, Mandaic, Devanagari,
1827          * Bengali, Gurmukhi, Gujarati, Oriya, Tamil, Telugu, Kannada,
1828          * Malayalam, Sinhala, Thai, Lao, Tibetan, Myanmar */
1829         if (uv1 < 0x10A0) {
1830             goto cases_to_self;
1831         }
1832
1833         /* The following largish code point ranges also don't have case
1834          * changes, but khw didn't think they warranted extra tests to speed
1835          * them up (which would slightly slow down everything else above them):
1836          * 1100..139F   Hangul Jamo, Ethiopic
1837          * 1400..1CFF   Unified Canadian Aboriginal Syllabics, Ogham, Runic,
1838          *              Tagalog, Hanunoo, Buhid, Tagbanwa, Khmer, Mongolian,
1839          *              Limbu, Tai Le, New Tai Lue, Buginese, Tai Tham,
1840          *              Combining Diacritical Marks Extended, Balinese,
1841          *              Sundanese, Batak, Lepcha, Ol Chiki
1842          * 2000..206F   General Punctuation
1843          */
1844
1845         if (uv1 >= 0x2D30) {
1846
1847             /* This keeps the from needing further processing the code points
1848              * most likely to be used in the following non-cased major scripts:
1849              * CJK, Katakana, Hiragana, plus some less-likely scripts.
1850              *
1851              * (0x2D30 above might have to be changed to 2F00 in the unlikely
1852              * event that Unicode eventually allocates the unused block as of
1853              * v8.0 2FE0..2FEF to code points that are cased.  khw has verified
1854              * that the test suite will start having failures to alert you
1855              * should that happen) */
1856             if (uv1 < 0xA640) {
1857                 goto cases_to_self;
1858             }
1859
1860             if (uv1 >= 0xAC00) {
1861                 if (UNLIKELY(UNICODE_IS_SURROGATE(uv1))) {
1862                     if (ckWARN_d(WARN_SURROGATE)) {
1863                         const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
1864                         Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
1865                             "Operation \"%s\" returns its argument for UTF-16 surrogate U+%04"UVXf"", desc, uv1);
1866                     }
1867                     goto cases_to_self;
1868                 }
1869
1870                 /* AC00..FAFF Catches Hangul syllables and private use, plus
1871                  * some others */
1872                 if (uv1 < 0xFB00) {
1873                     goto cases_to_self;
1874
1875                 }
1876
1877                 if (UNLIKELY(UNICODE_IS_SUPER(uv1))) {
1878                     if (   UNLIKELY(uv1 > MAX_NON_DEPRECATED_CP)
1879                         && ckWARN_d(WARN_DEPRECATED))
1880                     {
1881                         Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
1882                                 cp_above_legal_max, uv1, MAX_NON_DEPRECATED_CP);
1883                     }
1884                     if (ckWARN_d(WARN_NON_UNICODE)) {
1885                         const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
1886                         Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
1887                             "Operation \"%s\" returns its argument for non-Unicode code point 0x%04"UVXf"", desc, uv1);
1888                     }
1889                     goto cases_to_self;
1890                 }
1891 #ifdef HIGHEST_CASE_CHANGING_CP_FOR_USE_ONLY_BY_UTF8_DOT_C
1892                 if (UNLIKELY(uv1
1893                     > HIGHEST_CASE_CHANGING_CP_FOR_USE_ONLY_BY_UTF8_DOT_C))
1894                 {
1895
1896                     /* As of this writing, this means we avoid swash creation
1897                      * for anything beyond low Plane 1 */
1898                     goto cases_to_self;
1899                 }
1900 #endif
1901             }
1902         }
1903
1904         /* Note that non-characters are perfectly legal, so no warning should
1905          * be given.  There are so few of them, that it isn't worth the extra
1906          * tests to avoid swash creation */
1907     }
1908
1909     if (!*swashp) /* load on-demand */
1910          *swashp = _core_swash_init("utf8", normal, &PL_sv_undef, 4, 0, NULL, NULL);
1911
1912     if (special) {
1913          /* It might be "special" (sometimes, but not always,
1914           * a multicharacter mapping) */
1915          HV *hv = NULL;
1916          SV **svp;
1917
1918          /* If passed in the specials name, use that; otherwise use any
1919           * given in the swash */
1920          if (*special != '\0') {
1921             hv = get_hv(special, 0);
1922         }
1923         else {
1924             svp = hv_fetchs(MUTABLE_HV(SvRV(*swashp)), "SPECIALS", 0);
1925             if (svp) {
1926                 hv = MUTABLE_HV(SvRV(*svp));
1927             }
1928         }
1929
1930          if (hv
1931              && (svp = hv_fetch(hv, (const char*)p, UVCHR_SKIP(uv1), FALSE))
1932              && (*svp))
1933          {
1934              const char *s;
1935
1936               s = SvPV_const(*svp, len);
1937               if (len == 1)
1938                   /* EIGHTBIT */
1939                    len = uvchr_to_utf8(ustrp, *(U8*)s) - ustrp;
1940               else {
1941                    Copy(s, ustrp, len, U8);
1942               }
1943          }
1944     }
1945
1946     if (!len && *swashp) {
1947         const UV uv2 = swash_fetch(*swashp, p, TRUE /* => is UTF-8 */);
1948
1949          if (uv2) {
1950               /* It was "normal" (a single character mapping). */
1951               len = uvchr_to_utf8(ustrp, uv2) - ustrp;
1952          }
1953     }
1954
1955     if (len) {
1956         if (lenp) {
1957             *lenp = len;
1958         }
1959         return valid_utf8_to_uvchr(ustrp, 0);
1960     }
1961
1962     /* Here, there was no mapping defined, which means that the code point maps
1963      * to itself.  Return the inputs */
1964   cases_to_self:
1965     len = UTF8SKIP(p);
1966     if (p != ustrp) {   /* Don't copy onto itself */
1967         Copy(p, ustrp, len, U8);
1968     }
1969
1970     if (lenp)
1971          *lenp = len;
1972
1973     return uv1;
1974
1975 }
1976
1977 STATIC UV
1978 S_check_locale_boundary_crossing(pTHX_ const U8* const p, const UV result, U8* const ustrp, STRLEN *lenp)
1979 {
1980     /* This is called when changing the case of a UTF-8-encoded character above
1981      * the Latin1 range, and the operation is in a non-UTF-8 locale.  If the
1982      * result contains a character that crosses the 255/256 boundary, disallow
1983      * the change, and return the original code point.  See L<perlfunc/lc> for
1984      * why;
1985      *
1986      * p        points to the original string whose case was changed; assumed
1987      *          by this routine to be well-formed
1988      * result   the code point of the first character in the changed-case string
1989      * ustrp    points to the changed-case string (<result> represents its first char)
1990      * lenp     points to the length of <ustrp> */
1991
1992     UV original;    /* To store the first code point of <p> */
1993
1994     PERL_ARGS_ASSERT_CHECK_LOCALE_BOUNDARY_CROSSING;
1995
1996     assert(UTF8_IS_ABOVE_LATIN1(*p));
1997
1998     /* We know immediately if the first character in the string crosses the
1999      * boundary, so can skip */
2000     if (result > 255) {
2001
2002         /* Look at every character in the result; if any cross the
2003         * boundary, the whole thing is disallowed */
2004         U8* s = ustrp + UTF8SKIP(ustrp);
2005         U8* e = ustrp + *lenp;
2006         while (s < e) {
2007             if (! UTF8_IS_ABOVE_LATIN1(*s)) {
2008                 goto bad_crossing;
2009             }
2010             s += UTF8SKIP(s);
2011         }
2012
2013         /* Here, no characters crossed, result is ok as-is, but we warn. */
2014         _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(p, p + UTF8SKIP(p));
2015         return result;
2016     }
2017
2018   bad_crossing:
2019
2020     /* Failed, have to return the original */
2021     original = valid_utf8_to_uvchr(p, lenp);
2022
2023     /* diag_listed_as: Can't do %s("%s") on non-UTF-8 locale; resolved to "%s". */
2024     Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
2025                            "Can't do %s(\"\\x{%"UVXf"}\") on non-UTF-8 locale; "
2026                            "resolved to \"\\x{%"UVXf"}\".",
2027                            OP_DESC(PL_op),
2028                            original,
2029                            original);
2030     Copy(p, ustrp, *lenp, char);
2031     return original;
2032 }
2033
2034 /*
2035 =for apidoc to_utf8_upper
2036
2037 Instead use L</toUPPER_utf8>.
2038
2039 =cut */
2040
2041 /* Not currently externally documented, and subject to change:
2042  * <flags> is set iff iff the rules from the current underlying locale are to
2043  *         be used. */
2044
2045 UV
2046 Perl__to_utf8_upper_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, bool flags)
2047 {
2048     UV result;
2049
2050     PERL_ARGS_ASSERT__TO_UTF8_UPPER_FLAGS;
2051
2052     if (flags) {
2053         /* Treat a UTF-8 locale as not being in locale at all */
2054         if (IN_UTF8_CTYPE_LOCALE) {
2055             flags = FALSE;
2056         }
2057         else {
2058             _CHECK_AND_WARN_PROBLEMATIC_LOCALE;
2059         }
2060     }
2061
2062     if (UTF8_IS_INVARIANT(*p)) {
2063         if (flags) {
2064             result = toUPPER_LC(*p);
2065         }
2066         else {
2067             return _to_upper_title_latin1(*p, ustrp, lenp, 'S');
2068         }
2069     }
2070     else if UTF8_IS_DOWNGRADEABLE_START(*p) {
2071         if (flags) {
2072             U8 c = EIGHT_BIT_UTF8_TO_NATIVE(*p, *(p+1));
2073             result = toUPPER_LC(c);
2074         }
2075         else {
2076             return _to_upper_title_latin1(EIGHT_BIT_UTF8_TO_NATIVE(*p, *(p+1)),
2077                                           ustrp, lenp, 'S');
2078         }
2079     }
2080     else {  /* UTF-8, ord above 255 */
2081         result = CALL_UPPER_CASE(valid_utf8_to_uvchr(p, NULL), p, ustrp, lenp);
2082
2083         if (flags) {
2084             result = check_locale_boundary_crossing(p, result, ustrp, lenp);
2085         }
2086         return result;
2087     }
2088
2089     /* Here, used locale rules.  Convert back to UTF-8 */
2090     if (UTF8_IS_INVARIANT(result)) {
2091         *ustrp = (U8) result;
2092         *lenp = 1;
2093     }
2094     else {
2095         *ustrp = UTF8_EIGHT_BIT_HI((U8) result);
2096         *(ustrp + 1) = UTF8_EIGHT_BIT_LO((U8) result);
2097         *lenp = 2;
2098     }
2099
2100     return result;
2101 }
2102
2103 /*
2104 =for apidoc to_utf8_title
2105
2106 Instead use L</toTITLE_utf8>.
2107
2108 =cut */
2109
2110 /* Not currently externally documented, and subject to change:
2111  * <flags> is set iff the rules from the current underlying locale are to be
2112  *         used.  Since titlecase is not defined in POSIX, for other than a
2113  *         UTF-8 locale, uppercase is used instead for code points < 256.
2114  */
2115
2116 UV
2117 Perl__to_utf8_title_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, bool flags)
2118 {
2119     UV result;
2120
2121     PERL_ARGS_ASSERT__TO_UTF8_TITLE_FLAGS;
2122
2123     if (flags) {
2124         /* Treat a UTF-8 locale as not being in locale at all */
2125         if (IN_UTF8_CTYPE_LOCALE) {
2126             flags = FALSE;
2127         }
2128         else {
2129             _CHECK_AND_WARN_PROBLEMATIC_LOCALE;
2130         }
2131     }
2132
2133     if (UTF8_IS_INVARIANT(*p)) {
2134         if (flags) {
2135             result = toUPPER_LC(*p);
2136         }
2137         else {
2138             return _to_upper_title_latin1(*p, ustrp, lenp, 's');
2139         }
2140     }
2141     else if UTF8_IS_DOWNGRADEABLE_START(*p) {
2142         if (flags) {
2143             U8 c = EIGHT_BIT_UTF8_TO_NATIVE(*p, *(p+1));
2144             result = toUPPER_LC(c);
2145         }
2146         else {
2147             return _to_upper_title_latin1(EIGHT_BIT_UTF8_TO_NATIVE(*p, *(p+1)),
2148                                           ustrp, lenp, 's');
2149         }
2150     }
2151     else {  /* UTF-8, ord above 255 */
2152         result = CALL_TITLE_CASE(valid_utf8_to_uvchr(p, NULL), p, ustrp, lenp);
2153
2154         if (flags) {
2155             result = check_locale_boundary_crossing(p, result, ustrp, lenp);
2156         }
2157         return result;
2158     }
2159
2160     /* Here, used locale rules.  Convert back to UTF-8 */
2161     if (UTF8_IS_INVARIANT(result)) {
2162         *ustrp = (U8) result;
2163         *lenp = 1;
2164     }
2165     else {
2166         *ustrp = UTF8_EIGHT_BIT_HI((U8) result);
2167         *(ustrp + 1) = UTF8_EIGHT_BIT_LO((U8) result);
2168         *lenp = 2;
2169     }
2170
2171     return result;
2172 }
2173
2174 /*
2175 =for apidoc to_utf8_lower
2176
2177 Instead use L</toLOWER_utf8>.
2178
2179 =cut */
2180
2181 /* Not currently externally documented, and subject to change:
2182  * <flags> is set iff iff the rules from the current underlying locale are to
2183  *         be used.
2184  */
2185
2186 UV
2187 Perl__to_utf8_lower_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, bool flags)
2188 {
2189     UV result;
2190
2191     PERL_ARGS_ASSERT__TO_UTF8_LOWER_FLAGS;
2192
2193     if (flags) {
2194         /* Treat a UTF-8 locale as not being in locale at all */
2195         if (IN_UTF8_CTYPE_LOCALE) {
2196             flags = FALSE;
2197         }
2198         else {
2199             _CHECK_AND_WARN_PROBLEMATIC_LOCALE;
2200         }
2201     }
2202
2203     if (UTF8_IS_INVARIANT(*p)) {
2204         if (flags) {
2205             result = toLOWER_LC(*p);
2206         }
2207         else {
2208             return to_lower_latin1(*p, ustrp, lenp);
2209         }
2210     }
2211     else if UTF8_IS_DOWNGRADEABLE_START(*p) {
2212         if (flags) {
2213             U8 c = EIGHT_BIT_UTF8_TO_NATIVE(*p, *(p+1));
2214             result = toLOWER_LC(c);
2215         }
2216         else {
2217             return to_lower_latin1(EIGHT_BIT_UTF8_TO_NATIVE(*p, *(p+1)),
2218                                    ustrp, lenp);
2219         }
2220     }
2221     else {  /* UTF-8, ord above 255 */
2222         result = CALL_LOWER_CASE(valid_utf8_to_uvchr(p, NULL), p, ustrp, lenp);
2223
2224         if (flags) {
2225             result = check_locale_boundary_crossing(p, result, ustrp, lenp);
2226         }
2227
2228         return result;
2229     }
2230
2231     /* Here, used locale rules.  Convert back to UTF-8 */
2232     if (UTF8_IS_INVARIANT(result)) {
2233         *ustrp = (U8) result;
2234         *lenp = 1;
2235     }
2236     else {
2237         *ustrp = UTF8_EIGHT_BIT_HI((U8) result);
2238         *(ustrp + 1) = UTF8_EIGHT_BIT_LO((U8) result);
2239         *lenp = 2;
2240     }
2241
2242     return result;
2243 }
2244
2245 /*
2246 =for apidoc to_utf8_fold
2247
2248 Instead use L</toFOLD_utf8>.
2249
2250 =cut */
2251
2252 /* Not currently externally documented, and subject to change,
2253  * in <flags>
2254  *      bit FOLD_FLAGS_LOCALE is set iff the rules from the current underlying
2255  *                            locale are to be used.
2256  *      bit FOLD_FLAGS_FULL   is set iff full case folds are to be used;
2257  *                            otherwise simple folds
2258  *      bit FOLD_FLAGS_NOMIX_ASCII is set iff folds of non-ASCII to ASCII are
2259  *                            prohibited
2260  */
2261
2262 UV
2263 Perl__to_utf8_fold_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, U8 flags)
2264 {
2265     UV result;
2266
2267     PERL_ARGS_ASSERT__TO_UTF8_FOLD_FLAGS;
2268
2269     /* These are mutually exclusive */
2270     assert (! ((flags & FOLD_FLAGS_LOCALE) && (flags & FOLD_FLAGS_NOMIX_ASCII)));
2271
2272     assert(p != ustrp); /* Otherwise overwrites */
2273
2274     if (flags & FOLD_FLAGS_LOCALE) {
2275         /* Treat a UTF-8 locale as not being in locale at all */
2276         if (IN_UTF8_CTYPE_LOCALE) {
2277             flags &= ~FOLD_FLAGS_LOCALE;
2278         }
2279         else {
2280             _CHECK_AND_WARN_PROBLEMATIC_LOCALE;
2281         }
2282     }
2283
2284     if (UTF8_IS_INVARIANT(*p)) {
2285         if (flags & FOLD_FLAGS_LOCALE) {
2286             result = toFOLD_LC(*p);
2287         }
2288         else {
2289             return _to_fold_latin1(*p, ustrp, lenp,
2290                             flags & (FOLD_FLAGS_FULL | FOLD_FLAGS_NOMIX_ASCII));
2291         }
2292     }
2293     else if UTF8_IS_DOWNGRADEABLE_START(*p) {
2294         if (flags & FOLD_FLAGS_LOCALE) {
2295             U8 c = EIGHT_BIT_UTF8_TO_NATIVE(*p, *(p+1));
2296             result = toFOLD_LC(c);
2297         }
2298         else {
2299             return _to_fold_latin1(EIGHT_BIT_UTF8_TO_NATIVE(*p, *(p+1)),
2300                             ustrp, lenp,
2301                             flags & (FOLD_FLAGS_FULL | FOLD_FLAGS_NOMIX_ASCII));
2302         }
2303     }
2304     else {  /* UTF-8, ord above 255 */
2305         result = CALL_FOLD_CASE(valid_utf8_to_uvchr(p, NULL), p, ustrp, lenp, flags & FOLD_FLAGS_FULL);
2306
2307         if (flags & FOLD_FLAGS_LOCALE) {
2308
2309 #           define LONG_S_T      LATIN_SMALL_LIGATURE_LONG_S_T_UTF8
2310             const unsigned int long_s_t_len    = sizeof(LONG_S_T) - 1;
2311
2312 #         ifdef LATIN_CAPITAL_LETTER_SHARP_S_UTF8
2313 #           define CAP_SHARP_S   LATIN_CAPITAL_LETTER_SHARP_S_UTF8
2314
2315             const unsigned int cap_sharp_s_len = sizeof(CAP_SHARP_S) - 1;
2316
2317             /* Special case these two characters, as what normally gets
2318              * returned under locale doesn't work */
2319             if (UTF8SKIP(p) == cap_sharp_s_len
2320                 && memEQ((char *) p, CAP_SHARP_S, cap_sharp_s_len))
2321             {
2322                 /* diag_listed_as: Can't do %s("%s") on non-UTF-8 locale; resolved to "%s". */
2323                 Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
2324                               "Can't do fc(\"\\x{1E9E}\") on non-UTF-8 locale; "
2325                               "resolved to \"\\x{17F}\\x{17F}\".");
2326                 goto return_long_s;
2327             }
2328             else
2329 #endif
2330                  if (UTF8SKIP(p) == long_s_t_len
2331                      && memEQ((char *) p, LONG_S_T, long_s_t_len))
2332             {
2333                 /* diag_listed_as: Can't do %s("%s") on non-UTF-8 locale; resolved to "%s". */
2334                 Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
2335                               "Can't do fc(\"\\x{FB05}\") on non-UTF-8 locale; "
2336                               "resolved to \"\\x{FB06}\".");
2337                 goto return_ligature_st;
2338             }
2339
2340 #if    UNICODE_MAJOR_VERSION   == 3         \
2341     && UNICODE_DOT_VERSION     == 0         \
2342     && UNICODE_DOT_DOT_VERSION == 1
2343 #           define DOTTED_I   LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE_UTF8
2344
2345             /* And special case this on this Unicode version only, for the same
2346              * reaons the other two are special cased.  They would cross the
2347              * 255/256 boundary which is forbidden under /l, and so the code
2348              * wouldn't catch that they are equivalent (which they are only in
2349              * this release) */
2350             else if (UTF8SKIP(p) == sizeof(DOTTED_I) - 1
2351                      && memEQ((char *) p, DOTTED_I, sizeof(DOTTED_I) - 1))
2352             {
2353                 /* diag_listed_as: Can't do %s("%s") on non-UTF-8 locale; resolved to "%s". */
2354                 Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
2355                               "Can't do fc(\"\\x{0130}\") on non-UTF-8 locale; "
2356                               "resolved to \"\\x{0131}\".");
2357                 goto return_dotless_i;
2358             }
2359 #endif
2360
2361             return check_locale_boundary_crossing(p, result, ustrp, lenp);
2362         }
2363         else if (! (flags & FOLD_FLAGS_NOMIX_ASCII)) {
2364             return result;
2365         }
2366         else {
2367             /* This is called when changing the case of a UTF-8-encoded
2368              * character above the ASCII range, and the result should not
2369              * contain an ASCII character. */
2370
2371             UV original;    /* To store the first code point of <p> */
2372
2373             /* Look at every character in the result; if any cross the
2374             * boundary, the whole thing is disallowed */
2375             U8* s = ustrp;
2376             U8* e = ustrp + *lenp;
2377             while (s < e) {
2378                 if (isASCII(*s)) {
2379                     /* Crossed, have to return the original */
2380                     original = valid_utf8_to_uvchr(p, lenp);
2381
2382                     /* But in these instances, there is an alternative we can
2383                      * return that is valid */
2384                     if (original == LATIN_SMALL_LETTER_SHARP_S
2385 #ifdef LATIN_CAPITAL_LETTER_SHARP_S /* not defined in early Unicode releases */
2386                         || original == LATIN_CAPITAL_LETTER_SHARP_S
2387 #endif
2388                     ) {
2389                         goto return_long_s;
2390                     }
2391                     else if (original == LATIN_SMALL_LIGATURE_LONG_S_T) {
2392                         goto return_ligature_st;
2393                     }
2394 #if    UNICODE_MAJOR_VERSION   == 3         \
2395     && UNICODE_DOT_VERSION     == 0         \
2396     && UNICODE_DOT_DOT_VERSION == 1
2397
2398                     else if (original == LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE) {
2399                         goto return_dotless_i;
2400                     }
2401 #endif
2402                     Copy(p, ustrp, *lenp, char);
2403                     return original;
2404                 }
2405                 s += UTF8SKIP(s);
2406             }
2407
2408             /* Here, no characters crossed, result is ok as-is */
2409             return result;
2410         }
2411     }
2412
2413     /* Here, used locale rules.  Convert back to UTF-8 */
2414     if (UTF8_IS_INVARIANT(result)) {
2415         *ustrp = (U8) result;
2416         *lenp = 1;
2417     }
2418     else {
2419         *ustrp = UTF8_EIGHT_BIT_HI((U8) result);
2420         *(ustrp + 1) = UTF8_EIGHT_BIT_LO((U8) result);
2421         *lenp = 2;
2422     }
2423
2424     return result;
2425
2426   return_long_s:
2427     /* Certain folds to 'ss' are prohibited by the options, but they do allow
2428      * folds to a string of two of these characters.  By returning this
2429      * instead, then, e.g.,
2430      *      fc("\x{1E9E}") eq fc("\x{17F}\x{17F}")
2431      * works. */
2432
2433     *lenp = 2 * sizeof(LATIN_SMALL_LETTER_LONG_S_UTF8) - 2;
2434     Copy(LATIN_SMALL_LETTER_LONG_S_UTF8 LATIN_SMALL_LETTER_LONG_S_UTF8,
2435         ustrp, *lenp, U8);
2436     return LATIN_SMALL_LETTER_LONG_S;
2437
2438   return_ligature_st:
2439     /* Two folds to 'st' are prohibited by the options; instead we pick one and
2440      * have the other one fold to it */
2441
2442     *lenp = sizeof(LATIN_SMALL_LIGATURE_ST_UTF8) - 1;
2443     Copy(LATIN_SMALL_LIGATURE_ST_UTF8, ustrp, *lenp, U8);
2444     return LATIN_SMALL_LIGATURE_ST;
2445
2446 #if    UNICODE_MAJOR_VERSION   == 3         \
2447     && UNICODE_DOT_VERSION     == 0         \
2448     && UNICODE_DOT_DOT_VERSION == 1
2449
2450   return_dotless_i:
2451     *lenp = sizeof(LATIN_SMALL_LETTER_DOTLESS_I_UTF8) - 1;
2452     Copy(LATIN_SMALL_LETTER_DOTLESS_I_UTF8, ustrp, *lenp, U8);
2453     return LATIN_SMALL_LETTER_DOTLESS_I;
2454
2455 #endif
2456
2457 }
2458
2459 /* Note:
2460  * Returns a "swash" which is a hash described in utf8.c:Perl_swash_fetch().
2461  * C<pkg> is a pointer to a package name for SWASHNEW, should be "utf8".
2462  * For other parameters, see utf8::SWASHNEW in lib/utf8_heavy.pl.
2463  */
2464
2465 SV*
2466 Perl_swash_init(pTHX_ const char* pkg, const char* name, SV *listsv, I32 minbits, I32 none)
2467 {
2468     PERL_ARGS_ASSERT_SWASH_INIT;
2469
2470     /* Returns a copy of a swash initiated by the called function.  This is the
2471      * public interface, and returning a copy prevents others from doing
2472      * mischief on the original */
2473
2474     return newSVsv(_core_swash_init(pkg, name, listsv, minbits, none, NULL, NULL));
2475 }
2476
2477 SV*
2478 Perl__core_swash_init(pTHX_ const char* pkg, const char* name, SV *listsv, I32 minbits, I32 none, SV* invlist, U8* const flags_p)
2479 {
2480
2481     /*NOTE NOTE NOTE - If you want to use "return" in this routine you MUST
2482      * use the following define */
2483
2484 #define CORE_SWASH_INIT_RETURN(x)   \
2485     PL_curpm= old_PL_curpm;         \
2486     return x
2487
2488     /* Initialize and return a swash, creating it if necessary.  It does this
2489      * by calling utf8_heavy.pl in the general case.  The returned value may be
2490      * the swash's inversion list instead if the input parameters allow it.
2491      * Which is returned should be immaterial to callers, as the only
2492      * operations permitted on a swash, swash_fetch(), _get_swash_invlist(),
2493      * and swash_to_invlist() handle both these transparently.
2494      *
2495      * This interface should only be used by functions that won't destroy or
2496      * adversely change the swash, as doing so affects all other uses of the
2497      * swash in the program; the general public should use 'Perl_swash_init'
2498      * instead.
2499      *
2500      * pkg  is the name of the package that <name> should be in.
2501      * name is the name of the swash to find.  Typically it is a Unicode
2502      *      property name, including user-defined ones
2503      * listsv is a string to initialize the swash with.  It must be of the form
2504      *      documented as the subroutine return value in
2505      *      L<perlunicode/User-Defined Character Properties>
2506      * minbits is the number of bits required to represent each data element.
2507      *      It is '1' for binary properties.
2508      * none I (khw) do not understand this one, but it is used only in tr///.
2509      * invlist is an inversion list to initialize the swash with (or NULL)
2510      * flags_p if non-NULL is the address of various input and output flag bits
2511      *      to the routine, as follows:  ('I' means is input to the routine;
2512      *      'O' means output from the routine.  Only flags marked O are
2513      *      meaningful on return.)
2514      *  _CORE_SWASH_INIT_USER_DEFINED_PROPERTY indicates if the swash
2515      *      came from a user-defined property.  (I O)
2516      *  _CORE_SWASH_INIT_RETURN_IF_UNDEF indicates that instead of croaking
2517      *      when the swash cannot be located, to simply return NULL. (I)
2518      *  _CORE_SWASH_INIT_ACCEPT_INVLIST indicates that the caller will accept a
2519      *      return of an inversion list instead of a swash hash if this routine
2520      *      thinks that would result in faster execution of swash_fetch() later
2521      *      on. (I)
2522      *
2523      * Thus there are three possible inputs to find the swash: <name>,
2524      * <listsv>, and <invlist>.  At least one must be specified.  The result
2525      * will be the union of the specified ones, although <listsv>'s various
2526      * actions can intersect, etc. what <name> gives.  To avoid going out to
2527      * disk at all, <invlist> should specify completely what the swash should
2528      * have, and <listsv> should be &PL_sv_undef and <name> should be "".
2529      *
2530      * <invlist> is only valid for binary properties */
2531
2532     PMOP *old_PL_curpm= PL_curpm; /* save away the old PL_curpm */
2533
2534     SV* retval = &PL_sv_undef;
2535     HV* swash_hv = NULL;
2536     const int invlist_swash_boundary =
2537         (flags_p && *flags_p & _CORE_SWASH_INIT_ACCEPT_INVLIST)
2538         ? 512    /* Based on some benchmarking, but not extensive, see commit
2539                     message */
2540         : -1;   /* Never return just an inversion list */
2541
2542     assert(listsv != &PL_sv_undef || strNE(name, "") || invlist);
2543     assert(! invlist || minbits == 1);
2544
2545     PL_curpm= NULL; /* reset PL_curpm so that we dont get confused between the regex
2546                        that triggered the swash init and the swash init perl logic itself.
2547                        See perl #122747 */
2548
2549     /* If data was passed in to go out to utf8_heavy to find the swash of, do
2550      * so */
2551     if (listsv != &PL_sv_undef || strNE(name, "")) {
2552         dSP;
2553         const size_t pkg_len = strlen(pkg);
2554         const size_t name_len = strlen(name);
2555         HV * const stash = gv_stashpvn(pkg, pkg_len, 0);
2556         SV* errsv_save;
2557         GV *method;
2558
2559         PERL_ARGS_ASSERT__CORE_SWASH_INIT;
2560
2561         PUSHSTACKi(PERLSI_MAGIC);
2562         ENTER;
2563         SAVEHINTS();
2564         save_re_context();
2565         /* We might get here via a subroutine signature which uses a utf8
2566          * parameter name, at which point PL_subname will have been set
2567          * but not yet used. */
2568         save_item(PL_subname);
2569         if (PL_parser && PL_parser->error_count)
2570             SAVEI8(PL_parser->error_count), PL_parser->error_count = 0;
2571         method = gv_fetchmeth(stash, "SWASHNEW", 8, -1);
2572         if (!method) {  /* demand load UTF-8 */
2573             ENTER;
2574             if ((errsv_save = GvSV(PL_errgv))) SAVEFREESV(errsv_save);
2575             GvSV(PL_errgv) = NULL;
2576 #ifndef NO_TAINT_SUPPORT
2577             /* It is assumed that callers of this routine are not passing in
2578              * any user derived data.  */
2579             /* Need to do this after save_re_context() as it will set
2580              * PL_tainted to 1 while saving $1 etc (see the code after getrx:
2581              * in Perl_magic_get).  Even line to create errsv_save can turn on
2582              * PL_tainted.  */
2583             SAVEBOOL(TAINT_get);
2584             TAINT_NOT;
2585 #endif
2586             Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpvn(pkg,pkg_len),
2587                              NULL);
2588             {
2589                 /* Not ERRSV, as there is no need to vivify a scalar we are
2590                    about to discard. */
2591                 SV * const errsv = GvSV(PL_errgv);
2592                 if (!SvTRUE(errsv)) {
2593                     GvSV(PL_errgv) = SvREFCNT_inc_simple(errsv_save);
2594                     SvREFCNT_dec(errsv);
2595                 }
2596             }
2597             LEAVE;
2598         }
2599         SPAGAIN;
2600         PUSHMARK(SP);
2601         EXTEND(SP,5);
2602         mPUSHp(pkg, pkg_len);
2603         mPUSHp(name, name_len);
2604         PUSHs(listsv);
2605         mPUSHi(minbits);
2606         mPUSHi(none);
2607         PUTBACK;
2608         if ((errsv_save = GvSV(PL_errgv))) SAVEFREESV(errsv_save);
2609         GvSV(PL_errgv) = NULL;
2610         /* If we already have a pointer to the method, no need to use
2611          * call_method() to repeat the lookup.  */
2612         if (method
2613             ? call_sv(MUTABLE_SV(method), G_SCALAR)
2614             : call_sv(newSVpvs_flags("SWASHNEW", SVs_TEMP), G_SCALAR | G_METHOD))
2615         {
2616             retval = *PL_stack_sp--;
2617             SvREFCNT_inc(retval);
2618         }
2619         {
2620             /* Not ERRSV.  See above. */
2621             SV * const errsv = GvSV(PL_errgv);
2622             if (!SvTRUE(errsv)) {
2623                 GvSV(PL_errgv) = SvREFCNT_inc_simple(errsv_save);
2624                 SvREFCNT_dec(errsv);
2625             }
2626         }
2627         LEAVE;
2628         POPSTACK;
2629         if (IN_PERL_COMPILETIME) {
2630             CopHINTS_set(PL_curcop, PL_hints);
2631         }
2632         if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV) {
2633             if (SvPOK(retval)) {
2634
2635                 /* If caller wants to handle missing properties, let them */
2636                 if (flags_p && *flags_p & _CORE_SWASH_INIT_RETURN_IF_UNDEF) {
2637                     CORE_SWASH_INIT_RETURN(NULL);
2638                 }
2639                 Perl_croak(aTHX_
2640                            "Can't find Unicode property definition \"%"SVf"\"",
2641                            SVfARG(retval));
2642                 NOT_REACHED; /* NOTREACHED */
2643             }
2644         }
2645     } /* End of calling the module to find the swash */
2646
2647     /* If this operation fetched a swash, and we will need it later, get it */
2648     if (retval != &PL_sv_undef
2649         && (minbits == 1 || (flags_p
2650                             && ! (*flags_p
2651                                   & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY))))
2652     {
2653         swash_hv = MUTABLE_HV(SvRV(retval));
2654
2655         /* If we don't already know that there is a user-defined component to
2656          * this swash, and the user has indicated they wish to know if there is
2657          * one (by passing <flags_p>), find out */
2658         if (flags_p && ! (*flags_p & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY)) {
2659             SV** user_defined = hv_fetchs(swash_hv, "USER_DEFINED", FALSE);
2660             if (user_defined && SvUV(*user_defined)) {
2661                 *flags_p |= _CORE_SWASH_INIT_USER_DEFINED_PROPERTY;
2662             }
2663         }
2664     }
2665
2666     /* Make sure there is an inversion list for binary properties */
2667     if (minbits == 1) {
2668         SV** swash_invlistsvp = NULL;
2669         SV* swash_invlist = NULL;
2670         bool invlist_in_swash_is_valid = FALSE;
2671         bool swash_invlist_unclaimed = FALSE; /* whether swash_invlist has
2672                                             an unclaimed reference count */
2673
2674         /* If this operation fetched a swash, get its already existing
2675          * inversion list, or create one for it */
2676
2677         if (swash_hv) {
2678             swash_invlistsvp = hv_fetchs(swash_hv, "V", FALSE);
2679             if (swash_invlistsvp) {
2680                 swash_invlist = *swash_invlistsvp;
2681                 invlist_in_swash_is_valid = TRUE;
2682             }
2683             else {
2684                 swash_invlist = _swash_to_invlist(retval);
2685                 swash_invlist_unclaimed = TRUE;
2686             }
2687         }
2688
2689         /* If an inversion list was passed in, have to include it */
2690         if (invlist) {
2691
2692             /* Any fetched swash will by now have an inversion list in it;
2693              * otherwise <swash_invlist>  will be NULL, indicating that we
2694              * didn't fetch a swash */
2695             if (swash_invlist) {
2696
2697                 /* Add the passed-in inversion list, which invalidates the one
2698                  * already stored in the swash */
2699                 invlist_in_swash_is_valid = FALSE;
2700                 _invlist_union(invlist, swash_invlist, &swash_invlist);
2701             }
2702             else {
2703
2704                 /* Here, there is no swash already.  Set up a minimal one, if
2705                  * we are going to return a swash */
2706                 if ((int) _invlist_len(invlist) > invlist_swash_boundary) {
2707                     swash_hv = newHV();
2708                     retval = newRV_noinc(MUTABLE_SV(swash_hv));
2709                 }
2710                 swash_invlist = invlist;
2711             }
2712         }
2713
2714         /* Here, we have computed the union of all the passed-in data.  It may
2715          * be that there was an inversion list in the swash which didn't get
2716          * touched; otherwise save the computed one */
2717         if (! invlist_in_swash_is_valid
2718             && (int) _invlist_len(swash_invlist) > invlist_swash_boundary)
2719         {
2720             if (! hv_stores(MUTABLE_HV(SvRV(retval)), "V", swash_invlist))
2721             {
2722                 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2723             }
2724             /* We just stole a reference count. */
2725             if (swash_invlist_unclaimed) swash_invlist_unclaimed = FALSE;
2726             else SvREFCNT_inc_simple_void_NN(swash_invlist);
2727         }
2728
2729         SvREADONLY_on(swash_invlist);
2730
2731         /* Use the inversion list stand-alone if small enough */
2732         if ((int) _invlist_len(swash_invlist) <= invlist_swash_boundary) {
2733             SvREFCNT_dec(retval);
2734             if (!swash_invlist_unclaimed)
2735                 SvREFCNT_inc_simple_void_NN(swash_invlist);
2736             retval = newRV_noinc(swash_invlist);
2737         }
2738     }
2739
2740     CORE_SWASH_INIT_RETURN(retval);
2741 #undef CORE_SWASH_INIT_RETURN
2742 }
2743
2744
2745 /* This API is wrong for special case conversions since we may need to
2746  * return several Unicode characters for a single Unicode character
2747  * (see lib/unicore/SpecCase.txt) The SWASHGET in lib/utf8_heavy.pl is
2748  * the lower-level routine, and it is similarly broken for returning
2749  * multiple values.  --jhi
2750  * For those, you should use S__to_utf8_case() instead */
2751 /* Now SWASHGET is recasted into S_swatch_get in this file. */
2752
2753 /* Note:
2754  * Returns the value of property/mapping C<swash> for the first character
2755  * of the string C<ptr>. If C<do_utf8> is true, the string C<ptr> is
2756  * assumed to be in well-formed UTF-8. If C<do_utf8> is false, the string C<ptr>
2757  * is assumed to be in native 8-bit encoding. Caches the swatch in C<swash>.
2758  *
2759  * A "swash" is a hash which contains initially the keys/values set up by
2760  * SWASHNEW.  The purpose is to be able to completely represent a Unicode
2761  * property for all possible code points.  Things are stored in a compact form
2762  * (see utf8_heavy.pl) so that calculation is required to find the actual
2763  * property value for a given code point.  As code points are looked up, new
2764  * key/value pairs are added to the hash, so that the calculation doesn't have
2765  * to ever be re-done.  Further, each calculation is done, not just for the
2766  * desired one, but for a whole block of code points adjacent to that one.
2767  * For binary properties on ASCII machines, the block is usually for 64 code
2768  * points, starting with a code point evenly divisible by 64.  Thus if the
2769  * property value for code point 257 is requested, the code goes out and
2770  * calculates the property values for all 64 code points between 256 and 319,
2771  * and stores these as a single 64-bit long bit vector, called a "swatch",
2772  * under the key for code point 256.  The key is the UTF-8 encoding for code
2773  * point 256, minus the final byte.  Thus, if the length of the UTF-8 encoding
2774  * for a code point is 13 bytes, the key will be 12 bytes long.  If the value
2775  * for code point 258 is then requested, this code realizes that it would be
2776  * stored under the key for 256, and would find that value and extract the
2777  * relevant bit, offset from 256.
2778  *
2779  * Non-binary properties are stored in as many bits as necessary to represent
2780  * their values (32 currently, though the code is more general than that), not
2781  * as single bits, but the principle is the same: the value for each key is a
2782  * vector that encompasses the property values for all code points whose UTF-8
2783  * representations are represented by the key.  That is, for all code points
2784  * whose UTF-8 representations are length N bytes, and the key is the first N-1
2785  * bytes of that.
2786  */
2787 UV
2788 Perl_swash_fetch(pTHX_ SV *swash, const U8 *ptr, bool do_utf8)
2789 {
2790     HV *const hv = MUTABLE_HV(SvRV(swash));
2791     U32 klen;
2792     U32 off;
2793     STRLEN slen = 0;
2794     STRLEN needents;
2795     const U8 *tmps = NULL;
2796     SV *swatch;
2797     const U8 c = *ptr;
2798
2799     PERL_ARGS_ASSERT_SWASH_FETCH;
2800
2801     /* If it really isn't a hash, it isn't really swash; must be an inversion
2802      * list */
2803     if (SvTYPE(hv) != SVt_PVHV) {
2804         return _invlist_contains_cp((SV*)hv,
2805                                     (do_utf8)
2806                                      ? valid_utf8_to_uvchr(ptr, NULL)
2807                                      : c);
2808     }
2809
2810     /* We store the values in a "swatch" which is a vec() value in a swash
2811      * hash.  Code points 0-255 are a single vec() stored with key length
2812      * (klen) 0.  All other code points have a UTF-8 representation
2813      * 0xAA..0xYY,0xZZ.  A vec() is constructed containing all of them which
2814      * share 0xAA..0xYY, which is the key in the hash to that vec.  So the key
2815      * length for them is the length of the encoded char - 1.  ptr[klen] is the
2816      * final byte in the sequence representing the character */
2817     if (!do_utf8 || UTF8_IS_INVARIANT(c)) {
2818         klen = 0;
2819         needents = 256;
2820         off = c;
2821     }
2822     else if (UTF8_IS_DOWNGRADEABLE_START(c)) {
2823         klen = 0;
2824         needents = 256;
2825         off = EIGHT_BIT_UTF8_TO_NATIVE(c, *(ptr + 1));
2826     }
2827     else {
2828         klen = UTF8SKIP(ptr) - 1;
2829
2830         /* Each vec() stores 2**UTF_ACCUMULATION_SHIFT values.  The offset into
2831          * the vec is the final byte in the sequence.  (In EBCDIC this is
2832          * converted to I8 to get consecutive values.)  To help you visualize
2833          * all this:
2834          *                       Straight 1047   After final byte
2835          *             UTF-8      UTF-EBCDIC     I8 transform
2836          *  U+0400:  \xD0\x80    \xB8\x41\x41    \xB8\x41\xA0
2837          *  U+0401:  \xD0\x81    \xB8\x41\x42    \xB8\x41\xA1
2838          *    ...
2839          *  U+0409:  \xD0\x89    \xB8\x41\x4A    \xB8\x41\xA9
2840          *  U+040A:  \xD0\x8A    \xB8\x41\x51    \xB8\x41\xAA
2841          *    ...
2842          *  U+0412:  \xD0\x92    \xB8\x41\x59    \xB8\x41\xB2
2843          *  U+0413:  \xD0\x93    \xB8\x41\x62    \xB8\x41\xB3
2844          *    ...
2845          *  U+041B:  \xD0\x9B    \xB8\x41\x6A    \xB8\x41\xBB
2846          *  U+041C:  \xD0\x9C    \xB8\x41\x70    \xB8\x41\xBC
2847          *    ...
2848          *  U+041F:  \xD0\x9F    \xB8\x41\x73    \xB8\x41\xBF
2849          *  U+0420:  \xD0\xA0    \xB8\x42\x41    \xB8\x42\x41
2850          *
2851          * (There are no discontinuities in the elided (...) entries.)
2852          * The UTF-8 key for these 33 code points is '\xD0' (which also is the
2853          * key for the next 31, up through U+043F, whose UTF-8 final byte is
2854          * \xBF).  Thus in UTF-8, each key is for a vec() for 64 code points.
2855          * The final UTF-8 byte, which ranges between \x80 and \xBF, is an
2856          * index into the vec() swatch (after subtracting 0x80, which we
2857          * actually do with an '&').
2858          * In UTF-EBCDIC, each key is for a 32 code point vec().  The first 32
2859          * code points above have key '\xB8\x41'. The final UTF-EBCDIC byte has
2860          * dicontinuities which go away by transforming it into I8, and we
2861          * effectively subtract 0xA0 to get the index. */
2862         needents = (1 << UTF_ACCUMULATION_SHIFT);
2863         off      = NATIVE_UTF8_TO_I8(ptr[klen]) & UTF_CONTINUATION_MASK;
2864     }
2865
2866     /*
2867      * This single-entry cache saves about 1/3 of the UTF-8 overhead in test
2868      * suite.  (That is, only 7-8% overall over just a hash cache.  Still,
2869      * it's nothing to sniff at.)  Pity we usually come through at least
2870      * two function calls to get here...
2871      *
2872      * NB: this code assumes that swatches are never modified, once generated!
2873      */
2874
2875     if (hv   == PL_last_swash_hv &&
2876         klen == PL_last_swash_klen &&
2877         (!klen || memEQ((char *)ptr, (char *)PL_last_swash_key, klen)) )
2878     {
2879         tmps = PL_last_swash_tmps;
2880         slen = PL_last_swash_slen;
2881     }
2882     else {
2883         /* Try our second-level swatch cache, kept in a hash. */
2884         SV** svp = hv_fetch(hv, (const char*)ptr, klen, FALSE);
2885
2886         /* If not cached, generate it via swatch_get */
2887         if (!svp || !SvPOK(*svp)
2888                  || !(tmps = (const U8*)SvPV_const(*svp, slen)))
2889         {
2890             if (klen) {
2891                 const UV code_point = valid_utf8_to_uvchr(ptr, NULL);
2892                 swatch = swatch_get(swash,
2893                                     code_point & ~((UV)needents - 1),
2894                                     needents);
2895             }
2896             else {  /* For the first 256 code points, the swatch has a key of
2897                        length 0 */
2898                 swatch = swatch_get(swash, 0, needents);
2899             }
2900
2901             if (IN_PERL_COMPILETIME)
2902                 CopHINTS_set(PL_curcop, PL_hints);
2903
2904             svp = hv_store(hv, (const char *)ptr, klen, swatch, 0);
2905
2906             if (!svp || !(tmps = (U8*)SvPV(*svp, slen))
2907                      || (slen << 3) < needents)
2908                 Perl_croak(aTHX_ "panic: swash_fetch got improper swatch, "
2909                            "svp=%p, tmps=%p, slen=%"UVuf", needents=%"UVuf,
2910                            svp, tmps, (UV)slen, (UV)needents);
2911         }
2912
2913         PL_last_swash_hv = hv;
2914         assert(klen <= sizeof(PL_last_swash_key));
2915         PL_last_swash_klen = (U8)klen;
2916         /* FIXME change interpvar.h?  */
2917         PL_last_swash_tmps = (U8 *) tmps;
2918         PL_last_swash_slen = slen;
2919         if (klen)
2920             Copy(ptr, PL_last_swash_key, klen, U8);
2921     }
2922
2923     switch ((int)((slen << 3) / needents)) {
2924     case 1:
2925         return ((UV) tmps[off >> 3] & (1 << (off & 7))) != 0;
2926     case 8:
2927         return ((UV) tmps[off]);
2928     case 16:
2929         off <<= 1;
2930         return
2931             ((UV) tmps[off    ] << 8) +
2932             ((UV) tmps[off + 1]);
2933     case 32:
2934         off <<= 2;
2935         return
2936             ((UV) tmps[off    ] << 24) +
2937             ((UV) tmps[off + 1] << 16) +
2938             ((UV) tmps[off + 2] <<  8) +
2939             ((UV) tmps[off + 3]);
2940     }
2941     Perl_croak(aTHX_ "panic: swash_fetch got swatch of unexpected bit width, "
2942                "slen=%"UVuf", needents=%"UVuf, (UV)slen, (UV)needents);
2943     NORETURN_FUNCTION_END;
2944 }
2945
2946 /* Read a single line of the main body of the swash input text.  These are of
2947  * the form:
2948  * 0053 0056    0073
2949  * where each number is hex.  The first two numbers form the minimum and
2950  * maximum of a range, and the third is the value associated with the range.
2951  * Not all swashes should have a third number
2952  *
2953  * On input: l    points to the beginning of the line to be examined; it points
2954  *                to somewhere in the string of the whole input text, and is
2955  *                terminated by a \n or the null string terminator.
2956  *           lend   points to the null terminator of that string
2957  *           wants_value    is non-zero if the swash expects a third number
2958  *           typestr is the name of the swash's mapping, like 'ToLower'
2959  * On output: *min, *max, and *val are set to the values read from the line.
2960  *            returns a pointer just beyond the line examined.  If there was no
2961  *            valid min number on the line, returns lend+1
2962  */
2963
2964 STATIC U8*
2965 S_swash_scan_list_line(pTHX_ U8* l, U8* const lend, UV* min, UV* max, UV* val,
2966                              const bool wants_value, const U8* const typestr)
2967 {
2968     const int  typeto  = typestr[0] == 'T' && typestr[1] == 'o';
2969     STRLEN numlen;          /* Length of the number */
2970     I32 flags = PERL_SCAN_SILENT_ILLDIGIT
2971                 | PERL_SCAN_DISALLOW_PREFIX
2972                 | PERL_SCAN_SILENT_NON_PORTABLE;
2973
2974     /* nl points to the next \n in the scan */
2975     U8* const nl = (U8*)memchr(l, '\n', lend - l);
2976
2977     PERL_ARGS_ASSERT_SWASH_SCAN_LIST_LINE;
2978
2979     /* Get the first number on the line: the range minimum */
2980     numlen = lend - l;
2981     *min = grok_hex((char *)l, &numlen, &flags, NULL);
2982     *max = *min;    /* So can never return without setting max */
2983     if (numlen)     /* If found a hex number, position past it */
2984         l += numlen;
2985     else if (nl) {          /* Else, go handle next line, if any */
2986         return nl + 1;  /* 1 is length of "\n" */
2987     }
2988     else {              /* Else, no next line */
2989         return lend + 1;        /* to LIST's end at which \n is not found */
2990     }
2991
2992     /* The max range value follows, separated by a BLANK */
2993     if (isBLANK(*l)) {
2994         ++l;
2995         flags = PERL_SCAN_SILENT_ILLDIGIT
2996                 | PERL_SCAN_DISALLOW_PREFIX
2997                 | PERL_SCAN_SILENT_NON_PORTABLE;
2998         numlen = lend - l;
2999         *max = grok_hex((char *)l, &numlen, &flags, NULL);
3000         if (numlen)
3001             l += numlen;
3002         else    /* If no value here, it is a single element range */
3003             *max = *min;
3004
3005         /* Non-binary tables have a third entry: what the first element of the
3006          * range maps to.  The map for those currently read here is in hex */
3007         if (wants_value) {
3008             if (isBLANK(*l)) {
3009                 ++l;
3010                 flags = PERL_SCAN_SILENT_ILLDIGIT
3011                     | PERL_SCAN_DISALLOW_PREFIX
3012                     | PERL_SCAN_SILENT_NON_PORTABLE;
3013                 numlen = lend - l;
3014                 *val = grok_hex((char *)l, &numlen, &flags, NULL);
3015                 if (numlen)
3016                     l += numlen;
3017                 else
3018                     *val = 0;
3019             }
3020             else {
3021                 *val = 0;
3022                 if (typeto) {
3023                     /* diag_listed_as: To%s: illegal mapping '%s' */
3024                     Perl_croak(aTHX_ "%s: illegal mapping '%s'",
3025                                      typestr, l);
3026                 }
3027             }
3028         }
3029         else
3030             *val = 0; /* bits == 1, then any val should be ignored */
3031     }
3032     else { /* Nothing following range min, should be single element with no
3033               mapping expected */
3034         if (wants_value) {
3035             *val = 0;
3036             if (typeto) {
3037                 /* diag_listed_as: To%s: illegal mapping '%s' */
3038                 Perl_croak(aTHX_ "%s: illegal mapping '%s'", typestr, l);
3039             }
3040         }
3041         else
3042             *val = 0; /* bits == 1, then val should be ignored */
3043     }
3044
3045     /* Position to next line if any, or EOF */
3046     if (nl)
3047         l = nl + 1;
3048     else
3049         l = lend;
3050
3051     return l;
3052 }
3053
3054 /* Note:
3055  * Returns a swatch (a bit vector string) for a code point sequence
3056  * that starts from the value C<start> and comprises the number C<span>.
3057  * A C<swash> must be an object created by SWASHNEW (see lib/utf8_heavy.pl).
3058  * Should be used via swash_fetch, which will cache the swatch in C<swash>.
3059  */
3060 STATIC SV*
3061 S_swatch_get(pTHX_ SV* swash, UV start, UV span)
3062 {
3063     SV *swatch;
3064     U8 *l, *lend, *x, *xend, *s, *send;
3065     STRLEN lcur, xcur, scur;
3066     HV *const hv = MUTABLE_HV(SvRV(swash));
3067     SV** const invlistsvp = hv_fetchs(hv, "V", FALSE);
3068
3069     SV** listsvp = NULL; /* The string containing the main body of the table */
3070     SV** extssvp = NULL;
3071     SV** invert_it_svp = NULL;
3072     U8* typestr = NULL;
3073     STRLEN bits;
3074     STRLEN octets; /* if bits == 1, then octets == 0 */
3075     UV  none;
3076     UV  end = start + span;
3077
3078     if (invlistsvp == NULL) {
3079         SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
3080         SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
3081         SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
3082         extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
3083         listsvp = hv_fetchs(hv, "LIST", FALSE);
3084         invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
3085
3086         bits  = SvUV(*bitssvp);
3087         none  = SvUV(*nonesvp);
3088         typestr = (U8*)SvPV_nolen(*typesvp);
3089     }
3090     else {
3091         bits = 1;
3092         none = 0;
3093     }
3094     octets = bits >> 3; /* if bits == 1, then octets == 0 */
3095
3096     PERL_ARGS_ASSERT_SWATCH_GET;
3097
3098     if (bits != 1 && bits != 8 && bits != 16 && bits != 32) {
3099         Perl_croak(aTHX_ "panic: swatch_get doesn't expect bits %"UVuf,
3100                                                  (UV)bits);
3101     }
3102
3103     /* If overflowed, use the max possible */
3104     if (end < start) {
3105         end = UV_MAX;
3106         span = end - start;
3107     }
3108
3109     /* create and initialize $swatch */
3110     scur   = octets ? (span * octets) : (span + 7) / 8;
3111     swatch = newSV(scur);
3112     SvPOK_on(swatch);
3113     s = (U8*)SvPVX(swatch);
3114     if (octets && none) {
3115         const U8* const e = s + scur;
3116         while (s < e) {
3117             if (bits == 8)
3118                 *s++ = (U8)(none & 0xff);
3119             else if (bits == 16) {
3120                 *s++ = (U8)((none >>  8) & 0xff);
3121                 *s++ = (U8)( none        & 0xff);
3122             }
3123             else if (bits == 32) {
3124                 *s++ = (U8)((none >> 24) & 0xff);
3125                 *s++ = (U8)((none >> 16) & 0xff);
3126                 *s++ = (U8)((none >>  8) & 0xff);
3127                 *s++ = (U8)( none        & 0xff);
3128             }
3129         }
3130         *s = '\0';
3131     }
3132     else {
3133         (void)memzero((U8*)s, scur + 1);
3134     }
3135     SvCUR_set(swatch, scur);
3136     s = (U8*)SvPVX(swatch);
3137
3138     if (invlistsvp) {   /* If has an inversion list set up use that */
3139         _invlist_populate_swatch(*invlistsvp, start, end, s);
3140         return swatch;
3141     }
3142
3143     /* read $swash->{LIST} */
3144     l = (U8*)SvPV(*listsvp, lcur);
3145     lend = l + lcur;
3146     while (l < lend) {
3147         UV min, max, val, upper;
3148         l = swash_scan_list_line(l, lend, &min, &max, &val,
3149                                                         cBOOL(octets), typestr);
3150         if (l > lend) {
3151             break;
3152         }
3153
3154         /* If looking for something beyond this range, go try the next one */
3155         if (max < start)
3156             continue;
3157
3158         /* <end> is generally 1 beyond where we want to set things, but at the
3159          * platform's infinity, where we can't go any higher, we want to
3160          * include the code point at <end> */
3161         upper = (max < end)
3162                 ? max
3163                 : (max != UV_MAX || end != UV_MAX)
3164                   ? end - 1
3165                   : end;
3166
3167         if (octets) {
3168             UV key;
3169             if (min < start) {
3170                 if (!none || val < none) {
3171                     val += start - min;
3172                 }
3173                 min = start;
3174             }
3175             for (key = min; key <= upper; key++) {
3176                 STRLEN offset;
3177                 /* offset must be non-negative (start <= min <= key < end) */
3178                 offset = octets * (key - start);
3179                 if (bits == 8)
3180                     s[offset] = (U8)(val & 0xff);
3181                 else if (bits == 16) {
3182                     s[offset    ] = (U8)((val >>  8) & 0xff);
3183                     s[offset + 1] = (U8)( val        & 0xff);
3184                 }
3185                 else if (bits == 32) {
3186                     s[offset    ] = (U8)((val >> 24) & 0xff);
3187                     s[offset + 1] = (U8)((val >> 16) & 0xff);
3188                     s[offset + 2] = (U8)((val >>  8) & 0xff);
3189                     s[offset + 3] = (U8)( val        & 0xff);
3190                 }
3191
3192                 if (!none || val < none)
3193                     ++val;
3194             }
3195         }
3196         else { /* bits == 1, then val should be ignored */
3197             UV key;
3198             if (min < start)
3199                 min = start;
3200
3201             for (key = min; key <= upper; key++) {
3202                 const STRLEN offset = (STRLEN)(key - start);
3203                 s[offset >> 3] |= 1 << (offset & 7);
3204             }
3205         }
3206     } /* while */
3207
3208     /* Invert if the data says it should be.  Assumes that bits == 1 */
3209     if (invert_it_svp && SvUV(*invert_it_svp)) {
3210
3211         /* Unicode properties should come with all bits above PERL_UNICODE_MAX
3212          * be 0, and their inversion should also be 0, as we don't succeed any
3213          * Unicode property matches for non-Unicode code points */
3214         if (start <= PERL_UNICODE_MAX) {
3215
3216             /* The code below assumes that we never cross the
3217              * Unicode/above-Unicode boundary in a range, as otherwise we would
3218              * have to figure out where to stop flipping the bits.  Since this
3219              * boundary is divisible by a large power of 2, and swatches comes
3220              * in small powers of 2, this should be a valid assumption */
3221             assert(start + span - 1 <= PERL_UNICODE_MAX);
3222
3223             send = s + scur;
3224             while (s < send) {
3225                 *s = ~(*s);
3226                 s++;
3227             }
3228         }
3229     }
3230
3231     /* read $swash->{EXTRAS}
3232      * This code also copied to swash_to_invlist() below */
3233     x = (U8*)SvPV(*extssvp, xcur);
3234     xend = x + xcur;
3235     while (x < xend) {
3236         STRLEN namelen;
3237         U8 *namestr;
3238         SV** othersvp;
3239         HV* otherhv;
3240         STRLEN otherbits;
3241         SV **otherbitssvp, *other;
3242         U8 *s, *o, *nl;
3243         STRLEN slen, olen;
3244
3245         const U8 opc = *x++;
3246         if (opc == '\n')
3247             continue;
3248
3249         nl = (U8*)memchr(x, '\n', xend - x);
3250
3251         if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
3252             if (nl) {
3253                 x = nl + 1; /* 1 is length of "\n" */
3254                 continue;
3255             }
3256             else {
3257                 x = xend; /* to EXTRAS' end at which \n is not found */
3258                 break;
3259             }
3260         }
3261
3262         namestr = x;
3263         if (nl) {
3264             namelen = nl - namestr;
3265             x = nl + 1;
3266         }
3267         else {
3268             namelen = xend - namestr;
3269             x = xend;
3270         }
3271
3272         othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
3273         otherhv = MUTABLE_HV(SvRV(*othersvp));
3274         otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
3275         otherbits = (STRLEN)SvUV(*otherbitssvp);
3276         if (bits < otherbits)
3277             Perl_croak(aTHX_ "panic: swatch_get found swatch size mismatch, "
3278                        "bits=%"UVuf", otherbits=%"UVuf, (UV)bits, (UV)otherbits);
3279
3280         /* The "other" swatch must be destroyed after. */
3281         other = swatch_get(*othersvp, start, span);
3282         o = (U8*)SvPV(other, olen);
3283
3284         if (!olen)
3285             Perl_croak(aTHX_ "panic: swatch_get got improper swatch");
3286
3287         s = (U8*)SvPV(swatch, slen);
3288         if (bits == 1 && otherbits == 1) {
3289             if (slen != olen)
3290                 Perl_croak(aTHX_ "panic: swatch_get found swatch length "
3291                            "mismatch, slen=%"UVuf", olen=%"UVuf,
3292                            (UV)slen, (UV)olen);
3293
3294             switch (opc) {
3295             case '+':
3296                 while (slen--)
3297                     *s++ |= *o++;
3298                 break;
3299             case '!':
3300                 while (slen--)
3301                     *s++ |= ~*o++;
3302                 break;
3303             case '-':
3304                 while (slen--)
3305                     *s++ &= ~*o++;
3306                 break;
3307             case '&':
3308                 while (slen--)
3309                     *s++ &= *o++;
3310                 break;
3311             default:
3312                 break;
3313             }
3314         }
3315         else {
3316             STRLEN otheroctets = otherbits >> 3;
3317             STRLEN offset = 0;
3318             U8* const send = s + slen;
3319
3320             while (s < send) {
3321                 UV otherval = 0;
3322
3323                 if (otherbits == 1) {
3324                     otherval = (o[offset >> 3] >> (offset & 7)) & 1;
3325                     ++offset;
3326                 }
3327                 else {
3328                     STRLEN vlen = otheroctets;
3329                     otherval = *o++;
3330                     while (--vlen) {
3331                         otherval <<= 8;
3332                         otherval |= *o++;
3333                     }
3334                 }
3335
3336                 if (opc == '+' && otherval)
3337                     NOOP;   /* replace with otherval */
3338                 else if (opc == '!' && !otherval)
3339                     otherval = 1;
3340                 else if (opc == '-' && otherval)
3341                     otherval = 0;
3342                 else if (opc == '&' && !otherval)
3343                     otherval = 0;
3344                 else {
3345                     s += octets; /* no replacement */
3346                     continue;
3347                 }
3348
3349                 if (bits == 8)
3350                     *s++ = (U8)( otherval & 0xff);
3351                 else if (bits == 16) {
3352                     *s++ = (U8)((otherval >>  8) & 0xff);
3353                     *s++ = (U8)( otherval        & 0xff);
3354                 }
3355                 else if (bits == 32) {
3356                     *s++ = (U8)((otherval >> 24) & 0xff);
3357                     *s++ = (U8)((otherval >> 16) & 0xff);
3358                     *s++ = (U8)((otherval >>  8) & 0xff);
3359                     *s++ = (U8)( otherval        & 0xff);
3360                 }
3361             }
3362         }
3363         sv_free(other); /* through with it! */
3364     } /* while */
3365     return swatch;
3366 }
3367
3368 HV*
3369 Perl__swash_inversion_hash(pTHX_ SV* const swash)
3370 {
3371
3372    /* Subject to change or removal.  For use only in regcomp.c and regexec.c
3373     * Can't be used on a property that is subject to user override, as it
3374     * relies on the value of SPECIALS in the swash which would be set by
3375     * utf8_heavy.pl to the hash in the non-overriden file, and hence is not set
3376     * for overridden properties
3377     *
3378     * Returns a hash which is the inversion and closure of a swash mapping.
3379     * For example, consider the input lines:
3380     * 004B              006B
3381     * 004C              006C
3382     * 212A              006B
3383     *
3384     * The returned hash would have two keys, the UTF-8 for 006B and the UTF-8 for
3385     * 006C.  The value for each key is an array.  For 006C, the array would
3386     * have two elements, the UTF-8 for itself, and for 004C.  For 006B, there
3387     * would be three elements in its array, the UTF-8 for 006B, 004B and 212A.
3388     *
3389     * Note that there are no elements in the hash for 004B, 004C, 212A.  The
3390     * keys are only code points that are folded-to, so it isn't a full closure.
3391     *
3392     * Essentially, for any code point, it gives all the code points that map to
3393     * it, or the list of 'froms' for that point.
3394     *
3395     * Currently it ignores any additions or deletions from other swashes,
3396     * looking at just the main body of the swash, and if there are SPECIALS
3397     * in the swash, at that hash
3398     *
3399     * The specials hash can be extra code points, and most likely consists of
3400     * maps from single code points to multiple ones (each expressed as a string
3401     * of UTF-8 characters).   This function currently returns only 1-1 mappings.
3402     * However consider this possible input in the specials hash:
3403     * "\xEF\xAC\x85" => "\x{0073}\x{0074}",         # U+FB05 => 0073 0074
3404     * "\xEF\xAC\x86" => "\x{0073}\x{0074}",         # U+FB06 => 0073 0074
3405     *
3406     * Both FB05 and FB06 map to the same multi-char sequence, which we don't
3407     * currently handle.  But it also means that FB05 and FB06 are equivalent in
3408     * a 1-1 mapping which we should handle, and this relationship may not be in
3409     * the main table.  Therefore this function examines all the multi-char
3410     * sequences and adds the 1-1 mappings that come out of that.
3411     *
3412     * XXX This function was originally intended to be multipurpose, but its
3413     * only use is quite likely to remain for constructing the inversion of
3414     * the CaseFolding (//i) property.  If it were more general purpose for
3415     * regex patterns, it would have to do the FB05/FB06 game for simple folds,
3416     * because certain folds are prohibited under /iaa and /il.  As an example,
3417     * in Unicode 3.0.1 both U+0130 and U+0131 fold to 'i', and hence are both
3418     * equivalent under /i.  But under /iaa and /il, the folds to 'i' are
3419     * prohibited, so we would not figure out that they fold to each other.
3420     * Code could be written to automatically figure this out, similar to the
3421     * code that does this for multi-character folds, but this is the only case
3422     * where something like this is ever likely to happen, as all the single
3423     * char folds to the 0-255 range are now quite settled.  Instead there is a
3424     * little special code that is compiled only for this Unicode version.  This
3425     * is smaller and didn't require much coding time to do.  But this makes
3426     * this routine strongly tied to being used just for CaseFolding.  If ever
3427     * it should be generalized, this would have to be fixed */
3428
3429     U8 *l, *lend;
3430     STRLEN lcur;
3431     HV *const hv = MUTABLE_HV(SvRV(swash));
3432
3433     /* The string containing the main body of the table.  This will have its
3434      * assertion fail if the swash has been converted to its inversion list */
3435     SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
3436
3437     SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
3438     SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
3439     SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
3440     /*SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);*/
3441     const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
3442     const STRLEN bits  = SvUV(*bitssvp);
3443     const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
3444     const UV     none  = SvUV(*nonesvp);
3445     SV **specials_p = hv_fetchs(hv, "SPECIALS", 0);
3446
3447     HV* ret = newHV();
3448
3449     PERL_ARGS_ASSERT__SWASH_INVERSION_HASH;
3450
3451     /* Must have at least 8 bits to get the mappings */
3452     if (bits != 8 && bits != 16 && bits != 32) {
3453         Perl_croak(aTHX_ "panic: swash_inversion_hash doesn't expect bits %"UVuf,
3454                                                  (UV)bits);
3455     }
3456
3457     if (specials_p) { /* It might be "special" (sometimes, but not always, a
3458                         mapping to more than one character */
3459
3460         /* Construct an inverse mapping hash for the specials */
3461         HV * const specials_hv = MUTABLE_HV(SvRV(*specials_p));
3462         HV * specials_inverse = newHV();
3463         char *char_from; /* the lhs of the map */
3464         I32 from_len;   /* its byte length */
3465         char *char_to;  /* the rhs of the map */
3466         I32 to_len;     /* its byte length */
3467         SV *sv_to;      /* and in a sv */
3468         AV* from_list;  /* list of things that map to each 'to' */
3469
3470         hv_iterinit(specials_hv);
3471
3472         /* The keys are the characters (in UTF-8) that map to the corresponding
3473          * UTF-8 string value.  Iterate through the list creating the inverse
3474          * list. */
3475         while ((sv_to = hv_iternextsv(specials_hv, &char_from, &from_len))) {
3476             SV** listp;
3477             if (! SvPOK(sv_to)) {
3478                 Perl_croak(aTHX_ "panic: value returned from hv_iternextsv() "
3479                            "unexpectedly is not a string, flags=%lu",
3480                            (unsigned long)SvFLAGS(sv_to));
3481             }
3482             /*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)));*/
3483
3484             /* Each key in the inverse list is a mapped-to value, and the key's
3485              * hash value is a list of the strings (each in UTF-8) that map to
3486              * it.  Those strings are all one character long */
3487             if ((listp = hv_fetch(specials_inverse,
3488                                     SvPVX(sv_to),
3489                                     SvCUR(sv_to), 0)))
3490             {
3491                 from_list = (AV*) *listp;
3492             }
3493             else { /* No entry yet for it: create one */
3494                 from_list = newAV();
3495                 if (! hv_store(specials_inverse,
3496                                 SvPVX(sv_to),
3497                                 SvCUR(sv_to),
3498                                 (SV*) from_list, 0))
3499                 {
3500                     Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
3501                 }
3502             }
3503
3504             /* Here have the list associated with this 'to' (perhaps newly
3505              * created and empty).  Just add to it.  Note that we ASSUME that
3506              * the input is guaranteed to not have duplications, so we don't
3507              * check for that.  Duplications just slow down execution time. */
3508             av_push(from_list, newSVpvn_utf8(char_from, from_len, TRUE));
3509         }
3510
3511         /* Here, 'specials_inverse' contains the inverse mapping.  Go through
3512          * it looking for cases like the FB05/FB06 examples above.  There would
3513          * be an entry in the hash like
3514         *       'st' => [ FB05, FB06 ]
3515         * In this example we will create two lists that get stored in the
3516         * returned hash, 'ret':
3517         *       FB05 => [ FB05, FB06 ]
3518         *       FB06 => [ FB05, FB06 ]
3519         *
3520         * Note that there is nothing to do if the array only has one element.
3521         * (In the normal 1-1 case handled below, we don't have to worry about
3522         * two lists, as everything gets tied to the single list that is
3523         * generated for the single character 'to'.  But here, we are omitting
3524         * that list, ('st' in the example), so must have multiple lists.) */
3525         while ((from_list = (AV *) hv_iternextsv(specials_inverse,
3526                                                  &char_to, &to_len)))
3527         {
3528             if (av_tindex_nomg(from_list) > 0) {
3529                 SSize_t i;
3530
3531                 /* We iterate over all combinations of i,j to place each code
3532                  * point on each list */
3533                 for (i = 0; i <= av_tindex_nomg(from_list); i++) {
3534                     SSize_t j;
3535                     AV* i_list = newAV();
3536                     SV** entryp = av_fetch(from_list, i, FALSE);
3537                     if (entryp == NULL) {
3538                         Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
3539                     }
3540                     if (hv_fetch(ret, SvPVX(*entryp), SvCUR(*entryp), FALSE)) {
3541                         Perl_croak(aTHX_ "panic: unexpected entry for %s", SvPVX(*entryp));
3542                     }
3543                     if (! hv_store(ret, SvPVX(*entryp), SvCUR(*entryp),
3544                                    (SV*) i_list, FALSE))
3545                     {
3546                         Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
3547                     }
3548
3549                     /* For DEBUG_U: UV u = valid_utf8_to_uvchr((U8*) SvPVX(*entryp), 0);*/
3550                     for (j = 0; j <= av_tindex_nomg(from_list); j++) {
3551                         entryp = av_fetch(from_list, j, FALSE);
3552                         if (entryp == NULL) {
3553                             Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
3554                         }
3555
3556                         /* When i==j this adds itself to the list */
3557                         av_push(i_list, newSVuv(utf8_to_uvchr_buf(
3558                                         (U8*) SvPVX(*entryp),
3559                                         (U8*) SvPVX(*entryp) + SvCUR(*entryp),
3560                                         0)));
3561                         /*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));*/
3562                     }
3563                 }
3564             }
3565         }
3566         SvREFCNT_dec(specials_inverse); /* done with it */
3567     } /* End of specials */
3568
3569     /* read $swash->{LIST} */
3570
3571 #if    UNICODE_MAJOR_VERSION   == 3         \
3572     && UNICODE_DOT_VERSION     == 0         \
3573     && UNICODE_DOT_DOT_VERSION == 1
3574
3575     /* For this version only U+130 and U+131 are equivalent under qr//i.  Add a
3576      * rule so that things work under /iaa and /il */
3577
3578     SV * mod_listsv = sv_mortalcopy(*listsvp);
3579     sv_catpv(mod_listsv, "130\t130\t131\n");
3580     l = (U8*)SvPV(mod_listsv, lcur);
3581
3582 #else
3583
3584     l = (U8*)SvPV(*listsvp, lcur);
3585
3586 #endif
3587
3588     lend = l + lcur;
3589
3590     /* Go through each input line */
3591     while (l < lend) {
3592         UV min, max, val;
3593         UV inverse;
3594         l = swash_scan_list_line(l, lend, &min, &max, &val,
3595                                                      cBOOL(octets), typestr);
3596         if (l > lend) {
3597             break;
3598         }
3599
3600         /* Each element in the range is to be inverted */
3601         for (inverse = min; inverse <= max; inverse++) {
3602             AV* list;
3603             SV** listp;
3604             IV i;
3605             bool found_key = FALSE;
3606             bool found_inverse = FALSE;
3607
3608             /* The key is the inverse mapping */
3609             char key[UTF8_MAXBYTES+1];
3610             char* key_end = (char *) uvchr_to_utf8((U8*) key, val);
3611             STRLEN key_len = key_end - key;
3612
3613             /* Get the list for the map */
3614             if ((listp = hv_fetch(ret, key, key_len, FALSE))) {
3615                 list = (AV*) *listp;
3616             }
3617             else { /* No entry yet for it: create one */
3618                 list = newAV();
3619                 if (! hv_store(ret, key, key_len, (SV*) list, FALSE)) {
3620                     Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
3621                 }
3622             }
3623
3624             /* Look through list to see if this inverse mapping already is
3625              * listed, or if there is a mapping to itself already */
3626             for (i = 0; i <= av_tindex_nomg(list); i++) {
3627                 SV** entryp = av_fetch(list, i, FALSE);
3628                 SV* entry;
3629                 UV uv;
3630                 if (entryp == NULL) {
3631                     Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
3632                 }
3633                 entry = *entryp;
3634                 uv = SvUV(entry);
3635                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "list for %"UVXf" contains %"UVXf"\n", val, uv));*/
3636                 if (uv == val) {
3637                     found_key = TRUE;
3638                 }
3639                 if (uv == inverse) {
3640                     found_inverse = TRUE;
3641                 }
3642
3643                 /* No need to continue searching if found everything we are
3644                  * looking for */
3645                 if (found_key && found_inverse) {
3646                     break;
3647                 }
3648             }
3649
3650             /* Make sure there is a mapping to itself on the list */
3651             if (! found_key) {
3652                 av_push(list, newSVuv(val));
3653                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "%s: %d: Adding %"UVXf" to list for %"UVXf"\n", __FILE__, __LINE__, val, val));*/
3654             }
3655
3656
3657             /* Simply add the value to the list */
3658             if (! found_inverse) {
3659                 av_push(list, newSVuv(inverse));
3660                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "%s: %d: Adding %"UVXf" to list for %"UVXf"\n", __FILE__, __LINE__, inverse, val));*/
3661             }
3662
3663             /* swatch_get() increments the value of val for each element in the
3664              * range.  That makes more compact tables possible.  You can
3665              * express the capitalization, for example, of all consecutive
3666              * letters with a single line: 0061\t007A\t0041 This maps 0061 to
3667              * 0041, 0062 to 0042, etc.  I (khw) have never understood 'none',
3668              * and it's not documented; it appears to be used only in
3669              * implementing tr//; I copied the semantics from swatch_get(), just
3670              * in case */
3671             if (!none || val < none) {
3672                 ++val;
3673             }
3674         }
3675     }
3676
3677     return ret;
3678 }
3679
3680 SV*
3681 Perl__swash_to_invlist(pTHX_ SV* const swash)
3682 {
3683
3684    /* Subject to change or removal.  For use only in one place in regcomp.c.
3685     * Ownership is given to one reference count in the returned SV* */
3686
3687     U8 *l, *lend;
3688     char *loc;
3689     STRLEN lcur;
3690     HV *const hv = MUTABLE_HV(SvRV(swash));
3691     UV elements = 0;    /* Number of elements in the inversion list */
3692     U8 empty[] = "";
3693     SV** listsvp;
3694     SV** typesvp;
3695     SV** bitssvp;
3696     SV** extssvp;
3697     SV** invert_it_svp;
3698
3699     U8* typestr;
3700     STRLEN bits;
3701     STRLEN octets; /* if bits == 1, then octets == 0 */
3702     U8 *x, *xend;
3703     STRLEN xcur;
3704
3705     SV* invlist;
3706
3707     PERL_ARGS_ASSERT__SWASH_TO_INVLIST;
3708
3709     /* If not a hash, it must be the swash's inversion list instead */
3710     if (SvTYPE(hv) != SVt_PVHV) {
3711         return SvREFCNT_inc_simple_NN((SV*) hv);
3712     }
3713
3714     /* The string containing the main body of the table */
3715     listsvp = hv_fetchs(hv, "LIST", FALSE);
3716     typesvp = hv_fetchs(hv, "TYPE", FALSE);
3717     bitssvp = hv_fetchs(hv, "BITS", FALSE);
3718     extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
3719     invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
3720
3721     typestr = (U8*)SvPV_nolen(*typesvp);
3722     bits  = SvUV(*bitssvp);
3723     octets = bits >> 3; /* if bits == 1, then octets == 0 */
3724
3725     /* read $swash->{LIST} */
3726     if (SvPOK(*listsvp)) {
3727         l = (U8*)SvPV(*listsvp, lcur);
3728     }
3729     else {
3730         /* LIST legitimately doesn't contain a string during compilation phases
3731          * of Perl itself, before the Unicode tables are generated.  In this
3732          * case, just fake things up by creating an empty list */
3733         l = empty;
3734         lcur = 0;
3735     }
3736     loc = (char *) l;
3737     lend = l + lcur;
3738
3739     if (*l == 'V') {    /*  Inversion list format */
3740         const char *after_atou = (char *) lend;
3741         UV element0;
3742         UV* other_elements_ptr;
3743
3744         /* The first number is a count of the rest */
3745         l++;
3746         if (!grok_atoUV((const char *)l, &elements, &after_atou)) {
3747             Perl_croak(aTHX_ "panic: Expecting a valid count of elements at start of inversion list");
3748         }
3749         if (elements == 0) {
3750             invlist = _new_invlist(0);
3751         }
3752         else {
3753             while (isSPACE(*l)) l++;
3754             l = (U8 *) after_atou;
3755
3756             /* Get the 0th element, which is needed to setup the inversion list */
3757             while (isSPACE(*l)) l++;
3758             if (!grok_atoUV((const char *)l, &element0, &after_atou)) {
3759                 Perl_croak(aTHX_ "panic: Expecting a valid 0th element for inversion list");
3760             }
3761             l = (U8 *) after_atou;
3762             invlist = _setup_canned_invlist(elements, element0, &other_elements_ptr);
3763             elements--;
3764
3765             /* Then just populate the rest of the input */
3766             while (elements-- > 0) {
3767                 if (l > lend) {
3768                     Perl_croak(aTHX_ "panic: Expecting %"UVuf" more elements than available", elements);
3769                 }
3770                 while (isSPACE(*l)) l++;
3771                 if (!grok_atoUV((const char *)l, other_elements_ptr++, &after_atou)) {
3772                     Perl_croak(aTHX_ "panic: Expecting a valid element in inversion list");
3773                 }
3774                 l = (U8 *) after_atou;
3775             }
3776         }
3777     }
3778     else {
3779
3780         /* Scan the input to count the number of lines to preallocate array
3781          * size based on worst possible case, which is each line in the input
3782          * creates 2 elements in the inversion list: 1) the beginning of a
3783          * range in the list; 2) the beginning of a range not in the list.  */
3784         while ((loc = (strchr(loc, '\n'))) != NULL) {
3785             elements += 2;
3786             loc++;
3787         }
3788
3789         /* If the ending is somehow corrupt and isn't a new line, add another
3790          * element for the final range that isn't in the inversion list */
3791         if (! (*lend == '\n'
3792             || (*lend == '\0' && (lcur == 0 || *(lend - 1) == '\n'))))
3793         {
3794             elements++;
3795         }
3796
3797         invlist = _new_invlist(elements);
3798
3799         /* Now go through the input again, adding each range to the list */
3800         while (l < lend) {
3801             UV start, end;
3802             UV val;             /* Not used by this function */
3803
3804             l = swash_scan_list_line(l, lend, &start, &end, &val,
3805                                                         cBOOL(octets), typestr);
3806
3807             if (l > lend) {
3808                 break;
3809             }
3810
3811             invlist = _add_range_to_invlist(invlist, start, end);
3812         }
3813     }
3814
3815     /* Invert if the data says it should be */
3816     if (invert_it_svp && SvUV(*invert_it_svp)) {
3817         _invlist_invert(invlist);
3818     }
3819
3820     /* This code is copied from swatch_get()
3821      * read $swash->{EXTRAS} */
3822     x = (U8*)SvPV(*extssvp, xcur);
3823     xend = x + xcur;
3824     while (x < xend) {
3825         STRLEN namelen;
3826         U8 *namestr;
3827         SV** othersvp;
3828         HV* otherhv;
3829         STRLEN otherbits;
3830         SV **otherbitssvp, *other;
3831         U8 *nl;
3832
3833         const U8 opc = *x++;
3834         if (opc == '\n')
3835             continue;
3836
3837         nl = (U8*)memchr(x, '\n', xend - x);
3838
3839         if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
3840             if (nl) {
3841                 x = nl + 1; /* 1 is length of "\n" */
3842                 continue;
3843             }
3844             else {
3845                 x = xend; /* to EXTRAS' end at which \n is not found */
3846                 break;
3847             }
3848         }
3849
3850         namestr = x;
3851         if (nl) {
3852             namelen = nl - namestr;
3853             x = nl + 1;
3854         }
3855         else {
3856             namelen = xend - namestr;
3857             x = xend;
3858         }
3859
3860         othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
3861         otherhv = MUTABLE_HV(SvRV(*othersvp));
3862         otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
3863         otherbits = (STRLEN)SvUV(*otherbitssvp);
3864
3865         if (bits != otherbits || bits != 1) {
3866             Perl_croak(aTHX_ "panic: _swash_to_invlist only operates on boolean "
3867                        "properties, bits=%"UVuf", otherbits=%"UVuf,
3868                        (UV)bits, (UV)otherbits);
3869         }
3870
3871         /* The "other" swatch must be destroyed after. */
3872         other = _swash_to_invlist((SV *)*othersvp);
3873
3874         /* End of code copied from swatch_get() */
3875         switch (opc) {
3876         case '+':
3877             _invlist_union(invlist, other, &invlist);
3878             break;
3879         case '!':
3880             _invlist_union_maybe_complement_2nd(invlist, other, TRUE, &invlist);
3881             break;
3882         case '-':
3883             _invlist_subtract(invlist, other, &invlist);
3884             break;
3885         case '&':
3886             _invlist_intersection(invlist, other, &invlist);
3887             break;
3888         default:
3889             break;
3890         }
3891         sv_free(other); /* through with it! */
3892     }
3893
3894     SvREADONLY_on(invlist);
3895     return invlist;
3896 }
3897
3898 SV*
3899 Perl__get_swash_invlist(pTHX_ SV* const swash)
3900 {
3901     SV** ptr;
3902
3903     PERL_ARGS_ASSERT__GET_SWASH_INVLIST;
3904
3905     if (! SvROK(swash)) {
3906         return NULL;
3907     }
3908
3909     /* If it really isn't a hash, it isn't really swash; must be an inversion
3910      * list */
3911     if (SvTYPE(SvRV(swash)) != SVt_PVHV) {
3912         return SvRV(swash);
3913     }
3914
3915     ptr = hv_fetchs(MUTABLE_HV(SvRV(swash)), "V", FALSE);
3916     if (! ptr) {
3917         return NULL;
3918     }
3919
3920     return *ptr;
3921 }
3922
3923 bool
3924 Perl_check_utf8_print(pTHX_ const U8* s, const STRLEN len)
3925 {
3926     /* May change: warns if surrogates, non-character code points, or
3927      * non-Unicode code points are in s which has length len bytes.  Returns
3928      * TRUE if none found; FALSE otherwise.  The only other validity check is
3929      * to make sure that this won't exceed the string's length.
3930      *
3931      * Code points above the platform's C<IV_MAX> will raise a deprecation
3932      * warning, unless those are turned off.  */
3933
3934     const U8* const e = s + len;
3935     bool ok = TRUE;
3936
3937     PERL_ARGS_ASSERT_CHECK_UTF8_PRINT;
3938
3939     while (s < e) {
3940         if (UTF8SKIP(s) > len) {
3941             Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
3942                            "%s in %s", unees, PL_op ? OP_DESC(PL_op) : "print");
3943             return FALSE;
3944         }
3945         if (UNLIKELY(isUTF8_POSSIBLY_PROBLEMATIC(*s))) {
3946             STRLEN char_len;
3947             if (UTF8_IS_SUPER(s, e)) {
3948                 if (   ckWARN_d(WARN_NON_UNICODE)
3949                     || (   ckWARN_d(WARN_DEPRECATED)
3950 #if defined(UV_IS_QUAD)
3951                         /* 2**63 and up meet these conditions provided we have
3952                          * a 64-bit word. */
3953 #   ifdef EBCDIC
3954                         && *s == 0xFE && e - s >= UTF8_MAXBYTES
3955                         && s[1] >= 0x49
3956 #   else
3957                         && *s == 0xFF && e -s >= UTF8_MAXBYTES
3958                         && s[2] >= 0x88
3959 #   endif
3960 #else   /* Below is 32-bit words */
3961                         /* 2**31 and above meet these conditions on all EBCDIC
3962                          * pages recognized for 32-bit platforms */
3963 #   ifdef EBCDIC
3964                         && *s == 0xFE && e - s >= UTF8_MAXBYTES
3965                         && s[6] >= 0x43
3966 #   else
3967                         && *s >= 0xFE
3968 #   endif
3969 #endif
3970                 )) {
3971                     /* A side effect of this function will be to warn */
3972                     (void) utf8n_to_uvchr(s, e - s, &char_len, UTF8_WARN_SUPER);
3973                     ok = FALSE;
3974                 }
3975             }
3976             else if (UTF8_IS_SURROGATE(s, e)) {
3977                 if (ckWARN_d(WARN_SURROGATE)) {
3978                     /* This has a different warning than the one the called
3979                      * function would output, so can't just call it, unlike we
3980                      * do for the non-chars and above-unicodes */
3981                     UV uv = utf8_to_uvchr_buf(s, e, &char_len);
3982                     Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
3983                         "Unicode surrogate U+%04"UVXf" is illegal in UTF-8", uv);
3984                     ok = FALSE;
3985                 }
3986             }
3987             else if ((UTF8_IS_NONCHAR(s, e)) && (ckWARN_d(WARN_NONCHAR))) {
3988                 /* A side effect of this function will be to warn */
3989                 (void) utf8n_to_uvchr(s, e - s, &char_len, UTF8_WARN_NONCHAR);
3990                 ok = FALSE;
3991             }
3992         }
3993         s += UTF8SKIP(s);
3994     }
3995
3996     return ok;
3997 }
3998
3999 /*
4000 =for apidoc pv_uni_display
4001
4002 Build to the scalar C<dsv> a displayable version of the string C<spv>,
4003 length C<len>, the displayable version being at most C<pvlim> bytes long
4004 (if longer, the rest is truncated and C<"..."> will be appended).
4005
4006 The C<flags> argument can have C<UNI_DISPLAY_ISPRINT> set to display
4007 C<isPRINT()>able characters as themselves, C<UNI_DISPLAY_BACKSLASH>
4008 to display the C<\\[nrfta\\]> as the backslashed versions (like C<"\n">)
4009 (C<UNI_DISPLAY_BACKSLASH> is preferred over C<UNI_DISPLAY_ISPRINT> for C<"\\">).
4010 C<UNI_DISPLAY_QQ> (and its alias C<UNI_DISPLAY_REGEX>) have both
4011 C<UNI_DISPLAY_BACKSLASH> and C<UNI_DISPLAY_ISPRINT> turned on.
4012
4013 The pointer to the PV of the C<dsv> is returned.
4014
4015 See also L</sv_uni_display>.
4016
4017 =cut */
4018 char *
4019 Perl_pv_uni_display(pTHX_ SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4020 {
4021     int truncated = 0;
4022     const char *s, *e;
4023
4024     PERL_ARGS_ASSERT_PV_UNI_DISPLAY;
4025
4026     sv_setpvs(dsv, "");
4027     SvUTF8_off(dsv);
4028     for (s = (const char *)spv, e = s + len; s < e; s += UTF8SKIP(s)) {
4029          UV u;
4030           /* This serves double duty as a flag and a character to print after
4031              a \ when flags & UNI_DISPLAY_BACKSLASH is true.
4032           */
4033          char ok = 0;
4034
4035          if (pvlim && SvCUR(dsv) >= pvlim) {
4036               truncated++;
4037               break;
4038          }
4039          u = utf8_to_uvchr_buf((U8*)s, (U8*)e, 0);
4040          if (u < 256) {
4041              const unsigned char c = (unsigned char)u & 0xFF;
4042              if (flags & UNI_DISPLAY_BACKSLASH) {
4043                  switch (c) {
4044                  case '\n':
4045                      ok = 'n'; break;
4046                  case '\r':
4047                      ok = 'r'; break;
4048                  case '\t':
4049                      ok = 't'; break;
4050                  case '\f':
4051                      ok = 'f'; break;
4052                  case '\a':
4053                      ok = 'a'; break;
4054                  case '\\':
4055                      ok = '\\'; break;
4056                  default: break;
4057                  }
4058                  if (ok) {
4059                      const char string = ok;
4060                      sv_catpvs(dsv, "\\");
4061                      sv_catpvn(dsv, &string, 1);
4062                  }
4063              }
4064              /* isPRINT() is the locale-blind version. */
4065              if (!ok && (flags & UNI_DISPLAY_ISPRINT) && isPRINT(c)) {
4066                  const char string = c;
4067                  sv_catpvn(dsv, &string, 1);
4068                  ok = 1;
4069              }
4070          }
4071          if (!ok)
4072              Perl_sv_catpvf(aTHX_ dsv, "\\x{%"UVxf"}", u);
4073     }
4074     if (truncated)
4075          sv_catpvs(dsv, "...");
4076
4077     return SvPVX(dsv);
4078 }
4079
4080 /*
4081 =for apidoc sv_uni_display
4082
4083 Build to the scalar C<dsv> a displayable version of the scalar C<sv>,
4084 the displayable version being at most C<pvlim> bytes long
4085 (if longer, the rest is truncated and "..." will be appended).
4086
4087 The C<flags> argument is as in L</pv_uni_display>().
4088
4089 The pointer to the PV of the C<dsv> is returned.
4090
4091 =cut
4092 */
4093 char *
4094 Perl_sv_uni_display(pTHX_ SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4095 {
4096     const char * const ptr =
4097         isREGEXP(ssv) ? RX_WRAPPED((REGEXP*)ssv) : SvPVX_const(ssv);
4098
4099     PERL_ARGS_ASSERT_SV_UNI_DISPLAY;
4100
4101     return Perl_pv_uni_display(aTHX_ dsv, (const U8*)ptr,
4102                                 SvCUR(ssv), pvlim, flags);
4103 }
4104
4105 /*
4106 =for apidoc foldEQ_utf8
4107
4108 Returns true if the leading portions of the strings C<s1> and C<s2> (either or both
4109 of which may be in UTF-8) are the same case-insensitively; false otherwise.
4110 How far into the strings to compare is determined by other input parameters.
4111
4112 If C<u1> is true, the string C<s1> is assumed to be in UTF-8-encoded Unicode;
4113 otherwise it is assumed to be in native 8-bit encoding.  Correspondingly for C<u2>
4114 with respect to C<s2>.
4115
4116 If the byte length C<l1> is non-zero, it says how far into C<s1> to check for fold
4117 equality.  In other words, C<s1>+C<l1> will be used as a goal to reach.  The
4118 scan will not be considered to be a match unless the goal is reached, and
4119 scanning won't continue past that goal.  Correspondingly for C<l2> with respect to
4120 C<s2>.
4121
4122 If C<pe1> is non-C<NULL> and the pointer it points to is not C<NULL>, that pointer is
4123 considered an end pointer to the position 1 byte past the maximum point
4124 in C<s1> beyond which scanning will not continue under any circumstances.
4125 (This routine assumes that UTF-8 encoded input strings are not malformed;
4126 malformed input can cause it to read past C<pe1>).
4127 This means that if both C<l1> and C<pe1> are specified, and C<pe1>
4128 is less than C<s1>+C<l1>, the match will never be successful because it can
4129 never
4130 get as far as its goal (and in fact is asserted against).  Correspondingly for
4131 C<pe2> with respect to C<s2>.
4132
4133 At least one of C<s1> and C<s2> must have a goal (at least one of C<l1> and
4134 C<l2> must be non-zero), and if both do, both have to be
4135 reached for a successful match.   Also, if the fold of a character is multiple
4136 characters, all of them must be matched (see tr21 reference below for
4137 'folding').
4138
4139 Upon a successful match, if C<pe1> is non-C<NULL>,
4140 it will be set to point to the beginning of the I<next> character of C<s1>
4141 beyond what was matched.  Correspondingly for C<pe2> and C<s2>.
4142
4143 For case-insensitiveness, the "casefolding" of Unicode is used
4144 instead of upper/lowercasing both the characters, see
4145 L<http://www.unicode.org/unicode/reports/tr21/> (Case Mappings).
4146
4147 =cut */
4148
4149 /* A flags parameter has been added which may change, and hence isn't
4150  * externally documented.  Currently it is:
4151  *  0 for as-documented above
4152  *  FOLDEQ_UTF8_NOMIX_ASCII meaning that if a non-ASCII character folds to an
4153                             ASCII one, to not match
4154  *  FOLDEQ_LOCALE           is set iff the rules from the current underlying
4155  *                          locale are to be used.
4156  *  FOLDEQ_S1_ALREADY_FOLDED  s1 has already been folded before calling this
4157  *                          routine.  This allows that step to be skipped.
4158  *                          Currently, this requires s1 to be encoded as UTF-8
4159  *                          (u1 must be true), which is asserted for.
4160  *  FOLDEQ_S1_FOLDS_SANE    With either NOMIX_ASCII or LOCALE, no folds may
4161  *                          cross certain boundaries.  Hence, the caller should
4162  *                          let this function do the folding instead of
4163  *                          pre-folding.  This code contains an assertion to
4164  *                          that effect.  However, if the caller knows what
4165  *                          it's doing, it can pass this flag to indicate that,
4166  *                          and the assertion is skipped.
4167  *  FOLDEQ_S2_ALREADY_FOLDED  Similarly.
4168  *  FOLDEQ_S2_FOLDS_SANE
4169  */
4170 I32
4171 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)
4172 {
4173     const U8 *p1  = (const U8*)s1; /* Point to current char */
4174     const U8 *p2  = (const U8*)s2;
4175     const U8 *g1 = NULL;       /* goal for s1 */
4176     const U8 *g2 = NULL;
4177     const U8 *e1 = NULL;       /* Don't scan s1 past this */
4178     U8 *f1 = NULL;             /* Point to current folded */
4179     const U8 *e2 = NULL;
4180     U8 *f2 = NULL;
4181     STRLEN n1 = 0, n2 = 0;              /* Number of bytes in current char */
4182     U8 foldbuf1[UTF8_MAXBYTES_CASE+1];
4183     U8 foldbuf2[UTF8_MAXBYTES_CASE+1];
4184     U8 flags_for_folder = FOLD_FLAGS_FULL;
4185
4186     PERL_ARGS_ASSERT_FOLDEQ_UTF8_FLAGS;
4187
4188     assert( ! ((flags & (FOLDEQ_UTF8_NOMIX_ASCII | FOLDEQ_LOCALE))
4189                && (((flags & FOLDEQ_S1_ALREADY_FOLDED)
4190                      && !(flags & FOLDEQ_S1_FOLDS_SANE))
4191                    || ((flags & FOLDEQ_S2_ALREADY_FOLDED)
4192                        && !(flags & FOLDEQ_S2_FOLDS_SANE)))));
4193     /* The algorithm is to trial the folds without regard to the flags on
4194      * the first line of the above assert(), and then see if the result
4195      * violates them.  This means that the inputs can't be pre-folded to a
4196      * violating result, hence the assert.  This could be changed, with the
4197      * addition of extra tests here for the already-folded case, which would
4198      * slow it down.  That cost is more than any possible gain for when these
4199      * flags are specified, as the flags indicate /il or /iaa matching which
4200      * is less common than /iu, and I (khw) also believe that real-world /il
4201      * and /iaa matches are most likely to involve code points 0-255, and this
4202      * function only under rare conditions gets called for 0-255. */
4203
4204     if (flags & FOLDEQ_LOCALE) {
4205         if (IN_UTF8_CTYPE_LOCALE) {
4206             flags &= ~FOLDEQ_LOCALE;
4207         }
4208         else {
4209             flags_for_folder |= FOLD_FLAGS_LOCALE;
4210         }
4211     }
4212
4213     if (pe1) {
4214         e1 = *(U8**)pe1;
4215     }
4216
4217     if (l1) {
4218         g1 = (const U8*)s1 + l1;
4219     }
4220
4221     if (pe2) {
4222         e2 = *(U8**)pe2;
4223     }
4224
4225     if (l2) {
4226         g2 = (const U8*)s2 + l2;
4227     }
4228
4229     /* Must have at least one goal */
4230     assert(g1 || g2);
4231
4232     if (g1) {
4233
4234         /* Will never match if goal is out-of-bounds */
4235         assert(! e1  || e1 >= g1);
4236
4237         /* Here, there isn't an end pointer, or it is beyond the goal.  We
4238         * only go as far as the goal */
4239         e1 = g1;
4240     }
4241     else {
4242         assert(e1);    /* Must have an end for looking at s1 */
4243     }
4244
4245     /* Same for goal for s2 */
4246     if (g2) {
4247         assert(! e2  || e2 >= g2);
4248         e2 = g2;
4249     }
4250     else {
4251         assert(e2);
4252     }
4253
4254     /* If both operands are already folded, we could just do a memEQ on the
4255      * whole strings at once, but it would be better if the caller realized
4256      * this and didn't even call us */
4257
4258     /* Look through both strings, a character at a time */
4259     while (p1 < e1 && p2 < e2) {
4260
4261         /* If at the beginning of a new character in s1, get its fold to use
4262          * and the length of the fold. */
4263         if (n1 == 0) {
4264             if (flags & FOLDEQ_S1_ALREADY_FOLDED) {
4265                 f1 = (U8 *) p1;
4266                 assert(u1);
4267                 n1 = UTF8SKIP(f1);
4268             }
4269             else {
4270                 if (isASCII(*p1) && ! (flags & FOLDEQ_LOCALE)) {
4271
4272                     /* We have to forbid mixing ASCII with non-ASCII if the
4273                      * flags so indicate.  And, we can short circuit having to
4274                      * call the general functions for this common ASCII case,
4275                      * all of whose non-locale folds are also ASCII, and hence
4276                      * UTF-8 invariants, so the UTF8ness of the strings is not
4277                      * relevant. */
4278                     if ((flags & FOLDEQ_UTF8_NOMIX_ASCII) && ! isASCII(*p2)) {
4279                         return 0;
4280                     }
4281                     n1 = 1;
4282                     *foldbuf1 = toFOLD(*p1);
4283                 }
4284                 else if (u1) {
4285                     _to_utf8_fold_flags(p1, foldbuf1, &n1, flags_for_folder);
4286                 }
4287                 else {  /* Not UTF-8, get UTF-8 fold */
4288                     _to_uni_fold_flags(*p1, foldbuf1, &n1, flags_for_folder);
4289                 }
4290                 f1 = foldbuf1;
4291             }
4292         }
4293
4294         if (n2 == 0) {    /* Same for s2 */
4295             if (flags & FOLDEQ_S2_ALREADY_FOLDED) {
4296                 f2 = (U8 *) p2;
4297                 assert(u2);
4298                 n2 = UTF8SKIP(f2);
4299             }
4300             else {
4301                 if (isASCII(*p2) && ! (flags & FOLDEQ_LOCALE)) {
4302                     if ((flags & FOLDEQ_UTF8_NOMIX_ASCII) && ! isASCII(*p1)) {
4303                         return 0;
4304                     }
4305                     n2 = 1;
4306                     *foldbuf2 = toFOLD(*p2);
4307                 }
4308                 else if (u2) {
4309                     _to_utf8_fold_flags(p2, foldbuf2, &n2, flags_for_folder);
4310                 }
4311                 else {
4312                     _to_uni_fold_flags(*p2, foldbuf2, &n2, flags_for_folder);
4313                 }
4314                 f2 = foldbuf2;
4315             }
4316         }
4317
4318         /* Here f1 and f2 point to the beginning of the strings to compare.
4319          * These strings are the folds of the next character from each input
4320          * string, stored in UTF-8. */
4321
4322         /* While there is more to look for in both folds, see if they
4323         * continue to match */
4324         while (n1 && n2) {
4325             U8 fold_length = UTF8SKIP(f1);
4326             if (fold_length != UTF8SKIP(f2)
4327                 || (fold_length == 1 && *f1 != *f2) /* Short circuit memNE
4328                                                        function call for single
4329                                                        byte */
4330                 || memNE((char*)f1, (char*)f2, fold_length))
4331             {
4332                 return 0; /* mismatch */
4333             }
4334
4335             /* Here, they matched, advance past them */
4336             n1 -= fold_length;
4337             f1 += fold_length;
4338             n2 -= fold_length;
4339             f2 += fold_length;
4340         }
4341
4342         /* When reach the end of any fold, advance the input past it */
4343         if (n1 == 0) {
4344             p1 += u1 ? UTF8SKIP(p1) : 1;
4345         }
4346         if (n2 == 0) {
4347             p2 += u2 ? UTF8SKIP(p2) : 1;
4348         }
4349     } /* End of loop through both strings */
4350
4351     /* A match is defined by each scan that specified an explicit length
4352     * reaching its final goal, and the other not having matched a partial
4353     * character (which can happen when the fold of a character is more than one
4354     * character). */
4355     if (! ((g1 == 0 || p1 == g1) && (g2 == 0 || p2 == g2)) || n1 || n2) {
4356         return 0;
4357     }
4358
4359     /* Successful match.  Set output pointers */
4360     if (pe1) {
4361         *pe1 = (char*)p1;
4362     }
4363     if (pe2) {
4364         *pe2 = (char*)p2;
4365     }
4366     return 1;
4367 }
4368
4369 /* XXX The next two functions should likely be moved to mathoms.c once all
4370  * occurrences of them are removed from the core; some cpan-upstream modules
4371  * still use them */
4372
4373 U8 *
4374 Perl_uvuni_to_utf8(pTHX_ U8 *d, UV uv)
4375 {
4376     PERL_ARGS_ASSERT_UVUNI_TO_UTF8;
4377
4378     return Perl_uvoffuni_to_utf8_flags(aTHX_ d, uv, 0);
4379 }
4380
4381 /*
4382 =for apidoc utf8n_to_uvuni
4383
4384 Instead use L</utf8_to_uvchr_buf>, or rarely, L</utf8n_to_uvchr>.
4385
4386 This function was useful for code that wanted to handle both EBCDIC and
4387 ASCII platforms with Unicode properties, but starting in Perl v5.20, the
4388 distinctions between the platforms have mostly been made invisible to most
4389 code, so this function is quite unlikely to be what you want.  If you do need
4390 this precise functionality, use instead
4391 C<L<NATIVE_TO_UNI(utf8_to_uvchr_buf(...))|/utf8_to_uvchr_buf>>
4392 or C<L<NATIVE_TO_UNI(utf8n_to_uvchr(...))|/utf8n_to_uvchr>>.
4393
4394 =cut
4395 */
4396
4397 UV
4398 Perl_utf8n_to_uvuni(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
4399 {
4400     PERL_ARGS_ASSERT_UTF8N_TO_UVUNI;
4401
4402     return NATIVE_TO_UNI(utf8n_to_uvchr(s, curlen, retlen, flags));
4403 }
4404
4405 /*
4406 =for apidoc uvuni_to_utf8_flags
4407
4408 Instead you almost certainly want to use L</uvchr_to_utf8> or
4409 L</uvchr_to_utf8_flags>.
4410
4411 This function is a deprecated synonym for L</uvoffuni_to_utf8_flags>,
4412 which itself, while not deprecated, should be used only in isolated
4413 circumstances.  These functions were useful for code that wanted to handle
4414 both EBCDIC and ASCII platforms with Unicode properties, but starting in Perl
4415 v5.20, the distinctions between the platforms have mostly been made invisible
4416 to most code, so this function is quite unlikely to be what you want.
4417
4418 =cut
4419 */
4420
4421 U8 *
4422 Perl_uvuni_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
4423 {
4424     PERL_ARGS_ASSERT_UVUNI_TO_UTF8_FLAGS;
4425
4426     return uvoffuni_to_utf8_flags(d, uv, flags);
4427 }
4428
4429 /*
4430  * ex: set ts=8 sts=4 sw=4 et:
4431  */