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