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

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

*/


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

#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 UTF8_IS_ASCII(c) UTF8_IS_INVARIANT(c)

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