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