| 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 H_UTF8 /* Guard against recursive inclusion */ |
| 18 | #define H_UTF8 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 | /* For _core_swash_init(), internal core use only */ |
| 38 | #define _CORE_SWASH_INIT_USER_DEFINED_PROPERTY 0x1 |
| 39 | #define _CORE_SWASH_INIT_RETURN_IF_UNDEF 0x2 |
| 40 | #define _CORE_SWASH_INIT_ACCEPT_INVLIST 0x4 |
| 41 | |
| 42 | /* |
| 43 | =head1 Unicode Support |
| 44 | L<perlguts/Unicode Support> has an introduction to this API. |
| 45 | |
| 46 | See also L</Character classification>, |
| 47 | and L</Character case changing>. |
| 48 | Various functions outside this section also work specially with Unicode. |
| 49 | Search for the string "utf8" in this document. |
| 50 | |
| 51 | =for apidoc is_ascii_string |
| 52 | |
| 53 | This is a misleadingly-named synonym for L</is_invariant_string>. |
| 54 | On ASCII-ish platforms, the name isn't misleading: the ASCII-range characters |
| 55 | are exactly the UTF-8 invariants. But EBCDIC machines have more invariants |
| 56 | than just the ASCII characters, so C<is_invariant_string> is preferred. |
| 57 | |
| 58 | =cut |
| 59 | */ |
| 60 | #define is_ascii_string(s, len) is_invariant_string(s, len) |
| 61 | |
| 62 | #define uvchr_to_utf8(a,b) uvchr_to_utf8_flags(a,b,0) |
| 63 | #define uvchr_to_utf8_flags(d,uv,flags) \ |
| 64 | uvoffuni_to_utf8_flags(d,NATIVE_TO_UNI(uv),flags) |
| 65 | #define utf8_to_uvchr_buf(s, e, lenp) \ |
| 66 | utf8n_to_uvchr(s, (U8*)(e) - (U8*)(s), lenp, \ |
| 67 | ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY) |
| 68 | |
| 69 | #define to_uni_fold(c, p, lenp) _to_uni_fold_flags(c, p, lenp, FOLD_FLAGS_FULL) |
| 70 | #define to_utf8_fold(c, p, lenp) _to_utf8_fold_flags(c, p, lenp, FOLD_FLAGS_FULL) |
| 71 | #define to_utf8_lower(a,b,c) _to_utf8_lower_flags(a,b,c,0) |
| 72 | #define to_utf8_upper(a,b,c) _to_utf8_upper_flags(a,b,c,0) |
| 73 | #define to_utf8_title(a,b,c) _to_utf8_title_flags(a,b,c,0) |
| 74 | |
| 75 | /* Source backward compatibility. */ |
| 76 | #define is_utf8_string_loc(s, len, ep) is_utf8_string_loclen(s, len, ep, 0) |
| 77 | |
| 78 | #define foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \ |
| 79 | foldEQ_utf8_flags(s1, pe1, l1, u1, s2, pe2, l2, u2, 0) |
| 80 | #define FOLDEQ_UTF8_NOMIX_ASCII (1 << 0) |
| 81 | #define FOLDEQ_LOCALE (1 << 1) |
| 82 | #define FOLDEQ_S1_ALREADY_FOLDED (1 << 2) |
| 83 | #define FOLDEQ_S2_ALREADY_FOLDED (1 << 3) |
| 84 | #define FOLDEQ_S1_FOLDS_SANE (1 << 4) |
| 85 | #define FOLDEQ_S2_FOLDS_SANE (1 << 5) |
| 86 | |
| 87 | #define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \ |
| 88 | cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2)) |
| 89 | |
| 90 | #ifdef EBCDIC |
| 91 | /* The equivalent of these macros but implementing UTF-EBCDIC |
| 92 | are in the following header file: |
| 93 | */ |
| 94 | |
| 95 | #include "utfebcdic.h" |
| 96 | |
| 97 | #else /* ! EBCDIC */ |
| 98 | START_EXTERN_C |
| 99 | |
| 100 | /* How wide can a single UTF-8 encoded character become in bytes. */ |
| 101 | /* NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8 since UTF-8 |
| 102 | * is an encoding of Unicode, and Unicode's upper limit, 0x10FFFF, can be |
| 103 | * expressed with 4 bytes. However, Perl thinks of UTF-8 as a way to encode |
| 104 | * non-negative integers in a binary format, even those above Unicode */ |
| 105 | #define UTF8_MAXBYTES 13 |
| 106 | |
| 107 | #ifdef DOINIT |
| 108 | EXTCONST unsigned char PL_utf8skip[] = { |
| 109 | /* 0x00 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 110 | /* 0x10 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 111 | /* 0x20 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 112 | /* 0x30 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 113 | /* 0x40 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 114 | /* 0x50 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 115 | /* 0x60 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 116 | /* 0x70 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */ |
| 117 | /* 0x80 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */ |
| 118 | /* 0x90 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */ |
| 119 | /* 0xA0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */ |
| 120 | /* 0xB0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */ |
| 121 | /* 0xC0 */ 2,2, /* overlong */ |
| 122 | /* 0xC2 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0080 to U+03FF */ |
| 123 | /* 0xD0 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0400 to U+07FF */ |
| 124 | /* 0xE0 */ 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3, /* U+0800 to U+FFFF */ |
| 125 | /* 0xF0 */ 4,4,4,4,4,4,4,4,5,5,5,5,6,6, /* above BMP to 2**31 - 1 */ |
| 126 | /* Perl extended (never was official UTF-8). Up to 36 bit */ |
| 127 | /* 0xFE */ 7, |
| 128 | /* More extended, Up to 72 bits (64-bit + reserved) */ |
| 129 | /* 0xFF */ UTF8_MAXBYTES |
| 130 | }; |
| 131 | #else |
| 132 | EXTCONST unsigned char PL_utf8skip[]; |
| 133 | #endif |
| 134 | |
| 135 | END_EXTERN_C |
| 136 | |
| 137 | #if defined(_MSC_VER) && _MSC_VER < 1400 |
| 138 | /* older MSVC versions have a smallish macro buffer */ |
| 139 | #define PERL_SMALL_MACRO_BUFFER |
| 140 | #endif |
| 141 | |
| 142 | /* Native character to/from iso-8859-1. Are the identity functions on ASCII |
| 143 | * platforms */ |
| 144 | #ifdef PERL_SMALL_MACRO_BUFFER |
| 145 | #define NATIVE_TO_LATIN1(ch) ((U8)(ch)) |
| 146 | #define LATIN1_TO_NATIVE(ch) ((U8)(ch)) |
| 147 | #else |
| 148 | #define NATIVE_TO_LATIN1(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch))) |
| 149 | #define LATIN1_TO_NATIVE(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch))) |
| 150 | #endif |
| 151 | |
| 152 | /* I8 is an intermediate version of UTF-8 used only in UTF-EBCDIC. We thus |
| 153 | * consider it to be identical to UTF-8 on ASCII platforms. Strictly speaking |
| 154 | * UTF-8 and UTF-EBCDIC are two different things, but we often conflate them |
| 155 | * because they are 8-bit encodings that serve the same purpose in Perl, and |
| 156 | * rarely do we need to distinguish them. The term "NATIVE_UTF8" applies to |
| 157 | * whichever one is applicable on the current platform */ |
| 158 | #ifdef PERL_SMALL_MACRO_BUFFER |
| 159 | #define NATIVE_UTF8_TO_I8(ch) (ch) |
| 160 | #define I8_TO_NATIVE_UTF8(ch) (ch) |
| 161 | #else |
| 162 | #define NATIVE_UTF8_TO_I8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch))) |
| 163 | #define I8_TO_NATIVE_UTF8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch))) |
| 164 | #endif |
| 165 | |
| 166 | /* Transforms in wide UV chars */ |
| 167 | #define UNI_TO_NATIVE(ch) ((UV) (ch)) |
| 168 | #define NATIVE_TO_UNI(ch) ((UV) (ch)) |
| 169 | |
| 170 | /* |
| 171 | |
| 172 | The following table is from Unicode 3.2. |
| 173 | |
| 174 | Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte |
| 175 | |
| 176 | U+0000..U+007F 00..7F |
| 177 | U+0080..U+07FF * C2..DF 80..BF |
| 178 | U+0800..U+0FFF E0 * A0..BF 80..BF |
| 179 | U+1000..U+CFFF E1..EC 80..BF 80..BF |
| 180 | U+D000..U+D7FF ED 80..9F 80..BF |
| 181 | U+D800..U+DFFF ED A0..BF 80..BF (surrogates) |
| 182 | U+E000..U+FFFF EE..EF 80..BF 80..BF |
| 183 | U+10000..U+3FFFF F0 * 90..BF 80..BF 80..BF |
| 184 | U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF |
| 185 | U+100000..U+10FFFF F4 80..8F 80..BF 80..BF |
| 186 | Below are non-Unicode code points |
| 187 | U+110000..U+13FFFF F4 90..BF 80..BF 80..BF |
| 188 | U+110000..U+1FFFFF F5..F7 80..BF 80..BF 80..BF |
| 189 | U+200000..: F8.. * 88..BF 80..BF 80..BF 80..BF |
| 190 | |
| 191 | Note the gaps before several of the byte entries above marked by '*'. These are |
| 192 | caused by legal UTF-8 avoiding non-shortest encodings: it is technically |
| 193 | possible to UTF-8-encode a single code point in different ways, but that is |
| 194 | explicitly forbidden, and the shortest possible encoding should always be used |
| 195 | (and that is what Perl does). The non-shortest ones are called 'overlongs'. |
| 196 | |
| 197 | */ |
| 198 | |
| 199 | /* |
| 200 | Another way to look at it, as bits: |
| 201 | |
| 202 | Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte |
| 203 | |
| 204 | 0aaa aaaa 0aaa aaaa |
| 205 | 0000 0bbb bbaa aaaa 110b bbbb 10aa aaaa |
| 206 | cccc bbbb bbaa aaaa 1110 cccc 10bb bbbb 10aa aaaa |
| 207 | 00 000d ddcc cccc bbbb bbaa aaaa 1111 0ddd 10cc cccc 10bb bbbb 10aa aaaa |
| 208 | |
| 209 | As you can see, the continuation bytes all begin with C<10>, and the |
| 210 | leading bits of the start byte tell how many bytes there are in the |
| 211 | encoded character. |
| 212 | |
| 213 | Perl's extended UTF-8 means we can have start bytes up to FF. |
| 214 | |
| 215 | */ |
| 216 | |
| 217 | /* Is the representation of the Unicode code point 'cp' the same regardless of |
| 218 | * being encoded in UTF-8 or not? */ |
| 219 | #define OFFUNI_IS_INVARIANT(cp) isASCII(cp) |
| 220 | |
| 221 | /* Is the representation of the code point 'cp' the same regardless of |
| 222 | * being encoded in UTF-8 or not? 'cp' is native if < 256; Unicode otherwise |
| 223 | * */ |
| 224 | #define UVCHR_IS_INVARIANT(cp) OFFUNI_IS_INVARIANT(cp) |
| 225 | |
| 226 | /* This defines the bits that are to be in the continuation bytes of a multi-byte |
| 227 | * UTF-8 encoded character that mark it is a continuation byte. */ |
| 228 | #define UTF_CONTINUATION_MARK 0x80 |
| 229 | |
| 230 | /* Misleadingly named: is the UTF8-encoded byte 'c' part of a variant sequence |
| 231 | * in UTF-8? This is the inverse of UTF8_IS_INVARIANT */ |
| 232 | #define UTF8_IS_CONTINUED(c) (((U8)c) & UTF_CONTINUATION_MARK) |
| 233 | |
| 234 | /* Is the byte 'c' the first byte of a multi-byte UTF8-8 encoded sequence? |
| 235 | * This doesn't catch invariants (they are single-byte). It also excludes the |
| 236 | * illegal overlong sequences that begin with C0 and C1. */ |
| 237 | #define UTF8_IS_START(c) (((U8)c) >= 0xc2) |
| 238 | |
| 239 | /* For use in UTF8_IS_CONTINUATION() below */ |
| 240 | #define UTF_IS_CONTINUATION_MASK 0xC0 |
| 241 | |
| 242 | /* Is the byte 'c' part of a multi-byte UTF8-8 encoded sequence, and not the |
| 243 | * first byte thereof? */ |
| 244 | #define UTF8_IS_CONTINUATION(c) \ |
| 245 | ((((U8)c) & UTF_IS_CONTINUATION_MASK) == UTF_CONTINUATION_MARK) |
| 246 | |
| 247 | /* Is the UTF8-encoded byte 'c' the first byte of a two byte sequence? Use |
| 248 | * UTF8_IS_NEXT_CHAR_DOWNGRADEABLE() instead if the input isn't known to |
| 249 | * be well-formed. Masking with 0xfe allows the low bit to be 0 or 1; thus |
| 250 | * this matches 0xc[23]. */ |
| 251 | #define UTF8_IS_DOWNGRADEABLE_START(c) (((U8)(c) & 0xfe) == 0xc2) |
| 252 | |
| 253 | /* Is the UTF8-encoded byte 'c' the first byte of a sequence of bytes that |
| 254 | * represent a code point > 255? */ |
| 255 | #define UTF8_IS_ABOVE_LATIN1(c) ((U8)(c) >= 0xc4) |
| 256 | |
| 257 | /* This is the number of low-order bits a continuation byte in a UTF-8 encoded |
| 258 | * sequence contributes to the specification of the code point. In the bit |
| 259 | * maps above, you see that the first 2 bits are a constant '10', leaving 6 of |
| 260 | * real information */ |
| 261 | #define UTF_ACCUMULATION_SHIFT 6 |
| 262 | |
| 263 | /* ^? is defined to be DEL on ASCII systems. See the definition of toCTRL() |
| 264 | * for more */ |
| 265 | #define QUESTION_MARK_CTRL DEL_NATIVE |
| 266 | |
| 267 | /* Surrogates, non-character code points and above-Unicode code points are |
| 268 | * problematic in some contexts. This allows code that needs to check for |
| 269 | * those to to quickly exclude the vast majority of code points it will |
| 270 | * encounter */ |
| 271 | #define isUTF8_POSSIBLY_PROBLEMATIC(c) ((U8) c >= 0xED) |
| 272 | |
| 273 | #endif /* EBCDIC vs ASCII */ |
| 274 | |
| 275 | /* 2**UTF_ACCUMULATION_SHIFT - 1 */ |
| 276 | #define UTF_CONTINUATION_MASK ((U8) ((1U << UTF_ACCUMULATION_SHIFT) - 1)) |
| 277 | |
| 278 | /* Internal macro to be used only in this file to aid in constructing other |
| 279 | * publicly accessible macros. |
| 280 | * The number of bytes required to express this uv in UTF-8, for just those |
| 281 | * uv's requiring 2 through 6 bytes, as these are common to all platforms and |
| 282 | * word sizes. The number of bytes needed is given by the number of leading 1 |
| 283 | * bits in the start byte. There are 32 start bytes that have 2 initial 1 bits |
| 284 | * (C0-DF); there are 16 that have 3 initial 1 bits (E0-EF); 8 that have 4 |
| 285 | * initial 1 bits (F0-F8); 4 that have 5 initial 1 bits (F9-FB), and 2 that |
| 286 | * have 6 initial 1 bits (FC-FD). The largest number a string of n bytes can |
| 287 | * represent is (the number of possible start bytes for 'n') |
| 288 | * * (the number of possiblities for each start byte |
| 289 | * The latter in turn is |
| 290 | * 2 ** ( (how many continuation bytes there are) |
| 291 | * * (the number of bits of information each |
| 292 | * continuation byte holds)) |
| 293 | * |
| 294 | * If we were on a platform where we could use a fast find first set bit |
| 295 | * instruction (or count leading zeros instruction) this could be replaced by |
| 296 | * using that to find the log2 of the uv, and divide that by the number of bits |
| 297 | * of information in each continuation byte, adjusting for large cases and how |
| 298 | * much information is in a start byte for that length */ |
| 299 | #define __COMMON_UNI_SKIP(uv) \ |
| 300 | (UV) (uv) < (32 * (1U << ( UTF_ACCUMULATION_SHIFT))) ? 2 : \ |
| 301 | (UV) (uv) < (16 * (1U << (2 * UTF_ACCUMULATION_SHIFT))) ? 3 : \ |
| 302 | (UV) (uv) < ( 8 * (1U << (3 * UTF_ACCUMULATION_SHIFT))) ? 4 : \ |
| 303 | (UV) (uv) < ( 4 * (1U << (4 * UTF_ACCUMULATION_SHIFT))) ? 5 : \ |
| 304 | (UV) (uv) < ( 2 * (1U << (5 * UTF_ACCUMULATION_SHIFT))) ? 6 : |
| 305 | |
| 306 | /* Internal macro to be used only in this file. |
| 307 | * This adds to __COMMON_UNI_SKIP the details at this platform's upper range. |
| 308 | * For any-sized EBCDIC platforms, or 64-bit ASCII ones, we need one more test |
| 309 | * to see if just 7 bytes is needed, or if the maximum is needed. For 32-bit |
| 310 | * ASCII platforms, everything is representable by 7 bytes */ |
| 311 | #if defined(UV_IS_QUAD) || defined(EBCDIC) |
| 312 | # define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) \ |
| 313 | (UV) (uv) < ((UV) 1U << (6 * UTF_ACCUMULATION_SHIFT)) ? 7 : UTF8_MAXBYTES) |
| 314 | #else |
| 315 | # define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) 7) |
| 316 | #endif |
| 317 | |
| 318 | /* The next two macros use the base macro defined above, and add in the tests |
| 319 | * at the low-end of the range, for just 1 byte, yielding complete macros, |
| 320 | * publicly accessible. */ |
| 321 | |
| 322 | /* Input is a true Unicode (not-native) code point */ |
| 323 | #define OFFUNISKIP(uv) (OFFUNI_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv)) |
| 324 | |
| 325 | /* |
| 326 | |
| 327 | =for apidoc Am|STRLEN|UVCHR_SKIP|UV cp |
| 328 | returns the number of bytes required to represent the code point C<cp> when |
| 329 | encoded as UTF-8. C<cp> is a native (ASCII or EBCDIC) code point if less than |
| 330 | 255; a Unicode code point otherwise. |
| 331 | |
| 332 | =cut |
| 333 | */ |
| 334 | #define UVCHR_SKIP(uv) ( UVCHR_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv)) |
| 335 | |
| 336 | /* As explained in the comments for __COMMON_UNI_SKIP, 32 start bytes with |
| 337 | * UTF_ACCUMULATION_SHIFT bits of information each */ |
| 338 | #define MAX_UTF8_TWO_BYTE (32 * (1U << UTF_ACCUMULATION_SHIFT) - 1) |
| 339 | |
| 340 | /* constrained by EBCDIC which has 5 bits per continuation byte */ |
| 341 | #define MAX_PORTABLE_UTF8_TWO_BYTE (32 * (1U << 5) - 1) |
| 342 | |
| 343 | /* The maximum number of UTF-8 bytes a single Unicode character can |
| 344 | * uppercase/lowercase/fold into. Unicode guarantees that the maximum |
| 345 | * expansion is UTF8_MAX_FOLD_CHAR_EXPAND characters, but any above-Unicode |
| 346 | * code point will fold to itself, so we only have to look at the expansion of |
| 347 | * the maximum Unicode code point. But this number may be less than the space |
| 348 | * occupied by a very large code point under Perl's extended UTF-8. We have to |
| 349 | * make it large enough to fit any single character. (It turns out that ASCII |
| 350 | * and EBCDIC differ in which is larger) */ |
| 351 | #define UTF8_MAXBYTES_CASE \ |
| 352 | (UTF8_MAXBYTES >= (UTF8_MAX_FOLD_CHAR_EXPAND * OFFUNISKIP(0x10FFFF)) \ |
| 353 | ? UTF8_MAXBYTES \ |
| 354 | : (UTF8_MAX_FOLD_CHAR_EXPAND * OFFUNISKIP(0x10FFFF))) |
| 355 | |
| 356 | /* Rest of these are attributes of Unicode and perl's internals rather than the |
| 357 | * encoding, or happen to be the same in both ASCII and EBCDIC (at least at |
| 358 | * this level; the macros that some of these call may have different |
| 359 | * definitions in the two encodings */ |
| 360 | |
| 361 | /* In domain restricted to ASCII, these may make more sense to the reader than |
| 362 | * the ones with Latin1 in the name */ |
| 363 | #define NATIVE_TO_ASCII(ch) NATIVE_TO_LATIN1(ch) |
| 364 | #define ASCII_TO_NATIVE(ch) LATIN1_TO_NATIVE(ch) |
| 365 | |
| 366 | /* More or less misleadingly-named defines, retained for back compat */ |
| 367 | #define NATIVE_TO_UTF(ch) NATIVE_UTF8_TO_I8(ch) |
| 368 | #define NATIVE_TO_I8(ch) NATIVE_UTF8_TO_I8(ch) |
| 369 | #define UTF_TO_NATIVE(ch) I8_TO_NATIVE_UTF8(ch) |
| 370 | #define I8_TO_NATIVE(ch) I8_TO_NATIVE_UTF8(ch) |
| 371 | #define NATIVE8_TO_UNI(ch) NATIVE_TO_LATIN1(ch) |
| 372 | |
| 373 | /* This defines the 1-bits that are to be in the first byte of a multi-byte |
| 374 | * UTF-8 encoded character that mark it as a start byte and give the number of |
| 375 | * bytes that comprise the character. 'len' is the number of bytes in the |
| 376 | * multi-byte sequence. */ |
| 377 | #define UTF_START_MARK(len) (((len) > 7) ? 0xFF : (0xFF & (0xFE << (7-(len))))) |
| 378 | |
| 379 | /* Masks out the initial one bits in a start byte, leaving the real data ones. |
| 380 | * Doesn't work on an invariant byte. 'len' is the number of bytes in the |
| 381 | * multi-byte sequence that comprises the character. */ |
| 382 | #define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2))) |
| 383 | |
| 384 | /* Adds a UTF8 continuation byte 'new' of information to a running total code |
| 385 | * point 'old' of all the continuation bytes so far. This is designed to be |
| 386 | * used in a loop to convert from UTF-8 to the code point represented. Note |
| 387 | * that this is asymmetric on EBCDIC platforms, in that the 'new' parameter is |
| 388 | * the UTF-EBCDIC byte, whereas the 'old' parameter is a Unicode (not EBCDIC) |
| 389 | * code point in process of being generated */ |
| 390 | #define UTF8_ACCUMULATE(old, new) (((old) << UTF_ACCUMULATION_SHIFT) \ |
| 391 | | ((NATIVE_UTF8_TO_I8((U8)new)) \ |
| 392 | & UTF_CONTINUATION_MASK)) |
| 393 | |
| 394 | /* If a value is anded with this, and the result is non-zero, then using the |
| 395 | * original value in UTF8_ACCUMULATE will overflow, shifting bits off the left |
| 396 | * */ |
| 397 | #define UTF_ACCUMULATION_OVERFLOW_MASK \ |
| 398 | (((UV) UTF_CONTINUATION_MASK) << ((sizeof(UV) * CHARBITS) \ |
| 399 | - UTF_ACCUMULATION_SHIFT)) |
| 400 | |
| 401 | /* This works in the face of malformed UTF-8. */ |
| 402 | #define UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, e) (UTF8_IS_DOWNGRADEABLE_START(*s) \ |
| 403 | && ( (e) - (s) > 1) \ |
| 404 | && UTF8_IS_CONTINUATION(*((s)+1))) |
| 405 | |
| 406 | /* Number of bytes a code point occupies in UTF-8. */ |
| 407 | #define NATIVE_SKIP(uv) UVCHR_SKIP(uv) |
| 408 | |
| 409 | /* Most code which says UNISKIP is really thinking in terms of native code |
| 410 | * points (0-255) plus all those beyond. This is an imprecise term, but having |
| 411 | * it means existing code continues to work. For precision, use UVCHR_SKIP, |
| 412 | * NATIVE_SKIP, or OFFUNISKIP */ |
| 413 | #define UNISKIP(uv) UVCHR_SKIP(uv) |
| 414 | |
| 415 | /* Longer, but more accurate name */ |
| 416 | #define UTF8_IS_ABOVE_LATIN1_START(c) UTF8_IS_ABOVE_LATIN1(c) |
| 417 | |
| 418 | /* Convert a UTF-8 variant Latin1 character to a native code point value. |
| 419 | * Needs just one iteration of accumulate. Should be used only if it is known |
| 420 | * that the code point is < 256, and is not UTF-8 invariant. Use the slower |
| 421 | * but more general TWO_BYTE_UTF8_TO_NATIVE() which handles any code point |
| 422 | * representable by two bytes (which turns out to be up through |
| 423 | * MAX_PORTABLE_UTF8_TWO_BYTE). The two parameters are: |
| 424 | * HI: a downgradable start byte; |
| 425 | * LO: continuation. |
| 426 | * */ |
| 427 | #define EIGHT_BIT_UTF8_TO_NATIVE(HI, LO) \ |
| 428 | ( __ASSERT_(UTF8_IS_DOWNGRADEABLE_START(HI)) \ |
| 429 | __ASSERT_(UTF8_IS_CONTINUATION(LO)) \ |
| 430 | LATIN1_TO_NATIVE(UTF8_ACCUMULATE(( \ |
| 431 | NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), (LO)))) |
| 432 | |
| 433 | /* Convert a two (not one) byte utf8 character to a native code point value. |
| 434 | * Needs just one iteration of accumulate. Should not be used unless it is |
| 435 | * known that the two bytes are legal: 1) two-byte start, and 2) continuation. |
| 436 | * Note that the result can be larger than 255 if the input character is not |
| 437 | * downgradable */ |
| 438 | #define TWO_BYTE_UTF8_TO_NATIVE(HI, LO) \ |
| 439 | ( __ASSERT_(PL_utf8skip[HI] == 2) \ |
| 440 | __ASSERT_(UTF8_IS_CONTINUATION(LO)) \ |
| 441 | UNI_TO_NATIVE(UTF8_ACCUMULATE((NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), \ |
| 442 | (LO)))) |
| 443 | |
| 444 | /* Should never be used, and be deprecated */ |
| 445 | #define TWO_BYTE_UTF8_TO_UNI(HI, LO) NATIVE_TO_UNI(TWO_BYTE_UTF8_TO_NATIVE(HI, LO)) |
| 446 | |
| 447 | /* |
| 448 | |
| 449 | =for apidoc Am|STRLEN|UTF8SKIP|char* s |
| 450 | returns the number of bytes in the UTF-8 encoded character whose first (perhaps |
| 451 | only) byte is pointed to by C<s>. |
| 452 | |
| 453 | =cut |
| 454 | */ |
| 455 | #define UTF8SKIP(s) PL_utf8skip[*(const U8*)(s)] |
| 456 | #define UTF8_SKIP(s) UTF8SKIP(s) |
| 457 | |
| 458 | /* Most code that says 'UNI_' really means the native value for code points up |
| 459 | * through 255 */ |
| 460 | #define UNI_IS_INVARIANT(cp) UVCHR_IS_INVARIANT(cp) |
| 461 | |
| 462 | /* Is the byte 'c' the same character when encoded in UTF-8 as when not. This |
| 463 | * works on both UTF-8 encoded strings and non-encoded, as it returns TRUE in |
| 464 | * each for the exact same set of bit patterns. It is valid on a subset of |
| 465 | * what UVCHR_IS_INVARIANT is valid on, so can just use that; and the compiler |
| 466 | * should optimize out anything extraneous given the implementation of the |
| 467 | * latter */ |
| 468 | #define UTF8_IS_INVARIANT(c) UVCHR_IS_INVARIANT(c) |
| 469 | |
| 470 | /* Like the above, but its name implies a non-UTF8 input, which as the comments |
| 471 | * above show, doesn't matter as to its implementation */ |
| 472 | #define NATIVE_BYTE_IS_INVARIANT(c) UVCHR_IS_INVARIANT(c) |
| 473 | |
| 474 | /* The macros in the next 4 sets are used to generate the two utf8 or utfebcdic |
| 475 | * bytes from an ordinal that is known to fit into exactly two (not one) bytes; |
| 476 | * it must be less than 0x3FF to work across both encodings. */ |
| 477 | |
| 478 | /* These two are helper macros for the other three sets, and should not be used |
| 479 | * directly anywhere else. 'translate_function' is either NATIVE_TO_LATIN1 |
| 480 | * (which works for code points up through 0xFF) or NATIVE_TO_UNI which works |
| 481 | * for any code point */ |
| 482 | #define __BASE_TWO_BYTE_HI(c, translate_function) \ |
| 483 | (__ASSERT_(! UVCHR_IS_INVARIANT(c)) \ |
| 484 | I8_TO_NATIVE_UTF8((translate_function(c) >> UTF_ACCUMULATION_SHIFT) \ |
| 485 | | UTF_START_MARK(2))) |
| 486 | #define __BASE_TWO_BYTE_LO(c, translate_function) \ |
| 487 | (__ASSERT_(! UVCHR_IS_INVARIANT(c)) \ |
| 488 | I8_TO_NATIVE_UTF8((translate_function(c) & UTF_CONTINUATION_MASK) \ |
| 489 | | UTF_CONTINUATION_MARK)) |
| 490 | |
| 491 | /* The next two macros should not be used. They were designed to be usable as |
| 492 | * the case label of a switch statement, but this doesn't work for EBCDIC. Use |
| 493 | * regen/unicode_constants.pl instead */ |
| 494 | #define UTF8_TWO_BYTE_HI_nocast(c) __BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI) |
| 495 | #define UTF8_TWO_BYTE_LO_nocast(c) __BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI) |
| 496 | |
| 497 | /* The next two macros are used when the source should be a single byte |
| 498 | * character; checked for under DEBUGGING */ |
| 499 | #define UTF8_EIGHT_BIT_HI(c) (__ASSERT_(FITS_IN_8_BITS(c)) \ |
| 500 | ( __BASE_TWO_BYTE_HI(c, NATIVE_TO_LATIN1))) |
| 501 | #define UTF8_EIGHT_BIT_LO(c) (__ASSERT_(FITS_IN_8_BITS(c)) \ |
| 502 | (__BASE_TWO_BYTE_LO(c, NATIVE_TO_LATIN1))) |
| 503 | |
| 504 | /* These final two macros in the series are used when the source can be any |
| 505 | * code point whose UTF-8 is known to occupy 2 bytes; they are less efficient |
| 506 | * than the EIGHT_BIT versions on EBCDIC platforms. We use the logical '~' |
| 507 | * operator instead of "<=" to avoid getting compiler warnings. |
| 508 | * MAX_UTF8_TWO_BYTE should be exactly all one bits in the lower few |
| 509 | * places, so the ~ works */ |
| 510 | #define UTF8_TWO_BYTE_HI(c) \ |
| 511 | (__ASSERT_((sizeof(c) == 1) \ |
| 512 | || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE)) \ |
| 513 | (__BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI))) |
| 514 | #define UTF8_TWO_BYTE_LO(c) \ |
| 515 | (__ASSERT_((sizeof(c) == 1) \ |
| 516 | || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE)) \ |
| 517 | (__BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI))) |
| 518 | |
| 519 | /* This is illegal in any well-formed UTF-8 in both EBCDIC and ASCII |
| 520 | * as it is only in overlongs. */ |
| 521 | #define ILLEGAL_UTF8_BYTE I8_TO_NATIVE_UTF8(0xC1) |
| 522 | |
| 523 | /* |
| 524 | * 'UTF' is whether or not p is encoded in UTF8. The names 'foo_lazy_if' stem |
| 525 | * from an earlier version of these macros in which they didn't call the |
| 526 | * foo_utf8() macros (i.e. were 'lazy') unless they decided that *p is the |
| 527 | * beginning of a utf8 character. Now that foo_utf8() determines that itself, |
| 528 | * no need to do it again here |
| 529 | */ |
| 530 | #define isIDFIRST_lazy_if(p,UTF) ((IN_BYTES || !UTF) \ |
| 531 | ? isIDFIRST(*(p)) \ |
| 532 | : isIDFIRST_utf8((const U8*)p)) |
| 533 | #define isWORDCHAR_lazy_if(p,UTF) ((IN_BYTES || (!UTF)) \ |
| 534 | ? isWORDCHAR(*(p)) \ |
| 535 | : isWORDCHAR_utf8((const U8*)p)) |
| 536 | #define isALNUM_lazy_if(p,UTF) isWORDCHAR_lazy_if(p,UTF) |
| 537 | |
| 538 | #define UTF8_MAXLEN UTF8_MAXBYTES |
| 539 | |
| 540 | /* A Unicode character can fold to up to 3 characters */ |
| 541 | #define UTF8_MAX_FOLD_CHAR_EXPAND 3 |
| 542 | |
| 543 | #define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES) |
| 544 | |
| 545 | /* |
| 546 | |
| 547 | =for apidoc Am|bool|DO_UTF8|SV* sv |
| 548 | Returns a bool giving whether or not the PV in C<sv> is to be treated as being |
| 549 | encoded in UTF-8. |
| 550 | |
| 551 | You should use this I<after> a call to C<SvPV()> or one of its variants, in |
| 552 | case any call to string overloading updates the internal UTF-8 encoding flag. |
| 553 | |
| 554 | =cut |
| 555 | */ |
| 556 | #define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES) |
| 557 | |
| 558 | /* Should all strings be treated as Unicode, and not just UTF-8 encoded ones? |
| 559 | * Is so within 'feature unicode_strings' or 'locale :not_characters', and not |
| 560 | * within 'use bytes'. UTF-8 locales are not tested for here, but perhaps |
| 561 | * could be */ |
| 562 | #define IN_UNI_8_BIT \ |
| 563 | (((CopHINTS_get(PL_curcop) & (HINT_UNI_8_BIT)) \ |
| 564 | || (CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL \ |
| 565 | /* -1 below is for :not_characters */ \ |
| 566 | && _is_in_locale_category(FALSE, -1))) \ |
| 567 | && ! IN_BYTES) |
| 568 | |
| 569 | |
| 570 | #define UTF8_ALLOW_EMPTY 0x0001 /* Allow a zero length string */ |
| 571 | |
| 572 | /* Allow first byte to be a continuation byte */ |
| 573 | #define UTF8_ALLOW_CONTINUATION 0x0002 |
| 574 | |
| 575 | /* Allow second... bytes to be non-continuation bytes */ |
| 576 | #define UTF8_ALLOW_NON_CONTINUATION 0x0004 |
| 577 | |
| 578 | /* expecting more bytes than were available in the string */ |
| 579 | #define UTF8_ALLOW_SHORT 0x0008 |
| 580 | |
| 581 | /* Overlong sequence; i.e., the code point can be specified in fewer bytes. */ |
| 582 | #define UTF8_ALLOW_LONG 0x0010 |
| 583 | |
| 584 | #define UTF8_DISALLOW_SURROGATE 0x0020 /* Unicode surrogates */ |
| 585 | #define UTF8_WARN_SURROGATE 0x0040 |
| 586 | |
| 587 | #define UTF8_DISALLOW_NONCHAR 0x0080 /* Unicode non-character */ |
| 588 | #define UTF8_WARN_NONCHAR 0x0100 /* code points */ |
| 589 | |
| 590 | #define UTF8_DISALLOW_SUPER 0x0200 /* Super-set of Unicode: code */ |
| 591 | #define UTF8_WARN_SUPER 0x0400 /* points above the legal max */ |
| 592 | |
| 593 | /* Code points which never were part of the original UTF-8 standard, which only |
| 594 | * went up to 2 ** 31 - 1. Note that these all overflow a signed 32-bit word, |
| 595 | * The first byte of these code points is FE or FF on ASCII platforms. If the |
| 596 | * first byte is FF, it will overflow a 32-bit word. */ |
| 597 | #define UTF8_DISALLOW_ABOVE_31_BIT 0x0800 |
| 598 | #define UTF8_WARN_ABOVE_31_BIT 0x1000 |
| 599 | |
| 600 | /* For back compat, these old names are misleading for UTF_EBCDIC */ |
| 601 | #define UTF8_DISALLOW_FE_FF UTF8_DISALLOW_ABOVE_31_BIT |
| 602 | #define UTF8_WARN_FE_FF UTF8_WARN_ABOVE_31_BIT |
| 603 | |
| 604 | #define UTF8_CHECK_ONLY 0x2000 |
| 605 | |
| 606 | /* For backwards source compatibility. They do nothing, as the default now |
| 607 | * includes what they used to mean. The first one's meaning was to allow the |
| 608 | * just the single non-character 0xFFFF */ |
| 609 | #define UTF8_ALLOW_FFFF 0 |
| 610 | #define UTF8_ALLOW_SURROGATE 0 |
| 611 | |
| 612 | #define UTF8_DISALLOW_ILLEGAL_INTERCHANGE \ |
| 613 | ( UTF8_DISALLOW_SUPER|UTF8_DISALLOW_NONCHAR \ |
| 614 | |UTF8_DISALLOW_SURROGATE) |
| 615 | #define UTF8_WARN_ILLEGAL_INTERCHANGE \ |
| 616 | (UTF8_WARN_SUPER|UTF8_WARN_NONCHAR|UTF8_WARN_SURROGATE) |
| 617 | #define UTF8_ALLOW_ANY \ |
| 618 | (~( UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_DISALLOW_ABOVE_31_BIT \ |
| 619 | |UTF8_WARN_ILLEGAL_INTERCHANGE|UTF8_WARN_ABOVE_31_BIT)) |
| 620 | #define UTF8_ALLOW_ANYUV \ |
| 621 | (UTF8_ALLOW_EMPTY \ |
| 622 | & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE)) |
| 623 | #define UTF8_ALLOW_DEFAULT (ckWARN(WARN_UTF8) ? 0 : \ |
| 624 | UTF8_ALLOW_ANYUV) |
| 625 | |
| 626 | /* Several of the macros below have a second parameter that is currently |
| 627 | * unused; but could be used in the future to make sure that the input is |
| 628 | * well-formed. */ |
| 629 | |
| 630 | #define UTF8_IS_SURROGATE(s, e) cBOOL(is_SURROGATE_utf8(s)) |
| 631 | #define UTF8_IS_REPLACEMENT(s, send) cBOOL(is_REPLACEMENT_utf8_safe(s,send)) |
| 632 | |
| 633 | /* ASCII EBCDIC I8 |
| 634 | * U+10FFFF: \xF4\x8F\xBF\xBF \xF9\xA1\xBF\xBF\xBF max legal Unicode |
| 635 | * U+110000: \xF4\x90\x80\x80 \xF9\xA2\xA0\xA0\xA0 |
| 636 | * U+110001: \xF4\x90\x80\x81 \xF9\xA2\xA0\xA0\xA1 |
| 637 | * |
| 638 | * BE AWARE that this test doesn't rule out malformed code points, in |
| 639 | * particular overlongs */ |
| 640 | #ifdef EBCDIC /* Both versions assume well-formed UTF8 */ |
| 641 | # define UTF8_IS_SUPER(s, e) (NATIVE_UTF8_TO_I8(* (U8*) (s)) >= 0xF9 \ |
| 642 | && (NATIVE_UTF8_TO_I8(* (U8*) (s)) > 0xF9 \ |
| 643 | || (NATIVE_UTF8_TO_I8(* ((U8*) (s) + 1)) >= 0xA2))) |
| 644 | #else |
| 645 | # define UTF8_IS_SUPER(s, e) (*(U8*) (s) >= 0xF4 \ |
| 646 | && (*(U8*) (s) > 0xF4 || (*((U8*) (s) + 1) >= 0x90))) |
| 647 | #endif |
| 648 | |
| 649 | /* These are now machine generated, and the 'given' clause is no longer |
| 650 | * applicable */ |
| 651 | #define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e) \ |
| 652 | cBOOL(is_NONCHAR_utf8(s)) |
| 653 | #define UTF8_IS_NONCHAR(s, e) \ |
| 654 | UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e) |
| 655 | |
| 656 | #define UNICODE_SURROGATE_FIRST 0xD800 |
| 657 | #define UNICODE_SURROGATE_LAST 0xDFFF |
| 658 | #define UNICODE_REPLACEMENT 0xFFFD |
| 659 | #define UNICODE_BYTE_ORDER_MARK 0xFEFF |
| 660 | |
| 661 | /* Though our UTF-8 encoding can go beyond this, |
| 662 | * let's be conservative and do as Unicode says. */ |
| 663 | #define PERL_UNICODE_MAX 0x10FFFF |
| 664 | |
| 665 | #define UNICODE_WARN_SURROGATE 0x0001 /* UTF-16 surrogates */ |
| 666 | #define UNICODE_WARN_NONCHAR 0x0002 /* Non-char code points */ |
| 667 | #define UNICODE_WARN_SUPER 0x0004 /* Above 0x10FFFF */ |
| 668 | #define UNICODE_WARN_ABOVE_31_BIT 0x0008 /* Above 0x7FFF_FFFF */ |
| 669 | #define UNICODE_DISALLOW_SURROGATE 0x0010 |
| 670 | #define UNICODE_DISALLOW_NONCHAR 0x0020 |
| 671 | #define UNICODE_DISALLOW_SUPER 0x0040 |
| 672 | #define UNICODE_DISALLOW_ABOVE_31_BIT 0x0080 |
| 673 | #define UNICODE_WARN_ILLEGAL_INTERCHANGE \ |
| 674 | (UNICODE_WARN_SURROGATE|UNICODE_WARN_NONCHAR|UNICODE_WARN_SUPER) |
| 675 | #define UNICODE_DISALLOW_ILLEGAL_INTERCHANGE \ |
| 676 | (UNICODE_DISALLOW_SURROGATE|UNICODE_DISALLOW_NONCHAR|UNICODE_DISALLOW_SUPER) |
| 677 | |
| 678 | /* For backward source compatibility, as are now the default */ |
| 679 | #define UNICODE_ALLOW_SURROGATE 0 |
| 680 | #define UNICODE_ALLOW_SUPER 0 |
| 681 | #define UNICODE_ALLOW_ANY 0 |
| 682 | |
| 683 | /* This matches the 2048 code points between UNICODE_SURROGATE_FIRST (0xD800) and |
| 684 | * UNICODE_SURROGATE_LAST (0xDFFF) */ |
| 685 | #define UNICODE_IS_SURROGATE(uv) (((UV) (uv) & (~0xFFFF | 0xF800)) \ |
| 686 | == 0xD800) |
| 687 | |
| 688 | #define UNICODE_IS_REPLACEMENT(uv) ((UV) (uv) == UNICODE_REPLACEMENT) |
| 689 | #define UNICODE_IS_BYTE_ORDER_MARK(uv) ((UV) (uv) == UNICODE_BYTE_ORDER_MARK) |
| 690 | |
| 691 | /* Is 'uv' one of the 32 contiguous-range noncharacters? */ |
| 692 | #define UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv) ((UV) (uv) >= 0xFDD0 \ |
| 693 | && (UV) (uv) <= 0xFDEF) |
| 694 | |
| 695 | /* Is 'uv' one of the 34 plane-ending noncharacters 0xFFFE, 0xFFFF, 0x1FFFE, |
| 696 | * 0x1FFFF, ... 0x10FFFE, 0x10FFFF, given that we know that 'uv' is not above |
| 697 | * the Unicode legal max */ |
| 698 | #define UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv) \ |
| 699 | (((UV) (uv) & 0xFFFE) == 0xFFFE) |
| 700 | |
| 701 | #define UNICODE_IS_NONCHAR(uv) \ |
| 702 | ( UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv) \ |
| 703 | || ( LIKELY( ! UNICODE_IS_SUPER(uv)) \ |
| 704 | && UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv))) |
| 705 | |
| 706 | #define UNICODE_IS_SUPER(uv) ((UV) (uv) > PERL_UNICODE_MAX) |
| 707 | #define UNICODE_IS_ABOVE_31_BIT(uv) ((UV) (uv) > 0x7FFFFFFF) |
| 708 | |
| 709 | #define LATIN_SMALL_LETTER_SHARP_S LATIN_SMALL_LETTER_SHARP_S_NATIVE |
| 710 | #define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS \ |
| 711 | LATIN_SMALL_LETTER_Y_WITH_DIAERESIS_NATIVE |
| 712 | #define MICRO_SIGN MICRO_SIGN_NATIVE |
| 713 | #define LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE \ |
| 714 | LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE_NATIVE |
| 715 | #define LATIN_SMALL_LETTER_A_WITH_RING_ABOVE \ |
| 716 | LATIN_SMALL_LETTER_A_WITH_RING_ABOVE_NATIVE |
| 717 | #define UNICODE_GREEK_CAPITAL_LETTER_SIGMA 0x03A3 |
| 718 | #define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA 0x03C2 |
| 719 | #define UNICODE_GREEK_SMALL_LETTER_SIGMA 0x03C3 |
| 720 | #define GREEK_SMALL_LETTER_MU 0x03BC |
| 721 | #define GREEK_CAPITAL_LETTER_MU 0x039C /* Upper and title case |
| 722 | of MICRON */ |
| 723 | #define LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS 0x0178 /* Also is title case */ |
| 724 | #ifdef LATIN_CAPITAL_LETTER_SHARP_S_UTF8 |
| 725 | # define LATIN_CAPITAL_LETTER_SHARP_S 0x1E9E |
| 726 | #endif |
| 727 | #define LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE 0x130 |
| 728 | #define LATIN_SMALL_LETTER_DOTLESS_I 0x131 |
| 729 | #define LATIN_SMALL_LETTER_LONG_S 0x017F |
| 730 | #define LATIN_SMALL_LIGATURE_LONG_S_T 0xFB05 |
| 731 | #define LATIN_SMALL_LIGATURE_ST 0xFB06 |
| 732 | #define KELVIN_SIGN 0x212A |
| 733 | #define ANGSTROM_SIGN 0x212B |
| 734 | |
| 735 | #define UNI_DISPLAY_ISPRINT 0x0001 |
| 736 | #define UNI_DISPLAY_BACKSLASH 0x0002 |
| 737 | #define UNI_DISPLAY_QQ (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH) |
| 738 | #define UNI_DISPLAY_REGEX (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH) |
| 739 | |
| 740 | #define ANYOF_FOLD_SHARP_S(node, input, end) \ |
| 741 | (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \ |
| 742 | (ANYOF_NONBITMAP(node)) && \ |
| 743 | (ANYOF_FLAGS(node) & ANYOF_LOC_NONBITMAP_FOLD) && \ |
| 744 | ((end) > (input) + 1) && \ |
| 745 | isALPHA_FOLD_EQ((input)[0], 's')) |
| 746 | |
| 747 | #define SHARP_S_SKIP 2 |
| 748 | |
| 749 | /* If you want to exclude surrogates, and beyond legal Unicode, see the blame |
| 750 | * log for earlier versions which gave details for these */ |
| 751 | |
| 752 | /* A helper macro for isUTF8_CHAR, so use that one, and not this one. This is |
| 753 | * retained solely for backwards compatibility and may be deprecated and |
| 754 | * removed in a future Perl version. |
| 755 | * |
| 756 | * regen/regcharclass.pl generates is_UTF8_CHAR_utf8() macros for up to these |
| 757 | * number of bytes. So this has to be coordinated with that file */ |
| 758 | #ifdef EBCDIC |
| 759 | # define IS_UTF8_CHAR_FAST(n) ((n) <= 3) |
| 760 | #else |
| 761 | # define IS_UTF8_CHAR_FAST(n) ((n) <= 4) |
| 762 | #endif |
| 763 | |
| 764 | #ifndef EBCDIC |
| 765 | /* A helper macro for isUTF8_CHAR, so use that one instead of this. This was |
| 766 | * generated by regen/regcharclass.pl, and then moved here. The lines that |
| 767 | * generated it were then commented out. This was done solely because it takes |
| 768 | * on the order of 10 minutes to generate, and is never going to change, unless |
| 769 | * the generated code is improved. |
| 770 | * |
| 771 | * The EBCDIC versions have been cut to not cover all of legal Unicode, |
| 772 | * otherwise they take too long to generate; besides there is a separate one |
| 773 | * for each code page, so they are in regcharclass.h instead of here */ |
| 774 | /* |
| 775 | UTF8_CHAR: Matches legal UTF-8 encoded characters from 2 through 4 bytes |
| 776 | |
| 777 | 0x80 - 0x1FFFFF |
| 778 | */ |
| 779 | /*** GENERATED CODE ***/ |
| 780 | #define is_UTF8_CHAR_utf8_no_length_checks(s) \ |
| 781 | ( ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ? \ |
| 782 | ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 ) \ |
| 783 | : ( 0xE0 == ((U8*)s)[0] ) ? \ |
| 784 | ( ( ( ( ((U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\ |
| 785 | : ( 0xE1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xEF ) ? \ |
| 786 | ( ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\ |
| 787 | : ( 0xF0 == ((U8*)s)[0] ) ? \ |
| 788 | ( ( ( ( 0x90 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0xBF ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\ |
| 789 | : ( ( ( ( 0xF1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xF7 ) && ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 ) |
| 790 | #endif |
| 791 | |
| 792 | /* |
| 793 | |
| 794 | =for apidoc Am|STRLEN|isUTF8_CHAR|const U8 *s|const U8 *e |
| 795 | |
| 796 | Returns the number of bytes beginning at C<s> which form a legal UTF-8 (or |
| 797 | UTF-EBCDIC) encoded character, looking no further than S<C<e - s>> bytes into |
| 798 | C<s>. Returns 0 if the sequence starting at C<s> through S<C<e - 1>> is not |
| 799 | well-formed UTF-8. |
| 800 | |
| 801 | Note that an INVARIANT character (i.e. ASCII on non-EBCDIC |
| 802 | machines) is a valid UTF-8 character. |
| 803 | |
| 804 | =cut |
| 805 | */ |
| 806 | |
| 807 | #define isUTF8_CHAR(s, e) (UNLIKELY((e) <= (s)) \ |
| 808 | ? 0 \ |
| 809 | : (UTF8_IS_INVARIANT(*s)) \ |
| 810 | ? 1 \ |
| 811 | : UNLIKELY(((e) - (s)) < UTF8SKIP(s)) \ |
| 812 | ? 0 \ |
| 813 | : LIKELY(IS_UTF8_CHAR_FAST(UTF8SKIP(s))) \ |
| 814 | ? is_UTF8_CHAR_utf8_no_length_checks(s) \ |
| 815 | : _is_utf8_char_slow(s, e)) |
| 816 | |
| 817 | #define is_utf8_char_buf(buf, buf_end) isUTF8_CHAR(buf, buf_end) |
| 818 | |
| 819 | /* Do not use; should be deprecated. Use isUTF8_CHAR() instead; this is |
| 820 | * retained solely for backwards compatibility */ |
| 821 | #define IS_UTF8_CHAR(p, n) (isUTF8_CHAR(p, (p) + (n)) == n) |
| 822 | |
| 823 | #endif /* H_UTF8 */ |
| 824 | |
| 825 | /* |
| 826 | * ex: set ts=8 sts=4 sw=4 et: |
| 827 | */ |