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