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