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