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