fix a typo in a comment
[perl.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
1215 bool
1216 Perl_is_uni_alnum(pTHX_ UV c)
1217 {
1218     U8 tmpbuf[UTF8_MAXBYTES+1];
1219     uvchr_to_utf8(tmpbuf, c);
1220     return is_utf8_alnum(tmpbuf);
1221 }
1222
1223 bool
1224 Perl_is_uni_idfirst(pTHX_ UV c)
1225 {
1226     U8 tmpbuf[UTF8_MAXBYTES+1];
1227     uvchr_to_utf8(tmpbuf, c);
1228     return is_utf8_idfirst(tmpbuf);
1229 }
1230
1231 bool
1232 Perl_is_uni_alpha(pTHX_ UV c)
1233 {
1234     U8 tmpbuf[UTF8_MAXBYTES+1];
1235     uvchr_to_utf8(tmpbuf, c);
1236     return is_utf8_alpha(tmpbuf);
1237 }
1238
1239 bool
1240 Perl_is_uni_ascii(pTHX_ UV c)
1241 {
1242     return isASCII(c);
1243 }
1244
1245 bool
1246 Perl_is_uni_space(pTHX_ UV c)
1247 {
1248     U8 tmpbuf[UTF8_MAXBYTES+1];
1249     uvchr_to_utf8(tmpbuf, c);
1250     return is_utf8_space(tmpbuf);
1251 }
1252
1253 bool
1254 Perl_is_uni_digit(pTHX_ UV c)
1255 {
1256     U8 tmpbuf[UTF8_MAXBYTES+1];
1257     uvchr_to_utf8(tmpbuf, c);
1258     return is_utf8_digit(tmpbuf);
1259 }
1260
1261 bool
1262 Perl_is_uni_upper(pTHX_ UV c)
1263 {
1264     U8 tmpbuf[UTF8_MAXBYTES+1];
1265     uvchr_to_utf8(tmpbuf, c);
1266     return is_utf8_upper(tmpbuf);
1267 }
1268
1269 bool
1270 Perl_is_uni_lower(pTHX_ UV c)
1271 {
1272     U8 tmpbuf[UTF8_MAXBYTES+1];
1273     uvchr_to_utf8(tmpbuf, c);
1274     return is_utf8_lower(tmpbuf);
1275 }
1276
1277 bool
1278 Perl_is_uni_cntrl(pTHX_ UV c)
1279 {
1280     return isCNTRL_L1(c);
1281 }
1282
1283 bool
1284 Perl_is_uni_graph(pTHX_ UV c)
1285 {
1286     U8 tmpbuf[UTF8_MAXBYTES+1];
1287     uvchr_to_utf8(tmpbuf, c);
1288     return is_utf8_graph(tmpbuf);
1289 }
1290
1291 bool
1292 Perl_is_uni_print(pTHX_ UV c)
1293 {
1294     U8 tmpbuf[UTF8_MAXBYTES+1];
1295     uvchr_to_utf8(tmpbuf, c);
1296     return is_utf8_print(tmpbuf);
1297 }
1298
1299 bool
1300 Perl_is_uni_punct(pTHX_ UV c)
1301 {
1302     U8 tmpbuf[UTF8_MAXBYTES+1];
1303     uvchr_to_utf8(tmpbuf, c);
1304     return is_utf8_punct(tmpbuf);
1305 }
1306
1307 bool
1308 Perl_is_uni_xdigit(pTHX_ UV c)
1309 {
1310     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1311     uvchr_to_utf8(tmpbuf, c);
1312     return is_utf8_xdigit(tmpbuf);
1313 }
1314
1315 UV
1316 Perl_to_uni_upper(pTHX_ UV c, U8* p, STRLEN *lenp)
1317 {
1318     PERL_ARGS_ASSERT_TO_UNI_UPPER;
1319
1320     uvchr_to_utf8(p, c);
1321     return to_utf8_upper(p, p, lenp);
1322 }
1323
1324 UV
1325 Perl_to_uni_title(pTHX_ UV c, U8* p, STRLEN *lenp)
1326 {
1327     PERL_ARGS_ASSERT_TO_UNI_TITLE;
1328
1329     uvchr_to_utf8(p, c);
1330     return to_utf8_title(p, p, lenp);
1331 }
1332
1333 UV
1334 Perl_to_uni_lower(pTHX_ UV c, U8* p, STRLEN *lenp)
1335 {
1336     PERL_ARGS_ASSERT_TO_UNI_LOWER;
1337
1338     uvchr_to_utf8(p, c);
1339     return to_utf8_lower(p, p, lenp);
1340 }
1341
1342 UV
1343 Perl__to_uni_fold_flags(pTHX_ UV c, U8* p, STRLEN *lenp, U8 flags)
1344 {
1345     PERL_ARGS_ASSERT__TO_UNI_FOLD_FLAGS;
1346
1347     uvchr_to_utf8(p, c);
1348     return _to_utf8_fold_flags(p, p, lenp, flags);
1349 }
1350
1351 /* for now these all assume no locale info available for Unicode > 255 */
1352
1353 bool
1354 Perl_is_uni_alnum_lc(pTHX_ UV c)
1355 {
1356     return is_uni_alnum(c);     /* XXX no locale support yet */
1357 }
1358
1359 bool
1360 Perl_is_uni_idfirst_lc(pTHX_ UV c)
1361 {
1362     return is_uni_idfirst(c);   /* XXX no locale support yet */
1363 }
1364
1365 bool
1366 Perl_is_uni_alpha_lc(pTHX_ UV c)
1367 {
1368     return is_uni_alpha(c);     /* XXX no locale support yet */
1369 }
1370
1371 bool
1372 Perl_is_uni_ascii_lc(pTHX_ UV c)
1373 {
1374     return is_uni_ascii(c);     /* XXX no locale support yet */
1375 }
1376
1377 bool
1378 Perl_is_uni_space_lc(pTHX_ UV c)
1379 {
1380     return is_uni_space(c);     /* XXX no locale support yet */
1381 }
1382
1383 bool
1384 Perl_is_uni_digit_lc(pTHX_ UV c)
1385 {
1386     return is_uni_digit(c);     /* XXX no locale support yet */
1387 }
1388
1389 bool
1390 Perl_is_uni_upper_lc(pTHX_ UV c)
1391 {
1392     return is_uni_upper(c);     /* XXX no locale support yet */
1393 }
1394
1395 bool
1396 Perl_is_uni_lower_lc(pTHX_ UV c)
1397 {
1398     return is_uni_lower(c);     /* XXX no locale support yet */
1399 }
1400
1401 bool
1402 Perl_is_uni_cntrl_lc(pTHX_ UV c)
1403 {
1404     return is_uni_cntrl(c);     /* XXX no locale support yet */
1405 }
1406
1407 bool
1408 Perl_is_uni_graph_lc(pTHX_ UV c)
1409 {
1410     return is_uni_graph(c);     /* XXX no locale support yet */
1411 }
1412
1413 bool
1414 Perl_is_uni_print_lc(pTHX_ UV c)
1415 {
1416     return is_uni_print(c);     /* XXX no locale support yet */
1417 }
1418
1419 bool
1420 Perl_is_uni_punct_lc(pTHX_ UV c)
1421 {
1422     return is_uni_punct(c);     /* XXX no locale support yet */
1423 }
1424
1425 bool
1426 Perl_is_uni_xdigit_lc(pTHX_ UV c)
1427 {
1428     return is_uni_xdigit(c);    /* XXX no locale support yet */
1429 }
1430
1431 U32
1432 Perl_to_uni_upper_lc(pTHX_ U32 c)
1433 {
1434     /* XXX returns only the first character -- do not use XXX */
1435     /* XXX no locale support yet */
1436     STRLEN len;
1437     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1438     return (U32)to_uni_upper(c, tmpbuf, &len);
1439 }
1440
1441 U32
1442 Perl_to_uni_title_lc(pTHX_ U32 c)
1443 {
1444     /* XXX returns only the first character XXX -- do not use XXX */
1445     /* XXX no locale support yet */
1446     STRLEN len;
1447     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1448     return (U32)to_uni_title(c, tmpbuf, &len);
1449 }
1450
1451 U32
1452 Perl_to_uni_lower_lc(pTHX_ U32 c)
1453 {
1454     /* XXX returns only the first character -- do not use XXX */
1455     /* XXX no locale support yet */
1456     STRLEN len;
1457     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1458     return (U32)to_uni_lower(c, tmpbuf, &len);
1459 }
1460
1461 static bool
1462 S_is_utf8_common(pTHX_ const U8 *const p, SV **swash,
1463                  const char *const swashname)
1464 {
1465     dVAR;
1466
1467     PERL_ARGS_ASSERT_IS_UTF8_COMMON;
1468
1469     if (!is_utf8_char(p))
1470         return FALSE;
1471     if (!*swash)
1472         *swash = swash_init("utf8", swashname, &PL_sv_undef, 1, 0);
1473     return swash_fetch(*swash, p, TRUE) != 0;
1474 }
1475
1476 bool
1477 Perl_is_utf8_alnum(pTHX_ const U8 *p)
1478 {
1479     dVAR;
1480
1481     PERL_ARGS_ASSERT_IS_UTF8_ALNUM;
1482
1483     /* NOTE: "IsWord", not "IsAlnum", since Alnum is a true
1484      * descendant of isalnum(3), in other words, it doesn't
1485      * contain the '_'. --jhi */
1486     return is_utf8_common(p, &PL_utf8_alnum, "IsWord");
1487 }
1488
1489 bool
1490 Perl_is_utf8_idfirst(pTHX_ const U8 *p) /* The naming is historical. */
1491 {
1492     dVAR;
1493
1494     PERL_ARGS_ASSERT_IS_UTF8_IDFIRST;
1495
1496     if (*p == '_')
1497         return TRUE;
1498     /* is_utf8_idstart would be more logical. */
1499     return is_utf8_common(p, &PL_utf8_idstart, "IdStart");
1500 }
1501
1502 bool
1503 Perl_is_utf8_xidfirst(pTHX_ const U8 *p) /* The naming is historical. */
1504 {
1505     dVAR;
1506
1507     PERL_ARGS_ASSERT_IS_UTF8_XIDFIRST;
1508
1509     if (*p == '_')
1510         return TRUE;
1511     /* is_utf8_idstart would be more logical. */
1512     return is_utf8_common(p, &PL_utf8_xidstart, "XIdStart");
1513 }
1514
1515 bool
1516 Perl__is_utf8__perl_idstart(pTHX_ const U8 *p)
1517 {
1518     dVAR;
1519
1520     PERL_ARGS_ASSERT__IS_UTF8__PERL_IDSTART;
1521
1522     return is_utf8_common(p, &PL_utf8_perl_idstart, "_Perl_IDStart");
1523 }
1524
1525 bool
1526 Perl_is_utf8_idcont(pTHX_ const U8 *p)
1527 {
1528     dVAR;
1529
1530     PERL_ARGS_ASSERT_IS_UTF8_IDCONT;
1531
1532     return is_utf8_common(p, &PL_utf8_idcont, "IdContinue");
1533 }
1534
1535 bool
1536 Perl_is_utf8_xidcont(pTHX_ const U8 *p)
1537 {
1538     dVAR;
1539
1540     PERL_ARGS_ASSERT_IS_UTF8_XIDCONT;
1541
1542     return is_utf8_common(p, &PL_utf8_idcont, "XIdContinue");
1543 }
1544
1545 bool
1546 Perl_is_utf8_alpha(pTHX_ const U8 *p)
1547 {
1548     dVAR;
1549
1550     PERL_ARGS_ASSERT_IS_UTF8_ALPHA;
1551
1552     return is_utf8_common(p, &PL_utf8_alpha, "IsAlpha");
1553 }
1554
1555 bool
1556 Perl_is_utf8_ascii(pTHX_ const U8 *p)
1557 {
1558     dVAR;
1559
1560     PERL_ARGS_ASSERT_IS_UTF8_ASCII;
1561
1562     /* ASCII characters are the same whether in utf8 or not.  So the macro
1563      * works on both utf8 and non-utf8 representations. */
1564     return isASCII(*p);
1565 }
1566
1567 bool
1568 Perl_is_utf8_space(pTHX_ const U8 *p)
1569 {
1570     dVAR;
1571
1572     PERL_ARGS_ASSERT_IS_UTF8_SPACE;
1573
1574     return is_utf8_common(p, &PL_utf8_space, "IsXPerlSpace");
1575 }
1576
1577 bool
1578 Perl_is_utf8_perl_space(pTHX_ const U8 *p)
1579 {
1580     dVAR;
1581
1582     PERL_ARGS_ASSERT_IS_UTF8_PERL_SPACE;
1583
1584     /* Only true if is an ASCII space-like character, and ASCII is invariant
1585      * under utf8, so can just use the macro */
1586     return isSPACE_A(*p);
1587 }
1588
1589 bool
1590 Perl_is_utf8_perl_word(pTHX_ const U8 *p)
1591 {
1592     dVAR;
1593
1594     PERL_ARGS_ASSERT_IS_UTF8_PERL_WORD;
1595
1596     /* Only true if is an ASCII word character, and ASCII is invariant
1597      * under utf8, so can just use the macro */
1598     return isWORDCHAR_A(*p);
1599 }
1600
1601 bool
1602 Perl_is_utf8_digit(pTHX_ const U8 *p)
1603 {
1604     dVAR;
1605
1606     PERL_ARGS_ASSERT_IS_UTF8_DIGIT;
1607
1608     return is_utf8_common(p, &PL_utf8_digit, "IsDigit");
1609 }
1610
1611 bool
1612 Perl_is_utf8_posix_digit(pTHX_ const U8 *p)
1613 {
1614     dVAR;
1615
1616     PERL_ARGS_ASSERT_IS_UTF8_POSIX_DIGIT;
1617
1618     /* Only true if is an ASCII digit character, and ASCII is invariant
1619      * under utf8, so can just use the macro */
1620     return isDIGIT_A(*p);
1621 }
1622
1623 bool
1624 Perl_is_utf8_upper(pTHX_ const U8 *p)
1625 {
1626     dVAR;
1627
1628     PERL_ARGS_ASSERT_IS_UTF8_UPPER;
1629
1630     return is_utf8_common(p, &PL_utf8_upper, "IsUppercase");
1631 }
1632
1633 bool
1634 Perl_is_utf8_lower(pTHX_ const U8 *p)
1635 {
1636     dVAR;
1637
1638     PERL_ARGS_ASSERT_IS_UTF8_LOWER;
1639
1640     return is_utf8_common(p, &PL_utf8_lower, "IsLowercase");
1641 }
1642
1643 bool
1644 Perl_is_utf8_cntrl(pTHX_ const U8 *p)
1645 {
1646     dVAR;
1647
1648     PERL_ARGS_ASSERT_IS_UTF8_CNTRL;
1649
1650     if (isASCII(*p)) {
1651         return isCNTRL_A(*p);
1652     }
1653
1654     /* All controls are in Latin1 */
1655     if (! UTF8_IS_DOWNGRADEABLE_START(*p)) {
1656         return 0;
1657     }
1658     return isCNTRL_L1(TWO_BYTE_UTF8_TO_UNI(*p, *(p+1)));
1659 }
1660
1661 bool
1662 Perl_is_utf8_graph(pTHX_ const U8 *p)
1663 {
1664     dVAR;
1665
1666     PERL_ARGS_ASSERT_IS_UTF8_GRAPH;
1667
1668     return is_utf8_common(p, &PL_utf8_graph, "IsGraph");
1669 }
1670
1671 bool
1672 Perl_is_utf8_print(pTHX_ const U8 *p)
1673 {
1674     dVAR;
1675
1676     PERL_ARGS_ASSERT_IS_UTF8_PRINT;
1677
1678     return is_utf8_common(p, &PL_utf8_print, "IsPrint");
1679 }
1680
1681 bool
1682 Perl_is_utf8_punct(pTHX_ const U8 *p)
1683 {
1684     dVAR;
1685
1686     PERL_ARGS_ASSERT_IS_UTF8_PUNCT;
1687
1688     return is_utf8_common(p, &PL_utf8_punct, "IsPunct");
1689 }
1690
1691 bool
1692 Perl_is_utf8_xdigit(pTHX_ const U8 *p)
1693 {
1694     dVAR;
1695
1696     PERL_ARGS_ASSERT_IS_UTF8_XDIGIT;
1697
1698     return is_utf8_common(p, &PL_utf8_xdigit, "IsXDigit");
1699 }
1700
1701 bool
1702 Perl_is_utf8_mark(pTHX_ const U8 *p)
1703 {
1704     dVAR;
1705
1706     PERL_ARGS_ASSERT_IS_UTF8_MARK;
1707
1708     return is_utf8_common(p, &PL_utf8_mark, "IsM");
1709 }
1710
1711 bool
1712 Perl_is_utf8_X_begin(pTHX_ const U8 *p)
1713 {
1714     dVAR;
1715
1716     PERL_ARGS_ASSERT_IS_UTF8_X_BEGIN;
1717
1718     return is_utf8_common(p, &PL_utf8_X_begin, "_X_Begin");
1719 }
1720
1721 bool
1722 Perl_is_utf8_X_extend(pTHX_ const U8 *p)
1723 {
1724     dVAR;
1725
1726     PERL_ARGS_ASSERT_IS_UTF8_X_EXTEND;
1727
1728     return is_utf8_common(p, &PL_utf8_X_extend, "_X_Extend");
1729 }
1730
1731 bool
1732 Perl_is_utf8_X_prepend(pTHX_ const U8 *p)
1733 {
1734     dVAR;
1735
1736     PERL_ARGS_ASSERT_IS_UTF8_X_PREPEND;
1737
1738     return is_utf8_common(p, &PL_utf8_X_prepend, "GCB=Prepend");
1739 }
1740
1741 bool
1742 Perl_is_utf8_X_non_hangul(pTHX_ const U8 *p)
1743 {
1744     dVAR;
1745
1746     PERL_ARGS_ASSERT_IS_UTF8_X_NON_HANGUL;
1747
1748     return is_utf8_common(p, &PL_utf8_X_non_hangul, "HST=Not_Applicable");
1749 }
1750
1751 bool
1752 Perl_is_utf8_X_L(pTHX_ const U8 *p)
1753 {
1754     dVAR;
1755
1756     PERL_ARGS_ASSERT_IS_UTF8_X_L;
1757
1758     return is_utf8_common(p, &PL_utf8_X_L, "GCB=L");
1759 }
1760
1761 bool
1762 Perl_is_utf8_X_LV(pTHX_ const U8 *p)
1763 {
1764     dVAR;
1765
1766     PERL_ARGS_ASSERT_IS_UTF8_X_LV;
1767
1768     return is_utf8_common(p, &PL_utf8_X_LV, "GCB=LV");
1769 }
1770
1771 bool
1772 Perl_is_utf8_X_LVT(pTHX_ const U8 *p)
1773 {
1774     dVAR;
1775
1776     PERL_ARGS_ASSERT_IS_UTF8_X_LVT;
1777
1778     return is_utf8_common(p, &PL_utf8_X_LVT, "GCB=LVT");
1779 }
1780
1781 bool
1782 Perl_is_utf8_X_T(pTHX_ const U8 *p)
1783 {
1784     dVAR;
1785
1786     PERL_ARGS_ASSERT_IS_UTF8_X_T;
1787
1788     return is_utf8_common(p, &PL_utf8_X_T, "GCB=T");
1789 }
1790
1791 bool
1792 Perl_is_utf8_X_V(pTHX_ const U8 *p)
1793 {
1794     dVAR;
1795
1796     PERL_ARGS_ASSERT_IS_UTF8_X_V;
1797
1798     return is_utf8_common(p, &PL_utf8_X_V, "GCB=V");
1799 }
1800
1801 bool
1802 Perl_is_utf8_X_LV_LVT_V(pTHX_ const U8 *p)
1803 {
1804     dVAR;
1805
1806     PERL_ARGS_ASSERT_IS_UTF8_X_LV_LVT_V;
1807
1808     return is_utf8_common(p, &PL_utf8_X_LV_LVT_V, "_X_LV_LVT_V");
1809 }
1810
1811 /*
1812 =for apidoc to_utf8_case
1813
1814 The "p" contains the pointer to the UTF-8 string encoding
1815 the character that is being converted.
1816
1817 The "ustrp" is a pointer to the character buffer to put the
1818 conversion result to.  The "lenp" is a pointer to the length
1819 of the result.
1820
1821 The "swashp" is a pointer to the swash to use.
1822
1823 Both the special and normal mappings are stored in lib/unicore/To/Foo.pl,
1824 and loaded by SWASHNEW, using lib/utf8_heavy.pl.  The special (usually,
1825 but not always, a multicharacter mapping), is tried first.
1826
1827 The "special" is a string like "utf8::ToSpecLower", which means the
1828 hash %utf8::ToSpecLower.  The access to the hash is through
1829 Perl_to_utf8_case().
1830
1831 The "normal" is a string like "ToLower" which means the swash
1832 %utf8::ToLower.
1833
1834 =cut */
1835
1836 UV
1837 Perl_to_utf8_case(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp,
1838                         SV **swashp, const char *normal, const char *special)
1839 {
1840     dVAR;
1841     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1842     STRLEN len = 0;
1843     const UV uv0 = utf8_to_uvchr(p, NULL);
1844     /* The NATIVE_TO_UNI() and UNI_TO_NATIVE() mappings
1845      * are necessary in EBCDIC, they are redundant no-ops
1846      * in ASCII-ish platforms, and hopefully optimized away. */
1847     const UV uv1 = NATIVE_TO_UNI(uv0);
1848
1849     PERL_ARGS_ASSERT_TO_UTF8_CASE;
1850
1851     /* Note that swash_fetch() doesn't output warnings for these because it
1852      * assumes we will */
1853     if (uv1 >= UNICODE_SURROGATE_FIRST) {
1854         if (uv1 <= UNICODE_SURROGATE_LAST) {
1855             if (ckWARN_d(WARN_SURROGATE)) {
1856                 const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
1857                 Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
1858                     "Operation \"%s\" returns its argument for UTF-16 surrogate U+%04"UVXf"", desc, uv1);
1859             }
1860         }
1861         else if (UNICODE_IS_SUPER(uv1)) {
1862             if (ckWARN_d(WARN_NON_UNICODE)) {
1863                 const char* desc = (PL_op) ? OP_DESC(PL_op) : normal;
1864                 Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
1865                     "Operation \"%s\" returns its argument for non-Unicode code point 0x%04"UVXf"", desc, uv1);
1866             }
1867         }
1868
1869         /* Note that non-characters are perfectly legal, so no warning should
1870          * be given */
1871     }
1872
1873     uvuni_to_utf8(tmpbuf, uv1);
1874
1875     if (!*swashp) /* load on-demand */
1876          *swashp = swash_init("utf8", normal, &PL_sv_undef, 4, 0);
1877
1878     if (special) {
1879          /* It might be "special" (sometimes, but not always,
1880           * a multicharacter mapping) */
1881          HV * const hv = get_hv(special, 0);
1882          SV **svp;
1883
1884          if (hv &&
1885              (svp = hv_fetch(hv, (const char*)tmpbuf, UNISKIP(uv1), FALSE)) &&
1886              (*svp)) {
1887              const char *s;
1888
1889               s = SvPV_const(*svp, len);
1890               if (len == 1)
1891                    len = uvuni_to_utf8(ustrp, NATIVE_TO_UNI(*(U8*)s)) - ustrp;
1892               else {
1893 #ifdef EBCDIC
1894                    /* If we have EBCDIC we need to remap the characters
1895                     * since any characters in the low 256 are Unicode
1896                     * code points, not EBCDIC. */
1897                    U8 *t = (U8*)s, *tend = t + len, *d;
1898                 
1899                    d = tmpbuf;
1900                    if (SvUTF8(*svp)) {
1901                         STRLEN tlen = 0;
1902                         
1903                         while (t < tend) {
1904                              const UV c = utf8_to_uvchr(t, &tlen);
1905                              if (tlen > 0) {
1906                                   d = uvchr_to_utf8(d, UNI_TO_NATIVE(c));
1907                                   t += tlen;
1908                              }
1909                              else
1910                                   break;
1911                         }
1912                    }
1913                    else {
1914                         while (t < tend) {
1915                              d = uvchr_to_utf8(d, UNI_TO_NATIVE(*t));
1916                              t++;
1917                         }
1918                    }
1919                    len = d - tmpbuf;
1920                    Copy(tmpbuf, ustrp, len, U8);
1921 #else
1922                    Copy(s, ustrp, len, U8);
1923 #endif
1924               }
1925          }
1926     }
1927
1928     if (!len && *swashp) {
1929         const UV uv2 = swash_fetch(*swashp, tmpbuf, TRUE);
1930
1931          if (uv2) {
1932               /* It was "normal" (a single character mapping). */
1933               const UV uv3 = UNI_TO_NATIVE(uv2);
1934               len = uvchr_to_utf8(ustrp, uv3) - ustrp;
1935          }
1936     }
1937
1938     if (!len) /* Neither: just copy.  In other words, there was no mapping
1939                  defined, which means that the code point maps to itself */
1940          len = uvchr_to_utf8(ustrp, uv0) - ustrp;
1941
1942     if (lenp)
1943          *lenp = len;
1944
1945     return len ? utf8_to_uvchr(ustrp, 0) : 0;
1946 }
1947
1948 /*
1949 =for apidoc to_utf8_upper
1950
1951 Convert the UTF-8 encoded character at p to its uppercase version and
1952 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
1953 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
1954 the uppercase version may be longer than the original character.
1955
1956 The first character of the uppercased version is returned
1957 (but note, as explained above, that there may be more.)
1958
1959 =cut */
1960
1961 UV
1962 Perl_to_utf8_upper(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1963 {
1964     dVAR;
1965
1966     PERL_ARGS_ASSERT_TO_UTF8_UPPER;
1967
1968     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
1969                              &PL_utf8_toupper, "ToUpper", "utf8::ToSpecUpper");
1970 }
1971
1972 /*
1973 =for apidoc to_utf8_title
1974
1975 Convert the UTF-8 encoded character at p to its titlecase version and
1976 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
1977 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
1978 titlecase version may be longer than the original character.
1979
1980 The first character of the titlecased version is returned
1981 (but note, as explained above, that there may be more.)
1982
1983 =cut */
1984
1985 UV
1986 Perl_to_utf8_title(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1987 {
1988     dVAR;
1989
1990     PERL_ARGS_ASSERT_TO_UTF8_TITLE;
1991
1992     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
1993                              &PL_utf8_totitle, "ToTitle", "utf8::ToSpecTitle");
1994 }
1995
1996 /*
1997 =for apidoc to_utf8_lower
1998
1999 Convert the UTF-8 encoded character at p to its lowercase version and
2000 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
2001 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
2002 lowercase version may be longer than the original character.
2003
2004 The first character of the lowercased version is returned
2005 (but note, as explained above, that there may be more.)
2006
2007 =cut */
2008
2009 UV
2010 Perl_to_utf8_lower(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
2011 {
2012     dVAR;
2013
2014     PERL_ARGS_ASSERT_TO_UTF8_LOWER;
2015
2016     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
2017                              &PL_utf8_tolower, "ToLower", "utf8::ToSpecLower");
2018 }
2019
2020 /*
2021 =for apidoc to_utf8_fold
2022
2023 Convert the UTF-8 encoded character at p to its foldcase version and
2024 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
2025 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
2026 foldcase version may be longer than the original character (up to
2027 three characters).
2028
2029 The first character of the foldcased version is returned
2030 (but note, as explained above, that there may be more.)
2031
2032 =cut */
2033
2034 /* Not currently externally documented is 'flags', which currently is non-zero
2035  * if full case folds are to be used; otherwise simple folds */
2036
2037 UV
2038 Perl__to_utf8_fold_flags(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp, U8 flags)
2039 {
2040     const char *specials = (flags) ? "utf8::ToSpecFold" : NULL;
2041
2042     dVAR;
2043
2044     PERL_ARGS_ASSERT__TO_UTF8_FOLD_FLAGS;
2045
2046     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
2047                              &PL_utf8_tofold, "ToFold", specials);
2048 }
2049
2050 /* Note:
2051  * A "swash" is a swatch hash.
2052  * A "swatch" is a bit vector generated by utf8.c:S_swash_get().
2053  * C<pkg> is a pointer to a package name for SWASHNEW, should be "utf8".
2054  * For other parameters, see utf8::SWASHNEW in lib/utf8_heavy.pl.
2055  */
2056 SV*
2057 Perl_swash_init(pTHX_ const char* pkg, const char* name, SV *listsv, I32 minbits, I32 none)
2058 {
2059     dVAR;
2060     SV* retval;
2061     dSP;
2062     const size_t pkg_len = strlen(pkg);
2063     const size_t name_len = strlen(name);
2064     HV * const stash = gv_stashpvn(pkg, pkg_len, 0);
2065     SV* errsv_save;
2066     GV *method;
2067
2068     PERL_ARGS_ASSERT_SWASH_INIT;
2069
2070     PUSHSTACKi(PERLSI_MAGIC);
2071     ENTER;
2072     SAVEHINTS();
2073     save_re_context();
2074     if (PL_parser && PL_parser->error_count)
2075         SAVEI8(PL_parser->error_count), PL_parser->error_count = 0;
2076     method = gv_fetchmeth(stash, "SWASHNEW", 8, -1);
2077     if (!method) {      /* demand load utf8 */
2078         ENTER;
2079         errsv_save = newSVsv(ERRSV);
2080         /* It is assumed that callers of this routine are not passing in any
2081            user derived data.  */
2082         /* Need to do this after save_re_context() as it will set PL_tainted to
2083            1 while saving $1 etc (see the code after getrx: in Perl_magic_get).
2084            Even line to create errsv_save can turn on PL_tainted.  */
2085         SAVEBOOL(PL_tainted);
2086         PL_tainted = 0;
2087         Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpvn(pkg,pkg_len),
2088                          NULL);
2089         if (!SvTRUE(ERRSV))
2090             sv_setsv(ERRSV, errsv_save);
2091         SvREFCNT_dec(errsv_save);
2092         LEAVE;
2093     }
2094     SPAGAIN;
2095     PUSHMARK(SP);
2096     EXTEND(SP,5);
2097     mPUSHp(pkg, pkg_len);
2098     mPUSHp(name, name_len);
2099     PUSHs(listsv);
2100     mPUSHi(minbits);
2101     mPUSHi(none);
2102     PUTBACK;
2103     errsv_save = newSVsv(ERRSV);
2104     /* If we already have a pointer to the method, no need to use call_method()
2105        to repeat the lookup.  */
2106     if (method ? call_sv(MUTABLE_SV(method), G_SCALAR)
2107         : call_sv(newSVpvs_flags("SWASHNEW", SVs_TEMP), G_SCALAR | G_METHOD))
2108         retval = newSVsv(*PL_stack_sp--);
2109     else
2110         retval = &PL_sv_undef;
2111     if (!SvTRUE(ERRSV))
2112         sv_setsv(ERRSV, errsv_save);
2113     SvREFCNT_dec(errsv_save);
2114     LEAVE;
2115     POPSTACK;
2116     if (IN_PERL_COMPILETIME) {
2117         CopHINTS_set(PL_curcop, PL_hints);
2118     }
2119     if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV) {
2120         if (SvPOK(retval))
2121             Perl_croak(aTHX_ "Can't find Unicode property definition \"%"SVf"\"",
2122                        SVfARG(retval));
2123         Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
2124     }
2125     return retval;
2126 }
2127
2128
2129 /* This API is wrong for special case conversions since we may need to
2130  * return several Unicode characters for a single Unicode character
2131  * (see lib/unicore/SpecCase.txt) The SWASHGET in lib/utf8_heavy.pl is
2132  * the lower-level routine, and it is similarly broken for returning
2133  * multiple values.  --jhi
2134  * For those, you should use to_utf8_case() instead */
2135 /* Now SWASHGET is recasted into S_swash_get in this file. */
2136
2137 /* Note:
2138  * Returns the value of property/mapping C<swash> for the first character
2139  * of the string C<ptr>. If C<do_utf8> is true, the string C<ptr> is
2140  * assumed to be in utf8. If C<do_utf8> is false, the string C<ptr> is
2141  * assumed to be in native 8-bit encoding. Caches the swatch in C<swash>.
2142  */
2143 UV
2144 Perl_swash_fetch(pTHX_ SV *swash, const U8 *ptr, bool do_utf8)
2145 {
2146     dVAR;
2147     HV *const hv = MUTABLE_HV(SvRV(swash));
2148     U32 klen;
2149     U32 off;
2150     STRLEN slen;
2151     STRLEN needents;
2152     const U8 *tmps = NULL;
2153     U32 bit;
2154     SV *swatch;
2155     U8 tmputf8[2];
2156     const UV c = NATIVE_TO_ASCII(*ptr);
2157
2158     PERL_ARGS_ASSERT_SWASH_FETCH;
2159
2160     if (!do_utf8 && !UNI_IS_INVARIANT(c)) {
2161         tmputf8[0] = (U8)UTF8_EIGHT_BIT_HI(c);
2162         tmputf8[1] = (U8)UTF8_EIGHT_BIT_LO(c);
2163         ptr = tmputf8;
2164     }
2165     /* Given a UTF-X encoded char 0xAA..0xYY,0xZZ
2166      * then the "swatch" is a vec() for all the chars which start
2167      * with 0xAA..0xYY
2168      * So the key in the hash (klen) is length of encoded char -1
2169      */
2170     klen = UTF8SKIP(ptr) - 1;
2171     off  = ptr[klen];
2172
2173     if (klen == 0) {
2174       /* If char is invariant then swatch is for all the invariant chars
2175        * In both UTF-8 and UTF-8-MOD that happens to be UTF_CONTINUATION_MARK
2176        */
2177         needents = UTF_CONTINUATION_MARK;
2178         off      = NATIVE_TO_UTF(ptr[klen]);
2179     }
2180     else {
2181       /* If char is encoded then swatch is for the prefix */
2182         needents = (1 << UTF_ACCUMULATION_SHIFT);
2183         off      = NATIVE_TO_UTF(ptr[klen]) & UTF_CONTINUATION_MASK;
2184         if (UTF8_IS_SUPER(ptr) && ckWARN_d(WARN_NON_UNICODE)) {
2185             const UV code_point = utf8n_to_uvuni(ptr, UTF8_MAXBYTES, 0, 0);
2186
2187             /* This outputs warnings for binary properties only, assuming that
2188              * to_utf8_case() will output any for non-binary.  Also, surrogates
2189              * aren't checked for, as that would warn on things like
2190              * /\p{Gc=Cs}/ */
2191             SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2192             if (SvUV(*bitssvp) == 1) {
2193                 Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
2194                     "Code point 0x%04"UVXf" is not Unicode, all \\p{} matches fail; all \\P{} matches succeed", code_point);
2195             }
2196         }
2197     }
2198
2199     /*
2200      * This single-entry cache saves about 1/3 of the utf8 overhead in test
2201      * suite.  (That is, only 7-8% overall over just a hash cache.  Still,
2202      * it's nothing to sniff at.)  Pity we usually come through at least
2203      * two function calls to get here...
2204      *
2205      * NB: this code assumes that swatches are never modified, once generated!
2206      */
2207
2208     if (hv   == PL_last_swash_hv &&
2209         klen == PL_last_swash_klen &&
2210         (!klen || memEQ((char *)ptr, (char *)PL_last_swash_key, klen)) )
2211     {
2212         tmps = PL_last_swash_tmps;
2213         slen = PL_last_swash_slen;
2214     }
2215     else {
2216         /* Try our second-level swatch cache, kept in a hash. */
2217         SV** svp = hv_fetch(hv, (const char*)ptr, klen, FALSE);
2218
2219         /* If not cached, generate it via swash_get */
2220         if (!svp || !SvPOK(*svp)
2221                  || !(tmps = (const U8*)SvPV_const(*svp, slen))) {
2222             /* We use utf8n_to_uvuni() as we want an index into
2223                Unicode tables, not a native character number.
2224              */
2225             const UV code_point = utf8n_to_uvuni(ptr, UTF8_MAXBYTES, 0,
2226                                            ckWARN(WARN_UTF8) ?
2227                                            0 : UTF8_ALLOW_ANY);
2228             swatch = swash_get(swash,
2229                     /* On EBCDIC & ~(0xA0-1) isn't a useful thing to do */
2230                                 (klen) ? (code_point & ~(needents - 1)) : 0,
2231                                 needents);
2232
2233             if (IN_PERL_COMPILETIME)
2234                 CopHINTS_set(PL_curcop, PL_hints);
2235
2236             svp = hv_store(hv, (const char *)ptr, klen, swatch, 0);
2237
2238             if (!svp || !(tmps = (U8*)SvPV(*svp, slen))
2239                      || (slen << 3) < needents)
2240                 Perl_croak(aTHX_ "panic: swash_fetch got improper swatch");
2241         }
2242
2243         PL_last_swash_hv = hv;
2244         assert(klen <= sizeof(PL_last_swash_key));
2245         PL_last_swash_klen = (U8)klen;
2246         /* FIXME change interpvar.h?  */
2247         PL_last_swash_tmps = (U8 *) tmps;
2248         PL_last_swash_slen = slen;
2249         if (klen)
2250             Copy(ptr, PL_last_swash_key, klen, U8);
2251     }
2252
2253     switch ((int)((slen << 3) / needents)) {
2254     case 1:
2255         bit = 1 << (off & 7);
2256         off >>= 3;
2257         return (tmps[off] & bit) != 0;
2258     case 8:
2259         return tmps[off];
2260     case 16:
2261         off <<= 1;
2262         return (tmps[off] << 8) + tmps[off + 1] ;
2263     case 32:
2264         off <<= 2;
2265         return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
2266     }
2267     Perl_croak(aTHX_ "panic: swash_fetch got swatch of unexpected bit width");
2268     NORETURN_FUNCTION_END;
2269 }
2270
2271 /* Read a single line of the main body of the swash input text.  These are of
2272  * the form:
2273  * 0053 0056    0073
2274  * where each number is hex.  The first two numbers form the minimum and
2275  * maximum of a range, and the third is the value associated with the range.
2276  * Not all swashes should have a third number
2277  *
2278  * On input: l    points to the beginning of the line to be examined; it points
2279  *                to somewhere in the string of the whole input text, and is
2280  *                terminated by a \n or the null string terminator.
2281  *           lend   points to the null terminator of that string
2282  *           wants_value    is non-zero if the swash expects a third number
2283  *           typestr is the name of the swash's mapping, like 'ToLower'
2284  * On output: *min, *max, and *val are set to the values read from the line.
2285  *            returns a pointer just beyond the line examined.  If there was no
2286  *            valid min number on the line, returns lend+1
2287  */
2288
2289 STATIC U8*
2290 S_swash_scan_list_line(pTHX_ U8* l, U8* const lend, UV* min, UV* max, UV* val,
2291                              const bool wants_value, const U8* const typestr)
2292 {
2293     const int  typeto  = typestr[0] == 'T' && typestr[1] == 'o';
2294     STRLEN numlen;          /* Length of the number */
2295     I32 flags = PERL_SCAN_SILENT_ILLDIGIT
2296                 | PERL_SCAN_DISALLOW_PREFIX
2297                 | PERL_SCAN_SILENT_NON_PORTABLE;
2298
2299     /* nl points to the next \n in the scan */
2300     U8* const nl = (U8*)memchr(l, '\n', lend - l);
2301
2302     /* Get the first number on the line: the range minimum */
2303     numlen = lend - l;
2304     *min = grok_hex((char *)l, &numlen, &flags, NULL);
2305     if (numlen)     /* If found a hex number, position past it */
2306         l += numlen;
2307     else if (nl) {          /* Else, go handle next line, if any */
2308         return nl + 1;  /* 1 is length of "\n" */
2309     }
2310     else {              /* Else, no next line */
2311         return lend + 1;        /* to LIST's end at which \n is not found */
2312     }
2313
2314     /* The max range value follows, separated by a BLANK */
2315     if (isBLANK(*l)) {
2316         ++l;
2317         flags = PERL_SCAN_SILENT_ILLDIGIT
2318                 | PERL_SCAN_DISALLOW_PREFIX
2319                 | PERL_SCAN_SILENT_NON_PORTABLE;
2320         numlen = lend - l;
2321         *max = grok_hex((char *)l, &numlen, &flags, NULL);
2322         if (numlen)
2323             l += numlen;
2324         else    /* If no value here, it is a single element range */
2325             *max = *min;
2326
2327         /* Non-binary tables have a third entry: what the first element of the
2328          * range maps to */
2329         if (wants_value) {
2330             if (isBLANK(*l)) {
2331                 ++l;
2332                 flags = PERL_SCAN_SILENT_ILLDIGIT
2333                       | PERL_SCAN_DISALLOW_PREFIX
2334                       | PERL_SCAN_SILENT_NON_PORTABLE;
2335                 numlen = lend - l;
2336                 *val = grok_hex((char *)l, &numlen, &flags, NULL);
2337                 if (numlen)
2338                     l += numlen;
2339                 else
2340                     *val = 0;
2341             }
2342             else {
2343                 *val = 0;
2344                 if (typeto) {
2345                     Perl_croak(aTHX_ "%s: illegal mapping '%s'",
2346                                      typestr, l);
2347                 }
2348             }
2349         }
2350         else
2351             *val = 0; /* bits == 1, then any val should be ignored */
2352     }
2353     else { /* Nothing following range min, should be single element with no
2354               mapping expected */
2355         *max = *min;
2356         if (wants_value) {
2357             *val = 0;
2358             if (typeto) {
2359                 Perl_croak(aTHX_ "%s: illegal mapping '%s'", typestr, l);
2360             }
2361         }
2362         else
2363             *val = 0; /* bits == 1, then val should be ignored */
2364     }
2365
2366     /* Position to next line if any, or EOF */
2367     if (nl)
2368         l = nl + 1;
2369     else
2370         l = lend;
2371
2372     return l;
2373 }
2374
2375 /* Note:
2376  * Returns a swatch (a bit vector string) for a code point sequence
2377  * that starts from the value C<start> and comprises the number C<span>.
2378  * A C<swash> must be an object created by SWASHNEW (see lib/utf8_heavy.pl).
2379  * Should be used via swash_fetch, which will cache the swatch in C<swash>.
2380  */
2381 STATIC SV*
2382 S_swash_get(pTHX_ SV* swash, UV start, UV span)
2383 {
2384     SV *swatch;
2385     U8 *l, *lend, *x, *xend, *s, *send;
2386     STRLEN lcur, xcur, scur;
2387     HV *const hv = MUTABLE_HV(SvRV(swash));
2388
2389     /* The string containing the main body of the table */
2390     SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
2391
2392     SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
2393     SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2394     SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
2395     SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
2396     SV** const invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
2397     const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
2398     const STRLEN bits  = SvUV(*bitssvp);
2399     const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
2400     const UV     none  = SvUV(*nonesvp);
2401     const UV     end   = start + span;
2402
2403     PERL_ARGS_ASSERT_SWASH_GET;
2404
2405     if (bits != 1 && bits != 8 && bits != 16 && bits != 32) {
2406         Perl_croak(aTHX_ "panic: swash_get doesn't expect bits %"UVuf,
2407                                                  (UV)bits);
2408     }
2409
2410     /* create and initialize $swatch */
2411     scur   = octets ? (span * octets) : (span + 7) / 8;
2412     swatch = newSV(scur);
2413     SvPOK_on(swatch);
2414     s = (U8*)SvPVX(swatch);
2415     if (octets && none) {
2416         const U8* const e = s + scur;
2417         while (s < e) {
2418             if (bits == 8)
2419                 *s++ = (U8)(none & 0xff);
2420             else if (bits == 16) {
2421                 *s++ = (U8)((none >>  8) & 0xff);
2422                 *s++ = (U8)( none        & 0xff);
2423             }
2424             else if (bits == 32) {
2425                 *s++ = (U8)((none >> 24) & 0xff);
2426                 *s++ = (U8)((none >> 16) & 0xff);
2427                 *s++ = (U8)((none >>  8) & 0xff);
2428                 *s++ = (U8)( none        & 0xff);
2429             }
2430         }
2431         *s = '\0';
2432     }
2433     else {
2434         (void)memzero((U8*)s, scur + 1);
2435     }
2436     SvCUR_set(swatch, scur);
2437     s = (U8*)SvPVX(swatch);
2438
2439     /* read $swash->{LIST} */
2440     l = (U8*)SvPV(*listsvp, lcur);
2441     lend = l + lcur;
2442     while (l < lend) {
2443         UV min, max, val;
2444         l = S_swash_scan_list_line(aTHX_ l, lend, &min, &max, &val,
2445                                          cBOOL(octets), typestr);
2446         if (l > lend) {
2447             break;
2448         }
2449
2450         /* If looking for something beyond this range, go try the next one */
2451         if (max < start)
2452             continue;
2453
2454         if (octets) {
2455             UV key;
2456             if (min < start) {
2457                 if (!none || val < none) {
2458                     val += start - min;
2459                 }
2460                 min = start;
2461             }
2462             for (key = min; key <= max; key++) {
2463                 STRLEN offset;
2464                 if (key >= end)
2465                     goto go_out_list;
2466                 /* offset must be non-negative (start <= min <= key < end) */
2467                 offset = octets * (key - start);
2468                 if (bits == 8)
2469                     s[offset] = (U8)(val & 0xff);
2470                 else if (bits == 16) {
2471                     s[offset    ] = (U8)((val >>  8) & 0xff);
2472                     s[offset + 1] = (U8)( val        & 0xff);
2473                 }
2474                 else if (bits == 32) {
2475                     s[offset    ] = (U8)((val >> 24) & 0xff);
2476                     s[offset + 1] = (U8)((val >> 16) & 0xff);
2477                     s[offset + 2] = (U8)((val >>  8) & 0xff);
2478                     s[offset + 3] = (U8)( val        & 0xff);
2479                 }
2480
2481                 if (!none || val < none)
2482                     ++val;
2483             }
2484         }
2485         else { /* bits == 1, then val should be ignored */
2486             UV key;
2487             if (min < start)
2488                 min = start;
2489             for (key = min; key <= max; key++) {
2490                 const STRLEN offset = (STRLEN)(key - start);
2491                 if (key >= end)
2492                     goto go_out_list;
2493                 s[offset >> 3] |= 1 << (offset & 7);
2494             }
2495         }
2496     } /* while */
2497   go_out_list:
2498
2499     /* Invert if the data says it should be.  Assumes that bits == 1 */
2500     if (invert_it_svp && SvUV(*invert_it_svp)) {
2501
2502         /* Unicode properties should come with all bits above PERL_UNICODE_MAX
2503          * be 0, and their inversion should also be 0, as we don't succeed any
2504          * Unicode property matches for non-Unicode code points */
2505         if (start <= PERL_UNICODE_MAX) {
2506
2507             /* The code below assumes that we never cross the
2508              * Unicode/above-Unicode boundary in a range, as otherwise we would
2509              * have to figure out where to stop flipping the bits.  Since this
2510              * boundary is divisible by a large power of 2, and swatches comes
2511              * in small powers of 2, this should be a valid assumption */
2512             assert(start + span - 1 <= PERL_UNICODE_MAX);
2513
2514             send = s + scur;
2515             while (s < send) {
2516                 *s = ~(*s);
2517                 s++;
2518             }
2519         }
2520     }
2521
2522     /* read $swash->{EXTRAS}
2523      * This code also copied to swash_to_invlist() below */
2524     x = (U8*)SvPV(*extssvp, xcur);
2525     xend = x + xcur;
2526     while (x < xend) {
2527         STRLEN namelen;
2528         U8 *namestr;
2529         SV** othersvp;
2530         HV* otherhv;
2531         STRLEN otherbits;
2532         SV **otherbitssvp, *other;
2533         U8 *s, *o, *nl;
2534         STRLEN slen, olen;
2535
2536         const U8 opc = *x++;
2537         if (opc == '\n')
2538             continue;
2539
2540         nl = (U8*)memchr(x, '\n', xend - x);
2541
2542         if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
2543             if (nl) {
2544                 x = nl + 1; /* 1 is length of "\n" */
2545                 continue;
2546             }
2547             else {
2548                 x = xend; /* to EXTRAS' end at which \n is not found */
2549                 break;
2550             }
2551         }
2552
2553         namestr = x;
2554         if (nl) {
2555             namelen = nl - namestr;
2556             x = nl + 1;
2557         }
2558         else {
2559             namelen = xend - namestr;
2560             x = xend;
2561         }
2562
2563         othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
2564         otherhv = MUTABLE_HV(SvRV(*othersvp));
2565         otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
2566         otherbits = (STRLEN)SvUV(*otherbitssvp);
2567         if (bits < otherbits)
2568             Perl_croak(aTHX_ "panic: swash_get found swatch size mismatch");
2569
2570         /* The "other" swatch must be destroyed after. */
2571         other = swash_get(*othersvp, start, span);
2572         o = (U8*)SvPV(other, olen);
2573
2574         if (!olen)
2575             Perl_croak(aTHX_ "panic: swash_get got improper swatch");
2576
2577         s = (U8*)SvPV(swatch, slen);
2578         if (bits == 1 && otherbits == 1) {
2579             if (slen != olen)
2580                 Perl_croak(aTHX_ "panic: swash_get found swatch length mismatch");
2581
2582             switch (opc) {
2583             case '+':
2584                 while (slen--)
2585                     *s++ |= *o++;
2586                 break;
2587             case '!':
2588                 while (slen--)
2589                     *s++ |= ~*o++;
2590                 break;
2591             case '-':
2592                 while (slen--)
2593                     *s++ &= ~*o++;
2594                 break;
2595             case '&':
2596                 while (slen--)
2597                     *s++ &= *o++;
2598                 break;
2599             default:
2600                 break;
2601             }
2602         }
2603         else {
2604             STRLEN otheroctets = otherbits >> 3;
2605             STRLEN offset = 0;
2606             U8* const send = s + slen;
2607
2608             while (s < send) {
2609                 UV otherval = 0;
2610
2611                 if (otherbits == 1) {
2612                     otherval = (o[offset >> 3] >> (offset & 7)) & 1;
2613                     ++offset;
2614                 }
2615                 else {
2616                     STRLEN vlen = otheroctets;
2617                     otherval = *o++;
2618                     while (--vlen) {
2619                         otherval <<= 8;
2620                         otherval |= *o++;
2621                     }
2622                 }
2623
2624                 if (opc == '+' && otherval)
2625                     NOOP;   /* replace with otherval */
2626                 else if (opc == '!' && !otherval)
2627                     otherval = 1;
2628                 else if (opc == '-' && otherval)
2629                     otherval = 0;
2630                 else if (opc == '&' && !otherval)
2631                     otherval = 0;
2632                 else {
2633                     s += octets; /* no replacement */
2634                     continue;
2635                 }
2636
2637                 if (bits == 8)
2638                     *s++ = (U8)( otherval & 0xff);
2639                 else if (bits == 16) {
2640                     *s++ = (U8)((otherval >>  8) & 0xff);
2641                     *s++ = (U8)( otherval        & 0xff);
2642                 }
2643                 else if (bits == 32) {
2644                     *s++ = (U8)((otherval >> 24) & 0xff);
2645                     *s++ = (U8)((otherval >> 16) & 0xff);
2646                     *s++ = (U8)((otherval >>  8) & 0xff);
2647                     *s++ = (U8)( otherval        & 0xff);
2648                 }
2649             }
2650         }
2651         sv_free(other); /* through with it! */
2652     } /* while */
2653     return swatch;
2654 }
2655
2656 HV*
2657 Perl__swash_inversion_hash(pTHX_ SV* const swash)
2658 {
2659
2660    /* Subject to change or removal.  For use only in one place in regcomp.c.
2661     * Can't be used on a property that is subject to user override, as it
2662     * relies on the value of SPECIALS in the swash which would be set by
2663     * utf8_heavy.pl to the hash in the non-overriden file, and hence is not set
2664     * for overridden properties
2665     *
2666     * Returns a hash which is the inversion and closure of a swash mapping.
2667     * For example, consider the input lines:
2668     * 004B              006B
2669     * 004C              006C
2670     * 212A              006B
2671     *
2672     * The returned hash would have two keys, the utf8 for 006B and the utf8 for
2673     * 006C.  The value for each key is an array.  For 006C, the array would
2674     * have a two elements, the utf8 for itself, and for 004C.  For 006B, there
2675     * would be three elements in its array, the utf8 for 006B, 004B and 212A.
2676     *
2677     * Essentially, for any code point, it gives all the code points that map to
2678     * it, or the list of 'froms' for that point.
2679     *
2680     * Currently it ignores any additions or deletions from other swashes,
2681     * looking at just the main body of the swash, and if there are SPECIALS
2682     * in the swash, at that hash
2683     *
2684     * The specials hash can be extra code points, and most likely consists of
2685     * maps from single code points to multiple ones (each expressed as a string
2686     * of utf8 characters).   This function currently returns only 1-1 mappings.
2687     * However consider this possible input in the specials hash:
2688     * "\xEF\xAC\x85" => "\x{0073}\x{0074}",         # U+FB05 => 0073 0074
2689     * "\xEF\xAC\x86" => "\x{0073}\x{0074}",         # U+FB06 => 0073 0074
2690     *
2691     * Both FB05 and FB06 map to the same multi-char sequence, which we don't
2692     * currently handle.  But it also means that FB05 and FB06 are equivalent in
2693     * a 1-1 mapping which we should handle, and this relationship may not be in
2694     * the main table.  Therefore this function examines all the multi-char
2695     * sequences and adds the 1-1 mappings that come out of that.  */
2696
2697     U8 *l, *lend;
2698     STRLEN lcur;
2699     HV *const hv = MUTABLE_HV(SvRV(swash));
2700
2701     /* The string containing the main body of the table */
2702     SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
2703
2704     SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
2705     SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2706     SV** const nonesvp = hv_fetchs(hv, "NONE", FALSE);
2707     /*SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);*/
2708     const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
2709     const STRLEN bits  = SvUV(*bitssvp);
2710     const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
2711     const UV     none  = SvUV(*nonesvp);
2712     SV **specials_p = hv_fetchs(hv, "SPECIALS", 0);
2713
2714     HV* ret = newHV();
2715
2716     PERL_ARGS_ASSERT__SWASH_INVERSION_HASH;
2717
2718     /* Must have at least 8 bits to get the mappings */
2719     if (bits != 8 && bits != 16 && bits != 32) {
2720         Perl_croak(aTHX_ "panic: swash_inversion_hash doesn't expect bits %"UVuf,
2721                                                  (UV)bits);
2722     }
2723
2724     if (specials_p) { /* It might be "special" (sometimes, but not always, a
2725                         mapping to more than one character */
2726
2727         /* Construct an inverse mapping hash for the specials */
2728         HV * const specials_hv = MUTABLE_HV(SvRV(*specials_p));
2729         HV * specials_inverse = newHV();
2730         char *char_from; /* the lhs of the map */
2731         I32 from_len;   /* its byte length */
2732         char *char_to;  /* the rhs of the map */
2733         I32 to_len;     /* its byte length */
2734         SV *sv_to;      /* and in a sv */
2735         AV* from_list;  /* list of things that map to each 'to' */
2736
2737         hv_iterinit(specials_hv);
2738
2739         /* The keys are the characters (in utf8) that map to the corresponding
2740          * utf8 string value.  Iterate through the list creating the inverse
2741          * list. */
2742         while ((sv_to = hv_iternextsv(specials_hv, &char_from, &from_len))) {
2743             SV** listp;
2744             if (! SvPOK(sv_to)) {
2745                 Perl_croak(aTHX_ "panic: value returned from hv_iternextsv() unexpectedly is not a string");
2746             }
2747             /*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)));*/
2748
2749             /* Each key in the inverse list is a mapped-to value, and the key's
2750              * hash value is a list of the strings (each in utf8) that map to
2751              * it.  Those strings are all one character long */
2752             if ((listp = hv_fetch(specials_inverse,
2753                                     SvPVX(sv_to),
2754                                     SvCUR(sv_to), 0)))
2755             {
2756                 from_list = (AV*) *listp;
2757             }
2758             else { /* No entry yet for it: create one */
2759                 from_list = newAV();
2760                 if (! hv_store(specials_inverse,
2761                                 SvPVX(sv_to),
2762                                 SvCUR(sv_to),
2763                                 (SV*) from_list, 0))
2764                 {
2765                     Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2766                 }
2767             }
2768
2769             /* Here have the list associated with this 'to' (perhaps newly
2770              * created and empty).  Just add to it.  Note that we ASSUME that
2771              * the input is guaranteed to not have duplications, so we don't
2772              * check for that.  Duplications just slow down execution time. */
2773             av_push(from_list, newSVpvn_utf8(char_from, from_len, TRUE));
2774         }
2775
2776         /* Here, 'specials_inverse' contains the inverse mapping.  Go through
2777          * it looking for cases like the FB05/FB06 examples above.  There would
2778          * be an entry in the hash like
2779         *       'st' => [ FB05, FB06 ]
2780         * In this example we will create two lists that get stored in the
2781         * returned hash, 'ret':
2782         *       FB05 => [ FB05, FB06 ]
2783         *       FB06 => [ FB05, FB06 ]
2784         *
2785         * Note that there is nothing to do if the array only has one element.
2786         * (In the normal 1-1 case handled below, we don't have to worry about
2787         * two lists, as everything gets tied to the single list that is
2788         * generated for the single character 'to'.  But here, we are omitting
2789         * that list, ('st' in the example), so must have multiple lists.) */
2790         while ((from_list = (AV *) hv_iternextsv(specials_inverse,
2791                                                  &char_to, &to_len)))
2792         {
2793             if (av_len(from_list) > 0) {
2794                 int i;
2795
2796                 /* We iterate over all combinations of i,j to place each code
2797                  * point on each list */
2798                 for (i = 0; i <= av_len(from_list); i++) {
2799                     int j;
2800                     AV* i_list = newAV();
2801                     SV** entryp = av_fetch(from_list, i, FALSE);
2802                     if (entryp == NULL) {
2803                         Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
2804                     }
2805                     if (hv_fetch(ret, SvPVX(*entryp), SvCUR(*entryp), FALSE)) {
2806                         Perl_croak(aTHX_ "panic: unexpected entry for %s", SvPVX(*entryp));
2807                     }
2808                     if (! hv_store(ret, SvPVX(*entryp), SvCUR(*entryp),
2809                                    (SV*) i_list, FALSE))
2810                     {
2811                         Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2812                     }
2813
2814                     /* For debugging: UV u = utf8_to_uvchr((U8*) SvPVX(*entryp), 0);*/
2815                     for (j = 0; j <= av_len(from_list); j++) {
2816                         entryp = av_fetch(from_list, j, FALSE);
2817                         if (entryp == NULL) {
2818                             Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
2819                         }
2820
2821                         /* When i==j this adds itself to the list */
2822                         av_push(i_list, newSVuv(utf8_to_uvchr(
2823                                                 (U8*) SvPVX(*entryp), 0)));
2824                         /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Adding %"UVXf" to list for %"UVXf"\n", utf8_to_uvchr((U8*) SvPVX(*entryp), 0), u));*/
2825                     }
2826                 }
2827             }
2828         }
2829         SvREFCNT_dec(specials_inverse); /* done with it */
2830     } /* End of specials */
2831
2832     /* read $swash->{LIST} */
2833     l = (U8*)SvPV(*listsvp, lcur);
2834     lend = l + lcur;
2835
2836     /* Go through each input line */
2837     while (l < lend) {
2838         UV min, max, val;
2839         UV inverse;
2840         l = S_swash_scan_list_line(aTHX_ l, lend, &min, &max, &val,
2841                                          cBOOL(octets), typestr);
2842         if (l > lend) {
2843             break;
2844         }
2845
2846         /* Each element in the range is to be inverted */
2847         for (inverse = min; inverse <= max; inverse++) {
2848             AV* list;
2849             SV** listp;
2850             IV i;
2851             bool found_key = FALSE;
2852             bool found_inverse = FALSE;
2853
2854             /* The key is the inverse mapping */
2855             char key[UTF8_MAXBYTES+1];
2856             char* key_end = (char *) uvuni_to_utf8((U8*) key, val);
2857             STRLEN key_len = key_end - key;
2858
2859             /* Get the list for the map */
2860             if ((listp = hv_fetch(ret, key, key_len, FALSE))) {
2861                 list = (AV*) *listp;
2862             }
2863             else { /* No entry yet for it: create one */
2864                 list = newAV();
2865                 if (! hv_store(ret, key, key_len, (SV*) list, FALSE)) {
2866                     Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
2867                 }
2868             }
2869
2870             /* Look through list to see if this inverse mapping already is
2871              * listed, or if there is a mapping to itself already */
2872             for (i = 0; i <= av_len(list); i++) {
2873                 SV** entryp = av_fetch(list, i, FALSE);
2874                 SV* entry;
2875                 if (entryp == NULL) {
2876                     Perl_croak(aTHX_ "panic: av_fetch() unexpectedly failed");
2877                 }
2878                 entry = *entryp;
2879                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "list for %"UVXf" contains %"UVXf"\n", val, SvUV(entry)));*/
2880                 if (SvUV(entry) == val) {
2881                     found_key = TRUE;
2882                 }
2883                 if (SvUV(entry) == inverse) {
2884                     found_inverse = TRUE;
2885                 }
2886
2887                 /* No need to continue searching if found everything we are
2888                  * looking for */
2889                 if (found_key && found_inverse) {
2890                     break;
2891                 }
2892             }
2893
2894             /* Make sure there is a mapping to itself on the list */
2895             if (! found_key) {
2896                 av_push(list, newSVuv(val));
2897                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Adding %"UVXf" to list for %"UVXf"\n", val, val));*/
2898             }
2899
2900
2901             /* Simply add the value to the list */
2902             if (! found_inverse) {
2903                 av_push(list, newSVuv(inverse));
2904                 /*DEBUG_U(PerlIO_printf(Perl_debug_log, "Adding %"UVXf" to list for %"UVXf"\n", inverse, val));*/
2905             }
2906
2907             /* swash_get() increments the value of val for each element in the
2908              * range.  That makes more compact tables possible.  You can
2909              * express the capitalization, for example, of all consecutive
2910              * letters with a single line: 0061\t007A\t0041 This maps 0061 to
2911              * 0041, 0062 to 0042, etc.  I (khw) have never understood 'none',
2912              * and it's not documented; it appears to be used only in
2913              * implementing tr//; I copied the semantics from swash_get(), just
2914              * in case */
2915             if (!none || val < none) {
2916                 ++val;
2917             }
2918         }
2919     }
2920
2921     return ret;
2922 }
2923
2924 SV*
2925 Perl__swash_to_invlist(pTHX_ SV* const swash)
2926 {
2927
2928    /* Subject to change or removal.  For use only in one place in regcomp.c */
2929
2930     U8 *l, *lend;
2931     char *loc;
2932     STRLEN lcur;
2933     HV *const hv = MUTABLE_HV(SvRV(swash));
2934     UV elements = 0;    /* Number of elements in the inversion list */
2935     U8 empty[] = "";
2936
2937     /* The string containing the main body of the table */
2938     SV** const listsvp = hv_fetchs(hv, "LIST", FALSE);
2939     SV** const typesvp = hv_fetchs(hv, "TYPE", FALSE);
2940     SV** const bitssvp = hv_fetchs(hv, "BITS", FALSE);
2941     SV** const extssvp = hv_fetchs(hv, "EXTRAS", FALSE);
2942     SV** const invert_it_svp = hv_fetchs(hv, "INVERT_IT", FALSE);
2943
2944     const U8* const typestr = (U8*)SvPV_nolen(*typesvp);
2945     const STRLEN bits  = SvUV(*bitssvp);
2946     const STRLEN octets = bits >> 3; /* if bits == 1, then octets == 0 */
2947     U8 *x, *xend;
2948     STRLEN xcur;
2949
2950     SV* invlist;
2951
2952     PERL_ARGS_ASSERT__SWASH_TO_INVLIST;
2953
2954     /* read $swash->{LIST} */
2955     if (SvPOK(*listsvp)) {
2956         l = (U8*)SvPV(*listsvp, lcur);
2957     }
2958     else {
2959         /* LIST legitimately doesn't contain a string during compilation phases
2960          * of Perl itself, before the Unicode tables are generated.  In this
2961          * case, just fake things up by creating an empty list */
2962         l = empty;
2963         lcur = 0;
2964     }
2965     loc = (char *) l;
2966     lend = l + lcur;
2967
2968     /* Scan the input to count the number of lines to preallocate array size
2969      * based on worst possible case, which is each line in the input creates 2
2970      * elements in the inversion list: 1) the beginning of a range in the list;
2971      * 2) the beginning of a range not in the list.  */
2972     while ((loc = (strchr(loc, '\n'))) != NULL) {
2973         elements += 2;
2974         loc++;
2975     }
2976
2977     /* If the ending is somehow corrupt and isn't a new line, add another
2978      * element for the final range that isn't in the inversion list */
2979     if (! (*lend == '\n' || (*lend == '\0' && *(lend - 1) == '\n'))) {
2980         elements++;
2981     }
2982
2983     invlist = _new_invlist(elements);
2984
2985     /* Now go through the input again, adding each range to the list */
2986     while (l < lend) {
2987         UV start, end;
2988         UV val;         /* Not used by this function */
2989
2990         l = S_swash_scan_list_line(aTHX_ l, lend, &start, &end, &val,
2991                                          cBOOL(octets), typestr);
2992
2993         if (l > lend) {
2994             break;
2995         }
2996
2997         _append_range_to_invlist(invlist, start, end);
2998     }
2999
3000     /* Invert if the data says it should be */
3001     if (invert_it_svp && SvUV(*invert_it_svp)) {
3002         _invlist_invert_prop(invlist);
3003     }
3004
3005     /* This code is copied from swash_get()
3006      * read $swash->{EXTRAS} */
3007     x = (U8*)SvPV(*extssvp, xcur);
3008     xend = x + xcur;
3009     while (x < xend) {
3010         STRLEN namelen;
3011         U8 *namestr;
3012         SV** othersvp;
3013         HV* otherhv;
3014         STRLEN otherbits;
3015         SV **otherbitssvp, *other;
3016         U8 *nl;
3017
3018         const U8 opc = *x++;
3019         if (opc == '\n')
3020             continue;
3021
3022         nl = (U8*)memchr(x, '\n', xend - x);
3023
3024         if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
3025             if (nl) {
3026                 x = nl + 1; /* 1 is length of "\n" */
3027                 continue;
3028             }
3029             else {
3030                 x = xend; /* to EXTRAS' end at which \n is not found */
3031                 break;
3032             }
3033         }
3034
3035         namestr = x;
3036         if (nl) {
3037             namelen = nl - namestr;
3038             x = nl + 1;
3039         }
3040         else {
3041             namelen = xend - namestr;
3042             x = xend;
3043         }
3044
3045         othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
3046         otherhv = MUTABLE_HV(SvRV(*othersvp));
3047         otherbitssvp = hv_fetchs(otherhv, "BITS", FALSE);
3048         otherbits = (STRLEN)SvUV(*otherbitssvp);
3049
3050         if (bits != otherbits || bits != 1) {
3051             Perl_croak(aTHX_ "panic: _swash_to_invlist only operates on boolean properties");
3052         }
3053
3054         /* The "other" swatch must be destroyed after. */
3055         other = _swash_to_invlist((SV *)*othersvp);
3056
3057         /* End of code copied from swash_get() */
3058         switch (opc) {
3059         case '+':
3060             _invlist_union(invlist, other, &invlist);
3061             break;
3062         case '!':
3063             _invlist_invert(other);
3064             _invlist_union(invlist, other, &invlist);
3065             break;
3066         case '-':
3067             _invlist_subtract(invlist, other, &invlist);
3068             break;
3069         case '&':
3070             _invlist_intersection(invlist, other, &invlist);
3071             break;
3072         default:
3073             break;
3074         }
3075         sv_free(other); /* through with it! */
3076     }
3077
3078     return invlist;
3079 }
3080
3081 /*
3082 =for apidoc uvchr_to_utf8
3083
3084 Adds the UTF-8 representation of the Native code point C<uv> to the end
3085 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
3086 bytes available. The return value is the pointer to the byte after the
3087 end of the new character. In other words,
3088
3089     d = uvchr_to_utf8(d, uv);
3090
3091 is the recommended wide native character-aware way of saying
3092
3093     *(d++) = uv;
3094
3095 =cut
3096 */
3097
3098 /* On ASCII machines this is normally a macro but we want a
3099    real function in case XS code wants it
3100 */
3101 U8 *
3102 Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv)
3103 {
3104     PERL_ARGS_ASSERT_UVCHR_TO_UTF8;
3105
3106     return Perl_uvuni_to_utf8_flags(aTHX_ d, NATIVE_TO_UNI(uv), 0);
3107 }
3108
3109 U8 *
3110 Perl_uvchr_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
3111 {
3112     PERL_ARGS_ASSERT_UVCHR_TO_UTF8_FLAGS;
3113
3114     return Perl_uvuni_to_utf8_flags(aTHX_ d, NATIVE_TO_UNI(uv), flags);
3115 }
3116
3117 /*
3118 =for apidoc utf8n_to_uvchr
3119
3120 Returns the native character value of the first character in the string
3121 C<s>
3122 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
3123 length, in bytes, of that character.
3124
3125 length and flags are the same as utf8n_to_uvuni().
3126
3127 =cut
3128 */
3129 /* On ASCII machines this is normally a macro but we want
3130    a real function in case XS code wants it
3131 */
3132 UV
3133 Perl_utf8n_to_uvchr(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen,
3134 U32 flags)
3135 {
3136     const UV uv = Perl_utf8n_to_uvuni(aTHX_ s, curlen, retlen, flags);
3137
3138     PERL_ARGS_ASSERT_UTF8N_TO_UVCHR;
3139
3140     return UNI_TO_NATIVE(uv);
3141 }
3142
3143 bool
3144 Perl_check_utf8_print(pTHX_ register const U8* s, const STRLEN len)
3145 {
3146     /* May change: warns if surrogates, non-character code points, or
3147      * non-Unicode code points are in s which has length len.  Returns TRUE if
3148      * none found; FALSE otherwise.  The only other validity check is to make
3149      * sure that this won't exceed the string's length */
3150
3151     const U8* const e = s + len;
3152     bool ok = TRUE;
3153
3154     PERL_ARGS_ASSERT_CHECK_UTF8_PRINT;
3155
3156     while (s < e) {
3157         if (UTF8SKIP(s) > len) {
3158             Perl_ck_warner_d(aTHX_ packWARN(WARN_UTF8),
3159                            "%s in %s", unees, PL_op ? OP_DESC(PL_op) : "print");
3160             return FALSE;
3161         }
3162         if (*s >= UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE) {
3163             STRLEN char_len;
3164             if (UTF8_IS_SUPER(s)) {
3165                 if (ckWARN_d(WARN_NON_UNICODE)) {
3166                     UV uv = utf8_to_uvchr(s, &char_len);
3167                     Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
3168                         "Code point 0x%04"UVXf" is not Unicode, may not be portable", uv);
3169                     ok = FALSE;
3170                 }
3171             }
3172             else if (UTF8_IS_SURROGATE(s)) {
3173                 if (ckWARN_d(WARN_SURROGATE)) {
3174                     UV uv = utf8_to_uvchr(s, &char_len);
3175                     Perl_warner(aTHX_ packWARN(WARN_SURROGATE),
3176                         "Unicode surrogate U+%04"UVXf" is illegal in UTF-8", uv);
3177                     ok = FALSE;
3178                 }
3179             }
3180             else if
3181                 ((UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s))
3182                  && (ckWARN_d(WARN_NONCHAR)))
3183             {
3184                 UV uv = utf8_to_uvchr(s, &char_len);
3185                 Perl_warner(aTHX_ packWARN(WARN_NONCHAR),
3186                     "Unicode non-character U+%04"UVXf" is illegal for open interchange", uv);
3187                 ok = FALSE;
3188             }
3189         }
3190         s += UTF8SKIP(s);
3191     }
3192
3193     return ok;
3194 }
3195
3196 /*
3197 =for apidoc pv_uni_display
3198
3199 Build to the scalar dsv a displayable version of the string spv,
3200 length len, the displayable version being at most pvlim bytes long
3201 (if longer, the rest is truncated and "..." will be appended).
3202
3203 The flags argument can have UNI_DISPLAY_ISPRINT set to display
3204 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
3205 to display the \\[nrfta\\] as the backslashed versions (like '\n')
3206 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
3207 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
3208 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
3209
3210 The pointer to the PV of the dsv is returned.
3211
3212 =cut */
3213 char *
3214 Perl_pv_uni_display(pTHX_ SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
3215 {
3216     int truncated = 0;
3217     const char *s, *e;
3218
3219     PERL_ARGS_ASSERT_PV_UNI_DISPLAY;
3220
3221     sv_setpvs(dsv, "");
3222     SvUTF8_off(dsv);
3223     for (s = (const char *)spv, e = s + len; s < e; s += UTF8SKIP(s)) {
3224          UV u;
3225           /* This serves double duty as a flag and a character to print after
3226              a \ when flags & UNI_DISPLAY_BACKSLASH is true.
3227           */
3228          char ok = 0;
3229
3230          if (pvlim && SvCUR(dsv) >= pvlim) {
3231               truncated++;
3232               break;
3233          }
3234          u = utf8_to_uvchr((U8*)s, 0);
3235          if (u < 256) {
3236              const unsigned char c = (unsigned char)u & 0xFF;
3237              if (flags & UNI_DISPLAY_BACKSLASH) {
3238                  switch (c) {
3239                  case '\n':
3240                      ok = 'n'; break;
3241                  case '\r':
3242                      ok = 'r'; break;
3243                  case '\t':
3244                      ok = 't'; break;
3245                  case '\f':
3246                      ok = 'f'; break;
3247                  case '\a':
3248                      ok = 'a'; break;
3249                  case '\\':
3250                      ok = '\\'; break;
3251                  default: break;
3252                  }
3253                  if (ok) {
3254                      const char string = ok;
3255                      sv_catpvs(dsv, "\\");
3256                      sv_catpvn(dsv, &string, 1);
3257                  }
3258              }
3259              /* isPRINT() is the locale-blind version. */
3260              if (!ok && (flags & UNI_DISPLAY_ISPRINT) && isPRINT(c)) {
3261                  const char string = c;
3262                  sv_catpvn(dsv, &string, 1);
3263                  ok = 1;
3264              }
3265          }
3266          if (!ok)
3267              Perl_sv_catpvf(aTHX_ dsv, "\\x{%"UVxf"}", u);
3268     }
3269     if (truncated)
3270          sv_catpvs(dsv, "...");
3271
3272     return SvPVX(dsv);
3273 }
3274
3275 /*
3276 =for apidoc sv_uni_display
3277
3278 Build to the scalar dsv a displayable version of the scalar sv,
3279 the displayable version being at most pvlim bytes long
3280 (if longer, the rest is truncated and "..." will be appended).
3281
3282 The flags argument is as in pv_uni_display().
3283
3284 The pointer to the PV of the dsv is returned.
3285
3286 =cut
3287 */
3288 char *
3289 Perl_sv_uni_display(pTHX_ SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
3290 {
3291     PERL_ARGS_ASSERT_SV_UNI_DISPLAY;
3292
3293      return Perl_pv_uni_display(aTHX_ dsv, (const U8*)SvPVX_const(ssv),
3294                                 SvCUR(ssv), pvlim, flags);
3295 }
3296
3297 /*
3298 =for apidoc foldEQ_utf8
3299
3300 Returns true if the leading portions of the strings s1 and s2 (either or both
3301 of which may be in UTF-8) are the same case-insensitively; false otherwise.
3302 How far into the strings to compare is determined by other input parameters.
3303
3304 If u1 is true, the string s1 is assumed to be in UTF-8-encoded Unicode;
3305 otherwise it is assumed to be in native 8-bit encoding.  Correspondingly for u2
3306 with respect to s2.
3307
3308 If the byte length l1 is non-zero, it says how far into s1 to check for fold
3309 equality.  In other words, s1+l1 will be used as a goal to reach.  The
3310 scan will not be considered to be a match unless the goal is reached, and
3311 scanning won't continue past that goal.  Correspondingly for l2 with respect to
3312 s2.
3313
3314 If pe1 is non-NULL and the pointer it points to is not NULL, that pointer is
3315 considered an end pointer beyond which scanning of s1 will not continue under
3316 any circumstances.  This means that if both l1 and pe1 are specified, and pe1
3317 is less than s1+l1, the match will never be successful because it can never
3318 get as far as its goal (and in fact is asserted against).  Correspondingly for
3319 pe2 with respect to s2.
3320
3321 At least one of s1 and s2 must have a goal (at least one of l1 and l2 must be
3322 non-zero), and if both do, both have to be
3323 reached for a successful match.   Also, if the fold of a character is multiple
3324 characters, all of them must be matched (see tr21 reference below for
3325 'folding').
3326
3327 Upon a successful match, if pe1 is non-NULL,
3328 it will be set to point to the beginning of the I<next> character of s1 beyond
3329 what was matched.  Correspondingly for pe2 and s2.
3330
3331 For case-insensitiveness, the "casefolding" of Unicode is used
3332 instead of upper/lowercasing both the characters, see
3333 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
3334
3335 =cut */
3336
3337 /* A flags parameter has been added which may change, and hence isn't
3338  * externally documented.  Currently it is:
3339  *  0 for as-documented above
3340  *  FOLDEQ_UTF8_NOMIX_ASCII meaning that if a non-ASCII character folds to an
3341                             ASCII one, to not match
3342  *  FOLDEQ_UTF8_LOCALE      meaning that locale rules are to be used for code
3343  *                          points below 256; unicode rules for above 255; and
3344  *                          folds that cross those boundaries are disallowed,
3345  *                          like the NOMIX_ASCII option
3346  */
3347 I32
3348 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)
3349 {
3350     dVAR;
3351     register const U8 *p1  = (const U8*)s1; /* Point to current char */
3352     register const U8 *p2  = (const U8*)s2;
3353     register const U8 *g1 = NULL;       /* goal for s1 */
3354     register const U8 *g2 = NULL;
3355     register const U8 *e1 = NULL;       /* Don't scan s1 past this */
3356     register U8 *f1 = NULL;             /* Point to current folded */
3357     register const U8 *e2 = NULL;
3358     register U8 *f2 = NULL;
3359     STRLEN n1 = 0, n2 = 0;              /* Number of bytes in current char */
3360     U8 foldbuf1[UTF8_MAXBYTES_CASE+1];
3361     U8 foldbuf2[UTF8_MAXBYTES_CASE+1];
3362     U8 natbuf[2];               /* Holds native 8-bit char converted to utf8;
3363                                    these always fit in 2 bytes */
3364
3365     PERL_ARGS_ASSERT_FOLDEQ_UTF8_FLAGS;
3366
3367     if (pe1) {
3368         e1 = *(U8**)pe1;
3369     }
3370
3371     if (l1) {
3372         g1 = (const U8*)s1 + l1;
3373     }
3374
3375     if (pe2) {
3376         e2 = *(U8**)pe2;
3377     }
3378
3379     if (l2) {
3380         g2 = (const U8*)s2 + l2;
3381     }
3382
3383     /* Must have at least one goal */
3384     assert(g1 || g2);
3385
3386     if (g1) {
3387
3388         /* Will never match if goal is out-of-bounds */
3389         assert(! e1  || e1 >= g1);
3390
3391         /* Here, there isn't an end pointer, or it is beyond the goal.  We
3392         * only go as far as the goal */
3393         e1 = g1;
3394     }
3395     else {
3396         assert(e1);    /* Must have an end for looking at s1 */
3397     }
3398
3399     /* Same for goal for s2 */
3400     if (g2) {
3401         assert(! e2  || e2 >= g2);
3402         e2 = g2;
3403     }
3404     else {
3405         assert(e2);
3406     }
3407
3408     /* Look through both strings, a character at a time */
3409     while (p1 < e1 && p2 < e2) {
3410
3411         /* If at the beginning of a new character in s1, get its fold to use
3412          * and the length of the fold.  (exception: locale rules just get the
3413          * character to a single byte) */
3414         if (n1 == 0) {
3415
3416             /* If in locale matching, we use two sets of rules, depending on if
3417              * the code point is above or below 255.  Here, we test for and
3418              * handle locale rules */
3419             if ((flags & FOLDEQ_UTF8_LOCALE)
3420                 && (! u1 || UTF8_IS_INVARIANT(*p1) || UTF8_IS_DOWNGRADEABLE_START(*p1)))
3421             {
3422                 /* There is no mixing of code points above and below 255. */
3423                 if (u2 && (! UTF8_IS_INVARIANT(*p2)
3424                     && ! UTF8_IS_DOWNGRADEABLE_START(*p2)))
3425                 {
3426                     return 0;
3427                 }
3428
3429                 /* We handle locale rules by converting, if necessary, the code
3430                  * point to a single byte. */
3431                 if (! u1 || UTF8_IS_INVARIANT(*p1)) {
3432                     *foldbuf1 = *p1;
3433                 }
3434                 else {
3435                     *foldbuf1 = TWO_BYTE_UTF8_TO_UNI(*p1, *(p1 + 1));
3436                 }
3437                 n1 = 1;
3438             }
3439             else if (isASCII(*p1)) {    /* Note, that here won't be both ASCII
3440                                            and using locale rules */
3441
3442                 /* If trying to mix non- with ASCII, and not supposed to, fail */
3443                 if ((flags & FOLDEQ_UTF8_NOMIX_ASCII) && ! isASCII(*p2)) {
3444                     return 0;
3445                 }
3446                 n1 = 1;
3447                 *foldbuf1 = toLOWER(*p1);   /* Folds in the ASCII range are
3448                                                just lowercased */
3449             }
3450             else if (u1) {
3451                 to_utf8_fold(p1, foldbuf1, &n1);
3452             }
3453             else {  /* Not utf8, convert to it first and then get fold */
3454                 uvuni_to_utf8(natbuf, (UV) NATIVE_TO_UNI(((UV)*p1)));
3455                 to_utf8_fold(natbuf, foldbuf1, &n1);
3456             }
3457             f1 = foldbuf1;
3458         }
3459
3460         if (n2 == 0) {    /* Same for s2 */
3461             if ((flags & FOLDEQ_UTF8_LOCALE)
3462                 && (! u2 || UTF8_IS_INVARIANT(*p2) || UTF8_IS_DOWNGRADEABLE_START(*p2)))
3463             {
3464                 /* Here, the next char in s2 is < 256.  We've already worked on
3465                  * s1, and if it isn't also < 256, can't match */
3466                 if (u1 && (! UTF8_IS_INVARIANT(*p1)
3467                     && ! UTF8_IS_DOWNGRADEABLE_START(*p1)))
3468                 {
3469                     return 0;
3470                 }
3471                 if (! u2 || UTF8_IS_INVARIANT(*p2)) {
3472                     *foldbuf2 = *p2;
3473                 }
3474                 else {
3475                     *foldbuf2 = TWO_BYTE_UTF8_TO_UNI(*p2, *(p2 + 1));
3476                 }
3477
3478                 /* Use another function to handle locale rules.  We've made
3479                  * sure that both characters to compare are single bytes */
3480                 if (! foldEQ_locale((char *) f1, (char *) foldbuf2, 1)) {
3481                     return 0;
3482                 }
3483                 n1 = n2 = 0;
3484             }
3485             else if (isASCII(*p2)) {
3486                 if (flags && ! isASCII(*p1)) {
3487                     return 0;
3488                 }
3489                 n2 = 1;
3490                 *foldbuf2 = toLOWER(*p2);
3491             }
3492             else if (u2) {
3493                 to_utf8_fold(p2, foldbuf2, &n2);
3494             }
3495             else {
3496                 uvuni_to_utf8(natbuf, (UV) NATIVE_TO_UNI(((UV)*p2)));
3497                 to_utf8_fold(natbuf, foldbuf2, &n2);
3498             }
3499             f2 = foldbuf2;
3500         }
3501
3502         /* Here f1 and f2 point to the beginning of the strings to compare.
3503          * These strings are the folds of the input characters, stored in utf8.
3504          */
3505
3506         /* While there is more to look for in both folds, see if they
3507         * continue to match */
3508         while (n1 && n2) {
3509             U8 fold_length = UTF8SKIP(f1);
3510             if (fold_length != UTF8SKIP(f2)
3511                 || (fold_length == 1 && *f1 != *f2) /* Short circuit memNE
3512                                                        function call for single
3513                                                        character */
3514                 || memNE((char*)f1, (char*)f2, fold_length))
3515             {
3516                 return 0; /* mismatch */
3517             }
3518
3519             /* Here, they matched, advance past them */
3520             n1 -= fold_length;
3521             f1 += fold_length;
3522             n2 -= fold_length;
3523             f2 += fold_length;
3524         }
3525
3526         /* When reach the end of any fold, advance the input past it */
3527         if (n1 == 0) {
3528             p1 += u1 ? UTF8SKIP(p1) : 1;
3529         }
3530         if (n2 == 0) {
3531             p2 += u2 ? UTF8SKIP(p2) : 1;
3532         }
3533     } /* End of loop through both strings */
3534
3535     /* A match is defined by each scan that specified an explicit length
3536     * reaching its final goal, and the other not having matched a partial
3537     * character (which can happen when the fold of a character is more than one
3538     * character). */
3539     if (! ((g1 == 0 || p1 == g1) && (g2 == 0 || p2 == g2)) || n1 || n2) {
3540         return 0;
3541     }
3542
3543     /* Successful match.  Set output pointers */
3544     if (pe1) {
3545         *pe1 = (char*)p1;
3546     }
3547     if (pe2) {
3548         *pe2 = (char*)p2;
3549     }
3550     return 1;
3551 }
3552
3553 /*
3554  * Local variables:
3555  * c-indentation-style: bsd
3556  * c-basic-offset: 4
3557  * indent-tabs-mode: t
3558  * End:
3559  *
3560  * ex: set ts=8 sts=4 sw=4 noet:
3561  */