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