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