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