This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
utf8.h: Fix macro definition
[perl5.git] / utf8.h
CommitLineData
a0ed51b3
LW
1/* utf8.h
2 *
f3cb6f94
KW
3 * This file contains definitions for use with the UTF-8 encoding. It
4 * actually also works with the variant UTF-8 encoding called UTF-EBCDIC, and
5 * hides almost all of the differences between these from the caller. In other
6 * words, someone should #include this file, and if the code is being compiled
7 * on an EBCDIC platform, things should mostly just work.
8 *
2eee27d7
SS
9 * Copyright (C) 2000, 2001, 2002, 2005, 2006, 2007, 2009,
10 * 2010, 2011 by Larry Wall and others
a0ed51b3
LW
11 *
12 * You may distribute under the terms of either the GNU General Public
13 * License or the Artistic License, as specified in the README file.
14 *
15 */
16
57f0e7e2
KW
17#ifndef H_UTF8 /* Guard against recursive inclusion */
18#define H_UTF8 1
19
39e02b42 20/* Use UTF-8 as the default script encoding?
1e54db1a 21 * Turning this on will break scripts having non-UTF-8 binary
39e02b42
JH
22 * data (such as Latin-1) in string literals. */
23#ifdef USE_UTF8_SCRIPTS
24# define USE_UTF8_IN_NAMES (!IN_BYTES)
25#else
26# define USE_UTF8_IN_NAMES (PL_hints & HINT_UTF8)
27#endif
28
3cd96634
KW
29#include "regcharclass.h"
30#include "unicode_constants.h"
31
051a06d4 32/* For to_utf8_fold_flags, q.v. */
e4f4ef45
KW
33#define FOLD_FLAGS_LOCALE 0x1
34#define FOLD_FLAGS_FULL 0x2
35#define FOLD_FLAGS_NOMIX_ASCII 0x4
051a06d4 36
83199d38
KW
37/* For _core_swash_init(), internal core use only */
38#define _CORE_SWASH_INIT_USER_DEFINED_PROPERTY 0x1
5d3d13d1 39#define _CORE_SWASH_INIT_RETURN_IF_UNDEF 0x2
87367d5f 40#define _CORE_SWASH_INIT_ACCEPT_INVLIST 0x4
83199d38 41
7bbfa158
KW
42/*
43=head1 Unicode Support
8cca77bc
KW
44L<perlguts/Unicode Support> has an introduction to this API.
45
46See also L</Character classification>,
47and L</Character case changing>.
48Various functions outside this section also work specially with Unicode.
49Search for the string "utf8" in this document.
7bbfa158
KW
50
51=for apidoc is_ascii_string
52
53This is a misleadingly-named synonym for L</is_invariant_string>.
54On ASCII-ish platforms, the name isn't misleading: the ASCII-range characters
55are exactly the UTF-8 invariants. But EBCDIC machines have more invariants
56than just the ASCII characters, so C<is_invariant_string> is preferred.
57
58=cut
59*/
60#define is_ascii_string(s, len) is_invariant_string(s, len)
61
de69f3af
KW
62#define uvchr_to_utf8(a,b) uvchr_to_utf8_flags(a,b,0)
63#define uvchr_to_utf8_flags(d,uv,flags) \
64 uvoffuni_to_utf8_flags(d,NATIVE_TO_UNI(uv),flags)
65#define utf8_to_uvchr_buf(s, e, lenp) \
842991ae 66 utf8n_to_uvchr(s, (U8*)(e) - (U8*)(s), lenp, \
de69f3af
KW
67 ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY)
68
a0270393 69#define to_uni_fold(c, p, lenp) _to_uni_fold_flags(c, p, lenp, FOLD_FLAGS_FULL)
445bf929
KW
70#define to_utf8_fold(c, p, lenp) _to_utf8_fold_flags(c, p, lenp, FOLD_FLAGS_FULL)
71#define to_utf8_lower(a,b,c) _to_utf8_lower_flags(a,b,c,0)
72#define to_utf8_upper(a,b,c) _to_utf8_upper_flags(a,b,c,0)
73#define to_utf8_title(a,b,c) _to_utf8_title_flags(a,b,c,0)
36bb2ab6 74
fd7cb289 75/* Source backward compatibility. */
fd7cb289
RGS
76#define is_utf8_string_loc(s, len, ep) is_utf8_string_loclen(s, len, ep, 0)
77
eda9cac1
KW
78#define foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
79 foldEQ_utf8_flags(s1, pe1, l1, u1, s2, pe2, l2, u2, 0)
baa60164 80#define FOLDEQ_UTF8_NOMIX_ASCII (1 << 0)
cea315b6 81#define FOLDEQ_LOCALE (1 << 1)
18f762c3
KW
82#define FOLDEQ_S1_ALREADY_FOLDED (1 << 2)
83#define FOLDEQ_S2_ALREADY_FOLDED (1 << 3)
d635b710
KW
84#define FOLDEQ_S1_FOLDS_SANE (1 << 4)
85#define FOLDEQ_S2_FOLDS_SANE (1 << 5)
a33c29bc 86
e6226b18
KW
87#define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
88 cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2))
89
1d72bdf6
NIS
90#ifdef EBCDIC
91/* The equivalent of these macros but implementing UTF-EBCDIC
92 are in the following header file:
93 */
94
95#include "utfebcdic.h"
fd7cb289 96
d06134e5 97#else /* ! EBCDIC */
73c4f7a1
GS
98START_EXTERN_C
99
111e8ed9
KW
100/* How wide can a single UTF-8 encoded character become in bytes. */
101/* NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8 since UTF-8
102 * is an encoding of Unicode, and Unicode's upper limit, 0x10FFFF, can be
103 * expressed with 4 bytes. However, Perl thinks of UTF-8 as a way to encode
104 * non-negative integers in a binary format, even those above Unicode */
105#define UTF8_MAXBYTES 13
106
a0ed51b3 107#ifdef DOINIT
6f06b55f 108EXTCONST unsigned char PL_utf8skip[] = {
b2635aa8
KW
109/* 0x00 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
110/* 0x10 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
111/* 0x20 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
112/* 0x30 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
113/* 0x40 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
114/* 0x50 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
115/* 0x60 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
116/* 0x70 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
117/* 0x80 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
118/* 0x90 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
119/* 0xA0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
120/* 0xB0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
121/* 0xC0 */ 2,2, /* overlong */
1ff3baa2 122/* 0xC2 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0080 to U+03FF */
b2635aa8
KW
123/* 0xD0 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0400 to U+07FF */
124/* 0xE0 */ 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3, /* U+0800 to U+FFFF */
125/* 0xF0 */ 4,4,4,4,4,4,4,4,5,5,5,5,6,6, /* above BMP to 2**31 - 1 */
6937f885
KW
126 /* Perl extended (never was official UTF-8). Up to 36 bit */
127/* 0xFE */ 7,
128 /* More extended, Up to 72 bits (64-bit + reserved) */
111e8ed9 129/* 0xFF */ UTF8_MAXBYTES
a0ed51b3
LW
130};
131#else
6f06b55f 132EXTCONST unsigned char PL_utf8skip[];
a0ed51b3
LW
133#endif
134
73c4f7a1 135END_EXTERN_C
7e2040f0 136
59a449d5
KW
137/* Native character to/from iso-8859-1. Are the identity functions on ASCII
138 * platforms */
4c8cd605
KW
139#define NATIVE_TO_LATIN1(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
140#define LATIN1_TO_NATIVE(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
59a449d5
KW
141
142/* I8 is an intermediate version of UTF-8 used only in UTF-EBCDIC. We thus
143 * consider it to be identical to UTF-8 on ASCII platforms. Strictly speaking
144 * UTF-8 and UTF-EBCDIC are two different things, but we often conflate them
145 * because they are 8-bit encodings that serve the same purpose in Perl, and
146 * rarely do we need to distinguish them. The term "NATIVE_UTF8" applies to
147 * whichever one is applicable on the current platform */
4c8cd605
KW
148#define NATIVE_UTF8_TO_I8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
149#define I8_TO_NATIVE_UTF8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
59a449d5 150
1d72bdf6 151/* Transforms in wide UV chars */
4c8cd605
KW
152#define UNI_TO_NATIVE(ch) ((UV) (ch))
153#define NATIVE_TO_UNI(ch) ((UV) (ch))
d7578b48 154
877d9f0d 155/*
9041c2e3 156
8c007b5a 157 The following table is from Unicode 3.2.
877d9f0d
JH
158
159 Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte
160
375122d7 161 U+0000..U+007F 00..7F
e1b711da 162 U+0080..U+07FF * C2..DF 80..BF
37e2e78e 163 U+0800..U+0FFF E0 * A0..BF 80..BF
375122d7 164 U+1000..U+CFFF E1..EC 80..BF 80..BF
e1b711da 165 U+D000..U+D7FF ED 80..9F 80..BF
537124e4 166 U+D800..U+DFFF ED A0..BF 80..BF (surrogates)
375122d7 167 U+E000..U+FFFF EE..EF 80..BF 80..BF
37e2e78e 168 U+10000..U+3FFFF F0 * 90..BF 80..BF 80..BF
877d9f0d
JH
169 U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF
170 U+100000..U+10FFFF F4 80..8F 80..BF 80..BF
b2635aa8
KW
171 Below are non-Unicode code points
172 U+110000..U+13FFFF F4 90..BF 80..BF 80..BF
173 U+110000..U+1FFFFF F5..F7 80..BF 80..BF 80..BF
537124e4 174 U+200000..: F8.. * 88..BF 80..BF 80..BF 80..BF
877d9f0d 175
e1b711da 176Note the gaps before several of the byte entries above marked by '*'. These are
37e2e78e
KW
177caused by legal UTF-8 avoiding non-shortest encodings: it is technically
178possible to UTF-8-encode a single code point in different ways, but that is
179explicitly forbidden, and the shortest possible encoding should always be used
15824458 180(and that is what Perl does). The non-shortest ones are called 'overlongs'.
8c007b5a 181
877d9f0d
JH
182 */
183
8c007b5a
JH
184/*
185 Another way to look at it, as bits:
186
b2635aa8 187 Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte
8c007b5a 188
b2635aa8
KW
189 0aaa aaaa 0aaa aaaa
190 0000 0bbb bbaa aaaa 110b bbbb 10aa aaaa
191 cccc bbbb bbaa aaaa 1110 cccc 10bb bbbb 10aa aaaa
192 00 000d ddcc cccc bbbb bbaa aaaa 1111 0ddd 10cc cccc 10bb bbbb 10aa aaaa
8c007b5a
JH
193
194As you can see, the continuation bytes all begin with C<10>, and the
e1b711da 195leading bits of the start byte tell how many bytes there are in the
8c007b5a
JH
196encoded character.
197
65ab9279
TC
198Perl's extended UTF-8 means we can have start bytes up to FF.
199
8c007b5a
JH
200*/
201
6c88483e 202/* Is the representation of the Unicode code point 'cp' the same regardless of
15824458 203 * being encoded in UTF-8 or not? */
2d1545e5 204#define OFFUNI_IS_INVARIANT(cp) isASCII(cp)
15824458 205
38953e5a
KW
206/* Is the representation of the code point 'cp' the same regardless of
207 * being encoded in UTF-8 or not? 'cp' is native if < 256; Unicode otherwise
208 * */
cf1be84e 209#define UVCHR_IS_INVARIANT(cp) OFFUNI_IS_INVARIANT(cp)
38953e5a 210
c9264833
KW
211/* This defines the bits that are to be in the continuation bytes of a multi-byte
212 * UTF-8 encoded character that mark it is a continuation byte. */
213#define UTF_CONTINUATION_MARK 0x80
214
a95ec4fb
KW
215/* Misleadingly named: is the UTF8-encoded byte 'c' part of a variant sequence
216 * in UTF-8? This is the inverse of UTF8_IS_INVARIANT */
c9264833 217#define UTF8_IS_CONTINUED(c) (((U8)c) & UTF_CONTINUATION_MARK)
15824458
KW
218
219/* Is the byte 'c' the first byte of a multi-byte UTF8-8 encoded sequence?
220 * This doesn't catch invariants (they are single-byte). It also excludes the
221 * illegal overlong sequences that begin with C0 and C1. */
e4f4ef45 222#define UTF8_IS_START(c) (((U8)c) >= 0xc2)
15824458
KW
223
224/* Is the byte 'c' part of a multi-byte UTF8-8 encoded sequence, and not the
225 * first byte thereof? */
c9264833 226#define UTF8_IS_CONTINUATION(c) ((((U8)c) & 0xC0) == UTF_CONTINUATION_MARK)
0ae1fa71 227
15824458
KW
228/* Is the UTF8-encoded byte 'c' the first byte of a two byte sequence? Use
229 * UTF8_IS_NEXT_CHAR_DOWNGRADEABLE() instead if the input isn't known to
230 * be well-formed. Masking with 0xfe allows the low bit to be 0 or 1; thus
231 * this matches 0xc[23]. */
559c7f10 232#define UTF8_IS_DOWNGRADEABLE_START(c) (((U8)(c) & 0xfe) == 0xc2)
4ab10950 233
15824458
KW
234/* Is the UTF8-encoded byte 'c' the first byte of a sequence of bytes that
235 * represent a code point > 255? */
e4f4ef45 236#define UTF8_IS_ABOVE_LATIN1(c) ((U8)(c) >= 0xc4)
8850bf83 237
15824458
KW
238/* This is the number of low-order bits a continuation byte in a UTF-8 encoded
239 * sequence contributes to the specification of the code point. In the bit
240 * maps above, you see that the first 2 bits are a constant '10', leaving 6 of
241 * real information */
1d72bdf6 242#define UTF_ACCUMULATION_SHIFT 6
b2635aa8 243
fed423a5
KW
244/* ^? is defined to be DEL on ASCII systems. See the definition of toCTRL()
245 * for more */
246#define QUESTION_MARK_CTRL DEL_NATIVE
247
248/* Surrogates, non-character code points and above-Unicode code points are
249 * problematic in some contexts. This allows code that needs to check for
250 * those to to quickly exclude the vast majority of code points it will
251 * encounter */
252#define isUTF8_POSSIBLY_PROBLEMATIC(c) ((U8) c >= 0xED)
253
254#endif /* EBCDIC vs ASCII */
255
256/* 2**UTF_ACCUMULATION_SHIFT - 1 */
257#define UTF_CONTINUATION_MASK ((U8) ((1U << UTF_ACCUMULATION_SHIFT) - 1))
258
7028aeba
KW
259/* Internal macro to be used only in this file to aid in constructing other
260 * publicly accessible macros.
261 * The number of bytes required to express this uv in UTF-8, for just those
262 * uv's requiring 2 through 6 bytes, as these are common to all platforms and
263 * word sizes. The number of bytes needed is given by the number of leading 1
264 * bits in the start byte. There are 32 start bytes that have 2 initial 1 bits
265 * (C0-DF); there are 16 that have 3 initial 1 bits (E0-EF); 8 that have 4
266 * initial 1 bits (F0-F8); 4 that have 5 initial 1 bits (F9-FB), and 2 that
267 * have 6 initial 1 bits (FC-FD). The largest number a string of n bytes can
268 * represent is (the number of possible start bytes for 'n')
269 * * (the number of possiblities for each start byte
270 * The latter in turn is
271 * 2 ** ( (how many continuation bytes there are)
272 * * (the number of bits of information each
273 * continuation byte holds))
274 *
275 * If we were on a platform where we could use a fast find first set bit
276 * instruction (or count leading zeros instruction) this could be replaced by
277 * using that to find the log2 of the uv, and divide that by the number of bits
278 * of information in each continuation byte, adjusting for large cases and how
279 * much information is in a start byte for that length */
72164d3a 280#define __COMMON_UNI_SKIP(uv) \
7028aeba
KW
281 (UV) (uv) < (32 * (1U << ( UTF_ACCUMULATION_SHIFT))) ? 2 : \
282 (UV) (uv) < (16 * (1U << (2 * UTF_ACCUMULATION_SHIFT))) ? 3 : \
283 (UV) (uv) < ( 8 * (1U << (3 * UTF_ACCUMULATION_SHIFT))) ? 4 : \
284 (UV) (uv) < ( 4 * (1U << (4 * UTF_ACCUMULATION_SHIFT))) ? 5 : \
285 (UV) (uv) < ( 2 * (1U << (5 * UTF_ACCUMULATION_SHIFT))) ? 6 :
72164d3a
KW
286
287/* Internal macro to be used only in this file.
288 * This adds to __COMMON_UNI_SKIP the details at this platform's upper range.
fed423a5 289 * For any-sized EBCDIC platforms, or 64-bit ASCII ones, we need one more test
72164d3a
KW
290 * to see if just 7 bytes is needed, or if the maximum is needed. For 32-bit
291 * ASCII platforms, everything is representable by 7 bytes */
fed423a5 292#if defined(UV_IS_QUAD) || defined(EBCDIC)
72164d3a 293# define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) \
7028aeba 294 (UV) (uv) < ((UV) 1U << (6 * UTF_ACCUMULATION_SHIFT)) ? 7 : UTF8_MAXBYTES)
1d68d6cd 295#else
72164d3a 296# define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) 7)
1d68d6cd
SC
297#endif
298
fed423a5
KW
299/* The next two macros use the base macro defined above, and add in the tests
300 * at the low-end of the range, for just 1 byte, yielding complete macros,
301 * publicly accessible. */
302
303/* Input is a true Unicode (not-native) code point */
304#define OFFUNISKIP(uv) (OFFUNI_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv))
2084b489 305
5352a763
KW
306/*
307
308=for apidoc Am|STRLEN|UVCHR_SKIP|UV cp
309returns the number of bytes required to represent the code point C<cp> when
310encoded as UTF-8. C<cp> is a native (ASCII or EBCDIC) code point if less than
311255; a Unicode code point otherwise.
312
313=cut
314 */
fdb6583d 315#define UVCHR_SKIP(uv) ( UVCHR_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv))
5352a763 316
fed423a5
KW
317/* As explained in the comments for __COMMON_UNI_SKIP, 32 start bytes with
318 * UTF_ACCUMULATION_SHIFT bits of information each */
aa206fb7
KW
319#define MAX_UTF8_TWO_BYTE (32 * (1U << UTF_ACCUMULATION_SHIFT) - 1)
320
321/* constrained by EBCDIC which has 5 bits per continuation byte */
322#define MAX_PORTABLE_UTF8_TWO_BYTE (32 * (1U << 5) - 1)
323
c03c0950
KW
324/* The maximum number of UTF-8 bytes a single Unicode character can
325 * uppercase/lowercase/fold into. Unicode guarantees that the maximum
326 * expansion is UTF8_MAX_FOLD_CHAR_EXPAND characters, but any above-Unicode
327 * code point will fold to itself, so we only have to look at the expansion of
328 * the maximum Unicode code point. But this number may be less than the space
329 * occupied by a very large code point under Perl's extended UTF-8. We have to
330 * make it large enough to fit any single character. (It turns out that ASCII
331 * and EBCDIC differ in which is larger) */
332#define UTF8_MAXBYTES_CASE \
333 (UTF8_MAXBYTES >= (UTF8_MAX_FOLD_CHAR_EXPAND * OFFUNISKIP(0x10FFFF)) \
334 ? UTF8_MAXBYTES \
335 : (UTF8_MAX_FOLD_CHAR_EXPAND * OFFUNISKIP(0x10FFFF)))
336
d06134e5
KW
337/* Rest of these are attributes of Unicode and perl's internals rather than the
338 * encoding, or happen to be the same in both ASCII and EBCDIC (at least at
339 * this level; the macros that some of these call may have different
340 * definitions in the two encodings */
341
59a449d5
KW
342/* In domain restricted to ASCII, these may make more sense to the reader than
343 * the ones with Latin1 in the name */
344#define NATIVE_TO_ASCII(ch) NATIVE_TO_LATIN1(ch)
345#define ASCII_TO_NATIVE(ch) LATIN1_TO_NATIVE(ch)
346
347/* More or less misleadingly-named defines, retained for back compat */
348#define NATIVE_TO_UTF(ch) NATIVE_UTF8_TO_I8(ch)
349#define NATIVE_TO_I8(ch) NATIVE_UTF8_TO_I8(ch)
350#define UTF_TO_NATIVE(ch) I8_TO_NATIVE_UTF8(ch)
351#define I8_TO_NATIVE(ch) I8_TO_NATIVE_UTF8(ch)
352#define NATIVE8_TO_UNI(ch) NATIVE_TO_LATIN1(ch)
d06134e5 353
c0236afe 354/* This defines the 1-bits that are to be in the first byte of a multi-byte
97d0ceda
KW
355 * UTF-8 encoded character that mark it as a start byte and give the number of
356 * bytes that comprise the character. 'len' is the number of bytes in the
357 * multi-byte sequence. */
c0236afe
KW
358#define UTF_START_MARK(len) (((len) > 7) ? 0xFF : (0xFF & (0xFE << (7-(len)))))
359
360/* Masks out the initial one bits in a start byte, leaving the real data ones.
361 * Doesn't work on an invariant byte. 'len' is the number of bytes in the
362 * multi-byte sequence that comprises the character. */
363#define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2)))
364
537124e4
KW
365/* Adds a UTF8 continuation byte 'new' of information to a running total code
366 * point 'old' of all the continuation bytes so far. This is designed to be
155d2738
KW
367 * used in a loop to convert from UTF-8 to the code point represented. Note
368 * that this is asymmetric on EBCDIC platforms, in that the 'new' parameter is
369 * the UTF-EBCDIC byte, whereas the 'old' parameter is a Unicode (not EBCDIC)
370 * code point in process of being generated */
371#define UTF8_ACCUMULATE(old, new) (((old) << UTF_ACCUMULATION_SHIFT) \
372 | ((NATIVE_UTF8_TO_I8((U8)new)) \
373 & UTF_CONTINUATION_MASK))
d06134e5 374
7c560c3b
KW
375/* If a value is anded with this, and the result is non-zero, then using the
376 * original value in UTF8_ACCUMULATE will overflow, shifting bits off the left
377 * */
378#define UTF_ACCUMULATION_OVERFLOW_MASK \
379 (((UV) UTF_CONTINUATION_MASK) << ((sizeof(UV) * CHARBITS) \
380 - UTF_ACCUMULATION_SHIFT))
381
4ab10950
KW
382/* This works in the face of malformed UTF-8. */
383#define UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, e) (UTF8_IS_DOWNGRADEABLE_START(*s) \
384 && ( (e) - (s) > 1) \
385 && UTF8_IS_CONTINUATION(*((s)+1)))
386
5aaebcb3 387/* Number of bytes a code point occupies in UTF-8. */
5352a763 388#define NATIVE_SKIP(uv) UVCHR_SKIP(uv)
bd18bd40 389
5aaebcb3
KW
390/* Most code which says UNISKIP is really thinking in terms of native code
391 * points (0-255) plus all those beyond. This is an imprecise term, but having
2accb712 392 * it means existing code continues to work. For precision, use UVCHR_SKIP,
5352a763
KW
393 * NATIVE_SKIP, or OFFUNISKIP */
394#define UNISKIP(uv) UVCHR_SKIP(uv)
5aaebcb3 395
3c0792e4
KW
396/* Longer, but more accurate name */
397#define UTF8_IS_ABOVE_LATIN1_START(c) UTF8_IS_ABOVE_LATIN1(c)
398
a62b247b
KW
399/* Convert a UTF-8 variant Latin1 character to a native code point value.
400 * Needs just one iteration of accumulate. Should be used only if it is known
401 * that the code point is < 256, and is not UTF-8 invariant. Use the slower
402 * but more general TWO_BYTE_UTF8_TO_NATIVE() which handles any code point
403 * representable by two bytes (which turns out to be up through
404 * MAX_PORTABLE_UTF8_TWO_BYTE). The two parameters are:
405 * HI: a downgradable start byte;
406 * LO: continuation.
407 * */
408#define EIGHT_BIT_UTF8_TO_NATIVE(HI, LO) \
409 ( __ASSERT_(UTF8_IS_DOWNGRADEABLE_START(HI)) \
410 __ASSERT_(UTF8_IS_CONTINUATION(LO)) \
411 LATIN1_TO_NATIVE(UTF8_ACCUMULATE(( \
412 NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), (LO))))
413
94bb8c36 414/* Convert a two (not one) byte utf8 character to a native code point value.
2950f2a7
KW
415 * Needs just one iteration of accumulate. Should not be used unless it is
416 * known that the two bytes are legal: 1) two-byte start, and 2) continuation.
417 * Note that the result can be larger than 255 if the input character is not
418 * downgradable */
94bb8c36 419#define TWO_BYTE_UTF8_TO_NATIVE(HI, LO) \
b18b15ad 420 ( __ASSERT_(PL_utf8skip[HI] == 2) \
635e76f5 421 __ASSERT_(UTF8_IS_CONTINUATION(LO)) \
94bb8c36 422 UNI_TO_NATIVE(UTF8_ACCUMULATE((NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), \
635e76f5 423 (LO))))
94bb8c36
KW
424
425/* Should never be used, and be deprecated */
426#define TWO_BYTE_UTF8_TO_UNI(HI, LO) NATIVE_TO_UNI(TWO_BYTE_UTF8_TO_NATIVE(HI, LO))
2950f2a7 427
bd18bd40
KW
428/*
429
430=for apidoc Am|STRLEN|UTF8SKIP|char* s
431returns the number of bytes in the UTF-8 encoded character whose first (perhaps
432only) byte is pointed to by C<s>.
433
434=cut
435 */
2a70536e
KW
436#define UTF8SKIP(s) PL_utf8skip[*(const U8*)(s)]
437#define UTF8_SKIP(s) UTF8SKIP(s)
d06134e5 438
2d1545e5
KW
439/* Most code that says 'UNI_' really means the native value for code points up
440 * through 255 */
441#define UNI_IS_INVARIANT(cp) UVCHR_IS_INVARIANT(cp)
442
15824458
KW
443/* Is the byte 'c' the same character when encoded in UTF-8 as when not. This
444 * works on both UTF-8 encoded strings and non-encoded, as it returns TRUE in
5fc230f1
KW
445 * each for the exact same set of bit patterns. It is valid on a subset of
446 * what UVCHR_IS_INVARIANT is valid on, so can just use that; and the compiler
447 * should optimize out anything extraneous given the implementation of the
448 * latter */
449#define UTF8_IS_INVARIANT(c) UVCHR_IS_INVARIANT(c)
450
451/* Like the above, but its name implies a non-UTF8 input, which as the comments
452 * above show, doesn't matter as to its implementation */
38953e5a 453#define NATIVE_BYTE_IS_INVARIANT(c) UVCHR_IS_INVARIANT(c)
d06134e5 454
48ccf5e1
KW
455/* The macros in the next 4 sets are used to generate the two utf8 or utfebcdic
456 * bytes from an ordinal that is known to fit into exactly two (not one) bytes;
457 * it must be less than 0x3FF to work across both encodings. */
458
459/* These two are helper macros for the other three sets, and should not be used
460 * directly anywhere else. 'translate_function' is either NATIVE_TO_LATIN1
1ff3baa2
KW
461 * (which works for code points up through 0xFF) or NATIVE_TO_UNI which works
462 * for any code point */
48ccf5e1
KW
463#define __BASE_TWO_BYTE_HI(c, translate_function) \
464 I8_TO_NATIVE_UTF8((translate_function(c) >> UTF_ACCUMULATION_SHIFT) \
465 | UTF_START_MARK(2))
466#define __BASE_TWO_BYTE_LO(c, translate_function) \
467 I8_TO_NATIVE_UTF8((translate_function(c) & UTF_CONTINUATION_MASK) \
468 | UTF_CONTINUATION_MARK)
469
48ccf5e1
KW
470/* The next two macros should not be used. They were designed to be usable as
471 * the case label of a switch statement, but this doesn't work for EBCDIC. Use
9d0d3a03 472 * regen/unicode_constants.pl instead */
48ccf5e1
KW
473#define UTF8_TWO_BYTE_HI_nocast(c) __BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI)
474#define UTF8_TWO_BYTE_LO_nocast(c) __BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI)
475
476/* The next two macros are used when the source should be a single byte
477 * character; checked for under DEBUGGING */
478#define UTF8_EIGHT_BIT_HI(c) (__ASSERT_(FITS_IN_8_BITS(c)) \
4c8cd605 479 ( __BASE_TWO_BYTE_HI(c, NATIVE_TO_LATIN1)))
48ccf5e1 480#define UTF8_EIGHT_BIT_LO(c) (__ASSERT_(FITS_IN_8_BITS(c)) \
4c8cd605 481 (__BASE_TWO_BYTE_LO(c, NATIVE_TO_LATIN1)))
48ccf5e1
KW
482
483/* These final two macros in the series are used when the source can be any
484 * code point whose UTF-8 is known to occupy 2 bytes; they are less efficient
485 * than the EIGHT_BIT versions on EBCDIC platforms. We use the logical '~'
486 * operator instead of "<=" to avoid getting compiler warnings.
d52b8576 487 * MAX_UTF8_TWO_BYTE should be exactly all one bits in the lower few
48ccf5e1
KW
488 * places, so the ~ works */
489#define UTF8_TWO_BYTE_HI(c) \
490 (__ASSERT_((sizeof(c) == 1) \
d52b8576 491 || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE)) \
4c8cd605 492 (__BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI)))
48ccf5e1
KW
493#define UTF8_TWO_BYTE_LO(c) \
494 (__ASSERT_((sizeof(c) == 1) \
d52b8576 495 || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE)) \
4c8cd605 496 (__BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI)))
d06134e5 497
e7214ce8
KW
498/* This is illegal in any well-formed UTF-8 in both EBCDIC and ASCII
499 * as it is only in overlongs. */
500#define ILLEGAL_UTF8_BYTE I8_TO_NATIVE_UTF8(0xC1)
501
7e2040f0 502/*
e3036cf4 503 * 'UTF' is whether or not p is encoded in UTF8. The names 'foo_lazy_if' stem
20df05f4
KW
504 * from an earlier version of these macros in which they didn't call the
505 * foo_utf8() macros (i.e. were 'lazy') unless they decided that *p is the
506 * beginning of a utf8 character. Now that foo_utf8() determines that itself,
507 * no need to do it again here
7e2040f0 508 */
97d0ceda
KW
509#define isIDFIRST_lazy_if(p,UTF) ((IN_BYTES || !UTF) \
510 ? isIDFIRST(*(p)) \
e3036cf4 511 : isIDFIRST_utf8((const U8*)p))
97d0ceda
KW
512#define isWORDCHAR_lazy_if(p,UTF) ((IN_BYTES || (!UTF)) \
513 ? isWORDCHAR(*(p)) \
32636478
KW
514 : isWORDCHAR_utf8((const U8*)p))
515#define isALNUM_lazy_if(p,UTF) isWORDCHAR_lazy_if(p,UTF)
1d72bdf6 516
89ebb4a3
JH
517#define UTF8_MAXLEN UTF8_MAXBYTES
518
8cb75cc8
KW
519/* A Unicode character can fold to up to 3 characters */
520#define UTF8_MAX_FOLD_CHAR_EXPAND 3
521
a98fe34d 522#define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES)
bd18bd40
KW
523
524/*
525
526=for apidoc Am|bool|DO_UTF8|SV* sv
527Returns a bool giving whether or not the PV in C<sv> is to be treated as being
528encoded in UTF-8.
529
530You should use this I<after> a call to C<SvPV()> or one of its variants, in
531case any call to string overloading updates the internal UTF-8 encoding flag.
532
533=cut
534*/
0064a8a9 535#define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
1ff3baa2
KW
536
537/* Should all strings be treated as Unicode, and not just UTF-8 encoded ones?
538 * Is so within 'feature unicode_strings' or 'locale :not_characters', and not
539 * within 'use bytes'. UTF-8 locales are not tested for here, but perhaps
540 * could be */
541#define IN_UNI_8_BIT \
d6ded950
KW
542 (((CopHINTS_get(PL_curcop) & (HINT_UNI_8_BIT)) \
543 || (CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL \
544 /* -1 below is for :not_characters */ \
545 && _is_in_locale_category(FALSE, -1))) \
546 && ! IN_BYTES)
b36bf33f 547
1d72bdf6 548
c76687c5
KW
549#define UTF8_ALLOW_EMPTY 0x0001 /* Allow a zero length string */
550
551/* Allow first byte to be a continuation byte */
1d72bdf6 552#define UTF8_ALLOW_CONTINUATION 0x0002
c76687c5
KW
553
554/* Allow second... bytes to be non-continuation bytes */
1d72bdf6 555#define UTF8_ALLOW_NON_CONTINUATION 0x0004
949cf498
KW
556
557/* expecting more bytes than were available in the string */
558#define UTF8_ALLOW_SHORT 0x0008
559
560/* Overlong sequence; i.e., the code point can be specified in fewer bytes. */
561#define UTF8_ALLOW_LONG 0x0010
562
563#define UTF8_DISALLOW_SURROGATE 0x0020 /* Unicode surrogates */
564#define UTF8_WARN_SURROGATE 0x0040
565
566#define UTF8_DISALLOW_NONCHAR 0x0080 /* Unicode non-character */
567#define UTF8_WARN_NONCHAR 0x0100 /* code points */
568
569#define UTF8_DISALLOW_SUPER 0x0200 /* Super-set of Unicode: code */
570#define UTF8_WARN_SUPER 0x0400 /* points above the legal max */
571
d35f2ca5
KW
572/* Code points which never were part of the original UTF-8 standard, which only
573 * went up to 2 ** 31 - 1. Note that these all overflow a signed 32-bit word,
574 * The first byte of these code points is FE or FF on ASCII platforms. If the
575 * first byte is FF, it will overflow a 32-bit word. */
576#define UTF8_DISALLOW_ABOVE_31_BIT 0x0800
577#define UTF8_WARN_ABOVE_31_BIT 0x1000
578
579/* For back compat, these old names are misleading for UTF_EBCDIC */
580#define UTF8_DISALLOW_FE_FF UTF8_DISALLOW_ABOVE_31_BIT
581#define UTF8_WARN_FE_FF UTF8_WARN_ABOVE_31_BIT
949cf498
KW
582
583#define UTF8_CHECK_ONLY 0x2000
584
585/* For backwards source compatibility. They do nothing, as the default now
586 * includes what they used to mean. The first one's meaning was to allow the
587 * just the single non-character 0xFFFF */
588#define UTF8_ALLOW_FFFF 0
589#define UTF8_ALLOW_SURROGATE 0
590
d35f2ca5 591#define UTF8_DISALLOW_ILLEGAL_INTERCHANGE \
93e6dbd6
KW
592 ( UTF8_DISALLOW_SUPER|UTF8_DISALLOW_NONCHAR \
593 |UTF8_DISALLOW_SURROGATE)
949cf498 594#define UTF8_WARN_ILLEGAL_INTERCHANGE \
93e6dbd6
KW
595 (UTF8_WARN_SUPER|UTF8_WARN_NONCHAR|UTF8_WARN_SURROGATE)
596#define UTF8_ALLOW_ANY \
597 (~( UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_DISALLOW_ABOVE_31_BIT \
598 |UTF8_WARN_ILLEGAL_INTERCHANGE|UTF8_WARN_ABOVE_31_BIT))
949cf498
KW
599#define UTF8_ALLOW_ANYUV \
600 (UTF8_ALLOW_EMPTY \
601 & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
9f7f3913
ST
602#define UTF8_ALLOW_DEFAULT (ckWARN(WARN_UTF8) ? 0 : \
603 UTF8_ALLOW_ANYUV)
1d72bdf6 604
0c58a72b
KW
605/* Several of the macros below have a second parameter that is currently
606 * unused; but could be used in the future to make sure that the input is
607 * well-formed. */
608
609#define UTF8_IS_SURROGATE(s, e) cBOOL(is_SURROGATE_utf8(s))
b96a92fb 610#define UTF8_IS_REPLACEMENT(s, send) cBOOL(is_REPLACEMENT_utf8_safe(s,send))
7131f24d
KW
611
612/* ASCII EBCDIC I8
613 * U+10FFFF: \xF4\x8F\xBF\xBF \xF9\xA1\xBF\xBF\xBF max legal Unicode
614 * U+110000: \xF4\x90\x80\x80 \xF9\xA2\xA0\xA0\xA0
615 * U+110001: \xF4\x90\x80\x81 \xF9\xA2\xA0\xA0\xA1
a1776718
KW
616 *
617 * BE AWARE that this test doesn't rule out malformed code points, in
618 * particular overlongs */
7131f24d 619#ifdef EBCDIC /* Both versions assume well-formed UTF8 */
0c58a72b 620# define UTF8_IS_SUPER(s, e) (NATIVE_UTF8_TO_I8(* (U8*) (s)) >= 0xF9 \
bc3632a8 621 && (NATIVE_UTF8_TO_I8(* (U8*) (s)) > 0xF9 \
a3481822 622 || (NATIVE_UTF8_TO_I8(* ((U8*) (s) + 1)) >= 0xA2)))
7131f24d 623#else
0c58a72b
KW
624# define UTF8_IS_SUPER(s, e) (*(U8*) (s) >= 0xF4 \
625 && (*(U8*) (s) > 0xF4 || (*((U8*) (s) + 1) >= 0x90)))
7131f24d
KW
626#endif
627
b96a92fb
KW
628/* These are now machine generated, and the 'given' clause is no longer
629 * applicable */
0c58a72b 630#define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e) \
b96a92fb 631 cBOOL(is_NONCHAR_utf8(s))
0c58a72b
KW
632#define UTF8_IS_NONCHAR(s, e) \
633 UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e)
7131f24d 634
c867b360
JH
635#define UNICODE_SURROGATE_FIRST 0xD800
636#define UNICODE_SURROGATE_LAST 0xDFFF
637#define UNICODE_REPLACEMENT 0xFFFD
638#define UNICODE_BYTE_ORDER_MARK 0xFEFF
1d72bdf6 639
b851fbc1 640/* Though our UTF-8 encoding can go beyond this,
c76687c5 641 * let's be conservative and do as Unicode says. */
b851fbc1
JH
642#define PERL_UNICODE_MAX 0x10FFFF
643
d35f2ca5
KW
644#define UNICODE_WARN_SURROGATE 0x0001 /* UTF-16 surrogates */
645#define UNICODE_WARN_NONCHAR 0x0002 /* Non-char code points */
646#define UNICODE_WARN_SUPER 0x0004 /* Above 0x10FFFF */
647#define UNICODE_WARN_ABOVE_31_BIT 0x0008 /* Above 0x7FFF_FFFF */
648#define UNICODE_DISALLOW_SURROGATE 0x0010
649#define UNICODE_DISALLOW_NONCHAR 0x0020
650#define UNICODE_DISALLOW_SUPER 0x0040
651#define UNICODE_DISALLOW_ABOVE_31_BIT 0x0080
bb88be5f
KW
652#define UNICODE_WARN_ILLEGAL_INTERCHANGE \
653 (UNICODE_WARN_SURROGATE|UNICODE_WARN_NONCHAR|UNICODE_WARN_SUPER)
654#define UNICODE_DISALLOW_ILLEGAL_INTERCHANGE \
655 (UNICODE_DISALLOW_SURROGATE|UNICODE_DISALLOW_NONCHAR|UNICODE_DISALLOW_SUPER)
949cf498
KW
656
657/* For backward source compatibility, as are now the default */
658#define UNICODE_ALLOW_SURROGATE 0
659#define UNICODE_ALLOW_SUPER 0
660#define UNICODE_ALLOW_ANY 0
b851fbc1 661
2d6b3d38
KW
662/* This matches the 2048 code points between UNICODE_SURROGATE_FIRST (0xD800) and
663 * UNICODE_SURROGATE_LAST (0xDFFF) */
664#define UNICODE_IS_SURROGATE(uv) (((UV) (uv) & (~0xFFFF | 0xF800)) \
665 == 0xD800)
666
646d1759
KW
667#define UNICODE_IS_REPLACEMENT(uv) ((UV) (uv) == UNICODE_REPLACEMENT)
668#define UNICODE_IS_BYTE_ORDER_MARK(uv) ((UV) (uv) == UNICODE_BYTE_ORDER_MARK)
c149ab20
KW
669
670/* Is 'uv' one of the 32 contiguous-range noncharacters? */
671#define UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv) ((UV) (uv) >= 0xFDD0 \
672 && (UV) (uv) <= 0xFDEF)
673
674/* Is 'uv' one of the 34 plane-ending noncharacters 0xFFFE, 0xFFFF, 0x1FFFE,
675 * 0x1FFFF, ... 0x10FFFE, 0x10FFFF, given that we know that 'uv' is not above
676 * the Unicode legal max */
677#define UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv) \
678 (((UV) (uv) & 0xFFFE) == 0xFFFE)
679
680#define UNICODE_IS_NONCHAR(uv) \
681 ( UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv) \
682 || ( LIKELY( ! UNICODE_IS_SUPER(uv)) \
683 && UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv)))
684
685#define UNICODE_IS_SUPER(uv) ((UV) (uv) > PERL_UNICODE_MAX)
d35f2ca5 686#define UNICODE_IS_ABOVE_31_BIT(uv) ((UV) (uv) > 0x7FFFFFFF)
1d72bdf6 687
ec34087a
KW
688#define LATIN_SMALL_LETTER_SHARP_S LATIN_SMALL_LETTER_SHARP_S_NATIVE
689#define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS \
690 LATIN_SMALL_LETTER_Y_WITH_DIAERESIS_NATIVE
691#define MICRO_SIGN MICRO_SIGN_NATIVE
692#define LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE \
693 LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE_NATIVE
694#define LATIN_SMALL_LETTER_A_WITH_RING_ABOVE \
695 LATIN_SMALL_LETTER_A_WITH_RING_ABOVE_NATIVE
09091399
JH
696#define UNICODE_GREEK_CAPITAL_LETTER_SIGMA 0x03A3
697#define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA 0x03C2
698#define UNICODE_GREEK_SMALL_LETTER_SIGMA 0x03C3
9dcbe121 699#define GREEK_SMALL_LETTER_MU 0x03BC
9e682c18
KW
700#define GREEK_CAPITAL_LETTER_MU 0x039C /* Upper and title case
701 of MICRON */
702#define LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS 0x0178 /* Also is title case */
0766489e
KW
703#ifdef LATIN_CAPITAL_LETTER_SHARP_S_UTF8
704# define LATIN_CAPITAL_LETTER_SHARP_S 0x1E9E
705#endif
74894415
KW
706#define LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE 0x130
707#define LATIN_SMALL_LETTER_DOTLESS_I 0x131
9e682c18 708#define LATIN_SMALL_LETTER_LONG_S 0x017F
a9f50d33
KW
709#define LATIN_SMALL_LIGATURE_LONG_S_T 0xFB05
710#define LATIN_SMALL_LIGATURE_ST 0xFB06
9e682c18
KW
711#define KELVIN_SIGN 0x212A
712#define ANGSTROM_SIGN 0x212B
09091399 713
9e55ce06 714#define UNI_DISPLAY_ISPRINT 0x0001
c728cb41
JH
715#define UNI_DISPLAY_BACKSLASH 0x0002
716#define UNI_DISPLAY_QQ (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
717#define UNI_DISPLAY_REGEX (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
9e55ce06 718
5cd46e1f
KW
719#define ANYOF_FOLD_SHARP_S(node, input, end) \
720 (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \
137165a6 721 (ANYOF_NONBITMAP(node)) && \
39065660 722 (ANYOF_FLAGS(node) & ANYOF_LOC_NONBITMAP_FOLD) && \
07b6858f 723 ((end) > (input) + 1) && \
305b8651 724 isALPHA_FOLD_EQ((input)[0], 's'))
6302f837 725
ebc501f0 726#define SHARP_S_SKIP 2
3b0fc154 727
a4f7a67c
KW
728/* If you want to exclude surrogates, and beyond legal Unicode, see the blame
729 * log for earlier versions which gave details for these */
4d646140 730
6302f837
KW
731/* A helper macro for isUTF8_CHAR, so use that one, and not this one. This is
732 * retained solely for backwards compatibility and may be deprecated and
733 * removed in a future Perl version.
734 *
735 * regen/regcharclass.pl generates is_UTF8_CHAR_utf8() macros for up to these
d9f92374
KW
736 * number of bytes. So this has to be coordinated with that file */
737#ifdef EBCDIC
738# define IS_UTF8_CHAR_FAST(n) ((n) <= 3)
739#else
740# define IS_UTF8_CHAR_FAST(n) ((n) <= 4)
741#endif
742
4d646140 743#ifndef EBCDIC
6302f837
KW
744/* A helper macro for isUTF8_CHAR, so use that one instead of this. This was
745 * generated by regen/regcharclass.pl, and then moved here. The lines that
746 * generated it were then commented out. This was done solely because it takes
747 * on the order of 10 minutes to generate, and is never going to change, unless
748 * the generated code is improved.
749 *
1ff3baa2
KW
750 * The EBCDIC versions have been cut to not cover all of legal Unicode,
751 * otherwise they take too long to generate; besides there is a separate one
752 * for each code page, so they are in regcharclass.h instead of here */
39a0f513 753/*
5dca9278 754 UTF8_CHAR: Matches legal UTF-8 encoded characters from 2 through 4 bytes
39a0f513 755
5dca9278 756 0x80 - 0x1FFFFF
39a0f513 757*/
4d646140 758/*** GENERATED CODE ***/
5dca9278
KW
759#define is_UTF8_CHAR_utf8_no_length_checks(s) \
760( ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ? \
761 ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 ) \
762: ( 0xE0 == ((U8*)s)[0] ) ? \
763 ( ( ( ( ((U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
764: ( 0xE1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xEF ) ? \
765 ( ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
766: ( 0xF0 == ((U8*)s)[0] ) ? \
767 ( ( ( ( 0x90 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0xBF ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
768: ( ( ( ( 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 )
4d646140 769#endif
3b0fc154 770
6302f837 771/*
5dca9278
KW
772
773=for apidoc Am|STRLEN|isUTF8_CHAR|const U8 *s|const U8 *e
774
775Returns the number of bytes beginning at C<s> which form a legal UTF-8 (or
61b16eb9
KW
776UTF-EBCDIC) encoded character, looking no further than S<C<e - s>> bytes into
777C<s>. Returns 0 if the sequence starting at C<s> through S<C<e - 1>> is not
778well-formed UTF-8.
6302f837
KW
779
780Note that an INVARIANT character (i.e. ASCII on non-EBCDIC
5dca9278
KW
781machines) is a valid UTF-8 character.
782
783=cut
784*/
6302f837 785
dd9bc2b0 786#define isUTF8_CHAR(s, e) (UNLIKELY((e) <= (s)) \
6302f837
KW
787 ? 0 \
788 : (UTF8_IS_INVARIANT(*s)) \
789 ? 1 \
dd9bc2b0 790 : UNLIKELY(((e) - (s)) < UTF8SKIP(s)) \
6302f837 791 ? 0 \
dd9bc2b0 792 : LIKELY(IS_UTF8_CHAR_FAST(UTF8SKIP(s))) \
5dca9278 793 ? is_UTF8_CHAR_utf8_no_length_checks(s) \
6302f837
KW
794 : _is_utf8_char_slow(s, e))
795
3cedd9d9
KW
796#define is_utf8_char_buf(buf, buf_end) isUTF8_CHAR(buf, buf_end)
797
6302f837
KW
798/* Do not use; should be deprecated. Use isUTF8_CHAR() instead; this is
799 * retained solely for backwards compatibility */
800#define IS_UTF8_CHAR(p, n) (isUTF8_CHAR(p, (p) + (n)) == n)
e9a8c099 801
57f0e7e2
KW
802#endif /* H_UTF8 */
803
e9a8c099 804/*
14d04a33 805 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 806 */