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