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