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