This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
c8bdc7a3082ceefaae1ce8162c088e8e3adeca7b
[perl5.git] / utf8.c
1 /*    utf8.c
2  *
3  *    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
4  *    by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /*
12  * 'What a fix!' said Sam.  'That's the one place in all the lands we've ever
13  *  heard of that we don't want to see any closer; and that's the one place
14  *  we're trying to get to!  And that's just where we can't get, nohow.'
15  *
16  *     [p.603 of _The Lord of the Rings_, IV/I: "The Taming of Sméagol"]
17  *
18  * 'Well do I understand your speech,' he answered in the same language;
19  * 'yet few strangers do so.  Why then do you not speak in the Common Tongue,
20  *  as is the custom in the West, if you wish to be answered?'
21  *                           --Gandalf, addressing Théoden's door wardens
22  *
23  *     [p.508 of _The Lord of the Rings_, III/vi: "The King of the Golden Hall"]
24  *
25  * ...the travellers perceived that the floor was paved with stones of many
26  * hues; branching runes and strange devices intertwined beneath their feet.
27  *
28  *     [p.512 of _The Lord of the Rings_, III/vi: "The King of the Golden Hall"]
29  */
30
31 #include "EXTERN.h"
32 #define PERL_IN_UTF8_C
33 #include "perl.h"
34
35 #ifndef EBCDIC
36 /* Separate prototypes needed because in ASCII systems these are
37  * usually macros but they still are compiled as code, too. */
38 PERL_CALLCONV UV        Perl_utf8n_to_uvchr(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags);
39 PERL_CALLCONV U8*       Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv);
40 #endif
41
42 static const char unees[] =
43     "Malformed UTF-8 character (unexpected end of string)";
44
45 /*
46 =head1 Unicode Support
47
48 This file contains various utility functions for manipulating UTF8-encoded
49 strings. For the uninitiated, this is a method of representing arbitrary
50 Unicode characters as a variable number of bytes, in such a way that
51 characters in the ASCII range are unmodified, and a zero byte never appears
52 within non-zero characters.
53
54 =cut
55 */
56
57 /*
58 =for apidoc is_ascii_string
59
60 Returns true if the first C<len> bytes of the given string are the same whether
61 or not the string is encoded in UTF-8 (or UTF-EBCDIC on EBCDIC machines).  That
62 is, if they are invariant.  On ASCII-ish machines, only ASCII characters
63 fit this definition, hence the function's name.
64
65 If C<len> is 0, it will be calculated using C<strlen(s)>.  
66
67 See also is_utf8_string(), is_utf8_string_loclen(), and is_utf8_string_loc().
68
69 =cut
70 */
71
72 bool
73 Perl_is_ascii_string(const U8 *s, STRLEN len)
74 {
75     const U8* const send = s + (len ? len : strlen((const char *)s));
76     const U8* x = s;
77
78     PERL_ARGS_ASSERT_IS_ASCII_STRING;
79
80     for (; x < send; ++x) {
81         if (!UTF8_IS_INVARIANT(*x))
82             break;
83     }
84
85     return x == send;
86 }
87
88 /*
89 =for apidoc uvuni_to_utf8_flags
90
91 Adds the UTF-8 representation of the code point C<uv> to the end
92 of the string C<d>; C<d> should have at least C<UTF8_MAXBYTES+1> free
93 bytes available. The return value is the pointer to the byte after the
94 end of the new character. In other words,
95
96     d = uvuni_to_utf8_flags(d, uv, flags);
97
98 or, in most cases,
99
100     d = uvuni_to_utf8(d, uv);
101
102 (which is equivalent to)
103
104     d = uvuni_to_utf8_flags(d, uv, 0);
105
106 This is the recommended Unicode-aware way of saying
107
108     *(d++) = uv;
109
110 This function will convert to UTF-8 (and not warn) even code points that aren't
111 legal Unicode or are problematic, unless C<flags> contains one or more of the
112 following flags.
113 If C<uv> is a Unicode surrogate code point and UNICODE_WARN_SURROGATE is set,
114 the function will raise a warning, provided UTF8 warnings are enabled.  If instead
115 UNICODE_DISALLOW_SURROGATE is set, the function will fail and return NULL.
116 If both flags are set, the function will both warn and return NULL.
117
118 The UNICODE_WARN_NONCHAR and UNICODE_DISALLOW_NONCHAR flags correspondingly
119 affect how the function handles a Unicode non-character.  And, likewise for the
120 UNICODE_WARN_SUPER and UNICODE_DISALLOW_SUPER flags, and code points that are
121 above the Unicode maximum of 0x10FFFF.  Code points above 0x7FFF_FFFF (which are
122 even less portable) can be warned and/or disallowed even if other above-Unicode
123 code points are accepted by the UNICODE_WARN_FE_FF and UNICODE_DISALLOW_FE_FF
124 flags.
125
126 And finally, the flag UNICODE_WARN_ILLEGAL_INTERCHANGE selects all four of the
127 above WARN flags; and UNICODE_DISALLOW_ILLEGAL_INTERCHANGE selects all four
128 DISALLOW flags.
129
130
131 =cut
132 */
133
134 U8 *
135 Perl_uvuni_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
136 {
137     PERL_ARGS_ASSERT_UVUNI_TO_UTF8_FLAGS;
138
139     if (ckWARN_d(WARN_UTF8)) {
140         if (UNICODE_IS_SURROGATE(uv)) {
141             if (flags & UNICODE_WARN_SURROGATE) {
142                 Perl_ck_warner_d(aTHX_ packWARN(WARN_SURROGATE),
143                                             "UTF-16 surrogate U+%04"UVXf, uv);
144             }
145             if (flags & UNICODE_DISALLOW_SURROGATE) {
146                 return NULL;
147             }
148         }
149         else if (UNICODE_IS_SUPER(uv)) {
150             if (flags & UNICODE_WARN_SUPER
151                 || (UNICODE_IS_FE_FF(uv) && (flags & UNICODE_WARN_FE_FF)))
152             {
153                 Perl_ck_warner_d(aTHX_ packWARN(WARN_NON_UNICODE),
154                           "Code point 0x%04"UVXf" is not Unicode, may not be portable", uv);
155             }
156             if (flags & UNICODE_DISALLOW_SUPER
157                 || (UNICODE_IS_FE_FF(uv) && (flags & UNICODE_DISALLOW_FE_FF)))
158             {
159                 return NULL;
160             }
161         }
162         else if (UNICODE_IS_NONCHAR(uv)) {
163             if (flags & UNICODE_WARN_NONCHAR) {
164                 Perl_ck_warner_d(aTHX_ packWARN(WARN_NONCHAR),
165                  "Unicode non-character U+%04"UVXf" is illegal for open interchange",
166                  uv);
167             }
168             if (flags & UNICODE_DISALLOW_NONCHAR) {
169                 return NULL;
170             }
171         }
172     }
173     if (UNI_IS_INVARIANT(uv)) {
174         *d++ = (U8)UTF_TO_NATIVE(uv);
175         return d;
176     }
177 #if defined(EBCDIC)
178     else {
179         STRLEN len  = UNISKIP(uv);
180         U8 *p = d+len-1;
181         while (p > d) {
182             *p-- = (U8)UTF_TO_NATIVE((uv & UTF_CONTINUATION_MASK) | UTF_CONTINUATION_MARK);
183             uv >>= UTF_ACCUMULATION_SHIFT;
184         }
185         *p = (U8)UTF_TO_NATIVE((uv & UTF_START_MASK(len)) | UTF_START_MARK(len));
186         return d+len;
187     }
188 #else /* Non loop style */
189     if (uv < 0x800) {
190         *d++ = (U8)(( uv >>  6)         | 0xc0);
191         *d++ = (U8)(( uv        & 0x3f) | 0x80);
192         return d;
193     }
194     if (uv < 0x10000) {
195         *d++ = (U8)(( uv >> 12)         | 0xe0);
196         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
197         *d++ = (U8)(( uv        & 0x3f) | 0x80);
198         return d;
199     }
200     if (uv < 0x200000) {
201         *d++ = (U8)(( uv >> 18)         | 0xf0);
202         *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
203         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
204         *d++ = (U8)(( uv        & 0x3f) | 0x80);
205         return d;
206     }
207     if (uv < 0x4000000) {
208         *d++ = (U8)(( uv >> 24)         | 0xf8);
209         *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
210         *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
211         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
212         *d++ = (U8)(( uv        & 0x3f) | 0x80);
213         return d;
214     }
215     if (uv < 0x80000000) {
216         *d++ = (U8)(( uv >> 30)         | 0xfc);
217         *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
218         *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
219         *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
220         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
221         *d++ = (U8)(( uv        & 0x3f) | 0x80);
222         return d;
223     }
224 #ifdef HAS_QUAD
225     if (uv < UTF8_QUAD_MAX)
226 #endif
227     {
228         *d++ =                            0xfe; /* Can't match U+FEFF! */
229         *d++ = (U8)(((uv >> 30) & 0x3f) | 0x80);
230         *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
231         *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
232         *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
233         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
234         *d++ = (U8)(( uv        & 0x3f) | 0x80);
235         return d;
236     }
237 #ifdef HAS_QUAD
238     {
239         *d++ =                            0xff;         /* Can't match U+FFFE! */
240         *d++ =                            0x80;         /* 6 Reserved bits */
241         *d++ = (U8)(((uv >> 60) & 0x0f) | 0x80);        /* 2 Reserved bits */
242         *d++ = (U8)(((uv >> 54) & 0x3f) | 0x80);
243         *d++ = (U8)(((uv >> 48) & 0x3f) | 0x80);
244         *d++ = (U8)(((uv >> 42) & 0x3f) | 0x80);
245         *d++ = (U8)(((uv >> 36) & 0x3f) | 0x80);
246         *d++ = (U8)(((uv >> 30) & 0x3f) | 0x80);
247         *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
248         *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
249         *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
250         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
251         *d++ = (U8)(( uv        & 0x3f) | 0x80);
252         return d;
253     }
254 #endif
255 #endif /* Loop style */
256 }
257
258 /*
259
260 Tests if some arbitrary number of bytes begins in a valid UTF-8
261 character.  Note that an INVARIANT (i.e. ASCII) character is a valid
262 UTF-8 character.  The actual number of bytes in the UTF-8 character
263 will be returned if it is valid, otherwise 0.
264
265 This is the "slow" version as opposed to the "fast" version which is
266 the "unrolled" IS_UTF8_CHAR().  E.g. for t/uni/class.t the speed
267 difference is a factor of 2 to 3.  For lengths (UTF8SKIP(s)) of four
268 or less you should use the IS_UTF8_CHAR(), for lengths of five or more
269 you should use the _slow().  In practice this means that the _slow()
270 will be used very rarely, since the maximum Unicode code point (as of
271 Unicode 4.1) is U+10FFFF, which encodes in UTF-8 to four bytes.  Only
272 the "Perl extended UTF-8" (the infamous 'v-strings') will encode into
273 five bytes or more.
274
275 =cut */
276 STATIC STRLEN
277 S_is_utf8_char_slow(const U8 *s, const STRLEN len)
278 {
279     U8 u = *s;
280     STRLEN slen;
281     UV uv, ouv;
282
283     PERL_ARGS_ASSERT_IS_UTF8_CHAR_SLOW;
284
285     if (UTF8_IS_INVARIANT(u))
286         return 1;
287
288     if (!UTF8_IS_START(u))
289         return 0;
290
291     if (len < 2 || !UTF8_IS_CONTINUATION(s[1]))
292         return 0;
293
294     slen = len - 1;
295     s++;
296 #ifdef EBCDIC
297     u = NATIVE_TO_UTF(u);
298 #endif
299     u &= UTF_START_MASK(len);
300     uv  = u;
301     ouv = uv;
302     while (slen--) {
303         if (!UTF8_IS_CONTINUATION(*s))
304             return 0;
305         uv = UTF8_ACCUMULATE(uv, *s);
306         if (uv < ouv)
307             return 0;
308         ouv = uv;
309         s++;
310     }
311
312     if ((STRLEN)UNISKIP(uv) < len)
313         return 0;
314
315     return len;
316 }
317
318 /*
319 =for apidoc is_utf8_char
320
321 Tests if some arbitrary number of bytes begins in a valid UTF-8
322 character.  Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
323 character is a valid UTF-8 character.  The actual number of bytes in the UTF-8
324 character will be returned if it is valid, otherwise 0.
325
326 =cut */
327 STRLEN
328 Perl_is_utf8_char(const U8 *s)
329 {
330     const STRLEN len = UTF8SKIP(s);
331
332     PERL_ARGS_ASSERT_IS_UTF8_CHAR;
333 #ifdef IS_UTF8_CHAR
334     if (IS_UTF8_CHAR_FAST(len))
335         return IS_UTF8_CHAR(s, len) ? len : 0;
336 #endif /* #ifdef IS_UTF8_CHAR */
337     return is_utf8_char_slow(s, len);
338 }
339
340
341 /*
342 =for apidoc is_utf8_string
343
344 Returns true if first C<len> bytes of the given string form a valid
345 UTF-8 string, false otherwise.  If C<len> is 0, it will be calculated
346 using C<strlen(s)>.  Note that 'a valid UTF-8 string' does not mean 'a
347 string that contains code points above 0x7F encoded in UTF-8' because a
348 valid ASCII string is a valid UTF-8 string.
349
350 See also is_ascii_string(), is_utf8_string_loclen(), and is_utf8_string_loc().
351
352 =cut
353 */
354
355 bool
356 Perl_is_utf8_string(const U8 *s, STRLEN len)
357 {
358     const U8* const send = s + (len ? len : strlen((const char *)s));
359     const U8* x = s;
360
361     PERL_ARGS_ASSERT_IS_UTF8_STRING;
362
363     while (x < send) {
364         STRLEN c;
365          /* Inline the easy bits of is_utf8_char() here for speed... */
366          if (UTF8_IS_INVARIANT(*x))
367               c = 1;
368          else if (!UTF8_IS_START(*x))
369              goto out;
370          else {
371               /* ... and call is_utf8_char() only if really needed. */
372 #ifdef IS_UTF8_CHAR
373              c = UTF8SKIP(x);
374              if (IS_UTF8_CHAR_FAST(c)) {
375                  if (!IS_UTF8_CHAR(x, c))
376                      c = 0;
377              }
378              else
379                 c = is_utf8_char_slow(x, c);
380 #else
381              c = is_utf8_char(x);
382 #endif /* #ifdef IS_UTF8_CHAR */
383               if (!c)
384                   goto out;
385          }
386         x += c;
387     }
388
389  out:
390     if (x != send)
391         return FALSE;
392
393     return TRUE;
394 }
395
396 /*
397 Implemented as a macro in utf8.h
398
399 =for apidoc is_utf8_string_loc
400
401 Like is_utf8_string() but stores the location of the failure (in the
402 case of "utf8ness failure") or the location s+len (in the case of
403 "utf8ness success") in the C<ep>.
404
405 See also is_utf8_string_loclen() and is_utf8_string().
406
407 =for apidoc is_utf8_string_loclen
408
409 Like is_utf8_string() but stores the location of the failure (in the
410 case of "utf8ness failure") or the location s+len (in the case of
411 "utf8ness success") in the C<ep>, and the number of UTF-8
412 encoded characters in the C<el>.
413
414 See also is_utf8_string_loc() and is_utf8_string().
415
416 =cut
417 */
418
419 bool
420 Perl_is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
421 {
422     const U8* const send = s + (len ? len : strlen((const char *)s));
423     const U8* x = s;
424     STRLEN c;
425     STRLEN outlen = 0;
426
427     PERL_ARGS_ASSERT_IS_UTF8_STRING_LOCLEN;
428
429     while (x < send) {
430          /* Inline the easy bits of is_utf8_char() here for speed... */
431          if (UTF8_IS_INVARIANT(*x))
432              c = 1;
433          else if (!UTF8_IS_START(*x))
434              goto out;
435          else {
436              /* ... and call is_utf8_char() only if really needed. */
437 #ifdef IS_UTF8_CHAR
438              c = UTF8SKIP(x);
439              if (IS_UTF8_CHAR_FAST(c)) {
440                  if (!IS_UTF8_CHAR(x, c))
441                      c = 0;
442              } else
443                  c = is_utf8_char_slow(x, c);
444 #else
445              c = is_utf8_char(x);
446 #endif /* #ifdef IS_UTF8_CHAR */
447              if (!c)
448                  goto out;
449          }
450          x += c;
451          outlen++;
452     }
453
454  out:
455     if (el)
456         *el = outlen;
457
458     if (ep)
459         *ep = x;
460     return (x == send);
461 }
462
463 /*
464
465 =for apidoc utf8n_to_uvuni
466
467 Bottom level UTF-8 decode routine.
468 Returns the code point value of the first character in the string C<s>
469 which is assumed to be in UTF-8 (or UTF-EBCDIC) encoding and no longer than
470 C<curlen> bytes; C<retlen> will be set to the length, in bytes, of that
471 character.
472
473 The value of C<flags> determines the behavior when C<s> does not point to a
474 well-formed UTF-8 character.  If C<flags> is 0, when a malformation is found,
475 C<retlen> is set to the expected length of the UTF-8 character in bytes, zero
476 is returned, and if UTF-8 warnings haven't been lexically disabled, a warning
477 is raised.
478
479 Various ALLOW flags can be set in C<flags> to allow (and not warn on)
480 individual types of malformations, such as the sequence being overlong (that
481 is, when there is a shorter sequence that can express the same code point;
482 overlong sequences are expressly forbidden in the UTF-8 standard due to
483 potential security issues).  Another malformation example is the first byte of
484 a character not being a legal first byte.  See F<utf8.h> for the list of such
485 flags.  Of course, the value returned by this function under such conditions is
486 not reliable.
487
488 The UTF8_CHECK_ONLY flag overrides the behavior when a non-allowed (by other
489 flags) malformation is found.  If this flag is set, the routine assumes that
490 the caller will raise a warning, and this function will silently just set
491 C<retlen> to C<-1> and return zero.
492
493 Certain code points are considered problematic.  These are Unicode surrogates,
494 Unicode non-characters, and code points above the Unicode maximum of 0x10FFF.
495 By default these are considered regular code points, but certain situations
496 warrant special handling for them.  if C<flags> contains
497 UTF8_DISALLOW_ILLEGAL_INTERCHANGE, all three classes are treated as
498 malformations and handled as such.  The flags UTF8_DISALLOW_SURROGATE,
499 UTF8_DISALLOW_NONCHAR, and UTF8_DISALLOW_SUPER (meaning above the legal Unicode
500 maximum) can be set to disallow these categories individually.
501
502 The flags UTF8_WARN_ILLEGAL_INTERCHANGE, UTF8_WARN_SURROGATE,
503 UTF8_WARN_NONCHAR, and UTF8_WARN_SUPER will cause warning messages to be raised
504 for their respective categories, but otherwise the code points are considered
505 valid (not malformations).  To get a category to both be treated as a
506 malformation and raise a warning, specify both the WARN and DISALLOW flags.
507 (But note that warnings are not raised if lexically disabled nor if
508 UTF8_CHECK_ONLY is also specified.)
509
510 Very large code points (above 0x7FFF_FFFF) are considered more problematic than
511 the others that are above the Unicode legal maximum.  There are several
512 reasons, one of which is that the original UTF-8 specification never went above
513 this number (the current 0x10FFF limit was imposed later).  The UTF-8 encoding
514 on ASCII platforms for these large code point begins with a byte containing
515 0xFE or 0xFF.  The UTF8_DISALLOW_FE_FF flag will cause them to be treated as
516 malformations, while allowing smaller above-Unicode code points.  (Of course
517 UTF8_DISALLOW_SUPER will treat all above-Unicode code points, including these,
518 as malformations.) Similarly, UTF8_WARN_FE_FF acts just like the other WARN
519 flags, but applies just to these code points.
520
521 All other code points corresponding to Unicode characters, including private
522 use and those yet to be assigned, are never considered malformed and never
523 warn.
524
525 Most code should use utf8_to_uvchr() rather than call this directly.
526
527 =cut
528 */
529
530 UV
531 Perl_utf8n_to_uvuni(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
532 {
533     dVAR;
534     const U8 * const s0 = s;
535     UV uv = *s, ouv = 0;
536     STRLEN len = 1;
537     bool dowarn = ckWARN_d(WARN_UTF8);
538     const UV startbyte = *s;
539     STRLEN expectlen = 0;
540     U32 warning = 0;
541     SV* sv = NULL;
542
543     PERL_ARGS_ASSERT_UTF8N_TO_UVUNI;
544
545 /* This list is a superset of the UTF8_ALLOW_XXX. */
546
547 #define UTF8_WARN_EMPTY                          1
548 #define UTF8_WARN_CONTINUATION                   2
549 #define UTF8_WARN_NON_CONTINUATION               3
550 #define UTF8_WARN_SHORT                          4
551 #define UTF8_WARN_OVERFLOW                       5
552 #define UTF8_WARN_LONG                           6
553
554     if (curlen == 0 &&
555         !(flags & UTF8_ALLOW_EMPTY)) {
556         warning = UTF8_WARN_EMPTY;
557         goto malformed;
558     }
559
560     if (UTF8_IS_INVARIANT(uv)) {
561         if (retlen)
562             *retlen = 1;
563         return (UV) (NATIVE_TO_UTF(*s));
564     }
565
566     if (UTF8_IS_CONTINUATION(uv) &&
567         !(flags & UTF8_ALLOW_CONTINUATION)) {
568         warning = UTF8_WARN_CONTINUATION;
569         goto malformed;
570     }
571
572     if (UTF8_IS_START(uv) && curlen > 1 && !UTF8_IS_CONTINUATION(s[1]) &&
573         !(flags & UTF8_ALLOW_NON_CONTINUATION)) {
574         warning = UTF8_WARN_NON_CONTINUATION;
575         goto malformed;
576     }
577
578 #ifdef EBCDIC
579     uv = NATIVE_TO_UTF(uv);
580 #else
581     if (uv == 0xfe || uv == 0xff) {
582         if (flags & (UTF8_WARN_SUPER|UTF8_WARN_FE_FF)) {
583             sv = sv_2mortal(Perl_newSVpvf(aTHX_ "Code point beginning with byte 0x%02"UVXf" is not Unicode, and not portable", uv));
584             flags &= ~UTF8_WARN_SUPER;  /* Only warn once on this problem */
585         }
586         if (flags & (UTF8_DISALLOW_SUPER|UTF8_DISALLOW_FE_FF)) {
587             goto malformed;
588         }
589     }
590 #endif
591
592     if      (!(uv & 0x20))      { len =  2; uv &= 0x1f; }
593     else if (!(uv & 0x10))      { len =  3; uv &= 0x0f; }
594     else if (!(uv & 0x08))      { len =  4; uv &= 0x07; }
595     else if (!(uv & 0x04))      { len =  5; uv &= 0x03; }
596 #ifdef EBCDIC
597     else if (!(uv & 0x02))      { len =  6; uv &= 0x01; }
598     else                        { len =  7; uv &= 0x01; }
599 #else
600     else if (!(uv & 0x02))      { len =  6; uv &= 0x01; }
601     else if (!(uv & 0x01))      { len =  7; uv = 0; }
602     else                        { len = 13; uv = 0; } /* whoa! */
603 #endif
604
605     if (retlen)
606         *retlen = len;
607
608     expectlen = len;
609
610     if ((curlen < expectlen) &&
611         !(flags & UTF8_ALLOW_SHORT)) {
612         warning = UTF8_WARN_SHORT;
613         goto malformed;
614     }
615
616     len--;
617     s++;
618     ouv = uv;   /* ouv is the value from the previous iteration */
619
620     while (len--) {
621         if (!UTF8_IS_CONTINUATION(*s) &&
622             !(flags & UTF8_ALLOW_NON_CONTINUATION)) {
623             s--;
624             warning = UTF8_WARN_NON_CONTINUATION;
625             goto malformed;
626         }
627         else
628             uv = UTF8_ACCUMULATE(uv, *s);
629         if (!(uv > ouv)) {  /* If the value didn't grow from the previous
630                                iteration, something is horribly wrong */
631             /* These cannot be allowed. */
632             if (uv == ouv) {
633                 if (expectlen != 13 && !(flags & UTF8_ALLOW_LONG)) {
634                     warning = UTF8_WARN_LONG;
635                     goto malformed;
636                 }
637             }
638             else { /* uv < ouv */
639                 /* This cannot be allowed. */
640                 warning = UTF8_WARN_OVERFLOW;
641                 goto malformed;
642             }
643         }
644         s++;
645         ouv = uv;
646     }
647
648     if ((expectlen > (STRLEN)UNISKIP(uv)) && !(flags & UTF8_ALLOW_LONG)) {
649         warning = UTF8_WARN_LONG;
650         goto malformed;
651     } else if (flags & (UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE)) {
652         if (UNICODE_IS_SURROGATE(uv)) {
653             if ((flags & (UTF8_WARN_SURROGATE|UTF8_CHECK_ONLY)) == UTF8_WARN_SURROGATE) {
654                 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "UTF-16 surrogate U+%04"UVXf"", uv));
655             }
656             if (flags & UTF8_DISALLOW_SURROGATE) {
657                 goto disallowed;
658             }
659         }
660         else if (UNICODE_IS_NONCHAR(uv)) {
661             if ((flags & (UTF8_WARN_NONCHAR|UTF8_CHECK_ONLY)) == UTF8_WARN_NONCHAR ) {
662                 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "Unicode non-character U+%04"UVXf" is illegal for open interchange", uv));
663             }
664             if (flags & UTF8_DISALLOW_NONCHAR) {
665                 goto disallowed;
666             }
667         }
668         else if ((uv > PERL_UNICODE_MAX)) {
669             if ((flags & (UTF8_WARN_SUPER|UTF8_CHECK_ONLY)) == UTF8_WARN_SUPER) {
670                 sv = sv_2mortal(Perl_newSVpvf(aTHX_ "Code point 0x%04"UVXf" is not Unicode, may not be portable", uv));
671             }
672             if (flags & UTF8_DISALLOW_SUPER) {
673                 goto disallowed;
674             }
675         }
676
677         /* Here, this is not considered a malformed character, so drop through
678          * to return it */
679     }
680
681     return uv;
682
683 disallowed: /* Is disallowed, but otherwise not malformed.  'sv' will have been
684                set if there is to be a warning. */
685     if (!sv) {
686         dowarn = 0;
687     }
688
689 malformed:
690
691     if (flags & UTF8_CHECK_ONLY) {
692         if (retlen)
693             *retlen = ((STRLEN) -1);
694         return 0;
695     }
696
697     if (dowarn) {
698         if (! sv) {
699             sv = newSVpvs_flags("Malformed UTF-8 character ", SVs_TEMP);
700         }
701
702         switch (warning) {
703             case 0: /* Intentionally empty. */ break;
704             case UTF8_WARN_EMPTY:
705                 sv_catpvs(sv, "(empty string)");
706                 break;
707             case UTF8_WARN_CONTINUATION:
708                 Perl_sv_catpvf(aTHX_ sv, "(unexpected continuation byte 0x%02"UVxf", with no preceding start byte)", uv);
709                 break;
710             case UTF8_WARN_NON_CONTINUATION:
711                 if (s == s0)
712                     Perl_sv_catpvf(aTHX_ sv, "(unexpected non-continuation byte 0x%02"UVxf", immediately after start byte 0x%02"UVxf")",
713                                 (UV)s[1], startbyte);
714                 else {
715                     const int len = (int)(s-s0);
716                     Perl_sv_catpvf(aTHX_ sv, "(unexpected non-continuation byte 0x%02"UVxf", %d byte%s after start byte 0x%02"UVxf", expected %d bytes)",
717                                 (UV)s[1], len, len > 1 ? "s" : "", startbyte, (int)expectlen);
718                 }
719
720                 break;
721             case UTF8_WARN_SHORT:
722                 Perl_sv_catpvf(aTHX_ sv, "(%d byte%s, need %d, after start byte 0x%02"UVxf")",
723                                 (int)curlen, curlen == 1 ? "" : "s", (int)expectlen, startbyte);
724                 expectlen = curlen;             /* distance for caller to skip */
725                 break;
726             case UTF8_WARN_OVERFLOW:
727                 Perl_sv_catpvf(aTHX_ sv, "(overflow at 0x%"UVxf", byte 0x%02x, after start byte 0x%02"UVxf")",
728                                 ouv, *s, startbyte);
729                 break;
730             case UTF8_WARN_LONG:
731                 Perl_sv_catpvf(aTHX_ sv, "(%d byte%s, need %d, after start byte 0x%02"UVxf")",
732                                 (int)expectlen, expectlen == 1 ? "": "s", UNISKIP(uv), startbyte);
733                 break;
734             default:
735                 sv_catpvs(sv, "(unknown reason)");
736                 break;
737         }
738         
739         if (sv) {
740             const char * const s = SvPVX_const(sv);
741
742             if (PL_op)
743                 Perl_warner(aTHX_ packWARN(WARN_UTF8),
744                             "%s in %s", s,  OP_DESC(PL_op));
745             else
746                 Perl_warner(aTHX_ packWARN(WARN_UTF8), "%s", s);
747         }
748     }
749
750     if (retlen)
751         *retlen = expectlen ? expectlen : len;
752
753     return 0;
754 }
755
756 /*
757 =for apidoc utf8_to_uvchr
758
759 Returns the native code point of the first character in the string C<s>
760 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
761 length, in bytes, of that character.
762
763 If C<s> does not point to a well-formed UTF-8 character, zero is
764 returned and retlen is set, if possible, to -1.
765
766 =cut
767 */
768
769
770 UV
771 Perl_utf8_to_uvchr(pTHX_ const U8 *s, STRLEN *retlen)
772 {
773     PERL_ARGS_ASSERT_UTF8_TO_UVCHR;
774
775     return utf8n_to_uvchr(s, UTF8_MAXBYTES, retlen,
776                           ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY);
777 }
778
779 /*
780 =for apidoc utf8_to_uvuni
781
782 Returns the Unicode code point of the first character in the string C<s>
783 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
784 length, in bytes, of that character.
785
786 This function should only be used when the returned UV is considered
787 an index into the Unicode semantic tables (e.g. swashes).
788
789 If C<s> does not point to a well-formed UTF-8 character, zero is
790 returned and retlen is set, if possible, to -1.
791
792 =cut
793 */
794
795 UV
796 Perl_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
797 {
798     PERL_ARGS_ASSERT_UTF8_TO_UVUNI;
799
800     /* Call the low level routine asking for checks */
801     return Perl_utf8n_to_uvuni(aTHX_ s, UTF8_MAXBYTES, retlen,
802                                ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY);
803 }
804
805 /*
806 =for apidoc utf8_length
807
808 Return the length of the UTF-8 char encoded string C<s> in characters.
809 Stops at C<e> (inclusive).  If C<e E<lt> s> or if the scan would end
810 up past C<e>, croaks.
811
812 =cut
813 */
814
815 STRLEN
816 Perl_utf8_length(pTHX_ const U8 *s, const U8 *e)
817 {
818     dVAR;
819     STRLEN len = 0;
820
821     PERL_ARGS_ASSERT_UTF8_LENGTH;
822
823     /* Note: cannot use UTF8_IS_...() too eagerly here since e.g.
824      * the bitops (especially ~) can create illegal UTF-8.
825      * In other words: in Perl UTF-8 is not just for Unicode. */
826
827     if (e < s)
828         goto warn_and_return;
829     while (s < e) {
830         if (!UTF8_IS_INVARIANT(*s))
831             s += UTF8SKIP(s);
832         else
833             s++;
834         len++;
835     }
836
837     if (e != s) {
838         len--;
839         warn_and_return:
840         if (PL_op)
841             Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
842                              "%s in %s", unees, OP_DESC(PL_op));
843         else
844             Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8), "%s", unees);
845     }
846
847     return len;
848 }
849
850 /*
851 =for apidoc utf8_distance
852
853 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
854 and C<b>.
855
856 WARNING: use only if you *know* that the pointers point inside the
857 same UTF-8 buffer.
858
859 =cut
860 */
861
862 IV
863 Perl_utf8_distance(pTHX_ const U8 *a, const U8 *b)
864 {
865     PERL_ARGS_ASSERT_UTF8_DISTANCE;
866
867     return (a < b) ? -1 * (IV) utf8_length(a, b) : (IV) utf8_length(b, a);
868 }
869
870 /*
871 =for apidoc utf8_hop
872
873 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
874 forward or backward.
875
876 WARNING: do not use the following unless you *know* C<off> is within
877 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
878 on the first byte of character or just after the last byte of a character.
879
880 =cut
881 */
882
883 U8 *
884 Perl_utf8_hop(pTHX_ const U8 *s, I32 off)
885 {
886     PERL_ARGS_ASSERT_UTF8_HOP;
887
888     PERL_UNUSED_CONTEXT;
889     /* Note: cannot use UTF8_IS_...() too eagerly here since e.g
890      * the bitops (especially ~) can create illegal UTF-8.
891      * In other words: in Perl UTF-8 is not just for Unicode. */
892
893     if (off >= 0) {
894         while (off--)
895             s += UTF8SKIP(s);
896     }
897     else {
898         while (off++) {
899             s--;
900             while (UTF8_IS_CONTINUATION(*s))
901                 s--;
902         }
903     }
904     return (U8 *)s;
905 }
906
907 /*
908 =for apidoc bytes_cmp_utf8
909
910 Compares the sequence of characters (stored as octets) in b, blen with the
911 sequence of characters (stored as UTF-8) in u, ulen. Returns 0 if they are
912 equal, -1 or -2 if the first string is less than the second string, +1 or +2
913 if the first string is greater than the second string.
914
915 -1 or +1 is returned if the shorter string was identical to the start of the
916 longer string. -2 or +2 is returned if the was a difference between characters
917 within the strings.
918
919 =cut
920 */
921
922 int
923 Perl_bytes_cmp_utf8(pTHX_ const U8 *b, STRLEN blen, const U8 *u, STRLEN ulen)
924 {
925     const U8 *const bend = b + blen;
926     const U8 *const uend = u + ulen;
927
928     PERL_ARGS_ASSERT_BYTES_CMP_UTF8;
929
930     PERL_UNUSED_CONTEXT;
931
932     while (b < bend && u < uend) {
933         U8 c = *u++;
934         if (!UTF8_IS_INVARIANT(c)) {
935             if (UTF8_IS_DOWNGRADEABLE_START(c)) {
936                 if (u < uend) {
937                     U8 c1 = *u++;
938                     if (UTF8_IS_CONTINUATION(c1)) {
939                         c = UNI_TO_NATIVE(TWO_BYTE_UTF8_TO_UNI(c, c1));
940                     } else {
941                         Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
942                                          "Malformed UTF-8 character "
943                                          "(unexpected non-continuation byte 0x%02x"
944                                          ", immediately after start byte 0x%02x)"
945                                          /* Dear diag.t, it's in the pod.  */
946                                          "%s%s", c1, c,
947                                          PL_op ? " in " : "",
948                                          PL_op ? OP_DESC(PL_op) : "");
949                         return -2;
950                     }
951                 } else {
952                     if (PL_op)
953                         Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
954                                          "%s in %s", unees, OP_DESC(PL_op));
955                     else
956                         Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8), "%s", unees);
957                     return -2; /* Really want to return undef :-)  */
958                 }
959             } else {
960                 return -2;
961             }
962         }
963         if (*b != c) {
964             return *b < c ? -2 : +2;
965         }
966         ++b;
967     }
968
969     if (b == bend && u == uend)
970         return 0;
971
972     return b < bend ? +1 : -1;
973 }
974
975 /*
976 =for apidoc utf8_to_bytes
977
978 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
979 Unlike C<bytes_to_utf8>, this over-writes the original string, and
980 updates len to contain the new length.
981 Returns zero on failure, setting C<len> to -1.
982
983 If you need a copy of the string, see C<bytes_from_utf8>.
984
985 =cut
986 */
987
988 U8 *
989 Perl_utf8_to_bytes(pTHX_ U8 *s, STRLEN *len)
990 {
991     U8 * const save = s;
992     U8 * const send = s + *len;
993     U8 *d;
994
995     PERL_ARGS_ASSERT_UTF8_TO_BYTES;
996
997     /* ensure valid UTF-8 and chars < 256 before updating string */
998     while (s < send) {
999         U8 c = *s++;
1000
1001         if (!UTF8_IS_INVARIANT(c) &&
1002             (!UTF8_IS_DOWNGRADEABLE_START(c) || (s >= send)
1003              || !(c = *s++) || !UTF8_IS_CONTINUATION(c))) {
1004             *len = ((STRLEN) -1);
1005             return 0;
1006         }
1007     }
1008
1009     d = s = save;
1010     while (s < send) {
1011         STRLEN ulen;
1012         *d++ = (U8)utf8_to_uvchr(s, &ulen);
1013         s += ulen;
1014     }
1015     *d = '\0';
1016     *len = d - save;
1017     return save;
1018 }
1019
1020 /*
1021 =for apidoc bytes_from_utf8
1022
1023 Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
1024 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
1025 the newly-created string, and updates C<len> to contain the new
1026 length.  Returns the original string if no conversion occurs, C<len>
1027 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
1028 0 if C<s> is converted or consisted entirely of characters that are invariant
1029 in utf8 (i.e., US-ASCII on non-EBCDIC machines).
1030
1031 =cut
1032 */
1033
1034 U8 *
1035 Perl_bytes_from_utf8(pTHX_ const U8 *s, STRLEN *len, bool *is_utf8)
1036 {
1037     U8 *d;
1038     const U8 *start = s;
1039     const U8 *send;
1040     I32 count = 0;
1041
1042     PERL_ARGS_ASSERT_BYTES_FROM_UTF8;
1043
1044     PERL_UNUSED_CONTEXT;
1045     if (!*is_utf8)
1046         return (U8 *)start;
1047
1048     /* ensure valid UTF-8 and chars < 256 before converting string */
1049     for (send = s + *len; s < send;) {
1050         U8 c = *s++;
1051         if (!UTF8_IS_INVARIANT(c)) {
1052             if (UTF8_IS_DOWNGRADEABLE_START(c) && s < send &&
1053                 (c = *s++) && UTF8_IS_CONTINUATION(c))
1054                 count++;
1055             else
1056                 return (U8 *)start;
1057         }
1058     }
1059
1060     *is_utf8 = FALSE;
1061
1062     Newx(d, (*len) - count + 1, U8);
1063     s = start; start = d;
1064     while (s < send) {
1065         U8 c = *s++;
1066         if (!UTF8_IS_INVARIANT(c)) {
1067             /* Then it is two-byte encoded */
1068             c = UNI_TO_NATIVE(TWO_BYTE_UTF8_TO_UNI(c, *s++));
1069         }
1070         *d++ = c;
1071     }
1072     *d = '\0';
1073     *len = d - start;
1074     return (U8 *)start;
1075 }
1076
1077 /*
1078 =for apidoc bytes_to_utf8
1079
1080 Converts a string C<s> of length C<len> bytes from the native encoding into
1081 UTF-8.
1082 Returns a pointer to the newly-created string, and sets C<len> to
1083 reflect the new length in bytes.
1084
1085 A NUL character will be written after the end of the string.
1086
1087 If you want to convert to UTF-8 from encodings other than
1088 the native (Latin1 or EBCDIC),
1089 see sv_recode_to_utf8().
1090
1091 =cut
1092 */
1093
1094 /* This logic is duplicated in sv_catpvn_flags, so any bug fixes will
1095    likewise need duplication. */
1096
1097 U8*
1098 Perl_bytes_to_utf8(pTHX_ const U8 *s, STRLEN *len)
1099 {
1100     const U8 * const send = s + (*len);
1101     U8 *d;
1102     U8 *dst;
1103
1104     PERL_ARGS_ASSERT_BYTES_TO_UTF8;
1105     PERL_UNUSED_CONTEXT;
1106
1107     Newx(d, (*len) * 2 + 1, U8);
1108     dst = d;
1109
1110     while (s < send) {
1111         const UV uv = NATIVE_TO_ASCII(*s++);
1112         if (UNI_IS_INVARIANT(uv))
1113             *d++ = (U8)UTF_TO_NATIVE(uv);
1114         else {
1115             *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
1116             *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
1117         }
1118     }
1119     *d = '\0';
1120     *len = d-dst;
1121     return dst;
1122 }
1123
1124 /*
1125  * Convert native (big-endian) or reversed (little-endian) UTF-16 to UTF-8.
1126  *
1127  * Destination must be pre-extended to 3/2 source.  Do not use in-place.
1128  * We optimize for native, for obvious reasons. */
1129
1130 U8*
1131 Perl_utf16_to_utf8(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
1132 {
1133     U8* pend;
1134     U8* dstart = d;
1135
1136     PERL_ARGS_ASSERT_UTF16_TO_UTF8;
1137
1138     if (bytelen & 1)
1139         Perl_croak(aTHX_ "panic: utf16_to_utf8: odd bytelen %"UVuf, (UV)bytelen);
1140
1141     pend = p + bytelen;
1142
1143     while (p < pend) {
1144         UV uv = (p[0] << 8) + p[1]; /* UTF-16BE */
1145         p += 2;
1146         if (uv < 0x80) {
1147 #ifdef EBCDIC
1148             *d++ = UNI_TO_NATIVE(uv);
1149 #else
1150             *d++ = (U8)uv;
1151 #endif
1152             continue;
1153         }
1154         if (uv < 0x800) {
1155             *d++ = (U8)(( uv >>  6)         | 0xc0);
1156             *d++ = (U8)(( uv        & 0x3f) | 0x80);
1157             continue;
1158         }
1159         if (uv >= 0xd800 && uv <= 0xdbff) {     /* surrogates */
1160             if (p >= pend) {
1161                 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
1162             } else {
1163                 UV low = (p[0] << 8) + p[1];
1164                 p += 2;
1165                 if (low < 0xdc00 || low > 0xdfff)
1166                     Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
1167                 uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
1168             }
1169         } else if (uv >= 0xdc00 && uv <= 0xdfff) {
1170             Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
1171         }
1172         if (uv < 0x10000) {
1173             *d++ = (U8)(( uv >> 12)         | 0xe0);
1174             *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
1175             *d++ = (U8)(( uv        & 0x3f) | 0x80);
1176             continue;
1177         }
1178         else {
1179             *d++ = (U8)(( uv >> 18)         | 0xf0);
1180             *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
1181             *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
1182             *d++ = (U8)(( uv        & 0x3f) | 0x80);
1183             continue;
1184         }
1185     }
1186     *newlen = d - dstart;
1187     return d;
1188 }
1189
1190 /* Note: this one is slightly destructive of the source. */
1191
1192 U8*
1193 Perl_utf16_to_utf8_reversed(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
1194 {
1195     U8* s = (U8*)p;
1196     U8* const send = s + bytelen;
1197
1198     PERL_ARGS_ASSERT_UTF16_TO_UTF8_REVERSED;
1199
1200     if (bytelen & 1)
1201         Perl_croak(aTHX_ "panic: utf16_to_utf8_reversed: odd bytelen %"UVuf,
1202                    (UV)bytelen);
1203
1204     while (s < send) {
1205         const U8 tmp = s[0];
1206         s[0] = s[1];
1207         s[1] = tmp;
1208         s += 2;
1209     }
1210     return utf16_to_utf8(p, d, bytelen, newlen);
1211 }
1212
1213 /* for now these are all defined (inefficiently) in terms of the utf8 versions.
1214  * Note that the macros in handy.h that call these short-circuit calling them
1215  * for Latin-1 range inputs */
1216
1217 bool
1218 Perl_is_uni_alnum(pTHX_ UV c)
1219 {
1220     U8 tmpbuf[UTF8_MAXBYTES+1];
1221     uvchr_to_utf8(tmpbuf, c);
1222     return is_utf8_alnum(tmpbuf);
1223 }
1224
1225 bool
1226 Perl_is_uni_idfirst(pTHX_ UV c)
1227 {
1228     U8 tmpbuf[UTF8_MAXBYTES+1];
1229     uvchr_to_utf8(tmpbuf, c);
1230     return is_utf8_idfirst(tmpbuf);
1231 }
1232
1233 bool
1234 Perl_is_uni_alpha(pTHX_ UV c)
1235 {
1236     U8 tmpbuf[UTF8_MAXBYTES+1];
1237     uvchr_to_utf8(tmpbuf, c);
1238     return is_utf8_alpha(tmpbuf);
1239 }
1240
1241 bool
1242 Perl_is_uni_ascii(pTHX_ UV c)
1243 {
1244     return isASCII(c);
1245 }
1246
1247 bool
1248 Perl_is_uni_space(pTHX_ UV c)
1249 {
1250     U8 tmpbuf[UTF8_MAXBYTES+1];
1251     uvchr_to_utf8(tmpbuf, c);
1252     return is_utf8_space(tmpbuf);
1253 }
1254
1255 bool
1256 Perl_is_uni_digit(pTHX_ UV c)
1257 {
1258     U8 tmpbuf[UTF8_MAXBYTES+1];
1259     uvchr_to_utf8(tmpbuf, c);
1260     return is_utf8_digit(tmpbuf);
1261 }
1262
1263 bool
1264 Perl_is_uni_upper(pTHX_ UV c)
1265 {
1266     U8 tmpbuf[UTF8_MAXBYTES+1];
1267     uvchr_to_utf8(tmpbuf, c);
1268     return is_utf8_upper(tmpbuf);
1269 }
1270
1271 bool
1272 Perl_is_uni_lower(pTHX_ UV c)
1273 {
1274     U8 tmpbuf[UTF8_MAXBYTES+1];
1275     uvchr_to_utf8(tmpbuf, c);
1276     return is_utf8_lower(tmpbuf);
1277 }
1278
1279 bool
1280 Perl_is_uni_cntrl(pTHX_ UV c)
1281 {
1282     return isCNTRL_L1(c);
1283 }
1284
1285 bool
1286 Perl_is_uni_graph(pTHX_ UV c)
1287 {
1288     U8 tmpbuf[UTF8_MAXBYTES+1];
1289     uvchr_to_utf8(tmpbuf, c);
1290     return is_utf8_graph(tmpbuf);
1291 }
1292
1293 bool
1294 Perl_is_uni_print(pTHX_ UV c)
1295 {
1296     U8 tmpbuf[UTF8_MAXBYTES+1];
1297     uvchr_to_utf8(tmpbuf, c);
1298     return is_utf8_print(tmpbuf);
1299 }
1300
1301 bool
1302 Perl_is_uni_punct(pTHX_ UV c)
1303 {
1304     U8 tmpbuf[UTF8_MAXBYTES+1];
1305     uvchr_to_utf8(tmpbuf, c);
1306     return is_utf8_punct(tmpbuf);
1307 }
1308
1309 bool
1310 Perl_is_uni_xdigit(pTHX_ UV c)
1311 {
1312     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1313     uvchr_to_utf8(tmpbuf, c);
1314     return is_utf8_xdigit(tmpbuf);
1315 }
1316
1317
1318 UV
1319 Perl_to_uni_upper(pTHX_ UV c, U8* p, STRLEN *lenp)
1320 {
1321     /* Convert the Unicode character whose ordinal is c to its uppercase
1322      * version and store that in UTF-8 in p and its length in bytes in lenp.
1323      * Note that the p needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
1324      * the changed version may be longer than the original character.
1325      *
1326      * The ordinal of the first character of the changed version is returned
1327      * (but note, as explained above, that there may be more.) */
1328
1329     PERL_ARGS_ASSERT_TO_UNI_UPPER;
1330
1331     uvchr_to_utf8(p, c);
1332     return to_utf8_upper(p, p, lenp);
1333 }
1334
1335 UV
1336 Perl_to_uni_title(pTHX_ UV c, U8* p, STRLEN *lenp)
1337 {
1338     PERL_ARGS_ASSERT_TO_UNI_TITLE;
1339
1340     uvchr_to_utf8(p, c);
1341     return to_utf8_title(p, p, lenp);
1342 }
1343
1344 UV
1345 Perl_to_uni_lower(pTHX_ UV c, U8* p, STRLEN *lenp)
1346 {
1347     PERL_ARGS_ASSERT_TO_UNI_LOWER;
1348
1349     uvchr_to_utf8(p, c);
1350     return to_utf8_lower(p, p, lenp);
1351 }
1352
1353 UV
1354 Perl__to_uni_fold_flags(pTHX_ UV c, U8* p, STRLEN *lenp, U8 flags)
1355 {
1356     PERL_ARGS_ASSERT__TO_UNI_FOLD_FLAGS;
1357
1358     uvchr_to_utf8(p, c);
1359     return _to_utf8_fold_flags(p, p, lenp, flags);
1360 }
1361
1362 /* for now these all assume no locale info available for Unicode > 255 */
1363
1364 bool
1365 Perl_is_uni_alnum_lc(pTHX_ UV c)
1366 {
1367     return is_uni_alnum(c);     /* XXX no locale support yet */
1368 }
1369
1370 bool
1371 Perl_is_uni_idfirst_lc(pTHX_ UV c)
1372 {
1373     return is_uni_idfirst(c);   /* XXX no locale support yet */
1374 }
1375
1376 bool
1377 Perl_is_uni_alpha_lc(pTHX_ UV c)
1378 {
1379     return is_uni_alpha(c);     /* XXX no locale support yet */
1380 }
1381
1382 bool
1383 Perl_is_uni_ascii_lc(pTHX_ UV c)
1384 {
1385     return is_uni_ascii(c);     /* XXX no locale support yet */
1386 }
1387
1388 bool
1389 Perl_is_uni_space_lc(pTHX_ UV c)
1390 {
1391     return is_uni_space(c);     /* XXX no locale support yet */
1392 }
1393
1394 bool
1395 Perl_is_uni_digit_lc(pTHX_ UV c)
1396 {
1397     return is_uni_digit(c);     /* XXX no locale support yet */
1398 }
1399
1400 bool
1401 Perl_is_uni_upper_lc(pTHX_ UV c)
1402 {
1403     return is_uni_upper(c);     /* XXX no locale support yet */
1404 }
1405
1406 bool
1407 Perl_is_uni_lower_lc(pTHX_ UV c)
1408 {
1409     return is_uni_lower(c);     /* XXX no locale support yet */
1410 }
1411
1412 bool
1413 Perl_is_uni_cntrl_lc(pTHX_ UV c)
1414 {
1415     return is_uni_cntrl(c);     /* XXX no locale support yet */
1416 }
1417
1418 bool
1419 Perl_is_uni_graph_lc(pTHX_ UV c)
1420 {
1421     return is_uni_graph(c);     /* XXX no locale support yet */
1422 }
1423
1424 bool
1425 Perl_is_uni_print_lc(pTHX_ UV c)
1426 {
1427     return is_uni_print(c);     /* XXX no locale support yet */
1428 }
1429
1430 bool
1431 Perl_is_uni_punct_lc(pTHX_ UV c)
1432 {
1433     return is_uni_punct(c);     /* XXX no locale support yet */
1434 }
1435
1436 bool
1437 Perl_is_uni_xdigit_lc(pTHX_ UV c)
1438 {
1439     return is_uni_xdigit(c);    /* XXX no locale support yet */
1440 }
1441
1442 U32
1443 Perl_to_uni_upper_lc(pTHX_ U32 c)
1444 {
1445     /* XXX returns only the first character -- do not use XXX */
1446     /* XXX no locale support yet */
1447     STRLEN len;
1448     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1449     return (U32)to_uni_upper(c, tmpbuf, &len);
1450 }
1451
1452 U32
1453 Perl_to_uni_title_lc(pTHX_ U32 c)
1454 {
1455     /* XXX returns only the first character XXX -- do not use XXX */
1456     /* XXX no locale support yet */
1457     STRLEN len;
1458     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1459     return (U32)to_uni_title(c, tmpbuf, &len);
1460 }
1461
1462 U32
1463 Perl_to_uni_lower_lc(pTHX_ U32 c)
1464 {
1465     /* XXX returns only the first character -- do not use XXX */
1466     /* XXX no locale support yet */
1467     STRLEN len;
1468     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1469     return (U32)to_uni_lower(c, tmpbuf, &len);
1470 }
1471
1472 static bool
1473 S_is_utf8_common(pTHX_ const U8 *const p, SV **swash,
1474                  const char *const swashname)
1475 {
1476     dVAR;
1477
1478     PERL_ARGS_ASSERT_IS_UTF8_COMMON;
1479
1480     if (!is_utf8_char(p))
1481         return FALSE;
1482     if (!*swash)
1483         *swash = swash_init("utf8", swashname, &PL_sv_undef, 1, 0);
1484     return swash_fetch(*swash, p, TRUE) != 0;
1485 }
1486
1487 bool
1488 Perl_is_utf8_alnum(pTHX_ const U8 *p)
1489 {
1490     dVAR;
1491
1492     PERL_ARGS_ASSERT_IS_UTF8_ALNUM;
1493
1494     /* NOTE: "IsWord", not "IsAlnum", since Alnum is a true
1495      * descendant of isalnum(3), in other words, it doesn't
1496      * contain the '_'. --jhi */
1497     return is_utf8_common(p, &PL_utf8_alnum, "IsWord");
1498 }
1499
1500 bool
1501 Perl_is_utf8_idfirst(pTHX_ const U8 *p) /* The naming is historical. */
1502 {
1503     dVAR;
1504
1505     PERL_ARGS_ASSERT_IS_UTF8_IDFIRST;
1506
1507     if (*p == '_')
1508         return TRUE;
1509     /* is_utf8_idstart would be more logical. */
1510     return is_utf8_common(p, &PL_utf8_idstart, "IdStart");
1511 }
1512
1513 bool
1514 Perl_is_utf8_xidfirst(pTHX_ const U8 *p) /* The naming is historical. */
1515 {
1516     dVAR;
1517
1518     PERL_ARGS_ASSERT_IS_UTF8_XIDFIRST;
1519
1520     if (*p == '_')
1521         return TRUE;
1522     /* is_utf8_idstart would be more logical. */
1523     return is_utf8_common(p, &PL_utf8_xidstart, "XIdStart");
1524 }
1525
1526 bool
1527 Perl__is_utf8__perl_idstart(pTHX_ const U8 *p)
1528 {
1529     dVAR;
1530
1531     PERL_ARGS_ASSERT__IS_UTF8__PERL_IDSTART;
1532
1533     return is_utf8_common(p, &PL_utf8_perl_idstart, "_Perl_IDStart");
1534 }
1535
1536 bool
1537 Perl_is_utf8_idcont(pTHX_ const U8 *p)
1538 {
1539     dVAR;
1540
1541     PERL_ARGS_ASSERT_IS_UTF8_IDCONT;
1542
1543     return is_utf8_common(p, &PL_utf8_idcont, "IdContinue");
1544 }
1545
1546 bool
1547 Perl_is_utf8_xidcont(pTHX_ const U8 *p)
1548 {
1549     dVAR;
1550
1551     PERL_ARGS_ASSERT_IS_UTF8_XIDCONT;
1552
1553     return is_utf8_common(p, &PL_utf8_idcont, "XIdContinue");
1554 }
1555
1556 bool
1557 Perl_is_utf8_alpha(pTHX_ const U8 *p)
1558 {
1559     dVAR;
1560
1561     PERL_ARGS_ASSERT_IS_UTF8_ALPHA;
1562
1563     return is_utf8_common(p, &PL_utf8_alpha, "IsAlpha");
1564 }
1565
1566 bool
1567 Perl_is_utf8_ascii(pTHX_ const U8 *p)
1568 {
1569     dVAR;
1570
1571     PERL_ARGS_ASSERT_IS_UTF8_ASCII;
1572
1573     /* ASCII characters are the same whether in utf8 or not.  So the macro
1574      * works on both utf8 and non-utf8 representations. */
1575     return isASCII(*p);
1576 }
1577
1578 bool
1579 Perl_is_utf8_space(pTHX_ const U8 *p)
1580 {
1581     dVAR;
1582
1583     PERL_ARGS_ASSERT_IS_UTF8_SPACE;
1584
1585     return is_utf8_common(p, &PL_utf8_space, "IsXPerlSpace");
1586 }
1587
1588 bool
1589 Perl_is_utf8_perl_space(pTHX_ const U8 *p)
1590 {
1591     dVAR;
1592
1593     PERL_ARGS_ASSERT_IS_UTF8_PERL_SPACE;
1594
1595     /* Only true if is an ASCII space-like character, and ASCII is invariant
1596      * under utf8, so can just use the macro */
1597     return isSPACE_A(*p);
1598 }
1599
1600 bool
1601 Perl_is_utf8_perl_word(pTHX_ const U8 *p)
1602 {
1603     dVAR;
1604
1605     PERL_ARGS_ASSERT_IS_UTF8_PERL_WORD;
1606
1607     /* Only true if is an ASCII word character, and ASCII is invariant
1608      * under utf8, so can just use the macro */
1609     return isWORDCHAR_A(*p);
1610 }
1611
1612 bool
1613 Perl_is_utf8_digit(pTHX_ const U8 *p)
1614 {
1615     dVAR;
1616
1617     PERL_ARGS_ASSERT_IS_UTF8_DIGIT;
1618
1619     return is_utf8_common(p, &PL_utf8_digit, "IsDigit");
1620 }
1621
1622 bool
1623 Perl_is_utf8_posix_digit(pTHX_ const U8 *p)
1624 {
1625     dVAR;
1626
1627     PERL_ARGS_ASSERT_IS_UTF8_POSIX_DIGIT;
1628
1629     /* Only true if is an ASCII digit character, and ASCII is invariant
1630      * under utf8, so can just use the macro */
1631     return isDIGIT_A(*p);
1632 }
1633
1634 bool
1635 Perl_is_utf8_upper(pTHX_ const U8 *p)
1636 {
1637     dVAR;
1638
1639     PERL_ARGS_ASSERT_IS_UTF8_UPPER;
1640
1641     return is_utf8_common(p, &PL_utf8_upper, "IsUppercase");
1642 }
1643
1644 bool
1645 Perl_is_utf8_lower(pTHX_ const U8 *p)
1646 {
1647     dVAR;
1648
1649     PERL_ARGS_ASSERT_IS_UTF8_LOWER;
1650
1651     return is_utf8_common(p, &PL_utf8_lower, "IsLowercase");
1652 }
1653
1654 bool
1655 Perl_is_utf8_cntrl(pTHX_ const U8 *p)
1656 {
1657     dVAR;
1658
1659     PERL_ARGS_ASSERT_IS_UTF8_CNTRL;
1660
1661     if (isASCII(*p)) {
1662         return isCNTRL_A(*p);
1663     }
1664
1665     /* All controls are in Latin1 */
1666     if (! UTF8_IS_DOWNGRADEABLE_START(*p)) {
1667         return 0;
1668     }
1669     return isCNTRL_L1(TWO_BYTE_UTF8_TO_UNI(*p, *(p+1)));
1670 }
1671
1672 bool
1673 Perl_is_utf8_graph(pTHX_ const U8 *p)
1674 {
1675     dVAR;
1676
1677     PERL_ARGS_ASSERT_IS_UTF8_GRAPH;
1678
1679     return is_utf8_common(p, &PL_utf8_graph, "IsGraph");
1680 }
1681
1682 bool
1683 Perl_is_utf8_print(pTHX_ const U8 *p)
1684 {
1685     dVAR;
1686
1687     PERL_ARGS_ASSERT_IS_UTF8_PRINT;
1688
1689     return is_utf8_common(p, &PL_utf8_print, "IsPrint");
1690 }
1691
1692 bool
1693 Perl_is_utf8_punct(pTHX_ const U8 *p)
1694 {
1695     dVAR;
1696
1697     PERL_ARGS_ASSERT_IS_UTF8_PUNCT;
1698
1699     return is_utf8_common(p, &PL_utf8_punct, "IsPunct");
1700 }
1701
1702 bool
1703 Perl_is_utf8_xdigit(pTHX_ const U8 *p)
1704 {
1705     dVAR;
1706
1707     PERL_ARGS_ASSERT_IS_UTF8_XDIGIT;
1708
1709     return is_utf8_common(p, &PL_utf8_xdigit, "IsXDigit");
1710 }
1711
1712 bool
1713 Perl_is_utf8_mark(pTHX_ const U8 *p)
1714 {
1715     dVAR;
1716
1717     PERL_ARGS_ASSERT_IS_UTF8_MARK;
1718
1719     return is_utf8_common(p, &PL_utf8_mark, "IsM");
1720 }
1721
1722 bool
1723 Perl_is_utf8_X_begin(pTHX_ const U8 *p)
1724 {
1725     dVAR;
1726
1727     PERL_ARGS_ASSERT_IS_UTF8_X_BEGIN;
1728
1729     return is_utf8_common(p, &PL_utf8_X_begin, "_X_Begin");
1730 }
1731
1732 bool
1733 Perl_is_utf8_X_extend(pTHX_ const U8 *p)
1734 {
1735     dVAR;
1736
1737     PERL_ARGS_ASSERT_IS_UTF8_X_EXTEND;
1738
1739     return is_utf8_common(p, &PL_utf8_X_extend, "_X_Extend");
1740 }
1741
1742 bool
1743 Perl_is_utf8_X_prepend(pTHX_ const U8 *p)
1744 {
1745     dVAR;
1746
1747     PERL_ARGS_ASSERT_IS_UTF8_X_PREPEND;
1748
1749     return is_utf8_common(p, &PL_utf8_X_prepend, "GCB=Prepend");
1750 }
1751
1752 bool
1753 Perl_is_utf8_X_non_hangul(pTHX_ const U8 *p)
1754 {
1755     dVAR;
1756
1757     PERL_ARGS_ASSERT_IS_UTF8_X_NON_HANGUL;
1758
1759     return is_utf8_common(p, &PL_utf8_X_non_hangul, "HST=Not_Applicable");
1760 }
1761
1762 bool
1763 Perl_is_utf8_X_L(pTHX_ const U8 *p)
1764 {
1765     dVAR;
1766
1767     PERL_ARGS_ASSERT_IS_UTF8_X_L;
1768
1769     return is_utf8_common(p, &PL_utf8_X_L, "GCB=L");
1770 }
1771
1772 bool
1773 Perl_is_utf8_X_LV(pTHX_ const U8 *p)
1774 {
1775     dVAR;
1776
1777     PERL_ARGS_ASSERT_IS_UTF8_X_LV;
1778
1779     return is_utf8_common(p, &PL_utf8_X_LV, "GCB=LV");
1780 }
1781
1782 bool
1783 Perl_is_utf8_X_LVT(pTHX_ const U8 *p)
1784 {
1785     dVAR;
1786
1787     PERL_ARGS_ASSERT_IS_UTF8_X_LVT;
1788
1789     return is_utf8_common(p, &PL_utf8_X_LVT, "GCB=LVT");
1790 }
1791
1792 bool
1793 Perl_is_utf8_X_T(pTHX_ const U8 *p)
1794 {
1795     dVAR;
1796
1797     PERL_ARGS_ASSERT_IS_UTF8_X_T;
1798
1799     return is_utf8_common(p, &PL_utf8_X_T, "GCB=T");
1800 }
1801
1802 bool
1803 Perl_is_utf8_X_V(pTHX_ const U8 *p)
1804 {
1805     dVAR;
1806
1807     PERL_ARGS_ASSERT_IS_UTF8_X_V;
1808
1809     return is_utf8_common(p, &PL_utf8_X_V, "GCB=V");
1810 }
1811
1812 bool
1813 Perl_is_utf8_X_LV_LVT_V(pTHX_ const U8 *p)
1814 {
1815     dVAR;
1816
1817     PERL_ARGS_ASSERT_IS_UTF8_X_LV_LVT_V;
1818
1819     return is_utf8_common(p, &PL_utf8_X_LV_LVT_V, "_X_LV_LVT_V");
1820 }
1821
1822 /*
1823 =for apidoc to_utf8_case
1824
1825 The "p" contains the pointer to the UTF-8 string encoding
1826 the character that is being converted.
1827
1828 The "ustrp" is a pointer to the character buffer to put the
1829 conversion result to.  The "lenp" is a pointer to the length
1830 of the result.
1831
1832 The "swashp" is a pointer to the swash to use.
1833
1834 Both the special and normal mappings are stored in lib/unicore/To/Foo.pl,
1835 and loaded by SWASHNEW, using lib/utf8_heavy.pl.  The special (usually,
1836 but not always, a multicharacter mapping), is tried first.
1837
1838 The "special" is a string like "utf8::ToSpecLower", which means the
1839 hash %utf8::ToSpecLower.  The access to the hash is through
1840 Perl_to_utf8_case().
1841
1842 The "normal" is a string like "ToLower" which means the swash
1843 %utf8::ToLower.
1844
1845 =cut */
1846
1847 UV
1848 Perl_to_utf8_case(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp,
1849                         SV **swashp, const char *normal, const char *special)
1850 {
1851     dVAR;
1852     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1853     STRLEN len = 0;
1854     const UV uv0 = utf8_to_uvchr(p, NULL);
1855     /* The NATIVE_TO_UNI() and UNI_TO_NATIVE() mappings
1856      * are necessary in EBCDIC, they are redundant no-ops
1857      * in ASCII-ish platforms, and hopefully optimized away. */
1858     const UV uv1 = NATIVE_TO_UNI(uv0);
1859
1860     PERL_ARGS_ASSERT_TO_UTF8_CASE;
1861
1862     /* Note that swash_fetch() doesn't output warnings for these because it
1863      * assumes we will */
1864     if (uv1 >= UNICODE_SURROGATE_FIRST) {
1865         if (uv1 <= UNICODE_SURROGATE_LAST) {
1866             if (ckWARN_d(WARN_SURROGATE)) {
1867                 const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
1868                 Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
1869                     "Operation \"%s\" returns its argument for UTF-16 surrogate U+%04"UVXf"", desc, uv1);
1870             }
1871         }
1872         else if (UNICODE_IS_SUPER(uv1)) {
1873             if (ckWARN_d(WARN_NON_UNICODE)) {
1874                 const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
1875                 Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
1876                     "Operation \"%s\" returns its argument for non-Unicode code point 0x%04"UVXf"", desc, uv1);
1877             }
1878         }
1879
1880         /* Note that non-characters are perfectly legal, so no warning should
1881          * be given */
1882     }
1883
1884     uvuni_to_utf8(tmpbuf, uv1);
1885
1886     if (!*swashp) /* load on-demand */
1887          *swashp = swash_init("utf8", normal, &PL_sv_undef, 4, 0);
1888
1889     if (special) {
1890          /* It might be "special" (sometimes, but not always,
1891           * a multicharacter mapping) */
1892          HV * const hv = get_hv(special, 0);
1893          SV **svp;
1894
1895          if (hv &&
1896              (svp = hv_fetch(hv, (const char*)tmpbuf, UNISKIP(uv1), FALSE)) &&
1897              (*svp)) {
1898              const char *s;
1899
1900               s = SvPV_const(*svp, len);
1901               if (len == 1)
1902                    len = uvuni_to_utf8(ustrp, NATIVE_TO_UNI(*(U8*)s)) - ustrp;
1903               else {
1904 #ifdef EBCDIC
1905                    /* If we have EBCDIC we need to remap the characters
1906                     * since any characters in the low 256 are Unicode
1907                     * code points, not EBCDIC. */
1908                    U8 *t = (U8*)s, *tend = t + len, *d;
1909                 
1910                    d = tmpbuf;
1911                    if (SvUTF8(*svp)) {
1912                         STRLEN tlen = 0;
1913                         
1914                         while (t < tend) {
1915                              const UV c = utf8_to_uvchr(t, &tlen);
1916                              if (tlen > 0) {
1917                                   d = uvchr_to_utf8(d, UNI_TO_NATIVE(c));
1918                                   t += tlen;
1919                              }
1920                              else
1921                                   break;
1922                         }
1923                    }
1924                    else {
1925                         while (t < tend) {
1926                              d = uvchr_to_utf8(d, UNI_TO_NATIVE(*t));
1927                              t++;
1928                         }
1929                    }
1930                    len = d - tmpbuf;
1931                    Copy(tmpbuf, ustrp, len, U8);
1932 #else
1933                    Copy(s, ustrp, len, U8);
1934 #endif
1935               }
1936          }
1937     }
1938
1939     if (!len && *swashp) {
1940         const UV uv2 = swash_fetch(*swashp, tmpbuf, TRUE);
1941
1942          if (uv2) {
1943               /* It was "normal" (a single character mapping). */
1944               const UV uv3 = UNI_TO_NATIVE(uv2);
1945               len = uvchr_to_utf8(ustrp, uv3) - ustrp;
1946          }
1947     }
1948
1949     if (!len) /* Neither: just copy.  In other words, there was no mapping
1950                  defined, which means that the code point maps to itself */
1951          len = uvchr_to_utf8(ustrp, uv0) - ustrp;
1952
1953     if (lenp)
1954          *lenp = len;
1955
1956     return len ? utf8_to_uvchr(ustrp, 0) : 0;
1957 }
1958
1959 /*
1960 =for apidoc to_utf8_upper
1961
1962 Convert the UTF-8 encoded character at p to its uppercase version and
1963 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
1964 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
1965 the uppercase version may be longer than the original character.
1966
1967 The first character of the uppercased version is returned
1968 (but note, as explained above, that there may be more.)
1969
1970 =cut */
1971
1972 UV
1973 Perl_to_utf8_upper(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1974 {
1975     dVAR;
1976
1977     PERL_ARGS_ASSERT_TO_UTF8_UPPER;
1978
1979     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
1980                              &PL_utf8_toupper, "ToUpper", "utf8::ToSpecUpper");
1981 }
1982
1983 /*
1984 =for apidoc to_utf8_title
1985
1986 Convert the UTF-8 encoded character at p to its titlecase version and
1987 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
1988 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
1989 titlecase version may be longer than the original character.
1990
1991 The first character of the titlecased version is returned
1992 (but note, as explained above, that there may be more.)
1993
1994 =cut */
1995
1996 UV
1997 Perl_to_utf8_title(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1998 {
1999     dVAR;
2000
2001     PERL_ARGS_ASSERT_TO_UTF8_TITLE;
2002
2003     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
2004                              &PL_utf8_totitle, "ToTitle", "utf8::ToSpecTitle");
2005 }
2006
2007 /*
2008 =for apidoc to_utf8_lower
2009
2010 Convert the UTF-8 encoded character at p to its lowercase version and
2011 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
2012 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
2013 lowercase version may be longer than the original character.
2014
2015 The first character of the lowercased version is returned
2016 (but note, as explained above, that there may be more.)
2017
2018 =cut */
2019
2020 UV
2021 Perl_to_utf8_lower(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
2022 {
2023     dVAR;
2024
2025     PERL_ARGS_ASSERT_TO_UTF8_LOWER;
2026
2027     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
2028                              &PL_utf8_tolower, "ToLower", "utf8::ToSpecLower");
2029 }
2030
2031 /*
2032 =for apidoc to_utf8_fold
2033
2034 Convert the UTF-8 encoded character at p to its foldcase version and
2035 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
2036 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
2037 foldcase version may be longer than the original character (up to
2038 three characters).
2039
2040 The first character of the foldcased version is returned
2041 (but note, as explained above, that there may be more.)
2042
2043 =cut */
2044
2045 /* Not currently externally documented is 'flags', which currently is non-zero
2046  * if full case folds are to be used; otherwise simple folds */
2047
2048 UV
2049 Perl__to_utf8_fold_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, U8 flags)
2050 {
2051     const char *specials = (flags) ? "utf8::ToSpecFold" : NULL;
2052
2053     dVAR;
2054
2055     PERL_ARGS_ASSERT__TO_UTF8_FOLD_FLAGS;
2056
2057     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
2058                              &PL_utf8_tofold, "ToFold", specials);
2059 }
2060
2061 /* Note:
2062  * A "swash" is a swatch hash.
2063  * A "swatch" is a bit vector generated by utf8.c:S_swash_get().
2064  * C<pkg> is a pointer to a package name for SWASHNEW, should be "utf8".
2065  * For other parameters, see utf8::SWASHNEW in lib/utf8_heavy.pl.
2066  */
2067 SV*
2068 Perl_swash_init(pTHX_ const char* pkg, const char* name, SV *listsv, I32 minbits, I32 none)
2069 {
2070     dVAR;
2071     SV* retval;
2072     dSP;
2073     const size_t pkg_len = strlen(pkg);
2074     const size_t name_len = strlen(name);
2075     HV * const stash = gv_stashpvn(pkg, pkg_len, 0);
2076     SV* errsv_save;
2077     GV *method;
2078
2079     PERL_ARGS_ASSERT_SWASH_INIT;
2080
2081     PUSHSTACKi(PERLSI_MAGIC);
2082     ENTER;
2083     SAVEHINTS();
2084     save_re_context();
2085     if (PL_parser && PL_parser->error_count)
2086         SAVEI8(PL_parser->error_count), PL_parser->error_count = 0;
2087     method = gv_fetchmeth(stash, "SWASHNEW", 8, -1);
2088     if (!method) {      /* demand load utf8 */
2089         ENTER;
2090         errsv_save = newSVsv(ERRSV);
2091         /* It is assumed that callers of this routine are not passing in any
2092            user derived data.  */
2093         /* Need to do this after save_re_context() as it will set PL_tainted to
2094            1 while saving $1 etc (see the code after getrx: in Perl_magic_get).
2095            Even line to create errsv_save can turn on PL_tainted.  */
2096         SAVEBOOL(PL_tainted);
2097         PL_tainted = 0;
2098         Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpvn(pkg,pkg_len),
2099                          NULL);
2100         if (!SvTRUE(ERRSV))
2101             sv_setsv(ERRSV, errsv_save);
2102         SvREFCNT_dec(errsv_save);
2103         LEAVE;
2104     }
2105     SPAGAIN;
2106     PUSHMARK(SP);
2107     EXTEND(SP,5);
2108     mPUSHp(pkg, pkg_len);
2109     mPUSHp(name, name_len);
2110     PUSHs(listsv);
2111     mPUSHi(minbits);
2112     mPUSHi(none);
2113     PUTBACK;
2114     errsv_save = newSVsv(ERRSV);
2115     /* If we already have a pointer to the method, no need to use call_method()
2116        to repeat the lookup.  */
2117     if (method ? call_sv(MUTABLE_SV(method), G_SCALAR)
2118         : call_sv(newSVpvs_flags("SWASHNEW", SVs_TEMP), G_SCALAR | G_METHOD))
2119         retval = newSVsv(*PL_stack_sp--);
2120     else
2121         retval = &PL_sv_undef;
2122     if (!SvTRUE(ERRSV))
2123         sv_setsv(ERRSV, errsv_save);
2124     SvREFCNT_dec(errsv_save);
2125     LEAVE;
2126     POPSTACK;
2127     if (IN_PERL_COMPILETIME) {
2128         CopHINTS_set(PL_curcop, PL_hints);
2129     }
2130     if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV) {
2131         if (SvPOK(retval))
2132             Perl_croak(aTHX_ "Can't find Unicode property definition \"%"SVf"\"",
2133                        SVfARG(retval));
2134         Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
2135     }
2136     return retval;
2137 }
2138
2139
2140 /* This API is wrong for special case conversions since we may need to
2141  * return several Unicode characters for a single Unicode character
2142  * (see lib/unicore/SpecCase.txt) The SWASHGET in lib/utf8_heavy.pl is
2143  * the lower-level routine, and it is similarly broken for returning
2144  * multiple values.  --jhi
2145  * For those, you should use to_utf8_case() instead */
2146 /* Now SWASHGET is recasted into S_swash_get in this file. */
2147
2148 /* Note:
2149  * Returns the value of property/mapping C<swash> for the first character
2150  * of the string C<ptr>. If C<do_utf8> is true, the string C<ptr> is
2151  * assumed to be in utf8. If C<do_utf8> is false, the string C<ptr> is
2152  * assumed to be in native 8-bit encoding. Caches the swatch in C<swash>.
2153  */
2154 UV
2155 Perl_swash_fetch(pTHX_ SV *swash, const U8 *ptr, bool do_utf8)
2156 {
2157     dVAR;
2158     HV *const hv = MUTABLE_HV(SvRV(swash));
2159     U32 klen;
2160     U32 off;
2161     STRLEN slen;
2162     STRLEN needents;
2163     const U8 *tmps = NULL;
2164     U32 bit;
2165     SV *swatch;
2166     U8 tmputf8[2];
2167     const UV c = NATIVE_TO_ASCII(*ptr);
2168
2169     PERL_ARGS_ASSERT_SWASH_FETCH;
2170
2171     if (!do_utf8 && !UNI_IS_INVARIANT(c)) {
2172         tmputf8[0] = (U8)UTF8_EIGHT_BIT_HI(c);
2173         tmputf8[1] = (U8)UTF8_EIGHT_BIT_LO(c);
2174         ptr = tmputf8;
2175     }
2176     /* Given a UTF-X encoded char 0xAA..0xYY,0xZZ
2177      * then the "swatch" is a vec() for all the chars which start
2178      * with 0xAA..0xYY
2179      * So the key in the hash (klen) is length of encoded char -1
2180      */
2181     klen = UTF8SKIP(ptr) - 1;
2182     off  = ptr[klen];
2183
2184     if (klen == 0) {
2185       /* If char is invariant then swatch is for all the invariant chars
2186        * In both UTF-8 and UTF-8-MOD that happens to be UTF_CONTINUATION_MARK
2187        */
2188         needents = UTF_CONTINUATION_MARK;
2189         off      = NATIVE_TO_UTF(ptr[klen]);
2190     }
2191     else {
2192       /* If char is encoded then swatch is for the prefix */
2193         needents = (1 << UTF_ACCUMULATION_SHIFT);
2194         off      = NATIVE_TO_UTF(ptr[klen]) & UTF_CONTINUATION_MASK;
2195         if (UTF8_IS_SUPER(ptr) && ckWARN_d(WARN_NON_UNICODE)) {
2196             const UV code_point = utf8n_to_uvuni(ptr, UTF8_MAXBYTES, 0, 0);
2197
2198             /* This outputs warnings for binary properties only, assuming that
2199              * to_utf8_case() will output any for non-binary.  Also, surrogates
2200              * aren't checked for, as that would warn on things like
2201              * /\p{Gc=Cs}/ */
2202             SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2203             if (SvUV(*bitssvp) == 1) {
2204                 Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
2205                     "Code point 0x%04"UVXf" is not Unicode, all \\p{} matches fail; all \\P{} matches succeed", code_point);
2206             }
2207         }
2208     }
2209
2210     /*
2211      * This single-entry cache saves about 1/3 of the utf8 overhead in test
2212      * suite.  (That is, only 7-8% overall over just a hash cache.  Still,
2213      * it's nothing to sniff at.)  Pity we usually come through at least
2214      * two function calls to get here...
2215      *
2216      * NB: this code assumes that swatches are never modified, once generated!
2217      */
2218
2219     if (hv   == PL_last_swash_hv &&
2220         klen == PL_last_swash_klen &&
2221         (!klen || memEQ((char *)ptr, (char *)PL_last_swash_key, klen)) )
2222     {
2223         tmps = PL_last_swash_tmps;
2224         slen = PL_last_swash_slen;
2225     }
2226     else {
2227         /* Try our second-level swatch cache, kept in a hash. */
2228         SV** svp = hv_fetch(hv, (const char*)ptr, klen, FALSE);
2229
2230         /* If not cached, generate it via swash_get */
2231         if (!svp || !SvPOK(*svp)
2232                  || !(tmps = (const U8*)SvPV_const(*svp, slen))) {
2233             /* We use utf8n_to_uvuni() as we want an index into
2234                Unicode tables, not a native character number.
2235              */
2236             const UV code_point = utf8n_to_uvuni(ptr, UTF8_MAXBYTES, 0,
2237                                            ckWARN(WARN_UTF8) ?
2238                                            0 : UTF8_ALLOW_ANY);
2239             swatch = swash_get(swash,
2240                     /* On EBCDIC & ~(0xA0-1) isn't a useful thing to do */
2241                                 (klen) ? (code_point & ~(needents - 1)) : 0,
2242                                 needents);
2243
2244             if (IN_PERL_COMPILETIME)
2245                 CopHINTS_set(PL_curcop, PL_hints);
2246
2247             svp = hv_store(hv, (const char *)ptr, klen, swatch, 0);
2248
2249             if (!svp || !(tmps = (U8*)SvPV(*svp, slen))
2250                      || (slen << 3) < needents)
2251                 Perl_croak(aTHX_ "panic: swash_fetch got improper swatch");
2252         }
2253
2254         PL_last_swash_hv = hv;
2255         assert(klen <= sizeof(PL_last_swash_key));
2256         PL_last_swash_klen = (U8)klen;
2257         /* FIXME change interpvar.h?  */
2258         PL_last_swash_tmps = (U8 *) tmps;
2259         PL_last_swash_slen = slen;
2260         if (klen)
2261             Copy(ptr, PL_last_swash_key, klen, U8);
2262     }
2263
2264     switch ((int)((slen << 3) / needents)) {
2265     case 1:
2266         bit = 1 << (off & 7);
2267         off >>= 3;
2268         return (tmps[off] & bit) != 0;
2269     case 8:
2270         return tmps[off];
2271     case 16:
2272         off <<= 1;
2273         return (tmps[off] << 8) + tmps[off + 1] ;
2274     case 32:
2275         off <<= 2;
2276         return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
2277     }
2278     Perl_croak(aTHX_ "panic: swash_fetch got swatch of unexpected bit width");
2279     NORETURN_FUNCTION_END;
2280 }
2281
2282 /* Read a single line of the main body of the swash input text.  These are of
2283  * the form:
2284  * 0053 0056    0073
2285  * where each number is hex.  The first two numbers form the minimum and
2286  * maximum of a range, and the third is the value associated with the range.
2287  * Not all swashes should have a third number
2288  *
2289  * On input: l    points to the beginning of the line to be examined; it points
2290  *                to somewhere in the string of the whole input text, and is
2291  *                terminated by a \n or the null string terminator.
2292  *           lend   points to the null terminator of that string
2293  *           wants_value    is non-zero if the swash expects a third number
2294  *           typestr is the name of the swash's mapping, like 'ToLower'
2295  * On output: *min, *max, and *val are set to the values read from the line.
2296  *            returns a pointer just beyond the line examined.  If there was no
2297  *            valid min number on the line, returns lend+1
2298  */
2299
2300 STATIC U8*
2301 S_swash_scan_list_line(pTHX_ U8* l, U8* const lend, UV* min, UV* max, UV* val,
2302                              const bool wants_value, const U8* const typestr)
2303 {
2304     const int  typeto  = typestr[0] == 'T' && typestr[1] == 'o';
2305     STRLEN numlen;          /* Length of the number */
2306     I32 flags = PERL_SCAN_SILENT_ILLDIGIT
2307                 | PERL_SCAN_DISALLOW_PREFIX
2308                 | PERL_SCAN_SILENT_NON_PORTABLE;
2309
2310     /* nl points to the next \n in the scan */
2311     U8* const nl = (U8*)memchr(l, '\n', lend - l);
2312
2313     /* Get the first number on the line: the range minimum */
2314     numlen = lend - l;
2315     *min = grok_hex((char *)l, &numlen, &flags, NULL);
2316     if (numlen)     /* If found a hex number, position past it */
2317         l += numlen;
2318     else if (nl) {          /* Else, go handle next line, if any */
2319         return nl + 1;  /* 1 is length of "\n" */
2320     }
2321     else {              /* Else, no next line */
2322         return lend + 1;        /* to LIST's end at which \n is not found */
2323     }
2324
2325     /* The max range value follows, separated by a BLANK */
2326     if (isBLANK(*l)) {
2327         ++l;
2328         flags = PERL_SCAN_SILENT_ILLDIGIT
2329                 | PERL_SCAN_DISALLOW_PREFIX
2330                 | PERL_SCAN_SILENT_NON_PORTABLE;
2331         numlen = lend - l;
2332         *max = grok_hex((char *)l, &numlen, &flags, NULL);
2333         if (numlen)
2334             l += numlen;
2335         else    /* If no value here, it is a single element range */
2336             *max = *min;
2337
2338         /* Non-binary tables have a third entry: what the first element of the
2339          * range maps to */
2340         if (wants_value) {
2341             if (isBLANK(*l)) {
2342                 ++l;
2343                 flags = PERL_SCAN_SILENT_ILLDIGIT
2344                       | PERL_SCAN_DISALLOW_PREFIX
2345                       | PERL_SCAN_SILENT_NON_PORTABLE;
2346                 numlen = lend - l;
2347                 *val = grok_hex((char *)l, &numlen, &flags, NULL);
2348                 if (numlen)
2349                     l += numlen;
2350                 else
2351                     *val = 0;
2352             }
2353             else {
2354                 *val = 0;
2355                 if (typeto) {
2356                     Perl_croak(aTHX_ "%s: illegal mapping '%s'",
2357                                      typestr, l);
2358                 }
2359             }
2360         }
2361         else
2362             *val = 0; /* bits == 1, then any val should be ignored */
2363     }
2364     else { /* Nothing following range min, should be single element with no
2365               mapping expected */
2366         *max = *min;
2367         if (wants_value) {
2368             *val = 0;
2369             if (typeto) {
2370                 Perl_croak(aTHX_ "%s: illegal mapping '%s'", typestr, l);
2371             }
2372         }
2373         else
2374             *val = 0; /* bits == 1, then val should be ignored */
2375     }
2376
2377     /* Position to next line if any, or EOF */
2378     if (nl)
2379         l = nl + 1;
2380     else
2381         l = lend;
2382
2383     return l;
2384 }
2385
2386 /* Note:
2387  * Returns a swatch (a bit vector string) for a code point sequence
2388  * that starts from the value C<start> and comprises the number C<span>.
2389  * A C<swash> must be an object created by SWASHNEW (see lib/utf8_heavy.pl).
2390  * Should be used via swash_fetch, which will cache the swatch in C<swash>.
2391  */
2392 STATIC SV*
2393 S_swash_get(pTHX_ SV* swash, UV start, UV span)
2394 {
2395     SV *swatch;
2396     U8 *l, *lend, *x, *xend, *s, *send;
2397     STRLEN lcur, xcur, scur;
2398     HV *const hv = MUTABLE_HV(SvRV(swash));
2399
2400     /* The string containing the main body of the table */
2401     SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
2402
2403     SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
2404     SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2405     SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
2406     SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
2407     SV** const invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
2408     const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
2409     const STRLEN bits  = SvUV(*bitssvp);
2410     const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
2411     const UV     none  = SvUV(*nonesvp);
2412     const UV     end   = start + span;
2413
2414     PERL_ARGS_ASSERT_SWASH_GET;
2415
2416     if (bits != 1 && bits != 8 && bits != 16 && bits != 32) {
2417         Perl_croak(aTHX_ "panic: swash_get doesn't expect bits %"UVuf,
2418                                                  (UV)bits);
2419     }
2420
2421     /* create and initialize $swatch */
2422     scur   = octets ? (span * octets) : (span + 7) / 8;
2423     swatch = newSV(scur);
2424     SvPOK_on(swatch);
2425     s = (U8*)SvPVX(swatch);
2426     if (octets && none) {
2427         const U8* const e = s + scur;
2428         while (s < e) {
2429             if (bits == 8)
2430                 *s++ = (U8)(none & 0xff);
2431             else if (bits == 16) {
2432                 *s++ = (U8)((none >>  8) & 0xff);
2433                 *s++ = (U8)( none        & 0xff);
2434             }
2435             else if (bits == 32) {
2436                 *s++ = (U8)((none >> 24) & 0xff);
2437                 *s++ = (U8)((none >> 16) & 0xff);
2438                 *s++ = (U8)((none >>  8) & 0xff);
2439                 *s++ = (U8)( none        & 0xff);
2440             }
2441         }
2442         *s = '\0';
2443     }
2444     else {
2445         (void)memzero((U8*)s, scur + 1);
2446     }
2447     SvCUR_set(swatch, scur);
2448     s = (U8*)SvPVX(swatch);
2449
2450     /* read $swash->{LIST} */
2451     l = (U8*)SvPV(*listsvp, lcur);
2452     lend = l + lcur;
2453     while (l < lend) {
2454         UV min, max, val;
2455         l = S_swash_scan_list_line(aTHX_ l, lend, &min, &max, &val,
2456                                          cBOOL(octets), typestr);
2457         if (l > lend) {
2458             break;
2459         }
2460
2461         /* If looking for something beyond this range, go try the next one */
2462         if (max < start)
2463             continue;
2464
2465         if (octets) {
2466             UV key;
2467             if (min < start) {
2468                 if (!none || val < none) {
2469                     val += start - min;
2470                 }
2471                 min = start;
2472             }
2473             for (key = min; key <= max; key++) {
2474                 STRLEN offset;
2475                 if (key >= end)
2476                     goto go_out_list;
2477                 /* offset must be non-negative (start <= min <= key < end) */
2478                 offset = octets * (key - start);
2479                 if (bits == 8)
2480                     s[offset] = (U8)(val & 0xff);
2481                 else if (bits == 16) {
2482                     s[offset    ] = (U8)((val >>  8) & 0xff);
2483                     s[offset + 1] = (U8)( val        & 0xff);
2484                 }
2485                 else if (bits == 32) {
2486                     s[offset    ] = (U8)((val >> 24) & 0xff);
2487                     s[offset + 1] = (U8)((val >> 16) & 0xff);
2488                     s[offset + 2] = (U8)((val >>  8) & 0xff);
2489                     s[offset + 3] = (U8)( val        & 0xff);
2490                 }
2491
2492                 if (!none || val < none)
2493                     ++val;
2494             }
2495         }
2496         else { /* bits == 1, then val should be ignored */
2497             UV key;
2498             if (min < start)
2499                 min = start;
2500             for (key = min; key <= max; key++) {
2501                 const STRLEN offset = (STRLEN)(key - start);
2502                 if (key >= end)
2503                     goto go_out_list;
2504                 s[offset >> 3] |= 1 << (offset & 7);
2505             }
2506         }
2507     } /* while */
2508   go_out_list:
2509
2510     /* Invert if the data says it should be.  Assumes that bits == 1 */
2511     if (invert_it_svp && SvUV(*invert_it_svp)) {
2512
2513         /* Unicode properties should come with all bits above PERL_UNICODE_MAX
2514          * be 0, and their inversion should also be 0, as we don't succeed any
2515          * Unicode property matches for non-Unicode code points */
2516         if (start <= PERL_UNICODE_MAX) {
2517
2518             /* The code below assumes that we never cross the
2519              * Unicode/above-Unicode boundary in a range, as otherwise we would
2520              * have to figure out where to stop flipping the bits.  Since this
2521              * boundary is divisible by a large power of 2, and swatches comes
2522              * in small powers of 2, this should be a valid assumption */
2523             assert(start + span - 1 <= PERL_UNICODE_MAX);
2524
2525             send = s + scur;
2526             while (s < send) {
2527                 *s = ~(*s);
2528                 s++;
2529             }
2530         }
2531     }
2532
2533     /* read $swash->{EXTRAS}
2534      * This code also copied to swash_to_invlist() below */
2535     x = (U8*)SvPV(*extssvp, xcur);
2536     xend = x + xcur;
2537     while (x < xend) {
2538         STRLEN namelen;
2539         U8 *namestr;
2540         SV** othersvp;
2541         HV* otherhv;
2542         STRLEN otherbits;
2543         SV **otherbitssvp, *other;
2544         U8 *s, *o, *nl;
2545         STRLEN slen, olen;
2546
2547         const U8 opc = *x++;
2548         if (opc == '\n')
2549             continue;
2550
2551         nl = (U8*)memchr(x, '\n', xend - x);
2552
2553         if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
2554             if (nl) {
2555                 x = nl + 1; /* 1 is length of "\n" */
2556                 continue;
2557             }
2558             else {
2559                 x = xend; /* to EXTRAS' end at which \n is not found */
2560                 break;
2561             }
2562         }
2563
2564         namestr = x;
2565         if (nl) {
2566             namelen = nl - namestr;
2567             x = nl + 1;
2568         }
2569         else {
2570             namelen = xend - namestr;
2571             x = xend;
2572         }
2573
2574         othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
2575         otherhv = MUTABLE_HV(SvRV(*othersvp));
2576         otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
2577         otherbits = (STRLEN)SvUV(*otherbitssvp);
2578         if (bits < otherbits)
2579             Perl_croak(aTHX_ "panic: swash_get found swatch size mismatch");
2580
2581         /* The "other" swatch must be destroyed after. */
2582         other = swash_get(*othersvp, start, span);
2583         o = (U8*)SvPV(other, olen);
2584
2585         if (!olen)
2586             Perl_croak(aTHX_ "panic: swash_get got improper swatch");
2587
2588         s = (U8*)SvPV(swatch, slen);
2589         if (bits == 1 && otherbits == 1) {
2590             if (slen != olen)
2591                 Perl_croak(aTHX_ "panic: swash_get found swatch length mismatch");
2592
2593             switch (opc) {
2594             case '+':
2595                 while (slen--)
2596                     *s++ |= *o++;
2597                 break;
2598             case '!':
2599                 while (slen--)
2600                     *s++ |= ~*o++;
2601                 break;
2602             case '-':
2603                 while (slen--)
2604                     *s++ &= ~*o++;
2605                 break;
2606             case '&':
2607                 while (slen--)
2608                     *s++ &= *o++;
2609                 break;
2610             default:
2611                 break;
2612             }
2613         }
2614         else {
2615             STRLEN otheroctets = otherbits >> 3;
2616             STRLEN offset = 0;
2617             U8* const send = s + slen;
2618
2619             while (s < send) {
2620                 UV otherval = 0;
2621
2622                 if (otherbits == 1) {
2623                     otherval = (o[offset >> 3] >> (offset & 7)) & 1;
2624                     ++offset;
2625                 }
2626                 else {
2627                     STRLEN vlen = otheroctets;
2628                     otherval = *o++;
2629                     while (--vlen) {
2630                         otherval <<= 8;
2631                         otherval |= *o++;
2632                     }
2633                 }
2634
2635                 if (opc == '+' && otherval)
2636                     NOOP;   /* replace with otherval */
2637                 else if (opc == '!' && !otherval)
2638                     otherval = 1;
2639                 else if (opc == '-' && otherval)
2640                     otherval = 0;
2641                 else if (opc == '&' && !otherval)
2642                     otherval = 0;
2643                 else {
2644                     s += octets; /* no replacement */
2645                     continue;
2646                 }
2647
2648                 if (bits == 8)
2649                     *s++ = (U8)( otherval & 0xff);
2650                 else if (bits == 16) {
2651                     *s++ = (U8)((otherval >>  8) & 0xff);
2652                     *s++ = (U8)( otherval        & 0xff);
2653                 }
2654                 else if (bits == 32) {
2655                     *s++ = (U8)((otherval >> 24) & 0xff);
2656                     *s++ = (U8)((otherval >> 16) & 0xff);
2657                     *s++ = (U8)((otherval >>  8) & 0xff);
2658                     *s++ = (U8)( otherval        & 0xff);
2659                 }
2660             }
2661         }
2662         sv_free(other); /* through with it! */
2663     } /* while */
2664     return swatch;
2665 }
2666
2667 HV*
2668 Perl__swash_inversion_hash(pTHX_ SV* const swash)
2669 {
2670
2671    /* Subject to change or removal.  For use only in one place in regcomp.c.
2672     * Can't be used on a property that is subject to user override, as it
2673     * relies on the value of SPECIALS in the swash which would be set by
2674     * utf8_heavy.pl to the hash in the non-overriden file, and hence is not set
2675     * for overridden properties
2676     *
2677     * Returns a hash which is the inversion and closure of a swash mapping.
2678     * For example, consider the input lines:
2679     * 004B              006B
2680     * 004C              006C
2681     * 212A              006B
2682     *
2683     * The returned hash would have two keys, the utf8 for 006B and the utf8 for
2684     * 006C.  The value for each key is an array.  For 006C, the array would
2685     * have a two elements, the utf8 for itself, and for 004C.  For 006B, there
2686     * would be three elements in its array, the utf8 for 006B, 004B and 212A.
2687     *
2688     * Essentially, for any code point, it gives all the code points that map to
2689     * it, or the list of 'froms' for that point.
2690     *
2691     * Currently it ignores any additions or deletions from other swashes,
2692     * looking at just the main body of the swash, and if there are SPECIALS
2693     * in the swash, at that hash
2694     *
2695     * The specials hash can be extra code points, and most likely consists of
2696     * maps from single code points to multiple ones (each expressed as a string
2697     * of utf8 characters).   This function currently returns only 1-1 mappings.
2698     * However consider this possible input in the specials hash:
2699     * "\xEF\xAC\x85" => "\x{0073}\x{0074}",         # U+FB05 => 0073 0074
2700     * "\xEF\xAC\x86" => "\x{0073}\x{0074}",         # U+FB06 => 0073 0074
2701     *
2702     * Both FB05 and FB06 map to the same multi-char sequence, which we don't
2703     * currently handle.  But it also means that FB05 and FB06 are equivalent in
2704     * a 1-1 mapping which we should handle, and this relationship may not be in
2705     * the main table.  Therefore this function examines all the multi-char
2706     * sequences and adds the 1-1 mappings that come out of that.  */
2707
2708     U8 *l, *lend;
2709     STRLEN lcur;
2710     HV *const hv = MUTABLE_HV(SvRV(swash));
2711
2712     /* The string containing the main body of the table */
2713     SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
2714
2715     SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
2716     SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2717     SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
2718     /*SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);*/
2719     const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
2720     const STRLEN bits  = SvUV(*bitssvp);
2721     const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
2722     const UV     none  = SvUV(*nonesvp);
2723     SV **specials_p = hv_fetchs(hv, "SPECIALS", 0);
2724
2725     HV* ret = newHV();
2726
2727     PERL_ARGS_ASSERT__SWASH_INVERSION_HASH;
2728
2729     /* Must have at least 8 bits to get the mappings */
2730     if (bits != 8 && bits != 16 && bits != 32) {
2731         Perl_croak(aTHX_ "panic: swash_inversion_hash doesn't expect bits %"UVuf,
2732                                                  (UV)bits);
2733     }
2734
2735     if (specials_p) { /* It might be "special" (sometimes, but not always, a
2736                         mapping to more than one character */
2737
2738         /* Construct an inverse mapping hash for the specials */
2739         HV * const specials_hv = MUTABLE_HV(SvRV(*specials_p));
2740         HV * specials_inverse = newHV();
2741         char *char_from; /* the lhs of the map */
2742         I32 from_len;   /* its byte length */
2743         char *char_to;  /* the rhs of the map */
2744         I32 to_len;     /* its byte length */
2745         SV *sv_to;      /* and in a sv */
2746         AV* from_list;  /* list of things that map to each 'to' */
2747
2748         hv_iterinit(specials_hv);
2749
2750         /* The keys are the characters (in utf8) that map to the corresponding
2751          * utf8 string value.  Iterate through the list creating the inverse
2752          * list. */
2753         while ((sv_to = hv_iternextsv(specials_hv, &char_from, &from_len))) {
2754             SV** listp;
2755             if (! SvPOK(sv_to)) {
2756                 Perl_croak(aTHX_ "panic: value returned from hv_iternextsv() unexpectedly is not a string");
2757             }
2758             /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Found mapping from %"UVXf", First char of to is %"UVXf"\n", utf8_to_uvchr((U8*) char_from, 0), utf8_to_uvchr((U8*) SvPVX(sv_to), 0)));*/
2759
2760             /* Each key in the inverse list is a mapped-to value, and the key's
2761              * hash value is a list of the strings (each in utf8) that map to
2762              * it.  Those strings are all one character long */
2763             if ((listp = hv_fetch(specials_inverse,
2764                                     SvPVX(sv_to),
2765                                     SvCUR(sv_to), 0)))
2766             {
2767                 from_list = (AV*) *listp;
2768             }
2769             else { /* No entry yet for it: create one */
2770                 from_list = newAV();
2771                 if (! hv_store(specials_inverse,
2772                                 SvPVX(sv_to),
2773                                 SvCUR(sv_to),
2774                                 (SV*) from_list, 0))
2775                 {
2776                     Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2777                 }
2778             }
2779
2780             /* Here have the list associated with this 'to' (perhaps newly
2781              * created and empty).  Just add to it.  Note that we ASSUME that
2782              * the input is guaranteed to not have duplications, so we don't
2783              * check for that.  Duplications just slow down execution time. */
2784             av_push(from_list, newSVpvn_utf8(char_from, from_len, TRUE));
2785         }
2786
2787         /* Here, 'specials_inverse' contains the inverse mapping.  Go through
2788          * it looking for cases like the FB05/FB06 examples above.  There would
2789          * be an entry in the hash like
2790         *       'st' => [ FB05, FB06 ]
2791         * In this example we will create two lists that get stored in the
2792         * returned hash, 'ret':
2793         *       FB05 => [ FB05, FB06 ]
2794         *       FB06 => [ FB05, FB06 ]
2795         *
2796         * Note that there is nothing to do if the array only has one element.
2797         * (In the normal 1-1 case handled below, we don't have to worry about
2798         * two lists, as everything gets tied to the single list that is
2799         * generated for the single character 'to'.  But here, we are omitting
2800         * that list, ('st' in the example), so must have multiple lists.) */
2801         while ((from_list = (AV *) hv_iternextsv(specials_inverse,
2802                                                  &char_to, &to_len)))
2803         {
2804             if (av_len(from_list) > 0) {
2805                 int i;
2806
2807                 /* We iterate over all combinations of i,j to place each code
2808                  * point on each list */
2809                 for (i = 0; i <= av_len(from_list); i++) {
2810                     int j;
2811                     AV* i_list = newAV();
2812                     SV** entryp = av_fetch(from_list, i, FALSE);
2813                     if (entryp == NULL) {
2814                         Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
2815                     }
2816                     if (hv_fetch(ret, SvPVX(*entryp), SvCUR(*entryp), FALSE)) {
2817                         Perl_croak(aTHX_ "panic: unexpected entry for %s", SvPVX(*entryp));
2818                     }
2819                     if (! hv_store(ret, SvPVX(*entryp), SvCUR(*entryp),
2820                                    (SV*) i_list, FALSE))
2821                     {
2822                         Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2823                     }
2824
2825                     /* For debugging: UV u = utf8_to_uvchr((U8*) SvPVX(*entryp), 0);*/
2826                     for (j = 0; j <= av_len(from_list); j++) {
2827                         entryp = av_fetch(from_list, j, FALSE);
2828                         if (entryp == NULL) {
2829                             Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
2830                         }
2831
2832                         /* When i==j this adds itself to the list */
2833                         av_push(i_list, newSVuv(utf8_to_uvchr(
2834                                                 (U8*) SvPVX(*entryp), 0)));
2835                         /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Adding %"UVXf" to list for %"UVXf"\n", utf8_to_uvchr((U8*) SvPVX(*entryp), 0), u));*/
2836                     }
2837                 }
2838             }
2839         }
2840         SvREFCNT_dec(specials_inverse); /* done with it */
2841     } /* End of specials */
2842
2843     /* read $swash->{LIST} */
2844     l = (U8*)SvPV(*listsvp, lcur);
2845     lend = l + lcur;
2846
2847     /* Go through each input line */
2848     while (l < lend) {
2849         UV min, max, val;
2850         UV inverse;
2851         l = S_swash_scan_list_line(aTHX_ l, lend, &min, &max, &val,
2852                                          cBOOL(octets), typestr);
2853         if (l > lend) {
2854             break;
2855         }
2856
2857         /* Each element in the range is to be inverted */
2858         for (inverse = min; inverse <= max; inverse++) {
2859             AV* list;
2860             SV** listp;
2861             IV i;
2862             bool found_key = FALSE;
2863             bool found_inverse = FALSE;
2864
2865             /* The key is the inverse mapping */
2866             char key[UTF8_MAXBYTES+1];
2867             char* key_end = (char *) uvuni_to_utf8((U8*) key, val);
2868             STRLEN key_len = key_end - key;
2869
2870             /* Get the list for the map */
2871             if ((listp = hv_fetch(ret, key, key_len, FALSE))) {
2872                 list = (AV*) *listp;
2873             }
2874             else { /* No entry yet for it: create one */
2875                 list = newAV();
2876                 if (! hv_store(ret, key, key_len, (SV*) list, FALSE)) {
2877                     Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2878                 }
2879             }
2880
2881             /* Look through list to see if this inverse mapping already is
2882              * listed, or if there is a mapping to itself already */
2883             for (i = 0; i <= av_len(list); i++) {
2884                 SV** entryp = av_fetch(list, i, FALSE);
2885                 SV* entry;
2886                 if (entryp == NULL) {
2887                     Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
2888                 }
2889                 entry = *entryp;
2890                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "list for %"UVXf" contains %"UVXf"\n", val, SvUV(entry)));*/
2891                 if (SvUV(entry) == val) {
2892                     found_key = TRUE;
2893                 }
2894                 if (SvUV(entry) == inverse) {
2895                     found_inverse = TRUE;
2896                 }
2897
2898                 /* No need to continue searching if found everything we are
2899                  * looking for */
2900                 if (found_key && found_inverse) {
2901                     break;
2902                 }
2903             }
2904
2905             /* Make sure there is a mapping to itself on the list */
2906             if (! found_key) {
2907                 av_push(list, newSVuv(val));
2908                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Adding %"UVXf" to list for %"UVXf"\n", val, val));*/
2909             }
2910
2911
2912             /* Simply add the value to the list */
2913             if (! found_inverse) {
2914                 av_push(list, newSVuv(inverse));
2915                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Adding %"UVXf" to list for %"UVXf"\n", inverse, val));*/
2916             }
2917
2918             /* swash_get() increments the value of val for each element in the
2919              * range.  That makes more compact tables possible.  You can
2920              * express the capitalization, for example, of all consecutive
2921              * letters with a single line: 0061\t007A\t0041 This maps 0061 to
2922              * 0041, 0062 to 0042, etc.  I (khw) have never understood 'none',
2923              * and it's not documented; it appears to be used only in
2924              * implementing tr//; I copied the semantics from swash_get(), just
2925              * in case */
2926             if (!none || val < none) {
2927                 ++val;
2928             }
2929         }
2930     }
2931
2932     return ret;
2933 }
2934
2935 SV*
2936 Perl__swash_to_invlist(pTHX_ SV* const swash)
2937 {
2938
2939    /* Subject to change or removal.  For use only in one place in regcomp.c */
2940
2941     U8 *l, *lend;
2942     char *loc;
2943     STRLEN lcur;
2944     HV *const hv = MUTABLE_HV(SvRV(swash));
2945     UV elements = 0;    /* Number of elements in the inversion list */
2946     U8 empty[] = "";
2947
2948     /* The string containing the main body of the table */
2949     SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
2950     SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
2951     SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2952     SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
2953     SV** const invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
2954
2955     const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
2956     const STRLEN bits  = SvUV(*bitssvp);
2957     const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
2958     U8 *x, *xend;
2959     STRLEN xcur;
2960
2961     SV* invlist;
2962
2963     PERL_ARGS_ASSERT__SWASH_TO_INVLIST;
2964
2965     /* read $swash->{LIST} */
2966     if (SvPOK(*listsvp)) {
2967         l = (U8*)SvPV(*listsvp, lcur);
2968     }
2969     else {
2970         /* LIST legitimately doesn't contain a string during compilation phases
2971          * of Perl itself, before the Unicode tables are generated.  In this
2972          * case, just fake things up by creating an empty list */
2973         l = empty;
2974         lcur = 0;
2975     }
2976     loc = (char *) l;
2977     lend = l + lcur;
2978
2979     /* Scan the input to count the number of lines to preallocate array size
2980      * based on worst possible case, which is each line in the input creates 2
2981      * elements in the inversion list: 1) the beginning of a range in the list;
2982      * 2) the beginning of a range not in the list.  */
2983     while ((loc = (strchr(loc, '\n'))) != NULL) {
2984         elements += 2;
2985         loc++;
2986     }
2987
2988     /* If the ending is somehow corrupt and isn't a new line, add another
2989      * element for the final range that isn't in the inversion list */
2990     if (! (*lend == '\n' || (*lend == '\0' && *(lend - 1) == '\n'))) {
2991         elements++;
2992     }
2993
2994     invlist = _new_invlist(elements);
2995
2996     /* Now go through the input again, adding each range to the list */
2997     while (l < lend) {
2998         UV start, end;
2999         UV val;         /* Not used by this function */
3000
3001         l = S_swash_scan_list_line(aTHX_ l, lend, &start, &end, &val,
3002                                          cBOOL(octets), typestr);
3003
3004         if (l > lend) {
3005             break;
3006         }
3007
3008         _append_range_to_invlist(invlist, start, end);
3009     }
3010
3011     /* Invert if the data says it should be */
3012     if (invert_it_svp && SvUV(*invert_it_svp)) {
3013         _invlist_invert_prop(invlist);
3014     }
3015
3016     /* This code is copied from swash_get()
3017      * read $swash->{EXTRAS} */
3018     x = (U8*)SvPV(*extssvp, xcur);
3019     xend = x + xcur;
3020     while (x < xend) {
3021         STRLEN namelen;
3022         U8 *namestr;
3023         SV** othersvp;
3024         HV* otherhv;
3025         STRLEN otherbits;
3026         SV **otherbitssvp, *other;
3027         U8 *nl;
3028
3029         const U8 opc = *x++;
3030         if (opc == '\n')
3031             continue;
3032
3033         nl = (U8*)memchr(x, '\n', xend - x);
3034
3035         if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
3036             if (nl) {
3037                 x = nl + 1; /* 1 is length of "\n" */
3038                 continue;
3039             }
3040             else {
3041                 x = xend; /* to EXTRAS' end at which \n is not found */
3042                 break;
3043             }
3044         }
3045
3046         namestr = x;
3047         if (nl) {
3048             namelen = nl - namestr;
3049             x = nl + 1;
3050         }
3051         else {
3052             namelen = xend - namestr;
3053             x = xend;
3054         }
3055
3056         othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
3057         otherhv = MUTABLE_HV(SvRV(*othersvp));
3058         otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
3059         otherbits = (STRLEN)SvUV(*otherbitssvp);
3060
3061         if (bits != otherbits || bits != 1) {
3062             Perl_croak(aTHX_ "panic: _swash_to_invlist only operates on boolean properties");
3063         }
3064
3065         /* The "other" swatch must be destroyed after. */
3066         other = _swash_to_invlist((SV *)*othersvp);
3067
3068         /* End of code copied from swash_get() */
3069         switch (opc) {
3070         case '+':
3071             _invlist_union(invlist, other, &invlist);
3072             break;
3073         case '!':
3074             _invlist_invert(other);
3075             _invlist_union(invlist, other, &invlist);
3076             break;
3077         case '-':
3078             _invlist_subtract(invlist, other, &invlist);
3079             break;
3080         case '&':
3081             _invlist_intersection(invlist, other, &invlist);
3082             break;
3083         default:
3084             break;
3085         }
3086         sv_free(other); /* through with it! */
3087     }
3088
3089     return invlist;
3090 }
3091
3092 /*
3093 =for apidoc uvchr_to_utf8
3094
3095 Adds the UTF-8 representation of the Native code point C<uv> to the end
3096 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
3097 bytes available. The return value is the pointer to the byte after the
3098 end of the new character. In other words,
3099
3100     d = uvchr_to_utf8(d, uv);
3101
3102 is the recommended wide native character-aware way of saying
3103
3104     *(d++) = uv;
3105
3106 =cut
3107 */
3108
3109 /* On ASCII machines this is normally a macro but we want a
3110    real function in case XS code wants it
3111 */
3112 U8 *
3113 Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv)
3114 {
3115     PERL_ARGS_ASSERT_UVCHR_TO_UTF8;
3116
3117     return Perl_uvuni_to_utf8_flags(aTHX_ d, NATIVE_TO_UNI(uv), 0);
3118 }
3119
3120 U8 *
3121 Perl_uvchr_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
3122 {
3123     PERL_ARGS_ASSERT_UVCHR_TO_UTF8_FLAGS;
3124
3125     return Perl_uvuni_to_utf8_flags(aTHX_ d, NATIVE_TO_UNI(uv), flags);
3126 }
3127
3128 /*
3129 =for apidoc utf8n_to_uvchr
3130
3131 Returns the native character value of the first character in the string
3132 C<s>
3133 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
3134 length, in bytes, of that character.
3135
3136 length and flags are the same as utf8n_to_uvuni().
3137
3138 =cut
3139 */
3140 /* On ASCII machines this is normally a macro but we want
3141    a real function in case XS code wants it
3142 */
3143 UV
3144 Perl_utf8n_to_uvchr(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen,
3145 U32 flags)
3146 {
3147     const UV uv = Perl_utf8n_to_uvuni(aTHX_ s, curlen, retlen, flags);
3148
3149     PERL_ARGS_ASSERT_UTF8N_TO_UVCHR;
3150
3151     return UNI_TO_NATIVE(uv);
3152 }
3153
3154 bool
3155 Perl_check_utf8_print(pTHX_ register const U8* s, const STRLEN len)
3156 {
3157     /* May change: warns if surrogates, non-character code points, or
3158      * non-Unicode code points are in s which has length len.  Returns TRUE if
3159      * none found; FALSE otherwise.  The only other validity check is to make
3160      * sure that this won't exceed the string's length */
3161
3162     const U8* const e = s + len;
3163     bool ok = TRUE;
3164
3165     PERL_ARGS_ASSERT_CHECK_UTF8_PRINT;
3166
3167     while (s < e) {
3168         if (UTF8SKIP(s) > len) {
3169             Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
3170                            "%s in %s", unees, PL_op ? OP_DESC(PL_op) : "print");
3171             return FALSE;
3172         }
3173         if (*s >= UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE) {
3174             STRLEN char_len;
3175             if (UTF8_IS_SUPER(s)) {
3176                 if (ckWARN_d(WARN_NON_UNICODE)) {
3177                     UV uv = utf8_to_uvchr(s, &char_len);
3178                     Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
3179                         "Code point 0x%04"UVXf" is not Unicode, may not be portable", uv);
3180                     ok = FALSE;
3181                 }
3182             }
3183             else if (UTF8_IS_SURROGATE(s)) {
3184                 if (ckWARN_d(WARN_SURROGATE)) {
3185                     UV uv = utf8_to_uvchr(s, &char_len);
3186                     Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
3187                         "Unicode surrogate U+%04"UVXf" is illegal in UTF-8", uv);
3188                     ok = FALSE;
3189                 }
3190             }
3191             else if
3192                 ((UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s))
3193                  && (ckWARN_d(WARN_NONCHAR)))
3194             {
3195                 UV uv = utf8_to_uvchr(s, &char_len);
3196                 Perl_warner(aTHX_ packWARN(WARN_NONCHAR),
3197                     "Unicode non-character U+%04"UVXf" is illegal for open interchange", uv);
3198                 ok = FALSE;
3199             }
3200         }
3201         s += UTF8SKIP(s);
3202     }
3203
3204     return ok;
3205 }
3206
3207 /*
3208 =for apidoc pv_uni_display
3209
3210 Build to the scalar dsv a displayable version of the string spv,
3211 length len, the displayable version being at most pvlim bytes long
3212 (if longer, the rest is truncated and "..." will be appended).
3213
3214 The flags argument can have UNI_DISPLAY_ISPRINT set to display
3215 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
3216 to display the \\[nrfta\\] as the backslashed versions (like '\n')
3217 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
3218 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
3219 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
3220
3221 The pointer to the PV of the dsv is returned.
3222
3223 =cut */
3224 char *
3225 Perl_pv_uni_display(pTHX_ SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
3226 {
3227     int truncated = 0;
3228     const char *s, *e;
3229
3230     PERL_ARGS_ASSERT_PV_UNI_DISPLAY;
3231
3232     sv_setpvs(dsv, "");
3233     SvUTF8_off(dsv);
3234     for (s = (const char *)spv, e = s + len; s < e; s += UTF8SKIP(s)) {
3235          UV u;
3236           /* This serves double duty as a flag and a character to print after
3237              a \ when flags & UNI_DISPLAY_BACKSLASH is true.
3238           */
3239          char ok = 0;
3240
3241          if (pvlim && SvCUR(dsv) >= pvlim) {
3242               truncated++;
3243               break;
3244          }
3245          u = utf8_to_uvchr((U8*)s, 0);
3246          if (u < 256) {
3247              const unsigned char c = (unsigned char)u & 0xFF;
3248              if (flags & UNI_DISPLAY_BACKSLASH) {
3249                  switch (c) {
3250                  case '\n':
3251                      ok = 'n'; break;
3252                  case '\r':
3253                      ok = 'r'; break;
3254                  case '\t':
3255                      ok = 't'; break;
3256                  case '\f':
3257                      ok = 'f'; break;
3258                  case '\a':
3259                      ok = 'a'; break;
3260                  case '\\':
3261                      ok = '\\'; break;
3262                  default: break;
3263                  }
3264                  if (ok) {
3265                      const char string = ok;
3266                      sv_catpvs(dsv, "\\");
3267                      sv_catpvn(dsv, &string, 1);
3268                  }
3269              }
3270              /* isPRINT() is the locale-blind version. */
3271              if (!ok && (flags & UNI_DISPLAY_ISPRINT) && isPRINT(c)) {
3272                  const char string = c;
3273                  sv_catpvn(dsv, &string, 1);
3274                  ok = 1;
3275              }
3276          }
3277          if (!ok)
3278              Perl_sv_catpvf(aTHX_ dsv, "\\x{%"UVxf"}", u);
3279     }
3280     if (truncated)
3281          sv_catpvs(dsv, "...");
3282
3283     return SvPVX(dsv);
3284 }
3285
3286 /*
3287 =for apidoc sv_uni_display
3288
3289 Build to the scalar dsv a displayable version of the scalar sv,
3290 the displayable version being at most pvlim bytes long
3291 (if longer, the rest is truncated and "..." will be appended).
3292
3293 The flags argument is as in pv_uni_display().
3294
3295 The pointer to the PV of the dsv is returned.
3296
3297 =cut
3298 */
3299 char *
3300 Perl_sv_uni_display(pTHX_ SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
3301 {
3302     PERL_ARGS_ASSERT_SV_UNI_DISPLAY;
3303
3304      return Perl_pv_uni_display(aTHX_ dsv, (const U8*)SvPVX_const(ssv),
3305                                 SvCUR(ssv), pvlim, flags);
3306 }
3307
3308 /*
3309 =for apidoc foldEQ_utf8
3310
3311 Returns true if the leading portions of the strings s1 and s2 (either or both
3312 of which may be in UTF-8) are the same case-insensitively; false otherwise.
3313 How far into the strings to compare is determined by other input parameters.
3314
3315 If u1 is true, the string s1 is assumed to be in UTF-8-encoded Unicode;
3316 otherwise it is assumed to be in native 8-bit encoding.  Correspondingly for u2
3317 with respect to s2.
3318
3319 If the byte length l1 is non-zero, it says how far into s1 to check for fold
3320 equality.  In other words, s1+l1 will be used as a goal to reach.  The
3321 scan will not be considered to be a match unless the goal is reached, and
3322 scanning won't continue past that goal.  Correspondingly for l2 with respect to
3323 s2.
3324
3325 If pe1 is non-NULL and the pointer it points to is not NULL, that pointer is
3326 considered an end pointer beyond which scanning of s1 will not continue under
3327 any circumstances.  This means that if both l1 and pe1 are specified, and pe1
3328 is less than s1+l1, the match will never be successful because it can never
3329 get as far as its goal (and in fact is asserted against).  Correspondingly for
3330 pe2 with respect to s2.
3331
3332 At least one of s1 and s2 must have a goal (at least one of l1 and l2 must be
3333 non-zero), and if both do, both have to be
3334 reached for a successful match.   Also, if the fold of a character is multiple
3335 characters, all of them must be matched (see tr21 reference below for
3336 'folding').
3337
3338 Upon a successful match, if pe1 is non-NULL,
3339 it will be set to point to the beginning of the I<next> character of s1 beyond
3340 what was matched.  Correspondingly for pe2 and s2.
3341
3342 For case-insensitiveness, the "casefolding" of Unicode is used
3343 instead of upper/lowercasing both the characters, see
3344 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
3345
3346 =cut */
3347
3348 /* A flags parameter has been added which may change, and hence isn't
3349  * externally documented.  Currently it is:
3350  *  0 for as-documented above
3351  *  FOLDEQ_UTF8_NOMIX_ASCII meaning that if a non-ASCII character folds to an
3352                             ASCII one, to not match
3353  *  FOLDEQ_UTF8_LOCALE      meaning that locale rules are to be used for code
3354  *                          points below 256; unicode rules for above 255; and
3355  *                          folds that cross those boundaries are disallowed,
3356  *                          like the NOMIX_ASCII option
3357  */
3358 I32
3359 Perl_foldEQ_utf8_flags(pTHX_ const char *s1, char **pe1, register UV l1, bool u1, const char *s2, char **pe2, register UV l2, bool u2, U32 flags)
3360 {
3361     dVAR;
3362     register const U8 *p1  = (const U8*)s1; /* Point to current char */
3363     register const U8 *p2  = (const U8*)s2;
3364     register const U8 *g1 = NULL;       /* goal for s1 */
3365     register const U8 *g2 = NULL;
3366     register const U8 *e1 = NULL;       /* Don't scan s1 past this */
3367     register U8 *f1 = NULL;             /* Point to current folded */
3368     register const U8 *e2 = NULL;
3369     register U8 *f2 = NULL;
3370     STRLEN n1 = 0, n2 = 0;              /* Number of bytes in current char */
3371     U8 foldbuf1[UTF8_MAXBYTES_CASE+1];
3372     U8 foldbuf2[UTF8_MAXBYTES_CASE+1];
3373     U8 natbuf[2];               /* Holds native 8-bit char converted to utf8;
3374                                    these always fit in 2 bytes */
3375
3376     PERL_ARGS_ASSERT_FOLDEQ_UTF8_FLAGS;
3377
3378     if (pe1) {
3379         e1 = *(U8**)pe1;
3380     }
3381
3382     if (l1) {
3383         g1 = (const U8*)s1 + l1;
3384     }
3385
3386     if (pe2) {
3387         e2 = *(U8**)pe2;
3388     }
3389
3390     if (l2) {
3391         g2 = (const U8*)s2 + l2;
3392     }
3393
3394     /* Must have at least one goal */
3395     assert(g1 || g2);
3396
3397     if (g1) {
3398
3399         /* Will never match if goal is out-of-bounds */
3400         assert(! e1  || e1 >= g1);
3401
3402         /* Here, there isn't an end pointer, or it is beyond the goal.  We
3403         * only go as far as the goal */
3404         e1 = g1;
3405     }
3406     else {
3407         assert(e1);    /* Must have an end for looking at s1 */
3408     }
3409
3410     /* Same for goal for s2 */
3411     if (g2) {
3412         assert(! e2  || e2 >= g2);
3413         e2 = g2;
3414     }
3415     else {
3416         assert(e2);
3417     }
3418
3419     /* Look through both strings, a character at a time */
3420     while (p1 < e1 && p2 < e2) {
3421
3422         /* If at the beginning of a new character in s1, get its fold to use
3423          * and the length of the fold.  (exception: locale rules just get the
3424          * character to a single byte) */
3425         if (n1 == 0) {
3426
3427             /* If in locale matching, we use two sets of rules, depending on if
3428              * the code point is above or below 255.  Here, we test for and
3429              * handle locale rules */
3430             if ((flags & FOLDEQ_UTF8_LOCALE)
3431                 && (! u1 || UTF8_IS_INVARIANT(*p1) || UTF8_IS_DOWNGRADEABLE_START(*p1)))
3432             {
3433                 /* There is no mixing of code points above and below 255. */
3434                 if (u2 && (! UTF8_IS_INVARIANT(*p2)
3435                     && ! UTF8_IS_DOWNGRADEABLE_START(*p2)))
3436                 {
3437                     return 0;
3438                 }
3439
3440                 /* We handle locale rules by converting, if necessary, the code
3441                  * point to a single byte. */
3442                 if (! u1 || UTF8_IS_INVARIANT(*p1)) {
3443                     *foldbuf1 = *p1;
3444                 }
3445                 else {
3446                     *foldbuf1 = TWO_BYTE_UTF8_TO_UNI(*p1, *(p1 + 1));
3447                 }
3448                 n1 = 1;
3449             }
3450             else if (isASCII(*p1)) {    /* Note, that here won't be both ASCII
3451                                            and using locale rules */
3452
3453                 /* If trying to mix non- with ASCII, and not supposed to, fail */
3454                 if ((flags & FOLDEQ_UTF8_NOMIX_ASCII) && ! isASCII(*p2)) {
3455                     return 0;
3456                 }
3457                 n1 = 1;
3458                 *foldbuf1 = toLOWER(*p1);   /* Folds in the ASCII range are
3459                                                just lowercased */
3460             }
3461             else if (u1) {
3462                 to_utf8_fold(p1, foldbuf1, &n1);
3463             }
3464             else {  /* Not utf8, convert to it first and then get fold */
3465                 uvuni_to_utf8(natbuf, (UV) NATIVE_TO_UNI(((UV)*p1)));
3466                 to_utf8_fold(natbuf, foldbuf1, &n1);
3467             }
3468             f1 = foldbuf1;
3469         }
3470
3471         if (n2 == 0) {    /* Same for s2 */
3472             if ((flags & FOLDEQ_UTF8_LOCALE)
3473                 && (! u2 || UTF8_IS_INVARIANT(*p2) || UTF8_IS_DOWNGRADEABLE_START(*p2)))
3474             {
3475                 /* Here, the next char in s2 is < 256.  We've already worked on
3476                  * s1, and if it isn't also < 256, can't match */
3477                 if (u1 && (! UTF8_IS_INVARIANT(*p1)
3478                     && ! UTF8_IS_DOWNGRADEABLE_START(*p1)))
3479                 {
3480                     return 0;
3481                 }
3482                 if (! u2 || UTF8_IS_INVARIANT(*p2)) {
3483                     *foldbuf2 = *p2;
3484                 }
3485                 else {
3486                     *foldbuf2 = TWO_BYTE_UTF8_TO_UNI(*p2, *(p2 + 1));
3487                 }
3488
3489                 /* Use another function to handle locale rules.  We've made
3490                  * sure that both characters to compare are single bytes */
3491                 if (! foldEQ_locale((char *) f1, (char *) foldbuf2, 1)) {
3492                     return 0;
3493                 }
3494                 n1 = n2 = 0;
3495             }
3496             else if (isASCII(*p2)) {
3497                 if (flags && ! isASCII(*p1)) {
3498                     return 0;
3499                 }
3500                 n2 = 1;
3501                 *foldbuf2 = toLOWER(*p2);
3502             }
3503             else if (u2) {
3504                 to_utf8_fold(p2, foldbuf2, &n2);
3505             }
3506             else {
3507                 uvuni_to_utf8(natbuf, (UV) NATIVE_TO_UNI(((UV)*p2)));
3508                 to_utf8_fold(natbuf, foldbuf2, &n2);
3509             }
3510             f2 = foldbuf2;
3511         }
3512
3513         /* Here f1 and f2 point to the beginning of the strings to compare.
3514          * These strings are the folds of the input characters, stored in utf8.
3515          */
3516
3517         /* While there is more to look for in both folds, see if they
3518         * continue to match */
3519         while (n1 && n2) {
3520             U8 fold_length = UTF8SKIP(f1);
3521             if (fold_length != UTF8SKIP(f2)
3522                 || (fold_length == 1 && *f1 != *f2) /* Short circuit memNE
3523                                                        function call for single
3524                                                        character */
3525                 || memNE((char*)f1, (char*)f2, fold_length))
3526             {
3527                 return 0; /* mismatch */
3528             }
3529
3530             /* Here, they matched, advance past them */
3531             n1 -= fold_length;
3532             f1 += fold_length;
3533             n2 -= fold_length;
3534             f2 += fold_length;
3535         }
3536
3537         /* When reach the end of any fold, advance the input past it */
3538         if (n1 == 0) {
3539             p1 += u1 ? UTF8SKIP(p1) : 1;
3540         }
3541         if (n2 == 0) {
3542             p2 += u2 ? UTF8SKIP(p2) : 1;
3543         }
3544     } /* End of loop through both strings */
3545
3546     /* A match is defined by each scan that specified an explicit length
3547     * reaching its final goal, and the other not having matched a partial
3548     * character (which can happen when the fold of a character is more than one
3549     * character). */
3550     if (! ((g1 == 0 || p1 == g1) && (g2 == 0 || p2 == g2)) || n1 || n2) {
3551         return 0;
3552     }
3553
3554     /* Successful match.  Set output pointers */
3555     if (pe1) {
3556         *pe1 = (char*)p1;
3557     }
3558     if (pe2) {
3559         *pe2 = (char*)p2;
3560     }
3561     return 1;
3562 }
3563
3564 /*
3565  * Local variables:
3566  * c-indentation-style: bsd
3567  * c-basic-offset: 4
3568  * indent-tabs-mode: t
3569  * End:
3570  *
3571  * ex: set ts=8 sts=4 sw=4 noet:
3572  */