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