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