utf8.h

   1 /*    utf8.h
   2  *
   3  *    Copyright (C) 2000, 2001, 2002, 2005, 2006, 2007, 2009,
   4  *    2010, 2011 by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 /* Use UTF-8 as the default script encoding?
  12  * Turning this on will break scripts having non-UTF-8 binary
  13  * data (such as Latin-1) in string literals. */
  14 #ifdef USE_UTF8_SCRIPTS
  15 #    define USE_UTF8_IN_NAMES (!IN_BYTES)
  16 #else
  17 #    define USE_UTF8_IN_NAMES (PL_hints & HINT_UTF8)
  18 #endif
  19
  20 /* For to_utf8_fold_flags, q.v. */
  21 #define FOLD_FLAGS_LOCALE 0x1
  22 #define FOLD_FLAGS_FULL   0x2
  23 #define FOLD_FLAGS_NOMIX_ASCII 0x4
  24
  25 /* For _core_swash_init(), internal core use only */
  26 #define _CORE_SWASH_INIT_USER_DEFINED_PROPERTY 0x1
  27
  28 #define to_uni_fold(c, p, lenp) _to_uni_fold_flags(c, p, lenp, FOLD_FLAGS_FULL)
  29 #define to_utf8_fold(c, p, lenp) _to_utf8_fold_flags(c, p, lenp, \
  30                      FOLD_FLAGS_FULL, NULL)
  31 #define to_utf8_lower(a,b,c) _to_utf8_lower_flags(a,b,c,0, NULL)
  32 #define to_utf8_upper(a,b,c) _to_utf8_upper_flags(a,b,c,0, NULL)
  33 #define to_utf8_title(a,b,c) _to_utf8_title_flags(a,b,c,0, NULL)
  34
  35 /* Source backward compatibility. */
  36 #define uvuni_to_utf8(d, uv)            uvuni_to_utf8_flags(d, uv, 0)
  37 #define is_utf8_string_loc(s, len, ep)  is_utf8_string_loclen(s, len, ep, 0)
  38
  39 #define foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
  40                     foldEQ_utf8_flags(s1, pe1, l1, u1, s2, pe2, l2, u2, 0)
  41 #define FOLDEQ_UTF8_NOMIX_ASCII (1 << 0)
  42 #define FOLDEQ_UTF8_LOCALE      (1 << 1)
  43 #define FOLDEQ_S1_ALREADY_FOLDED  (1 << 2)
  44 #define FOLDEQ_S2_ALREADY_FOLDED  (1 << 3)
  45
  46 /*
  47 =for apidoc ibcmp_utf8
  48
  49 This is a synonym for (! foldEQ_utf8())
  50
  51 =cut
  52 */
  53 #define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
  54                     cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2))
  55
  56 #ifdef EBCDIC
  57 /* The equivalent of these macros but implementing UTF-EBCDIC
  58    are in the following header file:
  59  */
  60
  61 #include "utfebcdic.h"
  62
  63 #else   /* ! EBCDIC */
  64 START_EXTERN_C
  65
  66 #ifdef DOINIT
  67 EXTCONST unsigned char PL_utf8skip[] = {
  68 /* 0x00 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
  69 /* 0x10 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
  70 /* 0x20 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
  71 /* 0x30 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
  72 /* 0x40 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
  73 /* 0x50 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
  74 /* 0x60 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
  75 /* 0x70 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
  76 /* 0x80 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
  77 /* 0x90 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
  78 /* 0xA0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
  79 /* 0xB0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
  80 /* 0xC0 */ 2,2,                             /* overlong */
  81 /* 0xC2 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,     /* U+0080 to U+03FF */
  82 /* 0xD0 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0400 to U+07FF */
  83 /* 0xE0 */ 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3, /* U+0800 to U+FFFF */
  84 /* 0xF0 */ 4,4,4,4,4,4,4,4,5,5,5,5,6,6,     /* above BMP to 2**31 - 1 */
  85 /* 0xFE */ 7,13, /* Perl extended (never was official UTF-8).  Up to 72bit
  86                     allowed (64-bit + reserved). */
  87 };
  88 #else
  89 EXTCONST unsigned char PL_utf8skip[];
  90 #endif
  91
  92 END_EXTERN_C
  93
  94 /* Native character to iso-8859-1 */
  95 #define NATIVE_TO_ASCII(ch)      (ch)
  96 #define ASCII_TO_NATIVE(ch)      (ch)
  97 /* Transform after encoding */
  98 #define NATIVE_TO_UTF(ch)        (ch)
  99 #define UTF_TO_NATIVE(ch)        (ch)
 100 /* Transforms in wide UV chars */
 101 #define UNI_TO_NATIVE(ch)        (ch)
 102 #define NATIVE_TO_UNI(ch)        (ch)
 103 /* Transforms in invariant space */
 104 #define NATIVE_TO_NEED(enc,ch)   (ch)
 105 #define ASCII_TO_NEED(enc,ch)    (ch)
 106
 107 /* As there are no translations, avoid the function wrapper */
 108 #define utf8n_to_uvchr utf8n_to_uvuni
 109 #define uvchr_to_utf8  uvuni_to_utf8
 110
 111 /*
 112
 113  The following table is from Unicode 3.2.
 114
 115  Code Points            1st Byte  2nd Byte  3rd Byte  4th Byte
 116
 117    U+0000..U+007F       00..7F
 118    U+0080..U+07FF     * C2..DF    80..BF
 119    U+0800..U+0FFF       E0      * A0..BF    80..BF
 120    U+1000..U+CFFF       E1..EC    80..BF    80..BF
 121    U+D000..U+D7FF       ED        80..9F    80..BF
 122    U+D800..U+DFFF       +++++++ utf16 surrogates, not legal utf8 +++++++
 123    U+E000..U+FFFF       EE..EF    80..BF    80..BF
 124   U+10000..U+3FFFF      F0      * 90..BF    80..BF    80..BF
 125   U+40000..U+FFFFF      F1..F3    80..BF    80..BF    80..BF
 126  U+100000..U+10FFFF     F4        80..8F    80..BF    80..BF
 127     Below are non-Unicode code points
 128  U+110000..U+13FFFF     F4        90..BF    80..BF    80..BF
 129  U+110000..U+1FFFFF     F5..F7    80..BF    80..BF    80..BF
 130  U+200000:              F8..    * 88..BF    80..BF    80..BF    80..BF
 131
 132 Note the gaps before several of the byte entries above marked by '*'.  These are
 133 caused by legal UTF-8 avoiding non-shortest encodings: it is technically
 134 possible to UTF-8-encode a single code point in different ways, but that is
 135 explicitly forbidden, and the shortest possible encoding should always be used
 136 (and that is what Perl does).
 137
 138  */
 139
 140 /*
 141  Another way to look at it, as bits:
 142
 143                   Code Points      1st Byte   2nd Byte   3rd Byte   4th Byte
 144
 145                         0aaa aaaa  0aaa aaaa
 146               0000 0bbb bbaa aaaa  110b bbbb  10aa aaaa
 147               cccc bbbb bbaa aaaa  1110 cccc  10bb bbbb  10aa aaaa
 148  00 000d ddcc cccc bbbb bbaa aaaa  1111 0ddd  10cc cccc  10bb bbbb  10aa aaaa
 149
 150 As you can see, the continuation bytes all begin with C<10>, and the
 151 leading bits of the start byte tell how many bytes there are in the
 152 encoded character.
 153
 154 Perl's extended UTF-8 means we can have start bytes up to FF.
 155
 156 */
 157
 158 #define UNI_IS_INVARIANT(c)             (((UV)c) <  0x80)
 159 #define UTF8_IS_START(c)                (((U8)c) >= 0xc2)
 160 #define UTF8_IS_CONTINUATION(c)         (((U8)c) >= 0x80 && (((U8)c) <= 0xbf))
 161 #define UTF8_IS_CONTINUED(c)            (((U8)c) &  0x80)
 162
 163 /* Masking with 0xfe allows low bit to be 0 or 1; thus this matches 0xc[23] */
 164 #define UTF8_IS_DOWNGRADEABLE_START(c)  (((U8)c & 0xfe) == 0xc2)
 165
 166 #define UTF_START_MARK(len) (((len) >  7) ? 0xFF : (0xFE << (7-(len))))
 167
 168 /* Masks out the initial one bits in a start byte, leaving the real data ones.
 169  * Doesn't work on an invariant byte */
 170 #define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2)))
 171
 172 #define UTF_CONTINUATION_MARK           0x80
 173 #define UTF_ACCUMULATION_SHIFT          6
 174
 175 /* 2**UTF_ACCUMULATION_SHIFT - 1 */
 176 #define UTF_CONTINUATION_MASK           ((U8)0x3f)
 177
 178 /* This sets the UTF_CONTINUATION_MASK in the upper bits of a word.  If a value
 179  * is anded with it, and the result is non-zero, then using the original value
 180  * in UTF8_ACCUMULATE will overflow, shifting bits off the left */
 181 #define UTF_ACCUMULATION_OVERFLOW_MASK                                  \
 182     (((UV) UTF_CONTINUATION_MASK) << ((sizeof(UV) * CHARBITS) - UTF_ACCUMULATION_SHIFT))
 183
 184 #ifdef HAS_QUAD
 185 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
 186                       (uv) < 0x800          ? 2 : \
 187                       (uv) < 0x10000        ? 3 : \
 188                       (uv) < 0x200000       ? 4 : \
 189                       (uv) < 0x4000000      ? 5 : \
 190                       (uv) < 0x80000000     ? 6 : \
 191                       (uv) < UTF8_QUAD_MAX ? 7 : 13 )
 192 #else
 193 /* No, I'm not even going to *TRY* putting #ifdef inside a #define */
 194 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
 195                       (uv) < 0x800          ? 2 : \
 196                       (uv) < 0x10000        ? 3 : \
 197                       (uv) < 0x200000       ? 4 : \
 198                       (uv) < 0x4000000      ? 5 : \
 199                       (uv) < 0x80000000     ? 6 : 7 )
 200 #endif
 201
 202 #endif /* EBCDIC vs ASCII */
 203
 204 /* Rest of these are attributes of Unicode and perl's internals rather than the
 205  * encoding, or happen to be the same in both ASCII and EBCDIC (at least at
 206  * this level; the macros that some of these call may have different
 207  * definitions in the two encodings */
 208
 209 #define NATIVE8_TO_UNI(ch)     NATIVE_TO_ASCII(ch)      /* a clearer synonym */
 210
 211 #define UTF8_ACCUMULATE(old, new)       (((old) << UTF_ACCUMULATION_SHIFT) | (((U8)new) & UTF_CONTINUATION_MASK))
 212
 213 /* Convert a two (not one) byte utf8 character to a unicode code point value.
 214  * Needs just one iteration of accumulate.  Should not be used unless it is
 215  * known that the two bytes are legal: 1) two-byte start, and 2) continuation.
 216  * Note that the result can be larger than 255 if the input character is not
 217  * downgradable */
 218 #define TWO_BYTE_UTF8_TO_UNI(HI, LO) \
 219                     UTF8_ACCUMULATE((NATIVE_TO_UTF(HI) & UTF_START_MASK(2)), \
 220                                      NATIVE_TO_UTF(LO))
 221
 222 #define UTF8SKIP(s) PL_utf8skip[*(const U8*)(s)]
 223
 224 #define UTF8_IS_INVARIANT(c)            UNI_IS_INVARIANT(NATIVE_TO_UTF(c))
 225 #define NATIVE_IS_INVARIANT(c)          UNI_IS_INVARIANT(NATIVE8_TO_UNI(c))
 226
 227 #define MAX_PORTABLE_UTF8_TWO_BYTE 0x3FF    /* constrained by EBCDIC */
 228
 229 /* The macros in the next sets are used to generate the two utf8 or utfebcdic
 230  * bytes from an ordinal that is known to fit into two bytes; it must be less
 231  * than 0x3FF to work across both encodings. */
 232 /* Nocast allows these to be used in the case label of a switch statement */
 233 #define UTF8_TWO_BYTE_HI_nocast(c)      UTF_TO_NATIVE(((c) >> UTF_ACCUMULATION_SHIFT) | (0xFF & UTF_START_MARK(2)))
 234 #define UTF8_TWO_BYTE_LO_nocast(c)      UTF_TO_NATIVE(((c) & UTF_CONTINUATION_MASK) | UTF_CONTINUATION_MARK)
 235
 236 #define UTF8_TWO_BYTE_HI(c)     ((U8) (UTF8_TWO_BYTE_HI_nocast(c)))
 237 #define UTF8_TWO_BYTE_LO(c)     ((U8) (UTF8_TWO_BYTE_LO_nocast(c)))
 238
 239 /* This name is used when the source is a single byte */
 240 #define UTF8_EIGHT_BIT_HI(c)    UTF8_TWO_BYTE_HI((U8)(c))
 241 #define UTF8_EIGHT_BIT_LO(c)    UTF8_TWO_BYTE_LO((U8)(c))
 242
 243 /*
 244  * 'UTF' is whether or not p is encoded in UTF8.  The names 'foo_lazy_if' stem
 245  * from an earlier version of these macros in which they didn't call the
 246  * foo_utf8() macros (i.e. were 'lazy') unless they decided that *p is the
 247  * beginning of a utf8 character.  Now that foo_utf8() determines that itself,
 248  * no need to do it again here
 249  */
 250 #define isIDFIRST_lazy_if(p,UTF) ((IN_BYTES || !UTF ) \
 251                                  ? isIDFIRST(*(p)) \
 252                                  : isIDFIRST_utf8((const U8*)p))
 253 #define isALNUM_lazy_if(p,UTF)   ((IN_BYTES || (!UTF )) \
 254                                  ? isALNUM(*(p)) \
 255                                  : isALNUM_utf8((const U8*)p))
 256
 257 #define isIDFIRST_lazy(p)       isIDFIRST_lazy_if(p,1)
 258 #define isALNUM_lazy(p)         isALNUM_lazy_if(p,1)
 259
 260 #define UTF8_MAXBYTES 13
 261 /* How wide can a single UTF-8 encoded character become in bytes.
 262  * NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8
 263  * since UTF-8 is an encoding of Unicode and given Unicode's current
 264  * upper limit only four bytes is possible.  Perl thinks of UTF-8
 265  * as a way to encode non-negative integers in a binary format. */
 266 #define UTF8_MAXLEN UTF8_MAXBYTES
 267
 268 /* The maximum number of UTF-8 bytes a single Unicode character can
 269  * uppercase/lowercase/fold into; this number depends on the Unicode
 270  * version.  An example of maximal expansion is the U+03B0 which
 271  * uppercases to U+03C5 U+0308 U+0301.  The Unicode databases that
 272  * tell these things are UnicodeData.txt, CaseFolding.txt, and
 273  * SpecialCasing.txt.  The value is 6 for strict Unicode characters, but it has
 274  * to be as big as Perl allows for a single character */
 275 #define UTF8_MAXBYTES_CASE      UTF8_MAXBYTES
 276
 277 /* A Unicode character can fold to up to 3 characters */
 278 #define UTF8_MAX_FOLD_CHAR_EXPAND 3
 279
 280 #define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES)
 281 #define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
 282 #define IN_UNI_8_BIT \
 283             (CopHINTS_get(PL_curcop) & (HINT_UNI_8_BIT|HINT_LOCALE_NOT_CHARS) \
 284              && ! IN_LOCALE_RUNTIME && ! IN_BYTES)
 285
 286
 287 #define UTF8_ALLOW_EMPTY                0x0001  /* Allow a zero length string */
 288
 289 /* Allow first byte to be a continuation byte */
 290 #define UTF8_ALLOW_CONTINUATION         0x0002
 291
 292 /* Allow second... bytes to be non-continuation bytes */
 293 #define UTF8_ALLOW_NON_CONTINUATION     0x0004
 294
 295 /* expecting more bytes than were available in the string */
 296 #define UTF8_ALLOW_SHORT                0x0008
 297
 298 /* Overlong sequence; i.e., the code point can be specified in fewer bytes. */
 299 #define UTF8_ALLOW_LONG                 0x0010
 300
 301 #define UTF8_DISALLOW_SURROGATE         0x0020  /* Unicode surrogates */
 302 #define UTF8_WARN_SURROGATE             0x0040
 303
 304 #define UTF8_DISALLOW_NONCHAR           0x0080  /* Unicode non-character */
 305 #define UTF8_WARN_NONCHAR               0x0100  /*  code points */
 306
 307 #define UTF8_DISALLOW_SUPER             0x0200  /* Super-set of Unicode: code */
 308 #define UTF8_WARN_SUPER                 0x0400  /* points above the legal max */
 309
 310 /* Code points which never were part of the original UTF-8 standard, the first
 311  * byte of which is a FE or FF on ASCII platforms. */
 312 #define UTF8_DISALLOW_FE_FF             0x0800
 313 #define UTF8_WARN_FE_FF                 0x1000
 314
 315 #define UTF8_CHECK_ONLY                 0x2000
 316
 317 /* For backwards source compatibility.  They do nothing, as the default now
 318  * includes what they used to mean.  The first one's meaning was to allow the
 319  * just the single non-character 0xFFFF */
 320 #define UTF8_ALLOW_FFFF 0
 321 #define UTF8_ALLOW_SURROGATE 0
 322
 323 #define UTF8_DISALLOW_ILLEGAL_INTERCHANGE (UTF8_DISALLOW_SUPER|UTF8_DISALLOW_NONCHAR|UTF8_DISALLOW_SURROGATE|UTF8_DISALLOW_FE_FF)
 324 #define UTF8_WARN_ILLEGAL_INTERCHANGE \
 325         (UTF8_WARN_SUPER|UTF8_WARN_NONCHAR|UTF8_WARN_SURROGATE|UTF8_WARN_FE_FF)
 326 #define UTF8_ALLOW_ANY \
 327             (~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
 328 #define UTF8_ALLOW_ANYUV                                                        \
 329          (UTF8_ALLOW_EMPTY                                                      \
 330           & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
 331 #define UTF8_ALLOW_DEFAULT              (ckWARN(WARN_UTF8) ? 0 : \
 332                                          UTF8_ALLOW_ANYUV)
 333
 334 /* Surrogates, non-character code points and above-Unicode code points are
 335  * problematic in some contexts.  This allows code that needs to check for
 336  * those to to quickly exclude the vast majority of code points it will
 337  * encounter */
 338 #ifdef EBCDIC
 339 #   define UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE UTF_TO_NATIVE(0xF1)
 340 #else
 341 #   define UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE 0xED
 342 #endif
 343
 344 /*              ASCII              EBCDIC I8
 345  * U+D7FF:   \xED\x9F\xBF       \xF1\xB5\xBF\xBF    last before surrogates
 346  * U+D800:   \xED\xA0\x80       \xF1\xB6\xA0\xA0    1st surrogate
 347  * U+DFFF:   \xED\xBF\xBF       \xF1\xB7\xBF\xBF    final surrogate
 348  * U+E000:   \xEE\x80\x80       \xF1\xB8\xA0\xA0    next after surrogates
 349  */
 350 #ifdef EBCDIC /* Both versions assume well-formed UTF8 */
 351 #   define UTF8_IS_SURROGATE(s)  (*(s) == UTF_TO_NATIVE(0xF1)                 \
 352                                  && ((*((s) +1) == UTF_TO_NATIVE(0xB6))       \
 353                                      || *((s) + 1) == UTF_TO_NATIVE(0xB7)))
 354     /* <send> points to one beyond the end of the string that starts at <s> */
 355 #   define UTF8_IS_REPLACEMENT(s, send) (*(s) == UTF_TO_NATIVE(0xEF)          \
 356                                          && (send - s) >= 4                   \
 357                                          && *((s) + 1) == UTF_TO_NATIVE(0xBF) \
 358                                          && *((s) + 2) == UTF_TO_NATIVE(0xBF) \
 359                                          && *((s) + 3) == UTF_TO_NATIVE(0xBD)
 360 #else
 361 #   define UTF8_IS_SURROGATE(s) (*(s) == 0xED && *((s) + 1) >= 0xA0)
 362 #   define UTF8_IS_REPLACEMENT(s, send) (*(s) == 0xEF          \
 363                                          && (send - s) >= 3    \
 364                                          && *((s) + 1) == 0xBF \
 365                                          && *((s) + 2) == 0xBD)
 366 #endif
 367
 368 /*                ASCII              EBCDIC I8
 369  * U+10FFFF: \xF4\x8F\xBF\xBF   \xF9\xA1\xBF\xBF\xBF    max legal Unicode
 370  * U+110000: \xF4\x90\x80\x80   \xF9\xA2\xA0\xA0\xA0
 371  * U+110001: \xF4\x90\x80\x81   \xF9\xA2\xA0\xA0\xA1
 372  */
 373 #ifdef EBCDIC /* Both versions assume well-formed UTF8 */
 374 #   define UTF8_IS_SUPER(s)  (*(s) >= UTF_TO_NATIVE(0xF9)                       \
 375       && (*(s) > UTF_TO_NATIVE(0xF9) || (*((s) + 1) >= UTF_TO_NATIVE(0xA2))))
 376 #else
 377 #   define UTF8_IS_SUPER(s)  (*(s) >= 0xF4                                      \
 378                                         && (*(s) > 0xF4 || (*((s) + 1) >= 0x90)))
 379 #endif
 380
 381 /*         ASCII                     EBCDIC I8
 382  * U+FDCF: \xEF\xB7\x8F         \xF1\xBF\xAE\xAF        last before non-char block
 383  * U+FDD0: \xEF\xB7\x90         \xF1\xBF\xAE\xB0        first non-char in block
 384  * U+FDEF: \xEF\xB7\xAF         \xF1\xBF\xAF\xAF        last non-char in block
 385  * U+FDF0: \xEF\xB7\xB0         \xF1\xBF\xAF\xB0        first after non-char block
 386  * U+FFFF: \xEF\xBF\xBF         \xF1\xBF\xBF\xBF
 387  * U+1FFFF: \xF0\x9F\xBF\xBF    \xF3\xBF\xBF\xBF
 388  * U+2FFFF: \xF0\xAF\xBF\xBF    \xF5\xBF\xBF\xBF
 389  * U+3FFFF: \xF0\xBF\xBF\xBF    \xF7\xBF\xBF\xBF
 390  * U+4FFFF: \xF1\x8F\xBF\xBF    \xF8\xA9\xBF\xBF\xBF
 391  * U+5FFFF: \xF1\x9F\xBF\xBF    \xF8\xAB\xBF\xBF\xBF
 392  * U+6FFFF: \xF1\xAF\xBF\xBF    \xF8\xAD\xBF\xBF\xBF
 393  * U+7FFFF: \xF1\xBF\xBF\xBF    \xF8\xAF\xBF\xBF\xBF
 394  * U+8FFFF: \xF2\x8F\xBF\xBF    \xF8\xB1\xBF\xBF\xBF
 395  * U+9FFFF: \xF2\x9F\xBF\xBF    \xF8\xB3\xBF\xBF\xBF
 396  * U+AFFFF: \xF2\xAF\xBF\xBF    \xF8\xB5\xBF\xBF\xBF
 397  * U+BFFFF: \xF2\xBF\xBF\xBF    \xF8\xB7\xBF\xBF\xBF
 398  * U+CFFFF: \xF3\x8F\xBF\xBF    \xF8\xB9\xBF\xBF\xBF
 399  * U+DFFFF: \xF3\x9F\xBF\xBF    \xF8\xBB\xBF\xBF\xBF
 400  * U+EFFFF: \xF3\xAF\xBF\xBF    \xF8\xBD\xBF\xBF\xBF
 401  * U+FFFFF: \xF3\xBF\xBF\xBF    \xF8\xBF\xBF\xBF\xBF
 402  * U+10FFFF: \xF4\x8F\xBF\xBF   \xF9\xA1\xBF\xBF\xBF
 403  */
 404 #define UTF8_IS_NONCHAR_(s) (                                                   \
 405     *(s) >= UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE                        \
 406     && ! UTF8_IS_SUPER(s)                                                       \
 407     && UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_FIRST_PROBLEMATIC(s)         \
 408
 409 #ifdef EBCDIC /* Both versions assume well-formed UTF8 */
 410 #   define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s)           \
 411     ((*(s) == UTF_TO_NATIVE(0xF1)                                               \
 412        && (*((s) + 1) == UTF_TO_NATIVE(0xBF)                                    \
 413        &&    ((*((s) + 2) == UTF_TO_NATIVE(0xAE)                                \
 414             && *((s) + 3) >= UTF_TO_NATIVE(0xB0))                               \
 415           || (*((s) + 2) == UTF_TO_NATIVE(0xAF)                                 \
 416             && *((s) + 3) <= UTF_TO_NATIVE(0xAF)))))                            \
 417     || (UTF8SKIP(*(s)) > 3                                                      \
 418         /* (These were all derived by inspection and experimentation with an */ \
 419         /* editor)  The next line checks the next to final byte in the char */  \
 420         && *((s) + UTF8SKIP(*(s)) - 2) == UTF_TO_NATIVE(0xBF)                   \
 421         && *((s) + UTF8SKIP(*(s)) - 3) == UTF_TO_NATIVE(0xBF)                   \
 422         && (NATIVE_TO_UTF(*((s) + UTF8SKIP(*(s)) - 4)) & 0x81) == 0x81          \
 423         && (NATIVE_TO_UTF(*((s) + UTF8SKIP(*(s)) - 1)) & 0xBE) == 0XBE))
 424 #else
 425 #   define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s)           \
 426     ((*(s) == 0xEF                                                              \
 427         && ((*((s) + 1) == 0xB7 && (*((s) + 2) >= 0x90 && (*((s) + 2) <= 0xAF)))\
 428                 /* Gets U+FFF[EF] */                                            \
 429             || (*((s) + 1) == 0xBF && ((*((s) + 2) & 0xBE) == 0xBE))))          \
 430  || ((*((s) + 2) == 0xBF                                                        \
 431          && (*((s) + 3) & 0xBE) == 0xBE                                         \
 432             /* Excludes things like U+10FFE = \xF0\x90\xBF\xBE */               \
 433          && (*((s) + 1) & 0x8F) == 0x8F)))
 434 #endif
 435
 436 #define UNICODE_SURROGATE_FIRST         0xD800
 437 #define UNICODE_SURROGATE_LAST          0xDFFF
 438 #define UNICODE_REPLACEMENT             0xFFFD
 439 #define UNICODE_BYTE_ORDER_MARK         0xFEFF
 440
 441 /* Though our UTF-8 encoding can go beyond this,
 442  * let's be conservative and do as Unicode says. */
 443 #define PERL_UNICODE_MAX        0x10FFFF
 444
 445 #define UNICODE_WARN_SURROGATE     0x0001       /* UTF-16 surrogates */
 446 #define UNICODE_WARN_NONCHAR       0x0002       /* Non-char code points */
 447 #define UNICODE_WARN_SUPER         0x0004       /* Above 0x10FFFF */
 448 #define UNICODE_WARN_FE_FF         0x0008       /* Above 0x10FFFF */
 449 #define UNICODE_DISALLOW_SURROGATE 0x0010
 450 #define UNICODE_DISALLOW_NONCHAR   0x0020
 451 #define UNICODE_DISALLOW_SUPER     0x0040
 452 #define UNICODE_DISALLOW_FE_FF     0x0080
 453 #define UNICODE_WARN_ILLEGAL_INTERCHANGE \
 454     (UNICODE_WARN_SURROGATE|UNICODE_WARN_NONCHAR|UNICODE_WARN_SUPER)
 455 #define UNICODE_DISALLOW_ILLEGAL_INTERCHANGE \
 456     (UNICODE_DISALLOW_SURROGATE|UNICODE_DISALLOW_NONCHAR|UNICODE_DISALLOW_SUPER)
 457
 458 /* For backward source compatibility, as are now the default */
 459 #define UNICODE_ALLOW_SURROGATE 0
 460 #define UNICODE_ALLOW_SUPER     0
 461 #define UNICODE_ALLOW_ANY       0
 462
 463 #define UNICODE_IS_SURROGATE(c)         ((c) >= UNICODE_SURROGATE_FIRST && \
 464                                          (c) <= UNICODE_SURROGATE_LAST)
 465 #define UNICODE_IS_REPLACEMENT(c)       ((c) == UNICODE_REPLACEMENT)
 466 #define UNICODE_IS_BYTE_ORDER_MARK(c)   ((c) == UNICODE_BYTE_ORDER_MARK)
 467 #define UNICODE_IS_NONCHAR(c)           ((c >= 0xFDD0 && c <= 0xFDEF) \
 468                         /* The other noncharacters end in FFFE or FFFF, which  \
 469                          * the mask below catches both of, but beyond the last \
 470                          * official unicode code point, they aren't            \
 471                          * noncharacters, since those aren't Unicode           \
 472                          * characters at all */                                \
 473                         || ((((c & 0xFFFE) == 0xFFFE)) && ! UNICODE_IS_SUPER(c)))
 474 #define UNICODE_IS_SUPER(c)             ((c) > PERL_UNICODE_MAX)
 475 #define UNICODE_IS_FE_FF(c)             ((c) > 0x7FFFFFFF)
 476
 477 #ifdef HAS_QUAD
 478 #    define UTF8_QUAD_MAX       UINT64_C(0x1000000000)
 479 #endif
 480
 481 #define UNICODE_GREEK_CAPITAL_LETTER_SIGMA      0x03A3
 482 #define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA  0x03C2
 483 #define UNICODE_GREEK_SMALL_LETTER_SIGMA        0x03C3
 484 #define GREEK_SMALL_LETTER_MU                   0x03BC
 485 #define GREEK_CAPITAL_LETTER_MU 0x039C  /* Upper and title case of MICRON */
 486 #define LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS 0x0178    /* Also is title case */
 487 #define LATIN_CAPITAL_LETTER_SHARP_S    0x1E9E
 488 #define LATIN_SMALL_LETTER_LONG_S   0x017F
 489 #define KELVIN_SIGN                 0x212A
 490 #define ANGSTROM_SIGN               0x212B
 491
 492 #define UNI_DISPLAY_ISPRINT     0x0001
 493 #define UNI_DISPLAY_BACKSLASH   0x0002
 494 #define UNI_DISPLAY_QQ          (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
 495 #define UNI_DISPLAY_REGEX       (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
 496
 497 #ifndef EBCDIC
 498 #   define LATIN_SMALL_LETTER_SHARP_S   0x00DF
 499 #   define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS 0x00FF
 500 #   define MICRO_SIGN 0x00B5
 501 #   define LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE 0x00C5
 502 #   define LATIN_SMALL_LETTER_A_WITH_RING_ABOVE 0x00E5
 503 #endif
 504
 505 #define ANYOF_FOLD_SHARP_S(node, input, end)    \
 506         (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \
 507          (ANYOF_NONBITMAP(node)) && \
 508          (ANYOF_FLAGS(node) & ANYOF_LOC_NONBITMAP_FOLD) && \
 509          ((end) > (input) + 1) && \
 510          toLOWER((input)[0]) == 's' && \
 511          toLOWER((input)[1]) == 's')
 512 #define SHARP_S_SKIP 2
 513
 514 #ifndef EBCDIC
 515 /* If you want to exclude surrogates, and beyond legal Unicode, see the blame
 516  * log for earlier versions which gave details for these */
 517 #   define IS_UTF8_CHAR_1(p)    \
 518         ((p)[0] <= 0x7F)
 519 #   define IS_UTF8_CHAR_2(p)    \
 520         ((p)[0] >= 0xC2 && (p)[0] <= 0xDF && \
 521          (p)[1] >= 0x80 && (p)[1] <= 0xBF)
 522 #   define IS_UTF8_CHAR_3a(p)   \
 523         ((p)[0] == 0xE0 && \
 524          (p)[1] >= 0xA0 && (p)[1] <= 0xBF && \
 525          (p)[2] >= 0x80 && (p)[2] <= 0xBF)
 526 #   define IS_UTF8_CHAR_3b(p)   \
 527         ((p)[0] >= 0xE1 && (p)[0] <= 0xEF && \
 528          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
 529          (p)[2] >= 0x80 && (p)[2] <= 0xBF)
 530 #   define IS_UTF8_CHAR_4a(p)   \
 531         ((p)[0] == 0xF0 && \
 532          (p)[1] >= 0x90 && (p)[1] <= 0xBF && \
 533          (p)[2] >= 0x80 && (p)[2] <= 0xBF && \
 534          (p)[3] >= 0x80 && (p)[3] <= 0xBF)
 535 /* The 0xF7 allows us to go to 0x1fffff (0x200000 would
 536  * require five bytes).  Not doing any further code points
 537  * since that is not needed (and that would not be strict
 538  * UTF-8, anyway).  The "slow path" in Perl_is_utf8_char()
 539  * will take care of the "extended UTF-8". */
 540 #   define IS_UTF8_CHAR_4b(p)   \
 541         ((p)[0] >= 0xF1 && (p)[0] <= 0xF7 && \
 542          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
 543          (p)[2] >= 0x80 && (p)[2] <= 0xBF && \
 544          (p)[3] >= 0x80 && (p)[3] <= 0xBF)
 545
 546 #   define IS_UTF8_CHAR_3(p)    \
 547         (IS_UTF8_CHAR_3a(p) || \
 548          IS_UTF8_CHAR_3b(p))
 549 #   define IS_UTF8_CHAR_4(p)    \
 550         (IS_UTF8_CHAR_4a(p) || \
 551          IS_UTF8_CHAR_4b(p))
 552
 553 /* IS_UTF8_CHAR(p) is strictly speaking wrong (not UTF-8) because it
 554  * (1) allows UTF-8 encoded UTF-16 surrogates
 555  * (2) it allows code points past U+10FFFF.
 556  * The Perl_is_utf8_char() full "slow" code will handle the Perl
 557  * "extended UTF-8". */
 558 #   define IS_UTF8_CHAR(p, n)   \
 559         ((n) == 1 ? IS_UTF8_CHAR_1(p) : \
 560          (n) == 2 ? IS_UTF8_CHAR_2(p) : \
 561          (n) == 3 ? IS_UTF8_CHAR_3(p) : \
 562          (n) == 4 ? IS_UTF8_CHAR_4(p) : 0)
 563
 564 #   define IS_UTF8_CHAR_FAST(n) ((n) <= 4)
 565
 566 #else   /* EBCDIC */
 567
 568 /* This is an attempt to port IS_UTF8_CHAR to EBCDIC based on eyeballing.
 569  * untested.  If want to exclude surrogates and above-Unicode, see the
 570  * definitions for UTF8_IS_SURROGATE  and UTF8_IS_SUPER */
 571 #   define IS_UTF8_CHAR_1(p)    \
 572         (NATIVE_TO_ASCII((p)[0]) <= 0x9F)
 573 #   define IS_UTF8_CHAR_2(p)    \
 574         (NATIVE_TO_I8((p)[0]) >= 0xC5 && NATIVE_TO_I8((p)[0]) <= 0xDF && \
 575          NATIVE_TO_I8((p)[1]) >= 0xA0 && NATIVE_TO_I8((p)[1]) <= 0xBF)
 576 #   define IS_UTF8_CHAR_3(p)    \
 577         (NATIVE_TO_I8((p)[0]) == 0xE1 && NATIVE_TO_I8((p)[1]) <= 0xEF && \
 578          NATIVE_TO_I8((p)[1]) >= 0xA0 && NATIVE_TO_I8((p)[1]) <= 0xBF && \
 579          NATIVE_TO_I8((p)[2]) >= 0xA0 && NATIVE_TO_I8((p)[2]) <= 0xBF)
 580 #   define IS_UTF8_CHAR_4a(p)   \
 581         (NATIVE_TO_I8((p)[0]) == 0xF0 && \
 582          NATIVE_TO_I8((p)[1]) >= 0xB0 && NATIVE_TO_I8((p)[1]) <= 0xBF && \
 583          NATIVE_TO_I8((p)[2]) >= 0xA0 && NATIVE_TO_I8((p)[2]) <= 0xBF && \
 584          NATIVE_TO_I8((p)[3]) >= 0xA0 && NATIVE_TO_I8((p)[3]) <= 0xBF)
 585 #   define IS_UTF8_CHAR_4b(p)   \
 586         (NATIVE_TO_I8((p)[0]) >= 0xF1 && NATIVE_TO_I8((p)[0]) <= 0xF7 && \
 587          NATIVE_TO_I8((p)[1]) >= 0xA0 && NATIVE_TO_I8((p)[1]) <= 0xBF && \
 588          NATIVE_TO_I8((p)[2]) >= 0xA0 && NATIVE_TO_I8((p)[2]) <= 0xBF && \
 589          NATIVE_TO_I8((p)[3]) >= 0xA0 && NATIVE_TO_I8((p)[3]) <= 0xBF)
 590 #   define IS_UTF8_CHAR_5a(p)   \
 591         (NATIVE_TO_I8((p)[0]) == 0xF8 && \
 592          NATIVE_TO_I8((p)[1]) >= 0xA8 && NATIVE_TO_I8((p)[1]) <= 0xBF && \
 593          NATIVE_TO_I8((p)[1]) >= 0xA0 && NATIVE_TO_I8((p)[1]) <= 0xBF && \
 594          NATIVE_TO_I8((p)[2]) >= 0xA0 && NATIVE_TO_I8((p)[2]) <= 0xBF && \
 595          NATIVE_TO_I8((p)[3]) >= 0xA0 && NATIVE_TO_I8((p)[3]) <= 0xBF)
 596 #   define IS_UTF8_CHAR_5b(p)   \
 597          (NATIVE_TO_I8((p)[0]) >= 0xF9 && NATIVE_TO_I8((p)[1]) <= 0xFB && \
 598          NATIVE_TO_I8((p)[1]) >= 0xA0 && NATIVE_TO_I8((p)[1]) <= 0xBF && \
 599          NATIVE_TO_I8((p)[1]) >= 0xA0 && NATIVE_TO_I8((p)[1]) <= 0xBF && \
 600          NATIVE_TO_I8((p)[2]) >= 0xA0 && NATIVE_TO_I8((p)[2]) <= 0xBF && \
 601          NATIVE_TO_I8((p)[3]) >= 0xA0 && NATIVE_TO_I8((p)[3]) <= 0xBF)
 602
 603 #   define IS_UTF8_CHAR_4(p)    \
 604         (IS_UTF8_CHAR_4a(p) || \
 605          IS_UTF8_CHAR_4b(p))
 606 #   define IS_UTF8_CHAR_5(p)    \
 607         (IS_UTF8_CHAR_5a(p) || \
 608          IS_UTF8_CHAR_5b(p))
 609 #   define IS_UTF8_CHAR(p, n)   \
 610         ((n) == 1 ? IS_UTF8_CHAR_1(p) : \
 611          (n) == 2 ? IS_UTF8_CHAR_2(p) : \
 612          (n) == 3 ? IS_UTF8_CHAR_3(p) : \
 613          (n) == 4 ? IS_UTF8_CHAR_4(p) : \
 614          (n) == 5 ? IS_UTF8_CHAR_5(p) : 0)
 615
 616 #   define IS_UTF8_CHAR_FAST(n) ((n) <= 5)
 617
 618 #endif /* IS_UTF8_CHAR() for UTF-8 */
 619
 620 /*
 621  * Local variables:
 622  * c-indentation-style: bsd
 623  * c-basic-offset: 4
 624  * indent-tabs-mode: nil
 625  * End:
 626  *
 627  * ex: set ts=8 sts=4 sw=4 et:
 628  */