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