This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
8ea2d7a76d0fb28e5bdb33256296a60b719eb423
[perl5.git] / utf8.c
1 /*    utf8.c
2  *
3  *    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005 by Larry Wall and
4  *    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  * 'Well do I understand your speech,' he answered in the same language;
17  * 'yet few strangers do so.  Why then do you not speak in the Common Tongue,
18  * as is the custom in the West, if you wish to be answered?'
19  *
20  * ...the travellers perceived that the floor was paved with stones of many
21  * hues; branching runes and strange devices intertwined beneath their feet.
22  */
23
24 #include "EXTERN.h"
25 #define PERL_IN_UTF8_C
26 #include "perl.h"
27
28 static const char unees[] =
29     "Malformed UTF-8 character (unexpected end of string)";
30
31 /* 
32 =head1 Unicode Support
33
34 This file contains various utility functions for manipulating UTF8-encoded
35 strings. For the uninitiated, this is a method of representing arbitrary
36 Unicode characters as a variable number of bytes, in such a way that
37 characters in the ASCII range are unmodified, and a zero byte never appears
38 within non-zero characters.
39
40 =for apidoc A|U8 *|uvuni_to_utf8_flags|U8 *d|UV uv|UV flags
41
42 Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
43 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
44 bytes available. The return value is the pointer to the byte after the
45 end of the new character. In other words,
46
47     d = uvuni_to_utf8_flags(d, uv, flags);
48
49 or, in most cases,
50
51     d = uvuni_to_utf8(d, uv);
52
53 (which is equivalent to)
54
55     d = uvuni_to_utf8_flags(d, uv, 0);
56
57 is the recommended Unicode-aware way of saying
58
59     *(d++) = uv;
60
61 =cut
62 */
63
64 U8 *
65 Perl_uvuni_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
66 {
67     if (ckWARN(WARN_UTF8)) {
68          if (UNICODE_IS_SURROGATE(uv) &&
69              !(flags & UNICODE_ALLOW_SURROGATE))
70               Perl_warner(aTHX_ packWARN(WARN_UTF8), "UTF-16 surrogate 0x%04"UVxf, uv);
71          else if (
72                   ((uv >= 0xFDD0 && uv <= 0xFDEF &&
73                     !(flags & UNICODE_ALLOW_FDD0))
74                    ||
75                    ((uv & 0xFFFE) == 0xFFFE && /* Either FFFE or FFFF. */
76                     !(flags & UNICODE_ALLOW_FFFF))) &&
77                   /* UNICODE_ALLOW_SUPER includes
78                    * FFFEs and FFFFs beyond 0x10FFFF. */
79                   ((uv <= PERL_UNICODE_MAX) ||
80                    !(flags & UNICODE_ALLOW_SUPER))
81                   )
82               Perl_warner(aTHX_ packWARN(WARN_UTF8),
83                          "Unicode character 0x%04"UVxf" is illegal", uv);
84     }
85     if (UNI_IS_INVARIANT(uv)) {
86         *d++ = (U8)UTF_TO_NATIVE(uv);
87         return d;
88     }
89 #if defined(EBCDIC)
90     else {
91         STRLEN len  = UNISKIP(uv);
92         U8 *p = d+len-1;
93         while (p > d) {
94             *p-- = (U8)UTF_TO_NATIVE((uv & UTF_CONTINUATION_MASK) | UTF_CONTINUATION_MARK);
95             uv >>= UTF_ACCUMULATION_SHIFT;
96         }
97         *p = (U8)UTF_TO_NATIVE((uv & UTF_START_MASK(len)) | UTF_START_MARK(len));
98         return d+len;
99     }
100 #else /* Non loop style */
101     if (uv < 0x800) {
102         *d++ = (U8)(( uv >>  6)         | 0xc0);
103         *d++ = (U8)(( uv        & 0x3f) | 0x80);
104         return d;
105     }
106     if (uv < 0x10000) {
107         *d++ = (U8)(( uv >> 12)         | 0xe0);
108         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
109         *d++ = (U8)(( uv        & 0x3f) | 0x80);
110         return d;
111     }
112     if (uv < 0x200000) {
113         *d++ = (U8)(( uv >> 18)         | 0xf0);
114         *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
115         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
116         *d++ = (U8)(( uv        & 0x3f) | 0x80);
117         return d;
118     }
119     if (uv < 0x4000000) {
120         *d++ = (U8)(( uv >> 24)         | 0xf8);
121         *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
122         *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
123         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
124         *d++ = (U8)(( uv        & 0x3f) | 0x80);
125         return d;
126     }
127     if (uv < 0x80000000) {
128         *d++ = (U8)(( uv >> 30)         | 0xfc);
129         *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
130         *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
131         *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
132         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
133         *d++ = (U8)(( uv        & 0x3f) | 0x80);
134         return d;
135     }
136 #ifdef HAS_QUAD
137     if (uv < UTF8_QUAD_MAX)
138 #endif
139     {
140         *d++ =                            0xfe; /* Can't match U+FEFF! */
141         *d++ = (U8)(((uv >> 30) & 0x3f) | 0x80);
142         *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
143         *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
144         *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
145         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
146         *d++ = (U8)(( uv        & 0x3f) | 0x80);
147         return d;
148     }
149 #ifdef HAS_QUAD
150     {
151         *d++ =                            0xff;         /* Can't match U+FFFE! */
152         *d++ =                            0x80;         /* 6 Reserved bits */
153         *d++ = (U8)(((uv >> 60) & 0x0f) | 0x80);        /* 2 Reserved bits */
154         *d++ = (U8)(((uv >> 54) & 0x3f) | 0x80);
155         *d++ = (U8)(((uv >> 48) & 0x3f) | 0x80);
156         *d++ = (U8)(((uv >> 42) & 0x3f) | 0x80);
157         *d++ = (U8)(((uv >> 36) & 0x3f) | 0x80);
158         *d++ = (U8)(((uv >> 30) & 0x3f) | 0x80);
159         *d++ = (U8)(((uv >> 24) & 0x3f) | 0x80);
160         *d++ = (U8)(((uv >> 18) & 0x3f) | 0x80);
161         *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
162         *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
163         *d++ = (U8)(( uv        & 0x3f) | 0x80);
164         return d;
165     }
166 #endif
167 #endif /* Loop style */
168 }
169  
170 U8 *
171 Perl_uvuni_to_utf8(pTHX_ U8 *d, UV uv)
172 {
173     return Perl_uvuni_to_utf8_flags(aTHX_ d, uv, 0);
174 }
175
176 /*
177
178 Tests if some arbitrary number of bytes begins in a valid UTF-8
179 character.  Note that an INVARIANT (i.e. ASCII) character is a valid
180 UTF-8 character.  The actual number of bytes in the UTF-8 character
181 will be returned if it is valid, otherwise 0.
182
183 This is the "slow" version as opposed to the "fast" version which is
184 the "unrolled" IS_UTF8_CHAR().  E.g. for t/uni/class.t the speed
185 difference is a factor of 2 to 3.  For lengths (UTF8SKIP(s)) of four
186 or less you should use the IS_UTF8_CHAR(), for lengths of five or more
187 you should use the _slow().  In practice this means that the _slow()
188 will be used very rarely, since the maximum Unicode code point (as of
189 Unicode 4.1) is U+10FFFF, which encodes in UTF-8 to four bytes.  Only
190 the "Perl extended UTF-8" (the infamous 'v-strings') will encode into
191 five bytes or more.
192
193 =cut */
194 STATIC STRLEN
195 S_is_utf8_char_slow(pTHX_ const U8 *s, const STRLEN len)
196 {
197     U8 u = *s;
198     STRLEN slen;
199     UV uv, ouv;
200
201     if (UTF8_IS_INVARIANT(u))
202         return 1;
203
204     if (!UTF8_IS_START(u))
205         return 0;
206
207     if (len < 2 || !UTF8_IS_CONTINUATION(s[1]))
208         return 0;
209
210     slen = len - 1;
211     s++;
212 #ifdef EBCDIC
213     u = NATIVE_TO_UTF(u);
214 #endif
215     u &= UTF_START_MASK(len);
216     uv  = u;
217     ouv = uv;
218     while (slen--) {
219         if (!UTF8_IS_CONTINUATION(*s))
220             return 0;
221         uv = UTF8_ACCUMULATE(uv, *s);
222         if (uv < ouv) 
223             return 0;
224         ouv = uv;
225         s++;
226     }
227
228     if ((STRLEN)UNISKIP(uv) < len)
229         return 0;
230
231     return len;
232 }
233
234 /*
235 =for apidoc A|STRLEN|is_utf8_char|const U8 *s
236
237 Tests if some arbitrary number of bytes begins in a valid UTF-8
238 character.  Note that an INVARIANT (i.e. ASCII) character is a valid
239 UTF-8 character.  The actual number of bytes in the UTF-8 character
240 will be returned if it is valid, otherwise 0.
241
242 =cut */
243 STRLEN
244 Perl_is_utf8_char(pTHX_ const U8 *s)
245 {
246     const STRLEN len = UTF8SKIP(s);
247 #ifdef IS_UTF8_CHAR
248     if (IS_UTF8_CHAR_FAST(len))
249         return IS_UTF8_CHAR(s, len) ? len : 0;
250 #endif /* #ifdef IS_UTF8_CHAR */
251     return is_utf8_char_slow(s, len);
252 }
253
254 /*
255 =for apidoc A|bool|is_utf8_string|const U8 *s|STRLEN len
256
257 Returns true if first C<len> bytes of the given string form a valid
258 UTF-8 string, false otherwise.  Note that 'a valid UTF-8 string' does
259 not mean 'a string that contains code points above 0x7F encoded in UTF-8'
260 because a valid ASCII string is a valid UTF-8 string.
261
262 See also is_utf8_string_loclen() and is_utf8_string_loc().
263
264 =cut
265 */
266
267 bool
268 Perl_is_utf8_string(pTHX_ const U8 *s, STRLEN len)
269 {
270     const U8* x = s;
271     const U8* send;
272
273     if (!len)
274         len = strlen((const char *)s);
275     send = s + len;
276
277     while (x < send) {
278         STRLEN c;
279          /* Inline the easy bits of is_utf8_char() here for speed... */
280          if (UTF8_IS_INVARIANT(*x))
281               c = 1;
282          else if (!UTF8_IS_START(*x))
283              goto out;
284          else {
285               /* ... and call is_utf8_char() only if really needed. */
286 #ifdef IS_UTF8_CHAR
287              c = UTF8SKIP(x);
288              if (IS_UTF8_CHAR_FAST(c)) {
289                  if (!IS_UTF8_CHAR(x, c))
290                      goto out;
291              } else if (!is_utf8_char_slow(x, c))
292                  goto out;
293 #else
294              c = is_utf8_char(x);
295 #endif /* #ifdef IS_UTF8_CHAR */
296               if (!c)
297                   goto out;
298          }
299         x += c;
300     }
301
302  out:
303     if (x != send)
304         return FALSE;
305
306     return TRUE;
307 }
308
309 /*
310 =for apidoc A|bool|is_utf8_string_loclen|const U8 *s|STRLEN len|const U8 **ep|const STRLEN *el
311
312 Like is_ut8_string() but stores the location of the failure (in the
313 case of "utf8ness failure") or the location s+len (in the case of
314 "utf8ness success") in the C<ep>, and the number of UTF-8
315 encoded characters in the C<el>.
316
317 See also is_utf8_string_loc() and is_utf8_string().
318
319 =cut
320 */
321
322 bool
323 Perl_is_utf8_string_loclen(pTHX_ const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
324 {
325     const U8* x = s;
326     const U8* send;
327     STRLEN c;
328
329     if (!len)
330         len = strlen((const char *)s);
331     send = s + len;
332     if (el)
333         *el = 0;
334
335     while (x < send) {
336          /* Inline the easy bits of is_utf8_char() here for speed... */
337          if (UTF8_IS_INVARIANT(*x))
338              c = 1;
339          else if (!UTF8_IS_START(*x))
340              goto out;
341          else {
342              /* ... and call is_utf8_char() only if really needed. */
343 #ifdef IS_UTF8_CHAR
344              c = UTF8SKIP(x);
345              if (IS_UTF8_CHAR_FAST(c)) {
346                  if (!IS_UTF8_CHAR(x, c))
347                      c = 0;
348              } else
349                  c = is_utf8_char_slow(x, c);
350 #else
351              c = is_utf8_char(x);
352 #endif /* #ifdef IS_UTF8_CHAR */
353              if (!c)
354                  goto out;
355          }
356          x += c;
357          if (el)
358              (*el)++;
359     }
360
361  out:
362     if (ep)
363         *ep = x;
364     if (x != send)
365         return FALSE;
366
367     return TRUE;
368 }
369
370 /*
371 =for apidoc A|bool|is_utf8_string_loc|const U8 *s|STRLEN len|const U8 **ep|const STRLEN *el
372
373 Like is_ut8_string() but stores the location of the failure (in the
374 case of "utf8ness failure") or the location s+len (in the case of
375 "utf8ness success") in the C<ep>.
376
377 See also is_utf8_string_loclen() and is_utf8_string().
378
379 =cut
380 */
381
382 bool
383 Perl_is_utf8_string_loc(pTHX_ const U8 *s, STRLEN len, const U8 **ep)
384 {
385     return is_utf8_string_loclen(s, len, ep, 0);
386 }
387
388 /*
389 =for apidoc A|UV|utf8n_to_uvuni|const U8 *s|STRLEN curlen|STRLEN *retlen|U32 flags
390
391 Bottom level UTF-8 decode routine.
392 Returns the unicode code point value of the first character in the string C<s>
393 which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
394 C<retlen> will be set to the length, in bytes, of that character.
395
396 If C<s> does not point to a well-formed UTF-8 character, the behaviour
397 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
398 it is assumed that the caller will raise a warning, and this function
399 will silently just set C<retlen> to C<-1> and return zero.  If the
400 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
401 malformations will be given, C<retlen> will be set to the expected
402 length of the UTF-8 character in bytes, and zero will be returned.
403
404 The C<flags> can also contain various flags to allow deviations from
405 the strict UTF-8 encoding (see F<utf8.h>).
406
407 Most code should use utf8_to_uvchr() rather than call this directly.
408
409 =cut
410 */
411
412 UV
413 Perl_utf8n_to_uvuni(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
414 {
415     const U8 *s0 = s;
416     UV uv = *s, ouv = 0;
417     STRLEN len = 1;
418     const bool dowarn = ckWARN_d(WARN_UTF8);
419     const UV startbyte = *s;
420     STRLEN expectlen = 0;
421     U32 warning = 0;
422
423 /* This list is a superset of the UTF8_ALLOW_XXX. */
424
425 #define UTF8_WARN_EMPTY                          1
426 #define UTF8_WARN_CONTINUATION                   2
427 #define UTF8_WARN_NON_CONTINUATION               3
428 #define UTF8_WARN_FE_FF                          4
429 #define UTF8_WARN_SHORT                          5
430 #define UTF8_WARN_OVERFLOW                       6
431 #define UTF8_WARN_SURROGATE                      7
432 #define UTF8_WARN_LONG                           8
433 #define UTF8_WARN_FFFF                           9 /* Also FFFE. */
434
435     if (curlen == 0 &&
436         !(flags & UTF8_ALLOW_EMPTY)) {
437         warning = UTF8_WARN_EMPTY;
438         goto malformed;
439     }
440
441     if (UTF8_IS_INVARIANT(uv)) {
442         if (retlen)
443             *retlen = 1;
444         return (UV) (NATIVE_TO_UTF(*s));
445     }
446
447     if (UTF8_IS_CONTINUATION(uv) &&
448         !(flags & UTF8_ALLOW_CONTINUATION)) {
449         warning = UTF8_WARN_CONTINUATION;
450         goto malformed;
451     }
452
453     if (UTF8_IS_START(uv) && curlen > 1 && !UTF8_IS_CONTINUATION(s[1]) &&
454         !(flags & UTF8_ALLOW_NON_CONTINUATION)) {
455         warning = UTF8_WARN_NON_CONTINUATION;
456         goto malformed;
457     }
458
459 #ifdef EBCDIC
460     uv = NATIVE_TO_UTF(uv);
461 #else
462     if ((uv == 0xfe || uv == 0xff) &&
463         !(flags & UTF8_ALLOW_FE_FF)) {
464         warning = UTF8_WARN_FE_FF;
465         goto malformed;
466     }
467 #endif
468
469     if      (!(uv & 0x20))      { len =  2; uv &= 0x1f; }
470     else if (!(uv & 0x10))      { len =  3; uv &= 0x0f; }
471     else if (!(uv & 0x08))      { len =  4; uv &= 0x07; }
472     else if (!(uv & 0x04))      { len =  5; uv &= 0x03; }
473 #ifdef EBCDIC
474     else if (!(uv & 0x02))      { len =  6; uv &= 0x01; }
475     else                        { len =  7; uv &= 0x01; }
476 #else
477     else if (!(uv & 0x02))      { len =  6; uv &= 0x01; }
478     else if (!(uv & 0x01))      { len =  7; uv = 0; }
479     else                        { len = 13; uv = 0; } /* whoa! */
480 #endif
481
482     if (retlen)
483         *retlen = len;
484
485     expectlen = len;
486
487     if ((curlen < expectlen) &&
488         !(flags & UTF8_ALLOW_SHORT)) {
489         warning = UTF8_WARN_SHORT;
490         goto malformed;
491     }
492
493     len--;
494     s++;
495     ouv = uv;
496
497     while (len--) {
498         if (!UTF8_IS_CONTINUATION(*s) &&
499             !(flags & UTF8_ALLOW_NON_CONTINUATION)) {
500             s--;
501             warning = UTF8_WARN_NON_CONTINUATION;
502             goto malformed;
503         }
504         else
505             uv = UTF8_ACCUMULATE(uv, *s);
506         if (!(uv > ouv)) {
507             /* These cannot be allowed. */
508             if (uv == ouv) {
509                 if (expectlen != 13 && !(flags & UTF8_ALLOW_LONG)) {
510                     warning = UTF8_WARN_LONG;
511                     goto malformed;
512                 }
513             }
514             else { /* uv < ouv */
515                 /* This cannot be allowed. */
516                 warning = UTF8_WARN_OVERFLOW;
517                 goto malformed;
518             }
519         }
520         s++;
521         ouv = uv;
522     }
523
524     if (UNICODE_IS_SURROGATE(uv) &&
525         !(flags & UTF8_ALLOW_SURROGATE)) {
526         warning = UTF8_WARN_SURROGATE;
527         goto malformed;
528     } else if ((expectlen > (STRLEN)UNISKIP(uv)) &&
529                !(flags & UTF8_ALLOW_LONG)) {
530         warning = UTF8_WARN_LONG;
531         goto malformed;
532     } else if (UNICODE_IS_ILLEGAL(uv) &&
533                !(flags & UTF8_ALLOW_FFFF)) {
534         warning = UTF8_WARN_FFFF;
535         goto malformed;
536     }
537
538     return uv;
539
540 malformed:
541
542     if (flags & UTF8_CHECK_ONLY) {
543         if (retlen)
544             *retlen = -1;
545         return 0;
546     }
547
548     if (dowarn) {
549         SV* const sv = sv_2mortal(newSVpv("Malformed UTF-8 character ", 0));
550
551         switch (warning) {
552         case 0: /* Intentionally empty. */ break;
553         case UTF8_WARN_EMPTY:
554             Perl_sv_catpv(aTHX_ sv, "(empty string)");
555             break;
556         case UTF8_WARN_CONTINUATION:
557             Perl_sv_catpvf(aTHX_ sv, "(unexpected continuation byte 0x%02"UVxf", with no preceding start byte)", uv);
558             break;
559         case UTF8_WARN_NON_CONTINUATION:
560             if (s == s0)
561                 Perl_sv_catpvf(aTHX_ sv, "(unexpected non-continuation byte 0x%02"UVxf", immediately after start byte 0x%02"UVxf")",
562                            (UV)s[1], startbyte);
563             else
564                 Perl_sv_catpvf(aTHX_ sv, "(unexpected non-continuation byte 0x%02"UVxf", %d byte%s after start byte 0x%02"UVxf", expected %d bytes)",
565                            (UV)s[1], s - s0, s - s0 > 1 ? "s" : "", startbyte, (int)expectlen);
566               
567             break;
568         case UTF8_WARN_FE_FF:
569             Perl_sv_catpvf(aTHX_ sv, "(byte 0x%02"UVxf")", uv);
570             break;
571         case UTF8_WARN_SHORT:
572             Perl_sv_catpvf(aTHX_ sv, "(%d byte%s, need %d, after start byte 0x%02"UVxf")",
573                            (int)curlen, curlen == 1 ? "" : "s", (int)expectlen, startbyte);
574             expectlen = curlen;         /* distance for caller to skip */
575             break;
576         case UTF8_WARN_OVERFLOW:
577             Perl_sv_catpvf(aTHX_ sv, "(overflow at 0x%"UVxf", byte 0x%02x, after start byte 0x%02"UVxf")",
578                            ouv, *s, startbyte);
579             break;
580         case UTF8_WARN_SURROGATE:
581             Perl_sv_catpvf(aTHX_ sv, "(UTF-16 surrogate 0x%04"UVxf")", uv);
582             break;
583         case UTF8_WARN_LONG:
584             Perl_sv_catpvf(aTHX_ sv, "(%d byte%s, need %d, after start byte 0x%02"UVxf")",
585                            (int)expectlen, expectlen == 1 ? "": "s", UNISKIP(uv), startbyte);
586             break;
587         case UTF8_WARN_FFFF:
588             Perl_sv_catpvf(aTHX_ sv, "(character 0x%04"UVxf")", uv);
589             break;
590         default:
591             Perl_sv_catpv(aTHX_ sv, "(unknown reason)");
592             break;
593         }
594         
595         if (warning) {
596             const char * const s = SvPVX_const(sv);
597
598             if (PL_op)
599                 Perl_warner(aTHX_ packWARN(WARN_UTF8),
600                             "%s in %s", s,  OP_DESC(PL_op));
601             else
602                 Perl_warner(aTHX_ packWARN(WARN_UTF8), "%s", s);
603         }
604     }
605
606     if (retlen)
607         *retlen = expectlen ? expectlen : len;
608
609     return 0;
610 }
611
612 /*
613 =for apidoc A|UV|utf8_to_uvchr|const U8 *s|STRLEN *retlen
614
615 Returns the native character value of the first character in the string C<s>
616 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
617 length, in bytes, of that character.
618
619 If C<s> does not point to a well-formed UTF-8 character, zero is
620 returned and retlen is set, if possible, to -1.
621
622 =cut
623 */
624
625 UV
626 Perl_utf8_to_uvchr(pTHX_ const U8 *s, STRLEN *retlen)
627 {
628     return Perl_utf8n_to_uvchr(aTHX_ s, UTF8_MAXBYTES, retlen,
629                                ckWARN(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY);
630 }
631
632 /*
633 =for apidoc A|UV|utf8_to_uvuni|const U8 *s|STRLEN *retlen
634
635 Returns the Unicode code point of the first character in the string C<s>
636 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
637 length, in bytes, of that character.
638
639 This function should only be used when returned UV is considered
640 an index into the Unicode semantic tables (e.g. swashes).
641
642 If C<s> does not point to a well-formed UTF-8 character, zero is
643 returned and retlen is set, if possible, to -1.
644
645 =cut
646 */
647
648 UV
649 Perl_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
650 {
651     /* Call the low level routine asking for checks */
652     return Perl_utf8n_to_uvuni(aTHX_ s, UTF8_MAXBYTES, retlen,
653                                ckWARN(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY);
654 }
655
656 /*
657 =for apidoc A|STRLEN|utf8_length|const U8 *s|const U8 *e
658
659 Return the length of the UTF-8 char encoded string C<s> in characters.
660 Stops at C<e> (inclusive).  If C<e E<lt> s> or if the scan would end
661 up past C<e>, croaks.
662
663 =cut
664 */
665
666 STRLEN
667 Perl_utf8_length(pTHX_ const U8 *s, const U8 *e)
668 {
669     STRLEN len = 0;
670
671     /* Note: cannot use UTF8_IS_...() too eagerly here since e.g.
672      * the bitops (especially ~) can create illegal UTF-8.
673      * In other words: in Perl UTF-8 is not just for Unicode. */
674
675     if (e < s)
676         goto warn_and_return;
677     while (s < e) {
678         const U8 t = UTF8SKIP(s);
679         if (e - s < t) {
680             warn_and_return:
681             if (ckWARN_d(WARN_UTF8)) {
682                 if (PL_op)
683                     Perl_warner(aTHX_ packWARN(WARN_UTF8),
684                             "%s in %s", unees, OP_DESC(PL_op));
685                 else
686                     Perl_warner(aTHX_ packWARN(WARN_UTF8), unees);
687             }
688             return len;
689         }
690         s += t;
691         len++;
692     }
693
694     return len;
695 }
696
697 /*
698 =for apidoc A|IV|utf8_distance|const U8 *a|const U8 *b
699
700 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
701 and C<b>.
702
703 WARNING: use only if you *know* that the pointers point inside the
704 same UTF-8 buffer.
705
706 =cut
707 */
708
709 IV
710 Perl_utf8_distance(pTHX_ const U8 *a, const U8 *b)
711 {
712     IV off = 0;
713
714     /* Note: cannot use UTF8_IS_...() too eagerly here since  e.g.
715      * the bitops (especially ~) can create illegal UTF-8.
716      * In other words: in Perl UTF-8 is not just for Unicode. */
717
718     if (a < b) {
719         while (a < b) {
720             const U8 c = UTF8SKIP(a);
721             if (b - a < c)
722                 goto warn_and_return;
723             a += c;
724             off--;
725         }
726     }
727     else {
728         while (b < a) {
729             const U8 c = UTF8SKIP(b);
730
731             if (a - b < c) {
732                 warn_and_return:
733                 if (ckWARN_d(WARN_UTF8)) {
734                     if (PL_op)
735                         Perl_warner(aTHX_ packWARN(WARN_UTF8),
736                                     "%s in %s", unees, OP_DESC(PL_op));
737                     else
738                         Perl_warner(aTHX_ packWARN(WARN_UTF8), unees);
739                 }
740                 return off;
741             }
742             b += c;
743             off++;
744         }
745     }
746
747     return off;
748 }
749
750 /*
751 =for apidoc A|U8 *|utf8_hop|U8 *s|I32 off
752
753 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
754 forward or backward.
755
756 WARNING: do not use the following unless you *know* C<off> is within
757 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
758 on the first byte of character or just after the last byte of a character.
759
760 =cut
761 */
762
763 U8 *
764 Perl_utf8_hop(pTHX_ const U8 *s, I32 off)
765 {
766     /* Note: cannot use UTF8_IS_...() too eagerly here since e.g
767      * the bitops (especially ~) can create illegal UTF-8.
768      * In other words: in Perl UTF-8 is not just for Unicode. */
769
770     if (off >= 0) {
771         while (off--)
772             s += UTF8SKIP(s);
773     }
774     else {
775         while (off++) {
776             s--;
777             while (UTF8_IS_CONTINUATION(*s))
778                 s--;
779         }
780     }
781     return (U8 *)s;
782 }
783
784 /*
785 =for apidoc A|U8 *|utf8_to_bytes|U8 *s|STRLEN *len
786
787 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
788 Unlike C<bytes_to_utf8>, this over-writes the original string, and
789 updates len to contain the new length.
790 Returns zero on failure, setting C<len> to -1.
791
792 =cut
793 */
794
795 U8 *
796 Perl_utf8_to_bytes(pTHX_ U8 *s, STRLEN *len)
797 {
798     U8 *send;
799     U8 *d;
800     U8 *save = s;
801
802     /* ensure valid UTF-8 and chars < 256 before updating string */
803     for (send = s + *len; s < send; ) {
804         U8 c = *s++;
805
806         if (!UTF8_IS_INVARIANT(c) &&
807             (!UTF8_IS_DOWNGRADEABLE_START(c) || (s >= send)
808              || !(c = *s++) || !UTF8_IS_CONTINUATION(c))) {
809             *len = -1;
810             return 0;
811         }
812     }
813
814     d = s = save;
815     while (s < send) {
816         STRLEN ulen;
817         *d++ = (U8)utf8_to_uvchr(s, &ulen);
818         s += ulen;
819     }
820     *d = '\0';
821     *len = d - save;
822     return save;
823 }
824
825 /*
826 =for apidoc A|U8 *|bytes_from_utf8|const U8 *s|STRLEN *len|bool *is_utf8
827
828 Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
829 Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
830 the newly-created string, and updates C<len> to contain the new
831 length.  Returns the original string if no conversion occurs, C<len>
832 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
833 0 if C<s> is converted or contains all 7bit characters.
834
835 =cut
836 */
837
838 U8 *
839 Perl_bytes_from_utf8(pTHX_ const U8 *s, STRLEN *len, bool *is_utf8)
840 {
841     U8 *d;
842     const U8 *start = s;
843     const U8 *send;
844     I32 count = 0;
845
846     if (!*is_utf8)
847         return (U8 *)start;
848
849     /* ensure valid UTF-8 and chars < 256 before converting string */
850     for (send = s + *len; s < send;) {
851         U8 c = *s++;
852         if (!UTF8_IS_INVARIANT(c)) {
853             if (UTF8_IS_DOWNGRADEABLE_START(c) && s < send &&
854                 (c = *s++) && UTF8_IS_CONTINUATION(c))
855                 count++;
856             else
857                 return (U8 *)start;
858         }
859     }
860
861     *is_utf8 = 0;               
862
863     Newxz(d, (*len) - count + 1, U8);
864     s = start; start = d;
865     while (s < send) {
866         U8 c = *s++;
867         if (!UTF8_IS_INVARIANT(c)) {
868             /* Then it is two-byte encoded */
869             c = UTF8_ACCUMULATE(NATIVE_TO_UTF(c), *s++);
870             c = ASCII_TO_NATIVE(c);
871         }
872         *d++ = c;
873     }
874     *d = '\0';
875     *len = d - start;
876     return (U8 *)start;
877 }
878
879 /*
880 =for apidoc A|U8 *|bytes_to_utf8|const U8 *s|STRLEN *len
881
882 Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
883 Returns a pointer to the newly-created string, and sets C<len> to
884 reflect the new length.
885
886 If you want to convert to UTF-8 from other encodings than ASCII,
887 see sv_recode_to_utf8().
888
889 =cut
890 */
891
892 U8*
893 Perl_bytes_to_utf8(pTHX_ const U8 *s, STRLEN *len)
894 {
895     const U8 * const send = s + (*len);
896     U8 *d;
897     U8 *dst;
898
899     Newxz(d, (*len) * 2 + 1, U8);
900     dst = d;
901
902     while (s < send) {
903         const UV uv = NATIVE_TO_ASCII(*s++);
904         if (UNI_IS_INVARIANT(uv))
905             *d++ = (U8)UTF_TO_NATIVE(uv);
906         else {
907             *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
908             *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
909         }
910     }
911     *d = '\0';
912     *len = d-dst;
913     return dst;
914 }
915
916 /*
917  * Convert native (big-endian) or reversed (little-endian) UTF-16 to UTF-8.
918  *
919  * Destination must be pre-extended to 3/2 source.  Do not use in-place.
920  * We optimize for native, for obvious reasons. */
921
922 U8*
923 Perl_utf16_to_utf8(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
924 {
925     U8* pend;
926     U8* dstart = d;
927
928     if (bytelen == 1 && p[0] == 0) { /* Be understanding. */
929          d[0] = 0;
930          *newlen = 1;
931          return d;
932     }
933
934     if (bytelen & 1)
935         Perl_croak(aTHX_ "panic: utf16_to_utf8: odd bytelen %"UVf, (UV)bytelen);
936
937     pend = p + bytelen;
938
939     while (p < pend) {
940         UV uv = (p[0] << 8) + p[1]; /* UTF-16BE */
941         p += 2;
942         if (uv < 0x80) {
943             *d++ = (U8)uv;
944             continue;
945         }
946         if (uv < 0x800) {
947             *d++ = (U8)(( uv >>  6)         | 0xc0);
948             *d++ = (U8)(( uv        & 0x3f) | 0x80);
949             continue;
950         }
951         if (uv >= 0xd800 && uv < 0xdbff) {      /* surrogates */
952             UV low = (p[0] << 8) + p[1];
953             p += 2;
954             if (low < 0xdc00 || low >= 0xdfff)
955                 Perl_croak(aTHX_ "Malformed UTF-16 surrogate");
956             uv = ((uv - 0xd800) << 10) + (low - 0xdc00) + 0x10000;
957         }
958         if (uv < 0x10000) {
959             *d++ = (U8)(( uv >> 12)         | 0xe0);
960             *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
961             *d++ = (U8)(( uv        & 0x3f) | 0x80);
962             continue;
963         }
964         else {
965             *d++ = (U8)(( uv >> 18)         | 0xf0);
966             *d++ = (U8)(((uv >> 12) & 0x3f) | 0x80);
967             *d++ = (U8)(((uv >>  6) & 0x3f) | 0x80);
968             *d++ = (U8)(( uv        & 0x3f) | 0x80);
969             continue;
970         }
971     }
972     *newlen = d - dstart;
973     return d;
974 }
975
976 /* Note: this one is slightly destructive of the source. */
977
978 U8*
979 Perl_utf16_to_utf8_reversed(pTHX_ U8* p, U8* d, I32 bytelen, I32 *newlen)
980 {
981     U8* s = (U8*)p;
982     U8* send = s + bytelen;
983     while (s < send) {
984         U8 tmp = s[0];
985         s[0] = s[1];
986         s[1] = tmp;
987         s += 2;
988     }
989     return utf16_to_utf8(p, d, bytelen, newlen);
990 }
991
992 /* for now these are all defined (inefficiently) in terms of the utf8 versions */
993
994 bool
995 Perl_is_uni_alnum(pTHX_ UV c)
996 {
997     U8 tmpbuf[UTF8_MAXBYTES+1];
998     uvchr_to_utf8(tmpbuf, c);
999     return is_utf8_alnum(tmpbuf);
1000 }
1001
1002 bool
1003 Perl_is_uni_alnumc(pTHX_ UV c)
1004 {
1005     U8 tmpbuf[UTF8_MAXBYTES+1];
1006     uvchr_to_utf8(tmpbuf, c);
1007     return is_utf8_alnumc(tmpbuf);
1008 }
1009
1010 bool
1011 Perl_is_uni_idfirst(pTHX_ UV c)
1012 {
1013     U8 tmpbuf[UTF8_MAXBYTES+1];
1014     uvchr_to_utf8(tmpbuf, c);
1015     return is_utf8_idfirst(tmpbuf);
1016 }
1017
1018 bool
1019 Perl_is_uni_alpha(pTHX_ UV c)
1020 {
1021     U8 tmpbuf[UTF8_MAXBYTES+1];
1022     uvchr_to_utf8(tmpbuf, c);
1023     return is_utf8_alpha(tmpbuf);
1024 }
1025
1026 bool
1027 Perl_is_uni_ascii(pTHX_ UV c)
1028 {
1029     U8 tmpbuf[UTF8_MAXBYTES+1];
1030     uvchr_to_utf8(tmpbuf, c);
1031     return is_utf8_ascii(tmpbuf);
1032 }
1033
1034 bool
1035 Perl_is_uni_space(pTHX_ UV c)
1036 {
1037     U8 tmpbuf[UTF8_MAXBYTES+1];
1038     uvchr_to_utf8(tmpbuf, c);
1039     return is_utf8_space(tmpbuf);
1040 }
1041
1042 bool
1043 Perl_is_uni_digit(pTHX_ UV c)
1044 {
1045     U8 tmpbuf[UTF8_MAXBYTES+1];
1046     uvchr_to_utf8(tmpbuf, c);
1047     return is_utf8_digit(tmpbuf);
1048 }
1049
1050 bool
1051 Perl_is_uni_upper(pTHX_ UV c)
1052 {
1053     U8 tmpbuf[UTF8_MAXBYTES+1];
1054     uvchr_to_utf8(tmpbuf, c);
1055     return is_utf8_upper(tmpbuf);
1056 }
1057
1058 bool
1059 Perl_is_uni_lower(pTHX_ UV c)
1060 {
1061     U8 tmpbuf[UTF8_MAXBYTES+1];
1062     uvchr_to_utf8(tmpbuf, c);
1063     return is_utf8_lower(tmpbuf);
1064 }
1065
1066 bool
1067 Perl_is_uni_cntrl(pTHX_ UV c)
1068 {
1069     U8 tmpbuf[UTF8_MAXBYTES+1];
1070     uvchr_to_utf8(tmpbuf, c);
1071     return is_utf8_cntrl(tmpbuf);
1072 }
1073
1074 bool
1075 Perl_is_uni_graph(pTHX_ UV c)
1076 {
1077     U8 tmpbuf[UTF8_MAXBYTES+1];
1078     uvchr_to_utf8(tmpbuf, c);
1079     return is_utf8_graph(tmpbuf);
1080 }
1081
1082 bool
1083 Perl_is_uni_print(pTHX_ UV c)
1084 {
1085     U8 tmpbuf[UTF8_MAXBYTES+1];
1086     uvchr_to_utf8(tmpbuf, c);
1087     return is_utf8_print(tmpbuf);
1088 }
1089
1090 bool
1091 Perl_is_uni_punct(pTHX_ UV c)
1092 {
1093     U8 tmpbuf[UTF8_MAXBYTES+1];
1094     uvchr_to_utf8(tmpbuf, c);
1095     return is_utf8_punct(tmpbuf);
1096 }
1097
1098 bool
1099 Perl_is_uni_xdigit(pTHX_ UV c)
1100 {
1101     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1102     uvchr_to_utf8(tmpbuf, c);
1103     return is_utf8_xdigit(tmpbuf);
1104 }
1105
1106 UV
1107 Perl_to_uni_upper(pTHX_ UV c, U8* p, STRLEN *lenp)
1108 {
1109     uvchr_to_utf8(p, c);
1110     return to_utf8_upper(p, p, lenp);
1111 }
1112
1113 UV
1114 Perl_to_uni_title(pTHX_ UV c, U8* p, STRLEN *lenp)
1115 {
1116     uvchr_to_utf8(p, c);
1117     return to_utf8_title(p, p, lenp);
1118 }
1119
1120 UV
1121 Perl_to_uni_lower(pTHX_ UV c, U8* p, STRLEN *lenp)
1122 {
1123     uvchr_to_utf8(p, c);
1124     return to_utf8_lower(p, p, lenp);
1125 }
1126
1127 UV
1128 Perl_to_uni_fold(pTHX_ UV c, U8* p, STRLEN *lenp)
1129 {
1130     uvchr_to_utf8(p, c);
1131     return to_utf8_fold(p, p, lenp);
1132 }
1133
1134 /* for now these all assume no locale info available for Unicode > 255 */
1135
1136 bool
1137 Perl_is_uni_alnum_lc(pTHX_ UV c)
1138 {
1139     return is_uni_alnum(c);     /* XXX no locale support yet */
1140 }
1141
1142 bool
1143 Perl_is_uni_alnumc_lc(pTHX_ UV c)
1144 {
1145     return is_uni_alnumc(c);    /* XXX no locale support yet */
1146 }
1147
1148 bool
1149 Perl_is_uni_idfirst_lc(pTHX_ UV c)
1150 {
1151     return is_uni_idfirst(c);   /* XXX no locale support yet */
1152 }
1153
1154 bool
1155 Perl_is_uni_alpha_lc(pTHX_ UV c)
1156 {
1157     return is_uni_alpha(c);     /* XXX no locale support yet */
1158 }
1159
1160 bool
1161 Perl_is_uni_ascii_lc(pTHX_ UV c)
1162 {
1163     return is_uni_ascii(c);     /* XXX no locale support yet */
1164 }
1165
1166 bool
1167 Perl_is_uni_space_lc(pTHX_ UV c)
1168 {
1169     return is_uni_space(c);     /* XXX no locale support yet */
1170 }
1171
1172 bool
1173 Perl_is_uni_digit_lc(pTHX_ UV c)
1174 {
1175     return is_uni_digit(c);     /* XXX no locale support yet */
1176 }
1177
1178 bool
1179 Perl_is_uni_upper_lc(pTHX_ UV c)
1180 {
1181     return is_uni_upper(c);     /* XXX no locale support yet */
1182 }
1183
1184 bool
1185 Perl_is_uni_lower_lc(pTHX_ UV c)
1186 {
1187     return is_uni_lower(c);     /* XXX no locale support yet */
1188 }
1189
1190 bool
1191 Perl_is_uni_cntrl_lc(pTHX_ UV c)
1192 {
1193     return is_uni_cntrl(c);     /* XXX no locale support yet */
1194 }
1195
1196 bool
1197 Perl_is_uni_graph_lc(pTHX_ UV c)
1198 {
1199     return is_uni_graph(c);     /* XXX no locale support yet */
1200 }
1201
1202 bool
1203 Perl_is_uni_print_lc(pTHX_ UV c)
1204 {
1205     return is_uni_print(c);     /* XXX no locale support yet */
1206 }
1207
1208 bool
1209 Perl_is_uni_punct_lc(pTHX_ UV c)
1210 {
1211     return is_uni_punct(c);     /* XXX no locale support yet */
1212 }
1213
1214 bool
1215 Perl_is_uni_xdigit_lc(pTHX_ UV c)
1216 {
1217     return is_uni_xdigit(c);    /* XXX no locale support yet */
1218 }
1219
1220 U32
1221 Perl_to_uni_upper_lc(pTHX_ U32 c)
1222 {
1223     /* XXX returns only the first character -- do not use XXX */
1224     /* XXX no locale support yet */
1225     STRLEN len;
1226     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1227     return (U32)to_uni_upper(c, tmpbuf, &len);
1228 }
1229
1230 U32
1231 Perl_to_uni_title_lc(pTHX_ U32 c)
1232 {
1233     /* XXX returns only the first character XXX -- do not use XXX */
1234     /* XXX no locale support yet */
1235     STRLEN len;
1236     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1237     return (U32)to_uni_title(c, tmpbuf, &len);
1238 }
1239
1240 U32
1241 Perl_to_uni_lower_lc(pTHX_ U32 c)
1242 {
1243     /* XXX returns only the first character -- do not use XXX */
1244     /* XXX no locale support yet */
1245     STRLEN len;
1246     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1247     return (U32)to_uni_lower(c, tmpbuf, &len);
1248 }
1249
1250 bool
1251 Perl_is_utf8_alnum(pTHX_ const U8 *p)
1252 {
1253     if (!is_utf8_char(p))
1254         return FALSE;
1255     if (!PL_utf8_alnum)
1256         /* NOTE: "IsWord", not "IsAlnum", since Alnum is a true
1257          * descendant of isalnum(3), in other words, it doesn't
1258          * contain the '_'. --jhi */
1259         PL_utf8_alnum = swash_init("utf8", "IsWord", &PL_sv_undef, 0, 0);
1260     return swash_fetch(PL_utf8_alnum, p, TRUE) != 0;
1261 /*    return *p == '_' || is_utf8_alpha(p) || is_utf8_digit(p); */
1262 #ifdef SURPRISINGLY_SLOWER  /* probably because alpha is usually true */
1263     if (!PL_utf8_alnum)
1264         PL_utf8_alnum = swash_init("utf8", "",
1265             sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
1266     return swash_fetch(PL_utf8_alnum, p, TRUE) != 0;
1267 #endif
1268 }
1269
1270 bool
1271 Perl_is_utf8_alnumc(pTHX_ const U8 *p)
1272 {
1273     if (!is_utf8_char(p))
1274         return FALSE;
1275     if (!PL_utf8_alnum)
1276         PL_utf8_alnum = swash_init("utf8", "IsAlnumC", &PL_sv_undef, 0, 0);
1277     return swash_fetch(PL_utf8_alnum, p, TRUE) != 0;
1278 /*    return is_utf8_alpha(p) || is_utf8_digit(p); */
1279 #ifdef SURPRISINGLY_SLOWER  /* probably because alpha is usually true */
1280     if (!PL_utf8_alnum)
1281         PL_utf8_alnum = swash_init("utf8", "",
1282             sv_2mortal(newSVpv("+utf8::IsAlpha\n+utf8::IsDigit\n005F\n",0)), 0, 0);
1283     return swash_fetch(PL_utf8_alnum, p, TRUE) != 0;
1284 #endif
1285 }
1286
1287 bool
1288 Perl_is_utf8_idfirst(pTHX_ const U8 *p) /* The naming is historical. */
1289 {
1290     if (*p == '_')
1291         return TRUE;
1292     if (!is_utf8_char(p))
1293         return FALSE;
1294     if (!PL_utf8_idstart) /* is_utf8_idstart would be more logical. */
1295         PL_utf8_idstart = swash_init("utf8", "IdStart", &PL_sv_undef, 0, 0);
1296     return swash_fetch(PL_utf8_idstart, p, TRUE) != 0;
1297 }
1298
1299 bool
1300 Perl_is_utf8_idcont(pTHX_ const U8 *p)
1301 {
1302     if (*p == '_')
1303         return TRUE;
1304     if (!is_utf8_char(p))
1305         return FALSE;
1306     if (!PL_utf8_idcont)
1307         PL_utf8_idcont = swash_init("utf8", "IdContinue", &PL_sv_undef, 0, 0);
1308     return swash_fetch(PL_utf8_idcont, p, TRUE) != 0;
1309 }
1310
1311 bool
1312 Perl_is_utf8_alpha(pTHX_ const U8 *p)
1313 {
1314     if (!is_utf8_char(p))
1315         return FALSE;
1316     if (!PL_utf8_alpha)
1317         PL_utf8_alpha = swash_init("utf8", "IsAlpha", &PL_sv_undef, 0, 0);
1318     return swash_fetch(PL_utf8_alpha, p, TRUE) != 0;
1319 }
1320
1321 bool
1322 Perl_is_utf8_ascii(pTHX_ const U8 *p)
1323 {
1324     if (!is_utf8_char(p))
1325         return FALSE;
1326     if (!PL_utf8_ascii)
1327         PL_utf8_ascii = swash_init("utf8", "IsAscii", &PL_sv_undef, 0, 0);
1328     return swash_fetch(PL_utf8_ascii, p, TRUE) != 0;
1329 }
1330
1331 bool
1332 Perl_is_utf8_space(pTHX_ const U8 *p)
1333 {
1334     if (!is_utf8_char(p))
1335         return FALSE;
1336     if (!PL_utf8_space)
1337         PL_utf8_space = swash_init("utf8", "IsSpacePerl", &PL_sv_undef, 0, 0);
1338     return swash_fetch(PL_utf8_space, p, TRUE) != 0;
1339 }
1340
1341 bool
1342 Perl_is_utf8_digit(pTHX_ const U8 *p)
1343 {
1344     if (!is_utf8_char(p))
1345         return FALSE;
1346     if (!PL_utf8_digit)
1347         PL_utf8_digit = swash_init("utf8", "IsDigit", &PL_sv_undef, 0, 0);
1348     return swash_fetch(PL_utf8_digit, p, TRUE) != 0;
1349 }
1350
1351 bool
1352 Perl_is_utf8_upper(pTHX_ const U8 *p)
1353 {
1354     if (!is_utf8_char(p))
1355         return FALSE;
1356     if (!PL_utf8_upper)
1357         PL_utf8_upper = swash_init("utf8", "IsUppercase", &PL_sv_undef, 0, 0);
1358     return swash_fetch(PL_utf8_upper, p, TRUE) != 0;
1359 }
1360
1361 bool
1362 Perl_is_utf8_lower(pTHX_ const U8 *p)
1363 {
1364     if (!is_utf8_char(p))
1365         return FALSE;
1366     if (!PL_utf8_lower)
1367         PL_utf8_lower = swash_init("utf8", "IsLowercase", &PL_sv_undef, 0, 0);
1368     return swash_fetch(PL_utf8_lower, p, TRUE) != 0;
1369 }
1370
1371 bool
1372 Perl_is_utf8_cntrl(pTHX_ const U8 *p)
1373 {
1374     if (!is_utf8_char(p))
1375         return FALSE;
1376     if (!PL_utf8_cntrl)
1377         PL_utf8_cntrl = swash_init("utf8", "IsCntrl", &PL_sv_undef, 0, 0);
1378     return swash_fetch(PL_utf8_cntrl, p, TRUE) != 0;
1379 }
1380
1381 bool
1382 Perl_is_utf8_graph(pTHX_ const U8 *p)
1383 {
1384     if (!is_utf8_char(p))
1385         return FALSE;
1386     if (!PL_utf8_graph)
1387         PL_utf8_graph = swash_init("utf8", "IsGraph", &PL_sv_undef, 0, 0);
1388     return swash_fetch(PL_utf8_graph, p, TRUE) != 0;
1389 }
1390
1391 bool
1392 Perl_is_utf8_print(pTHX_ const U8 *p)
1393 {
1394     if (!is_utf8_char(p))
1395         return FALSE;
1396     if (!PL_utf8_print)
1397         PL_utf8_print = swash_init("utf8", "IsPrint", &PL_sv_undef, 0, 0);
1398     return swash_fetch(PL_utf8_print, p, TRUE) != 0;
1399 }
1400
1401 bool
1402 Perl_is_utf8_punct(pTHX_ const U8 *p)
1403 {
1404     if (!is_utf8_char(p))
1405         return FALSE;
1406     if (!PL_utf8_punct)
1407         PL_utf8_punct = swash_init("utf8", "IsPunct", &PL_sv_undef, 0, 0);
1408     return swash_fetch(PL_utf8_punct, p, TRUE) != 0;
1409 }
1410
1411 bool
1412 Perl_is_utf8_xdigit(pTHX_ const U8 *p)
1413 {
1414     if (!is_utf8_char(p))
1415         return FALSE;
1416     if (!PL_utf8_xdigit)
1417         PL_utf8_xdigit = swash_init("utf8", "IsXDigit", &PL_sv_undef, 0, 0);
1418     return swash_fetch(PL_utf8_xdigit, p, TRUE) != 0;
1419 }
1420
1421 bool
1422 Perl_is_utf8_mark(pTHX_ const U8 *p)
1423 {
1424     if (!is_utf8_char(p))
1425         return FALSE;
1426     if (!PL_utf8_mark)
1427         PL_utf8_mark = swash_init("utf8", "IsM", &PL_sv_undef, 0, 0);
1428     return swash_fetch(PL_utf8_mark, p, TRUE) != 0;
1429 }
1430
1431 /*
1432 =for apidoc A|UV|to_utf8_case|U8 *p|U8* ustrp|STRLEN *lenp|SV **swash|char *normal|char *special
1433
1434 The "p" contains the pointer to the UTF-8 string encoding
1435 the character that is being converted.
1436
1437 The "ustrp" is a pointer to the character buffer to put the
1438 conversion result to.  The "lenp" is a pointer to the length
1439 of the result.
1440
1441 The "swashp" is a pointer to the swash to use.
1442
1443 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
1444 and loaded by SWASHGET, using lib/utf8_heavy.pl.  The special (usually,
1445 but not always, a multicharacter mapping), is tried first.
1446
1447 The "special" is a string like "utf8::ToSpecLower", which means the
1448 hash %utf8::ToSpecLower.  The access to the hash is through
1449 Perl_to_utf8_case().
1450
1451 The "normal" is a string like "ToLower" which means the swash
1452 %utf8::ToLower.
1453
1454 =cut */
1455
1456 UV
1457 Perl_to_utf8_case(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp,
1458                         SV **swashp, const char *normal, const char *special)
1459 {
1460     U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1461     STRLEN len = 0;
1462
1463     const UV uv0 = utf8_to_uvchr(p, NULL);
1464     /* The NATIVE_TO_UNI() and UNI_TO_NATIVE() mappings
1465      * are necessary in EBCDIC, they are redundant no-ops
1466      * in ASCII-ish platforms, and hopefully optimized away. */
1467     const UV uv1 = NATIVE_TO_UNI(uv0);
1468     uvuni_to_utf8(tmpbuf, uv1);
1469
1470     if (!*swashp) /* load on-demand */
1471          *swashp = swash_init("utf8", normal, &PL_sv_undef, 4, 0);
1472
1473     /* The 0xDF is the only special casing Unicode code point below 0x100. */
1474     if (special && (uv1 == 0xDF || uv1 > 0xFF)) {
1475          /* It might be "special" (sometimes, but not always,
1476           * a multicharacter mapping) */
1477          HV *hv;
1478          SV **svp;
1479
1480          if ((hv  = get_hv(special, FALSE)) &&
1481              (svp = hv_fetch(hv, (const char*)tmpbuf, UNISKIP(uv1), FALSE)) &&
1482              (*svp)) {
1483              const char *s;
1484
1485               s = SvPV_const(*svp, len);
1486               if (len == 1)
1487                    len = uvuni_to_utf8(ustrp, NATIVE_TO_UNI(*(U8*)s)) - ustrp;
1488               else {
1489 #ifdef EBCDIC
1490                    /* If we have EBCDIC we need to remap the characters
1491                     * since any characters in the low 256 are Unicode
1492                     * code points, not EBCDIC. */
1493                    U8 *t = (U8*)s, *tend = t + len, *d;
1494                 
1495                    d = tmpbuf;
1496                    if (SvUTF8(*svp)) {
1497                         STRLEN tlen = 0;
1498                         
1499                         while (t < tend) {
1500                              UV c = utf8_to_uvchr(t, &tlen);
1501                              if (tlen > 0) {
1502                                   d = uvchr_to_utf8(d, UNI_TO_NATIVE(c));
1503                                   t += tlen;
1504                              }
1505                              else
1506                                   break;
1507                         }
1508                    }
1509                    else {
1510                         while (t < tend) {
1511                              d = uvchr_to_utf8(d, UNI_TO_NATIVE(*t));
1512                              t++;
1513                         }
1514                    }
1515                    len = d - tmpbuf;
1516                    Copy(tmpbuf, ustrp, len, U8);
1517 #else
1518                    Copy(s, ustrp, len, U8);
1519 #endif
1520               }
1521          }
1522     }
1523
1524     if (!len && *swashp) {
1525          UV uv2 = swash_fetch(*swashp, tmpbuf, TRUE);
1526          
1527          if (uv2) {
1528               /* It was "normal" (a single character mapping). */
1529               UV uv3 = UNI_TO_NATIVE(uv2);
1530               
1531               len = uvchr_to_utf8(ustrp, uv3) - ustrp;
1532          }
1533     }
1534
1535     if (!len) /* Neither: just copy. */
1536          len = uvchr_to_utf8(ustrp, uv0) - ustrp;
1537
1538     if (lenp)
1539          *lenp = len;
1540
1541     return len ? utf8_to_uvchr(ustrp, 0) : 0;
1542 }
1543
1544 /*
1545 =for apidoc A|UV|to_utf8_upper|const U8 *p|U8 *ustrp|STRLEN *lenp
1546
1547 Convert the UTF-8 encoded character at p to its uppercase version and
1548 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
1549 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
1550 the uppercase version may be longer than the original character.
1551
1552 The first character of the uppercased version is returned
1553 (but note, as explained above, that there may be more.)
1554
1555 =cut */
1556
1557 UV
1558 Perl_to_utf8_upper(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1559 {
1560     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
1561                              &PL_utf8_toupper, "ToUpper", "utf8::ToSpecUpper");
1562 }
1563
1564 /*
1565 =for apidoc A|UV|to_utf8_title|const U8 *p|U8 *ustrp|STRLEN *lenp
1566
1567 Convert the UTF-8 encoded character at p to its titlecase version and
1568 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
1569 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
1570 titlecase version may be longer than the original character.
1571
1572 The first character of the titlecased version is returned
1573 (but note, as explained above, that there may be more.)
1574
1575 =cut */
1576
1577 UV
1578 Perl_to_utf8_title(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1579 {
1580     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
1581                              &PL_utf8_totitle, "ToTitle", "utf8::ToSpecTitle");
1582 }
1583
1584 /*
1585 =for apidoc A|UV|to_utf8_lower|const U8 *p|U8 *ustrp|STRLEN *lenp
1586
1587 Convert the UTF-8 encoded character at p to its lowercase version and
1588 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
1589 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
1590 lowercase version may be longer than the original character.
1591
1592 The first character of the lowercased version is returned
1593 (but note, as explained above, that there may be more.)
1594
1595 =cut */
1596
1597 UV
1598 Perl_to_utf8_lower(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1599 {
1600     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
1601                              &PL_utf8_tolower, "ToLower", "utf8::ToSpecLower");
1602 }
1603
1604 /*
1605 =for apidoc A|UV|to_utf8_fold|const U8 *p|U8 *ustrp|STRLEN *lenp
1606
1607 Convert the UTF-8 encoded character at p to its foldcase version and
1608 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
1609 that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
1610 foldcase version may be longer than the original character (up to
1611 three characters).
1612
1613 The first character of the foldcased version is returned
1614 (but note, as explained above, that there may be more.)
1615
1616 =cut */
1617
1618 UV
1619 Perl_to_utf8_fold(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1620 {
1621     return Perl_to_utf8_case(aTHX_ p, ustrp, lenp,
1622                              &PL_utf8_tofold, "ToFold", "utf8::ToSpecFold");
1623 }
1624
1625 /* a "swash" is a swatch hash */
1626
1627 SV*
1628 Perl_swash_init(pTHX_ const char* pkg, const char* name, SV *listsv, I32 minbits, I32 none)
1629 {
1630     dVAR;
1631     SV* retval;
1632     SV* const tokenbufsv = sv_newmortal();
1633     dSP;
1634     const size_t pkg_len = strlen(pkg);
1635     const size_t name_len = strlen(name);
1636     HV * const stash = gv_stashpvn(pkg, pkg_len, FALSE);
1637     SV* errsv_save;
1638
1639     PUSHSTACKi(PERLSI_MAGIC);
1640     ENTER;
1641     SAVEI32(PL_hints);
1642     PL_hints = 0;
1643     save_re_context();
1644     if (!gv_fetchmeth(stash, "SWASHNEW", 8, -1)) {      /* demand load utf8 */
1645         ENTER;
1646         errsv_save = newSVsv(ERRSV);
1647         Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, newSVpvn(pkg,pkg_len),
1648                          Nullsv);
1649         if (!SvTRUE(ERRSV))
1650             sv_setsv(ERRSV, errsv_save);
1651         SvREFCNT_dec(errsv_save);
1652         LEAVE;
1653     }
1654     SPAGAIN;
1655     PUSHMARK(SP);
1656     EXTEND(SP,5);
1657     PUSHs(sv_2mortal(newSVpvn(pkg, pkg_len)));
1658     PUSHs(sv_2mortal(newSVpvn(name, name_len)));
1659     PUSHs(listsv);
1660     PUSHs(sv_2mortal(newSViv(minbits)));
1661     PUSHs(sv_2mortal(newSViv(none)));
1662     PUTBACK;
1663     if (IN_PERL_COMPILETIME) {
1664         /* XXX ought to be handled by lex_start */
1665         SAVEI32(PL_in_my);
1666         PL_in_my = 0;
1667         sv_setpv(tokenbufsv, PL_tokenbuf);
1668     }
1669     errsv_save = newSVsv(ERRSV);
1670     if (call_method("SWASHNEW", G_SCALAR))
1671         retval = newSVsv(*PL_stack_sp--);
1672     else
1673         retval = &PL_sv_undef;
1674     if (!SvTRUE(ERRSV))
1675         sv_setsv(ERRSV, errsv_save);
1676     SvREFCNT_dec(errsv_save);
1677     LEAVE;
1678     POPSTACK;
1679     if (IN_PERL_COMPILETIME) {
1680         STRLEN len;
1681         const char* const pv = SvPV_const(tokenbufsv, len);
1682
1683         Copy(pv, PL_tokenbuf, len+1, char);
1684         PL_curcop->op_private = (U8)(PL_hints & HINT_PRIVATE_MASK);
1685     }
1686     if (!SvROK(retval) || SvTYPE(SvRV(retval)) != SVt_PVHV) {
1687         if (SvPOK(retval))
1688             Perl_croak(aTHX_ "Can't find Unicode property definition \"%"SVf"\"",
1689                        retval);
1690         Perl_croak(aTHX_ "SWASHNEW didn't return an HV ref");
1691     }
1692     return retval;
1693 }
1694
1695
1696 /* This API is wrong for special case conversions since we may need to
1697  * return several Unicode characters for a single Unicode character
1698  * (see lib/unicore/SpecCase.txt) The SWASHGET in lib/utf8_heavy.pl is
1699  * the lower-level routine, and it is similarly broken for returning
1700  * multiple values.  --jhi */
1701 UV
1702 Perl_swash_fetch(pTHX_ SV *sv, const U8 *ptr, bool do_utf8)
1703 {
1704     dVAR;
1705     HV* const hv = (HV*)SvRV(sv);
1706     U32 klen;
1707     U32 off;
1708     STRLEN slen;
1709     STRLEN needents;
1710     const U8 *tmps = NULL;
1711     U32 bit;
1712     SV *retval;
1713     U8 tmputf8[2];
1714     UV c = NATIVE_TO_ASCII(*ptr);
1715
1716     if (!do_utf8 && !UNI_IS_INVARIANT(c)) {
1717         tmputf8[0] = (U8)UTF8_EIGHT_BIT_HI(c);
1718         tmputf8[1] = (U8)UTF8_EIGHT_BIT_LO(c);
1719         ptr = tmputf8;
1720     }
1721     /* Given a UTF-X encoded char 0xAA..0xYY,0xZZ
1722      * then the "swatch" is a vec() for al the chars which start
1723      * with 0xAA..0xYY
1724      * So the key in the hash (klen) is length of encoded char -1
1725      */
1726     klen = UTF8SKIP(ptr) - 1;
1727     off  = ptr[klen];
1728
1729     if (klen == 0)
1730      {
1731       /* If char in invariant then swatch is for all the invariant chars
1732        * In both UTF-8 and UTF-8-MOD that happens to be UTF_CONTINUATION_MARK
1733        */
1734       needents = UTF_CONTINUATION_MARK;
1735       off      = NATIVE_TO_UTF(ptr[klen]);
1736      }
1737     else
1738      {
1739       /* If char is encoded then swatch is for the prefix */
1740       needents = (1 << UTF_ACCUMULATION_SHIFT);
1741       off      = NATIVE_TO_UTF(ptr[klen]) & UTF_CONTINUATION_MASK;
1742      }
1743
1744     /*
1745      * This single-entry cache saves about 1/3 of the utf8 overhead in test
1746      * suite.  (That is, only 7-8% overall over just a hash cache.  Still,
1747      * it's nothing to sniff at.)  Pity we usually come through at least
1748      * two function calls to get here...
1749      *
1750      * NB: this code assumes that swatches are never modified, once generated!
1751      */
1752
1753     if (hv   == PL_last_swash_hv &&
1754         klen == PL_last_swash_klen &&
1755         (!klen || memEQ((char *)ptr, (char *)PL_last_swash_key, klen)) )
1756     {
1757         tmps = PL_last_swash_tmps;
1758         slen = PL_last_swash_slen;
1759     }
1760     else {
1761         /* Try our second-level swatch cache, kept in a hash. */
1762         SV** svp = hv_fetch(hv, (const char*)ptr, klen, FALSE);
1763
1764         /* If not cached, generate it via utf8::SWASHGET */
1765         if (!svp || !SvPOK(*svp) || !(tmps = (const U8*)SvPV_const(*svp, slen))) {
1766             dSP;
1767             /* We use utf8n_to_uvuni() as we want an index into
1768                Unicode tables, not a native character number.
1769              */
1770             const UV code_point = utf8n_to_uvuni(ptr, UTF8_MAXBYTES, 0,
1771                                            ckWARN(WARN_UTF8) ?
1772                                            0 : UTF8_ALLOW_ANY);
1773             SV *errsv_save;
1774             ENTER;
1775             SAVETMPS;
1776             save_re_context();
1777             PUSHSTACKi(PERLSI_MAGIC);
1778             PUSHMARK(SP);
1779             EXTEND(SP,3);
1780             PUSHs((SV*)sv);
1781             /* On EBCDIC & ~(0xA0-1) isn't a useful thing to do */
1782             PUSHs(sv_2mortal(newSViv((klen) ?
1783                                      (code_point & ~(needents - 1)) : 0)));
1784             PUSHs(sv_2mortal(newSViv(needents)));
1785             PUTBACK;
1786             errsv_save = newSVsv(ERRSV);
1787             if (call_method("SWASHGET", G_SCALAR))
1788                 retval = newSVsv(*PL_stack_sp--);
1789             else
1790                 retval = &PL_sv_undef;
1791             if (!SvTRUE(ERRSV))
1792                 sv_setsv(ERRSV, errsv_save);
1793             SvREFCNT_dec(errsv_save);
1794             POPSTACK;
1795             FREETMPS;
1796             LEAVE;
1797             if (IN_PERL_COMPILETIME)
1798                 PL_curcop->op_private = (U8)(PL_hints & HINT_PRIVATE_MASK);
1799
1800             svp = hv_store(hv, (const char *)ptr, klen, retval, 0);
1801
1802             if (!svp || !(tmps = (U8*)SvPV(*svp, slen)) || (slen << 3) < needents)
1803                 Perl_croak(aTHX_ "SWASHGET didn't return result of proper length");
1804         }
1805
1806         PL_last_swash_hv = hv;
1807         PL_last_swash_klen = klen;
1808         /* FIXME change interpvar.h?  */
1809         PL_last_swash_tmps = (U8 *) tmps;
1810         PL_last_swash_slen = slen;
1811         if (klen)
1812             Copy(ptr, PL_last_swash_key, klen, U8);
1813     }
1814
1815     switch ((int)((slen << 3) / needents)) {
1816     case 1:
1817         bit = 1 << (off & 7);
1818         off >>= 3;
1819         return (tmps[off] & bit) != 0;
1820     case 8:
1821         return tmps[off];
1822     case 16:
1823         off <<= 1;
1824         return (tmps[off] << 8) + tmps[off + 1] ;
1825     case 32:
1826         off <<= 2;
1827         return (tmps[off] << 24) + (tmps[off+1] << 16) + (tmps[off+2] << 8) + tmps[off + 3] ;
1828     }
1829     Perl_croak(aTHX_ "panic: swash_fetch");
1830     return 0;
1831 }
1832
1833
1834 /*
1835 =for apidoc A|U8 *|uvchr_to_utf8|U8 *d|UV uv
1836
1837 Adds the UTF-8 representation of the Native codepoint C<uv> to the end
1838 of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
1839 bytes available. The return value is the pointer to the byte after the
1840 end of the new character. In other words,
1841
1842     d = uvchr_to_utf8(d, uv);
1843
1844 is the recommended wide native character-aware way of saying
1845
1846     *(d++) = uv;
1847
1848 =cut
1849 */
1850
1851 /* On ASCII machines this is normally a macro but we want a
1852    real function in case XS code wants it
1853 */
1854 #undef Perl_uvchr_to_utf8
1855 U8 *
1856 Perl_uvchr_to_utf8(pTHX_ U8 *d, UV uv)
1857 {
1858     return Perl_uvuni_to_utf8_flags(aTHX_ d, NATIVE_TO_UNI(uv), 0);
1859 }
1860
1861 U8 *
1862 Perl_uvchr_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
1863 {
1864     return Perl_uvuni_to_utf8_flags(aTHX_ d, NATIVE_TO_UNI(uv), flags);
1865 }
1866
1867 /*
1868 =for apidoc A|UV|utf8n_to_uvchr|U8 *s|STRLEN curlen|STRLEN *retlen|U32 flags
1869
1870 Returns the native character value of the first character in the string C<s>
1871 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
1872 length, in bytes, of that character.
1873
1874 Allows length and flags to be passed to low level routine.
1875
1876 =cut
1877 */
1878 /* On ASCII machines this is normally a macro but we want
1879    a real function in case XS code wants it
1880 */
1881 #undef Perl_utf8n_to_uvchr
1882 UV
1883 Perl_utf8n_to_uvchr(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
1884 {
1885     const UV uv = Perl_utf8n_to_uvuni(aTHX_ s, curlen, retlen, flags);
1886     return UNI_TO_NATIVE(uv);
1887 }
1888
1889 /*
1890 =for apidoc A|char *|pv_uni_display|SV *dsv|U8 *spv|STRLEN len|STRLEN pvlim|UV flags
1891
1892 Build to the scalar dsv a displayable version of the string spv,
1893 length len, the displayable version being at most pvlim bytes long
1894 (if longer, the rest is truncated and "..." will be appended).
1895
1896 The flags argument can have UNI_DISPLAY_ISPRINT set to display
1897 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
1898 to display the \\[nrfta\\] as the backslashed versions (like '\n')
1899 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
1900 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
1901 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
1902
1903 The pointer to the PV of the dsv is returned.
1904
1905 =cut */
1906 char *
1907 Perl_pv_uni_display(pTHX_ SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
1908 {
1909     int truncated = 0;
1910     const char *s, *e;
1911
1912     sv_setpvn(dsv, "", 0);
1913     for (s = (const char *)spv, e = s + len; s < e; s += UTF8SKIP(s)) {
1914          UV u;
1915           /* This serves double duty as a flag and a character to print after
1916              a \ when flags & UNI_DISPLAY_BACKSLASH is true.
1917           */
1918          char ok = 0;
1919
1920          if (pvlim && SvCUR(dsv) >= pvlim) {
1921               truncated++;
1922               break;
1923          }
1924          u = utf8_to_uvchr((U8*)s, 0);
1925          if (u < 256) {
1926              const unsigned char c = (unsigned char)u & 0xFF;
1927              if (!ok && (flags & UNI_DISPLAY_BACKSLASH)) {
1928                  switch (c) {
1929                  case '\n':
1930                      ok = 'n'; break;
1931                  case '\r':
1932                      ok = 'r'; break;
1933                  case '\t':
1934                      ok = 't'; break;
1935                  case '\f':
1936                      ok = 'f'; break;
1937                  case '\a':
1938                      ok = 'a'; break;
1939                  case '\\':
1940                      ok = '\\'; break;
1941                  default: break;
1942                  }
1943                  if (ok) {
1944                      Perl_sv_catpvf(aTHX_ dsv, "\\%c", ok);
1945                  }
1946              }
1947              /* isPRINT() is the locale-blind version. */
1948              if (!ok && (flags & UNI_DISPLAY_ISPRINT) && isPRINT(c)) {
1949                  Perl_sv_catpvf(aTHX_ dsv, "%c", c);
1950                  ok = 1;
1951              }
1952          }
1953          if (!ok)
1954              Perl_sv_catpvf(aTHX_ dsv, "\\x{%"UVxf"}", u);
1955     }
1956     if (truncated)
1957          sv_catpvn(dsv, "...", 3);
1958     
1959     return SvPVX(dsv);
1960 }
1961
1962 /*
1963 =for apidoc A|char *|sv_uni_display|SV *dsv|SV *ssv|STRLEN pvlim|UV flags
1964
1965 Build to the scalar dsv a displayable version of the scalar sv,
1966 the displayable version being at most pvlim bytes long
1967 (if longer, the rest is truncated and "..." will be appended).
1968
1969 The flags argument is as in pv_uni_display().
1970
1971 The pointer to the PV of the dsv is returned.
1972
1973 =cut */
1974 char *
1975 Perl_sv_uni_display(pTHX_ SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
1976 {
1977      return Perl_pv_uni_display(aTHX_ dsv, (const U8*)SvPVX_const(ssv),
1978                                 SvCUR(ssv), pvlim, flags);
1979 }
1980
1981 /*
1982 =for apidoc A|I32|ibcmp_utf8|const char *s1|char **pe1|register UV l1|bool u1|const char *s2|char **pe2|register UV l2|bool u2
1983
1984 Return true if the strings s1 and s2 differ case-insensitively, false
1985 if not (if they are equal case-insensitively).  If u1 is true, the
1986 string s1 is assumed to be in UTF-8-encoded Unicode.  If u2 is true,
1987 the string s2 is assumed to be in UTF-8-encoded Unicode.  If u1 or u2
1988 are false, the respective string is assumed to be in native 8-bit
1989 encoding.
1990
1991 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
1992 in there (they will point at the beginning of the I<next> character).
1993 If the pointers behind pe1 or pe2 are non-NULL, they are the end
1994 pointers beyond which scanning will not continue under any
1995 circumstances.  If the byte lengths l1 and l2 are non-zero, s1+l1 and
1996 s2+l2 will be used as goal end pointers that will also stop the scan,
1997 and which qualify towards defining a successful match: all the scans
1998 that define an explicit length must reach their goal pointers for
1999 a match to succeed).
2000
2001 For case-insensitiveness, the "casefolding" of Unicode is used
2002 instead of upper/lowercasing both the characters, see
2003 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
2004
2005 =cut */
2006 I32
2007 Perl_ibcmp_utf8(pTHX_ const char *s1, char **pe1, register UV l1, bool u1, const char *s2, char **pe2, register UV l2, bool u2)
2008 {
2009      register const U8 *p1  = (const U8*)s1;
2010      register const U8 *p2  = (const U8*)s2;
2011      register const U8 *f1 = 0, *f2 = 0;
2012      register U8 *e1 = 0, *q1 = 0;
2013      register U8 *e2 = 0, *q2 = 0;
2014      STRLEN n1 = 0, n2 = 0;
2015      U8 foldbuf1[UTF8_MAXBYTES_CASE+1];
2016      U8 foldbuf2[UTF8_MAXBYTES_CASE+1];
2017      U8 natbuf[1+1];
2018      STRLEN foldlen1, foldlen2;
2019      bool match;
2020      
2021      if (pe1)
2022           e1 = *(U8**)pe1;
2023      if (e1 == 0 || (l1 && l1 < (UV)(e1 - (const U8*)s1)))
2024           f1 = (const U8*)s1 + l1;
2025      if (pe2)
2026           e2 = *(U8**)pe2;
2027      if (e2 == 0 || (l2 && l2 < (UV)(e2 - (const U8*)s2)))
2028           f2 = (const U8*)s2 + l2;
2029
2030      if ((e1 == 0 && f1 == 0) || (e2 == 0 && f2 == 0) || (f1 == 0 && f2 == 0))
2031           return 1; /* mismatch; possible infinite loop or false positive */
2032
2033      if (!u1 || !u2)
2034           natbuf[1] = 0; /* Need to terminate the buffer. */
2035
2036      while ((e1 == 0 || p1 < e1) &&
2037             (f1 == 0 || p1 < f1) &&
2038             (e2 == 0 || p2 < e2) &&
2039             (f2 == 0 || p2 < f2)) {
2040           if (n1 == 0) {
2041                if (u1)
2042                     to_utf8_fold(p1, foldbuf1, &foldlen1);
2043                else {
2044                     uvuni_to_utf8(natbuf, (UV) NATIVE_TO_UNI(((UV)*p1)));
2045                     to_utf8_fold(natbuf, foldbuf1, &foldlen1);
2046                }
2047                q1 = foldbuf1;
2048                n1 = foldlen1;
2049           }
2050           if (n2 == 0) {
2051                if (u2)
2052                     to_utf8_fold(p2, foldbuf2, &foldlen2);
2053                else {
2054                     uvuni_to_utf8(natbuf, (UV) NATIVE_TO_UNI(((UV)*p2)));
2055                     to_utf8_fold(natbuf, foldbuf2, &foldlen2);
2056                }
2057                q2 = foldbuf2;
2058                n2 = foldlen2;
2059           }
2060           while (n1 && n2) {
2061                if ( UTF8SKIP(q1) != UTF8SKIP(q2) ||
2062                    (UTF8SKIP(q1) == 1 && *q1 != *q2) ||
2063                     memNE((char*)q1, (char*)q2, UTF8SKIP(q1)) )
2064                    return 1; /* mismatch */
2065                n1 -= UTF8SKIP(q1);
2066                q1 += UTF8SKIP(q1);
2067                n2 -= UTF8SKIP(q2);
2068                q2 += UTF8SKIP(q2);
2069           }
2070           if (n1 == 0)
2071                p1 += u1 ? UTF8SKIP(p1) : 1;
2072           if (n2 == 0)
2073                p2 += u2 ? UTF8SKIP(p2) : 1;
2074
2075      }
2076
2077      /* A match is defined by all the scans that specified
2078       * an explicit length reaching their final goals. */
2079      match = (f1 == 0 || p1 == f1) && (f2 == 0 || p2 == f2);
2080
2081      if (match) {
2082           if (pe1)
2083                *pe1 = (char*)p1;
2084           if (pe2)
2085                *pe2 = (char*)p2;
2086      }
2087
2088      return match ? 0 : 1; /* 0 match, 1 mismatch */
2089 }
2090
2091 /*
2092  * Local variables:
2093  * c-indentation-style: bsd
2094  * c-basic-offset: 4
2095  * indent-tabs-mode: t
2096  * End:
2097  *
2098  * ex: set ts=8 sts=4 sw=4 noet:
2099  */