This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
ext/XS-APItest/t/handy.t: White-space only
[perl5.git] / handy.h
CommitLineData
a0d0e21e 1/* handy.h
a687059c 2 *
1129b882 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000,
da5d8dbb 4 * 2001, 2002, 2004, 2005, 2006, 2007, 2008, 2012 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
9d745869
KW
11#ifndef HANDY_H /* Guard against nested #inclusion */
12#define HANDY_H
13
85e6fe83 14#if !defined(__STDC__)
378cc40b
LW
15#ifdef NULL
16#undef NULL
17#endif
a687059c 18# define NULL 0
85e6fe83
LW
19#endif
20
24792b8d
NC
21#ifndef PERL_CORE
22# define Null(type) ((type)NULL)
954c1994
GS
23
24/*
ccfc67b7 25=head1 Handy Values
954c1994 26
3609ea0d 27=for apidoc AmU||Nullch
24792b8d 28Null character pointer. (No longer available when C<PERL_CORE> is defined.)
2307c6d0 29
954c1994 30=for apidoc AmU||Nullsv
24792b8d 31Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
954c1994
GS
32
33=cut
34*/
35
24792b8d
NC
36# define Nullch Null(char*)
37# define Nullfp Null(PerlIO*)
38# define Nullsv Null(SV*)
39#endif
8d063cd8 40
641d3f0b
PP
41#ifdef TRUE
42#undef TRUE
43#endif
44#ifdef FALSE
45#undef FALSE
46#endif
47#define TRUE (1)
48#define FALSE (0)
49
cf3f0ffb
DM
50/* The MUTABLE_*() macros cast pointers to the types shown, in such a way
51 * (compiler permitting) that casting away const-ness will give a warning;
52 * e.g.:
53 *
54 * const SV *sv = ...;
55 * AV *av1 = (AV*)sv; <== BAD: the const has been silently cast away
56 * AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
57 */
58
b1bc3f34 59#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
f065df04 60# define MUTABLE_PTR(p) ({ void *_p = (p); _p; })
b1bc3f34
NC
61#else
62# define MUTABLE_PTR(p) ((void *) (p))
63#endif
64
a062e10d 65#define MUTABLE_AV(p) ((AV *)MUTABLE_PTR(p))
ea726b52 66#define MUTABLE_CV(p) ((CV *)MUTABLE_PTR(p))
159b6efe 67#define MUTABLE_GV(p) ((GV *)MUTABLE_PTR(p))
dbebbdb4 68#define MUTABLE_HV(p) ((HV *)MUTABLE_PTR(p))
a45c7426 69#define MUTABLE_IO(p) ((IO *)MUTABLE_PTR(p))
b1bc3f34 70#define MUTABLE_SV(p) ((SV *)MUTABLE_PTR(p))
27d4fb96 71
bd31be4b
NC
72#ifdef I_STDBOOL
73# include <stdbool.h>
74# ifndef HAS_BOOL
75# define HAS_BOOL 1
76# endif
77#endif
78
8e84507e 79/* bool is built-in for g++-2.6.3 and later, which might be used
c1d22f6b
GS
80 for extensions. <_G_config.h> defines _G_HAVE_BOOL, but we can't
81 be sure _G_config.h will be included before this file. _G_config.h
8e84507e 82 also defines _G_HAVE_BOOL for both gcc and g++, but only g++
c1d22f6b
GS
83 actually has bool. Hence, _G_HAVE_BOOL is pretty useless for us.
84 g++ can be identified by __GNUG__.
85 Andy Dougherty February 2000
5d94fbed 86*/
3609ea0d 87#ifdef __GNUG__ /* GNU g++ has bool built-in */
5d94fbed 88# ifndef HAS_BOOL
c1d22f6b 89# define HAS_BOOL 1
5d94fbed 90# endif
5d94fbed
AD
91#endif
92
641d3f0b
PP
93/* The NeXT dynamic loader headers will not build with the bool macro
94 So declare them now to clear confusion.
95*/
8f1f23e8 96#if defined(NeXT) || defined(__NeXT__)
641d3f0b
PP
97# undef FALSE
98# undef TRUE
99 typedef enum bool { FALSE = 0, TRUE = 1 } bool;
100# define ENUM_BOOL 1
101# ifndef HAS_BOOL
102# define HAS_BOOL 1
103# endif /* !HAS_BOOL */
8f1f23e8 104#endif /* NeXT || __NeXT__ */
641d3f0b 105
5d94fbed 106#ifndef HAS_BOOL
cc3315ba 107# if defined(VMS)
5d94fbed
AD
108# define bool int
109# else
110# define bool char
111# endif
c1d22f6b 112# define HAS_BOOL 1
a687059c 113#endif
0d3e774c 114
f2338a2e
DM
115/* a simple (bool) cast may not do the right thing: if bool is defined
116 * as char for example, then the cast from int is implementation-defined
18f5643b 117 * (bool)!!(cbool) in a ternary triggers a bug in xlc on AIX
f2338a2e
DM
118 */
119
18f5643b 120#define cBOOL(cbool) ((cbool) ? (bool)1 : (bool)0)
f2338a2e 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
70764c00 129# if (defined(_MSC_VER) && _MSC_VER < 1300) || /* MSVC6 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 192#if defined(HAS_QUAD) && defined(USE_64_BIT_INT)
80524f33
JL
193# if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
194# define PeRl_INT64_C(c) CAT2(c,LL)
195# define PeRl_UINT64_C(c) CAT2(c,ULL)
196# else
52865553
SH
197# if QUADKIND == QUAD_IS___INT64
198# define PeRl_INT64_C(c) CAT2(c,I64)
199# define PeRl_UINT64_C(c) CAT2(c,UI64)
69512466 200# else
52865553
SH
201# if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
202# define PeRl_INT64_C(c) CAT2(c,L)
203# define PeRl_UINT64_C(c) CAT2(c,UL)
69512466 204# else
80524f33
JL
205# define PeRl_INT64_C(c) ((I64TYPE)(c))
206# define PeRl_UINT64_C(c) ((U64TYPE)(c))
69512466
JH
207# endif
208# endif
e8c95190 209# endif
80524f33
JL
210# ifndef UINT64_C
211# define UINT64_C(c) PeRl_UINT64_C(c)
212# endif
213# ifndef INT64_C
214# define INT64_C(c) PeRl_INT64_C(c)
215# endif
e8c95190 216#endif
dc750f2e 217
d8668976 218#if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
5ff3f7a4 219
5ff3f7a4
GS
220/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
221 Please search CHAR_MAX in perl.h for further details. */
222#define U8_MAX UINT8_MAX
223#define U8_MIN UINT8_MIN
224
5ff3f7a4
GS
225#define I16_MAX INT16_MAX
226#define I16_MIN INT16_MIN
227#define U16_MAX UINT16_MAX
228#define U16_MIN UINT16_MIN
229
5ff3f7a4
GS
230#define I32_MAX INT32_MAX
231#define I32_MIN INT32_MIN
0e983133
GS
232#ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
233# define U32_MAX UINT32_MAX
234#else
235# define U32_MAX 4294967295U
236#endif
5ff3f7a4
GS
237#define U32_MIN UINT32_MIN
238
239#else
240
5c9fa16e
KA
241/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
242 Please search CHAR_MAX in perl.h for further details. */
27d4fb96
PP
243#define U8_MAX PERL_UCHAR_MAX
244#define U8_MIN PERL_UCHAR_MIN
79072805 245
27d4fb96
PP
246#define I16_MAX PERL_SHORT_MAX
247#define I16_MIN PERL_SHORT_MIN
248#define U16_MAX PERL_USHORT_MAX
249#define U16_MIN PERL_USHORT_MIN
79072805 250
c4f23d77 251#if LONGSIZE > 4
27d4fb96
PP
252# define I32_MAX PERL_INT_MAX
253# define I32_MIN PERL_INT_MIN
254# define U32_MAX PERL_UINT_MAX
255# define U32_MIN PERL_UINT_MIN
79072805 256#else
27d4fb96
PP
257# define I32_MAX PERL_LONG_MAX
258# define I32_MIN PERL_LONG_MIN
259# define U32_MAX PERL_ULONG_MAX
260# define U32_MIN PERL_ULONG_MIN
79072805
LW
261#endif
262
5ff3f7a4
GS
263#endif
264
58a9a5d5 265/* log(2) is pretty close to 0.30103, just in case anyone is grepping for it */
fc36a67e
PP
266#define BIT_DIGITS(N) (((N)*146)/485 + 1) /* log2(10) =~ 146/485 */
267#define TYPE_DIGITS(T) BIT_DIGITS(sizeof(T) * 8)
268#define TYPE_CHARS(T) (TYPE_DIGITS(T) + 2) /* sign, NUL */
269
ff68c719 270#define Ctl(ch) ((ch) & 037)
8d063cd8 271
3fe05580
MHM
272/*
273=head1 SV-Body Allocation
274
275=for apidoc Ama|SV*|newSVpvs|const char* s
276Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
277
84bafc02
NC
278=for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags
279Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
280pair.
281
3fe05580
MHM
282=for apidoc Ama|SV*|newSVpvs_share|const char* s
283Like C<newSVpvn_share>, but takes a literal string instead of a string/length
284pair and omits the hash parameter.
285
9dcc53ea
Z
286=for apidoc Am|void|sv_catpvs_flags|SV* sv|const char* s|I32 flags
287Like C<sv_catpvn_flags>, but takes a literal string instead of a
288string/length pair.
289
290=for apidoc Am|void|sv_catpvs_nomg|SV* sv|const char* s
291Like C<sv_catpvn_nomg>, but takes a literal string instead of a
292string/length pair.
293
7b4e7469 294=for apidoc Am|void|sv_catpvs|SV* sv|const char* s
3fe05580
MHM
295Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
296
9dcc53ea
Z
297=for apidoc Am|void|sv_catpvs_mg|SV* sv|const char* s
298Like C<sv_catpvn_mg>, but takes a literal string instead of a
299string/length pair.
300
7b4e7469 301=for apidoc Am|void|sv_setpvs|SV* sv|const char* s
3fe05580
MHM
302Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
303
9dcc53ea
Z
304=for apidoc Am|void|sv_setpvs_mg|SV* sv|const char* s
305Like C<sv_setpvn_mg>, but takes a literal string instead of a
306string/length pair.
307
308=for apidoc Am|SV *|sv_setref_pvs|const char* s
309Like C<sv_setref_pvn>, but takes a literal string instead of a
310string/length pair.
311
3fe05580
MHM
312=head1 Memory Management
313
314=for apidoc Ama|char*|savepvs|const char* s
315Like C<savepvn>, but takes a literal string instead of a string/length pair.
316
9dcc53ea
Z
317=for apidoc Ama|char*|savesharedpvs|const char* s
318A version of C<savepvs()> which allocates the duplicate string in memory
319which is shared between threads.
320
3fe05580
MHM
321=head1 GV Functions
322
323=for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create
324Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
325
326=head1 Hash Manipulation Functions
327
328=for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval
329Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
330
331=for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val
332Like C<hv_store>, but takes a literal string instead of a string/length pair
333and omits the hash parameter.
334
510966aa
Z
335=head1 Lexer interface
336
337=for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags
338
339Like L</lex_stuff_pvn>, but takes a literal string instead of a
340string/length pair.
341
3fe05580
MHM
342=cut
343*/
344
926bb54c
KW
345/* concatenating with "" ensures that only literal strings are accepted as
346 * argument */
26bfd924 347#define STR_WITH_LEN(s) ("" s ""), (sizeof(s)-1)
2efa8cc7 348
926bb54c
KW
349/* note that STR_WITH_LEN() can't be used as argument to macros or functions
350 * that under some configurations might be macros, which means that it requires
351 * the full Perl_xxx(aTHX_ ...) form for any API calls where it's used.
ba3a79e7
GA
352 */
353
354/* STR_WITH_LEN() shortcuts */
355#define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str))
84bafc02
NC
356#define newSVpvs_flags(str,flags) \
357 Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags)
ba3a79e7 358#define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0)
9dcc53ea
Z
359#define sv_catpvs_flags(sv, str, flags) \
360 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), flags)
361#define sv_catpvs_nomg(sv, str) \
362 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), 0)
363#define sv_catpvs(sv, str) \
364 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC)
365#define sv_catpvs_mg(sv, str) \
366 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC|SV_SMAGIC)
3fe05580 367#define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str))
9dcc53ea
Z
368#define sv_setpvs_mg(sv, str) Perl_sv_setpvn_mg(aTHX_ sv, STR_WITH_LEN(str))
369#define sv_setref_pvs(rv, classname, str) \
370 Perl_sv_setref_pvn(aTHX_ rv, classname, STR_WITH_LEN(str))
ba3a79e7 371#define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str))
9dcc53ea
Z
372#define savesharedpvs(str) Perl_savesharedpvn(aTHX_ STR_WITH_LEN(str))
373#define gv_stashpvs(str, create) \
374 Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create)
375#define gv_fetchpvs(namebeg, add, sv_type) \
376 Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type)
377#define gv_fetchpvn(namebeg, len, add, sv_type) \
378 Perl_gv_fetchpvn_flags(aTHX_ namebeg, len, add, sv_type)
379#define sv_catxmlpvs(dsv, str, utf8) \
380 Perl_sv_catxmlpvn(aTHX_ dsv, STR_WITH_LEN(str), utf8)
a038e571
NC
381#define hv_fetchs(hv,key,lval) \
382 ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \
383 (lval) ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \
384 : HV_FETCH_JUST_SV, NULL, 0))
385
386#define hv_stores(hv,key,val) \
387 ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \
388 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), 0))
ba3a79e7 389
510966aa
Z
390#define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
391
b96d8cd9
NC
392#define get_cvs(str, flags) \
393 Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
5c1737d1 394
954c1994 395/*
ccfc67b7
JH
396=head1 Miscellaneous Functions
397
954c1994
GS
398=for apidoc Am|bool|strNE|char* s1|char* s2
399Test two strings to see if they are different. Returns true or
400false.
401
402=for apidoc Am|bool|strEQ|char* s1|char* s2
403Test two strings to see if they are equal. Returns true or false.
404
405=for apidoc Am|bool|strLT|char* s1|char* s2
406Test two strings to see if the first, C<s1>, is less than the second,
407C<s2>. Returns true or false.
408
409=for apidoc Am|bool|strLE|char* s1|char* s2
410Test two strings to see if the first, C<s1>, is less than or equal to the
411second, C<s2>. Returns true or false.
412
413=for apidoc Am|bool|strGT|char* s1|char* s2
414Test two strings to see if the first, C<s1>, is greater than the second,
415C<s2>. Returns true or false.
416
417=for apidoc Am|bool|strGE|char* s1|char* s2
418Test two strings to see if the first, C<s1>, is greater than or equal to
419the second, C<s2>. Returns true or false.
420
421=for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
422Test two strings to see if they are different. The C<len> parameter
423indicates the number of bytes to compare. Returns true or false. (A
424wrapper for C<strncmp>).
425
426=for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
427Test two strings to see if they are equal. The C<len> parameter indicates
428the number of bytes to compare. Returns true or false. (A wrapper for
429C<strncmp>).
430
431=cut
432*/
433
8d063cd8
LW
434#define strNE(s1,s2) (strcmp(s1,s2))
435#define strEQ(s1,s2) (!strcmp(s1,s2))
436#define strLT(s1,s2) (strcmp(s1,s2) < 0)
437#define strLE(s1,s2) (strcmp(s1,s2) <= 0)
438#define strGT(s1,s2) (strcmp(s1,s2) > 0)
439#define strGE(s1,s2) (strcmp(s1,s2) >= 0)
440#define strnNE(s1,s2,l) (strncmp(s1,s2,l))
441#define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
378cc40b 442
36477c24
PP
443#ifdef HAS_MEMCMP
444# define memNE(s1,s2,l) (memcmp(s1,s2,l))
445# define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
446#else
447# define memNE(s1,s2,l) (bcmp(s1,s2,l))
448# define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
449#endif
450
568a785a 451#define memEQs(s1, l, s2) \
8e6497b6 452 (sizeof(s2)-1 == l && memEQ(s1, ("" s2 ""), (sizeof(s2)-1)))
568a785a
NC
453#define memNEs(s1, l, s2) !memEQs(s1, l, s2)
454
bbce6d69
PP
455/*
456 * Character classes.
457 *
458 * Unfortunately, the introduction of locales means that we
459 * can't trust isupper(), etc. to tell the truth. And when
460 * it comes to /\w+/ with tainting enabled, we *must* be able
461 * to trust our character classes.
462 *
463 * Therefore, the default tests in the text of Perl will be
464 * independent of locale. Any code that wants to depend on
465 * the current locale will use the tests that begin with "lc".
466 */
467
2304df62
AD
468#ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */
469# ifndef CTYPE256
470# define CTYPE256
471# endif
472#endif
473
954c1994 474/*
ccfc67b7
JH
475
476=head1 Character classes
243effed
KW
477This section is about functions (really macros) that classify characters
478into types, such as punctuation versus alphabetic, etc. Most of these are
479analogous to regular expression character classes. (See
480L<perlrecharclass/POSIX Character Classes>.) There are several variants for
481each class. (Not all macros have all variants; each item below lists the
482ones valid for it.) None are affected by C<use bytes>, and only the ones
483with C<LC> in the name are affected by the current locale.
484
485The base function, e.g., C<isALPHA()>, takes an octet (either a C<char> or a
486C<U8>) as input and returns a boolean as to whether or not the character
487represented by that octet is in the named class based on platform, Unicode, and
488Perl rules. If the input is a number that doesn't fit in an octet, FALSE is
489always returned.
490
491Variant C<isFOO_A> (e.g., C<isALPHA_A()>) will return TRUE only if the input is
492also in the ASCII character set. For ASCII platforms, the base function with
493no suffix and the one with the C<_A> suffix are identical. On EBCDIC
494platforms, the C<_A> suffix function will not return true unless the specified
495character also has an ASCII equivalent.
496
497Variant C<isFOO_L1> operates on the full Latin1 character set. For EBCDIC
498platforms, the base function with no suffix and the one with the C<_L1> suffix
499are identical. For ASCII platforms, the C<_L1> suffix imposes the Latin-1
500character set onto the platform. That is, the code points that are ASCII are
501unaffected, since ASCII is a subset of Latin-1. But the non-ASCII code points
502are treated as if they are Latin-1 characters. For example, C<isSPACE_L1()>
503will return true when called with the code point 0xA0, which is the Latin-1
504NO-BREAK SPACE.
505
506Variant C<isFOO_uni> is like the C<isFOO_L1> variant, but accepts any UV code
507point as input. If the code point is larger than 255, Unicode rules are used
508to determine if it is in the character class. For example,
509C<isWORDCHAR(0x100)> returns TRUE, since 0x100 is LATIN CAPITAL LETTER A WITH
510MACRON in Unicode, and is a word character.
511
512Variant C<isFOO_utf8> is like C<isFOO_uni>, but the input is a pointer to a
513(known to be well-formed) UTF-8 encoded string (C<U8*> or C<char*>). The
514classification of just the first character in the string is tested.
515
516Variant C<isFOO_LC> is like the C<isFOO_A> and C<isFOO_L1> variants, but uses
517the C library function that gives the named classification instead of
518hard-coded rules. For example, C<isDIGIT_LC()> returns the result of calling
519C<isdigit()>. This means that the result is based on the current locale, which
520is what C<LC> in the name stands for. FALSE is always returned if the input
521won't fit into an octet.
522
523Variant C<isFOO_LC_uvchr> is like C<isFOO_LC>, but is defined on any UV. It
524returns the same as C<isFOO_LC> for input code points less than 256, and
525returns the hard-coded, not-affected-by-locale, Unicode results for larger ones.
526
527Variant C<isFOO_LC_utf8> is like C<isFOO_LC_uvchr>, but the input is a pointer to a
528(known to be well-formed) UTF-8 encoded string (C<U8*> or C<char*>). The
529classification of just the first character in the string is tested.
ccfc67b7 530
954c1994 531=for apidoc Am|bool|isALPHA|char ch
2787a470 532Returns a boolean indicating whether the specified character is an
243effed
KW
533alphabetic character in the platform's native character set, analogous to
534C<m/[[:alpha:]]/>.
8a58bdcf 535See the L<top of this section|/Character classes> for an explanation of variants
243effed
KW
536C<isALPHA_A>, C<isALPHA_L1>, C<isALPHA_uni>, C<isALPHA_utf8>, C<isALPHA_LC>
537C<isALPHA_LC_uvchr>, and C<isALPHA_LC_utf8>.
8a58bdcf 538
15861f94
KW
539=for apidoc Am|bool|isALPHANUMERIC|char ch
540Returns a boolean indicating whether the specified character is a either an
541alphabetic character or decimal digit in the platform's native character set,
542analogous to C<m/[[:alnum:]]/>.
543See the L<top of this section|/Character classes> for an explanation of variants
544C<isALPHANUMERIC_A>, C<isALPHANUMERIC_L1>, C<isALPHANUMERIC_uni>,
545C<isALPHANUMERIC_utf8>, C<isALPHANUMERIC_LC> C<isALPHANUMERIC_LC_uvchr>, and
546C<isALPHANUMERIC_LC_utf8>.
547
8a58bdcf
KW
548=for apidoc Am|bool|isASCII|char ch
549Returns a boolean indicating whether the specified character is one of the 128
243effed
KW
550characters in the ASCII character set, analogous to C<m/[[:ascii:]]/>.
551On non-ASCII platforms, it is if this
8a58bdcf
KW
552character corresponds to an ASCII character. Variants C<isASCII_A()> and
553C<isASCII_L1()> are identical to C<isASCII()>.
243effed
KW
554See the L<top of this section|/Character classes> for an explanation of variants
555C<isASCII_uni>, C<isASCII_utf8>, C<isASCII_LC>, C<isASCII_LC_uvchr>, and
556C<isASCII_LC_utf8>. Note, however, that some platforms do not have the C
557library routine C<isascii()>. In these cases, the variants whose names contain
558C<LC> are the same as the corresponding ones without.
559
560=for apidoc Am|bool|isBLANK|char ch
561Returns a boolean indicating whether the specified character is a
562character considered to be a blank in the platform's native character set,
563analogous to C<m/[[:blank:]]/>.
564See the L<top of this section|/Character classes> for an explanation of variants
565C<isBLANK_A>, C<isBLANK_L1>, C<isBLANK_uni>, C<isBLANK_utf8>, C<isBLANK_LC>
566C<isBLANK_LC_uvchr>, and C<isBLANK_LC_utf8>. Note, however, that some
567platforms do not have the C library routine C<isblank()>. In these cases, the
568variants whose names contain C<LC> are the same as the corresponding ones
569without.
570
571=for apidoc Am|bool|isCNTRL|char ch
572Returns a boolean indicating whether the specified character is a
573control character in the platform's native character set,
574analogous to C<m/[[:cntrl:]]/>.
575See the L<top of this section|/Character classes> for an explanation of variants
576C<isCNTRL_A>, C<isCNTRL_L1>, C<isCNTRL_uni>, C<isCNTRL_utf8>, C<isCNTRL_LC>
577C<isCNTRL_LC_uvchr>, and C<isCNTRL_LC_utf8>.
954c1994 578
954c1994 579=for apidoc Am|bool|isDIGIT|char ch
2787a470 580Returns a boolean indicating whether the specified character is a
243effed 581digit in the platform's native character set, analogous to C<m/[[:digit:]]/>.
8a58bdcf 582Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
243effed
KW
583See the L<top of this section|/Character classes> for an explanation of variants
584C<isDIGIT_uni>, C<isDIGIT_utf8>, C<isDIGIT_LC> C<isDIGIT_LC_uvchr>, and
585C<isDIGIT_LC_utf8>.
586
587=for apidoc Am|bool|isGRAPH|char ch
588Returns a boolean indicating whether the specified character is a
589graphic character in the platform's native character set, analogous to
590C<m/[[:graph:]]/>.
591See the L<top of this section|/Character classes> for an explanation of variants
592C<isGRAPH_A>, C<isGRAPH_L1>, C<isGRAPH_uni>, C<isGRAPH_utf8>, C<isGRAPH_LC>
593C<isGRAPH_LC_uvchr>, and C<isGRAPH_LC_utf8>.
954c1994 594
0c82b6df 595=for apidoc Am|bool|isLOWER|char ch
2787a470 596Returns a boolean indicating whether the specified character is a
243effed
KW
597lowercase character in the platform's native character set, analogous to
598C<m/[[:lower:]]/>.
8a58bdcf 599See the L<top of this section|/Character classes> for an explanation of variants
243effed
KW
600C<isLOWER_A>, C<isLOWER_L1>, C<isLOWER_uni>, C<isLOWER_utf8>, C<isLOWER_LC>
601C<isLOWER_LC_uvchr>, and C<isLOWER_LC_utf8>.
0c82b6df 602
c99e91e9 603=for apidoc Am|bool|isOCTAL|char ch
2787a470 604Returns a boolean indicating whether the specified character is an
06dc89af 605octal digit, [0-7] in the platform's native character set.
243effed
KW
606The only two variants are C<isOCTAL_A> and C<isOCTAL_L1>; each is identical to
607C<isOCTAL>.
608
609=for apidoc Am|bool|isPUNCT|char ch
610Returns a boolean indicating whether the specified character is a
611punctuation character in the platform's native character set, analogous to
612C<m/[[:punct:]]/>. Note that the definition of what is punctuation isn't as
613straightforward as one might desire. See L<perlrecharclass/POSIX Character
614Classes> for details.
615See the L<top of this section|/Character classes> for an explanation of variants
616C<isPUNCT_A>, C<isPUNCT_L1>, C<isPUNCT_uni>, C<isPUNCT_utf8>, C<isPUNCT_LC>
617C<isPUNCT_LC_uvchr>, and C<isPUNCT_LC_utf8>.
c99e91e9 618
0c82b6df 619=for apidoc Am|bool|isSPACE|char ch
2787a470 620Returns a boolean indicating whether the specified character is a
243effed
KW
621whitespace character in the platform's native character set. This is analogous
622to what C<m/\s/> and C<m/[[:space:]]/> match in a regular expression.
8a58bdcf 623See the L<top of this section|/Character classes> for an explanation of variants
243effed
KW
624C<isSPACE_A>, C<isSPACE_L1>, C<isSPACE_uni>, C<isSPACE_utf8>, C<isSPACE_LC>
625C<isSPACE_LC_uvchr>, and C<isSPACE_LC_utf8>.
0c82b6df 626
954c1994 627=for apidoc Am|bool|isUPPER|char ch
2787a470 628Returns a boolean indicating whether the specified character is an
243effed
KW
629uppercase character in the platform's native character set, analogous to
630C<m/[[:upper:]]/>.
8a58bdcf 631See the L<top of this section|/Character classes> for an explanation of variants
243effed
KW
632C<isUPPER_A>, C<isUPPER_L1>, C<isUPPER_uni>, C<isUPPER_utf8>, C<isUPPER_LC>
633C<isUPPER_LC_uvchr>, and C<isUPPER_LC_utf8>.
954c1994 634
243effed 635=for apidoc Am|bool|isPRINT|char ch
8eea39dd 636Returns a boolean indicating whether the specified character is a
243effed
KW
637printable character in the platform's native character set, analogous to
638C<m/[[:print:]]/>.
8a58bdcf 639See the L<top of this section|/Character classes> for an explanation of variants
243effed
KW
640C<isPRINT_A>, C<isPRINT_L1>, C<isPRINT_uni>, C<isPRINT_utf8>, C<isPRINT_LC>
641C<isPRINT_LC_uvchr>, and C<isPRINT_LC_utf8>.
642
643=for apidoc Am|bool|isWORDCHAR|char ch
644Returns a boolean indicating whether the specified character is a character
645that is a word character, analogous to what C<m/\w/> and C<m/[[:word:]]/> match
646in a regular expression. A word character is an alphabetic character, a
647decimal digit, a connecting punctuation character (such as an underscore), or
648a "mark" character that attaches to one of those (like some sort of accent).
649C<isALNUM()> is a synonym provided for backward compatibility, even though a
650word character includes more than the standard C language meaning of
651alphanumeric.
652See the L<top of this section|/Character classes> for an explanation of variants
653C<isWORDCHAR_A>, C<isWORDCHAR_L1>, C<isWORDCHAR_uni>, C<isWORDCHAR_utf8>,
654C<isWORDCHAR_LC>, C<isWORDCHAR_LC_uvchr>, and C<isWORDCHAR_LC_utf8>.
8a58bdcf
KW
655
656=for apidoc Am|bool|isXDIGIT|char ch
657Returns a boolean indicating whether the specified character is a hexadecimal
243effed
KW
658digit. In the ASCII range these are C<[0-9A-Fa-f]>. Variants C<isXDIGIT_A()>
659and C<isXDIGIT_L1()> are identical to C<isXDIGIT()>.
660See the L<top of this section|/Character classes> for an explanation of variants
661C<isXDIGIT_uni>, C<isXDIGIT_utf8>, C<isXDIGIT_LC>, C<isXDIGIT_LC_uvchr>, and
662C<isXDIGIT_LC_utf8>.
663
664=head1 Miscellaneous Functions
8eea39dd 665
95a59cab 666=for apidoc Am|U8|READ_XDIGIT|char str*
243effed 667Returns the value of an ASCII-range hex digit and advances the string pointer.
95a59cab
YO
668Behaviour is only well defined when isXDIGIT(*str) is true.
669
e7c1e6c1
KW
670=head1 Character case changing
671
954c1994 672=for apidoc Am|char|toUPPER|char ch
06dc89af
KW
673Converts the specified character to uppercase in the platform's native
674character set, if possible; otherwise returns the input character itself.
954c1994
GS
675
676=for apidoc Am|char|toLOWER|char ch
06dc89af
KW
677Converts the specified character to lowercase in the platform's native
678character set, if possible; otherwise returns the input character itself.
954c1994
GS
679
680=cut
353c9b6f 681
15861f94 682Still undocumented are , PSXSPC, VERTSPACE, and IDFIRST, and the other
243effed
KW
683toUPPER etc functions
684
8a58bdcf 685Note that these macros are repeated in Devel::PPPort, so should also be
62fa66b6
KW
686patched there. The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
687
954c1994
GS
688*/
689
7c062697
KW
690/* Specify the widest unsigned type on the platform. Use U64TYPE because U64
691 * is known only in the perl core, and this macro can be called from outside
692 * that */
693#ifdef HAS_QUAD
694# define WIDEST_UTYPE U64TYPE
695#else
696# define WIDEST_UTYPE U32
697#endif
698
3912bc88
KW
699/* FITS_IN_8_BITS(c) returns true if c doesn't have a bit set other than in
700 * the lower 8. It is designed to be hopefully bomb-proof, making sure that no
701 * bits of information are lost even on a 64-bit machine, but to get the
702 * compiler to optimize it out if possible. This is because Configure makes
703 * sure that the machine has an 8-bit byte, so if c is stored in a byte, the
704 * sizeof() guarantees that this evaluates to a constant true at compile time.
220c71bf
KW
705 */
706#define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || !(((WIDEST_UTYPE)(c)) & ~0xFF))
cf301eb7 707
41f43cc2 708#ifdef EBCDIC
ff7eba81 709# define isASCII(c) (FITS_IN_8_BITS(c) && (NATIVE_TO_UNI((U8) (c)) < 128))
41f43cc2
KW
710#else
711# define isASCII(c) ((WIDEST_UTYPE)(c) < 128)
712#endif
713
ec79cfbb 714#define isASCII_A(c) isASCII(c)
3509bb53 715#define isASCII_L1(c) isASCII(c)
6515cb76 716
c2da0b36
KW
717/* The lower 3 bits in both the ASCII and EBCDIC representations of '0' are 0,
718 * and the 8 possible permutations of those bits exactly comprise the 8 octal
719 * digits */
3d33b3e3 720#define isOCTAL_A(c) cBOOL(FITS_IN_8_BITS(c) && (0xF8 & (c)) == '0')
c2da0b36 721
ec79cfbb 722/* ASCII range only */
9fb1bf9d 723#ifdef H_PERL /* If have access to perl.h, lookup in its table */
f4cdb42c 724
a500dc72
KW
725/* Character class numbers. For internal core Perl use only. The ones less
726 * than 32 are used in PL_charclass[] and the ones up through the one that
727 * corresponds to <_HIGHEST_REGCOMP_DOT_H_SYNC> are used by regcomp.h and
728 * related files. PL_charclass ones use names used in l1_char_class_tab.h but
729 * their actual definitions are here. If that file has a name not used here,
730 * it won't compile.
1709d539
KW
731 *
732 * The first group of these is ordered in what I (khw) estimate to be the
31c7f561
KW
733 * frequency of their use. This gives a slight edge to exiting a loop earlier
734 * (in reginclass() in regexec.c) */
1709d539
KW
735# define _CC_WORDCHAR 0 /* \w and [:word:] */
736# define _CC_DIGIT 1 /* \d and [:digit:] */
737# define _CC_ALPHA 2 /* [:alpha:] */
738# define _CC_LOWER 3 /* [:lower:] */
739# define _CC_UPPER 4 /* [:upper:] */
740# define _CC_PUNCT 5 /* [:punct:] */
741# define _CC_PRINT 6 /* [:print:] */
15861f94 742# define _CC_ALPHANUMERIC 7 /* [:alnum:] */
1709d539
KW
743# define _CC_GRAPH 8 /* [:graph:] */
744
745#define _FIRST_NON_SWASH_CC 9
746/* The character classes above are implemented with swashes. The second group
747 * (just below) contains the ones implemented without. These are also sorted
748 * in rough order of the frequency of their use, except that \v should be last,
749 * as it isn't a real Posix character class, and some (small) inefficiencies in
750 * regular expression handling would be introduced by putting it in the middle
751 * of those that are. Also, cntrl and ascii come after the others as it may be
752 * useful to group these which have no members that match above Latin1, (or
753 * above ASCII in the latter case) */
754
755# define _CC_SPACE 9 /* \s */
756# define _CC_BLANK 10 /* [:blank:] */
757# define _CC_XDIGIT 11 /* [:xdigit:] */
758# define _CC_PSXSPC 12 /* [:space:] */
759# define _CC_CNTRL 13 /* [:cntrl:] */
760# define _CC_ASCII 14 /* [:ascii:] */
761# define _CC_VERTSPACE 15 /* \v */
762
a0947d7b
KW
763# define _HIGHEST_REGCOMP_DOT_H_SYNC _CC_VERTSPACE
764
1709d539
KW
765/* The members of the third group below do not need to be coordinated with data
766 * structures in regcomp.[ch] and regexec.c */
a0947d7b
KW
767# define _CC_IDFIRST 16
768# define _CC_CHARNAME_CONT 17
769# define _CC_NONLATIN1_FOLD 18
770# define _CC_QUOTEMETA 19
771# define _CC_NON_FINAL_FOLD 20
772# define _CC_IS_IN_SOME_FOLD 21
773/* Unused: 22-31
f4cdb42c
KW
774 * If more bits are needed, one could add a second word for non-64bit
775 * QUAD_IS_INT systems, using some #ifdefs to distinguish between having a 2nd
37ede926
KW
776 * word or not. The IS_IN_SOME_FOLD bit is the most easily expendable, as it
777 * is used only for optimization (as of this writing), and differs in the
778 * Latin1 range from the ALPHA bit only in two relatively unimportant
a500dc72
KW
779 * characters: the masculine and feminine ordinal indicators, so removing it
780 * would just cause /i regexes which match them to run less efficiently */
96ac0975 781
3a371f2f
KW
782#if defined(PERL_CORE) || defined(PERL_EXT)
783/* An enum version of the character class numbers, to help compilers
784 * optimize */
785typedef enum {
15861f94 786 _CC_ENUM_ALPHANUMERIC = _CC_ALPHANUMERIC,
3a371f2f
KW
787 _CC_ENUM_ALPHA = _CC_ALPHA,
788 _CC_ENUM_DIGIT = _CC_DIGIT,
789 _CC_ENUM_GRAPH = _CC_GRAPH,
790 _CC_ENUM_LOWER = _CC_LOWER,
791 _CC_ENUM_PRINT = _CC_PRINT,
792 _CC_ENUM_PUNCT = _CC_PUNCT,
793 _CC_ENUM_UPPER = _CC_UPPER,
794 _CC_ENUM_WORDCHAR = _CC_WORDCHAR,
795 _CC_ENUM_SPACE = _CC_SPACE,
796 _CC_ENUM_BLANK = _CC_BLANK,
797 _CC_ENUM_XDIGIT = _CC_XDIGIT,
798 _CC_ENUM_CNTRL = _CC_CNTRL,
799 _CC_ENUM_PSXSPC = _CC_PSXSPC,
800 _CC_ENUM_ASCII = _CC_ASCII,
801 _CC_ENUM_VERTSPACE = _CC_VERTSPACE
802} _char_class_number;
803#endif
804
63c61c3f 805#define POSIX_SWASH_COUNT _FIRST_NON_SWASH_CC
86f72d56 806#define POSIX_CC_COUNT (_HIGHEST_REGCOMP_DOT_H_SYNC + 1)
63c61c3f 807
3018b823 808#if defined(PERL_IN_UTF8_C) || defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
922e8cb4
KW
809# if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
810 || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6 \
811 || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8
812 #error Need to adjust order of swash_property_names[]
813# endif
814
b44daeeb
KW
815/* This is declared static in each of the few files that this is #defined for
816 * to keep them from being publicly accessible. Hence there is a small amount
817 * of wasted space */
818
922e8cb4
KW
819static const char* const swash_property_names[] = {
820 "XPosixWord",
821 "XPosixDigit",
822 "XPosixAlpha",
823 "XPosixLower",
824 "XPosixUpper",
825 "XPosixPunct",
826 "XPosixPrint",
827 "XPosixAlnum",
828 "XPosixGraph"
829};
830#endif
831
96ac0975
NC
832# ifdef DOINIT
833EXTCONST U32 PL_charclass[] = {
834# include "l1_char_class_tab.h"
835};
836
837# else /* ! DOINIT */
838EXTCONST U32 PL_charclass[];
839# endif
840
265c1f46 841 /* The 1U keeps Solaris from griping when shifting sets the uppermost bit */
430b7c70
KW
842# define _CC_mask(classnum) (1U << (classnum))
843# define _generic_isCC(c, classnum) cBOOL(FITS_IN_8_BITS(c) \
926bb54c 844 && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask(classnum)))
4eeeb416 845
f4cdb42c
KW
846 /* The mask for the _A versions of the macros; it just adds in the bit for
847 * ASCII. */
848# define _CC_mask_A(classnum) (_CC_mask(classnum) | _CC_mask(_CC_ASCII))
849
850 /* The _A version makes sure that both the desired bit and the ASCII bit
851 * are present */
852# define _generic_isCC_A(c, classnum) (FITS_IN_8_BITS(c) \
853 && ((PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask_A(classnum)) \
854 == _CC_mask_A(classnum)))
855
f4cdb42c 856# define isALPHA_A(c) _generic_isCC_A(c, _CC_ALPHA)
15861f94 857# define isALPHANUMERIC_A(c) _generic_isCC_A(c, _CC_ALPHANUMERIC)
f4cdb42c
KW
858# define isBLANK_A(c) _generic_isCC_A(c, _CC_BLANK)
859# define isCNTRL_A(c) _generic_isCC_A(c, _CC_CNTRL)
860# define isDIGIT_A(c) _generic_isCC(c, _CC_DIGIT)
861# define isGRAPH_A(c) _generic_isCC_A(c, _CC_GRAPH)
862# define isLOWER_A(c) _generic_isCC_A(c, _CC_LOWER)
863# define isPRINT_A(c) _generic_isCC_A(c, _CC_PRINT)
864# define isPSXSPC_A(c) _generic_isCC_A(c, _CC_PSXSPC)
865# define isPUNCT_A(c) _generic_isCC_A(c, _CC_PUNCT)
866# define isSPACE_A(c) _generic_isCC_A(c, _CC_SPACE)
867# define isUPPER_A(c) _generic_isCC_A(c, _CC_UPPER)
868# define isWORDCHAR_A(c) _generic_isCC_A(c, _CC_WORDCHAR)
869# define isXDIGIT_A(c) _generic_isCC(c, _CC_XDIGIT)
870# define isIDFIRST_A(c) _generic_isCC_A(c, ( _CC_IDFIRST))
871
fb9bfbf7
KW
872 /* Either participates in a fold with a character above 255, or is a
873 * multi-char fold */
430b7c70
KW
874# define _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) ((! cBOOL(FITS_IN_8_BITS(c))) || (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask(_CC_NONLATIN1_FOLD)))
875
4eeeb416 876# define _isQUOTEMETA(c) _generic_isCC(c, _CC_QUOTEMETA)
26faadbd
KW
877# define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
878 _generic_isCC(c, _CC_NON_FINAL_FOLD)
37ede926
KW
879# define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
880 _generic_isCC(c, _CC_IS_IN_SOME_FOLD)
9fb1bf9d 881#else /* No perl.h. */
9fb1bf9d 882# ifdef EBCDIC
9fb1bf9d 883# define isALPHA_A(c) (isASCII(c) && isALPHA(c))
15861f94 884# define isALPHANUMERIC_A(c) (isASCII(c) && isALPHANUMERIC(c))
9fb1bf9d
KW
885# define isBLANK_A(c) (isASCII(c) && isBLANK(c))
886# define isCNTRL_A(c) (isASCII(c) && isCNTRL(c))
887# define isDIGIT_A(c) (isASCII(c) && isDIGIT(c))
888# define isGRAPH_A(c) (isASCII(c) && isGRAPH(c))
889# define isIDFIRST_A(c) (isASCII(c) && isIDFIRST(c))
890# define isLOWER_A(c) (isASCII(c) && isLOWER(c))
891# define isPRINT_A(c) (isASCII(c) && isPRINT(c))
892# define isPSXSPC_A(c) (isASCII(c) && isPSXSPC(c))
893# define isPUNCT_A(c) (isASCII(c) && isPUNCT(c))
894# define isSPACE_A(c) (isASCII(c) && isSPACE(c))
895# define isUPPER_A(c) (isASCII(c) && isUPPER(c))
896# define isWORDCHAR_A(c) (isASCII(c) && isWORDCHAR(c))
897# define isXDIGIT_A(c) (isASCII(c) && isXDIGIT(c))
898# else /* ASCII platform, no perl.h */
9fb1bf9d 899# define isALPHA_A(c) (isUPPER_A(c) || isLOWER_A(c))
15861f94 900# define isALPHANUMERIC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
9fb1bf9d 901# define isBLANK_A(c) ((c) == ' ' || (c) == '\t')
926bb54c 902# define isCNTRL_A(c) (FITS_IN_8_BITS(c) && ((U8) (c) < ' ' || (c) == 127))
2181da29 903# define isDIGIT_A(c) ((c) <= '9' && (c) >= '0')
9fb1bf9d
KW
904# define isGRAPH_A(c) (isWORDCHAR_A(c) || isPUNCT_A(c))
905# define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_')
906# define isLOWER_A(c) ((c) >= 'a' && (c) <= 'z')
907# define isPRINT_A(c) (((c) >= 32 && (c) < 127))
908# define isPSXSPC_A(c) (isSPACE_A(c) || (c) == '\v')
926bb54c
KW
909# define isPUNCT_A(c) (((c) >= 33 && (c) <= 47) \
910 || ((c) >= 58 && (c) <= 64) \
911 || ((c) >= 91 && (c) <= 96) \
912 || ((c) >= 123 && (c) <= 126))
913# define isSPACE_A(c) ((c) == ' ' \
914 || (c) == '\t' \
915 || (c) == '\n' \
916 || (c) =='\r' \
917 || (c) == '\f')
2181da29 918# define isUPPER_A(c) ((c) <= 'Z' && (c) >= 'A')
9fb1bf9d 919# define isWORDCHAR_A(c) (isALPHA_A(c) || isDIGIT_A(c) || (c) == '_')
926bb54c
KW
920# define isXDIGIT_A(c) (isDIGIT_A(c) \
921 || ((c) >= 'a' && (c) <= 'f') \
922 || ((c) <= 'F' && (c) >= 'A'))
9fb1bf9d
KW
923# endif
924#endif /* ASCII range definitions */
ec79cfbb
KW
925
926/* Latin1 definitions */
8a58bdcf 927#ifdef H_PERL
f4cdb42c 928# define isALPHA_L1(c) _generic_isCC(c, _CC_ALPHA)
15861f94 929# define isALPHANUMERIC_L1(c) _generic_isCC(c, _CC_ALPHANUMERIC)
f4cdb42c 930# define isBLANK_L1(c) _generic_isCC(c, _CC_BLANK)
e5dcd934 931
8a58bdcf 932/* continuation character for legal NAME in \N{NAME} */
4eeeb416 933# define isCHARNAME_CONT(c) _generic_isCC(c, _CC_CHARNAME_CONT)
e5dcd934 934
f4cdb42c
KW
935# define isCNTRL_L1(c) _generic_isCC(c, _CC_CNTRL)
936# define isGRAPH_L1(c) _generic_isCC(c, _CC_GRAPH)
937# define isLOWER_L1(c) _generic_isCC(c, _CC_LOWER)
938# define isPRINT_L1(c) _generic_isCC(c, _CC_PRINT)
939# define isPSXSPC_L1(c) _generic_isCC(c, _CC_PSXSPC)
940# define isPUNCT_L1(c) _generic_isCC(c, _CC_PUNCT)
941# define isSPACE_L1(c) _generic_isCC(c, _CC_SPACE)
942# define isUPPER_L1(c) _generic_isCC(c, _CC_UPPER)
943# define isWORDCHAR_L1(c) _generic_isCC(c, _CC_WORDCHAR)
944# define isIDFIRST_L1(c) _generic_isCC(c, _CC_IDFIRST)
8a58bdcf
KW
945#else /* No access to perl.h. Only a few provided here, just in case needed
946 * for backwards compatibility */
947 /* ALPHAU includes Unicode semantics for latin1 characters. It has an extra
948 * >= AA test to speed up ASCII-only tests at the expense of the others */
949# define isALPHA_L1(c) (isALPHA(c) || (NATIVE_TO_UNI((U8) c) >= 0xAA \
950 && ((NATIVE_TO_UNI((U8) c) >= 0xC0 \
926bb54c 951 && NATIVE_TO_UNI((U8) c) != 0xD7 && NATIVE_TO_UNI((U8) c) != 0xF7) \
8a58bdcf
KW
952 || NATIVE_TO_UNI((U8) c) == 0xAA \
953 || NATIVE_TO_UNI((U8) c) == 0xB5 \
954 || NATIVE_TO_UNI((U8) c) == 0xBA)))
926bb54c
KW
955# define isCHARNAME_CONT(c) (isWORDCHAR_L1(c) \
956 || (c) == ' ' \
957 || (c) == '-' \
958 || (c) == '(' \
959 || (c) == ')' \
960 || (c) == ':' \
961 || NATIVE_TO_UNI((U8) c) == 0xA0)
8a58bdcf
KW
962#endif
963
8a58bdcf
KW
964/* Macros that differ between EBCDIC and ASCII. Where C89 defines a function,
965 * that is used in the EBCDIC form, because in EBCDIC we do not do locales:
966 * therefore can use native functions. For those where C89 doesn't define a
967 * function, use our function, assuming that the EBCDIC code page is isomorphic
968 * with Latin1, which the three currently recognized by Perl are. Some libc's
969 * have an isblank(), but it's not guaranteed. */
9d116dd7 970#ifdef EBCDIC
271b5cb3 971# define isALPHA(c) isalpha(c)
15861f94 972# define isALPHANUMERIC(c) isalnum(c)
0bc70f7f 973# define isBLANK(c) ((c) == ' ' || (c) == '\t' || NATIVE_TO_UNI(c) == 0xA0)
b8c5462f 974# define isCNTRL(c) iscntrl(c)
9916188f 975# define isDIGIT(c) isdigit(c)
b8c5462f 976# define isGRAPH(c) isgraph(c)
8a58bdcf 977# define isIDFIRST(c) (isALPHA(c) || (c) == '_')
7d79683e 978# define isLOWER(c) islower(c)
9d116dd7 979# define isPRINT(c) isprint(c)
56e4b611 980# define isPSXSPC(c) isspace(c)
b8c5462f 981# define isPUNCT(c) ispunct(c)
f1f70107
KW
982# define isSPACE(c) (isPSXSPC(c) /* && (c) != '\v' (Experimentally making
983 these macros identical) */)
7d79683e 984# define isUPPER(c) isupper(c)
b8c5462f 985# define isXDIGIT(c) isxdigit(c)
8a58bdcf 986# define isWORDCHAR(c) (isalnum(c) || (c) == '_')
9d116dd7 987# define toLOWER(c) tolower(c)
7d79683e 988# define toUPPER(c) toupper(c)
ec79cfbb 989#else /* Not EBCDIC: ASCII-only matching */
15861f94 990# define isALPHANUMERIC(c) isALPHANUMERIC_A(c)
271b5cb3 991# define isALPHA(c) isALPHA_A(c)
ec79cfbb
KW
992# define isBLANK(c) isBLANK_A(c)
993# define isCNTRL(c) isCNTRL_A(c)
994# define isDIGIT(c) isDIGIT_A(c)
995# define isGRAPH(c) isGRAPH_A(c)
8a58bdcf 996# define isIDFIRST(c) isIDFIRST_A(c)
ec79cfbb
KW
997# define isLOWER(c) isLOWER_A(c)
998# define isPRINT(c) isPRINT_A(c)
999# define isPSXSPC(c) isPSXSPC_A(c)
1000# define isPUNCT(c) isPUNCT_A(c)
1001# define isSPACE(c) isSPACE_A(c)
1002# define isUPPER(c) isUPPER_A(c)
8a58bdcf 1003# define isWORDCHAR(c) isWORDCHAR_A(c)
ec79cfbb 1004# define isXDIGIT(c) isXDIGIT_A(c)
00f254e2 1005
8a58bdcf
KW
1006 /* ASCII casing. These could also be written as
1007 #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
1008 #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
1009 which uses table lookup and mask instead of subtraction. (This would
1010 work because the _MOD does not apply in the ASCII range) */
9d116dd7 1011# define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c))
7d79683e 1012# define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c))
9d116dd7 1013#endif
bbce6d69 1014
1a0901db
KW
1015
1016/* Use table lookup for speed; return error character for input
1017 * out-of-range */
1018#define toLOWER_LATIN1(c) (FITS_IN_8_BITS(c) \
1019 ? UNI_TO_NATIVE(PL_latin1_lc[ \
1020 NATIVE_TO_UNI( (U8) (c)) ]) \
1021 : UNICODE_REPLACEMENT)
1022/* Modified uc. Is correct uc except for three non-ascii chars which are
1023 * all mapped to one of them, and these need special handling; error
1024 * character for input out-of-range */
1025#define toUPPER_LATIN1_MOD(c) (FITS_IN_8_BITS(c) \
1026 ? UNI_TO_NATIVE(PL_mod_latin1_uc[ \
1027 NATIVE_TO_UNI( (U8) (c)) ]) \
1028 : UNICODE_REPLACEMENT)
1029
bbce6d69
PP
1030#ifdef USE_NEXT_CTYPE
1031
15861f94 1032# define isALPHANUMERIC_LC(c) NXIsAlNum((unsigned int)(c))
ff68c719 1033# define isALPHA_LC(c) NXIsAlpha((unsigned int)(c))
07315176 1034# define isASCII_LC(c) isASCII((unsigned int)(c))
67addccf 1035# define isBLANK_LC(c) isBLANK((unsigned int)(c))
b8c5462f 1036# define isCNTRL_LC(c) NXIsCntrl((unsigned int)(c))
509fb054 1037# define isDIGIT_LC(c) NXIsDigit((unsigned int)(c))
b8c5462f 1038# define isGRAPH_LC(c) NXIsGraph((unsigned int)(c))
509fb054
KW
1039# define isIDFIRST_LC(c) (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
1040# define isLOWER_LC(c) NXIsLower((unsigned int)(c))
ff68c719 1041# define isPRINT_LC(c) NXIsPrint((unsigned int)(c))
b8c5462f 1042# define isPUNCT_LC(c) NXIsPunct((unsigned int)(c))
509fb054
KW
1043# define isSPACE_LC(c) NXIsSpace((unsigned int)(c))
1044# define isUPPER_LC(c) NXIsUpper((unsigned int)(c))
1045# define isWORDCHAR_LC(c) (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
e712593e 1046# define isXDIGIT_LC(c) NXIsXDigit((unsigned int)(c))
ff68c719 1047# define toLOWER_LC(c) NXToLower((unsigned int)(c))
509fb054 1048# define toUPPER_LC(c) NXToUpper((unsigned int)(c))
bbce6d69
PP
1049
1050#else /* !USE_NEXT_CTYPE */
b8c5462f 1051
bbce6d69
PP
1052# if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
1053
76fde96a 1054/* Use foo_LC_uvchr() instead of these for beyond the Latin1 range */
851131d3 1055
76fde96a 1056# define isALPHA_LC(c) (FITS_IN_8_BITS(c) && isalpha((unsigned char)(c)))
15861f94
KW
1057# define isALPHANUMERIC_LC(c) (FITS_IN_8_BITS(c) \
1058 && isalnum((unsigned char)(c)))
07315176 1059# ifdef HAS_ISASCII
76fde96a 1060# define isASCII_LC(c) (FITS_IN_8_BITS(c) && isascii((unsigned char)(c)))
07315176 1061# else
76fde96a 1062# define isASCII_LC(c) (FITS_IN_8_BITS(c) && isASCII((unsigned char)(c)))
07315176 1063# endif
67addccf 1064# ifdef HAS_ISBLANK
76fde96a 1065# define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isblank((unsigned char)(c)))
67addccf 1066# else
76fde96a 1067# define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isBLANK((unsigned char)(c)))
67addccf 1068# endif
76fde96a 1069# define isCNTRL_LC(c) (FITS_IN_8_BITS(c) && iscntrl((unsigned char)(c)))
509fb054 1070# define isDIGIT_LC(c) (FITS_IN_8_BITS(c) && isdigit((unsigned char)(c)))
76fde96a 1071# define isGRAPH_LC(c) (FITS_IN_8_BITS(c) && isgraph((unsigned char)(c)))
509fb054
KW
1072# define isIDFIRST_LC(c) (FITS_IN_8_BITS(c) \
1073 && (isalpha((unsigned char)(c)) || (char)(c) == '_'))
1074# define isLOWER_LC(c) (FITS_IN_8_BITS(c) && islower((unsigned char)(c)))
76fde96a
KW
1075# define isPRINT_LC(c) (FITS_IN_8_BITS(c) && isprint((unsigned char)(c)))
1076# define isPUNCT_LC(c) (FITS_IN_8_BITS(c) && ispunct((unsigned char)(c)))
509fb054
KW
1077# define isSPACE_LC(c) (FITS_IN_8_BITS(c) && isspace((unsigned char)(c)))
1078# define isUPPER_LC(c) (FITS_IN_8_BITS(c) && isupper((unsigned char)(c)))
1079# define isWORDCHAR_LC(c) (FITS_IN_8_BITS(c) \
1080 && (isalnum((unsigned char)(c)) || (char)(c) == '_'))
e712593e 1081# define isXDIGIT_LC(c) (FITS_IN_8_BITS(c) && isxdigit((unsigned char)(c)))
76fde96a 1082# define toLOWER_LC(c) (FITS_IN_8_BITS(c) ? tolower((unsigned char)(c)) : (c))
509fb054 1083# define toUPPER_LC(c) (FITS_IN_8_BITS(c) ? toupper((unsigned char)(c)) : (c))
bbce6d69
PP
1084
1085# else
1086
bbce6d69 1087# define isALPHA_LC(c) (isascii(c) && isalpha(c))
15861f94 1088# define isALPHANUMERIC_LC(c) (isascii(c) && isalnum(c))
07315176 1089# define isASCII_LC(c) isascii(c)
67addccf
KW
1090# ifdef HAS_ISBLANK
1091# define isBLANK_LC(c) (isascii(c) && isblank(c))
1092# else
3e66ab74 1093# define isBLANK_LC(c) isBLANK_A(c)
67addccf 1094# endif
b8c5462f 1095# define isCNTRL_LC(c) (isascii(c) && iscntrl(c))
509fb054 1096# define isDIGIT_LC(c) (isascii(c) && isdigit(c))
b8c5462f 1097# define isGRAPH_LC(c) (isascii(c) && isgraph(c))
509fb054
KW
1098# define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
1099# define isLOWER_LC(c) (isascii(c) && islower(c))
bbce6d69 1100# define isPRINT_LC(c) (isascii(c) && isprint(c))
b8c5462f 1101# define isPUNCT_LC(c) (isascii(c) && ispunct(c))
509fb054
KW
1102# define isSPACE_LC(c) (isascii(c) && isspace(c))
1103# define isUPPER_LC(c) (isascii(c) && isupper(c))
1104# define isWORDCHAR_LC(c) (isascii(c) && (isalnum(c) || (c) == '_'))
e712593e 1105# define isXDIGIT_LC(c) (isascii(c) && isxdigit(c))
76fde96a 1106# define toLOWER_LC(c) (isascii(c) ? tolower(c) : (c))
509fb054 1107# define toUPPER_LC(c) (isascii(c) ? toupper(c) : (c))
bbce6d69
PP
1108
1109# endif
a0d0e21e 1110#endif /* USE_NEXT_CTYPE */
55204971 1111
13380643 1112#define isPSXSPC_LC(c) isSPACE_LC(c)
aaa51d5e 1113
66c17564 1114/* For internal core Perl use only. If the input is Latin1, use the Latin1
a500dc72
KW
1115 * macro; otherwise use the function 'above_latin1'. Won't compile if 'c' isn't unsigned, as
1116 * won't match above_latin1 prototype. The macros do bounds checking, so have
66c17564
KW
1117 * duplicate checks here, so could create versions of the macros that don't,
1118 * but experiments show that gcc optimizes them out anyway. */
1119
1120/* Note that all ignore 'use bytes' */
cd500f2f
KW
1121#define _generic_uni(classnum, above_latin1, c) ((c) < 256 \
1122 ? _generic_isCC(c, classnum) \
1123 : above_latin1(c))
1124#define _generic_swash_uni(classnum, c) ((c) < 256 \
1125 ? _generic_isCC(c, classnum) \
922e8cb4 1126 : _is_uni_FOO(classnum, c))
cd500f2f
KW
1127#define isALPHA_uni(c) _generic_swash_uni(_CC_ALPHA, c)
1128#define isALPHANUMERIC_uni(c) _generic_swash_uni(_CC_ALPHANUMERIC, c)
509fb054
KW
1129#define isASCII_uni(c) isASCII(c)
1130#define isBLANK_uni(c) _generic_uni(_CC_BLANK, is_HORIZWS_cp_high, c)
1131#define isCNTRL_uni(c) isCNTRL_L1(c) /* All controls are in Latin1 */
cd500f2f
KW
1132#define isDIGIT_uni(c) _generic_swash_uni(_CC_DIGIT, c)
1133#define isGRAPH_uni(c) _generic_swash_uni(_CC_GRAPH, c)
509fb054 1134#define isIDFIRST_uni(c) _generic_uni(_CC_IDFIRST, _is_uni_perl_idstart, c)
cd500f2f
KW
1135#define isLOWER_uni(c) _generic_swash_uni(_CC_LOWER, c)
1136#define isPRINT_uni(c) _generic_swash_uni(_CC_PRINT, c)
aea0c08c 1137
509fb054
KW
1138/* Posix and regular space are identical above Latin1 */
1139#define isPSXSPC_uni(c) _generic_uni(_CC_PSXSPC, is_XPERLSPACE_cp_high, c)
b18192e9 1140
cd500f2f 1141#define isPUNCT_uni(c) _generic_swash_uni(_CC_PUNCT, c)
509fb054 1142#define isSPACE_uni(c) _generic_uni(_CC_SPACE, is_XPERLSPACE_cp_high, c)
cd500f2f 1143#define isUPPER_uni(c) _generic_swash_uni(_CC_UPPER, c)
509fb054 1144#define isVERTWS_uni(c) _generic_uni(_CC_VERTSPACE, is_VERTWS_cp_high, c)
cd500f2f 1145#define isWORDCHAR_uni(c) _generic_swash_uni(_CC_WORDCHAR, c)
509fb054 1146#define isXDIGIT_uni(c) _generic_uni(_CC_XDIGIT, is_XDIGIT_cp_high, c)
b18192e9 1147
b8d68ded 1148#define toFOLD_uni(c,s,l) to_uni_fold(c,s,l)
509fb054
KW
1149#define toLOWER_uni(c,s,l) to_uni_lower(c,s,l)
1150#define toTITLE_uni(c,s,l) to_uni_title(c,s,l)
1151#define toUPPER_uni(c,s,l) to_uni_upper(c,s,l)
a0ed51b3 1152
cd500f2f
KW
1153#define _generic_LC_uvchr(latin1, above_latin1, c) \
1154 (c < 256 ? latin1(c) : above_latin1(c))
1155#define _generic_LC_swash_uvchr(latin1, classnum, c) \
1156 (c < 256 ? latin1(c) : _is_uni_FOO(classnum, c))
1157
1158#define isALPHA_LC_uvchr(c) _generic_LC_swash_uvchr(isALPHA_LC, _CC_ALPHA, c)
1159#define isALPHANUMERIC_LC_uvchr(c) _generic_LC_swash_uvchr(isALPHANUMERIC_LC, \
1160 _CC_ALPHANUMERIC, c)
509fb054 1161#define isASCII_LC_uvchr(c) isASCII_LC(c)
cd500f2f 1162#define isBLANK_LC_uvchr(c) _generic_LC_uvchr(isBLANK_LC, is_HORIZWS_cp_high, c)
feeab5a9 1163#define isCNTRL_LC_uvchr(c) (c < 256 ? isCNTRL_LC(c) : 0)
cd500f2f
KW
1164#define isDIGIT_LC_uvchr(c) _generic_LC_swash_uvchr(isDIGIT_LC, _CC_DIGIT, c)
1165#define isGRAPH_LC_uvchr(c) _generic_LC_swash_uvchr(isGRAPH_LC, _CC_GRAPH, c)
1166#define isIDFIRST_LC_uvchr(c) _generic_LC_uvchr(isIDFIRST_LC, \
1167 _is_uni_perl_idstart, c)
1168#define isLOWER_LC_uvchr(c) _generic_LC_swash_uvchr(isLOWER_LC, _CC_LOWER, c)
1169#define isPRINT_LC_uvchr(c) _generic_LC_swash_uvchr(isPRINT_LC, _CC_PRINT, c)
509fb054
KW
1170#define isPSXSPC_LC_uvchr(c) isSPACE_LC_uvchr(c) /* space is identical to posix
1171 space under locale */
cd500f2f
KW
1172#define isPUNCT_LC_uvchr(c) _generic_LC_swash_uvchr(isPUNCT_LC, _CC_PUNCT, c)
1173#define isSPACE_LC_uvchr(c) _generic_LC_uvchr(isSPACE_LC, \
509fb054 1174 is_XPERLSPACE_cp_high, c)
cd500f2f
KW
1175#define isUPPER_LC_uvchr(c) _generic_LC_swash_uvchr(isUPPER_LC, _CC_UPPER, c)
1176#define isWORDCHAR_LC_uvchr(c) _generic_LC_swash_uvchr(isWORDCHAR_LC, \
1177 _CC_WORDCHAR, c)
1178#define isXDIGIT_LC_uvchr(c) _generic_LC_uvchr(isXDIGIT_LC, is_XDIGIT_cp_high, c)
e712593e 1179
a0ed51b3 1180
36b00f93 1181#define isBLANK_LC_uni(c) isBLANK_LC_uvchr(UNI_TO_NATIVE(c))
aaa51d5e 1182
a500dc72
KW
1183/* Everything whose name begins with an underscore is for internal core Perl
1184 * use only. */
1185
1186/* If the input is in the Latin1 range, use
252810d0
KW
1187 * the Latin1 macro 'classnum' on 'p' which is a pointer to a UTF-8 string.
1188 * Otherwise use the value given by the 'utf8' parameter. This relies on the
1189 * fact that ASCII characters have the same representation whether utf8 or not.
1190 * Note that it assumes that the utf8 has been validated, and ignores 'use
1191 * bytes' */
cd500f2f 1192#define _generic_utf8(classnum, p, utf8) (UTF8_IS_INVARIANT(*(p)) \
aea0c08c 1193 ? _generic_isCC(*(p), classnum) \
7d7a6efc 1194 : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
aea0c08c
KW
1195 ? _generic_isCC( \
1196 TWO_BYTE_UTF8_TO_UNI(*(p), \
1197 *((p)+1 )), \
1198 classnum) \
252810d0 1199 : utf8)
cd500f2f
KW
1200/* Like the above, but calls 'above_latin1(p)' to get the utf8 value. 'above_latin1'
1201 * can be a macro */
1202#define _generic_func_utf8(classnum, above_latin1, p) \
1203 _generic_utf8(classnum, p, above_latin1(p))
1204/* Like the above, but passes classnum to _isFOO_utf8(), instead of having a
1205 * 'above_latin1' parameter */
922e8cb4 1206#define _generic_swash_utf8(classnum, p) \
cd500f2f 1207 _generic_utf8(classnum, p, _is_utf8_FOO(classnum, p))
922e8cb4 1208
cc8ab7c0
KW
1209/* Like the above, but should be used only when it is known that there are no
1210 * characters in the range 128-255 which the class is TRUE for. Hence it can
cd500f2f
KW
1211 * skip the tests for this range. 'above_latin1' should include its arguments */
1212#define _generic_utf8_no_upper_latin1(classnum, p, above_latin1) \
cc8ab7c0
KW
1213 (UTF8_IS_INVARIANT(*(p)) \
1214 ? _generic_isCC(*(p), classnum) \
1215 : (UTF8_IS_ABOVE_LATIN1(*(p))) \
cd500f2f 1216 ? above_latin1 \
cc8ab7c0
KW
1217 : 0)
1218
84238efa
KW
1219/* NOTE that some of these macros have very similar ones in regcharclass.h.
1220 * For example, there is (at the time of this writing) an 'is_SPACE_utf8()'
1221 * there, differing in name only by an underscore from the one here
1222 * 'isSPACE_utf8(). The difference is that the ones here are probably more
1223 * efficient and smaller, using an O(1) array lookup for Latin1-range code
1224 * points; the regcharclass.h ones are implemented as a series of
1225 * "if-else-if-else ..." */
1226
922e8cb4
KW
1227#define isALPHA_utf8(p) _generic_swash_utf8(_CC_ALPHA, p)
1228#define isALPHANUMERIC_utf8(p) _generic_swash_utf8(_CC_ALPHANUMERIC, p)
509fb054
KW
1229#define isASCII_utf8(p) isASCII(*p) /* Because ASCII is invariant under
1230 utf8, the non-utf8 macro works
1231 */
cd500f2f
KW
1232#define isBLANK_utf8(p) _generic_func_utf8(_CC_BLANK, is_HORIZWS_high, p)
1233#define isCNTRL_utf8(p) _generic_utf8(_CC_CNTRL, p, 0)
1234#define isDIGIT_utf8(p) _generic_utf8_no_upper_latin1(_CC_DIGIT, p, \
1235 _is_utf8_FOO(_CC_DIGIT, p))
922e8cb4 1236#define isGRAPH_utf8(p) _generic_swash_utf8(_CC_GRAPH, p)
cd500f2f 1237#define isIDCONT_utf8(p) _generic_func_utf8(_CC_WORDCHAR, is_utf8_xidcont, p)
e5dcd934 1238
c11ff943
KW
1239/* To prevent S_scan_word in toke.c from hanging, we have to make sure that
1240 * IDFIRST is an alnum. See
c8362b00 1241 * http://rt.perl.org/rt3/Ticket/Display.html?id=74022 for more detail than you
f91dcd13
KW
1242 * ever wanted to know about. (In the ASCII range, there isn't a difference.)
1243 * This used to be not the XID version, but we decided to go with the more
1244 * modern Unicode definition */
cd500f2f 1245#define isIDFIRST_utf8(p) _generic_func_utf8(_CC_IDFIRST, \
509fb054 1246 _is_utf8_perl_idstart, p)
e5dcd934 1247
922e8cb4
KW
1248#define isLOWER_utf8(p) _generic_swash_utf8(_CC_LOWER, p)
1249#define isPRINT_utf8(p) _generic_swash_utf8(_CC_PRINT, p)
aea0c08c 1250
509fb054 1251/* Posix and regular space are identical above Latin1 */
cd500f2f 1252#define isPSXSPC_utf8(p) _generic_func_utf8(_CC_PSXSPC, is_XPERLSPACE_high, p)
aea0c08c 1253
922e8cb4 1254#define isPUNCT_utf8(p) _generic_swash_utf8(_CC_PUNCT, p)
cd500f2f 1255#define isSPACE_utf8(p) _generic_func_utf8(_CC_SPACE, is_XPERLSPACE_high, p)
922e8cb4 1256#define isUPPER_utf8(p) _generic_swash_utf8(_CC_UPPER, p)
cd500f2f 1257#define isVERTWS_utf8(p) _generic_func_utf8(_CC_VERTSPACE, is_VERTWS_high, p)
922e8cb4 1258#define isWORDCHAR_utf8(p) _generic_swash_utf8(_CC_WORDCHAR, p)
cd500f2f
KW
1259#define isXDIGIT_utf8(p) _generic_utf8_no_upper_latin1(_CC_XDIGIT, p, \
1260 is_XDIGIT_high(p))
a0ed51b3 1261
509fb054
KW
1262#define toLOWER_utf8(p,s,l) to_utf8_lower(p,s,l)
1263#define toTITLE_utf8(p,s,l) to_utf8_title(p,s,l)
1264#define toUPPER_utf8(p,s,l) to_utf8_upper(p,s,l)
2e8adce6 1265
9201a572
KW
1266/* For internal core Perl use only. If the input is in the Latin1 range, use
1267 * the macro 'macro' on 'p' which is a pointer to a UTF-8 string. Otherwise
1268 * use the value given by the 'utf8' parameter. This relies on the fact that
1269 * ASCII characters have the same representation whether utf8 or not. Note
1270 * that it assumes that the utf8 has been validated, and ignores 'use bytes' */
cd500f2f 1271#define _generic_LC_utf8(macro, p, utf8) \
9201a572
KW
1272 (UTF8_IS_INVARIANT(*(p)) \
1273 ? macro(*(p)) \
1274 : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
1275 ? macro(TWO_BYTE_UTF8_TO_UNI(*(p), *((p)+1))) \
1276 : utf8)
1277
cd500f2f
KW
1278#define _generic_LC_swash_utf8(macro, classnum, p) \
1279 _generic_LC_utf8(macro, p, _is_utf8_FOO(classnum, p))
1280#define _generic_LC_func_utf8(macro, above_latin1, p) \
1281 _generic_LC_utf8(macro, p, above_latin1(p))
9201a572 1282
cd500f2f
KW
1283#define isALPHANUMERIC_LC_utf8(p) _generic_LC_swash_utf8(isALPHANUMERIC_LC, \
1284 _CC_ALPHANUMERIC, p)
1285#define isALPHA_LC_utf8(p) _generic_LC_swash_utf8(isALPHA_LC, _CC_ALPHA, p)
509fb054 1286#define isASCII_LC_utf8(p) isASCII_LC(*p)
cd500f2f
KW
1287#define isBLANK_LC_utf8(p) _generic_LC_func_utf8(isBLANK_LC, is_HORIZWS_high, p)
1288#define isCNTRL_LC_utf8(p) _generic_LC_utf8(isCNTRL_LC, p, 0)
1289#define isDIGIT_LC_utf8(p) _generic_LC_swash_utf8(isDIGIT_LC, _CC_DIGIT, p)
1290#define isGRAPH_LC_utf8(p) _generic_LC_swash_utf8(isGRAPH_LC, _CC_GRAPH, p)
1291#define isIDFIRST_LC_utf8(p) _generic_LC_func_utf8(isIDFIRST_LC, _is_utf8_perl_idstart, p)
1292#define isLOWER_LC_utf8(p) _generic_LC_swash_utf8(isLOWER_LC, _CC_LOWER, p)
1293#define isPRINT_LC_utf8(p) _generic_LC_swash_utf8(isPRINT_LC, _CC_PRINT, p)
509fb054
KW
1294#define isPSXSPC_LC_utf8(p) isSPACE_LC_utf8(p) /* space is identical to posix
1295 space under locale */
cd500f2f
KW
1296#define isPUNCT_LC_utf8(p) _generic_LC_swash_utf8(isPUNCT_LC, _CC_PUNCT, p)
1297#define isSPACE_LC_utf8(p) _generic_LC_func_utf8(isSPACE_LC, is_XPERLSPACE_high, p)
1298#define isUPPER_LC_utf8(p) _generic_LC_swash_utf8(isUPPER_LC, _CC_UPPER, p)
1299#define isWORDCHAR_LC_utf8(p) _generic_LC_swash_utf8(isWORDCHAR_LC, \
1300 _CC_WORDCHAR, p)
1301#define isXDIGIT_LC_utf8(p) _generic_LC_func_utf8(isXDIGIT_LC, is_XDIGIT_high, p)
aaa51d5e 1302
fbc19f27
KW
1303/* Macros for backwards compatibility and for completeness when the ASCII and
1304 * Latin1 values are identical */
fbc19f27
KW
1305#define isALPHAU(c) isALPHA_L1(c)
1306#define isDIGIT_L1(c) isDIGIT_A(c)
1307#define isOCTAL(c) isOCTAL_A(c)
1308#define isOCTAL_L1(c) isOCTAL_A(c)
1309#define isXDIGIT_L1(c) isXDIGIT_A(c)
2e28f0b9
KW
1310#define isALNUM(c) isWORDCHAR(c)
1311#define isALNUMU(c) isWORDCHAR_L1(c)
1312#define isALNUM_LC(c) isWORDCHAR_LC(c)
1313#define isALNUM_uni(c) isWORDCHAR_uni(c)
1314#define isALNUM_LC_uvchr(c) isWORDCHAR_LC_uvchr(c)
1315#define isALNUM_utf8(p) isWORDCHAR_utf8(p)
1316#define isALNUM_LC_utf8(p) isWORDCHAR_LC_utf8(p)
15861f94
KW
1317#define isALNUMC_A(c) isALPHANUMERIC_A(c) /* Mnemonic: "C's alnum" */
1318#define isALNUMC_L1(c) isALPHANUMERIC_L1(c)
1319#define isALNUMC(c) isALPHANUMERIC(c)
1320#define isALNUMC_LC(c) isALPHANUMERIC_LC(c)
1321#define isALNUMC_uni(c) isALPHANUMERIC_uni(c)
1322#define isALNUMC_LC_uvchr(c) isALPHANUMERIC_LC_uvchr(c)
1323#define isALNUMC_utf8(p) isALPHANUMERIC_utf8(p)
1324#define isALNUMC_LC_utf8(p) isALPHANUMERIC_LC_utf8(p)
fbc19f27 1325
6ae9f32a 1326/* This conversion works both ways, strangely enough. On EBCDIC platforms,
e5dcd934
KW
1327 * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII, except that they don't
1328 * necessarily mean the same characters, e.g. CTRL-D is 4 on both systems, but
1329 * that is EOT on ASCII; ST on EBCDIC */
6ae9f32a 1330# define toCTRL(c) (toUPPER(NATIVE_TO_UNI(c)) ^ 64)
bbce6d69 1331
dea28490
JJ
1332/* Line numbers are unsigned, 32 bits. */
1333typedef U32 line_t;
e5dcd934 1334#define NOLINE ((line_t) 4294967295UL) /* = FFFFFFFF */
378cc40b 1335
91152fc1
DG
1336/* Helpful alias for version prescan */
1337#define is_LAX_VERSION(a,b) \
1338 (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
1339
1340#define is_STRICT_VERSION(a,b) \
1341 (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
1342
1343#define BADVERSION(a,b,c) \
1344 if (b) { \
1345 *b = c; \
1346 } \
1347 return a;
8c52afec 1348
95a59cab
YO
1349#define READ_XDIGIT(s) (isALPHA(*(s)) ? ((*(s)++ + 9) & 0xf) : (*(s)++ & 0xf))
1350
8e84507e 1351/*
ccfc67b7
JH
1352=head1 Memory Management
1353
a02a5408 1354=for apidoc Am|void|Newx|void* ptr|int nitems|type
954c1994
GS
1355The XSUB-writer's interface to the C C<malloc> function.
1356
c5008215
JC
1357In 5.9.3, Newx() and friends replace the older New() API, and drops
1358the first parameter, I<x>, a debug aid which allowed callers to identify
37b8b4c9 1359themselves. This aid has been superseded by a new build option,
d10b4965 1360PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>). The older API is still
c5008215
JC
1361there for use in XS modules supporting older perls.
1362
a02a5408 1363=for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
954c1994 1364The XSUB-writer's interface to the C C<malloc> function, with
c5008215 1365cast. See also C<Newx>.
954c1994 1366
a02a5408 1367=for apidoc Am|void|Newxz|void* ptr|int nitems|type
954c1994 1368The XSUB-writer's interface to the C C<malloc> function. The allocated
c5008215 1369memory is zeroed with C<memzero>. See also C<Newx>.
a02a5408 1370
954c1994
GS
1371=for apidoc Am|void|Renew|void* ptr|int nitems|type
1372The XSUB-writer's interface to the C C<realloc> function.
1373
1374=for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
1375The XSUB-writer's interface to the C C<realloc> function, with
1376cast.
1377
49b8b560 1378=for apidoc Am|void|Safefree|void* ptr
954c1994
GS
1379The XSUB-writer's interface to the C C<free> function.
1380
1381=for apidoc Am|void|Move|void* src|void* dest|int nitems|type
1382The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
926bb54c
KW
1383source, C<dest> is the destination, C<nitems> is the number of items, and
1384C<type> is the type. Can do overlapping moves. See also C<Copy>.
954c1994 1385
e90e2364
NC
1386=for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
1387Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1388optimise.
1389
954c1994
GS
1390=for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
1391The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
926bb54c
KW
1392source, C<dest> is the destination, C<nitems> is the number of items, and
1393C<type> is the type. May fail on overlapping copies. See also C<Move>.
954c1994 1394
e90e2364
NC
1395=for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
1396
1397Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1398optimise.
1399
954c1994
GS
1400=for apidoc Am|void|Zero|void* dest|int nitems|type
1401
1402The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1403destination, C<nitems> is the number of items, and C<type> is the type.
1404
e90e2364
NC
1405=for apidoc Am|void *|ZeroD|void* dest|int nitems|type
1406
1407Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1408optimise.
1409
da5d8dbb 1410=for apidoc Am|void|StructCopy|type *src|type *dest|type
4375e838 1411This is an architecture-independent macro to copy one structure to another.
954c1994 1412
7e337ee0
JH
1413=for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
1414
1415Fill up memory with a byte pattern (a byte repeated over and over
1416again) that hopefully catches attempts to access uninitialized memory.
1417
1418=for apidoc Am|void|PoisonNew|void* dest|int nitems|type
1419
1420PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
1421
1c12ffb4 1422=for apidoc Am|void|PoisonFree|void* dest|int nitems|type
7e337ee0
JH
1423
1424PoisonWith(0xEF) for catching access to freed memory.
1425
9965345d
JH
1426=for apidoc Am|void|Poison|void* dest|int nitems|type
1427
7e337ee0 1428PoisonWith(0xEF) for catching access to freed memory.
9965345d
JH
1429
1430=cut */
954c1994 1431
561b68a9
SH
1432/* Maintained for backwards-compatibility only. Use newSV() instead. */
1433#ifndef PERL_CORE
ff06c60c 1434#define NEWSV(x,len) newSV(len)
561b68a9 1435#endif
ff06c60c 1436
19a94d75
JH
1437#define MEM_SIZE_MAX ((MEM_SIZE)~0)
1438
2720f793
JH
1439/* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
1440 * overly eager compilers that will bleat about e.g.
1441 * (U16)n > (size_t)~0/sizeof(U16) always being false. */
27d5b266 1442#ifdef PERL_MALLOC_WRAP
f019c49e
DD
1443#define MEM_WRAP_CHECK(n,t) \
1444 (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (croak_memory_wrap(),0))
27d5b266 1445#define MEM_WRAP_CHECK_1(n,t,a) \
f1f66076 1446 (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
8b44ba4c 1447#define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
27d5b266 1448
f019c49e 1449#define PERL_STRLEN_ROUNDUP(n) ((void)(((n) > MEM_SIZE_MAX - 2 * PERL_STRLEN_ROUNDUP_QUANTUM) ? (croak_memory_wrap(),0):0),((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
27d5b266
JH
1450#else
1451
410319be
NC
1452#define MEM_WRAP_CHECK(n,t)
1453#define MEM_WRAP_CHECK_1(n,t,a)
1454#define MEM_WRAP_CHECK_2(n,t,a,b)
8b44ba4c
NC
1455#define MEM_WRAP_CHECK_(n,t)
1456
6fff79ce 1457#define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
27d5b266 1458
1936d2a7 1459#endif
8b44ba4c 1460
fe4f188c 1461#ifdef PERL_MEM_LOG
46c6c7e2 1462/*
9f653bb5 1463 * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
46c6c7e2
JH
1464 * go through functions, which are handy for debugging breakpoints, but
1465 * which more importantly get the immediate calling environment (file and
e352bcff
JH
1466 * line number, and C function name if available) passed in. This info can
1467 * then be used for logging the calls, for which one gets a sample
73d1d973 1468 * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
3609ea0d 1469 *
46c6c7e2 1470 * Known problems:
94e892a6 1471 * - not all memory allocs get logged, only those
46c6c7e2 1472 * that go through Newx() and derivatives (while all
94e892a6 1473 * Safefrees do get logged)
46c6c7e2
JH
1474 * - __FILE__ and __LINE__ do not work everywhere
1475 * - __func__ or __FUNCTION__ even less so
1476 * - I think more goes on after the perlio frees but
1477 * the thing is that STDERR gets closed (as do all
1478 * the file descriptors)
1479 * - no deeper calling stack than the caller of the Newx()
1480 * or the kind, but do I look like a C reflection/introspection
1481 * utility to you?
1482 * - the function prototypes for the logging functions
1483 * probably should maybe be somewhere else than handy.h
1484 * - one could consider inlining (macrofying) the logging
1485 * for speed, but I am too lazy
1486 * - one could imagine recording the allocations in a hash,
1487 * (keyed by the allocation address?), and maintain that
1488 * through reallocs and frees, but how to do that without
1489 * any News() happening...?
73d1d973 1490 * - lots of -Ddefines to get useful/controllable output
b953482e 1491 * - lots of ENV reads
46c6c7e2
JH
1492 */
1493
12754f92 1494PERL_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 1495
12754f92 1496PERL_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 1497
12754f92 1498PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
46c6c7e2 1499
0b0ab801 1500# ifdef PERL_CORE
73d1d973 1501# ifndef PERL_MEM_LOG_NOIMPL
0b0ab801
MHM
1502enum mem_log_type {
1503 MLT_ALLOC,
1504 MLT_REALLOC,
d7a2c63c
MHM
1505 MLT_FREE,
1506 MLT_NEW_SV,
1507 MLT_DEL_SV
0b0ab801
MHM
1508};
1509# endif
12754f92 1510# if defined(PERL_IN_SV_C) /* those are only used in sv.c */
d7a2c63c
MHM
1511void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1512void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
12754f92 1513# endif
0b0ab801
MHM
1514# endif
1515
fe4f188c
JH
1516#endif
1517
1518#ifdef PERL_MEM_LOG
d1401ee9
MHM
1519#define MEM_LOG_ALLOC(n,t,a) Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
1520#define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
46c6c7e2 1521#define MEM_LOG_FREE(a) Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
fe4f188c
JH
1522#endif
1523
1524#ifndef MEM_LOG_ALLOC
1525#define MEM_LOG_ALLOC(n,t,a) (a)
1526#endif
1527#ifndef MEM_LOG_REALLOC
1528#define MEM_LOG_REALLOC(n,t,v,a) (a)
1529#endif
1530#ifndef MEM_LOG_FREE
1531#define MEM_LOG_FREE(a) (a)
1532#endif
1533
d1401ee9
MHM
1534#define Newx(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1535#define Newxc(v,n,t,c) (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1536#define Newxz(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
a6f6820f
NC
1537
1538#ifndef PERL_CORE
a02a5408
JC
1539/* pre 5.9.x compatibility */
1540#define New(x,v,n,t) Newx(v,n,t)
1541#define Newc(x,v,n,t,c) Newxc(v,n,t,c)
4541904d 1542#define Newz(x,v,n,t) Newxz(v,n,t)
a6f6820f 1543#endif
a02a5408 1544
ff68c719 1545#define Renew(v,n,t) \
d1401ee9 1546 (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
ff68c719 1547#define Renewc(v,n,t,c) \
d1401ee9 1548 (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
94010e71
NC
1549
1550#ifdef PERL_POISON
1551#define Safefree(d) \
06c0cc96 1552 ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
94010e71 1553#else
fe4f188c 1554#define Safefree(d) safefree(MEM_LOG_FREE((Malloc_t)(d)))
94010e71 1555#endif
55497cff 1556
8b44ba4c
NC
1557#define Move(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1558#define Copy(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1559#define Zero(d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
55497cff 1560
8b44ba4c
NC
1561#define MoveD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1562#define CopyD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
e90e2364 1563#ifdef HAS_MEMSET
8b44ba4c 1564#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
e90e2364 1565#else
8b44ba4c
NC
1566/* Using bzero(), which returns void. */
1567#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
e90e2364
NC
1568#endif
1569
7e337ee0
JH
1570#define PoisonWith(d,n,t,b) (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
1571#define PoisonNew(d,n,t) PoisonWith(d,n,t,0xAB)
1572#define PoisonFree(d,n,t) PoisonWith(d,n,t,0xEF)
1573#define Poison(d,n,t) PoisonFree(d,n,t)
27d5b266 1574
2304df62 1575#ifdef USE_STRUCT_COPY
ff68c719 1576#define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
bee1dbe2
LW
1577#else
1578#define StructCopy(s,d,t) Copy(s,d,1,t)
1579#endif
2cc61e15 1580
622913ab 1581#define C_ARRAY_LENGTH(a) (sizeof(a)/sizeof((a)[0]))
cd431fde 1582#define C_ARRAY_END(a) (a) + (sizeof(a)/sizeof((a)[0]))
622913ab 1583
2cc61e15
DD
1584#ifdef NEED_VA_COPY
1585# ifdef va_copy
1586# define Perl_va_copy(s, d) va_copy(d, s)
2cc61e15 1587# else
a1866d1b
JH
1588# if defined(__va_copy)
1589# define Perl_va_copy(s, d) __va_copy(d, s)
1590# else
1591# define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
1592# endif
2cc61e15
DD
1593# endif
1594#endif
1595
472d47bc
SB
1596/* convenience debug macros */
1597#ifdef USE_ITHREADS
1598#define pTHX_FORMAT "Perl interpreter: 0x%p"
1599#define pTHX__FORMAT ", Perl interpreter: 0x%p"
f54cb97a
AL
1600#define pTHX_VALUE_ (void *)my_perl,
1601#define pTHX_VALUE (void *)my_perl
1602#define pTHX__VALUE_ ,(void *)my_perl,
1603#define pTHX__VALUE ,(void *)my_perl
472d47bc 1604#else
3609ea0d 1605#define pTHX_FORMAT
472d47bc 1606#define pTHX__FORMAT
3609ea0d 1607#define pTHX_VALUE_
472d47bc 1608#define pTHX_VALUE
3609ea0d 1609#define pTHX__VALUE_
472d47bc
SB
1610#define pTHX__VALUE
1611#endif /* USE_ITHREADS */
3609ea0d 1612
2acdbac1
NC
1613/* Perl_deprecate was not part of the public API, and did not have a deprecate()
1614 shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
1615 CPAN::Unpack show any users outside the core. */
1616#ifdef PERL_CORE
d1d15184 1617# define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
2acdbac1
NC
1618#endif
1619
9d745869
KW
1620#endif /* HANDY_H */
1621
e9a8c099
MHM
1622/*
1623 * Local variables:
1624 * c-indentation-style: bsd
1625 * c-basic-offset: 4
14d04a33 1626 * indent-tabs-mode: nil
e9a8c099
MHM
1627 * End:
1628 *
14d04a33 1629 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 1630 */