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