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