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