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