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