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