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