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