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