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