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