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