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