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