X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/4c8cd60559ce65964c5e42f43021ce23dc89819e..5b48e25f83f62f48ea280c49b00302e063384348:/utf8.h?ds=sidebyside diff --git a/utf8.h b/utf8.h index 464cf09..c954b42 100644 --- a/utf8.h +++ b/utf8.h @@ -134,10 +134,20 @@ EXTCONST unsigned char PL_utf8skip[]; END_EXTERN_C +#if defined(_MSC_VER) && _MSC_VER < 1400 +/* older MSVC versions have a smallish macro buffer */ +#define PERL_SMALL_MACRO_BUFFER +#endif + /* Native character to/from iso-8859-1. Are the identity functions on ASCII * platforms */ +#ifdef PERL_SMALL_MACRO_BUFFER +#define NATIVE_TO_LATIN1(ch) ((U8)(ch)) +#define LATIN1_TO_NATIVE(ch) ((U8)(ch)) +#else #define NATIVE_TO_LATIN1(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch))) #define LATIN1_TO_NATIVE(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch))) +#endif /* I8 is an intermediate version of UTF-8 used only in UTF-EBCDIC. We thus * consider it to be identical to UTF-8 on ASCII platforms. Strictly speaking @@ -145,8 +155,13 @@ END_EXTERN_C * because they are 8-bit encodings that serve the same purpose in Perl, and * rarely do we need to distinguish them. The term "NATIVE_UTF8" applies to * whichever one is applicable on the current platform */ +#ifdef PERL_SMALL_MACRO_BUFFER +#define NATIVE_UTF8_TO_I8(ch) (ch) +#define I8_TO_NATIVE_UTF8(ch) (ch) +#else #define NATIVE_UTF8_TO_I8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch))) #define I8_TO_NATIVE_UTF8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch))) +#endif /* Transforms in wide UV chars */ #define UNI_TO_NATIVE(ch) ((UV) (ch)) @@ -208,32 +223,41 @@ Perl's extended UTF-8 means we can have start bytes up to FF. * */ #define UVCHR_IS_INVARIANT(cp) OFFUNI_IS_INVARIANT(cp) +/* This defines the bits that are to be in the continuation bytes of a multi-byte + * UTF-8 encoded character that mark it is a continuation byte. */ +#define UTF_CONTINUATION_MARK 0x80 + /* Misleadingly named: is the UTF8-encoded byte 'c' part of a variant sequence - * in UTF-8? This is the inverse of UTF8_IS_INVARIANT */ -#define UTF8_IS_CONTINUED(c) (((U8)c) & 0x80) + * in UTF-8? This is the inverse of UTF8_IS_INVARIANT. The |0 makes sure this + * isn't mistakenly called with a ptr argument */ +#define UTF8_IS_CONTINUED(c) (((U8)((c) | 0)) & UTF_CONTINUATION_MARK) /* Is the byte 'c' the first byte of a multi-byte UTF8-8 encoded sequence? * This doesn't catch invariants (they are single-byte). It also excludes the - * illegal overlong sequences that begin with C0 and C1. */ -#define UTF8_IS_START(c) (((U8)c) >= 0xc2) + * illegal overlong sequences that begin with C0 and C1. The |0 makes sure + * this isn't mistakenly called with a ptr argument */ +#define UTF8_IS_START(c) (((U8)((c) | 0)) >= 0xc2) + +/* For use in UTF8_IS_CONTINUATION() below */ +#define UTF_IS_CONTINUATION_MASK 0xC0 /* Is the byte 'c' part of a multi-byte UTF8-8 encoded sequence, and not the - * first byte thereof? */ -#define UTF8_IS_CONTINUATION(c) ((((U8)c) & 0xC0) == 0x80) + * first byte thereof? The |0 makes sure this isn't mistakenly called with a + * ptr argument */ +#define UTF8_IS_CONTINUATION(c) \ + ((((U8)((c) | 0)) & UTF_IS_CONTINUATION_MASK) == UTF_CONTINUATION_MARK) /* Is the UTF8-encoded byte 'c' the first byte of a two byte sequence? Use * UTF8_IS_NEXT_CHAR_DOWNGRADEABLE() instead if the input isn't known to * be well-formed. Masking with 0xfe allows the low bit to be 0 or 1; thus - * this matches 0xc[23]. */ -#define UTF8_IS_DOWNGRADEABLE_START(c) (((U8)(c) & 0xfe) == 0xc2) + * this matches 0xc[23]. The |0 makes sure this isn't mistakenly called with a + * ptr argument */ +#define UTF8_IS_DOWNGRADEABLE_START(c) ((((U8)((c) | 0)) & 0xfe) == 0xc2) /* Is the UTF8-encoded byte 'c' the first byte of a sequence of bytes that - * represent a code point > 255? */ -#define UTF8_IS_ABOVE_LATIN1(c) ((U8)(c) >= 0xc4) - -/* This defines the bits that are to be in the continuation bytes of a multi-byte - * UTF-8 encoded character that indicate it is a continuation byte. */ -#define UTF_CONTINUATION_MARK 0x80 + * represent a code point > 255? The |0 makes sure this isn't mistakenly + * called with a ptr argument */ +#define UTF8_IS_ABOVE_LATIN1(c) (((U8)((c) | 0)) >= 0xc4) /* This is the number of low-order bits a continuation byte in a UTF-8 encoded * sequence contributes to the specification of the code point. In the bit @@ -241,32 +265,67 @@ Perl's extended UTF-8 means we can have start bytes up to FF. * real information */ #define UTF_ACCUMULATION_SHIFT 6 -#if UVSIZE >= 8 -# define UTF8_QUAD_MAX UINT64_C(0x1000000000) +/* ^? is defined to be DEL on ASCII systems. See the definition of toCTRL() + * for more */ +#define QUESTION_MARK_CTRL DEL_NATIVE -/* Input is a true Unicode (not-native) code point */ -#define OFFUNISKIP(uv) ( (uv) < 0x80 ? 1 : \ - (uv) < 0x800 ? 2 : \ - (uv) < 0x10000 ? 3 : \ - (uv) < 0x200000 ? 4 : \ - (uv) < 0x4000000 ? 5 : \ - (uv) < 0x80000000 ? 6 : \ - (uv) < UTF8_QUAD_MAX ? 7 : UTF8_MAXBYTES ) +/* Surrogates, non-character code points and above-Unicode code points are + * problematic in some contexts. This allows code that needs to check for + * those to to quickly exclude the vast majority of code points it will + * encounter */ +#define isUTF8_POSSIBLY_PROBLEMATIC(c) ((U8) c >= 0xED) + +#endif /* EBCDIC vs ASCII */ + +/* 2**UTF_ACCUMULATION_SHIFT - 1 */ +#define UTF_CONTINUATION_MASK ((U8) ((1U << UTF_ACCUMULATION_SHIFT) - 1)) + +/* Internal macro to be used only in this file to aid in constructing other + * publicly accessible macros. + * The number of bytes required to express this uv in UTF-8, for just those + * uv's requiring 2 through 6 bytes, as these are common to all platforms and + * word sizes. The number of bytes needed is given by the number of leading 1 + * bits in the start byte. There are 32 start bytes that have 2 initial 1 bits + * (C0-DF); there are 16 that have 3 initial 1 bits (E0-EF); 8 that have 4 + * initial 1 bits (F0-F8); 4 that have 5 initial 1 bits (F9-FB), and 2 that + * have 6 initial 1 bits (FC-FD). The largest number a string of n bytes can + * represent is (the number of possible start bytes for 'n') + * * (the number of possiblities for each start byte + * The latter in turn is + * 2 ** ( (how many continuation bytes there are) + * * (the number of bits of information each + * continuation byte holds)) + * + * If we were on a platform where we could use a fast find first set bit + * instruction (or count leading zeros instruction) this could be replaced by + * using that to find the log2 of the uv, and divide that by the number of bits + * of information in each continuation byte, adjusting for large cases and how + * much information is in a start byte for that length */ +#define __COMMON_UNI_SKIP(uv) \ + (UV) (uv) < (32 * (1U << ( UTF_ACCUMULATION_SHIFT))) ? 2 : \ + (UV) (uv) < (16 * (1U << (2 * UTF_ACCUMULATION_SHIFT))) ? 3 : \ + (UV) (uv) < ( 8 * (1U << (3 * UTF_ACCUMULATION_SHIFT))) ? 4 : \ + (UV) (uv) < ( 4 * (1U << (4 * UTF_ACCUMULATION_SHIFT))) ? 5 : \ + (UV) (uv) < ( 2 * (1U << (5 * UTF_ACCUMULATION_SHIFT))) ? 6 : + +/* Internal macro to be used only in this file. + * This adds to __COMMON_UNI_SKIP the details at this platform's upper range. + * For any-sized EBCDIC platforms, or 64-bit ASCII ones, we need one more test + * to see if just 7 bytes is needed, or if the maximum is needed. For 32-bit + * ASCII platforms, everything is representable by 7 bytes */ +#if defined(UV_IS_QUAD) || defined(EBCDIC) +# define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) \ + (UV) (uv) < ((UV) 1U << (6 * UTF_ACCUMULATION_SHIFT)) ? 7 : UTF8_MAXBYTES) #else -/* No, I'm not even going to *TRY* putting #ifdef inside a #define */ -#define OFFUNISKIP(uv) ( (uv) < 0x80 ? 1 : \ - (uv) < 0x800 ? 2 : \ - (uv) < 0x10000 ? 3 : \ - (uv) < 0x200000 ? 4 : \ - (uv) < 0x4000000 ? 5 : \ - (uv) < 0x80000000 ? 6 : 7 ) +# define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) 7) #endif -/* ^? is defined to be DEL on ASCII systems. See the definition of toCTRL() - * for more */ -#define QUESTION_MARK_CTRL DEL_NATIVE +/* The next two macros use the base macro defined above, and add in the tests + * at the low-end of the range, for just 1 byte, yielding complete macros, + * publicly accessible. */ -#define MAX_UTF8_TWO_BYTE 0x7FF +/* Input is a true Unicode (not-native) code point */ +#define OFFUNISKIP(uv) (OFFUNI_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv)) /* @@ -277,18 +336,14 @@ encoded as UTF-8. C is a native (ASCII or EBCDIC) code point if less than =cut */ -#define UVCHR_SKIP(uv) OFFUNISKIP(uv) - -/* Surrogates, non-character code points and above-Unicode code points are - * problematic in some contexts. This allows code that needs to check for - * those to to quickly exclude the vast majority of code points it will - * encounter */ -#define isUTF8_POSSIBLY_PROBLEMATIC(c) ((U8) c >= 0xED) +#define UVCHR_SKIP(uv) ( UVCHR_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv)) -#endif /* EBCDIC vs ASCII */ +/* As explained in the comments for __COMMON_UNI_SKIP, 32 start bytes with + * UTF_ACCUMULATION_SHIFT bits of information each */ +#define MAX_UTF8_TWO_BYTE (32 * (1U << UTF_ACCUMULATION_SHIFT) - 1) -/* 2**UTF_ACCUMULATION_SHIFT - 1 */ -#define UTF_CONTINUATION_MASK ((U8) ((1U << UTF_ACCUMULATION_SHIFT) - 1)) +/* constrained by EBCDIC which has 5 bits per continuation byte */ +#define MAX_PORTABLE_UTF8_TWO_BYTE (32 * (1U << 5) - 1) /* The maximum number of UTF-8 bytes a single Unicode character can * uppercase/lowercase/fold into. Unicode guarantees that the maximum @@ -321,8 +376,9 @@ encoded as UTF-8. C is a native (ASCII or EBCDIC) code point if less than #define NATIVE8_TO_UNI(ch) NATIVE_TO_LATIN1(ch) /* This defines the 1-bits that are to be in the first byte of a multi-byte - * UTF-8 encoded character that give the number of bytes that comprise the - * character. 'len' is the number of bytes in the multi-byte sequence. */ + * UTF-8 encoded character that mark it as a start byte and give the number of + * bytes that comprise the character. 'len' is the number of bytes in the + * multi-byte sequence. */ #define UTF_START_MARK(len) (((len) > 7) ? 0xFF : (0xFF & (0xFE << (7-(len))))) /* Masks out the initial one bits in a start byte, leaving the real data ones. @@ -385,7 +441,7 @@ encoded as UTF-8. C is a native (ASCII or EBCDIC) code point if less than * Note that the result can be larger than 255 if the input character is not * downgradable */ #define TWO_BYTE_UTF8_TO_NATIVE(HI, LO) \ - ( __ASSERT_(UTF8SKIP(HI) == 2) \ + ( __ASSERT_(PL_utf8skip[HI] == 2) \ __ASSERT_(UTF8_IS_CONTINUATION(LO)) \ UNI_TO_NATIVE(UTF8_ACCUMULATE((NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), \ (LO)))) @@ -413,15 +469,14 @@ only) byte is pointed to by C. * each for the exact same set of bit patterns. It is valid on a subset of * what UVCHR_IS_INVARIANT is valid on, so can just use that; and the compiler * should optimize out anything extraneous given the implementation of the - * latter */ -#define UTF8_IS_INVARIANT(c) UVCHR_IS_INVARIANT(c) + * latter. The |0 makes sure this isn't mistakenly called with a ptr argument. + * */ +#define UTF8_IS_INVARIANT(c) UVCHR_IS_INVARIANT((c) | 0) /* Like the above, but its name implies a non-UTF8 input, which as the comments * above show, doesn't matter as to its implementation */ #define NATIVE_BYTE_IS_INVARIANT(c) UVCHR_IS_INVARIANT(c) -#define MAX_PORTABLE_UTF8_TWO_BYTE 0x3FF /* constrained by EBCDIC */ - /* The macros in the next 4 sets are used to generate the two utf8 or utfebcdic * bytes from an ordinal that is known to fit into exactly two (not one) bytes; * it must be less than 0x3FF to work across both encodings. */ @@ -431,11 +486,13 @@ only) byte is pointed to by C. * (which works for code points up through 0xFF) or NATIVE_TO_UNI which works * for any code point */ #define __BASE_TWO_BYTE_HI(c, translate_function) \ + (__ASSERT_(! UVCHR_IS_INVARIANT(c)) \ I8_TO_NATIVE_UTF8((translate_function(c) >> UTF_ACCUMULATION_SHIFT) \ - | UTF_START_MARK(2)) + | UTF_START_MARK(2))) #define __BASE_TWO_BYTE_LO(c, translate_function) \ + (__ASSERT_(! UVCHR_IS_INVARIANT(c)) \ I8_TO_NATIVE_UTF8((translate_function(c) & UTF_CONTINUATION_MASK) \ - | UTF_CONTINUATION_MARK) + | UTF_CONTINUATION_MARK)) /* The next two macros should not be used. They were designed to be usable as * the case label of a switch statement, but this doesn't work for EBCDIC. Use @@ -476,11 +533,11 @@ only) byte is pointed to by C. * beginning of a utf8 character. Now that foo_utf8() determines that itself, * no need to do it again here */ -#define isIDFIRST_lazy_if(p,UTF) ((IN_BYTES || !UTF ) \ - ? isIDFIRST(*(p)) \ +#define isIDFIRST_lazy_if(p,UTF) ((IN_BYTES || !UTF) \ + ? isIDFIRST(*(p)) \ : isIDFIRST_utf8((const U8*)p)) -#define isWORDCHAR_lazy_if(p,UTF) ((IN_BYTES || (!UTF )) \ - ? isWORDCHAR(*(p)) \ +#define isWORDCHAR_lazy_if(p,UTF) ((IN_BYTES || (!UTF)) \ + ? isWORDCHAR(*(p)) \ : isWORDCHAR_utf8((const U8*)p)) #define isALNUM_lazy_if(p,UTF) isWORDCHAR_lazy_if(p,UTF) @@ -629,18 +686,30 @@ case any call to string overloading updates the internal UTF-8 encoding flag. #define UNICODE_ALLOW_SUPER 0 #define UNICODE_ALLOW_ANY 0 -#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_NONCHAR(c) ((c >= 0xFDD0 && c <= 0xFDEF) \ - /* The other noncharacters end in FFFE or FFFF, which \ - * the mask below catches both of, but beyond the last \ - * official unicode code point, they aren't \ - * noncharacters, since those aren't Unicode \ - * characters at all */ \ - || ((((c & 0xFFFE) == 0xFFFE)) && ! UNICODE_IS_SUPER(c))) -#define UNICODE_IS_SUPER(c) ((c) > PERL_UNICODE_MAX) +/* This matches the 2048 code points between UNICODE_SURROGATE_FIRST (0xD800) and + * UNICODE_SURROGATE_LAST (0xDFFF) */ +#define UNICODE_IS_SURROGATE(uv) (((UV) (uv) & (~0xFFFF | 0xF800)) \ + == 0xD800) + +#define UNICODE_IS_REPLACEMENT(uv) ((UV) (uv) == UNICODE_REPLACEMENT) +#define UNICODE_IS_BYTE_ORDER_MARK(uv) ((UV) (uv) == UNICODE_BYTE_ORDER_MARK) + +/* Is 'uv' one of the 32 contiguous-range noncharacters? */ +#define UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv) ((UV) (uv) >= 0xFDD0 \ + && (UV) (uv) <= 0xFDEF) + +/* Is 'uv' one of the 34 plane-ending noncharacters 0xFFFE, 0xFFFF, 0x1FFFE, + * 0x1FFFF, ... 0x10FFFE, 0x10FFFF, given that we know that 'uv' is not above + * the Unicode legal max */ +#define UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv) \ + (((UV) (uv) & 0xFFFE) == 0xFFFE) + +#define UNICODE_IS_NONCHAR(uv) \ + ( UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv) \ + || ( LIKELY( ! UNICODE_IS_SUPER(uv)) \ + && UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv))) + +#define UNICODE_IS_SUPER(uv) ((UV) (uv) > PERL_UNICODE_MAX) #define UNICODE_IS_ABOVE_31_BIT(uv) ((UV) (uv) > 0x7FFFFFFF) #define LATIN_SMALL_LETTER_SHARP_S LATIN_SMALL_LETTER_SHARP_S_NATIVE