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