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