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