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