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