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