This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
util.c: Add some asserts()
[perl5.git] / utf8.h
CommitLineData
a0ed51b3
LW
1/* utf8.h
2 *
2eee27d7
SS
3 * Copyright (C) 2000, 2001, 2002, 2005, 2006, 2007, 2009,
4 * 2010, 2011 by Larry Wall and others
a0ed51b3
LW
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
57f0e7e2
KW
11#ifndef H_UTF8 /* Guard against recursive inclusion */
12#define H_UTF8 1
13
39e02b42 14/* Use UTF-8 as the default script encoding?
1e54db1a 15 * Turning this on will break scripts having non-UTF-8 binary
39e02b42
JH
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
051a06d4
KW
23/* For to_utf8_fold_flags, q.v. */
24#define FOLD_FLAGS_LOCALE 0x1
25#define FOLD_FLAGS_FULL 0x2
a0270393 26#define FOLD_FLAGS_NOMIX_ASCII 0x4
051a06d4 27
83199d38
KW
28/* For _core_swash_init(), internal core use only */
29#define _CORE_SWASH_INIT_USER_DEFINED_PROPERTY 0x1
5d3d13d1 30#define _CORE_SWASH_INIT_RETURN_IF_UNDEF 0x2
87367d5f 31#define _CORE_SWASH_INIT_ACCEPT_INVLIST 0x4
83199d38 32
a0270393 33#define to_uni_fold(c, p, lenp) _to_uni_fold_flags(c, p, lenp, FOLD_FLAGS_FULL)
051a06d4
KW
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)
36bb2ab6 39
fd7cb289
RGS
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
eda9cac1
KW
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)
a33c29bc 46#define FOLDEQ_UTF8_NOMIX_ASCII (1 << 0)
5e64d0fa 47#define FOLDEQ_UTF8_LOCALE (1 << 1)
18f762c3
KW
48#define FOLDEQ_S1_ALREADY_FOLDED (1 << 2)
49#define FOLDEQ_S2_ALREADY_FOLDED (1 << 3)
a33c29bc 50
e6226b18
KW
51/*
52=for apidoc ibcmp_utf8
53
54This 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
1d72bdf6
NIS
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"
fd7cb289 67
d06134e5 68#else /* ! EBCDIC */
73c4f7a1
GS
69START_EXTERN_C
70
a0ed51b3 71#ifdef DOINIT
6f06b55f 72EXTCONST unsigned char PL_utf8skip[] = {
b2635aa8
KW
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). */
a0ed51b3
LW
92};
93#else
6f06b55f 94EXTCONST unsigned char PL_utf8skip[];
a0ed51b3
LW
95#endif
96
73c4f7a1 97END_EXTERN_C
7e2040f0 98
b96a92fb 99#include "regcharclass.h"
ec34087a
KW
100#include "unicode_constants.h"
101
1d72bdf6
NIS
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)
428921e5 107#define NATIVE_TO_I8(ch) NATIVE_TO_UTF(ch) /* a clearer synonym */
1d72bdf6 108#define UTF_TO_NATIVE(ch) (ch)
428921e5 109#define I8_TO_NATIVE(ch) UTF_TO_NATIVE(ch)
1d72bdf6
NIS
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)
d7578b48 116
d06134e5 117/* As there are no translations, avoid the function wrapper */
1754c1a1 118#define utf8n_to_uvchr utf8n_to_uvuni
6dd9dce9 119#define valid_utf8_to_uvchr valid_utf8_to_uvuni
1754c1a1 120#define uvchr_to_utf8 uvuni_to_utf8
2b9d42f0 121
877d9f0d 122/*
9041c2e3 123
8c007b5a 124 The following table is from Unicode 3.2.
877d9f0d
JH
125
126 Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte
127
375122d7 128 U+0000..U+007F 00..7F
e1b711da 129 U+0080..U+07FF * C2..DF 80..BF
37e2e78e 130 U+0800..U+0FFF E0 * A0..BF 80..BF
375122d7 131 U+1000..U+CFFF E1..EC 80..BF 80..BF
e1b711da 132 U+D000..U+D7FF ED 80..9F 80..BF
37e2e78e 133 U+D800..U+DFFF +++++++ utf16 surrogates, not legal utf8 +++++++
375122d7 134 U+E000..U+FFFF EE..EF 80..BF 80..BF
37e2e78e 135 U+10000..U+3FFFF F0 * 90..BF 80..BF 80..BF
877d9f0d
JH
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
b2635aa8
KW
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
877d9f0d 142
e1b711da 143Note the gaps before several of the byte entries above marked by '*'. These are
37e2e78e
KW
144caused by legal UTF-8 avoiding non-shortest encodings: it is technically
145possible to UTF-8-encode a single code point in different ways, but that is
146explicitly forbidden, and the shortest possible encoding should always be used
147(and that is what Perl does).
8c007b5a 148
877d9f0d
JH
149 */
150
8c007b5a
JH
151/*
152 Another way to look at it, as bits:
153
b2635aa8 154 Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte
8c007b5a 155
b2635aa8
KW
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
8c007b5a
JH
160
161As you can see, the continuation bytes all begin with C<10>, and the
e1b711da 162leading bits of the start byte tell how many bytes there are in the
8c007b5a
JH
163encoded character.
164
65ab9279
TC
165Perl's extended UTF-8 means we can have start bytes up to FF.
166
8c007b5a
JH
167*/
168
c4d5f83a 169#define UNI_IS_INVARIANT(c) (((UV)c) < 0x80)
0447e8df 170#define UTF8_IS_START(c) (((U8)c) >= 0xc2)
e021c6e6 171#define UTF8_IS_CONTINUATION(c) ((((U8)c) & 0xC0) == 0x80)
c512ce4f 172#define UTF8_IS_CONTINUED(c) (((U8)c) & 0x80)
0ae1fa71
CH
173
174/* Masking with 0xfe allows low bit to be 0 or 1; thus this matches 0xc[23] */
175#define UTF8_IS_DOWNGRADEABLE_START(c) (((U8)c & 0xfe) == 0xc2)
7b4252f4 176#define UTF8_IS_ABOVE_LATIN1(c) ((U8)(c) >= 0xc4)
8850bf83 177
22901f30 178#define UTF_START_MARK(len) (((len) > 7) ? 0xFF : (0xFE << (7-(len))))
b2635aa8
KW
179
180/* Masks out the initial one bits in a start byte, leaving the real data ones.
181 * Doesn't work on an invariant byte */
22901f30 182#define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2)))
1d72bdf6
NIS
183
184#define UTF_CONTINUATION_MARK 0x80
185#define UTF_ACCUMULATION_SHIFT 6
b2635aa8
KW
186
187/* 2**UTF_ACCUMULATION_SHIFT - 1 */
1d72bdf6 188#define UTF_CONTINUATION_MASK ((U8)0x3f)
c512ce4f 189
eb83ed87
KW
190/* This sets the UTF_CONTINUATION_MASK in the upper bits of a word. If a value
191 * is anded with it, and the result is non-zero, then using the original value
192 * in UTF8_ACCUMULATE will overflow, shifting bits off the left */
193#define UTF_ACCUMULATION_OVERFLOW_MASK \
bb88be5f
KW
194 (((UV) UTF_CONTINUATION_MASK) << ((sizeof(UV) * CHARBITS) \
195 - UTF_ACCUMULATION_SHIFT))
eb83ed87 196
1d68d6cd 197#ifdef HAS_QUAD
5bbb0b5a 198#define UNISKIP(uv) ( (uv) < 0x80 ? 1 : \
1d68d6cd
SC
199 (uv) < 0x800 ? 2 : \
200 (uv) < 0x10000 ? 3 : \
201 (uv) < 0x200000 ? 4 : \
202 (uv) < 0x4000000 ? 5 : \
203 (uv) < 0x80000000 ? 6 : \
9041c2e3 204 (uv) < UTF8_QUAD_MAX ? 7 : 13 )
1d68d6cd
SC
205#else
206/* No, I'm not even going to *TRY* putting #ifdef inside a #define */
5bbb0b5a 207#define UNISKIP(uv) ( (uv) < 0x80 ? 1 : \
1d68d6cd
SC
208 (uv) < 0x800 ? 2 : \
209 (uv) < 0x10000 ? 3 : \
210 (uv) < 0x200000 ? 4 : \
211 (uv) < 0x4000000 ? 5 : \
212 (uv) < 0x80000000 ? 6 : 7 )
213#endif
214
03c76984
KW
215/* How wide can a single UTF-8 encoded character become in bytes. */
216/* NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8 since UTF-8
217 * is an encoding of Unicode, and Unicode's upper limit, 0x10FFFF, can be
218 * expressed with 4 bytes. However, Perl thinks of UTF-8 as a way to encode
219 * non-negative integers in a binary format, even those above Unicode */
220#define UTF8_MAXBYTES 13
221
222/* The maximum number of UTF-8 bytes a single Unicode character can
223 * uppercase/lowercase/fold into. Unicode guarantees that the maximum
224 * expansion is 3 characters. On ASCIIish platforms, the highest Unicode
225 * character occupies 4 bytes, therefore this number would be 12, but this is
226 * smaller than the maximum width a single above-Unicode character can occupy,
227 * so use that instead */
228#if UTF8_MAXBYTES < 12
229#error UTF8_MAXBYTES must be at least 12
230#endif
231
232#define UTF8_MAXBYTES_CASE UTF8_MAXBYTES
233
d06134e5
KW
234#endif /* EBCDIC vs ASCII */
235
236/* Rest of these are attributes of Unicode and perl's internals rather than the
237 * encoding, or happen to be the same in both ASCII and EBCDIC (at least at
238 * this level; the macros that some of these call may have different
239 * definitions in the two encodings */
240
241#define NATIVE8_TO_UNI(ch) NATIVE_TO_ASCII(ch) /* a clearer synonym */
242
bb88be5f
KW
243#define UTF8_ACCUMULATE(old, new) (((old) << UTF_ACCUMULATION_SHIFT) \
244 | (((U8)new) & UTF_CONTINUATION_MASK))
d06134e5 245
2950f2a7
KW
246/* Convert a two (not one) byte utf8 character to a unicode code point value.
247 * Needs just one iteration of accumulate. Should not be used unless it is
248 * known that the two bytes are legal: 1) two-byte start, and 2) continuation.
249 * Note that the result can be larger than 255 if the input character is not
250 * downgradable */
251#define TWO_BYTE_UTF8_TO_UNI(HI, LO) \
252 UTF8_ACCUMULATE((NATIVE_TO_UTF(HI) & UTF_START_MASK(2)), \
253 NATIVE_TO_UTF(LO))
254
d06134e5
KW
255#define UTF8SKIP(s) PL_utf8skip[*(const U8*)(s)]
256
257#define UTF8_IS_INVARIANT(c) UNI_IS_INVARIANT(NATIVE_TO_UTF(c))
258#define NATIVE_IS_INVARIANT(c) UNI_IS_INVARIANT(NATIVE8_TO_UNI(c))
259
260#define MAX_PORTABLE_UTF8_TWO_BYTE 0x3FF /* constrained by EBCDIC */
261
262/* The macros in the next sets are used to generate the two utf8 or utfebcdic
263 * bytes from an ordinal that is known to fit into two bytes; it must be less
264 * than 0x3FF to work across both encodings. */
265/* Nocast allows these to be used in the case label of a switch statement */
428921e5
KW
266#define UTF8_TWO_BYTE_HI_nocast(c) NATIVE_TO_I8(((c) \
267 >> UTF_ACCUMULATION_SHIFT) | (0xFF & UTF_START_MARK(2)))
268#define UTF8_TWO_BYTE_LO_nocast(c) NATIVE_TO_I8(((c) & UTF_CONTINUATION_MASK) \
269 | UTF_CONTINUATION_MARK)
d06134e5
KW
270
271#define UTF8_TWO_BYTE_HI(c) ((U8) (UTF8_TWO_BYTE_HI_nocast(c)))
272#define UTF8_TWO_BYTE_LO(c) ((U8) (UTF8_TWO_BYTE_LO_nocast(c)))
273
274/* This name is used when the source is a single byte */
275#define UTF8_EIGHT_BIT_HI(c) UTF8_TWO_BYTE_HI((U8)(c))
276#define UTF8_EIGHT_BIT_LO(c) UTF8_TWO_BYTE_LO((U8)(c))
277
7e2040f0 278/*
e3036cf4 279 * 'UTF' is whether or not p is encoded in UTF8. The names 'foo_lazy_if' stem
20df05f4
KW
280 * from an earlier version of these macros in which they didn't call the
281 * foo_utf8() macros (i.e. were 'lazy') unless they decided that *p is the
282 * beginning of a utf8 character. Now that foo_utf8() determines that itself,
283 * no need to do it again here
7e2040f0 284 */
e3036cf4
KW
285#define isIDFIRST_lazy_if(p,UTF) ((IN_BYTES || !UTF ) \
286 ? isIDFIRST(*(p)) \
287 : isIDFIRST_utf8((const U8*)p))
288#define isALNUM_lazy_if(p,UTF) ((IN_BYTES || (!UTF )) \
289 ? isALNUM(*(p)) \
290 : isALNUM_utf8((const U8*)p))
1d72bdf6 291
7e2040f0
GS
292#define isIDFIRST_lazy(p) isIDFIRST_lazy_if(p,1)
293#define isALNUM_lazy(p) isALNUM_lazy_if(p,1)
3bd709b1 294
89ebb4a3
JH
295#define UTF8_MAXLEN UTF8_MAXBYTES
296
8cb75cc8
KW
297/* A Unicode character can fold to up to 3 characters */
298#define UTF8_MAX_FOLD_CHAR_EXPAND 3
299
a98fe34d 300#define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES)
0064a8a9 301#define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
66cbab2c 302#define IN_UNI_8_BIT \
b36bf33f
KW
303 (CopHINTS_get(PL_curcop) & (HINT_UNI_8_BIT|HINT_LOCALE_NOT_CHARS) \
304 && ! IN_LOCALE_RUNTIME && ! IN_BYTES)
305
1d72bdf6 306
c76687c5
KW
307#define UTF8_ALLOW_EMPTY 0x0001 /* Allow a zero length string */
308
309/* Allow first byte to be a continuation byte */
1d72bdf6 310#define UTF8_ALLOW_CONTINUATION 0x0002
c76687c5
KW
311
312/* Allow second... bytes to be non-continuation bytes */
1d72bdf6 313#define UTF8_ALLOW_NON_CONTINUATION 0x0004
949cf498
KW
314
315/* expecting more bytes than were available in the string */
316#define UTF8_ALLOW_SHORT 0x0008
317
318/* Overlong sequence; i.e., the code point can be specified in fewer bytes. */
319#define UTF8_ALLOW_LONG 0x0010
320
321#define UTF8_DISALLOW_SURROGATE 0x0020 /* Unicode surrogates */
322#define UTF8_WARN_SURROGATE 0x0040
323
324#define UTF8_DISALLOW_NONCHAR 0x0080 /* Unicode non-character */
325#define UTF8_WARN_NONCHAR 0x0100 /* code points */
326
327#define UTF8_DISALLOW_SUPER 0x0200 /* Super-set of Unicode: code */
328#define UTF8_WARN_SUPER 0x0400 /* points above the legal max */
329
330/* Code points which never were part of the original UTF-8 standard, the first
331 * byte of which is a FE or FF on ASCII platforms. */
332#define UTF8_DISALLOW_FE_FF 0x0800
333#define UTF8_WARN_FE_FF 0x1000
334
335#define UTF8_CHECK_ONLY 0x2000
336
337/* For backwards source compatibility. They do nothing, as the default now
338 * includes what they used to mean. The first one's meaning was to allow the
339 * just the single non-character 0xFFFF */
340#define UTF8_ALLOW_FFFF 0
341#define UTF8_ALLOW_SURROGATE 0
342
33d9abfb 343#define UTF8_DISALLOW_ILLEGAL_INTERCHANGE (UTF8_DISALLOW_SUPER|UTF8_DISALLOW_NONCHAR|UTF8_DISALLOW_SURROGATE|UTF8_DISALLOW_FE_FF)
949cf498 344#define UTF8_WARN_ILLEGAL_INTERCHANGE \
33d9abfb 345 (UTF8_WARN_SUPER|UTF8_WARN_NONCHAR|UTF8_WARN_SURROGATE|UTF8_WARN_FE_FF)
949cf498
KW
346#define UTF8_ALLOW_ANY \
347 (~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
348#define UTF8_ALLOW_ANYUV \
349 (UTF8_ALLOW_EMPTY \
350 & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
9f7f3913
ST
351#define UTF8_ALLOW_DEFAULT (ckWARN(WARN_UTF8) ? 0 : \
352 UTF8_ALLOW_ANYUV)
1d72bdf6 353
7131f24d
KW
354/* Surrogates, non-character code points and above-Unicode code points are
355 * problematic in some contexts. This allows code that needs to check for
356 * those to to quickly exclude the vast majority of code points it will
357 * encounter */
b96a92fb
KW
358#define UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE \
359 FIRST_SURROGATE_UTF8_FIRST_BYTE
7131f24d 360
b96a92fb
KW
361#define UTF8_IS_SURROGATE(s) cBOOL(is_SURROGATE_utf8(s))
362#define UTF8_IS_REPLACEMENT(s, send) cBOOL(is_REPLACEMENT_utf8_safe(s,send))
7131f24d
KW
363
364/* ASCII EBCDIC I8
365 * U+10FFFF: \xF4\x8F\xBF\xBF \xF9\xA1\xBF\xBF\xBF max legal Unicode
366 * U+110000: \xF4\x90\x80\x80 \xF9\xA2\xA0\xA0\xA0
367 * U+110001: \xF4\x90\x80\x81 \xF9\xA2\xA0\xA0\xA1
368 */
369#ifdef EBCDIC /* Both versions assume well-formed UTF8 */
428921e5
KW
370# define UTF8_IS_SUPER(s) (NATIVE_TO_I8(*(s)) >= 0xF9 \
371 && (NATIVE_TO_I8(*(s)) > 0xF9) || (NATIVE_TO_I8(*((s)) + 1 >= 0xA2)))
7131f24d
KW
372#else
373# define UTF8_IS_SUPER(s) (*(s) >= 0xF4 \
374 && (*(s) > 0xF4 || (*((s) + 1) >= 0x90)))
375#endif
376
b96a92fb
KW
377/* These are now machine generated, and the 'given' clause is no longer
378 * applicable */
379#define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s) \
380 cBOOL(is_NONCHAR_utf8(s))
381#define UTF8_IS_NONCHAR_(s) \
382 UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s)
7131f24d 383
c867b360
JH
384#define UNICODE_SURROGATE_FIRST 0xD800
385#define UNICODE_SURROGATE_LAST 0xDFFF
386#define UNICODE_REPLACEMENT 0xFFFD
387#define UNICODE_BYTE_ORDER_MARK 0xFEFF
1d72bdf6 388
b851fbc1 389/* Though our UTF-8 encoding can go beyond this,
c76687c5 390 * let's be conservative and do as Unicode says. */
b851fbc1
JH
391#define PERL_UNICODE_MAX 0x10FFFF
392
949cf498
KW
393#define UNICODE_WARN_SURROGATE 0x0001 /* UTF-16 surrogates */
394#define UNICODE_WARN_NONCHAR 0x0002 /* Non-char code points */
395#define UNICODE_WARN_SUPER 0x0004 /* Above 0x10FFFF */
396#define UNICODE_WARN_FE_FF 0x0008 /* Above 0x10FFFF */
397#define UNICODE_DISALLOW_SURROGATE 0x0010
398#define UNICODE_DISALLOW_NONCHAR 0x0020
399#define UNICODE_DISALLOW_SUPER 0x0040
400#define UNICODE_DISALLOW_FE_FF 0x0080
bb88be5f
KW
401#define UNICODE_WARN_ILLEGAL_INTERCHANGE \
402 (UNICODE_WARN_SURROGATE|UNICODE_WARN_NONCHAR|UNICODE_WARN_SUPER)
403#define UNICODE_DISALLOW_ILLEGAL_INTERCHANGE \
404 (UNICODE_DISALLOW_SURROGATE|UNICODE_DISALLOW_NONCHAR|UNICODE_DISALLOW_SUPER)
949cf498
KW
405
406/* For backward source compatibility, as are now the default */
407#define UNICODE_ALLOW_SURROGATE 0
408#define UNICODE_ALLOW_SUPER 0
409#define UNICODE_ALLOW_ANY 0
b851fbc1 410
1d72bdf6
NIS
411#define UNICODE_IS_SURROGATE(c) ((c) >= UNICODE_SURROGATE_FIRST && \
412 (c) <= UNICODE_SURROGATE_LAST)
a10ec373 413#define UNICODE_IS_REPLACEMENT(c) ((c) == UNICODE_REPLACEMENT)
872c91ae 414#define UNICODE_IS_BYTE_ORDER_MARK(c) ((c) == UNICODE_BYTE_ORDER_MARK)
7131f24d
KW
415#define UNICODE_IS_NONCHAR(c) ((c >= 0xFDD0 && c <= 0xFDEF) \
416 /* The other noncharacters end in FFFE or FFFF, which \
417 * the mask below catches both of, but beyond the last \
418 * official unicode code point, they aren't \
419 * noncharacters, since those aren't Unicode \
420 * characters at all */ \
421 || ((((c & 0xFFFE) == 0xFFFE)) && ! UNICODE_IS_SUPER(c)))
422#define UNICODE_IS_SUPER(c) ((c) > PERL_UNICODE_MAX)
423#define UNICODE_IS_FE_FF(c) ((c) > 0x7FFFFFFF)
1d72bdf6 424
f067b878
NA
425#ifdef HAS_QUAD
426# define UTF8_QUAD_MAX UINT64_C(0x1000000000)
427#endif
3bd709b1 428
ec34087a
KW
429#define LATIN_SMALL_LETTER_SHARP_S LATIN_SMALL_LETTER_SHARP_S_NATIVE
430#define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS \
431 LATIN_SMALL_LETTER_Y_WITH_DIAERESIS_NATIVE
432#define MICRO_SIGN MICRO_SIGN_NATIVE
433#define LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE \
434 LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE_NATIVE
435#define LATIN_SMALL_LETTER_A_WITH_RING_ABOVE \
436 LATIN_SMALL_LETTER_A_WITH_RING_ABOVE_NATIVE
09091399
JH
437#define UNICODE_GREEK_CAPITAL_LETTER_SIGMA 0x03A3
438#define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA 0x03C2
439#define UNICODE_GREEK_SMALL_LETTER_SIGMA 0x03C3
9dcbe121 440#define GREEK_SMALL_LETTER_MU 0x03BC
78a0d3cc
KW
441#define GREEK_CAPITAL_LETTER_MU 0x039C /* Upper and title case of MICRON */
442#define LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS 0x0178 /* Also is title case */
97298f37 443#define LATIN_CAPITAL_LETTER_SHARP_S 0x1E9E
8d64d87f
KW
444#define LATIN_SMALL_LETTER_LONG_S 0x017F
445#define KELVIN_SIGN 0x212A
446#define ANGSTROM_SIGN 0x212B
09091399 447
9e55ce06 448#define UNI_DISPLAY_ISPRINT 0x0001
c728cb41
JH
449#define UNI_DISPLAY_BACKSLASH 0x0002
450#define UNI_DISPLAY_QQ (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
451#define UNI_DISPLAY_REGEX (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
9e55ce06 452
5cd46e1f
KW
453#define ANYOF_FOLD_SHARP_S(node, input, end) \
454 (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \
137165a6 455 (ANYOF_NONBITMAP(node)) && \
39065660 456 (ANYOF_FLAGS(node) & ANYOF_LOC_NONBITMAP_FOLD) && \
07b6858f
JH
457 ((end) > (input) + 1) && \
458 toLOWER((input)[0]) == 's' && \
459 toLOWER((input)[1]) == 's')
ebc501f0 460#define SHARP_S_SKIP 2
3b0fc154 461
a4f7a67c
KW
462/* If you want to exclude surrogates, and beyond legal Unicode, see the blame
463 * log for earlier versions which gave details for these */
4d646140
KW
464
465#ifndef EBCDIC
466/* This was generated by regen/regcharclass.pl, and then moved here. The lines
467 * that generated it were then commented out. This was done solely because it
468 * takes on the order of 10 minutes to generate, and is never going to change.
469 * The EBCDIC equivalent hasn't been commented out in regcharclass.pl, so it
470 * should generate and run the correct stuff */
471/*** GENERATED CODE ***/
472#define is_UTF8_CHAR_utf8_safe(s,e) \
473( ((e)-(s) > 3) ? \
474 ( ( ( ((U8*)s)[0] & 0x80 ) == 0x00 ) ? 1 \
475 : ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ? \
476 ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 ) \
477 : ( 0xE0 == ((U8*)s)[0] ) ? \
478 ( ( ( ( ((U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
479 : ( 0xE1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xEF ) ? \
480 ( ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
481 : ( 0xF0 == ((U8*)s)[0] ) ? \
482 ( ( ( ( 0x90 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0xBF ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
483 : ( 0xF1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xF7 ) ? \
484 ( ( ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
485 : 0 ) \
486: ((e)-(s) > 2) ? \
487 ( ( ( ((U8*)s)[0] & 0x80 ) == 0x00 ) ? 1 \
488 : ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ? \
489 ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 ) \
490 : ( 0xE0 == ((U8*)s)[0] ) ? \
491 ( ( ( ( ((U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
492 : ( 0xE1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xEF ) ? \
493 ( ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
494 : 0 ) \
495: ((e)-(s) > 1) ? \
496 ( ( ( ((U8*)s)[0] & 0x80 ) == 0x00 ) ? 1 \
497 : ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ? \
498 ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 ) \
499 : 0 ) \
500: ((e)-(s) > 0) ? \
501 ( ( ((U8*)s)[0] & 0x80 ) == 0x00 ) \
502: 0 )
503#endif
3b0fc154
JH
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". */
4d646140 510#define IS_UTF8_CHAR(p, n) (is_UTF8_CHAR_utf8_safe(p, (p) + (n)) == n)
2f454f11 511
4d646140
KW
512/* regen/regcharclass.pl generates is_UTF8_CHAR_utf8_safe() macros for up to
513 * these number of bytes. So this has to be coordinated with it */
514#ifdef EBCDIC
2f454f11 515# define IS_UTF8_CHAR_FAST(n) ((n) <= 5)
4d646140
KW
516#else
517# define IS_UTF8_CHAR_FAST(n) ((n) <= 4)
518#endif
e9a8c099 519
57f0e7e2
KW
520#endif /* H_UTF8 */
521
e9a8c099
MHM
522/*
523 * Local variables:
524 * c-indentation-style: bsd
525 * c-basic-offset: 4
14d04a33 526 * indent-tabs-mode: nil
e9a8c099
MHM
527 * End:
528 *
14d04a33 529 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 530 */