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