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