This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document utf8_to_uv() better.
[perl5.git] / utf8.h
CommitLineData
a0ed51b3
LW
1/* utf8.h
2 *
3818b22b 3 * Copyright (c) 1998-2000, Larry Wall
a0ed51b3
LW
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
73c4f7a1
GS
10START_EXTERN_C
11
a0ed51b3 12#ifdef DOINIT
6f06b55f 13EXTCONST unsigned char PL_utf8skip[] = {
a0ed51b3
LW
141,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 */
151,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 */
161,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 */
171,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 */
181,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 */
191,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 */
202,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 */
3c77ea2b
GS
213,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. */
227,13, /* Perl extended (not UTF-8). Up to 72bit allowed (64-bit + reserved). */
a0ed51b3
LW
23};
24#else
6f06b55f 25EXTCONST unsigned char PL_utf8skip[];
a0ed51b3
LW
26#endif
27
73c4f7a1
GS
28END_EXTERN_C
29
aa6ffa16
GS
30#define UTF8_MAXLEN 13 /* how wide can a single UTF8 encoded character become */
31
fcc8fcf6 32/* #define IN_UTF8 (PL_curcop->op_private & HINT_UTF8) */
5bc28da9 33#define IN_BYTE (PL_curcop->op_private & HINT_BYTE)
7e2040f0 34#define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTE)
a0ed51b3 35
fcc8fcf6
JH
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
cc366d4b
YST
44#define UTF8_ALLOW_ANYUV (UTF8_ALLOW_FE_FF|UTF8_ALLOW_FFFF \
45 |UTF8_ALLOW_BOM|UTF8_ALLOW_SURROGATE)
fcc8fcf6
JH
46#define UTF8_ALLOW_ANY 0x00ff
47#define UTF8_CHECK_ONLY 0x0100
48
6f06b55f 49#define UTF8SKIP(s) PL_utf8skip[*(U8*)s]
7e2040f0 50
d7578b48
JH
51#define UTF8_QUAD_MAX UINT64_C(0x1000000000)
52
1d68d6cd 53#ifdef HAS_QUAD
5bbb0b5a 54#define UNISKIP(uv) ( (uv) < 0x80 ? 1 : \
1d68d6cd
SC
55 (uv) < 0x800 ? 2 : \
56 (uv) < 0x10000 ? 3 : \
57 (uv) < 0x200000 ? 4 : \
58 (uv) < 0x4000000 ? 5 : \
59 (uv) < 0x80000000 ? 6 : \
d7578b48 60 (uv) < UTF8_QUAD_MAX ? 7 : 13 )
1d68d6cd
SC
61#else
62/* No, I'm not even going to *TRY* putting #ifdef inside a #define */
5bbb0b5a 63#define UNISKIP(uv) ( (uv) < 0x80 ? 1 : \
1d68d6cd
SC
64 (uv) < 0x800 ? 2 : \
65 (uv) < 0x10000 ? 3 : \
66 (uv) < 0x200000 ? 4 : \
67 (uv) < 0x4000000 ? 5 : \
68 (uv) < 0x80000000 ? 6 : 7 )
69#endif
70
ba210ebe
JH
71#define UNICODE_REPLACEMENT_CHARACTER 0xfffd
72
7e2040f0
GS
73/*
74 * Note: we try to be careful never to call the isXXX_utf8() functions
75 * unless we're pretty sure we've seen the beginning of a UTF-8 character
76 * (that is, the two high bits are set). Otherwise we risk loading in the
77 * heavy-duty SWASHINIT and SWASHGET routines unnecessarily.
78 */
5b154c98
JH
79#ifdef EBCDIC
80#define isIDFIRST_lazy_if(p,c) isIDFIRST(*(p))
81#define isALNUM_lazy_if(p,c) isALNUM(*(p))
82#else
83#define isIDFIRST_lazy_if(p,c) ((IN_BYTE || (!c || (*((U8*)p) < 0xc0))) \
7e2040f0
GS
84 ? isIDFIRST(*(p)) \
85 : isIDFIRST_utf8((U8*)p))
5b154c98 86#define isALNUM_lazy_if(p,c) ((IN_BYTE || (!c || (*((U8*)p) < 0xc0))) \
7e2040f0
GS
87 ? isALNUM(*(p)) \
88 : isALNUM_utf8((U8*)p))
5b154c98 89#endif
7e2040f0
GS
90#define isIDFIRST_lazy(p) isIDFIRST_lazy_if(p,1)
91#define isALNUM_lazy(p) isALNUM_lazy_if(p,1)