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