remove almost unreachable NULL sv arg code from sv_2*n_flags
[perl.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 #define uvchr_to_utf8(a,b)          uvchr_to_utf8_flags(a,b,0)
43 #define uvchr_to_utf8_flags(d,uv,flags)                                        \
44                             uvoffuni_to_utf8_flags(d,NATIVE_TO_UNI(uv),flags)
45 #define utf8_to_uvchr_buf(s, e, lenp)                                          \
46                      utf8n_to_uvchr(s, (U8*)(e) - (U8*)(s), lenp,              \
47                                     ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY)
48
49 #define to_uni_fold(c, p, lenp) _to_uni_fold_flags(c, p, lenp, FOLD_FLAGS_FULL)
50 #define to_utf8_fold(c, p, lenp) _to_utf8_fold_flags(c, p, lenp, \
51                      FOLD_FLAGS_FULL, NULL)
52 #define to_utf8_lower(a,b,c) _to_utf8_lower_flags(a,b,c,0, NULL)
53 #define to_utf8_upper(a,b,c) _to_utf8_upper_flags(a,b,c,0, NULL)
54 #define to_utf8_title(a,b,c) _to_utf8_title_flags(a,b,c,0, NULL)
55
56 /* Source backward compatibility. */
57 #define is_utf8_string_loc(s, len, ep)  is_utf8_string_loclen(s, len, ep, 0)
58
59 #define foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
60                     foldEQ_utf8_flags(s1, pe1, l1, u1, s2, pe2, l2, u2, 0)
61 #define FOLDEQ_UTF8_NOMIX_ASCII (1 << 0)
62 #define FOLDEQ_UTF8_LOCALE      (1 << 1)
63 #define FOLDEQ_S1_ALREADY_FOLDED  (1 << 2)
64 #define FOLDEQ_S2_ALREADY_FOLDED  (1 << 3)
65
66 /*
67 =for apidoc ibcmp_utf8
68
69 This is a synonym for (! foldEQ_utf8())
70
71 =cut
72 */
73 #define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
74                     cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2))
75
76 #ifdef EBCDIC
77 /* The equivalent of these macros but implementing UTF-EBCDIC
78    are in the following header file:
79  */
80
81 #include "utfebcdic.h"
82
83 #else   /* ! EBCDIC */
84 START_EXTERN_C
85
86 #ifdef DOINIT
87 EXTCONST unsigned char PL_utf8skip[] = {
88 /* 0x00 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
89 /* 0x10 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
90 /* 0x20 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
91 /* 0x30 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
92 /* 0x40 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
93 /* 0x50 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
94 /* 0x60 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
95 /* 0x70 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
96 /* 0x80 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
97 /* 0x90 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
98 /* 0xA0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
99 /* 0xB0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
100 /* 0xC0 */ 2,2,                             /* overlong */
101 /* 0xC2 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,     /* U+0080 to U+03FF */
102 /* 0xD0 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0400 to U+07FF */
103 /* 0xE0 */ 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3, /* U+0800 to U+FFFF */
104 /* 0xF0 */ 4,4,4,4,4,4,4,4,5,5,5,5,6,6,     /* above BMP to 2**31 - 1 */
105 /* 0xFE */ 7,13, /* Perl extended (never was official UTF-8).  Up to 72bit
106                     allowed (64-bit + reserved). */
107 };
108 #else
109 EXTCONST unsigned char PL_utf8skip[];
110 #endif
111
112 END_EXTERN_C
113
114 /* Native character to/from iso-8859-1.  Are the identity functions on ASCII
115  * platforms */
116 #define NATIVE_TO_LATIN1(ch)     (ch)
117 #define LATIN1_TO_NATIVE(ch)     (ch)
118
119 /* I8 is an intermediate version of UTF-8 used only in UTF-EBCDIC.  We thus
120  * consider it to be identical to UTF-8 on ASCII platforms.  Strictly speaking
121  * UTF-8 and UTF-EBCDIC are two different things, but we often conflate them
122  * because they are 8-bit encodings that serve the same purpose in Perl, and
123  * rarely do we need to distinguish them.  The term "NATIVE_UTF8" applies to
124  * whichever one is applicable on the current platform */
125 #define NATIVE_UTF8_TO_I8(ch) (ch)
126 #define I8_TO_NATIVE_UTF8(ch) (ch)
127
128 /* Transforms in wide UV chars */
129 #define UNI_TO_NATIVE(ch)        (ch)
130 #define NATIVE_TO_UNI(ch)        (ch)
131
132 /*
133
134  The following table is from Unicode 3.2.
135
136  Code Points            1st Byte  2nd Byte  3rd Byte  4th Byte
137
138    U+0000..U+007F       00..7F
139    U+0080..U+07FF     * C2..DF    80..BF
140    U+0800..U+0FFF       E0      * A0..BF    80..BF
141    U+1000..U+CFFF       E1..EC    80..BF    80..BF
142    U+D000..U+D7FF       ED        80..9F    80..BF
143    U+D800..U+DFFF       ED        A0..BF    80..BF  (surrogates)
144    U+E000..U+FFFF       EE..EF    80..BF    80..BF
145   U+10000..U+3FFFF      F0      * 90..BF    80..BF    80..BF
146   U+40000..U+FFFFF      F1..F3    80..BF    80..BF    80..BF
147  U+100000..U+10FFFF     F4        80..8F    80..BF    80..BF
148     Below are non-Unicode code points
149  U+110000..U+13FFFF     F4        90..BF    80..BF    80..BF
150  U+110000..U+1FFFFF     F5..F7    80..BF    80..BF    80..BF
151  U+200000..:            F8..    * 88..BF    80..BF    80..BF    80..BF
152
153 Note the gaps before several of the byte entries above marked by '*'.  These are
154 caused by legal UTF-8 avoiding non-shortest encodings: it is technically
155 possible to UTF-8-encode a single code point in different ways, but that is
156 explicitly forbidden, and the shortest possible encoding should always be used
157 (and that is what Perl does).  The non-shortest ones are called 'overlongs'.
158
159  */
160
161 /*
162  Another way to look at it, as bits:
163
164                   Code Points      1st Byte   2nd Byte   3rd Byte   4th Byte
165
166                         0aaa aaaa  0aaa aaaa
167               0000 0bbb bbaa aaaa  110b bbbb  10aa aaaa
168               cccc bbbb bbaa aaaa  1110 cccc  10bb bbbb  10aa aaaa
169  00 000d ddcc cccc bbbb bbaa aaaa  1111 0ddd  10cc cccc  10bb bbbb  10aa aaaa
170
171 As you can see, the continuation bytes all begin with C<10>, and the
172 leading bits of the start byte tell how many bytes there are in the
173 encoded character.
174
175 Perl's extended UTF-8 means we can have start bytes up to FF.
176
177 */
178
179 /* Is the representation of the Unicode code point 'c' the same regardless of
180  * being encoded in UTF-8 or not? */
181 #define UNI_IS_INVARIANT(c)             (((UV)c) <  0x80)
182
183 /* Is the UTF8-encoded byte 'c' part of a variant sequence in UTF-8?  This is
184  * the inverse of UTF8_IS_INVARIANT */
185 #define UTF8_IS_CONTINUED(c)            (((U8)c) &  0x80)
186
187 /* Is the byte 'c' the first byte of a multi-byte UTF8-8 encoded sequence?
188  * This doesn't catch invariants (they are single-byte).  It also excludes the
189  * illegal overlong sequences that begin with C0 and C1. */
190 #define UTF8_IS_START(c)                (((U8)c) >= 0xc2)
191
192 /* Is the byte 'c' part of a multi-byte UTF8-8 encoded sequence, and not the
193  * first byte thereof?  */
194 #define UTF8_IS_CONTINUATION(c)         ((((U8)c) & 0xC0) == 0x80)
195
196 /* Is the UTF8-encoded byte 'c' the first byte of a two byte sequence?  Use
197  * UTF8_IS_NEXT_CHAR_DOWNGRADEABLE() instead if the input isn't known to
198  * be well-formed.  Masking with 0xfe allows the low bit to be 0 or 1; thus
199  * this matches 0xc[23]. */
200 #define UTF8_IS_DOWNGRADEABLE_START(c)  (((U8)(c) & 0xfe) == 0xc2)
201
202 /* Is the UTF8-encoded byte 'c' the first byte of a sequence of bytes that
203  * represent a code point > 255? */
204 #define UTF8_IS_ABOVE_LATIN1(c) ((U8)(c) >= 0xc4)
205
206 /* This defines the 1-bits that are to be in the first byte of a multi-byte
207  * UTF-8 encoded character that give the number of bytes that comprise the
208  * character. 'len' is the number of bytes in the multi-byte sequence. */
209 #define UTF_START_MARK(len) (((len) >  7) ? 0xFF : (0xFF & (0xFE << (7-(len)))))
210
211 /* Masks out the initial one bits in a start byte, leaving the real data ones.
212  * Doesn't work on an invariant byte.  'len' is the number of bytes in the
213  * multi-byte sequence that comprises the character. */
214 #define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2)))
215
216 /* This defines the bits that are to be in the continuation bytes of a multi-byte
217  * UTF-8 encoded character that indicate it is a continuation byte. */
218 #define UTF_CONTINUATION_MARK           0x80
219
220 /* This is the number of low-order bits a continuation byte in a UTF-8 encoded
221  * sequence contributes to the specification of the code point.  In the bit
222  * maps above, you see that the first 2 bits are a constant '10', leaving 6 of
223  * real information */
224 #define UTF_ACCUMULATION_SHIFT          6
225
226 /* 2**UTF_ACCUMULATION_SHIFT - 1 */
227 #define UTF_CONTINUATION_MASK           ((U8)0x3f)
228
229 /* If a value is anded with this, and the result is non-zero, then using the
230  * original value in UTF8_ACCUMULATE will overflow, shifting bits off the left
231  * */
232 #define UTF_ACCUMULATION_OVERFLOW_MASK                                  \
233     (((UV) UTF_CONTINUATION_MASK) << ((sizeof(UV) * CHARBITS)           \
234            - UTF_ACCUMULATION_SHIFT))
235
236 #if UVSIZE >= 8
237 #  define UTF8_QUAD_MAX UINT64_C(0x1000000000)
238
239 /* Input is a true Unicode (not-native) code point */
240 #define OFFUNISKIP(uv) ( (uv) < 0x80        ? 1 : \
241                       (uv) < 0x800          ? 2 : \
242                       (uv) < 0x10000        ? 3 : \
243                       (uv) < 0x200000       ? 4 : \
244                       (uv) < 0x4000000      ? 5 : \
245                       (uv) < 0x80000000     ? 6 : \
246                       (uv) < UTF8_QUAD_MAX ? 7 : 13 )
247 #else
248 /* No, I'm not even going to *TRY* putting #ifdef inside a #define */
249 #define OFFUNISKIP(uv) ( (uv) < 0x80        ? 1 : \
250                       (uv) < 0x800          ? 2 : \
251                       (uv) < 0x10000        ? 3 : \
252                       (uv) < 0x200000       ? 4 : \
253                       (uv) < 0x4000000      ? 5 : \
254                       (uv) < 0x80000000     ? 6 : 7 )
255 #endif
256
257 /* How wide can a single UTF-8 encoded character become in bytes. */
258 /* NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8 since UTF-8
259  * is an encoding of Unicode, and Unicode's upper limit, 0x10FFFF, can be
260  * expressed with 4 bytes.  However, Perl thinks of UTF-8 as a way to encode
261  * non-negative integers in a binary format, even those above Unicode */
262 #define UTF8_MAXBYTES 13
263
264 /* The maximum number of UTF-8 bytes a single Unicode character can
265  * uppercase/lowercase/fold into.  Unicode guarantees that the maximum
266  * expansion is 3 characters.  On ASCIIish platforms, the highest Unicode
267  * character occupies 4 bytes, therefore this number would be 12, but this is
268  * smaller than the maximum width a single above-Unicode character can occupy,
269  * so use that instead */
270 #if UTF8_MAXBYTES < 12
271 #error UTF8_MAXBYTES must be at least 12
272 #endif
273
274 #define MAX_UTF8_TWO_BYTE 0x7FF
275
276 #define UTF8_MAXBYTES_CASE      UTF8_MAXBYTES
277
278 #endif /* EBCDIC vs ASCII */
279
280 /* Rest of these are attributes of Unicode and perl's internals rather than the
281  * encoding, or happen to be the same in both ASCII and EBCDIC (at least at
282  * this level; the macros that some of these call may have different
283  * definitions in the two encodings */
284
285 /* In domain restricted to ASCII, these may make more sense to the reader than
286  * the ones with Latin1 in the name */
287 #define NATIVE_TO_ASCII(ch)      NATIVE_TO_LATIN1(ch)
288 #define ASCII_TO_NATIVE(ch)      LATIN1_TO_NATIVE(ch)
289
290 /* More or less misleadingly-named defines, retained for back compat */
291 #define NATIVE_TO_UTF(ch)        NATIVE_UTF8_TO_I8(ch)
292 #define NATIVE_TO_I8(ch)         NATIVE_UTF8_TO_I8(ch)
293 #define UTF_TO_NATIVE(ch)        I8_TO_NATIVE_UTF8(ch)
294 #define I8_TO_NATIVE(ch)         I8_TO_NATIVE_UTF8(ch)
295 #define NATIVE8_TO_UNI(ch)       NATIVE_TO_LATIN1(ch)
296
297 /* Adds a UTF8 continuation byte 'new' of information to a running total code
298  * point 'old' of all the continuation bytes so far.  This is designed to be
299  * used in a loop to convert from UTF-8 to the code point represented.  Note
300  * that this is asymmetric on EBCDIC platforms, in that the 'new' parameter is
301  * the UTF-EBCDIC byte, whereas the 'old' parameter is a Unicode (not EBCDIC)
302  * code point in process of being generated */
303 #define UTF8_ACCUMULATE(old, new) (((old) << UTF_ACCUMULATION_SHIFT)           \
304                                    | ((NATIVE_UTF8_TO_I8((U8)new))             \
305                                        & UTF_CONTINUATION_MASK))
306
307 /* This works in the face of malformed UTF-8. */
308 #define UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, e) (UTF8_IS_DOWNGRADEABLE_START(*s) \
309                                                && ( (e) - (s) > 1)             \
310                                                && UTF8_IS_CONTINUATION(*((s)+1)))
311
312 /* Number of bytes a code point occupies in UTF-8. */
313 #define NATIVE_SKIP(uv) OFFUNISKIP(NATIVE_TO_UNI(uv))
314
315 /* Most code which says UNISKIP is really thinking in terms of native code
316  * points (0-255) plus all those beyond.  This is an imprecise term, but having
317  * it means existing code continues to work.  For precision, use NATIVE_SKIP
318  * and OFFUNISKIP */
319 #define UNISKIP(uv)   NATIVE_SKIP(uv)
320
321 /* Convert a two (not one) byte utf8 character to a native code point value.
322  * Needs just one iteration of accumulate.  Should not be used unless it is
323  * known that the two bytes are legal: 1) two-byte start, and 2) continuation.
324  * Note that the result can be larger than 255 if the input character is not
325  * downgradable */
326 #define TWO_BYTE_UTF8_TO_NATIVE(HI, LO) \
327      UNI_TO_NATIVE(UTF8_ACCUMULATE((NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), \
328                                    (LO)))
329
330 /* Should never be used, and be deprecated */
331 #define TWO_BYTE_UTF8_TO_UNI(HI, LO) NATIVE_TO_UNI(TWO_BYTE_UTF8_TO_NATIVE(HI, LO))
332
333 /* How many bytes in the UTF-8 encoded character whose first (perhaps only)
334  * byte is pointed to by 's' */
335 #define UTF8SKIP(s) PL_utf8skip[*(const U8*)(s)]
336
337 /* Is the byte 'c' the same character when encoded in UTF-8 as when not.  This
338  * works on both UTF-8 encoded strings and non-encoded, as it returns TRUE in
339  * each for the exact same set of bit patterns.  (And it works on any byte in a
340  * UTF-8 encoded string) */
341 #define UTF8_IS_INVARIANT(c)            UNI_IS_INVARIANT(NATIVE_UTF8_TO_I8(c))
342
343 /* Like the above, but its name implies a non-UTF8 input, and is implemented
344  * differently (for no particular reason) */
345 #define NATIVE_BYTE_IS_INVARIANT(c)     UNI_IS_INVARIANT(NATIVE_TO_LATIN1(c))
346
347 /* Like the above, but accepts any UV as input */
348 #define UVCHR_IS_INVARIANT(uv)          UNI_IS_INVARIANT(NATIVE_TO_UNI(uv))
349
350 #define MAX_PORTABLE_UTF8_TWO_BYTE 0x3FF    /* constrained by EBCDIC */
351
352 /* The macros in the next sets are used to generate the two utf8 or utfebcdic
353  * bytes from an ordinal that is known to fit into two bytes; it must be less
354  * than 0x3FF to work across both encodings. */
355 /* Nocast allows these to be used in the case label of a switch statement;
356  * however this doesn't won't work for ebcdic, and should be avoided.  Use
357  * regen/unicode_constants instead */
358 #define UTF8_TWO_BYTE_HI_nocast(c)      I8_TO_NATIVE_UTF8((NATIVE_TO_UNI(c)     \
359                         >> UTF_ACCUMULATION_SHIFT) | UTF_START_MARK(2))
360 #define UTF8_TWO_BYTE_LO_nocast(c)  I8_TO_NATIVE_UTF8((NATIVE_TO_UNI(c)         \
361                                                   & UTF_CONTINUATION_MASK)      \
362                                                 | UTF_CONTINUATION_MARK)
363
364 #define UTF8_TWO_BYTE_HI(c)     ((U8) (UTF8_TWO_BYTE_HI_nocast(c)))
365 #define UTF8_TWO_BYTE_LO(c)     ((U8) (UTF8_TWO_BYTE_LO_nocast(c)))
366
367 /* This name is used when the source is a single byte (input not checked).
368  * These expand identically to the TWO_BYTE versions on ASCII platforms, but
369  * use to/from LATIN1 instead of UNI, which on EBCDIC eliminates tests */
370 #define UTF8_EIGHT_BIT_HI(c)    I8_TO_NATIVE_UTF8((NATIVE_TO_LATIN1(c)          \
371                                                     >> UTF_ACCUMULATION_SHIFT)  \
372                                                 | UTF_START_MARK(2))
373 #define UTF8_EIGHT_BIT_LO(c)    I8_TO_NATIVE_UTF8((NATIVE_TO_LATIN1(c)          \
374                                                   & UTF_CONTINUATION_MASK)      \
375                                                 | UTF_CONTINUATION_MARK)
376
377 /* This is illegal in any well-formed UTF-8 in both EBCDIC and ASCII
378  * as it is only in overlongs. */
379 #define ILLEGAL_UTF8_BYTE   I8_TO_NATIVE_UTF8(0xC1)
380
381 /*
382  * 'UTF' is whether or not p is encoded in UTF8.  The names 'foo_lazy_if' stem
383  * from an earlier version of these macros in which they didn't call the
384  * foo_utf8() macros (i.e. were 'lazy') unless they decided that *p is the
385  * beginning of a utf8 character.  Now that foo_utf8() determines that itself,
386  * no need to do it again here
387  */
388 #define isIDFIRST_lazy_if(p,UTF) ((IN_BYTES || !UTF ) \
389                                  ? isIDFIRST(*(p)) \
390                                  : isIDFIRST_utf8((const U8*)p))
391 #define isWORDCHAR_lazy_if(p,UTF)   ((IN_BYTES || (!UTF )) \
392                                  ? isWORDCHAR(*(p)) \
393                                  : isWORDCHAR_utf8((const U8*)p))
394 #define isALNUM_lazy_if(p,UTF)   isWORDCHAR_lazy_if(p,UTF)
395
396 #define UTF8_MAXLEN UTF8_MAXBYTES
397
398 /* A Unicode character can fold to up to 3 characters */
399 #define UTF8_MAX_FOLD_CHAR_EXPAND 3
400
401 #define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES)
402 #define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
403 #define IN_UNI_8_BIT \
404             (CopHINTS_get(PL_curcop) & (HINT_UNI_8_BIT|HINT_LOCALE_NOT_CHARS) \
405              && ! IN_LOCALE_RUNTIME && ! IN_BYTES)
406
407
408 #define UTF8_ALLOW_EMPTY                0x0001  /* Allow a zero length string */
409
410 /* Allow first byte to be a continuation byte */
411 #define UTF8_ALLOW_CONTINUATION         0x0002
412
413 /* Allow second... bytes to be non-continuation bytes */
414 #define UTF8_ALLOW_NON_CONTINUATION     0x0004
415
416 /* expecting more bytes than were available in the string */
417 #define UTF8_ALLOW_SHORT                0x0008
418
419 /* Overlong sequence; i.e., the code point can be specified in fewer bytes. */
420 #define UTF8_ALLOW_LONG                 0x0010
421
422 #define UTF8_DISALLOW_SURROGATE         0x0020  /* Unicode surrogates */
423 #define UTF8_WARN_SURROGATE             0x0040
424
425 #define UTF8_DISALLOW_NONCHAR           0x0080  /* Unicode non-character */
426 #define UTF8_WARN_NONCHAR               0x0100  /*  code points */
427
428 #define UTF8_DISALLOW_SUPER             0x0200  /* Super-set of Unicode: code */
429 #define UTF8_WARN_SUPER                 0x0400  /* points above the legal max */
430
431 /* Code points which never were part of the original UTF-8 standard, the first
432  * byte of which is a FE or FF on ASCII platforms. */
433 #define UTF8_DISALLOW_FE_FF             0x0800
434 #define UTF8_WARN_FE_FF                 0x1000
435
436 #define UTF8_CHECK_ONLY                 0x2000
437
438 /* For backwards source compatibility.  They do nothing, as the default now
439  * includes what they used to mean.  The first one's meaning was to allow the
440  * just the single non-character 0xFFFF */
441 #define UTF8_ALLOW_FFFF 0
442 #define UTF8_ALLOW_SURROGATE 0
443
444 #define UTF8_DISALLOW_ILLEGAL_INTERCHANGE (UTF8_DISALLOW_SUPER|UTF8_DISALLOW_NONCHAR|UTF8_DISALLOW_SURROGATE|UTF8_DISALLOW_FE_FF)
445 #define UTF8_WARN_ILLEGAL_INTERCHANGE \
446         (UTF8_WARN_SUPER|UTF8_WARN_NONCHAR|UTF8_WARN_SURROGATE|UTF8_WARN_FE_FF)
447 #define UTF8_ALLOW_ANY \
448             (~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
449 #define UTF8_ALLOW_ANYUV                                                        \
450          (UTF8_ALLOW_EMPTY                                                      \
451           & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_WARN_ILLEGAL_INTERCHANGE))
452 #define UTF8_ALLOW_DEFAULT              (ckWARN(WARN_UTF8) ? 0 : \
453                                          UTF8_ALLOW_ANYUV)
454
455 /* Surrogates, non-character code points and above-Unicode code points are
456  * problematic in some contexts.  This allows code that needs to check for
457  * those to to quickly exclude the vast majority of code points it will
458  * encounter */
459 #define UTF8_FIRST_PROBLEMATIC_CODE_POINT_FIRST_BYTE \
460                                     FIRST_SURROGATE_UTF8_FIRST_BYTE
461
462 #define UTF8_IS_SURROGATE(s) cBOOL(is_SURROGATE_utf8(s))
463 #define UTF8_IS_REPLACEMENT(s, send) cBOOL(is_REPLACEMENT_utf8_safe(s,send))
464
465 /*                ASCII              EBCDIC I8
466  * U+10FFFF: \xF4\x8F\xBF\xBF   \xF9\xA1\xBF\xBF\xBF    max legal Unicode
467  * U+110000: \xF4\x90\x80\x80   \xF9\xA2\xA0\xA0\xA0
468  * U+110001: \xF4\x90\x80\x81   \xF9\xA2\xA0\xA0\xA1
469  */
470 #ifdef EBCDIC /* Both versions assume well-formed UTF8 */
471 #   define UTF8_IS_SUPER(s) (NATIVE_UTF8_TO_I8(* (U8*) (s)) >= 0xF9             \
472                          && (NATIVE_UTF8_TO_I8(* (U8*) (s)) > 0xF9              \
473                              || (NATIVE_UTF8_TO_I8(* ((U8*) (s) + 1)) >= 0xA2)))
474 #else
475 #   define UTF8_IS_SUPER(s) (*(U8*) (s) >= 0xF4                                 \
476                             && (*(U8*) (s) > 0xF4 || (*((U8*) (s) + 1) >= 0x90)))
477 #endif
478
479 /* These are now machine generated, and the 'given' clause is no longer
480  * applicable */
481 #define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s)             \
482                                                     cBOOL(is_NONCHAR_utf8(s))
483 #define UTF8_IS_NONCHAR_(s)                                                    \
484                     UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s)
485
486 #define UNICODE_SURROGATE_FIRST         0xD800
487 #define UNICODE_SURROGATE_LAST          0xDFFF
488 #define UNICODE_REPLACEMENT             0xFFFD
489 #define UNICODE_BYTE_ORDER_MARK         0xFEFF
490
491 /* Though our UTF-8 encoding can go beyond this,
492  * let's be conservative and do as Unicode says. */
493 #define PERL_UNICODE_MAX        0x10FFFF
494
495 #define UNICODE_WARN_SURROGATE     0x0001       /* UTF-16 surrogates */
496 #define UNICODE_WARN_NONCHAR       0x0002       /* Non-char code points */
497 #define UNICODE_WARN_SUPER         0x0004       /* Above 0x10FFFF */
498 #define UNICODE_WARN_FE_FF         0x0008       /* Above 0x10FFFF */
499 #define UNICODE_DISALLOW_SURROGATE 0x0010
500 #define UNICODE_DISALLOW_NONCHAR   0x0020
501 #define UNICODE_DISALLOW_SUPER     0x0040
502 #define UNICODE_DISALLOW_FE_FF     0x0080
503 #define UNICODE_WARN_ILLEGAL_INTERCHANGE                                      \
504             (UNICODE_WARN_SURROGATE|UNICODE_WARN_NONCHAR|UNICODE_WARN_SUPER)
505 #define UNICODE_DISALLOW_ILLEGAL_INTERCHANGE                                  \
506  (UNICODE_DISALLOW_SURROGATE|UNICODE_DISALLOW_NONCHAR|UNICODE_DISALLOW_SUPER)
507
508 /* For backward source compatibility, as are now the default */
509 #define UNICODE_ALLOW_SURROGATE 0
510 #define UNICODE_ALLOW_SUPER     0
511 #define UNICODE_ALLOW_ANY       0
512
513 #define UNICODE_IS_SURROGATE(c)         ((c) >= UNICODE_SURROGATE_FIRST && \
514                                          (c) <= UNICODE_SURROGATE_LAST)
515 #define UNICODE_IS_REPLACEMENT(c)       ((c) == UNICODE_REPLACEMENT)
516 #define UNICODE_IS_BYTE_ORDER_MARK(c)   ((c) == UNICODE_BYTE_ORDER_MARK)
517 #define UNICODE_IS_NONCHAR(c)           ((c >= 0xFDD0 && c <= 0xFDEF) \
518                         /* The other noncharacters end in FFFE or FFFF, which  \
519                          * the mask below catches both of, but beyond the last \
520                          * official unicode code point, they aren't            \
521                          * noncharacters, since those aren't Unicode           \
522                          * characters at all */                                \
523                         || ((((c & 0xFFFE) == 0xFFFE)) && ! UNICODE_IS_SUPER(c)))
524 #define UNICODE_IS_SUPER(c)             ((c) > PERL_UNICODE_MAX)
525 #define UNICODE_IS_FE_FF(c)             ((c) > 0x7FFFFFFF)
526
527 #define LATIN_SMALL_LETTER_SHARP_S      LATIN_SMALL_LETTER_SHARP_S_NATIVE
528 #define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS                                  \
529                                 LATIN_SMALL_LETTER_Y_WITH_DIAERESIS_NATIVE
530 #define MICRO_SIGN      MICRO_SIGN_NATIVE
531 #define LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE                               \
532                             LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE_NATIVE
533 #define LATIN_SMALL_LETTER_A_WITH_RING_ABOVE                                 \
534                                 LATIN_SMALL_LETTER_A_WITH_RING_ABOVE_NATIVE
535 #define UNICODE_GREEK_CAPITAL_LETTER_SIGMA      0x03A3
536 #define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA  0x03C2
537 #define UNICODE_GREEK_SMALL_LETTER_SIGMA        0x03C3
538 #define GREEK_SMALL_LETTER_MU                   0x03BC
539 #define GREEK_CAPITAL_LETTER_MU                 0x039C  /* Upper and title case
540                                                            of MICRON */
541 #define LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS   0x0178  /* Also is title case */
542 #define LATIN_CAPITAL_LETTER_SHARP_S            0x1E9E
543 #define LATIN_SMALL_LETTER_LONG_S               0x017F
544 #define LATIN_SMALL_LIGATURE_LONG_S_T           0xFB05
545 #define LATIN_SMALL_LIGATURE_ST                 0xFB06
546 #define KELVIN_SIGN                             0x212A
547 #define ANGSTROM_SIGN                           0x212B
548
549 #define UNI_DISPLAY_ISPRINT     0x0001
550 #define UNI_DISPLAY_BACKSLASH   0x0002
551 #define UNI_DISPLAY_QQ          (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
552 #define UNI_DISPLAY_REGEX       (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
553
554 #define ANYOF_FOLD_SHARP_S(node, input, end)    \
555         (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \
556          (ANYOF_NONBITMAP(node)) && \
557          (ANYOF_FLAGS(node) & ANYOF_LOC_NONBITMAP_FOLD) && \
558          ((end) > (input) + 1) && \
559          toFOLD((input)[0]) == 's' && \
560          toFOLD((input)[1]) == 's')
561 #define SHARP_S_SKIP 2
562
563 /* If you want to exclude surrogates, and beyond legal Unicode, see the blame
564  * log for earlier versions which gave details for these */
565
566 #ifndef EBCDIC
567 /* This was generated by regen/regcharclass.pl, and then moved here.  The lines
568  * that generated it were then commented out.  This was done solely because it
569  * takes on the order of 10 minutes to generate, and is never going to change.
570  * The EBCDIC equivalent hasn't been commented out in regcharclass.pl, so it
571  * should generate and run the correct stuff */
572 /*
573         UTF8_CHAR: Matches utf8 from 1 to 4 bytes
574
575         0x0 - 0x1FFFFF
576 */
577 /*** GENERATED CODE ***/
578 #define is_UTF8_CHAR_utf8_safe(s,e)                                         \
579 ( ((e)-(s) > 3) ?                                                           \
580     ( ( ( ((U8*)s)[0] & 0x80 ) == 0x00 ) ? 1                                \
581     : ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ?                      \
582         ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 )                      \
583     : ( 0xE0 == ((U8*)s)[0] ) ?                                             \
584         ( ( ( ( ((U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
585     : ( 0xE1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xEF ) ?                      \
586         ( ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
587     : ( 0xF0 == ((U8*)s)[0] ) ?                                             \
588         ( ( ( ( 0x90 <= ((U8*)s)[1] && ((U8*)s)[1] <= 0xBF ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
589     : ( ( ( ( 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 )\
590 : ((e)-(s) > 2) ?                                                           \
591     ( ( ( ((U8*)s)[0] & 0x80 ) == 0x00 ) ? 1                                \
592     : ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) ?                      \
593         ( ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 )                      \
594     : ( 0xE0 == ((U8*)s)[0] ) ?                                             \
595         ( ( ( ( ((U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
596     : ( ( ( 0xE1 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xEF ) && ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ) && ( ( ((U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
597 : ((e)-(s) > 1) ?                                                           \
598     ( ( ( ((U8*)s)[0] & 0x80 ) == 0x00 ) ? 1                                \
599     : ( ( 0xC2 <= ((U8*)s)[0] && ((U8*)s)[0] <= 0xDF ) && ( ( ((U8*)s)[1] & 0xC0 ) == 0x80 ) ) ? 2 : 0 )\
600 : ((e)-(s) > 0) ?                                                           \
601     ( ( ((U8*)s)[0] & 0x80 ) == 0x00 )                                      \
602 : 0 )
603 #endif
604
605 /* IS_UTF8_CHAR(p) is strictly speaking wrong (not UTF-8) because it
606  * (1) allows UTF-8 encoded UTF-16 surrogates
607  * (2) it allows code points past U+10FFFF.
608  * The Perl_is_utf8_char() full "slow" code will handle the Perl
609  * "extended UTF-8". */
610 #define IS_UTF8_CHAR(p, n)      (is_UTF8_CHAR_utf8_safe(p, (p) + (n)) == n)
611
612 /* regen/regcharclass.pl generates is_UTF8_CHAR_utf8_safe() macros for up to
613  * these number of bytes.  So this has to be coordinated with it */
614 #ifdef EBCDIC
615 #   define IS_UTF8_CHAR_FAST(n) ((n) <= 5)
616 #else
617 #   define IS_UTF8_CHAR_FAST(n) ((n) <= 4)
618 #endif
619
620 #endif /* H_UTF8 */
621
622 /*
623  * Local variables:
624  * c-indentation-style: bsd
625  * c-basic-offset: 4
626  * indent-tabs-mode: nil
627  * End:
628  *
629  * ex: set ts=8 sts=4 sw=4 et:
630  */