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