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