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