perl.h

   1 /*    perl.h
   2  *
   3  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
   4  *    2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 #ifndef H_PERL
  12 #define H_PERL 1
  13
  14 #ifdef PERL_FOR_X2P
  15 /*
  16  * This file is being used for x2p stuff.
  17  * Above symbol is defined via -D in 'x2p/Makefile.SH'
  18  * Decouple x2p stuff from some of perls more extreme eccentricities.
  19  */
  20 #undef MULTIPLICITY
  21 #undef USE_STDIO
  22 #define USE_STDIO
  23 #endif /* PERL_FOR_X2P */
  24
  25 #if defined(DGUX)
  26 #include <sys/fcntl.h>
  27 #endif
  28
  29 #ifdef VOIDUSED
  30 #   undef VOIDUSED
  31 #endif
  32 #define VOIDUSED 1
  33
  34 #ifdef PERL_MICRO
  35 #   include "uconfig.h"
  36 #else
  37 #   ifndef USE_CROSS_COMPILE
  38 #       include "config.h"
  39 #   else
  40 #       include "xconfig.h"
  41 #   endif
  42 #endif
  43
  44 /* See L<perlguts/"The Perl API"> for detailed notes on
  45  * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
  46
  47 /* Note that from here --> to <-- the same logic is
  48  * repeated in makedef.pl, so be certain to update
  49  * both places when editing. */
  50
  51 #ifdef PERL_IMPLICIT_SYS
  52 /* PERL_IMPLICIT_SYS implies PerlMemShared != PerlMem
  53    so use slab allocator to avoid lots of MUTEX overhead
  54  */
  55 #  ifndef PL_OP_SLAB_ALLOC
  56 #    define PL_OP_SLAB_ALLOC
  57 #  endif
  58 #endif
  59
  60 #ifdef USE_ITHREADS
  61 #  if !defined(MULTIPLICITY)
  62 #    define MULTIPLICITY
  63 #  endif
  64 #endif
  65
  66 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
  67 #  ifndef PERL_GLOBAL_STRUCT
  68 #    define PERL_GLOBAL_STRUCT
  69 #  endif
  70 #endif
  71
  72 #ifdef PERL_GLOBAL_STRUCT
  73 #  ifndef MULTIPLICITY
  74 #    define MULTIPLICITY
  75 #  endif
  76 #endif
  77
  78 #ifdef MULTIPLICITY
  79 #  ifndef PERL_IMPLICIT_CONTEXT
  80 #    define PERL_IMPLICIT_CONTEXT
  81 #  endif
  82 #endif
  83
  84 /* undef WIN32 when building on Cygwin (for libwin32) - gph */
  85 #ifdef __CYGWIN__
  86 #   undef WIN32
  87 #   undef _WIN32
  88 #endif
  89
  90 #if defined(__SYMBIAN32__) || (defined(__VC32__) && defined(WINS))
  91 #   ifndef SYMBIAN
  92 #       define SYMBIAN
  93 #   endif
  94 #endif
  95
  96 #ifdef __SYMBIAN32__
  97 #  include "symbian/symbian_proto.h"
  98 #endif
  99
 100 /* Any stack-challenged places.  The limit varies (and often
 101  * is configurable), but using more than a kilobyte of stack
 102  * is usually dubious in these systems. */
 103 #if defined(EPOC) || defined(__SYMBIAN32__)
 104 /* EPOC/Symbian: need to work around the SDK features. *
 105  * On WINS: MS VC5 generates calls to _chkstk,         *
 106  * if a "large" stack frame is allocated.              *
 107  * gcc on MARM does not generate calls like these.     */
 108 #   define USE_HEAP_INSTEAD_OF_STACK
 109 #endif
 110
 111 #/* Use the reentrant APIs like localtime_r and getpwent_r */
 112 /* Win32 has naturally threadsafe libraries, no need to use any _r variants. */
 113 #if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32) && !defined(PERL_DARWIN)
 114 #   define USE_REENTRANT_API
 115 #endif
 116
 117 /* <--- here ends the logic shared by perl.h and makedef.pl */
 118
 119 /*
 120  * PERL_DARWIN for MacOSX (__APPLE__ exists but is not officially sanctioned)
 121  * (The -DPERL_DARWIN comes from the hints/darwin.sh.)
 122  * __bsdi__ for BSD/OS
 123  */
 124 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(PERL_DARWIN) || defined(__bsdi__) || defined(BSD41) || defined(BSD42) || defined(BSD43) || defined(BSD44)
 125 #   ifndef BSDish
 126 #       define BSDish
 127 #   endif
 128 #endif
 129
 130 #undef START_EXTERN_C
 131 #undef END_EXTERN_C
 132 #undef EXTERN_C
 133 #ifdef __cplusplus
 134 #  define START_EXTERN_C extern "C" {
 135 #  define END_EXTERN_C }
 136 #  define EXTERN_C extern "C"
 137 #else
 138 #  define START_EXTERN_C
 139 #  define END_EXTERN_C
 140 #  define EXTERN_C extern
 141 #endif
 142
 143 /* Fallback definitions in case we don't have definitions from config.h.
 144    This should only matter for systems that don't use Configure and
 145    haven't been modified to define PERL_STATIC_INLINE yet.
 146 */
 147 #if !defined(PERL_STATIC_INLINE)
 148 #  ifdef HAS_STATIC_INLINE
 149 #    define PERL_STATIC_INLINE static inline
 150 #  else
 151 #    define PERL_STATIC_INLINE static
 152 #  endif
 153 #endif
 154
 155 #ifdef PERL_GLOBAL_STRUCT
 156 #  ifndef PERL_GET_VARS
 157 #    ifdef PERL_GLOBAL_STRUCT_PRIVATE
 158        EXTERN_C struct perl_vars* Perl_GetVarsPrivate();
 159 #      define PERL_GET_VARS() Perl_GetVarsPrivate() /* see miniperlmain.c */
 160 #      ifndef PERLIO_FUNCS_CONST
 161 #        define PERLIO_FUNCS_CONST /* Can't have these lying around. */
 162 #      endif
 163 #    else
 164 #      define PERL_GET_VARS() PL_VarsPtr
 165 #    endif
 166 #  endif
 167 #endif
 168
 169 #define pVAR    register struct perl_vars* my_vars PERL_UNUSED_DECL
 170
 171 #ifdef PERL_GLOBAL_STRUCT
 172 #  define dVAR          pVAR    = (struct perl_vars*)PERL_GET_VARS()
 173 #else
 174 #  define dVAR          dNOOP
 175 #endif
 176
 177 #ifdef PERL_IMPLICIT_CONTEXT
 178 #  ifndef MULTIPLICITY
 179 #    define MULTIPLICITY
 180 #  endif
 181 #  define tTHX  PerlInterpreter*
 182 #  define pTHX  register tTHX my_perl PERL_UNUSED_DECL
 183 #  define aTHX  my_perl
 184 #  ifdef PERL_GLOBAL_STRUCT
 185 #    define dTHXa(a)    dVAR; pTHX = (tTHX)a
 186 #  else
 187 #    define dTHXa(a)    pTHX = (tTHX)a
 188 #  endif
 189 #  ifdef PERL_GLOBAL_STRUCT
 190 #    define dTHX                dVAR; pTHX = PERL_GET_THX
 191 #  else
 192 #    define dTHX                pTHX = PERL_GET_THX
 193 #  endif
 194 #  define pTHX_         pTHX,
 195 #  define aTHX_         aTHX,
 196 #  define pTHX_1        2
 197 #  define pTHX_2        3
 198 #  define pTHX_3        4
 199 #  define pTHX_4        5
 200 #  define pTHX_5        6
 201 #  define pTHX_6        7
 202 #  define pTHX_7        8
 203 #  define pTHX_8        9
 204 #  define pTHX_9        10
 205 #  if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
 206 #    define PERL_TRACK_MEMPOOL
 207 #  endif
 208 #else
 209 #  undef PERL_TRACK_MEMPOOL
 210 #endif
 211
 212 #define STATIC static
 213
 214 #ifndef PERL_CORE
 215 /* Do not use these macros. They were part of PERL_OBJECT, which was an
 216  * implementation of multiplicity using C++ objects. They have been left
 217  * here solely for the sake of XS code which has incorrectly
 218  * cargo-culted them.
 219  */
 220 #define CPERLscope(x) x
 221 #define CPERLarg void
 222 #define CPERLarg_
 223 #define _CPERLarg
 224 #define PERL_OBJECT_THIS
 225 #define _PERL_OBJECT_THIS
 226 #define PERL_OBJECT_THIS_
 227 #define CALL_FPTR(fptr) (*fptr)
 228 #define MEMBER_TO_FPTR(name) name
 229 #endif /* !PERL_CORE */
 230
 231 #define CALLRUNOPS  PL_runops
 232
 233 #define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
 234
 235 #define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
 236 #define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,screamer,data,flags) \
 237     RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
 238         (strbeg),(minend),(screamer),(data),(flags))
 239 #define CALLREG_INTUIT_START(prog,sv,strpos,strend,flags,data) \
 240     RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strpos), \
 241         (strend),(flags),(data))
 242 #define CALLREG_INTUIT_STRING(prog) \
 243     RX_ENGINE(prog)->checkstr(aTHX_ (prog))
 244
 245 #define CALLREGFREE(prog) \
 246     Perl_pregfree(aTHX_ (prog))
 247
 248 #define CALLREGFREE_PVT(prog) \
 249     if(prog) RX_ENGINE(prog)->free(aTHX_ (prog))
 250
 251 #define CALLREG_NUMBUF_FETCH(rx,paren,usesv)                                \
 252     RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
 253
 254 #define CALLREG_NUMBUF_STORE(rx,paren,value) \
 255     RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
 256
 257 #define CALLREG_NUMBUF_LENGTH(rx,sv,paren)                              \
 258     RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
 259
 260 #define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
 261     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
 262
 263 #define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
 264     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
 265
 266 #define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
 267     RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
 268
 269 #define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
 270     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
 271
 272 #define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
 273     RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
 274
 275 #define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
 276     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
 277
 278 #define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
 279     RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
 280
 281 #define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
 282     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
 283
 284 #define CALLREG_NAMED_BUFF_COUNT(rx) \
 285     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
 286
 287 #define CALLREG_NAMED_BUFF_ALL(rx, flags) \
 288     RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
 289
 290 #define CALLREG_PACKAGE(rx) \
 291     RX_ENGINE(rx)->qr_package(aTHX_ (rx))
 292
 293 #if defined(USE_ITHREADS)
 294 #define CALLREGDUPE(prog,param) \
 295     Perl_re_dup(aTHX_ (prog),(param))
 296
 297 #define CALLREGDUPE_PVT(prog,param) \
 298     (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
 299           : (REGEXP *)NULL)
 300 #endif
 301
 302
 303
 304
 305
 306 /*
 307  * Because of backward compatibility reasons the PERL_UNUSED_DECL
 308  * cannot be changed from postfix to PERL_UNUSED_DECL(x).  Sigh.
 309  *
 310  * Note that there are C compilers such as MetroWerks CodeWarrior
 311  * which do not have an "inlined" way (like the gcc __attribute__) of
 312  * marking unused variables (they need e.g. a #pragma) and therefore
 313  * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
 314  * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
 315  *
 316  */
 317
 318 #if defined(__SYMBIAN32__) && defined(__GNUC__)
 319 #  ifdef __cplusplus
 320 #    define PERL_UNUSED_DECL
 321 #  else
 322 #    define PERL_UNUSED_DECL __attribute__((unused))
 323 #  endif
 324 #endif
 325
 326 #ifndef PERL_UNUSED_DECL
 327 #  if defined(HASATTRIBUTE_UNUSED) && !defined(__cplusplus)
 328 #    define PERL_UNUSED_DECL __attribute__unused__
 329 #  else
 330 #    define PERL_UNUSED_DECL
 331 #  endif
 332 #endif
 333
 334 /* gcc -Wall:
 335  * for silencing unused variables that are actually used most of the time,
 336  * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs
 337  */
 338 #ifndef PERL_UNUSED_ARG
 339 #  if defined(lint) && defined(S_SPLINT_S) /* www.splint.org */
 340 #    include <note.h>
 341 #    define PERL_UNUSED_ARG(x) NOTE(ARGUNUSED(x))
 342 #  else
 343 #    define PERL_UNUSED_ARG(x) ((void)x)
 344 #  endif
 345 #endif
 346 #ifndef PERL_UNUSED_VAR
 347 #  define PERL_UNUSED_VAR(x) ((void)x)
 348 #endif
 349
 350 #ifdef USE_ITHREADS
 351 #  define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
 352 #else
 353 #  define PERL_UNUSED_CONTEXT
 354 #endif
 355
 356 #define NOOP /*EMPTY*/(void)0
 357 /* cea2e8a9dd23747f accidentally lost the comment originally from the first
 358    check in of thread.h, explaining why we need dNOOP at all:  */
 359 /* Rats: if dTHR is just blank then the subsequent ";" throws an error */
 360 /* Declaring a *function*, instead of a variable, ensures that we don't rely
 361    on being able to suppress "unused" warnings.  */
 362 #ifdef __cplusplus
 363 #define dNOOP (void)0
 364 #else
 365 #define dNOOP extern int Perl___notused(void)
 366 #endif
 367
 368 #ifndef pTHX
 369 /* Don't bother defining tTHX and sTHX; using them outside
 370  * code guarded by PERL_IMPLICIT_CONTEXT is an error.
 371  */
 372 #  define pTHX          void
 373 #  define pTHX_
 374 #  define aTHX
 375 #  define aTHX_
 376 #  define dTHXa(a)      dNOOP
 377 #  define dTHX          dNOOP
 378 #  define pTHX_1        1
 379 #  define pTHX_2        2
 380 #  define pTHX_3        3
 381 #  define pTHX_4        4
 382 #  define pTHX_5        5
 383 #  define pTHX_6        6
 384 #  define pTHX_7        7
 385 #  define pTHX_8        8
 386 #  define pTHX_9        9
 387 #endif
 388
 389 #ifndef dVAR
 390 #  define dVAR          dNOOP
 391 #endif
 392
 393 /* these are only defined for compatibility; should not be used internally */
 394 #if !defined(pTHXo) && !defined(PERL_CORE)
 395 #  define pTHXo         pTHX
 396 #  define pTHXo_        pTHX_
 397 #  define aTHXo         aTHX
 398 #  define aTHXo_        aTHX_
 399 #  define dTHXo         dTHX
 400 #  define dTHXoa(x)     dTHXa(x)
 401 #endif
 402
 403 #ifndef pTHXx
 404 #  define pTHXx         register PerlInterpreter *my_perl
 405 #  define pTHXx_        pTHXx,
 406 #  define aTHXx         my_perl
 407 #  define aTHXx_        aTHXx,
 408 #  define dTHXx         dTHX
 409 #endif
 410
 411 /* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
 412  * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
 413  * dTHXs is therefore needed for all functions using PerlIO_foo(). */
 414 #ifdef PERL_IMPLICIT_SYS
 415 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
 416 #    define dTHXs               dVAR; dTHX
 417 #  else
 418 #    define dTHXs               dTHX
 419 #  endif
 420 #else
 421 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
 422 #    define dTHXs               dVAR
 423 #  else
 424 #    define dTHXs               dNOOP
 425 #  endif
 426 #endif
 427
 428 /* Some platforms require marking function declarations
 429  * for them to be exportable.  Used in perlio.h, proto.h
 430  * is handled either by the makedef.pl or by defining the
 431  * PERL_CALLCONV to be something special.  See also the
 432  * definition of XS() in XSUB.h. */
 433 #ifndef PERL_EXPORT_C
 434 #  ifdef __cplusplus
 435 #    define PERL_EXPORT_C extern "C"
 436 #  else
 437 #    define PERL_EXPORT_C extern
 438 #  endif
 439 #endif
 440 #ifndef PERL_XS_EXPORT_C
 441 #  ifdef __cplusplus
 442 #    define PERL_XS_EXPORT_C extern "C"
 443 #  else
 444 #    define PERL_XS_EXPORT_C
 445 #  endif
 446 #endif
 447
 448 #ifdef OP_IN_REGISTER
 449 #  ifdef __GNUC__
 450 #    define stringify_immed(s) #s
 451 #    define stringify(s) stringify_immed(s)
 452 register struct op *Perl_op asm(stringify(OP_IN_REGISTER));
 453 #  endif
 454 #endif
 455
 456 /* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
 457  * g++ allows them but seems to have problems with them
 458  * (insane errors ensue).
 459  * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
 460  */
 461 #if defined(PERL_GCC_PEDANTIC) || \
 462     (defined(__GNUC__) && defined(__cplusplus) && \
 463         ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
 464 #  ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
 465 #    define PERL_GCC_BRACE_GROUPS_FORBIDDEN
 466 #  endif
 467 #endif
 468
 469 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
 470 #  ifndef PERL_USE_GCC_BRACE_GROUPS
 471 #    define PERL_USE_GCC_BRACE_GROUPS
 472 #  endif
 473 #endif
 474
 475 /*
 476  * STMT_START { statements; } STMT_END;
 477  * can be used as a single statement, as in
 478  * if (x) STMT_START { ... } STMT_END; else ...
 479  *
 480  * Trying to select a version that gives no warnings...
 481  */
 482 #if !(defined(STMT_START) && defined(STMT_END))
 483 # ifdef PERL_USE_GCC_BRACE_GROUPS
 484 #   define STMT_START   (void)( /* gcc supports "({ STATEMENTS; })" */
 485 #   define STMT_END     )
 486 # else
 487    /* Now which other defined()s do we need here ??? */
 488 #  if (VOIDFLAGS) && (defined(sun) || defined(__sun__)) && !defined(__GNUC__)
 489 #   define STMT_START   if (1)
 490 #   define STMT_END     else (void)0
 491 #  else
 492 #   define STMT_START   do
 493 #   define STMT_END     while (0)
 494 #  endif
 495 # endif
 496 #endif
 497
 498 #ifndef BYTEORDER  /* Should never happen -- byteorder is in config.h */
 499 #   define BYTEORDER 0x1234
 500 #endif
 501
 502 /* Overall memory policy? */
 503 #ifndef CONSERVATIVE
 504 #   define LIBERAL 1
 505 #endif
 506
 507 #if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
 508 #define ASCIIish
 509 #else
 510 #undef  ASCIIish
 511 #endif
 512
 513 /*
 514  * The following contortions are brought to you on behalf of all the
 515  * standards, semi-standards, de facto standards, not-so-de-facto standards
 516  * of the world, as well as all the other botches anyone ever thought of.
 517  * The basic theory is that if we work hard enough here, the rest of the
 518  * code can be a lot prettier.  Well, so much for theory.  Sorry, Henry...
 519  */
 520
 521 /* define this once if either system, instead of cluttering up the src */
 522 #if defined(MSDOS) || defined(atarist) || defined(WIN32) || defined(NETWARE)
 523 #define DOSISH 1
 524 #endif
 525
 526 #if defined(__STDC__) || defined(_AIX) || defined(__stdc__) || defined(__cplusplus) || defined(EPOC) || defined(NETWARE) || defined(__SYMBIAN32__)
 527 # define STANDARD_C 1
 528 #endif
 529
 530 #if defined(__cplusplus) || defined(WIN32) || defined(__sgi) || defined(__EMX__) || defined(__DGUX) || defined(EPOC) || defined(__QNX__) || defined(NETWARE) || defined(PERL_MICRO)
 531 # define DONT_DECLARE_STD 1
 532 #endif
 533
 534 #if defined(HASVOLATILE) || defined(STANDARD_C)
 535 #       define VOL volatile
 536 #else
 537 #   define VOL
 538 #endif
 539
 540 #define TAINT           (PL_tainted = TRUE)
 541 #define TAINT_NOT       (PL_tainted = FALSE)
 542 #define TAINT_IF(c)     if (c) { PL_tainted = TRUE; }
 543 #define TAINT_ENV()     if (PL_tainting) { taint_env(); }
 544 #define TAINT_PROPER(s) if (PL_tainting) { taint_proper(NULL, s); }
 545
 546 /* flags used internally only within pp_subst and pp_substcont */
 547 #ifdef PERL_CORE
 548 #  define SUBST_TAINT_STR      1        /* string tainted */
 549 #  define SUBST_TAINT_PAT      2        /* pattern tainted */
 550 #  define SUBST_TAINT_REPL     4        /* replacement tainted */
 551 #  define SUBST_TAINT_RETAINT  8        /* use re'taint' in scope */
 552 #  define SUBST_TAINT_BOOLRET 16        /* return is boolean (don't taint) */
 553 #endif
 554
 555 /* XXX All process group stuff is handled in pp_sys.c.  Should these
 556    defines move there?  If so, I could simplify this a lot. --AD  9/96.
 557 */
 558 /* Process group stuff changed from traditional BSD to POSIX.
 559    perlfunc.pod documents the traditional BSD-style syntax, so we'll
 560    try to preserve that, if possible.
 561 */
 562 #ifdef HAS_SETPGID
 563 #  define BSD_SETPGRP(pid, pgrp)        setpgid((pid), (pgrp))
 564 #else
 565 #  if defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
 566 #    define BSD_SETPGRP(pid, pgrp)      setpgrp((pid), (pgrp))
 567 #  else
 568 #    ifdef HAS_SETPGRP2  /* DG/UX */
 569 #      define BSD_SETPGRP(pid, pgrp)    setpgrp2((pid), (pgrp))
 570 #    endif
 571 #  endif
 572 #endif
 573 #if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
 574 #  define HAS_SETPGRP  /* Well, effectively it does . . . */
 575 #endif
 576
 577 /* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
 578     our life easier :-) so we'll try it.
 579 */
 580 #ifdef HAS_GETPGID
 581 #  define BSD_GETPGRP(pid)              getpgid((pid))
 582 #else
 583 #  if defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
 584 #    define BSD_GETPGRP(pid)            getpgrp((pid))
 585 #  else
 586 #    ifdef HAS_GETPGRP2  /* DG/UX */
 587 #      define BSD_GETPGRP(pid)          getpgrp2((pid))
 588 #    endif
 589 #  endif
 590 #endif
 591 #if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
 592 #  define HAS_GETPGRP  /* Well, effectively it does . . . */
 593 #endif
 594
 595 /* These are not exact synonyms, since setpgrp() and getpgrp() may
 596    have different behaviors, but perl.h used to define USE_BSDPGRP
 597    (prior to 5.003_05) so some extension might depend on it.
 598 */
 599 #if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
 600 #  ifndef USE_BSDPGRP
 601 #    define USE_BSDPGRP
 602 #  endif
 603 #endif
 604
 605 /* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
 606    pthread.h must be included before all other header files.
 607 */
 608 #if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
 609 #  include <pthread.h>
 610 #endif
 611
 612 #ifndef _TYPES_         /* If types.h defines this it's easy. */
 613 #   ifndef major                /* Does everyone's types.h define this? */
 614 #       include <sys/types.h>
 615 #   endif
 616 #endif
 617
 618 #ifdef __cplusplus
 619 #  ifndef I_STDARG
 620 #    define I_STDARG 1
 621 #  endif
 622 #endif
 623
 624 #ifdef I_STDARG
 625 #  include <stdarg.h>
 626 #else
 627 #  ifdef I_VARARGS
 628 #    include <varargs.h>
 629 #  endif
 630 #endif
 631
 632 #ifdef USE_NEXT_CTYPE
 633
 634 #if NX_CURRENT_COMPILER_RELEASE >= 500
 635 #  include <bsd/ctypes.h>
 636 #else
 637 #  if NX_CURRENT_COMPILER_RELEASE >= 400
 638 #    include <objc/NXCType.h>
 639 #  else /*  NX_CURRENT_COMPILER_RELEASE < 400 */
 640 #    include <appkit/NXCType.h>
 641 #  endif /*  NX_CURRENT_COMPILER_RELEASE >= 400 */
 642 #endif /*  NX_CURRENT_COMPILER_RELEASE >= 500 */
 643
 644 #else /* !USE_NEXT_CTYPE */
 645 #include <ctype.h>
 646 #endif /* USE_NEXT_CTYPE */
 647
 648 #ifdef METHOD   /* Defined by OSF/1 v3.0 by ctype.h */
 649 #undef METHOD
 650 #endif
 651
 652 #ifdef PERL_MICRO
 653 #   define NO_LOCALE
 654 #endif
 655
 656 #ifdef I_LOCALE
 657 #   include <locale.h>
 658 #endif
 659
 660 #if !defined(NO_LOCALE) && defined(HAS_SETLOCALE)
 661 #   define USE_LOCALE
 662 #   if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
 663        && defined(HAS_STRXFRM)
 664 #       define USE_LOCALE_COLLATE
 665 #   endif
 666 #   if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
 667 #       define USE_LOCALE_CTYPE
 668 #   endif
 669 #   if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
 670 #       define USE_LOCALE_NUMERIC
 671 #   endif
 672 #endif /* !NO_LOCALE && HAS_SETLOCALE */
 673
 674 #include <setjmp.h>
 675
 676 #ifdef I_SYS_PARAM
 677 #   ifdef PARAM_NEEDS_TYPES
 678 #       include <sys/types.h>
 679 #   endif
 680 #   include <sys/param.h>
 681 #endif
 682
 683 /* Use all the "standard" definitions? */
 684 #if defined(STANDARD_C) && defined(I_STDLIB)
 685 #   include <stdlib.h>
 686 #endif
 687
 688 /* If this causes problems, set i_unistd=undef in the hint file.  */
 689 #ifdef I_UNISTD
 690 #   include <unistd.h>
 691 #endif
 692
 693 /* for WCOREDUMP */
 694 #ifdef I_SYS_WAIT
 695 #   include <sys/wait.h>
 696 #endif
 697
 698 #ifdef __SYMBIAN32__
 699 #   undef _SC_ARG_MAX /* Symbian has _SC_ARG_MAX but no sysconf() */
 700 #endif
 701
 702 #if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO) && !defined(PERL_MICRO)
 703 EXTERN_C int syscall(int, ...);
 704 #endif
 705
 706 #if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO) && !defined(PERL_MICRO)
 707 EXTERN_C int usleep(unsigned int);
 708 #endif
 709
 710 /* Funky places that do not have socket stuff. */
 711 #if defined(__LIBCATAMOUNT__)
 712 #  define MYSWAP
 713 #endif
 714
 715 #ifdef PERL_MICRO /* Last chance to export Perl_my_swap */
 716 #  define MYSWAP
 717 #endif
 718
 719 #ifdef PERL_CORE
 720
 721 /* macros for correct constant construction */
 722 # if INTSIZE >= 2
 723 #  define U16_CONST(x) ((U16)x##U)
 724 # else
 725 #  define U16_CONST(x) ((U16)x##UL)
 726 # endif
 727
 728 # if INTSIZE >= 4
 729 #  define U32_CONST(x) ((U32)x##U)
 730 # else
 731 #  define U32_CONST(x) ((U32)x##UL)
 732 # endif
 733
 734 # ifdef HAS_QUAD
 735 #  if INTSIZE >= 8
 736 #   define U64_CONST(x) ((U64)x##U)
 737 #  elif LONGSIZE >= 8
 738 #   define U64_CONST(x) ((U64)x##UL)
 739 #  elif QUADKIND == QUAD_IS_LONG_LONG
 740 #   define U64_CONST(x) ((U64)x##ULL)
 741 #  else /* best guess we can make */
 742 #   define U64_CONST(x) ((U64)x##UL)
 743 #  endif
 744 # endif
 745
 746 /* byte-swapping functions for big-/little-endian conversion */
 747 # define _swab_16_(x) ((U16)( \
 748          (((U16)(x) & U16_CONST(0x00ff)) << 8) | \
 749          (((U16)(x) & U16_CONST(0xff00)) >> 8) ))
 750
 751 # define _swab_32_(x) ((U32)( \
 752          (((U32)(x) & U32_CONST(0x000000ff)) << 24) | \
 753          (((U32)(x) & U32_CONST(0x0000ff00)) <<  8) | \
 754          (((U32)(x) & U32_CONST(0x00ff0000)) >>  8) | \
 755          (((U32)(x) & U32_CONST(0xff000000)) >> 24) ))
 756
 757 # ifdef HAS_QUAD
 758 #  define _swab_64_(x) ((U64)( \
 759           (((U64)(x) & U64_CONST(0x00000000000000ff)) << 56) | \
 760           (((U64)(x) & U64_CONST(0x000000000000ff00)) << 40) | \
 761           (((U64)(x) & U64_CONST(0x0000000000ff0000)) << 24) | \
 762           (((U64)(x) & U64_CONST(0x00000000ff000000)) <<  8) | \
 763           (((U64)(x) & U64_CONST(0x000000ff00000000)) >>  8) | \
 764           (((U64)(x) & U64_CONST(0x0000ff0000000000)) >> 24) | \
 765           (((U64)(x) & U64_CONST(0x00ff000000000000)) >> 40) | \
 766           (((U64)(x) & U64_CONST(0xff00000000000000)) >> 56) ))
 767 # endif
 768
 769 /*----------------------------------------------------------------------------*/
 770 # if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678  /*     little-endian     */
 771 /*----------------------------------------------------------------------------*/
 772 #  define my_htole16(x)         (x)
 773 #  define my_letoh16(x)         (x)
 774 #  define my_htole32(x)         (x)
 775 #  define my_letoh32(x)         (x)
 776 #  define my_htobe16(x)         _swab_16_(x)
 777 #  define my_betoh16(x)         _swab_16_(x)
 778 #  define my_htobe32(x)         _swab_32_(x)
 779 #  define my_betoh32(x)         _swab_32_(x)
 780 #  ifdef HAS_QUAD
 781 #   define my_htole64(x)        (x)
 782 #   define my_letoh64(x)        (x)
 783 #   define my_htobe64(x)        _swab_64_(x)
 784 #   define my_betoh64(x)        _swab_64_(x)
 785 #  endif
 786 #  define my_htoles(x)          (x)
 787 #  define my_letohs(x)          (x)
 788 #  define my_htolei(x)          (x)
 789 #  define my_letohi(x)          (x)
 790 #  define my_htolel(x)          (x)
 791 #  define my_letohl(x)          (x)
 792 #  if SHORTSIZE == 1
 793 #   define my_htobes(x)         (x)
 794 #   define my_betohs(x)         (x)
 795 #  elif SHORTSIZE == 2
 796 #   define my_htobes(x)         _swab_16_(x)
 797 #   define my_betohs(x)         _swab_16_(x)
 798 #  elif SHORTSIZE == 4
 799 #   define my_htobes(x)         _swab_32_(x)
 800 #   define my_betohs(x)         _swab_32_(x)
 801 #  elif SHORTSIZE == 8
 802 #   define my_htobes(x)         _swab_64_(x)
 803 #   define my_betohs(x)         _swab_64_(x)
 804 #  else
 805 #   define PERL_NEED_MY_HTOBES
 806 #   define PERL_NEED_MY_BETOHS
 807 #  endif
 808 #  if INTSIZE == 1
 809 #   define my_htobei(x)         (x)
 810 #   define my_betohi(x)         (x)
 811 #  elif INTSIZE == 2
 812 #   define my_htobei(x)         _swab_16_(x)
 813 #   define my_betohi(x)         _swab_16_(x)
 814 #  elif INTSIZE == 4
 815 #   define my_htobei(x)         _swab_32_(x)
 816 #   define my_betohi(x)         _swab_32_(x)
 817 #  elif INTSIZE == 8
 818 #   define my_htobei(x)         _swab_64_(x)
 819 #   define my_betohi(x)         _swab_64_(x)
 820 #  else
 821 #   define PERL_NEED_MY_HTOBEI
 822 #   define PERL_NEED_MY_BETOHI
 823 #  endif
 824 #  if LONGSIZE == 1
 825 #   define my_htobel(x)         (x)
 826 #   define my_betohl(x)         (x)
 827 #  elif LONGSIZE == 2
 828 #   define my_htobel(x)         _swab_16_(x)
 829 #   define my_betohl(x)         _swab_16_(x)
 830 #  elif LONGSIZE == 4
 831 #   define my_htobel(x)         _swab_32_(x)
 832 #   define my_betohl(x)         _swab_32_(x)
 833 #  elif LONGSIZE == 8
 834 #   define my_htobel(x)         _swab_64_(x)
 835 #   define my_betohl(x)         _swab_64_(x)
 836 #  else
 837 #   define PERL_NEED_MY_HTOBEL
 838 #   define PERL_NEED_MY_BETOHL
 839 #  endif
 840 #  define my_htolen(p,n)        NOOP
 841 #  define my_letohn(p,n)        NOOP
 842 #  define my_htoben(p,n)        my_swabn(p,n)
 843 #  define my_betohn(p,n)        my_swabn(p,n)
 844 /*----------------------------------------------------------------------------*/
 845 # elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321  /*     big-endian      */
 846 /*----------------------------------------------------------------------------*/
 847 #  define my_htobe16(x)         (x)
 848 #  define my_betoh16(x)         (x)
 849 #  define my_htobe32(x)         (x)
 850 #  define my_betoh32(x)         (x)
 851 #  define my_htole16(x)         _swab_16_(x)
 852 #  define my_letoh16(x)         _swab_16_(x)
 853 #  define my_htole32(x)         _swab_32_(x)
 854 #  define my_letoh32(x)         _swab_32_(x)
 855 #  ifdef HAS_QUAD
 856 #   define my_htobe64(x)        (x)
 857 #   define my_betoh64(x)        (x)
 858 #   define my_htole64(x)        _swab_64_(x)
 859 #   define my_letoh64(x)        _swab_64_(x)
 860 #  endif
 861 #  define my_htobes(x)          (x)
 862 #  define my_betohs(x)          (x)
 863 #  define my_htobei(x)          (x)
 864 #  define my_betohi(x)          (x)
 865 #  define my_htobel(x)          (x)
 866 #  define my_betohl(x)          (x)
 867 #  if SHORTSIZE == 1
 868 #   define my_htoles(x)         (x)
 869 #   define my_letohs(x)         (x)
 870 #  elif SHORTSIZE == 2
 871 #   define my_htoles(x)         _swab_16_(x)
 872 #   define my_letohs(x)         _swab_16_(x)
 873 #  elif SHORTSIZE == 4
 874 #   define my_htoles(x)         _swab_32_(x)
 875 #   define my_letohs(x)         _swab_32_(x)
 876 #  elif SHORTSIZE == 8
 877 #   define my_htoles(x)         _swab_64_(x)
 878 #   define my_letohs(x)         _swab_64_(x)
 879 #  else
 880 #   define PERL_NEED_MY_HTOLES
 881 #   define PERL_NEED_MY_LETOHS
 882 #  endif
 883 #  if INTSIZE == 1
 884 #   define my_htolei(x)         (x)
 885 #   define my_letohi(x)         (x)
 886 #  elif INTSIZE == 2
 887 #   define my_htolei(x)         _swab_16_(x)
 888 #   define my_letohi(x)         _swab_16_(x)
 889 #  elif INTSIZE == 4
 890 #   define my_htolei(x)         _swab_32_(x)
 891 #   define my_letohi(x)         _swab_32_(x)
 892 #  elif INTSIZE == 8
 893 #   define my_htolei(x)         _swab_64_(x)
 894 #   define my_letohi(x)         _swab_64_(x)
 895 #  else
 896 #   define PERL_NEED_MY_HTOLEI
 897 #   define PERL_NEED_MY_LETOHI
 898 #  endif
 899 #  if LONGSIZE == 1
 900 #   define my_htolel(x)         (x)
 901 #   define my_letohl(x)         (x)
 902 #  elif LONGSIZE == 2
 903 #   define my_htolel(x)         _swab_16_(x)
 904 #   define my_letohl(x)         _swab_16_(x)
 905 #  elif LONGSIZE == 4
 906 #   define my_htolel(x)         _swab_32_(x)
 907 #   define my_letohl(x)         _swab_32_(x)
 908 #  elif LONGSIZE == 8
 909 #   define my_htolel(x)         _swab_64_(x)
 910 #   define my_letohl(x)         _swab_64_(x)
 911 #  else
 912 #   define PERL_NEED_MY_HTOLEL
 913 #   define PERL_NEED_MY_LETOHL
 914 #  endif
 915 #  define my_htolen(p,n)        my_swabn(p,n)
 916 #  define my_letohn(p,n)        my_swabn(p,n)
 917 #  define my_htoben(p,n)        NOOP
 918 #  define my_betohn(p,n)        NOOP
 919 /*----------------------------------------------------------------------------*/
 920 # else /*                       all other byte-orders                         */
 921 /*----------------------------------------------------------------------------*/
 922 #  define PERL_NEED_MY_HTOLE16
 923 #  define PERL_NEED_MY_LETOH16
 924 #  define PERL_NEED_MY_HTOBE16
 925 #  define PERL_NEED_MY_BETOH16
 926 #  define PERL_NEED_MY_HTOLE32
 927 #  define PERL_NEED_MY_LETOH32
 928 #  define PERL_NEED_MY_HTOBE32
 929 #  define PERL_NEED_MY_BETOH32
 930 #  ifdef HAS_QUAD
 931 #   define PERL_NEED_MY_HTOLE64
 932 #   define PERL_NEED_MY_LETOH64
 933 #   define PERL_NEED_MY_HTOBE64
 934 #   define PERL_NEED_MY_BETOH64
 935 #  endif
 936 #  define PERL_NEED_MY_HTOLES
 937 #  define PERL_NEED_MY_LETOHS
 938 #  define PERL_NEED_MY_HTOBES
 939 #  define PERL_NEED_MY_BETOHS
 940 #  define PERL_NEED_MY_HTOLEI
 941 #  define PERL_NEED_MY_LETOHI
 942 #  define PERL_NEED_MY_HTOBEI
 943 #  define PERL_NEED_MY_BETOHI
 944 #  define PERL_NEED_MY_HTOLEL
 945 #  define PERL_NEED_MY_LETOHL
 946 #  define PERL_NEED_MY_HTOBEL
 947 #  define PERL_NEED_MY_BETOHL
 948 /*----------------------------------------------------------------------------*/
 949 # endif /*                     end of byte-order macros                       */
 950 /*----------------------------------------------------------------------------*/
 951
 952 /* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
 953    at least on FreeBSD.  YMMV, so experiment.  */
 954 #ifndef PERL_ARENA_SIZE
 955 #define PERL_ARENA_SIZE 4080
 956 #endif
 957
 958 /* Maximum level of recursion */
 959 #ifndef PERL_SUB_DEPTH_WARN
 960 #define PERL_SUB_DEPTH_WARN 100
 961 #endif
 962
 963 #endif /* PERL_CORE */
 964
 965 /* We no longer default to creating a new SV for GvSV.
 966    Do this before embed.  */
 967 #ifndef PERL_CREATE_GVSV
 968 #  ifndef PERL_DONT_CREATE_GVSV
 969 #    define PERL_DONT_CREATE_GVSV
 970 #  endif
 971 #endif
 972
 973 #if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
 974 #define PERL_USES_PL_PIDSTATUS
 975 #endif
 976
 977 #if !defined(OS2) && !defined(WIN32) && !defined(DJGPP) && !defined(EPOC) && !defined(__SYMBIAN32__)
 978 #define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
 979 #endif
 980
 981 #define MEM_SIZE Size_t
 982
 983 /* Round all values passed to malloc up, by default to a multiple of
 984    sizeof(size_t)
 985 */
 986 #ifndef PERL_STRLEN_ROUNDUP_QUANTUM
 987 #define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
 988 #endif
 989
 990 /* sv_grow() will expand strings by at least a certain percentage of
 991    the previously *used* length to avoid excessive calls to realloc().
 992    The default is 25% of the current length.
 993 */
 994 #ifndef PERL_STRLEN_EXPAND_SHIFT
 995 #  define PERL_STRLEN_EXPAND_SHIFT 2
 996 #endif
 997
 998 #if defined(STANDARD_C) && defined(I_STDDEF)
 999 #   include <stddef.h>
1000 #   define STRUCT_OFFSET(s,m)  offsetof(s,m)
1001 #else
1002 #   define STRUCT_OFFSET(s,m)  (Size_t)(&(((s *)0)->m))
1003 #endif
1004
1005 #ifndef __SYMBIAN32__
1006 #  if defined(I_STRING) || defined(__cplusplus)
1007 #     include <string.h>
1008 #  else
1009 #     include <strings.h>
1010 #  endif
1011 #endif
1012
1013 /* This comes after <stdlib.h> so we don't try to change the standard
1014  * library prototypes; we'll use our own in proto.h instead. */
1015
1016 #ifdef MYMALLOC
1017 #  ifdef PERL_POLLUTE_MALLOC
1018 #   ifndef PERL_EXTMALLOC_DEF
1019 #    define Perl_malloc         malloc
1020 #    define Perl_calloc         calloc
1021 #    define Perl_realloc        realloc
1022 #    define Perl_mfree          free
1023 #   endif
1024 #  else
1025 #    define EMBEDMYMALLOC       /* for compatibility */
1026 #  endif
1027
1028 #  define safemalloc  Perl_malloc
1029 #  define safecalloc  Perl_calloc
1030 #  define saferealloc Perl_realloc
1031 #  define safefree    Perl_mfree
1032 #  define CHECK_MALLOC_TOO_LATE_FOR_(code)      STMT_START {            \
1033         if (!PL_tainting && MallocCfg_ptr[MallocCfg_cfg_env_read])      \
1034                 code;                                                   \
1035     } STMT_END
1036 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)                         \
1037         CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
1038 #  define panic_write2(s)               write(2, s, strlen(s))
1039 #  define CHECK_MALLOC_TAINT(newval)                            \
1040         CHECK_MALLOC_TOO_LATE_FOR_(                             \
1041                 if (newval) {                                   \
1042                   panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n");\
1043                   exit(1); })
1044 #  define MALLOC_CHECK_TAINT(argc,argv,env)     STMT_START {    \
1045         if (doing_taint(argc,argv,env)) {                       \
1046                 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1;      \
1047     }} STMT_END;
1048 #else  /* MYMALLOC */
1049 #  define safemalloc  safesysmalloc
1050 #  define safecalloc  safesyscalloc
1051 #  define saferealloc safesysrealloc
1052 #  define safefree    safesysfree
1053 #  define CHECK_MALLOC_TOO_LATE_FOR(ch)         ((void)0)
1054 #  define CHECK_MALLOC_TAINT(newval)            ((void)0)
1055 #  define MALLOC_CHECK_TAINT(argc,argv,env)
1056 #endif /* MYMALLOC */
1057
1058 /* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
1059 #define TOO_LATE_FOR_(ch,what)  Perl_croak(aTHX_ "\"-%c\" is on the #! line, it must also be used on the command line%s", (char)(ch), what)
1060 #define TOO_LATE_FOR(ch)        TOO_LATE_FOR_(ch, "")
1061 #define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
1062 #define MALLOC_CHECK_TAINT2(argc,argv)  MALLOC_CHECK_TAINT(argc,argv,NULL)
1063
1064 #if !defined(HAS_STRCHR) && defined(HAS_INDEX) && !defined(strchr)
1065 #define strchr index
1066 #define strrchr rindex
1067 #endif
1068
1069 #ifdef I_MEMORY
1070 #  include <memory.h>
1071 #endif
1072
1073 #ifdef HAS_MEMCPY
1074 #  if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
1075 #    ifndef memcpy
1076         extern char * memcpy (char*, char*, int);
1077 #    endif
1078 #  endif
1079 #else
1080 #   ifndef memcpy
1081 #       ifdef HAS_BCOPY
1082 #           define memcpy(d,s,l) bcopy(s,d,l)
1083 #       else
1084 #           define memcpy(d,s,l) my_bcopy(s,d,l)
1085 #       endif
1086 #   endif
1087 #endif /* HAS_MEMCPY */
1088
1089 #ifdef HAS_MEMSET
1090 #  if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
1091 #    ifndef memset
1092         extern char *memset (char*, int, int);
1093 #    endif
1094 #  endif
1095 #else
1096 #  undef  memset
1097 #  define memset(d,c,l) my_memset(d,c,l)
1098 #endif /* HAS_MEMSET */
1099
1100 #if !defined(HAS_MEMMOVE) && !defined(memmove)
1101 #   if defined(HAS_BCOPY) && defined(HAS_SAFE_BCOPY)
1102 #       define memmove(d,s,l) bcopy(s,d,l)
1103 #   else
1104 #       if defined(HAS_MEMCPY) && defined(HAS_SAFE_MEMCPY)
1105 #           define memmove(d,s,l) memcpy(d,s,l)
1106 #       else
1107 #           define memmove(d,s,l) my_bcopy(s,d,l)
1108 #       endif
1109 #   endif
1110 #endif
1111
1112 #if defined(mips) && defined(ultrix) && !defined(__STDC__)
1113 #   undef HAS_MEMCMP
1114 #endif
1115
1116 #if defined(HAS_MEMCMP) && defined(HAS_SANE_MEMCMP)
1117 #  if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
1118 #    ifndef memcmp
1119         extern int memcmp (char*, char*, int);
1120 #    endif
1121 #  endif
1122 #  ifdef BUGGY_MSC
1123 #    pragma function(memcmp)
1124 #  endif
1125 #else
1126 #   ifndef memcmp
1127 #       define memcmp   my_memcmp
1128 #   endif
1129 #endif /* HAS_MEMCMP && HAS_SANE_MEMCMP */
1130
1131 #ifndef memzero
1132 #   ifdef HAS_MEMSET
1133 #       define memzero(d,l) memset(d,0,l)
1134 #   else
1135 #       ifdef HAS_BZERO
1136 #           define memzero(d,l) bzero(d,l)
1137 #       else
1138 #           define memzero(d,l) my_bzero(d,l)
1139 #       endif
1140 #   endif
1141 #endif
1142
1143 #ifndef PERL_MICRO
1144 #ifndef memchr
1145 #   ifndef HAS_MEMCHR
1146 #       define memchr(s,c,n) ninstr((char*)(s), ((char*)(s)) + n, &(c), &(c) + 1)
1147 #   endif
1148 #endif
1149 #endif
1150
1151 #ifndef HAS_BCMP
1152 #   ifndef bcmp
1153 #       define bcmp(s1,s2,l) memcmp(s1,s2,l)
1154 #   endif
1155 #endif /* !HAS_BCMP */
1156
1157 #ifdef I_NETINET_IN
1158 #   include <netinet/in.h>
1159 #endif
1160
1161 #ifdef I_ARPA_INET
1162 #   include <arpa/inet.h>
1163 #endif
1164
1165 #if defined(SF_APPEND) && defined(USE_SFIO) && defined(I_SFIO)
1166 /* <sfio.h> defines SF_APPEND and <sys/stat.h> might define SF_APPEND
1167  * (the neo-BSD seem to do this).  */
1168 #   undef SF_APPEND
1169 #endif
1170
1171 #ifdef I_SYS_STAT
1172 #   include <sys/stat.h>
1173 #endif
1174
1175 /* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1176    This definition should ideally go into win32/win32.h, but S_IFIFO is
1177    used later here in perl.h before win32/win32.h is being included. */
1178 #if !defined(S_IFIFO) && defined(_S_IFIFO)
1179 #   define S_IFIFO _S_IFIFO
1180 #endif
1181
1182 /* The stat macros for Amdahl UTS, Unisoft System V/88 (and derivatives
1183    like UTekV) are broken, sometimes giving false positives.  Undefine
1184    them here and let the code below set them to proper values.
1185
1186    The ghs macro stands for GreenHills Software C-1.8.5 which
1187    is the C compiler for sysV88 and the various derivatives.
1188    This header file bug is corrected in gcc-2.5.8 and later versions.
1189    --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94.  */
1190
1191 #if defined(uts) || (defined(m88k) && defined(ghs))
1192 #   undef S_ISDIR
1193 #   undef S_ISCHR
1194 #   undef S_ISBLK
1195 #   undef S_ISREG
1196 #   undef S_ISFIFO
1197 #   undef S_ISLNK
1198 #endif
1199
1200 #ifdef I_TIME
1201 #   include <time.h>
1202 #endif
1203
1204 #ifdef I_SYS_TIME
1205 #   ifdef I_SYS_TIME_KERNEL
1206 #       define KERNEL
1207 #   endif
1208 #   include <sys/time.h>
1209 #   ifdef I_SYS_TIME_KERNEL
1210 #       undef KERNEL
1211 #   endif
1212 #endif
1213
1214 #if defined(HAS_TIMES) && defined(I_SYS_TIMES)
1215 #    include <sys/times.h>
1216 #endif
1217
1218 #if defined(HAS_STRERROR) && (!defined(HAS_MKDIR) || !defined(HAS_RMDIR))
1219 #   undef HAS_STRERROR
1220 #endif
1221
1222 #include <errno.h>
1223
1224 #if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
1225 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
1226 #endif
1227
1228 /* In Tru64 use the 4.4BSD struct msghdr, not the 4.3 one.
1229  * This is important for using IPv6.
1230  * For OSF/1 3.2, however, defining _SOCKADDR_LEN would be
1231  * a bad idea since it breaks send() and recv(). */
1232 #if defined(__osf__) && defined(__alpha) && !defined(_SOCKADDR_LEN) && !defined(DEC_OSF1_3_X)
1233 #   define _SOCKADDR_LEN
1234 #endif
1235
1236 #if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1237 # include <sys/socket.h>
1238 # if defined(USE_SOCKS) && defined(I_SOCKS)
1239 #   if !defined(INCLUDE_PROTOTYPES)
1240 #       define INCLUDE_PROTOTYPES /* for <socks.h> */
1241 #       define PERL_SOCKS_NEED_PROTOTYPES
1242 #   endif
1243 #   include <socks.h>
1244 #   ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1245 #       undef INCLUDE_PROTOTYPES
1246 #       undef PERL_SOCKS_NEED_PROTOTYPES
1247 #   endif
1248 # endif
1249 # ifdef I_NETDB
1250 #  ifdef NETWARE
1251 #   include<stdio.h>
1252 #  endif
1253 #  include <netdb.h>
1254 # endif
1255 # ifndef ENOTSOCK
1256 #  ifdef I_NET_ERRNO
1257 #   include <net/errno.h>
1258 #  endif
1259 # endif
1260 #endif
1261
1262 /* sockatmark() is so new (2001) that many places might have it hidden
1263  * behind some -D_BLAH_BLAH_SOURCE guard.  The __THROW magic is required
1264  * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
1265 #if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
1266 # if defined(__THROW) && defined(__GLIBC__)
1267 int sockatmark(int) __THROW;
1268 # else
1269 int sockatmark(int);
1270 # endif
1271 #endif
1272
1273 #if defined(__osf__) && defined(__cplusplus) && !defined(_XOPEN_SOURCE_EXTENDED) /* Tru64 "cxx" (C++), see hints/dec_osf.sh for why the _XOPEN_SOURCE_EXTENDED cannot be defined. */
1274 EXTERN_C int fchdir(int);
1275 EXTERN_C int flock(int, int);
1276 EXTERN_C int fseeko(FILE *, off_t, int);
1277 EXTERN_C off_t ftello(FILE *);
1278 #endif
1279
1280 #if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1281 EXTERN_C char *crypt(const char *, const char *);
1282 EXTERN_C char **environ;
1283 #endif
1284
1285 #if defined(__cplusplus)
1286 #  if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(__NetBSD__)
1287 EXTERN_C char **environ;
1288 #  elif defined(__CYGWIN__)
1289 EXTERN_C char *crypt(const char *, const char *);
1290 #endif
1291 #endif
1292
1293 #ifdef SETERRNO
1294 # undef SETERRNO  /* SOCKS might have defined this */
1295 #endif
1296
1297 #ifdef VMS
1298 #   define SETERRNO(errcode,vmserrcode) \
1299         STMT_START {                    \
1300             set_errno(errcode);         \
1301             set_vaxc_errno(vmserrcode); \
1302         } STMT_END
1303 #   define dSAVEDERRNO    int saved_errno; unsigned saved_vms_errno
1304 #   define dSAVE_ERRNO    int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1305 #   define SAVE_ERRNO     ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1306 #   define RESTORE_ERRNO  SETERRNO(saved_errno, saved_vms_errno)
1307
1308 #   define LIB_INVARG           LIB$_INVARG
1309 #   define RMS_DIR              RMS$_DIR
1310 #   define RMS_FAC              RMS$_FAC
1311 #   define RMS_FEX              RMS$_FEX
1312 #   define RMS_FNF              RMS$_FNF
1313 #   define RMS_IFI              RMS$_IFI
1314 #   define RMS_ISI              RMS$_ISI
1315 #   define RMS_PRV              RMS$_PRV
1316 #   define SS_ACCVIO            SS$_ACCVIO
1317 #   define SS_DEVOFFLINE        SS$_DEVOFFLINE
1318 #   define SS_IVCHAN            SS$_IVCHAN
1319 #   define SS_NORMAL            SS$_NORMAL
1320 #else
1321 #   define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1322 #   define dSAVEDERRNO    int saved_errno
1323 #   define dSAVE_ERRNO    int saved_errno = errno
1324 #   define SAVE_ERRNO     (saved_errno = errno)
1325 #   define RESTORE_ERRNO  (errno = saved_errno)
1326
1327 #   define LIB_INVARG           0
1328 #   define RMS_DIR              0
1329 #   define RMS_FAC              0
1330 #   define RMS_FEX              0
1331 #   define RMS_FNF              0
1332 #   define RMS_IFI              0
1333 #   define RMS_ISI              0
1334 #   define RMS_PRV              0
1335 #   define SS_ACCVIO            0
1336 #   define SS_DEVOFFLINE        0
1337 #   define SS_IVCHAN            0
1338 #   define SS_NORMAL            0
1339 #endif
1340
1341 #define ERRSV GvSVn(PL_errgv)
1342
1343 #define CLEAR_ERRSV() STMT_START {                                      \
1344     if (!GvSV(PL_errgv)) {                                              \
1345         sv_setpvs(GvSV(gv_add_by_type(PL_errgv, SVt_PV)), "");          \
1346     } else if (SvREADONLY(GvSV(PL_errgv))) {                            \
1347         SvREFCNT_dec(GvSV(PL_errgv));                                   \
1348         GvSV(PL_errgv) = newSVpvs("");                                  \
1349     } else {                                                            \
1350         SV *const errsv = GvSV(PL_errgv);                               \
1351         sv_setpvs(errsv, "");                                           \
1352         if (SvMAGICAL(errsv)) {                                         \
1353             mg_free(errsv);                                             \
1354         }                                                               \
1355         SvPOK_only(errsv);                                              \
1356     }                                                                   \
1357     } STMT_END
1358
1359
1360 #ifdef PERL_CORE
1361 # define DEFSV (0 + GvSVn(PL_defgv))
1362 # define DEFSV_set(sv) \
1363     (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1364 # define SAVE_DEFSV                \
1365     (                               \
1366         save_gp(PL_defgv, 0),        \
1367         GvINTRO_off(PL_defgv),        \
1368         SAVEGENERICSV(GvSV(PL_defgv)), \
1369         GvSV(PL_defgv) = NULL           \
1370     )
1371 #else
1372 # define DEFSV GvSVn(PL_defgv)
1373 # define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1374 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
1375 #endif
1376
1377 #define ERRHV GvHV(PL_errgv)    /* XXX unused, here for compatibility */
1378
1379 #ifndef errno
1380         extern int errno;     /* ANSI allows errno to be an lvalue expr.
1381                                * For example in multithreaded environments
1382                                * something like this might happen:
1383                                * extern int *_errno(void);
1384                                * #define errno (*_errno()) */
1385 #endif
1386
1387 #ifdef HAS_STRERROR
1388 #ifndef DONT_DECLARE_STD
1389 #       ifdef VMS
1390         char *strerror (int,...);
1391 #       else
1392         char *strerror (int);
1393 #       endif
1394 #endif
1395 #       ifndef Strerror
1396 #           define Strerror strerror
1397 #       endif
1398 #else
1399 #    ifdef HAS_SYS_ERRLIST
1400         extern int sys_nerr;
1401         extern char *sys_errlist[];
1402 #       ifndef Strerror
1403 #           define Strerror(e) \
1404                 ((e) < 0 || (e) >= sys_nerr ? "(unknown)" : sys_errlist[e])
1405 #       endif
1406 #   endif
1407 #endif
1408
1409 #ifdef I_SYS_IOCTL
1410 #   ifndef _IOCTL_
1411 #       include <sys/ioctl.h>
1412 #   endif
1413 #endif
1414
1415 #if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
1416 #   ifdef HAS_SOCKETPAIR
1417 #       undef HAS_SOCKETPAIR
1418 #   endif
1419 #   ifdef I_NDBM
1420 #       undef I_NDBM
1421 #   endif
1422 #endif
1423
1424 #ifndef HAS_SOCKETPAIR
1425 #   ifdef HAS_SOCKET
1426 #       define socketpair Perl_my_socketpair
1427 #   endif
1428 #endif
1429
1430 #if INTSIZE == 2
1431 #   define htoni htons
1432 #   define ntohi ntohs
1433 #else
1434 #   define htoni htonl
1435 #   define ntohi ntohl
1436 #endif
1437
1438 /* Configure already sets Direntry_t */
1439 #if defined(I_DIRENT)
1440 #   include <dirent.h>
1441     /* NeXT needs dirent + sys/dir.h */
1442 #   if  defined(I_SYS_DIR) && (defined(NeXT) || defined(__NeXT__))
1443 #       include <sys/dir.h>
1444 #   endif
1445 #else
1446 #   ifdef I_SYS_NDIR
1447 #       include <sys/ndir.h>
1448 #   else
1449 #       ifdef I_SYS_DIR
1450 #           ifdef hp9000s500
1451 #               include <ndir.h>        /* may be wrong in the future */
1452 #           else
1453 #               include <sys/dir.h>
1454 #           endif
1455 #       endif
1456 #   endif
1457 #endif
1458
1459 #ifdef PERL_MICRO
1460 #   ifndef DIR
1461 #      define DIR void
1462 #   endif
1463 #endif
1464
1465 #ifdef FPUTS_BOTCH
1466 /* work around botch in SunOS 4.0.1 and 4.0.2 */
1467 #   ifndef fputs
1468 #       define fputs(sv,fp) fprintf(fp,"%s",sv)
1469 #   endif
1470 #endif
1471
1472 /*
1473  * The following gobbledygook brought to you on behalf of __STDC__.
1474  * (I could just use #ifndef __STDC__, but this is more bulletproof
1475  * in the face of half-implementations.)
1476  */
1477
1478 #if defined(I_SYSMODE) && !defined(PERL_MICRO)
1479 #include <sys/mode.h>
1480 #endif
1481
1482 #ifndef S_IFMT
1483 #   ifdef _S_IFMT
1484 #       define S_IFMT _S_IFMT
1485 #   else
1486 #       define S_IFMT 0170000
1487 #   endif
1488 #endif
1489
1490 #ifndef S_ISDIR
1491 #   define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1492 #endif
1493
1494 #ifndef S_ISCHR
1495 #   define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1496 #endif
1497
1498 #ifndef S_ISBLK
1499 #   ifdef S_IFBLK
1500 #       define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1501 #   else
1502 #       define S_ISBLK(m) (0)
1503 #   endif
1504 #endif
1505
1506 #ifndef S_ISREG
1507 #   define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1508 #endif
1509
1510 #ifndef S_ISFIFO
1511 #   ifdef S_IFIFO
1512 #       define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1513 #   else
1514 #       define S_ISFIFO(m) (0)
1515 #   endif
1516 #endif
1517
1518 #ifndef S_ISLNK
1519 #   ifdef _S_ISLNK
1520 #       define S_ISLNK(m) _S_ISLNK(m)
1521 #   else
1522 #       ifdef _S_IFLNK
1523 #           define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1524 #       else
1525 #           ifdef S_IFLNK
1526 #               define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1527 #           else
1528 #               define S_ISLNK(m) (0)
1529 #           endif
1530 #       endif
1531 #   endif
1532 #endif
1533
1534 #ifndef S_ISSOCK
1535 #   ifdef _S_ISSOCK
1536 #       define S_ISSOCK(m) _S_ISSOCK(m)
1537 #   else
1538 #       ifdef _S_IFSOCK
1539 #           define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1540 #       else
1541 #           ifdef S_IFSOCK
1542 #               define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1543 #           else
1544 #               define S_ISSOCK(m) (0)
1545 #           endif
1546 #       endif
1547 #   endif
1548 #endif
1549
1550 #ifndef S_IRUSR
1551 #   ifdef S_IREAD
1552 #       define S_IRUSR S_IREAD
1553 #       define S_IWUSR S_IWRITE
1554 #       define S_IXUSR S_IEXEC
1555 #   else
1556 #       define S_IRUSR 0400
1557 #       define S_IWUSR 0200
1558 #       define S_IXUSR 0100
1559 #   endif
1560 #endif
1561
1562 #ifndef S_IRGRP
1563 #   ifdef S_IRUSR
1564 #       define S_IRGRP (S_IRUSR>>3)
1565 #       define S_IWGRP (S_IWUSR>>3)
1566 #       define S_IXGRP (S_IXUSR>>3)
1567 #   else
1568 #       define S_IRGRP 0040
1569 #       define S_IWGRP 0020
1570 #       define S_IXGRP 0010
1571 #   endif
1572 #endif
1573
1574 #ifndef S_IROTH
1575 #   ifdef S_IRUSR
1576 #       define S_IROTH (S_IRUSR>>6)
1577 #       define S_IWOTH (S_IWUSR>>6)
1578 #       define S_IXOTH (S_IXUSR>>6)
1579 #   else
1580 #       define S_IROTH 0040
1581 #       define S_IWOTH 0020
1582 #       define S_IXOTH 0010
1583 #   endif
1584 #endif
1585
1586 #ifndef S_ISUID
1587 #   define S_ISUID 04000
1588 #endif
1589
1590 #ifndef S_ISGID
1591 #   define S_ISGID 02000
1592 #endif
1593
1594 #ifndef S_IRWXU
1595 #   define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
1596 #endif
1597
1598 #ifndef S_IRWXG
1599 #   define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
1600 #endif
1601
1602 #ifndef S_IRWXO
1603 #   define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
1604 #endif
1605
1606 /* BeOS 5.0 and Haiku R1 seem to define S_IREAD and S_IWRITE in <posix/fcntl.h>
1607  * which would get included through <sys/file.h >, but that is 3000
1608  * lines in the future.  --jhi */
1609
1610 #if !defined(S_IREAD) && !(defined(__BEOS__) || defined(__HAIKU__))
1611 #   define S_IREAD S_IRUSR
1612 #endif
1613
1614 #if !defined(S_IWRITE) && !(defined(__BEOS__) || defined(__HAIKU__))
1615 #   define S_IWRITE S_IWUSR
1616 #endif
1617
1618 #ifndef S_IEXEC
1619 #   define S_IEXEC S_IXUSR
1620 #endif
1621
1622 #ifdef ff_next
1623 #   undef ff_next
1624 #endif
1625
1626 #if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
1627 #   define SLOPPYDIVIDE
1628 #endif
1629
1630 #ifdef UV
1631 #undef UV
1632 #endif
1633
1634 #ifdef  SPRINTF_E_BUG
1635 #  define sprintf UTS_sprintf_wrap
1636 #endif
1637
1638 /* For the times when you want the return value of sprintf, and you want it
1639    to be the length. Can't have a thread variable passed in, because C89 has
1640    no varargs macros.
1641 */
1642 #ifdef SPRINTF_RETURNS_STRLEN
1643 #  define my_sprintf sprintf
1644 #else
1645 #  define my_sprintf Perl_my_sprintf
1646 #endif
1647
1648 /*
1649  * If we have v?snprintf() and the C99 variadic macros, we can just
1650  * use just the v?snprintf().  It is nice to try to trap the buffer
1651  * overflow, however, so if we are DEBUGGING, and we cannot use the
1652  * gcc statement expressions, then use the function wrappers which try
1653  * to trap the overflow.  If we can use the gcc statement expressions,
1654  * we can try that even with the version that uses the C99 variadic
1655  * macros.
1656  */
1657
1658 /* Note that we do not check against snprintf()/vsnprintf() returning
1659  * negative values because that is non-standard behaviour and we use
1660  * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1661  * that should be true only if the snprintf()/vsnprintf() are true
1662  * to the standard. */
1663
1664 #if defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1665 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1666 #      define my_snprintf(buffer, len, ...) ({ int __len__ = snprintf(buffer, len, __VA_ARGS__); if ((len) > 0 && (Size_t)__len__ >= (len)) Perl_croak_nocontext("panic: snprintf buffer overflow"); __len__; })
1667 #      define PERL_MY_SNPRINTF_GUARDED
1668 #  else
1669 #    define my_snprintf(buffer, len, ...) snprintf(buffer, len, __VA_ARGS__)
1670 #  endif
1671 #else
1672 #  define my_snprintf  Perl_my_snprintf
1673 #  define PERL_MY_SNPRINTF_GUARDED
1674 #endif
1675
1676 #if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
1677 #  ifdef PERL_USE_GCC_BRACE_GROUPS
1678 #      define my_vsnprintf(buffer, len, ...) ({ int __len__ = vsnprintf(buffer, len, __VA_ARGS__); if ((len) > 0 && (Size_t)__len__ >= (len)) Perl_croak_nocontext("panic: vsnprintf buffer overflow"); __len__; })
1679 #      define PERL_MY_VSNPRINTF_GUARDED
1680 #  else
1681 #    define my_vsnprintf(buffer, len, ...) vsnprintf(buffer, len, __VA_ARGS__)
1682 #  endif
1683 #else
1684 #  define my_vsnprintf Perl_my_vsnprintf
1685 #  define PERL_MY_VSNPRINTF_GUARDED
1686 #endif
1687
1688 #ifdef HAS_STRLCAT
1689 #  define my_strlcat    strlcat
1690 #else
1691 #  define my_strlcat    Perl_my_strlcat
1692 #endif
1693
1694 #ifdef HAS_STRLCPY
1695 #  define my_strlcpy    strlcpy
1696 #else
1697 #  define my_strlcpy    Perl_my_strlcpy
1698 #endif
1699
1700 /* Configure gets this right but the UTS compiler gets it wrong.
1701    -- Hal Morris <hom00@utsglobal.com> */
1702 #ifdef UTS
1703 #  undef  UVTYPE
1704 #  define UVTYPE unsigned
1705 #endif
1706
1707 /*
1708     The IV type is supposed to be long enough to hold any integral
1709     value or a pointer.
1710     --Andy Dougherty    August 1996
1711 */
1712
1713 typedef IVTYPE IV;
1714 typedef UVTYPE UV;
1715
1716 #if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
1717 #  if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
1718 #    define IV_MAX INT64_MAX
1719 #    define IV_MIN INT64_MIN
1720 #    define UV_MAX UINT64_MAX
1721 #    ifndef UINT64_MIN
1722 #      define UINT64_MIN 0
1723 #    endif
1724 #    define UV_MIN UINT64_MIN
1725 #  else
1726 #    define IV_MAX PERL_QUAD_MAX
1727 #    define IV_MIN PERL_QUAD_MIN
1728 #    define UV_MAX PERL_UQUAD_MAX
1729 #    define UV_MIN PERL_UQUAD_MIN
1730 #  endif
1731 #  define IV_IS_QUAD
1732 #  define UV_IS_QUAD
1733 #else
1734 #  if defined(INT32_MAX) && IVSIZE == 4
1735 #    define IV_MAX INT32_MAX
1736 #    define IV_MIN INT32_MIN
1737 #    ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1738 #        define UV_MAX UINT32_MAX
1739 #    else
1740 #        define UV_MAX 4294967295U
1741 #    endif
1742 #    ifndef UINT32_MIN
1743 #      define UINT32_MIN 0
1744 #    endif
1745 #    define UV_MIN UINT32_MIN
1746 #  else
1747 #    define IV_MAX PERL_LONG_MAX
1748 #    define IV_MIN PERL_LONG_MIN
1749 #    define UV_MAX PERL_ULONG_MAX
1750 #    define UV_MIN PERL_ULONG_MIN
1751 #  endif
1752 #  if IVSIZE == 8
1753 #    define IV_IS_QUAD
1754 #    define UV_IS_QUAD
1755 #    ifndef HAS_QUAD
1756 #      define HAS_QUAD
1757 #    endif
1758 #  else
1759 #    undef IV_IS_QUAD
1760 #    undef UV_IS_QUAD
1761 #    undef HAS_QUAD
1762 #  endif
1763 #endif
1764
1765 #ifndef HAS_QUAD
1766 # undef PERL_NEED_MY_HTOLE64
1767 # undef PERL_NEED_MY_LETOH64
1768 # undef PERL_NEED_MY_HTOBE64
1769 # undef PERL_NEED_MY_BETOH64
1770 #endif
1771
1772 #if defined(uts) || defined(UTS)
1773 #       undef UV_MAX
1774 #       define UV_MAX (4294967295u)
1775 #endif
1776
1777 #define IV_DIG (BIT_DIGITS(IVSIZE * 8))
1778 #define UV_DIG (BIT_DIGITS(UVSIZE * 8))
1779
1780 #ifndef NO_PERL_PRESERVE_IVUV
1781 #define PERL_PRESERVE_IVUV      /* We like our integers to stay integers. */
1782 #endif
1783
1784 /*
1785  *  The macros INT2PTR and NUM2PTR are (despite their names)
1786  *  bi-directional: they will convert int/float to or from pointers.
1787  *  However the conversion to int/float are named explicitly:
1788  *  PTR2IV, PTR2UV, PTR2NV.
1789  *
1790  *  For int conversions we do not need two casts if pointers are
1791  *  the same size as IV and UV.   Otherwise we need an explicit
1792  *  cast (PTRV) to avoid compiler warnings.
1793  */
1794 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1795 #  define PTRV                  UV
1796 #  define INT2PTR(any,d)        (any)(d)
1797 #else
1798 #  if PTRSIZE == LONGSIZE
1799 #    define PTRV                unsigned long
1800 #    define PTR2ul(p)           (unsigned long)(p)
1801 #  else
1802 #    define PTRV                unsigned
1803 #  endif
1804 #endif
1805
1806 #ifndef INT2PTR
1807 #  define INT2PTR(any,d)        (any)(PTRV)(d)
1808 #endif
1809
1810 #ifndef PTR2ul
1811 #  define PTR2ul(p)     INT2PTR(unsigned long,p)
1812 #endif
1813
1814 #define NUM2PTR(any,d)  (any)(PTRV)(d)
1815 #define PTR2IV(p)       INT2PTR(IV,p)
1816 #define PTR2UV(p)       INT2PTR(UV,p)
1817 #define PTR2NV(p)       NUM2PTR(NV,p)
1818 #define PTR2nat(p)      (PTRV)(p)       /* pointer to integer of PTRSIZE */
1819
1820 /* According to strict ANSI C89 one cannot freely cast between
1821  * data pointers and function (code) pointers.  There are at least
1822  * two ways around this.  One (used below) is to do two casts,
1823  * first the other pointer to an (unsigned) integer, and then
1824  * the integer to the other pointer.  The other way would be
1825  * to use unions to "overlay" the pointers.  For an example of
1826  * the latter technique, see union dirpu in struct xpvio in sv.h.
1827  * The only feasible use is probably temporarily storing
1828  * function pointers in a data pointer (such as a void pointer). */
1829
1830 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
1831 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
1832
1833 #ifdef USE_LONG_DOUBLE
1834 #  if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE == DOUBLESIZE
1835 #      define LONG_DOUBLE_EQUALS_DOUBLE
1836 #  endif
1837 #  if !(defined(HAS_LONG_DOUBLE) && (LONG_DOUBLESIZE > DOUBLESIZE))
1838 #     undef USE_LONG_DOUBLE /* Ouch! */
1839 #  endif
1840 #endif
1841
1842 #ifdef OVR_DBL_DIG
1843 /* Use an overridden DBL_DIG */
1844 # ifdef DBL_DIG
1845 #  undef DBL_DIG
1846 # endif
1847 # define DBL_DIG OVR_DBL_DIG
1848 #else
1849 /* The following is all to get DBL_DIG, in order to pick a nice
1850    default value for printing floating point numbers in Gconvert
1851    (see config.h). (It also has other uses, such as figuring out if
1852    a given precision of printing can be done with a double instead of
1853    a long double - Allen).
1854 */
1855 #ifdef I_LIMITS
1856 #include <limits.h>
1857 #endif
1858 #ifdef I_FLOAT
1859 #include <float.h>
1860 #endif
1861 #ifndef HAS_DBL_DIG
1862 #define DBL_DIG 15   /* A guess that works lots of places */
1863 #endif
1864 #endif
1865
1866 #ifdef OVR_LDBL_DIG
1867 /* Use an overridden LDBL_DIG */
1868 # ifdef LDBL_DIG
1869 #  undef LDBL_DIG
1870 # endif
1871 # define LDBL_DIG OVR_LDBL_DIG
1872 #else
1873 /* The following is all to get LDBL_DIG, in order to pick a nice
1874    default value for printing floating point numbers in Gconvert.
1875    (see config.h)
1876 */
1877 # ifdef I_LIMITS
1878 #   include <limits.h>
1879 # endif
1880 # ifdef I_FLOAT
1881 #  include <float.h>
1882 # endif
1883 # ifndef HAS_LDBL_DIG
1884 #  if LONG_DOUBLESIZE == 10
1885 #   define LDBL_DIG 18 /* assume IEEE */
1886 #  else
1887 #   if LONG_DOUBLESIZE == 12
1888 #    define LDBL_DIG 18 /* gcc? */
1889 #   else
1890 #    if LONG_DOUBLESIZE == 16
1891 #     define LDBL_DIG 33 /* assume IEEE */
1892 #    else
1893 #     if LONG_DOUBLESIZE == DOUBLESIZE
1894 #      define LDBL_DIG DBL_DIG /* bummer */
1895 #     endif
1896 #    endif
1897 #   endif
1898 #  endif
1899 # endif
1900 #endif
1901
1902 /*
1903  * This is for making sure we have a good DBL_MAX value, if possible,
1904  * either for usage as NV_MAX or for usage in figuring out if we can
1905  * fit a given long double into a double, if bug-fixing makes it
1906  * necessary to do so. - Allen <allens@cpan.org>
1907  */
1908
1909 #ifdef I_LIMITS
1910 #  include <limits.h>
1911 #endif
1912
1913 #ifdef I_VALUES
1914 #  if !(defined(DBL_MIN) && defined(DBL_MAX) && defined(I_LIMITS))
1915 #    include <values.h>
1916 #    if defined(MAXDOUBLE) && !defined(DBL_MAX)
1917 #      define DBL_MAX MAXDOUBLE
1918 #    endif
1919 #    if defined(MINDOUBLE) && !defined(DBL_MIN)
1920 #      define DBL_MIN MINDOUBLE
1921 #    endif
1922 #  endif
1923 #endif /* defined(I_VALUES) */
1924
1925 typedef NVTYPE NV;
1926
1927 #ifdef I_IEEEFP
1928 #   include <ieeefp.h>
1929 #endif
1930
1931 #ifdef USE_LONG_DOUBLE
1932 #   ifdef I_SUNMATH
1933 #       include <sunmath.h>
1934 #   endif
1935 #   define NV_DIG LDBL_DIG
1936 #   ifdef LDBL_MANT_DIG
1937 #       define NV_MANT_DIG LDBL_MANT_DIG
1938 #   endif
1939 #   ifdef LDBL_MIN
1940 #       define NV_MIN LDBL_MIN
1941 #   endif
1942 #   ifdef LDBL_MAX
1943 #       define NV_MAX LDBL_MAX
1944 #   endif
1945 #   ifdef LDBL_MIN_10_EXP
1946 #       define NV_MIN_10_EXP LDBL_MIN_10_EXP
1947 #   endif
1948 #   ifdef LDBL_MAX_10_EXP
1949 #       define NV_MAX_10_EXP LDBL_MAX_10_EXP
1950 #   endif
1951 #   ifdef LDBL_EPSILON
1952 #       define NV_EPSILON LDBL_EPSILON
1953 #   endif
1954 #   ifdef LDBL_MAX
1955 #       define NV_MAX LDBL_MAX
1956 /* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
1957 #   else
1958 #       ifdef HUGE_VALL
1959 #           define NV_MAX HUGE_VALL
1960 #       else
1961 #           ifdef HUGE_VAL
1962 #               define NV_MAX ((NV)HUGE_VAL)
1963 #           endif
1964 #       endif
1965 #   endif
1966 #   ifdef HAS_SQRTL
1967 #       define Perl_cos cosl
1968 #       define Perl_sin sinl
1969 #       define Perl_sqrt sqrtl
1970 #       define Perl_exp expl
1971 #       define Perl_log logl
1972 #       define Perl_atan2 atan2l
1973 #       define Perl_pow powl
1974 #       define Perl_floor floorl
1975 #       define Perl_ceil ceill
1976 #       define Perl_fmod fmodl
1977 #   endif
1978 /* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
1979 #   ifdef HAS_MODFL
1980 #       define Perl_modf(x,y) modfl(x,y)
1981 /* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
1982    prototype in <math.h> */
1983 #       ifndef HAS_MODFL_PROTO
1984 EXTERN_C long double modfl(long double, long double *);
1985 #       endif
1986 #   else
1987 #       if defined(HAS_AINTL) && defined(HAS_COPYSIGNL)
1988         extern long double Perl_my_modfl(long double x, long double *ip);
1989 #           define Perl_modf(x,y) Perl_my_modfl(x,y)
1990 #       endif
1991 #   endif
1992 #   ifdef HAS_FREXPL
1993 #       define Perl_frexp(x,y) frexpl(x,y)
1994 #   else
1995 #       if defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1996         extern long double Perl_my_frexpl(long double x, int *e);
1997 #           define Perl_frexp(x,y) Perl_my_frexpl(x,y)
1998 #       endif
1999 #   endif
2000 #   ifndef Perl_isnan
2001 #       ifdef HAS_ISNANL
2002 #           define Perl_isnan(x) isnanl(x)
2003 #       endif
2004 #   endif
2005 #   ifndef Perl_isinf
2006 #       ifdef HAS_FINITEL
2007 #           define Perl_isinf(x) !(finitel(x)||Perl_isnan(x))
2008 #       endif
2009 #   endif
2010 #else
2011 #   define NV_DIG DBL_DIG
2012 #   ifdef DBL_MANT_DIG
2013 #       define NV_MANT_DIG DBL_MANT_DIG
2014 #   endif
2015 #   ifdef DBL_MIN
2016 #       define NV_MIN DBL_MIN
2017 #   endif
2018 #   ifdef DBL_MAX
2019 #       define NV_MAX DBL_MAX
2020 #   endif
2021 #   ifdef DBL_MIN_10_EXP
2022 #       define NV_MIN_10_EXP DBL_MIN_10_EXP
2023 #   endif
2024 #   ifdef DBL_MAX_10_EXP
2025 #       define NV_MAX_10_EXP DBL_MAX_10_EXP
2026 #   endif
2027 #   ifdef DBL_EPSILON
2028 #       define NV_EPSILON DBL_EPSILON
2029 #   endif
2030 #   ifdef DBL_MAX               /* XXX Does DBL_MAX imply having DBL_MIN? */
2031 #       define NV_MAX DBL_MAX
2032 #       define NV_MIN DBL_MIN
2033 #   else
2034 #       ifdef HUGE_VAL
2035 #           define NV_MAX HUGE_VAL
2036 #       endif
2037 #   endif
2038 #   define Perl_cos cos
2039 #   define Perl_sin sin
2040 #   define Perl_sqrt sqrt
2041 #   define Perl_exp exp
2042 #   define Perl_log log
2043 #   define Perl_atan2 atan2
2044 #   define Perl_pow pow
2045 #   define Perl_floor floor
2046 #   define Perl_ceil ceil
2047 #   define Perl_fmod fmod
2048 #   define Perl_modf(x,y) modf(x,y)
2049 #   define Perl_frexp(x,y) frexp(x,y)
2050 #endif
2051
2052 /* rumor has it that Win32 has _fpclass() */
2053
2054 /* SGI has fpclassl... but not with the same result values,
2055  * and it's via a typedef (not via #define), so will need to redo Configure
2056  * to use. Not worth the trouble, IMO, at least until the below is used
2057  * more places. Also has fp_class_l, BTW, via fp_class.h. Feel free to check
2058  * with me for the SGI manpages, SGI testing, etcetera, if you want to
2059  * try getting this to work with IRIX. - Allen <allens@cpan.org> */
2060
2061 #if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
2062 #    ifdef I_IEEFP
2063 #        include <ieeefp.h>
2064 #    endif
2065 #    ifdef I_FP
2066 #        include <fp.h>
2067 #    endif
2068 #    if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
2069 #        define Perl_fp_class()         fpclassl(x)
2070 #    else
2071 #        define Perl_fp_class()         fpclass(x)
2072 #    endif
2073 #    define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_CLASS_SNAN)
2074 #    define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_CLASS_QNAN)
2075 #    define Perl_fp_class_nan(x)        (Perl_fp_class(x)==FP_CLASS_SNAN||Perl_fp_class(x)==FP_CLASS_QNAN)
2076 #    define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_CLASS_NINF)
2077 #    define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_CLASS_PINF)
2078 #    define Perl_fp_class_inf(x)        (Perl_fp_class(x)==FP_CLASS_NINF||Perl_fp_class(x)==FP_CLASS_PINF)
2079 #    define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_CLASS_NNORM)
2080 #    define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_CLASS_PNORM)
2081 #    define Perl_fp_class_norm(x)       (Perl_fp_class(x)==FP_CLASS_NNORM||Perl_fp_class(x)==FP_CLASS_PNORM)
2082 #    define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_CLASS_NDENORM)
2083 #    define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_CLASS_PDENORM)
2084 #    define Perl_fp_class_denorm(x)     (Perl_fp_class(x)==FP_CLASS_NDENORM||Perl_fp_class(x)==FP_CLASS_PDENORM)
2085 #    define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_CLASS_NZERO)
2086 #    define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_CLASS_PZERO)
2087 #    define Perl_fp_class_zero(x)       (Perl_fp_class(x)==FP_CLASS_NZERO||Perl_fp_class(x)==FP_CLASS_PZERO)
2088 #endif
2089
2090 #if !defined(Perl_fp_class) && defined(HAS_FP_CLASS) && !defined(PERL_MICRO)
2091 #    include <math.h>
2092 #    if !defined(FP_SNAN) && defined(I_FP_CLASS)
2093 #        include <fp_class.h>
2094 #    endif
2095 #    define Perl_fp_class(x)            fp_class(x)
2096 #    define Perl_fp_class_snan(x)       (fp_class(x)==FP_SNAN)
2097 #    define Perl_fp_class_qnan(x)       (fp_class(x)==FP_QNAN)
2098 #    define Perl_fp_class_nan(x)        (fp_class(x)==FP_SNAN||fp_class(x)==FP_QNAN)
2099 #    define Perl_fp_class_ninf(x)       (fp_class(x)==FP_NEG_INF)
2100 #    define Perl_fp_class_pinf(x)       (fp_class(x)==FP_POS_INF)
2101 #    define Perl_fp_class_inf(x)        (fp_class(x)==FP_NEG_INF||fp_class(x)==FP_POS_INF)
2102 #    define Perl_fp_class_nnorm(x)      (fp_class(x)==FP_NEG_NORM)
2103 #    define Perl_fp_class_pnorm(x)      (fp_class(x)==FP_POS_NORM)
2104 #    define Perl_fp_class_norm(x)       (fp_class(x)==FP_NEG_NORM||fp_class(x)==FP_POS_NORM)
2105 #    define Perl_fp_class_ndenorm(x)    (fp_class(x)==FP_NEG_DENORM)
2106 #    define Perl_fp_class_pdenorm(x)    (fp_class(x)==FP_POS_DENORM)
2107 #    define Perl_fp_class_denorm(x)     (fp_class(x)==FP_NEG_DENORM||fp_class(x)==FP_POS_DENORM)
2108 #    define Perl_fp_class_nzero(x)      (fp_class(x)==FP_NEG_ZERO)
2109 #    define Perl_fp_class_pzero(x)      (fp_class(x)==FP_POS_ZERO)
2110 #    define Perl_fp_class_zero(x)       (fp_class(x)==FP_NEG_ZERO||fp_class(x)==FP_POS_ZERO)
2111 #endif
2112
2113 #if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
2114 #    include <math.h>
2115 #    define Perl_fp_class(x)            fpclassify(x)
2116 #    define Perl_fp_class_nan(x)        (fp_classify(x)==FP_SNAN||fp_classify(x)==FP_QNAN)
2117 #    define Perl_fp_class_inf(x)        (fp_classify(x)==FP_INFINITE)
2118 #    define Perl_fp_class_norm(x)       (fp_classify(x)==FP_NORMAL)
2119 #    define Perl_fp_class_denorm(x)     (fp_classify(x)==FP_SUBNORMAL)
2120 #    define Perl_fp_class_zero(x)       (fp_classify(x)==FP_ZERO)
2121 #endif
2122
2123 #if !defined(Perl_fp_class) && defined(HAS_CLASS)
2124 #    include <math.h>
2125 #    ifndef _cplusplus
2126 #        define Perl_fp_class(x)        class(x)
2127 #    else
2128 #        define Perl_fp_class(x)        _class(x)
2129 #    endif
2130 #    define Perl_fp_class_snan(x)       (Perl_fp_class(x)==FP_NANS)
2131 #    define Perl_fp_class_qnan(x)       (Perl_fp_class(x)==FP_NANQ)
2132 #    define Perl_fp_class_nan(x)        (Perl_fp_class(x)==FP_SNAN||Perl_fp_class(x)==FP_QNAN)
2133 #    define Perl_fp_class_ninf(x)       (Perl_fp_class(x)==FP_MINUS_INF)
2134 #    define Perl_fp_class_pinf(x)       (Perl_fp_class(x)==FP_PLUS_INF)
2135 #    define Perl_fp_class_inf(x)        (Perl_fp_class(x)==FP_MINUS_INF||Perl_fp_class(x)==FP_PLUS_INF)
2136 #    define Perl_fp_class_nnorm(x)      (Perl_fp_class(x)==FP_MINUS_NORM)
2137 #    define Perl_fp_class_pnorm(x)      (Perl_fp_class(x)==FP_PLUS_NORM)
2138 #    define Perl_fp_class_norm(x)       (Perl_fp_class(x)==FP_MINUS_NORM||Perl_fp_class(x)==FP_PLUS_NORM)
2139 #    define Perl_fp_class_ndenorm(x)    (Perl_fp_class(x)==FP_MINUS_DENORM)
2140 #    define Perl_fp_class_pdenorm(x)    (Perl_fp_class(x)==FP_PLUS_DENORM)
2141 #    define Perl_fp_class_denorm(x)     (Perl_fp_class(x)==FP_MINUS_DENORM||Perl_fp_class(x)==FP_PLUS_DENORM)
2142 #    define Perl_fp_class_nzero(x)      (Perl_fp_class(x)==FP_MINUS_ZERO)
2143 #    define Perl_fp_class_pzero(x)      (Perl_fp_class(x)==FP_PLUS_ZERO)
2144 #    define Perl_fp_class_zero(x)       (Perl_fp_class(x)==FP_MINUS_ZERO||Perl_fp_class(x)==FP_PLUS_ZERO)
2145 #endif
2146
2147 /* rumor has it that Win32 has _isnan() */
2148
2149 #ifndef Perl_isnan
2150 #   ifdef HAS_ISNAN
2151 #       define Perl_isnan(x) isnan((NV)x)
2152 #   else
2153 #       ifdef Perl_fp_class_nan
2154 #           define Perl_isnan(x) Perl_fp_class_nan(x)
2155 #       else
2156 #           ifdef HAS_UNORDERED
2157 #               define Perl_isnan(x) unordered((x), 0.0)
2158 #           else
2159 #               define Perl_isnan(x) ((x)!=(x))
2160 #           endif
2161 #       endif
2162 #   endif
2163 #endif
2164
2165 #ifdef UNDER_CE
2166 int isnan(double d);
2167 #endif
2168
2169 #ifndef Perl_isinf
2170 #   ifdef HAS_ISINF
2171 #       define Perl_isinf(x) isinf((NV)x)
2172 #   else
2173 #       ifdef Perl_fp_class_inf
2174 #           define Perl_isinf(x) Perl_fp_class_inf(x)
2175 #       else
2176 #           define Perl_isinf(x) ((x)==NV_INF)
2177 #       endif
2178 #   endif
2179 #endif
2180
2181 #ifndef Perl_isfinite
2182 #   ifdef HAS_FINITE
2183 #       define Perl_isfinite(x) finite((NV)x)
2184 #   else
2185 #       ifdef HAS_ISFINITE
2186 #           define Perl_isfinite(x) isfinite(x)
2187 #       else
2188 #           ifdef Perl_fp_class_finite
2189 #               define Perl_isfinite(x) Perl_fp_class_finite(x)
2190 #           else
2191 #               define Perl_isfinite(x) !(Perl_is_inf(x)||Perl_is_nan(x))
2192 #           endif
2193 #       endif
2194 #   endif
2195 #endif
2196
2197 /* The default is to use Perl's own atof() implementation (in numeric.c).
2198  * Usually that is the one to use but for some platforms (e.g. UNICOS)
2199  * it is however best to use the native implementation of atof.
2200  * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2201  * Some good tests to try out with either setting are t/base/num.t,
2202  * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2203  * you may need to be using a different function than atof! */
2204
2205 #ifndef USE_PERL_ATOF
2206 #   ifndef _UNICOS
2207 #       define USE_PERL_ATOF
2208 #   endif
2209 #else
2210 #   if USE_PERL_ATOF == 0
2211 #       undef USE_PERL_ATOF
2212 #   endif
2213 #endif
2214
2215 #ifdef USE_PERL_ATOF
2216 #   define Perl_atof(s) Perl_my_atof(s)
2217 #   define Perl_atof2(s, n) Perl_my_atof2(aTHX_ (s), &(n))
2218 #else
2219 #   define Perl_atof(s) (NV)atof(s)
2220 #   define Perl_atof2(s, n) ((n) = atof(s))
2221 #endif
2222
2223 /* Previously these definitions used hardcoded figures.
2224  * It is hoped these formula are more portable, although
2225  * no data one way or another is presently known to me.
2226  * The "PERL_" names are used because these calculated constants
2227  * do not meet the ANSI requirements for LONG_MAX, etc., which
2228  * need to be constants acceptable to #if - kja
2229  *    define PERL_LONG_MAX        2147483647L
2230  *    define PERL_LONG_MIN        (-LONG_MAX - 1)
2231  *    define PERL ULONG_MAX       4294967295L
2232  */
2233
2234 #ifdef I_LIMITS  /* Needed for cast_xxx() functions below. */
2235 #  include <limits.h>
2236 #endif
2237 /* Included values.h above if necessary; still including limits.h down here,
2238  * despite doing above, because math.h might have overridden... XXX - Allen */
2239
2240 /*
2241  * Try to figure out max and min values for the integral types.  THE CORRECT
2242  * SOLUTION TO THIS MESS: ADAPT enquire.c FROM GCC INTO CONFIGURE.  The
2243  * following hacks are used if neither limits.h or values.h provide them:
2244  * U<TYPE>_MAX: for types >= int: ~(unsigned TYPE)0
2245  *              for types <  int:  (unsigned TYPE)~(unsigned)0
2246  *      The argument to ~ must be unsigned so that later signed->unsigned
2247  *      conversion can't modify the value's bit pattern (e.g. -0 -> +0),
2248  *      and it must not be smaller than int because ~ does integral promotion.
2249  * <type>_MAX: (<type>) (U<type>_MAX >> 1)
2250  * <type>_MIN: -<type>_MAX - <is_twos_complement_architecture: (3 & -1) == 3>.
2251  *      The latter is a hack which happens to work on some machines but
2252  *      does *not* catch any random system, or things like integer types
2253  *      with NaN if that is possible.
2254  *
2255  * All of the types are explicitly cast to prevent accidental loss of
2256  * numeric range, and in the hope that they will be less likely to confuse
2257  * over-eager optimizers.
2258  *
2259  */
2260
2261 #define PERL_UCHAR_MIN ((unsigned char)0)
2262
2263 #ifdef UCHAR_MAX
2264 #  define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
2265 #else
2266 #  ifdef MAXUCHAR
2267 #    define PERL_UCHAR_MAX ((unsigned char)MAXUCHAR)
2268 #  else
2269 #    define PERL_UCHAR_MAX       ((unsigned char)~(unsigned)0)
2270 #  endif
2271 #endif
2272
2273 /*
2274  * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2275  * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2276  * depending on local options. Until Configure detects this (or at least
2277  * detects whether the "signed" keyword is available) the CHAR ranges
2278  * will not be included. UCHAR functions normally.
2279  *                                                           - kja
2280  */
2281
2282 #define PERL_USHORT_MIN ((unsigned short)0)
2283
2284 #ifdef USHORT_MAX
2285 #  define PERL_USHORT_MAX ((unsigned short)USHORT_MAX)
2286 #else
2287 #  ifdef MAXUSHORT
2288 #    define PERL_USHORT_MAX ((unsigned short)MAXUSHORT)
2289 #  else
2290 #    ifdef USHRT_MAX
2291 #      define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2292 #    else
2293 #      define PERL_USHORT_MAX       ((unsigned short)~(unsigned)0)
2294 #    endif
2295 #  endif
2296 #endif
2297
2298 #ifdef SHORT_MAX
2299 #  define PERL_SHORT_MAX ((short)SHORT_MAX)
2300 #else
2301 #  ifdef MAXSHORT    /* Often used in <values.h> */
2302 #    define PERL_SHORT_MAX ((short)MAXSHORT)
2303 #  else
2304 #    ifdef SHRT_MAX
2305 #      define PERL_SHORT_MAX ((short)SHRT_MAX)
2306 #    else
2307 #      define PERL_SHORT_MAX      ((short) (PERL_USHORT_MAX >> 1))
2308 #    endif
2309 #  endif
2310 #endif
2311
2312 #ifdef SHORT_MIN
2313 #  define PERL_SHORT_MIN ((short)SHORT_MIN)
2314 #else
2315 #  ifdef MINSHORT
2316 #    define PERL_SHORT_MIN ((short)MINSHORT)
2317 #  else
2318 #    ifdef SHRT_MIN
2319 #      define PERL_SHORT_MIN ((short)SHRT_MIN)
2320 #    else
2321 #      define PERL_SHORT_MIN        (-PERL_SHORT_MAX - ((3 & -1) == 3))
2322 #    endif
2323 #  endif
2324 #endif
2325
2326 #ifdef UINT_MAX
2327 #  define PERL_UINT_MAX ((unsigned int)UINT_MAX)
2328 #else
2329 #  ifdef MAXUINT
2330 #    define PERL_UINT_MAX ((unsigned int)MAXUINT)
2331 #  else
2332 #    define PERL_UINT_MAX       (~(unsigned int)0)
2333 #  endif
2334 #endif
2335
2336 #define PERL_UINT_MIN ((unsigned int)0)
2337
2338 #ifdef INT_MAX
2339 #  define PERL_INT_MAX ((int)INT_MAX)
2340 #else
2341 #  ifdef MAXINT    /* Often used in <values.h> */
2342 #    define PERL_INT_MAX ((int)MAXINT)
2343 #  else
2344 #    define PERL_INT_MAX        ((int)(PERL_UINT_MAX >> 1))
2345 #  endif
2346 #endif
2347
2348 #ifdef INT_MIN
2349 #  define PERL_INT_MIN ((int)INT_MIN)
2350 #else
2351 #  ifdef MININT
2352 #    define PERL_INT_MIN ((int)MININT)
2353 #  else
2354 #    define PERL_INT_MIN        (-PERL_INT_MAX - ((3 & -1) == 3))
2355 #  endif
2356 #endif
2357
2358 #ifdef ULONG_MAX
2359 #  define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
2360 #else
2361 #  ifdef MAXULONG
2362 #    define PERL_ULONG_MAX ((unsigned long)MAXULONG)
2363 #  else
2364 #    define PERL_ULONG_MAX       (~(unsigned long)0)
2365 #  endif
2366 #endif
2367
2368 #define PERL_ULONG_MIN ((unsigned long)0L)
2369
2370 #ifdef LONG_MAX
2371 #  define PERL_LONG_MAX ((long)LONG_MAX)
2372 #else
2373 #  ifdef MAXLONG    /* Often used in <values.h> */
2374 #    define PERL_LONG_MAX ((long)MAXLONG)
2375 #  else
2376 #    define PERL_LONG_MAX        ((long) (PERL_ULONG_MAX >> 1))
2377 #  endif
2378 #endif
2379
2380 #ifdef LONG_MIN
2381 #  define PERL_LONG_MIN ((long)LONG_MIN)
2382 #else
2383 #  ifdef MINLONG
2384 #    define PERL_LONG_MIN ((long)MINLONG)
2385 #  else
2386 #    define PERL_LONG_MIN        (-PERL_LONG_MAX - ((3 & -1) == 3))
2387 #  endif
2388 #endif
2389
2390 #ifdef UV_IS_QUAD
2391
2392 #    define PERL_UQUAD_MAX      (~(UV)0)
2393 #    define PERL_UQUAD_MIN      ((UV)0)
2394 #    define PERL_QUAD_MAX       ((IV) (PERL_UQUAD_MAX >> 1))
2395 #    define PERL_QUAD_MIN       (-PERL_QUAD_MAX - ((3 & -1) == 3))
2396
2397 #endif
2398
2399 struct RExC_state_t;
2400 struct _reg_trie_data;
2401
2402 typedef MEM_SIZE STRLEN;
2403
2404 #ifdef PERL_MAD
2405 typedef struct token TOKEN;
2406 typedef struct madprop MADPROP;
2407 typedef struct nexttoken NEXTTOKE;
2408 #endif
2409 typedef struct op OP;
2410 typedef struct cop COP;
2411 typedef struct unop UNOP;
2412 typedef struct binop BINOP;
2413 typedef struct listop LISTOP;
2414 typedef struct logop LOGOP;
2415 typedef struct pmop PMOP;
2416 typedef struct svop SVOP;
2417 typedef struct padop PADOP;
2418 typedef struct pvop PVOP;
2419 typedef struct loop LOOP;
2420
2421 typedef struct block_hooks BHK;
2422 typedef struct custom_op XOP;
2423
2424 typedef struct interpreter PerlInterpreter;
2425
2426 /* Amdahl's <ksync.h> has struct sv */
2427 /* SGI's <sys/sema.h> has struct sv */
2428 #if defined(UTS) || defined(__sgi)
2429 #   define STRUCT_SV perl_sv
2430 #else
2431 #   define STRUCT_SV sv
2432 #endif
2433 typedef struct STRUCT_SV SV;
2434 typedef struct av AV;
2435 typedef struct hv HV;
2436 typedef struct cv CV;
2437 typedef struct p5rx REGEXP;
2438 typedef struct gp GP;
2439 typedef struct gv GV;
2440 typedef struct io IO;
2441 typedef struct context PERL_CONTEXT;
2442 typedef struct block BLOCK;
2443
2444 typedef struct magic MAGIC;
2445 typedef struct xpv XPV;
2446 typedef struct xpviv XPVIV;
2447 typedef struct xpvuv XPVUV;
2448 typedef struct xpvnv XPVNV;
2449 typedef struct xpvmg XPVMG;
2450 typedef struct xpvlv XPVLV;
2451 typedef struct xpvav XPVAV;
2452 typedef struct xpvhv XPVHV;
2453 typedef struct xpvgv XPVGV;
2454 typedef struct xpvcv XPVCV;
2455 typedef struct xpvbm XPVBM;
2456 typedef struct xpvfm XPVFM;
2457 typedef struct xpvio XPVIO;
2458 typedef struct mgvtbl MGVTBL;
2459 typedef union any ANY;
2460 typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2461 typedef struct ptr_tbl PTR_TBL_t;
2462 typedef struct clone_params CLONE_PARAMS;
2463
2464 #include "handy.h"
2465
2466 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
2467 #   if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2468 #       define USE_64_BIT_RAWIO /* implicit */
2469 #   endif
2470 #endif
2471
2472 /* Notice the use of HAS_FSEEKO: now we are obligated to always use
2473  * fseeko/ftello if possible.  Don't go #defining ftell to ftello yourself,
2474  * however, because operating systems like to do that themself. */
2475 #ifndef FSEEKSIZE
2476 #   ifdef HAS_FSEEKO
2477 #       define FSEEKSIZE LSEEKSIZE
2478 #   else
2479 #       define FSEEKSIZE LONGSIZE
2480 #   endif
2481 #endif
2482
2483 #if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
2484 #   if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2485 #       define USE_64_BIT_STDIO /* implicit */
2486 #   endif
2487 #endif
2488
2489 #ifdef USE_64_BIT_RAWIO
2490 #   ifdef HAS_OFF64_T
2491 #       undef Off_t
2492 #       define Off_t off64_t
2493 #       undef LSEEKSIZE
2494 #       define LSEEKSIZE 8
2495 #   endif
2496 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2497  * will trigger defines like the ones below.  Some 64-bit environments,
2498  * however, do not.  Therefore we have to explicitly mix and match. */
2499 #   if defined(USE_OPEN64)
2500 #       define open open64
2501 #   endif
2502 #   if defined(USE_LSEEK64)
2503 #       define lseek lseek64
2504 #   else
2505 #       if defined(USE_LLSEEK)
2506 #           define lseek llseek
2507 #       endif
2508 #   endif
2509 #   if defined(USE_STAT64)
2510 #       define stat stat64
2511 #   endif
2512 #   if defined(USE_FSTAT64)
2513 #       define fstat fstat64
2514 #   endif
2515 #   if defined(USE_LSTAT64)
2516 #       define lstat lstat64
2517 #   endif
2518 #   if defined(USE_FLOCK64)
2519 #       define flock flock64
2520 #   endif
2521 #   if defined(USE_LOCKF64)
2522 #       define lockf lockf64
2523 #   endif
2524 #   if defined(USE_FCNTL64)
2525 #       define fcntl fcntl64
2526 #   endif
2527 #   if defined(USE_TRUNCATE64)
2528 #       define truncate truncate64
2529 #   endif
2530 #   if defined(USE_FTRUNCATE64)
2531 #       define ftruncate ftruncate64
2532 #   endif
2533 #endif
2534
2535 #ifdef USE_64_BIT_STDIO
2536 #   ifdef HAS_FPOS64_T
2537 #       undef Fpos_t
2538 #       define Fpos_t fpos64_t
2539 #   endif
2540 /* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2541  * will trigger defines like the ones below.  Some 64-bit environments,
2542  * however, do not. */
2543 #   if defined(USE_FOPEN64)
2544 #       define fopen fopen64
2545 #   endif
2546 #   if defined(USE_FSEEK64)
2547 #       define fseek fseek64 /* don't do fseeko here, see perlio.c */
2548 #   endif
2549 #   if defined(USE_FTELL64)
2550 #       define ftell ftell64 /* don't do ftello here, see perlio.c */
2551 #   endif
2552 #   if defined(USE_FSETPOS64)
2553 #       define fsetpos fsetpos64
2554 #   endif
2555 #   if defined(USE_FGETPOS64)
2556 #       define fgetpos fgetpos64
2557 #   endif
2558 #   if defined(USE_TMPFILE64)
2559 #       define tmpfile tmpfile64
2560 #   endif
2561 #   if defined(USE_FREOPEN64)
2562 #       define freopen freopen64
2563 #   endif
2564 #endif
2565
2566 #if defined(OS2)
2567 #  include "iperlsys.h"
2568 #endif
2569
2570 #if defined(__OPEN_VM)
2571 #   include "vmesa/vmesaish.h"
2572 #   define ISHISH "vmesa"
2573 #endif
2574
2575 #ifdef DOSISH
2576 #   if defined(OS2)
2577 #       include "os2ish.h"
2578 #   else
2579 #       include "dosish.h"
2580 #   endif
2581 #   define ISHISH "dos"
2582 #endif
2583
2584 #if defined(VMS)
2585 #   include "vmsish.h"
2586 #   define ISHISH "vms"
2587 #endif
2588
2589 #if defined(PLAN9)
2590 #   include "./plan9/plan9ish.h"
2591 #   define ISHISH "plan9"
2592 #endif
2593
2594 #if defined(MPE)
2595 #  include "mpeix/mpeixish.h"
2596 #  define ISHISH "mpeix"
2597 #endif
2598
2599 #if defined(__VOS__)
2600 #   ifdef __GNUC__
2601 #     include "./vos/vosish.h"
2602 #   else
2603 #     include "vos/vosish.h"
2604 #   endif
2605 #   define ISHISH "vos"
2606 #endif
2607
2608 #if defined(EPOC)
2609 #   include "epocish.h"
2610 #   define ISHISH "epoc"
2611 #endif
2612
2613 #ifdef __SYMBIAN32__
2614 #   include "symbian/symbianish.h"
2615 #   define ISHISH "symbian"
2616 #endif
2617
2618
2619 #if defined(__HAIKU__)
2620 #   include "haiku/haikuish.h"
2621 #   define ISHISH "haiku"
2622 #elif defined(__BEOS__)
2623 #   include "beos/beosish.h"
2624 #   define ISHISH "beos"
2625 #endif
2626
2627 #ifndef ISHISH
2628 #   include "unixish.h"
2629 #   define ISHISH "unix"
2630 #endif
2631
2632 /* NSIG logic from Configure --> */
2633 /* Strange style to avoid deeply-nested #if/#else/#endif */
2634 #ifndef NSIG
2635 #  ifdef _NSIG
2636 #    define NSIG (_NSIG)
2637 #  endif
2638 #endif
2639
2640 #ifndef NSIG
2641 #  ifdef SIGMAX
2642 #    define NSIG (SIGMAX+1)
2643 #  endif
2644 #endif
2645
2646 #ifndef NSIG
2647 #  ifdef SIG_MAX
2648 #    define NSIG (SIG_MAX+1)
2649 #  endif
2650 #endif
2651
2652 #ifndef NSIG
2653 #  ifdef _SIG_MAX
2654 #    define NSIG (_SIG_MAX+1)
2655 #  endif
2656 #endif
2657
2658 #ifndef NSIG
2659 #  ifdef MAXSIG
2660 #    define NSIG (MAXSIG+1)
2661 #  endif
2662 #endif
2663
2664 #ifndef NSIG
2665 #  ifdef MAX_SIG
2666 #    define NSIG (MAX_SIG+1)
2667 #  endif
2668 #endif
2669
2670 #ifndef NSIG
2671 #  ifdef SIGARRAYSIZE
2672 #    define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2673 #  endif
2674 #endif
2675
2676 #ifndef NSIG
2677 #  ifdef _sys_nsig
2678 #    define NSIG (_sys_nsig) /* Solaris 2.5 */
2679 #  endif
2680 #endif
2681
2682 /* Default to some arbitrary number that's big enough to get most
2683    of the common signals.
2684 */
2685 #ifndef NSIG
2686 #    define NSIG 50
2687 #endif
2688 /* <-- NSIG logic from Configure */
2689
2690 #ifndef NO_ENVIRON_ARRAY
2691 #  define USE_ENVIRON_ARRAY
2692 #endif
2693
2694 /*
2695  * initialise to avoid floating-point exceptions from overflow, etc
2696  */
2697 #ifndef PERL_FPU_INIT
2698 #  ifdef HAS_FPSETMASK
2699 #    if HAS_FLOATINGPOINT_H
2700 #      include <floatingpoint.h>
2701 #    endif
2702 /* Some operating systems have this as a macro, which in turn expands to a comma
2703    expression, and the last sub-expression is something that gets calculated,
2704    and then they have the gall to warn that a value computed is not used. Hence
2705    cast to void.  */
2706 #    define PERL_FPU_INIT (void)fpsetmask(0)
2707 #  else
2708 #    if defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
2709 #      define PERL_FPU_INIT       PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
2710 #      define PERL_FPU_PRE_EXEC   { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2711 #      define PERL_FPU_POST_EXEC    rsignal_restore(SIGFPE, &xfpe); }
2712 #    else
2713 #      define PERL_FPU_INIT
2714
2715 #    endif
2716 #  endif
2717 #endif
2718 #ifndef PERL_FPU_PRE_EXEC
2719 #  define PERL_FPU_PRE_EXEC   {
2720 #  define PERL_FPU_POST_EXEC  }
2721 #endif
2722
2723 #ifndef PERL_SYS_INIT3_BODY
2724 #  define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
2725 #endif
2726
2727 /*
2728 =for apidoc Am|void|PERL_SYS_INIT|int argc|char** argv
2729 Provides system-specific tune up of the C runtime environment necessary to
2730 run Perl interpreters. This should be called only once, before creating
2731 any Perl interpreters.
2732
2733 =for apidoc Am|void|PERL_SYS_INIT3|int argc|char** argv|char** env
2734 Provides system-specific tune up of the C runtime environment necessary to
2735 run Perl interpreters. This should be called only once, before creating
2736 any Perl interpreters.
2737
2738 =for apidoc Am|void|PERL_SYS_TERM|
2739 Provides system-specific clean up of the C runtime environment after
2740 running Perl interpreters. This should be called only once, after
2741 freeing any remaining Perl interpreters.
2742
2743 =cut
2744  */
2745
2746 #define PERL_SYS_INIT(argc, argv)       Perl_sys_init(argc, argv)
2747 #define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
2748 #define PERL_SYS_TERM()                 Perl_sys_term()
2749
2750 #ifndef PERL_WRITE_MSG_TO_CONSOLE
2751 #  define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2752 #endif
2753
2754 #ifndef MAXPATHLEN
2755 #  ifdef PATH_MAX
2756 #    ifdef _POSIX_PATH_MAX
2757 #       if PATH_MAX > _POSIX_PATH_MAX
2758 /* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2759  * included the null byte or not.  Later amendments of POSIX,
2760  * XPG4, the Austin Group, and the Single UNIX Specification
2761  * all explicitly include the null byte in the PATH_MAX.
2762  * Ditto for _POSIX_PATH_MAX. */
2763 #         define MAXPATHLEN PATH_MAX
2764 #       else
2765 #         define MAXPATHLEN _POSIX_PATH_MAX
2766 #       endif
2767 #    else
2768 #      define MAXPATHLEN (PATH_MAX+1)
2769 #    endif
2770 #  else
2771 #    define MAXPATHLEN 1024     /* Err on the large side. */
2772 #  endif
2773 #endif
2774
2775 /* In case Configure was not used (we are using a "canned config"
2776  * such as Win32, or a cross-compilation setup, for example) try going
2777  * by the gcc major and minor versions.  One useful URL is
2778  * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2779  * but contrary to this information warn_unused_result seems
2780  * not to be in gcc 3.3.5, at least. --jhi
2781  * Also, when building extensions with an installed perl, this allows
2782  * the user to upgrade gcc and get the right attributes, rather than
2783  * relying on the list generated at Configure time.  --AD
2784  * Set these up now otherwise we get confused when some of the <*thread.h>
2785  * includes below indirectly pull in <perlio.h> (which needs to know if we
2786  * have HASATTRIBUTE_FORMAT).
2787  */
2788
2789 #ifndef PERL_MICRO
2790 #if defined __GNUC__ && !defined(__INTEL_COMPILER)
2791 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2792 #    define HASATTRIBUTE_DEPRECATED
2793 #  endif
2794 #  if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2795 #    define HASATTRIBUTE_FORMAT
2796 #    if defined __MINGW32__
2797 #      define PRINTF_FORMAT_NULL_OK
2798 #    endif
2799 #  endif
2800 #  if __GNUC__ >= 3 /* 3.0 -> */
2801 #    define HASATTRIBUTE_MALLOC
2802 #  endif
2803 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2804 #    define HASATTRIBUTE_NONNULL
2805 #  endif
2806 #  if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2807 #    define HASATTRIBUTE_NORETURN
2808 #  endif
2809 #  if __GNUC__ >= 3 /* gcc 3.0 -> */
2810 #    define HASATTRIBUTE_PURE
2811 #  endif
2812 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2813 #    define HASATTRIBUTE_UNUSED
2814 #  endif
2815 #  if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2816 #    define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2817 #  endif
2818 #  if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2819 #    define HASATTRIBUTE_WARN_UNUSED_RESULT
2820 #  endif
2821 #endif
2822 #endif /* #ifndef PERL_MICRO */
2823
2824 /* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
2825  * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
2826  * this results in many functions being undeclared which bothers C++
2827  * May make sense to have threads after "*ish.h" anyway
2828  */
2829
2830 #if defined(USE_ITHREADS)
2831 #  ifdef NETWARE
2832 #   include <nw5thread.h>
2833 #  else
2834 #  ifdef FAKE_THREADS
2835 #    include "fakethr.h"
2836 #  else
2837 #    ifdef WIN32
2838 #      include <win32thread.h>
2839 #    else
2840 #      ifdef OS2
2841 #        include "os2thread.h"
2842 #      else
2843 #        ifdef I_MACH_CTHREADS
2844 #          include <mach/cthreads.h>
2845 #          if (defined(NeXT) || defined(__NeXT__)) && defined(PERL_POLLUTE_MALLOC)
2846 #            define MUTEX_INIT_CALLS_MALLOC
2847 #          endif
2848 typedef cthread_t       perl_os_thread;
2849 typedef mutex_t         perl_mutex;
2850 typedef condition_t     perl_cond;
2851 typedef void *          perl_key;
2852 #        else /* Posix threads */
2853 #          ifdef I_PTHREAD
2854 #            include <pthread.h>
2855 #          endif
2856 typedef pthread_t       perl_os_thread;
2857 typedef pthread_mutex_t perl_mutex;
2858 typedef pthread_cond_t  perl_cond;
2859 typedef pthread_key_t   perl_key;
2860 #        endif /* I_MACH_CTHREADS */
2861 #      endif /* OS2 */
2862 #    endif /* WIN32 */
2863 #  endif /* FAKE_THREADS */
2864 #endif  /* NETWARE */
2865 #endif /* USE_ITHREADS */
2866
2867 #if defined(WIN32)
2868 #  include "win32.h"
2869 #endif
2870
2871 #ifdef NETWARE
2872 #  include "netware.h"
2873 #endif
2874
2875 #define STATUS_UNIX     PL_statusvalue
2876 #ifdef VMS
2877 #   define STATUS_NATIVE        PL_statusvalue_vms
2878 /*
2879  * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
2880  * its contents can not be trusted.  Unfortunately, Perl seems to check
2881  * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
2882  * be updated also.
2883  */
2884 #  include <stsdef.h>
2885 #  include <ssdef.h>
2886 /* Presume this because if VMS changes it, it will require a new
2887  * set of APIs for waiting on children for binary compatibility.
2888  */
2889 #  define child_offset_bits (8)
2890 #  ifndef C_FAC_POSIX
2891 #  define C_FAC_POSIX 0x35A000
2892 #  endif
2893
2894 /*  STATUS_EXIT - validates and returns a NATIVE exit status code for the
2895  * platform from the existing UNIX or Native status values.
2896  */
2897
2898 #   define STATUS_EXIT \
2899         (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
2900            (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
2901
2902
2903 /* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
2904  * exit code and shifts the UNIX value over the correct number of bits to
2905  * be a child status.  Usually the number of bits is 8, but that could be
2906  * platform dependent.  The NATIVE status code is presumed to have either
2907  * from a child process.
2908  */
2909
2910 /* This is complicated.  The child processes return a true native VMS
2911    status which must be saved.  But there is an assumption in Perl that
2912    the UNIX child status has some relationship to errno values, so
2913    Perl tries to translate it to text in some of the tests.
2914    In order to get the string translation correct, for the error, errno
2915    must be EVMSERR, but that generates a different text message
2916    than what the test programs are expecting.  So an errno value must
2917    be derived from the native status value when an error occurs.
2918    That will hide the true native status message.  With this version of
2919    perl, the true native child status can always be retrieved so that
2920    is not a problem.  But in this case, Pl_statusvalue and errno may
2921    have different values in them.
2922  */
2923
2924 #   define STATUS_NATIVE_CHILD_SET(n) \
2925         STMT_START {                                                    \
2926             I32 evalue = (I32)n;                                        \
2927             if (evalue == EVMSERR) {                                    \
2928               PL_statusvalue_vms = vaxc$errno;                          \
2929               PL_statusvalue = evalue;                                  \
2930             } else {                                                    \
2931               PL_statusvalue_vms = evalue;                              \
2932               if (evalue == -1) {                                       \
2933                 PL_statusvalue = -1;                                    \
2934                 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
2935               } else                                                    \
2936                 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1);    \
2937               set_vaxc_errno(evalue);                                   \
2938               if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX)    \
2939                   set_errno(EVMSERR);                                   \
2940               else set_errno(Perl_vms_status_to_unix(evalue, 0));       \
2941               PL_statusvalue = PL_statusvalue << child_offset_bits;     \
2942             }                                                           \
2943         } STMT_END
2944
2945 #   ifdef VMSISH_STATUS
2946 #       define STATUS_CURRENT   (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
2947 #   else
2948 #       define STATUS_CURRENT   STATUS_UNIX
2949 #   endif
2950
2951   /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
2952    * the NATIVE status to an equivalent value.  Can not be used to translate
2953    * exit code values as exit code values are not guaranteed to have any
2954    * relationship at all to errno values.
2955    * This is used when Perl is forcing errno to have a specific value.
2956    */
2957 #   define STATUS_UNIX_SET(n)                           \
2958         STMT_START {                                    \
2959             I32 evalue = (I32)n;                        \
2960             PL_statusvalue = evalue;                    \
2961             if (PL_statusvalue != -1) {                 \
2962                 if (PL_statusvalue != EVMSERR) {        \
2963                   PL_statusvalue &= 0xFFFF;             \
2964                   if (MY_POSIX_EXIT)                    \
2965                     PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
2966                   else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
2967                 }                                       \
2968                 else {                                  \
2969                   PL_statusvalue_vms = vaxc$errno;      \
2970                 }                                       \
2971             }                                           \
2972             else PL_statusvalue_vms = SS$_ABORT;        \
2973             set_vaxc_errno(PL_statusvalue_vms);         \
2974         } STMT_END
2975
2976   /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
2977    * the NATIVE error status based on it.
2978    *
2979    * When in the default mode to comply with the Perl VMS documentation,
2980    * 0 is a success and any other code sets the NATIVE status to a failure
2981    * code of SS$_ABORT.
2982    *
2983    * In the new POSIX EXIT mode, native status will be set so that the
2984    * actual exit code will can be retrieved by the calling program or
2985    * shell.
2986    *
2987    * If the exit code is not clearly a UNIX parent or child exit status,
2988    * it will be passed through as a VMS status.
2989    */
2990
2991 #   define STATUS_UNIX_EXIT_SET(n)                      \
2992         STMT_START {                                    \
2993             I32 evalue = (I32)n;                        \
2994             PL_statusvalue = evalue;                    \
2995             if (MY_POSIX_EXIT) { \
2996               if (evalue <= 0xFF00) {           \
2997                   if (evalue > 0xFF)                    \
2998                     evalue = (evalue >> child_offset_bits) & 0xFF; \
2999                   PL_statusvalue_vms =          \
3000                     (C_FAC_POSIX | (evalue << 3 ) |     \
3001                     ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
3002               } else /* forgive them Perl, for they have sinned */ \
3003                 PL_statusvalue_vms = evalue; \
3004             } else { \
3005               if (evalue == 0)                  \
3006                 PL_statusvalue_vms = SS$_NORMAL;        \
3007               else if (evalue <= 0xFF00) \
3008                 PL_statusvalue_vms = SS$_ABORT; \
3009               else { /* forgive them Perl, for they have sinned */ \
3010                   if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
3011                   else PL_statusvalue_vms = vaxc$errno; \
3012                   /* And obviously used a VMS status value instead of UNIX */ \
3013                   PL_statusvalue = EVMSERR;             \
3014               } \
3015               set_vaxc_errno(PL_statusvalue_vms);       \
3016             }                                           \
3017         } STMT_END
3018
3019
3020   /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
3021    * and sets the NATIVE error status based on it.  This special case
3022    * is needed to maintain compatibility with past VMS behavior.
3023    *
3024    * In the default mode on VMS, this number is passed through as
3025    * both the NATIVE and UNIX status.  Which makes it different
3026    * that the STATUS_UNIX_EXIT_SET.
3027    *
3028    * In the new POSIX EXIT mode, native status will be set so that the
3029    * actual exit code will can be retrieved by the calling program or
3030    * shell.
3031    *
3032    * A POSIX exit code is from 0 to 255.  If the exit code is higher
3033    * than this, it needs to be assumed that it is a VMS exit code and
3034    * passed through.
3035    */
3036
3037 #   define STATUS_EXIT_SET(n)                           \
3038         STMT_START {                                    \
3039             I32 evalue = (I32)n;                        \
3040             PL_statusvalue = evalue;                    \
3041             if (MY_POSIX_EXIT)                          \
3042                 if (evalue > 255) PL_statusvalue_vms = evalue; else {   \
3043                   PL_statusvalue_vms = \
3044                     (C_FAC_POSIX | (evalue << 3 ) |     \
3045                      ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
3046             else                                        \
3047                 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
3048             set_vaxc_errno(PL_statusvalue_vms);         \
3049         } STMT_END
3050
3051
3052  /* This macro forces a success status */
3053 #   define STATUS_ALL_SUCCESS   \
3054         (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
3055
3056  /* This macro forces a failure status */
3057 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, \
3058      vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
3059         (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
3060
3061 #else
3062 #   define STATUS_NATIVE        PL_statusvalue_posix
3063 #   if defined(WCOREDUMP)
3064 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3065             STMT_START {                                   \
3066                 PL_statusvalue_posix = (n);                \
3067                 if (PL_statusvalue_posix == -1)            \
3068                     PL_statusvalue = -1;                   \
3069                 else {                                     \
3070                     PL_statusvalue =                       \
3071                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3072                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
3073                         (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0);  \
3074                 }                                          \
3075             } STMT_END
3076 #   elif defined(WIFEXITED)
3077 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3078             STMT_START {                                   \
3079                 PL_statusvalue_posix = (n);                \
3080                 if (PL_statusvalue_posix == -1)            \
3081                     PL_statusvalue = -1;                   \
3082                 else {                                     \
3083                     PL_statusvalue =                       \
3084                         (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) |  \
3085                         (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0);  \
3086                 }                                          \
3087             } STMT_END
3088 #   else
3089 #       define STATUS_NATIVE_CHILD_SET(n)                  \
3090             STMT_START {                                   \
3091                 PL_statusvalue_posix = (n);                \
3092                 if (PL_statusvalue_posix == -1)            \
3093                     PL_statusvalue = -1;                   \
3094                 else {                                     \
3095                     PL_statusvalue =                       \
3096                         PL_statusvalue_posix & 0xFFFF;     \
3097                 }                                          \
3098             } STMT_END
3099 #   endif
3100 #   define STATUS_UNIX_SET(n)           \
3101         STMT_START {                    \
3102             PL_statusvalue = (n);               \
3103             if (PL_statusvalue != -1)   \
3104                 PL_statusvalue &= 0xFFFF;       \
3105         } STMT_END
3106 #   define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
3107 #   define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
3108 #   define STATUS_CURRENT STATUS_UNIX
3109 #   define STATUS_EXIT STATUS_UNIX
3110 #   define STATUS_ALL_SUCCESS   (PL_statusvalue = 0, PL_statusvalue_posix = 0)
3111 #   define STATUS_ALL_FAILURE   (PL_statusvalue = 1, PL_statusvalue_posix = 1)
3112 #endif
3113
3114 /* flags in PL_exit_flags for nature of exit() */
3115 #define PERL_EXIT_EXPECTED      0x01
3116 #define PERL_EXIT_DESTRUCT_END  0x02  /* Run END in perl_destruct */
3117
3118 #ifndef PERL_CORE
3119 /* format to use for version numbers in file/directory names */
3120 /* XXX move to Configure? */
3121 /* This was only ever used for the current version, and that can be done at
3122    compile time, as PERL_FS_VERSION, so should we just delete it?  */
3123 #  ifndef PERL_FS_VER_FMT
3124 #    define PERL_FS_VER_FMT     "%d.%d.%d"
3125 #  endif
3126 #endif
3127
3128 #ifndef PERL_FS_VERSION
3129 #  define PERL_FS_VERSION       PERL_VERSION_STRING
3130 #endif
3131
3132 /* This defines a way to flush all output buffers.  This may be a
3133  * performance issue, so we allow people to disable it.  Also, if
3134  * we are using stdio, there are broken implementations of fflush(NULL)
3135  * out there, Solaris being the most prominent.
3136  */
3137 #ifndef PERL_FLUSHALL_FOR_CHILD
3138 # if defined(USE_PERLIO) || defined(FFLUSH_NULL) || defined(USE_SFIO)
3139 #  define PERL_FLUSHALL_FOR_CHILD       PerlIO_flush((PerlIO*)NULL)
3140 # else
3141 #  ifdef FFLUSH_ALL
3142 #   define PERL_FLUSHALL_FOR_CHILD      my_fflush_all()
3143 #  else
3144 #   define PERL_FLUSHALL_FOR_CHILD      NOOP
3145 #  endif
3146 # endif
3147 #endif
3148
3149 #ifndef PERL_WAIT_FOR_CHILDREN
3150 #  define PERL_WAIT_FOR_CHILDREN        NOOP
3151 #endif
3152
3153 /* the traditional thread-unsafe notion of "current interpreter". */
3154 #ifndef PERL_SET_INTERP
3155 #  define PERL_SET_INTERP(i)            (PL_curinterp = (PerlInterpreter*)(i))
3156 #endif
3157
3158 #ifndef PERL_GET_INTERP
3159 #  define PERL_GET_INTERP               (PL_curinterp)
3160 #endif
3161
3162 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
3163 #  ifdef MULTIPLICITY
3164 #    define PERL_GET_THX                ((PerlInterpreter *)PERL_GET_CONTEXT)
3165 #  endif
3166 #  define PERL_SET_THX(t)               PERL_SET_CONTEXT(t)
3167 #endif
3168
3169 /*
3170     This replaces the previous %_ "hack" by the "%p" hacks.
3171     All that is required is that the perl source does not
3172     use "%-p" or "%-<number>p" or "%<number>p" formats.
3173     These formats will still work in perl code.
3174     See comments in sv.c for further details.
3175
3176     Robin Barker 2005-07-14
3177
3178     No longer use %1p for VDf = %vd.  RMB 2007-10-19
3179 */
3180
3181 #ifndef SVf_
3182 #  define SVf_(n) "-" STRINGIFY(n) "p"
3183 #endif
3184
3185 #ifndef SVf
3186 #  define SVf "-p"
3187 #endif
3188
3189 #ifndef SVf32
3190 #  define SVf32 SVf_(32)
3191 #endif
3192
3193 #ifndef SVf256
3194 #  define SVf256 SVf_(256)
3195 #endif
3196
3197 #define SVfARG(p) ((void*)(p))
3198
3199 #ifndef HEKf
3200 #  define HEKf "2p"
3201 #endif
3202
3203 /* Not ideal, but we cannot easily include a number in an already-numeric
3204  * format sequence. */
3205 #ifndef HEKf256
3206 #  define HEKf256 "3p"
3207 #endif
3208
3209 #define HEKfARG(p) ((void*)(p))
3210
3211 #ifdef PERL_CORE
3212 /* not used; but needed for backward compatibility with XS code? - RMB */
3213 #  undef VDf
3214 #else
3215 #  ifndef VDf
3216 #    define VDf "vd"
3217 #  endif
3218 #endif
3219
3220 #ifdef PERL_CORE
3221 /* not used; but needed for backward compatibility with XS code? - RMB */
3222 #  undef UVf
3223 #else
3224 #  ifndef UVf
3225 #    define UVf UVuf
3226 #  endif
3227 #endif
3228
3229 #ifdef HASATTRIBUTE_DEPRECATED
3230 #  define __attribute__deprecated__         __attribute__((deprecated))
3231 #endif
3232 #ifdef HASATTRIBUTE_FORMAT
3233 #  define __attribute__format__(x,y,z)      __attribute__((format(x,y,z)))
3234 #endif
3235 #ifdef HASATTRIBUTE_MALLOC
3236 #  define __attribute__malloc__             __attribute__((__malloc__))
3237 #endif
3238 #ifdef HASATTRIBUTE_NONNULL
3239 #  define __attribute__nonnull__(a)         __attribute__((nonnull(a)))
3240 #endif
3241 #ifdef HASATTRIBUTE_NORETURN
3242 #  define __attribute__noreturn__           __attribute__((noreturn))
3243 #endif
3244 #ifdef HASATTRIBUTE_PURE
3245 #  define __attribute__pure__               __attribute__((pure))
3246 #endif
3247 #ifdef HASATTRIBUTE_UNUSED
3248 #  define __attribute__unused__             __attribute__((unused))
3249 #endif
3250 #ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
3251 #  define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
3252 #endif
3253
3254 /* If we haven't defined the attributes yet, define them to blank. */
3255 #ifndef __attribute__deprecated__
3256 #  define __attribute__deprecated__
3257 #endif
3258 #ifndef __attribute__format__
3259 #  define __attribute__format__(x,y,z)
3260 #endif
3261 #ifndef __attribute__malloc__
3262 #  define __attribute__malloc__
3263 #endif
3264 #ifndef __attribute__nonnull__
3265 #  define __attribute__nonnull__(a)
3266 #endif
3267 #ifndef __attribute__noreturn__
3268 #  define __attribute__noreturn__
3269 #endif
3270 #ifndef __attribute__pure__
3271 #  define __attribute__pure__
3272 #endif
3273 #ifndef __attribute__unused__
3274 #  define __attribute__unused__
3275 #endif
3276 #ifndef __attribute__warn_unused_result__
3277 #  define __attribute__warn_unused_result__
3278 #endif
3279
3280 /* For functions that are marked as __attribute__noreturn__, it's not
3281    appropriate to call return.  In either case, include the lint directive.
3282  */
3283 #ifdef HASATTRIBUTE_NORETURN
3284 #  define NORETURN_FUNCTION_END /* NOTREACHED */
3285 #else
3286 #  define NORETURN_FUNCTION_END /* NOTREACHED */ return 0
3287 #endif
3288
3289 /* Some OS warn on NULL format to printf */
3290 #ifdef PRINTF_FORMAT_NULL_OK
3291 #  define __attribute__format__null_ok__(x,y,z)  __attribute__format__(x,y,z)
3292 #else
3293 #  define __attribute__format__null_ok__(x,y,z)
3294 #endif
3295
3296 #ifdef HAS_BUILTIN_EXPECT
3297 #  define EXPECT(expr,val)                  __builtin_expect(expr,val)
3298 #else
3299 #  define EXPECT(expr,val)                  (expr)
3300 #endif
3301 #define LIKELY(cond)                        EXPECT(cond,1)
3302 #define UNLIKELY(cond)                      EXPECT(cond,0)
3303 #ifdef HAS_BUILTIN_CHOOSE_EXPR
3304 /* placeholder */
3305 #endif
3306
3307 /* Some unistd.h's give a prototype for pause() even though
3308    HAS_PAUSE ends up undefined.  This causes the #define
3309    below to be rejected by the compiler.  Sigh.
3310 */
3311 #ifdef HAS_PAUSE
3312 #define Pause   pause
3313 #else
3314 #define Pause() sleep((32767<<16)+32767)
3315 #endif
3316
3317 #ifndef IOCPARM_LEN
3318 #   ifdef IOCPARM_MASK
3319         /* on BSDish systems we're safe */
3320 #       define IOCPARM_LEN(x)  (((x) >> 16) & IOCPARM_MASK)
3321 #   else
3322 #       if defined(_IOC_SIZE) && defined(__GLIBC__)
3323         /* on Linux systems we're safe; except when we're not [perl #38223] */
3324 #           define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
3325 #       else
3326         /* otherwise guess at what's safe */
3327 #           define IOCPARM_LEN(x)       256
3328 #       endif
3329 #   endif
3330 #endif
3331
3332 #if defined(__CYGWIN__)
3333 /* USEMYBINMODE
3334  *   This symbol, if defined, indicates that the program should
3335  *   use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
3336  *   that a file is in "binary" mode -- that is, that no translation
3337  *   of bytes occurs on read or write operations.
3338  */
3339 #  define USEMYBINMODE /**/
3340 #  include <io.h> /* for setmode() prototype */
3341 #  define my_binmode(fp, iotype, mode) \
3342             (PerlLIO_setmode(fileno(fp), mode) != -1 ? TRUE : FALSE)
3343 #endif
3344
3345 #ifdef __CYGWIN__
3346 void init_os_extras(void);
3347 #endif
3348
3349 #ifdef UNION_ANY_DEFINITION
3350 UNION_ANY_DEFINITION;
3351 #else
3352 union any {
3353     void*       any_ptr;
3354     I32         any_i32;
3355     IV          any_iv;
3356     UV          any_uv;
3357     long        any_long;
3358     bool        any_bool;
3359     void        (*any_dptr) (void*);
3360     void        (*any_dxptr) (pTHX_ void*);
3361 };
3362 #endif
3363
3364 typedef I32 (*filter_t) (pTHX_ int, SV *, int);
3365
3366 #define FILTER_READ(idx, sv, len)  filter_read(idx, sv, len)
3367 #define FILTER_DATA(idx) \
3368             (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3369 #define FILTER_ISREADER(idx) \
3370             (PL_parser && PL_parser->rsfp_filters \
3371                 && idx >= AvFILLp(PL_parser->rsfp_filters))
3372 #define PERL_FILTER_EXISTS(i) \
3373             (PL_parser && PL_parser->rsfp_filters \
3374                 && (i) <= av_len(PL_parser->rsfp_filters))
3375
3376 #if defined(_AIX) && !defined(_AIX43)
3377 #if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3378 /* We cannot include <crypt.h> to get the struct crypt_data
3379  * because of setkey prototype problems when threading */
3380 typedef        struct crypt_data {     /* straight from /usr/include/crypt.h */
3381     /* From OSF, Not needed in AIX
3382        char C[28], D[28];
3383     */
3384     char E[48];
3385     char KS[16][48];
3386     char block[66];
3387     char iobuf[16];
3388 } CRYPTD;
3389 #endif /* threading */
3390 #endif /* AIX */
3391
3392 #if !defined(OS2)
3393 #  include "iperlsys.h"
3394 #endif
3395
3396 #ifdef __LIBCATAMOUNT__
3397 #undef HAS_PASSWD  /* unixish.h but not unixish enough. */
3398 #undef HAS_GROUP
3399 #define FAKE_BIT_BUCKET
3400 #endif
3401
3402 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3403  * Note that the USE_HASH_SEED and USE_HASH_SEED_EXPLICIT are *NOT*
3404  * defined by Configure, despite their names being similar to the
3405  * other defines like USE_ITHREADS.  Configure in fact knows nothing
3406  * about the randomised hashes.  Therefore to enable/disable the hash
3407  * randomisation defines use the Configure -Accflags=... instead. */
3408 #if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED) && !defined(USE_HASH_SEED_EXPLICIT)
3409 #  define USE_HASH_SEED
3410 #endif
3411
3412 /* Win32 defines a type 'WORD' in windef.h. This conflicts with the enumerator
3413  * 'WORD' defined in perly.h. The yytokentype enum is only a debugging aid, so
3414  * it's not really needed.
3415  */
3416 #if defined(WIN32)
3417 #  define YYTOKENTYPE
3418 #endif
3419 #include "perly.h"
3420
3421 #ifdef PERL_MAD
3422 struct nexttoken {
3423     YYSTYPE next_val;   /* value of next token, if any */
3424     I32 next_type;      /* type of next token */
3425     MADPROP *next_mad;  /* everything else about that token */
3426 };
3427 #endif
3428
3429 /* macros to define bit-fields in structs. */
3430 #ifndef PERL_BITFIELD8
3431 #  define PERL_BITFIELD8 unsigned
3432 #endif
3433 #ifndef PERL_BITFIELD16
3434 #  define PERL_BITFIELD16 unsigned
3435 #endif
3436 #ifndef PERL_BITFIELD32
3437 #  define PERL_BITFIELD32 unsigned
3438 #endif
3439
3440 #include "sv.h"
3441 #include "regexp.h"
3442 #include "util.h"
3443 #include "form.h"
3444 #include "gv.h"
3445 #include "pad.h"
3446 #include "cv.h"
3447 #include "opnames.h"
3448 #include "op.h"
3449 #include "hv.h"
3450 #include "cop.h"
3451 #include "av.h"
3452 #include "mg.h"
3453 #include "scope.h"
3454 #include "warnings.h"
3455 #include "utf8.h"
3456
3457 /* these would be in doio.h if there was such a file */
3458 #define my_stat()  my_stat_flags(SV_GMAGIC)
3459 #define my_lstat() my_lstat_flags(SV_GMAGIC)
3460
3461 /* defined in sv.c, but also used in [ach]v.c */
3462 #undef _XPV_HEAD
3463 #undef _XPVMG_HEAD
3464 #undef _XPVCV_COMMON
3465
3466 typedef struct _sublex_info SUBLEXINFO;
3467 struct _sublex_info {
3468     U8 super_state;     /* lexer state to save */
3469     U16 sub_inwhat;     /* "lex_inwhat" to use */
3470     OP *sub_op;         /* "lex_op" to use */
3471     char *super_bufptr; /* PL_parser->bufptr that was */
3472     char *super_bufend; /* PL_parser->bufend that was */
3473 };
3474
3475 #include "parser.h"
3476
3477 typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
3478
3479 struct scan_data_t;             /* Used in S_* functions in regcomp.c */
3480 struct regnode_charclass_class; /* Used in S_* functions in regcomp.c */
3481
3482 struct ptr_tbl_ent {
3483     struct ptr_tbl_ent*         next;
3484     const void*                 oldval;
3485     void*                       newval;
3486 };
3487
3488 struct ptr_tbl {
3489     struct ptr_tbl_ent**        tbl_ary;
3490     UV                          tbl_max;
3491     UV                          tbl_items;
3492     struct ptr_tbl_arena        *tbl_arena;
3493     struct ptr_tbl_ent          *tbl_arena_next;
3494     struct ptr_tbl_ent          *tbl_arena_end;
3495 };
3496
3497 #if defined(iAPX286) || defined(M_I286) || defined(I80286)
3498 #   define I286
3499 #endif
3500
3501 #if defined(htonl) && !defined(HAS_HTONL)
3502 #define HAS_HTONL
3503 #endif
3504 #if defined(htons) && !defined(HAS_HTONS)
3505 #define HAS_HTONS
3506 #endif
3507 #if defined(ntohl) && !defined(HAS_NTOHL)
3508 #define HAS_NTOHL
3509 #endif
3510 #if defined(ntohs) && !defined(HAS_NTOHS)
3511 #define HAS_NTOHS
3512 #endif
3513 #ifndef HAS_HTONL
3514 #if (BYTEORDER & 0xffff) != 0x4321
3515 #define HAS_HTONS
3516 #define HAS_HTONL
3517 #define HAS_NTOHS
3518 #define HAS_NTOHL
3519 #define MYSWAP
3520 #define htons my_swap
3521 #define htonl my_htonl
3522 #define ntohs my_swap
3523 #define ntohl my_ntohl
3524 #endif
3525 #else
3526 #if (BYTEORDER & 0xffff) == 0x4321
3527 #undef HAS_HTONS
3528 #undef HAS_HTONL
3529 #undef HAS_NTOHS
3530 #undef HAS_NTOHL
3531 #endif
3532 #endif
3533
3534 /*
3535  * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3536  * -DWS
3537  */
3538 #if BYTEORDER != 0x1234
3539 # define HAS_VTOHL
3540 # define HAS_VTOHS
3541 # define HAS_HTOVL
3542 # define HAS_HTOVS
3543 # if BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
3544 #  define vtohl(x)      ((((x)&0xFF)<<24)       \
3545                         +(((x)>>24)&0xFF)       \
3546                         +(((x)&0x0000FF00)<<8)  \
3547                         +(((x)&0x00FF0000)>>8)  )
3548 #  define vtohs(x)      ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3549 #  define htovl(x)      vtohl(x)
3550 #  define htovs(x)      vtohs(x)
3551 # endif
3552         /* otherwise default to functions in util.c */
3553 #ifndef htovs
3554 short htovs(short n);
3555 short vtohs(short n);
3556 long htovl(long n);
3557 long vtohl(long n);
3558 #endif
3559 #endif
3560
3561 /* *MAX Plus 1. A floating point value.
3562    Hopefully expressed in a way that dodgy floating point can't mess up.
3563    >> 2 rather than 1, so that value is safely less than I32_MAX after 1
3564    is added to it
3565    May find that some broken compiler will want the value cast to I32.
3566    [after the shift, as signed >> may not be as secure as unsigned >>]
3567 */
3568 #define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
3569 #define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
3570 /* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
3571    0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
3572    may be greater than sizeof(IV), so don't assume that half max UV is max IV.
3573 */
3574 #define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
3575
3576 #define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
3577 #define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
3578 #define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
3579
3580 /* This may look like unnecessary jumping through hoops, but converting
3581    out of range floating point values to integers *is* undefined behaviour,
3582    and it is starting to bite.
3583 */
3584 #ifndef CAST_INLINE
3585 #define I_32(what) (cast_i32((NV)(what)))
3586 #define U_32(what) (cast_ulong((NV)(what)))
3587 #define I_V(what) (cast_iv((NV)(what)))
3588 #define U_V(what) (cast_uv((NV)(what)))
3589 #else
3590 #define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
3591                   : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
3592                      : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
3593 #define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
3594                   : ((n) < U32_MAX_P1 ? (U32) (n) \
3595                      : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
3596 #define I_V(n) ((n) < IV_MAX_P1 ? ((n) < IV_MIN ? IV_MIN : (IV) (n)) \
3597                   : ((n) < UV_MAX_P1 ? (IV)(UV) (n) \
3598                      : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
3599 #define U_V(n) ((n) < 0.0 ? ((n) < IV_MIN ? (UV) IV_MIN : (UV)(IV) (n)) \
3600                   : ((n) < UV_MAX_P1 ? (UV) (n) \
3601                      : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
3602 #endif
3603
3604 #define U_S(what) ((U16)U_32(what))
3605 #define U_I(what) ((unsigned int)U_32(what))
3606 #define U_L(what) U_32(what)
3607
3608 #ifdef HAS_SIGNBIT
3609 #  define Perl_signbit signbit
3610 #endif
3611
3612 /* These do not care about the fractional part, only about the range. */
3613 #define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
3614 #define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
3615
3616 /* Used with UV/IV arguments: */
3617                                         /* XXXX: need to speed it up */
3618 #define CLUMP_2UV(iv)   ((iv) < 0 ? 0 : (UV)(iv))
3619 #define CLUMP_2IV(uv)   ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
3620
3621 #ifndef MAXSYSFD
3622 #   define MAXSYSFD 2
3623 #endif
3624
3625 #ifndef __cplusplus
3626 #if !(defined(UNDER_CE) || defined(SYMBIAN))
3627 Uid_t getuid (void);
3628 Uid_t geteuid (void);
3629 Gid_t getgid (void);
3630 Gid_t getegid (void);
3631 #endif
3632 #endif
3633
3634 #ifndef Perl_debug_log
3635 #  define Perl_debug_log        PerlIO_stderr()
3636 #endif
3637
3638 #ifndef Perl_error_log
3639 #  define Perl_error_log        (PL_stderrgv                    \
3640                                  && isGV(PL_stderrgv)           \
3641                                  && GvIOp(PL_stderrgv)          \
3642                                  && IoOFP(GvIOp(PL_stderrgv))   \
3643                                  ? IoOFP(GvIOp(PL_stderrgv))    \
3644                                  : PerlIO_stderr())
3645 #endif
3646
3647
3648 #define DEBUG_p_FLAG            0x00000001 /*      1 */
3649 #define DEBUG_s_FLAG            0x00000002 /*      2 */
3650 #define DEBUG_l_FLAG            0x00000004 /*      4 */
3651 #define DEBUG_t_FLAG            0x00000008 /*      8 */
3652 #define DEBUG_o_FLAG            0x00000010 /*     16 */
3653 #define DEBUG_c_FLAG            0x00000020 /*     32 */
3654 #define DEBUG_P_FLAG            0x00000040 /*     64 */
3655 #define DEBUG_m_FLAG            0x00000080 /*    128 */
3656 #define DEBUG_f_FLAG            0x00000100 /*    256 */
3657 #define DEBUG_r_FLAG            0x00000200 /*    512 */
3658 #define DEBUG_x_FLAG            0x00000400 /*   1024 */
3659 #define DEBUG_u_FLAG            0x00000800 /*   2048 */
3660 /* U is reserved for Unofficial, exploratory hacking */
3661 #define DEBUG_U_FLAG            0x00001000 /*   4096 */
3662 #define DEBUG_H_FLAG            0x00002000 /*   8192 */
3663 #define DEBUG_X_FLAG            0x00004000 /*  16384 */
3664 #define DEBUG_D_FLAG            0x00008000 /*  32768 */
3665 /* 0x00010000 is unused, used to be S */
3666 #define DEBUG_T_FLAG            0x00020000 /* 131072 */
3667 #define DEBUG_R_FLAG            0x00040000 /* 262144 */
3668 #define DEBUG_J_FLAG            0x00080000 /* 524288 */
3669 #define DEBUG_v_FLAG            0x00100000 /*1048576 */
3670 #define DEBUG_C_FLAG            0x00200000 /*2097152 */
3671 #define DEBUG_A_FLAG            0x00400000 /*4194304 */
3672 #define DEBUG_q_FLAG            0x00800000 /*8388608 */
3673 #define DEBUG_M_FLAG            0x01000000 /*16777216*/
3674 #define DEBUG_B_FLAG            0x02000000 /*33554432*/
3675 #define DEBUG_MASK              0x03FEEFFF /* mask of all the standard flags */
3676
3677 #define DEBUG_DB_RECURSE_FLAG   0x40000000
3678 #define DEBUG_TOP_FLAG          0x80000000 /* XXX what's this for ??? Signal
3679                                               that something was done? */
3680
3681 #  define DEBUG_p_TEST_ (PL_debug & DEBUG_p_FLAG)
3682 #  define DEBUG_s_TEST_ (PL_debug & DEBUG_s_FLAG)
3683 #  define DEBUG_l_TEST_ (PL_debug & DEBUG_l_FLAG)
3684 #  define DEBUG_t_TEST_ (PL_debug & DEBUG_t_FLAG)
3685 #  define DEBUG_o_TEST_ (PL_debug & DEBUG_o_FLAG)
3686 #  define DEBUG_c_TEST_ (PL_debug & DEBUG_c_FLAG)
3687 #  define DEBUG_P_TEST_ (PL_debug & DEBUG_P_FLAG)
3688 #  define DEBUG_m_TEST_ (PL_debug & DEBUG_m_FLAG)
3689 #  define DEBUG_f_TEST_ (PL_debug & DEBUG_f_FLAG)
3690 #  define DEBUG_r_TEST_ (PL_debug & DEBUG_r_FLAG)
3691 #  define DEBUG_x_TEST_ (PL_debug & DEBUG_x_FLAG)
3692 #  define DEBUG_u_TEST_ (PL_debug & DEBUG_u_FLAG)
3693 #  define DEBUG_U_TEST_ (PL_debug & DEBUG_U_FLAG)
3694 #  define DEBUG_H_TEST_ (PL_debug & DEBUG_H_FLAG)
3695 #  define DEBUG_X_TEST_ (PL_debug & DEBUG_X_FLAG)
3696 #  define DEBUG_D_TEST_ (PL_debug & DEBUG_D_FLAG)
3697 #  define DEBUG_T_TEST_ (PL_debug & DEBUG_T_FLAG)
3698 #  define DEBUG_R_TEST_ (PL_debug & DEBUG_R_FLAG)
3699 #  define DEBUG_J_TEST_ (PL_debug & DEBUG_J_FLAG)
3700 #  define DEBUG_v_TEST_ (PL_debug & DEBUG_v_FLAG)
3701 #  define DEBUG_C_TEST_ (PL_debug & DEBUG_C_FLAG)
3702 #  define DEBUG_A_TEST_ (PL_debug & DEBUG_A_FLAG)
3703 #  define DEBUG_q_TEST_ (PL_debug & DEBUG_q_FLAG)
3704 #  define DEBUG_M_TEST_ (PL_debug & DEBUG_M_FLAG)
3705 #  define DEBUG_B_TEST_ (PL_debug & DEBUG_B_FLAG)
3706 #  define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
3707 #  define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
3708 #  define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
3709
3710 #ifdef DEBUGGING
3711
3712 #  define DEBUG_p_TEST DEBUG_p_TEST_
3713 #  define DEBUG_s_TEST DEBUG_s_TEST_
3714 #  define DEBUG_l_TEST DEBUG_l_TEST_
3715 #  define DEBUG_t_TEST DEBUG_t_TEST_
3716 #  define DEBUG_o_TEST DEBUG_o_TEST_
3717 #  define DEBUG_c_TEST DEBUG_c_TEST_
3718 #  define DEBUG_P_TEST DEBUG_P_TEST_
3719 #  define DEBUG_m_TEST DEBUG_m_TEST_
3720 #  define DEBUG_f_TEST DEBUG_f_TEST_
3721 #  define DEBUG_r_TEST DEBUG_r_TEST_
3722 #  define DEBUG_x_TEST DEBUG_x_TEST_
3723 #  define DEBUG_u_TEST DEBUG_u_TEST_
3724 #  define DEBUG_U_TEST DEBUG_U_TEST_
3725 #  define DEBUG_H_TEST DEBUG_H_TEST_
3726 #  define DEBUG_X_TEST DEBUG_X_TEST_
3727 #  define DEBUG_D_TEST DEBUG_D_TEST_
3728 #  define DEBUG_T_TEST DEBUG_T_TEST_
3729 #  define DEBUG_R_TEST DEBUG_R_TEST_
3730 #  define DEBUG_J_TEST DEBUG_J_TEST_
3731 #  define DEBUG_v_TEST DEBUG_v_TEST_
3732 #  define DEBUG_C_TEST DEBUG_C_TEST_
3733 #  define DEBUG_A_TEST DEBUG_A_TEST_
3734 #  define DEBUG_q_TEST DEBUG_q_TEST_
3735 #  define DEBUG_M_TEST DEBUG_M_TEST_
3736 #  define DEBUG_B_TEST DEBUG_B_TEST_
3737 #  define DEBUG_Xv_TEST DEBUG_Xv_TEST_
3738 #  define DEBUG_Uv_TEST DEBUG_Uv_TEST_
3739 #  define DEBUG_Pv_TEST DEBUG_Pv_TEST_
3740
3741 #  define PERL_DEB(a)                  a
3742 #  define PERL_DEBUG(a) if (PL_debug)  a
3743 #  define DEBUG_p(a) if (DEBUG_p_TEST) a
3744 #  define DEBUG_s(a) if (DEBUG_s_TEST) a
3745 #  define DEBUG_l(a) if (DEBUG_l_TEST) a
3746 #  define DEBUG_t(a) if (DEBUG_t_TEST) a
3747 #  define DEBUG_o(a) if (DEBUG_o_TEST) a
3748 #  define DEBUG_c(a) if (DEBUG_c_TEST) a
3749 #  define DEBUG_P(a) if (DEBUG_P_TEST) a
3750
3751      /* Temporarily turn off memory debugging in case the a
3752       * does memory allocation, either directly or indirectly. */
3753 #  define DEBUG_m(a)  \
3754     STMT_START {                                                        \
3755         if (PERL_GET_INTERP) { dTHX; if (DEBUG_m_TEST) {PL_debug&=~DEBUG_m_FLAG; a; PL_debug|=DEBUG_m_FLAG;} } \
3756     } STMT_END
3757
3758 #  define DEBUG__(t, a) \
3759         STMT_START { \
3760                 if (t) STMT_START {a;} STMT_END; \
3761         } STMT_END
3762
3763 #  define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
3764 #ifndef PERL_EXT_RE_BUILD
3765 #  define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
3766 #else
3767 #  define DEBUG_r(a) STMT_START {a;} STMT_END
3768 #endif /* PERL_EXT_RE_BUILD */
3769 #  define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
3770 #  define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
3771 #  define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
3772 #  define DEBUG_H(a) DEBUG__(DEBUG_H_TEST, a)
3773 #  define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
3774 #  define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
3775 #  define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
3776 #  define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
3777 #  define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
3778
3779 #  define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
3780 #  define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
3781 #  define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
3782 #  define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
3783 #  define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
3784 #  define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
3785 #  define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
3786 #  define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
3787
3788 #else /* DEBUGGING */
3789
3790 #  define DEBUG_p_TEST (0)
3791 #  define DEBUG_s_TEST (0)
3792 #  define DEBUG_l_TEST (0)
3793 #  define DEBUG_t_TEST (0)
3794 #  define DEBUG_o_TEST (0)
3795 #  define DEBUG_c_TEST (0)
3796 #  define DEBUG_P_TEST (0)
3797 #  define DEBUG_m_TEST (0)
3798 #  define DEBUG_f_TEST (0)
3799 #  define DEBUG_r_TEST (0)
3800 #  define DEBUG_x_TEST (0)
3801 #  define DEBUG_u_TEST (0)
3802 #  define DEBUG_U_TEST (0)
3803 #  define DEBUG_H_TEST (0)
3804 #  define DEBUG_X_TEST (0)
3805 #  define DEBUG_D_TEST (0)
3806 #  define DEBUG_T_TEST (0)
3807 #  define DEBUG_R_TEST (0)
3808 #  define DEBUG_J_TEST (0)
3809 #  define DEBUG_v_TEST (0)
3810 #  define DEBUG_C_TEST (0)
3811 #  define DEBUG_A_TEST (0)
3812 #  define DEBUG_q_TEST (0)
3813 #  define DEBUG_M_TEST (0)
3814 #  define DEBUG_B_TEST (0)
3815 #  define DEBUG_Xv_TEST (0)
3816 #  define DEBUG_Uv_TEST (0)
3817 #  define DEBUG_Pv_TEST (0)
3818
3819 #  define PERL_DEB(a)
3820 #  define PERL_DEBUG(a)
3821 #  define DEBUG_p(a)
3822 #  define DEBUG_s(a)
3823 #  define DEBUG_l(a)
3824 #  define DEBUG_t(a)
3825 #  define DEBUG_o(a)
3826 #  define DEBUG_c(a)
3827 #  define DEBUG_P(a)
3828 #  define DEBUG_m(a)
3829 #  define DEBUG_f(a)
3830 #  define DEBUG_r(a)
3831 #  define DEBUG_x(a)
3832 #  define DEBUG_u(a)
3833 #  define DEBUG_U(a)
3834 #  define DEBUG_H(a)
3835 #  define DEBUG_X(a)
3836 #  define DEBUG_D(a)
3837 #  define DEBUG_T(a)
3838 #  define DEBUG_R(a)
3839 #  define DEBUG_v(a)
3840 #  define DEBUG_C(a)
3841 #  define DEBUG_A(a)
3842 #  define DEBUG_q(a)
3843 #  define DEBUG_M(a)
3844 #  define DEBUG_B(a)
3845 #  define DEBUG_Xv(a)
3846 #  define DEBUG_Uv(a)
3847 #  define DEBUG_Pv(a)
3848 #endif /* DEBUGGING */
3849
3850
3851 #define DEBUG_SCOPE(where) \
3852     DEBUG_l( \
3853     Perl_deb(aTHX_ "%s scope %ld (savestack=%ld) at %s:%d\n",   \
3854                     where, (long)PL_scopestack_ix, (long)PL_savestack_ix, \
3855                     __FILE__, __LINE__));
3856
3857 #if defined(DEBUGGING) && defined(I_ASSERT)
3858 #  include <assert.h>
3859 #endif
3860
3861 /* Keep the old croak based assert for those who want it, and as a fallback if
3862    the platform is so heretically non-ANSI that it can't assert.  */
3863
3864 #define Perl_assert(what)       PERL_DEB(                               \
3865         ((what) ? ((void) 0) :                                          \
3866             (Perl_croak_nocontext("Assertion %s failed: file \"" __FILE__ \
3867                         "\", line %d", STRINGIFY(what), __LINE__),      \
3868             (void) 0)))
3869
3870 #ifndef assert
3871 #  define assert(what)  Perl_assert(what)
3872 #endif
3873
3874 struct ufuncs {
3875     I32 (*uf_val)(pTHX_ IV, SV*);
3876     I32 (*uf_set)(pTHX_ IV, SV*);
3877     IV uf_index;
3878 };
3879
3880 /* In pre-5.7-Perls the PERL_MAGIC_uvar magic didn't get the thread context.
3881  * XS code wanting to be backward compatible can do something
3882  * like the following:
3883
3884 #ifndef PERL_MG_UFUNC
3885 #define PERL_MG_UFUNC(name,ix,sv) I32 name(IV ix, SV *sv)
3886 #endif
3887
3888 static PERL_MG_UFUNC(foo_get, index, val)
3889 {
3890     sv_setsv(val, ...);
3891     return TRUE;
3892 }
3893
3894 -- Doug MacEachern
3895
3896 */
3897
3898 #ifndef PERL_MG_UFUNC
3899 #define PERL_MG_UFUNC(name,ix,sv) I32 name(pTHX_ IV ix, SV *sv)
3900 #endif
3901
3902 /* Fix these up for __STDC__ */
3903 #ifndef DONT_DECLARE_STD
3904 char *mktemp (char*);
3905 #ifndef atof
3906 double atof (const char*);
3907 #endif
3908 #endif
3909
3910 #ifndef STANDARD_C
3911 /* All of these are in stdlib.h or time.h for ANSI C */
3912 Time_t time();
3913 struct tm *gmtime(), *localtime();
3914 #if defined(OEMVS) || defined(__OPEN_VM)
3915 char *(strchr)(), *(strrchr)();
3916 char *(strcpy)(), *(strcat)();
3917 #else
3918 char *strchr(), *strrchr();
3919 char *strcpy(), *strcat();
3920 #endif
3921 #endif /* ! STANDARD_C */
3922
3923
3924 #ifdef I_MATH
3925 #    include <math.h>
3926 #else
3927 START_EXTERN_C
3928             double exp (double);
3929             double log (double);
3930             double log10 (double);
3931             double sqrt (double);
3932             double frexp (double,int*);
3933             double ldexp (double,int);
3934             double modf (double,double*);
3935             double sin (double);
3936             double cos (double);
3937             double atan2 (double,double);
3938             double pow (double,double);
3939 END_EXTERN_C
3940 #endif
3941
3942 #if !defined(NV_INF) && defined(USE_LONG_DOUBLE) && defined(LDBL_INFINITY)
3943 #  define NV_INF LDBL_INFINITY
3944 #endif
3945 #if !defined(NV_INF) && defined(DBL_INFINITY)
3946 #  define NV_INF (NV)DBL_INFINITY
3947 #endif
3948 #if !defined(NV_INF) && defined(INFINITY)
3949 #  define NV_INF (NV)INFINITY
3950 #endif
3951 #if !defined(NV_INF) && defined(INF)
3952 #  define NV_INF (NV)INF
3953 #endif
3954 #if !defined(NV_INF) && defined(USE_LONG_DOUBLE) && defined(HUGE_VALL)
3955 #  define NV_INF (NV)HUGE_VALL
3956 #endif
3957 #if !defined(NV_INF) && defined(HUGE_VAL)
3958 #  define NV_INF (NV)HUGE_VAL
3959 #endif
3960
3961 #if !defined(NV_NAN) && defined(USE_LONG_DOUBLE)
3962 #   if !defined(NV_NAN) && defined(LDBL_NAN)
3963 #       define NV_NAN LDBL_NAN
3964 #   endif
3965 #   if !defined(NV_NAN) && defined(LDBL_QNAN)
3966 #       define NV_NAN LDBL_QNAN
3967 #   endif
3968 #   if !defined(NV_NAN) && defined(LDBL_SNAN)
3969 #       define NV_NAN LDBL_SNAN
3970 #   endif
3971 #endif
3972 #if !defined(NV_NAN) && defined(DBL_NAN)
3973 #  define NV_NAN (NV)DBL_NAN
3974 #endif
3975 #if !defined(NV_NAN) && defined(DBL_QNAN)
3976 #  define NV_NAN (NV)DBL_QNAN
3977 #endif
3978 #if !defined(NV_NAN) && defined(DBL_SNAN)
3979 #  define NV_NAN (NV)DBL_SNAN
3980 #endif
3981 #if !defined(NV_NAN) && defined(QNAN)
3982 #  define NV_NAN (NV)QNAN
3983 #endif
3984 #if !defined(NV_NAN) && defined(SNAN)
3985 #  define NV_NAN (NV)SNAN
3986 #endif
3987 #if !defined(NV_NAN) && defined(NAN)
3988 #  define NV_NAN (NV)NAN
3989 #endif
3990
3991 #ifndef __cplusplus
3992 #  if defined(NeXT) || defined(__NeXT__) /* or whatever catches all NeXTs */
3993 char *crypt ();       /* Maybe more hosts will need the unprototyped version */
3994 #  else
3995 #    if !defined(WIN32) && !defined(VMS)
3996 #ifndef crypt
3997 char *crypt (const char*, const char*);
3998 #endif
3999 #    endif /* !WIN32 */
4000 #  endif /* !NeXT && !__NeXT__ */
4001 #  ifndef DONT_DECLARE_STD
4002 #    ifndef getenv
4003 char *getenv (const char*);
4004 #    endif /* !getenv */
4005 #    if !defined(HAS_LSEEK_PROTO) && !defined(EPOC) && !defined(__hpux)
4006 #      ifdef _FILE_OFFSET_BITS
4007 #        if _FILE_OFFSET_BITS == 64
4008 Off_t lseek (int,Off_t,int);
4009 #        endif
4010 #      endif
4011 #    endif
4012 #  endif /* !DONT_DECLARE_STD */
4013 #ifndef getlogin
4014 char *getlogin (void);
4015 #endif
4016 #endif /* !__cplusplus */
4017
4018 /* Fixme on VMS.  This needs to be a run-time, not build time options */
4019 /* Also rename() is affected by this */
4020 #ifdef UNLINK_ALL_VERSIONS /* Currently only makes sense for VMS */
4021 #define UNLINK unlnk
4022 I32 unlnk (pTHX_ const char*);
4023 #else
4024 #define UNLINK PerlLIO_unlink
4025 #endif
4026
4027 /* some versions of glibc are missing the setresuid() proto */
4028 #if defined(HAS_SETRESUID) && !defined(HAS_SETRESUID_PROTO)
4029 int setresuid(uid_t ruid, uid_t euid, uid_t suid);
4030 #endif
4031 /* some versions of glibc are missing the setresgid() proto */
4032 #if defined(HAS_SETRESGID) && !defined(HAS_SETRESGID_PROTO)
4033 int setresgid(gid_t rgid, gid_t egid, gid_t sgid);
4034 #endif
4035
4036 #ifndef HAS_SETREUID
4037 #  ifdef HAS_SETRESUID
4038 #    define setreuid(r,e) setresuid(r,e,(Uid_t)-1)
4039 #    define HAS_SETREUID
4040 #  endif
4041 #endif
4042 #ifndef HAS_SETREGID
4043 #  ifdef HAS_SETRESGID
4044 #    define setregid(r,e) setresgid(r,e,(Gid_t)-1)
4045 #    define HAS_SETREGID
4046 #  endif
4047 #endif
4048
4049 /* Sighandler_t defined in iperlsys.h */
4050
4051 #ifdef HAS_SIGACTION
4052 typedef struct sigaction Sigsave_t;
4053 #else
4054 typedef Sighandler_t Sigsave_t;
4055 #endif
4056
4057 #define SCAN_DEF 0
4058 #define SCAN_TR 1
4059 #define SCAN_REPL 2
4060
4061 #ifdef DEBUGGING
4062 # ifndef register
4063 #  define register
4064 # endif
4065 # define RUNOPS_DEFAULT Perl_runops_debug
4066 #else
4067 # define RUNOPS_DEFAULT Perl_runops_standard
4068 #endif
4069
4070 #ifdef USE_PERLIO
4071 EXTERN_C void PerlIO_teardown(void);
4072 # ifdef USE_ITHREADS
4073 #  define PERLIO_INIT MUTEX_INIT(&PL_perlio_mutex)
4074 #  define PERLIO_TERM                           \
4075         STMT_START {                            \
4076                 PerlIO_teardown();              \
4077                 MUTEX_DESTROY(&PL_perlio_mutex);\
4078         } STMT_END
4079 # else
4080 #  define PERLIO_INIT
4081 #  define PERLIO_TERM   PerlIO_teardown()
4082 # endif
4083 #else
4084 #  define PERLIO_INIT
4085 #  define PERLIO_TERM
4086 #endif
4087
4088 #ifdef MYMALLOC
4089 #  ifdef MUTEX_INIT_CALLS_MALLOC
4090 #    define MALLOC_INIT                                 \
4091         STMT_START {                                    \
4092                 PL_malloc_mutex = NULL;                 \
4093                 MUTEX_INIT(&PL_malloc_mutex);           \
4094         } STMT_END
4095 #    define MALLOC_TERM                                 \
4096         STMT_START {                                    \
4097                 perl_mutex tmp = PL_malloc_mutex;       \
4098                 PL_malloc_mutex = NULL;                 \
4099                 MUTEX_DESTROY(&tmp);                    \
4100         } STMT_END
4101 #  else
4102 #    define MALLOC_INIT MUTEX_INIT(&PL_malloc_mutex)
4103 #    define MALLOC_TERM MUTEX_DESTROY(&PL_malloc_mutex)
4104 #  endif
4105 #else
4106 #  define MALLOC_INIT
4107 #  define MALLOC_TERM
4108 #endif
4109
4110 #if defined(PERL_IMPLICIT_CONTEXT)
4111
4112 struct perl_memory_debug_header;
4113 struct perl_memory_debug_header {
4114   tTHX  interpreter;
4115 #  ifdef PERL_POISON
4116   MEM_SIZE size;
4117 #  endif
4118   struct perl_memory_debug_header *prev;
4119   struct perl_memory_debug_header *next;
4120 };
4121
4122 #  define sTHX  (sizeof(struct perl_memory_debug_header) + \
4123         (MEM_ALIGNBYTES - sizeof(struct perl_memory_debug_header) \
4124          %MEM_ALIGNBYTES) % MEM_ALIGNBYTES)
4125
4126 #else
4127 #  define sTHX  0
4128 #endif
4129
4130 #ifdef PERL_TRACK_MEMPOOL
4131 #  define INIT_TRACK_MEMPOOL(header, interp)                    \
4132         STMT_START {                                            \
4133                 (header).interpreter = (interp);                \
4134                 (header).prev = (header).next = &(header);      \
4135         } STMT_END
4136 #  else
4137 #  define INIT_TRACK_MEMPOOL(header, interp)
4138 #endif
4139
4140 #ifdef I_MALLOCMALLOC
4141 /* Needed for malloc_size(), malloc_good_size() on some systems */
4142 #  include <malloc/malloc.h>
4143 #endif
4144
4145 #ifdef MYMALLOC
4146 #  define Perl_safesysmalloc_size(where)        Perl_malloced_size(where)
4147 #else
4148 #  ifdef HAS_MALLOC_SIZE
4149 #    ifdef PERL_TRACK_MEMPOOL
4150 #       define Perl_safesysmalloc_size(where)                   \
4151             (malloc_size(((char *)(where)) - sTHX) - sTHX)
4152 #    else
4153 #       define Perl_safesysmalloc_size(where) malloc_size(where)
4154 #    endif
4155 #  endif
4156 #  ifdef HAS_MALLOC_GOOD_SIZE
4157 #    ifdef PERL_TRACK_MEMPOOL
4158 #       define Perl_malloc_good_size(how_much)                  \
4159             (malloc_good_size((how_much) + sTHX) - sTHX)
4160 #    else
4161 #       define Perl_malloc_good_size(how_much) malloc_good_size(how_much)
4162 #    endif
4163 #  else
4164 /* Having this as the identity operation makes some code simpler.  */
4165 #       define Perl_malloc_good_size(how_much)  (how_much)
4166 #  endif
4167 #endif
4168
4169 typedef int (*runops_proc_t)(pTHX);
4170 typedef void (*share_proc_t) (pTHX_ SV *sv);
4171 typedef int  (*thrhook_proc_t) (pTHX);
4172 typedef OP* (*PPADDR_t[]) (pTHX);
4173 typedef bool (*destroyable_proc_t) (pTHX_ SV *sv);
4174 typedef void (*despatch_signals_proc_t) (pTHX);
4175
4176 /* NeXT has problems with crt0.o globals */
4177 #if defined(__DYNAMIC__) && \
4178     (defined(NeXT) || defined(__NeXT__) || defined(PERL_DARWIN))
4179 #  if defined(NeXT) || defined(__NeXT)
4180 #    include <mach-o/dyld.h>
4181 #    define environ (*environ_pointer)
4182 EXT char *** environ_pointer;
4183 #  else
4184 #    if defined(PERL_DARWIN) && defined(PERL_CORE)
4185 #      include <crt_externs.h>  /* for the env array */
4186 #      define environ (*_NSGetEnviron())
4187 #    endif
4188 #  endif
4189 #else
4190    /* VMS and some other platforms don't use the environ array */
4191 #  ifdef USE_ENVIRON_ARRAY
4192 #    if !defined(DONT_DECLARE_STD) || \
4193         (defined(__svr4__) && defined(__GNUC__) && defined(sun)) || \
4194         defined(__sgi) || \
4195         defined(__DGUX)
4196 extern char **  environ;        /* environment variables supplied via exec */
4197 #    endif
4198 #  endif
4199 #endif
4200
4201 #define PERL_PATCHLEVEL_H_IMPLICIT
4202 #include "patchlevel.h"
4203 #undef PERL_PATCHLEVEL_H_IMPLICIT
4204
4205 #define PERL_VERSION_STRING     STRINGIFY(PERL_REVISION) "." \
4206                                 STRINGIFY(PERL_VERSION) "." \
4207                                 STRINGIFY(PERL_SUBVERSION)
4208
4209 #define PERL_API_VERSION_STRING STRINGIFY(PERL_API_REVISION) "." \
4210                                 STRINGIFY(PERL_API_VERSION) "." \
4211                                 STRINGIFY(PERL_API_SUBVERSION)
4212
4213 START_EXTERN_C
4214
4215 /* handy constants */
4216 EXTCONST char PL_warn_uninit[]
4217   INIT("Use of uninitialized value%s%s%s");
4218 EXTCONST char PL_warn_uninit_sv[]
4219   INIT("Use of uninitialized value%"SVf"%s%s");
4220 EXTCONST char PL_warn_nosemi[]
4221   INIT("Semicolon seems to be missing");
4222 EXTCONST char PL_warn_reserved[]
4223   INIT("Unquoted string \"%s\" may clash with future reserved word");
4224 EXTCONST char PL_warn_nl[]
4225   INIT("Unsuccessful %s on filename containing newline");
4226 EXTCONST char PL_no_wrongref[]
4227   INIT("Can't use %s ref as %s ref");
4228 /* The core no longer needs these here. If you require the string constant,
4229    please inline a copy into your own code.  */
4230 EXTCONST char PL_no_symref[] __attribute__deprecated__
4231   INIT("Can't use string (\"%.32s\") as %s ref while \"strict refs\" in use");
4232 EXTCONST char PL_no_symref_sv[] __attribute__deprecated__
4233   INIT("Can't use string (\"%" SVf32 "\") as %s ref while \"strict refs\" in use");
4234 EXTCONST char PL_no_usym[]
4235   INIT("Can't use an undefined value as %s reference");
4236 EXTCONST char PL_no_aelem[]
4237   INIT("Modification of non-creatable array value attempted, subscript %d");
4238 EXTCONST char PL_no_helem_sv[]
4239   INIT("Modification of non-creatable hash value attempted, subscript \"%"SVf"\"");
4240 EXTCONST char PL_no_modify[]
4241   INIT("Modification of a read-only value attempted");
4242 EXTCONST char PL_no_mem[]
4243   INIT("Out of memory!\n");
4244 EXTCONST char PL_no_security[]
4245   INIT("Insecure dependency in %s%s");
4246 EXTCONST char PL_no_sock_func[]
4247   INIT("Unsupported socket function \"%s\" called");
4248 EXTCONST char PL_no_dir_func[]
4249   INIT("Unsupported directory function \"%s\" called");
4250 EXTCONST char PL_no_func[]
4251   INIT("The %s function is unimplemented");
4252 EXTCONST char PL_no_myglob[]
4253   INIT("\"%s\" variable %s can't be in a package");
4254 EXTCONST char PL_no_localize_ref[]
4255   INIT("Can't localize through a reference");
4256 EXTCONST char PL_memory_wrap[]
4257   INIT("panic: memory wrap");
4258
4259 EXTCONST char PL_Yes[]
4260   INIT("1");
4261 EXTCONST char PL_No[]
4262   INIT("");
4263 EXTCONST char PL_hexdigit[]
4264   INIT("0123456789abcdef0123456789ABCDEF");
4265
4266 /* This is constant on most architectures, a global on OS/2 */
4267 #ifndef OS2
4268 EXTCONST char PL_sh_path[]
4269   INIT(SH_PATH); /* full path of shell */
4270 #endif
4271
4272 #ifdef CSH
4273 EXTCONST char PL_cshname[]
4274   INIT(CSH);
4275 #  define PL_cshlen     (sizeof(CSH "") - 1)
4276 #endif
4277
4278 /* These are baked at compile time into any shared perl library.
4279    In future releases this will allow us in main() to sanity test the
4280    library we're linking against.  */
4281
4282 EXTCONST U8 PL_revision
4283   INIT(PERL_REVISION);
4284 EXTCONST U8 PL_version
4285   INIT(PERL_VERSION);
4286 EXTCONST U8 PL_subversion
4287   INIT(PERL_SUBVERSION);
4288
4289 EXTCONST char PL_uuemap[65]
4290   INIT("`!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_");
4291
4292 #ifdef DOINIT
4293 EXTCONST char PL_uudmap[256] =
4294 #  ifdef PERL_MICRO
4295 #    include "uuudmap.h"
4296 #  else
4297 #    include "uudmap.h"
4298 #  endif
4299 ;
4300 EXTCONST char PL_bitcount[256] =
4301 #  ifdef PERL_MICRO
4302 #    include "ubitcount.h"
4303 #else
4304 #    include "bitcount.h"
4305 #  endif
4306 ;
4307 EXTCONST char* const PL_sig_name[] = { SIG_NAME };
4308 EXTCONST int         PL_sig_num[]  = { SIG_NUM };
4309 #else
4310 EXTCONST char PL_uudmap[256];
4311 EXTCONST char PL_bitcount[256];
4312 EXTCONST char* const PL_sig_name[];
4313 EXTCONST int         PL_sig_num[];
4314 #endif
4315
4316 /* fast conversion and case folding tables.  The folding tables complement the
4317  * fold, so that 'a' maps to 'A' and 'A' maps to 'a', ignoring more complicated
4318  * folds such as outside the range or to multiple characters. */
4319
4320 #ifdef DOINIT
4321 #ifndef EBCDIC
4322
4323 /* The EBCDIC fold table depends on the code page, and hence is found in
4324  * utfebcdic.h */
4325
4326 EXTCONST  unsigned char PL_fold[] = {
4327         0,      1,      2,      3,      4,      5,      6,      7,
4328         8,      9,      10,     11,     12,     13,     14,     15,
4329         16,     17,     18,     19,     20,     21,     22,     23,
4330         24,     25,     26,     27,     28,     29,     30,     31,
4331         32,     33,     34,     35,     36,     37,     38,     39,
4332         40,     41,     42,     43,     44,     45,     46,     47,
4333         48,     49,     50,     51,     52,     53,     54,     55,
4334         56,     57,     58,     59,     60,     61,     62,     63,
4335         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4336         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4337         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4338         'x',    'y',    'z',    91,     92,     93,     94,     95,
4339         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4340         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4341         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4342         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4343         128,    129,    130,    131,    132,    133,    134,    135,
4344         136,    137,    138,    139,    140,    141,    142,    143,
4345         144,    145,    146,    147,    148,    149,    150,    151,
4346         152,    153,    154,    155,    156,    157,    158,    159,
4347         160,    161,    162,    163,    164,    165,    166,    167,
4348         168,    169,    170,    171,    172,    173,    174,    175,
4349         176,    177,    178,    179,    180,    181,    182,    183,
4350         184,    185,    186,    187,    188,    189,    190,    191,
4351         192,    193,    194,    195,    196,    197,    198,    199,
4352         200,    201,    202,    203,    204,    205,    206,    207,
4353         208,    209,    210,    211,    212,    213,    214,    215,
4354         216,    217,    218,    219,    220,    221,    222,    223,
4355         224,    225,    226,    227,    228,    229,    230,    231,
4356         232,    233,    234,    235,    236,    237,    238,    239,
4357         240,    241,    242,    243,    244,    245,    246,    247,
4358         248,    249,    250,    251,    252,    253,    254,    255
4359 };
4360 EXTCONST  unsigned char PL_fold_latin1[] = {
4361     /* Full latin1 complement folding, except for three problematic code points:
4362      *  Micro sign (181 = 0xB5) and y with diearesis (255 = 0xFF) have their
4363      *  fold complements outside the Latin1 range, so can't match something
4364      *  that isn't in utf8.
4365      *  German lower case sharp s (223 = 0xDF) folds to two characters, 'ss',
4366      *  not one, so can't be represented in this table.
4367      *
4368      * All have to be specially handled */
4369         0,      1,      2,      3,      4,      5,      6,      7,
4370         8,      9,      10,     11,     12,     13,     14,     15,
4371         16,     17,     18,     19,     20,     21,     22,     23,
4372         24,     25,     26,     27,     28,     29,     30,     31,
4373         32,     33,     34,     35,     36,     37,     38,     39,
4374         40,     41,     42,     43,     44,     45,     46,     47,
4375         48,     49,     50,     51,     52,     53,     54,     55,
4376         56,     57,     58,     59,     60,     61,     62,     63,
4377         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4378         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4379         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4380         'x',    'y',    'z',    91,     92,     93,     94,     95,
4381         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4382         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4383         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4384         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4385         128,    129,    130,    131,    132,    133,    134,    135,
4386         136,    137,    138,    139,    140,    141,    142,    143,
4387         144,    145,    146,    147,    148,    149,    150,    151,
4388         152,    153,    154,    155,    156,    157,    158,    159,
4389         160,    161,    162,    163,    164,    165,    166,    167,
4390         168,    169,    170,    171,    172,    173,    174,    175,
4391         176,    177,    178,    179,    180,    181 /*micro */, 182,    183,
4392         184,    185,    186,    187,    188,    189,    190,    191,
4393         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4394         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4395         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4396         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223 /* ss */,
4397         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4398         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4399         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4400         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32,
4401         255 /* y with diaeresis */
4402 };
4403 #endif  /* !EBCDIC, but still in DOINIT */
4404
4405 /* If these tables are accessed through ebcdic, the access will be converted to
4406  * latin1 first */
4407 EXTCONST  unsigned char PL_latin1_lc[] = {  /* lowercasing */
4408         0,      1,      2,      3,      4,      5,      6,      7,
4409         8,      9,      10,     11,     12,     13,     14,     15,
4410         16,     17,     18,     19,     20,     21,     22,     23,
4411         24,     25,     26,     27,     28,     29,     30,     31,
4412         32,     33,     34,     35,     36,     37,     38,     39,
4413         40,     41,     42,     43,     44,     45,     46,     47,
4414         48,     49,     50,     51,     52,     53,     54,     55,
4415         56,     57,     58,     59,     60,     61,     62,     63,
4416         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4417         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4418         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4419         'x',    'y',    'z',    91,     92,     93,     94,     95,
4420         96,     97,     98,     99,     100,    101,    102,    103,
4421         104,    105,    106,    107,    108,    109,    110,    111,
4422         112,    113,    114,    115,    116,    117,    118,    119,
4423         120,    121,    122,    123,    124,    125,    126,    127,
4424         128,    129,    130,    131,    132,    133,    134,    135,
4425         136,    137,    138,    139,    140,    141,    142,    143,
4426         144,    145,    146,    147,    148,    149,    150,    151,
4427         152,    153,    154,    155,    156,    157,    158,    159,
4428         160,    161,    162,    163,    164,    165,    166,    167,
4429         168,    169,    170,    171,    172,    173,    174,    175,
4430         176,    177,    178,    179,    180,    181,    182,    183,
4431         184,    185,    186,    187,    188,    189,    190,    191,
4432         192+32, 193+32, 194+32, 195+32, 196+32, 197+32, 198+32, 199+32,
4433         200+32, 201+32, 202+32, 203+32, 204+32, 205+32, 206+32, 207+32,
4434         208+32, 209+32, 210+32, 211+32, 212+32, 213+32, 214+32, 215,
4435         216+32, 217+32, 218+32, 219+32, 220+32, 221+32, 222+32, 223,
4436         224,    225,    226,    227,    228,    229,    230,    231,
4437         232,    233,    234,    235,    236,    237,    238,    239,
4438         240,    241,    242,    243,    244,    245,    246,    247,
4439         248,    249,    250,    251,    252,    253,    254,    255
4440 };
4441
4442 /* upper and title case of latin1 characters, modified so that the three tricky
4443  * ones are mapped to 255 (which is one of the three) */
4444 EXTCONST  unsigned char PL_mod_latin1_uc[] = {
4445         0,      1,      2,      3,      4,      5,      6,      7,
4446         8,      9,      10,     11,     12,     13,     14,     15,
4447         16,     17,     18,     19,     20,     21,     22,     23,
4448         24,     25,     26,     27,     28,     29,     30,     31,
4449         32,     33,     34,     35,     36,     37,     38,     39,
4450         40,     41,     42,     43,     44,     45,     46,     47,
4451         48,     49,     50,     51,     52,     53,     54,     55,
4452         56,     57,     58,     59,     60,     61,     62,     63,
4453         64,     65,     66,     67,     68,     69,     70,     71,
4454         72,     73,     74,     75,     76,     77,     78,     79,
4455         80,     81,     82,     83,     84,     85,     86,     87,
4456         88,     89,     90,     91,     92,     93,     94,     95,
4457         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4458         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4459         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4460         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4461         128,    129,    130,    131,    132,    133,    134,    135,
4462         136,    137,    138,    139,    140,    141,    142,    143,
4463         144,    145,    146,    147,    148,    149,    150,    151,
4464         152,    153,    154,    155,    156,    157,    158,    159,
4465         160,    161,    162,    163,    164,    165,    166,    167,
4466         168,    169,    170,    171,    172,    173,    174,    175,
4467         176,    177,    178,    179,    180,    255 /*micro*/,  182,    183,
4468         184,    185,    186,    187,    188,    189,    190,    191,
4469         192,    193,    194,    195,    196,    197,    198,    199,
4470         200,    201,    202,    203,    204,    205,    206,    207,
4471         208,    209,    210,    211,    212,    213,    214,    215,
4472         216,    217,    218,    219,    220,    221,    222,    255 /*sharp s*/,
4473         224-32, 225-32, 226-32, 227-32, 228-32, 229-32, 230-32, 231-32,
4474         232-32, 233-32, 234-32, 235-32, 236-32, 237-32, 238-32, 239-32,
4475         240-32, 241-32, 242-32, 243-32, 244-32, 245-32, 246-32, 247,
4476         248-32, 249-32, 250-32, 251-32, 252-32, 253-32, 254-32, 255
4477 };
4478 #else   /* ! DOINIT */
4479 EXTCONST unsigned char PL_fold[];
4480 EXTCONST unsigned char PL_fold_latin1[];
4481 EXTCONST unsigned char PL_mod_latin1_uc[];
4482 EXTCONST unsigned char PL_latin1_lc[];
4483 #endif
4484
4485 #ifndef PERL_GLOBAL_STRUCT /* or perlvars.h */
4486 #ifdef DOINIT
4487 EXT unsigned char PL_fold_locale[] = { /* Unfortunately not EXTCONST. */
4488         0,      1,      2,      3,      4,      5,      6,      7,
4489         8,      9,      10,     11,     12,     13,     14,     15,
4490         16,     17,     18,     19,     20,     21,     22,     23,
4491         24,     25,     26,     27,     28,     29,     30,     31,
4492         32,     33,     34,     35,     36,     37,     38,     39,
4493         40,     41,     42,     43,     44,     45,     46,     47,
4494         48,     49,     50,     51,     52,     53,     54,     55,
4495         56,     57,     58,     59,     60,     61,     62,     63,
4496         64,     'a',    'b',    'c',    'd',    'e',    'f',    'g',
4497         'h',    'i',    'j',    'k',    'l',    'm',    'n',    'o',
4498         'p',    'q',    'r',    's',    't',    'u',    'v',    'w',
4499         'x',    'y',    'z',    91,     92,     93,     94,     95,
4500         96,     'A',    'B',    'C',    'D',    'E',    'F',    'G',
4501         'H',    'I',    'J',    'K',    'L',    'M',    'N',    'O',
4502         'P',    'Q',    'R',    'S',    'T',    'U',    'V',    'W',
4503         'X',    'Y',    'Z',    123,    124,    125,    126,    127,
4504         128,    129,    130,    131,    132,    133,    134,    135,
4505         136,    137,    138,    139,    140,    141,    142,    143,
4506         144,    145,    146,    147,    148,    149,    150,    151,
4507         152,    153,    154,    155,    156,    157,    158,    159,
4508         160,    161,    162,    163,    164,    165,    166,    167,
4509         168,    169,    170,    171,    172,    173,    174,    175,
4510         176,    177,    178,    179,    180,    181,    182,    183,
4511         184,    185,    186,    187,    188,    189,    190,    191,
4512         192,    193,    194,    195,    196,    197,    198,    199,
4513         200,    201,    202,    203,    204,    205,    206,    207,
4514         208,    209,    210,    211,    212,    213,    214,    215,
4515         216,    217,    218,    219,    220,    221,    222,    223,
4516         224,    225,    226,    227,    228,    229,    230,    231,
4517         232,    233,    234,    235,    236,    237,    238,    239,
4518         240,    241,    242,    243,    244,    245,    246,    247,
4519         248,    249,    250,    251,    252,    253,    254,    255
4520 };
4521 #else
4522 EXT unsigned char PL_fold_locale[]; /* Unfortunately not EXTCONST. */
4523 #endif
4524 #endif /* !PERL_GLOBAL_STRUCT */
4525
4526 #ifdef DOINIT
4527 #ifdef EBCDIC
4528 EXTCONST unsigned char PL_freq[] = {/* EBCDIC frequencies for mixed English/C */
4529     1,      2,      84,     151,    154,    155,    156,    157,
4530     165,    246,    250,    3,      158,    7,      18,     29,
4531     40,     51,     62,     73,     85,     96,     107,    118,
4532     129,    140,    147,    148,    149,    150,    152,    153,
4533     255,      6,      8,      9,     10,     11,     12,     13,
4534      14,     15,     24,     25,     26,     27,     28,    226,
4535      29,     30,     31,     32,     33,     43,     44,     45,
4536      46,     47,     48,     49,     50,     76,     77,     78,
4537      79,     80,     81,     82,     83,     84,     85,     86,
4538      87,     94,     95,    234,    181,    233,    187,    190,
4539     180,     96,     97,     98,     99,    100,    101,    102,
4540     104,    112,    182,    174,    236,    232,    229,    103,
4541     228,    226,    114,    115,    116,    117,    118,    119,
4542     120,    121,    122,    235,    176,    230,    194,    162,
4543     130,    131,    132,    133,    134,    135,    136,    137,
4544     138,    139,    201,    205,    163,    217,    220,    224,
4545     5,      248,    227,    244,    242,    255,    241,    231,
4546     240,    253,    16,     197,    19,     20,     21,     187,
4547     23,     169,    210,    245,    237,    249,    247,    239,
4548     168,    252,    34,     196,    36,     37,     38,     39,
4549     41,     42,     251,    254,    238,    223,    221,    213,
4550     225,    177,    52,     53,     54,     55,     56,     57,
4551     58,     59,     60,     61,     63,     64,     65,     66,
4552     67,     68,     69,     70,     71,     72,     74,     75,
4553     205,    208,    186,    202,    200,    218,    198,    179,
4554     178,    214,    88,     89,     90,     91,     92,     93,
4555     217,    166,    170,    207,    199,    209,    206,    204,
4556     160,    212,    105,    106,    108,    109,    110,    111,
4557     203,    113,    216,    215,    192,    175,    193,    243,
4558     172,    161,    123,    124,    125,    126,    127,    128,
4559     222,    219,    211,    195,    188,    193,    185,    184,
4560     191,    183,    141,    142,    143,    144,    145,    146
4561 };
4562 #else  /* ascii rather than ebcdic */
4563 EXTCONST unsigned char PL_freq[] = {    /* letter frequencies for mixed English/C */
4564         1,      2,      84,     151,    154,    155,    156,    157,
4565         165,    246,    250,    3,      158,    7,      18,     29,
4566         40,     51,     62,     73,     85,     96,     107,    118,
4567         129,    140,    147,    148,    149,    150,    152,    153,
4568         255,    182,    224,    205,    174,    176,    180,    217,
4569         233,    232,    236,    187,    235,    228,    234,    226,
4570         222,    219,    211,    195,    188,    193,    185,    184,
4571         191,    183,    201,    229,    181,    220,    194,    162,
4572         163,    208,    186,    202,    200,    218,    198,    179,
4573         178,    214,    166,    170,    207,    199,    209,    206,
4574         204,    160,    212,    216,    215,    192,    175,    173,
4575         243,    172,    161,    190,    203,    189,    164,    230,
4576         167,    248,    227,    244,    242,    255,    241,    231,
4577         240,    253,    169,    210,    245,    237,    249,    247,
4578         239,    168,    252,    251,    254,    238,    223,    221,
4579         213,    225,    177,    197,    171,    196,    159,    4,
4580         5,      6,      8,      9,      10,     11,     12,     13,
4581         14,     15,     16,     17,     19,     20,     21,     22,
4582         23,     24,     25,     26,     27,     28,     30,     31,
4583         32,     33,     34,     35,     36,     37,     38,     39,
4584         41,     42,     43,     44,     45,     46,     47,     48,
4585         49,     50,     52,     53,     54,     55,     56,     57,
4586         58,     59,     60,     61,     63,     64,     65,     66,
4587         67,     68,     69,     70,     71,     72,     74,     75,
4588         76,     77,     78,     79,     80,     81,     82,     83,
4589         86,     87,     88,     89,     90,     91,     92,     93,
4590         94,     95,     97,     98,     99,     100,    101,    102,
4591         103,    104,    105,    106,    108,    109,    110,    111,
4592         112,    113,    114,    115,    116,    117,    119,    120,
4593         121,    122,    123,    124,    125,    126,    127,    128,
4594         130,    131,    132,    133,    134,    135,    136,    137,
4595         138,    139,    141,    142,    143,    144,    145,    146
4596 };
4597 #endif
4598 #else
4599 EXTCONST unsigned char PL_freq[];
4600 #endif
4601
4602 #ifdef DEBUGGING
4603 #ifdef DOINIT
4604 EXTCONST char* const PL_block_type[] = {
4605         "NULL",
4606         "WHEN",
4607         "BLOCK",
4608         "GIVEN",
4609         "LOOP_FOR",
4610         "LOOP_PLAIN",
4611         "LOOP_LAZYSV",
4612         "LOOP_LAZYIV",
4613         "SUB",
4614         "FORMAT",
4615         "EVAL",
4616         "SUBST"
4617 };
4618 #else
4619 EXTCONST char* PL_block_type[];
4620 #endif
4621 #endif
4622
4623 /* These are all the compile time options that affect binary compatibility.
4624    Other compile time options that are binary compatible are in perl.c
4625    Both are combined for the output of perl -V
4626    However, this string will be embedded in any shared perl library, which will
4627    allow us add a comparison check in perlmain.c in the near future.  */
4628 #ifdef DOINIT
4629 EXTCONST char PL_bincompat_options[] =
4630 #  ifdef DEBUG_LEAKING_SCALARS
4631                              " DEBUG_LEAKING_SCALARS"
4632 #  endif
4633 #  ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
4634                              " DEBUG_LEAKING_SCALARS_FORK_DUMP"
4635 #  endif
4636 #  ifdef FAKE_THREADS
4637                              " FAKE_THREADS"
4638 #  endif
4639 #  ifdef FCRYPT
4640                              " FCRYPT"
4641 #  endif
4642 #  ifdef HAS_TIMES
4643                              " HAS_TIMES"
4644 #  endif
4645 #  ifdef HAVE_INTERP_INTERN
4646                              " HAVE_INTERP_INTERN"
4647 #  endif
4648 #  ifdef MULTIPLICITY
4649                              " MULTIPLICITY"
4650 #  endif
4651 #  ifdef MYMALLOC
4652                              " MYMALLOC"
4653 #  endif
4654 #  ifdef PERLIO_LAYERS
4655                              " PERLIO_LAYERS"
4656 #  endif
4657 #  ifdef PERL_DEBUG_READONLY_OPS
4658                              " PERL_DEBUG_READONLY_OPS"
4659 #  endif
4660 #  ifdef PERL_GLOBAL_STRUCT
4661                              " PERL_GLOBAL_STRUCT"
4662 #  endif
4663 #  ifdef PERL_IMPLICIT_CONTEXT
4664                              " PERL_IMPLICIT_CONTEXT"
4665 #  endif
4666 #  ifdef PERL_IMPLICIT_SYS
4667                              " PERL_IMPLICIT_SYS"
4668 #  endif
4669 #  ifdef PERL_MAD
4670                              " PERL_MAD"
4671 #  endif
4672 #  ifdef PERL_MICRO
4673                              " PERL_MICRO"
4674 #  endif
4675 #  ifdef PERL_NEED_APPCTX
4676                              " PERL_NEED_APPCTX"
4677 #  endif
4678 #  ifdef PERL_NEED_TIMESBASE
4679                              " PERL_NEED_TIMESBASE"
4680 #  endif
4681 #  ifdef PERL_OLD_COPY_ON_WRITE
4682                              " PERL_OLD_COPY_ON_WRITE"
4683 #  endif
4684 #  ifdef PERL_POISON
4685                              " PERL_POISON"
4686 #  endif
4687 #  ifdef PERL_TRACK_MEMPOOL
4688                              " PERL_TRACK_MEMPOOL"
4689 #  endif
4690 #  ifdef PERL_USES_PL_PIDSTATUS
4691                              " PERL_USES_PL_PIDSTATUS"
4692 #  endif
4693 #  ifdef PL_OP_SLAB_ALLOC
4694                              " PL_OP_SLAB_ALLOC"
4695 #  endif
4696 #  ifdef USE_64_BIT_ALL
4697                              " USE_64_BIT_ALL"
4698 #  endif
4699 #  ifdef USE_64_BIT_INT
4700                              " USE_64_BIT_INT"
4701 #  endif
4702 #  ifdef USE_IEEE
4703                              " USE_IEEE"
4704 #  endif
4705 #  ifdef USE_ITHREADS
4706                              " USE_ITHREADS"
4707 #  endif
4708 #  ifdef USE_LARGE_FILES
4709                              " USE_LARGE_FILES"
4710 #  endif
4711 #  ifdef USE_LOCALE_COLLATE
4712                              " USE_LOCALE_COLLATE"
4713 #  endif
4714 #  ifdef USE_LOCALE_NUMERIC
4715                              " USE_LOCALE_NUMERIC"
4716 #  endif
4717 #  ifdef USE_LONG_DOUBLE
4718                              " USE_LONG_DOUBLE"
4719 #  endif
4720 #  ifdef USE_PERLIO
4721                              " USE_PERLIO"
4722 #  endif
4723 #  ifdef USE_REENTRANT_API
4724                              " USE_REENTRANT_API"
4725 #  endif
4726 #  ifdef USE_SFIO
4727                              " USE_SFIO"
4728 #  endif
4729 #  ifdef USE_SOCKS
4730                              " USE_SOCKS"
4731 #  endif
4732 #  ifdef VMS_DO_SOCKETS
4733                              " VMS_DO_SOCKETS"
4734 #  endif
4735 #  ifdef VMS_SHORTEN_LONG_SYMBOLS
4736                              " VMS_SHORTEN_LONG_SYMBOLS"
4737 #  endif
4738 #  ifdef VMS_WE_ARE_CASE_SENSITIVE
4739                              " VMS_SYMBOL_CASE_AS_IS"
4740 #  endif
4741   "";
4742 #else
4743 EXTCONST char PL_bincompat_options[];
4744 #endif
4745
4746 #ifndef PERL_SET_PHASE
4747 #  define PERL_SET_PHASE(new_phase) \
4748     PHASE_CHANGE_PROBE(PL_phase_names[new_phase], PL_phase_names[PL_phase]); \
4749     PL_phase = new_phase;
4750 #endif
4751
4752 /* The interpreter phases. If these ever change, PL_phase_names right below will
4753  * need to be updated accordingly. */
4754 enum perl_phase {
4755     PERL_PHASE_CONSTRUCT        = 0,
4756     PERL_PHASE_START            = 1,
4757     PERL_PHASE_CHECK            = 2,
4758     PERL_PHASE_INIT             = 3,
4759     PERL_PHASE_RUN              = 4,
4760     PERL_PHASE_END              = 5,
4761     PERL_PHASE_DESTRUCT         = 6
4762 };
4763
4764 #ifdef DOINIT
4765 EXTCONST char *const PL_phase_names[] = {
4766     "CONSTRUCT",
4767     "START",
4768     "CHECK",
4769     "INIT",
4770     "RUN",
4771     "END",
4772     "DESTRUCT"
4773 };
4774 #else
4775 EXTCONST char *const PL_phase_names[];
4776 #endif
4777
4778 #ifndef PERL_CORE
4779 /* Do not use this macro. It only exists for extensions that rely on PL_dirty
4780  * instead of using the newer PL_phase, which provides everything PL_dirty
4781  * provided, and more. */
4782 #  define PL_dirty (PL_phase == PERL_PHASE_DESTRUCT)
4783
4784 #  define PL_amagic_generation PL_na
4785 #endif /* !PERL_CORE */
4786
4787 END_EXTERN_C
4788
4789 /*****************************************************************************/
4790 /* This lexer/parser stuff is currently global since yacc is hard to reenter */
4791 /*****************************************************************************/
4792 /* XXX This needs to be revisited, since BEGIN makes yacc re-enter... */
4793
4794 #ifdef __Lynx__
4795 /* LynxOS defines these in scsi.h which is included via ioctl.h */
4796 #ifdef FORMAT
4797 #undef FORMAT
4798 #endif
4799 #ifdef SPACE
4800 #undef SPACE
4801 #endif
4802 #endif
4803
4804 #define LEX_NOTPARSING          11      /* borrowed from toke.c */
4805
4806 typedef enum {
4807     XOPERATOR,
4808     XTERM,
4809     XREF,
4810     XSTATE,
4811     XBLOCK,
4812     XATTRBLOCK,
4813     XATTRTERM,
4814     XTERMBLOCK,
4815     XTERMORDORDOR /* evil hack */
4816     /* update exp_name[] in toke.c if adding to this enum */
4817 } expectation;
4818
4819 /* Hints are now stored in a dedicated U32, so the bottom 8 bits are no longer
4820    special and there is no need for HINT_PRIVATE_MASK for COPs
4821    However, bitops store HINT_INTEGER in their op_private.  */
4822 #define HINT_INTEGER            0x00000001 /* integer pragma */
4823 #define HINT_STRICT_REFS        0x00000002 /* strict pragma */
4824 #define HINT_LOCALE             0x00000004 /* locale pragma */
4825 #define HINT_BYTES              0x00000008 /* bytes pragma */
4826 #define HINT_LOCALE_NOT_CHARS   0x00000010 /* locale ':not_characters' pragma */
4827
4828 #define HINT_EXPLICIT_STRICT_REFS       0x00000020 /* strict.pm */
4829 #define HINT_EXPLICIT_STRICT_SUBS       0x00000040 /* strict.pm */
4830 #define HINT_EXPLICIT_STRICT_VARS       0x00000080 /* strict.pm */
4831
4832 #define HINT_BLOCK_SCOPE        0x00000100
4833 #define HINT_STRICT_SUBS        0x00000200 /* strict pragma */
4834 #define HINT_STRICT_VARS        0x00000400 /* strict pragma */
4835 #define HINT_UNI_8_BIT          0x00000800 /* unicode_strings feature */
4836
4837 /* The HINT_NEW_* constants are used by the overload pragma */
4838 #define HINT_NEW_INTEGER        0x00001000
4839 #define HINT_NEW_FLOAT          0x00002000
4840 #define HINT_NEW_BINARY         0x00004000
4841 #define HINT_NEW_STRING         0x00008000
4842 #define HINT_NEW_RE             0x00010000
4843 #define HINT_LOCALIZE_HH        0x00020000 /* %^H needs to be copied */
4844 #define HINT_LEXICAL_IO_IN      0x00040000 /* ${^OPEN} is set for input */
4845 #define HINT_LEXICAL_IO_OUT     0x00080000 /* ${^OPEN} is set for output */
4846
4847 #define HINT_RE_TAINT           0x00100000 /* re pragma */
4848 #define HINT_RE_EVAL            0x00200000 /* re pragma */
4849
4850 #define HINT_FILETEST_ACCESS    0x00400000 /* filetest pragma */
4851 #define HINT_UTF8               0x00800000 /* utf8 pragma */
4852
4853 #define HINT_NO_AMAGIC          0x01000000 /* overloading pragma */
4854
4855 #define HINT_RE_FLAGS           0x02000000 /* re '/xism' pragma */
4856
4857 #define HINT_FEATURE_MASK       0x1c000000 /* 3 bits for feature bundles */
4858
4859                                 /* Note: Used for NATIVE_HINTS, currently
4860                                    defined by vms/vmsish.h:
4861                                 0x40000000
4862                                 0x80000000
4863                                  */
4864
4865 /* The following are stored in $^H{sort}, not in PL_hints */
4866 #define HINT_SORT_SORT_BITS     0x000000FF /* allow 256 different ones */
4867 #define HINT_SORT_QUICKSORT     0x00000001
4868 #define HINT_SORT_MERGESORT     0x00000002
4869 #define HINT_SORT_STABLE        0x00000100 /* sort styles (currently one) */
4870
4871 /* Various states of the input record separator SV (rs) */
4872 #define RsSNARF(sv)   (! SvOK(sv))
4873 #define RsSIMPLE(sv)  (SvOK(sv) && (! SvPOK(sv) || SvCUR(sv)))
4874 #define RsPARA(sv)    (SvPOK(sv) && ! SvCUR(sv))
4875 #define RsRECORD(sv)  (SvROK(sv) && (SvIV(SvRV(sv)) > 0))
4876
4877 /* A struct for keeping various DEBUGGING related stuff,
4878  * neatly packed.  Currently only scratch variables for
4879  * constructing debug output are included.  Needed always,
4880  * not just when DEBUGGING, though, because of the re extension. c*/
4881 struct perl_debug_pad {
4882   SV pad[3];
4883 };
4884
4885 #define PERL_DEBUG_PAD(i)       &(PL_debug_pad.pad[i])
4886 #define PERL_DEBUG_PAD_ZERO(i)  (SvPVX(PERL_DEBUG_PAD(i))[0] = 0, \
4887         (((XPV*) SvANY(PERL_DEBUG_PAD(i)))->xpv_cur = 0), \
4888         PERL_DEBUG_PAD(i))
4889
4890 /* Enable variables which are pointers to functions */
4891 typedef void (*peep_t)(pTHX_ OP* o);
4892 typedef regexp* (*regcomp_t) (pTHX_ char* exp, char* xend, PMOP* pm);
4893 typedef I32     (*regexec_t) (pTHX_ regexp* prog, char* stringarg,
4894                                       char* strend, char* strbeg, I32 minend,
4895                                       SV* screamer, void* data, U32 flags);
4896 typedef char*   (*re_intuit_start_t) (pTHX_ regexp *prog, SV *sv,
4897                                                 char *strpos, char *strend,
4898                                                 U32 flags,
4899                                                 re_scream_pos_data *d);
4900 typedef SV*     (*re_intuit_string_t) (pTHX_ regexp *prog);
4901 typedef void    (*regfree_t) (pTHX_ struct regexp* r);
4902 typedef regexp* (*regdupe_t) (pTHX_ const regexp* r, CLONE_PARAMS *param);
4903 typedef I32     (*re_fold_t)(const char *, char const *, I32);
4904
4905 typedef void (*DESTRUCTORFUNC_NOCONTEXT_t) (void*);
4906 typedef void (*DESTRUCTORFUNC_t) (pTHX_ void*);
4907 typedef void (*SVFUNC_t) (pTHX_ SV* const);
4908 typedef I32  (*SVCOMPARE_t) (pTHX_ SV* const, SV* const);
4909 typedef void (*XSINIT_t) (pTHX);
4910 typedef void (*ATEXIT_t) (pTHX_ void*);
4911 typedef void (*XSUBADDR_t) (pTHX_ CV *);
4912
4913 typedef OP* (*Perl_ppaddr_t)(pTHX);
4914 typedef OP* (*Perl_check_t) (pTHX_ OP*);
4915 typedef void(*Perl_ophook_t)(pTHX_ OP*);
4916 typedef int (*Perl_keyword_plugin_t)(pTHX_ char*, STRLEN, OP**);
4917 typedef void(*Perl_cpeep_t)(pTHX_ OP *, OP *);
4918
4919 typedef void(*globhook_t)(pTHX);
4920
4921 #define KEYWORD_PLUGIN_DECLINE 0
4922 #define KEYWORD_PLUGIN_STMT    1
4923 #define KEYWORD_PLUGIN_EXPR    2
4924
4925 /* Interpreter exitlist entry */
4926 typedef struct exitlistentry {
4927     void (*fn) (pTHX_ void*);
4928     void *ptr;
4929 } PerlExitListEntry;
4930
4931 /* if you only have signal() and it resets on each signal, FAKE_PERSISTENT_SIGNAL_HANDLERS fixes */
4932 /* These have to be before perlvars.h */
4933 #if !defined(HAS_SIGACTION) && defined(VMS)
4934 #  define  FAKE_PERSISTENT_SIGNAL_HANDLERS
4935 #endif
4936 /* if we're doing kill() with sys$sigprc on VMS, FAKE_DEFAULT_SIGNAL_HANDLERS */
4937 #if defined(KILL_BY_SIGPRC)
4938 #  define  FAKE_DEFAULT_SIGNAL_HANDLERS
4939 #endif
4940
4941 #if !defined(MULTIPLICITY)
4942
4943 struct interpreter {
4944     char broiled;
4945 };
4946
4947 #else
4948
4949 /* If we have multiple interpreters define a struct
4950    holding variables which must be per-interpreter
4951    If we don't have threads anything that would have
4952    be per-thread is per-interpreter.
4953 */
4954
4955 /* Set up PERLVAR macros for populating structs */
4956 #  define PERLVAR(prefix,var,type) type prefix##var;
4957 #  define PERLVARA(prefix,var,n,type) type prefix##var[n];
4958 #  define PERLVARI(prefix,var,type,init) type prefix##var;
4959 #  define PERLVARIC(prefix,var,type,init) type prefix##var;
4960
4961 struct interpreter {
4962 #  include "intrpvar.h"
4963 };
4964
4965 EXTCONST U16 PL_interp_size
4966   INIT(sizeof(struct interpreter));
4967
4968 #  define PERL_INTERPRETER_SIZE_UPTO_MEMBER(member)                     \
4969     STRUCT_OFFSET(struct interpreter, member) +                         \
4970     sizeof(((struct interpreter*)0)->member)
4971
4972 /* This will be useful for subsequent releases, because this has to be the
4973    same in your libperl as in main(), else you have a mismatch and must abort.
4974 */
4975 EXTCONST U16 PL_interp_size_5_16_0
4976   INIT(PERL_INTERPRETER_SIZE_UPTO_MEMBER(PERL_LAST_5_16_0_INTERP_MEMBER));
4977
4978
4979 #  ifdef PERL_GLOBAL_STRUCT
4980 /* MULTIPLICITY is automatically defined when PERL_GLOBAL_STRUCT is defined,
4981    hence it's safe and sane to nest this within #ifdef MULTIPLICITY  */
4982
4983 struct perl_vars {
4984 #    include "perlvars.h"
4985 };
4986
4987 EXTCONST U16 PL_global_struct_size
4988   INIT(sizeof(struct perl_vars));
4989
4990 #    ifdef PERL_CORE
4991 #      ifndef PERL_GLOBAL_STRUCT_PRIVATE
4992 EXT struct perl_vars PL_Vars;
4993 EXT struct perl_vars *PL_VarsPtr INIT(&PL_Vars);
4994 #        undef PERL_GET_VARS
4995 #        define PERL_GET_VARS() PL_VarsPtr
4996 #      endif /* !PERL_GLOBAL_STRUCT_PRIVATE */
4997 #    else /* PERL_CORE */
4998 #      if !defined(__GNUC__) || !defined(WIN32)
4999 EXT
5000 #      endif /* WIN32 */
5001 struct perl_vars *PL_VarsPtr;
5002 #      define PL_Vars (*((PL_VarsPtr) \
5003                        ? PL_VarsPtr : (PL_VarsPtr = Perl_GetVars(aTHX))))
5004 #    endif /* PERL_CORE */
5005 #  endif /* PERL_GLOBAL_STRUCT */
5006
5007 /* Done with PERLVAR macros for now ... */
5008 #  undef PERLVAR
5009 #  undef PERLVARA
5010 #  undef PERLVARI
5011 #  undef PERLVARIC
5012
5013 #endif /* MULTIPLICITY */
5014
5015 struct tempsym; /* defined in pp_pack.c */
5016
5017 #include "thread.h"
5018 #include "pp.h"
5019
5020 #ifndef PERL_CALLCONV
5021 #  ifdef __cplusplus
5022 #    define PERL_CALLCONV extern "C"
5023 #  else
5024 #    define PERL_CALLCONV
5025 #  endif
5026 #endif
5027 #undef PERL_CKDEF
5028 #undef PERL_PPDEF
5029 #define PERL_CKDEF(s)   PERL_CALLCONV OP *s (pTHX_ OP *o);
5030 #define PERL_PPDEF(s)   PERL_CALLCONV OP *s (pTHX);
5031
5032 #ifdef MYMALLOC
5033 #  include "malloc_ctl.h"
5034 #endif
5035
5036 #include "proto.h"
5037
5038 /* this has structure inits, so it cannot be included before here */
5039 #include "opcode.h"
5040
5041 /* The following must follow proto.h as #defines mess up syntax */
5042
5043 #if !defined(PERL_FOR_X2P)
5044 #  include "embedvar.h"
5045 #endif
5046 #ifndef PERL_MAD
5047 #  undef PL_madskills
5048 #  undef PL_xmlfp
5049 #  define PL_madskills 0
5050 #  define PL_xmlfp 0
5051 #endif
5052
5053 /* Now include all the 'global' variables
5054  * If we don't have threads or multiple interpreters
5055  * these include variables that would have been their struct-s
5056  */
5057
5058 #define PERLVAR(prefix,var,type) EXT type PL_##var;
5059 #define PERLVARA(prefix,var,n,type) EXT type PL_##var[n];
5060 #define PERLVARI(prefix,var,type,init) EXT type  PL_##var INIT(init);
5061 #define PERLVARIC(prefix,var,type,init) EXTCONST type PL_##var INIT(init);
5062
5063 #if !defined(MULTIPLICITY)
5064 START_EXTERN_C
5065 #  include "intrpvar.h"
5066 END_EXTERN_C
5067 #endif
5068
5069 #ifdef PERL_CORE
5070 /* All core uses now exterminated. Ensure no zombies can return:  */
5071 #  undef PL_na
5072 #endif
5073
5074 /* Now all the config stuff is setup we can include embed.h
5075    In particular, need the relevant *ish file included already, as it may
5076    define HAVE_INTERP_INTERN  */
5077 #include "embed.h"
5078 #ifndef PERL_MAD
5079 #  undef op_getmad
5080 #  define op_getmad(arg,pegop,slot) NOOP
5081 #endif
5082
5083 #ifndef PERL_GLOBAL_STRUCT
5084 START_EXTERN_C
5085
5086 #  include "perlvars.h"
5087
5088 END_EXTERN_C
5089 #endif
5090
5091 #undef PERLVAR
5092 #undef PERLVARA
5093 #undef PERLVARI
5094 #undef PERLVARIC
5095
5096 START_EXTERN_C
5097
5098 /* dummy variables that hold pointers to both runops functions, thus forcing
5099  * them *both* to get linked in (useful for Peek.xs, debugging etc) */
5100
5101 EXTCONST runops_proc_t PL_runops_std
5102   INIT(Perl_runops_standard);
5103 EXTCONST runops_proc_t PL_runops_dbg
5104   INIT(Perl_runops_debug);
5105
5106 /* PERL_GLOBAL_STRUCT_PRIVATE wants to keep global data like the
5107  * magic vtables const, but this is incompatible with SWIG which
5108  * does want to modify the vtables. */
5109 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
5110 #  define EXT_MGVTBL EXTCONST MGVTBL
5111 #else
5112 #  define EXT_MGVTBL EXT MGVTBL
5113 #endif
5114
5115 #define PERL_MAGIC_READONLY_ACCEPTABLE 0x40
5116 #define PERL_MAGIC_VALUE_MAGIC 0x80
5117 #define PERL_MAGIC_VTABLE_MASK 0x3F
5118 #define PERL_MAGIC_TYPE_READONLY_ACCEPTABLE(t) \
5119     (PL_magic_data[(U8)(t)] & PERL_MAGIC_READONLY_ACCEPTABLE)
5120 #define PERL_MAGIC_TYPE_IS_VALUE_MAGIC(t) \
5121     (PL_magic_data[(U8)(t)] & PERL_MAGIC_VALUE_MAGIC)
5122
5123 #include "mg_vtable.h"
5124
5125 #ifdef DOINIT
5126 EXTCONST U8 PL_magic_data[256] =
5127 #  ifdef PERL_MICRO
5128 #    include "umg_data.h"
5129 #  else
5130 #    include "mg_data.h"
5131 #  endif
5132 ;
5133 #else
5134 EXTCONST U8 PL_magic_data[256];
5135 #endif
5136
5137 #ifdef DOINIT
5138                         /* NL BD IV NV PV PI PN MG RX GV LV AV HV CV FM IO */
5139 EXTCONST bool
5140 PL_valid_types_IVX[]    = { 0, 0, 1, 0, 0, 1, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5141 EXTCONST bool
5142 PL_valid_types_NVX[]    = { 0, 0, 0, 1, 0, 0, 1, 1, 0, 1, 1, 0, 0, 0, 0, 0 };
5143 EXTCONST bool
5144 PL_valid_types_PVX[]    = { 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1 };
5145 EXTCONST bool
5146 PL_valid_types_RV[]     = { 0, 0, 1, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1 };
5147 EXTCONST bool
5148 PL_valid_types_IV_set[] = { 0, 0, 1, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1 };
5149 EXTCONST bool
5150 PL_valid_types_NV_set[] = { 0, 0, 0, 1, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 };
5151
5152 #else
5153
5154 EXTCONST bool PL_valid_types_IVX[];
5155 EXTCONST bool PL_valid_types_NVX[];
5156 EXTCONST bool PL_valid_types_PVX[];
5157 EXTCONST bool PL_valid_types_RV[];
5158 EXTCONST bool PL_valid_types_IV_set[];
5159 EXTCONST bool PL_valid_types_NV_set[];
5160
5161 #endif
5162
5163
5164 #include "overload.h"
5165
5166 END_EXTERN_C
5167
5168 struct am_table {
5169   U8 flags;
5170   U8 fallback;
5171   U16 spare;
5172   U32 was_ok_sub;
5173   CV* table[NofAMmeth];
5174 };
5175 struct am_table_short {
5176   U8 flags;
5177   U8 fallback;
5178   U16 spare;
5179   U32 was_ok_sub;
5180 };
5181 typedef struct am_table AMT;
5182 typedef struct am_table_short AMTS;
5183
5184 #define AMGfallNEVER    1
5185 #define AMGfallNO       2
5186 #define AMGfallYES      3
5187
5188 #define AMTf_AMAGIC             1
5189 #define AMTf_OVERLOADED         2
5190 #define AMT_AMAGIC(amt)         ((amt)->flags & AMTf_AMAGIC)
5191 #define AMT_AMAGIC_on(amt)      ((amt)->flags |= AMTf_AMAGIC)
5192 #define AMT_AMAGIC_off(amt)     ((amt)->flags &= ~AMTf_AMAGIC)
5193 #define AMT_OVERLOADED(amt)     ((amt)->flags & AMTf_OVERLOADED)
5194 #define AMT_OVERLOADED_on(amt)  ((amt)->flags |= AMTf_OVERLOADED)
5195 #define AMT_OVERLOADED_off(amt) ((amt)->flags &= ~AMTf_OVERLOADED)
5196
5197 #define StashHANDLER(stash,meth)        gv_handler((stash),CAT2(meth,_amg))
5198
5199 /*
5200  * some compilers like to redefine cos et alia as faster
5201  * (and less accurate?) versions called F_cos et cetera (Quidquid
5202  * latine dictum sit, altum viditur.)  This trick collides with
5203  * the Perl overloading (amg).  The following #defines fool both.
5204  */
5205
5206 #ifdef _FASTMATH
5207 #   ifdef atan2
5208 #       define F_atan2_amg  atan2_amg
5209 #   endif
5210 #   ifdef cos
5211 #       define F_cos_amg    cos_amg
5212 #   endif
5213 #   ifdef exp
5214 #       define F_exp_amg    exp_amg
5215 #   endif
5216 #   ifdef log
5217 #       define F_log_amg    log_amg
5218 #   endif
5219 #   ifdef pow
5220 #       define F_pow_amg    pow_amg
5221 #   endif
5222 #   ifdef sin
5223 #       define F_sin_amg    sin_amg
5224 #   endif
5225 #   ifdef sqrt
5226 #       define F_sqrt_amg   sqrt_amg
5227 #   endif
5228 #endif /* _FASTMATH */
5229
5230 #define PERLDB_ALL              (PERLDBf_SUB    | PERLDBf_LINE  |       \
5231                                  PERLDBf_NOOPT  | PERLDBf_INTER |       \
5232                                  PERLDBf_SUBLINE| PERLDBf_SINGLE|       \
5233                                  PERLDBf_NAMEEVAL| PERLDBf_NAMEANON |   \
5234                                  PERLDBf_SAVESRC)
5235                                         /* No _NONAME, _GOTO */
5236 #define PERLDBf_SUB             0x01    /* Debug sub enter/exit */
5237 #define PERLDBf_LINE            0x02    /* Keep line # */
5238 #define PERLDBf_NOOPT           0x04    /* Switch off optimizations */
5239 #define PERLDBf_INTER           0x08    /* Preserve more data for
5240                                            later inspections  */
5241 #define PERLDBf_SUBLINE         0x10    /* Keep subr source lines */
5242 #define PERLDBf_SINGLE          0x20    /* Start with single-step on */
5243 #define PERLDBf_NONAME          0x40    /* For _SUB: no name of the subr */
5244 #define PERLDBf_GOTO            0x80    /* Report goto: call DB::goto */
5245 #define PERLDBf_NAMEEVAL        0x100   /* Informative names for evals */
5246 #define PERLDBf_NAMEANON        0x200   /* Informative names for anon subs */
5247 #define PERLDBf_SAVESRC         0x400   /* Save source lines into @{"_<$filename"} */
5248 #define PERLDBf_SAVESRC_NOSUBS  0x800   /* Including evals that generate no subroutines */
5249 #define PERLDBf_SAVESRC_INVALID 0x1000  /* Save source that did not compile */
5250
5251 #define PERLDB_SUB      (PL_perldb && (PL_perldb & PERLDBf_SUB))
5252 #define PERLDB_LINE     (PL_perldb && (PL_perldb & PERLDBf_LINE))
5253 #define PERLDB_NOOPT    (PL_perldb && (PL_perldb & PERLDBf_NOOPT))
5254 #define PERLDB_INTER    (PL_perldb && (PL_perldb & PERLDBf_INTER))
5255 #define PERLDB_SUBLINE  (PL_perldb && (PL_perldb & PERLDBf_SUBLINE))
5256 #define PERLDB_SINGLE   (PL_perldb && (PL_perldb & PERLDBf_SINGLE))
5257 #define PERLDB_SUB_NN   (PL_perldb && (PL_perldb & (PERLDBf_NONAME)))
5258 #define PERLDB_GOTO     (PL_perldb && (PL_perldb & PERLDBf_GOTO))
5259 #define PERLDB_NAMEEVAL (PL_perldb && (PL_perldb & PERLDBf_NAMEEVAL))
5260 #define PERLDB_NAMEANON (PL_perldb && (PL_perldb & PERLDBf_NAMEANON))
5261 #define PERLDB_SAVESRC  (PL_perldb && (PL_perldb & PERLDBf_SAVESRC))
5262 #define PERLDB_SAVESRC_NOSUBS   (PL_perldb && (PL_perldb & PERLDBf_SAVESRC_NOSUBS))
5263 #define PERLDB_SAVESRC_INVALID  (PL_perldb && (PL_perldb & PERLDBf_SAVESRC_INVALID))
5264
5265 #ifdef USE_LOCALE_NUMERIC
5266
5267 #define SET_NUMERIC_STANDARD() \
5268         set_numeric_standard();
5269
5270 #define SET_NUMERIC_LOCAL() \
5271         set_numeric_local();
5272
5273 /* Returns non-zero If the plain locale pragma without a parameter is in effect
5274  */
5275 #define IN_LOCALE_RUNTIME       (CopHINTS_get(PL_curcop) & HINT_LOCALE)
5276
5277 /* Returns non-zero If either form of the locale pragma is in effect */
5278 #define IN_SOME_LOCALE_FORM_RUNTIME   \
5279                 (CopHINTS_get(PL_curcop) & (HINT_LOCALE|HINT_LOCALE_NOT_CHARS))
5280
5281 #define IN_LOCALE_COMPILETIME   (PL_hints & HINT_LOCALE)
5282 #define IN_SOME_LOCALE_FORM_COMPILETIME \
5283                             (PL_hints & (HINT_LOCALE|HINT_LOCALE_NOT_CHARS))
5284
5285 #define IN_LOCALE \
5286         (IN_PERL_COMPILETIME ? IN_LOCALE_COMPILETIME : IN_LOCALE_RUNTIME)
5287 #define IN_SOME_LOCALE_FORM \
5288         (IN_PERL_COMPILETIME ? IN_SOME_LOCALE_FORM_COMPILETIME \
5289                              : IN_SOME_LOCALE_FORM_RUNTIME)
5290
5291 #define STORE_NUMERIC_LOCAL_SET_STANDARD() \
5292         bool was_local = PL_numeric_local && IN_LOCALE; \
5293         if (was_local) SET_NUMERIC_STANDARD();
5294
5295 #define STORE_NUMERIC_STANDARD_SET_LOCAL() \
5296         bool was_standard = PL_numeric_standard && IN_LOCALE; \
5297         if (was_standard) SET_NUMERIC_LOCAL();
5298
5299 #define RESTORE_NUMERIC_LOCAL() \
5300         if (was_local) SET_NUMERIC_LOCAL();
5301
5302 #define RESTORE_NUMERIC_STANDARD() \
5303         if (was_standard) SET_NUMERIC_STANDARD();
5304
5305 #define Atof                            my_atof
5306
5307 #else /* !USE_LOCALE_NUMERIC */
5308
5309 #define SET_NUMERIC_STANDARD()          /**/
5310 #define SET_NUMERIC_LOCAL()             /**/
5311 #define IS_NUMERIC_RADIX(a, b)          (0)
5312 #define STORE_NUMERIC_LOCAL_SET_STANDARD()      /**/
5313 #define STORE_NUMERIC_STANDARD_SET_LOCAL()      /**/
5314 #define RESTORE_NUMERIC_LOCAL()         /**/
5315 #define RESTORE_NUMERIC_STANDARD()      /**/
5316 #define Atof                            my_atof
5317 #define IN_LOCALE_RUNTIME               0
5318
5319 #endif /* !USE_LOCALE_NUMERIC */
5320
5321 #if !defined(Strtol) && defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && QUADKIND == QUAD_IS_LONG_LONG
5322 #    ifdef __hpux
5323 #        define strtoll __strtoll       /* secret handshake */
5324 #    endif
5325 #    ifdef WIN64
5326 #        define strtoll _strtoi64       /* secret handshake */
5327 #    endif
5328 #   if !defined(Strtol) && defined(HAS_STRTOLL)
5329 #       define Strtol   strtoll
5330 #   endif
5331 #    if !defined(Strtol) && defined(HAS_STRTOQ)
5332 #       define Strtol   strtoq
5333 #    endif
5334 /* is there atoq() anywhere? */
5335 #endif
5336 #if !defined(Strtol) && defined(HAS_STRTOL)
5337 #   define Strtol       strtol
5338 #endif
5339 #ifndef Atol
5340 /* It would be more fashionable to use Strtol() to define atol()
5341  * (as is done for Atoul(), see below) but for backward compatibility
5342  * we just assume atol(). */
5343 #   if defined(USE_64_BIT_INT) && defined(IV_IS_QUAD) && QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_ATOLL)
5344 #    ifdef WIN64
5345 #       define atoll    _atoi64         /* secret handshake */
5346 #    endif
5347 #       define Atol     atoll
5348 #   else
5349 #       define Atol     atol
5350 #   endif
5351 #endif
5352
5353 #if !defined(Strtoul) && defined(USE_64_BIT_INT) && defined(UV_IS_QUAD) && QUADKIND == QUAD_IS_LONG_LONG
5354 #    ifdef __hpux
5355 #        define strtoull __strtoull     /* secret handshake */
5356 #    endif
5357 #    ifdef WIN64
5358 #        define strtoull _strtoui64     /* secret handshake */
5359 #    endif
5360 #    if !defined(Strtoul) && defined(HAS_STRTOULL)
5361 #       define Strtoul  strtoull
5362 #    endif
5363 #    if !defined(Strtoul) && defined(HAS_STRTOUQ)
5364 #       define Strtoul  strtouq
5365 #    endif
5366 /* is there atouq() anywhere? */
5367 #endif
5368 #if !defined(Strtoul) && defined(HAS_STRTOUL)
5369 #   define Strtoul      strtoul
5370 #endif
5371 #if !defined(Strtoul) && defined(HAS_STRTOL) /* Last resort. */
5372 #   define Strtoul(s, e, b)     strchr((s), '-') ? ULONG_MAX : (unsigned long)strtol((s), (e), (b))
5373 #endif
5374 #ifndef Atoul
5375 #   define Atoul(s)     Strtoul(s, NULL, 10)
5376 #endif
5377
5378
5379 /* if these never got defined, they need defaults */
5380 #ifndef PERL_SET_CONTEXT
5381 #  define PERL_SET_CONTEXT(i)           PERL_SET_INTERP(i)
5382 #endif
5383
5384 #ifndef PERL_GET_CONTEXT
5385 #  define PERL_GET_CONTEXT              PERL_GET_INTERP
5386 #endif
5387
5388 #ifndef PERL_GET_THX
5389 #  define PERL_GET_THX                  ((void*)NULL)
5390 #endif
5391
5392 #ifndef PERL_SET_THX
5393 #  define PERL_SET_THX(t)               NOOP
5394 #endif
5395
5396 #ifndef PERL_SCRIPT_MODE
5397 #define PERL_SCRIPT_MODE "r"
5398 #endif
5399
5400 /*
5401  * Some operating systems are stingy with stack allocation,
5402  * so perl may have to guard against stack overflow.
5403  */
5404 #ifndef PERL_STACK_OVERFLOW_CHECK
5405 #define PERL_STACK_OVERFLOW_CHECK()  NOOP
5406 #endif
5407
5408 /*
5409  * Some nonpreemptive operating systems find it convenient to
5410  * check for asynchronous conditions after each op execution.
5411  * Keep this check simple, or it may slow down execution
5412  * massively.
5413  */
5414
5415 #ifndef PERL_MICRO
5416 #       ifndef PERL_ASYNC_CHECK
5417 #               define PERL_ASYNC_CHECK() if (PL_sig_pending) PL_signalhook(aTHX)
5418 #       endif
5419 #endif
5420
5421 #ifndef PERL_ASYNC_CHECK
5422 #   define PERL_ASYNC_CHECK()  NOOP
5423 #endif
5424
5425 /*
5426  * On some operating systems, a memory allocation may succeed,
5427  * but put the process too close to the system's comfort limit.
5428  * In this case, PERL_ALLOC_CHECK frees the pointer and sets
5429  * it to NULL.
5430  */
5431 #ifndef PERL_ALLOC_CHECK
5432 #define PERL_ALLOC_CHECK(p)  NOOP
5433 #endif
5434
5435 #ifdef HAS_SEM
5436 #   include <sys/ipc.h>
5437 #   include <sys/sem.h>
5438 #   ifndef HAS_UNION_SEMUN      /* Provide the union semun. */
5439     union semun {
5440         int             val;
5441         struct semid_ds *buf;
5442         unsigned short  *array;
5443     };
5444 #   endif
5445 #   ifdef USE_SEMCTL_SEMUN
5446 #       ifdef IRIX32_SEMUN_BROKEN_BY_GCC
5447             union gccbug_semun {
5448                 int             val;
5449                 struct semid_ds *buf;
5450                 unsigned short  *array;
5451                 char            __dummy[5];
5452             };
5453 #           define semun gccbug_semun
5454 #       endif
5455 #       define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun)
5456 #   else
5457 #       ifdef USE_SEMCTL_SEMID_DS
5458 #           ifdef EXTRA_F_IN_SEMUN_BUF
5459 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buff)
5460 #           else
5461 #               define Semctl(id, num, cmd, semun) semctl(id, num, cmd, semun.buf)
5462 #           endif
5463 #       endif
5464 #   endif
5465 #endif
5466
5467 /*
5468  * Boilerplate macros for initializing and accessing interpreter-local
5469  * data from C.  All statics in extensions should be reworked to use
5470  * this, if you want to make the extension thread-safe.  See
5471  * ext/XS/APItest/APItest.xs for an example of the use of these macros,
5472  * and perlxs.pod for more.
5473  *
5474  * Code that uses these macros is responsible for the following:
5475  * 1. #define MY_CXT_KEY to a unique string, e.g.
5476  *    "DynaLoader::_guts" XS_VERSION
5477  *    XXX in the current implementation, this string is ignored.
5478  * 2. Declare a typedef named my_cxt_t that is a structure that contains
5479  *    all the data that needs to be interpreter-local.
5480  * 3. Use the START_MY_CXT macro after the declaration of my_cxt_t.
5481  * 4. Use the MY_CXT_INIT macro such that it is called exactly once
5482  *    (typically put in the BOOT: section).
5483  * 5. Use the members of the my_cxt_t structure everywhere as
5484  *    MY_CXT.member.
5485  * 6. Use the dMY_CXT macro (a declaration) in all the functions that
5486  *    access MY_CXT.
5487  */
5488
5489 #if defined(PERL_IMPLICIT_CONTEXT)
5490
5491 /* START_MY_CXT must appear in all extensions that define a my_cxt_t structure,
5492  * right after the definition (i.e. at file scope).  The non-threads
5493  * case below uses it to declare the data as static. */
5494 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
5495 #    define START_MY_CXT
5496 #    define MY_CXT_INDEX Perl_my_cxt_index(aTHX_ MY_CXT_KEY)
5497 #    define MY_CXT_INIT_ARG MY_CXT_KEY
5498 #  else
5499 #    define START_MY_CXT static int my_cxt_index = -1;
5500 #    define MY_CXT_INDEX my_cxt_index
5501 #    define MY_CXT_INIT_ARG &my_cxt_index
5502 #  endif /* #ifdef PERL_GLOBAL_STRUCT_PRIVATE */
5503
5504 /* Creates and zeroes the per-interpreter data.
5505  * (We allocate my_cxtp in a Perl SV so that it will be released when
5506  * the interpreter goes away.) */
5507 #  define MY_CXT_INIT \
5508         my_cxt_t *my_cxtp = \
5509             (my_cxt_t*)Perl_my_cxt_init(aTHX_ MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
5510         PERL_UNUSED_VAR(my_cxtp)
5511 #  define MY_CXT_INIT_INTERP(my_perl) \
5512         my_cxt_t *my_cxtp = \
5513             (my_cxt_t*)Perl_my_cxt_init(my_perl, MY_CXT_INIT_ARG, sizeof(my_cxt_t)); \
5514         PERL_UNUSED_VAR(my_cxtp)
5515
5516 /* This declaration should be used within all functions that use the
5517  * interpreter-local data. */
5518 #  define dMY_CXT       \
5519         my_cxt_t *my_cxtp = (my_cxt_t *)PL_my_cxt_list[MY_CXT_INDEX]
5520 #  define dMY_CXT_INTERP(my_perl)       \
5521         my_cxt_t *my_cxtp = (my_cxt_t *)(my_perl)->Imy_cxt_list[MY_CXT_INDEX]
5522
5523 /* Clones the per-interpreter data. */
5524 #  define MY_CXT_CLONE \
5525         my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1));\
5526         Copy(PL_my_cxt_list[MY_CXT_INDEX], my_cxtp, 1, my_cxt_t);\
5527         PL_my_cxt_list[MY_CXT_INDEX] = my_cxtp                          \
5528
5529
5530 /* This macro must be used to access members of the my_cxt_t structure.
5531  * e.g. MY_CXT.some_data */
5532 #  define MY_CXT                (*my_cxtp)
5533
5534 /* Judicious use of these macros can reduce the number of times dMY_CXT
5535  * is used.  Use is similar to pTHX, aTHX etc. */
5536 #  define pMY_CXT       my_cxt_t *my_cxtp
5537 #  define pMY_CXT_      pMY_CXT,
5538 #  define _pMY_CXT      ,pMY_CXT
5539 #  define aMY_CXT       my_cxtp
5540 #  define aMY_CXT_      aMY_CXT,
5541 #  define _aMY_CXT      ,aMY_CXT
5542
5543 #else /* PERL_IMPLICIT_CONTEXT */
5544
5545 #  define START_MY_CXT          static my_cxt_t my_cxt;
5546 #  define dMY_CXT_SV            dNOOP
5547 #  define dMY_CXT               dNOOP
5548 #  define dMY_CXT_INTERP(my_perl) dNOOP
5549 #  define MY_CXT_INIT           NOOP
5550 #  define MY_CXT_CLONE          NOOP
5551 #  define MY_CXT                my_cxt
5552
5553 #  define pMY_CXT               void
5554 #  define pMY_CXT_
5555 #  define _pMY_CXT
5556 #  define aMY_CXT
5557 #  define aMY_CXT_
5558 #  define _aMY_CXT
5559
5560 #endif /* !defined(PERL_IMPLICIT_CONTEXT) */
5561
5562 #ifdef I_FCNTL
5563 #  include <fcntl.h>
5564 #endif
5565
5566 #ifdef __Lynx__
5567 #  include <fcntl.h>
5568 #endif
5569
5570 #ifdef I_SYS_FILE
5571 #  include <sys/file.h>
5572 #endif
5573
5574 #if defined(HAS_FLOCK) && !defined(HAS_FLOCK_PROTO)
5575 int flock(int fd, int op);
5576 #endif
5577
5578 #ifndef O_RDONLY
5579 /* Assume UNIX defaults */
5580 #    define O_RDONLY    0000
5581 #    define O_WRONLY    0001
5582 #    define O_RDWR      0002
5583 #    define O_CREAT     0100
5584 #endif
5585
5586 #ifndef O_BINARY
5587 #  define O_BINARY 0
5588 #endif
5589
5590 #ifndef O_TEXT
5591 #  define O_TEXT 0
5592 #endif
5593
5594 #if O_TEXT != O_BINARY
5595     /* If you have different O_TEXT and O_BINARY and you are a CLRF shop,
5596      * that is, you are somehow DOSish. */
5597 #   if defined(__BEOS__) || defined(__HAIKU__) || defined(__VOS__) || \
5598         defined(__CYGWIN__)
5599     /* BeOS/Haiku has O_TEXT != O_BINARY but O_TEXT and O_BINARY have no effect;
5600      * BeOS/Haiku is always UNIXoid (LF), not DOSish (CRLF). */
5601     /* VOS has O_TEXT != O_BINARY, and they have effect,
5602      * but VOS always uses LF, never CRLF. */
5603     /* If you have O_TEXT different from your O_BINARY but you still are
5604      * not a CRLF shop. */
5605 #       undef PERLIO_USING_CRLF
5606 #   else
5607     /* If you really are DOSish. */
5608 #      define PERLIO_USING_CRLF 1
5609 #   endif
5610 #endif
5611
5612 #ifdef I_LIBUTIL
5613 #   include <libutil.h>         /* setproctitle() in some FreeBSDs */
5614 #endif
5615
5616 #ifndef EXEC_ARGV_CAST
5617 #define EXEC_ARGV_CAST(x) (char **)x
5618 #endif
5619
5620 #define IS_NUMBER_IN_UV               0x01 /* number within UV range (maybe not
5621                                               int).  value returned in pointed-
5622                                               to UV */
5623 #define IS_NUMBER_GREATER_THAN_UV_MAX 0x02 /* pointed to UV undefined */
5624 #define IS_NUMBER_NOT_INT             0x04 /* saw . or E notation */
5625 #define IS_NUMBER_NEG                 0x08 /* leading minus sign */
5626 #define IS_NUMBER_INFINITY            0x10 /* this is big */
5627 #define IS_NUMBER_NAN                 0x20 /* this is not */
5628
5629 #define GROK_NUMERIC_RADIX(sp, send) grok_numeric_radix(sp, send)
5630
5631 /* Input flags: */
5632 #define PERL_SCAN_ALLOW_UNDERSCORES   0x01 /* grok_??? accept _ in numbers */
5633 #define PERL_SCAN_DISALLOW_PREFIX     0x02 /* grok_??? reject 0x in hex etc */
5634 #define PERL_SCAN_SILENT_ILLDIGIT     0x04 /* grok_??? not warn about illegal digits */
5635 #define PERL_SCAN_SILENT_NON_PORTABLE 0x08 /* grok_??? not warn about very large
5636                                               numbers which are <= UV_MAX */
5637 /* Output flags: */
5638 #define PERL_SCAN_GREATER_THAN_UV_MAX 0x02 /* should this merge with above? */
5639
5640 /* to let user control profiling */
5641 #ifdef PERL_GPROF_CONTROL
5642 extern void moncontrol(int);
5643 #define PERL_GPROF_MONCONTROL(x) moncontrol(x)
5644 #else
5645 #define PERL_GPROF_MONCONTROL(x)
5646 #endif
5647
5648 #ifdef UNDER_CE
5649 #include "wince.h"
5650 #endif
5651
5652 /* ISO 6429 NEL - C1 control NExt Line */
5653 /* See http://www.unicode.org/unicode/reports/tr13/ */
5654 #ifdef EBCDIC   /* In EBCDIC NEL is just an alias for LF */
5655 #   if '^' == 95        /* CP 1047: MVS OpenEdition - OS/390 - z/OS */
5656 #       define NEXT_LINE_CHAR   0x15
5657 #   else                /* CDRA */
5658 #       define NEXT_LINE_CHAR   0x25
5659 #   endif
5660 #else
5661 #   define NEXT_LINE_CHAR       0x85
5662 #endif
5663
5664 /* The UTF-8 bytes of the Unicode LS and PS, U+2028 and U+2029 */
5665 #define UNICODE_LINE_SEPA_0     0xE2
5666 #define UNICODE_LINE_SEPA_1     0x80
5667 #define UNICODE_LINE_SEPA_2     0xA8
5668 #define UNICODE_PARA_SEPA_0     0xE2
5669 #define UNICODE_PARA_SEPA_1     0x80
5670 #define UNICODE_PARA_SEPA_2     0xA9
5671
5672 #ifndef PIPESOCK_MODE
5673 #  define PIPESOCK_MODE
5674 #endif
5675
5676 #ifndef SOCKET_OPEN_MODE
5677 #  define SOCKET_OPEN_MODE      PIPESOCK_MODE
5678 #endif
5679
5680 #ifndef PIPE_OPEN_MODE
5681 #  define PIPE_OPEN_MODE        PIPESOCK_MODE
5682 #endif
5683
5684 #define PERL_MAGIC_UTF8_CACHESIZE       2
5685
5686 #define PERL_UNICODE_STDIN_FLAG                 0x0001
5687 #define PERL_UNICODE_STDOUT_FLAG                0x0002
5688 #define PERL_UNICODE_STDERR_FLAG                0x0004
5689 #define PERL_UNICODE_IN_FLAG                    0x0008
5690 #define PERL_UNICODE_OUT_FLAG                   0x0010
5691 #define PERL_UNICODE_ARGV_FLAG                  0x0020
5692 #define PERL_UNICODE_LOCALE_FLAG                0x0040
5693 #define PERL_UNICODE_WIDESYSCALLS_FLAG          0x0080 /* for Sarathy */
5694 #define PERL_UNICODE_UTF8CACHEASSERT_FLAG       0x0100
5695
5696 #define PERL_UNICODE_STD_FLAG           \
5697         (PERL_UNICODE_STDIN_FLAG        | \
5698          PERL_UNICODE_STDOUT_FLAG       | \
5699          PERL_UNICODE_STDERR_FLAG)
5700
5701 #define PERL_UNICODE_INOUT_FLAG         \
5702         (PERL_UNICODE_IN_FLAG   | \
5703          PERL_UNICODE_OUT_FLAG)
5704
5705 #define PERL_UNICODE_DEFAULT_FLAGS      \
5706         (PERL_UNICODE_STD_FLAG          | \
5707          PERL_UNICODE_INOUT_FLAG        | \
5708          PERL_UNICODE_LOCALE_FLAG)
5709
5710 #define PERL_UNICODE_ALL_FLAGS                  0x01ff
5711
5712 #define PERL_UNICODE_STDIN                      'I'
5713 #define PERL_UNICODE_STDOUT                     'O'
5714 #define PERL_UNICODE_STDERR                     'E'
5715 #define PERL_UNICODE_STD                        'S'
5716 #define PERL_UNICODE_IN                         'i'
5717 #define PERL_UNICODE_OUT                        'o'
5718 #define PERL_UNICODE_INOUT                      'D'
5719 #define PERL_UNICODE_ARGV                       'A'
5720 #define PERL_UNICODE_LOCALE                     'L'
5721 #define PERL_UNICODE_WIDESYSCALLS               'W'
5722 #define PERL_UNICODE_UTF8CACHEASSERT            'a'
5723
5724 #define PERL_SIGNALS_UNSAFE_FLAG        0x0001
5725
5726 /* Use instead of abs() since abs() forces its argument to be an int,
5727  * but also beware since this evaluates its argument twice, so no x++. */
5728 #define PERL_ABS(x) ((x) < 0 ? -(x) : (x))
5729
5730 #if defined(__DECC) && defined(__osf__)
5731 #pragma message disable (mainparm) /* Perl uses the envp in main(). */
5732 #endif
5733
5734 #define do_open(g, n, l, a, rm, rp, sf) \
5735         do_openn(g, n, l, a, rm, rp, sf, (SV **) NULL, 0)
5736 #ifdef PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
5737 #  define do_exec(cmd)                  do_exec3(cmd,0,0)
5738 #endif
5739 #ifdef OS2
5740 #  define do_aexec                      Perl_do_aexec
5741 #else
5742 #  define do_aexec(really, mark,sp)     do_aexec5(really, mark, sp, 0, 0)
5743 #endif
5744
5745 #if defined(OEMVS)
5746 #define NO_ENV_ARRAY_IN_MAIN
5747 #endif
5748
5749 /* These are used by Perl_pv_escape() and Perl_pv_pretty()
5750  * are here so that they are available throughout the core
5751  * NOTE that even though some are for _escape and some for _pretty
5752  * there must not be any clashes as the flags from _pretty are
5753  * passed straight through to _escape.
5754  */
5755
5756 #define PERL_PV_ESCAPE_QUOTE        0x0001
5757 #define PERL_PV_PRETTY_QUOTE        PERL_PV_ESCAPE_QUOTE
5758
5759 #define PERL_PV_PRETTY_ELLIPSES     0x0002
5760 #define PERL_PV_PRETTY_LTGT         0x0004
5761
5762 #define PERL_PV_ESCAPE_FIRSTCHAR    0x0008
5763
5764 #define PERL_PV_ESCAPE_UNI          0x0100
5765 #define PERL_PV_ESCAPE_UNI_DETECT   0x0200
5766 #define PERL_PV_ESCAPE_NONASCII     0x0400
5767
5768 #define PERL_PV_ESCAPE_ALL          0x1000
5769 #define PERL_PV_ESCAPE_NOBACKSLASH  0x2000
5770 #define PERL_PV_ESCAPE_NOCLEAR      0x4000
5771 #define PERL_PV_ESCAPE_RE           0x8000
5772
5773 #define PERL_PV_PRETTY_NOCLEAR      PERL_PV_ESCAPE_NOCLEAR
5774
5775 /* used by pv_display in dump.c*/
5776 #define PERL_PV_PRETTY_DUMP  PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE
5777 #define PERL_PV_PRETTY_REGPROP PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_LTGT|PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII
5778
5779 /*
5780
5781    (KEEP THIS LAST IN perl.h!)
5782
5783    Mention
5784
5785    NV_PRESERVES_UV
5786
5787    HAS_MKSTEMP
5788    HAS_MKSTEMPS
5789    HAS_MKDTEMP
5790
5791    HAS_GETCWD
5792
5793    HAS_MMAP
5794    HAS_MPROTECT
5795    HAS_MSYNC
5796    HAS_MADVISE
5797    HAS_MUNMAP
5798    I_SYSMMAN
5799    Mmap_t
5800
5801    NVef
5802    NVff
5803    NVgf
5804
5805    HAS_UALARM
5806    HAS_USLEEP
5807
5808    HAS_SETITIMER
5809    HAS_GETITIMER
5810
5811    HAS_SENDMSG
5812    HAS_RECVMSG
5813    HAS_READV
5814    HAS_WRITEV
5815    I_SYSUIO
5816    HAS_STRUCT_MSGHDR
5817    HAS_STRUCT_CMSGHDR
5818
5819    HAS_NL_LANGINFO
5820
5821    HAS_DIRFD
5822
5823    so that Configure picks them up.
5824
5825    (KEEP THIS LAST IN perl.h!)
5826
5827 */
5828
5829 #endif /* Include guard */
5830
5831 /*
5832  * Local variables:
5833  * c-indentation-style: bsd
5834  * c-basic-offset: 4
5835  * indent-tabs-mode: nil
5836  * End:
5837  *
5838  * ex: set ts=8 sts=4 sw=4 et:
5839  */