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