This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Out of sync?
[perl5.git] / utf8.h
1 /*    utf8.h
2  *
3  *    Copyright (c) 1998-2000, 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_CONTINUATION         0x0001
37 #define UTF8_ALLOW_NON_CONTINUATION     0x0002
38 #define UTF8_ALLOW_FE_FF                0x0004
39 #define UTF8_ALLOW_SHORT                0x0008
40 #define UTF8_ALLOW_SURROGATE            0x0010
41 #define UTF8_ALLOW_BOM                  0x0020
42 #define UTF8_ALLOW_FFFF                 0x0040
43 #define UTF8_ALLOW_LONG                 0x0080
44 #define UTF8_ALLOW_ANYUV                (UTF8_ALLOW_FE_FF|UTF8_ALLOW_FFFF \
45                                         |UTF8_ALLOW_BOM|UTF8_ALLOW_SURROGATE)
46 #define UTF8_ALLOW_ANY                  0x00ff
47 #define UTF8_CHECK_ONLY                 0x0100
48
49 #define UNICODE_SURROGATE_FIRST         0xd800
50 #define UNICODE_SURROGATE_LAST          0xdfff
51 #define UNICODE_REPLACEMENT             0xfffd
52 #define UNICODE_BYTER_ORDER_MARK        0xfffe
53 #define UNICODE_ILLEGAL                 0xffff
54
55 #define UNICODE_IS_SURROGATE(c)         ((c) >= UNICODE_SURROGATE_FIRST && \
56                                          (c) <= UNICODE_SURROGATE_LAST)
57 #define UNICODE_IS_REPLACEMENT(c)       ((c) == UNICODE_REPLACMENT)
58 #define UNICODE_IS_BYTE_ORDER_MARK(c)   ((c) == UNICODE_BYTER_ORDER_MARK)
59 #define UNICODE_IS_ILLEGAL(c)           ((c) == UNICODE_ILLEGAL)
60
61 #define UTF8SKIP(s) PL_utf8skip[*(U8*)s]
62
63 #define UTF8_QUAD_MAX   UINT64_C(0x1000000000)
64
65 #define UTF8_IS_ASCII(c)                ((c) <  0x80)
66 #define UTF8_IS_START(c)                ((c) >= 0xc0 && ((c) <= 0xfd))
67 #define UTF8_IS_CONTINUATION(c)         ((c) >= 0x80 && ((c) <= 0xbf))
68
69 #ifdef HAS_QUAD
70 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
71                       (uv) < 0x800          ? 2 : \
72                       (uv) < 0x10000        ? 3 : \
73                       (uv) < 0x200000       ? 4 : \
74                       (uv) < 0x4000000      ? 5 : \
75                       (uv) < 0x80000000     ? 6 : \
76                       (uv) < UTF8_QUAD_MAX ? 7 : 13 ) 
77 #else
78 /* No, I'm not even going to *TRY* putting #ifdef inside a #define */
79 #define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
80                       (uv) < 0x800          ? 2 : \
81                       (uv) < 0x10000        ? 3 : \
82                       (uv) < 0x200000       ? 4 : \
83                       (uv) < 0x4000000      ? 5 : \
84                       (uv) < 0x80000000     ? 6 : 7 )
85 #endif
86
87
88 /*
89  * Note: we try to be careful never to call the isXXX_utf8() functions
90  * unless we're pretty sure we've seen the beginning of a UTF-8 character
91  * (that is, the two high bits are set).  Otherwise we risk loading in the
92  * heavy-duty SWASHINIT and SWASHGET routines unnecessarily.
93  */
94 #ifdef EBCDIC
95 #define isIDFIRST_lazy_if(p,c) isIDFIRST(*(p))
96 #define isALNUM_lazy_if(p,c)   isALNUM(*(p))
97 #else
98 #define isIDFIRST_lazy_if(p,c) ((IN_BYTE || (!c || (*((U8*)p) < 0xc0))) \
99                                 ? isIDFIRST(*(p)) \
100                                 : isIDFIRST_utf8((U8*)p))
101 #define isALNUM_lazy_if(p,c)   ((IN_BYTE || (!c || (*((U8*)p) < 0xc0))) \
102                                 ? isALNUM(*(p)) \
103                                 : isALNUM_utf8((U8*)p))
104 #endif
105 #define isIDFIRST_lazy(p)       isIDFIRST_lazy_if(p,1)
106 #define isALNUM_lazy(p)         isALNUM_lazy_if(p,1)