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