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