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