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