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