projects / p5sagit/p5-mst-13.2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | history | HEAD
sprinkle dVAR
[p5sagit/p5-mst-13.2.git] / handy.h
CommitLineData
a0d0e21e 1/* handy.h
a687059c 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999,
acde74e1 4 * 2000, 2001, 2002, 2004, 2005, 2006, by Larry Wall and others
a687059c 5 *
6e21c824 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.
8d063cd8 8 *
8d063cd8 9 */
10
85e6fe83 11#if !defined(__STDC__)
378cc40b 12#ifdef NULL
13#undef NULL
14#endif
a687059c 15#ifndef I286
16# define NULL 0
17#else
18# define NULL 0L
19#endif
85e6fe83 20#endif
21
378cc40b 22#define Null(type) ((type)NULL)
954c1994 23
24/*
ccfc67b7 25=head1 Handy Values
954c1994 26
3609ea0d 27=for apidoc AmU||Nullch
ccfc67b7 28Null character pointer.
2307c6d0 29
954c1994 30=for apidoc AmU||Nullsv
31Null SV pointer.
32
33=cut
34*/
35
8d063cd8 36#define Nullch Null(char*)
760ac839 37#define Nullfp Null(PerlIO*)
79072805 38#define Nullsv Null(SV*)
8d063cd8 39
641d3f0b 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
27d4fb96 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*/
8e84507e 54/* bool is built-in for g++-2.6.3 and later, which might be used
c1d22f6b 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
8e84507e 57 also defines _G_HAVE_BOOL for both gcc and g++, but only g++
c1d22f6b 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
5d94fbed 61*/
3609ea0d 62#ifdef __GNUG__ /* GNU g++ has bool built-in */
5d94fbed 63# ifndef HAS_BOOL
c1d22f6b 64# define HAS_BOOL 1
5d94fbed 65# endif
5d94fbed 66#endif
67
641d3f0b 68/* The NeXT dynamic loader headers will not build with the bool macro
69 So declare them now to clear confusion.
70*/
8f1f23e8 71#if defined(NeXT) || defined(__NeXT__)
641d3f0b 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 */
8f1f23e8 79#endif /* NeXT || __NeXT__ */
641d3f0b 80
5d94fbed 81#ifndef HAS_BOOL
61bb5906 82# if defined(UTS) || defined(VMS)
5d94fbed 83# define bool int
84# else
85# define bool char
86# endif
c1d22f6b 87# define HAS_BOOL 1
a687059c 88#endif
0d3e774c 89
46c6c7e2 90/* Try to figure out __func__ or __FUNCTION__ equivalent, if any.
e352bcff 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. */
46c6c7e2 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. */ \
be73ebb0 98 (defined(__DECC_VER)) /* Tru64 or VMS, and strict C89 being used, but not modern enough cc (in Tur64, -c99 not known, only -std1). */
46c6c7e2 99# define FUNCTION__ ""
100# else
101# define FUNCTION__ __FUNCTION__ /* Common extension. */
102# endif
103#endif
104
27d4fb96 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
24fef2a7 114
dc45a647 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.
693762b4 118
dc45a647 119 Similarly, there is no guarantee that I16 and U16 have exactly 16
120 bits.
693762b4 121
8e84507e 122 For dealing with issues that may arise from various 32/64-bit
123 systems, we will ask Configure to check out
8175356b 124
3609ea0d 125 SHORTSIZE == sizeof(short)
126 INTSIZE == sizeof(int)
127 LONGSIZE == sizeof(long)
dc45a647 128 LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
3609ea0d 129 PTRSIZE == sizeof(void *)
dc45a647 130 DOUBLESIZE == sizeof(double)
131 LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
8175356b 132
27d4fb96 133*/
134
69512466 135#ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
136# include <inttypes.h>
dd0eed91 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
69512466 145#endif
146
8175356b 147typedef I8TYPE I8;
148typedef U8TYPE U8;
149typedef I16TYPE I16;
150typedef U16TYPE U16;
151typedef I32TYPE I32;
152typedef U32TYPE U32;
6b8eaf93 153#ifdef PERL_CORE
154# ifdef HAS_QUAD
8175356b 155typedef I64TYPE I64;
156typedef U64TYPE U64;
6b8eaf93 157# endif
158#endif /* PERL_CORE */
8175356b 159
69512466 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
e8c95190 174# endif
175#endif
dc750f2e 176
cae3d67c 177/* HMB H.Merijn Brand - a placeholder for preparing Configure patches */
4f5da3e9 178#if defined(HAS_MALLOC_SIZE) && defined(HAS_SNPRINTF) && defined(HAS_VSNPRINTF)
cae3d67c 179/* Not (yet) used at top level, but mention them for metaconfig */
dc750f2e 180#endif
e8c95190 181
a22e52b9 182/* Mention I8SIZE, U8SIZE, I16SIZE, U16SIZE, I32SIZE, U32SIZE,
183 I64SIZE, and U64SIZE here so that metaconfig pulls them in. */
184
d8668976 185#if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
5ff3f7a4 186
5ff3f7a4 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
5ff3f7a4 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
5ff3f7a4 197#define I32_MAX INT32_MAX
198#define I32_MIN INT32_MIN
0e983133 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
5ff3f7a4 204#define U32_MIN UINT32_MIN
205
206#else
207
5c9fa16e 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. */
27d4fb96 210#define U8_MAX PERL_UCHAR_MAX
211#define U8_MIN PERL_UCHAR_MIN
79072805 212
27d4fb96 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
79072805 217
c4f23d77 218#if LONGSIZE > 4
27d4fb96 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
79072805 223#else
27d4fb96 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
79072805 228#endif
229
5ff3f7a4 230#endif
231
58a9a5d5 232/* log(2) is pretty close to 0.30103, just in case anyone is grepping for it */
fc36a67e 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
ff68c719 237#define Ctl(ch) ((ch) & 037)
8d063cd8 238
65177ae0 239/* concatenating with "" ensures that only literal strings are accepted as argument */
2efa8cc7 240#define STR_WITH_LEN(s) (s ""), (sizeof(s)-1)
241
ba3a79e7 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
954c1994 254/*
ccfc67b7 255=head1 Miscellaneous Functions
256
954c1994 257=for apidoc Am|bool|strNE|char* s1|char* s2
258Test two strings to see if they are different. Returns true or
259false.
260
261=for apidoc Am|bool|strEQ|char* s1|char* s2
262Test two strings to see if they are equal. Returns true or false.
263
264=for apidoc Am|bool|strLT|char* s1|char* s2
265Test two strings to see if the first, C<s1>, is less than the second,
266C<s2>. Returns true or false.
267
268=for apidoc Am|bool|strLE|char* s1|char* s2
269Test two strings to see if the first, C<s1>, is less than or equal to the
270second, C<s2>. Returns true or false.
271
272=for apidoc Am|bool|strGT|char* s1|char* s2
273Test two strings to see if the first, C<s1>, is greater than the second,
274C<s2>. Returns true or false.
275
276=for apidoc Am|bool|strGE|char* s1|char* s2
277Test two strings to see if the first, C<s1>, is greater than or equal to
278the second, C<s2>. Returns true or false.
279
280=for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
281Test two strings to see if they are different. The C<len> parameter
282indicates the number of bytes to compare. Returns true or false. (A
283wrapper for C<strncmp>).
284
285=for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
286Test two strings to see if they are equal. The C<len> parameter indicates
287the number of bytes to compare. Returns true or false. (A wrapper for
288C<strncmp>).
289
290=cut
291*/
292
8d063cd8 293#define strNE(s1,s2) (strcmp(s1,s2))
294#define strEQ(s1,s2) (!strcmp(s1,s2))
295#define strLT(s1,s2) (strcmp(s1,s2) < 0)
296#define strLE(s1,s2) (strcmp(s1,s2) <= 0)
297#define strGT(s1,s2) (strcmp(s1,s2) > 0)
298#define strGE(s1,s2) (strcmp(s1,s2) >= 0)
299#define strnNE(s1,s2,l) (strncmp(s1,s2,l))
300#define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
378cc40b 301
36477c24 302#ifdef HAS_MEMCMP
303# define memNE(s1,s2,l) (memcmp(s1,s2,l))
304# define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
305#else
306# define memNE(s1,s2,l) (bcmp(s1,s2,l))
307# define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
308#endif
309
bbce6d69 310/*
311 * Character classes.
312 *
313 * Unfortunately, the introduction of locales means that we
314 * can't trust isupper(), etc. to tell the truth. And when
315 * it comes to /\w+/ with tainting enabled, we *must* be able
316 * to trust our character classes.
317 *
318 * Therefore, the default tests in the text of Perl will be
319 * independent of locale. Any code that wants to depend on
320 * the current locale will use the tests that begin with "lc".
321 */
322
2304df62 323#ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */
324# ifndef CTYPE256
325# define CTYPE256
326# endif
327#endif
328
954c1994 329/*
ccfc67b7 330
331=head1 Character classes
332
954c1994 333=for apidoc Am|bool|isALNUM|char ch
4375e838 334Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
f1cbbd6e 335character (including underscore) or digit.
954c1994 336
337=for apidoc Am|bool|isALPHA|char ch
4375e838 338Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
954c1994 339character.
340
341=for apidoc Am|bool|isSPACE|char ch
342Returns a boolean indicating whether the C C<char> is whitespace.
343
344=for apidoc Am|bool|isDIGIT|char ch
4375e838 345Returns a boolean indicating whether the C C<char> is an ASCII
954c1994 346digit.
347
348=for apidoc Am|bool|isUPPER|char ch
349Returns a boolean indicating whether the C C<char> is an uppercase
350character.
351
352=for apidoc Am|bool|isLOWER|char ch
353Returns a boolean indicating whether the C C<char> is a lowercase
354character.
355
356=for apidoc Am|char|toUPPER|char ch
357Converts the specified character to uppercase.
358
359=for apidoc Am|char|toLOWER|char ch
360Converts the specified character to lowercase.
361
362=cut
363*/
364
bbce6d69 365#define isALNUM(c) (isALPHA(c) || isDIGIT(c) || (c) == '_')
366#define isIDFIRST(c) (isALPHA(c) || (c) == '_')
367#define isALPHA(c) (isUPPER(c) || isLOWER(c))
368#define isSPACE(c) \
369 ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
aaa51d5e 370#define isPSXSPC(c) (isSPACE(c) || (c) == '\v')
371#define isBLANK(c) ((c) == ' ' || (c) == '\t')
bbce6d69 372#define isDIGIT(c) ((c) >= '0' && (c) <= '9')
9d116dd7 373#ifdef EBCDIC
374 /* In EBCDIC we do not do locales: therefore() isupper() is fine. */
375# define isUPPER(c) isupper(c)
376# define isLOWER(c) islower(c)
b8c5462f 377# define isALNUMC(c) isalnum(c)
378# define isASCII(c) isascii(c)
379# define isCNTRL(c) iscntrl(c)
380# define isGRAPH(c) isgraph(c)
9d116dd7 381# define isPRINT(c) isprint(c)
b8c5462f 382# define isPUNCT(c) ispunct(c)
383# define isXDIGIT(c) isxdigit(c)
9d116dd7 384# define toUPPER(c) toupper(c)
385# define toLOWER(c) tolower(c)
386#else
387# define isUPPER(c) ((c) >= 'A' && (c) <= 'Z')
388# define isLOWER(c) ((c) >= 'a' && (c) <= 'z')
b8c5462f 389# define isALNUMC(c) (isALPHA(c) || isDIGIT(c))
390# define isASCII(c) ((c) <= 127)
7be5a6cf 391# define isCNTRL(c) ((c) < ' ' || (c) == 127)
b8c5462f 392# define isGRAPH(c) (isALNUM(c) || isPUNCT(c))
f79b3095 393# define isPRINT(c) (((c) > 32 && (c) < 127) || (c) == ' ')
b8c5462f 394# define isPUNCT(c) (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64) || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
c302d089 395# define isXDIGIT(c) (isDIGIT(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F'))
9d116dd7 396# define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c))
397# define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c))
398#endif
bbce6d69 399
400#ifdef USE_NEXT_CTYPE
401
402# define isALNUM_LC(c) \
37bd1396 403 (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
ff68c719 404# define isIDFIRST_LC(c) \
405 (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
406# define isALPHA_LC(c) NXIsAlpha((unsigned int)(c))
407# define isSPACE_LC(c) NXIsSpace((unsigned int)(c))
408# define isDIGIT_LC(c) NXIsDigit((unsigned int)(c))
409# define isUPPER_LC(c) NXIsUpper((unsigned int)(c))
410# define isLOWER_LC(c) NXIsLower((unsigned int)(c))
37bd1396 411# define isALNUMC_LC(c) NXIsAlNum((unsigned int)(c))
b8c5462f 412# define isCNTRL_LC(c) NXIsCntrl((unsigned int)(c))
413# define isGRAPH_LC(c) NXIsGraph((unsigned int)(c))
ff68c719 414# define isPRINT_LC(c) NXIsPrint((unsigned int)(c))
b8c5462f 415# define isPUNCT_LC(c) NXIsPunct((unsigned int)(c))
ff68c719 416# define toUPPER_LC(c) NXToUpper((unsigned int)(c))
417# define toLOWER_LC(c) NXToLower((unsigned int)(c))
bbce6d69 418
419#else /* !USE_NEXT_CTYPE */
b8c5462f 420
bbce6d69 421# if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
422
b8c5462f 423# define isALNUM_LC(c) (isalnum((unsigned char)(c)) || (char)(c) == '_')
ff68c719 424# define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
bbce6d69 425# define isALPHA_LC(c) isalpha((unsigned char)(c))
426# define isSPACE_LC(c) isspace((unsigned char)(c))
427# define isDIGIT_LC(c) isdigit((unsigned char)(c))
428# define isUPPER_LC(c) isupper((unsigned char)(c))
429# define isLOWER_LC(c) islower((unsigned char)(c))
b8c5462f 430# define isALNUMC_LC(c) isalnum((unsigned char)(c))
431# define isCNTRL_LC(c) iscntrl((unsigned char)(c))
432# define isGRAPH_LC(c) isgraph((unsigned char)(c))
bbce6d69 433# define isPRINT_LC(c) isprint((unsigned char)(c))
b8c5462f 434# define isPUNCT_LC(c) ispunct((unsigned char)(c))
bbce6d69 435# define toUPPER_LC(c) toupper((unsigned char)(c))
436# define toLOWER_LC(c) tolower((unsigned char)(c))
437
438# else
439
3609ea0d 440# define isALNUM_LC(c) (isascii(c) && (isalnum(c) || (c) == '_'))
bbce6d69 441# define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_'))
442# define isALPHA_LC(c) (isascii(c) && isalpha(c))
443# define isSPACE_LC(c) (isascii(c) && isspace(c))
444# define isDIGIT_LC(c) (isascii(c) && isdigit(c))
445# define isUPPER_LC(c) (isascii(c) && isupper(c))
446# define isLOWER_LC(c) (isascii(c) && islower(c))
b8c5462f 447# define isALNUMC_LC(c) (isascii(c) && isalnum(c))
448# define isCNTRL_LC(c) (isascii(c) && iscntrl(c))
449# define isGRAPH_LC(c) (isascii(c) && isgraph(c))
bbce6d69 450# define isPRINT_LC(c) (isascii(c) && isprint(c))
b8c5462f 451# define isPUNCT_LC(c) (isascii(c) && ispunct(c))
bbce6d69 452# define toUPPER_LC(c) toupper(c)
453# define toLOWER_LC(c) tolower(c)
454
455# endif
a0d0e21e 456#endif /* USE_NEXT_CTYPE */
55204971 457
aaa51d5e 458#define isPSXSPC_LC(c) (isSPACE_LC(c) || (c) == '\v')
459#define isBLANK_LC(c) isBLANK(c) /* could be wrong */
460
a0ed51b3 461#define isALNUM_uni(c) is_uni_alnum(c)
462#define isIDFIRST_uni(c) is_uni_idfirst(c)
463#define isALPHA_uni(c) is_uni_alpha(c)
464#define isSPACE_uni(c) is_uni_space(c)
465#define isDIGIT_uni(c) is_uni_digit(c)
466#define isUPPER_uni(c) is_uni_upper(c)
467#define isLOWER_uni(c) is_uni_lower(c)
b8c5462f 468#define isALNUMC_uni(c) is_uni_alnumc(c)
469#define isASCII_uni(c) is_uni_ascii(c)
470#define isCNTRL_uni(c) is_uni_cntrl(c)
471#define isGRAPH_uni(c) is_uni_graph(c)
a0ed51b3 472#define isPRINT_uni(c) is_uni_print(c)
b8c5462f 473#define isPUNCT_uni(c) is_uni_punct(c)
474#define isXDIGIT_uni(c) is_uni_xdigit(c)
a2a2844f 475#define toUPPER_uni(c,s,l) to_uni_upper(c,s,l)
476#define toTITLE_uni(c,s,l) to_uni_title(c,s,l)
477#define toLOWER_uni(c,s,l) to_uni_lower(c,s,l)
b8d68ded 478#define toFOLD_uni(c,s,l) to_uni_fold(c,s,l)
a0ed51b3 479
aaa51d5e 480#define isPSXSPC_uni(c) (isSPACE_uni(c) ||(c) == '\f')
481#define isBLANK_uni(c) isBLANK(c) /* could be wrong */
482
9041c2e3 483#define isALNUM_LC_uvchr(c) (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
484#define isIDFIRST_LC_uvchr(c) (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
485#define isALPHA_LC_uvchr(c) (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
486#define isSPACE_LC_uvchr(c) (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
487#define isDIGIT_LC_uvchr(c) (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
488#define isUPPER_LC_uvchr(c) (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
489#define isLOWER_LC_uvchr(c) (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
490#define isALNUMC_LC_uvchr(c) (c < 256 ? isALNUMC_LC(c) : is_uni_alnumc_lc(c))
491#define isCNTRL_LC_uvchr(c) (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
492#define isGRAPH_LC_uvchr(c) (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
493#define isPRINT_LC_uvchr(c) (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
494#define isPUNCT_LC_uvchr(c) (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
a0ed51b3 495
aaa51d5e 496#define isPSXSPC_LC_uni(c) (isSPACE_LC_uni(c) ||(c) == '\f')
497#define isBLANK_LC_uni(c) isBLANK(c) /* could be wrong */
498
a0ed51b3 499#define isALNUM_utf8(p) is_utf8_alnum(p)
82686b01 500/* The ID_Start of Unicode is quite limiting: it assumes a L-class
501 * character (meaning that you cannot have, say, a CJK character).
502 * Instead, let's allow ID_Continue but not digits. */
503#define isIDFIRST_utf8(p) (is_utf8_idcont(p) && !is_utf8_digit(p))
a0ed51b3 504#define isALPHA_utf8(p) is_utf8_alpha(p)
505#define isSPACE_utf8(p) is_utf8_space(p)
506#define isDIGIT_utf8(p) is_utf8_digit(p)
507#define isUPPER_utf8(p) is_utf8_upper(p)
508#define isLOWER_utf8(p) is_utf8_lower(p)
b8c5462f 509#define isALNUMC_utf8(p) is_utf8_alnumc(p)
510#define isASCII_utf8(p) is_utf8_ascii(p)
511#define isCNTRL_utf8(p) is_utf8_cntrl(p)
512#define isGRAPH_utf8(p) is_utf8_graph(p)
a0ed51b3 513#define isPRINT_utf8(p) is_utf8_print(p)
b8c5462f 514#define isPUNCT_utf8(p) is_utf8_punct(p)
515#define isXDIGIT_utf8(p) is_utf8_xdigit(p)
a2a2844f 516#define toUPPER_utf8(p,s,l) to_utf8_upper(p,s,l)
517#define toTITLE_utf8(p,s,l) to_utf8_title(p,s,l)
518#define toLOWER_utf8(p,s,l) to_utf8_lower(p,s,l)
a0ed51b3 519
aaa51d5e 520#define isPSXSPC_utf8(c) (isSPACE_utf8(c) ||(c) == '\f')
521#define isBLANK_utf8(c) isBLANK(c) /* could be wrong */
522
9041c2e3 523#define isALNUM_LC_utf8(p) isALNUM_LC_uvchr(utf8_to_uvchr(p, 0))
524#define isIDFIRST_LC_utf8(p) isIDFIRST_LC_uvchr(utf8_to_uvchr(p, 0))
525#define isALPHA_LC_utf8(p) isALPHA_LC_uvchr(utf8_to_uvchr(p, 0))
526#define isSPACE_LC_utf8(p) isSPACE_LC_uvchr(utf8_to_uvchr(p, 0))
527#define isDIGIT_LC_utf8(p) isDIGIT_LC_uvchr(utf8_to_uvchr(p, 0))
528#define isUPPER_LC_utf8(p) isUPPER_LC_uvchr(utf8_to_uvchr(p, 0))
529#define isLOWER_LC_utf8(p) isLOWER_LC_uvchr(utf8_to_uvchr(p, 0))
530#define isALNUMC_LC_utf8(p) isALNUMC_LC_uvchr(utf8_to_uvchr(p, 0))
531#define isCNTRL_LC_utf8(p) isCNTRL_LC_uvchr(utf8_to_uvchr(p, 0))
532#define isGRAPH_LC_utf8(p) isGRAPH_LC_uvchr(utf8_to_uvchr(p, 0))
533#define isPRINT_LC_utf8(p) isPRINT_LC_uvchr(utf8_to_uvchr(p, 0))
534#define isPUNCT_LC_utf8(p) isPUNCT_LC_uvchr(utf8_to_uvchr(p, 0))
a0ed51b3 535
aaa51d5e 536#define isPSXSPC_LC_utf8(c) (isSPACE_LC_utf8(c) ||(c) == '\f')
537#define isBLANK_LC_utf8(c) isBLANK(c) /* could be wrong */
538
9d116dd7 539#ifdef EBCDIC
20b634c2 540# ifdef PERL_IMPLICIT_CONTEXT
541# define toCTRL(c) Perl_ebcdic_control(aTHX_ c)
542# else
543# define toCTRL Perl_ebcdic_control
544# endif
9d116dd7 545#else
546 /* This conversion works both ways, strangely enough. */
547# define toCTRL(c) (toUPPER(c) ^ 64)
548#endif
bbce6d69 549
dea28490 550/* Line numbers are unsigned, 32 bits. */
551typedef U32 line_t;
dea28490 552#define NOLINE ((line_t) 4294967295UL)
378cc40b 553
8c52afec 554
8e84507e 555/*
ccfc67b7 556=head1 SV Manipulation Functions
557
954c1994 558=for apidoc Am|SV*|NEWSV|int id|STRLEN len
559Creates a new SV. A non-zero C<len> parameter indicates the number of
560bytes of preallocated string space the SV should have. An extra byte for a
561tailing NUL is also reserved. (SvPOK is not set for the SV even if string
8e84507e 562space is allocated.) The reference count for the new SV is set to 1.
954c1994 563C<id> is an integer id between 0 and 1299 (used to identify leaks).
564
ccfc67b7 565=head1 Memory Management
566
a02a5408 567=for apidoc Am|void|Newx|void* ptr|int nitems|type
954c1994 568The XSUB-writer's interface to the C C<malloc> function.
569
c5008215 570In 5.9.3, Newx() and friends replace the older New() API, and drops
571the first parameter, I<x>, a debug aid which allowed callers to identify
572themselves. This aid has been superceded by a new build option,
573PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
574there for use in XS modules supporting older perls.
575
a02a5408 576=for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
954c1994 577The XSUB-writer's interface to the C C<malloc> function, with
c5008215 578cast. See also C<Newx>.
954c1994 579
a02a5408 580=for apidoc Am|void|Newxz|void* ptr|int nitems|type
954c1994 581The XSUB-writer's interface to the C C<malloc> function. The allocated
c5008215 582memory is zeroed with C<memzero>. See also C<Newx>.
a02a5408 583
954c1994 584=for apidoc Am|void|Renew|void* ptr|int nitems|type
585The XSUB-writer's interface to the C C<realloc> function.
586
587=for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
588The XSUB-writer's interface to the C C<realloc> function, with
589cast.
590
49b8b560 591=for apidoc Am|void|Safefree|void* ptr
954c1994 592The XSUB-writer's interface to the C C<free> function.
593
594=for apidoc Am|void|Move|void* src|void* dest|int nitems|type
595The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
596source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
597the type. Can do overlapping moves. See also C<Copy>.
598
e90e2364 599=for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
600Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
601optimise.
602
954c1994 603=for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
604The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
605source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
606the type. May fail on overlapping copies. See also C<Move>.
607
e90e2364 608=for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
609
610Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
611optimise.
612
954c1994 613=for apidoc Am|void|Zero|void* dest|int nitems|type
614
615The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
616destination, C<nitems> is the number of items, and C<type> is the type.
617
e90e2364 618=for apidoc Am|void *|ZeroD|void* dest|int nitems|type
619
620Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
621optimise.
622
954c1994 623=for apidoc Am|void|StructCopy|type src|type dest|type
4375e838 624This is an architecture-independent macro to copy one structure to another.
954c1994 625
9965345d 626=for apidoc Am|void|Poison|void* dest|int nitems|type
627
628Fill up memory with a pattern (byte 0xAB over and over again) that
629hopefully catches attempts to access uninitialized memory.
630
631=cut */
954c1994 632
ff06c60c 633#define NEWSV(x,len) newSV(len)
634
27d5b266 635#ifdef PERL_MALLOC_WRAP
fabdb6c0 636#define MEM_WRAP_CHECK(n,t) MEM_WRAP_CHECK_1(n,t,PL_memory_wrap)
27d5b266 637#define MEM_WRAP_CHECK_1(n,t,a) \
ed87b6ed 638 (void)((sizeof(t)>1?(n):1)>((MEM_SIZE)~0)/sizeof(t)?(Perl_croak_nocontext(a),0):0)
8b44ba4c 639#define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
27d5b266 640
6fff79ce 641#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)))
1936d2a7 642
27d5b266 643#else
644
410319be 645#define MEM_WRAP_CHECK(n,t)
646#define MEM_WRAP_CHECK_1(n,t,a)
647#define MEM_WRAP_CHECK_2(n,t,a,b)
8b44ba4c 648#define MEM_WRAP_CHECK_(n,t)
649
6fff79ce 650#define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
27d5b266 651
1936d2a7 652#endif
8b44ba4c 653
fe4f188c 654#ifdef PERL_MEM_LOG
46c6c7e2 655/*
9f653bb5 656 * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
46c6c7e2 657 * go through functions, which are handy for debugging breakpoints, but
658 * which more importantly get the immediate calling environment (file and
e352bcff 659 * line number, and C function name if available) passed in. This info can
660 * then be used for logging the calls, for which one gets a sample
661 * implementation if PERL_MEM_LOG_STDERR is defined.
3609ea0d 662 *
46c6c7e2 663 * Known problems:
664 * - all memory allocs do not get logged, only those
665 * that go through Newx() and derivatives (while all
666 * Safefrees do get logged)
667 * - __FILE__ and __LINE__ do not work everywhere
668 * - __func__ or __FUNCTION__ even less so
669 * - I think more goes on after the perlio frees but
670 * the thing is that STDERR gets closed (as do all
671 * the file descriptors)
672 * - no deeper calling stack than the caller of the Newx()
673 * or the kind, but do I look like a C reflection/introspection
674 * utility to you?
675 * - the function prototypes for the logging functions
676 * probably should maybe be somewhere else than handy.h
677 * - one could consider inlining (macrofying) the logging
678 * for speed, but I am too lazy
679 * - one could imagine recording the allocations in a hash,
680 * (keyed by the allocation address?), and maintain that
681 * through reallocs and frees, but how to do that without
682 * any News() happening...?
683 */
684
685Malloc_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);
686
687Malloc_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);
688
689Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
690
fe4f188c 691#endif
692
693#ifdef PERL_MEM_LOG
46c6c7e2 694#define MEM_LOG_ALLOC(n,t,a) Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
695#define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
696#define MEM_LOG_FREE(a) Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
fe4f188c 697#endif
698
699#ifndef MEM_LOG_ALLOC
700#define MEM_LOG_ALLOC(n,t,a) (a)
701#endif
702#ifndef MEM_LOG_REALLOC
703#define MEM_LOG_REALLOC(n,t,v,a) (a)
704#endif
705#ifndef MEM_LOG_FREE
706#define MEM_LOG_FREE(a) (a)
707#endif
708
709#define Newx(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_ALLOC(n,t,(t*)safemalloc((MEM_SIZE)((n)*sizeof(t))))))
710#define Newxc(v,n,t,c) (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_ALLOC(n,t,(c*)safemalloc((MEM_SIZE)((n)*sizeof(t))))))
711#define Newxz(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_ALLOC(n,t,(t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))))), \
ff68c719 712 memzero((char*)(v), (n)*sizeof(t))
a6f6820f 713
714#ifndef PERL_CORE
a02a5408 715/* pre 5.9.x compatibility */
716#define New(x,v,n,t) Newx(v,n,t)
717#define Newc(x,v,n,t,c) Newxc(v,n,t,c)
4541904d 718#define Newz(x,v,n,t) Newxz(v,n,t)
a6f6820f 719#endif
a02a5408 720
ff68c719 721#define Renew(v,n,t) \
fe4f188c 722 (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_REALLOC(n,t,v,(t*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
ff68c719 723#define Renewc(v,n,t,c) \
fe4f188c 724 (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_REALLOC(n,t,v,(c*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
94010e71 725
726#ifdef PERL_POISON
727#define Safefree(d) \
06c0cc96 728 ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
94010e71 729#else
fe4f188c 730#define Safefree(d) safefree(MEM_LOG_FREE((Malloc_t)(d)))
94010e71 731#endif
55497cff 732
8b44ba4c 733#define Move(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
734#define Copy(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
735#define Zero(d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
55497cff 736
8b44ba4c 737#define MoveD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
738#define CopyD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
e90e2364 739#ifdef HAS_MEMSET
8b44ba4c 740#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
e90e2364 741#else
8b44ba4c 742/* Using bzero(), which returns void. */
743#define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
e90e2364 744#endif
745
8b44ba4c 746#define Poison(d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), 0xAB, (n) * sizeof(t)))
27d5b266 747
2304df62 748#ifdef USE_STRUCT_COPY
ff68c719 749#define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
bee1dbe2 750#else
751#define StructCopy(s,d,t) Copy(s,d,1,t)
752#endif
2cc61e15 753
622913ab 754#define C_ARRAY_LENGTH(a) (sizeof(a)/sizeof((a)[0]))
755
2cc61e15 756#ifdef NEED_VA_COPY
757# ifdef va_copy
758# define Perl_va_copy(s, d) va_copy(d, s)
2cc61e15 759# else
a1866d1b 760# if defined(__va_copy)
761# define Perl_va_copy(s, d) __va_copy(d, s)
762# else
763# define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
764# endif
2cc61e15 765# endif
766#endif
767
472d47bc 768/* convenience debug macros */
769#ifdef USE_ITHREADS
770#define pTHX_FORMAT "Perl interpreter: 0x%p"
771#define pTHX__FORMAT ", Perl interpreter: 0x%p"
f54cb97a 772#define pTHX_VALUE_ (void *)my_perl,
773#define pTHX_VALUE (void *)my_perl
774#define pTHX__VALUE_ ,(void *)my_perl,
775#define pTHX__VALUE ,(void *)my_perl
472d47bc 776#else
3609ea0d 777#define pTHX_FORMAT
472d47bc 778#define pTHX__FORMAT
3609ea0d 779#define pTHX_VALUE_
472d47bc 780#define pTHX_VALUE
3609ea0d 781#define pTHX__VALUE_
472d47bc 782#define pTHX__VALUE
783#endif /* USE_ITHREADS */
3609ea0d 784
Unnamed repository; edit this file to name it for gitweb.