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