This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Continue what #4494 started; introduce uid and gid formats.
[perl5.git] / handy.h
1 /*    handy.h
2  *
3  *    Copyright (c) 1991-1999, 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 #if defined(NeXT) || defined(__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 || __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    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.
88
89    Similarly, there is no guarantee that I16 and U16 have exactly 16
90    bits.
91
92    For dealing with issues that may arise from various 32/64-bit 
93    systems, we will ask Configure to check out 
94
95         SHORTSIZE == sizeof(short)
96         INTSIZE == sizeof(int)
97         LONGSIZE == sizeof(long)
98         LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
99         PTRSIZE == sizeof(void *)
100         DOUBLESIZE == sizeof(double)
101         LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
102
103 */
104
105 typedef I8TYPE I8;
106 typedef U8TYPE U8;
107 typedef I16TYPE I16;
108 typedef U16TYPE U16;
109 typedef I32TYPE I32;
110 typedef U32TYPE U32;
111 #ifdef Quad_t
112 typedef I64TYPE I64;
113 typedef U64TYPE U64;
114 #endif
115
116 /* Mention I8SIZE, U8SIZE, I16SIZE, U16SIZE, I32SIZE, U32SIZE,
117    I64SIZE, and U64SIZE here so that metaconfig pulls them in. */
118
119 #if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
120
121 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
122    Please search CHAR_MAX in perl.h for further details. */
123 #define U8_MAX UINT8_MAX
124 #define U8_MIN UINT8_MIN
125
126 #define I16_MAX INT16_MAX
127 #define I16_MIN INT16_MIN
128 #define U16_MAX UINT16_MAX
129 #define U16_MIN UINT16_MIN
130
131 #define I32_MAX INT32_MAX
132 #define I32_MIN INT32_MIN
133 #define U32_MAX UINT32_MAX
134 #define U32_MIN UINT32_MIN
135
136 #else
137
138 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
139    Please search CHAR_MAX in perl.h for further details. */
140 #define U8_MAX PERL_UCHAR_MAX
141 #define U8_MIN PERL_UCHAR_MIN
142
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
147
148 #if LONGSIZE > 4
149 # define I32_MAX PERL_INT_MAX
150 # define I32_MIN PERL_INT_MIN
151 # define U32_MAX PERL_UINT_MAX
152 # define U32_MIN PERL_UINT_MIN
153 #else
154 # define I32_MAX PERL_LONG_MAX
155 # define I32_MIN PERL_LONG_MIN
156 # define U32_MAX PERL_ULONG_MAX
157 # define U32_MIN PERL_ULONG_MIN
158 #endif
159
160 #endif
161
162 #define BIT_DIGITS(N)   (((N)*146)/485 + 1)  /* log2(10) =~ 146/485 */
163 #define TYPE_DIGITS(T)  BIT_DIGITS(sizeof(T) * 8)
164 #define TYPE_CHARS(T)   (TYPE_DIGITS(T) + 2) /* sign, NUL */
165
166 #define Ctl(ch) ((ch) & 037)
167
168 #define strNE(s1,s2) (strcmp(s1,s2))
169 #define strEQ(s1,s2) (!strcmp(s1,s2))
170 #define strLT(s1,s2) (strcmp(s1,s2) < 0)
171 #define strLE(s1,s2) (strcmp(s1,s2) <= 0)
172 #define strGT(s1,s2) (strcmp(s1,s2) > 0)
173 #define strGE(s1,s2) (strcmp(s1,s2) >= 0)
174 #define strnNE(s1,s2,l) (strncmp(s1,s2,l))
175 #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
176
177 #ifdef HAS_MEMCMP
178 #  define memNE(s1,s2,l) (memcmp(s1,s2,l))
179 #  define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
180 #else
181 #  define memNE(s1,s2,l) (bcmp(s1,s2,l))
182 #  define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
183 #endif
184
185 /*
186  * Character classes.
187  *
188  * Unfortunately, the introduction of locales means that we
189  * can't trust isupper(), etc. to tell the truth.  And when
190  * it comes to /\w+/ with tainting enabled, we *must* be able
191  * to trust our character classes.
192  *
193  * Therefore, the default tests in the text of Perl will be
194  * independent of locale.  Any code that wants to depend on
195  * the current locale will use the tests that begin with "lc".
196  */
197
198 #ifdef HAS_SETLOCALE  /* XXX Is there a better test for this? */
199 #  ifndef CTYPE256
200 #    define CTYPE256
201 #  endif
202 #endif
203
204 #define isALNUM(c)      (isALPHA(c) || isDIGIT(c) || (c) == '_')
205 #define isIDFIRST(c)    (isALPHA(c) || (c) == '_')
206 #define isALPHA(c)      (isUPPER(c) || isLOWER(c))
207 #define isSPACE(c) \
208         ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
209 #define isDIGIT(c)      ((c) >= '0' && (c) <= '9')
210 #ifdef EBCDIC
211     /* In EBCDIC we do not do locales: therefore() isupper() is fine. */
212 #   define isUPPER(c)   isupper(c)
213 #   define isLOWER(c)   islower(c)
214 #   define isALNUMC(c)  isalnum(c)
215 #   define isASCII(c)   isascii(c)
216 #   define isCNTRL(c)   iscntrl(c)
217 #   define isGRAPH(c)   isgraph(c)
218 #   define isPRINT(c)   isprint(c)
219 #   define isPUNCT(c)   ispunct(c)
220 #   define isXDIGIT(c)  isxdigit(c)
221 #   define toUPPER(c)   toupper(c)
222 #   define toLOWER(c)   tolower(c)
223 #else
224 #   define isUPPER(c)   ((c) >= 'A' && (c) <= 'Z')
225 #   define isLOWER(c)   ((c) >= 'a' && (c) <= 'z')
226 #   define isALNUMC(c)  (isALPHA(c) || isDIGIT(c))
227 #   define isASCII(c)   ((c) <= 127)
228 #   define isCNTRL(c)   ((c) < ' ')
229 #   define isGRAPH(c)   (isALNUM(c) || isPUNCT(c))
230 #   define isPRINT(c)   (((c) > 32 && (c) < 127) || isSPACE(c))
231 #   define isPUNCT(c)   (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64)  || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
232 #   define isXDIGIT(c)  (isdigit(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F'))
233 #   define toUPPER(c)   (isLOWER(c) ? (c) - ('a' - 'A') : (c))
234 #   define toLOWER(c)   (isUPPER(c) ? (c) + ('a' - 'A') : (c))
235 #endif
236
237 #ifdef USE_NEXT_CTYPE
238
239 #  define isALNUM_LC(c) \
240         (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
241 #  define isIDFIRST_LC(c) \
242         (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
243 #  define isALPHA_LC(c)         NXIsAlpha((unsigned int)(c))
244 #  define isSPACE_LC(c)         NXIsSpace((unsigned int)(c))
245 #  define isDIGIT_LC(c)         NXIsDigit((unsigned int)(c))
246 #  define isUPPER_LC(c)         NXIsUpper((unsigned int)(c))
247 #  define isLOWER_LC(c)         NXIsLower((unsigned int)(c))
248 #  define isALNUMC_LC(c)        NXIsAlNum((unsigned int)(c))
249 #  define isCNTRL_LC(c)         NXIsCntrl((unsigned int)(c))
250 #  define isGRAPH_LC(c)         NXIsGraph((unsigned int)(c))
251 #  define isPRINT_LC(c)         NXIsPrint((unsigned int)(c))
252 #  define isPUNCT_LC(c)         NXIsPunct((unsigned int)(c))
253 #  define toUPPER_LC(c)         NXToUpper((unsigned int)(c))
254 #  define toLOWER_LC(c)         NXToLower((unsigned int)(c))
255
256 #else /* !USE_NEXT_CTYPE */
257
258 #  if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
259
260 #    define isALNUM_LC(c)   (isalnum((unsigned char)(c)) || (char)(c) == '_')
261 #    define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
262 #    define isALPHA_LC(c)       isalpha((unsigned char)(c))
263 #    define isSPACE_LC(c)       isspace((unsigned char)(c))
264 #    define isDIGIT_LC(c)       isdigit((unsigned char)(c))
265 #    define isUPPER_LC(c)       isupper((unsigned char)(c))
266 #    define isLOWER_LC(c)       islower((unsigned char)(c))
267 #    define isALNUMC_LC(c)      isalnum((unsigned char)(c))
268 #    define isCNTRL_LC(c)       iscntrl((unsigned char)(c))
269 #    define isGRAPH_LC(c)       isgraph((unsigned char)(c))
270 #    define isPRINT_LC(c)       isprint((unsigned char)(c))
271 #    define isPUNCT_LC(c)       ispunct((unsigned char)(c))
272 #    define toUPPER_LC(c)       toupper((unsigned char)(c))
273 #    define toLOWER_LC(c)       tolower((unsigned char)(c))
274
275 #  else
276
277 #    define isALNUM_LC(c)       (isascii(c) && (isalnum(c) || (c) == '_'))
278 #    define isIDFIRST_LC(c)     (isascii(c) && (isalpha(c) || (c) == '_'))
279 #    define isALPHA_LC(c)       (isascii(c) && isalpha(c))
280 #    define isSPACE_LC(c)       (isascii(c) && isspace(c))
281 #    define isDIGIT_LC(c)       (isascii(c) && isdigit(c))
282 #    define isUPPER_LC(c)       (isascii(c) && isupper(c))
283 #    define isLOWER_LC(c)       (isascii(c) && islower(c))
284 #    define isALNUMC_LC(c)      (isascii(c) && isalnum(c))
285 #    define isCNTRL_LC(c)       (isascii(c) && iscntrl(c))
286 #    define isGRAPH_LC(c)       (isascii(c) && isgraph(c))
287 #    define isPRINT_LC(c)       (isascii(c) && isprint(c))
288 #    define isPUNCT_LC(c)       (isascii(c) && ispunct(c))
289 #    define toUPPER_LC(c)       toupper(c)
290 #    define toLOWER_LC(c)       tolower(c)
291
292 #  endif
293 #endif /* USE_NEXT_CTYPE */
294
295 #define isALNUM_uni(c)          is_uni_alnum(c)
296 #define isIDFIRST_uni(c)        is_uni_idfirst(c)
297 #define isALPHA_uni(c)          is_uni_alpha(c)
298 #define isSPACE_uni(c)          is_uni_space(c)
299 #define isDIGIT_uni(c)          is_uni_digit(c)
300 #define isUPPER_uni(c)          is_uni_upper(c)
301 #define isLOWER_uni(c)          is_uni_lower(c)
302 #define isALNUMC_uni(c)         is_uni_alnumc(c)
303 #define isASCII_uni(c)          is_uni_ascii(c)
304 #define isCNTRL_uni(c)          is_uni_cntrl(c)
305 #define isGRAPH_uni(c)          is_uni_graph(c)
306 #define isPRINT_uni(c)          is_uni_print(c)
307 #define isPUNCT_uni(c)          is_uni_punct(c)
308 #define isXDIGIT_uni(c)         is_uni_xdigit(c)
309 #define toUPPER_uni(c)          to_uni_upper(c)
310 #define toTITLE_uni(c)          to_uni_title(c)
311 #define toLOWER_uni(c)          to_uni_lower(c)
312
313 #define isALNUM_LC_uni(c)       (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
314 #define isIDFIRST_LC_uni(c)     (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
315 #define isALPHA_LC_uni(c)       (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
316 #define isSPACE_LC_uni(c)       (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
317 #define isDIGIT_LC_uni(c)       (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
318 #define isUPPER_LC_uni(c)       (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
319 #define isLOWER_LC_uni(c)       (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
320 #define isALNUMC_LC_uni(c)      (c < 256 ? isALNUMC_LC(c) : is_uni_alnumc_lc(c))
321 #define isCNTRL_LC_uni(c)       (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
322 #define isGRAPH_LC_uni(c)       (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
323 #define isPRINT_LC_uni(c)       (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
324 #define isPUNCT_LC_uni(c)       (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
325 #define toUPPER_LC_uni(c)       (c < 256 ? toUPPER_LC(c) : to_uni_upper_lc(c))
326 #define toTITLE_LC_uni(c)       (c < 256 ? toUPPER_LC(c) : to_uni_title_lc(c))
327 #define toLOWER_LC_uni(c)       (c < 256 ? toLOWER_LC(c) : to_uni_lower_lc(c))
328
329 #define isALNUM_utf8(p)         is_utf8_alnum(p)
330 #define isIDFIRST_utf8(p)       is_utf8_idfirst(p)
331 #define isALPHA_utf8(p)         is_utf8_alpha(p)
332 #define isSPACE_utf8(p)         is_utf8_space(p)
333 #define isDIGIT_utf8(p)         is_utf8_digit(p)
334 #define isUPPER_utf8(p)         is_utf8_upper(p)
335 #define isLOWER_utf8(p)         is_utf8_lower(p)
336 #define isALNUMC_utf8(p)        is_utf8_alnumc(p)
337 #define isASCII_utf8(p)         is_utf8_ascii(p)
338 #define isCNTRL_utf8(p)         is_utf8_cntrl(p)
339 #define isGRAPH_utf8(p)         is_utf8_graph(p)
340 #define isPRINT_utf8(p)         is_utf8_print(p)
341 #define isPUNCT_utf8(p)         is_utf8_punct(p)
342 #define isXDIGIT_utf8(p)        is_utf8_xdigit(p)
343 #define toUPPER_utf8(p)         to_utf8_upper(p)
344 #define toTITLE_utf8(p)         to_utf8_title(p)
345 #define toLOWER_utf8(p)         to_utf8_lower(p)
346
347 #define isALNUM_LC_utf8(p)      isALNUM_LC_uni(utf8_to_uv(p, 0))
348 #define isIDFIRST_LC_utf8(p)    isIDFIRST_LC_uni(utf8_to_uv(p, 0))
349 #define isALPHA_LC_utf8(p)      isALPHA_LC_uni(utf8_to_uv(p, 0))
350 #define isSPACE_LC_utf8(p)      isSPACE_LC_uni(utf8_to_uv(p, 0))
351 #define isDIGIT_LC_utf8(p)      isDIGIT_LC_uni(utf8_to_uv(p, 0))
352 #define isUPPER_LC_utf8(p)      isUPPER_LC_uni(utf8_to_uv(p, 0))
353 #define isLOWER_LC_utf8(p)      isLOWER_LC_uni(utf8_to_uv(p, 0))
354 #define isALNUMC_LC_utf8(p)     isALNUMC_LC_uni(utf8_to_uv(p, 0))
355 #define isCNTRL_LC_utf8(p)      isCNTRL_LC_uni(utf8_to_uv(p, 0))
356 #define isGRAPH_LC_utf8(p)      isGRAPH_LC_uni(utf8_to_uv(p, 0))
357 #define isPRINT_LC_utf8(p)      isPRINT_LC_uni(utf8_to_uv(p, 0))
358 #define isPUNCT_LC_utf8(p)      isPUNCT_LC_uni(utf8_to_uv(p, 0))
359 #define toUPPER_LC_utf8(p)      toUPPER_LC_uni(utf8_to_uv(p, 0))
360 #define toTITLE_LC_utf8(p)      toTITLE_LC_uni(utf8_to_uv(p, 0))
361 #define toLOWER_LC_utf8(p)      toLOWER_LC_uni(utf8_to_uv(p, 0))
362
363 #ifdef EBCDIC
364 EXT int ebcdic_control (int);
365 #  define toCTRL(c)     ebcdic_control(c)
366 #else
367   /* This conversion works both ways, strangely enough. */
368 #  define toCTRL(c)    (toUPPER(c) ^ 64)
369 #endif
370
371 /* Line numbers are unsigned, 16 bits. */
372 typedef U16 line_t;
373 #ifdef lint
374 #define NOLINE ((line_t)0)
375 #else
376 #define NOLINE ((line_t) 65535)
377 #endif
378
379
380 /* This looks obsolete (IZ):
381
382    XXX LEAKTEST doesn't really work in perl5.  There are direct calls to
383    safemalloc() in the source, so LEAKTEST won't pick them up.
384    Further, if you try LEAKTEST, you'll also end up calling
385    Safefree, which might call safexfree() on some things that weren't
386    malloced with safexmalloc.  The correct "fix" to this, if anyone
387    is interested, is to ensure that all calls go through the New and
388    Renew macros.
389         --Andy Dougherty                August 1996
390 */
391
392 #ifndef lint
393
394 #define NEWSV(x,len)    newSV(len)
395
396 #ifndef LEAKTEST
397
398 #define New(x,v,n,t)    (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
399 #define Newc(x,v,n,t,c) (v = (c*)safemalloc((MEM_SIZE)((n)*sizeof(t))))
400 #define Newz(x,v,n,t)   (v = (t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))), \
401                         memzero((char*)(v), (n)*sizeof(t))
402 #define Renew(v,n,t) \
403           (v = (t*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
404 #define Renewc(v,n,t,c) \
405           (v = (c*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
406 #define Safefree(d)     safefree((Malloc_t)(d))
407
408 #else /* LEAKTEST */
409
410 #define New(x,v,n,t)    (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
411 #define Newc(x,v,n,t,c) (v = (c*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t))))
412 #define Newz(x,v,n,t)   (v = (t*)safexmalloc((x),(MEM_SIZE)((n)*sizeof(t)))), \
413                          memzero((char*)(v), (n)*sizeof(t))
414 #define Renew(v,n,t) \
415           (v = (t*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
416 #define Renewc(v,n,t,c) \
417           (v = (c*)safexrealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))
418 #define Safefree(d)     safexfree((Malloc_t)(d))
419
420 #define MAXXCOUNT 1400
421 #define MAXY_SIZE 80
422 #define MAXYCOUNT 16                    /* (MAXY_SIZE/4 + 1) */
423 extern long xcount[MAXXCOUNT];
424 extern long lastxcount[MAXXCOUNT];
425 extern long xycount[MAXXCOUNT][MAXYCOUNT];
426 extern long lastxycount[MAXXCOUNT][MAXYCOUNT];
427
428 #endif /* LEAKTEST */
429
430 #define Move(s,d,n,t)   (void)memmove((char*)(d),(char*)(s), (n) * sizeof(t))
431 #define Copy(s,d,n,t)   (void)memcpy((char*)(d),(char*)(s), (n) * sizeof(t))
432 #define Zero(d,n,t)     (void)memzero((char*)(d), (n) * sizeof(t))
433
434 #else /* lint */
435
436 #define New(x,v,n,s)    (v = Null(s *))
437 #define Newc(x,v,n,s,c) (v = Null(s *))
438 #define Newz(x,v,n,s)   (v = Null(s *))
439 #define Renew(v,n,s)    (v = Null(s *))
440 #define Move(s,d,n,t)
441 #define Copy(s,d,n,t)
442 #define Zero(d,n,t)
443 #define Safefree(d)     (d) = (d)
444
445 #endif /* lint */
446
447 #ifdef USE_STRUCT_COPY
448 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
449 #else
450 #define StructCopy(s,d,t) Copy(s,d,1,t)
451 #endif