This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
223324adc58f9bc8d75853adcc4df6e10d03d493
[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|isALPHANUMERIC|char ch
540 Returns a boolean indicating whether the specified character is a either an
541 alphabetic character or decimal digit in the platform's native character set,
542 analogous to C<m/[[:alnum:]]/>.
543 See the L<top of this section|/Character classes> for an explanation of variants
544 C<isALPHANUMERIC_A>, C<isALPHANUMERIC_L1>, C<isALPHANUMERIC_uni>,
545 C<isALPHANUMERIC_utf8>, C<isALPHANUMERIC_LC> C<isALPHANUMERIC_LC_uvchr>, and
546 C<isALPHANUMERIC_LC_utf8>.
547
548 =for apidoc Am|bool|isASCII|char ch
549 Returns a boolean indicating whether the specified character is one of the 128
550 characters in the ASCII character set, analogous to C<m/[[:ascii:]]/>.
551 On non-ASCII platforms, it is if this
552 character corresponds to an ASCII character.  Variants C<isASCII_A()> and
553 C<isASCII_L1()> are identical to C<isASCII()>.
554 See the L<top of this section|/Character classes> for an explanation of variants
555 C<isASCII_uni>, C<isASCII_utf8>, C<isASCII_LC>, C<isASCII_LC_uvchr>, and
556 C<isASCII_LC_utf8>.  Note, however, that some platforms do not have the C
557 library routine C<isascii()>.  In these cases, the variants whose names contain
558 C<LC> are the same as the corresponding ones without.
559
560 =for apidoc Am|bool|isBLANK|char ch
561 Returns a boolean indicating whether the specified character is a
562 character considered to be a blank in the platform's native character set,
563 analogous to C<m/[[:blank:]]/>.
564 See the L<top of this section|/Character classes> for an explanation of variants
565 C<isBLANK_A>, C<isBLANK_L1>, C<isBLANK_uni>, C<isBLANK_utf8>, C<isBLANK_LC>
566 C<isBLANK_LC_uvchr>, and C<isBLANK_LC_utf8>.  Note, however, that some
567 platforms do not have the C library routine C<isblank()>.  In these cases, the
568 variants whose names contain C<LC> are the same as the corresponding ones
569 without.
570
571 =for apidoc Am|bool|isCNTRL|char ch
572 Returns a boolean indicating whether the specified character is a
573 control character in the platform's native character set,
574 analogous to C<m/[[:cntrl:]]/>.
575 See the L<top of this section|/Character classes> for an explanation of variants
576 C<isCNTRL_A>, C<isCNTRL_L1>, C<isCNTRL_uni>, C<isCNTRL_utf8>, C<isCNTRL_LC>
577 C<isCNTRL_LC_uvchr>, and C<isCNTRL_LC_utf8>.
578
579 =for apidoc Am|bool|isDIGIT|char ch
580 Returns a boolean indicating whether the specified character is a
581 digit in the platform's native character set, analogous to C<m/[[:digit:]]/>.
582 Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
583 See the L<top of this section|/Character classes> for an explanation of variants
584 C<isDIGIT_uni>, C<isDIGIT_utf8>, C<isDIGIT_LC> C<isDIGIT_LC_uvchr>, and
585 C<isDIGIT_LC_utf8>.
586
587 =for apidoc Am|bool|isGRAPH|char ch
588 Returns a boolean indicating whether the specified character is a
589 graphic character in the platform's native character set, analogous to
590 C<m/[[:graph:]]/>.
591 See the L<top of this section|/Character classes> for an explanation of variants
592 C<isGRAPH_A>, C<isGRAPH_L1>, C<isGRAPH_uni>, C<isGRAPH_utf8>, C<isGRAPH_LC>
593 C<isGRAPH_LC_uvchr>, and C<isGRAPH_LC_utf8>.
594
595 =for apidoc Am|bool|isLOWER|char ch
596 Returns a boolean indicating whether the specified character is a
597 lowercase character in the platform's native character set, analogous to
598 C<m/[[:lower:]]/>.
599 See the L<top of this section|/Character classes> for an explanation of variants
600 C<isLOWER_A>, C<isLOWER_L1>, C<isLOWER_uni>, C<isLOWER_utf8>, C<isLOWER_LC>
601 C<isLOWER_LC_uvchr>, and C<isLOWER_LC_utf8>.
602
603 =for apidoc Am|bool|isOCTAL|char ch
604 Returns a boolean indicating whether the specified character is an
605 octal digit, [0-7] in the platform's native character set.
606 The only two variants are C<isOCTAL_A> and C<isOCTAL_L1>; each is identical to
607 C<isOCTAL>.
608
609 =for apidoc Am|bool|isPUNCT|char ch
610 Returns a boolean indicating whether the specified character is a
611 punctuation character in the platform's native character set, analogous to
612 C<m/[[:punct:]]/>.  Note that the definition of what is punctuation isn't as
613 straightforward as one might desire.  See L<perlrecharclass/POSIX Character
614 Classes> for details.
615 See the L<top of this section|/Character classes> for an explanation of variants
616 C<isPUNCT_A>, C<isPUNCT_L1>, C<isPUNCT_uni>, C<isPUNCT_utf8>, C<isPUNCT_LC>
617 C<isPUNCT_LC_uvchr>, and C<isPUNCT_LC_utf8>.
618
619 =for apidoc Am|bool|isSPACE|char ch
620 Returns a boolean indicating whether the specified character is a
621 whitespace character in the platform's native character set.  This is analogous
622 to what C<m/\s/> and C<m/[[:space:]]/> match in a regular expression.
623 See the L<top of this section|/Character classes> for an explanation of variants
624 C<isSPACE_A>, C<isSPACE_L1>, C<isSPACE_uni>, C<isSPACE_utf8>, C<isSPACE_LC>
625 C<isSPACE_LC_uvchr>, and C<isSPACE_LC_utf8>.
626
627 =for apidoc Am|bool|isUPPER|char ch
628 Returns a boolean indicating whether the specified character is an
629 uppercase character in the platform's native character set, analogous to
630 C<m/[[:upper:]]/>.
631 See the L<top of this section|/Character classes> for an explanation of variants
632 C<isUPPER_A>, C<isUPPER_L1>, C<isUPPER_uni>, C<isUPPER_utf8>, C<isUPPER_LC>
633 C<isUPPER_LC_uvchr>, and C<isUPPER_LC_utf8>.
634
635 =for apidoc Am|bool|isPRINT|char ch
636 Returns a boolean indicating whether the specified character is a
637 printable character in the platform's native character set, analogous to
638 C<m/[[:print:]]/>.
639 See the L<top of this section|/Character classes> for an explanation of variants
640 C<isPRINT_A>, C<isPRINT_L1>, C<isPRINT_uni>, C<isPRINT_utf8>, C<isPRINT_LC>
641 C<isPRINT_LC_uvchr>, and C<isPRINT_LC_utf8>.
642
643 =for apidoc Am|bool|isWORDCHAR|char ch
644 Returns a boolean indicating whether the specified character is a character
645 that is a word character, analogous to what C<m/\w/> and C<m/[[:word:]]/> match
646 in a regular expression.  A word character is an alphabetic character, a
647 decimal digit, a connecting punctuation character (such as an underscore), or
648 a "mark" character that attaches to one of those (like some sort of accent).
649 C<isALNUM()> is a synonym provided for backward compatibility, even though a
650 word character includes more than the standard C language meaning of
651 alphanumeric.
652 See the L<top of this section|/Character classes> for an explanation of variants
653 C<isWORDCHAR_A>, C<isWORDCHAR_L1>, C<isWORDCHAR_uni>, C<isWORDCHAR_utf8>,
654 C<isWORDCHAR_LC>, C<isWORDCHAR_LC_uvchr>, and C<isWORDCHAR_LC_utf8>.
655
656 =for apidoc Am|bool|isXDIGIT|char ch
657 Returns a boolean indicating whether the specified character is a hexadecimal
658 digit.  In the ASCII range these are C<[0-9A-Fa-f]>.  Variants C<isXDIGIT_A()>
659 and C<isXDIGIT_L1()> are identical to C<isXDIGIT()>.
660 See the L<top of this section|/Character classes> for an explanation of variants
661 C<isXDIGIT_uni>, C<isXDIGIT_utf8>, C<isXDIGIT_LC>, C<isXDIGIT_LC_uvchr>, and
662 C<isXDIGIT_LC_utf8>.
663
664 =head1 Miscellaneous Functions
665
666 =for apidoc Am|U8|READ_XDIGIT|char str*
667 Returns the value of an ASCII-range hex digit and advances the string pointer.
668 Behaviour is only well defined when isXDIGIT(*str) is true.
669
670 =head1 Character case changing
671
672 =for apidoc Am|char|toUPPER|char ch
673 Converts the specified character to uppercase in the platform's native
674 character set, if possible; otherwise returns the input character itself.
675
676 =for apidoc Am|char|toLOWER|char ch
677 Converts the specified character to lowercase in the platform's native
678 character set, if possible; otherwise returns the input character itself.
679
680 =cut
681
682 Still undocumented are , PSXSPC, VERTSPACE, and IDFIRST, and the other
683 toUPPER etc functions
684
685 Note that these macros are repeated in Devel::PPPort, so should also be
686 patched there.  The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
687
688 */
689
690 /* Specify the widest unsigned type on the platform.  Use U64TYPE because U64
691  * is known only in the perl core, and this macro can be called from outside
692  * that */
693 #ifdef HAS_QUAD
694 #   define WIDEST_UTYPE U64TYPE
695 #else
696 #   define WIDEST_UTYPE U32
697 #endif
698
699 /* FITS_IN_8_BITS(c) returns true if c doesn't have  a bit set other than in
700  * the lower 8.  It is designed to be hopefully bomb-proof, making sure that no
701  * bits of information are lost even on a 64-bit machine, but to get the
702  * compiler to optimize it out if possible.  This is because Configure makes
703  * sure that the machine has an 8-bit byte, so if c is stored in a byte, the
704  * sizeof() guarantees that this evaluates to a constant true at compile time.
705  */
706 #define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || !(((WIDEST_UTYPE)(c)) & ~0xFF))
707
708 #ifdef EBCDIC
709 #   define isASCII(c)    (FITS_IN_8_BITS(c) && (NATIVE_TO_UNI((U8) (c)) < 128))
710 #else
711 #   define isASCII(c)    ((WIDEST_UTYPE)(c) < 128)
712 #endif
713
714 #define isASCII_A(c)  isASCII(c)
715 #define isASCII_L1(c)  isASCII(c)
716
717 /* The lower 3 bits in both the ASCII and EBCDIC representations of '0' are 0,
718  * and the 8 possible permutations of those bits exactly comprise the 8 octal
719  * digits */
720 #define isOCTAL_A(c)  cBOOL(FITS_IN_8_BITS(c) && (0xF8 & (c)) == '0')
721
722 /* ASCII range only */
723 #ifdef H_PERL       /* If have access to perl.h, lookup in its table */
724
725 /* Character class numbers.  For internal core Perl use only.  These are used
726  * in PL_charclass[] and the ones up through the one that corresponds to
727  * <_HIGHEST_REGCOMP_DOT_H_SYNC> are used by regcomp.h.  These use names used
728  * in l1_char_class_tab.h but their actual definitions are here.  If that file
729  * has a name not used here, it won't compile.
730  *
731  * The first group of these is ordered in what I (khw) estimate to be the
732  * frequency of their use.  This gives a slight edge to exiting a loop earlier
733  * (in reginclass() in regexec.c) */
734 #  define _CC_WORDCHAR           0      /* \w and [:word:] */
735 #  define _CC_DIGIT              1      /* \d and [:digit:] */
736 #  define _CC_ALPHA              2      /* [:alpha:] */
737 #  define _CC_LOWER              3      /* [:lower:] */
738 #  define _CC_UPPER              4      /* [:upper:] */
739 #  define _CC_PUNCT              5      /* [:punct:] */
740 #  define _CC_PRINT              6      /* [:print:] */
741 #  define _CC_ALPHANUMERIC       7      /* [:alnum:] */
742 #  define _CC_GRAPH              8      /* [:graph:] */
743
744 #define _FIRST_NON_SWASH_CC      9
745 /* The character classes above are implemented with swashes.  The second group
746  * (just below) contains the ones implemented without.  These are also sorted
747  * in rough order of the frequency of their use, except that \v should be last,
748  * as it isn't a real Posix character class, and some (small) inefficiencies in
749  * regular expression handling would be introduced by putting it in the middle
750  * of those that are.  Also, cntrl and ascii come after the others as it may be
751  * useful to group these which have no members that match above Latin1, (or
752  * above ASCII in the latter case) */
753
754 #  define _CC_SPACE              9      /* \s */
755 #  define _CC_BLANK             10      /* [:blank:] */
756 #  define _CC_XDIGIT            11      /* [:xdigit:] */
757 #  define _CC_PSXSPC            12      /* [:space:] */
758 #  define _CC_CNTRL             13      /* [:cntrl:] */
759 #  define _CC_ASCII             14      /* [:ascii:] */
760 #  define _CC_VERTSPACE         15      /* \v */
761
762 #  define _HIGHEST_REGCOMP_DOT_H_SYNC _CC_VERTSPACE
763
764 /* The members of the third group below do not need to be coordinated with data
765  * structures in regcomp.[ch] and regexec.c */
766 #  define _CC_IDFIRST           16
767 #  define _CC_CHARNAME_CONT     17
768 #  define _CC_NONLATIN1_FOLD    18
769 #  define _CC_QUOTEMETA         19
770 #  define _CC_NON_FINAL_FOLD    20
771 #  define _CC_IS_IN_SOME_FOLD   21
772 /* Unused: 22-31
773  * If more bits are needed, one could add a second word for non-64bit
774  * QUAD_IS_INT systems, using some #ifdefs to distinguish between having a 2nd
775  * word or not.  The IS_IN_SOME_FOLD bit is the most easily expendable, as it
776  * is used only for optimization (as of this writing), and differs in the
777  * Latin1 range from the ALPHA bit only in two relatively unimportant
778  * characters: the masculine and feminine ordinal indicators */
779
780 #if defined(PERL_CORE) || defined(PERL_EXT)
781 /* An enum version of the character class numbers, to help compilers
782  * optimize */
783 typedef enum {
784     _CC_ENUM_ALPHANUMERIC   = _CC_ALPHANUMERIC,
785     _CC_ENUM_ALPHA          = _CC_ALPHA,
786     _CC_ENUM_DIGIT          = _CC_DIGIT,
787     _CC_ENUM_GRAPH          = _CC_GRAPH,
788     _CC_ENUM_LOWER          = _CC_LOWER,
789     _CC_ENUM_PRINT          = _CC_PRINT,
790     _CC_ENUM_PUNCT          = _CC_PUNCT,
791     _CC_ENUM_UPPER          = _CC_UPPER,
792     _CC_ENUM_WORDCHAR       = _CC_WORDCHAR,
793     _CC_ENUM_SPACE          = _CC_SPACE,
794     _CC_ENUM_BLANK          = _CC_BLANK,
795     _CC_ENUM_XDIGIT         = _CC_XDIGIT,
796     _CC_ENUM_CNTRL          = _CC_CNTRL,
797     _CC_ENUM_PSXSPC         = _CC_PSXSPC,
798     _CC_ENUM_ASCII          = _CC_ASCII,
799     _CC_ENUM_VERTSPACE      = _CC_VERTSPACE
800 } _char_class_number;
801 #endif
802
803 #define POSIX_SWASH_COUNT _FIRST_NON_SWASH_CC
804 #define POSIX_CC_COUNT    (_HIGHEST_REGCOMP_DOT_H_SYNC + 1)
805
806 #if defined(PERL_IN_UTF8_C) || defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
807 #   if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
808        || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6 \
809        || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8
810       #error Need to adjust order of swash_property_names[]
811 #   endif
812
813 /* This is declared static in each of the few files that this is #defined for
814  * to keep them from being publicly accessible.  Hence there is a small amount
815  * of wasted space */
816
817 static const char* const swash_property_names[] = {
818     "XPosixWord",
819     "XPosixDigit",
820     "XPosixAlpha",
821     "XPosixLower",
822     "XPosixUpper",
823     "XPosixPunct",
824     "XPosixPrint",
825     "XPosixAlnum",
826     "XPosixGraph"
827 };
828 #endif
829
830 #define PL_utf8_alnum   PL_utf8_swash_ptrs[_CC_WORDCHAR]
831 #define PL_utf8_alnumc  PL_utf8_swash_ptrs[_CC_ALPHANUMERIC]
832 #define PL_utf8_alpha   PL_utf8_swash_ptrs[_CC_ALPHA]
833 #define PL_utf8_graph   PL_utf8_swash_ptrs[_CC_GRAPH]
834 #define PL_utf8_digit   PL_utf8_swash_ptrs[_CC_DIGIT]
835 #define PL_utf8_upper   PL_utf8_swash_ptrs[_CC_UPPER]
836 #define PL_utf8_lower   PL_utf8_swash_ptrs[_CC_LOWER]
837 #define PL_utf8_print   PL_utf8_swash_ptrs[_CC_PRINT]
838 #define PL_utf8_punct   PL_utf8_swash_ptrs[_CC_PUNCT]
839
840 #  ifdef DOINIT
841 EXTCONST  U32 PL_charclass[] = {
842 #    include "l1_char_class_tab.h"
843 };
844
845 #  else /* ! DOINIT */
846 EXTCONST U32 PL_charclass[];
847 #  endif
848
849     /* The 1U keeps Solaris from griping when shifting sets the uppermost bit */
850 #   define _CC_mask(classnum) (1U << (classnum))
851 #   define _generic_isCC(c, classnum) cBOOL(FITS_IN_8_BITS(c) \
852                 && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask(classnum)))
853
854     /* The mask for the _A versions of the macros; it just adds in the bit for
855      * ASCII. */
856 #   define _CC_mask_A(classnum) (_CC_mask(classnum) | _CC_mask(_CC_ASCII))
857
858     /* The _A version makes sure that both the desired bit and the ASCII bit
859      * are present */
860 #   define _generic_isCC_A(c, classnum) (FITS_IN_8_BITS(c) \
861         && ((PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask_A(classnum)) \
862                                 == _CC_mask_A(classnum)))
863
864 #   define isALPHA_A(c)  _generic_isCC_A(c, _CC_ALPHA)
865 #   define isALPHANUMERIC_A(c) _generic_isCC_A(c, _CC_ALPHANUMERIC)
866 #   define isBLANK_A(c)  _generic_isCC_A(c, _CC_BLANK)
867 #   define isCNTRL_A(c)  _generic_isCC_A(c, _CC_CNTRL)
868 #   define isDIGIT_A(c)  _generic_isCC(c, _CC_DIGIT)
869 #   define isGRAPH_A(c)  _generic_isCC_A(c, _CC_GRAPH)
870 #   define isLOWER_A(c)  _generic_isCC_A(c, _CC_LOWER)
871 #   define isPRINT_A(c)  _generic_isCC_A(c, _CC_PRINT)
872 #   define isPSXSPC_A(c) _generic_isCC_A(c, _CC_PSXSPC)
873 #   define isPUNCT_A(c)  _generic_isCC_A(c, _CC_PUNCT)
874 #   define isSPACE_A(c)  _generic_isCC_A(c, _CC_SPACE)
875 #   define isUPPER_A(c)  _generic_isCC_A(c, _CC_UPPER)
876 #   define isWORDCHAR_A(c) _generic_isCC_A(c, _CC_WORDCHAR)
877 #   define isXDIGIT_A(c)  _generic_isCC(c, _CC_XDIGIT)
878 #   define isIDFIRST_A(c) _generic_isCC_A(c, ( _CC_IDFIRST))
879
880     /* Either participates in a fold with a character above 255, or is a
881      * multi-char fold */
882 #   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)))
883
884 #   define _isQUOTEMETA(c) _generic_isCC(c, _CC_QUOTEMETA)
885 #   define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
886                                             _generic_isCC(c, _CC_NON_FINAL_FOLD)
887 #   define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
888                                             _generic_isCC(c, _CC_IS_IN_SOME_FOLD)
889 #else   /* No perl.h. */
890 #   ifdef EBCDIC
891 #       define isALPHA_A(c)    (isASCII(c) && isALPHA(c))
892 #       define isALPHANUMERIC_A(c) (isASCII(c) && isALPHANUMERIC(c))
893 #       define isBLANK_A(c)    (isASCII(c) && isBLANK(c))
894 #       define isCNTRL_A(c)    (isASCII(c) && isCNTRL(c))
895 #       define isDIGIT_A(c)    (isASCII(c) && isDIGIT(c))
896 #       define isGRAPH_A(c)    (isASCII(c) && isGRAPH(c))
897 #       define isIDFIRST_A(c)  (isASCII(c) && isIDFIRST(c))
898 #       define isLOWER_A(c)    (isASCII(c) && isLOWER(c))
899 #       define isPRINT_A(c)    (isASCII(c) && isPRINT(c))
900 #       define isPSXSPC_A(c)   (isASCII(c) && isPSXSPC(c))
901 #       define isPUNCT_A(c)    (isASCII(c) && isPUNCT(c))
902 #       define isSPACE_A(c)    (isASCII(c) && isSPACE(c))
903 #       define isUPPER_A(c)    (isASCII(c) && isUPPER(c))
904 #       define isWORDCHAR_A(c) (isASCII(c) && isWORDCHAR(c))
905 #       define isXDIGIT_A(c)   (isASCII(c) && isXDIGIT(c))
906 #   else   /* ASCII platform, no perl.h */
907 #       define isALPHA_A(c)  (isUPPER_A(c) || isLOWER_A(c))
908 #       define isALPHANUMERIC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
909 #       define isBLANK_A(c)  ((c) == ' ' || (c) == '\t')
910 #       define isCNTRL_A(c) (FITS_IN_8_BITS(c) && ((U8) (c) < ' ' || (c) == 127))
911 #       define isDIGIT_A(c)  ((c) <= '9' && (c) >= '0')
912 #       define isGRAPH_A(c)  (isWORDCHAR_A(c) || isPUNCT_A(c))
913 #       define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_')
914 #       define isLOWER_A(c)  ((c) >= 'a' && (c) <= 'z')
915 #       define isPRINT_A(c)  (((c) >= 32 && (c) < 127))
916 #       define isPSXSPC_A(c) (isSPACE_A(c) || (c) == '\v')
917 #       define isPUNCT_A(c)  (((c) >= 33 && (c) <= 47)              \
918                               || ((c) >= 58 && (c) <= 64)           \
919                               || ((c) >= 91 && (c) <= 96)           \
920                               || ((c) >= 123 && (c) <= 126))
921 #       define isSPACE_A(c)  ((c) == ' '                            \
922                               || (c) == '\t'                        \
923                               || (c) == '\n'                        \
924                               || (c) =='\r'                         \
925                               || (c) == '\f')
926 #       define isUPPER_A(c)  ((c) <= 'Z' && (c) >= 'A')
927 #       define isWORDCHAR_A(c) (isALPHA_A(c) || isDIGIT_A(c) || (c) == '_')
928 #       define isXDIGIT_A(c)   (isDIGIT_A(c)                        \
929                                 || ((c) >= 'a' && (c) <= 'f')       \
930                                 || ((c) <= 'F' && (c) >= 'A'))
931 #   endif
932 #endif  /* ASCII range definitions */
933
934 /* Latin1 definitions */
935 #ifdef H_PERL
936 #   define isALPHA_L1(c)  _generic_isCC(c, _CC_ALPHA)
937 #   define isALPHANUMERIC_L1(c) _generic_isCC(c, _CC_ALPHANUMERIC)
938 #   define isBLANK_L1(c)  _generic_isCC(c, _CC_BLANK)
939
940 /*  continuation character for legal NAME in \N{NAME} */
941 #   define isCHARNAME_CONT(c) _generic_isCC(c, _CC_CHARNAME_CONT)
942
943 #   define isCNTRL_L1(c)  _generic_isCC(c, _CC_CNTRL)
944 #   define isGRAPH_L1(c)  _generic_isCC(c, _CC_GRAPH)
945 #   define isLOWER_L1(c)  _generic_isCC(c, _CC_LOWER)
946 #   define isPRINT_L1(c)  _generic_isCC(c, _CC_PRINT)
947 #   define isPSXSPC_L1(c) _generic_isCC(c, _CC_PSXSPC)
948 #   define isPUNCT_L1(c)  _generic_isCC(c, _CC_PUNCT)
949 #   define isSPACE_L1(c)  _generic_isCC(c, _CC_SPACE)
950 #   define isUPPER_L1(c)  _generic_isCC(c, _CC_UPPER)
951 #   define isWORDCHAR_L1(c) _generic_isCC(c, _CC_WORDCHAR)
952 #   define isIDFIRST_L1(c) _generic_isCC(c, _CC_IDFIRST)
953 #else /* No access to perl.h.  Only a few provided here, just in case needed
954        * for backwards compatibility */
955     /* ALPHAU includes Unicode semantics for latin1 characters.  It has an extra
956      * >= AA test to speed up ASCII-only tests at the expense of the others */
957 #   define isALPHA_L1(c) (isALPHA(c) || (NATIVE_TO_UNI((U8) c) >= 0xAA \
958         && ((NATIVE_TO_UNI((U8) c) >= 0xC0 \
959              && NATIVE_TO_UNI((U8) c) != 0xD7 && NATIVE_TO_UNI((U8) c) != 0xF7) \
960             || NATIVE_TO_UNI((U8) c) == 0xAA \
961             || NATIVE_TO_UNI((U8) c) == 0xB5 \
962             || NATIVE_TO_UNI((U8) c) == 0xBA)))
963 #   define isCHARNAME_CONT(c) (isWORDCHAR_L1(c)                         \
964                                || (c) == ' '                            \
965                                || (c) == '-'                            \
966                                || (c) == '('                            \
967                                || (c) == ')'                            \
968                                || (c) == ':'                            \
969                                || NATIVE_TO_UNI((U8) c) == 0xA0)
970 #endif
971
972 /* Macros that differ between EBCDIC and ASCII.  Where C89 defines a function,
973  * that is used in the EBCDIC form, because in EBCDIC we do not do locales:
974  * therefore can use native functions.  For those where C89 doesn't define a
975  * function, use our function, assuming that the EBCDIC code page is isomorphic
976  * with Latin1, which the three currently recognized by Perl are.  Some libc's
977  * have an isblank(), but it's not guaranteed. */
978 #ifdef EBCDIC
979 #   define isALPHA(c)   isalpha(c)
980 #   define isALPHANUMERIC(c)    isalnum(c)
981 #   define isBLANK(c)   ((c) == ' ' || (c) == '\t' || NATIVE_TO_UNI(c) == 0xA0)
982 #   define isCNTRL(c)   iscntrl(c)
983 #   define isDIGIT(c)   isdigit(c)
984 #   define isGRAPH(c)   isgraph(c)
985 #   define isIDFIRST(c) (isALPHA(c) || (c) == '_')
986 #   define isLOWER(c)   islower(c)
987 #   define isPRINT(c)   isprint(c)
988 #   define isPSXSPC(c)  isspace(c)
989 #   define isPUNCT(c)   ispunct(c)
990 #   define isSPACE(c)   (isPSXSPC(c) /* && (c) != '\v' (Experimentally making
991                                         these macros identical) */)
992 #   define isUPPER(c)   isupper(c)
993 #   define isXDIGIT(c)  isxdigit(c)
994 #   define isWORDCHAR(c) (isalnum(c) || (c) == '_')
995 #   define toLOWER(c)   tolower(c)
996 #   define toUPPER(c)   toupper(c)
997 #else /* Not EBCDIC: ASCII-only matching */
998 #   define isALPHANUMERIC(c)  isALPHANUMERIC_A(c)
999 #   define isALPHA(c)   isALPHA_A(c)
1000 #   define isBLANK(c)   isBLANK_A(c)
1001 #   define isCNTRL(c)   isCNTRL_A(c)
1002 #   define isDIGIT(c)   isDIGIT_A(c)
1003 #   define isGRAPH(c)   isGRAPH_A(c)
1004 #   define isIDFIRST(c) isIDFIRST_A(c)
1005 #   define isLOWER(c)   isLOWER_A(c)
1006 #   define isPRINT(c)   isPRINT_A(c)
1007 #   define isPSXSPC(c)  isPSXSPC_A(c)
1008 #   define isPUNCT(c)   isPUNCT_A(c)
1009 #   define isSPACE(c)   isSPACE_A(c)
1010 #   define isUPPER(c)   isUPPER_A(c)
1011 #   define isWORDCHAR(c) isWORDCHAR_A(c)
1012 #   define isXDIGIT(c)  isXDIGIT_A(c)
1013
1014     /* ASCII casing.  These could also be written as
1015         #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
1016         #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
1017        which uses table lookup and mask instead of subtraction.  (This would
1018        work because the _MOD does not apply in the ASCII range) */
1019 #   define toLOWER(c)   (isUPPER(c) ? (c) + ('a' - 'A') : (c))
1020 #   define toUPPER(c)   (isLOWER(c) ? (c) - ('a' - 'A') : (c))
1021 #endif
1022
1023
1024 /* Use table lookup for speed; return error character for input
1025  * out-of-range */
1026 #define toLOWER_LATIN1(c)    (FITS_IN_8_BITS(c)                            \
1027                              ? UNI_TO_NATIVE(PL_latin1_lc[                 \
1028                                                NATIVE_TO_UNI( (U8) (c)) ]) \
1029                              : UNICODE_REPLACEMENT)
1030 /* Modified uc.  Is correct uc except for three non-ascii chars which are
1031  * all mapped to one of them, and these need special handling; error
1032  * character for input out-of-range */
1033 #define toUPPER_LATIN1_MOD(c) (FITS_IN_8_BITS(c)                           \
1034                               ? UNI_TO_NATIVE(PL_mod_latin1_uc[            \
1035                                                NATIVE_TO_UNI( (U8) (c)) ]) \
1036                               : UNICODE_REPLACEMENT)
1037
1038 #ifdef USE_NEXT_CTYPE
1039
1040 #  define isALPHANUMERIC_LC(c)  NXIsAlNum((unsigned int)(c))
1041 #  define isALPHA_LC(c)         NXIsAlpha((unsigned int)(c))
1042 #  define isASCII_LC(c)         isASCII((unsigned int)(c))
1043 #  define isBLANK_LC(c)         isBLANK((unsigned int)(c))
1044 #  define isCNTRL_LC(c)         NXIsCntrl((unsigned int)(c))
1045 #  define isDIGIT_LC(c)         NXIsDigit((unsigned int)(c))
1046 #  define isGRAPH_LC(c)         NXIsGraph((unsigned int)(c))
1047 #  define isIDFIRST_LC(c) (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
1048 #  define isLOWER_LC(c)         NXIsLower((unsigned int)(c))
1049 #  define isPRINT_LC(c)         NXIsPrint((unsigned int)(c))
1050 #  define isPUNCT_LC(c)         NXIsPunct((unsigned int)(c))
1051 #  define isSPACE_LC(c)         NXIsSpace((unsigned int)(c))
1052 #  define isUPPER_LC(c)         NXIsUpper((unsigned int)(c))
1053 #  define isWORDCHAR_LC(c) (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
1054 #  define isXDIGIT_LC(c)        NXIsXDigit((unsigned int)(c))
1055 #  define toLOWER_LC(c)         NXToLower((unsigned int)(c))
1056 #  define toUPPER_LC(c)         NXToUpper((unsigned int)(c))
1057
1058 #else /* !USE_NEXT_CTYPE */
1059
1060 #  if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
1061
1062 /* Use foo_LC_uvchr() instead  of these for beyond the Latin1 range */
1063
1064 #    define isALPHA_LC(c)   (FITS_IN_8_BITS(c) && isalpha((unsigned char)(c)))
1065 #    define isALPHANUMERIC_LC(c)   (FITS_IN_8_BITS(c)                          \
1066                                                && isalnum((unsigned char)(c)))
1067 #    ifdef HAS_ISASCII
1068 #       define isASCII_LC(c) (FITS_IN_8_BITS(c) && isascii((unsigned char)(c)))
1069 #    else
1070 #       define isASCII_LC(c) (FITS_IN_8_BITS(c) && isASCII((unsigned char)(c)))
1071 #    endif
1072 #    ifdef HAS_ISBLANK
1073 #       define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isblank((unsigned char)(c)))
1074 #    else
1075 #       define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isBLANK((unsigned char)(c)))
1076 #    endif
1077 #    define isCNTRL_LC(c)    (FITS_IN_8_BITS(c) && iscntrl((unsigned char)(c)))
1078 #    define isDIGIT_LC(c)    (FITS_IN_8_BITS(c) && isdigit((unsigned char)(c)))
1079 #    define isGRAPH_LC(c)    (FITS_IN_8_BITS(c) && isgraph((unsigned char)(c)))
1080 #    define isIDFIRST_LC(c) (FITS_IN_8_BITS(c)                                 \
1081                             && (isalpha((unsigned char)(c)) || (char)(c) == '_'))
1082 #    define isLOWER_LC(c)    (FITS_IN_8_BITS(c) && islower((unsigned char)(c)))
1083 #    define isPRINT_LC(c)    (FITS_IN_8_BITS(c) && isprint((unsigned char)(c)))
1084 #    define isPUNCT_LC(c)    (FITS_IN_8_BITS(c) && ispunct((unsigned char)(c)))
1085 #    define isSPACE_LC(c)    (FITS_IN_8_BITS(c) && isspace((unsigned char)(c)))
1086 #    define isUPPER_LC(c)    (FITS_IN_8_BITS(c) && isupper((unsigned char)(c)))
1087 #    define isWORDCHAR_LC(c) (FITS_IN_8_BITS(c)                                \
1088                             && (isalnum((unsigned char)(c)) || (char)(c) == '_'))
1089 #    define isXDIGIT_LC(c)   (FITS_IN_8_BITS(c) && isxdigit((unsigned char)(c)))
1090 #    define toLOWER_LC(c) (FITS_IN_8_BITS(c) ? tolower((unsigned char)(c)) : (c))
1091 #    define toUPPER_LC(c) (FITS_IN_8_BITS(c) ? toupper((unsigned char)(c)) : (c))
1092
1093 #  else
1094
1095 #    define isALPHA_LC(c)       (isascii(c) && isalpha(c))
1096 #    define isALPHANUMERIC_LC(c) (isascii(c) && isalnum(c))
1097 #    define isASCII_LC(c)       isascii(c)
1098 #    ifdef HAS_ISBLANK
1099 #       define isBLANK_LC(c)    (isascii(c) && isblank(c))
1100 #    else
1101 #       define isBLANK_LC(c)    isBLANK_A(c)
1102 #    endif
1103 #    define isCNTRL_LC(c)       (isascii(c) && iscntrl(c))
1104 #    define isDIGIT_LC(c)       (isascii(c) && isdigit(c))
1105 #    define isGRAPH_LC(c)       (isascii(c) && isgraph(c))
1106 #    define isIDFIRST_LC(c)     (isascii(c) && (isalpha(c) || (c) == '_'))
1107 #    define isLOWER_LC(c)       (isascii(c) && islower(c))
1108 #    define isPRINT_LC(c)       (isascii(c) && isprint(c))
1109 #    define isPUNCT_LC(c)       (isascii(c) && ispunct(c))
1110 #    define isSPACE_LC(c)       (isascii(c) && isspace(c))
1111 #    define isUPPER_LC(c)       (isascii(c) && isupper(c))
1112 #    define isWORDCHAR_LC(c)    (isascii(c) && (isalnum(c) || (c) == '_'))
1113 #    define isXDIGIT_LC(c)      (isascii(c) && isxdigit(c))
1114 #    define toLOWER_LC(c)       (isascii(c) ? tolower(c) : (c))
1115 #    define toUPPER_LC(c)       (isascii(c) ? toupper(c) : (c))
1116
1117 #  endif
1118 #endif /* USE_NEXT_CTYPE */
1119
1120 #define isPSXSPC_LC(c)          isSPACE_LC(c)
1121
1122 /* For internal core Perl use only.  If the input is Latin1, use the Latin1
1123  * macro; otherwise use the function.  Won't compile if 'c' isn't unsigned, as
1124  * won't match function prototype. The macros do bounds checking, so have
1125  * duplicate checks here, so could create versions of the macros that don't,
1126  * but experiments show that gcc optimizes them out anyway. */
1127
1128 /* Note that all ignore 'use bytes' */
1129 #define _generic_uni(classnum, above_latin1, c) ((c) < 256                    \
1130                                              ? _generic_isCC(c, classnum)     \
1131                                              : above_latin1(c))
1132 #define _generic_swash_uni(classnum, c) ((c) < 256                            \
1133                                              ? _generic_isCC(c, classnum)     \
1134                                              : _is_uni_FOO(classnum, c))
1135 #define isALPHA_uni(c)      _generic_swash_uni(_CC_ALPHA, c)
1136 #define isALPHANUMERIC_uni(c) _generic_swash_uni(_CC_ALPHANUMERIC, c)
1137 #define isASCII_uni(c)      isASCII(c)
1138 #define isBLANK_uni(c)      _generic_uni(_CC_BLANK, is_HORIZWS_cp_high, c)
1139 #define isCNTRL_uni(c)      isCNTRL_L1(c) /* All controls are in Latin1 */
1140 #define isDIGIT_uni(c)      _generic_swash_uni(_CC_DIGIT, c)
1141 #define isGRAPH_uni(c)      _generic_swash_uni(_CC_GRAPH, c)
1142 #define isIDFIRST_uni(c)    _generic_uni(_CC_IDFIRST, _is_uni_perl_idstart, c)
1143 #define isLOWER_uni(c)      _generic_swash_uni(_CC_LOWER, c)
1144 #define isPRINT_uni(c)      _generic_swash_uni(_CC_PRINT, c)
1145
1146 /* Posix and regular space are identical above Latin1 */
1147 #define isPSXSPC_uni(c)     _generic_uni(_CC_PSXSPC, is_XPERLSPACE_cp_high, c)
1148
1149 #define isPUNCT_uni(c)      _generic_swash_uni(_CC_PUNCT, c)
1150 #define isSPACE_uni(c)      _generic_uni(_CC_SPACE, is_XPERLSPACE_cp_high, c)
1151 #define isUPPER_uni(c)      _generic_swash_uni(_CC_UPPER, c)
1152 #define isVERTWS_uni(c)     _generic_uni(_CC_VERTSPACE, is_VERTWS_cp_high, c)
1153 #define isWORDCHAR_uni(c)   _generic_swash_uni(_CC_WORDCHAR, c)
1154 #define isXDIGIT_uni(c)     _generic_uni(_CC_XDIGIT, is_XDIGIT_cp_high, c)
1155
1156 #define toFOLD_uni(c,s,l)       to_uni_fold(c,s,l)
1157 #define toLOWER_uni(c,s,l)      to_uni_lower(c,s,l)
1158 #define toTITLE_uni(c,s,l)      to_uni_title(c,s,l)
1159 #define toUPPER_uni(c,s,l)      to_uni_upper(c,s,l)
1160
1161 #define _generic_LC_uvchr(latin1, above_latin1, c)                            \
1162                                     (c < 256 ? latin1(c) : above_latin1(c))
1163 #define _generic_LC_swash_uvchr(latin1, classnum, c)                          \
1164                             (c < 256 ? latin1(c) : _is_uni_FOO(classnum, c))
1165
1166 #define isALPHA_LC_uvchr(c)  _generic_LC_swash_uvchr(isALPHA_LC, _CC_ALPHA, c)
1167 #define isALPHANUMERIC_LC_uvchr(c)  _generic_LC_swash_uvchr(isALPHANUMERIC_LC, \
1168                                                          _CC_ALPHANUMERIC, c)
1169 #define isASCII_LC_uvchr(c)  isASCII_LC(c)
1170 #define isBLANK_LC_uvchr(c)  _generic_LC_uvchr(isBLANK_LC, is_HORIZWS_cp_high, c)
1171 #define isCNTRL_LC_uvchr(c)  (c < 256 ? isCNTRL_LC(c) : 0)
1172 #define isDIGIT_LC_uvchr(c)  _generic_LC_swash_uvchr(isDIGIT_LC, _CC_DIGIT, c)
1173 #define isGRAPH_LC_uvchr(c)  _generic_LC_swash_uvchr(isGRAPH_LC, _CC_GRAPH, c)
1174 #define isIDFIRST_LC_uvchr(c)  _generic_LC_uvchr(isIDFIRST_LC,                 \
1175                                                   _is_uni_perl_idstart, c)
1176 #define isLOWER_LC_uvchr(c)  _generic_LC_swash_uvchr(isLOWER_LC, _CC_LOWER, c)
1177 #define isPRINT_LC_uvchr(c)  _generic_LC_swash_uvchr(isPRINT_LC, _CC_PRINT, c)
1178 #define isPSXSPC_LC_uvchr(c) isSPACE_LC_uvchr(c) /* space is identical to posix
1179                                                     space under locale */
1180 #define isPUNCT_LC_uvchr(c)  _generic_LC_swash_uvchr(isPUNCT_LC, _CC_PUNCT, c)
1181 #define isSPACE_LC_uvchr(c)  _generic_LC_uvchr(isSPACE_LC,                     \
1182                                                     is_XPERLSPACE_cp_high, c)
1183 #define isUPPER_LC_uvchr(c)  _generic_LC_swash_uvchr(isUPPER_LC, _CC_UPPER, c)
1184 #define isWORDCHAR_LC_uvchr(c)  _generic_LC_swash_uvchr(isWORDCHAR_LC,              \
1185                                                            _CC_WORDCHAR, c)
1186 #define isXDIGIT_LC_uvchr(c) _generic_LC_uvchr(isXDIGIT_LC, is_XDIGIT_cp_high, c)
1187
1188
1189 #define isBLANK_LC_uni(c)       isBLANK_LC_uvchr(UNI_TO_NATIVE(c))
1190
1191 /* For internal core Perl use only.  If the input is in the Latin1 range, use
1192  * the Latin1 macro 'classnum' on 'p' which is a pointer to a UTF-8 string.
1193  * Otherwise use the value given by the 'utf8' parameter.  This relies on the
1194  * fact that ASCII characters have the same representation whether utf8 or not.
1195  * Note that it assumes that the utf8 has been validated, and ignores 'use
1196  * bytes' */
1197 #define _generic_utf8(classnum, p, utf8) (UTF8_IS_INVARIANT(*(p))              \
1198                                          ? _generic_isCC(*(p), classnum)       \
1199                                          : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
1200                                            ? _generic_isCC(                    \
1201                                                    TWO_BYTE_UTF8_TO_UNI(*(p),  \
1202                                                                    *((p)+1 )), \
1203                                                    classnum)                   \
1204                                            : utf8)
1205 /* Like the above, but calls 'above_latin1(p)' to get the utf8 value.  'above_latin1'
1206  * can be a macro */
1207 #define _generic_func_utf8(classnum, above_latin1, p)  \
1208                                     _generic_utf8(classnum, p, above_latin1(p))
1209 /* Like the above, but passes classnum to _isFOO_utf8(), instead of having a
1210  * 'above_latin1' parameter */
1211 #define _generic_swash_utf8(classnum, p)  \
1212                       _generic_utf8(classnum, p, _is_utf8_FOO(classnum, p))
1213
1214 /* Like the above, but should be used only when it is known that there are no
1215  * characters in the range 128-255 which the class is TRUE for.  Hence it can
1216  * skip the tests for this range.  'above_latin1' should include its arguments */
1217 #define _generic_utf8_no_upper_latin1(classnum, p, above_latin1)                   \
1218                                          (UTF8_IS_INVARIANT(*(p))              \
1219                                          ? _generic_isCC(*(p), classnum)       \
1220                                          : (UTF8_IS_ABOVE_LATIN1(*(p)))        \
1221                                            ? above_latin1                          \
1222                                            : 0)
1223
1224 /* NOTE that some of these macros have very similar ones in regcharclass.h.
1225  * For example, there is (at the time of this writing) an 'is_SPACE_utf8()'
1226  * there, differing in name only by an underscore from the one here
1227  * 'isSPACE_utf8().  The difference is that the ones here are probably more
1228  * efficient and smaller, using an O(1) array lookup for Latin1-range code
1229  * points; the regcharclass.h ones are implemented as a series of
1230  * "if-else-if-else ..." */
1231
1232 #define isALPHA_utf8(p)         _generic_swash_utf8(_CC_ALPHA, p)
1233 #define isALPHANUMERIC_utf8(p)  _generic_swash_utf8(_CC_ALPHANUMERIC, p)
1234 #define isASCII_utf8(p)         isASCII(*p) /* Because ASCII is invariant under
1235                                                utf8, the non-utf8 macro works
1236                                              */
1237 #define isBLANK_utf8(p)         _generic_func_utf8(_CC_BLANK, is_HORIZWS_high, p)
1238 #define isCNTRL_utf8(p)         _generic_utf8(_CC_CNTRL, p, 0)
1239 #define isDIGIT_utf8(p)         _generic_utf8_no_upper_latin1(_CC_DIGIT, p,   \
1240                                                   _is_utf8_FOO(_CC_DIGIT, p))
1241 #define isGRAPH_utf8(p)         _generic_swash_utf8(_CC_GRAPH, p)
1242 #define isIDCONT_utf8(p)        _generic_func_utf8(_CC_WORDCHAR, is_utf8_xidcont, p)
1243
1244 /* To prevent S_scan_word in toke.c from hanging, we have to make sure that
1245  * IDFIRST is an alnum.  See
1246  * http://rt.perl.org/rt3/Ticket/Display.html?id=74022 for more detail than you
1247  * ever wanted to know about.  (In the ASCII range, there isn't a difference.)
1248  * This used to be not the XID version, but we decided to go with the more
1249  * modern Unicode definition */
1250 #define isIDFIRST_utf8(p)       _generic_func_utf8(_CC_IDFIRST,               \
1251                                                 _is_utf8_perl_idstart, p)
1252
1253 #define isLOWER_utf8(p)         _generic_swash_utf8(_CC_LOWER, p)
1254 #define isPRINT_utf8(p)         _generic_swash_utf8(_CC_PRINT, p)
1255
1256 /* Posix and regular space are identical above Latin1 */
1257 #define isPSXSPC_utf8(p)        _generic_func_utf8(_CC_PSXSPC, is_XPERLSPACE_high, p)
1258
1259 #define isPUNCT_utf8(p)         _generic_swash_utf8(_CC_PUNCT, p)
1260 #define isSPACE_utf8(p)         _generic_func_utf8(_CC_SPACE, is_XPERLSPACE_high, p)
1261 #define isUPPER_utf8(p)         _generic_swash_utf8(_CC_UPPER, p)
1262 #define isVERTWS_utf8(p)        _generic_func_utf8(_CC_VERTSPACE, is_VERTWS_high, p)
1263 #define isWORDCHAR_utf8(p)      _generic_swash_utf8(_CC_WORDCHAR, p)
1264 #define isXDIGIT_utf8(p)        _generic_utf8_no_upper_latin1(_CC_XDIGIT, p,   \
1265                                                           is_XDIGIT_high(p))
1266
1267 #define toLOWER_utf8(p,s,l)     to_utf8_lower(p,s,l)
1268 #define toTITLE_utf8(p,s,l)     to_utf8_title(p,s,l)
1269 #define toUPPER_utf8(p,s,l)     to_utf8_upper(p,s,l)
1270
1271 /* For internal core Perl use only.  If the input is in the Latin1 range, use
1272  * the macro 'macro' on 'p' which is a pointer to a UTF-8 string.  Otherwise
1273  * use the value given by the 'utf8' parameter.  This relies on the fact that
1274  * ASCII characters have the same representation whether utf8 or not.  Note
1275  * that it assumes that the utf8 has been validated, and ignores 'use bytes' */
1276 #define _generic_LC_utf8(macro, p, utf8)                                   \
1277                          (UTF8_IS_INVARIANT(*(p))                          \
1278                          ? macro(*(p))                                     \
1279                          : (UTF8_IS_DOWNGRADEABLE_START(*(p)))             \
1280                            ? macro(TWO_BYTE_UTF8_TO_UNI(*(p), *((p)+1)))   \
1281                            : utf8)
1282
1283 #define _generic_LC_swash_utf8(macro, classnum, p)                         \
1284                     _generic_LC_utf8(macro, p, _is_utf8_FOO(classnum, p))
1285 #define _generic_LC_func_utf8(macro, above_latin1, p)                         \
1286                     _generic_LC_utf8(macro, p, above_latin1(p))
1287
1288 #define isALPHANUMERIC_LC_utf8(p)  _generic_LC_swash_utf8(isALPHANUMERIC_LC,  \
1289                                                       _CC_ALPHANUMERIC, p)
1290 #define isALPHA_LC_utf8(p)   _generic_LC_swash_utf8(isALPHA_LC, _CC_ALPHA, p)
1291 #define isASCII_LC_utf8(p)   isASCII_LC(*p)
1292 #define isBLANK_LC_utf8(p)   _generic_LC_func_utf8(isBLANK_LC, is_HORIZWS_high, p)
1293 #define isCNTRL_LC_utf8(p)   _generic_LC_utf8(isCNTRL_LC, p, 0)
1294 #define isDIGIT_LC_utf8(p)   _generic_LC_swash_utf8(isDIGIT_LC, _CC_DIGIT, p)
1295 #define isGRAPH_LC_utf8(p)   _generic_LC_swash_utf8(isGRAPH_LC, _CC_GRAPH, p)
1296 #define isIDFIRST_LC_utf8(p) _generic_LC_func_utf8(isIDFIRST_LC, _is_utf8_perl_idstart, p)
1297 #define isLOWER_LC_utf8(p)   _generic_LC_swash_utf8(isLOWER_LC, _CC_LOWER, p)
1298 #define isPRINT_LC_utf8(p)   _generic_LC_swash_utf8(isPRINT_LC, _CC_PRINT, p)
1299 #define isPSXSPC_LC_utf8(p)  isSPACE_LC_utf8(p) /* space is identical to posix
1300                                                    space under locale */
1301 #define isPUNCT_LC_utf8(p)   _generic_LC_swash_utf8(isPUNCT_LC, _CC_PUNCT, p)
1302 #define isSPACE_LC_utf8(p)   _generic_LC_func_utf8(isSPACE_LC, is_XPERLSPACE_high, p)
1303 #define isUPPER_LC_utf8(p)   _generic_LC_swash_utf8(isUPPER_LC, _CC_UPPER, p)
1304 #define isWORDCHAR_LC_utf8(p) _generic_LC_swash_utf8(isWORDCHAR_LC,           \
1305                                                             _CC_WORDCHAR, p)
1306 #define isXDIGIT_LC_utf8(p)  _generic_LC_func_utf8(isXDIGIT_LC, is_XDIGIT_high, p)
1307
1308 /* Macros for backwards compatibility and for completeness when the ASCII and
1309  * Latin1 values are identical */
1310 #define isALPHAU(c)     isALPHA_L1(c)
1311 #define isDIGIT_L1(c)   isDIGIT_A(c)
1312 #define isOCTAL(c)      isOCTAL_A(c)
1313 #define isOCTAL_L1(c)   isOCTAL_A(c)
1314 #define isXDIGIT_L1(c)  isXDIGIT_A(c)
1315 #define isALNUM(c)      isWORDCHAR(c)
1316 #define isALNUMU(c)     isWORDCHAR_L1(c)
1317 #define isALNUM_LC(c)   isWORDCHAR_LC(c)
1318 #define isALNUM_uni(c)  isWORDCHAR_uni(c)
1319 #define isALNUM_LC_uvchr(c) isWORDCHAR_LC_uvchr(c)
1320 #define isALNUM_utf8(p) isWORDCHAR_utf8(p)
1321 #define isALNUM_LC_utf8(p) isWORDCHAR_LC_utf8(p)
1322 #define isALNUMC_A(c)   isALPHANUMERIC_A(c)      /* Mnemonic: "C's alnum" */
1323 #define isALNUMC_L1(c)  isALPHANUMERIC_L1(c)
1324 #define isALNUMC(c)     isALPHANUMERIC(c)
1325 #define isALNUMC_LC(c)  isALPHANUMERIC_LC(c)
1326 #define isALNUMC_uni(c) isALPHANUMERIC_uni(c)
1327 #define isALNUMC_LC_uvchr(c) isALPHANUMERIC_LC_uvchr(c)
1328 #define isALNUMC_utf8(p) isALPHANUMERIC_utf8(p)
1329 #define isALNUMC_LC_utf8(p) isALPHANUMERIC_LC_utf8(p)
1330
1331 /* This conversion works both ways, strangely enough. On EBCDIC platforms,
1332  * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII, except that they don't
1333  * necessarily mean the same characters, e.g. CTRL-D is 4 on both systems, but
1334  * that is EOT on ASCII;  ST on EBCDIC */
1335 #  define toCTRL(c)    (toUPPER(NATIVE_TO_UNI(c)) ^ 64)
1336
1337 /* Line numbers are unsigned, 32 bits. */
1338 typedef U32 line_t;
1339 #define NOLINE ((line_t) 4294967295UL)  /* = FFFFFFFF */
1340
1341 /* Helpful alias for version prescan */
1342 #define is_LAX_VERSION(a,b) \
1343         (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
1344
1345 #define is_STRICT_VERSION(a,b) \
1346         (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
1347
1348 #define BADVERSION(a,b,c) \
1349         if (b) { \
1350             *b = c; \
1351         } \
1352         return a;
1353
1354 #define READ_XDIGIT(s) (isALPHA(*(s)) ? ((*(s)++ + 9) & 0xf) : (*(s)++ & 0xf))
1355
1356 /*
1357 =head1 Memory Management
1358
1359 =for apidoc Am|void|Newx|void* ptr|int nitems|type
1360 The XSUB-writer's interface to the C C<malloc> function.
1361
1362 In 5.9.3, Newx() and friends replace the older New() API, and drops
1363 the first parameter, I<x>, a debug aid which allowed callers to identify
1364 themselves.  This aid has been superseded by a new build option,
1365 PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>).  The older API is still
1366 there for use in XS modules supporting older perls.
1367
1368 =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
1369 The XSUB-writer's interface to the C C<malloc> function, with
1370 cast.  See also C<Newx>.
1371
1372 =for apidoc Am|void|Newxz|void* ptr|int nitems|type
1373 The XSUB-writer's interface to the C C<malloc> function.  The allocated
1374 memory is zeroed with C<memzero>.  See also C<Newx>.
1375
1376 =for apidoc Am|void|Renew|void* ptr|int nitems|type
1377 The XSUB-writer's interface to the C C<realloc> function.
1378
1379 =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
1380 The XSUB-writer's interface to the C C<realloc> function, with
1381 cast.
1382
1383 =for apidoc Am|void|Safefree|void* ptr
1384 The XSUB-writer's interface to the C C<free> function.
1385
1386 =for apidoc Am|void|Move|void* src|void* dest|int nitems|type
1387 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
1388 source, C<dest> is the destination, C<nitems> is the number of items, and
1389 C<type> is the type.  Can do overlapping moves.  See also C<Copy>.
1390
1391 =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
1392 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1393 optimise.
1394
1395 =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
1396 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
1397 source, C<dest> is the destination, C<nitems> is the number of items, and
1398 C<type> is the type.  May fail on overlapping copies.  See also C<Move>.
1399
1400 =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
1401
1402 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1403 optimise.
1404
1405 =for apidoc Am|void|Zero|void* dest|int nitems|type
1406
1407 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
1408 destination, C<nitems> is the number of items, and C<type> is the type.
1409
1410 =for apidoc Am|void *|ZeroD|void* dest|int nitems|type
1411
1412 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1413 optimise.
1414
1415 =for apidoc Am|void|StructCopy|type *src|type *dest|type
1416 This is an architecture-independent macro to copy one structure to another.
1417
1418 =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
1419
1420 Fill up memory with a byte pattern (a byte repeated over and over
1421 again) that hopefully catches attempts to access uninitialized memory.
1422
1423 =for apidoc Am|void|PoisonNew|void* dest|int nitems|type
1424
1425 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
1426
1427 =for apidoc Am|void|PoisonFree|void* dest|int nitems|type
1428
1429 PoisonWith(0xEF) for catching access to freed memory.
1430
1431 =for apidoc Am|void|Poison|void* dest|int nitems|type
1432
1433 PoisonWith(0xEF) for catching access to freed memory.
1434
1435 =cut */
1436
1437 /* Maintained for backwards-compatibility only. Use newSV() instead. */
1438 #ifndef PERL_CORE
1439 #define NEWSV(x,len)    newSV(len)
1440 #endif
1441
1442 #define MEM_SIZE_MAX ((MEM_SIZE)~0)
1443
1444 /* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
1445  * overly eager compilers that will bleat about e.g.
1446  * (U16)n > (size_t)~0/sizeof(U16) always being false. */
1447 #ifdef PERL_MALLOC_WRAP
1448 #define MEM_WRAP_CHECK(n,t) \
1449         (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (croak_memory_wrap(),0))
1450 #define MEM_WRAP_CHECK_1(n,t,a) \
1451         (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
1452 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
1453
1454 #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)))
1455 #else
1456
1457 #define MEM_WRAP_CHECK(n,t)
1458 #define MEM_WRAP_CHECK_1(n,t,a)
1459 #define MEM_WRAP_CHECK_2(n,t,a,b)
1460 #define MEM_WRAP_CHECK_(n,t)
1461
1462 #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
1463
1464 #endif
1465
1466 #ifdef PERL_MEM_LOG
1467 /*
1468  * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
1469  * go through functions, which are handy for debugging breakpoints, but
1470  * which more importantly get the immediate calling environment (file and
1471  * line number, and C function name if available) passed in.  This info can
1472  * then be used for logging the calls, for which one gets a sample
1473  * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
1474  *
1475  * Known problems:
1476  * - not all memory allocs get logged, only those
1477  *   that go through Newx() and derivatives (while all
1478  *   Safefrees do get logged)
1479  * - __FILE__ and __LINE__ do not work everywhere
1480  * - __func__ or __FUNCTION__ even less so
1481  * - I think more goes on after the perlio frees but
1482  *   the thing is that STDERR gets closed (as do all
1483  *   the file descriptors)
1484  * - no deeper calling stack than the caller of the Newx()
1485  *   or the kind, but do I look like a C reflection/introspection
1486  *   utility to you?
1487  * - the function prototypes for the logging functions
1488  *   probably should maybe be somewhere else than handy.h
1489  * - one could consider inlining (macrofying) the logging
1490  *   for speed, but I am too lazy
1491  * - one could imagine recording the allocations in a hash,
1492  *   (keyed by the allocation address?), and maintain that
1493  *   through reallocs and frees, but how to do that without
1494  *   any News() happening...?
1495  * - lots of -Ddefines to get useful/controllable output
1496  * - lots of ENV reads
1497  */
1498
1499 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);
1500
1501 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);
1502
1503 PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
1504
1505 # ifdef PERL_CORE
1506 #  ifndef PERL_MEM_LOG_NOIMPL
1507 enum mem_log_type {
1508   MLT_ALLOC,
1509   MLT_REALLOC,
1510   MLT_FREE,
1511   MLT_NEW_SV,
1512   MLT_DEL_SV
1513 };
1514 #  endif
1515 #  if defined(PERL_IN_SV_C)  /* those are only used in sv.c */
1516 void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1517 void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1518 #  endif
1519 # endif
1520
1521 #endif
1522
1523 #ifdef PERL_MEM_LOG
1524 #define MEM_LOG_ALLOC(n,t,a)     Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
1525 #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
1526 #define MEM_LOG_FREE(a)          Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
1527 #endif
1528
1529 #ifndef MEM_LOG_ALLOC
1530 #define MEM_LOG_ALLOC(n,t,a)     (a)
1531 #endif
1532 #ifndef MEM_LOG_REALLOC
1533 #define MEM_LOG_REALLOC(n,t,v,a) (a)
1534 #endif
1535 #ifndef MEM_LOG_FREE
1536 #define MEM_LOG_FREE(a)          (a)
1537 #endif
1538
1539 #define Newx(v,n,t)     (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1540 #define Newxc(v,n,t,c)  (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1541 #define Newxz(v,n,t)    (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
1542
1543 #ifndef PERL_CORE
1544 /* pre 5.9.x compatibility */
1545 #define New(x,v,n,t)    Newx(v,n,t)
1546 #define Newc(x,v,n,t,c) Newxc(v,n,t,c)
1547 #define Newz(x,v,n,t)   Newxz(v,n,t)
1548 #endif
1549
1550 #define Renew(v,n,t) \
1551           (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1552 #define Renewc(v,n,t,c) \
1553           (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1554
1555 #ifdef PERL_POISON
1556 #define Safefree(d) \
1557   ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
1558 #else
1559 #define Safefree(d)     safefree(MEM_LOG_FREE((Malloc_t)(d)))
1560 #endif
1561
1562 #define Move(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1563 #define Copy(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1564 #define Zero(d,n,t)     (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
1565
1566 #define MoveD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1567 #define CopyD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1568 #ifdef HAS_MEMSET
1569 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
1570 #else
1571 /* Using bzero(), which returns void.  */
1572 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
1573 #endif
1574
1575 #define PoisonWith(d,n,t,b)     (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
1576 #define PoisonNew(d,n,t)        PoisonWith(d,n,t,0xAB)
1577 #define PoisonFree(d,n,t)       PoisonWith(d,n,t,0xEF)
1578 #define Poison(d,n,t)           PoisonFree(d,n,t)
1579
1580 #ifdef USE_STRUCT_COPY
1581 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
1582 #else
1583 #define StructCopy(s,d,t) Copy(s,d,1,t)
1584 #endif
1585
1586 #define C_ARRAY_LENGTH(a)       (sizeof(a)/sizeof((a)[0]))
1587 #define C_ARRAY_END(a)          (a) + (sizeof(a)/sizeof((a)[0]))
1588
1589 #ifdef NEED_VA_COPY
1590 # ifdef va_copy
1591 #  define Perl_va_copy(s, d) va_copy(d, s)
1592 # else
1593 #  if defined(__va_copy)
1594 #   define Perl_va_copy(s, d) __va_copy(d, s)
1595 #  else
1596 #   define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
1597 #  endif
1598 # endif
1599 #endif
1600
1601 /* convenience debug macros */
1602 #ifdef USE_ITHREADS
1603 #define pTHX_FORMAT  "Perl interpreter: 0x%p"
1604 #define pTHX__FORMAT ", Perl interpreter: 0x%p"
1605 #define pTHX_VALUE_   (void *)my_perl,
1606 #define pTHX_VALUE    (void *)my_perl
1607 #define pTHX__VALUE_ ,(void *)my_perl,
1608 #define pTHX__VALUE  ,(void *)my_perl
1609 #else
1610 #define pTHX_FORMAT
1611 #define pTHX__FORMAT
1612 #define pTHX_VALUE_
1613 #define pTHX_VALUE
1614 #define pTHX__VALUE_
1615 #define pTHX__VALUE
1616 #endif /* USE_ITHREADS */
1617
1618 /* Perl_deprecate was not part of the public API, and did not have a deprecate()
1619    shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
1620    CPAN::Unpack show any users outside the core.  */
1621 #ifdef PERL_CORE
1622 #  define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
1623 #endif
1624
1625 #endif  /* HANDY_H */
1626
1627 /*
1628  * Local variables:
1629  * c-indentation-style: bsd
1630  * c-basic-offset: 4
1631  * indent-tabs-mode: nil
1632  * End:
1633  *
1634  * ex: set ts=8 sts=4 sw=4 et:
1635  */