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