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 defined.)
30 =for apidoc AmU||Nullsv
31 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
36 # define Nullch Null(char*)
37 # define Nullfp Null(PerlIO*)
38 # define Nullsv Null(SV*)
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;
55 * AV *av1 = (AV*)sv; <== BAD: the const has been silently cast away
56 * AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
59 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
60 # define MUTABLE_PTR(p) ({ void *_p = (p); _p; })
62 # define MUTABLE_PTR(p) ((void *) (p))
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))
72 #if defined(I_STDBOOL) && !defined(PERL_BOOL_AS_CHAR)
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
87 #ifdef __GNUG__ /* GNU g++ has bool built-in */
88 # ifndef PERL_BOOL_AS_CHAR
95 /* The NeXT dynamic loader headers will not build with the bool macro
96 So declare them now to clear confusion.
98 #if defined(NeXT) || defined(__NeXT__)
101 typedef enum bool { FALSE = 0, TRUE = 1 } bool;
105 # endif /* !HAS_BOOL */
106 #endif /* NeXT || __NeXT__ */
116 /* cast-to-bool. A simple (bool) cast may not do the right thing: if bool is
117 * defined as char for example, then the cast from int is
118 * implementation-defined (bool)!!(cbool) in a ternary triggers a bug in xlc on
120 #define cBOOL(cbool) ((cbool) ? (bool)1 : (bool)0)
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__
129 # if (defined(USING_MSVC6)) || /* 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__ ""
133 # define FUNCTION__ __FUNCTION__ /* Common extension. */
137 /* XXX A note on the perl source internal type system. The
138 original intent was that I32 be *exactly* 32 bits.
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
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.
151 Similarly, there is no guarantee that I16 and U16 have exactly 16
154 For dealing with issues that may arise from various 32/64-bit
155 systems, we will ask Configure to check out
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).
167 #ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
168 # include <inttypes.h>
169 # ifdef INT32_MIN_BROKEN
171 # define INT32_MIN (-2147483647-1)
173 # ifdef INT64_MIN_BROKEN
175 # define INT64_MIN (-9223372036854775807LL-1)
190 #endif /* PERL_CORE */
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)
197 # if QUADKIND == QUAD_IS___INT64
198 # define PeRl_INT64_C(c) CAT2(c,I64)
199 # define PeRl_UINT64_C(c) CAT2(c,UI64)
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)
205 # define PeRl_INT64_C(c) ((I64TYPE)(c))
206 # define PeRl_UINT64_C(c) ((U64TYPE)(c))
211 # define UINT64_C(c) PeRl_UINT64_C(c)
214 # define INT64_C(c) PeRl_INT64_C(c)
218 #if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
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
225 #define I16_MAX INT16_MAX
226 #define I16_MIN INT16_MIN
227 #define U16_MAX UINT16_MAX
228 #define U16_MIN UINT16_MIN
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
235 # define U32_MAX 4294967295U
237 #define U32_MIN UINT32_MIN
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
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
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
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
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 */
270 #define Ctl(ch) ((ch) & 037)
273 =head1 SV-Body Allocation
275 =for apidoc Ama|SV*|newSVpvs|const char* s
276 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
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
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.
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
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
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.
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
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.
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
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
312 =head1 Memory Management
314 =for apidoc Ama|char*|savepvs|const char* s
315 Like C<savepvn>, but takes a literal string instead of a string/length pair.
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.
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.
326 =head1 Hash Manipulation Functions
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.
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.
335 =head1 Lexer interface
337 =for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags
339 Like L</lex_stuff_pvn>, but takes a literal string instead of a
345 /* concatenating with "" ensures that only literal strings are accepted as
347 #define STR_WITH_LEN(s) ("" s ""), (sizeof(s)-1)
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.
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))
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))
390 #define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
392 #define get_cvs(str, flags) \
393 Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
396 =head1 Miscellaneous Functions
398 =for apidoc Am|bool|strNE|char* s1|char* s2
399 Test two strings to see if they are different. Returns true or
402 =for apidoc Am|bool|strEQ|char* s1|char* s2
403 Test two strings to see if they are equal. Returns true or false.
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.
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.
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.
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.
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>).
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
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))
444 # define memNE(s1,s2,l) (memcmp(s1,s2,l))
445 # define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
447 # define memNE(s1,s2,l) (bcmp(s1,s2,l))
448 # define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
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)
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.
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".
468 #ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */
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.
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 (or on non-ASCII platforms, corresponds to) an
488 ASCII character in the named class based on platform, Unicode, and Perl rules.
489 If the input is a number that doesn't fit in an octet, FALSE is returned.
491 Variant C<isFOO_A> (e.g., C<isALPHA_A()>) is identical to the base function
492 with no suffix C<"_A">.
494 Variant C<isFOO_L1> imposes the Latin-1 (or EBCDIC equivlalent) character set
495 onto the platform. That is, the code points that are ASCII are unaffected,
496 since ASCII is a subset of Latin-1. But the non-ASCII code points are treated
497 as if they are Latin-1 characters. For example, C<isWORDCHAR_L1()> will return
498 true when called with the code point 0xDF, which is a word character in both
499 ASCII and EBCDIC (though it represent different characters in each).
501 Variant C<isFOO_uni> is like the C<isFOO_L1> variant, but accepts any UV code
502 point as input. If the code point is larger than 255, Unicode rules are used
503 to determine if it is in the character class. For example,
504 C<isWORDCHAR_uni(0x100)> returns TRUE, since 0x100 is LATIN CAPITAL LETTER A
505 WITH MACRON in Unicode, and is a word character.
507 Variant C<isFOO_utf8> is like C<isFOO_uni>, but the input is a pointer to a
508 (known to be well-formed) UTF-8 encoded string (C<U8*> or C<char*>). The
509 classification of just the first (possibly multi-byte) character in the string
512 Variant C<isFOO_LC> is like the C<isFOO_A> and C<isFOO_L1> variants, but uses
513 the C library function that gives the named classification instead of
514 hard-coded rules. For example, C<isDIGIT_LC()> returns the result of calling
515 C<isdigit()>. This means that the result is based on the current locale, which
516 is what C<LC> in the name stands for. FALSE is always returned if the input
517 won't fit into an octet.
519 Variant C<isFOO_LC_uvchr> is like C<isFOO_LC>, but is defined on any UV. It
520 returns the same as C<isFOO_LC> for input code points less than 256, and
521 returns the hard-coded, not-affected-by-locale, Unicode results for larger ones.
523 Variant C<isFOO_LC_utf8> is like C<isFOO_LC_uvchr>, but the input is a pointer to a
524 (known to be well-formed) UTF-8 encoded string (C<U8*> or C<char*>). The
525 classification of just the first (possibly multi-byte) character in the string
528 =for apidoc Am|bool|isALPHA|char ch
529 Returns a boolean indicating whether the specified character is an
530 alphabetic character, analogous to C<m/[[:alpha:]]/>.
531 See the L<top of this section|/Character classes> for an explanation of variants
532 C<isALPHA_A>, C<isALPHA_L1>, C<isALPHA_uni>, C<isALPHA_utf8>, C<isALPHA_LC>,
533 C<isALPHA_LC_uvchr>, and C<isALPHA_LC_utf8>.
535 =for apidoc Am|bool|isALPHANUMERIC|char ch
536 Returns a boolean indicating whether the specified character is a either an
537 alphabetic character or decimal digit, analogous to C<m/[[:alnum:]]/>.
538 See the L<top of this section|/Character classes> for an explanation of variants
539 C<isALPHANUMERIC_A>, C<isALPHANUMERIC_L1>, C<isALPHANUMERIC_uni>,
540 C<isALPHANUMERIC_utf8>, C<isALPHANUMERIC_LC>, C<isALPHANUMERIC_LC_uvchr>, and
541 C<isALPHANUMERIC_LC_utf8>.
543 =for apidoc Am|bool|isASCII|char ch
544 Returns a boolean indicating whether the specified character is one of the 128
545 characters in the ASCII character set, analogous to C<m/[[:ascii:]]/>.
546 On non-ASCII platforms, it returns TRUE iff this
547 character corresponds to an ASCII character. Variants C<isASCII_A()> and
548 C<isASCII_L1()> are identical to C<isASCII()>.
549 See the L<top of this section|/Character classes> for an explanation of variants
550 C<isASCII_uni>, C<isASCII_utf8>, C<isASCII_LC>, C<isASCII_LC_uvchr>, and
551 C<isASCII_LC_utf8>. Note, however, that some platforms do not have the C
552 library routine C<isascii()>. In these cases, the variants whose names contain
553 C<LC> are the same as the corresponding ones without.
555 Also note, that because all ASCII characters are UTF-8 invariant (meaning they
556 have the exact same representation (always a single byte) whether encoded in
557 UTF-8 or not), C<isASCII> will give the correct results when called with any
558 byte in any string encoded or not in UTF-8. And similarly C<isASCII_utf8> will
559 work properly on any string encoded or not in UTF-8.
561 =for apidoc Am|bool|isBLANK|char ch
562 Returns a boolean indicating whether the specified character is a
563 character considered to be a blank, 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
571 =for apidoc Am|bool|isCNTRL|char ch
572 Returns a boolean indicating whether the specified character is a
573 control character, analogous to C<m/[[:cntrl:]]/>.
574 See the L<top of this section|/Character classes> for an explanation of variants
575 C<isCNTRL_A>, C<isCNTRL_L1>, C<isCNTRL_uni>, C<isCNTRL_utf8>, C<isCNTRL_LC>,
576 C<isCNTRL_LC_uvchr>, and C<isCNTRL_LC_utf8>
577 On EBCDIC platforms, you almost always want to use the C<isCNTRL_L1> variant.
579 =for apidoc Am|bool|isDIGIT|char ch
580 Returns a boolean indicating whether the specified character is a
581 digit, 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
587 =for apidoc Am|bool|isGRAPH|char ch
588 Returns a boolean indicating whether the specified character is a
589 graphic character, analogous to C<m/[[:graph:]]/>.
590 See the L<top of this section|/Character classes> for an explanation of variants
591 C<isGRAPH_A>, C<isGRAPH_L1>, C<isGRAPH_uni>, C<isGRAPH_utf8>, C<isGRAPH_LC>,
592 C<isGRAPH_LC_uvchr>, and C<isGRAPH_LC_utf8>.
594 =for apidoc Am|bool|isLOWER|char ch
595 Returns a boolean indicating whether the specified character is a
596 lowercase character, analogous to C<m/[[:lower:]]/>.
597 See the L<top of this section|/Character classes> for an explanation of variants
598 C<isLOWER_A>, C<isLOWER_L1>, C<isLOWER_uni>, C<isLOWER_utf8>, C<isLOWER_LC>,
599 C<isLOWER_LC_uvchr>, and C<isLOWER_LC_utf8>.
601 =for apidoc Am|bool|isOCTAL|char ch
602 Returns a boolean indicating whether the specified character is an
604 The only two variants are C<isOCTAL_A> and C<isOCTAL_L1>; each is identical to
607 =for apidoc Am|bool|isPUNCT|char ch
608 Returns a boolean indicating whether the specified character is a
609 punctuation character, analogous to C<m/[[:punct:]]/>.
610 Note that the definition of what is punctuation isn't as
611 straightforward as one might desire. See L<perlrecharclass/POSIX Character
612 Classes> for details.
613 See the L<top of this section|/Character classes> for an explanation of variants
614 C<isPUNCT_A>, C<isPUNCT_L1>, C<isPUNCT_uni>, C<isPUNCT_utf8>, C<isPUNCT_LC>,
615 C<isPUNCT_LC_uvchr>, and C<isPUNCT_LC_utf8>.
617 =for apidoc Am|bool|isSPACE|char ch
618 Returns a boolean indicating whether the specified character is a
619 whitespace character. This is analogous
620 to what C<m/\s/> matches in a regular expression. Starting in Perl 5.18
621 (experimentally), this also matches what C<m/[[:space:]]/> does.
622 ("Experimentally" means that this change may be backed out in 5.20 or 5.22 if
623 field experience indicates that it was unwise.) Prior to 5.18, only the
624 locale forms of this macro (the ones with C<LC> in their names) matched
625 precisely what C<m/[[:space:]]/> does. In those releases, the only difference,
626 in the non-locale variants, was that C<isSPACE()> did not match a vertical tab.
627 (See L</isPSXSPC> for a macro that matches a vertical tab in all releases.)
628 See the L<top of this section|/Character classes> for an explanation of variants
629 C<isSPACE_A>, C<isSPACE_L1>, C<isSPACE_uni>, C<isSPACE_utf8>, C<isSPACE_LC>,
630 C<isSPACE_LC_uvchr>, and C<isSPACE_LC_utf8>.
632 =for apidoc Am|bool|isPSXSPC|char ch
633 (short for Posix Space)
634 Starting in 5.18, this is identical (experimentally) in all its forms to the
635 corresponding C<isSPACE()> macros. ("Experimentally" means that this change
636 may be backed out in 5.20 or 5.22 if field experience indicates that it
638 The locale forms of this macro are identical to their corresponding
639 C<isSPACE()> forms in all Perl releases. In releases prior to 5.18, the
640 non-locale forms differ from their C<isSPACE()> forms only in that the
641 C<isSPACE()> forms don't match a Vertical Tab, and the C<isPSXSPC()> forms do.
642 Otherwise they are identical. Thus this macro is analogous to what
643 C<m/[[:space:]]/> matches in a regular expression.
644 See the L<top of this section|/Character classes> for an explanation of variants
645 C<isPSXSPC_A>, C<isPSXSPC_L1>, C<isPSXSPC_uni>, C<isPSXSPC_utf8>, C<isPSXSPC_LC>,
646 C<isPSXSPC_LC_uvchr>, and C<isPSXSPC_LC_utf8>.
648 =for apidoc Am|bool|isUPPER|char ch
649 Returns a boolean indicating whether the specified character is an
650 uppercase character, analogous to C<m/[[:upper:]]/>.
651 See the L<top of this section|/Character classes> for an explanation of variants
652 C<isUPPER_A>, C<isUPPER_L1>, C<isUPPER_uni>, C<isUPPER_utf8>, C<isUPPER_LC>,
653 C<isUPPER_LC_uvchr>, and C<isUPPER_LC_utf8>.
655 =for apidoc Am|bool|isPRINT|char ch
656 Returns a boolean indicating whether the specified character is a
657 printable character, analogous to C<m/[[:print:]]/>.
658 See the L<top of this section|/Character classes> for an explanation of variants
659 C<isPRINT_A>, C<isPRINT_L1>, C<isPRINT_uni>, C<isPRINT_utf8>, C<isPRINT_LC>,
660 C<isPRINT_LC_uvchr>, and C<isPRINT_LC_utf8>.
662 =for apidoc Am|bool|isWORDCHAR|char ch
663 Returns a boolean indicating whether the specified character is a character
664 that is a word character, analogous to what C<m/\w/> and C<m/[[:word:]]/> match
665 in a regular expression. A word character is an alphabetic character, a
666 decimal digit, a connecting punctuation character (such as an underscore), or
667 a "mark" character that attaches to one of those (like some sort of accent).
668 C<isALNUM()> is a synonym provided for backward compatibility, even though a
669 word character includes more than the standard C language meaning of
671 See the L<top of this section|/Character classes> for an explanation of variants
672 C<isWORDCHAR_A>, C<isWORDCHAR_L1>, C<isWORDCHAR_uni>, C<isWORDCHAR_utf8>,
673 C<isWORDCHAR_LC>, C<isWORDCHAR_LC_uvchr>, and C<isWORDCHAR_LC_utf8>.
675 =for apidoc Am|bool|isXDIGIT|char ch
676 Returns a boolean indicating whether the specified character is a hexadecimal
677 digit. In the ASCII range these are C<[0-9A-Fa-f]>. Variants C<isXDIGIT_A()>
678 and C<isXDIGIT_L1()> are identical to C<isXDIGIT()>.
679 See the L<top of this section|/Character classes> for an explanation of variants
680 C<isXDIGIT_uni>, C<isXDIGIT_utf8>, C<isXDIGIT_LC>, C<isXDIGIT_LC_uvchr>, and
683 =for apidoc Am|bool|isIDFIRST|char ch
684 Returns a boolean indicating whether the specified character can be the first
685 character of an identifier. This is very close to, but not quite the same as
686 the official Unicode property C<XID_Start>. The difference is that this
687 returns true only if the input character also matches L</isWORDCHAR>.
688 See the L<top of this section|/Character classes> for an explanation of variants
689 C<isIDFIRST_A>, C<isIDFIRST_L1>, C<isIDFIRST_uni>, C<isIDFIRST_utf8>,
690 C<isIDFIRST_LC>, C<isIDFIRST_LC_uvchr>, and C<isIDFIRST_LC_utf8>.
692 =for apidoc Am|bool|isIDCONT|char ch
693 Returns a boolean indicating whether the specified character can be the
694 second or succeeding character of an identifier. This is very close to, but
695 not quite the same as the official Unicode property C<XID_Continue>. The
696 difference is that this returns true only if the input character also matches
697 L</isWORDCHAR>. See the L<top of this section|/Character classes> for an
698 explanation of variants C<isIDCONT_A>, C<isIDCONT_L1>, C<isIDCONT_uni>,
699 C<isIDCONT_utf8>, C<isIDCONT_LC>, C<isIDCONT_LC_uvchr>, and
702 =head1 Miscellaneous Functions
704 =for apidoc Am|U8|READ_XDIGIT|char str*
705 Returns the value of an ASCII-range hex digit and advances the string pointer.
706 Behaviour is only well defined when isXDIGIT(*str) is true.
708 =head1 Character case changing
710 =for apidoc Am|U8|toUPPER|U8 ch
711 Converts the specified character to uppercase. If the input is anything but an
712 ASCII lowercase character, that input character itself is returned. Variant
713 C<toUPPER_A> is equivalent.
715 =for apidoc Am|UV|toUPPER_uni|UV cp|U8* s|STRLEN* lenp
716 Converts the Unicode code point C<cp> to its uppercase version, and
717 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
718 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
719 bytes since the uppercase version may be longer than the original character.
721 The first code point of the uppercased version is returned
722 (but note, as explained just above, that there may be more.)
724 =for apidoc Am|UV|toUPPER_utf8|U8* p|U8* s|STRLEN* lenp
725 Converts the UTF-8 encoded character at C<p> to its uppercase version, and
726 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
727 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
728 bytes since the uppercase version may be longer than the original character.
730 The first code point of the uppercased version is returned
731 (but note, as explained just above, that there may be more.)
733 The input character at C<p> is assumed to be well-formed.
735 =for apidoc Am|U8|toFOLD|U8 ch
736 Converts the specified character to foldcase. If the input is anything but an
737 ASCII uppercase character, that input character itself is returned. Variant
738 C<toFOLD_A> is equivalent. (There is no equivalent C<to_FOLD_L1> for the full
739 Latin1 range, as the full generality of L</toFOLD_uni> is needed there.)
741 =for apidoc Am|UV|toFOLD_uni|UV cp|U8* s|STRLEN* lenp
742 Converts the Unicode code point C<cp> to its foldcase version, and
743 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
744 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
745 bytes since the foldcase version may be longer than the original character.
747 The first code point of the foldcased version is returned
748 (but note, as explained just above, that there may be more.)
750 =for apidoc Am|UV|toFOLD_utf8|U8* p|U8* s|STRLEN* lenp
751 Converts the UTF-8 encoded character at C<p> to its foldcase version, and
752 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
753 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
754 bytes since the foldcase version may be longer than the original character.
756 The first code point of the foldcased version is returned
757 (but note, as explained just above, that there may be more.)
759 The input character at C<p> is assumed to be well-formed.
761 =for apidoc Am|U8|toLOWER|U8 ch
762 Converts the specified character to lowercase. If the input is anything but an
763 ASCII uppercase character, that input character itself is returned. Variant
764 C<toLOWER_A> is equivalent.
766 =for apidoc Am|U8|toLOWER_L1|U8 ch
767 Converts the specified Latin1 character to lowercase. The results are undefined if
768 the input doesn't fit in a byte.
770 =for apidoc Am|U8|toLOWER_LC|U8 ch
771 Converts the specified character to lowercase using the current locale's rules,
772 if possible; otherwise returns the input character itself.
774 =for apidoc Am|UV|toLOWER_uni|UV cp|U8* s|STRLEN* lenp
775 Converts the Unicode code point C<cp> to its lowercase version, and
776 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
777 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
778 bytes since the lowercase version may be longer than the original character.
780 The first code point of the lowercased version is returned
781 (but note, as explained just above, that there may be more.)
783 =for apidoc Am|UV|toLOWER_utf8|U8* p|U8* s|STRLEN* lenp
784 Converts the UTF-8 encoded character at C<p> to its lowercase version, and
785 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
786 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
787 bytes since the lowercase version may be longer than the original character.
789 The first code point of the lowercased version is returned
790 (but note, as explained just above, that there may be more.)
792 The input character at C<p> is assumed to be well-formed.
794 =for apidoc Am|U8|toLOWER_LC|U8 ch
795 Converts the specified character to lowercase using the current locale's rules,
796 if possible; otherwise returns the input character itself.
798 =for apidoc Am|U8|toTITLE|U8 ch
799 Converts the specified character to titlecase. If the input is anything but an
800 ASCII lowercase character, that input character itself is returned. Variant
801 C<toTITLE_A> is equivalent. (There is no C<toTITLE_L1> for the full Latin1 range,
802 as the full generality of L</toTITLE_uni> is needed there. Titlecase is not a
803 concept used in locale handling, so there is no functionality for that.)
805 =for apidoc Am|UV|toTITLE_uni|UV cp|U8* s|STRLEN* lenp
806 Converts the Unicode code point C<cp> to its titlecase version, and
807 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
808 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
809 bytes since the titlecase version may be longer than the original character.
811 The first code point of the titlecased version is returned
812 (but note, as explained just above, that there may be more.)
814 =for apidoc Am|UV|toTITLE_utf8|U8* p|U8* s|STRLEN* lenp
815 Converts the UTF-8 encoded character at C<p> to its titlecase version, and
816 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
817 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
818 bytes since the titlecase version may be longer than the original character.
820 The first code point of the titlecased version is returned
821 (but note, as explained just above, that there may be more.)
823 The input character at C<p> is assumed to be well-formed.
827 XXX Still undocumented isVERTWS_uni and _utf8; it's unclear what their names
828 really should be. Also toUPPER_LC and toFOLD_LC, which are subject to change.
830 Note that these macros are repeated in Devel::PPPort, so should also be
831 patched there. The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
835 /* Specify the widest unsigned type on the platform. Use U64TYPE because U64
836 * is known only in the perl core, and this macro can be called from outside
839 # define WIDEST_UTYPE U64TYPE
841 # define WIDEST_UTYPE U32
844 /* FITS_IN_8_BITS(c) returns true if c doesn't have a bit set other than in
845 * the lower 8. It is designed to be hopefully bomb-proof, making sure that no
846 * bits of information are lost even on a 64-bit machine, but to get the
847 * compiler to optimize it out if possible. This is because Configure makes
848 * sure that the machine has an 8-bit byte, so if c is stored in a byte, the
849 * sizeof() guarantees that this evaluates to a constant true at compile time.
851 #define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || !(((WIDEST_UTYPE)(c)) & ~0xFF))
855 /* This returns the wrong results on at least z/OS unless this is
857 # error _ALL_SOURCE should probably be defined
860 /* We could be called without perl.h, in which case NATIVE_TO_ASCII() is
861 * likely not defined, and so we use the native function */
862 # define isASCII(c) isascii(c)
864 # define isASCII(c) ((WIDEST_UTYPE)(c) < 128)
867 #define isASCII_A(c) isASCII(c)
868 #define isASCII_L1(c) isASCII(c)
870 /* The lower 3 bits in both the ASCII and EBCDIC representations of '0' are 0,
871 * and the 8 possible permutations of those bits exactly comprise the 8 octal
873 #define isOCTAL_A(c) cBOOL(FITS_IN_8_BITS(c) && (0xF8 & (c)) == '0')
875 /* ASCII range only */
876 #ifdef H_PERL /* If have access to perl.h, lookup in its table */
878 /* Character class numbers. For internal core Perl use only. The ones less
879 * than 32 are used in PL_charclass[] and the ones up through the one that
880 * corresponds to <_HIGHEST_REGCOMP_DOT_H_SYNC> are used by regcomp.h and
881 * related files. PL_charclass ones use names used in l1_char_class_tab.h but
882 * their actual definitions are here. If that file has a name not used here,
885 * The first group of these is ordered in what I (khw) estimate to be the
886 * frequency of their use. This gives a slight edge to exiting a loop earlier
887 * (in reginclass() in regexec.c) */
888 # define _CC_WORDCHAR 0 /* \w and [:word:] */
889 # define _CC_DIGIT 1 /* \d and [:digit:] */
890 # define _CC_ALPHA 2 /* [:alpha:] */
891 # define _CC_LOWER 3 /* [:lower:] */
892 # define _CC_UPPER 4 /* [:upper:] */
893 # define _CC_PUNCT 5 /* [:punct:] */
894 # define _CC_PRINT 6 /* [:print:] */
895 # define _CC_ALPHANUMERIC 7 /* [:alnum:] */
896 # define _CC_GRAPH 8 /* [:graph:] */
897 # define _CC_CASED 9 /* [:lower:] and [:upper:] under /i */
899 #define _FIRST_NON_SWASH_CC 10
900 /* The character classes above are implemented with swashes. The second group
901 * (just below) contains the ones implemented without. These are also sorted
902 * in rough order of the frequency of their use, except that \v should be last,
903 * as it isn't a real Posix character class, and some (small) inefficiencies in
904 * regular expression handling would be introduced by putting it in the middle
905 * of those that are. Also, cntrl and ascii come after the others as it may be
906 * useful to group these which have no members that match above Latin1, (or
907 * above ASCII in the latter case) */
909 # define _CC_SPACE 10 /* \s */
910 # define _CC_BLANK 11 /* [:blank:] */
911 # define _CC_XDIGIT 12 /* [:xdigit:] */
912 # define _CC_PSXSPC 13 /* [:space:] */
913 # define _CC_CNTRL 14 /* [:cntrl:] */
914 # define _CC_ASCII 15 /* [:ascii:] */
915 # define _CC_VERTSPACE 16 /* \v */
917 # define _HIGHEST_REGCOMP_DOT_H_SYNC _CC_VERTSPACE
919 /* The members of the third group below do not need to be coordinated with data
920 * structures in regcomp.[ch] and regexec.c. But they should be added to
921 * bootstrap_ctype() */
922 # define _CC_IDFIRST 17
923 # define _CC_CHARNAME_CONT 18
924 # define _CC_NONLATIN1_FOLD 19
925 # define _CC_QUOTEMETA 20
926 # define _CC_NON_FINAL_FOLD 21
927 # define _CC_IS_IN_SOME_FOLD 22
928 # define _CC_BACKSLASH_FOO_LBRACE_IS_META 31 /* temp, see mk_PL_charclass.pl */
930 * If more bits are needed, one could add a second word for non-64bit
931 * QUAD_IS_INT systems, using some #ifdefs to distinguish between having a 2nd
932 * word or not. The IS_IN_SOME_FOLD bit is the most easily expendable, as it
933 * is used only for optimization (as of this writing), and differs in the
934 * Latin1 range from the ALPHA bit only in two relatively unimportant
935 * characters: the masculine and feminine ordinal indicators, so removing it
936 * would just cause /i regexes which match them to run less efficiently */
938 #if defined(PERL_CORE) || defined(PERL_EXT)
939 /* An enum version of the character class numbers, to help compilers
942 _CC_ENUM_ALPHA = _CC_ALPHA,
943 _CC_ENUM_ALPHANUMERIC = _CC_ALPHANUMERIC,
944 _CC_ENUM_ASCII = _CC_ASCII,
945 _CC_ENUM_BLANK = _CC_BLANK,
946 _CC_ENUM_CASED = _CC_CASED,
947 _CC_ENUM_CNTRL = _CC_CNTRL,
948 _CC_ENUM_DIGIT = _CC_DIGIT,
949 _CC_ENUM_GRAPH = _CC_GRAPH,
950 _CC_ENUM_LOWER = _CC_LOWER,
951 _CC_ENUM_PRINT = _CC_PRINT,
952 _CC_ENUM_PSXSPC = _CC_PSXSPC,
953 _CC_ENUM_PUNCT = _CC_PUNCT,
954 _CC_ENUM_SPACE = _CC_SPACE,
955 _CC_ENUM_UPPER = _CC_UPPER,
956 _CC_ENUM_VERTSPACE = _CC_VERTSPACE,
957 _CC_ENUM_WORDCHAR = _CC_WORDCHAR,
958 _CC_ENUM_XDIGIT = _CC_XDIGIT
959 } _char_class_number;
962 #define POSIX_SWASH_COUNT _FIRST_NON_SWASH_CC
963 #define POSIX_CC_COUNT (_HIGHEST_REGCOMP_DOT_H_SYNC + 1)
965 #if defined(PERL_IN_UTF8_C) || defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C)
966 # if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
967 || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6 \
968 || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9
969 #error Need to adjust order of swash_property_names[]
972 /* This is declared static in each of the few files that this is #defined for
973 * to keep them from being publicly accessible. Hence there is a small amount
976 static const char* const swash_property_names[] = {
991 EXTCONST U32 PL_charclass[] = {
992 # include "l1_char_class_tab.h"
995 # else /* ! DOINIT */
996 EXTCONST U32 PL_charclass[];
998 #endif /* Has perl.h */
1000 #if defined(H_PERL) && ! defined(BOOTSTRAP_CHARSET)
1002 /* The 1U keeps Solaris from griping when shifting sets the uppermost bit */
1003 # define _CC_mask(classnum) (1U << (classnum))
1004 # define _generic_isCC(c, classnum) cBOOL(FITS_IN_8_BITS(c) \
1005 && (PL_charclass[(U8) (c)] & _CC_mask(classnum)))
1007 /* The mask for the _A versions of the macros; it just adds in the bit for
1009 # define _CC_mask_A(classnum) (_CC_mask(classnum) | _CC_mask(_CC_ASCII))
1011 /* The _A version makes sure that both the desired bit and the ASCII bit
1013 # define _generic_isCC_A(c, classnum) (FITS_IN_8_BITS(c) \
1014 && ((PL_charclass[(U8) (c)] & _CC_mask_A(classnum)) \
1015 == _CC_mask_A(classnum)))
1017 # define isALPHA_A(c) _generic_isCC_A(c, _CC_ALPHA)
1018 # define isALPHANUMERIC_A(c) _generic_isCC_A(c, _CC_ALPHANUMERIC)
1019 # define isBLANK_A(c) _generic_isCC_A(c, _CC_BLANK)
1020 # define isCNTRL_A(c) _generic_isCC_A(c, _CC_CNTRL)
1021 # define isDIGIT_A(c) _generic_isCC(c, _CC_DIGIT)
1022 # define isGRAPH_A(c) _generic_isCC_A(c, _CC_GRAPH)
1023 # define isLOWER_A(c) _generic_isCC_A(c, _CC_LOWER)
1024 # define isPRINT_A(c) _generic_isCC_A(c, _CC_PRINT)
1025 # define isPSXSPC_A(c) _generic_isCC_A(c, _CC_PSXSPC)
1026 # define isPUNCT_A(c) _generic_isCC_A(c, _CC_PUNCT)
1027 # define isSPACE_A(c) _generic_isCC_A(c, _CC_SPACE)
1028 # define isUPPER_A(c) _generic_isCC_A(c, _CC_UPPER)
1029 # define isWORDCHAR_A(c) _generic_isCC_A(c, _CC_WORDCHAR)
1030 # define isXDIGIT_A(c) _generic_isCC(c, _CC_XDIGIT)
1031 # define isIDFIRST_A(c) _generic_isCC_A(c, _CC_IDFIRST)
1032 # define isALPHA_L1(c) _generic_isCC(c, _CC_ALPHA)
1033 # define isALPHANUMERIC_L1(c) _generic_isCC(c, _CC_ALPHANUMERIC)
1034 # define isBLANK_L1(c) _generic_isCC(c, _CC_BLANK)
1036 /* continuation character for legal NAME in \N{NAME} */
1037 # define isCHARNAME_CONT(c) _generic_isCC(c, _CC_CHARNAME_CONT)
1039 # define isCNTRL_L1(c) _generic_isCC(c, _CC_CNTRL)
1040 # define isGRAPH_L1(c) _generic_isCC(c, _CC_GRAPH)
1041 # define isLOWER_L1(c) _generic_isCC(c, _CC_LOWER)
1042 # define isPRINT_L1(c) _generic_isCC(c, _CC_PRINT)
1043 # define isPSXSPC_L1(c) _generic_isCC(c, _CC_PSXSPC)
1044 # define isPUNCT_L1(c) _generic_isCC(c, _CC_PUNCT)
1045 # define isSPACE_L1(c) _generic_isCC(c, _CC_SPACE)
1046 # define isUPPER_L1(c) _generic_isCC(c, _CC_UPPER)
1047 # define isWORDCHAR_L1(c) _generic_isCC(c, _CC_WORDCHAR)
1048 # define isIDFIRST_L1(c) _generic_isCC(c, _CC_IDFIRST)
1050 /* Either participates in a fold with a character above 255, or is a
1051 * multi-char fold */
1052 # 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)))
1054 # define _isQUOTEMETA(c) _generic_isCC(c, _CC_QUOTEMETA)
1055 # define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
1056 _generic_isCC(c, _CC_NON_FINAL_FOLD)
1057 # define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
1058 _generic_isCC(c, _CC_IS_IN_SOME_FOLD)
1059 #else /* Either don't have perl.h or don't want to use char_class_tab.h */
1061 /* If we don't have perl.h, we are compiling a utility program. Below we
1062 * hard-code various macro definitions that wouldn't otherwise be available
1063 * to it. We can also get here if we are configured to bootstrap up Perl
1064 * on a non-ASCII platform that doesn't have a working Perl (currently only
1065 * EBCDIC). For these we currently use the native definitions to get
1066 * things going. (It should also be possible to use the translation
1067 * function NATIVE_TO_LATIN1(), but that is an extra layer of dependence on
1068 * Perl, so it is currently avoided for the macros where it's possible to
1071 /* Use the native functions. They likely will return false for all
1072 * non-ASCII values, but this makes sure */
1073 # define isALPHA_A(c) (isASCII(c) && isalpha(c))
1074 # define isALPHA_A(c) (isASCII(c) && isalpha(c))
1075 # define isALPHANUMERIC_A(c) (isASCII(c) && isalnum(c))
1076 # define isCNTRL_A(c) (isASCII(c) && iscntrl(c))
1077 # define isDIGIT_A(c) (isASCII(c) && isdigit(c))
1078 # define isGRAPH_A(c) (isASCII(c) && isgraph(c))
1079 # define isLOWER_A(c) (isASCII(c) && islower(c))
1080 # define isPRINT_A(c) (isASCII(c) && isprint(c))
1081 # define isPUNCT_A(c) (isASCII(c) && ispunct(c))
1082 # define isSPACE_A(c) (isASCII(c) && isspace(c))
1083 # define isUPPER_A(c) (isASCII(c) && isupper(c))
1084 # define isXDIGIT_A(c) (isASCII(c) && isxdigit(c))
1085 # else /* ASCII platform. These are coded based on first principals */
1086 # define isALPHA_A(c) (isUPPER_A(c) || isLOWER_A(c))
1087 # define isALPHANUMERIC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
1088 # define isCNTRL_A(c) (isASCII(c) && (! isPRINT_A(c)))
1089 # define isDIGIT_A(c) ((c) <= '9' && (c) >= '0')
1090 # define isGRAPH_A(c) (isPRINT_A(c) && (c) != ' ')
1091 # define isLOWER_A(c) ((c) >= 'a' && (c) <= 'z')
1092 # define isPRINT_A(c) (((c) >= 32 && (c) < 127))
1093 # define isPUNCT_A(c) (isGRAPH_A(c) && (! isALPHANUMERIC_A(c)))
1094 # define isSPACE_A(c) ((c) == ' ' \
1100 # define isUPPER_A(c) ((c) <= 'Z' && (c) >= 'A')
1101 # define isXDIGIT_A(c) (isDIGIT_A(c) \
1102 || ((c) >= 'a' && (c) <= 'f') \
1103 || ((c) <= 'F' && (c) >= 'A'))
1104 # endif /* Below are common definitions for ASCII and non-ASCII */
1105 # define isBLANK_A(c) ((c) == ' ' || (c) == '\t')
1106 # define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_')
1107 # define isWORDCHAR_A(c) (isALPHANUMERIC_A(c) || (c) == '_')
1109 /* The _L1 macros may be unnecessary for both the utilities and for
1110 * bootstrapping; I (khw) added them during debugging of bootstrapping, and
1111 * it seems best to keep them. */
1112 # define isPSXSPC_A(c) isSPACE_A(c) /* XXX Assumes SPACE matches '\v' */
1113 # define isALPHA_L1(c) (isUPPER_L1(c) || isLOWER_L1(c))
1114 # define isALPHANUMERIC_L1(c) (isALPHA_L1(c) || isDIGIT_A(c))
1115 # define isBLANK_L1(c) (isBLANK_A(c) \
1116 || (FITS_IN_8_BITS(c) \
1117 && NATIVE_TO_LATIN1((U8) c) == 0xA0))
1118 # define isCNTRL_L1(c) (FITS_IN_8_BITS(c) && (! isPRINT_L1(c)))
1119 # define isGRAPH_L1(c) (isPRINT_L1(c) && (! isBLANK_L1(c)))
1120 # define isLOWER_L1(c) (isLOWER_A(c) \
1121 || (FITS_IN_8_BITS(c) \
1122 && ((NATIVE_TO_LATIN1((U8) c) >= 0xDF \
1123 && NATIVE_TO_LATIN1((U8) c) != 0xF7) \
1124 || NATIVE_TO_LATIN1((U8) c) == 0xAA \
1125 || NATIVE_TO_LATIN1((U8) c) == 0xBA \
1126 || NATIVE_TO_LATIN1((U8) c) == 0xB5)))
1127 # define isPRINT_L1(c) (isPRINT_A(c) \
1128 || (FITS_IN_8_BITS(c) \
1129 && NATIVE_TO_LATIN1((U8) c) >= 0xA0))
1130 # define isPSXSPC_L1(c) isSPACE_L1(c)
1131 # define isPUNCT_L1(c) (isPUNCT_A(c) \
1132 || (FITS_IN_8_BITS(c) \
1133 && (NATIVE_TO_LATIN1((U8) c) == 0xA1 \
1134 || NATIVE_TO_LATIN1((U8) c) == 0xA7 \
1135 || NATIVE_TO_LATIN1((U8) c) == 0xAB \
1136 || NATIVE_TO_LATIN1((U8) c) == 0xB6 \
1137 || NATIVE_TO_LATIN1((U8) c) == 0xB7 \
1138 || NATIVE_TO_LATIN1((U8) c) == 0xBB \
1139 || NATIVE_TO_LATIN1((U8) c) == 0xBF)))
1140 # define isSPACE_L1(c) (isSPACE_A(c) \
1141 || (FITS_IN_8_BITS(c) \
1142 && (NATIVE_TO_LATIN1((U8) c) == 0x85 \
1143 || NATIVE_TO_LATIN1((U8) c) == 0xA0)))
1144 # define isUPPER_L1(c) (isUPPER_A(c) \
1145 || (FITS_IN_8_BITS(c) \
1146 && (NATIVE_TO_LATIN1((U8) c) >= 0xC0 \
1147 && NATIVE_TO_LATIN1((U8) c) <= 0xDE \
1148 && NATIVE_TO_LATIN1((U8) c) != 0xD7)))
1149 # define isWORDCHAR_L1(c) (isIDFIRST_L1(c) || isDIGIT_A(c))
1150 # define isIDFIRST_L1(c) (isALPHA_L1(c) || NATIVE_TO_LATIN1(c) == '_')
1151 # define isCHARNAME_CONT(c) (isWORDCHAR_L1(c) \
1156 /* The following are not fully accurate in the above-ASCII range. I (khw)
1157 * don't think it's necessary to be so for the purposes where this gets
1159 # define _isQUOTEMETA(c) (FITS_IN_8_BITS(c) && ! isWORDCHAR_L1(c))
1160 # define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) isALPHA_L1(c)
1162 /* And these aren't accurate at all. They are useful only for above
1163 * Latin1, which utilities and bootstrapping don't deal with */
1164 # define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) 0
1165 # define _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) 0
1167 /* Many of the macros later in this file are defined in terms of these. By
1168 * implementing them with a function, which converts the class number into
1169 * a call to the desired macro, all of the later ones work. However, that
1170 * function won't be actually defined when building a utility program (no
1171 * perl.h), and so a compiler error will be generated if one is attempted
1172 * to be used. And the above-Latin1 code points require Unicode tables to
1173 * be present, something unlikely to be the case when bootstrapping */
1174 # define _generic_isCC(c, classnum) \
1175 (FITS_IN_8_BITS(c) && S_bootstrap_ctype((U8) (c), (classnum), TRUE))
1176 # define _generic_isCC_A(c, classnum) \
1177 (FITS_IN_8_BITS(c) && S_bootstrap_ctype((U8) (c), (classnum), FALSE))
1178 #endif /* End of no perl.h or have BOOTSTRAP_CHARSET */
1180 #define isALPHANUMERIC(c) isALPHANUMERIC_A(c)
1181 #define isALPHA(c) isALPHA_A(c)
1182 #define isBLANK(c) isBLANK_A(c)
1183 #define isCNTRL(c) isCNTRL_A(c)
1184 #define isDIGIT(c) isDIGIT_A(c)
1185 #define isGRAPH(c) isGRAPH_A(c)
1186 #define isIDFIRST(c) isIDFIRST_A(c)
1187 #define isLOWER(c) isLOWER_A(c)
1188 #define isPRINT(c) isPRINT_A(c)
1189 #define isPSXSPC(c) isPSXSPC_A(c)
1190 #define isPUNCT(c) isPUNCT_A(c)
1191 #define isSPACE(c) isSPACE_A(c)
1192 #define isUPPER(c) isUPPER_A(c)
1193 #define isWORDCHAR(c) isWORDCHAR_A(c)
1194 #define isXDIGIT(c) isXDIGIT_A(c)
1196 /* ASCII casing. These could also be written as
1197 #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
1198 #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
1199 which uses table lookup and mask instead of subtraction. (This would
1200 work because the _MOD does not apply in the ASCII range) */
1201 #define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c))
1202 #define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c))
1204 /* In the ASCII range, these are equivalent to what they're here defined to be.
1205 * But by creating these definitions, other code doesn't have to be aware of
1207 #define toFOLD(c) toLOWER(c)
1208 #define toFOLD_LC(c) toLOWER_LC(c)
1209 #define toTITLE(c) toUPPER(c)
1211 #define toLOWER_A(c) toLOWER(c)
1212 #define toUPPER_A(c) toUPPER(c)
1213 #define toFOLD_A(c) toFOLD(c)
1214 #define toTITLE_A(c) toTITLE(c)
1216 /* Use table lookup for speed; return error character for input
1218 #define toLOWER_LATIN1(c) ((! FITS_IN_8_BITS(c)) \
1220 : PL_latin1_lc[ (U8) (c) ])
1221 #define toLOWER_L1(c) toLOWER_LATIN1(c) /* Synonym for consistency */
1223 /* Modified uc. Is correct uc except for three non-ascii chars which are
1224 * all mapped to one of them, and these need special handling; error
1225 * character for input out-of-range */
1226 #define toUPPER_LATIN1_MOD(c) ((! FITS_IN_8_BITS(c)) \
1228 : PL_mod_latin1_uc[ (U8) (c) ])
1229 #ifdef USE_NEXT_CTYPE
1231 # define isALPHANUMERIC_LC(c) NXIsAlNum((unsigned int)(c))
1232 # define isALPHA_LC(c) NXIsAlpha((unsigned int)(c))
1233 # define isASCII_LC(c) isASCII((unsigned int)(c))
1234 # define isBLANK_LC(c) isBLANK((unsigned int)(c))
1235 # define isCNTRL_LC(c) NXIsCntrl((unsigned int)(c))
1236 # define isDIGIT_LC(c) NXIsDigit((unsigned int)(c))
1237 # define isGRAPH_LC(c) NXIsGraph((unsigned int)(c))
1238 # define isIDFIRST_LC(c) (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
1239 # define isLOWER_LC(c) NXIsLower((unsigned int)(c))
1240 # define isPRINT_LC(c) NXIsPrint((unsigned int)(c))
1241 # define isPUNCT_LC(c) NXIsPunct((unsigned int)(c))
1242 # define isSPACE_LC(c) NXIsSpace((unsigned int)(c))
1243 # define isUPPER_LC(c) NXIsUpper((unsigned int)(c))
1244 # define isWORDCHAR_LC(c) (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
1245 # define isXDIGIT_LC(c) NXIsXDigit((unsigned int)(c))
1246 # define toLOWER_LC(c) NXToLower((unsigned int)(c))
1247 # define toUPPER_LC(c) NXToUpper((unsigned int)(c))
1249 #else /* !USE_NEXT_CTYPE */
1251 # if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
1253 /* Use foo_LC_uvchr() instead of these for beyond the Latin1 range */
1255 # define isALPHA_LC(c) (FITS_IN_8_BITS(c) && isalpha((unsigned char)(c)))
1256 # define isALPHANUMERIC_LC(c) (FITS_IN_8_BITS(c) \
1257 && isalnum((unsigned char)(c)))
1259 # define isASCII_LC(c) (FITS_IN_8_BITS(c) && isascii((unsigned char)(c)))
1261 # define isASCII_LC(c) (FITS_IN_8_BITS(c) && isASCII((unsigned char)(c)))
1264 # define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isblank((unsigned char)(c)))
1266 # define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isBLANK((unsigned char)(c)))
1268 # define isCNTRL_LC(c) (FITS_IN_8_BITS(c) && iscntrl((unsigned char)(c)))
1269 # define isDIGIT_LC(c) (FITS_IN_8_BITS(c) && isdigit((unsigned char)(c)))
1270 # define isGRAPH_LC(c) (FITS_IN_8_BITS(c) && isgraph((unsigned char)(c)))
1271 # define isIDFIRST_LC(c) (FITS_IN_8_BITS(c) \
1272 && (isalpha((unsigned char)(c)) || (char)(c) == '_'))
1273 # define isLOWER_LC(c) (FITS_IN_8_BITS(c) && islower((unsigned char)(c)))
1274 # define isPRINT_LC(c) (FITS_IN_8_BITS(c) && isprint((unsigned char)(c)))
1275 # define isPUNCT_LC(c) (FITS_IN_8_BITS(c) && ispunct((unsigned char)(c)))
1276 # define isSPACE_LC(c) (FITS_IN_8_BITS(c) && isspace((unsigned char)(c)))
1277 # define isUPPER_LC(c) (FITS_IN_8_BITS(c) && isupper((unsigned char)(c)))
1278 # define isWORDCHAR_LC(c) (FITS_IN_8_BITS(c) \
1279 && (isalnum((unsigned char)(c)) || (char)(c) == '_'))
1280 # define isXDIGIT_LC(c) (FITS_IN_8_BITS(c) && isxdigit((unsigned char)(c)))
1281 # define toLOWER_LC(c) (FITS_IN_8_BITS(c) ? tolower((unsigned char)(c)) : (c))
1282 # define toUPPER_LC(c) (FITS_IN_8_BITS(c) ? toupper((unsigned char)(c)) : (c))
1286 # define isALPHA_LC(c) (isascii(c) && isalpha(c))
1287 # define isALPHANUMERIC_LC(c) (isascii(c) && isalnum(c))
1288 # define isASCII_LC(c) isascii(c)
1290 # define isBLANK_LC(c) (isascii(c) && isblank(c))
1292 # define isBLANK_LC(c) isBLANK_A(c)
1294 # define isCNTRL_LC(c) (isascii(c) && iscntrl(c))
1295 # define isDIGIT_LC(c) (isascii(c) && isdigit(c))
1296 # define isGRAPH_LC(c) (isascii(c) && isgraph(c))
1297 # define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
1298 # define isLOWER_LC(c) (isascii(c) && islower(c))
1299 # define isPRINT_LC(c) (isascii(c) && isprint(c))
1300 # define isPUNCT_LC(c) (isascii(c) && ispunct(c))
1301 # define isSPACE_LC(c) (isascii(c) && isspace(c))
1302 # define isUPPER_LC(c) (isascii(c) && isupper(c))
1303 # define isWORDCHAR_LC(c) (isascii(c) && (isalnum(c) || (c) == '_'))
1304 # define isXDIGIT_LC(c) (isascii(c) && isxdigit(c))
1305 # define toLOWER_LC(c) (isascii(c) ? tolower(c) : (c))
1306 # define toUPPER_LC(c) (isascii(c) ? toupper(c) : (c))
1309 #endif /* USE_NEXT_CTYPE */
1311 #define isIDCONT(c) isWORDCHAR(c)
1312 #define isIDCONT_A(c) isWORDCHAR_A(c)
1313 #define isIDCONT_L1(c) isWORDCHAR_L1(c)
1314 #define isIDCONT_LC(c) isWORDCHAR_LC(c)
1315 #define isPSXSPC_LC(c) isSPACE_LC(c)
1317 /* For internal core Perl use only. If the input is Latin1, use the Latin1
1318 * macro; otherwise use the function 'above_latin1'. Won't compile if 'c' isn't unsigned, as
1319 * won't match above_latin1 prototype. The macros do bounds checking, so have
1320 * duplicate checks here, so could create versions of the macros that don't,
1321 * but experiments show that gcc optimizes them out anyway. */
1323 /* Note that all ignore 'use bytes' */
1324 #define _generic_uni(classnum, above_latin1, c) ((c) < 256 \
1325 ? _generic_isCC(c, classnum) \
1327 #define _generic_swash_uni(classnum, c) ((c) < 256 \
1328 ? _generic_isCC(c, classnum) \
1329 : _is_uni_FOO(classnum, c))
1330 #define isALPHA_uni(c) _generic_swash_uni(_CC_ALPHA, c)
1331 #define isALPHANUMERIC_uni(c) _generic_swash_uni(_CC_ALPHANUMERIC, c)
1332 #define isASCII_uni(c) isASCII(c)
1333 #define isBLANK_uni(c) _generic_uni(_CC_BLANK, is_HORIZWS_cp_high, c)
1334 #define isCNTRL_uni(c) isCNTRL_L1(c) /* All controls are in Latin1 */
1335 #define isDIGIT_uni(c) _generic_swash_uni(_CC_DIGIT, c)
1336 #define isGRAPH_uni(c) _generic_swash_uni(_CC_GRAPH, c)
1337 #define isIDCONT_uni(c) _generic_uni(_CC_WORDCHAR, _is_uni_perl_idcont, c)
1338 #define isIDFIRST_uni(c) _generic_uni(_CC_IDFIRST, _is_uni_perl_idstart, c)
1339 #define isLOWER_uni(c) _generic_swash_uni(_CC_LOWER, c)
1340 #define isPRINT_uni(c) _generic_swash_uni(_CC_PRINT, c)
1342 /* Posix and regular space are identical above Latin1 */
1343 #define isPSXSPC_uni(c) _generic_uni(_CC_PSXSPC, is_XPERLSPACE_cp_high, c)
1345 #define isPUNCT_uni(c) _generic_swash_uni(_CC_PUNCT, c)
1346 #define isSPACE_uni(c) _generic_uni(_CC_SPACE, is_XPERLSPACE_cp_high, c)
1347 #define isUPPER_uni(c) _generic_swash_uni(_CC_UPPER, c)
1348 #define isVERTWS_uni(c) _generic_uni(_CC_VERTSPACE, is_VERTWS_cp_high, c)
1349 #define isWORDCHAR_uni(c) _generic_swash_uni(_CC_WORDCHAR, c)
1350 #define isXDIGIT_uni(c) _generic_uni(_CC_XDIGIT, is_XDIGIT_cp_high, c)
1352 #define toFOLD_uni(c,s,l) to_uni_fold(c,s,l)
1353 #define toLOWER_uni(c,s,l) to_uni_lower(c,s,l)
1354 #define toTITLE_uni(c,s,l) to_uni_title(c,s,l)
1355 #define toUPPER_uni(c,s,l) to_uni_upper(c,s,l)
1357 #define _generic_LC_uvchr(latin1, above_latin1, c) \
1358 (c < 256 ? latin1(c) : above_latin1(c))
1359 #define _generic_LC_swash_uvchr(latin1, classnum, c) \
1360 (c < 256 ? latin1(c) : _is_uni_FOO(classnum, c))
1362 #define isALPHA_LC_uvchr(c) _generic_LC_swash_uvchr(isALPHA_LC, _CC_ALPHA, c)
1363 #define isALPHANUMERIC_LC_uvchr(c) _generic_LC_swash_uvchr(isALPHANUMERIC_LC, \
1364 _CC_ALPHANUMERIC, c)
1365 #define isASCII_LC_uvchr(c) isASCII_LC(c)
1366 #define isBLANK_LC_uvchr(c) _generic_LC_uvchr(isBLANK_LC, is_HORIZWS_cp_high, c)
1367 #define isCNTRL_LC_uvchr(c) (c < 256 ? isCNTRL_LC(c) : 0)
1368 #define isDIGIT_LC_uvchr(c) _generic_LC_swash_uvchr(isDIGIT_LC, _CC_DIGIT, c)
1369 #define isGRAPH_LC_uvchr(c) _generic_LC_swash_uvchr(isGRAPH_LC, _CC_GRAPH, c)
1370 #define isIDCONT_LC_uvchr(c) _generic_LC_uvchr(isIDCONT_LC, \
1371 _is_uni_perl_idcont, c)
1372 #define isIDFIRST_LC_uvchr(c) _generic_LC_uvchr(isIDFIRST_LC, \
1373 _is_uni_perl_idstart, c)
1374 #define isLOWER_LC_uvchr(c) _generic_LC_swash_uvchr(isLOWER_LC, _CC_LOWER, c)
1375 #define isPRINT_LC_uvchr(c) _generic_LC_swash_uvchr(isPRINT_LC, _CC_PRINT, c)
1376 #define isPSXSPC_LC_uvchr(c) isSPACE_LC_uvchr(c) /* space is identical to posix
1377 space under locale */
1378 #define isPUNCT_LC_uvchr(c) _generic_LC_swash_uvchr(isPUNCT_LC, _CC_PUNCT, c)
1379 #define isSPACE_LC_uvchr(c) _generic_LC_uvchr(isSPACE_LC, \
1380 is_XPERLSPACE_cp_high, c)
1381 #define isUPPER_LC_uvchr(c) _generic_LC_swash_uvchr(isUPPER_LC, _CC_UPPER, c)
1382 #define isWORDCHAR_LC_uvchr(c) _generic_LC_swash_uvchr(isWORDCHAR_LC, \
1384 #define isXDIGIT_LC_uvchr(c) _generic_LC_uvchr(isXDIGIT_LC, is_XDIGIT_cp_high, c)
1386 #define isBLANK_LC_uni(c) isBLANK_LC_uvchr(UNI_TO_NATIVE(c))
1388 /* Everything whose name begins with an underscore is for internal core Perl
1391 /* If the input is in the Latin1 range, use
1392 * the Latin1 macro 'classnum' on 'p' which is a pointer to a UTF-8 string.
1393 * Otherwise use the value given by the 'utf8' parameter. This relies on the
1394 * fact that ASCII characters have the same representation whether utf8 or not.
1395 * Note that it assumes that the utf8 has been validated, and ignores 'use
1397 #define _generic_utf8(classnum, p, utf8) (UTF8_IS_INVARIANT(*(p)) \
1398 ? _generic_isCC(*(p), classnum) \
1399 : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
1401 TWO_BYTE_UTF8_TO_NATIVE(*(p), \
1405 /* Like the above, but calls 'above_latin1(p)' to get the utf8 value. 'above_latin1'
1407 #define _generic_func_utf8(classnum, above_latin1, p) \
1408 _generic_utf8(classnum, p, above_latin1(p))
1409 /* Like the above, but passes classnum to _isFOO_utf8(), instead of having a
1410 * 'above_latin1' parameter */
1411 #define _generic_swash_utf8(classnum, p) \
1412 _generic_utf8(classnum, p, _is_utf8_FOO(classnum, p))
1414 /* Like the above, but should be used only when it is known that there are no
1415 * characters in the range 128-255 which the class is TRUE for. Hence it can
1416 * skip the tests for this range. 'above_latin1' should include its arguments */
1417 #define _generic_utf8_no_upper_latin1(classnum, p, above_latin1) \
1418 (UTF8_IS_INVARIANT(*(p)) \
1419 ? _generic_isCC(*(p), classnum) \
1420 : (UTF8_IS_ABOVE_LATIN1(*(p))) \
1424 /* NOTE that some of these macros have very similar ones in regcharclass.h.
1425 * For example, there is (at the time of this writing) an 'is_SPACE_utf8()'
1426 * there, differing in name only by an underscore from the one here
1427 * 'isSPACE_utf8(). The difference is that the ones here are probably more
1428 * efficient and smaller, using an O(1) array lookup for Latin1-range code
1429 * points; the regcharclass.h ones are implemented as a series of
1430 * "if-else-if-else ..." */
1432 #define isALPHA_utf8(p) _generic_swash_utf8(_CC_ALPHA, p)
1433 #define isALPHANUMERIC_utf8(p) _generic_swash_utf8(_CC_ALPHANUMERIC, p)
1434 #define isASCII_utf8(p) isASCII(*p) /* Because ASCII is invariant under
1435 utf8, the non-utf8 macro works
1437 #define isBLANK_utf8(p) _generic_func_utf8(_CC_BLANK, is_HORIZWS_high, p)
1438 #define isCNTRL_utf8(p) _generic_utf8(_CC_CNTRL, p, 0)
1439 #define isDIGIT_utf8(p) _generic_utf8_no_upper_latin1(_CC_DIGIT, p, \
1440 _is_utf8_FOO(_CC_DIGIT, p))
1441 #define isGRAPH_utf8(p) _generic_swash_utf8(_CC_GRAPH, p)
1442 #define isIDCONT_utf8(p) _generic_func_utf8(_CC_WORDCHAR, \
1443 _is_utf8_perl_idcont, p)
1445 /* To prevent S_scan_word in toke.c from hanging, we have to make sure that
1446 * IDFIRST is an alnum. See
1447 * http://rt.perl.org/rt3/Ticket/Display.html?id=74022 for more detail than you
1448 * ever wanted to know about. (In the ASCII range, there isn't a difference.)
1449 * This used to be not the XID version, but we decided to go with the more
1450 * modern Unicode definition */
1451 #define isIDFIRST_utf8(p) _generic_func_utf8(_CC_IDFIRST, \
1452 _is_utf8_perl_idstart, p)
1454 #define isLOWER_utf8(p) _generic_swash_utf8(_CC_LOWER, p)
1455 #define isPRINT_utf8(p) _generic_swash_utf8(_CC_PRINT, p)
1457 /* Posix and regular space are identical above Latin1 */
1458 #define isPSXSPC_utf8(p) _generic_func_utf8(_CC_PSXSPC, is_XPERLSPACE_high, p)
1460 #define isPUNCT_utf8(p) _generic_swash_utf8(_CC_PUNCT, p)
1461 #define isSPACE_utf8(p) _generic_func_utf8(_CC_SPACE, is_XPERLSPACE_high, p)
1462 #define isUPPER_utf8(p) _generic_swash_utf8(_CC_UPPER, p)
1463 #define isVERTWS_utf8(p) _generic_func_utf8(_CC_VERTSPACE, is_VERTWS_high, p)
1464 #define isWORDCHAR_utf8(p) _generic_swash_utf8(_CC_WORDCHAR, p)
1465 #define isXDIGIT_utf8(p) _generic_utf8_no_upper_latin1(_CC_XDIGIT, p, \
1468 #define toFOLD_utf8(p,s,l) to_utf8_fold(p,s,l)
1469 #define toLOWER_utf8(p,s,l) to_utf8_lower(p,s,l)
1470 #define toTITLE_utf8(p,s,l) to_utf8_title(p,s,l)
1471 #define toUPPER_utf8(p,s,l) to_utf8_upper(p,s,l)
1473 /* For internal core Perl use only. If the input is in the Latin1 range, use
1474 * the macro 'macro' on 'p' which is a pointer to a UTF-8 string. Otherwise
1475 * use the value given by the 'utf8' parameter. This relies on the fact that
1476 * ASCII characters have the same representation whether utf8 or not. Note
1477 * that it assumes that the utf8 has been validated, and ignores 'use bytes' */
1478 #define _generic_LC_utf8(macro, p, utf8) \
1479 (UTF8_IS_INVARIANT(*(p)) \
1481 : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
1482 ? macro(TWO_BYTE_UTF8_TO_NATIVE(*(p), *((p)+1))) \
1485 #define _generic_LC_swash_utf8(macro, classnum, p) \
1486 _generic_LC_utf8(macro, p, _is_utf8_FOO(classnum, p))
1487 #define _generic_LC_func_utf8(macro, above_latin1, p) \
1488 _generic_LC_utf8(macro, p, above_latin1(p))
1490 #define isALPHANUMERIC_LC_utf8(p) _generic_LC_swash_utf8(isALPHANUMERIC_LC, \
1491 _CC_ALPHANUMERIC, p)
1492 #define isALPHA_LC_utf8(p) _generic_LC_swash_utf8(isALPHA_LC, _CC_ALPHA, p)
1493 #define isASCII_LC_utf8(p) isASCII_LC(*p)
1494 #define isBLANK_LC_utf8(p) _generic_LC_func_utf8(isBLANK_LC, is_HORIZWS_high, p)
1495 #define isCNTRL_LC_utf8(p) _generic_LC_utf8(isCNTRL_LC, p, 0)
1496 #define isDIGIT_LC_utf8(p) _generic_LC_swash_utf8(isDIGIT_LC, _CC_DIGIT, p)
1497 #define isGRAPH_LC_utf8(p) _generic_LC_swash_utf8(isGRAPH_LC, _CC_GRAPH, p)
1498 #define isIDCONT_LC_utf8(p) _generic_LC_func_utf8(isIDCONT_LC, _is_utf8_perl_idcont, p)
1499 #define isIDFIRST_LC_utf8(p) _generic_LC_func_utf8(isIDFIRST_LC, _is_utf8_perl_idstart, p)
1500 #define isLOWER_LC_utf8(p) _generic_LC_swash_utf8(isLOWER_LC, _CC_LOWER, p)
1501 #define isPRINT_LC_utf8(p) _generic_LC_swash_utf8(isPRINT_LC, _CC_PRINT, p)
1502 #define isPSXSPC_LC_utf8(p) isSPACE_LC_utf8(p) /* space is identical to posix
1503 space under locale */
1504 #define isPUNCT_LC_utf8(p) _generic_LC_swash_utf8(isPUNCT_LC, _CC_PUNCT, p)
1505 #define isSPACE_LC_utf8(p) _generic_LC_func_utf8(isSPACE_LC, is_XPERLSPACE_high, p)
1506 #define isUPPER_LC_utf8(p) _generic_LC_swash_utf8(isUPPER_LC, _CC_UPPER, p)
1507 #define isWORDCHAR_LC_utf8(p) _generic_LC_swash_utf8(isWORDCHAR_LC, \
1509 #define isXDIGIT_LC_utf8(p) _generic_LC_func_utf8(isXDIGIT_LC, is_XDIGIT_high, p)
1511 /* Macros for backwards compatibility and for completeness when the ASCII and
1512 * Latin1 values are identical */
1513 #define isALPHAU(c) isALPHA_L1(c)
1514 #define isDIGIT_L1(c) isDIGIT_A(c)
1515 #define isOCTAL(c) isOCTAL_A(c)
1516 #define isOCTAL_L1(c) isOCTAL_A(c)
1517 #define isXDIGIT_L1(c) isXDIGIT_A(c)
1518 #define isALNUM(c) isWORDCHAR(c)
1519 #define isALNUMU(c) isWORDCHAR_L1(c)
1520 #define isALNUM_LC(c) isWORDCHAR_LC(c)
1521 #define isALNUM_uni(c) isWORDCHAR_uni(c)
1522 #define isALNUM_LC_uvchr(c) isWORDCHAR_LC_uvchr(c)
1523 #define isALNUM_utf8(p) isWORDCHAR_utf8(p)
1524 #define isALNUM_LC_utf8(p) isWORDCHAR_LC_utf8(p)
1525 #define isALNUMC_A(c) isALPHANUMERIC_A(c) /* Mnemonic: "C's alnum" */
1526 #define isALNUMC_L1(c) isALPHANUMERIC_L1(c)
1527 #define isALNUMC(c) isALPHANUMERIC(c)
1528 #define isALNUMC_LC(c) isALPHANUMERIC_LC(c)
1529 #define isALNUMC_uni(c) isALPHANUMERIC_uni(c)
1530 #define isALNUMC_LC_uvchr(c) isALPHANUMERIC_LC_uvchr(c)
1531 #define isALNUMC_utf8(p) isALPHANUMERIC_utf8(p)
1532 #define isALNUMC_LC_utf8(p) isALPHANUMERIC_LC_utf8(p)
1534 /* This conversion works both ways, strangely enough. On EBCDIC platforms,
1535 * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII, except that they don't
1536 * necessarily mean the same characters, e.g. CTRL-D is 4 on both systems, but
1537 * that is EOT on ASCII; ST on EBCDIC */
1538 # define toCTRL(c) (toUPPER(NATIVE_TO_LATIN1(c)) ^ 64)
1540 /* Line numbers are unsigned, 32 bits. */
1542 #define NOLINE ((line_t) 4294967295UL) /* = FFFFFFFF */
1544 /* Helpful alias for version prescan */
1545 #define is_LAX_VERSION(a,b) \
1546 (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
1548 #define is_STRICT_VERSION(a,b) \
1549 (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
1551 #define BADVERSION(a,b,c) \
1557 #define READ_XDIGIT(s) (isALPHA(*(s)) ? ((*(s)++ + 9) & 0xf) : (*(s)++ & 0xf))
1560 =head1 Memory Management
1562 =for apidoc Am|void|Newx|void* ptr|int nitems|type
1563 The XSUB-writer's interface to the C C<malloc> function.
1565 In 5.9.3, Newx() and friends replace the older New() API, and drops
1566 the first parameter, I<x>, a debug aid which allowed callers to identify
1567 themselves. This aid has been superseded by a new build option,
1568 PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>). The older API is still
1569 there for use in XS modules supporting older perls.
1571 =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
1572 The XSUB-writer's interface to the C C<malloc> function, with
1573 cast. See also C<Newx>.
1575 =for apidoc Am|void|Newxz|void* ptr|int nitems|type
1576 The XSUB-writer's interface to the C C<malloc> function. The allocated
1577 memory is zeroed with C<memzero>. See also C<Newx>.
1579 =for apidoc Am|void|Renew|void* ptr|int nitems|type
1580 The XSUB-writer's interface to the C C<realloc> function.
1582 =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
1583 The XSUB-writer's interface to the C C<realloc> function, with
1586 =for apidoc Am|void|Safefree|void* ptr
1587 The XSUB-writer's interface to the C C<free> function.
1589 =for apidoc Am|void|Move|void* src|void* dest|int nitems|type
1590 The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1591 source, C<dest> is the destination, C<nitems> is the number of items, and
1592 C<type> is the type. Can do overlapping moves. See also C<Copy>.
1594 =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
1595 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1598 =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
1599 The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1600 source, C<dest> is the destination, C<nitems> is the number of items, and
1601 C<type> is the type. May fail on overlapping copies. See also C<Move>.
1603 =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
1605 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1608 =for apidoc Am|void|Zero|void* dest|int nitems|type
1610 The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1611 destination, C<nitems> is the number of items, and C<type> is the type.
1613 =for apidoc Am|void *|ZeroD|void* dest|int nitems|type
1615 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1618 =for apidoc Am|void|StructCopy|type *src|type *dest|type
1619 This is an architecture-independent macro to copy one structure to another.
1621 =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
1623 Fill up memory with a byte pattern (a byte repeated over and over
1624 again) that hopefully catches attempts to access uninitialized memory.
1626 =for apidoc Am|void|PoisonNew|void* dest|int nitems|type
1628 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
1630 =for apidoc Am|void|PoisonFree|void* dest|int nitems|type
1632 PoisonWith(0xEF) for catching access to freed memory.
1634 =for apidoc Am|void|Poison|void* dest|int nitems|type
1636 PoisonWith(0xEF) for catching access to freed memory.
1640 /* Maintained for backwards-compatibility only. Use newSV() instead. */
1642 #define NEWSV(x,len) newSV(len)
1645 #define MEM_SIZE_MAX ((MEM_SIZE)~0)
1647 /* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
1648 * overly eager compilers that will bleat about e.g.
1649 * (U16)n > (size_t)~0/sizeof(U16) always being false. */
1650 #ifdef PERL_MALLOC_WRAP
1651 #define MEM_WRAP_CHECK(n,t) \
1652 (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (croak_memory_wrap(),0))
1653 #define MEM_WRAP_CHECK_1(n,t,a) \
1654 (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
1655 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
1657 #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)))
1660 #define MEM_WRAP_CHECK(n,t)
1661 #define MEM_WRAP_CHECK_1(n,t,a)
1662 #define MEM_WRAP_CHECK_2(n,t,a,b)
1663 #define MEM_WRAP_CHECK_(n,t)
1665 #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
1671 * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
1672 * go through functions, which are handy for debugging breakpoints, but
1673 * which more importantly get the immediate calling environment (file and
1674 * line number, and C function name if available) passed in. This info can
1675 * then be used for logging the calls, for which one gets a sample
1676 * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
1679 * - not all memory allocs get logged, only those
1680 * that go through Newx() and derivatives (while all
1681 * Safefrees do get logged)
1682 * - __FILE__ and __LINE__ do not work everywhere
1683 * - __func__ or __FUNCTION__ even less so
1684 * - I think more goes on after the perlio frees but
1685 * the thing is that STDERR gets closed (as do all
1686 * the file descriptors)
1687 * - no deeper calling stack than the caller of the Newx()
1688 * or the kind, but do I look like a C reflection/introspection
1690 * - the function prototypes for the logging functions
1691 * probably should maybe be somewhere else than handy.h
1692 * - one could consider inlining (macrofying) the logging
1693 * for speed, but I am too lazy
1694 * - one could imagine recording the allocations in a hash,
1695 * (keyed by the allocation address?), and maintain that
1696 * through reallocs and frees, but how to do that without
1697 * any News() happening...?
1698 * - lots of -Ddefines to get useful/controllable output
1699 * - lots of ENV reads
1702 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);
1704 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);
1706 PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
1709 # ifndef PERL_MEM_LOG_NOIMPL
1718 # if defined(PERL_IN_SV_C) /* those are only used in sv.c */
1719 void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1720 void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1727 #define MEM_LOG_ALLOC(n,t,a) Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
1728 #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
1729 #define MEM_LOG_FREE(a) Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
1732 #ifndef MEM_LOG_ALLOC
1733 #define MEM_LOG_ALLOC(n,t,a) (a)
1735 #ifndef MEM_LOG_REALLOC
1736 #define MEM_LOG_REALLOC(n,t,v,a) (a)
1738 #ifndef MEM_LOG_FREE
1739 #define MEM_LOG_FREE(a) (a)
1742 #define Newx(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1743 #define Newxc(v,n,t,c) (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1744 #define Newxz(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
1747 /* pre 5.9.x compatibility */
1748 #define New(x,v,n,t) Newx(v,n,t)
1749 #define Newc(x,v,n,t,c) Newxc(v,n,t,c)
1750 #define Newz(x,v,n,t) Newxz(v,n,t)
1753 #define Renew(v,n,t) \
1754 (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1755 #define Renewc(v,n,t,c) \
1756 (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1759 #define Safefree(d) \
1760 ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
1762 #define Safefree(d) safefree(MEM_LOG_FREE((Malloc_t)(d)))
1765 #define Move(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1766 #define Copy(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1767 #define Zero(d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
1769 #define MoveD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1770 #define CopyD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1772 #define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
1774 /* Using bzero(), which returns void. */
1775 #define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
1778 #define PoisonWith(d,n,t,b) (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
1779 #define PoisonNew(d,n,t) PoisonWith(d,n,t,0xAB)
1780 #define PoisonFree(d,n,t) PoisonWith(d,n,t,0xEF)
1781 #define Poison(d,n,t) PoisonFree(d,n,t)
1784 # define PERL_POISON_EXPR(x) x
1786 # define PERL_POISON_EXPR(x)
1789 #ifdef USE_STRUCT_COPY
1790 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
1792 #define StructCopy(s,d,t) Copy(s,d,1,t)
1795 #define C_ARRAY_LENGTH(a) (sizeof(a)/sizeof((a)[0]))
1796 #define C_ARRAY_END(a) (a) + (sizeof(a)/sizeof((a)[0]))
1800 # define Perl_va_copy(s, d) va_copy(d, s)
1802 # if defined(__va_copy)
1803 # define Perl_va_copy(s, d) __va_copy(d, s)
1805 # define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
1810 /* convenience debug macros */
1812 #define pTHX_FORMAT "Perl interpreter: 0x%p"
1813 #define pTHX__FORMAT ", Perl interpreter: 0x%p"
1814 #define pTHX_VALUE_ (void *)my_perl,
1815 #define pTHX_VALUE (void *)my_perl
1816 #define pTHX__VALUE_ ,(void *)my_perl,
1817 #define pTHX__VALUE ,(void *)my_perl
1820 #define pTHX__FORMAT
1823 #define pTHX__VALUE_
1825 #endif /* USE_ITHREADS */
1827 /* Perl_deprecate was not part of the public API, and did not have a deprecate()
1828 shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
1829 CPAN::Unpack show any users outside the core. */
1831 # define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
1834 /* Internal macros to deal with gids and uids */
1837 # if Uid_t_size > IVSIZE
1838 # define sv_setuid(sv, uid) sv_setnv((sv), (NV)(uid))
1839 # define SvUID(sv) SvNV(sv)
1841 # if Uid_t_sign <= 0
1842 # define sv_setuid(sv, uid) sv_setiv((sv), (IV)(uid))
1843 # define SvUID(sv) SvIV(sv)
1845 # define sv_setuid(sv, uid) sv_setuv((sv), (UV)(uid))
1846 # define SvUID(sv) SvUV(sv)
1848 # endif /* Uid_t_size */
1850 # if Gid_t_size > IVSIZE
1851 # define sv_setgid(sv, gid) sv_setnv((sv), (NV)(gid))
1852 # define SvGID(sv) SvNV(sv)
1854 # if Gid_t_sign <= 0
1855 # define sv_setgid(sv, gid) sv_setiv((sv), (IV)(gid))
1856 # define SvGID(sv) SvIV(sv)
1858 # define sv_setgid(sv, gid) sv_setuv((sv), (UV)(gid))
1859 # define SvGID(sv) SvUV(sv)
1861 # endif /* Gid_t_size */
1865 #endif /* HANDY_H */
1869 * c-indentation-style: bsd
1871 * indent-tabs-mode: nil
1874 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob