Commit | Line | Data |
a0d0e21e |
1 | /* sv.h |
79072805 |
2 | * |
4bb101f2 |
3 | * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, |
1d325971 |
4 | * 2000, 2001, 2002, 2003, 2004, 2005 by Larry Wall and others |
79072805 |
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 |
9 | */ |
10 | |
a0d0e21e |
11 | #ifdef sv_flags |
12 | #undef sv_flags /* Convex has this in <signal.h> for sigvec() */ |
13 | #endif |
14 | |
954c1994 |
15 | /* |
ccfc67b7 |
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 |
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 */ |
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 |
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 |
62 | SVt_PVIO, /* 15 */ |
63 | SVt_LAST /* keep last in enum. used to size arrays */ |
79072805 |
64 | } svtype; |
65 | |
028b03ee |
66 | #ifdef PERL_IN_SV_C |
67 | #define PTE_SVSLOT SVt_RV |
68 | #endif |
6a93a7e5 |
69 | #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST) |
70 | #define HE_SVSLOT SVt_NULL |
71 | #endif |
43e6e717 |
72 | |
73 | /* typedefs to eliminate some typing */ |
74 | typedef struct he HE; |
75 | typedef struct hek HEK; |
76 | |
79072805 |
77 | /* Using C's structural equivalence to help emulate C++ inheritance here... */ |
78 | |
30153bd2 |
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 |
97 | _SV_HEAD(void*); |
98 | _SV_HEAD_UNION; |
fd0854ff |
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 |
106 | }; |
107 | |
108 | struct gv { |
30153bd2 |
109 | _SV_HEAD(XPVGV*); /* pointer to xpvgv body */ |
110 | _SV_HEAD_UNION; |
79072805 |
111 | }; |
112 | |
113 | struct cv { |
30153bd2 |
114 | _SV_HEAD(XPVCV*); /* pointer to xpvcv body */ |
115 | _SV_HEAD_UNION; |
79072805 |
116 | }; |
117 | |
118 | struct av { |
30153bd2 |
119 | _SV_HEAD(XPVAV*); /* pointer to xpvcv body */ |
120 | _SV_HEAD_UNION; |
79072805 |
121 | }; |
122 | |
123 | struct hv { |
30153bd2 |
124 | _SV_HEAD(XPVHV*); /* pointer to xpvhv body */ |
125 | _SV_HEAD_UNION; |
8990e307 |
126 | }; |
127 | |
128 | struct io { |
30153bd2 |
129 | _SV_HEAD(XPVIO*); /* pointer to xpvio body */ |
130 | _SV_HEAD_UNION; |
79072805 |
131 | }; |
132 | |
30153bd2 |
133 | #undef _SV_HEAD |
134 | #undef _SV_HEAD_UNION /* insure no pollution */ |
135 | |
954c1994 |
136 | /* |
ccfc67b7 |
137 | =head1 SV Manipulation Functions |
138 | |
954c1994 |
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 |
163 | # define SvREFCNT_inc(sv) \ |
164 | ({ \ |
a3b680e6 |
165 | SV * const _sv = (SV*)(sv); \ |
3de3296f |
166 | if (_sv) \ |
167 | (SvREFCNT(_sv))++; \ |
168 | _sv; \ |
dce16143 |
169 | }) |
8990e307 |
170 | #else |
3db8f154 |
171 | # define SvREFCNT_inc(sv) \ |
4db098f4 |
172 | ((PL_Sv=(SV*)(sv)), (PL_Sv && ++(SvREFCNT(PL_Sv))), (SV*)PL_Sv) |
8990e307 |
173 | #endif |
174 | |
8c4d3c90 |
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 |
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 |
185 | } \ |
186 | } \ |
187 | }) |
188 | #else |
91f3b821 |
189 | #define SvREFCNT_dec(sv) sv_free((SV*)(sv)) |
8c4d3c90 |
190 | #endif |
a863c7d1 |
191 | |
8990e307 |
192 | #define SVTYPEMASK 0xff |
193 | #define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK) |
79072805 |
194 | |
0565a181 |
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 |
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 |
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 |
221 | #define SVf_BREAK 0x00400000 /* refcnt is artificially low - used |
222 | * by SV's in final arena cleanup */ |
8990e307 |
223 | #define SVf_READONLY 0x00800000 /* may not be modified */ |
224 | |
a0d0e21e |
225 | |
8990e307 |
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 |
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 |
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 |
249 | #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */ |
250 | |
251 | #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */ |
8990e307 |
252 | |
253 | #define SVpbm_VALID 0x80000000 |
bbce6d69 |
254 | #define SVpbm_TAIL 0x40000000 |
8990e307 |
255 | |
25da4f38 |
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 |
264 | #define SVprv_WEAKREF 0x80000000 /* Weak reference */ |
265 | |
11ca45c0 |
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 |
273 | }; |
274 | |
9f1501b2 |
275 | #if 0 |
59813432 |
276 | typedef struct xpv xpv_allocated; |
9f1501b2 |
277 | #else |
278 | typedef struct { |
339049b0 |
279 | STRLEN xpv_cur; /* length of svu_pv as a C string */ |
9f1501b2 |
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 |
288 | union { |
289 | IV xivu_iv; /* integer value or pv offset */ |
290 | UV xivu_uv; |
291 | void * xivu_p1; |
292 | } xiv_u; |
79072805 |
293 | }; |
294 | |
311a25d9 |
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 |
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 |
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 |
329 | IV xivu_iv; /* integer value or pv offset */ |
330 | UV xivu_uv; |
331 | void * xivu_p1; |
332 | } xiv_u; |
79072805 |
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 |
341 | IV xivu_iv; /* integer value or pv offset */ |
342 | UV xivu_uv; |
343 | void * xivu_p1; |
344 | } xiv_u; |
79072805 |
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 |
354 | IV xivu_iv; /* integer value or pv offset */ |
355 | UV xivu_uv; |
356 | void * xivu_p1; |
357 | } xiv_u; |
79072805 |
358 | MAGIC* xmg_magic; /* linked list of magicalness */ |
359 | HV* xmg_stash; /* class package */ |
8990e307 |
360 | |
4ce457a6 |
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 |
368 | STRLEN xlv_targoff; |
369 | STRLEN xlv_targlen; |
370 | SV* xlv_targ; |
dd28f7bb |
371 | char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re |
372 | * y=alem/helem/iter t=tie T=tied HE */ |
79072805 |
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 |
380 | IV xivu_iv; /* integer value or pv offset */ |
381 | UV xivu_uv; |
382 | void * xivu_p1; |
383 | } xiv_u; |
79072805 |
384 | MAGIC* xmg_magic; /* linked list of magicalness */ |
385 | HV* xmg_stash; /* class package */ |
8990e307 |
386 | |
79072805 |
387 | GP* xgv_gp; |
388 | char* xgv_name; |
389 | STRLEN xgv_namelen; |
390 | HV* xgv_stash; |
a5f75d66 |
391 | U8 xgv_flags; |
79072805 |
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 |
399 | IV xivu_iv; /* integer value or pv offset */ |
400 | UV xivu_uv; |
401 | void * xivu_p1; |
402 | } xiv_u; |
79072805 |
403 | MAGIC* xmg_magic; /* linked list of magicalness */ |
404 | HV* xmg_stash; /* class package */ |
8990e307 |
405 | |
79072805 |
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 |
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 |
420 | IV xivu_iv; /* integer value or pv offset */ |
421 | UV xivu_uv; |
422 | void * xivu_p1; |
423 | } xiv_u; |
79072805 |
424 | MAGIC* xmg_magic; /* linked list of magicalness */ |
425 | HV* xmg_stash; /* class package */ |
8990e307 |
426 | |
79072805 |
427 | HV * xcv_stash; |
428 | OP * xcv_start; |
429 | OP * xcv_root; |
acfe0abc |
430 | void (*xcv_xsub)(pTHX_ CV*); |
a0d0e21e |
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 |
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 |
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 |
449 | IV xivu_iv; /* integer value or pv offset */ |
450 | UV xivu_uv; |
451 | void * xivu_p1; |
452 | } xiv_u; |
8990e307 |
453 | MAGIC* xmg_magic; /* linked list of magicalness */ |
454 | HV* xmg_stash; /* class package */ |
455 | |
760ac839 |
456 | PerlIO * xio_ifp; /* ifp and ofp are normally the same */ |
457 | PerlIO * xio_ofp; /* but sockets need separate streams */ |
4755096e |
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 |
471 | IV xio_lines; /* $. */ |
472 | IV xio_page; /* $% */ |
473 | IV xio_page_len; /* $= */ |
474 | IV xio_lines_left; /* $- */ |
8990e307 |
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 |
485 | #define xio_dirp xio_dirpu.xiou_dirp |
486 | #define xio_any xio_dirpu.xiou_any |
8990e307 |
487 | |
e0c19803 |
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 |
496 | /* The following macros define implementation-independent predicates on SVs. */ |
497 | |
954c1994 |
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 |
511 | Returns a boolean indicating whether the value is an SV. It also tells |
512 | whether the value is defined or not. |
954c1994 |
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 |
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 |
542 | Returns a boolean indicating whether the SV contains an unsigned integer. |
543 | |
28e5dec8 |
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 |
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 |
576 | =for apidoc Am|bool|SvVOK|SV* sv |
577 | Returns a boolean indicating whether the SV contains a v-string. |
578 | |
954c1994 |
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 |
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 |
600 | |
601 | =for apidoc Am|UV|SvUVX|SV* sv |
645c22ef |
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 |
604 | |
605 | =for apidoc Am|NV|SvNVX|SV* sv |
645c22ef |
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 |
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 |
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 |
617 | Returns the size of the string buffer in the SV, not including any part |
618 | attributable to C<SvOOK>. See C<SvCUR>. |
954c1994 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
652 | Set the current length of the string which is in the SV. See C<SvCUR> |
653 | and C<SvIV_set>. |
672994ce |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
724 | |
725 | =for apidoc Am|void|SvUTF8_off|SV *sv |
1e54db1a |
726 | Unsets the UTF-8 status of an SV. |
914184e1 |
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 |
732 | =cut |
733 | */ |
734 | |
7a5fd60d |
735 | /* Ensure the return value of this macro does not clash with the GV_ADD* flags |
736 | in gv.h: */ |
a7cb1f99 |
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 |
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 | |
b0f01acb |
754 | #define SvVOK(sv) (SvMAGICAL(sv) && mg_find(sv,'V')) |
79072805 |
755 | #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK) |
155aba94 |
756 | #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK) |
0c34ef67 |
757 | #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv))) |
79072805 |
758 | |
a0d0e21e |
759 | #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE) |
760 | #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE) |
761 | #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE) |
762 | |
ed6116ce |
763 | #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK) |
a0d0e21e |
764 | #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK) |
a0d0e21e |
765 | #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC)) |
79072805 |
766 | |
8990e307 |
767 | #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG)) |
768 | #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG)) |
769 | #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG)) |
79072805 |
770 | |
8990e307 |
771 | #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG) |
772 | #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG) |
773 | #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG) |
ed6116ce |
774 | |
8990e307 |
775 | #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG) |
776 | #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG) |
777 | #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG) |
ed6116ce |
778 | |
8990e307 |
779 | #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG) |
780 | #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG) |
781 | #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG) |
ed6116ce |
782 | |
9e7bc3e8 |
783 | #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC) |
784 | #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC) |
785 | #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC) |
a0d0e21e |
786 | |
8cf8f3d1 |
787 | #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC)) |
1426bbf4 |
788 | |
a0d0e21e |
789 | /* |
790 | #define Gv_AMG(stash) \ |
791 | (HV_AMAGICmb(stash) && \ |
792 | ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash))) |
793 | */ |
3280af22 |
794 | #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash)) |
a0d0e21e |
795 | |
810b8aa5 |
796 | #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \ |
797 | == (SVf_ROK|SVprv_WEAKREF)) |
798 | #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF)) |
799 | #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF)) |
800 | |
a0d0e21e |
801 | #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST) |
ed6116ce |
802 | |
d9d18af6 |
803 | #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE) |
804 | #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE) |
805 | #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE) |
806 | |
8990e307 |
807 | #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP) |
235cc2e3 |
808 | #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP) |
8990e307 |
809 | #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP) |
ed6116ce |
810 | |
8990e307 |
811 | #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY) |
235cc2e3 |
812 | #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY) |
ed6116ce |
813 | |
8990e307 |
814 | #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP) |
815 | #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP) |
816 | #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP) |
79072805 |
817 | |
8990e307 |
818 | #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT) |
819 | #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT) |
820 | #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT) |
79072805 |
821 | |
8990e307 |
822 | #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY) |
823 | #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY) |
824 | #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY) |
79072805 |
825 | |
8990e307 |
826 | #define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM) |
827 | #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM) |
828 | #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM) |
79072805 |
829 | |
8990e307 |
830 | #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED) |
831 | #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED) |
832 | #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED) |
79072805 |
833 | |
25da4f38 |
834 | #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL) |
835 | #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL) |
836 | #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL) |
837 | |
8990e307 |
838 | #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL) |
839 | #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL) |
840 | #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL) |
841 | |
8990e307 |
842 | #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID) |
843 | #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID) |
844 | #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID) |
845 | |
1cc8b4c5 |
846 | #ifdef USE_ITHREADS |
847 | /* The following uses the FAKE flag to show that a regex pointer is infact |
8ca6097c |
848 | its own offset in the regexpad for ithreads */ |
1cc8b4c5 |
849 | #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE) |
850 | #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE) |
851 | #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE) |
852 | #endif |
853 | |
b162af07 |
854 | #ifdef PERL_DEBUG_COW |
339049b0 |
855 | #define SvRV(sv) (0 + (sv)->sv_u.svu_rv) |
b162af07 |
856 | #else |
339049b0 |
857 | #define SvRV(sv) ((sv)->sv_u.svu_rv) |
b162af07 |
858 | #endif |
ed6116ce |
859 | #define SvRVx(sv) SvRV(sv) |
860 | |
f599b64b |
861 | #ifdef PERL_DEBUG_COW |
8ed30cc1 |
862 | /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because |
863 | +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */ |
771ba71a |
864 | # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv) |
865 | # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv) |
8ed30cc1 |
866 | # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_nv) |
c0e1089a |
867 | /* Don't test the core XS code yet. */ |
771ba71a |
868 | # if defined (PERL_CORE) && PERL_DEBUG_COW > 1 |
869 | # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv)) |
870 | # else |
871 | # define SvPVX(sv) SvPVX_mutable(sv) |
872 | # endif |
771ba71a |
873 | # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur) |
874 | # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len) |
875 | # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur) |
876 | |
877 | # ifdef DEBUGGING |
878 | # ifdef PERL_IN_SV_C |
62703e72 |
879 | /* Can't make this RVALUE because of Perl_sv_unmagic. */ |
771ba71a |
880 | # define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic)) |
881 | # else |
882 | # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic)) |
883 | # endif |
884 | # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash)) |
03687789 |
885 | # else |
771ba71a |
886 | # ifdef PERL_IN_SV_C |
887 | # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic |
888 | # else |
889 | # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_magic) |
890 | # endif |
891 | # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash) |
03687789 |
892 | # endif |
f599b64b |
893 | #else |
771ba71a |
894 | # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv |
895 | # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv |
896 | # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_nv |
897 | # define SvPVX(sv) ((sv)->sv_u.svu_pv) |
771ba71a |
898 | # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur |
899 | # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len |
900 | # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur) |
901 | |
902 | # ifdef DEBUGGING |
903 | # define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic)) |
904 | # define SvSTASH(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash)) |
03687789 |
905 | # else |
771ba71a |
906 | # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic |
907 | # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash |
03687789 |
908 | # endif |
62703e72 |
909 | #endif |
910 | |
06c0cc96 |
911 | #ifndef PERL_POISON |
bb496845 |
912 | /* Given that these two are new, there can't be any existing code using them |
913 | * as LVALUEs */ |
06c0cc96 |
914 | # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv) |
915 | # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv)) |
916 | #else |
917 | /* Except for the poison code, which uses & to scribble over the pointer after |
918 | free() is called. */ |
919 | # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv) |
920 | # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv)) |
921 | #endif |
bb496845 |
922 | |
62703e72 |
923 | #define SvIVXx(sv) SvIVX(sv) |
924 | #define SvUVXx(sv) SvUVX(sv) |
925 | #define SvNVXx(sv) SvNVX(sv) |
926 | #define SvPVXx(sv) SvPVX(sv) |
927 | #define SvLENx(sv) SvLEN(sv) |
928 | #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv)) |
929 | |
930 | |
28e5dec8 |
931 | /* Ask a scalar nicely to try to become an IV, if possible. |
932 | Not guaranteed to stay returning void */ |
933 | /* Macro won't actually call sv_2iv if already IOK */ |
934 | #define SvIV_please(sv) \ |
935 | STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \ |
936 | (void) SvIV(sv); } STMT_END |
79072805 |
937 | #define SvIV_set(sv, val) \ |
80b92232 |
938 | STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \ |
b19bbeda |
939 | (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END |
79072805 |
940 | #define SvNV_set(sv, val) \ |
80b92232 |
941 | STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \ |
7ffec4a4 |
942 | assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \ |
f599b64b |
943 | (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END |
79072805 |
944 | #define SvPV_set(sv, val) \ |
80b92232 |
945 | STMT_START { assert(SvTYPE(sv) >= SVt_PV); \ |
339049b0 |
946 | ((sv)->sv_u.svu_pv = (val)); } STMT_END |
607fa7f2 |
947 | #define SvUV_set(sv, val) \ |
948 | STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \ |
949 | (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END |
b162af07 |
950 | #define SvRV_set(sv, val) \ |
951 | STMT_START { assert(SvTYPE(sv) >= SVt_RV); \ |
339049b0 |
952 | ((sv)->sv_u.svu_rv = (val)); } STMT_END |
b162af07 |
953 | #define SvMAGIC_set(sv, val) \ |
954 | STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \ |
955 | (((XPVMG*)SvANY(sv))->xmg_magic = (val)); } STMT_END |
956 | #define SvSTASH_set(sv, val) \ |
957 | STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \ |
958 | (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END |
79072805 |
959 | #define SvCUR_set(sv, val) \ |
80b92232 |
960 | STMT_START { assert(SvTYPE(sv) >= SVt_PV); \ |
b162af07 |
961 | (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END |
79072805 |
962 | #define SvLEN_set(sv, val) \ |
80b92232 |
963 | STMT_START { assert(SvTYPE(sv) >= SVt_PV); \ |
b162af07 |
964 | (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END |
7ae8ee9e |
965 | #define SvEND_set(sv, val) \ |
966 | STMT_START { assert(SvTYPE(sv) >= SVt_PV); \ |
967 | (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END |
79072805 |
968 | |
b7e9a5c2 |
969 | #define SvPV_renew(sv,n) \ |
1da4ca5f |
970 | STMT_START { SvLEN_set(sv, n); \ |
971 | SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \ |
972 | (char*)saferealloc((Malloc_t)SvPVX(sv), \ |
973 | (MEM_SIZE)((n))))); \ |
974 | } STMT_END |
975 | |
976 | #define SvPV_shrink_to_cur(sv) STMT_START { \ |
977 | const STRLEN _lEnGtH = SvCUR(sv) + 1; \ |
978 | SvPV_renew(sv, _lEnGtH); \ |
979 | } STMT_END |
b7e9a5c2 |
980 | |
771ba71a |
981 | #define SvPV_free(sv) \ |
982 | STMT_START { \ |
983 | assert(SvTYPE(sv) >= SVt_PV); \ |
984 | if (SvLEN(sv)) { \ |
985 | if(SvOOK(sv)) { \ |
986 | SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \ |
987 | SvFLAGS(sv) &= ~SVf_OOK; \ |
988 | } \ |
989 | Safefree(SvPVX(sv)); \ |
990 | } \ |
991 | } STMT_END |
8bd4d4c5 |
992 | |
79072805 |
993 | #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare |
994 | #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful |
995 | #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous |
996 | |
997 | #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines |
998 | |
999 | #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type |
1000 | #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ |
1001 | #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff |
1002 | #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen |
1003 | |
8990e307 |
1004 | #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp |
1005 | #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp |
1006 | #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp |
4755096e |
1007 | #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any |
8990e307 |
1008 | #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines |
1009 | #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page |
1010 | #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len |
1011 | #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left |
1012 | #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name |
1013 | #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv |
1014 | #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name |
1015 | #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv |
1016 | #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name |
1017 | #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv |
1018 | #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess |
1019 | #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type |
1020 | #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags |
1021 | |
50952442 |
1022 | /* IoTYPE(sv) is a single character telling the type of I/O connection. */ |
3b6c1aba |
1023 | #define IoTYPE_RDONLY '<' |
1024 | #define IoTYPE_WRONLY '>' |
1025 | #define IoTYPE_RDWR '+' |
1026 | #define IoTYPE_APPEND 'a' |
1027 | #define IoTYPE_PIPE '|' |
1028 | #define IoTYPE_STD '-' /* stdin or stdout */ |
1029 | #define IoTYPE_SOCKET 's' |
1030 | #define IoTYPE_CLOSED ' ' |
1031 | #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */ |
1032 | #define IoTYPE_NUMERIC '#' /* fdopen */ |
03fcf2fc |
1033 | |
1034 | /* |
954c1994 |
1035 | =for apidoc Am|bool|SvTAINTED|SV* sv |
1036 | Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if |
1037 | not. |
1038 | |
1039 | =for apidoc Am|void|SvTAINTED_on|SV* sv |
c55831ac |
1040 | Marks an SV as tainted if tainting is enabled. |
954c1994 |
1041 | |
1042 | =for apidoc Am|void|SvTAINTED_off|SV* sv |
1043 | Untaints an SV. Be I<very> careful with this routine, as it short-circuits |
1044 | some of Perl's fundamental security features. XS module authors should not |
1045 | use this function unless they fully understand all the implications of |
1046 | unconditionally untainting the value. Untainting should be done in the |
1047 | standard perl fashion, via a carefully crafted regexp, rather than directly |
1048 | untainting variables. |
1049 | |
1050 | =for apidoc Am|void|SvTAINT|SV* sv |
c55831ac |
1051 | Taints an SV if tainting is enabled. |
954c1994 |
1052 | |
1053 | =cut |
1054 | */ |
1055 | |
aae9cea0 |
1056 | #define sv_taint(sv) sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0) |
1057 | |
bbce6d69 |
1058 | #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv)) |
3280af22 |
1059 | #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END |
1060 | #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END |
bbce6d69 |
1061 | |
c6ee37c5 |
1062 | #define SvTAINT(sv) \ |
1063 | STMT_START { \ |
3280af22 |
1064 | if (PL_tainting) { \ |
3280af22 |
1065 | if (PL_tainted) \ |
c6ee37c5 |
1066 | SvTAINTED_on(sv); \ |
1067 | } \ |
1068 | } STMT_END |
79072805 |
1069 | |
954c1994 |
1070 | /* |
1071 | =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len |
5f08bad4 |
1072 | Like C<SvPV> but will force the SV into containing just a string |
1073 | (C<SvPOK_only>). You want force if you are going to update the C<SvPVX> |
1074 | directly. |
954c1994 |
1075 | |
645c22ef |
1076 | =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len |
5f08bad4 |
1077 | Like C<SvPV> but will force the SV into containing just a string |
1078 | (C<SvPOK_only>). You want force if you are going to update the C<SvPVX> |
1079 | directly. Doesn't process magic. |
645c22ef |
1080 | |
954c1994 |
1081 | =for apidoc Am|char*|SvPV|SV* sv|STRLEN len |
5f08bad4 |
1082 | Returns a pointer to the string in the SV, or a stringified form of |
1083 | the SV if the SV does not contain a string. The SV may cache the |
1084 | stringified version becoming C<SvPOK>. Handles 'get' magic. See also |
645c22ef |
1085 | C<SvPVx> for a version which guarantees to evaluate sv only once. |
1086 | |
1087 | =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len |
1088 | A version of C<SvPV> which guarantees to evaluate sv only once. |
954c1994 |
1089 | |
891f9566 |
1090 | =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len |
1091 | Like C<SvPV> but doesn't process magic. |
1092 | |
954c1994 |
1093 | =for apidoc Am|char*|SvPV_nolen|SV* sv |
5f08bad4 |
1094 | Returns a pointer to the string in the SV, or a stringified form of |
1095 | the SV if the SV does not contain a string. The SV may cache the |
1096 | stringified form becoming C<SvPOK>. Handles 'get' magic. |
954c1994 |
1097 | |
1098 | =for apidoc Am|IV|SvIV|SV* sv |
645c22ef |
1099 | Coerces the given SV to an integer and returns it. See C<SvIVx> for a |
1100 | version which guarantees to evaluate sv only once. |
1101 | |
891f9566 |
1102 | =for apidoc Am|IV|SvIV_nomg|SV* sv |
1103 | Like C<SvIV> but doesn't process magic. |
1104 | |
645c22ef |
1105 | =for apidoc Am|IV|SvIVx|SV* sv |
1106 | Coerces the given SV to an integer and returns it. Guarantees to evaluate |
d1be9408 |
1107 | sv only once. Use the more efficient C<SvIV> otherwise. |
954c1994 |
1108 | |
1109 | =for apidoc Am|NV|SvNV|SV* sv |
645c22ef |
1110 | Coerce the given SV to a double and return it. See C<SvNVx> for a version |
1111 | which guarantees to evaluate sv only once. |
1112 | |
1113 | =for apidoc Am|NV|SvNVx|SV* sv |
1114 | Coerces the given SV to a double and returns it. Guarantees to evaluate |
d1be9408 |
1115 | sv only once. Use the more efficient C<SvNV> otherwise. |
954c1994 |
1116 | |
1117 | =for apidoc Am|UV|SvUV|SV* sv |
645c22ef |
1118 | Coerces the given SV to an unsigned integer and returns it. See C<SvUVx> |
1119 | for a version which guarantees to evaluate sv only once. |
1120 | |
891f9566 |
1121 | =for apidoc Am|UV|SvUV_nomg|SV* sv |
1122 | Like C<SvUV> but doesn't process magic. |
1123 | |
645c22ef |
1124 | =for apidoc Am|UV|SvUVx|SV* sv |
1125 | Coerces the given SV to an unsigned integer and returns it. Guarantees to |
d1be9408 |
1126 | evaluate sv only once. Use the more efficient C<SvUV> otherwise. |
954c1994 |
1127 | |
1128 | =for apidoc Am|bool|SvTRUE|SV* sv |
1129 | Returns a boolean indicating whether Perl would evaluate the SV as true or |
1130 | false, defined or undefined. Does not handle 'get' magic. |
1131 | |
645c22ef |
1132 | =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len |
b70b15d2 |
1133 | Like C<SvPV_force>, but converts sv to utf8 first if necessary. |
645c22ef |
1134 | |
1135 | =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len |
b70b15d2 |
1136 | Like C<SvPV>, but converts sv to utf8 first if necessary. |
645c22ef |
1137 | |
b70b15d2 |
1138 | =for apidoc Am|char*|SvPVutf8_nolen|SV* sv |
1139 | Like C<SvPV_nolen>, but converts sv to utf8 first if necessary. |
645c22ef |
1140 | |
1141 | =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len |
1142 | Like C<SvPV_force>, but converts sv to byte representation first if necessary. |
1143 | |
1144 | =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len |
1145 | Like C<SvPV>, but converts sv to byte representation first if necessary. |
1146 | |
b70b15d2 |
1147 | =for apidoc Am|char*|SvPVbyte_nolen|SV* sv |
645c22ef |
1148 | Like C<SvPV_nolen>, but converts sv to byte representation first if necessary. |
1149 | |
1150 | =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len |
b70b15d2 |
1151 | Like C<SvPV_force>, but converts sv to utf8 first if necessary. |
d1be9408 |
1152 | Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force> |
645c22ef |
1153 | otherwise. |
1154 | |
1155 | =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len |
b70b15d2 |
1156 | Like C<SvPV>, but converts sv to utf8 first if necessary. |
d1be9408 |
1157 | Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8> |
645c22ef |
1158 | otherwise. |
1159 | |
1160 | =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len |
1161 | Like C<SvPV_force>, but converts sv to byte representation first if necessary. |
d1be9408 |
1162 | Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force> |
645c22ef |
1163 | otherwise. |
1164 | |
1165 | =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len |
1166 | Like C<SvPV>, but converts sv to byte representation first if necessary. |
d1be9408 |
1167 | Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte> |
645c22ef |
1168 | otherwise. |
1169 | |
19dbb8f1 |
1170 | =for apidoc Am|bool|SvIsCOW|SV* sv |
1171 | Returns a boolean indicating whether the SV is Copy-On-Write. (either shared |
1172 | hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for |
1173 | COW) |
1174 | |
1175 | =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv |
1176 | Returns a boolean indicating whether the SV is Copy-On-Write shared hash key |
1177 | scalar. |
645c22ef |
1178 | |
0f76ff59 |
1179 | =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len |
1180 | Like C<sv_catpvn> but doesn't process magic. |
1181 | |
1182 | =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv |
1183 | Like C<sv_setsv> but doesn't process magic. |
1184 | |
1185 | =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv |
1186 | Like C<sv_catsv> but doesn't process magic. |
1187 | |
954c1994 |
1188 | =cut |
1189 | */ |
1190 | |
25da4f38 |
1191 | /* Let us hope that bitmaps for UV and IV are the same */ |
463ee0b2 |
1192 | #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv)) |
ff68c719 |
1193 | #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv)) |
463ee0b2 |
1194 | #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv)) |
79072805 |
1195 | |
891f9566 |
1196 | #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0)) |
1197 | #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0)) |
1198 | |
baca2b92 |
1199 | /* ----*/ |
8d6d96c1 |
1200 | |
8d6d96c1 |
1201 | #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC) |
32a5c6ec |
1202 | #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC) |
44d22300 |
1203 | #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC) |
8d6d96c1 |
1204 | |
8d6d96c1 |
1205 | #define SvPV_flags(sv, lp, flags) \ |
1206 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ |
1207 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags)) |
32a5c6ec |
1208 | #define SvPV_flags_const(sv, lp, flags) \ |
1209 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ |
1210 | ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \ |
1211 | (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN)) |
2596d9fe |
1212 | #define SvPV_flags_const_nolen(sv, flags) \ |
1213 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ |
1214 | ? SvPVX_const(sv) : \ |
1215 | (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN)) |
44d22300 |
1216 | #define SvPV_flags_mutable(sv, lp, flags) \ |
1217 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ |
1218 | ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \ |
1219 | sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN)) |
79072805 |
1220 | |
8d6d96c1 |
1221 | #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC) |
13c5b33c |
1222 | #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC) |
32a5c6ec |
1223 | #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC) |
baca2b92 |
1224 | |
8d6d96c1 |
1225 | #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0) |
2596d9fe |
1226 | #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0) |
8d6d96c1 |
1227 | |
8d6d96c1 |
1228 | #define SvPV_force_flags(sv, lp, flags) \ |
ff68c719 |
1229 | ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \ |
8d6d96c1 |
1230 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags)) |
13c5b33c |
1231 | #define SvPV_force_flags_nolen(sv, flags) \ |
1232 | ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \ |
1233 | ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags)) |
32a5c6ec |
1234 | #define SvPV_force_flags_mutable(sv, lp, flags) \ |
1235 | ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \ |
1236 | ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \ |
1237 | : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN)) |
a0d0e21e |
1238 | |
1fa8b10d |
1239 | #define SvPV_nolen(sv) \ |
5bc28da9 |
1240 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ |
dafda6d1 |
1241 | ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC)) |
70401c6b |
1242 | |
9ce348e8 |
1243 | #define SvPV_nolen_const(sv) \ |
1244 | ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \ |
1245 | ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN)) |
1246 | |
baca2b92 |
1247 | #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0) |
9ce348e8 |
1248 | #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0) |
2596d9fe |
1249 | #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0) |
5bc28da9 |
1250 | |
baca2b92 |
1251 | /* ----*/ |
70401c6b |
1252 | |
5bc28da9 |
1253 | #define SvPVutf8(sv, lp) \ |
1254 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \ |
1255 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp)) |
70401c6b |
1256 | |
5bc28da9 |
1257 | #define SvPVutf8_force(sv, lp) \ |
70401c6b |
1258 | ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \ |
5bc28da9 |
1259 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp)) |
1260 | |
baca2b92 |
1261 | |
5bc28da9 |
1262 | #define SvPVutf8_nolen(sv) \ |
1263 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\ |
dafda6d1 |
1264 | ? SvPVX(sv) : sv_2pvutf8(sv, 0)) |
70401c6b |
1265 | |
baca2b92 |
1266 | /* ----*/ |
1267 | |
5bc28da9 |
1268 | #define SvPVbyte(sv, lp) \ |
1269 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \ |
1270 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp)) |
70401c6b |
1271 | |
5bc28da9 |
1272 | #define SvPVbyte_force(sv, lp) \ |
1273 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \ |
a7ec4e2e |
1274 | ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp)) |
5bc28da9 |
1275 | |
5bc28da9 |
1276 | #define SvPVbyte_nolen(sv) \ |
1277 | ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\ |
dafda6d1 |
1278 | ? SvPVX(sv) : sv_2pvbyte(sv, 0)) |
70401c6b |
1279 | |
1fa8b10d |
1280 | |
baca2b92 |
1281 | |
1282 | /* define FOOx(): idempotent versions of FOO(). If possible, use a local |
1283 | * var to evaluate the arg once; failing that, use a global if possible; |
1284 | * failing that, call a function to do the work |
1285 | */ |
1286 | |
1287 | #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp) |
1288 | #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp) |
1289 | #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp) |
1290 | |
5dc8bdac |
1291 | #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) |
baca2b92 |
1292 | |
3de3296f |
1293 | # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); }) |
1294 | # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); }) |
1295 | # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); }) |
1296 | # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); }) |
32a5c6ec |
1297 | # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); }) |
002e4c74 |
1298 | # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); }) |
9ce348e8 |
1299 | # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); }) |
3de3296f |
1300 | # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); }) |
1301 | # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); }) |
002e4c74 |
1302 | # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); }) |
a80f87c4 |
1303 | # define SvTRUE(sv) ( \ |
8990e307 |
1304 | !sv \ |
1305 | ? 0 \ |
1306 | : SvPOK(sv) \ |
a80f87c4 |
1307 | ? (({XPV *nxpv = (XPV*)SvANY(sv); \ |
1308 | nxpv && \ |
c2f1de04 |
1309 | (nxpv->xpv_cur > 1 || \ |
339049b0 |
1310 | (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \ |
79072805 |
1311 | ? 1 \ |
1312 | : 0) \ |
1313 | : \ |
1314 | SvIOK(sv) \ |
463ee0b2 |
1315 | ? SvIVX(sv) != 0 \ |
79072805 |
1316 | : SvNOK(sv) \ |
463ee0b2 |
1317 | ? SvNVX(sv) != 0.0 \ |
1318 | : sv_2bool(sv) ) |
3de3296f |
1319 | # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); }) |
baca2b92 |
1320 | |
a80f87c4 |
1321 | #else /* __GNUC__ */ |
baca2b92 |
1322 | |
a80f87c4 |
1323 | /* These inlined macros use globals, which will require a thread |
1324 | * declaration in user code, so we avoid them under threads */ |
1325 | |
3db8f154 |
1326 | # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv)) |
1327 | # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv)) |
1328 | # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv)) |
1329 | # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp)) |
32a5c6ec |
1330 | # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp)) |
002e4c74 |
1331 | # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv)) |
5f1478c3 |
1332 | # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv)) |
3db8f154 |
1333 | # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp)) |
1334 | # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp)) |
002e4c74 |
1335 | # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv)) |
3db8f154 |
1336 | # define SvTRUE(sv) ( \ |
a80f87c4 |
1337 | !sv \ |
1338 | ? 0 \ |
1339 | : SvPOK(sv) \ |
7b2c381c |
1340 | ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \ |
c2f1de04 |
1341 | (PL_Xpv->xpv_cur > 1 || \ |
339049b0 |
1342 | (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \ |
a80f87c4 |
1343 | ? 1 \ |
1344 | : 0) \ |
1345 | : \ |
1346 | SvIOK(sv) \ |
1347 | ? SvIVX(sv) != 0 \ |
1348 | : SvNOK(sv) \ |
1349 | ? SvNVX(sv) != 0.0 \ |
1350 | : sv_2bool(sv) ) |
3db8f154 |
1351 | # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv)) |
baca2b92 |
1352 | #endif /* __GNU__ */ |
1353 | |
765f542d |
1354 | #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \ |
1355 | (SVf_FAKE | SVf_READONLY)) |
46187eeb |
1356 | #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0) |
baca2b92 |
1357 | |
bdd68bc3 |
1358 | #define SvSHARED_HEK_FROM_PV(pvx) \ |
1359 | ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key))) |
0a356b31 |
1360 | #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash) |
c158a4fd |
1361 | |
baca2b92 |
1362 | /* flag values for sv_*_flags functions */ |
1363 | #define SV_IMMEDIATE_UNREF 1 |
1364 | #define SV_GMAGIC 2 |
765f542d |
1365 | #define SV_COW_DROP_PV 4 |
88632417 |
1366 | #define SV_UTF8_NO_ENCODING 8 |
5fcdf167 |
1367 | #define SV_NOSTEAL 16 |
32a5c6ec |
1368 | #define SV_CONST_RETURN 32 |
1369 | #define SV_MUTABLE_RETURN 64 |
bddd5118 |
1370 | #define SV_SMAGIC 128 |
765f542d |
1371 | |
5abc721d |
1372 | #define sv_unref(sv) sv_unref_flags(sv, 0) |
1373 | #define sv_force_normal(sv) sv_force_normal_flags(sv, 0) |
174c73e3 |
1374 | |
46187eeb |
1375 | /* We are about to replace the SV's current value. So if it's copy on write |
1376 | we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that |
1377 | the value is about to get thrown away, so drop the PV rather than go to |
1378 | the effort of making a read-write copy only for it to get immediately |
1379 | discarded. */ |
765f542d |
1380 | |
1381 | #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \ |
1382 | sv_force_normal_flags(sv, SV_COW_DROP_PV) |
46187eeb |
1383 | |
f8c7b90f |
1384 | #ifdef PERL_OLD_COPY_ON_WRITE |
46187eeb |
1385 | # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \ |
b885210e |
1386 | && Perl_sv_release_IVX(aTHX_ sv))) |
46187eeb |
1387 | # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv)) |
b8f9541a |
1388 | #else |
1389 | # define SvRELEASE_IVX(sv) SvOOK_off(sv) |
f8c7b90f |
1390 | #endif /* PERL_OLD_COPY_ON_WRITE */ |
ed252734 |
1391 | |
1392 | #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \ |
1393 | SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \ |
1394 | SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC) |
1395 | #define CAN_COW_FLAGS (SVp_POK|SVf_POK) |
1396 | |
765f542d |
1397 | #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \ |
1398 | sv_force_normal_flags(sv, 0) |
1399 | |
1400 | |
baca2b92 |
1401 | /* all these 'functions' are now just macros */ |
1402 | |
1403 | #define sv_pv(sv) SvPV_nolen(sv) |
1404 | #define sv_pvutf8(sv) SvPVutf8_nolen(sv) |
1405 | #define sv_pvbyte(sv) SvPVbyte_nolen(sv) |
1406 | |
1407 | #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0) |
1408 | #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0) |
1409 | #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0) |
1410 | #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC) |
1411 | #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0) |
1412 | #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC) |
1413 | #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0) |
b347df82 |
1414 | #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC) |
baca2b92 |
1415 | #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC) |
b347df82 |
1416 | #define sv_catpvn_mg(sv, sstr, slen) \ |
1417 | sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC); |
baca2b92 |
1418 | #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC) |
cb2f1b7b |
1419 | #define sv_2pv_nolen(sv) sv_2pv(sv, 0) |
1420 | #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0) |
1421 | #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0) |
baca2b92 |
1422 | #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0) |
1423 | #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC) |
1424 | #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC) |
891f9566 |
1425 | #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC) |
1426 | #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC) |
baca2b92 |
1427 | |
db79b45b |
1428 | /* Should be named SvCatPVN_utf8_upgrade? */ |
1429 | #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \ |
1430 | STMT_START { \ |
1431 | if (!(nsv)) \ |
1432 | nsv = sv_2mortal(newSVpvn(sstr, slen)); \ |
1433 | else \ |
1434 | sv_setpvn(nsv, sstr, slen); \ |
1435 | SvUTF8_off(nsv); \ |
1436 | sv_utf8_upgrade(nsv); \ |
1437 | sv_catsv(dsv, nsv); \ |
1438 | } STMT_END |
79072805 |
1439 | |
954c1994 |
1440 | /* |
1441 | =for apidoc Am|SV*|newRV_inc|SV* sv |
1442 | |
1443 | Creates an RV wrapper for an SV. The reference count for the original SV is |
1444 | incremented. |
1445 | |
1446 | =cut |
1447 | */ |
1448 | |
5f05dabc |
1449 | #define newRV_inc(sv) newRV(sv) |
5f05dabc |
1450 | |
ef50df4b |
1451 | /* the following macros update any magic values this sv is associated with */ |
79072805 |
1452 | |
954c1994 |
1453 | /* |
ccfc67b7 |
1454 | =head1 Magical Functions |
1455 | |
954c1994 |
1456 | =for apidoc Am|void|SvGETMAGIC|SV* sv |
1457 | Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its |
1458 | argument more than once. |
1459 | |
1460 | =for apidoc Am|void|SvSETMAGIC|SV* sv |
1461 | Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its |
1462 | argument more than once. |
1463 | |
1464 | =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv |
1465 | Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments |
1466 | more than once. |
1467 | |
1468 | =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv |
1469 | Calls a non-destructive version of C<sv_setsv> if dsv is not the same as |
1470 | ssv. May evaluate arguments more than once. |
1471 | |
645c22ef |
1472 | =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv |
1473 | Like C<SvSetSV>, but does any set magic required afterwards. |
1474 | |
1475 | =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv |
80663158 |
1476 | Like C<SvSetSV_nosteal>, but does any set magic required afterwards. |
645c22ef |
1477 | |
68795e93 |
1478 | =for apidoc Am|void|SvSHARE|SV* sv |
1479 | Arranges for sv to be shared between threads if a suitable module |
1480 | has been loaded. |
1481 | |
1482 | =for apidoc Am|void|SvLOCK|SV* sv |
1483 | Arranges for a mutual exclusion lock to be obtained on sv if a suitable module |
1484 | has been loaded. |
1485 | |
1486 | =for apidoc Am|void|SvUNLOCK|SV* sv |
1487 | Releases a mutual exclusion lock on sv if a suitable module |
1488 | has been loaded. |
1489 | |
ccfc67b7 |
1490 | =head1 SV Manipulation Functions |
1491 | |
679ac26e |
1492 | =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len |
954c1994 |
1493 | Expands the character buffer in the SV so that it has room for the |
1494 | indicated number of bytes (remember to reserve space for an extra trailing |
8cf8f3d1 |
1495 | NUL character). Calls C<sv_grow> to perform the expansion if necessary. |
954c1994 |
1496 | Returns a pointer to the character buffer. |
1497 | |
1498 | =cut |
1499 | */ |
1500 | |
68795e93 |
1501 | #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv) |
1502 | #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv) |
1503 | #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv) |
1504 | |
189b2af5 |
1505 | #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END |
1506 | #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END |
79072805 |
1507 | |
54310121 |
1508 | #define SvSetSV_and(dst,src,finally) \ |
189b2af5 |
1509 | STMT_START { \ |
54310121 |
1510 | if ((dst) != (src)) { \ |
1511 | sv_setsv(dst, src); \ |
1512 | finally; \ |
189b2af5 |
1513 | } \ |
1514 | } STMT_END |
54310121 |
1515 | #define SvSetSV_nosteal_and(dst,src,finally) \ |
189b2af5 |
1516 | STMT_START { \ |
8ebc5c01 |
1517 | if ((dst) != (src)) { \ |
5fcdf167 |
1518 | sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL); \ |
54310121 |
1519 | finally; \ |
189b2af5 |
1520 | } \ |
1521 | } STMT_END |
79072805 |
1522 | |
54310121 |
1523 | #define SvSetSV(dst,src) \ |
c9d716f7 |
1524 | SvSetSV_and(dst,src,/*nothing*/;) |
54310121 |
1525 | #define SvSetSV_nosteal(dst,src) \ |
c9d716f7 |
1526 | SvSetSV_nosteal_and(dst,src,/*nothing*/;) |
54310121 |
1527 | |
1528 | #define SvSetMagicSV(dst,src) \ |
1529 | SvSetSV_and(dst,src,SvSETMAGIC(dst)) |
1530 | #define SvSetMagicSV_nosteal(dst,src) \ |
1531 | SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst)) |
1532 | |
db79b45b |
1533 | |
1045810a |
1534 | #if !defined(SKIP_DEBUGGING) |
79072805 |
1535 | #define SvPEEK(sv) sv_peek(sv) |
3967c732 |
1536 | #else |
1537 | #define SvPEEK(sv) "" |
1538 | #endif |
79072805 |
1539 | |
5dc8bdac |
1540 | #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder) |
36477c24 |
1541 | |
3280af22 |
1542 | #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no) |
54310121 |
1543 | |
79072805 |
1544 | #define isGV(sv) (SvTYPE(sv) == SVt_PVGV) |
1545 | |
933fea7f |
1546 | #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv)) |
5902b6a9 |
1547 | #define SvGROW_mutable(sv,len) \ |
1548 | (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv)) |
933fea7f |
1549 | #define Sv_Grow sv_grow |
3d35f11b |
1550 | |
a0739874 |
1551 | #define CLONEf_COPY_STACKS 1 |
1552 | #define CLONEf_KEEP_PTR_TABLE 2 |
c43294b8 |
1553 | #define CLONEf_CLONE_HOST 4 |
0405e91e |
1554 | #define CLONEf_JOIN_IN 8 |
a0739874 |
1555 | |
8cf8f3d1 |
1556 | struct clone_params { |
d2d73c3e |
1557 | AV* stashes; |
1558 | UV flags; |
59b40662 |
1559 | PerlInterpreter *proto_perl; |
8cf8f3d1 |
1560 | }; |
102d3b8a |
1561 | |
1562 | /* |
1563 | * Local variables: |
1564 | * c-indentation-style: bsd |
1565 | * c-basic-offset: 4 |
1566 | * indent-tabs-mode: t |
1567 | * End: |
1568 | * |
1569 | * ex: set ts=8 sts=4 sw=4 noet: |
1570 | */ |