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