Commit | Line | Data |
---|---|---|
a0d0e21e | 1 | /* sv.h |
79072805 | 2 | * |
1129b882 | 3 | * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, |
83706693 | 4 | * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others |
79072805 LW |
5 | * |
6 | * You may distribute under the terms of either the GNU General Public | |
7 | * License or the Artistic License, as specified in the README file. | |
8 | * | |
79072805 LW |
9 | */ |
10 | ||
a0d0e21e LW |
11 | #ifdef sv_flags |
12 | #undef sv_flags /* Convex has this in <signal.h> for sigvec() */ | |
13 | #endif | |
14 | ||
954c1994 | 15 | /* |
ccfc67b7 JH |
16 | =head1 SV Flags |
17 | ||
954c1994 | 18 | =for apidoc AmU||svtype |
8cf8f3d1 | 19 | An enum of flags for Perl types. These are found in the file B<sv.h> |
954c1994 GS |
20 | in the C<svtype> enum. Test these flags with the C<SvTYPE> macro. |
21 | ||
a5e62da0 FC |
22 | The types are: |
23 | ||
24 | SVt_NULL | |
a5e62da0 FC |
25 | SVt_IV |
26 | SVt_NV | |
27 | SVt_RV | |
28 | SVt_PV | |
29 | SVt_PVIV | |
30 | SVt_PVNV | |
31 | SVt_PVMG | |
e94d9b54 | 32 | SVt_INVLIST |
a5e62da0 FC |
33 | SVt_REGEXP |
34 | SVt_PVGV | |
35 | SVt_PVLV | |
36 | SVt_PVAV | |
37 | SVt_PVHV | |
38 | SVt_PVCV | |
39 | SVt_PVFM | |
40 | SVt_PVIO | |
41 | ||
42 | These are most easily explained from the bottom up. | |
43 | ||
44 | SVt_PVIO is for I/O objects, SVt_PVFM for formats, SVt_PVCV for | |
45 | subroutines, SVt_PVHV for hashes and SVt_PVAV for arrays. | |
46 | ||
47 | All the others are scalar types, that is, things that can be bound to a | |
48 | C<$> variable. For these, the internal types are mostly orthogonal to | |
49 | types in the Perl language. | |
50 | ||
51 | Hence, checking C<< SvTYPE(sv) < SVt_PVAV >> is the best way to see whether | |
52 | something is a scalar. | |
53 | ||
54 | SVt_PVGV represents a typeglob. If !SvFAKE(sv), then it is a real, | |
55 | incoercible typeglob. If SvFAKE(sv), then it is a scalar to which a | |
56 | typeglob has been assigned. Assigning to it again will stop it from being | |
57 | a typeglob. SVt_PVLV represents a scalar that delegates to another scalar | |
58 | behind the scenes. It is used, e.g., for the return value of C<substr> and | |
59 | for tied hash and array elements. It can hold any scalar value, including | |
72d33970 FC |
60 | a typeglob. SVt_REGEXP is for regular |
61 | expressions. SVt_INVLIST is for Perl | |
e94d9b54 | 62 | core internal use only. |
a5e62da0 FC |
63 | |
64 | SVt_PVMG represents a "normal" scalar (not a typeglob, regular expression, | |
65 | or delegate). Since most scalars do not need all the internal fields of a | |
66 | PVMG, we save memory by allocating smaller structs when possible. All the | |
67 | other types are just simpler forms of SVt_PVMG, with fewer internal fields. | |
68 | SVt_NULL can only hold undef. SVt_IV can hold undef, an integer, or a | |
69 | reference. (SVt_RV is an alias for SVt_IV, which exists for backward | |
70 | compatibility.) SVt_NV can hold any of those or a double. SVt_PV can only | |
71 | hold undef or a string. SVt_PVIV is a superset of SVt_PV and SVt_IV. | |
72 | SVt_PVNV is similar. SVt_PVMG can hold anything SVt_PVNV can hold, but it | |
73 | can, but does not have to, be blessed or magical. | |
74 | ||
75 | =for apidoc AmU||SVt_NULL | |
76 | Type flag for scalars. See L</svtype>. | |
954c1994 GS |
77 | |
78 | =for apidoc AmU||SVt_IV | |
a5e62da0 | 79 | Type flag for scalars. See L</svtype>. |
954c1994 GS |
80 | |
81 | =for apidoc AmU||SVt_NV | |
a5e62da0 FC |
82 | Type flag for scalars. See L</svtype>. |
83 | ||
84 | =for apidoc AmU||SVt_PV | |
85 | Type flag for scalars. See L</svtype>. | |
86 | ||
87 | =for apidoc AmU||SVt_PVIV | |
88 | Type flag for scalars. See L</svtype>. | |
89 | ||
90 | =for apidoc AmU||SVt_PVNV | |
91 | Type flag for scalars. See L</svtype>. | |
954c1994 GS |
92 | |
93 | =for apidoc AmU||SVt_PVMG | |
a5e62da0 FC |
94 | Type flag for scalars. See L</svtype>. |
95 | ||
e94d9b54 KW |
96 | =for apidoc AmU||SVt_INVLIST |
97 | Type flag for scalars. See L</svtype>. | |
98 | ||
a5e62da0 FC |
99 | =for apidoc AmU||SVt_REGEXP |
100 | Type flag for regular expressions. See L</svtype>. | |
101 | ||
102 | =for apidoc AmU||SVt_PVGV | |
103 | Type flag for typeglobs. See L</svtype>. | |
104 | ||
105 | =for apidoc AmU||SVt_PVLV | |
106 | Type flag for scalars. See L</svtype>. | |
954c1994 GS |
107 | |
108 | =for apidoc AmU||SVt_PVAV | |
a5e62da0 | 109 | Type flag for arrays. See L</svtype>. |
954c1994 GS |
110 | |
111 | =for apidoc AmU||SVt_PVHV | |
a5e62da0 | 112 | Type flag for hashes. See L</svtype>. |
954c1994 GS |
113 | |
114 | =for apidoc AmU||SVt_PVCV | |
a5e62da0 FC |
115 | Type flag for subroutines. See L</svtype>. |
116 | ||
117 | =for apidoc AmU||SVt_PVFM | |
118 | Type flag for formats. See L</svtype>. | |
119 | ||
120 | =for apidoc AmU||SVt_PVIO | |
121 | Type flag for I/O objects. See L</svtype>. | |
954c1994 GS |
122 | |
123 | =cut | |
1078c6a2 KW |
124 | |
125 | These are ordered so that the simpler types have a lower value; SvUPGRADE | |
126 | doesn't allow you to upgrade from a higher numbered type to a lower numbered | |
127 | one; also there is code that assumes that anything that has as a PV component | |
128 | has a type numbered >= SVt_PV. | |
954c1994 GS |
129 | */ |
130 | ||
1078c6a2 | 131 | |
79072805 | 132 | typedef enum { |
a0d0e21e | 133 | SVt_NULL, /* 0 */ |
e94d9b54 KW |
134 | /* BIND was here, before INVLIST replaced it. */ |
135 | SVt_IV, /* 1 */ | |
136 | SVt_NV, /* 2 */ | |
4df7f6af | 137 | /* RV was here, before it was merged with IV. */ |
e94d9b54 KW |
138 | SVt_PV, /* 3 */ |
139 | SVt_INVLIST, /* 4, implemented as a PV */ | |
4df7f6af NC |
140 | SVt_PVIV, /* 5 */ |
141 | SVt_PVNV, /* 6 */ | |
142 | SVt_PVMG, /* 7 */ | |
5c35adbb | 143 | SVt_REGEXP, /* 8 */ |
cecf5685 | 144 | /* PVBM was here, before BIND replaced it. */ |
4ce457a6 TP |
145 | SVt_PVGV, /* 9 */ |
146 | SVt_PVLV, /* 10 */ | |
147 | SVt_PVAV, /* 11 */ | |
148 | SVt_PVHV, /* 12 */ | |
149 | SVt_PVCV, /* 13 */ | |
a0d0e21e | 150 | SVt_PVFM, /* 14 */ |
93e68bfb JC |
151 | SVt_PVIO, /* 15 */ |
152 | SVt_LAST /* keep last in enum. used to size arrays */ | |
79072805 LW |
153 | } svtype; |
154 | ||
f1fb8741 | 155 | /* *** any alterations to the SV types above need to be reflected in |
e94d9b54 KW |
156 | * SVt_MASK and the various PL_valid_types_* tables. As of this writing those |
157 | * tables are in perl.h. There are also two affected names tables in dump.c, | |
158 | * one in B.xs, and 'bodies_by_type[]' in sv.c */ | |
f1fb8741 DM |
159 | |
160 | #define SVt_MASK 0xf /* smallest bitmask that covers all types */ | |
161 | ||
cecf5685 NC |
162 | #ifndef PERL_CORE |
163 | /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most | |
1078c6a2 | 164 | purposes external code wanting to consider PVBM probably needs to think of |
cecf5685 NC |
165 | PVMG instead. */ |
166 | # define SVt_PVBM SVt_PVMG | |
4df7f6af NC |
167 | /* Anything wanting to create a reference from clean should ensure that it has |
168 | a scalar of type SVt_IV now: */ | |
169 | # define SVt_RV SVt_IV | |
cecf5685 NC |
170 | #endif |
171 | ||
d2a0f284 | 172 | /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL |
db93c0c4 NC |
173 | so never reaches the clause at the end that uses sv_type_details->body_size |
174 | to determine whether to call safefree(). Hence body_size can be set | |
175 | non-zero to record the size of HEs, without fear of bogus frees. */ | |
6a93a7e5 NC |
176 | #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST) |
177 | #define HE_SVSLOT SVt_NULL | |
178 | #endif | |
43e6e717 | 179 | |
232d1c15 NC |
180 | #define PERL_ARENA_ROOTS_SIZE (SVt_LAST) |
181 | ||
43e6e717 NC |
182 | /* typedefs to eliminate some typing */ |
183 | typedef struct he HE; | |
184 | typedef struct hek HEK; | |
185 | ||
79072805 LW |
186 | /* Using C's structural equivalence to help emulate C++ inheritance here... */ |
187 | ||
30153bd2 JC |
188 | /* start with 2 sv-head building blocks */ |
189 | #define _SV_HEAD(ptrtype) \ | |
190 | ptrtype sv_any; /* pointer to body */ \ | |
191 | U32 sv_refcnt; /* how many references to us */ \ | |
192 | U32 sv_flags /* what we are */ | |
193 | ||
194 | #define _SV_HEAD_UNION \ | |
195 | union { \ | |
2a12fdfc | 196 | char* svu_pv; /* pointer to malloced string */ \ |
30153bd2 JC |
197 | IV svu_iv; \ |
198 | UV svu_uv; \ | |
199 | SV* svu_rv; /* pointer to another SV */ \ | |
8d919b0a | 200 | struct regexp* svu_rx; \ |
30153bd2 JC |
201 | SV** svu_array; \ |
202 | HE** svu_hash; \ | |
f7877b28 | 203 | GP* svu_gp; \ |
6f7e8353 | 204 | PerlIO *svu_fp; \ |
30153bd2 JC |
205 | } sv_u |
206 | ||
207 | ||
5e045b90 | 208 | struct STRUCT_SV { /* struct sv { */ |
30153bd2 JC |
209 | _SV_HEAD(void*); |
210 | _SV_HEAD_UNION; | |
fd0854ff | 211 | #ifdef DEBUG_LEAKING_SCALARS |
654eccd5 JD |
212 | PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */ |
213 | PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */ | |
654eccd5 | 214 | PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */ |
c895a371 | 215 | UV sv_debug_serial; /* serial number of sv allocation */ |
cd676548 DM |
216 | char * sv_debug_file; /* the file where we were allocated */ |
217 | SV * sv_debug_parent; /* what we were cloned from (ithreads)*/ | |
fd0854ff | 218 | #endif |
79072805 LW |
219 | }; |
220 | ||
221 | struct gv { | |
30153bd2 JC |
222 | _SV_HEAD(XPVGV*); /* pointer to xpvgv body */ |
223 | _SV_HEAD_UNION; | |
79072805 LW |
224 | }; |
225 | ||
226 | struct cv { | |
30153bd2 JC |
227 | _SV_HEAD(XPVCV*); /* pointer to xpvcv body */ |
228 | _SV_HEAD_UNION; | |
79072805 LW |
229 | }; |
230 | ||
231 | struct av { | |
0f7b1ae0 | 232 | _SV_HEAD(XPVAV*); /* pointer to xpvav body */ |
30153bd2 | 233 | _SV_HEAD_UNION; |
79072805 LW |
234 | }; |
235 | ||
236 | struct hv { | |
30153bd2 JC |
237 | _SV_HEAD(XPVHV*); /* pointer to xpvhv body */ |
238 | _SV_HEAD_UNION; | |
8990e307 LW |
239 | }; |
240 | ||
241 | struct io { | |
30153bd2 JC |
242 | _SV_HEAD(XPVIO*); /* pointer to xpvio body */ |
243 | _SV_HEAD_UNION; | |
79072805 LW |
244 | }; |
245 | ||
d2f13c59 NC |
246 | struct p5rx { |
247 | _SV_HEAD(struct regexp*); /* pointer to regexp body */ | |
248 | _SV_HEAD_UNION; | |
249 | }; | |
250 | ||
30153bd2 | 251 | #undef _SV_HEAD |
0f7b1ae0 | 252 | #undef _SV_HEAD_UNION /* ensure no pollution */ |
30153bd2 | 253 | |
954c1994 | 254 | /* |
ccfc67b7 JH |
255 | =head1 SV Manipulation Functions |
256 | ||
954c1994 GS |
257 | =for apidoc Am|U32|SvREFCNT|SV* sv |
258 | Returns the value of the object's reference count. | |
259 | ||
260 | =for apidoc Am|SV*|SvREFCNT_inc|SV* sv | |
5df2f140 | 261 | Increments the reference count of the given SV, returning the SV. |
954c1994 | 262 | |
b37c2d43 AL |
263 | All of the following SvREFCNT_inc* macros are optimized versions of |
264 | SvREFCNT_inc, and can be replaced with SvREFCNT_inc. | |
265 | ||
266 | =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv | |
267 | Same as SvREFCNT_inc, but can only be used if you know I<sv> | |
268 | is not NULL. Since we don't have to check the NULLness, it's faster | |
269 | and smaller. | |
270 | ||
f2403e57 | 271 | =for apidoc Am|void|SvREFCNT_inc_void|SV* sv |
b37c2d43 AL |
272 | Same as SvREFCNT_inc, but can only be used if you don't need the |
273 | return value. The macro doesn't need to return a meaningful value. | |
274 | ||
f2403e57 | 275 | =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv |
b37c2d43 AL |
276 | Same as SvREFCNT_inc, but can only be used if you don't need the return |
277 | value, and you know that I<sv> is not NULL. The macro doesn't need | |
278 | to return a meaningful value, or check for NULLness, so it's smaller | |
279 | and faster. | |
280 | ||
281 | =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv | |
4ea561bc NC |
282 | Same as SvREFCNT_inc, but can only be used with expressions without side |
283 | effects. Since we don't have to store a temporary value, it's faster. | |
b37c2d43 AL |
284 | |
285 | =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv | |
286 | Same as SvREFCNT_inc_simple, but can only be used if you know I<sv> | |
287 | is not NULL. Since we don't have to check the NULLness, it's faster | |
288 | and smaller. | |
289 | ||
f2403e57 | 290 | =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv |
b37c2d43 AL |
291 | Same as SvREFCNT_inc_simple, but can only be used if you don't need the |
292 | return value. The macro doesn't need to return a meaningful value. | |
293 | ||
f2403e57 | 294 | =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv |
e638c624 MHM |
295 | Same as SvREFCNT_inc, but can only be used if you don't need the return |
296 | value, and you know that I<sv> is not NULL. The macro doesn't need | |
297 | to return a meaningful value, or check for NULLness, so it's smaller | |
298 | and faster. | |
b37c2d43 | 299 | |
954c1994 | 300 | =for apidoc Am|void|SvREFCNT_dec|SV* sv |
72d33970 | 301 | Decrements the reference count of the given SV. I<sv> may be NULL. |
954c1994 | 302 | |
4a9a56a7 DM |
303 | =for apidoc Am|void|SvREFCNT_dec_NN|SV* sv |
304 | Same as SvREFCNT_dec, but can only be used if you know I<sv> | |
305 | is not NULL. Since we don't have to check the NULLness, it's faster | |
306 | and smaller. | |
307 | ||
954c1994 GS |
308 | =for apidoc Am|svtype|SvTYPE|SV* sv |
309 | Returns the type of the SV. See C<svtype>. | |
310 | ||
311 | =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type | |
312 | Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to | |
313 | perform the upgrade if necessary. See C<svtype>. | |
314 | ||
315 | =cut | |
316 | */ | |
317 | ||
463ee0b2 | 318 | #define SvANY(sv) (sv)->sv_any |
79072805 | 319 | #define SvFLAGS(sv) (sv)->sv_flags |
aeea060c | 320 | #define SvREFCNT(sv) (sv)->sv_refcnt |
a863c7d1 | 321 | |
27669aa4 FC |
322 | #define SvREFCNT_inc(sv) S_SvREFCNT_inc(MUTABLE_SV(sv)) |
323 | #define SvREFCNT_inc_simple(sv) SvREFCNT_inc(sv) | |
324 | #define SvREFCNT_inc_NN(sv) S_SvREFCNT_inc_NN(MUTABLE_SV(sv)) | |
325 | #define SvREFCNT_inc_void(sv) S_SvREFCNT_inc_void(MUTABLE_SV(sv)) | |
8990e307 | 326 | |
b37c2d43 | 327 | /* These guys don't need the curly blocks */ |
e638c624 | 328 | #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END |
b1bc3f34 NC |
329 | #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv)) |
330 | #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv))) | |
331 | #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv))) | |
b37c2d43 | 332 | |
75e16a44 | 333 | #define SvREFCNT_dec(sv) S_SvREFCNT_dec(aTHX_ MUTABLE_SV(sv)) |
4a9a56a7 | 334 | #define SvREFCNT_dec_NN(sv) S_SvREFCNT_dec_NN(aTHX_ MUTABLE_SV(sv)) |
a863c7d1 | 335 | |
8990e307 | 336 | #define SVTYPEMASK 0xff |
1fef4616 | 337 | #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK)) |
79072805 | 338 | |
0565a181 NC |
339 | /* Sadly there are some parts of the core that have pointers to already-freed |
340 | SV heads, and rely on being able to tell that they are now free. So mark | |
341 | them all by using a consistent macro. */ | |
342 | #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK) | |
343 | ||
24e08842 DM |
344 | /* this is defined in this peculiar way to avoid compiler warnings. |
345 | * See the <20121213131428.GD1842@iabyn.com> thread in p5p */ | |
463ea229 | 346 | #define SvUPGRADE(sv, mt) \ |
24e08842 | 347 | ((void)(SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt),1))) |
79072805 | 348 | |
3f7ef1d4 NC |
349 | #define SVf_IOK 0x00000100 /* has valid public integer value */ |
350 | #define SVf_NOK 0x00000200 /* has valid public numeric value */ | |
351 | #define SVf_POK 0x00000400 /* has valid public pointer value */ | |
352 | #define SVf_ROK 0x00000800 /* has a valid reference pointer */ | |
353 | ||
354 | #define SVp_IOK 0x00001000 /* has valid non-public integer value */ | |
355 | #define SVp_NOK 0x00002000 /* has valid non-public numeric value */ | |
356 | #define SVp_POK 0x00004000 /* has valid non-public pointer value */ | |
fbb778ec | 357 | #define SVp_SCREAM 0x00008000 /* method name is DOES */ |
2e5b91de NC |
358 | #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */ |
359 | #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */ | |
1ccdb730 NC |
360 | #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant |
361 | subroutine in another package. Set the | |
7eeb6e4e | 362 | GvIMPORTED_CV_on() if it needs to be |
1ccdb730 | 363 | expanded to a real GV */ |
7db6405c | 364 | #define SVpad_NAMELIST SVp_SCREAM /* AV is a padnamelist */ |
e3918bb7 FC |
365 | #define SVf_IsCOW 0x00010000 /* copy on write (shared hash key if |
366 | SvLEN == 0) */ | |
9a214eec DM |
367 | #define SVs_PADTMP 0x00020000 /* in use as tmp; only if ! SVs_PADMY */ |
368 | #define SVs_PADSTALE 0x00020000 /* lexical has gone out of scope; | |
369 | only valid for SVs_PADMY */ | |
3f7ef1d4 NC |
370 | #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */ |
371 | #define SVs_PADMY 0x00040000 /* in use a "my" variable */ | |
372 | #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */ | |
373 | #define SVs_TEMP 0x00080000 /* string is stealable? */ | |
374 | #define SVs_OBJECT 0x00100000 /* is "blessed" */ | |
375 | #define SVs_GMG 0x00200000 /* has magical get method */ | |
376 | #define SVs_SMG 0x00400000 /* has magical set method */ | |
377 | #define SVs_RMG 0x00800000 /* has random magical methods */ | |
378 | ||
fea3622c | 379 | #define SVf_FAKE 0x01000000 /* 0: glob is just a copy |
3f7ef1d4 | 380 | 1: SV head arena wasn't malloc()ed |
e3918bb7 | 381 | 2: For PVCV, whether CvUNIQUE(cv) |
3f7ef1d4 NC |
382 | refers to an eval or once only |
383 | [CvEVAL(cv), CvSPECIAL(cv)] | |
e3918bb7 | 384 | 3: On a pad name SV, that slot in the |
3f7ef1d4 NC |
385 | frame AV is a REFCNT'ed reference |
386 | to a lexical from "outside". */ | |
3f7ef1d4 NC |
387 | #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this |
388 | means that a hv_aux struct is present | |
389 | after the main array */ | |
390 | #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by | |
36c662f4 NC |
391 | SVs in final arena cleanup. |
392 | Set in S_regtry on PL_reg_curpm, so that | |
393 | perl_destruct will skip it. */ | |
3f7ef1d4 | 394 | #define SVf_READONLY 0x08000000 /* may not be modified */ |
8990e307 | 395 | |
a0d0e21e | 396 | |
8990e307 | 397 | |
5bc28da9 | 398 | |
e3918bb7 | 399 | #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE|SVs_RMG|SVf_IsCOW) |
5bc28da9 | 400 | |
a0d0e21e | 401 | #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \ |
2e5b91de | 402 | SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP) |
a0d0e21e | 403 | |
7a77f1af | 404 | #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */ |
8990e307 | 405 | |
cd028baa | 406 | #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */ |
2e9f07a2 | 407 | |
70bc21b7 DM |
408 | /* note that SVf_AMAGIC is now only set on stashes, so this bit is free |
409 | * for non-HV SVs */ | |
410 | ||
2e9f07a2 | 411 | /* Ensure this value does not clash with the GV_ADD* flags in gv.h: */ |
cd028baa NC |
412 | #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded |
413 | This is also set on RVs whose overloaded | |
414 | stringification is UTF-8. This might | |
415 | only happen as a side effect of SvPV() */ | |
70bc21b7 DM |
416 | /* PVHV */ |
417 | #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */ | |
8990e307 | 418 | |
2e9f07a2 NC |
419 | /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can |
420 | be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't | |
421 | been restructured, so sometimes get used as string buffers. */ | |
422 | ||
70bc21b7 DM |
423 | |
424 | /* Some private flags. */ | |
425 | ||
e1dcbbca NC |
426 | |
427 | /* PVNV, PVMG only, and only used in pads. Should be safe to test on any scalar | |
428 | SV, as the core is careful to avoid setting both. | |
429 | ||
430 | SVf_POK, SVp_POK also set: | |
431 | 0x00004400 Normal | |
fbb778ec | 432 | 0x0000C400 method name for DOES (SvSCREAM) |
e1dcbbca NC |
433 | 0x40004400 FBM compiled (SvVALID) |
434 | 0x4000C400 pad name. | |
435 | ||
436 | 0x00008000 GV with GP | |
437 | 0x00008800 RV with PCS imported | |
438 | */ | |
439 | #define SVpad_NAME (SVp_SCREAM|SVpbm_VALID) | |
440 | /* This SV is a name in the PAD, so | |
3f7ef1d4 NC |
441 | SVpad_TYPED, SVpad_OUR and SVpad_STATE |
442 | apply */ | |
26a32e18 | 443 | /* PVAV */ |
3f7ef1d4 | 444 | #define SVpav_REAL 0x40000000 /* free old entries */ |
26a32e18 | 445 | /* PVHV */ |
3f7ef1d4 | 446 | #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */ |
69d97907 NC |
447 | /* This is only set true on a PVGV when it's playing "PVBM", but is tested for |
448 | on any regular scalar (anything <= PVLV) */ | |
5fe1b2e4 | 449 | #define SVpbm_VALID 0x40000000 |
7f83d853 | 450 | /* Only used in toke.c on an SV stored in PL_lex_repl */ |
3f7ef1d4 | 451 | #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */ |
25da4f38 | 452 | |
26a32e18 | 453 | /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */ |
3f7ef1d4 | 454 | #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */ |
26a32e18 | 455 | /* PVAV */ |
3f7ef1d4 | 456 | #define SVpav_REIFY 0x80000000 /* can become real */ |
26a32e18 | 457 | /* PVHV */ |
3f7ef1d4 | 458 | #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */ |
cecf5685 | 459 | /* PVGV when SVpbm_VALID is true */ |
5fe1b2e4 | 460 | #define SVpbm_TAIL 0x80000000 |
26a32e18 | 461 | /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */ |
3f7ef1d4 | 462 | #define SVprv_WEAKREF 0x80000000 /* Weak reference */ |
d3ce79bd DM |
463 | /* pad name vars only */ |
464 | #define SVpad_STATE 0x80000000 /* pad name is a "state" var */ | |
810b8aa5 | 465 | |
6e128786 NC |
466 | #define _XPV_HEAD \ |
467 | HV* xmg_stash; /* class package */ \ | |
468 | union _xmgu xmg_u; \ | |
8de47657 | 469 | STRLEN xpv_cur; /* length of svu_pv as a C string */ \ |
8d919b0a FC |
470 | union { \ |
471 | STRLEN xpvlenu_len; /* allocated size */ \ | |
472 | char * xpvlenu_pv; /* regexp string */ \ | |
473 | } xpv_len_u | |
474 | ||
475 | #define xpv_len xpv_len_u.xpvlenu_len | |
bb02a38f | 476 | |
20f4945e MHM |
477 | union _xnvu { |
478 | NV xnv_nv; /* numeric value, if any */ | |
479 | HV * xgv_stash; | |
480 | struct { | |
481 | U32 xlow; | |
482 | U32 xhigh; | |
483 | } xpad_cop_seq; /* used by pad.c for cop_sequence */ | |
20f4945e MHM |
484 | }; |
485 | ||
486 | union _xivu { | |
487 | IV xivu_iv; /* integer value */ | |
20f4945e | 488 | UV xivu_uv; |
20f4945e MHM |
489 | HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */ |
490 | }; | |
491 | ||
492 | union _xmgu { | |
493 | MAGIC* xmg_magic; /* linked list of magicalness */ | |
494 | HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */ | |
5bec93be | 495 | STRLEN xmg_hash_index; /* used while freeing hash entries */ |
7db6405c | 496 | }; /* also used by PadnamelistMAXNAMED */ |
11ca45c0 | 497 | |
79072805 | 498 | struct xpv { |
20f4945e | 499 | _XPV_HEAD; |
79072805 LW |
500 | }; |
501 | ||
502 | struct xpviv { | |
20f4945e MHM |
503 | _XPV_HEAD; |
504 | union _xivu xiv_u; | |
79072805 LW |
505 | }; |
506 | ||
311a25d9 NC |
507 | #define xiv_iv xiv_u.xivu_iv |
508 | ||
ff68c719 | 509 | struct xpvuv { |
20f4945e MHM |
510 | _XPV_HEAD; |
511 | union _xivu xuv_u; | |
ff68c719 | 512 | }; |
513 | ||
20f4945e | 514 | #define xuv_uv xuv_u.xivu_uv |
311a25d9 | 515 | |
79072805 | 516 | struct xpvnv { |
20f4945e MHM |
517 | _XPV_HEAD; |
518 | union _xivu xiv_u; | |
6e128786 | 519 | union _xnvu xnv_u; |
79072805 LW |
520 | }; |
521 | ||
3cd3be43 | 522 | /* This structure must match the beginning of struct xpvhv in hv.h. */ |
79072805 | 523 | struct xpvmg { |
20f4945e | 524 | _XPV_HEAD; |
6e128786 NC |
525 | union _xivu xiv_u; |
526 | union _xnvu xnv_u; | |
79072805 LW |
527 | }; |
528 | ||
529 | struct xpvlv { | |
20f4945e | 530 | _XPV_HEAD; |
6e128786 NC |
531 | union _xivu xiv_u; |
532 | union _xnvu xnv_u; | |
bbfdc870 FC |
533 | union { |
534 | STRLEN xlvu_targoff; | |
535 | SSize_t xlvu_stargoff; | |
536 | } xlv_targoff_u; | |
79072805 LW |
537 | STRLEN xlv_targlen; |
538 | SV* xlv_targ; | |
dd28f7bb DM |
539 | char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re |
540 | * y=alem/helem/iter t=tie T=tied HE */ | |
83f78d1a | 541 | char xlv_flags; /* 1 = negative offset 2 = negative len */ |
79072805 LW |
542 | }; |
543 | ||
bbfdc870 FC |
544 | #define xlv_targoff xlv_targoff_u.xlvu_targoff |
545 | ||
d361b004 KW |
546 | struct xpvinvlist { |
547 | _XPV_HEAD; | |
548 | IV prev_index; | |
549 | STRLEN iterator; | |
d361b004 KW |
550 | bool is_offset; /* */ |
551 | }; | |
552 | ||
cecf5685 NC |
553 | /* This structure works in 3 ways - regular scalar, GV with GP, or fast |
554 | Boyer-Moore. */ | |
79072805 | 555 | struct xpvgv { |
20f4945e | 556 | _XPV_HEAD; |
6e128786 NC |
557 | union _xivu xiv_u; |
558 | union _xnvu xnv_u; | |
79072805 LW |
559 | }; |
560 | ||
51c78f1b | 561 | typedef U32 cv_flags_t; |
77a005ab | 562 | |
20f4945e MHM |
563 | #define _XPVCV_COMMON \ |
564 | HV * xcv_stash; \ | |
565 | union { \ | |
566 | OP * xcv_start; \ | |
567 | ANY xcv_xsubany; \ | |
568 | } xcv_start_u; \ | |
569 | union { \ | |
570 | OP * xcv_root; \ | |
571 | void (*xcv_xsub) (pTHX_ CV*); \ | |
572 | } xcv_root_u; \ | |
b290562e FC |
573 | union { \ |
574 | GV * xcv_gv; \ | |
575 | HEK * xcv_hek; \ | |
576 | } xcv_gv_u; \ | |
20f4945e | 577 | char * xcv_file; \ |
b70d5558 | 578 | PADLIST * xcv_padlist; \ |
20f4945e MHM |
579 | CV * xcv_outside; \ |
580 | U32 xcv_outside_seq; /* the COP sequence (at the point of our \ | |
581 | * compilation) in the lexically enclosing \ | |
582 | * sub */ \ | |
8de47657 FC |
583 | cv_flags_t xcv_flags; \ |
584 | I32 xcv_depth /* >= 2 indicates recursive call */ | |
8990e307 | 585 | |
0d856a3a FC |
586 | /* This structure must match XPVCV in cv.h */ |
587 | ||
20f4945e MHM |
588 | struct xpvfm { |
589 | _XPV_HEAD; | |
20f4945e | 590 | _XPVCV_COMMON; |
79072805 LW |
591 | }; |
592 | ||
167f2c4d | 593 | |
8990e307 | 594 | struct xpvio { |
20f4945e | 595 | _XPV_HEAD; |
6e128786 | 596 | union _xivu xiv_u; |
6f7e8353 NC |
597 | /* ifp and ofp are normally the same, but sockets need separate streams */ |
598 | PerlIO * xio_ofp; | |
c951e2ad NC |
599 | /* Cray addresses everything by word boundaries (64 bits) and |
600 | * code and data pointers cannot be mixed (which is exactly what | |
601 | * Perl_filter_add() tries to do with the dirp), hence the | |
602 | * following union trick (as suggested by Gurusamy Sarathy). | |
603 | * For further information see Geir Johansen's problem report | |
604 | * titled [ID 20000612.002] Perl problem on Cray system | |
605 | * The any pointer (known as IoANY()) will also be a good place | |
606 | * to hang any IO disciplines to. | |
607 | */ | |
608 | union { | |
609 | DIR * xiou_dirp; /* for opendir, readdir, etc */ | |
610 | void * xiou_any; /* for alignment */ | |
611 | } xio_dirpu; | |
612 | /* IV xio_lines is now in IVX $. */ | |
613 | IV xio_page; /* $% */ | |
614 | IV xio_page_len; /* $= */ | |
615 | IV xio_lines_left; /* $- */ | |
616 | char * xio_top_name; /* $^ */ | |
617 | GV * xio_top_gv; /* $^ */ | |
618 | char * xio_fmt_name; /* $~ */ | |
619 | GV * xio_fmt_gv; /* $~ */ | |
620 | char * xio_bottom_name;/* $^B */ | |
621 | GV * xio_bottom_gv; /* $^B */ | |
622 | char xio_type; | |
623 | U8 xio_flags; | |
8990e307 | 624 | }; |
167f2c4d | 625 | |
4755096e GS |
626 | #define xio_dirp xio_dirpu.xiou_dirp |
627 | #define xio_any xio_dirpu.xiou_any | |
8990e307 | 628 | |
e0c19803 GS |
629 | #define IOf_ARGV 1 /* this fp iterates over ARGV */ |
630 | #define IOf_START 2 /* check for null ARGV and substitute '-' */ | |
631 | #define IOf_FLUSH 4 /* this fp wants a flush after write op */ | |
632 | #define IOf_DIDTOP 8 /* just did top of form */ | |
633 | #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */ | |
634 | #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */ | |
5bb89d25 NC |
635 | #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) |
636 | Also, when this is set, SvPVX() is valid */ | |
8990e307 | 637 | |
ed6116ce LW |
638 | /* The following macros define implementation-independent predicates on SVs. */ |
639 | ||
954c1994 | 640 | /* |
fbf9f983 RGS |
641 | =for apidoc Am|U32|SvNIOK|SV* sv |
642 | Returns a U32 value indicating whether the SV contains a number, integer or | |
954c1994 GS |
643 | double. |
644 | ||
fbf9f983 RGS |
645 | =for apidoc Am|U32|SvNIOKp|SV* sv |
646 | Returns a U32 value indicating whether the SV contains a number, integer or | |
fe749c9a | 647 | double. Checks the B<private> setting. Use C<SvNIOK> instead. |
954c1994 GS |
648 | |
649 | =for apidoc Am|void|SvNIOK_off|SV* sv | |
650 | Unsets the NV/IV status of an SV. | |
651 | ||
fbf9f983 | 652 | =for apidoc Am|U32|SvOK|SV* sv |
72d33970 | 653 | Returns a U32 value indicating whether the value is defined. This is |
c0b6140e | 654 | only meaningful for scalars. |
954c1994 | 655 | |
fbf9f983 RGS |
656 | =for apidoc Am|U32|SvIOKp|SV* sv |
657 | Returns a U32 value indicating whether the SV contains an integer. Checks | |
fe749c9a | 658 | the B<private> setting. Use C<SvIOK> instead. |
954c1994 | 659 | |
fbf9f983 RGS |
660 | =for apidoc Am|U32|SvNOKp|SV* sv |
661 | Returns a U32 value indicating whether the SV contains a double. Checks the | |
fe749c9a | 662 | B<private> setting. Use C<SvNOK> instead. |
954c1994 | 663 | |
fbf9f983 RGS |
664 | =for apidoc Am|U32|SvPOKp|SV* sv |
665 | Returns a U32 value indicating whether the SV contains a character string. | |
fe749c9a | 666 | Checks the B<private> setting. Use C<SvPOK> instead. |
954c1994 | 667 | |
fbf9f983 RGS |
668 | =for apidoc Am|U32|SvIOK|SV* sv |
669 | Returns a U32 value indicating whether the SV contains an integer. | |
954c1994 GS |
670 | |
671 | =for apidoc Am|void|SvIOK_on|SV* sv | |
672 | Tells an SV that it is an integer. | |
673 | ||
674 | =for apidoc Am|void|SvIOK_off|SV* sv | |
675 | Unsets the IV status of an SV. | |
676 | ||
677 | =for apidoc Am|void|SvIOK_only|SV* sv | |
678 | Tells an SV that it is an integer and disables all other OK bits. | |
679 | ||
e331fc52 | 680 | =for apidoc Am|void|SvIOK_only_UV|SV* sv |
feba1f01 | 681 | Tells an SV that it is an unsigned integer and disables all other OK bits. |
e331fc52 | 682 | |
12fa07df | 683 | =for apidoc Am|bool|SvIOK_UV|SV* sv |
a6ceea06 KW |
684 | Returns a boolean indicating whether the SV contains an integer that must be |
685 | interpreted as unsigned. A non-negative integer whose value is within the | |
686 | range of both an IV and a UV may be be flagged as either SvUOK or SVIOK. | |
e331fc52 | 687 | |
fbf9f983 | 688 | =for apidoc Am|bool|SvUOK|SV* sv |
a6ceea06 KW |
689 | Returns a boolean indicating whether the SV contains an integer that must be |
690 | interpreted as unsigned. A non-negative integer whose value is within the | |
691 | range of both an IV and a UV may be be flagged as either SvUOK or SVIOK. | |
28e5dec8 | 692 | |
12fa07df | 693 | =for apidoc Am|bool|SvIOK_notUV|SV* sv |
d1be9408 | 694 | Returns a boolean indicating whether the SV contains a signed integer. |
e331fc52 | 695 | |
fbf9f983 RGS |
696 | =for apidoc Am|U32|SvNOK|SV* sv |
697 | Returns a U32 value indicating whether the SV contains a double. | |
954c1994 GS |
698 | |
699 | =for apidoc Am|void|SvNOK_on|SV* sv | |
700 | Tells an SV that it is a double. | |
701 | ||
702 | =for apidoc Am|void|SvNOK_off|SV* sv | |
703 | Unsets the NV status of an SV. | |
704 | ||
705 | =for apidoc Am|void|SvNOK_only|SV* sv | |
706 | Tells an SV that it is a double and disables all other OK bits. | |
707 | ||
fbf9f983 RGS |
708 | =for apidoc Am|U32|SvPOK|SV* sv |
709 | Returns a U32 value indicating whether the SV contains a character | |
954c1994 GS |
710 | string. |
711 | ||
712 | =for apidoc Am|void|SvPOK_on|SV* sv | |
713 | Tells an SV that it is a string. | |
714 | ||
715 | =for apidoc Am|void|SvPOK_off|SV* sv | |
716 | Unsets the PV status of an SV. | |
717 | ||
718 | =for apidoc Am|void|SvPOK_only|SV* sv | |
719 | Tells an SV that it is a string and disables all other OK bits. | |
1e54db1a | 720 | Will also turn off the UTF-8 status. |
954c1994 | 721 | |
b0f01acb JP |
722 | =for apidoc Am|bool|SvVOK|SV* sv |
723 | Returns a boolean indicating whether the SV contains a v-string. | |
724 | ||
fbf9f983 | 725 | =for apidoc Am|U32|SvOOK|SV* sv |
69240efd NC |
726 | Returns a U32 indicating whether the pointer to the string buffer is offset. |
727 | This hack is used internally to speed up removal of characters from the | |
728 | beginning of a SvPV. When SvOOK is true, then the start of the | |
729 | allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX. | |
730 | This offset used to be stored in SvIVX, but is now stored within the spare | |
731 | part of the buffer. | |
954c1994 | 732 | |
fbf9f983 | 733 | =for apidoc Am|U32|SvROK|SV* sv |
954c1994 GS |
734 | Tests if the SV is an RV. |
735 | ||
736 | =for apidoc Am|void|SvROK_on|SV* sv | |
737 | Tells an SV that it is an RV. | |
738 | ||
739 | =for apidoc Am|void|SvROK_off|SV* sv | |
740 | Unsets the RV status of an SV. | |
741 | ||
742 | =for apidoc Am|SV*|SvRV|SV* sv | |
743 | Dereferences an RV to return the SV. | |
744 | ||
745 | =for apidoc Am|IV|SvIVX|SV* sv | |
645c22ef | 746 | Returns the raw value in the SV's IV slot, without checks or conversions. |
8554e7a0 | 747 | Only use when you are sure SvIOK is true. See also C<SvIV()>. |
954c1994 GS |
748 | |
749 | =for apidoc Am|UV|SvUVX|SV* sv | |
645c22ef | 750 | Returns the raw value in the SV's UV slot, without checks or conversions. |
8554e7a0 | 751 | Only use when you are sure SvIOK is true. See also C<SvUV()>. |
954c1994 GS |
752 | |
753 | =for apidoc Am|NV|SvNVX|SV* sv | |
645c22ef | 754 | Returns the raw value in the SV's NV slot, without checks or conversions. |
8554e7a0 | 755 | Only use when you are sure SvNOK is true. See also C<SvNV()>. |
954c1994 GS |
756 | |
757 | =for apidoc Am|char*|SvPVX|SV* sv | |
645c22ef | 758 | Returns a pointer to the physical string in the SV. The SV must contain a |
72d33970 FC |
759 | string. Prior to 5.9.3 it is not safe |
760 | to execute this macro unless the SV's | |
f615be48 | 761 | type >= SVt_PV. |
954c1994 | 762 | |
5b36e945 FC |
763 | This is also used to store the name of an autoloaded subroutine in an XS |
764 | AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>. | |
89fc9e2a | 765 | |
954c1994 GS |
766 | =for apidoc Am|STRLEN|SvCUR|SV* sv |
767 | Returns the length of the string which is in the SV. See C<SvLEN>. | |
768 | ||
769 | =for apidoc Am|STRLEN|SvLEN|SV* sv | |
659239a4 MG |
770 | Returns the size of the string buffer in the SV, not including any part |
771 | attributable to C<SvOOK>. See C<SvCUR>. | |
954c1994 GS |
772 | |
773 | =for apidoc Am|char*|SvEND|SV* sv | |
f990ea3e FC |
774 | Returns a pointer to the spot just after the last character in |
775 | the string which is in the SV, where there is usually a trailing | |
417b32ce | 776 | C<NUL> character (even though Perl scalars do not strictly require it). |
954c1994 GS |
777 | See C<SvCUR>. Access the character as *(SvEND(sv)). |
778 | ||
f990ea3e FC |
779 | Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to |
780 | unallocated memory. | |
781 | ||
954c1994 GS |
782 | =for apidoc Am|HV*|SvSTASH|SV* sv |
783 | Returns the stash of the SV. | |
784 | ||
672994ce | 785 | =for apidoc Am|void|SvIV_set|SV* sv|IV val |
20799e15 SP |
786 | Set the value of the IV pointer in sv to val. It is possible to perform |
787 | the same function of this macro with an lvalue assignment to C<SvIVX>. | |
788 | With future Perls, however, it will be more efficient to use | |
789 | C<SvIV_set> instead of the lvalue assignment to C<SvIVX>. | |
672994ce SP |
790 | |
791 | =for apidoc Am|void|SvNV_set|SV* sv|NV val | |
20799e15 | 792 | Set the value of the NV pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
793 | |
794 | =for apidoc Am|void|SvPV_set|SV* sv|char* val | |
417b32ce KW |
795 | Set the value of the PV pointer in C<sv> to the C<NUL>-terminated string |
796 | C<val>. See also C<SvIV_set>. | |
235fc044 FC |
797 | |
798 | Beware that the existing pointer may be involved in copy-on-write or other | |
799 | mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or | |
800 | C<SvPV_force> (or check the SvIsCOW flag) first to make sure this | |
801 | modification is safe. | |
672994ce SP |
802 | |
803 | =for apidoc Am|void|SvUV_set|SV* sv|UV val | |
20799e15 | 804 | Set the value of the UV pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
805 | |
806 | =for apidoc Am|void|SvRV_set|SV* sv|SV* val | |
20799e15 | 807 | Set the value of the RV pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
808 | |
809 | =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val | |
20799e15 | 810 | Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>. |
672994ce | 811 | |
b6f4de24 | 812 | =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val |
20799e15 | 813 | Set the value of the STASH pointer in sv to val. See C<SvIV_set>. |
672994ce | 814 | |
954c1994 | 815 | =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len |
20799e15 SP |
816 | Set the current length of the string which is in the SV. See C<SvCUR> |
817 | and C<SvIV_set>. | |
672994ce SP |
818 | |
819 | =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len | |
20799e15 | 820 | Set the actual length of the string which is in the SV. See C<SvIV_set>. |
954c1994 GS |
821 | |
822 | =cut | |
823 | */ | |
824 | ||
79072805 | 825 | #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK)) |
748a9306 | 826 | #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK)) |
a0d0e21e | 827 | #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \ |
25da4f38 | 828 | SVp_IOK|SVp_NOK|SVf_IVisUV)) |
79072805 | 829 | |
c7724415 FC |
830 | #define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv)) |
831 | #define assert_not_glob(sv) assert_(!isGV_with_GP(sv)) | |
906ed6d6 | 832 | |
3f2ee99a | 833 | #define SvOK(sv) (SvFLAGS(sv) & SVf_OK || isREGEXP(sv)) |
f7877b28 | 834 | #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \ |
dd2eae66 | 835 | SvFLAGS(sv) &= ~(SVf_OK| \ |
d41ff1b8 | 836 | SVf_IVisUV|SVf_UTF8), \ |
25da4f38 | 837 | SvOOK_off(sv)) |
54866b45 | 838 | #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \ |
dd2eae66 | 839 | SvFLAGS(sv) &= ~(SVf_OK| \ |
d41ff1b8 | 840 | SVf_UTF8), \ |
a0d0e21e | 841 | SvOOK_off(sv)) |
79072805 | 842 | |
8990e307 LW |
843 | #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) |
844 | #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK) | |
7a4bba22 | 845 | #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \ |
765f542d | 846 | SvFLAGS(sv) |= SVp_IOK) |
8990e307 | 847 | #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK) |
f7877b28 | 848 | #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK) |
8990e307 | 849 | #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK) |
f7877b28 | 850 | #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \ |
906ed6d6 | 851 | SvFLAGS(sv) |= SVp_POK) |
463ee0b2 | 852 | |
79072805 | 853 | #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK) |
7a4bba22 | 854 | #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \ |
765f542d | 855 | SvFLAGS(sv) |= (SVf_IOK|SVp_IOK)) |
25da4f38 | 856 | #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV)) |
0c34ef67 | 857 | #define SvIOK_only(sv) (SvOK_off(sv), \ |
a0d0e21e | 858 | SvFLAGS(sv) |= (SVf_IOK|SVp_IOK)) |
f7877b28 | 859 | #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \ |
25da4f38 | 860 | SvFLAGS(sv) |= (SVf_IOK|SVp_IOK)) |
70401c6b | 861 | |
25da4f38 IZ |
862 | #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \ |
863 | == (SVf_IOK|SVf_IVisUV)) | |
28e5dec8 | 864 | #define SvUOK(sv) SvIOK_UV(sv) |
25da4f38 IZ |
865 | #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \ |
866 | == SVf_IOK) | |
867 | ||
868 | #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV) | |
869 | #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV) | |
870 | #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV) | |
79072805 LW |
871 | |
872 | #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK) | |
f7877b28 NC |
873 | #define SvNOK_on(sv) (assert_not_glob(sv) \ |
874 | SvFLAGS(sv) |= (SVf_NOK|SVp_NOK)) | |
8990e307 | 875 | #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK)) |
0c34ef67 | 876 | #define SvNOK_only(sv) (SvOK_off(sv), \ |
a0d0e21e | 877 | SvFLAGS(sv) |= (SVf_NOK|SVp_NOK)) |
79072805 | 878 | |
914184e1 | 879 | /* |
fbf9f983 | 880 | =for apidoc Am|U32|SvUTF8|SV* sv |
3c813ed0 KW |
881 | Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up |
882 | properly, this indicates whether or not the SV contains UTF-8 encoded data. | |
fd142383 DM |
883 | You should use this I<after> a call to SvPV() or one of its variants, in |
884 | case any call to string overloading updates the internal flag. | |
914184e1 JH |
885 | |
886 | =for apidoc Am|void|SvUTF8_on|SV *sv | |
1e54db1a | 887 | Turn on the UTF-8 status of an SV (the data is not changed, just the flag). |
d5ce4a7c | 888 | Do not use frivolously. |
914184e1 JH |
889 | |
890 | =for apidoc Am|void|SvUTF8_off|SV *sv | |
3c813ed0 KW |
891 | Unsets the UTF-8 status of an SV (the data is not changed, just the flag). |
892 | Do not use frivolously. | |
914184e1 JH |
893 | |
894 | =for apidoc Am|void|SvPOK_only_UTF8|SV* sv | |
d5ce4a7c | 895 | Tells an SV that it is a string and disables all other OK bits, |
1e54db1a | 896 | and leaves the UTF-8 status as it was. |
f1a1024e | 897 | |
914184e1 JH |
898 | =cut |
899 | */ | |
900 | ||
7a5fd60d NC |
901 | /* Ensure the return value of this macro does not clash with the GV_ADD* flags |
902 | in gv.h: */ | |
a7cb1f99 GS |
903 | #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8) |
904 | #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8)) | |
905 | #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8)) | |
5bc28da9 | 906 | |
79072805 | 907 | #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK) |
f7877b28 | 908 | #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \ |
906ed6d6 | 909 | SvFLAGS(sv) |= (SVf_POK|SVp_POK)) |
8990e307 | 910 | #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK)) |
f7877b28 | 911 | #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \ |
dd2eae66 | 912 | SvFLAGS(sv) &= ~(SVf_OK| \ |
d41ff1b8 GS |
913 | SVf_IVisUV|SVf_UTF8), \ |
914 | SvFLAGS(sv) |= (SVf_POK|SVp_POK)) | |
f7877b28 | 915 | #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \ |
dd2eae66 | 916 | SvFLAGS(sv) &= ~(SVf_OK| \ |
d41ff1b8 | 917 | SVf_IVisUV), \ |
a0d0e21e | 918 | SvFLAGS(sv) |= (SVf_POK|SVp_POK)) |
79072805 | 919 | |
4f2da183 | 920 | #define SvVOK(sv) (SvMAGICAL(sv) \ |
b0a11fe1 RGS |
921 | && mg_find(sv,PERL_MAGIC_vstring)) |
922 | /* returns the vstring magic, if any */ | |
923 | #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \ | |
4f2da183 | 924 | ? mg_find(sv,PERL_MAGIC_vstring) : NULL) |
b0a11fe1 | 925 | |
79072805 | 926 | #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK) |
a4f658f7 | 927 | #define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK) |
0c34ef67 | 928 | #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv))) |
79072805 | 929 | |
a0d0e21e LW |
930 | #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE) |
931 | #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE) | |
932 | #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE) | |
933 | ||
ed6116ce | 934 | #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK) |
a0d0e21e | 935 | #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK) |
dd2eae66 | 936 | #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK)) |
79072805 | 937 | |
8990e307 LW |
938 | #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG)) |
939 | #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG)) | |
940 | #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG)) | |
79072805 | 941 | |
8990e307 LW |
942 | #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG) |
943 | #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG) | |
944 | #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG) | |
ed6116ce | 945 | |
8990e307 LW |
946 | #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG) |
947 | #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG) | |
948 | #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG) | |
ed6116ce | 949 | |
8990e307 LW |
950 | #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG) |
951 | #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG) | |
952 | #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG) | |
ed6116ce | 953 | |
a1cd65be | 954 | #define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \ |
54c554f3 | 955 | HvAMAGIC(SvSTASH(SvRV(sv)))) |
a0d0e21e | 956 | |
0adc25b0 FC |
957 | /* To be used on the stashes themselves: */ |
958 | #define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC) | |
959 | #define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC) | |
960 | #define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC) | |
961 | ||
4bac9ae4 | 962 | |
1078c6a2 | 963 | /* "nog" means "doesn't have get magic" */ |
4bac9ae4 CS |
964 | #define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK) |
965 | #define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK) | |
966 | #define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV)) | |
967 | #define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK) | |
968 | #define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG)) | |
969 | ||
970 | #define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK) | |
971 | #define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK) | |
972 | #define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV)) | |
973 | #define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK) | |
974 | #define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG))) | |
975 | ||
976 | #define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8)) | |
977 | #define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8)) | |
978 | ||
979 | #define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK) | |
980 | #define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK) | |
981 | ||
8bb025ae CS |
982 | #define SvPOK_pure_nogthink(sv) \ |
983 | ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK) | |
984 | #define SvPOK_utf8_pure_nogthink(sv) \ | |
985 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8)) | |
986 | #define SvPOK_byte_pure_nogthink(sv) \ | |
987 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK) | |
988 | ||
d34786ba | 989 | /* |
458b44e7 | 990 | =for apidoc Am|U32|SvGAMAGIC|SV* sv |
d34786ba | 991 | |
8554e7a0 FC |
992 | Returns true if the SV has get magic or |
993 | overloading. If either is true then | |
d34786ba | 994 | the scalar is active data, and has the potential to return a new value every |
8554e7a0 FC |
995 | time it is accessed. Hence you must be careful to |
996 | only read it once per user logical operation and work | |
997 | with that returned value. If neither is true then | |
d34786ba NC |
998 | the scalar's value cannot change unless written to. |
999 | ||
1000 | =cut | |
1001 | */ | |
1002 | ||
dd2eae66 | 1003 | #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv)) |
1426bbf4 | 1004 | |
9299023c | 1005 | #define Gv_AMG(stash) \ |
d3c7a87b FC |
1006 | (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \ |
1007 | ? 1 \ | |
1008 | : (HvAMAGIC_off(stash), 0)) | |
a0d0e21e | 1009 | |
810b8aa5 GS |
1010 | #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \ |
1011 | == (SVf_ROK|SVprv_WEAKREF)) | |
1012 | #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF)) | |
1013 | #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF)) | |
1014 | ||
1ccdb730 NC |
1015 | #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \ |
1016 | == (SVf_ROK|SVprv_PCS_IMPORTED)) | |
1017 | #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED)) | |
1018 | #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED)) | |
1019 | ||
a11eaecb FC |
1020 | /* |
1021 | =for apidoc m|U32|SvTHINKFIRST|SV *sv | |
1022 | ||
1023 | A quick flag check to see whether an sv should be passed to sv_force_normal | |
1024 | to be "downgraded" before SvIVX or SvPVX can be modified directly. | |
1025 | ||
1026 | For example, if your scalar is a reference and you want to modify the SvIVX | |
1027 | slot, you can't just do SvROK_off, as that will leak the referent. | |
1028 | ||
1029 | This is used internally by various sv-modifying functions, such as | |
1030 | sv_setsv, sv_setiv and sv_pvn_force. | |
1031 | ||
1032 | One case that this does not handle is a gv without SvFAKE set. After | |
1033 | ||
1034 | if (SvTHINKFIRST(gv)) sv_force_normal(gv); | |
1035 | ||
1036 | it will still be a gv. | |
1037 | ||
1038 | SvTHINKFIRST sometimes produces false positives. In those cases | |
1039 | sv_force_normal does nothing. | |
1040 | ||
1041 | =cut | |
1042 | */ | |
1043 | ||
a0d0e21e | 1044 | #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST) |
ed6116ce | 1045 | |
9a214eec DM |
1046 | #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY) |
1047 | #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY) | |
d9d18af6 | 1048 | |
9a214eec | 1049 | /* SVs_PADTMP and SVs_PADSTALE share the same bit, mediated by SVs_PADMY */ |
ed6116ce | 1050 | |
9a214eec DM |
1051 | #define SvPADTMP(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP)) == SVs_PADTMP) |
1052 | #define SvPADSTALE(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADSTALE)) \ | |
1053 | == (SVs_PADMY|SVs_PADSTALE)) | |
62bb6514 | 1054 | |
541377b1 FC |
1055 | #define SvPADTMP_on(sv) S_SvPADTMP_on(MUTABLE_SV(sv)) |
1056 | #define SvPADTMP_off(sv) S_SvPADTMP_off(MUTABLE_SV(sv)) | |
1057 | #define SvPADSTALE_on(sv) S_SvPADSTALE_on(MUTABLE_SV(sv)) | |
1058 | #define SvPADSTALE_off(sv) S_SvPADSTALE_off(MUTABLE_SV(sv)) | |
ed6116ce | 1059 | |
8990e307 LW |
1060 | #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP) |
1061 | #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP) | |
1062 | #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP) | |
79072805 | 1063 | |
8990e307 LW |
1064 | #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT) |
1065 | #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT) | |
1066 | #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT) | |
79072805 | 1067 | |
8990e307 LW |
1068 | #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY) |
1069 | #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY) | |
1070 | #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY) | |
79072805 | 1071 | |
180488f8 | 1072 | #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK)) |
8990e307 LW |
1073 | #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM) |
1074 | #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM) | |
79072805 | 1075 | |
74e0ddf7 NC |
1076 | #ifndef PERL_CORE |
1077 | # define SvCOMPILED(sv) 0 | |
1078 | # define SvCOMPILED_on(sv) | |
1079 | # define SvCOMPILED_off(sv) | |
1080 | #endif | |
79072805 | 1081 | |
25da4f38 IZ |
1082 | #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL) |
1083 | #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL) | |
1084 | #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL) | |
1085 | ||
85efc3a5 | 1086 | #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) |
e9726144 | 1087 | # define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \ |
654c0d3f | 1088 | if (SvFLAGS(_svvalid) & SVpbm_VALID && !SvSCREAM(_svvalid)) \ |
e5ae200f RU |
1089 | assert(!isGV_with_GP(_svvalid)); \ |
1090 | (SvFLAGS(_svvalid) & SVpbm_VALID); \ | |
85ffbbb0 | 1091 | }) |
b1bc3f34 | 1092 | # define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \ |
e5ae200f | 1093 | assert(!isGV_with_GP(_svvalid)); \ |
654c0d3f | 1094 | assert(!SvSCREAM(_svvalid)); \ |
e5ae200f | 1095 | (SvFLAGS(_svvalid) |= SVpbm_VALID); \ |
85ffbbb0 | 1096 | }) |
b1bc3f34 | 1097 | # define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \ |
e5ae200f | 1098 | assert(!isGV_with_GP(_svvalid)); \ |
654c0d3f | 1099 | assert(!SvSCREAM(_svvalid)); \ |
e5ae200f | 1100 | (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \ |
85ffbbb0 NC |
1101 | }) |
1102 | ||
e9726144 | 1103 | # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \ |
654c0d3f RU |
1104 | assert(SvTYPE(_svtail) != SVt_PVAV); \ |
1105 | assert(SvTYPE(_svtail) != SVt_PVHV); \ | |
1106 | assert(!SvSCREAM(_svtail)); \ | |
78d0cf80 NC |
1107 | (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \ |
1108 | == (SVpbm_TAIL|SVpbm_VALID); \ | |
85efc3a5 NC |
1109 | }) |
1110 | #else | |
654c0d3f | 1111 | # define SvVALID(sv) ((SvFLAGS(sv) & SVpbm_VALID) && !SvSCREAM(sv)) |
85ffbbb0 NC |
1112 | # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID) |
1113 | # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID) | |
78d0cf80 | 1114 | # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \ |
fe901688 | 1115 | == (SVpbm_TAIL|SVpbm_VALID)) |
78d0cf80 | 1116 | |
85efc3a5 | 1117 | #endif |
8990e307 LW |
1118 | #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL) |
1119 | #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL) | |
1120 | ||
8990e307 | 1121 | |
075bae1e NC |
1122 | #define SvPAD_TYPED(sv) \ |
1123 | ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED)) | |
00b1698f | 1124 | |
075bae1e NC |
1125 | #define SvPAD_OUR(sv) \ |
1126 | ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR)) | |
00b1698f | 1127 | |
952306ac RGS |
1128 | #define SvPAD_STATE(sv) \ |
1129 | ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE)) | |
a72e56b0 NC |
1130 | |
1131 | #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) | |
1132 | # define SvPAD_TYPED_on(sv) ({ \ | |
b1bc3f34 | 1133 | SV *const _svpad = MUTABLE_SV(sv); \ |
e5ae200f RU |
1134 | assert(SvTYPE(_svpad) == SVt_PVMG); \ |
1135 | (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \ | |
a72e56b0 NC |
1136 | }) |
1137 | #define SvPAD_OUR_on(sv) ({ \ | |
b1bc3f34 | 1138 | SV *const _svpad = MUTABLE_SV(sv); \ |
e5ae200f RU |
1139 | assert(SvTYPE(_svpad) == SVt_PVMG); \ |
1140 | (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \ | |
a72e56b0 NC |
1141 | }) |
1142 | #define SvPAD_STATE_on(sv) ({ \ | |
b1bc3f34 | 1143 | SV *const _svpad = MUTABLE_SV(sv); \ |
e5ae200f RU |
1144 | assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \ |
1145 | (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \ | |
a72e56b0 NC |
1146 | }) |
1147 | #else | |
1148 | # define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED) | |
1149 | # define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR) | |
1150 | # define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE) | |
1151 | #endif | |
952306ac | 1152 | |
73d95100 | 1153 | #define SvOURSTASH(sv) \ |
e736a858 | 1154 | (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL) |
73d95100 | 1155 | #define SvOURSTASH_set(sv, st) \ |
e736a858 | 1156 | STMT_START { \ |
2892acdb | 1157 | assert(SvTYPE(sv) == SVt_PVMG); \ |
e736a858 | 1158 | ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \ |
035dab74 NC |
1159 | } STMT_END |
1160 | ||
ed6116ce LW |
1161 | #define SvRVx(sv) SvRV(sv) |
1162 | ||
f599b64b | 1163 | #ifdef PERL_DEBUG_COW |
8ed30cc1 DD |
1164 | /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because |
1165 | +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */ | |
771ba71a NC |
1166 | # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv) |
1167 | # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv) | |
58430790 | 1168 | # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv) |
ac09da3b | 1169 | # define SvRV(sv) (0 + (sv)->sv_u.svu_rv) |
f19a12a3 | 1170 | # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv) |
c0e1089a | 1171 | /* Don't test the core XS code yet. */ |
771ba71a | 1172 | # if defined (PERL_CORE) && PERL_DEBUG_COW > 1 |
c7724415 | 1173 | # define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv)) |
771ba71a NC |
1174 | # else |
1175 | # define SvPVX(sv) SvPVX_mutable(sv) | |
1176 | # endif | |
771ba71a NC |
1177 | # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur) |
1178 | # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len) | |
1179 | # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur) | |
1180 | ||
c7724415 FC |
1181 | # define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)) |
1182 | # define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash)) | |
f599b64b | 1183 | #else |
771ba71a NC |
1184 | # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len |
1185 | # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur) | |
1186 | ||
05ef5f8f NC |
1187 | # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) |
1188 | /* These get expanded inside other macros that already use a variable _sv */ | |
f7877b28 | 1189 | # define SvPVX(sv) \ |
d2c6dc5e | 1190 | (*({ SV *const _svpvx = MUTABLE_SV(sv); \ |
f1fb8741 | 1191 | assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \ |
e5ae200f | 1192 | assert(!isGV_with_GP(_svpvx)); \ |
5bb89d25 NC |
1193 | assert(!(SvTYPE(_svpvx) == SVt_PVIO \ |
1194 | && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \ | |
e5ae200f | 1195 | &((_svpvx)->sv_u.svu_pv); \ |
f7877b28 | 1196 | })) |
08002bbf | 1197 | # define SvCUR(sv) \ |
b1bc3f34 | 1198 | (*({ const SV *const _svcur = (const SV *)(sv); \ |
8d919b0a FC |
1199 | assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK] \ |
1200 | || SvTYPE(_svcur) == SVt_REGEXP); \ | |
e5ae200f | 1201 | assert(!isGV_with_GP(_svcur)); \ |
6f7e8353 NC |
1202 | assert(!(SvTYPE(_svcur) == SVt_PVIO \ |
1203 | && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \ | |
b1bc3f34 | 1204 | &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \ |
08002bbf | 1205 | })) |
05ef5f8f | 1206 | # define SvIVX(sv) \ |
b1bc3f34 | 1207 | (*({ const SV *const _svivx = (const SV *)(sv); \ |
f1fb8741 | 1208 | assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \ |
e5ae200f | 1209 | assert(!isGV_with_GP(_svivx)); \ |
b1bc3f34 | 1210 | &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \ |
05ef5f8f NC |
1211 | })) |
1212 | # define SvUVX(sv) \ | |
b1bc3f34 | 1213 | (*({ const SV *const _svuvx = (const SV *)(sv); \ |
f1fb8741 | 1214 | assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \ |
e5ae200f | 1215 | assert(!isGV_with_GP(_svuvx)); \ |
b1bc3f34 | 1216 | &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \ |
05ef5f8f NC |
1217 | })) |
1218 | # define SvNVX(sv) \ | |
b1bc3f34 | 1219 | (*({ const SV *const _svnvx = (const SV *)(sv); \ |
f1fb8741 | 1220 | assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \ |
e5ae200f | 1221 | assert(!isGV_with_GP(_svnvx)); \ |
b1bc3f34 | 1222 | &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \ |
05ef5f8f | 1223 | })) |
ac09da3b | 1224 | # define SvRV(sv) \ |
f19a12a3 | 1225 | (*({ SV *const _svrv = MUTABLE_SV(sv); \ |
f1fb8741 | 1226 | assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \ |
e5ae200f | 1227 | assert(!isGV_with_GP(_svrv)); \ |
6f7e8353 NC |
1228 | assert(!(SvTYPE(_svrv) == SVt_PVIO \ |
1229 | && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \ | |
e5ae200f | 1230 | &((_svrv)->sv_u.svu_rv); \ |
ac09da3b | 1231 | })) |
f19a12a3 MHM |
1232 | # define SvRV_const(sv) \ |
1233 | ({ const SV *const _svrv = (const SV *)(sv); \ | |
f1fb8741 | 1234 | assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \ |
f19a12a3 | 1235 | assert(!isGV_with_GP(_svrv)); \ |
6f7e8353 NC |
1236 | assert(!(SvTYPE(_svrv) == SVt_PVIO \ |
1237 | && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \ | |
f19a12a3 MHM |
1238 | (_svrv)->sv_u.svu_rv; \ |
1239 | }) | |
05ef5f8f | 1240 | # define SvMAGIC(sv) \ |
b1bc3f34 | 1241 | (*({ const SV *const _svmagic = (const SV *)(sv); \ |
e5ae200f RU |
1242 | assert(SvTYPE(_svmagic) >= SVt_PVMG); \ |
1243 | if(SvTYPE(_svmagic) == SVt_PVMG) \ | |
1244 | assert(!SvPAD_OUR(_svmagic)); \ | |
b1bc3f34 | 1245 | &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \ |
05ef5f8f NC |
1246 | })) |
1247 | # define SvSTASH(sv) \ | |
b1bc3f34 | 1248 | (*({ const SV *const _svstash = (const SV *)(sv); \ |
e5ae200f | 1249 | assert(SvTYPE(_svstash) >= SVt_PVMG); \ |
b1bc3f34 | 1250 | &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \ |
05ef5f8f | 1251 | })) |
03687789 | 1252 | # else |
08002bbf NC |
1253 | # define SvPVX(sv) ((sv)->sv_u.svu_pv) |
1254 | # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur | |
05ef5f8f NC |
1255 | # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv |
1256 | # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv | |
58430790 | 1257 | # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv |
ac09da3b | 1258 | # define SvRV(sv) ((sv)->sv_u.svu_rv) |
f19a12a3 | 1259 | # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv) |
e736a858 | 1260 | # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic |
771ba71a | 1261 | # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash |
03687789 | 1262 | # endif |
62703e72 NC |
1263 | #endif |
1264 | ||
06c0cc96 | 1265 | #ifndef PERL_POISON |
bb496845 SP |
1266 | /* Given that these two are new, there can't be any existing code using them |
1267 | * as LVALUEs */ | |
06c0cc96 NC |
1268 | # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv) |
1269 | # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv)) | |
1270 | #else | |
1271 | /* Except for the poison code, which uses & to scribble over the pointer after | |
1272 | free() is called. */ | |
1273 | # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv) | |
1274 | # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv)) | |
1275 | #endif | |
bb496845 | 1276 | |
62703e72 NC |
1277 | #define SvIVXx(sv) SvIVX(sv) |
1278 | #define SvUVXx(sv) SvUVX(sv) | |
1279 | #define SvNVXx(sv) SvNVX(sv) | |
1280 | #define SvPVXx(sv) SvPVX(sv) | |
1281 | #define SvLENx(sv) SvLEN(sv) | |
1282 | #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv)) | |
1283 | ||
1284 | ||
28e5dec8 JH |
1285 | /* Ask a scalar nicely to try to become an IV, if possible. |
1286 | Not guaranteed to stay returning void */ | |
1287 | /* Macro won't actually call sv_2iv if already IOK */ | |
1288 | #define SvIV_please(sv) \ | |
1289 | STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \ | |
1290 | (void) SvIV(sv); } STMT_END | |
6f1401dc | 1291 | #define SvIV_please_nomg(sv) \ |
01f91bf2 FC |
1292 | (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv)) \ |
1293 | ? (SvIV_nomg(sv), SvIOK(sv)) \ | |
8a68f328 | 1294 | : SvIOK(sv)) |
79072805 | 1295 | #define SvIV_set(sv, val) \ |
f1fb8741 DM |
1296 | STMT_START { \ |
1297 | assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \ | |
08002bbf | 1298 | assert(!isGV_with_GP(sv)); \ |
b19bbeda | 1299 | (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END |
79072805 | 1300 | #define SvNV_set(sv, val) \ |
f1fb8741 DM |
1301 | STMT_START { \ |
1302 | assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \ | |
08002bbf | 1303 | assert(!isGV_with_GP(sv)); \ |
58430790 | 1304 | (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END |
79072805 | 1305 | #define SvPV_set(sv, val) \ |
f1fb8741 DM |
1306 | STMT_START { \ |
1307 | assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \ | |
08002bbf | 1308 | assert(!isGV_with_GP(sv)); \ |
6f7e8353 NC |
1309 | assert(!(SvTYPE(sv) == SVt_PVIO \ |
1310 | && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \ | |
339049b0 | 1311 | ((sv)->sv_u.svu_pv = (val)); } STMT_END |
607fa7f2 | 1312 | #define SvUV_set(sv, val) \ |
f1fb8741 DM |
1313 | STMT_START { \ |
1314 | assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \ | |
08002bbf | 1315 | assert(!isGV_with_GP(sv)); \ |
607fa7f2 | 1316 | (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END |
b162af07 | 1317 | #define SvRV_set(sv, val) \ |
f1fb8741 DM |
1318 | STMT_START { \ |
1319 | assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \ | |
08002bbf | 1320 | assert(!isGV_with_GP(sv)); \ |
6f7e8353 NC |
1321 | assert(!(SvTYPE(sv) == SVt_PVIO \ |
1322 | && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \ | |
339049b0 | 1323 | ((sv)->sv_u.svu_rv = (val)); } STMT_END |
b162af07 SP |
1324 | #define SvMAGIC_set(sv, val) \ |
1325 | STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \ | |
e736a858 | 1326 | (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END |
b162af07 SP |
1327 | #define SvSTASH_set(sv, val) \ |
1328 | STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \ | |
1329 | (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END | |
79072805 | 1330 | #define SvCUR_set(sv, val) \ |
f1fb8741 | 1331 | STMT_START { \ |
8d919b0a FC |
1332 | assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK] \ |
1333 | || SvTYPE(sv) == SVt_REGEXP); \ | |
08002bbf | 1334 | assert(!isGV_with_GP(sv)); \ |
6f7e8353 NC |
1335 | assert(!(SvTYPE(sv) == SVt_PVIO \ |
1336 | && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \ | |
b162af07 | 1337 | (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END |
79072805 | 1338 | #define SvLEN_set(sv, val) \ |
f1fb8741 DM |
1339 | STMT_START { \ |
1340 | assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \ | |
f7877b28 | 1341 | assert(!isGV_with_GP(sv)); \ |
6f7e8353 NC |
1342 | assert(!(SvTYPE(sv) == SVt_PVIO \ |
1343 | && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \ | |
b162af07 | 1344 | (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END |
7ae8ee9e NC |
1345 | #define SvEND_set(sv, val) \ |
1346 | STMT_START { assert(SvTYPE(sv) >= SVt_PV); \ | |
3ec35e0f | 1347 | SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END |
79072805 | 1348 | |
b7e9a5c2 | 1349 | #define SvPV_renew(sv,n) \ |
1da4ca5f NC |
1350 | STMT_START { SvLEN_set(sv, n); \ |
1351 | SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \ | |
1352 | (char*)saferealloc((Malloc_t)SvPVX(sv), \ | |
1353 | (MEM_SIZE)((n))))); \ | |
1354 | } STMT_END | |
1355 | ||
1356 | #define SvPV_shrink_to_cur(sv) STMT_START { \ | |
1357 | const STRLEN _lEnGtH = SvCUR(sv) + 1; \ | |
1358 | SvPV_renew(sv, _lEnGtH); \ | |
1359 | } STMT_END | |
b7e9a5c2 | 1360 | |
771ba71a NC |
1361 | #define SvPV_free(sv) \ |
1362 | STMT_START { \ | |
1363 | assert(SvTYPE(sv) >= SVt_PV); \ | |
1364 | if (SvLEN(sv)) { \ | |
e537ac38 | 1365 | assert(!SvROK(sv)); \ |
5d9574c1 | 1366 | if(UNLIKELY(SvOOK(sv))) { \ |
69240efd NC |
1367 | STRLEN zok; \ |
1368 | SvOOK_offset(sv, zok); \ | |
1369 | SvPV_set(sv, SvPVX_mutable(sv) - zok); \ | |
771ba71a NC |
1370 | SvFLAGS(sv) &= ~SVf_OOK; \ |
1371 | } \ | |
1372 | Safefree(SvPVX(sv)); \ | |
1373 | } \ | |
1374 | } STMT_END | |
8bd4d4c5 | 1375 | |
43230e26 NC |
1376 | #ifdef PERL_CORE |
1377 | /* Code that crops up in three places to take a scalar and ready it to hold | |
1378 | a reference */ | |
1379 | # define prepare_SV_for_RV(sv) \ | |
1380 | STMT_START { \ | |
1381 | if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \ | |
1382 | sv_upgrade(sv, SVt_IV); \ | |
662f1f9e | 1383 | else if (SvTYPE(sv) >= SVt_PV) { \ |
43230e26 NC |
1384 | SvPV_free(sv); \ |
1385 | SvLEN_set(sv, 0); \ | |
1386 | SvCUR_set(sv, 0); \ | |
1387 | } \ | |
1388 | } STMT_END | |
1389 | #endif | |
373b357f | 1390 | |
cffe132d NC |
1391 | #ifndef PERL_CORE |
1392 | # define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0) | |
1393 | #endif | |
6976cee3 | 1394 | |
60c8298a | 1395 | #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) |
60c8298a | 1396 | # define BmUSEFUL(sv) \ |
b1bc3f34 | 1397 | (*({ SV *const _bmuseful = MUTABLE_SV(sv); \ |
408dc2ec | 1398 | assert(SvTYPE(_bmuseful) >= SVt_PVIV); \ |
e5ae200f | 1399 | assert(SvVALID(_bmuseful)); \ |
408dc2ec NC |
1400 | assert(!SvIOK(_bmuseful)); \ |
1401 | &(((XPVIV*) SvANY(_bmuseful))->xiv_u.xivu_iv); \ | |
8eeaf79a | 1402 | })) |
60c8298a | 1403 | #else |
50c7be83 | 1404 | # define BmUSEFUL(sv) ((XPVIV*) SvANY(sv))->xiv_u.xivu_iv |
b4f6c04b | 1405 | |
60c8298a | 1406 | #endif |
79072805 | 1407 | |
8922e438 FC |
1408 | #ifndef PERL_CORE |
1409 | # define BmRARE(sv) 0 | |
1410 | # define BmPREVIOUS(sv) 0 | |
1411 | #endif | |
1412 | ||
f2da823f | 1413 | #define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv |
79072805 LW |
1414 | |
1415 | #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type | |
1416 | #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ | |
1417 | #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff | |
bbfdc870 | 1418 | #define LvSTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff_u.xlvu_stargoff |
79072805 | 1419 | #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen |
83f78d1a | 1420 | #define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags |
79072805 | 1421 | |
6f7e8353 | 1422 | #define IoIFP(sv) (sv)->sv_u.svu_fp |
8990e307 LW |
1423 | #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp |
1424 | #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp | |
4755096e | 1425 | #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any |
c490b21c | 1426 | #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv |
8990e307 LW |
1427 | #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page |
1428 | #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len | |
1429 | #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left | |
1430 | #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name | |
1431 | #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv | |
1432 | #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name | |
1433 | #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv | |
1434 | #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name | |
1435 | #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv | |
8990e307 LW |
1436 | #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type |
1437 | #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags | |
1438 | ||
50952442 | 1439 | /* IoTYPE(sv) is a single character telling the type of I/O connection. */ |
3b6c1aba JH |
1440 | #define IoTYPE_RDONLY '<' |
1441 | #define IoTYPE_WRONLY '>' | |
1442 | #define IoTYPE_RDWR '+' | |
1443 | #define IoTYPE_APPEND 'a' | |
1444 | #define IoTYPE_PIPE '|' | |
1445 | #define IoTYPE_STD '-' /* stdin or stdout */ | |
1446 | #define IoTYPE_SOCKET 's' | |
1447 | #define IoTYPE_CLOSED ' ' | |
1448 | #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */ | |
1449 | #define IoTYPE_NUMERIC '#' /* fdopen */ | |
03fcf2fc GS |
1450 | |
1451 | /* | |
954c1994 | 1452 | =for apidoc Am|bool|SvTAINTED|SV* sv |
8554e7a0 | 1453 | Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if |
954c1994 GS |
1454 | not. |
1455 | ||
1456 | =for apidoc Am|void|SvTAINTED_on|SV* sv | |
c55831ac | 1457 | Marks an SV as tainted if tainting is enabled. |
954c1994 GS |
1458 | |
1459 | =for apidoc Am|void|SvTAINTED_off|SV* sv | |
8554e7a0 FC |
1460 | Untaints an SV. Be I<very> careful with this routine, as it short-circuits |
1461 | some of Perl's fundamental security features. XS module authors should not | |
954c1994 | 1462 | use this function unless they fully understand all the implications of |
72d33970 | 1463 | unconditionally untainting the value. Untainting should be done in the |
954c1994 GS |
1464 | standard perl fashion, via a carefully crafted regexp, rather than directly |
1465 | untainting variables. | |
1466 | ||
1467 | =for apidoc Am|void|SvTAINT|SV* sv | |
c98cdb04 FC |
1468 | Taints an SV if tainting is enabled, and if some input to the current |
1469 | expression is tainted--usually a variable, but possibly also implicit | |
1470 | inputs such as locale settings. C<SvTAINT> propagates that taintedness to | |
1471 | the outputs of an expression in a pessimistic fashion; i.e., without paying | |
1472 | attention to precisely which outputs are influenced by which inputs. | |
954c1994 GS |
1473 | |
1474 | =cut | |
1475 | */ | |
1476 | ||
a0714e2c | 1477 | #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0) |
aae9cea0 | 1478 | |
dc6d7f5c | 1479 | #ifdef NO_TAINT_SUPPORT |
284167a5 S |
1480 | # define SvTAINTED(sv) 0 |
1481 | #else | |
1482 | # define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv)) | |
1483 | #endif | |
5d9574c1 DM |
1484 | #define SvTAINTED_on(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_taint(sv);} }STMT_END |
1485 | #define SvTAINTED_off(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_untaint(sv);} }STMT_END | |
bbce6d69 | 1486 | |
c6ee37c5 MB |
1487 | #define SvTAINT(sv) \ |
1488 | STMT_START { \ | |
5d9574c1 DM |
1489 | if (UNLIKELY(TAINTING_get)) { \ |
1490 | if (UNLIKELY(TAINT_get)) \ | |
c6ee37c5 MB |
1491 | SvTAINTED_on(sv); \ |
1492 | } \ | |
1493 | } STMT_END | |
79072805 | 1494 | |
954c1994 GS |
1495 | /* |
1496 | =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len | |
8bb025ae | 1497 | Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and |
fd142383 | 1498 | only a string (C<SvPOK_only>), by hook or by crook. You need force if you are |
8bb025ae | 1499 | going to update the C<SvPVX> directly. Processes get magic. |
954c1994 | 1500 | |
fd142383 | 1501 | Note that coercing an arbitrary scalar into a plain PV will potentially |
72d33970 | 1502 | strip useful data from it. For example if the SV was C<SvROK>, then the |
fd142383 DM |
1503 | referent will have its reference count decremented, and the SV itself may |
1504 | be converted to an C<SvPOK> scalar with a string buffer containing a value | |
1505 | such as C<"ARRAY(0x1234)">. | |
1506 | ||
645c22ef | 1507 | =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len |
fd142383 | 1508 | Like C<SvPV_force>, but doesn't process get magic. |
645c22ef | 1509 | |
954c1994 | 1510 | =for apidoc Am|char*|SvPV|SV* sv|STRLEN len |
5f08bad4 ST |
1511 | Returns a pointer to the string in the SV, or a stringified form of |
1512 | the SV if the SV does not contain a string. The SV may cache the | |
cfe3322a DG |
1513 | stringified version becoming C<SvPOK>. Handles 'get' magic. The |
1514 | C<len> variable will be set to the length of the string (this is a macro, so | |
1515 | don't use C<&len>). See also C<SvPVx> for a version which guarantees to | |
1516 | evaluate sv only once. | |
645c22ef | 1517 | |
fd142383 | 1518 | Note that there is no guarantee that the return value of C<SvPV()> is |
fe02ddb7 | 1519 | equal to C<SvPVX(sv)>, or that C<SvPVX(sv)> contains valid data, or that |
c07def6d | 1520 | successive calls to C<SvPV(sv)> will return the same pointer value each |
72d33970 | 1521 | time. This is due to the way that things like overloading and |
fe02ddb7 DM |
1522 | Copy-On-Write are handled. In these cases, the return value may point to |
1523 | a temporary buffer or similar. If you absolutely need the SvPVX field to | |
1524 | be valid (for example, if you intend to write to it), then see | |
1525 | L</SvPV_force>. | |
fd142383 | 1526 | |
645c22ef | 1527 | =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len |
4ea561bc NC |
1528 | A version of C<SvPV> which guarantees to evaluate C<sv> only once. |
1529 | Only use this if C<sv> is an expression with side effects, otherwise use the | |
b3adf4c0 | 1530 | more efficient C<SvPV>. |
954c1994 | 1531 | |
891f9566 YST |
1532 | =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len |
1533 | Like C<SvPV> but doesn't process magic. | |
1534 | ||
954c1994 | 1535 | =for apidoc Am|char*|SvPV_nolen|SV* sv |
fd142383 | 1536 | Like C<SvPV> but doesn't set a length variable. |
954c1994 | 1537 | |
71eb6d8c TC |
1538 | =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv |
1539 | Like C<SvPV_nolen> but doesn't process magic. | |
1540 | ||
954c1994 | 1541 | =for apidoc Am|IV|SvIV|SV* sv |
8554e7a0 | 1542 | Coerces the given SV to an integer and returns it. See C<SvIVx> for a |
645c22ef DM |
1543 | version which guarantees to evaluate sv only once. |
1544 | ||
891f9566 YST |
1545 | =for apidoc Am|IV|SvIV_nomg|SV* sv |
1546 | Like C<SvIV> but doesn't process magic. | |
1547 | ||
645c22ef | 1548 | =for apidoc Am|IV|SvIVx|SV* sv |
8554e7a0 FC |
1549 | Coerces the given SV to an integer and returns it. |
1550 | Guarantees to evaluate C<sv> only once. Only use | |
1551 | this if C<sv> is an expression with side effects, | |
4ea561bc | 1552 | otherwise use the more efficient C<SvIV>. |
954c1994 GS |
1553 | |
1554 | =for apidoc Am|NV|SvNV|SV* sv | |
8554e7a0 | 1555 | Coerce the given SV to a double and return it. See C<SvNVx> for a version |
645c22ef DM |
1556 | which guarantees to evaluate sv only once. |
1557 | ||
6f1401dc DM |
1558 | =for apidoc Am|NV|SvNV_nomg|SV* sv |
1559 | Like C<SvNV> but doesn't process magic. | |
1560 | ||
645c22ef | 1561 | =for apidoc Am|NV|SvNVx|SV* sv |
8554e7a0 FC |
1562 | Coerces the given SV to a double and returns it. |
1563 | Guarantees to evaluate C<sv> only once. Only use | |
1564 | this if C<sv> is an expression with side effects, | |
4ea561bc | 1565 | otherwise use the more efficient C<SvNV>. |
954c1994 GS |
1566 | |
1567 | =for apidoc Am|UV|SvUV|SV* sv | |
645c22ef DM |
1568 | Coerces the given SV to an unsigned integer and returns it. See C<SvUVx> |
1569 | for a version which guarantees to evaluate sv only once. | |
1570 | ||
891f9566 YST |
1571 | =for apidoc Am|UV|SvUV_nomg|SV* sv |
1572 | Like C<SvUV> but doesn't process magic. | |
1573 | ||
645c22ef | 1574 | =for apidoc Am|UV|SvUVx|SV* sv |
8554e7a0 | 1575 | Coerces the given SV to an unsigned integer and |
feba1f01 | 1576 | returns it. Guarantees to evaluate C<sv> only once. Only |
8554e7a0 | 1577 | use this if C<sv> is an expression with side effects, |
4ea561bc | 1578 | otherwise use the more efficient C<SvUV>. |
954c1994 GS |
1579 | |
1580 | =for apidoc Am|bool|SvTRUE|SV* sv | |
1581 | Returns a boolean indicating whether Perl would evaluate the SV as true or | |
06c841cf FC |
1582 | false. See SvOK() for a defined/undefined test. Handles 'get' magic |
1583 | unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the | |
1584 | private flags). | |
1585 | ||
1586 | =for apidoc Am|bool|SvTRUE_nomg|SV* sv | |
1587 | Returns a boolean indicating whether Perl would evaluate the SV as true or | |
c0b6140e | 1588 | false. See SvOK() for a defined/undefined test. Does not handle 'get' magic. |
954c1994 | 1589 | |
645c22ef | 1590 | =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len |
b70b15d2 | 1591 | Like C<SvPV_force>, but converts sv to utf8 first if necessary. |
645c22ef DM |
1592 | |
1593 | =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len | |
b70b15d2 | 1594 | Like C<SvPV>, but converts sv to utf8 first if necessary. |
645c22ef | 1595 | |
b70b15d2 TJ |
1596 | =for apidoc Am|char*|SvPVutf8_nolen|SV* sv |
1597 | Like C<SvPV_nolen>, but converts sv to utf8 first if necessary. | |
645c22ef DM |
1598 | |
1599 | =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len | |
1600 | Like C<SvPV_force>, but converts sv to byte representation first if necessary. | |
1601 | ||
1602 | =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len | |
1603 | Like C<SvPV>, but converts sv to byte representation first if necessary. | |
1604 | ||
b70b15d2 | 1605 | =for apidoc Am|char*|SvPVbyte_nolen|SV* sv |
645c22ef DM |
1606 | Like C<SvPV_nolen>, but converts sv to byte representation first if necessary. |
1607 | ||
1608 | =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len | |
b70b15d2 | 1609 | Like C<SvPV_force>, but converts sv to utf8 first if necessary. |
d1be9408 | 1610 | Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force> |
645c22ef DM |
1611 | otherwise. |
1612 | ||
1613 | =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len | |
b70b15d2 | 1614 | Like C<SvPV>, but converts sv to utf8 first if necessary. |
d1be9408 | 1615 | Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8> |
645c22ef DM |
1616 | otherwise. |
1617 | ||
1618 | =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len | |
1619 | Like C<SvPV_force>, but converts sv to byte representation first if necessary. | |
d1be9408 | 1620 | Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force> |
645c22ef DM |
1621 | otherwise. |
1622 | ||
1623 | =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len | |
1624 | Like C<SvPV>, but converts sv to byte representation first if necessary. | |
d1be9408 | 1625 | Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte> |
645c22ef DM |
1626 | otherwise. |
1627 | ||
df8dcb28 DD |
1628 | =for apidoc Am|U32|SvIsCOW|SV* sv |
1629 | Returns a U32 value indicating whether the SV is Copy-On-Write (either shared | |
19dbb8f1 | 1630 | hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for |
8554e7a0 | 1631 | COW). |
19dbb8f1 NC |
1632 | |
1633 | =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv | |
1634 | Returns a boolean indicating whether the SV is Copy-On-Write shared hash key | |
1635 | scalar. | |
645c22ef | 1636 | |
0f76ff59 MHM |
1637 | =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len |
1638 | Like C<sv_catpvn> but doesn't process magic. | |
1639 | ||
9dcc53ea Z |
1640 | =for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr |
1641 | Like C<sv_catpv> but doesn't process magic. | |
1642 | ||
0f76ff59 MHM |
1643 | =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv |
1644 | Like C<sv_setsv> but doesn't process magic. | |
1645 | ||
1646 | =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv | |
1647 | Like C<sv_catsv> but doesn't process magic. | |
1648 | ||
dc960812 SP |
1649 | =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv |
1650 | ||
8554e7a0 | 1651 | Like sv_utf8_upgrade, but doesn't do magic on C<sv>. |
dc960812 | 1652 | |
954c1994 GS |
1653 | =cut |
1654 | */ | |
1655 | ||
25da4f38 | 1656 | /* Let us hope that bitmaps for UV and IV are the same */ |
4bac9ae4 CS |
1657 | #define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv)) |
1658 | #define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv)) | |
1659 | #define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv)) | |
79072805 | 1660 | |
891f9566 YST |
1661 | #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0)) |
1662 | #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0)) | |
6f1401dc | 1663 | #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0)) |
891f9566 | 1664 | |
baca2b92 | 1665 | /* ----*/ |
8d6d96c1 | 1666 | |
4bac9ae4 CS |
1667 | #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC) |
1668 | #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC) | |
44d22300 | 1669 | #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC) |
8d6d96c1 | 1670 | |
8d6d96c1 | 1671 | #define SvPV_flags(sv, lp, flags) \ |
4bac9ae4 | 1672 | (SvPOK_nog(sv) \ |
8d6d96c1 | 1673 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags)) |
32a5c6ec | 1674 | #define SvPV_flags_const(sv, lp, flags) \ |
4bac9ae4 | 1675 | (SvPOK_nog(sv) \ |
32a5c6ec NC |
1676 | ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \ |
1677 | (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN)) | |
2596d9fe | 1678 | #define SvPV_flags_const_nolen(sv, flags) \ |
4bac9ae4 | 1679 | (SvPOK_nog(sv) \ |
2596d9fe NC |
1680 | ? SvPVX_const(sv) : \ |
1681 | (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN)) | |
44d22300 | 1682 | #define SvPV_flags_mutable(sv, lp, flags) \ |
4bac9ae4 | 1683 | (SvPOK_nog(sv) \ |
44d22300 NC |
1684 | ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \ |
1685 | sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN)) | |
79072805 | 1686 | |
8d6d96c1 | 1687 | #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC) |
13c5b33c | 1688 | #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC) |
32a5c6ec | 1689 | #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC) |
baca2b92 | 1690 | |
8d6d96c1 | 1691 | #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0) |
2596d9fe | 1692 | #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0) |
8d6d96c1 | 1693 | |
8d6d96c1 | 1694 | #define SvPV_force_flags(sv, lp, flags) \ |
8bb025ae | 1695 | (SvPOK_pure_nogthink(sv) \ |
4bac9ae4 CS |
1696 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags)) |
1697 | ||
13c5b33c | 1698 | #define SvPV_force_flags_nolen(sv, flags) \ |
8bb025ae | 1699 | (SvPOK_pure_nogthink(sv) \ |
4bac9ae4 CS |
1700 | ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags)) |
1701 | ||
32a5c6ec | 1702 | #define SvPV_force_flags_mutable(sv, lp, flags) \ |
8bb025ae | 1703 | (SvPOK_pure_nogthink(sv) \ |
4bac9ae4 | 1704 | ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \ |
32a5c6ec | 1705 | : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN)) |
a0d0e21e | 1706 | |
1fa8b10d | 1707 | #define SvPV_nolen(sv) \ |
4bac9ae4 | 1708 | (SvPOK_nog(sv) \ |
dafda6d1 | 1709 | ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC)) |
70401c6b | 1710 | |
0334097d | 1711 | /* "_nomg" in these defines means no mg_get() */ |
71eb6d8c | 1712 | #define SvPV_nomg_nolen(sv) \ |
4bac9ae4 | 1713 | (SvPOK_nog(sv) \ |
71eb6d8c TC |
1714 | ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0)) |
1715 | ||
9ce348e8 | 1716 | #define SvPV_nolen_const(sv) \ |
4bac9ae4 | 1717 | (SvPOK_nog(sv) \ |
9ce348e8 NC |
1718 | ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN)) |
1719 | ||
baca2b92 | 1720 | #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0) |
9ce348e8 | 1721 | #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0) |
2596d9fe | 1722 | #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0) |
5bc28da9 | 1723 | |
baca2b92 | 1724 | /* ----*/ |
70401c6b | 1725 | |
5bc28da9 | 1726 | #define SvPVutf8(sv, lp) \ |
4bac9ae4 | 1727 | (SvPOK_utf8_nog(sv) \ |
5bc28da9 | 1728 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp)) |
70401c6b | 1729 | |
5bc28da9 | 1730 | #define SvPVutf8_force(sv, lp) \ |
8bb025ae | 1731 | (SvPOK_utf8_pure_nogthink(sv) \ |
5bc28da9 NIS |
1732 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp)) |
1733 | ||
5bc28da9 | 1734 | #define SvPVutf8_nolen(sv) \ |
4bac9ae4 | 1735 | (SvPOK_utf8_nog(sv) \ |
dafda6d1 | 1736 | ? SvPVX(sv) : sv_2pvutf8(sv, 0)) |
70401c6b | 1737 | |
baca2b92 DM |
1738 | /* ----*/ |
1739 | ||
5bc28da9 | 1740 | #define SvPVbyte(sv, lp) \ |
4bac9ae4 | 1741 | (SvPOK_byte_nog(sv) \ |
5bc28da9 | 1742 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp)) |
70401c6b | 1743 | |
5bc28da9 | 1744 | #define SvPVbyte_force(sv, lp) \ |
8bb025ae | 1745 | (SvPOK_byte_pure_nogthink(sv) \ |
a7ec4e2e | 1746 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp)) |
5bc28da9 | 1747 | |
5bc28da9 | 1748 | #define SvPVbyte_nolen(sv) \ |
4bac9ae4 | 1749 | (SvPOK_byte_nog(sv) \ |
dafda6d1 | 1750 | ? SvPVX(sv) : sv_2pvbyte(sv, 0)) |
70401c6b | 1751 | |
baca2b92 DM |
1752 | |
1753 | /* define FOOx(): idempotent versions of FOO(). If possible, use a local | |
1754 | * var to evaluate the arg once; failing that, use a global if possible; | |
1755 | * failing that, call a function to do the work | |
1756 | */ | |
1757 | ||
1758 | #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp) | |
1759 | #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp) | |
1760 | #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp) | |
1761 | ||
5d9574c1 DM |
1762 | #define SvTRUE(sv) (LIKELY(sv) && (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv)))) |
1763 | #define SvTRUE_nomg(sv) (LIKELY(sv) && ( SvTRUE_common(sv, sv_2bool_nomg(sv)))) | |
1764 | #define SvTRUE_NN(sv) (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))) | |
716ae3b0 | 1765 | #define SvTRUE_nomg_NN(sv) ( SvTRUE_common(sv, sv_2bool_nomg(sv))) |
4bac9ae4 CS |
1766 | #define SvTRUE_common(sv,fallback) ( \ |
1767 | !SvOK(sv) \ | |
1768 | ? 0 \ | |
762dbf22 FC |
1769 | : SvPOK(sv) \ |
1770 | ? SvPVXtrue(sv) \ | |
1771 | : (SvFLAGS(sv) & (SVf_IOK|SVf_NOK)) \ | |
1772 | ? ( (SvIOK(sv) && SvIVX(sv) != 0) \ | |
659c4b96 | 1773 | || (SvNOK(sv) && SvNVX(sv) != 0.0)) \ |
4bac9ae4 CS |
1774 | : (fallback)) |
1775 | ||
5dc8bdac | 1776 | #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) |
baca2b92 | 1777 | |
b1bc3f34 NC |
1778 | # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); }) |
1779 | # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); }) | |
1780 | # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); }) | |
3de3296f | 1781 | # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); }) |
32a5c6ec | 1782 | # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); }) |
002e4c74 | 1783 | # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); }) |
9ce348e8 | 1784 | # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); }) |
3de3296f AE |
1785 | # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); }) |
1786 | # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); }) | |
002e4c74 | 1787 | # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); }) |
4bac9ae4 CS |
1788 | # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); }) |
1789 | # define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); }) | |
baca2b92 | 1790 | |
a80f87c4 | 1791 | #else /* __GNUC__ */ |
baca2b92 | 1792 | |
a80f87c4 GS |
1793 | /* These inlined macros use globals, which will require a thread |
1794 | * declaration in user code, so we avoid them under threads */ | |
1795 | ||
3db8f154 MB |
1796 | # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv)) |
1797 | # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv)) | |
1798 | # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv)) | |
1799 | # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp)) | |
32a5c6ec | 1800 | # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp)) |
002e4c74 | 1801 | # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv)) |
5f1478c3 | 1802 | # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv)) |
3db8f154 MB |
1803 | # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp)) |
1804 | # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp)) | |
002e4c74 | 1805 | # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv)) |
4bac9ae4 CS |
1806 | # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv)) |
1807 | # define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv)) | |
baca2b92 DM |
1808 | #endif /* __GNU__ */ |
1809 | ||
630b72b0 DD |
1810 | #define SvPVXtrue(sv) ( \ |
1811 | ((XPV*)SvANY((sv))) \ | |
1812 | && ( \ | |
1813 | ((XPV*)SvANY((sv)))->xpv_cur > 1 \ | |
1814 | || ( \ | |
1815 | ((XPV*)SvANY((sv)))->xpv_cur \ | |
1816 | && *(sv)->sv_u.svu_pv != '0' \ | |
1817 | ) \ | |
1818 | ) \ | |
1819 | ) | |
1820 | ||
e3918bb7 FC |
1821 | #define SvIsCOW(sv) (SvFLAGS(sv) & SVf_IsCOW) |
1822 | #define SvIsCOW_on(sv) (SvFLAGS(sv) |= SVf_IsCOW) | |
1823 | #define SvIsCOW_off(sv) (SvFLAGS(sv) &= ~SVf_IsCOW) | |
46187eeb | 1824 | #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0) |
baca2b92 | 1825 | |
bdd68bc3 NC |
1826 | #define SvSHARED_HEK_FROM_PV(pvx) \ |
1827 | ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key))) | |
0a356b31 | 1828 | #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash) |
c158a4fd | 1829 | |
baca2b92 DM |
1830 | /* flag values for sv_*_flags functions */ |
1831 | #define SV_IMMEDIATE_UNREF 1 | |
1832 | #define SV_GMAGIC 2 | |
765f542d | 1833 | #define SV_COW_DROP_PV 4 |
88632417 | 1834 | #define SV_UTF8_NO_ENCODING 8 |
5fcdf167 | 1835 | #define SV_NOSTEAL 16 |
32a5c6ec NC |
1836 | #define SV_CONST_RETURN 32 |
1837 | #define SV_MUTABLE_RETURN 64 | |
bddd5118 | 1838 | #define SV_SMAGIC 128 |
c1c21316 | 1839 | #define SV_HAS_TRAILING_NUL 256 |
34482cd6 | 1840 | #define SV_COW_SHARED_HASH_KEYS 512 |
cb23d5b1 NC |
1841 | /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */ |
1842 | #define SV_COW_OTHER_PVS 1024 | |
9f621bb0 NC |
1843 | /* Make sv_2pv_flags return NULL if something is undefined. */ |
1844 | #define SV_UNDEF_RETURNS_NULL 2048 | |
b3ab6785 KW |
1845 | /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed. |
1846 | * This is used when the caller has already determined it is, and avoids | |
1847 | * redundant work */ | |
1848 | #define SV_FORCE_UTF8_UPGRADE 4096 | |
aee036bb DM |
1849 | /* if (after resolving magic etc), the SV is found to be overloaded, |
1850 | * don't call the overload magic, just return as-is */ | |
1851 | #define SV_SKIP_OVERLOAD 8192 | |
c682ebef FC |
1852 | /* It is not yet clear whether we want this as an API, or what the |
1853 | * constants should be named. */ | |
1854 | #ifdef PERL_CORE | |
1855 | # define SV_CATBYTES 16384 | |
1856 | # define SV_CATUTF8 32768 | |
1857 | #endif | |
34482cd6 NC |
1858 | |
1859 | /* The core is safe for this COW optimisation. XS code on CPAN may not be. | |
1860 | So only default to doing the COW setup if we're in the core. | |
1861 | */ | |
1862 | #ifdef PERL_CORE | |
1863 | # ifndef SV_DO_COW_SVSETSV | |
cb23d5b1 | 1864 | # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS |
34482cd6 NC |
1865 | # endif |
1866 | #endif | |
1867 | ||
1868 | #ifndef SV_DO_COW_SVSETSV | |
1869 | # define SV_DO_COW_SVSETSV 0 | |
1870 | #endif | |
1871 | ||
765f542d | 1872 | |
5abc721d NC |
1873 | #define sv_unref(sv) sv_unref_flags(sv, 0) |
1874 | #define sv_force_normal(sv) sv_force_normal_flags(sv, 0) | |
47518d95 NC |
1875 | #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0) |
1876 | #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC) | |
174c73e3 | 1877 | |
46187eeb NC |
1878 | /* We are about to replace the SV's current value. So if it's copy on write |
1879 | we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that | |
1880 | the value is about to get thrown away, so drop the PV rather than go to | |
1881 | the effort of making a read-write copy only for it to get immediately | |
1882 | discarded. */ | |
765f542d NC |
1883 | |
1884 | #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \ | |
1885 | sv_force_normal_flags(sv, SV_COW_DROP_PV) | |
46187eeb | 1886 | |
f8c7b90f | 1887 | #ifdef PERL_OLD_COPY_ON_WRITE |
5302ffd4 | 1888 | #define SvRELEASE_IVX(sv) \ |
7a4bba22 | 1889 | ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0) |
46187eeb | 1890 | # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv)) |
7a4bba22 | 1891 | # define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv), |
db2c6cb3 FC |
1892 | # define SvCANCOW(sv) \ |
1893 | (SvIsCOW(sv) || (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS) | |
f7a8268c FC |
1894 | /* This is a pessimistic view. Scalar must be purely a read-write PV to copy- |
1895 | on-write. */ | |
1896 | # define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \ | |
1897 | SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \ | |
1898 | SVf_OOK|SVf_BREAK|SVf_READONLY) | |
b8f9541a | 1899 | #else |
7a4bba22 NC |
1900 | # define SvRELEASE_IVX(sv) 0 |
1901 | /* This little game brought to you by the need to shut this warning up: | |
1204f081 | 1902 | mg.c: In function 'Perl_magic_get': |
7a4bba22 NC |
1903 | mg.c:1024: warning: left-hand operand of comma expression has no effect |
1904 | */ | |
1905 | # define SvRELEASE_IVX_(sv) /**/ | |
db2c6cb3 FC |
1906 | # ifdef PERL_NEW_COPY_ON_WRITE |
1907 | # define SvCANCOW(sv) \ | |
1908 | (SvIsCOW(sv) \ | |
1909 | ? SvLEN(sv) ? CowREFCNT(sv) != SV_COW_REFCNT_MAX : 1 \ | |
1910 | : (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS \ | |
1911 | && SvCUR(sv)+1 < SvLEN(sv)) | |
1912 | /* Note: To allow 256 COW "copies", a refcnt of 0 means 1. */ | |
1913 | # define CowREFCNT(sv) (*(U8 *)(SvPVX(sv)+SvLEN(sv)-1)) | |
1914 | # define SV_COW_REFCNT_MAX ((1 << sizeof(U8)*8) - 1) | |
f7a8268c FC |
1915 | # define CAN_COW_MASK (SVf_POK|SVf_ROK|SVp_POK|SVf_FAKE| \ |
1916 | SVf_OOK|SVf_BREAK|SVf_READONLY) | |
db2c6cb3 | 1917 | # endif |
f8c7b90f | 1918 | #endif /* PERL_OLD_COPY_ON_WRITE */ |
ed252734 | 1919 | |
ed252734 NC |
1920 | #define CAN_COW_FLAGS (SVp_POK|SVf_POK) |
1921 | ||
765f542d NC |
1922 | #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \ |
1923 | sv_force_normal_flags(sv, 0) | |
1924 | ||
1925 | ||
baca2b92 DM |
1926 | /* all these 'functions' are now just macros */ |
1927 | ||
1928 | #define sv_pv(sv) SvPV_nolen(sv) | |
1929 | #define sv_pvutf8(sv) SvPVutf8_nolen(sv) | |
1930 | #define sv_pvbyte(sv) SvPVbyte_nolen(sv) | |
1931 | ||
1932 | #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0) | |
b3ab6785 | 1933 | #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0) |
baca2b92 DM |
1934 | #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0) |
1935 | #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0) | |
9dcc53ea | 1936 | #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0) |
34482cd6 NC |
1937 | #define sv_setsv(dsv, ssv) \ |
1938 | sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV) | |
1939 | #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV) | |
baca2b92 DM |
1940 | #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC) |
1941 | #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0) | |
b347df82 | 1942 | #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC) |
baca2b92 | 1943 | #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC) |
4bac9ae4 CS |
1944 | #define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC); |
1945 | #define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC) | |
1946 | #define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0) | |
baca2b92 | 1947 | #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC) |
cb2f1b7b NC |
1948 | #define sv_2pv_nolen(sv) sv_2pv(sv, 0) |
1949 | #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0) | |
1950 | #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0) | |
baca2b92 DM |
1951 | #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0) |
1952 | #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC) | |
1953 | #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC) | |
891f9566 YST |
1954 | #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC) |
1955 | #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC) | |
39d5de13 | 1956 | #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC) |
078504b2 | 1957 | #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC) |
e8c9c9d4 NC |
1958 | #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC) |
1959 | #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC) | |
078504b2 | 1960 | #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC) |
06c841cf | 1961 | #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC) |
4bac9ae4 | 1962 | #define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0) |
84335ee9 NC |
1963 | #define sv_insert(bigstr, offset, len, little, littlelen) \ |
1964 | Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \ | |
1965 | (littlelen), SV_GMAGIC) | |
108cb980 FC |
1966 | #define sv_mortalcopy(sv) \ |
1967 | Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV) | |
baca2b92 | 1968 | |
db79b45b | 1969 | /* Should be named SvCatPVN_utf8_upgrade? */ |
4bac9ae4 | 1970 | #define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \ |
db79b45b JH |
1971 | STMT_START { \ |
1972 | if (!(nsv)) \ | |
ad25789c | 1973 | nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \ |
db79b45b JH |
1974 | else \ |
1975 | sv_setpvn(nsv, sstr, slen); \ | |
1976 | SvUTF8_off(nsv); \ | |
1977 | sv_utf8_upgrade(nsv); \ | |
4bac9ae4 | 1978 | sv_catsv_nomg(dsv, nsv); \ |
db79b45b | 1979 | } STMT_END |
64534138 FC |
1980 | #define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \ |
1981 | sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES) | |
79072805 | 1982 | |
25fdce4a | 1983 | #if defined(PERL_CORE) || defined(PERL_EXT) |
aec43834 FC |
1984 | # define sv_or_pv_len_utf8(sv, pv, bytelen) \ |
1985 | (SvGAMAGIC(sv) \ | |
1986 | ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \ | |
1987 | : sv_len_utf8(sv)) | |
aec43834 FC |
1988 | #endif |
1989 | ||
954c1994 GS |
1990 | /* |
1991 | =for apidoc Am|SV*|newRV_inc|SV* sv | |
1992 | ||
1993 | Creates an RV wrapper for an SV. The reference count for the original SV is | |
1994 | incremented. | |
1995 | ||
1996 | =cut | |
1997 | */ | |
1998 | ||
5f05dabc | 1999 | #define newRV_inc(sv) newRV(sv) |
5f05dabc | 2000 | |
ef50df4b | 2001 | /* the following macros update any magic values this sv is associated with */ |
79072805 | 2002 | |
954c1994 | 2003 | /* |
ccfc67b7 JH |
2004 | =head1 Magical Functions |
2005 | ||
954c1994 | 2006 | =for apidoc Am|void|SvGETMAGIC|SV* sv |
f7e029ab FC |
2007 | Invokes C<mg_get> on an SV if it has 'get' magic. For example, this |
2008 | will call C<FETCH> on a tied variable. This macro evaluates its | |
954c1994 GS |
2009 | argument more than once. |
2010 | ||
2011 | =for apidoc Am|void|SvSETMAGIC|SV* sv | |
f7e029ab FC |
2012 | Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary |
2013 | after modifying a scalar, in case it is a magical variable like C<$|> | |
2014 | or a tied variable (it calls C<STORE>). This macro evaluates its | |
954c1994 GS |
2015 | argument more than once. |
2016 | ||
87ef9da8 | 2017 | =for apidoc Am|void|SvSetSV|SV* dsv|SV* ssv |
954c1994 | 2018 | Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments |
f31006c9 | 2019 | more than once. Does not handle 'set' magic on the destination SV. |
954c1994 GS |
2020 | |
2021 | =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv | |
2022 | Calls a non-destructive version of C<sv_setsv> if dsv is not the same as | |
8554e7a0 | 2023 | ssv. May evaluate arguments more than once. |
954c1994 | 2024 | |
87ef9da8 | 2025 | =for apidoc Am|void|SvSetMagicSV|SV* dsv|SV* ssv |
645c22ef DM |
2026 | Like C<SvSetSV>, but does any set magic required afterwards. |
2027 | ||
2028 | =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv | |
80663158 | 2029 | Like C<SvSetSV_nosteal>, but does any set magic required afterwards. |
645c22ef | 2030 | |
68795e93 NIS |
2031 | =for apidoc Am|void|SvSHARE|SV* sv |
2032 | Arranges for sv to be shared between threads if a suitable module | |
2033 | has been loaded. | |
2034 | ||
2035 | =for apidoc Am|void|SvLOCK|SV* sv | |
2036 | Arranges for a mutual exclusion lock to be obtained on sv if a suitable module | |
2037 | has been loaded. | |
2038 | ||
2039 | =for apidoc Am|void|SvUNLOCK|SV* sv | |
2040 | Releases a mutual exclusion lock on sv if a suitable module | |
2041 | has been loaded. | |
2042 | ||
ccfc67b7 JH |
2043 | =head1 SV Manipulation Functions |
2044 | ||
679ac26e | 2045 | =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len |
954c1994 GS |
2046 | Expands the character buffer in the SV so that it has room for the |
2047 | indicated number of bytes (remember to reserve space for an extra trailing | |
6602b933 | 2048 | C<NUL> character). Calls C<sv_grow> to perform the expansion if necessary. |
72d33970 FC |
2049 | Returns a pointer to the character |
2050 | buffer. SV must be of type >= SVt_PV. One | |
4b1e7f06 | 2051 | alternative is to call C<sv_grow> if you are not sure of the type of SV. |
954c1994 GS |
2052 | |
2053 | =cut | |
2054 | */ | |
2055 | ||
16c91539 BM |
2056 | #define SvSHARE(sv) PL_sharehook(aTHX_ sv) |
2057 | #define SvLOCK(sv) PL_lockhook(aTHX_ sv) | |
2058 | #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv) | |
2059 | #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv) | |
68795e93 | 2060 | |
5d9574c1 DM |
2061 | #define SvGETMAGIC(x) ((void)(UNLIKELY(SvGMAGICAL(x)) && mg_get(x))) |
2062 | #define SvSETMAGIC(x) STMT_START { if (UNLIKELY(SvSMAGICAL(x))) mg_set(x); } STMT_END | |
79072805 | 2063 | |
54310121 | 2064 | #define SvSetSV_and(dst,src,finally) \ |
189b2af5 | 2065 | STMT_START { \ |
5d9574c1 | 2066 | if (LIKELY((dst) != (src))) { \ |
54310121 | 2067 | sv_setsv(dst, src); \ |
2068 | finally; \ | |
189b2af5 GS |
2069 | } \ |
2070 | } STMT_END | |
54310121 | 2071 | #define SvSetSV_nosteal_and(dst,src,finally) \ |
189b2af5 | 2072 | STMT_START { \ |
5d9574c1 | 2073 | if (LIKELY((dst) != (src))) { \ |
34482cd6 | 2074 | sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \ |
54310121 | 2075 | finally; \ |
189b2af5 GS |
2076 | } \ |
2077 | } STMT_END | |
79072805 | 2078 | |
54310121 | 2079 | #define SvSetSV(dst,src) \ |
c9d716f7 | 2080 | SvSetSV_and(dst,src,/*nothing*/;) |
54310121 | 2081 | #define SvSetSV_nosteal(dst,src) \ |
c9d716f7 | 2082 | SvSetSV_nosteal_and(dst,src,/*nothing*/;) |
54310121 | 2083 | |
2084 | #define SvSetMagicSV(dst,src) \ | |
4e3a8365 | 2085 | SvSetSV_and(dst,src,SvSETMAGIC(dst)) |
54310121 | 2086 | #define SvSetMagicSV_nosteal(dst,src) \ |
4e3a8365 | 2087 | SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst)) |
54310121 | 2088 | |
db79b45b | 2089 | |
1045810a | 2090 | #if !defined(SKIP_DEBUGGING) |
79072805 | 2091 | #define SvPEEK(sv) sv_peek(sv) |
3967c732 JD |
2092 | #else |
2093 | #define SvPEEK(sv) "" | |
2094 | #endif | |
79072805 | 2095 | |
3041a168 | 2096 | #define SvIMMORTAL(sv) (SvREADONLY(sv) && ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)) |
36477c24 | 2097 | |
fe54beba DM |
2098 | #ifdef DEBUGGING |
2099 | /* exercise the immortal resurrection code in sv_free2() */ | |
2100 | # define SvREFCNT_IMMORTAL 1000 | |
2101 | #else | |
2102 | # define SvREFCNT_IMMORTAL ((~(U32)0)/2) | |
2103 | #endif | |
2104 | ||
567f3b56 TC |
2105 | /* |
2106 | =for apidoc Am|SV *|boolSV|bool b | |
2107 | ||
2108 | Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0. | |
2109 | ||
2110 | See also C<PL_sv_yes> and C<PL_sv_no>. | |
2111 | ||
2112 | =cut | |
2113 | */ | |
2114 | ||
3280af22 | 2115 | #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no) |
54310121 | 2116 | |
79072805 | 2117 | #define isGV(sv) (SvTYPE(sv) == SVt_PVGV) |
f7877b28 NC |
2118 | /* If I give every macro argument a different name, then there won't be bugs |
2119 | where nested macros get confused. Been there, done that. */ | |
2120 | #define isGV_with_GP(pwadak) \ | |
2e5b91de | 2121 | (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \ |
f7877b28 | 2122 | && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV)) |
2e5b91de | 2123 | #define isGV_with_GP_on(sv) STMT_START { \ |
70ad9799 SP |
2124 | assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \ |
2125 | assert (!SvPOKp(sv)); \ | |
2126 | assert (!SvIOKp(sv)); \ | |
2127 | (SvFLAGS(sv) |= SVpgv_GP); \ | |
2e5b91de NC |
2128 | } STMT_END |
2129 | #define isGV_with_GP_off(sv) STMT_START { \ | |
70ad9799 SP |
2130 | assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \ |
2131 | assert (!SvPOKp(sv)); \ | |
2132 | assert (!SvIOKp(sv)); \ | |
2e5b91de NC |
2133 | (SvFLAGS(sv) &= ~SVpgv_GP); \ |
2134 | } STMT_END | |
8d919b0a FC |
2135 | #define isREGEXP(sv) \ |
2136 | (SvTYPE(sv) == SVt_REGEXP \ | |
2137 | || (SvFLAGS(sv) & (SVTYPEMASK|SVp_POK|SVpgv_GP|SVf_FAKE)) \ | |
2138 | == (SVt_PVLV|SVf_FAKE)) | |
2e5b91de | 2139 | |
79072805 | 2140 | |
bba82a09 | 2141 | #ifdef PERL_ANY_COW |
db2c6cb3 FC |
2142 | # define SvGROW(sv,len) \ |
2143 | (SvIsCOW(sv) || SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv)) | |
2144 | #else | |
2145 | # define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv)) | |
2146 | #endif | |
5902b6a9 NC |
2147 | #define SvGROW_mutable(sv,len) \ |
2148 | (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv)) | |
933fea7f | 2149 | #define Sv_Grow sv_grow |
3d35f11b | 2150 | |
a0739874 DM |
2151 | #define CLONEf_COPY_STACKS 1 |
2152 | #define CLONEf_KEEP_PTR_TABLE 2 | |
c43294b8 | 2153 | #define CLONEf_CLONE_HOST 4 |
0405e91e | 2154 | #define CLONEf_JOIN_IN 8 |
a0739874 | 2155 | |
8cf8f3d1 | 2156 | struct clone_params { |
d2d73c3e AB |
2157 | AV* stashes; |
2158 | UV flags; | |
59b40662 | 2159 | PerlInterpreter *proto_perl; |
1db366cc | 2160 | PerlInterpreter *new_perl; |
d08d57ef | 2161 | AV *unreferenced; |
8cf8f3d1 | 2162 | }; |
102d3b8a NC |
2163 | |
2164 | /* | |
740cce10 NC |
2165 | =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8 |
2166 | ||
30a15352 KW |
2167 | Creates a new SV and copies a string (which may contain C<NUL> (C<\0>) |
2168 | characters) into it. If utf8 is true, calls | |
740cce10 NC |
2169 | C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>. |
2170 | ||
2171 | =cut | |
2172 | */ | |
2173 | ||
2174 | #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0) | |
2175 | ||
2176 | /* | |
35e035cc FC |
2177 | =for apidoc Amx|SV*|newSVpadname|PADNAME *pn |
2178 | ||
2179 | Creates a new SV containing the pad name. This is currently identical | |
2180 | to C<newSVsv>, but pad names may cease being SVs at some point, so | |
2181 | C<newSVpadname> is preferable. | |
2182 | ||
2183 | =cut | |
2184 | */ | |
2185 | ||
2186 | #define newSVpadname(pn) newSVsv(pn) | |
2187 | ||
2188 | /* | |
69240efd NC |
2189 | =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len |
2190 | ||
2191 | Reads into I<len> the offset from SvPVX back to the true start of the | |
2192 | allocated buffer, which will be non-zero if C<sv_chop> has been used to | |
8554e7a0 | 2193 | efficiently remove characters from start of the buffer. Implemented as a |
69240efd | 2194 | macro, which takes the address of I<len>, which must be of type C<STRLEN>. |
8554e7a0 | 2195 | Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false. |
69240efd NC |
2196 | |
2197 | =cut | |
2198 | */ | |
2199 | ||
2200 | #ifdef DEBUGGING | |
2201 | /* Does the bot know something I don't? | |
2202 | 10:28 <@Nicholas> metabatman | |
2203 | 10:28 <+meta> Nicholas: crash | |
2204 | */ | |
2205 | # define SvOOK_offset(sv, offset) STMT_START { \ | |
2206 | assert(sizeof(offset) == sizeof(STRLEN)); \ | |
2207 | if (SvOOK(sv)) { \ | |
d845901f CS |
2208 | const U8 *_crash = (U8*)SvPVX_const(sv); \ |
2209 | (offset) = *--_crash; \ | |
2210 | if (!(offset)) { \ | |
2211 | _crash -= sizeof(STRLEN); \ | |
2212 | Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \ | |
69240efd NC |
2213 | } \ |
2214 | { \ | |
2215 | /* Validate the preceding buffer's sentinels to \ | |
2216 | verify that no-one is using it. */ \ | |
d845901f CS |
2217 | const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\ |
2218 | while (_crash > _bonk) { \ | |
2219 | --_crash; \ | |
2220 | assert (*_crash == (U8)PTR2UV(_crash)); \ | |
69240efd NC |
2221 | } \ |
2222 | } \ | |
2223 | } else { \ | |
d845901f | 2224 | (offset) = 0; \ |
69240efd NC |
2225 | } \ |
2226 | } STMT_END | |
2227 | #else | |
2228 | /* This is the same code, but avoids using any temporary variables: */ | |
2229 | # define SvOOK_offset(sv, offset) STMT_START { \ | |
2230 | assert(sizeof(offset) == sizeof(STRLEN)); \ | |
2231 | if (SvOOK(sv)) { \ | |
d845901f CS |
2232 | (offset) = ((U8*)SvPVX_const(sv))[-1]; \ |
2233 | if (!(offset)) { \ | |
69240efd | 2234 | Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \ |
d845901f | 2235 | (U8*)&(offset), sizeof(STRLEN), U8); \ |
69240efd NC |
2236 | } \ |
2237 | } else { \ | |
d845901f | 2238 | (offset) = 0; \ |
69240efd NC |
2239 | } \ |
2240 | } STMT_END | |
2241 | #endif | |
85dca89a NC |
2242 | |
2243 | #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO)) | |
2244 | ||
a38ab475 RZ |
2245 | #define SV_CONST(name) \ |
2246 | PL_sv_consts[SV_CONST_##name] \ | |
2247 | ? PL_sv_consts[SV_CONST_##name] \ | |
2248 | : (PL_sv_consts[SV_CONST_##name] = newSVpv_share(#name, 0)) | |
2249 | ||
2250 | #define SV_CONST_TIESCALAR 0 | |
2251 | #define SV_CONST_TIEARRAY 1 | |
2252 | #define SV_CONST_TIEHASH 2 | |
2253 | #define SV_CONST_TIEHANDLE 3 | |
2254 | ||
2255 | #define SV_CONST_FETCH 4 | |
2256 | #define SV_CONST_FETCHSIZE 5 | |
2257 | #define SV_CONST_STORE 6 | |
2258 | #define SV_CONST_STORESIZE 7 | |
2259 | #define SV_CONST_EXISTS 8 | |
2260 | ||
2261 | #define SV_CONST_PUSH 9 | |
2262 | #define SV_CONST_POP 10 | |
2263 | #define SV_CONST_SHIFT 11 | |
2264 | #define SV_CONST_UNSHIFT 12 | |
2265 | #define SV_CONST_SPLICE 13 | |
2266 | #define SV_CONST_EXTEND 14 | |
2267 | ||
2268 | #define SV_CONST_FIRSTKEY 15 | |
2269 | #define SV_CONST_NEXTKEY 16 | |
2270 | #define SV_CONST_SCALAR 17 | |
2271 | ||
2272 | #define SV_CONST_OPEN 18 | |
2273 | #define SV_CONST_WRITE 19 | |
2274 | #define SV_CONST_PRINT 20 | |
2275 | #define SV_CONST_PRINTF 21 | |
2276 | #define SV_CONST_READ 22 | |
2277 | #define SV_CONST_READLINE 23 | |
2278 | #define SV_CONST_GETC 24 | |
2279 | #define SV_CONST_SEEK 25 | |
2280 | #define SV_CONST_TELL 26 | |
2281 | #define SV_CONST_EOF 27 | |
2282 | #define SV_CONST_BINMODE 28 | |
2283 | #define SV_CONST_FILENO 29 | |
2284 | #define SV_CONST_CLOSE 30 | |
2285 | ||
2286 | #define SV_CONST_DELETE 31 | |
2287 | #define SV_CONST_CLEAR 32 | |
2288 | #define SV_CONST_UNTIE 33 | |
2289 | #define SV_CONST_DESTROY 34 | |
2290 | ||
2291 | #define SV_CONSTS_COUNT 35 | |
2292 | ||
69240efd | 2293 | /* |
102d3b8a NC |
2294 | * Local variables: |
2295 | * c-indentation-style: bsd | |
2296 | * c-basic-offset: 4 | |
14d04a33 | 2297 | * indent-tabs-mode: nil |
102d3b8a NC |
2298 | * End: |
2299 | * | |
14d04a33 | 2300 | * ex: set ts=8 sts=4 sw=4 et: |
102d3b8a | 2301 | */ |