This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
obscure warning from Carp::Heavy
[perl5.git] / handy.h
CommitLineData
a0d0e21e 1/* handy.h
a687059c 2 *
bc89e66f 3 * Copyright (c) 1991-2001, Larry Wall
a687059c 4 *
6e21c824
LW
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
8d063cd8 7 *
8d063cd8
LW
8 */
9
85e6fe83 10#if !defined(__STDC__)
378cc40b
LW
11#ifdef NULL
12#undef NULL
13#endif
a687059c
LW
14#ifndef I286
15# define NULL 0
16#else
17# define NULL 0L
18#endif
85e6fe83
LW
19#endif
20
378cc40b 21#define Null(type) ((type)NULL)
954c1994
GS
22
23/*
24=for apidoc AmU||Nullch
25Null character pointer.
26
27=for apidoc AmU||Nullsv
28Null SV pointer.
29
30=cut
31*/
32
8d063cd8 33#define Nullch Null(char*)
760ac839 34#define Nullfp Null(PerlIO*)
79072805 35#define Nullsv Null(SV*)
8d063cd8 36
641d3f0b
PP
37#ifdef TRUE
38#undef TRUE
39#endif
40#ifdef FALSE
41#undef FALSE
42#endif
43#define TRUE (1)
44#define FALSE (0)
45
27d4fb96
PP
46
47/* XXX Configure ought to have a test for a boolean type, if I can
48 just figure out all the headers such a test needs.
49 Andy Dougherty August 1996
50*/
8e84507e 51/* bool is built-in for g++-2.6.3 and later, which might be used
c1d22f6b
GS
52 for extensions. <_G_config.h> defines _G_HAVE_BOOL, but we can't
53 be sure _G_config.h will be included before this file. _G_config.h
8e84507e 54 also defines _G_HAVE_BOOL for both gcc and g++, but only g++
c1d22f6b
GS
55 actually has bool. Hence, _G_HAVE_BOOL is pretty useless for us.
56 g++ can be identified by __GNUG__.
57 Andy Dougherty February 2000
5d94fbed 58*/
c1d22f6b 59#ifdef __GNUG__ /* GNU g++ has bool built-in */
5d94fbed 60# ifndef HAS_BOOL
c1d22f6b 61# define HAS_BOOL 1
5d94fbed 62# endif
5d94fbed
AD
63#endif
64
641d3f0b
PP
65/* The NeXT dynamic loader headers will not build with the bool macro
66 So declare them now to clear confusion.
67*/
8f1f23e8 68#if defined(NeXT) || defined(__NeXT__)
641d3f0b
PP
69# undef FALSE
70# undef TRUE
71 typedef enum bool { FALSE = 0, TRUE = 1 } bool;
72# define ENUM_BOOL 1
73# ifndef HAS_BOOL
74# define HAS_BOOL 1
75# endif /* !HAS_BOOL */
8f1f23e8 76#endif /* NeXT || __NeXT__ */
641d3f0b 77
5d94fbed 78#ifndef HAS_BOOL
61bb5906 79# if defined(UTS) || defined(VMS)
5d94fbed
AD
80# define bool int
81# else
82# define bool char
83# endif
c1d22f6b 84# define HAS_BOOL 1
a687059c 85#endif
0d3e774c 86
27d4fb96
PP
87/* XXX A note on the perl source internal type system. The
88 original intent was that I32 be *exactly* 32 bits.
89
90 Currently, we only guarantee that I32 is *at least* 32 bits.
91 Specifically, if int is 64 bits, then so is I32. (This is the case
92 for the Cray.) This has the advantage of meshing nicely with
93 standard library calls (where we pass an I32 and the library is
94 expecting an int), but the disadvantage that an I32 is not 32 bits.
95 Andy Dougherty August 1996
24fef2a7 96
dc45a647
MB
97 There is no guarantee that there is *any* integral type with
98 exactly 32 bits. It is perfectly legal for a system to have
99 sizeof(short) == sizeof(int) == sizeof(long) == 8.
693762b4 100
dc45a647
MB
101 Similarly, there is no guarantee that I16 and U16 have exactly 16
102 bits.
693762b4 103
8e84507e
NIS
104 For dealing with issues that may arise from various 32/64-bit
105 systems, we will ask Configure to check out
8175356b 106
dc45a647
MB
107 SHORTSIZE == sizeof(short)
108 INTSIZE == sizeof(int)
109 LONGSIZE == sizeof(long)
110 LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
111 PTRSIZE == sizeof(void *)
112 DOUBLESIZE == sizeof(double)
113 LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
8175356b 114
27d4fb96
PP
115*/
116
69512466
JH
117#ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
118# include <inttypes.h>
dd0eed91
JH
119# ifdef INT32_MIN_BROKEN
120# undef INT32_MIN
121# define INT32_MIN (-2147483647-1)
122# endif
123# ifdef INT64_MIN_BROKEN
124# undef INT64_MIN
125# define INT64_MIN (-9223372036854775807LL-1)
126# endif
69512466
JH
127#endif
128
8175356b
JH
129typedef I8TYPE I8;
130typedef U8TYPE U8;
131typedef I16TYPE I16;
132typedef U16TYPE U16;
133typedef I32TYPE I32;
134typedef U32TYPE U32;
6b8eaf93
JH
135#ifdef PERL_CORE
136# ifdef HAS_QUAD
8175356b
JH
137typedef I64TYPE I64;
138typedef U64TYPE U64;
6b8eaf93
JH
139# endif
140#endif /* PERL_CORE */
8175356b 141
69512466
JH
142#if defined(HAS_QUAD) && defined(USE_64_BIT_INT)
143# ifndef UINT64_C /* usually from <inttypes.h> */
144# if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
145# define INT64_C(c) CAT2(c,LL)
146# define UINT64_C(c) CAT2(c,ULL)
147# else
148# if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
149# define INT64_C(c) CAT2(c,L)
150# define UINT64_C(c) CAT2(c,UL)
151# else
152# define INT64_C(c) ((I64TYPE)(c))
153# define UINT64_C(c) ((U64TYPE)(c))
154# endif
155# endif
e8c95190
JH
156# endif
157#endif
158
a22e52b9
JH
159/* Mention I8SIZE, U8SIZE, I16SIZE, U16SIZE, I32SIZE, U32SIZE,
160 I64SIZE, and U64SIZE here so that metaconfig pulls them in. */
161
d8668976 162#if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
5ff3f7a4 163
5ff3f7a4
GS
164/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
165 Please search CHAR_MAX in perl.h for further details. */
166#define U8_MAX UINT8_MAX
167#define U8_MIN UINT8_MIN
168
5ff3f7a4
GS
169#define I16_MAX INT16_MAX
170#define I16_MIN INT16_MIN
171#define U16_MAX UINT16_MAX
172#define U16_MIN UINT16_MIN
173
5ff3f7a4
GS
174#define I32_MAX INT32_MAX
175#define I32_MIN INT32_MIN
176#define U32_MAX UINT32_MAX
177#define U32_MIN UINT32_MIN
178
179#else
180
5c9fa16e
KA
181/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
182 Please search CHAR_MAX in perl.h for further details. */
27d4fb96
PP
183#define U8_MAX PERL_UCHAR_MAX
184#define U8_MIN PERL_UCHAR_MIN
79072805 185
27d4fb96
PP
186#define I16_MAX PERL_SHORT_MAX
187#define I16_MIN PERL_SHORT_MIN
188#define U16_MAX PERL_USHORT_MAX
189#define U16_MIN PERL_USHORT_MIN
79072805 190
c4f23d77 191#if LONGSIZE > 4
27d4fb96
PP
192# define I32_MAX PERL_INT_MAX
193# define I32_MIN PERL_INT_MIN
194# define U32_MAX PERL_UINT_MAX
195# define U32_MIN PERL_UINT_MIN
79072805 196#else
27d4fb96
PP
197# define I32_MAX PERL_LONG_MAX
198# define I32_MIN PERL_LONG_MIN
199# define U32_MAX PERL_ULONG_MAX
200# define U32_MIN PERL_ULONG_MIN
79072805
LW
201#endif
202
5ff3f7a4
GS
203#endif
204
58a9a5d5 205/* log(2) is pretty close to 0.30103, just in case anyone is grepping for it */
fc36a67e
PP
206#define BIT_DIGITS(N) (((N)*146)/485 + 1) /* log2(10) =~ 146/485 */
207#define TYPE_DIGITS(T) BIT_DIGITS(sizeof(T) * 8)
208#define TYPE_CHARS(T) (TYPE_DIGITS(T) + 2) /* sign, NUL */
209
ff68c719 210#define Ctl(ch) ((ch) & 037)
8d063cd8 211
954c1994
GS
212/*
213=for apidoc Am|bool|strNE|char* s1|char* s2
214Test two strings to see if they are different. Returns true or
215false.
216
217=for apidoc Am|bool|strEQ|char* s1|char* s2
218Test two strings to see if they are equal. Returns true or false.
219
220=for apidoc Am|bool|strLT|char* s1|char* s2
221Test two strings to see if the first, C<s1>, is less than the second,
222C<s2>. Returns true or false.
223
224=for apidoc Am|bool|strLE|char* s1|char* s2
225Test two strings to see if the first, C<s1>, is less than or equal to the
226second, C<s2>. Returns true or false.
227
228=for apidoc Am|bool|strGT|char* s1|char* s2
229Test two strings to see if the first, C<s1>, is greater than the second,
230C<s2>. Returns true or false.
231
232=for apidoc Am|bool|strGE|char* s1|char* s2
233Test two strings to see if the first, C<s1>, is greater than or equal to
234the second, C<s2>. Returns true or false.
235
236=for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
237Test two strings to see if they are different. The C<len> parameter
238indicates the number of bytes to compare. Returns true or false. (A
239wrapper for C<strncmp>).
240
241=for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
242Test two strings to see if they are equal. The C<len> parameter indicates
243the number of bytes to compare. Returns true or false. (A wrapper for
244C<strncmp>).
245
246=cut
247*/
248
8d063cd8
LW
249#define strNE(s1,s2) (strcmp(s1,s2))
250#define strEQ(s1,s2) (!strcmp(s1,s2))
251#define strLT(s1,s2) (strcmp(s1,s2) < 0)
252#define strLE(s1,s2) (strcmp(s1,s2) <= 0)
253#define strGT(s1,s2) (strcmp(s1,s2) > 0)
254#define strGE(s1,s2) (strcmp(s1,s2) >= 0)
255#define strnNE(s1,s2,l) (strncmp(s1,s2,l))
256#define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
378cc40b 257
36477c24
PP
258#ifdef HAS_MEMCMP
259# define memNE(s1,s2,l) (memcmp(s1,s2,l))
260# define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
261#else
262# define memNE(s1,s2,l) (bcmp(s1,s2,l))
263# define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
264#endif
265
bbce6d69
PP
266/*
267 * Character classes.
268 *
269 * Unfortunately, the introduction of locales means that we
270 * can't trust isupper(), etc. to tell the truth. And when
271 * it comes to /\w+/ with tainting enabled, we *must* be able
272 * to trust our character classes.
273 *
274 * Therefore, the default tests in the text of Perl will be
275 * independent of locale. Any code that wants to depend on
276 * the current locale will use the tests that begin with "lc".
277 */
278
2304df62
AD
279#ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */
280# ifndef CTYPE256
281# define CTYPE256
282# endif
283#endif
284
954c1994
GS
285/*
286=for apidoc Am|bool|isALNUM|char ch
4375e838 287Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
f1cbbd6e 288character (including underscore) or digit.
954c1994
GS
289
290=for apidoc Am|bool|isALPHA|char ch
4375e838 291Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
954c1994
GS
292character.
293
294=for apidoc Am|bool|isSPACE|char ch
295Returns a boolean indicating whether the C C<char> is whitespace.
296
297=for apidoc Am|bool|isDIGIT|char ch
4375e838 298Returns a boolean indicating whether the C C<char> is an ASCII
954c1994
GS
299digit.
300
301=for apidoc Am|bool|isUPPER|char ch
302Returns a boolean indicating whether the C C<char> is an uppercase
303character.
304
305=for apidoc Am|bool|isLOWER|char ch
306Returns a boolean indicating whether the C C<char> is a lowercase
307character.
308
309=for apidoc Am|char|toUPPER|char ch
310Converts the specified character to uppercase.
311
312=for apidoc Am|char|toLOWER|char ch
313Converts the specified character to lowercase.
314
315=cut
316*/
317
bbce6d69
PP
318#define isALNUM(c) (isALPHA(c) || isDIGIT(c) || (c) == '_')
319#define isIDFIRST(c) (isALPHA(c) || (c) == '_')
320#define isALPHA(c) (isUPPER(c) || isLOWER(c))
321#define isSPACE(c) \
322 ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
aaa51d5e
JF
323#define isPSXSPC(c) (isSPACE(c) || (c) == '\v')
324#define isBLANK(c) ((c) == ' ' || (c) == '\t')
bbce6d69 325#define isDIGIT(c) ((c) >= '0' && (c) <= '9')
9d116dd7
JH
326#ifdef EBCDIC
327 /* In EBCDIC we do not do locales: therefore() isupper() is fine. */
328# define isUPPER(c) isupper(c)
329# define isLOWER(c) islower(c)
b8c5462f
JH
330# define isALNUMC(c) isalnum(c)
331# define isASCII(c) isascii(c)
332# define isCNTRL(c) iscntrl(c)
333# define isGRAPH(c) isgraph(c)
9d116dd7 334# define isPRINT(c) isprint(c)
b8c5462f
JH
335# define isPUNCT(c) ispunct(c)
336# define isXDIGIT(c) isxdigit(c)
9d116dd7
JH
337# define toUPPER(c) toupper(c)
338# define toLOWER(c) tolower(c)
339#else
340# define isUPPER(c) ((c) >= 'A' && (c) <= 'Z')
341# define isLOWER(c) ((c) >= 'a' && (c) <= 'z')
b8c5462f
JH
342# define isALNUMC(c) (isALPHA(c) || isDIGIT(c))
343# define isASCII(c) ((c) <= 127)
7be5a6cf 344# define isCNTRL(c) ((c) < ' ' || (c) == 127)
b8c5462f 345# define isGRAPH(c) (isALNUM(c) || isPUNCT(c))
f79b3095 346# define isPRINT(c) (((c) > 32 && (c) < 127) || (c) == ' ')
b8c5462f
JH
347# define isPUNCT(c) (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64) || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
348# define isXDIGIT(c) (isdigit(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F'))
9d116dd7
JH
349# define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c))
350# define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c))
351#endif
bbce6d69
PP
352
353#ifdef USE_NEXT_CTYPE
354
355# define isALNUM_LC(c) \
37bd1396 356 (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
ff68c719
PP
357# define isIDFIRST_LC(c) \
358 (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
359# define isALPHA_LC(c) NXIsAlpha((unsigned int)(c))
360# define isSPACE_LC(c) NXIsSpace((unsigned int)(c))
361# define isDIGIT_LC(c) NXIsDigit((unsigned int)(c))
362# define isUPPER_LC(c) NXIsUpper((unsigned int)(c))
363# define isLOWER_LC(c) NXIsLower((unsigned int)(c))
37bd1396 364# define isALNUMC_LC(c) NXIsAlNum((unsigned int)(c))
b8c5462f
JH
365# define isCNTRL_LC(c) NXIsCntrl((unsigned int)(c))
366# define isGRAPH_LC(c) NXIsGraph((unsigned int)(c))
ff68c719 367# define isPRINT_LC(c) NXIsPrint((unsigned int)(c))
b8c5462f 368# define isPUNCT_LC(c) NXIsPunct((unsigned int)(c))
ff68c719
PP
369# define toUPPER_LC(c) NXToUpper((unsigned int)(c))
370# define toLOWER_LC(c) NXToLower((unsigned int)(c))
bbce6d69
PP
371
372#else /* !USE_NEXT_CTYPE */
b8c5462f 373
bbce6d69
PP
374# if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
375
b8c5462f 376# define isALNUM_LC(c) (isalnum((unsigned char)(c)) || (char)(c) == '_')
ff68c719 377# define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
bbce6d69
PP
378# define isALPHA_LC(c) isalpha((unsigned char)(c))
379# define isSPACE_LC(c) isspace((unsigned char)(c))
380# define isDIGIT_LC(c) isdigit((unsigned char)(c))
381# define isUPPER_LC(c) isupper((unsigned char)(c))
382# define isLOWER_LC(c) islower((unsigned char)(c))
b8c5462f
JH
383# define isALNUMC_LC(c) isalnum((unsigned char)(c))
384# define isCNTRL_LC(c) iscntrl((unsigned char)(c))
385# define isGRAPH_LC(c) isgraph((unsigned char)(c))
bbce6d69 386# define isPRINT_LC(c) isprint((unsigned char)(c))
b8c5462f 387# define isPUNCT_LC(c) ispunct((unsigned char)(c))
bbce6d69
PP
388# define toUPPER_LC(c) toupper((unsigned char)(c))
389# define toLOWER_LC(c) tolower((unsigned char)(c))
390
391# else
392
b8c5462f 393# define isALNUM_LC(c) (isascii(c) && (isalnum(c) || (c) == '_'))
bbce6d69
PP
394# define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
395# define isALPHA_LC(c) (isascii(c) && isalpha(c))
396# define isSPACE_LC(c) (isascii(c) && isspace(c))
397# define isDIGIT_LC(c) (isascii(c) && isdigit(c))
398# define isUPPER_LC(c) (isascii(c) && isupper(c))
399# define isLOWER_LC(c) (isascii(c) && islower(c))
b8c5462f
JH
400# define isALNUMC_LC(c) (isascii(c) && isalnum(c))
401# define isCNTRL_LC(c) (isascii(c) && iscntrl(c))
402# define isGRAPH_LC(c) (isascii(c) && isgraph(c))
bbce6d69 403# define isPRINT_LC(c) (isascii(c) && isprint(c))
b8c5462f 404# define isPUNCT_LC(c) (isascii(c) && ispunct(c))
bbce6d69
PP
405# define toUPPER_LC(c) toupper(c)
406# define toLOWER_LC(c) tolower(c)
407
408# endif
a0d0e21e 409#endif /* USE_NEXT_CTYPE */
55204971 410
aaa51d5e
JF
411#define isPSXSPC_LC(c) (isSPACE_LC(c) || (c) == '\v')
412#define isBLANK_LC(c) isBLANK(c) /* could be wrong */
413
a0ed51b3
LW
414#define isALNUM_uni(c) is_uni_alnum(c)
415#define isIDFIRST_uni(c) is_uni_idfirst(c)
416#define isALPHA_uni(c) is_uni_alpha(c)
417#define isSPACE_uni(c) is_uni_space(c)
418#define isDIGIT_uni(c) is_uni_digit(c)
419#define isUPPER_uni(c) is_uni_upper(c)
420#define isLOWER_uni(c) is_uni_lower(c)
b8c5462f
JH
421#define isALNUMC_uni(c) is_uni_alnumc(c)
422#define isASCII_uni(c) is_uni_ascii(c)
423#define isCNTRL_uni(c) is_uni_cntrl(c)
424#define isGRAPH_uni(c) is_uni_graph(c)
a0ed51b3 425#define isPRINT_uni(c) is_uni_print(c)
b8c5462f
JH
426#define isPUNCT_uni(c) is_uni_punct(c)
427#define isXDIGIT_uni(c) is_uni_xdigit(c)
a2a2844f
JH
428#define toUPPER_uni(c,s,l) to_uni_upper(c,s,l)
429#define toTITLE_uni(c,s,l) to_uni_title(c,s,l)
430#define toLOWER_uni(c,s,l) to_uni_lower(c,s,l)
b8d68ded 431#define toFOLD_uni(c,s,l) to_uni_fold(c,s,l)
a0ed51b3 432
aaa51d5e
JF
433#define isPSXSPC_uni(c) (isSPACE_uni(c) ||(c) == '\f')
434#define isBLANK_uni(c) isBLANK(c) /* could be wrong */
435
9041c2e3
NIS
436#define isALNUM_LC_uvchr(c) (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
437#define isIDFIRST_LC_uvchr(c) (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
438#define isALPHA_LC_uvchr(c) (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
439#define isSPACE_LC_uvchr(c) (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
440#define isDIGIT_LC_uvchr(c) (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
441#define isUPPER_LC_uvchr(c) (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
442#define isLOWER_LC_uvchr(c) (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
443#define isALNUMC_LC_uvchr(c) (c < 256 ? isALNUMC_LC(c) : is_uni_alnumc_lc(c))
444#define isCNTRL_LC_uvchr(c) (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
445#define isGRAPH_LC_uvchr(c) (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
446#define isPRINT_LC_uvchr(c) (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
447#define isPUNCT_LC_uvchr(c) (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
a0ed51b3 448
aaa51d5e
JF
449#define isPSXSPC_LC_uni(c) (isSPACE_LC_uni(c) ||(c) == '\f')
450#define isBLANK_LC_uni(c) isBLANK(c) /* could be wrong */
451
a0ed51b3
LW
452#define isALNUM_utf8(p) is_utf8_alnum(p)
453#define isIDFIRST_utf8(p) is_utf8_idfirst(p)
454#define isALPHA_utf8(p) is_utf8_alpha(p)
455#define isSPACE_utf8(p) is_utf8_space(p)
456#define isDIGIT_utf8(p) is_utf8_digit(p)
457#define isUPPER_utf8(p) is_utf8_upper(p)
458#define isLOWER_utf8(p) is_utf8_lower(p)
b8c5462f
JH
459#define isALNUMC_utf8(p) is_utf8_alnumc(p)
460#define isASCII_utf8(p) is_utf8_ascii(p)
461#define isCNTRL_utf8(p) is_utf8_cntrl(p)
462#define isGRAPH_utf8(p) is_utf8_graph(p)
a0ed51b3 463#define isPRINT_utf8(p) is_utf8_print(p)
b8c5462f
JH
464#define isPUNCT_utf8(p) is_utf8_punct(p)
465#define isXDIGIT_utf8(p) is_utf8_xdigit(p)
a2a2844f
JH
466#define toUPPER_utf8(p,s,l) to_utf8_upper(p,s,l)
467#define toTITLE_utf8(p,s,l) to_utf8_title(p,s,l)
468#define toLOWER_utf8(p,s,l) to_utf8_lower(p,s,l)
a0ed51b3 469
aaa51d5e
JF
470#define isPSXSPC_utf8(c) (isSPACE_utf8(c) ||(c) == '\f')
471#define isBLANK_utf8(c) isBLANK(c) /* could be wrong */
472
9041c2e3
NIS
473#define isALNUM_LC_utf8(p) isALNUM_LC_uvchr(utf8_to_uvchr(p, 0))
474#define isIDFIRST_LC_utf8(p) isIDFIRST_LC_uvchr(utf8_to_uvchr(p, 0))
475#define isALPHA_LC_utf8(p) isALPHA_LC_uvchr(utf8_to_uvchr(p, 0))
476#define isSPACE_LC_utf8(p) isSPACE_LC_uvchr(utf8_to_uvchr(p, 0))
477#define isDIGIT_LC_utf8(p) isDIGIT_LC_uvchr(utf8_to_uvchr(p, 0))
478#define isUPPER_LC_utf8(p) isUPPER_LC_uvchr(utf8_to_uvchr(p, 0))
479#define isLOWER_LC_utf8(p) isLOWER_LC_uvchr(utf8_to_uvchr(p, 0))
480#define isALNUMC_LC_utf8(p) isALNUMC_LC_uvchr(utf8_to_uvchr(p, 0))
481#define isCNTRL_LC_utf8(p) isCNTRL_LC_uvchr(utf8_to_uvchr(p, 0))
482#define isGRAPH_LC_utf8(p) isGRAPH_LC_uvchr(utf8_to_uvchr(p, 0))
483#define isPRINT_LC_utf8(p) isPRINT_LC_uvchr(utf8_to_uvchr(p, 0))
484#define isPUNCT_LC_utf8(p) isPUNCT_LC_uvchr(utf8_to_uvchr(p, 0))
a0ed51b3 485
aaa51d5e
JF
486#define isPSXSPC_LC_utf8(c) (isSPACE_LC_utf8(c) ||(c) == '\f')
487#define isBLANK_LC_utf8(c) isBLANK(c) /* could be wrong */
488
9d116dd7 489#ifdef EBCDIC
cbebf344 490# define toCTRL(c) Perl_ebcdic_control(c)
9d116dd7
JH
491#else
492 /* This conversion works both ways, strangely enough. */
493# define toCTRL(c) (toUPPER(c) ^ 64)
494#endif
bbce6d69 495
378cc40b 496/* Line numbers are unsigned, 16 bits. */
79072805 497typedef U16 line_t;
378cc40b
LW
498#ifdef lint
499#define NOLINE ((line_t)0)
500#else
501#define NOLINE ((line_t) 65535)
502#endif
503
8c52afec 504
8e84507e 505/*
8c52afec 506 XXX LEAKTEST doesn't really work in perl5. There are direct calls to
27d4fb96 507 safemalloc() in the source, so LEAKTEST won't pick them up.
c1d22f6b 508 (The main "offenders" are extensions.)
27d4fb96
PP
509 Further, if you try LEAKTEST, you'll also end up calling
510 Safefree, which might call safexfree() on some things that weren't
511 malloced with safexmalloc. The correct "fix" to this, if anyone
512 is interested, is to ensure that all calls go through the New and
513 Renew macros.
514 --Andy Dougherty August 1996
515*/
55497cff 516
954c1994
GS
517/*
518=for apidoc Am|SV*|NEWSV|int id|STRLEN len
519Creates a new SV. A non-zero C<len> parameter indicates the number of
520bytes of preallocated string space the SV should have. An extra byte for a
521tailing NUL is also reserved. (SvPOK is not set for the SV even if string
8e84507e 522space is allocated.) The reference count for the new SV is set to 1.
954c1994
GS
523C<id> is an integer id between 0 and 1299 (used to identify leaks).
524
525=for apidoc Am|void|New|int id|void* ptr|int nitems|type
526The XSUB-writer's interface to the C C<malloc> function.
527
528=for apidoc Am|void|Newc|int id|void* ptr|int nitems|type|cast
529The XSUB-writer's interface to the C C<malloc> function, with
530cast.
531
532=for apidoc Am|void|Newz|int id|void* ptr|int nitems|type
533The XSUB-writer's interface to the C C<malloc> function. The allocated
534memory is zeroed with C<memzero>.
535
536=for apidoc Am|void|Renew|void* ptr|int nitems|type
537The XSUB-writer's interface to the C C<realloc> function.
538
539=for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
540The XSUB-writer's interface to the C C<realloc> function, with
541cast.
542
49b8b560 543=for apidoc Am|void|Safefree|void* ptr
954c1994
GS
544The XSUB-writer's interface to the C C<free> function.
545
546=for apidoc Am|void|Move|void* src|void* dest|int nitems|type
547The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
548source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
549the type. Can do overlapping moves. See also C<Copy>.
550
551=for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
552The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
553source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
554the type. May fail on overlapping copies. See also C<Move>.
555
556=for apidoc Am|void|Zero|void* dest|int nitems|type
557
558The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
559destination, C<nitems> is the number of items, and C<type> is the type.
560
561=for apidoc Am|void|StructCopy|type src|type dest|type
4375e838 562This is an architecture-independent macro to copy one structure to another.
954c1994
GS
563
564=cut
565*/
566
a687059c 567#ifndef lint
ff06c60c
IZ
568
569#define NEWSV(x,len) newSV(len)
570
a687059c 571#ifndef LEAKTEST
598a3d64 572
ff68c719
PP
573#define New(x,v,n,t) (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
574#define Newc(x,v,n,t,c) (v = (c*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
575#define Newz(x,v,n,t) (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))), \
576 memzero((char*)(v), (n)*sizeof(t))
577#define Renew(v,n,t) \
578 (v = (t*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
579#define Renewc(v,n,t,c) \
580 (v = (c*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
581#define Safefree(d) safefree((Malloc_t)(d))
55497cff 582
a687059c 583#else /* LEAKTEST */
55497cff 584
ff68c719
PP
585#define New(x,v,n,t) (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
586#define Newc(x,v,n,t,c) (v = (c*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
587#define Newz(x,v,n,t) (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t)))), \
588 memzero((char*)(v), (n)*sizeof(t))
589#define Renew(v,n,t) \
590 (v = (t*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
591#define Renewc(v,n,t,c) \
592 (v = (c*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
8c52afec 593#define Safefree(d) safexfree((Malloc_t)(d))
ff68c719 594
fc36a67e 595#define MAXXCOUNT 1400
8c52afec
IZ
596#define MAXY_SIZE 80
597#define MAXYCOUNT 16 /* (MAXY_SIZE/4 + 1) */
598extern long xcount[MAXXCOUNT];
599extern long lastxcount[MAXXCOUNT];
600extern long xycount[MAXXCOUNT][MAXYCOUNT];
601extern long lastxycount[MAXXCOUNT][MAXYCOUNT];
55497cff 602
a687059c 603#endif /* LEAKTEST */
55497cff 604
ff68c719
PP
605#define Move(s,d,n,t) (void)memmove((char*)(d),(char*)(s), (n) * sizeof(t))
606#define Copy(s,d,n,t) (void)memcpy((char*)(d),(char*)(s), (n) * sizeof(t))
607#define Zero(d,n,t) (void)memzero((char*)(d), (n) * sizeof(t))
55497cff 608
a687059c 609#else /* lint */
55497cff 610
ff68c719
PP
611#define New(x,v,n,s) (v = Null(s *))
612#define Newc(x,v,n,s,c) (v = Null(s *))
613#define Newz(x,v,n,s) (v = Null(s *))
614#define Renew(v,n,s) (v = Null(s *))
bee1dbe2 615#define Move(s,d,n,t)
a687059c
LW
616#define Copy(s,d,n,t)
617#define Zero(d,n,t)
ff68c719 618#define Safefree(d) (d) = (d)
55497cff 619
a687059c 620#endif /* lint */
bee1dbe2 621
2304df62 622#ifdef USE_STRUCT_COPY
ff68c719 623#define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
bee1dbe2
LW
624#else
625#define StructCopy(s,d,t) Copy(s,d,1,t)
626#endif
2cc61e15
DD
627
628#ifdef NEED_VA_COPY
629# ifdef va_copy
630# define Perl_va_copy(s, d) va_copy(d, s)
2cc61e15 631# else
a1866d1b
JH
632# if defined(__va_copy)
633# define Perl_va_copy(s, d) __va_copy(d, s)
634# else
635# define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
636# endif
2cc61e15
DD
637# endif
638#endif
639