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