This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Remove empty #ifdef/#else/#endif block.
[perl5.git] / sv.h
1 /*    sv.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 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_BIND,       /* 1 */
49         SVt_IV,         /* 2 */
50         SVt_NV,         /* 3 */
51         /* RV was here, before it was merged with IV.  */
52         SVt_PV,         /* 4 */
53         SVt_PVIV,       /* 5 */
54         SVt_PVNV,       /* 6 */
55         SVt_PVMG,       /* 7 */
56         SVt_REGEXP,     /* 8 */
57         /* PVBM was here, before BIND replaced it.  */
58         SVt_PVGV,       /* 9 */
59         SVt_PVLV,       /* 10 */
60         SVt_PVAV,       /* 11 */
61         SVt_PVHV,       /* 12 */
62         SVt_PVCV,       /* 13 */
63         SVt_PVFM,       /* 14 */
64         SVt_PVIO,       /* 15 */
65         SVt_LAST        /* keep last in enum. used to size arrays */
66 } svtype;
67
68 #ifndef PERL_CORE
69 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
70    purposes eternal code wanting to consider PVBM probably needs to think of
71    PVMG instead.  */
72 #  define SVt_PVBM      SVt_PVMG
73 /* Anything wanting to create a reference from clean should ensure that it has
74    a scalar of type SVt_IV now:  */
75 #  define SVt_RV        SVt_IV
76 #endif
77
78 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
79    so never reaches the clause at the end that uses sv_type_details->body_size
80    to determine whether to call safefree(). Hence body_size can be set
81    non-zero to record the size of HEs, without fear of bogus frees.  */
82 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
83 #define HE_SVSLOT       SVt_NULL
84 #endif
85
86 #define PERL_ARENA_ROOTS_SIZE   (SVt_LAST)
87
88 /* typedefs to eliminate some typing */
89 typedef struct he HE;
90 typedef struct hek HEK;
91
92 /* Using C's structural equivalence to help emulate C++ inheritance here... */
93
94 /* start with 2 sv-head building blocks */
95 #define _SV_HEAD(ptrtype) \
96     ptrtype     sv_any;         /* pointer to body */   \
97     U32         sv_refcnt;      /* how many references to us */ \
98     U32         sv_flags        /* what we are */
99
100 #define _SV_HEAD_UNION \
101     union {                             \
102         char*   svu_pv;         /* pointer to malloced string */        \
103         IV      svu_iv;                 \
104         UV      svu_uv;                 \
105         SV*     svu_rv;         /* pointer to another SV */             \
106         SV**    svu_array;              \
107         HE**    svu_hash;               \
108         GP*     svu_gp;                 \
109         PerlIO *svu_fp;                 \
110     }   sv_u
111
112
113 struct STRUCT_SV {              /* struct sv { */
114     _SV_HEAD(void*);
115     _SV_HEAD_UNION;
116 #ifdef DEBUG_LEAKING_SCALARS
117     PERL_BITFIELD32 sv_debug_optype:9;  /* the type of OP that allocated us */
118     PERL_BITFIELD32 sv_debug_inpad:1;   /* was allocated in a pad for an OP */
119     PERL_BITFIELD32 sv_debug_line:16;   /* the line where we were allocated */
120     UV              sv_debug_serial;    /* serial number of sv allocation   */
121     char *          sv_debug_file;      /* the file where we were allocated */
122     SV *            sv_debug_parent;    /* what we were cloned from (ithreads)*/
123 #endif
124 };
125
126 struct gv {
127     _SV_HEAD(XPVGV*);           /* pointer to xpvgv body */
128     _SV_HEAD_UNION;
129 };
130
131 struct cv {
132     _SV_HEAD(XPVCV*);           /* pointer to xpvcv body */
133     _SV_HEAD_UNION;
134 };
135
136 struct av {
137     _SV_HEAD(XPVAV*);           /* pointer to xpvav body */
138     _SV_HEAD_UNION;
139 };
140
141 struct hv {
142     _SV_HEAD(XPVHV*);           /* pointer to xpvhv body */
143     _SV_HEAD_UNION;
144 };
145
146 struct io {
147     _SV_HEAD(XPVIO*);           /* pointer to xpvio body */
148     _SV_HEAD_UNION;
149 };
150
151 struct p5rx {
152     _SV_HEAD(struct regexp*);   /* pointer to regexp body */
153     _SV_HEAD_UNION;
154 };
155
156 #undef _SV_HEAD
157 #undef _SV_HEAD_UNION           /* ensure no pollution */
158
159 /*
160 =head1 SV Manipulation Functions
161
162 =for apidoc Am|U32|SvREFCNT|SV* sv
163 Returns the value of the object's reference count.
164
165 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
166 Increments the reference count of the given SV.
167
168 All of the following SvREFCNT_inc* macros are optimized versions of
169 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
170
171 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
172 Same as SvREFCNT_inc, but can only be used if you know I<sv>
173 is not NULL.  Since we don't have to check the NULLness, it's faster
174 and smaller.
175
176 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
177 Same as SvREFCNT_inc, but can only be used if you don't need the
178 return value.  The macro doesn't need to return a meaningful value.
179
180 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
181 Same as SvREFCNT_inc, but can only be used if you don't need the return
182 value, and you know that I<sv> is not NULL.  The macro doesn't need
183 to return a meaningful value, or check for NULLness, so it's smaller
184 and faster.
185
186 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
187 Same as SvREFCNT_inc, but can only be used with expressions without side
188 effects.  Since we don't have to store a temporary value, it's faster.
189
190 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
191 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
192 is not NULL.  Since we don't have to check the NULLness, it's faster
193 and smaller.
194
195 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
196 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
197 return value.  The macro doesn't need to return a meaningful value.
198
199 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
200 Same as SvREFCNT_inc, but can only be used if you don't need the return
201 value, and you know that I<sv> is not NULL.  The macro doesn't need
202 to return a meaningful value, or check for NULLness, so it's smaller
203 and faster.
204
205 =for apidoc Am|void|SvREFCNT_dec|SV* sv
206 Decrements the reference count of the given SV.
207
208 =for apidoc Am|svtype|SvTYPE|SV* sv
209 Returns the type of the SV.  See C<svtype>.
210
211 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
212 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to
213 perform the upgrade if necessary.  See C<svtype>.
214
215 =cut
216 */
217
218 #define SvANY(sv)       (sv)->sv_any
219 #define SvFLAGS(sv)     (sv)->sv_flags
220 #define SvREFCNT(sv)    (sv)->sv_refcnt
221
222 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
223 #  define SvREFCNT_inc(sv)              \
224     ({                                  \
225         SV * const _sv = MUTABLE_SV(sv);        \
226         if (_sv)                        \
227              (SvREFCNT(_sv))++;         \
228         _sv;                            \
229     })
230 #  define SvREFCNT_inc_simple(sv)       \
231     ({                                  \
232         if (sv)                         \
233              (SvREFCNT(sv))++;          \
234         MUTABLE_SV(sv);                         \
235     })
236 #  define SvREFCNT_inc_NN(sv)           \
237     ({                                  \
238         SV * const _sv = MUTABLE_SV(sv);        \
239         SvREFCNT(_sv)++;                \
240         _sv;                            \
241     })
242 #  define SvREFCNT_inc_void(sv)         \
243     ({                                  \
244         SV * const _sv = MUTABLE_SV(sv);        \
245         if (_sv)                        \
246             (void)(SvREFCNT(_sv)++);    \
247     })
248 #else
249 #  define SvREFCNT_inc(sv)      \
250         ((PL_Sv=MUTABLE_SV(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
251 #  define SvREFCNT_inc_simple(sv) \
252         ((sv) ? (SvREFCNT(sv)++,MUTABLE_SV(sv)) : NULL)
253 #  define SvREFCNT_inc_NN(sv) \
254         (PL_Sv=MUTABLE_SV(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
255 #  define SvREFCNT_inc_void(sv) \
256         (void)((PL_Sv=MUTABLE_SV(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
257 #endif
258
259 /* These guys don't need the curly blocks */
260 #define SvREFCNT_inc_simple_void(sv)    STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
261 #define SvREFCNT_inc_simple_NN(sv)      (++(SvREFCNT(sv)),MUTABLE_SV(sv))
262 #define SvREFCNT_inc_void_NN(sv)        (void)(++SvREFCNT(MUTABLE_SV(sv)))
263 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
264
265 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
266 #  define SvREFCNT_dec(sv)              \
267     ({                                  \
268         SV * const _sv = MUTABLE_SV(sv);        \
269         if (_sv) {                      \
270             if (SvREFCNT(_sv)) {        \
271                 if (--(SvREFCNT(_sv)) == 0) \
272                     Perl_sv_free2(aTHX_ _sv);   \
273             } else {                    \
274                 sv_free(_sv);           \
275             }                           \
276         }                               \
277     })
278 #else
279 #define SvREFCNT_dec(sv)        sv_free(MUTABLE_SV(sv))
280 #endif
281
282 #define SVTYPEMASK      0xff
283 #define SvTYPE(sv)      ((svtype)((sv)->sv_flags & SVTYPEMASK))
284
285 /* Sadly there are some parts of the core that have pointers to already-freed
286    SV heads, and rely on being able to tell that they are now free. So mark
287    them all by using a consistent macro.  */
288 #define SvIS_FREED(sv)  ((sv)->sv_flags == SVTYPEMASK)
289
290 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
291
292 #define SVf_IOK         0x00000100  /* has valid public integer value */
293 #define SVf_NOK         0x00000200  /* has valid public numeric value */
294 #define SVf_POK         0x00000400  /* has valid public pointer value */
295 #define SVf_ROK         0x00000800  /* has a valid reference pointer */
296
297 #define SVp_IOK         0x00001000  /* has valid non-public integer value */
298 #define SVp_NOK         0x00002000  /* has valid non-public numeric value */
299 #define SVp_POK         0x00004000  /* has valid non-public pointer value */
300 #define SVp_SCREAM      0x00008000  /* has been studied? */
301 #define SVphv_CLONEABLE SVp_SCREAM  /* PVHV (stashes) clone its objects */
302 #define SVpgv_GP        SVp_SCREAM  /* GV has a valid GP */
303 #define SVprv_PCS_IMPORTED  SVp_SCREAM  /* RV is a proxy for a constant
304                                        subroutine in another package. Set the
305                                        CvIMPORTED_CV_ON() if it needs to be
306                                        expanded to a real GV */
307
308 #define SVs_PADSTALE    0x00010000  /* lexical has gone out of scope */
309 #define SVpad_STATE     0x00010000  /* pad name is a "state" var */
310 #define SVs_PADTMP      0x00020000  /* in use as tmp */
311 #define SVpad_TYPED     0x00020000  /* pad name is a Typed Lexical */
312 #define SVs_PADMY       0x00040000  /* in use a "my" variable */
313 #define SVpad_OUR       0x00040000  /* pad name is "our" instead of "my" */
314 #define SVs_TEMP        0x00080000  /* string is stealable? */
315 #define SVs_OBJECT      0x00100000  /* is "blessed" */
316 #define SVs_GMG         0x00200000  /* has magical get method */
317 #define SVs_SMG         0x00400000  /* has magical set method */
318 #define SVs_RMG         0x00800000  /* has random magical methods */
319
320 #define SVf_FAKE        0x01000000  /* 0: glob or lexical is just a copy
321                                        1: SV head arena wasn't malloc()ed
322                                        2: in conjunction with SVf_READONLY
323                                           marks a shared hash key scalar
324                                           (SvLEN == 0) or a copy on write
325                                           string (SvLEN != 0) [SvIsCOW(sv)]
326                                        3: For PVCV, whether CvUNIQUE(cv)
327                                           refers to an eval or once only
328                                           [CvEVAL(cv), CvSPECIAL(cv)]
329                                        4: On a pad name SV, that slot in the
330                                           frame AV is a REFCNT'ed reference
331                                           to a lexical from "outside". */
332 #define SVphv_REHASH    SVf_FAKE    /* 5: On a PVHV, hash values are being
333                                           recalculated */
334 #define SVf_OOK         0x02000000  /* has valid offset value. For a PVHV this
335                                        means that a hv_aux struct is present
336                                        after the main array */
337 #define SVf_BREAK       0x04000000  /* refcnt is artificially low - used by
338                                        SVs in final arena cleanup.
339                                        Set in S_regtry on PL_reg_curpm, so that
340                                        perl_destruct will skip it. */
341 #define SVf_READONLY    0x08000000  /* may not be modified */
342
343
344
345
346 #define SVf_THINKFIRST  (SVf_READONLY|SVf_ROK|SVf_FAKE)
347
348 #define SVf_OK          (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
349                          SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
350
351 #define PRIVSHIFT 4     /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
352
353 #define SVf_AMAGIC      0x10000000  /* has magical overloaded methods */
354
355 /* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
356 #define SVf_UTF8        0x20000000  /* SvPV is UTF-8 encoded
357                                        This is also set on RVs whose overloaded
358                                        stringification is UTF-8. This might
359                                        only happen as a side effect of SvPV() */
360                                            
361
362 /* Some private flags. */
363
364 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
365    be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
366    been restructured, so sometimes get used as string buffers.  */
367
368 /* PVHV */
369 #define SVphv_SHAREKEYS 0x20000000  /* PVHV keys live on shared string table */
370 /* PVNV, PVMG, presumably only inside pads */
371 #define SVpad_NAME      0x40000000  /* This SV is a name in the PAD, so
372                                        SVpad_TYPED, SVpad_OUR and SVpad_STATE
373                                        apply */
374 /* PVAV */
375 #define SVpav_REAL      0x40000000  /* free old entries */
376 /* PVHV */
377 #define SVphv_LAZYDEL   0x40000000  /* entry in xhv_eiter must be deleted */
378 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
379    on any regular scalar (anything <= PVLV) */
380 #define SVpbm_VALID     0x40000000
381 /* ??? */
382 #define SVrepl_EVAL     0x40000000  /* Replacement part of s///e */
383
384 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV  */
385 /* Presumably IVs aren't stored in pads */
386 #define SVf_IVisUV      0x80000000  /* use XPVUV instead of XPVIV */
387 /* PVAV */
388 #define SVpav_REIFY     0x80000000  /* can become real */
389 /* PVHV */
390 #define SVphv_HASKFLAGS 0x80000000  /* keys have flag byte after hash */
391 /* PVGV when SVpbm_VALID is true */
392 #define SVpbm_TAIL      0x80000000
393 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive  */
394 #define SVprv_WEAKREF   0x80000000  /* Weak reference */
395
396 #define _XPV_HEAD                                                       \
397     HV*         xmg_stash;      /* class package */                     \
398     union _xmgu xmg_u;                                                  \
399     STRLEN      xpv_cur;        /* length of svu_pv as a C string */    \
400     STRLEN      xpv_len         /* allocated size */
401
402 union _xnvu {
403     NV      xnv_nv;             /* numeric value, if any */
404     HV *    xgv_stash;
405     struct {
406         U32 xlow;
407         U32 xhigh;
408     }       xpad_cop_seq;       /* used by pad.c for cop_sequence */
409     struct {
410         U32 xbm_previous;       /* how many characters in string before rare? */
411         U8  xbm_flags;
412         U8  xbm_rare;           /* rarest character in string */
413     }       xbm_s;              /* fields from PVBM */
414 };
415
416 union _xivu {
417     IV      xivu_iv;            /* integer value */
418     UV      xivu_uv;
419     I32     xivu_i32;           /* BmUSEFUL */
420     HEK *   xivu_namehek;       /* xpvlv, xpvgv: GvNAME */
421 };
422
423 union _xmgu {
424     MAGIC*  xmg_magic;          /* linked list of magicalness */
425     HV*     xmg_ourstash;       /* Stash for our (when SvPAD_OUR is true) */
426 };
427
428 struct xpv {
429     _XPV_HEAD;
430 };
431
432 struct xpviv {
433     _XPV_HEAD;
434     union _xivu xiv_u;
435 };
436
437 #define xiv_iv xiv_u.xivu_iv
438
439 struct xpvuv {
440     _XPV_HEAD;
441     union _xivu xuv_u;
442 };
443
444 #define xuv_uv xuv_u.xivu_uv
445
446 struct xpvnv {
447     _XPV_HEAD;
448     union _xivu xiv_u;
449     union _xnvu xnv_u;
450 };
451
452 /* This structure must match the beginning of struct xpvhv in hv.h. */
453 struct xpvmg {
454     _XPV_HEAD;
455     union _xivu xiv_u;
456     union _xnvu xnv_u;
457 };
458
459 struct xpvlv {
460     _XPV_HEAD;
461     union _xivu xiv_u;
462     union _xnvu xnv_u;
463     STRLEN      xlv_targoff;
464     STRLEN      xlv_targlen;
465     SV*         xlv_targ;
466     char        xlv_type;       /* k=keys .=pos x=substr v=vec /=join/re
467                                  * y=alem/helem/iter t=tie T=tied HE */
468 };
469
470 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
471    Boyer-Moore.  */
472 struct xpvgv {
473     _XPV_HEAD;
474     union _xivu xiv_u;
475     union _xnvu xnv_u;
476 };
477
478 /* This structure must match XPVCV in cv.h */
479
480 typedef U16 cv_flags_t;
481
482 #define _XPVCV_COMMON                                                           \
483     HV *        xcv_stash;                                                      \
484     union {                                                                     \
485         OP *    xcv_start;                                                      \
486         ANY     xcv_xsubany;                                                    \
487     }           xcv_start_u;                                                    \
488     union {                                                                     \
489         OP *    xcv_root;                                                       \
490         void    (*xcv_xsub) (pTHX_ CV*);                                        \
491     }           xcv_root_u;                                                     \
492     GV *        xcv_gv;                                                         \
493     char *      xcv_file;                                                       \
494     AV *        xcv_padlist;                                                    \
495     CV *        xcv_outside;                                                    \
496     U32         xcv_outside_seq; /* the COP sequence (at the point of our       \
497                                   * compilation) in the lexically enclosing     \
498                                   * sub */                                      \
499     cv_flags_t  xcv_flags
500
501 struct xpvfm {
502     _XPV_HEAD;
503     _XPVCV_COMMON;
504     IV          xfm_lines;
505 };
506
507
508 struct xpvio {
509     _XPV_HEAD;
510     union _xivu xiv_u;
511     /* ifp and ofp are normally the same, but sockets need separate streams */
512     PerlIO *    xio_ofp;
513     /* Cray addresses everything by word boundaries (64 bits) and
514      * code and data pointers cannot be mixed (which is exactly what
515      * Perl_filter_add() tries to do with the dirp), hence the
516      *  following union trick (as suggested by Gurusamy Sarathy).
517      * For further information see Geir Johansen's problem report
518      * titled [ID 20000612.002] Perl problem on Cray system
519      * The any pointer (known as IoANY()) will also be a good place
520      * to hang any IO disciplines to.
521      */
522     union {
523         DIR *   xiou_dirp;      /* for opendir, readdir, etc */
524         void *  xiou_any;       /* for alignment */
525     } xio_dirpu;
526     /* IV xio_lines is now in IVX  $. */
527     IV          xio_page;       /* $% */
528     IV          xio_page_len;   /* $= */
529     IV          xio_lines_left; /* $- */
530     char *      xio_top_name;   /* $^ */
531     GV *        xio_top_gv;     /* $^ */
532     char *      xio_fmt_name;   /* $~ */
533     GV *        xio_fmt_gv;     /* $~ */
534     char *      xio_bottom_name;/* $^B */
535     GV *        xio_bottom_gv;  /* $^B */
536     char        xio_type;
537     U8          xio_flags;
538 };
539
540 #define xio_dirp        xio_dirpu.xiou_dirp
541 #define xio_any         xio_dirpu.xiou_any
542
543 #define IOf_ARGV        1       /* this fp iterates over ARGV */
544 #define IOf_START       2       /* check for null ARGV and substitute '-' */
545 #define IOf_FLUSH       4       /* this fp wants a flush after write op */
546 #define IOf_DIDTOP      8       /* just did top of form */
547 #define IOf_UNTAINT     16      /* consider this fp (and its data) "safe" */
548 #define IOf_NOLINE      32      /* slurped a pseudo-line from empty file */
549 #define IOf_FAKE_DIRP   64      /* xio_dirp is fake (source filters kludge)
550                                    Also, when this is set, SvPVX() is valid */
551
552 /* The following macros define implementation-independent predicates on SVs. */
553
554 /*
555 =for apidoc Am|U32|SvNIOK|SV* sv
556 Returns a U32 value indicating whether the SV contains a number, integer or
557 double.
558
559 =for apidoc Am|U32|SvNIOKp|SV* sv
560 Returns a U32 value indicating whether the SV contains a number, integer or
561 double.  Checks the B<private> setting.  Use C<SvNIOK> instead.
562
563 =for apidoc Am|void|SvNIOK_off|SV* sv
564 Unsets the NV/IV status of an SV.
565
566 =for apidoc Am|U32|SvOK|SV* sv
567 Returns a U32 value indicating whether the value is defined. This is
568 only meaningful for scalars.
569
570 =for apidoc Am|U32|SvIOKp|SV* sv
571 Returns a U32 value indicating whether the SV contains an integer.  Checks
572 the B<private> setting.  Use C<SvIOK> instead.
573
574 =for apidoc Am|U32|SvNOKp|SV* sv
575 Returns a U32 value indicating whether the SV contains a double.  Checks the
576 B<private> setting.  Use C<SvNOK> instead.
577
578 =for apidoc Am|U32|SvPOKp|SV* sv
579 Returns a U32 value indicating whether the SV contains a character string.
580 Checks the B<private> setting.  Use C<SvPOK> instead.
581
582 =for apidoc Am|U32|SvIOK|SV* sv
583 Returns a U32 value indicating whether the SV contains an integer.
584
585 =for apidoc Am|void|SvIOK_on|SV* sv
586 Tells an SV that it is an integer.
587
588 =for apidoc Am|void|SvIOK_off|SV* sv
589 Unsets the IV status of an SV.
590
591 =for apidoc Am|void|SvIOK_only|SV* sv
592 Tells an SV that it is an integer and disables all other OK bits.
593
594 =for apidoc Am|void|SvIOK_only_UV|SV* sv
595 Tells and SV that it is an unsigned integer and disables all other OK bits.
596
597 =for apidoc Am|bool|SvIOK_UV|SV* sv
598 Returns a boolean indicating whether the SV contains an unsigned integer.
599
600 =for apidoc Am|bool|SvUOK|SV* sv
601 Returns a boolean indicating whether the SV contains an unsigned integer.
602
603 =for apidoc Am|bool|SvIOK_notUV|SV* sv
604 Returns a boolean indicating whether the SV contains a signed integer.
605
606 =for apidoc Am|U32|SvNOK|SV* sv
607 Returns a U32 value indicating whether the SV contains a double.
608
609 =for apidoc Am|void|SvNOK_on|SV* sv
610 Tells an SV that it is a double.
611
612 =for apidoc Am|void|SvNOK_off|SV* sv
613 Unsets the NV status of an SV.
614
615 =for apidoc Am|void|SvNOK_only|SV* sv
616 Tells an SV that it is a double and disables all other OK bits.
617
618 =for apidoc Am|U32|SvPOK|SV* sv
619 Returns a U32 value indicating whether the SV contains a character
620 string.
621
622 =for apidoc Am|void|SvPOK_on|SV* sv
623 Tells an SV that it is a string.
624
625 =for apidoc Am|void|SvPOK_off|SV* sv
626 Unsets the PV status of an SV.
627
628 =for apidoc Am|void|SvPOK_only|SV* sv
629 Tells an SV that it is a string and disables all other OK bits.
630 Will also turn off the UTF-8 status.
631
632 =for apidoc Am|bool|SvVOK|SV* sv
633 Returns a boolean indicating whether the SV contains a v-string.
634
635 =for apidoc Am|U32|SvOOK|SV* sv
636 Returns a U32 indicating whether the pointer to the string buffer is offset.
637 This hack is used internally to speed up removal of characters from the
638 beginning of a SvPV.  When SvOOK is true, then the start of the
639 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
640 This offset used to be stored in SvIVX, but is now stored within the spare
641 part of the buffer.
642
643 =for apidoc Am|U32|SvROK|SV* sv
644 Tests if the SV is an RV.
645
646 =for apidoc Am|void|SvROK_on|SV* sv
647 Tells an SV that it is an RV.
648
649 =for apidoc Am|void|SvROK_off|SV* sv
650 Unsets the RV status of an SV.
651
652 =for apidoc Am|SV*|SvRV|SV* sv
653 Dereferences an RV to return the SV.
654
655 =for apidoc Am|IV|SvIVX|SV* sv
656 Returns the raw value in the SV's IV slot, without checks or conversions.
657 Only use when you are sure SvIOK is true. See also C<SvIV()>.
658
659 =for apidoc Am|UV|SvUVX|SV* sv
660 Returns the raw value in the SV's UV slot, without checks or conversions.
661 Only use when you are sure SvIOK is true. See also C<SvUV()>.
662
663 =for apidoc Am|NV|SvNVX|SV* sv
664 Returns the raw value in the SV's NV slot, without checks or conversions.
665 Only use when you are sure SvNOK is true. See also C<SvNV()>.
666
667 =for apidoc Am|char*|SvPVX|SV* sv
668 Returns a pointer to the physical string in the SV.  The SV must contain a
669 string.
670
671 =for apidoc Am|STRLEN|SvCUR|SV* sv
672 Returns the length of the string which is in the SV.  See C<SvLEN>.
673
674 =for apidoc Am|STRLEN|SvLEN|SV* sv
675 Returns the size of the string buffer in the SV, not including any part
676 attributable to C<SvOOK>.  See C<SvCUR>.
677
678 =for apidoc Am|char*|SvEND|SV* sv
679 Returns a pointer to the last character in the string which is in the SV.
680 See C<SvCUR>.  Access the character as *(SvEND(sv)).
681
682 =for apidoc Am|HV*|SvSTASH|SV* sv
683 Returns the stash of the SV.
684
685 =for apidoc Am|void|SvIV_set|SV* sv|IV val
686 Set the value of the IV pointer in sv to val.  It is possible to perform
687 the same function of this macro with an lvalue assignment to C<SvIVX>.
688 With future Perls, however, it will be more efficient to use 
689 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
690
691 =for apidoc Am|void|SvNV_set|SV* sv|NV val
692 Set the value of the NV pointer in sv to val.  See C<SvIV_set>.
693
694 =for apidoc Am|void|SvPV_set|SV* sv|char* val
695 Set the value of the PV pointer in sv to val.  See C<SvIV_set>.
696
697 =for apidoc Am|void|SvUV_set|SV* sv|UV val
698 Set the value of the UV pointer in sv to val.  See C<SvIV_set>.
699
700 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
701 Set the value of the RV pointer in sv to val.  See C<SvIV_set>.
702
703 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
704 Set the value of the MAGIC pointer in sv to val.  See C<SvIV_set>.
705
706 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
707 Set the value of the STASH pointer in sv to val.  See C<SvIV_set>.
708
709 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
710 Set the current length of the string which is in the SV.  See C<SvCUR>
711 and C<SvIV_set>.
712
713 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
714 Set the actual length of the string which is in the SV.  See C<SvIV_set>.
715
716 =cut
717 */
718
719 #define SvNIOK(sv)              (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
720 #define SvNIOKp(sv)             (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
721 #define SvNIOK_off(sv)          (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
722                                                   SVp_IOK|SVp_NOK|SVf_IVisUV))
723
724 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
725 #define assert_not_ROK(sv)      ({assert(!SvROK(sv) || !SvRV(sv));}),
726 #define assert_not_glob(sv)     ({assert(!isGV_with_GP(sv));}),
727 #else
728 #define assert_not_ROK(sv)      
729 #define assert_not_glob(sv)     
730 #endif
731
732 #define SvOK(sv)                ((SvTYPE(sv) == SVt_BIND)               \
733                                  ? (SvFLAGS(SvRV(sv)) & SVf_OK)         \
734                                  : (SvFLAGS(sv) & SVf_OK))
735 #define SvOK_off(sv)            (assert_not_ROK(sv) assert_not_glob(sv) \
736                                  SvFLAGS(sv) &= ~(SVf_OK|               \
737                                                   SVf_IVisUV|SVf_UTF8), \
738                                                         SvOOK_off(sv))
739 #define SvOK_off_exc_UV(sv)     (assert_not_ROK(sv)                     \
740                                  SvFLAGS(sv) &= ~(SVf_OK|               \
741                                                   SVf_UTF8),            \
742                                                         SvOOK_off(sv))
743
744 #define SvOKp(sv)               (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
745 #define SvIOKp(sv)              (SvFLAGS(sv) & SVp_IOK)
746 #define SvIOKp_on(sv)           (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
747                                     SvFLAGS(sv) |= SVp_IOK)
748 #define SvNOKp(sv)              (SvFLAGS(sv) & SVp_NOK)
749 #define SvNOKp_on(sv)           (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
750 #define SvPOKp(sv)              (SvFLAGS(sv) & SVp_POK)
751 #define SvPOKp_on(sv)           (assert_not_ROK(sv) assert_not_glob(sv) \
752                                  SvFLAGS(sv) |= SVp_POK)
753
754 #define SvIOK(sv)               (SvFLAGS(sv) & SVf_IOK)
755 #define SvIOK_on(sv)            (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
756                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
757 #define SvIOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
758 #define SvIOK_only(sv)          (SvOK_off(sv), \
759                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
760 #define SvIOK_only_UV(sv)       (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
761                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
762
763 #define SvIOK_UV(sv)            ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
764                                  == (SVf_IOK|SVf_IVisUV))
765 #define SvUOK(sv)               SvIOK_UV(sv)
766 #define SvIOK_notUV(sv)         ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
767                                  == SVf_IOK)
768
769 #define SvIsUV(sv)              (SvFLAGS(sv) & SVf_IVisUV)
770 #define SvIsUV_on(sv)           (SvFLAGS(sv) |= SVf_IVisUV)
771 #define SvIsUV_off(sv)          (SvFLAGS(sv) &= ~SVf_IVisUV)
772
773 #define SvNOK(sv)               (SvFLAGS(sv) & SVf_NOK)
774 #define SvNOK_on(sv)            (assert_not_glob(sv) \
775                                  SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
776 #define SvNOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
777 #define SvNOK_only(sv)          (SvOK_off(sv), \
778                                     SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
779
780 /*
781 =for apidoc Am|U32|SvUTF8|SV* sv
782 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
783 Call this after SvPV() in case any call to string overloading updates the
784 internal flag.
785
786 =for apidoc Am|void|SvUTF8_on|SV *sv
787 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
788 Do not use frivolously.
789
790 =for apidoc Am|void|SvUTF8_off|SV *sv
791 Unsets the UTF-8 status of an SV.
792
793 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
794 Tells an SV that it is a string and disables all other OK bits,
795 and leaves the UTF-8 status as it was.
796
797 =cut
798  */
799
800 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
801 in gv.h: */
802 #define SvUTF8(sv)              (SvFLAGS(sv) & SVf_UTF8)
803 #define SvUTF8_on(sv)           (SvFLAGS(sv) |= (SVf_UTF8))
804 #define SvUTF8_off(sv)          (SvFLAGS(sv) &= ~(SVf_UTF8))
805
806 #define SvPOK(sv)               (SvFLAGS(sv) & SVf_POK)
807 #define SvPOK_on(sv)            (assert_not_ROK(sv) assert_not_glob(sv) \
808                                  SvFLAGS(sv) |= (SVf_POK|SVp_POK))
809 #define SvPOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
810 #define SvPOK_only(sv)          (assert_not_ROK(sv) assert_not_glob(sv) \
811                                  SvFLAGS(sv) &= ~(SVf_OK|               \
812                                                   SVf_IVisUV|SVf_UTF8), \
813                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
814 #define SvPOK_only_UTF8(sv)     (assert_not_ROK(sv) assert_not_glob(sv) \
815                                  SvFLAGS(sv) &= ~(SVf_OK|               \
816                                                   SVf_IVisUV),          \
817                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
818
819 #define SvVOK(sv)               (SvMAGICAL(sv)                          \
820                                  && mg_find(sv,PERL_MAGIC_vstring))
821 /* returns the vstring magic, if any */
822 #define SvVSTRING_mg(sv)        (SvMAGICAL(sv) \
823                                  ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
824
825 #define SvOOK(sv)               (SvFLAGS(sv) & SVf_OOK)
826 #define SvOOK_on(sv)            ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
827 #define SvOOK_off(sv)           ((void)(SvOOK(sv) && sv_backoff(sv)))
828
829 #define SvFAKE(sv)              (SvFLAGS(sv) & SVf_FAKE)
830 #define SvFAKE_on(sv)           (SvFLAGS(sv) |= SVf_FAKE)
831 #define SvFAKE_off(sv)          (SvFLAGS(sv) &= ~SVf_FAKE)
832
833 #define SvROK(sv)               (SvFLAGS(sv) & SVf_ROK)
834 #define SvROK_on(sv)            (SvFLAGS(sv) |= SVf_ROK)
835 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~(SVf_ROK))
836
837 #define SvMAGICAL(sv)           (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
838 #define SvMAGICAL_on(sv)        (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
839 #define SvMAGICAL_off(sv)       (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
840
841 #define SvGMAGICAL(sv)          (SvFLAGS(sv) & SVs_GMG)
842 #define SvGMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_GMG)
843 #define SvGMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_GMG)
844
845 #define SvSMAGICAL(sv)          (SvFLAGS(sv) & SVs_SMG)
846 #define SvSMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_SMG)
847 #define SvSMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_SMG)
848
849 #define SvRMAGICAL(sv)          (SvFLAGS(sv) & SVs_RMG)
850 #define SvRMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_RMG)
851 #define SvRMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_RMG)
852
853 #define SvAMAGIC(sv)            (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
854 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
855 #  define SvAMAGIC_on(sv)       ({ SV * const kloink = sv;              \
856                                    assert(SvROK(kloink));               \
857                                    SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
858                                 })
859 #  define SvAMAGIC_off(sv)      ({ SV * const kloink = sv;              \
860                                    if(SvROK(kloink))                    \
861                                         SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
862                                 })
863 #else
864 #  define SvAMAGIC_on(sv)       (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
865 #  define SvAMAGIC_off(sv) \
866         (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
867 #endif
868
869 /*
870 =for apidoc Am|U32|SvGAMAGIC|SV* sv
871
872 Returns true if the SV has get magic or overloading. If either is true then
873 the scalar is active data, and has the potential to return a new value every
874 time it is accessed. Hence you must be careful to only read it once per user
875 logical operation and work with that returned value. If neither is true then
876 the scalar's value cannot change unless written to.
877
878 =cut
879 */
880
881 #define SvGAMAGIC(sv)           (SvGMAGICAL(sv) || SvAMAGIC(sv))
882
883 #define Gv_AMG(stash)           (PL_amagic_generation && Gv_AMupdate(stash, FALSE))
884
885 #define SvWEAKREF(sv)           ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
886                                   == (SVf_ROK|SVprv_WEAKREF))
887 #define SvWEAKREF_on(sv)        (SvFLAGS(sv) |=  (SVf_ROK|SVprv_WEAKREF))
888 #define SvWEAKREF_off(sv)       (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
889
890 #define SvPCS_IMPORTED(sv)      ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
891                                  == (SVf_ROK|SVprv_PCS_IMPORTED))
892 #define SvPCS_IMPORTED_on(sv)   (SvFLAGS(sv) |=  (SVf_ROK|SVprv_PCS_IMPORTED))
893 #define SvPCS_IMPORTED_off(sv)  (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
894
895 #define SvTHINKFIRST(sv)        (SvFLAGS(sv) & SVf_THINKFIRST)
896
897 #define SvPADSTALE(sv)          (SvFLAGS(sv) & SVs_PADSTALE)
898 #define SvPADSTALE_on(sv)       (SvFLAGS(sv) |= SVs_PADSTALE)
899 #define SvPADSTALE_off(sv)      (SvFLAGS(sv) &= ~SVs_PADSTALE)
900
901 #define SvPADTMP(sv)            (SvFLAGS(sv) & SVs_PADTMP)
902 #define SvPADTMP_on(sv)         (SvFLAGS(sv) |= SVs_PADTMP)
903 #define SvPADTMP_off(sv)        (SvFLAGS(sv) &= ~SVs_PADTMP)
904
905 #define SvPADMY(sv)             (SvFLAGS(sv) & SVs_PADMY)
906 #define SvPADMY_on(sv)          (SvFLAGS(sv) |= SVs_PADMY)
907
908 #define SvTEMP(sv)              (SvFLAGS(sv) & SVs_TEMP)
909 #define SvTEMP_on(sv)           (SvFLAGS(sv) |= SVs_TEMP)
910 #define SvTEMP_off(sv)          (SvFLAGS(sv) &= ~SVs_TEMP)
911
912 #define SvOBJECT(sv)            (SvFLAGS(sv) & SVs_OBJECT)
913 #define SvOBJECT_on(sv)         (SvFLAGS(sv) |= SVs_OBJECT)
914 #define SvOBJECT_off(sv)        (SvFLAGS(sv) &= ~SVs_OBJECT)
915
916 #define SvREADONLY(sv)          (SvFLAGS(sv) & SVf_READONLY)
917 #define SvREADONLY_on(sv)       (SvFLAGS(sv) |= SVf_READONLY)
918 #define SvREADONLY_off(sv)      (SvFLAGS(sv) &= ~SVf_READONLY)
919
920 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
921 #define SvSCREAM_on(sv)         (SvFLAGS(sv) |= SVp_SCREAM)
922 #define SvSCREAM_off(sv)        (SvFLAGS(sv) &= ~SVp_SCREAM)
923
924 #ifndef PERL_CORE
925 #  define SvCOMPILED(sv)        0
926 #  define SvCOMPILED_on(sv)
927 #  define SvCOMPILED_off(sv)
928 #endif
929
930 #define SvEVALED(sv)            (SvFLAGS(sv) & SVrepl_EVAL)
931 #define SvEVALED_on(sv)         (SvFLAGS(sv) |= SVrepl_EVAL)
932 #define SvEVALED_off(sv)        (SvFLAGS(sv) &= ~SVrepl_EVAL)
933
934 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
935 #  define SvVALID(sv)           ({ const SV *const _svvalid = (const SV*)(sv); \
936                                    if (SvFLAGS(_svvalid) & SVpbm_VALID) \
937                                        assert(!isGV_with_GP(_svvalid)); \
938                                    (SvFLAGS(_svvalid) & SVpbm_VALID);   \
939                                 })
940 #  define SvVALID_on(sv)        ({ SV *const _svvalid = MUTABLE_SV(sv); \
941                                    assert(!isGV_with_GP(_svvalid));     \
942                                    (SvFLAGS(_svvalid) |= SVpbm_VALID);  \
943                                 })
944 #  define SvVALID_off(sv)       ({ SV *const _svvalid = MUTABLE_SV(sv); \
945                                    assert(!isGV_with_GP(_svvalid));     \
946                                    (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
947                                 })
948
949 #  define SvTAIL(sv)    ({ const SV *const _svtail = (const SV *)(sv);  \
950                             assert(SvTYPE(_svtail) != SVt_PVAV);                \
951                             assert(SvTYPE(_svtail) != SVt_PVHV);                \
952                             (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID))    \
953                                 == (SVpbm_TAIL|SVpbm_VALID);            \
954                         })
955 #else
956 #  define SvVALID(sv)           (SvFLAGS(sv) & SVpbm_VALID)
957 #  define SvVALID_on(sv)        (SvFLAGS(sv) |= SVpbm_VALID)
958 #  define SvVALID_off(sv)       (SvFLAGS(sv) &= ~SVpbm_VALID)
959 #  define SvTAIL(sv)        ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID))   \
960                              == (SVpbm_TAIL|SVpbm_VALID))
961
962 #endif
963 #define SvTAIL_on(sv)           (SvFLAGS(sv) |= SVpbm_TAIL)
964 #define SvTAIL_off(sv)          (SvFLAGS(sv) &= ~SVpbm_TAIL)
965
966
967 #define SvPAD_TYPED(sv) \
968         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
969
970 #define SvPAD_OUR(sv)   \
971         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
972
973 #define SvPAD_STATE(sv) \
974         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
975
976 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
977 #  define SvPAD_TYPED_on(sv)    ({                                      \
978             SV *const _svpad = MUTABLE_SV(sv);                          \
979             assert(SvTYPE(_svpad) == SVt_PVMG);                         \
980             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED);                \
981         })
982 #define SvPAD_OUR_on(sv)        ({                                      \
983             SV *const _svpad = MUTABLE_SV(sv);                          \
984             assert(SvTYPE(_svpad) == SVt_PVMG);                         \
985             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR);                  \
986         })
987 #define SvPAD_STATE_on(sv)      ({                                      \
988             SV *const _svpad = MUTABLE_SV(sv);                          \
989             assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
990             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE);                \
991         })
992 #else
993 #  define SvPAD_TYPED_on(sv)    (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
994 #  define SvPAD_OUR_on(sv)      (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
995 #  define SvPAD_STATE_on(sv)    (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
996 #endif
997
998 #define SvOURSTASH(sv)  \
999         (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1000 #define SvOURSTASH_set(sv, st)                                  \
1001         STMT_START {                                            \
1002             assert(SvTYPE(sv) == SVt_PVMG);                     \
1003             ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st;      \
1004         } STMT_END
1005
1006 #define SvRVx(sv) SvRV(sv)
1007
1008 #ifdef PERL_DEBUG_COW
1009 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1010    +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1011 #  define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1012 #  define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1013 #  define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1014 #  define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1015 #  define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1016 /* Don't test the core XS code yet.  */
1017 #  if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1018 #    define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1019 #  else
1020 #  define SvPVX(sv) SvPVX_mutable(sv)
1021 #  endif
1022 #  define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1023 #  define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1024 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1025
1026 #  ifdef DEBUGGING
1027 #    define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic))
1028 #    define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_stash))
1029 #  else
1030 #    define SvMAGIC(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic)
1031 #    define SvSTASH(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_stash)
1032 #  endif
1033 #else
1034 #  define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1035 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1036
1037 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1038 /* These get expanded inside other macros that already use a variable _sv  */
1039 #    define SvPVX(sv)                                                   \
1040         (*({ SV *const _svpvx = MUTABLE_SV(sv);                         \
1041             assert(SvTYPE(_svpvx) >= SVt_PV);                           \
1042             assert(SvTYPE(_svpvx) != SVt_PVAV);                         \
1043             assert(SvTYPE(_svpvx) != SVt_PVHV);                         \
1044             assert(!isGV_with_GP(_svpvx));                              \
1045             assert(!(SvTYPE(_svpvx) == SVt_PVIO                         \
1046                      && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP)));           \
1047             &((_svpvx)->sv_u.svu_pv);                                   \
1048          }))
1049 #    define SvCUR(sv)                                                   \
1050         (*({ const SV *const _svcur = (const SV *)(sv);                 \
1051             assert(SvTYPE(_svcur) >= SVt_PV);                           \
1052             assert(SvTYPE(_svcur) != SVt_PVAV);                         \
1053             assert(SvTYPE(_svcur) != SVt_PVHV);                         \
1054             assert(!isGV_with_GP(_svcur));                              \
1055             assert(!(SvTYPE(_svcur) == SVt_PVIO                         \
1056                      && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP)));           \
1057             &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur);            \
1058          }))
1059 #    define SvIVX(sv)                                                   \
1060         (*({ const SV *const _svivx = (const SV *)(sv);                 \
1061             assert(SvTYPE(_svivx) == SVt_IV || SvTYPE(_svivx) >= SVt_PVIV); \
1062             assert(SvTYPE(_svivx) != SVt_PVAV);                         \
1063             assert(SvTYPE(_svivx) != SVt_PVHV);                         \
1064             assert(SvTYPE(_svivx) != SVt_PVCV);                         \
1065             assert(SvTYPE(_svivx) != SVt_PVFM);                         \
1066             assert(SvTYPE(_svivx) != SVt_PVIO);                         \
1067             assert(SvTYPE(_svivx) != SVt_REGEXP);                       \
1068             assert(!isGV_with_GP(_svivx));                              \
1069             &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv);           \
1070          }))
1071 #    define SvUVX(sv)                                                   \
1072         (*({ const SV *const _svuvx = (const SV *)(sv);                 \
1073             assert(SvTYPE(_svuvx) == SVt_IV || SvTYPE(_svuvx) >= SVt_PVIV); \
1074             assert(SvTYPE(_svuvx) != SVt_PVAV);                         \
1075             assert(SvTYPE(_svuvx) != SVt_PVHV);                         \
1076             assert(SvTYPE(_svuvx) != SVt_PVCV);                         \
1077             assert(SvTYPE(_svuvx) != SVt_PVFM);                         \
1078             assert(SvTYPE(_svuvx) != SVt_PVIO);                         \
1079             assert(SvTYPE(_svuvx) != SVt_REGEXP);                       \
1080             assert(!isGV_with_GP(_svuvx));                              \
1081             &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv);           \
1082          }))
1083 #    define SvNVX(sv)                                                   \
1084         (*({ const SV *const _svnvx = (const SV *)(sv);                 \
1085             assert(SvTYPE(_svnvx) == SVt_NV || SvTYPE(_svnvx) >= SVt_PVNV); \
1086             assert(SvTYPE(_svnvx) != SVt_PVAV);                         \
1087             assert(SvTYPE(_svnvx) != SVt_PVHV);                         \
1088             assert(SvTYPE(_svnvx) != SVt_PVCV);                         \
1089             assert(SvTYPE(_svnvx) != SVt_PVFM);                         \
1090             assert(SvTYPE(_svnvx) != SVt_PVIO);                         \
1091             assert(SvTYPE(_svnvx) != SVt_REGEXP);                       \
1092             assert(!isGV_with_GP(_svnvx));                              \
1093             &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv);     \
1094          }))
1095 #    define SvRV(sv)                                                    \
1096         (*({ SV *const _svrv = MUTABLE_SV(sv);                          \
1097             assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1098             assert(SvTYPE(_svrv) != SVt_PVAV);                          \
1099             assert(SvTYPE(_svrv) != SVt_PVHV);                          \
1100             assert(SvTYPE(_svrv) != SVt_PVCV);                          \
1101             assert(SvTYPE(_svrv) != SVt_PVFM);                          \
1102             assert(!isGV_with_GP(_svrv));                               \
1103             assert(!(SvTYPE(_svrv) == SVt_PVIO                          \
1104                      && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP)));            \
1105             &((_svrv)->sv_u.svu_rv);                                    \
1106          }))
1107 #    define SvRV_const(sv)                                              \
1108         ({ const SV *const _svrv = (const SV *)(sv);                    \
1109             assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1110             assert(SvTYPE(_svrv) != SVt_PVAV);                          \
1111             assert(SvTYPE(_svrv) != SVt_PVHV);                          \
1112             assert(SvTYPE(_svrv) != SVt_PVCV);                          \
1113             assert(SvTYPE(_svrv) != SVt_PVFM);                          \
1114             assert(!isGV_with_GP(_svrv));                               \
1115             assert(!(SvTYPE(_svrv) == SVt_PVIO                          \
1116                      && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP)));            \
1117             (_svrv)->sv_u.svu_rv;                                       \
1118          })
1119 #    define SvMAGIC(sv)                                                 \
1120         (*({ const SV *const _svmagic = (const SV *)(sv);               \
1121             assert(SvTYPE(_svmagic) >= SVt_PVMG);                       \
1122             if(SvTYPE(_svmagic) == SVt_PVMG)                            \
1123                 assert(!SvPAD_OUR(_svmagic));                           \
1124             &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1125           }))
1126 #    define SvSTASH(sv)                                                 \
1127         (*({ const SV *const _svstash = (const SV *)(sv);               \
1128             assert(SvTYPE(_svstash) >= SVt_PVMG);                       \
1129             &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash);      \
1130           }))
1131 #  else
1132 #    define SvPVX(sv) ((sv)->sv_u.svu_pv)
1133 #    define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1134 #    define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1135 #    define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1136 #    define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1137 #    define SvRV(sv) ((sv)->sv_u.svu_rv)
1138 #    define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1139 #    define SvMAGIC(sv) ((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic
1140 #    define SvSTASH(sv) ((XPVMG*)  SvANY(sv))->xmg_stash
1141 #  endif
1142 #endif
1143
1144 #ifndef PERL_POISON
1145 /* Given that these two are new, there can't be any existing code using them
1146  *  as LVALUEs  */
1147 #  define SvPVX_mutable(sv)     (0 + (sv)->sv_u.svu_pv)
1148 #  define SvPVX_const(sv)       ((const char*)(0 + (sv)->sv_u.svu_pv))
1149 #else
1150 /* Except for the poison code, which uses & to scribble over the pointer after
1151    free() is called.  */
1152 #  define SvPVX_mutable(sv)     ((sv)->sv_u.svu_pv)
1153 #  define SvPVX_const(sv)       ((const char*)((sv)->sv_u.svu_pv))
1154 #endif
1155
1156 #define SvIVXx(sv) SvIVX(sv)
1157 #define SvUVXx(sv) SvUVX(sv)
1158 #define SvNVXx(sv) SvNVX(sv)
1159 #define SvPVXx(sv) SvPVX(sv)
1160 #define SvLENx(sv) SvLEN(sv)
1161 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1162
1163
1164 /* Ask a scalar nicely to try to become an IV, if possible.
1165    Not guaranteed to stay returning void */
1166 /* Macro won't actually call sv_2iv if already IOK */
1167 #define SvIV_please(sv) \
1168         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1169                 (void) SvIV(sv); } STMT_END
1170 #define SvIV_please_nomg(sv) \
1171         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1172                 (void) SvIV_nomg(sv); } STMT_END
1173 #define SvIV_set(sv, val) \
1174         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1175                 assert(SvTYPE(sv) != SVt_PVAV);         \
1176                 assert(SvTYPE(sv) != SVt_PVHV);         \
1177                 assert(SvTYPE(sv) != SVt_PVCV);         \
1178                 assert(!isGV_with_GP(sv));              \
1179                 (((XPVIV*)  SvANY(sv))->xiv_iv = (val)); } STMT_END
1180 #define SvNV_set(sv, val) \
1181         STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1182             assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1183             assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1184                 assert(SvTYPE(sv) != SVt_PVIO);         \
1185                 assert(!isGV_with_GP(sv));              \
1186                 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1187 #define SvPV_set(sv, val) \
1188         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1189                 assert(SvTYPE(sv) != SVt_PVAV);         \
1190                 assert(SvTYPE(sv) != SVt_PVHV);         \
1191                 assert(!isGV_with_GP(sv));              \
1192                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1193                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1194                 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1195 #define SvUV_set(sv, val) \
1196         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1197                 assert(SvTYPE(sv) != SVt_PVAV);         \
1198                 assert(SvTYPE(sv) != SVt_PVHV);         \
1199                 assert(SvTYPE(sv) != SVt_PVCV);         \
1200                 assert(!isGV_with_GP(sv));              \
1201                 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1202 #define SvRV_set(sv, val) \
1203         STMT_START { assert(SvTYPE(sv) >=  SVt_PV || SvTYPE(sv) ==  SVt_IV); \
1204                 assert(SvTYPE(sv) != SVt_PVAV);         \
1205                 assert(SvTYPE(sv) != SVt_PVHV);         \
1206                 assert(SvTYPE(sv) != SVt_PVCV);         \
1207                 assert(SvTYPE(sv) != SVt_PVFM);         \
1208                 assert(!isGV_with_GP(sv));              \
1209                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1210                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1211                 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1212 #define SvMAGIC_set(sv, val) \
1213         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1214                 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1215 #define SvSTASH_set(sv, val) \
1216         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1217                 (((XPVMG*)  SvANY(sv))->xmg_stash = (val)); } STMT_END
1218 #define SvCUR_set(sv, val) \
1219         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1220                 assert(SvTYPE(sv) != SVt_PVAV);         \
1221                 assert(SvTYPE(sv) != SVt_PVHV);         \
1222                 assert(!isGV_with_GP(sv));              \
1223                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1224                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1225                 (((XPV*)  SvANY(sv))->xpv_cur = (val)); } STMT_END
1226 #define SvLEN_set(sv, val) \
1227         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1228                 assert(SvTYPE(sv) != SVt_PVAV); \
1229                 assert(SvTYPE(sv) != SVt_PVHV); \
1230                 assert(!isGV_with_GP(sv));      \
1231                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1232                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1233                 (((XPV*)  SvANY(sv))->xpv_len = (val)); } STMT_END
1234 #define SvEND_set(sv, val) \
1235         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1236                 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1237
1238 #define SvPV_renew(sv,n) \
1239         STMT_START { SvLEN_set(sv, n); \
1240                 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)                 \
1241                                 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1242                                                    (MEM_SIZE)((n)))));  \
1243                  } STMT_END
1244
1245 #define SvPV_shrink_to_cur(sv) STMT_START { \
1246                    const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1247                    SvPV_renew(sv, _lEnGtH); \
1248                  } STMT_END
1249
1250 #define SvPV_free(sv)                                                   \
1251     STMT_START {                                                        \
1252                      assert(SvTYPE(sv) >= SVt_PV);                      \
1253                      if (SvLEN(sv)) {                                   \
1254                          assert(!SvROK(sv));                            \
1255                          if(SvOOK(sv)) {                                \
1256                              STRLEN zok;                                \
1257                              SvOOK_offset(sv, zok);                     \
1258                              SvPV_set(sv, SvPVX_mutable(sv) - zok);     \
1259                              SvFLAGS(sv) &= ~SVf_OOK;                   \
1260                          }                                              \
1261                          Safefree(SvPVX(sv));                           \
1262                      }                                                  \
1263                  } STMT_END
1264
1265 #ifdef PERL_CORE
1266 /* Code that crops up in three places to take a scalar and ready it to hold
1267    a reference */
1268 #  define prepare_SV_for_RV(sv)                                         \
1269     STMT_START {                                                        \
1270                     if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV)    \
1271                         sv_upgrade(sv, SVt_IV);                         \
1272                     else if (SvTYPE(sv) >= SVt_PV) {                    \
1273                         SvPV_free(sv);                                  \
1274                         SvLEN_set(sv, 0);                               \
1275                         SvCUR_set(sv, 0);                               \
1276                     }                                                   \
1277                  } STMT_END
1278 #endif
1279
1280 #define PERL_FBM_TABLE_OFFSET 1 /* Number of bytes between EOS and table */
1281
1282 /* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1283    perl -T -e '/$^X/'
1284 */
1285 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1286 #  define BmFLAGS(sv)                                                   \
1287         (*({ SV *const _bmflags = MUTABLE_SV(sv);                       \
1288                 assert(SvTYPE(_bmflags) == SVt_PVGV);                   \
1289                 assert(SvVALID(_bmflags));                              \
1290             &(((XPVGV*) SvANY(_bmflags))->xnv_u.xbm_s.xbm_flags);       \
1291          }))
1292 #  define BmRARE(sv)                                                    \
1293         (*({ SV *const _bmrare = MUTABLE_SV(sv);                        \
1294                 assert(SvTYPE(_bmrare) == SVt_PVGV);                    \
1295                 assert(SvVALID(_bmrare));                               \
1296             &(((XPVGV*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare);         \
1297          }))
1298 #  define BmUSEFUL(sv)                                                  \
1299         (*({ SV *const _bmuseful = MUTABLE_SV(sv);                      \
1300             assert(SvTYPE(_bmuseful) == SVt_PVGV);                      \
1301             assert(SvVALID(_bmuseful));                                 \
1302             assert(!SvIOK(_bmuseful));                                  \
1303             &(((XPVGV*) SvANY(_bmuseful))->xiv_u.xivu_i32);             \
1304          }))
1305 #  define BmPREVIOUS(sv)                                                \
1306     (*({ SV *const _bmprevious = MUTABLE_SV(sv);                        \
1307                 assert(SvTYPE(_bmprevious) == SVt_PVGV);                \
1308                 assert(SvVALID(_bmprevious));                           \
1309             &(((XPVGV*) SvANY(_bmprevious))->xnv_u.xbm_s.xbm_previous); \
1310          }))
1311 #else
1312 #  define BmFLAGS(sv)           ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_flags
1313 #  define BmRARE(sv)            ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1314 #  define BmUSEFUL(sv)          ((XPVGV*) SvANY(sv))->xiv_u.xivu_i32
1315 #  define BmPREVIOUS(sv)        ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_previous
1316
1317 #endif
1318
1319 #define FmLINES(sv)     ((XPVFM*)  SvANY(sv))->xfm_lines
1320
1321 #define LvTYPE(sv)      ((XPVLV*)  SvANY(sv))->xlv_type
1322 #define LvTARG(sv)      ((XPVLV*)  SvANY(sv))->xlv_targ
1323 #define LvTARGOFF(sv)   ((XPVLV*)  SvANY(sv))->xlv_targoff
1324 #define LvTARGLEN(sv)   ((XPVLV*)  SvANY(sv))->xlv_targlen
1325
1326 #define IoIFP(sv)       (sv)->sv_u.svu_fp
1327 #define IoOFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ofp
1328 #define IoDIRP(sv)      ((XPVIO*)  SvANY(sv))->xio_dirp
1329 #define IoANY(sv)       ((XPVIO*)  SvANY(sv))->xio_any
1330 #define IoLINES(sv)     ((XPVIO*)  SvANY(sv))->xiv_u.xivu_iv
1331 #define IoPAGE(sv)      ((XPVIO*)  SvANY(sv))->xio_page
1332 #define IoPAGE_LEN(sv)  ((XPVIO*)  SvANY(sv))->xio_page_len
1333 #define IoLINES_LEFT(sv)((XPVIO*)  SvANY(sv))->xio_lines_left
1334 #define IoTOP_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_top_name
1335 #define IoTOP_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_top_gv
1336 #define IoFMT_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_fmt_name
1337 #define IoFMT_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_fmt_gv
1338 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1339 #define IoBOTTOM_GV(sv) ((XPVIO*)  SvANY(sv))->xio_bottom_gv
1340 #define IoTYPE(sv)      ((XPVIO*)  SvANY(sv))->xio_type
1341 #define IoFLAGS(sv)     ((XPVIO*)  SvANY(sv))->xio_flags
1342
1343 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1344 #define IoTYPE_RDONLY           '<'
1345 #define IoTYPE_WRONLY           '>'
1346 #define IoTYPE_RDWR             '+'
1347 #define IoTYPE_APPEND           'a'
1348 #define IoTYPE_PIPE             '|'
1349 #define IoTYPE_STD              '-'     /* stdin or stdout */
1350 #define IoTYPE_SOCKET           's'
1351 #define IoTYPE_CLOSED           ' '
1352 #define IoTYPE_IMPLICIT         'I'     /* stdin or stdout or stderr */
1353 #define IoTYPE_NUMERIC          '#'     /* fdopen */
1354
1355 /*
1356 =for apidoc Am|bool|SvTAINTED|SV* sv
1357 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1358 not.
1359
1360 =for apidoc Am|void|SvTAINTED_on|SV* sv
1361 Marks an SV as tainted if tainting is enabled.
1362
1363 =for apidoc Am|void|SvTAINTED_off|SV* sv
1364 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1365 some of Perl's fundamental security features. XS module authors should not
1366 use this function unless they fully understand all the implications of
1367 unconditionally untainting the value. Untainting should be done in the
1368 standard perl fashion, via a carefully crafted regexp, rather than directly
1369 untainting variables.
1370
1371 =for apidoc Am|void|SvTAINT|SV* sv
1372 Taints an SV if tainting is enabled.
1373
1374 =cut
1375 */
1376
1377 #define sv_taint(sv)      sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1378
1379 #define SvTAINTED(sv)     (SvMAGICAL(sv) && sv_tainted(sv))
1380 #define SvTAINTED_on(sv)  STMT_START{ if(PL_tainting){sv_taint(sv);}   }STMT_END
1381 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1382
1383 #define SvTAINT(sv)                     \
1384     STMT_START {                        \
1385         if (PL_tainting) {              \
1386             if (PL_tainted)             \
1387                 SvTAINTED_on(sv);       \
1388         }                               \
1389     } STMT_END
1390
1391 /*
1392 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1393 Like C<SvPV> but will force the SV into containing just a string
1394 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1395 directly.
1396
1397 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1398 Like C<SvPV> but will force the SV into containing just a string
1399 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1400 directly. Doesn't process magic.
1401
1402 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1403 Returns a pointer to the string in the SV, or a stringified form of
1404 the SV if the SV does not contain a string.  The SV may cache the
1405 stringified version becoming C<SvPOK>.  Handles 'get' magic. See also
1406 C<SvPVx> for a version which guarantees to evaluate sv only once.
1407
1408 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1409 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1410 Only use this if C<sv> is an expression with side effects, otherwise use the
1411 more efficient C<SvPVX>.
1412
1413 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1414 Like C<SvPV> but doesn't process magic.
1415
1416 =for apidoc Am|char*|SvPV_nolen|SV* sv
1417 Returns a pointer to the string in the SV, or a stringified form of
1418 the SV if the SV does not contain a string.  The SV may cache the
1419 stringified form becoming C<SvPOK>.  Handles 'get' magic.
1420
1421 =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1422 Like C<SvPV_nolen> but doesn't process magic.
1423
1424 =for apidoc Am|IV|SvIV|SV* sv
1425 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1426 version which guarantees to evaluate sv only once.
1427
1428 =for apidoc Am|IV|SvIV_nomg|SV* sv
1429 Like C<SvIV> but doesn't process magic.
1430
1431 =for apidoc Am|IV|SvIVx|SV* sv
1432 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1433 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1434 otherwise use the more efficient C<SvIV>.
1435
1436 =for apidoc Am|NV|SvNV|SV* sv
1437 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1438 which guarantees to evaluate sv only once.
1439
1440 =for apidoc Am|NV|SvNV_nomg|SV* sv
1441 Like C<SvNV> but doesn't process magic.
1442
1443 =for apidoc Am|NV|SvNVx|SV* sv
1444 Coerces the given SV to a double and returns it. Guarantees to evaluate
1445 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1446 otherwise use the more efficient C<SvNV>.
1447
1448 =for apidoc Am|UV|SvUV|SV* sv
1449 Coerces the given SV to an unsigned integer and returns it.  See C<SvUVx>
1450 for a version which guarantees to evaluate sv only once.
1451
1452 =for apidoc Am|UV|SvUV_nomg|SV* sv
1453 Like C<SvUV> but doesn't process magic.
1454
1455 =for apidoc Am|UV|SvUVx|SV* sv
1456 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1457 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1458 otherwise use the more efficient C<SvUV>.
1459
1460 =for apidoc Am|bool|SvTRUE|SV* sv
1461 Returns a boolean indicating whether Perl would evaluate the SV as true or
1462 false.  See SvOK() for a defined/undefined test.  Handles 'get' magic
1463 unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
1464 private flags).
1465
1466 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
1467 Returns a boolean indicating whether Perl would evaluate the SV as true or
1468 false.  See SvOK() for a defined/undefined test.  Does not handle 'get' magic.
1469
1470 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1471 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1472
1473 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1474 Like C<SvPV>, but converts sv to utf8 first if necessary.
1475
1476 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1477 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1478
1479 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1480 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1481
1482 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1483 Like C<SvPV>, but converts sv to byte representation first if necessary.
1484
1485 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1486 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1487
1488 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1489 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1490 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1491 otherwise.
1492
1493 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1494 Like C<SvPV>, but converts sv to utf8 first if necessary.
1495 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1496 otherwise.
1497
1498 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1499 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1500 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1501 otherwise.
1502
1503 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1504 Like C<SvPV>, but converts sv to byte representation first if necessary.
1505 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1506 otherwise.
1507
1508 =for apidoc Am|bool|SvIsCOW|SV* sv
1509 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1510 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1511 COW)
1512
1513 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1514 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1515 scalar.
1516
1517 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1518 Like C<sv_catpvn> but doesn't process magic.
1519
1520 =for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1521 Like C<sv_catpv> but doesn't process magic.
1522
1523 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1524 Like C<sv_setsv> but doesn't process magic.
1525
1526 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1527 Like C<sv_catsv> but doesn't process magic.
1528
1529 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1530
1531 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
1532
1533 =cut
1534 */
1535
1536 /* Let us hope that bitmaps for UV and IV are the same */
1537 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1538 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1539 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1540
1541 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1542 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1543 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1544
1545 /* ----*/
1546
1547 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1548 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1549 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1550
1551 #define SvPV_flags(sv, lp, flags) \
1552     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1553      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1554 #define SvPV_flags_const(sv, lp, flags) \
1555     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1556      ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1557      (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1558 #define SvPV_flags_const_nolen(sv, flags) \
1559     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1560      ? SvPVX_const(sv) : \
1561      (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1562 #define SvPV_flags_mutable(sv, lp, flags) \
1563     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1564      ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1565      sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1566
1567 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1568 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1569 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1570
1571 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1572 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1573
1574 #define SvPV_force_flags(sv, lp, flags) \
1575     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1576     ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1577 #define SvPV_force_flags_nolen(sv, flags) \
1578     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1579     ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1580 #define SvPV_force_flags_mutable(sv, lp, flags) \
1581     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1582     ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1583      : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1584
1585 #define SvPV_nolen(sv) \
1586     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1587      ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1588
1589 #define SvPV_nomg_nolen(sv) \
1590     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1591      ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1592
1593 #define SvPV_nolen_const(sv) \
1594     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1595      ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1596
1597 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1598 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1599 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1600
1601 /* ----*/
1602
1603 #define SvPVutf8(sv, lp) \
1604     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1605      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1606
1607 #define SvPVutf8_force(sv, lp) \
1608     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1609      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1610
1611
1612 #define SvPVutf8_nolen(sv) \
1613     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1614      ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1615
1616 /* ----*/
1617
1618 #define SvPVbyte(sv, lp) \
1619     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1620      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1621
1622 #define SvPVbyte_force(sv, lp) \
1623     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1624      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1625
1626 #define SvPVbyte_nolen(sv) \
1627     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1628      ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1629
1630
1631     
1632 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1633  * var to evaluate the arg once; failing that, use a global if possible;
1634  * failing that, call a function to do the work
1635  */
1636
1637 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1638 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1639 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1640
1641 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1642
1643 #  define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1644 #  define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1645 #  define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1646 #  define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1647 #  define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1648 #  define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1649 #  define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1650 #  define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1651 #  define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1652 #  define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1653 #  define SvTRUE(sv) (                                          \
1654     !sv                                                         \
1655     ? 0                                                         \
1656     :    SvPOK(sv)                                              \
1657         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
1658              nxpv &&                                            \
1659              (nxpv->xpv_cur > 1 ||                              \
1660               (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1661              ? 1                                                \
1662              : 0)                                               \
1663         :                                                       \
1664             SvIOK(sv)                                           \
1665             ? SvIVX(sv) != 0                                    \
1666             :   SvNOK(sv)                                       \
1667                 ? SvNVX(sv) != 0.0                              \
1668                 : sv_2bool(sv) )
1669 #  define SvTRUE_nomg(sv) (                                     \
1670     !sv                                                         \
1671     ? 0                                                         \
1672     :    SvPOK(sv)                                              \
1673         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
1674              nxpv &&                                            \
1675              (nxpv->xpv_cur > 1 ||                              \
1676               (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1677              ? 1                                                \
1678              : 0)                                               \
1679         :                                                       \
1680             SvIOK(sv)                                           \
1681             ? SvIVX(sv) != 0                                    \
1682             :   SvNOK(sv)                                       \
1683                 ? SvNVX(sv) != 0.0                              \
1684                 : sv_2bool_flags(sv,0) )
1685 #  define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1686
1687 #else /* __GNUC__ */
1688
1689 /* These inlined macros use globals, which will require a thread
1690  * declaration in user code, so we avoid them under threads */
1691
1692 #  define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1693 #  define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1694 #  define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1695 #  define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1696 #  define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1697 #  define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1698 #  define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1699 #  define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1700 #  define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1701 #  define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1702 #  define SvTRUE(sv) (                                          \
1703     !sv                                                         \
1704     ? 0                                                         \
1705     :    SvPOK(sv)                                              \
1706         ?   ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) &&            \
1707              (PL_Xpv->xpv_cur > 1 ||                            \
1708               (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0'))  \
1709              ? 1                                                \
1710              : 0)                                               \
1711         :                                                       \
1712             SvIOK(sv)                                           \
1713             ? SvIVX(sv) != 0                                    \
1714             :   SvNOK(sv)                                       \
1715                 ? SvNVX(sv) != 0.0                              \
1716                 : sv_2bool(sv) )
1717 #  define SvTRUE_nomg(sv) (                                     \
1718     !sv                                                         \
1719     ? 0                                                         \
1720     :    SvPOK(sv)                                              \
1721         ?   ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) &&            \
1722              (PL_Xpv->xpv_cur > 1 ||                            \
1723               (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0'))  \
1724              ? 1                                                \
1725              : 0)                                               \
1726         :                                                       \
1727             SvIOK(sv)                                           \
1728             ? SvIVX(sv) != 0                                    \
1729             :   SvNOK(sv)                                       \
1730                 ? SvNVX(sv) != 0.0                              \
1731                 : sv_2bool_flags(sv,0) )
1732 #  define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1733 #endif /* __GNU__ */
1734
1735 #define SvIsCOW(sv)             ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1736                                     (SVf_FAKE | SVf_READONLY))
1737 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1738
1739 #define SvSHARED_HEK_FROM_PV(pvx) \
1740         ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1741 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1742
1743 /* flag values for sv_*_flags functions */
1744 #define SV_IMMEDIATE_UNREF      1
1745 #define SV_GMAGIC               2
1746 #define SV_COW_DROP_PV          4
1747 #define SV_UTF8_NO_ENCODING     8
1748 #define SV_NOSTEAL              16
1749 #define SV_CONST_RETURN         32
1750 #define SV_MUTABLE_RETURN       64
1751 #define SV_SMAGIC               128
1752 #define SV_HAS_TRAILING_NUL     256
1753 #define SV_COW_SHARED_HASH_KEYS 512
1754 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1755 #define SV_COW_OTHER_PVS        1024
1756 /* Make sv_2pv_flags return NULL if something is undefined.  */
1757 #define SV_UNDEF_RETURNS_NULL   2048
1758 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1759  * This is used when the caller has already determined it is, and avoids
1760  * redundant work */
1761 #define SV_FORCE_UTF8_UPGRADE   4096
1762 /* if (after resolving magic etc), the SV is found to be overloaded,
1763  * don't call the overload magic, just return as-is */
1764 #define SV_SKIP_OVERLOAD        8192
1765
1766 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1767    So only default to doing the COW setup if we're in the core.
1768  */
1769 #ifdef PERL_CORE
1770 #  ifndef SV_DO_COW_SVSETSV
1771 #    define SV_DO_COW_SVSETSV   SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1772 #  endif
1773 #endif
1774
1775 #ifndef SV_DO_COW_SVSETSV
1776 #  define SV_DO_COW_SVSETSV     0
1777 #endif
1778
1779
1780 #define sv_unref(sv)            sv_unref_flags(sv, 0)
1781 #define sv_force_normal(sv)     sv_force_normal_flags(sv, 0)
1782 #define sv_usepvn(sv, p, l)     sv_usepvn_flags(sv, p, l, 0)
1783 #define sv_usepvn_mg(sv, p, l)  sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1784
1785 /* We are about to replace the SV's current value. So if it's copy on write
1786    we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1787    the value is about to get thrown away, so drop the PV rather than go to
1788    the effort of making a read-write copy only for it to get immediately
1789    discarded.  */
1790
1791 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1792                                     sv_force_normal_flags(sv, SV_COW_DROP_PV)
1793
1794 #ifdef PERL_OLD_COPY_ON_WRITE
1795 #define SvRELEASE_IVX(sv)   \
1796     ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1797 #  define SvIsCOW_normal(sv)    (SvIsCOW(sv) && SvLEN(sv))
1798 #  define SvRELEASE_IVX_(sv)    SvRELEASE_IVX(sv),
1799 #else
1800 #  define SvRELEASE_IVX(sv)   0
1801 /* This little game brought to you by the need to shut this warning up:
1802 mg.c: In function `Perl_magic_get':
1803 mg.c:1024: warning: left-hand operand of comma expression has no effect
1804 */
1805 #  define SvRELEASE_IVX_(sv)  /**/
1806 #endif /* PERL_OLD_COPY_ON_WRITE */
1807
1808 #define CAN_COW_MASK    (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1809                          SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1810                          SVf_OOK|SVf_BREAK|SVf_READONLY)
1811 #define CAN_COW_FLAGS   (SVp_POK|SVf_POK)
1812
1813 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1814                                     sv_force_normal_flags(sv, 0)
1815
1816
1817 /* all these 'functions' are now just macros */
1818
1819 #define sv_pv(sv) SvPV_nolen(sv)
1820 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1821 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1822
1823 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1824 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1825 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1826 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1827 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
1828 #define sv_setsv(dsv, ssv) \
1829         sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1830 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1831 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1832 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1833 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1834 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1835 #define sv_catpvn_mg(sv, sstr, slen) \
1836         sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1837 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1838 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1839 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1840 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1841 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1842 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1843 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1844 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1845 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1846 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1847 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1848 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1849 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
1850 #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
1851 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
1852 #define sv_insert(bigstr, offset, len, little, littlelen)               \
1853         Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little),  \
1854                              (littlelen), SV_GMAGIC)
1855
1856 /* Should be named SvCatPVN_utf8_upgrade? */
1857 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv)    \
1858         STMT_START {                                    \
1859             if (!(nsv))                                 \
1860                 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP);     \
1861             else                                        \
1862                 sv_setpvn(nsv, sstr, slen);             \
1863             SvUTF8_off(nsv);                            \
1864             sv_utf8_upgrade(nsv);                       \
1865             sv_catsv(dsv, nsv); \
1866         } STMT_END
1867
1868 /*
1869 =for apidoc Am|SV*|newRV_inc|SV* sv
1870
1871 Creates an RV wrapper for an SV.  The reference count for the original SV is
1872 incremented.
1873
1874 =cut
1875 */
1876
1877 #define newRV_inc(sv)   newRV(sv)
1878
1879 /* the following macros update any magic values this sv is associated with */
1880
1881 /*
1882 =head1 Magical Functions
1883
1884 =for apidoc Am|void|SvGETMAGIC|SV* sv
1885 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
1886 argument more than once.
1887
1888 =for apidoc Am|void|SvSETMAGIC|SV* sv
1889 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
1890 argument more than once.
1891
1892 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1893 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
1894 more than once.
1895
1896 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1897 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1898 ssv. May evaluate arguments more than once.
1899
1900 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1901 Like C<SvSetSV>, but does any set magic required afterwards.
1902
1903 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1904 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1905
1906 =for apidoc Am|void|SvSHARE|SV* sv
1907 Arranges for sv to be shared between threads if a suitable module
1908 has been loaded.
1909
1910 =for apidoc Am|void|SvLOCK|SV* sv
1911 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1912 has been loaded.
1913
1914 =for apidoc Am|void|SvUNLOCK|SV* sv
1915 Releases a mutual exclusion lock on sv if a suitable module
1916 has been loaded.
1917
1918 =head1 SV Manipulation Functions
1919
1920 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1921 Expands the character buffer in the SV so that it has room for the
1922 indicated number of bytes (remember to reserve space for an extra trailing
1923 NUL character).  Calls C<sv_grow> to perform the expansion if necessary.
1924 Returns a pointer to the character buffer.
1925
1926 =cut
1927 */
1928
1929 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
1930 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
1931 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
1932 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
1933
1934 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1935 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1936
1937 #define SvSetSV_and(dst,src,finally) \
1938         STMT_START {                                    \
1939             if ((dst) != (src)) {                       \
1940                 sv_setsv(dst, src);                     \
1941                 finally;                                \
1942             }                                           \
1943         } STMT_END
1944 #define SvSetSV_nosteal_and(dst,src,finally) \
1945         STMT_START {                                    \
1946             if ((dst) != (src)) {                       \
1947                 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV);   \
1948                 finally;                                \
1949             }                                           \
1950         } STMT_END
1951
1952 #define SvSetSV(dst,src) \
1953                 SvSetSV_and(dst,src,/*nothing*/;)
1954 #define SvSetSV_nosteal(dst,src) \
1955                 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1956
1957 #define SvSetMagicSV(dst,src) \
1958                 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1959 #define SvSetMagicSV_nosteal(dst,src) \
1960                 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1961
1962
1963 #if !defined(SKIP_DEBUGGING)
1964 #define SvPEEK(sv) sv_peek(sv)
1965 #else
1966 #define SvPEEK(sv) ""
1967 #endif
1968
1969 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1970
1971 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1972
1973 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1974 /* If I give every macro argument a different name, then there won't be bugs
1975    where nested macros get confused. Been there, done that.  */
1976 #define isGV_with_GP(pwadak) \
1977         (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP)   \
1978         && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
1979 #define isGV_with_GP_on(sv)     STMT_START {                           \
1980         assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1981         assert (!SvPOKp(sv));                                          \
1982         assert (!SvIOKp(sv));                                          \
1983         (SvFLAGS(sv) |= SVpgv_GP);                                     \
1984     } STMT_END
1985 #define isGV_with_GP_off(sv)    STMT_START {                           \
1986         assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1987         assert (!SvPOKp(sv));                                          \
1988         assert (!SvIOKp(sv));                                          \
1989         (SvFLAGS(sv) &= ~SVpgv_GP);                                    \
1990     } STMT_END
1991
1992
1993 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1994 #define SvGROW_mutable(sv,len) \
1995     (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1996 #define Sv_Grow sv_grow
1997
1998 #define CLONEf_COPY_STACKS 1
1999 #define CLONEf_KEEP_PTR_TABLE 2
2000 #define CLONEf_CLONE_HOST 4
2001 #define CLONEf_JOIN_IN 8
2002
2003 struct clone_params {
2004   AV* stashes;
2005   UV  flags;
2006   PerlInterpreter *proto_perl;
2007   PerlInterpreter *new_perl;
2008   AV *unreferenced;
2009 };
2010
2011 /*
2012 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2013
2014 Creates a new SV and copies a string into it.  If utf8 is true, calls
2015 C<SvUTF8_on> on the new SV.  Implemented as a wrapper around C<newSVpvn_flags>.
2016
2017 =cut
2018 */
2019
2020 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2021
2022 /*
2023 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2024
2025 Reads into I<len> the offset from SvPVX back to the true start of the
2026 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2027 efficiently remove characters from start of the buffer. Implemented as a
2028 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
2029 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
2030
2031 =cut
2032 */
2033
2034 #ifdef DEBUGGING
2035 /* Does the bot know something I don't?
2036 10:28 <@Nicholas> metabatman
2037 10:28 <+meta> Nicholas: crash
2038 */
2039 #  define SvOOK_offset(sv, offset) STMT_START {                         \
2040         assert(sizeof(offset) == sizeof(STRLEN));                       \
2041         if (SvOOK(sv)) {                                                \
2042             const U8 *crash = (U8*)SvPVX_const(sv);                     \
2043             offset = *--crash;                                          \
2044             if (!offset) {                                              \
2045                 crash -= sizeof(STRLEN);                                \
2046                 Copy(crash, (U8 *)&offset, sizeof(STRLEN), U8);         \
2047             }                                                           \
2048             {                                                           \
2049                 /* Validate the preceding buffer's sentinels to         \
2050                    verify that no-one is using it.  */                  \
2051                 const U8 *const bonk = (U8 *) SvPVX_const(sv) - offset; \
2052                 while (crash > bonk) {                                  \
2053                     --crash;                                            \
2054                     assert (*crash == (U8)PTR2UV(crash));               \
2055                 }                                                       \
2056             }                                                           \
2057         } else {                                                        \
2058             offset = 0;                                                 \
2059         }                                                               \
2060     } STMT_END
2061 #else
2062     /* This is the same code, but avoids using any temporary variables:  */
2063 #  define SvOOK_offset(sv, offset) STMT_START {                         \
2064         assert(sizeof(offset) == sizeof(STRLEN));                       \
2065         if (SvOOK(sv)) {                                                \
2066             offset = ((U8*)SvPVX_const(sv))[-1];                        \
2067             if (!offset) {                                              \
2068                 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN),              \
2069                      (U8 *)&offset, sizeof(STRLEN), U8);                \
2070             }                                                           \
2071         } else {                                                        \
2072             offset = 0;                                                 \
2073         }                                                               \
2074     } STMT_END
2075 #endif
2076
2077 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2078
2079 /*
2080  * Local variables:
2081  * c-indentation-style: bsd
2082  * c-basic-offset: 4
2083  * indent-tabs-mode: t
2084  * End:
2085  *
2086  * ex: set ts=8 sts=4 sw=4 noet:
2087  */