This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re-order IVX slot in SV bodies
[perl5.git] / sv.h
1 /*    sv.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2004, 2005 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 #ifdef sv_flags
12 #undef sv_flags         /* Convex has this in <signal.h> for sigvec() */
13 #endif
14
15 /*
16 =head1 SV Flags
17
18 =for apidoc AmU||svtype
19 An enum of flags for Perl types.  These are found in the file B<sv.h>
20 in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
21
22 =for apidoc AmU||SVt_PV
23 Pointer type flag for scalars.  See C<svtype>.
24
25 =for apidoc AmU||SVt_IV
26 Integer type flag for scalars.  See C<svtype>.
27
28 =for apidoc AmU||SVt_NV
29 Double type flag for scalars.  See C<svtype>.
30
31 =for apidoc AmU||SVt_PVMG
32 Type flag for blessed scalars.  See C<svtype>.
33
34 =for apidoc AmU||SVt_PVAV
35 Type flag for arrays.  See C<svtype>.
36
37 =for apidoc AmU||SVt_PVHV
38 Type flag for hashes.  See C<svtype>.
39
40 =for apidoc AmU||SVt_PVCV
41 Type flag for code refs.  See C<svtype>.
42
43 =cut
44 */
45
46 typedef enum {
47         SVt_NULL,       /* 0 */
48         SVt_IV,         /* 1 */
49         SVt_NV,         /* 2 */
50         SVt_RV,         /* 3 */
51         SVt_PV,         /* 4 */
52         SVt_PVIV,       /* 5 */
53         SVt_PVNV,       /* 6 */
54         SVt_PVMG,       /* 7 */
55         SVt_PVBM,       /* 8 */
56         SVt_PVGV,       /* 9 */
57         SVt_PVLV,       /* 10 */
58         SVt_PVAV,       /* 11 */
59         SVt_PVHV,       /* 12 */
60         SVt_PVCV,       /* 13 */
61         SVt_PVFM,       /* 14 */
62         SVt_PVIO        /* 15 */
63 } svtype;
64
65 /* Using C's structural equivalence to help emulate C++ inheritance here... */
66
67 struct STRUCT_SV {              /* struct sv { */
68     void*       sv_any;         /* pointer to something */
69     U32         sv_refcnt;      /* how many references to us */
70     U32         sv_flags;       /* what we are */
71     union {
72         IV      sv_iv;
73         UV      sv_uv;
74         SV*     sv_rv;          /* pointer to another SV */
75         char*   sv_pv;          /* pointer to malloced string */
76         SV**    sv_array;
77     }           sv_u;
78 #ifdef DEBUG_LEAKING_SCALARS
79     unsigned    sv_debug_optype:9;      /* the type of OP that allocated us */
80     unsigned    sv_debug_inpad:1;       /* was allocated in a pad for an OP */
81     unsigned    sv_debug_cloned:1;      /* was cloned for an ithread */
82     unsigned    sv_debug_line:16;       /* the line where we were allocated */
83     char *      sv_debug_file;          /* the file where we were allocated */
84 #endif
85 };
86
87 struct gv {
88     XPVGV*      sv_any;         /* pointer to something */
89     U32         sv_refcnt;      /* how many references to us */
90     U32         sv_flags;       /* what we are */
91     union {
92         IV      sv_iv;
93         UV      sv_uv;
94         SV*     sv_rv;
95         char*   sv_pv;
96         SV**    sv_array;
97     }           sv_u;
98 };
99
100 struct cv {
101     XPVCV*      sv_any;         /* pointer to something */
102     U32         sv_refcnt;      /* how many references to us */
103     U32         sv_flags;       /* what we are */
104     union {
105         IV      sv_iv;
106         UV      sv_uv;
107         SV*     sv_rv;
108         char*   sv_pv;
109         SV**    sv_array;
110     }           sv_u;
111 };
112
113 struct av {
114     XPVAV*      sv_any;         /* pointer to something */
115     U32         sv_refcnt;      /* how many references to us */
116     U32         sv_flags;       /* what we are */
117     union {
118         IV      sv_iv;
119         UV      sv_uv;
120         SV*     sv_rv;
121         char*   sv_pv;          /* pointer to first array element */
122         SV**    sv_array;
123     }           sv_u;
124 };
125
126 struct hv {
127     XPVHV*      sv_any;         /* pointer to something */
128     U32         sv_refcnt;      /* how many references to us */
129     U32         sv_flags;       /* what we are */
130     union {
131         IV      sv_iv;
132         UV      sv_uv;
133         SV*     sv_rv;
134         char*   sv_pv;
135         SV**    sv_array;
136     }           sv_u;
137 };
138
139 struct io {
140     XPVIO*      sv_any;         /* pointer to something */
141     U32         sv_refcnt;      /* how many references to us */
142     U32         sv_flags;       /* what we are */
143     union {
144         IV      sv_iv;
145         UV      sv_uv;
146         SV*     sv_rv;
147         char*   sv_pv;
148         SV**    sv_array;
149     }           sv_u;
150 };
151
152 /*
153 =head1 SV Manipulation Functions
154
155 =for apidoc Am|U32|SvREFCNT|SV* sv
156 Returns the value of the object's reference count.
157
158 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
159 Increments the reference count of the given SV.
160
161 =for apidoc Am|void|SvREFCNT_dec|SV* sv
162 Decrements the reference count of the given SV.
163
164 =for apidoc Am|svtype|SvTYPE|SV* sv
165 Returns the type of the SV.  See C<svtype>.
166
167 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
168 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to
169 perform the upgrade if necessary.  See C<svtype>.
170
171 =cut
172 */
173
174 #define SvANY(sv)       (sv)->sv_any
175 #define SvFLAGS(sv)     (sv)->sv_flags
176 #define SvREFCNT(sv)    (sv)->sv_refcnt
177
178 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
179 #  define SvREFCNT_inc(sv)              \
180     ({                                  \
181         SV * const _sv = (SV*)(sv);     \
182         if (_sv)                        \
183              (SvREFCNT(_sv))++;         \
184         _sv;                            \
185     })
186 #else
187 #  define SvREFCNT_inc(sv)      \
188         ((PL_Sv=(SV*)(sv)), (PL_Sv && ++(SvREFCNT(PL_Sv))), (SV*)PL_Sv)
189 #endif
190
191 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
192 #  define SvREFCNT_dec(sv)              \
193     ({                                  \
194         SV * const _sv = (SV*)(sv);     \
195         if (_sv) {                      \
196             if (SvREFCNT(_sv)) {        \
197                 if (--(SvREFCNT(_sv)) == 0) \
198                     Perl_sv_free2(aTHX_ _sv);   \
199             } else {                    \
200                 sv_free(_sv);           \
201             }                           \
202         }                               \
203     })
204 #else
205 #define SvREFCNT_dec(sv)        sv_free((SV*)(sv))
206 #endif
207
208 #define SVTYPEMASK      0xff
209 #define SvTYPE(sv)      ((sv)->sv_flags & SVTYPEMASK)
210
211 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
212
213 #define SVs_PADSTALE    0x00000100      /* lexical has gone out of scope */
214 #define SVs_PADTMP      0x00000200      /* in use as tmp */
215 #define SVs_PADMY       0x00000400      /* in use a "my" variable */
216 #define SVs_TEMP        0x00000800      /* string is stealable? */
217 #define SVs_OBJECT      0x00001000      /* is "blessed" */
218 #define SVs_GMG         0x00002000      /* has magical get method */
219 #define SVs_SMG         0x00004000      /* has magical set method */
220 #define SVs_RMG         0x00008000      /* has random magical methods */
221
222 #define SVf_IOK         0x00010000      /* has valid public integer value */
223 #define SVf_NOK         0x00020000      /* has valid public numeric value */
224 #define SVf_POK         0x00040000      /* has valid public pointer value */
225 #define SVf_ROK         0x00080000      /* has a valid reference pointer */
226
227 #define SVf_FAKE        0x00100000      /* glob or lexical is just a copy */
228 #define SVf_OOK         0x00200000      /* has valid offset value */
229 #define SVf_BREAK       0x00400000      /* refcnt is artificially low - used
230                                          * by SV's in final arena  cleanup */
231 #define SVf_READONLY    0x00800000      /* may not be modified */
232
233
234 #define SVp_IOK         0x01000000      /* has valid non-public integer value */
235 #define SVp_NOK         0x02000000      /* has valid non-public numeric value */
236 #define SVp_POK         0x04000000      /* has valid non-public pointer value */
237 #define SVp_SCREAM      0x08000000      /* has been studied? */
238
239 #define SVf_UTF8        0x20000000      /* SvPV is UTF-8 encoded */
240 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
241
242 #define SVf_THINKFIRST  (SVf_READONLY|SVf_ROK|SVf_FAKE)
243
244 #define SVf_OK          (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
245                          SVp_IOK|SVp_NOK|SVp_POK)
246
247 #define SVf_AMAGIC      0x10000000      /* has magical overloaded methods */
248
249 #define PRIVSHIFT 8     /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
250
251 /* Some private flags. */
252
253 /* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
254 #define SVpad_OUR       0x80000000      /* pad name is "our" instead of "my" */
255 #define SVpad_TYPED     0x40000000      /* Typed Lexical */
256
257 #define SVf_IVisUV      0x80000000      /* use XPVUV instead of XPVIV */
258
259 #define SVpfm_COMPILED  0x80000000      /* FORMLINE is compiled */
260
261 #define SVpbm_VALID     0x80000000
262 #define SVpbm_TAIL      0x40000000
263
264 #define SVrepl_EVAL     0x40000000      /* Replacement part of s///e */
265
266 #define SVphv_CLONEABLE 0x08000000      /* for stashes: clone its objects */
267 #define SVphv_REHASH    0x10000000      /* HV is recalculating hash values */
268 #define SVphv_SHAREKEYS 0x20000000      /* keys live on shared string table */
269 #define SVphv_LAZYDEL   0x40000000      /* entry in xhv_eiter must be deleted */
270 #define SVphv_HASKFLAGS 0x80000000      /* keys have flag byte after hash */
271
272 #define SVprv_WEAKREF   0x80000000      /* Weak reference */
273
274 #define SVpav_REAL      0x40000000      /* free old entries */
275 #define SVpav_REIFY     0x80000000      /* can become real */
276
277 struct xpv {
278     IV          xpv_dummy;      /* This isn't allocated. */
279     STRLEN      xpv_cur;        /* length of sv_pv as a C string */
280     STRLEN      xpv_len;        /* allocated size */
281 };
282
283 struct xpviv {
284     IV          xiv_iv;         /* integer value or pv offset */
285     STRLEN      xpv_cur;        /* length of sv_pv as a C string */
286     STRLEN      xpv_len;        /* allocated size */
287 };
288
289 struct xpvuv {
290     UV          xuv_uv;         /* unsigned value or pv offset */
291     STRLEN      xpv_cur;        /* length of sv_pv as a C string */
292     STRLEN      xpv_len;        /* allocated size */
293 };
294
295 struct xpvnv {
296     IV          xiv_iv;         /* integer value or pv offset */
297     STRLEN      xpv_cur;        /* length of sv_pv as a C string */
298     STRLEN      xpv_len;        /* allocated size */
299     union {
300         NV      xnvu_nv;        /* numeric value, if any */
301         struct {
302             void *xnv_p1;
303             union {
304                 void *xnv_p2;
305                 IV xnv_i2;
306             }   xnv_u2;
307         }       xnv_s;
308     }           xnv_u;
309 };
310
311 #define xnv_nv xnv_u.xnvu_nv
312
313 /* These structure must match the beginning of struct xpvhv in hv.h. */
314 struct xpvmg {
315     IV          xiv_iv;         /* integer value or pv offset */
316     STRLEN      xpv_cur;        /* length of sv_pv as a C string */
317     STRLEN      xpv_len;        /* allocated size */
318     union {
319         NV      xnvu_nv;        /* numeric value, if any */
320         struct {
321             void *xnv_p1;
322             union {
323                 void *xnv_p2;
324                 IV xnv_i2;
325             }   xnv_u2;
326         }       xnv_s;
327     }           xnv_u;
328     MAGIC*      xmg_magic;      /* linked list of magicalness */
329     HV*         xmg_stash;      /* class package */
330 };
331
332 struct xpvlv {
333     IV          xiv_iv;         /* integer value or pv offset */
334     STRLEN      xpv_cur;        /* length of sv_pv as a C string */
335     STRLEN      xpv_len;        /* allocated size */
336     union {
337         NV      xnvu_nv;        /* numeric value, if any */
338         struct {
339             void *xnv_p1;
340             union {
341                 void *xnv_p2;
342                 IV xnv_i2;
343             }   xnv_u2;
344         }       xnv_s;
345     }           xnv_u;
346     MAGIC*      xmg_magic;      /* linked list of magicalness */
347     HV*         xmg_stash;      /* class package */
348
349     /* a full glob fits into this */
350     GP*         xgv_gp;
351     char*       xgv_name;
352     STRLEN      xgv_namelen;
353     HV*         xgv_stash;
354     U8          xgv_flags;
355
356     STRLEN      xlv_targoff;
357     STRLEN      xlv_targlen;
358     SV*         xlv_targ;
359     char        xlv_type;       /* k=keys .=pos x=substr v=vec /=join/re
360                                  * y=alem/helem/iter t=tie T=tied HE */
361 };
362
363 struct xpvgv {
364     IV          xiv_iv;         /* integer value or pv offset */
365     STRLEN      xpv_cur;        /* length of sv_pv as a C string */
366     STRLEN      xpv_len;        /* allocated size */
367     union {
368         NV      xnvu_nv;        /* numeric value, if any */
369         struct {
370             void *xnv_p1;
371             union {
372                 void *xnv_p2;
373                 IV xnv_i2;
374             }   xnv_u2;
375         }       xnv_s;
376     }           xnv_u;
377     MAGIC*      xmg_magic;      /* linked list of magicalness */
378     HV*         xmg_stash;      /* class package */
379
380     GP*         xgv_gp;
381     char*       xgv_name;
382     STRLEN      xgv_namelen;
383     HV*         xgv_stash;
384     U8          xgv_flags;
385 };
386
387 struct xpvbm {
388     IV          xiv_iv;         /* integer value or pv offset */
389     STRLEN      xpv_cur;        /* length of sv_pv as a C string */
390     STRLEN      xpv_len;        /* allocated size */
391     union {
392         NV      xnvu_nv;        /* numeric value, if any */
393         struct {
394             void *xnv_p1;
395             union {
396                 void *xnv_p2;
397                 IV xnv_i2;
398             }   xnv_u2;
399         }       xnv_s;
400     }           xnv_u;
401     MAGIC*      xmg_magic;      /* linked list of magicalness */
402     HV*         xmg_stash;      /* class package */
403
404     I32         xbm_useful;     /* is this constant pattern being useful? */
405     U16         xbm_previous;   /* how many characters in string before rare? */
406     U8          xbm_rare;       /* rarest character in string */
407 };
408
409 /* This structure must match XPVCV in cv.h */
410
411 typedef U16 cv_flags_t;
412
413 struct xpvfm {
414     IV          xiv_iv;         /* integer value or pv offset */
415     STRLEN      xpv_cur;        /* length of sv_pv as a C string */
416     STRLEN      xpv_len;        /* allocated size */
417     union {
418         NV      xnvu_nv;        /* numeric value, if any */
419         struct {
420             void *xnv_p1;
421             union {
422                 void *xnv_p2;
423                 IV xnv_i2;
424             }   xnv_u2;
425         }       xnv_s;
426     }           xnv_u;
427     MAGIC*      xmg_magic;      /* linked list of magicalness */
428     HV*         xmg_stash;      /* class package */
429
430     HV *        xcv_stash;
431     OP *        xcv_start;
432     OP *        xcv_root;
433     void      (*xcv_xsub)(pTHX_ CV*);
434     ANY         xcv_xsubany;
435     GV *        xcv_gv;
436     char *      xcv_file;
437     long        xcv_depth;      /* >= 2 indicates recursive call */
438     AV *        xcv_padlist;
439     CV *        xcv_outside;
440     cv_flags_t  xcv_flags;
441     U32         xcv_outside_seq; /* the COP sequence (at the point of our
442                                   * compilation) in the lexically enclosing
443                                   * sub */
444     IV          xfm_lines;
445 };
446
447 struct xpvio {
448     IV          xiv_iv;         /* integer value or pv offset */
449     STRLEN      xpv_cur;        /* length of sv_pv as a C string */
450     STRLEN      xpv_len;        /* allocated size */
451     union {
452         NV      xnvu_nv;        /* numeric value, if any */
453         struct {
454             void *xnv_p1;
455             union {
456                 void *xnv_p2;
457                 IV xnv_i2;
458             }   xnv_u2;
459         }       xnv_s;
460     }           xnv_u;
461     MAGIC*      xmg_magic;      /* linked list of magicalness */
462     HV*         xmg_stash;      /* class package */
463
464     PerlIO *    xio_ifp;        /* ifp and ofp are normally the same */
465     PerlIO *    xio_ofp;        /* but sockets need separate streams */
466     /* Cray addresses everything by word boundaries (64 bits) and
467      * code and data pointers cannot be mixed (which is exactly what
468      * Perl_filter_add() tries to do with the dirp), hence the following
469      * union trick (as suggested by Gurusamy Sarathy).
470      * For further information see Geir Johansen's problem report titled
471        [ID 20000612.002] Perl problem on Cray system
472      * The any pointer (known as IoANY()) will also be a good place
473      * to hang any IO disciplines to.
474      */
475     union {
476         DIR *   xiou_dirp;      /* for opendir, readdir, etc */
477         void *  xiou_any;       /* for alignment */
478     } xio_dirpu;
479     IV          xio_lines;      /* $. */
480     IV          xio_page;       /* $% */
481     IV          xio_page_len;   /* $= */
482     IV          xio_lines_left; /* $- */
483     char *      xio_top_name;   /* $^ */
484     GV *        xio_top_gv;     /* $^ */
485     char *      xio_fmt_name;   /* $~ */
486     GV *        xio_fmt_gv;     /* $~ */
487     char *      xio_bottom_name;/* $^B */
488     GV *        xio_bottom_gv;  /* $^B */
489     short       xio_subprocess; /* -| or |- */
490     char        xio_type;
491     char        xio_flags;
492 };
493 #define xio_dirp        xio_dirpu.xiou_dirp
494 #define xio_any         xio_dirpu.xiou_any
495
496 #define IOf_ARGV        1       /* this fp iterates over ARGV */
497 #define IOf_START       2       /* check for null ARGV and substitute '-' */
498 #define IOf_FLUSH       4       /* this fp wants a flush after write op */
499 #define IOf_DIDTOP      8       /* just did top of form */
500 #define IOf_UNTAINT     16      /* consider this fp (and its data) "safe" */
501 #define IOf_NOLINE      32      /* slurped a pseudo-line from empty file */
502 #define IOf_FAKE_DIRP   64      /* xio_dirp is fake (source filters kludge) */
503
504 /* The following macros define implementation-independent predicates on SVs. */
505
506 /*
507 =for apidoc Am|bool|SvNIOK|SV* sv
508 Returns a boolean indicating whether the SV contains a number, integer or
509 double.
510
511 =for apidoc Am|bool|SvNIOKp|SV* sv
512 Returns a boolean indicating whether the SV contains a number, integer or
513 double.  Checks the B<private> setting.  Use C<SvNIOK>.
514
515 =for apidoc Am|void|SvNIOK_off|SV* sv
516 Unsets the NV/IV status of an SV.
517
518 =for apidoc Am|bool|SvOK|SV* sv
519 Returns a boolean indicating whether the value is an SV. It also tells
520 whether the value is defined or not.
521
522 =for apidoc Am|bool|SvIOKp|SV* sv
523 Returns a boolean indicating whether the SV contains an integer.  Checks
524 the B<private> setting.  Use C<SvIOK>.
525
526 =for apidoc Am|bool|SvNOKp|SV* sv
527 Returns a boolean indicating whether the SV contains a double.  Checks the
528 B<private> setting.  Use C<SvNOK>.
529
530 =for apidoc Am|bool|SvPOKp|SV* sv
531 Returns a boolean indicating whether the SV contains a character string.
532 Checks the B<private> setting.  Use C<SvPOK>.
533
534 =for apidoc Am|bool|SvIOK|SV* sv
535 Returns a boolean indicating whether the SV contains an integer.
536
537 =for apidoc Am|void|SvIOK_on|SV* sv
538 Tells an SV that it is an integer.
539
540 =for apidoc Am|void|SvIOK_off|SV* sv
541 Unsets the IV status of an SV.
542
543 =for apidoc Am|void|SvIOK_only|SV* sv
544 Tells an SV that it is an integer and disables all other OK bits.
545
546 =for apidoc Am|void|SvIOK_only_UV|SV* sv
547 Tells and SV that it is an unsigned integer and disables all other OK bits.
548
549 =for apidoc Am|bool|SvIOK_UV|SV* sv
550 Returns a boolean indicating whether the SV contains an unsigned integer.
551
552 =for apidoc Am|void|SvUOK|SV* sv
553 Returns a boolean indicating whether the SV contains an unsigned integer.
554
555 =for apidoc Am|bool|SvIOK_notUV|SV* sv
556 Returns a boolean indicating whether the SV contains a signed integer.
557
558 =for apidoc Am|bool|SvNOK|SV* sv
559 Returns a boolean indicating whether the SV contains a double.
560
561 =for apidoc Am|void|SvNOK_on|SV* sv
562 Tells an SV that it is a double.
563
564 =for apidoc Am|void|SvNOK_off|SV* sv
565 Unsets the NV status of an SV.
566
567 =for apidoc Am|void|SvNOK_only|SV* sv
568 Tells an SV that it is a double and disables all other OK bits.
569
570 =for apidoc Am|bool|SvPOK|SV* sv
571 Returns a boolean indicating whether the SV contains a character
572 string.
573
574 =for apidoc Am|void|SvPOK_on|SV* sv
575 Tells an SV that it is a string.
576
577 =for apidoc Am|void|SvPOK_off|SV* sv
578 Unsets the PV status of an SV.
579
580 =for apidoc Am|void|SvPOK_only|SV* sv
581 Tells an SV that it is a string and disables all other OK bits.
582 Will also turn off the UTF-8 status.
583
584 =for apidoc Am|bool|SvVOK|SV* sv
585 Returns a boolean indicating whether the SV contains a v-string.
586
587 =for apidoc Am|bool|SvOOK|SV* sv
588 Returns a boolean indicating whether the SvIVX is a valid offset value for
589 the SvPVX.  This hack is used internally to speed up removal of characters
590 from the beginning of a SvPV.  When SvOOK is true, then the start of the
591 allocated string buffer is really (SvPVX - SvIVX).
592
593 =for apidoc Am|bool|SvROK|SV* sv
594 Tests if the SV is an RV.
595
596 =for apidoc Am|void|SvROK_on|SV* sv
597 Tells an SV that it is an RV.
598
599 =for apidoc Am|void|SvROK_off|SV* sv
600 Unsets the RV status of an SV.
601
602 =for apidoc Am|SV*|SvRV|SV* sv
603 Dereferences an RV to return the SV.
604
605 =for apidoc Am|IV|SvIVX|SV* sv
606 Returns the raw value in the SV's IV slot, without checks or conversions.
607 Only use when you are sure SvIOK is true. See also C<SvIV()>.
608
609 =for apidoc Am|UV|SvUVX|SV* sv
610 Returns the raw value in the SV's UV slot, without checks or conversions.
611 Only use when you are sure SvIOK is true. See also C<SvUV()>.
612
613 =for apidoc Am|NV|SvNVX|SV* sv
614 Returns the raw value in the SV's NV slot, without checks or conversions.
615 Only use when you are sure SvNOK is true. See also C<SvNV()>.
616
617 =for apidoc Am|char*|SvPVX|SV* sv
618 Returns a pointer to the physical string in the SV.  The SV must contain a
619 string.
620
621 =for apidoc Am|STRLEN|SvCUR|SV* sv
622 Returns the length of the string which is in the SV.  See C<SvLEN>.
623
624 =for apidoc Am|STRLEN|SvLEN|SV* sv
625 Returns the size of the string buffer in the SV, not including any part
626 attributable to C<SvOOK>.  See C<SvCUR>.
627
628 =for apidoc Am|char*|SvEND|SV* sv
629 Returns a pointer to the last character in the string which is in the SV.
630 See C<SvCUR>.  Access the character as *(SvEND(sv)).
631
632 =for apidoc Am|HV*|SvSTASH|SV* sv
633 Returns the stash of the SV.
634
635 =for apidoc Am|void|SvIV_set|SV* sv|IV val
636 Set the value of the IV pointer in sv to val.
637
638 =for apidoc Am|void|SvNV_set|SV* sv|NV val
639 Set the value of the IV pointer in sv to val.
640
641 =for apidoc Am|void|SvPV_set|SV* sv|char* val
642 Set the value of the PV pointer in sv to val.
643
644 =for apidoc Am|void|SvUV_set|SV* sv|UV val
645 Set the value of the PV pointer in sv to val.
646
647 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
648 Set the value of the RV pointer in sv to val.
649
650 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
651 Set the value of the MAGIC pointer in sv to val.
652
653 =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
654 Set the value of the STASH pointer in sv to val.
655
656 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
657 Set the current length of the string which is in the SV.  See C<SvCUR>.
658
659 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
660 Set the actual length of the string which is in the SV.
661
662 =cut
663 */
664
665 #define SvNIOK(sv)              (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
666 #define SvNIOKp(sv)             (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
667 #define SvNIOK_off(sv)          (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
668                                                   SVp_IOK|SVp_NOK|SVf_IVisUV))
669
670 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
671 #define assert_not_ROK(sv)      ({assert(!SvROK(sv) || !SvRV(sv));}),
672 #else
673 #define assert_not_ROK(sv)      
674 #endif
675
676 #define SvOK(sv)                (SvFLAGS(sv) & SVf_OK)
677 #define SvOK_off(sv)            (assert_not_ROK(sv)                     \
678                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
679                                                   SVf_IVisUV|SVf_UTF8), \
680                                                         SvOOK_off(sv))
681 #define SvOK_off_exc_UV(sv)     (assert_not_ROK(sv)                     \
682                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
683                                                   SVf_UTF8),            \
684                                                         SvOOK_off(sv))
685
686 #define SvOKp(sv)               (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
687 #define SvIOKp(sv)              (SvFLAGS(sv) & SVp_IOK)
688 #define SvIOKp_on(sv)           (SvRELEASE_IVX(sv), \
689                                     SvFLAGS(sv) |= SVp_IOK)
690 #define SvNOKp(sv)              (SvFLAGS(sv) & SVp_NOK)
691 #define SvNOKp_on(sv)           (SvFLAGS(sv) |= SVp_NOK)
692 #define SvPOKp(sv)              (SvFLAGS(sv) & SVp_POK)
693 #define SvPOKp_on(sv)           (assert_not_ROK(sv)                     \
694                                  SvFLAGS(sv) |= SVp_POK)
695
696 #define SvIOK(sv)               (SvFLAGS(sv) & SVf_IOK)
697 #define SvIOK_on(sv)            (SvRELEASE_IVX(sv), \
698                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
699 #define SvIOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
700 #define SvIOK_only(sv)          (SvOK_off(sv), \
701                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
702 #define SvIOK_only_UV(sv)       (SvOK_off_exc_UV(sv), \
703                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
704
705 #define SvIOK_UV(sv)            ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
706                                  == (SVf_IOK|SVf_IVisUV))
707 #define SvUOK(sv)               SvIOK_UV(sv)
708 #define SvIOK_notUV(sv)         ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
709                                  == SVf_IOK)
710
711 #define SvIsUV(sv)              (SvFLAGS(sv) & SVf_IVisUV)
712 #define SvIsUV_on(sv)           (SvFLAGS(sv) |= SVf_IVisUV)
713 #define SvIsUV_off(sv)          (SvFLAGS(sv) &= ~SVf_IVisUV)
714
715 #define SvNOK(sv)               (SvFLAGS(sv) & SVf_NOK)
716 #define SvNOK_on(sv)            (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
717 #define SvNOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
718 #define SvNOK_only(sv)          (SvOK_off(sv), \
719                                     SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
720
721 /*
722 =for apidoc Am|bool|SvUTF8|SV* sv
723 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
724
725 =for apidoc Am|void|SvUTF8_on|SV *sv
726 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
727 Do not use frivolously.
728
729 =for apidoc Am|void|SvUTF8_off|SV *sv
730 Unsets the UTF-8 status of an SV.
731
732 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
733 Tells an SV that it is a string and disables all other OK bits,
734 and leaves the UTF-8 status as it was.
735
736 =cut
737  */
738
739 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
740 in gv.h: */
741 #define SvUTF8(sv)              (SvFLAGS(sv) & SVf_UTF8)
742 #define SvUTF8_on(sv)           (SvFLAGS(sv) |= (SVf_UTF8))
743 #define SvUTF8_off(sv)          (SvFLAGS(sv) &= ~(SVf_UTF8))
744
745 #define SvPOK(sv)               (SvFLAGS(sv) & SVf_POK)
746 #define SvPOK_on(sv)            (assert_not_ROK(sv)                     \
747                                  SvFLAGS(sv) |= (SVf_POK|SVp_POK))
748 #define SvPOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
749 #define SvPOK_only(sv)          (assert_not_ROK(sv)                     \
750                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
751                                                   SVf_IVisUV|SVf_UTF8), \
752                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
753 #define SvPOK_only_UTF8(sv)     (assert_not_ROK(sv)                     \
754                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
755                                                   SVf_IVisUV),          \
756                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
757
758 #define SvVOK(sv)               (SvMAGICAL(sv) && mg_find(sv,'V'))
759 #define SvOOK(sv)               (SvFLAGS(sv) & SVf_OOK)
760 #define SvOOK_on(sv)            ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
761 #define SvOOK_off(sv)           ((void)(SvOOK(sv) && sv_backoff(sv)))
762
763 #define SvFAKE(sv)              (SvFLAGS(sv) & SVf_FAKE)
764 #define SvFAKE_on(sv)           (SvFLAGS(sv) |= SVf_FAKE)
765 #define SvFAKE_off(sv)          (SvFLAGS(sv) &= ~SVf_FAKE)
766
767 #define SvROK(sv)               (SvFLAGS(sv) & SVf_ROK)
768 #define SvROK_on(sv)            (SvFLAGS(sv) |= SVf_ROK)
769 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
770
771 #define SvMAGICAL(sv)           (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
772 #define SvMAGICAL_on(sv)        (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
773 #define SvMAGICAL_off(sv)       (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
774
775 #define SvGMAGICAL(sv)          (SvFLAGS(sv) & SVs_GMG)
776 #define SvGMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_GMG)
777 #define SvGMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_GMG)
778
779 #define SvSMAGICAL(sv)          (SvFLAGS(sv) & SVs_SMG)
780 #define SvSMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_SMG)
781 #define SvSMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_SMG)
782
783 #define SvRMAGICAL(sv)          (SvFLAGS(sv) & SVs_RMG)
784 #define SvRMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_RMG)
785 #define SvRMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_RMG)
786
787 #define SvAMAGIC(sv)            (SvFLAGS(sv) & SVf_AMAGIC)
788 #define SvAMAGIC_on(sv)         (SvFLAGS(sv) |= SVf_AMAGIC)
789 #define SvAMAGIC_off(sv)        (SvFLAGS(sv) &= ~SVf_AMAGIC)
790
791 #define SvGAMAGIC(sv)           (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
792
793 /*
794 #define Gv_AMG(stash) \
795         (HV_AMAGICmb(stash) && \
796          ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
797 */
798 #define Gv_AMG(stash)           (PL_amagic_generation && Gv_AMupdate(stash))
799
800 #define SvWEAKREF(sv)           ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
801                                   == (SVf_ROK|SVprv_WEAKREF))
802 #define SvWEAKREF_on(sv)        (SvFLAGS(sv) |=  (SVf_ROK|SVprv_WEAKREF))
803 #define SvWEAKREF_off(sv)       (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
804
805 #define SvTHINKFIRST(sv)        (SvFLAGS(sv) & SVf_THINKFIRST)
806
807 #define SvPADSTALE(sv)          (SvFLAGS(sv) & SVs_PADSTALE)
808 #define SvPADSTALE_on(sv)       (SvFLAGS(sv) |= SVs_PADSTALE)
809 #define SvPADSTALE_off(sv)      (SvFLAGS(sv) &= ~SVs_PADSTALE)
810
811 #define SvPADTMP(sv)            (SvFLAGS(sv) & SVs_PADTMP)
812 #define SvPADTMP_on(sv)         (SvFLAGS(sv) |= SVs_PADTMP)
813 #define SvPADTMP_off(sv)        (SvFLAGS(sv) &= ~SVs_PADTMP)
814
815 #define SvPADMY(sv)             (SvFLAGS(sv) & SVs_PADMY)
816 #define SvPADMY_on(sv)          (SvFLAGS(sv) |= SVs_PADMY)
817
818 #define SvTEMP(sv)              (SvFLAGS(sv) & SVs_TEMP)
819 #define SvTEMP_on(sv)           (SvFLAGS(sv) |= SVs_TEMP)
820 #define SvTEMP_off(sv)          (SvFLAGS(sv) &= ~SVs_TEMP)
821
822 #define SvOBJECT(sv)            (SvFLAGS(sv) & SVs_OBJECT)
823 #define SvOBJECT_on(sv)         (SvFLAGS(sv) |= SVs_OBJECT)
824 #define SvOBJECT_off(sv)        (SvFLAGS(sv) &= ~SVs_OBJECT)
825
826 #define SvREADONLY(sv)          (SvFLAGS(sv) & SVf_READONLY)
827 #define SvREADONLY_on(sv)       (SvFLAGS(sv) |= SVf_READONLY)
828 #define SvREADONLY_off(sv)      (SvFLAGS(sv) &= ~SVf_READONLY)
829
830 #define SvSCREAM(sv)            (SvFLAGS(sv) & SVp_SCREAM)
831 #define SvSCREAM_on(sv)         (SvFLAGS(sv) |= SVp_SCREAM)
832 #define SvSCREAM_off(sv)        (SvFLAGS(sv) &= ~SVp_SCREAM)
833
834 #define SvCOMPILED(sv)          (SvFLAGS(sv) & SVpfm_COMPILED)
835 #define SvCOMPILED_on(sv)       (SvFLAGS(sv) |= SVpfm_COMPILED)
836 #define SvCOMPILED_off(sv)      (SvFLAGS(sv) &= ~SVpfm_COMPILED)
837
838 #define SvEVALED(sv)            (SvFLAGS(sv) & SVrepl_EVAL)
839 #define SvEVALED_on(sv)         (SvFLAGS(sv) |= SVrepl_EVAL)
840 #define SvEVALED_off(sv)        (SvFLAGS(sv) &= ~SVrepl_EVAL)
841
842 #define SvTAIL(sv)              (SvFLAGS(sv) & SVpbm_TAIL)
843 #define SvTAIL_on(sv)           (SvFLAGS(sv) |= SVpbm_TAIL)
844 #define SvTAIL_off(sv)          (SvFLAGS(sv) &= ~SVpbm_TAIL)
845
846 #define SvVALID(sv)             (SvFLAGS(sv) & SVpbm_VALID)
847 #define SvVALID_on(sv)          (SvFLAGS(sv) |= SVpbm_VALID)
848 #define SvVALID_off(sv)         (SvFLAGS(sv) &= ~SVpbm_VALID)
849
850 #ifdef USE_ITHREADS
851 /* The following uses the FAKE flag to show that a regex pointer is infact
852    its own offset in the regexpad for ithreads */
853 #define SvREPADTMP(sv)          (SvFLAGS(sv) & SVf_FAKE)
854 #define SvREPADTMP_on(sv)       (SvFLAGS(sv) |= SVf_FAKE)
855 #define SvREPADTMP_off(sv)      (SvFLAGS(sv) &= ~SVf_FAKE)
856 #endif
857
858 #ifdef PERL_DEBUG_COW
859 #define SvRV(sv) (0 + (sv)->sv_u.sv_rv)
860 #else
861 #define SvRV(sv) ((sv)->sv_u.sv_rv)
862 #endif
863 #define SvRVx(sv) SvRV(sv)
864
865 #ifdef PERL_DEBUG_COW
866 #define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
867 #define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
868 #define SvNVX(sv) (0 + ((XPVNV*) SvANY(sv))->xnv_nv)
869 #define SvPVX(sv) (0 + (sv)->sv_u.sv_pv)
870 #define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
871 #define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
872 #define SvEND(sv) ((sv)->sv_u.sv_pv + ((XPV*)SvANY(sv))->xpv_cur)
873
874 #ifdef DEBUGGING
875 #  ifdef PERL_IN_SV_C
876 /* Can't make this RVALUE because of Perl_sv_unmagic.  */
877 #    define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_magic))
878 #  else
879 #    define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_magic))
880 #  endif
881 #define SvSTASH(sv)     (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_stash))
882 #else
883 #  ifdef PERL_IN_SV_C
884 #    define SvMAGIC(sv) ((XPVMG*)  SvANY(sv))->xmg_magic
885 #  else
886 #    define SvMAGIC(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_magic)
887 #  endif
888 #define SvSTASH(sv)     (0 + ((XPVMG*)  SvANY(sv))->xmg_stash)
889 #endif
890 #else
891 #define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
892 #define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
893 #define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_nv
894 #define SvPVX(sv) ((sv)->sv_u.sv_pv)
895 #define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
896 #define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
897 #define SvEND(sv) ((sv)->sv_u.sv_pv + ((XPV*)SvANY(sv))->xpv_cur)
898
899 #ifdef DEBUGGING
900 #define SvMAGIC(sv)     (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_magic))
901 #define SvSTASH(sv)     (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_stash))
902 #else
903 #define SvMAGIC(sv)     ((XPVMG*)  SvANY(sv))->xmg_magic
904 #define SvSTASH(sv)     ((XPVMG*)  SvANY(sv))->xmg_stash
905 #endif
906
907 #endif
908
909 #define SvIVXx(sv) SvIVX(sv)
910 #define SvUVXx(sv) SvUVX(sv)
911 #define SvNVXx(sv) SvNVX(sv)
912 #define SvPVXx(sv) SvPVX(sv)
913 #define SvLENx(sv) SvLEN(sv)
914 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
915
916
917 /* Ask a scalar nicely to try to become an IV, if possible.
918    Not guaranteed to stay returning void */
919 /* Macro won't actually call sv_2iv if already IOK */
920 #define SvIV_please(sv) \
921         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
922                 (void) SvIV(sv); } STMT_END
923 #define SvIV_set(sv, val) \
924         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
925                 (((XPVIV*)  SvANY(sv))->xiv_iv = (val)); } STMT_END
926 #define SvNV_set(sv, val) \
927         STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
928                 (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END
929 #define SvPV_set(sv, val) \
930         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
931                 ((sv)->sv_u.sv_pv = (val)); } STMT_END
932 #define SvUV_set(sv, val) \
933         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
934                 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
935 #define SvRV_set(sv, val) \
936         STMT_START { assert(SvTYPE(sv) >=  SVt_RV); \
937                 ((sv)->sv_u.sv_rv = (val)); } STMT_END
938 #define SvMAGIC_set(sv, val) \
939         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
940                 (((XPVMG*)SvANY(sv))->xmg_magic = (val)); } STMT_END
941 #define SvSTASH_set(sv, val) \
942         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
943                 (((XPVMG*)  SvANY(sv))->xmg_stash = (val)); } STMT_END
944 #define SvCUR_set(sv, val) \
945         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
946                 (((XPV*)  SvANY(sv))->xpv_cur = (val)); } STMT_END
947 #define SvLEN_set(sv, val) \
948         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
949                 (((XPV*)  SvANY(sv))->xpv_len = (val)); } STMT_END
950 #define SvEND_set(sv, val) \
951         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
952                 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
953
954 #define SvPV_renew(sv,n) \
955         STMT_START { SvLEN_set(sv, n); \
956                 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)                 \
957                                 (char*)saferealloc((Malloc_t)SvPVX(sv), \
958                                                    (MEM_SIZE)((n)))));  \
959                  } STMT_END
960
961 #define SvPV_shrink_to_cur(sv) STMT_START { \
962                    const STRLEN _lEnGtH = SvCUR(sv) + 1; \
963                    SvPV_renew(sv, _lEnGtH); \
964                  } STMT_END
965
966 #define SvPV_free(sv) \
967         STMT_START { assert(SvTYPE(sv) >= SVt_PV);      \
968                 if (SvLEN(sv)) {                        \
969                     if(SvOOK(sv)) {                     \
970                       Safefree(SvPVX(sv) - SvIVX(sv));  \
971                       SvFLAGS(sv) &= ~SVf_OOK;          \
972                     } else {                            \
973                       Safefree(SvPVX(sv));              \
974                     }                                   \
975                 }                                       \
976         } STMT_END
977
978 #define SvPVX_const(sv) ((const char*)SvPVX(sv))
979
980 #define BmRARE(sv)      ((XPVBM*)  SvANY(sv))->xbm_rare
981 #define BmUSEFUL(sv)    ((XPVBM*)  SvANY(sv))->xbm_useful
982 #define BmPREVIOUS(sv)  ((XPVBM*)  SvANY(sv))->xbm_previous
983
984 #define FmLINES(sv)     ((XPVFM*)  SvANY(sv))->xfm_lines
985
986 #define LvTYPE(sv)      ((XPVLV*)  SvANY(sv))->xlv_type
987 #define LvTARG(sv)      ((XPVLV*)  SvANY(sv))->xlv_targ
988 #define LvTARGOFF(sv)   ((XPVLV*)  SvANY(sv))->xlv_targoff
989 #define LvTARGLEN(sv)   ((XPVLV*)  SvANY(sv))->xlv_targlen
990
991 #define IoIFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ifp
992 #define IoOFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ofp
993 #define IoDIRP(sv)      ((XPVIO*)  SvANY(sv))->xio_dirp
994 #define IoANY(sv)       ((XPVIO*)  SvANY(sv))->xio_any
995 #define IoLINES(sv)     ((XPVIO*)  SvANY(sv))->xio_lines
996 #define IoPAGE(sv)      ((XPVIO*)  SvANY(sv))->xio_page
997 #define IoPAGE_LEN(sv)  ((XPVIO*)  SvANY(sv))->xio_page_len
998 #define IoLINES_LEFT(sv)((XPVIO*)  SvANY(sv))->xio_lines_left
999 #define IoTOP_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_top_name
1000 #define IoTOP_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_top_gv
1001 #define IoFMT_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_fmt_name
1002 #define IoFMT_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_fmt_gv
1003 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1004 #define IoBOTTOM_GV(sv) ((XPVIO*)  SvANY(sv))->xio_bottom_gv
1005 #define IoSUBPROCESS(sv)((XPVIO*)  SvANY(sv))->xio_subprocess
1006 #define IoTYPE(sv)      ((XPVIO*)  SvANY(sv))->xio_type
1007 #define IoFLAGS(sv)     ((XPVIO*)  SvANY(sv))->xio_flags
1008
1009 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1010 #define IoTYPE_RDONLY           '<'
1011 #define IoTYPE_WRONLY           '>'
1012 #define IoTYPE_RDWR             '+'
1013 #define IoTYPE_APPEND           'a'
1014 #define IoTYPE_PIPE             '|'
1015 #define IoTYPE_STD              '-'     /* stdin or stdout */
1016 #define IoTYPE_SOCKET           's'
1017 #define IoTYPE_CLOSED           ' '
1018 #define IoTYPE_IMPLICIT         'I'     /* stdin or stdout or stderr */
1019 #define IoTYPE_NUMERIC          '#'     /* fdopen */
1020
1021 /*
1022 =for apidoc Am|bool|SvTAINTED|SV* sv
1023 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1024 not.
1025
1026 =for apidoc Am|void|SvTAINTED_on|SV* sv
1027 Marks an SV as tainted if tainting is enabled.
1028
1029 =for apidoc Am|void|SvTAINTED_off|SV* sv
1030 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1031 some of Perl's fundamental security features. XS module authors should not
1032 use this function unless they fully understand all the implications of
1033 unconditionally untainting the value. Untainting should be done in the
1034 standard perl fashion, via a carefully crafted regexp, rather than directly
1035 untainting variables.
1036
1037 =for apidoc Am|void|SvTAINT|SV* sv
1038 Taints an SV if tainting is enabled.
1039
1040 =cut
1041 */
1042
1043 #define SvTAINTED(sv)     (SvMAGICAL(sv) && sv_tainted(sv))
1044 #define SvTAINTED_on(sv)  STMT_START{ if(PL_tainting){sv_taint(sv);}   }STMT_END
1045 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1046
1047 #define SvTAINT(sv)                     \
1048     STMT_START {                        \
1049         if (PL_tainting) {              \
1050             if (PL_tainted)             \
1051                 SvTAINTED_on(sv);       \
1052         }                               \
1053     } STMT_END
1054
1055 /*
1056 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1057 Like C<SvPV> but will force the SV into containing just a string
1058 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1059 directly.
1060
1061 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1062 Like C<SvPV> but will force the SV into containing just a string
1063 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1064 directly. Doesn't process magic.
1065
1066 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1067 Returns a pointer to the string in the SV, or a stringified form of
1068 the SV if the SV does not contain a string.  The SV may cache the
1069 stringified version becoming C<SvPOK>.  Handles 'get' magic. See also
1070 C<SvPVx> for a version which guarantees to evaluate sv only once.
1071
1072 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1073 A version of C<SvPV> which guarantees to evaluate sv only once.
1074
1075 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1076 Like C<SvPV> but doesn't process magic.
1077
1078 =for apidoc Am|char*|SvPV_nolen|SV* sv
1079 Returns a pointer to the string in the SV, or a stringified form of
1080 the SV if the SV does not contain a string.  The SV may cache the
1081 stringified form becoming C<SvPOK>.  Handles 'get' magic.
1082
1083 =for apidoc Am|IV|SvIV|SV* sv
1084 Coerces the given SV to an integer and returns it. See  C<SvIVx> for a
1085 version which guarantees to evaluate sv only once.
1086
1087 =for apidoc Am|IV|SvIV_nomg|SV* sv
1088 Like C<SvIV> but doesn't process magic.
1089
1090 =for apidoc Am|IV|SvIVx|SV* sv
1091 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1092 sv only once. Use the more efficient C<SvIV> otherwise.
1093
1094 =for apidoc Am|NV|SvNV|SV* sv
1095 Coerce the given SV to a double and return it. See  C<SvNVx> for a version
1096 which guarantees to evaluate sv only once.
1097
1098 =for apidoc Am|NV|SvNVx|SV* sv
1099 Coerces the given SV to a double and returns it. Guarantees to evaluate
1100 sv only once. Use the more efficient C<SvNV> otherwise.
1101
1102 =for apidoc Am|UV|SvUV|SV* sv
1103 Coerces the given SV to an unsigned integer and returns it.  See C<SvUVx>
1104 for a version which guarantees to evaluate sv only once.
1105
1106 =for apidoc Am|UV|SvUV_nomg|SV* sv
1107 Like C<SvUV> but doesn't process magic.
1108
1109 =for apidoc Am|UV|SvUVx|SV* sv
1110 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1111 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1112
1113 =for apidoc Am|bool|SvTRUE|SV* sv
1114 Returns a boolean indicating whether Perl would evaluate the SV as true or
1115 false, defined or undefined.  Does not handle 'get' magic.
1116
1117 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1118 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1119
1120 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1121 Like C<SvPV>, but converts sv to utf8 first if necessary.
1122
1123 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1124 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1125
1126 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1127 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1128
1129 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1130 Like C<SvPV>, but converts sv to byte representation first if necessary.
1131
1132 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1133 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1134
1135 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1136 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1137 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1138 otherwise.
1139
1140 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1141 Like C<SvPV>, but converts sv to utf8 first if necessary.
1142 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1143 otherwise.
1144
1145 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1146 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1147 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1148 otherwise.
1149
1150 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1151 Like C<SvPV>, but converts sv to byte representation first if necessary.
1152 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1153 otherwise.
1154
1155 =for apidoc Am|bool|SvIsCOW|SV* sv
1156 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1157 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1158 COW)
1159
1160 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1161 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1162 scalar.
1163
1164 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1165 Like C<sv_catpvn> but doesn't process magic.
1166
1167 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1168 Like C<sv_setsv> but doesn't process magic.
1169
1170 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1171 Like C<sv_catsv> but doesn't process magic.
1172
1173 =cut
1174 */
1175
1176 /* Let us hope that bitmaps for UV and IV are the same */
1177 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1178 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1179 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1180
1181 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1182 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1183
1184 /* ----*/
1185
1186 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1187
1188 #define SvPV_flags(sv, lp, flags) \
1189     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1190      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1191
1192 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1193
1194 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1195
1196 #define SvPV_force_flags(sv, lp, flags) \
1197     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1198     ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1199
1200 #define SvPV_nolen(sv) \
1201     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1202      ? SvPVX(sv) : sv_2pv_nolen(sv))
1203
1204 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1205
1206 /* ----*/
1207
1208 #define SvPVutf8(sv, lp) \
1209     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1210      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1211
1212 #define SvPVutf8_force(sv, lp) \
1213     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1214      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1215
1216
1217 #define SvPVutf8_nolen(sv) \
1218     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1219      ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
1220
1221 /* ----*/
1222
1223 #define SvPVbyte(sv, lp) \
1224     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1225      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1226
1227 #define SvPVbyte_force(sv, lp) \
1228     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1229      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1230
1231 #define SvPVbyte_nolen(sv) \
1232     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1233      ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
1234
1235
1236     
1237 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1238  * var to evaluate the arg once; failing that, use a global if possible;
1239  * failing that, call a function to do the work
1240  */
1241
1242 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1243 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1244 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1245
1246 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1247
1248 #  define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1249 #  define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1250 #  define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1251 #  define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1252 #  define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1253 #  define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1254 #  define SvTRUE(sv) (                                          \
1255     !sv                                                         \
1256     ? 0                                                         \
1257     :    SvPOK(sv)                                              \
1258         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
1259              nxpv &&                                            \
1260              (nxpv->xpv_cur > 1 ||                              \
1261               (nxpv->xpv_cur && *(sv)->sv_u.sv_pv != '0')); })  \
1262              ? 1                                                \
1263              : 0)                                               \
1264         :                                                       \
1265             SvIOK(sv)                                           \
1266             ? SvIVX(sv) != 0                                    \
1267             :   SvNOK(sv)                                       \
1268                 ? SvNVX(sv) != 0.0                              \
1269                 : sv_2bool(sv) )
1270 #  define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1271
1272 #else /* __GNUC__ */
1273
1274 /* These inlined macros use globals, which will require a thread
1275  * declaration in user code, so we avoid them under threads */
1276
1277 #  define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1278 #  define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1279 #  define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1280 #  define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1281 #  define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1282 #  define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1283 #  define SvTRUE(sv) (                                          \
1284     !sv                                                         \
1285     ? 0                                                         \
1286     :    SvPOK(sv)                                              \
1287         ?   ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) &&            \
1288              (PL_Xpv->xpv_cur > 1 ||                            \
1289               (PL_Xpv->xpv_cur && *PL_Sv->sv_u.sv_pv != '0'))   \
1290              ? 1                                                \
1291              : 0)                                               \
1292         :                                                       \
1293             SvIOK(sv)                                           \
1294             ? SvIVX(sv) != 0                                    \
1295             :   SvNOK(sv)                                       \
1296                 ? SvNVX(sv) != 0.0                              \
1297                 : sv_2bool(sv) )
1298 #  define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1299 #endif /* __GNU__ */
1300
1301 #define SvIsCOW(sv)             ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1302                                     (SVf_FAKE | SVf_READONLY))
1303 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1304
1305 /* flag values for sv_*_flags functions */
1306 #define SV_IMMEDIATE_UNREF      1
1307 #define SV_GMAGIC               2
1308 #define SV_COW_DROP_PV          4
1309 #define SV_UTF8_NO_ENCODING     8
1310 #define SV_NOSTEAL              16
1311
1312 /* We are about to replace the SV's current value. So if it's copy on write
1313    we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1314    the value is about to get thrown away, so drop the PV rather than go to
1315    the effort of making a read-write copy only for it to get immediately
1316    discarded.  */
1317
1318 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1319                                     sv_force_normal_flags(sv, SV_COW_DROP_PV)
1320
1321 #ifdef PERL_COPY_ON_WRITE
1322 #  define SvRELEASE_IVX(sv)   ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1323                                 && Perl_sv_release_IVX(aTHX_ sv)))
1324 #  define SvIsCOW_normal(sv)    (SvIsCOW(sv) && SvLEN(sv))
1325
1326 #define CAN_COW_MASK    (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1327                          SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1328                          SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1329 #define CAN_COW_FLAGS   (SVp_POK|SVf_POK)
1330
1331 #else
1332 #  define SvRELEASE_IVX(sv)   SvOOK_off(sv)
1333 #endif /* PERL_COPY_ON_WRITE */
1334
1335 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1336                                     sv_force_normal_flags(sv, 0)
1337
1338
1339 /* all these 'functions' are now just macros */
1340
1341 #define sv_pv(sv) SvPV_nolen(sv)
1342 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1343 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1344
1345 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1346 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1347 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1348 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1349 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1350 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1351 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1352 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1353 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1354 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1355 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1356 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1357 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1358 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1359
1360 /* Should be named SvCatPVN_utf8_upgrade? */
1361 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv)    \
1362         STMT_START {                                    \
1363             if (!(nsv))                                 \
1364                 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1365             else                                        \
1366                 sv_setpvn(nsv, sstr, slen);             \
1367             SvUTF8_off(nsv);                            \
1368             sv_utf8_upgrade(nsv);                       \
1369             sv_catsv(dsv, nsv); \
1370         } STMT_END
1371
1372 /*
1373 =for apidoc Am|SV*|newRV_inc|SV* sv
1374
1375 Creates an RV wrapper for an SV.  The reference count for the original SV is
1376 incremented.
1377
1378 =cut
1379 */
1380
1381 #define newRV_inc(sv)   newRV(sv)
1382
1383 /* the following macros update any magic values this sv is associated with */
1384
1385 /*
1386 =head1 Magical Functions
1387
1388 =for apidoc Am|void|SvGETMAGIC|SV* sv
1389 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
1390 argument more than once.
1391
1392 =for apidoc Am|void|SvSETMAGIC|SV* sv
1393 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
1394 argument more than once.
1395
1396 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1397 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
1398 more than once.
1399
1400 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1401 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1402 ssv. May evaluate arguments more than once.
1403
1404 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1405 Like C<SvSetSV>, but does any set magic required afterwards.
1406
1407 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1408 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1409
1410 =for apidoc Am|void|SvSHARE|SV* sv
1411 Arranges for sv to be shared between threads if a suitable module
1412 has been loaded.
1413
1414 =for apidoc Am|void|SvLOCK|SV* sv
1415 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1416 has been loaded.
1417
1418 =for apidoc Am|void|SvUNLOCK|SV* sv
1419 Releases a mutual exclusion lock on sv if a suitable module
1420 has been loaded.
1421
1422 =head1 SV Manipulation Functions
1423
1424 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1425 Expands the character buffer in the SV so that it has room for the
1426 indicated number of bytes (remember to reserve space for an extra trailing
1427 NUL character).  Calls C<sv_grow> to perform the expansion if necessary.
1428 Returns a pointer to the character buffer.
1429
1430 =cut
1431 */
1432
1433 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1434 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1435 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1436
1437 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1438 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1439
1440 #define SvSetSV_and(dst,src,finally) \
1441         STMT_START {                                    \
1442             if ((dst) != (src)) {                       \
1443                 sv_setsv(dst, src);                     \
1444                 finally;                                \
1445             }                                           \
1446         } STMT_END
1447 #define SvSetSV_nosteal_and(dst,src,finally) \
1448         STMT_START {                                    \
1449             if ((dst) != (src)) {                       \
1450                 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL);       \
1451                 finally;                                \
1452             }                                           \
1453         } STMT_END
1454
1455 #define SvSetSV(dst,src) \
1456                 SvSetSV_and(dst,src,/*nothing*/;)
1457 #define SvSetSV_nosteal(dst,src) \
1458                 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1459
1460 #define SvSetMagicSV(dst,src) \
1461                 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1462 #define SvSetMagicSV_nosteal(dst,src) \
1463                 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1464
1465
1466 #if !defined(SKIP_DEBUGGING)
1467 #define SvPEEK(sv) sv_peek(sv)
1468 #else
1469 #define SvPEEK(sv) ""
1470 #endif
1471
1472 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1473
1474 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1475
1476 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1477
1478 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1479 #define Sv_Grow sv_grow
1480
1481 #define CLONEf_COPY_STACKS 1
1482 #define CLONEf_KEEP_PTR_TABLE 2
1483 #define CLONEf_CLONE_HOST 4
1484 #define CLONEf_JOIN_IN 8
1485
1486 struct clone_params {
1487   AV* stashes;
1488   UV  flags;
1489   PerlInterpreter *proto_perl;
1490 };
1491
1492 /*
1493  * Local variables:
1494  * c-indentation-style: bsd
1495  * c-basic-offset: 4
1496  * indent-tabs-mode: t
1497  * End:
1498  *
1499  * ex: set ts=8 sts=4 sw=4 noet:
1500  */