This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Get resolve -at mainline
[perl5.git] / sv.h
CommitLineData
a0d0e21e 1/* sv.h
79072805 2 *
4eb8286e 3 * Copyright (c) 1991-1999, Larry Wall
79072805
LW
4 *
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
7 *
79072805
LW
8 */
9
a0d0e21e
LW
10#ifdef sv_flags
11#undef sv_flags /* Convex has this in <signal.h> for sigvec() */
12#endif
13
79072805 14typedef enum {
a0d0e21e
LW
15 SVt_NULL, /* 0 */
16 SVt_IV, /* 1 */
17 SVt_NV, /* 2 */
18 SVt_RV, /* 3 */
19 SVt_PV, /* 4 */
20 SVt_PVIV, /* 5 */
21 SVt_PVNV, /* 6 */
22 SVt_PVMG, /* 7 */
23 SVt_PVBM, /* 8 */
24 SVt_PVLV, /* 9 */
25 SVt_PVAV, /* 10 */
26 SVt_PVHV, /* 11 */
27 SVt_PVCV, /* 12 */
28 SVt_PVGV, /* 13 */
29 SVt_PVFM, /* 14 */
30 SVt_PVIO /* 15 */
79072805
LW
31} svtype;
32
79072805
LW
33/* Using C's structural equivalence to help emulate C++ inheritance here... */
34
35struct sv {
463ee0b2 36 void* sv_any; /* pointer to something */
79072805 37 U32 sv_refcnt; /* how many references to us */
8990e307 38 U32 sv_flags; /* what we are */
79072805
LW
39};
40
41struct gv {
463ee0b2 42 XPVGV* sv_any; /* pointer to something */
79072805 43 U32 sv_refcnt; /* how many references to us */
8990e307 44 U32 sv_flags; /* what we are */
79072805
LW
45};
46
47struct cv {
232e078e 48 XPVCV* sv_any; /* pointer to something */
79072805 49 U32 sv_refcnt; /* how many references to us */
8990e307 50 U32 sv_flags; /* what we are */
79072805
LW
51};
52
53struct av {
463ee0b2 54 XPVAV* sv_any; /* pointer to something */
79072805 55 U32 sv_refcnt; /* how many references to us */
8990e307 56 U32 sv_flags; /* what we are */
79072805
LW
57};
58
59struct hv {
463ee0b2 60 XPVHV* sv_any; /* pointer to something */
79072805 61 U32 sv_refcnt; /* how many references to us */
8990e307
LW
62 U32 sv_flags; /* what we are */
63};
64
65struct io {
66 XPVIO* sv_any; /* pointer to something */
67 U32 sv_refcnt; /* how many references to us */
68 U32 sv_flags; /* what we are */
79072805
LW
69};
70
463ee0b2 71#define SvANY(sv) (sv)->sv_any
79072805 72#define SvFLAGS(sv) (sv)->sv_flags
aeea060c 73#define SvREFCNT(sv) (sv)->sv_refcnt
a863c7d1 74
dce16143
MB
75#ifdef USE_THREADS
76
dce16143
MB
77# ifdef EMULATE_ATOMIC_REFCOUNTS
78# define ATOMIC_INC(count) STMT_START { \
533c011a 79 MUTEX_LOCK(&PL_svref_mutex); \
dce16143 80 ++count; \
533c011a 81 MUTEX_UNLOCK(&PL_svref_mutex); \
dce16143 82 } STMT_END
0bfcb09d 83# define ATOMIC_DEC_AND_TEST(res,count) STMT_START { \
533c011a 84 MUTEX_LOCK(&PL_svref_mutex); \
0bfcb09d 85 res = (--count == 0); \
533c011a 86 MUTEX_UNLOCK(&PL_svref_mutex); \
dce16143
MB
87 } STMT_END
88# else
89# define ATOMIC_INC(count) atomic_inc(&count)
90# define ATOMIC_DEC_AND_TEST(res,count) (res = atomic_dec_and_test(&count))
91# endif /* EMULATE_ATOMIC_REFCOUNTS */
92#else
93# define ATOMIC_INC(count) (++count)
83b0a010 94# define ATOMIC_DEC_AND_TEST(res, count) (res = (--count == 0))
dce16143
MB
95#endif /* USE_THREADS */
96
a863c7d1 97#ifdef __GNUC__
dce16143
MB
98# define SvREFCNT_inc(sv) \
99 ({ \
100 SV *nsv = (SV*)(sv); \
101 if (nsv) \
102 ATOMIC_INC(SvREFCNT(nsv)); \
103 nsv; \
104 })
8990e307 105#else
a863c7d1 106# if defined(CRIPPLED_CC) || defined(USE_THREADS)
199100c8 107# define SvREFCNT_inc(sv) sv_newref((SV*)sv)
a863c7d1 108# else
dce16143 109# define SvREFCNT_inc(sv) \
6b88bc9c 110 ((PL_Sv=(SV*)(sv)), (PL_Sv && ATOMIC_INC(SvREFCNT(PL_Sv))), (SV*)PL_Sv)
a863c7d1 111# endif
8990e307
LW
112#endif
113
a863c7d1
MB
114#define SvREFCNT_dec(sv) sv_free((SV*)sv)
115
8990e307
LW
116#define SVTYPEMASK 0xff
117#define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
79072805
LW
118
119#define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
120
8990e307
LW
121#define SVs_PADBUSY 0x00000100 /* reserved for tmp or my already */
122#define SVs_PADTMP 0x00000200 /* in use as tmp */
123#define SVs_PADMY 0x00000400 /* in use a "my" variable */
124#define SVs_TEMP 0x00000800 /* string is stealable? */
125#define SVs_OBJECT 0x00001000 /* is "blessed" */
126#define SVs_GMG 0x00002000 /* has magical get method */
127#define SVs_SMG 0x00004000 /* has magical set method */
128#define SVs_RMG 0x00008000 /* has random magical methods */
129
130#define SVf_IOK 0x00010000 /* has valid public integer value */
131#define SVf_NOK 0x00020000 /* has valid public numeric value */
132#define SVf_POK 0x00040000 /* has valid public pointer value */
133#define SVf_ROK 0x00080000 /* has a valid reference pointer */
a0d0e21e 134
748a9306 135#define SVf_FAKE 0x00100000 /* glob or lexical is just a copy */
8990e307
LW
136#define SVf_OOK 0x00200000 /* has valid offset value */
137#define SVf_BREAK 0x00400000 /* refcnt is artificially low */
138#define SVf_READONLY 0x00800000 /* may not be modified */
139
6fc92669 140#define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
a0d0e21e 141
8990e307
LW
142#define SVp_IOK 0x01000000 /* has valid non-public integer value */
143#define SVp_NOK 0x02000000 /* has valid non-public numeric value */
144#define SVp_POK 0x04000000 /* has valid non-public pointer value */
145#define SVp_SCREAM 0x08000000 /* has been studied? */
146
a0d0e21e
LW
147#define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
148 SVp_IOK|SVp_NOK|SVp_POK)
149
9e7bc3e8 150#define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
a0d0e21e 151
8990e307
LW
152#define PRIVSHIFT 8
153
154/* Some private flags. */
155
25da4f38
IZ
156#define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
157
158#define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
8990e307
LW
159
160#define SVpbm_VALID 0x80000000
bbce6d69 161#define SVpbm_TAIL 0x40000000
8990e307 162
25da4f38
IZ
163#define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
164
bf6bd887 165#define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */
51594c39 166#define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
bf6bd887 167
810b8aa5
GS
168#define SVprv_WEAKREF 0x80000000 /* Weak reference */
169
ed6116ce
LW
170struct xrv {
171 SV * xrv_rv; /* pointer to another SV */
172};
173
79072805 174struct xpv {
ed6116ce
LW
175 char * xpv_pv; /* pointer to malloced string */
176 STRLEN xpv_cur; /* length of xpv_pv as a C string */
177 STRLEN xpv_len; /* allocated size */
79072805
LW
178};
179
180struct xpviv {
ed6116ce
LW
181 char * xpv_pv; /* pointer to malloced string */
182 STRLEN xpv_cur; /* length of xpv_pv as a C string */
183 STRLEN xpv_len; /* allocated size */
a0d0e21e 184 IV xiv_iv; /* integer value or pv offset */
79072805
LW
185};
186
ff68c719
PP
187struct xpvuv {
188 char * xpv_pv; /* pointer to malloced string */
189 STRLEN xpv_cur; /* length of xpv_pv as a C string */
190 STRLEN xpv_len; /* allocated size */
191 UV xuv_uv; /* unsigned value or pv offset */
192};
193
79072805 194struct xpvnv {
ed6116ce
LW
195 char * xpv_pv; /* pointer to malloced string */
196 STRLEN xpv_cur; /* length of xpv_pv as a C string */
197 STRLEN xpv_len; /* allocated size */
a0d0e21e 198 IV xiv_iv; /* integer value or pv offset */
65202027 199 NV xnv_nv; /* numeric value, if any */
79072805
LW
200};
201
6ee623d5 202/* These structure must match the beginning of struct xpvhv in hv.h. */
79072805 203struct xpvmg {
ed6116ce
LW
204 char * xpv_pv; /* pointer to malloced string */
205 STRLEN xpv_cur; /* length of xpv_pv as a C string */
206 STRLEN xpv_len; /* allocated size */
a0d0e21e 207 IV xiv_iv; /* integer value or pv offset */
65202027 208 NV xnv_nv; /* numeric value, if any */
79072805
LW
209 MAGIC* xmg_magic; /* linked list of magicalness */
210 HV* xmg_stash; /* class package */
211};
212
213struct xpvlv {
ed6116ce
LW
214 char * xpv_pv; /* pointer to malloced string */
215 STRLEN xpv_cur; /* length of xpv_pv as a C string */
216 STRLEN xpv_len; /* allocated size */
a0d0e21e 217 IV xiv_iv; /* integer value or pv offset */
65202027 218 NV xnv_nv; /* numeric value, if any */
79072805
LW
219 MAGIC* xmg_magic; /* linked list of magicalness */
220 HV* xmg_stash; /* class package */
8990e307 221
79072805
LW
222 STRLEN xlv_targoff;
223 STRLEN xlv_targlen;
224 SV* xlv_targ;
225 char xlv_type;
226};
227
228struct xpvgv {
ed6116ce
LW
229 char * xpv_pv; /* pointer to malloced string */
230 STRLEN xpv_cur; /* length of xpv_pv as a C string */
231 STRLEN xpv_len; /* allocated size */
a0d0e21e 232 IV xiv_iv; /* integer value or pv offset */
65202027 233 NV xnv_nv; /* numeric value, if any */
79072805
LW
234 MAGIC* xmg_magic; /* linked list of magicalness */
235 HV* xmg_stash; /* class package */
8990e307 236
79072805
LW
237 GP* xgv_gp;
238 char* xgv_name;
239 STRLEN xgv_namelen;
240 HV* xgv_stash;
a5f75d66 241 U8 xgv_flags;
79072805
LW
242};
243
244struct xpvbm {
ed6116ce
LW
245 char * xpv_pv; /* pointer to malloced string */
246 STRLEN xpv_cur; /* length of xpv_pv as a C string */
247 STRLEN xpv_len; /* allocated size */
a0d0e21e 248 IV xiv_iv; /* integer value or pv offset */
65202027 249 NV xnv_nv; /* numeric value, if any */
79072805
LW
250 MAGIC* xmg_magic; /* linked list of magicalness */
251 HV* xmg_stash; /* class package */
8990e307 252
79072805
LW
253 I32 xbm_useful; /* is this constant pattern being useful? */
254 U16 xbm_previous; /* how many characters in string before rare? */
255 U8 xbm_rare; /* rarest character in string */
256};
257
44a8e56a
PP
258/* This structure much match XPVCV */
259
77a005ab
MB
260typedef U16 cv_flags_t;
261
79072805 262struct xpvfm {
ed6116ce
LW
263 char * xpv_pv; /* pointer to malloced string */
264 STRLEN xpv_cur; /* length of xpv_pv as a C string */
265 STRLEN xpv_len; /* allocated size */
a0d0e21e 266 IV xiv_iv; /* integer value or pv offset */
65202027 267 NV xnv_nv; /* numeric value, if any */
79072805
LW
268 MAGIC* xmg_magic; /* linked list of magicalness */
269 HV* xmg_stash; /* class package */
8990e307 270
79072805
LW
271 HV * xcv_stash;
272 OP * xcv_start;
273 OP * xcv_root;
0cb96387 274 void (*xcv_xsub)(pTHXo_ CV*);
a0d0e21e
LW
275 ANY xcv_xsubany;
276 GV * xcv_gv;
79072805
LW
277 GV * xcv_filegv;
278 long xcv_depth; /* >= 2 indicates recursive call */
279 AV * xcv_padlist;
748a9306 280 CV * xcv_outside;
e858de61 281#ifdef USE_THREADS
f6d98b14 282 perl_mutex *xcv_mutexp; /* protects xcv_owner */
52e1cb5e 283 struct perl_thread *xcv_owner; /* current owner thread */
e858de61 284#endif /* USE_THREADS */
77a005ab 285 cv_flags_t xcv_flags;
44a8e56a 286
79072805
LW
287 I32 xfm_lines;
288};
289
8990e307
LW
290struct xpvio {
291 char * xpv_pv; /* pointer to malloced string */
292 STRLEN xpv_cur; /* length of xpv_pv as a C string */
293 STRLEN xpv_len; /* allocated size */
a0d0e21e 294 IV xiv_iv; /* integer value or pv offset */
65202027 295 NV xnv_nv; /* numeric value, if any */
8990e307
LW
296 MAGIC* xmg_magic; /* linked list of magicalness */
297 HV* xmg_stash; /* class package */
298
760ac839
LW
299 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
300 PerlIO * xio_ofp; /* but sockets need separate streams */
8990e307
LW
301 DIR * xio_dirp; /* for opendir, readdir, etc */
302 long xio_lines; /* $. */
303 long xio_page; /* $% */
304 long xio_page_len; /* $= */
305 long xio_lines_left; /* $- */
306 char * xio_top_name; /* $^ */
307 GV * xio_top_gv; /* $^ */
308 char * xio_fmt_name; /* $~ */
309 GV * xio_fmt_gv; /* $~ */
310 char * xio_bottom_name;/* $^B */
311 GV * xio_bottom_gv; /* $^B */
312 short xio_subprocess; /* -| or |- */
313 char xio_type;
314 char xio_flags;
315};
316
317#define IOf_ARGV 1 /* this fp iterates over ARGV */
318#define IOf_START 2 /* check for null ARGV and substitute '-' */
319#define IOf_FLUSH 4 /* this fp wants a flush after write op */
748a9306 320#define IOf_DIDTOP 8 /* just did top of form */
003e7f14 321#define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
fbad3eb5 322#define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
8990e307 323
ed6116ce
LW
324/* The following macros define implementation-independent predicates on SVs. */
325
79072805 326#define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
748a9306 327#define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
a0d0e21e 328#define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
25da4f38 329 SVp_IOK|SVp_NOK|SVf_IVisUV))
79072805 330
463ee0b2 331#define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
25da4f38
IZ
332#define SvOK_off(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
333 SVf_IVisUV), \
334 SvOOK_off(sv))
335#define SvOK_off_exc_UV(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC), \
a0d0e21e 336 SvOOK_off(sv))
79072805 337
8990e307
LW
338#define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
339#define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
340#define SvIOKp_on(sv) (SvOOK_off(sv), SvFLAGS(sv) |= SVp_IOK)
341#define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
342#define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
343#define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
344#define SvPOKp_on(sv) (SvFLAGS(sv) |= SVp_POK)
463ee0b2 345
79072805 346#define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
8990e307 347#define SvIOK_on(sv) (SvOOK_off(sv), \
a0d0e21e 348 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38 349#define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
827b7e14 350#define SvIOK_only(sv) (SvOK_off(sv), \
a0d0e21e 351 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38
IZ
352#define SvIOK_only_UV(sv) (SvOK_off_exc_UV(sv), \
353 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
354
355#define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
356 == (SVf_IOK|SVf_IVisUV))
357#define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
358 == SVf_IOK)
359
360#define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
361#define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
362#define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
79072805
LW
363
364#define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
a0d0e21e 365#define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
8990e307
LW
366#define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
367#define SvNOK_only(sv) (SvOK_off(sv), \
a0d0e21e 368 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
79072805
LW
369
370#define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
a0d0e21e 371#define SvPOK_on(sv) (SvFLAGS(sv) |= (SVf_POK|SVp_POK))
8990e307 372#define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
25da4f38 373#define SvPOK_only(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|SVf_IVisUV), \
a0d0e21e 374 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
79072805
LW
375
376#define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
377#define SvOOK_on(sv) (SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
378#define SvOOK_off(sv) (SvOOK(sv) && sv_backoff(sv))
79072805 379
a0d0e21e
LW
380#define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
381#define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
382#define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
383
ed6116ce 384#define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
a0d0e21e 385#define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
a0d0e21e 386#define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
79072805 387
8990e307
LW
388#define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
389#define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
390#define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
79072805 391
8990e307
LW
392#define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
393#define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
394#define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
ed6116ce 395
8990e307
LW
396#define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
397#define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
398#define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
ed6116ce 399
8990e307
LW
400#define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
401#define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
402#define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
ed6116ce 403
9e7bc3e8
JD
404#define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
405#define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
406#define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
a0d0e21e
LW
407
408/*
409#define Gv_AMG(stash) \
410 (HV_AMAGICmb(stash) && \
411 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
412*/
3280af22 413#define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
a0d0e21e 414
810b8aa5
GS
415#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
416 == (SVf_ROK|SVprv_WEAKREF))
417#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
418#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
419
a0d0e21e 420#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 421
8990e307 422#define SvPADBUSY(sv) (SvFLAGS(sv) & SVs_PADBUSY)
ed6116ce 423
8990e307
LW
424#define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
425#define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP|SVs_PADBUSY)
426#define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
ed6116ce 427
8990e307
LW
428#define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
429#define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY|SVs_PADBUSY)
ed6116ce 430
8990e307
LW
431#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
432#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
433#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 434
8990e307
LW
435#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
436#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
437#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 438
8990e307
LW
439#define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
440#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
441#define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
79072805 442
8990e307
LW
443#define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
444#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
445#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 446
8990e307
LW
447#define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
448#define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
449#define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
79072805 450
25da4f38
IZ
451#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
452#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
453#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
454
8990e307
LW
455#define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
456#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
457#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
458
8990e307
LW
459#define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
460#define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
461#define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
462
ed6116ce
LW
463#define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
464#define SvRVx(sv) SvRV(sv)
465
463ee0b2
LW
466#define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
467#define SvIVXx(sv) SvIVX(sv)
ff68c719
PP
468#define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
469#define SvUVXx(sv) SvUVX(sv)
463ee0b2
LW
470#define SvNVX(sv) ((XPVNV*)SvANY(sv))->xnv_nv
471#define SvNVXx(sv) SvNVX(sv)
472#define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
473#define SvPVXx(sv) SvPVX(sv)
79072805 474#define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
79072805
LW
475#define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
476#define SvLENx(sv) SvLEN(sv)
477#define SvEND(sv)(((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
6b88bc9c 478#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
79072805
LW
479#define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
480#define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
481
482#define SvIV_set(sv, val) \
80b92232
PP
483 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
484 (((XPVIV*) SvANY(sv))->xiv_iv = val); } STMT_END
79072805 485#define SvNV_set(sv, val) \
80b92232
PP
486 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
487 (((XPVNV*) SvANY(sv))->xnv_nv = val); } STMT_END
79072805 488#define SvPV_set(sv, val) \
80b92232
PP
489 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
490 (((XPV*) SvANY(sv))->xpv_pv = val); } STMT_END
79072805 491#define SvCUR_set(sv, val) \
80b92232
PP
492 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
493 (((XPV*) SvANY(sv))->xpv_cur = val); } STMT_END
79072805 494#define SvLEN_set(sv, val) \
80b92232
PP
495 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
496 (((XPV*) SvANY(sv))->xpv_len = val); } STMT_END
79072805 497#define SvEND_set(sv, val) \
80b92232
PP
498 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
499 (((XPV*) SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
79072805
LW
500
501#define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
502#define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
503#define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
504
505#define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
506
507#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
508#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
509#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
510#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
511
8990e307
LW
512#define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
513#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
514#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
515#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
516#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
517#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
518#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
519#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
520#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
521#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
522#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
523#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
524#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
525#define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
526#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
527#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
528
bbce6d69 529#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22
NIS
530#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
531#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 532
c6ee37c5
MB
533#define SvTAINT(sv) \
534 STMT_START { \
3280af22 535 if (PL_tainting) { \
c6ee37c5 536 dTHR; \
3280af22 537 if (PL_tainted) \
c6ee37c5
MB
538 SvTAINTED_on(sv); \
539 } \
540 } STMT_END
79072805 541
a0d0e21e 542#define SvPV_force(sv, lp) sv_pvn_force(sv, &lp)
463ee0b2 543#define SvPV(sv, lp) sv_pvn(sv, &lp)
1fa8b10d 544#define SvPV_nolen(sv) sv_pv(sv)
4e35701f
NIS
545#define SvIVx(sv) sv_iv(sv)
546#define SvUVx(sv) sv_uv(sv)
547#define SvNVx(sv) sv_nv(sv)
463ee0b2 548#define SvPVx(sv, lp) sv_pvn(sv, &lp)
a0d0e21e 549#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
4e35701f
NIS
550#define SvTRUEx(sv) sv_true(sv)
551
552#define SvIV(sv) SvIVx(sv)
553#define SvNV(sv) SvNVx(sv)
25da4f38 554#define SvUV(sv) SvUVx(sv)
4e35701f 555#define SvTRUE(sv) SvTRUEx(sv)
79072805 556
a80f87c4
GS
557#ifndef CRIPPLED_CC
558/* redefine some things to more efficient inlined versions */
79072805 559
25da4f38 560/* Let us hope that bitmaps for UV and IV are the same */
ff68c719 561#undef SvIV
463ee0b2 562#define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
79072805 563
ff68c719
PP
564#undef SvUV
565#define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
566
567#undef SvNV
463ee0b2 568#define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 569
ff68c719
PP
570#undef SvPV
571#define SvPV(sv, lp) \
572 (SvPOK(sv) ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv(sv, &lp))
79072805 573
ff68c719
PP
574#undef SvPV_force
575#define SvPV_force(sv, lp) \
576 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
577 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force(sv, &lp))
a0d0e21e 578
1fa8b10d
JD
579#undef SvPV_nolen
580#define SvPV_nolen(sv) \
581 (SvPOK(sv) ? SvPVX(sv) : sv_2pv_nolen(sv))
582
a80f87c4
GS
583#ifdef __GNUC__
584# undef SvIVx
585# undef SvUVx
586# undef SvNVx
587# undef SvPVx
588# undef SvTRUE
589# undef SvTRUEx
590# define SvIVx(sv) ({SV *nsv = (SV*)(sv); SvIV(nsv); })
591# define SvUVx(sv) ({SV *nsv = (SV*)(sv); SvUV(nsv); })
592# define SvNVx(sv) ({SV *nsv = (SV*)(sv); SvNV(nsv); })
593# define SvPVx(sv, lp) ({SV *nsv = (sv); SvPV(nsv, lp); })
594# define SvTRUE(sv) ( \
8990e307
LW
595 !sv \
596 ? 0 \
597 : SvPOK(sv) \
a80f87c4
GS
598 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
599 nxpv && \
600 (*nxpv->xpv_pv > '0' || \
601 nxpv->xpv_cur > 1 || \
602 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
79072805
LW
603 ? 1 \
604 : 0) \
605 : \
606 SvIOK(sv) \
463ee0b2 607 ? SvIVX(sv) != 0 \
79072805 608 : SvNOK(sv) \
463ee0b2
LW
609 ? SvNVX(sv) != 0.0 \
610 : sv_2bool(sv) )
a80f87c4
GS
611# define SvTRUEx(sv) ({SV *nsv = (sv); SvTRUE(nsv); })
612#else /* __GNUC__ */
613#ifndef USE_THREADS
614/* These inlined macros use globals, which will require a thread
615 * declaration in user code, so we avoid them under threads */
616
617# undef SvIVx
618# undef SvUVx
619# undef SvNVx
620# undef SvPVx
621# undef SvTRUE
622# undef SvTRUEx
6b88bc9c
GS
623# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
624# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
625# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
626# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
a80f87c4
GS
627# define SvTRUE(sv) ( \
628 !sv \
629 ? 0 \
630 : SvPOK(sv) \
6b88bc9c
GS
631 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
632 (*PL_Xpv->xpv_pv > '0' || \
633 PL_Xpv->xpv_cur > 1 || \
634 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
a80f87c4
GS
635 ? 1 \
636 : 0) \
637 : \
638 SvIOK(sv) \
639 ? SvIVX(sv) != 0 \
640 : SvNOK(sv) \
641 ? SvNVX(sv) != 0.0 \
642 : sv_2bool(sv) )
6b88bc9c 643# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
a80f87c4
GS
644#endif /* !USE_THREADS */
645#endif /* !__GNU__ */
646#endif /* !CRIPPLED_CC */
79072805 647
5f05dabc 648#define newRV_inc(sv) newRV(sv)
5f05dabc 649
ef50df4b 650/* the following macros update any magic values this sv is associated with */
79072805 651
189b2af5
GS
652#define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
653#define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
79072805 654
54310121 655#define SvSetSV_and(dst,src,finally) \
189b2af5 656 STMT_START { \
54310121
PP
657 if ((dst) != (src)) { \
658 sv_setsv(dst, src); \
659 finally; \
189b2af5
GS
660 } \
661 } STMT_END
54310121 662#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 663 STMT_START { \
8ebc5c01
PP
664 if ((dst) != (src)) { \
665 U32 tMpF = SvFLAGS(src) & SVs_TEMP; \
666 SvTEMP_off(src); \
667 sv_setsv(dst, src); \
668 SvFLAGS(src) |= tMpF; \
54310121 669 finally; \
189b2af5
GS
670 } \
671 } STMT_END
79072805 672
54310121 673#define SvSetSV(dst,src) \
c9d716f7 674 SvSetSV_and(dst,src,/*nothing*/;)
54310121 675#define SvSetSV_nosteal(dst,src) \
c9d716f7 676 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121
PP
677
678#define SvSetMagicSV(dst,src) \
679 SvSetSV_and(dst,src,SvSETMAGIC(dst))
680#define SvSetMagicSV_nosteal(dst,src) \
681 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
682
3967c732 683#ifdef DEBUGGING
79072805 684#define SvPEEK(sv) sv_peek(sv)
3967c732
JD
685#else
686#define SvPEEK(sv) ""
687#endif
79072805 688
3280af22 689#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no)
36477c24 690
3280af22 691#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 692
79072805
LW
693#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
694
933fea7f
GS
695#define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
696#define Sv_Grow sv_grow