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