Upgrade to PathTools-3.14_01
[perl.git] / handy.h
1 /*    handy.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999,
4  *    2000, 2001, 2002, 2004, 2005 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 #if !defined(__STDC__)
12 #ifdef NULL
13 #undef NULL
14 #endif
15 #ifndef I286
16 #  define NULL 0
17 #else
18 #  define NULL 0L
19 #endif
20 #endif
21
22 #define Null(type) ((type)NULL)
23
24 /*
25 =head1 Handy Values
26
27 =for apidoc AmU||Nullch
28 Null character pointer.
29
30 =for apidoc AmU||Nullsv
31 Null SV pointer.
32
33 =cut
34 */
35
36 #define Nullch Null(char*)
37 #define Nullfp Null(PerlIO*)
38 #define Nullsv Null(SV*)
39
40 #ifdef TRUE
41 #undef TRUE
42 #endif
43 #ifdef FALSE
44 #undef FALSE
45 #endif
46 #define TRUE (1)
47 #define FALSE (0)
48
49
50 /* XXX Configure ought to have a test for a boolean type, if I can
51    just figure out all the headers such a test needs.
52    Andy Dougherty       August 1996
53 */
54 /* bool is built-in for g++-2.6.3 and later, which might be used
55    for extensions.  <_G_config.h> defines _G_HAVE_BOOL, but we can't
56    be sure _G_config.h will be included before this file.  _G_config.h
57    also defines _G_HAVE_BOOL for both gcc and g++, but only g++
58    actually has bool.  Hence, _G_HAVE_BOOL is pretty useless for us.
59    g++ can be identified by __GNUG__.
60    Andy Dougherty       February 2000
61 */
62 #ifdef __GNUG__         /* GNU g++ has bool built-in */
63 #  ifndef HAS_BOOL
64 #    define HAS_BOOL 1
65 #  endif
66 #endif
67
68 /* The NeXT dynamic loader headers will not build with the bool macro
69    So declare them now to clear confusion.
70 */
71 #if defined(NeXT) || defined(__NeXT__)
72 # undef FALSE
73 # undef TRUE
74   typedef enum bool { FALSE = 0, TRUE = 1 } bool;
75 # define ENUM_BOOL 1
76 # ifndef HAS_BOOL
77 #  define HAS_BOOL 1
78 # endif /* !HAS_BOOL */
79 #endif /* NeXT || __NeXT__ */
80
81 #ifndef HAS_BOOL
82 # if defined(UTS) || defined(VMS)
83 #  define bool int
84 # else
85 #  define bool char
86 # endif
87 # define HAS_BOOL 1
88 #endif
89
90 /* Try to figure out __func__ or __FUNCTION__ equivalent, if any.
91  * XXX Should really be a Configure probe, with HAS__FUNCTION__
92  *     and FUNCTION__ as results.
93  * XXX Similarly, a Configure probe for __FILE__ and __LINE__ is needed. */
94 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || (defined(__SUNPRO_C)) /* C99 or close enough. */
95 #  define FUNCTION__ __func__
96 #else
97 #  if (defined(_MSC_VER) && _MSC_VER < 1300) || /* Pre-MSVC 7.0 has neither __func__ nor __FUNCTION and no good workarounds, either. */ \
98       (defined(__DECC_VER)) /* Tru64 or VMS, and strict C89 being used, but not modern enough cc (in Tur64, -c99 not known, only -std1). */
99 #    define FUNCTION__ ""
100 #  else
101 #    define FUNCTION__ __FUNCTION__ /* Common extension. */
102 #  endif
103 #endif
104
105 /* XXX A note on the perl source internal type system.  The
106    original intent was that I32 be *exactly* 32 bits.
107
108    Currently, we only guarantee that I32 is *at least* 32 bits.
109    Specifically, if int is 64 bits, then so is I32.  (This is the case
110    for the Cray.)  This has the advantage of meshing nicely with
111    standard library calls (where we pass an I32 and the library is
112    expecting an int), but the disadvantage that an I32 is not 32 bits.
113    Andy Dougherty       August 1996
114
115    There is no guarantee that there is *any* integral type with
116    exactly 32 bits.  It is perfectly legal for a system to have
117    sizeof(short) == sizeof(int) == sizeof(long) == 8.
118
119    Similarly, there is no guarantee that I16 and U16 have exactly 16
120    bits.
121
122    For dealing with issues that may arise from various 32/64-bit
123    systems, we will ask Configure to check out
124
125         SHORTSIZE == sizeof(short)
126         INTSIZE == sizeof(int)
127         LONGSIZE == sizeof(long)
128         LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
129         PTRSIZE == sizeof(void *)
130         DOUBLESIZE == sizeof(double)
131         LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
132
133 */
134
135 #ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
136 #   include <inttypes.h>
137 #   ifdef INT32_MIN_BROKEN
138 #       undef  INT32_MIN
139 #       define INT32_MIN (-2147483647-1)
140 #   endif
141 #   ifdef INT64_MIN_BROKEN
142 #       undef  INT64_MIN
143 #       define INT64_MIN (-9223372036854775807LL-1)
144 #   endif
145 #endif
146
147 typedef I8TYPE I8;
148 typedef U8TYPE U8;
149 typedef I16TYPE I16;
150 typedef U16TYPE U16;
151 typedef I32TYPE I32;
152 typedef U32TYPE U32;
153 #ifdef PERL_CORE
154 #   ifdef HAS_QUAD
155 typedef I64TYPE I64;
156 typedef U64TYPE U64;
157 #   endif
158 #endif /* PERL_CORE */
159
160 #if defined(HAS_QUAD) && defined(USE_64_BIT_INT)
161 #   ifndef UINT64_C /* usually from <inttypes.h> */
162 #       if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
163 #           define INT64_C(c)   CAT2(c,LL)
164 #           define UINT64_C(c)  CAT2(c,ULL)
165 #       else
166 #           if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
167 #               define INT64_C(c)       CAT2(c,L)
168 #               define UINT64_C(c)      CAT2(c,UL)
169 #           else
170 #               define INT64_C(c)       ((I64TYPE)(c))
171 #               define UINT64_C(c)      ((U64TYPE)(c))
172 #           endif
173 #       endif
174 #   endif
175 #endif
176
177 /* HMB H.Merijn Brand - a placeholder for preparing Configure patches */
178 #if defined(HAS_MALLOC_SIZE) && defined(HAS_MALLOC_GOOD_SIZE) && defined(HAS_CLEARENV)
179 /* Not (yet) used at top level, but mention them for metaconfig */
180 #endif
181
182 /* Mention I8SIZE, U8SIZE, I16SIZE, U16SIZE, I32SIZE, U32SIZE,
183    I64SIZE, and U64SIZE here so that metaconfig pulls them in. */
184
185 #if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
186
187 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
188    Please search CHAR_MAX in perl.h for further details. */
189 #define U8_MAX UINT8_MAX
190 #define U8_MIN UINT8_MIN
191
192 #define I16_MAX INT16_MAX
193 #define I16_MIN INT16_MIN
194 #define U16_MAX UINT16_MAX
195 #define U16_MIN UINT16_MIN
196
197 #define I32_MAX INT32_MAX
198 #define I32_MIN INT32_MIN
199 #ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
200 #  define U32_MAX UINT32_MAX
201 #else
202 #  define U32_MAX 4294967295U
203 #endif
204 #define U32_MIN UINT32_MIN
205
206 #else
207
208 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
209    Please search CHAR_MAX in perl.h for further details. */
210 #define U8_MAX PERL_UCHAR_MAX
211 #define U8_MIN PERL_UCHAR_MIN
212
213 #define I16_MAX PERL_SHORT_MAX
214 #define I16_MIN PERL_SHORT_MIN
215 #define U16_MAX PERL_USHORT_MAX
216 #define U16_MIN PERL_USHORT_MIN
217
218 #if LONGSIZE > 4
219 # define I32_MAX PERL_INT_MAX
220 # define I32_MIN PERL_INT_MIN
221 # define U32_MAX PERL_UINT_MAX
222 # define U32_MIN PERL_UINT_MIN
223 #else
224 # define I32_MAX PERL_LONG_MAX
225 # define I32_MIN PERL_LONG_MIN
226 # define U32_MAX PERL_ULONG_MAX
227 # define U32_MIN PERL_ULONG_MIN
228 #endif
229
230 #endif
231
232 /* log(2) is pretty close to  0.30103, just in case anyone is grepping for it */
233 #define BIT_DIGITS(N)   (((N)*146)/485 + 1)  /* log2(10) =~ 146/485 */
234 #define TYPE_DIGITS(T)  BIT_DIGITS(sizeof(T) * 8)
235 #define TYPE_CHARS(T)   (TYPE_DIGITS(T) + 2) /* sign, NUL */
236
237 #define Ctl(ch) ((ch) & 037)
238
239 /*
240 =head1 Miscellaneous Functions
241
242 =for apidoc Am|bool|strNE|char* s1|char* s2
243 Test two strings to see if they are different.  Returns true or
244 false.
245
246 =for apidoc Am|bool|strEQ|char* s1|char* s2
247 Test two strings to see if they are equal.  Returns true or false.
248
249 =for apidoc Am|bool|strLT|char* s1|char* s2
250 Test two strings to see if the first, C<s1>, is less than the second,
251 C<s2>.  Returns true or false.
252
253 =for apidoc Am|bool|strLE|char* s1|char* s2
254 Test two strings to see if the first, C<s1>, is less than or equal to the
255 second, C<s2>.  Returns true or false.
256
257 =for apidoc Am|bool|strGT|char* s1|char* s2
258 Test two strings to see if the first, C<s1>, is greater than the second,
259 C<s2>.  Returns true or false.
260
261 =for apidoc Am|bool|strGE|char* s1|char* s2
262 Test two strings to see if the first, C<s1>, is greater than or equal to
263 the second, C<s2>.  Returns true or false.
264
265 =for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
266 Test two strings to see if they are different.  The C<len> parameter
267 indicates the number of bytes to compare.  Returns true or false. (A
268 wrapper for C<strncmp>).
269
270 =for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
271 Test two strings to see if they are equal.  The C<len> parameter indicates
272 the number of bytes to compare.  Returns true or false. (A wrapper for
273 C<strncmp>).
274
275 =cut
276 */
277
278 #define strNE(s1,s2) (strcmp(s1,s2))
279 #define strEQ(s1,s2) (!strcmp(s1,s2))
280 #define strLT(s1,s2) (strcmp(s1,s2) < 0)
281 #define strLE(s1,s2) (strcmp(s1,s2) <= 0)
282 #define strGT(s1,s2) (strcmp(s1,s2) > 0)
283 #define strGE(s1,s2) (strcmp(s1,s2) >= 0)
284 #define strnNE(s1,s2,l) (strncmp(s1,s2,l))
285 #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
286
287 #ifdef HAS_MEMCMP
288 #  define memNE(s1,s2,l) (memcmp(s1,s2,l))
289 #  define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
290 #else
291 #  define memNE(s1,s2,l) (bcmp(s1,s2,l))
292 #  define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
293 #endif
294
295 /*
296  * Character classes.
297  *
298  * Unfortunately, the introduction of locales means that we
299  * can't trust isupper(), etc. to tell the truth.  And when
300  * it comes to /\w+/ with tainting enabled, we *must* be able
301  * to trust our character classes.
302  *
303  * Therefore, the default tests in the text of Perl will be
304  * independent of locale.  Any code that wants to depend on
305  * the current locale will use the tests that begin with "lc".
306  */
307
308 #ifdef HAS_SETLOCALE  /* XXX Is there a better test for this? */
309 #  ifndef CTYPE256
310 #    define CTYPE256
311 #  endif
312 #endif
313
314 /*
315
316 =head1 Character classes
317
318 =for apidoc Am|bool|isALNUM|char ch
319 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
320 character (including underscore) or digit.
321
322 =for apidoc Am|bool|isALPHA|char ch
323 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
324 character.
325
326 =for apidoc Am|bool|isSPACE|char ch
327 Returns a boolean indicating whether the C C<char> is whitespace.
328
329 =for apidoc Am|bool|isDIGIT|char ch
330 Returns a boolean indicating whether the C C<char> is an ASCII
331 digit.
332
333 =for apidoc Am|bool|isUPPER|char ch
334 Returns a boolean indicating whether the C C<char> is an uppercase
335 character.
336
337 =for apidoc Am|bool|isLOWER|char ch
338 Returns a boolean indicating whether the C C<char> is a lowercase
339 character.
340
341 =for apidoc Am|char|toUPPER|char ch
342 Converts the specified character to uppercase.
343
344 =for apidoc Am|char|toLOWER|char ch
345 Converts the specified character to lowercase.
346
347 =cut
348 */
349
350 #define isALNUM(c)      (isALPHA(c) || isDIGIT(c) || (c) == '_')
351 #define isIDFIRST(c)    (isALPHA(c) || (c) == '_')
352 #define isALPHA(c)      (isUPPER(c) || isLOWER(c))
353 #define isSPACE(c) \
354         ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
355 #define isPSXSPC(c)     (isSPACE(c) || (c) == '\v')
356 #define isBLANK(c)      ((c) == ' ' || (c) == '\t')
357 #define isDIGIT(c)      ((c) >= '0' && (c) <= '9')
358 #ifdef EBCDIC
359     /* In EBCDIC we do not do locales: therefore() isupper() is fine. */
360 #   define isUPPER(c)   isupper(c)
361 #   define isLOWER(c)   islower(c)
362 #   define isALNUMC(c)  isalnum(c)
363 #   define isASCII(c)   isascii(c)
364 #   define isCNTRL(c)   iscntrl(c)
365 #   define isGRAPH(c)   isgraph(c)
366 #   define isPRINT(c)   isprint(c)
367 #   define isPUNCT(c)   ispunct(c)
368 #   define isXDIGIT(c)  isxdigit(c)
369 #   define toUPPER(c)   toupper(c)
370 #   define toLOWER(c)   tolower(c)
371 #else
372 #   define isUPPER(c)   ((c) >= 'A' && (c) <= 'Z')
373 #   define isLOWER(c)   ((c) >= 'a' && (c) <= 'z')
374 #   define isALNUMC(c)  (isALPHA(c) || isDIGIT(c))
375 #   define isASCII(c)   ((c) <= 127)
376 #   define isCNTRL(c)   ((c) < ' ' || (c) == 127)
377 #   define isGRAPH(c)   (isALNUM(c) || isPUNCT(c))
378 #   define isPRINT(c)   (((c) > 32 && (c) < 127) || (c) == ' ')
379 #   define isPUNCT(c)   (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64)  || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
380 #   define isXDIGIT(c)  (isDIGIT(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F'))
381 #   define toUPPER(c)   (isLOWER(c) ? (c) - ('a' - 'A') : (c))
382 #   define toLOWER(c)   (isUPPER(c) ? (c) + ('a' - 'A') : (c))
383 #endif
384
385 #ifdef USE_NEXT_CTYPE
386
387 #  define isALNUM_LC(c) \
388         (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
389 #  define isIDFIRST_LC(c) \
390         (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
391 #  define isALPHA_LC(c)         NXIsAlpha((unsigned int)(c))
392 #  define isSPACE_LC(c)         NXIsSpace((unsigned int)(c))
393 #  define isDIGIT_LC(c)         NXIsDigit((unsigned int)(c))
394 #  define isUPPER_LC(c)         NXIsUpper((unsigned int)(c))
395 #  define isLOWER_LC(c)         NXIsLower((unsigned int)(c))
396 #  define isALNUMC_LC(c)        NXIsAlNum((unsigned int)(c))
397 #  define isCNTRL_LC(c)         NXIsCntrl((unsigned int)(c))
398 #  define isGRAPH_LC(c)         NXIsGraph((unsigned int)(c))
399 #  define isPRINT_LC(c)         NXIsPrint((unsigned int)(c))
400 #  define isPUNCT_LC(c)         NXIsPunct((unsigned int)(c))
401 #  define toUPPER_LC(c)         NXToUpper((unsigned int)(c))
402 #  define toLOWER_LC(c)         NXToLower((unsigned int)(c))
403
404 #else /* !USE_NEXT_CTYPE */
405
406 #  if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
407
408 #    define isALNUM_LC(c)   (isalnum((unsigned char)(c)) || (char)(c) == '_')
409 #    define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
410 #    define isALPHA_LC(c)       isalpha((unsigned char)(c))
411 #    define isSPACE_LC(c)       isspace((unsigned char)(c))
412 #    define isDIGIT_LC(c)       isdigit((unsigned char)(c))
413 #    define isUPPER_LC(c)       isupper((unsigned char)(c))
414 #    define isLOWER_LC(c)       islower((unsigned char)(c))
415 #    define isALNUMC_LC(c)      isalnum((unsigned char)(c))
416 #    define isCNTRL_LC(c)       iscntrl((unsigned char)(c))
417 #    define isGRAPH_LC(c)       isgraph((unsigned char)(c))
418 #    define isPRINT_LC(c)       isprint((unsigned char)(c))
419 #    define isPUNCT_LC(c)       ispunct((unsigned char)(c))
420 #    define toUPPER_LC(c)       toupper((unsigned char)(c))
421 #    define toLOWER_LC(c)       tolower((unsigned char)(c))
422
423 #  else
424
425 #    define isALNUM_LC(c)       (isascii(c) && (isalnum(c) || (c) == '_'))
426 #    define isIDFIRST_LC(c)     (isascii(c) && (isalpha(c) || (c) == '_'))
427 #    define isALPHA_LC(c)       (isascii(c) && isalpha(c))
428 #    define isSPACE_LC(c)       (isascii(c) && isspace(c))
429 #    define isDIGIT_LC(c)       (isascii(c) && isdigit(c))
430 #    define isUPPER_LC(c)       (isascii(c) && isupper(c))
431 #    define isLOWER_LC(c)       (isascii(c) && islower(c))
432 #    define isALNUMC_LC(c)      (isascii(c) && isalnum(c))
433 #    define isCNTRL_LC(c)       (isascii(c) && iscntrl(c))
434 #    define isGRAPH_LC(c)       (isascii(c) && isgraph(c))
435 #    define isPRINT_LC(c)       (isascii(c) && isprint(c))
436 #    define isPUNCT_LC(c)       (isascii(c) && ispunct(c))
437 #    define toUPPER_LC(c)       toupper(c)
438 #    define toLOWER_LC(c)       tolower(c)
439
440 #  endif
441 #endif /* USE_NEXT_CTYPE */
442
443 #define isPSXSPC_LC(c)          (isSPACE_LC(c) || (c) == '\v')
444 #define isBLANK_LC(c)           isBLANK(c) /* could be wrong */
445
446 #define isALNUM_uni(c)          is_uni_alnum(c)
447 #define isIDFIRST_uni(c)        is_uni_idfirst(c)
448 #define isALPHA_uni(c)          is_uni_alpha(c)
449 #define isSPACE_uni(c)          is_uni_space(c)
450 #define isDIGIT_uni(c)          is_uni_digit(c)
451 #define isUPPER_uni(c)          is_uni_upper(c)
452 #define isLOWER_uni(c)          is_uni_lower(c)
453 #define isALNUMC_uni(c)         is_uni_alnumc(c)
454 #define isASCII_uni(c)          is_uni_ascii(c)
455 #define isCNTRL_uni(c)          is_uni_cntrl(c)
456 #define isGRAPH_uni(c)          is_uni_graph(c)
457 #define isPRINT_uni(c)          is_uni_print(c)
458 #define isPUNCT_uni(c)          is_uni_punct(c)
459 #define isXDIGIT_uni(c)         is_uni_xdigit(c)
460 #define toUPPER_uni(c,s,l)      to_uni_upper(c,s,l)
461 #define toTITLE_uni(c,s,l)      to_uni_title(c,s,l)
462 #define toLOWER_uni(c,s,l)      to_uni_lower(c,s,l)
463 #define toFOLD_uni(c,s,l)       to_uni_fold(c,s,l)
464
465 #define isPSXSPC_uni(c)         (isSPACE_uni(c) ||(c) == '\f')
466 #define isBLANK_uni(c)          isBLANK(c) /* could be wrong */
467
468 #define isALNUM_LC_uvchr(c)     (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
469 #define isIDFIRST_LC_uvchr(c)   (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
470 #define isALPHA_LC_uvchr(c)     (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
471 #define isSPACE_LC_uvchr(c)     (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
472 #define isDIGIT_LC_uvchr(c)     (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
473 #define isUPPER_LC_uvchr(c)     (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
474 #define isLOWER_LC_uvchr(c)     (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
475 #define isALNUMC_LC_uvchr(c)    (c < 256 ? isALNUMC_LC(c) : is_uni_alnumc_lc(c))
476 #define isCNTRL_LC_uvchr(c)     (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
477 #define isGRAPH_LC_uvchr(c)     (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
478 #define isPRINT_LC_uvchr(c)     (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
479 #define isPUNCT_LC_uvchr(c)     (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
480
481 #define isPSXSPC_LC_uni(c)      (isSPACE_LC_uni(c) ||(c) == '\f')
482 #define isBLANK_LC_uni(c)       isBLANK(c) /* could be wrong */
483
484 #define isALNUM_utf8(p)         is_utf8_alnum(p)
485 /* The ID_Start of Unicode is quite limiting: it assumes a L-class
486  * character (meaning that you cannot have, say, a CJK character).
487  * Instead, let's allow ID_Continue but not digits. */
488 #define isIDFIRST_utf8(p)       (is_utf8_idcont(p) && !is_utf8_digit(p))
489 #define isALPHA_utf8(p)         is_utf8_alpha(p)
490 #define isSPACE_utf8(p)         is_utf8_space(p)
491 #define isDIGIT_utf8(p)         is_utf8_digit(p)
492 #define isUPPER_utf8(p)         is_utf8_upper(p)
493 #define isLOWER_utf8(p)         is_utf8_lower(p)
494 #define isALNUMC_utf8(p)        is_utf8_alnumc(p)
495 #define isASCII_utf8(p)         is_utf8_ascii(p)
496 #define isCNTRL_utf8(p)         is_utf8_cntrl(p)
497 #define isGRAPH_utf8(p)         is_utf8_graph(p)
498 #define isPRINT_utf8(p)         is_utf8_print(p)
499 #define isPUNCT_utf8(p)         is_utf8_punct(p)
500 #define isXDIGIT_utf8(p)        is_utf8_xdigit(p)
501 #define toUPPER_utf8(p,s,l)     to_utf8_upper(p,s,l)
502 #define toTITLE_utf8(p,s,l)     to_utf8_title(p,s,l)
503 #define toLOWER_utf8(p,s,l)     to_utf8_lower(p,s,l)
504
505 #define isPSXSPC_utf8(c)        (isSPACE_utf8(c) ||(c) == '\f')
506 #define isBLANK_utf8(c)         isBLANK(c) /* could be wrong */
507
508 #define isALNUM_LC_utf8(p)      isALNUM_LC_uvchr(utf8_to_uvchr(p,  0))
509 #define isIDFIRST_LC_utf8(p)    isIDFIRST_LC_uvchr(utf8_to_uvchr(p,  0))
510 #define isALPHA_LC_utf8(p)      isALPHA_LC_uvchr(utf8_to_uvchr(p,  0))
511 #define isSPACE_LC_utf8(p)      isSPACE_LC_uvchr(utf8_to_uvchr(p,  0))
512 #define isDIGIT_LC_utf8(p)      isDIGIT_LC_uvchr(utf8_to_uvchr(p,  0))
513 #define isUPPER_LC_utf8(p)      isUPPER_LC_uvchr(utf8_to_uvchr(p,  0))
514 #define isLOWER_LC_utf8(p)      isLOWER_LC_uvchr(utf8_to_uvchr(p,  0))
515 #define isALNUMC_LC_utf8(p)     isALNUMC_LC_uvchr(utf8_to_uvchr(p,  0))
516 #define isCNTRL_LC_utf8(p)      isCNTRL_LC_uvchr(utf8_to_uvchr(p,  0))
517 #define isGRAPH_LC_utf8(p)      isGRAPH_LC_uvchr(utf8_to_uvchr(p,  0))
518 #define isPRINT_LC_utf8(p)      isPRINT_LC_uvchr(utf8_to_uvchr(p,  0))
519 #define isPUNCT_LC_utf8(p)      isPUNCT_LC_uvchr(utf8_to_uvchr(p,  0))
520
521 #define isPSXSPC_LC_utf8(c)     (isSPACE_LC_utf8(c) ||(c) == '\f')
522 #define isBLANK_LC_utf8(c)      isBLANK(c) /* could be wrong */
523
524 #ifdef EBCDIC
525 #  ifdef PERL_IMPLICIT_CONTEXT
526 #    define toCTRL(c)     Perl_ebcdic_control(aTHX_ c)
527 #  else
528 #    define toCTRL        Perl_ebcdic_control
529 #  endif
530 #else
531   /* This conversion works both ways, strangely enough. */
532 #  define toCTRL(c)    (toUPPER(c) ^ 64)
533 #endif
534
535 /* Line numbers are unsigned, 32 bits. */
536 typedef U32 line_t;
537 #define NOLINE ((line_t) 4294967295UL)
538
539
540 /*
541 =head1 SV Manipulation Functions
542
543 =for apidoc Am|SV*|NEWSV|int id|STRLEN len
544 Creates a new SV.  A non-zero C<len> parameter indicates the number of
545 bytes of preallocated string space the SV should have.  An extra byte for a
546 tailing NUL is also reserved.  (SvPOK is not set for the SV even if string
547 space is allocated.)  The reference count for the new SV is set to 1.
548 C<id> is an integer id between 0 and 1299 (used to identify leaks).
549
550 =head1 Memory Management
551
552 =for apidoc Am|void|Newx|void* ptr|int nitems|type
553 The XSUB-writer's interface to the C C<malloc> function.
554
555 In 5.9.3, Newx() and friends replace the older New() API, and drops
556 the first parameter, I<x>, a debug aid which allowed callers to identify
557 themselves.  This aid has been superceded by a new build option,
558 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>).  The older API is still
559 there for use in XS modules supporting older perls.
560
561 =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
562 The XSUB-writer's interface to the C C<malloc> function, with
563 cast.  See also C<Newx>.
564
565 =for apidoc Am|void|Newxz|void* ptr|int nitems|type
566 The XSUB-writer's interface to the C C<malloc> function.  The allocated
567 memory is zeroed with C<memzero>.  See also C<Newx>.
568
569 =for apidoc Am|void|Renew|void* ptr|int nitems|type
570 The XSUB-writer's interface to the C C<realloc> function.
571
572 =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
573 The XSUB-writer's interface to the C C<realloc> function, with
574 cast.
575
576 =for apidoc Am|void|Safefree|void* ptr
577 The XSUB-writer's interface to the C C<free> function.
578
579 =for apidoc Am|void|Move|void* src|void* dest|int nitems|type
580 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
581 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
582 the type.  Can do overlapping moves.  See also C<Copy>.
583
584 =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
585 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
586 optimise.
587
588 =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
589 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
590 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
591 the type.  May fail on overlapping copies.  See also C<Move>.
592
593 =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
594
595 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
596 optimise.
597
598 =for apidoc Am|void|Zero|void* dest|int nitems|type
599
600 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
601 destination, C<nitems> is the number of items, and C<type> is the type.
602
603 =for apidoc Am|void *|ZeroD|void* dest|int nitems|type
604
605 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
606 optimise.
607
608 =for apidoc Am|void|StructCopy|type src|type dest|type
609 This is an architecture-independent macro to copy one structure to another.
610
611 =for apidoc Am|void|Poison|void* dest|int nitems|type
612
613 Fill up memory with a pattern (byte 0xAB over and over again) that
614 hopefully catches attempts to access uninitialized memory.
615
616 =cut */
617
618 #define NEWSV(x,len)    newSV(len)
619
620 #ifdef PERL_MALLOC_WRAP
621 #define MEM_WRAP_CHECK(n,t) \
622         (void)((sizeof(t)>1?(n):1)>((MEM_SIZE)~0)/sizeof(t)?(Perl_croak_nocontext(PL_memory_wrap),0):0)
623 #define MEM_WRAP_CHECK_1(n,t,a) \
624         (void)((sizeof(t)>1?(n):1)>((MEM_SIZE)~0)/sizeof(t)?(Perl_croak_nocontext(a),0):0)
625 #define MEM_WRAP_CHECK_2(n,t,a,b) \
626         (void)((sizeof(t)>1?(n):1)>((MEM_SIZE)~0)/sizeof(t)?(Perl_croak_nocontext(a,b),0):0)
627 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
628
629 #define PERL_STRLEN_ROUNDUP(n) ((void)(((n) > (MEM_SIZE)~0 - 2 * PERL_STRLEN_ROUNDUP_QUANTUM) ? (Perl_croak_nocontext(PL_memory_wrap),0):0),((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
630
631 #else
632
633 #define MEM_WRAP_CHECK(n,t)
634 #define MEM_WRAP_CHECK_1(n,t,a)
635 #define MEM_WRAP_CHECK_2(n,t,a,b)
636 #define MEM_WRAP_CHECK_(n,t)
637
638 #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
639
640 #endif
641
642 #ifdef PERL_MEM_LOG
643 /*
644  * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
645  * go through functions, which are handy for debugging breakpoints, but
646  * which more importantly get the immediate calling environment (file and
647  * line number, and C function name if available) passed in.  This info can
648  * then be used for logging the calls, for which one gets a sample
649  * implementation if PERL_MEM_LOG_STDERR is defined.
650  *
651  * Known problems:
652  * - all memory allocs do not get logged, only those
653  *   that go through Newx() and derivatives (while all
654  *  Safefrees do get logged)
655  * - __FILE__ and __LINE__ do not work everywhere
656  * - __func__ or __FUNCTION__ even less so
657  * - I think more goes on after the perlio frees but
658  *   the thing is that STDERR gets closed (as do all
659  *   the file descriptors)
660  * - no deeper calling stack than the caller of the Newx()
661  *   or the kind, but do I look like a C reflection/introspection
662  *   utility to you?
663  * - the function prototypes for the logging functions
664  *   probably should maybe be somewhere else than handy.h
665  * - one could consider inlining (macrofying) the logging
666  *   for speed, but I am too lazy
667  * - one could imagine recording the allocations in a hash,
668  *   (keyed by the allocation address?), and maintain that
669  *   through reallocs and frees, but how to do that without
670  *   any News() happening...?
671  */
672
673 Malloc_t Perl_mem_log_alloc(const UV n, const UV typesize, const char *typename, Malloc_t newalloc, const char *filename, const int linenumber, const char *funcname);
674
675 Malloc_t Perl_mem_log_realloc(const UV n, const UV typesize, const char *typename, Malloc_t oldalloc, Malloc_t newalloc, const char *filename, const int linenumber, const char *funcname);
676
677 Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
678
679 #endif
680
681 #ifdef PERL_MEM_LOG
682 #define MEM_LOG_ALLOC(n,t,a)     Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
683 #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
684 #define MEM_LOG_FREE(a)          Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
685 #endif
686
687 #ifndef MEM_LOG_ALLOC
688 #define MEM_LOG_ALLOC(n,t,a)     (a)
689 #endif
690 #ifndef MEM_LOG_REALLOC
691 #define MEM_LOG_REALLOC(n,t,v,a) (a)
692 #endif
693 #ifndef MEM_LOG_FREE
694 #define MEM_LOG_FREE(a)          (a)
695 #endif
696
697 #define Newx(v,n,t)     (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_ALLOC(n,t,(t*)safemalloc((MEM_SIZE)((n)*sizeof(t))))))
698 #define Newxc(v,n,t,c)  (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_ALLOC(n,t,(c*)safemalloc((MEM_SIZE)((n)*sizeof(t))))))
699 #define Newxz(v,n,t)    (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_ALLOC(n,t,(t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))))), \
700                         memzero((char*)(v), (n)*sizeof(t))
701
702 #ifndef PERL_CORE
703 /* pre 5.9.x compatibility */
704 #define New(x,v,n,t)    Newx(v,n,t)
705 #define Newc(x,v,n,t,c) Newxc(v,n,t,c)
706 #define Newz(x,v,n,t)   Newxz(v,n,t)
707 #endif
708
709 #define Renew(v,n,t) \
710           (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_REALLOC(n,t,v,(t*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
711 #define Renewc(v,n,t,c) \
712           (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_REALLOC(n,t,v,(c*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
713
714 #ifdef PERL_POISON
715 #define Safefree(d) \
716   ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
717 #else
718 #define Safefree(d)     safefree(MEM_LOG_FREE((Malloc_t)(d)))
719 #endif
720
721 #define Move(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
722 #define Copy(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
723 #define Zero(d,n,t)     (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
724
725 #define MoveD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
726 #define CopyD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
727 #ifdef HAS_MEMSET
728 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
729 #else
730 /* Using bzero(), which returns void.  */
731 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
732 #endif
733
734 #define Poison(d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), 0xAB, (n) * sizeof(t)))
735
736 #ifdef USE_STRUCT_COPY
737 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
738 #else
739 #define StructCopy(s,d,t) Copy(s,d,1,t)
740 #endif
741
742 #define C_ARRAY_LENGTH(a)       (sizeof(a)/sizeof((a)[0]))
743
744 #ifdef NEED_VA_COPY
745 # ifdef va_copy
746 #  define Perl_va_copy(s, d) va_copy(d, s)
747 # else
748 #  if defined(__va_copy)
749 #   define Perl_va_copy(s, d) __va_copy(d, s)
750 #  else
751 #   define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
752 #  endif
753 # endif
754 #endif
755
756 /* convenience debug macros */
757 #ifdef USE_ITHREADS
758 #define pTHX_FORMAT  "Perl interpreter: 0x%p"
759 #define pTHX__FORMAT ", Perl interpreter: 0x%p"
760 #define pTHX_VALUE_   (void *)my_perl,
761 #define pTHX_VALUE    (void *)my_perl
762 #define pTHX__VALUE_ ,(void *)my_perl,
763 #define pTHX__VALUE  ,(void *)my_perl
764 #else
765 #define pTHX_FORMAT
766 #define pTHX__FORMAT
767 #define pTHX_VALUE_
768 #define pTHX_VALUE
769 #define pTHX__VALUE_
770 #define pTHX__VALUE
771 #endif /* USE_ITHREADS */
772