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