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