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