[inseparable changes from patch from perl5.003_18 to perl5.003_19]
[perl.git] / sv.h
1 /*    sv.h
2  *
3  *    Copyright (c) 1991-1994, Larry Wall
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  *
8  */
9
10 #ifdef sv_flags
11 #undef sv_flags         /* Convex has this in <signal.h> for sigvec() */
12 #endif
13
14 typedef enum {
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 */
31 } svtype;
32
33 /* Using C's structural equivalence to help emulate C++ inheritance here... */
34
35 struct sv {
36     void*       sv_any;         /* pointer to something */
37     U32         sv_refcnt;      /* how many references to us */
38     U32         sv_flags;       /* what we are */
39 };
40
41 struct gv {
42     XPVGV*      sv_any;         /* pointer to something */
43     U32         sv_refcnt;      /* how many references to us */
44     U32         sv_flags;       /* what we are */
45 };
46
47 struct cv {
48     XPVCV*      sv_any;         /* pointer to something */
49     U32         sv_refcnt;      /* how many references to us */
50     U32         sv_flags;       /* what we are */
51 };
52
53 struct av {
54     XPVAV*      sv_any;         /* pointer to something */
55     U32         sv_refcnt;      /* how many references to us */
56     U32         sv_flags;       /* what we are */
57 };
58
59 struct hv {
60     XPVHV*      sv_any;         /* pointer to something */
61     U32         sv_refcnt;      /* how many references to us */
62     U32         sv_flags;       /* what we are */
63 };
64
65 struct io {
66     XPVIO*      sv_any;         /* pointer to something */
67     U32         sv_refcnt;      /* how many references to us */
68     U32         sv_flags;       /* what we are */
69 };
70
71 #define SvANY(sv)       (sv)->sv_any
72 #define SvFLAGS(sv)     (sv)->sv_flags
73
74 #define SvREFCNT(sv)    (sv)->sv_refcnt
75 #ifdef CRIPPLED_CC
76 #define SvREFCNT_inc(sv)        sv_newref((SV*)sv)
77 #define SvREFCNT_dec(sv)        sv_free((SV*)sv)
78 #else
79 #define SvREFCNT_inc(sv)        ((Sv = (SV*)(sv)), \
80                                     (Sv && ++SvREFCNT(Sv)), (SV*)Sv)
81 #define SvREFCNT_dec(sv)        sv_free((SV*)sv)
82 #endif
83
84 #define SVTYPEMASK      0xff
85 #define SvTYPE(sv)      ((sv)->sv_flags & SVTYPEMASK)
86
87 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
88
89 #define SVs_PADBUSY     0x00000100      /* reserved for tmp or my already */
90 #define SVs_PADTMP      0x00000200      /* in use as tmp */
91 #define SVs_PADMY       0x00000400      /* in use a "my" variable */
92 #define SVs_TEMP        0x00000800      /* string is stealable? */
93 #define SVs_OBJECT      0x00001000      /* is "blessed" */
94 #define SVs_GMG         0x00002000      /* has magical get method */
95 #define SVs_SMG         0x00004000      /* has magical set method */
96 #define SVs_RMG         0x00008000      /* has random magical methods */
97
98 #define SVf_IOK         0x00010000      /* has valid public integer value */
99 #define SVf_NOK         0x00020000      /* has valid public numeric value */
100 #define SVf_POK         0x00040000      /* has valid public pointer value */
101 #define SVf_ROK         0x00080000      /* has a valid reference pointer */
102
103 #define SVf_FAKE        0x00100000      /* glob or lexical is just a copy */
104 #define SVf_OOK         0x00200000      /* has valid offset value */
105 #define SVf_BREAK       0x00400000      /* refcnt is artificially low */
106 #define SVf_READONLY    0x00800000      /* may not be modified */
107
108 #define SVf_THINKFIRST  (SVf_READONLY|SVf_ROK)
109
110 #define SVp_IOK         0x01000000      /* has valid non-public integer value */
111 #define SVp_NOK         0x02000000      /* has valid non-public numeric value */
112 #define SVp_POK         0x04000000      /* has valid non-public pointer value */
113 #define SVp_SCREAM      0x08000000      /* has been studied? */
114
115 #define SVf_OK          (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
116                          SVp_IOK|SVp_NOK|SVp_POK)
117
118 #ifdef OVERLOAD
119 #define SVf_AMAGIC    0x10000000      /* has magical overloaded methods */
120 #endif /* OVERLOAD */
121
122 #define PRIVSHIFT 8
123
124 /* Some private flags. */
125
126 #define SVpfm_COMPILED  0x80000000
127
128 #define SVpbm_VALID     0x80000000
129 #define SVpbm_TAIL      0x40000000
130
131 #define SVphv_SHAREKEYS 0x20000000      /* keys live on shared string table */
132 #define SVphv_LAZYDEL   0x40000000      /* entry in xhv_eiter must be deleted */
133
134 struct xrv {
135     SV *        xrv_rv;         /* pointer to another SV */
136 };
137
138 struct xpv {
139     char *      xpv_pv;         /* pointer to malloced string */
140     STRLEN      xpv_cur;        /* length of xpv_pv as a C string */
141     STRLEN      xpv_len;        /* allocated size */
142 };
143
144 struct xpviv {
145     char *      xpv_pv;         /* pointer to malloced string */
146     STRLEN      xpv_cur;        /* length of xpv_pv as a C string */
147     STRLEN      xpv_len;        /* allocated size */
148     IV          xiv_iv;         /* integer value or pv offset */
149 };
150
151 struct xpvuv {
152     char *      xpv_pv;         /* pointer to malloced string */
153     STRLEN      xpv_cur;        /* length of xpv_pv as a C string */
154     STRLEN      xpv_len;        /* allocated size */
155     UV          xuv_uv;         /* unsigned value or pv offset */
156 };
157
158 struct xpvnv {
159     char *      xpv_pv;         /* pointer to malloced string */
160     STRLEN      xpv_cur;        /* length of xpv_pv as a C string */
161     STRLEN      xpv_len;        /* allocated size */
162     IV          xiv_iv;         /* integer value or pv offset */
163     double      xnv_nv;         /* numeric value, if any */
164 };
165
166 struct xpvmg {
167     char *      xpv_pv;         /* pointer to malloced string */
168     STRLEN      xpv_cur;        /* length of xpv_pv as a C string */
169     STRLEN      xpv_len;        /* allocated size */
170     IV          xiv_iv;         /* integer value or pv offset */
171     double      xnv_nv;         /* numeric value, if any */
172     MAGIC*      xmg_magic;      /* linked list of magicalness */
173     HV*         xmg_stash;      /* class package */
174 };
175
176 struct xpvlv {
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 */
180     IV          xiv_iv;         /* integer value or pv offset */
181     double      xnv_nv;         /* numeric value, if any */
182     MAGIC*      xmg_magic;      /* linked list of magicalness */
183     HV*         xmg_stash;      /* class package */
184
185     STRLEN      xlv_targoff;
186     STRLEN      xlv_targlen;
187     SV*         xlv_targ;
188     char        xlv_type;
189 };
190
191 struct xpvgv {
192     char *      xpv_pv;         /* pointer to malloced string */
193     STRLEN      xpv_cur;        /* length of xpv_pv as a C string */
194     STRLEN      xpv_len;        /* allocated size */
195     IV          xiv_iv;         /* integer value or pv offset */
196     double      xnv_nv;         /* numeric value, if any */
197     MAGIC*      xmg_magic;      /* linked list of magicalness */
198     HV*         xmg_stash;      /* class package */
199
200     GP*         xgv_gp;
201     char*       xgv_name;
202     STRLEN      xgv_namelen;
203     HV*         xgv_stash;
204     U8          xgv_flags;
205 };
206
207 struct xpvbm {
208     char *      xpv_pv;         /* pointer to malloced string */
209     STRLEN      xpv_cur;        /* length of xpv_pv as a C string */
210     STRLEN      xpv_len;        /* allocated size */
211     IV          xiv_iv;         /* integer value or pv offset */
212     double      xnv_nv;         /* numeric value, if any */
213     MAGIC*      xmg_magic;      /* linked list of magicalness */
214     HV*         xmg_stash;      /* class package */
215
216     I32         xbm_useful;     /* is this constant pattern being useful? */
217     U16         xbm_previous;   /* how many characters in string before rare? */
218     U8          xbm_rare;       /* rarest character in string */
219 };
220
221 struct xpvfm {
222     char *      xpv_pv;         /* pointer to malloced string */
223     STRLEN      xpv_cur;        /* length of xpv_pv as a C string */
224     STRLEN      xpv_len;        /* allocated size */
225     IV          xiv_iv;         /* integer value or pv offset */
226     double      xnv_nv;         /* numeric value, if any */
227     MAGIC*      xmg_magic;      /* linked list of magicalness */
228     HV*         xmg_stash;      /* class package */
229
230     HV *        xcv_stash;
231     OP *        xcv_start;
232     OP *        xcv_root;
233     void      (*xcv_xsub)_((CV*));
234     ANY         xcv_xsubany;
235     GV *        xcv_gv;
236     GV *        xcv_filegv;
237     long        xcv_depth;              /* >= 2 indicates recursive call */
238     AV *        xcv_padlist;
239     CV *        xcv_outside;
240     I32         xfm_lines;
241 };
242
243 struct xpvio {
244     char *      xpv_pv;         /* pointer to malloced string */
245     STRLEN      xpv_cur;        /* length of xpv_pv as a C string */
246     STRLEN      xpv_len;        /* allocated size */
247     IV          xiv_iv;         /* integer value or pv offset */
248     double      xnv_nv;         /* numeric value, if any */
249     MAGIC*      xmg_magic;      /* linked list of magicalness */
250     HV*         xmg_stash;      /* class package */
251
252     PerlIO *    xio_ifp;        /* ifp and ofp are normally the same */
253     PerlIO *    xio_ofp;        /* but sockets need separate streams */
254     DIR *       xio_dirp;       /* for opendir, readdir, etc */
255     long        xio_lines;      /* $. */
256     long        xio_page;       /* $% */
257     long        xio_page_len;   /* $= */
258     long        xio_lines_left; /* $- */
259     char *      xio_top_name;   /* $^ */
260     GV *        xio_top_gv;     /* $^ */
261     char *      xio_fmt_name;   /* $~ */
262     GV *        xio_fmt_gv;     /* $~ */
263     char *      xio_bottom_name;/* $^B */
264     GV *        xio_bottom_gv;  /* $^B */
265     short       xio_subprocess; /* -| or |- */
266     char        xio_type;
267     char        xio_flags;
268 };
269
270 #define IOf_ARGV 1      /* this fp iterates over ARGV */
271 #define IOf_START 2     /* check for null ARGV and substitute '-' */
272 #define IOf_FLUSH 4     /* this fp wants a flush after write op */
273 #define IOf_DIDTOP 8    /* just did top of form */
274 #define IOf_UNTAINT 16  /* consider this fp (and it's data) "safe" */
275
276 /* The following macros define implementation-independent predicates on SVs. */
277
278 #define SvNIOK(sv)              (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
279 #define SvNIOKp(sv)             (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
280 #define SvNIOK_off(sv)          (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
281                                                   SVp_IOK|SVp_NOK))
282
283 #define SvOK(sv)                (SvFLAGS(sv) & SVf_OK)
284
285 #ifdef OVERLOAD
286 #define SvOK_off(sv)            (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC),   \
287                                                         SvOOK_off(sv))
288 #else
289 #define SvOK_off(sv)            (SvFLAGS(sv) &= ~SVf_OK, SvOOK_off(sv))
290 #endif /* OVERLOAD */
291
292 #define SvOKp(sv)               (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
293 #define SvIOKp(sv)              (SvFLAGS(sv) & SVp_IOK)
294 #define SvIOKp_on(sv)           (SvOOK_off(sv), SvFLAGS(sv) |= SVp_IOK)
295 #define SvNOKp(sv)              (SvFLAGS(sv) & SVp_NOK)
296 #define SvNOKp_on(sv)           (SvFLAGS(sv) |= SVp_NOK)
297 #define SvPOKp(sv)              (SvFLAGS(sv) & SVp_POK)
298 #define SvPOKp_on(sv)           (SvFLAGS(sv) |= SVp_POK)
299
300 #define SvIOK(sv)               (SvFLAGS(sv) & SVf_IOK)
301 #define SvIOK_on(sv)            (SvOOK_off(sv), \
302                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
303 #define SvIOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK))
304 #define SvIOK_only(sv)          (SvOOK_off(sv), SvOK_off(sv), \
305                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
306
307 #define SvNOK(sv)               (SvFLAGS(sv) & SVf_NOK)
308 #define SvNOK_on(sv)            (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
309 #define SvNOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
310 #define SvNOK_only(sv)          (SvOK_off(sv), \
311                                     SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
312
313 #define SvPOK(sv)               (SvFLAGS(sv) & SVf_POK)
314 #define SvPOK_on(sv)            (SvFLAGS(sv) |= (SVf_POK|SVp_POK))
315 #define SvPOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
316
317 #ifdef OVERLOAD
318 #define SvPOK_only(sv)            (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC),   \
319                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
320 #else
321 #define SvPOK_only(sv)            (SvFLAGS(sv) &= ~SVf_OK, \
322                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
323 #endif /* OVERLOAD */
324
325 #define SvOOK(sv)               (SvFLAGS(sv) & SVf_OOK)
326 #define SvOOK_on(sv)            (SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
327 #define SvOOK_off(sv)           (SvOOK(sv) && sv_backoff(sv))
328
329 #define SvFAKE(sv)              (SvFLAGS(sv) & SVf_FAKE)
330 #define SvFAKE_on(sv)           (SvFLAGS(sv) |= SVf_FAKE)
331 #define SvFAKE_off(sv)          (SvFLAGS(sv) &= ~SVf_FAKE)
332
333 #define SvROK(sv)               (SvFLAGS(sv) & SVf_ROK)
334 #define SvROK_on(sv)            (SvFLAGS(sv) |= SVf_ROK)
335
336 #ifdef OVERLOAD
337 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
338 #else
339 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~SVf_ROK)
340 #endif /* OVERLOAD */
341
342 #define SvMAGICAL(sv)           (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
343 #define SvMAGICAL_on(sv)        (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
344 #define SvMAGICAL_off(sv)       (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
345
346 #define SvGMAGICAL(sv)          (SvFLAGS(sv) & SVs_GMG)
347 #define SvGMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_GMG)
348 #define SvGMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_GMG)
349
350 #define SvSMAGICAL(sv)          (SvFLAGS(sv) & SVs_SMG)
351 #define SvSMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_SMG)
352 #define SvSMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_SMG)
353
354 #define SvRMAGICAL(sv)          (SvFLAGS(sv) & SVs_RMG)
355 #define SvRMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_RMG)
356 #define SvRMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_RMG)
357
358 #ifdef OVERLOAD
359 #define SvAMAGIC(sv)         (SvFLAGS(sv) & SVf_AMAGIC)
360 #define SvAMAGIC_on(sv)      (SvFLAGS(sv) |= SVf_AMAGIC)
361 #define SvAMAGIC_off(sv)     (SvFLAGS(sv) &= ~SVf_AMAGIC)
362
363 /*
364 #define Gv_AMG(stash) \
365         (HV_AMAGICmb(stash) && \
366          ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
367 */
368 #define Gv_AMG(stash)           (amagic_generation && Gv_AMupdate(stash))
369 #endif /* OVERLOAD */
370
371 #define SvTHINKFIRST(sv)        (SvFLAGS(sv) & SVf_THINKFIRST)
372
373 #define SvPADBUSY(sv)           (SvFLAGS(sv) & SVs_PADBUSY)
374
375 #define SvPADTMP(sv)            (SvFLAGS(sv) & SVs_PADTMP)
376 #define SvPADTMP_on(sv)         (SvFLAGS(sv) |= SVs_PADTMP|SVs_PADBUSY)
377 #define SvPADTMP_off(sv)        (SvFLAGS(sv) &= ~SVs_PADTMP)
378
379 #define SvPADMY(sv)             (SvFLAGS(sv) & SVs_PADMY)
380 #define SvPADMY_on(sv)          (SvFLAGS(sv) |= SVs_PADMY|SVs_PADBUSY)
381
382 #define SvTEMP(sv)              (SvFLAGS(sv) & SVs_TEMP)
383 #define SvTEMP_on(sv)           (SvFLAGS(sv) |= SVs_TEMP)
384 #define SvTEMP_off(sv)          (SvFLAGS(sv) &= ~SVs_TEMP)
385
386 #define SvOBJECT(sv)            (SvFLAGS(sv) & SVs_OBJECT)
387 #define SvOBJECT_on(sv)         (SvFLAGS(sv) |= SVs_OBJECT)
388 #define SvOBJECT_off(sv)        (SvFLAGS(sv) &= ~SVs_OBJECT)
389
390 #define SvREADONLY(sv)          (SvFLAGS(sv) & SVf_READONLY)
391 #define SvREADONLY_on(sv)       (SvFLAGS(sv) |= SVf_READONLY)
392 #define SvREADONLY_off(sv)      (SvFLAGS(sv) &= ~SVf_READONLY)
393
394 #define SvSCREAM(sv)            (SvFLAGS(sv) & SVp_SCREAM)
395 #define SvSCREAM_on(sv)         (SvFLAGS(sv) |= SVp_SCREAM)
396 #define SvSCREAM_off(sv)        (SvFLAGS(sv) &= ~SVp_SCREAM)
397
398 #define SvCOMPILED(sv)          (SvFLAGS(sv) & SVpfm_COMPILED)
399 #define SvCOMPILED_on(sv)       (SvFLAGS(sv) |= SVpfm_COMPILED)
400 #define SvCOMPILED_off(sv)      (SvFLAGS(sv) &= ~SVpfm_COMPILED)
401
402 #define SvTAIL(sv)              (SvFLAGS(sv) & SVpbm_TAIL)
403 #define SvTAIL_on(sv)           (SvFLAGS(sv) |= SVpbm_TAIL)
404 #define SvTAIL_off(sv)          (SvFLAGS(sv) &= ~SVpbm_TAIL)
405
406 #define SvVALID(sv)             (SvFLAGS(sv) & SVpbm_VALID)
407 #define SvVALID_on(sv)          (SvFLAGS(sv) |= SVpbm_VALID)
408 #define SvVALID_off(sv)         (SvFLAGS(sv) &= ~SVpbm_VALID)
409
410 #define SvRV(sv) ((XRV*)  SvANY(sv))->xrv_rv
411 #define SvRVx(sv) SvRV(sv)
412
413 #define SvIVX(sv) ((XPVIV*)  SvANY(sv))->xiv_iv
414 #define SvIVXx(sv) SvIVX(sv)
415 #define SvUVX(sv) ((XPVUV*)  SvANY(sv))->xuv_uv
416 #define SvUVXx(sv) SvUVX(sv)
417 #define SvNVX(sv)  ((XPVNV*)SvANY(sv))->xnv_nv
418 #define SvNVXx(sv) SvNVX(sv)
419 #define SvPVX(sv)  ((XPV*)  SvANY(sv))->xpv_pv
420 #define SvPVXx(sv) SvPVX(sv)
421 #define SvCUR(sv) ((XPV*)  SvANY(sv))->xpv_cur
422 #define SvLEN(sv) ((XPV*)  SvANY(sv))->xpv_len
423 #define SvLENx(sv) SvLEN(sv)
424 #define SvEND(sv)(((XPV*)  SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
425 #define SvENDx(sv) ((Sv = (sv)), SvEND(Sv))
426 #define SvMAGIC(sv)     ((XPVMG*)  SvANY(sv))->xmg_magic
427 #define SvSTASH(sv)     ((XPVMG*)  SvANY(sv))->xmg_stash
428
429 #define SvIV_set(sv, val) \
430         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
431                 (((XPVIV*)  SvANY(sv))->xiv_iv = val); } STMT_END
432 #define SvNV_set(sv, val) \
433         STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
434                 (((XPVNV*)  SvANY(sv))->xnv_nv = val); } STMT_END
435 #define SvPV_set(sv, val) \
436         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
437                 (((XPV*)  SvANY(sv))->xpv_pv = val); } STMT_END
438 #define SvCUR_set(sv, val) \
439         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
440                 (((XPV*)  SvANY(sv))->xpv_cur = val); } STMT_END
441 #define SvLEN_set(sv, val) \
442         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
443                 (((XPV*)  SvANY(sv))->xpv_len = val); } STMT_END
444 #define SvEND_set(sv, val) \
445         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
446                 (((XPV*)  SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
447
448 #define BmRARE(sv)      ((XPVBM*)  SvANY(sv))->xbm_rare
449 #define BmUSEFUL(sv)    ((XPVBM*)  SvANY(sv))->xbm_useful
450 #define BmPREVIOUS(sv)  ((XPVBM*)  SvANY(sv))->xbm_previous
451
452 #define FmLINES(sv)     ((XPVFM*)  SvANY(sv))->xfm_lines
453
454 #define LvTYPE(sv)      ((XPVLV*)  SvANY(sv))->xlv_type
455 #define LvTARG(sv)      ((XPVLV*)  SvANY(sv))->xlv_targ
456 #define LvTARGOFF(sv)   ((XPVLV*)  SvANY(sv))->xlv_targoff
457 #define LvTARGLEN(sv)   ((XPVLV*)  SvANY(sv))->xlv_targlen
458
459 #define IoIFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ifp
460 #define IoOFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ofp
461 #define IoDIRP(sv)      ((XPVIO*)  SvANY(sv))->xio_dirp
462 #define IoLINES(sv)     ((XPVIO*)  SvANY(sv))->xio_lines
463 #define IoPAGE(sv)      ((XPVIO*)  SvANY(sv))->xio_page
464 #define IoPAGE_LEN(sv)  ((XPVIO*)  SvANY(sv))->xio_page_len
465 #define IoLINES_LEFT(sv)((XPVIO*)  SvANY(sv))->xio_lines_left
466 #define IoTOP_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_top_name
467 #define IoTOP_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_top_gv
468 #define IoFMT_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_fmt_name
469 #define IoFMT_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_fmt_gv
470 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
471 #define IoBOTTOM_GV(sv) ((XPVIO*)  SvANY(sv))->xio_bottom_gv
472 #define IoSUBPROCESS(sv)((XPVIO*)  SvANY(sv))->xio_subprocess
473 #define IoTYPE(sv)      ((XPVIO*)  SvANY(sv))->xio_type
474 #define IoFLAGS(sv)     ((XPVIO*)  SvANY(sv))->xio_flags
475
476 #define SvTAINTED(sv)     (SvMAGICAL(sv) && sv_tainted(sv))
477 #define SvTAINTED_on(sv)  STMT_START{ if(tainting){sv_taint(sv);}   }STMT_END
478 #define SvTAINTED_off(sv) STMT_START{ if(tainting){sv_untaint(sv);} }STMT_END
479
480 #define SvTAINT(sv)       STMT_START{ if(tainted){SvTAINTED_on(sv);} }STMT_END
481
482 #ifdef CRIPPLED_CC
483
484 IV SvIV _((SV* sv));
485 UV SvUV _((SV* sv));
486 double SvNV _((SV* sv));
487 #define SvPV_force(sv, lp) sv_pvn_force(sv, &lp)
488 #define SvPV(sv, lp) sv_pvn(sv, &lp)
489 char *sv_pvn _((SV *, STRLEN *));
490 I32 SvTRUE _((SV *));
491
492 #define SvIVx(sv) SvIV(sv)
493 #define SvUVx(sv) SvUV(sv)
494 #define SvNVx(sv) SvNV(sv)
495 #define SvPVx(sv, lp) sv_pvn(sv, &lp)
496 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
497 #define SvTRUEx(sv) SvTRUE(sv)
498
499 #else /* !CRIPPLED_CC */
500
501 #undef SvIV
502 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
503
504 #undef SvUV
505 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
506
507 #undef SvNV
508 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
509
510 #undef SvPV
511 #define SvPV(sv, lp) \
512     (SvPOK(sv) ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv(sv, &lp))
513
514 #undef SvPV_force
515 #define SvPV_force(sv, lp) \
516     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
517      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force(sv, &lp))
518
519 #undef SvTRUE
520 #define SvTRUE(sv) (                                            \
521     !sv                                                         \
522     ? 0                                                         \
523     :    SvPOK(sv)                                              \
524         ?   ((Xpv = (XPV*)SvANY(sv)) &&                         \
525              (*Xpv->xpv_pv > '0' ||                             \
526               Xpv->xpv_cur > 1 ||                               \
527               (Xpv->xpv_cur && *Xpv->xpv_pv != '0'))            \
528              ? 1                                                \
529              : 0)                                               \
530         :                                                       \
531             SvIOK(sv)                                           \
532             ? SvIVX(sv) != 0                                    \
533             :   SvNOK(sv)                                       \
534                 ? SvNVX(sv) != 0.0                              \
535                 : sv_2bool(sv) )
536
537 #define SvIVx(sv) ((Sv = (sv)), SvIV(Sv))
538 #define SvUVx(sv) ((Sv = (sv)), SvUV(Sv))
539 #define SvNVx(sv) ((Sv = (sv)), SvNV(Sv))
540 #define SvPVx(sv, lp) ((Sv = (sv)), SvPV(Sv, lp))
541 #define SvTRUEx(sv) ((Sv = (sv)), SvTRUE(Sv))
542
543 #endif /* CRIPPLED_CC */
544
545 #define newRV_inc(sv)   newRV(sv)
546 #ifdef CRIPPLED_CC
547 SV *newRV_noinc _((SV *));
548 #else
549 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
550 #endif
551
552 /* the following macro updates any magic values this sv is associated with */
553
554 #define SvSETMAGIC(x) if (SvSMAGICAL(x)) mg_set(x)
555
556 #define SvSetSV(dst,src) if ((dst) != (src)) sv_setsv(dst,src)
557
558 #define SvSetSV_nosteal(dst,src) \
559             if ((dst) != (src)) {                       \
560                 U32 tMpF = SvFLAGS(src) & SVs_TEMP;     \
561                 SvTEMP_off(src);                        \
562                 sv_setsv(dst, src);                     \
563                 SvFLAGS(src) |= tMpF;                   \
564             }
565
566 #define SvPEEK(sv) sv_peek(sv)
567
568 #define SvIMMORTAL(sv) ((sv)==&sv_undef || (sv)==&sv_yes || (sv)==&sv_no)
569
570 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
571
572 #ifndef DOSISH
573 #  define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
574 #  define Sv_Grow sv_grow
575 #else
576     /* extra parentheses intentionally NOT placed around "len"! */
577 #  define SvGROW(sv,len) ((SvLEN(sv) < (unsigned long)len) \
578                 ? sv_grow(sv,(unsigned long)len) : SvPVX(sv))
579 #  define Sv_Grow(sv,len) sv_grow(sv,(unsigned long)(len))
580 #endif /* DOSISH */