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