utf8.h

   1 /*    utf8.h
   2  *
   3  * This file contains definitions for use with the UTF-8 encoding.  It
   4  * actually also works with the variant UTF-8 encoding called UTF-EBCDIC, and
   5  * hides almost all of the differences between these from the caller.  In other
   6  * words, someone should #include this file, and if the code is being compiled
   7  * on an EBCDIC platform, things should mostly just work.
   8  *
   9  *    Copyright (C) 2000, 2001, 2002, 2005, 2006, 2007, 2009,
  10  *    2010, 2011 by Larry Wall and others
  11  *
  12  *    You may distribute under the terms of either the GNU General Public
  13  *    License or the Artistic License, as specified in the README file.
  14  *
  15  */
  16
  17 #ifndef H_UTF8      /* Guard against recursive inclusion */
  18 #define H_UTF8 1
  19
  20 /* Use UTF-8 as the default script encoding?
  21  * Turning this on will break scripts having non-UTF-8 binary
  22  * data (such as Latin-1) in string literals. */
  23 #ifdef USE_UTF8_SCRIPTS
  24 #    define USE_UTF8_IN_NAMES (!IN_BYTES)
  25 #else
  26 #    define USE_UTF8_IN_NAMES (PL_hints & HINT_UTF8)
  27 #endif
  28
  29 #include "regcharclass.h"
  30 #include "unicode_constants.h"
  31
  32 /* For to_utf8_fold_flags, q.v. */
  33 #define FOLD_FLAGS_LOCALE       0x1
  34 #define FOLD_FLAGS_FULL         0x2
  35 #define FOLD_FLAGS_NOMIX_ASCII  0x4
  36
  37 /* For _core_swash_init(), internal core use only */
  38 #define _CORE_SWASH_INIT_USER_DEFINED_PROPERTY 0x1
  39 #define _CORE_SWASH_INIT_RETURN_IF_UNDEF       0x2
  40 #define _CORE_SWASH_INIT_ACCEPT_INVLIST        0x4
  41
  42 /*
  43 =head1 Unicode Support
  44 L<perlguts/Unicode Support> has an introduction to this API.
  45
  46 See also L</Character classification>,
  47 and L</Character case changing>.
  48 Various functions outside this section also work specially with Unicode.
  49 Search for the string "utf8" in this document.
  50
  51 =for apidoc is_ascii_string
  52
  53 This is a misleadingly-named synonym for L</is_utf8_invariant_string>.
  54 On ASCII-ish platforms, the name isn't misleading: the ASCII-range characters
  55 are exactly the UTF-8 invariants.  But EBCDIC machines have more invariants
  56 than just the ASCII characters, so C<is_utf8_invariant_string> is preferred.
  57
  58 =for apidoc is_invariant_string
  59
  60 This is a somewhat misleadingly-named synonym for L</is_utf8_invariant_string>.
  61 C<is_utf8_invariant_string> is preferred, as it indicates under what conditions
  62 the string is invariant.
  63
  64 =cut
  65 */
  66 #define is_ascii_string(s, len)     is_utf8_invariant_string(s, len)
  67 #define is_invariant_string(s, len) is_utf8_invariant_string(s, len)
  68
  69 #define uvchr_to_utf8(a,b)          uvchr_to_utf8_flags(a,b,0)
  70 #define uvchr_to_utf8_flags(d,uv,flags)                                        \
  71                             uvoffuni_to_utf8_flags(d,NATIVE_TO_UNI(uv),flags)
  72 #define utf8_to_uvchr_buf(s, e, lenp)                                          \
  73                      utf8n_to_uvchr(s, (U8*)(e) - (U8*)(s), lenp,              \
  74                                     ckWARN_d(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY)
  75 #define utf8n_to_uvchr(s, len, lenp, flags)                                    \
  76                                 utf8n_to_uvchr_error(s, len, lenp, flags, 0)
  77
  78 #define to_uni_fold(c, p, lenp) _to_uni_fold_flags(c, p, lenp, FOLD_FLAGS_FULL)
  79 #define to_utf8_fold(c, p, lenp) _to_utf8_fold_flags(c, p, lenp, FOLD_FLAGS_FULL)
  80 #define to_utf8_lower(a,b,c) _to_utf8_lower_flags(a,b,c,0)
  81 #define to_utf8_upper(a,b,c) _to_utf8_upper_flags(a,b,c,0)
  82 #define to_utf8_title(a,b,c) _to_utf8_title_flags(a,b,c,0)
  83
  84 #define foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
  85                     foldEQ_utf8_flags(s1, pe1, l1, u1, s2, pe2, l2, u2, 0)
  86 #define FOLDEQ_UTF8_NOMIX_ASCII   (1 << 0)
  87 #define FOLDEQ_LOCALE             (1 << 1)
  88 #define FOLDEQ_S1_ALREADY_FOLDED  (1 << 2)
  89 #define FOLDEQ_S2_ALREADY_FOLDED  (1 << 3)
  90 #define FOLDEQ_S1_FOLDS_SANE      (1 << 4)
  91 #define FOLDEQ_S2_FOLDS_SANE      (1 << 5)
  92
  93 #define ibcmp_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2) \
  94                     cBOOL(! foldEQ_utf8(s1, pe1, l1, u1, s2, pe2, l2, u2))
  95
  96 #ifdef EBCDIC
  97 /* The equivalent of these macros but implementing UTF-EBCDIC
  98    are in the following header file:
  99  */
 100
 101 #include "utfebcdic.h"
 102
 103 #else   /* ! EBCDIC */
 104 START_EXTERN_C
 105
 106 /* How wide can a single UTF-8 encoded character become in bytes. */
 107 /* NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8 since UTF-8
 108  * is an encoding of Unicode, and Unicode's upper limit, 0x10FFFF, can be
 109  * expressed with 4 bytes.  However, Perl thinks of UTF-8 as a way to encode
 110  * non-negative integers in a binary format, even those above Unicode */
 111 #define UTF8_MAXBYTES 13
 112
 113 #ifdef DOINIT
 114 EXTCONST unsigned char PL_utf8skip[] = {
 115 /* 0x00 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
 116 /* 0x10 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
 117 /* 0x20 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
 118 /* 0x30 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
 119 /* 0x40 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
 120 /* 0x50 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
 121 /* 0x60 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
 122 /* 0x70 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* ascii */
 123 /* 0x80 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
 124 /* 0x90 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
 125 /* 0xA0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
 126 /* 0xB0 */ 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1, /* bogus: continuation byte */
 127 /* 0xC0 */ 2,2,                             /* overlong */
 128 /* 0xC2 */     2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0080 to U+03FF */
 129 /* 0xD0 */ 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, /* U+0400 to U+07FF */
 130 /* 0xE0 */ 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3, /* U+0800 to U+FFFF */
 131 /* 0xF0 */ 4,4,4,4,4,4,4,4,5,5,5,5,6,6,     /* above BMP to 2**31 - 1 */
 132            /* Perl extended (never was official UTF-8).  Up to 36 bit */
 133 /* 0xFE */                             7,
 134            /* More extended, Up to 72 bits (64-bit + reserved) */
 135 /* 0xFF */                               UTF8_MAXBYTES
 136 };
 137 #else
 138 EXTCONST unsigned char PL_utf8skip[];
 139 #endif
 140
 141 END_EXTERN_C
 142
 143 #if defined(_MSC_VER) && _MSC_VER < 1400
 144 /* older MSVC versions have a smallish macro buffer */
 145 #define PERL_SMALL_MACRO_BUFFER
 146 #endif
 147
 148 /* Native character to/from iso-8859-1.  Are the identity functions on ASCII
 149  * platforms */
 150 #ifdef PERL_SMALL_MACRO_BUFFER
 151 #define NATIVE_TO_LATIN1(ch)     ((U8)(ch))
 152 #define LATIN1_TO_NATIVE(ch)     ((U8)(ch))
 153 #else
 154 #define NATIVE_TO_LATIN1(ch)     (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
 155 #define LATIN1_TO_NATIVE(ch)     (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
 156 #endif
 157
 158 /* I8 is an intermediate version of UTF-8 used only in UTF-EBCDIC.  We thus
 159  * consider it to be identical to UTF-8 on ASCII platforms.  Strictly speaking
 160  * UTF-8 and UTF-EBCDIC are two different things, but we often conflate them
 161  * because they are 8-bit encodings that serve the same purpose in Perl, and
 162  * rarely do we need to distinguish them.  The term "NATIVE_UTF8" applies to
 163  * whichever one is applicable on the current platform */
 164 #ifdef PERL_SMALL_MACRO_BUFFER
 165 #define NATIVE_UTF8_TO_I8(ch) ((U8) (ch))
 166 #define I8_TO_NATIVE_UTF8(ch) ((U8) (ch))
 167 #else
 168 #define NATIVE_UTF8_TO_I8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
 169 #define I8_TO_NATIVE_UTF8(ch) (__ASSERT_(FITS_IN_8_BITS(ch)) ((U8) (ch)))
 170 #endif
 171
 172 /* Transforms in wide UV chars */
 173 #define UNI_TO_NATIVE(ch)        ((UV) (ch))
 174 #define NATIVE_TO_UNI(ch)        ((UV) (ch))
 175
 176 /*
 177
 178  The following table is from Unicode 3.2, plus the Perl extensions for above
 179  U+10FFFF
 180
 181  Code Points            1st Byte  2nd Byte  3rd    4th     5th     6th       7th   8th-13th
 182
 183    U+0000..U+007F       00..7F
 184    U+0080..U+07FF     * C2..DF    80..BF
 185    U+0800..U+0FFF       E0      * A0..BF  80..BF
 186    U+1000..U+CFFF       E1..EC    80..BF  80..BF
 187    U+D000..U+D7FF       ED        80..9F  80..BF
 188    U+D800..U+DFFF       ED        A0..BF  80..BF  (surrogates)
 189    U+E000..U+FFFF       EE..EF    80..BF  80..BF
 190   U+10000..U+3FFFF      F0      * 90..BF  80..BF  80..BF
 191   U+40000..U+FFFFF      F1..F3    80..BF  80..BF  80..BF
 192  U+100000..U+10FFFF     F4        80..8F  80..BF  80..BF
 193     Below are above-Unicode code points
 194  U+110000..U+13FFFF     F4        90..BF  80..BF  80..BF
 195  U+110000..U+1FFFFF     F5..F7    80..BF  80..BF  80..BF
 196  U+200000..U+FFFFFF     F8      * 88..BF  80..BF  80..BF  80..BF
 197 U+1000000..U+3FFFFFF    F9..FB    80..BF  80..BF  80..BF  80..BF
 198 U+4000000..U+3FFFFFFF    FC     * 84..BF  80..BF  80..BF  80..BF  80..BF
 199 U+40000000..U+7FFFFFFF   FD       80..BF  80..BF  80..BF  80..BF  80..BF
 200 U+80000000..U+FFFFFFFFF  FE     * 82..BF  80..BF  80..BF  80..BF  80..BF    80..BF
 201 U+1000000000..           FF       80..BF  80..BF  80..BF  80..BF  80..BF  * 81..BF  80..BF
 202
 203 Note the gaps before several of the byte entries above marked by '*'.  These are
 204 caused by legal UTF-8 avoiding non-shortest encodings: it is technically
 205 possible to UTF-8-encode a single code point in different ways, but that is
 206 explicitly forbidden, and the shortest possible encoding should always be used
 207 (and that is what Perl does).  The non-shortest ones are called 'overlongs'.
 208
 209  */
 210
 211 /*
 212  Another way to look at it, as bits:
 213
 214                   Code Points      1st Byte   2nd Byte   3rd Byte   4th Byte
 215
 216                         0aaa aaaa  0aaa aaaa
 217               0000 0bbb bbaa aaaa  110b bbbb  10aa aaaa
 218               cccc bbbb bbaa aaaa  1110 cccc  10bb bbbb  10aa aaaa
 219  00 000d ddcc cccc bbbb bbaa aaaa  1111 0ddd  10cc cccc  10bb bbbb  10aa aaaa
 220
 221 As you can see, the continuation bytes all begin with C<10>, and the
 222 leading bits of the start byte tell how many bytes there are in the
 223 encoded character.
 224
 225 Perl's extended UTF-8 means we can have start bytes up through FF, though any
 226 beginning with FF yields a code point that is too large for 32-bit ASCII
 227 platforms.  FF signals to use 13 bytes for the encoded character.  This breaks
 228 the paradigm that the number of leading bits gives how many total bytes there
 229 are in the character.
 230
 231 */
 232
 233 /* Anything larger than this will overflow the word if it were converted into a UV */
 234 #if defined(UV_IS_QUAD)
 235 #   define HIGHEST_REPRESENTABLE_UTF8  "\xFF\x80\x8F\xBF\xBF\xBF\xBF\xBF\xBF\xBF\xBF\xBF\xBF"
 236 #else
 237 #   define HIGHEST_REPRESENTABLE_UTF8  "\xFE\x83\xBF\xBF\xBF\xBF\xBF"
 238 #endif
 239
 240 /* Is the representation of the Unicode code point 'cp' the same regardless of
 241  * being encoded in UTF-8 or not? */
 242 #define OFFUNI_IS_INVARIANT(cp)     isASCII(cp)
 243
 244 /*
 245 =for apidoc Am|bool|UVCHR_IS_INVARIANT|UV cp
 246
 247 Evaluates to 1 if the representation of code point C<cp> is the same whether or
 248 not it is encoded in UTF-8; otherwise evaluates to 0.  UTF-8 invariant
 249 characters can be copied as-is when converting to/from UTF-8, saving time.
 250 C<cp> is Unicode if above 255; otherwise is platform-native.
 251
 252 =cut
 253  */
 254
 255 #define UVCHR_IS_INVARIANT(cp)      OFFUNI_IS_INVARIANT(cp)
 256
 257 /* This defines the bits that are to be in the continuation bytes of a multi-byte
 258  * UTF-8 encoded character that mark it is a continuation byte. */
 259 #define UTF_CONTINUATION_MARK           0x80
 260
 261 /* Misleadingly named: is the UTF8-encoded byte 'c' part of a variant sequence
 262  * in UTF-8?  This is the inverse of UTF8_IS_INVARIANT.  The |0 makes sure this
 263  * isn't mistakenly called with a ptr argument */
 264 #define UTF8_IS_CONTINUED(c)        (((U8)((c) | 0)) &  UTF_CONTINUATION_MARK)
 265
 266 /* Is the byte 'c' the first byte of a multi-byte UTF8-8 encoded sequence?
 267  * This doesn't catch invariants (they are single-byte).  It also excludes the
 268  * illegal overlong sequences that begin with C0 and C1.  The |0 makes sure
 269  * this isn't mistakenly called with a ptr argument */
 270 #define UTF8_IS_START(c)            (((U8)((c) | 0)) >= 0xc2)
 271
 272 /* For use in UTF8_IS_CONTINUATION() below */
 273 #define UTF_IS_CONTINUATION_MASK    0xC0
 274
 275 /* Is the byte 'c' part of a multi-byte UTF8-8 encoded sequence, and not the
 276  * first byte thereof?  The |0 makes sure this isn't mistakenly called with a
 277  * ptr argument */
 278 #define UTF8_IS_CONTINUATION(c)                                             \
 279     ((((U8)((c) | 0)) & UTF_IS_CONTINUATION_MASK) == UTF_CONTINUATION_MARK)
 280
 281 /* Is the UTF8-encoded byte 'c' the first byte of a two byte sequence?  Use
 282  * UTF8_IS_NEXT_CHAR_DOWNGRADEABLE() instead if the input isn't known to
 283  * be well-formed.  Masking with 0xfe allows the low bit to be 0 or 1; thus
 284  * this matches 0xc[23].  The |0 makes sure this isn't mistakenly called with a
 285  * ptr argument */
 286 #define UTF8_IS_DOWNGRADEABLE_START(c)  ((((U8)((c) | 0)) & 0xfe) == 0xc2)
 287
 288 /* Is the UTF8-encoded byte 'c' the first byte of a sequence of bytes that
 289  * represent a code point > 255?  The |0 makes sure this isn't mistakenly
 290  * called with a ptr argument */
 291 #define UTF8_IS_ABOVE_LATIN1(c)     (((U8)((c) | 0)) >= 0xc4)
 292
 293 /* This is the number of low-order bits a continuation byte in a UTF-8 encoded
 294  * sequence contributes to the specification of the code point.  In the bit
 295  * maps above, you see that the first 2 bits are a constant '10', leaving 6 of
 296  * real information */
 297 #define UTF_ACCUMULATION_SHIFT          6
 298
 299 /* ^? is defined to be DEL on ASCII systems.  See the definition of toCTRL()
 300  * for more */
 301 #define QUESTION_MARK_CTRL  DEL_NATIVE
 302
 303 /* Surrogates, non-character code points and above-Unicode code points are
 304  * problematic in some contexts.  This allows code that needs to check for
 305  * those to to quickly exclude the vast majority of code points it will
 306  * encounter */
 307 #define isUTF8_POSSIBLY_PROBLEMATIC(c) ((U8) c >= 0xED)
 308
 309 /* A helper macro for isUTF8_CHAR, so use that one instead of this.  This was
 310  * generated by regen/regcharclass.pl, and then moved here.  Then it was
 311  * hand-edited to add some LIKELY() calls, presuming that malformations are
 312  * unlikely.  The lines that generated it were then commented out.  This was
 313  * done because it takes on the order of 10 minutes to generate, and is never
 314  * going to change, unless the generated code is improved, and figuring out
 315  * the LIKELYs there would be hard.
 316  *
 317         UTF8_CHAR: Matches legal UTF-8 variant code points up through 0x1FFFFFF
 318
 319         0x80 - 0x1FFFFF
 320 */
 321 /*** GENERATED CODE ***/
 322 #define is_UTF8_CHAR_utf8_no_length_checks(s)                               \
 323 ( ( 0xC2 <= ((const U8*)s)[0] && ((const U8*)s)[0] <= 0xDF ) ?                          \
 324     ( LIKELY( ( ((const U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 )                    \
 325 : ( 0xE0 == ((const U8*)s)[0] ) ?                                                 \
 326     ( LIKELY( ( ( ((const U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
 327 : ( 0xE1 <= ((const U8*)s)[0] && ((const U8*)s)[0] <= 0xEF ) ?                          \
 328     ( LIKELY( ( ( ((const U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
 329 : ( 0xF0 == ((const U8*)s)[0] ) ?                                                 \
 330     ( LIKELY( ( ( 0x90 <= ((const U8*)s)[1] && ((const U8*)s)[1] <= 0xBF ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((const U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
 331 : ( ( ( ( 0xF1 <= ((const U8*)s)[0] && ((const U8*)s)[0] <= 0xF7 ) && LIKELY( ( ((const U8*)s)[1] & 0xC0 ) == 0x80 ) ) && LIKELY( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) && LIKELY( ( ((const U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )
 332
 333 /* The above macro handles UTF-8 that has this start byte as the maximum */
 334 #define _IS_UTF8_CHAR_HIGHEST_START_BYTE 0xF7
 335
 336 /* A helper macro for isSTRICT_UTF8_CHAR, so use that one instead of this.
 337  * Like is_UTF8_CHAR_utf8_no_length_checks(), this was moved here and LIKELYs
 338  * added manually.
 339  *
 340         STRICT_UTF8_CHAR: Matches legal Unicode UTF-8 variant code points, no
 341                           surrrogates nor non-character code points
 342 */
 343 /*** GENERATED CODE ***/
 344 #define is_STRICT_UTF8_CHAR_utf8_no_length_checks(s)                        \
 345 ( ( 0xC2 <= ((const U8*)s)[0] && ((const U8*)s)[0] <= 0xDF ) ?                          \
 346     ( LIKELY( ( ((const U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 )                          \
 347 : ( 0xE0 == ((const U8*)s)[0] ) ?                                                 \
 348     ( LIKELY( ( ( ((const U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
 349 : ( ( 0xE1 <= ((const U8*)s)[0] && ((const U8*)s)[0] <= 0xEC ) || 0xEE == ((const U8*)s)[0] ) ?\
 350     ( ( ( ( ((const U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
 351 : ( 0xED == ((const U8*)s)[0] ) ?                                                 \
 352     ( LIKELY( ( ( ((const U8*)s)[1] & 0xE0 ) == 0x80 ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
 353 : ( 0xEF == ((const U8*)s)[0] ) ?                                                 \
 354     ( ( ( 0x80 <= ((const U8*)s)[1] && ((const U8*)s)[1] <= 0xB6 ) || ( 0xB8 <= ((const U8*)s)[1] && ((const U8*)s)[1] <= 0xBE ) ) ?\
 355         ( LIKELY( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ? 3 : 0 )                      \
 356     : ( 0xB7 == ((const U8*)s)[1] ) ?                                             \
 357         ( LIKELY( ( ((const U8*)s)[2] & 0xF0 ) == 0x80 || ( ((const U8*)s)[2] & 0xF0 ) == 0xB0 ) ? 3 : 0 )\
 358     : ( ( 0xBF == ((const U8*)s)[1] ) && ( 0x80 <= ((const U8*)s)[2] && ((const U8*)s)[2] <= 0xBD ) ) ? 3 : 0 )\
 359 : ( 0xF0 == ((const U8*)s)[0] ) ?                                                 \
 360     ( ( ( 0x90 <= ((const U8*)s)[1] && ((const U8*)s)[1] <= 0x9E ) || ( 0xA0 <= ((const U8*)s)[1] && ((const U8*)s)[1] <= 0xAE ) || ( 0xB0 <= ((const U8*)s)[1] && ((const U8*)s)[1] <= 0xBE ) ) ?\
 361         ( LIKELY( ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) && ( ( ((const U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
 362     : ( ((const U8*)s)[1] == 0x9F || ( ( ((const U8*)s)[1] & 0xEF ) == 0xAF ) ) ?       \
 363         ( ( 0x80 <= ((const U8*)s)[2] && ((const U8*)s)[2] <= 0xBE ) ?                  \
 364             ( LIKELY( ( ((const U8*)s)[3] & 0xC0 ) == 0x80 ) ? 4 : 0 )                  \
 365         : LIKELY( ( 0xBF == ((const U8*)s)[2] ) && ( 0x80 <= ((const U8*)s)[3] && ((const U8*)s)[3] <= 0xBD ) ) ? 4 : 0 )\
 366     : 0 )                                                                   \
 367 : ( 0xF1 <= ((const U8*)s)[0] && ((const U8*)s)[0] <= 0xF3 ) ?                          \
 368     ( ( ( ( ((const U8*)s)[1] & 0xC8 ) == 0x80 ) || ( ( ((const U8*)s)[1] & 0xCC ) == 0x88 ) || ( ( ((const U8*)s)[1] & 0xCE ) == 0x8C ) || ( ( ((const U8*)s)[1] & 0xCF ) == 0x8E ) ) ?\
 369         ( LIKELY( ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) && ( ( ((const U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
 370     : ( ( ((const U8*)s)[1] & 0xCF ) == 0x8F ) ?                                  \
 371         ( ( 0x80 <= ((const U8*)s)[2] && ((const U8*)s)[2] <= 0xBE ) ?                  \
 372             ( LIKELY( ( ((const U8*)s)[3] & 0xC0 ) == 0x80 ) ? 4 : 0 )                  \
 373         : LIKELY( ( 0xBF == ((const U8*)s)[2] ) && ( 0x80 <= ((const U8*)s)[3] && ((const U8*)s)[3] <= 0xBD ) ) ? 4 : 0 )\
 374     : 0 )                                                                   \
 375 : ( 0xF4 == ((const U8*)s)[0] ) ?                                                 \
 376     ( ( 0x80 <= ((const U8*)s)[1] && ((const U8*)s)[1] <= 0x8E ) ?                      \
 377         ( LIKELY( ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) && ( ( ((const U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
 378     : ( 0x8F == ((const U8*)s)[1] ) ?                                             \
 379         ( ( 0x80 <= ((const U8*)s)[2] && ((const U8*)s)[2] <= 0xBE ) ?                  \
 380             ( LIKELY( ( ((const U8*)s)[3] & 0xC0 ) == 0x80 ) ? 4 : 0 )                  \
 381         : LIKELY( ( 0xBF == ((const U8*)s)[2] ) && ( 0x80 <= ((const U8*)s)[3] && ((const U8*)s)[3] <= 0xBD ) ) ? 4 : 0 )\
 382     : 0 )                                                                   \
 383 : 0 )
 384
 385 /*  Similarly,
 386         C9_STRICT_UTF8_CHAR: Matches legal Unicode UTF-8 variant code
 387                                      points, no surrogates
 388         0x0080 - 0xD7FF
 389         0xE000 - 0x10FFFF
 390 */
 391 /*** GENERATED CODE ***/
 392 #define is_C9_STRICT_UTF8_CHAR_utf8_no_length_checks(s)                     \
 393 ( ( 0xC2 <= ((const U8*)s)[0] && ((const U8*)s)[0] <= 0xDF ) ?                          \
 394     ( LIKELY( ( ((const U8*)s)[1] & 0xC0 ) == 0x80 ) ? 2 : 0 )                    \
 395 : ( 0xE0 == ((const U8*)s)[0] ) ?                                                 \
 396     ( LIKELY( ( ( ((const U8*)s)[1] & 0xE0 ) == 0xA0 ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
 397 : ( ( 0xE1 <= ((const U8*)s)[0] && ((const U8*)s)[0] <= 0xEC ) || ( ((const U8*)s)[0] & 0xFE ) == 0xEE ) ?\
 398     ( LIKELY( ( ( ((const U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
 399 : ( 0xED == ((const U8*)s)[0] ) ?                                                 \
 400     ( LIKELY( ( ( ((const U8*)s)[1] & 0xE0 ) == 0x80 ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) ? 3 : 0 )\
 401 : ( 0xF0 == ((const U8*)s)[0] ) ?                                                 \
 402     ( LIKELY( ( ( 0x90 <= ((const U8*)s)[1] && ((const U8*)s)[1] <= 0xBF ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((const U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
 403 : ( 0xF1 <= ((const U8*)s)[0] && ((const U8*)s)[0] <= 0xF3 ) ?                          \
 404     ( LIKELY( ( ( ( ((const U8*)s)[1] & 0xC0 ) == 0x80 ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((const U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )\
 405 : LIKELY( ( ( ( 0xF4 == ((const U8*)s)[0] ) && ( ( ((const U8*)s)[1] & 0xF0 ) == 0x80 ) ) && ( ( ((const U8*)s)[2] & 0xC0 ) == 0x80 ) ) && ( ( ((const U8*)s)[3] & 0xC0 ) == 0x80 ) ) ? 4 : 0 )
 406
 407 #endif /* EBCDIC vs ASCII */
 408
 409 /* 2**UTF_ACCUMULATION_SHIFT - 1 */
 410 #define UTF_CONTINUATION_MASK  ((U8) ((1U << UTF_ACCUMULATION_SHIFT) - 1))
 411
 412 /* Internal macro to be used only in this file to aid in constructing other
 413  * publicly accessible macros.
 414  * The number of bytes required to express this uv in UTF-8, for just those
 415  * uv's requiring 2 through 6 bytes, as these are common to all platforms and
 416  * word sizes.  The number of bytes needed is given by the number of leading 1
 417  * bits in the start byte.  There are 32 start bytes that have 2 initial 1 bits
 418  * (C0-DF); there are 16 that have 3 initial 1 bits (E0-EF); 8 that have 4
 419  * initial 1 bits (F0-F8); 4 that have 5 initial 1 bits (F9-FB), and 2 that
 420  * have 6 initial 1 bits (FC-FD).  The largest number a string of n bytes can
 421  * represent is       (the number of possible start bytes for 'n')
 422  *                  * (the number of possiblities for each start byte
 423  * The latter in turn is
 424  *                  2  ** (  (how many continuation bytes there are)
 425  *                         * (the number of bits of information each
 426  *                            continuation byte holds))
 427  *
 428  * If we were on a platform where we could use a fast find first set bit
 429  * instruction (or count leading zeros instruction) this could be replaced by
 430  * using that to find the log2 of the uv, and divide that by the number of bits
 431  * of information in each continuation byte, adjusting for large cases and how
 432  * much information is in a start byte for that length */
 433 #define __COMMON_UNI_SKIP(uv)                                               \
 434           (UV) (uv) < (32 * (1U << (    UTF_ACCUMULATION_SHIFT))) ? 2 :     \
 435           (UV) (uv) < (16 * (1U << (2 * UTF_ACCUMULATION_SHIFT))) ? 3 :     \
 436           (UV) (uv) < ( 8 * (1U << (3 * UTF_ACCUMULATION_SHIFT))) ? 4 :     \
 437           (UV) (uv) < ( 4 * (1U << (4 * UTF_ACCUMULATION_SHIFT))) ? 5 :     \
 438           (UV) (uv) < ( 2 * (1U << (5 * UTF_ACCUMULATION_SHIFT))) ? 6 :
 439
 440 /* Internal macro to be used only in this file.
 441  * This adds to __COMMON_UNI_SKIP the details at this platform's upper range.
 442  * For any-sized EBCDIC platforms, or 64-bit ASCII ones, we need one more test
 443  * to see if just 7 bytes is needed, or if the maximum is needed.  For 32-bit
 444  * ASCII platforms, everything is representable by 7 bytes */
 445 #if defined(UV_IS_QUAD) || defined(EBCDIC)
 446 #   define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv)                       \
 447      (UV) (uv) < ((UV) 1U << (6 * UTF_ACCUMULATION_SHIFT)) ? 7 : UTF8_MAXBYTES)
 448 #else
 449 #   define __BASE_UNI_SKIP(uv) (__COMMON_UNI_SKIP(uv) 7)
 450 #endif
 451
 452 /* The next two macros use the base macro defined above, and add in the tests
 453  * at the low-end of the range, for just 1 byte, yielding complete macros,
 454  * publicly accessible. */
 455
 456 /* Input is a true Unicode (not-native) code point */
 457 #define OFFUNISKIP(uv) (OFFUNI_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv))
 458
 459 /*
 460
 461 =for apidoc Am|STRLEN|UVCHR_SKIP|UV cp
 462 returns the number of bytes required to represent the code point C<cp> when
 463 encoded as UTF-8.  C<cp> is a native (ASCII or EBCDIC) code point if less than
 464 255; a Unicode code point otherwise.
 465
 466 =cut
 467  */
 468 #define UVCHR_SKIP(uv) ( UVCHR_IS_INVARIANT(uv) ? 1 : __BASE_UNI_SKIP(uv))
 469
 470 /* The largest code point representable by two UTF-8 bytes on this platform.
 471  * As explained in the comments for __COMMON_UNI_SKIP, 32 start bytes with
 472  * UTF_ACCUMULATION_SHIFT bits of information each */
 473 #define MAX_UTF8_TWO_BYTE (32 * (1U << UTF_ACCUMULATION_SHIFT) - 1)
 474
 475 /* The largest code point representable by two UTF-8 bytes on any platform that
 476  * Perl runs on.  This value is constrained by EBCDIC which has 5 bits per
 477  * continuation byte */
 478 #define MAX_PORTABLE_UTF8_TWO_BYTE (32 * (1U << 5) - 1)
 479
 480 /* The maximum number of UTF-8 bytes a single Unicode character can
 481  * uppercase/lowercase/fold into.  Unicode guarantees that the maximum
 482  * expansion is UTF8_MAX_FOLD_CHAR_EXPAND characters, but any above-Unicode
 483  * code point will fold to itself, so we only have to look at the expansion of
 484  * the maximum Unicode code point.  But this number may be less than the space
 485  * occupied by a very large code point under Perl's extended UTF-8.  We have to
 486  * make it large enough to fit any single character.  (It turns out that ASCII
 487  * and EBCDIC differ in which is larger) */
 488 #define UTF8_MAXBYTES_CASE                                                      \
 489         (UTF8_MAXBYTES >= (UTF8_MAX_FOLD_CHAR_EXPAND * OFFUNISKIP(0x10FFFF))    \
 490                            ? UTF8_MAXBYTES                                      \
 491                            : (UTF8_MAX_FOLD_CHAR_EXPAND * OFFUNISKIP(0x10FFFF)))
 492
 493 /* Rest of these are attributes of Unicode and perl's internals rather than the
 494  * encoding, or happen to be the same in both ASCII and EBCDIC (at least at
 495  * this level; the macros that some of these call may have different
 496  * definitions in the two encodings */
 497
 498 /* In domain restricted to ASCII, these may make more sense to the reader than
 499  * the ones with Latin1 in the name */
 500 #define NATIVE_TO_ASCII(ch)      NATIVE_TO_LATIN1(ch)
 501 #define ASCII_TO_NATIVE(ch)      LATIN1_TO_NATIVE(ch)
 502
 503 /* More or less misleadingly-named defines, retained for back compat */
 504 #define NATIVE_TO_UTF(ch)        NATIVE_UTF8_TO_I8(ch)
 505 #define NATIVE_TO_I8(ch)         NATIVE_UTF8_TO_I8(ch)
 506 #define UTF_TO_NATIVE(ch)        I8_TO_NATIVE_UTF8(ch)
 507 #define I8_TO_NATIVE(ch)         I8_TO_NATIVE_UTF8(ch)
 508 #define NATIVE8_TO_UNI(ch)       NATIVE_TO_LATIN1(ch)
 509
 510 /* This defines the 1-bits that are to be in the first byte of a multi-byte
 511  * UTF-8 encoded character that mark it as a start byte and give the number of
 512  * bytes that comprise the character. 'len' is the number of bytes in the
 513  * multi-byte sequence. */
 514 #define UTF_START_MARK(len) (((len) >  7) ? 0xFF : (0xFF & (0xFE << (7-(len)))))
 515
 516 /* Masks out the initial one bits in a start byte, leaving the real data ones.
 517  * Doesn't work on an invariant byte.  'len' is the number of bytes in the
 518  * multi-byte sequence that comprises the character. */
 519 #define UTF_START_MASK(len) (((len) >= 7) ? 0x00 : (0x1F >> ((len)-2)))
 520
 521 /* Adds a UTF8 continuation byte 'new' of information to a running total code
 522  * point 'old' of all the continuation bytes so far.  This is designed to be
 523  * used in a loop to convert from UTF-8 to the code point represented.  Note
 524  * that this is asymmetric on EBCDIC platforms, in that the 'new' parameter is
 525  * the UTF-EBCDIC byte, whereas the 'old' parameter is a Unicode (not EBCDIC)
 526  * code point in process of being generated */
 527 #define UTF8_ACCUMULATE(old, new) (((old) << UTF_ACCUMULATION_SHIFT)           \
 528                                    | ((NATIVE_UTF8_TO_I8((U8)new))             \
 529                                        & UTF_CONTINUATION_MASK))
 530
 531 /* This works in the face of malformed UTF-8. */
 532 #define UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(s, e) (UTF8_IS_DOWNGRADEABLE_START(*s) \
 533                                                && ( (e) - (s) > 1)             \
 534                                                && UTF8_IS_CONTINUATION(*((s)+1)))
 535
 536 /* Number of bytes a code point occupies in UTF-8. */
 537 #define NATIVE_SKIP(uv) UVCHR_SKIP(uv)
 538
 539 /* Most code which says UNISKIP is really thinking in terms of native code
 540  * points (0-255) plus all those beyond.  This is an imprecise term, but having
 541  * it means existing code continues to work.  For precision, use UVCHR_SKIP,
 542  * NATIVE_SKIP, or OFFUNISKIP */
 543 #define UNISKIP(uv)   UVCHR_SKIP(uv)
 544
 545 /* Longer, but more accurate name */
 546 #define UTF8_IS_ABOVE_LATIN1_START(c)     UTF8_IS_ABOVE_LATIN1(c)
 547
 548 /* Convert a UTF-8 variant Latin1 character to a native code point value.
 549  * Needs just one iteration of accumulate.  Should be used only if it is known
 550  * that the code point is < 256, and is not UTF-8 invariant.  Use the slower
 551  * but more general TWO_BYTE_UTF8_TO_NATIVE() which handles any code point
 552  * representable by two bytes (which turns out to be up through
 553  * MAX_PORTABLE_UTF8_TWO_BYTE).  The two parameters are:
 554  *  HI: a downgradable start byte;
 555  *  LO: continuation.
 556  * */
 557 #define EIGHT_BIT_UTF8_TO_NATIVE(HI, LO)                                        \
 558     ( __ASSERT_(UTF8_IS_DOWNGRADEABLE_START(HI))                                \
 559       __ASSERT_(UTF8_IS_CONTINUATION(LO))                                       \
 560      LATIN1_TO_NATIVE(UTF8_ACCUMULATE((                                         \
 561                             NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), (LO))))
 562
 563 /* Convert a two (not one) byte utf8 character to a native code point value.
 564  * Needs just one iteration of accumulate.  Should not be used unless it is
 565  * known that the two bytes are legal: 1) two-byte start, and 2) continuation.
 566  * Note that the result can be larger than 255 if the input character is not
 567  * downgradable */
 568 #define TWO_BYTE_UTF8_TO_NATIVE(HI, LO) \
 569     ( __ASSERT_(PL_utf8skip[HI] == 2)                                           \
 570       __ASSERT_(UTF8_IS_CONTINUATION(LO))                                       \
 571      UNI_TO_NATIVE(UTF8_ACCUMULATE((NATIVE_UTF8_TO_I8(HI) & UTF_START_MASK(2)), \
 572                                    (LO))))
 573
 574 /* Should never be used, and be deprecated */
 575 #define TWO_BYTE_UTF8_TO_UNI(HI, LO) NATIVE_TO_UNI(TWO_BYTE_UTF8_TO_NATIVE(HI, LO))
 576
 577 /*
 578
 579 =for apidoc Am|STRLEN|UTF8SKIP|char* s
 580 returns the number of bytes in the UTF-8 encoded character whose first (perhaps
 581 only) byte is pointed to by C<s>.
 582
 583 =cut
 584  */
 585 #define UTF8SKIP(s)  PL_utf8skip[*(const U8*)(s)]
 586 #define UTF8_SKIP(s) UTF8SKIP(s)
 587
 588 /* Most code that says 'UNI_' really means the native value for code points up
 589  * through 255 */
 590 #define UNI_IS_INVARIANT(cp)   UVCHR_IS_INVARIANT(cp)
 591
 592 /*
 593 =for apidoc Am|bool|UTF8_IS_INVARIANT|char c
 594
 595 Evaluates to 1 if the byte C<c> represents the same character when encoded in
 596 UTF-8 as when not; otherwise evaluates to 0.  UTF-8 invariant characters can be
 597 copied as-is when converting to/from UTF-8, saving time.
 598
 599 In spite of the name, this macro gives the correct result if the input string
 600 from which C<c> comes is not encoded in UTF-8.
 601
 602 See C<L</UVCHR_IS_INVARIANT>> for checking if a UV is invariant.
 603
 604 =cut
 605
 606 The reason it works on both UTF-8 encoded strings and non-UTF-8 encoded, is
 607 that it returns TRUE in each for the exact same set of bit patterns.  It is
 608 valid on a subset of what UVCHR_IS_INVARIANT is valid on, so can just use that;
 609 and the compiler should optimize out anything extraneous given the
 610 implementation of the latter.  The |0 makes sure this isn't mistakenly called
 611 with a ptr argument.
 612 */
 613 #define UTF8_IS_INVARIANT(c)    UVCHR_IS_INVARIANT((c) | 0)
 614
 615 /* Like the above, but its name implies a non-UTF8 input, which as the comments
 616  * above show, doesn't matter as to its implementation */
 617 #define NATIVE_BYTE_IS_INVARIANT(c)     UVCHR_IS_INVARIANT(c)
 618
 619 /* The macros in the next 4 sets are used to generate the two utf8 or utfebcdic
 620  * bytes from an ordinal that is known to fit into exactly two (not one) bytes;
 621  * it must be less than 0x3FF to work across both encodings. */
 622
 623 /* These two are helper macros for the other three sets, and should not be used
 624  * directly anywhere else.  'translate_function' is either NATIVE_TO_LATIN1
 625  * (which works for code points up through 0xFF) or NATIVE_TO_UNI which works
 626  * for any code point */
 627 #define __BASE_TWO_BYTE_HI(c, translate_function)                               \
 628            (__ASSERT_(! UVCHR_IS_INVARIANT(c))                                  \
 629             I8_TO_NATIVE_UTF8((translate_function(c) >> UTF_ACCUMULATION_SHIFT) \
 630                               | UTF_START_MARK(2)))
 631 #define __BASE_TWO_BYTE_LO(c, translate_function)                               \
 632              (__ASSERT_(! UVCHR_IS_INVARIANT(c))                                \
 633               I8_TO_NATIVE_UTF8((translate_function(c) & UTF_CONTINUATION_MASK) \
 634                                  | UTF_CONTINUATION_MARK))
 635
 636 /* The next two macros should not be used.  They were designed to be usable as
 637  * the case label of a switch statement, but this doesn't work for EBCDIC.  Use
 638  * regen/unicode_constants.pl instead */
 639 #define UTF8_TWO_BYTE_HI_nocast(c)  __BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI)
 640 #define UTF8_TWO_BYTE_LO_nocast(c)  __BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI)
 641
 642 /* The next two macros are used when the source should be a single byte
 643  * character; checked for under DEBUGGING */
 644 #define UTF8_EIGHT_BIT_HI(c) (__ASSERT_(FITS_IN_8_BITS(c))                    \
 645                              ( __BASE_TWO_BYTE_HI(c, NATIVE_TO_LATIN1)))
 646 #define UTF8_EIGHT_BIT_LO(c) (__ASSERT_(FITS_IN_8_BITS(c))                    \
 647                              (__BASE_TWO_BYTE_LO(c, NATIVE_TO_LATIN1)))
 648
 649 /* These final two macros in the series are used when the source can be any
 650  * code point whose UTF-8 is known to occupy 2 bytes; they are less efficient
 651  * than the EIGHT_BIT versions on EBCDIC platforms.  We use the logical '~'
 652  * operator instead of "<=" to avoid getting compiler warnings.
 653  * MAX_UTF8_TWO_BYTE should be exactly all one bits in the lower few
 654  * places, so the ~ works */
 655 #define UTF8_TWO_BYTE_HI(c)                                                    \
 656        (__ASSERT_((sizeof(c) ==  1)                                            \
 657                   || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE))              \
 658         (__BASE_TWO_BYTE_HI(c, NATIVE_TO_UNI)))
 659 #define UTF8_TWO_BYTE_LO(c)                                                    \
 660        (__ASSERT_((sizeof(c) ==  1)                                            \
 661                   || !(((WIDEST_UTYPE)(c)) & ~MAX_UTF8_TWO_BYTE))              \
 662         (__BASE_TWO_BYTE_LO(c, NATIVE_TO_UNI)))
 663
 664 /* This is illegal in any well-formed UTF-8 in both EBCDIC and ASCII
 665  * as it is only in overlongs. */
 666 #define ILLEGAL_UTF8_BYTE   I8_TO_NATIVE_UTF8(0xC1)
 667
 668 /*
 669  * 'UTF' is whether or not p is encoded in UTF8.  The names 'foo_lazy_if' stem
 670  * from an earlier version of these macros in which they didn't call the
 671  * foo_utf8() macros (i.e. were 'lazy') unless they decided that *p is the
 672  * beginning of a utf8 character.  Now that foo_utf8() determines that itself,
 673  * no need to do it again here
 674  */
 675 #define isIDFIRST_lazy_if(p,UTF) ((IN_BYTES || !UTF)                \
 676                                  ? isIDFIRST(*(p))                  \
 677                                  : isIDFIRST_utf8((const U8*)p))
 678 #define isWORDCHAR_lazy_if(p,UTF)   ((IN_BYTES || (!UTF))           \
 679                                  ? isWORDCHAR(*(p))                 \
 680                                  : isWORDCHAR_utf8((const U8*)p))
 681 #define isALNUM_lazy_if(p,UTF)   isWORDCHAR_lazy_if(p,UTF)
 682
 683 #define isIDFIRST_lazy_if_safe(p, e, UTF)                                   \
 684                    ((IN_BYTES || !UTF)                                      \
 685                      ? isIDFIRST(*(p))                                      \
 686                      : isIDFIRST_utf8_safe(p, e))
 687
 688 #define isWORDCHAR_lazy_if_safe(p, e, UTF)                                  \
 689                    ((IN_BYTES || !UTF)                                      \
 690                      ? isWORDCHAR(*(p))                                     \
 691                      : isWORDCHAR_utf8_safe((U8 *) p, (U8 *) e))
 692
 693
 694 #define UTF8_MAXLEN UTF8_MAXBYTES
 695
 696 /* A Unicode character can fold to up to 3 characters */
 697 #define UTF8_MAX_FOLD_CHAR_EXPAND 3
 698
 699 #define IN_BYTES (CopHINTS_get(PL_curcop) & HINT_BYTES)
 700
 701 /*
 702
 703 =for apidoc Am|bool|DO_UTF8|SV* sv
 704 Returns a bool giving whether or not the PV in C<sv> is to be treated as being
 705 encoded in UTF-8.
 706
 707 You should use this I<after> a call to C<SvPV()> or one of its variants, in
 708 case any call to string overloading updates the internal UTF-8 encoding flag.
 709
 710 =cut
 711 */
 712 #define DO_UTF8(sv) (SvUTF8(sv) && !IN_BYTES)
 713
 714 /* Should all strings be treated as Unicode, and not just UTF-8 encoded ones?
 715  * Is so within 'feature unicode_strings' or 'locale :not_characters', and not
 716  * within 'use bytes'.  UTF-8 locales are not tested for here, but perhaps
 717  * could be */
 718 #define IN_UNI_8_BIT                                                             \
 719             (((CopHINTS_get(PL_curcop) & (HINT_UNI_8_BIT))                       \
 720                || (CopHINTS_get(PL_curcop) & HINT_LOCALE_PARTIAL                 \
 721                    /* -1 below is for :not_characters */                         \
 722                    && _is_in_locale_category(FALSE, -1)))                        \
 723               && ! IN_BYTES)
 724
 725
 726 #define UTF8_ALLOW_EMPTY                0x0001  /* Allow a zero length string */
 727 #define UTF8_GOT_EMPTY                  UTF8_ALLOW_EMPTY
 728
 729 /* Allow first byte to be a continuation byte */
 730 #define UTF8_ALLOW_CONTINUATION         0x0002
 731 #define UTF8_GOT_CONTINUATION           UTF8_ALLOW_CONTINUATION
 732
 733 /* Unexpected continuation byte */
 734 #define UTF8_ALLOW_NON_CONTINUATION     0x0004
 735 #define UTF8_GOT_NON_CONTINUATION       UTF8_ALLOW_NON_CONTINUATION
 736
 737 /* expecting more bytes than were available in the string */
 738 #define UTF8_ALLOW_SHORT                0x0008
 739 #define UTF8_GOT_SHORT                  UTF8_ALLOW_SHORT
 740
 741 /* Overlong sequence; i.e., the code point can be specified in fewer bytes. */
 742 #define UTF8_ALLOW_LONG                 0x0010
 743 #define UTF8_GOT_LONG                   UTF8_ALLOW_LONG
 744
 745 /* Currently no way to allow overflow */
 746 #define UTF8_GOT_OVERFLOW               0x0080
 747
 748 #define UTF8_DISALLOW_SURROGATE         0x0100  /* Unicode surrogates */
 749 #define UTF8_GOT_SURROGATE              UTF8_DISALLOW_SURROGATE
 750 #define UTF8_WARN_SURROGATE             0x0200
 751
 752 #define UTF8_DISALLOW_NONCHAR           0x0400  /* Unicode non-character */
 753 #define UTF8_GOT_NONCHAR                UTF8_DISALLOW_NONCHAR
 754 #define UTF8_WARN_NONCHAR               0x0800  /*  code points */
 755
 756 #define UTF8_DISALLOW_SUPER             0x1000  /* Super-set of Unicode: code */
 757 #define UTF8_GOT_SUPER                  UTF8_DISALLOW_SUPER
 758 #define UTF8_WARN_SUPER                 0x2000  /* points above the legal max */
 759
 760 /* Code points which never were part of the original UTF-8 standard, which only
 761  * went up to 2 ** 31 - 1.  Note that these all overflow a signed 32-bit word,
 762  * The first byte of these code points is FE or FF on ASCII platforms.  If the
 763  * first byte is FF, it will overflow a 32-bit word. */
 764 #define UTF8_DISALLOW_ABOVE_31_BIT      0x4000
 765 #define UTF8_GOT_ABOVE_31_BIT           UTF8_DISALLOW_ABOVE_31_BIT
 766 #define UTF8_WARN_ABOVE_31_BIT          0x8000
 767
 768 /* For back compat, these old names are misleading for UTF_EBCDIC */
 769 #define UTF8_DISALLOW_FE_FF             UTF8_DISALLOW_ABOVE_31_BIT
 770 #define UTF8_WARN_FE_FF                 UTF8_WARN_ABOVE_31_BIT
 771
 772 #define UTF8_CHECK_ONLY                 0x10000
 773
 774 /* For backwards source compatibility.  They do nothing, as the default now
 775  * includes what they used to mean.  The first one's meaning was to allow the
 776  * just the single non-character 0xFFFF */
 777 #define UTF8_ALLOW_FFFF 0
 778 #define UTF8_ALLOW_SURROGATE 0
 779
 780 /* C9 refers to Unicode Corrigendum #9: allows but discourages non-chars */
 781 #define UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE                                    \
 782                                  (UTF8_DISALLOW_SUPER|UTF8_DISALLOW_SURROGATE)
 783 #define UTF8_WARN_ILLEGAL_C9_INTERCHANGE (UTF8_WARN_SUPER|UTF8_WARN_SURROGATE)
 784
 785 #define UTF8_DISALLOW_ILLEGAL_INTERCHANGE                                       \
 786                   (UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE|UTF8_DISALLOW_NONCHAR)
 787 #define UTF8_WARN_ILLEGAL_INTERCHANGE \
 788                           (UTF8_WARN_ILLEGAL_C9_INTERCHANGE|UTF8_WARN_NONCHAR)
 789
 790 #define UTF8_ALLOW_ANY                                                          \
 791             (~( UTF8_DISALLOW_ILLEGAL_INTERCHANGE|UTF8_DISALLOW_ABOVE_31_BIT    \
 792                |UTF8_WARN_ILLEGAL_INTERCHANGE|UTF8_WARN_ABOVE_31_BIT))
 793 #define UTF8_ALLOW_ANYUV  UTF8_ALLOW_EMPTY
 794 #define UTF8_ALLOW_DEFAULT              (ckWARN(WARN_UTF8) ? 0 : \
 795                                          UTF8_ALLOW_ANYUV)
 796
 797 /*
 798 =for apidoc Am|bool|UTF8_IS_SURROGATE|const U8 *s|const U8 *e
 799
 800 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
 801 looking no further than S<C<e - 1>> are well-formed UTF-8 that represents one
 802 of the Unicode surrogate code points; otherwise it evaluates to 0.  If
 803 non-zero, the value gives how many bytes starting at C<s> comprise the code
 804 point's representation.
 805
 806 =cut
 807  */
 808 #define UTF8_IS_SURROGATE(s, e)      is_SURROGATE_utf8_safe(s, e)
 809
 810
 811 #define UTF8_IS_REPLACEMENT(s, send) is_REPLACEMENT_utf8_safe(s,send)
 812
 813 /*
 814 =for apidoc Am|bool|UTF8_IS_SUPER|const U8 *s|const U8 *e
 815
 816 Recall that Perl recognizes an extension to UTF-8 that can encode code
 817 points larger than the ones defined by Unicode, which are 0..0x10FFFF.
 818
 819 This macro evaluates to non-zero if the first few bytes of the string starting
 820 at C<s> and looking no further than S<C<e - 1>> are from this UTF-8 extension;
 821 otherwise it evaluates to 0.  If non-zero, the value gives how many bytes
 822 starting at C<s> comprise the code point's representation.
 823
 824 0 is returned if the bytes are not well-formed extended UTF-8, or if they
 825 represent a code point that cannot fit in a UV on the current platform.  Hence
 826 this macro can give different results when run on a 64-bit word machine than on
 827 one with a 32-bit word size.
 828
 829 Note that it is deprecated to have code points that are larger than what can
 830 fit in an IV on the current machine.
 831
 832 =cut
 833
 834  *                ASCII              EBCDIC I8
 835  * U+10FFFF: \xF4\x8F\xBF\xBF   \xF9\xA1\xBF\xBF\xBF    max legal Unicode
 836  * U+110000: \xF4\x90\x80\x80   \xF9\xA2\xA0\xA0\xA0
 837  * U+110001: \xF4\x90\x80\x81   \xF9\xA2\xA0\xA0\xA1
 838  */
 839 #ifdef EBCDIC
 840 #   define UTF8_IS_SUPER(s, e)                                              \
 841                   ((    LIKELY((e) > (s) + 4)                               \
 842                     &&      NATIVE_UTF8_TO_I8(*(s)) >= 0xF9                 \
 843                     && (    NATIVE_UTF8_TO_I8(*(s)) >  0xF9                 \
 844                         || (NATIVE_UTF8_TO_I8(*((s) + 1)) >= 0xA2))         \
 845                     &&  LIKELY((s) + UTF8SKIP(s) <= (e)))                   \
 846                     ? _is_utf8_char_helper(s, s + UTF8SKIP(s), 0) : 0)
 847 #else
 848 #   define UTF8_IS_SUPER(s, e)                                              \
 849                    ((    LIKELY((e) > (s) + 3)                              \
 850                      &&  (*(U8*) (s)) >= 0xF4                               \
 851                      && ((*(U8*) (s)) >  0xF4 || (*((U8*) (s) + 1) >= 0x90))\
 852                      &&  LIKELY((s) + UTF8SKIP(s) <= (e)))                  \
 853                     ? _is_utf8_char_helper(s, s + UTF8SKIP(s), 0) : 0)
 854 #endif
 855
 856 /* These are now machine generated, and the 'given' clause is no longer
 857  * applicable */
 858 #define UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e)          \
 859                                             cBOOL(is_NONCHAR_utf8_safe(s,e))
 860
 861 /*
 862 =for apidoc Am|bool|UTF8_IS_NONCHAR|const U8 *s|const U8 *e
 863
 864 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
 865 looking no further than S<C<e - 1>> are well-formed UTF-8 that represents one
 866 of the Unicode non-character code points; otherwise it evaluates to 0.  If
 867 non-zero, the value gives how many bytes starting at C<s> comprise the code
 868 point's representation.
 869
 870 =cut
 871  */
 872 #define UTF8_IS_NONCHAR(s, e)                                                  \
 873                 UTF8_IS_NONCHAR_GIVEN_THAT_NON_SUPER_AND_GE_PROBLEMATIC(s, e)
 874
 875 #define UNICODE_SURROGATE_FIRST         0xD800
 876 #define UNICODE_SURROGATE_LAST          0xDFFF
 877 #define UNICODE_REPLACEMENT             0xFFFD
 878 #define UNICODE_BYTE_ORDER_MARK         0xFEFF
 879
 880 /* Though our UTF-8 encoding can go beyond this,
 881  * let's be conservative and do as Unicode says. */
 882 #define PERL_UNICODE_MAX        0x10FFFF
 883
 884 #define UNICODE_WARN_SURROGATE        0x0001    /* UTF-16 surrogates */
 885 #define UNICODE_WARN_NONCHAR          0x0002    /* Non-char code points */
 886 #define UNICODE_WARN_SUPER            0x0004    /* Above 0x10FFFF */
 887 #define UNICODE_WARN_ABOVE_31_BIT     0x0008    /* Above 0x7FFF_FFFF */
 888 #define UNICODE_DISALLOW_SURROGATE    0x0010
 889 #define UNICODE_DISALLOW_NONCHAR      0x0020
 890 #define UNICODE_DISALLOW_SUPER        0x0040
 891 #define UNICODE_DISALLOW_ABOVE_31_BIT 0x0080
 892 #define UNICODE_WARN_ILLEGAL_C9_INTERCHANGE                                   \
 893                                   (UNICODE_WARN_SURROGATE|UNICODE_WARN_SUPER)
 894 #define UNICODE_WARN_ILLEGAL_INTERCHANGE                                      \
 895                    (UNICODE_WARN_ILLEGAL_C9_INTERCHANGE|UNICODE_WARN_NONCHAR)
 896 #define UNICODE_DISALLOW_ILLEGAL_C9_INTERCHANGE                               \
 897                           (UNICODE_DISALLOW_SURROGATE|UNICODE_DISALLOW_SUPER)
 898 #define UNICODE_DISALLOW_ILLEGAL_INTERCHANGE                                  \
 899            (UNICODE_DISALLOW_ILLEGAL_C9_INTERCHANGE|UNICODE_DISALLOW_NONCHAR)
 900
 901 /* For backward source compatibility, as are now the default */
 902 #define UNICODE_ALLOW_SURROGATE 0
 903 #define UNICODE_ALLOW_SUPER     0
 904 #define UNICODE_ALLOW_ANY       0
 905
 906 /* This matches the 2048 code points between UNICODE_SURROGATE_FIRST (0xD800) and
 907  * UNICODE_SURROGATE_LAST (0xDFFF) */
 908 #define UNICODE_IS_SURROGATE(uv)        (((UV) (uv) & (~0xFFFF | 0xF800))       \
 909                                                                     == 0xD800)
 910
 911 #define UNICODE_IS_REPLACEMENT(uv)      ((UV) (uv) == UNICODE_REPLACEMENT)
 912 #define UNICODE_IS_BYTE_ORDER_MARK(uv)  ((UV) (uv) == UNICODE_BYTE_ORDER_MARK)
 913
 914 /* Is 'uv' one of the 32 contiguous-range noncharacters? */
 915 #define UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv)      ((UV) (uv) >= 0xFDD0         \
 916                                                  && (UV) (uv) <= 0xFDEF)
 917
 918 /* Is 'uv' one of the 34 plane-ending noncharacters 0xFFFE, 0xFFFF, 0x1FFFE,
 919  * 0x1FFFF, ... 0x10FFFE, 0x10FFFF, given that we know that 'uv' is not above
 920  * the Unicode legal max */
 921 #define UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv)                        \
 922                                               (((UV) (uv) & 0xFFFE) == 0xFFFE)
 923
 924 #define UNICODE_IS_NONCHAR(uv)                                                  \
 925     (   UNICODE_IS_32_CONTIGUOUS_NONCHARS(uv)                                   \
 926      || (   LIKELY( ! UNICODE_IS_SUPER(uv))                                     \
 927          && UNICODE_IS_END_PLANE_NONCHAR_GIVEN_NOT_SUPER(uv)))
 928
 929 #define UNICODE_IS_SUPER(uv)    ((UV) (uv) > PERL_UNICODE_MAX)
 930 #define UNICODE_IS_ABOVE_31_BIT(uv)    ((UV) (uv) > 0x7FFFFFFF)
 931
 932 #define LATIN_SMALL_LETTER_SHARP_S      LATIN_SMALL_LETTER_SHARP_S_NATIVE
 933 #define LATIN_SMALL_LETTER_Y_WITH_DIAERESIS                                  \
 934                                 LATIN_SMALL_LETTER_Y_WITH_DIAERESIS_NATIVE
 935 #define MICRO_SIGN      MICRO_SIGN_NATIVE
 936 #define LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE                               \
 937                             LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE_NATIVE
 938 #define LATIN_SMALL_LETTER_A_WITH_RING_ABOVE                                 \
 939                                 LATIN_SMALL_LETTER_A_WITH_RING_ABOVE_NATIVE
 940 #define UNICODE_GREEK_CAPITAL_LETTER_SIGMA      0x03A3
 941 #define UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA  0x03C2
 942 #define UNICODE_GREEK_SMALL_LETTER_SIGMA        0x03C3
 943 #define GREEK_SMALL_LETTER_MU                   0x03BC
 944 #define GREEK_CAPITAL_LETTER_MU                 0x039C  /* Upper and title case
 945                                                            of MICRON */
 946 #define LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS   0x0178  /* Also is title case */
 947 #ifdef LATIN_CAPITAL_LETTER_SHARP_S_UTF8
 948 #   define LATIN_CAPITAL_LETTER_SHARP_S         0x1E9E
 949 #endif
 950 #define LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE   0x130
 951 #define LATIN_SMALL_LETTER_DOTLESS_I            0x131
 952 #define LATIN_SMALL_LETTER_LONG_S               0x017F
 953 #define LATIN_SMALL_LIGATURE_LONG_S_T           0xFB05
 954 #define LATIN_SMALL_LIGATURE_ST                 0xFB06
 955 #define KELVIN_SIGN                             0x212A
 956 #define ANGSTROM_SIGN                           0x212B
 957
 958 #define UNI_DISPLAY_ISPRINT     0x0001
 959 #define UNI_DISPLAY_BACKSLASH   0x0002
 960 #define UNI_DISPLAY_QQ          (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
 961 #define UNI_DISPLAY_REGEX       (UNI_DISPLAY_ISPRINT|UNI_DISPLAY_BACKSLASH)
 962
 963 #define ANYOF_FOLD_SHARP_S(node, input, end)    \
 964         (ANYOF_BITMAP_TEST(node, LATIN_SMALL_LETTER_SHARP_S) && \
 965          (ANYOF_NONBITMAP(node)) && \
 966          (ANYOF_FLAGS(node) & ANYOF_LOC_NONBITMAP_FOLD) && \
 967          ((end) > (input) + 1) && \
 968          isALPHA_FOLD_EQ((input)[0], 's'))
 969
 970 #define SHARP_S_SKIP 2
 971
 972 /*
 973
 974 =for apidoc Am|STRLEN|isUTF8_CHAR|const U8 *s|const U8 *e
 975
 976 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
 977 looking no further than S<C<e - 1>> are well-formed UTF-8, as extended by Perl,
 978 that represents some code point; otherwise it evaluates to 0.  If non-zero, the
 979 value gives how many bytes starting at C<s> comprise the code point's
 980 representation.  Any bytes remaining before C<e>, but beyond the ones needed to
 981 form the first code point in C<s>, are not examined.
 982
 983 The code point can be any that will fit in a UV on this machine, using Perl's
 984 extension to official UTF-8 to represent those higher than the Unicode maximum
 985 of 0x10FFFF.  That means that this macro is used to efficiently decide if the
 986 next few bytes in C<s> is legal UTF-8 for a single character.
 987
 988 Use C<L</isSTRICT_UTF8_CHAR>> to restrict the acceptable code points to those
 989 defined by Unicode to be fully interchangeable across applications;
 990 C<L</isC9_STRICT_UTF8_CHAR>> to use the L<Unicode Corrigendum
 991 #9|http://www.unicode.org/versions/corrigendum9.html> definition of allowable
 992 code points; and C<L</isUTF8_CHAR_flags>> for a more customized definition.
 993
 994 Use C<L</is_utf8_string>>, C<L</is_utf8_string_loc>>, and
 995 C<L</is_utf8_string_loclen>> to check entire strings.
 996
 997 Note that it is deprecated to use code points higher than what will fit in an
 998 IV.  This macro does not raise any warnings for such code points, treating them
 999 as valid.
1000
1001 Note also that a UTF-8 INVARIANT character (i.e. ASCII on non-EBCDIC machines)
1002 is a valid UTF-8 character.
1003
1004 =cut
1005 */
1006
1007 #define isUTF8_CHAR(s, e)                                                   \
1008     (UNLIKELY((e) <= (s))                                                   \
1009     ? 0                                                                     \
1010     : (UTF8_IS_INVARIANT(*s))                                               \
1011       ? 1                                                                   \
1012       : UNLIKELY(((e) - (s)) < UTF8SKIP(s))                                 \
1013         ? 0                                                                 \
1014         : LIKELY(NATIVE_UTF8_TO_I8(*s) <= _IS_UTF8_CHAR_HIGHEST_START_BYTE) \
1015           ? is_UTF8_CHAR_utf8_no_length_checks(s)                           \
1016           : _is_utf8_char_helper(s, e, 0))
1017
1018 #define is_utf8_char_buf(buf, buf_end) isUTF8_CHAR(buf, buf_end)
1019
1020 /*
1021
1022 =for apidoc Am|STRLEN|isSTRICT_UTF8_CHAR|const U8 *s|const U8 *e
1023
1024 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
1025 looking no further than S<C<e - 1>> are well-formed UTF-8 that represents some
1026 Unicode code point completely acceptable for open interchange between all
1027 applications; otherwise it evaluates to 0.  If non-zero, the value gives how
1028 many bytes starting at C<s> comprise the code point's representation.  Any
1029 bytes remaining before C<e>, but beyond the ones needed to form the first code
1030 point in C<s>, are not examined.
1031
1032 The largest acceptable code point is the Unicode maximum 0x10FFFF, and must not
1033 be a surrogate nor a non-character code point.  Thus this excludes any code
1034 point from Perl's extended UTF-8.
1035
1036 This is used to efficiently decide if the next few bytes in C<s> is
1037 legal Unicode-acceptable UTF-8 for a single character.
1038
1039 Use C<L</isC9_STRICT_UTF8_CHAR>> to use the L<Unicode Corrigendum
1040 #9|http://www.unicode.org/versions/corrigendum9.html> definition of allowable
1041 code points; C<L</isUTF8_CHAR>> to check for Perl's extended UTF-8;
1042 and C<L</isUTF8_CHAR_flags>> for a more customized definition.
1043
1044 Use C<L</is_strict_utf8_string>>, C<L</is_strict_utf8_string_loc>>, and
1045 C<L</is_strict_utf8_string_loclen>> to check entire strings.
1046
1047 =cut
1048 */
1049
1050 #define isSTRICT_UTF8_CHAR(s, e)                                            \
1051     (UNLIKELY((e) <= (s))                                                   \
1052     ? 0                                                                     \
1053     : (UTF8_IS_INVARIANT(*s))                                               \
1054       ? 1                                                                   \
1055       : UNLIKELY(((e) - (s)) < UTF8SKIP(s))                                 \
1056         ? 0                                                                 \
1057         : is_STRICT_UTF8_CHAR_utf8_no_length_checks(s))
1058
1059 /*
1060
1061 =for apidoc Am|STRLEN|isC9_STRICT_UTF8_CHAR|const U8 *s|const U8 *e
1062
1063 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
1064 looking no further than S<C<e - 1>> are well-formed UTF-8 that represents some
1065 Unicode non-surrogate code point; otherwise it evaluates to 0.  If non-zero,
1066 the value gives how many bytes starting at C<s> comprise the code point's
1067 representation.  Any bytes remaining before C<e>, but beyond the ones needed to
1068 form the first code point in C<s>, are not examined.
1069
1070 The largest acceptable code point is the Unicode maximum 0x10FFFF.  This
1071 differs from C<L</isSTRICT_UTF8_CHAR>> only in that it accepts non-character
1072 code points.  This corresponds to
1073 L<Unicode Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>.
1074 which said that non-character code points are merely discouraged rather than
1075 completely forbidden in open interchange.  See
1076 L<perlunicode/Noncharacter code points>.
1077
1078 Use C<L</isUTF8_CHAR>> to check for Perl's extended UTF-8; and
1079 C<L</isUTF8_CHAR_flags>> for a more customized definition.
1080
1081 Use C<L</is_c9strict_utf8_string>>, C<L</is_c9strict_utf8_string_loc>>, and
1082 C<L</is_c9strict_utf8_string_loclen>> to check entire strings.
1083
1084 =cut
1085 */
1086
1087 #define isC9_STRICT_UTF8_CHAR(s, e)                                         \
1088     (UNLIKELY((e) <= (s))                                                   \
1089     ? 0                                                                     \
1090     : (UTF8_IS_INVARIANT(*s))                                               \
1091       ? 1                                                                   \
1092       : UNLIKELY(((e) - (s)) < UTF8SKIP(s))                                 \
1093         ? 0                                                                 \
1094         : is_C9_STRICT_UTF8_CHAR_utf8_no_length_checks(s))
1095
1096 /*
1097
1098 =for apidoc Am|STRLEN|isUTF8_CHAR_flags|const U8 *s|const U8 *e| const U32 flags
1099
1100 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
1101 looking no further than S<C<e - 1>> are well-formed UTF-8, as extended by Perl,
1102 that represents some code point, subject to the restrictions given by C<flags>;
1103 otherwise it evaluates to 0.  If non-zero, the value gives how many bytes
1104 starting at C<s> comprise the code point's representation.  Any bytes remaining
1105 before C<e>, but beyond the ones needed to form the first code point in C<s>,
1106 are not examined.
1107
1108 If C<flags> is 0, this gives the same results as C<L</isUTF8_CHAR>>;
1109 if C<flags> is C<UTF8_DISALLOW_ILLEGAL_INTERCHANGE>, this gives the same results
1110 as C<L</isSTRICT_UTF8_CHAR>>;
1111 and if C<flags> is C<UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE>, this gives
1112 the same results as C<L</isC9_STRICT_UTF8_CHAR>>.
1113 Otherwise C<flags> may be any combination of the C<UTF8_DISALLOW_I<foo>> flags
1114 understood by C<L</utf8n_to_uvchr>>, with the same meanings.
1115
1116 The three alternative macros are for the most commonly needed validations; they
1117 are likely to run somewhat faster than this more general one, as they can be
1118 inlined into your code.
1119
1120 Use L</is_utf8_string_flags>, L</is_utf8_string_loc_flags>, and
1121 L</is_utf8_string_loclen_flags> to check entire strings.
1122
1123 =cut
1124 */
1125
1126 #define isUTF8_CHAR_flags(s, e, flags)                                      \
1127     (UNLIKELY((e) <= (s))                                                   \
1128     ? 0                                                                     \
1129     : (UTF8_IS_INVARIANT(*s))                                               \
1130       ? 1                                                                   \
1131       : UNLIKELY(((e) - (s)) < UTF8SKIP(s))                                 \
1132         ? 0                                                                 \
1133         : _is_utf8_char_helper(s, e, flags))
1134
1135 /* Do not use; should be deprecated.  Use isUTF8_CHAR() instead; this is
1136  * retained solely for backwards compatibility */
1137 #define IS_UTF8_CHAR(p, n)      (isUTF8_CHAR(p, (p) + (n)) == n)
1138
1139 #endif /* H_UTF8 */
1140
1141 /*
1142  * ex: set ts=8 sts=4 sw=4 et:
1143  */