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