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