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