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