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