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