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