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