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