Commit | Line | Data |
a0d0e21e |
1 | /* handy.h |
a687059c |
2 | * |
9607fc9c |
3 | * Copyright (c) 1991-1997, Larry Wall |
a687059c |
4 | * |
6e21c824 |
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 |
8 | */ |
9 | |
85e6fe83 |
10 | #if !defined(__STDC__) |
378cc40b |
11 | #ifdef NULL |
12 | #undef NULL |
13 | #endif |
a687059c |
14 | #ifndef I286 |
15 | # define NULL 0 |
16 | #else |
17 | # define NULL 0L |
18 | #endif |
85e6fe83 |
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 |
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 |
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 |
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 |
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 |
67 | #ifndef HAS_BOOL |
61bb5906 |
68 | # if defined(UTS) || defined(VMS) |
5d94fbed |
69 | # define bool int |
70 | # else |
71 | # define bool char |
72 | # endif |
a687059c |
73 | #endif |
0d3e774c |
74 | |
27d4fb96 |
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 |
24fef2a7 |
84 | |
85 | In the future, we may perhaps want to think about something like |
86 | #if INTSIZE == 4 |
87 | typedef I32 int; |
88 | #else |
89 | # if LONGSIZE == 4 |
90 | typedef I32 long; |
91 | # else |
92 | # if SHORTSIZE == 4 |
93 | typedef I32 short; |
94 | # else |
95 | typedef I32 int; |
96 | # endif |
97 | # endif |
98 | #endif |
693762b4 |
99 | |
100 | except that still won't work if a system has no integral type |
101 | with a size that is 32 bytes. |
102 | |
103 | Further, we need to know about PTRSIZE == sizeof(void *) and |
104 | DOUBLESIZE == sizeof(double) if we really want to try to handle |
105 | 32/64-bit combinations. |
106 | |
107 | For the moment, these are only mentioned here so metaconfig will |
24fef2a7 |
108 | construct Configure to figure out the various sizes. |
27d4fb96 |
109 | */ |
110 | |
79072805 |
111 | typedef char I8; |
112 | typedef unsigned char U8; |
5c9fa16e |
113 | /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type. |
114 | Please search CHAR_MAX in perl.h for further details. */ |
27d4fb96 |
115 | #define U8_MAX PERL_UCHAR_MAX |
116 | #define U8_MIN PERL_UCHAR_MIN |
79072805 |
117 | |
118 | typedef short I16; |
119 | typedef unsigned short U16; |
27d4fb96 |
120 | #define I16_MAX PERL_SHORT_MAX |
121 | #define I16_MIN PERL_SHORT_MIN |
122 | #define U16_MAX PERL_USHORT_MAX |
123 | #define U16_MIN PERL_USHORT_MIN |
79072805 |
124 | |
a0d0e21e |
125 | #if BYTEORDER > 0x4321 |
85e6fe83 |
126 | typedef int I32; |
127 | typedef unsigned int U32; |
27d4fb96 |
128 | # define I32_MAX PERL_INT_MAX |
129 | # define I32_MIN PERL_INT_MIN |
130 | # define U32_MAX PERL_UINT_MAX |
131 | # define U32_MIN PERL_UINT_MIN |
79072805 |
132 | #else |
85e6fe83 |
133 | typedef long I32; |
134 | typedef unsigned long U32; |
27d4fb96 |
135 | # define I32_MAX PERL_LONG_MAX |
136 | # define I32_MIN PERL_LONG_MIN |
137 | # define U32_MAX PERL_ULONG_MAX |
138 | # define U32_MIN PERL_ULONG_MIN |
79072805 |
139 | #endif |
140 | |
fc36a67e |
141 | #define BIT_DIGITS(N) (((N)*146)/485 + 1) /* log2(10) =~ 146/485 */ |
142 | #define TYPE_DIGITS(T) BIT_DIGITS(sizeof(T) * 8) |
143 | #define TYPE_CHARS(T) (TYPE_DIGITS(T) + 2) /* sign, NUL */ |
144 | |
ff68c719 |
145 | #define Ctl(ch) ((ch) & 037) |
8d063cd8 |
146 | |
147 | #define strNE(s1,s2) (strcmp(s1,s2)) |
148 | #define strEQ(s1,s2) (!strcmp(s1,s2)) |
149 | #define strLT(s1,s2) (strcmp(s1,s2) < 0) |
150 | #define strLE(s1,s2) (strcmp(s1,s2) <= 0) |
151 | #define strGT(s1,s2) (strcmp(s1,s2) > 0) |
152 | #define strGE(s1,s2) (strcmp(s1,s2) >= 0) |
153 | #define strnNE(s1,s2,l) (strncmp(s1,s2,l)) |
154 | #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l)) |
378cc40b |
155 | |
36477c24 |
156 | #ifdef HAS_MEMCMP |
157 | # define memNE(s1,s2,l) (memcmp(s1,s2,l)) |
158 | # define memEQ(s1,s2,l) (!memcmp(s1,s2,l)) |
159 | #else |
160 | # define memNE(s1,s2,l) (bcmp(s1,s2,l)) |
161 | # define memEQ(s1,s2,l) (!bcmp(s1,s2,l)) |
162 | #endif |
163 | |
bbce6d69 |
164 | /* |
165 | * Character classes. |
166 | * |
167 | * Unfortunately, the introduction of locales means that we |
168 | * can't trust isupper(), etc. to tell the truth. And when |
169 | * it comes to /\w+/ with tainting enabled, we *must* be able |
170 | * to trust our character classes. |
171 | * |
172 | * Therefore, the default tests in the text of Perl will be |
173 | * independent of locale. Any code that wants to depend on |
174 | * the current locale will use the tests that begin with "lc". |
175 | */ |
176 | |
2304df62 |
177 | #ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */ |
178 | # ifndef CTYPE256 |
179 | # define CTYPE256 |
180 | # endif |
181 | #endif |
182 | |
bbce6d69 |
183 | #define isALNUM(c) (isALPHA(c) || isDIGIT(c) || (c) == '_') |
184 | #define isIDFIRST(c) (isALPHA(c) || (c) == '_') |
185 | #define isALPHA(c) (isUPPER(c) || isLOWER(c)) |
186 | #define isSPACE(c) \ |
187 | ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f') |
188 | #define isDIGIT(c) ((c) >= '0' && (c) <= '9') |
189 | #define isUPPER(c) ((c) >= 'A' && (c) <= 'Z') |
190 | #define isLOWER(c) ((c) >= 'a' && (c) <= 'z') |
191 | #define isPRINT(c) (((c) > 32 && (c) < 127) || isSPACE(c)) |
192 | #define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c)) |
193 | #define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c)) |
194 | |
195 | #ifdef USE_NEXT_CTYPE |
196 | |
197 | # define isALNUM_LC(c) \ |
ff68c719 |
198 | (NXIsAlpha((unsigned int)(c)) || NXIsDigit((unsigned int)(c)) || \ |
199 | (char)(c) == '_') |
200 | # define isIDFIRST_LC(c) \ |
201 | (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_') |
202 | # define isALPHA_LC(c) NXIsAlpha((unsigned int)(c)) |
203 | # define isSPACE_LC(c) NXIsSpace((unsigned int)(c)) |
204 | # define isDIGIT_LC(c) NXIsDigit((unsigned int)(c)) |
205 | # define isUPPER_LC(c) NXIsUpper((unsigned int)(c)) |
206 | # define isLOWER_LC(c) NXIsLower((unsigned int)(c)) |
207 | # define isPRINT_LC(c) NXIsPrint((unsigned int)(c)) |
208 | # define toUPPER_LC(c) NXToUpper((unsigned int)(c)) |
209 | # define toLOWER_LC(c) NXToLower((unsigned int)(c)) |
bbce6d69 |
210 | |
211 | #else /* !USE_NEXT_CTYPE */ |
212 | # if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII)) |
213 | |
214 | # define isALNUM_LC(c) \ |
215 | (isalpha((unsigned char)(c)) || \ |
ff68c719 |
216 | isdigit((unsigned char)(c)) || (char)(c) == '_') |
217 | # define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_') |
bbce6d69 |
218 | # define isALPHA_LC(c) isalpha((unsigned char)(c)) |
219 | # define isSPACE_LC(c) isspace((unsigned char)(c)) |
220 | # define isDIGIT_LC(c) isdigit((unsigned char)(c)) |
221 | # define isUPPER_LC(c) isupper((unsigned char)(c)) |
222 | # define isLOWER_LC(c) islower((unsigned char)(c)) |
223 | # define isPRINT_LC(c) isprint((unsigned char)(c)) |
224 | # define toUPPER_LC(c) toupper((unsigned char)(c)) |
225 | # define toLOWER_LC(c) tolower((unsigned char)(c)) |
226 | |
227 | # else |
228 | |
229 | # define isALNUM_LC(c) \ |
ff68c719 |
230 | (isascii(c) && (isalpha(c) || isdigit(c) || (c) == '_')) |
bbce6d69 |
231 | # define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_')) |
232 | # define isALPHA_LC(c) (isascii(c) && isalpha(c)) |
233 | # define isSPACE_LC(c) (isascii(c) && isspace(c)) |
234 | # define isDIGIT_LC(c) (isascii(c) && isdigit(c)) |
235 | # define isUPPER_LC(c) (isascii(c) && isupper(c)) |
236 | # define isLOWER_LC(c) (isascii(c) && islower(c)) |
237 | # define isPRINT_LC(c) (isascii(c) && isprint(c)) |
238 | # define toUPPER_LC(c) toupper(c) |
239 | # define toLOWER_LC(c) tolower(c) |
240 | |
241 | # endif |
a0d0e21e |
242 | #endif /* USE_NEXT_CTYPE */ |
55204971 |
243 | |
bbce6d69 |
244 | /* This conversion works both ways, strangely enough. */ |
245 | #define toCTRL(c) (toUPPER(c) ^ 64) |
246 | |
378cc40b |
247 | /* Line numbers are unsigned, 16 bits. */ |
79072805 |
248 | typedef U16 line_t; |
378cc40b |
249 | #ifdef lint |
250 | #define NOLINE ((line_t)0) |
251 | #else |
252 | #define NOLINE ((line_t) 65535) |
253 | #endif |
254 | |
8c52afec |
255 | |
256 | /* This looks obsolete (IZ): |
257 | |
258 | XXX LEAKTEST doesn't really work in perl5. There are direct calls to |
27d4fb96 |
259 | safemalloc() in the source, so LEAKTEST won't pick them up. |
260 | Further, if you try LEAKTEST, you'll also end up calling |
261 | Safefree, which might call safexfree() on some things that weren't |
262 | malloced with safexmalloc. The correct "fix" to this, if anyone |
263 | is interested, is to ensure that all calls go through the New and |
264 | Renew macros. |
265 | --Andy Dougherty August 1996 |
266 | */ |
55497cff |
267 | |
a687059c |
268 | #ifndef lint |
269 | #ifndef LEAKTEST |
598a3d64 |
270 | |
ff68c719 |
271 | #define New(x,v,n,t) (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))) |
272 | #define Newc(x,v,n,t,c) (v = (c*)safemalloc((MEM_SIZE)((n)*sizeof(t)))) |
273 | #define Newz(x,v,n,t) (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))), \ |
274 | memzero((char*)(v), (n)*sizeof(t)) |
275 | #define Renew(v,n,t) \ |
276 | (v = (t*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t)))) |
277 | #define Renewc(v,n,t,c) \ |
278 | (v = (c*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t)))) |
279 | #define Safefree(d) safefree((Malloc_t)(d)) |
280 | #define NEWSV(x,len) newSV(len) |
55497cff |
281 | |
a687059c |
282 | #else /* LEAKTEST */ |
55497cff |
283 | |
ff68c719 |
284 | #define New(x,v,n,t) (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t)))) |
285 | #define Newc(x,v,n,t,c) (v = (c*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t)))) |
286 | #define Newz(x,v,n,t) (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t)))), \ |
287 | memzero((char*)(v), (n)*sizeof(t)) |
288 | #define Renew(v,n,t) \ |
289 | (v = (t*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t)))) |
290 | #define Renewc(v,n,t,c) \ |
291 | (v = (c*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t)))) |
8c52afec |
292 | #define Safefree(d) safexfree((Malloc_t)(d)) |
ff68c719 |
293 | #define NEWSV(x,len) newSV(x,len) |
294 | |
fc36a67e |
295 | #define MAXXCOUNT 1400 |
8c52afec |
296 | #define MAXY_SIZE 80 |
297 | #define MAXYCOUNT 16 /* (MAXY_SIZE/4 + 1) */ |
298 | extern long xcount[MAXXCOUNT]; |
299 | extern long lastxcount[MAXXCOUNT]; |
300 | extern long xycount[MAXXCOUNT][MAXYCOUNT]; |
301 | extern long lastxycount[MAXXCOUNT][MAXYCOUNT]; |
55497cff |
302 | |
a687059c |
303 | #endif /* LEAKTEST */ |
55497cff |
304 | |
ff68c719 |
305 | #define Move(s,d,n,t) (void)memmove((char*)(d),(char*)(s), (n) * sizeof(t)) |
306 | #define Copy(s,d,n,t) (void)memcpy((char*)(d),(char*)(s), (n) * sizeof(t)) |
307 | #define Zero(d,n,t) (void)memzero((char*)(d), (n) * sizeof(t)) |
55497cff |
308 | |
a687059c |
309 | #else /* lint */ |
55497cff |
310 | |
ff68c719 |
311 | #define New(x,v,n,s) (v = Null(s *)) |
312 | #define Newc(x,v,n,s,c) (v = Null(s *)) |
313 | #define Newz(x,v,n,s) (v = Null(s *)) |
314 | #define Renew(v,n,s) (v = Null(s *)) |
bee1dbe2 |
315 | #define Move(s,d,n,t) |
a687059c |
316 | #define Copy(s,d,n,t) |
317 | #define Zero(d,n,t) |
ff68c719 |
318 | #define Safefree(d) (d) = (d) |
55497cff |
319 | |
a687059c |
320 | #endif /* lint */ |
bee1dbe2 |
321 | |
2304df62 |
322 | #ifdef USE_STRUCT_COPY |
ff68c719 |
323 | #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s))) |
bee1dbe2 |
324 | #else |
325 | #define StructCopy(s,d,t) Copy(s,d,1,t) |
326 | #endif |