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