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