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