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