use non-dev version for Safe
[perl.git] / utf8.h
1 /*    utf8.h
2  *
3  *    Copyright (C) 2000, 2001, 2002, 2005, 2006, 2007, 2009,
4  *    2010, 2011 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 #ifndef H_UTF8      /* Guard against recursive inclusion */
12 #define H_UTF8 1
13
14 /* Use UTF-8 as the default script encoding?
15  * Turning this on will break scripts having non-UTF-8 binary
16  * data (such as Latin-1) in string literals. */
17 #ifdef USE_UTF8_SCRIPTS
18 #    define USE_UTF8_IN_NAMES (!IN_BYTES)
19 #else
20 #    define USE_UTF8_IN_NAMES (PL_hints & HINT_UTF8)
21 #endif
22
23 /* For to_utf8_fold_flags, q.v. */
24 #define FOLD_FLAGS_LOCALE 0x1
25 #define FOLD_FLAGS_FULL   0x2
26 #define FOLD_FLAGS_NOMIX_ASCII 0x4
27
28 /* For _core_swash_init(), internal core use only */
29 #define _CORE_SWASH_INIT_USER_DEFINED_PROPERTY 0x1
30 #define _CORE_SWASH_INIT_RETURN_IF_UNDEF       0x2
31 #define _CORE_SWASH_INIT_ACCEPT_INVLIST        0x4
32
33 #define to_uni_fold(c, p, lenp) _to_uni_fold_flags(c, p, lenp, FOLD_FLAGS_FULL)
34 #define to_utf8_fold(c, p, lenp) _to_utf8_fold_flags(c, p, lenp, \
35                      FOLD_FLAGS_FULL, NULL)
36 #define to_utf8_lower(a,b,c) _to_utf8_lower_flags(a,b,c,0, NULL)
37 #define to_utf8_upper(a,b,c) _to_utf8_upper_flags(a,b,c,0, NULL)
38 #define to_utf8_title(a,b,c) _to_utf8_title_flags(a,b,c,0, NULL)
39
40 /* Source backward compatibility. */
41 #define uvuni_to_utf8(d, uv)            uvuni_to_utf8_flags(d, uv, 0)
42 #define is_utf8_string_loc(s, len, ep)  is_utf8_string_loclen(s, len, ep, 0)
43
44 #define foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
45                     foldEQ_utf8_flags(s1, pe1, l1, u1, s2, pe2, l2, u2, 0)
46 #define FOLDEQ_UTF8_NOMIX_ASCII (1 << 0)
47 #define FOLDEQ_UTF8_LOCALE      (1 << 1)
48 #define FOLDEQ_S1_ALREADY_FOLDED  (1 << 2)
49 #define FOLDEQ_S2_ALREADY_FOLDED  (1 << 3)
50
51 /*
52 =for apidoc ibcmp_utf8
53
54 This is a synonym for (! foldEQ_utf8())
55
56 =cut
57 */
58 #define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
59                     cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2))
60
61 #ifdef EBCDIC
62 /* The equivalent of these macros but implementing UTF-EBCDIC
63    are in the following header file:
64  */
65
66 #include "utfebcdic.h"
67
68 #else   /* ! EBCDIC */
69 START_EXTERN_C
70
71 #ifdef DOINIT
72 EXTCONST unsigned char PL_utf8skip[] = {
73 /* 0x00 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
74 /* 0x10 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
75 /* 0x20 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
76 /* 0x30 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
77 /* 0x40 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
78 /* 0x50 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
79 /* 0x60 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
80 /* 0x70 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
81 /* 0x80 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
82 /* 0x90 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
83 /* 0xA0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
84 /* 0xB0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
85 /* 0xC0 */ 2,2,                             /* overlong */
86 /* 0xC2 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,     /* U+0080 to U+03FF */
87 /* 0xD0 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0400 to U+07FF */
88 /* 0xE0 */ 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3, /* U+0800 to U+FFFF */
89 /* 0xF0 */ 4,4,4,4,4,4,4,4,5,5,5,5,6,6,     /* above BMP to 2**31 - 1 */
90 /* 0xFE */ 7,13, /* Perl extended (never was official UTF-8).  Up to 72bit
91                     allowed (64-bit + reserved). */
92 };
93 #else
94 EXTCONST unsigned char PL_utf8skip[];
95 #endif
96
97 END_EXTERN_C
98
99 #include "regcharclass.h"
100 #include "unicode_constants.h"
101
102 /* Native character to iso-8859-1 */
103 #define NATIVE_TO_ASCII(ch)      (ch)
104 #define ASCII_TO_NATIVE(ch)      (ch)
105 /* Transform after encoding */
106 #define NATIVE_TO_UTF(ch)        (ch)
107 #define NATIVE_TO_I8(ch) NATIVE_TO_UTF(ch)      /* a clearer synonym */
108 #define UTF_TO_NATIVE(ch)        (ch)
109 #define I8_TO_NATIVE(ch) UTF_TO_NATIVE(ch)
110 /* Transforms in wide UV chars */
111 #define UNI_TO_NATIVE(ch)        (ch)
112 #define NATIVE_TO_UNI(ch)        (ch)
113 /* Transforms in invariant space */
114 #define NATIVE_TO_NEED(enc,ch)   (ch)
115 #define ASCII_TO_NEED(enc,ch)    (ch)
116
117 /* As there are no translations, avoid the function wrapper */
118 #define utf8n_to_uvchr utf8n_to_uvuni
119 #define valid_utf8_to_uvchr valid_utf8_to_uvuni
120 #define uvchr_to_utf8  uvuni_to_utf8
121
122 /*
123
124  The following table is from Unicode 3.2.
125
126  Code Points            1st Byte  2nd Byte  3rd Byte  4th Byte
127
128    U+0000..U+007F       00..7F
129    U+0080..U+07FF     * C2..DF    80..BF
130    U+0800..U+0FFF       E0      * A0..BF    80..BF
131    U+1000..U+CFFF       E1..EC    80..BF    80..BF
132    U+D000..U+D7FF       ED        80..9F    80..BF
133    U+D800..U+DFFF       +++++++ utf16 surrogates, not legal utf8 +++++++
134    U+E000..U+FFFF       EE..EF    80..BF    80..BF
135   U+10000..U+3FFFF      F0      * 90..BF    80..BF    80..BF
136   U+40000..U+FFFFF      F1..F3    80..BF    80..BF    80..BF
137  U+100000..U+10FFFF     F4        80..8F    80..BF    80..BF
138     Below are non-Unicode code points
139  U+110000..U+13FFFF     F4        90..BF    80..BF    80..BF
140  U+110000..U+1FFFFF     F5..F7    80..BF    80..BF    80..BF
141  U+200000:              F8..    * 88..BF    80..BF    80..BF    80..BF
142
143 Note the gaps before several of the byte entries above marked by '*'.  These are
144 caused by legal UTF-8 avoiding non-shortest encodings: it is technically
145 possible to UTF-8-encode a single code point in different ways, but that is
146 explicitly forbidden, and the shortest possible encoding should always be used
147 (and that is what Perl does).  The non-shortest ones are called 'overlongs'.
148
149  */
150
151 /*
152  Another way to look at it, as bits:
153
154                   Code Points      1st Byte   2nd Byte   3rd Byte   4th Byte
155
156                         0aaa aaaa  0aaa aaaa
157               0000 0bbb bbaa aaaa  110b bbbb  10aa aaaa
158               cccc bbbb bbaa aaaa  1110 cccc  10bb bbbb  10aa aaaa
159  00 000d ddcc cccc bbbb bbaa aaaa  1111 0ddd  10cc cccc  10bb bbbb  10aa aaaa
160
161 As you can see, the continuation bytes all begin with C<10>, and the
162 leading bits of the start byte tell how many bytes there are in the
163 encoded character.
164
165 Perl's extended UTF-8 means we can have start bytes up to FF.
166
167 */
168
169 /* Is the representation of the Unicode code point 'c' the same regardless of
170  * being encoded in UTF-8 or not? */
171 #define UNI_IS_INVARIANT(c)             (((UV)c) <  0x80)
172
173 /* Is the UTF8-encoded byte 'c' part of a variant sequence in UTF-8?  This is
174  * the inverse of UTF8_IS_INVARIANT */
175 #define UTF8_IS_CONTINUED(c)            (((U8)c) &  0x80)
176
177 /* Is the byte 'c' the first byte of a multi-byte UTF8-8 encoded sequence?
178  * This doesn't catch invariants (they are single-byte).  It also excludes the
179  * illegal overlong sequences that begin with C0 and C1. */
180 #define UTF8_IS_START(c)                (((U8)c) >= 0xc2)
181
182 /* Is the byte 'c' part of a multi-byte UTF8-8 encoded sequence, and not the
183  * first byte thereof?  */
184 #define UTF8_IS_CONTINUATION(c)         ((((U8)c) & 0xC0) == 0x80)
185
186 /* Is the UTF8-encoded byte 'c' the first byte of a two byte sequence?  Use
187  * UTF8_IS_NEXT_CHAR_DOWNGRADEABLE() instead if the input isn't known to
188  * be well-formed.  Masking with 0xfe allows the low bit to be 0 or 1; thus
189  * this matches 0xc[23]. */
190 #define UTF8_IS_DOWNGRADEABLE_START(c)  (((U8)(c) & 0xfe) == 0xc2)
191
192 /* Is the UTF8-encoded byte 'c' the first byte of a sequence of bytes that
193  * represent a code point > 255? */
194 #define UTF8_IS_ABOVE_LATIN1(c) ((U8)(c) >= 0xc4)
195
196 /* This defines the 1-bits that are to be in the first byte of a multi-byte
197  * UTF-8 encoded character that give the number of bytes that comprise the
198  * character.
199  * */
200 #define UTF_START_MARK(len) (((len) >  7) ? 0xFF : (0xFE << (7-(len))))
201
202 /* Masks out the initial one bits in a start byte, leaving the real data ones.
203  * Doesn't work on an invariant byte */
204 #define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2)))
205
206 /* This defines the bits that are to be in the continuation bytes of a multi-byte
207  * UTF-8 encoded character that indicate it is a continuation byte. */
208 #define UTF_CONTINUATION_MARK           0x80
209
210 /* This is the number of low-order bits a continuation byte in a UTF-8 encoded
211  * sequence contributes to the specification of the code point.  In the bit
212  * maps above, you see that the first 2 bits are a constant '10', leaving 6 of
213  * real information */
214 #define UTF_ACCUMULATION_SHIFT          6
215
216 /* 2**UTF_ACCUMULATION_SHIFT - 1 */
217 #define UTF_CONTINUATION_MASK           ((U8)0x3f)
218
219 /* If a value is anded with this, and the result is non-zero, then using the
220  * original value in UTF8_ACCUMULATE will overflow, shifting bits off the left
221  * */
222 #define UTF_ACCUMULATION_OVERFLOW_MASK                                  \
223     (((UV) UTF_CONTINUATION_MASK) << ((sizeof(UV) * CHARBITS)           \
224            - UTF_ACCUMULATION_SHIFT))
225
226 #ifdef HAS_QUAD
227 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
228                       (uv) < 0x800          ? 2 : \
229                       (uv) < 0x10000        ? 3 : \
230                       (uv) < 0x200000       ? 4 : \
231                       (uv) < 0x4000000      ? 5 : \
232                       (uv) < 0x80000000     ? 6 : \
233                       (uv) < UTF8_QUAD_MAX ? 7 : 13 )
234 #else
235 /* No, I'm not even going to *TRY* putting #ifdef inside a #define */
236 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
237                       (uv) < 0x800          ? 2 : \
238                       (uv) < 0x10000        ? 3 : \
239                       (uv) < 0x200000       ? 4 : \
240                       (uv) < 0x4000000      ? 5 : \
241                       (uv) < 0x80000000     ? 6 : 7 )
242 #endif
243
244 /* How wide can a single UTF-8 encoded character become in bytes. */
245 /* NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8 since UTF-8
246  * is an encoding of Unicode, and Unicode's upper limit, 0x10FFFF, can be
247  * expressed with 4 bytes.  However, Perl thinks of UTF-8 as a way to encode
248  * non-negative integers in a binary format, even those above Unicode */
249 #define UTF8_MAXBYTES 13
250
251 /* The maximum number of UTF-8 bytes a single Unicode character can
252  * uppercase/lowercase/fold into.  Unicode guarantees that the maximum
253  * expansion is 3 characters.  On ASCIIish platforms, the highest Unicode
254  * character occupies 4 bytes, therefore this number would be 12, but this is
255  * smaller than the maximum width a single above-Unicode character can occupy,
256  * so use that instead */
257 #if UTF8_MAXBYTES < 12
258 #error UTF8_MAXBYTES must be at least 12
259 #endif
260
261 #define UTF8_MAXBYTES_CASE      UTF8_MAXBYTES
262
263 #endif /* EBCDIC vs ASCII */
264
265 /* Rest of these are attributes of Unicode and perl's internals rather than the
266  * encoding, or happen to be the same in both ASCII and EBCDIC (at least at
267  * this level; the macros that some of these call may have different
268  * definitions in the two encodings */
269
270 #define NATIVE8_TO_UNI(ch)     NATIVE_TO_ASCII(ch)      /* a clearer synonym */
271
272 #define UTF8_ACCUMULATE(old, new)       (((old) << UTF_ACCUMULATION_SHIFT)     \
273                                         | (((U8)new) & UTF_CONTINUATION_MASK))
274
275 /* This works in the face of malformed UTF-8. */
276 #define UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, e) (UTF8_IS_DOWNGRADEABLE_START(*s) \
277                                                && ( (e) - (s) > 1)             \
278                                                && UTF8_IS_CONTINUATION(*((s)+1)))
279
280 /* Convert a two (not one) byte utf8 character to a unicode code point value.
281  * Needs just one iteration of accumulate.  Should not be used unless it is
282  * known that the two bytes are legal: 1) two-byte start, and 2) continuation.
283  * Note that the result can be larger than 255 if the input character is not
284  * downgradable */
285 #define TWO_BYTE_UTF8_TO_UNI(HI, LO) \
286                     UTF8_ACCUMULATE((NATIVE_TO_UTF(HI) & UTF_START_MASK(2)), \
287                                      NATIVE_TO_UTF(LO))
288
289 /* How many bytes in the UTF-8 encoded character whose first (perhaps only)
290  * byte is pointed to by 's' */
291 #define UTF8SKIP(s) PL_utf8skip[*(const U8*)(s)]
292
293 /* Is the byte 'c' the same character when encoded in UTF-8 as when not.  This
294  * works on both UTF-8 encoded strings and non-encoded, as it returns TRUE in
295  * each for the exact same set of bit patterns.  (And it works on any byte in a
296  * UTF-8 encoded string) */
297 #define UTF8_IS_INVARIANT(c)            UNI_IS_INVARIANT(NATIVE_TO_UTF(c))
298
299 #define NATIVE_IS_INVARIANT(c)          UNI_IS_INVARIANT(NATIVE8_TO_UNI(c))
300
301 #define MAX_PORTABLE_UTF8_TWO_BYTE 0x3FF    /* constrained by EBCDIC */
302
303 /* The macros in the next sets are used to generate the two utf8 or utfebcdic
304  * bytes from an ordinal that is known to fit into two bytes; it must be less
305  * than 0x3FF to work across both encodings. */
306 /* Nocast allows these to be used in the case label of a switch statement */
307 #define UTF8_TWO_BYTE_HI_nocast(c)      NATIVE_TO_I8(((c)                       \
308                         >> UTF_ACCUMULATION_SHIFT) | (0xFF & UTF_START_MARK(2)))
309 #define UTF8_TWO_BYTE_LO_nocast(c)  NATIVE_TO_I8(((c) & UTF_CONTINUATION_MASK)  \
310                                     | UTF_CONTINUATION_MARK)
311
312 #define UTF8_TWO_BYTE_HI(c)     ((U8) (UTF8_TWO_BYTE_HI_nocast(c)))
313 #define UTF8_TWO_BYTE_LO(c)     ((U8) (UTF8_TWO_BYTE_LO_nocast(c)))
314
315 /* This name is used when the source is a single byte */
316 #define UTF8_EIGHT_BIT_HI(c)    UTF8_TWO_BYTE_HI((U8)(c))
317 #define UTF8_EIGHT_BIT_LO(c)    UTF8_TWO_BYTE_LO((U8)(c))
318
319 /*
320  * 'UTF' is whether or not p is encoded in UTF8.  The names 'foo_lazy_if' stem
321  * from an earlier version of these macros in which they didn't call the
322  * foo_utf8() macros (i.e. were 'lazy') unless they decided that *p is the
323  * beginning of a utf8 character.  Now that foo_utf8() determines that itself,
324  * no need to do it again here
325  */
326 #define isIDFIRST_lazy_if(p,UTF) ((IN_BYTES || !UTF ) \
327                                  ? isIDFIRST(*(p)) \
328                                  : isIDFIRST_utf8((const U8*)p))
329 #define isWORDCHAR_lazy_if(p,UTF)   ((IN_BYTES || (!UTF )) \
330                                  ? isWORDCHAR(*(p)) \
331                                  : isWORDCHAR_utf8((const U8*)p))
332 #define isALNUM_lazy_if(p,UTF)   isWORDCHAR_lazy_if(p,UTF)
333
334 #define UTF8_MAXLEN UTF8_MAXBYTES
335
336 /* A Unicode character can fold to up to 3 characters */
337 #define UTF8_MAX_FOLD_CHAR_EXPAND 3
338
339 #define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES)
340 #define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
341 #define IN_UNI_8_BIT \
342             (CopHINTS_get(PL_curcop) & (HINT_UNI_8_BIT|HINT_LOCALE_NOT_CHARS) \
343              && ! IN_LOCALE_RUNTIME && ! IN_BYTES)
344
345
346 #define UTF8_ALLOW_EMPTY                0x0001  /* Allow a zero length string */
347
348 /* Allow first byte to be a continuation byte */
349 #define UTF8_ALLOW_CONTINUATION         0x0002
350
351 /* Allow second... bytes to be non-continuation bytes */
352 #define UTF8_ALLOW_NON_CONTINUATION     0x0004
353
354 /* expecting more bytes than were available in the string */
355 #define UTF8_ALLOW_SHORT                0x0008
356
357 /* Overlong sequence; i.e., the code point can be specified in fewer bytes. */
358 #define UTF8_ALLOW_LONG                 0x0010
359
360 #define UTF8_DISALLOW_SURROGATE         0x0020  /* Unicode surrogates */
361 #define UTF8_WARN_SURROGATE             0x0040
362
363 #define UTF8_DISALLOW_NONCHAR           0x0080  /* Unicode non-character */
364 #define UTF8_WARN_NONCHAR               0x0100  /*  code points */
365
366 #define UTF8_DISALLOW_SUPER             0x0200  /* Super-set of Unicode: code */
367 #define UTF8_WARN_SUPER                 0x0400  /* points above the legal max */
368
369 /* Code points which never were part of the original UTF-8 standard, the first
370  * byte of which is a FE or FF on ASCII platforms. */
371 #define UTF8_DISALLOW_FE_FF             0x0800
372 #define UTF8_WARN_FE_FF                 0x1000
373
374 #define UTF8_CHECK_ONLY                 0x2000
375
376 /* For backwards source compatibility.  They do nothing, as the default now
377  * includes what they used to mean.  The first one's meaning was to allow the
378  * just the single non-character 0xFFFF */
379 #define UTF8_ALLOW_FFFF 0
380 #define UTF8_ALLOW_SURROGATE 0
381
382 #define UTF8_DISALLOW_ILLEGAL_INTERCHANGE (UTF8_DISALLOW_SUPER|UTF8_DISALLOW_NONCHAR|UTF8_DISALLOW_SURROGATE|UTF8_DISALLOW_FE_FF)
383 #define UTF8_WARN_ILLEGAL_INTERCHANGE \
384         (UTF8_WARN_SUPER|UTF8_WARN_NONCHAR|UTF8_WARN_SURROGATE|UTF8_WARN_FE_FF)
385 #define UTF8_ALLOW_ANY \
386             (~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
387 #define UTF8_ALLOW_ANYUV                                                        \
388          (UTF8_ALLOW_EMPTY                                                      \
389           & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
390 #define UTF8_ALLOW_DEFAULT              (ckWARN(WARN_UTF8) ? 0 : \
391                                          UTF8_ALLOW_ANYUV)
392
393 /* Surrogates, non-character code points and above-Unicode code points are
394  * problematic in some contexts.  This allows code that needs to check for
395  * those to to quickly exclude the vast majority of code points it will
396  * encounter */
397 #define UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE \
398                                     FIRST_SURROGATE_UTF8_FIRST_BYTE
399
400 #define UTF8_IS_SURROGATE(s) cBOOL(is_SURROGATE_utf8(s))
401 #define UTF8_IS_REPLACEMENT(s, send) cBOOL(is_REPLACEMENT_utf8_safe(s,send))
402
403 /*                ASCII              EBCDIC I8
404  * U+10FFFF: \xF4\x8F\xBF\xBF   \xF9\xA1\xBF\xBF\xBF    max legal Unicode
405  * U+110000: \xF4\x90\x80\x80   \xF9\xA2\xA0\xA0\xA0
406  * U+110001: \xF4\x90\x80\x81   \xF9\xA2\xA0\xA0\xA1
407  */
408 #ifdef EBCDIC /* Both versions assume well-formed UTF8 */
409 #   define UTF8_IS_SUPER(s)  (NATIVE_TO_I8(* (U8*) (s)) >= 0xF9                 \
410                               && (NATIVE_TO_I8(* (U8*) (s)) > 0xF9              \
411                                   || (NATIVE_TO_I8(* (U8*) ((s)) + 1 >= 0xA2))))
412 #else
413 #   define UTF8_IS_SUPER(s) (*(U8*) (s) >= 0xF4                                 \
414                             && (*(U8*) (s) > 0xF4 || (*((U8*) (s) + 1) >= 0x90)))
415 #endif
416
417 /* These are now machine generated, and the 'given' clause is no longer
418  * applicable */
419 #define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s)             \
420                                                     cBOOL(is_NONCHAR_utf8(s))
421 #define UTF8_IS_NONCHAR_(s)                                                    \
422                     UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s)
423
424 #define UNICODE_SURROGATE_FIRST         0xD800
425 #define UNICODE_SURROGATE_LAST          0xDFFF
426 #define UNICODE_REPLACEMENT             0xFFFD
427 #define UNICODE_BYTE_ORDER_MARK         0xFEFF
428
429 /* Though our UTF-8 encoding can go beyond this,
430  * let's be conservative and do as Unicode says. */
431 #define PERL_UNICODE_MAX        0x10FFFF
432
433 #define UNICODE_WARN_SURROGATE     0x0001       /* UTF-16 surrogates */
434 #define UNICODE_WARN_NONCHAR       0x0002       /* Non-char code points */
435 #define UNICODE_WARN_SUPER         0x0004       /* Above 0x10FFFF */
436 #define UNICODE_WARN_FE_FF         0x0008       /* Above 0x10FFFF */
437 #define UNICODE_DISALLOW_SURROGATE 0x0010
438 #define UNICODE_DISALLOW_NONCHAR   0x0020
439 #define UNICODE_DISALLOW_SUPER     0x0040
440 #define UNICODE_DISALLOW_FE_FF     0x0080
441 #define UNICODE_WARN_ILLEGAL_INTERCHANGE                                      \
442             (UNICODE_WARN_SURROGATE|UNICODE_WARN_NONCHAR|UNICODE_WARN_SUPER)
443 #define UNICODE_DISALLOW_ILLEGAL_INTERCHANGE                                  \
444  (UNICODE_DISALLOW_SURROGATE|UNICODE_DISALLOW_NONCHAR|UNICODE_DISALLOW_SUPER)
445
446 /* For backward source compatibility, as are now the default */
447 #define UNICODE_ALLOW_SURROGATE 0
448 #define UNICODE_ALLOW_SUPER     0
449 #define UNICODE_ALLOW_ANY       0
450
451 #define UNICODE_IS_SURROGATE(c)         ((c) >= UNICODE_SURROGATE_FIRST && \
452                                          (c) <= UNICODE_SURROGATE_LAST)
453 #define UNICODE_IS_REPLACEMENT(c)       ((c) == UNICODE_REPLACEMENT)
454 #define UNICODE_IS_BYTE_ORDER_MARK(c)   ((c) == UNICODE_BYTE_ORDER_MARK)
455 #define UNICODE_IS_NONCHAR(c)           ((c >= 0xFDD0 && c <= 0xFDEF) \
456                         /* The other noncharacters end in FFFE or FFFF, which  \
457                          * the mask below catches both of, but beyond the last \
458                          * official unicode code point, they aren't            \
459                          * noncharacters, since those aren't Unicode           \
460                          * characters at all */                                \
461                         || ((((c & 0xFFFE) == 0xFFFE)) && ! UNICODE_IS_SUPER(c)))
462 #define UNICODE_IS_SUPER(c)             ((c) > PERL_UNICODE_MAX)
463 #define UNICODE_IS_FE_FF(c)             ((c) > 0x7FFFFFFF)
464
465 #ifdef HAS_QUAD
466 #    define UTF8_QUAD_MAX       UINT64_C(0x1000000000)
467 #endif
468
469 #define LATIN_SMALL_LETTER_SHARP_S      LATIN_SMALL_LETTER_SHARP_S_NATIVE
470 #define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS                                  \
471                                 LATIN_SMALL_LETTER_Y_WITH_DIAERESIS_NATIVE
472 #define MICRO_SIGN      MICRO_SIGN_NATIVE
473 #define LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE                               \
474                             LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE_NATIVE
475 #define LATIN_SMALL_LETTER_A_WITH_RING_ABOVE                                 \
476                                 LATIN_SMALL_LETTER_A_WITH_RING_ABOVE_NATIVE
477 #define UNICODE_GREEK_CAPITAL_LETTER_SIGMA      0x03A3
478 #define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA  0x03C2
479 #define UNICODE_GREEK_SMALL_LETTER_SIGMA        0x03C3
480 #define GREEK_SMALL_LETTER_MU                   0x03BC
481 #define GREEK_CAPITAL_LETTER_MU 0x039C  /* Upper and title case of MICRON */
482 #define LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS 0x0178    /* Also is title case */
483 #define LATIN_CAPITAL_LETTER_SHARP_S    0x1E9E
484 #define LATIN_SMALL_LETTER_LONG_S   0x017F
485 #define KELVIN_SIGN                 0x212A
486 #define ANGSTROM_SIGN               0x212B
487
488 #define UNI_DISPLAY_ISPRINT     0x0001
489 #define UNI_DISPLAY_BACKSLASH   0x0002
490 #define UNI_DISPLAY_QQ          (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
491 #define UNI_DISPLAY_REGEX       (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
492
493 #define ANYOF_FOLD_SHARP_S(node, input, end)    \
494         (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \
495          (ANYOF_NONBITMAP(node)) && \
496          (ANYOF_FLAGS(node) & ANYOF_LOC_NONBITMAP_FOLD) && \
497          ((end) > (input) + 1) && \
498          toLOWER((input)[0]) == 's' && \
499          toLOWER((input)[1]) == 's')
500 #define SHARP_S_SKIP 2
501
502 /* If you want to exclude surrogates, and beyond legal Unicode, see the blame
503  * log for earlier versions which gave details for these */
504
505 #ifndef EBCDIC
506 /* This was generated by regen/regcharclass.pl, and then moved here.  The lines
507  * that generated it were then commented out.  This was done solely because it
508  * takes on the order of 10 minutes to generate, and is never going to change.
509  * The EBCDIC equivalent hasn't been commented out in regcharclass.pl, so it
510  * should generate and run the correct stuff */
511 /*
512         UTF8_CHAR: Matches utf8 from 1 to 4 bytes
513
514         0x0 - 0x1FFFFF
515 */
516 /*** GENERATED CODE ***/
517 #define is_UTF8_CHAR_utf8_safe(s,e)                                         \
518 ( ((e)-(s) > 3) ?                                                           \
519     ( ( ( ((U8*)s)[0] & 0x80 ) == 0x00 ) ? 1                                \
520     : ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ?                      \
521         ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 )                      \
522     : ( 0xE0 == ((U8*)s)[0] ) ?                                             \
523         ( ( ( ( ((U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
524     : ( 0xE1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xEF ) ?                      \
525         ( ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
526     : ( 0xF0 == ((U8*)s)[0] ) ?                                             \
527         ( ( ( ( 0x90 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0xBF ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
528     : ( ( ( ( 0xF1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xF7 ) && ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
529 : ((e)-(s) > 2) ?                                                           \
530     ( ( ( ((U8*)s)[0] & 0x80 ) == 0x00 ) ? 1                                \
531     : ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ?                      \
532         ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 )                      \
533     : ( 0xE0 == ((U8*)s)[0] ) ?                                             \
534         ( ( ( ( ((U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
535     : ( ( ( 0xE1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xEF ) && ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
536 : ((e)-(s) > 1) ?                                                           \
537     ( ( ( ((U8*)s)[0] & 0x80 ) == 0x00 ) ? 1                                \
538     : ( ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) && ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ) ? 2 : 0 )\
539 : ((e)-(s) > 0) ?                                                           \
540     ( ( ((U8*)s)[0] & 0x80 ) == 0x00 )                                      \
541 : 0 )
542 #endif
543
544 /* IS_UTF8_CHAR(p) is strictly speaking wrong (not UTF-8) because it
545  * (1) allows UTF-8 encoded UTF-16 surrogates
546  * (2) it allows code points past U+10FFFF.
547  * The Perl_is_utf8_char() full "slow" code will handle the Perl
548  * "extended UTF-8". */
549 #define IS_UTF8_CHAR(p, n)      (is_UTF8_CHAR_utf8_safe(p, (p) + (n)) == n)
550
551 /* regen/regcharclass.pl generates is_UTF8_CHAR_utf8_safe() macros for up to
552  * these number of bytes.  So this has to be coordinated with it */
553 #ifdef EBCDIC
554 #   define IS_UTF8_CHAR_FAST(n) ((n) <= 5)
555 #else
556 #   define IS_UTF8_CHAR_FAST(n) ((n) <= 4)
557 #endif
558
559 #endif /* H_UTF8 */
560
561 /*
562  * Local variables:
563  * c-indentation-style: bsd
564  * c-basic-offset: 4
565  * indent-tabs-mode: nil
566  * End:
567  *
568  * ex: set ts=8 sts=4 sw=4 et:
569  */