| 1 | /* utf8.h |
| 2 | * |
| 3 | * This file contains definitions for use with the UTF-8 encoding. It |
| 4 | * actually also works with the variant UTF-8 encoding called UTF-EBCDIC, and |
| 5 | * hides almost all of the differences between these from the caller. In other |
| 6 | * words, someone should #include this file, and if the code is being compiled |
| 7 | * on an EBCDIC platform, things should mostly just work. |
| 8 | * |
| 9 | * Copyright (C) 2000, 2001, 2002, 2005, 2006, 2007, 2009, |
| 10 | * 2010, 2011 by Larry Wall and others |
| 11 | * |
| 12 | * You may distribute under the terms of either the GNU General Public |
| 13 | * License or the Artistic License, as specified in the README file. |
| 14 | * |
| 15 | */ |
| 16 | |
| 17 | #ifndef PERL_UTF8_H_ /* Guard against recursive inclusion */ |
| 18 | #define PERL_UTF8_H_ 1 |
| 19 | |
| 20 | /* Use UTF-8 as the default script encoding? |
| 21 | * Turning this on will break scripts having non-UTF-8 binary |
| 22 | * data (such as Latin-1) in string literals. */ |
| 23 | #ifdef USE_UTF8_SCRIPTS |
| 24 | # define USE_UTF8_IN_NAMES (!IN_BYTES) |
| 25 | #else |
| 26 | # define USE_UTF8_IN_NAMES (PL_hints & HINT_UTF8) |
| 27 | #endif |
| 28 | |
| 29 | #include "regcharclass.h" |
| 30 | #include "unicode_constants.h" |
| 31 | |
| 32 | /* For to_utf8_fold_flags, q.v. */ |
| 33 | #define FOLD_FLAGS_LOCALE 0x1 |
| 34 | #define FOLD_FLAGS_FULL 0x2 |
| 35 | #define FOLD_FLAGS_NOMIX_ASCII 0x4 |
| 36 | |
| 37 | /* |
| 38 | =head1 Unicode Support |
| 39 | L<perlguts/Unicode Support> has an introduction to this API. |
| 40 | |
| 41 | See also L</Character classification>, |
| 42 | and L</Character case changing>. |
| 43 | Various functions outside this section also work specially with Unicode. |
| 44 | Search for the string "utf8" in this document. |
| 45 | |
| 46 | =for apidoc is_ascii_string |
| 47 | |
| 48 | This is a misleadingly-named synonym for L</is_utf8_invariant_string>. |
| 49 | On ASCII-ish platforms, the name isn't misleading: the ASCII-range characters |
| 50 | are exactly the UTF-8 invariants. But EBCDIC machines have more invariants |
| 51 | than just the ASCII characters, so C<is_utf8_invariant_string> is preferred. |
| 52 | |
| 53 | =for apidoc is_invariant_string |
| 54 | |
| 55 | This is a somewhat misleadingly-named synonym for L</is_utf8_invariant_string>. |
| 56 | C<is_utf8_invariant_string> is preferred, as it indicates under what conditions |
| 57 | the string is invariant. |
| 58 | |
| 59 | =cut |
| 60 | */ |
| 61 | #define is_ascii_string(s, len) is_utf8_invariant_string(s, len) |
| 62 | #define is_invariant_string(s, len) is_utf8_invariant_string(s, len) |
| 63 | |
| 64 | #define uvoffuni_to_utf8_flags(d,uv,flags) \ |
| 65 | uvoffuni_to_utf8_flags_msgs(d, uv, flags, 0) |
| 66 | #define uvchr_to_utf8(a,b) uvchr_to_utf8_flags(a,b,0) |
| 67 | #define uvchr_to_utf8_flags(d,uv,flags) \ |
| 68 | uvchr_to_utf8_flags_msgs(d,uv,flags, 0) |
| 69 | #define uvchr_to_utf8_flags_msgs(d,uv,flags,msgs) \ |
| 70 | uvoffuni_to_utf8_flags_msgs(d,NATIVE_TO_UNI(uv),flags, msgs) |
| 71 | #define utf8_to_uvchr_buf(s, e, lenp) \ |
| 72 | utf8_to_uvchr_buf_helper((const U8 *) (s), (const U8 *) e, lenp) |
| 73 | #define utf8n_to_uvchr(s, len, lenp, flags) \ |
| 74 | utf8n_to_uvchr_error(s, len, lenp, flags, 0) |
| 75 | #define utf8n_to_uvchr_error(s, len, lenp, flags, errors) \ |
| 76 | utf8n_to_uvchr_msgs(s, len, lenp, flags, errors, 0) |
| 77 | |
| 78 | #define to_uni_fold(c, p, lenp) _to_uni_fold_flags(c, p, lenp, FOLD_FLAGS_FULL) |
| 79 | |
| 80 | #define foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \ |
| 81 | foldEQ_utf8_flags(s1, pe1, l1, u1, s2, pe2, l2, u2, 0) |
| 82 | #define FOLDEQ_UTF8_NOMIX_ASCII (1 << 0) |
| 83 | #define FOLDEQ_LOCALE (1 << 1) |
| 84 | #define FOLDEQ_S1_ALREADY_FOLDED (1 << 2) |
| 85 | #define FOLDEQ_S2_ALREADY_FOLDED (1 << 3) |
| 86 | #define FOLDEQ_S1_FOLDS_SANE (1 << 4) |
| 87 | #define FOLDEQ_S2_FOLDS_SANE (1 << 5) |
| 88 | |
| 89 | #define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \ |
| 90 | cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2)) |
| 91 | |
| 92 | #ifdef EBCDIC |
| 93 | /* The equivalent of these macros but implementing UTF-EBCDIC |
| 94 | are in the following header file: |
| 95 | */ |
| 96 | |
| 97 | #include "utfebcdic.h" |
| 98 | |
| 99 | #else /* ! EBCDIC */ |
| 100 | START_EXTERN_C |
| 101 | |
| 102 | /* |
| 103 | |
| 104 | =for apidoc AmnU|STRLEN|UTF8_MAXBYTES |
| 105 | |
| 106 | The maximum width of a single UTF-8 encoded character, in bytes. |
| 107 | |
| 108 | NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8 since UTF-8 |
| 109 | is an encoding of Unicode, and Unicode's upper limit, 0x10FFFF, can be |
| 110 | expressed with 4 bytes. However, Perl thinks of UTF-8 as a way to encode |
| 111 | non-negative integers in a binary format, even those above Unicode. |
| 112 | |
| 113 | =cut |
| 114 | */ |
| 115 | #define UTF8_MAXBYTES 13 |
| 116 | |
| 117 | #ifdef DOINIT |
| 118 | EXTCONST unsigned char PL_utf8skip[] = { |
| 119 | /* 0x00 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 120 | /* 0x10 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 121 | /* 0x20 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 122 | /* 0x30 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 123 | /* 0x40 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 124 | /* 0x50 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 125 | /* 0x60 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 126 | /* 0x70 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 127 | /* 0x80 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */ |
| 128 | /* 0x90 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */ |
| 129 | /* 0xA0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */ |
| 130 | /* 0xB0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */ |
| 131 | /* 0xC0 */ 2,2, /* overlong */ |
| 132 | /* 0xC2 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0080 to U+03FF */ |
| 133 | /* 0xD0 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0400 to U+07FF */ |
| 134 | /* 0xE0 */ 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3, /* U+0800 to U+FFFF */ |
| 135 | /* 0xF0 */ 4,4,4,4,4,4,4,4,5,5,5,5,6,6, /* above BMP to 2**31 - 1 */ |
| 136 | /* Perl extended (never was official UTF-8). Up to 36 bit */ |
| 137 | /* 0xFE */ 7, |
| 138 | /* More extended, Up to 72 bits (64-bit + reserved) */ |
| 139 | /* 0xFF */ UTF8_MAXBYTES |
| 140 | }; |
| 141 | #else |
| 142 | EXTCONST unsigned char PL_utf8skip[]; |
| 143 | #endif |
| 144 | |
| 145 | END_EXTERN_C |
| 146 | |
| 147 | /* |
| 148 | |
| 149 | =for apidoc Am|U8|NATIVE_TO_LATIN1|U8 ch |
| 150 | |
| 151 | Returns the Latin-1 (including ASCII and control characters) equivalent of the |
| 152 | input native code point given by C<ch>. Thus, C<NATIVE_TO_LATIN1(193)> on |
| 153 | EBCDIC platforms returns 65. These each represent the character C<"A"> on |
| 154 | their respective platforms. On ASCII platforms no conversion is needed, so |
| 155 | this macro expands to just its input, adding no time nor space requirements to |
| 156 | the implementation. |
| 157 | |
| 158 | For conversion of code points potentially larger than will fit in a character, |
| 159 | use L</NATIVE_TO_UNI>. |
| 160 | |
| 161 | =for apidoc Am|U8|LATIN1_TO_NATIVE|U8 ch |
| 162 | |
| 163 | Returns the native equivalent of the input Latin-1 code point (including ASCII |
| 164 | and control characters) given by C<ch>. Thus, C<LATIN1_TO_NATIVE(66)> on |
| 165 | EBCDIC platforms returns 194. These each represent the character C<"B"> on |
| 166 | their respective platforms. On ASCII platforms no conversion is needed, so |
| 167 | this macro expands to just its input, adding no time nor space requirements to |
| 168 | the implementation. |
| 169 | |
| 170 | For conversion of code points potentially larger than will fit in a character, |
| 171 | use L</UNI_TO_NATIVE>. |
| 172 | |
| 173 | =for apidoc Am|UV|NATIVE_TO_UNI|UV ch |
| 174 | |
| 175 | Returns the Unicode equivalent of the input native code point given by C<ch>. |
| 176 | Thus, C<NATIVE_TO_UNI(195)> on EBCDIC platforms returns 67. These each |
| 177 | represent the character C<"C"> on their respective platforms. On ASCII |
| 178 | platforms no conversion is needed, so this macro expands to just its input, |
| 179 | adding no time nor space requirements to the implementation. |
| 180 | |
| 181 | =for apidoc Am|UV|UNI_TO_NATIVE|UV ch |
| 182 | |
| 183 | Returns the native equivalent of the input Unicode code point given by C<ch>. |
| 184 | Thus, C<UNI_TO_NATIVE(68)> on EBCDIC platforms returns 196. These each |
| 185 | represent the character C<"D"> on their respective platforms. On ASCII |
| 186 | platforms no conversion is needed, so this macro expands to just its input, |
| 187 | adding no time nor space requirements to the implementation. |
| 188 | |
| 189 | =cut |
| 190 | */ |
| 191 | |
| 192 | #define NATIVE_TO_LATIN1(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) ((ch) | 0))) |
| 193 | #define LATIN1_TO_NATIVE(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) ((ch) | 0))) |
| 194 | |
| 195 | /* I8 is an intermediate version of UTF-8 used only in UTF-EBCDIC. We thus |
| 196 | * consider it to be identical to UTF-8 on ASCII platforms. Strictly speaking |
| 197 | * UTF-8 and UTF-EBCDIC are two different things, but we often conflate them |
| 198 | * because they are 8-bit encodings that serve the same purpose in Perl, and |
| 199 | * rarely do we need to distinguish them. The term "NATIVE_UTF8" applies to |
| 200 | * whichever one is applicable on the current platform */ |
| 201 | #define NATIVE_UTF8_TO_I8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) ((ch) | 0))) |
| 202 | #define I8_TO_NATIVE_UTF8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) ((ch) | 0))) |
| 203 | |
| 204 | #define UNI_TO_NATIVE(ch) ((UV) ((ch) | 0)) |
| 205 | #define NATIVE_TO_UNI(ch) ((UV) ((ch) | 0)) |
| 206 | |
| 207 | /* |
| 208 | |
| 209 | The following table is from Unicode 3.2, plus the Perl extensions for above |
| 210 | U+10FFFF |
| 211 | |
| 212 | Code Points 1st Byte 2nd Byte 3rd 4th 5th 6th 7th 8th-13th |
| 213 | |
| 214 | U+0000..U+007F 00..7F |
| 215 | U+0080..U+07FF * C2..DF 80..BF |
| 216 | U+0800..U+0FFF E0 * A0..BF 80..BF |
| 217 | U+1000..U+CFFF E1..EC 80..BF 80..BF |
| 218 | U+D000..U+D7FF ED 80..9F 80..BF |
| 219 | U+D800..U+DFFF ED A0..BF 80..BF (surrogates) |
| 220 | U+E000..U+FFFF EE..EF 80..BF 80..BF |
| 221 | U+10000..U+3FFFF F0 * 90..BF 80..BF 80..BF |
| 222 | U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF |
| 223 | U+100000..U+10FFFF F4 80..8F 80..BF 80..BF |
| 224 | Below are above-Unicode code points |
| 225 | U+110000..U+13FFFF F4 90..BF 80..BF 80..BF |
| 226 | U+110000..U+1FFFFF F5..F7 80..BF 80..BF 80..BF |
| 227 | U+200000..U+FFFFFF F8 * 88..BF 80..BF 80..BF 80..BF |
| 228 | U+1000000..U+3FFFFFF F9..FB 80..BF 80..BF 80..BF 80..BF |
| 229 | U+4000000..U+3FFFFFFF FC * 84..BF 80..BF 80..BF 80..BF 80..BF |
| 230 | U+40000000..U+7FFFFFFF FD 80..BF 80..BF 80..BF 80..BF 80..BF |
| 231 | U+80000000..U+FFFFFFFFF FE * 82..BF 80..BF 80..BF 80..BF 80..BF 80..BF |
| 232 | U+1000000000.. FF 80..BF 80..BF 80..BF 80..BF 80..BF * 81..BF 80..BF |
| 233 | |
| 234 | Note the gaps before several of the byte entries above marked by '*'. These are |
| 235 | caused by legal UTF-8 avoiding non-shortest encodings: it is technically |
| 236 | possible to UTF-8-encode a single code point in different ways, but that is |
| 237 | explicitly forbidden, and the shortest possible encoding should always be used |
| 238 | (and that is what Perl does). The non-shortest ones are called 'overlongs'. |
| 239 | |
| 240 | */ |
| 241 | |
| 242 | /* |
| 243 | Another way to look at it, as bits: |
| 244 | |
| 245 | Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte |
| 246 | |
| 247 | 0aaa aaaa 0aaa aaaa |
| 248 | 0000 0bbb bbaa aaaa 110b bbbb 10aa aaaa |
| 249 | cccc bbbb bbaa aaaa 1110 cccc 10bb bbbb 10aa aaaa |
| 250 | 00 000d ddcc cccc bbbb bbaa aaaa 1111 0ddd 10cc cccc 10bb bbbb 10aa aaaa |
| 251 | |
| 252 | As you can see, the continuation bytes all begin with C<10>, and the |
| 253 | leading bits of the start byte tell how many bytes there are in the |
| 254 | encoded character. |
| 255 | |
| 256 | Perl's extended UTF-8 means we can have start bytes up through FF, though any |
| 257 | beginning with FF yields a code point that is too large for 32-bit ASCII |
| 258 | platforms. FF signals to use 13 bytes for the encoded character. This breaks |
| 259 | the paradigm that the number of leading bits gives how many total bytes there |
| 260 | are in the character. */ |
| 261 | |
| 262 | /* This is the number of low-order bits a continuation byte in a UTF-8 encoded |
| 263 | * sequence contributes to the specification of the code point. In the bit |
| 264 | * maps above, you see that the first 2 bits are a constant '10', leaving 6 of |
| 265 | * real information */ |
| 266 | #define UTF_ACCUMULATION_SHIFT 6 |
| 267 | |
| 268 | /* ^? is defined to be DEL on ASCII systems. See the definition of toCTRL() |
| 269 | * for more */ |
| 270 | #define QUESTION_MARK_CTRL DEL_NATIVE |
| 271 | |
| 272 | /* Surrogates, non-character code points and above-Unicode code points are |
| 273 | * problematic in some contexts. This allows code that needs to check for |
| 274 | * those to to quickly exclude the vast majority of code points it will |
| 275 | * encounter */ |
| 276 | #define isUTF8_POSSIBLY_PROBLEMATIC(c) (__ASSERT_(FITS_IN_8_BITS(c)) \ |
| 277 | (U8) c >= 0xED) |
| 278 | |
| 279 | #define UNICODE_IS_PERL_EXTENDED(uv) UNLIKELY((UV) (uv) > 0x7FFFFFFF) |
| 280 | |
| 281 | #endif /* EBCDIC vs ASCII */ |
| 282 | |
| 283 | /* 2**UTF_ACCUMULATION_SHIFT - 1. This masks out all but the bits that carry |
| 284 | * real information in a continuation byte. This turns out to be 0x3F in |
| 285 | * UTF-8, 0x1F in UTF-EBCDIC. */ |
| 286 | #define UTF_CONTINUATION_MASK ((U8) ((1U << UTF_ACCUMULATION_SHIFT) - 1)) |
| 287 | |
| 288 | /* For use in UTF8_IS_CONTINUATION(). This turns out to be 0xC0 in UTF-8, |
| 289 | * E0 in UTF-EBCDIC */ |
| 290 | #define UTF_IS_CONTINUATION_MASK ((U8) (0xFF << UTF_ACCUMULATION_SHIFT)) |
| 291 | |
| 292 | /* This defines the bits that are to be in the continuation bytes of a |
| 293 | * multi-byte UTF-8 encoded character that mark it is a continuation byte. |
| 294 | * This turns out to be 0x80 in UTF-8, 0xA0 in UTF-EBCDIC. (khw doesn't know |
| 295 | * the underlying reason that B0 works here) */ |
| 296 | #define UTF_CONTINUATION_MARK (UTF_IS_CONTINUATION_MASK & 0xB0) |
| 297 | |
| 298 | /* Is the byte 'c' part of a multi-byte UTF8-8 encoded sequence, and not the |
| 299 | * first byte thereof? */ |
| 300 | #define UTF8_IS_CONTINUATION(c) (__ASSERT_(FITS_IN_8_BITS(c)) \ |
| 301 | (((NATIVE_UTF8_TO_I8(c) & UTF_IS_CONTINUATION_MASK) \ |
| 302 | == UTF_CONTINUATION_MARK))) |
| 303 | |
| 304 | /* Is the representation of the Unicode code point 'cp' the same regardless of |
| 305 | * being encoded in UTF-8 or not? This is a fundamental property of |
| 306 | * UTF-8,EBCDIC */ |
| 307 | #define OFFUNI_IS_INVARIANT(c) (((WIDEST_UTYPE)(c)) < UTF_CONTINUATION_MARK) |
| 308 | |
| 309 | /* |
| 310 | =for apidoc Am|bool|UVCHR_IS_INVARIANT|UV cp |
| 311 | |
| 312 | Evaluates to 1 if the representation of code point C<cp> is the same whether or |
| 313 | not it is encoded in UTF-8; otherwise evaluates to 0. UTF-8 invariant |
| 314 | characters can be copied as-is when converting to/from UTF-8, saving time. |
| 315 | C<cp> is Unicode if above 255; otherwise is platform-native. |
| 316 | |
| 317 | =cut |
| 318 | */ |
| 319 | #define UVCHR_IS_INVARIANT(cp) (OFFUNI_IS_INVARIANT(NATIVE_TO_UNI(cp))) |
| 320 | |
| 321 | /* Internal macro to be used only in this file to aid in constructing other |
| 322 | * publicly accessible macros. |
| 323 | * The number of bytes required to express this uv in UTF-8, for just those |
| 324 | * uv's requiring 2 through 6 bytes, as these are common to all platforms and |
| 325 | * word sizes. The number of bytes needed is given by the number of leading 1 |
| 326 | * bits in the start byte. There are 32 start bytes that have 2 initial 1 bits |
| 327 | * (C0-DF); there are 16 that have 3 initial 1 bits (E0-EF); 8 that have 4 |
| 328 | * initial 1 bits (F0-F8); 4 that have 5 initial 1 bits (F9-FB), and 2 that |
| 329 | * have 6 initial 1 bits (FC-FD). The largest number a string of n bytes can |
| 330 | * represent is (the number of possible start bytes for 'n') |
| 331 | * * (the number of possiblities for each start byte |
| 332 | * The latter in turn is |
| 333 | * 2 ** ( (how many continuation bytes there are) |
| 334 | * * (the number of bits of information each |
| 335 | * continuation byte holds)) |
| 336 | * |
| 337 | * If we were on a platform where we could use a fast find first set bit |
| 338 | * instruction (or count leading zeros instruction) this could be replaced by |
| 339 | * using that to find the log2 of the uv, and divide that by the number of bits |
| 340 | * of information in each continuation byte, adjusting for large cases and how |
| 341 | * much information is in a start byte for that length */ |
| 342 | #define __COMMON_UNI_SKIP(uv) \ |
| 343 | (UV) (uv) < (32 * (1U << ( UTF_ACCUMULATION_SHIFT))) ? 2 : \ |
| 344 | (UV) (uv) < (16 * (1U << (2 * UTF_ACCUMULATION_SHIFT))) ? 3 : \ |
| 345 | (UV) (uv) < ( 8 * (1U << (3 * UTF_ACCUMULATION_SHIFT))) ? 4 : \ |
| 346 | (UV) (uv) < ( 4 * (1U << (4 * UTF_ACCUMULATION_SHIFT))) ? 5 : \ |
| 347 | (UV) (uv) < ( 2 * (1U << (5 * UTF_ACCUMULATION_SHIFT))) ? 6 : |
| 348 | |
| 349 | /* Internal macro to be used only in this file. |
| 350 | * This adds to __COMMON_UNI_SKIP the details at this platform's upper range. |
| 351 | * For any-sized EBCDIC platforms, or 64-bit ASCII ones, we need one more test |
| 352 | * to see if just 7 bytes is needed, or if the maximum is needed. For 32-bit |
| 353 | * ASCII platforms, everything is representable by 7 bytes */ |
| 354 | #if defined(UV_IS_QUAD) || defined(EBCDIC) |
| 355 | # define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) \ |
| 356 | (UV) (uv) < ((UV) 1U << (6 * UTF_ACCUMULATION_SHIFT)) ? 7 : UTF8_MAXBYTES) |
| 357 | #else |
| 358 | # define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) 7) |
| 359 | #endif |
| 360 | |
| 361 | /* The next two macros use the base macro defined above, and add in the tests |
| 362 | * at the low-end of the range, for just 1 byte, yielding complete macros, |
| 363 | * publicly accessible. */ |
| 364 | |
| 365 | /* Input is a true Unicode (not-native) code point */ |
| 366 | #define OFFUNISKIP(uv) (OFFUNI_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv)) |
| 367 | |
| 368 | /* |
| 369 | |
| 370 | =for apidoc Am|STRLEN|UVCHR_SKIP|UV cp |
| 371 | returns the number of bytes required to represent the code point C<cp> when |
| 372 | encoded as UTF-8. C<cp> is a native (ASCII or EBCDIC) code point if less than |
| 373 | 255; a Unicode code point otherwise. |
| 374 | |
| 375 | =cut |
| 376 | */ |
| 377 | #define UVCHR_SKIP(uv) ( UVCHR_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv)) |
| 378 | |
| 379 | #define UTF_MIN_START_BYTE \ |
| 380 | ((UTF_CONTINUATION_MARK >> UTF_ACCUMULATION_SHIFT) | UTF_START_MARK(2)) |
| 381 | |
| 382 | /* Is the byte 'c' the first byte of a multi-byte UTF8-8 encoded sequence? |
| 383 | * This excludes invariants (they are single-byte). It also excludes the |
| 384 | * illegal overlong sequences that begin with C0 and C1 on ASCII platforms, and |
| 385 | * C0-C4 I8 start bytes on EBCDIC ones. On EBCDIC E0 can't start a |
| 386 | * non-overlong sequence, so we define a base macro and for those platforms, |
| 387 | * extend it to also exclude E0 */ |
| 388 | #define UTF8_IS_START_base(c) (__ASSERT_(FITS_IN_8_BITS(c)) \ |
| 389 | (NATIVE_UTF8_TO_I8(c) >= UTF_MIN_START_BYTE)) |
| 390 | #ifdef EBCDIC |
| 391 | # define UTF8_IS_START(c) \ |
| 392 | (UTF8_IS_START_base(c) && (c) != I8_TO_NATIVE_UTF8(0xE0)) |
| 393 | #else |
| 394 | # define UTF8_IS_START(c) UTF8_IS_START_base(c) |
| 395 | #endif |
| 396 | |
| 397 | #define UTF_MIN_ABOVE_LATIN1_BYTE \ |
| 398 | ((0x100 >> UTF_ACCUMULATION_SHIFT) | UTF_START_MARK(2)) |
| 399 | |
| 400 | /* Is the UTF8-encoded byte 'c' the first byte of a sequence of bytes that |
| 401 | * represent a code point > 255? */ |
| 402 | #define UTF8_IS_ABOVE_LATIN1(c) (__ASSERT_(FITS_IN_8_BITS(c)) \ |
| 403 | (NATIVE_UTF8_TO_I8(c) >= UTF_MIN_ABOVE_LATIN1_BYTE)) |
| 404 | |
| 405 | /* Is the UTF8-encoded byte 'c' the first byte of a two byte sequence? Use |
| 406 | * UTF8_IS_NEXT_CHAR_DOWNGRADEABLE() instead if the input isn't known to |
| 407 | * be well-formed. */ |
| 408 | #define UTF8_IS_DOWNGRADEABLE_START(c) (__ASSERT_(FITS_IN_8_BITS(c)) \ |
| 409 | inRANGE(NATIVE_UTF8_TO_I8(c), \ |
| 410 | UTF_MIN_START_BYTE, UTF_MIN_ABOVE_LATIN1_BYTE - 1)) |
| 411 | |
| 412 | /* The largest code point representable by two UTF-8 bytes on this platform. |
| 413 | * As explained in the comments for __COMMON_UNI_SKIP, 32 start bytes with |
| 414 | * UTF_ACCUMULATION_SHIFT bits of information each */ |
| 415 | #define MAX_UTF8_TWO_BYTE (32 * (1U << UTF_ACCUMULATION_SHIFT) - 1) |
| 416 | |
| 417 | /* The largest code point representable by two UTF-8 bytes on any platform that |
| 418 | * Perl runs on. This value is constrained by EBCDIC which has 5 bits per |
| 419 | * continuation byte */ |
| 420 | #define MAX_PORTABLE_UTF8_TWO_BYTE (32 * (1U << 5) - 1) |
| 421 | |
| 422 | /* |
| 423 | |
| 424 | =for apidoc AmnU|STRLEN|UTF8_MAXBYTES_CASE |
| 425 | |
| 426 | The maximum number of UTF-8 bytes a single Unicode character can |
| 427 | uppercase/lowercase/titlecase/fold into. |
| 428 | |
| 429 | =cut |
| 430 | |
| 431 | * Unicode guarantees that the maximum expansion is UTF8_MAX_FOLD_CHAR_EXPAND |
| 432 | * characters, but any above-Unicode code point will fold to itself, so we only |
| 433 | * have to look at the expansion of the maximum Unicode code point. But this |
| 434 | * number may be less than the space occupied by a very large code point under |
| 435 | * Perl's extended UTF-8. We have to make it large enough to fit any single |
| 436 | * character. (It turns out that ASCII and EBCDIC differ in which is larger) |
| 437 | * |
| 438 | =cut |
| 439 | */ |
| 440 | #define UTF8_MAXBYTES_CASE \ |
| 441 | MAX(UTF8_MAXBYTES, UTF8_MAX_FOLD_CHAR_EXPAND * OFFUNISKIP(0x10FFFF)) |
| 442 | |
| 443 | /* Rest of these are attributes of Unicode and perl's internals rather than the |
| 444 | * encoding, or happen to be the same in both ASCII and EBCDIC (at least at |
| 445 | * this level; the macros that some of these call may have different |
| 446 | * definitions in the two encodings */ |
| 447 | |
| 448 | /* In domain restricted to ASCII, these may make more sense to the reader than |
| 449 | * the ones with Latin1 in the name */ |
| 450 | #define NATIVE_TO_ASCII(ch) NATIVE_TO_LATIN1(ch) |
| 451 | #define ASCII_TO_NATIVE(ch) LATIN1_TO_NATIVE(ch) |
| 452 | |
| 453 | /* More or less misleadingly-named defines, retained for back compat */ |
| 454 | #define NATIVE_TO_UTF(ch) NATIVE_UTF8_TO_I8(ch) |
| 455 | #define NATIVE_TO_I8(ch) NATIVE_UTF8_TO_I8(ch) |
| 456 | #define UTF_TO_NATIVE(ch) I8_TO_NATIVE_UTF8(ch) |
| 457 | #define I8_TO_NATIVE(ch) I8_TO_NATIVE_UTF8(ch) |
| 458 | #define NATIVE8_TO_UNI(ch) NATIVE_TO_LATIN1(ch) |
| 459 | |
| 460 | /* This defines the 1-bits that are to be in the first byte of a multi-byte |
| 461 | * UTF-8 encoded character that mark it as a start byte and give the number of |
| 462 | * bytes that comprise the character. 'len' is the number of bytes in the |
| 463 | * multi-byte sequence. */ |
| 464 | #define UTF_START_MARK(len) (((len) > 7) ? 0xFF : ((U8) (0xFE << (7-(len))))) |
| 465 | |
| 466 | /* Masks out the initial one bits in a start byte, leaving the real data ones. |
| 467 | * Doesn't work on an invariant byte. 'len' is the number of bytes in the |
| 468 | * multi-byte sequence that comprises the character. */ |
| 469 | #define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2))) |
| 470 | |
| 471 | /* Adds a UTF8 continuation byte 'new' of information to a running total code |
| 472 | * point 'old' of all the continuation bytes so far. This is designed to be |
| 473 | * used in a loop to convert from UTF-8 to the code point represented. Note |
| 474 | * that this is asymmetric on EBCDIC platforms, in that the 'new' parameter is |
| 475 | * the UTF-EBCDIC byte, whereas the 'old' parameter is a Unicode (not EBCDIC) |
| 476 | * code point in process of being generated */ |
| 477 | #define UTF8_ACCUMULATE(old, new) (__ASSERT_(FITS_IN_8_BITS(new)) \ |
| 478 | ((old) << UTF_ACCUMULATION_SHIFT) \ |
| 479 | | ((NATIVE_UTF8_TO_I8(new)) \ |
| 480 | & UTF_CONTINUATION_MASK)) |
| 481 | |
| 482 | /* This works in the face of malformed UTF-8. */ |
| 483 | #define UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, e) \ |
| 484 | ( UTF8_IS_DOWNGRADEABLE_START(*(s)) \ |
| 485 | && ( (e) - (s) > 1) \ |
| 486 | && UTF8_IS_CONTINUATION(*((s)+1))) |
| 487 | |
| 488 | /* Number of bytes a code point occupies in UTF-8. */ |
| 489 | #define NATIVE_SKIP(uv) UVCHR_SKIP(uv) |
| 490 | |
| 491 | /* Most code which says UNISKIP is really thinking in terms of native code |
| 492 | * points (0-255) plus all those beyond. This is an imprecise term, but having |
| 493 | * it means existing code continues to work. For precision, use UVCHR_SKIP, |
| 494 | * NATIVE_SKIP, or OFFUNISKIP */ |
| 495 | #define UNISKIP(uv) UVCHR_SKIP(uv) |
| 496 | |
| 497 | /* Longer, but more accurate name */ |
| 498 | #define UTF8_IS_ABOVE_LATIN1_START(c) UTF8_IS_ABOVE_LATIN1(c) |
| 499 | |
| 500 | /* Convert a UTF-8 variant Latin1 character to a native code point value. |
| 501 | * Needs just one iteration of accumulate. Should be used only if it is known |
| 502 | * that the code point is < 256, and is not UTF-8 invariant. Use the slower |
| 503 | * but more general TWO_BYTE_UTF8_TO_NATIVE() which handles any code point |
| 504 | * representable by two bytes (which turns out to be up through |
| 505 | * MAX_PORTABLE_UTF8_TWO_BYTE). The two parameters are: |
| 506 | * HI: a downgradable start byte; |
| 507 | * LO: continuation. |
| 508 | * */ |
| 509 | #define EIGHT_BIT_UTF8_TO_NATIVE(HI, LO) \ |
| 510 | ( __ASSERT_(UTF8_IS_DOWNGRADEABLE_START(HI)) \ |
| 511 | __ASSERT_(UTF8_IS_CONTINUATION(LO)) \ |
| 512 | LATIN1_TO_NATIVE(UTF8_ACCUMULATE(( \ |
| 513 | NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), (LO)))) |
| 514 | |
| 515 | /* Convert a two (not one) byte utf8 character to a native code point value. |
| 516 | * Needs just one iteration of accumulate. Should not be used unless it is |
| 517 | * known that the two bytes are legal: 1) two-byte start, and 2) continuation. |
| 518 | * Note that the result can be larger than 255 if the input character is not |
| 519 | * downgradable */ |
| 520 | #define TWO_BYTE_UTF8_TO_NATIVE(HI, LO) \ |
| 521 | (__ASSERT_(FITS_IN_8_BITS(HI)) \ |
| 522 | __ASSERT_(FITS_IN_8_BITS(LO)) \ |
| 523 | __ASSERT_(PL_utf8skip[HI] == 2) \ |
| 524 | __ASSERT_(UTF8_IS_CONTINUATION(LO)) \ |
| 525 | UNI_TO_NATIVE(UTF8_ACCUMULATE((NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), \ |
| 526 | (LO)))) |
| 527 | |
| 528 | /* Should never be used, and be deprecated */ |
| 529 | #define TWO_BYTE_UTF8_TO_UNI(HI, LO) NATIVE_TO_UNI(TWO_BYTE_UTF8_TO_NATIVE(HI, LO)) |
| 530 | |
| 531 | /* |
| 532 | |
| 533 | =for apidoc Am|STRLEN|UTF8SKIP|char* s |
| 534 | returns the number of bytes a non-malformed UTF-8 encoded character whose first |
| 535 | (perhaps only) byte is pointed to by C<s>. |
| 536 | |
| 537 | If there is a possibility of malformed input, use instead: |
| 538 | |
| 539 | =over |
| 540 | |
| 541 | =item L</C<UTF8_SAFE_SKIP>> if you know the maximum ending pointer in the |
| 542 | buffer pointed to by C<s>; or |
| 543 | |
| 544 | =item L</C<UTF8_CHK_SKIP>> if you don't know it. |
| 545 | |
| 546 | =back |
| 547 | |
| 548 | It is better to restructure your code so the end pointer is passed down so that |
| 549 | you know what it actually is at the point of this call, but if that isn't |
| 550 | possible, L</C<UTF8_CHK_SKIP>> can minimize the chance of accessing beyond the end |
| 551 | of the input buffer. |
| 552 | |
| 553 | =cut |
| 554 | */ |
| 555 | #define UTF8SKIP(s) PL_utf8skip[*(const U8*)(s)] |
| 556 | |
| 557 | /* |
| 558 | =for apidoc Am|STRLEN|UTF8_SKIP|char* s |
| 559 | This is a synonym for L</C<UTF8SKIP>> |
| 560 | |
| 561 | =cut |
| 562 | */ |
| 563 | |
| 564 | #define UTF8_SKIP(s) UTF8SKIP(s) |
| 565 | |
| 566 | /* |
| 567 | =for apidoc Am|STRLEN|UTF8_CHK_SKIP|char* s |
| 568 | |
| 569 | This is a safer version of L</C<UTF8SKIP>>, but still not as safe as |
| 570 | L</C<UTF8_SAFE_SKIP>>. This version doesn't blindly assume that the input |
| 571 | string pointed to by C<s> is well-formed, but verifies that there isn't a NUL |
| 572 | terminating character before the expected end of the next character in C<s>. |
| 573 | The length C<UTF8_CHK_SKIP> returns stops just before any such NUL. |
| 574 | |
| 575 | Perl tends to add NULs, as an insurance policy, after the end of strings in |
| 576 | SV's, so it is likely that using this macro will prevent inadvertent reading |
| 577 | beyond the end of the input buffer, even if it is malformed UTF-8. |
| 578 | |
| 579 | This macro is intended to be used by XS modules where the inputs could be |
| 580 | malformed, and it isn't feasible to restructure to use the safer |
| 581 | L</C<UTF8_SAFE_SKIP>>, for example when interfacing with a C library. |
| 582 | |
| 583 | =cut |
| 584 | */ |
| 585 | |
| 586 | #define UTF8_CHK_SKIP(s) \ |
| 587 | (s[0] == '\0' ? 1 : MIN(UTF8SKIP(s), \ |
| 588 | my_strnlen((char *) (s), UTF8SKIP(s)))) |
| 589 | /* |
| 590 | |
| 591 | =for apidoc Am|STRLEN|UTF8_SAFE_SKIP|char* s|char* e |
| 592 | returns 0 if S<C<s E<gt>= e>>; otherwise returns the number of bytes in the |
| 593 | UTF-8 encoded character whose first byte is pointed to by C<s>. But it never |
| 594 | returns beyond C<e>. On DEBUGGING builds, it asserts that S<C<s E<lt>= e>>. |
| 595 | |
| 596 | =cut |
| 597 | */ |
| 598 | #define UTF8_SAFE_SKIP(s, e) (__ASSERT_((e) >= (s)) \ |
| 599 | ((e) - (s)) <= 0 \ |
| 600 | ? 0 \ |
| 601 | : MIN(((e) - (s)), UTF8_SKIP(s))) |
| 602 | |
| 603 | /* Most code that says 'UNI_' really means the native value for code points up |
| 604 | * through 255 */ |
| 605 | #define UNI_IS_INVARIANT(cp) UVCHR_IS_INVARIANT(cp) |
| 606 | |
| 607 | /* |
| 608 | =for apidoc Am|bool|UTF8_IS_INVARIANT|char c |
| 609 | |
| 610 | Evaluates to 1 if the byte C<c> represents the same character when encoded in |
| 611 | UTF-8 as when not; otherwise evaluates to 0. UTF-8 invariant characters can be |
| 612 | copied as-is when converting to/from UTF-8, saving time. |
| 613 | |
| 614 | In spite of the name, this macro gives the correct result if the input string |
| 615 | from which C<c> comes is not encoded in UTF-8. |
| 616 | |
| 617 | See C<L</UVCHR_IS_INVARIANT>> for checking if a UV is invariant. |
| 618 | |
| 619 | =cut |
| 620 | |
| 621 | The reason it works on both UTF-8 encoded strings and non-UTF-8 encoded, is |
| 622 | that it returns TRUE in each for the exact same set of bit patterns. It is |
| 623 | valid on a subset of what UVCHR_IS_INVARIANT is valid on, so can just use that; |
| 624 | and the compiler should optimize out anything extraneous given the |
| 625 | implementation of the latter. The |0 makes sure this isn't mistakenly called |
| 626 | with a ptr argument. |
| 627 | */ |
| 628 | #define UTF8_IS_INVARIANT(c) UVCHR_IS_INVARIANT((c) | 0) |
| 629 | |
| 630 | /* Like the above, but its name implies a non-UTF8 input, which as the comments |
| 631 | * above show, doesn't matter as to its implementation */ |
| 632 | #define NATIVE_BYTE_IS_INVARIANT(c) UVCHR_IS_INVARIANT(c) |
| 633 | |
| 634 | /* Misleadingly named: is the UTF8-encoded byte 'c' part of a variant sequence |
| 635 | * in UTF-8? This is the inverse of UTF8_IS_INVARIANT. */ |
| 636 | #define UTF8_IS_CONTINUED(c) (__ASSERT_(FITS_IN_8_BITS(c)) \ |
| 637 | (! UTF8_IS_INVARIANT(c))) |
| 638 | |
| 639 | /* The macros in the next 4 sets are used to generate the two utf8 or utfebcdic |
| 640 | * bytes from an ordinal that is known to fit into exactly two (not one) bytes; |
| 641 | * it must be less than 0x3FF to work across both encodings. */ |
| 642 | |
| 643 | /* These two are helper macros for the other three sets, and should not be used |
| 644 | * directly anywhere else. 'translate_function' is either NATIVE_TO_LATIN1 |
| 645 | * (which works for code points up through 0xFF) or NATIVE_TO_UNI which works |
| 646 | * for any code point */ |
| 647 | #define __BASE_TWO_BYTE_HI(c, translate_function) \ |
| 648 | (__ASSERT_(! UVCHR_IS_INVARIANT(c)) \ |
| 649 | I8_TO_NATIVE_UTF8((translate_function(c) >> UTF_ACCUMULATION_SHIFT) \ |
| 650 | | UTF_START_MARK(2))) |
| 651 | #define __BASE_TWO_BYTE_LO(c, translate_function) \ |
| 652 | (__ASSERT_(! UVCHR_IS_INVARIANT(c)) \ |
| 653 | I8_TO_NATIVE_UTF8((translate_function(c) & UTF_CONTINUATION_MASK) \ |
| 654 | | UTF_CONTINUATION_MARK)) |
| 655 | |
| 656 | /* The next two macros should not be used. They were designed to be usable as |
| 657 | * the case label of a switch statement, but this doesn't work for EBCDIC. Use |
| 658 | * regen/unicode_constants.pl instead */ |
| 659 | #define UTF8_TWO_BYTE_HI_nocast(c) __BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI) |
| 660 | #define UTF8_TWO_BYTE_LO_nocast(c) __BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI) |
| 661 | |
| 662 | /* The next two macros are used when the source should be a single byte |
| 663 | * character; checked for under DEBUGGING */ |
| 664 | #define UTF8_EIGHT_BIT_HI(c) (__ASSERT_(FITS_IN_8_BITS(c)) \ |
| 665 | ( __BASE_TWO_BYTE_HI(c, NATIVE_TO_LATIN1))) |
| 666 | #define UTF8_EIGHT_BIT_LO(c) (__ASSERT_(FITS_IN_8_BITS(c)) \ |
| 667 | (__BASE_TWO_BYTE_LO(c, NATIVE_TO_LATIN1))) |
| 668 | |
| 669 | /* These final two macros in the series are used when the source can be any |
| 670 | * code point whose UTF-8 is known to occupy 2 bytes; they are less efficient |
| 671 | * than the EIGHT_BIT versions on EBCDIC platforms. We use the logical '~' |
| 672 | * operator instead of "<=" to avoid getting compiler warnings. |
| 673 | * MAX_UTF8_TWO_BYTE should be exactly all one bits in the lower few |
| 674 | * places, so the ~ works */ |
| 675 | #define UTF8_TWO_BYTE_HI(c) \ |
| 676 | (__ASSERT_((sizeof(c) == 1) \ |
| 677 | || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE)) \ |
| 678 | (__BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI))) |
| 679 | #define UTF8_TWO_BYTE_LO(c) \ |
| 680 | (__ASSERT_((sizeof(c) == 1) \ |
| 681 | || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE)) \ |
| 682 | (__BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI))) |
| 683 | |
| 684 | /* This is illegal in any well-formed UTF-8 in both EBCDIC and ASCII |
| 685 | * as it is only in overlongs. */ |
| 686 | #define ILLEGAL_UTF8_BYTE I8_TO_NATIVE_UTF8(0xC1) |
| 687 | |
| 688 | /* |
| 689 | * 'UTF' is whether or not p is encoded in UTF8. The names 'foo_lazy_if' stem |
| 690 | * from an earlier version of these macros in which they didn't call the |
| 691 | * foo_utf8() macros (i.e. were 'lazy') unless they decided that *p is the |
| 692 | * beginning of a utf8 character. Now that foo_utf8() determines that itself, |
| 693 | * no need to do it again here |
| 694 | */ |
| 695 | #define isIDFIRST_lazy_if_safe(p, e, UTF) \ |
| 696 | ((IN_BYTES || !UTF) \ |
| 697 | ? isIDFIRST(*(p)) \ |
| 698 | : isIDFIRST_utf8_safe(p, e)) |
| 699 | #define isWORDCHAR_lazy_if_safe(p, e, UTF) \ |
| 700 | ((IN_BYTES || !UTF) \ |
| 701 | ? isWORDCHAR(*(p)) \ |
| 702 | : isWORDCHAR_utf8_safe((U8 *) p, (U8 *) e)) |
| 703 | #define isALNUM_lazy_if_safe(p, e, UTF) isWORDCHAR_lazy_if_safe(p, e, UTF) |
| 704 | |
| 705 | #define UTF8_MAXLEN UTF8_MAXBYTES |
| 706 | |
| 707 | /* A Unicode character can fold to up to 3 characters */ |
| 708 | #define UTF8_MAX_FOLD_CHAR_EXPAND 3 |
| 709 | |
| 710 | #define IN_BYTES UNLIKELY(CopHINTS_get(PL_curcop) & HINT_BYTES) |
| 711 | |
| 712 | /* |
| 713 | |
| 714 | =for apidoc Am|bool|DO_UTF8|SV* sv |
| 715 | Returns a bool giving whether or not the PV in C<sv> is to be treated as being |
| 716 | encoded in UTF-8. |
| 717 | |
| 718 | You should use this I<after> a call to C<SvPV()> or one of its variants, in |
| 719 | case any call to string overloading updates the internal UTF-8 encoding flag. |
| 720 | |
| 721 | =cut |
| 722 | */ |
| 723 | #define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES) |
| 724 | |
| 725 | /* Should all strings be treated as Unicode, and not just UTF-8 encoded ones? |
| 726 | * Is so within 'feature unicode_strings' or 'locale :not_characters', and not |
| 727 | * within 'use bytes'. UTF-8 locales are not tested for here, but perhaps |
| 728 | * could be */ |
| 729 | #define IN_UNI_8_BIT \ |
| 730 | (( ( (CopHINTS_get(PL_curcop) & HINT_UNI_8_BIT)) \ |
| 731 | || ( CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL \ |
| 732 | /* -1 below is for :not_characters */ \ |
| 733 | && _is_in_locale_category(FALSE, -1))) \ |
| 734 | && (! IN_BYTES)) |
| 735 | |
| 736 | |
| 737 | #define UTF8_ALLOW_EMPTY 0x0001 /* Allow a zero length string */ |
| 738 | #define UTF8_GOT_EMPTY UTF8_ALLOW_EMPTY |
| 739 | |
| 740 | /* Allow first byte to be a continuation byte */ |
| 741 | #define UTF8_ALLOW_CONTINUATION 0x0002 |
| 742 | #define UTF8_GOT_CONTINUATION UTF8_ALLOW_CONTINUATION |
| 743 | |
| 744 | /* Unexpected non-continuation byte */ |
| 745 | #define UTF8_ALLOW_NON_CONTINUATION 0x0004 |
| 746 | #define UTF8_GOT_NON_CONTINUATION UTF8_ALLOW_NON_CONTINUATION |
| 747 | |
| 748 | /* expecting more bytes than were available in the string */ |
| 749 | #define UTF8_ALLOW_SHORT 0x0008 |
| 750 | #define UTF8_GOT_SHORT UTF8_ALLOW_SHORT |
| 751 | |
| 752 | /* Overlong sequence; i.e., the code point can be specified in fewer bytes. |
| 753 | * First one will convert the overlong to the REPLACEMENT CHARACTER; second |
| 754 | * will return what the overlong evaluates to */ |
| 755 | #define UTF8_ALLOW_LONG 0x0010 |
| 756 | #define UTF8_ALLOW_LONG_AND_ITS_VALUE (UTF8_ALLOW_LONG|0x0020) |
| 757 | #define UTF8_GOT_LONG UTF8_ALLOW_LONG |
| 758 | |
| 759 | #define UTF8_ALLOW_OVERFLOW 0x0080 |
| 760 | #define UTF8_GOT_OVERFLOW UTF8_ALLOW_OVERFLOW |
| 761 | |
| 762 | #define UTF8_DISALLOW_SURROGATE 0x0100 /* Unicode surrogates */ |
| 763 | #define UTF8_GOT_SURROGATE UTF8_DISALLOW_SURROGATE |
| 764 | #define UTF8_WARN_SURROGATE 0x0200 |
| 765 | |
| 766 | /* Unicode non-character code points */ |
| 767 | #define UTF8_DISALLOW_NONCHAR 0x0400 |
| 768 | #define UTF8_GOT_NONCHAR UTF8_DISALLOW_NONCHAR |
| 769 | #define UTF8_WARN_NONCHAR 0x0800 |
| 770 | |
| 771 | /* Super-set of Unicode: code points above the legal max */ |
| 772 | #define UTF8_DISALLOW_SUPER 0x1000 |
| 773 | #define UTF8_GOT_SUPER UTF8_DISALLOW_SUPER |
| 774 | #define UTF8_WARN_SUPER 0x2000 |
| 775 | |
| 776 | /* The original UTF-8 standard did not define UTF-8 with start bytes of 0xFE or |
| 777 | * 0xFF, though UTF-EBCDIC did. This allowed both versions to represent code |
| 778 | * points up to 2 ** 31 - 1. Perl extends UTF-8 so that 0xFE and 0xFF are |
| 779 | * usable on ASCII platforms, and 0xFF means something different than |
| 780 | * UTF-EBCDIC defines. These changes allow code points of 64 bits (actually |
| 781 | * somewhat more) to be represented on both platforms. But these are Perl |
| 782 | * extensions, and not likely to be interchangeable with other languages. Note |
| 783 | * that on ASCII platforms, FE overflows a signed 32-bit word, and FF an |
| 784 | * unsigned one. */ |
| 785 | #define UTF8_DISALLOW_PERL_EXTENDED 0x4000 |
| 786 | #define UTF8_GOT_PERL_EXTENDED UTF8_DISALLOW_PERL_EXTENDED |
| 787 | #define UTF8_WARN_PERL_EXTENDED 0x8000 |
| 788 | |
| 789 | /* For back compat, these old names are misleading for overlongs and |
| 790 | * UTF_EBCDIC. */ |
| 791 | #define UTF8_DISALLOW_ABOVE_31_BIT UTF8_DISALLOW_PERL_EXTENDED |
| 792 | #define UTF8_GOT_ABOVE_31_BIT UTF8_GOT_PERL_EXTENDED |
| 793 | #define UTF8_WARN_ABOVE_31_BIT UTF8_WARN_PERL_EXTENDED |
| 794 | #define UTF8_DISALLOW_FE_FF UTF8_DISALLOW_PERL_EXTENDED |
| 795 | #define UTF8_WARN_FE_FF UTF8_WARN_PERL_EXTENDED |
| 796 | |
| 797 | #define UTF8_CHECK_ONLY 0x10000 |
| 798 | #define _UTF8_NO_CONFIDENCE_IN_CURLEN 0x20000 /* Internal core use only */ |
| 799 | |
| 800 | /* For backwards source compatibility. They do nothing, as the default now |
| 801 | * includes what they used to mean. The first one's meaning was to allow the |
| 802 | * just the single non-character 0xFFFF */ |
| 803 | #define UTF8_ALLOW_FFFF 0 |
| 804 | #define UTF8_ALLOW_FE_FF 0 |
| 805 | #define UTF8_ALLOW_SURROGATE 0 |
| 806 | |
| 807 | /* C9 refers to Unicode Corrigendum #9: allows but discourages non-chars */ |
| 808 | #define UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE \ |
| 809 | (UTF8_DISALLOW_SUPER|UTF8_DISALLOW_SURROGATE) |
| 810 | #define UTF8_WARN_ILLEGAL_C9_INTERCHANGE (UTF8_WARN_SUPER|UTF8_WARN_SURROGATE) |
| 811 | |
| 812 | #define UTF8_DISALLOW_ILLEGAL_INTERCHANGE \ |
| 813 | (UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE|UTF8_DISALLOW_NONCHAR) |
| 814 | #define UTF8_WARN_ILLEGAL_INTERCHANGE \ |
| 815 | (UTF8_WARN_ILLEGAL_C9_INTERCHANGE|UTF8_WARN_NONCHAR) |
| 816 | |
| 817 | /* This is typically used for code that processes UTF-8 input and doesn't want |
| 818 | * to have to deal with any malformations that might be present. All such will |
| 819 | * be safely replaced by the REPLACEMENT CHARACTER, unless other flags |
| 820 | * overriding this are also present. */ |
| 821 | #define UTF8_ALLOW_ANY ( UTF8_ALLOW_CONTINUATION \ |
| 822 | |UTF8_ALLOW_NON_CONTINUATION \ |
| 823 | |UTF8_ALLOW_SHORT \ |
| 824 | |UTF8_ALLOW_LONG \ |
| 825 | |UTF8_ALLOW_OVERFLOW) |
| 826 | |
| 827 | /* Accept any Perl-extended UTF-8 that evaluates to any UV on the platform, but |
| 828 | * not any malformed. This is the default. */ |
| 829 | #define UTF8_ALLOW_ANYUV 0 |
| 830 | #define UTF8_ALLOW_DEFAULT UTF8_ALLOW_ANYUV |
| 831 | |
| 832 | /* |
| 833 | =for apidoc Am|bool|UTF8_IS_SURROGATE|const U8 *s|const U8 *e |
| 834 | |
| 835 | Evaluates to non-zero if the first few bytes of the string starting at C<s> and |
| 836 | looking no further than S<C<e - 1>> are well-formed UTF-8 that represents one |
| 837 | of the Unicode surrogate code points; otherwise it evaluates to 0. If |
| 838 | non-zero, the value gives how many bytes starting at C<s> comprise the code |
| 839 | point's representation. |
| 840 | |
| 841 | =cut |
| 842 | */ |
| 843 | #define UTF8_IS_SURROGATE(s, e) is_SURROGATE_utf8_safe(s, e) |
| 844 | |
| 845 | |
| 846 | #define UTF8_IS_REPLACEMENT(s, send) is_REPLACEMENT_utf8_safe(s,send) |
| 847 | |
| 848 | #define MAX_LEGAL_CP ((UV)IV_MAX) |
| 849 | |
| 850 | /* |
| 851 | =for apidoc Am|bool|UTF8_IS_SUPER|const U8 *s|const U8 *e |
| 852 | |
| 853 | Recall that Perl recognizes an extension to UTF-8 that can encode code |
| 854 | points larger than the ones defined by Unicode, which are 0..0x10FFFF. |
| 855 | |
| 856 | This macro evaluates to non-zero if the first few bytes of the string starting |
| 857 | at C<s> and looking no further than S<C<e - 1>> are from this UTF-8 extension; |
| 858 | otherwise it evaluates to 0. If non-zero, the value gives how many bytes |
| 859 | starting at C<s> comprise the code point's representation. |
| 860 | |
| 861 | 0 is returned if the bytes are not well-formed extended UTF-8, or if they |
| 862 | represent a code point that cannot fit in a UV on the current platform. Hence |
| 863 | this macro can give different results when run on a 64-bit word machine than on |
| 864 | one with a 32-bit word size. |
| 865 | |
| 866 | Note that it is illegal to have code points that are larger than what can |
| 867 | fit in an IV on the current machine. |
| 868 | |
| 869 | =cut |
| 870 | |
| 871 | * ASCII EBCDIC I8 |
| 872 | * U+10FFFF: \xF4\x8F\xBF\xBF \xF9\xA1\xBF\xBF\xBF max legal Unicode |
| 873 | * U+110000: \xF4\x90\x80\x80 \xF9\xA2\xA0\xA0\xA0 |
| 874 | * U+110001: \xF4\x90\x80\x81 \xF9\xA2\xA0\xA0\xA1 |
| 875 | */ |
| 876 | #ifdef EBCDIC |
| 877 | # define UTF8_IS_SUPER(s, e) \ |
| 878 | (( LIKELY((e) > (s) + 4) \ |
| 879 | && NATIVE_UTF8_TO_I8(*(s)) >= 0xF9 \ |
| 880 | && ( NATIVE_UTF8_TO_I8(*(s)) > 0xF9 \ |
| 881 | || (NATIVE_UTF8_TO_I8(*((s) + 1)) >= 0xA2)) \ |
| 882 | && LIKELY((s) + UTF8SKIP(s) <= (e))) \ |
| 883 | ? is_utf8_char_helper(s, s + UTF8SKIP(s), 0) : 0) |
| 884 | #else |
| 885 | # define UTF8_IS_SUPER(s, e) \ |
| 886 | (( LIKELY((e) > (s) + 3) \ |
| 887 | && (*(U8*) (s)) >= 0xF4 \ |
| 888 | && ((*(U8*) (s)) > 0xF4 || (*((U8*) (s) + 1) >= 0x90))\ |
| 889 | && LIKELY((s) + UTF8SKIP(s) <= (e))) \ |
| 890 | ? is_utf8_char_helper(s, s + UTF8SKIP(s), 0) : 0) |
| 891 | #endif |
| 892 | |
| 893 | /* These are now machine generated, and the 'given' clause is no longer |
| 894 | * applicable */ |
| 895 | #define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e) \ |
| 896 | cBOOL(is_NONCHAR_utf8_safe(s,e)) |
| 897 | |
| 898 | /* |
| 899 | =for apidoc Am|bool|UTF8_IS_NONCHAR|const U8 *s|const U8 *e |
| 900 | |
| 901 | Evaluates to non-zero if the first few bytes of the string starting at C<s> and |
| 902 | looking no further than S<C<e - 1>> are well-formed UTF-8 that represents one |
| 903 | of the Unicode non-character code points; otherwise it evaluates to 0. If |
| 904 | non-zero, the value gives how many bytes starting at C<s> comprise the code |
| 905 | point's representation. |
| 906 | |
| 907 | =for apidoc AmnU|UV|UNICODE_REPLACEMENT |
| 908 | |
| 909 | Evaluates to 0xFFFD, the code point of the Unicode REPLACEMENT CHARACTER |
| 910 | |
| 911 | =cut |
| 912 | */ |
| 913 | #define UTF8_IS_NONCHAR(s, e) \ |
| 914 | UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e) |
| 915 | |
| 916 | #define UNICODE_SURROGATE_FIRST 0xD800 |
| 917 | #define UNICODE_SURROGATE_LAST 0xDFFF |
| 918 | #define UNICODE_REPLACEMENT 0xFFFD |
| 919 | #define UNICODE_BYTE_ORDER_MARK 0xFEFF |
| 920 | |
| 921 | /* Though our UTF-8 encoding can go beyond this, |
| 922 | * let's be conservative and do as Unicode says. */ |
| 923 | #define PERL_UNICODE_MAX 0x10FFFF |
| 924 | |
| 925 | #define UNICODE_WARN_SURROGATE 0x0001 /* UTF-16 surrogates */ |
| 926 | #define UNICODE_WARN_NONCHAR 0x0002 /* Non-char code points */ |
| 927 | #define UNICODE_WARN_SUPER 0x0004 /* Above 0x10FFFF */ |
| 928 | #define UNICODE_WARN_PERL_EXTENDED 0x0008 /* Above 0x7FFF_FFFF */ |
| 929 | #define UNICODE_WARN_ABOVE_31_BIT UNICODE_WARN_PERL_EXTENDED |
| 930 | #define UNICODE_DISALLOW_SURROGATE 0x0010 |
| 931 | #define UNICODE_DISALLOW_NONCHAR 0x0020 |
| 932 | #define UNICODE_DISALLOW_SUPER 0x0040 |
| 933 | #define UNICODE_DISALLOW_PERL_EXTENDED 0x0080 |
| 934 | |
| 935 | #ifdef PERL_CORE |
| 936 | # define UNICODE_ALLOW_ABOVE_IV_MAX 0x0100 |
| 937 | #endif |
| 938 | #define UNICODE_DISALLOW_ABOVE_31_BIT UNICODE_DISALLOW_PERL_EXTENDED |
| 939 | |
| 940 | #define UNICODE_GOT_SURROGATE UNICODE_DISALLOW_SURROGATE |
| 941 | #define UNICODE_GOT_NONCHAR UNICODE_DISALLOW_NONCHAR |
| 942 | #define UNICODE_GOT_SUPER UNICODE_DISALLOW_SUPER |
| 943 | #define UNICODE_GOT_PERL_EXTENDED UNICODE_DISALLOW_PERL_EXTENDED |
| 944 | |
| 945 | #define UNICODE_WARN_ILLEGAL_C9_INTERCHANGE \ |
| 946 | (UNICODE_WARN_SURROGATE|UNICODE_WARN_SUPER) |
| 947 | #define UNICODE_WARN_ILLEGAL_INTERCHANGE \ |
| 948 | (UNICODE_WARN_ILLEGAL_C9_INTERCHANGE|UNICODE_WARN_NONCHAR) |
| 949 | #define UNICODE_DISALLOW_ILLEGAL_C9_INTERCHANGE \ |
| 950 | (UNICODE_DISALLOW_SURROGATE|UNICODE_DISALLOW_SUPER) |
| 951 | #define UNICODE_DISALLOW_ILLEGAL_INTERCHANGE \ |
| 952 | (UNICODE_DISALLOW_ILLEGAL_C9_INTERCHANGE|UNICODE_DISALLOW_NONCHAR) |
| 953 | |
| 954 | /* For backward source compatibility, as are now the default */ |
| 955 | #define UNICODE_ALLOW_SURROGATE 0 |
| 956 | #define UNICODE_ALLOW_SUPER 0 |
| 957 | #define UNICODE_ALLOW_ANY 0 |
| 958 | |
| 959 | /* This matches the 2048 code points between UNICODE_SURROGATE_FIRST (0xD800) and |
| 960 | * UNICODE_SURROGATE_LAST (0xDFFF) */ |
| 961 | #define UNICODE_IS_SURROGATE(uv) (((UV) (uv) & (~0xFFFF | 0xF800)) \ |
| 962 | == 0xD800) |
| 963 | |
| 964 | #define UNICODE_IS_REPLACEMENT(uv) ((UV) (uv) == UNICODE_REPLACEMENT) |
| 965 | #define UNICODE_IS_BYTE_ORDER_MARK(uv) ((UV) (uv) == UNICODE_BYTE_ORDER_MARK) |
| 966 | |
| 967 | /* Is 'uv' one of the 32 contiguous-range noncharacters? */ |
| 968 | #define UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv) ((UV) (uv) >= 0xFDD0 \ |
| 969 | && (UV) (uv) <= 0xFDEF) |
| 970 | |
| 971 | /* Is 'uv' one of the 34 plane-ending noncharacters 0xFFFE, 0xFFFF, 0x1FFFE, |
| 972 | * 0x1FFFF, ... 0x10FFFE, 0x10FFFF, given that we know that 'uv' is not above |
| 973 | * the Unicode legal max */ |
| 974 | #define UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv) \ |
| 975 | (((UV) (uv) & 0xFFFE) == 0xFFFE) |
| 976 | |
| 977 | #define UNICODE_IS_NONCHAR(uv) \ |
| 978 | ( UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv) \ |
| 979 | || ( LIKELY( ! UNICODE_IS_SUPER(uv)) \ |
| 980 | && UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv))) |
| 981 | |
| 982 | #define UNICODE_IS_SUPER(uv) ((UV) (uv) > PERL_UNICODE_MAX) |
| 983 | |
| 984 | #define LATIN_SMALL_LETTER_SHARP_S LATIN_SMALL_LETTER_SHARP_S_NATIVE |
| 985 | #define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS \ |
| 986 | LATIN_SMALL_LETTER_Y_WITH_DIAERESIS_NATIVE |
| 987 | #define MICRO_SIGN MICRO_SIGN_NATIVE |
| 988 | #define LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE \ |
| 989 | LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE_NATIVE |
| 990 | #define LATIN_SMALL_LETTER_A_WITH_RING_ABOVE \ |
| 991 | LATIN_SMALL_LETTER_A_WITH_RING_ABOVE_NATIVE |
| 992 | #define UNICODE_GREEK_CAPITAL_LETTER_SIGMA 0x03A3 |
| 993 | #define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA 0x03C2 |
| 994 | #define UNICODE_GREEK_SMALL_LETTER_SIGMA 0x03C3 |
| 995 | #define GREEK_SMALL_LETTER_MU 0x03BC |
| 996 | #define GREEK_CAPITAL_LETTER_MU 0x039C /* Upper and title case |
| 997 | of MICRON */ |
| 998 | #define LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS 0x0178 /* Also is title case */ |
| 999 | #ifdef LATIN_CAPITAL_LETTER_SHARP_S_UTF8 |
| 1000 | # define LATIN_CAPITAL_LETTER_SHARP_S 0x1E9E |
| 1001 | #endif |
| 1002 | #define LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE 0x130 |
| 1003 | #define LATIN_SMALL_LETTER_DOTLESS_I 0x131 |
| 1004 | #define LATIN_SMALL_LETTER_LONG_S 0x017F |
| 1005 | #define LATIN_SMALL_LIGATURE_LONG_S_T 0xFB05 |
| 1006 | #define LATIN_SMALL_LIGATURE_ST 0xFB06 |
| 1007 | #define KELVIN_SIGN 0x212A |
| 1008 | #define ANGSTROM_SIGN 0x212B |
| 1009 | |
| 1010 | #define UNI_DISPLAY_ISPRINT 0x0001 |
| 1011 | #define UNI_DISPLAY_BACKSLASH 0x0002 |
| 1012 | #define UNI_DISPLAY_BACKSPACE 0x0004 /* Allow \b when also |
| 1013 | UNI_DISPLAY_BACKSLASH */ |
| 1014 | #define UNI_DISPLAY_QQ (UNI_DISPLAY_ISPRINT \ |
| 1015 | |UNI_DISPLAY_BACKSLASH \ |
| 1016 | |UNI_DISPLAY_BACKSPACE) |
| 1017 | |
| 1018 | /* Character classes could also allow \b, but not patterns in general */ |
| 1019 | #define UNI_DISPLAY_REGEX (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH) |
| 1020 | |
| 1021 | #define ANYOF_FOLD_SHARP_S(node, input, end) \ |
| 1022 | (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \ |
| 1023 | (ANYOF_NONBITMAP(node)) && \ |
| 1024 | (ANYOF_FLAGS(node) & ANYOF_LOC_NONBITMAP_FOLD) && \ |
| 1025 | ((end) > (input) + 1) && \ |
| 1026 | isALPHA_FOLD_EQ((input)[0], 's')) |
| 1027 | |
| 1028 | #define SHARP_S_SKIP 2 |
| 1029 | |
| 1030 | #define is_utf8_char_buf(buf, buf_end) isUTF8_CHAR(buf, buf_end) |
| 1031 | #define bytes_from_utf8(s, lenp, is_utf8p) \ |
| 1032 | bytes_from_utf8_loc(s, lenp, is_utf8p, 0) |
| 1033 | |
| 1034 | /* |
| 1035 | |
| 1036 | =for apidoc Am|STRLEN|isUTF8_CHAR_flags|const U8 *s|const U8 *e| const U32 flags |
| 1037 | |
| 1038 | Evaluates to non-zero if the first few bytes of the string starting at C<s> and |
| 1039 | looking no further than S<C<e - 1>> are well-formed UTF-8, as extended by Perl, |
| 1040 | that represents some code point, subject to the restrictions given by C<flags>; |
| 1041 | otherwise it evaluates to 0. If non-zero, the value gives how many bytes |
| 1042 | starting at C<s> comprise the code point's representation. Any bytes remaining |
| 1043 | before C<e>, but beyond the ones needed to form the first code point in C<s>, |
| 1044 | are not examined. |
| 1045 | |
| 1046 | If C<flags> is 0, this gives the same results as C<L</isUTF8_CHAR>>; |
| 1047 | if C<flags> is C<UTF8_DISALLOW_ILLEGAL_INTERCHANGE>, this gives the same results |
| 1048 | as C<L</isSTRICT_UTF8_CHAR>>; |
| 1049 | and if C<flags> is C<UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE>, this gives |
| 1050 | the same results as C<L</isC9_STRICT_UTF8_CHAR>>. |
| 1051 | Otherwise C<flags> may be any combination of the C<UTF8_DISALLOW_I<foo>> flags |
| 1052 | understood by C<L</utf8n_to_uvchr>>, with the same meanings. |
| 1053 | |
| 1054 | The three alternative macros are for the most commonly needed validations; they |
| 1055 | are likely to run somewhat faster than this more general one, as they can be |
| 1056 | inlined into your code. |
| 1057 | |
| 1058 | Use L</is_utf8_string_flags>, L</is_utf8_string_loc_flags>, and |
| 1059 | L</is_utf8_string_loclen_flags> to check entire strings. |
| 1060 | |
| 1061 | =cut |
| 1062 | */ |
| 1063 | |
| 1064 | #define isUTF8_CHAR_flags(s, e, flags) \ |
| 1065 | (UNLIKELY((e) <= (s)) \ |
| 1066 | ? 0 \ |
| 1067 | : (UTF8_IS_INVARIANT(*s)) \ |
| 1068 | ? 1 \ |
| 1069 | : UNLIKELY(((e) - (s)) < UTF8SKIP(s)) \ |
| 1070 | ? 0 \ |
| 1071 | : is_utf8_char_helper(s, e, flags)) |
| 1072 | |
| 1073 | /* Do not use; should be deprecated. Use isUTF8_CHAR() instead; this is |
| 1074 | * retained solely for backwards compatibility */ |
| 1075 | #define IS_UTF8_CHAR(p, n) (isUTF8_CHAR(p, (p) + (n)) == n) |
| 1076 | |
| 1077 | #endif /* PERL_UTF8_H_ */ |
| 1078 | |
| 1079 | /* |
| 1080 | * ex: set ts=8 sts=4 sw=4 et: |
| 1081 | */ |