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