handy.h

   1 /*    handy.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000,
   4  *    2001, 2002, 2004, 2005, 2006, 2007, 2008, 2012 by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 #ifndef HANDY_H /* Guard against nested #inclusion */
  12 #define HANDY_H
  13
  14 #if !defined(__STDC__)
  15 #ifdef NULL
  16 #undef NULL
  17 #endif
  18 #  define NULL 0
  19 #endif
  20
  21 #ifndef PERL_CORE
  22 #  define Null(type) ((type)NULL)
  23
  24 /*
  25 =head1 Handy Values
  26
  27 =for apidoc AmU||Nullch
  28 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
  29
  30 =for apidoc AmU||Nullsv
  31 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
  32
  33 =cut
  34 */
  35
  36 #  define Nullch Null(char*)
  37 #  define Nullfp Null(PerlIO*)
  38 #  define Nullsv Null(SV*)
  39 #endif
  40
  41 #ifdef TRUE
  42 #undef TRUE
  43 #endif
  44 #ifdef FALSE
  45 #undef FALSE
  46 #endif
  47 #define TRUE (1)
  48 #define FALSE (0)
  49
  50 /* The MUTABLE_*() macros cast pointers to the types shown, in such a way
  51  * (compiler permitting) that casting away const-ness will give a warning;
  52  * e.g.:
  53  *
  54  * const SV *sv = ...;
  55  * AV *av1 = (AV*)sv;        <== BAD:  the const has been silently cast away
  56  * AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
  57  */
  58
  59 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
  60 #  define MUTABLE_PTR(p) ({ void *_p = (p); _p; })
  61 #else
  62 #  define MUTABLE_PTR(p) ((void *) (p))
  63 #endif
  64
  65 #define MUTABLE_AV(p)   ((AV *)MUTABLE_PTR(p))
  66 #define MUTABLE_CV(p)   ((CV *)MUTABLE_PTR(p))
  67 #define MUTABLE_GV(p)   ((GV *)MUTABLE_PTR(p))
  68 #define MUTABLE_HV(p)   ((HV *)MUTABLE_PTR(p))
  69 #define MUTABLE_IO(p)   ((IO *)MUTABLE_PTR(p))
  70 #define MUTABLE_SV(p)   ((SV *)MUTABLE_PTR(p))
  71
  72 #ifdef I_STDBOOL
  73 #  include <stdbool.h>
  74 #  ifndef HAS_BOOL
  75 #    define HAS_BOOL 1
  76 #  endif
  77 #endif
  78
  79 /* bool is built-in for g++-2.6.3 and later, which might be used
  80    for extensions.  <_G_config.h> defines _G_HAVE_BOOL, but we can't
  81    be sure _G_config.h will be included before this file.  _G_config.h
  82    also defines _G_HAVE_BOOL for both gcc and g++, but only g++
  83    actually has bool.  Hence, _G_HAVE_BOOL is pretty useless for us.
  84    g++ can be identified by __GNUG__.
  85    Andy Dougherty       February 2000
  86 */
  87 #ifdef __GNUG__         /* GNU g++ has bool built-in */
  88 #  ifndef HAS_BOOL
  89 #    define HAS_BOOL 1
  90 #  endif
  91 #endif
  92
  93 /* The NeXT dynamic loader headers will not build with the bool macro
  94    So declare them now to clear confusion.
  95 */
  96 #if defined(NeXT) || defined(__NeXT__)
  97 # undef FALSE
  98 # undef TRUE
  99   typedef enum bool { FALSE = 0, TRUE = 1 } bool;
 100 # define ENUM_BOOL 1
 101 # ifndef HAS_BOOL
 102 #  define HAS_BOOL 1
 103 # endif /* !HAS_BOOL */
 104 #endif /* NeXT || __NeXT__ */
 105
 106 #ifndef HAS_BOOL
 107 # if defined(VMS)
 108 #  define bool int
 109 # else
 110 #  define bool char
 111 # endif
 112 # define HAS_BOOL 1
 113 #endif
 114
 115 /* cast-to-bool.  A simple (bool) cast may not do the right thing: if bool is
 116  * defined as char for example, then the cast from int is
 117  * implementation-defined (bool)!!(cbool) in a ternary triggers a bug in xlc on
 118  * AIX */
 119 #define cBOOL(cbool) ((cbool) ? (bool)1 : (bool)0)
 120
 121 /* Try to figure out __func__ or __FUNCTION__ equivalent, if any.
 122  * XXX Should really be a Configure probe, with HAS__FUNCTION__
 123  *     and FUNCTION__ as results.
 124  * XXX Similarly, a Configure probe for __FILE__ and __LINE__ is needed. */
 125 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || (defined(__SUNPRO_C)) /* C99 or close enough. */
 126 #  define FUNCTION__ __func__
 127 #else
 128 #  if (defined(_MSC_VER) && _MSC_VER < 1300) || /* MSVC6 has neither __func__ nor __FUNCTION and no good workarounds, either. */ \
 129       (defined(__DECC_VER)) /* Tru64 or VMS, and strict C89 being used, but not modern enough cc (in Tur64, -c99 not known, only -std1). */
 130 #    define FUNCTION__ ""
 131 #  else
 132 #    define FUNCTION__ __FUNCTION__ /* Common extension. */
 133 #  endif
 134 #endif
 135
 136 /* XXX A note on the perl source internal type system.  The
 137    original intent was that I32 be *exactly* 32 bits.
 138
 139    Currently, we only guarantee that I32 is *at least* 32 bits.
 140    Specifically, if int is 64 bits, then so is I32.  (This is the case
 141    for the Cray.)  This has the advantage of meshing nicely with
 142    standard library calls (where we pass an I32 and the library is
 143    expecting an int), but the disadvantage that an I32 is not 32 bits.
 144    Andy Dougherty       August 1996
 145
 146    There is no guarantee that there is *any* integral type with
 147    exactly 32 bits.  It is perfectly legal for a system to have
 148    sizeof(short) == sizeof(int) == sizeof(long) == 8.
 149
 150    Similarly, there is no guarantee that I16 and U16 have exactly 16
 151    bits.
 152
 153    For dealing with issues that may arise from various 32/64-bit
 154    systems, we will ask Configure to check out
 155
 156         SHORTSIZE == sizeof(short)
 157         INTSIZE == sizeof(int)
 158         LONGSIZE == sizeof(long)
 159         LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
 160         PTRSIZE == sizeof(void *)
 161         DOUBLESIZE == sizeof(double)
 162         LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
 163
 164 */
 165
 166 #ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
 167 #   include <inttypes.h>
 168 #   ifdef INT32_MIN_BROKEN
 169 #       undef  INT32_MIN
 170 #       define INT32_MIN (-2147483647-1)
 171 #   endif
 172 #   ifdef INT64_MIN_BROKEN
 173 #       undef  INT64_MIN
 174 #       define INT64_MIN (-9223372036854775807LL-1)
 175 #   endif
 176 #endif
 177
 178 typedef I8TYPE I8;
 179 typedef U8TYPE U8;
 180 typedef I16TYPE I16;
 181 typedef U16TYPE U16;
 182 typedef I32TYPE I32;
 183 typedef U32TYPE U32;
 184 #ifdef PERL_CORE
 185 #   ifdef HAS_QUAD
 186 typedef I64TYPE I64;
 187 typedef U64TYPE U64;
 188 #   endif
 189 #endif /* PERL_CORE */
 190
 191 #if defined(HAS_QUAD) && defined(USE_64_BIT_INT)
 192 #   if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
 193 #       define PeRl_INT64_C(c)  CAT2(c,LL)
 194 #       define PeRl_UINT64_C(c) CAT2(c,ULL)
 195 #   else
 196 #       if QUADKIND == QUAD_IS___INT64
 197 #           define PeRl_INT64_C(c)      CAT2(c,I64)
 198 #           define PeRl_UINT64_C(c)     CAT2(c,UI64)
 199 #       else
 200 #           if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
 201 #               define PeRl_INT64_C(c)  CAT2(c,L)
 202 #               define PeRl_UINT64_C(c) CAT2(c,UL)
 203 #           else
 204 #               define PeRl_INT64_C(c)  ((I64TYPE)(c))
 205 #               define PeRl_UINT64_C(c) ((U64TYPE)(c))
 206 #           endif
 207 #       endif
 208 #   endif
 209 #   ifndef UINT64_C
 210 #   define UINT64_C(c) PeRl_UINT64_C(c)
 211 #   endif
 212 #   ifndef INT64_C
 213 #   define INT64_C(c) PeRl_INT64_C(c)
 214 #   endif
 215 #endif
 216
 217 #if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
 218
 219 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
 220    Please search CHAR_MAX in perl.h for further details. */
 221 #define U8_MAX UINT8_MAX
 222 #define U8_MIN UINT8_MIN
 223
 224 #define I16_MAX INT16_MAX
 225 #define I16_MIN INT16_MIN
 226 #define U16_MAX UINT16_MAX
 227 #define U16_MIN UINT16_MIN
 228
 229 #define I32_MAX INT32_MAX
 230 #define I32_MIN INT32_MIN
 231 #ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
 232 #  define U32_MAX UINT32_MAX
 233 #else
 234 #  define U32_MAX 4294967295U
 235 #endif
 236 #define U32_MIN UINT32_MIN
 237
 238 #else
 239
 240 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
 241    Please search CHAR_MAX in perl.h for further details. */
 242 #define U8_MAX PERL_UCHAR_MAX
 243 #define U8_MIN PERL_UCHAR_MIN
 244
 245 #define I16_MAX PERL_SHORT_MAX
 246 #define I16_MIN PERL_SHORT_MIN
 247 #define U16_MAX PERL_USHORT_MAX
 248 #define U16_MIN PERL_USHORT_MIN
 249
 250 #if LONGSIZE > 4
 251 # define I32_MAX PERL_INT_MAX
 252 # define I32_MIN PERL_INT_MIN
 253 # define U32_MAX PERL_UINT_MAX
 254 # define U32_MIN PERL_UINT_MIN
 255 #else
 256 # define I32_MAX PERL_LONG_MAX
 257 # define I32_MIN PERL_LONG_MIN
 258 # define U32_MAX PERL_ULONG_MAX
 259 # define U32_MIN PERL_ULONG_MIN
 260 #endif
 261
 262 #endif
 263
 264 /* log(2) is pretty close to  0.30103, just in case anyone is grepping for it */
 265 #define BIT_DIGITS(N)   (((N)*146)/485 + 1)  /* log2(10) =~ 146/485 */
 266 #define TYPE_DIGITS(T)  BIT_DIGITS(sizeof(T) * 8)
 267 #define TYPE_CHARS(T)   (TYPE_DIGITS(T) + 2) /* sign, NUL */
 268
 269 #define Ctl(ch) ((ch) & 037)
 270
 271 /*
 272 =head1 SV-Body Allocation
 273
 274 =for apidoc Ama|SV*|newSVpvs|const char* s
 275 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
 276
 277 =for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags
 278 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
 279 pair.
 280
 281 =for apidoc Ama|SV*|newSVpvs_share|const char* s
 282 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
 283 pair and omits the hash parameter.
 284
 285 =for apidoc Am|void|sv_catpvs_flags|SV* sv|const char* s|I32 flags
 286 Like C<sv_catpvn_flags>, but takes a literal string instead of a
 287 string/length pair.
 288
 289 =for apidoc Am|void|sv_catpvs_nomg|SV* sv|const char* s
 290 Like C<sv_catpvn_nomg>, but takes a literal string instead of a
 291 string/length pair.
 292
 293 =for apidoc Am|void|sv_catpvs|SV* sv|const char* s
 294 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
 295
 296 =for apidoc Am|void|sv_catpvs_mg|SV* sv|const char* s
 297 Like C<sv_catpvn_mg>, but takes a literal string instead of a
 298 string/length pair.
 299
 300 =for apidoc Am|void|sv_setpvs|SV* sv|const char* s
 301 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
 302
 303 =for apidoc Am|void|sv_setpvs_mg|SV* sv|const char* s
 304 Like C<sv_setpvn_mg>, but takes a literal string instead of a
 305 string/length pair.
 306
 307 =for apidoc Am|SV *|sv_setref_pvs|const char* s
 308 Like C<sv_setref_pvn>, but takes a literal string instead of a
 309 string/length pair.
 310
 311 =head1 Memory Management
 312
 313 =for apidoc Ama|char*|savepvs|const char* s
 314 Like C<savepvn>, but takes a literal string instead of a string/length pair.
 315
 316 =for apidoc Ama|char*|savesharedpvs|const char* s
 317 A version of C<savepvs()> which allocates the duplicate string in memory
 318 which is shared between threads.
 319
 320 =head1 GV Functions
 321
 322 =for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create
 323 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
 324
 325 =head1 Hash Manipulation Functions
 326
 327 =for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval
 328 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
 329
 330 =for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val
 331 Like C<hv_store>, but takes a literal string instead of a string/length pair
 332 and omits the hash parameter.
 333
 334 =head1 Lexer interface
 335
 336 =for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags
 337
 338 Like L</lex_stuff_pvn>, but takes a literal string instead of a
 339 string/length pair.
 340
 341 =cut
 342 */
 343
 344 /* concatenating with "" ensures that only literal strings are accepted as
 345  * argument */
 346 #define STR_WITH_LEN(s)  ("" s ""), (sizeof(s)-1)
 347
 348 /* note that STR_WITH_LEN() can't be used as argument to macros or functions
 349  * that under some configurations might be macros, which means that it requires
 350  * the full Perl_xxx(aTHX_ ...) form for any API calls where it's used.
 351  */
 352
 353 /* STR_WITH_LEN() shortcuts */
 354 #define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str))
 355 #define newSVpvs_flags(str,flags)       \
 356     Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags)
 357 #define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0)
 358 #define sv_catpvs_flags(sv, str, flags) \
 359     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), flags)
 360 #define sv_catpvs_nomg(sv, str) \
 361     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), 0)
 362 #define sv_catpvs(sv, str) \
 363     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC)
 364 #define sv_catpvs_mg(sv, str) \
 365     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC|SV_SMAGIC)
 366 #define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str))
 367 #define sv_setpvs_mg(sv, str) Perl_sv_setpvn_mg(aTHX_ sv, STR_WITH_LEN(str))
 368 #define sv_setref_pvs(rv, classname, str) \
 369     Perl_sv_setref_pvn(aTHX_ rv, classname, STR_WITH_LEN(str))
 370 #define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str))
 371 #define savesharedpvs(str) Perl_savesharedpvn(aTHX_ STR_WITH_LEN(str))
 372 #define gv_stashpvs(str, create) \
 373     Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create)
 374 #define gv_fetchpvs(namebeg, add, sv_type) \
 375     Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type)
 376 #define gv_fetchpvn(namebeg, len, add, sv_type) \
 377     Perl_gv_fetchpvn_flags(aTHX_ namebeg, len, add, sv_type)
 378 #define sv_catxmlpvs(dsv, str, utf8) \
 379     Perl_sv_catxmlpvn(aTHX_ dsv, STR_WITH_LEN(str), utf8)
 380 #define hv_fetchs(hv,key,lval)                                          \
 381   ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0,        \
 382                          (lval) ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)  \
 383                          : HV_FETCH_JUST_SV, NULL, 0))
 384
 385 #define hv_stores(hv,key,val)                                           \
 386   ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0,        \
 387                          (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), 0))
 388
 389 #define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
 390
 391 #define get_cvs(str, flags)                                     \
 392         Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
 393
 394 /*
 395 =head1 Miscellaneous Functions
 396
 397 =for apidoc Am|bool|strNE|char* s1|char* s2
 398 Test two strings to see if they are different.  Returns true or
 399 false.
 400
 401 =for apidoc Am|bool|strEQ|char* s1|char* s2
 402 Test two strings to see if they are equal.  Returns true or false.
 403
 404 =for apidoc Am|bool|strLT|char* s1|char* s2
 405 Test two strings to see if the first, C<s1>, is less than the second,
 406 C<s2>.  Returns true or false.
 407
 408 =for apidoc Am|bool|strLE|char* s1|char* s2
 409 Test two strings to see if the first, C<s1>, is less than or equal to the
 410 second, C<s2>.  Returns true or false.
 411
 412 =for apidoc Am|bool|strGT|char* s1|char* s2
 413 Test two strings to see if the first, C<s1>, is greater than the second,
 414 C<s2>.  Returns true or false.
 415
 416 =for apidoc Am|bool|strGE|char* s1|char* s2
 417 Test two strings to see if the first, C<s1>, is greater than or equal to
 418 the second, C<s2>.  Returns true or false.
 419
 420 =for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
 421 Test two strings to see if they are different.  The C<len> parameter
 422 indicates the number of bytes to compare.  Returns true or false. (A
 423 wrapper for C<strncmp>).
 424
 425 =for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
 426 Test two strings to see if they are equal.  The C<len> parameter indicates
 427 the number of bytes to compare.  Returns true or false. (A wrapper for
 428 C<strncmp>).
 429
 430 =cut
 431 */
 432
 433 #define strNE(s1,s2) (strcmp(s1,s2))
 434 #define strEQ(s1,s2) (!strcmp(s1,s2))
 435 #define strLT(s1,s2) (strcmp(s1,s2) < 0)
 436 #define strLE(s1,s2) (strcmp(s1,s2) <= 0)
 437 #define strGT(s1,s2) (strcmp(s1,s2) > 0)
 438 #define strGE(s1,s2) (strcmp(s1,s2) >= 0)
 439 #define strnNE(s1,s2,l) (strncmp(s1,s2,l))
 440 #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
 441
 442 #ifdef HAS_MEMCMP
 443 #  define memNE(s1,s2,l) (memcmp(s1,s2,l))
 444 #  define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
 445 #else
 446 #  define memNE(s1,s2,l) (bcmp(s1,s2,l))
 447 #  define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
 448 #endif
 449
 450 #define memEQs(s1, l, s2) \
 451         (sizeof(s2)-1 == l && memEQ(s1, ("" s2 ""), (sizeof(s2)-1)))
 452 #define memNEs(s1, l, s2) !memEQs(s1, l, s2)
 453
 454 /*
 455  * Character classes.
 456  *
 457  * Unfortunately, the introduction of locales means that we
 458  * can't trust isupper(), etc. to tell the truth.  And when
 459  * it comes to /\w+/ with tainting enabled, we *must* be able
 460  * to trust our character classes.
 461  *
 462  * Therefore, the default tests in the text of Perl will be
 463  * independent of locale.  Any code that wants to depend on
 464  * the current locale will use the tests that begin with "lc".
 465  */
 466
 467 #ifdef HAS_SETLOCALE  /* XXX Is there a better test for this? */
 468 #  ifndef CTYPE256
 469 #    define CTYPE256
 470 #  endif
 471 #endif
 472
 473 /*
 474
 475 =head1 Character classes
 476 This section is about functions (really macros) that classify characters
 477 into types, such as punctuation versus alphabetic, etc.  Most of these are
 478 analogous to regular expression character classes.  (See
 479 L<perlrecharclass/POSIX Character Classes>.)  There are several variants for
 480 each class.  (Not all macros have all variants; each item below lists the
 481 ones valid for it.)  None are affected by C<use bytes>, and only the ones
 482 with C<LC> in the name are affected by the current locale.
 483
 484 The base function, e.g., C<isALPHA()>, takes an octet (either a C<char> or a
 485 C<U8>) as input and returns a boolean as to whether or not the character
 486 represented by that octet is (or on non-ASCII platforms, corresponds to) an
 487 ASCII character in the named class based on platform, Unicode, and Perl rules.
 488 If the input is a number that doesn't fit in an octet, FALSE is returned.
 489
 490 Variant C<isFOO_A> (e.g., C<isALPHA_A()>) is identical to the base function
 491 with no suffix C<"_A">.
 492
 493 Variant C<isFOO_L1> imposes the Latin-1 (or EBCDIC equivlalent) character set
 494 onto the platform.  That is, the code points that are ASCII are unaffected,
 495 since ASCII is a subset of Latin-1.  But the non-ASCII code points are treated
 496 as if they are Latin-1 characters.  For example, C<isWORDCHAR_L1()> will return
 497 true when called with the code point 0xDF, which is a word character in both
 498 ASCII and EBCDIC (though it represent different characters in each).
 499
 500 Variant C<isFOO_uni> is like the C<isFOO_L1> variant, but accepts any UV code
 501 point as input.  If the code point is larger than 255, Unicode rules are used
 502 to determine if it is in the character class.  For example,
 503 C<isWORDCHAR_uni(0x100)> returns TRUE, since 0x100 is LATIN CAPITAL LETTER A
 504 WITH MACRON in Unicode, and is a word character.
 505
 506 Variant C<isFOO_utf8> is like C<isFOO_uni>, but the input is a pointer to a
 507 (known to be well-formed) UTF-8 encoded string (C<U8*> or C<char*>).  The
 508 classification of just the first (possibly multi-byte) character in the string
 509 is tested.
 510
 511 Variant C<isFOO_LC> is like the C<isFOO_A> and C<isFOO_L1> variants, but uses
 512 the C library function that gives the named classification instead of
 513 hard-coded rules.  For example, C<isDIGIT_LC()> returns the result of calling
 514 C<isdigit()>.  This means that the result is based on the current locale, which
 515 is what C<LC> in the name stands for.  FALSE is always returned if the input
 516 won't fit into an octet.
 517
 518 Variant C<isFOO_LC_uvchr> is like C<isFOO_LC>, but is defined on any UV.  It
 519 returns the same as C<isFOO_LC> for input code points less than 256, and
 520 returns the hard-coded, not-affected-by-locale, Unicode results for larger ones.
 521
 522 Variant C<isFOO_LC_utf8> is like C<isFOO_LC_uvchr>, but the input is a pointer to a
 523 (known to be well-formed) UTF-8 encoded string (C<U8*> or C<char*>).  The
 524 classification of just the first (possibly multi-byte) character in the string
 525 is tested.
 526
 527 =for apidoc Am|bool|isALPHA|char ch
 528 Returns a boolean indicating whether the specified character is an
 529 alphabetic character, analogous to C<m/[[:alpha:]]/>.
 530 See the L<top of this section|/Character classes> for an explanation of variants
 531 C<isALPHA_A>, C<isALPHA_L1>, C<isALPHA_uni>, C<isALPHA_utf8>, C<isALPHA_LC>,
 532 C<isALPHA_LC_uvchr>, and C<isALPHA_LC_utf8>.
 533
 534 =for apidoc Am|bool|isALPHANUMERIC|char ch
 535 Returns a boolean indicating whether the specified character is a either an
 536 alphabetic character or decimal digit, analogous to C<m/[[:alnum:]]/>.
 537 See the L<top of this section|/Character classes> for an explanation of variants
 538 C<isALPHANUMERIC_A>, C<isALPHANUMERIC_L1>, C<isALPHANUMERIC_uni>,
 539 C<isALPHANUMERIC_utf8>, C<isALPHANUMERIC_LC>, C<isALPHANUMERIC_LC_uvchr>, and
 540 C<isALPHANUMERIC_LC_utf8>.
 541
 542 =for apidoc Am|bool|isASCII|char ch
 543 Returns a boolean indicating whether the specified character is one of the 128
 544 characters in the ASCII character set, analogous to C<m/[[:ascii:]]/>.
 545 On non-ASCII platforms, it returns TRUE iff this
 546 character corresponds to an ASCII character.  Variants C<isASCII_A()> and
 547 C<isASCII_L1()> are identical to C<isASCII()>.
 548 See the L<top of this section|/Character classes> for an explanation of variants
 549 C<isASCII_uni>, C<isASCII_utf8>, C<isASCII_LC>, C<isASCII_LC_uvchr>, and
 550 C<isASCII_LC_utf8>.  Note, however, that some platforms do not have the C
 551 library routine C<isascii()>.  In these cases, the variants whose names contain
 552 C<LC> are the same as the corresponding ones without.
 553
 554 =for apidoc Am|bool|isBLANK|char ch
 555 Returns a boolean indicating whether the specified character is a
 556 character considered to be a blank, analogous to C<m/[[:blank:]]/>.
 557 See the L<top of this section|/Character classes> for an explanation of variants
 558 C<isBLANK_A>, C<isBLANK_L1>, C<isBLANK_uni>, C<isBLANK_utf8>, C<isBLANK_LC>,
 559 C<isBLANK_LC_uvchr>, and C<isBLANK_LC_utf8>.  Note, however, that some
 560 platforms do not have the C library routine C<isblank()>.  In these cases, the
 561 variants whose names contain C<LC> are the same as the corresponding ones
 562 without.
 563
 564 =for apidoc Am|bool|isCNTRL|char ch
 565 Returns a boolean indicating whether the specified character is a
 566 control character, analogous to C<m/[[:cntrl:]]/>.
 567 See the L<top of this section|/Character classes> for an explanation of variants
 568 C<isCNTRL_A>, C<isCNTRL_L1>, C<isCNTRL_uni>, C<isCNTRL_utf8>, C<isCNTRL_LC>,
 569 C<isCNTRL_LC_uvchr>, and C<isCNTRL_LC_utf8>
 570 On EBCDIC platforms, you almost always want to use the C<isCNTRL_L1> variant.
 571
 572 =for apidoc Am|bool|isDIGIT|char ch
 573 Returns a boolean indicating whether the specified character is a
 574 digit, analogous to C<m/[[:digit:]]/>.
 575 Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
 576 See the L<top of this section|/Character classes> for an explanation of variants
 577 C<isDIGIT_uni>, C<isDIGIT_utf8>, C<isDIGIT_LC>, C<isDIGIT_LC_uvchr>, and
 578 C<isDIGIT_LC_utf8>.
 579
 580 =for apidoc Am|bool|isGRAPH|char ch
 581 Returns a boolean indicating whether the specified character is a
 582 graphic character, analogous to C<m/[[:graph:]]/>.
 583 See the L<top of this section|/Character classes> for an explanation of variants
 584 C<isGRAPH_A>, C<isGRAPH_L1>, C<isGRAPH_uni>, C<isGRAPH_utf8>, C<isGRAPH_LC>,
 585 C<isGRAPH_LC_uvchr>, and C<isGRAPH_LC_utf8>.
 586
 587 =for apidoc Am|bool|isLOWER|char ch
 588 Returns a boolean indicating whether the specified character is a
 589 lowercase character, analogous to C<m/[[:lower:]]/>.
 590 See the L<top of this section|/Character classes> for an explanation of variants
 591 C<isLOWER_A>, C<isLOWER_L1>, C<isLOWER_uni>, C<isLOWER_utf8>, C<isLOWER_LC>,
 592 C<isLOWER_LC_uvchr>, and C<isLOWER_LC_utf8>.
 593
 594 =for apidoc Am|bool|isOCTAL|char ch
 595 Returns a boolean indicating whether the specified character is an
 596 octal digit, [0-7].
 597 The only two variants are C<isOCTAL_A> and C<isOCTAL_L1>; each is identical to
 598 C<isOCTAL>.
 599
 600 =for apidoc Am|bool|isPUNCT|char ch
 601 Returns a boolean indicating whether the specified character is a
 602 punctuation character, analogous to C<m/[[:punct:]]/>.
 603 Note that the definition of what is punctuation isn't as
 604 straightforward as one might desire.  See L<perlrecharclass/POSIX Character
 605 Classes> for details.
 606 See the L<top of this section|/Character classes> for an explanation of variants
 607 C<isPUNCT_A>, C<isPUNCT_L1>, C<isPUNCT_uni>, C<isPUNCT_utf8>, C<isPUNCT_LC>,
 608 C<isPUNCT_LC_uvchr>, and C<isPUNCT_LC_utf8>.
 609
 610 =for apidoc Am|bool|isSPACE|char ch
 611 Returns a boolean indicating whether the specified character is a
 612 whitespace character.  This is analogous
 613 to what C<m/\s/> matches in a regular expression.  Starting in Perl 5.18
 614 (experimentally), this also matches what C<m/[[:space:]]/> does.
 615 ("Experimentally" means that this change may be backed out in 5.20 or 5.22 if
 616 field experience indicates that it was unwise.)  Prior to 5.18, only the
 617 locale forms of this macro (the ones with C<LC> in their names) matched
 618 precisely what C<m/[[:space:]]/> does.  In those releases, the only difference,
 619 in the non-locale variants, was that C<isSPACE()> did not match a vertical tab.
 620 (See L</isPSXSPC> for a macro that matches a vertical tab in all releases.)
 621 See the L<top of this section|/Character classes> for an explanation of variants
 622 C<isSPACE_A>, C<isSPACE_L1>, C<isSPACE_uni>, C<isSPACE_utf8>, C<isSPACE_LC>,
 623 C<isSPACE_LC_uvchr>, and C<isSPACE_LC_utf8>.
 624
 625 =for apidoc Am|bool|isPSXSPC|char ch
 626 (short for Posix Space)
 627 Starting in 5.18, this is identical (experimentally) in all its forms to the
 628 corresponding C<isSPACE()> macros.  ("Experimentally" means that this change
 629 may be backed out in 5.20 or 5.22 if field experience indicates that it
 630 was unwise.)
 631 The locale forms of this macro are identical to their corresponding
 632 C<isSPACE()> forms in all Perl releases.  In releases prior to 5.18, the
 633 non-locale forms differ from their C<isSPACE()> forms only in that the
 634 C<isSPACE()> forms don't match a Vertical Tab, and the C<isPSXSPC()> forms do.
 635 Otherwise they are identical.  Thus this macro is analogous to what
 636 C<m/[[:space:]]/> matches in a regular expression.
 637 See the L<top of this section|/Character classes> for an explanation of variants
 638 C<isPSXSPC_A>, C<isPSXSPC_L1>, C<isPSXSPC_uni>, C<isPSXSPC_utf8>, C<isPSXSPC_LC>,
 639 C<isPSXSPC_LC_uvchr>, and C<isPSXSPC_LC_utf8>.
 640
 641 =for apidoc Am|bool|isUPPER|char ch
 642 Returns a boolean indicating whether the specified character is an
 643 uppercase character, analogous to C<m/[[:upper:]]/>.
 644 See the L<top of this section|/Character classes> for an explanation of variants
 645 C<isUPPER_A>, C<isUPPER_L1>, C<isUPPER_uni>, C<isUPPER_utf8>, C<isUPPER_LC>,
 646 C<isUPPER_LC_uvchr>, and C<isUPPER_LC_utf8>.
 647
 648 =for apidoc Am|bool|isPRINT|char ch
 649 Returns a boolean indicating whether the specified character is a
 650 printable character, analogous to C<m/[[:print:]]/>.
 651 See the L<top of this section|/Character classes> for an explanation of variants
 652 C<isPRINT_A>, C<isPRINT_L1>, C<isPRINT_uni>, C<isPRINT_utf8>, C<isPRINT_LC>,
 653 C<isPRINT_LC_uvchr>, and C<isPRINT_LC_utf8>.
 654
 655 =for apidoc Am|bool|isWORDCHAR|char ch
 656 Returns a boolean indicating whether the specified character is a character
 657 that is a word character, analogous to what C<m/\w/> and C<m/[[:word:]]/> match
 658 in a regular expression.  A word character is an alphabetic character, a
 659 decimal digit, a connecting punctuation character (such as an underscore), or
 660 a "mark" character that attaches to one of those (like some sort of accent).
 661 C<isALNUM()> is a synonym provided for backward compatibility, even though a
 662 word character includes more than the standard C language meaning of
 663 alphanumeric.
 664 See the L<top of this section|/Character classes> for an explanation of variants
 665 C<isWORDCHAR_A>, C<isWORDCHAR_L1>, C<isWORDCHAR_uni>, C<isWORDCHAR_utf8>,
 666 C<isWORDCHAR_LC>, C<isWORDCHAR_LC_uvchr>, and C<isWORDCHAR_LC_utf8>.
 667
 668 =for apidoc Am|bool|isXDIGIT|char ch
 669 Returns a boolean indicating whether the specified character is a hexadecimal
 670 digit.  In the ASCII range these are C<[0-9A-Fa-f]>.  Variants C<isXDIGIT_A()>
 671 and C<isXDIGIT_L1()> are identical to C<isXDIGIT()>.
 672 See the L<top of this section|/Character classes> for an explanation of variants
 673 C<isXDIGIT_uni>, C<isXDIGIT_utf8>, C<isXDIGIT_LC>, C<isXDIGIT_LC_uvchr>, and
 674 C<isXDIGIT_LC_utf8>.
 675
 676 =for apidoc Am|bool|isIDFIRST|char ch
 677 Returns a boolean indicating whether the specified character can be the first
 678 character of an identifier.  This is very close to, but not quite the same as
 679 the official Unicode property C<XID_Start>.  The difference is that this
 680 returns true only if the input character also matches L</isWORDCHAR>.
 681 See the L<top of this section|/Character classes> for an explanation of variants
 682 C<isIDFIRST_A>, C<isIDFIRST_L1>, C<isIDFIRST_uni>, C<isIDFIRST_utf8>,
 683 C<isIDFIRST_LC>, C<isIDFIRST_LC_uvchr>, and C<isIDFIRST_LC_utf8>.
 684
 685 =for apidoc Am|bool|isIDCONT|char ch
 686 Returns a boolean indicating whether the specified character can be the
 687 second or succeeding character of an identifier.  This is very close to, but
 688 not quite the same as the official Unicode property C<XID_Continue>.  The
 689 difference is that this returns true only if the input character also matches
 690 L</isWORDCHAR>.  See the L<top of this section|/Character classes> for an
 691 explanation of variants C<isIDCONT_A>, C<isIDCONT_L1>, C<isIDCONT_uni>,
 692 C<isIDCONT_utf8>, C<isIDCONT_LC>, C<isIDCONT_LC_uvchr>, and
 693 C<isIDCONT_LC_utf8>.
 694
 695 =head1 Miscellaneous Functions
 696
 697 =for apidoc Am|U8|READ_XDIGIT|char str*
 698 Returns the value of an ASCII-range hex digit and advances the string pointer.
 699 Behaviour is only well defined when isXDIGIT(*str) is true.
 700
 701 =head1 Character case changing
 702
 703 =for apidoc Am|char|toUPPER|char ch
 704 Converts the specified character to uppercase, if possible; otherwise returns
 705 the input character itself.
 706
 707 =for apidoc Am|char|toLOWER|char ch
 708 Converts the specified character to lowercase, if possible; otherwise returns
 709 the input character itself.
 710
 711 =cut
 712
 713 XXX Still undocumented isVERTWS_uni and _utf8, and the other toUPPER etc functions
 714
 715 Note that these macros are repeated in Devel::PPPort, so should also be
 716 patched there.  The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
 717
 718 */
 719
 720 /* Specify the widest unsigned type on the platform.  Use U64TYPE because U64
 721  * is known only in the perl core, and this macro can be called from outside
 722  * that */
 723 #ifdef HAS_QUAD
 724 #   define WIDEST_UTYPE U64TYPE
 725 #else
 726 #   define WIDEST_UTYPE U32
 727 #endif
 728
 729 /* FITS_IN_8_BITS(c) returns true if c doesn't have  a bit set other than in
 730  * the lower 8.  It is designed to be hopefully bomb-proof, making sure that no
 731  * bits of information are lost even on a 64-bit machine, but to get the
 732  * compiler to optimize it out if possible.  This is because Configure makes
 733  * sure that the machine has an 8-bit byte, so if c is stored in a byte, the
 734  * sizeof() guarantees that this evaluates to a constant true at compile time.
 735  */
 736 #define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || !(((WIDEST_UTYPE)(c)) & ~0xFF))
 737
 738 #ifdef EBCDIC
 739 #   define isASCII(c)    (FITS_IN_8_BITS(c) && (NATIVE_TO_UNI((U8) (c)) < 128))
 740 #else
 741 #   define isASCII(c)    ((WIDEST_UTYPE)(c) < 128)
 742 #endif
 743
 744 #define isASCII_A(c)  isASCII(c)
 745 #define isASCII_L1(c)  isASCII(c)
 746
 747 /* The lower 3 bits in both the ASCII and EBCDIC representations of '0' are 0,
 748  * and the 8 possible permutations of those bits exactly comprise the 8 octal
 749  * digits */
 750 #define isOCTAL_A(c)  cBOOL(FITS_IN_8_BITS(c) && (0xF8 & (c)) == '0')
 751
 752 /* ASCII range only */
 753 #ifdef H_PERL       /* If have access to perl.h, lookup in its table */
 754
 755 /* Character class numbers.  For internal core Perl use only.  The ones less
 756  * than 32 are used in PL_charclass[] and the ones up through the one that
 757  * corresponds to <_HIGHEST_REGCOMP_DOT_H_SYNC> are used by regcomp.h and
 758  * related files.  PL_charclass ones use names used in l1_char_class_tab.h but
 759  * their actual definitions are here.  If that file has a name not used here,
 760  * it won't compile.
 761  *
 762  * The first group of these is ordered in what I (khw) estimate to be the
 763  * frequency of their use.  This gives a slight edge to exiting a loop earlier
 764  * (in reginclass() in regexec.c) */
 765 #  define _CC_WORDCHAR           0      /* \w and [:word:] */
 766 #  define _CC_DIGIT              1      /* \d and [:digit:] */
 767 #  define _CC_ALPHA              2      /* [:alpha:] */
 768 #  define _CC_LOWER              3      /* [:lower:] */
 769 #  define _CC_UPPER              4      /* [:upper:] */
 770 #  define _CC_PUNCT              5      /* [:punct:] */
 771 #  define _CC_PRINT              6      /* [:print:] */
 772 #  define _CC_ALPHANUMERIC       7      /* [:alnum:] */
 773 #  define _CC_GRAPH              8      /* [:graph:] */
 774 #  define _CC_CASED              9      /* [:lower:] and [:upper:] under /i */
 775
 776 #define _FIRST_NON_SWASH_CC     10
 777 /* The character classes above are implemented with swashes.  The second group
 778  * (just below) contains the ones implemented without.  These are also sorted
 779  * in rough order of the frequency of their use, except that \v should be last,
 780  * as it isn't a real Posix character class, and some (small) inefficiencies in
 781  * regular expression handling would be introduced by putting it in the middle
 782  * of those that are.  Also, cntrl and ascii come after the others as it may be
 783  * useful to group these which have no members that match above Latin1, (or
 784  * above ASCII in the latter case) */
 785
 786 #  define _CC_SPACE             10      /* \s */
 787 #  define _CC_BLANK             11      /* [:blank:] */
 788 #  define _CC_XDIGIT            12      /* [:xdigit:] */
 789 #  define _CC_PSXSPC            13      /* [:space:] */
 790 #  define _CC_CNTRL             14      /* [:cntrl:] */
 791 #  define _CC_ASCII             15      /* [:ascii:] */
 792 #  define _CC_VERTSPACE         16      /* \v */
 793
 794 #  define _HIGHEST_REGCOMP_DOT_H_SYNC _CC_VERTSPACE
 795
 796 /* The members of the third group below do not need to be coordinated with data
 797  * structures in regcomp.[ch] and regexec.c */
 798 #  define _CC_IDFIRST           17
 799 #  define _CC_CHARNAME_CONT     18
 800 #  define _CC_NONLATIN1_FOLD    19
 801 #  define _CC_QUOTEMETA         20
 802 #  define _CC_NON_FINAL_FOLD    21
 803 #  define _CC_IS_IN_SOME_FOLD   22
 804 #  define _CC_BACKSLASH_FOO_LBRACE_IS_META 31 /* temp, see mk_PL_charclass.pl */
 805 /* Unused: 23-30
 806  * If more bits are needed, one could add a second word for non-64bit
 807  * QUAD_IS_INT systems, using some #ifdefs to distinguish between having a 2nd
 808  * word or not.  The IS_IN_SOME_FOLD bit is the most easily expendable, as it
 809  * is used only for optimization (as of this writing), and differs in the
 810  * Latin1 range from the ALPHA bit only in two relatively unimportant
 811  * characters: the masculine and feminine ordinal indicators, so removing it
 812  * would just cause /i regexes which match them to run less efficiently */
 813
 814 #if defined(PERL_CORE) || defined(PERL_EXT)
 815 /* An enum version of the character class numbers, to help compilers
 816  * optimize */
 817 typedef enum {
 818     _CC_ENUM_ALPHA          = _CC_ALPHA,
 819     _CC_ENUM_ALPHANUMERIC   = _CC_ALPHANUMERIC,
 820     _CC_ENUM_ASCII          = _CC_ASCII,
 821     _CC_ENUM_BLANK          = _CC_BLANK,
 822     _CC_ENUM_CASED          = _CC_CASED,
 823     _CC_ENUM_CNTRL          = _CC_CNTRL,
 824     _CC_ENUM_DIGIT          = _CC_DIGIT,
 825     _CC_ENUM_GRAPH          = _CC_GRAPH,
 826     _CC_ENUM_LOWER          = _CC_LOWER,
 827     _CC_ENUM_PRINT          = _CC_PRINT,
 828     _CC_ENUM_PSXSPC         = _CC_PSXSPC,
 829     _CC_ENUM_PUNCT          = _CC_PUNCT,
 830     _CC_ENUM_SPACE          = _CC_SPACE,
 831     _CC_ENUM_UPPER          = _CC_UPPER,
 832     _CC_ENUM_VERTSPACE      = _CC_VERTSPACE,
 833     _CC_ENUM_WORDCHAR       = _CC_WORDCHAR,
 834     _CC_ENUM_XDIGIT         = _CC_XDIGIT
 835 } _char_class_number;
 836 #endif
 837
 838 #define POSIX_SWASH_COUNT _FIRST_NON_SWASH_CC
 839 #define POSIX_CC_COUNT    (_HIGHEST_REGCOMP_DOT_H_SYNC + 1)
 840
 841 #if defined(PERL_IN_UTF8_C) || defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
 842 #   if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
 843        || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6                   \
 844        || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9
 845       #error Need to adjust order of swash_property_names[]
 846 #   endif
 847
 848 /* This is declared static in each of the few files that this is #defined for
 849  * to keep them from being publicly accessible.  Hence there is a small amount
 850  * of wasted space */
 851
 852 static const char* const swash_property_names[] = {
 853     "XPosixWord",
 854     "XPosixDigit",
 855     "XPosixAlpha",
 856     "XPosixLower",
 857     "XPosixUpper",
 858     "XPosixPunct",
 859     "XPosixPrint",
 860     "XPosixAlnum",
 861     "XPosixGraph",
 862     "Cased"
 863 };
 864 #endif
 865
 866 #  ifdef DOINIT
 867 EXTCONST  U32 PL_charclass[] = {
 868 #    include "l1_char_class_tab.h"
 869 };
 870
 871 #  else /* ! DOINIT */
 872 EXTCONST U32 PL_charclass[];
 873 #  endif
 874
 875     /* The 1U keeps Solaris from griping when shifting sets the uppermost bit */
 876 #   define _CC_mask(classnum) (1U << (classnum))
 877 #   define _generic_isCC(c, classnum) cBOOL(FITS_IN_8_BITS(c) \
 878                 && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask(classnum)))
 879
 880     /* The mask for the _A versions of the macros; it just adds in the bit for
 881      * ASCII. */
 882 #   define _CC_mask_A(classnum) (_CC_mask(classnum) | _CC_mask(_CC_ASCII))
 883
 884     /* The _A version makes sure that both the desired bit and the ASCII bit
 885      * are present */
 886 #   define _generic_isCC_A(c, classnum) (FITS_IN_8_BITS(c) \
 887         && ((PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask_A(classnum)) \
 888                                 == _CC_mask_A(classnum)))
 889
 890 #   define isALPHA_A(c)  _generic_isCC_A(c, _CC_ALPHA)
 891 #   define isALPHANUMERIC_A(c) _generic_isCC_A(c, _CC_ALPHANUMERIC)
 892 #   define isBLANK_A(c)  _generic_isCC_A(c, _CC_BLANK)
 893 #   define isCNTRL_A(c)  _generic_isCC_A(c, _CC_CNTRL)
 894 #   define isDIGIT_A(c)  _generic_isCC(c, _CC_DIGIT)
 895 #   define isGRAPH_A(c)  _generic_isCC_A(c, _CC_GRAPH)
 896 #   define isLOWER_A(c)  _generic_isCC_A(c, _CC_LOWER)
 897 #   define isPRINT_A(c)  _generic_isCC_A(c, _CC_PRINT)
 898 #   define isPSXSPC_A(c) _generic_isCC_A(c, _CC_PSXSPC)
 899 #   define isPUNCT_A(c)  _generic_isCC_A(c, _CC_PUNCT)
 900 #   define isSPACE_A(c)  _generic_isCC_A(c, _CC_SPACE)
 901 #   define isUPPER_A(c)  _generic_isCC_A(c, _CC_UPPER)
 902 #   define isWORDCHAR_A(c) _generic_isCC_A(c, _CC_WORDCHAR)
 903 #   define isXDIGIT_A(c)  _generic_isCC(c, _CC_XDIGIT)
 904 #   define isIDFIRST_A(c) _generic_isCC_A(c, ( _CC_IDFIRST))
 905
 906     /* Either participates in a fold with a character above 255, or is a
 907      * multi-char fold */
 908 #   define _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) ((! cBOOL(FITS_IN_8_BITS(c))) || (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask(_CC_NONLATIN1_FOLD)))
 909
 910 #   define _isQUOTEMETA(c) _generic_isCC(c, _CC_QUOTEMETA)
 911 #   define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
 912                                             _generic_isCC(c, _CC_NON_FINAL_FOLD)
 913 #   define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
 914                                             _generic_isCC(c, _CC_IS_IN_SOME_FOLD)
 915 #else   /* No perl.h. */
 916 #   ifdef EBCDIC
 917 #       define isALPHA_A(c)    (isASCII(c) && isALPHA(c))
 918 #       define isALPHANUMERIC_A(c) (isASCII(c) && isALPHANUMERIC(c))
 919 #       define isBLANK_A(c)    (isASCII(c) && isBLANK(c))
 920 #       define isCNTRL_A(c)    (isASCII(c) && isCNTRL(c))
 921 #       define isDIGIT_A(c)    (isASCII(c) && isDIGIT(c))
 922 #       define isGRAPH_A(c)    (isASCII(c) && isGRAPH(c))
 923 #       define isIDFIRST_A(c)  (isASCII(c) && isIDFIRST(c))
 924 #       define isLOWER_A(c)    (isASCII(c) && isLOWER(c))
 925 #       define isPRINT_A(c)    (isASCII(c) && isPRINT(c))
 926 #       define isPSXSPC_A(c)   (isASCII(c) && isPSXSPC(c))
 927 #       define isPUNCT_A(c)    (isASCII(c) && isPUNCT(c))
 928 #       define isSPACE_A(c)    (isASCII(c) && isSPACE(c))
 929 #       define isUPPER_A(c)    (isASCII(c) && isUPPER(c))
 930 #       define isWORDCHAR_A(c) (isASCII(c) && isWORDCHAR(c))
 931 #       define isXDIGIT_A(c)   (isASCII(c) && isXDIGIT(c))
 932 #   else   /* ASCII platform, no perl.h */
 933 #       define isALPHA_A(c)  (isUPPER_A(c) || isLOWER_A(c))
 934 #       define isALPHANUMERIC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
 935 #       define isBLANK_A(c)  ((c) == ' ' || (c) == '\t')
 936 #       define isCNTRL_A(c) (FITS_IN_8_BITS(c) && ((U8) (c) < ' ' || (c) == 127))
 937 #       define isDIGIT_A(c)  ((c) <= '9' && (c) >= '0')
 938 #       define isGRAPH_A(c)  (isWORDCHAR_A(c) || isPUNCT_A(c))
 939 #       define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_')
 940 #       define isLOWER_A(c)  ((c) >= 'a' && (c) <= 'z')
 941 #       define isPRINT_A(c)  (((c) >= 32 && (c) < 127))
 942 #       define isPSXSPC_A(c) (isSPACE_A(c) || (c) == '\v')
 943 #       define isPUNCT_A(c)  (((c) >= 33 && (c) <= 47)              \
 944                               || ((c) >= 58 && (c) <= 64)           \
 945                               || ((c) >= 91 && (c) <= 96)           \
 946                               || ((c) >= 123 && (c) <= 126))
 947 #       define isSPACE_A(c)  ((c) == ' '                            \
 948                               || (c) == '\t'                        \
 949                               || (c) == '\n'                        \
 950                               || (c) =='\r'                         \
 951                               || (c) == '\f')
 952 #       define isUPPER_A(c)  ((c) <= 'Z' && (c) >= 'A')
 953 #       define isWORDCHAR_A(c) (isALPHA_A(c) || isDIGIT_A(c) || (c) == '_')
 954 #       define isXDIGIT_A(c)   (isDIGIT_A(c)                        \
 955                                 || ((c) >= 'a' && (c) <= 'f')       \
 956                                 || ((c) <= 'F' && (c) >= 'A'))
 957 #   endif
 958 #endif  /* ASCII range definitions */
 959
 960 /* Latin1 definitions */
 961 #ifdef H_PERL
 962 #   define isALPHA_L1(c)  _generic_isCC(c, _CC_ALPHA)
 963 #   define isALPHANUMERIC_L1(c) _generic_isCC(c, _CC_ALPHANUMERIC)
 964 #   define isBLANK_L1(c)  _generic_isCC(c, _CC_BLANK)
 965
 966 /*  continuation character for legal NAME in \N{NAME} */
 967 #   define isCHARNAME_CONT(c) _generic_isCC(c, _CC_CHARNAME_CONT)
 968
 969 #   define isCNTRL_L1(c)  _generic_isCC(c, _CC_CNTRL)
 970 #   define isGRAPH_L1(c)  _generic_isCC(c, _CC_GRAPH)
 971 #   define isLOWER_L1(c)  _generic_isCC(c, _CC_LOWER)
 972 #   define isPRINT_L1(c)  _generic_isCC(c, _CC_PRINT)
 973 #   define isPSXSPC_L1(c) _generic_isCC(c, _CC_PSXSPC)
 974 #   define isPUNCT_L1(c)  _generic_isCC(c, _CC_PUNCT)
 975 #   define isSPACE_L1(c)  _generic_isCC(c, _CC_SPACE)
 976 #   define isUPPER_L1(c)  _generic_isCC(c, _CC_UPPER)
 977 #   define isWORDCHAR_L1(c) _generic_isCC(c, _CC_WORDCHAR)
 978 #   define isIDFIRST_L1(c) _generic_isCC(c, _CC_IDFIRST)
 979 #else /* No access to perl.h.  Only a few provided here, just in case needed
 980        * for backwards compatibility */
 981     /* ALPHAU includes Unicode semantics for latin1 characters.  It has an extra
 982      * >= AA test to speed up ASCII-only tests at the expense of the others */
 983 #   define isALPHA_L1(c) (isALPHA(c) || (NATIVE_TO_UNI((U8) c) >= 0xAA \
 984         && ((NATIVE_TO_UNI((U8) c) >= 0xC0 \
 985              && NATIVE_TO_UNI((U8) c) != 0xD7 && NATIVE_TO_UNI((U8) c) != 0xF7) \
 986             || NATIVE_TO_UNI((U8) c) == 0xAA \
 987             || NATIVE_TO_UNI((U8) c) == 0xB5 \
 988             || NATIVE_TO_UNI((U8) c) == 0xBA)))
 989 #   define isCHARNAME_CONT(c) (isWORDCHAR_L1(c)                         \
 990                                || (c) == ' '                            \
 991                                || (c) == '-'                            \
 992                                || (c) == '('                            \
 993                                || (c) == ')'                            \
 994                                || (c) == ':'                            \
 995                                || NATIVE_TO_UNI((U8) c) == 0xA0)
 996 #endif
 997
 998 /* Macros that differ between EBCDIC and ASCII.  Where C89 defines a function,
 999  * that is used in the EBCDIC form, because in EBCDIC we do not do locales:
1000  * therefore can use native functions.  For those where C89 doesn't define a
1001  * function, use our function, assuming that the EBCDIC code page is isomorphic
1002  * with Latin1, which the three currently recognized by Perl are.  Some libc's
1003  * have an isblank(), but it's not guaranteed. */
1004 #ifdef EBCDIC
1005 #   define isALPHA(c)   isalpha(c)
1006 #   define isALPHANUMERIC(c)    isalnum(c)
1007 #   define isBLANK(c)   ((c) == ' ' || (c) == '\t' || NATIVE_TO_UNI(c) == 0xA0)
1008 #   define isCNTRL(c)   iscntrl(c)
1009 #   define isDIGIT(c)   isdigit(c)
1010 #   define isGRAPH(c)   isgraph(c)
1011 #   define isIDFIRST(c) (isALPHA(c) || (c) == '_')
1012 #   define isLOWER(c)   islower(c)
1013 #   define isPRINT(c)   isprint(c)
1014 #   define isPSXSPC(c)  isspace(c)
1015 #   define isPUNCT(c)   ispunct(c)
1016 #   define isSPACE(c)   (isPSXSPC(c) /* && (c) != '\v' (Experimentally making
1017                                         these macros identical) */)
1018 #   define isUPPER(c)   isupper(c)
1019 #   define isXDIGIT(c)  isxdigit(c)
1020 #   define isWORDCHAR(c) (isalnum(c) || (c) == '_')
1021 #   define toLOWER(c)   tolower(c)
1022 #   define toUPPER(c)   toupper(c)
1023 #else /* Not EBCDIC: ASCII-only matching */
1024 #   define isALPHANUMERIC(c)  isALPHANUMERIC_A(c)
1025 #   define isALPHA(c)   isALPHA_A(c)
1026 #   define isBLANK(c)   isBLANK_A(c)
1027 #   define isCNTRL(c)   isCNTRL_A(c)
1028 #   define isDIGIT(c)   isDIGIT_A(c)
1029 #   define isGRAPH(c)   isGRAPH_A(c)
1030 #   define isIDFIRST(c) isIDFIRST_A(c)
1031 #   define isLOWER(c)   isLOWER_A(c)
1032 #   define isPRINT(c)   isPRINT_A(c)
1033 #   define isPSXSPC(c)  isPSXSPC_A(c)
1034 #   define isPUNCT(c)   isPUNCT_A(c)
1035 #   define isSPACE(c)   isSPACE_A(c)
1036 #   define isUPPER(c)   isUPPER_A(c)
1037 #   define isWORDCHAR(c) isWORDCHAR_A(c)
1038 #   define isXDIGIT(c)  isXDIGIT_A(c)
1039
1040     /* ASCII casing.  These could also be written as
1041         #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
1042         #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
1043        which uses table lookup and mask instead of subtraction.  (This would
1044        work because the _MOD does not apply in the ASCII range) */
1045 #   define toLOWER(c)   (isUPPER(c) ? (c) + ('a' - 'A') : (c))
1046 #   define toUPPER(c)   (isLOWER(c) ? (c) - ('a' - 'A') : (c))
1047 #endif
1048
1049
1050 /* Use table lookup for speed; return error character for input
1051  * out-of-range */
1052 #define toLOWER_LATIN1(c)    (FITS_IN_8_BITS(c)                            \
1053                              ? UNI_TO_NATIVE(PL_latin1_lc[                 \
1054                                                NATIVE_TO_UNI( (U8) (c)) ]) \
1055                              : UNICODE_REPLACEMENT)
1056 /* Modified uc.  Is correct uc except for three non-ascii chars which are
1057  * all mapped to one of them, and these need special handling; error
1058  * character for input out-of-range */
1059 #define toUPPER_LATIN1_MOD(c) (FITS_IN_8_BITS(c)                           \
1060                               ? UNI_TO_NATIVE(PL_mod_latin1_uc[            \
1061                                                NATIVE_TO_UNI( (U8) (c)) ]) \
1062                               : UNICODE_REPLACEMENT)
1063
1064 #ifdef USE_NEXT_CTYPE
1065
1066 #  define isALPHANUMERIC_LC(c)  NXIsAlNum((unsigned int)(c))
1067 #  define isALPHA_LC(c)         NXIsAlpha((unsigned int)(c))
1068 #  define isASCII_LC(c)         isASCII((unsigned int)(c))
1069 #  define isBLANK_LC(c)         isBLANK((unsigned int)(c))
1070 #  define isCNTRL_LC(c)         NXIsCntrl((unsigned int)(c))
1071 #  define isDIGIT_LC(c)         NXIsDigit((unsigned int)(c))
1072 #  define isGRAPH_LC(c)         NXIsGraph((unsigned int)(c))
1073 #  define isIDFIRST_LC(c) (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
1074 #  define isLOWER_LC(c)         NXIsLower((unsigned int)(c))
1075 #  define isPRINT_LC(c)         NXIsPrint((unsigned int)(c))
1076 #  define isPUNCT_LC(c)         NXIsPunct((unsigned int)(c))
1077 #  define isSPACE_LC(c)         NXIsSpace((unsigned int)(c))
1078 #  define isUPPER_LC(c)         NXIsUpper((unsigned int)(c))
1079 #  define isWORDCHAR_LC(c) (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
1080 #  define isXDIGIT_LC(c)        NXIsXDigit((unsigned int)(c))
1081 #  define toLOWER_LC(c)         NXToLower((unsigned int)(c))
1082 #  define toUPPER_LC(c)         NXToUpper((unsigned int)(c))
1083
1084 #else /* !USE_NEXT_CTYPE */
1085
1086 #  if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
1087
1088 /* Use foo_LC_uvchr() instead  of these for beyond the Latin1 range */
1089
1090 #    define isALPHA_LC(c)   (FITS_IN_8_BITS(c) && isalpha((unsigned char)(c)))
1091 #    define isALPHANUMERIC_LC(c)   (FITS_IN_8_BITS(c)                          \
1092                                                && isalnum((unsigned char)(c)))
1093 #    ifdef HAS_ISASCII
1094 #       define isASCII_LC(c) (FITS_IN_8_BITS(c) && isascii((unsigned char)(c)))
1095 #    else
1096 #       define isASCII_LC(c) (FITS_IN_8_BITS(c) && isASCII((unsigned char)(c)))
1097 #    endif
1098 #    ifdef HAS_ISBLANK
1099 #       define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isblank((unsigned char)(c)))
1100 #    else
1101 #       define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isBLANK((unsigned char)(c)))
1102 #    endif
1103 #    define isCNTRL_LC(c)    (FITS_IN_8_BITS(c) && iscntrl((unsigned char)(c)))
1104 #    define isDIGIT_LC(c)    (FITS_IN_8_BITS(c) && isdigit((unsigned char)(c)))
1105 #    define isGRAPH_LC(c)    (FITS_IN_8_BITS(c) && isgraph((unsigned char)(c)))
1106 #    define isIDFIRST_LC(c) (FITS_IN_8_BITS(c)                                 \
1107                             && (isalpha((unsigned char)(c)) || (char)(c) == '_'))
1108 #    define isLOWER_LC(c)    (FITS_IN_8_BITS(c) && islower((unsigned char)(c)))
1109 #    define isPRINT_LC(c)    (FITS_IN_8_BITS(c) && isprint((unsigned char)(c)))
1110 #    define isPUNCT_LC(c)    (FITS_IN_8_BITS(c) && ispunct((unsigned char)(c)))
1111 #    define isSPACE_LC(c)    (FITS_IN_8_BITS(c) && isspace((unsigned char)(c)))
1112 #    define isUPPER_LC(c)    (FITS_IN_8_BITS(c) && isupper((unsigned char)(c)))
1113 #    define isWORDCHAR_LC(c) (FITS_IN_8_BITS(c)                                \
1114                             && (isalnum((unsigned char)(c)) || (char)(c) == '_'))
1115 #    define isXDIGIT_LC(c)   (FITS_IN_8_BITS(c) && isxdigit((unsigned char)(c)))
1116 #    define toLOWER_LC(c) (FITS_IN_8_BITS(c) ? tolower((unsigned char)(c)) : (c))
1117 #    define toUPPER_LC(c) (FITS_IN_8_BITS(c) ? toupper((unsigned char)(c)) : (c))
1118
1119 #  else
1120
1121 #    define isALPHA_LC(c)       (isascii(c) && isalpha(c))
1122 #    define isALPHANUMERIC_LC(c) (isascii(c) && isalnum(c))
1123 #    define isASCII_LC(c)       isascii(c)
1124 #    ifdef HAS_ISBLANK
1125 #       define isBLANK_LC(c)    (isascii(c) && isblank(c))
1126 #    else
1127 #       define isBLANK_LC(c)    isBLANK_A(c)
1128 #    endif
1129 #    define isCNTRL_LC(c)       (isascii(c) && iscntrl(c))
1130 #    define isDIGIT_LC(c)       (isascii(c) && isdigit(c))
1131 #    define isGRAPH_LC(c)       (isascii(c) && isgraph(c))
1132 #    define isIDFIRST_LC(c)     (isascii(c) && (isalpha(c) || (c) == '_'))
1133 #    define isLOWER_LC(c)       (isascii(c) && islower(c))
1134 #    define isPRINT_LC(c)       (isascii(c) && isprint(c))
1135 #    define isPUNCT_LC(c)       (isascii(c) && ispunct(c))
1136 #    define isSPACE_LC(c)       (isascii(c) && isspace(c))
1137 #    define isUPPER_LC(c)       (isascii(c) && isupper(c))
1138 #    define isWORDCHAR_LC(c)    (isascii(c) && (isalnum(c) || (c) == '_'))
1139 #    define isXDIGIT_LC(c)      (isascii(c) && isxdigit(c))
1140 #    define toLOWER_LC(c)       (isascii(c) ? tolower(c) : (c))
1141 #    define toUPPER_LC(c)       (isascii(c) ? toupper(c) : (c))
1142
1143 #  endif
1144 #endif /* USE_NEXT_CTYPE */
1145
1146 #define isIDCONT(c)             isWORDCHAR(c)
1147 #define isIDCONT_A(c)           isWORDCHAR_A(c)
1148 #define isIDCONT_L1(c)          isWORDCHAR_L1(c)
1149 #define isIDCONT_LC(c)          isWORDCHAR_LC(c)
1150 #define isPSXSPC_LC(c)          isSPACE_LC(c)
1151
1152 /* For internal core Perl use only.  If the input is Latin1, use the Latin1
1153  * macro; otherwise use the function 'above_latin1'.  Won't compile if 'c' isn't unsigned, as
1154  * won't match above_latin1 prototype. The macros do bounds checking, so have
1155  * duplicate checks here, so could create versions of the macros that don't,
1156  * but experiments show that gcc optimizes them out anyway. */
1157
1158 /* Note that all ignore 'use bytes' */
1159 #define _generic_uni(classnum, above_latin1, c) ((c) < 256                    \
1160                                              ? _generic_isCC(c, classnum)     \
1161                                              : above_latin1(c))
1162 #define _generic_swash_uni(classnum, c) ((c) < 256                            \
1163                                              ? _generic_isCC(c, classnum)     \
1164                                              : _is_uni_FOO(classnum, c))
1165 #define isALPHA_uni(c)      _generic_swash_uni(_CC_ALPHA, c)
1166 #define isALPHANUMERIC_uni(c) _generic_swash_uni(_CC_ALPHANUMERIC, c)
1167 #define isASCII_uni(c)      isASCII(c)
1168 #define isBLANK_uni(c)      _generic_uni(_CC_BLANK, is_HORIZWS_cp_high, c)
1169 #define isCNTRL_uni(c)      isCNTRL_L1(c) /* All controls are in Latin1 */
1170 #define isDIGIT_uni(c)      _generic_swash_uni(_CC_DIGIT, c)
1171 #define isGRAPH_uni(c)      _generic_swash_uni(_CC_GRAPH, c)
1172 #define isIDCONT_uni(c)     _generic_uni(_CC_WORDCHAR, _is_uni_perl_idcont, c)
1173 #define isIDFIRST_uni(c)    _generic_uni(_CC_IDFIRST, _is_uni_perl_idstart, c)
1174 #define isLOWER_uni(c)      _generic_swash_uni(_CC_LOWER, c)
1175 #define isPRINT_uni(c)      _generic_swash_uni(_CC_PRINT, c)
1176
1177 /* Posix and regular space are identical above Latin1 */
1178 #define isPSXSPC_uni(c)     _generic_uni(_CC_PSXSPC, is_XPERLSPACE_cp_high, c)
1179
1180 #define isPUNCT_uni(c)      _generic_swash_uni(_CC_PUNCT, c)
1181 #define isSPACE_uni(c)      _generic_uni(_CC_SPACE, is_XPERLSPACE_cp_high, c)
1182 #define isUPPER_uni(c)      _generic_swash_uni(_CC_UPPER, c)
1183 #define isVERTWS_uni(c)     _generic_uni(_CC_VERTSPACE, is_VERTWS_cp_high, c)
1184 #define isWORDCHAR_uni(c)   _generic_swash_uni(_CC_WORDCHAR, c)
1185 #define isXDIGIT_uni(c)     _generic_uni(_CC_XDIGIT, is_XDIGIT_cp_high, c)
1186
1187 #define toFOLD_uni(c,s,l)       to_uni_fold(c,s,l)
1188 #define toLOWER_uni(c,s,l)      to_uni_lower(c,s,l)
1189 #define toTITLE_uni(c,s,l)      to_uni_title(c,s,l)
1190 #define toUPPER_uni(c,s,l)      to_uni_upper(c,s,l)
1191
1192 #define _generic_LC_uvchr(latin1, above_latin1, c)                            \
1193                                     (c < 256 ? latin1(c) : above_latin1(c))
1194 #define _generic_LC_swash_uvchr(latin1, classnum, c)                          \
1195                             (c < 256 ? latin1(c) : _is_uni_FOO(classnum, c))
1196
1197 #define isALPHA_LC_uvchr(c)  _generic_LC_swash_uvchr(isALPHA_LC, _CC_ALPHA, c)
1198 #define isALPHANUMERIC_LC_uvchr(c)  _generic_LC_swash_uvchr(isALPHANUMERIC_LC, \
1199                                                          _CC_ALPHANUMERIC, c)
1200 #define isASCII_LC_uvchr(c)  isASCII_LC(c)
1201 #define isBLANK_LC_uvchr(c)  _generic_LC_uvchr(isBLANK_LC, is_HORIZWS_cp_high, c)
1202 #define isCNTRL_LC_uvchr(c)  (c < 256 ? isCNTRL_LC(c) : 0)
1203 #define isDIGIT_LC_uvchr(c)  _generic_LC_swash_uvchr(isDIGIT_LC, _CC_DIGIT, c)
1204 #define isGRAPH_LC_uvchr(c)  _generic_LC_swash_uvchr(isGRAPH_LC, _CC_GRAPH, c)
1205 #define isIDCONT_LC_uvchr(c)  _generic_LC_uvchr(isIDCONT_LC,                  \
1206                                                   _is_uni_perl_idcont, c)
1207 #define isIDFIRST_LC_uvchr(c)  _generic_LC_uvchr(isIDFIRST_LC,                 \
1208                                                   _is_uni_perl_idstart, c)
1209 #define isLOWER_LC_uvchr(c)  _generic_LC_swash_uvchr(isLOWER_LC, _CC_LOWER, c)
1210 #define isPRINT_LC_uvchr(c)  _generic_LC_swash_uvchr(isPRINT_LC, _CC_PRINT, c)
1211 #define isPSXSPC_LC_uvchr(c) isSPACE_LC_uvchr(c) /* space is identical to posix
1212                                                     space under locale */
1213 #define isPUNCT_LC_uvchr(c)  _generic_LC_swash_uvchr(isPUNCT_LC, _CC_PUNCT, c)
1214 #define isSPACE_LC_uvchr(c)  _generic_LC_uvchr(isSPACE_LC,                     \
1215                                                     is_XPERLSPACE_cp_high, c)
1216 #define isUPPER_LC_uvchr(c)  _generic_LC_swash_uvchr(isUPPER_LC, _CC_UPPER, c)
1217 #define isWORDCHAR_LC_uvchr(c)  _generic_LC_swash_uvchr(isWORDCHAR_LC,              \
1218                                                            _CC_WORDCHAR, c)
1219 #define isXDIGIT_LC_uvchr(c) _generic_LC_uvchr(isXDIGIT_LC, is_XDIGIT_cp_high, c)
1220
1221
1222 #define isBLANK_LC_uni(c)       isBLANK_LC_uvchr(UNI_TO_NATIVE(c))
1223
1224 /* Everything whose name begins with an underscore is for internal core Perl
1225  * use only. */
1226
1227 /* If the input is in the Latin1 range, use
1228  * the Latin1 macro 'classnum' on 'p' which is a pointer to a UTF-8 string.
1229  * Otherwise use the value given by the 'utf8' parameter.  This relies on the
1230  * fact that ASCII characters have the same representation whether utf8 or not.
1231  * Note that it assumes that the utf8 has been validated, and ignores 'use
1232  * bytes' */
1233 #define _generic_utf8(classnum, p, utf8) (UTF8_IS_INVARIANT(*(p))              \
1234                                          ? _generic_isCC(*(p), classnum)       \
1235                                          : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
1236                                            ? _generic_isCC(                    \
1237                                                    TWO_BYTE_UTF8_TO_UNI(*(p),  \
1238                                                                    *((p)+1 )), \
1239                                                    classnum)                   \
1240                                            : utf8)
1241 /* Like the above, but calls 'above_latin1(p)' to get the utf8 value.  'above_latin1'
1242  * can be a macro */
1243 #define _generic_func_utf8(classnum, above_latin1, p)  \
1244                                     _generic_utf8(classnum, p, above_latin1(p))
1245 /* Like the above, but passes classnum to _isFOO_utf8(), instead of having a
1246  * 'above_latin1' parameter */
1247 #define _generic_swash_utf8(classnum, p)  \
1248                       _generic_utf8(classnum, p, _is_utf8_FOO(classnum, p))
1249
1250 /* Like the above, but should be used only when it is known that there are no
1251  * characters in the range 128-255 which the class is TRUE for.  Hence it can
1252  * skip the tests for this range.  'above_latin1' should include its arguments */
1253 #define _generic_utf8_no_upper_latin1(classnum, p, above_latin1)                   \
1254                                          (UTF8_IS_INVARIANT(*(p))              \
1255                                          ? _generic_isCC(*(p), classnum)       \
1256                                          : (UTF8_IS_ABOVE_LATIN1(*(p)))        \
1257                                            ? above_latin1                          \
1258                                            : 0)
1259
1260 /* NOTE that some of these macros have very similar ones in regcharclass.h.
1261  * For example, there is (at the time of this writing) an 'is_SPACE_utf8()'
1262  * there, differing in name only by an underscore from the one here
1263  * 'isSPACE_utf8().  The difference is that the ones here are probably more
1264  * efficient and smaller, using an O(1) array lookup for Latin1-range code
1265  * points; the regcharclass.h ones are implemented as a series of
1266  * "if-else-if-else ..." */
1267
1268 #define isALPHA_utf8(p)         _generic_swash_utf8(_CC_ALPHA, p)
1269 #define isALPHANUMERIC_utf8(p)  _generic_swash_utf8(_CC_ALPHANUMERIC, p)
1270 #define isASCII_utf8(p)         isASCII(*p) /* Because ASCII is invariant under
1271                                                utf8, the non-utf8 macro works
1272                                              */
1273 #define isBLANK_utf8(p)         _generic_func_utf8(_CC_BLANK, is_HORIZWS_high, p)
1274 #define isCNTRL_utf8(p)         _generic_utf8(_CC_CNTRL, p, 0)
1275 #define isDIGIT_utf8(p)         _generic_utf8_no_upper_latin1(_CC_DIGIT, p,   \
1276                                                   _is_utf8_FOO(_CC_DIGIT, p))
1277 #define isGRAPH_utf8(p)         _generic_swash_utf8(_CC_GRAPH, p)
1278 #define isIDCONT_utf8(p)        _generic_func_utf8(_CC_WORDCHAR,              \
1279                                                   _is_utf8_perl_idcont, p)
1280
1281 /* To prevent S_scan_word in toke.c from hanging, we have to make sure that
1282  * IDFIRST is an alnum.  See
1283  * http://rt.perl.org/rt3/Ticket/Display.html?id=74022 for more detail than you
1284  * ever wanted to know about.  (In the ASCII range, there isn't a difference.)
1285  * This used to be not the XID version, but we decided to go with the more
1286  * modern Unicode definition */
1287 #define isIDFIRST_utf8(p)       _generic_func_utf8(_CC_IDFIRST,               \
1288                                                 _is_utf8_perl_idstart, p)
1289
1290 #define isLOWER_utf8(p)         _generic_swash_utf8(_CC_LOWER, p)
1291 #define isPRINT_utf8(p)         _generic_swash_utf8(_CC_PRINT, p)
1292
1293 /* Posix and regular space are identical above Latin1 */
1294 #define isPSXSPC_utf8(p)        _generic_func_utf8(_CC_PSXSPC, is_XPERLSPACE_high, p)
1295
1296 #define isPUNCT_utf8(p)         _generic_swash_utf8(_CC_PUNCT, p)
1297 #define isSPACE_utf8(p)         _generic_func_utf8(_CC_SPACE, is_XPERLSPACE_high, p)
1298 #define isUPPER_utf8(p)         _generic_swash_utf8(_CC_UPPER, p)
1299 #define isVERTWS_utf8(p)        _generic_func_utf8(_CC_VERTSPACE, is_VERTWS_high, p)
1300 #define isWORDCHAR_utf8(p)      _generic_swash_utf8(_CC_WORDCHAR, p)
1301 #define isXDIGIT_utf8(p)        _generic_utf8_no_upper_latin1(_CC_XDIGIT, p,   \
1302                                                           is_XDIGIT_high(p))
1303
1304 #define toLOWER_utf8(p,s,l)     to_utf8_lower(p,s,l)
1305 #define toTITLE_utf8(p,s,l)     to_utf8_title(p,s,l)
1306 #define toUPPER_utf8(p,s,l)     to_utf8_upper(p,s,l)
1307
1308 /* For internal core Perl use only.  If the input is in the Latin1 range, use
1309  * the macro 'macro' on 'p' which is a pointer to a UTF-8 string.  Otherwise
1310  * use the value given by the 'utf8' parameter.  This relies on the fact that
1311  * ASCII characters have the same representation whether utf8 or not.  Note
1312  * that it assumes that the utf8 has been validated, and ignores 'use bytes' */
1313 #define _generic_LC_utf8(macro, p, utf8)                                   \
1314                          (UTF8_IS_INVARIANT(*(p))                          \
1315                          ? macro(*(p))                                     \
1316                          : (UTF8_IS_DOWNGRADEABLE_START(*(p)))             \
1317                            ? macro(TWO_BYTE_UTF8_TO_UNI(*(p), *((p)+1)))   \
1318                            : utf8)
1319
1320 #define _generic_LC_swash_utf8(macro, classnum, p)                         \
1321                     _generic_LC_utf8(macro, p, _is_utf8_FOO(classnum, p))
1322 #define _generic_LC_func_utf8(macro, above_latin1, p)                         \
1323                     _generic_LC_utf8(macro, p, above_latin1(p))
1324
1325 #define isALPHANUMERIC_LC_utf8(p)  _generic_LC_swash_utf8(isALPHANUMERIC_LC,  \
1326                                                       _CC_ALPHANUMERIC, p)
1327 #define isALPHA_LC_utf8(p)   _generic_LC_swash_utf8(isALPHA_LC, _CC_ALPHA, p)
1328 #define isASCII_LC_utf8(p)   isASCII_LC(*p)
1329 #define isBLANK_LC_utf8(p)   _generic_LC_func_utf8(isBLANK_LC, is_HORIZWS_high, p)
1330 #define isCNTRL_LC_utf8(p)   _generic_LC_utf8(isCNTRL_LC, p, 0)
1331 #define isDIGIT_LC_utf8(p)   _generic_LC_swash_utf8(isDIGIT_LC, _CC_DIGIT, p)
1332 #define isGRAPH_LC_utf8(p)   _generic_LC_swash_utf8(isGRAPH_LC, _CC_GRAPH, p)
1333 #define isIDCONT_LC_utf8(p) _generic_LC_func_utf8(isIDCONT_LC, _is_utf8_perl_idcont, p)
1334 #define isIDFIRST_LC_utf8(p) _generic_LC_func_utf8(isIDFIRST_LC, _is_utf8_perl_idstart, p)
1335 #define isLOWER_LC_utf8(p)   _generic_LC_swash_utf8(isLOWER_LC, _CC_LOWER, p)
1336 #define isPRINT_LC_utf8(p)   _generic_LC_swash_utf8(isPRINT_LC, _CC_PRINT, p)
1337 #define isPSXSPC_LC_utf8(p)  isSPACE_LC_utf8(p) /* space is identical to posix
1338                                                    space under locale */
1339 #define isPUNCT_LC_utf8(p)   _generic_LC_swash_utf8(isPUNCT_LC, _CC_PUNCT, p)
1340 #define isSPACE_LC_utf8(p)   _generic_LC_func_utf8(isSPACE_LC, is_XPERLSPACE_high, p)
1341 #define isUPPER_LC_utf8(p)   _generic_LC_swash_utf8(isUPPER_LC, _CC_UPPER, p)
1342 #define isWORDCHAR_LC_utf8(p) _generic_LC_swash_utf8(isWORDCHAR_LC,           \
1343                                                             _CC_WORDCHAR, p)
1344 #define isXDIGIT_LC_utf8(p)  _generic_LC_func_utf8(isXDIGIT_LC, is_XDIGIT_high, p)
1345
1346 /* Macros for backwards compatibility and for completeness when the ASCII and
1347  * Latin1 values are identical */
1348 #define isALPHAU(c)     isALPHA_L1(c)
1349 #define isDIGIT_L1(c)   isDIGIT_A(c)
1350 #define isOCTAL(c)      isOCTAL_A(c)
1351 #define isOCTAL_L1(c)   isOCTAL_A(c)
1352 #define isXDIGIT_L1(c)  isXDIGIT_A(c)
1353 #define isALNUM(c)      isWORDCHAR(c)
1354 #define isALNUMU(c)     isWORDCHAR_L1(c)
1355 #define isALNUM_LC(c)   isWORDCHAR_LC(c)
1356 #define isALNUM_uni(c)  isWORDCHAR_uni(c)
1357 #define isALNUM_LC_uvchr(c) isWORDCHAR_LC_uvchr(c)
1358 #define isALNUM_utf8(p) isWORDCHAR_utf8(p)
1359 #define isALNUM_LC_utf8(p) isWORDCHAR_LC_utf8(p)
1360 #define isALNUMC_A(c)   isALPHANUMERIC_A(c)      /* Mnemonic: "C's alnum" */
1361 #define isALNUMC_L1(c)  isALPHANUMERIC_L1(c)
1362 #define isALNUMC(c)     isALPHANUMERIC(c)
1363 #define isALNUMC_LC(c)  isALPHANUMERIC_LC(c)
1364 #define isALNUMC_uni(c) isALPHANUMERIC_uni(c)
1365 #define isALNUMC_LC_uvchr(c) isALPHANUMERIC_LC_uvchr(c)
1366 #define isALNUMC_utf8(p) isALPHANUMERIC_utf8(p)
1367 #define isALNUMC_LC_utf8(p) isALPHANUMERIC_LC_utf8(p)
1368
1369 /* This conversion works both ways, strangely enough. On EBCDIC platforms,
1370  * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII, except that they don't
1371  * necessarily mean the same characters, e.g. CTRL-D is 4 on both systems, but
1372  * that is EOT on ASCII;  ST on EBCDIC */
1373 #  define toCTRL(c)    (toUPPER(NATIVE_TO_UNI(c)) ^ 64)
1374
1375 /* Line numbers are unsigned, 32 bits. */
1376 typedef U32 line_t;
1377 #define NOLINE ((line_t) 4294967295UL)  /* = FFFFFFFF */
1378
1379 /* Helpful alias for version prescan */
1380 #define is_LAX_VERSION(a,b) \
1381         (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
1382
1383 #define is_STRICT_VERSION(a,b) \
1384         (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
1385
1386 #define BADVERSION(a,b,c) \
1387         if (b) { \
1388             *b = c; \
1389         } \
1390         return a;
1391
1392 #define READ_XDIGIT(s) (isALPHA(*(s)) ? ((*(s)++ + 9) & 0xf) : (*(s)++ & 0xf))
1393
1394 /*
1395 =head1 Memory Management
1396
1397 =for apidoc Am|void|Newx|void* ptr|int nitems|type
1398 The XSUB-writer's interface to the C C<malloc> function.
1399
1400 In 5.9.3, Newx() and friends replace the older New() API, and drops
1401 the first parameter, I<x>, a debug aid which allowed callers to identify
1402 themselves.  This aid has been superseded by a new build option,
1403 PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>).  The older API is still
1404 there for use in XS modules supporting older perls.
1405
1406 =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
1407 The XSUB-writer's interface to the C C<malloc> function, with
1408 cast.  See also C<Newx>.
1409
1410 =for apidoc Am|void|Newxz|void* ptr|int nitems|type
1411 The XSUB-writer's interface to the C C<malloc> function.  The allocated
1412 memory is zeroed with C<memzero>.  See also C<Newx>.
1413
1414 =for apidoc Am|void|Renew|void* ptr|int nitems|type
1415 The XSUB-writer's interface to the C C<realloc> function.
1416
1417 =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
1418 The XSUB-writer's interface to the C C<realloc> function, with
1419 cast.
1420
1421 =for apidoc Am|void|Safefree|void* ptr
1422 The XSUB-writer's interface to the C C<free> function.
1423
1424 =for apidoc Am|void|Move|void* src|void* dest|int nitems|type
1425 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
1426 source, C<dest> is the destination, C<nitems> is the number of items, and
1427 C<type> is the type.  Can do overlapping moves.  See also C<Copy>.
1428
1429 =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
1430 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1431 optimise.
1432
1433 =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
1434 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
1435 source, C<dest> is the destination, C<nitems> is the number of items, and
1436 C<type> is the type.  May fail on overlapping copies.  See also C<Move>.
1437
1438 =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
1439
1440 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1441 optimise.
1442
1443 =for apidoc Am|void|Zero|void* dest|int nitems|type
1444
1445 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
1446 destination, C<nitems> is the number of items, and C<type> is the type.
1447
1448 =for apidoc Am|void *|ZeroD|void* dest|int nitems|type
1449
1450 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1451 optimise.
1452
1453 =for apidoc Am|void|StructCopy|type *src|type *dest|type
1454 This is an architecture-independent macro to copy one structure to another.
1455
1456 =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
1457
1458 Fill up memory with a byte pattern (a byte repeated over and over
1459 again) that hopefully catches attempts to access uninitialized memory.
1460
1461 =for apidoc Am|void|PoisonNew|void* dest|int nitems|type
1462
1463 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
1464
1465 =for apidoc Am|void|PoisonFree|void* dest|int nitems|type
1466
1467 PoisonWith(0xEF) for catching access to freed memory.
1468
1469 =for apidoc Am|void|Poison|void* dest|int nitems|type
1470
1471 PoisonWith(0xEF) for catching access to freed memory.
1472
1473 =cut */
1474
1475 /* Maintained for backwards-compatibility only. Use newSV() instead. */
1476 #ifndef PERL_CORE
1477 #define NEWSV(x,len)    newSV(len)
1478 #endif
1479
1480 #define MEM_SIZE_MAX ((MEM_SIZE)~0)
1481
1482 /* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
1483  * overly eager compilers that will bleat about e.g.
1484  * (U16)n > (size_t)~0/sizeof(U16) always being false. */
1485 #ifdef PERL_MALLOC_WRAP
1486 #define MEM_WRAP_CHECK(n,t) \
1487         (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_memory_wrap(),0))
1488 #define MEM_WRAP_CHECK_1(n,t,a) \
1489         (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
1490 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
1491
1492 #define PERL_STRLEN_ROUNDUP(n) ((void)(((n) > MEM_SIZE_MAX - 2 * PERL_STRLEN_ROUNDUP_QUANTUM) ?  (Perl_croak_memory_wrap(),0):0),((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
1493 #else
1494
1495 #define MEM_WRAP_CHECK(n,t)
1496 #define MEM_WRAP_CHECK_1(n,t,a)
1497 #define MEM_WRAP_CHECK_2(n,t,a,b)
1498 #define MEM_WRAP_CHECK_(n,t)
1499
1500 #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
1501
1502 #endif
1503
1504 #ifdef PERL_MEM_LOG
1505 /*
1506  * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
1507  * go through functions, which are handy for debugging breakpoints, but
1508  * which more importantly get the immediate calling environment (file and
1509  * line number, and C function name if available) passed in.  This info can
1510  * then be used for logging the calls, for which one gets a sample
1511  * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
1512  *
1513  * Known problems:
1514  * - not all memory allocs get logged, only those
1515  *   that go through Newx() and derivatives (while all
1516  *   Safefrees do get logged)
1517  * - __FILE__ and __LINE__ do not work everywhere
1518  * - __func__ or __FUNCTION__ even less so
1519  * - I think more goes on after the perlio frees but
1520  *   the thing is that STDERR gets closed (as do all
1521  *   the file descriptors)
1522  * - no deeper calling stack than the caller of the Newx()
1523  *   or the kind, but do I look like a C reflection/introspection
1524  *   utility to you?
1525  * - the function prototypes for the logging functions
1526  *   probably should maybe be somewhere else than handy.h
1527  * - one could consider inlining (macrofying) the logging
1528  *   for speed, but I am too lazy
1529  * - one could imagine recording the allocations in a hash,
1530  *   (keyed by the allocation address?), and maintain that
1531  *   through reallocs and frees, but how to do that without
1532  *   any News() happening...?
1533  * - lots of -Ddefines to get useful/controllable output
1534  * - lots of ENV reads
1535  */
1536
1537 PERL_EXPORT_C Malloc_t Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name, Malloc_t newalloc, const char *filename, const int linenumber, const char *funcname);
1538
1539 PERL_EXPORT_C Malloc_t Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name, Malloc_t oldalloc, Malloc_t newalloc, const char *filename, const int linenumber, const char *funcname);
1540
1541 PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
1542
1543 # ifdef PERL_CORE
1544 #  ifndef PERL_MEM_LOG_NOIMPL
1545 enum mem_log_type {
1546   MLT_ALLOC,
1547   MLT_REALLOC,
1548   MLT_FREE,
1549   MLT_NEW_SV,
1550   MLT_DEL_SV
1551 };
1552 #  endif
1553 #  if defined(PERL_IN_SV_C)  /* those are only used in sv.c */
1554 void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1555 void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1556 #  endif
1557 # endif
1558
1559 #endif
1560
1561 #ifdef PERL_MEM_LOG
1562 #define MEM_LOG_ALLOC(n,t,a)     Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
1563 #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
1564 #define MEM_LOG_FREE(a)          Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
1565 #endif
1566
1567 #ifndef MEM_LOG_ALLOC
1568 #define MEM_LOG_ALLOC(n,t,a)     (a)
1569 #endif
1570 #ifndef MEM_LOG_REALLOC
1571 #define MEM_LOG_REALLOC(n,t,v,a) (a)
1572 #endif
1573 #ifndef MEM_LOG_FREE
1574 #define MEM_LOG_FREE(a)          (a)
1575 #endif
1576
1577 #define Newx(v,n,t)     (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1578 #define Newxc(v,n,t,c)  (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1579 #define Newxz(v,n,t)    (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
1580
1581 #ifndef PERL_CORE
1582 /* pre 5.9.x compatibility */
1583 #define New(x,v,n,t)    Newx(v,n,t)
1584 #define Newc(x,v,n,t,c) Newxc(v,n,t,c)
1585 #define Newz(x,v,n,t)   Newxz(v,n,t)
1586 #endif
1587
1588 #define Renew(v,n,t) \
1589           (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1590 #define Renewc(v,n,t,c) \
1591           (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1592
1593 #ifdef PERL_POISON
1594 #define Safefree(d) \
1595   ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
1596 #else
1597 #define Safefree(d)     safefree(MEM_LOG_FREE((Malloc_t)(d)))
1598 #endif
1599
1600 #define Move(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1601 #define Copy(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1602 #define Zero(d,n,t)     (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
1603
1604 #define MoveD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1605 #define CopyD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1606 #ifdef HAS_MEMSET
1607 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
1608 #else
1609 /* Using bzero(), which returns void.  */
1610 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
1611 #endif
1612
1613 #define PoisonWith(d,n,t,b)     (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
1614 #define PoisonNew(d,n,t)        PoisonWith(d,n,t,0xAB)
1615 #define PoisonFree(d,n,t)       PoisonWith(d,n,t,0xEF)
1616 #define Poison(d,n,t)           PoisonFree(d,n,t)
1617
1618 #ifdef USE_STRUCT_COPY
1619 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
1620 #else
1621 #define StructCopy(s,d,t) Copy(s,d,1,t)
1622 #endif
1623
1624 #define C_ARRAY_LENGTH(a)       (sizeof(a)/sizeof((a)[0]))
1625 #define C_ARRAY_END(a)          (a) + (sizeof(a)/sizeof((a)[0]))
1626
1627 #ifdef NEED_VA_COPY
1628 # ifdef va_copy
1629 #  define Perl_va_copy(s, d) va_copy(d, s)
1630 # else
1631 #  if defined(__va_copy)
1632 #   define Perl_va_copy(s, d) __va_copy(d, s)
1633 #  else
1634 #   define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
1635 #  endif
1636 # endif
1637 #endif
1638
1639 /* convenience debug macros */
1640 #ifdef USE_ITHREADS
1641 #define pTHX_FORMAT  "Perl interpreter: 0x%p"
1642 #define pTHX__FORMAT ", Perl interpreter: 0x%p"
1643 #define pTHX_VALUE_   (void *)my_perl,
1644 #define pTHX_VALUE    (void *)my_perl
1645 #define pTHX__VALUE_ ,(void *)my_perl,
1646 #define pTHX__VALUE  ,(void *)my_perl
1647 #else
1648 #define pTHX_FORMAT
1649 #define pTHX__FORMAT
1650 #define pTHX_VALUE_
1651 #define pTHX_VALUE
1652 #define pTHX__VALUE_
1653 #define pTHX__VALUE
1654 #endif /* USE_ITHREADS */
1655
1656 /* Perl_deprecate was not part of the public API, and did not have a deprecate()
1657    shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
1658    CPAN::Unpack show any users outside the core.  */
1659 #ifdef PERL_CORE
1660 #  define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
1661 #endif
1662
1663 #endif  /* HANDY_H */
1664
1665 /*
1666  * Local variables:
1667  * c-indentation-style: bsd
1668  * c-basic-offset: 4
1669  * indent-tabs-mode: nil
1670  * End:
1671  *
1672  * ex: set ts=8 sts=4 sw=4 et:
1673  */