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