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