This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Retract #8762.
[perl5.git] / utf8.h
1 /*    utf8.h
2  *
3  *    Copyright (c) 1998-2001, Larry Wall
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  */
9
10 START_EXTERN_C
11
12 #ifdef DOINIT
13 EXTCONST unsigned char PL_utf8skip[] = {
14 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
15 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
16 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
17 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
18 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus */
19 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus */
20 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* scripts */
21 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,4,4,4,4,4,4,4,4,5,5,5,5,6,6,     /* cjk etc. */
22 7,13, /* Perl extended (not UTF-8).  Up to 72bit allowed (64-bit + reserved). */
23 };
24 #else
25 EXTCONST unsigned char PL_utf8skip[];
26 #endif
27
28 END_EXTERN_C
29
30 #define UTF8_MAXLEN 13 /* how wide can a single UTF8 encoded character become */
31
32 /* #define IN_UTF8 (PL_curcop->op_private & HINT_UTF8) */
33 #define IN_BYTE (PL_curcop->op_private & HINT_BYTE)
34 #define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTE)
35
36 #define UTF8_ALLOW_EMPTY                0x0001
37 #define UTF8_ALLOW_CONTINUATION         0x0002
38 #define UTF8_ALLOW_NON_CONTINUATION     0x0004
39 #define UTF8_ALLOW_FE_FF                0x0008
40 #define UTF8_ALLOW_SHORT                0x0010
41 #define UTF8_ALLOW_SURROGATE            0x0020
42 #define UTF8_ALLOW_BOM                  0x0040
43 #define UTF8_ALLOW_FFFF                 0x0080
44 #define UTF8_ALLOW_LONG                 0x0100
45 #define UTF8_ALLOW_ANYUV                (UTF8_ALLOW_EMPTY|UTF8_ALLOW_FE_FF|\
46                                          UTF8_ALLOW_SURROGATE|UTF8_ALLOW_BOM|\
47                                          UTF8_ALLOW_FFFF|UTF8_ALLOW_LONG)
48 #define UTF8_ALLOW_ANY                  0x00ff
49 #define UTF8_CHECK_ONLY                 0x0100
50
51 #define UNICODE_SURROGATE_FIRST         0xd800
52 #define UNICODE_SURROGATE_LAST          0xdfff
53 #define UNICODE_REPLACEMENT             0xfffd
54 #define UNICODE_BYTER_ORDER_MARK        0xfffe
55 #define UNICODE_ILLEGAL                 0xffff
56
57 #define UNICODE_IS_SURROGATE(c)         ((c) >= UNICODE_SURROGATE_FIRST && \
58                                          (c) <= UNICODE_SURROGATE_LAST)
59 #define UNICODE_IS_REPLACEMENT(c)       ((c) == UNICODE_REPLACMENT)
60 #define UNICODE_IS_BYTE_ORDER_MARK(c)   ((c) == UNICODE_BYTER_ORDER_MARK)
61 #define UNICODE_IS_ILLEGAL(c)           ((c) == UNICODE_ILLEGAL)
62
63 #define UTF8SKIP(s) PL_utf8skip[*(U8*)s]
64
65 #define UTF8_QUAD_MAX   UINT64_C(0x1000000000)
66
67 #define UTF8_IS_ASCII(c)                (((U8)c) <  0x80)
68 #define UTF8_IS_START(c)                (((U8)c) >= 0xc0 && (((U8)c) <= 0xfd))
69 #define UTF8_IS_CONTINUATION(c)         (((U8)c) >= 0x80 && (((U8)c) <= 0xbf))
70 #define UTF8_IS_CONTINUED(c)            (((U8)c) &  0x80)
71 #define UTF8_IS_DOWNGRADEABLE_START(c)  (((U8)c & 0xfc) != 0xc0)
72
73 #define UTF8_CONTINUATION_MASK          ((U8)0x3f)
74 #define UTF8_ACCUMULATION_SHIFT         6
75 #define UTF8_ACCUMULATE(old, new)       ((old) << UTF8_ACCUMULATION_SHIFT | (((U8)new) & UTF8_CONTINUATION_MASK))
76
77 #define UTF8_EIGHT_BIT_HI(c)    ( (((U8)(c))>>6)      |0xc0)
78 #define UTF8_EIGHT_BIT_LO(c)    (((((U8)(c))   )&0x3f)|0x80)
79
80 #ifdef HAS_QUAD
81 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
82                       (uv) < 0x800          ? 2 : \
83                       (uv) < 0x10000        ? 3 : \
84                       (uv) < 0x200000       ? 4 : \
85                       (uv) < 0x4000000      ? 5 : \
86                       (uv) < 0x80000000     ? 6 : \
87                       (uv) < UTF8_QUAD_MAX ? 7 : 13 ) 
88 #else
89 /* No, I'm not even going to *TRY* putting #ifdef inside a #define */
90 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
91                       (uv) < 0x800          ? 2 : \
92                       (uv) < 0x10000        ? 3 : \
93                       (uv) < 0x200000       ? 4 : \
94                       (uv) < 0x4000000      ? 5 : \
95                       (uv) < 0x80000000     ? 6 : 7 )
96 #endif
97
98
99 /*
100  * Note: we try to be careful never to call the isXXX_utf8() functions
101  * unless we're pretty sure we've seen the beginning of a UTF-8 character
102  * (that is, the two high bits are set).  Otherwise we risk loading in the
103  * heavy-duty SWASHINIT and SWASHGET routines unnecessarily.
104  */
105 #ifdef EBCDIC
106 #define isIDFIRST_lazy_if(p,c) isIDFIRST(*(p))
107 #define isALNUM_lazy_if(p,c)   isALNUM(*(p))
108 #else
109 #define isIDFIRST_lazy_if(p,c) ((IN_BYTE || (!c || (*((U8*)p) < 0xc0))) \
110                                 ? isIDFIRST(*(p)) \
111                                 : isIDFIRST_utf8((U8*)p))
112 #define isALNUM_lazy_if(p,c)   ((IN_BYTE || (!c || (*((U8*)p) < 0xc0))) \
113                                 ? isALNUM(*(p)) \
114                                 : isALNUM_utf8((U8*)p))
115 #endif
116 #define isIDFIRST_lazy(p)       isIDFIRST_lazy_if(p,1)
117 #define isALNUM_lazy(p)         isALNUM_lazy_if(p,1)