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