This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
small nits in changes#4538,4539
[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
77ca0c92
LW
156#define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
157
25da4f38
IZ
158#define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
159
160#define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
8990e307
LW
161
162#define SVpbm_VALID 0x80000000
bbce6d69 163#define SVpbm_TAIL 0x40000000
8990e307 164
25da4f38
IZ
165#define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
166
bf6bd887 167#define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */
51594c39 168#define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
bf6bd887 169
810b8aa5
GS
170#define SVprv_WEAKREF 0x80000000 /* Weak reference */
171
ed6116ce
LW
172struct xrv {
173 SV * xrv_rv; /* pointer to another SV */
174};
175
79072805 176struct xpv {
ed6116ce
LW
177 char * xpv_pv; /* pointer to malloced string */
178 STRLEN xpv_cur; /* length of xpv_pv as a C string */
179 STRLEN xpv_len; /* allocated size */
79072805
LW
180};
181
182struct xpviv {
ed6116ce
LW
183 char * xpv_pv; /* pointer to malloced string */
184 STRLEN xpv_cur; /* length of xpv_pv as a C string */
185 STRLEN xpv_len; /* allocated size */
a0d0e21e 186 IV xiv_iv; /* integer value or pv offset */
79072805
LW
187};
188
ff68c719
PP
189struct xpvuv {
190 char * xpv_pv; /* pointer to malloced string */
191 STRLEN xpv_cur; /* length of xpv_pv as a C string */
192 STRLEN xpv_len; /* allocated size */
193 UV xuv_uv; /* unsigned value or pv offset */
194};
195
79072805 196struct xpvnv {
ed6116ce
LW
197 char * xpv_pv; /* pointer to malloced string */
198 STRLEN xpv_cur; /* length of xpv_pv as a C string */
199 STRLEN xpv_len; /* allocated size */
a0d0e21e 200 IV xiv_iv; /* integer value or pv offset */
65202027 201 NV xnv_nv; /* numeric value, if any */
79072805
LW
202};
203
6ee623d5 204/* These structure must match the beginning of struct xpvhv in hv.h. */
79072805 205struct xpvmg {
ed6116ce
LW
206 char * xpv_pv; /* pointer to malloced string */
207 STRLEN xpv_cur; /* length of xpv_pv as a C string */
208 STRLEN xpv_len; /* allocated size */
a0d0e21e 209 IV xiv_iv; /* integer value or pv offset */
65202027 210 NV xnv_nv; /* numeric value, if any */
79072805
LW
211 MAGIC* xmg_magic; /* linked list of magicalness */
212 HV* xmg_stash; /* class package */
213};
214
215struct xpvlv {
ed6116ce
LW
216 char * xpv_pv; /* pointer to malloced string */
217 STRLEN xpv_cur; /* length of xpv_pv as a C string */
218 STRLEN xpv_len; /* allocated size */
a0d0e21e 219 IV xiv_iv; /* integer value or pv offset */
65202027 220 NV xnv_nv; /* numeric value, if any */
79072805
LW
221 MAGIC* xmg_magic; /* linked list of magicalness */
222 HV* xmg_stash; /* class package */
8990e307 223
79072805
LW
224 STRLEN xlv_targoff;
225 STRLEN xlv_targlen;
226 SV* xlv_targ;
227 char xlv_type;
228};
229
230struct xpvgv {
ed6116ce
LW
231 char * xpv_pv; /* pointer to malloced string */
232 STRLEN xpv_cur; /* length of xpv_pv as a C string */
233 STRLEN xpv_len; /* allocated size */
a0d0e21e 234 IV xiv_iv; /* integer value or pv offset */
65202027 235 NV xnv_nv; /* numeric value, if any */
79072805
LW
236 MAGIC* xmg_magic; /* linked list of magicalness */
237 HV* xmg_stash; /* class package */
8990e307 238
79072805
LW
239 GP* xgv_gp;
240 char* xgv_name;
241 STRLEN xgv_namelen;
242 HV* xgv_stash;
a5f75d66 243 U8 xgv_flags;
79072805
LW
244};
245
246struct xpvbm {
ed6116ce
LW
247 char * xpv_pv; /* pointer to malloced string */
248 STRLEN xpv_cur; /* length of xpv_pv as a C string */
249 STRLEN xpv_len; /* allocated size */
a0d0e21e 250 IV xiv_iv; /* integer value or pv offset */
65202027 251 NV xnv_nv; /* numeric value, if any */
79072805
LW
252 MAGIC* xmg_magic; /* linked list of magicalness */
253 HV* xmg_stash; /* class package */
8990e307 254
79072805
LW
255 I32 xbm_useful; /* is this constant pattern being useful? */
256 U16 xbm_previous; /* how many characters in string before rare? */
257 U8 xbm_rare; /* rarest character in string */
258};
259
44a8e56a
PP
260/* This structure much match XPVCV */
261
77a005ab
MB
262typedef U16 cv_flags_t;
263
79072805 264struct xpvfm {
ed6116ce
LW
265 char * xpv_pv; /* pointer to malloced string */
266 STRLEN xpv_cur; /* length of xpv_pv as a C string */
267 STRLEN xpv_len; /* allocated size */
a0d0e21e 268 IV xiv_iv; /* integer value or pv offset */
65202027 269 NV xnv_nv; /* numeric value, if any */
79072805
LW
270 MAGIC* xmg_magic; /* linked list of magicalness */
271 HV* xmg_stash; /* class package */
8990e307 272
79072805
LW
273 HV * xcv_stash;
274 OP * xcv_start;
275 OP * xcv_root;
0cb96387 276 void (*xcv_xsub)(pTHXo_ CV*);
a0d0e21e
LW
277 ANY xcv_xsubany;
278 GV * xcv_gv;
b195d487
GS
279#if defined(PERL_BINCOMPAT_5005)
280 GV * xcv_filegv; /* XXX unused (and deprecated) */
281#endif
282 long xcv_depth; /* >= 2 indicates recursive call */
79072805 283 AV * xcv_padlist;
748a9306 284 CV * xcv_outside;
e858de61 285#ifdef USE_THREADS
f6d98b14 286 perl_mutex *xcv_mutexp; /* protects xcv_owner */
52e1cb5e 287 struct perl_thread *xcv_owner; /* current owner thread */
e858de61 288#endif /* USE_THREADS */
77a005ab 289 cv_flags_t xcv_flags;
44a8e56a 290
79072805
LW
291 I32 xfm_lines;
292};
293
8990e307
LW
294struct xpvio {
295 char * xpv_pv; /* pointer to malloced string */
296 STRLEN xpv_cur; /* length of xpv_pv as a C string */
297 STRLEN xpv_len; /* allocated size */
a0d0e21e 298 IV xiv_iv; /* integer value or pv offset */
65202027 299 NV xnv_nv; /* numeric value, if any */
8990e307
LW
300 MAGIC* xmg_magic; /* linked list of magicalness */
301 HV* xmg_stash; /* class package */
302
760ac839
LW
303 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
304 PerlIO * xio_ofp; /* but sockets need separate streams */
8990e307
LW
305 DIR * xio_dirp; /* for opendir, readdir, etc */
306 long xio_lines; /* $. */
307 long xio_page; /* $% */
308 long xio_page_len; /* $= */
309 long xio_lines_left; /* $- */
310 char * xio_top_name; /* $^ */
311 GV * xio_top_gv; /* $^ */
312 char * xio_fmt_name; /* $~ */
313 GV * xio_fmt_gv; /* $~ */
314 char * xio_bottom_name;/* $^B */
315 GV * xio_bottom_gv; /* $^B */
316 short xio_subprocess; /* -| or |- */
317 char xio_type;
318 char xio_flags;
319};
320
321#define IOf_ARGV 1 /* this fp iterates over ARGV */
322#define IOf_START 2 /* check for null ARGV and substitute '-' */
323#define IOf_FLUSH 4 /* this fp wants a flush after write op */
748a9306 324#define IOf_DIDTOP 8 /* just did top of form */
003e7f14 325#define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
fbad3eb5 326#define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
8990e307 327
ed6116ce
LW
328/* The following macros define implementation-independent predicates on SVs. */
329
79072805 330#define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
748a9306 331#define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
a0d0e21e 332#define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
25da4f38 333 SVp_IOK|SVp_NOK|SVf_IVisUV))
79072805 334
463ee0b2 335#define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
25da4f38
IZ
336#define SvOK_off(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
337 SVf_IVisUV), \
338 SvOOK_off(sv))
339#define SvOK_off_exc_UV(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC), \
a0d0e21e 340 SvOOK_off(sv))
79072805 341
8990e307
LW
342#define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
343#define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
344#define SvIOKp_on(sv) (SvOOK_off(sv), SvFLAGS(sv) |= SVp_IOK)
345#define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
346#define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
347#define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
348#define SvPOKp_on(sv) (SvFLAGS(sv) |= SVp_POK)
463ee0b2 349
79072805 350#define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
8990e307 351#define SvIOK_on(sv) (SvOOK_off(sv), \
a0d0e21e 352 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38 353#define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
827b7e14 354#define SvIOK_only(sv) (SvOK_off(sv), \
a0d0e21e 355 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38
IZ
356#define SvIOK_only_UV(sv) (SvOK_off_exc_UV(sv), \
357 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
358
359#define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
360 == (SVf_IOK|SVf_IVisUV))
361#define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
362 == SVf_IOK)
363
364#define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
365#define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
366#define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
79072805
LW
367
368#define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
a0d0e21e 369#define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
8990e307
LW
370#define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
371#define SvNOK_only(sv) (SvOK_off(sv), \
a0d0e21e 372 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
79072805
LW
373
374#define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
a0d0e21e 375#define SvPOK_on(sv) (SvFLAGS(sv) |= (SVf_POK|SVp_POK))
8990e307 376#define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
25da4f38 377#define SvPOK_only(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|SVf_IVisUV), \
a0d0e21e 378 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
79072805
LW
379
380#define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
381#define SvOOK_on(sv) (SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
382#define SvOOK_off(sv) (SvOOK(sv) && sv_backoff(sv))
79072805 383
a0d0e21e
LW
384#define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
385#define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
386#define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
387
ed6116ce 388#define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
a0d0e21e 389#define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
a0d0e21e 390#define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
79072805 391
8990e307
LW
392#define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
393#define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
394#define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
79072805 395
8990e307
LW
396#define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
397#define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
398#define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
ed6116ce 399
8990e307
LW
400#define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
401#define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
402#define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
ed6116ce 403
8990e307
LW
404#define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
405#define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
406#define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
ed6116ce 407
9e7bc3e8
JD
408#define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
409#define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
410#define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
a0d0e21e
LW
411
412/*
413#define Gv_AMG(stash) \
414 (HV_AMAGICmb(stash) && \
415 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
416*/
3280af22 417#define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
a0d0e21e 418
810b8aa5
GS
419#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
420 == (SVf_ROK|SVprv_WEAKREF))
421#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
422#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
423
a0d0e21e 424#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 425
8990e307 426#define SvPADBUSY(sv) (SvFLAGS(sv) & SVs_PADBUSY)
ed6116ce 427
8990e307
LW
428#define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
429#define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP|SVs_PADBUSY)
430#define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
ed6116ce 431
8990e307
LW
432#define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
433#define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY|SVs_PADBUSY)
ed6116ce 434
8990e307
LW
435#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
436#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
437#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 438
8990e307
LW
439#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
440#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
441#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 442
8990e307
LW
443#define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
444#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
445#define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
79072805 446
8990e307
LW
447#define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
448#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
449#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 450
8990e307
LW
451#define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
452#define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
453#define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
79072805 454
25da4f38
IZ
455#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
456#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
457#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
458
8990e307
LW
459#define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
460#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
461#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
462
8990e307
LW
463#define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
464#define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
465#define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
466
ed6116ce
LW
467#define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
468#define SvRVx(sv) SvRV(sv)
469
463ee0b2
LW
470#define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
471#define SvIVXx(sv) SvIVX(sv)
ff68c719
PP
472#define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
473#define SvUVXx(sv) SvUVX(sv)
463ee0b2
LW
474#define SvNVX(sv) ((XPVNV*)SvANY(sv))->xnv_nv
475#define SvNVXx(sv) SvNVX(sv)
476#define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
477#define SvPVXx(sv) SvPVX(sv)
79072805 478#define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
79072805
LW
479#define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
480#define SvLENx(sv) SvLEN(sv)
481#define SvEND(sv)(((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
6b88bc9c 482#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
79072805
LW
483#define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
484#define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
485
486#define SvIV_set(sv, val) \
80b92232
PP
487 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
488 (((XPVIV*) SvANY(sv))->xiv_iv = val); } STMT_END
79072805 489#define SvNV_set(sv, val) \
80b92232
PP
490 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
491 (((XPVNV*) SvANY(sv))->xnv_nv = val); } STMT_END
79072805 492#define SvPV_set(sv, val) \
80b92232
PP
493 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
494 (((XPV*) SvANY(sv))->xpv_pv = val); } STMT_END
79072805 495#define SvCUR_set(sv, val) \
80b92232
PP
496 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
497 (((XPV*) SvANY(sv))->xpv_cur = val); } STMT_END
79072805 498#define SvLEN_set(sv, val) \
80b92232
PP
499 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
500 (((XPV*) SvANY(sv))->xpv_len = val); } STMT_END
79072805 501#define SvEND_set(sv, val) \
80b92232
PP
502 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
503 (((XPV*) SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
79072805
LW
504
505#define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
506#define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
507#define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
508
509#define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
510
511#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
512#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
513#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
514#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
515
8990e307
LW
516#define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
517#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
518#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
519#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
520#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
521#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
522#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
523#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
524#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
525#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
526#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
527#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
528#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
529#define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
530#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
531#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
532
bbce6d69 533#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22
NIS
534#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
535#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 536
c6ee37c5
MB
537#define SvTAINT(sv) \
538 STMT_START { \
3280af22 539 if (PL_tainting) { \
c6ee37c5 540 dTHR; \
3280af22 541 if (PL_tainted) \
c6ee37c5
MB
542 SvTAINTED_on(sv); \
543 } \
544 } STMT_END
79072805 545
a0d0e21e 546#define SvPV_force(sv, lp) sv_pvn_force(sv, &lp)
463ee0b2 547#define SvPV(sv, lp) sv_pvn(sv, &lp)
1fa8b10d 548#define SvPV_nolen(sv) sv_pv(sv)
4e35701f
NIS
549#define SvIVx(sv) sv_iv(sv)
550#define SvUVx(sv) sv_uv(sv)
551#define SvNVx(sv) sv_nv(sv)
463ee0b2 552#define SvPVx(sv, lp) sv_pvn(sv, &lp)
a0d0e21e 553#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
4e35701f
NIS
554#define SvTRUEx(sv) sv_true(sv)
555
556#define SvIV(sv) SvIVx(sv)
557#define SvNV(sv) SvNVx(sv)
25da4f38 558#define SvUV(sv) SvUVx(sv)
4e35701f 559#define SvTRUE(sv) SvTRUEx(sv)
79072805 560
a80f87c4
GS
561#ifndef CRIPPLED_CC
562/* redefine some things to more efficient inlined versions */
79072805 563
25da4f38 564/* Let us hope that bitmaps for UV and IV are the same */
ff68c719 565#undef SvIV
463ee0b2 566#define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
79072805 567
ff68c719
PP
568#undef SvUV
569#define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
570
571#undef SvNV
463ee0b2 572#define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 573
ff68c719
PP
574#undef SvPV
575#define SvPV(sv, lp) \
576 (SvPOK(sv) ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv(sv, &lp))
79072805 577
ff68c719
PP
578#undef SvPV_force
579#define SvPV_force(sv, lp) \
580 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
581 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force(sv, &lp))
a0d0e21e 582
1fa8b10d
JD
583#undef SvPV_nolen
584#define SvPV_nolen(sv) \
585 (SvPOK(sv) ? SvPVX(sv) : sv_2pv_nolen(sv))
586
a80f87c4
GS
587#ifdef __GNUC__
588# undef SvIVx
589# undef SvUVx
590# undef SvNVx
591# undef SvPVx
592# undef SvTRUE
593# undef SvTRUEx
594# define SvIVx(sv) ({SV *nsv = (SV*)(sv); SvIV(nsv); })
595# define SvUVx(sv) ({SV *nsv = (SV*)(sv); SvUV(nsv); })
596# define SvNVx(sv) ({SV *nsv = (SV*)(sv); SvNV(nsv); })
597# define SvPVx(sv, lp) ({SV *nsv = (sv); SvPV(nsv, lp); })
598# define SvTRUE(sv) ( \
8990e307
LW
599 !sv \
600 ? 0 \
601 : SvPOK(sv) \
a80f87c4
GS
602 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
603 nxpv && \
604 (*nxpv->xpv_pv > '0' || \
605 nxpv->xpv_cur > 1 || \
606 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
79072805
LW
607 ? 1 \
608 : 0) \
609 : \
610 SvIOK(sv) \
463ee0b2 611 ? SvIVX(sv) != 0 \
79072805 612 : SvNOK(sv) \
463ee0b2
LW
613 ? SvNVX(sv) != 0.0 \
614 : sv_2bool(sv) )
a80f87c4
GS
615# define SvTRUEx(sv) ({SV *nsv = (sv); SvTRUE(nsv); })
616#else /* __GNUC__ */
617#ifndef USE_THREADS
618/* These inlined macros use globals, which will require a thread
619 * declaration in user code, so we avoid them under threads */
620
621# undef SvIVx
622# undef SvUVx
623# undef SvNVx
624# undef SvPVx
625# undef SvTRUE
626# undef SvTRUEx
6b88bc9c
GS
627# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
628# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
629# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
630# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
a80f87c4
GS
631# define SvTRUE(sv) ( \
632 !sv \
633 ? 0 \
634 : SvPOK(sv) \
6b88bc9c
GS
635 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
636 (*PL_Xpv->xpv_pv > '0' || \
637 PL_Xpv->xpv_cur > 1 || \
638 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
a80f87c4
GS
639 ? 1 \
640 : 0) \
641 : \
642 SvIOK(sv) \
643 ? SvIVX(sv) != 0 \
644 : SvNOK(sv) \
645 ? SvNVX(sv) != 0.0 \
646 : sv_2bool(sv) )
6b88bc9c 647# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
a80f87c4
GS
648#endif /* !USE_THREADS */
649#endif /* !__GNU__ */
650#endif /* !CRIPPLED_CC */
79072805 651
5f05dabc 652#define newRV_inc(sv) newRV(sv)
5f05dabc 653
ef50df4b 654/* the following macros update any magic values this sv is associated with */
79072805 655
189b2af5
GS
656#define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
657#define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
79072805 658
54310121 659#define SvSetSV_and(dst,src,finally) \
189b2af5 660 STMT_START { \
54310121
PP
661 if ((dst) != (src)) { \
662 sv_setsv(dst, src); \
663 finally; \
189b2af5
GS
664 } \
665 } STMT_END
54310121 666#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 667 STMT_START { \
8ebc5c01
PP
668 if ((dst) != (src)) { \
669 U32 tMpF = SvFLAGS(src) & SVs_TEMP; \
670 SvTEMP_off(src); \
671 sv_setsv(dst, src); \
672 SvFLAGS(src) |= tMpF; \
54310121 673 finally; \
189b2af5
GS
674 } \
675 } STMT_END
79072805 676
54310121 677#define SvSetSV(dst,src) \
c9d716f7 678 SvSetSV_and(dst,src,/*nothing*/;)
54310121 679#define SvSetSV_nosteal(dst,src) \
c9d716f7 680 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121
PP
681
682#define SvSetMagicSV(dst,src) \
683 SvSetSV_and(dst,src,SvSETMAGIC(dst))
684#define SvSetMagicSV_nosteal(dst,src) \
685 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
686
3967c732 687#ifdef DEBUGGING
79072805 688#define SvPEEK(sv) sv_peek(sv)
3967c732
JD
689#else
690#define SvPEEK(sv) ""
691#endif
79072805 692
3280af22 693#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no)
36477c24 694
3280af22 695#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 696
79072805
LW
697#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
698
933fea7f
GS
699#define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
700#define Sv_Grow sv_grow