This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
utf8.h: Add comment
[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
6a5bc5ac
KW
17#ifndef PERL_UTF8_H_ /* Guard against recursive inclusion */
18#define PERL_UTF8_H_ 1
57f0e7e2 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
7bbfa158
KW
37/*
38=head1 Unicode Support
8cca77bc
KW
39L<perlguts/Unicode Support> has an introduction to this API.
40
41See also L</Character classification>,
42and L</Character case changing>.
43Various functions outside this section also work specially with Unicode.
44Search for the string "utf8" in this document.
7bbfa158
KW
45
46=for apidoc is_ascii_string
47
8871a094 48This is a misleadingly-named synonym for L</is_utf8_invariant_string>.
7bbfa158
KW
49On ASCII-ish platforms, the name isn't misleading: the ASCII-range characters
50are exactly the UTF-8 invariants. But EBCDIC machines have more invariants
8871a094
KW
51than just the ASCII characters, so C<is_utf8_invariant_string> is preferred.
52
53=for apidoc is_invariant_string
54
55This is a somewhat misleadingly-named synonym for L</is_utf8_invariant_string>.
56C<is_utf8_invariant_string> is preferred, as it indicates under what conditions
57the string is invariant.
7bbfa158
KW
58
59=cut
60*/
8871a094
KW
61#define is_ascii_string(s, len) is_utf8_invariant_string(s, len)
62#define is_invariant_string(s, len) is_utf8_invariant_string(s, len)
7bbfa158 63
33f38593
KW
64#define uvoffuni_to_utf8_flags(d,uv,flags) \
65 uvoffuni_to_utf8_flags_msgs(d, uv, flags, 0)
de69f3af
KW
66#define uvchr_to_utf8(a,b) uvchr_to_utf8_flags(a,b,0)
67#define uvchr_to_utf8_flags(d,uv,flags) \
33f38593
KW
68 uvchr_to_utf8_flags_msgs(d,uv,flags, 0)
69#define uvchr_to_utf8_flags_msgs(d,uv,flags,msgs) \
70 uvoffuni_to_utf8_flags_msgs(d,NATIVE_TO_UNI(uv),flags, msgs)
de69f3af 71#define utf8_to_uvchr_buf(s, e, lenp) \
9a9a6c98 72 utf8_to_uvchr_buf_helper((const U8 *) (s), (const U8 *) e, lenp)
f9380377
KW
73#define utf8n_to_uvchr(s, len, lenp, flags) \
74 utf8n_to_uvchr_error(s, len, lenp, flags, 0)
37657a5b
KW
75#define utf8n_to_uvchr_error(s, len, lenp, flags, errors) \
76 utf8n_to_uvchr_msgs(s, len, lenp, flags, errors, 0)
de69f3af 77
a0270393 78#define to_uni_fold(c, p, lenp) _to_uni_fold_flags(c, p, lenp, FOLD_FLAGS_FULL)
a239b1e2 79
eda9cac1
KW
80#define foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
81 foldEQ_utf8_flags(s1, pe1, l1, u1, s2, pe2, l2, u2, 0)
baa60164 82#define FOLDEQ_UTF8_NOMIX_ASCII (1 << 0)
cea315b6 83#define FOLDEQ_LOCALE (1 << 1)
18f762c3
KW
84#define FOLDEQ_S1_ALREADY_FOLDED (1 << 2)
85#define FOLDEQ_S2_ALREADY_FOLDED (1 << 3)
d635b710
KW
86#define FOLDEQ_S1_FOLDS_SANE (1 << 4)
87#define FOLDEQ_S2_FOLDS_SANE (1 << 5)
a33c29bc 88
e6226b18
KW
89#define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
90 cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2))
91
1d72bdf6
NIS
92#ifdef EBCDIC
93/* The equivalent of these macros but implementing UTF-EBCDIC
94 are in the following header file:
95 */
96
97#include "utfebcdic.h"
fd7cb289 98
d06134e5 99#else /* ! EBCDIC */
73c4f7a1
GS
100START_EXTERN_C
101
f4d83e55
KW
102/*
103
104=for apidoc AmnU|STRLEN|UTF8_MAXBYTES
105
106The maximum width of a single UTF-8 encoded character, in bytes.
107
108NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8 since UTF-8
109is an encoding of Unicode, and Unicode's upper limit, 0x10FFFF, can be
110expressed with 4 bytes. However, Perl thinks of UTF-8 as a way to encode
111non-negative integers in a binary format, even those above Unicode.
112
113=cut
114 */
111e8ed9
KW
115#define UTF8_MAXBYTES 13
116
a0ed51b3 117#ifdef DOINIT
6f06b55f 118EXTCONST unsigned char PL_utf8skip[] = {
b2635aa8
KW
119/* 0x00 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
120/* 0x10 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
121/* 0x20 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
122/* 0x30 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
123/* 0x40 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
124/* 0x50 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
125/* 0x60 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
126/* 0x70 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
127/* 0x80 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
128/* 0x90 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
129/* 0xA0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
130/* 0xB0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
131/* 0xC0 */ 2,2, /* overlong */
1ff3baa2 132/* 0xC2 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0080 to U+03FF */
b2635aa8
KW
133/* 0xD0 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0400 to U+07FF */
134/* 0xE0 */ 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3, /* U+0800 to U+FFFF */
135/* 0xF0 */ 4,4,4,4,4,4,4,4,5,5,5,5,6,6, /* above BMP to 2**31 - 1 */
6937f885
KW
136 /* Perl extended (never was official UTF-8). Up to 36 bit */
137/* 0xFE */ 7,
138 /* More extended, Up to 72 bits (64-bit + reserved) */
111e8ed9 139/* 0xFF */ UTF8_MAXBYTES
a0ed51b3
LW
140};
141#else
6f06b55f 142EXTCONST unsigned char PL_utf8skip[];
a0ed51b3
LW
143#endif
144
73c4f7a1 145END_EXTERN_C
7e2040f0 146
1a3756de 147#if defined(_MSC_VER) && _MSC_VER < 1400
6f6d1bab
TC
148/* older MSVC versions have a smallish macro buffer */
149#define PERL_SMALL_MACRO_BUFFER
150#endif
151
ef2a4c8f
KW
152/*
153
154=for apidoc Am|U8|NATIVE_TO_LATIN1|U8 ch
155
156Returns the Latin-1 (including ASCII and control characters) equivalent of the
157input native code point given by C<ch>. Thus, C<NATIVE_TO_LATIN1(193)> on
158EBCDIC platforms returns 65. These each represent the character C<"A"> on
159their respective platforms. On ASCII platforms no conversion is needed, so
160this macro expands to just its input, adding no time nor space requirements to
161the implementation.
162
163For conversion of code points potentially larger than will fit in a character,
164use L</NATIVE_TO_UNI>.
165
166=for apidoc Am|U8|LATIN1_TO_NATIVE|U8 ch
167
168Returns the native equivalent of the input Latin-1 code point (including ASCII
169and control characters) given by C<ch>. Thus, C<LATIN1_TO_NATIVE(66)> on
170EBCDIC platforms returns 194. These each represent the character C<"B"> on
171their respective platforms. On ASCII platforms no conversion is needed, so
172this macro expands to just its input, adding no time nor space requirements to
173the implementation.
174
175For conversion of code points potentially larger than will fit in a character,
176use L</UNI_TO_NATIVE>.
177
178=for apidoc Am|UV|NATIVE_TO_UNI|UV ch
179
180Returns the Unicode equivalent of the input native code point given by C<ch>.
181Thus, C<NATIVE_TO_UNI(195)> on EBCDIC platforms returns 67. These each
182represent the character C<"C"> on their respective platforms. On ASCII
183platforms no conversion is needed, so this macro expands to just its input,
184adding no time nor space requirements to the implementation.
185
186=for apidoc Am|UV|UNI_TO_NATIVE|UV ch
187
188Returns the native equivalent of the input Unicode code point given by C<ch>.
189Thus, C<UNI_TO_NATIVE(68)> on EBCDIC platforms returns 196. These each
190represent the character C<"D"> on their respective platforms. On ASCII
191platforms no conversion is needed, so this macro expands to just its input,
192adding no time nor space requirements to the implementation.
193
194=cut
195*/
196
6f6d1bab 197#ifdef PERL_SMALL_MACRO_BUFFER
cb15eeb2
KW
198# define NATIVE_TO_LATIN1(ch) ((U8)(ch))
199# define LATIN1_TO_NATIVE(ch) ((U8)(ch))
6f6d1bab 200#else
cb15eeb2
KW
201# define NATIVE_TO_LATIN1(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) ((ch) | 0)))
202# define LATIN1_TO_NATIVE(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) ((ch) | 0)))
6f6d1bab 203#endif
59a449d5
KW
204
205/* I8 is an intermediate version of UTF-8 used only in UTF-EBCDIC. We thus
206 * consider it to be identical to UTF-8 on ASCII platforms. Strictly speaking
207 * UTF-8 and UTF-EBCDIC are two different things, but we often conflate them
208 * because they are 8-bit encodings that serve the same purpose in Perl, and
209 * rarely do we need to distinguish them. The term "NATIVE_UTF8" applies to
210 * whichever one is applicable on the current platform */
6f6d1bab 211#ifdef PERL_SMALL_MACRO_BUFFER
1d4ea287
DD
212#define NATIVE_UTF8_TO_I8(ch) ((U8) (ch))
213#define I8_TO_NATIVE_UTF8(ch) ((U8) (ch))
6f6d1bab 214#else
cb15eeb2
KW
215#define NATIVE_UTF8_TO_I8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) ((ch) | 0)))
216#define I8_TO_NATIVE_UTF8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) ((ch) | 0)))
6f6d1bab 217#endif
59a449d5 218
cb15eeb2
KW
219#define UNI_TO_NATIVE(ch) ((UV) ((ch) | 0))
220#define NATIVE_TO_UNI(ch) ((UV) ((ch) | 0))
d7578b48 221
877d9f0d 222/*
9041c2e3 223
a14e0a36
KW
224 The following table is from Unicode 3.2, plus the Perl extensions for above
225 U+10FFFF
877d9f0d 226
a14e0a36 227 Code Points 1st Byte 2nd Byte 3rd 4th 5th 6th 7th 8th-13th
877d9f0d 228
375122d7 229 U+0000..U+007F 00..7F
e1b711da 230 U+0080..U+07FF * C2..DF 80..BF
a14e0a36
KW
231 U+0800..U+0FFF E0 * A0..BF 80..BF
232 U+1000..U+CFFF E1..EC 80..BF 80..BF
233 U+D000..U+D7FF ED 80..9F 80..BF
234 U+D800..U+DFFF ED A0..BF 80..BF (surrogates)
235 U+E000..U+FFFF EE..EF 80..BF 80..BF
236 U+10000..U+3FFFF F0 * 90..BF 80..BF 80..BF
237 U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF
238 U+100000..U+10FFFF F4 80..8F 80..BF 80..BF
239 Below are above-Unicode code points
240 U+110000..U+13FFFF F4 90..BF 80..BF 80..BF
241 U+110000..U+1FFFFF F5..F7 80..BF 80..BF 80..BF
242 U+200000..U+FFFFFF F8 * 88..BF 80..BF 80..BF 80..BF
243U+1000000..U+3FFFFFF F9..FB 80..BF 80..BF 80..BF 80..BF
244U+4000000..U+3FFFFFFF FC * 84..BF 80..BF 80..BF 80..BF 80..BF
245U+40000000..U+7FFFFFFF FD 80..BF 80..BF 80..BF 80..BF 80..BF
246U+80000000..U+FFFFFFFFF FE * 82..BF 80..BF 80..BF 80..BF 80..BF 80..BF
247U+1000000000.. FF 80..BF 80..BF 80..BF 80..BF 80..BF * 81..BF 80..BF
877d9f0d 248
e1b711da 249Note the gaps before several of the byte entries above marked by '*'. These are
37e2e78e
KW
250caused by legal UTF-8 avoiding non-shortest encodings: it is technically
251possible to UTF-8-encode a single code point in different ways, but that is
252explicitly forbidden, and the shortest possible encoding should always be used
15824458 253(and that is what Perl does). The non-shortest ones are called 'overlongs'.
8c007b5a 254
877d9f0d
JH
255 */
256
8c007b5a
JH
257/*
258 Another way to look at it, as bits:
259
b2635aa8 260 Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte
8c007b5a 261
b2635aa8
KW
262 0aaa aaaa 0aaa aaaa
263 0000 0bbb bbaa aaaa 110b bbbb 10aa aaaa
264 cccc bbbb bbaa aaaa 1110 cccc 10bb bbbb 10aa aaaa
265 00 000d ddcc cccc bbbb bbaa aaaa 1111 0ddd 10cc cccc 10bb bbbb 10aa aaaa
8c007b5a
JH
266
267As you can see, the continuation bytes all begin with C<10>, and the
e1b711da 268leading bits of the start byte tell how many bytes there are in the
8c007b5a
JH
269encoded character.
270
df863e43
KW
271Perl's extended UTF-8 means we can have start bytes up through FF, though any
272beginning with FF yields a code point that is too large for 32-bit ASCII
273platforms. FF signals to use 13 bytes for the encoded character. This breaks
274the paradigm that the number of leading bits gives how many total bytes there
275are in the character.
65ab9279 276
d296fe14 277=cut
8c007b5a
JH
278*/
279
6c88483e 280/* Is the representation of the Unicode code point 'cp' the same regardless of
15824458 281 * being encoded in UTF-8 or not? */
2d1545e5 282#define OFFUNI_IS_INVARIANT(cp) isASCII(cp)
15824458 283
c2b32798
KW
284/*
285=for apidoc Am|bool|UVCHR_IS_INVARIANT|UV cp
286
287Evaluates to 1 if the representation of code point C<cp> is the same whether or
288not it is encoded in UTF-8; otherwise evaluates to 0. UTF-8 invariant
289characters can be copied as-is when converting to/from UTF-8, saving time.
290C<cp> is Unicode if above 255; otherwise is platform-native.
291
292=cut
293 */
294
cf1be84e 295#define UVCHR_IS_INVARIANT(cp) OFFUNI_IS_INVARIANT(cp)
38953e5a 296
c9264833
KW
297/* This defines the bits that are to be in the continuation bytes of a multi-byte
298 * UTF-8 encoded character that mark it is a continuation byte. */
299#define UTF_CONTINUATION_MARK 0x80
300
a95ec4fb 301/* Misleadingly named: is the UTF8-encoded byte 'c' part of a variant sequence
5c06326b
KW
302 * in UTF-8? This is the inverse of UTF8_IS_INVARIANT. The |0 makes sure this
303 * isn't mistakenly called with a ptr argument */
a6951642
KW
304#define UTF8_IS_CONTINUED(c) (__ASSERT_(FITS_IN_8_BITS(c)) \
305 ((U8)((c) | 0)) & UTF_CONTINUATION_MARK)
15824458
KW
306
307/* Is the byte 'c' the first byte of a multi-byte UTF8-8 encoded sequence?
308 * This doesn't catch invariants (they are single-byte). It also excludes the
5c06326b
KW
309 * illegal overlong sequences that begin with C0 and C1. The |0 makes sure
310 * this isn't mistakenly called with a ptr argument */
a6951642
KW
311#define UTF8_IS_START(c) (__ASSERT_(FITS_IN_8_BITS(c)) \
312 ((U8)((c) | 0)) >= 0xc2)
15824458 313
858cd8ab
KW
314/* For use in UTF8_IS_CONTINUATION() below */
315#define UTF_IS_CONTINUATION_MASK 0xC0
316
15824458 317/* Is the byte 'c' part of a multi-byte UTF8-8 encoded sequence, and not the
5c06326b
KW
318 * first byte thereof? The |0 makes sure this isn't mistakenly called with a
319 * ptr argument */
a6951642
KW
320#define UTF8_IS_CONTINUATION(c) (__ASSERT_(FITS_IN_8_BITS(c)) \
321 (((U8)((c) | 0)) & UTF_IS_CONTINUATION_MASK) == UTF_CONTINUATION_MARK)
0ae1fa71 322
15824458
KW
323/* Is the UTF8-encoded byte 'c' the first byte of a two byte sequence? Use
324 * UTF8_IS_NEXT_CHAR_DOWNGRADEABLE() instead if the input isn't known to
325 * be well-formed. Masking with 0xfe allows the low bit to be 0 or 1; thus
5c06326b
KW
326 * this matches 0xc[23]. The |0 makes sure this isn't mistakenly called with a
327 * ptr argument */
a6951642
KW
328#define UTF8_IS_DOWNGRADEABLE_START(c) (__ASSERT_(FITS_IN_8_BITS(c)) \
329 (((U8)((c) | 0)) & 0xfe) == 0xc2)
4ab10950 330
15824458 331/* Is the UTF8-encoded byte 'c' the first byte of a sequence of bytes that
5c06326b
KW
332 * represent a code point > 255? The |0 makes sure this isn't mistakenly
333 * called with a ptr argument */
a6951642
KW
334#define UTF8_IS_ABOVE_LATIN1(c) (__ASSERT_(FITS_IN_8_BITS(c)) \
335 ((U8)((c) | 0)) >= 0xc4)
8850bf83 336
15824458
KW
337/* This is the number of low-order bits a continuation byte in a UTF-8 encoded
338 * sequence contributes to the specification of the code point. In the bit
339 * maps above, you see that the first 2 bits are a constant '10', leaving 6 of
340 * real information */
1d72bdf6 341#define UTF_ACCUMULATION_SHIFT 6
b2635aa8 342
fed423a5
KW
343/* ^? is defined to be DEL on ASCII systems. See the definition of toCTRL()
344 * for more */
345#define QUESTION_MARK_CTRL DEL_NATIVE
346
347/* Surrogates, non-character code points and above-Unicode code points are
348 * problematic in some contexts. This allows code that needs to check for
349 * those to to quickly exclude the vast majority of code points it will
350 * encounter */
a6951642
KW
351#define isUTF8_POSSIBLY_PROBLEMATIC(c) (__ASSERT_(FITS_IN_8_BITS(c)) \
352 (U8) c >= 0xED)
fed423a5 353
57ff5f59
KW
354#define UNICODE_IS_PERL_EXTENDED(uv) UNLIKELY((UV) (uv) > 0x7FFFFFFF)
355
fed423a5
KW
356#endif /* EBCDIC vs ASCII */
357
d7bcd45a
KW
358/* 2**UTF_ACCUMULATION_SHIFT - 1. This masks out all but the bits that carry
359 * real information in a continuation byte. This turns out to be 0x3F in
360 * UTF-8, 0x1F in UTF-EBCDIC. */
fed423a5
KW
361#define UTF_CONTINUATION_MASK ((U8) ((1U << UTF_ACCUMULATION_SHIFT) - 1))
362
7028aeba
KW
363/* Internal macro to be used only in this file to aid in constructing other
364 * publicly accessible macros.
365 * The number of bytes required to express this uv in UTF-8, for just those
366 * uv's requiring 2 through 6 bytes, as these are common to all platforms and
367 * word sizes. The number of bytes needed is given by the number of leading 1
368 * bits in the start byte. There are 32 start bytes that have 2 initial 1 bits
369 * (C0-DF); there are 16 that have 3 initial 1 bits (E0-EF); 8 that have 4
370 * initial 1 bits (F0-F8); 4 that have 5 initial 1 bits (F9-FB), and 2 that
371 * have 6 initial 1 bits (FC-FD). The largest number a string of n bytes can
372 * represent is (the number of possible start bytes for 'n')
373 * * (the number of possiblities for each start byte
374 * The latter in turn is
375 * 2 ** ( (how many continuation bytes there are)
376 * * (the number of bits of information each
377 * continuation byte holds))
378 *
379 * If we were on a platform where we could use a fast find first set bit
380 * instruction (or count leading zeros instruction) this could be replaced by
381 * using that to find the log2 of the uv, and divide that by the number of bits
382 * of information in each continuation byte, adjusting for large cases and how
383 * much information is in a start byte for that length */
72164d3a 384#define __COMMON_UNI_SKIP(uv) \
7028aeba
KW
385 (UV) (uv) < (32 * (1U << ( UTF_ACCUMULATION_SHIFT))) ? 2 : \
386 (UV) (uv) < (16 * (1U << (2 * UTF_ACCUMULATION_SHIFT))) ? 3 : \
387 (UV) (uv) < ( 8 * (1U << (3 * UTF_ACCUMULATION_SHIFT))) ? 4 : \
388 (UV) (uv) < ( 4 * (1U << (4 * UTF_ACCUMULATION_SHIFT))) ? 5 : \
389 (UV) (uv) < ( 2 * (1U << (5 * UTF_ACCUMULATION_SHIFT))) ? 6 :
72164d3a
KW
390
391/* Internal macro to be used only in this file.
392 * This adds to __COMMON_UNI_SKIP the details at this platform's upper range.
fed423a5 393 * For any-sized EBCDIC platforms, or 64-bit ASCII ones, we need one more test
72164d3a
KW
394 * to see if just 7 bytes is needed, or if the maximum is needed. For 32-bit
395 * ASCII platforms, everything is representable by 7 bytes */
fed423a5 396#if defined(UV_IS_QUAD) || defined(EBCDIC)
72164d3a 397# define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) \
7028aeba 398 (UV) (uv) < ((UV) 1U << (6 * UTF_ACCUMULATION_SHIFT)) ? 7 : UTF8_MAXBYTES)
1d68d6cd 399#else
72164d3a 400# define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) 7)
1d68d6cd
SC
401#endif
402
fed423a5
KW
403/* The next two macros use the base macro defined above, and add in the tests
404 * at the low-end of the range, for just 1 byte, yielding complete macros,
405 * publicly accessible. */
406
407/* Input is a true Unicode (not-native) code point */
408#define OFFUNISKIP(uv) (OFFUNI_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv))
2084b489 409
5352a763
KW
410/*
411
412=for apidoc Am|STRLEN|UVCHR_SKIP|UV cp
413returns the number of bytes required to represent the code point C<cp> when
414encoded as UTF-8. C<cp> is a native (ASCII or EBCDIC) code point if less than
415255; a Unicode code point otherwise.
416
417=cut
418 */
fdb6583d 419#define UVCHR_SKIP(uv) ( UVCHR_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv))
5352a763 420
b651802e
KW
421/* The largest code point representable by two UTF-8 bytes on this platform.
422 * As explained in the comments for __COMMON_UNI_SKIP, 32 start bytes with
fed423a5 423 * UTF_ACCUMULATION_SHIFT bits of information each */
aa206fb7
KW
424#define MAX_UTF8_TWO_BYTE (32 * (1U << UTF_ACCUMULATION_SHIFT) - 1)
425
b651802e
KW
426/* The largest code point representable by two UTF-8 bytes on any platform that
427 * Perl runs on. This value is constrained by EBCDIC which has 5 bits per
428 * continuation byte */
aa206fb7
KW
429#define MAX_PORTABLE_UTF8_TWO_BYTE (32 * (1U << 5) - 1)
430
c03c0950
KW
431/* The maximum number of UTF-8 bytes a single Unicode character can
432 * uppercase/lowercase/fold into. Unicode guarantees that the maximum
433 * expansion is UTF8_MAX_FOLD_CHAR_EXPAND characters, but any above-Unicode
434 * code point will fold to itself, so we only have to look at the expansion of
435 * the maximum Unicode code point. But this number may be less than the space
436 * occupied by a very large code point under Perl's extended UTF-8. We have to
437 * make it large enough to fit any single character. (It turns out that ASCII
438 * and EBCDIC differ in which is larger) */
439#define UTF8_MAXBYTES_CASE \
440 (UTF8_MAXBYTES >= (UTF8_MAX_FOLD_CHAR_EXPAND * OFFUNISKIP(0x10FFFF)) \
441 ? UTF8_MAXBYTES \
442 : (UTF8_MAX_FOLD_CHAR_EXPAND * OFFUNISKIP(0x10FFFF)))
443
d06134e5
KW
444/* Rest of these are attributes of Unicode and perl's internals rather than the
445 * encoding, or happen to be the same in both ASCII and EBCDIC (at least at
446 * this level; the macros that some of these call may have different
447 * definitions in the two encodings */
448
59a449d5
KW
449/* In domain restricted to ASCII, these may make more sense to the reader than
450 * the ones with Latin1 in the name */
451#define NATIVE_TO_ASCII(ch) NATIVE_TO_LATIN1(ch)
452#define ASCII_TO_NATIVE(ch) LATIN1_TO_NATIVE(ch)
453
454/* More or less misleadingly-named defines, retained for back compat */
455#define NATIVE_TO_UTF(ch) NATIVE_UTF8_TO_I8(ch)
456#define NATIVE_TO_I8(ch) NATIVE_UTF8_TO_I8(ch)
457#define UTF_TO_NATIVE(ch) I8_TO_NATIVE_UTF8(ch)
458#define I8_TO_NATIVE(ch) I8_TO_NATIVE_UTF8(ch)
459#define NATIVE8_TO_UNI(ch) NATIVE_TO_LATIN1(ch)
d06134e5 460
c0236afe 461/* This defines the 1-bits that are to be in the first byte of a multi-byte
97d0ceda
KW
462 * UTF-8 encoded character that mark it as a start byte and give the number of
463 * bytes that comprise the character. 'len' is the number of bytes in the
464 * multi-byte sequence. */
c0236afe
KW
465#define UTF_START_MARK(len) (((len) > 7) ? 0xFF : (0xFF & (0xFE << (7-(len)))))
466
467/* Masks out the initial one bits in a start byte, leaving the real data ones.
468 * Doesn't work on an invariant byte. 'len' is the number of bytes in the
469 * multi-byte sequence that comprises the character. */
470#define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2)))
471
537124e4
KW
472/* Adds a UTF8 continuation byte 'new' of information to a running total code
473 * point 'old' of all the continuation bytes so far. This is designed to be
155d2738
KW
474 * used in a loop to convert from UTF-8 to the code point represented. Note
475 * that this is asymmetric on EBCDIC platforms, in that the 'new' parameter is
476 * the UTF-EBCDIC byte, whereas the 'old' parameter is a Unicode (not EBCDIC)
477 * code point in process of being generated */
a6951642
KW
478#define UTF8_ACCUMULATE(old, new) (__ASSERT_(FITS_IN_8_BITS(new)) \
479 ((old) << UTF_ACCUMULATION_SHIFT) \
009097b1 480 | ((NATIVE_UTF8_TO_I8(new)) \
155d2738 481 & UTF_CONTINUATION_MASK))
d06134e5 482
4ab10950 483/* This works in the face of malformed UTF-8. */
4e1ed312
KW
484#define UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, e) \
485 ( UTF8_IS_DOWNGRADEABLE_START(*(s)) \
486 && ( (e) - (s) > 1) \
487 && UTF8_IS_CONTINUATION(*((s)+1)))
4ab10950 488
5aaebcb3 489/* Number of bytes a code point occupies in UTF-8. */
5352a763 490#define NATIVE_SKIP(uv) UVCHR_SKIP(uv)
bd18bd40 491
5aaebcb3
KW
492/* Most code which says UNISKIP is really thinking in terms of native code
493 * points (0-255) plus all those beyond. This is an imprecise term, but having
2accb712 494 * it means existing code continues to work. For precision, use UVCHR_SKIP,
5352a763
KW
495 * NATIVE_SKIP, or OFFUNISKIP */
496#define UNISKIP(uv) UVCHR_SKIP(uv)
5aaebcb3 497
3c0792e4
KW
498/* Longer, but more accurate name */
499#define UTF8_IS_ABOVE_LATIN1_START(c) UTF8_IS_ABOVE_LATIN1(c)
500
a62b247b
KW
501/* Convert a UTF-8 variant Latin1 character to a native code point value.
502 * Needs just one iteration of accumulate. Should be used only if it is known
503 * that the code point is < 256, and is not UTF-8 invariant. Use the slower
504 * but more general TWO_BYTE_UTF8_TO_NATIVE() which handles any code point
505 * representable by two bytes (which turns out to be up through
506 * MAX_PORTABLE_UTF8_TWO_BYTE). The two parameters are:
507 * HI: a downgradable start byte;
508 * LO: continuation.
509 * */
510#define EIGHT_BIT_UTF8_TO_NATIVE(HI, LO) \
511 ( __ASSERT_(UTF8_IS_DOWNGRADEABLE_START(HI)) \
512 __ASSERT_(UTF8_IS_CONTINUATION(LO)) \
513 LATIN1_TO_NATIVE(UTF8_ACCUMULATE(( \
514 NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), (LO))))
515
94bb8c36 516/* Convert a two (not one) byte utf8 character to a native code point value.
2950f2a7
KW
517 * Needs just one iteration of accumulate. Should not be used unless it is
518 * known that the two bytes are legal: 1) two-byte start, and 2) continuation.
519 * Note that the result can be larger than 255 if the input character is not
520 * downgradable */
94bb8c36 521#define TWO_BYTE_UTF8_TO_NATIVE(HI, LO) \
a6951642
KW
522 (__ASSERT_(FITS_IN_8_BITS(HI)) \
523 __ASSERT_(FITS_IN_8_BITS(LO)) \
524 __ASSERT_(PL_utf8skip[HI] == 2) \
525 __ASSERT_(UTF8_IS_CONTINUATION(LO)) \
94bb8c36 526 UNI_TO_NATIVE(UTF8_ACCUMULATE((NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), \
635e76f5 527 (LO))))
94bb8c36
KW
528
529/* Should never be used, and be deprecated */
530#define TWO_BYTE_UTF8_TO_UNI(HI, LO) NATIVE_TO_UNI(TWO_BYTE_UTF8_TO_NATIVE(HI, LO))
2950f2a7 531
bd18bd40
KW
532/*
533
534=for apidoc Am|STRLEN|UTF8SKIP|char* s
535returns the number of bytes in the UTF-8 encoded character whose first (perhaps
536only) byte is pointed to by C<s>.
537
538=cut
539 */
2a70536e
KW
540#define UTF8SKIP(s) PL_utf8skip[*(const U8*)(s)]
541#define UTF8_SKIP(s) UTF8SKIP(s)
d06134e5 542
85fcc8f2
KW
543/*
544
545=for apidoc Am|STRLEN|UTF8_SAFE_SKIP|char* s|char* e
45671da2
KW
546returns 0 if S<C<s E<gt>= e>>; otherwise returns the number of bytes in the
547UTF-8 encoded character whose first byte is pointed to by C<s>. But it never
548returns beyond C<e>. On DEBUGGING builds, it asserts that S<C<s E<lt>= e>>.
85fcc8f2
KW
549
550=cut
551 */
45671da2
KW
552#define UTF8_SAFE_SKIP(s, e) (__ASSERT_((e) >= (s)) \
553 ((e) - (s)) <= 0 \
554 ? 0 \
555 : MIN(((e) - (s)), UTF8_SKIP(s)))
85fcc8f2 556
2d1545e5
KW
557/* Most code that says 'UNI_' really means the native value for code points up
558 * through 255 */
559#define UNI_IS_INVARIANT(cp) UVCHR_IS_INVARIANT(cp)
560
c2b32798
KW
561/*
562=for apidoc Am|bool|UTF8_IS_INVARIANT|char c
563
564Evaluates to 1 if the byte C<c> represents the same character when encoded in
565UTF-8 as when not; otherwise evaluates to 0. UTF-8 invariant characters can be
566copied as-is when converting to/from UTF-8, saving time.
567
568In spite of the name, this macro gives the correct result if the input string
569from which C<c> comes is not encoded in UTF-8.
570
571See C<L</UVCHR_IS_INVARIANT>> for checking if a UV is invariant.
572
573=cut
574
575The reason it works on both UTF-8 encoded strings and non-UTF-8 encoded, is
576that it returns TRUE in each for the exact same set of bit patterns. It is
577valid on a subset of what UVCHR_IS_INVARIANT is valid on, so can just use that;
578and the compiler should optimize out anything extraneous given the
579implementation of the latter. The |0 makes sure this isn't mistakenly called
580with a ptr argument.
581*/
5c06326b 582#define UTF8_IS_INVARIANT(c) UVCHR_IS_INVARIANT((c) | 0)
5fc230f1
KW
583
584/* Like the above, but its name implies a non-UTF8 input, which as the comments
585 * above show, doesn't matter as to its implementation */
38953e5a 586#define NATIVE_BYTE_IS_INVARIANT(c) UVCHR_IS_INVARIANT(c)
d06134e5 587
48ccf5e1
KW
588/* The macros in the next 4 sets are used to generate the two utf8 or utfebcdic
589 * bytes from an ordinal that is known to fit into exactly two (not one) bytes;
590 * it must be less than 0x3FF to work across both encodings. */
591
592/* These two are helper macros for the other three sets, and should not be used
593 * directly anywhere else. 'translate_function' is either NATIVE_TO_LATIN1
1ff3baa2
KW
594 * (which works for code points up through 0xFF) or NATIVE_TO_UNI which works
595 * for any code point */
48ccf5e1 596#define __BASE_TWO_BYTE_HI(c, translate_function) \
2863dafa 597 (__ASSERT_(! UVCHR_IS_INVARIANT(c)) \
48ccf5e1 598 I8_TO_NATIVE_UTF8((translate_function(c) >> UTF_ACCUMULATION_SHIFT) \
2863dafa 599 | UTF_START_MARK(2)))
48ccf5e1 600#define __BASE_TWO_BYTE_LO(c, translate_function) \
2863dafa 601 (__ASSERT_(! UVCHR_IS_INVARIANT(c)) \
48ccf5e1 602 I8_TO_NATIVE_UTF8((translate_function(c) & UTF_CONTINUATION_MASK) \
2863dafa 603 | UTF_CONTINUATION_MARK))
48ccf5e1 604
48ccf5e1
KW
605/* The next two macros should not be used. They were designed to be usable as
606 * the case label of a switch statement, but this doesn't work for EBCDIC. Use
9d0d3a03 607 * regen/unicode_constants.pl instead */
48ccf5e1
KW
608#define UTF8_TWO_BYTE_HI_nocast(c) __BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI)
609#define UTF8_TWO_BYTE_LO_nocast(c) __BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI)
610
611/* The next two macros are used when the source should be a single byte
612 * character; checked for under DEBUGGING */
613#define UTF8_EIGHT_BIT_HI(c) (__ASSERT_(FITS_IN_8_BITS(c)) \
4c8cd605 614 ( __BASE_TWO_BYTE_HI(c, NATIVE_TO_LATIN1)))
48ccf5e1 615#define UTF8_EIGHT_BIT_LO(c) (__ASSERT_(FITS_IN_8_BITS(c)) \
4c8cd605 616 (__BASE_TWO_BYTE_LO(c, NATIVE_TO_LATIN1)))
48ccf5e1
KW
617
618/* These final two macros in the series are used when the source can be any
619 * code point whose UTF-8 is known to occupy 2 bytes; they are less efficient
620 * than the EIGHT_BIT versions on EBCDIC platforms. We use the logical '~'
621 * operator instead of "<=" to avoid getting compiler warnings.
d52b8576 622 * MAX_UTF8_TWO_BYTE should be exactly all one bits in the lower few
48ccf5e1
KW
623 * places, so the ~ works */
624#define UTF8_TWO_BYTE_HI(c) \
625 (__ASSERT_((sizeof(c) == 1) \
d52b8576 626 || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE)) \
4c8cd605 627 (__BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI)))
48ccf5e1
KW
628#define UTF8_TWO_BYTE_LO(c) \
629 (__ASSERT_((sizeof(c) == 1) \
d52b8576 630 || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE)) \
4c8cd605 631 (__BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI)))
d06134e5 632
e7214ce8
KW
633/* This is illegal in any well-formed UTF-8 in both EBCDIC and ASCII
634 * as it is only in overlongs. */
635#define ILLEGAL_UTF8_BYTE I8_TO_NATIVE_UTF8(0xC1)
636
7e2040f0 637/*
e3036cf4 638 * 'UTF' is whether or not p is encoded in UTF8. The names 'foo_lazy_if' stem
20df05f4
KW
639 * from an earlier version of these macros in which they didn't call the
640 * foo_utf8() macros (i.e. were 'lazy') unless they decided that *p is the
641 * beginning of a utf8 character. Now that foo_utf8() determines that itself,
642 * no need to do it again here
7e2040f0 643 */
34aeb2e9
KW
644#define isIDFIRST_lazy_if(p,UTF) \
645 _is_utf8_FOO(_CC_IDFIRST, (const U8 *) p, "isIDFIRST_lazy_if", \
646 "isIDFIRST_lazy_if_safe", \
647 cBOOL(UTF && ! IN_BYTES), 0, __FILE__,__LINE__)
1d72bdf6 648
da8c1a98
KW
649#define isIDFIRST_lazy_if_safe(p, e, UTF) \
650 ((IN_BYTES || !UTF) \
651 ? isIDFIRST(*(p)) \
652 : isIDFIRST_utf8_safe(p, e))
653
34aeb2e9
KW
654#define isWORDCHAR_lazy_if(p,UTF) \
655 _is_utf8_FOO(_CC_IDFIRST, (const U8 *) p, "isWORDCHAR_lazy_if", \
656 "isWORDCHAR_lazy_if_safe", \
657 cBOOL(UTF && ! IN_BYTES), 0, __FILE__,__LINE__)
658
da8c1a98
KW
659#define isWORDCHAR_lazy_if_safe(p, e, UTF) \
660 ((IN_BYTES || !UTF) \
661 ? isWORDCHAR(*(p)) \
662 : isWORDCHAR_utf8_safe((U8 *) p, (U8 *) e))
663
34aeb2e9
KW
664#define isALNUM_lazy_if(p,UTF) \
665 _is_utf8_FOO(_CC_IDFIRST, (const U8 *) p, "isALNUM_lazy_if", \
666 "isWORDCHAR_lazy_if_safe", \
667 cBOOL(UTF && ! IN_BYTES), 0, __FILE__,__LINE__)
da8c1a98 668
89ebb4a3
JH
669#define UTF8_MAXLEN UTF8_MAXBYTES
670
8cb75cc8
KW
671/* A Unicode character can fold to up to 3 characters */
672#define UTF8_MAX_FOLD_CHAR_EXPAND 3
673
d3481830 674#define IN_BYTES UNLIKELY(CopHINTS_get(PL_curcop) & HINT_BYTES)
bd18bd40
KW
675
676/*
677
678=for apidoc Am|bool|DO_UTF8|SV* sv
679Returns a bool giving whether or not the PV in C<sv> is to be treated as being
680encoded in UTF-8.
681
682You should use this I<after> a call to C<SvPV()> or one of its variants, in
683case any call to string overloading updates the internal UTF-8 encoding flag.
684
685=cut
686*/
0064a8a9 687#define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
1ff3baa2
KW
688
689/* Should all strings be treated as Unicode, and not just UTF-8 encoded ones?
690 * Is so within 'feature unicode_strings' or 'locale :not_characters', and not
691 * within 'use bytes'. UTF-8 locales are not tested for here, but perhaps
692 * could be */
70844984
KW
693#define IN_UNI_8_BIT \
694 (( ( (CopHINTS_get(PL_curcop) & HINT_UNI_8_BIT)) \
695 || ( CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL \
696 /* -1 below is for :not_characters */ \
697 && _is_in_locale_category(FALSE, -1))) \
698 && (! IN_BYTES))
b36bf33f 699
1d72bdf6 700
c76687c5 701#define UTF8_ALLOW_EMPTY 0x0001 /* Allow a zero length string */
2b5e7bc2 702#define UTF8_GOT_EMPTY UTF8_ALLOW_EMPTY
c76687c5
KW
703
704/* Allow first byte to be a continuation byte */
1d72bdf6 705#define UTF8_ALLOW_CONTINUATION 0x0002
2b5e7bc2 706#define UTF8_GOT_CONTINUATION UTF8_ALLOW_CONTINUATION
c76687c5 707
cd01d3b1 708/* Unexpected non-continuation byte */
1d72bdf6 709#define UTF8_ALLOW_NON_CONTINUATION 0x0004
2b5e7bc2 710#define UTF8_GOT_NON_CONTINUATION UTF8_ALLOW_NON_CONTINUATION
949cf498
KW
711
712/* expecting more bytes than were available in the string */
713#define UTF8_ALLOW_SHORT 0x0008
2b5e7bc2 714#define UTF8_GOT_SHORT UTF8_ALLOW_SHORT
949cf498 715
94953955
KW
716/* Overlong sequence; i.e., the code point can be specified in fewer bytes.
717 * First one will convert the overlong to the REPLACEMENT CHARACTER; second
718 * will return what the overlong evaluates to */
949cf498 719#define UTF8_ALLOW_LONG 0x0010
94953955 720#define UTF8_ALLOW_LONG_AND_ITS_VALUE (UTF8_ALLOW_LONG|0x0020)
2b5e7bc2
KW
721#define UTF8_GOT_LONG UTF8_ALLOW_LONG
722
d60baaa7
KW
723#define UTF8_ALLOW_OVERFLOW 0x0080
724#define UTF8_GOT_OVERFLOW UTF8_ALLOW_OVERFLOW
949cf498 725
f180b292 726#define UTF8_DISALLOW_SURROGATE 0x0100 /* Unicode surrogates */
2b5e7bc2 727#define UTF8_GOT_SURROGATE UTF8_DISALLOW_SURROGATE
f180b292 728#define UTF8_WARN_SURROGATE 0x0200
949cf498 729
c4e96019
KW
730/* Unicode non-character code points */
731#define UTF8_DISALLOW_NONCHAR 0x0400
2b5e7bc2 732#define UTF8_GOT_NONCHAR UTF8_DISALLOW_NONCHAR
c4e96019 733#define UTF8_WARN_NONCHAR 0x0800
949cf498 734
c4e96019
KW
735/* Super-set of Unicode: code points above the legal max */
736#define UTF8_DISALLOW_SUPER 0x1000
2b5e7bc2 737#define UTF8_GOT_SUPER UTF8_DISALLOW_SUPER
c4e96019
KW
738#define UTF8_WARN_SUPER 0x2000
739
740/* The original UTF-8 standard did not define UTF-8 with start bytes of 0xFE or
741 * 0xFF, though UTF-EBCDIC did. This allowed both versions to represent code
742 * points up to 2 ** 31 - 1. Perl extends UTF-8 so that 0xFE and 0xFF are
743 * usable on ASCII platforms, and 0xFF means something different than
744 * UTF-EBCDIC defines. These changes allow code points of 64 bits (actually
745 * somewhat more) to be represented on both platforms. But these are Perl
746 * extensions, and not likely to be interchangeable with other languages. Note
747 * that on ASCII platforms, FE overflows a signed 32-bit word, and FF an
748 * unsigned one. */
d044b7a7
KW
749#define UTF8_DISALLOW_PERL_EXTENDED 0x4000
750#define UTF8_GOT_PERL_EXTENDED UTF8_DISALLOW_PERL_EXTENDED
751#define UTF8_WARN_PERL_EXTENDED 0x8000
d35f2ca5 752
57ff5f59
KW
753/* For back compat, these old names are misleading for overlongs and
754 * UTF_EBCDIC. */
d044b7a7
KW
755#define UTF8_DISALLOW_ABOVE_31_BIT UTF8_DISALLOW_PERL_EXTENDED
756#define UTF8_GOT_ABOVE_31_BIT UTF8_GOT_PERL_EXTENDED
757#define UTF8_WARN_ABOVE_31_BIT UTF8_WARN_PERL_EXTENDED
758#define UTF8_DISALLOW_FE_FF UTF8_DISALLOW_PERL_EXTENDED
759#define UTF8_WARN_FE_FF UTF8_WARN_PERL_EXTENDED
949cf498 760
f180b292 761#define UTF8_CHECK_ONLY 0x10000
99a765e9 762#define _UTF8_NO_CONFIDENCE_IN_CURLEN 0x20000 /* Internal core use only */
949cf498
KW
763
764/* For backwards source compatibility. They do nothing, as the default now
765 * includes what they used to mean. The first one's meaning was to allow the
766 * just the single non-character 0xFFFF */
767#define UTF8_ALLOW_FFFF 0
c825ef8c 768#define UTF8_ALLOW_FE_FF 0
949cf498
KW
769#define UTF8_ALLOW_SURROGATE 0
770
ecc1615f
KW
771/* C9 refers to Unicode Corrigendum #9: allows but discourages non-chars */
772#define UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE \
773 (UTF8_DISALLOW_SUPER|UTF8_DISALLOW_SURROGATE)
774#define UTF8_WARN_ILLEGAL_C9_INTERCHANGE (UTF8_WARN_SUPER|UTF8_WARN_SURROGATE)
775
d35f2ca5 776#define UTF8_DISALLOW_ILLEGAL_INTERCHANGE \
ecc1615f 777 (UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE|UTF8_DISALLOW_NONCHAR)
949cf498 778#define UTF8_WARN_ILLEGAL_INTERCHANGE \
ecc1615f
KW
779 (UTF8_WARN_ILLEGAL_C9_INTERCHANGE|UTF8_WARN_NONCHAR)
780
0eb3d6a0
KW
781/* This is typically used for code that processes UTF-8 input and doesn't want
782 * to have to deal with any malformations that might be present. All such will
783 * be safely replaced by the REPLACEMENT CHARACTER, unless other flags
784 * overriding this are also present. */
2d532c27
KW
785#define UTF8_ALLOW_ANY ( UTF8_ALLOW_CONTINUATION \
786 |UTF8_ALLOW_NON_CONTINUATION \
787 |UTF8_ALLOW_SHORT \
d60baaa7
KW
788 |UTF8_ALLOW_LONG \
789 |UTF8_ALLOW_OVERFLOW)
2d532c27
KW
790
791/* Accept any Perl-extended UTF-8 that evaluates to any UV on the platform, but
cd01d3b1 792 * not any malformed. This is the default. */
2d532c27
KW
793#define UTF8_ALLOW_ANYUV 0
794#define UTF8_ALLOW_DEFAULT UTF8_ALLOW_ANYUV
1d72bdf6 795
89d986df
KW
796/*
797=for apidoc Am|bool|UTF8_IS_SURROGATE|const U8 *s|const U8 *e
798
799Evaluates to non-zero if the first few bytes of the string starting at C<s> and
800looking no further than S<C<e - 1>> are well-formed UTF-8 that represents one
801of the Unicode surrogate code points; otherwise it evaluates to 0. If
802non-zero, the value gives how many bytes starting at C<s> comprise the code
803point's representation.
804
805=cut
806 */
807#define UTF8_IS_SURROGATE(s, e) is_SURROGATE_utf8_safe(s, e)
808
809
810#define UTF8_IS_REPLACEMENT(s, send) is_REPLACEMENT_utf8_safe(s,send)
811
285aa1f0 812#define MAX_LEGAL_CP ((UV)IV_MAX)
40606899 813
89d986df
KW
814/*
815=for apidoc Am|bool|UTF8_IS_SUPER|const U8 *s|const U8 *e
816
817Recall that Perl recognizes an extension to UTF-8 that can encode code
818points larger than the ones defined by Unicode, which are 0..0x10FFFF.
819
820This macro evaluates to non-zero if the first few bytes of the string starting
821at C<s> and looking no further than S<C<e - 1>> are from this UTF-8 extension;
822otherwise it evaluates to 0. If non-zero, the value gives how many bytes
823starting at C<s> comprise the code point's representation.
824
8250 is returned if the bytes are not well-formed extended UTF-8, or if they
826represent a code point that cannot fit in a UV on the current platform. Hence
827this macro can give different results when run on a 64-bit word machine than on
828one with a 32-bit word size.
0c58a72b 829
891fd405 830Note that it is illegal to have code points that are larger than what can
89d986df 831fit in an IV on the current machine.
7131f24d 832
89d986df
KW
833=cut
834
835 * ASCII EBCDIC I8
7131f24d
KW
836 * U+10FFFF: \xF4\x8F\xBF\xBF \xF9\xA1\xBF\xBF\xBF max legal Unicode
837 * U+110000: \xF4\x90\x80\x80 \xF9\xA2\xA0\xA0\xA0
838 * U+110001: \xF4\x90\x80\x81 \xF9\xA2\xA0\xA0\xA1
89d986df
KW
839 */
840#ifdef EBCDIC
a14e0a36 841# define UTF8_IS_SUPER(s, e) \
89d986df
KW
842 (( LIKELY((e) > (s) + 4) \
843 && NATIVE_UTF8_TO_I8(*(s)) >= 0xF9 \
844 && ( NATIVE_UTF8_TO_I8(*(s)) > 0xF9 \
3d42f267 845 || (NATIVE_UTF8_TO_I8(*((s) + 1)) >= 0xA2)) \
89d986df 846 && LIKELY((s) + UTF8SKIP(s) <= (e))) \
1376b35c 847 ? is_utf8_char_helper(s, s + UTF8SKIP(s), 0) : 0)
7131f24d 848#else
a14e0a36 849# define UTF8_IS_SUPER(s, e) \
89d986df
KW
850 (( LIKELY((e) > (s) + 3) \
851 && (*(U8*) (s)) >= 0xF4 \
852 && ((*(U8*) (s)) > 0xF4 || (*((U8*) (s) + 1) >= 0x90))\
853 && LIKELY((s) + UTF8SKIP(s) <= (e))) \
1376b35c 854 ? is_utf8_char_helper(s, s + UTF8SKIP(s), 0) : 0)
7131f24d
KW
855#endif
856
b96a92fb
KW
857/* These are now machine generated, and the 'given' clause is no longer
858 * applicable */
0c58a72b 859#define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e) \
89d986df
KW
860 cBOOL(is_NONCHAR_utf8_safe(s,e))
861
862/*
863=for apidoc Am|bool|UTF8_IS_NONCHAR|const U8 *s|const U8 *e
864
865Evaluates to non-zero if the first few bytes of the string starting at C<s> and
866looking no further than S<C<e - 1>> are well-formed UTF-8 that represents one
867of the Unicode non-character code points; otherwise it evaluates to 0. If
868non-zero, the value gives how many bytes starting at C<s> comprise the code
869point's representation.
870
d296fe14
KW
871=for apidoc AmnU|UV|UNICODE_REPLACEMENT
872
873Evaluates to 0xFFFD, the code point of the Unicode REPLACEMENT CHARACTER
874
89d986df
KW
875=cut
876 */
0c58a72b
KW
877#define UTF8_IS_NONCHAR(s, e) \
878 UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e)
7131f24d 879
c867b360
JH
880#define UNICODE_SURROGATE_FIRST 0xD800
881#define UNICODE_SURROGATE_LAST 0xDFFF
882#define UNICODE_REPLACEMENT 0xFFFD
883#define UNICODE_BYTE_ORDER_MARK 0xFEFF
1d72bdf6 884
b851fbc1 885/* Though our UTF-8 encoding can go beyond this,
c76687c5 886 * let's be conservative and do as Unicode says. */
b851fbc1
JH
887#define PERL_UNICODE_MAX 0x10FFFF
888
d044b7a7
KW
889#define UNICODE_WARN_SURROGATE 0x0001 /* UTF-16 surrogates */
890#define UNICODE_WARN_NONCHAR 0x0002 /* Non-char code points */
891#define UNICODE_WARN_SUPER 0x0004 /* Above 0x10FFFF */
892#define UNICODE_WARN_PERL_EXTENDED 0x0008 /* Above 0x7FFF_FFFF */
893#define UNICODE_WARN_ABOVE_31_BIT UNICODE_WARN_PERL_EXTENDED
894#define UNICODE_DISALLOW_SURROGATE 0x0010
895#define UNICODE_DISALLOW_NONCHAR 0x0020
896#define UNICODE_DISALLOW_SUPER 0x0040
897#define UNICODE_DISALLOW_PERL_EXTENDED 0x0080
898#define UNICODE_DISALLOW_ABOVE_31_BIT UNICODE_DISALLOW_PERL_EXTENDED
33f38593
KW
899
900#define UNICODE_GOT_SURROGATE UNICODE_DISALLOW_SURROGATE
901#define UNICODE_GOT_NONCHAR UNICODE_DISALLOW_NONCHAR
902#define UNICODE_GOT_SUPER UNICODE_DISALLOW_SUPER
903#define UNICODE_GOT_PERL_EXTENDED UNICODE_DISALLOW_PERL_EXTENDED
904
ecc1615f
KW
905#define UNICODE_WARN_ILLEGAL_C9_INTERCHANGE \
906 (UNICODE_WARN_SURROGATE|UNICODE_WARN_SUPER)
bb88be5f 907#define UNICODE_WARN_ILLEGAL_INTERCHANGE \
ecc1615f
KW
908 (UNICODE_WARN_ILLEGAL_C9_INTERCHANGE|UNICODE_WARN_NONCHAR)
909#define UNICODE_DISALLOW_ILLEGAL_C9_INTERCHANGE \
910 (UNICODE_DISALLOW_SURROGATE|UNICODE_DISALLOW_SUPER)
bb88be5f 911#define UNICODE_DISALLOW_ILLEGAL_INTERCHANGE \
ecc1615f 912 (UNICODE_DISALLOW_ILLEGAL_C9_INTERCHANGE|UNICODE_DISALLOW_NONCHAR)
949cf498
KW
913
914/* For backward source compatibility, as are now the default */
915#define UNICODE_ALLOW_SURROGATE 0
916#define UNICODE_ALLOW_SUPER 0
917#define UNICODE_ALLOW_ANY 0
b851fbc1 918
2d6b3d38
KW
919/* This matches the 2048 code points between UNICODE_SURROGATE_FIRST (0xD800) and
920 * UNICODE_SURROGATE_LAST (0xDFFF) */
921#define UNICODE_IS_SURROGATE(uv) (((UV) (uv) & (~0xFFFF | 0xF800)) \
922 == 0xD800)
923
646d1759
KW
924#define UNICODE_IS_REPLACEMENT(uv) ((UV) (uv) == UNICODE_REPLACEMENT)
925#define UNICODE_IS_BYTE_ORDER_MARK(uv) ((UV) (uv) == UNICODE_BYTE_ORDER_MARK)
c149ab20
KW
926
927/* Is 'uv' one of the 32 contiguous-range noncharacters? */
928#define UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv) ((UV) (uv) >= 0xFDD0 \
929 && (UV) (uv) <= 0xFDEF)
930
931/* Is 'uv' one of the 34 plane-ending noncharacters 0xFFFE, 0xFFFF, 0x1FFFE,
932 * 0x1FFFF, ... 0x10FFFE, 0x10FFFF, given that we know that 'uv' is not above
933 * the Unicode legal max */
934#define UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv) \
935 (((UV) (uv) & 0xFFFE) == 0xFFFE)
936
937#define UNICODE_IS_NONCHAR(uv) \
938 ( UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv) \
939 || ( LIKELY( ! UNICODE_IS_SUPER(uv)) \
940 && UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv)))
941
942#define UNICODE_IS_SUPER(uv) ((UV) (uv) > PERL_UNICODE_MAX)
1d72bdf6 943
ec34087a
KW
944#define LATIN_SMALL_LETTER_SHARP_S LATIN_SMALL_LETTER_SHARP_S_NATIVE
945#define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS \
946 LATIN_SMALL_LETTER_Y_WITH_DIAERESIS_NATIVE
947#define MICRO_SIGN MICRO_SIGN_NATIVE
948#define LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE \
949 LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE_NATIVE
950#define LATIN_SMALL_LETTER_A_WITH_RING_ABOVE \
951 LATIN_SMALL_LETTER_A_WITH_RING_ABOVE_NATIVE
09091399
JH
952#define UNICODE_GREEK_CAPITAL_LETTER_SIGMA 0x03A3
953#define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA 0x03C2
954#define UNICODE_GREEK_SMALL_LETTER_SIGMA 0x03C3
9dcbe121 955#define GREEK_SMALL_LETTER_MU 0x03BC
9e682c18
KW
956#define GREEK_CAPITAL_LETTER_MU 0x039C /* Upper and title case
957 of MICRON */
958#define LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS 0x0178 /* Also is title case */
0766489e
KW
959#ifdef LATIN_CAPITAL_LETTER_SHARP_S_UTF8
960# define LATIN_CAPITAL_LETTER_SHARP_S 0x1E9E
961#endif
74894415
KW
962#define LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE 0x130
963#define LATIN_SMALL_LETTER_DOTLESS_I 0x131
9e682c18 964#define LATIN_SMALL_LETTER_LONG_S 0x017F
a9f50d33
KW
965#define LATIN_SMALL_LIGATURE_LONG_S_T 0xFB05
966#define LATIN_SMALL_LIGATURE_ST 0xFB06
9e682c18
KW
967#define KELVIN_SIGN 0x212A
968#define ANGSTROM_SIGN 0x212B
09091399 969
9e55ce06 970#define UNI_DISPLAY_ISPRINT 0x0001
c728cb41
JH
971#define UNI_DISPLAY_BACKSLASH 0x0002
972#define UNI_DISPLAY_QQ (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
973#define UNI_DISPLAY_REGEX (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
9e55ce06 974
5cd46e1f
KW
975#define ANYOF_FOLD_SHARP_S(node, input, end) \
976 (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \
137165a6 977 (ANYOF_NONBITMAP(node)) && \
39065660 978 (ANYOF_FLAGS(node) & ANYOF_LOC_NONBITMAP_FOLD) && \
07b6858f 979 ((end) > (input) + 1) && \
305b8651 980 isALPHA_FOLD_EQ((input)[0], 's'))
6302f837 981
ebc501f0 982#define SHARP_S_SKIP 2
3b0fc154 983
3cedd9d9 984#define is_utf8_char_buf(buf, buf_end) isUTF8_CHAR(buf, buf_end)
976c1b08
KW
985#define bytes_from_utf8(s, lenp, is_utf8p) \
986 bytes_from_utf8_loc(s, lenp, is_utf8p, 0)
3cedd9d9 987
e23e8bc1
KW
988/*
989
25e3a4e0
KW
990=for apidoc Am|STRLEN|isUTF8_CHAR_flags|const U8 *s|const U8 *e| const U32 flags
991
992Evaluates to non-zero if the first few bytes of the string starting at C<s> and
993looking no further than S<C<e - 1>> are well-formed UTF-8, as extended by Perl,
994that represents some code point, subject to the restrictions given by C<flags>;
995otherwise it evaluates to 0. If non-zero, the value gives how many bytes
2717076a
KW
996starting at C<s> comprise the code point's representation. Any bytes remaining
997before C<e>, but beyond the ones needed to form the first code point in C<s>,
998are not examined.
25e3a4e0
KW
999
1000If C<flags> is 0, this gives the same results as C<L</isUTF8_CHAR>>;
1001if C<flags> is C<UTF8_DISALLOW_ILLEGAL_INTERCHANGE>, this gives the same results
1002as C<L</isSTRICT_UTF8_CHAR>>;
1003and if C<flags> is C<UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE>, this gives
1004the same results as C<L</isC9_STRICT_UTF8_CHAR>>.
1005Otherwise C<flags> may be any combination of the C<UTF8_DISALLOW_I<foo>> flags
1006understood by C<L</utf8n_to_uvchr>>, with the same meanings.
1007
1008The three alternative macros are for the most commonly needed validations; they
1009are likely to run somewhat faster than this more general one, as they can be
1010inlined into your code.
1011
9f2abfde
KW
1012Use L</is_utf8_string_flags>, L</is_utf8_string_loc_flags>, and
1013L</is_utf8_string_loclen_flags> to check entire strings.
1014
25e3a4e0
KW
1015=cut
1016*/
1017
1018#define isUTF8_CHAR_flags(s, e, flags) \
1019 (UNLIKELY((e) <= (s)) \
1020 ? 0 \
1021 : (UTF8_IS_INVARIANT(*s)) \
1022 ? 1 \
1023 : UNLIKELY(((e) - (s)) < UTF8SKIP(s)) \
1024 ? 0 \
1376b35c 1025 : is_utf8_char_helper(s, e, flags))
25e3a4e0 1026
6302f837
KW
1027/* Do not use; should be deprecated. Use isUTF8_CHAR() instead; this is
1028 * retained solely for backwards compatibility */
1029#define IS_UTF8_CHAR(p, n) (isUTF8_CHAR(p, (p) + (n)) == n)
e9a8c099 1030
6a5bc5ac 1031#endif /* PERL_UTF8_H_ */
57f0e7e2 1032
e9a8c099 1033/*
14d04a33 1034 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 1035 */