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