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