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