Commit | Line | Data |
---|---|---|
a0d0e21e | 1 | /* sv.h |
79072805 | 2 | * |
4bb101f2 | 3 | * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, |
acde74e1 | 4 | * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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 LW |
47 | SVt_NULL, /* 0 */ |
48 | SVt_IV, /* 1 */ | |
49 | SVt_NV, /* 2 */ | |
50 | SVt_RV, /* 3 */ | |
51 | SVt_PV, /* 4 */ | |
52 | SVt_PVIV, /* 5 */ | |
53 | SVt_PVNV, /* 6 */ | |
54 | SVt_PVMG, /* 7 */ | |
55 | SVt_PVBM, /* 8 */ | |
4ce457a6 TP |
56 | SVt_PVGV, /* 9 */ |
57 | SVt_PVLV, /* 10 */ | |
58 | SVt_PVAV, /* 11 */ | |
59 | SVt_PVHV, /* 12 */ | |
60 | SVt_PVCV, /* 13 */ | |
a0d0e21e | 61 | SVt_PVFM, /* 14 */ |
93e68bfb JC |
62 | SVt_PVIO, /* 15 */ |
63 | SVt_LAST /* keep last in enum. used to size arrays */ | |
79072805 LW |
64 | } svtype; |
65 | ||
028b03ee NC |
66 | #ifdef PERL_IN_SV_C |
67 | #define PTE_SVSLOT SVt_RV | |
68 | #endif | |
6a93a7e5 NC |
69 | #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST) |
70 | #define HE_SVSLOT SVt_NULL | |
71 | #endif | |
43e6e717 NC |
72 | |
73 | /* typedefs to eliminate some typing */ | |
74 | typedef struct he HE; | |
75 | typedef struct hek HEK; | |
76 | ||
79072805 LW |
77 | /* Using C's structural equivalence to help emulate C++ inheritance here... */ |
78 | ||
30153bd2 JC |
79 | /* start with 2 sv-head building blocks */ |
80 | #define _SV_HEAD(ptrtype) \ | |
81 | ptrtype sv_any; /* pointer to body */ \ | |
82 | U32 sv_refcnt; /* how many references to us */ \ | |
83 | U32 sv_flags /* what we are */ | |
84 | ||
85 | #define _SV_HEAD_UNION \ | |
86 | union { \ | |
87 | IV svu_iv; \ | |
88 | UV svu_uv; \ | |
89 | SV* svu_rv; /* pointer to another SV */ \ | |
90 | char* svu_pv; /* pointer to malloced string */ \ | |
91 | SV** svu_array; \ | |
92 | HE** svu_hash; \ | |
93 | } sv_u | |
94 | ||
95 | ||
5e045b90 | 96 | struct STRUCT_SV { /* struct sv { */ |
30153bd2 JC |
97 | _SV_HEAD(void*); |
98 | _SV_HEAD_UNION; | |
fd0854ff DM |
99 | #ifdef DEBUG_LEAKING_SCALARS |
100 | unsigned sv_debug_optype:9; /* the type of OP that allocated us */ | |
101 | unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */ | |
102 | unsigned sv_debug_cloned:1; /* was cloned for an ithread */ | |
103 | unsigned sv_debug_line:16; /* the line where we were allocated */ | |
104 | char * sv_debug_file; /* the file where we were allocated */ | |
105 | #endif | |
79072805 LW |
106 | }; |
107 | ||
108 | struct gv { | |
30153bd2 JC |
109 | _SV_HEAD(XPVGV*); /* pointer to xpvgv body */ |
110 | _SV_HEAD_UNION; | |
79072805 LW |
111 | }; |
112 | ||
113 | struct cv { | |
30153bd2 JC |
114 | _SV_HEAD(XPVCV*); /* pointer to xpvcv body */ |
115 | _SV_HEAD_UNION; | |
79072805 LW |
116 | }; |
117 | ||
118 | struct av { | |
0f7b1ae0 | 119 | _SV_HEAD(XPVAV*); /* pointer to xpvav body */ |
30153bd2 | 120 | _SV_HEAD_UNION; |
79072805 LW |
121 | }; |
122 | ||
123 | struct hv { | |
30153bd2 JC |
124 | _SV_HEAD(XPVHV*); /* pointer to xpvhv body */ |
125 | _SV_HEAD_UNION; | |
8990e307 LW |
126 | }; |
127 | ||
128 | struct io { | |
30153bd2 JC |
129 | _SV_HEAD(XPVIO*); /* pointer to xpvio body */ |
130 | _SV_HEAD_UNION; | |
79072805 LW |
131 | }; |
132 | ||
30153bd2 | 133 | #undef _SV_HEAD |
0f7b1ae0 | 134 | #undef _SV_HEAD_UNION /* ensure no pollution */ |
30153bd2 | 135 | |
954c1994 | 136 | /* |
ccfc67b7 JH |
137 | =head1 SV Manipulation Functions |
138 | ||
954c1994 GS |
139 | =for apidoc Am|U32|SvREFCNT|SV* sv |
140 | Returns the value of the object's reference count. | |
141 | ||
142 | =for apidoc Am|SV*|SvREFCNT_inc|SV* sv | |
143 | Increments the reference count of the given SV. | |
144 | ||
145 | =for apidoc Am|void|SvREFCNT_dec|SV* sv | |
146 | Decrements the reference count of the given SV. | |
147 | ||
148 | =for apidoc Am|svtype|SvTYPE|SV* sv | |
149 | Returns the type of the SV. See C<svtype>. | |
150 | ||
151 | =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type | |
152 | Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to | |
153 | perform the upgrade if necessary. See C<svtype>. | |
154 | ||
155 | =cut | |
156 | */ | |
157 | ||
463ee0b2 | 158 | #define SvANY(sv) (sv)->sv_any |
79072805 | 159 | #define SvFLAGS(sv) (sv)->sv_flags |
aeea060c | 160 | #define SvREFCNT(sv) (sv)->sv_refcnt |
a863c7d1 | 161 | |
93189314 | 162 | #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC) |
dce16143 MB |
163 | # define SvREFCNT_inc(sv) \ |
164 | ({ \ | |
a3b680e6 | 165 | SV * const _sv = (SV*)(sv); \ |
3de3296f AE |
166 | if (_sv) \ |
167 | (SvREFCNT(_sv))++; \ | |
168 | _sv; \ | |
dce16143 | 169 | }) |
8990e307 | 170 | #else |
3db8f154 | 171 | # define SvREFCNT_inc(sv) \ |
38a574c7 | 172 | ((PL_Sv=(SV*)(sv)) ? ((++(SvREFCNT(PL_Sv))),(PL_Sv)) : NULL) |
8990e307 LW |
173 | #endif |
174 | ||
8c4d3c90 NC |
175 | #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC) |
176 | # define SvREFCNT_dec(sv) \ | |
177 | ({ \ | |
a3b680e6 | 178 | SV * const _sv = (SV*)(sv); \ |
3de3296f AE |
179 | if (_sv) { \ |
180 | if (SvREFCNT(_sv)) { \ | |
181 | if (--(SvREFCNT(_sv)) == 0) \ | |
182 | Perl_sv_free2(aTHX_ _sv); \ | |
8c4d3c90 | 183 | } else { \ |
3de3296f | 184 | sv_free(_sv); \ |
8c4d3c90 NC |
185 | } \ |
186 | } \ | |
187 | }) | |
188 | #else | |
91f3b821 | 189 | #define SvREFCNT_dec(sv) sv_free((SV*)(sv)) |
8c4d3c90 | 190 | #endif |
a863c7d1 | 191 | |
8990e307 LW |
192 | #define SVTYPEMASK 0xff |
193 | #define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK) | |
79072805 | 194 | |
0565a181 NC |
195 | /* Sadly there are some parts of the core that have pointers to already-freed |
196 | SV heads, and rely on being able to tell that they are now free. So mark | |
197 | them all by using a consistent macro. */ | |
198 | #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK) | |
199 | ||
63f97190 | 200 | #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1)) |
79072805 | 201 | |
d9d18af6 | 202 | #define SVs_PADSTALE 0x00000100 /* lexical has gone out of scope */ |
8990e307 LW |
203 | #define SVs_PADTMP 0x00000200 /* in use as tmp */ |
204 | #define SVs_PADMY 0x00000400 /* in use a "my" variable */ | |
205 | #define SVs_TEMP 0x00000800 /* string is stealable? */ | |
206 | #define SVs_OBJECT 0x00001000 /* is "blessed" */ | |
207 | #define SVs_GMG 0x00002000 /* has magical get method */ | |
208 | #define SVs_SMG 0x00004000 /* has magical set method */ | |
209 | #define SVs_RMG 0x00008000 /* has random magical methods */ | |
210 | ||
211 | #define SVf_IOK 0x00010000 /* has valid public integer value */ | |
212 | #define SVf_NOK 0x00020000 /* has valid public numeric value */ | |
213 | #define SVf_POK 0x00040000 /* has valid public pointer value */ | |
214 | #define SVf_ROK 0x00080000 /* has a valid reference pointer */ | |
a0d0e21e | 215 | |
748a9306 | 216 | #define SVf_FAKE 0x00100000 /* glob or lexical is just a copy */ |
b79f7545 NC |
217 | #define SVf_OOK 0x00200000 /* has valid offset value |
218 | For a PVHV this means that a | |
219 | hv_aux struct is present after the | |
220 | main array */ | |
645c22ef DM |
221 | #define SVf_BREAK 0x00400000 /* refcnt is artificially low - used |
222 | * by SV's in final arena cleanup */ | |
8990e307 LW |
223 | #define SVf_READONLY 0x00800000 /* may not be modified */ |
224 | ||
a0d0e21e | 225 | |
8990e307 LW |
226 | #define SVp_IOK 0x01000000 /* has valid non-public integer value */ |
227 | #define SVp_NOK 0x02000000 /* has valid non-public numeric value */ | |
228 | #define SVp_POK 0x04000000 /* has valid non-public pointer value */ | |
229 | #define SVp_SCREAM 0x08000000 /* has been studied? */ | |
230 | ||
446eaa42 | 231 | #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */ |
7a5fd60d | 232 | /* Ensure this value does not clash with the GV_ADD* flags in gv.h */ |
5bc28da9 | 233 | |
430eacda | 234 | #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE) |
5bc28da9 | 235 | |
a0d0e21e LW |
236 | #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \ |
237 | SVp_IOK|SVp_NOK|SVp_POK) | |
238 | ||
9e7bc3e8 | 239 | #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */ |
a0d0e21e | 240 | |
7b2a0f84 | 241 | #define PRIVSHIFT 8 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */ |
8990e307 LW |
242 | |
243 | /* Some private flags. */ | |
244 | ||
f472eb5c | 245 | /* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */ |
032d6771 | 246 | #define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */ |
524189f1 | 247 | #define SVpad_TYPED 0x40000000 /* Typed Lexical */ |
032d6771 | 248 | |
25da4f38 IZ |
249 | #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */ |
250 | ||
251 | #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */ | |
8990e307 LW |
252 | |
253 | #define SVpbm_VALID 0x80000000 | |
bbce6d69 | 254 | #define SVpbm_TAIL 0x40000000 |
8990e307 | 255 | |
25da4f38 IZ |
256 | #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */ |
257 | ||
9660f481 | 258 | #define SVphv_CLONEABLE 0x08000000 /* for stashes: clone its objects */ |
4b5190b5 | 259 | #define SVphv_REHASH 0x10000000 /* HV is recalculating hash values */ |
6bfc225d | 260 | #define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */ |
51594c39 | 261 | #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */ |
19692e8d | 262 | #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */ |
bf6bd887 | 263 | |
810b8aa5 GS |
264 | #define SVprv_WEAKREF 0x80000000 /* Weak reference */ |
265 | ||
11ca45c0 NC |
266 | #define SVpav_REAL 0x40000000 /* free old entries */ |
267 | #define SVpav_REIFY 0x80000000 /* can become real */ | |
268 | ||
79072805 | 269 | struct xpv { |
311a25d9 | 270 | NV xnv_nv; /* numeric value, if any */ |
339049b0 | 271 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
ed6116ce | 272 | STRLEN xpv_len; /* allocated size */ |
79072805 LW |
273 | }; |
274 | ||
9f1501b2 | 275 | #if 0 |
59813432 | 276 | typedef struct xpv xpv_allocated; |
9f1501b2 NC |
277 | #else |
278 | typedef struct { | |
339049b0 | 279 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
9f1501b2 NC |
280 | STRLEN xpv_len; /* allocated size */ |
281 | } xpv_allocated; | |
282 | #endif | |
59813432 | 283 | |
79072805 | 284 | struct xpviv { |
311a25d9 | 285 | NV xnv_nv; /* numeric value, if any */ |
339049b0 | 286 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
ed6116ce | 287 | STRLEN xpv_len; /* allocated size */ |
311a25d9 NC |
288 | union { |
289 | IV xivu_iv; /* integer value or pv offset */ | |
290 | UV xivu_uv; | |
291 | void * xivu_p1; | |
292 | } xiv_u; | |
79072805 LW |
293 | }; |
294 | ||
311a25d9 NC |
295 | #if 0 |
296 | typedef struct xpviv xpviv_allocated; | |
297 | #else | |
298 | typedef struct { | |
299 | STRLEN xpv_cur; /* length of svu_pv as a C string */ | |
300 | STRLEN xpv_len; /* allocated size */ | |
301 | union { | |
302 | IV xivu_iv; /* integer value or pv offset */ | |
303 | UV xivu_uv; | |
304 | void * xivu_p1; | |
305 | } xiv_u; | |
306 | } xpviv_allocated; | |
307 | #endif | |
308 | ||
309 | #define xiv_iv xiv_u.xivu_iv | |
310 | ||
ff68c719 | 311 | struct xpvuv { |
311a25d9 | 312 | NV xnv_nv; /* numeric value, if any */ |
339049b0 | 313 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
ff68c719 | 314 | STRLEN xpv_len; /* allocated size */ |
311a25d9 NC |
315 | union { |
316 | IV xuvu_iv; | |
317 | UV xuvu_uv; /* unsigned value or pv offset */ | |
318 | void * xuvu_p1; | |
319 | } xuv_u; | |
ff68c719 | 320 | }; |
321 | ||
311a25d9 NC |
322 | #define xuv_uv xuv_u.xuvu_uv |
323 | ||
79072805 | 324 | struct xpvnv { |
311a25d9 | 325 | NV xnv_nv; /* numeric value, if any */ |
339049b0 | 326 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
ed6116ce | 327 | STRLEN xpv_len; /* allocated size */ |
e4305a63 | 328 | union { |
311a25d9 NC |
329 | IV xivu_iv; /* integer value or pv offset */ |
330 | UV xivu_uv; | |
331 | void * xivu_p1; | |
332 | } xiv_u; | |
79072805 LW |
333 | }; |
334 | ||
6ee623d5 | 335 | /* These structure must match the beginning of struct xpvhv in hv.h. */ |
79072805 | 336 | struct xpvmg { |
311a25d9 | 337 | NV xnv_nv; /* numeric value, if any */ |
339049b0 | 338 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
ed6116ce | 339 | STRLEN xpv_len; /* allocated size */ |
e4305a63 | 340 | union { |
311a25d9 NC |
341 | IV xivu_iv; /* integer value or pv offset */ |
342 | UV xivu_uv; | |
343 | void * xivu_p1; | |
344 | } xiv_u; | |
79072805 LW |
345 | MAGIC* xmg_magic; /* linked list of magicalness */ |
346 | HV* xmg_stash; /* class package */ | |
347 | }; | |
348 | ||
349 | struct xpvlv { | |
311a25d9 | 350 | NV xnv_nv; /* numeric value, if any */ |
339049b0 | 351 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
ed6116ce | 352 | STRLEN xpv_len; /* allocated size */ |
e4305a63 | 353 | union { |
311a25d9 NC |
354 | IV xivu_iv; /* integer value or pv offset */ |
355 | UV xivu_uv; | |
356 | void * xivu_p1; | |
357 | } xiv_u; | |
79072805 LW |
358 | MAGIC* xmg_magic; /* linked list of magicalness */ |
359 | HV* xmg_stash; /* class package */ | |
8990e307 | 360 | |
4ce457a6 TP |
361 | /* a full glob fits into this */ |
362 | GP* xgv_gp; | |
363 | char* xgv_name; | |
364 | STRLEN xgv_namelen; | |
365 | HV* xgv_stash; | |
366 | U8 xgv_flags; | |
367 | ||
79072805 LW |
368 | STRLEN xlv_targoff; |
369 | STRLEN xlv_targlen; | |
370 | SV* xlv_targ; | |
dd28f7bb DM |
371 | char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re |
372 | * y=alem/helem/iter t=tie T=tied HE */ | |
79072805 LW |
373 | }; |
374 | ||
375 | struct xpvgv { | |
311a25d9 | 376 | NV xnv_nv; /* numeric value, if any */ |
339049b0 | 377 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
ed6116ce | 378 | STRLEN xpv_len; /* allocated size */ |
e4305a63 | 379 | union { |
311a25d9 NC |
380 | IV xivu_iv; /* integer value or pv offset */ |
381 | UV xivu_uv; | |
382 | void * xivu_p1; | |
383 | } xiv_u; | |
79072805 LW |
384 | MAGIC* xmg_magic; /* linked list of magicalness */ |
385 | HV* xmg_stash; /* class package */ | |
8990e307 | 386 | |
79072805 LW |
387 | GP* xgv_gp; |
388 | char* xgv_name; | |
389 | STRLEN xgv_namelen; | |
390 | HV* xgv_stash; | |
a5f75d66 | 391 | U8 xgv_flags; |
79072805 LW |
392 | }; |
393 | ||
394 | struct xpvbm { | |
311a25d9 | 395 | NV xnv_nv; /* numeric value, if any */ |
339049b0 | 396 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
ed6116ce | 397 | STRLEN xpv_len; /* allocated size */ |
e4305a63 | 398 | union { |
311a25d9 NC |
399 | IV xivu_iv; /* integer value or pv offset */ |
400 | UV xivu_uv; | |
401 | void * xivu_p1; | |
402 | } xiv_u; | |
79072805 LW |
403 | MAGIC* xmg_magic; /* linked list of magicalness */ |
404 | HV* xmg_stash; /* class package */ | |
8990e307 | 405 | |
79072805 LW |
406 | I32 xbm_useful; /* is this constant pattern being useful? */ |
407 | U16 xbm_previous; /* how many characters in string before rare? */ | |
408 | U8 xbm_rare; /* rarest character in string */ | |
409 | }; | |
410 | ||
fd40b977 | 411 | /* This structure must match XPVCV in cv.h */ |
44a8e56a | 412 | |
77a005ab MB |
413 | typedef U16 cv_flags_t; |
414 | ||
79072805 | 415 | struct xpvfm { |
311a25d9 | 416 | NV xnv_nv; /* numeric value, if any */ |
339049b0 | 417 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
ed6116ce | 418 | STRLEN xpv_len; /* allocated size */ |
e4305a63 | 419 | union { |
311a25d9 NC |
420 | IV xivu_iv; /* integer value or pv offset */ |
421 | UV xivu_uv; | |
422 | void * xivu_p1; | |
423 | } xiv_u; | |
79072805 LW |
424 | MAGIC* xmg_magic; /* linked list of magicalness */ |
425 | HV* xmg_stash; /* class package */ | |
8990e307 | 426 | |
79072805 LW |
427 | HV * xcv_stash; |
428 | OP * xcv_start; | |
429 | OP * xcv_root; | |
acfe0abc | 430 | void (*xcv_xsub)(pTHX_ CV*); |
a0d0e21e LW |
431 | ANY xcv_xsubany; |
432 | GV * xcv_gv; | |
57843af0 | 433 | char * xcv_file; |
b195d487 | 434 | long xcv_depth; /* >= 2 indicates recursive call */ |
79072805 | 435 | AV * xcv_padlist; |
748a9306 | 436 | CV * xcv_outside; |
77a005ab | 437 | cv_flags_t xcv_flags; |
a3985cdc DM |
438 | U32 xcv_outside_seq; /* the COP sequence (at the point of our |
439 | * compilation) in the lexically enclosing | |
440 | * sub */ | |
11a7ac70 | 441 | IV xfm_lines; |
79072805 LW |
442 | }; |
443 | ||
8990e307 | 444 | struct xpvio { |
311a25d9 | 445 | NV xnv_nv; /* numeric value, if any */ |
339049b0 | 446 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
8990e307 | 447 | STRLEN xpv_len; /* allocated size */ |
e4305a63 | 448 | union { |
311a25d9 NC |
449 | IV xivu_iv; /* integer value or pv offset */ |
450 | UV xivu_uv; | |
451 | void * xivu_p1; | |
452 | } xiv_u; | |
8990e307 LW |
453 | MAGIC* xmg_magic; /* linked list of magicalness */ |
454 | HV* xmg_stash; /* class package */ | |
455 | ||
760ac839 LW |
456 | PerlIO * xio_ifp; /* ifp and ofp are normally the same */ |
457 | PerlIO * xio_ofp; /* but sockets need separate streams */ | |
4755096e GS |
458 | /* Cray addresses everything by word boundaries (64 bits) and |
459 | * code and data pointers cannot be mixed (which is exactly what | |
460 | * Perl_filter_add() tries to do with the dirp), hence the following | |
461 | * union trick (as suggested by Gurusamy Sarathy). | |
462 | * For further information see Geir Johansen's problem report titled | |
463 | [ID 20000612.002] Perl problem on Cray system | |
464 | * The any pointer (known as IoANY()) will also be a good place | |
465 | * to hang any IO disciplines to. | |
466 | */ | |
467 | union { | |
468 | DIR * xiou_dirp; /* for opendir, readdir, etc */ | |
469 | void * xiou_any; /* for alignment */ | |
470 | } xio_dirpu; | |
11a7ac70 JH |
471 | IV xio_lines; /* $. */ |
472 | IV xio_page; /* $% */ | |
473 | IV xio_page_len; /* $= */ | |
474 | IV xio_lines_left; /* $- */ | |
8990e307 LW |
475 | char * xio_top_name; /* $^ */ |
476 | GV * xio_top_gv; /* $^ */ | |
477 | char * xio_fmt_name; /* $~ */ | |
478 | GV * xio_fmt_gv; /* $~ */ | |
479 | char * xio_bottom_name;/* $^B */ | |
480 | GV * xio_bottom_gv; /* $^B */ | |
481 | short xio_subprocess; /* -| or |- */ | |
482 | char xio_type; | |
483 | char xio_flags; | |
484 | }; | |
4755096e GS |
485 | #define xio_dirp xio_dirpu.xiou_dirp |
486 | #define xio_any xio_dirpu.xiou_any | |
8990e307 | 487 | |
e0c19803 GS |
488 | #define IOf_ARGV 1 /* this fp iterates over ARGV */ |
489 | #define IOf_START 2 /* check for null ARGV and substitute '-' */ | |
490 | #define IOf_FLUSH 4 /* this fp wants a flush after write op */ | |
491 | #define IOf_DIDTOP 8 /* just did top of form */ | |
492 | #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */ | |
493 | #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */ | |
494 | #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */ | |
8990e307 | 495 | |
ed6116ce LW |
496 | /* The following macros define implementation-independent predicates on SVs. */ |
497 | ||
954c1994 GS |
498 | /* |
499 | =for apidoc Am|bool|SvNIOK|SV* sv | |
500 | Returns a boolean indicating whether the SV contains a number, integer or | |
501 | double. | |
502 | ||
503 | =for apidoc Am|bool|SvNIOKp|SV* sv | |
504 | Returns a boolean indicating whether the SV contains a number, integer or | |
505 | double. Checks the B<private> setting. Use C<SvNIOK>. | |
506 | ||
507 | =for apidoc Am|void|SvNIOK_off|SV* sv | |
508 | Unsets the NV/IV status of an SV. | |
509 | ||
510 | =for apidoc Am|bool|SvOK|SV* sv | |
9adebda4 SB |
511 | Returns a boolean indicating whether the value is an SV. It also tells |
512 | whether the value is defined or not. | |
954c1994 GS |
513 | |
514 | =for apidoc Am|bool|SvIOKp|SV* sv | |
515 | Returns a boolean indicating whether the SV contains an integer. Checks | |
516 | the B<private> setting. Use C<SvIOK>. | |
517 | ||
518 | =for apidoc Am|bool|SvNOKp|SV* sv | |
519 | Returns a boolean indicating whether the SV contains a double. Checks the | |
520 | B<private> setting. Use C<SvNOK>. | |
521 | ||
522 | =for apidoc Am|bool|SvPOKp|SV* sv | |
523 | Returns a boolean indicating whether the SV contains a character string. | |
524 | Checks the B<private> setting. Use C<SvPOK>. | |
525 | ||
526 | =for apidoc Am|bool|SvIOK|SV* sv | |
527 | Returns a boolean indicating whether the SV contains an integer. | |
528 | ||
529 | =for apidoc Am|void|SvIOK_on|SV* sv | |
530 | Tells an SV that it is an integer. | |
531 | ||
532 | =for apidoc Am|void|SvIOK_off|SV* sv | |
533 | Unsets the IV status of an SV. | |
534 | ||
535 | =for apidoc Am|void|SvIOK_only|SV* sv | |
536 | Tells an SV that it is an integer and disables all other OK bits. | |
537 | ||
e331fc52 JH |
538 | =for apidoc Am|void|SvIOK_only_UV|SV* sv |
539 | Tells and SV that it is an unsigned integer and disables all other OK bits. | |
540 | ||
12fa07df | 541 | =for apidoc Am|bool|SvIOK_UV|SV* sv |
e331fc52 JH |
542 | Returns a boolean indicating whether the SV contains an unsigned integer. |
543 | ||
28e5dec8 JH |
544 | =for apidoc Am|void|SvUOK|SV* sv |
545 | Returns a boolean indicating whether the SV contains an unsigned integer. | |
546 | ||
12fa07df | 547 | =for apidoc Am|bool|SvIOK_notUV|SV* sv |
d1be9408 | 548 | Returns a boolean indicating whether the SV contains a signed integer. |
e331fc52 | 549 | |
954c1994 GS |
550 | =for apidoc Am|bool|SvNOK|SV* sv |
551 | Returns a boolean indicating whether the SV contains a double. | |
552 | ||
553 | =for apidoc Am|void|SvNOK_on|SV* sv | |
554 | Tells an SV that it is a double. | |
555 | ||
556 | =for apidoc Am|void|SvNOK_off|SV* sv | |
557 | Unsets the NV status of an SV. | |
558 | ||
559 | =for apidoc Am|void|SvNOK_only|SV* sv | |
560 | Tells an SV that it is a double and disables all other OK bits. | |
561 | ||
562 | =for apidoc Am|bool|SvPOK|SV* sv | |
563 | Returns a boolean indicating whether the SV contains a character | |
564 | string. | |
565 | ||
566 | =for apidoc Am|void|SvPOK_on|SV* sv | |
567 | Tells an SV that it is a string. | |
568 | ||
569 | =for apidoc Am|void|SvPOK_off|SV* sv | |
570 | Unsets the PV status of an SV. | |
571 | ||
572 | =for apidoc Am|void|SvPOK_only|SV* sv | |
573 | Tells an SV that it is a string and disables all other OK bits. | |
1e54db1a | 574 | Will also turn off the UTF-8 status. |
954c1994 | 575 | |
b0f01acb JP |
576 | =for apidoc Am|bool|SvVOK|SV* sv |
577 | Returns a boolean indicating whether the SV contains a v-string. | |
578 | ||
954c1994 GS |
579 | =for apidoc Am|bool|SvOOK|SV* sv |
580 | Returns a boolean indicating whether the SvIVX is a valid offset value for | |
581 | the SvPVX. This hack is used internally to speed up removal of characters | |
582 | from the beginning of a SvPV. When SvOOK is true, then the start of the | |
583 | allocated string buffer is really (SvPVX - SvIVX). | |
584 | ||
585 | =for apidoc Am|bool|SvROK|SV* sv | |
586 | Tests if the SV is an RV. | |
587 | ||
588 | =for apidoc Am|void|SvROK_on|SV* sv | |
589 | Tells an SV that it is an RV. | |
590 | ||
591 | =for apidoc Am|void|SvROK_off|SV* sv | |
592 | Unsets the RV status of an SV. | |
593 | ||
594 | =for apidoc Am|SV*|SvRV|SV* sv | |
595 | Dereferences an RV to return the SV. | |
596 | ||
597 | =for apidoc Am|IV|SvIVX|SV* sv | |
645c22ef DM |
598 | Returns the raw value in the SV's IV slot, without checks or conversions. |
599 | Only use when you are sure SvIOK is true. See also C<SvIV()>. | |
954c1994 GS |
600 | |
601 | =for apidoc Am|UV|SvUVX|SV* sv | |
645c22ef DM |
602 | Returns the raw value in the SV's UV slot, without checks or conversions. |
603 | Only use when you are sure SvIOK is true. See also C<SvUV()>. | |
954c1994 GS |
604 | |
605 | =for apidoc Am|NV|SvNVX|SV* sv | |
645c22ef DM |
606 | Returns the raw value in the SV's NV slot, without checks or conversions. |
607 | Only use when you are sure SvNOK is true. See also C<SvNV()>. | |
954c1994 GS |
608 | |
609 | =for apidoc Am|char*|SvPVX|SV* sv | |
645c22ef | 610 | Returns a pointer to the physical string in the SV. The SV must contain a |
954c1994 GS |
611 | string. |
612 | ||
613 | =for apidoc Am|STRLEN|SvCUR|SV* sv | |
614 | Returns the length of the string which is in the SV. See C<SvLEN>. | |
615 | ||
616 | =for apidoc Am|STRLEN|SvLEN|SV* sv | |
659239a4 MG |
617 | Returns the size of the string buffer in the SV, not including any part |
618 | attributable to C<SvOOK>. See C<SvCUR>. | |
954c1994 GS |
619 | |
620 | =for apidoc Am|char*|SvEND|SV* sv | |
621 | Returns a pointer to the last character in the string which is in the SV. | |
622 | See C<SvCUR>. Access the character as *(SvEND(sv)). | |
623 | ||
624 | =for apidoc Am|HV*|SvSTASH|SV* sv | |
625 | Returns the stash of the SV. | |
626 | ||
672994ce | 627 | =for apidoc Am|void|SvIV_set|SV* sv|IV val |
20799e15 SP |
628 | Set the value of the IV pointer in sv to val. It is possible to perform |
629 | the same function of this macro with an lvalue assignment to C<SvIVX>. | |
630 | With future Perls, however, it will be more efficient to use | |
631 | C<SvIV_set> instead of the lvalue assignment to C<SvIVX>. | |
672994ce SP |
632 | |
633 | =for apidoc Am|void|SvNV_set|SV* sv|NV val | |
20799e15 | 634 | Set the value of the NV pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
635 | |
636 | =for apidoc Am|void|SvPV_set|SV* sv|char* val | |
20799e15 | 637 | Set the value of the PV pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
638 | |
639 | =for apidoc Am|void|SvUV_set|SV* sv|UV val | |
20799e15 | 640 | Set the value of the UV pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
641 | |
642 | =for apidoc Am|void|SvRV_set|SV* sv|SV* val | |
20799e15 | 643 | Set the value of the RV pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
644 | |
645 | =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val | |
20799e15 | 646 | Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
647 | |
648 | =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val | |
20799e15 | 649 | Set the value of the STASH pointer in sv to val. See C<SvIV_set>. |
672994ce | 650 | |
954c1994 | 651 | =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len |
20799e15 SP |
652 | Set the current length of the string which is in the SV. See C<SvCUR> |
653 | and C<SvIV_set>. | |
672994ce SP |
654 | |
655 | =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len | |
20799e15 | 656 | Set the actual length of the string which is in the SV. See C<SvIV_set>. |
954c1994 GS |
657 | |
658 | =cut | |
659 | */ | |
660 | ||
79072805 | 661 | #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK)) |
748a9306 | 662 | #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK)) |
a0d0e21e | 663 | #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \ |
25da4f38 | 664 | SVp_IOK|SVp_NOK|SVf_IVisUV)) |
79072805 | 665 | |
5dc8bdac | 666 | #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) |
29e97371 | 667 | #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}), |
906ed6d6 | 668 | #else |
54866b45 | 669 | #define assert_not_ROK(sv) |
906ed6d6 NC |
670 | #endif |
671 | ||
463ee0b2 | 672 | #define SvOK(sv) (SvFLAGS(sv) & SVf_OK) |
54866b45 | 673 | #define SvOK_off(sv) (assert_not_ROK(sv) \ |
906ed6d6 | 674 | SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \ |
d41ff1b8 | 675 | SVf_IVisUV|SVf_UTF8), \ |
25da4f38 | 676 | SvOOK_off(sv)) |
54866b45 | 677 | #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \ |
906ed6d6 | 678 | SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \ |
d41ff1b8 | 679 | SVf_UTF8), \ |
a0d0e21e | 680 | SvOOK_off(sv)) |
79072805 | 681 | |
8990e307 LW |
682 | #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) |
683 | #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK) | |
46187eeb | 684 | #define SvIOKp_on(sv) (SvRELEASE_IVX(sv), \ |
765f542d | 685 | SvFLAGS(sv) |= SVp_IOK) |
8990e307 LW |
686 | #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK) |
687 | #define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK) | |
688 | #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK) | |
54866b45 | 689 | #define SvPOKp_on(sv) (assert_not_ROK(sv) \ |
906ed6d6 | 690 | SvFLAGS(sv) |= SVp_POK) |
463ee0b2 | 691 | |
79072805 | 692 | #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK) |
46187eeb | 693 | #define SvIOK_on(sv) (SvRELEASE_IVX(sv), \ |
765f542d | 694 | SvFLAGS(sv) |= (SVf_IOK|SVp_IOK)) |
25da4f38 | 695 | #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV)) |
0c34ef67 | 696 | #define SvIOK_only(sv) (SvOK_off(sv), \ |
a0d0e21e | 697 | SvFLAGS(sv) |= (SVf_IOK|SVp_IOK)) |
0c34ef67 | 698 | #define SvIOK_only_UV(sv) (SvOK_off_exc_UV(sv), \ |
25da4f38 | 699 | SvFLAGS(sv) |= (SVf_IOK|SVp_IOK)) |
70401c6b | 700 | |
25da4f38 IZ |
701 | #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \ |
702 | == (SVf_IOK|SVf_IVisUV)) | |
28e5dec8 | 703 | #define SvUOK(sv) SvIOK_UV(sv) |
25da4f38 IZ |
704 | #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \ |
705 | == SVf_IOK) | |
706 | ||
707 | #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV) | |
708 | #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV) | |
709 | #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV) | |
79072805 LW |
710 | |
711 | #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK) | |
a0d0e21e | 712 | #define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK)) |
8990e307 | 713 | #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK)) |
0c34ef67 | 714 | #define SvNOK_only(sv) (SvOK_off(sv), \ |
a0d0e21e | 715 | SvFLAGS(sv) |= (SVf_NOK|SVp_NOK)) |
79072805 | 716 | |
914184e1 | 717 | /* |
12fa07df | 718 | =for apidoc Am|bool|SvUTF8|SV* sv |
914184e1 JH |
719 | Returns a boolean indicating whether the SV contains UTF-8 encoded data. |
720 | ||
721 | =for apidoc Am|void|SvUTF8_on|SV *sv | |
1e54db1a | 722 | Turn on the UTF-8 status of an SV (the data is not changed, just the flag). |
d5ce4a7c | 723 | Do not use frivolously. |
914184e1 JH |
724 | |
725 | =for apidoc Am|void|SvUTF8_off|SV *sv | |
1e54db1a | 726 | Unsets the UTF-8 status of an SV. |
914184e1 JH |
727 | |
728 | =for apidoc Am|void|SvPOK_only_UTF8|SV* sv | |
d5ce4a7c | 729 | Tells an SV that it is a string and disables all other OK bits, |
1e54db1a | 730 | and leaves the UTF-8 status as it was. |
f1a1024e | 731 | |
914184e1 JH |
732 | =cut |
733 | */ | |
734 | ||
7a5fd60d NC |
735 | /* Ensure the return value of this macro does not clash with the GV_ADD* flags |
736 | in gv.h: */ | |
a7cb1f99 GS |
737 | #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8) |
738 | #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8)) | |
739 | #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8)) | |
5bc28da9 | 740 | |
79072805 | 741 | #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK) |
54866b45 | 742 | #define SvPOK_on(sv) (assert_not_ROK(sv) \ |
906ed6d6 | 743 | SvFLAGS(sv) |= (SVf_POK|SVp_POK)) |
8990e307 | 744 | #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK)) |
54866b45 | 745 | #define SvPOK_only(sv) (assert_not_ROK(sv) \ |
906ed6d6 | 746 | SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \ |
d41ff1b8 GS |
747 | SVf_IVisUV|SVf_UTF8), \ |
748 | SvFLAGS(sv) |= (SVf_POK|SVp_POK)) | |
54866b45 | 749 | #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) \ |
906ed6d6 | 750 | SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \ |
d41ff1b8 | 751 | SVf_IVisUV), \ |
a0d0e21e | 752 | SvFLAGS(sv) |= (SVf_POK|SVp_POK)) |
79072805 | 753 | |
4f2da183 NC |
754 | #define SvVOK(sv) (SvMAGICAL(sv) \ |
755 | ? mg_find(sv,PERL_MAGIC_vstring) : NULL) | |
79072805 | 756 | #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK) |
155aba94 | 757 | #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK) |
0c34ef67 | 758 | #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv))) |
79072805 | 759 | |
a0d0e21e LW |
760 | #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE) |
761 | #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE) | |
762 | #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE) | |
763 | ||
ed6116ce | 764 | #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK) |
a0d0e21e | 765 | #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK) |
a0d0e21e | 766 | #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC)) |
79072805 | 767 | |
8990e307 LW |
768 | #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG)) |
769 | #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG)) | |
770 | #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG)) | |
79072805 | 771 | |
8990e307 LW |
772 | #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG) |
773 | #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG) | |
774 | #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG) | |
ed6116ce | 775 | |
8990e307 LW |
776 | #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG) |
777 | #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG) | |
778 | #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG) | |
ed6116ce | 779 | |
8990e307 LW |
780 | #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG) |
781 | #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG) | |
782 | #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG) | |
ed6116ce | 783 | |
9e7bc3e8 JD |
784 | #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC) |
785 | #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC) | |
786 | #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC) | |
a0d0e21e | 787 | |
8cf8f3d1 | 788 | #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC)) |
1426bbf4 | 789 | |
a0d0e21e LW |
790 | /* |
791 | #define Gv_AMG(stash) \ | |
792 | (HV_AMAGICmb(stash) && \ | |
793 | ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash))) | |
794 | */ | |
3280af22 | 795 | #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash)) |
a0d0e21e | 796 | |
810b8aa5 GS |
797 | #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \ |
798 | == (SVf_ROK|SVprv_WEAKREF)) | |
799 | #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF)) | |
800 | #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF)) | |
801 | ||
a0d0e21e | 802 | #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST) |
ed6116ce | 803 | |
d9d18af6 DM |
804 | #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE) |
805 | #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE) | |
806 | #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE) | |
807 | ||
8990e307 | 808 | #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP) |
235cc2e3 | 809 | #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP) |
8990e307 | 810 | #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP) |
ed6116ce | 811 | |
8990e307 | 812 | #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY) |
235cc2e3 | 813 | #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY) |
ed6116ce | 814 | |
8990e307 LW |
815 | #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP) |
816 | #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP) | |
817 | #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP) | |
79072805 | 818 | |
8990e307 LW |
819 | #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT) |
820 | #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT) | |
821 | #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT) | |
79072805 | 822 | |
8990e307 LW |
823 | #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY) |
824 | #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY) | |
825 | #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY) | |
79072805 | 826 | |
8990e307 LW |
827 | #define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM) |
828 | #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM) | |
829 | #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM) | |
79072805 | 830 | |
8990e307 LW |
831 | #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED) |
832 | #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED) | |
833 | #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED) | |
79072805 | 834 | |
25da4f38 IZ |
835 | #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL) |
836 | #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL) | |
837 | #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL) | |
838 | ||
8990e307 LW |
839 | #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL) |
840 | #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL) | |
841 | #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL) | |
842 | ||
8990e307 LW |
843 | #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID) |
844 | #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID) | |
845 | #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID) | |
846 | ||
1cc8b4c5 AB |
847 | #ifdef USE_ITHREADS |
848 | /* The following uses the FAKE flag to show that a regex pointer is infact | |
8ca6097c | 849 | its own offset in the regexpad for ithreads */ |
1cc8b4c5 AB |
850 | #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE) |
851 | #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE) | |
852 | #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE) | |
853 | #endif | |
854 | ||
b162af07 | 855 | #ifdef PERL_DEBUG_COW |
339049b0 | 856 | #define SvRV(sv) (0 + (sv)->sv_u.svu_rv) |
b162af07 | 857 | #else |
339049b0 | 858 | #define SvRV(sv) ((sv)->sv_u.svu_rv) |
b162af07 | 859 | #endif |
ed6116ce LW |
860 | #define SvRVx(sv) SvRV(sv) |
861 | ||
f599b64b | 862 | #ifdef PERL_DEBUG_COW |
8ed30cc1 DD |
863 | /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because |
864 | +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */ | |
771ba71a NC |
865 | # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv) |
866 | # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv) | |
8ed30cc1 | 867 | # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_nv) |
c0e1089a | 868 | /* Don't test the core XS code yet. */ |
771ba71a NC |
869 | # if defined (PERL_CORE) && PERL_DEBUG_COW > 1 |
870 | # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv)) | |
871 | # else | |
872 | # define SvPVX(sv) SvPVX_mutable(sv) | |
873 | # endif | |
771ba71a NC |
874 | # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur) |
875 | # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len) | |
876 | # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur) | |
877 | ||
878 | # ifdef DEBUGGING | |
879 | # ifdef PERL_IN_SV_C | |
62703e72 | 880 | /* Can't make this RVALUE because of Perl_sv_unmagic. */ |
771ba71a NC |
881 | # define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic)) |
882 | # else | |
883 | # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic)) | |
884 | # endif | |
885 | # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash)) | |
03687789 | 886 | # else |
771ba71a NC |
887 | # ifdef PERL_IN_SV_C |
888 | # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic | |
889 | # else | |
890 | # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_magic) | |
891 | # endif | |
892 | # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash) | |
03687789 | 893 | # endif |
f599b64b | 894 | #else |
771ba71a NC |
895 | # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv |
896 | # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv | |
897 | # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_nv | |
898 | # define SvPVX(sv) ((sv)->sv_u.svu_pv) | |
771ba71a NC |
899 | # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur |
900 | # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len | |
901 | # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur) | |
902 | ||
903 | # ifdef DEBUGGING | |
904 | # define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic)) | |
905 | # define SvSTASH(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash)) | |
03687789 | 906 | # else |
771ba71a NC |
907 | # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic |
908 | # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash | |
03687789 | 909 | # endif |
62703e72 NC |
910 | #endif |
911 | ||
06c0cc96 | 912 | #ifndef PERL_POISON |
bb496845 SP |
913 | /* Given that these two are new, there can't be any existing code using them |
914 | * as LVALUEs */ | |
06c0cc96 NC |
915 | # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv) |
916 | # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv)) | |
917 | #else | |
918 | /* Except for the poison code, which uses & to scribble over the pointer after | |
919 | free() is called. */ | |
920 | # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv) | |
921 | # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv)) | |
922 | #endif | |
bb496845 | 923 | |
62703e72 NC |
924 | #define SvIVXx(sv) SvIVX(sv) |
925 | #define SvUVXx(sv) SvUVX(sv) | |
926 | #define SvNVXx(sv) SvNVX(sv) | |
927 | #define SvPVXx(sv) SvPVX(sv) | |
928 | #define SvLENx(sv) SvLEN(sv) | |
929 | #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv)) | |
930 | ||
931 | ||
28e5dec8 JH |
932 | /* Ask a scalar nicely to try to become an IV, if possible. |
933 | Not guaranteed to stay returning void */ | |
934 | /* Macro won't actually call sv_2iv if already IOK */ | |
935 | #define SvIV_please(sv) \ | |
936 | STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \ | |
937 | (void) SvIV(sv); } STMT_END | |
79072805 | 938 | #define SvIV_set(sv, val) \ |
80b92232 | 939 | STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \ |
b19bbeda | 940 | (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END |
79072805 | 941 | #define SvNV_set(sv, val) \ |
80b92232 | 942 | STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \ |
7ffec4a4 | 943 | assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \ |
f599b64b | 944 | (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END |
79072805 | 945 | #define SvPV_set(sv, val) \ |
80b92232 | 946 | STMT_START { assert(SvTYPE(sv) >= SVt_PV); \ |
339049b0 | 947 | ((sv)->sv_u.svu_pv = (val)); } STMT_END |
607fa7f2 SP |
948 | #define SvUV_set(sv, val) \ |
949 | STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \ | |
950 | (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END | |
b162af07 SP |
951 | #define SvRV_set(sv, val) \ |
952 | STMT_START { assert(SvTYPE(sv) >= SVt_RV); \ | |
339049b0 | 953 | ((sv)->sv_u.svu_rv = (val)); } STMT_END |
b162af07 SP |
954 | #define SvMAGIC_set(sv, val) \ |
955 | STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \ | |
956 | (((XPVMG*)SvANY(sv))->xmg_magic = (val)); } STMT_END | |
957 | #define SvSTASH_set(sv, val) \ | |
958 | STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \ | |
959 | (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END | |
79072805 | 960 | #define SvCUR_set(sv, val) \ |
80b92232 | 961 | STMT_START { assert(SvTYPE(sv) >= SVt_PV); \ |
b162af07 | 962 | (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END |
79072805 | 963 | #define SvLEN_set(sv, val) \ |
80b92232 | 964 | STMT_START { assert(SvTYPE(sv) >= SVt_PV); \ |
b162af07 | 965 | (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END |
7ae8ee9e NC |
966 | #define SvEND_set(sv, val) \ |
967 | STMT_START { assert(SvTYPE(sv) >= SVt_PV); \ | |
968 | (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END | |
79072805 | 969 | |
b7e9a5c2 | 970 | #define SvPV_renew(sv,n) \ |
1da4ca5f NC |
971 | STMT_START { SvLEN_set(sv, n); \ |
972 | SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \ | |
973 | (char*)saferealloc((Malloc_t)SvPVX(sv), \ | |
974 | (MEM_SIZE)((n))))); \ | |
975 | } STMT_END | |
976 | ||
977 | #define SvPV_shrink_to_cur(sv) STMT_START { \ | |
978 | const STRLEN _lEnGtH = SvCUR(sv) + 1; \ | |
979 | SvPV_renew(sv, _lEnGtH); \ | |
980 | } STMT_END | |
b7e9a5c2 | 981 | |
771ba71a NC |
982 | #define SvPV_free(sv) \ |
983 | STMT_START { \ | |
984 | assert(SvTYPE(sv) >= SVt_PV); \ | |
985 | if (SvLEN(sv)) { \ | |
986 | if(SvOOK(sv)) { \ | |
987 | SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \ | |
988 | SvFLAGS(sv) &= ~SVf_OOK; \ | |
989 | } \ | |
990 | Safefree(SvPVX(sv)); \ | |
991 | } \ | |
992 | } STMT_END | |
8bd4d4c5 | 993 | |
79072805 LW |
994 | #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare |
995 | #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful | |
996 | #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous | |
997 | ||
998 | #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines | |
999 | ||
1000 | #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type | |
1001 | #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ | |
1002 | #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff | |
1003 | #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen | |
1004 | ||
8990e307 LW |
1005 | #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp |
1006 | #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp | |
1007 | #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp | |
4755096e | 1008 | #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any |
8990e307 LW |
1009 | #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines |
1010 | #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page | |
1011 | #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len | |
1012 | #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left | |
1013 | #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name | |
1014 | #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv | |
1015 | #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name | |
1016 | #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv | |
1017 | #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name | |
1018 | #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv | |
1019 | #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess | |
1020 | #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type | |
1021 | #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags | |
1022 | ||
50952442 | 1023 | /* IoTYPE(sv) is a single character telling the type of I/O connection. */ |
3b6c1aba JH |
1024 | #define IoTYPE_RDONLY '<' |
1025 | #define IoTYPE_WRONLY '>' | |
1026 | #define IoTYPE_RDWR '+' | |
1027 | #define IoTYPE_APPEND 'a' | |
1028 | #define IoTYPE_PIPE '|' | |
1029 | #define IoTYPE_STD '-' /* stdin or stdout */ | |
1030 | #define IoTYPE_SOCKET 's' | |
1031 | #define IoTYPE_CLOSED ' ' | |
1032 | #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */ | |
1033 | #define IoTYPE_NUMERIC '#' /* fdopen */ | |
03fcf2fc GS |
1034 | |
1035 | /* | |
954c1994 GS |
1036 | =for apidoc Am|bool|SvTAINTED|SV* sv |
1037 | Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if | |
1038 | not. | |
1039 | ||
1040 | =for apidoc Am|void|SvTAINTED_on|SV* sv | |
c55831ac | 1041 | Marks an SV as tainted if tainting is enabled. |
954c1994 GS |
1042 | |
1043 | =for apidoc Am|void|SvTAINTED_off|SV* sv | |
1044 | Untaints an SV. Be I<very> careful with this routine, as it short-circuits | |
1045 | some of Perl's fundamental security features. XS module authors should not | |
1046 | use this function unless they fully understand all the implications of | |
1047 | unconditionally untainting the value. Untainting should be done in the | |
1048 | standard perl fashion, via a carefully crafted regexp, rather than directly | |
1049 | untainting variables. | |
1050 | ||
1051 | =for apidoc Am|void|SvTAINT|SV* sv | |
c55831ac | 1052 | Taints an SV if tainting is enabled. |
954c1994 GS |
1053 | |
1054 | =cut | |
1055 | */ | |
1056 | ||
a0714e2c | 1057 | #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0) |
aae9cea0 | 1058 | |
bbce6d69 | 1059 | #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv)) |
3280af22 NIS |
1060 | #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END |
1061 | #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END | |
bbce6d69 | 1062 | |
c6ee37c5 MB |
1063 | #define SvTAINT(sv) \ |
1064 | STMT_START { \ | |
3280af22 | 1065 | if (PL_tainting) { \ |
3280af22 | 1066 | if (PL_tainted) \ |
c6ee37c5 MB |
1067 | SvTAINTED_on(sv); \ |
1068 | } \ | |
1069 | } STMT_END | |
79072805 | 1070 | |
954c1994 GS |
1071 | /* |
1072 | =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len | |
5f08bad4 ST |
1073 | Like C<SvPV> but will force the SV into containing just a string |
1074 | (C<SvPOK_only>). You want force if you are going to update the C<SvPVX> | |
1075 | directly. | |
954c1994 | 1076 | |
645c22ef | 1077 | =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len |
5f08bad4 ST |
1078 | Like C<SvPV> but will force the SV into containing just a string |
1079 | (C<SvPOK_only>). You want force if you are going to update the C<SvPVX> | |
1080 | directly. Doesn't process magic. | |
645c22ef | 1081 | |
954c1994 | 1082 | =for apidoc Am|char*|SvPV|SV* sv|STRLEN len |
5f08bad4 ST |
1083 | Returns a pointer to the string in the SV, or a stringified form of |
1084 | the SV if the SV does not contain a string. The SV may cache the | |
1085 | stringified version becoming C<SvPOK>. Handles 'get' magic. See also | |
645c22ef DM |
1086 | C<SvPVx> for a version which guarantees to evaluate sv only once. |
1087 | ||
1088 | =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len | |
1089 | A version of C<SvPV> which guarantees to evaluate sv only once. | |
954c1994 | 1090 | |
891f9566 YST |
1091 | =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len |
1092 | Like C<SvPV> but doesn't process magic. | |
1093 | ||
954c1994 | 1094 | =for apidoc Am|char*|SvPV_nolen|SV* sv |
5f08bad4 ST |
1095 | Returns a pointer to the string in the SV, or a stringified form of |
1096 | the SV if the SV does not contain a string. The SV may cache the | |
1097 | stringified form becoming C<SvPOK>. Handles 'get' magic. | |
954c1994 GS |
1098 | |
1099 | =for apidoc Am|IV|SvIV|SV* sv | |
645c22ef DM |
1100 | Coerces the given SV to an integer and returns it. See C<SvIVx> for a |
1101 | version which guarantees to evaluate sv only once. | |
1102 | ||
891f9566 YST |
1103 | =for apidoc Am|IV|SvIV_nomg|SV* sv |
1104 | Like C<SvIV> but doesn't process magic. | |
1105 | ||
645c22ef DM |
1106 | =for apidoc Am|IV|SvIVx|SV* sv |
1107 | Coerces the given SV to an integer and returns it. Guarantees to evaluate | |
d1be9408 | 1108 | sv only once. Use the more efficient C<SvIV> otherwise. |
954c1994 GS |
1109 | |
1110 | =for apidoc Am|NV|SvNV|SV* sv | |
645c22ef DM |
1111 | Coerce the given SV to a double and return it. See C<SvNVx> for a version |
1112 | which guarantees to evaluate sv only once. | |
1113 | ||
1114 | =for apidoc Am|NV|SvNVx|SV* sv | |
1115 | Coerces the given SV to a double and returns it. Guarantees to evaluate | |
d1be9408 | 1116 | sv only once. Use the more efficient C<SvNV> otherwise. |
954c1994 GS |
1117 | |
1118 | =for apidoc Am|UV|SvUV|SV* sv | |
645c22ef DM |
1119 | Coerces the given SV to an unsigned integer and returns it. See C<SvUVx> |
1120 | for a version which guarantees to evaluate sv only once. | |
1121 | ||
891f9566 YST |
1122 | =for apidoc Am|UV|SvUV_nomg|SV* sv |
1123 | Like C<SvUV> but doesn't process magic. | |
1124 | ||
645c22ef DM |
1125 | =for apidoc Am|UV|SvUVx|SV* sv |
1126 | Coerces the given SV to an unsigned integer and returns it. Guarantees to | |
d1be9408 | 1127 | evaluate sv only once. Use the more efficient C<SvUV> otherwise. |
954c1994 GS |
1128 | |
1129 | =for apidoc Am|bool|SvTRUE|SV* sv | |
1130 | Returns a boolean indicating whether Perl would evaluate the SV as true or | |
1131 | false, defined or undefined. Does not handle 'get' magic. | |
1132 | ||
645c22ef | 1133 | =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len |
b70b15d2 | 1134 | Like C<SvPV_force>, but converts sv to utf8 first if necessary. |
645c22ef DM |
1135 | |
1136 | =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len | |
b70b15d2 | 1137 | Like C<SvPV>, but converts sv to utf8 first if necessary. |
645c22ef | 1138 | |
b70b15d2 TJ |
1139 | =for apidoc Am|char*|SvPVutf8_nolen|SV* sv |
1140 | Like C<SvPV_nolen>, but converts sv to utf8 first if necessary. | |
645c22ef DM |
1141 | |
1142 | =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len | |
1143 | Like C<SvPV_force>, but converts sv to byte representation first if necessary. | |
1144 | ||
1145 | =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len | |
1146 | Like C<SvPV>, but converts sv to byte representation first if necessary. | |
1147 | ||
b70b15d2 | 1148 | =for apidoc Am|char*|SvPVbyte_nolen|SV* sv |
645c22ef DM |
1149 | Like C<SvPV_nolen>, but converts sv to byte representation first if necessary. |
1150 | ||
1151 | =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len | |
b70b15d2 | 1152 | Like C<SvPV_force>, but converts sv to utf8 first if necessary. |
d1be9408 | 1153 | Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force> |
645c22ef DM |
1154 | otherwise. |
1155 | ||
1156 | =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len | |
b70b15d2 | 1157 | Like C<SvPV>, but converts sv to utf8 first if necessary. |
d1be9408 | 1158 | Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8> |
645c22ef DM |
1159 | otherwise. |
1160 | ||
1161 | =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len | |
1162 | Like C<SvPV_force>, but converts sv to byte representation first if necessary. | |
d1be9408 | 1163 | Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force> |
645c22ef DM |
1164 | otherwise. |
1165 | ||
1166 | =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len | |
1167 | Like C<SvPV>, but converts sv to byte representation first if necessary. | |
d1be9408 | 1168 | Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte> |
645c22ef DM |
1169 | otherwise. |
1170 | ||
19dbb8f1 NC |
1171 | =for apidoc Am|bool|SvIsCOW|SV* sv |
1172 | Returns a boolean indicating whether the SV is Copy-On-Write. (either shared | |
1173 | hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for | |
1174 | COW) | |
1175 | ||
1176 | =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv | |
1177 | Returns a boolean indicating whether the SV is Copy-On-Write shared hash key | |
1178 | scalar. | |
645c22ef | 1179 | |
0f76ff59 MHM |
1180 | =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len |
1181 | Like C<sv_catpvn> but doesn't process magic. | |
1182 | ||
1183 | =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv | |
1184 | Like C<sv_setsv> but doesn't process magic. | |
1185 | ||
1186 | =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv | |
1187 | Like C<sv_catsv> but doesn't process magic. | |
1188 | ||
954c1994 GS |
1189 | =cut |
1190 | */ | |
1191 | ||
25da4f38 | 1192 | /* Let us hope that bitmaps for UV and IV are the same */ |
463ee0b2 | 1193 | #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv)) |
ff68c719 | 1194 | #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv)) |
463ee0b2 | 1195 | #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv)) |
79072805 | 1196 | |
891f9566 YST |
1197 | #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0)) |
1198 | #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0)) | |
1199 | ||
baca2b92 | 1200 | /* ----*/ |
8d6d96c1 | 1201 | |
8d6d96c1 | 1202 | #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC) |
32a5c6ec | 1203 | #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC) |
44d22300 | 1204 | #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC) |
8d6d96c1 | 1205 | |
8d6d96c1 HS |
1206 | #define SvPV_flags(sv, lp, flags) \ |
1207 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ | |
1208 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags)) | |
32a5c6ec NC |
1209 | #define SvPV_flags_const(sv, lp, flags) \ |
1210 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ | |
1211 | ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \ | |
1212 | (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN)) | |
2596d9fe NC |
1213 | #define SvPV_flags_const_nolen(sv, flags) \ |
1214 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ | |
1215 | ? SvPVX_const(sv) : \ | |
1216 | (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN)) | |
44d22300 NC |
1217 | #define SvPV_flags_mutable(sv, lp, flags) \ |
1218 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ | |
1219 | ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \ | |
1220 | sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN)) | |
79072805 | 1221 | |
8d6d96c1 | 1222 | #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC) |
13c5b33c | 1223 | #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC) |
32a5c6ec | 1224 | #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC) |
baca2b92 | 1225 | |
8d6d96c1 | 1226 | #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0) |
2596d9fe | 1227 | #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0) |
8d6d96c1 | 1228 | |
8d6d96c1 | 1229 | #define SvPV_force_flags(sv, lp, flags) \ |
ff68c719 | 1230 | ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \ |
8d6d96c1 | 1231 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags)) |
13c5b33c NC |
1232 | #define SvPV_force_flags_nolen(sv, flags) \ |
1233 | ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \ | |
1234 | ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags)) | |
32a5c6ec NC |
1235 | #define SvPV_force_flags_mutable(sv, lp, flags) \ |
1236 | ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \ | |
1237 | ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \ | |
1238 | : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN)) | |
a0d0e21e | 1239 | |
1fa8b10d | 1240 | #define SvPV_nolen(sv) \ |
5bc28da9 | 1241 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ |
dafda6d1 | 1242 | ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC)) |
70401c6b | 1243 | |
9ce348e8 NC |
1244 | #define SvPV_nolen_const(sv) \ |
1245 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ | |
1246 | ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN)) | |
1247 | ||
baca2b92 | 1248 | #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0) |
9ce348e8 | 1249 | #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0) |
2596d9fe | 1250 | #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0) |
5bc28da9 | 1251 | |
baca2b92 | 1252 | /* ----*/ |
70401c6b | 1253 | |
5bc28da9 NIS |
1254 | #define SvPVutf8(sv, lp) \ |
1255 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \ | |
1256 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp)) | |
70401c6b | 1257 | |
5bc28da9 | 1258 | #define SvPVutf8_force(sv, lp) \ |
70401c6b | 1259 | ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \ |
5bc28da9 NIS |
1260 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp)) |
1261 | ||
baca2b92 | 1262 | |
5bc28da9 NIS |
1263 | #define SvPVutf8_nolen(sv) \ |
1264 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\ | |
dafda6d1 | 1265 | ? SvPVX(sv) : sv_2pvutf8(sv, 0)) |
70401c6b | 1266 | |
baca2b92 DM |
1267 | /* ----*/ |
1268 | ||
5bc28da9 NIS |
1269 | #define SvPVbyte(sv, lp) \ |
1270 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \ | |
1271 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp)) | |
70401c6b | 1272 | |
5bc28da9 NIS |
1273 | #define SvPVbyte_force(sv, lp) \ |
1274 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \ | |
a7ec4e2e | 1275 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp)) |
5bc28da9 | 1276 | |
5bc28da9 NIS |
1277 | #define SvPVbyte_nolen(sv) \ |
1278 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\ | |
dafda6d1 | 1279 | ? SvPVX(sv) : sv_2pvbyte(sv, 0)) |
70401c6b | 1280 | |
1fa8b10d | 1281 | |
baca2b92 DM |
1282 | |
1283 | /* define FOOx(): idempotent versions of FOO(). If possible, use a local | |
1284 | * var to evaluate the arg once; failing that, use a global if possible; | |
1285 | * failing that, call a function to do the work | |
1286 | */ | |
1287 | ||
1288 | #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp) | |
1289 | #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp) | |
1290 | #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp) | |
1291 | ||
5dc8bdac | 1292 | #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) |
baca2b92 | 1293 | |
3de3296f AE |
1294 | # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); }) |
1295 | # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); }) | |
1296 | # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); }) | |
1297 | # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); }) | |
32a5c6ec | 1298 | # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); }) |
002e4c74 | 1299 | # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); }) |
9ce348e8 | 1300 | # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); }) |
3de3296f AE |
1301 | # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); }) |
1302 | # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); }) | |
002e4c74 | 1303 | # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); }) |
a80f87c4 | 1304 | # define SvTRUE(sv) ( \ |
8990e307 LW |
1305 | !sv \ |
1306 | ? 0 \ | |
1307 | : SvPOK(sv) \ | |
a80f87c4 GS |
1308 | ? (({XPV *nxpv = (XPV*)SvANY(sv); \ |
1309 | nxpv && \ | |
c2f1de04 | 1310 | (nxpv->xpv_cur > 1 || \ |
339049b0 | 1311 | (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \ |
79072805 LW |
1312 | ? 1 \ |
1313 | : 0) \ | |
1314 | : \ | |
1315 | SvIOK(sv) \ | |
463ee0b2 | 1316 | ? SvIVX(sv) != 0 \ |
79072805 | 1317 | : SvNOK(sv) \ |
463ee0b2 LW |
1318 | ? SvNVX(sv) != 0.0 \ |
1319 | : sv_2bool(sv) ) | |
3de3296f | 1320 | # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); }) |
baca2b92 | 1321 | |
a80f87c4 | 1322 | #else /* __GNUC__ */ |
baca2b92 | 1323 | |
a80f87c4 GS |
1324 | /* These inlined macros use globals, which will require a thread |
1325 | * declaration in user code, so we avoid them under threads */ | |
1326 | ||
3db8f154 MB |
1327 | # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv)) |
1328 | # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv)) | |
1329 | # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv)) | |
1330 | # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp)) | |
32a5c6ec | 1331 | # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp)) |
002e4c74 | 1332 | # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv)) |
5f1478c3 | 1333 | # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv)) |
3db8f154 MB |
1334 | # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp)) |
1335 | # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp)) | |
002e4c74 | 1336 | # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv)) |
3db8f154 | 1337 | # define SvTRUE(sv) ( \ |
a80f87c4 GS |
1338 | !sv \ |
1339 | ? 0 \ | |
1340 | : SvPOK(sv) \ | |
7b2c381c | 1341 | ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \ |
c2f1de04 | 1342 | (PL_Xpv->xpv_cur > 1 || \ |
339049b0 | 1343 | (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \ |
a80f87c4 GS |
1344 | ? 1 \ |
1345 | : 0) \ | |
1346 | : \ | |
1347 | SvIOK(sv) \ | |
1348 | ? SvIVX(sv) != 0 \ | |
1349 | : SvNOK(sv) \ | |
1350 | ? SvNVX(sv) != 0.0 \ | |
1351 | : sv_2bool(sv) ) | |
3db8f154 | 1352 | # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv)) |
baca2b92 DM |
1353 | #endif /* __GNU__ */ |
1354 | ||
765f542d NC |
1355 | #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \ |
1356 | (SVf_FAKE | SVf_READONLY)) | |
46187eeb | 1357 | #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0) |
baca2b92 | 1358 | |
bdd68bc3 NC |
1359 | #define SvSHARED_HEK_FROM_PV(pvx) \ |
1360 | ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key))) | |
0a356b31 | 1361 | #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash) |
c158a4fd | 1362 | |
baca2b92 DM |
1363 | /* flag values for sv_*_flags functions */ |
1364 | #define SV_IMMEDIATE_UNREF 1 | |
1365 | #define SV_GMAGIC 2 | |
765f542d | 1366 | #define SV_COW_DROP_PV 4 |
88632417 | 1367 | #define SV_UTF8_NO_ENCODING 8 |
5fcdf167 | 1368 | #define SV_NOSTEAL 16 |
32a5c6ec NC |
1369 | #define SV_CONST_RETURN 32 |
1370 | #define SV_MUTABLE_RETURN 64 | |
bddd5118 | 1371 | #define SV_SMAGIC 128 |
765f542d | 1372 | |
5abc721d NC |
1373 | #define sv_unref(sv) sv_unref_flags(sv, 0) |
1374 | #define sv_force_normal(sv) sv_force_normal_flags(sv, 0) | |
174c73e3 | 1375 | |
46187eeb NC |
1376 | /* We are about to replace the SV's current value. So if it's copy on write |
1377 | we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that | |
1378 | the value is about to get thrown away, so drop the PV rather than go to | |
1379 | the effort of making a read-write copy only for it to get immediately | |
1380 | discarded. */ | |
765f542d NC |
1381 | |
1382 | #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \ | |
1383 | sv_force_normal_flags(sv, SV_COW_DROP_PV) | |
46187eeb | 1384 | |
f8c7b90f | 1385 | #ifdef PERL_OLD_COPY_ON_WRITE |
46187eeb | 1386 | # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \ |
b885210e | 1387 | && Perl_sv_release_IVX(aTHX_ sv))) |
46187eeb | 1388 | # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv)) |
b8f9541a NC |
1389 | #else |
1390 | # define SvRELEASE_IVX(sv) SvOOK_off(sv) | |
f8c7b90f | 1391 | #endif /* PERL_OLD_COPY_ON_WRITE */ |
ed252734 NC |
1392 | |
1393 | #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \ | |
1394 | SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \ | |
1395 | SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC) | |
1396 | #define CAN_COW_FLAGS (SVp_POK|SVf_POK) | |
1397 | ||
765f542d NC |
1398 | #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \ |
1399 | sv_force_normal_flags(sv, 0) | |
1400 | ||
1401 | ||
baca2b92 DM |
1402 | /* all these 'functions' are now just macros */ |
1403 | ||
1404 | #define sv_pv(sv) SvPV_nolen(sv) | |
1405 | #define sv_pvutf8(sv) SvPVutf8_nolen(sv) | |
1406 | #define sv_pvbyte(sv) SvPVbyte_nolen(sv) | |
1407 | ||
1408 | #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0) | |
1409 | #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0) | |
1410 | #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0) | |
1411 | #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC) | |
1412 | #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0) | |
1413 | #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC) | |
1414 | #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0) | |
b347df82 | 1415 | #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC) |
baca2b92 | 1416 | #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC) |
b347df82 NC |
1417 | #define sv_catpvn_mg(sv, sstr, slen) \ |
1418 | sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC); | |
baca2b92 | 1419 | #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC) |
cb2f1b7b NC |
1420 | #define sv_2pv_nolen(sv) sv_2pv(sv, 0) |
1421 | #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0) | |
1422 | #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0) | |
baca2b92 DM |
1423 | #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0) |
1424 | #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC) | |
1425 | #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC) | |
891f9566 YST |
1426 | #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC) |
1427 | #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC) | |
baca2b92 | 1428 | |
db79b45b JH |
1429 | /* Should be named SvCatPVN_utf8_upgrade? */ |
1430 | #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \ | |
1431 | STMT_START { \ | |
1432 | if (!(nsv)) \ | |
1433 | nsv = sv_2mortal(newSVpvn(sstr, slen)); \ | |
1434 | else \ | |
1435 | sv_setpvn(nsv, sstr, slen); \ | |
1436 | SvUTF8_off(nsv); \ | |
1437 | sv_utf8_upgrade(nsv); \ | |
1438 | sv_catsv(dsv, nsv); \ | |
1439 | } STMT_END | |
79072805 | 1440 | |
954c1994 GS |
1441 | /* |
1442 | =for apidoc Am|SV*|newRV_inc|SV* sv | |
1443 | ||
1444 | Creates an RV wrapper for an SV. The reference count for the original SV is | |
1445 | incremented. | |
1446 | ||
1447 | =cut | |
1448 | */ | |
1449 | ||
5f05dabc | 1450 | #define newRV_inc(sv) newRV(sv) |
5f05dabc | 1451 | |
ef50df4b | 1452 | /* the following macros update any magic values this sv is associated with */ |
79072805 | 1453 | |
954c1994 | 1454 | /* |
ccfc67b7 JH |
1455 | =head1 Magical Functions |
1456 | ||
954c1994 GS |
1457 | =for apidoc Am|void|SvGETMAGIC|SV* sv |
1458 | Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its | |
1459 | argument more than once. | |
1460 | ||
1461 | =for apidoc Am|void|SvSETMAGIC|SV* sv | |
1462 | Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its | |
1463 | argument more than once. | |
1464 | ||
1465 | =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv | |
1466 | Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments | |
1467 | more than once. | |
1468 | ||
1469 | =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv | |
1470 | Calls a non-destructive version of C<sv_setsv> if dsv is not the same as | |
1471 | ssv. May evaluate arguments more than once. | |
1472 | ||
645c22ef DM |
1473 | =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv |
1474 | Like C<SvSetSV>, but does any set magic required afterwards. | |
1475 | ||
1476 | =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv | |
80663158 | 1477 | Like C<SvSetSV_nosteal>, but does any set magic required afterwards. |
645c22ef | 1478 | |
68795e93 NIS |
1479 | =for apidoc Am|void|SvSHARE|SV* sv |
1480 | Arranges for sv to be shared between threads if a suitable module | |
1481 | has been loaded. | |
1482 | ||
1483 | =for apidoc Am|void|SvLOCK|SV* sv | |
1484 | Arranges for a mutual exclusion lock to be obtained on sv if a suitable module | |
1485 | has been loaded. | |
1486 | ||
1487 | =for apidoc Am|void|SvUNLOCK|SV* sv | |
1488 | Releases a mutual exclusion lock on sv if a suitable module | |
1489 | has been loaded. | |
1490 | ||
ccfc67b7 JH |
1491 | =head1 SV Manipulation Functions |
1492 | ||
679ac26e | 1493 | =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len |
954c1994 GS |
1494 | Expands the character buffer in the SV so that it has room for the |
1495 | indicated number of bytes (remember to reserve space for an extra trailing | |
8cf8f3d1 | 1496 | NUL character). Calls C<sv_grow> to perform the expansion if necessary. |
954c1994 GS |
1497 | Returns a pointer to the character buffer. |
1498 | ||
1499 | =cut | |
1500 | */ | |
1501 | ||
68795e93 NIS |
1502 | #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv) |
1503 | #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv) | |
1504 | #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv) | |
1505 | ||
189b2af5 GS |
1506 | #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END |
1507 | #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END | |
79072805 | 1508 | |
54310121 | 1509 | #define SvSetSV_and(dst,src,finally) \ |
189b2af5 | 1510 | STMT_START { \ |
54310121 | 1511 | if ((dst) != (src)) { \ |
1512 | sv_setsv(dst, src); \ | |
1513 | finally; \ | |
189b2af5 GS |
1514 | } \ |
1515 | } STMT_END | |
54310121 | 1516 | #define SvSetSV_nosteal_and(dst,src,finally) \ |
189b2af5 | 1517 | STMT_START { \ |
8ebc5c01 | 1518 | if ((dst) != (src)) { \ |
5fcdf167 | 1519 | sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL); \ |
54310121 | 1520 | finally; \ |
189b2af5 GS |
1521 | } \ |
1522 | } STMT_END | |
79072805 | 1523 | |
54310121 | 1524 | #define SvSetSV(dst,src) \ |
c9d716f7 | 1525 | SvSetSV_and(dst,src,/*nothing*/;) |
54310121 | 1526 | #define SvSetSV_nosteal(dst,src) \ |
c9d716f7 | 1527 | SvSetSV_nosteal_and(dst,src,/*nothing*/;) |
54310121 | 1528 | |
1529 | #define SvSetMagicSV(dst,src) \ | |
1530 | SvSetSV_and(dst,src,SvSETMAGIC(dst)) | |
1531 | #define SvSetMagicSV_nosteal(dst,src) \ | |
1532 | SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst)) | |
1533 | ||
db79b45b | 1534 | |
1045810a | 1535 | #if !defined(SKIP_DEBUGGING) |
79072805 | 1536 | #define SvPEEK(sv) sv_peek(sv) |
3967c732 JD |
1537 | #else |
1538 | #define SvPEEK(sv) "" | |
1539 | #endif | |
79072805 | 1540 | |
5dc8bdac | 1541 | #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder) |
36477c24 | 1542 | |
3280af22 | 1543 | #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no) |
54310121 | 1544 | |
79072805 LW |
1545 | #define isGV(sv) (SvTYPE(sv) == SVt_PVGV) |
1546 | ||
933fea7f | 1547 | #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv)) |
5902b6a9 NC |
1548 | #define SvGROW_mutable(sv,len) \ |
1549 | (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv)) | |
933fea7f | 1550 | #define Sv_Grow sv_grow |
3d35f11b | 1551 | |
a0739874 DM |
1552 | #define CLONEf_COPY_STACKS 1 |
1553 | #define CLONEf_KEEP_PTR_TABLE 2 | |
c43294b8 | 1554 | #define CLONEf_CLONE_HOST 4 |
0405e91e | 1555 | #define CLONEf_JOIN_IN 8 |
a0739874 | 1556 | |
8cf8f3d1 | 1557 | struct clone_params { |
d2d73c3e AB |
1558 | AV* stashes; |
1559 | UV flags; | |
59b40662 | 1560 | PerlInterpreter *proto_perl; |
8cf8f3d1 | 1561 | }; |
102d3b8a NC |
1562 | |
1563 | /* | |
1564 | * Local variables: | |
1565 | * c-indentation-style: bsd | |
1566 | * c-basic-offset: 4 | |
1567 | * indent-tabs-mode: t | |
1568 | * End: | |
1569 | * | |
1570 | * ex: set ts=8 sts=4 sw=4 noet: | |
1571 | */ |