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