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