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