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