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 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 #if !defined(__STDC__)
  12 #ifdef NULL
  13 #undef NULL
  14 #endif
  15 #ifndef I286
  16 #  define NULL 0
  17 #else
  18 #  define NULL 0L
  19 #endif
  20 #endif
  21
  22 #ifndef PERL_CORE
  23 #  define Null(type) ((type)NULL)
  24
  25 /*
  26 =head1 Handy Values
  27
  28 =for apidoc AmU||Nullch
  29 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
  30
  31 =for apidoc AmU||Nullsv
  32 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
  33
  34 =cut
  35 */
  36
  37 #  define Nullch Null(char*)
  38 #  define Nullfp Null(PerlIO*)
  39 #  define Nullsv Null(SV*)
  40 #endif
  41
  42 #ifdef TRUE
  43 #undef TRUE
  44 #endif
  45 #ifdef FALSE
  46 #undef FALSE
  47 #endif
  48 #define TRUE (1)
  49 #define FALSE (0)
  50
  51 /* The MUTABLE_*() macros cast pointers to the types shown, in such a way
  52  * (compiler permitting) that casting away const-ness will give a warning;
  53  * e.g.:
  54  *
  55  * const SV *sv = ...;
  56  * AV *av1 = (AV*)sv;        <== BAD:  the const has been silently cast away
  57  * AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
  58  */
  59
  60 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
  61 #  define MUTABLE_PTR(p) ({ void *_p = (p); _p; })
  62 #else
  63 #  define MUTABLE_PTR(p) ((void *) (p))
  64 #endif
  65
  66 #define MUTABLE_AV(p)   ((AV *)MUTABLE_PTR(p))
  67 #define MUTABLE_CV(p)   ((CV *)MUTABLE_PTR(p))
  68 #define MUTABLE_GV(p)   ((GV *)MUTABLE_PTR(p))
  69 #define MUTABLE_HV(p)   ((HV *)MUTABLE_PTR(p))
  70 #define MUTABLE_IO(p)   ((IO *)MUTABLE_PTR(p))
  71 #define MUTABLE_SV(p)   ((SV *)MUTABLE_PTR(p))
  72
  73 /* XXX Configure ought to have a test for a boolean type, if I can
  74    just figure out all the headers such a test needs.
  75    Andy Dougherty       August 1996
  76 */
  77 /* bool is built-in for g++-2.6.3 and later, which might be used
  78    for extensions.  <_G_config.h> defines _G_HAVE_BOOL, but we can't
  79    be sure _G_config.h will be included before this file.  _G_config.h
  80    also defines _G_HAVE_BOOL for both gcc and g++, but only g++
  81    actually has bool.  Hence, _G_HAVE_BOOL is pretty useless for us.
  82    g++ can be identified by __GNUG__.
  83    Andy Dougherty       February 2000
  84 */
  85 #ifdef __GNUG__         /* GNU g++ has bool built-in */
  86 #  ifndef HAS_BOOL
  87 #    define HAS_BOOL 1
  88 #  endif
  89 #endif
  90
  91 /* The NeXT dynamic loader headers will not build with the bool macro
  92    So declare them now to clear confusion.
  93 */
  94 #if defined(NeXT) || defined(__NeXT__)
  95 # undef FALSE
  96 # undef TRUE
  97   typedef enum bool { FALSE = 0, TRUE = 1 } bool;
  98 # define ENUM_BOOL 1
  99 # ifndef HAS_BOOL
 100 #  define HAS_BOOL 1
 101 # endif /* !HAS_BOOL */
 102 #endif /* NeXT || __NeXT__ */
 103
 104 #ifndef HAS_BOOL
 105 # if defined(UTS) || defined(VMS)
 106 #  define bool int
 107 # else
 108 #  define bool char
 109 # endif
 110 # define HAS_BOOL 1
 111 #endif
 112
 113 /* a simple (bool) cast may not do the right thing: if bool is defined
 114  * as char for example, then the cast from int is implementation-defined
 115  */
 116
 117 #define cBOOL(cbool) ((bool)!!(cbool))
 118
 119 /* Try to figure out __func__ or __FUNCTION__ equivalent, if any.
 120  * XXX Should really be a Configure probe, with HAS__FUNCTION__
 121  *     and FUNCTION__ as results.
 122  * XXX Similarly, a Configure probe for __FILE__ and __LINE__ is needed. */
 123 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || (defined(__SUNPRO_C)) /* C99 or close enough. */
 124 #  define FUNCTION__ __func__
 125 #else
 126 #  if (defined(_MSC_VER) && _MSC_VER < 1300) || /* Pre-MSVC 7.0 has neither __func__ nor __FUNCTION and no good workarounds, either. */ \
 127       (defined(__DECC_VER)) /* Tru64 or VMS, and strict C89 being used, but not modern enough cc (in Tur64, -c99 not known, only -std1). */
 128 #    define FUNCTION__ ""
 129 #  else
 130 #    define FUNCTION__ __FUNCTION__ /* Common extension. */
 131 #  endif
 132 #endif
 133
 134 /* XXX A note on the perl source internal type system.  The
 135    original intent was that I32 be *exactly* 32 bits.
 136
 137    Currently, we only guarantee that I32 is *at least* 32 bits.
 138    Specifically, if int is 64 bits, then so is I32.  (This is the case
 139    for the Cray.)  This has the advantage of meshing nicely with
 140    standard library calls (where we pass an I32 and the library is
 141    expecting an int), but the disadvantage that an I32 is not 32 bits.
 142    Andy Dougherty       August 1996
 143
 144    There is no guarantee that there is *any* integral type with
 145    exactly 32 bits.  It is perfectly legal for a system to have
 146    sizeof(short) == sizeof(int) == sizeof(long) == 8.
 147
 148    Similarly, there is no guarantee that I16 and U16 have exactly 16
 149    bits.
 150
 151    For dealing with issues that may arise from various 32/64-bit
 152    systems, we will ask Configure to check out
 153
 154         SHORTSIZE == sizeof(short)
 155         INTSIZE == sizeof(int)
 156         LONGSIZE == sizeof(long)
 157         LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
 158         PTRSIZE == sizeof(void *)
 159         DOUBLESIZE == sizeof(double)
 160         LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
 161
 162 */
 163
 164 #ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
 165 #   include <inttypes.h>
 166 #   ifdef INT32_MIN_BROKEN
 167 #       undef  INT32_MIN
 168 #       define INT32_MIN (-2147483647-1)
 169 #   endif
 170 #   ifdef INT64_MIN_BROKEN
 171 #       undef  INT64_MIN
 172 #       define INT64_MIN (-9223372036854775807LL-1)
 173 #   endif
 174 #endif
 175
 176 typedef I8TYPE I8;
 177 typedef U8TYPE U8;
 178 typedef I16TYPE I16;
 179 typedef U16TYPE U16;
 180 typedef I32TYPE I32;
 181 typedef U32TYPE U32;
 182 #ifdef PERL_CORE
 183 #   ifdef HAS_QUAD
 184 typedef I64TYPE I64;
 185 typedef U64TYPE U64;
 186 #   endif
 187 #endif /* PERL_CORE */
 188
 189 #if defined(HAS_QUAD) && defined(USE_64_BIT_INT)
 190 #   ifndef UINT64_C /* usually from <inttypes.h> */
 191 #       if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
 192 #           define INT64_C(c)   CAT2(c,LL)
 193 #           define UINT64_C(c)  CAT2(c,ULL)
 194 #       else
 195 #           if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
 196 #               define INT64_C(c)       CAT2(c,L)
 197 #               define UINT64_C(c)      CAT2(c,UL)
 198 #           else
 199 #               if defined(_WIN64) && defined(_MSC_VER)
 200 #                   define INT64_C(c)   CAT2(c,I64)
 201 #                   define UINT64_C(c)  CAT2(c,UI64)
 202 #               else
 203 #                   define INT64_C(c)   ((I64TYPE)(c))
 204 #                   define UINT64_C(c)  ((U64TYPE)(c))
 205 #               endif
 206 #           endif
 207 #       endif
 208 #   endif
 209 #endif
 210
 211 /* HMB H.Merijn Brand - a placeholder for preparing Configure patches:
 212  *
 213  * USE_DTRACE   HAS_PSEUDOFORK  HAS_TIMEGM      LOCALTIME_R_NEEDS_TZSET
 214  * GMTIME_MAX   GMTIME_MIN      LOCALTIME_MAX   LOCALTIME_MIN
 215  * HAS_CTIME64  HAS_LOCALTIME64 HAS_GMTIME64    HAS_DIFFTIME64
 216  * HAS_MKTIME64 HAS_ASCTIME64   HAS_GETADDRINFO HAS_GETNAMEINFO
 217  * HAS_INETNTOP HAS_INETPTON    CHARBITS        HAS_PRCTL
 218  * Not (yet) used at top level, but mention them for metaconfig
 219  */
 220
 221 /* Mention I8SIZE, U8SIZE, I16SIZE, U16SIZE, I32SIZE, U32SIZE,
 222    I64SIZE, and U64SIZE here so that metaconfig pulls them in. */
 223
 224 #if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
 225
 226 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
 227    Please search CHAR_MAX in perl.h for further details. */
 228 #define U8_MAX UINT8_MAX
 229 #define U8_MIN UINT8_MIN
 230
 231 #define I16_MAX INT16_MAX
 232 #define I16_MIN INT16_MIN
 233 #define U16_MAX UINT16_MAX
 234 #define U16_MIN UINT16_MIN
 235
 236 #define I32_MAX INT32_MAX
 237 #define I32_MIN INT32_MIN
 238 #ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
 239 #  define U32_MAX UINT32_MAX
 240 #else
 241 #  define U32_MAX 4294967295U
 242 #endif
 243 #define U32_MIN UINT32_MIN
 244
 245 #else
 246
 247 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
 248    Please search CHAR_MAX in perl.h for further details. */
 249 #define U8_MAX PERL_UCHAR_MAX
 250 #define U8_MIN PERL_UCHAR_MIN
 251
 252 #define I16_MAX PERL_SHORT_MAX
 253 #define I16_MIN PERL_SHORT_MIN
 254 #define U16_MAX PERL_USHORT_MAX
 255 #define U16_MIN PERL_USHORT_MIN
 256
 257 #if LONGSIZE > 4
 258 # define I32_MAX PERL_INT_MAX
 259 # define I32_MIN PERL_INT_MIN
 260 # define U32_MAX PERL_UINT_MAX
 261 # define U32_MIN PERL_UINT_MIN
 262 #else
 263 # define I32_MAX PERL_LONG_MAX
 264 # define I32_MIN PERL_LONG_MIN
 265 # define U32_MAX PERL_ULONG_MAX
 266 # define U32_MIN PERL_ULONG_MIN
 267 #endif
 268
 269 #endif
 270
 271 /* log(2) is pretty close to  0.30103, just in case anyone is grepping for it */
 272 #define BIT_DIGITS(N)   (((N)*146)/485 + 1)  /* log2(10) =~ 146/485 */
 273 #define TYPE_DIGITS(T)  BIT_DIGITS(sizeof(T) * 8)
 274 #define TYPE_CHARS(T)   (TYPE_DIGITS(T) + 2) /* sign, NUL */
 275
 276 #define Ctl(ch) ((ch) & 037)
 277
 278 /*
 279 =head1 SV-Body Allocation
 280
 281 =for apidoc Ama|SV*|newSVpvs|const char* s
 282 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
 283
 284 =for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags
 285 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
 286 pair.
 287
 288 =for apidoc Ama|SV*|newSVpvs_share|const char* s
 289 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
 290 pair and omits the hash parameter.
 291
 292 =for apidoc Am|void|sv_catpvs|SV* sv|const char* s
 293 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
 294
 295 =for apidoc Am|void|sv_setpvs|SV* sv|const char* s
 296 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
 297
 298 =head1 Memory Management
 299
 300 =for apidoc Ama|char*|savepvs|const char* s
 301 Like C<savepvn>, but takes a literal string instead of a string/length pair.
 302
 303 =head1 GV Functions
 304
 305 =for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create
 306 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
 307
 308 =head1 Hash Manipulation Functions
 309
 310 =for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval
 311 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
 312
 313 =for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val
 314 Like C<hv_store>, but takes a literal string instead of a string/length pair
 315 and omits the hash parameter.
 316
 317 =head1 Lexer interface
 318
 319 =for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags
 320
 321 Like L</lex_stuff_pvn>, but takes a literal string instead of a
 322 string/length pair.
 323
 324 =cut
 325 */
 326
 327 /* concatenating with "" ensures that only literal strings are accepted as argument */
 328 #define STR_WITH_LEN(s)  ("" s ""), (sizeof(s)-1)
 329
 330 /* note that STR_WITH_LEN() can't be used as argument to macros or functions that
 331  * under some configurations might be macros, which means that it requires the full
 332  * Perl_xxx(aTHX_ ...) form for any API calls where it's used.
 333  */
 334
 335 /* STR_WITH_LEN() shortcuts */
 336 #define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str))
 337 #define newSVpvs_flags(str,flags)       \
 338     Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags)
 339 #define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0)
 340 #define sv_catpvs(sv, str) Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC)
 341 #define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str))
 342 #define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str))
 343 #define gv_stashpvs(str, create) Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create)
 344 #define gv_fetchpvs(namebeg, add, sv_type) Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type)
 345 #define hv_fetchs(hv,key,lval)                                          \
 346   ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0,        \
 347                          (lval) ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)  \
 348                          : HV_FETCH_JUST_SV, NULL, 0))
 349
 350 #define hv_stores(hv,key,val)                                           \
 351   ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0,        \
 352                          (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), 0))
 353
 354 #define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
 355
 356 #define get_cvs(str, flags)                                     \
 357         Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
 358
 359 /*
 360 =head1 Miscellaneous Functions
 361
 362 =for apidoc Am|bool|strNE|char* s1|char* s2
 363 Test two strings to see if they are different.  Returns true or
 364 false.
 365
 366 =for apidoc Am|bool|strEQ|char* s1|char* s2
 367 Test two strings to see if they are equal.  Returns true or false.
 368
 369 =for apidoc Am|bool|strLT|char* s1|char* s2
 370 Test two strings to see if the first, C<s1>, is less than the second,
 371 C<s2>.  Returns true or false.
 372
 373 =for apidoc Am|bool|strLE|char* s1|char* s2
 374 Test two strings to see if the first, C<s1>, is less than or equal to the
 375 second, C<s2>.  Returns true or false.
 376
 377 =for apidoc Am|bool|strGT|char* s1|char* s2
 378 Test two strings to see if the first, C<s1>, is greater than the second,
 379 C<s2>.  Returns true or false.
 380
 381 =for apidoc Am|bool|strGE|char* s1|char* s2
 382 Test two strings to see if the first, C<s1>, is greater than or equal to
 383 the second, C<s2>.  Returns true or false.
 384
 385 =for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
 386 Test two strings to see if they are different.  The C<len> parameter
 387 indicates the number of bytes to compare.  Returns true or false. (A
 388 wrapper for C<strncmp>).
 389
 390 =for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
 391 Test two strings to see if they are equal.  The C<len> parameter indicates
 392 the number of bytes to compare.  Returns true or false. (A wrapper for
 393 C<strncmp>).
 394
 395 =cut
 396 */
 397
 398 #define strNE(s1,s2) (strcmp(s1,s2))
 399 #define strEQ(s1,s2) (!strcmp(s1,s2))
 400 #define strLT(s1,s2) (strcmp(s1,s2) < 0)
 401 #define strLE(s1,s2) (strcmp(s1,s2) <= 0)
 402 #define strGT(s1,s2) (strcmp(s1,s2) > 0)
 403 #define strGE(s1,s2) (strcmp(s1,s2) >= 0)
 404 #define strnNE(s1,s2,l) (strncmp(s1,s2,l))
 405 #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
 406
 407 #ifdef HAS_MEMCMP
 408 #  define memNE(s1,s2,l) (memcmp(s1,s2,l))
 409 #  define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
 410 #else
 411 #  define memNE(s1,s2,l) (bcmp(s1,s2,l))
 412 #  define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
 413 #endif
 414
 415 #define memEQs(s1, l, s2) \
 416         (sizeof(s2)-1 == l && memEQ(s1, ("" s2 ""), (sizeof(s2)-1)))
 417 #define memNEs(s1, l, s2) !memEQs(s1, l, s2)
 418
 419 /*
 420  * Character classes.
 421  *
 422  * Unfortunately, the introduction of locales means that we
 423  * can't trust isupper(), etc. to tell the truth.  And when
 424  * it comes to /\w+/ with tainting enabled, we *must* be able
 425  * to trust our character classes.
 426  *
 427  * Therefore, the default tests in the text of Perl will be
 428  * independent of locale.  Any code that wants to depend on
 429  * the current locale will use the tests that begin with "lc".
 430  */
 431
 432 #ifdef HAS_SETLOCALE  /* XXX Is there a better test for this? */
 433 #  ifndef CTYPE256
 434 #    define CTYPE256
 435 #  endif
 436 #endif
 437
 438 /*
 439
 440 =head1 Character classes
 441
 442 =for apidoc Am|bool|isALNUM|char ch
 443 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
 444 alphanumeric character (including underscore) or digit.
 445
 446 =for apidoc Am|bool|isALPHA|char ch
 447 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
 448 alphabetic character.
 449
 450 =for apidoc Am|bool|isSPACE|char ch
 451 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
 452 whitespace.
 453
 454 =for apidoc Am|bool|isDIGIT|char ch
 455 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
 456 digit.
 457
 458 =for apidoc Am|bool|isUPPER|char ch
 459 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
 460 uppercase character.
 461
 462 =for apidoc Am|bool|isLOWER|char ch
 463 Returns a boolean indicating whether the C C<char> is a US-ASCII (Basic Latin)
 464 lowercase character.
 465
 466 =for apidoc Am|char|toUPPER|char ch
 467 Converts the specified character to uppercase.  Characters outside the
 468 US-ASCII (Basic Latin) range are viewed as not having any case.
 469
 470 =for apidoc Am|char|toLOWER|char ch
 471 Converts the specified character to lowercase.  Characters outside the
 472 US-ASCII (Basic Latin) range are viewed as not having any case.
 473
 474 =cut
 475
 476 NOTE:  Since some of these are macros, there is no check in those that the
 477 parameter is a char or U8.  This means that if called with a larger width
 478 parameter, casts can silently truncate and yield wrong results.
 479
 480 Also note that these macros are repeated in Devel::PPPort, so should also be
 481 patched there.  The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
 482
 483 */
 484
 485 /* FITS_IN_8_BITS(c) returns true if c occupies no more than 8 bits.  It is
 486  * designed to be hopefully bomb-proof, making sure that no bits of
 487  * information are lost even on a 64-bit machine, but to get the compiler to
 488  * optimize it out if possible.  This is because Configure makes sure that the
 489  * machine has an 8-bit byte, so if c is stored in a byte, the sizeof()
 490  * guarantees that this evaluates to a constant true at compile time.  The use
 491  * of the mask instead of '< 256' keeps gcc from complaining that it is alway
 492  * true, when c's storage class is a byte */
 493 #ifdef HAS_QUAD
 494 #  define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || (((U64)(c) & 0xFF) == (U64)(c)))
 495 #else
 496 #  define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || (((U32)(c) & 0xFF) == (U32)(c)))
 497 #endif
 498
 499 #define isALNUM(c)      (isALPHA(c) || isDIGIT(c) || (c) == '_')
 500 #define isIDFIRST(c)    (isALPHA(c) || (c) == '_')
 501 #define isALPHA(c)      (isUPPER(c) || isLOWER(c))
 502 /* ALPHAU includes Unicode semantics for latin1 characters.  It has an extra
 503  * >= AA test to speed up ASCII-only tests at the expense of the others */
 504 #define isALPHAU(c)     (isALPHA(c) || (NATIVE_TO_UNI((U8) c) >= 0xAA \
 505     && ((NATIVE_TO_UNI((U8) c) >= 0xC0 \
 506             && NATIVE_TO_UNI((U8) c) != 0xD7 && NATIVE_TO_UNI((U8) c) != 0xF7) \
 507         || NATIVE_TO_UNI((U8) c) == 0xAA \
 508         || NATIVE_TO_UNI((U8) c) == 0xB5 \
 509         || NATIVE_TO_UNI((U8) c) == 0xBA)))
 510 #define isALNUMU(c)     (isDIGIT(c) || isALPHAU(c) || (c) == '_')
 511
 512 /* continuation character for legal NAME in \N{NAME} */
 513 #define isCHARNAME_CONT(c) (isALNUMU(c) || (c) == ' ' || (c) == '-' || (c) == '(' || (c) == ')' || (c) == ':' || NATIVE_TO_UNI((U8) c) == 0xA0)
 514 #define isSPACE(c) \
 515         ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
 516 #define isPSXSPC(c)     (isSPACE(c) || (c) == '\v')
 517 #define isBLANK(c)      ((c) == ' ' || (c) == '\t')
 518 #define isDIGIT(c)      ((c) >= '0' && (c) <= '9')
 519 #ifdef EBCDIC
 520     /* In EBCDIC we do not do locales: therefore() isupper() is fine. */
 521 #   define isUPPER(c)   isupper(c)
 522 #   define isLOWER(c)   islower(c)
 523 #   define isALNUMC(c)  isalnum(c)
 524 #   define isASCII(c)   isascii(c)
 525 #   define isCNTRL(c)   iscntrl(c)
 526 #   define isGRAPH(c)   isgraph(c)
 527 #   define isPRINT(c)   isprint(c)
 528 #   define isPUNCT(c)   ispunct(c)
 529 #   define isXDIGIT(c)  isxdigit(c)
 530 #   define toUPPER(c)   toupper(c)
 531 #   define toUPPER_LATIN1_MOD(c)    UNI_TO_NATIVE(PL_mod_latin1_uc[(U8) NATIVE_TO_UNI(c)])
 532 #   define toLOWER(c)   tolower(c)
 533 #   define toLOWER_LATIN1(c)    UNI_TO_NATIVE(PL_latin1_lc[(U8) NATIVE_TO_UNI(c)])
 534 #else
 535 #   define isUPPER(c)   ((c) >= 'A' && (c) <= 'Z')
 536 #   define isLOWER(c)   ((c) >= 'a' && (c) <= 'z')
 537 #   define isALNUMC(c)  (isALPHA(c) || isDIGIT(c))
 538 #   define isASCII(c)   ((U8) (c) <= 127)
 539 #   define isCNTRL(c)   ((U8) (c) < ' ' || (c) == 127)
 540 #   define isGRAPH(c)   (isALNUM(c) || isPUNCT(c))
 541 #   define isPRINT(c)   (((c) >= 32 && (c) < 127))
 542 #   define isPUNCT(c)   (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64)  || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
 543 #   define isXDIGIT(c)  (isDIGIT(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F'))
 544
 545 /* Use table lookup for speed */
 546 #   define toLOWER_LATIN1(c)    (PL_latin1_lc[(U8) c])
 547
 548 /* Modified uc.  Is correct uc except for three non-ascii chars which are
 549  * all mapped to one of them, and these need special handling */
 550 #   define toUPPER_LATIN1_MOD(c)    (PL_mod_latin1_uc[(U8) c])
 551
 552 /* ASCII casing. */
 553 #   define toUPPER(c)   (isLOWER(c) ? (c) - ('a' - 'A') : (c))
 554 #   define toLOWER(c)   (isUPPER(c) ? (c) + ('a' - 'A') : (c))
 555 #endif
 556
 557 #ifdef USE_NEXT_CTYPE
 558
 559 #  define isALNUM_LC(c) \
 560         (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
 561 #  define isIDFIRST_LC(c) \
 562         (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
 563 #  define isALPHA_LC(c)         NXIsAlpha((unsigned int)(c))
 564 #  define isSPACE_LC(c)         NXIsSpace((unsigned int)(c))
 565 #  define isDIGIT_LC(c)         NXIsDigit((unsigned int)(c))
 566 #  define isUPPER_LC(c)         NXIsUpper((unsigned int)(c))
 567 #  define isLOWER_LC(c)         NXIsLower((unsigned int)(c))
 568 #  define isALNUMC_LC(c)        NXIsAlNum((unsigned int)(c))
 569 #  define isCNTRL_LC(c)         NXIsCntrl((unsigned int)(c))
 570 #  define isGRAPH_LC(c)         NXIsGraph((unsigned int)(c))
 571 #  define isPRINT_LC(c)         NXIsPrint((unsigned int)(c))
 572 #  define isPUNCT_LC(c)         NXIsPunct((unsigned int)(c))
 573 #  define toUPPER_LC(c)         NXToUpper((unsigned int)(c))
 574 #  define toLOWER_LC(c)         NXToLower((unsigned int)(c))
 575
 576 #else /* !USE_NEXT_CTYPE */
 577
 578 #  if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
 579
 580 #    define isALNUM_LC(c)   (isalnum((unsigned char)(c)) || (char)(c) == '_')
 581 #    define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
 582 #    define isALPHA_LC(c)       isalpha((unsigned char)(c))
 583 #    define isSPACE_LC(c)       isspace((unsigned char)(c))
 584 #    define isDIGIT_LC(c)       isdigit((unsigned char)(c))
 585 #    define isUPPER_LC(c)       isupper((unsigned char)(c))
 586 #    define isLOWER_LC(c)       islower((unsigned char)(c))
 587 #    define isALNUMC_LC(c)      isalnum((unsigned char)(c))
 588 #    define isCNTRL_LC(c)       iscntrl((unsigned char)(c))
 589 #    define isGRAPH_LC(c)       isgraph((unsigned char)(c))
 590 #    define isPRINT_LC(c)       isprint((unsigned char)(c))
 591 #    define isPUNCT_LC(c)       ispunct((unsigned char)(c))
 592 #    define toUPPER_LC(c)       toupper((unsigned char)(c))
 593 #    define toLOWER_LC(c)       tolower((unsigned char)(c))
 594
 595 #  else
 596
 597 #    define isALNUM_LC(c)       (isascii(c) && (isalnum(c) || (c) == '_'))
 598 #    define isIDFIRST_LC(c)     (isascii(c) && (isalpha(c) || (c) == '_'))
 599 #    define isALPHA_LC(c)       (isascii(c) && isalpha(c))
 600 #    define isSPACE_LC(c)       (isascii(c) && isspace(c))
 601 #    define isDIGIT_LC(c)       (isascii(c) && isdigit(c))
 602 #    define isUPPER_LC(c)       (isascii(c) && isupper(c))
 603 #    define isLOWER_LC(c)       (isascii(c) && islower(c))
 604 #    define isALNUMC_LC(c)      (isascii(c) && isalnum(c))
 605 #    define isCNTRL_LC(c)       (isascii(c) && iscntrl(c))
 606 #    define isGRAPH_LC(c)       (isascii(c) && isgraph(c))
 607 #    define isPRINT_LC(c)       (isascii(c) && isprint(c))
 608 #    define isPUNCT_LC(c)       (isascii(c) && ispunct(c))
 609 #    define toUPPER_LC(c)       toupper(c)
 610 #    define toLOWER_LC(c)       tolower(c)
 611
 612 #  endif
 613 #endif /* USE_NEXT_CTYPE */
 614
 615 #define isPSXSPC_LC(c)          (isSPACE_LC(c) || (c) == '\v')
 616 #define isBLANK_LC(c)           isBLANK(c) /* could be wrong */
 617
 618 #define isALNUM_uni(c)          is_uni_alnum(c)
 619 #define isIDFIRST_uni(c)        is_uni_idfirst(c)
 620 #define isALPHA_uni(c)          is_uni_alpha(c)
 621 #define isSPACE_uni(c)          is_uni_space(c)
 622 #define isDIGIT_uni(c)          is_uni_digit(c)
 623 #define isUPPER_uni(c)          is_uni_upper(c)
 624 #define isLOWER_uni(c)          is_uni_lower(c)
 625 #define isASCII_uni(c)          is_uni_ascii(c)
 626 #define isCNTRL_uni(c)          is_uni_cntrl(c)
 627 #define isGRAPH_uni(c)          is_uni_graph(c)
 628 #define isPRINT_uni(c)          is_uni_print(c)
 629 #define isPUNCT_uni(c)          is_uni_punct(c)
 630 #define isXDIGIT_uni(c)         is_uni_xdigit(c)
 631 #define toUPPER_uni(c,s,l)      to_uni_upper(c,s,l)
 632 #define toTITLE_uni(c,s,l)      to_uni_title(c,s,l)
 633 #define toLOWER_uni(c,s,l)      to_uni_lower(c,s,l)
 634 #define toFOLD_uni(c,s,l)       to_uni_fold(c,s,l)
 635
 636 #define isPSXSPC_uni(c)         (isSPACE_uni(c) ||(c) == '\f')
 637 #define isBLANK_uni(c)          isBLANK(c) /* could be wrong */
 638
 639 #define isALNUM_LC_uvchr(c)     (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
 640 #define isIDFIRST_LC_uvchr(c)   (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
 641 #define isALPHA_LC_uvchr(c)     (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
 642 #define isSPACE_LC_uvchr(c)     (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
 643 #define isDIGIT_LC_uvchr(c)     (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
 644 #define isUPPER_LC_uvchr(c)     (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
 645 #define isLOWER_LC_uvchr(c)     (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
 646 #define isCNTRL_LC_uvchr(c)     (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
 647 #define isGRAPH_LC_uvchr(c)     (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
 648 #define isPRINT_LC_uvchr(c)     (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
 649 #define isPUNCT_LC_uvchr(c)     (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
 650
 651 #define isPSXSPC_LC_uni(c)      (isSPACE_LC_uni(c) ||(c) == '\f')
 652 #define isBLANK_LC_uni(c)       isBLANK(c) /* could be wrong */
 653
 654 #define isALNUM_utf8(p)         is_utf8_alnum(p)
 655 /* The ID_Start of Unicode is quite limiting: it assumes a L-class
 656  * character (meaning that you cannot have, say, a CJK character).
 657  * Instead, let's allow ID_Continue but not digits. */
 658 #define isIDFIRST_utf8(p)       (is_utf8_idcont(p) && !is_utf8_digit(p))
 659 #define isALPHA_utf8(p)         is_utf8_alpha(p)
 660 #define isSPACE_utf8(p)         is_utf8_space(p)
 661 #define isDIGIT_utf8(p)         is_utf8_digit(p)
 662 #define isUPPER_utf8(p)         is_utf8_upper(p)
 663 #define isLOWER_utf8(p)         is_utf8_lower(p)
 664 #define isASCII_utf8(p)         is_utf8_ascii(p)
 665 #define isCNTRL_utf8(p)         is_utf8_cntrl(p)
 666 #define isGRAPH_utf8(p)         is_utf8_graph(p)
 667 #define isPRINT_utf8(p)         is_utf8_print(p)
 668 #define isPUNCT_utf8(p)         is_utf8_punct(p)
 669 #define isXDIGIT_utf8(p)        is_utf8_xdigit(p)
 670 #define toUPPER_utf8(p,s,l)     to_utf8_upper(p,s,l)
 671 #define toTITLE_utf8(p,s,l)     to_utf8_title(p,s,l)
 672 #define toLOWER_utf8(p,s,l)     to_utf8_lower(p,s,l)
 673
 674 #define isPSXSPC_utf8(c)        (isSPACE_utf8(c) ||(c) == '\f')
 675 #define isBLANK_utf8(c)         isBLANK(c) /* could be wrong */
 676
 677 #define isALNUM_LC_utf8(p)      isALNUM_LC_uvchr(utf8_to_uvchr(p,  0))
 678 #define isIDFIRST_LC_utf8(p)    isIDFIRST_LC_uvchr(utf8_to_uvchr(p,  0))
 679 #define isALPHA_LC_utf8(p)      isALPHA_LC_uvchr(utf8_to_uvchr(p,  0))
 680 #define isSPACE_LC_utf8(p)      isSPACE_LC_uvchr(utf8_to_uvchr(p,  0))
 681 #define isDIGIT_LC_utf8(p)      isDIGIT_LC_uvchr(utf8_to_uvchr(p,  0))
 682 #define isUPPER_LC_utf8(p)      isUPPER_LC_uvchr(utf8_to_uvchr(p,  0))
 683 #define isLOWER_LC_utf8(p)      isLOWER_LC_uvchr(utf8_to_uvchr(p,  0))
 684 #define isALNUMC_LC_utf8(p)     isALNUMC_LC_uvchr(utf8_to_uvchr(p,  0))
 685 #define isCNTRL_LC_utf8(p)      isCNTRL_LC_uvchr(utf8_to_uvchr(p,  0))
 686 #define isGRAPH_LC_utf8(p)      isGRAPH_LC_uvchr(utf8_to_uvchr(p,  0))
 687 #define isPRINT_LC_utf8(p)      isPRINT_LC_uvchr(utf8_to_uvchr(p,  0))
 688 #define isPUNCT_LC_utf8(p)      isPUNCT_LC_uvchr(utf8_to_uvchr(p,  0))
 689
 690 #define isPSXSPC_LC_utf8(c)     (isSPACE_LC_utf8(c) ||(c) == '\f')
 691 #define isBLANK_LC_utf8(c)      isBLANK(c) /* could be wrong */
 692
 693 /* This conversion works both ways, strangely enough. On EBCDIC platforms,
 694  * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII */
 695 #  define toCTRL(c)    (toUPPER(NATIVE_TO_UNI(c)) ^ 64)
 696
 697 /* Line numbers are unsigned, 32 bits. */
 698 typedef U32 line_t;
 699 #define NOLINE ((line_t) 4294967295UL)
 700
 701 /* Helpful alias for version prescan */
 702 #define is_LAX_VERSION(a,b) \
 703         (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
 704
 705 #define is_STRICT_VERSION(a,b) \
 706         (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
 707
 708 #define BADVERSION(a,b,c) \
 709         if (b) { \
 710             *b = c; \
 711         } \
 712         return a;
 713
 714 /*
 715 =head1 Memory Management
 716
 717 =for apidoc Am|void|Newx|void* ptr|int nitems|type
 718 The XSUB-writer's interface to the C C<malloc> function.
 719
 720 In 5.9.3, Newx() and friends replace the older New() API, and drops
 721 the first parameter, I<x>, a debug aid which allowed callers to identify
 722 themselves.  This aid has been superseded by a new build option,
 723 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>).  The older API is still
 724 there for use in XS modules supporting older perls.
 725
 726 =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
 727 The XSUB-writer's interface to the C C<malloc> function, with
 728 cast.  See also C<Newx>.
 729
 730 =for apidoc Am|void|Newxz|void* ptr|int nitems|type
 731 The XSUB-writer's interface to the C C<malloc> function.  The allocated
 732 memory is zeroed with C<memzero>.  See also C<Newx>.
 733
 734 =for apidoc Am|void|Renew|void* ptr|int nitems|type
 735 The XSUB-writer's interface to the C C<realloc> function.
 736
 737 =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
 738 The XSUB-writer's interface to the C C<realloc> function, with
 739 cast.
 740
 741 =for apidoc Am|void|Safefree|void* ptr
 742 The XSUB-writer's interface to the C C<free> function.
 743
 744 =for apidoc Am|void|Move|void* src|void* dest|int nitems|type
 745 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
 746 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
 747 the type.  Can do overlapping moves.  See also C<Copy>.
 748
 749 =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
 750 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
 751 optimise.
 752
 753 =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
 754 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
 755 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
 756 the type.  May fail on overlapping copies.  See also C<Move>.
 757
 758 =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
 759
 760 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
 761 optimise.
 762
 763 =for apidoc Am|void|Zero|void* dest|int nitems|type
 764
 765 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
 766 destination, C<nitems> is the number of items, and C<type> is the type.
 767
 768 =for apidoc Am|void *|ZeroD|void* dest|int nitems|type
 769
 770 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
 771 optimise.
 772
 773 =for apidoc Am|void|StructCopy|type src|type dest|type
 774 This is an architecture-independent macro to copy one structure to another.
 775
 776 =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
 777
 778 Fill up memory with a byte pattern (a byte repeated over and over
 779 again) that hopefully catches attempts to access uninitialized memory.
 780
 781 =for apidoc Am|void|PoisonNew|void* dest|int nitems|type
 782
 783 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
 784
 785 =for apidoc Am|void|PoisonFree|void* dest|int nitems|type
 786
 787 PoisonWith(0xEF) for catching access to freed memory.
 788
 789 =for apidoc Am|void|Poison|void* dest|int nitems|type
 790
 791 PoisonWith(0xEF) for catching access to freed memory.
 792
 793 =cut */
 794
 795 /* Maintained for backwards-compatibility only. Use newSV() instead. */
 796 #ifndef PERL_CORE
 797 #define NEWSV(x,len)    newSV(len)
 798 #endif
 799
 800 #define MEM_SIZE_MAX ((MEM_SIZE)~0)
 801
 802 /* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
 803  * overly eager compilers that will bleat about e.g.
 804  * (U16)n > (size_t)~0/sizeof(U16) always being false. */
 805 #ifdef PERL_MALLOC_WRAP
 806 #define MEM_WRAP_CHECK(n,t) MEM_WRAP_CHECK_1(n,t,PL_memory_wrap)
 807 #define MEM_WRAP_CHECK_1(n,t,a) \
 808         (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
 809 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
 810
 811 #define PERL_STRLEN_ROUNDUP(n) ((void)(((n) > MEM_SIZE_MAX - 2 * PERL_STRLEN_ROUNDUP_QUANTUM) ? (Perl_croak_nocontext("%s",PL_memory_wrap),0):0),((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
 812
 813 #else
 814
 815 #define MEM_WRAP_CHECK(n,t)
 816 #define MEM_WRAP_CHECK_1(n,t,a)
 817 #define MEM_WRAP_CHECK_2(n,t,a,b)
 818 #define MEM_WRAP_CHECK_(n,t)
 819
 820 #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
 821
 822 #endif
 823
 824 #ifdef PERL_MEM_LOG
 825 /*
 826  * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
 827  * go through functions, which are handy for debugging breakpoints, but
 828  * which more importantly get the immediate calling environment (file and
 829  * line number, and C function name if available) passed in.  This info can
 830  * then be used for logging the calls, for which one gets a sample
 831  * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
 832  *
 833  * Known problems:
 834  * - not all memory allocs get logged, only those
 835  *   that go through Newx() and derivatives (while all
 836  *   Safefrees do get logged)
 837  * - __FILE__ and __LINE__ do not work everywhere
 838  * - __func__ or __FUNCTION__ even less so
 839  * - I think more goes on after the perlio frees but
 840  *   the thing is that STDERR gets closed (as do all
 841  *   the file descriptors)
 842  * - no deeper calling stack than the caller of the Newx()
 843  *   or the kind, but do I look like a C reflection/introspection
 844  *   utility to you?
 845  * - the function prototypes for the logging functions
 846  *   probably should maybe be somewhere else than handy.h
 847  * - one could consider inlining (macrofying) the logging
 848  *   for speed, but I am too lazy
 849  * - one could imagine recording the allocations in a hash,
 850  *   (keyed by the allocation address?), and maintain that
 851  *   through reallocs and frees, but how to do that without
 852  *   any News() happening...?
 853  * - lots of -Ddefines to get useful/controllable output
 854  * - lots of ENV reads
 855  */
 856
 857 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);
 858
 859 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);
 860
 861 PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
 862
 863 # ifdef PERL_CORE
 864 #  ifndef PERL_MEM_LOG_NOIMPL
 865 enum mem_log_type {
 866   MLT_ALLOC,
 867   MLT_REALLOC,
 868   MLT_FREE,
 869   MLT_NEW_SV,
 870   MLT_DEL_SV
 871 };
 872 #  endif
 873 #  if defined(PERL_IN_SV_C)  /* those are only used in sv.c */
 874 void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
 875 void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
 876 #  endif
 877 # endif
 878
 879 #endif
 880
 881 #ifdef PERL_MEM_LOG
 882 #define MEM_LOG_ALLOC(n,t,a)     Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
 883 #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
 884 #define MEM_LOG_FREE(a)          Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
 885 #endif
 886
 887 #ifndef MEM_LOG_ALLOC
 888 #define MEM_LOG_ALLOC(n,t,a)     (a)
 889 #endif
 890 #ifndef MEM_LOG_REALLOC
 891 #define MEM_LOG_REALLOC(n,t,v,a) (a)
 892 #endif
 893 #ifndef MEM_LOG_FREE
 894 #define MEM_LOG_FREE(a)          (a)
 895 #endif
 896
 897 #define Newx(v,n,t)     (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
 898 #define Newxc(v,n,t,c)  (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
 899 #define Newxz(v,n,t)    (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
 900
 901 #ifndef PERL_CORE
 902 /* pre 5.9.x compatibility */
 903 #define New(x,v,n,t)    Newx(v,n,t)
 904 #define Newc(x,v,n,t,c) Newxc(v,n,t,c)
 905 #define Newz(x,v,n,t)   Newxz(v,n,t)
 906 #endif
 907
 908 #define Renew(v,n,t) \
 909           (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
 910 #define Renewc(v,n,t,c) \
 911           (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
 912
 913 #ifdef PERL_POISON
 914 #define Safefree(d) \
 915   ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
 916 #else
 917 #define Safefree(d)     safefree(MEM_LOG_FREE((Malloc_t)(d)))
 918 #endif
 919
 920 #define Move(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
 921 #define Copy(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
 922 #define Zero(d,n,t)     (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
 923
 924 #define MoveD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
 925 #define CopyD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
 926 #ifdef HAS_MEMSET
 927 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
 928 #else
 929 /* Using bzero(), which returns void.  */
 930 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
 931 #endif
 932
 933 #define PoisonWith(d,n,t,b)     (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
 934 #define PoisonNew(d,n,t)        PoisonWith(d,n,t,0xAB)
 935 #define PoisonFree(d,n,t)       PoisonWith(d,n,t,0xEF)
 936 #define Poison(d,n,t)           PoisonFree(d,n,t)
 937
 938 #ifdef USE_STRUCT_COPY
 939 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
 940 #else
 941 #define StructCopy(s,d,t) Copy(s,d,1,t)
 942 #endif
 943
 944 #define C_ARRAY_LENGTH(a)       (sizeof(a)/sizeof((a)[0]))
 945 #define C_ARRAY_END(a)          (a) + (sizeof(a)/sizeof((a)[0]))
 946
 947 #ifdef NEED_VA_COPY
 948 # ifdef va_copy
 949 #  define Perl_va_copy(s, d) va_copy(d, s)
 950 # else
 951 #  if defined(__va_copy)
 952 #   define Perl_va_copy(s, d) __va_copy(d, s)
 953 #  else
 954 #   define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
 955 #  endif
 956 # endif
 957 #endif
 958
 959 /* convenience debug macros */
 960 #ifdef USE_ITHREADS
 961 #define pTHX_FORMAT  "Perl interpreter: 0x%p"
 962 #define pTHX__FORMAT ", Perl interpreter: 0x%p"
 963 #define pTHX_VALUE_   (void *)my_perl,
 964 #define pTHX_VALUE    (void *)my_perl
 965 #define pTHX__VALUE_ ,(void *)my_perl,
 966 #define pTHX__VALUE  ,(void *)my_perl
 967 #else
 968 #define pTHX_FORMAT
 969 #define pTHX__FORMAT
 970 #define pTHX_VALUE_
 971 #define pTHX_VALUE
 972 #define pTHX__VALUE_
 973 #define pTHX__VALUE
 974 #endif /* USE_ITHREADS */
 975
 976 /* Perl_deprecate was not part of the public API, and did not have a deprecate()
 977    shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
 978    CPAN::Unpack show any users outside the core.  */
 979 #ifdef PERL_CORE
 980 #  define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
 981 #endif
 982
 983 /*
 984  * Local variables:
 985  * c-indentation-style: bsd
 986  * c-basic-offset: 4
 987  * indent-tabs-mode: t
 988  * End:
 989  *
 990  * ex: set ts=8 sts=4 sw=4 noet:
 991  */