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