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