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