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