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