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