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