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