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