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