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