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