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