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 The functions in this section operate using the character set of the platform
 442 Perl is running on, and are unaffected by locale.  For ASCII platforms, they
 443 will all return false for characters outside the ASCII range.  For EBCDIC
 444 platforms, they use the code page of the platform.  The code pages that Perl
 445 knows about all have 8-bit characters, so most of these functions will return
 446 true for more characters than on ASCII platforms.
 447
 448 =for apidoc Am|bool|isALNUM|char ch
 449 Returns a boolean indicating whether the C C<char> is an
 450 alphanumeric character (including underscore) or digit in the platform's native
 451 character set.
 452
 453 =for apidoc Am|bool|isALPHA|char ch
 454 Returns a boolean indicating whether the C C<char> is an
 455 alphabetic character in the platform's native character set.
 456
 457 =for apidoc Am|bool|isSPACE|char ch
 458 Returns a boolean indicating whether the C C<char> is a
 459 whitespace character in the platform's native character set.
 460
 461 =for apidoc Am|bool|isDIGIT|char ch
 462 Returns a boolean indicating whether the C C<char> is a
 463 digit in the platform's native character set.
 464
 465 =for apidoc Am|bool|isOCTAL|char ch
 466 Returns a boolean indicating whether the C C<char> is an
 467 octal digit, [0-7] in the platform's native character set.
 468
 469 =for apidoc Am|bool|isUPPER|char ch
 470 Returns a boolean indicating whether the C C<char> is an
 471 uppercase character in the platform's native character set.
 472
 473 =for apidoc Am|bool|isLOWER|char ch
 474 Returns a boolean indicating whether the C C<char> is a
 475 lowercase character in the platform's native character set.
 476
 477 =head1 Character case changing
 478
 479 =for apidoc Am|char|toUPPER|char ch
 480 Converts the specified character to uppercase in the platform's native
 481 character set, if possible; otherwise returns the input character itself.
 482
 483 =for apidoc Am|char|toLOWER|char ch
 484 Converts the specified character to lowercase in the platform's native
 485 character set, if possible; otherwise returns the input character itself.
 486
 487 =cut
 488
 489 NOTE:  Since some of these are macros, there is no check in those that the
 490 parameter is a char or U8.  This means that if called with a larger width
 491 parameter, casts can silently truncate and yield wrong results.
 492
 493 Also note that these macros are repeated in Devel::PPPort, so should also be
 494 patched there.  The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
 495
 496 */
 497
 498 /* FITS_IN_8_BITS(c) returns true if c occupies no more than 8 bits.  It is
 499  * designed to be hopefully bomb-proof, making sure that no bits of
 500  * information are lost even on a 64-bit machine, but to get the compiler to
 501  * optimize it out if possible.  This is because Configure makes sure that the
 502  * machine has an 8-bit byte, so if c is stored in a byte, the sizeof()
 503  * guarantees that this evaluates to a constant true at compile time.  The use
 504  * of the mask instead of '< 256' keeps gcc from complaining that it is alway
 505  * true, when c's storage class is a byte.  Use U64TYPE because U64 is known
 506  * only in the perl core, and this macro can be called from outside that */
 507 #ifdef HAS_QUAD
 508 #  define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || (((U64TYPE)(c) & 0xFF) == (U64TYPE)(c)))
 509 #else
 510 #  define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || (((U32)(c) & 0xFF) == (U32)(c)))
 511 #endif
 512
 513 #define isALNUM(c)      (isALPHA(c) || isDIGIT(c) || (c) == '_')
 514 #define isIDFIRST(c)    (isALPHA(c) || (c) == '_')
 515 #define isALPHA(c)      (isUPPER(c) || isLOWER(c))
 516 /* ALPHAU includes Unicode semantics for latin1 characters.  It has an extra
 517  * >= AA test to speed up ASCII-only tests at the expense of the others */
 518 #define isALPHAU(c)     (isALPHA(c) || (NATIVE_TO_UNI((U8) c) >= 0xAA \
 519     && ((NATIVE_TO_UNI((U8) c) >= 0xC0 \
 520             && NATIVE_TO_UNI((U8) c) != 0xD7 && NATIVE_TO_UNI((U8) c) != 0xF7) \
 521         || NATIVE_TO_UNI((U8) c) == 0xAA \
 522         || NATIVE_TO_UNI((U8) c) == 0xB5 \
 523         || NATIVE_TO_UNI((U8) c) == 0xBA)))
 524 #define isALNUMU(c)     (isDIGIT(c) || isALPHAU(c) || (c) == '_')
 525
 526 /* continuation character for legal NAME in \N{NAME} */
 527 #define isCHARNAME_CONT(c) (isALNUMU(c) || (c) == ' ' || (c) == '-' || (c) == '(' || (c) == ')' || (c) == ':' || NATIVE_TO_UNI((U8) c) == 0xA0)
 528 #define isSPACE(c) \
 529         ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
 530 #define isPSXSPC(c)     (isSPACE(c) || (c) == '\v')
 531 #define isBLANK(c)      ((c) == ' ' || (c) == '\t')
 532 #define isDIGIT(c)      ((c) >= '0' && (c) <= '9')
 533 #define isOCTAL(c)      ((c) >= '0' && (c) <= '7')
 534 #define isASCII(c)      (FITS_IN_8_BITS(c) ? NATIVE_TO_UNI((U8) c) <= 127 : 0)
 535 #ifdef EBCDIC
 536     /* In EBCDIC we do not do locales: therefore() isupper() is fine. */
 537 #   define isUPPER(c)   isupper(c)
 538 #   define isLOWER(c)   islower(c)
 539 #   define isALNUMC(c)  isalnum(c)
 540 #   define isCNTRL(c)   iscntrl(c)
 541 #   define isGRAPH(c)   isgraph(c)
 542 #   define isPRINT(c)   isprint(c)
 543 #   define isPUNCT(c)   ispunct(c)
 544 #   define isXDIGIT(c)  isxdigit(c)
 545 #   define toUPPER(c)   toupper(c)
 546 #   define toLOWER(c)   tolower(c)
 547 #else
 548 #   define isUPPER(c)   ((c) >= 'A' && (c) <= 'Z')
 549 #   define isLOWER(c)   ((c) >= 'a' && (c) <= 'z')
 550 #   define isALNUMC(c)  (isALPHA(c) || isDIGIT(c))
 551 #   define isCNTRL(c)   ((U8) (c) < ' ' || (c) == 127)
 552 #   define isGRAPH(c)   (isALNUM(c) || isPUNCT(c))
 553 #   define isPRINT(c)   (((c) >= 32 && (c) < 127))
 554 #   define isPUNCT(c)   (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64)  || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
 555 #   define isXDIGIT(c)  (isDIGIT(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F'))
 556
 557
 558     /* Use table lookup for speed; return error character for input
 559      * out-of-range */
 560 #   define toLOWER_LATIN1(c)    (FITS_IN_8_BITS(c)                            \
 561                                 ? UNI_TO_NATIVE(PL_latin1_lc[                 \
 562                                                   NATIVE_TO_UNI( (U8) (c)) ]) \
 563                                 : UNICODE_REPLACEMENT)
 564     /* Modified uc.  Is correct uc except for three non-ascii chars which are
 565      * all mapped to one of them, and these need special handling; error
 566      * character for input out-of-range */
 567 #   define toUPPER_LATIN1_MOD(c) (FITS_IN_8_BITS(c)                           \
 568                                  ? UNI_TO_NATIVE(PL_mod_latin1_uc[            \
 569                                                   NATIVE_TO_UNI( (U8) (c)) ]) \
 570                                  : UNICODE_REPLACEMENT)
 571
 572 /* ASCII casing. */
 573 #   define toUPPER(c)   (isLOWER(c) ? (c) - ('a' - 'A') : (c))
 574 #   define toLOWER(c)   (isUPPER(c) ? (c) + ('a' - 'A') : (c))
 575 #endif
 576
 577 #ifdef USE_NEXT_CTYPE
 578
 579 #  define isALNUM_LC(c) \
 580         (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
 581 #  define isIDFIRST_LC(c) \
 582         (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
 583 #  define isALPHA_LC(c)         NXIsAlpha((unsigned int)(c))
 584 #  define isSPACE_LC(c)         NXIsSpace((unsigned int)(c))
 585 #  define isDIGIT_LC(c)         NXIsDigit((unsigned int)(c))
 586 #  define isUPPER_LC(c)         NXIsUpper((unsigned int)(c))
 587 #  define isLOWER_LC(c)         NXIsLower((unsigned int)(c))
 588 #  define isALNUMC_LC(c)        NXIsAlNum((unsigned int)(c))
 589 #  define isCNTRL_LC(c)         NXIsCntrl((unsigned int)(c))
 590 #  define isGRAPH_LC(c)         NXIsGraph((unsigned int)(c))
 591 #  define isPRINT_LC(c)         NXIsPrint((unsigned int)(c))
 592 #  define isPUNCT_LC(c)         NXIsPunct((unsigned int)(c))
 593 #  define toUPPER_LC(c)         NXToUpper((unsigned int)(c))
 594 #  define toLOWER_LC(c)         NXToLower((unsigned int)(c))
 595
 596 #else /* !USE_NEXT_CTYPE */
 597
 598 #  if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
 599
 600 #    define isALNUM_LC(c)   (isalnum((unsigned char)(c)) || (char)(c) == '_')
 601 #    define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
 602 #    define isALPHA_LC(c)       isalpha((unsigned char)(c))
 603 #    define isSPACE_LC(c)       isspace((unsigned char)(c))
 604 #    define isDIGIT_LC(c)       isdigit((unsigned char)(c))
 605 #    define isUPPER_LC(c)       isupper((unsigned char)(c))
 606 #    define isLOWER_LC(c)       islower((unsigned char)(c))
 607 #    define isALNUMC_LC(c)      isalnum((unsigned char)(c))
 608 #    define isCNTRL_LC(c)       iscntrl((unsigned char)(c))
 609 #    define isGRAPH_LC(c)       isgraph((unsigned char)(c))
 610 #    define isPRINT_LC(c)       isprint((unsigned char)(c))
 611 #    define isPUNCT_LC(c)       ispunct((unsigned char)(c))
 612 #    define toUPPER_LC(c)       toupper((unsigned char)(c))
 613 #    define toLOWER_LC(c)       tolower((unsigned char)(c))
 614
 615 #  else
 616
 617 #    define isALNUM_LC(c)       (isascii(c) && (isalnum(c) || (c) == '_'))
 618 #    define isIDFIRST_LC(c)     (isascii(c) && (isalpha(c) || (c) == '_'))
 619 #    define isALPHA_LC(c)       (isascii(c) && isalpha(c))
 620 #    define isSPACE_LC(c)       (isascii(c) && isspace(c))
 621 #    define isDIGIT_LC(c)       (isascii(c) && isdigit(c))
 622 #    define isUPPER_LC(c)       (isascii(c) && isupper(c))
 623 #    define isLOWER_LC(c)       (isascii(c) && islower(c))
 624 #    define isALNUMC_LC(c)      (isascii(c) && isalnum(c))
 625 #    define isCNTRL_LC(c)       (isascii(c) && iscntrl(c))
 626 #    define isGRAPH_LC(c)       (isascii(c) && isgraph(c))
 627 #    define isPRINT_LC(c)       (isascii(c) && isprint(c))
 628 #    define isPUNCT_LC(c)       (isascii(c) && ispunct(c))
 629 #    define toUPPER_LC(c)       toupper(c)
 630 #    define toLOWER_LC(c)       tolower(c)
 631
 632 #  endif
 633 #endif /* USE_NEXT_CTYPE */
 634
 635 #define isPSXSPC_LC(c)          (isSPACE_LC(c) || (c) == '\v')
 636 #define isBLANK_LC(c)           isBLANK(c) /* could be wrong */
 637
 638 #define isALNUM_uni(c)          is_uni_alnum(c)
 639 #define isIDFIRST_uni(c)        is_uni_idfirst(c)
 640 #define isALPHA_uni(c)          is_uni_alpha(c)
 641 #define isSPACE_uni(c)          is_uni_space(c)
 642 #define isDIGIT_uni(c)          is_uni_digit(c)
 643 #define isUPPER_uni(c)          is_uni_upper(c)
 644 #define isLOWER_uni(c)          is_uni_lower(c)
 645 #define isASCII_uni(c)          is_uni_ascii(c)
 646 #define isCNTRL_uni(c)          is_uni_cntrl(c)
 647 #define isGRAPH_uni(c)          is_uni_graph(c)
 648 #define isPRINT_uni(c)          is_uni_print(c)
 649 #define isPUNCT_uni(c)          is_uni_punct(c)
 650 #define isXDIGIT_uni(c)         is_uni_xdigit(c)
 651 #define toUPPER_uni(c,s,l)      to_uni_upper(c,s,l)
 652 #define toTITLE_uni(c,s,l)      to_uni_title(c,s,l)
 653 #define toLOWER_uni(c,s,l)      to_uni_lower(c,s,l)
 654 #define toFOLD_uni(c,s,l)       to_uni_fold(c,s,l)
 655
 656 #define isPSXSPC_uni(c)         (isSPACE_uni(c) ||(c) == '\f')
 657 #define isBLANK_uni(c)          isBLANK(c) /* could be wrong */
 658
 659 #define isALNUM_LC_uvchr(c)     (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
 660 #define isIDFIRST_LC_uvchr(c)   (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
 661 #define isALPHA_LC_uvchr(c)     (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
 662 #define isSPACE_LC_uvchr(c)     (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
 663 #define isDIGIT_LC_uvchr(c)     (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
 664 #define isUPPER_LC_uvchr(c)     (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
 665 #define isLOWER_LC_uvchr(c)     (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
 666 #define isCNTRL_LC_uvchr(c)     (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
 667 #define isGRAPH_LC_uvchr(c)     (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
 668 #define isPRINT_LC_uvchr(c)     (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
 669 #define isPUNCT_LC_uvchr(c)     (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
 670
 671 #define isPSXSPC_LC_uni(c)      (isSPACE_LC_uni(c) ||(c) == '\f')
 672 #define isBLANK_LC_uni(c)       isBLANK(c) /* could be wrong */
 673
 674 #define isALNUM_utf8(p)         is_utf8_alnum(p)
 675 /* The ID_Start of Unicode is quite limiting: it assumes a L-class
 676  * character (meaning that you cannot have, say, a CJK character).
 677  * Instead, let's allow ID_Continue but not digits. */
 678 #define isIDFIRST_utf8(p)       (is_utf8_idcont(p) && !is_utf8_digit(p))
 679 #define isALPHA_utf8(p)         is_utf8_alpha(p)
 680 #define isSPACE_utf8(p)         is_utf8_space(p)
 681 #define isDIGIT_utf8(p)         is_utf8_digit(p)
 682 #define isUPPER_utf8(p)         is_utf8_upper(p)
 683 #define isLOWER_utf8(p)         is_utf8_lower(p)
 684 #define isASCII_utf8(p)         is_utf8_ascii(p)
 685 #define isCNTRL_utf8(p)         is_utf8_cntrl(p)
 686 #define isGRAPH_utf8(p)         is_utf8_graph(p)
 687 #define isPRINT_utf8(p)         is_utf8_print(p)
 688 #define isPUNCT_utf8(p)         is_utf8_punct(p)
 689 #define isXDIGIT_utf8(p)        is_utf8_xdigit(p)
 690 #define toUPPER_utf8(p,s,l)     to_utf8_upper(p,s,l)
 691 #define toTITLE_utf8(p,s,l)     to_utf8_title(p,s,l)
 692 #define toLOWER_utf8(p,s,l)     to_utf8_lower(p,s,l)
 693
 694 #define isPSXSPC_utf8(c)        (isSPACE_utf8(c) ||(c) == '\f')
 695 #define isBLANK_utf8(c)         isBLANK(c) /* could be wrong */
 696
 697 #define isALNUM_LC_utf8(p)      isALNUM_LC_uvchr(utf8_to_uvchr(p,  0))
 698 #define isIDFIRST_LC_utf8(p)    isIDFIRST_LC_uvchr(utf8_to_uvchr(p,  0))
 699 #define isALPHA_LC_utf8(p)      isALPHA_LC_uvchr(utf8_to_uvchr(p,  0))
 700 #define isSPACE_LC_utf8(p)      isSPACE_LC_uvchr(utf8_to_uvchr(p,  0))
 701 #define isDIGIT_LC_utf8(p)      isDIGIT_LC_uvchr(utf8_to_uvchr(p,  0))
 702 #define isUPPER_LC_utf8(p)      isUPPER_LC_uvchr(utf8_to_uvchr(p,  0))
 703 #define isLOWER_LC_utf8(p)      isLOWER_LC_uvchr(utf8_to_uvchr(p,  0))
 704 #define isALNUMC_LC_utf8(p)     isALNUMC_LC_uvchr(utf8_to_uvchr(p,  0))
 705 #define isCNTRL_LC_utf8(p)      isCNTRL_LC_uvchr(utf8_to_uvchr(p,  0))
 706 #define isGRAPH_LC_utf8(p)      isGRAPH_LC_uvchr(utf8_to_uvchr(p,  0))
 707 #define isPRINT_LC_utf8(p)      isPRINT_LC_uvchr(utf8_to_uvchr(p,  0))
 708 #define isPUNCT_LC_utf8(p)      isPUNCT_LC_uvchr(utf8_to_uvchr(p,  0))
 709
 710 #define isPSXSPC_LC_utf8(c)     (isSPACE_LC_utf8(c) ||(c) == '\f')
 711 #define isBLANK_LC_utf8(c)      isBLANK(c) /* could be wrong */
 712
 713 /* This conversion works both ways, strangely enough. On EBCDIC platforms,
 714  * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII */
 715 #  define toCTRL(c)    (toUPPER(NATIVE_TO_UNI(c)) ^ 64)
 716
 717 /* Line numbers are unsigned, 32 bits. */
 718 typedef U32 line_t;
 719 #define NOLINE ((line_t) 4294967295UL)
 720
 721 /* Helpful alias for version prescan */
 722 #define is_LAX_VERSION(a,b) \
 723         (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
 724
 725 #define is_STRICT_VERSION(a,b) \
 726         (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
 727
 728 #define BADVERSION(a,b,c) \
 729         if (b) { \
 730             *b = c; \
 731         } \
 732         return a;
 733
 734 /*
 735 =head1 Memory Management
 736
 737 =for apidoc Am|void|Newx|void* ptr|int nitems|type
 738 The XSUB-writer's interface to the C C<malloc> function.
 739
 740 In 5.9.3, Newx() and friends replace the older New() API, and drops
 741 the first parameter, I<x>, a debug aid which allowed callers to identify
 742 themselves.  This aid has been superseded by a new build option,
 743 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>).  The older API is still
 744 there for use in XS modules supporting older perls.
 745
 746 =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
 747 The XSUB-writer's interface to the C C<malloc> function, with
 748 cast.  See also C<Newx>.
 749
 750 =for apidoc Am|void|Newxz|void* ptr|int nitems|type
 751 The XSUB-writer's interface to the C C<malloc> function.  The allocated
 752 memory is zeroed with C<memzero>.  See also C<Newx>.
 753
 754 =for apidoc Am|void|Renew|void* ptr|int nitems|type
 755 The XSUB-writer's interface to the C C<realloc> function.
 756
 757 =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
 758 The XSUB-writer's interface to the C C<realloc> function, with
 759 cast.
 760
 761 =for apidoc Am|void|Safefree|void* ptr
 762 The XSUB-writer's interface to the C C<free> function.
 763
 764 =for apidoc Am|void|Move|void* src|void* dest|int nitems|type
 765 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
 766 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
 767 the type.  Can do overlapping moves.  See also C<Copy>.
 768
 769 =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
 770 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
 771 optimise.
 772
 773 =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
 774 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
 775 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
 776 the type.  May fail on overlapping copies.  See also C<Move>.
 777
 778 =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
 779
 780 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
 781 optimise.
 782
 783 =for apidoc Am|void|Zero|void* dest|int nitems|type
 784
 785 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
 786 destination, C<nitems> is the number of items, and C<type> is the type.
 787
 788 =for apidoc Am|void *|ZeroD|void* dest|int nitems|type
 789
 790 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
 791 optimise.
 792
 793 =for apidoc Am|void|StructCopy|type src|type dest|type
 794 This is an architecture-independent macro to copy one structure to another.
 795
 796 =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
 797
 798 Fill up memory with a byte pattern (a byte repeated over and over
 799 again) that hopefully catches attempts to access uninitialized memory.
 800
 801 =for apidoc Am|void|PoisonNew|void* dest|int nitems|type
 802
 803 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
 804
 805 =for apidoc Am|void|PoisonFree|void* dest|int nitems|type
 806
 807 PoisonWith(0xEF) for catching access to freed memory.
 808
 809 =for apidoc Am|void|Poison|void* dest|int nitems|type
 810
 811 PoisonWith(0xEF) for catching access to freed memory.
 812
 813 =cut */
 814
 815 /* Maintained for backwards-compatibility only. Use newSV() instead. */
 816 #ifndef PERL_CORE
 817 #define NEWSV(x,len)    newSV(len)
 818 #endif
 819
 820 #define MEM_SIZE_MAX ((MEM_SIZE)~0)
 821
 822 /* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
 823  * overly eager compilers that will bleat about e.g.
 824  * (U16)n > (size_t)~0/sizeof(U16) always being false. */
 825 #ifdef PERL_MALLOC_WRAP
 826 #define MEM_WRAP_CHECK(n,t) MEM_WRAP_CHECK_1(n,t,PL_memory_wrap)
 827 #define MEM_WRAP_CHECK_1(n,t,a) \
 828         (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
 829 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
 830
 831 #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)))
 832
 833 #else
 834
 835 #define MEM_WRAP_CHECK(n,t)
 836 #define MEM_WRAP_CHECK_1(n,t,a)
 837 #define MEM_WRAP_CHECK_2(n,t,a,b)
 838 #define MEM_WRAP_CHECK_(n,t)
 839
 840 #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
 841
 842 #endif
 843
 844 #ifdef PERL_MEM_LOG
 845 /*
 846  * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
 847  * go through functions, which are handy for debugging breakpoints, but
 848  * which more importantly get the immediate calling environment (file and
 849  * line number, and C function name if available) passed in.  This info can
 850  * then be used for logging the calls, for which one gets a sample
 851  * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
 852  *
 853  * Known problems:
 854  * - not all memory allocs get logged, only those
 855  *   that go through Newx() and derivatives (while all
 856  *   Safefrees do get logged)
 857  * - __FILE__ and __LINE__ do not work everywhere
 858  * - __func__ or __FUNCTION__ even less so
 859  * - I think more goes on after the perlio frees but
 860  *   the thing is that STDERR gets closed (as do all
 861  *   the file descriptors)
 862  * - no deeper calling stack than the caller of the Newx()
 863  *   or the kind, but do I look like a C reflection/introspection
 864  *   utility to you?
 865  * - the function prototypes for the logging functions
 866  *   probably should maybe be somewhere else than handy.h
 867  * - one could consider inlining (macrofying) the logging
 868  *   for speed, but I am too lazy
 869  * - one could imagine recording the allocations in a hash,
 870  *   (keyed by the allocation address?), and maintain that
 871  *   through reallocs and frees, but how to do that without
 872  *   any News() happening...?
 873  * - lots of -Ddefines to get useful/controllable output
 874  * - lots of ENV reads
 875  */
 876
 877 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);
 878
 879 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);
 880
 881 PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
 882
 883 # ifdef PERL_CORE
 884 #  ifndef PERL_MEM_LOG_NOIMPL
 885 enum mem_log_type {
 886   MLT_ALLOC,
 887   MLT_REALLOC,
 888   MLT_FREE,
 889   MLT_NEW_SV,
 890   MLT_DEL_SV
 891 };
 892 #  endif
 893 #  if defined(PERL_IN_SV_C)  /* those are only used in sv.c */
 894 void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
 895 void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
 896 #  endif
 897 # endif
 898
 899 #endif
 900
 901 #ifdef PERL_MEM_LOG
 902 #define MEM_LOG_ALLOC(n,t,a)     Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
 903 #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
 904 #define MEM_LOG_FREE(a)          Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
 905 #endif
 906
 907 #ifndef MEM_LOG_ALLOC
 908 #define MEM_LOG_ALLOC(n,t,a)     (a)
 909 #endif
 910 #ifndef MEM_LOG_REALLOC
 911 #define MEM_LOG_REALLOC(n,t,v,a) (a)
 912 #endif
 913 #ifndef MEM_LOG_FREE
 914 #define MEM_LOG_FREE(a)          (a)
 915 #endif
 916
 917 #define Newx(v,n,t)     (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
 918 #define Newxc(v,n,t,c)  (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
 919 #define Newxz(v,n,t)    (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
 920
 921 #ifndef PERL_CORE
 922 /* pre 5.9.x compatibility */
 923 #define New(x,v,n,t)    Newx(v,n,t)
 924 #define Newc(x,v,n,t,c) Newxc(v,n,t,c)
 925 #define Newz(x,v,n,t)   Newxz(v,n,t)
 926 #endif
 927
 928 #define Renew(v,n,t) \
 929           (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
 930 #define Renewc(v,n,t,c) \
 931           (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
 932
 933 #ifdef PERL_POISON
 934 #define Safefree(d) \
 935   ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
 936 #else
 937 #define Safefree(d)     safefree(MEM_LOG_FREE((Malloc_t)(d)))
 938 #endif
 939
 940 #define Move(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
 941 #define Copy(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
 942 #define Zero(d,n,t)     (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
 943
 944 #define MoveD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
 945 #define CopyD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
 946 #ifdef HAS_MEMSET
 947 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
 948 #else
 949 /* Using bzero(), which returns void.  */
 950 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
 951 #endif
 952
 953 #define PoisonWith(d,n,t,b)     (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
 954 #define PoisonNew(d,n,t)        PoisonWith(d,n,t,0xAB)
 955 #define PoisonFree(d,n,t)       PoisonWith(d,n,t,0xEF)
 956 #define Poison(d,n,t)           PoisonFree(d,n,t)
 957
 958 #ifdef USE_STRUCT_COPY
 959 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
 960 #else
 961 #define StructCopy(s,d,t) Copy(s,d,1,t)
 962 #endif
 963
 964 #define C_ARRAY_LENGTH(a)       (sizeof(a)/sizeof((a)[0]))
 965 #define C_ARRAY_END(a)          (a) + (sizeof(a)/sizeof((a)[0]))
 966
 967 #ifdef NEED_VA_COPY
 968 # ifdef va_copy
 969 #  define Perl_va_copy(s, d) va_copy(d, s)
 970 # else
 971 #  if defined(__va_copy)
 972 #   define Perl_va_copy(s, d) __va_copy(d, s)
 973 #  else
 974 #   define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
 975 #  endif
 976 # endif
 977 #endif
 978
 979 /* convenience debug macros */
 980 #ifdef USE_ITHREADS
 981 #define pTHX_FORMAT  "Perl interpreter: 0x%p"
 982 #define pTHX__FORMAT ", Perl interpreter: 0x%p"
 983 #define pTHX_VALUE_   (void *)my_perl,
 984 #define pTHX_VALUE    (void *)my_perl
 985 #define pTHX__VALUE_ ,(void *)my_perl,
 986 #define pTHX__VALUE  ,(void *)my_perl
 987 #else
 988 #define pTHX_FORMAT
 989 #define pTHX__FORMAT
 990 #define pTHX_VALUE_
 991 #define pTHX_VALUE
 992 #define pTHX__VALUE_
 993 #define pTHX__VALUE
 994 #endif /* USE_ITHREADS */
 995
 996 /* Perl_deprecate was not part of the public API, and did not have a deprecate()
 997    shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
 998    CPAN::Unpack show any users outside the core.  */
 999 #ifdef PERL_CORE
1000 #  define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
1001 #endif
1002
1003 /*
1004  * Local variables:
1005  * c-indentation-style: bsd
1006  * c-basic-offset: 4
1007  * indent-tabs-mode: t
1008  * End:
1009  *
1010  * ex: set ts=8 sts=4 sw=4 noet:
1011  */