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