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