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