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