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