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