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