3 * Copyright (c) 1991-1999, Larry Wall
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.
10 #if !defined(__STDC__)
21 #define Null(type) ((type)NULL)
22 #define Nullch Null(char*)
23 #define Nullfp Null(PerlIO*)
24 #define Nullsv Null(SV*)
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
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.
54 /* The NeXT dynamic loader headers will not build with the bool macro
55 So declare them now to clear confusion.
57 #if defined(NeXT) || defined(__NeXT__)
60 typedef enum bool { FALSE = 0, TRUE = 1 } bool;
64 # endif /* !HAS_BOOL */
65 #endif /* NeXT || __NeXT__ */
68 # if defined(UTS) || defined(VMS)
75 /* XXX A note on the perl source internal type system. The
76 original intent was that I32 be *exactly* 32 bits.
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
85 There is no guarantee that there is *any* integral type with
86 exactly 32 bits. It is perfectly legal for a system to have
87 sizeof(short) == sizeof(int) == sizeof(long) == 8.
89 Similarly, there is no guarantee that I16 and U16 have exactly 16
92 For dealing with issues that may arise from various 32/64-bit
93 systems, we will ask Configure to check out
94 SHORTSIZE == sizeof(short)
95 INTSIZE == sizeof(int)
96 LONGSIZE == sizeof(long)
97 LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
98 PTRSIZE == sizeof(void *)
99 DOUBLESIZE == sizeof(double)
100 LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
101 Most of these are currently unused, but they are mentioned here so
102 metaconfig will include the appropriate tests in Configure and
103 we can then start to consider how best to deal with long long
105 Andy Dougherty April 1998
108 #if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
112 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
113 Please search CHAR_MAX in perl.h for further details. */
114 #define U8_MAX UINT8_MAX
115 #define U8_MIN UINT8_MIN
118 typedef uint16_t U16;
119 #define I16_MAX INT16_MAX
120 #define I16_MIN INT16_MIN
121 #define U16_MAX UINT16_MAX
122 #define U16_MIN UINT16_MIN
125 typedef uint32_t U32;
126 #define I32_MAX INT32_MAX
127 #define I32_MIN INT32_MIN
128 #define U32_MAX UINT32_MAX
129 #define U32_MIN UINT32_MIN
134 typedef unsigned char U8;
135 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
136 Please search CHAR_MAX in perl.h for further details. */
137 #define U8_MAX PERL_UCHAR_MAX
138 #define U8_MIN PERL_UCHAR_MIN
140 /* Beware. SHORTSIZE > 2 in Cray C90ties. */
142 typedef unsigned short U16;
143 #define I16_MAX PERL_SHORT_MAX
144 #define I16_MIN PERL_SHORT_MIN
145 #define U16_MAX PERL_USHORT_MAX
146 #define U16_MIN PERL_USHORT_MIN
150 typedef unsigned int U32;
151 # define I32_MAX PERL_INT_MAX
152 # define I32_MIN PERL_INT_MIN
153 # define U32_MAX PERL_UINT_MAX
154 # define U32_MIN PERL_UINT_MIN
157 typedef unsigned long U32;
158 # define I32_MAX PERL_LONG_MAX
159 # define I32_MIN PERL_LONG_MIN
160 # define U32_MAX PERL_ULONG_MAX
161 # define U32_MIN PERL_ULONG_MIN
166 #define BIT_DIGITS(N) (((N)*146)/485 + 1) /* log2(10) =~ 146/485 */
167 #define TYPE_DIGITS(T) BIT_DIGITS(sizeof(T) * 8)
168 #define TYPE_CHARS(T) (TYPE_DIGITS(T) + 2) /* sign, NUL */
170 #define Ctl(ch) ((ch) & 037)
172 #define strNE(s1,s2) (strcmp(s1,s2))
173 #define strEQ(s1,s2) (!strcmp(s1,s2))
174 #define strLT(s1,s2) (strcmp(s1,s2) < 0)
175 #define strLE(s1,s2) (strcmp(s1,s2) <= 0)
176 #define strGT(s1,s2) (strcmp(s1,s2) > 0)
177 #define strGE(s1,s2) (strcmp(s1,s2) >= 0)
178 #define strnNE(s1,s2,l) (strncmp(s1,s2,l))
179 #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
182 # define memNE(s1,s2,l) (memcmp(s1,s2,l))
183 # define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
185 # define memNE(s1,s2,l) (bcmp(s1,s2,l))
186 # define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
192 * Unfortunately, the introduction of locales means that we
193 * can't trust isupper(), etc. to tell the truth. And when
194 * it comes to /\w+/ with tainting enabled, we *must* be able
195 * to trust our character classes.
197 * Therefore, the default tests in the text of Perl will be
198 * independent of locale. Any code that wants to depend on
199 * the current locale will use the tests that begin with "lc".
202 #ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */
208 #define isALNUM(c) (isALPHA(c) || isDIGIT(c) || (c) == '_')
209 #define isIDFIRST(c) (isALPHA(c) || (c) == '_')
210 #define isALPHA(c) (isUPPER(c) || isLOWER(c))
212 ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
213 #define isDIGIT(c) ((c) >= '0' && (c) <= '9')
215 /* In EBCDIC we do not do locales: therefore() isupper() is fine. */
216 # define isUPPER(c) isupper(c)
217 # define isLOWER(c) islower(c)
218 # define isALNUMC(c) isalnum(c)
219 # define isASCII(c) isascii(c)
220 # define isCNTRL(c) iscntrl(c)
221 # define isGRAPH(c) isgraph(c)
222 # define isPRINT(c) isprint(c)
223 # define isPUNCT(c) ispunct(c)
224 # define isXDIGIT(c) isxdigit(c)
225 # define toUPPER(c) toupper(c)
226 # define toLOWER(c) tolower(c)
228 # define isUPPER(c) ((c) >= 'A' && (c) <= 'Z')
229 # define isLOWER(c) ((c) >= 'a' && (c) <= 'z')
230 # define isALNUMC(c) (isALPHA(c) || isDIGIT(c))
231 # define isASCII(c) ((c) <= 127)
232 # define isCNTRL(c) ((c) < ' ')
233 # define isGRAPH(c) (isALNUM(c) || isPUNCT(c))
234 # define isPRINT(c) (((c) > 32 && (c) < 127) || isSPACE(c))
235 # define isPUNCT(c) (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64) || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
236 # define isXDIGIT(c) (isdigit(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F'))
237 # define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c))
238 # define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c))
241 #ifdef USE_NEXT_CTYPE
243 # define isALNUM_LC(c) \
244 (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
245 # define isIDFIRST_LC(c) \
246 (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
247 # define isALPHA_LC(c) NXIsAlpha((unsigned int)(c))
248 # define isSPACE_LC(c) NXIsSpace((unsigned int)(c))
249 # define isDIGIT_LC(c) NXIsDigit((unsigned int)(c))
250 # define isUPPER_LC(c) NXIsUpper((unsigned int)(c))
251 # define isLOWER_LC(c) NXIsLower((unsigned int)(c))
252 # define isALNUMC_LC(c) NXIsAlNum((unsigned int)(c))
253 # define isCNTRL_LC(c) NXIsCntrl((unsigned int)(c))
254 # define isGRAPH_LC(c) NXIsGraph((unsigned int)(c))
255 # define isPRINT_LC(c) NXIsPrint((unsigned int)(c))
256 # define isPUNCT_LC(c) NXIsPunct((unsigned int)(c))
257 # define toUPPER_LC(c) NXToUpper((unsigned int)(c))
258 # define toLOWER_LC(c) NXToLower((unsigned int)(c))
260 #else /* !USE_NEXT_CTYPE */
262 # if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
264 # define isALNUM_LC(c) (isalnum((unsigned char)(c)) || (char)(c) == '_')
265 # define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
266 # define isALPHA_LC(c) isalpha((unsigned char)(c))
267 # define isSPACE_LC(c) isspace((unsigned char)(c))
268 # define isDIGIT_LC(c) isdigit((unsigned char)(c))
269 # define isUPPER_LC(c) isupper((unsigned char)(c))
270 # define isLOWER_LC(c) islower((unsigned char)(c))
271 # define isALNUMC_LC(c) isalnum((unsigned char)(c))
272 # define isCNTRL_LC(c) iscntrl((unsigned char)(c))
273 # define isGRAPH_LC(c) isgraph((unsigned char)(c))
274 # define isPRINT_LC(c) isprint((unsigned char)(c))
275 # define isPUNCT_LC(c) ispunct((unsigned char)(c))
276 # define toUPPER_LC(c) toupper((unsigned char)(c))
277 # define toLOWER_LC(c) tolower((unsigned char)(c))
281 # define isALNUM_LC(c) (isascii(c) && (isalnum(c) || (c) == '_'))
282 # define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
283 # define isALPHA_LC(c) (isascii(c) && isalpha(c))
284 # define isSPACE_LC(c) (isascii(c) && isspace(c))
285 # define isDIGIT_LC(c) (isascii(c) && isdigit(c))
286 # define isUPPER_LC(c) (isascii(c) && isupper(c))
287 # define isLOWER_LC(c) (isascii(c) && islower(c))
288 # define isALNUMC_LC(c) (isascii(c) && isalnum(c))
289 # define isCNTRL_LC(c) (isascii(c) && iscntrl(c))
290 # define isGRAPH_LC(c) (isascii(c) && isgraph(c))
291 # define isPRINT_LC(c) (isascii(c) && isprint(c))
292 # define isPUNCT_LC(c) (isascii(c) && ispunct(c))
293 # define toUPPER_LC(c) toupper(c)
294 # define toLOWER_LC(c) tolower(c)
297 #endif /* USE_NEXT_CTYPE */
299 #define isALNUM_uni(c) is_uni_alnum(c)
300 #define isIDFIRST_uni(c) is_uni_idfirst(c)
301 #define isALPHA_uni(c) is_uni_alpha(c)
302 #define isSPACE_uni(c) is_uni_space(c)
303 #define isDIGIT_uni(c) is_uni_digit(c)
304 #define isUPPER_uni(c) is_uni_upper(c)
305 #define isLOWER_uni(c) is_uni_lower(c)
306 #define isALNUMC_uni(c) is_uni_alnumc(c)
307 #define isASCII_uni(c) is_uni_ascii(c)
308 #define isCNTRL_uni(c) is_uni_cntrl(c)
309 #define isGRAPH_uni(c) is_uni_graph(c)
310 #define isPRINT_uni(c) is_uni_print(c)
311 #define isPUNCT_uni(c) is_uni_punct(c)
312 #define isXDIGIT_uni(c) is_uni_xdigit(c)
313 #define toUPPER_uni(c) to_uni_upper(c)
314 #define toTITLE_uni(c) to_uni_title(c)
315 #define toLOWER_uni(c) to_uni_lower(c)
317 #define isALNUM_LC_uni(c) (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
318 #define isIDFIRST_LC_uni(c) (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
319 #define isALPHA_LC_uni(c) (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
320 #define isSPACE_LC_uni(c) (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
321 #define isDIGIT_LC_uni(c) (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
322 #define isUPPER_LC_uni(c) (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
323 #define isLOWER_LC_uni(c) (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
324 #define isALNUMC_LC_uni(c) (c < 256 ? isALNUMC_LC(c) : is_uni_alnumc_lc(c))
325 #define isCNTRL_LC_uni(c) (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
326 #define isGRAPH_LC_uni(c) (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
327 #define isPRINT_LC_uni(c) (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
328 #define isPUNCT_LC_uni(c) (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
329 #define toUPPER_LC_uni(c) (c < 256 ? toUPPER_LC(c) : to_uni_upper_lc(c))
330 #define toTITLE_LC_uni(c) (c < 256 ? toUPPER_LC(c) : to_uni_title_lc(c))
331 #define toLOWER_LC_uni(c) (c < 256 ? toLOWER_LC(c) : to_uni_lower_lc(c))
333 #define isALNUM_utf8(p) is_utf8_alnum(p)
334 #define isIDFIRST_utf8(p) is_utf8_idfirst(p)
335 #define isALPHA_utf8(p) is_utf8_alpha(p)
336 #define isSPACE_utf8(p) is_utf8_space(p)
337 #define isDIGIT_utf8(p) is_utf8_digit(p)
338 #define isUPPER_utf8(p) is_utf8_upper(p)
339 #define isLOWER_utf8(p) is_utf8_lower(p)
340 #define isALNUMC_utf8(p) is_utf8_alnumc(p)
341 #define isASCII_utf8(p) is_utf8_ascii(p)
342 #define isCNTRL_utf8(p) is_utf8_cntrl(p)
343 #define isGRAPH_utf8(p) is_utf8_graph(p)
344 #define isPRINT_utf8(p) is_utf8_print(p)
345 #define isPUNCT_utf8(p) is_utf8_punct(p)
346 #define isXDIGIT_utf8(p) is_utf8_xdigit(p)
347 #define toUPPER_utf8(p) to_utf8_upper(p)
348 #define toTITLE_utf8(p) to_utf8_title(p)
349 #define toLOWER_utf8(p) to_utf8_lower(p)
351 #define isALNUM_LC_utf8(p) isALNUM_LC_uni(utf8_to_uv(p, 0))
352 #define isIDFIRST_LC_utf8(p) isIDFIRST_LC_uni(utf8_to_uv(p, 0))
353 #define isALPHA_LC_utf8(p) isALPHA_LC_uni(utf8_to_uv(p, 0))
354 #define isSPACE_LC_utf8(p) isSPACE_LC_uni(utf8_to_uv(p, 0))
355 #define isDIGIT_LC_utf8(p) isDIGIT_LC_uni(utf8_to_uv(p, 0))
356 #define isUPPER_LC_utf8(p) isUPPER_LC_uni(utf8_to_uv(p, 0))
357 #define isLOWER_LC_utf8(p) isLOWER_LC_uni(utf8_to_uv(p, 0))
358 #define isALNUMC_LC_utf8(p) isALNUMC_LC_uni(utf8_to_uv(p, 0))
359 #define isCNTRL_LC_utf8(p) isCNTRL_LC_uni(utf8_to_uv(p, 0))
360 #define isGRAPH_LC_utf8(p) isGRAPH_LC_uni(utf8_to_uv(p, 0))
361 #define isPRINT_LC_utf8(p) isPRINT_LC_uni(utf8_to_uv(p, 0))
362 #define isPUNCT_LC_utf8(p) isPUNCT_LC_uni(utf8_to_uv(p, 0))
363 #define toUPPER_LC_utf8(p) toUPPER_LC_uni(utf8_to_uv(p, 0))
364 #define toTITLE_LC_utf8(p) toTITLE_LC_uni(utf8_to_uv(p, 0))
365 #define toLOWER_LC_utf8(p) toLOWER_LC_uni(utf8_to_uv(p, 0))
368 EXT int ebcdic_control (int);
369 # define toCTRL(c) ebcdic_control(c)
371 /* This conversion works both ways, strangely enough. */
372 # define toCTRL(c) (toUPPER(c) ^ 64)
375 /* Line numbers are unsigned, 16 bits. */
378 #define NOLINE ((line_t)0)
380 #define NOLINE ((line_t) 65535)
384 /* This looks obsolete (IZ):
386 XXX LEAKTEST doesn't really work in perl5. There are direct calls to
387 safemalloc() in the source, so LEAKTEST won't pick them up.
388 Further, if you try LEAKTEST, you'll also end up calling
389 Safefree, which might call safexfree() on some things that weren't
390 malloced with safexmalloc. The correct "fix" to this, if anyone
391 is interested, is to ensure that all calls go through the New and
393 --Andy Dougherty August 1996
398 #define NEWSV(x,len) newSV(len)
402 #define New(x,v,n,t) (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
403 #define Newc(x,v,n,t,c) (v = (c*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
404 #define Newz(x,v,n,t) (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))), \
405 memzero((char*)(v), (n)*sizeof(t))
406 #define Renew(v,n,t) \
407 (v = (t*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
408 #define Renewc(v,n,t,c) \
409 (v = (c*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
410 #define Safefree(d) safefree((Malloc_t)(d))
414 #define New(x,v,n,t) (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
415 #define Newc(x,v,n,t,c) (v = (c*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
416 #define Newz(x,v,n,t) (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t)))), \
417 memzero((char*)(v), (n)*sizeof(t))
418 #define Renew(v,n,t) \
419 (v = (t*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
420 #define Renewc(v,n,t,c) \
421 (v = (c*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
422 #define Safefree(d) safexfree((Malloc_t)(d))
424 #define MAXXCOUNT 1400
426 #define MAXYCOUNT 16 /* (MAXY_SIZE/4 + 1) */
427 extern long xcount[MAXXCOUNT];
428 extern long lastxcount[MAXXCOUNT];
429 extern long xycount[MAXXCOUNT][MAXYCOUNT];
430 extern long lastxycount[MAXXCOUNT][MAXYCOUNT];
432 #endif /* LEAKTEST */
434 #define Move(s,d,n,t) (void)memmove((char*)(d),(char*)(s), (n) * sizeof(t))
435 #define Copy(s,d,n,t) (void)memcpy((char*)(d),(char*)(s), (n) * sizeof(t))
436 #define Zero(d,n,t) (void)memzero((char*)(d), (n) * sizeof(t))
440 #define New(x,v,n,s) (v = Null(s *))
441 #define Newc(x,v,n,s,c) (v = Null(s *))
442 #define Newz(x,v,n,s) (v = Null(s *))
443 #define Renew(v,n,s) (v = Null(s *))
444 #define Move(s,d,n,t)
445 #define Copy(s,d,n,t)
447 #define Safefree(d) (d) = (d)
451 #ifdef USE_STRUCT_COPY
452 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
454 #define StructCopy(s,d,t) Copy(s,d,1,t)