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