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