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