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