This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Ignore refs to lexicals when making refs to lexicals
[perl5.git] / handy.h
CommitLineData
a0d0e21e 1/* handy.h
a687059c 2 *
a0d0e21e 3 * Copyright (c) 1991-1994, 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)
8d063cd8 22#define Nullch Null(char*)
760ac839 23#define Nullfp Null(PerlIO*)
79072805 24#define Nullsv Null(SV*)
8d063cd8 25
641d3f0b
PP
26#ifdef TRUE
27#undef TRUE
28#endif
29#ifdef FALSE
30#undef FALSE
31#endif
32#define TRUE (1)
33#define FALSE (0)
34
27d4fb96
PP
35
36/* XXX Configure ought to have a test for a boolean type, if I can
37 just figure out all the headers such a test needs.
38 Andy Dougherty August 1996
39*/
232e078e 40/* bool is built-in for g++-2.6.3, which might be used for an extension.
5d94fbed
AD
41 If the extension includes <_G_config.h> before this file then
42 _G_HAVE_BOOL will be properly set. If, however, the extension includes
43 this file first, then you will have to manually set -DHAS_BOOL in
44 your command line to avoid a conflict.
45*/
46#ifdef _G_HAVE_BOOL
47# if _G_HAVE_BOOL
48# ifndef HAS_BOOL
49# define HAS_BOOL 1
50# endif
51# endif
52#endif
53
641d3f0b
PP
54/* The NeXT dynamic loader headers will not build with the bool macro
55 So declare them now to clear confusion.
56*/
57#ifdef NeXT
58# undef FALSE
59# undef TRUE
60 typedef enum bool { FALSE = 0, TRUE = 1 } bool;
61# define ENUM_BOOL 1
62# ifndef HAS_BOOL
63# define HAS_BOOL 1
64# endif /* !HAS_BOOL */
65#endif /* NeXT */
66
5d94fbed
AD
67#ifndef HAS_BOOL
68# ifdef UTS
69# define bool int
70# else
71# define bool char
72# endif
a687059c 73#endif
0d3e774c 74
27d4fb96
PP
75/* XXX A note on the perl source internal type system. The
76 original intent was that I32 be *exactly* 32 bits.
77
78 Currently, we only guarantee that I32 is *at least* 32 bits.
79 Specifically, if int is 64 bits, then so is I32. (This is the case
80 for the Cray.) This has the advantage of meshing nicely with
81 standard library calls (where we pass an I32 and the library is
82 expecting an int), but the disadvantage that an I32 is not 32 bits.
83 Andy Dougherty August 1996
84*/
85
79072805
LW
86typedef char I8;
87typedef unsigned char U8;
5c9fa16e
KA
88/* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
89 Please search CHAR_MAX in perl.h for further details. */
27d4fb96
PP
90#define U8_MAX PERL_UCHAR_MAX
91#define U8_MIN PERL_UCHAR_MIN
79072805
LW
92
93typedef short I16;
94typedef unsigned short U16;
27d4fb96
PP
95#define I16_MAX PERL_SHORT_MAX
96#define I16_MIN PERL_SHORT_MIN
97#define U16_MAX PERL_USHORT_MAX
98#define U16_MIN PERL_USHORT_MIN
79072805 99
a0d0e21e 100#if BYTEORDER > 0x4321
85e6fe83
LW
101 typedef int I32;
102 typedef unsigned int U32;
27d4fb96
PP
103# define I32_MAX PERL_INT_MAX
104# define I32_MIN PERL_INT_MIN
105# define U32_MAX PERL_UINT_MAX
106# define U32_MIN PERL_UINT_MIN
79072805 107#else
85e6fe83
LW
108 typedef long I32;
109 typedef unsigned long U32;
27d4fb96
PP
110# define I32_MAX PERL_LONG_MAX
111# define I32_MIN PERL_LONG_MIN
112# define U32_MAX PERL_ULONG_MAX
113# define U32_MIN PERL_ULONG_MIN
79072805
LW
114#endif
115
ff68c719 116#define Ctl(ch) ((ch) & 037)
8d063cd8
LW
117
118#define strNE(s1,s2) (strcmp(s1,s2))
119#define strEQ(s1,s2) (!strcmp(s1,s2))
120#define strLT(s1,s2) (strcmp(s1,s2) < 0)
121#define strLE(s1,s2) (strcmp(s1,s2) <= 0)
122#define strGT(s1,s2) (strcmp(s1,s2) > 0)
123#define strGE(s1,s2) (strcmp(s1,s2) >= 0)
124#define strnNE(s1,s2,l) (strncmp(s1,s2,l))
125#define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
378cc40b 126
36477c24
PP
127#ifdef HAS_MEMCMP
128# define memNE(s1,s2,l) (memcmp(s1,s2,l))
129# define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
130#else
131# define memNE(s1,s2,l) (bcmp(s1,s2,l))
132# define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
133#endif
134
bbce6d69
PP
135/*
136 * Character classes.
137 *
138 * Unfortunately, the introduction of locales means that we
139 * can't trust isupper(), etc. to tell the truth. And when
140 * it comes to /\w+/ with tainting enabled, we *must* be able
141 * to trust our character classes.
142 *
143 * Therefore, the default tests in the text of Perl will be
144 * independent of locale. Any code that wants to depend on
145 * the current locale will use the tests that begin with "lc".
146 */
147
2304df62
AD
148#ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */
149# ifndef CTYPE256
150# define CTYPE256
151# endif
152#endif
153
bbce6d69
PP
154#define isALNUM(c) (isALPHA(c) || isDIGIT(c) || (c) == '_')
155#define isIDFIRST(c) (isALPHA(c) || (c) == '_')
156#define isALPHA(c) (isUPPER(c) || isLOWER(c))
157#define isSPACE(c) \
158 ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
159#define isDIGIT(c) ((c) >= '0' && (c) <= '9')
160#define isUPPER(c) ((c) >= 'A' && (c) <= 'Z')
161#define isLOWER(c) ((c) >= 'a' && (c) <= 'z')
162#define isPRINT(c) (((c) > 32 && (c) < 127) || isSPACE(c))
163#define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c))
164#define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c))
165
166#ifdef USE_NEXT_CTYPE
167
168# define isALNUM_LC(c) \
ff68c719
PP
169 (NXIsAlpha((unsigned int)(c)) || NXIsDigit((unsigned int)(c)) || \
170 (char)(c) == '_')
171# define isIDFIRST_LC(c) \
172 (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
173# define isALPHA_LC(c) NXIsAlpha((unsigned int)(c))
174# define isSPACE_LC(c) NXIsSpace((unsigned int)(c))
175# define isDIGIT_LC(c) NXIsDigit((unsigned int)(c))
176# define isUPPER_LC(c) NXIsUpper((unsigned int)(c))
177# define isLOWER_LC(c) NXIsLower((unsigned int)(c))
178# define isPRINT_LC(c) NXIsPrint((unsigned int)(c))
179# define toUPPER_LC(c) NXToUpper((unsigned int)(c))
180# define toLOWER_LC(c) NXToLower((unsigned int)(c))
bbce6d69
PP
181
182#else /* !USE_NEXT_CTYPE */
183# if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
184
185# define isALNUM_LC(c) \
186 (isalpha((unsigned char)(c)) || \
ff68c719
PP
187 isdigit((unsigned char)(c)) || (char)(c) == '_')
188# define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
bbce6d69
PP
189# define isALPHA_LC(c) isalpha((unsigned char)(c))
190# define isSPACE_LC(c) isspace((unsigned char)(c))
191# define isDIGIT_LC(c) isdigit((unsigned char)(c))
192# define isUPPER_LC(c) isupper((unsigned char)(c))
193# define isLOWER_LC(c) islower((unsigned char)(c))
194# define isPRINT_LC(c) isprint((unsigned char)(c))
195# define toUPPER_LC(c) toupper((unsigned char)(c))
196# define toLOWER_LC(c) tolower((unsigned char)(c))
197
198# else
199
200# define isALNUM_LC(c) \
ff68c719 201 (isascii(c) && (isalpha(c) || isdigit(c) || (c) == '_'))
bbce6d69
PP
202# define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
203# define isALPHA_LC(c) (isascii(c) && isalpha(c))
204# define isSPACE_LC(c) (isascii(c) && isspace(c))
205# define isDIGIT_LC(c) (isascii(c) && isdigit(c))
206# define isUPPER_LC(c) (isascii(c) && isupper(c))
207# define isLOWER_LC(c) (isascii(c) && islower(c))
208# define isPRINT_LC(c) (isascii(c) && isprint(c))
209# define toUPPER_LC(c) toupper(c)
210# define toLOWER_LC(c) tolower(c)
211
212# endif
a0d0e21e 213#endif /* USE_NEXT_CTYPE */
55204971 214
bbce6d69
PP
215/* This conversion works both ways, strangely enough. */
216#define toCTRL(c) (toUPPER(c) ^ 64)
217
378cc40b 218/* Line numbers are unsigned, 16 bits. */
79072805 219typedef U16 line_t;
378cc40b
LW
220#ifdef lint
221#define NOLINE ((line_t)0)
222#else
223#define NOLINE ((line_t) 65535)
224#endif
225
27d4fb96
PP
226/* XXX LEAKTEST doesn't really work in perl5. There are direct calls to
227 safemalloc() in the source, so LEAKTEST won't pick them up.
228 Further, if you try LEAKTEST, you'll also end up calling
229 Safefree, which might call safexfree() on some things that weren't
230 malloced with safexmalloc. The correct "fix" to this, if anyone
231 is interested, is to ensure that all calls go through the New and
232 Renew macros.
233 --Andy Dougherty August 1996
234*/
55497cff 235
a687059c
LW
236#ifndef lint
237#ifndef LEAKTEST
598a3d64 238
ff68c719
PP
239#define New(x,v,n,t) (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
240#define Newc(x,v,n,t,c) (v = (c*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
241#define Newz(x,v,n,t) (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))), \
242 memzero((char*)(v), (n)*sizeof(t))
243#define Renew(v,n,t) \
244 (v = (t*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
245#define Renewc(v,n,t,c) \
246 (v = (c*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
247#define Safefree(d) safefree((Malloc_t)(d))
248#define NEWSV(x,len) newSV(len)
55497cff 249
a687059c 250#else /* LEAKTEST */
55497cff 251
ff68c719
PP
252#define New(x,v,n,t) (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
253#define Newc(x,v,n,t,c) (v = (c*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
254#define Newz(x,v,n,t) (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t)))), \
255 memzero((char*)(v), (n)*sizeof(t))
256#define Renew(v,n,t) \
257 (v = (t*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
258#define Renewc(v,n,t,c) \
259 (v = (c*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
260#define Safefree(d) safexfree((Malloc_t)d)
261#define NEWSV(x,len) newSV(x,len)
262
a687059c
LW
263#define MAXXCOUNT 1200
264long xcount[MAXXCOUNT];
265long lastxcount[MAXXCOUNT];
55497cff 266
a687059c 267#endif /* LEAKTEST */
55497cff 268
ff68c719
PP
269#define Move(s,d,n,t) (void)memmove((char*)(d),(char*)(s), (n) * sizeof(t))
270#define Copy(s,d,n,t) (void)memcpy((char*)(d),(char*)(s), (n) * sizeof(t))
271#define Zero(d,n,t) (void)memzero((char*)(d), (n) * sizeof(t))
55497cff 272
a687059c 273#else /* lint */
55497cff 274
ff68c719
PP
275#define New(x,v,n,s) (v = Null(s *))
276#define Newc(x,v,n,s,c) (v = Null(s *))
277#define Newz(x,v,n,s) (v = Null(s *))
278#define Renew(v,n,s) (v = Null(s *))
bee1dbe2 279#define Move(s,d,n,t)
a687059c
LW
280#define Copy(s,d,n,t)
281#define Zero(d,n,t)
ff68c719 282#define Safefree(d) (d) = (d)
55497cff 283
a687059c 284#endif /* lint */
bee1dbe2 285
2304df62 286#ifdef USE_STRUCT_COPY
ff68c719 287#define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
bee1dbe2
LW
288#else
289#define StructCopy(s,d,t) Copy(s,d,1,t)
290#endif