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