This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Integrate scope.h@7790 from perlio, works better with multiplicity.
[perl5.git] / handy.h
CommitLineData
a0d0e21e 1/* handy.h
a687059c 2 *
3818b22b 3 * Copyright (c) 1991-2000, 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>
119#endif
120
8175356b
JH
121typedef I8TYPE I8;
122typedef U8TYPE U8;
123typedef I16TYPE I16;
124typedef U16TYPE U16;
125typedef I32TYPE I32;
126typedef U32TYPE U32;
6b8eaf93
JH
127#ifdef PERL_CORE
128# ifdef HAS_QUAD
8175356b
JH
129typedef I64TYPE I64;
130typedef U64TYPE U64;
6b8eaf93
JH
131# endif
132#endif /* PERL_CORE */
8175356b 133
69512466
JH
134#if defined(HAS_QUAD) && defined(USE_64_BIT_INT)
135# ifndef UINT64_C /* usually from <inttypes.h> */
136# if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
137# define INT64_C(c) CAT2(c,LL)
138# define UINT64_C(c) CAT2(c,ULL)
139# else
140# if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
141# define INT64_C(c) CAT2(c,L)
142# define UINT64_C(c) CAT2(c,UL)
143# else
144# define INT64_C(c) ((I64TYPE)(c))
145# define UINT64_C(c) ((U64TYPE)(c))
146# endif
147# endif
e8c95190
JH
148# endif
149#endif
150
a22e52b9
JH
151/* Mention I8SIZE, U8SIZE, I16SIZE, U16SIZE, I32SIZE, U32SIZE,
152 I64SIZE, and U64SIZE here so that metaconfig pulls them in. */
153
d8668976 154#if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
5ff3f7a4 155
5ff3f7a4
GS
156/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
157 Please search CHAR_MAX in perl.h for further details. */
158#define U8_MAX UINT8_MAX
159#define U8_MIN UINT8_MIN
160
5ff3f7a4
GS
161#define I16_MAX INT16_MAX
162#define I16_MIN INT16_MIN
163#define U16_MAX UINT16_MAX
164#define U16_MIN UINT16_MIN
165
5ff3f7a4
GS
166#define I32_MAX INT32_MAX
167#define I32_MIN INT32_MIN
168#define U32_MAX UINT32_MAX
169#define U32_MIN UINT32_MIN
170
171#else
172
5c9fa16e
KA
173/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
174 Please search CHAR_MAX in perl.h for further details. */
27d4fb96
PP
175#define U8_MAX PERL_UCHAR_MAX
176#define U8_MIN PERL_UCHAR_MIN
79072805 177
27d4fb96
PP
178#define I16_MAX PERL_SHORT_MAX
179#define I16_MIN PERL_SHORT_MIN
180#define U16_MAX PERL_USHORT_MAX
181#define U16_MIN PERL_USHORT_MIN
79072805 182
c4f23d77 183#if LONGSIZE > 4
27d4fb96
PP
184# define I32_MAX PERL_INT_MAX
185# define I32_MIN PERL_INT_MIN
186# define U32_MAX PERL_UINT_MAX
187# define U32_MIN PERL_UINT_MIN
79072805 188#else
27d4fb96
PP
189# define I32_MAX PERL_LONG_MAX
190# define I32_MIN PERL_LONG_MIN
191# define U32_MAX PERL_ULONG_MAX
192# define U32_MIN PERL_ULONG_MIN
79072805
LW
193#endif
194
5ff3f7a4
GS
195#endif
196
fc36a67e
PP
197#define BIT_DIGITS(N) (((N)*146)/485 + 1) /* log2(10) =~ 146/485 */
198#define TYPE_DIGITS(T) BIT_DIGITS(sizeof(T) * 8)
199#define TYPE_CHARS(T) (TYPE_DIGITS(T) + 2) /* sign, NUL */
200
ff68c719 201#define Ctl(ch) ((ch) & 037)
8d063cd8 202
954c1994
GS
203/*
204=for apidoc Am|bool|strNE|char* s1|char* s2
205Test two strings to see if they are different. Returns true or
206false.
207
208=for apidoc Am|bool|strEQ|char* s1|char* s2
209Test two strings to see if they are equal. Returns true or false.
210
211=for apidoc Am|bool|strLT|char* s1|char* s2
212Test two strings to see if the first, C<s1>, is less than the second,
213C<s2>. Returns true or false.
214
215=for apidoc Am|bool|strLE|char* s1|char* s2
216Test two strings to see if the first, C<s1>, is less than or equal to the
217second, C<s2>. Returns true or false.
218
219=for apidoc Am|bool|strGT|char* s1|char* s2
220Test two strings to see if the first, C<s1>, is greater than the second,
221C<s2>. Returns true or false.
222
223=for apidoc Am|bool|strGE|char* s1|char* s2
224Test two strings to see if the first, C<s1>, is greater than or equal to
225the second, C<s2>. Returns true or false.
226
227=for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
228Test two strings to see if they are different. The C<len> parameter
229indicates the number of bytes to compare. Returns true or false. (A
230wrapper for C<strncmp>).
231
232=for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
233Test two strings to see if they are equal. The C<len> parameter indicates
234the number of bytes to compare. Returns true or false. (A wrapper for
235C<strncmp>).
236
237=cut
238*/
239
8d063cd8
LW
240#define strNE(s1,s2) (strcmp(s1,s2))
241#define strEQ(s1,s2) (!strcmp(s1,s2))
242#define strLT(s1,s2) (strcmp(s1,s2) < 0)
243#define strLE(s1,s2) (strcmp(s1,s2) <= 0)
244#define strGT(s1,s2) (strcmp(s1,s2) > 0)
245#define strGE(s1,s2) (strcmp(s1,s2) >= 0)
246#define strnNE(s1,s2,l) (strncmp(s1,s2,l))
247#define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
378cc40b 248
36477c24
PP
249#ifdef HAS_MEMCMP
250# define memNE(s1,s2,l) (memcmp(s1,s2,l))
251# define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
252#else
253# define memNE(s1,s2,l) (bcmp(s1,s2,l))
254# define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
255#endif
256
bbce6d69
PP
257/*
258 * Character classes.
259 *
260 * Unfortunately, the introduction of locales means that we
261 * can't trust isupper(), etc. to tell the truth. And when
262 * it comes to /\w+/ with tainting enabled, we *must* be able
263 * to trust our character classes.
264 *
265 * Therefore, the default tests in the text of Perl will be
266 * independent of locale. Any code that wants to depend on
267 * the current locale will use the tests that begin with "lc".
268 */
269
2304df62
AD
270#ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */
271# ifndef CTYPE256
272# define CTYPE256
273# endif
274#endif
275
954c1994
GS
276/*
277=for apidoc Am|bool|isALNUM|char ch
4375e838 278Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
f1cbbd6e 279character (including underscore) or digit.
954c1994
GS
280
281=for apidoc Am|bool|isALPHA|char ch
4375e838 282Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
954c1994
GS
283character.
284
285=for apidoc Am|bool|isSPACE|char ch
286Returns a boolean indicating whether the C C<char> is whitespace.
287
288=for apidoc Am|bool|isDIGIT|char ch
4375e838 289Returns a boolean indicating whether the C C<char> is an ASCII
954c1994
GS
290digit.
291
292=for apidoc Am|bool|isUPPER|char ch
293Returns a boolean indicating whether the C C<char> is an uppercase
294character.
295
296=for apidoc Am|bool|isLOWER|char ch
297Returns a boolean indicating whether the C C<char> is a lowercase
298character.
299
300=for apidoc Am|char|toUPPER|char ch
301Converts the specified character to uppercase.
302
303=for apidoc Am|char|toLOWER|char ch
304Converts the specified character to lowercase.
305
306=cut
307*/
308
bbce6d69
PP
309#define isALNUM(c) (isALPHA(c) || isDIGIT(c) || (c) == '_')
310#define isIDFIRST(c) (isALPHA(c) || (c) == '_')
311#define isALPHA(c) (isUPPER(c) || isLOWER(c))
312#define isSPACE(c) \
313 ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
aaa51d5e
JF
314#define isPSXSPC(c) (isSPACE(c) || (c) == '\v')
315#define isBLANK(c) ((c) == ' ' || (c) == '\t')
bbce6d69 316#define isDIGIT(c) ((c) >= '0' && (c) <= '9')
9d116dd7
JH
317#ifdef EBCDIC
318 /* In EBCDIC we do not do locales: therefore() isupper() is fine. */
319# define isUPPER(c) isupper(c)
320# define isLOWER(c) islower(c)
b8c5462f
JH
321# define isALNUMC(c) isalnum(c)
322# define isASCII(c) isascii(c)
323# define isCNTRL(c) iscntrl(c)
324# define isGRAPH(c) isgraph(c)
9d116dd7 325# define isPRINT(c) isprint(c)
b8c5462f
JH
326# define isPUNCT(c) ispunct(c)
327# define isXDIGIT(c) isxdigit(c)
9d116dd7
JH
328# define toUPPER(c) toupper(c)
329# define toLOWER(c) tolower(c)
330#else
331# define isUPPER(c) ((c) >= 'A' && (c) <= 'Z')
332# define isLOWER(c) ((c) >= 'a' && (c) <= 'z')
b8c5462f
JH
333# define isALNUMC(c) (isALPHA(c) || isDIGIT(c))
334# define isASCII(c) ((c) <= 127)
335# define isCNTRL(c) ((c) < ' ')
336# define isGRAPH(c) (isALNUM(c) || isPUNCT(c))
9d116dd7 337# define isPRINT(c) (((c) > 32 && (c) < 127) || isSPACE(c))
b8c5462f
JH
338# define isPUNCT(c) (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64) || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
339# define isXDIGIT(c) (isdigit(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F'))
9d116dd7
JH
340# define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c))
341# define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c))
342#endif
bbce6d69
PP
343
344#ifdef USE_NEXT_CTYPE
345
346# define isALNUM_LC(c) \
37bd1396 347 (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
ff68c719
PP
348# define isIDFIRST_LC(c) \
349 (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
350# define isALPHA_LC(c) NXIsAlpha((unsigned int)(c))
351# define isSPACE_LC(c) NXIsSpace((unsigned int)(c))
352# define isDIGIT_LC(c) NXIsDigit((unsigned int)(c))
353# define isUPPER_LC(c) NXIsUpper((unsigned int)(c))
354# define isLOWER_LC(c) NXIsLower((unsigned int)(c))
37bd1396 355# define isALNUMC_LC(c) NXIsAlNum((unsigned int)(c))
b8c5462f
JH
356# define isCNTRL_LC(c) NXIsCntrl((unsigned int)(c))
357# define isGRAPH_LC(c) NXIsGraph((unsigned int)(c))
ff68c719 358# define isPRINT_LC(c) NXIsPrint((unsigned int)(c))
b8c5462f 359# define isPUNCT_LC(c) NXIsPunct((unsigned int)(c))
ff68c719
PP
360# define toUPPER_LC(c) NXToUpper((unsigned int)(c))
361# define toLOWER_LC(c) NXToLower((unsigned int)(c))
bbce6d69
PP
362
363#else /* !USE_NEXT_CTYPE */
b8c5462f 364
bbce6d69
PP
365# if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
366
b8c5462f 367# define isALNUM_LC(c) (isalnum((unsigned char)(c)) || (char)(c) == '_')
ff68c719 368# define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
bbce6d69
PP
369# define isALPHA_LC(c) isalpha((unsigned char)(c))
370# define isSPACE_LC(c) isspace((unsigned char)(c))
371# define isDIGIT_LC(c) isdigit((unsigned char)(c))
372# define isUPPER_LC(c) isupper((unsigned char)(c))
373# define isLOWER_LC(c) islower((unsigned char)(c))
b8c5462f
JH
374# define isALNUMC_LC(c) isalnum((unsigned char)(c))
375# define isCNTRL_LC(c) iscntrl((unsigned char)(c))
376# define isGRAPH_LC(c) isgraph((unsigned char)(c))
bbce6d69 377# define isPRINT_LC(c) isprint((unsigned char)(c))
b8c5462f 378# define isPUNCT_LC(c) ispunct((unsigned char)(c))
bbce6d69
PP
379# define toUPPER_LC(c) toupper((unsigned char)(c))
380# define toLOWER_LC(c) tolower((unsigned char)(c))
381
382# else
383
b8c5462f 384# define isALNUM_LC(c) (isascii(c) && (isalnum(c) || (c) == '_'))
bbce6d69
PP
385# define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
386# define isALPHA_LC(c) (isascii(c) && isalpha(c))
387# define isSPACE_LC(c) (isascii(c) && isspace(c))
388# define isDIGIT_LC(c) (isascii(c) && isdigit(c))
389# define isUPPER_LC(c) (isascii(c) && isupper(c))
390# define isLOWER_LC(c) (isascii(c) && islower(c))
b8c5462f
JH
391# define isALNUMC_LC(c) (isascii(c) && isalnum(c))
392# define isCNTRL_LC(c) (isascii(c) && iscntrl(c))
393# define isGRAPH_LC(c) (isascii(c) && isgraph(c))
bbce6d69 394# define isPRINT_LC(c) (isascii(c) && isprint(c))
b8c5462f 395# define isPUNCT_LC(c) (isascii(c) && ispunct(c))
bbce6d69
PP
396# define toUPPER_LC(c) toupper(c)
397# define toLOWER_LC(c) tolower(c)
398
399# endif
a0d0e21e 400#endif /* USE_NEXT_CTYPE */
55204971 401
aaa51d5e
JF
402#define isPSXSPC_LC(c) (isSPACE_LC(c) || (c) == '\v')
403#define isBLANK_LC(c) isBLANK(c) /* could be wrong */
404
a0ed51b3
LW
405#define isALNUM_uni(c) is_uni_alnum(c)
406#define isIDFIRST_uni(c) is_uni_idfirst(c)
407#define isALPHA_uni(c) is_uni_alpha(c)
408#define isSPACE_uni(c) is_uni_space(c)
409#define isDIGIT_uni(c) is_uni_digit(c)
410#define isUPPER_uni(c) is_uni_upper(c)
411#define isLOWER_uni(c) is_uni_lower(c)
b8c5462f
JH
412#define isALNUMC_uni(c) is_uni_alnumc(c)
413#define isASCII_uni(c) is_uni_ascii(c)
414#define isCNTRL_uni(c) is_uni_cntrl(c)
415#define isGRAPH_uni(c) is_uni_graph(c)
a0ed51b3 416#define isPRINT_uni(c) is_uni_print(c)
b8c5462f
JH
417#define isPUNCT_uni(c) is_uni_punct(c)
418#define isXDIGIT_uni(c) is_uni_xdigit(c)
a0ed51b3
LW
419#define toUPPER_uni(c) to_uni_upper(c)
420#define toTITLE_uni(c) to_uni_title(c)
421#define toLOWER_uni(c) to_uni_lower(c)
422
aaa51d5e
JF
423#define isPSXSPC_uni(c) (isSPACE_uni(c) ||(c) == '\f')
424#define isBLANK_uni(c) isBLANK(c) /* could be wrong */
425
a0ed51b3
LW
426#define isALNUM_LC_uni(c) (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
427#define isIDFIRST_LC_uni(c) (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
428#define isALPHA_LC_uni(c) (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
429#define isSPACE_LC_uni(c) (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
430#define isDIGIT_LC_uni(c) (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
431#define isUPPER_LC_uni(c) (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
432#define isLOWER_LC_uni(c) (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
b8c5462f
JH
433#define isALNUMC_LC_uni(c) (c < 256 ? isALNUMC_LC(c) : is_uni_alnumc_lc(c))
434#define isCNTRL_LC_uni(c) (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
435#define isGRAPH_LC_uni(c) (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
a0ed51b3 436#define isPRINT_LC_uni(c) (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
b8c5462f 437#define isPUNCT_LC_uni(c) (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
a0ed51b3
LW
438#define toUPPER_LC_uni(c) (c < 256 ? toUPPER_LC(c) : to_uni_upper_lc(c))
439#define toTITLE_LC_uni(c) (c < 256 ? toUPPER_LC(c) : to_uni_title_lc(c))
440#define toLOWER_LC_uni(c) (c < 256 ? toLOWER_LC(c) : to_uni_lower_lc(c))
441
aaa51d5e
JF
442#define isPSXSPC_LC_uni(c) (isSPACE_LC_uni(c) ||(c) == '\f')
443#define isBLANK_LC_uni(c) isBLANK(c) /* could be wrong */
444
a0ed51b3
LW
445#define isALNUM_utf8(p) is_utf8_alnum(p)
446#define isIDFIRST_utf8(p) is_utf8_idfirst(p)
447#define isALPHA_utf8(p) is_utf8_alpha(p)
448#define isSPACE_utf8(p) is_utf8_space(p)
449#define isDIGIT_utf8(p) is_utf8_digit(p)
450#define isUPPER_utf8(p) is_utf8_upper(p)
451#define isLOWER_utf8(p) is_utf8_lower(p)
b8c5462f
JH
452#define isALNUMC_utf8(p) is_utf8_alnumc(p)
453#define isASCII_utf8(p) is_utf8_ascii(p)
454#define isCNTRL_utf8(p) is_utf8_cntrl(p)
455#define isGRAPH_utf8(p) is_utf8_graph(p)
a0ed51b3 456#define isPRINT_utf8(p) is_utf8_print(p)
b8c5462f
JH
457#define isPUNCT_utf8(p) is_utf8_punct(p)
458#define isXDIGIT_utf8(p) is_utf8_xdigit(p)
a0ed51b3
LW
459#define toUPPER_utf8(p) to_utf8_upper(p)
460#define toTITLE_utf8(p) to_utf8_title(p)
461#define toLOWER_utf8(p) to_utf8_lower(p)
462
aaa51d5e
JF
463#define isPSXSPC_utf8(c) (isSPACE_utf8(c) ||(c) == '\f')
464#define isBLANK_utf8(c) isBLANK(c) /* could be wrong */
465
ba210ebe
JH
466#define STRLEN_MAX ((STRLEN)-1)
467
06aa31c8
JH
468#define isALNUM_LC_utf8(p) isALNUM_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
469#define isIDFIRST_LC_utf8(p) isIDFIRST_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
470#define isALPHA_LC_utf8(p) isALPHA_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
471#define isSPACE_LC_utf8(p) isSPACE_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
472#define isDIGIT_LC_utf8(p) isDIGIT_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
473#define isUPPER_LC_utf8(p) isUPPER_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
474#define isLOWER_LC_utf8(p) isLOWER_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
475#define isALNUMC_LC_utf8(p) isALNUMC_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
476#define isCNTRL_LC_utf8(p) isCNTRL_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
477#define isGRAPH_LC_utf8(p) isGRAPH_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
478#define isPRINT_LC_utf8(p) isPRINT_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
479#define isPUNCT_LC_utf8(p) isPUNCT_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
480#define toUPPER_LC_utf8(p) toUPPER_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
481#define toTITLE_LC_utf8(p) toTITLE_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
482#define toLOWER_LC_utf8(p) toLOWER_LC_uni(utf8_to_uv(p, STRLEN_MAX, 0, 0))
a0ed51b3 483
aaa51d5e
JF
484#define isPSXSPC_LC_utf8(c) (isSPACE_LC_utf8(c) ||(c) == '\f')
485#define isBLANK_LC_utf8(c) isBLANK(c) /* could be wrong */
486
9d116dd7 487#ifdef EBCDIC
20ce7b12 488EXT int ebcdic_control (int);
9d116dd7
JH
489# define toCTRL(c) ebcdic_control(c)
490#else
491 /* This conversion works both ways, strangely enough. */
492# define toCTRL(c) (toUPPER(c) ^ 64)
493#endif
bbce6d69 494
378cc40b 495/* Line numbers are unsigned, 16 bits. */
79072805 496typedef U16 line_t;
378cc40b
LW
497#ifdef lint
498#define NOLINE ((line_t)0)
499#else
500#define NOLINE ((line_t) 65535)
501#endif
502
8c52afec 503
8e84507e 504/*
8c52afec 505 XXX LEAKTEST doesn't really work in perl5. There are direct calls to
27d4fb96 506 safemalloc() in the source, so LEAKTEST won't pick them up.
c1d22f6b 507 (The main "offenders" are extensions.)
27d4fb96
PP
508 Further, if you try LEAKTEST, you'll also end up calling
509 Safefree, which might call safexfree() on some things that weren't
510 malloced with safexmalloc. The correct "fix" to this, if anyone
511 is interested, is to ensure that all calls go through the New and
512 Renew macros.
513 --Andy Dougherty August 1996
514*/
55497cff 515
954c1994
GS
516/*
517=for apidoc Am|SV*|NEWSV|int id|STRLEN len
518Creates a new SV. A non-zero C<len> parameter indicates the number of
519bytes of preallocated string space the SV should have. An extra byte for a
520tailing NUL is also reserved. (SvPOK is not set for the SV even if string
8e84507e 521space is allocated.) The reference count for the new SV is set to 1.
954c1994
GS
522C<id> is an integer id between 0 and 1299 (used to identify leaks).
523
524=for apidoc Am|void|New|int id|void* ptr|int nitems|type
525The XSUB-writer's interface to the C C<malloc> function.
526
527=for apidoc Am|void|Newc|int id|void* ptr|int nitems|type|cast
528The XSUB-writer's interface to the C C<malloc> function, with
529cast.
530
531=for apidoc Am|void|Newz|int id|void* ptr|int nitems|type
532The XSUB-writer's interface to the C C<malloc> function. The allocated
533memory is zeroed with C<memzero>.
534
535=for apidoc Am|void|Renew|void* ptr|int nitems|type
536The XSUB-writer's interface to the C C<realloc> function.
537
538=for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
539The XSUB-writer's interface to the C C<realloc> function, with
540cast.
541
49b8b560 542=for apidoc Am|void|Safefree|void* ptr
954c1994
GS
543The XSUB-writer's interface to the C C<free> function.
544
545=for apidoc Am|void|Move|void* src|void* dest|int nitems|type
546The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
547source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
548the type. Can do overlapping moves. See also C<Copy>.
549
550=for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
551The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
552source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
553the type. May fail on overlapping copies. See also C<Move>.
554
555=for apidoc Am|void|Zero|void* dest|int nitems|type
556
557The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
558destination, C<nitems> is the number of items, and C<type> is the type.
559
560=for apidoc Am|void|StructCopy|type src|type dest|type
4375e838 561This is an architecture-independent macro to copy one structure to another.
954c1994
GS
562
563=cut
564*/
565
a687059c 566#ifndef lint
ff06c60c
IZ
567
568#define NEWSV(x,len) newSV(len)
569
a687059c 570#ifndef LEAKTEST
598a3d64 571
ff68c719
PP
572#define New(x,v,n,t) (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
573#define Newc(x,v,n,t,c) (v = (c*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
574#define Newz(x,v,n,t) (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))), \
575 memzero((char*)(v), (n)*sizeof(t))
576#define Renew(v,n,t) \
577 (v = (t*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
578#define Renewc(v,n,t,c) \
579 (v = (c*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
580#define Safefree(d) safefree((Malloc_t)(d))
55497cff 581
a687059c 582#else /* LEAKTEST */
55497cff 583
ff68c719
PP
584#define New(x,v,n,t) (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
585#define Newc(x,v,n,t,c) (v = (c*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
586#define Newz(x,v,n,t) (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t)))), \
587 memzero((char*)(v), (n)*sizeof(t))
588#define Renew(v,n,t) \
589 (v = (t*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
590#define Renewc(v,n,t,c) \
591 (v = (c*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
8c52afec 592#define Safefree(d) safexfree((Malloc_t)(d))
ff68c719 593
fc36a67e 594#define MAXXCOUNT 1400
8c52afec
IZ
595#define MAXY_SIZE 80
596#define MAXYCOUNT 16 /* (MAXY_SIZE/4 + 1) */
597extern long xcount[MAXXCOUNT];
598extern long lastxcount[MAXXCOUNT];
599extern long xycount[MAXXCOUNT][MAXYCOUNT];
600extern long lastxycount[MAXXCOUNT][MAXYCOUNT];
55497cff 601
a687059c 602#endif /* LEAKTEST */
55497cff 603
ff68c719
PP
604#define Move(s,d,n,t) (void)memmove((char*)(d),(char*)(s), (n) * sizeof(t))
605#define Copy(s,d,n,t) (void)memcpy((char*)(d),(char*)(s), (n) * sizeof(t))
606#define Zero(d,n,t) (void)memzero((char*)(d), (n) * sizeof(t))
55497cff 607
a687059c 608#else /* lint */
55497cff 609
ff68c719
PP
610#define New(x,v,n,s) (v = Null(s *))
611#define Newc(x,v,n,s,c) (v = Null(s *))
612#define Newz(x,v,n,s) (v = Null(s *))
613#define Renew(v,n,s) (v = Null(s *))
bee1dbe2 614#define Move(s,d,n,t)
a687059c
LW
615#define Copy(s,d,n,t)
616#define Zero(d,n,t)
ff68c719 617#define Safefree(d) (d) = (d)
55497cff 618
a687059c 619#endif /* lint */
bee1dbe2 620
2304df62 621#ifdef USE_STRUCT_COPY
ff68c719 622#define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
bee1dbe2
LW
623#else
624#define StructCopy(s,d,t) Copy(s,d,1,t)
625#endif