Bumped Cwd and File::Spec versions for release per cmpVERSION.pl
[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 /* 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 #define UNI_IS_INVARIANT(c)             (((UV)c) <  0x80)
122 /* Note that C0 and C1 are invalid in legal UTF8, so the lower bound of the
123  * below might ought to be C2 */
124 #define UTF8_IS_START(c)                (((U8)c) >= 0xc0)
125 #define UTF8_IS_CONTINUATION(c)         (((U8)c) >= 0x80 && (((U8)c) <= 0xbf))
126 #define UTF8_IS_CONTINUED(c)            (((U8)c) &  0x80)
127 #define UTF8_IS_DOWNGRADEABLE_START(c)  (((U8)c & 0xfc) == 0xc0)
128
129 #define UTF_START_MARK(len) (((len) >  7) ? 0xFF : (0xFE << (7-(len))))
130 #define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2)))
131
132 #define UTF_CONTINUATION_MARK           0x80
133 #define UTF_ACCUMULATION_SHIFT          6
134 #define UTF_CONTINUATION_MASK           ((U8)0x3f)
135
136 #ifdef HAS_QUAD
137 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
138                       (uv) < 0x800          ? 2 : \
139                       (uv) < 0x10000        ? 3 : \
140                       (uv) < 0x200000       ? 4 : \
141                       (uv) < 0x4000000      ? 5 : \
142                       (uv) < 0x80000000     ? 6 : \
143                       (uv) < UTF8_QUAD_MAX ? 7 : 13 )
144 #else
145 /* No, I'm not even going to *TRY* putting #ifdef inside a #define */
146 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
147                       (uv) < 0x800          ? 2 : \
148                       (uv) < 0x10000        ? 3 : \
149                       (uv) < 0x200000       ? 4 : \
150                       (uv) < 0x4000000      ? 5 : \
151                       (uv) < 0x80000000     ? 6 : 7 )
152 #endif
153
154 #endif /* EBCDIC vs ASCII */
155
156 /* Rest of these are attributes of Unicode and perl's internals rather than the
157  * encoding, or happen to be the same in both ASCII and EBCDIC (at least at
158  * this level; the macros that some of these call may have different
159  * definitions in the two encodings */
160
161 #define NATIVE8_TO_UNI(ch)     NATIVE_TO_ASCII(ch)      /* a clearer synonym */
162
163 #define UTF8_ACCUMULATE(old, new)       (((old) << UTF_ACCUMULATION_SHIFT) | (((U8)new) & UTF_CONTINUATION_MASK))
164
165 /* Convert a two (not one) byte utf8 character to a unicode code point value.
166  * Needs just one iteration of accumulate.  Should not be used unless it is
167  * known that the two bytes are legal: 1) two-byte start, and 2) continuation.
168  * Note that the result can be larger than 255 if the input character is not
169  * downgradable */
170 #define TWO_BYTE_UTF8_TO_UNI(HI, LO) \
171                     UTF8_ACCUMULATE((NATIVE_TO_UTF(HI) & UTF_START_MASK(2)), \
172                                      NATIVE_TO_UTF(LO))
173
174 #define UTF8SKIP(s) PL_utf8skip[*(const U8*)(s)]
175
176 #define UTF8_IS_INVARIANT(c)            UNI_IS_INVARIANT(NATIVE_TO_UTF(c))
177 #define NATIVE_IS_INVARIANT(c)          UNI_IS_INVARIANT(NATIVE8_TO_UNI(c))
178
179 #define MAX_PORTABLE_UTF8_TWO_BYTE 0x3FF    /* constrained by EBCDIC */
180
181 /* The macros in the next sets are used to generate the two utf8 or utfebcdic
182  * bytes from an ordinal that is known to fit into two bytes; it must be less
183  * than 0x3FF to work across both encodings. */
184 /* Nocast allows these to be used in the case label of a switch statement */
185 #define UTF8_TWO_BYTE_HI_nocast(c)      UTF_TO_NATIVE(((c) >> UTF_ACCUMULATION_SHIFT) | (0xFF & UTF_START_MARK(2)))
186 #define UTF8_TWO_BYTE_LO_nocast(c)      UTF_TO_NATIVE(((c) & UTF_CONTINUATION_MASK) | UTF_CONTINUATION_MARK)
187
188 #define UTF8_TWO_BYTE_HI(c)     ((U8) (UTF8_TWO_BYTE_HI_nocast(c)))
189 #define UTF8_TWO_BYTE_LO(c)     ((U8) (UTF8_TWO_BYTE_LO_nocast(c)))
190
191 /* This name is used when the source is a single byte */
192 #define UTF8_EIGHT_BIT_HI(c)    UTF8_TWO_BYTE_HI((U8)(c))
193 #define UTF8_EIGHT_BIT_LO(c)    UTF8_TWO_BYTE_LO((U8)(c))
194
195 /*
196  * Note: we try to be careful never to call the isXXX_utf8() functions
197  * unless we're pretty sure we've seen the beginning of a UTF-8 or UTFEBCDIC
198  * character.  Otherwise we risk loading in the heavy-duty swash_init and
199  * swash_fetch routines unnecessarily.
200  */
201 #define isIDFIRST_lazy_if(p,c) ((IN_BYTES || (!c || ! UTF8_IS_START(*((const U8*)p)))) \
202                                 ? isIDFIRST(*(p)) \
203                                 : isIDFIRST_utf8((const U8*)p))
204 #define isALNUM_lazy_if(p,c)   ((IN_BYTES || (!c || ! UTF8_IS_START(*((const U8*)p)))) \
205                                 ? isALNUM(*(p)) \
206                                 : isALNUM_utf8((const U8*)p))
207
208 #define isIDFIRST_lazy(p)       isIDFIRST_lazy_if(p,1)
209 #define isALNUM_lazy(p)         isALNUM_lazy_if(p,1)
210
211 #define UTF8_MAXBYTES 13
212 /* How wide can a single UTF-8 encoded character become in bytes.
213  * NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8
214  * since UTF-8 is an encoding of Unicode and given Unicode's current
215  * upper limit only four bytes is possible.  Perl thinks of UTF-8
216  * as a way to encode non-negative integers in a binary format. */
217 #define UTF8_MAXLEN UTF8_MAXBYTES
218
219 /* The maximum number of UTF-8 bytes a single Unicode character can
220  * uppercase/lowercase/fold into; this number depends on the Unicode
221  * version.  An example of maximal expansion is the U+03B0 which
222  * uppercases to U+03C5 U+0308 U+0301.  The Unicode databases that
223  * tell these things are UnicodeData.txt, CaseFolding.txt, and
224  * SpecialCasing.txt. */
225 #define UTF8_MAXBYTES_CASE      6
226
227 /* A Unicode character can fold to up to 3 characters */
228 #define UTF8_MAX_FOLD_CHAR_EXPAND 3
229
230 #define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES)
231 #define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
232 #define IN_UNI_8_BIT ( (CopHINTS_get(PL_curcop) & HINT_UNI_8_BIT) \
233                         && ! IN_LOCALE_RUNTIME && ! IN_BYTES)
234
235 #define UTF8_ALLOW_EMPTY                0x0001  /* Allow a zero length string */
236
237 /* Allow first byte to be a continuation byte */
238 #define UTF8_ALLOW_CONTINUATION         0x0002
239
240 /* Allow second... bytes to be non-continuation bytes */
241 #define UTF8_ALLOW_NON_CONTINUATION     0x0004
242
243 /* expecting more bytes than were available in the string */
244 #define UTF8_ALLOW_SHORT                0x0008
245
246 /* Overlong sequence; i.e., the code point can be specified in fewer bytes. */
247 #define UTF8_ALLOW_LONG                 0x0010
248
249 #define UTF8_DISALLOW_SURROGATE         0x0020  /* Unicode surrogates */
250 #define UTF8_WARN_SURROGATE             0x0040
251
252 #define UTF8_DISALLOW_NONCHAR           0x0080  /* Unicode non-character */
253 #define UTF8_WARN_NONCHAR               0x0100  /*  code points */
254
255 #define UTF8_DISALLOW_SUPER             0x0200  /* Super-set of Unicode: code */
256 #define UTF8_WARN_SUPER                 0x0400  /* points above the legal max */
257
258 /* Code points which never were part of the original UTF-8 standard, the first
259  * byte of which is a FE or FF on ASCII platforms. */
260 #define UTF8_DISALLOW_FE_FF             0x0800
261 #define UTF8_WARN_FE_FF                 0x1000
262
263 #define UTF8_CHECK_ONLY                 0x2000
264
265 /* For backwards source compatibility.  They do nothing, as the default now
266  * includes what they used to mean.  The first one's meaning was to allow the
267  * just the single non-character 0xFFFF */
268 #define UTF8_ALLOW_FFFF 0
269 #define UTF8_ALLOW_SURROGATE 0
270
271 #define UTF8_DISALLOW_ILLEGAL_INTERCHANGE \
272             (UTF8_DISALLOW_SUPER|UTF8_DISALLOW_NONCHAR|UTF8_DISALLOW_SURROGATE)
273 #define UTF8_WARN_ILLEGAL_INTERCHANGE \
274                         (UTF8_WARN_SUPER|UTF8_WARN_NONCHAR|UTF8_WARN_SURROGATE)
275 #define UTF8_ALLOW_ANY \
276             (~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
277 #define UTF8_ALLOW_ANYUV                                                        \
278          (UTF8_ALLOW_EMPTY                                                      \
279           & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
280 #define UTF8_ALLOW_DEFAULT              (ckWARN(WARN_UTF8) ? 0 : \
281                                          UTF8_ALLOW_ANYUV)
282
283 /* Surrogates, non-character code points and above-Unicode code points are
284  * problematic in some contexts.  This allows code that needs to check for
285  * those to to quickly exclude the vast majority of code points it will
286  * encounter */
287 #ifdef EBCDIC
288 #   define UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE UTF_TO_NATIVE(0xF1)
289 #else
290 #   define UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE 0xED
291 #endif
292
293 /*              ASCII              EBCDIC I8
294  * U+D7FF:   \xED\x9F\xBF       \xF1\xB5\xBF\xBF    last before surrogates
295  * U+D800:   \xED\xA0\x80       \xF1\xB6\xA0\xA0    1st surrogate
296  * U+DFFF:   \xED\xBF\xBF       \xF1\xB7\xBF\xBF    final surrogate
297  * U+E000:   \xEE\x80\x80       \xF1\xB8\xA0\xA0    next after surrogates
298  */
299 #ifdef EBCDIC /* Both versions assume well-formed UTF8 */
300 #   define UTF8_IS_SURROGATE(s)  (*(s) == UTF_TO_NATIVE(0xF1)                   \
301       && (*((s) +1) == UTF_TO_NATIVE(0xB6)) || *((s) + 1) == UTF_TO_NATIVE(0xB7))
302 #else
303 #   define UTF8_IS_SURROGATE(s) (*(s) == 0xED && *((s) + 1) >= 0xA0)
304 #endif
305
306 /*                ASCII              EBCDIC I8
307  * U+10FFFF: \xF4\x8F\xBF\xBF   \xF9\xA1\xBF\xBF\xBF    max legal Unicode
308  * U+110000: \xF4\x90\x80\x80   \xF9\xA2\xA0\xA0\xA0
309  * U+110001: \xF4\x90\x80\x81   \xF9\xA2\xA0\xA0\xA1
310  */
311 #ifdef EBCDIC /* Both versions assume well-formed UTF8 */
312 #   define UTF8_IS_SUPER(s)  (*(s) >= UTF_TO_NATIVE(0xF9)                       \
313       && (*(s) > UTF_TO_NATIVE(0xF9) || (*((s) + 1) >= UTF_TO_NATIVE(0xA2))))
314 #else
315 #   define UTF8_IS_SUPER(s)  (*(s) >= 0xF4                                      \
316                                         && (*(s) > 0xF4 || (*((s) + 1) >= 0x90)))
317 #endif
318
319 /*         ASCII                     EBCDIC I8
320  * U+FDCF: \xEF\xB7\x8F         \xF1\xBF\xAE\xAF        last before non-char block
321  * U+FDD0: \xEF\xB7\x90         \xF1\xBF\xAE\xB0        first non-char in block
322  * U+FDEF: \xEF\xB7\xAF         \xF1\xBF\xAF\xAF        last non-char in block
323  * U+FDF0: \xEF\xB7\xB0         \xF1\xBF\xAF\xB0        first after non-char block
324  * U+FFFF: \xEF\xBF\xBF         \xF1\xBF\xBF\xBF
325  * U+1FFFF: \xF0\x9F\xBF\xBF    \xF3\xBF\xBF\xBF
326  * U+2FFFF: \xF0\xAF\xBF\xBF    \xF5\xBF\xBF\xBF
327  * U+3FFFF: \xF0\xBF\xBF\xBF    \xF7\xBF\xBF\xBF
328  * U+4FFFF: \xF1\x8F\xBF\xBF    \xF8\xA9\xBF\xBF\xBF
329  * U+5FFFF: \xF1\x9F\xBF\xBF    \xF8\xAB\xBF\xBF\xBF
330  * U+6FFFF: \xF1\xAF\xBF\xBF    \xF8\xAD\xBF\xBF\xBF
331  * U+7FFFF: \xF1\xBF\xBF\xBF    \xF8\xAF\xBF\xBF\xBF
332  * U+8FFFF: \xF2\x8F\xBF\xBF    \xF8\xB1\xBF\xBF\xBF
333  * U+9FFFF: \xF2\x9F\xBF\xBF    \xF8\xB3\xBF\xBF\xBF
334  * U+AFFFF: \xF2\xAF\xBF\xBF    \xF8\xB5\xBF\xBF\xBF
335  * U+BFFFF: \xF2\xBF\xBF\xBF    \xF8\xB7\xBF\xBF\xBF
336  * U+CFFFF: \xF3\x8F\xBF\xBF    \xF8\xB9\xBF\xBF\xBF
337  * U+DFFFF: \xF3\x9F\xBF\xBF    \xF8\xBB\xBF\xBF\xBF
338  * U+EFFFF: \xF3\xAF\xBF\xBF    \xF8\xBD\xBF\xBF\xBF
339  * U+FFFFF: \xF3\xBF\xBF\xBF    \xF8\xBF\xBF\xBF\xBF
340  * U+10FFFF: \xF4\x8F\xBF\xBF   \xF9\xA1\xBF\xBF\xBF
341  */
342 #define UTF8_IS_NONCHAR_(s) (                                                   \
343     *(s) >= UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE                        \
344     && ! UTF8_IS_SUPER(s)                                                       \
345     && UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_FIRST_PROBLEMATIC(s)         \
346
347 #ifdef EBCDIC /* Both versions assume well-formed UTF8 */
348 #   define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s)           \
349     ((*(s) == UTF_TO_NATIVE(0xF1)                                               \
350        && (*((s) + 1) == UTF_TO_NATIVE(0xBF)                                    \
351        &&    ((*((s) + 2) == UTF_TO_NATIVE(0xAE)                                \
352             && *((s) + 3) >= UTF_TO_NATIVE(0xB0))                               \
353           || (*((s) + 2) == UTF_TO_NATIVE(0xAF)                                 \
354             && *((s) + 3) <= UTF_TO_NATIVE(0xAF)))))                            \
355     || (UTF8SKIP(*(s)) > 3                                                      \
356         /* (These were all derived by inspection and experimentation with an */ \
357         /* editor)  The next line checks the next to final byte in the char */  \
358         && *((s) + UTF8SKIP(*(s)) - 2) == UTF_TO_NATIVE(0xBF)                   \
359         && *((s) + UTF8SKIP(*(s)) - 3) == UTF_TO_NATIVE(0xBF)                   \
360         && (NATIVE_TO_UTF(*((s) + UTF8SKIP(*(s)) - 4)) & 0x81) == 0x81          \
361         && (NATIVE_TO_UTF(*((s) + UTF8SKIP(*(s)) - 1)) & 0xBE) == 0XBE))
362 #else
363 #   define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s)           \
364     ((*(s) == 0xEF                                                              \
365         && ((*((s) + 1) == 0xB7 && (*((s) + 2) >= 0x90 && (*((s) + 2) <= 0xAF)))\
366                 /* Gets U+FFF[EF] */                                            \
367             || (*((s) + 1) == 0xBF && ((*((s) + 2) & 0xBE) == 0xBE))))          \
368  || ((*((s) + 2) == 0xBF                                                        \
369          && (*((s) + 3) & 0xBE) == 0xBE                                         \
370             /* Excludes things like U+10FFE = \xF0\x90\xBF\xBE */               \
371          && (*((s) + 1) & 0x8F) == 0x8F)))
372 #endif
373
374 #define UNICODE_SURROGATE_FIRST         0xD800
375 #define UNICODE_SURROGATE_LAST          0xDFFF
376 #define UNICODE_REPLACEMENT             0xFFFD
377 #define UNICODE_BYTE_ORDER_MARK         0xFEFF
378
379 /* Though our UTF-8 encoding can go beyond this,
380  * let's be conservative and do as Unicode says. */
381 #define PERL_UNICODE_MAX        0x10FFFF
382
383 #define UNICODE_WARN_SURROGATE     0x0001       /* UTF-16 surrogates */
384 #define UNICODE_WARN_NONCHAR       0x0002       /* Non-char code points */
385 #define UNICODE_WARN_SUPER         0x0004       /* Above 0x10FFFF */
386 #define UNICODE_WARN_FE_FF         0x0008       /* Above 0x10FFFF */
387 #define UNICODE_DISALLOW_SURROGATE 0x0010
388 #define UNICODE_DISALLOW_NONCHAR   0x0020
389 #define UNICODE_DISALLOW_SUPER     0x0040
390 #define UNICODE_DISALLOW_FE_FF     0x0080
391 #define UNICODE_WARN_ILLEGAL_INTERCHANGE \
392     (UNICODE_WARN_SURROGATE|UNICODE_WARN_NONCHAR|UNICODE_WARN_SUPER)
393 #define UNICODE_DISALLOW_ILLEGAL_INTERCHANGE \
394     (UNICODE_DISALLOW_SURROGATE|UNICODE_DISALLOW_NONCHAR|UNICODE_DISALLOW_SUPER)
395
396 /* For backward source compatibility, as are now the default */
397 #define UNICODE_ALLOW_SURROGATE 0
398 #define UNICODE_ALLOW_SUPER     0
399 #define UNICODE_ALLOW_ANY       0
400
401 #define UNICODE_IS_SURROGATE(c)         ((c) >= UNICODE_SURROGATE_FIRST && \
402                                          (c) <= UNICODE_SURROGATE_LAST)
403 #define UNICODE_IS_REPLACEMENT(c)       ((c) == UNICODE_REPLACEMENT)
404 #define UNICODE_IS_BYTE_ORDER_MARK(c)   ((c) == UNICODE_BYTE_ORDER_MARK)
405 #define UNICODE_IS_NONCHAR(c)           ((c >= 0xFDD0 && c <= 0xFDEF) \
406                         /* The other noncharacters end in FFFE or FFFF, which  \
407                          * the mask below catches both of, but beyond the last \
408                          * official unicode code point, they aren't            \
409                          * noncharacters, since those aren't Unicode           \
410                          * characters at all */                                \
411                         || ((((c & 0xFFFE) == 0xFFFE)) && ! UNICODE_IS_SUPER(c)))
412 #define UNICODE_IS_SUPER(c)             ((c) > PERL_UNICODE_MAX)
413 #define UNICODE_IS_FE_FF(c)             ((c) > 0x7FFFFFFF)
414
415 #ifdef HAS_QUAD
416 #    define UTF8_QUAD_MAX       UINT64_C(0x1000000000)
417 #endif
418
419 #define UNICODE_GREEK_CAPITAL_LETTER_SIGMA      0x03A3
420 #define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA  0x03C2
421 #define UNICODE_GREEK_SMALL_LETTER_SIGMA        0x03C3
422 #define GREEK_SMALL_LETTER_MU                   0x03BC
423
424 #define UNI_DISPLAY_ISPRINT     0x0001
425 #define UNI_DISPLAY_BACKSLASH   0x0002
426 #define UNI_DISPLAY_QQ          (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
427 #define UNI_DISPLAY_REGEX       (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
428
429 #ifndef EBCDIC
430 #   define LATIN_SMALL_LETTER_SHARP_S   0x00DF
431 #   define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS 0x00FF
432 #   define MICRO_SIGN 0x00B5
433 #endif
434
435 #define ANYOF_FOLD_SHARP_S(node, input, end)    \
436         (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \
437          (ANYOF_FLAGS(node) & ANYOF_NONBITMAP) && \
438          (ANYOF_FLAGS(node) & ANYOF_LOC_NONBITMAP_FOLD) && \
439          ((end) > (input) + 1) && \
440          toLOWER((input)[0]) == 's' && \
441          toLOWER((input)[1]) == 's')
442 #define SHARP_S_SKIP 2
443
444 #ifdef EBCDIC
445 /* IS_UTF8_CHAR() is not ported to EBCDIC */
446 #else
447 #define IS_UTF8_CHAR_1(p)       \
448         ((p)[0] <= 0x7F)
449 #define IS_UTF8_CHAR_2(p)       \
450         ((p)[0] >= 0xC2 && (p)[0] <= 0xDF && \
451          (p)[1] >= 0x80 && (p)[1] <= 0xBF)
452 #define IS_UTF8_CHAR_3a(p)      \
453         ((p)[0] == 0xE0 && \
454          (p)[1] >= 0xA0 && (p)[1] <= 0xBF && \
455          (p)[2] >= 0x80 && (p)[2] <= 0xBF)
456 #define IS_UTF8_CHAR_3b(p)      \
457         ((p)[0] >= 0xE1 && (p)[0] <= 0xEC && \
458          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
459          (p)[2] >= 0x80 && (p)[2] <= 0xBF)
460 #define IS_UTF8_CHAR_3c(p)      \
461         ((p)[0] == 0xED && \
462          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
463          (p)[2] >= 0x80 && (p)[2] <= 0xBF)
464 /* In IS_UTF8_CHAR_3c(p) one could use
465  * (p)[1] >= 0x80 && (p)[1] <= 0x9F
466  * if one wanted to exclude surrogates. */
467 #define IS_UTF8_CHAR_3d(p)      \
468         ((p)[0] >= 0xEE && (p)[0] <= 0xEF && \
469          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
470          (p)[2] >= 0x80 && (p)[2] <= 0xBF)
471 #define IS_UTF8_CHAR_4a(p)      \
472         ((p)[0] == 0xF0 && \
473          (p)[1] >= 0x90 && (p)[1] <= 0xBF && \
474          (p)[2] >= 0x80 && (p)[2] <= 0xBF && \
475          (p)[3] >= 0x80 && (p)[3] <= 0xBF)
476 #define IS_UTF8_CHAR_4b(p)      \
477         ((p)[0] >= 0xF1 && (p)[0] <= 0xF3 && \
478          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
479          (p)[2] >= 0x80 && (p)[2] <= 0xBF && \
480          (p)[3] >= 0x80 && (p)[3] <= 0xBF)
481 /* In IS_UTF8_CHAR_4c(p) one could use
482  * (p)[0] == 0xF4
483  * if one wanted to stop at the Unicode limit U+10FFFF.
484  * The 0xF7 allows us to go to 0x1fffff (0x200000 would
485  * require five bytes).  Not doing any further code points
486  * since that is not needed (and that would not be strict
487  * UTF-8, anyway).  The "slow path" in Perl_is_utf8_char()
488  * will take care of the "extended UTF-8". */
489 #define IS_UTF8_CHAR_4c(p)      \
490         ((p)[0] >= 0xF4 && (p)[0] <= 0xF7 && \
491          (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
492          (p)[2] >= 0x80 && (p)[2] <= 0xBF && \
493          (p)[3] >= 0x80 && (p)[3] <= 0xBF)
494
495 #define IS_UTF8_CHAR_3(p)       \
496         (IS_UTF8_CHAR_3a(p) || \
497          IS_UTF8_CHAR_3b(p) || \
498          IS_UTF8_CHAR_3c(p) || \
499          IS_UTF8_CHAR_3d(p))
500 #define IS_UTF8_CHAR_4(p)       \
501         (IS_UTF8_CHAR_4a(p) || \
502          IS_UTF8_CHAR_4b(p) || \
503          IS_UTF8_CHAR_4c(p))
504
505 /* IS_UTF8_CHAR(p) is strictly speaking wrong (not UTF-8) because it
506  * (1) allows UTF-8 encoded UTF-16 surrogates
507  * (2) it allows code points past U+10FFFF.
508  * The Perl_is_utf8_char() full "slow" code will handle the Perl
509  * "extended UTF-8". */
510 #define IS_UTF8_CHAR(p, n)      \
511         ((n) == 1 ? IS_UTF8_CHAR_1(p) : \
512          (n) == 2 ? IS_UTF8_CHAR_2(p) : \
513          (n) == 3 ? IS_UTF8_CHAR_3(p) : \
514          (n) == 4 ? IS_UTF8_CHAR_4(p) : 0)
515
516 #define IS_UTF8_CHAR_FAST(n) ((n) <= 4)
517
518 #endif /* IS_UTF8_CHAR() for UTF-8 */
519
520 /*
521  * Local variables:
522  * c-indentation-style: bsd
523  * c-basic-offset: 4
524  * indent-tabs-mode: t
525  * End:
526  *
527  * ex: set ts=8 sts=4 sw=4 noet:
528  */