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 /*
  24 =for apidoc ibcmp_utf8
  25
  26 This is a synonym for (! foldEQ_utf8())
  27
  28 =cut
  29 */
  30 #define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
  31                     cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2))
  32
  33 #ifdef EBCDIC
  34 /* The equivalent of these macros but implementing UTF-EBCDIC
  35    are in the following header file:
  36  */
  37
  38 #include "utfebcdic.h"
  39
  40 #else   /* ! EBCDIC */
  41 START_EXTERN_C
  42
  43 #ifdef DOINIT
  44 EXTCONST unsigned char PL_utf8skip[] = {
  45 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 */
  46 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 */
  47 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 */
  48 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 */
  49 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 */
  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, /* bogus */
  51 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 */
  52 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. */
  53 7,13, /* Perl extended (not UTF-8).  Up to 72bit allowed (64-bit + reserved). */
  54 };
  55 #else
  56 EXTCONST unsigned char PL_utf8skip[];
  57 #endif
  58
  59 END_EXTERN_C
  60
  61 /* Native character to iso-8859-1 */
  62 #define NATIVE_TO_ASCII(ch)      (ch)
  63 #define ASCII_TO_NATIVE(ch)      (ch)
  64 /* Transform after encoding */
  65 #define NATIVE_TO_UTF(ch)        (ch)
  66 #define UTF_TO_NATIVE(ch)        (ch)
  67 /* Transforms in wide UV chars */
  68 #define UNI_TO_NATIVE(ch)        (ch)
  69 #define NATIVE_TO_UNI(ch)        (ch)
  70 /* Transforms in invariant space */
  71 #define NATIVE_TO_NEED(enc,ch)   (ch)
  72 #define ASCII_TO_NEED(enc,ch)    (ch)
  73
  74 /* As there are no translations, avoid the function wrapper */
  75 #define utf8n_to_uvchr utf8n_to_uvuni
  76 #define uvchr_to_utf8  uvuni_to_utf8
  77
  78 /*
  79
  80  The following table is from Unicode 3.2.
  81
  82  Code Points            1st Byte  2nd Byte  3rd Byte  4th Byte
  83
  84    U+0000..U+007F       00..7F
  85    U+0080..U+07FF     * C2..DF    80..BF
  86    U+0800..U+0FFF       E0      * A0..BF    80..BF
  87    U+1000..U+CFFF       E1..EC    80..BF    80..BF
  88    U+D000..U+D7FF       ED        80..9F    80..BF
  89    U+D800..U+DFFF       +++++++ utf16 surrogates, not legal utf8 +++++++
  90    U+E000..U+FFFF       EE..EF    80..BF    80..BF
  91   U+10000..U+3FFFF      F0      * 90..BF    80..BF    80..BF
  92   U+40000..U+FFFFF      F1..F3    80..BF    80..BF    80..BF
  93  U+100000..U+10FFFF     F4        80..8F    80..BF    80..BF
  94
  95 Note the gaps before several of the byte entries above marked by '*'.  These are
  96 caused by legal UTF-8 avoiding non-shortest encodings: it is technically
  97 possible to UTF-8-encode a single code point in different ways, but that is
  98 explicitly forbidden, and the shortest possible encoding should always be used
  99 (and that is what Perl does).
 100
 101  */
 102
 103 /*
 104  Another way to look at it, as bits:
 105
 106  Code Points                    1st Byte   2nd Byte  3rd Byte  4th Byte
 107
 108                     0aaaaaaa     0aaaaaaa
 109             00000bbbbbaaaaaa     110bbbbb  10aaaaaa
 110             ccccbbbbbbaaaaaa     1110cccc  10bbbbbb  10aaaaaa
 111   00000dddccccccbbbbbbaaaaaa     11110ddd  10cccccc  10bbbbbb  10aaaaaa
 112
 113 As you can see, the continuation bytes all begin with C<10>, and the
 114 leading bits of the start byte tell how many bytes there are in the
 115 encoded character.
 116
 117 Perl's extended UTF-8 means we can have start bytes up to FF.
 118
 119 */
 120
 121
 122 #define UNI_IS_INVARIANT(c)             (((UV)c) <  0x80)
 123 /* Note that C0 and C1 are invalid in legal UTF8, so the lower bound of the
 124  * below might ought to be C2 */
 125 #define UTF8_IS_START(c)                (((U8)c) >= 0xc0)
 126 #define UTF8_IS_CONTINUATION(c)         (((U8)c) >= 0x80 && (((U8)c) <= 0xbf))
 127 #define UTF8_IS_CONTINUED(c)            (((U8)c) &  0x80)
 128 #define UTF8_IS_DOWNGRADEABLE_START(c)  (((U8)c & 0xfc) == 0xc0)
 129
 130 #define UTF_START_MARK(len) (((len) >  7) ? 0xFF : (0xFE << (7-(len))))
 131 #define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2)))
 132
 133 #define UTF_CONTINUATION_MARK           0x80
 134 #define UTF_ACCUMULATION_SHIFT          6
 135 #define UTF_CONTINUATION_MASK           ((U8)0x3f)
 136
 137 #ifdef HAS_QUAD
 138 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
 139                       (uv) < 0x800          ? 2 : \
 140                       (uv) < 0x10000        ? 3 : \
 141                       (uv) < 0x200000       ? 4 : \
 142                       (uv) < 0x4000000      ? 5 : \
 143                       (uv) < 0x80000000     ? 6 : \
 144                       (uv) < UTF8_QUAD_MAX ? 7 : 13 )
 145 #else
 146 /* No, I'm not even going to *TRY* putting #ifdef inside a #define */
 147 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
 148                       (uv) < 0x800          ? 2 : \
 149                       (uv) < 0x10000        ? 3 : \
 150                       (uv) < 0x200000       ? 4 : \
 151                       (uv) < 0x4000000      ? 5 : \
 152                       (uv) < 0x80000000     ? 6 : 7 )
 153 #endif
 154
 155 #endif /* EBCDIC vs ASCII */
 156
 157 /* Rest of these are attributes of Unicode and perl's internals rather than the
 158  * encoding, or happen to be the same in both ASCII and EBCDIC (at least at
 159  * this level; the macros that some of these call may have different
 160  * definitions in the two encodings */
 161
 162 #define NATIVE8_TO_UNI(ch)     NATIVE_TO_ASCII(ch)      /* a clearer synonym */
 163
 164 #define UTF8_ACCUMULATE(old, new)       (((old) << UTF_ACCUMULATION_SHIFT) | (((U8)new) & UTF_CONTINUATION_MASK))
 165
 166 #define UTF8SKIP(s) PL_utf8skip[*(const U8*)(s)]
 167
 168 #define UTF8_IS_INVARIANT(c)            UNI_IS_INVARIANT(NATIVE_TO_UTF(c))
 169 #define NATIVE_IS_INVARIANT(c)          UNI_IS_INVARIANT(NATIVE8_TO_UNI(c))
 170
 171 #define MAX_PORTABLE_UTF8_TWO_BYTE 0x3FF    /* constrained by EBCDIC */
 172
 173 /* The macros in the next sets are used to generate the two utf8 or utfebcdic
 174  * bytes from an ordinal that is known to fit into two bytes; it must be less
 175  * than 0x3FF to work across both encodings. */
 176 /* Nocast allows these to be used in the case label of a switch statement */
 177 #define UTF8_TWO_BYTE_HI_nocast(c)      UTF_TO_NATIVE(((c)>>UTF_ACCUMULATION_SHIFT)|UTF_START_MARK(2))
 178 #define UTF8_TWO_BYTE_LO_nocast(c)      UTF_TO_NATIVE(((c)&UTF_CONTINUATION_MASK)|UTF_CONTINUATION_MARK)
 179
 180 #define UTF8_TWO_BYTE_HI(c)     ((U8) (UTF8_TWO_BYTE_HI_nocast(c)))
 181 #define UTF8_TWO_BYTE_LO(c)     ((U8) (UTF8_TWO_BYTE_LO_nocast(c)))
 182
 183 /* This name is used when the source is a single byte */
 184 #define UTF8_EIGHT_BIT_HI(c)    UTF8_TWO_BYTE_HI((U8)(c))
 185 #define UTF8_EIGHT_BIT_LO(c)    UTF8_TWO_BYTE_LO((U8)(c))
 186
 187 /*
 188  * Note: we try to be careful never to call the isXXX_utf8() functions
 189  * unless we're pretty sure we've seen the beginning of a UTF-8 or UTFEBCDIC
 190  * character.  Otherwise we risk loading in the heavy-duty swash_init and
 191  * swash_fetch routines unnecessarily.
 192  */
 193 #define isIDFIRST_lazy_if(p,c) ((IN_BYTES || (!c || ! UTF8_IS_START(*((const U8*)p)))) \
 194                                 ? isIDFIRST(*(p)) \
 195                                 : isIDFIRST_utf8((const U8*)p))
 196 #define isALNUM_lazy_if(p,c)   ((IN_BYTES || (!c || ! UTF8_IS_START(*((const U8*)p)))) \
 197                                 ? isALNUM(*(p)) \
 198                                 : isALNUM_utf8((const U8*)p))
 199
 200 #define isIDFIRST_lazy(p)       isIDFIRST_lazy_if(p,1)
 201 #define isALNUM_lazy(p)         isALNUM_lazy_if(p,1)
 202
 203 #define UTF8_MAXBYTES 13
 204 /* How wide can a single UTF-8 encoded character become in bytes.
 205  * NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8
 206  * since UTF-8 is an encoding of Unicode and given Unicode's current
 207  * upper limit only four bytes is possible.  Perl thinks of UTF-8
 208  * as a way to encode non-negative integers in a binary format. */
 209 #define UTF8_MAXLEN UTF8_MAXBYTES
 210
 211 /* The maximum number of UTF-8 bytes a single Unicode character can
 212  * uppercase/lowercase/fold into; this number depends on the Unicode
 213  * version.  An example of maximal expansion is the U+03B0 which
 214  * uppercases to U+03C5 U+0308 U+0301.  The Unicode databases that
 215  * tell these things are UnicodeData.txt, CaseFolding.txt, and
 216  * SpecialCasing.txt. */
 217 #define UTF8_MAXBYTES_CASE      6
 218
 219 #define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES)
 220 #define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
 221 #define IN_UNI_8_BIT ( (CopHINTS_get(PL_curcop) & HINT_UNI_8_BIT) \
 222                         && ! IN_LOCALE_RUNTIME && ! IN_BYTES)
 223
 224 #define UTF8_ALLOW_EMPTY                0x0001
 225 #define UTF8_ALLOW_CONTINUATION         0x0002
 226 #define UTF8_ALLOW_NON_CONTINUATION     0x0004
 227 #define UTF8_ALLOW_FE_FF                0x0008 /* Allow FE or FF start bytes, \
 228                                                   yields above 0x7fffFFFF */
 229 #define UTF8_ALLOW_SHORT                0x0010 /* expecting more bytes */
 230 #define UTF8_ALLOW_SURROGATE            0x0020
 231 #define UTF8_ALLOW_FFFF                 0x0040 /* Allow UNICODE_ILLEGAL */
 232 #define UTF8_ALLOW_LONG                 0x0080 /* expecting fewer bytes */
 233 #define UTF8_ALLOW_ANYUV                (UTF8_ALLOW_EMPTY|UTF8_ALLOW_FE_FF|\
 234                                          UTF8_ALLOW_SURROGATE|UTF8_ALLOW_FFFF)
 235 #define UTF8_ALLOW_ANY                  0x00FF
 236 #define UTF8_CHECK_ONLY                 0x0200
 237 #define UTF8_ALLOW_DEFAULT              (ckWARN(WARN_UTF8) ? 0 : \
 238                                          UTF8_ALLOW_ANYUV)
 239
 240 #define UNICODE_SURROGATE_FIRST         0xD800
 241 #define UNICODE_SURROGATE_LAST          0xDFFF
 242 #define UNICODE_REPLACEMENT             0xFFFD
 243 #define UNICODE_BYTE_ORDER_MARK         0xFEFF
 244 #define UNICODE_ILLEGAL                 0xFFFF
 245
 246 /* Though our UTF-8 encoding can go beyond this,
 247  * let's be conservative and do as Unicode 5.1 says. */
 248 #define PERL_UNICODE_MAX        0x10FFFF
 249
 250 #define UNICODE_ALLOW_SURROGATE 0x0001  /* Allow UTF-16 surrogates (EVIL) */
 251 #define UNICODE_ALLOW_FDD0      0x0002  /* Allow the U+FDD0...U+FDEF */
 252 #define UNICODE_ALLOW_FFFF      0x0004  /* Allow U+FFF[EF], U+1FFF[EF], ... */
 253 #define UNICODE_ALLOW_SUPER     0x0008  /* Allow past 0x10FFFF */
 254 #define UNICODE_ALLOW_ANY       0x000F
 255
 256 #define UNICODE_IS_SURROGATE(c)         ((c) >= UNICODE_SURROGATE_FIRST && \
 257                                          (c) <= UNICODE_SURROGATE_LAST)
 258 #define UNICODE_IS_REPLACEMENT(c)       ((c) == UNICODE_REPLACEMENT)
 259 #define UNICODE_IS_BYTE_ORDER_MARK(c)   ((c) == UNICODE_BYTE_ORDER_MARK)
 260 #define UNICODE_IS_ILLEGAL(c)           ((c) == UNICODE_ILLEGAL)
 261
 262 #ifdef HAS_QUAD
 263 #    define UTF8_QUAD_MAX       UINT64_C(0x1000000000)
 264 #endif
 265
 266 #define UNICODE_GREEK_CAPITAL_LETTER_SIGMA      0x03A3
 267 #define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA  0x03C2
 268 #define UNICODE_GREEK_SMALL_LETTER_SIGMA        0x03C3
 269
 270 #define UNI_DISPLAY_ISPRINT     0x0001
 271 #define UNI_DISPLAY_BACKSLASH   0x0002
 272 #define UNI_DISPLAY_QQ          (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
 273 #define UNI_DISPLAY_REGEX       (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
 274
 275 #ifndef EBCDIC
 276 #   define LATIN_SMALL_LETTER_SHARP_S   0x00DF
 277 #   define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS 0x00FF
 278 #   define MICRO_SIGN 0x00B5
 279 #endif
 280
 281 #define ANYOF_FOLD_SHARP_S(node, input, end)    \
 282         (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \
 283          (ANYOF_FLAGS(node) & ANYOF_UNICODE) && \
 284          (ANYOF_FLAGS(node) & ANYOF_FOLD) && \
 285          ((end) > (input) + 1) && \
 286          toLOWER((input)[0]) == 's' && \
 287          toLOWER((input)[1]) == 's')
 288 #define SHARP_S_SKIP 2
 289
 290 #ifdef EBCDIC
 291 /* IS_UTF8_CHAR() is not ported to EBCDIC */
 292 #else
 293 #define IS_UTF8_CHAR_1(p)       \
 294         ((p)[0] <= 0x7F)
 295 #define IS_UTF8_CHAR_2(p)       \
 296         ((p)[0] >= 0xC2 && (p)[0] <= 0xDF && \
 297          (p)[1] >= 0x80 && (p)[1] <= 0xBF)
 298 #define IS_UTF8_CHAR_3a(p)      \
 299         ((p)[0] == 0xE0 && \
 300          (p)[1] >= 0xA0 && (p)[1] <= 0xBF && \
 301          (p)[2] >= 0x80 && (p)[2] <= 0xBF)
 302 #define IS_UTF8_CHAR_3b(p)      \
 303         ((p)[0] >= 0xE1 && (p)[0] <= 0xEC && \
 304          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
 305          (p)[2] >= 0x80 && (p)[2] <= 0xBF)
 306 #define IS_UTF8_CHAR_3c(p)      \
 307         ((p)[0] == 0xED && \
 308          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
 309          (p)[2] >= 0x80 && (p)[2] <= 0xBF)
 310 /* In IS_UTF8_CHAR_3c(p) one could use
 311  * (p)[1] >= 0x80 && (p)[1] <= 0x9F
 312  * if one wanted to exclude surrogates. */
 313 #define IS_UTF8_CHAR_3d(p)      \
 314         ((p)[0] >= 0xEE && (p)[0] <= 0xEF && \
 315          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
 316          (p)[2] >= 0x80 && (p)[2] <= 0xBF)
 317 #define IS_UTF8_CHAR_4a(p)      \
 318         ((p)[0] == 0xF0 && \
 319          (p)[1] >= 0x90 && (p)[1] <= 0xBF && \
 320          (p)[2] >= 0x80 && (p)[2] <= 0xBF && \
 321          (p)[3] >= 0x80 && (p)[3] <= 0xBF)
 322 #define IS_UTF8_CHAR_4b(p)      \
 323         ((p)[0] >= 0xF1 && (p)[0] <= 0xF3 && \
 324          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
 325          (p)[2] >= 0x80 && (p)[2] <= 0xBF && \
 326          (p)[3] >= 0x80 && (p)[3] <= 0xBF)
 327 /* In IS_UTF8_CHAR_4c(p) one could use
 328  * (p)[0] == 0xF4
 329  * if one wanted to stop at the Unicode limit U+10FFFF.
 330  * The 0xF7 allows us to go to 0x1fffff (0x200000 would
 331  * require five bytes).  Not doing any further code points
 332  * since that is not needed (and that would not be strict
 333  * UTF-8, anyway).  The "slow path" in Perl_is_utf8_char()
 334  * will take care of the "extended UTF-8". */
 335 #define IS_UTF8_CHAR_4c(p)      \
 336         ((p)[0] == 0xF4 && (p)[0] <= 0xF7 && \
 337          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
 338          (p)[2] >= 0x80 && (p)[2] <= 0xBF && \
 339          (p)[3] >= 0x80 && (p)[3] <= 0xBF)
 340
 341 #define IS_UTF8_CHAR_3(p)       \
 342         (IS_UTF8_CHAR_3a(p) || \
 343          IS_UTF8_CHAR_3b(p) || \
 344          IS_UTF8_CHAR_3c(p) || \
 345          IS_UTF8_CHAR_3d(p))
 346 #define IS_UTF8_CHAR_4(p)       \
 347         (IS_UTF8_CHAR_4a(p) || \
 348          IS_UTF8_CHAR_4b(p) || \
 349          IS_UTF8_CHAR_4c(p))
 350
 351 /* IS_UTF8_CHAR(p) is strictly speaking wrong (not UTF-8) because it
 352  * (1) allows UTF-8 encoded UTF-16 surrogates
 353  * (2) it allows code points past U+10FFFF.
 354  * The Perl_is_utf8_char() full "slow" code will handle the Perl
 355  * "extended UTF-8". */
 356 #define IS_UTF8_CHAR(p, n)      \
 357         ((n) == 1 ? IS_UTF8_CHAR_1(p) : \
 358          (n) == 2 ? IS_UTF8_CHAR_2(p) : \
 359          (n) == 3 ? IS_UTF8_CHAR_3(p) : \
 360          (n) == 4 ? IS_UTF8_CHAR_4(p) : 0)
 361
 362 #define IS_UTF8_CHAR_FAST(n) ((n) <= 4)
 363
 364 #endif /* IS_UTF8_CHAR() for UTF-8 */
 365
 366 /*
 367  * Local variables:
 368  * c-indentation-style: bsd
 369  * c-basic-offset: 4
 370  * indent-tabs-mode: t
 371  * End:
 372  *
 373  * ex: set ts=8 sts=4 sw=4 noet:
 374  */