This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Note for Devel::PPPort HvNAME_get, HvNAMELEN_get
[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
4650c663
KW
11/* IMPORTANT NOTE: Everything whose name begins with an underscore is for
12 * internal core Perl use only. */
13
6a5bc5ac
KW
14#ifndef PERL_HANDY_H_ /* Guard against nested #inclusion */
15#define PERL_HANDY_H_
9d745869 16
24792b8d
NC
17#ifndef PERL_CORE
18# define Null(type) ((type)NULL)
954c1994
GS
19
20/*
51b56f5c 21=for apidoc_section String Handling
78342678 22=for apidoc AmnU||Nullch
72d33970
FC
23Null character pointer. (No longer available when C<PERL_CORE> is
24defined.)
2307c6d0 25
51b56f5c 26=for apidoc_section SV Handling
78342678 27=for apidoc AmnU||Nullsv
72d33970 28Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
954c1994
GS
29
30=cut
51b56f5c
KW
31
32Below are signatures of functions from config.h which can't easily be gleaned
33from it, and are very unlikely to change
34
35=for apidoc_section Signals
36=for apidoc Am|int|Sigsetjmp|jmp_buf env|int savesigs
37=for apidoc Am|void|Siglongjmp|jmp_buf env|int val
38
39=for apidoc_section Filesystem configuration values
40=for apidoc Am|void *|FILE_ptr|FILE * f
41=for apidoc Am|Size_t|FILE_cnt|FILE * f
42=for apidoc Am|void *|FILE_base|FILE * f
43=for apidoc Am|Size_t|FILE_bufsiz
44
45=for apidoc_section String Handling
46=for apidoc Am|token|CAT2|token x|token y
47=for apidoc Am|string|STRINGIFY|token x
48
49=for apidoc_section Numeric Functions
50=for apidoc Am|double|Drand01|double x
51=for apidoc Am|void|seedDrand01|Rand_seed_t x
52=for apidoc Am|char *|Gconvert|double x|Size_t n|bool t|char * b
53
54=cut
954c1994
GS
55*/
56
24792b8d
NC
57# define Nullch Null(char*)
58# define Nullfp Null(PerlIO*)
59# define Nullsv Null(SV*)
60#endif
8d063cd8 61
641d3f0b
PP
62#ifdef TRUE
63#undef TRUE
64#endif
65#ifdef FALSE
66#undef FALSE
67#endif
68#define TRUE (1)
69#define FALSE (0)
70
cf3f0ffb
DM
71/* The MUTABLE_*() macros cast pointers to the types shown, in such a way
72 * (compiler permitting) that casting away const-ness will give a warning;
73 * e.g.:
74 *
75 * const SV *sv = ...;
76 * AV *av1 = (AV*)sv; <== BAD: the const has been silently cast away
77 * AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
78 */
79
b1bc3f34 80#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
6c2255e0 81# define MUTABLE_PTR(p) ({ void *p_ = (p); p_; })
b1bc3f34
NC
82#else
83# define MUTABLE_PTR(p) ((void *) (p))
84#endif
85
a062e10d 86#define MUTABLE_AV(p) ((AV *)MUTABLE_PTR(p))
ea726b52 87#define MUTABLE_CV(p) ((CV *)MUTABLE_PTR(p))
159b6efe 88#define MUTABLE_GV(p) ((GV *)MUTABLE_PTR(p))
dbebbdb4 89#define MUTABLE_HV(p) ((HV *)MUTABLE_PTR(p))
a45c7426 90#define MUTABLE_IO(p) ((IO *)MUTABLE_PTR(p))
b1bc3f34 91#define MUTABLE_SV(p) ((SV *)MUTABLE_PTR(p))
27d4fb96 92
f789f6a4 93#if defined(I_STDBOOL) && !defined(PERL_BOOL_AS_CHAR)
bd31be4b
NC
94# include <stdbool.h>
95# ifndef HAS_BOOL
96# define HAS_BOOL 1
97# endif
98#endif
99
8e84507e 100/* bool is built-in for g++-2.6.3 and later, which might be used
c1d22f6b
GS
101 for extensions. <_G_config.h> defines _G_HAVE_BOOL, but we can't
102 be sure _G_config.h will be included before this file. _G_config.h
8e84507e 103 also defines _G_HAVE_BOOL for both gcc and g++, but only g++
c1d22f6b
GS
104 actually has bool. Hence, _G_HAVE_BOOL is pretty useless for us.
105 g++ can be identified by __GNUG__.
106 Andy Dougherty February 2000
5d94fbed 107*/
3609ea0d 108#ifdef __GNUG__ /* GNU g++ has bool built-in */
f789f6a4 109# ifndef PERL_BOOL_AS_CHAR
5d94fbed 110# ifndef HAS_BOOL
c1d22f6b 111# define HAS_BOOL 1
5d94fbed 112# endif
f789f6a4 113# endif
5d94fbed
AD
114#endif
115
116#ifndef HAS_BOOL
f789f6a4
FC
117# ifdef bool
118# undef bool
119# endif
70d5cb32 120# define bool char
c1d22f6b 121# define HAS_BOOL 1
a687059c 122#endif
0d3e774c 123
25ba28ce 124/*
51b56f5c 125=for apidoc_section Casting
25ba28ce
KW
126=for apidoc Am|bool|cBOOL|bool expr
127
128Cast-to-bool. A simple S<C<(bool) I<expr>>> cast may not do the right thing:
129if C<bool> is defined as C<char>, for example, then the cast from C<int> is
130implementation-defined.
131
132C<(bool)!!(cbool)> in a ternary triggers a bug in xlc on AIX
133
134=cut
135*/
18f5643b 136#define cBOOL(cbool) ((cbool) ? (bool)1 : (bool)0)
f2338a2e 137
46c6c7e2 138/* Try to figure out __func__ or __FUNCTION__ equivalent, if any.
e352bcff
JH
139 * XXX Should really be a Configure probe, with HAS__FUNCTION__
140 * and FUNCTION__ as results.
141 * XXX Similarly, a Configure probe for __FILE__ and __LINE__ is needed. */
46c6c7e2
JH
142#if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || (defined(__SUNPRO_C)) /* C99 or close enough. */
143# define FUNCTION__ __func__
7adf2470 144#elif (defined(__DECC_VER)) /* Tru64 or VMS, and strict C89 being used, but not modern enough cc (in Tur64, -c99 not known, only -std1). */
07798b17 145# define FUNCTION__ ""
46c6c7e2 146#else
07798b17 147# define FUNCTION__ __FUNCTION__ /* Common extension. */
46c6c7e2
JH
148#endif
149
27d4fb96
PP
150/* XXX A note on the perl source internal type system. The
151 original intent was that I32 be *exactly* 32 bits.
152
153 Currently, we only guarantee that I32 is *at least* 32 bits.
154 Specifically, if int is 64 bits, then so is I32. (This is the case
155 for the Cray.) This has the advantage of meshing nicely with
156 standard library calls (where we pass an I32 and the library is
157 expecting an int), but the disadvantage that an I32 is not 32 bits.
158 Andy Dougherty August 1996
24fef2a7 159
dc45a647
MB
160 There is no guarantee that there is *any* integral type with
161 exactly 32 bits. It is perfectly legal for a system to have
162 sizeof(short) == sizeof(int) == sizeof(long) == 8.
693762b4 163
dc45a647
MB
164 Similarly, there is no guarantee that I16 and U16 have exactly 16
165 bits.
693762b4 166
8e84507e
NIS
167 For dealing with issues that may arise from various 32/64-bit
168 systems, we will ask Configure to check out
8175356b 169
3609ea0d
JH
170 SHORTSIZE == sizeof(short)
171 INTSIZE == sizeof(int)
172 LONGSIZE == sizeof(long)
dc45a647 173 LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
3609ea0d 174 PTRSIZE == sizeof(void *)
dc45a647
MB
175 DOUBLESIZE == sizeof(double)
176 LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
8175356b 177
27d4fb96
PP
178*/
179
69512466
JH
180#ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
181# include <inttypes.h>
dd0eed91
JH
182# ifdef INT32_MIN_BROKEN
183# undef INT32_MIN
184# define INT32_MIN (-2147483647-1)
185# endif
186# ifdef INT64_MIN_BROKEN
187# undef INT64_MIN
188# define INT64_MIN (-9223372036854775807LL-1)
189# endif
69512466
JH
190#endif
191
8175356b
JH
192typedef I8TYPE I8;
193typedef U8TYPE U8;
194typedef I16TYPE I16;
195typedef U16TYPE U16;
196typedef I32TYPE I32;
197typedef U32TYPE U32;
16d89be8 198
74b807c7 199#ifdef QUADKIND
8175356b
JH
200typedef I64TYPE I64;
201typedef U64TYPE U64;
16d89be8 202#endif
8175356b 203
d8668976 204#if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
5ff3f7a4 205
5ff3f7a4
GS
206/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
207 Please search CHAR_MAX in perl.h for further details. */
208#define U8_MAX UINT8_MAX
209#define U8_MIN UINT8_MIN
210
5ff3f7a4
GS
211#define I16_MAX INT16_MAX
212#define I16_MIN INT16_MIN
213#define U16_MAX UINT16_MAX
214#define U16_MIN UINT16_MIN
215
5ff3f7a4
GS
216#define I32_MAX INT32_MAX
217#define I32_MIN INT32_MIN
0e983133
GS
218#ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
219# define U32_MAX UINT32_MAX
220#else
221# define U32_MAX 4294967295U
222#endif
5ff3f7a4
GS
223#define U32_MIN UINT32_MIN
224
225#else
226
5c9fa16e
KA
227/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
228 Please search CHAR_MAX in perl.h for further details. */
27d4fb96
PP
229#define U8_MAX PERL_UCHAR_MAX
230#define U8_MIN PERL_UCHAR_MIN
79072805 231
27d4fb96
PP
232#define I16_MAX PERL_SHORT_MAX
233#define I16_MIN PERL_SHORT_MIN
234#define U16_MAX PERL_USHORT_MAX
235#define U16_MIN PERL_USHORT_MIN
79072805 236
c4f23d77 237#if LONGSIZE > 4
27d4fb96
PP
238# define I32_MAX PERL_INT_MAX
239# define I32_MIN PERL_INT_MIN
240# define U32_MAX PERL_UINT_MAX
241# define U32_MIN PERL_UINT_MIN
79072805 242#else
27d4fb96
PP
243# define I32_MAX PERL_LONG_MAX
244# define I32_MIN PERL_LONG_MIN
245# define U32_MAX PERL_ULONG_MAX
246# define U32_MIN PERL_ULONG_MIN
79072805
LW
247#endif
248
5ff3f7a4
GS
249#endif
250
247cee9f
KW
251/* These C99 typedefs are useful sometimes for, say, loop variables whose
252 * maximum values are small, but for which speed trumps size. If we have a C99
253 * compiler, use that. Otherwise, a plain 'int' should be good enough.
254 *
255 * Restrict these to core for now until we are more certain this is a good
256 * idea. */
257#if defined(PERL_CORE) || defined(PERL_EXT)
258# ifdef I_STDINT
259 typedef int_fast8_t PERL_INT_FAST8_T;
260 typedef uint_fast8_t PERL_UINT_FAST8_T;
261 typedef int_fast16_t PERL_INT_FAST16_T;
262 typedef uint_fast16_t PERL_UINT_FAST16_T;
263# else
264 typedef int PERL_INT_FAST8_T;
265 typedef unsigned int PERL_UINT_FAST8_T;
266 typedef int PERL_INT_FAST16_T;
267 typedef unsigned int PERL_UINT_FAST16_T;
268# endif
269#endif
270
464decb6 271/* log(2) (i.e., log base 10 of 2) is pretty close to 0.30103, just in case
ab350cbd
KW
272 * anyone is grepping for it. So BIT_DIGITS gives the number of decimal digits
273 * required to represent any possible unsigned number containing N bits.
274 * TYPE_DIGITS gives the number of decimal digits required to represent any
275 * possible unsigned number of type T. */
464decb6 276#define BIT_DIGITS(N) (((N)*146)/485 + 1) /* log10(2) =~ 146/485 */
fc36a67e
PP
277#define TYPE_DIGITS(T) BIT_DIGITS(sizeof(T) * 8)
278#define TYPE_CHARS(T) (TYPE_DIGITS(T) + 2) /* sign, NUL */
279
88794300 280/* Unused by core; should be deprecated */
ff68c719 281#define Ctl(ch) ((ch) & 037)
8d063cd8 282
98fce2a4
KW
283#if defined(PERL_CORE) || defined(PERL_EXT)
284# ifndef MIN
285# define MIN(a,b) ((a) < (b) ? (a) : (b))
286# endif
287# ifndef MAX
288# define MAX(a,b) ((a) > (b) ? (a) : (b))
289# endif
290#endif
291
84ff4fa9
KW
292/* Returns a boolean as to whether the input unsigned number is a power of 2
293 * (2**0, 2**1, etc). In other words if it has just a single bit set.
294 * If not, subtracting 1 would leave the uppermost bit set, so the & would
295 * yield non-zero */
296#if defined(PERL_CORE) || defined(PERL_EXT)
011b1419 297# define isPOWER_OF_2(n) ((n) && ((n) & ((n)-1)) == 0)
84ff4fa9
KW
298#endif
299
d223e1ea 300/* Returns a mask with the lowest n bits set */
fae1e72b 301#define nBIT_MASK(n) ((UINTMAX_C(1) << (n)) - 1)
d223e1ea 302
1381ccb1
KW
303/* The largest unsigned number that will fit into n bits */
304#define nBIT_UMAX(n) nBIT_MASK(n)
305
8d9433eb 306/*
51b56f5c 307=for apidoc_section Compiler directives
8d9433eb
KW
308=for apidoc Am|void|__ASSERT_|bool expr
309
310This is a helper macro to avoid preprocessor issues, replaced by nothing
311unless under DEBUGGING, where it expands to an assert of its argument,
312followed by a comma (hence the comma operator). If we just used a straight
313assert(), we would get a comma with nothing before it when not DEBUGGING.
314
315=cut
316
317We also use empty definition under Coverity since the __ASSERT__
318checks often check for things that Really Cannot Happen, and Coverity
319detects that and gets all excited. */
3e94db23 320
e7ae132e
KW
321#if defined(DEBUGGING) && !defined(__COVERITY__) \
322 && ! defined(PERL_SMALL_MACRO_BUFFER)
0f092d08
KW
323# define __ASSERT_(statement) assert(statement),
324#else
325# define __ASSERT_(statement)
326#endif
327
3fe05580 328/*
51b56f5c 329=for apidoc_section SV Handling
3fe05580 330
3bb9fd01 331=for apidoc Ama|SV*|newSVpvs|"literal string"
1568d13a 332Like C<newSVpvn>, but takes a literal string instead of a
30a15352 333string/length pair.
3fe05580 334
3bb9fd01 335=for apidoc Ama|SV*|newSVpvs_flags|"literal string"|U32 flags
1568d13a 336Like C<newSVpvn_flags>, but takes a literal string instead of
30a15352 337a string/length pair.
84bafc02 338
3bb9fd01 339=for apidoc Ama|SV*|newSVpvs_share|"literal string"
1568d13a 340Like C<newSVpvn_share>, but takes a literal string instead of
30a15352 341a string/length pair and omits the hash parameter.
3fe05580 342
3bb9fd01 343=for apidoc Am|void|sv_catpvs_flags|SV* sv|"literal string"|I32 flags
1568d13a 344Like C<sv_catpvn_flags>, but takes a literal string instead
30a15352 345of a string/length pair.
9dcc53ea 346
3bb9fd01 347=for apidoc Am|void|sv_catpvs_nomg|SV* sv|"literal string"
1568d13a 348Like C<sv_catpvn_nomg>, but takes a literal string instead of
0c395ea5 349a string/length pair.
9dcc53ea 350
3bb9fd01 351=for apidoc Am|void|sv_catpvs|SV* sv|"literal string"
1568d13a 352Like C<sv_catpvn>, but takes a literal string instead of a
0c395ea5 353string/length pair.
3fe05580 354
3bb9fd01 355=for apidoc Am|void|sv_catpvs_mg|SV* sv|"literal string"
1568d13a 356Like C<sv_catpvn_mg>, but takes a literal string instead of a
9dcc53ea
Z
357string/length pair.
358
3bb9fd01 359=for apidoc Am|void|sv_setpvs|SV* sv|"literal string"
1568d13a 360Like C<sv_setpvn>, but takes a literal string instead of a
0c395ea5 361string/length pair.
3fe05580 362
3bb9fd01 363=for apidoc Am|void|sv_setpvs_mg|SV* sv|"literal string"
1568d13a 364Like C<sv_setpvn_mg>, but takes a literal string instead of a
9dcc53ea
Z
365string/length pair.
366
3bb9fd01 367=for apidoc Am|SV *|sv_setref_pvs|SV *const rv|const char *const classname|"literal string"
1568d13a 368Like C<sv_setref_pvn>, but takes a literal string instead of
0c395ea5 369a string/length pair.
9dcc53ea 370
51b56f5c 371=for apidoc_section String Handling
3fe05580 372
3bb9fd01 373=for apidoc Ama|char*|savepvs|"literal string"
1568d13a 374Like C<savepvn>, but takes a literal string instead of a
30a15352 375string/length pair.
3fe05580 376
3bb9fd01 377=for apidoc Ama|char*|savesharedpvs|"literal string"
9dcc53ea
Z
378A version of C<savepvs()> which allocates the duplicate string in memory
379which is shared between threads.
380
51b56f5c 381=for apidoc_section GV Handling
3fe05580 382
3bb9fd01 383=for apidoc Am|HV*|gv_stashpvs|"name"|I32 create
1568d13a 384Like C<gv_stashpvn>, but takes a literal string instead of a
0c395ea5 385string/length pair.
3fe05580 386
51b56f5c 387=for apidoc_section HV Handling
3fe05580 388
3bb9fd01 389=for apidoc Am|SV**|hv_fetchs|HV* tb|"key"|I32 lval
1568d13a 390Like C<hv_fetch>, but takes a literal string instead of a
0c395ea5 391string/length pair.
3fe05580 392
3bb9fd01 393=for apidoc Am|SV**|hv_stores|HV* tb|"key"|SV* val
1568d13a 394Like C<hv_store>, but takes a literal string instead of a
0c395ea5 395string/length pair
3fe05580
MHM
396and omits the hash parameter.
397
70b05c7c 398=for apidoc_section Lexer interface
510966aa 399
3bb9fd01 400=for apidoc Amx|void|lex_stuff_pvs|"pv"|U32 flags
510966aa 401
1568d13a 402Like L</lex_stuff_pvn>, but takes a literal string instead of
0c395ea5 403a string/length pair.
510966aa 404
3fe05580
MHM
405=cut
406*/
407
a34e53fc 408/*
51b56f5c 409=for apidoc_section String Handling
2efa8cc7 410
a34e53fc
KW
411=for apidoc Amu|pair|STR_WITH_LEN|"literal string"
412
413Returns two comma separated tokens of the input literal string, and its length.
414This is convenience macro which helps out in some API calls.
415Note that it can't be used as an argument to macros or functions that under
416some configurations might be macros, which means that it requires the full
417Perl_xxx(aTHX_ ...) form for any API calls where it's used.
418
419=cut
420*/
421
a34e53fc 422#define STR_WITH_LEN(s) ("" s ""), (sizeof(s)-1)
ba3a79e7
GA
423
424/* STR_WITH_LEN() shortcuts */
425#define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str))
84bafc02
NC
426#define newSVpvs_flags(str,flags) \
427 Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags)
ba3a79e7 428#define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0)
9dcc53ea
Z
429#define sv_catpvs_flags(sv, str, flags) \
430 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), flags)
431#define sv_catpvs_nomg(sv, str) \
432 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), 0)
433#define sv_catpvs(sv, str) \
434 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC)
435#define sv_catpvs_mg(sv, str) \
436 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC|SV_SMAGIC)
3fe05580 437#define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str))
9dcc53ea
Z
438#define sv_setpvs_mg(sv, str) Perl_sv_setpvn_mg(aTHX_ sv, STR_WITH_LEN(str))
439#define sv_setref_pvs(rv, classname, str) \
440 Perl_sv_setref_pvn(aTHX_ rv, classname, STR_WITH_LEN(str))
ba3a79e7 441#define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str))
9dcc53ea
Z
442#define savesharedpvs(str) Perl_savesharedpvn(aTHX_ STR_WITH_LEN(str))
443#define gv_stashpvs(str, create) \
444 Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create)
445#define gv_fetchpvs(namebeg, add, sv_type) \
446 Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type)
447#define gv_fetchpvn(namebeg, len, add, sv_type) \
448 Perl_gv_fetchpvn_flags(aTHX_ namebeg, len, add, sv_type)
449#define sv_catxmlpvs(dsv, str, utf8) \
450 Perl_sv_catxmlpvn(aTHX_ dsv, STR_WITH_LEN(str), utf8)
4ac46235 451
ba3a79e7 452
510966aa
Z
453#define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
454
b96d8cd9
NC
455#define get_cvs(str, flags) \
456 Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
5c1737d1 457
9b6e9510 458/* internal helpers */
4a1bbd3d 459/* Transitional */
d67f622b
N
460#ifndef PERL_VERSION_MAJOR
461# define PERL_VERSION_MAJOR PERL_REVISION
4a1bbd3d
KW
462#else
463# undef PERL_REVISION /* We don't want code to be using these */
464#endif
d67f622b
N
465#ifndef PERL_VERSION_MINOR
466# define PERL_VERSION_MINOR PERL_VERSION
4a1bbd3d
KW
467#else
468# undef PERL_VERSION
469#endif
d67f622b
N
470#ifndef PERL_VERSION_PATCH
471# define PERL_VERSION_PATCH PERL_SUBVERSION
4a1bbd3d
KW
472#else
473# undef PERL_SUBVERSION
474#endif
475
476#define PERL_JNP_TO_DECIMAL_(maJor,miNor,Patch) \
477 /* '10*' leaves room for things like alpha, beta, releases */ \
478 (10 * ((maJor) * 1000000) + ((miNor) * 1000) + (Patch))
9b6e9510 479#define PERL_DECIMAL_VERSION_ \
d67f622b
N
480 PERL_JNP_TO_DECIMAL_(PERL_VERSION_MAJOR, PERL_VERSION_MINOR, \
481 PERL_VERSION_PATCH)
9b6e9510
KW
482
483/*
51b56f5c 484=for apidoc_section Versioning
4a1bbd3d 485=for apidoc AmR|bool|PERL_VERSION_EQ|const U8 major|const U8 minor|const U8 patch
9b6e9510 486
4a1bbd3d 487Returns whether or not the perl currently being compiled has the specified
9b6e9510
KW
488relationship to the perl given by the parameters. For example,
489
490 #if PERL_VERSION_GT(5,24,2)
491 code that will only be compiled on perls after v5.24.2
492 #else
493 fallback code
494 #endif
495
496Note that this is usable in making compile-time decisions
497
498The possible comparisons are C<PERL_VERSION_EQ>, C<PERL_VERSION_NE>,
499C<PERL_VERSION_GE>, C<PERL_VERSION_GT>, C<PERL_VERSION_LE>, and
500C<PERL_VERSION_LT>.
501
4a1bbd3d
KW
502You may use the special value '*' for the final number to mean ALL possible
503values for it. Thus,
504
505 #if PERL_VERSION_EQ(5,31,'*')
506
507means all perls in the 5.31 series. And
508
509 #if PERL_VERSION_NE(5,24,'*')
510
511means all perls EXCEPT 5.24 ones. And
512
513 #if PERL_VERSION_LE(5,9,'*')
514
515is effectively
516
517 #if PERL_VERSION_LT(5,10,0)
518
519This means you don't have to think so much when converting from the existing
520deprecated C<PERL_VERSION> to using this macro:
521
522 #if PERL_VERSION <= 9
523
524becomes
525
526 #if PERL_VERSION_LE(5,9,'*')
527
528=for apidoc AmRh|bool|PERL_VERSION_NE|const U8 major|const U8 minor|const U8 patch
529=for apidoc AmRh|bool|PERL_VERSION_GE|const U8 major|const U8 minor|const U8 patch
530=for apidoc AmRh|bool|PERL_VERSION_GT|const U8 major|const U8 minor|const U8 patch
531=for apidoc AmRh|bool|PERL_VERSION_LE|const U8 major|const U8 minor|const U8 patch
532=for apidoc AmRh|bool|PERL_VERSION_LT|const U8 major|const U8 minor|const U8 patch
9b6e9510
KW
533
534=cut
535*/
536
4a1bbd3d
KW
537/* N.B. These don't work if the patch version is 42 or 92, as those are what
538 * '*' is in ASCII and EBCDIC respectively */
539# define PERL_VERSION_EQ(j,n,p) \
540 (((p) == '*') \
d67f622b
N
541 ? ( (j) == PERL_VERSION_MAJOR \
542 && (n) == PERL_VERSION_MINOR) \
4a1bbd3d
KW
543 : (PERL_DECIMAL_VERSION_ == PERL_JNP_TO_DECIMAL_(j,n,p)))
544# define PERL_VERSION_NE(j,n,p) (! PERL_VERSION_EQ(j,n,p))
545
546# define PERL_VERSION_LT(j,n,p) /* < '*' effectively means < 0 */ \
547 (PERL_DECIMAL_VERSION_ < PERL_JNP_TO_DECIMAL_( (j), \
548 (n), \
549 (((p) == '*') ? 0 : p)))
550# define PERL_VERSION_GE(j,n,p) (! PERL_VERSION_LT(j,n,p))
551
552# define PERL_VERSION_LE(j,n,p) /* <= '*' effectively means < n+1 */ \
553 (PERL_DECIMAL_VERSION_ < PERL_JNP_TO_DECIMAL_( (j), \
554 (((p) == '*') ? ((n)+1) : (n)), \
555 (((p) == '*') ? 0 : p)))
556# define PERL_VERSION_GT(j,n,p) (! PERL_VERSION_LE(j,n,p))
9b6e9510 557
954c1994 558/*
51b56f5c 559=for apidoc_section String Handling
ccfc67b7 560
954c1994 561=for apidoc Am|bool|strNE|char* s1|char* s2
dc6b0978
KW
562Test two C<NUL>-terminated strings to see if they are different. Returns true
563or false.
954c1994
GS
564
565=for apidoc Am|bool|strEQ|char* s1|char* s2
dc6b0978
KW
566Test two C<NUL>-terminated strings to see if they are equal. Returns true or
567false.
954c1994
GS
568
569=for apidoc Am|bool|strLT|char* s1|char* s2
dc6b0978
KW
570Test two C<NUL>-terminated strings to see if the first, C<s1>, is less than the
571second, C<s2>. Returns true or false.
954c1994
GS
572
573=for apidoc Am|bool|strLE|char* s1|char* s2
dc6b0978
KW
574Test two C<NUL>-terminated strings to see if the first, C<s1>, is less than or
575equal to the second, C<s2>. Returns true or false.
954c1994
GS
576
577=for apidoc Am|bool|strGT|char* s1|char* s2
dc6b0978
KW
578Test two C<NUL>-terminated strings to see if the first, C<s1>, is greater than
579the second, C<s2>. Returns true or false.
954c1994
GS
580
581=for apidoc Am|bool|strGE|char* s1|char* s2
dc6b0978
KW
582Test two C<NUL>-terminated strings to see if the first, C<s1>, is greater than
583or equal to the second, C<s2>. Returns true or false.
954c1994
GS
584
585=for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
dc6b0978
KW
586Test two C<NUL>-terminated strings to see if they are different. The C<len>
587parameter indicates the number of bytes to compare. Returns true or false. (A
954c1994
GS
588wrapper for C<strncmp>).
589
590=for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
dc6b0978
KW
591Test two C<NUL>-terminated strings to see if they are equal. The C<len>
592parameter indicates the number of bytes to compare. Returns true or false. (A
593wrapper for C<strncmp>).
954c1994 594
bd18bd40
KW
595=for apidoc Am|bool|memEQ|char* s1|char* s2|STRLEN len
596Test two buffers (which may contain embedded C<NUL> characters, to see if they
597are equal. The C<len> parameter indicates the number of bytes to compare.
598Returns zero if equal, or non-zero if non-equal.
599
3bb9fd01 600=for apidoc Am|bool|memEQs|char* s1|STRLEN l1|"s2"
2d8eeddb
KW
601Like L</memEQ>, but the second string is a literal enclosed in double quotes,
602C<l1> gives the number of bytes in C<s1>.
603Returns zero if equal, or non-zero if non-equal.
604
bd18bd40
KW
605=for apidoc Am|bool|memNE|char* s1|char* s2|STRLEN len
606Test two buffers (which may contain embedded C<NUL> characters, to see if they
607are not equal. The C<len> parameter indicates the number of bytes to compare.
608Returns zero if non-equal, or non-zero if equal.
609
3bb9fd01 610=for apidoc Am|bool|memNEs|char* s1|STRLEN l1|"s2"
2d8eeddb
KW
611Like L</memNE>, but the second string is a literal enclosed in double quotes,
612C<l1> gives the number of bytes in C<s1>.
613Returns zero if non-equal, or zero if non-equal.
614
4aada8b9
KW
615=for apidoc Am|bool|memCHRs|"list"|char c
616Returns the position of the first occurence of the byte C<c> in the literal
617string C<"list">, or NULL if C<c> doesn't appear in C<"list">. All bytes are
618treated as unsigned char. Thus this macro can be used to determine if C<c> is
619in a set of particular characters. Unlike L<strchr(3)>, it works even if C<c>
620is C<NUL> (and the set doesn't include C<NUL>).
621
954c1994 622=cut
fc169e00
KW
623
624New macros should use the following conventions for their names (which are
625based on the underlying C library functions):
626
627 (mem | str n? ) (EQ | NE | LT | GT | GE | (( BEGIN | END ) P? )) l? s?
628
629 Each has two main parameters, string-like operands that are compared
630 against each other, as specified by the macro name. Some macros may
631 additionally have one or potentially even two length parameters. If a length
632 parameter applies to both string parameters, it will be positioned third;
633 otherwise any length parameter immediately follows the string parameter it
634 applies to.
635
636 If the prefix to the name is 'str', the string parameter is a pointer to a C
637 language string. Such a string does not contain embedded NUL bytes; its
638 length may be unknown, but can be calculated by C<strlen()>, since it is
639 terminated by a NUL, which isn't included in its length.
640
a3815e44 641 The optional 'n' following 'str' means that there is a third parameter,
fc169e00
KW
642 giving the maximum number of bytes to look at in each string. Even if both
643 strings are longer than the length parameter, those extra bytes will be
644 unexamined.
645
646 The 's' suffix means that the 2nd byte string parameter is a literal C
647 double-quoted string. Its length will automatically be calculated by the
648 macro, so no length parameter will ever be needed for it.
649
650 If the prefix is 'mem', the string parameters don't have to be C strings;
651 they may contain embedded NUL bytes, do not necessarily have a terminating
652 NUL, and their lengths can be known only through other means, which in
653 practice are additional parameter(s) passed to the function. All 'mem'
654 functions have at least one length parameter. Barring any 'l' or 's' suffix,
655 there is a single length parameter, in position 3, which applies to both
656 string parameters. The 's' suffix means, as described above, that the 2nd
657 string is a literal double-quoted C string (hence its length is calculated by
658 the macro, and the length parameter to the function applies just to the first
659 string parameter, and hence is positioned just after it). An 'l' suffix
660 means that the 2nd string parameter has its own length parameter, and the
661 signature will look like memFOOl(s1, l1, s2, l2).
662
663 BEGIN (and END) are for testing if the 2nd string is an initial (or final)
664 substring of the 1st string. 'P' if present indicates that the substring
665 must be a "proper" one in tha mathematical sense that the first one must be
666 strictly larger than the 2nd.
667
954c1994
GS
668*/
669
62946e08 670
75400963
KW
671#define strNE(s1,s2) (strcmp(s1,s2) != 0)
672#define strEQ(s1,s2) (strcmp(s1,s2) == 0)
8d063cd8
LW
673#define strLT(s1,s2) (strcmp(s1,s2) < 0)
674#define strLE(s1,s2) (strcmp(s1,s2) <= 0)
675#define strGT(s1,s2) (strcmp(s1,s2) > 0)
676#define strGE(s1,s2) (strcmp(s1,s2) >= 0)
62946e08 677
75400963
KW
678#define strnNE(s1,s2,l) (strncmp(s1,s2,l) != 0)
679#define strnEQ(s1,s2,l) (strncmp(s1,s2,l) == 0)
378cc40b 680
9d3980bc
KW
681#define memEQ(s1,s2,l) (memcmp(((const void *) (s1)), ((const void *) (s2)), l) == 0)
682#define memNE(s1,s2,l) (! memEQ(s1,s2,l))
36477c24 683
085b7534 684/* memEQ and memNE where second comparand is a string constant */
568a785a 685#define memEQs(s1, l, s2) \
777fa2cb 686 (((sizeof(s2)-1) == (l)) && memEQ((s1), ("" s2 ""), (sizeof(s2)-1)))
5f50c6c9 687#define memNEs(s1, l, s2) (! memEQs(s1, l, s2))
568a785a 688
fdbb9a7c
KW
689/* Keep these private until we decide it was a good idea */
690#if defined(PERL_CORE) || defined(PERL_EXT) || defined(PERL_EXT_POSIX)
691
692#define strBEGINs(s1,s2) (strncmp(s1,"" s2 "", sizeof(s2)-1) == 0)
693
bdb7e3f0 694#define memBEGINs(s1, l, s2) \
30a6480c 695 ( (Ptrdiff_t) (l) >= (Ptrdiff_t) sizeof(s2) - 1 \
bdb7e3f0 696 && memEQ(s1, "" s2 "", sizeof(s2)-1))
de627158 697#define memBEGINPs(s1, l, s2) \
30a6480c 698 ( (Ptrdiff_t) (l) > (Ptrdiff_t) sizeof(s2) - 1 \
de627158 699 && memEQ(s1, "" s2 "", sizeof(s2)-1))
bdb7e3f0 700#define memENDs(s1, l, s2) \
30a6480c 701 ( (Ptrdiff_t) (l) >= (Ptrdiff_t) sizeof(s2) - 1 \
bdb7e3f0 702 && memEQ(s1 + (l) - (sizeof(s2) - 1), "" s2 "", sizeof(s2)-1))
b80f8424 703#define memENDPs(s1, l, s2) \
30a6480c 704 ( (Ptrdiff_t) (l) > (Ptrdiff_t) sizeof(s2) \
b80f8424 705 && memEQ(s1 + (l) - (sizeof(s2) - 1), "" s2 "", sizeof(s2)-1))
fdbb9a7c 706#endif /* End of making macros private */
bdb7e3f0 707
062b6850
KW
708#define memLT(s1,s2,l) (memcmp(s1,s2,l) < 0)
709#define memLE(s1,s2,l) (memcmp(s1,s2,l) <= 0)
710#define memGT(s1,s2,l) (memcmp(s1,s2,l) > 0)
711#define memGE(s1,s2,l) (memcmp(s1,s2,l) >= 0)
712
4aada8b9
KW
713#define memCHRs(s1,c) ((const char *) memchr("" s1 "" , c, sizeof(s1)-1))
714
bbce6d69
PP
715/*
716 * Character classes.
717 *
718 * Unfortunately, the introduction of locales means that we
719 * can't trust isupper(), etc. to tell the truth. And when
720 * it comes to /\w+/ with tainting enabled, we *must* be able
721 * to trust our character classes.
722 *
723 * Therefore, the default tests in the text of Perl will be
724 * independent of locale. Any code that wants to depend on
725 * the current locale will use the tests that begin with "lc".
726 */
727
2304df62
AD
728#ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */
729# ifndef CTYPE256
730# define CTYPE256
731# endif
732#endif
733
954c1994 734/*
ccfc67b7 735
dcccc8ff 736=head1 Character classification
243effed
KW
737This section is about functions (really macros) that classify characters
738into types, such as punctuation versus alphabetic, etc. Most of these are
739analogous to regular expression character classes. (See
740L<perlrecharclass/POSIX Character Classes>.) There are several variants for
741each class. (Not all macros have all variants; each item below lists the
742ones valid for it.) None are affected by C<use bytes>, and only the ones
743with C<LC> in the name are affected by the current locale.
744
d713f9d9
KW
745The base function, e.g., C<isALPHA()>, takes any signed or unsigned value,
746treating it as a code point, and returns a boolean as to whether or not the
747character represented by it is (or on non-ASCII platforms, corresponds to) an
6aff1f14
KW
748ASCII character in the named class based on platform, Unicode, and Perl rules.
749If the input is a number that doesn't fit in an octet, FALSE is returned.
243effed 750
c98722a4 751Variant C<isI<FOO>_A> (e.g., C<isALPHA_A()>) is identical to the base function
550da823
KW
752with no suffix C<"_A">. This variant is used to emphasize by its name that
753only ASCII-range characters can return TRUE.
4b9734bf 754
d60679e1 755Variant C<isI<FOO>_L1> imposes the Latin-1 (or EBCDIC equivalent) character set
4b9734bf
KW
756onto the platform. That is, the code points that are ASCII are unaffected,
757since ASCII is a subset of Latin-1. But the non-ASCII code points are treated
758as if they are Latin-1 characters. For example, C<isWORDCHAR_L1()> will return
759true when called with the code point 0xDF, which is a word character in both
4650c663 760ASCII and EBCDIC (though it represents different characters in each).
d713f9d9
KW
761If the input is a number that doesn't fit in an octet, FALSE is returned.
762(Perl's documentation uses a colloquial definition of Latin-1, to include all
763code points below 256.)
243effed 764
d713f9d9
KW
765Variant C<isI<FOO>_uvchr> is exactly like the C<isI<FOO>_L1> variant, for
766inputs below 256, but if the code point is larger than 255, Unicode rules are
767used to determine if it is in the character class. For example,
d0da05db 768C<isWORDCHAR_uvchr(0x100)> returns TRUE, since 0x100 is LATIN CAPITAL LETTER A
6aff1f14 769WITH MACRON in Unicode, and is a word character.
243effed 770
059703b0
KW
771Variants C<isI<FOO>_utf8> and C<isI<FOO>_utf8_safe> are like C<isI<FOO>_uvchr>,
772but are used for UTF-8 encoded strings. The two forms are different names for
773the same thing. Each call to one of these classifies the first character of
774the string starting at C<p>. The second parameter, C<e>, points to anywhere in
775the string beyond the first character, up to one byte past the end of the
776entire string. Although both variants are identical, the suffix C<_safe> in
777one name emphasizes that it will not attempt to read beyond S<C<e - 1>>,
778provided that the constraint S<C<s E<lt> e>> is true (this is asserted for in
779C<-DDEBUGGING> builds). If the UTF-8 for the input character is malformed in
780some way, the program may croak, or the function may return FALSE, at the
781discretion of the implementation, and subject to change in future releases.
243effed 782
d713f9d9
KW
783Variant C<isI<FOO>_LC> is like the C<isI<FOO>_A> and C<isI<FOO>_L1> variants,
784but the result is based on the current locale, which is what C<LC> in the name
785stands for. If Perl can determine that the current locale is a UTF-8 locale,
786it uses the published Unicode rules; otherwise, it uses the C library function
787that gives the named classification. For example, C<isDIGIT_LC()> when not in
788a UTF-8 locale returns the result of calling C<isdigit()>. FALSE is always
1a83413c
KW
789returned if the input won't fit into an octet. On some platforms where the C
790library function is known to be defective, Perl changes its result to follow
791the POSIX standard's rules.
243effed 792
d713f9d9
KW
793Variant C<isI<FOO>_LC_uvchr> acts exactly like C<isI<FOO>_LC> for inputs less
794than 256, but for larger ones it returns the Unicode classification of the code
795point.
243effed 796
059703b0
KW
797Variants C<isI<FOO>_LC_utf8> and C<isI<FOO>_LC_utf8_safe> are like
798C<isI<FOO>_LC_uvchr>, but are used for UTF-8 encoded strings. The two forms
799are different names for the same thing. Each call to one of these classifies
800the first character of the string starting at C<p>. The second parameter,
801C<e>, points to anywhere in the string beyond the first character, up to one
802byte past the end of the entire string. Although both variants are identical,
803the suffix C<_safe> in one name emphasizes that it will not attempt to read
804beyond S<C<e - 1>>, provided that the constraint S<C<s E<lt> e>> is true (this
805is asserted for in C<-DDEBUGGING> builds). If the UTF-8 for the input
806character is malformed in some way, the program may croak, or the function may
807return FALSE, at the discretion of the implementation, and subject to change in
808future releases.
ccfc67b7 809
d713f9d9 810=for apidoc Am|bool|isALPHA|int ch
fa470d81
KW
811=for apidoc_item ||isALPHA_A|int ch
812=for apidoc_item ||isALPHA_L1|int ch
813=for apidoc_item ||isALPHA_uvchr|int ch
814=for apidoc_item ||isALPHA_utf8_safe|U8 * s|U8 * end
815=for apidoc_item ||isALPHA_utf8|U8 * s|U8 * end
816=for apidoc_item ||isALPHA_LC|int ch
817=for apidoc_item ||isALPHA_LC_uvchr|int ch
818=for apidoc_item ||isALPHA_LC_utf8_safe|U8 * s| U8 *end
d713f9d9
KW
819Returns a boolean indicating whether the specified input is one of C<[A-Za-z]>,
820analogous to C<m/[[:alpha:]]/>.
dcccc8ff 821See the L<top of this section|/Character classification> for an explanation of
fa470d81 822the variants.
8a58bdcf 823
f16858ed
KW
824=cut
825
826Here and below, we add the protoypes of these macros for downstream programs
827that would be interested in them, such as Devel::PPPort
828
d713f9d9 829=for apidoc Am|bool|isALPHANUMERIC|int ch
fa470d81
KW
830=for apidoc_item ||isALPHANUMERIC_A|int ch
831=for apidoc_item ||isALPHANUMERIC_L1|int ch
832=for apidoc_item ||isALPHANUMERIC_uvchr|int ch
833=for apidoc_item ||isALPHANUMERIC_utf8_safe|U8 * s|U8 * end
834=for apidoc_item ||isALPHANUMERIC_utf8|U8 * s|U8 * end
835=for apidoc_item ||isALPHANUMERIC_LC|int ch
836=for apidoc_item ||isALPHANUMERIC_LC_uvchr|int ch
837=for apidoc_item ||isALPHANUMERIC_LC_utf8_safe|U8 * s| U8 *end
838=for apidoc_item ||isALNUMC|int ch
839=for apidoc_item ||isALNUMC_A|int ch
840=for apidoc_item ||isALNUMC_L1|int ch
841=for apidoc_item ||isALNUMC_LC|int ch
842=for apidoc_item ||isALNUMC_LC_uvchr|int ch
d713f9d9
KW
843Returns a boolean indicating whether the specified character is one of
844C<[A-Za-z0-9]>, analogous to C<m/[[:alnum:]]/>.
dcccc8ff 845See the L<top of this section|/Character classification> for an explanation of
fa470d81 846the variants.
15861f94 847
255b632a
KW
848A (discouraged from use) synonym is C<isALNUMC> (where the C<C> suffix means
849this corresponds to the C language alphanumeric definition). Also
850there are the variants
851C<isALNUMC_A>, C<isALNUMC_L1>
852C<isALNUMC_LC>, and C<isALNUMC_LC_uvchr>.
853
d713f9d9 854=for apidoc Am|bool|isASCII|int ch
fa470d81
KW
855=for apidoc_item ||isASCII_A|int ch
856=for apidoc_item ||isASCII_L1|int ch
857=for apidoc_item ||isASCII_uvchr|int ch
858=for apidoc_item ||isASCII_utf8_safe|U8 * s|U8 * end
859=for apidoc_item ||isASCII_utf8|U8 * s|U8 * end
860=for apidoc_item ||isASCII_LC|int ch
861=for apidoc_item ||isASCII_LC_uvchr|int ch
862=for apidoc_item ||isASCII_LC_utf8_safe|U8 * s| U8 *end
8a58bdcf 863Returns a boolean indicating whether the specified character is one of the 128
243effed 864characters in the ASCII character set, analogous to C<m/[[:ascii:]]/>.
e5ad6aba 865On non-ASCII platforms, it returns TRUE iff this
8a58bdcf
KW
866character corresponds to an ASCII character. Variants C<isASCII_A()> and
867C<isASCII_L1()> are identical to C<isASCII()>.
dcccc8ff 868See the L<top of this section|/Character classification> for an explanation of
fa470d81 869the variants.
059703b0
KW
870Note, however, that some platforms do not have the C library routine
871C<isascii()>. In these cases, the variants whose names contain C<LC> are the
872same as the corresponding ones without.
243effed 873
d98532ea
KW
874Also note, that because all ASCII characters are UTF-8 invariant (meaning they
875have the exact same representation (always a single byte) whether encoded in
876UTF-8 or not), C<isASCII> will give the correct results when called with any
059703b0
KW
877byte in any string encoded or not in UTF-8. And similarly C<isASCII_utf8> and
878C<isASCII_utf8_safe> will work properly on any string encoded or not in UTF-8.
d98532ea 879
fa470d81
KW
880=for apidoc Am|bool|isBLANK|int ch
881=for apidoc_item ||isBLANK_A|int ch
882=for apidoc_item ||isBLANK_L1|int ch
883=for apidoc_item ||isBLANK_uvchr|int ch
884=for apidoc_item ||isBLANK_utf8_safe|U8 * s|U8 * end
885=for apidoc_item ||isBLANK_utf8|U8 * s|U8 * end
886=for apidoc_item ||isBLANK_LC|int ch
887=for apidoc_item ||isBLANK_LC_uvchr|int ch
888=for apidoc_item ||isBLANK_LC_utf8_safe|U8 * s| U8 *end
243effed 889Returns a boolean indicating whether the specified character is a
6aff1f14 890character considered to be a blank, analogous to C<m/[[:blank:]]/>.
dcccc8ff 891See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
892the variants.
893Note,
da8c1a98
KW
894however, that some platforms do not have the C library routine
895C<isblank()>. In these cases, the variants whose names contain C<LC> are
896the same as the corresponding ones without.
243effed 897
fa470d81
KW
898=for apidoc Am|bool|isCNTRL|int ch
899=for apidoc_item ||isCNTRL_A|int ch
900=for apidoc_item ||isCNTRL_L1|int ch
901=for apidoc_item ||isCNTRL_uvchr|int ch
902=for apidoc_item ||isCNTRL_utf8_safe|U8 * s|U8 * end
903=for apidoc_item ||isCNTRL_utf8|U8 * s|U8 * end
904=for apidoc_item ||isCNTRL_LC|int ch
905=for apidoc_item ||isCNTRL_LC_uvchr|int ch
906=for apidoc_item ||isCNTRL_LC_utf8_safe|U8 * s| U8 *end
f16858ed 907
243effed 908Returns a boolean indicating whether the specified character is a
6aff1f14 909control character, analogous to C<m/[[:cntrl:]]/>.
dcccc8ff 910See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
911the variants.
912On EBCDIC platforms, you almost always want to use the C<isCNTRL_L1> variant.
913
914=for apidoc Am|bool|isDIGIT|int ch
915=for apidoc_item ||isDIGIT_A|int ch
916=for apidoc_item ||isDIGIT_L1|int ch
917=for apidoc_item ||isDIGIT_uvchr|int ch
918=for apidoc_item ||isDIGIT_utf8_safe|U8 * s|U8 * end
919=for apidoc_item ||isDIGIT_utf8|U8 * s|U8 * end
920=for apidoc_item ||isDIGIT_LC|int ch
921=for apidoc_item ||isDIGIT_LC_uvchr|int ch
922=for apidoc_item ||isDIGIT_LC_utf8_safe|U8 * s| U8 *end
923
2787a470 924Returns a boolean indicating whether the specified character is a
6aff1f14 925digit, analogous to C<m/[[:digit:]]/>.
8a58bdcf 926Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
dcccc8ff 927See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
928the variants.
929
930=for apidoc Am|bool|isGRAPH|int ch
931=for apidoc_item ||isGRAPH_A|int ch
932=for apidoc_item ||isGRAPH_L1|int ch
933=for apidoc_item ||isGRAPH_uvchr|int ch
934=for apidoc_item ||isGRAPH_utf8_safe|U8 * s|U8 * end
935=for apidoc_item ||isGRAPH_utf8|U8 * s|U8 * end
936=for apidoc_item ||isGRAPH_LC|int ch
937=for apidoc_item ||isGRAPH_LC_uvchr|int ch
938=for apidoc_item ||isGRAPH_LC_utf8_safe|U8 * s| U8 *end
243effed 939Returns a boolean indicating whether the specified character is a
6aff1f14 940graphic character, analogous to C<m/[[:graph:]]/>.
dcccc8ff 941See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
942the variants.
943
944=for apidoc Am|bool|isLOWER|int ch
945=for apidoc_item ||isLOWER_A|int ch
946=for apidoc_item ||isLOWER_L1|int ch
947=for apidoc_item ||isLOWER_uvchr|int ch
948=for apidoc_item ||isLOWER_utf8_safe|U8 * s|U8 * end
949=for apidoc_item ||isLOWER_utf8|U8 * s|U8 * end
950=for apidoc_item ||isLOWER_LC|int ch
951=for apidoc_item ||isLOWER_LC_uvchr|int ch
952=for apidoc_item ||isLOWER_LC_utf8_safe|U8 * s| U8 *end
2787a470 953Returns a boolean indicating whether the specified character is a
6aff1f14 954lowercase character, analogous to C<m/[[:lower:]]/>.
dcccc8ff 955See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
956the variants
957
958=for apidoc Am|bool|isOCTAL|int ch
959=for apidoc_item ||isOCTAL_A|int ch
960=for apidoc_item ||isOCTAL_L1|int ch
2787a470 961Returns a boolean indicating whether the specified character is an
6aff1f14 962octal digit, [0-7].
243effed
KW
963The only two variants are C<isOCTAL_A> and C<isOCTAL_L1>; each is identical to
964C<isOCTAL>.
965
fa470d81
KW
966=for apidoc Am|bool|isPUNCT|int ch
967=for apidoc_item ||isPUNCT_A|int ch
968=for apidoc_item ||isPUNCT_L1|int ch
969=for apidoc_item ||isPUNCT_uvchr|int ch
970=for apidoc_item ||isPUNCT_utf8_safe|U8 * s|U8 * end
971=for apidoc_item ||isPUNCT_utf8|U8 * s|U8 * end
972=for apidoc_item ||isPUNCT_LC|int ch
973=for apidoc_item ||isPUNCT_LC_uvchr|int ch
974=for apidoc_item ||isPUNCT_LC_utf8_safe|U8 * s| U8 *end
243effed 975Returns a boolean indicating whether the specified character is a
6aff1f14
KW
976punctuation character, analogous to C<m/[[:punct:]]/>.
977Note that the definition of what is punctuation isn't as
243effed
KW
978straightforward as one might desire. See L<perlrecharclass/POSIX Character
979Classes> for details.
dcccc8ff 980See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
981the variants.
982
983=for apidoc Am|bool|isSPACE|int ch
984=for apidoc_item ||isSPACE_A|int ch
985=for apidoc_item ||isSPACE_L1|int ch
986=for apidoc_item ||isSPACE_uvchr|int ch
987=for apidoc_item ||isSPACE_utf8_safe|U8 * s|U8 * end
988=for apidoc_item ||isSPACE_utf8|U8 * s|U8 * end
989=for apidoc_item ||isSPACE_LC|int ch
990=for apidoc_item ||isSPACE_LC_uvchr|int ch
991=for apidoc_item ||isSPACE_LC_utf8_safe|U8 * s| U8 *end
2787a470 992Returns a boolean indicating whether the specified character is a
6aff1f14 993whitespace character. This is analogous
398d098a 994to what C<m/\s/> matches in a regular expression. Starting in Perl 5.18
779cf272 995this also matches what C<m/[[:space:]]/> does. Prior to 5.18, only the
398d098a
KW
996locale forms of this macro (the ones with C<LC> in their names) matched
997precisely what C<m/[[:space:]]/> does. In those releases, the only difference,
998in the non-locale variants, was that C<isSPACE()> did not match a vertical tab.
999(See L</isPSXSPC> for a macro that matches a vertical tab in all releases.)
dcccc8ff 1000See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
1001the variants.
1002
1003=for apidoc Am|bool|isPSXSPC|int ch
1004=for apidoc_item ||isPSXSPC_A|int ch
1005=for apidoc_item ||isPSXSPC_L1|int ch
1006=for apidoc_item ||isPSXSPC_uvchr|int ch
1007=for apidoc_item ||isPSXSPC_utf8_safe|U8 * s|U8 * end
1008=for apidoc_item ||isPSXSPC_utf8|U8 * s|U8 * end
1009=for apidoc_item ||isPSXSPC_LC|int ch
1010=for apidoc_item ||isPSXSPC_LC_uvchr|int ch
1011=for apidoc_item ||isPSXSPC_LC_utf8_safe|U8 * s| U8 *end
398d098a 1012(short for Posix Space)
779cf272
KW
1013Starting in 5.18, this is identical in all its forms to the
1014corresponding C<isSPACE()> macros.
398d098a
KW
1015The locale forms of this macro are identical to their corresponding
1016C<isSPACE()> forms in all Perl releases. In releases prior to 5.18, the
1017non-locale forms differ from their C<isSPACE()> forms only in that the
1018C<isSPACE()> forms don't match a Vertical Tab, and the C<isPSXSPC()> forms do.
1019Otherwise they are identical. Thus this macro is analogous to what
1020C<m/[[:space:]]/> matches in a regular expression.
dcccc8ff 1021See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
1022the variants.
1023
1024=for apidoc Am|bool|isUPPER|int ch
1025=for apidoc_item ||isUPPER_A|int ch
1026=for apidoc_item ||isUPPER_L1|int ch
1027=for apidoc_item ||isUPPER_uvchr|int ch
1028=for apidoc_item ||isUPPER_utf8_safe|U8 * s|U8 * end
1029=for apidoc_item ||isUPPER_utf8|U8 * s|U8 * end
1030=for apidoc_item ||isUPPER_LC|int ch
1031=for apidoc_item ||isUPPER_LC_uvchr|int ch
1032=for apidoc_item ||isUPPER_LC_utf8_safe|U8 * s| U8 *end
2787a470 1033Returns a boolean indicating whether the specified character is an
6aff1f14 1034uppercase character, analogous to C<m/[[:upper:]]/>.
dcccc8ff 1035See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
1036the variants.
1037
1038=for apidoc Am|bool|isPRINT|int ch
1039=for apidoc_item ||isPRINT_A|int ch
1040=for apidoc_item ||isPRINT_L1|int ch
1041=for apidoc_item ||isPRINT_uvchr|int ch
1042=for apidoc_item ||isPRINT_utf8_safe|U8 * s|U8 * end
1043=for apidoc_item ||isPRINT_utf8|U8 * s|U8 * end
1044=for apidoc_item ||isPRINT_LC|int ch
1045=for apidoc_item ||isPRINT_LC_uvchr|int ch
1046=for apidoc_item ||isPRINT_LC_utf8_safe|U8 * s| U8 *end
8eea39dd 1047Returns a boolean indicating whether the specified character is a
6aff1f14 1048printable character, analogous to C<m/[[:print:]]/>.
dcccc8ff 1049See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
1050the variants.
1051
1052=for apidoc Am|bool|isWORDCHAR|int ch
1053=for apidoc_item ||isWORDCHAR_A|int ch
1054=for apidoc_item ||isWORDCHAR_L1|int ch
1055=for apidoc_item ||isWORDCHAR_uvchr|int ch
1056=for apidoc_item ||isWORDCHAR_utf8_safe|U8 * s|U8 * end
1057=for apidoc_item ||isWORDCHAR_utf8|U8 * s|U8 * end
1058=for apidoc_item ||isWORDCHAR_LC|int ch
1059=for apidoc_item ||isWORDCHAR_LC_uvchr|int ch
1060=for apidoc_item ||isWORDCHAR_LC_utf8_safe|U8 * s| U8 *end
1061=for apidoc_item ||isALNUM|int ch
1062=for apidoc_item ||isALNUM_A|int ch
1063=for apidoc_item ||isALNUM_LC|int ch
1064=for apidoc_item ||isALNUM_LC_uvchr|int ch
243effed
KW
1065Returns a boolean indicating whether the specified character is a character
1066that is a word character, analogous to what C<m/\w/> and C<m/[[:word:]]/> match
1067in a regular expression. A word character is an alphabetic character, a
1068decimal digit, a connecting punctuation character (such as an underscore), or
1069a "mark" character that attaches to one of those (like some sort of accent).
1070C<isALNUM()> is a synonym provided for backward compatibility, even though a
1071word character includes more than the standard C language meaning of
1072alphanumeric.
dcccc8ff 1073See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
1074the variants.
1075C<isWORDCHAR_A>, C<isWORDCHAR_L1>, C<isWORDCHAR_uvchr>,
1076C<isWORDCHAR_LC>, C<isWORDCHAR_LC_uvchr>, C<isWORDCHAR_LC_utf8>, and
1077C<isWORDCHAR_LC_utf8_safe> are also as described there, but additionally
1078include the platform's native underscore.
1079
1080=for apidoc Am|bool|isXDIGIT|int ch
1081=for apidoc_item ||isXDIGIT_A|int ch
1082=for apidoc_item ||isXDIGIT_L1|int ch
1083=for apidoc_item ||isXDIGIT_uvchr|int ch
1084=for apidoc_item ||isXDIGIT_utf8_safe|U8 * s|U8 * end
1085=for apidoc_item ||isXDIGIT_utf8|U8 * s|U8 * end
1086=for apidoc_item ||isXDIGIT_LC|int ch
1087=for apidoc_item ||isXDIGIT_LC_uvchr|int ch
1088=for apidoc_item ||isXDIGIT_LC_utf8_safe|U8 * s| U8 *end
8a58bdcf 1089Returns a boolean indicating whether the specified character is a hexadecimal
243effed
KW
1090digit. In the ASCII range these are C<[0-9A-Fa-f]>. Variants C<isXDIGIT_A()>
1091and C<isXDIGIT_L1()> are identical to C<isXDIGIT()>.
dcccc8ff 1092See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
1093the variants.
1094
1095=for apidoc Am|bool|isIDFIRST|int ch
1096=for apidoc_item ||isIDFIRST_A|int ch
1097=for apidoc_item ||isIDFIRST_L1|int ch
1098=for apidoc_item ||isIDFIRST_uvchr|int ch
1099=for apidoc_item ||isIDFIRST_utf8_safe|U8 * s|U8 * end
1100=for apidoc_item ||isIDFIRST_utf8|U8 * s|U8 * end
1101=for apidoc_item ||isIDFIRST_LC|int ch
1102=for apidoc_item ||isIDFIRST_LC_uvchr|int ch
1103=for apidoc_item ||isIDFIRST_LC_utf8_safe|U8 * s| U8 *end
3c3ecf18
KW
1104Returns a boolean indicating whether the specified character can be the first
1105character of an identifier. This is very close to, but not quite the same as
1106the official Unicode property C<XID_Start>. The difference is that this
1107returns true only if the input character also matches L</isWORDCHAR>.
dcccc8ff 1108See the L<top of this section|/Character classification> for an explanation of
fa470d81
KW
1109the variants.
1110
1111=for apidoc Am|bool|isIDCONT|int ch
1112=for apidoc_item ||isIDCONT_A|int ch
1113=for apidoc_item ||isIDCONT_L1|int ch
1114=for apidoc_item ||isIDCONT_uvchr|int ch
1115=for apidoc_item ||isIDCONT_utf8_safe|U8 * s|U8 * end
1116=for apidoc_item ||isIDCONT_utf8|U8 * s|U8 * end
1117=for apidoc_item ||isIDCONT_LC|int ch
1118=for apidoc_item ||isIDCONT_LC_uvchr|int ch
1119=for apidoc_item ||isIDCONT_LC_utf8_safe|U8 * s| U8 *end
3c3ecf18
KW
1120Returns a boolean indicating whether the specified character can be the
1121second or succeeding character of an identifier. This is very close to, but
1122not quite the same as the official Unicode property C<XID_Continue>. The
1123difference is that this returns true only if the input character also matches
dcccc8ff 1124L</isWORDCHAR>. See the L<top of this section|/Character classification> for
fa470d81 1125an explanation of the variants.
f16858ed 1126
51b56f5c 1127=for apidoc_section Numeric Functions
8eea39dd 1128
95a59cab 1129=for apidoc Am|U8|READ_XDIGIT|char str*
243effed 1130Returns the value of an ASCII-range hex digit and advances the string pointer.
95a59cab
YO
1131Behaviour is only well defined when isXDIGIT(*str) is true.
1132
e7c1e6c1 1133=head1 Character case changing
21da7284
KW
1134Perl uses "full" Unicode case mappings. This means that converting a single
1135character to another case may result in a sequence of more than one character.
1136For example, the uppercase of C<E<223>> (LATIN SMALL LETTER SHARP S) is the two
1137character sequence C<SS>. This presents some complications The lowercase of
1138all characters in the range 0..255 is a single character, and thus
1139C<L</toLOWER_L1>> is furnished. But, C<toUPPER_L1> can't exist, as it couldn't
1140return a valid result for all legal inputs. Instead C<L</toUPPER_uvchr>> has
1141an API that does allow every possible legal result to be returned.) Likewise
1142no other function that is crippled by not being able to give the correct
1143results for the full range of possible inputs has been implemented here.
e7c1e6c1 1144
d713f9d9 1145=for apidoc Am|U8|toUPPER|int ch
1f607577
KW
1146Converts the specified character to uppercase. If the input is anything but an
1147ASCII lowercase character, that input character itself is returned. Variant
c753c8d3 1148C<toUPPER_A> is equivalent.
954c1994 1149
d0da05db
KW
1150=for apidoc Am|UV|toUPPER_uvchr|UV cp|U8* s|STRLEN* lenp
1151Converts the code point C<cp> to its uppercase version, and
1152stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. The code
1153point is interpreted as native if less than 256; otherwise as Unicode. Note
1f607577
KW
1154that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
1155bytes since the uppercase version may be longer than the original character.
1156
1157The first code point of the uppercased version is returned
21da7284
KW
1158(but note, as explained at L<the top of this section|/Character case
1159changing>, that there may be more.)
1f607577 1160
059703b0 1161=for apidoc Am|UV|toUPPER_utf8|U8* p|U8* e|U8* s|STRLEN* lenp
912c8141 1162=for apidoc_item toUPPER_utf8_safe
a239b1e2
KW
1163Converts the first UTF-8 encoded character in the sequence starting at C<p> and
1164extending no further than S<C<e - 1>> to its uppercase version, and
1f607577
KW
1165stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
1166that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
1167bytes since the uppercase version may be longer than the original character.
1168
1169The first code point of the uppercased version is returned
21da7284
KW
1170(but note, as explained at L<the top of this section|/Character case
1171changing>, that there may be more).
1f607577 1172
059703b0
KW
1173It will not attempt to read beyond S<C<e - 1>>, provided that the constraint
1174S<C<s E<lt> e>> is true (this is asserted for in C<-DDEBUGGING> builds). If
1175the UTF-8 for the input character is malformed in some way, the program may
1176croak, or the function may return the REPLACEMENT CHARACTER, at the discretion
1177of the implementation, and subject to change in future releases.
a239b1e2 1178
912c8141 1179C<toUPPER_utf8_safe> is now just a different spelling of plain C<toUPPER_utf8>
1f607577 1180
25200305
KW
1181=for apidoc Am|U8|toFOLD|U8 ch
1182Converts the specified character to foldcase. If the input is anything but an
1183ASCII uppercase character, that input character itself is returned. Variant
1184C<toFOLD_A> is equivalent. (There is no equivalent C<to_FOLD_L1> for the full
d0da05db 1185Latin1 range, as the full generality of L</toFOLD_uvchr> is needed there.)
25200305 1186
d0da05db
KW
1187=for apidoc Am|UV|toFOLD_uvchr|UV cp|U8* s|STRLEN* lenp
1188Converts the code point C<cp> to its foldcase version, and
1189stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. The code
1190point is interpreted as native if less than 256; otherwise as Unicode. Note
1f607577
KW
1191that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
1192bytes since the foldcase version may be longer than the original character.
1193
1194The first code point of the foldcased version is returned
21da7284
KW
1195(but note, as explained at L<the top of this section|/Character case
1196changing>, that there may be more).
1f607577 1197
059703b0 1198=for apidoc Am|UV|toFOLD_utf8|U8* p|U8* e|U8* s|STRLEN* lenp
912c8141 1199=for apidoc_item toFOLD_utf8_safe
a239b1e2
KW
1200Converts the first UTF-8 encoded character in the sequence starting at C<p> and
1201extending no further than S<C<e - 1>> to its foldcase version, and
1f607577
KW
1202stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
1203that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
1204bytes since the foldcase version may be longer than the original character.
1205
1206The first code point of the foldcased version is returned
21da7284
KW
1207(but note, as explained at L<the top of this section|/Character case
1208changing>, that there may be more).
1f607577 1209
059703b0 1210It will not attempt
a239b1e2
KW
1211to read beyond S<C<e - 1>>, provided that the constraint S<C<s E<lt> e>> is
1212true (this is asserted for in C<-DDEBUGGING> builds). If the UTF-8 for the
1213input character is malformed in some way, the program may croak, or the
1214function may return the REPLACEMENT CHARACTER, at the discretion of the
1215implementation, and subject to change in future releases.
1216
912c8141 1217C<toFOLD_utf8_safe> is now just a different spelling of plain C<toFOLD_utf8>
1f607577
KW
1218
1219=for apidoc Am|U8|toLOWER|U8 ch
1220Converts the specified character to lowercase. If the input is anything but an
1221ASCII uppercase character, that input character itself is returned. Variant
c753c8d3 1222C<toLOWER_A> is equivalent.
954c1994 1223
1f607577 1224=for apidoc Am|U8|toLOWER_L1|U8 ch
b7d90381
KW
1225Converts the specified Latin1 character to lowercase. The results are
1226undefined if the input doesn't fit in a byte.
1f607577
KW
1227
1228=for apidoc Am|U8|toLOWER_LC|U8 ch
1229Converts the specified character to lowercase using the current locale's rules,
1230if possible; otherwise returns the input character itself.
1231
d0da05db
KW
1232=for apidoc Am|UV|toLOWER_uvchr|UV cp|U8* s|STRLEN* lenp
1233Converts the code point C<cp> to its lowercase version, and
1234stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. The code
1235point is interpreted as native if less than 256; otherwise as Unicode. Note
1f607577
KW
1236that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
1237bytes since the lowercase version may be longer than the original character.
1238
1239The first code point of the lowercased version is returned
21da7284
KW
1240(but note, as explained at L<the top of this section|/Character case
1241changing>, that there may be more).
1f607577 1242
bd350c85 1243=for apidoc Am|UV|toLOWER_utf8|U8* p|U8* e|U8* s|STRLEN* lenp
912c8141 1244=for apidoc_item toLOWER_utf8_safe
a239b1e2
KW
1245Converts the first UTF-8 encoded character in the sequence starting at C<p> and
1246extending no further than S<C<e - 1>> to its lowercase version, and
1f607577
KW
1247stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
1248that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
1249bytes since the lowercase version may be longer than the original character.
1250
1251The first code point of the lowercased version is returned
21da7284
KW
1252(but note, as explained at L<the top of this section|/Character case
1253changing>, that there may be more).
059703b0
KW
1254It will not attempt to read beyond S<C<e - 1>>, provided that the constraint
1255S<C<s E<lt> e>> is true (this is asserted for in C<-DDEBUGGING> builds). If
1256the UTF-8 for the input character is malformed in some way, the program may
1257croak, or the function may return the REPLACEMENT CHARACTER, at the discretion
1258of the implementation, and subject to change in future releases.
1f607577 1259
912c8141 1260C<toLOWER_utf8_safe> is now just a different spelling of plain C<toLOWER_utf8>
1f607577 1261
25200305
KW
1262=for apidoc Am|U8|toTITLE|U8 ch
1263Converts the specified character to titlecase. If the input is anything but an
1264ASCII lowercase character, that input character itself is returned. Variant
b7d90381 1265C<toTITLE_A> is equivalent. (There is no C<toTITLE_L1> for the full Latin1
d0da05db 1266range, as the full generality of L</toTITLE_uvchr> is needed there. Titlecase is
b7d90381 1267not a concept used in locale handling, so there is no functionality for that.)
25200305 1268
d0da05db
KW
1269=for apidoc Am|UV|toTITLE_uvchr|UV cp|U8* s|STRLEN* lenp
1270Converts the code point C<cp> to its titlecase version, and
1271stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. The code
1272point is interpreted as native if less than 256; otherwise as Unicode. Note
1f607577
KW
1273that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
1274bytes since the titlecase version may be longer than the original character.
1275
1276The first code point of the titlecased version is returned
21da7284
KW
1277(but note, as explained at L<the top of this section|/Character case
1278changing>, that there may be more).
1f607577 1279
059703b0 1280=for apidoc Am|UV|toTITLE_utf8|U8* p|U8* e|U8* s|STRLEN* lenp
912c8141
KW
1281=for apidoc_item toTITLE_utf8_safe
1282Convert the first UTF-8 encoded character in the sequence starting at C<p> and
a239b1e2 1283extending no further than S<C<e - 1>> to its titlecase version, and
1f607577
KW
1284stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
1285that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
1286bytes since the titlecase version may be longer than the original character.
1287
1288The first code point of the titlecased version is returned
21da7284
KW
1289(but note, as explained at L<the top of this section|/Character case
1290changing>, that there may be more).
1f607577 1291
059703b0 1292It will not attempt
a239b1e2
KW
1293to read beyond S<C<e - 1>>, provided that the constraint S<C<s E<lt> e>> is
1294true (this is asserted for in C<-DDEBUGGING> builds). If the UTF-8 for the
1295input character is malformed in some way, the program may croak, or the
1296function may return the REPLACEMENT CHARACTER, at the discretion of the
1297implementation, and subject to change in future releases.
1298
912c8141 1299C<toTITLE_utf8_safe> is now just a different spelling of plain C<toTITLE_utf8>
1f607577 1300
954c1994 1301=cut
353c9b6f 1302
d0da05db 1303XXX Still undocumented isVERTWS_uvchr and _utf8; it's unclear what their names
1e222e4f
KW
1304really should be. Also toUPPER_LC and toFOLD_LC, which are subject to change,
1305and aren't general purpose as they don't work on U+DF, and assert against that.
243effed 1306
8a58bdcf 1307Note that these macros are repeated in Devel::PPPort, so should also be
62fa66b6
KW
1308patched there. The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
1309
954c1994
GS
1310*/
1311
8f5283f4
KW
1312/*
1313 void below because that's the best fit, and works for Devel::PPPort
51b56f5c 1314=for apidoc_section Integer configuration values
8f5283f4
KW
1315=for apidoc AmnU|void|WIDEST_UTYPE
1316
1317Yields the widest unsigned integer type on the platform, currently either
1318C<U32> or C<64>. This can be used in declarations such as
1319
1320 WIDEST_UTYPE my_uv;
1321
1322or casts
1323
1324 my_uv = (WIDEST_UTYPE) val;
1325
1326=cut
1327
1328*/
de9e2639
KW
1329#ifdef QUADKIND
1330# define WIDEST_UTYPE U64
7c062697
KW
1331#else
1332# define WIDEST_UTYPE U32
1333#endif
1334
3912bc88
KW
1335/* FITS_IN_8_BITS(c) returns true if c doesn't have a bit set other than in
1336 * the lower 8. It is designed to be hopefully bomb-proof, making sure that no
1337 * bits of information are lost even on a 64-bit machine, but to get the
1338 * compiler to optimize it out if possible. This is because Configure makes
1339 * sure that the machine has an 8-bit byte, so if c is stored in a byte, the
1340 * sizeof() guarantees that this evaluates to a constant true at compile time.
7e75d1a1
JH
1341 *
1342 * For Coverity, be always true, because otherwise Coverity thinks
1343 * it finds several expressions that are always true, independent
1344 * of operands. Well, they are, but that is kind of the point.
220c71bf 1345 */
7e75d1a1 1346#ifndef __COVERITY__
6c5b02ac
KW
1347 /* The '| 0' part ensures a compiler error if c is not integer (like e.g., a
1348 * pointer) */
1349#define FITS_IN_8_BITS(c) ( (sizeof(c) == 1) \
ace3ad0f 1350 || !(((WIDEST_UTYPE)((c) | 0)) & ~0xFF))
7e75d1a1
JH
1351#else
1352#define FITS_IN_8_BITS(c) (1)
1353#endif
cf301eb7 1354
45f4bb73 1355/* Returns true if l <= c <= (l + n), where 'l' and 'n' are non-negative
833b0f46 1356 * Written this way so that after optimization, only one conditional test is
76d3ad4c
KW
1357 * needed. (The NV casts stop any warnings about comparison always being true
1358 * if called with an unsigned. The cast preserves the sign, which is all we
1359 * care about.) */
1360#define withinCOUNT(c, l, n) (__ASSERT_((NV) (l) >= 0) \
1361 __ASSERT_((NV) (n) >= 0) \
1362 (((WIDEST_UTYPE) (((c)) - ((l) | 0))) <= (((WIDEST_UTYPE) ((n) | 0)))))
833b0f46 1363
94250c4f
KW
1364/* Returns true if c is in the range l..u, where 'l' is non-negative
1365 * Written this way so that after optimization, only one conditional test is
4758c20d 1366 * needed. */
1eaefa6e 1367#define inRANGE(c, l, u) (__ASSERT_((u) >= (l)) \
4758c20d 1368 ( (sizeof(c) == sizeof(U8)) ? withinCOUNT(((U8) (c)), (l), ((u) - (l))) \
4758c20d
KW
1369 : (sizeof(c) == sizeof(U32)) ? withinCOUNT(((U32) (c)), (l), ((u) - (l))) \
1370 : (__ASSERT_(sizeof(c) == sizeof(WIDEST_UTYPE)) \
45f4bb73 1371 withinCOUNT(((WIDEST_UTYPE) (c)), (l), ((u) - (l))))))
305fe86e 1372
41f43cc2 1373#ifdef EBCDIC
b6340bd0 1374# ifndef _ALL_SOURCE
0852beac
KW
1375 /* The native libc isascii() et.al. functions return the wrong results
1376 * on at least z/OS unless this is defined. */
b6340bd0
KW
1377# error _ALL_SOURCE should probably be defined
1378# endif
41f43cc2 1379#else
0852beac
KW
1380 /* There is a simple definition of ASCII for ASCII platforms. But the
1381 * EBCDIC one isn't so simple, so is defined using table look-up like the
9c903d59 1382 * other macros below.
3f3c579d
KW
1383 *
1384 * The cast here is used instead of '(c) >= 0', because some compilers emit
1385 * a warning that that test is always true when the parameter is an
1386 * unsigned type. khw supposes that it could be written as
1387 * && ((c) == '\0' || (c) > 0)
1388 * to avoid the message, but the cast will likely avoid extra branches even
1389 * with stupid compilers.
1390 *
1391 * The '| 0' part ensures a compiler error if c is not integer (like e.g.,
1392 * a pointer) */
9c903d59 1393# define isASCII(c) ((WIDEST_UTYPE)((c) | 0) < 128)
41f43cc2
KW
1394#endif
1395
38694112
KW
1396/* Take the eight possible bit patterns of the lower 3 bits and you get the
1397 * lower 3 bits of the 8 octal digits, in both ASCII and EBCDIC, so those bits
1398 * can be ignored. If the rest match '0', we have an octal */
1399#define isOCTAL_A(c) (((WIDEST_UTYPE)((c) | 0) & ~7) == '0')
c2da0b36 1400
9fb1bf9d 1401#ifdef H_PERL /* If have access to perl.h, lookup in its table */
f4cdb42c 1402
a500dc72
KW
1403/* Character class numbers. For internal core Perl use only. The ones less
1404 * than 32 are used in PL_charclass[] and the ones up through the one that
1405 * corresponds to <_HIGHEST_REGCOMP_DOT_H_SYNC> are used by regcomp.h and
1406 * related files. PL_charclass ones use names used in l1_char_class_tab.h but
1407 * their actual definitions are here. If that file has a name not used here,
1408 * it won't compile.
1709d539
KW
1409 *
1410 * The first group of these is ordered in what I (khw) estimate to be the
31c7f561 1411 * frequency of their use. This gives a slight edge to exiting a loop earlier
58a3ba2c
KW
1412 * (in reginclass() in regexec.c). Except \v should be last, as it isn't a
1413 * real Posix character class, and some (small) inefficiencies in regular
1414 * expression handling would be introduced by putting it in the middle of those
1415 * that are. Also, cntrl and ascii come after the others as it may be useful
1416 * to group these which have no members that match above Latin1, (or above
1417 * ASCII in the latter case) */
1418
1709d539
KW
1419# define _CC_WORDCHAR 0 /* \w and [:word:] */
1420# define _CC_DIGIT 1 /* \d and [:digit:] */
1421# define _CC_ALPHA 2 /* [:alpha:] */
1422# define _CC_LOWER 3 /* [:lower:] */
1423# define _CC_UPPER 4 /* [:upper:] */
1424# define _CC_PUNCT 5 /* [:punct:] */
1425# define _CC_PRINT 6 /* [:print:] */
15861f94 1426# define _CC_ALPHANUMERIC 7 /* [:alnum:] */
1709d539 1427# define _CC_GRAPH 8 /* [:graph:] */
359b005e 1428# define _CC_CASED 9 /* [:lower:] or [:upper:] under /i */
779cf272 1429# define _CC_SPACE 10 /* \s, [:space:] */
b0d691b2
KW
1430# define _CC_BLANK 11 /* [:blank:] */
1431# define _CC_XDIGIT 12 /* [:xdigit:] */
779cf272
KW
1432# define _CC_CNTRL 13 /* [:cntrl:] */
1433# define _CC_ASCII 14 /* [:ascii:] */
1434# define _CC_VERTSPACE 15 /* \v */
1709d539 1435
a0947d7b
KW
1436# define _HIGHEST_REGCOMP_DOT_H_SYNC _CC_VERTSPACE
1437
1709d539 1438/* The members of the third group below do not need to be coordinated with data
3ffc8c70 1439 * structures in regcomp.[ch] and regexec.c. */
779cf272
KW
1440# define _CC_IDFIRST 16
1441# define _CC_CHARNAME_CONT 17
1442# define _CC_NONLATIN1_FOLD 18
1443# define _CC_NONLATIN1_SIMPLE_FOLD 19
1444# define _CC_QUOTEMETA 20
1445# define _CC_NON_FINAL_FOLD 21
1446# define _CC_IS_IN_SOME_FOLD 22
2ae9030c
KW
1447# define _CC_BINDIGIT 23
1448# define _CC_OCTDIGIT 24
1449# define _CC_MNEMONIC_CNTRL 25
073c22b3
KW
1450
1451/* This next group is only used on EBCDIC platforms, so theoretically could be
1452 * shared with something entirely different that's only on ASCII platforms */
abb8abf6 1453# define _CC_UTF8_START_BYTE_IS_FOR_AT_LEAST_SURROGATE 31
0654f0ab 1454/* Unused: 26-30
f4cdb42c
KW
1455 * If more bits are needed, one could add a second word for non-64bit
1456 * QUAD_IS_INT systems, using some #ifdefs to distinguish between having a 2nd
37ede926
KW
1457 * word or not. The IS_IN_SOME_FOLD bit is the most easily expendable, as it
1458 * is used only for optimization (as of this writing), and differs in the
1459 * Latin1 range from the ALPHA bit only in two relatively unimportant
a500dc72 1460 * characters: the masculine and feminine ordinal indicators, so removing it
073c22b3
KW
1461 * would just cause /i regexes which match them to run less efficiently.
1462 * Similarly the EBCDIC-only bits are used just for speed, and could be
1463 * replaced by other means */
96ac0975 1464
3a371f2f
KW
1465#if defined(PERL_CORE) || defined(PERL_EXT)
1466/* An enum version of the character class numbers, to help compilers
1467 * optimize */
1468typedef enum {
3a371f2f 1469 _CC_ENUM_ALPHA = _CC_ALPHA,
e8d596e0
KW
1470 _CC_ENUM_ALPHANUMERIC = _CC_ALPHANUMERIC,
1471 _CC_ENUM_ASCII = _CC_ASCII,
1472 _CC_ENUM_BLANK = _CC_BLANK,
b0d691b2 1473 _CC_ENUM_CASED = _CC_CASED,
e8d596e0 1474 _CC_ENUM_CNTRL = _CC_CNTRL,
3a371f2f
KW
1475 _CC_ENUM_DIGIT = _CC_DIGIT,
1476 _CC_ENUM_GRAPH = _CC_GRAPH,
1477 _CC_ENUM_LOWER = _CC_LOWER,
1478 _CC_ENUM_PRINT = _CC_PRINT,
1479 _CC_ENUM_PUNCT = _CC_PUNCT,
e8d596e0 1480 _CC_ENUM_SPACE = _CC_SPACE,
3a371f2f 1481 _CC_ENUM_UPPER = _CC_UPPER,
e8d596e0 1482 _CC_ENUM_VERTSPACE = _CC_VERTSPACE,
3a371f2f 1483 _CC_ENUM_WORDCHAR = _CC_WORDCHAR,
e8d596e0 1484 _CC_ENUM_XDIGIT = _CC_XDIGIT
3a371f2f
KW
1485} _char_class_number;
1486#endif
1487
86f72d56 1488#define POSIX_CC_COUNT (_HIGHEST_REGCOMP_DOT_H_SYNC + 1)
63c61c3f 1489
6635f04f 1490START_EXTERN_C
96ac0975
NC
1491# ifdef DOINIT
1492EXTCONST U32 PL_charclass[] = {
1493# include "l1_char_class_tab.h"
1494};
1495
1496# else /* ! DOINIT */
1497EXTCONST U32 PL_charclass[];
1498# endif
6635f04f 1499END_EXTERN_C
96ac0975 1500
265c1f46 1501 /* The 1U keeps Solaris from griping when shifting sets the uppermost bit */
430b7c70 1502# define _CC_mask(classnum) (1U << (classnum))
4650c663
KW
1503
1504 /* For internal core Perl use only: the base macro for defining macros like
1505 * isALPHA */
ff7ecfc3 1506# define _generic_isCC(c, classnum) cBOOL(FITS_IN_8_BITS(c) \
f4cd282c 1507 && (PL_charclass[(U8) (c)] & _CC_mask(classnum)))
4eeeb416 1508
f4cdb42c
KW
1509 /* The mask for the _A versions of the macros; it just adds in the bit for
1510 * ASCII. */
1511# define _CC_mask_A(classnum) (_CC_mask(classnum) | _CC_mask(_CC_ASCII))
1512
4650c663
KW
1513 /* For internal core Perl use only: the base macro for defining macros like
1514 * isALPHA_A. The foo_A version makes sure that both the desired bit and
1515 * the ASCII bit are present */
b7d90381
KW
1516# define _generic_isCC_A(c, classnum) (FITS_IN_8_BITS(c) \
1517 && ((PL_charclass[(U8) (c)] & _CC_mask_A(classnum)) \
1518 == _CC_mask_A(classnum)))
f4cdb42c 1519
26c1d9d8
KW
1520/* On ASCII platforms certain classes form a single range. It's faster to
1521 * special case these. isDIGIT is a single range on all platforms */
b877c1ff
KW
1522# ifdef EBCDIC
1523# define isALPHA_A(c) _generic_isCC_A(c, _CC_ALPHA)
1524# define isGRAPH_A(c) _generic_isCC_A(c, _CC_GRAPH)
1525# define isLOWER_A(c) _generic_isCC_A(c, _CC_LOWER)
1526# define isPRINT_A(c) _generic_isCC_A(c, _CC_PRINT)
1527# define isUPPER_A(c) _generic_isCC_A(c, _CC_UPPER)
1528# else
26c1d9d8 1529 /* By folding the upper and lowercase, we can use a single range */
b877c1ff 1530# define isALPHA_A(c) inRANGE((~('A' ^ 'a') & (c)), 'A', 'Z')
26c1d9d8 1531# define isGRAPH_A(c) inRANGE(c, ' ' + 1, 0x7e)
b877c1ff
KW
1532# define isLOWER_A(c) inRANGE(c, 'a', 'z')
1533# define isPRINT_A(c) inRANGE(c, ' ', 0x7e)
1534# define isUPPER_A(c) inRANGE(c, 'A', 'Z')
1535# endif
15861f94 1536# define isALPHANUMERIC_A(c) _generic_isCC_A(c, _CC_ALPHANUMERIC)
f4cdb42c
KW
1537# define isBLANK_A(c) _generic_isCC_A(c, _CC_BLANK)
1538# define isCNTRL_A(c) _generic_isCC_A(c, _CC_CNTRL)
b877c1ff 1539# define isDIGIT_A(c) inRANGE(c, '0', '9')
f4cdb42c
KW
1540# define isPUNCT_A(c) _generic_isCC_A(c, _CC_PUNCT)
1541# define isSPACE_A(c) _generic_isCC_A(c, _CC_SPACE)
f4cdb42c 1542# define isWORDCHAR_A(c) _generic_isCC_A(c, _CC_WORDCHAR)
b7d90381
KW
1543# define isXDIGIT_A(c) _generic_isCC(c, _CC_XDIGIT) /* No non-ASCII xdigits
1544 */
d95f8b6a 1545# define isIDFIRST_A(c) _generic_isCC_A(c, _CC_IDFIRST)
3ded5eb0
KW
1546# define isALPHA_L1(c) _generic_isCC(c, _CC_ALPHA)
1547# define isALPHANUMERIC_L1(c) _generic_isCC(c, _CC_ALPHANUMERIC)
1548# define isBLANK_L1(c) _generic_isCC(c, _CC_BLANK)
1549
1550 /* continuation character for legal NAME in \N{NAME} */
1551# define isCHARNAME_CONT(c) _generic_isCC(c, _CC_CHARNAME_CONT)
1552
1553# define isCNTRL_L1(c) _generic_isCC(c, _CC_CNTRL)
1554# define isGRAPH_L1(c) _generic_isCC(c, _CC_GRAPH)
1555# define isLOWER_L1(c) _generic_isCC(c, _CC_LOWER)
1556# define isPRINT_L1(c) _generic_isCC(c, _CC_PRINT)
b7d90381 1557# define isPSXSPC_L1(c) isSPACE_L1(c)
3ded5eb0
KW
1558# define isPUNCT_L1(c) _generic_isCC(c, _CC_PUNCT)
1559# define isSPACE_L1(c) _generic_isCC(c, _CC_SPACE)
1560# define isUPPER_L1(c) _generic_isCC(c, _CC_UPPER)
1561# define isWORDCHAR_L1(c) _generic_isCC(c, _CC_WORDCHAR)
1562# define isIDFIRST_L1(c) _generic_isCC(c, _CC_IDFIRST)
f4cdb42c 1563
0852beac
KW
1564# ifdef EBCDIC
1565# define isASCII(c) _generic_isCC(c, _CC_ASCII)
1566# endif
1567
f12c0118
KW
1568 /* Participates in a single-character fold with a character above 255 */
1569# define _HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) ((! cBOOL(FITS_IN_8_BITS(c))) || (PL_charclass[(U8) (c)] & _CC_mask(_CC_NONLATIN1_SIMPLE_FOLD)))
1570
1571 /* Like the above, but also can be part of a multi-char fold */
f4cd282c 1572# 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) (c)] & _CC_mask(_CC_NONLATIN1_FOLD)))
430b7c70 1573
4eeeb416 1574# define _isQUOTEMETA(c) _generic_isCC(c, _CC_QUOTEMETA)
26faadbd 1575# define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
b7d90381 1576 _generic_isCC(c, _CC_NON_FINAL_FOLD)
37ede926 1577# define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
b7d90381 1578 _generic_isCC(c, _CC_IS_IN_SOME_FOLD)
5e6ebb12
KW
1579
1580/* is c a control character for which we have a mnemonic? */
1581# if defined(PERL_CORE) || defined(PERL_EXT)
1582# define isMNEMONIC_CNTRL(c) _generic_isCC(c, _CC_MNEMONIC_CNTRL)
1583# endif
687c8d01 1584#else /* else we don't have perl.h H_PERL */
3ded5eb0
KW
1585
1586 /* If we don't have perl.h, we are compiling a utility program. Below we
1587 * hard-code various macro definitions that wouldn't otherwise be available
fc273927 1588 * to it. Most are coded based on first principles. These are written to
74665a89 1589 * avoid EBCDIC vs. ASCII #ifdef's as much as possible. */
182c4ace 1590# define isDIGIT_A(c) inRANGE(c, '0', '9')
0852beac 1591# define isBLANK_A(c) ((c) == ' ' || (c) == '\t')
74665a89
KW
1592# define isSPACE_A(c) (isBLANK_A(c) \
1593 || (c) == '\n' \
1594 || (c) == '\r' \
1595 || (c) == '\v' \
0852beac 1596 || (c) == '\f')
74665a89
KW
1597 /* On EBCDIC, there are gaps between 'i' and 'j'; 'r' and 's'. Same for
1598 * uppercase. The tests for those aren't necessary on ASCII, but hurt only
1599 * performance (if optimization isn't on), and allow the same code to be
1600 * used for both platform types */
182c4ace
KW
1601# define isLOWER_A(c) inRANGE((c), 'a', 'i') \
1602 || inRANGE((c), 'j', 'r') \
1603 || inRANGE((c), 's', 'z')
1604# define isUPPER_A(c) inRANGE((c), 'A', 'I') \
1605 || inRANGE((c), 'J', 'R') \
1606 || inRANGE((c), 'S', 'Z')
a4d7a999
KW
1607# define isALPHA_A(c) (isUPPER_A(c) || isLOWER_A(c))
1608# define isALPHANUMERIC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
3ded5eb0 1609# define isWORDCHAR_A(c) (isALPHANUMERIC_A(c) || (c) == '_')
0852beac 1610# define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_')
182c4ace
KW
1611# define isXDIGIT_A(c) ( isDIGIT_A(c) \
1612 || inRANGE((c), 'a', 'f') \
1613 || inRANGE((c), 'A', 'F')
74665a89
KW
1614# define isPUNCT_A(c) ((c) == '-' || (c) == '!' || (c) == '"' \
1615 || (c) == '#' || (c) == '$' || (c) == '%' \
1616 || (c) == '&' || (c) == '\'' || (c) == '(' \
1617 || (c) == ')' || (c) == '*' || (c) == '+' \
1618 || (c) == ',' || (c) == '.' || (c) == '/' \
1619 || (c) == ':' || (c) == ';' || (c) == '<' \
1620 || (c) == '=' || (c) == '>' || (c) == '?' \
1621 || (c) == '@' || (c) == '[' || (c) == '\\' \
1622 || (c) == ']' || (c) == '^' || (c) == '_' \
1623 || (c) == '`' || (c) == '{' || (c) == '|' \
1624 || (c) == '}' || (c) == '~')
1625# define isGRAPH_A(c) (isALPHANUMERIC_A(c) || isPUNCT_A(c))
1626# define isPRINT_A(c) (isGRAPH_A(c) || (c) == ' ')
3ded5eb0 1627
0852beac 1628# ifdef EBCDIC
74665a89
KW
1629 /* The below is accurate for the 3 EBCDIC code pages traditionally
1630 * supported by perl. The only difference between them in the controls
1631 * is the position of \n, and that is represented symbolically below */
1632# define isCNTRL_A(c) ((c) == '\0' || (c) == '\a' || (c) == '\b' \
1633 || (c) == '\f' || (c) == '\n' || (c) == '\r' \
1634 || (c) == '\t' || (c) == '\v' \
182c4ace 1635 || inRANGE((c), 1, 3) /* SOH, STX, ETX */ \
8ec0a736 1636 || (c) == 7F /* U+7F DEL */ \
182c4ace
KW
1637 || inRANGE((c), 0x0E, 0x13) /* SO SI DLE \
1638 DC[1-3] */ \
74665a89
KW
1639 || (c) == 0x18 /* U+18 CAN */ \
1640 || (c) == 0x19 /* U+19 EOM */ \
182c4ace 1641 || inRANGE((c), 0x1C, 0x1F) /* [FGRU]S */ \
74665a89
KW
1642 || (c) == 0x26 /* U+17 ETB */ \
1643 || (c) == 0x27 /* U+1B ESC */ \
1644 || (c) == 0x2D /* U+05 ENQ */ \
1645 || (c) == 0x2E /* U+06 ACK */ \
1646 || (c) == 0x32 /* U+16 SYN */ \
1647 || (c) == 0x37 /* U+04 EOT */ \
1648 || (c) == 0x3C /* U+14 DC4 */ \
1649 || (c) == 0x3D /* U+15 NAK */ \
1650 || (c) == 0x3F)/* U+1A SUB */
0852beac 1651# define isASCII(c) (isCNTRL_A(c) || isPRINT_A(c))
74665a89
KW
1652# else /* isASCII is already defined for ASCII platforms, so can use that to
1653 define isCNTRL */
1654# define isCNTRL_A(c) (isASCII(c) && ! isPRINT_A(c))
0852beac
KW
1655# endif
1656
3ffc8c70 1657 /* The _L1 macros may be unnecessary for the utilities; I (khw) added them
caa94d35
KW
1658 * during debugging, and it seems best to keep them. We may be called
1659 * without NATIVE_TO_LATIN1 being defined. On ASCII platforms, it doesn't
1660 * do anything anyway, so make it not a problem */
1661# if ! defined(EBCDIC) && ! defined(NATIVE_TO_LATIN1)
1662# define NATIVE_TO_LATIN1(ch) (ch)
1663# endif
3ded5eb0
KW
1664# define isALPHA_L1(c) (isUPPER_L1(c) || isLOWER_L1(c))
1665# define isALPHANUMERIC_L1(c) (isALPHA_L1(c) || isDIGIT_A(c))
1666# define isBLANK_L1(c) (isBLANK_A(c) \
1667 || (FITS_IN_8_BITS(c) \
1668 && NATIVE_TO_LATIN1((U8) c) == 0xA0))
1669# define isCNTRL_L1(c) (FITS_IN_8_BITS(c) && (! isPRINT_L1(c)))
1670# define isGRAPH_L1(c) (isPRINT_L1(c) && (! isBLANK_L1(c)))
1671# define isLOWER_L1(c) (isLOWER_A(c) \
1672 || (FITS_IN_8_BITS(c) \
ae683a5f 1673 && (( NATIVE_TO_LATIN1((U8) c) >= 0xDF \
3ded5eb0
KW
1674 && NATIVE_TO_LATIN1((U8) c) != 0xF7) \
1675 || NATIVE_TO_LATIN1((U8) c) == 0xAA \
1676 || NATIVE_TO_LATIN1((U8) c) == 0xBA \
1677 || NATIVE_TO_LATIN1((U8) c) == 0xB5)))
1678# define isPRINT_L1(c) (isPRINT_A(c) \
1679 || (FITS_IN_8_BITS(c) \
1680 && NATIVE_TO_LATIN1((U8) c) >= 0xA0))
3ded5eb0
KW
1681# define isPUNCT_L1(c) (isPUNCT_A(c) \
1682 || (FITS_IN_8_BITS(c) \
ae683a5f 1683 && ( NATIVE_TO_LATIN1((U8) c) == 0xA1 \
3ded5eb0
KW
1684 || NATIVE_TO_LATIN1((U8) c) == 0xA7 \
1685 || NATIVE_TO_LATIN1((U8) c) == 0xAB \
1686 || NATIVE_TO_LATIN1((U8) c) == 0xB6 \
1687 || NATIVE_TO_LATIN1((U8) c) == 0xB7 \
1688 || NATIVE_TO_LATIN1((U8) c) == 0xBB \
1689 || NATIVE_TO_LATIN1((U8) c) == 0xBF)))
1690# define isSPACE_L1(c) (isSPACE_A(c) \
1691 || (FITS_IN_8_BITS(c) \
ae683a5f 1692 && ( NATIVE_TO_LATIN1((U8) c) == 0x85 \
3ded5eb0
KW
1693 || NATIVE_TO_LATIN1((U8) c) == 0xA0)))
1694# define isUPPER_L1(c) (isUPPER_A(c) \
1695 || (FITS_IN_8_BITS(c) \
182c4ace
KW
1696 && ( IN_RANGE(NATIVE_TO_LATIN1((U8) c), \
1697 0xC0, 0xDE) \
3ded5eb0
KW
1698 && NATIVE_TO_LATIN1((U8) c) != 0xD7)))
1699# define isWORDCHAR_L1(c) (isIDFIRST_L1(c) || isDIGIT_A(c))
1700# define isIDFIRST_L1(c) (isALPHA_L1(c) || NATIVE_TO_LATIN1(c) == '_')
1701# define isCHARNAME_CONT(c) (isWORDCHAR_L1(c) \
1702 || isBLANK_L1(c) \
1703 || (c) == '-' \
1704 || (c) == '(' \
1705 || (c) == ')')
1706 /* The following are not fully accurate in the above-ASCII range. I (khw)
1707 * don't think it's necessary to be so for the purposes where this gets
1708 * compiled */
1709# define _isQUOTEMETA(c) (FITS_IN_8_BITS(c) && ! isWORDCHAR_L1(c))
1710# define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) isALPHA_L1(c)
1711
1712 /* And these aren't accurate at all. They are useful only for above
1713 * Latin1, which utilities and bootstrapping don't deal with */
1714# define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) 0
6838b41e 1715# define _HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) 0
3ded5eb0
KW
1716# define _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) 0
1717
1718 /* Many of the macros later in this file are defined in terms of these. By
1719 * implementing them with a function, which converts the class number into
1720 * a call to the desired macro, all of the later ones work. However, that
1721 * function won't be actually defined when building a utility program (no
1722 * perl.h), and so a compiler error will be generated if one is attempted
1723 * to be used. And the above-Latin1 code points require Unicode tables to
1724 * be present, something unlikely to be the case when bootstrapping */
1725# define _generic_isCC(c, classnum) \
1726 (FITS_IN_8_BITS(c) && S_bootstrap_ctype((U8) (c), (classnum), TRUE))
1727# define _generic_isCC_A(c, classnum) \
1728 (FITS_IN_8_BITS(c) && S_bootstrap_ctype((U8) (c), (classnum), FALSE))
687c8d01 1729#endif /* End of no perl.h H_PERL */
8a58bdcf 1730
e66b99e9
KW
1731#define isALPHANUMERIC(c) isALPHANUMERIC_A(c)
1732#define isALPHA(c) isALPHA_A(c)
0852beac
KW
1733#define isASCII_A(c) isASCII(c)
1734#define isASCII_L1(c) isASCII(c)
e66b99e9
KW
1735#define isBLANK(c) isBLANK_A(c)
1736#define isCNTRL(c) isCNTRL_A(c)
1737#define isDIGIT(c) isDIGIT_A(c)
1738#define isGRAPH(c) isGRAPH_A(c)
1739#define isIDFIRST(c) isIDFIRST_A(c)
1740#define isLOWER(c) isLOWER_A(c)
1741#define isPRINT(c) isPRINT_A(c)
779cf272 1742#define isPSXSPC_A(c) isSPACE_A(c)
e66b99e9 1743#define isPSXSPC(c) isPSXSPC_A(c)
779cf272 1744#define isPSXSPC_L1(c) isSPACE_L1(c)
e66b99e9
KW
1745#define isPUNCT(c) isPUNCT_A(c)
1746#define isSPACE(c) isSPACE_A(c)
1747#define isUPPER(c) isUPPER_A(c)
1748#define isWORDCHAR(c) isWORDCHAR_A(c)
1749#define isXDIGIT(c) isXDIGIT_A(c)
1750
1751/* ASCII casing. These could also be written as
1752 #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
1753 #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
1754 which uses table lookup and mask instead of subtraction. (This would
c5e9991e
KW
1755 work because the _MOD does not apply in the ASCII range).
1756
1757 These actually are UTF-8 invariant casing, not just ASCII, as any non-ASCII
1758 UTF-8 invariants are neither upper nor lower. (Only on EBCDIC platforms are
1759 there non-ASCII invariants, and all of them are controls.) */
68067e4e
DM
1760#define toLOWER(c) (isUPPER(c) ? (U8)((c) + ('a' - 'A')) : (c))
1761#define toUPPER(c) (isLOWER(c) ? (U8)((c) - ('a' - 'A')) : (c))
bbce6d69 1762
25200305
KW
1763/* In the ASCII range, these are equivalent to what they're here defined to be.
1764 * But by creating these definitions, other code doesn't have to be aware of
c5e9991e
KW
1765 * this detail. Actually this works for all UTF-8 invariants, not just the
1766 * ASCII range. (EBCDIC platforms can have non-ASCII invariants.) */
25200305 1767#define toFOLD(c) toLOWER(c)
25200305
KW
1768#define toTITLE(c) toUPPER(c)
1769
c753c8d3
KW
1770#define toLOWER_A(c) toLOWER(c)
1771#define toUPPER_A(c) toUPPER(c)
25200305
KW
1772#define toFOLD_A(c) toFOLD(c)
1773#define toTITLE_A(c) toTITLE(c)
1a0901db 1774
4650c663 1775/* Use table lookup for speed; returns the input itself if is out-of-range */
b2bf251f 1776#define toLOWER_LATIN1(c) ((! FITS_IN_8_BITS(c)) \
8e7c6e7d 1777 ? (c) \
f4cd282c 1778 : PL_latin1_lc[ (U8) (c) ])
c753c8d3
KW
1779#define toLOWER_L1(c) toLOWER_LATIN1(c) /* Synonym for consistency */
1780
1a0901db 1781/* Modified uc. Is correct uc except for three non-ascii chars which are
4650c663
KW
1782 * all mapped to one of them, and these need special handling; returns the
1783 * input itself if is out-of-range */
b2bf251f 1784#define toUPPER_LATIN1_MOD(c) ((! FITS_IN_8_BITS(c)) \
8e7c6e7d 1785 ? (c) \
f4cd282c 1786 : PL_mod_latin1_uc[ (U8) (c) ])
31f05a37 1787#define IN_UTF8_CTYPE_LOCALE PL_in_utf8_CTYPE_locale
84061b6a 1788
beab9ebe
KW
1789/* Use foo_LC_uvchr() instead of these for beyond the Latin1 range */
1790
1791/* For internal core Perl use only: the base macro for defining macros like
1792 * isALPHA_LC, which uses the current LC_CTYPE locale. 'c' is the code point
31f05a37
KW
1793 * (0-255) to check. In a UTF-8 locale, the result is the same as calling
1794 * isFOO_L1(); the 'utf8_locale_classnum' parameter is something like
1795 * _CC_UPPER, which gives the class number for doing this. For non-UTF-8
1796 * locales, the code to actually do the test this is passed in 'non_utf8'. If
1797 * 'c' is above 255, 0 is returned. For accessing the full range of possible
1798 * code points under locale rules, use the macros based on _generic_LC_uvchr
1799 * instead of this. */
beab9ebe
KW
1800#define _generic_LC_base(c, utf8_locale_classnum, non_utf8) \
1801 (! FITS_IN_8_BITS(c) \
1802 ? 0 \
31f05a37
KW
1803 : IN_UTF8_CTYPE_LOCALE \
1804 ? cBOOL(PL_charclass[(U8) (c)] & _CC_mask(utf8_locale_classnum)) \
beab9ebe
KW
1805 : cBOOL(non_utf8))
1806
1807/* For internal core Perl use only: a helper macro for defining macros like
1808 * isALPHA_LC. 'c' is the code point (0-255) to check. The function name to
1809 * actually do this test is passed in 'non_utf8_func', which is called on 'c',
1810 * casting 'c' to the macro _LC_CAST, which should not be parenthesized. See
1811 * _generic_LC_base for more info */
1812#define _generic_LC(c, utf8_locale_classnum, non_utf8_func) \
1813 _generic_LC_base(c,utf8_locale_classnum, \
1814 non_utf8_func( (_LC_CAST) (c)))
1815
1816/* For internal core Perl use only: like _generic_LC, but also returns TRUE if
1817 * 'c' is the platform's native underscore character */
1818#define _generic_LC_underscore(c,utf8_locale_classnum,non_utf8_func) \
1819 _generic_LC_base(c, utf8_locale_classnum, \
1820 (non_utf8_func( (_LC_CAST) (c)) \
1821 || (char)(c) == '_'))
1822
1823/* These next three are also for internal core Perl use only: case-change
247985d4
KW
1824 * helper macros. The reason for using the PL_latin arrays is in case the
1825 * system function is defective; it ensures uniform results that conform to the
b257a28c 1826 * Unicod standard. It does not handle the anomalies in UTF-8 Turkic locales */
beab9ebe
KW
1827#define _generic_toLOWER_LC(c, function, cast) (! FITS_IN_8_BITS(c) \
1828 ? (c) \
31f05a37
KW
1829 : (IN_UTF8_CTYPE_LOCALE) \
1830 ? PL_latin1_lc[ (U8) (c) ] \
5a10328c 1831 : (cast)function((cast)(c)))
beab9ebe 1832
31f05a37
KW
1833/* Note that the result can be larger than a byte in a UTF-8 locale. It
1834 * returns a single value, so can't adequately return the upper case of LATIN
1835 * SMALL LETTER SHARP S in a UTF-8 locale (which should be a string of two
1836 * values "SS"); instead it asserts against that under DEBUGGING, and
b257a28c
KW
1837 * otherwise returns its input. It does not handle the anomalies in UTF-8
1838 * Turkic locales. */
beab9ebe
KW
1839#define _generic_toUPPER_LC(c, function, cast) \
1840 (! FITS_IN_8_BITS(c) \
1841 ? (c) \
31f05a37 1842 : ((! IN_UTF8_CTYPE_LOCALE) \
b7d90381 1843 ? (cast)function((cast)(c)) \
31f05a37
KW
1844 : ((((U8)(c)) == MICRO_SIGN) \
1845 ? GREEK_CAPITAL_LETTER_MU \
1846 : ((((U8)(c)) == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS) \
1847 ? LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS \
1848 : ((((U8)(c)) == LATIN_SMALL_LETTER_SHARP_S) \
1849 ? (__ASSERT_(0) (c)) \
1850 : PL_mod_latin1_uc[ (U8) (c) ])))))
1851
1852/* Note that the result can be larger than a byte in a UTF-8 locale. It
1853 * returns a single value, so can't adequately return the fold case of LATIN
1854 * SMALL LETTER SHARP S in a UTF-8 locale (which should be a string of two
1855 * values "ss"); instead it asserts against that under DEBUGGING, and
b257a28c
KW
1856 * otherwise returns its input. It does not handle the anomalies in UTF-8
1857 * Turkic locales */
beab9ebe 1858#define _generic_toFOLD_LC(c, function, cast) \
4d7db1b9 1859 ((UNLIKELY((c) == MICRO_SIGN) && IN_UTF8_CTYPE_LOCALE) \
31f05a37 1860 ? GREEK_SMALL_LETTER_MU \
4d7db1b9
KW
1861 : (__ASSERT_(! IN_UTF8_CTYPE_LOCALE \
1862 || (c) != LATIN_SMALL_LETTER_SHARP_S) \
1863 _generic_toLOWER_LC(c, function, cast)))
beab9ebe 1864
84061b6a 1865/* Use the libc versions for these if available. */
f05550c0 1866#if defined(HAS_ISASCII)
84061b6a
KW
1867# define isASCII_LC(c) (FITS_IN_8_BITS(c) && isascii( (U8) (c)))
1868#else
1869# define isASCII_LC(c) isASCII(c)
1870#endif
1871
f05550c0 1872#if defined(HAS_ISBLANK)
84061b6a 1873# define isBLANK_LC(c) _generic_LC(c, _CC_BLANK, isblank)
95f34b6f 1874#else /* Unlike isASCII, varies if in a UTF-8 locale */
278b2b56 1875# define isBLANK_LC(c) ((IN_UTF8_CTYPE_LOCALE) ? isBLANK_L1(c) : isBLANK(c))
84061b6a
KW
1876#endif
1877
f05550c0 1878#define _LC_CAST U8
bbce6d69 1879
f05550c0 1880#ifdef WIN32
375f5f06
KW
1881 /* The Windows functions don't bother to follow the POSIX standard, which
1882 * for example says that something can't both be a printable and a control.
1883 * But Windows treats the \t control as a printable, and does such things
1884 * as making superscripts into both digits and punctuation. This tames
1885 * these flaws by assuming that the definitions of both controls and space
1886 * are correct, and then making sure that other definitions don't have
1887 * weirdnesses, by making sure that isalnum() isn't also ispunct(), etc.
1888 * Not all possible weirdnesses are checked for, just the ones that were
1889 * detected on actual Microsoft code pages */
1890
b7d90381
KW
1891# define isCNTRL_LC(c) _generic_LC(c, _CC_CNTRL, iscntrl)
1892# define isSPACE_LC(c) _generic_LC(c, _CC_SPACE, isspace)
1893
1894# define isALPHA_LC(c) (_generic_LC(c, _CC_ALPHA, isalpha) \
1895 && isALPHANUMERIC_LC(c))
1896# define isALPHANUMERIC_LC(c) (_generic_LC(c, _CC_ALPHANUMERIC, isalnum) && \
1897 ! isPUNCT_LC(c))
1898# define isDIGIT_LC(c) (_generic_LC(c, _CC_DIGIT, isdigit) && \
1899 isALPHANUMERIC_LC(c))
1900# define isGRAPH_LC(c) (_generic_LC(c, _CC_GRAPH, isgraph) && isPRINT_LC(c))
1901# define isIDFIRST_LC(c) (((c) == '_') \
1902 || (_generic_LC(c, _CC_IDFIRST, isalpha) && ! isPUNCT_LC(c)))
1903# define isLOWER_LC(c) (_generic_LC(c, _CC_LOWER, islower) && isALPHA_LC(c))
1904# define isPRINT_LC(c) (_generic_LC(c, _CC_PRINT, isprint) && ! isCNTRL_LC(c))
1905# define isPUNCT_LC(c) (_generic_LC(c, _CC_PUNCT, ispunct) && ! isCNTRL_LC(c))
1906# define isUPPER_LC(c) (_generic_LC(c, _CC_UPPER, isupper) && isALPHA_LC(c))
f05550c0 1907# define isWORDCHAR_LC(c) (((c) == '_') || isALPHANUMERIC_LC(c))
b7d90381
KW
1908# define isXDIGIT_LC(c) (_generic_LC(c, _CC_XDIGIT, isxdigit) \
1909 && isALPHANUMERIC_LC(c))
f05550c0
BF
1910
1911# define toLOWER_LC(c) _generic_toLOWER_LC((c), tolower, U8)
1912# define toUPPER_LC(c) _generic_toUPPER_LC((c), toupper, U8)
1913# define toFOLD_LC(c) _generic_toFOLD_LC((c), tolower, U8)
1914
1915#elif defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
4650c663 1916 /* For most other platforms */
beab9ebe 1917
f05550c0
BF
1918# define isALPHA_LC(c) _generic_LC(c, _CC_ALPHA, isalpha)
1919# define isALPHANUMERIC_LC(c) _generic_LC(c, _CC_ALPHANUMERIC, isalnum)
1920# define isCNTRL_LC(c) _generic_LC(c, _CC_CNTRL, iscntrl)
1921# define isDIGIT_LC(c) _generic_LC(c, _CC_DIGIT, isdigit)
1922# define isGRAPH_LC(c) _generic_LC(c, _CC_GRAPH, isgraph)
1923# define isIDFIRST_LC(c) _generic_LC_underscore(c, _CC_IDFIRST, isalpha)
1924# define isLOWER_LC(c) _generic_LC(c, _CC_LOWER, islower)
1925# define isPRINT_LC(c) _generic_LC(c, _CC_PRINT, isprint)
1926# define isPUNCT_LC(c) _generic_LC(c, _CC_PUNCT, ispunct)
1927# define isSPACE_LC(c) _generic_LC(c, _CC_SPACE, isspace)
1928# define isUPPER_LC(c) _generic_LC(c, _CC_UPPER, isupper)
1929# define isWORDCHAR_LC(c) _generic_LC_underscore(c, _CC_WORDCHAR, isalnum)
1930# define isXDIGIT_LC(c) _generic_LC(c, _CC_XDIGIT, isxdigit)
1931
1932
1933# define toLOWER_LC(c) _generic_toLOWER_LC((c), tolower, U8)
1934# define toUPPER_LC(c) _generic_toUPPER_LC((c), toupper, U8)
1935# define toFOLD_LC(c) _generic_toFOLD_LC((c), tolower, U8)
1936
1937#else /* The final fallback position */
1938
b7d90381
KW
1939# define isALPHA_LC(c) (isascii(c) && isalpha(c))
1940# define isALPHANUMERIC_LC(c) (isascii(c) && isalnum(c))
1941# define isCNTRL_LC(c) (isascii(c) && iscntrl(c))
1942# define isDIGIT_LC(c) (isascii(c) && isdigit(c))
1943# define isGRAPH_LC(c) (isascii(c) && isgraph(c))
f05550c0 1944# define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
b7d90381
KW
1945# define isLOWER_LC(c) (isascii(c) && islower(c))
1946# define isPRINT_LC(c) (isascii(c) && isprint(c))
1947# define isPUNCT_LC(c) (isascii(c) && ispunct(c))
1948# define isSPACE_LC(c) (isascii(c) && isspace(c))
1949# define isUPPER_LC(c) (isascii(c) && isupper(c))
f05550c0 1950# define isWORDCHAR_LC(c) (isascii(c) && (isalnum(c) || (c) == '_'))
b7d90381 1951# define isXDIGIT_LC(c) (isascii(c) && isxdigit(c))
f05550c0
BF
1952
1953# define toLOWER_LC(c) (isascii(c) ? tolower(c) : (c))
1954# define toUPPER_LC(c) (isascii(c) ? toupper(c) : (c))
1955# define toFOLD_LC(c) (isascii(c) ? tolower(c) : (c))
bbce6d69 1956
f05550c0 1957#endif
55204971 1958
eba68aa0
KW
1959#define isIDCONT(c) isWORDCHAR(c)
1960#define isIDCONT_A(c) isWORDCHAR_A(c)
1961#define isIDCONT_L1(c) isWORDCHAR_L1(c)
1962#define isIDCONT_LC(c) isWORDCHAR_LC(c)
13380643 1963#define isPSXSPC_LC(c) isSPACE_LC(c)
aaa51d5e 1964
4650c663 1965/* For internal core Perl use only: the base macros for defining macros like
d0da05db
KW
1966 * isALPHA_uvchr. 'c' is the code point to check. 'classnum' is the POSIX class
1967 * number defined earlier in this file. _generic_uvchr() is used for POSIX
4650c663
KW
1968 * classes where there is a macro or function 'above_latin1' that takes the
1969 * single argument 'c' and returns the desired value. These exist for those
2366ba44
KW
1970 * classes which have simple definitions, avoiding the overhead of an inversion
1971 * list binary search. _generic_invlist_uvchr() can be used
4650c663 1972 * for classes where that overhead is faster than a direct lookup.
d0da05db 1973 * _generic_uvchr() won't compile if 'c' isn't unsigned, as it won't match the
4650c663
KW
1974 * 'above_latin1' prototype. _generic_isCC() macro does bounds checking, so
1975 * have duplicate checks here, so could create versions of the macros that
1976 * don't, but experiments show that gcc optimizes them out anyway. */
66c17564
KW
1977
1978/* Note that all ignore 'use bytes' */
1e222e4f
KW
1979#define _generic_uvchr(classnum, above_latin1, c) ((c) < 256 \
1980 ? _generic_isCC(c, classnum) \
cd500f2f 1981 : above_latin1(c))
2366ba44 1982#define _generic_invlist_uvchr(classnum, c) ((c) < 256 \
1e222e4f 1983 ? _generic_isCC(c, classnum) \
922e8cb4 1984 : _is_uni_FOO(classnum, c))
2366ba44
KW
1985#define isALPHA_uvchr(c) _generic_invlist_uvchr(_CC_ALPHA, c)
1986#define isALPHANUMERIC_uvchr(c) _generic_invlist_uvchr(_CC_ALPHANUMERIC, c)
d0da05db
KW
1987#define isASCII_uvchr(c) isASCII(c)
1988#define isBLANK_uvchr(c) _generic_uvchr(_CC_BLANK, is_HORIZWS_cp_high, c)
1989#define isCNTRL_uvchr(c) isCNTRL_L1(c) /* All controls are in Latin1 */
2366ba44
KW
1990#define isDIGIT_uvchr(c) _generic_invlist_uvchr(_CC_DIGIT, c)
1991#define isGRAPH_uvchr(c) _generic_invlist_uvchr(_CC_GRAPH, c)
1e222e4f
KW
1992#define isIDCONT_uvchr(c) \
1993 _generic_uvchr(_CC_WORDCHAR, _is_uni_perl_idcont, c)
1994#define isIDFIRST_uvchr(c) \
1995 _generic_uvchr(_CC_IDFIRST, _is_uni_perl_idstart, c)
2366ba44
KW
1996#define isLOWER_uvchr(c) _generic_invlist_uvchr(_CC_LOWER, c)
1997#define isPRINT_uvchr(c) _generic_invlist_uvchr(_CC_PRINT, c)
d0da05db 1998
2366ba44 1999#define isPUNCT_uvchr(c) _generic_invlist_uvchr(_CC_PUNCT, c)
d0da05db
KW
2000#define isSPACE_uvchr(c) _generic_uvchr(_CC_SPACE, is_XPERLSPACE_cp_high, c)
2001#define isPSXSPC_uvchr(c) isSPACE_uvchr(c)
2002
2366ba44 2003#define isUPPER_uvchr(c) _generic_invlist_uvchr(_CC_UPPER, c)
d0da05db 2004#define isVERTWS_uvchr(c) _generic_uvchr(_CC_VERTSPACE, is_VERTWS_cp_high, c)
2366ba44 2005#define isWORDCHAR_uvchr(c) _generic_invlist_uvchr(_CC_WORDCHAR, c)
d0da05db
KW
2006#define isXDIGIT_uvchr(c) _generic_uvchr(_CC_XDIGIT, is_XDIGIT_cp_high, c)
2007
2008#define toFOLD_uvchr(c,s,l) to_uni_fold(c,s,l)
2009#define toLOWER_uvchr(c,s,l) to_uni_lower(c,s,l)
2010#define toTITLE_uvchr(c,s,l) to_uni_title(c,s,l)
2011#define toUPPER_uvchr(c,s,l) to_uni_upper(c,s,l)
2012
2013/* For backwards compatibility, even though '_uni' should mean official Unicode
2014 * code points, in Perl it means native for those below 256 */
2015#define isALPHA_uni(c) isALPHA_uvchr(c)
2016#define isALPHANUMERIC_uni(c) isALPHANUMERIC_uvchr(c)
2017#define isASCII_uni(c) isASCII_uvchr(c)
2018#define isBLANK_uni(c) isBLANK_uvchr(c)
2019#define isCNTRL_uni(c) isCNTRL_uvchr(c)
2020#define isDIGIT_uni(c) isDIGIT_uvchr(c)
2021#define isGRAPH_uni(c) isGRAPH_uvchr(c)
2022#define isIDCONT_uni(c) isIDCONT_uvchr(c)
2023#define isIDFIRST_uni(c) isIDFIRST_uvchr(c)
2024#define isLOWER_uni(c) isLOWER_uvchr(c)
2025#define isPRINT_uni(c) isPRINT_uvchr(c)
2026#define isPUNCT_uni(c) isPUNCT_uvchr(c)
2027#define isSPACE_uni(c) isSPACE_uvchr(c)
2028#define isPSXSPC_uni(c) isPSXSPC_uvchr(c)
2029#define isUPPER_uni(c) isUPPER_uvchr(c)
2030#define isVERTWS_uni(c) isVERTWS_uvchr(c)
2031#define isWORDCHAR_uni(c) isWORDCHAR_uvchr(c)
2032#define isXDIGIT_uni(c) isXDIGIT_uvchr(c)
2033#define toFOLD_uni(c,s,l) toFOLD_uvchr(c,s,l)
2034#define toLOWER_uni(c,s,l) toLOWER_uvchr(c,s,l)
2035#define toTITLE_uni(c,s,l) toTITLE_uvchr(c,s,l)
2036#define toUPPER_uni(c,s,l) toUPPER_uvchr(c,s,l)
a0ed51b3 2037
4650c663
KW
2038/* For internal core Perl use only: the base macros for defining macros like
2039 * isALPHA_LC_uvchr. These are like isALPHA_LC, but the input can be any code
d0da05db 2040 * point, not just 0-255. Like _generic_uvchr, there are two versions, one for
4650c663 2041 * simple class definitions; the other for more complex. These are like
d0da05db 2042 * _generic_uvchr, so see it for more info. */
cd500f2f
KW
2043#define _generic_LC_uvchr(latin1, above_latin1, c) \
2044 (c < 256 ? latin1(c) : above_latin1(c))
2366ba44 2045#define _generic_LC_invlist_uvchr(latin1, classnum, c) \
cd500f2f
KW
2046 (c < 256 ? latin1(c) : _is_uni_FOO(classnum, c))
2047
2366ba44
KW
2048#define isALPHA_LC_uvchr(c) _generic_LC_invlist_uvchr(isALPHA_LC, _CC_ALPHA, c)
2049#define isALPHANUMERIC_LC_uvchr(c) _generic_LC_invlist_uvchr(isALPHANUMERIC_LC, \
cd500f2f 2050 _CC_ALPHANUMERIC, c)
b7d90381
KW
2051#define isASCII_LC_uvchr(c) isASCII_LC(c)
2052#define isBLANK_LC_uvchr(c) _generic_LC_uvchr(isBLANK_LC, \
2053 is_HORIZWS_cp_high, c)
feeab5a9 2054#define isCNTRL_LC_uvchr(c) (c < 256 ? isCNTRL_LC(c) : 0)
2366ba44
KW
2055#define isDIGIT_LC_uvchr(c) _generic_LC_invlist_uvchr(isDIGIT_LC, _CC_DIGIT, c)
2056#define isGRAPH_LC_uvchr(c) _generic_LC_invlist_uvchr(isGRAPH_LC, _CC_GRAPH, c)
b7d90381 2057#define isIDCONT_LC_uvchr(c) _generic_LC_uvchr(isIDCONT_LC, \
eba68aa0 2058 _is_uni_perl_idcont, c)
b7d90381 2059#define isIDFIRST_LC_uvchr(c) _generic_LC_uvchr(isIDFIRST_LC, \
cd500f2f 2060 _is_uni_perl_idstart, c)
2366ba44
KW
2061#define isLOWER_LC_uvchr(c) _generic_LC_invlist_uvchr(isLOWER_LC, _CC_LOWER, c)
2062#define isPRINT_LC_uvchr(c) _generic_LC_invlist_uvchr(isPRINT_LC, _CC_PRINT, c)
b7d90381 2063#define isPSXSPC_LC_uvchr(c) isSPACE_LC_uvchr(c)
2366ba44 2064#define isPUNCT_LC_uvchr(c) _generic_LC_invlist_uvchr(isPUNCT_LC, _CC_PUNCT, c)
b7d90381 2065#define isSPACE_LC_uvchr(c) _generic_LC_uvchr(isSPACE_LC, \
509fb054 2066 is_XPERLSPACE_cp_high, c)
2366ba44
KW
2067#define isUPPER_LC_uvchr(c) _generic_LC_invlist_uvchr(isUPPER_LC, _CC_UPPER, c)
2068#define isWORDCHAR_LC_uvchr(c) _generic_LC_invlist_uvchr(isWORDCHAR_LC, \
cd500f2f 2069 _CC_WORDCHAR, c)
b7d90381
KW
2070#define isXDIGIT_LC_uvchr(c) _generic_LC_uvchr(isXDIGIT_LC, \
2071 is_XDIGIT_cp_high, c)
e712593e 2072
b7d90381 2073#define isBLANK_LC_uni(c) isBLANK_LC_uvchr(UNI_TO_NATIVE(c))
aaa51d5e 2074
da8c1a98
KW
2075/* The "_safe" macros make sure that we don't attempt to read beyond 'e', but
2076 * they don't otherwise go out of their way to look for malformed UTF-8. If
2077 * they can return accurate results without knowing if the input is otherwise
2078 * malformed, they do so. For example isASCII is accurate in spite of any
2079 * non-length malformations because it looks only at a single byte. Likewise
2080 * isDIGIT looks just at the first byte for code points 0-255, as all UTF-8
2081 * variant ones return FALSE. But, if the input has to be well-formed in order
2082 * for the results to be accurate, the macros will test and if malformed will
2083 * call a routine to die
2084 *
2085 * Except for toke.c, the macros do assume that e > p, asserting that on
2086 * DEBUGGING builds. Much code that calls these depends on this being true,
2087 * for other reasons. toke.c is treated specially as using the regular
2088 * assertion breaks it in many ways. All strings that these operate on there
2089 * are supposed to have an extra NUL character at the end, so that *e = \0. A
2090 * bunch of code in toke.c assumes that this is true, so the assertion allows
2091 * for that */
2092#ifdef PERL_IN_TOKE_C
2093# define _utf8_safe_assert(p,e) ((e) > (p) || ((e) == (p) && *(p) == '\0'))
2094#else
2095# define _utf8_safe_assert(p,e) ((e) > (p))
2096#endif
2097
2098#define _generic_utf8_safe(classnum, p, e, above_latin1) \
c81b3562
KW
2099 ((! _utf8_safe_assert(p, e)) \
2100 ? (_force_out_malformed_utf8_message((U8 *) (p), (U8 *) (e), 0, 1), 0)\
2101 : (UTF8_IS_INVARIANT(*(p))) \
da8c1a98
KW
2102 ? _generic_isCC(*(p), classnum) \
2103 : (UTF8_IS_DOWNGRADEABLE_START(*(p)) \
2104 ? ((LIKELY((e) - (p) > 1 && UTF8_IS_CONTINUATION(*((p)+1)))) \
2105 ? _generic_isCC(EIGHT_BIT_UTF8_TO_NATIVE(*(p), *((p)+1 )), \
2106 classnum) \
2107 : (_force_out_malformed_utf8_message( \
2108 (U8 *) (p), (U8 *) (e), 0, 1), 0)) \
2109 : above_latin1))
b7d90381
KW
2110/* Like the above, but calls 'above_latin1(p)' to get the utf8 value.
2111 * 'above_latin1' can be a macro */
da8c1a98
KW
2112#define _generic_func_utf8_safe(classnum, above_latin1, p, e) \
2113 _generic_utf8_safe(classnum, p, e, above_latin1(p, e))
2366ba44 2114#define _generic_non_invlist_utf8_safe(classnum, above_latin1, p, e) \
da8c1a98
KW
2115 _generic_utf8_safe(classnum, p, e, \
2116 (UNLIKELY((e) - (p) < UTF8SKIP(p)) \
2117 ? (_force_out_malformed_utf8_message( \
2118 (U8 *) (p), (U8 *) (e), 0, 1), 0) \
2119 : above_latin1(p)))
2366ba44
KW
2120/* Like the above, but passes classnum to _isFOO_utf8(), instead of having an
2121 * 'above_latin1' parameter */
2122#define _generic_invlist_utf8_safe(classnum, p, e) \
2123 _generic_utf8_safe(classnum, p, e, _is_utf8_FOO(classnum, p, e))
922e8cb4 2124
cc8ab7c0 2125/* Like the above, but should be used only when it is known that there are no
ff7ecfc3
KW
2126 * characters in the upper-Latin1 range (128-255 on ASCII platforms) which the
2127 * class is TRUE for. Hence it can skip the tests for this range.
2128 * 'above_latin1' should include its arguments */
da8c1a98
KW
2129#define _generic_utf8_safe_no_upper_latin1(classnum, p, e, above_latin1) \
2130 (__ASSERT_(_utf8_safe_assert(p, e)) \
2131 (UTF8_IS_INVARIANT(*(p))) \
2132 ? _generic_isCC(*(p), classnum) \
2133 : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
2134 ? 0 /* Note that doesn't check validity for latin1 */ \
2135 : above_latin1)
2136
84238efa 2137
059703b0
KW
2138#define isALPHA_utf8(p, e) isALPHA_utf8_safe(p, e)
2139#define isALPHANUMERIC_utf8(p, e) isALPHANUMERIC_utf8_safe(p, e)
2140#define isASCII_utf8(p, e) isASCII_utf8_safe(p, e)
2141#define isBLANK_utf8(p, e) isBLANK_utf8_safe(p, e)
2142#define isCNTRL_utf8(p, e) isCNTRL_utf8_safe(p, e)
2143#define isDIGIT_utf8(p, e) isDIGIT_utf8_safe(p, e)
2144#define isGRAPH_utf8(p, e) isGRAPH_utf8_safe(p, e)
2145#define isIDCONT_utf8(p, e) isIDCONT_utf8_safe(p, e)
2146#define isIDFIRST_utf8(p, e) isIDFIRST_utf8_safe(p, e)
2147#define isLOWER_utf8(p, e) isLOWER_utf8_safe(p, e)
2148#define isPRINT_utf8(p, e) isPRINT_utf8_safe(p, e)
2149#define isPSXSPC_utf8(p, e) isPSXSPC_utf8_safe(p, e)
2150#define isPUNCT_utf8(p, e) isPUNCT_utf8_safe(p, e)
2151#define isSPACE_utf8(p, e) isSPACE_utf8_safe(p, e)
2152#define isUPPER_utf8(p, e) isUPPER_utf8_safe(p, e)
2153#define isVERTWS_utf8(p, e) isVERTWS_utf8_safe(p, e)
2154#define isWORDCHAR_utf8(p, e) isWORDCHAR_utf8_safe(p, e)
2155#define isXDIGIT_utf8(p, e) isXDIGIT_utf8_safe(p, e)
e8fa43e2 2156
2366ba44 2157#define isALPHA_utf8_safe(p, e) _generic_invlist_utf8_safe(_CC_ALPHA, p, e)
da8c1a98 2158#define isALPHANUMERIC_utf8_safe(p, e) \
2366ba44 2159 _generic_invlist_utf8_safe(_CC_ALPHANUMERIC, p, e)
da8c1a98
KW
2160#define isASCII_utf8_safe(p, e) \
2161 /* Because ASCII is invariant under utf8, the non-utf8 macro \
2162 * works */ \
2163 (__ASSERT_(_utf8_safe_assert(p, e)) isASCII(*(p)))
2164#define isBLANK_utf8_safe(p, e) \
2366ba44 2165 _generic_non_invlist_utf8_safe(_CC_BLANK, is_HORIZWS_high, p, e)
da8c1a98 2166
e8fa43e2
KW
2167#ifdef EBCDIC
2168 /* Because all controls are UTF-8 invariants in EBCDIC, we can use this
2169 * more efficient macro instead of the more general one */
da8c1a98 2170# define isCNTRL_utf8_safe(p, e) \
56d02b8c 2171 (__ASSERT_(_utf8_safe_assert(p, e)) isCNTRL_L1(*(p)))
e8fa43e2 2172#else
da8c1a98 2173# define isCNTRL_utf8_safe(p, e) _generic_utf8_safe(_CC_CNTRL, p, e, 0)
e8fa43e2
KW
2174#endif
2175
da8c1a98
KW
2176#define isDIGIT_utf8_safe(p, e) \
2177 _generic_utf8_safe_no_upper_latin1(_CC_DIGIT, p, e, \
2366ba44
KW
2178 _is_utf8_FOO(_CC_DIGIT, p, e))
2179#define isGRAPH_utf8_safe(p, e) _generic_invlist_utf8_safe(_CC_GRAPH, p, e)
da8c1a98 2180#define isIDCONT_utf8_safe(p, e) _generic_func_utf8_safe(_CC_WORDCHAR, \
dd1a3ba7 2181 _is_utf8_perl_idcont, p, e)
e5dcd934 2182
c11ff943
KW
2183/* To prevent S_scan_word in toke.c from hanging, we have to make sure that
2184 * IDFIRST is an alnum. See
8034715d 2185 * https://github.com/Perl/perl5/issues/10275 for more detail than you
f91dcd13
KW
2186 * ever wanted to know about. (In the ASCII range, there isn't a difference.)
2187 * This used to be not the XID version, but we decided to go with the more
2188 * modern Unicode definition */
da8c1a98
KW
2189#define isIDFIRST_utf8_safe(p, e) \
2190 _generic_func_utf8_safe(_CC_IDFIRST, \
dd1a3ba7 2191 _is_utf8_perl_idstart, (U8 *) (p), (U8 *) (e))
da8c1a98 2192
2366ba44
KW
2193#define isLOWER_utf8_safe(p, e) _generic_invlist_utf8_safe(_CC_LOWER, p, e)
2194#define isPRINT_utf8_safe(p, e) _generic_invlist_utf8_safe(_CC_PRINT, p, e)
da8c1a98 2195#define isPSXSPC_utf8_safe(p, e) isSPACE_utf8_safe(p, e)
2366ba44 2196#define isPUNCT_utf8_safe(p, e) _generic_invlist_utf8_safe(_CC_PUNCT, p, e)
da8c1a98 2197#define isSPACE_utf8_safe(p, e) \
2366ba44
KW
2198 _generic_non_invlist_utf8_safe(_CC_SPACE, is_XPERLSPACE_high, p, e)
2199#define isUPPER_utf8_safe(p, e) _generic_invlist_utf8_safe(_CC_UPPER, p, e)
da8c1a98 2200#define isVERTWS_utf8_safe(p, e) \
2366ba44 2201 _generic_non_invlist_utf8_safe(_CC_VERTSPACE, is_VERTWS_high, p, e)
da8c1a98 2202#define isWORDCHAR_utf8_safe(p, e) \
2366ba44 2203 _generic_invlist_utf8_safe(_CC_WORDCHAR, p, e)
da8c1a98
KW
2204#define isXDIGIT_utf8_safe(p, e) \
2205 _generic_utf8_safe_no_upper_latin1(_CC_XDIGIT, p, e, \
2206 (UNLIKELY((e) - (p) < UTF8SKIP(p)) \
2207 ? (_force_out_malformed_utf8_message( \
2208 (U8 *) (p), (U8 *) (e), 0, 1), 0) \
2209 : is_XDIGIT_high(p)))
a0ed51b3 2210
059703b0
KW
2211#define toFOLD_utf8(p,e,s,l) toFOLD_utf8_safe(p,e,s,l)
2212#define toLOWER_utf8(p,e,s,l) toLOWER_utf8_safe(p,e,s,l)
2213#define toTITLE_utf8(p,e,s,l) toTITLE_utf8_safe(p,e,s,l)
2214#define toUPPER_utf8(p,e,s,l) toUPPER_utf8_safe(p,e,s,l)
2e8adce6 2215
567b353c 2216/* For internal core use only, subject to change */
059703b0
KW
2217#define _toFOLD_utf8_flags(p,e,s,l,f) _to_utf8_fold_flags (p,e,s,l,f)
2218#define _toLOWER_utf8_flags(p,e,s,l,f) _to_utf8_lower_flags(p,e,s,l,f)
2219#define _toTITLE_utf8_flags(p,e,s,l,f) _to_utf8_title_flags(p,e,s,l,f)
2220#define _toUPPER_utf8_flags(p,e,s,l,f) _to_utf8_upper_flags(p,e,s,l,f)
a1a5ec35
KW
2221
2222#define toFOLD_utf8_safe(p,e,s,l) _toFOLD_utf8_flags(p,e,s,l, FOLD_FLAGS_FULL)
2223#define toLOWER_utf8_safe(p,e,s,l) _toLOWER_utf8_flags(p,e,s,l, 0)
2224#define toTITLE_utf8_safe(p,e,s,l) _toTITLE_utf8_flags(p,e,s,l, 0)
2225#define toUPPER_utf8_safe(p,e,s,l) _toUPPER_utf8_flags(p,e,s,l, 0)
567b353c 2226
059703b0
KW
2227#define isALPHA_LC_utf8(p, e) isALPHA_LC_utf8_safe(p, e)
2228#define isALPHANUMERIC_LC_utf8(p, e) isALPHANUMERIC_LC_utf8_safe(p, e)
2229#define isASCII_LC_utf8(p, e) isASCII_LC_utf8_safe(p, e)
2230#define isBLANK_LC_utf8(p, e) isBLANK_LC_utf8_safe(p, e)
2231#define isCNTRL_LC_utf8(p, e) isCNTRL_LC_utf8_safe(p, e)
2232#define isDIGIT_LC_utf8(p, e) isDIGIT_LC_utf8_safe(p, e)
2233#define isGRAPH_LC_utf8(p, e) isGRAPH_LC_utf8_safe(p, e)
2234#define isIDCONT_LC_utf8(p, e) isIDCONT_LC_utf8_safe(p, e)
2235#define isIDFIRST_LC_utf8(p, e) isIDFIRST_LC_utf8_safe(p, e)
2236#define isLOWER_LC_utf8(p, e) isLOWER_LC_utf8_safe(p, e)
2237#define isPRINT_LC_utf8(p, e) isPRINT_LC_utf8_safe(p, e)
2238#define isPSXSPC_LC_utf8(p, e) isPSXSPC_LC_utf8_safe(p, e)
2239#define isPUNCT_LC_utf8(p, e) isPUNCT_LC_utf8_safe(p, e)
2240#define isSPACE_LC_utf8(p, e) isSPACE_LC_utf8_safe(p, e)
2241#define isUPPER_LC_utf8(p, e) isUPPER_LC_utf8_safe(p, e)
2242#define isWORDCHAR_LC_utf8(p, e) isWORDCHAR_LC_utf8_safe(p, e)
2243#define isXDIGIT_LC_utf8(p, e) isXDIGIT_LC_utf8_safe(p, e)
34aeb2e9 2244
da8c1a98
KW
2245/* For internal core Perl use only: the base macros for defining macros like
2246 * isALPHA_LC_utf8_safe. These are like _generic_utf8, but if the first code
2247 * point in 'p' is within the 0-255 range, it uses locale rules from the
2248 * passed-in 'macro' parameter */
2249#define _generic_LC_utf8_safe(macro, p, e, above_latin1) \
2250 (__ASSERT_(_utf8_safe_assert(p, e)) \
2251 (UTF8_IS_INVARIANT(*(p))) \
2252 ? macro(*(p)) \
2253 : (UTF8_IS_DOWNGRADEABLE_START(*(p)) \
2254 ? ((LIKELY((e) - (p) > 1 && UTF8_IS_CONTINUATION(*((p)+1)))) \
2255 ? macro(EIGHT_BIT_UTF8_TO_NATIVE(*(p), *((p)+1))) \
2256 : (_force_out_malformed_utf8_message( \
2257 (U8 *) (p), (U8 *) (e), 0, 1), 0)) \
2258 : above_latin1))
2259
2366ba44
KW
2260#define _generic_LC_invlist_utf8_safe(macro, classnum, p, e) \
2261 _generic_LC_utf8_safe(macro, p, e, \
2262 _is_utf8_FOO(classnum, p, e))
da8c1a98
KW
2263
2264#define _generic_LC_func_utf8_safe(macro, above_latin1, p, e) \
2265 _generic_LC_utf8_safe(macro, p, e, above_latin1(p, e))
2266
2366ba44 2267#define _generic_LC_non_invlist_utf8_safe(classnum, above_latin1, p, e) \
da8c1a98
KW
2268 _generic_LC_utf8_safe(classnum, p, e, \
2269 (UNLIKELY((e) - (p) < UTF8SKIP(p)) \
2270 ? (_force_out_malformed_utf8_message( \
2271 (U8 *) (p), (U8 *) (e), 0, 1), 0) \
2272 : above_latin1(p)))
2273
2274#define isALPHANUMERIC_LC_utf8_safe(p, e) \
2366ba44 2275 _generic_LC_invlist_utf8_safe(isALPHANUMERIC_LC, \
da8c1a98
KW
2276 _CC_ALPHANUMERIC, p, e)
2277#define isALPHA_LC_utf8_safe(p, e) \
2366ba44 2278 _generic_LC_invlist_utf8_safe(isALPHA_LC, _CC_ALPHA, p, e)
da8c1a98
KW
2279#define isASCII_LC_utf8_safe(p, e) \
2280 (__ASSERT_(_utf8_safe_assert(p, e)) isASCII_LC(*(p)))
2281#define isBLANK_LC_utf8_safe(p, e) \
2366ba44 2282 _generic_LC_non_invlist_utf8_safe(isBLANK_LC, is_HORIZWS_high, p, e)
da8c1a98
KW
2283#define isCNTRL_LC_utf8_safe(p, e) \
2284 _generic_LC_utf8_safe(isCNTRL_LC, p, e, 0)
2285#define isDIGIT_LC_utf8_safe(p, e) \
2366ba44 2286 _generic_LC_invlist_utf8_safe(isDIGIT_LC, _CC_DIGIT, p, e)
da8c1a98 2287#define isGRAPH_LC_utf8_safe(p, e) \
2366ba44 2288 _generic_LC_invlist_utf8_safe(isGRAPH_LC, _CC_GRAPH, p, e)
da8c1a98
KW
2289#define isIDCONT_LC_utf8_safe(p, e) \
2290 _generic_LC_func_utf8_safe(isIDCONT_LC, \
dd1a3ba7 2291 _is_utf8_perl_idcont, p, e)
da8c1a98
KW
2292#define isIDFIRST_LC_utf8_safe(p, e) \
2293 _generic_LC_func_utf8_safe(isIDFIRST_LC, \
dd1a3ba7 2294 _is_utf8_perl_idstart, p, e)
da8c1a98 2295#define isLOWER_LC_utf8_safe(p, e) \
2366ba44 2296 _generic_LC_invlist_utf8_safe(isLOWER_LC, _CC_LOWER, p, e)
da8c1a98 2297#define isPRINT_LC_utf8_safe(p, e) \
2366ba44 2298 _generic_LC_invlist_utf8_safe(isPRINT_LC, _CC_PRINT, p, e)
da8c1a98
KW
2299#define isPSXSPC_LC_utf8_safe(p, e) isSPACE_LC_utf8_safe(p, e)
2300#define isPUNCT_LC_utf8_safe(p, e) \
2366ba44 2301 _generic_LC_invlist_utf8_safe(isPUNCT_LC, _CC_PUNCT, p, e)
da8c1a98 2302#define isSPACE_LC_utf8_safe(p, e) \
2366ba44 2303 _generic_LC_non_invlist_utf8_safe(isSPACE_LC, is_XPERLSPACE_high, p, e)
da8c1a98 2304#define isUPPER_LC_utf8_safe(p, e) \
2366ba44 2305 _generic_LC_invlist_utf8_safe(isUPPER_LC, _CC_UPPER, p, e)
da8c1a98 2306#define isWORDCHAR_LC_utf8_safe(p, e) \
2366ba44 2307 _generic_LC_invlist_utf8_safe(isWORDCHAR_LC, _CC_WORDCHAR, p, e)
da8c1a98 2308#define isXDIGIT_LC_utf8_safe(p, e) \
2366ba44 2309 _generic_LC_non_invlist_utf8_safe(isXDIGIT_LC, is_XDIGIT_high, p, e)
aaa51d5e 2310
fbc19f27
KW
2311/* Macros for backwards compatibility and for completeness when the ASCII and
2312 * Latin1 values are identical */
b7d90381
KW
2313#define isALPHAU(c) isALPHA_L1(c)
2314#define isDIGIT_L1(c) isDIGIT_A(c)
2315#define isOCTAL(c) isOCTAL_A(c)
2316#define isOCTAL_L1(c) isOCTAL_A(c)
2317#define isXDIGIT_L1(c) isXDIGIT_A(c)
2318#define isALNUM(c) isWORDCHAR(c)
a377c856 2319#define isALNUM_A(c) isALNUM(c)
b7d90381
KW
2320#define isALNUMU(c) isWORDCHAR_L1(c)
2321#define isALNUM_LC(c) isWORDCHAR_LC(c)
2322#define isALNUM_uni(c) isWORDCHAR_uni(c)
2e28f0b9 2323#define isALNUM_LC_uvchr(c) isWORDCHAR_LC_uvchr(c)
059703b0 2324#define isALNUM_utf8(p,e) isWORDCHAR_utf8(p,e)
4c1d9526 2325#define isALNUM_utf8_safe(p,e) isWORDCHAR_utf8_safe(p,e)
059703b0 2326#define isALNUM_LC_utf8(p,e)isWORDCHAR_LC_utf8(p,e)
4c1d9526 2327#define isALNUM_LC_utf8_safe(p,e)isWORDCHAR_LC_utf8_safe(p,e)
b7d90381
KW
2328#define isALNUMC_A(c) isALPHANUMERIC_A(c) /* Mnemonic: "C's alnum" */
2329#define isALNUMC_L1(c) isALPHANUMERIC_L1(c)
2330#define isALNUMC(c) isALPHANUMERIC(c)
2331#define isALNUMC_LC(c) isALPHANUMERIC_LC(c)
2332#define isALNUMC_uni(c) isALPHANUMERIC_uni(c)
15861f94 2333#define isALNUMC_LC_uvchr(c) isALPHANUMERIC_LC_uvchr(c)
059703b0 2334#define isALNUMC_utf8(p,e) isALPHANUMERIC_utf8(p,e)
4c1d9526
KW
2335#define isALNUMC_utf8_safe(p,e) isALPHANUMERIC_utf8_safe(p,e)
2336#define isALNUMC_LC_utf8_safe(p,e) isALPHANUMERIC_LC_utf8_safe(p,e)
fbc19f27 2337
2bd1cbf6
KW
2338/* On EBCDIC platforms, CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII,
2339 * except that they don't necessarily mean the same characters, e.g. CTRL-D is
2340 * 4 on both systems, but that is EOT on ASCII; ST on EBCDIC.
2341 * '?' is special-cased on EBCDIC to APC, which is the control there that is
2342 * the outlier from the block that contains the other controls, just like
2343 * toCTRL('?') on ASCII yields DEL, the control that is the outlier from the C0
2344 * block. If it weren't special cased, it would yield a non-control.
88794300
KW
2345 * The conversion works both ways, so toCTRL('D') is 4, and toCTRL(4) is D,
2346 * etc. */
2bd1cbf6 2347#ifndef EBCDIC
75763b3a 2348# define toCTRL(c) (__ASSERT_(FITS_IN_8_BITS(c)) toUPPER(((U8)(c))) ^ 64)
2bd1cbf6 2349#else
75763b3a
KW
2350# define toCTRL(c) (__ASSERT_(FITS_IN_8_BITS(c)) \
2351 ((isPRINT_A(c)) \
2352 ? (UNLIKELY((c) == '?') \
2353 ? QUESTION_MARK_CTRL \
2354 : (NATIVE_TO_LATIN1(toUPPER((U8) (c))) ^ 64)) \
2355 : (UNLIKELY((c) == QUESTION_MARK_CTRL) \
2356 ? '?' \
2357 : (LATIN1_TO_NATIVE(((U8) (c)) ^ 64)))))
2bd1cbf6 2358#endif
bbce6d69 2359
dea28490
JJ
2360/* Line numbers are unsigned, 32 bits. */
2361typedef U32 line_t;
e5dcd934 2362#define NOLINE ((line_t) 4294967295UL) /* = FFFFFFFF */
378cc40b 2363
91152fc1
DG
2364/* Helpful alias for version prescan */
2365#define is_LAX_VERSION(a,b) \
2366 (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
2367
2368#define is_STRICT_VERSION(a,b) \
2369 (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
2370
2371#define BADVERSION(a,b,c) \
2372 if (b) { \
2373 *b = c; \
2374 } \
2375 return a;
8c52afec 2376
1ce77b7d
KW
2377/* Converts a character KNOWN to represent a hexadecimal digit (0-9, A-F, or
2378 * a-f) to its numeric value without using any branches. The input is
2379 * validated only by an assert() in DEBUGGING builds.
2380 *
2381 * It works by right shifting and isolating the bit that is 0 for the digits,
2382 * and 1 for at least the alphas A-F, a-f. The bit is shifted to the ones
2383 * position, and then to the eights position. Both are added together to form
2384 * 0 if the input is '0'-'9' and to form 9 if alpha. This is added to the
2385 * final four bits of the input to form the correct value. */
2386#define XDIGIT_VALUE(c) (__ASSERT_(isXDIGIT(c)) \
2387 ((NATIVE_TO_LATIN1(c) >> 6) & 1) /* 1 if alpha; 0 if not */ \
2388 + ((NATIVE_TO_LATIN1(c) >> 3) & 8) /* 8 if alpha; 0 if not */ \
2389 + ((c) & 0xF)) /* 0-9 if input valid hex digit */
2390
2391/* The argument is a string pointer, which is advanced. */
2392#define READ_XDIGIT(s) ((s)++, XDIGIT_VALUE(*((s) - 1)))
95a59cab 2393
cb27eebd
KW
2394/* Converts a character known to represent an octal digit (0-7) to its numeric
2395 * value. The input is validated only by an assert() in DEBUGGING builds. In
2396 * both ASCII and EBCDIC the last 3 bits of the octal digits range from 0-7. */
2397#define OCTAL_VALUE(c) (__ASSERT_(isOCTAL(c)) (7 & (c)))
2398
305b8651
KW
2399/* Efficiently returns a boolean as to if two native characters are equivalent
2400 * case-insenstively. At least one of the characters must be one of [A-Za-z];
2401 * the ALPHA in the name is to remind you of that. This is asserted() in
2402 * DEBUGGING builds. Because [A-Za-z] are invariant under UTF-8, this macro
2403 * works (on valid input) for both non- and UTF-8-encoded bytes.
2404 *
2405 * When one of the inputs is a compile-time constant and gets folded by the
2406 * compiler, this reduces to an AND and a TEST. On both EBCDIC and ASCII
2407 * machines, 'A' and 'a' differ by a single bit; the same with the upper and
2408 * lower case of all other ASCII-range alphabetics. On ASCII platforms, they
96ca48da
KW
2409 * are 32 apart; on EBCDIC, they are 64. At compile time, this uses an
2410 * exclusive 'or' to find that bit and then inverts it to form a mask, with
2411 * just a single 0, in the bit position where the upper- and lowercase differ.
2412 * */
305b8651
KW
2413#define isALPHA_FOLD_EQ(c1, c2) \
2414 (__ASSERT_(isALPHA_A(c1) || isALPHA_A(c2)) \
2415 ((c1) & ~('A' ^ 'a')) == ((c2) & ~('A' ^ 'a')))
2416#define isALPHA_FOLD_NE(c1, c2) (! isALPHA_FOLD_EQ((c1), (c2)))
2417
8e84507e 2418/*
70b05c7c 2419=for apidoc_section Memory Management
ccfc67b7 2420
a02a5408 2421=for apidoc Am|void|Newx|void* ptr|int nitems|type
954c1994
GS
2422The XSUB-writer's interface to the C C<malloc> function.
2423
596f7718 2424Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
0d7b2759 2425
c5008215
JC
2426In 5.9.3, Newx() and friends replace the older New() API, and drops
2427the first parameter, I<x>, a debug aid which allowed callers to identify
37b8b4c9 2428themselves. This aid has been superseded by a new build option,
d10b4965 2429PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>). The older API is still
c5008215
JC
2430there for use in XS modules supporting older perls.
2431
a02a5408 2432=for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
954c1994 2433The XSUB-writer's interface to the C C<malloc> function, with
fbe13c60 2434cast. See also C<L</Newx>>.
954c1994 2435
596f7718 2436Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
0d7b2759 2437
a02a5408 2438=for apidoc Am|void|Newxz|void* ptr|int nitems|type
954c1994 2439The XSUB-writer's interface to the C C<malloc> function. The allocated
fbe13c60 2440memory is zeroed with C<memzero>. See also C<L</Newx>>.
a02a5408 2441
596f7718 2442Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
0d7b2759 2443
954c1994
GS
2444=for apidoc Am|void|Renew|void* ptr|int nitems|type
2445The XSUB-writer's interface to the C C<realloc> function.
2446
596f7718 2447Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
0d7b2759 2448
954c1994
GS
2449=for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
2450The XSUB-writer's interface to the C C<realloc> function, with
2451cast.
2452
596f7718 2453Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
0d7b2759 2454
49b8b560 2455=for apidoc Am|void|Safefree|void* ptr
954c1994
GS
2456The XSUB-writer's interface to the C C<free> function.
2457
596f7718 2458This should B<ONLY> be used on memory obtained using L</"Newx"> and friends.
0d7b2759 2459
51b56f5c 2460=for apidoc_section String Handling
954c1994
GS
2461=for apidoc Am|void|Move|void* src|void* dest|int nitems|type
2462The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
926bb54c 2463source, C<dest> is the destination, C<nitems> is the number of items, and
fbe13c60 2464C<type> is the type. Can do overlapping moves. See also C<L</Copy>>.
954c1994 2465
e90e2364 2466=for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
796b6530 2467Like C<Move> but returns C<dest>. Useful
72d33970 2468for encouraging compilers to tail-call
e90e2364
NC
2469optimise.
2470
954c1994
GS
2471=for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
2472The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
926bb54c 2473source, C<dest> is the destination, C<nitems> is the number of items, and
fbe13c60 2474C<type> is the type. May fail on overlapping copies. See also C<L</Move>>.
954c1994 2475
e90e2364
NC
2476=for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
2477
796b6530 2478Like C<Copy> but returns C<dest>. Useful
72d33970 2479for encouraging compilers to tail-call
e90e2364
NC
2480optimise.
2481
954c1994
GS
2482=for apidoc Am|void|Zero|void* dest|int nitems|type
2483
2484The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
2485destination, C<nitems> is the number of items, and C<type> is the type.
2486
e90e2364
NC
2487=for apidoc Am|void *|ZeroD|void* dest|int nitems|type
2488
72d33970
FC
2489Like C<Zero> but returns dest. Useful
2490for encouraging compilers to tail-call
e90e2364
NC
2491optimise.
2492
51b56f5c 2493=for apidoc_section Utility Functions
da5d8dbb 2494=for apidoc Am|void|StructCopy|type *src|type *dest|type
4375e838 2495This is an architecture-independent macro to copy one structure to another.
954c1994 2496
7e337ee0
JH
2497=for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
2498
2499Fill up memory with a byte pattern (a byte repeated over and over
2500again) that hopefully catches attempts to access uninitialized memory.
2501
2502=for apidoc Am|void|PoisonNew|void* dest|int nitems|type
2503
2504PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2505
1c12ffb4 2506=for apidoc Am|void|PoisonFree|void* dest|int nitems|type
7e337ee0
JH
2507
2508PoisonWith(0xEF) for catching access to freed memory.
2509
9965345d
JH
2510=for apidoc Am|void|Poison|void* dest|int nitems|type
2511
7e337ee0 2512PoisonWith(0xEF) for catching access to freed memory.
9965345d
JH
2513
2514=cut */
954c1994 2515
561b68a9
SH
2516/* Maintained for backwards-compatibility only. Use newSV() instead. */
2517#ifndef PERL_CORE
ff06c60c 2518#define NEWSV(x,len) newSV(len)
561b68a9 2519#endif
ff06c60c 2520
b7112dce 2521#define MEM_SIZE_MAX ((MEM_SIZE)-1)
19a94d75 2522
a500027b 2523#define _PERL_STRLEN_ROUNDUP_UNCHECKED(n) (((n) - 1 + PERL_STRLEN_ROUNDUP_QUANTUM) & ~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM - 1))
e6bdf523 2524
27d5b266 2525#ifdef PERL_MALLOC_WRAP
e6bdf523
DM
2526
2527/* This expression will be constant-folded at compile time. It checks
2528 * whether or not the type of the count n is so small (e.g. U8 or U16, or
2529 * U32 on 64-bit systems) that there's no way a wrap-around could occur.
2530 * As well as avoiding the need for a run-time check in some cases, it's
2531 * designed to avoid compiler warnings like:
2532 * comparison is always false due to limited range of data type
73e8ff00
DM
2533 * It's mathematically equivalent to
2534 * max(n) * sizeof(t) > MEM_SIZE_MAX
e6bdf523
DM
2535 */
2536
2537# define _MEM_WRAP_NEEDS_RUNTIME_CHECK(n,t) \
445198b9
LM
2538 ( sizeof(MEM_SIZE) < sizeof(n) \
2539 || sizeof(t) > ((MEM_SIZE)1 << 8*(sizeof(MEM_SIZE) - sizeof(n))))
e6bdf523 2540
88f9f128 2541/* This is written in a slightly odd way to avoid various spurious
d98e5cde
DM
2542 * compiler warnings. We *want* to write the expression as
2543 * _MEM_WRAP_NEEDS_RUNTIME_CHECK(n,t) && (n > C)
2544 * (for some compile-time constant C), but even when the LHS
2545 * constant-folds to false at compile-time, g++ insists on emitting
2546 * warnings about the RHS (e.g. "comparison is always false"), so instead
2547 * we write it as
e6bdf523 2548 *
d98e5cde 2549 * (cond ? n : X) > C
88f9f128 2550 *
d98e5cde
DM
2551 * where X is a constant with X > C always false. Choosing a value for X
2552 * is tricky. If 0, some compilers will complain about 0 > C always being
2553 * false; if 1, Coverity complains when n happens to be the constant value
2554 * '1', that cond ? 1 : 1 has the same value on both branches; so use C
2555 * for X and hope that nothing else whines.
e6bdf523
DM
2556 */
2557
2558# define _MEM_WRAP_WILL_WRAP(n,t) \
88f9f128
DM
2559 ((_MEM_WRAP_NEEDS_RUNTIME_CHECK(n,t) ? (MEM_SIZE)(n) : \
2560 MEM_SIZE_MAX/sizeof(t)) > MEM_SIZE_MAX/sizeof(t))
e6bdf523
DM
2561
2562# define MEM_WRAP_CHECK(n,t) \
2563 (void)(UNLIKELY(_MEM_WRAP_WILL_WRAP(n,t)) \
2564 && (croak_memory_wrap(),0))
2565
2566# define MEM_WRAP_CHECK_1(n,t,a) \
2567 (void)(UNLIKELY(_MEM_WRAP_WILL_WRAP(n,t)) \
2568 && (Perl_croak_nocontext("%s",(a)),0))
2569
814eedc8
DD
2570/* "a" arg must be a string literal */
2571# define MEM_WRAP_CHECK_s(n,t,a) \
2572 (void)(UNLIKELY(_MEM_WRAP_WILL_WRAP(n,t)) \
2573 && (Perl_croak_nocontext("" a ""),0))
2574
8b44ba4c 2575#define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
27d5b266 2576
a500027b 2577#define PERL_STRLEN_ROUNDUP(n) ((void)(((n) > MEM_SIZE_MAX - 2 * PERL_STRLEN_ROUNDUP_QUANTUM) ? (croak_memory_wrap(),0) : 0), _PERL_STRLEN_ROUNDUP_UNCHECKED(n))
27d5b266
JH
2578#else
2579
410319be
NC
2580#define MEM_WRAP_CHECK(n,t)
2581#define MEM_WRAP_CHECK_1(n,t,a)
814eedc8 2582#define MEM_WRAP_CHECK_s(n,t,a)
8b44ba4c
NC
2583#define MEM_WRAP_CHECK_(n,t)
2584
a500027b 2585#define PERL_STRLEN_ROUNDUP(n) _PERL_STRLEN_ROUNDUP_UNCHECKED(n)
27d5b266 2586
1936d2a7 2587#endif
8b44ba4c 2588
fe4f188c 2589#ifdef PERL_MEM_LOG
46c6c7e2 2590/*
9f653bb5 2591 * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
46c6c7e2
JH
2592 * go through functions, which are handy for debugging breakpoints, but
2593 * which more importantly get the immediate calling environment (file and
e352bcff
JH
2594 * line number, and C function name if available) passed in. This info can
2595 * then be used for logging the calls, for which one gets a sample
73d1d973 2596 * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
3609ea0d 2597 *
46c6c7e2 2598 * Known problems:
94e892a6 2599 * - not all memory allocs get logged, only those
46c6c7e2 2600 * that go through Newx() and derivatives (while all
94e892a6 2601 * Safefrees do get logged)
46c6c7e2
JH
2602 * - __FILE__ and __LINE__ do not work everywhere
2603 * - __func__ or __FUNCTION__ even less so
2604 * - I think more goes on after the perlio frees but
2605 * the thing is that STDERR gets closed (as do all
2606 * the file descriptors)
2607 * - no deeper calling stack than the caller of the Newx()
2608 * or the kind, but do I look like a C reflection/introspection
2609 * utility to you?
2610 * - the function prototypes for the logging functions
2611 * probably should maybe be somewhere else than handy.h
2612 * - one could consider inlining (macrofying) the logging
2613 * for speed, but I am too lazy
2614 * - one could imagine recording the allocations in a hash,
2615 * (keyed by the allocation address?), and maintain that
2616 * through reallocs and frees, but how to do that without
2617 * any News() happening...?
73d1d973 2618 * - lots of -Ddefines to get useful/controllable output
b953482e 2619 * - lots of ENV reads
46c6c7e2
JH
2620 */
2621
0b0ab801 2622# ifdef PERL_CORE
73d1d973 2623# ifndef PERL_MEM_LOG_NOIMPL
0b0ab801
MHM
2624enum mem_log_type {
2625 MLT_ALLOC,
2626 MLT_REALLOC,
d7a2c63c
MHM
2627 MLT_FREE,
2628 MLT_NEW_SV,
2629 MLT_DEL_SV
0b0ab801
MHM
2630};
2631# endif
12754f92 2632# if defined(PERL_IN_SV_C) /* those are only used in sv.c */
d7a2c63c
MHM
2633void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
2634void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
12754f92 2635# endif
0b0ab801
MHM
2636# endif
2637
fe4f188c
JH
2638#endif
2639
2640#ifdef PERL_MEM_LOG
d1401ee9
MHM
2641#define MEM_LOG_ALLOC(n,t,a) Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
2642#define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
46c6c7e2 2643#define MEM_LOG_FREE(a) Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
fe4f188c
JH
2644#endif
2645
2646#ifndef MEM_LOG_ALLOC
2647#define MEM_LOG_ALLOC(n,t,a) (a)
2648#endif
2649#ifndef MEM_LOG_REALLOC
2650#define MEM_LOG_REALLOC(n,t,v,a) (a)
2651#endif
2652#ifndef MEM_LOG_FREE
2653#define MEM_LOG_FREE(a) (a)
2654#endif
2655
d1401ee9
MHM
2656#define Newx(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
2657#define Newxc(v,n,t,c) (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
2658#define Newxz(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
a6f6820f
NC
2659
2660#ifndef PERL_CORE
a02a5408
JC
2661/* pre 5.9.x compatibility */
2662#define New(x,v,n,t) Newx(v,n,t)
2663#define Newc(x,v,n,t,c) Newxc(v,n,t,c)
4541904d 2664#define Newz(x,v,n,t) Newxz(v,n,t)
a6f6820f 2665#endif
a02a5408 2666
ff68c719 2667#define Renew(v,n,t) \
d1401ee9 2668 (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
ff68c719 2669#define Renewc(v,n,t,c) \
d1401ee9 2670 (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
94010e71
NC
2671
2672#ifdef PERL_POISON
2673#define Safefree(d) \
06c0cc96 2674 ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
94010e71 2675#else
fe4f188c 2676#define Safefree(d) safefree(MEM_LOG_FREE((Malloc_t)(d)))
94010e71 2677#endif
55497cff 2678
dbb57106
YO
2679/* assert that a valid ptr has been supplied - use this instead of assert(ptr) *
2680 * as it handles cases like constant string arguments without throwing warnings *
2681 * the cast is required, as is the inequality check, to avoid warnings */
45908e4d 2682#define perl_assert_ptr(p) assert( ((void*)(p)) != 0 )
55497cff 2683
45908e4d
YO
2684
2685#define Move(s,d,n,t) (MEM_WRAP_CHECK_(n,t) perl_assert_ptr(d), perl_assert_ptr(s), (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
2686#define Copy(s,d,n,t) (MEM_WRAP_CHECK_(n,t) perl_assert_ptr(d), perl_assert_ptr(s), (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
2687#define Zero(d,n,t) (MEM_WRAP_CHECK_(n,t) perl_assert_ptr(d), (void)memzero((char*)(d), (n) * sizeof(t)))
2688
bdd1531d 2689/* Like above, but returns a pointer to 'd' */
45908e4d
YO
2690#define MoveD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) perl_assert_ptr(d), perl_assert_ptr(s), memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
2691#define CopyD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) perl_assert_ptr(d), perl_assert_ptr(s), memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
45908e4d 2692#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) perl_assert_ptr(d), memzero((char*)(d), (n) * sizeof(t)))
e90e2364 2693
7e337ee0
JH
2694#define PoisonWith(d,n,t,b) (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
2695#define PoisonNew(d,n,t) PoisonWith(d,n,t,0xAB)
2696#define PoisonFree(d,n,t) PoisonWith(d,n,t,0xEF)
2697#define Poison(d,n,t) PoisonFree(d,n,t)
27d5b266 2698
caa674f3
DD
2699#ifdef PERL_POISON
2700# define PERL_POISON_EXPR(x) x
2701#else
2702# define PERL_POISON_EXPR(x)
2703#endif
2704
ff68c719 2705#define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
2cc61e15 2706
1b7e2294 2707/*
51b56f5c 2708=for apidoc_section Utility Functions
1b7e2294
KW
2709
2710=for apidoc Am|STRLEN|C_ARRAY_LENGTH|void *a
2711
2712Returns the number of elements in the input C array (so you want your
2713zero-based indices to be less than but not equal to).
2714
2715=for apidoc Am|void *|C_ARRAY_END|void *a
2716
2717Returns a pointer to one element past the final element of the input C array.
2718
2719=cut
2720
2721C_ARRAY_END is one past the last: half-open/half-closed range, not
2722last-inclusive range.
2723*/
622913ab 2724#define C_ARRAY_LENGTH(a) (sizeof(a)/sizeof((a)[0]))
c3caa5c3 2725#define C_ARRAY_END(a) ((a) + C_ARRAY_LENGTH(a))
622913ab 2726
2cc61e15
DD
2727#ifdef NEED_VA_COPY
2728# ifdef va_copy
2729# define Perl_va_copy(s, d) va_copy(d, s)
07798b17
AC
2730# elif defined(__va_copy)
2731# define Perl_va_copy(s, d) __va_copy(d, s)
2cc61e15 2732# else
07798b17 2733# define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
2cc61e15
DD
2734# endif
2735#endif
2736
472d47bc
SB
2737/* convenience debug macros */
2738#ifdef USE_ITHREADS
2739#define pTHX_FORMAT "Perl interpreter: 0x%p"
2740#define pTHX__FORMAT ", Perl interpreter: 0x%p"
f54cb97a
AL
2741#define pTHX_VALUE_ (void *)my_perl,
2742#define pTHX_VALUE (void *)my_perl
2743#define pTHX__VALUE_ ,(void *)my_perl,
2744#define pTHX__VALUE ,(void *)my_perl
472d47bc 2745#else
3609ea0d 2746#define pTHX_FORMAT
472d47bc 2747#define pTHX__FORMAT
3609ea0d 2748#define pTHX_VALUE_
472d47bc 2749#define pTHX_VALUE
3609ea0d 2750#define pTHX__VALUE_
472d47bc
SB
2751#define pTHX__VALUE
2752#endif /* USE_ITHREADS */
3609ea0d 2753
2acdbac1
NC
2754/* Perl_deprecate was not part of the public API, and did not have a deprecate()
2755 shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
2756 CPAN::Unpack show any users outside the core. */
2757#ifdef PERL_CORE
dc6e8de0
A
2758# define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), \
2759 "Use of " s " is deprecated")
c9680906
A
2760# define deprecate_disappears_in(when,message) \
2761 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), \
2762 message ", and will disappear in Perl " when)
ac641426
A
2763# define deprecate_fatal_in(when,message) \
2764 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), \
2765 message ". Its use will be fatal in Perl " when)
2acdbac1
NC
2766#endif
2767
dfff4baf
BF
2768/* Internal macros to deal with gids and uids */
2769#ifdef PERL_CORE
2770
2771# if Uid_t_size > IVSIZE
2772# define sv_setuid(sv, uid) sv_setnv((sv), (NV)(uid))
2773# define SvUID(sv) SvNV(sv)
07798b17
AC
2774# elif Uid_t_sign <= 0
2775# define sv_setuid(sv, uid) sv_setiv((sv), (IV)(uid))
2776# define SvUID(sv) SvIV(sv)
dfff4baf 2777# else
07798b17
AC
2778# define sv_setuid(sv, uid) sv_setuv((sv), (UV)(uid))
2779# define SvUID(sv) SvUV(sv)
dfff4baf
BF
2780# endif /* Uid_t_size */
2781
2782# if Gid_t_size > IVSIZE
2783# define sv_setgid(sv, gid) sv_setnv((sv), (NV)(gid))
2784# define SvGID(sv) SvNV(sv)
07798b17
AC
2785# elif Gid_t_sign <= 0
2786# define sv_setgid(sv, gid) sv_setiv((sv), (IV)(gid))
2787# define SvGID(sv) SvIV(sv)
dfff4baf 2788# else
07798b17
AC
2789# define sv_setgid(sv, gid) sv_setuv((sv), (UV)(gid))
2790# define SvGID(sv) SvUV(sv)
dfff4baf
BF
2791# endif /* Gid_t_size */
2792
2793#endif
2794
6a5bc5ac 2795#endif /* PERL_HANDY_H_ */
9d745869 2796
e9a8c099 2797/*
14d04a33 2798 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 2799 */