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