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