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