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