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