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