This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
https://perl5.git.perl.org / perl5.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
perl5db: extract some subroutines.
[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 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 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 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 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 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 240#define U8_MAX PERL_UCHAR_MAX
241#define U8_MIN PERL_UCHAR_MIN
79072805 242
27d4fb96 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 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 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 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 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 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
e7c1e6c1
KW		 549=head1 Character case changing
550
954c1994 551=for apidoc Am|char|toUPPER|char ch
06dc89af
KW		 552Converts the specified character to uppercase in the platform's native
553character set, if possible; otherwise returns the input character itself.
954c1994
GS		 554
555=for apidoc Am|char|toLOWER|char ch
06dc89af
KW		 556Converts the specified character to lowercase in the platform's native
557character set, if possible; otherwise returns the input character itself.
954c1994
GS		 558
559=cut
353c9b6f 560
8a58bdcf 561Note that these macros are repeated in Devel::PPPort, so should also be
62fa66b6
KW		 562patched there. The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
563
954c1994
GS		 564*/
565
7c062697
KW		 566/* Specify the widest unsigned type on the platform. Use U64TYPE because U64
567 * is known only in the perl core, and this macro can be called from outside
568 * that */
569#ifdef HAS_QUAD
570# define WIDEST_UTYPE U64TYPE
571#else
572# define WIDEST_UTYPE U32
573#endif
574
3912bc88
KW		 575/* FITS_IN_8_BITS(c) returns true if c doesn't have a bit set other than in
576 * the lower 8. It is designed to be hopefully bomb-proof, making sure that no
577 * bits of information are lost even on a 64-bit machine, but to get the
578 * compiler to optimize it out if possible. This is because Configure makes
579 * sure that the machine has an 8-bit byte, so if c is stored in a byte, the
580 * sizeof() guarantees that this evaluates to a constant true at compile time.
220c71bf
KW		 581 */
582#define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || !(((WIDEST_UTYPE)(c)) & ~0xFF))
cf301eb7 583
41f43cc2 584#ifdef EBCDIC
ff7eba81 585# define isASCII(c) (FITS_IN_8_BITS(c) && (NATIVE_TO_UNI((U8) (c)) < 128))
41f43cc2
KW		 586#else
587# define isASCII(c) ((WIDEST_UTYPE)(c) < 128)
588#endif
589
ec79cfbb 590#define isASCII_A(c) isASCII(c)
3509bb53 591#define isASCII_L1(c) isASCII(c)
6515cb76 592
c2da0b36
KW		 593/* The lower 3 bits in both the ASCII and EBCDIC representations of '0' are 0,
594 * and the 8 possible permutations of those bits exactly comprise the 8 octal
595 * digits */
3d33b3e3 596#define isOCTAL_A(c) cBOOL(FITS_IN_8_BITS(c) && (0xF8 & (c)) == '0')
c2da0b36 597
ec79cfbb 598/* ASCII range only */
9fb1bf9d 599#ifdef H_PERL /* If have access to perl.h, lookup in its table */
f4cdb42c 600
08ada29e
KW		 601/* Character class numbers. These are used in PL_charclass[] and the ones
602 * up through the one that corresponds to <_HIGHEST_REGCOMP_DOT_H_SYNC> are
603 * used by regcomp.h. These use names used in l1_char_class_tab.h but their
604 * actual definitions are here. If that has a name not used here, it won't
605 * compile. */
f4cdb42c
KW		 606# define _CC_WORDCHAR 0
607# define _CC_SPACE 1
608# define _CC_DIGIT 2
609# define _CC_ALNUMC 3
610# define _CC_ALPHA 4
611# define _CC_ASCII 5
612# define _CC_CNTRL 6
613# define _CC_GRAPH 7
614# define _CC_LOWER 8
615# define _CC_PRINT 9
616# define _CC_PUNCT 10
617# define _CC_UPPER 11
618# define _CC_XDIGIT 12
619# define _CC_PSXSPC 13
620# define _CC_BLANK 14
08ada29e
KW		 621# define _HIGHEST_REGCOMP_DOT_H_SYNC _CC_BLANK
622
f4cdb42c
KW		 623# define _CC_IDFIRST 15
624# define _CC_CHARNAME_CONT 16
625# define _CC_NONLATIN1_FOLD 17
626# define _CC_QUOTEMETA 18
b72a36d4 627# define _CC_NON_FINAL_FOLD 19
37ede926
KW		 628# define _CC_IS_IN_SOME_FOLD 20
629/* Unused: 21-31
f4cdb42c
KW		 630 * If more bits are needed, one could add a second word for non-64bit
631 * QUAD_IS_INT systems, using some #ifdefs to distinguish between having a 2nd
37ede926
KW		 632 * word or not. The IS_IN_SOME_FOLD bit is the most easily expendable, as it
633 * is used only for optimization (as of this writing), and differs in the
634 * Latin1 range from the ALPHA bit only in two relatively unimportant
635 * characters: the masculine and feminine ordinal indicators */
96ac0975
NC		 636
637# ifdef DOINIT
638EXTCONST U32 PL_charclass[] = {
639# include "l1_char_class_tab.h"
640};
641
642# else /* ! DOINIT */
643EXTCONST U32 PL_charclass[];
644# endif
645
265c1f46 646 /* The 1U keeps Solaris from griping when shifting sets the uppermost bit */
430b7c70
KW		 647# define _CC_mask(classnum) (1U << (classnum))
648# define _generic_isCC(c, classnum) cBOOL(FITS_IN_8_BITS(c) \
649 && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask(classnum)))
4eeeb416 650
f4cdb42c
KW		 651 /* The mask for the _A versions of the macros; it just adds in the bit for
652 * ASCII. */
653# define _CC_mask_A(classnum) (_CC_mask(classnum) | _CC_mask(_CC_ASCII))
654
655 /* The _A version makes sure that both the desired bit and the ASCII bit
656 * are present */
657# define _generic_isCC_A(c, classnum) (FITS_IN_8_BITS(c) \
658 && ((PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_mask_A(classnum)) \
659 == _CC_mask_A(classnum)))
660
661# define isALNUMC_A(c) _generic_isCC_A(c, _CC_ALNUMC)
662# define isALPHA_A(c) _generic_isCC_A(c, _CC_ALPHA)
663# define isBLANK_A(c) _generic_isCC_A(c, _CC_BLANK)
664# define isCNTRL_A(c) _generic_isCC_A(c, _CC_CNTRL)
665# define isDIGIT_A(c) _generic_isCC(c, _CC_DIGIT)
666# define isGRAPH_A(c) _generic_isCC_A(c, _CC_GRAPH)
667# define isLOWER_A(c) _generic_isCC_A(c, _CC_LOWER)
668# define isPRINT_A(c) _generic_isCC_A(c, _CC_PRINT)
669# define isPSXSPC_A(c) _generic_isCC_A(c, _CC_PSXSPC)
670# define isPUNCT_A(c) _generic_isCC_A(c, _CC_PUNCT)
671# define isSPACE_A(c) _generic_isCC_A(c, _CC_SPACE)
672# define isUPPER_A(c) _generic_isCC_A(c, _CC_UPPER)
673# define isWORDCHAR_A(c) _generic_isCC_A(c, _CC_WORDCHAR)
674# define isXDIGIT_A(c) _generic_isCC(c, _CC_XDIGIT)
675# define isIDFIRST_A(c) _generic_isCC_A(c, ( _CC_IDFIRST))
676
fb9bfbf7
KW		 677 /* Either participates in a fold with a character above 255, or is a
678 * multi-char fold */
430b7c70
KW		 679# 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)))
680
4eeeb416 681# define _isQUOTEMETA(c) _generic_isCC(c, _CC_QUOTEMETA)
26faadbd
KW		 682# define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
683 _generic_isCC(c, _CC_NON_FINAL_FOLD)
37ede926
KW		 684# define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
685 _generic_isCC(c, _CC_IS_IN_SOME_FOLD)
9fb1bf9d 686#else /* No perl.h. */
9fb1bf9d
KW		 687# ifdef EBCDIC
688# define isALNUMC_A(c) (isASCII(c) && isALNUMC(c))
689# define isALPHA_A(c) (isASCII(c) && isALPHA(c))
690# define isBLANK_A(c) (isASCII(c) && isBLANK(c))
691# define isCNTRL_A(c) (isASCII(c) && isCNTRL(c))
692# define isDIGIT_A(c) (isASCII(c) && isDIGIT(c))
693# define isGRAPH_A(c) (isASCII(c) && isGRAPH(c))
694# define isIDFIRST_A(c) (isASCII(c) && isIDFIRST(c))
695# define isLOWER_A(c) (isASCII(c) && isLOWER(c))
696# define isPRINT_A(c) (isASCII(c) && isPRINT(c))
697# define isPSXSPC_A(c) (isASCII(c) && isPSXSPC(c))
698# define isPUNCT_A(c) (isASCII(c) && isPUNCT(c))
699# define isSPACE_A(c) (isASCII(c) && isSPACE(c))
700# define isUPPER_A(c) (isASCII(c) && isUPPER(c))
701# define isWORDCHAR_A(c) (isASCII(c) && isWORDCHAR(c))
702# define isXDIGIT_A(c) (isASCII(c) && isXDIGIT(c))
703# else /* ASCII platform, no perl.h */
704# define isALNUMC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
705# define isALPHA_A(c) (isUPPER_A(c) || isLOWER_A(c))
706# define isBLANK_A(c) ((c) == ' ' || (c) == '\t')
ff7eba81 707# define isCNTRL_A(c) (FITS_IN_8_BITS(c) && ((U8) (c) < ' ' || (c) == 127))
2181da29 708# define isDIGIT_A(c) ((c) <= '9' && (c) >= '0')
9fb1bf9d
KW		 709# define isGRAPH_A(c) (isWORDCHAR_A(c) || isPUNCT_A(c))
710# define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_')
711# define isLOWER_A(c) ((c) >= 'a' && (c) <= 'z')
712# define isPRINT_A(c) (((c) >= 32 && (c) < 127))
713# define isPSXSPC_A(c) (isSPACE_A(c) || (c) == '\v')
714# define isPUNCT_A(c) (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64) || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
715# define isSPACE_A(c) ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
2181da29 716# define isUPPER_A(c) ((c) <= 'Z' && (c) >= 'A')
9fb1bf9d 717# define isWORDCHAR_A(c) (isALPHA_A(c) || isDIGIT_A(c) || (c) == '_')
2181da29 718# define isXDIGIT_A(c) (isDIGIT_A(c) || ((c) >= 'a' && (c) <= 'f') || ((c) <= 'F' && (c) >= 'A'))
9fb1bf9d
KW		 719# endif
720#endif /* ASCII range definitions */
ec79cfbb
KW		 721
722/* Latin1 definitions */
8a58bdcf 723#ifdef H_PERL
f4cdb42c
KW		 724# define isALNUMC_L1(c) _generic_isCC(c, _CC_ALNUMC)
725# define isALPHA_L1(c) _generic_isCC(c, _CC_ALPHA)
726# define isBLANK_L1(c) _generic_isCC(c, _CC_BLANK)
8a58bdcf 727/* continuation character for legal NAME in \N{NAME} */
4eeeb416 728# define isCHARNAME_CONT(c) _generic_isCC(c, _CC_CHARNAME_CONT)
f4cdb42c
KW		 729# define isCNTRL_L1(c) _generic_isCC(c, _CC_CNTRL)
730# define isGRAPH_L1(c) _generic_isCC(c, _CC_GRAPH)
731# define isLOWER_L1(c) _generic_isCC(c, _CC_LOWER)
732# define isPRINT_L1(c) _generic_isCC(c, _CC_PRINT)
733# define isPSXSPC_L1(c) _generic_isCC(c, _CC_PSXSPC)
734# define isPUNCT_L1(c) _generic_isCC(c, _CC_PUNCT)
735# define isSPACE_L1(c) _generic_isCC(c, _CC_SPACE)
736# define isUPPER_L1(c) _generic_isCC(c, _CC_UPPER)
737# define isWORDCHAR_L1(c) _generic_isCC(c, _CC_WORDCHAR)
738# define isIDFIRST_L1(c) _generic_isCC(c, _CC_IDFIRST)
8a58bdcf
KW		 739#else /* No access to perl.h. Only a few provided here, just in case needed
740 * for backwards compatibility */
741 /* ALPHAU includes Unicode semantics for latin1 characters. It has an extra
742 * >= AA test to speed up ASCII-only tests at the expense of the others */
743# define isALPHA_L1(c) (isALPHA(c) || (NATIVE_TO_UNI((U8) c) >= 0xAA \
744 && ((NATIVE_TO_UNI((U8) c) >= 0xC0 \
745 && NATIVE_TO_UNI((U8) c) != 0xD7 && NATIVE_TO_UNI((U8) c) != 0xF7) \
746 || NATIVE_TO_UNI((U8) c) == 0xAA \
747 || NATIVE_TO_UNI((U8) c) == 0xB5 \
748 || NATIVE_TO_UNI((U8) c) == 0xBA)))
749# define isCHARNAME_CONT(c) (isALNUM_L1(c) || (c) == ' ' || (c) == '-' || (c) == '(' || (c) == ')' || (c) == ':' || NATIVE_TO_UNI((U8) c) == 0xA0)
750#endif
751
752/* Macros for backwards compatibility and for completeness when the ASCII and
753 * Latin1 values are identical */
ec79cfbb
KW		 754#define isALNUM(c) isWORDCHAR(c)
755#define isALNUMU(c) isWORDCHAR_L1(c)
8a58bdcf
KW		 756#define isALPHAU(c) isALPHA_L1(c)
757#define isDIGIT_L1(c) isDIGIT_A(c)
758#define isOCTAL(c) isOCTAL_A(c)
759#define isOCTAL_L1(c) isOCTAL_A(c)
760#define isXDIGIT_L1(c) isXDIGIT_A(c)
761
762/* Macros that differ between EBCDIC and ASCII. Where C89 defines a function,
763 * that is used in the EBCDIC form, because in EBCDIC we do not do locales:
764 * therefore can use native functions. For those where C89 doesn't define a
765 * function, use our function, assuming that the EBCDIC code page is isomorphic
766 * with Latin1, which the three currently recognized by Perl are. Some libc's
767 * have an isblank(), but it's not guaranteed. */
9d116dd7 768#ifdef EBCDIC
b8c5462f 769# define isALNUMC(c) isalnum(c)
271b5cb3 770# define isALPHA(c) isalpha(c)
0bc70f7f 771# define isBLANK(c) ((c) == ' ' || (c) == '\t' || NATIVE_TO_UNI(c) == 0xA0)
b8c5462f 772# define isCNTRL(c) iscntrl(c)
9916188f 773# define isDIGIT(c) isdigit(c)
b8c5462f 774# define isGRAPH(c) isgraph(c)
8a58bdcf 775# define isIDFIRST(c) (isALPHA(c) || (c) == '_')
7d79683e 776# define isLOWER(c) islower(c)
9d116dd7 777# define isPRINT(c) isprint(c)
56e4b611 778# define isPSXSPC(c) isspace(c)
b8c5462f 779# define isPUNCT(c) ispunct(c)
174b5e76 780# define isSPACE(c) (isPSXSPC(c) && (c) != '\v')
7d79683e 781# define isUPPER(c) isupper(c)
b8c5462f 782# define isXDIGIT(c) isxdigit(c)
8a58bdcf 783# define isWORDCHAR(c) (isalnum(c) || (c) == '_')
9d116dd7 784# define toLOWER(c) tolower(c)
7d79683e 785# define toUPPER(c) toupper(c)
ec79cfbb 786#else /* Not EBCDIC: ASCII-only matching */
e58b1dde 787# define isALNUMC(c) isALNUMC_A(c) /* Mnemonic: "C's alnum" = alpha + digit */
271b5cb3 788# define isALPHA(c) isALPHA_A(c)
ec79cfbb
KW		 789# define isBLANK(c) isBLANK_A(c)
790# define isCNTRL(c) isCNTRL_A(c)
791# define isDIGIT(c) isDIGIT_A(c)
792# define isGRAPH(c) isGRAPH_A(c)
8a58bdcf 793# define isIDFIRST(c) isIDFIRST_A(c)
ec79cfbb
KW		 794# define isLOWER(c) isLOWER_A(c)
795# define isPRINT(c) isPRINT_A(c)
796# define isPSXSPC(c) isPSXSPC_A(c)
797# define isPUNCT(c) isPUNCT_A(c)
798# define isSPACE(c) isSPACE_A(c)
799# define isUPPER(c) isUPPER_A(c)
8a58bdcf 800# define isWORDCHAR(c) isWORDCHAR_A(c)
ec79cfbb 801# define isXDIGIT(c) isXDIGIT_A(c)
00f254e2 802
8a58bdcf
KW		 803 /* ASCII casing. These could also be written as
804 #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
805 #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
806 which uses table lookup and mask instead of subtraction. (This would
807 work because the _MOD does not apply in the ASCII range) */
9d116dd7 808# define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c))
7d79683e 809# define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c))
9d116dd7 810#endif
bbce6d69 811
1a0901db
KW		 812
813/* Use table lookup for speed; return error character for input
814 * out-of-range */
815#define toLOWER_LATIN1(c) (FITS_IN_8_BITS(c) \
816 ? UNI_TO_NATIVE(PL_latin1_lc[ \
817 NATIVE_TO_UNI( (U8) (c)) ]) \
818 : UNICODE_REPLACEMENT)
819/* Modified uc. Is correct uc except for three non-ascii chars which are
820 * all mapped to one of them, and these need special handling; error
821 * character for input out-of-range */
822#define toUPPER_LATIN1_MOD(c) (FITS_IN_8_BITS(c) \
823 ? UNI_TO_NATIVE(PL_mod_latin1_uc[ \
824 NATIVE_TO_UNI( (U8) (c)) ]) \
825 : UNICODE_REPLACEMENT)
826
bbce6d69 827#ifdef USE_NEXT_CTYPE
828
829# define isALNUM_LC(c) \
37bd1396 830 (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
ff68c719 831# define isIDFIRST_LC(c) \
832 (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
833# define isALPHA_LC(c) NXIsAlpha((unsigned int)(c))
07315176 834# define isASCII_LC(c) isASCII((unsigned int)(c))
67addccf 835# define isBLANK_LC(c) isBLANK((unsigned int)(c))
ff68c719 836# define isSPACE_LC(c) NXIsSpace((unsigned int)(c))
837# define isDIGIT_LC(c) NXIsDigit((unsigned int)(c))
838# define isUPPER_LC(c) NXIsUpper((unsigned int)(c))
839# define isLOWER_LC(c) NXIsLower((unsigned int)(c))
37bd1396 840# define isALNUMC_LC(c) NXIsAlNum((unsigned int)(c))
b8c5462f
JH		 841# define isCNTRL_LC(c) NXIsCntrl((unsigned int)(c))
842# define isGRAPH_LC(c) NXIsGraph((unsigned int)(c))
ff68c719 843# define isPRINT_LC(c) NXIsPrint((unsigned int)(c))
b8c5462f 844# define isPUNCT_LC(c) NXIsPunct((unsigned int)(c))
ff68c719 845# define toUPPER_LC(c) NXToUpper((unsigned int)(c))
846# define toLOWER_LC(c) NXToLower((unsigned int)(c))
bbce6d69 847
848#else /* !USE_NEXT_CTYPE */
b8c5462f 849
bbce6d69 850# if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
851
851131d3
KW		 852/* Note that the foo_LC() macros in this case generally are defined only on
853 * code points 0-256, and give undefined, unwarned results if called with
854 * values outside that range */
855
b8c5462f 856# define isALNUM_LC(c) (isalnum((unsigned char)(c)) || (char)(c) == '_')
ff68c719 857# define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
bbce6d69 858# define isALPHA_LC(c) isalpha((unsigned char)(c))
07315176
KW		 859# ifdef HAS_ISASCII
860# define isASCII_LC(c) isascii((unsigned char)(c))
861# else
862# define isASCII_LC(c) isASCII((unsigned char)(c))
863# endif
67addccf
KW		 864# ifdef HAS_ISBLANK
865# define isBLANK_LC(c) isblank((unsigned char)(c))
866# else
867# define isBLANK_LC(c) isBLANK((unsigned char)(c))
868# endif
bbce6d69 869# define isSPACE_LC(c) isspace((unsigned char)(c))
870# define isDIGIT_LC(c) isdigit((unsigned char)(c))
871# define isUPPER_LC(c) isupper((unsigned char)(c))
872# define isLOWER_LC(c) islower((unsigned char)(c))
b8c5462f
JH		 873# define isALNUMC_LC(c) isalnum((unsigned char)(c))
874# define isCNTRL_LC(c) iscntrl((unsigned char)(c))
875# define isGRAPH_LC(c) isgraph((unsigned char)(c))
bbce6d69 876# define isPRINT_LC(c) isprint((unsigned char)(c))
b8c5462f 877# define isPUNCT_LC(c) ispunct((unsigned char)(c))
bbce6d69 878# define toUPPER_LC(c) toupper((unsigned char)(c))
879# define toLOWER_LC(c) tolower((unsigned char)(c))
880
881# else
882
3609ea0d 883# define isALNUM_LC(c) (isascii(c) && (isalnum(c) || (c) == '_'))
bbce6d69 884# define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
885# define isALPHA_LC(c) (isascii(c) && isalpha(c))
07315176 886# define isASCII_LC(c) isascii(c)
67addccf
KW		 887# ifdef HAS_ISBLANK
888# define isBLANK_LC(c) (isascii(c) && isblank(c))
889# else
890# define isBLANK_LC(c) isBLANK(c)
891# endif
bbce6d69 892# define isSPACE_LC(c) (isascii(c) && isspace(c))
893# define isDIGIT_LC(c) (isascii(c) && isdigit(c))
894# define isUPPER_LC(c) (isascii(c) && isupper(c))
895# define isLOWER_LC(c) (isascii(c) && islower(c))
b8c5462f
JH		 896# define isALNUMC_LC(c) (isascii(c) && isalnum(c))
897# define isCNTRL_LC(c) (isascii(c) && iscntrl(c))
898# define isGRAPH_LC(c) (isascii(c) && isgraph(c))
bbce6d69 899# define isPRINT_LC(c) (isascii(c) && isprint(c))
b8c5462f 900# define isPUNCT_LC(c) (isascii(c) && ispunct(c))
bbce6d69 901# define toUPPER_LC(c) toupper(c)
902# define toLOWER_LC(c) tolower(c)
903
904# endif
a0d0e21e 905#endif /* USE_NEXT_CTYPE */
55204971 906
aaa51d5e 907#define isPSXSPC_LC(c) (isSPACE_LC(c) || (c) == '\v')
aaa51d5e 908
eb0052d1
KW		 909/* For use in the macros just below. If the input is Latin1, use the Latin1
910 * (_L1) version of the macro; otherwise use the function. Won't compile if
911 * 'c' isn't unsigned, as won't match function prototype. The macros do bounds
912 * checking, so have duplicate checks here, so could create versions of the
913 * macros that don't, but experiments show that gcc optimizes them out anyway.
914 */
915#define generic_uni(macro, function, c) ((c) < 256 \
916 ? CAT2(macro, _L1)(c) \
917 : function(c))
181ab5fd 918/* Note that all ignore 'use bytes' */
eb0052d1
KW		 919
920#define isALNUM_uni(c) generic_uni(isWORDCHAR, is_uni_alnum, c)
bdd8600f 921#define isBLANK_uni(c) generic_uni(isBLANK, is_uni_blank, c)
eb0052d1
KW		 922#define isIDFIRST_uni(c) generic_uni(isIDFIRST, is_uni_idfirst, c)
923#define isALPHA_uni(c) generic_uni(isALPHA, is_uni_alpha, c)
924#define isSPACE_uni(c) generic_uni(isSPACE, is_uni_space, c)
925#define isDIGIT_uni(c) generic_uni(isDIGIT, is_uni_digit, c)
926#define isUPPER_uni(c) generic_uni(isUPPER, is_uni_upper, c)
927#define isLOWER_uni(c) generic_uni(isLOWER, is_uni_lower, c)
141d8bad 928#define isASCII_uni(c) isASCII(c)
7b952154 929/* All controls are in Latin1 */
8ad3d40f 930#define isCNTRL_uni(c) isCNTRL_L1(c)
eb0052d1
KW		 931#define isGRAPH_uni(c) generic_uni(isGRAPH, is_uni_graph, c)
932#define isPRINT_uni(c) generic_uni(isPRINT, is_uni_print, c)
933#define isPUNCT_uni(c) generic_uni(isPUNCT, is_uni_punct, c)
934#define isXDIGIT_uni(c) generic_uni(isXDIGIT, is_uni_xdigit, c)
b18192e9
KW		 935
936/* Posix and regular space differ only in U+000B, which is in Latin1 */
937#define isPSXSPC_uni(c) ((c) < 256 ? isPSXSPC_L1(c) : isSPACE_uni(c))
938
a2a2844f
JH		 939#define toUPPER_uni(c,s,l) to_uni_upper(c,s,l)
940#define toTITLE_uni(c,s,l) to_uni_title(c,s,l)
941#define toLOWER_uni(c,s,l) to_uni_lower(c,s,l)
b8d68ded 942#define toFOLD_uni(c,s,l) to_uni_fold(c,s,l)
a0ed51b3 943
9041c2e3
NIS		 944#define isALNUM_LC_uvchr(c) (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
945#define isIDFIRST_LC_uvchr(c) (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
946#define isALPHA_LC_uvchr(c) (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
947#define isSPACE_LC_uvchr(c) (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
948#define isDIGIT_LC_uvchr(c) (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
949#define isUPPER_LC_uvchr(c) (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
950#define isLOWER_LC_uvchr(c) (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
9041c2e3
NIS		 951#define isCNTRL_LC_uvchr(c) (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
952#define isGRAPH_LC_uvchr(c) (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
953#define isPRINT_LC_uvchr(c) (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
954#define isPUNCT_LC_uvchr(c) (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
a0ed51b3 955
aaa51d5e
JF		 956#define isPSXSPC_LC_uni(c) (isSPACE_LC_uni(c) ||(c) == '\f')
957#define isBLANK_LC_uni(c) isBLANK(c) /* could be wrong */
958
c8362b00 959/* For use in the macros just below. If the input is ASCII, use the ASCII (_A)
7d7a6efc
KW		 960 * version of the macro; if the input is in the upper Latin1 range, use the
961 * Latin1 (_L1) version of the macro, after converting from utf8; otherwise use
962 * the function. This relies on the fact that ASCII characters have the same
963 * representation whether utf8 or not */
964#define generic_utf8(macro, function, p) (isASCII(*(p)) \
b18192e9 965 ? CAT2(CAT2(macro,_),A)(*(p)) \
7d7a6efc
KW		 966 : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
967 ? CAT2(macro, _L1) \
968 (TWO_BYTE_UTF8_TO_UNI(*(p), \
969 *((p)+1))) \
970 : function(p))
c8362b00 971
4b88fb76
KW		 972/* Note that all assume that the utf8 has been validated, and ignore 'use
973 * bytes' */
181ab5fd 974
c8362b00 975#define isALNUM_utf8(p) generic_utf8(isWORDCHAR, is_utf8_alnum, p)
c11ff943
KW		 976/* To prevent S_scan_word in toke.c from hanging, we have to make sure that
977 * IDFIRST is an alnum. See
c8362b00 978 * http://rt.perl.org/rt3/Ticket/Display.html?id=74022 for more detail than you
9479a769
KW		 979 * ever wanted to know about. XXX It is unclear if this should extend to
980 * isIDFIRST_uni() which it hasn't so far. (In the ASCII range, there isn't a
981 * difference.) This used to be not the XID version, but we decided to go with
982 * the more modern Unicode definition */
c8362b00
KW		 983#define isIDFIRST_utf8(p) (isASCII(*(p)) \
984 ? isIDFIRST_A(*(p)) \
7d7a6efc
KW		 985 : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \
986 ? isIDFIRST_L1(TWO_BYTE_UTF8_TO_UNI(*(p), \
987 *((p)+1)))\
4244b029 988 : Perl__is_utf8__perl_idstart(aTHX_ p))
c8362b00
KW		 989#define isIDCONT_utf8(p) generic_utf8(isWORDCHAR, is_utf8_xidcont, p)
990#define isALPHA_utf8(p) generic_utf8(isALPHA, is_utf8_alpha, p)
bdd8600f 991#define isBLANK_utf8(p) generic_utf8(isBLANK, is_utf8_blank, p)
c8362b00
KW		 992#define isSPACE_utf8(p) generic_utf8(isSPACE, is_utf8_space, p)
993#define isDIGIT_utf8(p) generic_utf8(isDIGIT, is_utf8_digit, p)
994#define isUPPER_utf8(p) generic_utf8(isUPPER, is_utf8_upper, p)
995#define isLOWER_utf8(p) generic_utf8(isLOWER, is_utf8_lower, p)
141d8bad 996/* Because ASCII is invariant under utf8, the non-utf8 macro works */
bce3d7a4 997#define isASCII_utf8(p) isASCII(*p)
c8362b00
KW		 998#define isCNTRL_utf8(p) generic_utf8(isCNTRL, is_utf8_cntrl, p)
999#define isGRAPH_utf8(p) generic_utf8(isGRAPH, is_utf8_graph, p)
1000#define isPRINT_utf8(p) generic_utf8(isPRINT, is_utf8_print, p)
1001#define isPUNCT_utf8(p) generic_utf8(isPUNCT, is_utf8_punct, p)
1002#define isXDIGIT_utf8(p) generic_utf8(isXDIGIT, is_utf8_xdigit, p)
a2a2844f
JH		 1003#define toUPPER_utf8(p,s,l) to_utf8_upper(p,s,l)
1004#define toTITLE_utf8(p,s,l) to_utf8_title(p,s,l)
1005#define toLOWER_utf8(p,s,l) to_utf8_lower(p,s,l)
a0ed51b3 1006
c8362b00
KW		 1007/* Posix and regular space differ only in U+000B, which is in ASCII (and hence
1008 * Latin1 */
1009#define isPSXSPC_utf8(p) ((isASCII(*(p))) \
1010 ? isPSXSPC_A(*(p)) \
7d7a6efc
KW		 1011 : (UTF8_IS_DOWNGRADEABLE_START(*(p)) \
1012 ? isPSXSPC_L1(TWO_BYTE_UTF8_TO_UNI(*(p), \
1013 *((p)+1)))\
1014 : isSPACE_utf8(p)))
4b88fb76
KW		 1015#define isALNUM_LC_utf8(p) isALNUM_LC_uvchr(valid_utf8_to_uvchr(p, 0))
1016#define isIDFIRST_LC_utf8(p) isIDFIRST_LC_uvchr(valid_utf8_to_uvchr(p, 0))
1017#define isALPHA_LC_utf8(p) isALPHA_LC_uvchr(valid_utf8_to_uvchr(p, 0))
bdd8600f 1018#define isBLANK_LC_utf8(p) isBLANK_LC_uvchr(valid_utf8_to_uvchr(p, 0))
4b88fb76
KW		 1019#define isSPACE_LC_utf8(p) isSPACE_LC_uvchr(valid_utf8_to_uvchr(p, 0))
1020#define isDIGIT_LC_utf8(p) isDIGIT_LC_uvchr(valid_utf8_to_uvchr(p, 0))
1021#define isUPPER_LC_utf8(p) isUPPER_LC_uvchr(valid_utf8_to_uvchr(p, 0))
1022#define isLOWER_LC_utf8(p) isLOWER_LC_uvchr(valid_utf8_to_uvchr(p, 0))
1023#define isALNUMC_LC_utf8(p) isALNUMC_LC_uvchr(valid_utf8_to_uvchr(p, 0))
1024#define isCNTRL_LC_utf8(p) isCNTRL_LC_uvchr(valid_utf8_to_uvchr(p, 0))
1025#define isGRAPH_LC_utf8(p) isGRAPH_LC_uvchr(valid_utf8_to_uvchr(p, 0))
1026#define isPRINT_LC_utf8(p) isPRINT_LC_uvchr(valid_utf8_to_uvchr(p, 0))
1027#define isPUNCT_LC_utf8(p) isPUNCT_LC_uvchr(valid_utf8_to_uvchr(p, 0))
a0ed51b3 1028
aaa51d5e 1029#define isPSXSPC_LC_utf8(c) (isSPACE_LC_utf8(c) ||(c) == '\f')
aaa51d5e 1030
6ae9f32a
KW		 1031/* This conversion works both ways, strangely enough. On EBCDIC platforms,
1032 * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII */
1033# define toCTRL(c) (toUPPER(NATIVE_TO_UNI(c)) ^ 64)
bbce6d69 1034
dea28490
JJ		 1035/* Line numbers are unsigned, 32 bits. */
1036typedef U32 line_t;
dea28490 1037#define NOLINE ((line_t) 4294967295UL)
378cc40b 1038
91152fc1
DG		 1039/* Helpful alias for version prescan */
1040#define is_LAX_VERSION(a,b) \
1041 (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
1042
1043#define is_STRICT_VERSION(a,b) \
1044 (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
1045
1046#define BADVERSION(a,b,c) \
1047 if (b) { \
1048 *b = c; \
1049 } \
1050 return a;
8c52afec 1051
8e84507e 1052/*
ccfc67b7
JH		 1053=head1 Memory Management
1054
a02a5408 1055=for apidoc Am|void|Newx|void* ptr|int nitems|type
954c1994
GS		 1056The XSUB-writer's interface to the C C<malloc> function.
1057
c5008215
JC		 1058In 5.9.3, Newx() and friends replace the older New() API, and drops
1059the first parameter, I<x>, a debug aid which allowed callers to identify
37b8b4c9 1060themselves. This aid has been superseded by a new build option,
d10b4965 1061PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>). The older API is still
c5008215
JC		 1062there for use in XS modules supporting older perls.
1063
a02a5408 1064=for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
954c1994 1065The XSUB-writer's interface to the C C<malloc> function, with
c5008215 1066cast. See also C<Newx>.
954c1994 1067
a02a5408 1068=for apidoc Am|void|Newxz|void* ptr|int nitems|type
954c1994 1069The XSUB-writer's interface to the C C<malloc> function. The allocated
c5008215 1070memory is zeroed with C<memzero>. See also C<Newx>.
a02a5408 1071
954c1994
GS		 1072=for apidoc Am|void|Renew|void* ptr|int nitems|type
1073The XSUB-writer's interface to the C C<realloc> function.
1074
1075=for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
1076The XSUB-writer's interface to the C C<realloc> function, with
1077cast.
1078
49b8b560 1079=for apidoc Am|void|Safefree|void* ptr
954c1994
GS		 1080The XSUB-writer's interface to the C C<free> function.
1081
1082=for apidoc Am|void|Move|void* src|void* dest|int nitems|type
1083The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
1084source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1085the type. Can do overlapping moves. See also C<Copy>.
1086
e90e2364
NC		 1087=for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
1088Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
1089optimise.
1090
954c1994
GS		 1091=for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
1092The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
1093source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1094the type. May fail on overlapping copies. See also C<Move>.
1095
e90e2364
NC		 1096=for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
1097
1098Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
1099optimise.
1100
954c1994
GS		 1101=for apidoc Am|void|Zero|void* dest|int nitems|type
1102
1103The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
1104destination, C<nitems> is the number of items, and C<type> is the type.
1105
e90e2364
NC		 1106=for apidoc Am|void *|ZeroD|void* dest|int nitems|type
1107
1108Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
1109optimise.
1110
da5d8dbb 1111=for apidoc Am|void|StructCopy|type *src|type *dest|type
4375e838 1112This is an architecture-independent macro to copy one structure to another.
954c1994 1113
7e337ee0
JH		 1114=for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
1115
1116Fill up memory with a byte pattern (a byte repeated over and over
1117again) that hopefully catches attempts to access uninitialized memory.
1118
1119=for apidoc Am|void|PoisonNew|void* dest|int nitems|type
1120
1121PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
1122
1c12ffb4 1123=for apidoc Am|void|PoisonFree|void* dest|int nitems|type
7e337ee0
JH		 1124
1125PoisonWith(0xEF) for catching access to freed memory.
1126
9965345d
JH		 1127=for apidoc Am|void|Poison|void* dest|int nitems|type
1128
7e337ee0 1129PoisonWith(0xEF) for catching access to freed memory.
9965345d
JH		 1130
1131=cut */
954c1994 1132
561b68a9
SH		 1133/* Maintained for backwards-compatibility only. Use newSV() instead. */
1134#ifndef PERL_CORE
ff06c60c 1135#define NEWSV(x,len) newSV(len)
561b68a9 1136#endif
ff06c60c 1137
19a94d75
JH		 1138#define MEM_SIZE_MAX ((MEM_SIZE)~0)
1139
2720f793
JH		 1140/* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
1141 * overly eager compilers that will bleat about e.g.
1142 * (U16)n > (size_t)~0/sizeof(U16) always being false. */
27d5b266 1143#ifdef PERL_MALLOC_WRAP
f019c49e
DD		 1144#define MEM_WRAP_CHECK(n,t) \
1145 (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (croak_memory_wrap(),0))
27d5b266 1146#define MEM_WRAP_CHECK_1(n,t,a) \
f1f66076 1147 (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
8b44ba4c 1148#define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
27d5b266 1149
f019c49e 1150#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		 1151#else
1152
410319be
NC		 1153#define MEM_WRAP_CHECK(n,t)
1154#define MEM_WRAP_CHECK_1(n,t,a)
1155#define MEM_WRAP_CHECK_2(n,t,a,b)
8b44ba4c
NC		 1156#define MEM_WRAP_CHECK_(n,t)
1157
6fff79ce 1158#define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
27d5b266 1159
1936d2a7 1160#endif
8b44ba4c 1161
fe4f188c 1162#ifdef PERL_MEM_LOG
46c6c7e2 1163/*
9f653bb5 1164 * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
46c6c7e2
JH		 1165 * go through functions, which are handy for debugging breakpoints, but
1166 * which more importantly get the immediate calling environment (file and
e352bcff
JH		 1167 * line number, and C function name if available) passed in. This info can
1168 * then be used for logging the calls, for which one gets a sample
73d1d973 1169 * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
3609ea0d 1170 *
46c6c7e2 1171 * Known problems:
94e892a6 1172 * - not all memory allocs get logged, only those
46c6c7e2 1173 * that go through Newx() and derivatives (while all
94e892a6 1174 * Safefrees do get logged)
46c6c7e2
JH		 1175 * - __FILE__ and __LINE__ do not work everywhere
1176 * - __func__ or __FUNCTION__ even less so
1177 * - I think more goes on after the perlio frees but
1178 * the thing is that STDERR gets closed (as do all
1179 * the file descriptors)
1180 * - no deeper calling stack than the caller of the Newx()
1181 * or the kind, but do I look like a C reflection/introspection
1182 * utility to you?
1183 * - the function prototypes for the logging functions
1184 * probably should maybe be somewhere else than handy.h
1185 * - one could consider inlining (macrofying) the logging
1186 * for speed, but I am too lazy
1187 * - one could imagine recording the allocations in a hash,
1188 * (keyed by the allocation address?), and maintain that
1189 * through reallocs and frees, but how to do that without
1190 * any News() happening...?
73d1d973 1191 * - lots of -Ddefines to get useful/controllable output
b953482e 1192 * - lots of ENV reads
46c6c7e2
JH		 1193 */
1194
12754f92 1195PERL_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 1196
12754f92 1197PERL_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 1198
12754f92 1199PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
46c6c7e2 1200
0b0ab801 1201# ifdef PERL_CORE
73d1d973 1202# ifndef PERL_MEM_LOG_NOIMPL
0b0ab801
MHM		 1203enum mem_log_type {
1204 MLT_ALLOC,
1205 MLT_REALLOC,
d7a2c63c
MHM		 1206 MLT_FREE,
1207 MLT_NEW_SV,
1208 MLT_DEL_SV
0b0ab801
MHM		 1209};
1210# endif
12754f92 1211# if defined(PERL_IN_SV_C) /* those are only used in sv.c */
d7a2c63c
MHM		 1212void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1213void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
12754f92 1214# endif
0b0ab801
MHM		 1215# endif
1216
fe4f188c
JH		 1217#endif
1218
1219#ifdef PERL_MEM_LOG
d1401ee9
MHM		 1220#define MEM_LOG_ALLOC(n,t,a) Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
1221#define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
46c6c7e2 1222#define MEM_LOG_FREE(a) Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
fe4f188c
JH		 1223#endif
1224
1225#ifndef MEM_LOG_ALLOC
1226#define MEM_LOG_ALLOC(n,t,a) (a)
1227#endif
1228#ifndef MEM_LOG_REALLOC
1229#define MEM_LOG_REALLOC(n,t,v,a) (a)
1230#endif
1231#ifndef MEM_LOG_FREE
1232#define MEM_LOG_FREE(a) (a)
1233#endif
1234
d1401ee9
MHM		 1235#define Newx(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1236#define Newxc(v,n,t,c) (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1237#define Newxz(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
a6f6820f
NC		 1238
1239#ifndef PERL_CORE
a02a5408
JC		 1240/* pre 5.9.x compatibility */
1241#define New(x,v,n,t) Newx(v,n,t)
1242#define Newc(x,v,n,t,c) Newxc(v,n,t,c)
4541904d 1243#define Newz(x,v,n,t) Newxz(v,n,t)
a6f6820f 1244#endif
a02a5408 1245
ff68c719 1246#define Renew(v,n,t) \
d1401ee9 1247 (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
ff68c719 1248#define Renewc(v,n,t,c) \
d1401ee9 1249 (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
94010e71
NC		 1250
1251#ifdef PERL_POISON
1252#define Safefree(d) \
06c0cc96 1253 ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
94010e71 1254#else
fe4f188c 1255#define Safefree(d) safefree(MEM_LOG_FREE((Malloc_t)(d)))
94010e71 1256#endif
55497cff 1257
8b44ba4c
NC		 1258#define Move(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1259#define Copy(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1260#define Zero(d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
55497cff 1261
8b44ba4c
NC		 1262#define MoveD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1263#define CopyD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
e90e2364 1264#ifdef HAS_MEMSET
8b44ba4c 1265#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
e90e2364 1266#else
8b44ba4c
NC		 1267/* Using bzero(), which returns void. */
1268#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
e90e2364
NC		 1269#endif
1270
7e337ee0
JH		 1271#define PoisonWith(d,n,t,b) (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
1272#define PoisonNew(d,n,t) PoisonWith(d,n,t,0xAB)
1273#define PoisonFree(d,n,t) PoisonWith(d,n,t,0xEF)
1274#define Poison(d,n,t) PoisonFree(d,n,t)
27d5b266 1275
2304df62 1276#ifdef USE_STRUCT_COPY
ff68c719 1277#define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
bee1dbe2
LW		 1278#else
1279#define StructCopy(s,d,t) Copy(s,d,1,t)
1280#endif
2cc61e15 1281
622913ab 1282#define C_ARRAY_LENGTH(a) (sizeof(a)/sizeof((a)[0]))
cd431fde 1283#define C_ARRAY_END(a) (a) + (sizeof(a)/sizeof((a)[0]))
622913ab 1284
2cc61e15
DD		 1285#ifdef NEED_VA_COPY
1286# ifdef va_copy
1287# define Perl_va_copy(s, d) va_copy(d, s)
2cc61e15 1288# else
a1866d1b
JH		 1289# if defined(__va_copy)
1290# define Perl_va_copy(s, d) __va_copy(d, s)
1291# else
1292# define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
1293# endif
2cc61e15
DD		 1294# endif
1295#endif
1296
472d47bc
SB		 1297/* convenience debug macros */
1298#ifdef USE_ITHREADS
1299#define pTHX_FORMAT "Perl interpreter: 0x%p"
1300#define pTHX__FORMAT ", Perl interpreter: 0x%p"
f54cb97a
AL		 1301#define pTHX_VALUE_ (void *)my_perl,
1302#define pTHX_VALUE (void *)my_perl
1303#define pTHX__VALUE_ ,(void *)my_perl,
1304#define pTHX__VALUE ,(void *)my_perl
472d47bc 1305#else
3609ea0d 1306#define pTHX_FORMAT
472d47bc 1307#define pTHX__FORMAT
3609ea0d 1308#define pTHX_VALUE_
472d47bc 1309#define pTHX_VALUE
3609ea0d 1310#define pTHX__VALUE_
472d47bc
SB		 1311#define pTHX__VALUE
1312#endif /* USE_ITHREADS */
3609ea0d 1313
2acdbac1
NC		 1314/* Perl_deprecate was not part of the public API, and did not have a deprecate()
1315 shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
1316 CPAN::Unpack show any users outside the core. */
1317#ifdef PERL_CORE
d1d15184 1318# define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
2acdbac1
NC		 1319#endif
1320
e9a8c099
MHM		 1321/*
1322 * Local variables:
1323 * c-indentation-style: bsd
1324 * c-basic-offset: 4
14d04a33 1325 * indent-tabs-mode: nil
e9a8c099
MHM		 1326 * End:
1327 *
14d04a33 1328 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 1329 */
Unnamed repository; edit this file 'description' to name the repository.