This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
GCC_DIAG_IGNORE needs to end with semicolon (inline.h).
[perl5.git] / perl.h
CommitLineData
a0d0e21e 1/* perl.h
a687059c 2 *
1129b882 3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
5cd3f21a 4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
a687059c 5 *
352d5a3a
LW
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.
8d063cd8 8 *
8d063cd8 9 */
d6376244 10
85e6fe83
LW
11#ifndef H_PERL
12#define H_PERL 1
8d063cd8 13
760ac839
LW
14#ifdef PERL_FOR_X2P
15/*
d460ef45 16 * This file is being used for x2p stuff.
760ac839 17 * Above symbol is defined via -D in 'x2p/Makefile.SH'
d460ef45 18 * Decouple x2p stuff from some of perls more extreme eccentricities.
760ac839 19 */
55497cff 20#undef MULTIPLICITY
760ac839
LW
21#undef USE_STDIO
22#define USE_STDIO
23#endif /* PERL_FOR_X2P */
24
d460ef45 25#ifdef PERL_MICRO
12ae5dfc
JH
26# include "uconfig.h"
27#else
611cf957 28# include "config.h"
12ae5dfc 29#endif
0cb96387 30
2c2d71f5
JH
31/* See L<perlguts/"The Perl API"> for detailed notes on
32 * PERL_IMPLICIT_CONTEXT and PERL_IMPLICIT_SYS */
33
ac6bedea
JH
34/* Note that from here --> to <-- the same logic is
35 * repeated in makedef.pl, so be certain to update
36 * both places when editing. */
37
6f4183fe 38#ifdef USE_ITHREADS
acfe0abc 39# if !defined(MULTIPLICITY)
6f4183fe
GS
40# define MULTIPLICITY
41# endif
42#endif
43
27da23d5
JH
44#ifdef PERL_GLOBAL_STRUCT_PRIVATE
45# ifndef PERL_GLOBAL_STRUCT
46# define PERL_GLOBAL_STRUCT
47# endif
48#endif
97aff369 49
27da23d5
JH
50#ifdef PERL_GLOBAL_STRUCT
51# ifndef MULTIPLICITY
52# define MULTIPLICITY
53# endif
54#endif
55
97aff369
JH
56#ifdef MULTIPLICITY
57# ifndef PERL_IMPLICIT_CONTEXT
58# define PERL_IMPLICIT_CONTEXT
59# endif
60#endif
61
026fd48b
GH
62/* undef WIN32 when building on Cygwin (for libwin32) - gph */
63#ifdef __CYGWIN__
64# undef WIN32
65# undef _WIN32
66#endif
67
27da23d5
JH
68#if defined(__SYMBIAN32__) || (defined(__VC32__) && defined(WINS))
69# ifndef SYMBIAN
70# define SYMBIAN
71# endif
72#endif
73
a0fd4948 74#ifdef __SYMBIAN32__
27da23d5
JH
75# include "symbian/symbian_proto.h"
76#endif
77
78/* Any stack-challenged places. The limit varies (and often
79 * is configurable), but using more than a kilobyte of stack
80 * is usually dubious in these systems. */
739a0b84
NC
81#if defined(__SYMBIAN32__)
82/* Symbian: need to work around the SDK features. *
27da23d5
JH
83 * On WINS: MS VC5 generates calls to _chkstk, *
84 * if a "large" stack frame is allocated. *
85 * gcc on MARM does not generate calls like these. */
86# define USE_HEAP_INSTEAD_OF_STACK
87#endif
88
dd134d2c 89/* Use the reentrant APIs like localtime_r and getpwent_r */
10bc17b6 90/* Win32 has naturally threadsafe libraries, no need to use any _r variants. */
6239f2da 91#if defined(USE_ITHREADS) && !defined(USE_REENTRANT_API) && !defined(NETWARE) && !defined(WIN32) && !defined(PERL_DARWIN)
10bc17b6
JH
92# define USE_REENTRANT_API
93#endif
94
ac6bedea
JH
95/* <--- here ends the logic shared by perl.h and makedef.pl */
96
9ea40801
SH
97/* Microsoft Visual C++ 6.0 needs special treatment in numerous places */
98#if defined(WIN32) && defined(_MSC_VER) && _MSC_VER >= 1200 && _MSC_VER < 1300
99# define USING_MSVC6
100#endif
101
cf5a8da6
MHM
102#undef START_EXTERN_C
103#undef END_EXTERN_C
104#undef EXTERN_C
105#ifdef __cplusplus
106# define START_EXTERN_C extern "C" {
107# define END_EXTERN_C }
108# define EXTERN_C extern "C"
109#else
110# define START_EXTERN_C
111# define END_EXTERN_C
112# define EXTERN_C extern
113#endif
114
17a6c8e3
AD
115/* Fallback definitions in case we don't have definitions from config.h.
116 This should only matter for systems that don't use Configure and
117 haven't been modified to define PERL_STATIC_INLINE yet.
118*/
119#if !defined(PERL_STATIC_INLINE)
120# ifdef HAS_STATIC_INLINE
121# define PERL_STATIC_INLINE static inline
122# else
123# define PERL_STATIC_INLINE static
124# endif
125#endif
126
27da23d5
JH
127#ifdef PERL_GLOBAL_STRUCT
128# ifndef PERL_GET_VARS
129# ifdef PERL_GLOBAL_STRUCT_PRIVATE
cf5a8da6 130 EXTERN_C struct perl_vars* Perl_GetVarsPrivate();
27da23d5
JH
131# define PERL_GET_VARS() Perl_GetVarsPrivate() /* see miniperlmain.c */
132# ifndef PERLIO_FUNCS_CONST
133# define PERLIO_FUNCS_CONST /* Can't have these lying around. */
134# endif
135# else
136# define PERL_GET_VARS() PL_VarsPtr
137# endif
138# endif
139#endif
140
5aaab254 141#define pVAR struct perl_vars* my_vars PERL_UNUSED_DECL
27da23d5
JH
142
143#ifdef PERL_GLOBAL_STRUCT
144# define dVAR pVAR = (struct perl_vars*)PERL_GET_VARS()
145#else
146# define dVAR dNOOP
147#endif
148
c5be433b 149#ifdef PERL_IMPLICIT_CONTEXT
3db8f154
MB
150# ifndef MULTIPLICITY
151# define MULTIPLICITY
c5be433b 152# endif
e8dda941 153# define tTHX PerlInterpreter*
5aaab254 154# define pTHX tTHX my_perl PERL_UNUSED_DECL
3db8f154 155# define aTHX my_perl
9399a70c 156# define aTHXa(a) aTHX = (tTHX)a
27da23d5 157# ifdef PERL_GLOBAL_STRUCT
e8dda941 158# define dTHXa(a) dVAR; pTHX = (tTHX)a
27da23d5 159# else
e8dda941 160# define dTHXa(a) pTHX = (tTHX)a
27da23d5
JH
161# endif
162# ifdef PERL_GLOBAL_STRUCT
163# define dTHX dVAR; pTHX = PERL_GET_THX
164# else
165# define dTHX pTHX = PERL_GET_THX
166# endif
c5be433b 167# define pTHX_ pTHX,
c5be433b 168# define aTHX_ aTHX,
4373e329 169# define pTHX_1 2
894356b3
GS
170# define pTHX_2 3
171# define pTHX_3 4
172# define pTHX_4 5
4373e329
AL
173# define pTHX_5 6
174# define pTHX_6 7
a3b680e6
AL
175# define pTHX_7 8
176# define pTHX_8 9
177# define pTHX_9 10
a6fc70e5 178# define pTHX_12 13
e8dda941
JD
179# if defined(DEBUGGING) && !defined(PERL_TRACK_MEMPOOL)
180# define PERL_TRACK_MEMPOOL
181# endif
182#else
183# undef PERL_TRACK_MEMPOOL
c5be433b
GS
184#endif
185
76e3520e 186#define STATIC static
16c91539
BM
187
188#ifndef PERL_CORE
189/* Do not use these macros. They were part of PERL_OBJECT, which was an
190 * implementation of multiplicity using C++ objects. They have been left
191 * here solely for the sake of XS code which has incorrectly
192 * cargo-culted them.
193 */
76e3520e 194#define CPERLscope(x) x
565764a8 195#define CPERLarg void
76e3520e 196#define CPERLarg_
e3b8966e 197#define _CPERLarg
1d583055
GS
198#define PERL_OBJECT_THIS
199#define _PERL_OBJECT_THIS
200#define PERL_OBJECT_THIS_
312caa8e 201#define CALL_FPTR(fptr) (*fptr)
ef69c8fc 202#define MEMBER_TO_FPTR(name) name
16c91539 203#endif /* !PERL_CORE */
76e3520e 204
16c91539 205#define CALLRUNOPS PL_runops
f9f4320a 206
3ab4a224 207#define CALLREGCOMP(sv, flags) Perl_pregcomp(aTHX_ (sv),(flags))
f9f4320a 208
16c91539 209#define CALLREGCOMP_ENG(prog, sv, flags) (prog)->comp(aTHX_ sv, flags)
a340edde 210#define CALLREGEXEC(prog,stringarg,strend,strbeg,minend,sv,data,flags) \
16c91539 211 RX_ENGINE(prog)->exec(aTHX_ (prog),(stringarg),(strend), \
a340edde 212 (strbeg),(minend),(sv),(data),(flags))
52a21eb3
DM
213#define CALLREG_INTUIT_START(prog,sv,strbeg,strpos,strend,flags,data) \
214 RX_ENGINE(prog)->intuit(aTHX_ (prog), (sv), (strbeg), (strpos), \
f9f4320a
YO
215 (strend),(flags),(data))
216#define CALLREG_INTUIT_STRING(prog) \
16c91539 217 RX_ENGINE(prog)->checkstr(aTHX_ (prog))
f8149455 218
f8149455
YO
219#define CALLREGFREE(prog) \
220 Perl_pregfree(aTHX_ (prog))
221
222#define CALLREGFREE_PVT(prog) \
16c91539 223 if(prog) RX_ENGINE(prog)->free(aTHX_ (prog))
f8149455 224
2fdbfb4d 225#define CALLREG_NUMBUF_FETCH(rx,paren,usesv) \
16c91539 226 RX_ENGINE(rx)->numbered_buff_FETCH(aTHX_ (rx),(paren),(usesv))
93b32b6d 227
2fdbfb4d 228#define CALLREG_NUMBUF_STORE(rx,paren,value) \
16c91539 229 RX_ENGINE(rx)->numbered_buff_STORE(aTHX_ (rx),(paren),(value))
2fdbfb4d
AB
230
231#define CALLREG_NUMBUF_LENGTH(rx,sv,paren) \
16c91539 232 RX_ENGINE(rx)->numbered_buff_LENGTH(aTHX_ (rx),(sv),(paren))
2fdbfb4d 233
192b9cd1 234#define CALLREG_NAMED_BUFF_FETCH(rx, key, flags) \
16c91539 235 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_FETCH))
192b9cd1
AB
236
237#define CALLREG_NAMED_BUFF_STORE(rx, key, value, flags) \
16c91539 238 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), (value), ((flags) | RXapif_STORE))
192b9cd1
AB
239
240#define CALLREG_NAMED_BUFF_DELETE(rx, key, flags) \
16c91539 241 RX_ENGINE(rx)->named_buff(aTHX_ (rx),(key), NULL, ((flags) | RXapif_DELETE))
192b9cd1
AB
242
243#define CALLREG_NAMED_BUFF_CLEAR(rx, flags) \
16c91539 244 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_CLEAR))
192b9cd1
AB
245
246#define CALLREG_NAMED_BUFF_EXISTS(rx, key, flags) \
16c91539 247 RX_ENGINE(rx)->named_buff(aTHX_ (rx), (key), NULL, ((flags) | RXapif_EXISTS))
192b9cd1
AB
248
249#define CALLREG_NAMED_BUFF_FIRSTKEY(rx, flags) \
16c91539 250 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), NULL, ((flags) | RXapif_FIRSTKEY))
192b9cd1
AB
251
252#define CALLREG_NAMED_BUFF_NEXTKEY(rx, lastkey, flags) \
16c91539 253 RX_ENGINE(rx)->named_buff_iter(aTHX_ (rx), (lastkey), ((flags) | RXapif_NEXTKEY))
192b9cd1
AB
254
255#define CALLREG_NAMED_BUFF_SCALAR(rx, flags) \
16c91539 256 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, ((flags) | RXapif_SCALAR))
192b9cd1
AB
257
258#define CALLREG_NAMED_BUFF_COUNT(rx) \
16c91539 259 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, RXapif_REGNAMES_COUNT)
192b9cd1
AB
260
261#define CALLREG_NAMED_BUFF_ALL(rx, flags) \
16c91539 262 RX_ENGINE(rx)->named_buff(aTHX_ (rx), NULL, NULL, flags)
93b32b6d 263
49d7dfbc 264#define CALLREG_PACKAGE(rx) \
16c91539 265 RX_ENGINE(rx)->qr_package(aTHX_ (rx))
93b32b6d 266
00f254e2 267#if defined(USE_ITHREADS)
f9f4320a 268#define CALLREGDUPE(prog,param) \
f8149455
YO
269 Perl_re_dup(aTHX_ (prog),(param))
270
271#define CALLREGDUPE_PVT(prog,param) \
16c91539 272 (prog ? RX_ENGINE(prog)->dupe(aTHX_ (prog),(param)) \
00f254e2 273 : (REGEXP *)NULL)
f9f4320a 274#endif
14dd3ad8 275
a20207d7 276
bcdf7404 277
a20207d7
YO
278
279
5ba4cab2
SH
280/*
281 * Because of backward compatibility reasons the PERL_UNUSED_DECL
282 * cannot be changed from postfix to PERL_UNUSED_DECL(x). Sigh.
283 *
284 * Note that there are C compilers such as MetroWerks CodeWarrior
1266ad8c 285 * which do not have an "inlined" way (like the gcc __attribute__) of
5ba4cab2
SH
286 * marking unused variables (they need e.g. a #pragma) and therefore
287 * cpp macros like PERL_UNUSED_DECL cannot work for this purpose, even
288 * if it were PERL_UNUSED_DECL(x), which it cannot be (see above).
289 *
290 */
1266ad8c 291
9969cdde 292#if defined(__SYMBIAN32__) && defined(__GNUC__)
5b2bd0a5 293# ifdef __cplusplus
5ba4cab2 294# define PERL_UNUSED_DECL
5b2bd0a5 295# else
5ba4cab2 296# define PERL_UNUSED_DECL __attribute__((unused))
5b2bd0a5
AMS
297# endif
298#endif
44dbb695 299
5b2bd0a5 300#ifndef PERL_UNUSED_DECL
34659ad4 301# if defined(HASATTRIBUTE_UNUSED) && !defined(__cplusplus)
5ba4cab2 302# define PERL_UNUSED_DECL __attribute__unused__
b79c357a 303# else
5ba4cab2 304# define PERL_UNUSED_DECL
b79c357a 305# endif
5b2bd0a5 306#endif
00f254e2 307
349b520e
DM
308/* gcc -Wall:
309 * for silencing unused variables that are actually used most of the time,
a0288114 310 * but we cannot quite get rid of, such as "ax" in PPCODE+noargs xsubs
349b520e 311 */
53c1dcc0 312#ifndef PERL_UNUSED_ARG
c99ffe5e 313# if defined(lint) && defined(S_SPLINT_S) /* www.splint.org */
ad73156c 314# include <note.h>
53c1dcc0 315# define PERL_UNUSED_ARG(x) NOTE(ARGUNUSED(x))
ad73156c 316# else
53c1dcc0 317# define PERL_UNUSED_ARG(x) ((void)x)
ad73156c
AL
318# endif
319#endif
53c1dcc0
AL
320#ifndef PERL_UNUSED_VAR
321# define PERL_UNUSED_VAR(x) ((void)x)
322#endif
ad73156c 323
96a5add6
AL
324#ifdef USE_ITHREADS
325# define PERL_UNUSED_CONTEXT PERL_UNUSED_ARG(my_perl)
326#else
327# define PERL_UNUSED_CONTEXT
328#endif
329
24e7ff4e
JH
330/* gcc (-ansi) -pedantic doesn't allow gcc statement expressions,
331 * g++ allows them but seems to have problems with them
332 * (insane errors ensue).
333 * g++ does not give insane errors now (RMB 2008-01-30, gcc 4.2.2).
334 */
335#if defined(PERL_GCC_PEDANTIC) || \
336 (defined(__GNUC__) && defined(__cplusplus) && \
337 ((__GNUC__ < 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2))))
338# ifndef PERL_GCC_BRACE_GROUPS_FORBIDDEN
339# define PERL_GCC_BRACE_GROUPS_FORBIDDEN
340# endif
341#endif
342
ffea512f 343/* Use PERL_UNUSED_RESULT() to suppress the warnings about unused results
b469f1e0
JH
344 * of function calls, e.g. PERL_UNUSED_RESULT(foo(a, b)).
345 *
346 * The main reason for this is that the combination of gcc -Wunused-result
347 * (part of -Wall) and the __attribute__((warn_unused_result)) cannot
348 * be silenced with casting to void. This causes trouble when the system
349 * header files use the attribute.
350 *
351 * Use PERL_UNUSED_RESULT sparingly, though, since usually the warning
352 * is there for a good reason: you might lose success/failure information,
353 * or leak resources, or changes in resources.
ffea512f
JH
354 *
355 * But sometimes you just want to ignore the return value, e.g. on
b469f1e0
JH
356 * codepaths soon ending up in abort, or in "best effort" attempts,
357 * or in situations where there is no good way to handle failures.
ffea512f 358 *
b469f1e0
JH
359 * Sometimes PERL_UNUSED_RESULT might not be the most natural way:
360 * another possibility is that you can capture the return value
361 * and use PERL_UNUSED_VAR on that.
ffea512f 362 *
b469f1e0
JH
363 * The __typeof__() is used instead of typeof() since typeof() is not
364 * available under strict C89, and because of compilers masquerading
365 * as gcc (clang and icc), we want exactly the gcc extension
366 * __typeof__ and nothing else.
ffea512f
JH
367 */
368#ifndef PERL_UNUSED_RESULT
b469f1e0
JH
369# if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
370# define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
ffea512f
JH
371# else
372# define PERL_UNUSED_RESULT(v) ((void)(v))
373# endif
374#endif
375
b56aac20
DM
376/* on gcc (and clang), specify that a warning should be temporarily
377 * ignored; e.g.
378 *
379 * GCC_DIAG_IGNORE(-Wmultichar);
380 * char b = 'ab';
381 * GCC_DIAG_RESTORE;
382 *
383 * based on http://dbp-consulting.com/tutorials/SuppressingGCCWarnings.html
384 *
385 * Note that "pragma GCC diagnostic push/pop" was added in GCC 4.6, Mar 2011;
386 * clang only pretends to be GCC 4.2, but still supports push/pop.
387 */
388
57d4b8c5 389#if defined(__clang__) || defined(__clang) || \
d28ce8b4 390 (defined( __GNUC__) && ((__GNUC__ * 100) + __GNUC_MINOR__) >= 406)
b56aac20
DM
391# define GCC_DIAG_DO_PRAGMA_(x) _Pragma (#x)
392
393# define GCC_DIAG_IGNORE(x) _Pragma("GCC diagnostic push") \
394 GCC_DIAG_DO_PRAGMA_(GCC diagnostic ignored #x)
395# define GCC_DIAG_RESTORE _Pragma("GCC diagnostic pop")
396#else
a3ccabca
JH
397# define GCC_DIAG_IGNORE(w) dNOOP
398# define GCC_DIAG_RESTORE dNOOP
b56aac20
DM
399#endif
400
6f207bd3 401#define NOOP /*EMPTY*/(void)0
bafdc25d
NC
402/* cea2e8a9dd23747f accidentally lost the comment originally from the first
403 check in of thread.h, explaining why we need dNOOP at all: */
404/* Rats: if dTHR is just blank then the subsequent ";" throws an error */
405/* Declaring a *function*, instead of a variable, ensures that we don't rely
406 on being able to suppress "unused" warnings. */
7db66e12
CB
407#ifdef __cplusplus
408#define dNOOP (void)0
409#else
64a8239e 410#define dNOOP extern int Perl___notused(void)
7db66e12 411#endif
71be2cbc 412
0cb96387 413#ifndef pTHX
a78adc84 414/* Don't bother defining tTHX ; using it outside
e8dda941
JD
415 * code guarded by PERL_IMPLICIT_CONTEXT is an error.
416 */
0cb96387
GS
417# define pTHX void
418# define pTHX_
0cb96387
GS
419# define aTHX
420# define aTHX_
9399a70c 421# define aTHXa(a) NOOP
0cb96387
GS
422# define dTHXa(a) dNOOP
423# define dTHX dNOOP
894356b3
GS
424# define pTHX_1 1
425# define pTHX_2 2
426# define pTHX_3 3
427# define pTHX_4 4
3d42dc86
RGS
428# define pTHX_5 5
429# define pTHX_6 6
a3b680e6
AL
430# define pTHX_7 7
431# define pTHX_8 8
432# define pTHX_9 9
a6fc70e5 433# define pTHX_12 12
0cb96387
GS
434#endif
435
27da23d5
JH
436#ifndef dVAR
437# define dVAR dNOOP
438#endif
439
b4f7f263
GS
440/* these are only defined for compatibility; should not be used internally */
441#if !defined(pTHXo) && !defined(PERL_CORE)
0cb96387
GS
442# define pTHXo pTHX
443# define pTHXo_ pTHX_
0cb96387
GS
444# define aTHXo aTHX
445# define aTHXo_ aTHX_
c5be433b 446# define dTHXo dTHX
71d280e3 447# define dTHXoa(x) dTHXa(x)
0cb96387
GS
448#endif
449
450#ifndef pTHXx
5aaab254 451# define pTHXx PerlInterpreter *my_perl
0cb96387 452# define pTHXx_ pTHXx,
0cb96387
GS
453# define aTHXx my_perl
454# define aTHXx_ aTHXx,
c5be433b 455# define dTHXx dTHX
22c35a8c 456#endif
71be2cbc 457
1de7c2ac
GS
458/* Under PERL_IMPLICIT_SYS (used in Windows for fork emulation)
459 * PerlIO_foo() expands to PL_StdIO->pFOO(PL_StdIO, ...).
460 * dTHXs is therefore needed for all functions using PerlIO_foo(). */
461#ifdef PERL_IMPLICIT_SYS
27da23d5
JH
462# ifdef PERL_GLOBAL_STRUCT_PRIVATE
463# define dTHXs dVAR; dTHX
464# else
465# define dTHXs dTHX
466# endif
1de7c2ac 467#else
27da23d5
JH
468# ifdef PERL_GLOBAL_STRUCT_PRIVATE
469# define dTHXs dVAR
470# else
471# define dTHXs dNOOP
472# endif
1de7c2ac
GS
473#endif
474
27da23d5
JH
475/* Some platforms require marking function declarations
476 * for them to be exportable. Used in perlio.h, proto.h
477 * is handled either by the makedef.pl or by defining the
478 * PERL_CALLCONV to be something special. See also the
479 * definition of XS() in XSUB.h. */
480#ifndef PERL_EXPORT_C
a0c21aa1
JH
481# ifdef __cplusplus
482# define PERL_EXPORT_C extern "C"
483# else
484# define PERL_EXPORT_C extern
485# endif
27da23d5
JH
486#endif
487#ifndef PERL_XS_EXPORT_C
a0c21aa1
JH
488# ifdef __cplusplus
489# define PERL_XS_EXPORT_C extern "C"
490# else
491# define PERL_XS_EXPORT_C
492# endif
27da23d5
JH
493#endif
494
5b692037
JH
495#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) && !defined(__cplusplus)
496# ifndef PERL_USE_GCC_BRACE_GROUPS
497# define PERL_USE_GCC_BRACE_GROUPS
498# endif
499#endif
500
728e2803
PP
501/*
502 * STMT_START { statements; } STMT_END;
503 * can be used as a single statement, as in
504 * if (x) STMT_START { ... } STMT_END; else ...
505 *
506 * Trying to select a version that gives no warnings...
507 */
508#if !(defined(STMT_START) && defined(STMT_END))
5b692037 509# ifdef PERL_USE_GCC_BRACE_GROUPS
a0288114 510# define STMT_START (void)( /* gcc supports "({ STATEMENTS; })" */
728e2803
PP
511# define STMT_END )
512# else
728e2803
PP
513# define STMT_START do
514# define STMT_END while (0)
728e2803
PP
515# endif
516#endif
517
d6f9c181
JH
518#ifndef BYTEORDER /* Should never happen -- byteorder is in config.h */
519# define BYTEORDER 0x1234
79072805
LW
520#endif
521
522/* Overall memory policy? */
523#ifndef CONSERVATIVE
524# define LIBERAL 1
525#endif
526
8ada0baa
JH
527#if 'A' == 65 && 'I' == 73 && 'J' == 74 && 'Z' == 90
528#define ASCIIish
529#else
530#undef ASCIIish
531#endif
532
79072805
LW
533/*
534 * The following contortions are brought to you on behalf of all the
535 * standards, semi-standards, de facto standards, not-so-de-facto standards
536 * of the world, as well as all the other botches anyone ever thought of.
537 * The basic theory is that if we work hard enough here, the rest of the
538 * code can be a lot prettier. Well, so much for theory. Sorry, Henry...
539 */
ac58e20f 540
ee0007ab 541/* define this once if either system, instead of cluttering up the src */
7c458fae 542#if defined(MSDOS) || defined(WIN32) || defined(NETWARE)
ee0007ab
LW
543#define DOSISH 1
544#endif
545
739a0b84 546#if defined(__STDC__) || defined(_AIX) || defined(__stdc__) || defined(__cplusplus) || defined(NETWARE) || defined(__SYMBIAN32__)
352d5a3a
LW
547# define STANDARD_C 1
548#endif
549
8d87852b 550#if defined(__cplusplus) || defined(WIN32) || defined(__sgi) || defined(__EMX__) || defined(__QNX__) || defined(NETWARE) || defined(PERL_MICRO)
68dc0745
PP
551# define DONT_DECLARE_STD 1
552#endif
553
352d5a3a 554#if defined(HASVOLATILE) || defined(STANDARD_C)
79072805 555# define VOL volatile
663a0e37 556#else
79072805 557# define VOL
663a0e37
LW
558#endif
559
284167a5
SM
560/* By compiling a perl with -DNO_TAINT_SUPPORT or -DSILENT_NO_TAINT_SUPPORT,
561 * you get a perl without taint support, but doubtlessly with a lesser
562 * degree of support. Do not do so unless you know exactly what it means
563 * technically, have a good reason to do so, and know exactly how the
564 * perl will be used. perls with -DSILENT_NO_TAINT_SUPPORT are considered
565 * a potential security risk due to flat out ignoring the security-relevant
566 * taint flags. This being said, a perl without taint support compiled in
567 * has marginal run-time performance benefits.
568 * SILENT_NO_TAINT_SUPPORT implies NO_TAINT_SUPPORT.
569 * SILENT_NO_TAINT_SUPPORT is the same as NO_TAINT_SUPPORT except it
570 * silently ignores -t/-T instead of throwing an exception.
053a3618
SM
571 *
572 * DANGER! Using NO_TAINT_SUPPORT or SILENT_NO_TAINT_SUPPORT
6ecb40c7 573 * voids your nonexistent warranty!
284167a5 574 */
dc6d7f5c 575#if defined(SILENT_NO_TAINT_SUPPORT) && !defined(NO_TAINT_SUPPORT)
284167a5
SM
576# define NO_TAINT_SUPPORT 1
577#endif
578
579/* NO_TAINT_SUPPORT can be set to transform virtually all taint-related
580 * operations into no-ops for a very modest speed-up. Enable only if you
581 * know what you're doing: tests and CPAN modules' tests are bound to fail.
582 */
dc6d7f5c 583#ifdef NO_TAINT_SUPPORT
284167a5
SM
584# define TAINT NOOP
585# define TAINT_NOT NOOP
586# define TAINT_IF(c) NOOP
587# define TAINT_ENV() NOOP
588# define TAINT_PROPER(s) NOOP
589# define TAINT_set(s) NOOP
590# define TAINT_get 0
591# define TAINTING_get 0
592# define TAINTING_set(s) NOOP
593# define TAINT_WARN_get 0
594# define TAINT_WARN_set(s) NOOP
595#else
596# define TAINT (PL_tainted = TRUE)
597# define TAINT_NOT (PL_tainted = FALSE)
2439e033
SM
598# define TAINT_IF(c) if (UNLIKELY(c)) { PL_tainted = TRUE; }
599# define TAINT_ENV() if (UNLIKELY(PL_tainting)) { taint_env(); }
600# define TAINT_PROPER(s) if (UNLIKELY(PL_tainting)) { taint_proper(NULL, s); }
284167a5
SM
601# define TAINT_set(s) (PL_tainted = (s))
602# define TAINT_get (PL_tainted)
603# define TAINTING_get (PL_tainting)
604# define TAINTING_set(s) (PL_tainting = (s))
605# define TAINT_WARN_get (PL_taint_warn)
606# define TAINT_WARN_set(s) (PL_taint_warn = (s))
607#endif
a687059c 608
20be6587
DM
609/* flags used internally only within pp_subst and pp_substcont */
610#ifdef PERL_CORE
611# define SUBST_TAINT_STR 1 /* string tainted */
612# define SUBST_TAINT_PAT 2 /* pattern tainted */
613# define SUBST_TAINT_REPL 4 /* replacement tainted */
614# define SUBST_TAINT_RETAINT 8 /* use re'taint' in scope */
615# define SUBST_TAINT_BOOLRET 16 /* return is boolean (don't taint) */
616#endif
617
d460ef45 618/* XXX All process group stuff is handled in pp_sys.c. Should these
a6e633de
PP
619 defines move there? If so, I could simplify this a lot. --AD 9/96.
620*/
621/* Process group stuff changed from traditional BSD to POSIX.
622 perlfunc.pod documents the traditional BSD-style syntax, so we'll
623 try to preserve that, if possible.
624*/
625#ifdef HAS_SETPGID
626# define BSD_SETPGRP(pid, pgrp) setpgid((pid), (pgrp))
c07a80fd 627#else
a6e633de
PP
628# if defined(HAS_SETPGRP) && defined(USE_BSD_SETPGRP)
629# define BSD_SETPGRP(pid, pgrp) setpgrp((pid), (pgrp))
630# else
631# ifdef HAS_SETPGRP2 /* DG/UX */
632# define BSD_SETPGRP(pid, pgrp) setpgrp2((pid), (pgrp))
633# endif
634# endif
635#endif
636#if defined(BSD_SETPGRP) && !defined(HAS_SETPGRP)
637# define HAS_SETPGRP /* Well, effectively it does . . . */
638#endif
639
640/* getpgid isn't POSIX, but at least Solaris and Linux have it, and it makes
641 our life easier :-) so we'll try it.
642*/
643#ifdef HAS_GETPGID
644# define BSD_GETPGRP(pid) getpgid((pid))
645#else
646# if defined(HAS_GETPGRP) && defined(USE_BSD_GETPGRP)
647# define BSD_GETPGRP(pid) getpgrp((pid))
648# else
649# ifdef HAS_GETPGRP2 /* DG/UX */
650# define BSD_GETPGRP(pid) getpgrp2((pid))
651# endif
652# endif
653#endif
654#if defined(BSD_GETPGRP) && !defined(HAS_GETPGRP)
655# define HAS_GETPGRP /* Well, effectively it does . . . */
656#endif
657
d460ef45 658/* These are not exact synonyms, since setpgrp() and getpgrp() may
a6e633de
PP
659 have different behaviors, but perl.h used to define USE_BSDPGRP
660 (prior to 5.003_05) so some extension might depend on it.
661*/
662#if defined(USE_BSD_SETPGRP) || defined(USE_BSD_GETPGRP)
663# ifndef USE_BSDPGRP
664# define USE_BSDPGRP
665# endif
663a0e37
LW
666#endif
667
486ec47a 668/* HP-UX 10.X CMA (Common Multithreaded Architecture) insists that
8ac5a1fe
MH
669 pthread.h must be included before all other header files.
670*/
3db8f154 671#if defined(USE_ITHREADS) && defined(PTHREAD_H_FIRST) && defined(I_PTHREAD)
8ac5a1fe
MH
672# include <pthread.h>
673#endif
674
58ab9e8b 675#include <sys/types.h>
663a0e37 676
760ac839
LW
677#ifdef __cplusplus
678# ifndef I_STDARG
679# define I_STDARG 1
680# endif
681#endif
682
683#ifdef I_STDARG
684# include <stdarg.h>
685#else
686# ifdef I_VARARGS
687# include <varargs.h>
688# endif
689#endif
690
fe14fcc3 691#include <ctype.h>
a0d0e21e
LW
692
693#ifdef METHOD /* Defined by OSF/1 v3.0 by ctype.h */
694#undef METHOD
a0d0e21e
LW
695#endif
696
12ae5dfc
JH
697#ifdef PERL_MICRO
698# define NO_LOCALE
699#endif
700
4633a7c4 701#ifdef I_LOCALE
36477c24 702# include <locale.h>
4633a7c4
LW
703#endif
704
36477c24
PP
705#if !defined(NO_LOCALE) && defined(HAS_SETLOCALE)
706# define USE_LOCALE
ccd65d51
KW
707# define HAS_SKIP_LOCALE_INIT /* Solely for XS code to test for this
708 capability */
36477c24
PP
709# if !defined(NO_LOCALE_COLLATE) && defined(LC_COLLATE) \
710 && defined(HAS_STRXFRM)
711# define USE_LOCALE_COLLATE
712# endif
713# if !defined(NO_LOCALE_CTYPE) && defined(LC_CTYPE)
714# define USE_LOCALE_CTYPE
715# endif
716# if !defined(NO_LOCALE_NUMERIC) && defined(LC_NUMERIC)
717# define USE_LOCALE_NUMERIC
718# endif
fa9b773e
KW
719# if !defined(NO_LOCALE_MESSAGES) && defined(LC_MESSAGES)
720# define USE_LOCALE_MESSAGES
721# endif
722# if !defined(NO_LOCALE_MONETARY) && defined(LC_MONETARY)
723# define USE_LOCALE_MONETARY
724# endif
b385bb4d
KW
725# ifndef WIN32 /* No wrapper except on Windows */
726# define my_setlocale(a,b) setlocale(a,b)
727# endif
36477c24 728#endif /* !NO_LOCALE && HAS_SETLOCALE */
a0d0e21e 729
fe14fcc3 730#include <setjmp.h>
79072805 731
a0d0e21e 732#ifdef I_SYS_PARAM
79072805
LW
733# ifdef PARAM_NEEDS_TYPES
734# include <sys/types.h>
735# endif
736# include <sys/param.h>
352d5a3a 737#endif
79072805 738
ce3470dc
AD
739/* On BSD-derived systems, <sys/param.h> defines BSD to a year-month
740 value something like 199306. This may be useful if no more-specific
741 feature test is available.
742*/
743#if defined(BSD)
744# ifndef BSDish
745# define BSDish
746# endif
747#endif
748
79072805 749/* Use all the "standard" definitions? */
a0d0e21e 750#if defined(STANDARD_C) && defined(I_STDLIB)
79072805 751# include <stdlib.h>
ff68c719 752#endif
03a14243 753
3f270f98
JH
754/* If this causes problems, set i_unistd=undef in the hint file. */
755#ifdef I_UNISTD
756# include <unistd.h>
757#endif
758
de8ca8af
NT
759/* for WCOREDUMP */
760#ifdef I_SYS_WAIT
761# include <sys/wait.h>
762#endif
763
9969cdde 764#ifdef __SYMBIAN32__
27da23d5
JH
765# undef _SC_ARG_MAX /* Symbian has _SC_ARG_MAX but no sysconf() */
766#endif
767
21e89b5f 768#if defined(HAS_SYSCALL) && !defined(HAS_SYSCALL_PROTO)
c45598c5 769EXTERN_C int syscall(int, ...);
2ef53570
JH
770#endif
771
21e89b5f 772#if defined(HAS_USLEEP) && !defined(HAS_USLEEP_PROTO)
c45598c5 773EXTERN_C int usleep(unsigned int);
2ef53570
JH
774#endif
775
1109a392
MHM
776#ifdef PERL_CORE
777
778/* macros for correct constant construction */
779# if INTSIZE >= 2
780# define U16_CONST(x) ((U16)x##U)
781# else
782# define U16_CONST(x) ((U16)x##UL)
783# endif
784
785# if INTSIZE >= 4
786# define U32_CONST(x) ((U32)x##U)
787# else
788# define U32_CONST(x) ((U32)x##UL)
789# endif
790
791# ifdef HAS_QUAD
792# if INTSIZE >= 8
793# define U64_CONST(x) ((U64)x##U)
794# elif LONGSIZE >= 8
795# define U64_CONST(x) ((U64)x##UL)
796# elif QUADKIND == QUAD_IS_LONG_LONG
797# define U64_CONST(x) ((U64)x##ULL)
52865553
SH
798# elif QUADKIND == QUAD_IS___INT64
799# define U64_CONST(x) ((U64)x##UI64)
1109a392
MHM
800# else /* best guess we can make */
801# define U64_CONST(x) ((U64)x##UL)
802# endif
803# endif
804
805/* byte-swapping functions for big-/little-endian conversion */
806# define _swab_16_(x) ((U16)( \
807 (((U16)(x) & U16_CONST(0x00ff)) << 8) | \
808 (((U16)(x) & U16_CONST(0xff00)) >> 8) ))
809
810# define _swab_32_(x) ((U32)( \
811 (((U32)(x) & U32_CONST(0x000000ff)) << 24) | \
812 (((U32)(x) & U32_CONST(0x0000ff00)) << 8) | \
813 (((U32)(x) & U32_CONST(0x00ff0000)) >> 8) | \
814 (((U32)(x) & U32_CONST(0xff000000)) >> 24) ))
815
816# ifdef HAS_QUAD
817# define _swab_64_(x) ((U64)( \
818 (((U64)(x) & U64_CONST(0x00000000000000ff)) << 56) | \
819 (((U64)(x) & U64_CONST(0x000000000000ff00)) << 40) | \
820 (((U64)(x) & U64_CONST(0x0000000000ff0000)) << 24) | \
821 (((U64)(x) & U64_CONST(0x00000000ff000000)) << 8) | \
822 (((U64)(x) & U64_CONST(0x000000ff00000000)) >> 8) | \
823 (((U64)(x) & U64_CONST(0x0000ff0000000000)) >> 24) | \
824 (((U64)(x) & U64_CONST(0x00ff000000000000)) >> 40) | \
825 (((U64)(x) & U64_CONST(0xff00000000000000)) >> 56) ))
826# endif
827
9c17f24a
NC
828/* The old value was hard coded at 1008. (4096-16) seems to be a bit faster,
829 at least on FreeBSD. YMMV, so experiment. */
830#ifndef PERL_ARENA_SIZE
831#define PERL_ARENA_SIZE 4080
832#endif
833
ccb2c8b8 834/* Maximum level of recursion */
2b9dff67
RGS
835#ifndef PERL_SUB_DEPTH_WARN
836#define PERL_SUB_DEPTH_WARN 100
ccb2c8b8
RGS
837#endif
838
1109a392
MHM
839#endif /* PERL_CORE */
840
bdf3085f
NC
841/* We no longer default to creating a new SV for GvSV.
842 Do this before embed. */
843#ifndef PERL_CREATE_GVSV
7459f06b
NC
844# ifndef PERL_DONT_CREATE_GVSV
845# define PERL_DONT_CREATE_GVSV
846# endif
bdf3085f
NC
847#endif
848
ca0c25f6
NC
849#if !defined(HAS_WAITPID) && !defined(HAS_WAIT4) || defined(HAS_WAITPID_RUNTIME)
850#define PERL_USES_PL_PIDSTATUS
851#endif
852
739a0b84 853#if !defined(OS2) && !defined(WIN32) && !defined(DJGPP) && !defined(__SYMBIAN32__)
a62746fa
RGS
854#define PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
855#endif
856
c31fac66
GS
857#define MEM_SIZE Size_t
858
1936d2a7
NC
859/* Round all values passed to malloc up, by default to a multiple of
860 sizeof(size_t)
861*/
862#ifndef PERL_STRLEN_ROUNDUP_QUANTUM
863#define PERL_STRLEN_ROUNDUP_QUANTUM Size_t_size
864#endif
865
f1200559
WH
866/* sv_grow() will expand strings by at least a certain percentage of
867 the previously *used* length to avoid excessive calls to realloc().
868 The default is 25% of the current length.
869*/
870#ifndef PERL_STRLEN_EXPAND_SHIFT
871# define PERL_STRLEN_EXPAND_SHIFT 2
872#endif
873
3800c318 874#if defined(STANDARD_C) && defined(I_STDDEF) && !defined(PERL_GCC_PEDANTIC)
51371543
GS
875# include <stddef.h>
876# define STRUCT_OFFSET(s,m) offsetof(s,m)
877#else
878# define STRUCT_OFFSET(s,m) (Size_t)(&(((s *)0)->m))
d0b86e2f
BF
879#endif
880
881/* ptrdiff_t is C11, so undef it under pedantic builds */
882#ifdef PERL_GCC_PEDANTIC
883# undef HAS_PTRDIFF_T
51371543
GS
884#endif
885
9969cdde 886#ifndef __SYMBIAN32__
27da23d5
JH
887# if defined(I_STRING) || defined(__cplusplus)
888# include <string.h>
889# else
890# include <strings.h>
891# endif
51371543
GS
892#endif
893
55497cff
PP
894/* This comes after <stdlib.h> so we don't try to change the standard
895 * library prototypes; we'll use our own in proto.h instead. */
03a14243 896
4633a7c4 897#ifdef MYMALLOC
86058a2d 898# ifdef PERL_POLLUTE_MALLOC
ee13e175 899# ifndef PERL_EXTMALLOC_DEF
86058a2d
GS
900# define Perl_malloc malloc
901# define Perl_calloc calloc
902# define Perl_realloc realloc
903# define Perl_mfree free
ee13e175 904# endif
86058a2d
GS
905# else
906# define EMBEDMYMALLOC /* for compatibility */
907# endif
827e134a 908
651b9576
GS
909# define safemalloc Perl_malloc
910# define safecalloc Perl_calloc
911# define saferealloc Perl_realloc
912# define safefree Perl_mfree
22f7c9c9
JH
913# define CHECK_MALLOC_TOO_LATE_FOR_(code) STMT_START { \
914 if (!PL_tainting && MallocCfg_ptr[MallocCfg_cfg_env_read]) \
915 code; \
916 } STMT_END
917# define CHECK_MALLOC_TOO_LATE_FOR(ch) \
918 CHECK_MALLOC_TOO_LATE_FOR_(MALLOC_TOO_LATE_FOR(ch))
919# define panic_write2(s) write(2, s, strlen(s))
920# define CHECK_MALLOC_TAINT(newval) \
921 CHECK_MALLOC_TOO_LATE_FOR_( \
922 if (newval) { \
acfd4d8e 923 PERL_UNUSED_RESULT(panic_write2("panic: tainting with $ENV{PERL_MALLOC_OPT}\n"));\
22f7c9c9 924 exit(1); })
22f7c9c9 925# define MALLOC_CHECK_TAINT(argc,argv,env) STMT_START { \
b0891165 926 if (doing_taint(argc,argv,env)) { \
22f7c9c9
JH
927 MallocCfg_ptr[MallocCfg_skip_cfg_env] = 1; \
928 }} STMT_END;
f2517201
GS
929#else /* MYMALLOC */
930# define safemalloc safesysmalloc
931# define safecalloc safesyscalloc
932# define saferealloc safesysrealloc
933# define safefree safesysfree
22f7c9c9
JH
934# define CHECK_MALLOC_TOO_LATE_FOR(ch) ((void)0)
935# define CHECK_MALLOC_TAINT(newval) ((void)0)
936# define MALLOC_CHECK_TAINT(argc,argv,env)
55497cff 937#endif /* MYMALLOC */
4633a7c4 938
fe13d51d 939/* diag_listed_as: "-T" is on the #! line, it must also be used on the command line */
27da23d5 940#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)
22f7c9c9
JH
941#define TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, "")
942#define MALLOC_TOO_LATE_FOR(ch) TOO_LATE_FOR_(ch, " with $ENV{PERL_MALLOC_OPT}")
943#define MALLOC_CHECK_TAINT2(argc,argv) MALLOC_CHECK_TAINT(argc,argv,NULL)
944
a0d0e21e
LW
945#if !defined(HAS_STRCHR) && defined(HAS_INDEX) && !defined(strchr)
946#define strchr index
947#define strrchr rindex
948#endif
949
16d20bd9
AD
950#ifdef I_MEMORY
951# include <memory.h>
952#endif
953
fe14fcc3 954#ifdef HAS_MEMCPY
85e6fe83 955# if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
fe14fcc3 956# ifndef memcpy
20ce7b12 957 extern char * memcpy (char*, char*, int);
ee0007ab
LW
958# endif
959# endif
960#else
961# ifndef memcpy
962# ifdef HAS_BCOPY
963# define memcpy(d,s,l) bcopy(s,d,l)
964# else
965# define memcpy(d,s,l) my_bcopy(s,d,l)
966# endif
967# endif
968#endif /* HAS_MEMCPY */
fe14fcc3 969
ee0007ab 970#ifdef HAS_MEMSET
85e6fe83 971# if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
ee0007ab 972# ifndef memset
20ce7b12 973 extern char *memset (char*, int, int);
ee0007ab
LW
974# endif
975# endif
ee0007ab 976#else
12ae5dfc 977# undef memset
fc36a67e 978# define memset(d,c,l) my_memset(d,c,l)
ee0007ab
LW
979#endif /* HAS_MEMSET */
980
85e6fe83 981#if !defined(HAS_MEMMOVE) && !defined(memmove)
2304df62 982# if defined(HAS_BCOPY) && defined(HAS_SAFE_BCOPY)
79072805
LW
983# define memmove(d,s,l) bcopy(s,d,l)
984# else
2304df62 985# if defined(HAS_MEMCPY) && defined(HAS_SAFE_MEMCPY)
79072805 986# define memmove(d,s,l) memcpy(d,s,l)
ee0007ab 987# else
79072805 988# define memmove(d,s,l) my_bcopy(s,d,l)
ee0007ab 989# endif
352d5a3a 990# endif
d9d8d8de 991#endif
ee0007ab 992
36477c24
PP
993#if defined(mips) && defined(ultrix) && !defined(__STDC__)
994# undef HAS_MEMCMP
995#endif
996
997#if defined(HAS_MEMCMP) && defined(HAS_SANE_MEMCMP)
85e6fe83 998# if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
ee0007ab 999# ifndef memcmp
20ce7b12 1000 extern int memcmp (char*, char*, int);
ee0007ab
LW
1001# endif
1002# endif
1003#else
1004# ifndef memcmp
ecfc5424 1005# define memcmp my_memcmp
352d5a3a 1006# endif
36477c24 1007#endif /* HAS_MEMCMP && HAS_SANE_MEMCMP */
8d063cd8 1008
fc36a67e 1009#ifndef memzero
c635e13b
PP
1010# ifdef HAS_MEMSET
1011# define memzero(d,l) memset(d,0,l)
79072805 1012# else
c635e13b
PP
1013# ifdef HAS_BZERO
1014# define memzero(d,l) bzero(d,l)
79072805 1015# else
fc36a67e 1016# define memzero(d,l) my_bzero(d,l)
79072805
LW
1017# endif
1018# endif
d9d8d8de 1019#endif
378cc40b 1020
2f42fcb0 1021#ifndef PERL_MICRO
0f27ced1
JH
1022#ifndef memchr
1023# ifndef HAS_MEMCHR
1024# define memchr(s,c,n) ninstr((char*)(s), ((char*)(s)) + n, &(c), &(c) + 1)
1025# endif
1026#endif
2f42fcb0 1027#endif
0f27ced1 1028
36477c24
PP
1029#ifndef HAS_BCMP
1030# ifndef bcmp
1031# define bcmp(s1,s2,l) memcmp(s1,s2,l)
79072805 1032# endif
36477c24 1033#endif /* !HAS_BCMP */
378cc40b 1034
ae986130 1035#ifdef I_NETINET_IN
79072805 1036# include <netinet/in.h>
ae986130
LW
1037#endif
1038
28e8609d
JH
1039#ifdef I_ARPA_INET
1040# include <arpa/inet.h>
1041#endif
1042
1aef975c 1043#ifdef I_SYS_STAT
84902520 1044# include <sys/stat.h>
1aef975c 1045#endif
79072805 1046
287a962e
JD
1047/* Microsoft VC's sys/stat.h defines all S_Ixxx macros except S_IFIFO.
1048 This definition should ideally go into win32/win32.h, but S_IFIFO is
1049 used later here in perl.h before win32/win32.h is being included. */
1050#if !defined(S_IFIFO) && defined(_S_IFIFO)
1051# define S_IFIFO _S_IFIFO
1052#endif
1053
cc3315ba 1054/* The stat macros for Unisoft System V/88 (and derivatives
a0d0e21e
LW
1055 like UTekV) are broken, sometimes giving false positives. Undefine
1056 them here and let the code below set them to proper values.
1057
1058 The ghs macro stands for GreenHills Software C-1.8.5 which
1059 is the C compiler for sysV88 and the various derivatives.
1060 This header file bug is corrected in gcc-2.5.8 and later versions.
1061 --Kaveh Ghazi (ghazi@noc.rutgers.edu) 10/3/94. */
1062
cc3315ba 1063#if defined(m88k) && defined(ghs)
79072805
LW
1064# undef S_ISDIR
1065# undef S_ISCHR
1066# undef S_ISBLK
1067# undef S_ISREG
1068# undef S_ISFIFO
1069# undef S_ISLNK
ee0007ab 1070#endif
135863df 1071
663a0e37
LW
1072#ifdef I_TIME
1073# include <time.h>
ffed7fef 1074#endif
663a0e37 1075
fe14fcc3 1076#ifdef I_SYS_TIME
85e6fe83 1077# ifdef I_SYS_TIME_KERNEL
663a0e37
LW
1078# define KERNEL
1079# endif
1080# include <sys/time.h>
85e6fe83 1081# ifdef I_SYS_TIME_KERNEL
663a0e37
LW
1082# undef KERNEL
1083# endif
a687059c 1084#endif
135863df 1085
55497cff 1086#if defined(HAS_TIMES) && defined(I_SYS_TIMES)
85e6fe83 1087# include <sys/times.h>
d9d8d8de 1088#endif
8d063cd8 1089
fe14fcc3 1090#if defined(HAS_STRERROR) && (!defined(HAS_MKDIR) || !defined(HAS_RMDIR))
79072805 1091# undef HAS_STRERROR
663a0e37
LW
1092#endif
1093
1094#include <errno.h>
1e743fda 1095
acfe0abc 1096#if defined(WIN32) && defined(PERL_IMPLICIT_SYS)
b4748376
NIS
1097# define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
1098#endif
1099
8cfab5ff 1100/* In Tru64 use the 4.4BSD struct msghdr, not the 4.3 one.
00f254e2 1101 * This is important for using IPv6.
8cfab5ff
JH
1102 * For OSF/1 3.2, however, defining _SOCKADDR_LEN would be
1103 * a bad idea since it breaks send() and recv(). */
1104#if defined(__osf__) && defined(__alpha) && !defined(_SOCKADDR_LEN) && !defined(DEC_OSF1_3_X)
1105# define _SOCKADDR_LEN
1106#endif
1107
da70cfc6 1108#if defined(HAS_SOCKET) && !defined(WIN32) /* WIN32 handles sockets via win32.h */
1e743fda
JH
1109# include <sys/socket.h>
1110# if defined(USE_SOCKS) && defined(I_SOCKS)
1111# if !defined(INCLUDE_PROTOTYPES)
1112# define INCLUDE_PROTOTYPES /* for <socks.h> */
1113# define PERL_SOCKS_NEED_PROTOTYPES
1114# endif
1115# include <socks.h>
1116# ifdef PERL_SOCKS_NEED_PROTOTYPES /* keep cpp space clean */
1117# undef INCLUDE_PROTOTYPES
1118# undef PERL_SOCKS_NEED_PROTOTYPES
ed6116ce 1119# endif
d460ef45 1120# endif
1e743fda 1121# ifdef I_NETDB
2986a63f
JH
1122# ifdef NETWARE
1123# include<stdio.h>
1124# endif
1e743fda
JH
1125# include <netdb.h>
1126# endif
1127# ifndef ENOTSOCK
1128# ifdef I_NET_ERRNO
1129# include <net/errno.h>
1130# endif
1131# endif
1132#endif
1133
fa0a29af 1134/* sockatmark() is so new (2001) that many places might have it hidden
29820b6d
MHM
1135 * behind some -D_BLAH_BLAH_SOURCE guard. The __THROW magic is required
1136 * e.g. in Gentoo, see http://bugs.gentoo.org/show_bug.cgi?id=12605 */
fa0a29af 1137#if defined(HAS_SOCKATMARK) && !defined(HAS_SOCKATMARK_PROTO)
29820b6d
MHM
1138# if defined(__THROW) && defined(__GLIBC__)
1139int sockatmark(int) __THROW;
1140# else
2ef53570 1141int sockatmark(int);
29820b6d 1142# endif
2ef53570
JH
1143#endif
1144
7e827271 1145#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. */
45d3b546
JH
1146EXTERN_C int fchdir(int);
1147EXTERN_C int flock(int, int);
1148EXTERN_C int fseeko(FILE *, off_t, int);
1149EXTERN_C off_t ftello(FILE *);
1150#endif
1151
7e827271 1152#if defined(__SUNPRO_CC) /* SUNWspro CC (C++) */
1ccb7c8d 1153EXTERN_C char *crypt(const char *, const char *);
7e827271 1154EXTERN_C char **environ;
1ccb7c8d
JH
1155#endif
1156
83a6ff2e 1157#if defined(__cplusplus)
ce3470dc 1158# if defined(BSDish)
b91fbb93 1159EXTERN_C char **environ;
83a6ff2e 1160# elif defined(__CYGWIN__)
667e2948
SP
1161EXTERN_C char *crypt(const char *, const char *);
1162#endif
83a6ff2e 1163#endif
667e2948 1164
1e743fda
JH
1165#ifdef SETERRNO
1166# undef SETERRNO /* SOCKS might have defined this */
ed6116ce 1167#endif
f86702cc
PP
1168
1169#ifdef VMS
1170# define SETERRNO(errcode,vmserrcode) \
1171 STMT_START { \
1172 set_errno(errcode); \
1173 set_vaxc_errno(vmserrcode); \
1174 } STMT_END
4ee39169
CS
1175# define dSAVEDERRNO int saved_errno; unsigned saved_vms_errno
1176# define dSAVE_ERRNO int saved_errno = errno; unsigned saved_vms_errno = vaxc$errno
1177# define SAVE_ERRNO ( saved_errno = errno, saved_vms_errno = vaxc$errno )
1178# define RESTORE_ERRNO SETERRNO(saved_errno, saved_vms_errno)
1179
93189314
JH
1180# define LIB_INVARG LIB$_INVARG
1181# define RMS_DIR RMS$_DIR
1182# define RMS_FAC RMS$_FAC
1183# define RMS_FEX RMS$_FEX
1184# define RMS_FNF RMS$_FNF
1185# define RMS_IFI RMS$_IFI
1186# define RMS_ISI RMS$_ISI
1187# define RMS_PRV RMS$_PRV
1188# define SS_ACCVIO SS$_ACCVIO
1189# define SS_DEVOFFLINE SS$_DEVOFFLINE
1190# define SS_IVCHAN SS$_IVCHAN
1191# define SS_NORMAL SS$_NORMAL
8a9f18be 1192# define SS_NOPRIV SS$_NOPRIV
748a9306 1193#else
93189314
JH
1194# define LIB_INVARG 0
1195# define RMS_DIR 0
1196# define RMS_FAC 0
1197# define RMS_FEX 0
1198# define RMS_FNF 0
1199# define RMS_IFI 0
1200# define RMS_ISI 0
1201# define RMS_PRV 0
1202# define SS_ACCVIO 0
1203# define SS_DEVOFFLINE 0
1204# define SS_IVCHAN 0
1205# define SS_NORMAL 0
8a9f18be 1206# define SS_NOPRIV 0
748a9306 1207#endif
ed6116ce 1208
6ca940a9
TC
1209#ifdef WIN32
1210# define dSAVEDERRNO int saved_errno; DWORD saved_win32_errno
1211# define dSAVE_ERRNO int saved_errno = errno; DWORD saved_win32_errno = GetLastError()
1212# define SAVE_ERRNO ( saved_errno = errno, saved_win32_errno = GetLastError() )
1213# define RESTORE_ERRNO ( errno = saved_errno, SetLastError(saved_win32_errno) )
1214#endif
1215
1216#ifdef OS2
1217# define dSAVEDERRNO int saved_errno; unsigned long saved_os2_errno
1218# define dSAVE_ERRNO int saved_errno = errno; unsigned long saved_os2_errno = Perl_rc
1219# define SAVE_ERRNO ( saved_errno = errno, saved_os2_errno = Perl_rc )
1220# define RESTORE_ERRNO ( errno = saved_errno, Perl_rc = saved_os2_errno )
1221#endif
1222
1223#ifndef SETERRNO
1224# define SETERRNO(errcode,vmserrcode) (errno = (errcode))
1225#endif
1226
1227#ifndef dSAVEDERRNO
1228# define dSAVEDERRNO int saved_errno
1229# define dSAVE_ERRNO int saved_errno = errno
1230# define SAVE_ERRNO (saved_errno = errno)
1231# define RESTORE_ERRNO (errno = saved_errno)
1232#endif
1233
f5fa9033 1234#define ERRSV GvSVn(PL_errgv)
dfd167e9
NC
1235
1236#define CLEAR_ERRSV() STMT_START { \
1237 if (!GvSV(PL_errgv)) { \
1238 sv_setpvs(GvSV(gv_add_by_type(PL_errgv, SVt_PV)), ""); \
1239 } else if (SvREADONLY(GvSV(PL_errgv))) { \
1240 SvREFCNT_dec(GvSV(PL_errgv)); \
1241 GvSV(PL_errgv) = newSVpvs(""); \
1242 } else { \
1243 SV *const errsv = GvSV(PL_errgv); \
1244 sv_setpvs(errsv, ""); \
1245 if (SvMAGICAL(errsv)) { \
1246 mg_free(errsv); \
1247 } \
1248 SvPOK_only(errsv); \
1249 } \
1250 } STMT_END
1251
1252
414bf5ae
MHM
1253#ifdef PERL_CORE
1254# define DEFSV (0 + GvSVn(PL_defgv))
55b5114f
FC
1255# define DEFSV_set(sv) \
1256 (SvREFCNT_dec(GvSV(PL_defgv)), GvSV(PL_defgv) = SvREFCNT_inc(sv))
1257# define SAVE_DEFSV \
1258 ( \
1259 save_gp(PL_defgv, 0), \
1260 GvINTRO_off(PL_defgv), \
1261 SAVEGENERICSV(GvSV(PL_defgv)), \
1262 GvSV(PL_defgv) = NULL \
1263 )
414bf5ae
MHM
1264#else
1265# define DEFSV GvSVn(PL_defgv)
55b5114f
FC
1266# define DEFSV_set(sv) (GvSV(PL_defgv) = (sv))
1267# define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
414bf5ae 1268#endif
38a03e6e 1269
55497cff 1270#ifndef errno
5ff3f7a4
GS
1271 extern int errno; /* ANSI allows errno to be an lvalue expr.
1272 * For example in multithreaded environments
1273 * something like this might happen:
1274 * extern int *_errno(void);
1275 * #define errno (*_errno()) */
d9d8d8de 1276#endif
663a0e37 1277
7e996671
KW
1278#define UNKNOWN_ERRNO_MSG "(unknown)"
1279
2304df62 1280#ifdef HAS_STRERROR
b3e384bf 1281# ifndef DONT_DECLARE_STD
a0d0e21e 1282# ifdef VMS
20ce7b12 1283 char *strerror (int,...);
a0d0e21e 1284# else
20ce7b12 1285 char *strerror (int);
a0d0e21e 1286# endif
b3e384bf
KW
1287# endif
1288# ifndef Strerror
1289# define Strerror strerror
1290# endif
2304df62
AD
1291#else
1292# ifdef HAS_SYS_ERRLIST
79072805
LW
1293 extern int sys_nerr;
1294 extern char *sys_errlist[];
2304df62
AD
1295# ifndef Strerror
1296# define Strerror(e) \
7e996671 1297 ((e) < 0 || (e) >= sys_nerr ? UNKNOWN_ERRNO_MSG : sys_errlist[e])
2304df62 1298# endif
79072805 1299# endif
35c8bce7 1300#endif
663a0e37 1301
2304df62 1302#ifdef I_SYS_IOCTL
79072805
LW
1303# ifndef _IOCTL_
1304# include <sys/ioctl.h>
1305# endif
a687059c
LW
1306#endif
1307
ee0007ab 1308#if defined(mc300) || defined(mc500) || defined(mc700) || defined(mc6000)
79072805
LW
1309# ifdef HAS_SOCKETPAIR
1310# undef HAS_SOCKETPAIR
1311# endif
2304df62
AD
1312# ifdef I_NDBM
1313# undef I_NDBM
79072805 1314# endif
a687059c
LW
1315#endif
1316
02fc2eee
NC
1317#ifndef HAS_SOCKETPAIR
1318# ifdef HAS_SOCKET
1319# define socketpair Perl_my_socketpair
1320# endif
1321#endif
1322
a687059c 1323#if INTSIZE == 2
79072805
LW
1324# define htoni htons
1325# define ntohi ntohs
a687059c 1326#else
79072805
LW
1327# define htoni htonl
1328# define ntohi ntohl
a687059c
LW
1329#endif
1330
a0d0e21e 1331/* Configure already sets Direntry_t */
35c8bce7 1332#if defined(I_DIRENT)
663a0e37 1333# include <dirent.h>
ae986130 1334#else
fe14fcc3 1335# ifdef I_SYS_NDIR
79a0689e 1336# include <sys/ndir.h>
663a0e37 1337# else
fe14fcc3 1338# ifdef I_SYS_DIR
79a0689e
LW
1339# ifdef hp9000s500
1340# include <ndir.h> /* may be wrong in the future */
1341# else
1342# include <sys/dir.h>
1343# endif
663a0e37
LW
1344# endif
1345# endif
4633a7c4 1346#endif
a687059c 1347
c623bd54
LW
1348/*
1349 * The following gobbledygook brought to you on behalf of __STDC__.
1350 * (I could just use #ifndef __STDC__, but this is more bulletproof
1351 * in the face of half-implementations.)
1352 */
1353
21e89b5f 1354#if defined(I_SYSMODE)
ca6e1c26
JH
1355#include <sys/mode.h>
1356#endif
1357
c623bd54
LW
1358#ifndef S_IFMT
1359# ifdef _S_IFMT
1360# define S_IFMT _S_IFMT
1361# else
1362# define S_IFMT 0170000
1363# endif
1364#endif
1365
1366#ifndef S_ISDIR
1367# define S_ISDIR(m) ((m & S_IFMT) == S_IFDIR)
1368#endif
1369
1370#ifndef S_ISCHR
1371# define S_ISCHR(m) ((m & S_IFMT) == S_IFCHR)
1372#endif
1373
1374#ifndef S_ISBLK
fe14fcc3
LW
1375# ifdef S_IFBLK
1376# define S_ISBLK(m) ((m & S_IFMT) == S_IFBLK)
1377# else
1378# define S_ISBLK(m) (0)
1379# endif
c623bd54
LW
1380#endif
1381
1382#ifndef S_ISREG
1383# define S_ISREG(m) ((m & S_IFMT) == S_IFREG)
1384#endif
1385
1386#ifndef S_ISFIFO
fe14fcc3
LW
1387# ifdef S_IFIFO
1388# define S_ISFIFO(m) ((m & S_IFMT) == S_IFIFO)
1389# else
1390# define S_ISFIFO(m) (0)
1391# endif
c623bd54
LW
1392#endif
1393
1394#ifndef S_ISLNK
1395# ifdef _S_ISLNK
1396# define S_ISLNK(m) _S_ISLNK(m)
1397# else
1398# ifdef _S_IFLNK
1399# define S_ISLNK(m) ((m & S_IFMT) == _S_IFLNK)
1400# else
1401# ifdef S_IFLNK
1402# define S_ISLNK(m) ((m & S_IFMT) == S_IFLNK)
1403# else
1404# define S_ISLNK(m) (0)
1405# endif
1406# endif
1407# endif
1408#endif
1409
1410#ifndef S_ISSOCK
1411# ifdef _S_ISSOCK
1412# define S_ISSOCK(m) _S_ISSOCK(m)
1413# else
1414# ifdef _S_IFSOCK
1415# define S_ISSOCK(m) ((m & S_IFMT) == _S_IFSOCK)
1416# else
1417# ifdef S_IFSOCK
1418# define S_ISSOCK(m) ((m & S_IFMT) == S_IFSOCK)
1419# else
1420# define S_ISSOCK(m) (0)
1421# endif
1422# endif
1423# endif
1424#endif
1425
1426#ifndef S_IRUSR
1427# ifdef S_IREAD
1428# define S_IRUSR S_IREAD
1429# define S_IWUSR S_IWRITE
1430# define S_IXUSR S_IEXEC
1431# else
1432# define S_IRUSR 0400
1433# define S_IWUSR 0200
1434# define S_IXUSR 0100
1435# endif
fac7cdfc 1436#endif
1437
1438#ifndef S_IRGRP
1439# ifdef S_IRUSR
1440# define S_IRGRP (S_IRUSR>>3)
1441# define S_IWGRP (S_IWUSR>>3)
1442# define S_IXGRP (S_IXUSR>>3)
1443# else
1444# define S_IRGRP 0040
1445# define S_IWGRP 0020
1446# define S_IXGRP 0010
1447# endif
1448#endif
1449
1450#ifndef S_IROTH
1451# ifdef S_IRUSR
1452# define S_IROTH (S_IRUSR>>6)
1453# define S_IWOTH (S_IWUSR>>6)
1454# define S_IXOTH (S_IXUSR>>6)
1455# else
1456# define S_IROTH 0040
1457# define S_IWOTH 0020
1458# define S_IXOTH 0010
1459# endif
c623bd54
LW
1460#endif
1461
1462#ifndef S_ISUID
1463# define S_ISUID 04000
1464#endif
1465
1466#ifndef S_ISGID
1467# define S_ISGID 02000
1468#endif
1469
ca6e1c26
JH
1470#ifndef S_IRWXU
1471# define S_IRWXU (S_IRUSR|S_IWUSR|S_IXUSR)
d460ef45 1472#endif
ca6e1c26
JH
1473
1474#ifndef S_IRWXG
1475# define S_IRWXG (S_IRGRP|S_IWGRP|S_IXGRP)
d460ef45 1476#endif
ca6e1c26
JH
1477
1478#ifndef S_IRWXO
1479# define S_IRWXO (S_IROTH|S_IWOTH|S_IXOTH)
d460ef45 1480#endif
ca6e1c26 1481
b6c36746 1482/* Haiku R1 seems to define S_IREAD and S_IWRITE in <posix/fcntl.h>
c21fb2b8
JH
1483 * which would get included through <sys/file.h >, but that is 3000
1484 * lines in the future. --jhi */
1485
b6c36746 1486#if !defined(S_IREAD) && !defined(__HAIKU__)
ca6e1c26
JH
1487# define S_IREAD S_IRUSR
1488#endif
1489
b6c36746 1490#if !defined(S_IWRITE) && !defined(__HAIKU__)
ca6e1c26
JH
1491# define S_IWRITE S_IWUSR
1492#endif
1493
1494#ifndef S_IEXEC
1495# define S_IEXEC S_IXUSR
1496#endif
1497
a0d0e21e 1498#if defined(cray) || defined(gould) || defined(i860) || defined(pyr)
45d8adaa
LW
1499# define SLOPPYDIVIDE
1500#endif
1501
748a9306
LW
1502#ifdef UV
1503#undef UV
1504#endif
1505
ce582cee
NC
1506/* For the times when you want the return value of sprintf, and you want it
1507 to be the length. Can't have a thread variable passed in, because C89 has
1508 no varargs macros.
1509*/
1510#ifdef SPRINTF_RETURNS_STRLEN
1511# define my_sprintf sprintf
1512#else
1513# define my_sprintf Perl_my_sprintf
1514#endif
1515
5b692037
JH
1516/*
1517 * If we have v?snprintf() and the C99 variadic macros, we can just
1518 * use just the v?snprintf(). It is nice to try to trap the buffer
1519 * overflow, however, so if we are DEBUGGING, and we cannot use the
e5afc1ae
DD
1520 * gcc statement expressions, then use the function wrappers which try
1521 * to trap the overflow. If we can use the gcc statement expressions,
1522 * we can try that even with the version that uses the C99 variadic
1523 * macros.
5b692037
JH
1524 */
1525
1208b3dd
JH
1526/* Note that we do not check against snprintf()/vsnprintf() returning
1527 * negative values because that is non-standard behaviour and we use
1528 * snprintf/vsnprintf only iff HAS_VSNPRINTF has been defined, and
1529 * that should be true only if the snprintf()/vsnprintf() are true
1530 * to the standard. */
1531
dfeee9b1 1532#if defined(HAS_SNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
5b692037 1533# ifdef PERL_USE_GCC_BRACE_GROUPS
12e82c57 1534# 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__; })
1208b3dd 1535# define PERL_MY_SNPRINTF_GUARDED
5b692037
JH
1536# else
1537# define my_snprintf(buffer, len, ...) snprintf(buffer, len, __VA_ARGS__)
1538# endif
1539#else
1540# define my_snprintf Perl_my_snprintf
1208b3dd 1541# define PERL_MY_SNPRINTF_GUARDED
5b692037
JH
1542#endif
1543
dfeee9b1 1544#if defined(HAS_VSNPRINTF) && defined(HAS_C99_VARIADIC_MACROS) && !(defined(DEBUGGING) && !defined(PERL_USE_GCC_BRACE_GROUPS)) && !defined(PERL_GCC_PEDANTIC)
5b692037 1545# ifdef PERL_USE_GCC_BRACE_GROUPS
9e440ecc 1546# define my_vsnprintf(buffer, len, ...) ({ int __len__ = vsnprintf(buffer, len, __VA_ARGS__); if ((len) > 0 && (Size_t)__len__ >= (Size_t)(len)) Perl_croak_nocontext("panic: vsnprintf buffer overflow"); __len__; })
1208b3dd 1547# define PERL_MY_VSNPRINTF_GUARDED
5b692037
JH
1548# else
1549# define my_vsnprintf(buffer, len, ...) vsnprintf(buffer, len, __VA_ARGS__)
1550# endif
1551#else
1552# define my_vsnprintf Perl_my_vsnprintf
1208b3dd 1553# define PERL_MY_VSNPRINTF_GUARDED
5b692037 1554#endif
d9fad198 1555
a6cc4119
SP
1556#ifdef HAS_STRLCAT
1557# define my_strlcat strlcat
1558#else
1559# define my_strlcat Perl_my_strlcat
1560#endif
1561
1562#ifdef HAS_STRLCPY
1563# define my_strlcpy strlcpy
1564#else
1565# define my_strlcpy Perl_my_strlcpy
1566#endif
1567
05f13f53 1568/*
27d4fb96
PP
1569 The IV type is supposed to be long enough to hold any integral
1570 value or a pointer.
1571 --Andy Dougherty August 1996
1572*/
1573
a22e52b9
JH
1574typedef IVTYPE IV;
1575typedef UVTYPE UV;
8175356b 1576
10cc9d2a 1577#if defined(USE_64_BIT_INT) && defined(HAS_QUAD)
6b8eaf93 1578# if QUADKIND == QUAD_IS_INT64_T && defined(INT64_MAX)
5ff3f7a4
GS
1579# define IV_MAX INT64_MAX
1580# define IV_MIN INT64_MIN
1581# define UV_MAX UINT64_MAX
cae7ae48
JH
1582# ifndef UINT64_MIN
1583# define UINT64_MIN 0
1584# endif
5ff3f7a4
GS
1585# define UV_MIN UINT64_MIN
1586# else
1587# define IV_MAX PERL_QUAD_MAX
1588# define IV_MIN PERL_QUAD_MIN
1589# define UV_MAX PERL_UQUAD_MAX
1590# define UV_MIN PERL_UQUAD_MIN
1591# endif
cf2093f6
JH
1592# define IV_IS_QUAD
1593# define UV_IS_QUAD
79072805 1594#else
8175356b 1595# if defined(INT32_MAX) && IVSIZE == 4
5ff3f7a4
GS
1596# define IV_MAX INT32_MAX
1597# define IV_MIN INT32_MIN
716026f9
DL
1598# ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
1599# define UV_MAX UINT32_MAX
1600# else
1601# define UV_MAX 4294967295U
1602# endif
cae7ae48
JH
1603# ifndef UINT32_MIN
1604# define UINT32_MIN 0
1605# endif
5ff3f7a4
GS
1606# define UV_MIN UINT32_MIN
1607# else
1608# define IV_MAX PERL_LONG_MAX
1609# define IV_MIN PERL_LONG_MIN
1610# define UV_MAX PERL_ULONG_MAX
1611# define UV_MIN PERL_ULONG_MIN
1612# endif
8175356b 1613# if IVSIZE == 8
cf2093f6
JH
1614# define IV_IS_QUAD
1615# define UV_IS_QUAD
de1c2614
JH
1616# ifndef HAS_QUAD
1617# define HAS_QUAD
1618# endif
cf2093f6
JH
1619# else
1620# undef IV_IS_QUAD
1621# undef UV_IS_QUAD
9ea40801 1622#if !defined(PERL_CORE) || defined(USING_MSVC6)
e25d460c
NC
1623/* We think that removing this decade-old undef this will cause too much
1624 breakage on CPAN for too little gain. (See RT #119753)
9ea40801
SH
1625 However, we do need HAS_QUAD in the core for use by the drand48 code,
1626 but not for Win32 VC6 because it has poor __int64 support. */
cb4b14d5 1627# undef HAS_QUAD
e25d460c 1628#endif
cf2093f6 1629# endif
79072805 1630#endif
d7d93a81 1631
9a543cee
FC
1632#define SSize_t_MAX (SSize_t)(~(size_t)0 >> 1)
1633
cae7ae48 1634#define IV_DIG (BIT_DIGITS(IVSIZE * 8))
22ec83e3 1635#define UV_DIG (BIT_DIGITS(UVSIZE * 8))
56431972 1636
28e5dec8 1637#ifndef NO_PERL_PRESERVE_IVUV
f5c03d33 1638#define PERL_PRESERVE_IVUV /* We like our integers to stay integers. */
28e5dec8
JH
1639#endif
1640
d460ef45 1641/*
26bb67e2
JH
1642 * The macros INT2PTR and NUM2PTR are (despite their names)
1643 * bi-directional: they will convert int/float to or from pointers.
1644 * However the conversion to int/float are named explicitly:
1645 * PTR2IV, PTR2UV, PTR2NV.
1646 *
1647 * For int conversions we do not need two casts if pointers are
1648 * the same size as IV and UV. Otherwise we need an explicit
1649 * cast (PTRV) to avoid compiler warnings.
1650 */
56431972
RB
1651#if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
1652# define PTRV UV
1653# define INT2PTR(any,d) (any)(d)
1654#else
d460ef45 1655# if PTRSIZE == LONGSIZE
56431972 1656# define PTRV unsigned long
e91e3b10 1657# define PTR2ul(p) (unsigned long)(p)
42718184 1658# else
56431972 1659# define PTRV unsigned
42718184 1660# endif
e91e3b10
RB
1661#endif
1662
1663#ifndef INT2PTR
56431972 1664# define INT2PTR(any,d) (any)(PTRV)(d)
42718184 1665#endif
e91e3b10
RB
1666
1667#ifndef PTR2ul
1668# define PTR2ul(p) INT2PTR(unsigned long,p)
1669#endif
1670
56431972
RB
1671#define NUM2PTR(any,d) (any)(PTRV)(d)
1672#define PTR2IV(p) INT2PTR(IV,p)
1673#define PTR2UV(p) INT2PTR(UV,p)
1674#define PTR2NV(p) NUM2PTR(NV,p)
e91e3b10 1675#define PTR2nat(p) (PTRV)(p) /* pointer to integer of PTRSIZE */
d460ef45 1676
8141890a
JH
1677/* According to strict ANSI C89 one cannot freely cast between
1678 * data pointers and function (code) pointers. There are at least
1679 * two ways around this. One (used below) is to do two casts,
1680 * first the other pointer to an (unsigned) integer, and then
1681 * the integer to the other pointer. The other way would be
1682 * to use unions to "overlay" the pointers. For an example of
1683 * the latter technique, see union dirpu in struct xpvio in sv.h.
1684 * The only feasible use is probably temporarily storing
1685 * function pointers in a data pointer (such as a void pointer). */
1686
e91e3b10
RB
1687#define DPTR2FPTR(t,p) ((t)PTR2nat(p)) /* data pointer to function pointer */
1688#define FPTR2DPTR(t,p) ((t)PTR2nat(p)) /* function pointer to data pointer */
8141890a 1689
65202027 1690#ifdef USE_LONG_DOUBLE
1048ea30
JH
1691# if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE == DOUBLESIZE
1692# define LONG_DOUBLE_EQUALS_DOUBLE
1693# endif
68d4903c 1694# if !(defined(HAS_LONG_DOUBLE) && (LONG_DOUBLESIZE > DOUBLESIZE))
2d4389e4 1695# undef USE_LONG_DOUBLE /* Ouch! */
65202027
DS
1696# endif
1697#endif
1698
2d4389e4
JH
1699#ifdef OVR_DBL_DIG
1700/* Use an overridden DBL_DIG */
1701# ifdef DBL_DIG
1702# undef DBL_DIG
1703# endif
1704# define DBL_DIG OVR_DBL_DIG
1705#else
1706/* The following is all to get DBL_DIG, in order to pick a nice
205f51d8
AS
1707 default value for printing floating point numbers in Gconvert
1708 (see config.h). (It also has other uses, such as figuring out if
1709 a given precision of printing can be done with a double instead of
1710 a long double - Allen).
2d4389e4
JH
1711*/
1712#ifdef I_LIMITS
1713#include <limits.h>
1714#endif
1715#ifdef I_FLOAT
1716#include <float.h>
1717#endif
1718#ifndef HAS_DBL_DIG
1719#define DBL_DIG 15 /* A guess that works lots of places */
1720#endif
1721#endif
1722
1723#ifdef OVR_LDBL_DIG
1724/* Use an overridden LDBL_DIG */
1725# ifdef LDBL_DIG
1726# undef LDBL_DIG
1727# endif
1728# define LDBL_DIG OVR_LDBL_DIG
1729#else
1730/* The following is all to get LDBL_DIG, in order to pick a nice
1731 default value for printing floating point numbers in Gconvert.
1732 (see config.h)
1733*/
68d4903c
JH
1734# ifdef I_LIMITS
1735# include <limits.h>
1736# endif
1737# ifdef I_FLOAT
1738# include <float.h>
1739# endif
1740# ifndef HAS_LDBL_DIG
1741# if LONG_DOUBLESIZE == 10
1742# define LDBL_DIG 18 /* assume IEEE */
1743# else
1744# if LONG_DOUBLESIZE == 12
1745# define LDBL_DIG 18 /* gcc? */
1746# else
1747# if LONG_DOUBLESIZE == 16
1748# define LDBL_DIG 33 /* assume IEEE */
1749# else
1750# if LONG_DOUBLESIZE == DOUBLESIZE
1751# define LDBL_DIG DBL_DIG /* bummer */
1752# endif
1753# endif
1754# endif
1755# endif
1756# endif
2d4389e4
JH
1757#endif
1758
20f6aaab
AS
1759/*
1760 * This is for making sure we have a good DBL_MAX value, if possible,
1761 * either for usage as NV_MAX or for usage in figuring out if we can
1762 * fit a given long double into a double, if bug-fixing makes it
1763 * necessary to do so. - Allen <allens@cpan.org>
1764 */
1765
205f51d8
AS
1766#ifdef I_LIMITS
1767# include <limits.h>
20f6aaab
AS
1768#endif
1769
205f51d8
AS
1770#ifdef I_VALUES
1771# if !(defined(DBL_MIN) && defined(DBL_MAX) && defined(I_LIMITS))
1772# include <values.h>
1773# if defined(MAXDOUBLE) && !defined(DBL_MAX)
1774# define DBL_MAX MAXDOUBLE
1775# endif
1776# if defined(MINDOUBLE) && !defined(DBL_MIN)
1777# define DBL_MIN MINDOUBLE
1778# endif
1779# endif
1780#endif /* defined(I_VALUES) */
1781
a22e52b9 1782typedef NVTYPE NV;
8175356b 1783
792d8dab
JH
1784#ifdef I_IEEEFP
1785# include <ieeefp.h>
1786#endif
923fc586 1787
65202027 1788#ifdef USE_LONG_DOUBLE
923fc586
JH
1789# ifdef I_SUNMATH
1790# include <sunmath.h>
1791# endif
2d4389e4 1792# define NV_DIG LDBL_DIG
d6c14000
JH
1793# ifdef LDBL_MANT_DIG
1794# define NV_MANT_DIG LDBL_MANT_DIG
1795# endif
06fc1729
JH
1796# ifdef LDBL_MIN
1797# define NV_MIN LDBL_MIN
1798# endif
1799# ifdef LDBL_MAX
1800# define NV_MAX LDBL_MAX
1801# endif
1802# ifdef LDBL_MIN_10_EXP
1803# define NV_MIN_10_EXP LDBL_MIN_10_EXP
1804# endif
1805# ifdef LDBL_MAX_10_EXP
1806# define NV_MAX_10_EXP LDBL_MAX_10_EXP
1807# endif
1808# ifdef LDBL_EPSILON
1809# define NV_EPSILON LDBL_EPSILON
1810# endif
f4a14a62
JH
1811# ifdef LDBL_MAX
1812# define NV_MAX LDBL_MAX
20f6aaab 1813/* Having LDBL_MAX doesn't necessarily mean that we have LDBL_MIN... -Allen */
f4a14a62
JH
1814# else
1815# ifdef HUGE_VALL
1816# define NV_MAX HUGE_VALL
1817# else
1818# ifdef HUGE_VAL
1819# define NV_MAX ((NV)HUGE_VAL)
1820# endif
1821# endif
1822# endif
68d4903c 1823# ifdef HAS_SQRTL
68d4903c
JH
1824# define Perl_cos cosl
1825# define Perl_sin sinl
1826# define Perl_sqrt sqrtl
1827# define Perl_exp expl
1828# define Perl_log logl
1829# define Perl_atan2 atan2l
1830# define Perl_pow powl
1831# define Perl_floor floorl
1bbae031 1832# define Perl_ceil ceill
68d4903c
JH
1833# define Perl_fmod fmodl
1834# endif
a3540c92
JH
1835/* e.g. libsunmath doesn't have modfl and frexpl as of mid-March 2000 */
1836# ifdef HAS_MODFL
1837# define Perl_modf(x,y) modfl(x,y)
51997bc3
NC
1838/* eg glibc 2.2 series seems to provide modfl on ppc and arm, but has no
1839 prototype in <math.h> */
1840# ifndef HAS_MODFL_PROTO
a221a8a5 1841EXTERN_C long double modfl(long double, long double *);
51997bc3 1842# endif
03476e8e
JH
1843# else
1844# if defined(HAS_AINTL) && defined(HAS_COPYSIGNL)
55954f19 1845 extern long double Perl_my_modfl(long double x, long double *ip);
03476e8e
JH
1846# define Perl_modf(x,y) Perl_my_modfl(x,y)
1847# endif
a3540c92
JH
1848# endif
1849# ifdef HAS_FREXPL
dff3e0b8 1850# define Perl_frexp(x,y) frexpl(x,y)
03476e8e
JH
1851# else
1852# if defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
55954f19 1853 extern long double Perl_my_frexpl(long double x, int *e);
03476e8e
JH
1854# define Perl_frexp(x,y) Perl_my_frexpl(x,y)
1855# endif
a3540c92 1856# endif
38dbb4c5 1857# ifndef Perl_isnan
758a5d79
JH
1858# ifdef HAS_ISNANL
1859# define Perl_isnan(x) isnanl(x)
1860# endif
1861# endif
1862# ifndef Perl_isinf
1863# ifdef HAS_FINITEL
1864# define Perl_isinf(x) !(finitel(x)||Perl_isnan(x))
a3540c92
JH
1865# endif
1866# endif
65202027 1867#else
2d4389e4 1868# define NV_DIG DBL_DIG
d6c14000
JH
1869# ifdef DBL_MANT_DIG
1870# define NV_MANT_DIG DBL_MANT_DIG
1871# endif
06fc1729
JH
1872# ifdef DBL_MIN
1873# define NV_MIN DBL_MIN
1874# endif
1875# ifdef DBL_MAX
1876# define NV_MAX DBL_MAX
1877# endif
1878# ifdef DBL_MIN_10_EXP
1879# define NV_MIN_10_EXP DBL_MIN_10_EXP
1880# endif
1881# ifdef DBL_MAX_10_EXP
1882# define NV_MAX_10_EXP DBL_MAX_10_EXP
1883# endif
1884# ifdef DBL_EPSILON
1885# define NV_EPSILON DBL_EPSILON
1886# endif
205f51d8 1887# ifdef DBL_MAX /* XXX Does DBL_MAX imply having DBL_MIN? */
f4a14a62
JH
1888# define NV_MAX DBL_MAX
1889# define NV_MIN DBL_MIN
1890# else
1891# ifdef HUGE_VAL
1892# define NV_MAX HUGE_VAL
1893# endif
1894# endif
65202027
DS
1895# define Perl_cos cos
1896# define Perl_sin sin
1897# define Perl_sqrt sqrt
1898# define Perl_exp exp
1899# define Perl_log log
1900# define Perl_atan2 atan2
1901# define Perl_pow pow
1902# define Perl_floor floor
1bbae031 1903# define Perl_ceil ceil
65202027 1904# define Perl_fmod fmod
a3540c92 1905# define Perl_modf(x,y) modf(x,y)
dff3e0b8 1906# define Perl_frexp(x,y) frexp(x,y)
758a5d79
JH
1907#endif
1908
1909/* rumor has it that Win32 has _fpclass() */
1910
205f51d8
AS
1911/* SGI has fpclassl... but not with the same result values,
1912 * and it's via a typedef (not via #define), so will need to redo Configure
1913 * to use. Not worth the trouble, IMO, at least until the below is used
1914 * more places. Also has fp_class_l, BTW, via fp_class.h. Feel free to check
1915 * with me for the SGI manpages, SGI testing, etcetera, if you want to
1916 * try getting this to work with IRIX. - Allen <allens@cpan.org> */
1917
758a5d79
JH
1918#if !defined(Perl_fp_class) && (defined(HAS_FPCLASS)||defined(HAS_FPCLASSL))
1919# ifdef I_IEEFP
1920# include <ieeefp.h>
1921# endif
1922# ifdef I_FP
1923# include <fp.h>
1924# endif
1925# if defined(USE_LONG_DOUBLE) && defined(HAS_FPCLASSL)
1926# define Perl_fp_class() fpclassl(x)
1927# else
1928# define Perl_fp_class() fpclass(x)
1929# endif
1930# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_CLASS_SNAN)
1931# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_CLASS_QNAN)
1932# define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_CLASS_SNAN||Perl_fp_class(x)==FP_CLASS_QNAN)
1933# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_CLASS_NINF)
1934# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_CLASS_PINF)
1935# define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_CLASS_NINF||Perl_fp_class(x)==FP_CLASS_PINF)
1936# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_CLASS_NNORM)
1937# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_CLASS_PNORM)
1938# define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_CLASS_NNORM||Perl_fp_class(x)==FP_CLASS_PNORM)
1939# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_CLASS_NDENORM)
1940# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_CLASS_PDENORM)
1941# define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_CLASS_NDENORM||Perl_fp_class(x)==FP_CLASS_PDENORM)
1942# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_CLASS_NZERO)
1943# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_CLASS_PZERO)
1944# define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_CLASS_NZERO||Perl_fp_class(x)==FP_CLASS_PZERO)
1945#endif
1946
21e89b5f 1947#if !defined(Perl_fp_class) && defined(HAS_FP_CLASS)
758a5d79
JH
1948# include <math.h>
1949# if !defined(FP_SNAN) && defined(I_FP_CLASS)
1950# include <fp_class.h>
1951# endif
1952# define Perl_fp_class(x) fp_class(x)
1953# define Perl_fp_class_snan(x) (fp_class(x)==FP_SNAN)
1954# define Perl_fp_class_qnan(x) (fp_class(x)==FP_QNAN)
1955# define Perl_fp_class_nan(x) (fp_class(x)==FP_SNAN||fp_class(x)==FP_QNAN)
1956# define Perl_fp_class_ninf(x) (fp_class(x)==FP_NEG_INF)
1957# define Perl_fp_class_pinf(x) (fp_class(x)==FP_POS_INF)
1958# define Perl_fp_class_inf(x) (fp_class(x)==FP_NEG_INF||fp_class(x)==FP_POS_INF)
1959# define Perl_fp_class_nnorm(x) (fp_class(x)==FP_NEG_NORM)
1960# define Perl_fp_class_pnorm(x) (fp_class(x)==FP_POS_NORM)
1961# define Perl_fp_class_norm(x) (fp_class(x)==FP_NEG_NORM||fp_class(x)==FP_POS_NORM)
1962# define Perl_fp_class_ndenorm(x) (fp_class(x)==FP_NEG_DENORM)
1963# define Perl_fp_class_pdenorm(x) (fp_class(x)==FP_POS_DENORM)
1964# define Perl_fp_class_denorm(x) (fp_class(x)==FP_NEG_DENORM||fp_class(x)==FP_POS_DENORM)
1965# define Perl_fp_class_nzero(x) (fp_class(x)==FP_NEG_ZERO)
1966# define Perl_fp_class_pzero(x) (fp_class(x)==FP_POS_ZERO)
1967# define Perl_fp_class_zero(x) (fp_class(x)==FP_NEG_ZERO||fp_class(x)==FP_POS_ZERO)
1968#endif
1969
1970#if !defined(Perl_fp_class) && defined(HAS_FPCLASSIFY)
1971# include <math.h>
1972# define Perl_fp_class(x) fpclassify(x)
38dbb4c5 1973# define Perl_fp_class_nan(x) (fp_classify(x)==FP_SNAN||fp_classify(x)==FP_QNAN)
758a5d79
JH
1974# define Perl_fp_class_inf(x) (fp_classify(x)==FP_INFINITE)
1975# define Perl_fp_class_norm(x) (fp_classify(x)==FP_NORMAL)
1976# define Perl_fp_class_denorm(x) (fp_classify(x)==FP_SUBNORMAL)
1977# define Perl_fp_class_zero(x) (fp_classify(x)==FP_ZERO)
1978#endif
1979
1980#if !defined(Perl_fp_class) && defined(HAS_CLASS)
1981# include <math.h>
1982# ifndef _cplusplus
1983# define Perl_fp_class(x) class(x)
1984# else
1985# define Perl_fp_class(x) _class(x)
1986# endif
1987# define Perl_fp_class_snan(x) (Perl_fp_class(x)==FP_NANS)
1988# define Perl_fp_class_qnan(x) (Perl_fp_class(x)==FP_NANQ)
1989# define Perl_fp_class_nan(x) (Perl_fp_class(x)==FP_SNAN||Perl_fp_class(x)==FP_QNAN)
1990# define Perl_fp_class_ninf(x) (Perl_fp_class(x)==FP_MINUS_INF)
1991# define Perl_fp_class_pinf(x) (Perl_fp_class(x)==FP_PLUS_INF)
1992# define Perl_fp_class_inf(x) (Perl_fp_class(x)==FP_MINUS_INF||Perl_fp_class(x)==FP_PLUS_INF)
1993# define Perl_fp_class_nnorm(x) (Perl_fp_class(x)==FP_MINUS_NORM)
1994# define Perl_fp_class_pnorm(x) (Perl_fp_class(x)==FP_PLUS_NORM)
1995# define Perl_fp_class_norm(x) (Perl_fp_class(x)==FP_MINUS_NORM||Perl_fp_class(x)==FP_PLUS_NORM)
1996# define Perl_fp_class_ndenorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM)
1997# define Perl_fp_class_pdenorm(x) (Perl_fp_class(x)==FP_PLUS_DENORM)
1998# define Perl_fp_class_denorm(x) (Perl_fp_class(x)==FP_MINUS_DENORM||Perl_fp_class(x)==FP_PLUS_DENORM)
1999# define Perl_fp_class_nzero(x) (Perl_fp_class(x)==FP_MINUS_ZERO)
2000# define Perl_fp_class_pzero(x) (Perl_fp_class(x)==FP_PLUS_ZERO)
2001# define Perl_fp_class_zero(x) (Perl_fp_class(x)==FP_MINUS_ZERO||Perl_fp_class(x)==FP_PLUS_ZERO)
2002#endif
2003
2004/* rumor has it that Win32 has _isnan() */
2005
2006#ifndef Perl_isnan
a3540c92 2007# ifdef HAS_ISNAN
758a5d79
JH
2008# define Perl_isnan(x) isnan((NV)x)
2009# else
2010# ifdef Perl_fp_class_nan
2011# define Perl_isnan(x) Perl_fp_class_nan(x)
2012# else
2013# ifdef HAS_UNORDERED
2014# define Perl_isnan(x) unordered((x), 0.0)
2015# else
2016# define Perl_isnan(x) ((x)!=(x))
2017# endif
2018# endif
2019# endif
2020#endif
2021
ca6c63e1
JH
2022#ifdef UNDER_CE
2023int isnan(double d);
2024#endif
2025
758a5d79
JH
2026#ifndef Perl_isinf
2027# ifdef HAS_ISINF
2028# define Perl_isinf(x) isinf((NV)x)
a3540c92 2029# else
758a5d79
JH
2030# ifdef Perl_fp_class_inf
2031# define Perl_isinf(x) Perl_fp_class_inf(x)
2032# else
2033# define Perl_isinf(x) ((x)==NV_INF)
2034# endif
2035# endif
2036#endif
2037
2038#ifndef Perl_isfinite
2039# ifdef HAS_FINITE
2040# define Perl_isfinite(x) finite((NV)x)
2041# else
2042# ifdef HAS_ISFINITE
2043# define Perl_isfinite(x) isfinite(x)
2044# else
2045# ifdef Perl_fp_class_finite
2046# define Perl_isfinite(x) Perl_fp_class_finite(x)
2047# else
2048# define Perl_isfinite(x) !(Perl_is_inf(x)||Perl_is_nan(x))
2049# endif
2050# endif
a3540c92 2051# endif
65202027
DS
2052#endif
2053
a36244b7
JH
2054/* The default is to use Perl's own atof() implementation (in numeric.c).
2055 * Usually that is the one to use but for some platforms (e.g. UNICOS)
2056 * it is however best to use the native implementation of atof.
2057 * You can experiment with using your native one by -DUSE_PERL_ATOF=0.
2058 * Some good tests to try out with either setting are t/base/num.t,
205f51d8
AS
2059 * t/op/numconvert.t, and t/op/pack.t. Note that if using long doubles
2060 * you may need to be using a different function than atof! */
a36244b7
JH
2061
2062#ifndef USE_PERL_ATOF
2063# ifndef _UNICOS
2064# define USE_PERL_ATOF
2065# endif
2066#else
2067# if USE_PERL_ATOF == 0
2068# undef USE_PERL_ATOF
2069# endif
2070#endif
2071
2072#ifdef USE_PERL_ATOF
2073# define Perl_atof(s) Perl_my_atof(s)
2074# define Perl_atof2(s, n) Perl_my_atof2(aTHX_ (s), &(n))
2075#else
2076# define Perl_atof(s) (NV)atof(s)
2077# define Perl_atof2(s, n) ((n) = atof(s))
2078#endif
cf2093f6 2079
d460ef45 2080/* Previously these definitions used hardcoded figures.
760ac839
LW
2081 * It is hoped these formula are more portable, although
2082 * no data one way or another is presently known to me.
2083 * The "PERL_" names are used because these calculated constants
2084 * do not meet the ANSI requirements for LONG_MAX, etc., which
2085 * need to be constants acceptable to #if - kja
2086 * define PERL_LONG_MAX 2147483647L
2087 * define PERL_LONG_MIN (-LONG_MAX - 1)
2088 * define PERL ULONG_MAX 4294967295L
2089 */
2090
2091#ifdef I_LIMITS /* Needed for cast_xxx() functions below. */
2092# include <limits.h>
760ac839 2093#endif
205f51d8 2094/* Included values.h above if necessary; still including limits.h down here,
486ec47a 2095 * despite doing above, because math.h might have overridden... XXX - Allen */
760ac839 2096
99abf803
PP
2097/*
2098 * Try to figure out max and min values for the integral types. THE CORRECT
2099 * SOLUTION TO THIS MESS: ADAPT enquire.c FROM GCC INTO CONFIGURE. The
2100 * following hacks are used if neither limits.h or values.h provide them:
2101 * U<TYPE>_MAX: for types >= int: ~(unsigned TYPE)0
2102 * for types < int: (unsigned TYPE)~(unsigned)0
2103 * The argument to ~ must be unsigned so that later signed->unsigned
2104 * conversion can't modify the value's bit pattern (e.g. -0 -> +0),
2105 * and it must not be smaller than int because ~ does integral promotion.
2106 * <type>_MAX: (<type>) (U<type>_MAX >> 1)
2107 * <type>_MIN: -<type>_MAX - <is_twos_complement_architecture: (3 & -1) == 3>.
2108 * The latter is a hack which happens to work on some machines but
2109 * does *not* catch any random system, or things like integer types
2110 * with NaN if that is possible.
2111 *
2112 * All of the types are explicitly cast to prevent accidental loss of
2113 * numeric range, and in the hope that they will be less likely to confuse
2114 * over-eager optimizers.
2115 *
2116 */
27d4fb96 2117
99abf803
PP
2118#define PERL_UCHAR_MIN ((unsigned char)0)
2119
2120#ifdef UCHAR_MAX
2121# define PERL_UCHAR_MAX ((unsigned char)UCHAR_MAX)
27d4fb96 2122#else
99abf803
PP
2123# ifdef MAXUCHAR
2124# define PERL_UCHAR_MAX ((unsigned char)MAXUCHAR)
27d4fb96 2125# else
99abf803 2126# define PERL_UCHAR_MAX ((unsigned char)~(unsigned)0)
27d4fb96
PP
2127# endif
2128#endif
d460ef45 2129
99abf803
PP
2130/*
2131 * CHAR_MIN and CHAR_MAX are not included here, as the (char) type may be
2132 * ambiguous. It may be equivalent to (signed char) or (unsigned char)
2133 * depending on local options. Until Configure detects this (or at least
2134 * detects whether the "signed" keyword is available) the CHAR ranges
2135 * will not be included. UCHAR functions normally.
2136 * - kja
2137 */
27d4fb96 2138
99abf803
PP
2139#define PERL_USHORT_MIN ((unsigned short)0)
2140
2141#ifdef USHORT_MAX
2142# define PERL_USHORT_MAX ((unsigned short)USHORT_MAX)
27d4fb96 2143#else
99abf803
PP
2144# ifdef MAXUSHORT
2145# define PERL_USHORT_MAX ((unsigned short)MAXUSHORT)
27d4fb96 2146# else
ef2f54b0
CB
2147# ifdef USHRT_MAX
2148# define PERL_USHORT_MAX ((unsigned short)USHRT_MAX)
2149# else
2150# define PERL_USHORT_MAX ((unsigned short)~(unsigned)0)
2151# endif
27d4fb96
PP
2152# endif
2153#endif
2154
27d4fb96 2155#ifdef SHORT_MAX
99abf803 2156# define PERL_SHORT_MAX ((short)SHORT_MAX)
27d4fb96
PP
2157#else
2158# ifdef MAXSHORT /* Often used in <values.h> */
99abf803 2159# define PERL_SHORT_MAX ((short)MAXSHORT)
27d4fb96 2160# else
ef2f54b0
CB
2161# ifdef SHRT_MAX
2162# define PERL_SHORT_MAX ((short)SHRT_MAX)
2163# else
2164# define PERL_SHORT_MAX ((short) (PERL_USHORT_MAX >> 1))
2165# endif
27d4fb96
PP
2166# endif
2167#endif
2168
2169#ifdef SHORT_MIN
99abf803 2170# define PERL_SHORT_MIN ((short)SHORT_MIN)
27d4fb96
PP
2171#else
2172# ifdef MINSHORT
99abf803 2173# define PERL_SHORT_MIN ((short)MINSHORT)
27d4fb96 2174# else
ef2f54b0
CB
2175# ifdef SHRT_MIN
2176# define PERL_SHORT_MIN ((short)SHRT_MIN)
2177# else
2178# define PERL_SHORT_MIN (-PERL_SHORT_MAX - ((3 & -1) == 3))
2179# endif
27d4fb96
PP
2180# endif
2181#endif
2182
99abf803
PP
2183#ifdef UINT_MAX
2184# define PERL_UINT_MAX ((unsigned int)UINT_MAX)
27d4fb96 2185#else
99abf803
PP
2186# ifdef MAXUINT
2187# define PERL_UINT_MAX ((unsigned int)MAXUINT)
27d4fb96 2188# else
99abf803 2189# define PERL_UINT_MAX (~(unsigned int)0)
27d4fb96
PP
2190# endif
2191#endif
2192
99abf803 2193#define PERL_UINT_MIN ((unsigned int)0)
27d4fb96
PP
2194
2195#ifdef INT_MAX
99abf803 2196# define PERL_INT_MAX ((int)INT_MAX)
27d4fb96
PP
2197#else
2198# ifdef MAXINT /* Often used in <values.h> */
99abf803 2199# define PERL_INT_MAX ((int)MAXINT)
27d4fb96 2200# else
99abf803 2201# define PERL_INT_MAX ((int)(PERL_UINT_MAX >> 1))
27d4fb96
PP
2202# endif
2203#endif
2204
2205#ifdef INT_MIN
99abf803 2206# define PERL_INT_MIN ((int)INT_MIN)
27d4fb96
PP
2207#else
2208# ifdef MININT
99abf803 2209# define PERL_INT_MIN ((int)MININT)
27d4fb96
PP
2210# else
2211# define PERL_INT_MIN (-PERL_INT_MAX - ((3 & -1) == 3))
2212# endif
2213#endif
2214
99abf803
PP
2215#ifdef ULONG_MAX
2216# define PERL_ULONG_MAX ((unsigned long)ULONG_MAX)
27d4fb96 2217#else
99abf803
PP
2218# ifdef MAXULONG
2219# define PERL_ULONG_MAX ((unsigned long)MAXULONG)
27d4fb96 2220# else
99abf803 2221# define PERL_ULONG_MAX (~(unsigned long)0)
27d4fb96
PP
2222# endif
2223#endif
2224
99abf803 2225#define PERL_ULONG_MIN ((unsigned long)0L)
27d4fb96 2226
760ac839 2227#ifdef LONG_MAX
99abf803 2228# define PERL_LONG_MAX ((long)LONG_MAX)
760ac839
LW
2229#else
2230# ifdef MAXLONG /* Often used in <values.h> */
99abf803 2231# define PERL_LONG_MAX ((long)MAXLONG)
760ac839 2232# else
99abf803 2233# define PERL_LONG_MAX ((long) (PERL_ULONG_MAX >> 1))
760ac839
LW
2234# endif
2235#endif
2236
2237#ifdef LONG_MIN
99abf803 2238# define PERL_LONG_MIN ((long)LONG_MIN)
760ac839
LW
2239#else
2240# ifdef MINLONG
99abf803 2241# define PERL_LONG_MIN ((long)MINLONG)
760ac839 2242# else
27d4fb96 2243# define PERL_LONG_MIN (-PERL_LONG_MAX - ((3 & -1) == 3))
760ac839
LW
2244# endif
2245#endif
2246
d7d93a81 2247#ifdef UV_IS_QUAD
99abf803 2248
99abf803 2249# define PERL_UQUAD_MAX (~(UV)0)
f1c3b19a 2250# define PERL_UQUAD_MIN ((UV)0)
99abf803 2251# define PERL_QUAD_MAX ((IV) (PERL_UQUAD_MAX >> 1))
a6e633de 2252# define PERL_QUAD_MIN (-PERL_QUAD_MAX - ((3 & -1) == 3))
27d4fb96 2253
79072805
LW
2254#endif
2255
ee0007ab 2256typedef MEM_SIZE STRLEN;
450a55e4 2257
79072805
LW
2258typedef struct op OP;
2259typedef struct cop COP;
2260typedef struct unop UNOP;
2261typedef struct binop BINOP;
2262typedef struct listop LISTOP;
2263typedef struct logop LOGOP;
79072805
LW
2264typedef struct pmop PMOP;
2265typedef struct svop SVOP;
7934575e 2266typedef struct padop PADOP;
79072805 2267typedef struct pvop PVOP;
79072805
LW
2268typedef struct loop LOOP;
2269
7aef8e5b 2270#ifdef PERL_CORE
8be227ab
FC
2271typedef struct opslab OPSLAB;
2272typedef struct opslot OPSLOT;
2273#endif
2274
52db365a 2275typedef struct block_hooks BHK;
1830b3d9 2276typedef struct custom_op XOP;
52db365a 2277
cd1541b2
NC
2278typedef struct interpreter PerlInterpreter;
2279
d2b3f365 2280/* SGI's <sys/sema.h> has struct sv */
cc3315ba 2281#if defined(__sgi)
d2b3f365 2282# define STRUCT_SV perl_sv
b8d3c5db
JH
2283#else
2284# define STRUCT_SV sv
2285#endif
2286typedef struct STRUCT_SV SV;
79072805
LW
2287typedef struct av AV;
2288typedef struct hv HV;
2289typedef struct cv CV;
d2f13c59 2290typedef struct p5rx REGEXP;
79072805 2291typedef struct gp GP;
0c30d9ec 2292typedef struct gv GV;
8990e307 2293typedef struct io IO;
c09156bb 2294typedef struct context PERL_CONTEXT;
79072805
LW
2295typedef struct block BLOCK;
2296
2297typedef struct magic MAGIC;
2298typedef struct xpv XPV;
2299typedef struct xpviv XPVIV;
ff68c719 2300typedef struct xpvuv XPVUV;
79072805
LW
2301typedef struct xpvnv XPVNV;
2302typedef struct xpvmg XPVMG;
2303typedef struct xpvlv XPVLV;
d361b004 2304typedef struct xpvinvlist XINVLIST;
79072805
LW
2305typedef struct xpvav XPVAV;
2306typedef struct xpvhv XPVHV;
2307typedef struct xpvgv XPVGV;
2308typedef struct xpvcv XPVCV;
2309typedef struct xpvbm XPVBM;
2310typedef struct xpvfm XPVFM;
8990e307 2311typedef struct xpvio XPVIO;
79072805
LW
2312typedef struct mgvtbl MGVTBL;
2313typedef union any ANY;
5f7fde29
GS
2314typedef struct ptr_tbl_ent PTR_TBL_ENT_t;
2315typedef struct ptr_tbl PTR_TBL_t;
8cf8f3d1
NIS
2316typedef struct clone_params CLONE_PARAMS;
2317
35e035cc 2318/* a pad or name pad is currently just an AV; but that might change,
7261499d
FC
2319 * so hide the type. */
2320typedef struct padlist PADLIST;
67634234 2321typedef AV PAD;
35e035cc
FC
2322typedef AV PADNAMELIST;
2323typedef SV PADNAME;
67634234 2324
13b0f67d
DM
2325/* enable PERL_NEW_COPY_ON_WRITE by default */
2326#if !defined(PERL_OLD_COPY_ON_WRITE) && !defined(PERL_NEW_COPY_ON_WRITE) && !defined(PERL_NO_COW)
2327# define PERL_NEW_COPY_ON_WRITE
2328#endif
07d01d6e 2329
db2c6cb3
FC
2330#if defined(PERL_OLD_COPY_ON_WRITE) || defined(PERL_NEW_COPY_ON_WRITE)
2331# if defined(PERL_OLD_COPY_ON_WRITE) && defined(PERL_NEW_COPY_ON_WRITE)
2332# error PERL_OLD_COPY_ON_WRITE and PERL_NEW_COPY_ON_WRITE are exclusive
2333# else
2334# define PERL_ANY_COW
2335# endif
9f351b45
DM
2336#else
2337# define PERL_SAWAMPERSAND
db2c6cb3
FC
2338#endif
2339
378cc40b 2340#include "handy.h"
a0d0e21e 2341
6b8eaf93 2342#if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_RAWIO)
6b8eaf93
JH
2343# if LSEEKSIZE == 8 && !defined(USE_64_BIT_RAWIO)
2344# define USE_64_BIT_RAWIO /* implicit */
2345# endif
4564133c
JH
2346#endif
2347
6b8eaf93
JH
2348/* Notice the use of HAS_FSEEKO: now we are obligated to always use
2349 * fseeko/ftello if possible. Don't go #defining ftell to ftello yourself,
2350 * however, because operating systems like to do that themself. */
2351#ifndef FSEEKSIZE
2352# ifdef HAS_FSEEKO
2353# define FSEEKSIZE LSEEKSIZE
2354# else
2355# define FSEEKSIZE LONGSIZE
d460ef45 2356# endif
6b8eaf93
JH
2357#endif
2358
2359#if defined(USE_LARGE_FILES) && !defined(NO_64_BIT_STDIO)
6b8eaf93
JH
2360# if FSEEKSIZE == 8 && !defined(USE_64_BIT_STDIO)
2361# define USE_64_BIT_STDIO /* implicit */
2362# endif
2363#endif
4564133c 2364
09458382 2365#ifdef USE_64_BIT_RAWIO
d9b3e12d
JH
2366# ifdef HAS_OFF64_T
2367# undef Off_t
2368# define Off_t off64_t
2369# undef LSEEKSIZE
2370# define LSEEKSIZE 8
5ff3f7a4 2371# endif
d9b3e12d
JH
2372/* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2373 * will trigger defines like the ones below. Some 64-bit environments,
09458382 2374 * however, do not. Therefore we have to explicitly mix and match. */
d9b3e12d
JH
2375# if defined(USE_OPEN64)
2376# define open open64
5ff3f7a4 2377# endif
d9b3e12d
JH
2378# if defined(USE_LSEEK64)
2379# define lseek lseek64
6b8eaf93
JH
2380# else
2381# if defined(USE_LLSEEK)
2382# define lseek llseek
2383# endif
d9b3e12d
JH
2384# endif
2385# if defined(USE_STAT64)
2386# define stat stat64
2387# endif
2388# if defined(USE_FSTAT64)
2389# define fstat fstat64
2390# endif
2391# if defined(USE_LSTAT64)
2392# define lstat lstat64
2393# endif
2394# if defined(USE_FLOCK64)
2395# define flock flock64
2396# endif
2397# if defined(USE_LOCKF64)
2398# define lockf lockf64
2399# endif
2400# if defined(USE_FCNTL64)
2401# define fcntl fcntl64
2402# endif
2403# if defined(USE_TRUNCATE64)
2404# define truncate truncate64
2405# endif
2406# if defined(USE_FTRUNCATE64)
2407# define ftruncate ftruncate64
2408# endif
2409#endif
2410
2411#ifdef USE_64_BIT_STDIO
2412# ifdef HAS_FPOS64_T
2413# undef Fpos_t
2414# define Fpos_t fpos64_t
2415# endif
2416/* Most 64-bit environments have defines like _LARGEFILE_SOURCE that
2417 * will trigger defines like the ones below. Some 64-bit environments,
2418 * however, do not. */
2419# if defined(USE_FOPEN64)
2420# define fopen fopen64
2421# endif
2422# if defined(USE_FSEEK64)
6b8eaf93 2423# define fseek fseek64 /* don't do fseeko here, see perlio.c */
d9b3e12d
JH
2424# endif
2425# if defined(USE_FTELL64)
6b8eaf93 2426# define ftell ftell64 /* don't do ftello here, see perlio.c */
d9b3e12d
JH
2427# endif
2428# if defined(USE_FSETPOS64)
2429# define fsetpos fsetpos64
2430# endif
2431# if defined(USE_FGETPOS64)
2432# define fgetpos fgetpos64
2433# endif
2434# if defined(USE_TMPFILE64)
2435# define tmpfile tmpfile64
2436# endif
2437# if defined(USE_FREOPEN64)
2438# define freopen freopen64
5ff3f7a4
GS
2439# endif
2440#endif
2441
e37778c2 2442#if defined(OS2)
2c2d71f5
JH
2443# include "iperlsys.h"
2444#endif
2445
748a9306 2446#ifdef DOSISH
19848b3f
JH
2447# if defined(OS2)
2448# include "os2ish.h"
2449# else
2450# include "dosish.h"
2451# endif
009819bb 2452#elif defined(VMS)
748a9306 2453# include "vmsish.h"
009819bb 2454#elif defined(PLAN9)
19848b3f 2455# include "./plan9/plan9ish.h"
009819bb 2456#elif defined(__VOS__)
196918b0
PG
2457# ifdef __GNUC__
2458# include "./vos/vosish.h"
2459# else
2460# include "vos/vosish.h"
2461# endif
009819bb 2462#elif defined(__SYMBIAN32__)
27da23d5 2463# include "symbian/symbianish.h"
009819bb 2464#elif defined(__HAIKU__)
df00ff3b 2465# include "haiku/haikuish.h"
009819bb 2466#else
19848b3f 2467# include "unixish.h"
13b6e58c
JH
2468#endif
2469
2946a158
JH
2470/* NSIG logic from Configure --> */
2471/* Strange style to avoid deeply-nested #if/#else/#endif */
2472#ifndef NSIG
2473# ifdef _NSIG
2474# define NSIG (_NSIG)
2475# endif
2476#endif
2477
2478#ifndef NSIG
2479# ifdef SIGMAX
2480# define NSIG (SIGMAX+1)
2481# endif
2482#endif
2483
2484#ifndef NSIG
2485# ifdef SIG_MAX
2486# define NSIG (SIG_MAX+1)
2487# endif
2488#endif
2489
2490#ifndef NSIG
2491# ifdef _SIG_MAX
2492# define NSIG (_SIG_MAX+1)
2493# endif
2494#endif
2495
2496#ifndef NSIG
2497# ifdef MAXSIG
2498# define NSIG (MAXSIG+1)
2499# endif
2500#endif
2501
2502#ifndef NSIG
2503# ifdef MAX_SIG
2504# define NSIG (MAX_SIG+1)
2505# endif
2506#endif
2507
2508#ifndef NSIG
2509# ifdef SIGARRAYSIZE
2510# define NSIG SIGARRAYSIZE /* Assume ary[SIGARRAYSIZE] */
2511# endif
2512#endif
2513
2514#ifndef NSIG
2515# ifdef _sys_nsig
2516# define NSIG (_sys_nsig) /* Solaris 2.5 */
2517# endif
2518#endif
2519
2520/* Default to some arbitrary number that's big enough to get most
2521 of the common signals.
2522*/
2523#ifndef NSIG
2524# define NSIG 50
2525#endif
2526/* <-- NSIG logic from Configure */
2527
13b6e58c
JH
2528#ifndef NO_ENVIRON_ARRAY
2529# define USE_ENVIRON_ARRAY
2530#endif
32f822de 2531
c77b533b
JH
2532/*
2533 * initialise to avoid floating-point exceptions from overflow, etc
2534 */
2535#ifndef PERL_FPU_INIT
2536# ifdef HAS_FPSETMASK
2537# if HAS_FLOATINGPOINT_H
2538# include <floatingpoint.h>
2539# endif
ad3a8c67
NC
2540/* Some operating systems have this as a macro, which in turn expands to a comma
2541 expression, and the last sub-expression is something that gets calculated,
2542 and then they have the gall to warn that a value computed is not used. Hence
2543 cast to void. */
2544# define PERL_FPU_INIT (void)fpsetmask(0)
c77b533b 2545# else
2f42fcb0 2546# if defined(SIGFPE) && defined(SIG_IGN) && !defined(PERL_MICRO)
7f7c3354 2547# define PERL_FPU_INIT PL_sigfpe_saved = (Sighandler_t) signal(SIGFPE, SIG_IGN)
b35112e7
CS
2548# define PERL_FPU_PRE_EXEC { Sigsave_t xfpe; rsignal_save(SIGFPE, PL_sigfpe_saved, &xfpe);
2549# define PERL_FPU_POST_EXEC rsignal_restore(SIGFPE, &xfpe); }
7014c407
JH
2550# else
2551# define PERL_FPU_INIT
2f42fcb0 2552
7014c407 2553# endif
c77b533b
JH
2554# endif
2555#endif
b35112e7
CS
2556#ifndef PERL_FPU_PRE_EXEC
2557# define PERL_FPU_PRE_EXEC {
2558# define PERL_FPU_POST_EXEC }
2559#endif
c77b533b 2560
cbec8ebe
DM
2561#ifndef PERL_SYS_INIT3_BODY
2562# define PERL_SYS_INIT3_BODY(argvp,argcp,envp) PERL_SYS_INIT_BODY(argvp,argcp)
ed344e4f
IZ
2563#endif
2564
eb533572 2565/*
dcccc8ff
KW
2566=head1 Miscellaneous Functions
2567
4ad9e498 2568=for apidoc Am|void|PERL_SYS_INIT|int *argc|char*** argv
eb533572 2569Provides system-specific tune up of the C runtime environment necessary to
72d33970 2570run Perl interpreters. This should be called only once, before creating
eb533572
DM
2571any Perl interpreters.
2572
4ad9e498 2573=for apidoc Am|void|PERL_SYS_INIT3|int *argc|char*** argv|char*** env
eb533572 2574Provides system-specific tune up of the C runtime environment necessary to
72d33970 2575run Perl interpreters. This should be called only once, before creating
eb533572
DM
2576any Perl interpreters.
2577
2578=for apidoc Am|void|PERL_SYS_TERM|
2579Provides system-specific clean up of the C runtime environment after
72d33970 2580running Perl interpreters. This should be called only once, after
eb533572
DM
2581freeing any remaining Perl interpreters.
2582
2583=cut
2584 */
2585
cbec8ebe
DM
2586#define PERL_SYS_INIT(argc, argv) Perl_sys_init(argc, argv)
2587#define PERL_SYS_INIT3(argc, argv, env) Perl_sys_init3(argc, argv, env)
d0820ef1 2588#define PERL_SYS_TERM() Perl_sys_term()
cbec8ebe 2589
be708cc0
JH
2590#ifndef PERL_WRITE_MSG_TO_CONSOLE
2591# define PERL_WRITE_MSG_TO_CONSOLE(io, msg, len) PerlIO_write(io, msg, len)
2592#endif
2593
0f31cffe
GS
2594#ifndef MAXPATHLEN
2595# ifdef PATH_MAX
b990c8b2
JH
2596# ifdef _POSIX_PATH_MAX
2597# if PATH_MAX > _POSIX_PATH_MAX
09448d78
JH
2598/* POSIX 1990 (and pre) was ambiguous about whether PATH_MAX
2599 * included the null byte or not. Later amendments of POSIX,
2600 * XPG4, the Austin Group, and the Single UNIX Specification
2601 * all explicitly include the null byte in the PATH_MAX.
2602 * Ditto for _POSIX_PATH_MAX. */
2603# define MAXPATHLEN PATH_MAX
b990c8b2 2604# else
09448d78 2605# define MAXPATHLEN _POSIX_PATH_MAX
b990c8b2
JH
2606# endif
2607# else
2608# define MAXPATHLEN (PATH_MAX+1)
2609# endif
0f31cffe 2610# else
d552bce8 2611# define MAXPATHLEN 1024 /* Err on the large side. */
0f31cffe
GS
2612# endif
2613#endif
2614
c80263a8
SH
2615/* In case Configure was not used (we are using a "canned config"
2616 * such as Win32, or a cross-compilation setup, for example) try going
2617 * by the gcc major and minor versions. One useful URL is
2618 * http://www.ohse.de/uwe/articles/gcc-attributes.html,
2619 * but contrary to this information warn_unused_result seems
2620 * not to be in gcc 3.3.5, at least. --jhi
42bf5550
AD
2621 * Also, when building extensions with an installed perl, this allows
2622 * the user to upgrade gcc and get the right attributes, rather than
2623 * relying on the list generated at Configure time. --AD
c80263a8
SH
2624 * Set these up now otherwise we get confused when some of the <*thread.h>
2625 * includes below indirectly pull in <perlio.h> (which needs to know if we
2626 * have HASATTRIBUTE_FORMAT).
2627 */
2628
4d7c7898 2629#ifndef PERL_MICRO
fc2007d4 2630#if defined __GNUC__ && !defined(__INTEL_COMPILER)
6a387721
RGS
2631# if __GNUC__ == 3 && __GNUC_MINOR__ >= 1 || __GNUC__ > 3 /* 3.1 -> */
2632# define HASATTRIBUTE_DEPRECATED
2633# endif
c80263a8
SH
2634# if __GNUC__ >= 3 /* 3.0 -> */ /* XXX Verify this version */
2635# define HASATTRIBUTE_FORMAT
63cdf24b
SH
2636# if defined __MINGW32__
2637# define PRINTF_FORMAT_NULL_OK
2638# endif
c80263a8
SH
2639# endif
2640# if __GNUC__ >= 3 /* 3.0 -> */
2641# define HASATTRIBUTE_MALLOC
2642# endif
2643# if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || __GNUC__ > 3 /* 3.3 -> */
2644# define HASATTRIBUTE_NONNULL
2645# endif
2646# if __GNUC__ == 2 && __GNUC_MINOR__ >= 5 || __GNUC__ > 2 /* 2.5 -> */
2647# define HASATTRIBUTE_NORETURN
2648# endif
2649# if __GNUC__ >= 3 /* gcc 3.0 -> */
2650# define HASATTRIBUTE_PURE
2651# endif
42bf5550 2652# if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
c80263a8
SH
2653# define HASATTRIBUTE_UNUSED
2654# endif
d324fe49
AD
2655# if __GNUC__ == 3 && __GNUC_MINOR__ == 3 && !defined(__cplusplus)
2656# define HASATTRIBUTE_UNUSED /* gcc-3.3, but not g++-3.3. */
2657# endif
c80263a8
SH
2658# if __GNUC__ == 3 && __GNUC_MINOR__ >= 4 || __GNUC__ > 3 /* 3.4 -> */
2659# define HASATTRIBUTE_WARN_UNUSED_RESULT
2660# endif
2661#endif
00f254e2 2662#endif /* #ifndef PERL_MICRO */
c80263a8 2663
3db8f154 2664/* USE_5005THREADS needs to be after unixish.h as <pthread.h> includes
dd96f567 2665 * <sys/signal.h> which defines NSIG - which will stop inclusion of <signal.h>
32f822de
GS
2666 * this results in many functions being undeclared which bothers C++
2667 * May make sense to have threads after "*ish.h" anyway
2668 */
2669
3db8f154 2670#if defined(USE_ITHREADS)
2986a63f
JH
2671# ifdef NETWARE
2672# include <nw5thread.h>
2673# else
32f822de
GS
2674# ifdef WIN32
2675# include <win32thread.h>
2676# else
dd96f567
IZ
2677# ifdef OS2
2678# include "os2thread.h"
2679# else
7f3d1cf1 2680# ifdef I_MACH_CTHREADS
bdd66968 2681# include <mach/cthreads.h>
7f3d1cf1
BH
2682typedef cthread_t perl_os_thread;
2683typedef mutex_t perl_mutex;
2684typedef condition_t perl_cond;
2685typedef void * perl_key;
2686# else /* Posix threads */
1f5ae88c
JH
2687# ifdef I_PTHREAD
2688# include <pthread.h>
2689# endif
7f3d1cf1
BH
2690typedef pthread_t perl_os_thread;
2691typedef pthread_mutex_t perl_mutex;
2692typedef pthread_cond_t perl_cond;
2693typedef pthread_key_t perl_key;
2694# endif /* I_MACH_CTHREADS */
dd96f567 2695# endif /* OS2 */
32f822de 2696# endif /* WIN32 */
ef4abe76 2697# endif /* NETWARE */
3db8f154 2698#endif /* USE_ITHREADS */
c5be433b 2699
66a93824 2700#if defined(WIN32)
1feb2720 2701# include "win32.h"
c5be433b
GS
2702#endif
2703
2986a63f
JH
2704#ifdef NETWARE
2705# include "netware.h"
2706#endif
2707
e5218da5 2708#define STATUS_UNIX PL_statusvalue
68dc0745 2709#ifdef VMS
6b88bc9c 2710# define STATUS_NATIVE PL_statusvalue_vms
7a7fd8e0
JM
2711/*
2712 * vaxc$errno is only guaranteed to be valid if errno == EVMSERR, otherwise
ff7298cb 2713 * its contents can not be trusted. Unfortunately, Perl seems to check
7a7fd8e0
JM
2714 * it on exit, so it when PL_statusvalue_vms is updated, vaxc$errno should
2715 * be updated also.
2716 */
2717# include <stsdef.h>
2718# include <ssdef.h>
2719/* Presume this because if VMS changes it, it will require a new
2720 * set of APIs for waiting on children for binary compatibility.
2721 */
2722# define child_offset_bits (8)
2723# ifndef C_FAC_POSIX
2724# define C_FAC_POSIX 0x35A000
2725# endif
2726
2727/* STATUS_EXIT - validates and returns a NATIVE exit status code for the
2728 * platform from the existing UNIX or Native status values.
2729 */
2730
37038d91 2731# define STATUS_EXIT \
7a7fd8e0
JM
2732 (((I32)PL_statusvalue_vms == -1 ? SS$_ABORT : PL_statusvalue_vms) | \
2733 (VMSISH_HUSHED ? STS$M_INHIB_MSG : 0))
2734
7a7fd8e0 2735
fb38d079
JM
2736/* STATUS_NATIVE_CHILD_SET - Calculate UNIX status that matches the child
2737 * exit code and shifts the UNIX value over the correct number of bits to
2738 * be a child status. Usually the number of bits is 8, but that could be
2739 * platform dependent. The NATIVE status code is presumed to have either
2740 * from a child process.
7a7fd8e0
JM
2741 */
2742
fb38d079
JM
2743/* This is complicated. The child processes return a true native VMS
2744 status which must be saved. But there is an assumption in Perl that
2745 the UNIX child status has some relationship to errno values, so
00f254e2 2746 Perl tries to translate it to text in some of the tests.
fb38d079
JM
2747 In order to get the string translation correct, for the error, errno
2748 must be EVMSERR, but that generates a different text message
2749 than what the test programs are expecting. So an errno value must
2750 be derived from the native status value when an error occurs.
2751 That will hide the true native status message. With this version of
2752 perl, the true native child status can always be retrieved so that
2753 is not a problem. But in this case, Pl_statusvalue and errno may
2754 have different values in them.
2755 */
7a7fd8e0 2756
fb38d079 2757# define STATUS_NATIVE_CHILD_SET(n) \
68dc0745 2758 STMT_START { \
2fbb330f
JM
2759 I32 evalue = (I32)n; \
2760 if (evalue == EVMSERR) { \
2761 PL_statusvalue_vms = vaxc$errno; \
2762 PL_statusvalue = evalue; \
7a7fd8e0 2763 } else { \
2fbb330f 2764 PL_statusvalue_vms = evalue; \
fb38d079 2765 if (evalue == -1) { \
3280af22 2766 PL_statusvalue = -1; \
7a7fd8e0
JM
2767 PL_statusvalue_vms = SS$_ABORT; /* Should not happen */ \
2768 } else \
fb38d079 2769 PL_statusvalue = Perl_vms_status_to_unix(evalue, 1); \
2fbb330f 2770 set_vaxc_errno(evalue); \
fb38d079
JM
2771 if ((PL_statusvalue_vms & C_FAC_POSIX) == C_FAC_POSIX) \
2772 set_errno(EVMSERR); \
2773 else set_errno(Perl_vms_status_to_unix(evalue, 0)); \
2774 PL_statusvalue = PL_statusvalue << child_offset_bits; \
2fbb330f 2775 } \
68dc0745 2776 } STMT_END
7a7fd8e0 2777
68dc0745 2778# ifdef VMSISH_STATUS
e5218da5 2779# define STATUS_CURRENT (VMSISH_STATUS ? STATUS_NATIVE : STATUS_UNIX)
68dc0745 2780# else
e5218da5 2781# define STATUS_CURRENT STATUS_UNIX
68dc0745 2782# endif
7a7fd8e0
JM
2783
2784 /* STATUS_UNIX_SET - takes a UNIX/POSIX errno value and attempts to update
2785 * the NATIVE status to an equivalent value. Can not be used to translate
2786 * exit code values as exit code values are not guaranteed to have any
2787 * relationship at all to errno values.
2788 * This is used when Perl is forcing errno to have a specific value.
2789 */
e5218da5 2790# define STATUS_UNIX_SET(n) \
68dc0745 2791 STMT_START { \
7a7fd8e0 2792 I32 evalue = (I32)n; \
0968cdad 2793 PL_statusvalue = evalue; \
3280af22 2794 if (PL_statusvalue != -1) { \
0968cdad
JM
2795 if (PL_statusvalue != EVMSERR) { \
2796 PL_statusvalue &= 0xFFFF; \
2797 if (MY_POSIX_EXIT) \
2798 PL_statusvalue_vms=PL_statusvalue ? SS$_ABORT : SS$_NORMAL;\
2799 else PL_statusvalue_vms = Perl_unix_status_to_vms(evalue); \
2800 } \
2801 else { \
2802 PL_statusvalue_vms = vaxc$errno; \
2803 } \
68dc0745 2804 } \
0968cdad
JM
2805 else PL_statusvalue_vms = SS$_ABORT; \
2806 set_vaxc_errno(PL_statusvalue_vms); \
7a7fd8e0
JM
2807 } STMT_END
2808
2809 /* STATUS_UNIX_EXIT_SET - Takes a UNIX/POSIX exit code and sets
e08e1e1d
JM
2810 * the NATIVE error status based on it.
2811 *
2812 * When in the default mode to comply with the Perl VMS documentation,
2813 * 0 is a success and any other code sets the NATIVE status to a failure
2814 * code of SS$_ABORT.
fb38d079
JM
2815 *
2816 * In the new POSIX EXIT mode, native status will be set so that the
2817 * actual exit code will can be retrieved by the calling program or
2818 * shell.
2819 *
2820 * If the exit code is not clearly a UNIX parent or child exit status,
2821 * it will be passed through as a VMS status.
7a7fd8e0
JM
2822 */
2823
fb38d079 2824# define STATUS_UNIX_EXIT_SET(n) \
7a7fd8e0
JM
2825 STMT_START { \
2826 I32 evalue = (I32)n; \
2827 PL_statusvalue = evalue; \
e08e1e1d
JM
2828 if (MY_POSIX_EXIT) { \
2829 if (evalue <= 0xFF00) { \
2830 if (evalue > 0xFF) \
2831 evalue = (evalue >> child_offset_bits) & 0xFF; \
2832 PL_statusvalue_vms = \
2833 (C_FAC_POSIX | (evalue << 3 ) | \
2834 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1)); \
2835 } else /* forgive them Perl, for they have sinned */ \
2836 PL_statusvalue_vms = evalue; \
2837 } else { \
2838 if (evalue == 0) \
2839 PL_statusvalue_vms = SS$_NORMAL; \
2840 else if (evalue <= 0xFF00) \
2841 PL_statusvalue_vms = SS$_ABORT; \
2842 else { /* forgive them Perl, for they have sinned */ \
2843 if (evalue != EVMSERR) PL_statusvalue_vms = evalue; \
2844 else PL_statusvalue_vms = vaxc$errno; \
2845 /* And obviously used a VMS status value instead of UNIX */ \
2846 PL_statusvalue = EVMSERR; \
2847 } \
2848 set_vaxc_errno(PL_statusvalue_vms); \
2849 } \
68dc0745 2850 } STMT_END
fb38d079 2851
e08e1e1d 2852
6ac6a52b
JM
2853 /* STATUS_EXIT_SET - Takes a NATIVE/UNIX/POSIX exit code
2854 * and sets the NATIVE error status based on it. This special case
2855 * is needed to maintain compatibility with past VMS behavior.
2856 *
2857 * In the default mode on VMS, this number is passed through as
2858 * both the NATIVE and UNIX status. Which makes it different
2859 * that the STATUS_UNIX_EXIT_SET.
2860 *
2861 * In the new POSIX EXIT mode, native status will be set so that the
2862 * actual exit code will can be retrieved by the calling program or
2863 * shell.
2864 *
1a3aec58
JM
2865 * A POSIX exit code is from 0 to 255. If the exit code is higher
2866 * than this, it needs to be assumed that it is a VMS exit code and
2867 * passed through.
6ac6a52b
JM
2868 */
2869
2870# define STATUS_EXIT_SET(n) \
2871 STMT_START { \
2872 I32 evalue = (I32)n; \
2873 PL_statusvalue = evalue; \
2874 if (MY_POSIX_EXIT) \
1a3aec58
JM
2875 if (evalue > 255) PL_statusvalue_vms = evalue; else { \
2876 PL_statusvalue_vms = \
2877 (C_FAC_POSIX | (evalue << 3 ) | \
2878 ((evalue == 1) ? (STS$K_ERROR | STS$M_INHIB_MSG) : 1));} \
6ac6a52b
JM
2879 else \
2880 PL_statusvalue_vms = evalue ? evalue : SS$_NORMAL; \
2881 set_vaxc_errno(PL_statusvalue_vms); \
2882 } STMT_END
2883
fb38d079
JM
2884
2885 /* This macro forces a success status */
7a7fd8e0
JM
2886# define STATUS_ALL_SUCCESS \
2887 (PL_statusvalue = 0, PL_statusvalue_vms = SS$_NORMAL)
fb38d079
JM
2888
2889 /* This macro forces a failure status */
7a7fd8e0
JM
2890# define STATUS_ALL_FAILURE (PL_statusvalue = 1, \
2891 vaxc$errno = PL_statusvalue_vms = MY_POSIX_EXIT ? \
2892 (C_FAC_POSIX | (1 << 3) | STS$K_ERROR | STS$M_INHIB_MSG) : SS$_ABORT)
fb38d079 2893
68dc0745 2894#else
e5218da5 2895# define STATUS_NATIVE PL_statusvalue_posix
e5218da5 2896# if defined(WCOREDUMP)
37038d91 2897# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA
2898 STMT_START { \
2899 PL_statusvalue_posix = (n); \
2900 if (PL_statusvalue_posix == -1) \
2901 PL_statusvalue = -1; \
2902 else { \
2903 PL_statusvalue = \
2904 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
2905 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0) | \
2906 (WIFSIGNALED(PL_statusvalue_posix) && WCOREDUMP(PL_statusvalue_posix) ? 0x80 : 0); \
2907 } \
2908 } STMT_END
2909# elif defined(WIFEXITED)
37038d91 2910# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA
2911 STMT_START { \
2912 PL_statusvalue_posix = (n); \
2913 if (PL_statusvalue_posix == -1) \
2914 PL_statusvalue = -1; \
2915 else { \
2916 PL_statusvalue = \
2917 (WIFEXITED(PL_statusvalue_posix) ? (WEXITSTATUS(PL_statusvalue_posix) << 8) : 0) | \
2918 (WIFSIGNALED(PL_statusvalue_posix) ? (WTERMSIG(PL_statusvalue_posix) & 0x7F) : 0); \
2919 } \
2920 } STMT_END
2921# else
37038d91 2922# define STATUS_NATIVE_CHILD_SET(n) \
e5218da5
GA
2923 STMT_START { \
2924 PL_statusvalue_posix = (n); \
2925 if (PL_statusvalue_posix == -1) \
2926 PL_statusvalue = -1; \
2927 else { \
2928 PL_statusvalue = \
2929 PL_statusvalue_posix & 0xFFFF; \
2930 } \
2931 } STMT_END
2932# endif
2933# define STATUS_UNIX_SET(n) \
68dc0745 2934 STMT_START { \
3280af22
NIS
2935 PL_statusvalue = (n); \
2936 if (PL_statusvalue != -1) \
2937 PL_statusvalue &= 0xFFFF; \
68dc0745 2938 } STMT_END
7a7fd8e0 2939# define STATUS_UNIX_EXIT_SET(n) STATUS_UNIX_SET(n)
6ac6a52b 2940# define STATUS_EXIT_SET(n) STATUS_UNIX_SET(n)
e5218da5 2941# define STATUS_CURRENT STATUS_UNIX
37038d91 2942# define STATUS_EXIT STATUS_UNIX
e5218da5
GA
2943# define STATUS_ALL_SUCCESS (PL_statusvalue = 0, PL_statusvalue_posix = 0)
2944# define STATUS_ALL_FAILURE (PL_statusvalue = 1, PL_statusvalue_posix = 1)
68dc0745
PP
2945#endif
2946
cc3604b1
GS
2947/* flags in PL_exit_flags for nature of exit() */
2948#define PERL_EXIT_EXPECTED 0x01
31d77e54 2949#define PERL_EXIT_DESTRUCT_END 0x02 /* Run END in perl_destruct */
6136213b
JGM
2950#define PERL_EXIT_WARN 0x04 /* Warn if Perl_my_exit() or Perl_my_failure_exit() called */
2951#define PERL_EXIT_ABORT 0x08 /* Call abort() if Perl_my_exit() or Perl_my_failure_exit() called */
cc3604b1 2952
b79b76e0 2953#ifndef PERL_CORE
a7cb1f99 2954/* format to use for version numbers in file/directory names */
273cf8d1 2955/* XXX move to Configure? */
b79b76e0
NC
2956/* This was only ever used for the current version, and that can be done at
2957 compile time, as PERL_FS_VERSION, so should we just delete it? */
2958# ifndef PERL_FS_VER_FMT
2959# define PERL_FS_VER_FMT "%d.%d.%d"
2960# endif
2961#endif
2962
2963#ifndef PERL_FS_VERSION
2964# define PERL_FS_VERSION PERL_VERSION_STRING
0b94c7bb
GS
2965#endif
2966
45bc9206 2967/* This defines a way to flush all output buffers. This may be a
76549fef
JH
2968 * performance issue, so we allow people to disable it. Also, if
2969 * we are using stdio, there are broken implementations of fflush(NULL)
2970 * out there, Solaris being the most prominent.
45bc9206
GS
2971 */
2972#ifndef PERL_FLUSHALL_FOR_CHILD
97cb92d6 2973# if defined(USE_PERLIO) || defined(FFLUSH_NULL)
66fe083f 2974# define PERL_FLUSHALL_FOR_CHILD PerlIO_flush((PerlIO*)NULL)
767df6a1
JH
2975# else
2976# ifdef FFLUSH_ALL
2977# define PERL_FLUSHALL_FOR_CHILD my_fflush_all()
e2dbf222 2978# else
c5be433b 2979# define PERL_FLUSHALL_FOR_CHILD NOOP
767df6a1 2980# endif
66fe083f 2981# endif
45bc9206
GS
2982#endif
2983
7766f137
GS
2984#ifndef PERL_WAIT_FOR_CHILDREN
2985# define PERL_WAIT_FOR_CHILDREN NOOP
2986#endif
2987
ba869deb 2988/* the traditional thread-unsafe notion of "current interpreter". */
c5be433b
GS
2989#ifndef PERL_SET_INTERP
2990# define PERL_SET_INTERP(i) (PL_curinterp = (PerlInterpreter*)(i))
2991#endif
2992
2993#ifndef PERL_GET_INTERP
2994# define PERL_GET_INTERP (PL_curinterp)
2995#endif
2996
54aff467 2997#if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_GET_THX)
54aff467 2998# ifdef MULTIPLICITY
ba869deb 2999# define PERL_GET_THX ((PerlInterpreter *)PERL_GET_CONTEXT)
54aff467 3000# endif
ba869deb
GS
3001# define PERL_SET_THX(t) PERL_SET_CONTEXT(t)
3002#endif
3003
00f254e2 3004/*
8896765a 3005 This replaces the previous %_ "hack" by the "%p" hacks.
0dbb1585 3006 All that is required is that the perl source does not
00f254e2
KW
3007 use "%-p" or "%-<number>p" or "%<number>p" formats.
3008 These formats will still work in perl code.
486ec47a 3009 See comments in sv.c for further details.
8896765a 3010
8896765a 3011 Robin Barker 2005-07-14
f46d31f2 3012
00f254e2 3013 No longer use %1p for VDf = %vd. RMB 2007-10-19
0dbb1585 3014*/
8896765a
RB
3015
3016#ifndef SVf_
63ce7bf0 3017# define SVf_(n) "-" STRINGIFY(n) "p"
894356b3
GS
3018#endif
3019
8896765a 3020#ifndef SVf
104abab4 3021# define SVf "-p"
d2560b70
RB
3022#endif
3023
014ead4b 3024#ifndef SVf32
8896765a 3025# define SVf32 SVf_(32)
014ead4b
RB
3026#endif
3027
3028#ifndef SVf256
8896765a
RB
3029# define SVf256 SVf_(256)
3030#endif
3031
be2597df
MHM
3032#define SVfARG(p) ((void*)(p))
3033
20023040
FC
3034#ifndef HEKf
3035# define HEKf "2p"
3036#endif
3037
b8fa5213
FC
3038/* Not ideal, but we cannot easily include a number in an already-numeric
3039 * format sequence. */
3040#ifndef HEKf256
3041# define HEKf256 "3p"
3042#endif
3043
20023040
FC
3044#define HEKfARG(p) ((void*)(p))
3045
b17a0679
FC
3046/* Takes three arguments: is_utf8, length, str */
3047#ifndef UTF8f
61608bb7 3048# define UTF8f "d%" UVuf "%4p"
b17a0679
FC
3049#endif
3050#define UTF8fARG(u,l,p) (int)cBOOL(u), (UV)(l), (void*)(p)
3051
f46d31f2 3052#ifdef PERL_CORE
486ec47a 3053/* not used; but needed for backward compatibility with XS code? - RMB */
7776bb98
RB
3054# undef UVf
3055#else
170cd9e9
NC
3056# ifndef UVf
3057# define UVf UVuf
3058# endif
d2560b70
RB
3059#endif
3060
fcdf39cf
RGS
3061#ifdef HASATTRIBUTE_DEPRECATED
3062# define __attribute__deprecated__ __attribute__((deprecated))
3063#endif
0dbb1585
AL
3064#ifdef HASATTRIBUTE_FORMAT
3065# define __attribute__format__(x,y,z) __attribute__((format(x,y,z)))
3066#endif
3067#ifdef HASATTRIBUTE_MALLOC
77785eea 3068# define __attribute__malloc__ __attribute__((__malloc__))
f22be1b8 3069#endif
0dbb1585 3070#ifdef HASATTRIBUTE_NONNULL
abb2c242 3071# define __attribute__nonnull__(a) __attribute__((nonnull(a)))
f22be1b8 3072#endif
0dbb1585 3073#ifdef HASATTRIBUTE_NORETURN
abb2c242 3074# define __attribute__noreturn__ __attribute__((noreturn))
f22be1b8 3075#endif
0dbb1585 3076#ifdef HASATTRIBUTE_PURE
abb2c242 3077# define __attribute__pure__ __attribute__((pure))
f22be1b8 3078#endif
0dbb1585
AL
3079#ifdef HASATTRIBUTE_UNUSED
3080# define __attribute__unused__ __attribute__((unused))
3081#endif
3082#ifdef HASATTRIBUTE_WARN_UNUSED_RESULT
abb2c242 3083# define __attribute__warn_unused_result__ __attribute__((warn_unused_result))
f22be1b8
JH
3084#endif
3085
0dbb1585 3086/* If we haven't defined the attributes yet, define them to blank. */
fcdf39cf
RGS
3087#ifndef __attribute__deprecated__
3088# define __attribute__deprecated__
3089#endif
0dbb1585
AL
3090#ifndef __attribute__format__
3091# define __attribute__format__(x,y,z)
3092#endif
f22be1b8 3093#ifndef __attribute__malloc__
abb2c242 3094# define __attribute__malloc__
f22be1b8
JH
3095#endif
3096#ifndef __attribute__nonnull__
abb2c242 3097# define __attribute__nonnull__(a)
f22be1b8
JH
3098#endif
3099#ifndef __attribute__noreturn__
abb2c242 3100# define __attribute__noreturn__
f22be1b8
JH
3101#endif
3102#ifndef __attribute__pure__
abb2c242 3103# define __attribute__pure__
f22be1b8 3104#endif
0dbb1585
AL
3105#ifndef __attribute__unused__
3106# define __attribute__unused__
3107#endif
f22be1b8 3108#ifndef __attribute__warn_unused_result__
abb2c242
JH
3109# define __attribute__warn_unused_result__
3110#endif
3111
cd13e623
JH
3112#if defined(DEBUGGING) && defined(I_ASSERT)
3113# include <assert.h>
3114#endif
3115
0dbb1585
AL
3116/* For functions that are marked as __attribute__noreturn__, it's not
3117 appropriate to call return. In either case, include the lint directive.
3118 */
3119#ifdef HASATTRIBUTE_NORETURN
ae103e09 3120# define NORETURN_FUNCTION_END NOT_REACHED; /* NOTREACHED */
0dbb1585 3121#else
ae103e09 3122# define NORETURN_FUNCTION_END NOT_REACHED; /* NOTREACHED */ return 0
abb2c242
JH
3123#endif
3124
cdfeb707
RB
3125/* Some OS warn on NULL format to printf */
3126#ifdef PRINTF_FORMAT_NULL_OK
3127# define __attribute__format__null_ok__(x,y,z) __attribute__format__(x,y,z)
3128#else
00f254e2 3129# define __attribute__format__null_ok__(x,y,z)
cdfeb707
RB
3130#endif
3131
635aebb7 3132#ifdef HAS_BUILTIN_EXPECT
b37c2d43
AL
3133# define EXPECT(expr,val) __builtin_expect(expr,val)
3134#else
3135# define EXPECT(expr,val) (expr)
3136#endif
6d5abc62
NC
3137#define LIKELY(cond) EXPECT(cBOOL(cond),TRUE)
3138#define UNLIKELY(cond) EXPECT(cBOOL(cond),FALSE)
635aebb7
AL
3139#ifdef HAS_BUILTIN_CHOOSE_EXPR
3140/* placeholder */
3141#endif
b37c2d43 3142
ae103e09
DD
3143
3144#ifndef __has_builtin
3145# define __has_builtin(x) 0 /* not a clang style compiler */
3146#endif
3147
3148/* ASSUME is like assert(), but it has a benefit in a release build. It is a
3149 hint to a compiler about a statement of fact in a function call free
3150 expression, which allows the compiler to generate better machine code.
3151 In a debug build, ASSUME(x) is a synonym for assert(x). ASSUME(0) means
3152 the control path is unreachable. In a for loop, ASSUME can be used to hint
3153 that a loop will run atleast X times. ASSUME is based off MSVC's __assume
3154 intrinsic function, see its documents for more details.
3155*/
3156
3157#ifndef DEBUGGING
3158# if __has_builtin(__builtin_unreachable) \
3159 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5 || __GNUC__ > 5) /* 4.5 -> */
3160# define ASSUME(x) ((x) ? (void) 0 : __builtin_unreachable())
3161# elif defined(_MSC_VER)
3162# define ASSUME(x) __assume(x)
3163# elif defined(__ARMCC_VERSION) /* untested */
3164# define ASSUME(x) __promise(x)
3165# else
3166/* a random compiler might define assert to its own special optimization token
3167 so pass it through to C lib as a last resort */
3168# define ASSUME(x) assert(x)
3169# endif
3170#else
3171# define ASSUME(x) assert(x)
3172#endif
3173
3174#define NOT_REACHED ASSUME(0)
3175
3fc1aec6
PP
3176/* Some unistd.h's give a prototype for pause() even though
3177 HAS_PAUSE ends up undefined. This causes the #define
d2560b70 3178 below to be rejected by the compiler. Sigh.
3fc1aec6
PP
3179*/
3180#ifdef HAS_PAUSE
3181#define Pause pause
3182#else
3183#define Pause() sleep((32767<<16)+32767)
748a9306
LW
3184#endif
3185
3186#ifndef IOCPARM_LEN
3187# ifdef IOCPARM_MASK
61f1c44b 3188 /* on BSDish systems we're safe */
748a9306
LW
3189# define IOCPARM_LEN(x) (((x) >> 16) & IOCPARM_MASK)
3190# else
61f1c44b 3191# if defined(_IOC_SIZE) && defined(__GLIBC__)
301eb2f0
GA
3192 /* on Linux systems we're safe; except when we're not [perl #38223] */
3193# define IOCPARM_LEN(x) (_IOC_SIZE(x) < 256 ? 256 : _IOC_SIZE(x))
61f1c44b 3194# else
748a9306 3195 /* otherwise guess at what's safe */
61f1c44b
JVD
3196# define IOCPARM_LEN(x) 256
3197# endif
748a9306 3198# endif
a0d0e21e
LW
3199#endif
3200
1761cee5 3201#if defined(__CYGWIN__)
521e0776
GS
3202/* USEMYBINMODE
3203 * This symbol, if defined, indicates that the program should
16fe6d59 3204 * use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
521e0776
GS
3205 * that a file is in "binary" mode -- that is, that no translation
3206 * of bytes occurs on read or write operations.
3207 */
36894f0b 3208# define USEMYBINMODE /**/
77a40698 3209# include <io.h> /* for setmode() prototype */
16fe6d59 3210# define my_binmode(fp, iotype, mode) \
77a40698 3211 (PerlLIO_setmode(fileno(fp), mode) != -1 ? TRUE : FALSE)
5aabfad6
PP
3212#endif
3213
88d10794
JH
3214#ifdef __CYGWIN__
3215void init_os_extras(void);
3216#endif
3217
cea2e8a9
GS
3218#ifdef UNION_ANY_DEFINITION
3219UNION_ANY_DEFINITION;
3220#else
3221union any {
3222 void* any_ptr;
3223 I32 any_i32;
ae103e09 3224 U32 any_u32;
cea2e8a9 3225 IV any_iv;
c6bf6a65 3226 UV any_uv;
cea2e8a9 3227 long any_long;
9febdf04 3228 bool any_bool;
c76ac1ee 3229 void (*any_dptr) (void*);
acfe0abc 3230 void (*any_dxptr) (pTHX_ void*);
cea2e8a9
GS
3231};
3232#endif
3233
acfe0abc 3234typedef I32 (*filter_t) (pTHX_ int, SV *, int);
cea2e8a9
GS
3235
3236#define FILTER_READ(idx, sv, len) filter_read(idx, sv, len)
5486870f
DM
3237#define FILTER_DATA(idx) \
3238 (PL_parser ? AvARRAY(PL_parser->rsfp_filters)[idx] : NULL)
3239#define FILTER_ISREADER(idx) \
3240 (PL_parser && PL_parser->rsfp_filters \
3241 && idx >= AvFILLp(PL_parser->rsfp_filters))
3242#define PERL_FILTER_EXISTS(i) \
3243 (PL_parser && PL_parser->rsfp_filters \
b9f2b683 3244 && (i) <= av_tindex(PL_parser->rsfp_filters))
cea2e8a9 3245
c5078cac
JH
3246#if defined(_AIX) && !defined(_AIX43)
3247#if defined(USE_REENTRANT) || defined(_REENTRANT) || defined(_THREAD_SAFE)
3248/* We cannot include <crypt.h> to get the struct crypt_data
3249 * because of setkey prototype problems when threading */
3250typedef struct crypt_data { /* straight from /usr/include/crypt.h */
3251 /* From OSF, Not needed in AIX
3252 char C[28], D[28];
3253 */
3254 char E[48];
3255 char KS[16][48];
3256 char block[66];
3257 char iobuf[16];
3258} CRYPTD;
3259#endif /* threading */
3260#endif /* AIX */
3261
e37778c2 3262#if !defined(OS2)
2c2d71f5
JH
3263# include "iperlsys.h"
3264#endif
504f80c1 3265
9c12f1e5 3266#ifdef __LIBCATAMOUNT__
00f254e2 3267#undef HAS_PASSWD /* unixish.h but not unixish enough. */
9c12f1e5
RGS
3268#undef HAS_GROUP
3269#define FAKE_BIT_BUCKET
3270#endif
3271
d10dc2ae
JH
3272/* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0.
3273 * Note that the USE_HASH_SEED and USE_HASH_SEED_EXPLICIT are *NOT*
3274 * defined by Configure, despite their names being similar to the
3275 * other defines like USE_ITHREADS. Configure in fact knows nothing
3276 * about the randomised hashes. Therefore to enable/disable the hash
3277 * randomisation defines use the Configure -Accflags=... instead. */
504f80c1 3278#if !defined(NO_HASH_SEED) && !defined(USE_HASH_SEED) && !defined(USE_HASH_SEED_EXPLICIT)
4546b9e6 3279# define USE_HASH_SEED
504f80c1
JH
3280#endif
3281
598921a7
NC
3282/* Win32 defines a type 'WORD' in windef.h. This conflicts with the enumerator
3283 * 'WORD' defined in perly.h. The yytokentype enum is only a debugging aid, so
3284 * it's not really needed.
3285 */
3286#if defined(WIN32)
3287# define YYTOKENTYPE
3288#endif
3289#include "perly.h"
3290
598921a7 3291
654eccd5
JD
3292/* macros to define bit-fields in structs. */
3293#ifndef PERL_BITFIELD8
3294# define PERL_BITFIELD8 unsigned
3295#endif
3296#ifndef PERL_BITFIELD16
3297# define PERL_BITFIELD16 unsigned
3298#endif
3299#ifndef PERL_BITFIELD32
3300# define PERL_BITFIELD32 unsigned
3301#endif
3302
79072805 3303#include "sv.h"
288b8c02 3304#include "regexp.h"
378cc40b 3305#include "util.h"
8d063cd8 3306#include "form.h"
79072805 3307#include "gv.h"
dd2155a4 3308#include "pad.h"
79072805 3309#include "cv.h"
abdd5c84 3310#include "opnames.h"
79072805 3311#include "op.h"
b3ca2e83 3312#include "hv.h"
79072805
LW
3313#include "cop.h"
3314#include "av.h"
79072805
LW
3315#include "mg.h"
3316#include "scope.h"
4438c4b7 3317#include "warnings.h"
a0ed51b3 3318#include "utf8.h"
8d063cd8 3319
0d7d409d
DM
3320/* these would be in doio.h if there was such a file */
3321#define my_stat() my_stat_flags(SV_GMAGIC)
3322#define my_lstat() my_lstat_flags(SV_GMAGIC)
3323
20f4945e 3324/* defined in sv.c, but also used in [ach]v.c */
20f4945e
MHM
3325#undef _XPV_HEAD
3326#undef _XPVMG_HEAD
3327#undef _XPVCV_COMMON
7fae4e64
GS
3328
3329typedef struct _sublex_info SUBLEXINFO;
3330struct _sublex_info {
651b5b28
NC
3331 U8 super_state; /* lexer state to save */
3332 U16 sub_inwhat; /* "lex_inwhat" to use */
7fae4e64 3333 OP *sub_op; /* "lex_op" to use */
7cc34111 3334 SV *repl; /* replacement of s/// or y/// */
7fae4e64
GS
3335};
3336
199e78b7
DM
3337#include "parser.h"
3338
455ece5e 3339typedef struct magic_state MGS; /* struct magic_state defined in mg.c */
76e3520e 3340
2260ab51
KW
3341#if defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
3342
3343/* These have to be predeclared, as they are used in proto.h which is #included
3344 * before their definitions in regcomp.h. */
3345
3346struct scan_data_t;
7dcac5f6
KW
3347typedef struct regnode_charclass regnode_charclass;
3348
2260ab51 3349struct regnode_charclass_class;
d1d040e5
KW
3350
3351/* A hopefully less confusing name. The sub-classes are all Posix classes only
3352 * used under /l matching */
3353typedef struct regnode_charclass_class regnode_charclass_posixl;
3354
b8f7bb16 3355typedef struct regnode_ssc regnode_ssc;
09b2b2e6
KW
3356typedef struct RExC_state_t RExC_state_t;
3357struct _reg_trie_data;
76e3520e 3358
2260ab51
KW
3359#endif
3360
5f7fde29
GS
3361struct ptr_tbl_ent {
3362 struct ptr_tbl_ent* next;
53c1dcc0 3363 const void* oldval;
5f7fde29 3364 void* newval;
d18c6117
GS
3365};
3366
5f7fde29
GS
3367struct ptr_tbl {
3368 struct ptr_tbl_ent** tbl_ary;
3369 UV tbl_max;
3370 UV tbl_items;
db93c0c4
NC
3371 struct ptr_tbl_arena *tbl_arena;
3372 struct ptr_tbl_ent *tbl_arena_next;
3373 struct ptr_tbl_ent *tbl_arena_end;
d18c6117
GS
3374};
3375
fe14fcc3
LW
3376#if defined(htonl) && !defined(HAS_HTONL)
3377#define HAS_HTONL
ae986130 3378#endif
fe14fcc3
LW
3379#if defined(htons) && !defined(HAS_HTONS)
3380#define HAS_HTONS
ae986130 3381#endif
fe14fcc3
LW
3382#if defined(ntohl) && !defined(HAS_NTOHL)
3383#define HAS_NTOHL
ae986130 3384#endif
fe14fcc3
LW
3385#if defined(ntohs) && !defined(HAS_NTOHS)
3386#define HAS_NTOHS
ae986130 3387#endif
fe14fcc3 3388#ifndef HAS_HTONL
fe14fcc3
LW
3389#define HAS_HTONS
3390#define HAS_HTONL
3391#define HAS_NTOHS
3392#define HAS_NTOHL
8e2d7c44
NC
3393# if (BYTEORDER & 0xffff) == 0x4321
3394/* Big endian system, so ntohl, ntohs, htonl and htons do not need to
3395 re-order their values. However, to behave identically to the alternative
3396 implementations, they should truncate to the correct size. */
3397# define ntohl(x) ((x)&0xFFFFFFFF)
3398# define htonl(x) ntohl(x)
3399# define ntohs(x) ((x)&0xFFFF)
3400# define htons(x) ntohs(x)
e4b03fed
NC
3401# elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
3402
3403/* Note that we can't straight out declare our own htonl and htons because
3404 the Win32 build process forcibly undefines HAS_HTONL etc for its miniperl,
3405 to avoid the overhead of initialising the socket subsystem, but the headers
3406 that *declare* the various functions are still seen. If we declare our own
3407 htonl etc they will clash with the declarations in the Win32 headers. */
3408
3409PERL_STATIC_INLINE U32
3410my_swap32(const U32 x) {
3411 return ((x & 0xFF) << 24) | ((x >> 24) & 0xFF)
3412 | ((x & 0x0000FF00) << 8) | ((x & 0x00FF0000) >> 8);
3413}
3414
3415PERL_STATIC_INLINE U16
3416my_swap16(const U16 x) {
3417 return ((x & 0xFF) << 8) | ((x >> 8) & 0xFF);
3418}
3419
3420# define htonl(x) my_swap32(x)
3421# define ntohl(x) my_swap32(x)
3422# define ntohs(x) my_swap16(x)
3423# define htons(x) my_swap16(x)
8e2d7c44 3424# else
691a44df
NC
3425# error "Unsupported byteorder"
3426/* The C pre-processor doesn't let us return the value of BYTEORDER as part of
3427 the error message. Please check the value of the macro BYTEORDER, as defined
3428 in config.h. The values of BYTEORDER we expect are
3429
3430 big endian little endian
3431 32 bit 0x4321 0x1234
3432 64 bit 0x87654321 0x12345678
3433
3434 If you have a system with a different byte order, please see
3435 pod/perlhack.pod for how to submit a patch to add supporting code.
3436*/
3437# endif
a687059c
LW
3438#endif
3439
988174c1
LW
3440/*
3441 * Little-endian byte order functions - 'v' for 'VAX', or 'reVerse'.
3442 * -DWS
3443 */
5ae72479 3444#if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
260c6fee
NC
3445/* Little endian system, so vtohl, vtohs, htovl and htovs do not need to
3446 re-order their values. However, to behave identically to the alternative
3447 implementations, they should truncate to the correct size. */
3448# define vtohl(x) ((x)&0xFFFFFFFF)
3449# define vtohs(x) ((x)&0xFFFF)
3450# define htovl(x) vtohl(x)
3451# define htovs(x) vtohs(x)
545872c5 3452#elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
988174c1
LW
3453# define vtohl(x) ((((x)&0xFF)<<24) \
3454 +(((x)>>24)&0xFF) \
3455 +(((x)&0x0000FF00)<<8) \
3456 +(((x)&0x00FF0000)>>8) )
3457# define vtohs(x) ((((x)&0xFF)<<8) + (((x)>>8)&0xFF))
3458# define htovl(x) vtohl(x)
3459# define htovs(x) vtohs(x)
545872c5
NC
3460#else
3461# error "Unsupported byteorder"
3462/* If you have need for current perl on PDP-11 or similar, and can help test
3463 that blead keeps working on a mixed-endian system, then see
3464 pod/perlhack.pod for how to submit patches to things working again. */
2a8c3029 3465#endif
988174c1 3466
3bb7c1b4
JH
3467/* *MAX Plus 1. A floating point value.
3468 Hopefully expressed in a way that dodgy floating point can't mess up.
3469 >> 2 rather than 1, so that value is safely less than I32_MAX after 1
3470 is added to it
3471 May find that some broken compiler will want the value cast to I32.
3472 [after the shift, as signed >> may not be as secure as unsigned >>]
3473*/
3474#define I32_MAX_P1 (2.0 * (1 + (((U32)I32_MAX) >> 1)))
3475#define U32_MAX_P1 (4.0 * (1 + ((U32_MAX) >> 2)))
3476/* For compilers that can't correctly cast NVs over 0x7FFFFFFF (or
3477 0x7FFFFFFFFFFFFFFF) to an unsigned integer. In the future, sizeof(UV)
3478 may be greater than sizeof(IV), so don't assume that half max UV is max IV.
3479*/
3480#define U32_MAX_P1_HALF (2.0 * (1 + ((U32_MAX) >> 2)))
ee0007ab 3481
3bb7c1b4
JH
3482#define UV_MAX_P1 (4.0 * (1 + ((UV_MAX) >> 2)))
3483#define IV_MAX_P1 (2.0 * (1 + (((UV)IV_MAX) >> 1)))
3484#define UV_MAX_P1_HALF (2.0 * (1 + ((UV_MAX) >> 2)))
3485
3486/* This may look like unnecessary jumping through hoops, but converting
3487 out of range floating point values to integers *is* undefined behaviour,
3488 and it is starting to bite.
3489*/
3490#ifndef CAST_INLINE
65202027 3491#define I_32(what) (cast_i32((NV)(what)))
3bb7c1b4 3492#define U_32(what) (cast_ulong((NV)(what)))
65202027
DS
3493#define I_V(what) (cast_iv((NV)(what)))
3494#define U_V(what) (cast_uv((NV)(what)))
3bb7c1b4
JH
3495#else
3496#define I_32(n) ((n) < I32_MAX_P1 ? ((n) < I32_MIN ? I32_MIN : (I32) (n)) \
3497 : ((n) < U32_MAX_P1 ? (I32)(U32) (n) \
3498 : ((n) > 0 ? (I32) U32_MAX : 0 /* NaN */)))
3499#define U_32(n) ((n) < 0.0 ? ((n) < I32_MIN ? (UV) I32_MIN : (U32)(I32) (n)) \
3500 : ((n) < U32_MAX_P1 ? (U32) (n) \
3501 : ((n) > 0 ? U32_MAX : 0 /* NaN */)))
5d9574c1
DM
3502#define I_V(n) (LIKELY((n) < IV_MAX_P1) ? (UNLIKELY((n) < IV_MIN) ? IV_MIN : (IV) (n)) \
3503 : (LIKELY((n) < UV_MAX_P1) ? (IV)(UV) (n) \
3bb7c1b4 3504 : ((n) > 0 ? (IV)UV_MAX : 0 /* NaN */)))
5d9574c1
DM
3505#define U_V(n) ((n) < 0.0 ? (UNLIKELY((n) < IV_MIN) ? (UV) IV_MIN : (UV)(IV) (n)) \
3506 : (LIKELY((n) < UV_MAX_P1) ? (UV) (n) \
3bb7c1b4
JH
3507 : ((n) > 0 ? UV_MAX : 0 /* NaN */)))
3508#endif
3509
3510#define U_S(what) ((U16)U_32(what))
3511#define U_I(what) ((unsigned int)U_32(what))
3512#define U_L(what) U_32(what)
ed6116ce 3513
ed140128
AD
3514#ifdef HAS_SIGNBIT
3515# define Perl_signbit signbit
3516#endif
3517
2d4389e4
JH
3518/* These do not care about the fractional part, only about the range. */
3519#define NV_WITHIN_IV(nv) (I_V(nv) >= IV_MIN && I_V(nv) <= IV_MAX)
24db6c0d 3520#define NV_WITHIN_UV(nv) ((nv)>=0.0 && U_V(nv) >= UV_MIN && U_V(nv) <= UV_MAX)
2d4389e4 3521
25da4f38
IZ
3522/* Used with UV/IV arguments: */
3523 /* XXXX: need to speed it up */
3524#define CLUMP_2UV(iv) ((iv) < 0 ? 0 : (UV)(iv))
3525#define CLUMP_2IV(uv) ((uv) > (UV)IV_MAX ? IV_MAX : (IV)(uv))
3526
352d5a3a
LW
3527#ifndef MAXSYSFD
3528# define MAXSYSFD 2
3529#endif
ee0007ab 3530
79072805 3531#ifndef __cplusplus
e37d7e38 3532#if !(defined(WIN32) || defined(UNDER_CE) || defined(SYMBIAN))
20ce7b12
GS
3533Uid_t getuid (void);
3534Uid_t geteuid (void);
3535Gid_t getgid (void);
3536Gid_t getegid (void);
79072805 3537#endif
e1caacb4 3538#endif
8d063cd8 3539
0c30d9ec 3540#ifndef Perl_debug_log
bf49b057
GS
3541# define Perl_debug_log PerlIO_stderr()
3542#endif
3543
3544#ifndef Perl_error_log
3545# define Perl_error_log (PL_stderrgv \
6b78add2 3546 && isGV(PL_stderrgv) \
01bb7c6d 3547 && GvIOp(PL_stderrgv) \
42de951c 3548 && IoOFP(GvIOp(PL_stderrgv)) \
bf49b057
GS
3549 ? IoOFP(GvIOp(PL_stderrgv)) \
3550 : PerlIO_stderr())
0c30d9ec 3551#endif
3967c732 3552
aea4f609
DM
3553
3554#define DEBUG_p_FLAG 0x00000001 /* 1 */
3555#define DEBUG_s_FLAG 0x00000002 /* 2 */
3556#define DEBUG_l_FLAG 0x00000004 /* 4 */
3557#define DEBUG_t_FLAG 0x00000008 /* 8 */
3558#define DEBUG_o_FLAG 0x00000010 /* 16 */
3559#define DEBUG_c_FLAG 0x00000020 /* 32 */
3560#define DEBUG_P_FLAG 0x00000040 /* 64 */
3561#define DEBUG_m_FLAG 0x00000080 /* 128 */
3562#define DEBUG_f_FLAG 0x00000100 /* 256 */
3563#define DEBUG_r_FLAG 0x00000200 /* 512 */
3564#define DEBUG_x_FLAG 0x00000400 /* 1024 */
3565#define DEBUG_u_FLAG 0x00000800 /* 2048 */
88d2d28a
JC
3566/* U is reserved for Unofficial, exploratory hacking */
3567#define DEBUG_U_FLAG 0x00001000 /* 4096 */
aea4f609
DM
3568#define DEBUG_H_FLAG 0x00002000 /* 8192 */
3569#define DEBUG_X_FLAG 0x00004000 /* 16384 */
3570#define DEBUG_D_FLAG 0x00008000 /* 32768 */
56967202 3571#define DEBUG_S_FLAG 0x00010000 /* 65536 */
aea4f609 3572#define DEBUG_T_FLAG 0x00020000 /* 131072 */
04932ac8 3573#define DEBUG_R_FLAG 0x00040000 /* 262144 */
1045810a 3574#define DEBUG_J_FLAG 0x00080000 /* 524288 */
d6721266 3575#define DEBUG_v_FLAG 0x00100000 /*1048576 */
46187eeb 3576#define DEBUG_C_FLAG 0x00200000 /*2097152 */
ecae49c0 3577#define DEBUG_A_FLAG 0x00400000 /*4194304 */
a3c98653 3578#define DEBUG_q_FLAG 0x00800000 /*8388608 */
cc8773c0
CS
3579#define DEBUG_M_FLAG 0x01000000 /*16777216*/
3580#define DEBUG_B_FLAG 0x02000000 /*33554432*/
69014004
KW
3581#define DEBUG_L_FLAG 0x04000000 /*67108864*/
3582#define DEBUG_MASK 0x07FFEFFF /* mask of all the standard flags */
aea4f609
DM
3583
3584#define DEBUG_DB_RECURSE_FLAG 0x40000000
1045810a
IZ
3585#define DEBUG_TOP_FLAG 0x80000000 /* XXX what's this for ??? Signal
3586 that something was done? */
aea4f609 3587
bd16a5f0
IZ
3588# define DEBUG_p_TEST_ (PL_debug & DEBUG_p_FLAG)
3589# define DEBUG_s_TEST_ (PL_debug & DEBUG_s_FLAG)
3590# define DEBUG_l_TEST_ (PL_debug & DEBUG_l_FLAG)
3591# define DEBUG_t_TEST_ (PL_debug & DEBUG_t_FLAG)
3592# define DEBUG_o_TEST_ (PL_debug & DEBUG_o_FLAG)
3593# define DEBUG_c_TEST_ (PL_debug & DEBUG_c_FLAG)
3594# define DEBUG_P_TEST_ (PL_debug & DEBUG_P_FLAG)
3595# define DEBUG_m_TEST_ (PL_debug & DEBUG_m_FLAG)
3596# define DEBUG_f_TEST_ (PL_debug & DEBUG_f_FLAG)
3597# define DEBUG_r_TEST_ (PL_debug & DEBUG_r_FLAG)
3598# define DEBUG_x_TEST_ (PL_debug & DEBUG_x_FLAG)
3599# define DEBUG_u_TEST_ (PL_debug & DEBUG_u_FLAG)
88d2d28a 3600# define DEBUG_U_TEST_ (PL_debug & DEBUG_U_FLAG)
bd16a5f0
IZ
3601# define DEBUG_H_TEST_ (PL_debug & DEBUG_H_FLAG)
3602# define DEBUG_X_TEST_ (PL_debug & DEBUG_X_FLAG)
3603# define DEBUG_D_TEST_ (PL_debug & DEBUG_D_FLAG)
56967202 3604# define DEBUG_S_TEST_ (PL_debug & DEBUG_S_FLAG)
bd16a5f0
IZ
3605# define DEBUG_T_TEST_ (PL_debug & DEBUG_T_FLAG)
3606# define DEBUG_R_TEST_ (PL_debug & DEBUG_R_FLAG)
1045810a 3607# define DEBUG_J_TEST_ (PL_debug & DEBUG_J_FLAG)
d6721266 3608# define DEBUG_v_TEST_ (PL_debug & DEBUG_v_FLAG)
46187eeb 3609# define DEBUG_C_TEST_ (PL_debug & DEBUG_C_FLAG)
ecae49c0
NC
3610# define DEBUG_A_TEST_ (PL_debug & DEBUG_A_FLAG)
3611# define DEBUG_q_TEST_ (PL_debug & DEBUG_q_FLAG)
d7c0d282 3612# define DEBUG_M_TEST_ (PL_debug & DEBUG_M_FLAG)
cc8773c0 3613# define DEBUG_B_TEST_ (PL_debug & DEBUG_B_FLAG)
69014004 3614# define DEBUG_L_TEST_ (PL_debug & DEBUG_L_FLAG)
dd2155a4 3615# define DEBUG_Xv_TEST_ (DEBUG_X_TEST_ && DEBUG_v_TEST_)
7949c6f5 3616# define DEBUG_Uv_TEST_ (DEBUG_U_TEST_ && DEBUG_v_TEST_)
ad9e76a8 3617# define DEBUG_Pv_TEST_ (DEBUG_P_TEST_ && DEBUG_v_TEST_)
bd16a5f0 3618
3967c732 3619#ifdef DEBUGGING
aea4f609 3620
bd16a5f0
IZ
3621# define DEBUG_p_TEST DEBUG_p_TEST_
3622# define DEBUG_s_TEST DEBUG_s_TEST_
3623# define DEBUG_l_TEST DEBUG_l_TEST_
3624# define DEBUG_t_TEST DEBUG_t_TEST_
3625# define DEBUG_o_TEST DEBUG_o_TEST_
3626# define DEBUG_c_TEST DEBUG_c_TEST_
3627# define DEBUG_P_TEST DEBUG_P_TEST_
3628# define DEBUG_m_TEST DEBUG_m_TEST_
3629# define DEBUG_f_TEST DEBUG_f_TEST_
3630# define DEBUG_r_TEST DEBUG_r_TEST_
3631# define DEBUG_x_TEST DEBUG_x_TEST_
3632# define DEBUG_u_TEST DEBUG_u_TEST_
88d2d28a 3633# define DEBUG_U_TEST DEBUG_U_TEST_
bd16a5f0
IZ
3634# define DEBUG_H_TEST DEBUG_H_TEST_
3635# define DEBUG_X_TEST DEBUG_X_TEST_
3636# define DEBUG_D_TEST DEBUG_D_TEST_
56967202 3637# define DEBUG_S_TEST DEBUG_S_TEST_
bd16a5f0
IZ
3638# define DEBUG_T_TEST DEBUG_T_TEST_
3639# define DEBUG_R_TEST DEBUG_R_TEST_
1045810a 3640# define DEBUG_J_TEST DEBUG_J_TEST_
d6721266 3641# define DEBUG_v_TEST DEBUG_v_TEST_
46187eeb 3642# define DEBUG_C_TEST DEBUG_C_TEST_
ecae49c0 3643# define DEBUG_A_TEST DEBUG_A_TEST_
a3c98653 3644# define DEBUG_q_TEST DEBUG_q_TEST_
d7c0d282 3645# define DEBUG_M_TEST DEBUG_M_TEST_
cc8773c0 3646# define DEBUG_B_TEST DEBUG_B_TEST_
69014004 3647# define DEBUG_L_TEST DEBUG_L_TEST_
7949c6f5
JC
3648# define DEBUG_Xv_TEST DEBUG_Xv_TEST_
3649# define DEBUG_Uv_TEST DEBUG_Uv_TEST_
ad9e76a8 3650# define DEBUG_Pv_TEST DEBUG_Pv_TEST_
aea4f609 3651
488b0c7a
JH
3652# define PERL_DEB(a) a
3653# define PERL_DEBUG(a) if (PL_debug) a
aea4f609
DM
3654# define DEBUG_p(a) if (DEBUG_p_TEST) a
3655# define DEBUG_s(a) if (DEBUG_s_TEST) a
3656# define DEBUG_l(a) if (DEBUG_l_TEST) a
3657# define DEBUG_t(a) if (DEBUG_t_TEST) a
3658# define DEBUG_o(a) if (DEBUG_o_TEST) a
3659# define DEBUG_c(a) if (DEBUG_c_TEST) a
3660# define DEBUG_P(a) if (DEBUG_P_TEST) a
3661
969058bb
VK
3662 /* Temporarily turn off memory debugging in case the a
3663 * does memory allocation, either directly or indirectly. */
acfe0abc 3664# define DEBUG_m(a) \
0b250b9e 3665 STMT_START { \
aea4f609 3666 if (PERL_GET_INTERP) { dTHX; if (DEBUG_m_TEST) {PL_debug&=~DEBUG_m_FLAG; a; PL_debug|=DEBUG_m_FLAG;} } \
0b250b9e 3667 } STMT_END
aea4f609 3668
5f80b19c
AMS
3669# define DEBUG__(t, a) \
3670 STMT_START { \
3671 if (t) STMT_START {a;} STMT_END; \
3672 } STMT_END
3673
3674# define DEBUG_f(a) DEBUG__(DEBUG_f_TEST, a)
f9f4320a 3675#ifndef PERL_EXT_RE_BUILD
5f80b19c 3676# define DEBUG_r(a) DEBUG__(DEBUG_r_TEST, a)
f9f4320a
YO
3677#else
3678# define DEBUG_r(a) STMT_START {a;} STMT_END
3679#endif /* PERL_EXT_RE_BUILD */
5f80b19c
AMS
3680# define DEBUG_x(a) DEBUG__(DEBUG_x_TEST, a)
3681# define DEBUG_u(a) DEBUG__(DEBUG_u_TEST, a)
88d2d28a 3682# define DEBUG_U(a) DEBUG__(DEBUG_U_TEST, a)
5f80b19c
AMS
3683# define DEBUG_H(a) DEBUG__(DEBUG_H_TEST, a)
3684# define DEBUG_X(a) DEBUG__(DEBUG_X_TEST, a)
3685# define DEBUG_D(a) DEBUG__(DEBUG_D_TEST, a)
7949c6f5
JC
3686# define DEBUG_Xv(a) DEBUG__(DEBUG_Xv_TEST, a)
3687# define DEBUG_Uv(a) DEBUG__(DEBUG_Uv_TEST, a)
ad9e76a8 3688# define DEBUG_Pv(a) DEBUG__(DEBUG_Pv_TEST, a)
aea4f609 3689
56967202 3690# define DEBUG_S(a) DEBUG__(DEBUG_S_TEST, a)
5f80b19c
AMS
3691# define DEBUG_T(a) DEBUG__(DEBUG_T_TEST, a)
3692# define DEBUG_R(a) DEBUG__(DEBUG_R_TEST, a)
d6721266 3693# define DEBUG_v(a) DEBUG__(DEBUG_v_TEST, a)
46187eeb 3694# define DEBUG_C(a) DEBUG__(DEBUG_C_TEST, a)
ecae49c0
NC
3695# define DEBUG_A(a) DEBUG__(DEBUG_A_TEST, a)
3696# define DEBUG_q(a) DEBUG__(DEBUG_q_TEST, a)
d7c0d282 3697# define DEBUG_M(a) DEBUG__(DEBUG_M_TEST, a)
cc8773c0 3698# define DEBUG_B(a) DEBUG__(DEBUG_B_TEST, a)
69014004 3699# define DEBUG_L(a) DEBUG__(DEBUG_L_TEST, a)
aea4f609
DM
3700
3701#else /* DEBUGGING */
3702
3703# define DEBUG_p_TEST (0)
3704# define DEBUG_s_TEST (0)
3705# define DEBUG_l_TEST (0)
3706# define DEBUG_t_TEST (0)
3707# define DEBUG_o_TEST (0)
3708# define DEBUG_c_TEST (0)
3709# define DEBUG_P_TEST (0)
3710# define DEBUG_m_TEST (0)
3711# define DEBUG_f_TEST (0)
3712# define DEBUG_r_TEST (0)
3713# define DEBUG_x_TEST (0)
3714# define DEBUG_u_TEST (0)
88d2d28a 3715# define DEBUG_U_TEST (0)
aea4f609
DM
3716# define DEBUG_H_TEST (0)
3717# define DEBUG_X_TEST (0)
3718# define DEBUG_D_TEST (0)
56967202 3719# define DEBUG_S_TEST (0)
aea4f609 3720# define DEBUG_T_TEST (0)
04932ac8 3721# define DEBUG_R_TEST (0)
1045810a 3722# define DEBUG_J_TEST (0)
d6721266 3723# define DEBUG_v_TEST (0)
46187eeb 3724# define DEBUG_C_TEST (0)
ecae49c0
NC
3725# define DEBUG_A_TEST (0)
3726# define DEBUG_q_TEST (0)
d7c0d282 3727# define DEBUG_M_TEST (0)
cc8773c0 3728# define DEBUG_B_TEST (0)
69014004 3729# define DEBUG_L_TEST (0)
7949c6f5
JC