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