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