[perl5.git] / utf8.h

/*    utf8.h
 *
 *    Copyright (c) 1998-2002, Larry Wall
 *
 *    You may distribute under the terms of either the GNU General Public
 *    License or the Artistic License, as specified in the README file.
 *
 */

/* Use UTF-8 as the default script encoding?
 * Turning this on will break scripts having non-UTF8 binary
 * data (such as Latin-1) in string literals. */
#ifdef USE_UTF8_SCRIPTS
#    define USE_UTF8_IN_NAMES (!IN_BYTES)
#else
#    define USE_UTF8_IN_NAMES (PL_hints & HINT_UTF8)
#endif

#ifdef EBCDIC
/* The equivalent of these macros but implementing UTF-EBCDIC
   are in the following header file:
 */

#include "utfebcdic.h"
#else
START_EXTERN_C

#ifdef DOINIT
EXTCONST unsigned char PL_utf8skip[] = {
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 */
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 */
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 */
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 */
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 */
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 */
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 */
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. */
7,13, /* Perl extended (not UTF-8).  Up to 72bit allowed (64-bit + reserved). */
};
#else
EXTCONST unsigned char PL_utf8skip[];
#endif

END_EXTERN_C
#define UTF8SKIP(s) PL_utf8skip[*(U8*)s]

/* Native character to iso-8859-1 */
#define NATIVE_TO_ASCII(ch)      (ch)
#define ASCII_TO_NATIVE(ch)      (ch)
/* Transform after encoding */
#define NATIVE_TO_UTF(ch)        (ch)
#define UTF_TO_NATIVE(ch)        (ch)
/* Transforms in wide UV chars */
#define UNI_TO_NATIVE(ch)        (ch)
#define NATIVE_TO_UNI(ch)        (ch)
/* Transforms in invariant space */
#define NATIVE_TO_NEED(enc,ch)   (ch)
#define ASCII_TO_NEED(enc,ch)    (ch)

/* As there are no translations avoid the function wrapper */
#define Perl_utf8n_to_uvchr Perl_utf8n_to_uvuni
#define Perl_uvchr_to_utf8  Perl_uvuni_to_utf8

/*

 The following table is from Unicode 3.2.

 Code Points		1st Byte  2nd Byte  3rd Byte  4th Byte

   U+0000..U+007F	00..7F   
   U+0080..U+07FF	C2..DF    80..BF   
   U+0800..U+0FFF	E0        A0..BF    80..BF  
   U+1000..U+CFFF       E1..EC    80..BF    80..BF  
   U+D000..U+D7FF       ED        80..9F    80..BF  
   U+D800..U+DFFF       ******* ill-formed *******
   U+E000..U+FFFF       EE..EF    80..BF    80..BF  
  U+10000..U+3FFFF	F0        90..BF    80..BF    80..BF
  U+40000..U+FFFFF	F1..F3    80..BF    80..BF    80..BF
 U+100000..U+10FFFF	F4        80..8F    80..BF    80..BF

Note the A0..BF in U+0800..U+0FFF, the 80..9F in U+D000...U+D7FF,
the 90..BF in U+10000..U+3FFFF, and the 80...8F in U+100000..U+10FFFF.

 */

/*
 Another way to look at it, as bits:

 Code Points                    1st Byte   2nd Byte  3rd Byte  4th Byte

                    0aaaaaaa     0aaaaaaa
            00000bbbbbaaaaaa     110bbbbb  10aaaaaa
            ccccbbbbbbaaaaaa     1110cccc  10bbbbbb  10aaaaaa
  00000dddccccccbbbbbbaaaaaa     11110ddd  10cccccc  10bbbbbb  10aaaaaa

As you can see, the continuation bytes all begin with C<10>, and the
leading bits of the start byte tell how many bytes the are in the
encoded character.

*/


#define UNI_IS_INVARIANT(c)		(((UV)c) <  0x80)
#define UTF8_IS_INVARIANT(c)		UNI_IS_INVARIANT(NATIVE_TO_UTF(c))
#define NATIVE_IS_INVARIANT(c)		UNI_IS_INVARIANT(NATIVE_TO_ASCII(c))
#define UTF8_IS_START(c)		(((U8)c) >= 0xc0 && (((U8)c) <= 0xfd))
#define UTF8_IS_CONTINUATION(c)		(((U8)c) >= 0x80 && (((U8)c) <= 0xbf))
#define UTF8_IS_CONTINUED(c) 		(((U8)c) &  0x80)
#define UTF8_IS_DOWNGRADEABLE_START(c)	(((U8)c & 0xfc) == 0xc0)

#define UTF_START_MARK(len) ((len >  7) ? 0xFF : (0xFE << (7-len)))
#define UTF_START_MASK(len) ((len >= 7) ? 0x00 : (0x1F >> (len-2)))

#define UTF_CONTINUATION_MARK		0x80
#define UTF_ACCUMULATION_SHIFT		6
#define UTF_CONTINUATION_MASK		((U8)0x3f)
#define UTF8_ACCUMULATE(old, new)	(((old) << UTF_ACCUMULATION_SHIFT) | (((U8)new) & UTF_CONTINUATION_MASK))

#define UTF8_EIGHT_BIT_HI(c)	((((U8)(c))>>UTF_ACCUMULATION_SHIFT)|UTF_START_MARK(2))
#define UTF8_EIGHT_BIT_LO(c)	(((((U8)(c)))&UTF_CONTINUATION_MASK)|UTF_CONTINUATION_MARK)

#ifdef HAS_QUAD
#define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
		      (uv) < 0x800          ? 2 : \
		      (uv) < 0x10000        ? 3 : \
		      (uv) < 0x200000       ? 4 : \
		      (uv) < 0x4000000      ? 5 : \
		      (uv) < 0x80000000     ? 6 : \
                      (uv) < UTF8_QUAD_MAX ? 7 : 13 )
#else
/* No, I'm not even going to *TRY* putting #ifdef inside a #define */
#define UNISKIP(uv) ( (uv) < 0x80           ? 1 : \
		      (uv) < 0x800          ? 2 : \
		      (uv) < 0x10000        ? 3 : \
		      (uv) < 0x200000       ? 4 : \
		      (uv) < 0x4000000      ? 5 : \
		      (uv) < 0x80000000     ? 6 : 7 )
#endif

/*
 * Note: we try to be careful never to call the isXXX_utf8() functions
 * unless we're pretty sure we've seen the beginning of a UTF-8 character
 * (that is, the two high bits are set).  Otherwise we risk loading in the
 * heavy-duty SWASHINIT and SWASHGET routines unnecessarily.
 */
#define isIDFIRST_lazy_if(p,c) ((IN_BYTES || (!c || (*((U8*)p) < 0xc0))) \
				? isIDFIRST(*(p)) \
				: isIDFIRST_utf8((U8*)p))
#define isALNUM_lazy_if(p,c)   ((IN_BYTES || (!c || (*((U8*)p) < 0xc0))) \
				? isALNUM(*(p)) \
				: isALNUM_utf8((U8*)p))


#endif /* EBCDIC vs ASCII */

/* Rest of these are attributes of Unicode and perl's internals rather than the encoding */

#define isIDFIRST_lazy(p)	isIDFIRST_lazy_if(p,1)
#define isALNUM_lazy(p)		isALNUM_lazy_if(p,1)

/* how wide can a single UTF8 encoded character become */
#define UTF8_MAXLEN 13
/* how wide a character can become when upper/lowercased */
#define UTF8_MAXLEN_UCLC_MULT 3
#define UTF8_MAXLEN_UCLC (UTF8_MAXLEN*UTF8_MAXLEN_UCLC_MULT)
/* how wide a character can become when casefolded */
#define UTF8_MAXLEN_FOLD_MULT 3
#define UTF8_MAXLEN_FOLD (UTF8_MAXLEN*UTF8_MAXLEN_FOLD_MULT)

#define IN_BYTES (PL_curcop->op_private & HINT_BYTES)
#define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)

#define UTF8_ALLOW_EMPTY		0x0001
#define UTF8_ALLOW_CONTINUATION		0x0002
#define UTF8_ALLOW_NON_CONTINUATION	0x0004
#define UTF8_ALLOW_FE_FF		0x0008
#define UTF8_ALLOW_SHORT		0x0010
#define UTF8_ALLOW_SURROGATE		0x0020
#define UTF8_ALLOW_BOM			0x0040
#define UTF8_ALLOW_FFFF			0x0080
#define UTF8_ALLOW_LONG			0x0100
#define UTF8_ALLOW_ANYUV		(UTF8_ALLOW_EMPTY|UTF8_ALLOW_FE_FF|\
					 UTF8_ALLOW_SURROGATE|UTF8_ALLOW_BOM|\
					 UTF8_ALLOW_FFFF|UTF8_ALLOW_LONG)
#define UTF8_ALLOW_ANY			0x00ff
#define UTF8_CHECK_ONLY			0x0200

#define UNICODE_SURROGATE_FIRST		0xd800
#define UNICODE_SURROGATE_LAST		0xdfff
#define UNICODE_REPLACEMENT		0xfffd
#define UNICODE_BYTER_ORDER_MARK	0xfffe
#define UNICODE_ILLEGAL			0xffff

/* Though our UTF-8 encoding can go beyond this,
 * let's be conservative. */
#define PERL_UNICODE_MAX	0x10FFFF

#define UNICODE_ALLOW_SURROGATE 0x0001	/* Allow UTF-16 surrogates (EVIL) */
#define UNICODE_ALLOW_FDD0	0x0002	/* Allow the U+FDD0...U+FDEF */
#define UNICODE_ALLOW_FFFE	0x0004	/* Allow 0xFFFE, 0x1FFFE, ... */
#define UNICODE_ALLOW_FFFF	0x0008	/* Allow 0xFFFE, 0x1FFFE, ... */
#define UNICODE_ALLOW_SUPER	0x0010	/* Allow past 10xFFFF */
#define UNICODE_ALLOW_ANY	0xFFFF

#define UNICODE_IS_SURROGATE(c)		((c) >= UNICODE_SURROGATE_FIRST && \
					 (c) <= UNICODE_SURROGATE_LAST)
#define UNICODE_IS_REPLACEMENT(c)	((c) == UNICODE_REPLACEMENT)
#define UNICODE_IS_BYTE_ORDER_MARK(c)	((c) == UNICODE_BYTER_ORDER_MARK)
#define UNICODE_IS_ILLEGAL(c)		((c) == UNICODE_ILLEGAL)

#ifdef HAS_QUAD
#    define UTF8_QUAD_MAX	UINT64_C(0x1000000000)
#endif

#define UTF8_IS_ASCII(c) UTF8_IS_INVARIANT(c)

#define UNICODE_LATIN_SMALL_LETTER_SHARP_S	0x00DF
#define UNICODE_GREEK_CAPITAL_LETTER_SIGMA	0x03A3
#define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA	0x03C2
#define UNICODE_GREEK_SMALL_LETTER_SIGMA	0x03C3

#define EBCDIC_LATIN_SMALL_LETTER_SHARP_S	0x0059

#define UNI_DISPLAY_ISPRINT	0x0001
#define UNI_DISPLAY_BACKSLASH	0x0002
#define UNI_DISPLAY_QQ		(UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
#define UNI_DISPLAY_REGEX	(UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)

#ifdef EBCDIC
#   define ANYOF_FOLD_SHARP_S(node, input, end)	\
	(ANYOF_BITMAP_TEST(node, EBCDIC_LATIN_SMALL_LETTER_SHARP_S) && \
	 (ANYOF_FLAGS(node) & ANYOF_UNICODE) && \
	 (ANYOF_FLAGS(node) & ANYOF_FOLD) && \
	 ((end) > (input) + 1) && \
	 toLOWER((input)[0]) == 's' && \
	 toLOWER((input)[1]) == 's')
#else
#   define ANYOF_FOLD_SHARP_S(node, input, end)	\
	(ANYOF_BITMAP_TEST(node, UNICODE_LATIN_SMALL_LETTER_SHARP_S) && \
	 (ANYOF_FLAGS(node) & ANYOF_UNICODE) && \
	 (ANYOF_FLAGS(node) & ANYOF_FOLD) && \
	 ((end) > (input) + 1) && \
	 toLOWER((input)[0]) == 's' && \
	 toLOWER((input)[1]) == 's')
#endif
#define SHARP_S_SKIP 2
Commit	Line	Data
a0ed51b3 LW	1	/* utf8.h
a0ed51b3 LW	2	*
be3c0a43	3	* Copyright (c) 1998-2002, 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
39e02b42 JH	10	/* Use UTF-8 as the default script encoding?
	11	* Turning this on will break scripts having non-UTF8 binary
	12	* data (such as Latin-1) in string literals. */
	13	#ifdef USE_UTF8_SCRIPTS
	14	# define USE_UTF8_IN_NAMES (!IN_BYTES)
	15	#else
	16	# define USE_UTF8_IN_NAMES (PL_hints & HINT_UTF8)
	17	#endif
	18
1d72bdf6 NIS	19	#ifdef EBCDIC
	20	/* The equivalent of these macros but implementing UTF-EBCDIC
	21	are in the following header file:
	22	*/
	23
	24	#include "utfebcdic.h"
	25	#else
73c4f7a1 GS	26	START_EXTERN_C
73c4f7a1 GS	27
a0ed51b3	28	#ifdef DOINIT
6f06b55f	29	EXTCONST unsigned char PL_utf8skip[] = {
a0ed51b3 LW	30	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 */
	31	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 */
	32	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 */
	33	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 */
	34	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 */
	35	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 */
	36	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 */
3c77ea2b GS	37	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. */
3c77ea2b GS	38	7,13, /* Perl extended (not UTF-8). Up to 72bit allowed (64-bit + reserved). */
a0ed51b3 LW	39	};
a0ed51b3 LW	40	#else
6f06b55f	41	EXTCONST unsigned char PL_utf8skip[];
a0ed51b3 LW	42	#endif
a0ed51b3 LW	43
73c4f7a1	44	END_EXTERN_C
6f06b55f	45	#define UTF8SKIP(s) PL_utf8skip[(U8)s]
7e2040f0	46
1d72bdf6 NIS	47	/* Native character to iso-8859-1 */
	48	#define NATIVE_TO_ASCII(ch) (ch)
	49	#define ASCII_TO_NATIVE(ch) (ch)
	50	/* Transform after encoding */
	51	#define NATIVE_TO_UTF(ch) (ch)
	52	#define UTF_TO_NATIVE(ch) (ch)
	53	/* Transforms in wide UV chars */
	54	#define UNI_TO_NATIVE(ch) (ch)
	55	#define NATIVE_TO_UNI(ch) (ch)
	56	/* Transforms in invariant space */
	57	#define NATIVE_TO_NEED(enc,ch) (ch)
	58	#define ASCII_TO_NEED(enc,ch) (ch)
d7578b48	59
2b9d42f0 NIS	60	/* As there are no translations avoid the function wrapper */
	61	#define Perl_utf8n_to_uvchr Perl_utf8n_to_uvuni
	62	#define Perl_uvchr_to_utf8 Perl_uvuni_to_utf8
	63
877d9f0d	64	/*
9041c2e3	65
8c007b5a	66	The following table is from Unicode 3.2.
877d9f0d JH	67
	68	Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte
	69
	70	U+0000..U+007F 00..7F
	71	U+0080..U+07FF C2..DF 80..BF
	72	U+0800..U+0FFF E0 A0..BF 80..BF
8c007b5a JH	73	U+1000..U+CFFF E1..EC 80..BF 80..BF
	74	U+D000..U+D7FF ED 80..9F 80..BF
	75	U+D800..U+DFFF ***** ill-formed *****
	76	U+E000..U+FFFF EE..EF 80..BF 80..BF
877d9f0d JH	77	U+10000..U+3FFFF F0 90..BF 80..BF 80..BF
	78	U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF
	79	U+100000..U+10FFFF F4 80..8F 80..BF 80..BF
	80
8c007b5a JH	81	Note the A0..BF in U+0800..U+0FFF, the 80..9F in U+D000...U+D7FF,
	82	the 90..BF in U+10000..U+3FFFF, and the 80...8F in U+100000..U+10FFFF.
	83
877d9f0d JH	84	*/
877d9f0d JH	85
8c007b5a JH	86	/*
	87	Another way to look at it, as bits:
	88
	89	Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte
	90
	91	0aaaaaaa 0aaaaaaa
	92	00000bbbbbaaaaaa 110bbbbb 10aaaaaa
	93	ccccbbbbbbaaaaaa 1110cccc 10bbbbbb 10aaaaaa
	94	00000dddccccccbbbbbbaaaaaa 11110ddd 10cccccc 10bbbbbb 10aaaaaa
	95
	96	As you can see, the continuation bytes all begin with C<10>, and the
	97	leading bits of the start byte tell how many bytes the are in the
	98	encoded character.
	99
	100	*/
	101
	102
c4d5f83a NIS	103	#define UNI_IS_INVARIANT(c) (((UV)c) < 0x80)
	104	#define UTF8_IS_INVARIANT(c) UNI_IS_INVARIANT(NATIVE_TO_UTF(c))
	105	#define NATIVE_IS_INVARIANT(c) UNI_IS_INVARIANT(NATIVE_TO_ASCII(c))
c512ce4f JH	106	#define UTF8_IS_START(c) (((U8)c) >= 0xc0 && (((U8)c) <= 0xfd))
	107	#define UTF8_IS_CONTINUATION(c) (((U8)c) >= 0x80 && (((U8)c) <= 0xbf))
	108	#define UTF8_IS_CONTINUED(c) (((U8)c) & 0x80)
db42d148	109	#define UTF8_IS_DOWNGRADEABLE_START(c) (((U8)c & 0xfc) == 0xc0)
8850bf83	110
1d72bdf6 NIS	111	#define UTF_START_MARK(len) ((len > 7) ? 0xFF : (0xFE << (7-len)))
	112	#define UTF_START_MASK(len) ((len >= 7) ? 0x00 : (0x1F >> (len-2)))
	113
	114	#define UTF_CONTINUATION_MARK 0x80
	115	#define UTF_ACCUMULATION_SHIFT 6
	116	#define UTF_CONTINUATION_MASK ((U8)0x3f)
cb359b41	117	#define UTF8_ACCUMULATE(old, new) (((old) << UTF_ACCUMULATION_SHIFT) \| (((U8)new) & UTF_CONTINUATION_MASK))
421a8bf2	118
1d72bdf6 NIS	119	#define UTF8_EIGHT_BIT_HI(c) ((((U8)(c))>>UTF_ACCUMULATION_SHIFT)\|UTF_START_MARK(2))
1d72bdf6 NIS	120	#define UTF8_EIGHT_BIT_LO(c) (((((U8)(c)))&UTF_CONTINUATION_MASK)\|UTF_CONTINUATION_MARK)
c512ce4f	121
1d68d6cd	122	#ifdef HAS_QUAD
5bbb0b5a	123	#define UNISKIP(uv) ( (uv) < 0x80 ? 1 : \
1d68d6cd SC	124	(uv) < 0x800 ? 2 : \
	125	(uv) < 0x10000 ? 3 : \
	126	(uv) < 0x200000 ? 4 : \
	127	(uv) < 0x4000000 ? 5 : \
	128	(uv) < 0x80000000 ? 6 : \
9041c2e3	129	(uv) < UTF8_QUAD_MAX ? 7 : 13 )
1d68d6cd SC	130	#else
1d68d6cd SC	131	/* No, I'm not even going to TRY putting #ifdef inside a #define */
5bbb0b5a	132	#define UNISKIP(uv) ( (uv) < 0x80 ? 1 : \
1d68d6cd SC	133	(uv) < 0x800 ? 2 : \
	134	(uv) < 0x10000 ? 3 : \
	135	(uv) < 0x200000 ? 4 : \
	136	(uv) < 0x4000000 ? 5 : \
	137	(uv) < 0x80000000 ? 6 : 7 )
	138	#endif
	139
7e2040f0 GS	140	/*
	141	* Note: we try to be careful never to call the isXXX_utf8() functions
	142	* unless we're pretty sure we've seen the beginning of a UTF-8 character
	143	* (that is, the two high bits are set). Otherwise we risk loading in the
	144	* heavy-duty SWASHINIT and SWASHGET routines unnecessarily.
	145	*/
0064a8a9	146	#define isIDFIRST_lazy_if(p,c) ((IN_BYTES \|\| (!c \|\| (((U8)p) < 0xc0))) \
7e2040f0 GS	147	? isIDFIRST(*(p)) \
7e2040f0 GS	148	: isIDFIRST_utf8((U8*)p))
0064a8a9	149	#define isALNUM_lazy_if(p,c) ((IN_BYTES \|\| (!c \|\| (((U8)p) < 0xc0))) \
7e2040f0 GS	150	? isALNUM(*(p)) \
7e2040f0 GS	151	: isALNUM_utf8((U8*)p))
1d72bdf6 NIS	152
	153
	154	#endif /* EBCDIC vs ASCII */
	155
	156	/* Rest of these are attributes of Unicode and perl's internals rather than the encoding */
	157
7e2040f0 GS	158	#define isIDFIRST_lazy(p) isIDFIRST_lazy_if(p,1)
7e2040f0 GS	159	#define isALNUM_lazy(p) isALNUM_lazy_if(p,1)
3bd709b1	160
e7ae6809 JH	161	/* how wide can a single UTF8 encoded character become */
	162	#define UTF8_MAXLEN 13
	163	/* how wide a character can become when upper/lowercased */
3ec562b0 JH	164	#define UTF8_MAXLEN_UCLC_MULT 3
3ec562b0 JH	165	#define UTF8_MAXLEN_UCLC (UTF8_MAXLEN*UTF8_MAXLEN_UCLC_MULT)
e7ae6809	166	/* how wide a character can become when casefolded */
3ec562b0 JH	167	#define UTF8_MAXLEN_FOLD_MULT 3
3ec562b0 JH	168	#define UTF8_MAXLEN_FOLD (UTF8_MAXLEN*UTF8_MAXLEN_FOLD_MULT)
3bd709b1	169
0064a8a9 JH	170	#define IN_BYTES (PL_curcop->op_private & HINT_BYTES)
0064a8a9 JH	171	#define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
1d72bdf6 NIS	172
	173	#define UTF8_ALLOW_EMPTY 0x0001
	174	#define UTF8_ALLOW_CONTINUATION 0x0002
	175	#define UTF8_ALLOW_NON_CONTINUATION 0x0004
	176	#define UTF8_ALLOW_FE_FF 0x0008
	177	#define UTF8_ALLOW_SHORT 0x0010
	178	#define UTF8_ALLOW_SURROGATE 0x0020
	179	#define UTF8_ALLOW_BOM 0x0040
	180	#define UTF8_ALLOW_FFFF 0x0080
	181	#define UTF8_ALLOW_LONG 0x0100
	182	#define UTF8_ALLOW_ANYUV (UTF8_ALLOW_EMPTY\|UTF8_ALLOW_FE_FF\|\
	183	UTF8_ALLOW_SURROGATE\|UTF8_ALLOW_BOM\|\
	184	UTF8_ALLOW_FFFF\|UTF8_ALLOW_LONG)
	185	#define UTF8_ALLOW_ANY 0x00ff
e83d50c9	186	#define UTF8_CHECK_ONLY 0x0200
1d72bdf6 NIS	187
	188	#define UNICODE_SURROGATE_FIRST 0xd800
	189	#define UNICODE_SURROGATE_LAST 0xdfff
	190	#define UNICODE_REPLACEMENT 0xfffd
	191	#define UNICODE_BYTER_ORDER_MARK 0xfffe
	192	#define UNICODE_ILLEGAL 0xffff
	193
b851fbc1 JH	194	/* Though our UTF-8 encoding can go beyond this,
	195	* let's be conservative. */
	196	#define PERL_UNICODE_MAX 0x10FFFF
	197
	198	#define UNICODE_ALLOW_SURROGATE 0x0001 /* Allow UTF-16 surrogates (EVIL) */
	199	#define UNICODE_ALLOW_FDD0 0x0002 /* Allow the U+FDD0...U+FDEF */
	200	#define UNICODE_ALLOW_FFFE 0x0004 /* Allow 0xFFFE, 0x1FFFE, ... */
	201	#define UNICODE_ALLOW_FFFF 0x0008 /* Allow 0xFFFE, 0x1FFFE, ... */
	202	#define UNICODE_ALLOW_SUPER 0x0010 /* Allow past 10xFFFF */
	203	#define UNICODE_ALLOW_ANY 0xFFFF
	204
1d72bdf6 NIS	205	#define UNICODE_IS_SURROGATE(c) ((c) >= UNICODE_SURROGATE_FIRST && \
1d72bdf6 NIS	206	(c) <= UNICODE_SURROGATE_LAST)
a10ec373	207	#define UNICODE_IS_REPLACEMENT(c) ((c) == UNICODE_REPLACEMENT)
1d72bdf6 NIS	208	#define UNICODE_IS_BYTE_ORDER_MARK(c) ((c) == UNICODE_BYTER_ORDER_MARK)
	209	#define UNICODE_IS_ILLEGAL(c) ((c) == UNICODE_ILLEGAL)
	210
f067b878 NA	211	#ifdef HAS_QUAD
	212	# define UTF8_QUAD_MAX UINT64_C(0x1000000000)
	213	#endif
3bd709b1	214
1d72bdf6	215	#define UTF8_IS_ASCII(c) UTF8_IS_INVARIANT(c)
09091399	216
e0f9d4a8	217	#define UNICODE_LATIN_SMALL_LETTER_SHARP_S 0x00DF
09091399 JH	218	#define UNICODE_GREEK_CAPITAL_LETTER_SIGMA 0x03A3
	219	#define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA 0x03C2
	220	#define UNICODE_GREEK_SMALL_LETTER_SIGMA 0x03C3
	221
ebc501f0 JH	222	#define EBCDIC_LATIN_SMALL_LETTER_SHARP_S 0x0059
ebc501f0 JH	223
9e55ce06	224	#define UNI_DISPLAY_ISPRINT 0x0001
c728cb41 JH	225	#define UNI_DISPLAY_BACKSLASH 0x0002
	226	#define UNI_DISPLAY_QQ (UNI_DISPLAY_ISPRINT\|UNI_DISPLAY_BACKSLASH)
	227	#define UNI_DISPLAY_REGEX (UNI_DISPLAY_ISPRINT\|UNI_DISPLAY_BACKSLASH)
9e55ce06	228
ebc501f0 JH	229	#ifdef EBCDIC
	230	# define ANYOF_FOLD_SHARP_S(node, input, end) \
	231	(ANYOF_BITMAP_TEST(node, EBCDIC_LATIN_SMALL_LETTER_SHARP_S) && \
	232	(ANYOF_FLAGS(node) & ANYOF_UNICODE) && \
	233	(ANYOF_FLAGS(node) & ANYOF_FOLD) && \
	234	((end) > (input) + 1) && \
	235	toLOWER((input)[0]) == 's' && \
	236	toLOWER((input)[1]) == 's')
	237	#else
	238	# define ANYOF_FOLD_SHARP_S(node, input, end) \
07b6858f JH	239	(ANYOF_BITMAP_TEST(node, UNICODE_LATIN_SMALL_LETTER_SHARP_S) && \
	240	(ANYOF_FLAGS(node) & ANYOF_UNICODE) && \
	241	(ANYOF_FLAGS(node) & ANYOF_FOLD) && \
	242	((end) > (input) + 1) && \
	243	toLOWER((input)[0]) == 's' && \
	244	toLOWER((input)[1]) == 's')
ebc501f0 JH	245	#endif
ebc501f0 JH	246	#define SHARP_S_SKIP 2