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