This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
ef63cd81c0bdd287ab731d37165c8325572f886e
[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, 2012 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 #  define NULL 0
16 #endif
17
18 #ifndef PERL_CORE
19 #  define Null(type) ((type)NULL)
20
21 /*
22 =head1 Handy Values
23
24 =for apidoc AmU||Nullch
25 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
26
27 =for apidoc AmU||Nullsv
28 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
29
30 =cut
31 */
32
33 #  define Nullch Null(char*)
34 #  define Nullfp Null(PerlIO*)
35 #  define Nullsv Null(SV*)
36 #endif
37
38 #ifdef TRUE
39 #undef TRUE
40 #endif
41 #ifdef FALSE
42 #undef FALSE
43 #endif
44 #define TRUE (1)
45 #define FALSE (0)
46
47 /* The MUTABLE_*() macros cast pointers to the types shown, in such a way
48  * (compiler permitting) that casting away const-ness will give a warning;
49  * e.g.:
50  *
51  * const SV *sv = ...;
52  * AV *av1 = (AV*)sv;        <== BAD:  the const has been silently cast away
53  * AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
54  */
55
56 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
57 #  define MUTABLE_PTR(p) ({ void *_p = (p); _p; })
58 #else
59 #  define MUTABLE_PTR(p) ((void *) (p))
60 #endif
61
62 #define MUTABLE_AV(p)   ((AV *)MUTABLE_PTR(p))
63 #define MUTABLE_CV(p)   ((CV *)MUTABLE_PTR(p))
64 #define MUTABLE_GV(p)   ((GV *)MUTABLE_PTR(p))
65 #define MUTABLE_HV(p)   ((HV *)MUTABLE_PTR(p))
66 #define MUTABLE_IO(p)   ((IO *)MUTABLE_PTR(p))
67 #define MUTABLE_SV(p)   ((SV *)MUTABLE_PTR(p))
68
69 #ifdef I_STDBOOL
70 #  include <stdbool.h>
71 #  ifndef HAS_BOOL
72 #    define HAS_BOOL 1
73 #  endif
74 #endif
75
76 /* bool is built-in for g++-2.6.3 and later, which might be used
77    for extensions.  <_G_config.h> defines _G_HAVE_BOOL, but we can't
78    be sure _G_config.h will be included before this file.  _G_config.h
79    also defines _G_HAVE_BOOL for both gcc and g++, but only g++
80    actually has bool.  Hence, _G_HAVE_BOOL is pretty useless for us.
81    g++ can be identified by __GNUG__.
82    Andy Dougherty       February 2000
83 */
84 #ifdef __GNUG__         /* GNU g++ has bool built-in */
85 #  ifndef HAS_BOOL
86 #    define HAS_BOOL 1
87 #  endif
88 #endif
89
90 /* The NeXT dynamic loader headers will not build with the bool macro
91    So declare them now to clear confusion.
92 */
93 #if defined(NeXT) || defined(__NeXT__)
94 # undef FALSE
95 # undef TRUE
96   typedef enum bool { FALSE = 0, TRUE = 1 } bool;
97 # define ENUM_BOOL 1
98 # ifndef HAS_BOOL
99 #  define HAS_BOOL 1
100 # endif /* !HAS_BOOL */
101 #endif /* NeXT || __NeXT__ */
102
103 #ifndef HAS_BOOL
104 # if defined(VMS)
105 #  define bool int
106 # else
107 #  define bool char
108 # endif
109 # define HAS_BOOL 1
110 #endif
111
112 /* a simple (bool) cast may not do the right thing: if bool is defined
113  * as char for example, then the cast from int is implementation-defined
114  * (bool)!!(cbool) in a ternary triggers a bug in xlc on AIX
115  */
116
117 #define cBOOL(cbool) ((cbool) ? (bool)1 : (bool)0)
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) || /* MSVC6 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 #   if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
191 #       define PeRl_INT64_C(c)  CAT2(c,LL)
192 #       define PeRl_UINT64_C(c) CAT2(c,ULL)
193 #   else
194 #       if QUADKIND == QUAD_IS___INT64
195 #           define PeRl_INT64_C(c)      CAT2(c,I64)
196 #           define PeRl_UINT64_C(c)     CAT2(c,UI64)
197 #       else
198 #           if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
199 #               define PeRl_INT64_C(c)  CAT2(c,L)
200 #               define PeRl_UINT64_C(c) CAT2(c,UL)
201 #           else
202 #               define PeRl_INT64_C(c)  ((I64TYPE)(c))
203 #               define PeRl_UINT64_C(c) ((U64TYPE)(c))
204 #           endif
205 #       endif
206 #   endif
207 #   ifndef UINT64_C
208 #   define UINT64_C(c) PeRl_UINT64_C(c)
209 #   endif
210 #   ifndef INT64_C
211 #   define INT64_C(c) PeRl_INT64_C(c)
212 #   endif
213 #endif
214
215 #if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
216
217 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
218    Please search CHAR_MAX in perl.h for further details. */
219 #define U8_MAX UINT8_MAX
220 #define U8_MIN UINT8_MIN
221
222 #define I16_MAX INT16_MAX
223 #define I16_MIN INT16_MIN
224 #define U16_MAX UINT16_MAX
225 #define U16_MIN UINT16_MIN
226
227 #define I32_MAX INT32_MAX
228 #define I32_MIN INT32_MIN
229 #ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
230 #  define U32_MAX UINT32_MAX
231 #else
232 #  define U32_MAX 4294967295U
233 #endif
234 #define U32_MIN UINT32_MIN
235
236 #else
237
238 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
239    Please search CHAR_MAX in perl.h for further details. */
240 #define U8_MAX PERL_UCHAR_MAX
241 #define U8_MIN PERL_UCHAR_MIN
242
243 #define I16_MAX PERL_SHORT_MAX
244 #define I16_MIN PERL_SHORT_MIN
245 #define U16_MAX PERL_USHORT_MAX
246 #define U16_MIN PERL_USHORT_MIN
247
248 #if LONGSIZE > 4
249 # define I32_MAX PERL_INT_MAX
250 # define I32_MIN PERL_INT_MIN
251 # define U32_MAX PERL_UINT_MAX
252 # define U32_MIN PERL_UINT_MIN
253 #else
254 # define I32_MAX PERL_LONG_MAX
255 # define I32_MIN PERL_LONG_MIN
256 # define U32_MAX PERL_ULONG_MAX
257 # define U32_MIN PERL_ULONG_MIN
258 #endif
259
260 #endif
261
262 /* log(2) is pretty close to  0.30103, just in case anyone is grepping for it */
263 #define BIT_DIGITS(N)   (((N)*146)/485 + 1)  /* log2(10) =~ 146/485 */
264 #define TYPE_DIGITS(T)  BIT_DIGITS(sizeof(T) * 8)
265 #define TYPE_CHARS(T)   (TYPE_DIGITS(T) + 2) /* sign, NUL */
266
267 #define Ctl(ch) ((ch) & 037)
268
269 /*
270 =head1 SV-Body Allocation
271
272 =for apidoc Ama|SV*|newSVpvs|const char* s
273 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
274
275 =for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags
276 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
277 pair.
278
279 =for apidoc Ama|SV*|newSVpvs_share|const char* s
280 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
281 pair and omits the hash parameter.
282
283 =for apidoc Am|void|sv_catpvs_flags|SV* sv|const char* s|I32 flags
284 Like C<sv_catpvn_flags>, but takes a literal string instead of a
285 string/length pair.
286
287 =for apidoc Am|void|sv_catpvs_nomg|SV* sv|const char* s
288 Like C<sv_catpvn_nomg>, but takes a literal string instead of a
289 string/length pair.
290
291 =for apidoc Am|void|sv_catpvs|SV* sv|const char* s
292 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
293
294 =for apidoc Am|void|sv_catpvs_mg|SV* sv|const char* s
295 Like C<sv_catpvn_mg>, but takes a literal string instead of a
296 string/length pair.
297
298 =for apidoc Am|void|sv_setpvs|SV* sv|const char* s
299 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
300
301 =for apidoc Am|void|sv_setpvs_mg|SV* sv|const char* s
302 Like C<sv_setpvn_mg>, but takes a literal string instead of a
303 string/length pair.
304
305 =for apidoc Am|SV *|sv_setref_pvs|const char* s
306 Like C<sv_setref_pvn>, but takes a literal string instead of a
307 string/length pair.
308
309 =head1 Memory Management
310
311 =for apidoc Ama|char*|savepvs|const char* s
312 Like C<savepvn>, but takes a literal string instead of a string/length pair.
313
314 =for apidoc Ama|char*|savesharedpvs|const char* s
315 A version of C<savepvs()> which allocates the duplicate string in memory
316 which is shared between threads.
317
318 =head1 GV Functions
319
320 =for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create
321 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
322
323 =head1 Hash Manipulation Functions
324
325 =for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval
326 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
327
328 =for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val
329 Like C<hv_store>, but takes a literal string instead of a string/length pair
330 and omits the hash parameter.
331
332 =head1 Lexer interface
333
334 =for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags
335
336 Like L</lex_stuff_pvn>, but takes a literal string instead of a
337 string/length pair.
338
339 =cut
340 */
341
342 /* concatenating with "" ensures that only literal strings are accepted as
343  * argument */
344 #define STR_WITH_LEN(s)  ("" s ""), (sizeof(s)-1)
345
346 /* note that STR_WITH_LEN() can't be used as argument to macros or functions
347  * that under some configurations might be macros, which means that it requires
348  * the full Perl_xxx(aTHX_ ...) form for any API calls where it's used.
349  */
350
351 /* STR_WITH_LEN() shortcuts */
352 #define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str))
353 #define newSVpvs_flags(str,flags)       \
354     Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags)
355 #define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0)
356 #define sv_catpvs_flags(sv, str, flags) \
357     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), flags)
358 #define sv_catpvs_nomg(sv, str) \
359     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), 0)
360 #define sv_catpvs(sv, str) \
361     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC)
362 #define sv_catpvs_mg(sv, str) \
363     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC|SV_SMAGIC)
364 #define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str))
365 #define sv_setpvs_mg(sv, str) Perl_sv_setpvn_mg(aTHX_ sv, STR_WITH_LEN(str))
366 #define sv_setref_pvs(rv, classname, str) \
367     Perl_sv_setref_pvn(aTHX_ rv, classname, STR_WITH_LEN(str))
368 #define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str))
369 #define savesharedpvs(str) Perl_savesharedpvn(aTHX_ STR_WITH_LEN(str))
370 #define gv_stashpvs(str, create) \
371     Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create)
372 #define gv_fetchpvs(namebeg, add, sv_type) \
373     Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type)
374 #define gv_fetchpvn(namebeg, len, add, sv_type) \
375     Perl_gv_fetchpvn_flags(aTHX_ namebeg, len, add, sv_type)
376 #define sv_catxmlpvs(dsv, str, utf8) \
377     Perl_sv_catxmlpvn(aTHX_ dsv, STR_WITH_LEN(str), utf8)
378 #define hv_fetchs(hv,key,lval)                                          \
379   ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0,        \
380                          (lval) ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)  \
381                          : HV_FETCH_JUST_SV, NULL, 0))
382
383 #define hv_stores(hv,key,val)                                           \
384   ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0,        \
385                          (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), 0))
386
387 #define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
388
389 #define get_cvs(str, flags)                                     \
390         Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
391
392 /*
393 =head1 Miscellaneous Functions
394
395 =for apidoc Am|bool|strNE|char* s1|char* s2
396 Test two strings to see if they are different.  Returns true or
397 false.
398
399 =for apidoc Am|bool|strEQ|char* s1|char* s2
400 Test two strings to see if they are equal.  Returns true or false.
401
402 =for apidoc Am|bool|strLT|char* s1|char* s2
403 Test two strings to see if the first, C<s1>, is less than the second,
404 C<s2>.  Returns true or false.
405
406 =for apidoc Am|bool|strLE|char* s1|char* s2
407 Test two strings to see if the first, C<s1>, is less than or equal to the
408 second, C<s2>.  Returns true or false.
409
410 =for apidoc Am|bool|strGT|char* s1|char* s2
411 Test two strings to see if the first, C<s1>, is greater than the second,
412 C<s2>.  Returns true or false.
413
414 =for apidoc Am|bool|strGE|char* s1|char* s2
415 Test two strings to see if the first, C<s1>, is greater than or equal to
416 the second, C<s2>.  Returns true or false.
417
418 =for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
419 Test two strings to see if they are different.  The C<len> parameter
420 indicates the number of bytes to compare.  Returns true or false. (A
421 wrapper for C<strncmp>).
422
423 =for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
424 Test two strings to see if they are equal.  The C<len> parameter indicates
425 the number of bytes to compare.  Returns true or false. (A wrapper for
426 C<strncmp>).
427
428 =cut
429 */
430
431 #define strNE(s1,s2) (strcmp(s1,s2))
432 #define strEQ(s1,s2) (!strcmp(s1,s2))
433 #define strLT(s1,s2) (strcmp(s1,s2) < 0)
434 #define strLE(s1,s2) (strcmp(s1,s2) <= 0)
435 #define strGT(s1,s2) (strcmp(s1,s2) > 0)
436 #define strGE(s1,s2) (strcmp(s1,s2) >= 0)
437 #define strnNE(s1,s2,l) (strncmp(s1,s2,l))
438 #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
439
440 #ifdef HAS_MEMCMP
441 #  define memNE(s1,s2,l) (memcmp(s1,s2,l))
442 #  define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
443 #else
444 #  define memNE(s1,s2,l) (bcmp(s1,s2,l))
445 #  define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
446 #endif
447
448 #define memEQs(s1, l, s2) \
449         (sizeof(s2)-1 == l && memEQ(s1, ("" s2 ""), (sizeof(s2)-1)))
450 #define memNEs(s1, l, s2) !memEQs(s1, l, s2)
451
452 /*
453  * Character classes.
454  *
455  * Unfortunately, the introduction of locales means that we
456  * can't trust isupper(), etc. to tell the truth.  And when
457  * it comes to /\w+/ with tainting enabled, we *must* be able
458  * to trust our character classes.
459  *
460  * Therefore, the default tests in the text of Perl will be
461  * independent of locale.  Any code that wants to depend on
462  * the current locale will use the tests that begin with "lc".
463  */
464
465 #ifdef HAS_SETLOCALE  /* XXX Is there a better test for this? */
466 #  ifndef CTYPE256
467 #    define CTYPE256
468 #  endif
469 #endif
470
471 /*
472
473 =head1 Character classes
474 There are three variants for all the functions in this section.  The base ones
475 operate using the character set of the platform Perl is running on.  The ones
476 with an C<_A> suffix operate on the ASCII character set, and the ones with an
477 C<_L1> suffix operate on the full Latin1 character set.  All are unaffected by
478 locale and by C<use bytes>.
479
480 For ASCII platforms, the base function with no suffix and the one with the
481 C<_A> suffix are identical.  The function with the C<_L1> suffix imposes the
482 Latin-1 character set onto the platform.  That is, the code points that are
483 ASCII are unaffected, since ASCII is a subset of Latin-1.  But the non-ASCII
484 code points are treated as if they are Latin-1 characters.  For example,
485 C<isSPACE_L1()> will return true when called with the code point 0xA0, which is
486 the Latin-1 NO-BREAK SPACE.
487
488 For EBCDIC platforms, the base function with no suffix and the one with the
489 C<_L1> suffix should be identical, since, as of this writing, the EBCDIC code
490 pages that Perl knows about all are equivalent to Latin-1.  The function that
491 ends in an C<_A> suffix will not return true unless the specified character also
492 has an ASCII equivalent.
493
494 =for apidoc Am|bool|isALPHA|char ch
495 Returns a boolean indicating whether the specified character is an
496 alphabetic character in the platform's native character set.
497 See the L<top of this section|/Character classes> for an explanation of variants
498 C<isALPHA_A> and C<isALPHA_L1>.
499
500 =for apidoc Am|bool|isASCII|char ch
501 Returns a boolean indicating whether the specified character is one of the 128
502 characters in the ASCII character set.  On non-ASCII platforms, it is if this
503 character corresponds to an ASCII character.  Variants C<isASCII_A()> and
504 C<isASCII_L1()> are identical to C<isASCII()>.
505
506 =for apidoc Am|bool|isDIGIT|char ch
507 Returns a boolean indicating whether the specified character is a
508 digit in the platform's native character set.
509 Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
510
511 =for apidoc Am|bool|isLOWER|char ch
512 Returns a boolean indicating whether the specified character is a
513 lowercase character in the platform's native character set.
514 See the L<top of this section|/Character classes> for an explanation of variants
515 C<isLOWER_A> and C<isLOWER_L1>.
516
517 =for apidoc Am|bool|isOCTAL|char ch
518 Returns a boolean indicating whether the specified character is an
519 octal digit, [0-7] in the platform's native character set.
520 Variants C<isOCTAL_A> and C<isOCTAL_L1> are identical to C<isOCTAL>.
521
522 =for apidoc Am|bool|isSPACE|char ch
523 Returns a boolean indicating whether the specified character is a
524 whitespace character in the platform's native character set.  This is the same
525 as what C<\s> matches in a regular expression.
526 See the L<top of this section|/Character classes> for an explanation of variants
527 C<isSPACE_A> and C<isSPACE_L1>.
528
529 =for apidoc Am|bool|isUPPER|char ch
530 Returns a boolean indicating whether the specified character is an
531 uppercase character in the platform's native character set.
532 See the L<top of this section|/Character classes> for an explanation of variants
533 C<isUPPER_A> and C<isUPPER_L1>.
534
535 =for apidoc Am|bool|isWORDCHAR|char ch
536 Returns a boolean indicating whether the specified character is a
537 character that is any of: alphabetic, numeric, or an underscore.  This is the
538 same as what C<\w> matches in a regular expression.
539 C<isALNUM()> is a synonym provided for backward compatibility.  Note that it
540 does not have the standard C language meaning of alphanumeric, since it matches
541 an underscore and the standard meaning does not.
542 See the L<top of this section|/Character classes> for an explanation of variants
543 C<isWORDCHAR_A> and C<isWORDCHAR_L1>.
544
545 =for apidoc Am|bool|isXDIGIT|char ch
546 Returns a boolean indicating whether the specified character is a hexadecimal
547 digit, [0-9A-Fa-f].  Variants C<isXDIGIT_A()> and C<isXDIGIT_L1()> are
548 identical to C<isXDIGIT()>.
549
550 =for apidoc Am|U8|READ_XDIGIT|char str*
551 Returns the value of a hex digit and advances the string pointer.
552 Behaviour is only well defined when isXDIGIT(*str) is true.
553
554 =head1 Character case changing
555
556 =for apidoc Am|char|toUPPER|char ch
557 Converts the specified character to uppercase in the platform's native
558 character set, if possible; otherwise returns the input character itself.
559
560 =for apidoc Am|char|toLOWER|char ch
561 Converts the specified character to lowercase in the platform's native
562 character set, if possible; otherwise returns the input character itself.
563
564 =cut
565
566 Note that these macros are repeated in Devel::PPPort, so should also be
567 patched there.  The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
568
569 */
570
571 /* Specify the widest unsigned type on the platform.  Use U64TYPE because U64
572  * is known only in the perl core, and this macro can be called from outside
573  * that */
574 #ifdef HAS_QUAD
575 #   define WIDEST_UTYPE U64TYPE
576 #else
577 #   define WIDEST_UTYPE U32
578 #endif
579
580 /* FITS_IN_8_BITS(c) returns true if c doesn't have  a bit set other than in
581  * the lower 8.  It is designed to be hopefully bomb-proof, making sure that no
582  * bits of information are lost even on a 64-bit machine, but to get the
583  * compiler to optimize it out if possible.  This is because Configure makes
584  * sure that the machine has an 8-bit byte, so if c is stored in a byte, the
585  * sizeof() guarantees that this evaluates to a constant true at compile time.
586  */
587 #define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || !(((WIDEST_UTYPE)(c)) & ~0xFF))
588
589 #ifdef EBCDIC
590 #   define isASCII(c)    (FITS_IN_8_BITS(c) && (NATIVE_TO_UNI((U8) (c)) < 128))
591 #else
592 #   define isASCII(c)    ((WIDEST_UTYPE)(c) < 128)
593 #endif
594
595 #define isASCII_A(c)  isASCII(c)
596 #define isASCII_L1(c)  isASCII(c)
597
598 /* The lower 3 bits in both the ASCII and EBCDIC representations of '0' are 0,
599  * and the 8 possible permutations of those bits exactly comprise the 8 octal
600  * digits */
601 #define isOCTAL_A(c)  cBOOL(FITS_IN_8_BITS(c) && (0xF8 & (c)) == '0')
602
603 /* ASCII range only */
604 #ifdef H_PERL       /* If have access to perl.h, lookup in its table */
605
606 /* Character class numbers.  For internal core Perl use only.  These are used
607  * in PL_charclass[] and the ones up through the one that corresponds to
608  * <_HIGHEST_REGCOMP_DOT_H_SYNC> are used by regcomp.h.  These use names used
609  * in l1_char_class_tab.h but their actual definitions are here.  If that has a
610  * name not used here, it won't compile. */
611 #  define _CC_WORDCHAR           0
612 #  define _CC_SPACE              1
613 #  define _CC_DIGIT              2
614 #  define _CC_ALNUMC             3
615 #  define _CC_ALPHA              4
616 #  define _CC_ASCII              5
617 #  define _CC_CNTRL              6
618 #  define _CC_GRAPH              7
619 #  define _CC_LOWER              8
620 #  define _CC_PRINT              9
621 #  define _CC_PUNCT             10
622 #  define _CC_UPPER             11
623 #  define _CC_XDIGIT            12
624 #  define _CC_PSXSPC            13
625 #  define _CC_BLANK             14
626 #  define _CC_VERTSPACE         15
627 #  define _HIGHEST_REGCOMP_DOT_H_SYNC _CC_VERTSPACE
628
629 #  define _CC_IDFIRST           16
630 #  define _CC_CHARNAME_CONT     17
631 #  define _CC_NONLATIN1_FOLD    18
632 #  define _CC_QUOTEMETA         19
633 #  define _CC_NON_FINAL_FOLD    20
634 #  define _CC_IS_IN_SOME_FOLD   21
635 /* Unused: 22-31
636  * If more bits are needed, one could add a second word for non-64bit
637  * QUAD_IS_INT systems, using some #ifdefs to distinguish between having a 2nd
638  * word or not.  The IS_IN_SOME_FOLD bit is the most easily expendable, as it
639  * is used only for optimization (as of this writing), and differs in the
640  * Latin1 range from the ALPHA bit only in two relatively unimportant
641  * characters: the masculine and feminine ordinal indicators */
642
643 #  ifdef DOINIT
644 EXTCONST  U32 PL_charclass[] = {
645 #    include "l1_char_class_tab.h"
646 };
647
648 #  else /* ! DOINIT */
649 EXTCONST U32 PL_charclass[];
650 #  endif
651
652     /* The 1U keeps Solaris from griping when shifting sets the uppermost bit */
653 #   define _CC_mask(classnum) (1U << (classnum))
654 #   define _generic_isCC(c, classnum) cBOOL(FITS_IN_8_BITS(c) \
655                 && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask(classnum)))
656
657     /* The mask for the _A versions of the macros; it just adds in the bit for
658      * ASCII. */
659 #   define _CC_mask_A(classnum) (_CC_mask(classnum) | _CC_mask(_CC_ASCII))
660
661     /* The _A version makes sure that both the desired bit and the ASCII bit
662      * are present */
663 #   define _generic_isCC_A(c, classnum) (FITS_IN_8_BITS(c) \
664         && ((PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask_A(classnum)) \
665                                 == _CC_mask_A(classnum)))
666
667 #   define isALNUMC_A(c) _generic_isCC_A(c, _CC_ALNUMC)
668 #   define isALPHA_A(c)  _generic_isCC_A(c, _CC_ALPHA)
669 #   define isBLANK_A(c)  _generic_isCC_A(c, _CC_BLANK)
670 #   define isCNTRL_A(c)  _generic_isCC_A(c, _CC_CNTRL)
671 #   define isDIGIT_A(c)  _generic_isCC(c, _CC_DIGIT)
672 #   define isGRAPH_A(c)  _generic_isCC_A(c, _CC_GRAPH)
673 #   define isLOWER_A(c)  _generic_isCC_A(c, _CC_LOWER)
674 #   define isPRINT_A(c)  _generic_isCC_A(c, _CC_PRINT)
675 #   define isPSXSPC_A(c) _generic_isCC_A(c, _CC_PSXSPC)
676 #   define isPUNCT_A(c)  _generic_isCC_A(c, _CC_PUNCT)
677 #   define isSPACE_A(c)  _generic_isCC_A(c, _CC_SPACE)
678 #   define isUPPER_A(c)  _generic_isCC_A(c, _CC_UPPER)
679 #   define isWORDCHAR_A(c) _generic_isCC_A(c, _CC_WORDCHAR)
680 #   define isXDIGIT_A(c)  _generic_isCC(c, _CC_XDIGIT)
681 #   define isIDFIRST_A(c) _generic_isCC_A(c, ( _CC_IDFIRST))
682
683     /* Either participates in a fold with a character above 255, or is a
684      * multi-char fold */
685 #   define _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) ((! cBOOL(FITS_IN_8_BITS(c))) || (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask(_CC_NONLATIN1_FOLD)))
686
687 #   define _isQUOTEMETA(c) _generic_isCC(c, _CC_QUOTEMETA)
688 #   define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
689                                             _generic_isCC(c, _CC_NON_FINAL_FOLD)
690 #   define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
691                                             _generic_isCC(c, _CC_IS_IN_SOME_FOLD)
692 #else   /* No perl.h. */
693 #   ifdef EBCDIC
694 #       define isALNUMC_A(c)   (isASCII(c) && isALNUMC(c))
695 #       define isALPHA_A(c)    (isASCII(c) && isALPHA(c))
696 #       define isBLANK_A(c)    (isASCII(c) && isBLANK(c))
697 #       define isCNTRL_A(c)    (isASCII(c) && isCNTRL(c))
698 #       define isDIGIT_A(c)    (isASCII(c) && isDIGIT(c))
699 #       define isGRAPH_A(c)    (isASCII(c) && isGRAPH(c))
700 #       define isIDFIRST_A(c)  (isASCII(c) && isIDFIRST(c))
701 #       define isLOWER_A(c)    (isASCII(c) && isLOWER(c))
702 #       define isPRINT_A(c)    (isASCII(c) && isPRINT(c))
703 #       define isPSXSPC_A(c)   (isASCII(c) && isPSXSPC(c))
704 #       define isPUNCT_A(c)    (isASCII(c) && isPUNCT(c))
705 #       define isSPACE_A(c)    (isASCII(c) && isSPACE(c))
706 #       define isUPPER_A(c)    (isASCII(c) && isUPPER(c))
707 #       define isWORDCHAR_A(c) (isASCII(c) && isWORDCHAR(c))
708 #       define isXDIGIT_A(c)   (isASCII(c) && isXDIGIT(c))
709 #   else   /* ASCII platform, no perl.h */
710 #       define isALNUMC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
711 #       define isALPHA_A(c)  (isUPPER_A(c) || isLOWER_A(c))
712 #       define isBLANK_A(c)  ((c) == ' ' || (c) == '\t')
713 #       define isCNTRL_A(c) (FITS_IN_8_BITS(c) && ((U8) (c) < ' ' || (c) == 127))
714 #       define isDIGIT_A(c)  ((c) <= '9' && (c) >= '0')
715 #       define isGRAPH_A(c)  (isWORDCHAR_A(c) || isPUNCT_A(c))
716 #       define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_')
717 #       define isLOWER_A(c)  ((c) >= 'a' && (c) <= 'z')
718 #       define isPRINT_A(c)  (((c) >= 32 && (c) < 127))
719 #       define isPSXSPC_A(c) (isSPACE_A(c) || (c) == '\v')
720 #       define isPUNCT_A(c)  (((c) >= 33 && (c) <= 47)              \
721                               || ((c) >= 58 && (c) <= 64)           \
722                               || ((c) >= 91 && (c) <= 96)           \
723                               || ((c) >= 123 && (c) <= 126))
724 #       define isSPACE_A(c)  ((c) == ' '                            \
725                               || (c) == '\t'                        \
726                               || (c) == '\n'                        \
727                               || (c) =='\r'                         \
728                               || (c) == '\f')
729 #       define isUPPER_A(c)  ((c) <= 'Z' && (c) >= 'A')
730 #       define isWORDCHAR_A(c) (isALPHA_A(c) || isDIGIT_A(c) || (c) == '_')
731 #       define isXDIGIT_A(c)   (isDIGIT_A(c)                        \
732                                 || ((c) >= 'a' && (c) <= 'f')       \
733                                 || ((c) <= 'F' && (c) >= 'A'))
734 #   endif
735 #endif  /* ASCII range definitions */
736
737 /* Latin1 definitions */
738 #ifdef H_PERL
739 #   define isALNUMC_L1(c) _generic_isCC(c, _CC_ALNUMC)
740 #   define isALPHA_L1(c)  _generic_isCC(c, _CC_ALPHA)
741 #   define isBLANK_L1(c)  _generic_isCC(c, _CC_BLANK)
742
743 /*  continuation character for legal NAME in \N{NAME} */
744 #   define isCHARNAME_CONT(c) _generic_isCC(c, _CC_CHARNAME_CONT)
745
746 #   define isCNTRL_L1(c)  _generic_isCC(c, _CC_CNTRL)
747 #   define isGRAPH_L1(c)  _generic_isCC(c, _CC_GRAPH)
748 #   define isLOWER_L1(c)  _generic_isCC(c, _CC_LOWER)
749 #   define isPRINT_L1(c)  _generic_isCC(c, _CC_PRINT)
750 #   define isPSXSPC_L1(c) _generic_isCC(c, _CC_PSXSPC)
751 #   define isPUNCT_L1(c)  _generic_isCC(c, _CC_PUNCT)
752 #   define isSPACE_L1(c)  _generic_isCC(c, _CC_SPACE)
753 #   define isUPPER_L1(c)  _generic_isCC(c, _CC_UPPER)
754 #   define isWORDCHAR_L1(c) _generic_isCC(c, _CC_WORDCHAR)
755 #   define isIDFIRST_L1(c) _generic_isCC(c, _CC_IDFIRST)
756 #else /* No access to perl.h.  Only a few provided here, just in case needed
757        * for backwards compatibility */
758     /* ALPHAU includes Unicode semantics for latin1 characters.  It has an extra
759      * >= AA test to speed up ASCII-only tests at the expense of the others */
760 #   define isALPHA_L1(c) (isALPHA(c) || (NATIVE_TO_UNI((U8) c) >= 0xAA \
761         && ((NATIVE_TO_UNI((U8) c) >= 0xC0 \
762              && NATIVE_TO_UNI((U8) c) != 0xD7 && NATIVE_TO_UNI((U8) c) != 0xF7) \
763             || NATIVE_TO_UNI((U8) c) == 0xAA \
764             || NATIVE_TO_UNI((U8) c) == 0xB5 \
765             || NATIVE_TO_UNI((U8) c) == 0xBA)))
766 #   define isCHARNAME_CONT(c) (isWORDCHAR_L1(c)                         \
767                                || (c) == ' '                            \
768                                || (c) == '-'                            \
769                                || (c) == '('                            \
770                                || (c) == ')'                            \
771                                || (c) == ':'                            \
772                                || NATIVE_TO_UNI((U8) c) == 0xA0)
773 #endif
774
775 /* Macros for backwards compatibility and for completeness when the ASCII and
776  * Latin1 values are identical */
777 #define isALNUM(c)      isWORDCHAR(c)
778 #define isALNUMU(c)     isWORDCHAR_L1(c)
779 #define isALPHAU(c)     isALPHA_L1(c)
780 #define isDIGIT_L1(c)   isDIGIT_A(c)
781 #define isOCTAL(c)      isOCTAL_A(c)
782 #define isOCTAL_L1(c)   isOCTAL_A(c)
783 #define isXDIGIT_L1(c)  isXDIGIT_A(c)
784
785 /* Macros that differ between EBCDIC and ASCII.  Where C89 defines a function,
786  * that is used in the EBCDIC form, because in EBCDIC we do not do locales:
787  * therefore can use native functions.  For those where C89 doesn't define a
788  * function, use our function, assuming that the EBCDIC code page is isomorphic
789  * with Latin1, which the three currently recognized by Perl are.  Some libc's
790  * have an isblank(), but it's not guaranteed. */
791 #ifdef EBCDIC
792 #   define isALNUMC(c)  isalnum(c)
793 #   define isALPHA(c)   isalpha(c)
794 #   define isBLANK(c)   ((c) == ' ' || (c) == '\t' || NATIVE_TO_UNI(c) == 0xA0)
795 #   define isCNTRL(c)   iscntrl(c)
796 #   define isDIGIT(c)   isdigit(c)
797 #   define isGRAPH(c)   isgraph(c)
798 #   define isIDFIRST(c) (isALPHA(c) || (c) == '_')
799 #   define isLOWER(c)   islower(c)
800 #   define isPRINT(c)   isprint(c)
801 #   define isPSXSPC(c)  isspace(c)
802 #   define isPUNCT(c)   ispunct(c)
803 #   define isSPACE(c)   (isPSXSPC(c) /* && (c) != '\v' (Experimentally making
804                                         these macros identical) */)
805 #   define isUPPER(c)   isupper(c)
806 #   define isXDIGIT(c)  isxdigit(c)
807 #   define isWORDCHAR(c) (isalnum(c) || (c) == '_')
808 #   define toLOWER(c)   tolower(c)
809 #   define toUPPER(c)   toupper(c)
810 #else /* Not EBCDIC: ASCII-only matching */
811 #   define isALNUMC(c)  isALNUMC_A(c) /* Mnemonic: "C's alnum" = alpha + digit */
812 #   define isALPHA(c)   isALPHA_A(c)
813 #   define isBLANK(c)   isBLANK_A(c)
814 #   define isCNTRL(c)   isCNTRL_A(c)
815 #   define isDIGIT(c)   isDIGIT_A(c)
816 #   define isGRAPH(c)   isGRAPH_A(c)
817 #   define isIDFIRST(c) isIDFIRST_A(c)
818 #   define isLOWER(c)   isLOWER_A(c)
819 #   define isPRINT(c)   isPRINT_A(c)
820 #   define isPSXSPC(c)  isPSXSPC_A(c)
821 #   define isPUNCT(c)   isPUNCT_A(c)
822 #   define isSPACE(c)   isSPACE_A(c)
823 #   define isUPPER(c)   isUPPER_A(c)
824 #   define isWORDCHAR(c) isWORDCHAR_A(c)
825 #   define isXDIGIT(c)  isXDIGIT_A(c)
826
827     /* ASCII casing.  These could also be written as
828         #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
829         #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
830        which uses table lookup and mask instead of subtraction.  (This would
831        work because the _MOD does not apply in the ASCII range) */
832 #   define toLOWER(c)   (isUPPER(c) ? (c) + ('a' - 'A') : (c))
833 #   define toUPPER(c)   (isLOWER(c) ? (c) - ('a' - 'A') : (c))
834 #endif
835
836
837 /* Use table lookup for speed; return error character for input
838  * out-of-range */
839 #define toLOWER_LATIN1(c)    (FITS_IN_8_BITS(c)                            \
840                              ? UNI_TO_NATIVE(PL_latin1_lc[                 \
841                                                NATIVE_TO_UNI( (U8) (c)) ]) \
842                              : UNICODE_REPLACEMENT)
843 /* Modified uc.  Is correct uc except for three non-ascii chars which are
844  * all mapped to one of them, and these need special handling; error
845  * character for input out-of-range */
846 #define toUPPER_LATIN1_MOD(c) (FITS_IN_8_BITS(c)                           \
847                               ? UNI_TO_NATIVE(PL_mod_latin1_uc[            \
848                                                NATIVE_TO_UNI( (U8) (c)) ]) \
849                               : UNICODE_REPLACEMENT)
850
851 #ifdef USE_NEXT_CTYPE
852
853 #  define isWORDCHAR_LC(c) \
854         (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
855 #  define isALNUM_LC(c) isWORDCHAR_LC(c)
856 #  define isIDFIRST_LC(c) \
857         (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
858 #  define isALPHA_LC(c)         NXIsAlpha((unsigned int)(c))
859 #  define isASCII_LC(c)         isASCII((unsigned int)(c))
860 #  define isBLANK_LC(c)         isBLANK((unsigned int)(c))
861 #  define isSPACE_LC(c)         NXIsSpace((unsigned int)(c))
862 #  define isDIGIT_LC(c)         NXIsDigit((unsigned int)(c))
863 #  define isUPPER_LC(c)         NXIsUpper((unsigned int)(c))
864 #  define isLOWER_LC(c)         NXIsLower((unsigned int)(c))
865 #  define isALNUMC_LC(c)        NXIsAlNum((unsigned int)(c))
866 #  define isCNTRL_LC(c)         NXIsCntrl((unsigned int)(c))
867 #  define isGRAPH_LC(c)         NXIsGraph((unsigned int)(c))
868 #  define isPRINT_LC(c)         NXIsPrint((unsigned int)(c))
869 #  define isPUNCT_LC(c)         NXIsPunct((unsigned int)(c))
870 #  define isXDIGIT_LC(c)        NXIsXDigit((unsigned int)(c))
871 #  define toUPPER_LC(c)         NXToUpper((unsigned int)(c))
872 #  define toLOWER_LC(c)         NXToLower((unsigned int)(c))
873
874 #else /* !USE_NEXT_CTYPE */
875
876 #  if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
877
878 /* Use foo_LC_uvchr() instead  of these for beyond the Latin1 range */
879
880 #    define isWORDCHAR_LC(c) (FITS_IN_8_BITS(c)                                \
881                            && (isalnum((unsigned char)(c)) || (char)(c) == '_'))
882 #    define isALNUM_LC(c) isWORDCHAR_LC(c)
883 #    define isIDFIRST_LC(c) (FITS_IN_8_BITS(c)                                 \
884                            && (isalpha((unsigned char)(c)) || (char)(c) == '_'))
885 #    define isALPHA_LC(c)   (FITS_IN_8_BITS(c) && isalpha((unsigned char)(c)))
886 #    ifdef HAS_ISASCII
887 #       define isASCII_LC(c) (FITS_IN_8_BITS(c) && isascii((unsigned char)(c)))
888 #    else
889 #       define isASCII_LC(c) (FITS_IN_8_BITS(c) && isASCII((unsigned char)(c)))
890 #    endif
891 #    ifdef HAS_ISBLANK
892 #       define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isblank((unsigned char)(c)))
893 #    else
894 #       define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isBLANK((unsigned char)(c)))
895 #    endif
896 #    define isSPACE_LC(c)    (FITS_IN_8_BITS(c) && isspace((unsigned char)(c)))
897 #    define isDIGIT_LC(c)    (FITS_IN_8_BITS(c) && isdigit((unsigned char)(c)))
898 #    define isUPPER_LC(c)    (FITS_IN_8_BITS(c) && isupper((unsigned char)(c)))
899 #    define isLOWER_LC(c)    (FITS_IN_8_BITS(c) && islower((unsigned char)(c)))
900 #    define isALNUMC_LC(c)   (FITS_IN_8_BITS(c) && isalnum((unsigned char)(c)))
901 #    define isCNTRL_LC(c)    (FITS_IN_8_BITS(c) && iscntrl((unsigned char)(c)))
902 #    define isGRAPH_LC(c)    (FITS_IN_8_BITS(c) && isgraph((unsigned char)(c)))
903 #    define isPRINT_LC(c)    (FITS_IN_8_BITS(c) && isprint((unsigned char)(c)))
904 #    define isPUNCT_LC(c)    (FITS_IN_8_BITS(c) && ispunct((unsigned char)(c)))
905 #    define isXDIGIT_LC(c)   (FITS_IN_8_BITS(c) && isxdigit((unsigned char)(c)))
906 #    define toUPPER_LC(c) (FITS_IN_8_BITS(c) ? toupper((unsigned char)(c)) : (c))
907 #    define toLOWER_LC(c) (FITS_IN_8_BITS(c) ? tolower((unsigned char)(c)) : (c))
908
909 #  else
910
911 #    define isWORDCHAR_LC(c)    (isascii(c) && (isalnum(c) || (c) == '_'))
912 #    define isALNUM_LC(c)       isWORDCHAR_LC(c)
913 #    define isIDFIRST_LC(c)     (isascii(c) && (isalpha(c) || (c) == '_'))
914 #    define isALPHA_LC(c)       (isascii(c) && isalpha(c))
915 #    define isASCII_LC(c)       isascii(c)
916 #    ifdef HAS_ISBLANK
917 #       define isBLANK_LC(c)    (isascii(c) && isblank(c))
918 #    else
919 #       define isBLANK_LC(c)    isBLANK(c)
920 #    endif
921 #    define isSPACE_LC(c)       (isascii(c) && isspace(c))
922 #    define isDIGIT_LC(c)       (isascii(c) && isdigit(c))
923 #    define isUPPER_LC(c)       (isascii(c) && isupper(c))
924 #    define isLOWER_LC(c)       (isascii(c) && islower(c))
925 #    define isALNUMC_LC(c)      (isascii(c) && isalnum(c))
926 #    define isCNTRL_LC(c)       (isascii(c) && iscntrl(c))
927 #    define isGRAPH_LC(c)       (isascii(c) && isgraph(c))
928 #    define isPRINT_LC(c)       (isascii(c) && isprint(c))
929 #    define isPUNCT_LC(c)       (isascii(c) && ispunct(c))
930 #    define isXDIGIT_LC(c)      (isascii(c) && isxdigit(c))
931 #    define toUPPER_LC(c)       (isascii(c) ? toupper(c) : (c))
932 #    define toLOWER_LC(c)       (isascii(c) ? tolower(c) : (c))
933
934 #  endif
935 #endif /* USE_NEXT_CTYPE */
936
937 #define isPSXSPC_LC(c)          isSPACE_LC(c)
938
939 /* For internal core Perl use only.  If the input is Latin1, use the Latin1
940  * macro; otherwise use the function.  Won't compile if 'c' isn't unsigned, as
941  * won't match function prototype. The macros do bounds checking, so have
942  * duplicate checks here, so could create versions of the macros that don't,
943  * but experiments show that gcc optimizes them out anyway. */
944
945 /* Note that all ignore 'use bytes' */
946 #define _generic_uni(classnum, function, c) ((c) < 256                    \
947                                              ? _generic_isCC(c, classnum) \
948                                              : function(c))
949
950 #define isWORDCHAR_uni(c)   _generic_uni(_CC_WORDCHAR, is_uni_alnum, c)
951 #define isALNUM_uni(c)      isWORDCHAR_uni(c)
952 #define isBLANK_uni(c)      _generic_uni(_CC_BLANK, is_HORIZWS_cp_high, c)
953 #define isIDFIRST_uni(c)    _generic_uni(_CC_IDFIRST, _is_uni_perl_idstart, c)
954 #define isALPHA_uni(c)      _generic_uni(_CC_ALPHA, is_uni_alpha, c)
955 #define isALNUMC_uni(c)     _generic_uni(_CC_ALNUMC, is_uni_alnumc, c)
956 #define isSPACE_uni(c)      _generic_uni(_CC_SPACE, is_XPERLSPACE_cp_high, c)
957 #define isVERTWS_uni(c)     _generic_uni(_CC_VERTSPACE, is_VERTWS_cp_high, c)
958 #define isDIGIT_uni(c)      _generic_uni(_CC_DIGIT, is_uni_digit, c)
959 #define isUPPER_uni(c)      _generic_uni(_CC_UPPER, is_uni_upper, c)
960 #define isLOWER_uni(c)      _generic_uni(_CC_LOWER, is_uni_lower, c)
961 #define isASCII_uni(c)      isASCII(c)
962
963 /* All controls are in Latin1 */
964 #define isCNTRL_uni(c)          isCNTRL_L1(c)
965
966 #define isGRAPH_uni(c)          _generic_uni(_CC_GRAPH, is_uni_graph, c)
967 #define isPRINT_uni(c)          _generic_uni(_CC_PRINT, is_uni_print, c)
968 #define isPUNCT_uni(c)          _generic_uni(_CC_PUNCT, is_uni_punct, c)
969 #define isXDIGIT_uni(c)         _generic_uni(_CC_XDIGIT, is_XDIGIT_cp_high, c)
970
971 /* Posix and regular space differ only the ASCII-range, so uses the same
972  * above-latin1 function */
973 #define isPSXSPC_uni(c)         _generic_uni(_CC_PSXSPC,                \
974                                              is_XPERLSPACE_cp_high, c)
975
976 #define toUPPER_uni(c,s,l)      to_uni_upper(c,s,l)
977 #define toTITLE_uni(c,s,l)      to_uni_title(c,s,l)
978 #define toLOWER_uni(c,s,l)      to_uni_lower(c,s,l)
979 #define toFOLD_uni(c,s,l)       to_uni_fold(c,s,l)
980
981 #define _gnrc_is_LC_uvchr(latin1, above_latin1, c)                            \
982                         (c < 256 ? latin1(c) : above_latin1(NATIVE_TO_UNI(c)))
983 #define isWORDCHAR_LC_uvchr(c)  _gnrc_is_LC_uvchr(isWORDCHAR_LC,              \
984                                                         is_uni_alnum_lc, c)
985 #define isALNUM_LC_uvchr(c)  isWORDCHAR_LC_uvchr(c)
986 #define isIDFIRST_LC_uvchr(c)  _gnrc_is_LC_uvchr(isIDFIRST_LC,                 \
987                                                         is_uni_idfirst_lc, c)
988 #define isALPHA_LC_uvchr(c)  _gnrc_is_LC_uvchr(isALPHA_LC, is_uni_alpha_lc, c)
989 #define isALNUMC_LC_uvchr(c)  _gnrc_is_LC_uvchr(isALNUMC_LC, is_uni_alnumc_lc, c)
990 #define isSPACE_LC_uvchr(c)  _gnrc_is_LC_uvchr(isSPACE_LC,                     \
991                                                        is_XPERLSPACE_cp_high, c)
992 #define isDIGIT_LC_uvchr(c)  _gnrc_is_LC_uvchr(isDIGIT_LC, is_uni_digit_lc, c)
993 #define isUPPER_LC_uvchr(c)  _gnrc_is_LC_uvchr(isUPPER_LC, is_uni_upper_lc, c)
994 #define isLOWER_LC_uvchr(c)  _gnrc_is_LC_uvchr(isLOWER_LC, is_uni_lower_lc, c)
995 #define isCNTRL_LC_uvchr(c)  (c < 256 ? isCNTRL_LC(c) : 0)
996 #define isGRAPH_LC_uvchr(c)  _gnrc_is_LC_uvchr(isGRAPH_LC, is_uni_graph_lc, c)
997 #define isPRINT_LC_uvchr(c)  _gnrc_is_LC_uvchr(isPRINT_LC, is_uni_print_lc, c)
998 #define isPUNCT_LC_uvchr(c)  _gnrc_is_LC_uvchr(isPUNCT_LC, is_uni_punct_lc, c)
999 #define isBLANK_LC_uvchr(c)  _gnrc_is_LC_uvchr(isBLANK_LC, is_HORIZWS_cp_high, c)
1000 #define isXDIGIT_LC_uvchr(c) _gnrc_is_LC_uvchr(isXDIGIT_LC, is_XDIGIT_cp_high, c)
1001 #define isASCII_LC_uvchr(c)  isASCII_LC(c)
1002
1003 /* space is identical to posix space under locale */
1004 #define isPSXSPC_LC_uvchr(c) isSPACE_LC_uvchr(c)
1005
1006 #define isBLANK_LC_uni(c)       isBLANK(c) /* could be wrong */
1007
1008 /* For internal core Perl use only.  If the input is in the Latin1 range, use
1009  * the Latin1 macro 'classnum' on 'p' which is a pointer to a UTF-8 string.
1010  * Otherwise use the value given by the 'utf8' parameter.  This relies on the
1011  * fact that ASCII characters have the same representation whether utf8 or not.
1012  * Note that it assumes that the utf8 has been validated, and ignores 'use
1013  * bytes' */
1014 #define _generic_utf8_utf8(classnum, p, utf8) (UTF8_IS_INVARIANT(*(p))         \
1015                                          ? _generic_isCC(*(p), classnum)       \
1016                                          : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
1017                                            ? _generic_isCC(                    \
1018                                                    TWO_BYTE_UTF8_TO_UNI(*(p),  \
1019                                                                    *((p)+1 )), \
1020                                                    classnum)                   \
1021                                            : utf8)
1022 /* Like the above, but calls 'function(p)' to get the utf8 value */
1023 #define _generic_utf8(classnum, function, p)  \
1024                                     _generic_utf8_utf8(classnum, p, function(p))
1025
1026 #define isWORDCHAR_utf8(p)      _generic_utf8(_CC_WORDCHAR, is_utf8_alnum, p)
1027 #define isALNUM_utf8(p)         isWORDCHAR_utf8(p)  /* back compat */
1028
1029 /* To prevent S_scan_word in toke.c from hanging, we have to make sure that
1030  * IDFIRST is an alnum.  See
1031  * http://rt.perl.org/rt3/Ticket/Display.html?id=74022 for more detail than you
1032  * ever wanted to know about.  (In the ASCII range, there isn't a difference.)
1033  * This used to be not the XID version, but we decided to go with the more
1034  * modern Unicode definition */
1035 #define isIDFIRST_utf8(p)       _generic_utf8(_CC_IDFIRST,               \
1036                                               _is_utf8_perl_idstart, p)
1037
1038 #define isIDCONT_utf8(p)        _generic_utf8(_CC_WORDCHAR, is_utf8_xidcont, p)
1039 #define isALPHA_utf8(p)         _generic_utf8(_CC_ALPHA, is_utf8_alpha, p)
1040 #define isALNUMC_utf8(p)        _generic_utf8(_CC_ALNUMC, is_utf8_alnumc, p)
1041 #define isBLANK_utf8(p)         _generic_utf8(_CC_BLANK, is_HORIZWS_high, p)
1042 #define isSPACE_utf8(p)         _generic_utf8(_CC_SPACE, is_XPERLSPACE_high, p)
1043 #define isVERTWS_utf8(p)        _generic_utf8(_CC_VERTSPACE, is_VERTWS_high, p)
1044 #define isDIGIT_utf8(p)         _generic_utf8(_CC_DIGIT, is_utf8_digit, p)
1045 #define isUPPER_utf8(p)         _generic_utf8(_CC_UPPER, is_utf8_upper, p)
1046 #define isLOWER_utf8(p)         _generic_utf8(_CC_LOWER, is_utf8_lower, p)
1047
1048 /* Because ASCII is invariant under utf8, the non-utf8 macro works */
1049 #define isASCII_utf8(p)         isASCII(*p)
1050
1051 #define isCNTRL_utf8(p)         _generic_utf8_utf8(_CC_CNTRL, p, 0)
1052 #define isGRAPH_utf8(p)         _generic_utf8(_CC_GRAPH, is_utf8_graph, p)
1053 #define isPRINT_utf8(p)         _generic_utf8(_CC_PRINT, is_utf8_print, p)
1054 #define isPUNCT_utf8(p)         _generic_utf8(_CC_PUNCT, is_utf8_punct, p)
1055 #define isXDIGIT_utf8(p)        _generic_utf8(_CC_XDIGIT, is_XDIGIT_high, p)
1056 #define toUPPER_utf8(p,s,l)     to_utf8_upper(p,s,l)
1057 #define toTITLE_utf8(p,s,l)     to_utf8_title(p,s,l)
1058 #define toLOWER_utf8(p,s,l)     to_utf8_lower(p,s,l)
1059
1060 /* Posix and regular space differ only in the ASCII range, so uses the same
1061  * above-Latin1 function */
1062 #define isPSXSPC_utf8(p)        _generic_utf8(_CC_PSXSPC, is_XPERLSPACE_high, p)
1063
1064 /* For internal core Perl use only.  If the input is in the Latin1 range, use
1065  * the macro 'macro' on 'p' which is a pointer to a UTF-8 string.  Otherwise
1066  * use the value given by the 'utf8' parameter.  This relies on the fact that
1067  * ASCII characters have the same representation whether utf8 or not.  Note
1068  * that it assumes that the utf8 has been validated, and ignores 'use bytes' */
1069 #define _generic_LC_utf8_utf8(macro, p, utf8) \
1070                          (UTF8_IS_INVARIANT(*(p))                          \
1071                          ? macro(*(p))                                     \
1072                          : (UTF8_IS_DOWNGRADEABLE_START(*(p)))             \
1073                            ? macro(TWO_BYTE_UTF8_TO_UNI(*(p), *((p)+1)))   \
1074                            : utf8)
1075
1076 #define _generic_LC_utf8(macro, utf8_func, p)                              \
1077                             _generic_LC_utf8_utf8(macro, p, utf8_func(p))
1078
1079 #define isWORDCHAR_LC_utf8(p) _generic_LC_utf8(isWORDCHAR_LC, is_utf8_alnum, p)
1080 #define isALNUM_LC_utf8(p)   isWORDCHAR_LC_utf8(p)
1081 #define isIDFIRST_LC_utf8(p) _generic_LC_utf8(isIDFIRST_LC,                \
1082                                                     _is_utf8_perl_idstart, p)
1083 #define isALPHA_LC_utf8(p)   _generic_LC_utf8(isALPHA_LC, is_utf8_alpha, p)
1084 #define isBLANK_LC_utf8(p)   _generic_LC_utf8(isBLANK_LC, is_HORIZWS_high, p)
1085 #define isSPACE_LC_utf8(p)   _generic_LC_utf8(isSPACE_LC, is_XPERLSPACE_high, p)
1086 #define isDIGIT_LC_utf8(p)   _generic_LC_utf8(isDIGIT_LC, is_utf8_digit, p)
1087 #define isUPPER_LC_utf8(p)   _generic_LC_utf8(isUPPER_LC, is_utf8_upper, p)
1088 #define isLOWER_LC_utf8(p)   _generic_LC_utf8(isLOWER_LC, is_utf8_lower, p)
1089 #define isALNUMC_LC_utf8(p)  _generic_LC_utf8(isALNUMC_LC, is_utf8_alnumc, p)
1090 #define isCNTRL_LC_utf8(p)   _generic_LC_utf8_utf8(isCNTRL_LC, p, 0)
1091 #define isGRAPH_LC_utf8(p)   _generic_LC_utf8(isGRAPH_LC, is_utf8_graph, p)
1092 #define isPRINT_LC_utf8(p)   _generic_LC_utf8(isPRINT_LC, is_utf8_print, p)
1093 #define isPUNCT_LC_utf8(p)   _generic_LC_utf8(isPUNCT_LC, is_utf8_punct, p)
1094 #define isXDIGIT_LC_utf8(p)  _generic_LC_utf8(isXDIGIT_LC, is_XDIGIT_high, p)
1095 #define isASCII_LC_utf8(p)   isASCII_LC(*p)
1096
1097 /* space is identical to posix space under locale */
1098 #define isPSXSPC_LC_utf8(p)     isSPACE_LC_utf8(p)
1099
1100 /* This conversion works both ways, strangely enough. On EBCDIC platforms,
1101  * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII, except that they don't
1102  * necessarily mean the same characters, e.g. CTRL-D is 4 on both systems, but
1103  * that is EOT on ASCII;  ST on EBCDIC */
1104 #  define toCTRL(c)    (toUPPER(NATIVE_TO_UNI(c)) ^ 64)
1105
1106 /* Line numbers are unsigned, 32 bits. */
1107 typedef U32 line_t;
1108 #define NOLINE ((line_t) 4294967295UL)  /* = FFFFFFFF */
1109
1110 /* Helpful alias for version prescan */
1111 #define is_LAX_VERSION(a,b) \
1112         (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
1113
1114 #define is_STRICT_VERSION(a,b) \
1115         (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
1116
1117 #define BADVERSION(a,b,c) \
1118         if (b) { \
1119             *b = c; \
1120         } \
1121         return a;
1122
1123 #define READ_XDIGIT(s) (isALPHA(*(s)) ? ((*(s)++ + 9) & 0xf) : (*(s)++ & 0xf))
1124
1125 /*
1126 =head1 Memory Management
1127
1128 =for apidoc Am|void|Newx|void* ptr|int nitems|type
1129 The XSUB-writer's interface to the C C<malloc> function.
1130
1131 In 5.9.3, Newx() and friends replace the older New() API, and drops
1132 the first parameter, I<x>, a debug aid which allowed callers to identify
1133 themselves.  This aid has been superseded by a new build option,
1134 PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>).  The older API is still
1135 there for use in XS modules supporting older perls.
1136
1137 =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
1138 The XSUB-writer's interface to the C C<malloc> function, with
1139 cast.  See also C<Newx>.
1140
1141 =for apidoc Am|void|Newxz|void* ptr|int nitems|type
1142 The XSUB-writer's interface to the C C<malloc> function.  The allocated
1143 memory is zeroed with C<memzero>.  See also C<Newx>.
1144
1145 =for apidoc Am|void|Renew|void* ptr|int nitems|type
1146 The XSUB-writer's interface to the C C<realloc> function.
1147
1148 =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
1149 The XSUB-writer's interface to the C C<realloc> function, with
1150 cast.
1151
1152 =for apidoc Am|void|Safefree|void* ptr
1153 The XSUB-writer's interface to the C C<free> function.
1154
1155 =for apidoc Am|void|Move|void* src|void* dest|int nitems|type
1156 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
1157 source, C<dest> is the destination, C<nitems> is the number of items, and
1158 C<type> is the type.  Can do overlapping moves.  See also C<Copy>.
1159
1160 =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
1161 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1162 optimise.
1163
1164 =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
1165 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
1166 source, C<dest> is the destination, C<nitems> is the number of items, and
1167 C<type> is the type.  May fail on overlapping copies.  See also C<Move>.
1168
1169 =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
1170
1171 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1172 optimise.
1173
1174 =for apidoc Am|void|Zero|void* dest|int nitems|type
1175
1176 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
1177 destination, C<nitems> is the number of items, and C<type> is the type.
1178
1179 =for apidoc Am|void *|ZeroD|void* dest|int nitems|type
1180
1181 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1182 optimise.
1183
1184 =for apidoc Am|void|StructCopy|type *src|type *dest|type
1185 This is an architecture-independent macro to copy one structure to another.
1186
1187 =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
1188
1189 Fill up memory with a byte pattern (a byte repeated over and over
1190 again) that hopefully catches attempts to access uninitialized memory.
1191
1192 =for apidoc Am|void|PoisonNew|void* dest|int nitems|type
1193
1194 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
1195
1196 =for apidoc Am|void|PoisonFree|void* dest|int nitems|type
1197
1198 PoisonWith(0xEF) for catching access to freed memory.
1199
1200 =for apidoc Am|void|Poison|void* dest|int nitems|type
1201
1202 PoisonWith(0xEF) for catching access to freed memory.
1203
1204 =cut */
1205
1206 /* Maintained for backwards-compatibility only. Use newSV() instead. */
1207 #ifndef PERL_CORE
1208 #define NEWSV(x,len)    newSV(len)
1209 #endif
1210
1211 #define MEM_SIZE_MAX ((MEM_SIZE)~0)
1212
1213 /* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
1214  * overly eager compilers that will bleat about e.g.
1215  * (U16)n > (size_t)~0/sizeof(U16) always being false. */
1216 #ifdef PERL_MALLOC_WRAP
1217 #define MEM_WRAP_CHECK(n,t) \
1218         (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (croak_memory_wrap(),0))
1219 #define MEM_WRAP_CHECK_1(n,t,a) \
1220         (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
1221 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
1222
1223 #define PERL_STRLEN_ROUNDUP(n) ((void)(((n) > MEM_SIZE_MAX - 2 * PERL_STRLEN_ROUNDUP_QUANTUM) ? (croak_memory_wrap(),0):0),((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
1224 #else
1225
1226 #define MEM_WRAP_CHECK(n,t)
1227 #define MEM_WRAP_CHECK_1(n,t,a)
1228 #define MEM_WRAP_CHECK_2(n,t,a,b)
1229 #define MEM_WRAP_CHECK_(n,t)
1230
1231 #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
1232
1233 #endif
1234
1235 #ifdef PERL_MEM_LOG
1236 /*
1237  * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
1238  * go through functions, which are handy for debugging breakpoints, but
1239  * which more importantly get the immediate calling environment (file and
1240  * line number, and C function name if available) passed in.  This info can
1241  * then be used for logging the calls, for which one gets a sample
1242  * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
1243  *
1244  * Known problems:
1245  * - not all memory allocs get logged, only those
1246  *   that go through Newx() and derivatives (while all
1247  *   Safefrees do get logged)
1248  * - __FILE__ and __LINE__ do not work everywhere
1249  * - __func__ or __FUNCTION__ even less so
1250  * - I think more goes on after the perlio frees but
1251  *   the thing is that STDERR gets closed (as do all
1252  *   the file descriptors)
1253  * - no deeper calling stack than the caller of the Newx()
1254  *   or the kind, but do I look like a C reflection/introspection
1255  *   utility to you?
1256  * - the function prototypes for the logging functions
1257  *   probably should maybe be somewhere else than handy.h
1258  * - one could consider inlining (macrofying) the logging
1259  *   for speed, but I am too lazy
1260  * - one could imagine recording the allocations in a hash,
1261  *   (keyed by the allocation address?), and maintain that
1262  *   through reallocs and frees, but how to do that without
1263  *   any News() happening...?
1264  * - lots of -Ddefines to get useful/controllable output
1265  * - lots of ENV reads
1266  */
1267
1268 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);
1269
1270 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);
1271
1272 PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
1273
1274 # ifdef PERL_CORE
1275 #  ifndef PERL_MEM_LOG_NOIMPL
1276 enum mem_log_type {
1277   MLT_ALLOC,
1278   MLT_REALLOC,
1279   MLT_FREE,
1280   MLT_NEW_SV,
1281   MLT_DEL_SV
1282 };
1283 #  endif
1284 #  if defined(PERL_IN_SV_C)  /* those are only used in sv.c */
1285 void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1286 void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1287 #  endif
1288 # endif
1289
1290 #endif
1291
1292 #ifdef PERL_MEM_LOG
1293 #define MEM_LOG_ALLOC(n,t,a)     Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
1294 #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
1295 #define MEM_LOG_FREE(a)          Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
1296 #endif
1297
1298 #ifndef MEM_LOG_ALLOC
1299 #define MEM_LOG_ALLOC(n,t,a)     (a)
1300 #endif
1301 #ifndef MEM_LOG_REALLOC
1302 #define MEM_LOG_REALLOC(n,t,v,a) (a)
1303 #endif
1304 #ifndef MEM_LOG_FREE
1305 #define MEM_LOG_FREE(a)          (a)
1306 #endif
1307
1308 #define Newx(v,n,t)     (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1309 #define Newxc(v,n,t,c)  (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1310 #define Newxz(v,n,t)    (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
1311
1312 #ifndef PERL_CORE
1313 /* pre 5.9.x compatibility */
1314 #define New(x,v,n,t)    Newx(v,n,t)
1315 #define Newc(x,v,n,t,c) Newxc(v,n,t,c)
1316 #define Newz(x,v,n,t)   Newxz(v,n,t)
1317 #endif
1318
1319 #define Renew(v,n,t) \
1320           (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1321 #define Renewc(v,n,t,c) \
1322           (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1323
1324 #ifdef PERL_POISON
1325 #define Safefree(d) \
1326   ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
1327 #else
1328 #define Safefree(d)     safefree(MEM_LOG_FREE((Malloc_t)(d)))
1329 #endif
1330
1331 #define Move(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1332 #define Copy(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1333 #define Zero(d,n,t)     (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
1334
1335 #define MoveD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1336 #define CopyD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1337 #ifdef HAS_MEMSET
1338 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
1339 #else
1340 /* Using bzero(), which returns void.  */
1341 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
1342 #endif
1343
1344 #define PoisonWith(d,n,t,b)     (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
1345 #define PoisonNew(d,n,t)        PoisonWith(d,n,t,0xAB)
1346 #define PoisonFree(d,n,t)       PoisonWith(d,n,t,0xEF)
1347 #define Poison(d,n,t)           PoisonFree(d,n,t)
1348
1349 #ifdef USE_STRUCT_COPY
1350 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
1351 #else
1352 #define StructCopy(s,d,t) Copy(s,d,1,t)
1353 #endif
1354
1355 #define C_ARRAY_LENGTH(a)       (sizeof(a)/sizeof((a)[0]))
1356 #define C_ARRAY_END(a)          (a) + (sizeof(a)/sizeof((a)[0]))
1357
1358 #ifdef NEED_VA_COPY
1359 # ifdef va_copy
1360 #  define Perl_va_copy(s, d) va_copy(d, s)
1361 # else
1362 #  if defined(__va_copy)
1363 #   define Perl_va_copy(s, d) __va_copy(d, s)
1364 #  else
1365 #   define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
1366 #  endif
1367 # endif
1368 #endif
1369
1370 /* convenience debug macros */
1371 #ifdef USE_ITHREADS
1372 #define pTHX_FORMAT  "Perl interpreter: 0x%p"
1373 #define pTHX__FORMAT ", Perl interpreter: 0x%p"
1374 #define pTHX_VALUE_   (void *)my_perl,
1375 #define pTHX_VALUE    (void *)my_perl
1376 #define pTHX__VALUE_ ,(void *)my_perl,
1377 #define pTHX__VALUE  ,(void *)my_perl
1378 #else
1379 #define pTHX_FORMAT
1380 #define pTHX__FORMAT
1381 #define pTHX_VALUE_
1382 #define pTHX_VALUE
1383 #define pTHX__VALUE_
1384 #define pTHX__VALUE
1385 #endif /* USE_ITHREADS */
1386
1387 /* Perl_deprecate was not part of the public API, and did not have a deprecate()
1388    shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
1389    CPAN::Unpack show any users outside the core.  */
1390 #ifdef PERL_CORE
1391 #  define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
1392 #endif
1393
1394 /*
1395  * Local variables:
1396  * c-indentation-style: bsd
1397  * c-basic-offset: 4
1398  * indent-tabs-mode: nil
1399  * End:
1400  *
1401  * ex: set ts=8 sts=4 sw=4 et:
1402  */