Commit | Line | Data |
---|---|---|
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 LW |
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 LW |
9 | */ |
10 | ||
85e6fe83 | 11 | #if !defined(__STDC__) |
378cc40b LW |
12 | #ifdef NULL |
13 | #undef NULL | |
14 | #endif | |
a687059c LW |
15 | #ifndef I286 |
16 | # define NULL 0 | |
17 | #else | |
18 | # define NULL 0L | |
19 | #endif | |
85e6fe83 LW |
20 | #endif |
21 | ||
378cc40b | 22 | #define Null(type) ((type)NULL) |
954c1994 GS |
23 | |
24 | /* | |
ccfc67b7 | 25 | =head1 Handy Values |
954c1994 | 26 | |
3609ea0d | 27 | =for apidoc AmU||Nullch |
ccfc67b7 | 28 | Null character pointer. |
2307c6d0 | 29 | |
954c1994 GS |
30 | =for apidoc AmU||Nullsv |
31 | Null 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 GS |
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 GS |
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 AD |
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 AD |
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 JH |
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 JH |
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 JH |
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 MB |
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 MB |
119 | Similarly, there is no guarantee that I16 and U16 have exactly 16 |
120 | bits. | |
693762b4 | 121 | |
8e84507e NIS |
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 JH |
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 MB |
130 | DOUBLESIZE == sizeof(double) |
131 | LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE). | |
8175356b | 132 | |
27d4fb96 | 133 | */ |
134 | ||
69512466 JH |
135 | #ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */ |
136 | # include <inttypes.h> | |
dd0eed91 JH |
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 JH |
145 | #endif |
146 | ||
8175356b JH |
147 | typedef I8TYPE I8; |
148 | typedef U8TYPE U8; | |
149 | typedef I16TYPE I16; | |
150 | typedef U16TYPE U16; | |
151 | typedef I32TYPE I32; | |
152 | typedef U32TYPE U32; | |
6b8eaf93 JH |
153 | #ifdef PERL_CORE |
154 | # ifdef HAS_QUAD | |
8175356b JH |
155 | typedef I64TYPE I64; |
156 | typedef U64TYPE U64; | |
6b8eaf93 JH |
157 | # endif |
158 | #endif /* PERL_CORE */ | |
8175356b | 159 | |
69512466 JH |
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 JH |
174 | # endif |
175 | #endif | |
dc750f2e | 176 | |
cae3d67c | 177 | /* HMB H.Merijn Brand - a placeholder for preparing Configure patches */ |
3497a01f | 178 | #if defined(HAS_MALLOC_SIZE) && defined(LOCALTIME_R_NEEDS_TZSET) && defined(HAS_PSEUDOFORK) |
cae3d67c | 179 | /* Not (yet) used at top level, but mention them for metaconfig */ |
dc750f2e | 180 | #endif |
e8c95190 | 181 | |
a22e52b9 JH |
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 GS |
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 GS |
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 GS |
197 | #define I32_MAX INT32_MAX |
198 | #define I32_MIN INT32_MIN | |
0e983133 GS |
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 GS |
204 | #define U32_MIN UINT32_MIN |
205 | ||
206 | #else | |
207 | ||
5c9fa16e KA |
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 LW |
228 | #endif |
229 | ||
5ff3f7a4 GS |
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 | |
3fe05580 MHM |
239 | /* |
240 | =head1 SV-Body Allocation | |
241 | ||
242 | =for apidoc Ama|SV*|newSVpvs|const char* s | |
243 | Like C<newSVpvn>, but takes a literal string instead of a string/length pair. | |
244 | ||
245 | =for apidoc Ama|SV*|newSVpvs_share|const char* s | |
246 | Like C<newSVpvn_share>, but takes a literal string instead of a string/length | |
247 | pair and omits the hash parameter. | |
248 | ||
7b4e7469 | 249 | =for apidoc Am|void|sv_catpvs|SV* sv|const char* s |
3fe05580 MHM |
250 | Like C<sv_catpvn>, but takes a literal string instead of a string/length pair. |
251 | ||
7b4e7469 | 252 | =for apidoc Am|void|sv_setpvs|SV* sv|const char* s |
3fe05580 MHM |
253 | Like C<sv_setpvn>, but takes a literal string instead of a string/length pair. |
254 | ||
255 | =head1 Memory Management | |
256 | ||
257 | =for apidoc Ama|char*|savepvs|const char* s | |
258 | Like C<savepvn>, but takes a literal string instead of a string/length pair. | |
259 | ||
260 | =head1 GV Functions | |
261 | ||
262 | =for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create | |
263 | Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair. | |
264 | ||
265 | =head1 Hash Manipulation Functions | |
266 | ||
267 | =for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval | |
268 | Like C<hv_fetch>, but takes a literal string instead of a string/length pair. | |
269 | ||
270 | =for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val | |
271 | Like C<hv_store>, but takes a literal string instead of a string/length pair | |
272 | and omits the hash parameter. | |
273 | ||
274 | =cut | |
275 | */ | |
276 | ||
65177ae0 | 277 | /* concatenating with "" ensures that only literal strings are accepted as argument */ |
2efa8cc7 GA |
278 | #define STR_WITH_LEN(s) (s ""), (sizeof(s)-1) |
279 | ||
ba3a79e7 GA |
280 | /* note that STR_WITH_LEN() can't be used as argument to macros or functions that |
281 | * under some configurations might be macros, which means that it requires the full | |
282 | * Perl_xxx(aTHX_ ...) form for any API calls where it's used. | |
283 | */ | |
284 | ||
285 | /* STR_WITH_LEN() shortcuts */ | |
286 | #define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str)) | |
287 | #define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0) | |
288 | #define sv_catpvs(sv, str) Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC) | |
3fe05580 | 289 | #define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str)) |
ba3a79e7 GA |
290 | #define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str)) |
291 | #define gv_stashpvs(str, create) Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create) | |
5c1737d1 | 292 | #define gv_fetchpvs(namebeg, add, sv_type) Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type) |
a038e571 NC |
293 | #define hv_fetchs(hv,key,lval) \ |
294 | ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \ | |
295 | (lval) ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \ | |
296 | : HV_FETCH_JUST_SV, NULL, 0)) | |
297 | ||
298 | #define hv_stores(hv,key,val) \ | |
299 | ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \ | |
300 | (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), 0)) | |
ba3a79e7 | 301 | |
5c1737d1 | 302 | |
954c1994 | 303 | /* |
ccfc67b7 JH |
304 | =head1 Miscellaneous Functions |
305 | ||
954c1994 GS |
306 | =for apidoc Am|bool|strNE|char* s1|char* s2 |
307 | Test two strings to see if they are different. Returns true or | |
308 | false. | |
309 | ||
310 | =for apidoc Am|bool|strEQ|char* s1|char* s2 | |
311 | Test two strings to see if they are equal. Returns true or false. | |
312 | ||
313 | =for apidoc Am|bool|strLT|char* s1|char* s2 | |
314 | Test two strings to see if the first, C<s1>, is less than the second, | |
315 | C<s2>. Returns true or false. | |
316 | ||
317 | =for apidoc Am|bool|strLE|char* s1|char* s2 | |
318 | Test two strings to see if the first, C<s1>, is less than or equal to the | |
319 | second, C<s2>. Returns true or false. | |
320 | ||
321 | =for apidoc Am|bool|strGT|char* s1|char* s2 | |
322 | Test two strings to see if the first, C<s1>, is greater than the second, | |
323 | C<s2>. Returns true or false. | |
324 | ||
325 | =for apidoc Am|bool|strGE|char* s1|char* s2 | |
326 | Test two strings to see if the first, C<s1>, is greater than or equal to | |
327 | the second, C<s2>. Returns true or false. | |
328 | ||
329 | =for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len | |
330 | Test two strings to see if they are different. The C<len> parameter | |
331 | indicates the number of bytes to compare. Returns true or false. (A | |
332 | wrapper for C<strncmp>). | |
333 | ||
334 | =for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len | |
335 | Test two strings to see if they are equal. The C<len> parameter indicates | |
336 | the number of bytes to compare. Returns true or false. (A wrapper for | |
337 | C<strncmp>). | |
338 | ||
339 | =cut | |
340 | */ | |
341 | ||
8d063cd8 LW |
342 | #define strNE(s1,s2) (strcmp(s1,s2)) |
343 | #define strEQ(s1,s2) (!strcmp(s1,s2)) | |
344 | #define strLT(s1,s2) (strcmp(s1,s2) < 0) | |
345 | #define strLE(s1,s2) (strcmp(s1,s2) <= 0) | |
346 | #define strGT(s1,s2) (strcmp(s1,s2) > 0) | |
347 | #define strGE(s1,s2) (strcmp(s1,s2) >= 0) | |
348 | #define strnNE(s1,s2,l) (strncmp(s1,s2,l)) | |
349 | #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l)) | |
378cc40b | 350 | |
36477c24 | 351 | #ifdef HAS_MEMCMP |
352 | # define memNE(s1,s2,l) (memcmp(s1,s2,l)) | |
353 | # define memEQ(s1,s2,l) (!memcmp(s1,s2,l)) | |
354 | #else | |
355 | # define memNE(s1,s2,l) (bcmp(s1,s2,l)) | |
356 | # define memEQ(s1,s2,l) (!bcmp(s1,s2,l)) | |
357 | #endif | |
358 | ||
568a785a NC |
359 | #define memEQs(s1, l, s2) \ |
360 | (sizeof(s2)-1 == l && memEQ(s1, (s2 ""), (sizeof(s2)-1))) | |
361 | #define memNEs(s1, l, s2) !memEQs(s1, l, s2) | |
362 | ||
bbce6d69 | 363 | /* |
364 | * Character classes. | |
365 | * | |
366 | * Unfortunately, the introduction of locales means that we | |
367 | * can't trust isupper(), etc. to tell the truth. And when | |
368 | * it comes to /\w+/ with tainting enabled, we *must* be able | |
369 | * to trust our character classes. | |
370 | * | |
371 | * Therefore, the default tests in the text of Perl will be | |
372 | * independent of locale. Any code that wants to depend on | |
373 | * the current locale will use the tests that begin with "lc". | |
374 | */ | |
375 | ||
2304df62 AD |
376 | #ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */ |
377 | # ifndef CTYPE256 | |
378 | # define CTYPE256 | |
379 | # endif | |
380 | #endif | |
381 | ||
954c1994 | 382 | /* |
ccfc67b7 JH |
383 | |
384 | =head1 Character classes | |
385 | ||
954c1994 | 386 | =for apidoc Am|bool|isALNUM|char ch |
4375e838 | 387 | Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric |
f1cbbd6e | 388 | character (including underscore) or digit. |
954c1994 GS |
389 | |
390 | =for apidoc Am|bool|isALPHA|char ch | |
4375e838 | 391 | Returns a boolean indicating whether the C C<char> is an ASCII alphabetic |
954c1994 GS |
392 | character. |
393 | ||
394 | =for apidoc Am|bool|isSPACE|char ch | |
395 | Returns a boolean indicating whether the C C<char> is whitespace. | |
396 | ||
397 | =for apidoc Am|bool|isDIGIT|char ch | |
4375e838 | 398 | Returns a boolean indicating whether the C C<char> is an ASCII |
954c1994 GS |
399 | digit. |
400 | ||
401 | =for apidoc Am|bool|isUPPER|char ch | |
402 | Returns a boolean indicating whether the C C<char> is an uppercase | |
403 | character. | |
404 | ||
405 | =for apidoc Am|bool|isLOWER|char ch | |
406 | Returns a boolean indicating whether the C C<char> is a lowercase | |
407 | character. | |
408 | ||
409 | =for apidoc Am|char|toUPPER|char ch | |
410 | Converts the specified character to uppercase. | |
411 | ||
412 | =for apidoc Am|char|toLOWER|char ch | |
413 | Converts the specified character to lowercase. | |
414 | ||
415 | =cut | |
416 | */ | |
417 | ||
bbce6d69 | 418 | #define isALNUM(c) (isALPHA(c) || isDIGIT(c) || (c) == '_') |
419 | #define isIDFIRST(c) (isALPHA(c) || (c) == '_') | |
420 | #define isALPHA(c) (isUPPER(c) || isLOWER(c)) | |
421 | #define isSPACE(c) \ | |
422 | ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f') | |
aaa51d5e JF |
423 | #define isPSXSPC(c) (isSPACE(c) || (c) == '\v') |
424 | #define isBLANK(c) ((c) == ' ' || (c) == '\t') | |
bbce6d69 | 425 | #define isDIGIT(c) ((c) >= '0' && (c) <= '9') |
9d116dd7 JH |
426 | #ifdef EBCDIC |
427 | /* In EBCDIC we do not do locales: therefore() isupper() is fine. */ | |
428 | # define isUPPER(c) isupper(c) | |
429 | # define isLOWER(c) islower(c) | |
b8c5462f JH |
430 | # define isALNUMC(c) isalnum(c) |
431 | # define isASCII(c) isascii(c) | |
432 | # define isCNTRL(c) iscntrl(c) | |
433 | # define isGRAPH(c) isgraph(c) | |
9d116dd7 | 434 | # define isPRINT(c) isprint(c) |
b8c5462f JH |
435 | # define isPUNCT(c) ispunct(c) |
436 | # define isXDIGIT(c) isxdigit(c) | |
9d116dd7 JH |
437 | # define toUPPER(c) toupper(c) |
438 | # define toLOWER(c) tolower(c) | |
439 | #else | |
440 | # define isUPPER(c) ((c) >= 'A' && (c) <= 'Z') | |
441 | # define isLOWER(c) ((c) >= 'a' && (c) <= 'z') | |
b8c5462f JH |
442 | # define isALNUMC(c) (isALPHA(c) || isDIGIT(c)) |
443 | # define isASCII(c) ((c) <= 127) | |
7be5a6cf | 444 | # define isCNTRL(c) ((c) < ' ' || (c) == 127) |
b8c5462f | 445 | # define isGRAPH(c) (isALNUM(c) || isPUNCT(c)) |
dc7a1c02 | 446 | # define isPRINT(c) (((c) >= 32 && (c) < 127)) |
b8c5462f | 447 | # define isPUNCT(c) (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64) || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126)) |
c302d089 | 448 | # define isXDIGIT(c) (isDIGIT(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F')) |
9d116dd7 JH |
449 | # define toUPPER(c) (isLOWER(c) ? (c) - ('a' - 'A') : (c)) |
450 | # define toLOWER(c) (isUPPER(c) ? (c) + ('a' - 'A') : (c)) | |
451 | #endif | |
bbce6d69 | 452 | |
453 | #ifdef USE_NEXT_CTYPE | |
454 | ||
455 | # define isALNUM_LC(c) \ | |
37bd1396 | 456 | (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_') |
ff68c719 | 457 | # define isIDFIRST_LC(c) \ |
458 | (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_') | |
459 | # define isALPHA_LC(c) NXIsAlpha((unsigned int)(c)) | |
460 | # define isSPACE_LC(c) NXIsSpace((unsigned int)(c)) | |
461 | # define isDIGIT_LC(c) NXIsDigit((unsigned int)(c)) | |
462 | # define isUPPER_LC(c) NXIsUpper((unsigned int)(c)) | |
463 | # define isLOWER_LC(c) NXIsLower((unsigned int)(c)) | |
37bd1396 | 464 | # define isALNUMC_LC(c) NXIsAlNum((unsigned int)(c)) |
b8c5462f JH |
465 | # define isCNTRL_LC(c) NXIsCntrl((unsigned int)(c)) |
466 | # define isGRAPH_LC(c) NXIsGraph((unsigned int)(c)) | |
ff68c719 | 467 | # define isPRINT_LC(c) NXIsPrint((unsigned int)(c)) |
b8c5462f | 468 | # define isPUNCT_LC(c) NXIsPunct((unsigned int)(c)) |
ff68c719 | 469 | # define toUPPER_LC(c) NXToUpper((unsigned int)(c)) |
470 | # define toLOWER_LC(c) NXToLower((unsigned int)(c)) | |
bbce6d69 | 471 | |
472 | #else /* !USE_NEXT_CTYPE */ | |
b8c5462f | 473 | |
bbce6d69 | 474 | # if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII)) |
475 | ||
b8c5462f | 476 | # define isALNUM_LC(c) (isalnum((unsigned char)(c)) || (char)(c) == '_') |
ff68c719 | 477 | # define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_') |
bbce6d69 | 478 | # define isALPHA_LC(c) isalpha((unsigned char)(c)) |
479 | # define isSPACE_LC(c) isspace((unsigned char)(c)) | |
480 | # define isDIGIT_LC(c) isdigit((unsigned char)(c)) | |
481 | # define isUPPER_LC(c) isupper((unsigned char)(c)) | |
482 | # define isLOWER_LC(c) islower((unsigned char)(c)) | |
b8c5462f JH |
483 | # define isALNUMC_LC(c) isalnum((unsigned char)(c)) |
484 | # define isCNTRL_LC(c) iscntrl((unsigned char)(c)) | |
485 | # define isGRAPH_LC(c) isgraph((unsigned char)(c)) | |
bbce6d69 | 486 | # define isPRINT_LC(c) isprint((unsigned char)(c)) |
b8c5462f | 487 | # define isPUNCT_LC(c) ispunct((unsigned char)(c)) |
bbce6d69 | 488 | # define toUPPER_LC(c) toupper((unsigned char)(c)) |
489 | # define toLOWER_LC(c) tolower((unsigned char)(c)) | |
490 | ||
491 | # else | |
492 | ||
3609ea0d | 493 | # define isALNUM_LC(c) (isascii(c) && (isalnum(c) || (c) == '_')) |
bbce6d69 | 494 | # define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_')) |
495 | # define isALPHA_LC(c) (isascii(c) && isalpha(c)) | |
496 | # define isSPACE_LC(c) (isascii(c) && isspace(c)) | |
497 | # define isDIGIT_LC(c) (isascii(c) && isdigit(c)) | |
498 | # define isUPPER_LC(c) (isascii(c) && isupper(c)) | |
499 | # define isLOWER_LC(c) (isascii(c) && islower(c)) | |
b8c5462f JH |
500 | # define isALNUMC_LC(c) (isascii(c) && isalnum(c)) |
501 | # define isCNTRL_LC(c) (isascii(c) && iscntrl(c)) | |
502 | # define isGRAPH_LC(c) (isascii(c) && isgraph(c)) | |
bbce6d69 | 503 | # define isPRINT_LC(c) (isascii(c) && isprint(c)) |
b8c5462f | 504 | # define isPUNCT_LC(c) (isascii(c) && ispunct(c)) |
bbce6d69 | 505 | # define toUPPER_LC(c) toupper(c) |
506 | # define toLOWER_LC(c) tolower(c) | |
507 | ||
508 | # endif | |
a0d0e21e | 509 | #endif /* USE_NEXT_CTYPE */ |
55204971 | 510 | |
aaa51d5e JF |
511 | #define isPSXSPC_LC(c) (isSPACE_LC(c) || (c) == '\v') |
512 | #define isBLANK_LC(c) isBLANK(c) /* could be wrong */ | |
513 | ||
a0ed51b3 LW |
514 | #define isALNUM_uni(c) is_uni_alnum(c) |
515 | #define isIDFIRST_uni(c) is_uni_idfirst(c) | |
516 | #define isALPHA_uni(c) is_uni_alpha(c) | |
517 | #define isSPACE_uni(c) is_uni_space(c) | |
518 | #define isDIGIT_uni(c) is_uni_digit(c) | |
519 | #define isUPPER_uni(c) is_uni_upper(c) | |
520 | #define isLOWER_uni(c) is_uni_lower(c) | |
b8c5462f JH |
521 | #define isALNUMC_uni(c) is_uni_alnumc(c) |
522 | #define isASCII_uni(c) is_uni_ascii(c) | |
523 | #define isCNTRL_uni(c) is_uni_cntrl(c) | |
524 | #define isGRAPH_uni(c) is_uni_graph(c) | |
a0ed51b3 | 525 | #define isPRINT_uni(c) is_uni_print(c) |
b8c5462f JH |
526 | #define isPUNCT_uni(c) is_uni_punct(c) |
527 | #define isXDIGIT_uni(c) is_uni_xdigit(c) | |
a2a2844f JH |
528 | #define toUPPER_uni(c,s,l) to_uni_upper(c,s,l) |
529 | #define toTITLE_uni(c,s,l) to_uni_title(c,s,l) | |
530 | #define toLOWER_uni(c,s,l) to_uni_lower(c,s,l) | |
b8d68ded | 531 | #define toFOLD_uni(c,s,l) to_uni_fold(c,s,l) |
a0ed51b3 | 532 | |
aaa51d5e JF |
533 | #define isPSXSPC_uni(c) (isSPACE_uni(c) ||(c) == '\f') |
534 | #define isBLANK_uni(c) isBLANK(c) /* could be wrong */ | |
535 | ||
9041c2e3 NIS |
536 | #define isALNUM_LC_uvchr(c) (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c)) |
537 | #define isIDFIRST_LC_uvchr(c) (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c)) | |
538 | #define isALPHA_LC_uvchr(c) (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c)) | |
539 | #define isSPACE_LC_uvchr(c) (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c)) | |
540 | #define isDIGIT_LC_uvchr(c) (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c)) | |
541 | #define isUPPER_LC_uvchr(c) (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c)) | |
542 | #define isLOWER_LC_uvchr(c) (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c)) | |
543 | #define isALNUMC_LC_uvchr(c) (c < 256 ? isALNUMC_LC(c) : is_uni_alnumc_lc(c)) | |
544 | #define isCNTRL_LC_uvchr(c) (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c)) | |
545 | #define isGRAPH_LC_uvchr(c) (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c)) | |
546 | #define isPRINT_LC_uvchr(c) (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c)) | |
547 | #define isPUNCT_LC_uvchr(c) (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c)) | |
a0ed51b3 | 548 | |
aaa51d5e JF |
549 | #define isPSXSPC_LC_uni(c) (isSPACE_LC_uni(c) ||(c) == '\f') |
550 | #define isBLANK_LC_uni(c) isBLANK(c) /* could be wrong */ | |
551 | ||
a0ed51b3 | 552 | #define isALNUM_utf8(p) is_utf8_alnum(p) |
82686b01 JH |
553 | /* The ID_Start of Unicode is quite limiting: it assumes a L-class |
554 | * character (meaning that you cannot have, say, a CJK character). | |
555 | * Instead, let's allow ID_Continue but not digits. */ | |
556 | #define isIDFIRST_utf8(p) (is_utf8_idcont(p) && !is_utf8_digit(p)) | |
a0ed51b3 LW |
557 | #define isALPHA_utf8(p) is_utf8_alpha(p) |
558 | #define isSPACE_utf8(p) is_utf8_space(p) | |
559 | #define isDIGIT_utf8(p) is_utf8_digit(p) | |
560 | #define isUPPER_utf8(p) is_utf8_upper(p) | |
561 | #define isLOWER_utf8(p) is_utf8_lower(p) | |
b8c5462f JH |
562 | #define isALNUMC_utf8(p) is_utf8_alnumc(p) |
563 | #define isASCII_utf8(p) is_utf8_ascii(p) | |
564 | #define isCNTRL_utf8(p) is_utf8_cntrl(p) | |
565 | #define isGRAPH_utf8(p) is_utf8_graph(p) | |
a0ed51b3 | 566 | #define isPRINT_utf8(p) is_utf8_print(p) |
b8c5462f JH |
567 | #define isPUNCT_utf8(p) is_utf8_punct(p) |
568 | #define isXDIGIT_utf8(p) is_utf8_xdigit(p) | |
a2a2844f JH |
569 | #define toUPPER_utf8(p,s,l) to_utf8_upper(p,s,l) |
570 | #define toTITLE_utf8(p,s,l) to_utf8_title(p,s,l) | |
571 | #define toLOWER_utf8(p,s,l) to_utf8_lower(p,s,l) | |
a0ed51b3 | 572 | |
aaa51d5e JF |
573 | #define isPSXSPC_utf8(c) (isSPACE_utf8(c) ||(c) == '\f') |
574 | #define isBLANK_utf8(c) isBLANK(c) /* could be wrong */ | |
575 | ||
9041c2e3 NIS |
576 | #define isALNUM_LC_utf8(p) isALNUM_LC_uvchr(utf8_to_uvchr(p, 0)) |
577 | #define isIDFIRST_LC_utf8(p) isIDFIRST_LC_uvchr(utf8_to_uvchr(p, 0)) | |
578 | #define isALPHA_LC_utf8(p) isALPHA_LC_uvchr(utf8_to_uvchr(p, 0)) | |
579 | #define isSPACE_LC_utf8(p) isSPACE_LC_uvchr(utf8_to_uvchr(p, 0)) | |
580 | #define isDIGIT_LC_utf8(p) isDIGIT_LC_uvchr(utf8_to_uvchr(p, 0)) | |
581 | #define isUPPER_LC_utf8(p) isUPPER_LC_uvchr(utf8_to_uvchr(p, 0)) | |
582 | #define isLOWER_LC_utf8(p) isLOWER_LC_uvchr(utf8_to_uvchr(p, 0)) | |
583 | #define isALNUMC_LC_utf8(p) isALNUMC_LC_uvchr(utf8_to_uvchr(p, 0)) | |
584 | #define isCNTRL_LC_utf8(p) isCNTRL_LC_uvchr(utf8_to_uvchr(p, 0)) | |
585 | #define isGRAPH_LC_utf8(p) isGRAPH_LC_uvchr(utf8_to_uvchr(p, 0)) | |
586 | #define isPRINT_LC_utf8(p) isPRINT_LC_uvchr(utf8_to_uvchr(p, 0)) | |
587 | #define isPUNCT_LC_utf8(p) isPUNCT_LC_uvchr(utf8_to_uvchr(p, 0)) | |
a0ed51b3 | 588 | |
aaa51d5e JF |
589 | #define isPSXSPC_LC_utf8(c) (isSPACE_LC_utf8(c) ||(c) == '\f') |
590 | #define isBLANK_LC_utf8(c) isBLANK(c) /* could be wrong */ | |
591 | ||
9d116dd7 | 592 | #ifdef EBCDIC |
20b634c2 JH |
593 | # ifdef PERL_IMPLICIT_CONTEXT |
594 | # define toCTRL(c) Perl_ebcdic_control(aTHX_ c) | |
595 | # else | |
596 | # define toCTRL Perl_ebcdic_control | |
597 | # endif | |
9d116dd7 JH |
598 | #else |
599 | /* This conversion works both ways, strangely enough. */ | |
600 | # define toCTRL(c) (toUPPER(c) ^ 64) | |
601 | #endif | |
bbce6d69 | 602 | |
dea28490 JJ |
603 | /* Line numbers are unsigned, 32 bits. */ |
604 | typedef U32 line_t; | |
dea28490 | 605 | #define NOLINE ((line_t) 4294967295UL) |
378cc40b | 606 | |
8c52afec | 607 | |
8e84507e | 608 | /* |
ccfc67b7 JH |
609 | =head1 Memory Management |
610 | ||
a02a5408 | 611 | =for apidoc Am|void|Newx|void* ptr|int nitems|type |
954c1994 GS |
612 | The XSUB-writer's interface to the C C<malloc> function. |
613 | ||
c5008215 JC |
614 | In 5.9.3, Newx() and friends replace the older New() API, and drops |
615 | the first parameter, I<x>, a debug aid which allowed callers to identify | |
37b8b4c9 | 616 | themselves. This aid has been superseded by a new build option, |
c5008215 JC |
617 | PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still |
618 | there for use in XS modules supporting older perls. | |
619 | ||
a02a5408 | 620 | =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast |
954c1994 | 621 | The XSUB-writer's interface to the C C<malloc> function, with |
c5008215 | 622 | cast. See also C<Newx>. |
954c1994 | 623 | |
a02a5408 | 624 | =for apidoc Am|void|Newxz|void* ptr|int nitems|type |
954c1994 | 625 | The XSUB-writer's interface to the C C<malloc> function. The allocated |
c5008215 | 626 | memory is zeroed with C<memzero>. See also C<Newx>. |
a02a5408 | 627 | |
954c1994 GS |
628 | =for apidoc Am|void|Renew|void* ptr|int nitems|type |
629 | The XSUB-writer's interface to the C C<realloc> function. | |
630 | ||
631 | =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast | |
632 | The XSUB-writer's interface to the C C<realloc> function, with | |
633 | cast. | |
634 | ||
49b8b560 | 635 | =for apidoc Am|void|Safefree|void* ptr |
954c1994 GS |
636 | The XSUB-writer's interface to the C C<free> function. |
637 | ||
638 | =for apidoc Am|void|Move|void* src|void* dest|int nitems|type | |
639 | The XSUB-writer's interface to the C C<memmove> function. The C<src> is the | |
640 | source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is | |
641 | the type. Can do overlapping moves. See also C<Copy>. | |
642 | ||
e90e2364 NC |
643 | =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type |
644 | Like C<Move> but returns dest. Useful for encouraging compilers to tail-call | |
645 | optimise. | |
646 | ||
954c1994 GS |
647 | =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type |
648 | The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the | |
649 | source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is | |
650 | the type. May fail on overlapping copies. See also C<Move>. | |
651 | ||
e90e2364 NC |
652 | =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type |
653 | ||
654 | Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call | |
655 | optimise. | |
656 | ||
954c1994 GS |
657 | =for apidoc Am|void|Zero|void* dest|int nitems|type |
658 | ||
659 | The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the | |
660 | destination, C<nitems> is the number of items, and C<type> is the type. | |
661 | ||
e90e2364 NC |
662 | =for apidoc Am|void *|ZeroD|void* dest|int nitems|type |
663 | ||
664 | Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call | |
665 | optimise. | |
666 | ||
954c1994 | 667 | =for apidoc Am|void|StructCopy|type src|type dest|type |
4375e838 | 668 | This is an architecture-independent macro to copy one structure to another. |
954c1994 | 669 | |
7e337ee0 JH |
670 | =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte |
671 | ||
672 | Fill up memory with a byte pattern (a byte repeated over and over | |
673 | again) that hopefully catches attempts to access uninitialized memory. | |
674 | ||
675 | =for apidoc Am|void|PoisonNew|void* dest|int nitems|type | |
676 | ||
677 | PoisonWith(0xAB) for catching access to allocated but uninitialized memory. | |
678 | ||
1c12ffb4 | 679 | =for apidoc Am|void|PoisonFree|void* dest|int nitems|type |
7e337ee0 JH |
680 | |
681 | PoisonWith(0xEF) for catching access to freed memory. | |
682 | ||
9965345d JH |
683 | =for apidoc Am|void|Poison|void* dest|int nitems|type |
684 | ||
7e337ee0 | 685 | PoisonWith(0xEF) for catching access to freed memory. |
9965345d JH |
686 | |
687 | =cut */ | |
954c1994 | 688 | |
561b68a9 SH |
689 | /* Maintained for backwards-compatibility only. Use newSV() instead. */ |
690 | #ifndef PERL_CORE | |
ff06c60c | 691 | #define NEWSV(x,len) newSV(len) |
561b68a9 | 692 | #endif |
ff06c60c | 693 | |
19a94d75 JH |
694 | #define MEM_SIZE_MAX ((MEM_SIZE)~0) |
695 | ||
2720f793 JH |
696 | /* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil |
697 | * overly eager compilers that will bleat about e.g. | |
698 | * (U16)n > (size_t)~0/sizeof(U16) always being false. */ | |
27d5b266 | 699 | #ifdef PERL_MALLOC_WRAP |
fabdb6c0 | 700 | #define MEM_WRAP_CHECK(n,t) MEM_WRAP_CHECK_1(n,t,PL_memory_wrap) |
27d5b266 | 701 | #define MEM_WRAP_CHECK_1(n,t,a) \ |
19a94d75 | 702 | (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext(a),0)) |
8b44ba4c | 703 | #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t), |
27d5b266 | 704 | |
19a94d75 | 705 | #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))) |
1936d2a7 | 706 | |
27d5b266 JH |
707 | #else |
708 | ||
410319be NC |
709 | #define MEM_WRAP_CHECK(n,t) |
710 | #define MEM_WRAP_CHECK_1(n,t,a) | |
711 | #define MEM_WRAP_CHECK_2(n,t,a,b) | |
8b44ba4c NC |
712 | #define MEM_WRAP_CHECK_(n,t) |
713 | ||
6fff79ce | 714 | #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1))) |
27d5b266 | 715 | |
1936d2a7 | 716 | #endif |
8b44ba4c | 717 | |
fe4f188c | 718 | #ifdef PERL_MEM_LOG |
46c6c7e2 | 719 | /* |
9f653bb5 | 720 | * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s |
46c6c7e2 JH |
721 | * go through functions, which are handy for debugging breakpoints, but |
722 | * which more importantly get the immediate calling environment (file and | |
e352bcff JH |
723 | * line number, and C function name if available) passed in. This info can |
724 | * then be used for logging the calls, for which one gets a sample | |
725 | * implementation if PERL_MEM_LOG_STDERR is defined. | |
3609ea0d | 726 | * |
46c6c7e2 JH |
727 | * Known problems: |
728 | * - all memory allocs do not get logged, only those | |
729 | * that go through Newx() and derivatives (while all | |
730 | * Safefrees do get logged) | |
731 | * - __FILE__ and __LINE__ do not work everywhere | |
732 | * - __func__ or __FUNCTION__ even less so | |
733 | * - I think more goes on after the perlio frees but | |
734 | * the thing is that STDERR gets closed (as do all | |
735 | * the file descriptors) | |
736 | * - no deeper calling stack than the caller of the Newx() | |
737 | * or the kind, but do I look like a C reflection/introspection | |
738 | * utility to you? | |
739 | * - the function prototypes for the logging functions | |
740 | * probably should maybe be somewhere else than handy.h | |
741 | * - one could consider inlining (macrofying) the logging | |
742 | * for speed, but I am too lazy | |
743 | * - one could imagine recording the allocations in a hash, | |
744 | * (keyed by the allocation address?), and maintain that | |
745 | * through reallocs and frees, but how to do that without | |
746 | * any News() happening...? | |
747 | */ | |
748 | ||
749 | 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); | |
750 | ||
751 | 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); | |
752 | ||
753 | Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname); | |
754 | ||
fe4f188c JH |
755 | #endif |
756 | ||
757 | #ifdef PERL_MEM_LOG | |
46c6c7e2 JH |
758 | #define MEM_LOG_ALLOC(n,t,a) Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__) |
759 | #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__) | |
760 | #define MEM_LOG_FREE(a) Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__) | |
fe4f188c JH |
761 | #endif |
762 | ||
763 | #ifndef MEM_LOG_ALLOC | |
764 | #define MEM_LOG_ALLOC(n,t,a) (a) | |
765 | #endif | |
766 | #ifndef MEM_LOG_REALLOC | |
767 | #define MEM_LOG_REALLOC(n,t,v,a) (a) | |
768 | #endif | |
769 | #ifndef MEM_LOG_FREE | |
770 | #define MEM_LOG_FREE(a) (a) | |
771 | #endif | |
772 | ||
773 | #define Newx(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_ALLOC(n,t,(t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))))) | |
774 | #define Newxc(v,n,t,c) (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_ALLOC(n,t,(c*)safemalloc((MEM_SIZE)((n)*sizeof(t)))))) | |
3341f577 | 775 | #define Newxz(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_ALLOC(n,t,(t*)safecalloc((n),sizeof(t))))) |
a6f6820f NC |
776 | |
777 | #ifndef PERL_CORE | |
a02a5408 JC |
778 | /* pre 5.9.x compatibility */ |
779 | #define New(x,v,n,t) Newx(v,n,t) | |
780 | #define Newc(x,v,n,t,c) Newxc(v,n,t,c) | |
4541904d | 781 | #define Newz(x,v,n,t) Newxz(v,n,t) |
a6f6820f | 782 | #endif |
a02a5408 | 783 | |
ff68c719 | 784 | #define Renew(v,n,t) \ |
fe4f188c | 785 | (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_REALLOC(n,t,v,(t*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t)))))) |
ff68c719 | 786 | #define Renewc(v,n,t,c) \ |
fe4f188c | 787 | (v = (MEM_WRAP_CHECK_(n,t) MEM_LOG_REALLOC(n,t,v,(c*)saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t)))))) |
94010e71 NC |
788 | |
789 | #ifdef PERL_POISON | |
790 | #define Safefree(d) \ | |
06c0cc96 | 791 | ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0) |
94010e71 | 792 | #else |
fe4f188c | 793 | #define Safefree(d) safefree(MEM_LOG_FREE((Malloc_t)(d))) |
94010e71 | 794 | #endif |
55497cff | 795 | |
8b44ba4c NC |
796 | #define Move(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t))) |
797 | #define Copy(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t))) | |
798 | #define Zero(d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t))) | |
55497cff | 799 | |
8b44ba4c NC |
800 | #define MoveD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t))) |
801 | #define CopyD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t))) | |
e90e2364 | 802 | #ifdef HAS_MEMSET |
8b44ba4c | 803 | #define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t))) |
e90e2364 | 804 | #else |
8b44ba4c NC |
805 | /* Using bzero(), which returns void. */ |
806 | #define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d) | |
e90e2364 NC |
807 | #endif |
808 | ||
7e337ee0 JH |
809 | #define PoisonWith(d,n,t,b) (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t))) |
810 | #define PoisonNew(d,n,t) PoisonWith(d,n,t,0xAB) | |
811 | #define PoisonFree(d,n,t) PoisonWith(d,n,t,0xEF) | |
812 | #define Poison(d,n,t) PoisonFree(d,n,t) | |
27d5b266 | 813 | |
2304df62 | 814 | #ifdef USE_STRUCT_COPY |
ff68c719 | 815 | #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s))) |
bee1dbe2 LW |
816 | #else |
817 | #define StructCopy(s,d,t) Copy(s,d,1,t) | |
818 | #endif | |
2cc61e15 | 819 | |
622913ab IZ |
820 | #define C_ARRAY_LENGTH(a) (sizeof(a)/sizeof((a)[0])) |
821 | ||
2cc61e15 DD |
822 | #ifdef NEED_VA_COPY |
823 | # ifdef va_copy | |
824 | # define Perl_va_copy(s, d) va_copy(d, s) | |
2cc61e15 | 825 | # else |
a1866d1b JH |
826 | # if defined(__va_copy) |
827 | # define Perl_va_copy(s, d) __va_copy(d, s) | |
828 | # else | |
829 | # define Perl_va_copy(s, d) Copy(s, d, 1, va_list) | |
830 | # endif | |
2cc61e15 DD |
831 | # endif |
832 | #endif | |
833 | ||
472d47bc SB |
834 | /* convenience debug macros */ |
835 | #ifdef USE_ITHREADS | |
836 | #define pTHX_FORMAT "Perl interpreter: 0x%p" | |
837 | #define pTHX__FORMAT ", Perl interpreter: 0x%p" | |
f54cb97a AL |
838 | #define pTHX_VALUE_ (void *)my_perl, |
839 | #define pTHX_VALUE (void *)my_perl | |
840 | #define pTHX__VALUE_ ,(void *)my_perl, | |
841 | #define pTHX__VALUE ,(void *)my_perl | |
472d47bc | 842 | #else |
3609ea0d | 843 | #define pTHX_FORMAT |
472d47bc | 844 | #define pTHX__FORMAT |
3609ea0d | 845 | #define pTHX_VALUE_ |
472d47bc | 846 | #define pTHX_VALUE |
3609ea0d | 847 | #define pTHX__VALUE_ |
472d47bc SB |
848 | #define pTHX__VALUE |
849 | #endif /* USE_ITHREADS */ | |
3609ea0d | 850 |