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