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