[perl5.git] / utf8.h

/*    utf8.h
 *
 *    Copyright (C) 2000, 2001, 2002, 2005, 2006, 2007, 2009 by Larry Wall and others
 *
 *    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-UTF-8 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

/* Source backward compatibility. */
#define uvuni_to_utf8(d, uv)		uvuni_to_utf8_flags(d, uv, 0)
#define is_utf8_string_loc(s, len, ep)	is_utf8_string_loclen(s, len, ep, 0)

/*
=for apidoc ibcmp_utf8

This is a synonym for (! foldEQ_utf8())

=cut
*/
#define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
		    cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2))

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

#include "utfebcdic.h"

#else	/* ! EBCDIC */
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

/* 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 utf8n_to_uvchr utf8n_to_uvuni
#define uvchr_to_utf8  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       +++++++ utf16 surrogates, not legal utf8 +++++++
   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 gaps before several of the byte entries above marked by '*'.  These are
caused by legal UTF-8 avoiding non-shortest encodings: it is technically
possible to UTF-8-encode a single code point in different ways, but that is
explicitly forbidden, and the shortest possible encoding should always be used
(and that is what Perl does).

 */

/*
 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 there are in the
encoded character.

Perl's extended UTF-8 means we can have start bytes up to FF.

*/


#define UNI_IS_INVARIANT(c)		(((UV)c) <  0x80)
/* Note that C0 and C1 are invalid in legal UTF8, so the lower bound of the
 * below might ought to be C2 */
#define UTF8_IS_START(c)		(((U8)c) >= 0xc0)
#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)

#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

#endif /* EBCDIC vs ASCII */

/* Rest of these are attributes of Unicode and perl's internals rather than the
 * encoding, or happen to be the same in both ASCII and EBCDIC (at least at
 * this level; the macros that some of these call may have different
 * definitions in the two encodings */

#define NATIVE8_TO_UNI(ch)     NATIVE_TO_ASCII(ch)	/* a clearer synonym */

#define UTF8_ACCUMULATE(old, new)	(((old) << UTF_ACCUMULATION_SHIFT) | (((U8)new) & UTF_CONTINUATION_MASK))

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

#define UTF8_IS_INVARIANT(c)		UNI_IS_INVARIANT(NATIVE_TO_UTF(c))
#define NATIVE_IS_INVARIANT(c)		UNI_IS_INVARIANT(NATIVE8_TO_UNI(c))

#define MAX_PORTABLE_UTF8_TWO_BYTE 0x3FF    /* constrained by EBCDIC */

/* The macros in the next sets are used to generate the two utf8 or utfebcdic
 * bytes from an ordinal that is known to fit into two bytes; it must be less
 * than 0x3FF to work across both encodings. */
/* Nocast allows these to be used in the case label of a switch statement */
#define UTF8_TWO_BYTE_HI_nocast(c)	UTF_TO_NATIVE(((c)>>UTF_ACCUMULATION_SHIFT)|UTF_START_MARK(2))
#define UTF8_TWO_BYTE_LO_nocast(c)	UTF_TO_NATIVE(((c)&UTF_CONTINUATION_MASK)|UTF_CONTINUATION_MARK)

#define UTF8_TWO_BYTE_HI(c)	((U8) (UTF8_TWO_BYTE_HI_nocast(c)))
#define UTF8_TWO_BYTE_LO(c)	((U8) (UTF8_TWO_BYTE_LO_nocast(c)))

/* This name is used when the source is a single byte */
#define UTF8_EIGHT_BIT_HI(c)	UTF8_TWO_BYTE_HI((U8)(c))
#define UTF8_EIGHT_BIT_LO(c)	UTF8_TWO_BYTE_LO((U8)(c))

/*
 * 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 or UTFEBCDIC
 * character.  Otherwise we risk loading in the heavy-duty swash_init and
 * swash_fetch routines unnecessarily.
 */
#define isIDFIRST_lazy_if(p,c) ((IN_BYTES || (!c || ! UTF8_IS_START(*((const U8*)p)))) \
				? isIDFIRST(*(p)) \
				: isIDFIRST_utf8((const U8*)p))
#define isALNUM_lazy_if(p,c)   ((IN_BYTES || (!c || ! UTF8_IS_START(*((const U8*)p)))) \
				? isALNUM(*(p)) \
				: isALNUM_utf8((const U8*)p))

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

#define UTF8_MAXBYTES 13
/* How wide can a single UTF-8 encoded character become in bytes.
 * NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8
 * since UTF-8 is an encoding of Unicode and given Unicode's current
 * upper limit only four bytes is possible.  Perl thinks of UTF-8
 * as a way to encode non-negative integers in a binary format. */
#define UTF8_MAXLEN UTF8_MAXBYTES

/* The maximum number of UTF-8 bytes a single Unicode character can
 * uppercase/lowercase/fold into; this number depends on the Unicode
 * version.  An example of maximal expansion is the U+03B0 which
 * uppercases to U+03C5 U+0308 U+0301.  The Unicode databases that
 * tell these things are UnicodeData.txt, CaseFolding.txt, and
 * SpecialCasing.txt. */
#define UTF8_MAXBYTES_CASE	6

#define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES)
#define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
#define IN_UNI_8_BIT ( (CopHINTS_get(PL_curcop) & HINT_UNI_8_BIT) \
			&& ! IN_LOCALE_RUNTIME && ! IN_BYTES)

#define UTF8_ALLOW_EMPTY		0x0001
#define UTF8_ALLOW_CONTINUATION		0x0002
#define UTF8_ALLOW_NON_CONTINUATION	0x0004
#define UTF8_ALLOW_FE_FF		0x0008 /* Allow FE or FF start bytes, \
						  yields above 0x7fffFFFF */
#define UTF8_ALLOW_SHORT		0x0010 /* expecting more bytes */
#define UTF8_ALLOW_SURROGATE		0x0020
#define UTF8_ALLOW_FFFF			0x0040 /* Allow UNICODE_ILLEGAL */
#define UTF8_ALLOW_LONG			0x0080 /* expecting fewer bytes */
#define UTF8_ALLOW_ANYUV		(UTF8_ALLOW_EMPTY|UTF8_ALLOW_FE_FF|\
					 UTF8_ALLOW_SURROGATE|UTF8_ALLOW_FFFF)
#define UTF8_ALLOW_ANY			0x00FF
#define UTF8_CHECK_ONLY			0x0200
#define UTF8_ALLOW_DEFAULT		(ckWARN(WARN_UTF8) ? 0 : \
					 UTF8_ALLOW_ANYUV)

#define UNICODE_SURROGATE_FIRST		0xD800
#define UNICODE_SURROGATE_LAST		0xDFFF
#define UNICODE_REPLACEMENT		0xFFFD
#define UNICODE_BYTE_ORDER_MARK		0xFEFF
#define UNICODE_ILLEGAL			0xFFFF

/* Though our UTF-8 encoding can go beyond this,
 * let's be conservative and do as Unicode 5.1 says. */
#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_FFFF	0x0004	/* Allow U+FFF[EF], U+1FFF[EF], ... */
#define UNICODE_ALLOW_SUPER	0x0008	/* Allow past 0x10FFFF */
#define UNICODE_ALLOW_ANY	0x000F

#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_BYTE_ORDER_MARK)
#define UNICODE_IS_ILLEGAL(c)		((c) == UNICODE_ILLEGAL)

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

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

#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)

#ifndef EBCDIC
#   define LATIN_SMALL_LETTER_SHARP_S	0x00DF
#   define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS 0x00FF
#   define MICRO_SIGN 0x00B5
#endif

#define ANYOF_FOLD_SHARP_S(node, input, end)	\
	(ANYOF_BITMAP_TEST(node, 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')
#define SHARP_S_SKIP 2

#ifdef EBCDIC
/* IS_UTF8_CHAR() is not ported to EBCDIC */
#else
#define IS_UTF8_CHAR_1(p)	\
	((p)[0] <= 0x7F)
#define IS_UTF8_CHAR_2(p)	\
	((p)[0] >= 0xC2 && (p)[0] <= 0xDF && \
	 (p)[1] >= 0x80 && (p)[1] <= 0xBF)
#define IS_UTF8_CHAR_3a(p)	\
	((p)[0] == 0xE0 && \
	 (p)[1] >= 0xA0 && (p)[1] <= 0xBF && \
	 (p)[2] >= 0x80 && (p)[2] <= 0xBF)
#define IS_UTF8_CHAR_3b(p)	\
	((p)[0] >= 0xE1 && (p)[0] <= 0xEC && \
	 (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
	 (p)[2] >= 0x80 && (p)[2] <= 0xBF)
#define IS_UTF8_CHAR_3c(p)	\
	((p)[0] == 0xED && \
	 (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
	 (p)[2] >= 0x80 && (p)[2] <= 0xBF)
/* In IS_UTF8_CHAR_3c(p) one could use
 * (p)[1] >= 0x80 && (p)[1] <= 0x9F
 * if one wanted to exclude surrogates. */
#define IS_UTF8_CHAR_3d(p)	\
	((p)[0] >= 0xEE && (p)[0] <= 0xEF && \
	 (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
	 (p)[2] >= 0x80 && (p)[2] <= 0xBF)
#define IS_UTF8_CHAR_4a(p)	\
	((p)[0] == 0xF0 && \
	 (p)[1] >= 0x90 && (p)[1] <= 0xBF && \
	 (p)[2] >= 0x80 && (p)[2] <= 0xBF && \
	 (p)[3] >= 0x80 && (p)[3] <= 0xBF)
#define IS_UTF8_CHAR_4b(p)	\
	((p)[0] >= 0xF1 && (p)[0] <= 0xF3 && \
	 (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
	 (p)[2] >= 0x80 && (p)[2] <= 0xBF && \
	 (p)[3] >= 0x80 && (p)[3] <= 0xBF)
/* In IS_UTF8_CHAR_4c(p) one could use
 * (p)[0] == 0xF4
 * if one wanted to stop at the Unicode limit U+10FFFF.
 * The 0xF7 allows us to go to 0x1fffff (0x200000 would
 * require five bytes).  Not doing any further code points
 * since that is not needed (and that would not be strict
 * UTF-8, anyway).  The "slow path" in Perl_is_utf8_char()
 * will take care of the "extended UTF-8". */
#define IS_UTF8_CHAR_4c(p)	\
	((p)[0] == 0xF4 && (p)[0] <= 0xF7 && \
	 (p)[1] >= 0x80 && (p)[1] <= 0xBF && \
	 (p)[2] >= 0x80 && (p)[2] <= 0xBF && \
	 (p)[3] >= 0x80 && (p)[3] <= 0xBF)

#define IS_UTF8_CHAR_3(p)	\
	(IS_UTF8_CHAR_3a(p) || \
	 IS_UTF8_CHAR_3b(p) || \
	 IS_UTF8_CHAR_3c(p) || \
	 IS_UTF8_CHAR_3d(p))
#define IS_UTF8_CHAR_4(p)	\
	(IS_UTF8_CHAR_4a(p) || \
	 IS_UTF8_CHAR_4b(p) || \
	 IS_UTF8_CHAR_4c(p))

/* IS_UTF8_CHAR(p) is strictly speaking wrong (not UTF-8) because it
 * (1) allows UTF-8 encoded UTF-16 surrogates
 * (2) it allows code points past U+10FFFF.
 * The Perl_is_utf8_char() full "slow" code will handle the Perl
 * "extended UTF-8". */
#define IS_UTF8_CHAR(p, n)	\
	((n) == 1 ? IS_UTF8_CHAR_1(p) : \
 	 (n) == 2 ? IS_UTF8_CHAR_2(p) : \
	 (n) == 3 ? IS_UTF8_CHAR_3(p) : \
	 (n) == 4 ? IS_UTF8_CHAR_4(p) : 0)

#define IS_UTF8_CHAR_FAST(n) ((n) <= 4)

#endif /* IS_UTF8_CHAR() for UTF-8 */

/*
 * Local variables:
 * c-indentation-style: bsd
 * c-basic-offset: 4
 * indent-tabs-mode: t
 * End:
 *
 * ex: set ts=8 sts=4 sw=4 noet:
 */
Commit	Line	Data
a0ed51b3 LW	1	/* utf8.h
a0ed51b3 LW	2	*
83706693	3	* Copyright (C) 2000, 2001, 2002, 2005, 2006, 2007, 2009 by Larry Wall and others
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	10	/* Use UTF-8 as the default script encoding?
1e54db1a	11	* Turning this on will break scripts having non-UTF-8 binary
39e02b42 JH	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
fd7cb289 RGS	19	/* Source backward compatibility. */
	20	#define uvuni_to_utf8(d, uv) uvuni_to_utf8_flags(d, uv, 0)
	21	#define is_utf8_string_loc(s, len, ep) is_utf8_string_loclen(s, len, ep, 0)
	22
e6226b18 KW	23	/*
	24	=for apidoc ibcmp_utf8
	25
	26	This is a synonym for (! foldEQ_utf8())
	27
	28	=cut
	29	*/
	30	#define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
	31	cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2))
	32
1d72bdf6 NIS	33	#ifdef EBCDIC
	34	/* The equivalent of these macros but implementing UTF-EBCDIC
	35	are in the following header file:
	36	*/
	37
	38	#include "utfebcdic.h"
fd7cb289	39
d06134e5	40	#else /* ! EBCDIC */
73c4f7a1 GS	41	START_EXTERN_C
73c4f7a1 GS	42
a0ed51b3	43	#ifdef DOINIT
6f06b55f	44	EXTCONST unsigned char PL_utf8skip[] = {
a0ed51b3 LW	45	1,1,1,1,1,1,1,1,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 */
	46	1,1,1,1,1,1,1,1,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 */
	47	1,1,1,1,1,1,1,1,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 */
	48	1,1,1,1,1,1,1,1,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 */
	49	1,1,1,1,1,1,1,1,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 */
	50	1,1,1,1,1,1,1,1,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 */
	51	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	52	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	53	7,13, /* Perl extended (not UTF-8). Up to 72bit allowed (64-bit + reserved). */
a0ed51b3 LW	54	};
a0ed51b3 LW	55	#else
6f06b55f	56	EXTCONST unsigned char PL_utf8skip[];
a0ed51b3 LW	57	#endif
a0ed51b3 LW	58
73c4f7a1	59	END_EXTERN_C
7e2040f0	60
1d72bdf6 NIS	61	/* Native character to iso-8859-1 */
	62	#define NATIVE_TO_ASCII(ch) (ch)
	63	#define ASCII_TO_NATIVE(ch) (ch)
	64	/* Transform after encoding */
	65	#define NATIVE_TO_UTF(ch) (ch)
	66	#define UTF_TO_NATIVE(ch) (ch)
	67	/* Transforms in wide UV chars */
	68	#define UNI_TO_NATIVE(ch) (ch)
	69	#define NATIVE_TO_UNI(ch) (ch)
	70	/* Transforms in invariant space */
	71	#define NATIVE_TO_NEED(enc,ch) (ch)
	72	#define ASCII_TO_NEED(enc,ch) (ch)
d7578b48	73
d06134e5	74	/* As there are no translations, avoid the function wrapper */
1754c1a1 NC	75	#define utf8n_to_uvchr utf8n_to_uvuni
1754c1a1 NC	76	#define uvchr_to_utf8 uvuni_to_utf8
2b9d42f0	77
877d9f0d	78	/*
9041c2e3	79
8c007b5a	80	The following table is from Unicode 3.2.
877d9f0d JH	81
	82	Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte
	83
375122d7	84	U+0000..U+007F 00..7F
e1b711da	85	U+0080..U+07FF * C2..DF 80..BF
37e2e78e	86	U+0800..U+0FFF E0 * A0..BF 80..BF
375122d7	87	U+1000..U+CFFF E1..EC 80..BF 80..BF
e1b711da	88	U+D000..U+D7FF ED 80..9F 80..BF
37e2e78e	89	U+D800..U+DFFF +++++++ utf16 surrogates, not legal utf8 +++++++
375122d7	90	U+E000..U+FFFF EE..EF 80..BF 80..BF
37e2e78e	91	U+10000..U+3FFFF F0 * 90..BF 80..BF 80..BF
877d9f0d JH	92	U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF
	93	U+100000..U+10FFFF F4 80..8F 80..BF 80..BF
	94
e1b711da	95	Note the gaps before several of the byte entries above marked by '*'. These are
37e2e78e KW	96	caused by legal UTF-8 avoiding non-shortest encodings: it is technically
	97	possible to UTF-8-encode a single code point in different ways, but that is
	98	explicitly forbidden, and the shortest possible encoding should always be used
	99	(and that is what Perl does).
8c007b5a	100
877d9f0d JH	101	*/
877d9f0d JH	102
8c007b5a JH	103	/*
	104	Another way to look at it, as bits:
	105
	106	Code Points 1st Byte 2nd Byte 3rd Byte 4th Byte
	107
	108	0aaaaaaa 0aaaaaaa
	109	00000bbbbbaaaaaa 110bbbbb 10aaaaaa
	110	ccccbbbbbbaaaaaa 1110cccc 10bbbbbb 10aaaaaa
	111	00000dddccccccbbbbbbaaaaaa 11110ddd 10cccccc 10bbbbbb 10aaaaaa
	112
	113	As you can see, the continuation bytes all begin with C<10>, and the
e1b711da	114	leading bits of the start byte tell how many bytes there are in the
8c007b5a JH	115	encoded character.
8c007b5a JH	116
65ab9279 TC	117	Perl's extended UTF-8 means we can have start bytes up to FF.
65ab9279 TC	118
8c007b5a JH	119	*/
	120
	121
c4d5f83a	122	#define UNI_IS_INVARIANT(c) (((UV)c) < 0x80)
d06134e5 KW	123	/* Note that C0 and C1 are invalid in legal UTF8, so the lower bound of the
d06134e5 KW	124	* below might ought to be C2 */
65ab9279	125	#define UTF8_IS_START(c) (((U8)c) >= 0xc0)
c512ce4f JH	126	#define UTF8_IS_CONTINUATION(c) (((U8)c) >= 0x80 && (((U8)c) <= 0xbf))
c512ce4f JH	127	#define UTF8_IS_CONTINUED(c) (((U8)c) & 0x80)
db42d148	128	#define UTF8_IS_DOWNGRADEABLE_START(c) (((U8)c & 0xfc) == 0xc0)
8850bf83	129
22901f30 RGS	130	#define UTF_START_MARK(len) (((len) > 7) ? 0xFF : (0xFE << (7-(len))))
22901f30 RGS	131	#define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2)))
1d72bdf6 NIS	132
	133	#define UTF_CONTINUATION_MARK 0x80
	134	#define UTF_ACCUMULATION_SHIFT 6
	135	#define UTF_CONTINUATION_MASK ((U8)0x3f)
c512ce4f	136
1d68d6cd	137	#ifdef HAS_QUAD
5bbb0b5a	138	#define UNISKIP(uv) ( (uv) < 0x80 ? 1 : \
1d68d6cd SC	139	(uv) < 0x800 ? 2 : \
	140	(uv) < 0x10000 ? 3 : \
	141	(uv) < 0x200000 ? 4 : \
	142	(uv) < 0x4000000 ? 5 : \
	143	(uv) < 0x80000000 ? 6 : \
9041c2e3	144	(uv) < UTF8_QUAD_MAX ? 7 : 13 )
1d68d6cd SC	145	#else
1d68d6cd SC	146	/* No, I'm not even going to TRY putting #ifdef inside a #define */
5bbb0b5a	147	#define UNISKIP(uv) ( (uv) < 0x80 ? 1 : \
1d68d6cd SC	148	(uv) < 0x800 ? 2 : \
	149	(uv) < 0x10000 ? 3 : \
	150	(uv) < 0x200000 ? 4 : \
	151	(uv) < 0x4000000 ? 5 : \
	152	(uv) < 0x80000000 ? 6 : 7 )
	153	#endif
	154
d06134e5 KW	155	#endif /* EBCDIC vs ASCII */
	156
	157	/* Rest of these are attributes of Unicode and perl's internals rather than the
	158	* encoding, or happen to be the same in both ASCII and EBCDIC (at least at
	159	* this level; the macros that some of these call may have different
	160	* definitions in the two encodings */
	161
	162	#define NATIVE8_TO_UNI(ch) NATIVE_TO_ASCII(ch) /* a clearer synonym */
	163
	164	#define UTF8_ACCUMULATE(old, new) (((old) << UTF_ACCUMULATION_SHIFT) \| (((U8)new) & UTF_CONTINUATION_MASK))
	165
	166	#define UTF8SKIP(s) PL_utf8skip[(const U8)(s)]
	167
	168	#define UTF8_IS_INVARIANT(c) UNI_IS_INVARIANT(NATIVE_TO_UTF(c))
	169	#define NATIVE_IS_INVARIANT(c) UNI_IS_INVARIANT(NATIVE8_TO_UNI(c))
	170
	171	#define MAX_PORTABLE_UTF8_TWO_BYTE 0x3FF /* constrained by EBCDIC */
	172
	173	/* The macros in the next sets are used to generate the two utf8 or utfebcdic
	174	* bytes from an ordinal that is known to fit into two bytes; it must be less
	175	* than 0x3FF to work across both encodings. */
	176	/* Nocast allows these to be used in the case label of a switch statement */
	177	#define UTF8_TWO_BYTE_HI_nocast(c) UTF_TO_NATIVE(((c)>>UTF_ACCUMULATION_SHIFT)\|UTF_START_MARK(2))
	178	#define UTF8_TWO_BYTE_LO_nocast(c) UTF_TO_NATIVE(((c)&UTF_CONTINUATION_MASK)\|UTF_CONTINUATION_MARK)
	179
	180	#define UTF8_TWO_BYTE_HI(c) ((U8) (UTF8_TWO_BYTE_HI_nocast(c)))
	181	#define UTF8_TWO_BYTE_LO(c) ((U8) (UTF8_TWO_BYTE_LO_nocast(c)))
	182
	183	/* This name is used when the source is a single byte */
	184	#define UTF8_EIGHT_BIT_HI(c) UTF8_TWO_BYTE_HI((U8)(c))
	185	#define UTF8_EIGHT_BIT_LO(c) UTF8_TWO_BYTE_LO((U8)(c))
	186
7e2040f0 GS	187	/*
7e2040f0 GS	188	* Note: we try to be careful never to call the isXXX_utf8() functions
d06134e5 KW	189	* unless we're pretty sure we've seen the beginning of a UTF-8 or UTFEBCDIC
	190	* character. Otherwise we risk loading in the heavy-duty swash_init and
	191	* swash_fetch routines unnecessarily.
7e2040f0	192	*/
d06134e5	193	#define isIDFIRST_lazy_if(p,c) ((IN_BYTES \|\| (!c \|\| ! UTF8_IS_START(((const U8)p)))) \
7e2040f0	194	? isIDFIRST(*(p)) \
e1ec3a88	195	: isIDFIRST_utf8((const U8*)p))
d06134e5	196	#define isALNUM_lazy_if(p,c) ((IN_BYTES \|\| (!c \|\| ! UTF8_IS_START(((const U8)p)))) \
7e2040f0	197	? isALNUM(*(p)) \
e1ec3a88	198	: isALNUM_utf8((const U8*)p))
1d72bdf6	199
7e2040f0 GS	200	#define isIDFIRST_lazy(p) isIDFIRST_lazy_if(p,1)
7e2040f0 GS	201	#define isALNUM_lazy(p) isALNUM_lazy_if(p,1)
3bd709b1	202
89ebb4a3 JH	203	#define UTF8_MAXBYTES 13
	204	/* How wide can a single UTF-8 encoded character become in bytes.
	205	* NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8
	206	* since UTF-8 is an encoding of Unicode and given Unicode's current
	207	* upper limit only four bytes is possible. Perl thinks of UTF-8
	208	* as a way to encode non-negative integers in a binary format. */
	209	#define UTF8_MAXLEN UTF8_MAXBYTES
	210
89ebb4a3 JH	211	/* The maximum number of UTF-8 bytes a single Unicode character can
	212	* uppercase/lowercase/fold into; this number depends on the Unicode
	213	* version. An example of maximal expansion is the U+03B0 which
	214	* uppercases to U+03C5 U+0308 U+0301. The Unicode databases that
d06134e5	215	* tell these things are UnicodeData.txt, CaseFolding.txt, and
89ebb4a3 JH	216	* SpecialCasing.txt. */
89ebb4a3 JH	217	#define UTF8_MAXBYTES_CASE 6
3bd709b1	218
a98fe34d	219	#define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES)
0064a8a9	220	#define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
1863b879	221	#define IN_UNI_8_BIT ( (CopHINTS_get(PL_curcop) & HINT_UNI_8_BIT) \
61fc5122	222	&& ! IN_LOCALE_RUNTIME && ! IN_BYTES)
1d72bdf6 NIS	223
	224	#define UTF8_ALLOW_EMPTY 0x0001
	225	#define UTF8_ALLOW_CONTINUATION 0x0002
	226	#define UTF8_ALLOW_NON_CONTINUATION 0x0004
37e2e78e KW	227	#define UTF8_ALLOW_FE_FF 0x0008 /* Allow FE or FF start bytes, \
	228	yields above 0x7fffFFFF */
	229	#define UTF8_ALLOW_SHORT 0x0010 /* expecting more bytes */
1d72bdf6	230	#define UTF8_ALLOW_SURROGATE 0x0020
9f7f3913	231	#define UTF8_ALLOW_FFFF 0x0040 /* Allow UNICODE_ILLEGAL */
37e2e78e	232	#define UTF8_ALLOW_LONG 0x0080 /* expecting fewer bytes */
1d72bdf6	233	#define UTF8_ALLOW_ANYUV (UTF8_ALLOW_EMPTY\|UTF8_ALLOW_FE_FF\|\
61843245	234	UTF8_ALLOW_SURROGATE\|UTF8_ALLOW_FFFF)
c867b360	235	#define UTF8_ALLOW_ANY 0x00FF
e83d50c9	236	#define UTF8_CHECK_ONLY 0x0200
9f7f3913 TS	237	#define UTF8_ALLOW_DEFAULT (ckWARN(WARN_UTF8) ? 0 : \
9f7f3913 TS	238	UTF8_ALLOW_ANYUV)
1d72bdf6	239
c867b360 JH	240	#define UNICODE_SURROGATE_FIRST 0xD800
	241	#define UNICODE_SURROGATE_LAST 0xDFFF
	242	#define UNICODE_REPLACEMENT 0xFFFD
	243	#define UNICODE_BYTE_ORDER_MARK 0xFEFF
	244	#define UNICODE_ILLEGAL 0xFFFF
1d72bdf6	245
b851fbc1	246	/* Though our UTF-8 encoding can go beyond this,
b3ab6785	247	* let's be conservative and do as Unicode 5.1 says. */
b851fbc1 JH	248	#define PERL_UNICODE_MAX 0x10FFFF
	249
	250	#define UNICODE_ALLOW_SURROGATE 0x0001 /* Allow UTF-16 surrogates (EVIL) */
	251	#define UNICODE_ALLOW_FDD0 0x0002 /* Allow the U+FDD0...U+FDEF */
9f7f3913 TS	252	#define UNICODE_ALLOW_FFFF 0x0004 /* Allow U+FFF[EF], U+1FFF[EF], ... */
9f7f3913 TS	253	#define UNICODE_ALLOW_SUPER 0x0008 /* Allow past 0x10FFFF */
c867b360	254	#define UNICODE_ALLOW_ANY 0x000F
b851fbc1	255
1d72bdf6 NIS	256	#define UNICODE_IS_SURROGATE(c) ((c) >= UNICODE_SURROGATE_FIRST && \
1d72bdf6 NIS	257	(c) <= UNICODE_SURROGATE_LAST)
a10ec373	258	#define UNICODE_IS_REPLACEMENT(c) ((c) == UNICODE_REPLACEMENT)
872c91ae	259	#define UNICODE_IS_BYTE_ORDER_MARK(c) ((c) == UNICODE_BYTE_ORDER_MARK)
1d72bdf6 NIS	260	#define UNICODE_IS_ILLEGAL(c) ((c) == UNICODE_ILLEGAL)
1d72bdf6 NIS	261
f067b878 NA	262	#ifdef HAS_QUAD
	263	# define UTF8_QUAD_MAX UINT64_C(0x1000000000)
	264	#endif
3bd709b1	265
09091399 JH	266	#define UNICODE_GREEK_CAPITAL_LETTER_SIGMA 0x03A3
	267	#define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA 0x03C2
	268	#define UNICODE_GREEK_SMALL_LETTER_SIGMA 0x03C3
	269
9e55ce06	270	#define UNI_DISPLAY_ISPRINT 0x0001
c728cb41 JH	271	#define UNI_DISPLAY_BACKSLASH 0x0002
	272	#define UNI_DISPLAY_QQ (UNI_DISPLAY_ISPRINT\|UNI_DISPLAY_BACKSLASH)
	273	#define UNI_DISPLAY_REGEX (UNI_DISPLAY_ISPRINT\|UNI_DISPLAY_BACKSLASH)
9e55ce06	274
5cd46e1f KW	275	#ifndef EBCDIC
	276	# define LATIN_SMALL_LETTER_SHARP_S 0x00DF
	277	# define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS 0x00FF
	278	# define MICRO_SIGN 0x00B5
	279	#endif
	280
	281	#define ANYOF_FOLD_SHARP_S(node, input, end) \
	282	(ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \
07b6858f JH	283	(ANYOF_FLAGS(node) & ANYOF_UNICODE) && \
	284	(ANYOF_FLAGS(node) & ANYOF_FOLD) && \
	285	((end) > (input) + 1) && \
	286	toLOWER((input)[0]) == 's' && \
	287	toLOWER((input)[1]) == 's')
ebc501f0	288	#define SHARP_S_SKIP 2
3b0fc154	289
77263263 TS	290	#ifdef EBCDIC
	291	/* IS_UTF8_CHAR() is not ported to EBCDIC */
	292	#else
3b0fc154 JH	293	#define IS_UTF8_CHAR_1(p) \
	294	((p)[0] <= 0x7F)
	295	#define IS_UTF8_CHAR_2(p) \
	296	((p)[0] >= 0xC2 && (p)[0] <= 0xDF && \
	297	(p)[1] >= 0x80 && (p)[1] <= 0xBF)
	298	#define IS_UTF8_CHAR_3a(p) \
	299	((p)[0] == 0xE0 && \
	300	(p)[1] >= 0xA0 && (p)[1] <= 0xBF && \
	301	(p)[2] >= 0x80 && (p)[2] <= 0xBF)
	302	#define IS_UTF8_CHAR_3b(p) \
	303	((p)[0] >= 0xE1 && (p)[0] <= 0xEC && \
	304	(p)[1] >= 0x80 && (p)[1] <= 0xBF && \
	305	(p)[2] >= 0x80 && (p)[2] <= 0xBF)
	306	#define IS_UTF8_CHAR_3c(p) \
	307	((p)[0] == 0xED && \
	308	(p)[1] >= 0x80 && (p)[1] <= 0xBF && \
	309	(p)[2] >= 0x80 && (p)[2] <= 0xBF)
	310	/* In IS_UTF8_CHAR_3c(p) one could use
	311	* (p)[1] >= 0x80 && (p)[1] <= 0x9F
	312	* if one wanted to exclude surrogates. */
	313	#define IS_UTF8_CHAR_3d(p) \
	314	((p)[0] >= 0xEE && (p)[0] <= 0xEF && \
	315	(p)[1] >= 0x80 && (p)[1] <= 0xBF && \
	316	(p)[2] >= 0x80 && (p)[2] <= 0xBF)
	317	#define IS_UTF8_CHAR_4a(p) \
	318	((p)[0] == 0xF0 && \
	319	(p)[1] >= 0x90 && (p)[1] <= 0xBF && \
	320	(p)[2] >= 0x80 && (p)[2] <= 0xBF && \
	321	(p)[3] >= 0x80 && (p)[3] <= 0xBF)
	322	#define IS_UTF8_CHAR_4b(p) \
	323	((p)[0] >= 0xF1 && (p)[0] <= 0xF3 && \
	324	(p)[1] >= 0x80 && (p)[1] <= 0xBF && \
	325	(p)[2] >= 0x80 && (p)[2] <= 0xBF && \
	326	(p)[3] >= 0x80 && (p)[3] <= 0xBF)
	327	/* In IS_UTF8_CHAR_4c(p) one could use
	328	* (p)[0] == 0xF4
	329	* if one wanted to stop at the Unicode limit U+10FFFF.
	330	* The 0xF7 allows us to go to 0x1fffff (0x200000 would
	331	* require five bytes). Not doing any further code points
	332	* since that is not needed (and that would not be strict
	333	* UTF-8, anyway). The "slow path" in Perl_is_utf8_char()
	334	* will take care of the "extended UTF-8". */
	335	#define IS_UTF8_CHAR_4c(p) \
	336	((p)[0] == 0xF4 && (p)[0] <= 0xF7 && \
	337	(p)[1] >= 0x80 && (p)[1] <= 0xBF && \
	338	(p)[2] >= 0x80 && (p)[2] <= 0xBF && \
	339	(p)[3] >= 0x80 && (p)[3] <= 0xBF)
	340
	341	#define IS_UTF8_CHAR_3(p) \
	342	(IS_UTF8_CHAR_3a(p) \|\| \
	343	IS_UTF8_CHAR_3b(p) \|\| \
	344	IS_UTF8_CHAR_3c(p) \|\| \
	345	IS_UTF8_CHAR_3d(p))
	346	#define IS_UTF8_CHAR_4(p) \
	347	(IS_UTF8_CHAR_4a(p) \|\| \
	348	IS_UTF8_CHAR_4b(p) \|\| \
	349	IS_UTF8_CHAR_4c(p))
	350
	351	/* IS_UTF8_CHAR(p) is strictly speaking wrong (not UTF-8) because it
	352	* (1) allows UTF-8 encoded UTF-16 surrogates
	353	* (2) it allows code points past U+10FFFF.
	354	* The Perl_is_utf8_char() full "slow" code will handle the Perl
	355	* "extended UTF-8". */
	356	#define IS_UTF8_CHAR(p, n) \
357	((n) == 1 ? IS_UTF8_CHAR_1(p) : \
358	(n) == 2 ? IS_UTF8_CHAR_2(p) : \
359	(n) == 3 ? IS_UTF8_CHAR_3(p) : \
360	(n) == 4 ? IS_UTF8_CHAR_4(p) : 0)
361
768c67ee JH	362	#define IS_UTF8_CHAR_FAST(n) ((n) <= 4)
768c67ee JH	363
77263263	364	#endif /* IS_UTF8_CHAR() for UTF-8 */
e9a8c099 MHM	365
	366	/*
	367	* Local variables:
	368	* c-indentation-style: bsd
	369	* c-basic-offset: 4
	370	* indent-tabs-mode: t
	371	* End:
	372	*
	373	* ex: set ts=8 sts=4 sw=4 noet:
	374	*/