handy.h

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