This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
89024f8c683993fe38b15ab861adc97b6c1b98e8
[perl5.git] / utf8.h
1 /*    utf8.h
2  *
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  *
9  *    Copyright (C) 2000, 2001, 2002, 2005, 2006, 2007, 2009,
10  *    2010, 2011 by Larry Wall and others
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
17 #ifndef H_UTF8      /* Guard against recursive inclusion */
18 #define H_UTF8 1
19
20 /* Use UTF-8 as the default script encoding?
21  * Turning this on will break scripts having non-UTF-8 binary
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
29 #include "regcharclass.h"
30 #include "unicode_constants.h"
31
32 /* For to_utf8_fold_flags, q.v. */
33 #define FOLD_FLAGS_LOCALE       0x1
34 #define FOLD_FLAGS_FULL         0x2
35 #define FOLD_FLAGS_NOMIX_ASCII  0x4
36
37 /* For _core_swash_init(), internal core use only */
38 #define _CORE_SWASH_INIT_USER_DEFINED_PROPERTY 0x1
39 #define _CORE_SWASH_INIT_RETURN_IF_UNDEF       0x2
40 #define _CORE_SWASH_INIT_ACCEPT_INVLIST        0x4
41
42 /*
43 =head1 Unicode Support
44 L<perlguts/Unicode Support> has an introduction to this API.
45
46 See also L</Character classification>,
47 and L</Character case changing>.
48 Various functions outside this section also work specially with Unicode.
49 Search for the string "utf8" in this document.
50
51 =for apidoc is_ascii_string
52
53 This is a misleadingly-named synonym for L</is_utf8_invariant_string>.
54 On ASCII-ish platforms, the name isn't misleading: the ASCII-range characters
55 are exactly the UTF-8 invariants.  But EBCDIC machines have more invariants
56 than just the ASCII characters, so C<is_utf8_invariant_string> is preferred.
57
58 =for apidoc is_invariant_string
59
60 This is a somewhat misleadingly-named synonym for L</is_utf8_invariant_string>.
61 C<is_utf8_invariant_string> is preferred, as it indicates under what conditions
62 the string is invariant.
63
64 =cut
65 */
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)
68
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)                                          \
73                      utf8n_to_uvchr(s, (U8*)(e) - (U8*)(s), lenp,              \
74                                     ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY)
75
76 #define to_uni_fold(c, p, lenp) _to_uni_fold_flags(c, p, lenp, FOLD_FLAGS_FULL)
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)
81
82 #define foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
83                     foldEQ_utf8_flags(s1, pe1, l1, u1, s2, pe2, l2, u2, 0)
84 #define FOLDEQ_UTF8_NOMIX_ASCII   (1 << 0)
85 #define FOLDEQ_LOCALE             (1 << 1)
86 #define FOLDEQ_S1_ALREADY_FOLDED  (1 << 2)
87 #define FOLDEQ_S2_ALREADY_FOLDED  (1 << 3)
88 #define FOLDEQ_S1_FOLDS_SANE      (1 << 4)
89 #define FOLDEQ_S2_FOLDS_SANE      (1 << 5)
90
91 #define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
92                     cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2))
93
94 #ifdef EBCDIC
95 /* The equivalent of these macros but implementing UTF-EBCDIC
96    are in the following header file:
97  */
98
99 #include "utfebcdic.h"
100
101 #else   /* ! EBCDIC */
102 START_EXTERN_C
103
104 /* How wide can a single UTF-8 encoded character become in bytes. */
105 /* NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8 since UTF-8
106  * is an encoding of Unicode, and Unicode's upper limit, 0x10FFFF, can be
107  * expressed with 4 bytes.  However, Perl thinks of UTF-8 as a way to encode
108  * non-negative integers in a binary format, even those above Unicode */
109 #define UTF8_MAXBYTES 13
110
111 #ifdef DOINIT
112 EXTCONST unsigned char PL_utf8skip[] = {
113 /* 0x00 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
114 /* 0x10 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
115 /* 0x20 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
116 /* 0x30 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
117 /* 0x40 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
118 /* 0x50 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
119 /* 0x60 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
120 /* 0x70 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
121 /* 0x80 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
122 /* 0x90 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
123 /* 0xA0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
124 /* 0xB0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
125 /* 0xC0 */ 2,2,                             /* overlong */
126 /* 0xC2 */     2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0080 to U+03FF */
127 /* 0xD0 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0400 to U+07FF */
128 /* 0xE0 */ 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3, /* U+0800 to U+FFFF */
129 /* 0xF0 */ 4,4,4,4,4,4,4,4,5,5,5,5,6,6,     /* above BMP to 2**31 - 1 */
130            /* Perl extended (never was official UTF-8).  Up to 36 bit */
131 /* 0xFE */                             7,
132            /* More extended, Up to 72 bits (64-bit + reserved) */
133 /* 0xFF */                               UTF8_MAXBYTES
134 };
135 #else
136 EXTCONST unsigned char PL_utf8skip[];
137 #endif
138
139 END_EXTERN_C
140
141 #if defined(_MSC_VER) && _MSC_VER < 1400
142 /* older MSVC versions have a smallish macro buffer */
143 #define PERL_SMALL_MACRO_BUFFER
144 #endif
145
146 /* Native character to/from iso-8859-1.  Are the identity functions on ASCII
147  * platforms */
148 #ifdef PERL_SMALL_MACRO_BUFFER
149 #define NATIVE_TO_LATIN1(ch)     ((U8)(ch))
150 #define LATIN1_TO_NATIVE(ch)     ((U8)(ch))
151 #else
152 #define NATIVE_TO_LATIN1(ch)     (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
153 #define LATIN1_TO_NATIVE(ch)     (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
154 #endif
155
156 /* I8 is an intermediate version of UTF-8 used only in UTF-EBCDIC.  We thus
157  * consider it to be identical to UTF-8 on ASCII platforms.  Strictly speaking
158  * UTF-8 and UTF-EBCDIC are two different things, but we often conflate them
159  * because they are 8-bit encodings that serve the same purpose in Perl, and
160  * rarely do we need to distinguish them.  The term "NATIVE_UTF8" applies to
161  * whichever one is applicable on the current platform */
162 #ifdef PERL_SMALL_MACRO_BUFFER
163 #define NATIVE_UTF8_TO_I8(ch) ((U8) (ch))
164 #define I8_TO_NATIVE_UTF8(ch) ((U8) (ch))
165 #else
166 #define NATIVE_UTF8_TO_I8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
167 #define I8_TO_NATIVE_UTF8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
168 #endif
169
170 /* Transforms in wide UV chars */
171 #define UNI_TO_NATIVE(ch)        ((UV) (ch))
172 #define NATIVE_TO_UNI(ch)        ((UV) (ch))
173
174 /*
175
176  The following table is from Unicode 3.2, plus the Perl extensions for above
177  U+10FFFF
178
179  Code Points            1st Byte  2nd Byte  3rd    4th     5th     6th       7th   8th-13th
180
181    U+0000..U+007F       00..7F
182    U+0080..U+07FF     * C2..DF    80..BF
183    U+0800..U+0FFF       E0      * A0..BF  80..BF
184    U+1000..U+CFFF       E1..EC    80..BF  80..BF
185    U+D000..U+D7FF       ED        80..9F  80..BF
186    U+D800..U+DFFF       ED        A0..BF  80..BF  (surrogates)
187    U+E000..U+FFFF       EE..EF    80..BF  80..BF
188   U+10000..U+3FFFF      F0      * 90..BF  80..BF  80..BF
189   U+40000..U+FFFFF      F1..F3    80..BF  80..BF  80..BF
190  U+100000..U+10FFFF     F4        80..8F  80..BF  80..BF
191     Below are above-Unicode code points
192  U+110000..U+13FFFF     F4        90..BF  80..BF  80..BF
193  U+110000..U+1FFFFF     F5..F7    80..BF  80..BF  80..BF
194  U+200000..U+FFFFFF     F8      * 88..BF  80..BF  80..BF  80..BF
195 U+1000000..U+3FFFFFF    F9..FB    80..BF  80..BF  80..BF  80..BF
196 U+4000000..U+3FFFFFFF    FC     * 84..BF  80..BF  80..BF  80..BF  80..BF
197 U+40000000..U+7FFFFFFF   FD       80..BF  80..BF  80..BF  80..BF  80..BF
198 U+80000000..U+FFFFFFFFF  FE     * 82..BF  80..BF  80..BF  80..BF  80..BF    80..BF
199 U+1000000000..           FF       80..BF  80..BF  80..BF  80..BF  80..BF  * 81..BF  80..BF
200
201 Note the gaps before several of the byte entries above marked by '*'.  These are
202 caused by legal UTF-8 avoiding non-shortest encodings: it is technically
203 possible to UTF-8-encode a single code point in different ways, but that is
204 explicitly forbidden, and the shortest possible encoding should always be used
205 (and that is what Perl does).  The non-shortest ones are called 'overlongs'.
206
207  */
208
209 /*
210  Another way to look at it, as bits:
211
212                   Code Points      1st Byte   2nd Byte   3rd Byte   4th Byte
213
214                         0aaa aaaa  0aaa aaaa
215               0000 0bbb bbaa aaaa  110b bbbb  10aa aaaa
216               cccc bbbb bbaa aaaa  1110 cccc  10bb bbbb  10aa aaaa
217  00 000d ddcc cccc bbbb bbaa aaaa  1111 0ddd  10cc cccc  10bb bbbb  10aa aaaa
218
219 As you can see, the continuation bytes all begin with C<10>, and the
220 leading bits of the start byte tell how many bytes there are in the
221 encoded character.
222
223 Perl's extended UTF-8 means we can have start bytes up through FF, though any
224 beginning with FF yields a code point that is too large for 32-bit ASCII
225 platforms.  FF signals to use 13 bytes for the encoded character.  This breaks
226 the paradigm that the number of leading bits gives how many total bytes there
227 are in the character.
228
229 */
230
231 /* Anything larger than this will overflow the word if it were converted into a UV */
232 #if defined(UV_IS_QUAD)
233 #   define HIGHEST_REPRESENTABLE_UTF8  "\xFF\x80\x8F\xBF\xBF\xBF\xBF\xBF\xBF\xBF\xBF\xBF\xBF"
234 #else
235 #   define HIGHEST_REPRESENTABLE_UTF8  "\xFE\x83\xBF\xBF\xBF\xBF\xBF"
236 #endif
237
238 /* Is the representation of the Unicode code point 'cp' the same regardless of
239  * being encoded in UTF-8 or not? */
240 #define OFFUNI_IS_INVARIANT(cp)     isASCII(cp)
241
242 /*
243 =for apidoc Am|bool|UVCHR_IS_INVARIANT|UV cp
244
245 Evaluates to 1 if the representation of code point C<cp> is the same whether or
246 not it is encoded in UTF-8; otherwise evaluates to 0.  UTF-8 invariant
247 characters can be copied as-is when converting to/from UTF-8, saving time.
248 C<cp> is Unicode if above 255; otherwise is platform-native.
249
250 =cut
251  */
252
253 #define UVCHR_IS_INVARIANT(cp)      OFFUNI_IS_INVARIANT(cp)
254
255 /* This defines the bits that are to be in the continuation bytes of a multi-byte
256  * UTF-8 encoded character that mark it is a continuation byte. */
257 #define UTF_CONTINUATION_MARK           0x80
258
259 /* Misleadingly named: is the UTF8-encoded byte 'c' part of a variant sequence
260  * in UTF-8?  This is the inverse of UTF8_IS_INVARIANT.  The |0 makes sure this
261  * isn't mistakenly called with a ptr argument */
262 #define UTF8_IS_CONTINUED(c)        (((U8)((c) | 0)) &  UTF_CONTINUATION_MARK)
263
264 /* Is the byte 'c' the first byte of a multi-byte UTF8-8 encoded sequence?
265  * This doesn't catch invariants (they are single-byte).  It also excludes the
266  * illegal overlong sequences that begin with C0 and C1.  The |0 makes sure
267  * this isn't mistakenly called with a ptr argument */
268 #define UTF8_IS_START(c)            (((U8)((c) | 0)) >= 0xc2)
269
270 /* For use in UTF8_IS_CONTINUATION() below */
271 #define UTF_IS_CONTINUATION_MASK    0xC0
272
273 /* Is the byte 'c' part of a multi-byte UTF8-8 encoded sequence, and not the
274  * first byte thereof?  The |0 makes sure this isn't mistakenly called with a
275  * ptr argument */
276 #define UTF8_IS_CONTINUATION(c)                                             \
277     ((((U8)((c) | 0)) & UTF_IS_CONTINUATION_MASK) == UTF_CONTINUATION_MARK)
278
279 /* Is the UTF8-encoded byte 'c' the first byte of a two byte sequence?  Use
280  * UTF8_IS_NEXT_CHAR_DOWNGRADEABLE() instead if the input isn't known to
281  * be well-formed.  Masking with 0xfe allows the low bit to be 0 or 1; thus
282  * this matches 0xc[23].  The |0 makes sure this isn't mistakenly called with a
283  * ptr argument */
284 #define UTF8_IS_DOWNGRADEABLE_START(c)  ((((U8)((c) | 0)) & 0xfe) == 0xc2)
285
286 /* Is the UTF8-encoded byte 'c' the first byte of a sequence of bytes that
287  * represent a code point > 255?  The |0 makes sure this isn't mistakenly
288  * called with a ptr argument */
289 #define UTF8_IS_ABOVE_LATIN1(c)     (((U8)((c) | 0)) >= 0xc4)
290
291 /* This is the number of low-order bits a continuation byte in a UTF-8 encoded
292  * sequence contributes to the specification of the code point.  In the bit
293  * maps above, you see that the first 2 bits are a constant '10', leaving 6 of
294  * real information */
295 #define UTF_ACCUMULATION_SHIFT          6
296
297 /* ^? is defined to be DEL on ASCII systems.  See the definition of toCTRL()
298  * for more */
299 #define QUESTION_MARK_CTRL  DEL_NATIVE
300
301 /* Surrogates, non-character code points and above-Unicode code points are
302  * problematic in some contexts.  This allows code that needs to check for
303  * those to to quickly exclude the vast majority of code points it will
304  * encounter */
305 #define isUTF8_POSSIBLY_PROBLEMATIC(c) ((U8) c >= 0xED)
306
307 /* A helper macro for isUTF8_CHAR, so use that one instead of this.  This was
308  * generated by regen/regcharclass.pl, and then moved here.  Then it was
309  * hand-edited to add some LIKELY() calls, presuming that malformations are
310  * unlikely.  The lines that generated it were then commented out.  This was
311  * done because it takes on the order of 10 minutes to generate, and is never
312  * going to change, unless the generated code is improved, and figuring out
313  * the LIKELYs there would be hard.
314  *
315         UTF8_CHAR: Matches legal UTF-8 variant code points up through 0x1FFFFFF
316
317         0x80 - 0x1FFFFF
318 */
319 /*** GENERATED CODE ***/
320 #define is_UTF8_CHAR_utf8_no_length_checks(s)                               \
321 ( ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ?                          \
322     ( LIKELY( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 )                    \
323 : ( 0xE0 == ((U8*)s)[0] ) ?                                                 \
324     ( LIKELY( ( ( ((U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
325 : ( 0xE1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xEF ) ?                          \
326     ( LIKELY( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
327 : ( 0xF0 == ((U8*)s)[0] ) ?                                                 \
328     ( LIKELY( ( ( 0x90 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0xBF ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
329 : ( ( ( ( 0xF1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xF7 ) && LIKELY( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ) && LIKELY( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && LIKELY( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )
330
331 /* The above macro handles UTF-8 that has this start byte as the maximum */
332 #define _IS_UTF8_CHAR_HIGHEST_START_BYTE 0xF7
333
334 /* A helper macro for isSTRICT_UTF8_CHAR, so use that one instead of this.
335  * Like is_UTF8_CHAR_utf8_no_length_checks(), this was moved here and LIKELYs
336  * added manually.
337  *
338         STRICT_UTF8_CHAR: Matches legal Unicode UTF-8 variant code points, no
339                           surrrogates nor non-character code points
340 */
341 /*** GENERATED CODE ***/
342 #define is_STRICT_UTF8_CHAR_utf8_no_length_checks(s)                        \
343 ( ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ?                          \
344     ( LIKELY( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 )                          \
345 : ( 0xE0 == ((U8*)s)[0] ) ?                                                 \
346     ( LIKELY( ( ( ((U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
347 : ( ( 0xE1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xEC ) || 0xEE == ((U8*)s)[0] ) ?\
348     ( ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
349 : ( 0xED == ((U8*)s)[0] ) ?                                                 \
350     ( LIKELY( ( ( ((U8*)s)[1] & 0xE0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
351 : ( 0xEF == ((U8*)s)[0] ) ?                                                 \
352     ( ( ( 0x80 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0xB6 ) || ( 0xB8 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0xBE ) ) ?\
353         ( LIKELY( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ? 3 : 0 )                      \
354     : ( 0xB7 == ((U8*)s)[1] ) ?                                             \
355         ( LIKELY( ( ((U8*)s)[2] & 0xF0 ) == 0x80 || ( ((U8*)s)[2] & 0xF0 ) == 0xB0 ) ? 3 : 0 )\
356     : ( ( 0xBF == ((U8*)s)[1] ) && ( 0x80 <= ((U8*)s)[2] && ((U8*)s)[2] <= 0xBD ) ) ? 3 : 0 )\
357 : ( 0xF0 == ((U8*)s)[0] ) ?                                                 \
358     ( ( ( 0x90 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0x9E ) || ( 0xA0 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0xAE ) || ( 0xB0 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0xBE ) ) ?\
359         ( LIKELY( ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
360     : ( ((U8*)s)[1] == 0x9F || ( ( ((U8*)s)[1] & 0xEF ) == 0xAF ) ) ?       \
361         ( ( 0x80 <= ((U8*)s)[2] && ((U8*)s)[2] <= 0xBE ) ?                  \
362             ( LIKELY( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ? 4 : 0 )                  \
363         : LIKELY( ( 0xBF == ((U8*)s)[2] ) && ( 0x80 <= ((U8*)s)[3] && ((U8*)s)[3] <= 0xBD ) ) ? 4 : 0 )\
364     : 0 )                                                                   \
365 : ( 0xF1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xF3 ) ?                          \
366     ( ( ( ( ((U8*)s)[1] & 0xC8 ) == 0x80 ) || ( ( ((U8*)s)[1] & 0xCC ) == 0x88 ) || ( ( ((U8*)s)[1] & 0xCE ) == 0x8C ) || ( ( ((U8*)s)[1] & 0xCF ) == 0x8E ) ) ?\
367         ( LIKELY( ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
368     : ( ( ((U8*)s)[1] & 0xCF ) == 0x8F ) ?                                  \
369         ( ( 0x80 <= ((U8*)s)[2] && ((U8*)s)[2] <= 0xBE ) ?                  \
370             ( LIKELY( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ? 4 : 0 )                  \
371         : LIKELY( ( 0xBF == ((U8*)s)[2] ) && ( 0x80 <= ((U8*)s)[3] && ((U8*)s)[3] <= 0xBD ) ) ? 4 : 0 )\
372     : 0 )                                                                   \
373 : ( 0xF4 == ((U8*)s)[0] ) ?                                                 \
374     ( ( 0x80 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0x8E ) ?                      \
375         ( LIKELY( ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
376     : ( 0x8F == ((U8*)s)[1] ) ?                                             \
377         ( ( 0x80 <= ((U8*)s)[2] && ((U8*)s)[2] <= 0xBE ) ?                  \
378             ( LIKELY( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ? 4 : 0 )                  \
379         : LIKELY( ( 0xBF == ((U8*)s)[2] ) && ( 0x80 <= ((U8*)s)[3] && ((U8*)s)[3] <= 0xBD ) ) ? 4 : 0 )\
380     : 0 )                                                                   \
381 : 0 )
382
383 /*  Similarly,
384         C9_STRICT_UTF8_CHAR: Matches legal Unicode UTF-8 variant code
385                                      points, no surrogates
386         0x0080 - 0xD7FF
387         0xE000 - 0x10FFFF
388 */
389 /*** GENERATED CODE ***/
390 #define is_C9_STRICT_UTF8_CHAR_utf8_no_length_checks(s)                     \
391 ( ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ?                          \
392     ( LIKELY( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 )                    \
393 : ( 0xE0 == ((U8*)s)[0] ) ?                                                 \
394     ( LIKELY( ( ( ((U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
395 : ( ( 0xE1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xEC ) || ( ((U8*)s)[0] & 0xFE ) == 0xEE ) ?\
396     ( LIKELY( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
397 : ( 0xED == ((U8*)s)[0] ) ?                                                 \
398     ( LIKELY( ( ( ((U8*)s)[1] & 0xE0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
399 : ( 0xF0 == ((U8*)s)[0] ) ?                                                 \
400     ( LIKELY( ( ( 0x90 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0xBF ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
401 : ( 0xF1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xF3 ) ?                          \
402     ( LIKELY( ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
403 : LIKELY( ( ( ( 0xF4 == ((U8*)s)[0] ) && ( ( ((U8*)s)[1] & 0xF0 ) == 0x80 ) ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )
404
405 #endif /* EBCDIC vs ASCII */
406
407 /* 2**UTF_ACCUMULATION_SHIFT - 1 */
408 #define UTF_CONTINUATION_MASK  ((U8) ((1U << UTF_ACCUMULATION_SHIFT) - 1))
409
410 /* Internal macro to be used only in this file to aid in constructing other
411  * publicly accessible macros.
412  * The number of bytes required to express this uv in UTF-8, for just those
413  * uv's requiring 2 through 6 bytes, as these are common to all platforms and
414  * word sizes.  The number of bytes needed is given by the number of leading 1
415  * bits in the start byte.  There are 32 start bytes that have 2 initial 1 bits
416  * (C0-DF); there are 16 that have 3 initial 1 bits (E0-EF); 8 that have 4
417  * initial 1 bits (F0-F8); 4 that have 5 initial 1 bits (F9-FB), and 2 that
418  * have 6 initial 1 bits (FC-FD).  The largest number a string of n bytes can
419  * represent is       (the number of possible start bytes for 'n')
420  *                  * (the number of possiblities for each start byte
421  * The latter in turn is
422  *                  2  ** (  (how many continuation bytes there are)
423  *                         * (the number of bits of information each
424  *                            continuation byte holds))
425  *
426  * If we were on a platform where we could use a fast find first set bit
427  * instruction (or count leading zeros instruction) this could be replaced by
428  * using that to find the log2 of the uv, and divide that by the number of bits
429  * of information in each continuation byte, adjusting for large cases and how
430  * much information is in a start byte for that length */
431 #define __COMMON_UNI_SKIP(uv)                                               \
432           (UV) (uv) < (32 * (1U << (    UTF_ACCUMULATION_SHIFT))) ? 2 :     \
433           (UV) (uv) < (16 * (1U << (2 * UTF_ACCUMULATION_SHIFT))) ? 3 :     \
434           (UV) (uv) < ( 8 * (1U << (3 * UTF_ACCUMULATION_SHIFT))) ? 4 :     \
435           (UV) (uv) < ( 4 * (1U << (4 * UTF_ACCUMULATION_SHIFT))) ? 5 :     \
436           (UV) (uv) < ( 2 * (1U << (5 * UTF_ACCUMULATION_SHIFT))) ? 6 :
437
438 /* Internal macro to be used only in this file.
439  * This adds to __COMMON_UNI_SKIP the details at this platform's upper range.
440  * For any-sized EBCDIC platforms, or 64-bit ASCII ones, we need one more test
441  * to see if just 7 bytes is needed, or if the maximum is needed.  For 32-bit
442  * ASCII platforms, everything is representable by 7 bytes */
443 #if defined(UV_IS_QUAD) || defined(EBCDIC)
444 #   define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv)                       \
445      (UV) (uv) < ((UV) 1U << (6 * UTF_ACCUMULATION_SHIFT)) ? 7 : UTF8_MAXBYTES)
446 #else
447 #   define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) 7)
448 #endif
449
450 /* The next two macros use the base macro defined above, and add in the tests
451  * at the low-end of the range, for just 1 byte, yielding complete macros,
452  * publicly accessible. */
453
454 /* Input is a true Unicode (not-native) code point */
455 #define OFFUNISKIP(uv) (OFFUNI_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv))
456
457 /*
458
459 =for apidoc Am|STRLEN|UVCHR_SKIP|UV cp
460 returns the number of bytes required to represent the code point C<cp> when
461 encoded as UTF-8.  C<cp> is a native (ASCII or EBCDIC) code point if less than
462 255; a Unicode code point otherwise.
463
464 =cut
465  */
466 #define UVCHR_SKIP(uv) ( UVCHR_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv))
467
468 /* The largest code point representable by two UTF-8 bytes on this platform.
469  * As explained in the comments for __COMMON_UNI_SKIP, 32 start bytes with
470  * UTF_ACCUMULATION_SHIFT bits of information each */
471 #define MAX_UTF8_TWO_BYTE (32 * (1U << UTF_ACCUMULATION_SHIFT) - 1)
472
473 /* The largest code point representable by two UTF-8 bytes on any platform that
474  * Perl runs on.  This value is constrained by EBCDIC which has 5 bits per
475  * continuation byte */
476 #define MAX_PORTABLE_UTF8_TWO_BYTE (32 * (1U << 5) - 1)
477
478 /* The maximum number of UTF-8 bytes a single Unicode character can
479  * uppercase/lowercase/fold into.  Unicode guarantees that the maximum
480  * expansion is UTF8_MAX_FOLD_CHAR_EXPAND characters, but any above-Unicode
481  * code point will fold to itself, so we only have to look at the expansion of
482  * the maximum Unicode code point.  But this number may be less than the space
483  * occupied by a very large code point under Perl's extended UTF-8.  We have to
484  * make it large enough to fit any single character.  (It turns out that ASCII
485  * and EBCDIC differ in which is larger) */
486 #define UTF8_MAXBYTES_CASE                                                      \
487         (UTF8_MAXBYTES >= (UTF8_MAX_FOLD_CHAR_EXPAND * OFFUNISKIP(0x10FFFF))    \
488                            ? UTF8_MAXBYTES                                      \
489                            : (UTF8_MAX_FOLD_CHAR_EXPAND * OFFUNISKIP(0x10FFFF)))
490
491 /* Rest of these are attributes of Unicode and perl's internals rather than the
492  * encoding, or happen to be the same in both ASCII and EBCDIC (at least at
493  * this level; the macros that some of these call may have different
494  * definitions in the two encodings */
495
496 /* In domain restricted to ASCII, these may make more sense to the reader than
497  * the ones with Latin1 in the name */
498 #define NATIVE_TO_ASCII(ch)      NATIVE_TO_LATIN1(ch)
499 #define ASCII_TO_NATIVE(ch)      LATIN1_TO_NATIVE(ch)
500
501 /* More or less misleadingly-named defines, retained for back compat */
502 #define NATIVE_TO_UTF(ch)        NATIVE_UTF8_TO_I8(ch)
503 #define NATIVE_TO_I8(ch)         NATIVE_UTF8_TO_I8(ch)
504 #define UTF_TO_NATIVE(ch)        I8_TO_NATIVE_UTF8(ch)
505 #define I8_TO_NATIVE(ch)         I8_TO_NATIVE_UTF8(ch)
506 #define NATIVE8_TO_UNI(ch)       NATIVE_TO_LATIN1(ch)
507
508 /* This defines the 1-bits that are to be in the first byte of a multi-byte
509  * UTF-8 encoded character that mark it as a start byte and give the number of
510  * bytes that comprise the character. 'len' is the number of bytes in the
511  * multi-byte sequence. */
512 #define UTF_START_MARK(len) (((len) >  7) ? 0xFF : (0xFF & (0xFE << (7-(len)))))
513
514 /* Masks out the initial one bits in a start byte, leaving the real data ones.
515  * Doesn't work on an invariant byte.  'len' is the number of bytes in the
516  * multi-byte sequence that comprises the character. */
517 #define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2)))
518
519 /* Adds a UTF8 continuation byte 'new' of information to a running total code
520  * point 'old' of all the continuation bytes so far.  This is designed to be
521  * used in a loop to convert from UTF-8 to the code point represented.  Note
522  * that this is asymmetric on EBCDIC platforms, in that the 'new' parameter is
523  * the UTF-EBCDIC byte, whereas the 'old' parameter is a Unicode (not EBCDIC)
524  * code point in process of being generated */
525 #define UTF8_ACCUMULATE(old, new) (((old) << UTF_ACCUMULATION_SHIFT)           \
526                                    | ((NATIVE_UTF8_TO_I8((U8)new))             \
527                                        & UTF_CONTINUATION_MASK))
528
529 /* If a value is anded with this, and the result is non-zero, then using the
530  * original value in UTF8_ACCUMULATE will overflow, shifting bits off the left
531  * */
532 #define UTF_ACCUMULATION_OVERFLOW_MASK                                  \
533     (((UV) UTF_CONTINUATION_MASK) << ((sizeof(UV) * CHARBITS)           \
534            - UTF_ACCUMULATION_SHIFT))
535
536 /* This works in the face of malformed UTF-8. */
537 #define UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, e) (UTF8_IS_DOWNGRADEABLE_START(*s) \
538                                                && ( (e) - (s) > 1)             \
539                                                && UTF8_IS_CONTINUATION(*((s)+1)))
540
541 /* Number of bytes a code point occupies in UTF-8. */
542 #define NATIVE_SKIP(uv) UVCHR_SKIP(uv)
543
544 /* Most code which says UNISKIP is really thinking in terms of native code
545  * points (0-255) plus all those beyond.  This is an imprecise term, but having
546  * it means existing code continues to work.  For precision, use UVCHR_SKIP,
547  * NATIVE_SKIP, or OFFUNISKIP */
548 #define UNISKIP(uv)   UVCHR_SKIP(uv)
549
550 /* Longer, but more accurate name */
551 #define UTF8_IS_ABOVE_LATIN1_START(c)     UTF8_IS_ABOVE_LATIN1(c)
552
553 /* Convert a UTF-8 variant Latin1 character to a native code point value.
554  * Needs just one iteration of accumulate.  Should be used only if it is known
555  * that the code point is < 256, and is not UTF-8 invariant.  Use the slower
556  * but more general TWO_BYTE_UTF8_TO_NATIVE() which handles any code point
557  * representable by two bytes (which turns out to be up through
558  * MAX_PORTABLE_UTF8_TWO_BYTE).  The two parameters are:
559  *  HI: a downgradable start byte;
560  *  LO: continuation.
561  * */
562 #define EIGHT_BIT_UTF8_TO_NATIVE(HI, LO)                                        \
563     ( __ASSERT_(UTF8_IS_DOWNGRADEABLE_START(HI))                                \
564       __ASSERT_(UTF8_IS_CONTINUATION(LO))                                       \
565      LATIN1_TO_NATIVE(UTF8_ACCUMULATE((                                         \
566                             NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), (LO))))
567
568 /* Convert a two (not one) byte utf8 character to a native code point value.
569  * Needs just one iteration of accumulate.  Should not be used unless it is
570  * known that the two bytes are legal: 1) two-byte start, and 2) continuation.
571  * Note that the result can be larger than 255 if the input character is not
572  * downgradable */
573 #define TWO_BYTE_UTF8_TO_NATIVE(HI, LO) \
574     ( __ASSERT_(PL_utf8skip[HI] == 2)                                           \
575       __ASSERT_(UTF8_IS_CONTINUATION(LO))                                       \
576      UNI_TO_NATIVE(UTF8_ACCUMULATE((NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), \
577                                    (LO))))
578
579 /* Should never be used, and be deprecated */
580 #define TWO_BYTE_UTF8_TO_UNI(HI, LO) NATIVE_TO_UNI(TWO_BYTE_UTF8_TO_NATIVE(HI, LO))
581
582 /*
583
584 =for apidoc Am|STRLEN|UTF8SKIP|char* s
585 returns the number of bytes in the UTF-8 encoded character whose first (perhaps
586 only) byte is pointed to by C<s>.
587
588 =cut
589  */
590 #define UTF8SKIP(s)  PL_utf8skip[*(const U8*)(s)]
591 #define UTF8_SKIP(s) UTF8SKIP(s)
592
593 /* Most code that says 'UNI_' really means the native value for code points up
594  * through 255 */
595 #define UNI_IS_INVARIANT(cp)   UVCHR_IS_INVARIANT(cp)
596
597 /*
598 =for apidoc Am|bool|UTF8_IS_INVARIANT|char c
599
600 Evaluates to 1 if the byte C<c> represents the same character when encoded in
601 UTF-8 as when not; otherwise evaluates to 0.  UTF-8 invariant characters can be
602 copied as-is when converting to/from UTF-8, saving time.
603
604 In spite of the name, this macro gives the correct result if the input string
605 from which C<c> comes is not encoded in UTF-8.
606
607 See C<L</UVCHR_IS_INVARIANT>> for checking if a UV is invariant.
608
609 =cut
610
611 The reason it works on both UTF-8 encoded strings and non-UTF-8 encoded, is
612 that it returns TRUE in each for the exact same set of bit patterns.  It is
613 valid on a subset of what UVCHR_IS_INVARIANT is valid on, so can just use that;
614 and the compiler should optimize out anything extraneous given the
615 implementation of the latter.  The |0 makes sure this isn't mistakenly called
616 with a ptr argument.
617 */
618 #define UTF8_IS_INVARIANT(c)    UVCHR_IS_INVARIANT((c) | 0)
619
620 /* Like the above, but its name implies a non-UTF8 input, which as the comments
621  * above show, doesn't matter as to its implementation */
622 #define NATIVE_BYTE_IS_INVARIANT(c)     UVCHR_IS_INVARIANT(c)
623
624 /* The macros in the next 4 sets are used to generate the two utf8 or utfebcdic
625  * bytes from an ordinal that is known to fit into exactly two (not one) bytes;
626  * it must be less than 0x3FF to work across both encodings. */
627
628 /* These two are helper macros for the other three sets, and should not be used
629  * directly anywhere else.  'translate_function' is either NATIVE_TO_LATIN1
630  * (which works for code points up through 0xFF) or NATIVE_TO_UNI which works
631  * for any code point */
632 #define __BASE_TWO_BYTE_HI(c, translate_function)                               \
633            (__ASSERT_(! UVCHR_IS_INVARIANT(c))                                  \
634             I8_TO_NATIVE_UTF8((translate_function(c) >> UTF_ACCUMULATION_SHIFT) \
635                               | UTF_START_MARK(2)))
636 #define __BASE_TWO_BYTE_LO(c, translate_function)                               \
637              (__ASSERT_(! UVCHR_IS_INVARIANT(c))                                \
638               I8_TO_NATIVE_UTF8((translate_function(c) & UTF_CONTINUATION_MASK) \
639                                  | UTF_CONTINUATION_MARK))
640
641 /* The next two macros should not be used.  They were designed to be usable as
642  * the case label of a switch statement, but this doesn't work for EBCDIC.  Use
643  * regen/unicode_constants.pl instead */
644 #define UTF8_TWO_BYTE_HI_nocast(c)  __BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI)
645 #define UTF8_TWO_BYTE_LO_nocast(c)  __BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI)
646
647 /* The next two macros are used when the source should be a single byte
648  * character; checked for under DEBUGGING */
649 #define UTF8_EIGHT_BIT_HI(c) (__ASSERT_(FITS_IN_8_BITS(c))                    \
650                              ( __BASE_TWO_BYTE_HI(c, NATIVE_TO_LATIN1)))
651 #define UTF8_EIGHT_BIT_LO(c) (__ASSERT_(FITS_IN_8_BITS(c))                    \
652                              (__BASE_TWO_BYTE_LO(c, NATIVE_TO_LATIN1)))
653
654 /* These final two macros in the series are used when the source can be any
655  * code point whose UTF-8 is known to occupy 2 bytes; they are less efficient
656  * than the EIGHT_BIT versions on EBCDIC platforms.  We use the logical '~'
657  * operator instead of "<=" to avoid getting compiler warnings.
658  * MAX_UTF8_TWO_BYTE should be exactly all one bits in the lower few
659  * places, so the ~ works */
660 #define UTF8_TWO_BYTE_HI(c)                                                    \
661        (__ASSERT_((sizeof(c) ==  1)                                            \
662                   || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE))              \
663         (__BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI)))
664 #define UTF8_TWO_BYTE_LO(c)                                                    \
665        (__ASSERT_((sizeof(c) ==  1)                                            \
666                   || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE))              \
667         (__BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI)))
668
669 /* This is illegal in any well-formed UTF-8 in both EBCDIC and ASCII
670  * as it is only in overlongs. */
671 #define ILLEGAL_UTF8_BYTE   I8_TO_NATIVE_UTF8(0xC1)
672
673 /*
674  * 'UTF' is whether or not p is encoded in UTF8.  The names 'foo_lazy_if' stem
675  * from an earlier version of these macros in which they didn't call the
676  * foo_utf8() macros (i.e. were 'lazy') unless they decided that *p is the
677  * beginning of a utf8 character.  Now that foo_utf8() determines that itself,
678  * no need to do it again here
679  */
680 #define isIDFIRST_lazy_if(p,UTF) ((IN_BYTES || !UTF)                \
681                                  ? isIDFIRST(*(p))                  \
682                                  : isIDFIRST_utf8((const U8*)p))
683 #define isWORDCHAR_lazy_if(p,UTF)   ((IN_BYTES || (!UTF))           \
684                                  ? isWORDCHAR(*(p))                 \
685                                  : isWORDCHAR_utf8((const U8*)p))
686 #define isALNUM_lazy_if(p,UTF)   isWORDCHAR_lazy_if(p,UTF)
687
688 #define UTF8_MAXLEN UTF8_MAXBYTES
689
690 /* A Unicode character can fold to up to 3 characters */
691 #define UTF8_MAX_FOLD_CHAR_EXPAND 3
692
693 #define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES)
694
695 /*
696
697 =for apidoc Am|bool|DO_UTF8|SV* sv
698 Returns a bool giving whether or not the PV in C<sv> is to be treated as being
699 encoded in UTF-8.
700
701 You should use this I<after> a call to C<SvPV()> or one of its variants, in
702 case any call to string overloading updates the internal UTF-8 encoding flag.
703
704 =cut
705 */
706 #define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
707
708 /* Should all strings be treated as Unicode, and not just UTF-8 encoded ones?
709  * Is so within 'feature unicode_strings' or 'locale :not_characters', and not
710  * within 'use bytes'.  UTF-8 locales are not tested for here, but perhaps
711  * could be */
712 #define IN_UNI_8_BIT                                                             \
713             (((CopHINTS_get(PL_curcop) & (HINT_UNI_8_BIT))                       \
714                || (CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL                 \
715                    /* -1 below is for :not_characters */                         \
716                    && _is_in_locale_category(FALSE, -1)))                        \
717               && ! IN_BYTES)
718
719
720 #define UTF8_ALLOW_EMPTY                0x0001  /* Allow a zero length string */
721
722 /* Allow first byte to be a continuation byte */
723 #define UTF8_ALLOW_CONTINUATION         0x0002
724
725 /* Allow second... bytes to be non-continuation bytes */
726 #define UTF8_ALLOW_NON_CONTINUATION     0x0004
727
728 /* expecting more bytes than were available in the string */
729 #define UTF8_ALLOW_SHORT                0x0008
730
731 /* Overlong sequence; i.e., the code point can be specified in fewer bytes. */
732 #define UTF8_ALLOW_LONG                 0x0010
733
734 #define UTF8_DISALLOW_SURROGATE         0x0020  /* Unicode surrogates */
735 #define UTF8_WARN_SURROGATE             0x0040
736
737 #define UTF8_DISALLOW_NONCHAR           0x0080  /* Unicode non-character */
738 #define UTF8_WARN_NONCHAR               0x0100  /*  code points */
739
740 #define UTF8_DISALLOW_SUPER             0x0200  /* Super-set of Unicode: code */
741 #define UTF8_WARN_SUPER                 0x0400  /* points above the legal max */
742
743 /* Code points which never were part of the original UTF-8 standard, which only
744  * went up to 2 ** 31 - 1.  Note that these all overflow a signed 32-bit word,
745  * The first byte of these code points is FE or FF on ASCII platforms.  If the
746  * first byte is FF, it will overflow a 32-bit word. */
747 #define UTF8_DISALLOW_ABOVE_31_BIT      0x0800
748 #define UTF8_WARN_ABOVE_31_BIT          0x1000
749
750 /* For back compat, these old names are misleading for UTF_EBCDIC */
751 #define UTF8_DISALLOW_FE_FF             UTF8_DISALLOW_ABOVE_31_BIT
752 #define UTF8_WARN_FE_FF                 UTF8_WARN_ABOVE_31_BIT
753
754 #define UTF8_CHECK_ONLY                 0x2000
755
756 /* For backwards source compatibility.  They do nothing, as the default now
757  * includes what they used to mean.  The first one's meaning was to allow the
758  * just the single non-character 0xFFFF */
759 #define UTF8_ALLOW_FFFF 0
760 #define UTF8_ALLOW_SURROGATE 0
761
762 /* C9 refers to Unicode Corrigendum #9: allows but discourages non-chars */
763 #define UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE                                    \
764                                  (UTF8_DISALLOW_SUPER|UTF8_DISALLOW_SURROGATE)
765 #define UTF8_WARN_ILLEGAL_C9_INTERCHANGE (UTF8_WARN_SUPER|UTF8_WARN_SURROGATE)
766
767 #define UTF8_DISALLOW_ILLEGAL_INTERCHANGE                                       \
768                   (UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE|UTF8_DISALLOW_NONCHAR)
769 #define UTF8_WARN_ILLEGAL_INTERCHANGE \
770                           (UTF8_WARN_ILLEGAL_C9_INTERCHANGE|UTF8_WARN_NONCHAR)
771
772 #define UTF8_ALLOW_ANY                                                          \
773             (~( UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_DISALLOW_ABOVE_31_BIT    \
774                |UTF8_WARN_ILLEGAL_INTERCHANGE|UTF8_WARN_ABOVE_31_BIT))
775 #define UTF8_ALLOW_ANYUV                                                        \
776          (UTF8_ALLOW_EMPTY                                                      \
777           & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
778 #define UTF8_ALLOW_DEFAULT              (ckWARN(WARN_UTF8) ? 0 : \
779                                          UTF8_ALLOW_ANYUV)
780
781 /*
782 =for apidoc Am|bool|UTF8_IS_SURROGATE|const U8 *s|const U8 *e
783
784 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
785 looking no further than S<C<e - 1>> are well-formed UTF-8 that represents one
786 of the Unicode surrogate code points; otherwise it evaluates to 0.  If
787 non-zero, the value gives how many bytes starting at C<s> comprise the code
788 point's representation.
789
790 =cut
791  */
792 #define UTF8_IS_SURROGATE(s, e)      is_SURROGATE_utf8_safe(s, e)
793
794
795 #define UTF8_IS_REPLACEMENT(s, send) is_REPLACEMENT_utf8_safe(s,send)
796
797 /*
798 =for apidoc Am|bool|UTF8_IS_SUPER|const U8 *s|const U8 *e
799
800 Recall that Perl recognizes an extension to UTF-8 that can encode code
801 points larger than the ones defined by Unicode, which are 0..0x10FFFF.
802
803 This macro evaluates to non-zero if the first few bytes of the string starting
804 at C<s> and looking no further than S<C<e - 1>> are from this UTF-8 extension;
805 otherwise it evaluates to 0.  If non-zero, the value gives how many bytes
806 starting at C<s> comprise the code point's representation.
807
808 0 is returned if the bytes are not well-formed extended UTF-8, or if they
809 represent a code point that cannot fit in a UV on the current platform.  Hence
810 this macro can give different results when run on a 64-bit word machine than on
811 one with a 32-bit word size.
812
813 Note that it is deprecated to have code points that are larger than what can
814 fit in an IV on the current machine.
815
816 =cut
817
818  *                ASCII              EBCDIC I8
819  * U+10FFFF: \xF4\x8F\xBF\xBF   \xF9\xA1\xBF\xBF\xBF    max legal Unicode
820  * U+110000: \xF4\x90\x80\x80   \xF9\xA2\xA0\xA0\xA0
821  * U+110001: \xF4\x90\x80\x81   \xF9\xA2\xA0\xA0\xA1
822  */
823 #ifdef EBCDIC
824 #   define UTF8_IS_SUPER(s, e)                                              \
825                   ((    LIKELY((e) > (s) + 4)                               \
826                     &&      NATIVE_UTF8_TO_I8(*(s)) >= 0xF9                 \
827                     && (    NATIVE_UTF8_TO_I8(*(s)) >  0xF9                 \
828                         || (NATIVE_UTF8_TO_I8(*(s) + 1) >= 0xA2))           \
829                     &&  LIKELY((s) + UTF8SKIP(s) <= (e)))                   \
830                     ? _is_utf8_char_helper(s, s + UTF8SKIP(s), 0) : 0)
831 #else
832 #   define UTF8_IS_SUPER(s, e)                                              \
833                    ((    LIKELY((e) > (s) + 3)                              \
834                      &&  (*(U8*) (s)) >= 0xF4                               \
835                      && ((*(U8*) (s)) >  0xF4 || (*((U8*) (s) + 1) >= 0x90))\
836                      &&  LIKELY((s) + UTF8SKIP(s) <= (e)))                  \
837                     ? _is_utf8_char_helper(s, s + UTF8SKIP(s), 0) : 0)
838 #endif
839
840 /* These are now machine generated, and the 'given' clause is no longer
841  * applicable */
842 #define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e)          \
843                                             cBOOL(is_NONCHAR_utf8_safe(s,e))
844
845 /*
846 =for apidoc Am|bool|UTF8_IS_NONCHAR|const U8 *s|const U8 *e
847
848 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
849 looking no further than S<C<e - 1>> are well-formed UTF-8 that represents one
850 of the Unicode non-character code points; otherwise it evaluates to 0.  If
851 non-zero, the value gives how many bytes starting at C<s> comprise the code
852 point's representation.
853
854 =cut
855  */
856 #define UTF8_IS_NONCHAR(s, e)                                                  \
857                 UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e)
858
859 #define UNICODE_SURROGATE_FIRST         0xD800
860 #define UNICODE_SURROGATE_LAST          0xDFFF
861 #define UNICODE_REPLACEMENT             0xFFFD
862 #define UNICODE_BYTE_ORDER_MARK         0xFEFF
863
864 /* Though our UTF-8 encoding can go beyond this,
865  * let's be conservative and do as Unicode says. */
866 #define PERL_UNICODE_MAX        0x10FFFF
867
868 #define UNICODE_WARN_SURROGATE        0x0001    /* UTF-16 surrogates */
869 #define UNICODE_WARN_NONCHAR          0x0002    /* Non-char code points */
870 #define UNICODE_WARN_SUPER            0x0004    /* Above 0x10FFFF */
871 #define UNICODE_WARN_ABOVE_31_BIT     0x0008    /* Above 0x7FFF_FFFF */
872 #define UNICODE_DISALLOW_SURROGATE    0x0010
873 #define UNICODE_DISALLOW_NONCHAR      0x0020
874 #define UNICODE_DISALLOW_SUPER        0x0040
875 #define UNICODE_DISALLOW_ABOVE_31_BIT 0x0080
876 #define UNICODE_WARN_ILLEGAL_C9_INTERCHANGE                                   \
877                                   (UNICODE_WARN_SURROGATE|UNICODE_WARN_SUPER)
878 #define UNICODE_WARN_ILLEGAL_INTERCHANGE                                      \
879                    (UNICODE_WARN_ILLEGAL_C9_INTERCHANGE|UNICODE_WARN_NONCHAR)
880 #define UNICODE_DISALLOW_ILLEGAL_C9_INTERCHANGE                               \
881                           (UNICODE_DISALLOW_SURROGATE|UNICODE_DISALLOW_SUPER)
882 #define UNICODE_DISALLOW_ILLEGAL_INTERCHANGE                                  \
883            (UNICODE_DISALLOW_ILLEGAL_C9_INTERCHANGE|UNICODE_DISALLOW_NONCHAR)
884
885 /* For backward source compatibility, as are now the default */
886 #define UNICODE_ALLOW_SURROGATE 0
887 #define UNICODE_ALLOW_SUPER     0
888 #define UNICODE_ALLOW_ANY       0
889
890 /* This matches the 2048 code points between UNICODE_SURROGATE_FIRST (0xD800) and
891  * UNICODE_SURROGATE_LAST (0xDFFF) */
892 #define UNICODE_IS_SURROGATE(uv)        (((UV) (uv) & (~0xFFFF | 0xF800))       \
893                                                                     == 0xD800)
894
895 #define UNICODE_IS_REPLACEMENT(uv)      ((UV) (uv) == UNICODE_REPLACEMENT)
896 #define UNICODE_IS_BYTE_ORDER_MARK(uv)  ((UV) (uv) == UNICODE_BYTE_ORDER_MARK)
897
898 /* Is 'uv' one of the 32 contiguous-range noncharacters? */
899 #define UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv)      ((UV) (uv) >= 0xFDD0         \
900                                                  && (UV) (uv) <= 0xFDEF)
901
902 /* Is 'uv' one of the 34 plane-ending noncharacters 0xFFFE, 0xFFFF, 0x1FFFE,
903  * 0x1FFFF, ... 0x10FFFE, 0x10FFFF, given that we know that 'uv' is not above
904  * the Unicode legal max */
905 #define UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv)                        \
906                                               (((UV) (uv) & 0xFFFE) == 0xFFFE)
907
908 #define UNICODE_IS_NONCHAR(uv)                                                  \
909     (   UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv)                                   \
910      || (   LIKELY( ! UNICODE_IS_SUPER(uv))                                     \
911          && UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv)))
912
913 #define UNICODE_IS_SUPER(uv)    ((UV) (uv) > PERL_UNICODE_MAX)
914 #define UNICODE_IS_ABOVE_31_BIT(uv)    ((UV) (uv) > 0x7FFFFFFF)
915
916 #define LATIN_SMALL_LETTER_SHARP_S      LATIN_SMALL_LETTER_SHARP_S_NATIVE
917 #define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS                                  \
918                                 LATIN_SMALL_LETTER_Y_WITH_DIAERESIS_NATIVE
919 #define MICRO_SIGN      MICRO_SIGN_NATIVE
920 #define LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE                               \
921                             LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE_NATIVE
922 #define LATIN_SMALL_LETTER_A_WITH_RING_ABOVE                                 \
923                                 LATIN_SMALL_LETTER_A_WITH_RING_ABOVE_NATIVE
924 #define UNICODE_GREEK_CAPITAL_LETTER_SIGMA      0x03A3
925 #define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA  0x03C2
926 #define UNICODE_GREEK_SMALL_LETTER_SIGMA        0x03C3
927 #define GREEK_SMALL_LETTER_MU                   0x03BC
928 #define GREEK_CAPITAL_LETTER_MU                 0x039C  /* Upper and title case
929                                                            of MICRON */
930 #define LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS   0x0178  /* Also is title case */
931 #ifdef LATIN_CAPITAL_LETTER_SHARP_S_UTF8
932 #   define LATIN_CAPITAL_LETTER_SHARP_S         0x1E9E
933 #endif
934 #define LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE   0x130
935 #define LATIN_SMALL_LETTER_DOTLESS_I            0x131
936 #define LATIN_SMALL_LETTER_LONG_S               0x017F
937 #define LATIN_SMALL_LIGATURE_LONG_S_T           0xFB05
938 #define LATIN_SMALL_LIGATURE_ST                 0xFB06
939 #define KELVIN_SIGN                             0x212A
940 #define ANGSTROM_SIGN                           0x212B
941
942 #define UNI_DISPLAY_ISPRINT     0x0001
943 #define UNI_DISPLAY_BACKSLASH   0x0002
944 #define UNI_DISPLAY_QQ          (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
945 #define UNI_DISPLAY_REGEX       (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
946
947 #define ANYOF_FOLD_SHARP_S(node, input, end)    \
948         (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \
949          (ANYOF_NONBITMAP(node)) && \
950          (ANYOF_FLAGS(node) & ANYOF_LOC_NONBITMAP_FOLD) && \
951          ((end) > (input) + 1) && \
952          isALPHA_FOLD_EQ((input)[0], 's'))
953
954 #define SHARP_S_SKIP 2
955
956 /*
957
958 =for apidoc Am|STRLEN|isUTF8_CHAR|const U8 *s|const U8 *e
959
960 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
961 looking no further than S<C<e - 1>> are well-formed UTF-8, as extended by Perl,
962 that represents some code point; otherwise it evaluates to 0.  If non-zero, the
963 value gives how many bytes starting at C<s> comprise the code point's
964 representation.  Any bytes remaining before C<e>, but beyond the ones needed to
965 form the first code point in C<s>, are not examined.
966
967 The code point can be any that will fit in a UV on this machine, using Perl's
968 extension to official UTF-8 to represent those higher than the Unicode maximum
969 of 0x10FFFF.  That means that this macro is used to efficiently decide if the
970 next few bytes in C<s> is legal UTF-8 for a single character.
971
972 Use C<L</isSTRICT_UTF8_CHAR>> to restrict the acceptable code points to those
973 defined by Unicode to be fully interchangeable across applications;
974 C<L</isC9_STRICT_UTF8_CHAR>> to use the L<Unicode Corrigendum
975 #9|http://www.unicode.org/versions/corrigendum9.html> definition of allowable
976 code points; and C<L</isUTF8_CHAR_flags>> for a more customized definition.
977
978 Use C<L</is_utf8_string>>, C<L</is_utf8_string_loc>>, and
979 C<L</is_utf8_string_loclen>> to check entire strings.
980
981 Note that it is deprecated to use code points higher than what will fit in an
982 IV.  This macro does not raise any warnings for such code points, treating them
983 as valid.
984
985 Note also that a UTF-8 INVARIANT character (i.e. ASCII on non-EBCDIC machines)
986 is a valid UTF-8 character.
987
988 =cut
989 */
990
991 #define isUTF8_CHAR(s, e)                                                   \
992     (UNLIKELY((e) <= (s))                                                   \
993     ? 0                                                                     \
994     : (UTF8_IS_INVARIANT(*s))                                               \
995       ? 1                                                                   \
996       : UNLIKELY(((e) - (s)) < UTF8SKIP(s))                                 \
997         ? 0                                                                 \
998         : LIKELY(NATIVE_UTF8_TO_I8(*s) <= _IS_UTF8_CHAR_HIGHEST_START_BYTE) \
999           ? is_UTF8_CHAR_utf8_no_length_checks(s)                           \
1000           : _is_utf8_char_helper(s, e, 0))
1001
1002 #define is_utf8_char_buf(buf, buf_end) isUTF8_CHAR(buf, buf_end)
1003
1004 /*
1005
1006 =for apidoc Am|STRLEN|isSTRICT_UTF8_CHAR|const U8 *s|const U8 *e
1007
1008 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
1009 looking no further than S<C<e - 1>> are well-formed UTF-8 that represents some
1010 Unicode code point completely acceptable for open interchange between all
1011 applications; otherwise it evaluates to 0.  If non-zero, the value gives how
1012 many bytes starting at C<s> comprise the code point's representation.  Any
1013 bytes remaining before C<e>, but beyond the ones needed to form the first code
1014 point in C<s>, are not examined.
1015
1016 The largest acceptable code point is the Unicode maximum 0x10FFFF, and must not
1017 be a surrogate nor a non-character code point.  Thus this excludes any code
1018 point from Perl's extended UTF-8.
1019
1020 This is used to efficiently decide if the next few bytes in C<s> is
1021 legal Unicode-acceptable UTF-8 for a single character.
1022
1023 Use C<L</isC9_STRICT_UTF8_CHAR>> to use the L<Unicode Corrigendum
1024 #9|http://www.unicode.org/versions/corrigendum9.html> definition of allowable
1025 code points; C<L</isUTF8_CHAR>> to check for Perl's extended UTF-8;
1026 and C<L</isUTF8_CHAR_flags>> for a more customized definition.
1027
1028 =cut
1029 */
1030
1031 #define isSTRICT_UTF8_CHAR(s, e)                                            \
1032     (UNLIKELY((e) <= (s))                                                   \
1033     ? 0                                                                     \
1034     : (UTF8_IS_INVARIANT(*s))                                               \
1035       ? 1                                                                   \
1036       : UNLIKELY(((e) - (s)) < UTF8SKIP(s))                                 \
1037         ? 0                                                                 \
1038         : is_STRICT_UTF8_CHAR_utf8_no_length_checks(s))
1039
1040 /*
1041
1042 =for apidoc Am|STRLEN|isC9_STRICT_UTF8_CHAR|const U8 *s|const U8 *e
1043
1044 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
1045 looking no further than S<C<e - 1>> are well-formed UTF-8 that represents some
1046 Unicode non-surrogate code point; otherwise it evaluates to 0.  If non-zero,
1047 the value gives how many bytes starting at C<s> comprise the code point's
1048 representation.  Any bytes remaining before C<e>, but beyond the ones needed to
1049 form the first code point in C<s>, are not examined.
1050
1051 The largest acceptable code point is the Unicode maximum 0x10FFFF.  This
1052 differs from C<L</isSTRICT_UTF8_CHAR>> only in that it accepts non-character
1053 code points.  This corresponds to
1054 L<Unicode Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>.
1055 which said that non-character code points are merely discouraged rather than
1056 completely forbidden in open interchange.  See
1057 L<perlunicode/Noncharacter code points>.
1058
1059 Use C<L</isUTF8_CHAR>> to check for Perl's extended UTF-8; and
1060 C<L</isUTF8_CHAR_flags>> for a more customized definition.
1061
1062 =cut
1063 */
1064
1065 #define isC9_STRICT_UTF8_CHAR(s, e)                                         \
1066     (UNLIKELY((e) <= (s))                                                   \
1067     ? 0                                                                     \
1068     : (UTF8_IS_INVARIANT(*s))                                               \
1069       ? 1                                                                   \
1070       : UNLIKELY(((e) - (s)) < UTF8SKIP(s))                                 \
1071         ? 0                                                                 \
1072         : is_C9_STRICT_UTF8_CHAR_utf8_no_length_checks(s))
1073
1074 /*
1075
1076 =for apidoc Am|STRLEN|isUTF8_CHAR_flags|const U8 *s|const U8 *e| const U32 flags
1077
1078 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
1079 looking no further than S<C<e - 1>> are well-formed UTF-8, as extended by Perl,
1080 that represents some code point, subject to the restrictions given by C<flags>;
1081 otherwise it evaluates to 0.  If non-zero, the value gives how many bytes
1082 starting at C<s> comprise the code point's representation.  Any bytes remaining
1083 before C<e>, but beyond the ones needed to form the first code point in C<s>,
1084 are not examined.
1085
1086 If C<flags> is 0, this gives the same results as C<L</isUTF8_CHAR>>;
1087 if C<flags> is C<UTF8_DISALLOW_ILLEGAL_INTERCHANGE>, this gives the same results
1088 as C<L</isSTRICT_UTF8_CHAR>>;
1089 and if C<flags> is C<UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE>, this gives
1090 the same results as C<L</isC9_STRICT_UTF8_CHAR>>.
1091 Otherwise C<flags> may be any combination of the C<UTF8_DISALLOW_I<foo>> flags
1092 understood by C<L</utf8n_to_uvchr>>, with the same meanings.
1093
1094 The three alternative macros are for the most commonly needed validations; they
1095 are likely to run somewhat faster than this more general one, as they can be
1096 inlined into your code.
1097
1098 =cut
1099 */
1100
1101 #define isUTF8_CHAR_flags(s, e, flags)                                      \
1102     (UNLIKELY((e) <= (s))                                                   \
1103     ? 0                                                                     \
1104     : (UTF8_IS_INVARIANT(*s))                                               \
1105       ? 1                                                                   \
1106       : UNLIKELY(((e) - (s)) < UTF8SKIP(s))                                 \
1107         ? 0                                                                 \
1108         : _is_utf8_char_helper(s, e, flags))
1109
1110 /* Do not use; should be deprecated.  Use isUTF8_CHAR() instead; this is
1111  * retained solely for backwards compatibility */
1112 #define IS_UTF8_CHAR(p, n)      (isUTF8_CHAR(p, (p) + (n)) == n)
1113
1114 #endif /* H_UTF8 */
1115
1116 /*
1117  * ex: set ts=8 sts=4 sw=4 et:
1118  */