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