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