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