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