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