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