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