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