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