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