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