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