perlguts: consistent spaces after dots
[perl.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 #ifdef I_STDBOOL
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 HAS_BOOL
89 #    define HAS_BOOL 1
90 #  endif
91 #endif
92
93 /* The NeXT dynamic loader headers will not build with the bool macro
94    So declare them now to clear confusion.
95 */
96 #if defined(NeXT) || defined(__NeXT__)
97 # undef FALSE
98 # undef TRUE
99   typedef enum bool { FALSE = 0, TRUE = 1 } bool;
100 # define ENUM_BOOL 1
101 # ifndef HAS_BOOL
102 #  define HAS_BOOL 1
103 # endif /* !HAS_BOOL */
104 #endif /* NeXT || __NeXT__ */
105
106 #ifndef HAS_BOOL
107 # if defined(VMS)
108 #  define bool int
109 # else
110 #  define bool char
111 # endif
112 # define HAS_BOOL 1
113 #endif
114
115 /* cast-to-bool.  A simple (bool) cast may not do the right thing: if bool is
116  * defined as char for example, then the cast from int is
117  * implementation-defined (bool)!!(cbool) in a ternary triggers a bug in xlc on
118  * AIX */
119 #define cBOOL(cbool) ((cbool) ? (bool)1 : (bool)0)
120
121 /* Try to figure out __func__ or __FUNCTION__ equivalent, if any.
122  * XXX Should really be a Configure probe, with HAS__FUNCTION__
123  *     and FUNCTION__ as results.
124  * XXX Similarly, a Configure probe for __FILE__ and __LINE__ is needed. */
125 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || (defined(__SUNPRO_C)) /* C99 or close enough. */
126 #  define FUNCTION__ __func__
127 #else
128 #  if (defined(_MSC_VER) && _MSC_VER < 1300) || /* MSVC6 has neither __func__ nor __FUNCTION and no good workarounds, either. */ \
129       (defined(__DECC_VER)) /* Tru64 or VMS, and strict C89 being used, but not modern enough cc (in Tur64, -c99 not known, only -std1). */
130 #    define FUNCTION__ ""
131 #  else
132 #    define FUNCTION__ __FUNCTION__ /* Common extension. */
133 #  endif
134 #endif
135
136 /* XXX A note on the perl source internal type system.  The
137    original intent was that I32 be *exactly* 32 bits.
138
139    Currently, we only guarantee that I32 is *at least* 32 bits.
140    Specifically, if int is 64 bits, then so is I32.  (This is the case
141    for the Cray.)  This has the advantage of meshing nicely with
142    standard library calls (where we pass an I32 and the library is
143    expecting an int), but the disadvantage that an I32 is not 32 bits.
144    Andy Dougherty       August 1996
145
146    There is no guarantee that there is *any* integral type with
147    exactly 32 bits.  It is perfectly legal for a system to have
148    sizeof(short) == sizeof(int) == sizeof(long) == 8.
149
150    Similarly, there is no guarantee that I16 and U16 have exactly 16
151    bits.
152
153    For dealing with issues that may arise from various 32/64-bit
154    systems, we will ask Configure to check out
155
156         SHORTSIZE == sizeof(short)
157         INTSIZE == sizeof(int)
158         LONGSIZE == sizeof(long)
159         LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
160         PTRSIZE == sizeof(void *)
161         DOUBLESIZE == sizeof(double)
162         LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
163
164 */
165
166 #ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
167 #   include <inttypes.h>
168 #   ifdef INT32_MIN_BROKEN
169 #       undef  INT32_MIN
170 #       define INT32_MIN (-2147483647-1)
171 #   endif
172 #   ifdef INT64_MIN_BROKEN
173 #       undef  INT64_MIN
174 #       define INT64_MIN (-9223372036854775807LL-1)
175 #   endif
176 #endif
177
178 typedef I8TYPE I8;
179 typedef U8TYPE U8;
180 typedef I16TYPE I16;
181 typedef U16TYPE U16;
182 typedef I32TYPE I32;
183 typedef U32TYPE U32;
184 #ifdef PERL_CORE
185 #   ifdef HAS_QUAD
186 typedef I64TYPE I64;
187 typedef U64TYPE U64;
188 #   endif
189 #endif /* PERL_CORE */
190
191 #if defined(HAS_QUAD) && defined(USE_64_BIT_INT)
192 #   if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
193 #       define PeRl_INT64_C(c)  CAT2(c,LL)
194 #       define PeRl_UINT64_C(c) CAT2(c,ULL)
195 #   else
196 #       if QUADKIND == QUAD_IS___INT64
197 #           define PeRl_INT64_C(c)      CAT2(c,I64)
198 #           define PeRl_UINT64_C(c)     CAT2(c,UI64)
199 #       else
200 #           if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
201 #               define PeRl_INT64_C(c)  CAT2(c,L)
202 #               define PeRl_UINT64_C(c) CAT2(c,UL)
203 #           else
204 #               define PeRl_INT64_C(c)  ((I64TYPE)(c))
205 #               define PeRl_UINT64_C(c) ((U64TYPE)(c))
206 #           endif
207 #       endif
208 #   endif
209 #   ifndef UINT64_C
210 #   define UINT64_C(c) PeRl_UINT64_C(c)
211 #   endif
212 #   ifndef INT64_C
213 #   define INT64_C(c) PeRl_INT64_C(c)
214 #   endif
215 #endif
216
217 #if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
218
219 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
220    Please search CHAR_MAX in perl.h for further details. */
221 #define U8_MAX UINT8_MAX
222 #define U8_MIN UINT8_MIN
223
224 #define I16_MAX INT16_MAX
225 #define I16_MIN INT16_MIN
226 #define U16_MAX UINT16_MAX
227 #define U16_MIN UINT16_MIN
228
229 #define I32_MAX INT32_MAX
230 #define I32_MIN INT32_MIN
231 #ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
232 #  define U32_MAX UINT32_MAX
233 #else
234 #  define U32_MAX 4294967295U
235 #endif
236 #define U32_MIN UINT32_MIN
237
238 #else
239
240 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
241    Please search CHAR_MAX in perl.h for further details. */
242 #define U8_MAX PERL_UCHAR_MAX
243 #define U8_MIN PERL_UCHAR_MIN
244
245 #define I16_MAX PERL_SHORT_MAX
246 #define I16_MIN PERL_SHORT_MIN
247 #define U16_MAX PERL_USHORT_MAX
248 #define U16_MIN PERL_USHORT_MIN
249
250 #if LONGSIZE > 4
251 # define I32_MAX PERL_INT_MAX
252 # define I32_MIN PERL_INT_MIN
253 # define U32_MAX PERL_UINT_MAX
254 # define U32_MIN PERL_UINT_MIN
255 #else
256 # define I32_MAX PERL_LONG_MAX
257 # define I32_MIN PERL_LONG_MIN
258 # define U32_MAX PERL_ULONG_MAX
259 # define U32_MIN PERL_ULONG_MIN
260 #endif
261
262 #endif
263
264 /* log(2) is pretty close to  0.30103, just in case anyone is grepping for it */
265 #define BIT_DIGITS(N)   (((N)*146)/485 + 1)  /* log2(10) =~ 146/485 */
266 #define TYPE_DIGITS(T)  BIT_DIGITS(sizeof(T) * 8)
267 #define TYPE_CHARS(T)   (TYPE_DIGITS(T) + 2) /* sign, NUL */
268
269 #define Ctl(ch) ((ch) & 037)
270
271 /*
272 =head1 SV-Body Allocation
273
274 =for apidoc Ama|SV*|newSVpvs|const char* s
275 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
276
277 =for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags
278 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
279 pair.
280
281 =for apidoc Ama|SV*|newSVpvs_share|const char* s
282 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
283 pair and omits the hash parameter.
284
285 =for apidoc Am|void|sv_catpvs_flags|SV* sv|const char* s|I32 flags
286 Like C<sv_catpvn_flags>, but takes a literal string instead of a
287 string/length pair.
288
289 =for apidoc Am|void|sv_catpvs_nomg|SV* sv|const char* s
290 Like C<sv_catpvn_nomg>, but takes a literal string instead of a
291 string/length pair.
292
293 =for apidoc Am|void|sv_catpvs|SV* sv|const char* s
294 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
295
296 =for apidoc Am|void|sv_catpvs_mg|SV* sv|const char* s
297 Like C<sv_catpvn_mg>, but takes a literal string instead of a
298 string/length pair.
299
300 =for apidoc Am|void|sv_setpvs|SV* sv|const char* s
301 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
302
303 =for apidoc Am|void|sv_setpvs_mg|SV* sv|const char* s
304 Like C<sv_setpvn_mg>, but takes a literal string instead of a
305 string/length pair.
306
307 =for apidoc Am|SV *|sv_setref_pvs|const char* s
308 Like C<sv_setref_pvn>, but takes a literal string instead of a
309 string/length pair.
310
311 =head1 Memory Management
312
313 =for apidoc Ama|char*|savepvs|const char* s
314 Like C<savepvn>, but takes a literal string instead of a string/length pair.
315
316 =for apidoc Ama|char*|savesharedpvs|const char* s
317 A version of C<savepvs()> which allocates the duplicate string in memory
318 which is shared between threads.
319
320 =head1 GV Functions
321
322 =for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create
323 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
324
325 =head1 Hash Manipulation Functions
326
327 =for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval
328 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
329
330 =for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val
331 Like C<hv_store>, but takes a literal string instead of a string/length pair
332 and omits the hash parameter.
333
334 =head1 Lexer interface
335
336 =for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags
337
338 Like L</lex_stuff_pvn>, but takes a literal string instead of a
339 string/length pair.
340
341 =cut
342 */
343
344 /* concatenating with "" ensures that only literal strings are accepted as
345  * argument */
346 #define STR_WITH_LEN(s)  ("" s ""), (sizeof(s)-1)
347
348 /* note that STR_WITH_LEN() can't be used as argument to macros or functions
349  * that under some configurations might be macros, which means that it requires
350  * the full Perl_xxx(aTHX_ ...) form for any API calls where it's used.
351  */
352
353 /* STR_WITH_LEN() shortcuts */
354 #define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str))
355 #define newSVpvs_flags(str,flags)       \
356     Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags)
357 #define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0)
358 #define sv_catpvs_flags(sv, str, flags) \
359     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), flags)
360 #define sv_catpvs_nomg(sv, str) \
361     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), 0)
362 #define sv_catpvs(sv, str) \
363     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC)
364 #define sv_catpvs_mg(sv, str) \
365     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC|SV_SMAGIC)
366 #define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str))
367 #define sv_setpvs_mg(sv, str) Perl_sv_setpvn_mg(aTHX_ sv, STR_WITH_LEN(str))
368 #define sv_setref_pvs(rv, classname, str) \
369     Perl_sv_setref_pvn(aTHX_ rv, classname, STR_WITH_LEN(str))
370 #define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str))
371 #define savesharedpvs(str) Perl_savesharedpvn(aTHX_ STR_WITH_LEN(str))
372 #define gv_stashpvs(str, create) \
373     Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create)
374 #define gv_fetchpvs(namebeg, add, sv_type) \
375     Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type)
376 #define gv_fetchpvn(namebeg, len, add, sv_type) \
377     Perl_gv_fetchpvn_flags(aTHX_ namebeg, len, add, sv_type)
378 #define sv_catxmlpvs(dsv, str, utf8) \
379     Perl_sv_catxmlpvn(aTHX_ dsv, STR_WITH_LEN(str), utf8)
380 #define hv_fetchs(hv,key,lval)                                          \
381   ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0,        \
382                          (lval) ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)  \
383                          : HV_FETCH_JUST_SV, NULL, 0))
384
385 #define hv_stores(hv,key,val)                                           \
386   ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0,        \
387                          (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), 0))
388
389 #define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
390
391 #define get_cvs(str, flags)                                     \
392         Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
393
394 /*
395 =head1 Miscellaneous Functions
396
397 =for apidoc Am|bool|strNE|char* s1|char* s2
398 Test two strings to see if they are different.  Returns true or
399 false.
400
401 =for apidoc Am|bool|strEQ|char* s1|char* s2
402 Test two strings to see if they are equal.  Returns true or false.
403
404 =for apidoc Am|bool|strLT|char* s1|char* s2
405 Test two strings to see if the first, C<s1>, is less than the second,
406 C<s2>.  Returns true or false.
407
408 =for apidoc Am|bool|strLE|char* s1|char* s2
409 Test two strings to see if the first, C<s1>, is less than or equal to the
410 second, C<s2>.  Returns true or false.
411
412 =for apidoc Am|bool|strGT|char* s1|char* s2
413 Test two strings to see if the first, C<s1>, is greater than the second,
414 C<s2>.  Returns true or false.
415
416 =for apidoc Am|bool|strGE|char* s1|char* s2
417 Test two strings to see if the first, C<s1>, is greater than or equal to
418 the second, C<s2>.  Returns true or false.
419
420 =for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
421 Test two strings to see if they are different.  The C<len> parameter
422 indicates the number of bytes to compare.  Returns true or false. (A
423 wrapper for C<strncmp>).
424
425 =for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
426 Test two strings to see if they are equal.  The C<len> parameter indicates
427 the number of bytes to compare.  Returns true or false. (A wrapper for
428 C<strncmp>).
429
430 =cut
431 */
432
433 #define strNE(s1,s2) (strcmp(s1,s2))
434 #define strEQ(s1,s2) (!strcmp(s1,s2))
435 #define strLT(s1,s2) (strcmp(s1,s2) < 0)
436 #define strLE(s1,s2) (strcmp(s1,s2) <= 0)
437 #define strGT(s1,s2) (strcmp(s1,s2) > 0)
438 #define strGE(s1,s2) (strcmp(s1,s2) >= 0)
439 #define strnNE(s1,s2,l) (strncmp(s1,s2,l))
440 #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
441
442 #ifdef HAS_MEMCMP
443 #  define memNE(s1,s2,l) (memcmp(s1,s2,l))
444 #  define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
445 #else
446 #  define memNE(s1,s2,l) (bcmp(s1,s2,l))
447 #  define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
448 #endif
449
450 #define memEQs(s1, l, s2) \
451         (sizeof(s2)-1 == l && memEQ(s1, ("" s2 ""), (sizeof(s2)-1)))
452 #define memNEs(s1, l, s2) !memEQs(s1, l, s2)
453
454 /*
455  * Character classes.
456  *
457  * Unfortunately, the introduction of locales means that we
458  * can't trust isupper(), etc. to tell the truth.  And when
459  * it comes to /\w+/ with tainting enabled, we *must* be able
460  * to trust our character classes.
461  *
462  * Therefore, the default tests in the text of Perl will be
463  * independent of locale.  Any code that wants to depend on
464  * the current locale will use the tests that begin with "lc".
465  */
466
467 #ifdef HAS_SETLOCALE  /* XXX Is there a better test for this? */
468 #  ifndef CTYPE256
469 #    define CTYPE256
470 #  endif
471 #endif
472
473 /*
474
475 =head1 Character classes
476 This section is about functions (really macros) that classify characters
477 into types, such as punctuation versus alphabetic, etc.  Most of these are
478 analogous to regular expression character classes.  (See
479 L<perlrecharclass/POSIX Character Classes>.)  There are several variants for
480 each class.  (Not all macros have all variants; each item below lists the
481 ones valid for it.)  None are affected by C<use bytes>, and only the ones
482 with C<LC> in the name are affected by the current locale.
483
484 The base function, e.g., C<isALPHA()>, takes an octet (either a C<char> or a
485 C<U8>) as input and returns a boolean as to whether or not the character
486 represented by that octet is (or on non-ASCII platforms, corresponds to) an
487 ASCII character in the named class based on platform, Unicode, and Perl rules.
488 If the input is a number that doesn't fit in an octet, FALSE is returned.
489
490 Variant C<isFOO_A> (e.g., C<isALPHA_A()>) is identical to the base function
491 with no suffix C<"_A">.
492
493 Variant C<isFOO_L1> imposes the Latin-1 (or EBCDIC equivlalent) character set
494 onto the platform.  That is, the code points that are ASCII are unaffected,
495 since ASCII is a subset of Latin-1.  But the non-ASCII code points are treated
496 as if they are Latin-1 characters.  For example, C<isWORDCHAR_L1()> will return
497 true when called with the code point 0xDF, which is a word character in both
498 ASCII and EBCDIC (though it represent different characters in each).
499
500 Variant C<isFOO_uni> is like the C<isFOO_L1> variant, but accepts any UV code
501 point as input.  If the code point is larger than 255, Unicode rules are used
502 to determine if it is in the character class.  For example,
503 C<isWORDCHAR_uni(0x100)> returns TRUE, since 0x100 is LATIN CAPITAL LETTER A
504 WITH MACRON in Unicode, and is a word character.
505
506 Variant C<isFOO_utf8> is like C<isFOO_uni>, but the input is a pointer to a
507 (known to be well-formed) UTF-8 encoded string (C<U8*> or C<char*>).  The
508 classification of just the first (possibly multi-byte) character in the string
509 is tested.
510
511 Variant C<isFOO_LC> is like the C<isFOO_A> and C<isFOO_L1> variants, but uses
512 the C library function that gives the named classification instead of
513 hard-coded rules.  For example, C<isDIGIT_LC()> returns the result of calling
514 C<isdigit()>.  This means that the result is based on the current locale, which
515 is what C<LC> in the name stands for.  FALSE is always returned if the input
516 won't fit into an octet.
517
518 Variant C<isFOO_LC_uvchr> is like C<isFOO_LC>, but is defined on any UV.  It
519 returns the same as C<isFOO_LC> for input code points less than 256, and
520 returns the hard-coded, not-affected-by-locale, Unicode results for larger ones.
521
522 Variant C<isFOO_LC_utf8> is like C<isFOO_LC_uvchr>, but the input is a pointer to a
523 (known to be well-formed) UTF-8 encoded string (C<U8*> or C<char*>).  The
524 classification of just the first (possibly multi-byte) character in the string
525 is tested.
526
527 =for apidoc Am|bool|isALPHA|char ch
528 Returns a boolean indicating whether the specified character is an
529 alphabetic character, analogous to C<m/[[:alpha:]]/>.
530 See the L<top of this section|/Character classes> for an explanation of variants
531 C<isALPHA_A>, C<isALPHA_L1>, C<isALPHA_uni>, C<isALPHA_utf8>, C<isALPHA_LC>,
532 C<isALPHA_LC_uvchr>, and C<isALPHA_LC_utf8>.
533
534 =for apidoc Am|bool|isALPHANUMERIC|char ch
535 Returns a boolean indicating whether the specified character is a either an
536 alphabetic character or decimal digit, analogous to C<m/[[:alnum:]]/>.
537 See the L<top of this section|/Character classes> for an explanation of variants
538 C<isALPHANUMERIC_A>, C<isALPHANUMERIC_L1>, C<isALPHANUMERIC_uni>,
539 C<isALPHANUMERIC_utf8>, C<isALPHANUMERIC_LC>, C<isALPHANUMERIC_LC_uvchr>, and
540 C<isALPHANUMERIC_LC_utf8>.
541
542 =for apidoc Am|bool|isASCII|char ch
543 Returns a boolean indicating whether the specified character is one of the 128
544 characters in the ASCII character set, analogous to C<m/[[:ascii:]]/>.
545 On non-ASCII platforms, it returns TRUE iff this
546 character corresponds to an ASCII character.  Variants C<isASCII_A()> and
547 C<isASCII_L1()> are identical to C<isASCII()>.
548 See the L<top of this section|/Character classes> for an explanation of variants
549 C<isASCII_uni>, C<isASCII_utf8>, C<isASCII_LC>, C<isASCII_LC_uvchr>, and
550 C<isASCII_LC_utf8>.  Note, however, that some platforms do not have the C
551 library routine C<isascii()>.  In these cases, the variants whose names contain
552 C<LC> are the same as the corresponding ones without.
553
554 Also note, that because all ASCII characters are UTF-8 invariant (meaning they
555 have the exact same representation (always a single byte) whether encoded in
556 UTF-8 or not), C<isASCII> will give the correct results when called with any
557 byte in any string encoded or not in UTF-8.  And similarly C<isASCII_utf8> will
558 work properly on any string encoded or not in UTF-8.
559
560 =for apidoc Am|bool|isBLANK|char ch
561 Returns a boolean indicating whether the specified character is a
562 character considered to be a blank, analogous to C<m/[[:blank:]]/>.
563 See the L<top of this section|/Character classes> for an explanation of variants
564 C<isBLANK_A>, C<isBLANK_L1>, C<isBLANK_uni>, C<isBLANK_utf8>, C<isBLANK_LC>,
565 C<isBLANK_LC_uvchr>, and C<isBLANK_LC_utf8>.  Note, however, that some
566 platforms do not have the C library routine C<isblank()>.  In these cases, the
567 variants whose names contain C<LC> are the same as the corresponding ones
568 without.
569
570 =for apidoc Am|bool|isCNTRL|char ch
571 Returns a boolean indicating whether the specified character is a
572 control character, analogous to C<m/[[:cntrl:]]/>.
573 See the L<top of this section|/Character classes> for an explanation of variants
574 C<isCNTRL_A>, C<isCNTRL_L1>, C<isCNTRL_uni>, C<isCNTRL_utf8>, C<isCNTRL_LC>,
575 C<isCNTRL_LC_uvchr>, and C<isCNTRL_LC_utf8>
576 On EBCDIC platforms, you almost always want to use the C<isCNTRL_L1> variant.
577
578 =for apidoc Am|bool|isDIGIT|char ch
579 Returns a boolean indicating whether the specified character is a
580 digit, analogous to C<m/[[:digit:]]/>.
581 Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
582 See the L<top of this section|/Character classes> for an explanation of variants
583 C<isDIGIT_uni>, C<isDIGIT_utf8>, C<isDIGIT_LC>, C<isDIGIT_LC_uvchr>, and
584 C<isDIGIT_LC_utf8>.
585
586 =for apidoc Am|bool|isGRAPH|char ch
587 Returns a boolean indicating whether the specified character is a
588 graphic character, analogous to C<m/[[:graph:]]/>.
589 See the L<top of this section|/Character classes> for an explanation of variants
590 C<isGRAPH_A>, C<isGRAPH_L1>, C<isGRAPH_uni>, C<isGRAPH_utf8>, C<isGRAPH_LC>,
591 C<isGRAPH_LC_uvchr>, and C<isGRAPH_LC_utf8>.
592
593 =for apidoc Am|bool|isLOWER|char ch
594 Returns a boolean indicating whether the specified character is a
595 lowercase character, analogous to C<m/[[:lower:]]/>.
596 See the L<top of this section|/Character classes> for an explanation of variants
597 C<isLOWER_A>, C<isLOWER_L1>, C<isLOWER_uni>, C<isLOWER_utf8>, C<isLOWER_LC>,
598 C<isLOWER_LC_uvchr>, and C<isLOWER_LC_utf8>.
599
600 =for apidoc Am|bool|isOCTAL|char ch
601 Returns a boolean indicating whether the specified character is an
602 octal digit, [0-7].
603 The only two variants are C<isOCTAL_A> and C<isOCTAL_L1>; each is identical to
604 C<isOCTAL>.
605
606 =for apidoc Am|bool|isPUNCT|char ch
607 Returns a boolean indicating whether the specified character is a
608 punctuation character, analogous to C<m/[[:punct:]]/>.
609 Note that the definition of what is punctuation isn't as
610 straightforward as one might desire.  See L<perlrecharclass/POSIX Character
611 Classes> for details.
612 See the L<top of this section|/Character classes> for an explanation of variants
613 C<isPUNCT_A>, C<isPUNCT_L1>, C<isPUNCT_uni>, C<isPUNCT_utf8>, C<isPUNCT_LC>,
614 C<isPUNCT_LC_uvchr>, and C<isPUNCT_LC_utf8>.
615
616 =for apidoc Am|bool|isSPACE|char ch
617 Returns a boolean indicating whether the specified character is a
618 whitespace character.  This is analogous
619 to what C<m/\s/> matches in a regular expression.  Starting in Perl 5.18
620 (experimentally), this also matches what C<m/[[:space:]]/> does.
621 ("Experimentally" means that this change may be backed out in 5.20 or 5.22 if
622 field experience indicates that it was unwise.)  Prior to 5.18, only the
623 locale forms of this macro (the ones with C<LC> in their names) matched
624 precisely what C<m/[[:space:]]/> does.  In those releases, the only difference,
625 in the non-locale variants, was that C<isSPACE()> did not match a vertical tab.
626 (See L</isPSXSPC> for a macro that matches a vertical tab in all releases.)
627 See the L<top of this section|/Character classes> for an explanation of variants
628 C<isSPACE_A>, C<isSPACE_L1>, C<isSPACE_uni>, C<isSPACE_utf8>, C<isSPACE_LC>,
629 C<isSPACE_LC_uvchr>, and C<isSPACE_LC_utf8>.
630
631 =for apidoc Am|bool|isPSXSPC|char ch
632 (short for Posix Space)
633 Starting in 5.18, this is identical (experimentally) in all its forms to the
634 corresponding C<isSPACE()> macros.  ("Experimentally" means that this change
635 may be backed out in 5.20 or 5.22 if field experience indicates that it
636 was unwise.)
637 The locale forms of this macro are identical to their corresponding
638 C<isSPACE()> forms in all Perl releases.  In releases prior to 5.18, the
639 non-locale forms differ from their C<isSPACE()> forms only in that the
640 C<isSPACE()> forms don't match a Vertical Tab, and the C<isPSXSPC()> forms do.
641 Otherwise they are identical.  Thus this macro is analogous to what
642 C<m/[[:space:]]/> matches in a regular expression.
643 See the L<top of this section|/Character classes> for an explanation of variants
644 C<isPSXSPC_A>, C<isPSXSPC_L1>, C<isPSXSPC_uni>, C<isPSXSPC_utf8>, C<isPSXSPC_LC>,
645 C<isPSXSPC_LC_uvchr>, and C<isPSXSPC_LC_utf8>.
646
647 =for apidoc Am|bool|isUPPER|char ch
648 Returns a boolean indicating whether the specified character is an
649 uppercase character, analogous to C<m/[[:upper:]]/>.
650 See the L<top of this section|/Character classes> for an explanation of variants
651 C<isUPPER_A>, C<isUPPER_L1>, C<isUPPER_uni>, C<isUPPER_utf8>, C<isUPPER_LC>,
652 C<isUPPER_LC_uvchr>, and C<isUPPER_LC_utf8>.
653
654 =for apidoc Am|bool|isPRINT|char ch
655 Returns a boolean indicating whether the specified character is a
656 printable character, analogous to C<m/[[:print:]]/>.
657 See the L<top of this section|/Character classes> for an explanation of variants
658 C<isPRINT_A>, C<isPRINT_L1>, C<isPRINT_uni>, C<isPRINT_utf8>, C<isPRINT_LC>,
659 C<isPRINT_LC_uvchr>, and C<isPRINT_LC_utf8>.
660
661 =for apidoc Am|bool|isWORDCHAR|char ch
662 Returns a boolean indicating whether the specified character is a character
663 that is a word character, analogous to what C<m/\w/> and C<m/[[:word:]]/> match
664 in a regular expression.  A word character is an alphabetic character, a
665 decimal digit, a connecting punctuation character (such as an underscore), or
666 a "mark" character that attaches to one of those (like some sort of accent).
667 C<isALNUM()> is a synonym provided for backward compatibility, even though a
668 word character includes more than the standard C language meaning of
669 alphanumeric.
670 See the L<top of this section|/Character classes> for an explanation of variants
671 C<isWORDCHAR_A>, C<isWORDCHAR_L1>, C<isWORDCHAR_uni>, C<isWORDCHAR_utf8>,
672 C<isWORDCHAR_LC>, C<isWORDCHAR_LC_uvchr>, and C<isWORDCHAR_LC_utf8>.
673
674 =for apidoc Am|bool|isXDIGIT|char ch
675 Returns a boolean indicating whether the specified character is a hexadecimal
676 digit.  In the ASCII range these are C<[0-9A-Fa-f]>.  Variants C<isXDIGIT_A()>
677 and C<isXDIGIT_L1()> are identical to C<isXDIGIT()>.
678 See the L<top of this section|/Character classes> for an explanation of variants
679 C<isXDIGIT_uni>, C<isXDIGIT_utf8>, C<isXDIGIT_LC>, C<isXDIGIT_LC_uvchr>, and
680 C<isXDIGIT_LC_utf8>.
681
682 =for apidoc Am|bool|isIDFIRST|char ch
683 Returns a boolean indicating whether the specified character can be the first
684 character of an identifier.  This is very close to, but not quite the same as
685 the official Unicode property C<XID_Start>.  The difference is that this
686 returns true only if the input character also matches L</isWORDCHAR>.
687 See the L<top of this section|/Character classes> for an explanation of variants
688 C<isIDFIRST_A>, C<isIDFIRST_L1>, C<isIDFIRST_uni>, C<isIDFIRST_utf8>,
689 C<isIDFIRST_LC>, C<isIDFIRST_LC_uvchr>, and C<isIDFIRST_LC_utf8>.
690
691 =for apidoc Am|bool|isIDCONT|char ch
692 Returns a boolean indicating whether the specified character can be the
693 second or succeeding character of an identifier.  This is very close to, but
694 not quite the same as the official Unicode property C<XID_Continue>.  The
695 difference is that this returns true only if the input character also matches
696 L</isWORDCHAR>.  See the L<top of this section|/Character classes> for an
697 explanation of variants C<isIDCONT_A>, C<isIDCONT_L1>, C<isIDCONT_uni>,
698 C<isIDCONT_utf8>, C<isIDCONT_LC>, C<isIDCONT_LC_uvchr>, and
699 C<isIDCONT_LC_utf8>.
700
701 =head1 Miscellaneous Functions
702
703 =for apidoc Am|U8|READ_XDIGIT|char str*
704 Returns the value of an ASCII-range hex digit and advances the string pointer.
705 Behaviour is only well defined when isXDIGIT(*str) is true.
706
707 =head1 Character case changing
708
709 =for apidoc Am|U8|toUPPER|U8 ch
710 Converts the specified character to uppercase.  If the input is anything but an
711 ASCII lowercase character, that input character itself is returned.  Variant
712 C<toUPPER_A> is equivalent.
713
714 =for apidoc Am|UV|toUPPER_uni|UV cp|U8* s|STRLEN* lenp
715 Converts the Unicode code point C<cp> to its uppercase version, and
716 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
717 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
718 bytes since the uppercase version may be longer than the original character.
719
720 The first code point of the uppercased version is returned
721 (but note, as explained just above, that there may be more.)
722
723 =for apidoc Am|UV|toUPPER_utf8|U8* p|U8* s|STRLEN* lenp
724 Converts the UTF-8 encoded character at C<p> to its uppercase version, and
725 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
726 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
727 bytes since the uppercase version may be longer than the original character.
728
729 The first code point of the uppercased version is returned
730 (but note, as explained just above, that there may be more.)
731
732 The input character at C<p> is assumed to be well-formed.
733
734 =for apidoc Am|U8|toFOLD|U8 ch
735 Converts the specified character to foldcase.  If the input is anything but an
736 ASCII uppercase character, that input character itself is returned.  Variant
737 C<toFOLD_A> is equivalent.  (There is no equivalent C<to_FOLD_L1> for the full
738 Latin1 range, as the full generality of L</toFOLD_uni> is needed there.)
739
740 =for apidoc Am|UV|toFOLD_uni|UV cp|U8* s|STRLEN* lenp
741 Converts the Unicode code point C<cp> to its foldcase version, and
742 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
743 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
744 bytes since the foldcase version may be longer than the original character.
745
746 The first code point of the foldcased version is returned
747 (but note, as explained just above, that there may be more.)
748
749 =for apidoc Am|UV|toFOLD_utf8|U8* p|U8* s|STRLEN* lenp
750 Converts the UTF-8 encoded character at C<p> to its foldcase version, and
751 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
752 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
753 bytes since the foldcase version may be longer than the original character.
754
755 The first code point of the foldcased version is returned
756 (but note, as explained just above, that there may be more.)
757
758 The input character at C<p> is assumed to be well-formed.
759
760 =for apidoc Am|U8|toLOWER|U8 ch
761 Converts the specified character to lowercase.  If the input is anything but an
762 ASCII uppercase character, that input character itself is returned.  Variant
763 C<toLOWER_A> is equivalent.
764
765 =for apidoc Am|U8|toLOWER_L1|U8 ch
766 Converts the specified Latin1 character to lowercase.  The results are undefined if
767 the input doesn't fit in a byte.
768
769 =for apidoc Am|U8|toLOWER_LC|U8 ch
770 Converts the specified character to lowercase using the current locale's rules,
771 if possible; otherwise returns the input character itself.
772
773 =for apidoc Am|UV|toLOWER_uni|UV cp|U8* s|STRLEN* lenp
774 Converts the Unicode code point C<cp> to its lowercase version, and
775 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
776 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
777 bytes since the lowercase version may be longer than the original character.
778
779 The first code point of the lowercased version is returned
780 (but note, as explained just above, that there may be more.)
781
782 =for apidoc Am|UV|toLOWER_utf8|U8* p|U8* s|STRLEN* lenp
783 Converts the UTF-8 encoded character at C<p> to its lowercase version, and
784 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
785 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
786 bytes since the lowercase version may be longer than the original character.
787
788 The first code point of the lowercased version is returned
789 (but note, as explained just above, that there may be more.)
790
791 The input character at C<p> is assumed to be well-formed.
792
793 =for apidoc Am|U8|toLOWER_LC|U8 ch
794 Converts the specified character to lowercase using the current locale's rules,
795 if possible; otherwise returns the input character itself.
796
797 =for apidoc Am|U8|toTITLE|U8 ch
798 Converts the specified character to titlecase.  If the input is anything but an
799 ASCII lowercase character, that input character itself is returned.  Variant
800 C<toTITLE_A> is equivalent.  (There is no C<toTITLE_L1> for the full Latin1 range,
801 as the full generality of L</toTITLE_uni> is needed there.  Titlecase is not a
802 concept used in locale handling, so there is no functionality for that.)
803
804 =for apidoc Am|UV|toTITLE_uni|UV cp|U8* s|STRLEN* lenp
805 Converts the Unicode code point C<cp> to its titlecase version, and
806 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
807 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
808 bytes since the titlecase version may be longer than the original character.
809
810 The first code point of the titlecased version is returned
811 (but note, as explained just above, that there may be more.)
812
813 =for apidoc Am|UV|toTITLE_utf8|U8* p|U8* s|STRLEN* lenp
814 Converts the UTF-8 encoded character at C<p> to its titlecase version, and
815 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
816 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
817 bytes since the titlecase version may be longer than the original character.
818
819 The first code point of the titlecased version is returned
820 (but note, as explained just above, that there may be more.)
821
822 The input character at C<p> is assumed to be well-formed.
823
824 =cut
825
826 XXX Still undocumented isVERTWS_uni and _utf8; it's unclear what their names
827 really should be.  Also toUPPER_LC and toFOLD_LC, which are subject to change.
828
829 Note that these macros are repeated in Devel::PPPort, so should also be
830 patched there.  The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
831
832 */
833
834 /* Specify the widest unsigned type on the platform.  Use U64TYPE because U64
835  * is known only in the perl core, and this macro can be called from outside
836  * that */
837 #ifdef HAS_QUAD
838 #   define WIDEST_UTYPE U64TYPE
839 #else
840 #   define WIDEST_UTYPE U32
841 #endif
842
843 /* FITS_IN_8_BITS(c) returns true if c doesn't have  a bit set other than in
844  * the lower 8.  It is designed to be hopefully bomb-proof, making sure that no
845  * bits of information are lost even on a 64-bit machine, but to get the
846  * compiler to optimize it out if possible.  This is because Configure makes
847  * sure that the machine has an 8-bit byte, so if c is stored in a byte, the
848  * sizeof() guarantees that this evaluates to a constant true at compile time.
849  */
850 #define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || !(((WIDEST_UTYPE)(c)) & ~0xFF))
851
852 #ifdef EBCDIC
853 #   ifndef _ALL_SOURCE
854         /* This returns the wrong results on at least z/OS unless this is
855          * defined. */
856 #       error   _ALL_SOURCE should probably be defined
857 #   endif
858
859     /* We could be called without perl.h, in which case NATIVE_TO_ASCII() is
860      * likely not defined, and so we use the native function */
861 #   define isASCII(c)    isascii(c)
862 #else
863 #   define isASCII(c)    ((WIDEST_UTYPE)(c) < 128)
864 #endif
865
866 #define isASCII_A(c)  isASCII(c)
867 #define isASCII_L1(c)  isASCII(c)
868
869 /* The lower 3 bits in both the ASCII and EBCDIC representations of '0' are 0,
870  * and the 8 possible permutations of those bits exactly comprise the 8 octal
871  * digits */
872 #define isOCTAL_A(c)  cBOOL(FITS_IN_8_BITS(c) && (0xF8 & (c)) == '0')
873
874 /* ASCII range only */
875 #ifdef H_PERL       /* If have access to perl.h, lookup in its table */
876
877 /* Character class numbers.  For internal core Perl use only.  The ones less
878  * than 32 are used in PL_charclass[] and the ones up through the one that
879  * corresponds to <_HIGHEST_REGCOMP_DOT_H_SYNC> are used by regcomp.h and
880  * related files.  PL_charclass ones use names used in l1_char_class_tab.h but
881  * their actual definitions are here.  If that file has a name not used here,
882  * it won't compile.
883  *
884  * The first group of these is ordered in what I (khw) estimate to be the
885  * frequency of their use.  This gives a slight edge to exiting a loop earlier
886  * (in reginclass() in regexec.c) */
887 #  define _CC_WORDCHAR           0      /* \w and [:word:] */
888 #  define _CC_DIGIT              1      /* \d and [:digit:] */
889 #  define _CC_ALPHA              2      /* [:alpha:] */
890 #  define _CC_LOWER              3      /* [:lower:] */
891 #  define _CC_UPPER              4      /* [:upper:] */
892 #  define _CC_PUNCT              5      /* [:punct:] */
893 #  define _CC_PRINT              6      /* [:print:] */
894 #  define _CC_ALPHANUMERIC       7      /* [:alnum:] */
895 #  define _CC_GRAPH              8      /* [:graph:] */
896 #  define _CC_CASED              9      /* [:lower:] and [:upper:] under /i */
897
898 #define _FIRST_NON_SWASH_CC     10
899 /* The character classes above are implemented with swashes.  The second group
900  * (just below) contains the ones implemented without.  These are also sorted
901  * in rough order of the frequency of their use, except that \v should be last,
902  * as it isn't a real Posix character class, and some (small) inefficiencies in
903  * regular expression handling would be introduced by putting it in the middle
904  * of those that are.  Also, cntrl and ascii come after the others as it may be
905  * useful to group these which have no members that match above Latin1, (or
906  * above ASCII in the latter case) */
907
908 #  define _CC_SPACE             10      /* \s */
909 #  define _CC_BLANK             11      /* [:blank:] */
910 #  define _CC_XDIGIT            12      /* [:xdigit:] */
911 #  define _CC_PSXSPC            13      /* [:space:] */
912 #  define _CC_CNTRL             14      /* [:cntrl:] */
913 #  define _CC_ASCII             15      /* [:ascii:] */
914 #  define _CC_VERTSPACE         16      /* \v */
915
916 #  define _HIGHEST_REGCOMP_DOT_H_SYNC _CC_VERTSPACE
917
918 /* The members of the third group below do not need to be coordinated with data
919  * structures in regcomp.[ch] and regexec.c.  But they should be added to
920  * bootstrap_ctype() */
921 #  define _CC_IDFIRST           17
922 #  define _CC_CHARNAME_CONT     18
923 #  define _CC_NONLATIN1_FOLD    19
924 #  define _CC_QUOTEMETA         20
925 #  define _CC_NON_FINAL_FOLD    21
926 #  define _CC_IS_IN_SOME_FOLD   22
927 #  define _CC_BACKSLASH_FOO_LBRACE_IS_META 31 /* temp, see mk_PL_charclass.pl */
928 /* Unused: 23-30
929  * If more bits are needed, one could add a second word for non-64bit
930  * QUAD_IS_INT systems, using some #ifdefs to distinguish between having a 2nd
931  * word or not.  The IS_IN_SOME_FOLD bit is the most easily expendable, as it
932  * is used only for optimization (as of this writing), and differs in the
933  * Latin1 range from the ALPHA bit only in two relatively unimportant
934  * characters: the masculine and feminine ordinal indicators, so removing it
935  * would just cause /i regexes which match them to run less efficiently */
936
937 #if defined(PERL_CORE) || defined(PERL_EXT)
938 /* An enum version of the character class numbers, to help compilers
939  * optimize */
940 typedef enum {
941     _CC_ENUM_ALPHA          = _CC_ALPHA,
942     _CC_ENUM_ALPHANUMERIC   = _CC_ALPHANUMERIC,
943     _CC_ENUM_ASCII          = _CC_ASCII,
944     _CC_ENUM_BLANK          = _CC_BLANK,
945     _CC_ENUM_CASED          = _CC_CASED,
946     _CC_ENUM_CNTRL          = _CC_CNTRL,
947     _CC_ENUM_DIGIT          = _CC_DIGIT,
948     _CC_ENUM_GRAPH          = _CC_GRAPH,
949     _CC_ENUM_LOWER          = _CC_LOWER,
950     _CC_ENUM_PRINT          = _CC_PRINT,
951     _CC_ENUM_PSXSPC         = _CC_PSXSPC,
952     _CC_ENUM_PUNCT          = _CC_PUNCT,
953     _CC_ENUM_SPACE          = _CC_SPACE,
954     _CC_ENUM_UPPER          = _CC_UPPER,
955     _CC_ENUM_VERTSPACE      = _CC_VERTSPACE,
956     _CC_ENUM_WORDCHAR       = _CC_WORDCHAR,
957     _CC_ENUM_XDIGIT         = _CC_XDIGIT
958 } _char_class_number;
959 #endif
960
961 #define POSIX_SWASH_COUNT _FIRST_NON_SWASH_CC
962 #define POSIX_CC_COUNT    (_HIGHEST_REGCOMP_DOT_H_SYNC + 1)
963
964 #if defined(PERL_IN_UTF8_C) || defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
965 #   if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
966        || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6                   \
967        || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9
968       #error Need to adjust order of swash_property_names[]
969 #   endif
970
971 /* This is declared static in each of the few files that this is #defined for
972  * to keep them from being publicly accessible.  Hence there is a small amount
973  * of wasted space */
974
975 static const char* const swash_property_names[] = {
976     "XPosixWord",
977     "XPosixDigit",
978     "XPosixAlpha",
979     "XPosixLower",
980     "XPosixUpper",
981     "XPosixPunct",
982     "XPosixPrint",
983     "XPosixAlnum",
984     "XPosixGraph",
985     "Cased"
986 };
987 #endif
988
989 #  ifdef DOINIT
990 EXTCONST  U32 PL_charclass[] = {
991 #    include "l1_char_class_tab.h"
992 };
993
994 #  else /* ! DOINIT */
995 EXTCONST U32 PL_charclass[];
996 #  endif
997 #endif  /* Has perl.h */
998
999 #if defined(H_PERL) && ! defined(BOOTSTRAP_CHARSET)
1000
1001     /* The 1U keeps Solaris from griping when shifting sets the uppermost bit */
1002 #   define _CC_mask(classnum) (1U << (classnum))
1003 #   define _generic_isCC(c, classnum) cBOOL(FITS_IN_8_BITS(c) \
1004                 && (PL_charclass[(U8) (c)] & _CC_mask(classnum)))
1005
1006     /* The mask for the _A versions of the macros; it just adds in the bit for
1007      * ASCII. */
1008 #   define _CC_mask_A(classnum) (_CC_mask(classnum) | _CC_mask(_CC_ASCII))
1009
1010     /* The _A version makes sure that both the desired bit and the ASCII bit
1011      * are present */
1012 #   define _generic_isCC_A(c, classnum) (FITS_IN_8_BITS(c)  \
1013         && ((PL_charclass[(U8) (c)] & _CC_mask_A(classnum)) \
1014                                 == _CC_mask_A(classnum)))
1015
1016 #   define isALPHA_A(c)  _generic_isCC_A(c, _CC_ALPHA)
1017 #   define isALPHANUMERIC_A(c) _generic_isCC_A(c, _CC_ALPHANUMERIC)
1018 #   define isBLANK_A(c)  _generic_isCC_A(c, _CC_BLANK)
1019 #   define isCNTRL_A(c)  _generic_isCC_A(c, _CC_CNTRL)
1020 #   define isDIGIT_A(c)  _generic_isCC(c, _CC_DIGIT)
1021 #   define isGRAPH_A(c)  _generic_isCC_A(c, _CC_GRAPH)
1022 #   define isLOWER_A(c)  _generic_isCC_A(c, _CC_LOWER)
1023 #   define isPRINT_A(c)  _generic_isCC_A(c, _CC_PRINT)
1024 #   define isPSXSPC_A(c) _generic_isCC_A(c, _CC_PSXSPC)
1025 #   define isPUNCT_A(c)  _generic_isCC_A(c, _CC_PUNCT)
1026 #   define isSPACE_A(c)  _generic_isCC_A(c, _CC_SPACE)
1027 #   define isUPPER_A(c)  _generic_isCC_A(c, _CC_UPPER)
1028 #   define isWORDCHAR_A(c) _generic_isCC_A(c, _CC_WORDCHAR)
1029 #   define isXDIGIT_A(c)  _generic_isCC(c, _CC_XDIGIT)
1030 #   define isIDFIRST_A(c) _generic_isCC_A(c, _CC_IDFIRST)
1031 #   define isALPHA_L1(c)  _generic_isCC(c, _CC_ALPHA)
1032 #   define isALPHANUMERIC_L1(c) _generic_isCC(c, _CC_ALPHANUMERIC)
1033 #   define isBLANK_L1(c)  _generic_isCC(c, _CC_BLANK)
1034
1035     /* continuation character for legal NAME in \N{NAME} */
1036 #   define isCHARNAME_CONT(c) _generic_isCC(c, _CC_CHARNAME_CONT)
1037
1038 #   define isCNTRL_L1(c)  _generic_isCC(c, _CC_CNTRL)
1039 #   define isGRAPH_L1(c)  _generic_isCC(c, _CC_GRAPH)
1040 #   define isLOWER_L1(c)  _generic_isCC(c, _CC_LOWER)
1041 #   define isPRINT_L1(c)  _generic_isCC(c, _CC_PRINT)
1042 #   define isPSXSPC_L1(c) _generic_isCC(c, _CC_PSXSPC)
1043 #   define isPUNCT_L1(c)  _generic_isCC(c, _CC_PUNCT)
1044 #   define isSPACE_L1(c)  _generic_isCC(c, _CC_SPACE)
1045 #   define isUPPER_L1(c)  _generic_isCC(c, _CC_UPPER)
1046 #   define isWORDCHAR_L1(c) _generic_isCC(c, _CC_WORDCHAR)
1047 #   define isIDFIRST_L1(c) _generic_isCC(c, _CC_IDFIRST)
1048
1049     /* Either participates in a fold with a character above 255, or is a
1050      * multi-char fold */
1051 #   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)))
1052
1053 #   define _isQUOTEMETA(c) _generic_isCC(c, _CC_QUOTEMETA)
1054 #   define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
1055                                             _generic_isCC(c, _CC_NON_FINAL_FOLD)
1056 #   define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
1057                                             _generic_isCC(c, _CC_IS_IN_SOME_FOLD)
1058 #else   /* Either don't have perl.h or don't want to use char_class_tab.h */
1059
1060     /* If we don't have perl.h, we are compiling a utility program.  Below we
1061      * hard-code various macro definitions that wouldn't otherwise be available
1062      * to it.  We can also get here if we are configured to bootstrap up Perl
1063      * on a non-ASCII platform that doesn't have a working Perl (currently only
1064      * EBCDIC).  For these we currently use the native definitions to get
1065      * things going.  (It should also be possible to use the translation
1066      * function NATIVE_TO_LATIN1(), but that is an extra layer of dependence on
1067      * Perl, so it is currently avoided for the macros where it's possible to
1068      * do so.) */
1069 #   ifdef EBCDIC
1070         /* Use the native functions.  They likely will return false for all
1071          * non-ASCII values, but this makes sure */
1072 #       define isALPHA_A(c)    (isASCII(c) && isalpha(c))
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) ? (c) + ('a' - 'A') : (c))
1201 #define toUPPER(c)  (isLOWER(c) ? (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) ? tolower((unsigned char)(c)) : (c))
1281 #    define toUPPER_LC(c) (FITS_IN_8_BITS(c) ? 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 #define READ_XDIGIT(s) (isALPHA(*(s)) ? ((*(s)++ + 9) & 0xf) : (*(s)++ & 0xf))
1557
1558 /*
1559 =head1 Memory Management
1560
1561 =for apidoc Am|void|Newx|void* ptr|int nitems|type
1562 The XSUB-writer's interface to the C C<malloc> function.
1563
1564 In 5.9.3, Newx() and friends replace the older New() API, and drops
1565 the first parameter, I<x>, a debug aid which allowed callers to identify
1566 themselves.  This aid has been superseded by a new build option,
1567 PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>).  The older API is still
1568 there for use in XS modules supporting older perls.
1569
1570 =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
1571 The XSUB-writer's interface to the C C<malloc> function, with
1572 cast.  See also C<Newx>.
1573
1574 =for apidoc Am|void|Newxz|void* ptr|int nitems|type
1575 The XSUB-writer's interface to the C C<malloc> function.  The allocated
1576 memory is zeroed with C<memzero>.  See also C<Newx>.
1577
1578 =for apidoc Am|void|Renew|void* ptr|int nitems|type
1579 The XSUB-writer's interface to the C C<realloc> function.
1580
1581 =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
1582 The XSUB-writer's interface to the C C<realloc> function, with
1583 cast.
1584
1585 =for apidoc Am|void|Safefree|void* ptr
1586 The XSUB-writer's interface to the C C<free> function.
1587
1588 =for apidoc Am|void|Move|void* src|void* dest|int nitems|type
1589 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
1590 source, C<dest> is the destination, C<nitems> is the number of items, and
1591 C<type> is the type.  Can do overlapping moves.  See also C<Copy>.
1592
1593 =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
1594 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1595 optimise.
1596
1597 =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
1598 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
1599 source, C<dest> is the destination, C<nitems> is the number of items, and
1600 C<type> is the type.  May fail on overlapping copies.  See also C<Move>.
1601
1602 =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
1603
1604 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1605 optimise.
1606
1607 =for apidoc Am|void|Zero|void* dest|int nitems|type
1608
1609 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
1610 destination, C<nitems> is the number of items, and C<type> is the type.
1611
1612 =for apidoc Am|void *|ZeroD|void* dest|int nitems|type
1613
1614 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1615 optimise.
1616
1617 =for apidoc Am|void|StructCopy|type *src|type *dest|type
1618 This is an architecture-independent macro to copy one structure to another.
1619
1620 =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
1621
1622 Fill up memory with a byte pattern (a byte repeated over and over
1623 again) that hopefully catches attempts to access uninitialized memory.
1624
1625 =for apidoc Am|void|PoisonNew|void* dest|int nitems|type
1626
1627 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
1628
1629 =for apidoc Am|void|PoisonFree|void* dest|int nitems|type
1630
1631 PoisonWith(0xEF) for catching access to freed memory.
1632
1633 =for apidoc Am|void|Poison|void* dest|int nitems|type
1634
1635 PoisonWith(0xEF) for catching access to freed memory.
1636
1637 =cut */
1638
1639 /* Maintained for backwards-compatibility only. Use newSV() instead. */
1640 #ifndef PERL_CORE
1641 #define NEWSV(x,len)    newSV(len)
1642 #endif
1643
1644 #define MEM_SIZE_MAX ((MEM_SIZE)~0)
1645
1646 /* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
1647  * overly eager compilers that will bleat about e.g.
1648  * (U16)n > (size_t)~0/sizeof(U16) always being false. */
1649 #ifdef PERL_MALLOC_WRAP
1650 #define MEM_WRAP_CHECK(n,t) \
1651         (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (croak_memory_wrap(),0))
1652 #define MEM_WRAP_CHECK_1(n,t,a) \
1653         (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
1654 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
1655
1656 #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)))
1657 #else
1658
1659 #define MEM_WRAP_CHECK(n,t)
1660 #define MEM_WRAP_CHECK_1(n,t,a)
1661 #define MEM_WRAP_CHECK_2(n,t,a,b)
1662 #define MEM_WRAP_CHECK_(n,t)
1663
1664 #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
1665
1666 #endif
1667
1668 #ifdef PERL_MEM_LOG
1669 /*
1670  * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
1671  * go through functions, which are handy for debugging breakpoints, but
1672  * which more importantly get the immediate calling environment (file and
1673  * line number, and C function name if available) passed in.  This info can
1674  * then be used for logging the calls, for which one gets a sample
1675  * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
1676  *
1677  * Known problems:
1678  * - not all memory allocs get logged, only those
1679  *   that go through Newx() and derivatives (while all
1680  *   Safefrees do get logged)
1681  * - __FILE__ and __LINE__ do not work everywhere
1682  * - __func__ or __FUNCTION__ even less so
1683  * - I think more goes on after the perlio frees but
1684  *   the thing is that STDERR gets closed (as do all
1685  *   the file descriptors)
1686  * - no deeper calling stack than the caller of the Newx()
1687  *   or the kind, but do I look like a C reflection/introspection
1688  *   utility to you?
1689  * - the function prototypes for the logging functions
1690  *   probably should maybe be somewhere else than handy.h
1691  * - one could consider inlining (macrofying) the logging
1692  *   for speed, but I am too lazy
1693  * - one could imagine recording the allocations in a hash,
1694  *   (keyed by the allocation address?), and maintain that
1695  *   through reallocs and frees, but how to do that without
1696  *   any News() happening...?
1697  * - lots of -Ddefines to get useful/controllable output
1698  * - lots of ENV reads
1699  */
1700
1701 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);
1702
1703 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);
1704
1705 PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
1706
1707 # ifdef PERL_CORE
1708 #  ifndef PERL_MEM_LOG_NOIMPL
1709 enum mem_log_type {
1710   MLT_ALLOC,
1711   MLT_REALLOC,
1712   MLT_FREE,
1713   MLT_NEW_SV,
1714   MLT_DEL_SV
1715 };
1716 #  endif
1717 #  if defined(PERL_IN_SV_C)  /* those are only used in sv.c */
1718 void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1719 void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1720 #  endif
1721 # endif
1722
1723 #endif
1724
1725 #ifdef PERL_MEM_LOG
1726 #define MEM_LOG_ALLOC(n,t,a)     Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
1727 #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
1728 #define MEM_LOG_FREE(a)          Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
1729 #endif
1730
1731 #ifndef MEM_LOG_ALLOC
1732 #define MEM_LOG_ALLOC(n,t,a)     (a)
1733 #endif
1734 #ifndef MEM_LOG_REALLOC
1735 #define MEM_LOG_REALLOC(n,t,v,a) (a)
1736 #endif
1737 #ifndef MEM_LOG_FREE
1738 #define MEM_LOG_FREE(a)          (a)
1739 #endif
1740
1741 #define Newx(v,n,t)     (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1742 #define Newxc(v,n,t,c)  (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1743 #define Newxz(v,n,t)    (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
1744
1745 #ifndef PERL_CORE
1746 /* pre 5.9.x compatibility */
1747 #define New(x,v,n,t)    Newx(v,n,t)
1748 #define Newc(x,v,n,t,c) Newxc(v,n,t,c)
1749 #define Newz(x,v,n,t)   Newxz(v,n,t)
1750 #endif
1751
1752 #define Renew(v,n,t) \
1753           (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1754 #define Renewc(v,n,t,c) \
1755           (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1756
1757 #ifdef PERL_POISON
1758 #define Safefree(d) \
1759   ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
1760 #else
1761 #define Safefree(d)     safefree(MEM_LOG_FREE((Malloc_t)(d)))
1762 #endif
1763
1764 #define Move(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1765 #define Copy(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1766 #define Zero(d,n,t)     (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
1767
1768 #define MoveD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1769 #define CopyD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1770 #ifdef HAS_MEMSET
1771 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
1772 #else
1773 /* Using bzero(), which returns void.  */
1774 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
1775 #endif
1776
1777 #define PoisonWith(d,n,t,b)     (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
1778 #define PoisonNew(d,n,t)        PoisonWith(d,n,t,0xAB)
1779 #define PoisonFree(d,n,t)       PoisonWith(d,n,t,0xEF)
1780 #define Poison(d,n,t)           PoisonFree(d,n,t)
1781
1782 #ifdef USE_STRUCT_COPY
1783 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
1784 #else
1785 #define StructCopy(s,d,t) Copy(s,d,1,t)
1786 #endif
1787
1788 #define C_ARRAY_LENGTH(a)       (sizeof(a)/sizeof((a)[0]))
1789 #define C_ARRAY_END(a)          (a) + (sizeof(a)/sizeof((a)[0]))
1790
1791 #ifdef NEED_VA_COPY
1792 # ifdef va_copy
1793 #  define Perl_va_copy(s, d) va_copy(d, s)
1794 # else
1795 #  if defined(__va_copy)
1796 #   define Perl_va_copy(s, d) __va_copy(d, s)
1797 #  else
1798 #   define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
1799 #  endif
1800 # endif
1801 #endif
1802
1803 /* convenience debug macros */
1804 #ifdef USE_ITHREADS
1805 #define pTHX_FORMAT  "Perl interpreter: 0x%p"
1806 #define pTHX__FORMAT ", Perl interpreter: 0x%p"
1807 #define pTHX_VALUE_   (void *)my_perl,
1808 #define pTHX_VALUE    (void *)my_perl
1809 #define pTHX__VALUE_ ,(void *)my_perl,
1810 #define pTHX__VALUE  ,(void *)my_perl
1811 #else
1812 #define pTHX_FORMAT
1813 #define pTHX__FORMAT
1814 #define pTHX_VALUE_
1815 #define pTHX_VALUE
1816 #define pTHX__VALUE_
1817 #define pTHX__VALUE
1818 #endif /* USE_ITHREADS */
1819
1820 /* Perl_deprecate was not part of the public API, and did not have a deprecate()
1821    shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
1822    CPAN::Unpack show any users outside the core.  */
1823 #ifdef PERL_CORE
1824 #  define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
1825 #endif
1826
1827 /* Internal macros to deal with gids and uids */
1828 #ifdef PERL_CORE
1829
1830 #  if Uid_t_size > IVSIZE
1831 #    define sv_setuid(sv, uid)       sv_setnv((sv), (NV)(uid))
1832 #    define SvUID(sv)                SvNV(sv)
1833 #  else
1834 #    if Uid_t_sign <= 0
1835 #      define sv_setuid(sv, uid)       sv_setiv((sv), (IV)(uid))
1836 #      define SvUID(sv)                SvIV(sv)
1837 #    else
1838 #      define sv_setuid(sv, uid)       sv_setuv((sv), (UV)(uid))
1839 #      define SvUID(sv)                SvUV(sv)
1840 #    endif
1841 #  endif /* Uid_t_size */
1842
1843 #  if Gid_t_size > IVSIZE
1844 #    define sv_setgid(sv, gid)       sv_setnv((sv), (NV)(gid))
1845 #    define SvGID(sv)                SvNV(sv)
1846 #  else
1847 #    if Gid_t_sign <= 0
1848 #      define sv_setgid(sv, gid)       sv_setiv((sv), (IV)(gid))
1849 #      define SvGID(sv)                SvIV(sv)
1850 #    else
1851 #      define sv_setgid(sv, gid)       sv_setuv((sv), (UV)(gid))
1852 #      define SvGID(sv)                SvUV(sv)
1853 #    endif
1854 #  endif /* Gid_t_size */
1855
1856 #endif
1857
1858 #endif  /* HANDY_H */
1859
1860 /*
1861  * Local variables:
1862  * c-indentation-style: bsd
1863  * c-basic-offset: 4
1864  * indent-tabs-mode: nil
1865  * End:
1866  *
1867  * ex: set ts=8 sts=4 sw=4 et:
1868  */