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