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