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