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