This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
handy.h: clarify, typos in comment
[perl5.git] / handy.h
CommitLineData
a0d0e21e 1/* handy.h
a687059c 2 *
1129b882
NC
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000,
4 * 2001, 2002, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
a687059c 5 *
6e21c824
LW
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8d063cd8 8 *
8d063cd8
LW
9 */
10
85e6fe83 11#if !defined(__STDC__)
378cc40b
LW
12#ifdef NULL
13#undef NULL
14#endif
a687059c
LW
15#ifndef I286
16# define NULL 0
17#else
18# define NULL 0L
19#endif
85e6fe83
LW
20#endif
21
24792b8d
NC
22#ifndef PERL_CORE
23# define Null(type) ((type)NULL)
954c1994
GS
24
25/*
ccfc67b7 26=head1 Handy Values
954c1994 27
3609ea0d 28=for apidoc AmU||Nullch
24792b8d 29Null character pointer. (No longer available when C<PERL_CORE> is defined.)
2307c6d0 30
954c1994 31=for apidoc AmU||Nullsv
24792b8d 32Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
954c1994
GS
33
34=cut
35*/
36
24792b8d
NC
37# define Nullch Null(char*)
38# define Nullfp Null(PerlIO*)
39# define Nullsv Null(SV*)
40#endif
8d063cd8 41
641d3f0b
PP
42#ifdef TRUE
43#undef TRUE
44#endif
45#ifdef FALSE
46#undef FALSE
47#endif
48#define TRUE (1)
49#define FALSE (0)
50
cf3f0ffb
DM
51/* The MUTABLE_*() macros cast pointers to the types shown, in such a way
52 * (compiler permitting) that casting away const-ness will give a warning;
53 * e.g.:
54 *
55 * const SV *sv = ...;
56 * AV *av1 = (AV*)sv; <== BAD: the const has been silently cast away
57 * AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
58 */
59
b1bc3f34 60#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
f065df04 61# define MUTABLE_PTR(p) ({ void *_p = (p); _p; })
b1bc3f34
NC
62#else
63# define MUTABLE_PTR(p) ((void *) (p))
64#endif
65
a062e10d 66#define MUTABLE_AV(p) ((AV *)MUTABLE_PTR(p))
ea726b52 67#define MUTABLE_CV(p) ((CV *)MUTABLE_PTR(p))
159b6efe 68#define MUTABLE_GV(p) ((GV *)MUTABLE_PTR(p))
dbebbdb4 69#define MUTABLE_HV(p) ((HV *)MUTABLE_PTR(p))
a45c7426 70#define MUTABLE_IO(p) ((IO *)MUTABLE_PTR(p))
b1bc3f34 71#define MUTABLE_SV(p) ((SV *)MUTABLE_PTR(p))
27d4fb96 72
bd31be4b
NC
73#ifdef I_STDBOOL
74# include <stdbool.h>
75# ifndef HAS_BOOL
76# define HAS_BOOL 1
77# endif
78#endif
79
8e84507e 80/* bool is built-in for g++-2.6.3 and later, which might be used
c1d22f6b
GS
81 for extensions. <_G_config.h> defines _G_HAVE_BOOL, but we can't
82 be sure _G_config.h will be included before this file. _G_config.h
8e84507e 83 also defines _G_HAVE_BOOL for both gcc and g++, but only g++
c1d22f6b
GS
84 actually has bool. Hence, _G_HAVE_BOOL is pretty useless for us.
85 g++ can be identified by __GNUG__.
86 Andy Dougherty February 2000
5d94fbed 87*/
3609ea0d 88#ifdef __GNUG__ /* GNU g++ has bool built-in */
5d94fbed 89# ifndef HAS_BOOL
c1d22f6b 90# define HAS_BOOL 1
5d94fbed 91# endif
5d94fbed
AD
92#endif
93
641d3f0b
PP
94/* The NeXT dynamic loader headers will not build with the bool macro
95 So declare them now to clear confusion.
96*/
8f1f23e8 97#if defined(NeXT) || defined(__NeXT__)
641d3f0b
PP
98# undef FALSE
99# undef TRUE
100 typedef enum bool { FALSE = 0, TRUE = 1 } bool;
101# define ENUM_BOOL 1
102# ifndef HAS_BOOL
103# define HAS_BOOL 1
104# endif /* !HAS_BOOL */
8f1f23e8 105#endif /* NeXT || __NeXT__ */
641d3f0b 106
5d94fbed 107#ifndef HAS_BOOL
61bb5906 108# if defined(UTS) || defined(VMS)
5d94fbed
AD
109# define bool int
110# else
111# define bool char
112# endif
c1d22f6b 113# define HAS_BOOL 1
a687059c 114#endif
0d3e774c 115
f2338a2e
DM
116/* a simple (bool) cast may not do the right thing: if bool is defined
117 * as char for example, then the cast from int is implementation-defined
118 */
119
120#define cBOOL(cbool) ((bool)!!(cbool))
121
46c6c7e2 122/* Try to figure out __func__ or __FUNCTION__ equivalent, if any.
e352bcff
JH
123 * XXX Should really be a Configure probe, with HAS__FUNCTION__
124 * and FUNCTION__ as results.
125 * XXX Similarly, a Configure probe for __FILE__ and __LINE__ is needed. */
46c6c7e2
JH
126#if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || (defined(__SUNPRO_C)) /* C99 or close enough. */
127# define FUNCTION__ __func__
128#else
129# if (defined(_MSC_VER) && _MSC_VER < 1300) || /* Pre-MSVC 7.0 has neither __func__ nor __FUNCTION and no good workarounds, either. */ \
be73ebb0 130 (defined(__DECC_VER)) /* Tru64 or VMS, and strict C89 being used, but not modern enough cc (in Tur64, -c99 not known, only -std1). */
46c6c7e2
JH
131# define FUNCTION__ ""
132# else
133# define FUNCTION__ __FUNCTION__ /* Common extension. */
134# endif
135#endif
136
27d4fb96
PP
137/* XXX A note on the perl source internal type system. The
138 original intent was that I32 be *exactly* 32 bits.
139
140 Currently, we only guarantee that I32 is *at least* 32 bits.
141 Specifically, if int is 64 bits, then so is I32. (This is the case
142 for the Cray.) This has the advantage of meshing nicely with
143 standard library calls (where we pass an I32 and the library is
144 expecting an int), but the disadvantage that an I32 is not 32 bits.
145 Andy Dougherty August 1996
24fef2a7 146
dc45a647
MB
147 There is no guarantee that there is *any* integral type with
148 exactly 32 bits. It is perfectly legal for a system to have
149 sizeof(short) == sizeof(int) == sizeof(long) == 8.
693762b4 150
dc45a647
MB
151 Similarly, there is no guarantee that I16 and U16 have exactly 16
152 bits.
693762b4 153
8e84507e
NIS
154 For dealing with issues that may arise from various 32/64-bit
155 systems, we will ask Configure to check out
8175356b 156
3609ea0d
JH
157 SHORTSIZE == sizeof(short)
158 INTSIZE == sizeof(int)
159 LONGSIZE == sizeof(long)
dc45a647 160 LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
3609ea0d 161 PTRSIZE == sizeof(void *)
dc45a647
MB
162 DOUBLESIZE == sizeof(double)
163 LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
8175356b 164
27d4fb96
PP
165*/
166
69512466
JH
167#ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
168# include <inttypes.h>
dd0eed91
JH
169# ifdef INT32_MIN_BROKEN
170# undef INT32_MIN
171# define INT32_MIN (-2147483647-1)
172# endif
173# ifdef INT64_MIN_BROKEN
174# undef INT64_MIN
175# define INT64_MIN (-9223372036854775807LL-1)
176# endif
69512466
JH
177#endif
178
8175356b
JH
179typedef I8TYPE I8;
180typedef U8TYPE U8;
181typedef I16TYPE I16;
182typedef U16TYPE U16;
183typedef I32TYPE I32;
184typedef U32TYPE U32;
6b8eaf93
JH
185#ifdef PERL_CORE
186# ifdef HAS_QUAD
8175356b
JH
187typedef I64TYPE I64;
188typedef U64TYPE U64;
6b8eaf93
JH
189# endif
190#endif /* PERL_CORE */
8175356b 191
69512466
JH
192#if defined(HAS_QUAD) && defined(USE_64_BIT_INT)
193# ifndef UINT64_C /* usually from <inttypes.h> */
194# if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
195# define INT64_C(c) CAT2(c,LL)
196# define UINT64_C(c) CAT2(c,ULL)
197# else
198# if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
199# define INT64_C(c) CAT2(c,L)
200# define UINT64_C(c) CAT2(c,UL)
201# else
fa58a56f
S
202# if defined(_WIN64) && defined(_MSC_VER)
203# define INT64_C(c) CAT2(c,I64)
204# define UINT64_C(c) CAT2(c,UI64)
205# else
206# define INT64_C(c) ((I64TYPE)(c))
207# define UINT64_C(c) ((U64TYPE)(c))
208# endif
69512466
JH
209# endif
210# endif
e8c95190
JH
211# endif
212#endif
dc750f2e 213
d8668976 214#if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
5ff3f7a4 215
5ff3f7a4
GS
216/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
217 Please search CHAR_MAX in perl.h for further details. */
218#define U8_MAX UINT8_MAX
219#define U8_MIN UINT8_MIN
220
5ff3f7a4
GS
221#define I16_MAX INT16_MAX
222#define I16_MIN INT16_MIN
223#define U16_MAX UINT16_MAX
224#define U16_MIN UINT16_MIN
225
5ff3f7a4
GS
226#define I32_MAX INT32_MAX
227#define I32_MIN INT32_MIN
0e983133
GS
228#ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
229# define U32_MAX UINT32_MAX
230#else
231# define U32_MAX 4294967295U
232#endif
5ff3f7a4
GS
233#define U32_MIN UINT32_MIN
234
235#else
236
5c9fa16e
KA
237/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
238 Please search CHAR_MAX in perl.h for further details. */
27d4fb96
PP
239#define U8_MAX PERL_UCHAR_MAX
240#define U8_MIN PERL_UCHAR_MIN
79072805 241
27d4fb96
PP
242#define I16_MAX PERL_SHORT_MAX
243#define I16_MIN PERL_SHORT_MIN
244#define U16_MAX PERL_USHORT_MAX
245#define U16_MIN PERL_USHORT_MIN
79072805 246
c4f23d77 247#if LONGSIZE > 4
27d4fb96
PP
248# define I32_MAX PERL_INT_MAX
249# define I32_MIN PERL_INT_MIN
250# define U32_MAX PERL_UINT_MAX
251# define U32_MIN PERL_UINT_MIN
79072805 252#else
27d4fb96
PP
253# define I32_MAX PERL_LONG_MAX
254# define I32_MIN PERL_LONG_MIN
255# define U32_MAX PERL_ULONG_MAX
256# define U32_MIN PERL_ULONG_MIN
79072805
LW
257#endif
258
5ff3f7a4
GS
259#endif
260
58a9a5d5 261/* log(2) is pretty close to 0.30103, just in case anyone is grepping for it */
fc36a67e
PP
262#define BIT_DIGITS(N) (((N)*146)/485 + 1) /* log2(10) =~ 146/485 */
263#define TYPE_DIGITS(T) BIT_DIGITS(sizeof(T) * 8)
264#define TYPE_CHARS(T) (TYPE_DIGITS(T) + 2) /* sign, NUL */
265
ff68c719 266#define Ctl(ch) ((ch) & 037)
8d063cd8 267
3fe05580
MHM
268/*
269=head1 SV-Body Allocation
270
271=for apidoc Ama|SV*|newSVpvs|const char* s
272Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
273
84bafc02
NC
274=for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags
275Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
276pair.
277
3fe05580
MHM
278=for apidoc Ama|SV*|newSVpvs_share|const char* s
279Like C<newSVpvn_share>, but takes a literal string instead of a string/length
280pair and omits the hash parameter.
281
9dcc53ea
Z
282=for apidoc Am|void|sv_catpvs_flags|SV* sv|const char* s|I32 flags
283Like C<sv_catpvn_flags>, but takes a literal string instead of a
284string/length pair.
285
286=for apidoc Am|void|sv_catpvs_nomg|SV* sv|const char* s
287Like C<sv_catpvn_nomg>, but takes a literal string instead of a
288string/length pair.
289
7b4e7469 290=for apidoc Am|void|sv_catpvs|SV* sv|const char* s
3fe05580
MHM
291Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
292
9dcc53ea
Z
293=for apidoc Am|void|sv_catpvs_mg|SV* sv|const char* s
294Like C<sv_catpvn_mg>, but takes a literal string instead of a
295string/length pair.
296
7b4e7469 297=for apidoc Am|void|sv_setpvs|SV* sv|const char* s
3fe05580
MHM
298Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
299
9dcc53ea
Z
300=for apidoc Am|void|sv_setpvs_mg|SV* sv|const char* s
301Like C<sv_setpvn_mg>, but takes a literal string instead of a
302string/length pair.
303
304=for apidoc Am|SV *|sv_setref_pvs|const char* s
305Like C<sv_setref_pvn>, but takes a literal string instead of a
306string/length pair.
307
3fe05580
MHM
308=head1 Memory Management
309
310=for apidoc Ama|char*|savepvs|const char* s
311Like C<savepvn>, but takes a literal string instead of a string/length pair.
312
9dcc53ea
Z
313=for apidoc Ama|char*|savesharedpvs|const char* s
314A version of C<savepvs()> which allocates the duplicate string in memory
315which is shared between threads.
316
3fe05580
MHM
317=head1 GV Functions
318
319=for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create
320Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
321
322=head1 Hash Manipulation Functions
323
324=for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval
325Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
326
327=for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val
328Like C<hv_store>, but takes a literal string instead of a string/length pair
329and omits the hash parameter.
330
510966aa
Z
331=head1 Lexer interface
332
333=for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags
334
335Like L</lex_stuff_pvn>, but takes a literal string instead of a
336string/length pair.
337
3fe05580
MHM
338=cut
339*/
340
65177ae0 341/* concatenating with "" ensures that only literal strings are accepted as argument */
26bfd924 342#define STR_WITH_LEN(s) ("" s ""), (sizeof(s)-1)
2efa8cc7 343
ba3a79e7
GA
344/* note that STR_WITH_LEN() can't be used as argument to macros or functions that
345 * under some configurations might be macros, which means that it requires the full
346 * Perl_xxx(aTHX_ ...) form for any API calls where it's used.
347 */
348
349/* STR_WITH_LEN() shortcuts */
350#define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str))
84bafc02
NC
351#define newSVpvs_flags(str,flags) \
352 Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags)
ba3a79e7 353#define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0)
9dcc53ea
Z
354#define sv_catpvs_flags(sv, str, flags) \
355 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), flags)
356#define sv_catpvs_nomg(sv, str) \
357 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), 0)
358#define sv_catpvs(sv, str) \
359 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC)
360#define sv_catpvs_mg(sv, str) \
361 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC|SV_SMAGIC)
3fe05580 362#define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str))
9dcc53ea
Z
363#define sv_setpvs_mg(sv, str) Perl_sv_setpvn_mg(aTHX_ sv, STR_WITH_LEN(str))
364#define sv_setref_pvs(rv, classname, str) \
365 Perl_sv_setref_pvn(aTHX_ rv, classname, STR_WITH_LEN(str))
ba3a79e7 366#define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str))
9dcc53ea
Z
367#define savesharedpvs(str) Perl_savesharedpvn(aTHX_ STR_WITH_LEN(str))
368#define gv_stashpvs(str, create) \
369 Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create)
370#define gv_fetchpvs(namebeg, add, sv_type) \
371 Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type)
372#define gv_fetchpvn(namebeg, len, add, sv_type) \
373 Perl_gv_fetchpvn_flags(aTHX_ namebeg, len, add, sv_type)
374#define sv_catxmlpvs(dsv, str, utf8) \
375 Perl_sv_catxmlpvn(aTHX_ dsv, STR_WITH_LEN(str), utf8)
a038e571
NC
376#define hv_fetchs(hv,key,lval) \
377 ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \
378 (lval) ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \
379 : HV_FETCH_JUST_SV, NULL, 0))
380
381#define hv_stores(hv,key,val) \
382 ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \
383 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), 0))
ba3a79e7 384
510966aa
Z
385#define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
386
b96d8cd9
NC
387#define get_cvs(str, flags) \
388 Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
5c1737d1 389
954c1994 390/*
ccfc67b7
JH
391=head1 Miscellaneous Functions
392
954c1994
GS
393=for apidoc Am|bool|strNE|char* s1|char* s2
394Test two strings to see if they are different. Returns true or
395false.
396
397=for apidoc Am|bool|strEQ|char* s1|char* s2
398Test two strings to see if they are equal. Returns true or false.
399
400=for apidoc Am|bool|strLT|char* s1|char* s2
401Test two strings to see if the first, C<s1>, is less than the second,
402C<s2>. Returns true or false.
403
404=for apidoc Am|bool|strLE|char* s1|char* s2
405Test two strings to see if the first, C<s1>, is less than or equal to the
406second, C<s2>. Returns true or false.
407
408=for apidoc Am|bool|strGT|char* s1|char* s2
409Test two strings to see if the first, C<s1>, is greater than the second,
410C<s2>. Returns true or false.
411
412=for apidoc Am|bool|strGE|char* s1|char* s2
413Test two strings to see if the first, C<s1>, is greater than or equal to
414the second, C<s2>. Returns true or false.
415
416=for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
417Test two strings to see if they are different. The C<len> parameter
418indicates the number of bytes to compare. Returns true or false. (A
419wrapper for C<strncmp>).
420
421=for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
422Test two strings to see if they are equal. The C<len> parameter indicates
423the number of bytes to compare. Returns true or false. (A wrapper for
424C<strncmp>).
425
426=cut
427*/
428
8d063cd8
LW
429#define strNE(s1,s2) (strcmp(s1,s2))
430#define strEQ(s1,s2) (!strcmp(s1,s2))
431#define strLT(s1,s2) (strcmp(s1,s2) < 0)
432#define strLE(s1,s2) (strcmp(s1,s2) <= 0)
433#define strGT(s1,s2) (strcmp(s1,s2) > 0)
434#define strGE(s1,s2) (strcmp(s1,s2) >= 0)
435#define strnNE(s1,s2,l) (strncmp(s1,s2,l))
436#define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
378cc40b 437
36477c24
PP
438#ifdef HAS_MEMCMP
439# define memNE(s1,s2,l) (memcmp(s1,s2,l))
440# define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
441#else
442# define memNE(s1,s2,l) (bcmp(s1,s2,l))
443# define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
444#endif
445
568a785a 446#define memEQs(s1, l, s2) \
8e6497b6 447 (sizeof(s2)-1 == l && memEQ(s1, ("" s2 ""), (sizeof(s2)-1)))
568a785a
NC
448#define memNEs(s1, l, s2) !memEQs(s1, l, s2)
449
bbce6d69
PP
450/*
451 * Character classes.
452 *
453 * Unfortunately, the introduction of locales means that we
454 * can't trust isupper(), etc. to tell the truth. And when
455 * it comes to /\w+/ with tainting enabled, we *must* be able
456 * to trust our character classes.
457 *
458 * Therefore, the default tests in the text of Perl will be
459 * independent of locale. Any code that wants to depend on
460 * the current locale will use the tests that begin with "lc".
461 */
462
2304df62
AD
463#ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */
464# ifndef CTYPE256
465# define CTYPE256
466# endif
467#endif
468
954c1994 469/*
ccfc67b7
JH
470
471=head1 Character classes
8a58bdcf
KW
472There are three variants for all the functions in this section. The base ones
473operate using the character set of the platform Perl is running on. The ones
474with an C<_A> suffix operate on the ASCII character set, and the ones with an
475C<_L1> suffix operate on the full Latin1 character set. All are unaffected by
d0df0e98 476locale.
8a58bdcf
KW
477
478For ASCII platforms, the base function with no suffix and the one with the
479C<_A> suffix are identical. The function with the C<_L1> suffix imposes the
480Latin-1 character set onto the platform. That is, the code points that are
481ASCII are unaffected, since ASCII is a subset of Latin-1. But the non-ASCII
482code points are treated as if they are Latin-1 characters. For example,
483C<isSPACE_L1()> will return true when called with the code point 0xA0, which is
484the Latin-1 NO-BREAK SPACE.
485
486For EBCDIC platforms, the base function with no suffix and the one with the
487C<_L1> suffix should be identical, since, as of this writing, the EBCDIC code
488pages that Perl knows about all are equivalent to Latin-1. The function that
489ends in an C<_A> suffix will not return true unless the specified character also
490has an ASCII equivalent.
ccfc67b7 491
954c1994 492=for apidoc Am|bool|isALPHA|char ch
2787a470 493Returns a boolean indicating whether the specified character is an
06dc89af 494alphabetic character in the platform's native character set.
8a58bdcf
KW
495See the L<top of this section|/Character classes> for an explanation of variants
496C<isALPHA_A> and C<isALPHA_L1>.
497
498=for apidoc Am|bool|isASCII|char ch
499Returns a boolean indicating whether the specified character is one of the 128
500characters in the ASCII character set. On non-ASCII platforms, it is if this
501character corresponds to an ASCII character. Variants C<isASCII_A()> and
502C<isASCII_L1()> are identical to C<isASCII()>.
954c1994 503
954c1994 504=for apidoc Am|bool|isDIGIT|char ch
2787a470 505Returns a boolean indicating whether the specified character is a
06dc89af 506digit in the platform's native character set.
8a58bdcf 507Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
954c1994 508
0c82b6df 509=for apidoc Am|bool|isLOWER|char ch
2787a470 510Returns a boolean indicating whether the specified character is a
0c82b6df 511lowercase character in the platform's native character set.
8a58bdcf
KW
512See the L<top of this section|/Character classes> for an explanation of variants
513C<isLOWER_A> and C<isLOWER_L1>.
0c82b6df 514
c99e91e9 515=for apidoc Am|bool|isOCTAL|char ch
2787a470 516Returns a boolean indicating whether the specified character is an
06dc89af 517octal digit, [0-7] in the platform's native character set.
8a58bdcf 518Variants C<isOCTAL_A> and C<isOCTAL_L1> are identical to C<isOCTAL>.
c99e91e9 519
0c82b6df 520=for apidoc Am|bool|isSPACE|char ch
2787a470 521Returns a boolean indicating whether the specified character is a
8a58bdcf
KW
522whitespace character in the platform's native character set. This is the same
523as what C<\s> matches in a regular expression.
524See the L<top of this section|/Character classes> for an explanation of variants
525C<isSPACE_A> and C<isSPACE_L1>.
0c82b6df 526
954c1994 527=for apidoc Am|bool|isUPPER|char ch
2787a470 528Returns a boolean indicating whether the specified character is an
06dc89af 529uppercase character in the platform's native character set.
8a58bdcf
KW
530See the L<top of this section|/Character classes> for an explanation of variants
531C<isUPPER_A> and C<isUPPER_L1>.
954c1994 532
8eea39dd
KW
533=for apidoc Am|bool|isWORDCHAR|char ch
534Returns a boolean indicating whether the specified character is a
535character that is any of: alphabetic, numeric, or an underscore. This is the
536same as what C<\w> matches in a regular expression.
537C<isALNUM()> is a synonym provided for backward compatibility. Note that it
538does not have the standard C language meaning of alphanumeric, since it matches
539an underscore and the standard meaning does not.
8a58bdcf
KW
540See the L<top of this section|/Character classes> for an explanation of variants
541C<isWORDCHAR_A> and C<isWORDCHAR_L1>.
542
543=for apidoc Am|bool|isXDIGIT|char ch
544Returns a boolean indicating whether the specified character is a hexadecimal
545digit, [0-9A-Fa-f]. Variants C<isXDIGIT_A()> and C<isXDIGIT_L1()> are
546identical to C<isXDIGIT()>.
8eea39dd 547
e7c1e6c1
KW
548=head1 Character case changing
549
954c1994 550=for apidoc Am|char|toUPPER|char ch
06dc89af
KW
551Converts the specified character to uppercase in the platform's native
552character set, if possible; otherwise returns the input character itself.
954c1994
GS
553
554=for apidoc Am|char|toLOWER|char ch
06dc89af
KW
555Converts the specified character to lowercase in the platform's native
556character set, if possible; otherwise returns the input character itself.
954c1994
GS
557
558=cut
353c9b6f 559
8a58bdcf 560Note that these macros are repeated in Devel::PPPort, so should also be
62fa66b6
KW
561patched there. The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
562
954c1994
GS
563*/
564
3912bc88
KW
565/* FITS_IN_8_BITS(c) returns true if c doesn't have a bit set other than in
566 * the lower 8. It is designed to be hopefully bomb-proof, making sure that no
567 * bits of information are lost even on a 64-bit machine, but to get the
568 * compiler to optimize it out if possible. This is because Configure makes
569 * sure that the machine has an 8-bit byte, so if c is stored in a byte, the
570 * sizeof() guarantees that this evaluates to a constant true at compile time.
571 * The use of the mask instead of '< 256' keeps gcc from complaining that it is
572 * always true, when c's storage class is a byte. Use U64TYPE because U64 is
573 * known only in the perl core, and this macro can be called from outside that
574 */
cf301eb7 575#ifdef HAS_QUAD
d0dcc402 576# define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || (((U64TYPE)(c) & 0xFF) == (U64TYPE)(c)))
cf301eb7
KW
577#else
578# define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || (((U32)(c) & 0xFF) == (U32)(c)))
579#endif
580
ec79cfbb
KW
581#define isASCII(c) (FITS_IN_8_BITS(c) ? NATIVE_TO_UNI((U8) c) <= 127 : 0)
582#define isASCII_A(c) isASCII(c)
6515cb76 583
ec79cfbb 584/* ASCII range only */
9fb1bf9d 585#ifdef H_PERL /* If have access to perl.h, lookup in its table */
96ac0975
NC
586/* Bits for PL_charclass[] */
587# define _CC_ALNUMC_A (1<<0)
588# define _CC_ALNUMC_L1 (1<<1)
589# define _CC_ALPHA_A (1<<2)
590# define _CC_ALPHA_L1 (1<<3)
591# define _CC_BLANK_A (1<<4)
592# define _CC_BLANK_L1 (1<<5)
593# define _CC_CHARNAME_CONT (1<<6)
594# define _CC_CNTRL_A (1<<7)
595# define _CC_CNTRL_L1 (1<<8)
596# define _CC_DIGIT_A (1<<9)
597# define _CC_GRAPH_A (1<<10)
598# define _CC_GRAPH_L1 (1<<11)
599# define _CC_IDFIRST_A (1<<12)
600# define _CC_IDFIRST_L1 (1<<13)
601# define _CC_LOWER_A (1<<14)
602# define _CC_LOWER_L1 (1<<15)
603# define _CC_OCTAL_A (1<<16)
604# define _CC_PRINT_A (1<<17)
605# define _CC_PRINT_L1 (1<<18)
606# define _CC_PSXSPC_A (1<<19)
607# define _CC_PSXSPC_L1 (1<<20)
608# define _CC_PUNCT_A (1<<21)
609# define _CC_PUNCT_L1 (1<<22)
610# define _CC_SPACE_A (1<<23)
611# define _CC_SPACE_L1 (1<<24)
612# define _CC_UPPER_A (1<<25)
613# define _CC_UPPER_L1 (1<<26)
614# define _CC_WORDCHAR_A (1<<27)
615# define _CC_WORDCHAR_L1 (1<<28)
616# define _CC_XDIGIT_A (1<<29)
617# define _CC_NONLATIN1_FOLD (1<<30)
618/* Unused
619 * (1<<31)
620 */
621
622# ifdef DOINIT
623EXTCONST U32 PL_charclass[] = {
624# include "l1_char_class_tab.h"
625};
626
627# else /* ! DOINIT */
628EXTCONST U32 PL_charclass[];
629# endif
630
9fb1bf9d
KW
631# define isALNUMC_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALNUMC_A))
632# define isALPHA_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALPHA_A))
633# define isBLANK_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_BLANK_A))
634# define isCNTRL_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_CNTRL_A))
635# define isDIGIT_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_DIGIT_A))
636# define isGRAPH_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_GRAPH_A))
637# define isIDFIRST_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_IDFIRST_A))
638# define isLOWER_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_LOWER_A))
639# define isOCTAL_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_OCTAL_A))
640# define isPRINT_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PRINT_A))
641# define isPSXSPC_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PSXSPC_A))
642# define isPUNCT_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PUNCT_A))
643# define isSPACE_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_SPACE_A))
644# define isUPPER_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_UPPER_A))
645# define isWORDCHAR_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_WORDCHAR_A))
646# define isXDIGIT_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_XDIGIT_A))
fb9bfbf7
KW
647 /* Either participates in a fold with a character above 255, or is a
648 * multi-char fold */
e2e75538 649# 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_NONLATIN1_FOLD))
9fb1bf9d
KW
650#else /* No perl.h. */
651# define isOCTAL_A(c) ((c) >= '0' && (c) <= '9')
652# ifdef EBCDIC
653# define isALNUMC_A(c) (isASCII(c) && isALNUMC(c))
654# define isALPHA_A(c) (isASCII(c) && isALPHA(c))
655# define isBLANK_A(c) (isASCII(c) && isBLANK(c))
656# define isCNTRL_A(c) (isASCII(c) && isCNTRL(c))
657# define isDIGIT_A(c) (isASCII(c) && isDIGIT(c))
658# define isGRAPH_A(c) (isASCII(c) && isGRAPH(c))
659# define isIDFIRST_A(c) (isASCII(c) && isIDFIRST(c))
660# define isLOWER_A(c) (isASCII(c) && isLOWER(c))
661# define isPRINT_A(c) (isASCII(c) && isPRINT(c))
662# define isPSXSPC_A(c) (isASCII(c) && isPSXSPC(c))
663# define isPUNCT_A(c) (isASCII(c) && isPUNCT(c))
664# define isSPACE_A(c) (isASCII(c) && isSPACE(c))
665# define isUPPER_A(c) (isASCII(c) && isUPPER(c))
666# define isWORDCHAR_A(c) (isASCII(c) && isWORDCHAR(c))
667# define isXDIGIT_A(c) (isASCII(c) && isXDIGIT(c))
668# else /* ASCII platform, no perl.h */
669# define isALNUMC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
670# define isALPHA_A(c) (isUPPER_A(c) || isLOWER_A(c))
671# define isBLANK_A(c) ((c) == ' ' || (c) == '\t')
672# define isCNTRL_A(c) (FITS_IN_8_BITS(c) ? ((U8) (c) < ' ' || (c) == 127) : 0)
673# define isDIGIT_A(c) ((c) >= '0' && (c) <= '9')
674# define isGRAPH_A(c) (isWORDCHAR_A(c) || isPUNCT_A(c))
675# define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_')
676# define isLOWER_A(c) ((c) >= 'a' && (c) <= 'z')
677# define isPRINT_A(c) (((c) >= 32 && (c) < 127))
678# define isPSXSPC_A(c) (isSPACE_A(c) || (c) == '\v')
679# define isPUNCT_A(c) (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64) || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
680# define isSPACE_A(c) ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
681# define isUPPER_A(c) ((c) >= 'A' && (c) <= 'Z')
682# define isWORDCHAR_A(c) (isALPHA_A(c) || isDIGIT_A(c) || (c) == '_')
683# define isXDIGIT_A(c) (isDIGIT_A(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F'))
684# endif
685#endif /* ASCII range definitions */
ec79cfbb
KW
686
687/* Latin1 definitions */
8a58bdcf
KW
688#ifdef H_PERL
689# define isALNUMC_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALNUMC_L1))
690# define isALPHA_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALPHA_L1))
691# define isBLANK_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_BLANK_L1))
692/* continuation character for legal NAME in \N{NAME} */
693# define isCHARNAME_CONT(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_CHARNAME_CONT))
694# define isCNTRL_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_CNTRL_L1))
695# define isGRAPH_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_GRAPH_L1))
696# define isIDFIRST_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_IDFIRST_L1))
697# define isLOWER_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_LOWER_L1))
698# define isPRINT_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PRINT_L1))
699# define isPSXSPC_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PSXSPC_L1))
700# define isPUNCT_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PUNCT_L1))
701# define isSPACE_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_SPACE_L1))
702# define isUPPER_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_UPPER_L1))
703# define isWORDCHAR_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_WORDCHAR_L1))
704#else /* No access to perl.h. Only a few provided here, just in case needed
705 * for backwards compatibility */
706 /* ALPHAU includes Unicode semantics for latin1 characters. It has an extra
707 * >= AA test to speed up ASCII-only tests at the expense of the others */
708# define isALPHA_L1(c) (isALPHA(c) || (NATIVE_TO_UNI((U8) c) >= 0xAA \
709 && ((NATIVE_TO_UNI((U8) c) >= 0xC0 \
710 && NATIVE_TO_UNI((U8) c) != 0xD7 && NATIVE_TO_UNI((U8) c) != 0xF7) \
711 || NATIVE_TO_UNI((U8) c) == 0xAA \
712 || NATIVE_TO_UNI((U8) c) == 0xB5 \
713 || NATIVE_TO_UNI((U8) c) == 0xBA)))
714# define isCHARNAME_CONT(c) (isALNUM_L1(c) || (c) == ' ' || (c) == '-' || (c) == '(' || (c) == ')' || (c) == ':' || NATIVE_TO_UNI((U8) c) == 0xA0)
715#endif
716
717/* Macros for backwards compatibility and for completeness when the ASCII and
718 * Latin1 values are identical */
ec79cfbb
KW
719#define isALNUM(c) isWORDCHAR(c)
720#define isALNUMU(c) isWORDCHAR_L1(c)
8a58bdcf
KW
721#define isALPHAU(c) isALPHA_L1(c)
722#define isDIGIT_L1(c) isDIGIT_A(c)
723#define isOCTAL(c) isOCTAL_A(c)
724#define isOCTAL_L1(c) isOCTAL_A(c)
725#define isXDIGIT_L1(c) isXDIGIT_A(c)
726
727/* Macros that differ between EBCDIC and ASCII. Where C89 defines a function,
728 * that is used in the EBCDIC form, because in EBCDIC we do not do locales:
729 * therefore can use native functions. For those where C89 doesn't define a
730 * function, use our function, assuming that the EBCDIC code page is isomorphic
731 * with Latin1, which the three currently recognized by Perl are. Some libc's
732 * have an isblank(), but it's not guaranteed. */
9d116dd7 733#ifdef EBCDIC
b8c5462f 734# define isALNUMC(c) isalnum(c)
271b5cb3 735# define isALPHA(c) isalpha(c)
0bc70f7f 736# define isBLANK(c) ((c) == ' ' || (c) == '\t' || NATIVE_TO_UNI(c) == 0xA0)
b8c5462f 737# define isCNTRL(c) iscntrl(c)
9916188f 738# define isDIGIT(c) isdigit(c)
b8c5462f 739# define isGRAPH(c) isgraph(c)
8a58bdcf 740# define isIDFIRST(c) (isALPHA(c) || (c) == '_')
7d79683e 741# define isLOWER(c) islower(c)
9d116dd7 742# define isPRINT(c) isprint(c)
56e4b611 743# define isPSXSPC(c) isspace(c)
b8c5462f 744# define isPUNCT(c) ispunct(c)
174b5e76 745# define isSPACE(c) (isPSXSPC(c) && (c) != '\v')
7d79683e 746# define isUPPER(c) isupper(c)
b8c5462f 747# define isXDIGIT(c) isxdigit(c)
8a58bdcf 748# define isWORDCHAR(c) (isalnum(c) || (c) == '_')
9d116dd7 749# define toLOWER(c) tolower(c)
7d79683e 750# define toUPPER(c) toupper(c)
ec79cfbb
KW
751#else /* Not EBCDIC: ASCII-only matching */
752# define isALNUMC(c) isALNUMC_A(c)
271b5cb3 753# define isALPHA(c) isALPHA_A(c)
ec79cfbb
KW
754# define isBLANK(c) isBLANK_A(c)
755# define isCNTRL(c) isCNTRL_A(c)
756# define isDIGIT(c) isDIGIT_A(c)
757# define isGRAPH(c) isGRAPH_A(c)
8a58bdcf 758# define isIDFIRST(c) isIDFIRST_A(c)
ec79cfbb
KW
759# define isLOWER(c) isLOWER_A(c)
760# define isPRINT(c) isPRINT_A(c)
761# define isPSXSPC(c) isPSXSPC_A(c)
762# define isPUNCT(c) isPUNCT_A(c)
763# define isSPACE(c) isSPACE_A(c)
764# define isUPPER(c) isUPPER_A(c)
8a58bdcf 765# define isWORDCHAR(c) isWORDCHAR_A(c)
ec79cfbb 766# define isXDIGIT(c) isXDIGIT_A(c)
00f254e2 767
8a58bdcf
KW
768 /* ASCII casing. These could also be written as
769 #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
770 #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
771 which uses table lookup and mask instead of subtraction. (This would
772 work because the _MOD does not apply in the ASCII range) */
9d116dd7 773# define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c))
7d79683e 774# define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c))
9d116dd7 775#endif
bbce6d69 776
1a0901db
KW
777
778/* Use table lookup for speed; return error character for input
779 * out-of-range */
780#define toLOWER_LATIN1(c) (FITS_IN_8_BITS(c) \
781 ? UNI_TO_NATIVE(PL_latin1_lc[ \
782 NATIVE_TO_UNI( (U8) (c)) ]) \
783 : UNICODE_REPLACEMENT)
784/* Modified uc. Is correct uc except for three non-ascii chars which are
785 * all mapped to one of them, and these need special handling; error
786 * character for input out-of-range */
787#define toUPPER_LATIN1_MOD(c) (FITS_IN_8_BITS(c) \
788 ? UNI_TO_NATIVE(PL_mod_latin1_uc[ \
789 NATIVE_TO_UNI( (U8) (c)) ]) \
790 : UNICODE_REPLACEMENT)
791
bbce6d69
PP
792#ifdef USE_NEXT_CTYPE
793
794# define isALNUM_LC(c) \
37bd1396 795 (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
ff68c719
PP
796# define isIDFIRST_LC(c) \
797 (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
798# define isALPHA_LC(c) NXIsAlpha((unsigned int)(c))
799# define isSPACE_LC(c) NXIsSpace((unsigned int)(c))
800# define isDIGIT_LC(c) NXIsDigit((unsigned int)(c))
801# define isUPPER_LC(c) NXIsUpper((unsigned int)(c))
802# define isLOWER_LC(c) NXIsLower((unsigned int)(c))
37bd1396 803# define isALNUMC_LC(c) NXIsAlNum((unsigned int)(c))
b8c5462f
JH
804# define isCNTRL_LC(c) NXIsCntrl((unsigned int)(c))
805# define isGRAPH_LC(c) NXIsGraph((unsigned int)(c))
ff68c719 806# define isPRINT_LC(c) NXIsPrint((unsigned int)(c))
b8c5462f 807# define isPUNCT_LC(c) NXIsPunct((unsigned int)(c))
ff68c719
PP
808# define toUPPER_LC(c) NXToUpper((unsigned int)(c))
809# define toLOWER_LC(c) NXToLower((unsigned int)(c))
bbce6d69
PP
810
811#else /* !USE_NEXT_CTYPE */
b8c5462f 812
bbce6d69
PP
813# if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
814
b8c5462f 815# define isALNUM_LC(c) (isalnum((unsigned char)(c)) || (char)(c) == '_')
ff68c719 816# define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
bbce6d69
PP
817# define isALPHA_LC(c) isalpha((unsigned char)(c))
818# define isSPACE_LC(c) isspace((unsigned char)(c))
819# define isDIGIT_LC(c) isdigit((unsigned char)(c))
820# define isUPPER_LC(c) isupper((unsigned char)(c))
821# define isLOWER_LC(c) islower((unsigned char)(c))
b8c5462f
JH
822# define isALNUMC_LC(c) isalnum((unsigned char)(c))
823# define isCNTRL_LC(c) iscntrl((unsigned char)(c))
824# define isGRAPH_LC(c) isgraph((unsigned char)(c))
bbce6d69 825# define isPRINT_LC(c) isprint((unsigned char)(c))
b8c5462f 826# define isPUNCT_LC(c) ispunct((unsigned char)(c))
bbce6d69
PP
827# define toUPPER_LC(c) toupper((unsigned char)(c))
828# define toLOWER_LC(c) tolower((unsigned char)(c))
829
830# else
831
3609ea0d 832# define isALNUM_LC(c) (isascii(c) && (isalnum(c) || (c) == '_'))
bbce6d69
PP
833# define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
834# define isALPHA_LC(c) (isascii(c) && isalpha(c))
835# define isSPACE_LC(c) (isascii(c) && isspace(c))
836# define isDIGIT_LC(c) (isascii(c) && isdigit(c))
837# define isUPPER_LC(c) (isascii(c) && isupper(c))
838# define isLOWER_LC(c) (isascii(c) && islower(c))
b8c5462f
JH
839# define isALNUMC_LC(c) (isascii(c) && isalnum(c))
840# define isCNTRL_LC(c) (isascii(c) && iscntrl(c))
841# define isGRAPH_LC(c) (isascii(c) && isgraph(c))
bbce6d69 842# define isPRINT_LC(c) (isascii(c) && isprint(c))
b8c5462f 843# define isPUNCT_LC(c) (isascii(c) && ispunct(c))
bbce6d69
PP
844# define toUPPER_LC(c) toupper(c)
845# define toLOWER_LC(c) tolower(c)
846
847# endif
a0d0e21e 848#endif /* USE_NEXT_CTYPE */
55204971 849
aaa51d5e
JF
850#define isPSXSPC_LC(c) (isSPACE_LC(c) || (c) == '\v')
851#define isBLANK_LC(c) isBLANK(c) /* could be wrong */
852
a0ed51b3
LW
853#define isALNUM_uni(c) is_uni_alnum(c)
854#define isIDFIRST_uni(c) is_uni_idfirst(c)
855#define isALPHA_uni(c) is_uni_alpha(c)
856#define isSPACE_uni(c) is_uni_space(c)
857#define isDIGIT_uni(c) is_uni_digit(c)
858#define isUPPER_uni(c) is_uni_upper(c)
859#define isLOWER_uni(c) is_uni_lower(c)
b8c5462f
JH
860#define isASCII_uni(c) is_uni_ascii(c)
861#define isCNTRL_uni(c) is_uni_cntrl(c)
862#define isGRAPH_uni(c) is_uni_graph(c)
a0ed51b3 863#define isPRINT_uni(c) is_uni_print(c)
b8c5462f
JH
864#define isPUNCT_uni(c) is_uni_punct(c)
865#define isXDIGIT_uni(c) is_uni_xdigit(c)
a2a2844f
JH
866#define toUPPER_uni(c,s,l) to_uni_upper(c,s,l)
867#define toTITLE_uni(c,s,l) to_uni_title(c,s,l)
868#define toLOWER_uni(c,s,l) to_uni_lower(c,s,l)
b8d68ded 869#define toFOLD_uni(c,s,l) to_uni_fold(c,s,l)
a0ed51b3 870
aaa51d5e
JF
871#define isPSXSPC_uni(c) (isSPACE_uni(c) ||(c) == '\f')
872#define isBLANK_uni(c) isBLANK(c) /* could be wrong */
873
9041c2e3
NIS
874#define isALNUM_LC_uvchr(c) (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
875#define isIDFIRST_LC_uvchr(c) (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
876#define isALPHA_LC_uvchr(c) (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
877#define isSPACE_LC_uvchr(c) (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
878#define isDIGIT_LC_uvchr(c) (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
879#define isUPPER_LC_uvchr(c) (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
880#define isLOWER_LC_uvchr(c) (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
9041c2e3
NIS
881#define isCNTRL_LC_uvchr(c) (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
882#define isGRAPH_LC_uvchr(c) (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
883#define isPRINT_LC_uvchr(c) (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
884#define isPUNCT_LC_uvchr(c) (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
a0ed51b3 885
aaa51d5e
JF
886#define isPSXSPC_LC_uni(c) (isSPACE_LC_uni(c) ||(c) == '\f')
887#define isBLANK_LC_uni(c) isBLANK(c) /* could be wrong */
888
a0ed51b3 889#define isALNUM_utf8(p) is_utf8_alnum(p)
c11ff943
KW
890/* To prevent S_scan_word in toke.c from hanging, we have to make sure that
891 * IDFIRST is an alnum. See
892 * http://rt.perl.org/rt3/Ticket/Display.html?id=74022
893 * for more detail than you ever wanted to know about. This used to be not the
894 * XID version, but we decided to go with the more modern Unicode definition */
895#define isIDFIRST_utf8(p) (is_utf8_xidfirst(p) && is_utf8_alnum(p))
896#define isIDCONT_utf8(p) is_utf8_xidcont(p)
a0ed51b3
LW
897#define isALPHA_utf8(p) is_utf8_alpha(p)
898#define isSPACE_utf8(p) is_utf8_space(p)
899#define isDIGIT_utf8(p) is_utf8_digit(p)
900#define isUPPER_utf8(p) is_utf8_upper(p)
901#define isLOWER_utf8(p) is_utf8_lower(p)
b8c5462f
JH
902#define isASCII_utf8(p) is_utf8_ascii(p)
903#define isCNTRL_utf8(p) is_utf8_cntrl(p)
904#define isGRAPH_utf8(p) is_utf8_graph(p)
a0ed51b3 905#define isPRINT_utf8(p) is_utf8_print(p)
b8c5462f
JH
906#define isPUNCT_utf8(p) is_utf8_punct(p)
907#define isXDIGIT_utf8(p) is_utf8_xdigit(p)
a2a2844f
JH
908#define toUPPER_utf8(p,s,l) to_utf8_upper(p,s,l)
909#define toTITLE_utf8(p,s,l) to_utf8_title(p,s,l)
910#define toLOWER_utf8(p,s,l) to_utf8_lower(p,s,l)
a0ed51b3 911
aaa51d5e
JF
912#define isPSXSPC_utf8(c) (isSPACE_utf8(c) ||(c) == '\f')
913#define isBLANK_utf8(c) isBLANK(c) /* could be wrong */
914
9041c2e3
NIS
915#define isALNUM_LC_utf8(p) isALNUM_LC_uvchr(utf8_to_uvchr(p, 0))
916#define isIDFIRST_LC_utf8(p) isIDFIRST_LC_uvchr(utf8_to_uvchr(p, 0))
917#define isALPHA_LC_utf8(p) isALPHA_LC_uvchr(utf8_to_uvchr(p, 0))
918#define isSPACE_LC_utf8(p) isSPACE_LC_uvchr(utf8_to_uvchr(p, 0))
919#define isDIGIT_LC_utf8(p) isDIGIT_LC_uvchr(utf8_to_uvchr(p, 0))
920#define isUPPER_LC_utf8(p) isUPPER_LC_uvchr(utf8_to_uvchr(p, 0))
921#define isLOWER_LC_utf8(p) isLOWER_LC_uvchr(utf8_to_uvchr(p, 0))
922#define isALNUMC_LC_utf8(p) isALNUMC_LC_uvchr(utf8_to_uvchr(p, 0))
923#define isCNTRL_LC_utf8(p) isCNTRL_LC_uvchr(utf8_to_uvchr(p, 0))
924#define isGRAPH_LC_utf8(p) isGRAPH_LC_uvchr(utf8_to_uvchr(p, 0))
925#define isPRINT_LC_utf8(p) isPRINT_LC_uvchr(utf8_to_uvchr(p, 0))
926#define isPUNCT_LC_utf8(p) isPUNCT_LC_uvchr(utf8_to_uvchr(p, 0))
a0ed51b3 927
aaa51d5e
JF
928#define isPSXSPC_LC_utf8(c) (isSPACE_LC_utf8(c) ||(c) == '\f')
929#define isBLANK_LC_utf8(c) isBLANK(c) /* could be wrong */
930
6ae9f32a
KW
931/* This conversion works both ways, strangely enough. On EBCDIC platforms,
932 * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII */
933# define toCTRL(c) (toUPPER(NATIVE_TO_UNI(c)) ^ 64)
bbce6d69 934
dea28490
JJ
935/* Line numbers are unsigned, 32 bits. */
936typedef U32 line_t;
dea28490 937#define NOLINE ((line_t) 4294967295UL)
378cc40b 938
91152fc1
DG
939/* Helpful alias for version prescan */
940#define is_LAX_VERSION(a,b) \
941 (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
942
943#define is_STRICT_VERSION(a,b) \
944 (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
945
946#define BADVERSION(a,b,c) \
947 if (b) { \
948 *b = c; \
949 } \
950 return a;
8c52afec 951
8e84507e 952/*
ccfc67b7
JH
953=head1 Memory Management
954
a02a5408 955=for apidoc Am|void|Newx|void* ptr|int nitems|type
954c1994
GS
956The XSUB-writer's interface to the C C<malloc> function.
957
c5008215
JC
958In 5.9.3, Newx() and friends replace the older New() API, and drops
959the first parameter, I<x>, a debug aid which allowed callers to identify
37b8b4c9 960themselves. This aid has been superseded by a new build option,
d10b4965 961PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>). The older API is still
c5008215
JC
962there for use in XS modules supporting older perls.
963
a02a5408 964=for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
954c1994 965The XSUB-writer's interface to the C C<malloc> function, with
c5008215 966cast. See also C<Newx>.
954c1994 967
a02a5408 968=for apidoc Am|void|Newxz|void* ptr|int nitems|type
954c1994 969The XSUB-writer's interface to the C C<malloc> function. The allocated
c5008215 970memory is zeroed with C<memzero>. See also C<Newx>.
a02a5408 971
954c1994
GS
972=for apidoc Am|void|Renew|void* ptr|int nitems|type
973The XSUB-writer's interface to the C C<realloc> function.
974
975=for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
976The XSUB-writer's interface to the C C<realloc> function, with
977cast.
978
49b8b560 979=for apidoc Am|void|Safefree|void* ptr
954c1994
GS
980The XSUB-writer's interface to the C C<free> function.
981
982=for apidoc Am|void|Move|void* src|void* dest|int nitems|type
983The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
984source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
985the type. Can do overlapping moves. See also C<Copy>.
986
e90e2364
NC
987=for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
988Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
989optimise.
990
954c1994
GS
991=for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
992The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
993source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
994the type. May fail on overlapping copies. See also C<Move>.
995
e90e2364
NC
996=for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
997
998Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
999optimise.
1000
954c1994
GS
1001=for apidoc Am|void|Zero|void* dest|int nitems|type
1002
1003The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1004destination, C<nitems> is the number of items, and C<type> is the type.
1005
e90e2364
NC
1006=for apidoc Am|void *|ZeroD|void* dest|int nitems|type
1007
1008Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1009optimise.
1010
954c1994 1011=for apidoc Am|void|StructCopy|type src|type dest|type
4375e838 1012This is an architecture-independent macro to copy one structure to another.
954c1994 1013
7e337ee0
JH
1014=for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
1015
1016Fill up memory with a byte pattern (a byte repeated over and over
1017again) that hopefully catches attempts to access uninitialized memory.
1018
1019=for apidoc Am|void|PoisonNew|void* dest|int nitems|type
1020
1021PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
1022
1c12ffb4 1023=for apidoc Am|void|PoisonFree|void* dest|int nitems|type
7e337ee0
JH
1024
1025PoisonWith(0xEF) for catching access to freed memory.
1026
9965345d
JH
1027=for apidoc Am|void|Poison|void* dest|int nitems|type
1028
7e337ee0 1029PoisonWith(0xEF) for catching access to freed memory.
9965345d
JH
1030
1031=cut */
954c1994 1032
561b68a9
SH
1033/* Maintained for backwards-compatibility only. Use newSV() instead. */
1034#ifndef PERL_CORE
ff06c60c 1035#define NEWSV(x,len) newSV(len)
561b68a9 1036#endif
ff06c60c 1037
19a94d75
JH
1038#define MEM_SIZE_MAX ((MEM_SIZE)~0)
1039
2720f793
JH
1040/* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
1041 * overly eager compilers that will bleat about e.g.
1042 * (U16)n > (size_t)~0/sizeof(U16) always being false. */
27d5b266 1043#ifdef PERL_MALLOC_WRAP
fabdb6c0 1044#define MEM_WRAP_CHECK(n,t) MEM_WRAP_CHECK_1(n,t,PL_memory_wrap)
27d5b266 1045#define MEM_WRAP_CHECK_1(n,t,a) \
f1f66076 1046 (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
8b44ba4c 1047#define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
27d5b266 1048
f1f66076 1049#define PERL_STRLEN_ROUNDUP(n) ((void)(((n) > MEM_SIZE_MAX - 2 * PERL_STRLEN_ROUNDUP_QUANTUM) ? (Perl_croak_nocontext("%s",PL_memory_wrap),0):0),((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
1936d2a7 1050
27d5b266
JH
1051#else
1052
410319be
NC
1053#define MEM_WRAP_CHECK(n,t)
1054#define MEM_WRAP_CHECK_1(n,t,a)
1055#define MEM_WRAP_CHECK_2(n,t,a,b)
8b44ba4c
NC
1056#define MEM_WRAP_CHECK_(n,t)
1057
6fff79ce 1058#define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
27d5b266 1059
1936d2a7 1060#endif
8b44ba4c 1061
fe4f188c 1062#ifdef PERL_MEM_LOG
46c6c7e2 1063/*
9f653bb5 1064 * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
46c6c7e2
JH
1065 * go through functions, which are handy for debugging breakpoints, but
1066 * which more importantly get the immediate calling environment (file and
e352bcff
JH
1067 * line number, and C function name if available) passed in. This info can
1068 * then be used for logging the calls, for which one gets a sample
73d1d973 1069 * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
3609ea0d 1070 *
46c6c7e2 1071 * Known problems:
94e892a6 1072 * - not all memory allocs get logged, only those
46c6c7e2 1073 * that go through Newx() and derivatives (while all
94e892a6 1074 * Safefrees do get logged)
46c6c7e2
JH
1075 * - __FILE__ and __LINE__ do not work everywhere
1076 * - __func__ or __FUNCTION__ even less so
1077 * - I think more goes on after the perlio frees but
1078 * the thing is that STDERR gets closed (as do all
1079 * the file descriptors)
1080 * - no deeper calling stack than the caller of the Newx()
1081 * or the kind, but do I look like a C reflection/introspection
1082 * utility to you?
1083 * - the function prototypes for the logging functions
1084 * probably should maybe be somewhere else than handy.h
1085 * - one could consider inlining (macrofying) the logging
1086 * for speed, but I am too lazy
1087 * - one could imagine recording the allocations in a hash,
1088 * (keyed by the allocation address?), and maintain that
1089 * through reallocs and frees, but how to do that without
1090 * any News() happening...?
73d1d973 1091 * - lots of -Ddefines to get useful/controllable output
b953482e 1092 * - lots of ENV reads
46c6c7e2
JH
1093 */
1094
12754f92 1095PERL_EXPORT_C Malloc_t Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name, Malloc_t newalloc, const char *filename, const int linenumber, const char *funcname);
46c6c7e2 1096
12754f92 1097PERL_EXPORT_C Malloc_t Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name, Malloc_t oldalloc, Malloc_t newalloc, const char *filename, const int linenumber, const char *funcname);
46c6c7e2 1098
12754f92 1099PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
46c6c7e2 1100
0b0ab801 1101# ifdef PERL_CORE
73d1d973 1102# ifndef PERL_MEM_LOG_NOIMPL
0b0ab801
MHM
1103enum mem_log_type {
1104 MLT_ALLOC,
1105 MLT_REALLOC,
d7a2c63c
MHM
1106 MLT_FREE,
1107 MLT_NEW_SV,
1108 MLT_DEL_SV
0b0ab801
MHM
1109};
1110# endif
12754f92 1111# if defined(PERL_IN_SV_C) /* those are only used in sv.c */
d7a2c63c
MHM
1112void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1113void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
12754f92 1114# endif
0b0ab801
MHM
1115# endif
1116
fe4f188c
JH
1117#endif
1118
1119#ifdef PERL_MEM_LOG
d1401ee9
MHM
1120#define MEM_LOG_ALLOC(n,t,a) Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
1121#define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
46c6c7e2 1122#define MEM_LOG_FREE(a) Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
fe4f188c
JH
1123#endif
1124
1125#ifndef MEM_LOG_ALLOC
1126#define MEM_LOG_ALLOC(n,t,a) (a)
1127#endif
1128#ifndef MEM_LOG_REALLOC
1129#define MEM_LOG_REALLOC(n,t,v,a) (a)
1130#endif
1131#ifndef MEM_LOG_FREE
1132#define MEM_LOG_FREE(a) (a)
1133#endif
1134
d1401ee9
MHM
1135#define Newx(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1136#define Newxc(v,n,t,c) (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1137#define Newxz(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
a6f6820f
NC
1138
1139#ifndef PERL_CORE
a02a5408
JC
1140/* pre 5.9.x compatibility */
1141#define New(x,v,n,t) Newx(v,n,t)
1142#define Newc(x,v,n,t,c) Newxc(v,n,t,c)
4541904d 1143#define Newz(x,v,n,t) Newxz(v,n,t)
a6f6820f 1144#endif
a02a5408 1145
ff68c719 1146#define Renew(v,n,t) \
d1401ee9 1147 (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
ff68c719 1148#define Renewc(v,n,t,c) \
d1401ee9 1149 (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
94010e71
NC
1150
1151#ifdef PERL_POISON
1152#define Safefree(d) \
06c0cc96 1153 ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
94010e71 1154#else
fe4f188c 1155#define Safefree(d) safefree(MEM_LOG_FREE((Malloc_t)(d)))
94010e71 1156#endif
55497cff 1157
8b44ba4c
NC
1158#define Move(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1159#define Copy(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1160#define Zero(d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
55497cff 1161
8b44ba4c
NC
1162#define MoveD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1163#define CopyD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
e90e2364 1164#ifdef HAS_MEMSET
8b44ba4c 1165#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
e90e2364 1166#else
8b44ba4c
NC
1167/* Using bzero(), which returns void. */
1168#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
e90e2364
NC
1169#endif
1170
7e337ee0
JH
1171#define PoisonWith(d,n,t,b) (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
1172#define PoisonNew(d,n,t) PoisonWith(d,n,t,0xAB)
1173#define PoisonFree(d,n,t) PoisonWith(d,n,t,0xEF)
1174#define Poison(d,n,t) PoisonFree(d,n,t)
27d5b266 1175
2304df62 1176#ifdef USE_STRUCT_COPY
ff68c719 1177#define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
bee1dbe2
LW
1178#else
1179#define StructCopy(s,d,t) Copy(s,d,1,t)
1180#endif
2cc61e15 1181
622913ab 1182#define C_ARRAY_LENGTH(a) (sizeof(a)/sizeof((a)[0]))
cd431fde 1183#define C_ARRAY_END(a) (a) + (sizeof(a)/sizeof((a)[0]))
622913ab 1184
2cc61e15
DD
1185#ifdef NEED_VA_COPY
1186# ifdef va_copy
1187# define Perl_va_copy(s, d) va_copy(d, s)
2cc61e15 1188# else
a1866d1b
JH
1189# if defined(__va_copy)
1190# define Perl_va_copy(s, d) __va_copy(d, s)
1191# else
1192# define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
1193# endif
2cc61e15
DD
1194# endif
1195#endif
1196
472d47bc
SB
1197/* convenience debug macros */
1198#ifdef USE_ITHREADS
1199#define pTHX_FORMAT "Perl interpreter: 0x%p"
1200#define pTHX__FORMAT ", Perl interpreter: 0x%p"
f54cb97a
AL
1201#define pTHX_VALUE_ (void *)my_perl,
1202#define pTHX_VALUE (void *)my_perl
1203#define pTHX__VALUE_ ,(void *)my_perl,
1204#define pTHX__VALUE ,(void *)my_perl
472d47bc 1205#else
3609ea0d 1206#define pTHX_FORMAT
472d47bc 1207#define pTHX__FORMAT
3609ea0d 1208#define pTHX_VALUE_
472d47bc 1209#define pTHX_VALUE
3609ea0d 1210#define pTHX__VALUE_
472d47bc
SB
1211#define pTHX__VALUE
1212#endif /* USE_ITHREADS */
3609ea0d 1213
2acdbac1
NC
1214/* Perl_deprecate was not part of the public API, and did not have a deprecate()
1215 shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
1216 CPAN::Unpack show any users outside the core. */
1217#ifdef PERL_CORE
d1d15184 1218# define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
2acdbac1
NC
1219#endif
1220
e9a8c099
MHM
1221/*
1222 * Local variables:
1223 * c-indentation-style: bsd
1224 * c-basic-offset: 4
1225 * indent-tabs-mode: t
1226 * End:
1227 *
1228 * ex: set ts=8 sts=4 sw=4 noet:
1229 */