utf8.h

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