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