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