This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add new Locale::Maketext files to MANIFEST
[perl5.git] / handy.h
CommitLineData
a0d0e21e 1/* handy.h
a687059c 2 *
1129b882
NC
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000,
4 * 2001, 2002, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
a687059c 5 *
6e21c824
LW
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.
8d063cd8 8 *
8d063cd8
LW
9 */
10
85e6fe83 11#if !defined(__STDC__)
378cc40b
LW
12#ifdef NULL
13#undef NULL
14#endif
a687059c
LW
15#ifndef I286
16# define NULL 0
17#else
18# define NULL 0L
19#endif
85e6fe83
LW
20#endif
21
24792b8d
NC
22#ifndef PERL_CORE
23# define Null(type) ((type)NULL)
954c1994
GS
24
25/*
ccfc67b7 26=head1 Handy Values
954c1994 27
3609ea0d 28=for apidoc AmU||Nullch
24792b8d 29Null character pointer. (No longer available when C<PERL_CORE> is defined.)
2307c6d0 30
954c1994 31=for apidoc AmU||Nullsv
24792b8d 32Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
954c1994
GS
33
34=cut
35*/
36
24792b8d
NC
37# define Nullch Null(char*)
38# define Nullfp Null(PerlIO*)
39# define Nullsv Null(SV*)
40#endif
8d063cd8 41
641d3f0b
PP
42#ifdef TRUE
43#undef TRUE
44#endif
45#ifdef FALSE
46#undef FALSE
47#endif
48#define TRUE (1)
49#define FALSE (0)
50
cf3f0ffb
DM
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;
53 * e.g.:
54 *
55 * const SV *sv = ...;
56 * AV *av1 = (AV*)sv; <== BAD: the const has been silently cast away
57 * AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
58 */
59
b1bc3f34 60#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
f065df04 61# define MUTABLE_PTR(p) ({ void *_p = (p); _p; })
b1bc3f34
NC
62#else
63# define MUTABLE_PTR(p) ((void *) (p))
64#endif
65
a062e10d 66#define MUTABLE_AV(p) ((AV *)MUTABLE_PTR(p))
ea726b52 67#define MUTABLE_CV(p) ((CV *)MUTABLE_PTR(p))
159b6efe 68#define MUTABLE_GV(p) ((GV *)MUTABLE_PTR(p))
dbebbdb4 69#define MUTABLE_HV(p) ((HV *)MUTABLE_PTR(p))
a45c7426 70#define MUTABLE_IO(p) ((IO *)MUTABLE_PTR(p))
b1bc3f34 71#define MUTABLE_SV(p) ((SV *)MUTABLE_PTR(p))
27d4fb96
PP
72
73/* XXX Configure ought to have a test for a boolean type, if I can
74 just figure out all the headers such a test needs.
75 Andy Dougherty August 1996
76*/
8e84507e 77/* bool is built-in for g++-2.6.3 and later, which might be used
c1d22f6b
GS
78 for extensions. <_G_config.h> defines _G_HAVE_BOOL, but we can't
79 be sure _G_config.h will be included before this file. _G_config.h
8e84507e 80 also defines _G_HAVE_BOOL for both gcc and g++, but only g++
c1d22f6b
GS
81 actually has bool. Hence, _G_HAVE_BOOL is pretty useless for us.
82 g++ can be identified by __GNUG__.
83 Andy Dougherty February 2000
5d94fbed 84*/
3609ea0d 85#ifdef __GNUG__ /* GNU g++ has bool built-in */
5d94fbed 86# ifndef HAS_BOOL
c1d22f6b 87# define HAS_BOOL 1
5d94fbed 88# endif
5d94fbed
AD
89#endif
90
641d3f0b
PP
91/* The NeXT dynamic loader headers will not build with the bool macro
92 So declare them now to clear confusion.
93*/
8f1f23e8 94#if defined(NeXT) || defined(__NeXT__)
641d3f0b
PP
95# undef FALSE
96# undef TRUE
97 typedef enum bool { FALSE = 0, TRUE = 1 } bool;
98# define ENUM_BOOL 1
99# ifndef HAS_BOOL
100# define HAS_BOOL 1
101# endif /* !HAS_BOOL */
8f1f23e8 102#endif /* NeXT || __NeXT__ */
641d3f0b 103
5d94fbed 104#ifndef HAS_BOOL
61bb5906 105# if defined(UTS) || defined(VMS)
5d94fbed
AD
106# define bool int
107# else
108# define bool char
109# endif
c1d22f6b 110# define HAS_BOOL 1
a687059c 111#endif
0d3e774c 112
f2338a2e
DM
113/* a simple (bool) cast may not do the right thing: if bool is defined
114 * as char for example, then the cast from int is implementation-defined
115 */
116
117#define cBOOL(cbool) ((bool)!!(cbool))
118
46c6c7e2 119/* Try to figure out __func__ or __FUNCTION__ equivalent, if any.
e352bcff
JH
120 * XXX Should really be a Configure probe, with HAS__FUNCTION__
121 * and FUNCTION__ as results.
122 * XXX Similarly, a Configure probe for __FILE__ and __LINE__ is needed. */
46c6c7e2
JH
123#if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || (defined(__SUNPRO_C)) /* C99 or close enough. */
124# define FUNCTION__ __func__
125#else
126# if (defined(_MSC_VER) && _MSC_VER < 1300) || /* Pre-MSVC 7.0 has neither __func__ nor __FUNCTION and no good workarounds, either. */ \
be73ebb0 127 (defined(__DECC_VER)) /* Tru64 or VMS, and strict C89 being used, but not modern enough cc (in Tur64, -c99 not known, only -std1). */
46c6c7e2
JH
128# define FUNCTION__ ""
129# else
130# define FUNCTION__ __FUNCTION__ /* Common extension. */
131# endif
132#endif
133
27d4fb96
PP
134/* XXX A note on the perl source internal type system. The
135 original intent was that I32 be *exactly* 32 bits.
136
137 Currently, we only guarantee that I32 is *at least* 32 bits.
138 Specifically, if int is 64 bits, then so is I32. (This is the case
139 for the Cray.) This has the advantage of meshing nicely with
140 standard library calls (where we pass an I32 and the library is
141 expecting an int), but the disadvantage that an I32 is not 32 bits.
142 Andy Dougherty August 1996
24fef2a7 143
dc45a647
MB
144 There is no guarantee that there is *any* integral type with
145 exactly 32 bits. It is perfectly legal for a system to have
146 sizeof(short) == sizeof(int) == sizeof(long) == 8.
693762b4 147
dc45a647
MB
148 Similarly, there is no guarantee that I16 and U16 have exactly 16
149 bits.
693762b4 150
8e84507e
NIS
151 For dealing with issues that may arise from various 32/64-bit
152 systems, we will ask Configure to check out
8175356b 153
3609ea0d
JH
154 SHORTSIZE == sizeof(short)
155 INTSIZE == sizeof(int)
156 LONGSIZE == sizeof(long)
dc45a647 157 LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
3609ea0d 158 PTRSIZE == sizeof(void *)
dc45a647
MB
159 DOUBLESIZE == sizeof(double)
160 LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
8175356b 161
27d4fb96
PP
162*/
163
69512466
JH
164#ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
165# include <inttypes.h>
dd0eed91
JH
166# ifdef INT32_MIN_BROKEN
167# undef INT32_MIN
168# define INT32_MIN (-2147483647-1)
169# endif
170# ifdef INT64_MIN_BROKEN
171# undef INT64_MIN
172# define INT64_MIN (-9223372036854775807LL-1)
173# endif
69512466
JH
174#endif
175
8175356b
JH
176typedef I8TYPE I8;
177typedef U8TYPE U8;
178typedef I16TYPE I16;
179typedef U16TYPE U16;
180typedef I32TYPE I32;
181typedef U32TYPE U32;
6b8eaf93
JH
182#ifdef PERL_CORE
183# ifdef HAS_QUAD
8175356b
JH
184typedef I64TYPE I64;
185typedef U64TYPE U64;
6b8eaf93
JH
186# endif
187#endif /* PERL_CORE */
8175356b 188
69512466
JH
189#if defined(HAS_QUAD) && defined(USE_64_BIT_INT)
190# ifndef UINT64_C /* usually from <inttypes.h> */
191# if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
192# define INT64_C(c) CAT2(c,LL)
193# define UINT64_C(c) CAT2(c,ULL)
194# else
195# if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
196# define INT64_C(c) CAT2(c,L)
197# define UINT64_C(c) CAT2(c,UL)
198# else
fa58a56f
S
199# if defined(_WIN64) && defined(_MSC_VER)
200# define INT64_C(c) CAT2(c,I64)
201# define UINT64_C(c) CAT2(c,UI64)
202# else
203# define INT64_C(c) ((I64TYPE)(c))
204# define UINT64_C(c) ((U64TYPE)(c))
205# endif
69512466
JH
206# endif
207# endif
e8c95190
JH
208# endif
209#endif
dc750f2e 210
5086dff9
MB
211/* HMB H.Merijn Brand - a placeholder for preparing Configure patches:
212 *
213 * USE_DTRACE HAS_PSEUDOFORK HAS_TIMEGM LOCALTIME_R_NEEDS_TZSET
214 * GMTIME_MAX GMTIME_MIN LOCALTIME_MAX LOCALTIME_MIN
215 * HAS_CTIME64 HAS_LOCALTIME64 HAS_GMTIME64 HAS_DIFFTIME64
216 * HAS_MKTIME64 HAS_ASCTIME64 HAS_GETADDRINFO HAS_GETNAMEINFO
7636ea95 217 * HAS_INETNTOP HAS_INETPTON CHARBITS HAS_PRCTL
5086dff9
MB
218 * Not (yet) used at top level, but mention them for metaconfig
219 */
e8c95190 220
a22e52b9
JH
221/* Mention I8SIZE, U8SIZE, I16SIZE, U16SIZE, I32SIZE, U32SIZE,
222 I64SIZE, and U64SIZE here so that metaconfig pulls them in. */
223
d8668976 224#if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
5ff3f7a4 225
5ff3f7a4
GS
226/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
227 Please search CHAR_MAX in perl.h for further details. */
228#define U8_MAX UINT8_MAX
229#define U8_MIN UINT8_MIN
230
5ff3f7a4
GS
231#define I16_MAX INT16_MAX
232#define I16_MIN INT16_MIN
233#define U16_MAX UINT16_MAX
234#define U16_MIN UINT16_MIN
235
5ff3f7a4
GS
236#define I32_MAX INT32_MAX
237#define I32_MIN INT32_MIN
0e983133
GS
238#ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
239# define U32_MAX UINT32_MAX
240#else
241# define U32_MAX 4294967295U
242#endif
5ff3f7a4
GS
243#define U32_MIN UINT32_MIN
244
245#else
246
5c9fa16e
KA
247/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
248 Please search CHAR_MAX in perl.h for further details. */
27d4fb96
PP
249#define U8_MAX PERL_UCHAR_MAX
250#define U8_MIN PERL_UCHAR_MIN
79072805 251
27d4fb96
PP
252#define I16_MAX PERL_SHORT_MAX
253#define I16_MIN PERL_SHORT_MIN
254#define U16_MAX PERL_USHORT_MAX
255#define U16_MIN PERL_USHORT_MIN
79072805 256
c4f23d77 257#if LONGSIZE > 4
27d4fb96
PP
258# define I32_MAX PERL_INT_MAX
259# define I32_MIN PERL_INT_MIN
260# define U32_MAX PERL_UINT_MAX
261# define U32_MIN PERL_UINT_MIN
79072805 262#else
27d4fb96
PP
263# define I32_MAX PERL_LONG_MAX
264# define I32_MIN PERL_LONG_MIN
265# define U32_MAX PERL_ULONG_MAX
266# define U32_MIN PERL_ULONG_MIN
79072805
LW
267#endif
268
5ff3f7a4
GS
269#endif
270
58a9a5d5 271/* log(2) is pretty close to 0.30103, just in case anyone is grepping for it */
fc36a67e
PP
272#define BIT_DIGITS(N) (((N)*146)/485 + 1) /* log2(10) =~ 146/485 */
273#define TYPE_DIGITS(T) BIT_DIGITS(sizeof(T) * 8)
274#define TYPE_CHARS(T) (TYPE_DIGITS(T) + 2) /* sign, NUL */
275
ff68c719 276#define Ctl(ch) ((ch) & 037)
8d063cd8 277
3fe05580
MHM
278/*
279=head1 SV-Body Allocation
280
281=for apidoc Ama|SV*|newSVpvs|const char* s
282Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
283
84bafc02
NC
284=for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags
285Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
286pair.
287
3fe05580
MHM
288=for apidoc Ama|SV*|newSVpvs_share|const char* s
289Like C<newSVpvn_share>, but takes a literal string instead of a string/length
290pair and omits the hash parameter.
291
7b4e7469 292=for apidoc Am|void|sv_catpvs|SV* sv|const char* s
3fe05580
MHM
293Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
294
7b4e7469 295=for apidoc Am|void|sv_setpvs|SV* sv|const char* s
3fe05580
MHM
296Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
297
298=head1 Memory Management
299
300=for apidoc Ama|char*|savepvs|const char* s
301Like C<savepvn>, but takes a literal string instead of a string/length pair.
302
303=head1 GV Functions
304
305=for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create
306Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
307
308=head1 Hash Manipulation Functions
309
310=for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval
311Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
312
313=for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val
314Like C<hv_store>, but takes a literal string instead of a string/length pair
315and omits the hash parameter.
316
510966aa
Z
317=head1 Lexer interface
318
319=for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags
320
321Like L</lex_stuff_pvn>, but takes a literal string instead of a
322string/length pair.
323
3fe05580
MHM
324=cut
325*/
326
65177ae0 327/* concatenating with "" ensures that only literal strings are accepted as argument */
26bfd924 328#define STR_WITH_LEN(s) ("" s ""), (sizeof(s)-1)
2efa8cc7 329
ba3a79e7
GA
330/* note that STR_WITH_LEN() can't be used as argument to macros or functions that
331 * under some configurations might be macros, which means that it requires the full
332 * Perl_xxx(aTHX_ ...) form for any API calls where it's used.
333 */
334
335/* STR_WITH_LEN() shortcuts */
336#define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str))
84bafc02
NC
337#define newSVpvs_flags(str,flags) \
338 Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags)
ba3a79e7
GA
339#define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0)
340#define sv_catpvs(sv, str) Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC)
3fe05580 341#define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str))
ba3a79e7
GA
342#define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str))
343#define gv_stashpvs(str, create) Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create)
5c1737d1 344#define gv_fetchpvs(namebeg, add, sv_type) Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type)
a038e571
NC
345#define hv_fetchs(hv,key,lval) \
346 ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \
347 (lval) ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \
348 : HV_FETCH_JUST_SV, NULL, 0))
349
350#define hv_stores(hv,key,val) \
351 ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \
352 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), 0))
ba3a79e7 353
510966aa
Z
354#define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
355
b96d8cd9
NC
356#define get_cvs(str, flags) \
357 Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
5c1737d1 358
954c1994 359/*
ccfc67b7
JH
360=head1 Miscellaneous Functions
361
954c1994
GS
362=for apidoc Am|bool|strNE|char* s1|char* s2
363Test two strings to see if they are different. Returns true or
364false.
365
366=for apidoc Am|bool|strEQ|char* s1|char* s2
367Test two strings to see if they are equal. Returns true or false.
368
369=for apidoc Am|bool|strLT|char* s1|char* s2
370Test two strings to see if the first, C<s1>, is less than the second,
371C<s2>. Returns true or false.
372
373=for apidoc Am|bool|strLE|char* s1|char* s2
374Test two strings to see if the first, C<s1>, is less than or equal to the
375second, C<s2>. Returns true or false.
376
377=for apidoc Am|bool|strGT|char* s1|char* s2
378Test two strings to see if the first, C<s1>, is greater than the second,
379C<s2>. Returns true or false.
380
381=for apidoc Am|bool|strGE|char* s1|char* s2
382Test two strings to see if the first, C<s1>, is greater than or equal to
383the second, C<s2>. Returns true or false.
384
385=for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
386Test two strings to see if they are different. The C<len> parameter
387indicates the number of bytes to compare. Returns true or false. (A
388wrapper for C<strncmp>).
389
390=for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
391Test two strings to see if they are equal. The C<len> parameter indicates
392the number of bytes to compare. Returns true or false. (A wrapper for
393C<strncmp>).
394
395=cut
396*/
397
8d063cd8
LW
398#define strNE(s1,s2) (strcmp(s1,s2))
399#define strEQ(s1,s2) (!strcmp(s1,s2))
400#define strLT(s1,s2) (strcmp(s1,s2) < 0)
401#define strLE(s1,s2) (strcmp(s1,s2) <= 0)
402#define strGT(s1,s2) (strcmp(s1,s2) > 0)
403#define strGE(s1,s2) (strcmp(s1,s2) >= 0)
404#define strnNE(s1,s2,l) (strncmp(s1,s2,l))
405#define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
378cc40b 406
36477c24
PP
407#ifdef HAS_MEMCMP
408# define memNE(s1,s2,l) (memcmp(s1,s2,l))
409# define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
410#else
411# define memNE(s1,s2,l) (bcmp(s1,s2,l))
412# define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
413#endif
414
568a785a 415#define memEQs(s1, l, s2) \
8e6497b6 416 (sizeof(s2)-1 == l && memEQ(s1, ("" s2 ""), (sizeof(s2)-1)))
568a785a
NC
417#define memNEs(s1, l, s2) !memEQs(s1, l, s2)
418
bbce6d69
PP
419/*
420 * Character classes.
421 *
422 * Unfortunately, the introduction of locales means that we
423 * can't trust isupper(), etc. to tell the truth. And when
424 * it comes to /\w+/ with tainting enabled, we *must* be able
425 * to trust our character classes.
426 *
427 * Therefore, the default tests in the text of Perl will be
428 * independent of locale. Any code that wants to depend on
429 * the current locale will use the tests that begin with "lc".
430 */
431
2304df62
AD
432#ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */
433# ifndef CTYPE256
434# define CTYPE256
435# endif
436#endif
437
954c1994 438/*
ccfc67b7
JH
439
440=head1 Character classes
8a58bdcf
KW
441There are three variants for all the functions in this section. The base ones
442operate using the character set of the platform Perl is running on. The ones
443with an C<_A> suffix operate on the ASCII character set, and the ones with an
444C<_L1> suffix operate on the full Latin1 character set. All are unaffected by
445locale
446
447For ASCII platforms, the base function with no suffix and the one with the
448C<_A> suffix are identical. The function with the C<_L1> suffix imposes the
449Latin-1 character set onto the platform. That is, the code points that are
450ASCII are unaffected, since ASCII is a subset of Latin-1. But the non-ASCII
451code points are treated as if they are Latin-1 characters. For example,
452C<isSPACE_L1()> will return true when called with the code point 0xA0, which is
453the Latin-1 NO-BREAK SPACE.
454
455For EBCDIC platforms, the base function with no suffix and the one with the
456C<_L1> suffix should be identical, since, as of this writing, the EBCDIC code
457pages that Perl knows about all are equivalent to Latin-1. The function that
458ends in an C<_A> suffix will not return true unless the specified character also
459has an ASCII equivalent.
ccfc67b7 460
954c1994 461=for apidoc Am|bool|isALPHA|char ch
2787a470 462Returns a boolean indicating whether the specified character is an
06dc89af 463alphabetic character in the platform's native character set.
8a58bdcf
KW
464See the L<top of this section|/Character classes> for an explanation of variants
465C<isALPHA_A> and C<isALPHA_L1>.
466
467=for apidoc Am|bool|isASCII|char ch
468Returns a boolean indicating whether the specified character is one of the 128
469characters in the ASCII character set. On non-ASCII platforms, it is if this
470character corresponds to an ASCII character. Variants C<isASCII_A()> and
471C<isASCII_L1()> are identical to C<isASCII()>.
954c1994 472
954c1994 473=for apidoc Am|bool|isDIGIT|char ch
2787a470 474Returns a boolean indicating whether the specified character is a
06dc89af 475digit in the platform's native character set.
8a58bdcf 476Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
954c1994 477
0c82b6df 478=for apidoc Am|bool|isLOWER|char ch
2787a470 479Returns a boolean indicating whether the specified character is a
0c82b6df 480lowercase character in the platform's native character set.
8a58bdcf
KW
481See the L<top of this section|/Character classes> for an explanation of variants
482C<isLOWER_A> and C<isLOWER_L1>.
0c82b6df 483
c99e91e9 484=for apidoc Am|bool|isOCTAL|char ch
2787a470 485Returns a boolean indicating whether the specified character is an
06dc89af 486octal digit, [0-7] in the platform's native character set.
8a58bdcf 487Variants C<isOCTAL_A> and C<isOCTAL_L1> are identical to C<isOCTAL>.
c99e91e9 488
0c82b6df 489=for apidoc Am|bool|isSPACE|char ch
2787a470 490Returns a boolean indicating whether the specified character is a
8a58bdcf
KW
491whitespace character in the platform's native character set. This is the same
492as what C<\s> matches in a regular expression.
493See the L<top of this section|/Character classes> for an explanation of variants
494C<isSPACE_A> and C<isSPACE_L1>.
0c82b6df 495
954c1994 496=for apidoc Am|bool|isUPPER|char ch
2787a470 497Returns a boolean indicating whether the specified character is an
06dc89af 498uppercase character in the platform's native character set.
8a58bdcf
KW
499See the L<top of this section|/Character classes> for an explanation of variants
500C<isUPPER_A> and C<isUPPER_L1>.
954c1994 501
8eea39dd
KW
502=for apidoc Am|bool|isWORDCHAR|char ch
503Returns a boolean indicating whether the specified character is a
504character that is any of: alphabetic, numeric, or an underscore. This is the
505same as what C<\w> matches in a regular expression.
506C<isALNUM()> is a synonym provided for backward compatibility. Note that it
507does not have the standard C language meaning of alphanumeric, since it matches
508an underscore and the standard meaning does not.
8a58bdcf
KW
509See the L<top of this section|/Character classes> for an explanation of variants
510C<isWORDCHAR_A> and C<isWORDCHAR_L1>.
511
512=for apidoc Am|bool|isXDIGIT|char ch
513Returns a boolean indicating whether the specified character is a hexadecimal
514digit, [0-9A-Fa-f]. Variants C<isXDIGIT_A()> and C<isXDIGIT_L1()> are
515identical to C<isXDIGIT()>.
8eea39dd 516
e7c1e6c1
KW
517=head1 Character case changing
518
954c1994 519=for apidoc Am|char|toUPPER|char ch
06dc89af
KW
520Converts the specified character to uppercase in the platform's native
521character set, if possible; otherwise returns the input character itself.
954c1994
GS
522
523=for apidoc Am|char|toLOWER|char ch
06dc89af
KW
524Converts the specified character to lowercase in the platform's native
525character set, if possible; otherwise returns the input character itself.
954c1994
GS
526
527=cut
353c9b6f 528
8a58bdcf 529Note that these macros are repeated in Devel::PPPort, so should also be
62fa66b6
KW
530patched there. The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
531
954c1994
GS
532*/
533
cf301eb7
KW
534/* FITS_IN_8_BITS(c) returns true if c occupies no more than 8 bits. It is
535 * designed to be hopefully bomb-proof, making sure that no bits of
536 * information are lost even on a 64-bit machine, but to get the compiler to
537 * optimize it out if possible. This is because Configure makes sure that the
538 * machine has an 8-bit byte, so if c is stored in a byte, the sizeof()
539 * guarantees that this evaluates to a constant true at compile time. The use
540 * of the mask instead of '< 256' keeps gcc from complaining that it is alway
d0dcc402
KW
541 * true, when c's storage class is a byte. Use U64TYPE because U64 is known
542 * only in the perl core, and this macro can be called from outside that */
cf301eb7 543#ifdef HAS_QUAD
d0dcc402 544# define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || (((U64TYPE)(c) & 0xFF) == (U64TYPE)(c)))
cf301eb7
KW
545#else
546# define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || (((U32)(c) & 0xFF) == (U32)(c)))
547#endif
548
ec79cfbb
KW
549#define isASCII(c) (FITS_IN_8_BITS(c) ? NATIVE_TO_UNI((U8) c) <= 127 : 0)
550#define isASCII_A(c) isASCII(c)
6515cb76 551
ec79cfbb 552/* ASCII range only */
9fb1bf9d
KW
553#ifdef H_PERL /* If have access to perl.h, lookup in its table */
554# include "l1_char_class_tab.h"
555# define isALNUMC_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALNUMC_A))
556# define isALPHA_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALPHA_A))
557# define isBLANK_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_BLANK_A))
558# define isCNTRL_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_CNTRL_A))
559# define isDIGIT_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_DIGIT_A))
560# define isGRAPH_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_GRAPH_A))
561# define isIDFIRST_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_IDFIRST_A))
562# define isLOWER_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_LOWER_A))
563# define isOCTAL_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_OCTAL_A))
564# define isPRINT_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PRINT_A))
565# define isPSXSPC_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PSXSPC_A))
566# define isPUNCT_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PUNCT_A))
567# define isSPACE_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_SPACE_A))
568# define isUPPER_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_UPPER_A))
569# define isWORDCHAR_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_WORDCHAR_A))
570# define isXDIGIT_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_XDIGIT_A))
571#else /* No perl.h. */
572# define isOCTAL_A(c) ((c) >= '0' && (c) <= '9')
573# ifdef EBCDIC
574# define isALNUMC_A(c) (isASCII(c) && isALNUMC(c))
575# define isALPHA_A(c) (isASCII(c) && isALPHA(c))
576# define isBLANK_A(c) (isASCII(c) && isBLANK(c))
577# define isCNTRL_A(c) (isASCII(c) && isCNTRL(c))
578# define isDIGIT_A(c) (isASCII(c) && isDIGIT(c))
579# define isGRAPH_A(c) (isASCII(c) && isGRAPH(c))
580# define isIDFIRST_A(c) (isASCII(c) && isIDFIRST(c))
581# define isLOWER_A(c) (isASCII(c) && isLOWER(c))
582# define isPRINT_A(c) (isASCII(c) && isPRINT(c))
583# define isPSXSPC_A(c) (isASCII(c) && isPSXSPC(c))
584# define isPUNCT_A(c) (isASCII(c) && isPUNCT(c))
585# define isSPACE_A(c) (isASCII(c) && isSPACE(c))
586# define isUPPER_A(c) (isASCII(c) && isUPPER(c))
587# define isWORDCHAR_A(c) (isASCII(c) && isWORDCHAR(c))
588# define isXDIGIT_A(c) (isASCII(c) && isXDIGIT(c))
589# else /* ASCII platform, no perl.h */
590# define isALNUMC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
591# define isALPHA_A(c) (isUPPER_A(c) || isLOWER_A(c))
592# define isBLANK_A(c) ((c) == ' ' || (c) == '\t')
593# define isCNTRL_A(c) (FITS_IN_8_BITS(c) ? ((U8) (c) < ' ' || (c) == 127) : 0)
594# define isDIGIT_A(c) ((c) >= '0' && (c) <= '9')
595# define isGRAPH_A(c) (isWORDCHAR_A(c) || isPUNCT_A(c))
596# define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_')
597# define isLOWER_A(c) ((c) >= 'a' && (c) <= 'z')
598# define isPRINT_A(c) (((c) >= 32 && (c) < 127))
599# define isPSXSPC_A(c) (isSPACE_A(c) || (c) == '\v')
600# define isPUNCT_A(c) (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64) || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
601# define isSPACE_A(c) ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
602# define isUPPER_A(c) ((c) >= 'A' && (c) <= 'Z')
603# define isWORDCHAR_A(c) (isALPHA_A(c) || isDIGIT_A(c) || (c) == '_')
604# define isXDIGIT_A(c) (isDIGIT_A(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F'))
605# endif
606#endif /* ASCII range definitions */
ec79cfbb
KW
607
608/* Latin1 definitions */
8a58bdcf
KW
609#ifdef H_PERL
610# define isALNUMC_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALNUMC_L1))
611# define isALPHA_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALPHA_L1))
612# define isBLANK_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_BLANK_L1))
613/* continuation character for legal NAME in \N{NAME} */
614# define isCHARNAME_CONT(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_CHARNAME_CONT))
615# define isCNTRL_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_CNTRL_L1))
616# define isGRAPH_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_GRAPH_L1))
617# define isIDFIRST_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_IDFIRST_L1))
618# define isLOWER_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_LOWER_L1))
619# define isPRINT_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PRINT_L1))
620# define isPSXSPC_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PSXSPC_L1))
621# define isPUNCT_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PUNCT_L1))
622# define isSPACE_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_SPACE_L1))
623# define isUPPER_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_UPPER_L1))
624# define isWORDCHAR_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_WORDCHAR_L1))
625#else /* No access to perl.h. Only a few provided here, just in case needed
626 * for backwards compatibility */
627 /* ALPHAU includes Unicode semantics for latin1 characters. It has an extra
628 * >= AA test to speed up ASCII-only tests at the expense of the others */
629# define isALPHA_L1(c) (isALPHA(c) || (NATIVE_TO_UNI((U8) c) >= 0xAA \
630 && ((NATIVE_TO_UNI((U8) c) >= 0xC0 \
631 && NATIVE_TO_UNI((U8) c) != 0xD7 && NATIVE_TO_UNI((U8) c) != 0xF7) \
632 || NATIVE_TO_UNI((U8) c) == 0xAA \
633 || NATIVE_TO_UNI((U8) c) == 0xB5 \
634 || NATIVE_TO_UNI((U8) c) == 0xBA)))
635# define isCHARNAME_CONT(c) (isALNUM_L1(c) || (c) == ' ' || (c) == '-' || (c) == '(' || (c) == ')' || (c) == ':' || NATIVE_TO_UNI((U8) c) == 0xA0)
636#endif
637
638/* Macros for backwards compatibility and for completeness when the ASCII and
639 * Latin1 values are identical */
ec79cfbb
KW
640#define isALNUM(c) isWORDCHAR(c)
641#define isALNUMU(c) isWORDCHAR_L1(c)
8a58bdcf
KW
642#define isALPHAU(c) isALPHA_L1(c)
643#define isDIGIT_L1(c) isDIGIT_A(c)
644#define isOCTAL(c) isOCTAL_A(c)
645#define isOCTAL_L1(c) isOCTAL_A(c)
646#define isXDIGIT_L1(c) isXDIGIT_A(c)
647
648/* Macros that differ between EBCDIC and ASCII. Where C89 defines a function,
649 * that is used in the EBCDIC form, because in EBCDIC we do not do locales:
650 * therefore can use native functions. For those where C89 doesn't define a
651 * function, use our function, assuming that the EBCDIC code page is isomorphic
652 * with Latin1, which the three currently recognized by Perl are. Some libc's
653 * have an isblank(), but it's not guaranteed. */
9d116dd7 654#ifdef EBCDIC
b8c5462f 655# define isALNUMC(c) isalnum(c)
271b5cb3 656# define isALPHA(c) isalpha(c)
0bc70f7f 657# define isBLANK(c) ((c) == ' ' || (c) == '\t' || NATIVE_TO_UNI(c) == 0xA0)
b8c5462f 658# define isCNTRL(c) iscntrl(c)
9916188f 659# define isDIGIT(c) isdigit(c)
b8c5462f 660# define isGRAPH(c) isgraph(c)
8a58bdcf 661# define isIDFIRST(c) (isALPHA(c) || (c) == '_')
7d79683e 662# define isLOWER(c) islower(c)
9d116dd7 663# define isPRINT(c) isprint(c)
56e4b611 664# define isPSXSPC(c) isspace(c)
b8c5462f 665# define isPUNCT(c) ispunct(c)
174b5e76 666# define isSPACE(c) (isPSXSPC(c) && (c) != '\v')
7d79683e 667# define isUPPER(c) isupper(c)
b8c5462f 668# define isXDIGIT(c) isxdigit(c)
8a58bdcf 669# define isWORDCHAR(c) (isalnum(c) || (c) == '_')
9d116dd7 670# define toLOWER(c) tolower(c)
7d79683e 671# define toUPPER(c) toupper(c)
ec79cfbb
KW
672#else /* Not EBCDIC: ASCII-only matching */
673# define isALNUMC(c) isALNUMC_A(c)
271b5cb3 674# define isALPHA(c) isALPHA_A(c)
ec79cfbb
KW
675# define isBLANK(c) isBLANK_A(c)
676# define isCNTRL(c) isCNTRL_A(c)
677# define isDIGIT(c) isDIGIT_A(c)
678# define isGRAPH(c) isGRAPH_A(c)
8a58bdcf 679# define isIDFIRST(c) isIDFIRST_A(c)
ec79cfbb
KW
680# define isLOWER(c) isLOWER_A(c)
681# define isPRINT(c) isPRINT_A(c)
682# define isPSXSPC(c) isPSXSPC_A(c)
683# define isPUNCT(c) isPUNCT_A(c)
684# define isSPACE(c) isSPACE_A(c)
685# define isUPPER(c) isUPPER_A(c)
8a58bdcf 686# define isWORDCHAR(c) isWORDCHAR_A(c)
ec79cfbb 687# define isXDIGIT(c) isXDIGIT_A(c)
00f254e2 688
8a58bdcf
KW
689 /* ASCII casing. These could also be written as
690 #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
691 #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
692 which uses table lookup and mask instead of subtraction. (This would
693 work because the _MOD does not apply in the ASCII range) */
9d116dd7 694# define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c))
7d79683e 695# define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c))
9d116dd7 696#endif
bbce6d69 697
1a0901db
KW
698
699/* Use table lookup for speed; return error character for input
700 * out-of-range */
701#define toLOWER_LATIN1(c) (FITS_IN_8_BITS(c) \
702 ? UNI_TO_NATIVE(PL_latin1_lc[ \
703 NATIVE_TO_UNI( (U8) (c)) ]) \
704 : UNICODE_REPLACEMENT)
705/* Modified uc. Is correct uc except for three non-ascii chars which are
706 * all mapped to one of them, and these need special handling; error
707 * character for input out-of-range */
708#define toUPPER_LATIN1_MOD(c) (FITS_IN_8_BITS(c) \
709 ? UNI_TO_NATIVE(PL_mod_latin1_uc[ \
710 NATIVE_TO_UNI( (U8) (c)) ]) \
711 : UNICODE_REPLACEMENT)
712
bbce6d69
PP
713#ifdef USE_NEXT_CTYPE
714
715# define isALNUM_LC(c) \
37bd1396 716 (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
ff68c719
PP
717# define isIDFIRST_LC(c) \
718 (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
719# define isALPHA_LC(c) NXIsAlpha((unsigned int)(c))
720# define isSPACE_LC(c) NXIsSpace((unsigned int)(c))
721# define isDIGIT_LC(c) NXIsDigit((unsigned int)(c))
722# define isUPPER_LC(c) NXIsUpper((unsigned int)(c))
723# define isLOWER_LC(c) NXIsLower((unsigned int)(c))
37bd1396 724# define isALNUMC_LC(c) NXIsAlNum((unsigned int)(c))
b8c5462f
JH
725# define isCNTRL_LC(c) NXIsCntrl((unsigned int)(c))
726# define isGRAPH_LC(c) NXIsGraph((unsigned int)(c))
ff68c719 727# define isPRINT_LC(c) NXIsPrint((unsigned int)(c))
b8c5462f 728# define isPUNCT_LC(c) NXIsPunct((unsigned int)(c))
ff68c719
PP
729# define toUPPER_LC(c) NXToUpper((unsigned int)(c))
730# define toLOWER_LC(c) NXToLower((unsigned int)(c))
bbce6d69
PP
731
732#else /* !USE_NEXT_CTYPE */
b8c5462f 733
bbce6d69
PP
734# if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
735
b8c5462f 736# define isALNUM_LC(c) (isalnum((unsigned char)(c)) || (char)(c) == '_')
ff68c719 737# define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
bbce6d69
PP
738# define isALPHA_LC(c) isalpha((unsigned char)(c))
739# define isSPACE_LC(c) isspace((unsigned char)(c))
740# define isDIGIT_LC(c) isdigit((unsigned char)(c))
741# define isUPPER_LC(c) isupper((unsigned char)(c))
742# define isLOWER_LC(c) islower((unsigned char)(c))
b8c5462f
JH
743# define isALNUMC_LC(c) isalnum((unsigned char)(c))
744# define isCNTRL_LC(c) iscntrl((unsigned char)(c))
745# define isGRAPH_LC(c) isgraph((unsigned char)(c))
bbce6d69 746# define isPRINT_LC(c) isprint((unsigned char)(c))
b8c5462f 747# define isPUNCT_LC(c) ispunct((unsigned char)(c))
bbce6d69
PP
748# define toUPPER_LC(c) toupper((unsigned char)(c))
749# define toLOWER_LC(c) tolower((unsigned char)(c))
750
751# else
752
3609ea0d 753# define isALNUM_LC(c) (isascii(c) && (isalnum(c) || (c) == '_'))
bbce6d69
PP
754# define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
755# define isALPHA_LC(c) (isascii(c) && isalpha(c))
756# define isSPACE_LC(c) (isascii(c) && isspace(c))
757# define isDIGIT_LC(c) (isascii(c) && isdigit(c))
758# define isUPPER_LC(c) (isascii(c) && isupper(c))
759# define isLOWER_LC(c) (isascii(c) && islower(c))
b8c5462f
JH
760# define isALNUMC_LC(c) (isascii(c) && isalnum(c))
761# define isCNTRL_LC(c) (isascii(c) && iscntrl(c))
762# define isGRAPH_LC(c) (isascii(c) && isgraph(c))
bbce6d69 763# define isPRINT_LC(c) (isascii(c) && isprint(c))
b8c5462f 764# define isPUNCT_LC(c) (isascii(c) && ispunct(c))
bbce6d69
PP
765# define toUPPER_LC(c) toupper(c)
766# define toLOWER_LC(c) tolower(c)
767
768# endif
a0d0e21e 769#endif /* USE_NEXT_CTYPE */
55204971 770
aaa51d5e
JF
771#define isPSXSPC_LC(c) (isSPACE_LC(c) || (c) == '\v')
772#define isBLANK_LC(c) isBLANK(c) /* could be wrong */
773
a0ed51b3
LW
774#define isALNUM_uni(c) is_uni_alnum(c)
775#define isIDFIRST_uni(c) is_uni_idfirst(c)
776#define isALPHA_uni(c) is_uni_alpha(c)
777#define isSPACE_uni(c) is_uni_space(c)
778#define isDIGIT_uni(c) is_uni_digit(c)
779#define isUPPER_uni(c) is_uni_upper(c)
780#define isLOWER_uni(c) is_uni_lower(c)
b8c5462f
JH
781#define isASCII_uni(c) is_uni_ascii(c)
782#define isCNTRL_uni(c) is_uni_cntrl(c)
783#define isGRAPH_uni(c) is_uni_graph(c)
a0ed51b3 784#define isPRINT_uni(c) is_uni_print(c)
b8c5462f
JH
785#define isPUNCT_uni(c) is_uni_punct(c)
786#define isXDIGIT_uni(c) is_uni_xdigit(c)
a2a2844f
JH
787#define toUPPER_uni(c,s,l) to_uni_upper(c,s,l)
788#define toTITLE_uni(c,s,l) to_uni_title(c,s,l)
789#define toLOWER_uni(c,s,l) to_uni_lower(c,s,l)
b8d68ded 790#define toFOLD_uni(c,s,l) to_uni_fold(c,s,l)
a0ed51b3 791
aaa51d5e
JF
792#define isPSXSPC_uni(c) (isSPACE_uni(c) ||(c) == '\f')
793#define isBLANK_uni(c) isBLANK(c) /* could be wrong */
794
9041c2e3
NIS
795#define isALNUM_LC_uvchr(c) (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
796#define isIDFIRST_LC_uvchr(c) (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
797#define isALPHA_LC_uvchr(c) (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
798#define isSPACE_LC_uvchr(c) (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
799#define isDIGIT_LC_uvchr(c) (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
800#define isUPPER_LC_uvchr(c) (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
801#define isLOWER_LC_uvchr(c) (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
9041c2e3
NIS
802#define isCNTRL_LC_uvchr(c) (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
803#define isGRAPH_LC_uvchr(c) (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
804#define isPRINT_LC_uvchr(c) (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
805#define isPUNCT_LC_uvchr(c) (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
a0ed51b3 806
aaa51d5e
JF
807#define isPSXSPC_LC_uni(c) (isSPACE_LC_uni(c) ||(c) == '\f')
808#define isBLANK_LC_uni(c) isBLANK(c) /* could be wrong */
809
a0ed51b3 810#define isALNUM_utf8(p) is_utf8_alnum(p)
82686b01
JH
811/* The ID_Start of Unicode is quite limiting: it assumes a L-class
812 * character (meaning that you cannot have, say, a CJK character).
813 * Instead, let's allow ID_Continue but not digits. */
814#define isIDFIRST_utf8(p) (is_utf8_idcont(p) && !is_utf8_digit(p))
a0ed51b3
LW
815#define isALPHA_utf8(p) is_utf8_alpha(p)
816#define isSPACE_utf8(p) is_utf8_space(p)
817#define isDIGIT_utf8(p) is_utf8_digit(p)
818#define isUPPER_utf8(p) is_utf8_upper(p)
819#define isLOWER_utf8(p) is_utf8_lower(p)
b8c5462f
JH
820#define isASCII_utf8(p) is_utf8_ascii(p)
821#define isCNTRL_utf8(p) is_utf8_cntrl(p)
822#define isGRAPH_utf8(p) is_utf8_graph(p)
a0ed51b3 823#define isPRINT_utf8(p) is_utf8_print(p)
b8c5462f
JH
824#define isPUNCT_utf8(p) is_utf8_punct(p)
825#define isXDIGIT_utf8(p) is_utf8_xdigit(p)
a2a2844f
JH
826#define toUPPER_utf8(p,s,l) to_utf8_upper(p,s,l)
827#define toTITLE_utf8(p,s,l) to_utf8_title(p,s,l)
828#define toLOWER_utf8(p,s,l) to_utf8_lower(p,s,l)
a0ed51b3 829
aaa51d5e
JF
830#define isPSXSPC_utf8(c) (isSPACE_utf8(c) ||(c) == '\f')
831#define isBLANK_utf8(c) isBLANK(c) /* could be wrong */
832
9041c2e3
NIS
833#define isALNUM_LC_utf8(p) isALNUM_LC_uvchr(utf8_to_uvchr(p, 0))
834#define isIDFIRST_LC_utf8(p) isIDFIRST_LC_uvchr(utf8_to_uvchr(p, 0))
835#define isALPHA_LC_utf8(p) isALPHA_LC_uvchr(utf8_to_uvchr(p, 0))
836#define isSPACE_LC_utf8(p) isSPACE_LC_uvchr(utf8_to_uvchr(p, 0))
837#define isDIGIT_LC_utf8(p) isDIGIT_LC_uvchr(utf8_to_uvchr(p, 0))
838#define isUPPER_LC_utf8(p) isUPPER_LC_uvchr(utf8_to_uvchr(p, 0))
839#define isLOWER_LC_utf8(p) isLOWER_LC_uvchr(utf8_to_uvchr(p, 0))
840#define isALNUMC_LC_utf8(p) isALNUMC_LC_uvchr(utf8_to_uvchr(p, 0))
841#define isCNTRL_LC_utf8(p) isCNTRL_LC_uvchr(utf8_to_uvchr(p, 0))
842#define isGRAPH_LC_utf8(p) isGRAPH_LC_uvchr(utf8_to_uvchr(p, 0))
843#define isPRINT_LC_utf8(p) isPRINT_LC_uvchr(utf8_to_uvchr(p, 0))
844#define isPUNCT_LC_utf8(p) isPUNCT_LC_uvchr(utf8_to_uvchr(p, 0))
a0ed51b3 845
aaa51d5e
JF
846#define isPSXSPC_LC_utf8(c) (isSPACE_LC_utf8(c) ||(c) == '\f')
847#define isBLANK_LC_utf8(c) isBLANK(c) /* could be wrong */
848
6ae9f32a
KW
849/* This conversion works both ways, strangely enough. On EBCDIC platforms,
850 * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII */
851# define toCTRL(c) (toUPPER(NATIVE_TO_UNI(c)) ^ 64)
bbce6d69 852
dea28490
JJ
853/* Line numbers are unsigned, 32 bits. */
854typedef U32 line_t;
dea28490 855#define NOLINE ((line_t) 4294967295UL)
378cc40b 856
91152fc1
DG
857/* Helpful alias for version prescan */
858#define is_LAX_VERSION(a,b) \
859 (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
860
861#define is_STRICT_VERSION(a,b) \
862 (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
863
864#define BADVERSION(a,b,c) \
865 if (b) { \
866 *b = c; \
867 } \
868 return a;
8c52afec 869
8e84507e 870/*
ccfc67b7
JH
871=head1 Memory Management
872
a02a5408 873=for apidoc Am|void|Newx|void* ptr|int nitems|type
954c1994
GS
874The XSUB-writer's interface to the C C<malloc> function.
875
c5008215
JC
876In 5.9.3, Newx() and friends replace the older New() API, and drops
877the first parameter, I<x>, a debug aid which allowed callers to identify
37b8b4c9 878themselves. This aid has been superseded by a new build option,
c5008215
JC
879PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
880there for use in XS modules supporting older perls.
881
a02a5408 882=for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
954c1994 883The XSUB-writer's interface to the C C<malloc> function, with
c5008215 884cast. See also C<Newx>.
954c1994 885
a02a5408 886=for apidoc Am|void|Newxz|void* ptr|int nitems|type
954c1994 887The XSUB-writer's interface to the C C<malloc> function. The allocated
c5008215 888memory is zeroed with C<memzero>. See also C<Newx>.
a02a5408 889
954c1994
GS
890=for apidoc Am|void|Renew|void* ptr|int nitems|type
891The XSUB-writer's interface to the C C<realloc> function.
892
893=for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
894The XSUB-writer's interface to the C C<realloc> function, with
895cast.
896
49b8b560 897=for apidoc Am|void|Safefree|void* ptr
954c1994
GS
898The XSUB-writer's interface to the C C<free> function.
899
900=for apidoc Am|void|Move|void* src|void* dest|int nitems|type
901The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
902source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
903the type. Can do overlapping moves. See also C<Copy>.
904
e90e2364
NC
905=for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
906Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
907optimise.
908
954c1994
GS
909=for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
910The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
911source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
912the type. May fail on overlapping copies. See also C<Move>.
913
e90e2364
NC
914=for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
915
916Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
917optimise.
918
954c1994
GS
919=for apidoc Am|void|Zero|void* dest|int nitems|type
920
921The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
922destination, C<nitems> is the number of items, and C<type> is the type.
923
e90e2364
NC
924=for apidoc Am|void *|ZeroD|void* dest|int nitems|type
925
926Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
927optimise.
928
954c1994 929=for apidoc Am|void|StructCopy|type src|type dest|type
4375e838 930This is an architecture-independent macro to copy one structure to another.
954c1994 931
7e337ee0
JH
932=for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
933
934Fill up memory with a byte pattern (a byte repeated over and over
935again) that hopefully catches attempts to access uninitialized memory.
936
937=for apidoc Am|void|PoisonNew|void* dest|int nitems|type
938
939PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
940
1c12ffb4 941=for apidoc Am|void|PoisonFree|void* dest|int nitems|type
7e337ee0
JH
942
943PoisonWith(0xEF) for catching access to freed memory.
944
9965345d
JH
945=for apidoc Am|void|Poison|void* dest|int nitems|type
946
7e337ee0 947PoisonWith(0xEF) for catching access to freed memory.
9965345d
JH
948
949=cut */
954c1994 950
561b68a9
SH
951/* Maintained for backwards-compatibility only. Use newSV() instead. */
952#ifndef PERL_CORE
ff06c60c 953#define NEWSV(x,len) newSV(len)
561b68a9 954#endif
ff06c60c 955
19a94d75
JH
956#define MEM_SIZE_MAX ((MEM_SIZE)~0)
957
2720f793
JH
958/* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
959 * overly eager compilers that will bleat about e.g.
960 * (U16)n > (size_t)~0/sizeof(U16) always being false. */
27d5b266 961#ifdef PERL_MALLOC_WRAP
fabdb6c0 962#define MEM_WRAP_CHECK(n,t) MEM_WRAP_CHECK_1(n,t,PL_memory_wrap)
27d5b266 963#define MEM_WRAP_CHECK_1(n,t,a) \
f1f66076 964 (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
8b44ba4c 965#define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
27d5b266 966
f1f66076 967#define PERL_STRLEN_ROUNDUP(n) ((void)(((n) > MEM_SIZE_MAX - 2 * PERL_STRLEN_ROUNDUP_QUANTUM) ? (Perl_croak_nocontext("%s",PL_memory_wrap),0):0),((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
1936d2a7 968
27d5b266
JH
969#else
970
410319be
NC
971#define MEM_WRAP_CHECK(n,t)
972#define MEM_WRAP_CHECK_1(n,t,a)
973#define MEM_WRAP_CHECK_2(n,t,a,b)
8b44ba4c
NC
974#define MEM_WRAP_CHECK_(n,t)
975
6fff79ce 976#define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
27d5b266 977
1936d2a7 978#endif
8b44ba4c 979
fe4f188c 980#ifdef PERL_MEM_LOG
46c6c7e2 981/*
9f653bb5 982 * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
46c6c7e2
JH
983 * go through functions, which are handy for debugging breakpoints, but
984 * which more importantly get the immediate calling environment (file and
e352bcff
JH
985 * line number, and C function name if available) passed in. This info can
986 * then be used for logging the calls, for which one gets a sample
73d1d973 987 * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
3609ea0d 988 *
46c6c7e2 989 * Known problems:
94e892a6 990 * - not all memory allocs get logged, only those
46c6c7e2 991 * that go through Newx() and derivatives (while all
94e892a6 992 * Safefrees do get logged)
46c6c7e2
JH
993 * - __FILE__ and __LINE__ do not work everywhere
994 * - __func__ or __FUNCTION__ even less so
995 * - I think more goes on after the perlio frees but
996 * the thing is that STDERR gets closed (as do all
997 * the file descriptors)
998 * - no deeper calling stack than the caller of the Newx()
999 * or the kind, but do I look like a C reflection/introspection
1000 * utility to you?
1001 * - the function prototypes for the logging functions
1002 * probably should maybe be somewhere else than handy.h
1003 * - one could consider inlining (macrofying) the logging
1004 * for speed, but I am too lazy
1005 * - one could imagine recording the allocations in a hash,
1006 * (keyed by the allocation address?), and maintain that
1007 * through reallocs and frees, but how to do that without
1008 * any News() happening...?
73d1d973 1009 * - lots of -Ddefines to get useful/controllable output
b953482e 1010 * - lots of ENV reads
46c6c7e2
JH
1011 */
1012
12754f92 1013PERL_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);
46c6c7e2 1014
12754f92 1015PERL_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);
46c6c7e2 1016
12754f92 1017PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
46c6c7e2 1018
0b0ab801 1019# ifdef PERL_CORE
73d1d973 1020# ifndef PERL_MEM_LOG_NOIMPL
0b0ab801
MHM
1021enum mem_log_type {
1022 MLT_ALLOC,
1023 MLT_REALLOC,
d7a2c63c
MHM
1024 MLT_FREE,
1025 MLT_NEW_SV,
1026 MLT_DEL_SV
0b0ab801
MHM
1027};
1028# endif
12754f92 1029# if defined(PERL_IN_SV_C) /* those are only used in sv.c */
d7a2c63c
MHM
1030void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1031void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
12754f92 1032# endif
0b0ab801
MHM
1033# endif
1034
fe4f188c
JH
1035#endif
1036
1037#ifdef PERL_MEM_LOG
d1401ee9
MHM
1038#define MEM_LOG_ALLOC(n,t,a) Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
1039#define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
46c6c7e2 1040#define MEM_LOG_FREE(a) Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
fe4f188c
JH
1041#endif
1042
1043#ifndef MEM_LOG_ALLOC
1044#define MEM_LOG_ALLOC(n,t,a) (a)
1045#endif
1046#ifndef MEM_LOG_REALLOC
1047#define MEM_LOG_REALLOC(n,t,v,a) (a)
1048#endif
1049#ifndef MEM_LOG_FREE
1050#define MEM_LOG_FREE(a) (a)
1051#endif
1052
d1401ee9
MHM
1053#define Newx(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1054#define Newxc(v,n,t,c) (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1055#define Newxz(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
a6f6820f
NC
1056
1057#ifndef PERL_CORE
a02a5408
JC
1058/* pre 5.9.x compatibility */
1059#define New(x,v,n,t) Newx(v,n,t)
1060#define Newc(x,v,n,t,c) Newxc(v,n,t,c)
4541904d 1061#define Newz(x,v,n,t) Newxz(v,n,t)
a6f6820f 1062#endif
a02a5408 1063
ff68c719 1064#define Renew(v,n,t) \
d1401ee9 1065 (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
ff68c719 1066#define Renewc(v,n,t,c) \
d1401ee9 1067 (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
94010e71
NC
1068
1069#ifdef PERL_POISON
1070#define Safefree(d) \
06c0cc96 1071 ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
94010e71 1072#else
fe4f188c 1073#define Safefree(d) safefree(MEM_LOG_FREE((Malloc_t)(d)))
94010e71 1074#endif
55497cff 1075
8b44ba4c
NC
1076#define Move(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1077#define Copy(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1078#define Zero(d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
55497cff 1079
8b44ba4c
NC
1080#define MoveD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1081#define CopyD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
e90e2364 1082#ifdef HAS_MEMSET
8b44ba4c 1083#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
e90e2364 1084#else
8b44ba4c
NC
1085/* Using bzero(), which returns void. */
1086#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
e90e2364
NC
1087#endif
1088
7e337ee0
JH
1089#define PoisonWith(d,n,t,b) (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
1090#define PoisonNew(d,n,t) PoisonWith(d,n,t,0xAB)
1091#define PoisonFree(d,n,t) PoisonWith(d,n,t,0xEF)
1092#define Poison(d,n,t) PoisonFree(d,n,t)
27d5b266 1093
2304df62 1094#ifdef USE_STRUCT_COPY
ff68c719 1095#define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
bee1dbe2
LW
1096#else
1097#define StructCopy(s,d,t) Copy(s,d,1,t)
1098#endif
2cc61e15 1099
622913ab 1100#define C_ARRAY_LENGTH(a) (sizeof(a)/sizeof((a)[0]))
cd431fde 1101#define C_ARRAY_END(a) (a) + (sizeof(a)/sizeof((a)[0]))
622913ab 1102
2cc61e15
DD
1103#ifdef NEED_VA_COPY
1104# ifdef va_copy
1105# define Perl_va_copy(s, d) va_copy(d, s)
2cc61e15 1106# else
a1866d1b
JH
1107# if defined(__va_copy)
1108# define Perl_va_copy(s, d) __va_copy(d, s)
1109# else
1110# define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
1111# endif
2cc61e15
DD
1112# endif
1113#endif
1114
472d47bc
SB
1115/* convenience debug macros */
1116#ifdef USE_ITHREADS
1117#define pTHX_FORMAT "Perl interpreter: 0x%p"
1118#define pTHX__FORMAT ", Perl interpreter: 0x%p"
f54cb97a
AL
1119#define pTHX_VALUE_ (void *)my_perl,
1120#define pTHX_VALUE (void *)my_perl
1121#define pTHX__VALUE_ ,(void *)my_perl,
1122#define pTHX__VALUE ,(void *)my_perl
472d47bc 1123#else
3609ea0d 1124#define pTHX_FORMAT
472d47bc 1125#define pTHX__FORMAT
3609ea0d 1126#define pTHX_VALUE_
472d47bc 1127#define pTHX_VALUE
3609ea0d 1128#define pTHX__VALUE_
472d47bc
SB
1129#define pTHX__VALUE
1130#endif /* USE_ITHREADS */
3609ea0d 1131
2acdbac1
NC
1132/* Perl_deprecate was not part of the public API, and did not have a deprecate()
1133 shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
1134 CPAN::Unpack show any users outside the core. */
1135#ifdef PERL_CORE
d1d15184 1136# define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
2acdbac1
NC
1137#endif
1138
e9a8c099
MHM
1139/*
1140 * Local variables:
1141 * c-indentation-style: bsd
1142 * c-basic-offset: 4
1143 * indent-tabs-mode: t
1144 * End:
1145 *
1146 * ex: set ts=8 sts=4 sw=4 noet:
1147 */