This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
XS-APItest: Add tests for handy.h
[perl5.git] / handy.h
CommitLineData
a0d0e21e 1/* handy.h
a687059c 2 *
1129b882 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000,
da5d8dbb 4 * 2001, 2002, 2004, 2005, 2006, 2007, 2008, 2012 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 15# define NULL 0
85e6fe83
LW
16#endif
17
24792b8d
NC
18#ifndef PERL_CORE
19# define Null(type) ((type)NULL)
954c1994
GS
20
21/*
ccfc67b7 22=head1 Handy Values
954c1994 23
3609ea0d 24=for apidoc AmU||Nullch
24792b8d 25Null character pointer. (No longer available when C<PERL_CORE> is defined.)
2307c6d0 26
954c1994 27=for apidoc AmU||Nullsv
24792b8d 28Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
954c1994
GS
29
30=cut
31*/
32
24792b8d
NC
33# define Nullch Null(char*)
34# define Nullfp Null(PerlIO*)
35# define Nullsv Null(SV*)
36#endif
8d063cd8 37
641d3f0b
PP
38#ifdef TRUE
39#undef TRUE
40#endif
41#ifdef FALSE
42#undef FALSE
43#endif
44#define TRUE (1)
45#define FALSE (0)
46
cf3f0ffb
DM
47/* The MUTABLE_*() macros cast pointers to the types shown, in such a way
48 * (compiler permitting) that casting away const-ness will give a warning;
49 * e.g.:
50 *
51 * const SV *sv = ...;
52 * AV *av1 = (AV*)sv; <== BAD: the const has been silently cast away
53 * AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
54 */
55
b1bc3f34 56#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
f065df04 57# define MUTABLE_PTR(p) ({ void *_p = (p); _p; })
b1bc3f34
NC
58#else
59# define MUTABLE_PTR(p) ((void *) (p))
60#endif
61
a062e10d 62#define MUTABLE_AV(p) ((AV *)MUTABLE_PTR(p))
ea726b52 63#define MUTABLE_CV(p) ((CV *)MUTABLE_PTR(p))
159b6efe 64#define MUTABLE_GV(p) ((GV *)MUTABLE_PTR(p))
dbebbdb4 65#define MUTABLE_HV(p) ((HV *)MUTABLE_PTR(p))
a45c7426 66#define MUTABLE_IO(p) ((IO *)MUTABLE_PTR(p))
b1bc3f34 67#define MUTABLE_SV(p) ((SV *)MUTABLE_PTR(p))
27d4fb96 68
bd31be4b
NC
69#ifdef I_STDBOOL
70# include <stdbool.h>
71# ifndef HAS_BOOL
72# define HAS_BOOL 1
73# endif
74#endif
75
8e84507e 76/* bool is built-in for g++-2.6.3 and later, which might be used
c1d22f6b
GS
77 for extensions. <_G_config.h> defines _G_HAVE_BOOL, but we can't
78 be sure _G_config.h will be included before this file. _G_config.h
8e84507e 79 also defines _G_HAVE_BOOL for both gcc and g++, but only g++
c1d22f6b
GS
80 actually has bool. Hence, _G_HAVE_BOOL is pretty useless for us.
81 g++ can be identified by __GNUG__.
82 Andy Dougherty February 2000
5d94fbed 83*/
3609ea0d 84#ifdef __GNUG__ /* GNU g++ has bool built-in */
5d94fbed 85# ifndef HAS_BOOL
c1d22f6b 86# define HAS_BOOL 1
5d94fbed 87# endif
5d94fbed
AD
88#endif
89
641d3f0b
PP
90/* The NeXT dynamic loader headers will not build with the bool macro
91 So declare them now to clear confusion.
92*/
8f1f23e8 93#if defined(NeXT) || defined(__NeXT__)
641d3f0b
PP
94# undef FALSE
95# undef TRUE
96 typedef enum bool { FALSE = 0, TRUE = 1 } bool;
97# define ENUM_BOOL 1
98# ifndef HAS_BOOL
99# define HAS_BOOL 1
100# endif /* !HAS_BOOL */
8f1f23e8 101#endif /* NeXT || __NeXT__ */
641d3f0b 102
5d94fbed 103#ifndef HAS_BOOL
cc3315ba 104# if defined(VMS)
5d94fbed
AD
105# define bool int
106# else
107# define bool char
108# endif
c1d22f6b 109# define HAS_BOOL 1
a687059c 110#endif
0d3e774c 111
f2338a2e
DM
112/* a simple (bool) cast may not do the right thing: if bool is defined
113 * as char for example, then the cast from int is implementation-defined
18f5643b 114 * (bool)!!(cbool) in a ternary triggers a bug in xlc on AIX
f2338a2e
DM
115 */
116
18f5643b 117#define cBOOL(cbool) ((cbool) ? (bool)1 : (bool)0)
f2338a2e 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
70764c00 126# if (defined(_MSC_VER) && _MSC_VER < 1300) || /* MSVC6 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 189#if defined(HAS_QUAD) && defined(USE_64_BIT_INT)
80524f33
JL
190# if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
191# define PeRl_INT64_C(c) CAT2(c,LL)
192# define PeRl_UINT64_C(c) CAT2(c,ULL)
193# else
52865553
SH
194# if QUADKIND == QUAD_IS___INT64
195# define PeRl_INT64_C(c) CAT2(c,I64)
196# define PeRl_UINT64_C(c) CAT2(c,UI64)
69512466 197# else
52865553
SH
198# if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
199# define PeRl_INT64_C(c) CAT2(c,L)
200# define PeRl_UINT64_C(c) CAT2(c,UL)
69512466 201# else
80524f33
JL
202# define PeRl_INT64_C(c) ((I64TYPE)(c))
203# define PeRl_UINT64_C(c) ((U64TYPE)(c))
69512466
JH
204# endif
205# endif
e8c95190 206# endif
80524f33
JL
207# ifndef UINT64_C
208# define UINT64_C(c) PeRl_UINT64_C(c)
209# endif
210# ifndef INT64_C
211# define INT64_C(c) PeRl_INT64_C(c)
212# endif
e8c95190 213#endif
dc750f2e 214
d8668976 215#if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
5ff3f7a4 216
5ff3f7a4
GS
217/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
218 Please search CHAR_MAX in perl.h for further details. */
219#define U8_MAX UINT8_MAX
220#define U8_MIN UINT8_MIN
221
5ff3f7a4
GS
222#define I16_MAX INT16_MAX
223#define I16_MIN INT16_MIN
224#define U16_MAX UINT16_MAX
225#define U16_MIN UINT16_MIN
226
5ff3f7a4
GS
227#define I32_MAX INT32_MAX
228#define I32_MIN INT32_MIN
0e983133
GS
229#ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
230# define U32_MAX UINT32_MAX
231#else
232# define U32_MAX 4294967295U
233#endif
5ff3f7a4
GS
234#define U32_MIN UINT32_MIN
235
236#else
237
5c9fa16e
KA
238/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
239 Please search CHAR_MAX in perl.h for further details. */
27d4fb96
PP
240#define U8_MAX PERL_UCHAR_MAX
241#define U8_MIN PERL_UCHAR_MIN
79072805 242
27d4fb96
PP
243#define I16_MAX PERL_SHORT_MAX
244#define I16_MIN PERL_SHORT_MIN
245#define U16_MAX PERL_USHORT_MAX
246#define U16_MIN PERL_USHORT_MIN
79072805 247
c4f23d77 248#if LONGSIZE > 4
27d4fb96
PP
249# define I32_MAX PERL_INT_MAX
250# define I32_MIN PERL_INT_MIN
251# define U32_MAX PERL_UINT_MAX
252# define U32_MIN PERL_UINT_MIN
79072805 253#else
27d4fb96
PP
254# define I32_MAX PERL_LONG_MAX
255# define I32_MIN PERL_LONG_MIN
256# define U32_MAX PERL_ULONG_MAX
257# define U32_MIN PERL_ULONG_MIN
79072805
LW
258#endif
259
5ff3f7a4
GS
260#endif
261
58a9a5d5 262/* log(2) is pretty close to 0.30103, just in case anyone is grepping for it */
fc36a67e
PP
263#define BIT_DIGITS(N) (((N)*146)/485 + 1) /* log2(10) =~ 146/485 */
264#define TYPE_DIGITS(T) BIT_DIGITS(sizeof(T) * 8)
265#define TYPE_CHARS(T) (TYPE_DIGITS(T) + 2) /* sign, NUL */
266
ff68c719 267#define Ctl(ch) ((ch) & 037)
8d063cd8 268
3fe05580
MHM
269/*
270=head1 SV-Body Allocation
271
272=for apidoc Ama|SV*|newSVpvs|const char* s
273Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
274
84bafc02
NC
275=for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags
276Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
277pair.
278
3fe05580
MHM
279=for apidoc Ama|SV*|newSVpvs_share|const char* s
280Like C<newSVpvn_share>, but takes a literal string instead of a string/length
281pair and omits the hash parameter.
282
9dcc53ea
Z
283=for apidoc Am|void|sv_catpvs_flags|SV* sv|const char* s|I32 flags
284Like C<sv_catpvn_flags>, but takes a literal string instead of a
285string/length pair.
286
287=for apidoc Am|void|sv_catpvs_nomg|SV* sv|const char* s
288Like C<sv_catpvn_nomg>, but takes a literal string instead of a
289string/length pair.
290
7b4e7469 291=for apidoc Am|void|sv_catpvs|SV* sv|const char* s
3fe05580
MHM
292Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
293
9dcc53ea
Z
294=for apidoc Am|void|sv_catpvs_mg|SV* sv|const char* s
295Like C<sv_catpvn_mg>, but takes a literal string instead of a
296string/length pair.
297
7b4e7469 298=for apidoc Am|void|sv_setpvs|SV* sv|const char* s
3fe05580
MHM
299Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
300
9dcc53ea
Z
301=for apidoc Am|void|sv_setpvs_mg|SV* sv|const char* s
302Like C<sv_setpvn_mg>, but takes a literal string instead of a
303string/length pair.
304
305=for apidoc Am|SV *|sv_setref_pvs|const char* s
306Like C<sv_setref_pvn>, but takes a literal string instead of a
307string/length pair.
308
3fe05580
MHM
309=head1 Memory Management
310
311=for apidoc Ama|char*|savepvs|const char* s
312Like C<savepvn>, but takes a literal string instead of a string/length pair.
313
9dcc53ea
Z
314=for apidoc Ama|char*|savesharedpvs|const char* s
315A version of C<savepvs()> which allocates the duplicate string in memory
316which is shared between threads.
317
3fe05580
MHM
318=head1 GV Functions
319
320=for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create
321Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
322
323=head1 Hash Manipulation Functions
324
325=for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval
326Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
327
328=for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val
329Like C<hv_store>, but takes a literal string instead of a string/length pair
330and omits the hash parameter.
331
510966aa
Z
332=head1 Lexer interface
333
334=for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags
335
336Like L</lex_stuff_pvn>, but takes a literal string instead of a
337string/length pair.
338
3fe05580
MHM
339=cut
340*/
341
65177ae0 342/* concatenating with "" ensures that only literal strings are accepted as argument */
26bfd924 343#define STR_WITH_LEN(s) ("" s ""), (sizeof(s)-1)
2efa8cc7 344
ba3a79e7
GA
345/* note that STR_WITH_LEN() can't be used as argument to macros or functions that
346 * under some configurations might be macros, which means that it requires the full
347 * Perl_xxx(aTHX_ ...) form for any API calls where it's used.
348 */
349
350/* STR_WITH_LEN() shortcuts */
351#define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str))
84bafc02
NC
352#define newSVpvs_flags(str,flags) \
353 Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags)
ba3a79e7 354#define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0)
9dcc53ea
Z
355#define sv_catpvs_flags(sv, str, flags) \
356 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), flags)
357#define sv_catpvs_nomg(sv, str) \
358 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), 0)
359#define sv_catpvs(sv, str) \
360 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC)
361#define sv_catpvs_mg(sv, str) \
362 Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC|SV_SMAGIC)
3fe05580 363#define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str))
9dcc53ea
Z
364#define sv_setpvs_mg(sv, str) Perl_sv_setpvn_mg(aTHX_ sv, STR_WITH_LEN(str))
365#define sv_setref_pvs(rv, classname, str) \
366 Perl_sv_setref_pvn(aTHX_ rv, classname, STR_WITH_LEN(str))
ba3a79e7 367#define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str))
9dcc53ea
Z
368#define savesharedpvs(str) Perl_savesharedpvn(aTHX_ STR_WITH_LEN(str))
369#define gv_stashpvs(str, create) \
370 Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create)
371#define gv_fetchpvs(namebeg, add, sv_type) \
372 Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type)
373#define gv_fetchpvn(namebeg, len, add, sv_type) \
374 Perl_gv_fetchpvn_flags(aTHX_ namebeg, len, add, sv_type)
375#define sv_catxmlpvs(dsv, str, utf8) \
376 Perl_sv_catxmlpvn(aTHX_ dsv, STR_WITH_LEN(str), utf8)
a038e571
NC
377#define hv_fetchs(hv,key,lval) \
378 ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \
379 (lval) ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \
380 : HV_FETCH_JUST_SV, NULL, 0))
381
382#define hv_stores(hv,key,val) \
383 ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \
384 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), 0))
ba3a79e7 385
510966aa
Z
386#define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
387
b96d8cd9
NC
388#define get_cvs(str, flags) \
389 Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
5c1737d1 390
954c1994 391/*
ccfc67b7
JH
392=head1 Miscellaneous Functions
393
954c1994
GS
394=for apidoc Am|bool|strNE|char* s1|char* s2
395Test two strings to see if they are different. Returns true or
396false.
397
398=for apidoc Am|bool|strEQ|char* s1|char* s2
399Test two strings to see if they are equal. Returns true or false.
400
401=for apidoc Am|bool|strLT|char* s1|char* s2
402Test two strings to see if the first, C<s1>, is less than the second,
403C<s2>. Returns true or false.
404
405=for apidoc Am|bool|strLE|char* s1|char* s2
406Test two strings to see if the first, C<s1>, is less than or equal to the
407second, C<s2>. Returns true or false.
408
409=for apidoc Am|bool|strGT|char* s1|char* s2
410Test two strings to see if the first, C<s1>, is greater than the second,
411C<s2>. Returns true or false.
412
413=for apidoc Am|bool|strGE|char* s1|char* s2
414Test two strings to see if the first, C<s1>, is greater than or equal to
415the second, C<s2>. Returns true or false.
416
417=for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
418Test two strings to see if they are different. The C<len> parameter
419indicates the number of bytes to compare. Returns true or false. (A
420wrapper for C<strncmp>).
421
422=for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
423Test two strings to see if they are equal. The C<len> parameter indicates
424the number of bytes to compare. Returns true or false. (A wrapper for
425C<strncmp>).
426
427=cut
428*/
429
8d063cd8
LW
430#define strNE(s1,s2) (strcmp(s1,s2))
431#define strEQ(s1,s2) (!strcmp(s1,s2))
432#define strLT(s1,s2) (strcmp(s1,s2) < 0)
433#define strLE(s1,s2) (strcmp(s1,s2) <= 0)
434#define strGT(s1,s2) (strcmp(s1,s2) > 0)
435#define strGE(s1,s2) (strcmp(s1,s2) >= 0)
436#define strnNE(s1,s2,l) (strncmp(s1,s2,l))
437#define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
378cc40b 438
36477c24
PP
439#ifdef HAS_MEMCMP
440# define memNE(s1,s2,l) (memcmp(s1,s2,l))
441# define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
442#else
443# define memNE(s1,s2,l) (bcmp(s1,s2,l))
444# define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
445#endif
446
568a785a 447#define memEQs(s1, l, s2) \
8e6497b6 448 (sizeof(s2)-1 == l && memEQ(s1, ("" s2 ""), (sizeof(s2)-1)))
568a785a
NC
449#define memNEs(s1, l, s2) !memEQs(s1, l, s2)
450
bbce6d69
PP
451/*
452 * Character classes.
453 *
454 * Unfortunately, the introduction of locales means that we
455 * can't trust isupper(), etc. to tell the truth. And when
456 * it comes to /\w+/ with tainting enabled, we *must* be able
457 * to trust our character classes.
458 *
459 * Therefore, the default tests in the text of Perl will be
460 * independent of locale. Any code that wants to depend on
461 * the current locale will use the tests that begin with "lc".
462 */
463
2304df62
AD
464#ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */
465# ifndef CTYPE256
466# define CTYPE256
467# endif
468#endif
469
954c1994 470/*
ccfc67b7
JH
471
472=head1 Character classes
8a58bdcf
KW
473There are three variants for all the functions in this section. The base ones
474operate using the character set of the platform Perl is running on. The ones
475with an C<_A> suffix operate on the ASCII character set, and the ones with an
476C<_L1> suffix operate on the full Latin1 character set. All are unaffected by
181ab5fd 477locale and by C<use bytes>.
8a58bdcf
KW
478
479For ASCII platforms, the base function with no suffix and the one with the
480C<_A> suffix are identical. The function with the C<_L1> suffix imposes the
481Latin-1 character set onto the platform. That is, the code points that are
482ASCII are unaffected, since ASCII is a subset of Latin-1. But the non-ASCII
483code points are treated as if they are Latin-1 characters. For example,
484C<isSPACE_L1()> will return true when called with the code point 0xA0, which is
485the Latin-1 NO-BREAK SPACE.
486
487For EBCDIC platforms, the base function with no suffix and the one with the
488C<_L1> suffix should be identical, since, as of this writing, the EBCDIC code
489pages that Perl knows about all are equivalent to Latin-1. The function that
490ends in an C<_A> suffix will not return true unless the specified character also
491has an ASCII equivalent.
ccfc67b7 492
954c1994 493=for apidoc Am|bool|isALPHA|char ch
2787a470 494Returns a boolean indicating whether the specified character is an
06dc89af 495alphabetic character in the platform's native character set.
8a58bdcf
KW
496See the L<top of this section|/Character classes> for an explanation of variants
497C<isALPHA_A> and C<isALPHA_L1>.
498
499=for apidoc Am|bool|isASCII|char ch
500Returns a boolean indicating whether the specified character is one of the 128
501characters in the ASCII character set. On non-ASCII platforms, it is if this
502character corresponds to an ASCII character. Variants C<isASCII_A()> and
503C<isASCII_L1()> are identical to C<isASCII()>.
954c1994 504
954c1994 505=for apidoc Am|bool|isDIGIT|char ch
2787a470 506Returns a boolean indicating whether the specified character is a
06dc89af 507digit in the platform's native character set.
8a58bdcf 508Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
954c1994 509
0c82b6df 510=for apidoc Am|bool|isLOWER|char ch
2787a470 511Returns a boolean indicating whether the specified character is a
0c82b6df 512lowercase character in the platform's native character set.
8a58bdcf
KW
513See the L<top of this section|/Character classes> for an explanation of variants
514C<isLOWER_A> and C<isLOWER_L1>.
0c82b6df 515
c99e91e9 516=for apidoc Am|bool|isOCTAL|char ch
2787a470 517Returns a boolean indicating whether the specified character is an
06dc89af 518octal digit, [0-7] in the platform's native character set.
8a58bdcf 519Variants C<isOCTAL_A> and C<isOCTAL_L1> are identical to C<isOCTAL>.
c99e91e9 520
0c82b6df 521=for apidoc Am|bool|isSPACE|char ch
2787a470 522Returns a boolean indicating whether the specified character is a
8a58bdcf
KW
523whitespace character in the platform's native character set. This is the same
524as what C<\s> matches in a regular expression.
525See the L<top of this section|/Character classes> for an explanation of variants
526C<isSPACE_A> and C<isSPACE_L1>.
0c82b6df 527
954c1994 528=for apidoc Am|bool|isUPPER|char ch
2787a470 529Returns a boolean indicating whether the specified character is an
06dc89af 530uppercase character in the platform's native character set.
8a58bdcf
KW
531See the L<top of this section|/Character classes> for an explanation of variants
532C<isUPPER_A> and C<isUPPER_L1>.
954c1994 533
8eea39dd
KW
534=for apidoc Am|bool|isWORDCHAR|char ch
535Returns a boolean indicating whether the specified character is a
536character that is any of: alphabetic, numeric, or an underscore. This is the
537same as what C<\w> matches in a regular expression.
538C<isALNUM()> is a synonym provided for backward compatibility. Note that it
539does not have the standard C language meaning of alphanumeric, since it matches
540an underscore and the standard meaning does not.
8a58bdcf
KW
541See the L<top of this section|/Character classes> for an explanation of variants
542C<isWORDCHAR_A> and C<isWORDCHAR_L1>.
543
544=for apidoc Am|bool|isXDIGIT|char ch
545Returns a boolean indicating whether the specified character is a hexadecimal
546digit, [0-9A-Fa-f]. Variants C<isXDIGIT_A()> and C<isXDIGIT_L1()> are
547identical to C<isXDIGIT()>.
8eea39dd 548
95a59cab
YO
549=for apidoc Am|U8|READ_XDIGIT|char str*
550Returns the value of a hex digit and advances the string pointer.
551Behaviour is only well defined when isXDIGIT(*str) is true.
552
e7c1e6c1
KW
553=head1 Character case changing
554
954c1994 555=for apidoc Am|char|toUPPER|char ch
06dc89af
KW
556Converts the specified character to uppercase in the platform's native
557character set, if possible; otherwise returns the input character itself.
954c1994
GS
558
559=for apidoc Am|char|toLOWER|char ch
06dc89af
KW
560Converts the specified character to lowercase in the platform's native
561character set, if possible; otherwise returns the input character itself.
954c1994
GS
562
563=cut
353c9b6f 564
8a58bdcf 565Note that these macros are repeated in Devel::PPPort, so should also be
62fa66b6
KW
566patched there. The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
567
954c1994
GS
568*/
569
7c062697
KW
570/* Specify the widest unsigned type on the platform. Use U64TYPE because U64
571 * is known only in the perl core, and this macro can be called from outside
572 * that */
573#ifdef HAS_QUAD
574# define WIDEST_UTYPE U64TYPE
575#else
576# define WIDEST_UTYPE U32
577#endif
578
3912bc88
KW
579/* FITS_IN_8_BITS(c) returns true if c doesn't have a bit set other than in
580 * the lower 8. It is designed to be hopefully bomb-proof, making sure that no
581 * bits of information are lost even on a 64-bit machine, but to get the
582 * compiler to optimize it out if possible. This is because Configure makes
583 * sure that the machine has an 8-bit byte, so if c is stored in a byte, the
584 * sizeof() guarantees that this evaluates to a constant true at compile time.
220c71bf
KW
585 */
586#define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || !(((WIDEST_UTYPE)(c)) & ~0xFF))
cf301eb7 587
41f43cc2 588#ifdef EBCDIC
ff7eba81 589# define isASCII(c) (FITS_IN_8_BITS(c) && (NATIVE_TO_UNI((U8) (c)) < 128))
41f43cc2
KW
590#else
591# define isASCII(c) ((WIDEST_UTYPE)(c) < 128)
592#endif
593
ec79cfbb 594#define isASCII_A(c) isASCII(c)
3509bb53 595#define isASCII_L1(c) isASCII(c)
6515cb76 596
c2da0b36
KW
597/* The lower 3 bits in both the ASCII and EBCDIC representations of '0' are 0,
598 * and the 8 possible permutations of those bits exactly comprise the 8 octal
599 * digits */
3d33b3e3 600#define isOCTAL_A(c) cBOOL(FITS_IN_8_BITS(c) && (0xF8 & (c)) == '0')
c2da0b36 601
ec79cfbb 602/* ASCII range only */
9fb1bf9d 603#ifdef H_PERL /* If have access to perl.h, lookup in its table */
f4cdb42c 604
66c17564
KW
605/* Character class numbers. For internal core Perl use only. These are used
606 * in PL_charclass[] and the ones up through the one that corresponds to
607 * <_HIGHEST_REGCOMP_DOT_H_SYNC> are used by regcomp.h. These use names used
608 * in l1_char_class_tab.h but their actual definitions are here. If that has a
609 * name not used here, it won't compile. */
f4cdb42c
KW
610# define _CC_WORDCHAR 0
611# define _CC_SPACE 1
612# define _CC_DIGIT 2
613# define _CC_ALNUMC 3
614# define _CC_ALPHA 4
615# define _CC_ASCII 5
616# define _CC_CNTRL 6
617# define _CC_GRAPH 7
618# define _CC_LOWER 8
619# define _CC_PRINT 9
620# define _CC_PUNCT 10
621# define _CC_UPPER 11
622# define _CC_XDIGIT 12
623# define _CC_PSXSPC 13
624# define _CC_BLANK 14
a0947d7b
KW
625# define _CC_VERTSPACE 15
626# define _HIGHEST_REGCOMP_DOT_H_SYNC _CC_VERTSPACE
627
628# define _CC_IDFIRST 16
629# define _CC_CHARNAME_CONT 17
630# define _CC_NONLATIN1_FOLD 18
631# define _CC_QUOTEMETA 19
632# define _CC_NON_FINAL_FOLD 20
633# define _CC_IS_IN_SOME_FOLD 21
634/* Unused: 22-31
f4cdb42c
KW
635 * If more bits are needed, one could add a second word for non-64bit
636 * QUAD_IS_INT systems, using some #ifdefs to distinguish between having a 2nd
37ede926
KW
637 * word or not. The IS_IN_SOME_FOLD bit is the most easily expendable, as it
638 * is used only for optimization (as of this writing), and differs in the
639 * Latin1 range from the ALPHA bit only in two relatively unimportant
640 * characters: the masculine and feminine ordinal indicators */
96ac0975
NC
641
642# ifdef DOINIT
643EXTCONST U32 PL_charclass[] = {
644# include "l1_char_class_tab.h"
645};
646
647# else /* ! DOINIT */
648EXTCONST U32 PL_charclass[];
649# endif
650
265c1f46 651 /* The 1U keeps Solaris from griping when shifting sets the uppermost bit */
430b7c70
KW
652# define _CC_mask(classnum) (1U << (classnum))
653# define _generic_isCC(c, classnum) cBOOL(FITS_IN_8_BITS(c) \
654 && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask(classnum)))
4eeeb416 655
f4cdb42c
KW
656 /* The mask for the _A versions of the macros; it just adds in the bit for
657 * ASCII. */
658# define _CC_mask_A(classnum) (_CC_mask(classnum) | _CC_mask(_CC_ASCII))
659
660 /* The _A version makes sure that both the desired bit and the ASCII bit
661 * are present */
662# define _generic_isCC_A(c, classnum) (FITS_IN_8_BITS(c) \
663 && ((PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask_A(classnum)) \
664 == _CC_mask_A(classnum)))
665
666# define isALNUMC_A(c) _generic_isCC_A(c, _CC_ALNUMC)
667# define isALPHA_A(c) _generic_isCC_A(c, _CC_ALPHA)
668# define isBLANK_A(c) _generic_isCC_A(c, _CC_BLANK)
669# define isCNTRL_A(c) _generic_isCC_A(c, _CC_CNTRL)
670# define isDIGIT_A(c) _generic_isCC(c, _CC_DIGIT)
671# define isGRAPH_A(c) _generic_isCC_A(c, _CC_GRAPH)
672# define isLOWER_A(c) _generic_isCC_A(c, _CC_LOWER)
673# define isPRINT_A(c) _generic_isCC_A(c, _CC_PRINT)
674# define isPSXSPC_A(c) _generic_isCC_A(c, _CC_PSXSPC)
675# define isPUNCT_A(c) _generic_isCC_A(c, _CC_PUNCT)
676# define isSPACE_A(c) _generic_isCC_A(c, _CC_SPACE)
677# define isUPPER_A(c) _generic_isCC_A(c, _CC_UPPER)
678# define isWORDCHAR_A(c) _generic_isCC_A(c, _CC_WORDCHAR)
679# define isXDIGIT_A(c) _generic_isCC(c, _CC_XDIGIT)
680# define isIDFIRST_A(c) _generic_isCC_A(c, ( _CC_IDFIRST))
681
fb9bfbf7
KW
682 /* Either participates in a fold with a character above 255, or is a
683 * multi-char fold */
430b7c70
KW
684# define _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) ((! cBOOL(FITS_IN_8_BITS(c))) || (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask(_CC_NONLATIN1_FOLD)))
685
4eeeb416 686# define _isQUOTEMETA(c) _generic_isCC(c, _CC_QUOTEMETA)
26faadbd
KW
687# define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
688 _generic_isCC(c, _CC_NON_FINAL_FOLD)
37ede926
KW
689# define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
690 _generic_isCC(c, _CC_IS_IN_SOME_FOLD)
9fb1bf9d 691#else /* No perl.h. */
9fb1bf9d
KW
692# ifdef EBCDIC
693# define isALNUMC_A(c) (isASCII(c) && isALNUMC(c))
694# define isALPHA_A(c) (isASCII(c) && isALPHA(c))
695# define isBLANK_A(c) (isASCII(c) && isBLANK(c))
696# define isCNTRL_A(c) (isASCII(c) && isCNTRL(c))
697# define isDIGIT_A(c) (isASCII(c) && isDIGIT(c))
698# define isGRAPH_A(c) (isASCII(c) && isGRAPH(c))
699# define isIDFIRST_A(c) (isASCII(c) && isIDFIRST(c))
700# define isLOWER_A(c) (isASCII(c) && isLOWER(c))
701# define isPRINT_A(c) (isASCII(c) && isPRINT(c))
702# define isPSXSPC_A(c) (isASCII(c) && isPSXSPC(c))
703# define isPUNCT_A(c) (isASCII(c) && isPUNCT(c))
704# define isSPACE_A(c) (isASCII(c) && isSPACE(c))
705# define isUPPER_A(c) (isASCII(c) && isUPPER(c))
706# define isWORDCHAR_A(c) (isASCII(c) && isWORDCHAR(c))
707# define isXDIGIT_A(c) (isASCII(c) && isXDIGIT(c))
708# else /* ASCII platform, no perl.h */
709# define isALNUMC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
710# define isALPHA_A(c) (isUPPER_A(c) || isLOWER_A(c))
711# define isBLANK_A(c) ((c) == ' ' || (c) == '\t')
ff7eba81 712# define isCNTRL_A(c) (FITS_IN_8_BITS(c) && ((U8) (c) < ' ' || (c) == 127))
2181da29 713# define isDIGIT_A(c) ((c) <= '9' && (c) >= '0')
9fb1bf9d
KW
714# define isGRAPH_A(c) (isWORDCHAR_A(c) || isPUNCT_A(c))
715# define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_')
716# define isLOWER_A(c) ((c) >= 'a' && (c) <= 'z')
717# define isPRINT_A(c) (((c) >= 32 && (c) < 127))
718# define isPSXSPC_A(c) (isSPACE_A(c) || (c) == '\v')
719# define isPUNCT_A(c) (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64) || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
720# define isSPACE_A(c) ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
2181da29 721# define isUPPER_A(c) ((c) <= 'Z' && (c) >= 'A')
9fb1bf9d 722# define isWORDCHAR_A(c) (isALPHA_A(c) || isDIGIT_A(c) || (c) == '_')
2181da29 723# define isXDIGIT_A(c) (isDIGIT_A(c) || ((c) >= 'a' && (c) <= 'f') || ((c) <= 'F' && (c) >= 'A'))
9fb1bf9d
KW
724# endif
725#endif /* ASCII range definitions */
ec79cfbb
KW
726
727/* Latin1 definitions */
8a58bdcf 728#ifdef H_PERL
f4cdb42c
KW
729# define isALNUMC_L1(c) _generic_isCC(c, _CC_ALNUMC)
730# define isALPHA_L1(c) _generic_isCC(c, _CC_ALPHA)
731# define isBLANK_L1(c) _generic_isCC(c, _CC_BLANK)
e5dcd934 732
8a58bdcf 733/* continuation character for legal NAME in \N{NAME} */
4eeeb416 734# define isCHARNAME_CONT(c) _generic_isCC(c, _CC_CHARNAME_CONT)
e5dcd934 735
f4cdb42c
KW
736# define isCNTRL_L1(c) _generic_isCC(c, _CC_CNTRL)
737# define isGRAPH_L1(c) _generic_isCC(c, _CC_GRAPH)
738# define isLOWER_L1(c) _generic_isCC(c, _CC_LOWER)
739# define isPRINT_L1(c) _generic_isCC(c, _CC_PRINT)
740# define isPSXSPC_L1(c) _generic_isCC(c, _CC_PSXSPC)
741# define isPUNCT_L1(c) _generic_isCC(c, _CC_PUNCT)
742# define isSPACE_L1(c) _generic_isCC(c, _CC_SPACE)
743# define isUPPER_L1(c) _generic_isCC(c, _CC_UPPER)
744# define isWORDCHAR_L1(c) _generic_isCC(c, _CC_WORDCHAR)
745# define isIDFIRST_L1(c) _generic_isCC(c, _CC_IDFIRST)
8a58bdcf
KW
746#else /* No access to perl.h. Only a few provided here, just in case needed
747 * for backwards compatibility */
748 /* ALPHAU includes Unicode semantics for latin1 characters. It has an extra
749 * >= AA test to speed up ASCII-only tests at the expense of the others */
750# define isALPHA_L1(c) (isALPHA(c) || (NATIVE_TO_UNI((U8) c) >= 0xAA \
751 && ((NATIVE_TO_UNI((U8) c) >= 0xC0 \
752 && NATIVE_TO_UNI((U8) c) != 0xD7 && NATIVE_TO_UNI((U8) c) != 0xF7) \
753 || NATIVE_TO_UNI((U8) c) == 0xAA \
754 || NATIVE_TO_UNI((U8) c) == 0xB5 \
755 || NATIVE_TO_UNI((U8) c) == 0xBA)))
ca5b5914 756# define isCHARNAME_CONT(c) (isWORDCHAR_L1(c) || (c) == ' ' || (c) == '-' || (c) == '(' || (c) == ')' || (c) == ':' || NATIVE_TO_UNI((U8) c) == 0xA0)
8a58bdcf
KW
757#endif
758
759/* Macros for backwards compatibility and for completeness when the ASCII and
760 * Latin1 values are identical */
ec79cfbb
KW
761#define isALNUM(c) isWORDCHAR(c)
762#define isALNUMU(c) isWORDCHAR_L1(c)
8a58bdcf
KW
763#define isALPHAU(c) isALPHA_L1(c)
764#define isDIGIT_L1(c) isDIGIT_A(c)
765#define isOCTAL(c) isOCTAL_A(c)
766#define isOCTAL_L1(c) isOCTAL_A(c)
767#define isXDIGIT_L1(c) isXDIGIT_A(c)
768
769/* Macros that differ between EBCDIC and ASCII. Where C89 defines a function,
770 * that is used in the EBCDIC form, because in EBCDIC we do not do locales:
771 * therefore can use native functions. For those where C89 doesn't define a
772 * function, use our function, assuming that the EBCDIC code page is isomorphic
773 * with Latin1, which the three currently recognized by Perl are. Some libc's
774 * have an isblank(), but it's not guaranteed. */
9d116dd7 775#ifdef EBCDIC
b8c5462f 776# define isALNUMC(c) isalnum(c)
271b5cb3 777# define isALPHA(c) isalpha(c)
0bc70f7f 778# define isBLANK(c) ((c) == ' ' || (c) == '\t' || NATIVE_TO_UNI(c) == 0xA0)
b8c5462f 779# define isCNTRL(c) iscntrl(c)
9916188f 780# define isDIGIT(c) isdigit(c)
b8c5462f 781# define isGRAPH(c) isgraph(c)
8a58bdcf 782# define isIDFIRST(c) (isALPHA(c) || (c) == '_')
7d79683e 783# define isLOWER(c) islower(c)
9d116dd7 784# define isPRINT(c) isprint(c)
56e4b611 785# define isPSXSPC(c) isspace(c)
b8c5462f 786# define isPUNCT(c) ispunct(c)
f1f70107
KW
787# define isSPACE(c) (isPSXSPC(c) /* && (c) != '\v' (Experimentally making
788 these macros identical) */)
7d79683e 789# define isUPPER(c) isupper(c)
b8c5462f 790# define isXDIGIT(c) isxdigit(c)
8a58bdcf 791# define isWORDCHAR(c) (isalnum(c) || (c) == '_')
9d116dd7 792# define toLOWER(c) tolower(c)
7d79683e 793# define toUPPER(c) toupper(c)
ec79cfbb 794#else /* Not EBCDIC: ASCII-only matching */
e58b1dde 795# define isALNUMC(c) isALNUMC_A(c) /* Mnemonic: "C's alnum" = alpha + digit */
271b5cb3 796# define isALPHA(c) isALPHA_A(c)
ec79cfbb
KW
797# define isBLANK(c) isBLANK_A(c)
798# define isCNTRL(c) isCNTRL_A(c)
799# define isDIGIT(c) isDIGIT_A(c)
800# define isGRAPH(c) isGRAPH_A(c)
8a58bdcf 801# define isIDFIRST(c) isIDFIRST_A(c)
ec79cfbb
KW
802# define isLOWER(c) isLOWER_A(c)
803# define isPRINT(c) isPRINT_A(c)
804# define isPSXSPC(c) isPSXSPC_A(c)
805# define isPUNCT(c) isPUNCT_A(c)
806# define isSPACE(c) isSPACE_A(c)
807# define isUPPER(c) isUPPER_A(c)
8a58bdcf 808# define isWORDCHAR(c) isWORDCHAR_A(c)
ec79cfbb 809# define isXDIGIT(c) isXDIGIT_A(c)
00f254e2 810
8a58bdcf
KW
811 /* ASCII casing. These could also be written as
812 #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
813 #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
814 which uses table lookup and mask instead of subtraction. (This would
815 work because the _MOD does not apply in the ASCII range) */
9d116dd7 816# define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c))
7d79683e 817# define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c))
9d116dd7 818#endif
bbce6d69 819
1a0901db
KW
820
821/* Use table lookup for speed; return error character for input
822 * out-of-range */
823#define toLOWER_LATIN1(c) (FITS_IN_8_BITS(c) \
824 ? UNI_TO_NATIVE(PL_latin1_lc[ \
825 NATIVE_TO_UNI( (U8) (c)) ]) \
826 : UNICODE_REPLACEMENT)
827/* Modified uc. Is correct uc except for three non-ascii chars which are
828 * all mapped to one of them, and these need special handling; error
829 * character for input out-of-range */
830#define toUPPER_LATIN1_MOD(c) (FITS_IN_8_BITS(c) \
831 ? UNI_TO_NATIVE(PL_mod_latin1_uc[ \
832 NATIVE_TO_UNI( (U8) (c)) ]) \
833 : UNICODE_REPLACEMENT)
834
bbce6d69
PP
835#ifdef USE_NEXT_CTYPE
836
ca5b5914 837# define isWORDCHAR_LC(c) \
37bd1396 838 (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
ca5b5914 839# define isALNUM_LC(c) isWORDCHAR_LC(c)
ff68c719
PP
840# define isIDFIRST_LC(c) \
841 (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
842# define isALPHA_LC(c) NXIsAlpha((unsigned int)(c))
07315176 843# define isASCII_LC(c) isASCII((unsigned int)(c))
67addccf 844# define isBLANK_LC(c) isBLANK((unsigned int)(c))
ff68c719
PP
845# define isSPACE_LC(c) NXIsSpace((unsigned int)(c))
846# define isDIGIT_LC(c) NXIsDigit((unsigned int)(c))
847# define isUPPER_LC(c) NXIsUpper((unsigned int)(c))
848# define isLOWER_LC(c) NXIsLower((unsigned int)(c))
37bd1396 849# define isALNUMC_LC(c) NXIsAlNum((unsigned int)(c))
b8c5462f
JH
850# define isCNTRL_LC(c) NXIsCntrl((unsigned int)(c))
851# define isGRAPH_LC(c) NXIsGraph((unsigned int)(c))
ff68c719 852# define isPRINT_LC(c) NXIsPrint((unsigned int)(c))
b8c5462f 853# define isPUNCT_LC(c) NXIsPunct((unsigned int)(c))
e712593e 854# define isXDIGIT_LC(c) NXIsXDigit((unsigned int)(c))
ff68c719
PP
855# define toUPPER_LC(c) NXToUpper((unsigned int)(c))
856# define toLOWER_LC(c) NXToLower((unsigned int)(c))
bbce6d69
PP
857
858#else /* !USE_NEXT_CTYPE */
b8c5462f 859
bbce6d69
PP
860# if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
861
76fde96a 862/* Use foo_LC_uvchr() instead of these for beyond the Latin1 range */
851131d3 863
ca5b5914 864# define isWORDCHAR_LC(c) (FITS_IN_8_BITS(c) \
76fde96a 865 && (isalnum((unsigned char)(c)) || (char)(c) == '_'))
ca5b5914 866# define isALNUM_LC(c) isWORDCHAR_LC(c)
76fde96a
KW
867# define isIDFIRST_LC(c) (FITS_IN_8_BITS(c) \
868 && (isalpha((unsigned char)(c)) || (char)(c) == '_'))
869# define isALPHA_LC(c) (FITS_IN_8_BITS(c) && isalpha((unsigned char)(c)))
07315176 870# ifdef HAS_ISASCII
76fde96a 871# define isASCII_LC(c) (FITS_IN_8_BITS(c) && isascii((unsigned char)(c)))
07315176 872# else
76fde96a 873# define isASCII_LC(c) (FITS_IN_8_BITS(c) && isASCII((unsigned char)(c)))
07315176 874# endif
67addccf 875# ifdef HAS_ISBLANK
76fde96a 876# define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isblank((unsigned char)(c)))
67addccf 877# else
76fde96a 878# define isBLANK_LC(c) (FITS_IN_8_BITS(c) && isBLANK((unsigned char)(c)))
67addccf 879# endif
76fde96a
KW
880# define isSPACE_LC(c) (FITS_IN_8_BITS(c) && isspace((unsigned char)(c)))
881# define isDIGIT_LC(c) (FITS_IN_8_BITS(c) && isdigit((unsigned char)(c)))
882# define isUPPER_LC(c) (FITS_IN_8_BITS(c) && isupper((unsigned char)(c)))
883# define isLOWER_LC(c) (FITS_IN_8_BITS(c) && islower((unsigned char)(c)))
884# define isALNUMC_LC(c) (FITS_IN_8_BITS(c) && isalnum((unsigned char)(c)))
885# define isCNTRL_LC(c) (FITS_IN_8_BITS(c) && iscntrl((unsigned char)(c)))
886# define isGRAPH_LC(c) (FITS_IN_8_BITS(c) && isgraph((unsigned char)(c)))
887# define isPRINT_LC(c) (FITS_IN_8_BITS(c) && isprint((unsigned char)(c)))
888# define isPUNCT_LC(c) (FITS_IN_8_BITS(c) && ispunct((unsigned char)(c)))
e712593e 889# define isXDIGIT_LC(c) (FITS_IN_8_BITS(c) && isxdigit((unsigned char)(c)))
76fde96a
KW
890# define toUPPER_LC(c) (FITS_IN_8_BITS(c) ? toupper((unsigned char)(c)) : (c))
891# define toLOWER_LC(c) (FITS_IN_8_BITS(c) ? tolower((unsigned char)(c)) : (c))
bbce6d69
PP
892
893# else
894
ca5b5914
KW
895# define isWORDCHAR_LC(c) (isascii(c) && (isalnum(c) || (c) == '_'))
896# define isALNUM_LC(c) isWORDCHAR_LC(c)
bbce6d69
PP
897# define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
898# define isALPHA_LC(c) (isascii(c) && isalpha(c))
07315176 899# define isASCII_LC(c) isascii(c)
67addccf
KW
900# ifdef HAS_ISBLANK
901# define isBLANK_LC(c) (isascii(c) && isblank(c))
902# else
903# define isBLANK_LC(c) isBLANK(c)
904# endif
bbce6d69
PP
905# define isSPACE_LC(c) (isascii(c) && isspace(c))
906# define isDIGIT_LC(c) (isascii(c) && isdigit(c))
907# define isUPPER_LC(c) (isascii(c) && isupper(c))
908# define isLOWER_LC(c) (isascii(c) && islower(c))
b8c5462f
JH
909# define isALNUMC_LC(c) (isascii(c) && isalnum(c))
910# define isCNTRL_LC(c) (isascii(c) && iscntrl(c))
911# define isGRAPH_LC(c) (isascii(c) && isgraph(c))
bbce6d69 912# define isPRINT_LC(c) (isascii(c) && isprint(c))
b8c5462f 913# define isPUNCT_LC(c) (isascii(c) && ispunct(c))
e712593e 914# define isXDIGIT_LC(c) (isascii(c) && isxdigit(c))
76fde96a
KW
915# define toUPPER_LC(c) (isascii(c) ? toupper(c) : (c))
916# define toLOWER_LC(c) (isascii(c) ? tolower(c) : (c))
bbce6d69
PP
917
918# endif
a0d0e21e 919#endif /* USE_NEXT_CTYPE */
55204971 920
13380643 921#define isPSXSPC_LC(c) isSPACE_LC(c)
aaa51d5e 922
66c17564
KW
923/* For internal core Perl use only. If the input is Latin1, use the Latin1
924 * macro; otherwise use the function. Won't compile if 'c' isn't unsigned, as
925 * won't match function prototype. The macros do bounds checking, so have
926 * duplicate checks here, so could create versions of the macros that don't,
927 * but experiments show that gcc optimizes them out anyway. */
928
929/* Note that all ignore 'use bytes' */
930#define _generic_uni(classnum, function, c) ((c) < 256 \
aea0c08c
KW
931 ? _generic_isCC(c, classnum) \
932 : function(c))
eb0052d1 933
66c17564 934#define isWORDCHAR_uni(c) _generic_uni(_CC_WORDCHAR, is_uni_alnum, c)
1545c4e9 935#define isALNUM_uni(c) isWORDCHAR_uni(c)
2cafb56b 936#define isBLANK_uni(c) _generic_uni(_CC_BLANK, is_HORIZWS_cp_high, c)
f91dcd13 937#define isIDFIRST_uni(c) _generic_uni(_CC_IDFIRST, _is_uni_perl_idstart, c)
66c17564 938#define isALPHA_uni(c) _generic_uni(_CC_ALPHA, is_uni_alpha, c)
5092f92a 939#define isALNUMC_uni(c) _generic_uni(_CC_ALNUMC, is_uni_alnumc, c)
add4123a 940#define isSPACE_uni(c) _generic_uni(_CC_SPACE, is_XPERLSPACE_cp_high, c)
840f8e92 941#define isVERTWS_uni(c) _generic_uni(_CC_VERTSPACE, is_VERTWS_cp_high, c)
66c17564
KW
942#define isDIGIT_uni(c) _generic_uni(_CC_DIGIT, is_uni_digit, c)
943#define isUPPER_uni(c) _generic_uni(_CC_UPPER, is_uni_upper, c)
944#define isLOWER_uni(c) _generic_uni(_CC_LOWER, is_uni_lower, c)
aea0c08c
KW
945#define isASCII_uni(c) isASCII(c)
946
7b952154 947/* All controls are in Latin1 */
aea0c08c
KW
948#define isCNTRL_uni(c) isCNTRL_L1(c)
949
66c17564
KW
950#define isGRAPH_uni(c) _generic_uni(_CC_GRAPH, is_uni_graph, c)
951#define isPRINT_uni(c) _generic_uni(_CC_PRINT, is_uni_print, c)
952#define isPUNCT_uni(c) _generic_uni(_CC_PUNCT, is_uni_punct, c)
4ac6419d 953#define isXDIGIT_uni(c) _generic_uni(_CC_XDIGIT, is_XDIGIT_cp_high, c)
b18192e9 954
13380643
KW
955/* Posix and regular space differ only the ASCII-range, so uses the same
956 * above-latin1 function */
add4123a
KW
957#define isPSXSPC_uni(c) _generic_uni(_CC_PSXSPC, \
958 is_XPERLSPACE_cp_high, c)
b18192e9 959
a2a2844f
JH
960#define toUPPER_uni(c,s,l) to_uni_upper(c,s,l)
961#define toTITLE_uni(c,s,l) to_uni_title(c,s,l)
962#define toLOWER_uni(c,s,l) to_uni_lower(c,s,l)
b8d68ded 963#define toFOLD_uni(c,s,l) to_uni_fold(c,s,l)
a0ed51b3 964
69788afd
KW
965#define _gnrc_is_LC_uvchr(latin1, above_latin1, c) \
966 (c < 256 ? latin1(c) : above_latin1(NATIVE_TO_UNI(c)))
ca5b5914 967#define isWORDCHAR_LC_uvchr(c) _gnrc_is_LC_uvchr(isWORDCHAR_LC, \
69788afd 968 is_uni_alnum_lc, c)
ca5b5914 969#define isALNUM_LC_uvchr(c) isWORDCHAR_LC_uvchr(c)
69788afd
KW
970#define isIDFIRST_LC_uvchr(c) _gnrc_is_LC_uvchr(isIDFIRST_LC, \
971 is_uni_idfirst_lc, c)
972#define isALPHA_LC_uvchr(c) _gnrc_is_LC_uvchr(isALPHA_LC, is_uni_alpha_lc, c)
5092f92a 973#define isALNUMC_LC_uvchr(c) _gnrc_is_LC_uvchr(isALNUMC_LC, is_uni_alnumc_lc, c)
69788afd 974#define isSPACE_LC_uvchr(c) _gnrc_is_LC_uvchr(isSPACE_LC, \
feeab5a9 975 is_XPERLSPACE_cp_high, c)
69788afd
KW
976#define isDIGIT_LC_uvchr(c) _gnrc_is_LC_uvchr(isDIGIT_LC, is_uni_digit_lc, c)
977#define isUPPER_LC_uvchr(c) _gnrc_is_LC_uvchr(isUPPER_LC, is_uni_upper_lc, c)
978#define isLOWER_LC_uvchr(c) _gnrc_is_LC_uvchr(isLOWER_LC, is_uni_lower_lc, c)
feeab5a9 979#define isCNTRL_LC_uvchr(c) (c < 256 ? isCNTRL_LC(c) : 0)
69788afd
KW
980#define isGRAPH_LC_uvchr(c) _gnrc_is_LC_uvchr(isGRAPH_LC, is_uni_graph_lc, c)
981#define isPRINT_LC_uvchr(c) _gnrc_is_LC_uvchr(isPRINT_LC, is_uni_print_lc, c)
982#define isPUNCT_LC_uvchr(c) _gnrc_is_LC_uvchr(isPUNCT_LC, is_uni_punct_lc, c)
e712593e
KW
983#define isBLANK_LC_uvchr(c) _gnrc_is_LC_uvchr(isBLANK_LC, is_HORIZWS_cp_high, c)
984#define isXDIGIT_LC_uvchr(c) _gnrc_is_LC_uvchr(isXDIGIT_LC, is_XDIGIT_cp_high, c)
985#define isASCII_LC_uvchr(c) isASCII_LC(c)
986
987/* space is identical to posix space under locale */
988#define isPSXSPC_LC_uvchr(c) isSPACE_LC_uvchr(c)
a0ed51b3 989
aaa51d5e
JF
990#define isBLANK_LC_uni(c) isBLANK(c) /* could be wrong */
991
66c17564 992/* For internal core Perl use only. If the input is in the Latin1 range, use
252810d0
KW
993 * the Latin1 macro 'classnum' on 'p' which is a pointer to a UTF-8 string.
994 * Otherwise use the value given by the 'utf8' parameter. This relies on the
995 * fact that ASCII characters have the same representation whether utf8 or not.
996 * Note that it assumes that the utf8 has been validated, and ignores 'use
997 * bytes' */
998#define _generic_utf8_utf8(classnum, p, utf8) (UTF8_IS_INVARIANT(*(p)) \
aea0c08c 999 ? _generic_isCC(*(p), classnum) \
7d7a6efc 1000 : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
aea0c08c
KW
1001 ? _generic_isCC( \
1002 TWO_BYTE_UTF8_TO_UNI(*(p), \
1003 *((p)+1 )), \
1004 classnum) \
252810d0
KW
1005 : utf8)
1006/* Like the above, but calls 'function(p)' to get the utf8 value */
1007#define _generic_utf8(classnum, function, p) \
1008 _generic_utf8_utf8(classnum, p, function(p))
c8362b00 1009
252810d0
KW
1010#define isWORDCHAR_utf8(p) _generic_utf8(_CC_WORDCHAR, is_utf8_alnum, p)
1011#define isALNUM_utf8(p) isWORDCHAR_utf8(p) /* back compat */
e5dcd934 1012
c11ff943
KW
1013/* To prevent S_scan_word in toke.c from hanging, we have to make sure that
1014 * IDFIRST is an alnum. See
c8362b00 1015 * http://rt.perl.org/rt3/Ticket/Display.html?id=74022 for more detail than you
f91dcd13
KW
1016 * ever wanted to know about. (In the ASCII range, there isn't a difference.)
1017 * This used to be not the XID version, but we decided to go with the more
1018 * modern Unicode definition */
252810d0 1019#define isIDFIRST_utf8(p) _generic_utf8(_CC_IDFIRST, \
d65654cb 1020 _is_utf8_perl_idstart, p)
e5dcd934 1021
252810d0
KW
1022#define isIDCONT_utf8(p) _generic_utf8(_CC_WORDCHAR, is_utf8_xidcont, p)
1023#define isALPHA_utf8(p) _generic_utf8(_CC_ALPHA, is_utf8_alpha, p)
5092f92a 1024#define isALNUMC_utf8(p) _generic_utf8(_CC_ALNUMC, is_utf8_alnumc, p)
2cafb56b 1025#define isBLANK_utf8(p) _generic_utf8(_CC_BLANK, is_HORIZWS_high, p)
add4123a 1026#define isSPACE_utf8(p) _generic_utf8(_CC_SPACE, is_XPERLSPACE_high, p)
840f8e92 1027#define isVERTWS_utf8(p) _generic_utf8(_CC_VERTSPACE, is_VERTWS_high, p)
252810d0
KW
1028#define isDIGIT_utf8(p) _generic_utf8(_CC_DIGIT, is_utf8_digit, p)
1029#define isUPPER_utf8(p) _generic_utf8(_CC_UPPER, is_utf8_upper, p)
1030#define isLOWER_utf8(p) _generic_utf8(_CC_LOWER, is_utf8_lower, p)
aea0c08c 1031
141d8bad 1032/* Because ASCII is invariant under utf8, the non-utf8 macro works */
252810d0 1033#define isASCII_utf8(p) isASCII(*p)
aea0c08c 1034
a35d759a 1035#define isCNTRL_utf8(p) _generic_utf8_utf8(_CC_CNTRL, p, 0)
252810d0
KW
1036#define isGRAPH_utf8(p) _generic_utf8(_CC_GRAPH, is_utf8_graph, p)
1037#define isPRINT_utf8(p) _generic_utf8(_CC_PRINT, is_utf8_print, p)
1038#define isPUNCT_utf8(p) _generic_utf8(_CC_PUNCT, is_utf8_punct, p)
4ac6419d 1039#define isXDIGIT_utf8(p) _generic_utf8(_CC_XDIGIT, is_XDIGIT_high, p)
a2a2844f
JH
1040#define toUPPER_utf8(p,s,l) to_utf8_upper(p,s,l)
1041#define toTITLE_utf8(p,s,l) to_utf8_title(p,s,l)
1042#define toLOWER_utf8(p,s,l) to_utf8_lower(p,s,l)
a0ed51b3 1043
13380643
KW
1044/* Posix and regular space differ only in the ASCII range, so uses the same
1045 * above-Latin1 function */
add4123a 1046#define isPSXSPC_utf8(p) _generic_utf8(_CC_PSXSPC, is_XPERLSPACE_high, p)
2e8adce6 1047
9201a572
KW
1048/* For internal core Perl use only. If the input is in the Latin1 range, use
1049 * the macro 'macro' on 'p' which is a pointer to a UTF-8 string. Otherwise
1050 * use the value given by the 'utf8' parameter. This relies on the fact that
1051 * ASCII characters have the same representation whether utf8 or not. Note
1052 * that it assumes that the utf8 has been validated, and ignores 'use bytes' */
1053#define _generic_LC_utf8_utf8(macro, p, utf8) \
1054 (UTF8_IS_INVARIANT(*(p)) \
1055 ? macro(*(p)) \
1056 : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
1057 ? macro(TWO_BYTE_UTF8_TO_UNI(*(p), *((p)+1))) \
1058 : utf8)
1059
1060#define _generic_LC_utf8(macro, utf8_func, p) \
1061 _generic_LC_utf8_utf8(macro, p, utf8_func(p))
1062
ca5b5914
KW
1063#define isWORDCHAR_LC_utf8(p) _generic_LC_utf8(isWORDCHAR_LC, is_utf8_alnum, p)
1064#define isALNUM_LC_utf8(p) isWORDCHAR_LC_utf8(p)
9201a572
KW
1065#define isIDFIRST_LC_utf8(p) _generic_LC_utf8(isIDFIRST_LC, \
1066 _is_utf8_perl_idstart, p)
1067#define isALPHA_LC_utf8(p) _generic_LC_utf8(isALPHA_LC, is_utf8_alpha, p)
1068#define isBLANK_LC_utf8(p) _generic_LC_utf8(isBLANK_LC, is_HORIZWS_high, p)
1069#define isSPACE_LC_utf8(p) _generic_LC_utf8(isSPACE_LC, is_XPERLSPACE_high, p)
1070#define isDIGIT_LC_utf8(p) _generic_LC_utf8(isDIGIT_LC, is_utf8_digit, p)
1071#define isUPPER_LC_utf8(p) _generic_LC_utf8(isUPPER_LC, is_utf8_upper, p)
1072#define isLOWER_LC_utf8(p) _generic_LC_utf8(isLOWER_LC, is_utf8_lower, p)
1073#define isALNUMC_LC_utf8(p) _generic_LC_utf8(isALNUMC_LC, is_utf8_alnumc, p)
1074#define isCNTRL_LC_utf8(p) _generic_LC_utf8_utf8(isCNTRL_LC, p, 0)
1075#define isGRAPH_LC_utf8(p) _generic_LC_utf8(isGRAPH_LC, is_utf8_graph, p)
1076#define isPRINT_LC_utf8(p) _generic_LC_utf8(isPRINT_LC, is_utf8_print, p)
1077#define isPUNCT_LC_utf8(p) _generic_LC_utf8(isPUNCT_LC, is_utf8_punct, p)
e712593e
KW
1078#define isXDIGIT_LC_utf8(p) _generic_LC_utf8(isXDIGIT_LC, is_XDIGIT_high, p)
1079#define isASCII_LC_utf8(p) isASCII_LC(*p)
a0ed51b3 1080
13380643
KW
1081/* space is identical to posix space under locale */
1082#define isPSXSPC_LC_utf8(p) isSPACE_LC_utf8(p)
aaa51d5e 1083
6ae9f32a 1084/* This conversion works both ways, strangely enough. On EBCDIC platforms,
e5dcd934
KW
1085 * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII, except that they don't
1086 * necessarily mean the same characters, e.g. CTRL-D is 4 on both systems, but
1087 * that is EOT on ASCII; ST on EBCDIC */
6ae9f32a 1088# define toCTRL(c) (toUPPER(NATIVE_TO_UNI(c)) ^ 64)
bbce6d69 1089
dea28490
JJ
1090/* Line numbers are unsigned, 32 bits. */
1091typedef U32 line_t;
e5dcd934 1092#define NOLINE ((line_t) 4294967295UL) /* = FFFFFFFF */
378cc40b 1093
91152fc1
DG
1094/* Helpful alias for version prescan */
1095#define is_LAX_VERSION(a,b) \
1096 (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
1097
1098#define is_STRICT_VERSION(a,b) \
1099 (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
1100
1101#define BADVERSION(a,b,c) \
1102 if (b) { \
1103 *b = c; \
1104 } \
1105 return a;
8c52afec 1106
95a59cab
YO
1107#define READ_XDIGIT(s) (isALPHA(*(s)) ? ((*(s)++ + 9) & 0xf) : (*(s)++ & 0xf))
1108
8e84507e 1109/*
ccfc67b7
JH
1110=head1 Memory Management
1111
a02a5408 1112=for apidoc Am|void|Newx|void* ptr|int nitems|type
954c1994
GS
1113The XSUB-writer's interface to the C C<malloc> function.
1114
c5008215
JC
1115In 5.9.3, Newx() and friends replace the older New() API, and drops
1116the first parameter, I<x>, a debug aid which allowed callers to identify
37b8b4c9 1117themselves. This aid has been superseded by a new build option,
d10b4965 1118PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>). The older API is still
c5008215
JC
1119there for use in XS modules supporting older perls.
1120
a02a5408 1121=for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
954c1994 1122The XSUB-writer's interface to the C C<malloc> function, with
c5008215 1123cast. See also C<Newx>.
954c1994 1124
a02a5408 1125=for apidoc Am|void|Newxz|void* ptr|int nitems|type
954c1994 1126The XSUB-writer's interface to the C C<malloc> function. The allocated
c5008215 1127memory is zeroed with C<memzero>. See also C<Newx>.
a02a5408 1128
954c1994
GS
1129=for apidoc Am|void|Renew|void* ptr|int nitems|type
1130The XSUB-writer's interface to the C C<realloc> function.
1131
1132=for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
1133The XSUB-writer's interface to the C C<realloc> function, with
1134cast.
1135
49b8b560 1136=for apidoc Am|void|Safefree|void* ptr
954c1994
GS
1137The XSUB-writer's interface to the C C<free> function.
1138
1139=for apidoc Am|void|Move|void* src|void* dest|int nitems|type
1140The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1141source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1142the type. Can do overlapping moves. See also C<Copy>.
1143
e90e2364
NC
1144=for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
1145Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1146optimise.
1147
954c1994
GS
1148=for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
1149The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1150source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1151the type. May fail on overlapping copies. See also C<Move>.
1152
e90e2364
NC
1153=for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
1154
1155Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1156optimise.
1157
954c1994
GS
1158=for apidoc Am|void|Zero|void* dest|int nitems|type
1159
1160The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1161destination, C<nitems> is the number of items, and C<type> is the type.
1162
e90e2364
NC
1163=for apidoc Am|void *|ZeroD|void* dest|int nitems|type
1164
1165Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1166optimise.
1167
da5d8dbb 1168=for apidoc Am|void|StructCopy|type *src|type *dest|type
4375e838 1169This is an architecture-independent macro to copy one structure to another.
954c1994 1170
7e337ee0
JH
1171=for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
1172
1173Fill up memory with a byte pattern (a byte repeated over and over
1174again) that hopefully catches attempts to access uninitialized memory.
1175
1176=for apidoc Am|void|PoisonNew|void* dest|int nitems|type
1177
1178PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
1179
1c12ffb4 1180=for apidoc Am|void|PoisonFree|void* dest|int nitems|type
7e337ee0
JH
1181
1182PoisonWith(0xEF) for catching access to freed memory.
1183
9965345d
JH
1184=for apidoc Am|void|Poison|void* dest|int nitems|type
1185
7e337ee0 1186PoisonWith(0xEF) for catching access to freed memory.
9965345d
JH
1187
1188=cut */
954c1994 1189
561b68a9
SH
1190/* Maintained for backwards-compatibility only. Use newSV() instead. */
1191#ifndef PERL_CORE
ff06c60c 1192#define NEWSV(x,len) newSV(len)
561b68a9 1193#endif
ff06c60c 1194
19a94d75
JH
1195#define MEM_SIZE_MAX ((MEM_SIZE)~0)
1196
2720f793
JH
1197/* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
1198 * overly eager compilers that will bleat about e.g.
1199 * (U16)n > (size_t)~0/sizeof(U16) always being false. */
27d5b266 1200#ifdef PERL_MALLOC_WRAP
f019c49e
DD
1201#define MEM_WRAP_CHECK(n,t) \
1202 (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (croak_memory_wrap(),0))
27d5b266 1203#define MEM_WRAP_CHECK_1(n,t,a) \
f1f66076 1204 (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
8b44ba4c 1205#define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
27d5b266 1206
f019c49e 1207#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)))
27d5b266
JH
1208#else
1209
410319be
NC
1210#define MEM_WRAP_CHECK(n,t)
1211#define MEM_WRAP_CHECK_1(n,t,a)
1212#define MEM_WRAP_CHECK_2(n,t,a,b)
8b44ba4c
NC
1213#define MEM_WRAP_CHECK_(n,t)
1214
6fff79ce 1215#define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
27d5b266 1216
1936d2a7 1217#endif
8b44ba4c 1218
fe4f188c 1219#ifdef PERL_MEM_LOG
46c6c7e2 1220/*
9f653bb5 1221 * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
46c6c7e2
JH
1222 * go through functions, which are handy for debugging breakpoints, but
1223 * which more importantly get the immediate calling environment (file and
e352bcff
JH
1224 * line number, and C function name if available) passed in. This info can
1225 * then be used for logging the calls, for which one gets a sample
73d1d973 1226 * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
3609ea0d 1227 *
46c6c7e2 1228 * Known problems:
94e892a6 1229 * - not all memory allocs get logged, only those
46c6c7e2 1230 * that go through Newx() and derivatives (while all
94e892a6 1231 * Safefrees do get logged)
46c6c7e2
JH
1232 * - __FILE__ and __LINE__ do not work everywhere
1233 * - __func__ or __FUNCTION__ even less so
1234 * - I think more goes on after the perlio frees but
1235 * the thing is that STDERR gets closed (as do all
1236 * the file descriptors)
1237 * - no deeper calling stack than the caller of the Newx()
1238 * or the kind, but do I look like a C reflection/introspection
1239 * utility to you?
1240 * - the function prototypes for the logging functions
1241 * probably should maybe be somewhere else than handy.h
1242 * - one could consider inlining (macrofying) the logging
1243 * for speed, but I am too lazy
1244 * - one could imagine recording the allocations in a hash,
1245 * (keyed by the allocation address?), and maintain that
1246 * through reallocs and frees, but how to do that without
1247 * any News() happening...?
73d1d973 1248 * - lots of -Ddefines to get useful/controllable output
b953482e 1249 * - lots of ENV reads
46c6c7e2
JH
1250 */
1251
12754f92 1252PERL_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 1253
12754f92 1254PERL_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 1255
12754f92 1256PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
46c6c7e2 1257
0b0ab801 1258# ifdef PERL_CORE
73d1d973 1259# ifndef PERL_MEM_LOG_NOIMPL
0b0ab801
MHM
1260enum mem_log_type {
1261 MLT_ALLOC,
1262 MLT_REALLOC,
d7a2c63c
MHM
1263 MLT_FREE,
1264 MLT_NEW_SV,
1265 MLT_DEL_SV
0b0ab801
MHM
1266};
1267# endif
12754f92 1268# if defined(PERL_IN_SV_C) /* those are only used in sv.c */
d7a2c63c
MHM
1269void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1270void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
12754f92 1271# endif
0b0ab801
MHM
1272# endif
1273
fe4f188c
JH
1274#endif
1275
1276#ifdef PERL_MEM_LOG
d1401ee9
MHM
1277#define MEM_LOG_ALLOC(n,t,a) Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
1278#define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
46c6c7e2 1279#define MEM_LOG_FREE(a) Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
fe4f188c
JH
1280#endif
1281
1282#ifndef MEM_LOG_ALLOC
1283#define MEM_LOG_ALLOC(n,t,a) (a)
1284#endif
1285#ifndef MEM_LOG_REALLOC
1286#define MEM_LOG_REALLOC(n,t,v,a) (a)
1287#endif
1288#ifndef MEM_LOG_FREE
1289#define MEM_LOG_FREE(a) (a)
1290#endif
1291
d1401ee9
MHM
1292#define Newx(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1293#define Newxc(v,n,t,c) (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1294#define Newxz(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
a6f6820f
NC
1295
1296#ifndef PERL_CORE
a02a5408
JC
1297/* pre 5.9.x compatibility */
1298#define New(x,v,n,t) Newx(v,n,t)
1299#define Newc(x,v,n,t,c) Newxc(v,n,t,c)
4541904d 1300#define Newz(x,v,n,t) Newxz(v,n,t)
a6f6820f 1301#endif
a02a5408 1302
ff68c719 1303#define Renew(v,n,t) \
d1401ee9 1304 (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
ff68c719 1305#define Renewc(v,n,t,c) \
d1401ee9 1306 (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
94010e71
NC
1307
1308#ifdef PERL_POISON
1309#define Safefree(d) \
06c0cc96 1310 ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
94010e71 1311#else
fe4f188c 1312#define Safefree(d) safefree(MEM_LOG_FREE((Malloc_t)(d)))
94010e71 1313#endif
55497cff 1314
8b44ba4c
NC
1315#define Move(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1316#define Copy(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1317#define Zero(d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
55497cff 1318
8b44ba4c
NC
1319#define MoveD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1320#define CopyD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
e90e2364 1321#ifdef HAS_MEMSET
8b44ba4c 1322#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
e90e2364 1323#else
8b44ba4c
NC
1324/* Using bzero(), which returns void. */
1325#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
e90e2364
NC
1326#endif
1327
7e337ee0
JH
1328#define PoisonWith(d,n,t,b) (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
1329#define PoisonNew(d,n,t) PoisonWith(d,n,t,0xAB)
1330#define PoisonFree(d,n,t) PoisonWith(d,n,t,0xEF)
1331#define Poison(d,n,t) PoisonFree(d,n,t)
27d5b266 1332
2304df62 1333#ifdef USE_STRUCT_COPY
ff68c719 1334#define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
bee1dbe2
LW
1335#else
1336#define StructCopy(s,d,t) Copy(s,d,1,t)
1337#endif
2cc61e15 1338
622913ab 1339#define C_ARRAY_LENGTH(a) (sizeof(a)/sizeof((a)[0]))
cd431fde 1340#define C_ARRAY_END(a) (a) + (sizeof(a)/sizeof((a)[0]))
622913ab 1341
2cc61e15
DD
1342#ifdef NEED_VA_COPY
1343# ifdef va_copy
1344# define Perl_va_copy(s, d) va_copy(d, s)
2cc61e15 1345# else
a1866d1b
JH
1346# if defined(__va_copy)
1347# define Perl_va_copy(s, d) __va_copy(d, s)
1348# else
1349# define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
1350# endif
2cc61e15
DD
1351# endif
1352#endif
1353
472d47bc
SB
1354/* convenience debug macros */
1355#ifdef USE_ITHREADS
1356#define pTHX_FORMAT "Perl interpreter: 0x%p"
1357#define pTHX__FORMAT ", Perl interpreter: 0x%p"
f54cb97a
AL
1358#define pTHX_VALUE_ (void *)my_perl,
1359#define pTHX_VALUE (void *)my_perl
1360#define pTHX__VALUE_ ,(void *)my_perl,
1361#define pTHX__VALUE ,(void *)my_perl
472d47bc 1362#else
3609ea0d 1363#define pTHX_FORMAT
472d47bc 1364#define pTHX__FORMAT
3609ea0d 1365#define pTHX_VALUE_
472d47bc 1366#define pTHX_VALUE
3609ea0d 1367#define pTHX__VALUE_
472d47bc
SB
1368#define pTHX__VALUE
1369#endif /* USE_ITHREADS */
3609ea0d 1370
2acdbac1
NC
1371/* Perl_deprecate was not part of the public API, and did not have a deprecate()
1372 shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
1373 CPAN::Unpack show any users outside the core. */
1374#ifdef PERL_CORE
d1d15184 1375# define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
2acdbac1
NC
1376#endif
1377
e9a8c099
MHM
1378/*
1379 * Local variables:
1380 * c-indentation-style: bsd
1381 * c-basic-offset: 4
14d04a33 1382 * indent-tabs-mode: nil
e9a8c099
MHM
1383 * End:
1384 *
14d04a33 1385 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 1386 */