Remove improper use of each() in B::walksymtable and fix ext/B/t/xref.t
[perl.git] / utf8.c
1 /*    utf8.c
2  *
3  *    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
4  *    by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /*
12  * 'What a fix!' said Sam.  'That's the one place in all the lands we've ever
13  *  heard of that we don't want to see any closer; and that's the one place
14  *  we're trying to get to!  And that's just where we can't get, nohow.'
15  *
16  *     [p.603 of _The Lord of the Rings_, IV/I: "The Taming of Sméagol"]
17  *
18  * 'Well do I understand your speech,' he answered in the same language;
19  * 'yet few strangers do so.  Why then do you not speak in the Common Tongue,
20  *  as is the custom in the West, if you wish to be answered?'
21  *                           --Gandalf, addressing Théoden's door wardens
22  *
23  *     [p.508 of _The Lord of the Rings_, III/vi: "The King of the Golden Hall"]
24  *
25  * ...the travellers perceived that the floor was paved with stones of many
26  * hues; branching runes and strange devices intertwined beneath their feet.
27  *
28  *     [p.512 of _The Lord of the Rings_, III/vi: "The King of the Golden Hall"]
29  */
30
31 #include "EXTERN.h"
32 #define PERL_IN_UTF8_C
33 #include "perl.h"
34 #include "inline_invlist.c"
35
36 #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     return isSPACE_uni(c);
1525 }
1526
1527 bool
1528 Perl_is_uni_digit(pTHX_ UV c)
1529 {
1530     U8 tmpbuf[UTF8_MAXBYTES+1];
1531     uvchr_to_utf8(tmpbuf, c);
1532     return is_utf8_digit(tmpbuf);
1533 }
1534
1535 bool
1536 Perl_is_uni_upper(pTHX_ UV c)
1537 {
1538     U8 tmpbuf[UTF8_MAXBYTES+1];
1539     uvchr_to_utf8(tmpbuf, c);
1540     return is_utf8_upper(tmpbuf);
1541 }
1542
1543 bool
1544 Perl_is_uni_lower(pTHX_ UV c)
1545 {
1546     U8 tmpbuf[UTF8_MAXBYTES+1];
1547     uvchr_to_utf8(tmpbuf, c);
1548     return is_utf8_lower(tmpbuf);
1549 }
1550
1551 bool
1552 Perl_is_uni_cntrl(pTHX_ UV c)
1553 {
1554     return isCNTRL_L1(c);
1555 }
1556
1557 bool
1558 Perl_is_uni_graph(pTHX_ UV c)
1559 {
1560     U8 tmpbuf[UTF8_MAXBYTES+1];
1561     uvchr_to_utf8(tmpbuf, c);
1562     return is_utf8_graph(tmpbuf);
1563 }
1564
1565 bool
1566 Perl_is_uni_print(pTHX_ UV c)
1567 {
1568     U8 tmpbuf[UTF8_MAXBYTES+1];
1569     uvchr_to_utf8(tmpbuf, c);
1570     return is_utf8_print(tmpbuf);
1571 }
1572
1573 bool
1574 Perl_is_uni_punct(pTHX_ UV c)
1575 {
1576     U8 tmpbuf[UTF8_MAXBYTES+1];
1577     uvchr_to_utf8(tmpbuf, c);
1578     return is_utf8_punct(tmpbuf);
1579 }
1580
1581 bool
1582 Perl_is_uni_xdigit(pTHX_ UV c)
1583 {
1584     return isXDIGIT_uni(c);
1585 }
1586
1587 UV
1588 Perl__to_upper_title_latin1(pTHX_ const U8 c, U8* p, STRLEN *lenp, const char S_or_s)
1589 {
1590     /* We have the latin1-range values compiled into the core, so just use
1591      * those, converting the result to utf8.  The only difference between upper
1592      * and title case in this range is that LATIN_SMALL_LETTER_SHARP_S is
1593      * either "SS" or "Ss".  Which one to use is passed into the routine in
1594      * 'S_or_s' to avoid a test */
1595
1596     UV converted = toUPPER_LATIN1_MOD(c);
1597
1598     PERL_ARGS_ASSERT__TO_UPPER_TITLE_LATIN1;
1599
1600     assert(S_or_s == 'S' || S_or_s == 's');
1601
1602     if (UNI_IS_INVARIANT(converted)) { /* No difference between the two for
1603                                           characters in this range */
1604         *p = (U8) converted;
1605         *lenp = 1;
1606         return converted;
1607     }
1608
1609     /* toUPPER_LATIN1_MOD gives the correct results except for three outliers,
1610      * which it maps to one of them, so as to only have to have one check for
1611      * it in the main case */
1612     if (UNLIKELY(converted == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS)) {
1613         switch (c) {
1614             case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
1615                 converted = LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS;
1616                 break;
1617             case MICRO_SIGN:
1618                 converted = GREEK_CAPITAL_LETTER_MU;
1619                 break;
1620             case LATIN_SMALL_LETTER_SHARP_S:
1621                 *(p)++ = 'S';
1622                 *p = S_or_s;
1623                 *lenp = 2;
1624                 return 'S';
1625             default:
1626                 Perl_croak(aTHX_ "panic: to_upper_title_latin1 did not expect '%c' to map to '%c'", c, LATIN_SMALL_LETTER_Y_WITH_DIAERESIS);
1627                 assert(0); /* NOTREACHED */
1628         }
1629     }
1630
1631     *(p)++ = UTF8_TWO_BYTE_HI(converted);
1632     *p = UTF8_TWO_BYTE_LO(converted);
1633     *lenp = 2;
1634
1635     return converted;
1636 }
1637
1638 /* Call the function to convert a UTF-8 encoded character to the specified case.
1639  * Note that there may be more than one character in the result.
1640  * INP is a pointer to the first byte of the input character
1641  * OUTP will be set to the first byte of the string of changed characters.  It
1642  *      needs to have space for UTF8_MAXBYTES_CASE+1 bytes
1643  * LENP will be set to the length in bytes of the string of changed characters
1644  *
1645  * The functions return the ordinal of the first character in the string of OUTP */
1646 #define CALL_UPPER_CASE(INP, OUTP, LENP) Perl_to_utf8_case(aTHX_ INP, OUTP, LENP, &PL_utf8_toupper, "ToUc", "utf8::ToSpecUc")
1647 #define CALL_TITLE_CASE(INP, OUTP, LENP) Perl_to_utf8_case(aTHX_ INP, OUTP, LENP, &PL_utf8_totitle, "ToTc", "utf8::ToSpecTc")
1648 #define CALL_LOWER_CASE(INP, OUTP, LENP) Perl_to_utf8_case(aTHX_ INP, OUTP, LENP, &PL_utf8_tolower, "ToLc", "utf8::ToSpecLc")
1649
1650 /* This additionally has the input parameter SPECIALS, which if non-zero will
1651  * cause this to use the SPECIALS hash for folding (meaning get full case
1652  * folding); otherwise, when zero, this implies a simple case fold */
1653 #define CALL_FOLD_CASE(INP, OUTP, LENP, SPECIALS) Perl_to_utf8_case(aTHX_ INP, OUTP, LENP, &PL_utf8_tofold, "ToCf", (SPECIALS) ? "utf8::ToSpecCf" : NULL)
1654
1655 UV
1656 Perl_to_uni_upper(pTHX_ UV c, U8* p, STRLEN *lenp)
1657 {
1658     dVAR;
1659
1660     /* Convert the Unicode character whose ordinal is <c> to its uppercase
1661      * version and store that in UTF-8 in <p> and its length in bytes in <lenp>.
1662      * Note that the <p> needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
1663      * the changed version may be longer than the original character.
1664      *
1665      * The ordinal of the first character of the changed version is returned
1666      * (but note, as explained above, that there may be more.) */
1667
1668     PERL_ARGS_ASSERT_TO_UNI_UPPER;
1669
1670     if (c < 256) {
1671         return _to_upper_title_latin1((U8) c, p, lenp, 'S');
1672     }
1673
1674     uvchr_to_utf8(p, c);
1675     return CALL_UPPER_CASE(p, p, lenp);
1676 }
1677
1678 UV
1679 Perl_to_uni_title(pTHX_ UV c, U8* p, STRLEN *lenp)
1680 {
1681     dVAR;
1682
1683     PERL_ARGS_ASSERT_TO_UNI_TITLE;
1684
1685     if (c < 256) {
1686         return _to_upper_title_latin1((U8) c, p, lenp, 's');
1687     }
1688
1689     uvchr_to_utf8(p, c);
1690     return CALL_TITLE_CASE(p, p, lenp);
1691 }
1692
1693 STATIC U8
1694 S_to_lower_latin1(pTHX_ const U8 c, U8* p, STRLEN *lenp)
1695 {
1696     /* We have the latin1-range values compiled into the core, so just use
1697      * those, converting the result to utf8.  Since the result is always just
1698      * one character, we allow <p> to be NULL */
1699
1700     U8 converted = toLOWER_LATIN1(c);
1701
1702     if (p != NULL) {
1703         if (UNI_IS_INVARIANT(converted)) {
1704             *p = converted;
1705             *lenp = 1;
1706         }
1707         else {
1708             *p = UTF8_TWO_BYTE_HI(converted);
1709             *(p+1) = UTF8_TWO_BYTE_LO(converted);
1710             *lenp = 2;
1711         }
1712     }
1713     return converted;
1714 }
1715
1716 UV
1717 Perl_to_uni_lower(pTHX_ UV c, U8* p, STRLEN *lenp)
1718 {
1719     dVAR;
1720
1721     PERL_ARGS_ASSERT_TO_UNI_LOWER;
1722
1723     if (c < 256) {
1724         return to_lower_latin1((U8) c, p, lenp);
1725     }
1726
1727     uvchr_to_utf8(p, c);
1728     return CALL_LOWER_CASE(p, p, lenp);
1729 }
1730
1731 UV
1732 Perl__to_fold_latin1(pTHX_ const U8 c, U8* p, STRLEN *lenp, const bool flags)
1733 {
1734     /* Corresponds to to_lower_latin1(), <flags> is TRUE if to use full case
1735      * folding */
1736
1737     UV converted;
1738
1739     PERL_ARGS_ASSERT__TO_FOLD_LATIN1;
1740
1741     if (c == MICRO_SIGN) {
1742         converted = GREEK_SMALL_LETTER_MU;
1743     }
1744     else if (flags && c == LATIN_SMALL_LETTER_SHARP_S) {
1745         *(p)++ = 's';
1746         *p = 's';
1747         *lenp = 2;
1748         return 's';
1749     }
1750     else { /* In this range the fold of all other characters is their lower
1751               case */
1752         converted = toLOWER_LATIN1(c);
1753     }
1754
1755     if (UNI_IS_INVARIANT(converted)) {
1756         *p = (U8) converted;
1757         *lenp = 1;
1758     }
1759     else {
1760         *(p)++ = UTF8_TWO_BYTE_HI(converted);
1761         *p = UTF8_TWO_BYTE_LO(converted);
1762         *lenp = 2;
1763     }
1764
1765     return converted;
1766 }
1767
1768 UV
1769 Perl__to_uni_fold_flags(pTHX_ UV c, U8* p, STRLEN *lenp, const U8 flags)
1770 {
1771
1772     /* Not currently externally documented, and subject to change
1773      *  <flags> bits meanings:
1774      *      FOLD_FLAGS_FULL  iff full folding is to be used;
1775      *      FOLD_FLAGS_LOCALE iff in locale
1776      *      FOLD_FLAGS_NOMIX_ASCII iff non-ASCII to ASCII folds are prohibited
1777      */
1778
1779     PERL_ARGS_ASSERT__TO_UNI_FOLD_FLAGS;
1780
1781     if (c < 256) {
1782         UV result = _to_fold_latin1((U8) c, p, lenp,
1783                                cBOOL(((flags & FOLD_FLAGS_FULL)
1784                                    /* If ASCII-safe, don't allow full folding,
1785                                     * as that could include SHARP S => ss;
1786                                     * otherwise there is no crossing of
1787                                     * ascii/non-ascii in the latin1 range */
1788                                    && ! (flags & FOLD_FLAGS_NOMIX_ASCII))));
1789         /* It is illegal for the fold to cross the 255/256 boundary under
1790          * locale; in this case return the original */
1791         return (result > 256 && flags & FOLD_FLAGS_LOCALE)
1792                ? c
1793                : result;
1794     }
1795
1796     /* If no special needs, just use the macro */
1797     if ( ! (flags & (FOLD_FLAGS_LOCALE|FOLD_FLAGS_NOMIX_ASCII))) {
1798         uvchr_to_utf8(p, c);
1799         return CALL_FOLD_CASE(p, p, lenp, flags & FOLD_FLAGS_FULL);
1800     }
1801     else {  /* Otherwise, _to_utf8_fold_flags has the intelligence to deal with
1802                the special flags. */
1803         U8 utf8_c[UTF8_MAXBYTES + 1];
1804         uvchr_to_utf8(utf8_c, c);
1805         return _to_utf8_fold_flags(utf8_c, p, lenp, flags, NULL);
1806     }
1807 }
1808
1809 /* for now these all assume no locale info available for Unicode > 255; and
1810  * the corresponding macros in handy.h (like isALNUM_LC_uvchr) should have been
1811  * called instead, so that these don't get called for < 255 */
1812
1813 bool
1814 Perl_is_uni_alnum_lc(pTHX_ UV c)
1815 {
1816     return is_uni_alnum(c);     /* XXX no locale support yet */
1817 }
1818
1819 bool
1820 Perl_is_uni_idfirst_lc(pTHX_ UV c)
1821 {
1822     return is_uni_idfirst(c);   /* XXX no locale support yet */
1823 }
1824
1825 bool
1826 Perl_is_uni_alpha_lc(pTHX_ UV c)
1827 {
1828     return is_uni_alpha(c);     /* XXX no locale support yet */
1829 }
1830
1831 bool
1832 Perl_is_uni_ascii_lc(pTHX_ UV c)
1833 {
1834     return is_uni_ascii(c);     /* XXX no locale support yet */
1835 }
1836
1837 bool
1838 Perl_is_uni_blank_lc(pTHX_ UV c)
1839 {
1840     return is_uni_blank(c);     /* XXX no locale support yet */
1841 }
1842
1843 bool
1844 Perl_is_uni_space_lc(pTHX_ UV c)
1845 {
1846     return is_uni_space(c);     /* XXX no locale support yet */
1847 }
1848
1849 bool
1850 Perl_is_uni_digit_lc(pTHX_ UV c)
1851 {
1852     return is_uni_digit(c);     /* XXX no locale support yet */
1853 }
1854
1855 bool
1856 Perl_is_uni_upper_lc(pTHX_ UV c)
1857 {
1858     return is_uni_upper(c);     /* XXX no locale support yet */
1859 }
1860
1861 bool
1862 Perl_is_uni_lower_lc(pTHX_ UV c)
1863 {
1864     return is_uni_lower(c);     /* XXX no locale support yet */
1865 }
1866
1867 bool
1868 Perl_is_uni_cntrl_lc(pTHX_ UV c)
1869 {
1870     return is_uni_cntrl(c);     /* XXX no locale support yet */
1871 }
1872
1873 bool
1874 Perl_is_uni_graph_lc(pTHX_ UV c)
1875 {
1876     return is_uni_graph(c);     /* XXX no locale support yet */
1877 }
1878
1879 bool
1880 Perl_is_uni_print_lc(pTHX_ UV c)
1881 {
1882     return is_uni_print(c);     /* XXX no locale support yet */
1883 }
1884
1885 bool
1886 Perl_is_uni_punct_lc(pTHX_ UV c)
1887 {
1888     return is_uni_punct(c);     /* XXX no locale support yet */
1889 }
1890
1891 bool
1892 Perl_is_uni_xdigit_lc(pTHX_ UV c)
1893 {
1894     return is_uni_xdigit(c);    /* XXX no locale support yet */
1895 }
1896
1897 U32
1898 Perl_to_uni_upper_lc(pTHX_ U32 c)
1899 {
1900     /* XXX returns only the first character -- do not use XXX */
1901     /* XXX no locale support yet */
1902     STRLEN len;
1903     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1904     return (U32)to_uni_upper(c, tmpbuf, &len);
1905 }
1906
1907 U32
1908 Perl_to_uni_title_lc(pTHX_ U32 c)
1909 {
1910     /* XXX returns only the first character XXX -- do not use XXX */
1911     /* XXX no locale support yet */
1912     STRLEN len;
1913     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1914     return (U32)to_uni_title(c, tmpbuf, &len);
1915 }
1916
1917 U32
1918 Perl_to_uni_lower_lc(pTHX_ U32 c)
1919 {
1920     /* XXX returns only the first character -- do not use XXX */
1921     /* XXX no locale support yet */
1922     STRLEN len;
1923     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1924     return (U32)to_uni_lower(c, tmpbuf, &len);
1925 }
1926
1927 PERL_STATIC_INLINE bool
1928 S_is_utf8_common(pTHX_ const U8 *const p, SV **swash,
1929                  const char *const swashname)
1930 {
1931     /* returns a boolean giving whether or not the UTF8-encoded character that
1932      * starts at <p> is in the swash indicated by <swashname>.  <swash>
1933      * contains a pointer to where the swash indicated by <swashname>
1934      * is to be stored; which this routine will do, so that future calls will
1935      * look at <*swash> and only generate a swash if it is not null
1936      *
1937      * Note that it is assumed that the buffer length of <p> is enough to
1938      * contain all the bytes that comprise the character.  Thus, <*p> should
1939      * have been checked before this call for mal-formedness enough to assure
1940      * that. */
1941
1942     dVAR;
1943
1944     PERL_ARGS_ASSERT_IS_UTF8_COMMON;
1945
1946     /* The API should have included a length for the UTF-8 character in <p>,
1947      * but it doesn't.  We therefor assume that p has been validated at least
1948      * as far as there being enough bytes available in it to accommodate the
1949      * character without reading beyond the end, and pass that number on to the
1950      * validating routine */
1951     if (!is_utf8_char_buf(p, p + UTF8SKIP(p)))
1952         return FALSE;
1953     if (!*swash) {
1954         U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
1955         *swash = _core_swash_init("utf8", swashname, &PL_sv_undef, 1, 0, NULL, &flags);
1956     }
1957     return swash_fetch(*swash, p, TRUE) != 0;
1958 }
1959
1960 bool
1961 Perl_is_utf8_alnum(pTHX_ const U8 *p)
1962 {
1963     dVAR;
1964
1965     PERL_ARGS_ASSERT_IS_UTF8_ALNUM;
1966
1967     /* NOTE: "IsWord", not "IsAlnum", since Alnum is a true
1968      * descendant of isalnum(3), in other words, it doesn't
1969      * contain the '_'. --jhi */
1970     return is_utf8_common(p, &PL_utf8_alnum, "IsWord");
1971 }
1972
1973 bool
1974 Perl_is_utf8_idfirst(pTHX_ const U8 *p) /* The naming is historical. */
1975 {
1976     dVAR;
1977
1978     PERL_ARGS_ASSERT_IS_UTF8_IDFIRST;
1979
1980     if (*p == '_')
1981         return TRUE;
1982     /* is_utf8_idstart would be more logical. */
1983     return is_utf8_common(p, &PL_utf8_idstart, "IdStart");
1984 }
1985
1986 bool
1987 Perl_is_utf8_xidfirst(pTHX_ const U8 *p) /* The naming is historical. */
1988 {
1989     dVAR;
1990
1991     PERL_ARGS_ASSERT_IS_UTF8_XIDFIRST;
1992
1993     if (*p == '_')
1994         return TRUE;
1995     /* is_utf8_idstart would be more logical. */
1996     return is_utf8_common(p, &PL_utf8_xidstart, "XIdStart");
1997 }
1998
1999 bool
2000 Perl__is_utf8__perl_idstart(pTHX_ const U8 *p)
2001 {
2002     dVAR;
2003
2004     PERL_ARGS_ASSERT__IS_UTF8__PERL_IDSTART;
2005
2006     return is_utf8_common(p, &PL_utf8_perl_idstart, "_Perl_IDStart");
2007 }
2008
2009 bool
2010 Perl_is_utf8_idcont(pTHX_ const U8 *p)
2011 {
2012     dVAR;
2013
2014     PERL_ARGS_ASSERT_IS_UTF8_IDCONT;
2015
2016     return is_utf8_common(p, &PL_utf8_idcont, "IdContinue");
2017 }
2018
2019 bool
2020 Perl_is_utf8_xidcont(pTHX_ const U8 *p)
2021 {
2022     dVAR;
2023
2024     PERL_ARGS_ASSERT_IS_UTF8_XIDCONT;
2025
2026     return is_utf8_common(p, &PL_utf8_idcont, "XIdContinue");
2027 }
2028
2029 bool
2030 Perl_is_utf8_alpha(pTHX_ const U8 *p)
2031 {
2032     dVAR;
2033
2034     PERL_ARGS_ASSERT_IS_UTF8_ALPHA;
2035
2036     return is_utf8_common(p, &PL_utf8_alpha, "IsAlpha");
2037 }
2038
2039 bool
2040 Perl_is_utf8_ascii(pTHX_ const U8 *p)
2041 {
2042     dVAR;
2043
2044     PERL_ARGS_ASSERT_IS_UTF8_ASCII;
2045
2046     /* ASCII characters are the same whether in utf8 or not.  So the macro
2047      * works on both utf8 and non-utf8 representations. */
2048     return isASCII(*p);
2049 }
2050
2051 bool
2052 Perl_is_utf8_blank(pTHX_ const U8 *p)
2053 {
2054     dVAR;
2055
2056     PERL_ARGS_ASSERT_IS_UTF8_BLANK;
2057
2058     return isBLANK_utf8(p);
2059 }
2060
2061 bool
2062 Perl_is_utf8_space(pTHX_ const U8 *p)
2063 {
2064     dVAR;
2065
2066     PERL_ARGS_ASSERT_IS_UTF8_SPACE;
2067
2068     return isSPACE_utf8(p);
2069 }
2070
2071 bool
2072 Perl_is_utf8_perl_space(pTHX_ const U8 *p)
2073 {
2074     dVAR;
2075
2076     PERL_ARGS_ASSERT_IS_UTF8_PERL_SPACE;
2077
2078     /* Only true if is an ASCII space-like character, and ASCII is invariant
2079      * under utf8, so can just use the macro */
2080     return isSPACE_A(*p);
2081 }
2082
2083 bool
2084 Perl_is_utf8_perl_word(pTHX_ const U8 *p)
2085 {
2086     dVAR;
2087
2088     PERL_ARGS_ASSERT_IS_UTF8_PERL_WORD;
2089
2090     /* Only true if is an ASCII word character, and ASCII is invariant
2091      * under utf8, so can just use the macro */
2092     return isWORDCHAR_A(*p);
2093 }
2094
2095 bool
2096 Perl_is_utf8_digit(pTHX_ const U8 *p)
2097 {
2098     dVAR;
2099
2100     PERL_ARGS_ASSERT_IS_UTF8_DIGIT;
2101
2102     return is_utf8_common(p, &PL_utf8_digit, "IsDigit");
2103 }
2104
2105 bool
2106 Perl_is_utf8_posix_digit(pTHX_ const U8 *p)
2107 {
2108     dVAR;
2109
2110     PERL_ARGS_ASSERT_IS_UTF8_POSIX_DIGIT;
2111
2112     /* Only true if is an ASCII digit character, and ASCII is invariant
2113      * under utf8, so can just use the macro */
2114     return isDIGIT_A(*p);
2115 }
2116
2117 bool
2118 Perl_is_utf8_upper(pTHX_ const U8 *p)
2119 {
2120     dVAR;
2121
2122     PERL_ARGS_ASSERT_IS_UTF8_UPPER;
2123
2124     return is_utf8_common(p, &PL_utf8_upper, "IsUppercase");
2125 }
2126
2127 bool
2128 Perl_is_utf8_lower(pTHX_ const U8 *p)
2129 {
2130     dVAR;
2131
2132     PERL_ARGS_ASSERT_IS_UTF8_LOWER;
2133
2134     return is_utf8_common(p, &PL_utf8_lower, "IsLowercase");
2135 }
2136
2137 bool
2138 Perl_is_utf8_cntrl(pTHX_ const U8 *p)
2139 {
2140     dVAR;
2141
2142     PERL_ARGS_ASSERT_IS_UTF8_CNTRL;
2143
2144     return isCNTRL_utf8(p);
2145 }
2146
2147 bool
2148 Perl_is_utf8_graph(pTHX_ const U8 *p)
2149 {
2150     dVAR;
2151
2152     PERL_ARGS_ASSERT_IS_UTF8_GRAPH;
2153
2154     return is_utf8_common(p, &PL_utf8_graph, "IsGraph");
2155 }
2156
2157 bool
2158 Perl_is_utf8_print(pTHX_ const U8 *p)
2159 {
2160     dVAR;
2161
2162     PERL_ARGS_ASSERT_IS_UTF8_PRINT;
2163
2164     return is_utf8_common(p, &PL_utf8_print, "IsPrint");
2165 }
2166
2167 bool
2168 Perl_is_utf8_punct(pTHX_ const U8 *p)
2169 {
2170     dVAR;
2171
2172     PERL_ARGS_ASSERT_IS_UTF8_PUNCT;
2173
2174     return is_utf8_common(p, &PL_utf8_punct, "IsPunct");
2175 }
2176
2177 bool
2178 Perl_is_utf8_xdigit(pTHX_ const U8 *p)
2179 {
2180     dVAR;
2181
2182     PERL_ARGS_ASSERT_IS_UTF8_XDIGIT;
2183
2184     return is_XDIGIT_utf8(p);
2185 }
2186
2187 bool
2188 Perl_is_utf8_mark(pTHX_ const U8 *p)
2189 {
2190     dVAR;
2191
2192     PERL_ARGS_ASSERT_IS_UTF8_MARK;
2193
2194     return is_utf8_common(p, &PL_utf8_mark, "IsM");
2195 }
2196
2197 bool
2198 Perl_is_utf8_X_regular_begin(pTHX_ const U8 *p)
2199 {
2200     dVAR;
2201
2202     PERL_ARGS_ASSERT_IS_UTF8_X_REGULAR_BEGIN;
2203
2204     return is_utf8_common(p, &PL_utf8_X_regular_begin, "_X_Regular_Begin");
2205 }
2206
2207 bool
2208 Perl_is_utf8_X_extend(pTHX_ const U8 *p)
2209 {
2210     dVAR;
2211
2212     PERL_ARGS_ASSERT_IS_UTF8_X_EXTEND;
2213
2214     return is_utf8_common(p, &PL_utf8_X_extend, "_X_Extend");
2215 }
2216
2217 /*
2218 =for apidoc to_utf8_case
2219
2220 The C<p> contains the pointer to the UTF-8 string encoding
2221 the character that is being converted.  This routine assumes that the character
2222 at C<p> is well-formed.
2223
2224 The C<ustrp> is a pointer to the character buffer to put the
2225 conversion result to.  The C<lenp> is a pointer to the length
2226 of the result.
2227
2228 The C<swashp> is a pointer to the swash to use.
2229
2230 Both the special and normal mappings are stored in F<lib/unicore/To/Foo.pl>,
2231 and loaded by SWASHNEW, using F<lib/utf8_heavy.pl>.  The C<special> (usually,
2232 but not always, a multicharacter mapping), is tried first.
2233
2234 The C<special> is a string like "utf8::ToSpecLower", which means the
2235 hash %utf8::ToSpecLower.  The access to the hash is through
2236 Perl_to_utf8_case().
2237
2238 The C<normal> is a string like "ToLower" which means the swash
2239 %utf8::ToLower.
2240
2241 =cut */
2242
2243 UV
2244 Perl_to_utf8_case(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp,
2245                         SV **swashp, const char *normal, const char *special)
2246 {
2247     dVAR;
2248     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
2249     STRLEN len = 0;
2250     const UV uv0 = valid_utf8_to_uvchr(p, NULL);
2251     /* The NATIVE_TO_UNI() and UNI_TO_NATIVE() mappings
2252      * are necessary in EBCDIC, they are redundant no-ops
2253      * in ASCII-ish platforms, and hopefully optimized away. */
2254     const UV uv1 = NATIVE_TO_UNI(uv0);
2255
2256     PERL_ARGS_ASSERT_TO_UTF8_CASE;
2257
2258     /* Note that swash_fetch() doesn't output warnings for these because it
2259      * assumes we will */
2260     if (uv1 >= UNICODE_SURROGATE_FIRST) {
2261         if (uv1 <= UNICODE_SURROGATE_LAST) {
2262             if (ckWARN_d(WARN_SURROGATE)) {
2263                 const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
2264                 Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
2265                     "Operation \"%s\" returns its argument for UTF-16 surrogate U+%04"UVXf"", desc, uv1);
2266             }
2267         }
2268         else if (UNICODE_IS_SUPER(uv1)) {
2269             if (ckWARN_d(WARN_NON_UNICODE)) {
2270                 const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
2271                 Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
2272                     "Operation \"%s\" returns its argument for non-Unicode code point 0x%04"UVXf"", desc, uv1);
2273             }
2274         }
2275
2276         /* Note that non-characters are perfectly legal, so no warning should
2277          * be given */
2278     }
2279
2280     uvuni_to_utf8(tmpbuf, uv1);
2281
2282     if (!*swashp) /* load on-demand */
2283          *swashp = _core_swash_init("utf8", normal, &PL_sv_undef, 4, 0, NULL, NULL);
2284
2285     if (special) {
2286          /* It might be "special" (sometimes, but not always,
2287           * a multicharacter mapping) */
2288          HV * const hv = get_hv(special, 0);
2289          SV **svp;
2290
2291          if (hv &&
2292              (svp = hv_fetch(hv, (const char*)tmpbuf, UNISKIP(uv1), FALSE)) &&
2293              (*svp)) {
2294              const char *s;
2295
2296               s = SvPV_const(*svp, len);
2297               if (len == 1)
2298                    len = uvuni_to_utf8(ustrp, NATIVE_TO_UNI(*(U8*)s)) - ustrp;
2299               else {
2300 #ifdef EBCDIC
2301                    /* If we have EBCDIC we need to remap the characters
2302                     * since any characters in the low 256 are Unicode
2303                     * code points, not EBCDIC. */
2304                    U8 *t = (U8*)s, *tend = t + len, *d;
2305                 
2306                    d = tmpbuf;
2307                    if (SvUTF8(*svp)) {
2308                         STRLEN tlen = 0;
2309                         
2310                         while (t < tend) {
2311                              const UV c = utf8_to_uvchr_buf(t, tend, &tlen);
2312                              if (tlen > 0) {
2313                                   d = uvchr_to_utf8(d, UNI_TO_NATIVE(c));
2314                                   t += tlen;
2315                              }
2316                              else
2317                                   break;
2318                         }
2319                    }
2320                    else {
2321                         while (t < tend) {
2322                              d = uvchr_to_utf8(d, UNI_TO_NATIVE(*t));
2323                              t++;
2324                         }
2325                    }
2326                    len = d - tmpbuf;
2327                    Copy(tmpbuf, ustrp, len, U8);
2328 #else
2329                    Copy(s, ustrp, len, U8);
2330 #endif
2331               }
2332          }
2333     }
2334
2335     if (!len && *swashp) {
2336         const UV uv2 = swash_fetch(*swashp, tmpbuf, TRUE /* => is utf8 */);
2337
2338          if (uv2) {
2339               /* It was "normal" (a single character mapping). */
2340               const UV uv3 = UNI_TO_NATIVE(uv2);
2341               len = uvchr_to_utf8(ustrp, uv3) - ustrp;
2342          }
2343     }
2344
2345     if (len) {
2346         if (lenp) {
2347             *lenp = len;
2348         }
2349         return valid_utf8_to_uvchr(ustrp, 0);
2350     }
2351
2352     /* Here, there was no mapping defined, which means that the code point maps
2353      * to itself.  Return the inputs */
2354     len = UTF8SKIP(p);
2355     if (p != ustrp) {   /* Don't copy onto itself */
2356         Copy(p, ustrp, len, U8);
2357     }
2358
2359     if (lenp)
2360          *lenp = len;
2361
2362     return uv0;
2363
2364 }
2365
2366 STATIC UV
2367 S_check_locale_boundary_crossing(pTHX_ const U8* const p, const UV result, U8* const ustrp, STRLEN *lenp)
2368 {
2369     /* This is called when changing the case of a utf8-encoded character above
2370      * the Latin1 range, and the operation is in locale.  If the result
2371      * contains a character that crosses the 255/256 boundary, disallow the
2372      * change, and return the original code point.  See L<perlfunc/lc> for why;
2373      *
2374      * p        points to the original string whose case was changed; assumed
2375      *          by this routine to be well-formed
2376      * result   the code point of the first character in the changed-case string
2377      * ustrp    points to the changed-case string (<result> represents its first char)
2378      * lenp     points to the length of <ustrp> */
2379
2380     UV original;    /* To store the first code point of <p> */
2381
2382     PERL_ARGS_ASSERT_CHECK_LOCALE_BOUNDARY_CROSSING;
2383
2384     assert(! UTF8_IS_INVARIANT(*p) && ! UTF8_IS_DOWNGRADEABLE_START(*p));
2385
2386     /* We know immediately if the first character in the string crosses the
2387      * boundary, so can skip */
2388     if (result > 255) {
2389
2390         /* Look at every character in the result; if any cross the
2391         * boundary, the whole thing is disallowed */
2392         U8* s = ustrp + UTF8SKIP(ustrp);
2393         U8* e = ustrp + *lenp;
2394         while (s < e) {
2395             if (UTF8_IS_INVARIANT(*s) || UTF8_IS_DOWNGRADEABLE_START(*s))
2396             {
2397                 goto bad_crossing;
2398             }
2399             s += UTF8SKIP(s);
2400         }
2401
2402         /* Here, no characters crossed, result is ok as-is */
2403         return result;
2404     }
2405
2406 bad_crossing:
2407
2408     /* Failed, have to return the original */
2409     original = valid_utf8_to_uvchr(p, lenp);
2410     Copy(p, ustrp, *lenp, char);
2411     return original;
2412 }
2413
2414 /*
2415 =for apidoc to_utf8_upper
2416
2417 Convert the UTF-8 encoded character at C<p> to its uppercase version and
2418 store that in UTF-8 in C<ustrp> and its length in bytes in C<lenp>.  Note
2419 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
2420 the uppercase version may be longer than the original character.
2421
2422 The first character of the uppercased version is returned
2423 (but note, as explained above, that there may be more.)
2424
2425 The character at C<p> is assumed by this routine to be well-formed.
2426
2427 =cut */
2428
2429 /* Not currently externally documented, and subject to change:
2430  * <flags> is set iff locale semantics are to be used for code points < 256
2431  * <tainted_ptr> if non-null, *tainted_ptr will be set TRUE iff locale rules
2432  *               were used in the calculation; otherwise unchanged. */
2433
2434 UV
2435 Perl__to_utf8_upper_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, const bool flags, bool* tainted_ptr)
2436 {
2437     dVAR;
2438
2439     UV result;
2440
2441     PERL_ARGS_ASSERT__TO_UTF8_UPPER_FLAGS;
2442
2443     if (UTF8_IS_INVARIANT(*p)) {
2444         if (flags) {
2445             result = toUPPER_LC(*p);
2446         }
2447         else {
2448             return _to_upper_title_latin1(*p, ustrp, lenp, 'S');
2449         }
2450     }
2451     else if UTF8_IS_DOWNGRADEABLE_START(*p) {
2452         if (flags) {
2453             result = toUPPER_LC(TWO_BYTE_UTF8_TO_UNI(*p, *(p+1)));
2454         }
2455         else {
2456             return _to_upper_title_latin1(TWO_BYTE_UTF8_TO_UNI(*p, *(p+1)),
2457                                           ustrp, lenp, 'S');
2458         }
2459     }
2460     else {  /* utf8, ord above 255 */
2461         result = CALL_UPPER_CASE(p, ustrp, lenp);
2462
2463         if (flags) {
2464             result = check_locale_boundary_crossing(p, result, ustrp, lenp);
2465         }
2466         return result;
2467     }
2468
2469     /* Here, used locale rules.  Convert back to utf8 */
2470     if (UTF8_IS_INVARIANT(result)) {
2471         *ustrp = (U8) result;
2472         *lenp = 1;
2473     }
2474     else {
2475         *ustrp = UTF8_EIGHT_BIT_HI(result);
2476         *(ustrp + 1) = UTF8_EIGHT_BIT_LO(result);
2477         *lenp = 2;
2478     }
2479
2480     if (tainted_ptr) {
2481         *tainted_ptr = TRUE;
2482     }
2483     return result;
2484 }
2485
2486 /*
2487 =for apidoc to_utf8_title
2488
2489 Convert the UTF-8 encoded character at C<p> to its titlecase version and
2490 store that in UTF-8 in C<ustrp> and its length in bytes in C<lenp>.  Note
2491 that the C<ustrp> needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
2492 titlecase version may be longer than the original character.
2493
2494 The first character of the titlecased version is returned
2495 (but note, as explained above, that there may be more.)
2496
2497 The character at C<p> is assumed by this routine to be well-formed.
2498
2499 =cut */
2500
2501 /* Not currently externally documented, and subject to change:
2502  * <flags> is set iff locale semantics are to be used for code points < 256
2503  *         Since titlecase is not defined in POSIX, uppercase is used instead
2504  *         for these/
2505  * <tainted_ptr> if non-null, *tainted_ptr will be set TRUE iff locale rules
2506  *               were used in the calculation; otherwise unchanged. */
2507
2508 UV
2509 Perl__to_utf8_title_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, const bool flags, bool* tainted_ptr)
2510 {
2511     dVAR;
2512
2513     UV result;
2514
2515     PERL_ARGS_ASSERT__TO_UTF8_TITLE_FLAGS;
2516
2517     if (UTF8_IS_INVARIANT(*p)) {
2518         if (flags) {
2519             result = toUPPER_LC(*p);
2520         }
2521         else {
2522             return _to_upper_title_latin1(*p, ustrp, lenp, 's');
2523         }
2524     }
2525     else if UTF8_IS_DOWNGRADEABLE_START(*p) {
2526         if (flags) {
2527             result = toUPPER_LC(TWO_BYTE_UTF8_TO_UNI(*p, *(p+1)));
2528         }
2529         else {
2530             return _to_upper_title_latin1(TWO_BYTE_UTF8_TO_UNI(*p, *(p+1)),
2531                                           ustrp, lenp, 's');
2532         }
2533     }
2534     else {  /* utf8, ord above 255 */
2535         result = CALL_TITLE_CASE(p, ustrp, lenp);
2536
2537         if (flags) {
2538             result = check_locale_boundary_crossing(p, result, ustrp, lenp);
2539         }
2540         return result;
2541     }
2542
2543     /* Here, used locale rules.  Convert back to utf8 */
2544     if (UTF8_IS_INVARIANT(result)) {
2545         *ustrp = (U8) result;
2546         *lenp = 1;
2547     }
2548     else {
2549         *ustrp = UTF8_EIGHT_BIT_HI(result);
2550         *(ustrp + 1) = UTF8_EIGHT_BIT_LO(result);
2551         *lenp = 2;
2552     }
2553
2554     if (tainted_ptr) {
2555         *tainted_ptr = TRUE;
2556     }
2557     return result;
2558 }
2559
2560 /*
2561 =for apidoc to_utf8_lower
2562
2563 Convert the UTF-8 encoded character at C<p> to its lowercase version and
2564 store that in UTF-8 in ustrp and its length in bytes in C<lenp>.  Note
2565 that the C<ustrp> needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
2566 lowercase version may be longer than the original character.
2567
2568 The first character of the lowercased version is returned
2569 (but note, as explained above, that there may be more.)
2570
2571 The character at C<p> is assumed by this routine to be well-formed.
2572
2573 =cut */
2574
2575 /* Not currently externally documented, and subject to change:
2576  * <flags> is set iff locale semantics are to be used for code points < 256
2577  * <tainted_ptr> if non-null, *tainted_ptr will be set TRUE iff locale rules
2578  *               were used in the calculation; otherwise unchanged. */
2579
2580 UV
2581 Perl__to_utf8_lower_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, const bool flags, bool* tainted_ptr)
2582 {
2583     UV result;
2584
2585     dVAR;
2586
2587     PERL_ARGS_ASSERT__TO_UTF8_LOWER_FLAGS;
2588
2589     if (UTF8_IS_INVARIANT(*p)) {
2590         if (flags) {
2591             result = toLOWER_LC(*p);
2592         }
2593         else {
2594             return to_lower_latin1(*p, ustrp, lenp);
2595         }
2596     }
2597     else if UTF8_IS_DOWNGRADEABLE_START(*p) {
2598         if (flags) {
2599             result = toLOWER_LC(TWO_BYTE_UTF8_TO_UNI(*p, *(p+1)));
2600         }
2601         else {
2602             return to_lower_latin1(TWO_BYTE_UTF8_TO_UNI(*p, *(p+1)),
2603                                    ustrp, lenp);
2604         }
2605     }
2606     else {  /* utf8, ord above 255 */
2607         result = CALL_LOWER_CASE(p, ustrp, lenp);
2608
2609         if (flags) {
2610             result = check_locale_boundary_crossing(p, result, ustrp, lenp);
2611         }
2612
2613         return result;
2614     }
2615
2616     /* Here, used locale rules.  Convert back to utf8 */
2617     if (UTF8_IS_INVARIANT(result)) {
2618         *ustrp = (U8) result;
2619         *lenp = 1;
2620     }
2621     else {
2622         *ustrp = UTF8_EIGHT_BIT_HI(result);
2623         *(ustrp + 1) = UTF8_EIGHT_BIT_LO(result);
2624         *lenp = 2;
2625     }
2626
2627     if (tainted_ptr) {
2628         *tainted_ptr = TRUE;
2629     }
2630     return result;
2631 }
2632
2633 /*
2634 =for apidoc to_utf8_fold
2635
2636 Convert the UTF-8 encoded character at C<p> to its foldcase version and
2637 store that in UTF-8 in C<ustrp> and its length in bytes in C<lenp>.  Note
2638 that the C<ustrp> needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
2639 foldcase version may be longer than the original character (up to
2640 three characters).
2641
2642 The first character of the foldcased version is returned
2643 (but note, as explained above, that there may be more.)
2644
2645 The character at C<p> is assumed by this routine to be well-formed.
2646
2647 =cut */
2648
2649 /* Not currently externally documented, and subject to change,
2650  * in <flags>
2651  *      bit FOLD_FLAGS_LOCALE is set iff locale semantics are to be used for code
2652  *                            points < 256.  Since foldcase is not defined in
2653  *                            POSIX, lowercase is used instead
2654  *      bit FOLD_FLAGS_FULL   is set iff full case folds are to be used;
2655  *                            otherwise simple folds
2656  *      bit FOLD_FLAGS_NOMIX_ASCII is set iff folds of non-ASCII to ASCII are
2657  *                            prohibited
2658  * <tainted_ptr> if non-null, *tainted_ptr will be set TRUE iff locale rules
2659  *               were used in the calculation; otherwise unchanged. */
2660
2661 UV
2662 Perl__to_utf8_fold_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, U8 flags, bool* tainted_ptr)
2663 {
2664     dVAR;
2665
2666     UV result;
2667
2668     PERL_ARGS_ASSERT__TO_UTF8_FOLD_FLAGS;
2669
2670     /* These are mutually exclusive */
2671     assert (! ((flags & FOLD_FLAGS_LOCALE) && (flags & FOLD_FLAGS_NOMIX_ASCII)));
2672
2673     assert(p != ustrp); /* Otherwise overwrites */
2674
2675     if (UTF8_IS_INVARIANT(*p)) {
2676         if (flags & FOLD_FLAGS_LOCALE) {
2677             result = toLOWER_LC(*p);
2678         }
2679         else {
2680             return _to_fold_latin1(*p, ustrp, lenp,
2681                                    cBOOL(flags & FOLD_FLAGS_FULL));
2682         }
2683     }
2684     else if UTF8_IS_DOWNGRADEABLE_START(*p) {
2685         if (flags & FOLD_FLAGS_LOCALE) {
2686             result = toLOWER_LC(TWO_BYTE_UTF8_TO_UNI(*p, *(p+1)));
2687         }
2688         else {
2689             return _to_fold_latin1(TWO_BYTE_UTF8_TO_UNI(*p, *(p+1)),
2690                                    ustrp, lenp,
2691                                    cBOOL((flags & FOLD_FLAGS_FULL
2692                                        /* If ASCII safe, don't allow full
2693                                         * folding, as that could include SHARP
2694                                         * S => ss; otherwise there is no
2695                                         * crossing of ascii/non-ascii in the
2696                                         * latin1 range */
2697                                        && ! (flags & FOLD_FLAGS_NOMIX_ASCII))));
2698         }
2699     }
2700     else {  /* utf8, ord above 255 */
2701         result = CALL_FOLD_CASE(p, ustrp, lenp, flags & FOLD_FLAGS_FULL);
2702
2703         if ((flags & FOLD_FLAGS_LOCALE)) {
2704             return check_locale_boundary_crossing(p, result, ustrp, lenp);
2705         }
2706         else if (! (flags & FOLD_FLAGS_NOMIX_ASCII)) {
2707             return result;
2708         }
2709         else {
2710             /* This is called when changing the case of a utf8-encoded
2711              * character above the Latin1 range, and the result should not
2712              * contain an ASCII character. */
2713
2714             UV original;    /* To store the first code point of <p> */
2715
2716             /* Look at every character in the result; if any cross the
2717             * boundary, the whole thing is disallowed */
2718             U8* s = ustrp;
2719             U8* e = ustrp + *lenp;
2720             while (s < e) {
2721                 if (isASCII(*s)) {
2722                     /* Crossed, have to return the original */
2723                     original = valid_utf8_to_uvchr(p, lenp);
2724                     Copy(p, ustrp, *lenp, char);
2725                     return original;
2726                 }
2727                 s += UTF8SKIP(s);
2728             }
2729
2730             /* Here, no characters crossed, result is ok as-is */
2731             return result;
2732         }
2733     }
2734
2735     /* Here, used locale rules.  Convert back to utf8 */
2736     if (UTF8_IS_INVARIANT(result)) {
2737         *ustrp = (U8) result;
2738         *lenp = 1;
2739     }
2740     else {
2741         *ustrp = UTF8_EIGHT_BIT_HI(result);
2742         *(ustrp + 1) = UTF8_EIGHT_BIT_LO(result);
2743         *lenp = 2;
2744     }
2745
2746     if (tainted_ptr) {
2747         *tainted_ptr = TRUE;
2748     }
2749     return result;
2750 }
2751
2752 /* Note:
2753  * Returns a "swash" which is a hash described in utf8.c:Perl_swash_fetch().
2754  * C<pkg> is a pointer to a package name for SWASHNEW, should be "utf8".
2755  * For other parameters, see utf8::SWASHNEW in lib/utf8_heavy.pl.
2756  */
2757
2758 SV*
2759 Perl_swash_init(pTHX_ const char* pkg, const char* name, SV *listsv, I32 minbits, I32 none)
2760 {
2761     PERL_ARGS_ASSERT_SWASH_INIT;
2762
2763     /* Returns a copy of a swash initiated by the called function.  This is the
2764      * public interface, and returning a copy prevents others from doing
2765      * mischief on the original */
2766
2767     return newSVsv(_core_swash_init(pkg, name, listsv, minbits, none, NULL, NULL));
2768 }
2769
2770 SV*
2771 Perl__core_swash_init(pTHX_ const char* pkg, const char* name, SV *listsv, I32 minbits, I32 none, SV* invlist, U8* const flags_p)
2772 {
2773     /* Initialize and return a swash, creating it if necessary.  It does this
2774      * by calling utf8_heavy.pl in the general case.  The returned value may be
2775      * the swash's inversion list instead if the input parameters allow it.
2776      * Which is returned should be immaterial to callers, as the only
2777      * operations permitted on a swash, swash_fetch(), _get_swash_invlist(),
2778      * and swash_to_invlist() handle both these transparently.
2779      *
2780      * This interface should only be used by functions that won't destroy or
2781      * adversely change the swash, as doing so affects all other uses of the
2782      * swash in the program; the general public should use 'Perl_swash_init'
2783      * instead.
2784      *
2785      * pkg  is the name of the package that <name> should be in.
2786      * name is the name of the swash to find.  Typically it is a Unicode
2787      *      property name, including user-defined ones
2788      * listsv is a string to initialize the swash with.  It must be of the form
2789      *      documented as the subroutine return value in
2790      *      L<perlunicode/User-Defined Character Properties>
2791      * minbits is the number of bits required to represent each data element.
2792      *      It is '1' for binary properties.
2793      * none I (khw) do not understand this one, but it is used only in tr///.
2794      * invlist is an inversion list to initialize the swash with (or NULL)
2795      * flags_p if non-NULL is the address of various input and output flag bits
2796      *      to the routine, as follows:  ('I' means is input to the routine;
2797      *      'O' means output from the routine.  Only flags marked O are
2798      *      meaningful on return.)
2799      *  _CORE_SWASH_INIT_USER_DEFINED_PROPERTY indicates if the swash
2800      *      came from a user-defined property.  (I O)
2801      *  _CORE_SWASH_INIT_RETURN_IF_UNDEF indicates that instead of croaking
2802      *      when the swash cannot be located, to simply return NULL. (I)
2803      *  _CORE_SWASH_INIT_ACCEPT_INVLIST indicates that the caller will accept a
2804      *      return of an inversion list instead of a swash hash if this routine
2805      *      thinks that would result in faster execution of swash_fetch() later
2806      *      on. (I)
2807      *
2808      * Thus there are three possible inputs to find the swash: <name>,
2809      * <listsv>, and <invlist>.  At least one must be specified.  The result
2810      * will be the union of the specified ones, although <listsv>'s various
2811      * actions can intersect, etc. what <name> gives.
2812      *
2813      * <invlist> is only valid for binary properties */
2814
2815     dVAR;
2816     SV* retval = &PL_sv_undef;
2817     HV* swash_hv = NULL;
2818     const int invlist_swash_boundary =
2819         (flags_p && *flags_p & _CORE_SWASH_INIT_ACCEPT_INVLIST)
2820         ? 512    /* Based on some benchmarking, but not extensive, see commit
2821                     message */
2822         : -1;   /* Never return just an inversion list */
2823
2824     assert(listsv != &PL_sv_undef || strNE(name, "") || invlist);
2825     assert(! invlist || minbits == 1);
2826
2827     /* If data was passed in to go out to utf8_heavy to find the swash of, do
2828      * so */
2829     if (listsv != &PL_sv_undef || strNE(name, "")) {
2830         dSP;
2831         const size_t pkg_len = strlen(pkg);
2832         const size_t name_len = strlen(name);
2833         HV * const stash = gv_stashpvn(pkg, pkg_len, 0);
2834         SV* errsv_save;
2835         GV *method;
2836
2837         PERL_ARGS_ASSERT__CORE_SWASH_INIT;
2838
2839         PUSHSTACKi(PERLSI_MAGIC);
2840         ENTER;
2841         SAVEHINTS();
2842         save_re_context();
2843         /* We might get here via a subroutine signature which uses a utf8
2844          * parameter name, at which point PL_subname will have been set
2845          * but not yet used. */
2846         save_item(PL_subname);
2847         if (PL_parser && PL_parser->error_count)
2848             SAVEI8(PL_parser->error_count), PL_parser->error_count = 0;
2849         method = gv_fetchmeth(stash, "SWASHNEW", 8, -1);
2850         if (!method) {  /* demand load utf8 */
2851             ENTER;
2852             errsv_save = newSVsv(ERRSV);
2853             SAVEFREESV(errsv_save);
2854             /* It is assumed that callers of this routine are not passing in
2855              * any user derived data.  */
2856             /* Need to do this after save_re_context() as it will set
2857              * PL_tainted to 1 while saving $1 etc (see the code after getrx:
2858              * in Perl_magic_get).  Even line to create errsv_save can turn on
2859              * PL_tainted.  */
2860 #ifndef NO_TAINT_SUPPORT
2861             SAVEBOOL(TAINT_get);
2862             TAINT_NOT;
2863 #endif
2864             Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpvn(pkg,pkg_len),
2865                              NULL);
2866             if (!SvTRUE(ERRSV))
2867                 sv_setsv(ERRSV, errsv_save);
2868             LEAVE;
2869         }
2870         SPAGAIN;
2871         PUSHMARK(SP);
2872         EXTEND(SP,5);
2873         mPUSHp(pkg, pkg_len);
2874         mPUSHp(name, name_len);
2875         PUSHs(listsv);
2876         mPUSHi(minbits);
2877         mPUSHi(none);
2878         PUTBACK;
2879         errsv_save = newSVsv(ERRSV);
2880         SAVEFREESV(errsv_save);
2881         /* If we already have a pointer to the method, no need to use
2882          * call_method() to repeat the lookup.  */
2883         if (method
2884             ? call_sv(MUTABLE_SV(method), G_SCALAR)
2885             : call_sv(newSVpvs_flags("SWASHNEW", SVs_TEMP), G_SCALAR | G_METHOD))
2886         {
2887             retval = *PL_stack_sp--;
2888             SvREFCNT_inc(retval);
2889         }
2890         if (!SvTRUE(ERRSV))
2891             sv_setsv(ERRSV, errsv_save);
2892         LEAVE;
2893         POPSTACK;
2894         if (IN_PERL_COMPILETIME) {
2895             CopHINTS_set(PL_curcop, PL_hints);
2896         }
2897         if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV) {
2898             if (SvPOK(retval))
2899
2900                 /* If caller wants to handle missing properties, let them */
2901                 if (flags_p && *flags_p & _CORE_SWASH_INIT_RETURN_IF_UNDEF) {
2902                     return NULL;
2903                 }
2904                 Perl_croak(aTHX_
2905                            "Can't find Unicode property definition \"%"SVf"\"",
2906                            SVfARG(retval));
2907             Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
2908         }
2909     } /* End of calling the module to find the swash */
2910
2911     /* If this operation fetched a swash, and we will need it later, get it */
2912     if (retval != &PL_sv_undef
2913         && (minbits == 1 || (flags_p
2914                             && ! (*flags_p
2915                                   & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY))))
2916     {
2917         swash_hv = MUTABLE_HV(SvRV(retval));
2918
2919         /* If we don't already know that there is a user-defined component to
2920          * this swash, and the user has indicated they wish to know if there is
2921          * one (by passing <flags_p>), find out */
2922         if (flags_p && ! (*flags_p & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY)) {
2923             SV** user_defined = hv_fetchs(swash_hv, "USER_DEFINED", FALSE);
2924             if (user_defined && SvUV(*user_defined)) {
2925                 *flags_p |= _CORE_SWASH_INIT_USER_DEFINED_PROPERTY;
2926             }
2927         }
2928     }
2929
2930     /* Make sure there is an inversion list for binary properties */
2931     if (minbits == 1) {
2932         SV** swash_invlistsvp = NULL;
2933         SV* swash_invlist = NULL;
2934         bool invlist_in_swash_is_valid = FALSE;
2935         bool swash_invlist_unclaimed = FALSE; /* whether swash_invlist has
2936                                             an unclaimed reference count */
2937
2938         /* If this operation fetched a swash, get its already existing
2939          * inversion list, or create one for it */
2940
2941         if (swash_hv) {
2942             swash_invlistsvp = hv_fetchs(swash_hv, "V", FALSE);
2943             if (swash_invlistsvp) {
2944                 swash_invlist = *swash_invlistsvp;
2945                 invlist_in_swash_is_valid = TRUE;
2946             }
2947             else {
2948                 swash_invlist = _swash_to_invlist(retval);
2949                 swash_invlist_unclaimed = TRUE;
2950             }
2951         }
2952
2953         /* If an inversion list was passed in, have to include it */
2954         if (invlist) {
2955
2956             /* Any fetched swash will by now have an inversion list in it;
2957              * otherwise <swash_invlist>  will be NULL, indicating that we
2958              * didn't fetch a swash */
2959             if (swash_invlist) {
2960
2961                 /* Add the passed-in inversion list, which invalidates the one
2962                  * already stored in the swash */
2963                 invlist_in_swash_is_valid = FALSE;
2964                 _invlist_union(invlist, swash_invlist, &swash_invlist);
2965             }
2966             else {
2967
2968                 /* Here, there is no swash already.  Set up a minimal one, if
2969                  * we are going to return a swash */
2970                 if ((int) _invlist_len(invlist) > invlist_swash_boundary) {
2971                     swash_hv = newHV();
2972                     retval = newRV_noinc(MUTABLE_SV(swash_hv));
2973                 }
2974                 swash_invlist = invlist;
2975             }
2976         }
2977
2978         /* Here, we have computed the union of all the passed-in data.  It may
2979          * be that there was an inversion list in the swash which didn't get
2980          * touched; otherwise save the one computed one */
2981         if (! invlist_in_swash_is_valid
2982             && (int) _invlist_len(swash_invlist) > invlist_swash_boundary)
2983         {
2984             if (! hv_stores(MUTABLE_HV(SvRV(retval)), "V", swash_invlist))
2985             {
2986                 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2987             }
2988             /* We just stole a reference count. */
2989             if (swash_invlist_unclaimed) swash_invlist_unclaimed = FALSE;
2990             else SvREFCNT_inc_simple_void_NN(swash_invlist);
2991         }
2992
2993         /* Use the inversion list stand-alone if small enough */
2994         if ((int) _invlist_len(swash_invlist) <= invlist_swash_boundary) {
2995             SvREFCNT_dec(retval);
2996             if (!swash_invlist_unclaimed)
2997                 SvREFCNT_inc_simple_void_NN(swash_invlist);
2998             retval = newRV_noinc(swash_invlist);
2999         }
3000     }
3001
3002     return retval;
3003 }
3004
3005
3006 /* This API is wrong for special case conversions since we may need to
3007  * return several Unicode characters for a single Unicode character
3008  * (see lib/unicore/SpecCase.txt) The SWASHGET in lib/utf8_heavy.pl is
3009  * the lower-level routine, and it is similarly broken for returning
3010  * multiple values.  --jhi
3011  * For those, you should use to_utf8_case() instead */
3012 /* Now SWASHGET is recasted into S_swatch_get in this file. */
3013
3014 /* Note:
3015  * Returns the value of property/mapping C<swash> for the first character
3016  * of the string C<ptr>. If C<do_utf8> is true, the string C<ptr> is
3017  * assumed to be in utf8. If C<do_utf8> is false, the string C<ptr> is
3018  * assumed to be in native 8-bit encoding. Caches the swatch in C<swash>.
3019  *
3020  * A "swash" is a hash which contains initially the keys/values set up by
3021  * SWASHNEW.  The purpose is to be able to completely represent a Unicode
3022  * property for all possible code points.  Things are stored in a compact form
3023  * (see utf8_heavy.pl) so that calculation is required to find the actual
3024  * property value for a given code point.  As code points are looked up, new
3025  * key/value pairs are added to the hash, so that the calculation doesn't have
3026  * to ever be re-done.  Further, each calculation is done, not just for the
3027  * desired one, but for a whole block of code points adjacent to that one.
3028  * For binary properties on ASCII machines, the block is usually for 64 code
3029  * points, starting with a code point evenly divisible by 64.  Thus if the
3030  * property value for code point 257 is requested, the code goes out and
3031  * calculates the property values for all 64 code points between 256 and 319,
3032  * and stores these as a single 64-bit long bit vector, called a "swatch",
3033  * under the key for code point 256.  The key is the UTF-8 encoding for code
3034  * point 256, minus the final byte.  Thus, if the length of the UTF-8 encoding
3035  * for a code point is 13 bytes, the key will be 12 bytes long.  If the value
3036  * for code point 258 is then requested, this code realizes that it would be
3037  * stored under the key for 256, and would find that value and extract the
3038  * relevant bit, offset from 256.
3039  *
3040  * Non-binary properties are stored in as many bits as necessary to represent
3041  * their values (32 currently, though the code is more general than that), not
3042  * as single bits, but the principal is the same: the value for each key is a
3043  * vector that encompasses the property values for all code points whose UTF-8
3044  * representations are represented by the key.  That is, for all code points
3045  * whose UTF-8 representations are length N bytes, and the key is the first N-1
3046  * bytes of that.
3047  */
3048 UV
3049 Perl_swash_fetch(pTHX_ SV *swash, const U8 *ptr, bool do_utf8)
3050 {
3051     dVAR;
3052     HV *const hv = MUTABLE_HV(SvRV(swash));
3053     U32 klen;
3054     U32 off;
3055     STRLEN slen;
3056     STRLEN needents;
3057     const U8 *tmps = NULL;
3058     U32 bit;
3059     SV *swatch;
3060     U8 tmputf8[2];
3061     const UV c = NATIVE_TO_ASCII(*ptr);
3062
3063     PERL_ARGS_ASSERT_SWASH_FETCH;
3064
3065     /* If it really isn't a hash, it isn't really swash; must be an inversion
3066      * list */
3067     if (SvTYPE(hv) != SVt_PVHV) {
3068         return _invlist_contains_cp((SV*)hv,
3069                                     (do_utf8)
3070                                      ? valid_utf8_to_uvchr(ptr, NULL)
3071                                      : c);
3072     }
3073
3074     /* Convert to utf8 if not already */
3075     if (!do_utf8 && !UNI_IS_INVARIANT(c)) {
3076         tmputf8[0] = (U8)UTF8_EIGHT_BIT_HI(c);
3077         tmputf8[1] = (U8)UTF8_EIGHT_BIT_LO(c);
3078         ptr = tmputf8;
3079     }
3080     /* Given a UTF-X encoded char 0xAA..0xYY,0xZZ
3081      * then the "swatch" is a vec() for all the chars which start
3082      * with 0xAA..0xYY
3083      * So the key in the hash (klen) is length of encoded char -1
3084      */
3085     klen = UTF8SKIP(ptr) - 1;
3086     off  = ptr[klen];
3087
3088     if (klen == 0) {
3089       /* If char is invariant then swatch is for all the invariant chars
3090        * In both UTF-8 and UTF-8-MOD that happens to be UTF_CONTINUATION_MARK
3091        */
3092         needents = UTF_CONTINUATION_MARK;
3093         off      = NATIVE_TO_UTF(ptr[klen]);
3094     }
3095     else {
3096       /* If char is encoded then swatch is for the prefix */
3097         needents = (1 << UTF_ACCUMULATION_SHIFT);
3098         off      = NATIVE_TO_UTF(ptr[klen]) & UTF_CONTINUATION_MASK;
3099     }
3100
3101     /*
3102      * This single-entry cache saves about 1/3 of the utf8 overhead in test
3103      * suite.  (That is, only 7-8% overall over just a hash cache.  Still,
3104      * it's nothing to sniff at.)  Pity we usually come through at least
3105      * two function calls to get here...
3106      *
3107      * NB: this code assumes that swatches are never modified, once generated!
3108      */
3109
3110     if (hv   == PL_last_swash_hv &&
3111         klen == PL_last_swash_klen &&
3112         (!klen || memEQ((char *)ptr, (char *)PL_last_swash_key, klen)) )
3113     {
3114         tmps = PL_last_swash_tmps;
3115         slen = PL_last_swash_slen;
3116     }
3117     else {
3118         /* Try our second-level swatch cache, kept in a hash. */
3119         SV** svp = hv_fetch(hv, (const char*)ptr, klen, FALSE);
3120
3121         /* If not cached, generate it via swatch_get */
3122         if (!svp || !SvPOK(*svp)
3123                  || !(tmps = (const U8*)SvPV_const(*svp, slen))) {
3124             /* We use utf8n_to_uvuni() as we want an index into
3125                Unicode tables, not a native character number.
3126              */
3127             const UV code_point = utf8n_to_uvuni(ptr, UTF8_MAXBYTES, 0,
3128                                            ckWARN(WARN_UTF8) ?
3129                                            0 : UTF8_ALLOW_ANY);
3130             swatch = swatch_get(swash,
3131                     /* On EBCDIC & ~(0xA0-1) isn't a useful thing to do */
3132                                 (klen) ? (code_point & ~((UV)needents - 1)) : 0,
3133                                 needents);
3134
3135             if (IN_PERL_COMPILETIME)
3136                 CopHINTS_set(PL_curcop, PL_hints);
3137
3138             svp = hv_store(hv, (const char *)ptr, klen, swatch, 0);
3139
3140             if (!svp || !(tmps = (U8*)SvPV(*svp, slen))
3141                      || (slen << 3) < needents)
3142                 Perl_croak(aTHX_ "panic: swash_fetch got improper swatch, "
3143                            "svp=%p, tmps=%p, slen=%"UVuf", needents=%"UVuf,
3144                            svp, tmps, (UV)slen, (UV)needents);
3145         }
3146
3147         PL_last_swash_hv = hv;
3148         assert(klen <= sizeof(PL_last_swash_key));
3149         PL_last_swash_klen = (U8)klen;
3150         /* FIXME change interpvar.h?  */
3151         PL_last_swash_tmps = (U8 *) tmps;
3152         PL_last_swash_slen = slen;
3153         if (klen)
3154             Copy(ptr, PL_last_swash_key, klen, U8);
3155     }
3156
3157     switch ((int)((slen << 3) / needents)) {
3158     case 1:
3159         bit = 1 << (off & 7);
3160         off >>= 3;
3161         return (tmps[off] & bit) != 0;
3162     case 8:
3163         return tmps[off];
3164     case 16:
3165         off <<= 1;
3166         return (tmps[off] << 8) + tmps[off + 1] ;
3167     case 32:
3168         off <<= 2;
3169         return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
3170     }
3171     Perl_croak(aTHX_ "panic: swash_fetch got swatch of unexpected bit width, "
3172                "slen=%"UVuf", needents=%"UVuf, (UV)slen, (UV)needents);
3173     NORETURN_FUNCTION_END;
3174 }
3175
3176 /* Read a single line of the main body of the swash input text.  These are of
3177  * the form:
3178  * 0053 0056    0073
3179  * where each number is hex.  The first two numbers form the minimum and
3180  * maximum of a range, and the third is the value associated with the range.
3181  * Not all swashes should have a third number
3182  *
3183  * On input: l    points to the beginning of the line to be examined; it points
3184  *                to somewhere in the string of the whole input text, and is
3185  *                terminated by a \n or the null string terminator.
3186  *           lend   points to the null terminator of that string
3187  *           wants_value    is non-zero if the swash expects a third number
3188  *           typestr is the name of the swash's mapping, like 'ToLower'
3189  * On output: *min, *max, and *val are set to the values read from the line.
3190  *            returns a pointer just beyond the line examined.  If there was no
3191  *            valid min number on the line, returns lend+1
3192  */
3193
3194 STATIC U8*
3195 S_swash_scan_list_line(pTHX_ U8* l, U8* const lend, UV* min, UV* max, UV* val,
3196                              const bool wants_value, const U8* const typestr)
3197 {
3198     const int  typeto  = typestr[0] == 'T' && typestr[1] == 'o';
3199     STRLEN numlen;          /* Length of the number */
3200     I32 flags = PERL_SCAN_SILENT_ILLDIGIT
3201                 | PERL_SCAN_DISALLOW_PREFIX
3202                 | PERL_SCAN_SILENT_NON_PORTABLE;
3203
3204     /* nl points to the next \n in the scan */
3205     U8* const nl = (U8*)memchr(l, '\n', lend - l);
3206
3207     /* Get the first number on the line: the range minimum */
3208     numlen = lend - l;
3209     *min = grok_hex((char *)l, &numlen, &flags, NULL);
3210     if (numlen)     /* If found a hex number, position past it */
3211         l += numlen;
3212     else if (nl) {          /* Else, go handle next line, if any */
3213         return nl + 1;  /* 1 is length of "\n" */
3214     }
3215     else {              /* Else, no next line */
3216         return lend + 1;        /* to LIST's end at which \n is not found */
3217     }
3218
3219     /* The max range value follows, separated by a BLANK */
3220     if (isBLANK(*l)) {
3221         ++l;
3222         flags = PERL_SCAN_SILENT_ILLDIGIT
3223                 | PERL_SCAN_DISALLOW_PREFIX
3224                 | PERL_SCAN_SILENT_NON_PORTABLE;
3225         numlen = lend - l;
3226         *max = grok_hex((char *)l, &numlen, &flags, NULL);
3227         if (numlen)
3228             l += numlen;
3229         else    /* If no value here, it is a single element range */
3230             *max = *min;
3231
3232         /* Non-binary tables have a third entry: what the first element of the
3233          * range maps to */
3234         if (wants_value) {
3235             if (isBLANK(*l)) {
3236                 ++l;
3237
3238                 /* The ToLc, etc table mappings are not in hex, and must be
3239                  * corrected by adding the code point to them */
3240                 if (typeto) {
3241                     char *after_strtol = (char *) lend;
3242                     *val = Strtol((char *)l, &after_strtol, 10);
3243                     l = (U8 *) after_strtol;
3244                 }
3245                 else { /* Other tables are in hex, and are the correct result
3246                           without tweaking */
3247                     flags = PERL_SCAN_SILENT_ILLDIGIT
3248                         | PERL_SCAN_DISALLOW_PREFIX
3249                         | PERL_SCAN_SILENT_NON_PORTABLE;
3250                     numlen = lend - l;
3251                     *val = grok_hex((char *)l, &numlen, &flags, NULL);
3252                     if (numlen)
3253                         l += numlen;
3254                     else
3255                         *val = 0;
3256                 }
3257             }
3258             else {
3259                 *val = 0;
3260                 if (typeto) {
3261                     /* diag_listed_as: To%s: illegal mapping '%s' */
3262                     Perl_croak(aTHX_ "%s: illegal mapping '%s'",
3263                                      typestr, l);
3264                 }
3265             }
3266         }
3267         else
3268             *val = 0; /* bits == 1, then any val should be ignored */
3269     }
3270     else { /* Nothing following range min, should be single element with no
3271               mapping expected */
3272         *max = *min;
3273         if (wants_value) {
3274             *val = 0;
3275             if (typeto) {
3276                 /* diag_listed_as: To%s: illegal mapping '%s' */
3277                 Perl_croak(aTHX_ "%s: illegal mapping '%s'", typestr, l);
3278             }
3279         }
3280         else
3281             *val = 0; /* bits == 1, then val should be ignored */
3282     }
3283
3284     /* Position to next line if any, or EOF */
3285     if (nl)
3286         l = nl + 1;
3287     else
3288         l = lend;
3289
3290     return l;
3291 }
3292
3293 /* Note:
3294  * Returns a swatch (a bit vector string) for a code point sequence
3295  * that starts from the value C<start> and comprises the number C<span>.
3296  * A C<swash> must be an object created by SWASHNEW (see lib/utf8_heavy.pl).
3297  * Should be used via swash_fetch, which will cache the swatch in C<swash>.
3298  */
3299 STATIC SV*
3300 S_swatch_get(pTHX_ SV* swash, UV start, UV span)
3301 {
3302     SV *swatch;
3303     U8 *l, *lend, *x, *xend, *s, *send;
3304     STRLEN lcur, xcur, scur;
3305     HV *const hv = MUTABLE_HV(SvRV(swash));
3306     SV** const invlistsvp = hv_fetchs(hv, "V", FALSE);
3307
3308     SV** listsvp = NULL; /* The string containing the main body of the table */
3309     SV** extssvp = NULL;
3310     SV** invert_it_svp = NULL;
3311     U8* typestr = NULL;
3312     STRLEN bits;
3313     STRLEN octets; /* if bits == 1, then octets == 0 */
3314     UV  none;
3315     UV  end = start + span;
3316
3317     if (invlistsvp == NULL) {
3318         SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
3319         SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
3320         SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
3321         extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
3322         listsvp = hv_fetchs(hv, "LIST", FALSE);
3323         invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
3324
3325         bits  = SvUV(*bitssvp);
3326         none  = SvUV(*nonesvp);
3327         typestr = (U8*)SvPV_nolen(*typesvp);
3328     }
3329     else {
3330         bits = 1;
3331         none = 0;
3332     }
3333     octets = bits >> 3; /* if bits == 1, then octets == 0 */
3334
3335     PERL_ARGS_ASSERT_SWATCH_GET;
3336
3337     if (bits != 1 && bits != 8 && bits != 16 && bits != 32) {
3338         Perl_croak(aTHX_ "panic: swatch_get doesn't expect bits %"UVuf,
3339                                                  (UV)bits);
3340     }
3341
3342     /* If overflowed, use the max possible */
3343     if (end < start) {
3344         end = UV_MAX;
3345         span = end - start;
3346     }
3347
3348     /* create and initialize $swatch */
3349     scur   = octets ? (span * octets) : (span + 7) / 8;
3350     swatch = newSV(scur);
3351     SvPOK_on(swatch);
3352     s = (U8*)SvPVX(swatch);
3353     if (octets && none) {
3354         const U8* const e = s + scur;
3355         while (s < e) {
3356             if (bits == 8)
3357                 *s++ = (U8)(none & 0xff);
3358             else if (bits == 16) {
3359                 *s++ = (U8)((none >>  8) & 0xff);
3360                 *s++ = (U8)( none        & 0xff);
3361             }
3362             else if (bits == 32) {
3363                 *s++ = (U8)((none >> 24) & 0xff);
3364                 *s++ = (U8)((none >> 16) & 0xff);
3365                 *s++ = (U8)((none >>  8) & 0xff);
3366                 *s++ = (U8)( none        & 0xff);
3367             }
3368         }
3369         *s = '\0';
3370     }
3371     else {
3372         (void)memzero((U8*)s, scur + 1);
3373     }
3374     SvCUR_set(swatch, scur);
3375     s = (U8*)SvPVX(swatch);
3376
3377     if (invlistsvp) {   /* If has an inversion list set up use that */
3378         _invlist_populate_swatch(*invlistsvp, start, end, s);
3379         return swatch;
3380     }
3381
3382     /* read $swash->{LIST} */
3383     l = (U8*)SvPV(*listsvp, lcur);
3384     lend = l + lcur;
3385     while (l < lend) {
3386         UV min, max, val, upper;
3387         l = S_swash_scan_list_line(aTHX_ l, lend, &min, &max, &val,
3388                                          cBOOL(octets), typestr);
3389         if (l > lend) {
3390             break;
3391         }
3392
3393         /* If looking for something beyond this range, go try the next one */
3394         if (max < start)
3395             continue;
3396
3397         /* <end> is generally 1 beyond where we want to set things, but at the
3398          * platform's infinity, where we can't go any higher, we want to
3399          * include the code point at <end> */
3400         upper = (max < end)
3401                 ? max
3402                 : (max != UV_MAX || end != UV_MAX)
3403                   ? end - 1
3404                   : end;
3405
3406         if (octets) {
3407             UV key;
3408             if (min < start) {
3409                 if (!none || val < none) {
3410                     val += start - min;
3411                 }
3412                 min = start;
3413             }
3414             for (key = min; key <= upper; key++) {
3415                 STRLEN offset;
3416                 /* offset must be non-negative (start <= min <= key < end) */
3417                 offset = octets * (key - start);
3418                 if (bits == 8)
3419                     s[offset] = (U8)(val & 0xff);
3420                 else if (bits == 16) {
3421                     s[offset    ] = (U8)((val >>  8) & 0xff);
3422                     s[offset + 1] = (U8)( val        & 0xff);
3423                 }
3424                 else if (bits == 32) {
3425                     s[offset    ] = (U8)((val >> 24) & 0xff);
3426                     s[offset + 1] = (U8)((val >> 16) & 0xff);
3427                     s[offset + 2] = (U8)((val >>  8) & 0xff);
3428                     s[offset + 3] = (U8)( val        & 0xff);
3429                 }
3430
3431                 if (!none || val < none)
3432                     ++val;
3433             }
3434         }
3435         else { /* bits == 1, then val should be ignored */
3436             UV key;
3437             if (min < start)
3438                 min = start;
3439
3440             for (key = min; key <= upper; key++) {
3441                 const STRLEN offset = (STRLEN)(key - start);
3442                 s[offset >> 3] |= 1 << (offset & 7);
3443             }
3444         }
3445     } /* while */
3446
3447     /* Invert if the data says it should be.  Assumes that bits == 1 */
3448     if (invert_it_svp && SvUV(*invert_it_svp)) {
3449
3450         /* Unicode properties should come with all bits above PERL_UNICODE_MAX
3451          * be 0, and their inversion should also be 0, as we don't succeed any
3452          * Unicode property matches for non-Unicode code points */
3453         if (start <= PERL_UNICODE_MAX) {
3454
3455             /* The code below assumes that we never cross the
3456              * Unicode/above-Unicode boundary in a range, as otherwise we would
3457              * have to figure out where to stop flipping the bits.  Since this
3458              * boundary is divisible by a large power of 2, and swatches comes
3459              * in small powers of 2, this should be a valid assumption */
3460             assert(start + span - 1 <= PERL_UNICODE_MAX);
3461
3462             send = s + scur;
3463             while (s < send) {
3464                 *s = ~(*s);
3465                 s++;
3466             }
3467         }
3468     }
3469
3470     /* read $swash->{EXTRAS}
3471      * This code also copied to swash_to_invlist() below */
3472     x = (U8*)SvPV(*extssvp, xcur);
3473     xend = x + xcur;
3474     while (x < xend) {
3475         STRLEN namelen;
3476         U8 *namestr;
3477         SV** othersvp;
3478         HV* otherhv;
3479         STRLEN otherbits;
3480         SV **otherbitssvp, *other;
3481         U8 *s, *o, *nl;
3482         STRLEN slen, olen;
3483
3484         const U8 opc = *x++;
3485         if (opc == '\n')
3486             continue;
3487
3488         nl = (U8*)memchr(x, '\n', xend - x);
3489
3490         if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
3491             if (nl) {
3492                 x = nl + 1; /* 1 is length of "\n" */
3493                 continue;
3494             }
3495             else {
3496                 x = xend; /* to EXTRAS' end at which \n is not found */
3497                 break;
3498             }
3499         }
3500
3501         namestr = x;
3502         if (nl) {
3503             namelen = nl - namestr;
3504             x = nl + 1;
3505         }
3506         else {
3507             namelen = xend - namestr;
3508             x = xend;
3509         }
3510
3511         othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
3512         otherhv = MUTABLE_HV(SvRV(*othersvp));
3513         otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
3514         otherbits = (STRLEN)SvUV(*otherbitssvp);
3515         if (bits < otherbits)
3516             Perl_croak(aTHX_ "panic: swatch_get found swatch size mismatch, "
3517                        "bits=%"UVuf", otherbits=%"UVuf, (UV)bits, (UV)otherbits);
3518
3519         /* The "other" swatch must be destroyed after. */
3520         other = swatch_get(*othersvp, start, span);
3521         o = (U8*)SvPV(other, olen);
3522
3523         if (!olen)
3524             Perl_croak(aTHX_ "panic: swatch_get got improper swatch");
3525
3526         s = (U8*)SvPV(swatch, slen);
3527         if (bits == 1 && otherbits == 1) {
3528             if (slen != olen)
3529                 Perl_croak(aTHX_ "panic: swatch_get found swatch length "
3530                            "mismatch, slen=%"UVuf", olen=%"UVuf,
3531                            (UV)slen, (UV)olen);
3532
3533             switch (opc) {
3534             case '+':
3535                 while (slen--)
3536                     *s++ |= *o++;
3537                 break;
3538             case '!':
3539                 while (slen--)
3540                     *s++ |= ~*o++;
3541                 break;
3542             case '-':
3543                 while (slen--)
3544                     *s++ &= ~*o++;
3545                 break;
3546             case '&':
3547                 while (slen--)
3548                     *s++ &= *o++;
3549                 break;
3550             default:
3551                 break;
3552             }
3553         }
3554         else {
3555             STRLEN otheroctets = otherbits >> 3;
3556             STRLEN offset = 0;
3557             U8* const send = s + slen;
3558
3559             while (s < send) {
3560                 UV otherval = 0;
3561
3562                 if (otherbits == 1) {
3563                     otherval = (o[offset >> 3] >> (offset & 7)) & 1;
3564                     ++offset;
3565                 }
3566                 else {
3567                     STRLEN vlen = otheroctets;
3568                     otherval = *o++;
3569                     while (--vlen) {
3570                         otherval <<= 8;
3571                         otherval |= *o++;
3572                     }
3573                 }
3574
3575                 if (opc == '+' && otherval)
3576                     NOOP;   /* replace with otherval */
3577                 else if (opc == '!' && !otherval)
3578                     otherval = 1;
3579                 else if (opc == '-' && otherval)
3580                     otherval = 0;
3581                 else if (opc == '&' && !otherval)
3582                     otherval = 0;
3583                 else {
3584                     s += octets; /* no replacement */
3585                     continue;
3586                 }
3587
3588                 if (bits == 8)
3589                     *s++ = (U8)( otherval & 0xff);
3590                 else if (bits == 16) {
3591                     *s++ = (U8)((otherval >>  8) & 0xff);
3592                     *s++ = (U8)( otherval        & 0xff);
3593                 }
3594                 else if (bits == 32) {
3595                     *s++ = (U8)((otherval >> 24) & 0xff);
3596                     *s++ = (U8)((otherval >> 16) & 0xff);
3597                     *s++ = (U8)((otherval >>  8) & 0xff);
3598                     *s++ = (U8)( otherval        & 0xff);
3599                 }
3600             }
3601         }
3602         sv_free(other); /* through with it! */
3603     } /* while */
3604     return swatch;
3605 }
3606
3607 HV*
3608 Perl__swash_inversion_hash(pTHX_ SV* const swash)
3609 {
3610
3611    /* Subject to change or removal.  For use only in regcomp.c and regexec.c
3612     * Can't be used on a property that is subject to user override, as it
3613     * relies on the value of SPECIALS in the swash which would be set by
3614     * utf8_heavy.pl to the hash in the non-overriden file, and hence is not set
3615     * for overridden properties
3616     *
3617     * Returns a hash which is the inversion and closure of a swash mapping.
3618     * For example, consider the input lines:
3619     * 004B              006B
3620     * 004C              006C
3621     * 212A              006B
3622     *
3623     * The returned hash would have two keys, the utf8 for 006B and the utf8 for
3624     * 006C.  The value for each key is an array.  For 006C, the array would
3625     * have a two elements, the utf8 for itself, and for 004C.  For 006B, there
3626     * would be three elements in its array, the utf8 for 006B, 004B and 212A.
3627     *
3628     * Essentially, for any code point, it gives all the code points that map to
3629     * it, or the list of 'froms' for that point.
3630     *
3631     * Currently it ignores any additions or deletions from other swashes,
3632     * looking at just the main body of the swash, and if there are SPECIALS
3633     * in the swash, at that hash
3634     *
3635     * The specials hash can be extra code points, and most likely consists of
3636     * maps from single code points to multiple ones (each expressed as a string
3637     * of utf8 characters).   This function currently returns only 1-1 mappings.
3638     * However consider this possible input in the specials hash:
3639     * "\xEF\xAC\x85" => "\x{0073}\x{0074}",         # U+FB05 => 0073 0074
3640     * "\xEF\xAC\x86" => "\x{0073}\x{0074}",         # U+FB06 => 0073 0074
3641     *
3642     * Both FB05 and FB06 map to the same multi-char sequence, which we don't
3643     * currently handle.  But it also means that FB05 and FB06 are equivalent in
3644     * a 1-1 mapping which we should handle, and this relationship may not be in
3645     * the main table.  Therefore this function examines all the multi-char
3646     * sequences and adds the 1-1 mappings that come out of that.  */
3647
3648     U8 *l, *lend;
3649     STRLEN lcur;
3650     HV *const hv = MUTABLE_HV(SvRV(swash));
3651
3652     /* The string containing the main body of the table.  This will have its
3653      * assertion fail if the swash has been converted to its inversion list */
3654     SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
3655
3656     SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
3657     SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
3658     SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
3659     /*SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);*/
3660     const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
3661     const STRLEN bits  = SvUV(*bitssvp);
3662     const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
3663     const UV     none  = SvUV(*nonesvp);
3664     SV **specials_p = hv_fetchs(hv, "SPECIALS", 0);
3665
3666     HV* ret = newHV();
3667
3668     PERL_ARGS_ASSERT__SWASH_INVERSION_HASH;
3669
3670     /* Must have at least 8 bits to get the mappings */
3671     if (bits != 8 && bits != 16 && bits != 32) {
3672         Perl_croak(aTHX_ "panic: swash_inversion_hash doesn't expect bits %"UVuf,
3673                                                  (UV)bits);
3674     }
3675
3676     if (specials_p) { /* It might be "special" (sometimes, but not always, a
3677                         mapping to more than one character */
3678
3679         /* Construct an inverse mapping hash for the specials */
3680         HV * const specials_hv = MUTABLE_HV(SvRV(*specials_p));
3681         HV * specials_inverse = newHV();
3682         char *char_from; /* the lhs of the map */
3683         I32 from_len;   /* its byte length */
3684         char *char_to;  /* the rhs of the map */
3685         I32 to_len;     /* its byte length */
3686         SV *sv_to;      /* and in a sv */
3687         AV* from_list;  /* list of things that map to each 'to' */
3688
3689         hv_iterinit(specials_hv);
3690
3691         /* The keys are the characters (in utf8) that map to the corresponding
3692          * utf8 string value.  Iterate through the list creating the inverse
3693          * list. */
3694         while ((sv_to = hv_iternextsv(specials_hv, &char_from, &from_len))) {
3695             SV** listp;
3696             if (! SvPOK(sv_to)) {
3697                 Perl_croak(aTHX_ "panic: value returned from hv_iternextsv() "
3698                            "unexpectedly is not a string, flags=%lu",
3699                            (unsigned long)SvFLAGS(sv_to));
3700             }
3701             /*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)));*/
3702
3703             /* Each key in the inverse list is a mapped-to value, and the key's
3704              * hash value is a list of the strings (each in utf8) that map to
3705              * it.  Those strings are all one character long */
3706             if ((listp = hv_fetch(specials_inverse,
3707                                     SvPVX(sv_to),
3708                                     SvCUR(sv_to), 0)))
3709             {
3710                 from_list = (AV*) *listp;
3711             }
3712             else { /* No entry yet for it: create one */
3713                 from_list = newAV();
3714                 if (! hv_store(specials_inverse,
3715                                 SvPVX(sv_to),
3716                                 SvCUR(sv_to),
3717                                 (SV*) from_list, 0))
3718                 {
3719                     Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
3720                 }
3721             }
3722
3723             /* Here have the list associated with this 'to' (perhaps newly
3724              * created and empty).  Just add to it.  Note that we ASSUME that
3725              * the input is guaranteed to not have duplications, so we don't
3726              * check for that.  Duplications just slow down execution time. */
3727             av_push(from_list, newSVpvn_utf8(char_from, from_len, TRUE));
3728         }
3729
3730         /* Here, 'specials_inverse' contains the inverse mapping.  Go through
3731          * it looking for cases like the FB05/FB06 examples above.  There would
3732          * be an entry in the hash like
3733         *       'st' => [ FB05, FB06 ]
3734         * In this example we will create two lists that get stored in the
3735         * returned hash, 'ret':
3736         *       FB05 => [ FB05, FB06 ]
3737         *       FB06 => [ FB05, FB06 ]
3738         *
3739         * Note that there is nothing to do if the array only has one element.
3740         * (In the normal 1-1 case handled below, we don't have to worry about
3741         * two lists, as everything gets tied to the single list that is
3742         * generated for the single character 'to'.  But here, we are omitting
3743         * that list, ('st' in the example), so must have multiple lists.) */
3744         while ((from_list = (AV *) hv_iternextsv(specials_inverse,
3745                                                  &char_to, &to_len)))
3746         {
3747             if (av_len(from_list) > 0) {
3748                 int i;
3749
3750                 /* We iterate over all combinations of i,j to place each code
3751                  * point on each list */
3752                 for (i = 0; i <= av_len(from_list); i++) {
3753                     int j;
3754                     AV* i_list = newAV();
3755                     SV** entryp = av_fetch(from_list, i, FALSE);
3756                     if (entryp == NULL) {
3757                         Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
3758                     }
3759                     if (hv_fetch(ret, SvPVX(*entryp), SvCUR(*entryp), FALSE)) {
3760                         Perl_croak(aTHX_ "panic: unexpected entry for %s", SvPVX(*entryp));
3761                     }
3762                     if (! hv_store(ret, SvPVX(*entryp), SvCUR(*entryp),
3763                                    (SV*) i_list, FALSE))
3764                     {
3765                         Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
3766                     }
3767
3768                     /* For debugging: UV u = valid_utf8_to_uvchr((U8*) SvPVX(*entryp), 0);*/
3769                     for (j = 0; j <= av_len(from_list); j++) {
3770                         entryp = av_fetch(from_list, j, FALSE);
3771                         if (entryp == NULL) {
3772                             Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
3773                         }
3774
3775                         /* When i==j this adds itself to the list */
3776                         av_push(i_list, newSVuv(utf8_to_uvchr_buf(
3777                                         (U8*) SvPVX(*entryp),
3778                                         (U8*) SvPVX(*entryp) + SvCUR(*entryp),
3779                                         0)));
3780                         /*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));*/
3781                     }
3782                 }
3783             }
3784         }
3785         SvREFCNT_dec(specials_inverse); /* done with it */
3786     } /* End of specials */
3787
3788     /* read $swash->{LIST} */
3789     l = (U8*)SvPV(*listsvp, lcur);
3790     lend = l + lcur;
3791
3792     /* Go through each input line */
3793     while (l < lend) {
3794         UV min, max, val;
3795         UV inverse;
3796         l = S_swash_scan_list_line(aTHX_ l, lend, &min, &max, &val,
3797                                          cBOOL(octets), typestr);
3798         if (l > lend) {
3799             break;
3800         }
3801
3802         /* Each element in the range is to be inverted */
3803         for (inverse = min; inverse <= max; inverse++) {
3804             AV* list;
3805             SV** listp;
3806             IV i;
3807             bool found_key = FALSE;
3808             bool found_inverse = FALSE;
3809
3810             /* The key is the inverse mapping */
3811             char key[UTF8_MAXBYTES+1];
3812             char* key_end = (char *) uvuni_to_utf8((U8*) key, val);
3813             STRLEN key_len = key_end - key;
3814
3815             /* Get the list for the map */
3816             if ((listp = hv_fetch(ret, key, key_len, FALSE))) {
3817                 list = (AV*) *listp;
3818             }
3819             else { /* No entry yet for it: create one */
3820                 list = newAV();
3821                 if (! hv_store(ret, key, key_len, (SV*) list, FALSE)) {
3822                     Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
3823                 }
3824             }
3825
3826             /* Look through list to see if this inverse mapping already is
3827              * listed, or if there is a mapping to itself already */
3828             for (i = 0; i <= av_len(list); i++) {
3829                 SV** entryp = av_fetch(list, i, FALSE);
3830                 SV* entry;
3831                 if (entryp == NULL) {
3832                     Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
3833                 }
3834                 entry = *entryp;
3835                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "list for %"UVXf" contains %"UVXf"\n", val, SvUV(entry)));*/
3836                 if (SvUV(entry) == val) {
3837                     found_key = TRUE;
3838                 }
3839                 if (SvUV(entry) == inverse) {
3840                     found_inverse = TRUE;
3841                 }
3842
3843                 /* No need to continue searching if found everything we are
3844                  * looking for */
3845                 if (found_key && found_inverse) {
3846                     break;
3847                 }
3848             }
3849
3850             /* Make sure there is a mapping to itself on the list */
3851             if (! found_key) {
3852                 av_push(list, newSVuv(val));
3853                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "%s: %d: Adding %"UVXf" to list for %"UVXf"\n", __FILE__, __LINE__, val, val));*/
3854             }
3855
3856
3857             /* Simply add the value to the list */
3858             if (! found_inverse) {
3859                 av_push(list, newSVuv(inverse));
3860                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "%s: %d: Adding %"UVXf" to list for %"UVXf"\n", __FILE__, __LINE__, inverse, val));*/
3861             }
3862
3863             /* swatch_get() increments the value of val for each element in the
3864              * range.  That makes more compact tables possible.  You can
3865              * express the capitalization, for example, of all consecutive
3866              * letters with a single line: 0061\t007A\t0041 This maps 0061 to
3867              * 0041, 0062 to 0042, etc.  I (khw) have never understood 'none',
3868              * and it's not documented; it appears to be used only in
3869              * implementing tr//; I copied the semantics from swatch_get(), just
3870              * in case */
3871             if (!none || val < none) {
3872                 ++val;
3873             }
3874         }
3875     }
3876
3877     return ret;
3878 }
3879
3880 SV*
3881 Perl__swash_to_invlist(pTHX_ SV* const swash)
3882 {
3883
3884    /* Subject to change or removal.  For use only in one place in regcomp.c */
3885
3886     U8 *l, *lend;
3887     char *loc;
3888     STRLEN lcur;
3889     HV *const hv = MUTABLE_HV(SvRV(swash));
3890     UV elements = 0;    /* Number of elements in the inversion list */
3891     U8 empty[] = "";
3892     SV** listsvp;
3893     SV** typesvp;
3894     SV** bitssvp;
3895     SV** extssvp;
3896     SV** invert_it_svp;
3897
3898     U8* typestr;
3899     STRLEN bits;
3900     STRLEN octets; /* if bits == 1, then octets == 0 */
3901     U8 *x, *xend;
3902     STRLEN xcur;
3903
3904     SV* invlist;
3905
3906     /* If not a hash, it must be the swash's inversion list instead */
3907     if (SvTYPE(hv) != SVt_PVHV) {
3908         return (SV*) hv;
3909     }
3910
3911     /* The string containing the main body of the table */
3912     listsvp = hv_fetchs(hv, "LIST", FALSE);
3913     typesvp = hv_fetchs(hv, "TYPE", FALSE);
3914     bitssvp = hv_fetchs(hv, "BITS", FALSE);
3915     extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
3916     invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
3917
3918     typestr = (U8*)SvPV_nolen(*typesvp);
3919     bits  = SvUV(*bitssvp);
3920     octets = bits >> 3; /* if bits == 1, then octets == 0 */
3921
3922     PERL_ARGS_ASSERT__SWASH_TO_INVLIST;
3923
3924     /* read $swash->{LIST} */
3925     if (SvPOK(*listsvp)) {
3926         l = (U8*)SvPV(*listsvp, lcur);
3927     }
3928     else {
3929         /* LIST legitimately doesn't contain a string during compilation phases
3930          * of Perl itself, before the Unicode tables are generated.  In this
3931          * case, just fake things up by creating an empty list */
3932         l = empty;
3933         lcur = 0;
3934     }
3935     loc = (char *) l;
3936     lend = l + lcur;
3937
3938     /* Scan the input to count the number of lines to preallocate array size
3939      * based on worst possible case, which is each line in the input creates 2
3940      * elements in the inversion list: 1) the beginning of a range in the list;
3941      * 2) the beginning of a range not in the list.  */
3942     while ((loc = (strchr(loc, '\n'))) != NULL) {
3943         elements += 2;
3944         loc++;
3945     }
3946
3947     /* If the ending is somehow corrupt and isn't a new line, add another
3948      * element for the final range that isn't in the inversion list */
3949     if (! (*lend == '\n'
3950         || (*lend == '\0' && (lcur == 0 || *(lend - 1) == '\n'))))
3951     {
3952         elements++;
3953     }
3954
3955     invlist = _new_invlist(elements);
3956
3957     /* Now go through the input again, adding each range to the list */
3958     while (l < lend) {
3959         UV start, end;
3960         UV val;         /* Not used by this function */
3961
3962         l = S_swash_scan_list_line(aTHX_ l, lend, &start, &end, &val,
3963                                          cBOOL(octets), typestr);
3964
3965         if (l > lend) {
3966             break;
3967         }
3968
3969         invlist = _add_range_to_invlist(invlist, start, end);
3970     }
3971
3972     /* Invert if the data says it should be */
3973     if (invert_it_svp && SvUV(*invert_it_svp)) {
3974         _invlist_invert_prop(invlist);
3975     }
3976
3977     /* This code is copied from swatch_get()
3978      * read $swash->{EXTRAS} */
3979     x = (U8*)SvPV(*extssvp, xcur);
3980     xend = x + xcur;
3981     while (x < xend) {
3982         STRLEN namelen;
3983         U8 *namestr;
3984         SV** othersvp;
3985         HV* otherhv;
3986         STRLEN otherbits;
3987         SV **otherbitssvp, *other;
3988         U8 *nl;
3989
3990         const U8 opc = *x++;
3991         if (opc == '\n')
3992             continue;
3993
3994         nl = (U8*)memchr(x, '\n', xend - x);
3995
3996         if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
3997             if (nl) {
3998                 x = nl + 1; /* 1 is length of "\n" */
3999                 continue;
4000             }
4001             else {
4002                 x = xend; /* to EXTRAS' end at which \n is not found */
4003                 break;
4004             }
4005         }
4006
4007         namestr = x;
4008         if (nl) {
4009             namelen = nl - namestr;
4010             x = nl + 1;
4011         }
4012         else {
4013             namelen = xend - namestr;
4014             x = xend;
4015         }
4016
4017         othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
4018         otherhv = MUTABLE_HV(SvRV(*othersvp));
4019         otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
4020         otherbits = (STRLEN)SvUV(*otherbitssvp);
4021
4022         if (bits != otherbits || bits != 1) {
4023             Perl_croak(aTHX_ "panic: _swash_to_invlist only operates on boolean "
4024                        "properties, bits=%"UVuf", otherbits=%"UVuf,
4025                        (UV)bits, (UV)otherbits);
4026         }
4027
4028         /* The "other" swatch must be destroyed after. */
4029         other = _swash_to_invlist((SV *)*othersvp);
4030
4031         /* End of code copied from swatch_get() */
4032         switch (opc) {
4033         case '+':
4034             _invlist_union(invlist, other, &invlist);
4035             break;
4036         case '!':
4037             _invlist_invert(other);
4038             _invlist_union(invlist, other, &invlist);
4039             break;
4040         case '-':
4041             _invlist_subtract(invlist, other, &invlist);
4042             break;
4043         case '&':
4044             _invlist_intersection(invlist, other, &invlist);
4045             break;
4046         default:
4047             break;
4048         }
4049         sv_free(other); /* through with it! */
4050     }
4051
4052     return invlist;
4053 }
4054
4055 SV*
4056 Perl__get_swash_invlist(pTHX_ SV* const swash)
4057 {
4058     SV** ptr;
4059
4060     PERL_ARGS_ASSERT__GET_SWASH_INVLIST;
4061
4062     if (! SvROK(swash)) {
4063         return NULL;
4064     }
4065
4066     /* If it really isn't a hash, it isn't really swash; must be an inversion
4067      * list */
4068     if (SvTYPE(SvRV(swash)) != SVt_PVHV) {
4069         return SvRV(swash);
4070     }
4071
4072     ptr = hv_fetchs(MUTABLE_HV(SvRV(swash)), "V", FALSE);
4073     if (! ptr) {
4074         return NULL;
4075     }
4076
4077     return *ptr;
4078 }
4079
4080 /*
4081 =for apidoc uvchr_to_utf8
4082
4083 Adds the UTF-8 representation of the Native code point C<uv> to the end
4084 of the string C<d>; C<d> should have at least C<UTF8_MAXBYTES+1> free
4085 bytes available. The return value is the pointer to the byte after the
4086 end of the new character. In other words,
4087
4088     d = uvchr_to_utf8(d, uv);
4089
4090 is the recommended wide native character-aware way of saying
4091
4092     *(d++) = uv;
4093
4094 =cut
4095 */
4096
4097 /* On ASCII machines this is normally a macro but we want a
4098    real function in case XS code wants it
4099 */
4100 U8 *
4101 Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv)
4102 {
4103     PERL_ARGS_ASSERT_UVCHR_TO_UTF8;
4104
4105     return Perl_uvuni_to_utf8_flags(aTHX_ d, NATIVE_TO_UNI(uv), 0);
4106 }
4107
4108 U8 *
4109 Perl_uvchr_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
4110 {
4111     PERL_ARGS_ASSERT_UVCHR_TO_UTF8_FLAGS;
4112
4113     return Perl_uvuni_to_utf8_flags(aTHX_ d, NATIVE_TO_UNI(uv), flags);
4114 }
4115
4116 /*
4117 =for apidoc utf8n_to_uvchr
4118
4119 Returns the native character value of the first character in the string
4120 C<s>
4121 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
4122 length, in bytes, of that character.
4123
4124 C<length> and C<flags> are the same as L</utf8n_to_uvuni>().
4125
4126 =cut
4127 */
4128 /* On ASCII machines this is normally a macro but we want
4129    a real function in case XS code wants it
4130 */
4131 UV
4132 Perl_utf8n_to_uvchr(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen,
4133 U32 flags)
4134 {
4135     const UV uv = Perl_utf8n_to_uvuni(aTHX_ s, curlen, retlen, flags);
4136
4137     PERL_ARGS_ASSERT_UTF8N_TO_UVCHR;
4138
4139     return UNI_TO_NATIVE(uv);
4140 }
4141
4142 bool
4143 Perl_check_utf8_print(pTHX_ register const U8* s, const STRLEN len)
4144 {
4145     /* May change: warns if surrogates, non-character code points, or
4146      * non-Unicode code points are in s which has length len bytes.  Returns
4147      * TRUE if none found; FALSE otherwise.  The only other validity check is
4148      * to make sure that this won't exceed the string's length */
4149
4150     const U8* const e = s + len;
4151     bool ok = TRUE;
4152
4153     PERL_ARGS_ASSERT_CHECK_UTF8_PRINT;
4154
4155     while (s < e) {
4156         if (UTF8SKIP(s) > len) {
4157             Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
4158                            "%s in %s", unees, PL_op ? OP_DESC(PL_op) : "print");
4159             return FALSE;
4160         }
4161         if (UNLIKELY(*s >= UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE)) {
4162             STRLEN char_len;
4163             if (UTF8_IS_SUPER(s)) {
4164                 if (ckWARN_d(WARN_NON_UNICODE)) {
4165                     UV uv = utf8_to_uvchr_buf(s, e, &char_len);
4166                     Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
4167                         "Code point 0x%04"UVXf" is not Unicode, may not be portable", uv);
4168                     ok = FALSE;
4169                 }
4170             }
4171             else if (UTF8_IS_SURROGATE(s)) {
4172                 if (ckWARN_d(WARN_SURROGATE)) {
4173                     UV uv = utf8_to_uvchr_buf(s, e, &char_len);
4174                     Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
4175                         "Unicode surrogate U+%04"UVXf" is illegal in UTF-8", uv);
4176                     ok = FALSE;
4177                 }
4178             }
4179             else if
4180                 ((UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s))
4181                  && (ckWARN_d(WARN_NONCHAR)))
4182             {
4183                 UV uv = utf8_to_uvchr_buf(s, e, &char_len);
4184                 Perl_warner(aTHX_ packWARN(WARN_NONCHAR),
4185                     "Unicode non-character U+%04"UVXf" is illegal for open interchange", uv);
4186                 ok = FALSE;
4187             }
4188         }
4189         s += UTF8SKIP(s);
4190     }
4191
4192     return ok;
4193 }
4194
4195 /*
4196 =for apidoc pv_uni_display
4197
4198 Build to the scalar C<dsv> a displayable version of the string C<spv>,
4199 length C<len>, the displayable version being at most C<pvlim> bytes long
4200 (if longer, the rest is truncated and "..." will be appended).
4201
4202 The C<flags> argument can have UNI_DISPLAY_ISPRINT set to display
4203 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4204 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4205 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4206 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4207 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4208
4209 The pointer to the PV of the C<dsv> is returned.
4210
4211 =cut */
4212 char *
4213 Perl_pv_uni_display(pTHX_ SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4214 {
4215     int truncated = 0;
4216     const char *s, *e;
4217
4218     PERL_ARGS_ASSERT_PV_UNI_DISPLAY;
4219
4220     sv_setpvs(dsv, "");
4221     SvUTF8_off(dsv);
4222     for (s = (const char *)spv, e = s + len; s < e; s += UTF8SKIP(s)) {
4223          UV u;
4224           /* This serves double duty as a flag and a character to print after
4225              a \ when flags & UNI_DISPLAY_BACKSLASH is true.
4226           */
4227          char ok = 0;
4228
4229          if (pvlim && SvCUR(dsv) >= pvlim) {
4230               truncated++;
4231               break;
4232          }
4233          u = utf8_to_uvchr_buf((U8*)s, (U8*)e, 0);
4234          if (u < 256) {
4235              const unsigned char c = (unsigned char)u & 0xFF;
4236              if (flags & UNI_DISPLAY_BACKSLASH) {
4237                  switch (c) {
4238                  case '\n':
4239                      ok = 'n'; break;
4240                  case '\r':
4241                      ok = 'r'; break;
4242                  case '\t':
4243                      ok = 't'; break;
4244                  case '\f':
4245                      ok = 'f'; break;
4246                  case '\a':
4247                      ok = 'a'; break;
4248                  case '\\':
4249                      ok = '\\'; break;
4250                  default: break;
4251                  }
4252                  if (ok) {
4253                      const char string = ok;
4254                      sv_catpvs(dsv, "\\");
4255                      sv_catpvn(dsv, &string, 1);
4256                  }
4257              }
4258              /* isPRINT() is the locale-blind version. */
4259              if (!ok && (flags & UNI_DISPLAY_ISPRINT) && isPRINT(c)) {
4260                  const char string = c;
4261                  sv_catpvn(dsv, &string, 1);
4262                  ok = 1;
4263              }
4264          }
4265          if (!ok)
4266              Perl_sv_catpvf(aTHX_ dsv, "\\x{%"UVxf"}", u);
4267     }
4268     if (truncated)
4269          sv_catpvs(dsv, "...");
4270
4271     return SvPVX(dsv);
4272 }
4273
4274 /*
4275 =for apidoc sv_uni_display
4276
4277 Build to the scalar C<dsv> a displayable version of the scalar C<sv>,
4278 the displayable version being at most C<pvlim> bytes long
4279 (if longer, the rest is truncated and "..." will be appended).
4280
4281 The C<flags> argument is as in L</pv_uni_display>().
4282
4283 The pointer to the PV of the C<dsv> is returned.
4284
4285 =cut
4286 */
4287 char *
4288 Perl_sv_uni_display(pTHX_ SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4289 {
4290     PERL_ARGS_ASSERT_SV_UNI_DISPLAY;
4291
4292      return Perl_pv_uni_display(aTHX_ dsv, (const U8*)SvPVX_const(ssv),
4293                                 SvCUR(ssv), pvlim, flags);
4294 }
4295
4296 /*
4297 =for apidoc foldEQ_utf8
4298
4299 Returns true if the leading portions of the strings C<s1> and C<s2> (either or both
4300 of which may be in UTF-8) are the same case-insensitively; false otherwise.
4301 How far into the strings to compare is determined by other input parameters.
4302
4303 If C<u1> is true, the string C<s1> is assumed to be in UTF-8-encoded Unicode;
4304 otherwise it is assumed to be in native 8-bit encoding.  Correspondingly for C<u2>
4305 with respect to C<s2>.
4306
4307 If the byte length C<l1> is non-zero, it says how far into C<s1> to check for fold
4308 equality.  In other words, C<s1>+C<l1> will be used as a goal to reach.  The
4309 scan will not be considered to be a match unless the goal is reached, and
4310 scanning won't continue past that goal.  Correspondingly for C<l2> with respect to
4311 C<s2>.
4312
4313 If C<pe1> is non-NULL and the pointer it points to is not NULL, that pointer is
4314 considered an end pointer to the position 1 byte past the maximum point
4315 in C<s1> beyond which scanning will not continue under any circumstances.
4316 (This routine assumes that UTF-8 encoded input strings are not malformed;
4317 malformed input can cause it to read past C<pe1>).
4318 This means that if both C<l1> and C<pe1> are specified, and C<pe1>
4319 is less than C<s1>+C<l1>, the match will never be successful because it can
4320 never
4321 get as far as its goal (and in fact is asserted against).  Correspondingly for
4322 C<pe2> with respect to C<s2>.
4323
4324 At least one of C<s1> and C<s2> must have a goal (at least one of C<l1> and
4325 C<l2> must be non-zero), and if both do, both have to be
4326 reached for a successful match.   Also, if the fold of a character is multiple
4327 characters, all of them must be matched (see tr21 reference below for
4328 'folding').
4329
4330 Upon a successful match, if C<pe1> is non-NULL,
4331 it will be set to point to the beginning of the I<next> character of C<s1>
4332 beyond what was matched.  Correspondingly for C<pe2> and C<s2>.
4333
4334 For case-insensitiveness, the "casefolding" of Unicode is used
4335 instead of upper/lowercasing both the characters, see
4336 L<http://www.unicode.org/unicode/reports/tr21/> (Case Mappings).
4337
4338 =cut */
4339
4340 /* A flags parameter has been added which may change, and hence isn't
4341  * externally documented.  Currently it is:
4342  *  0 for as-documented above
4343  *  FOLDEQ_UTF8_NOMIX_ASCII meaning that if a non-ASCII character folds to an
4344                             ASCII one, to not match
4345  *  FOLDEQ_UTF8_LOCALE      meaning that locale rules are to be used for code
4346  *                          points below 256; unicode rules for above 255; and
4347  *                          folds that cross those boundaries are disallowed,
4348  *                          like the NOMIX_ASCII option
4349  *  FOLDEQ_S1_ALREADY_FOLDED s1 has already been folded before calling this
4350  *                           routine.  This allows that step to be skipped.
4351  *  FOLDEQ_S2_ALREADY_FOLDED   Similarly.
4352  */
4353 I32
4354 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)
4355 {
4356     dVAR;
4357     const U8 *p1  = (const U8*)s1; /* Point to current char */
4358     const U8 *p2  = (const U8*)s2;
4359     const U8 *g1 = NULL;       /* goal for s1 */
4360     const U8 *g2 = NULL;
4361     const U8 *e1 = NULL;       /* Don't scan s1 past this */
4362     U8 *f1 = NULL;             /* Point to current folded */
4363     const U8 *e2 = NULL;
4364     U8 *f2 = NULL;
4365     STRLEN n1 = 0, n2 = 0;              /* Number of bytes in current char */
4366     U8 foldbuf1[UTF8_MAXBYTES_CASE+1];
4367     U8 foldbuf2[UTF8_MAXBYTES_CASE+1];
4368
4369     PERL_ARGS_ASSERT_FOLDEQ_UTF8_FLAGS;
4370
4371     /* The algorithm requires that input with the flags on the first line of
4372      * the assert not be pre-folded. */
4373     assert( ! ((flags & (FOLDEQ_UTF8_NOMIX_ASCII | FOLDEQ_UTF8_LOCALE))
4374         && (flags & (FOLDEQ_S1_ALREADY_FOLDED | FOLDEQ_S2_ALREADY_FOLDED))));
4375
4376     if (pe1) {
4377         e1 = *(U8**)pe1;
4378     }
4379
4380     if (l1) {
4381         g1 = (const U8*)s1 + l1;
4382     }
4383
4384     if (pe2) {
4385         e2 = *(U8**)pe2;
4386     }
4387
4388     if (l2) {
4389         g2 = (const U8*)s2 + l2;
4390     }
4391
4392     /* Must have at least one goal */
4393     assert(g1 || g2);
4394
4395     if (g1) {
4396
4397         /* Will never match if goal is out-of-bounds */
4398         assert(! e1  || e1 >= g1);
4399
4400         /* Here, there isn't an end pointer, or it is beyond the goal.  We
4401         * only go as far as the goal */
4402         e1 = g1;
4403     }
4404     else {
4405         assert(e1);    /* Must have an end for looking at s1 */
4406     }
4407
4408     /* Same for goal for s2 */
4409     if (g2) {
4410         assert(! e2  || e2 >= g2);
4411         e2 = g2;
4412     }
4413     else {
4414         assert(e2);
4415     }
4416
4417     /* If both operands are already folded, we could just do a memEQ on the
4418      * whole strings at once, but it would be better if the caller realized
4419      * this and didn't even call us */
4420
4421     /* Look through both strings, a character at a time */
4422     while (p1 < e1 && p2 < e2) {
4423
4424         /* If at the beginning of a new character in s1, get its fold to use
4425          * and the length of the fold.  (exception: locale rules just get the
4426          * character to a single byte) */
4427         if (n1 == 0) {
4428             if (flags & FOLDEQ_S1_ALREADY_FOLDED) {
4429                 f1 = (U8 *) p1;
4430                 n1 = UTF8SKIP(f1);
4431             }
4432             else {
4433                 /* If in locale matching, we use two sets of rules, depending
4434                  * on if the code point is above or below 255.  Here, we test
4435                  * for and handle locale rules */
4436                 if ((flags & FOLDEQ_UTF8_LOCALE)
4437                     && (! u1 || UTF8_IS_INVARIANT(*p1)
4438                         || UTF8_IS_DOWNGRADEABLE_START(*p1)))
4439                 {
4440                     /* There is no mixing of code points above and below 255. */
4441                     if (u2 && (! UTF8_IS_INVARIANT(*p2)
4442                         && ! UTF8_IS_DOWNGRADEABLE_START(*p2)))
4443                     {
4444                         return 0;
4445                     }
4446
4447                     /* We handle locale rules by converting, if necessary, the
4448                      * code point to a single byte. */
4449                     if (! u1 || UTF8_IS_INVARIANT(*p1)) {
4450                         *foldbuf1 = *p1;
4451                     }
4452                     else {
4453                         *foldbuf1 = TWO_BYTE_UTF8_TO_UNI(*p1, *(p1 + 1));
4454                     }
4455                     n1 = 1;
4456                 }
4457                 else if (isASCII(*p1)) {    /* Note, that here won't be both
4458                                                ASCII and using locale rules */
4459
4460                     /* If trying to mix non- with ASCII, and not supposed to,
4461                      * fail */
4462                     if ((flags & FOLDEQ_UTF8_NOMIX_ASCII) && ! isASCII(*p2)) {
4463                         return 0;
4464                     }
4465                     n1 = 1;
4466                     *foldbuf1 = toLOWER(*p1);   /* Folds in the ASCII range are
4467                                                    just lowercased */
4468                 }
4469                 else if (u1) {
4470                     to_utf8_fold(p1, foldbuf1, &n1);
4471                 }
4472                 else {  /* Not utf8, get utf8 fold */
4473                     to_uni_fold(NATIVE_TO_UNI(*p1), foldbuf1, &n1);
4474                 }
4475                 f1 = foldbuf1;
4476             }
4477         }
4478
4479         if (n2 == 0) {    /* Same for s2 */
4480             if (flags & FOLDEQ_S2_ALREADY_FOLDED) {
4481                 f2 = (U8 *) p2;
4482                 n2 = UTF8SKIP(f2);
4483             }
4484             else {
4485                 if ((flags & FOLDEQ_UTF8_LOCALE)
4486                     && (! u2 || UTF8_IS_INVARIANT(*p2) || UTF8_IS_DOWNGRADEABLE_START(*p2)))
4487                 {
4488                     /* Here, the next char in s2 is < 256.  We've already
4489                      * worked on s1, and if it isn't also < 256, can't match */
4490                     if (u1 && (! UTF8_IS_INVARIANT(*p1)
4491                         && ! UTF8_IS_DOWNGRADEABLE_START(*p1)))
4492                     {
4493                         return 0;
4494                     }
4495                     if (! u2 || UTF8_IS_INVARIANT(*p2)) {
4496                         *foldbuf2 = *p2;
4497                     }
4498                     else {
4499                         *foldbuf2 = TWO_BYTE_UTF8_TO_UNI(*p2, *(p2 + 1));
4500                     }
4501
4502                     /* Use another function to handle locale rules.  We've made
4503                      * sure that both characters to compare are single bytes */
4504                     if (! foldEQ_locale((char *) f1, (char *) foldbuf2, 1)) {
4505                         return 0;
4506                     }
4507                     n1 = n2 = 0;
4508                 }
4509                 else if (isASCII(*p2)) {
4510                     if ((flags & FOLDEQ_UTF8_NOMIX_ASCII) && ! isASCII(*p1)) {
4511                         return 0;
4512                     }
4513                     n2 = 1;
4514                     *foldbuf2 = toLOWER(*p2);
4515                 }
4516                 else if (u2) {
4517                     to_utf8_fold(p2, foldbuf2, &n2);
4518                 }
4519                 else {
4520                     to_uni_fold(NATIVE_TO_UNI(*p2), foldbuf2, &n2);
4521                 }
4522                 f2 = foldbuf2;
4523             }
4524         }
4525
4526         /* Here f1 and f2 point to the beginning of the strings to compare.
4527          * These strings are the folds of the next character from each input
4528          * string, stored in utf8. */
4529
4530         /* While there is more to look for in both folds, see if they
4531         * continue to match */
4532         while (n1 && n2) {
4533             U8 fold_length = UTF8SKIP(f1);
4534             if (fold_length != UTF8SKIP(f2)
4535                 || (fold_length == 1 && *f1 != *f2) /* Short circuit memNE
4536                                                        function call for single
4537                                                        byte */
4538                 || memNE((char*)f1, (char*)f2, fold_length))
4539             {
4540                 return 0; /* mismatch */
4541             }
4542
4543             /* Here, they matched, advance past them */
4544             n1 -= fold_length;
4545             f1 += fold_length;
4546             n2 -= fold_length;
4547             f2 += fold_length;
4548         }
4549
4550         /* When reach the end of any fold, advance the input past it */
4551         if (n1 == 0) {
4552             p1 += u1 ? UTF8SKIP(p1) : 1;
4553         }
4554         if (n2 == 0) {
4555             p2 += u2 ? UTF8SKIP(p2) : 1;
4556         }
4557     } /* End of loop through both strings */
4558
4559     /* A match is defined by each scan that specified an explicit length
4560     * reaching its final goal, and the other not having matched a partial
4561     * character (which can happen when the fold of a character is more than one
4562     * character). */
4563     if (! ((g1 == 0 || p1 == g1) && (g2 == 0 || p2 == g2)) || n1 || n2) {
4564         return 0;
4565     }
4566
4567     /* Successful match.  Set output pointers */
4568     if (pe1) {
4569         *pe1 = (char*)p1;
4570     }
4571     if (pe2) {
4572         *pe2 = (char*)p2;
4573     }
4574     return 1;
4575 }
4576
4577 /*
4578  * Local variables:
4579  * c-indentation-style: bsd
4580  * c-basic-offset: 4
4581  * indent-tabs-mode: nil
4582  * End:
4583  *
4584  * ex: set ts=8 sts=4 sw=4 et:
4585  */