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