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