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