This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Eliminate the remaining definitions for *_allocated structs.
[perl5.git] / sv.h
1 /*    sv.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 #ifdef sv_flags
12 #undef sv_flags         /* Convex has this in <signal.h> for sigvec() */
13 #endif
14
15 /*
16 =head1 SV Flags
17
18 =for apidoc AmU||svtype
19 An enum of flags for Perl types.  These are found in the file B<sv.h>
20 in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
21
22 =for apidoc AmU||SVt_PV
23 Pointer type flag for scalars.  See C<svtype>.
24
25 =for apidoc AmU||SVt_IV
26 Integer type flag for scalars.  See C<svtype>.
27
28 =for apidoc AmU||SVt_NV
29 Double type flag for scalars.  See C<svtype>.
30
31 =for apidoc AmU||SVt_PVMG
32 Type flag for blessed scalars.  See C<svtype>.
33
34 =for apidoc AmU||SVt_PVAV
35 Type flag for arrays.  See C<svtype>.
36
37 =for apidoc AmU||SVt_PVHV
38 Type flag for hashes.  See C<svtype>.
39
40 =for apidoc AmU||SVt_PVCV
41 Type flag for code refs.  See C<svtype>.
42
43 =cut
44 */
45
46 typedef enum {
47         SVt_NULL,       /* 0 */
48         SVt_BIND,       /* 1 */
49         SVt_IV,         /* 2 */
50         SVt_NV,         /* 3 */
51         /* RV was here, before it was merged with IV.  */
52         SVt_PV,         /* 4 */
53         SVt_PVIV,       /* 5 */
54         SVt_PVNV,       /* 6 */
55         SVt_PVMG,       /* 7 */
56         SVt_REGEXP,     /* 8 */
57         /* PVBM was here, before BIND replaced it.  */
58         SVt_PVGV,       /* 9 */
59         SVt_PVLV,       /* 10 */
60         SVt_PVAV,       /* 11 */
61         SVt_PVHV,       /* 12 */
62         SVt_PVCV,       /* 13 */
63         SVt_PVFM,       /* 14 */
64         SVt_PVIO,       /* 15 */
65         SVt_LAST        /* keep last in enum. used to size arrays */
66 } svtype;
67
68 #ifndef PERL_CORE
69 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
70    purposes eternal code wanting to consider PVBM probably needs to think of
71    PVMG instead.  */
72 #  define SVt_PVBM      SVt_PVMG
73 /* Anything wanting to create a reference from clean should ensure that it has
74    a scalar of type SVt_IV now:  */
75 #  define SVt_RV        SVt_IV
76 #endif
77
78 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
79    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 = MUTABLE_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         MUTABLE_SV(sv);                         \
238     })
239 #  define SvREFCNT_inc_NN(sv)           \
240     ({                                  \
241         SV * const _sv = MUTABLE_SV(sv);        \
242         SvREFCNT(_sv)++;                \
243         _sv;                            \
244     })
245 #  define SvREFCNT_inc_void(sv)         \
246     ({                                  \
247         SV * const _sv = MUTABLE_SV(sv);        \
248         if (_sv)                        \
249             (void)(SvREFCNT(_sv)++);    \
250     })
251 #else
252 #  define SvREFCNT_inc(sv)      \
253         ((PL_Sv=MUTABLE_SV(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
254 #  define SvREFCNT_inc_simple(sv) \
255         ((sv) ? (SvREFCNT(sv)++,MUTABLE_SV(sv)) : NULL)
256 #  define SvREFCNT_inc_NN(sv) \
257         (PL_Sv=MUTABLE_SV(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
258 #  define SvREFCNT_inc_void(sv) \
259         (void)((PL_Sv=MUTABLE_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)),MUTABLE_SV(sv))
265 #define SvREFCNT_inc_void_NN(sv)        (void)(++SvREFCNT(MUTABLE_SV(sv)))
266 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
267
268 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
269 #  define SvREFCNT_dec(sv)              \
270     ({                                  \
271         SV * const _sv = MUTABLE_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(MUTABLE_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 struct xpviv {
443     _XPV_HEAD;
444     union _xivu xiv_u;
445 };
446
447 #define xiv_iv xiv_u.xivu_iv
448
449 struct xpvuv {
450     _XPV_HEAD;
451     union _xivu xuv_u;
452 };
453
454 #define xuv_uv xuv_u.xivu_uv
455
456 struct xpvnv {
457     _XPV_HEAD;
458     union _xivu xiv_u;
459 };
460
461 #define _XPVMG_HEAD                                 \
462     union _xivu xiv_u;                              \
463     union _xmgu xmg_u;                              \
464     HV*         xmg_stash       /* class package */
465
466 /* These structure must match the beginning of struct xpvhv in hv.h. */
467 struct xpvmg {
468     _XPV_HEAD;
469     _XPVMG_HEAD;
470 };
471
472 struct xpvlv {
473     _XPV_HEAD;
474     _XPVMG_HEAD;
475
476     STRLEN      xlv_targoff;
477     STRLEN      xlv_targlen;
478     SV*         xlv_targ;
479     char        xlv_type;       /* k=keys .=pos x=substr v=vec /=join/re
480                                  * y=alem/helem/iter t=tie T=tied HE */
481 };
482
483 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
484    Boyer-Moore.  */
485 struct xpvgv {
486     _XPV_HEAD;
487     _XPVMG_HEAD;
488 };
489
490 /* This structure must match XPVCV in cv.h */
491
492 typedef U16 cv_flags_t;
493
494 #define _XPVCV_COMMON                                                           \
495     HV *        xcv_stash;                                                      \
496     union {                                                                     \
497         OP *    xcv_start;                                                      \
498         ANY     xcv_xsubany;                                                    \
499     }           xcv_start_u;                                                    \
500     union {                                                                     \
501         OP *    xcv_root;                                                       \
502         void    (*xcv_xsub) (pTHX_ CV*);                                        \
503     }           xcv_root_u;                                                     \
504     GV *        xcv_gv;                                                         \
505     char *      xcv_file;                                                       \
506     AV *        xcv_padlist;                                                    \
507     CV *        xcv_outside;                                                    \
508     U32         xcv_outside_seq; /* the COP sequence (at the point of our       \
509                                   * compilation) in the lexically enclosing     \
510                                   * sub */                                      \
511     cv_flags_t  xcv_flags
512
513 struct xpvfm {
514     _XPV_HEAD;
515     _XPVMG_HEAD;
516     _XPVCV_COMMON;
517 };
518
519 #define _XPVIO_TAIL                                                     \
520     PerlIO *    xio_ifp;        /* ifp and ofp are normally the same */ \
521     PerlIO *    xio_ofp;        /* but sockets need separate streams */ \
522     /* Cray addresses everything by word boundaries (64 bits) and       \
523      * code and data pointers cannot be mixed (which is exactly what    \
524      * Perl_filter_add() tries to do with the dirp), hence the          \
525      *  following union trick (as suggested by Gurusamy Sarathy).       \
526      * For further information see Geir Johansen's problem report       \
527      * titled [ID 20000612.002] Perl problem on Cray system             \
528      * The any pointer (known as IoANY()) will also be a good place     \
529      * to hang any IO disciplines to.                                   \
530      */                                                                 \
531     union {                                                             \
532         DIR *   xiou_dirp;      /* for opendir, readdir, etc */         \
533         void *  xiou_any;       /* for alignment */                     \
534     } xio_dirpu;                                                        \
535     IV          xio_lines;      /* $. */                                \
536     IV          xio_page;       /* $% */                                \
537     IV          xio_page_len;   /* $= */                                \
538     IV          xio_lines_left; /* $- */                                \
539     char *      xio_top_name;   /* $^ */                                \
540     GV *        xio_top_gv;     /* $^ */                                \
541     char *      xio_fmt_name;   /* $~ */                                \
542     GV *        xio_fmt_gv;     /* $~ */                                \
543     char *      xio_bottom_name;/* $^B */                               \
544     GV *        xio_bottom_gv;  /* $^B */                               \
545     char        xio_type;                                               \
546     U8          xio_flags
547
548
549 struct xpvio {
550     _XPV_HEAD;
551     _XPVMG_HEAD;
552     _XPVIO_TAIL;
553 };
554
555 #define xio_dirp        xio_dirpu.xiou_dirp
556 #define xio_any         xio_dirpu.xiou_any
557
558 #define IOf_ARGV        1       /* this fp iterates over ARGV */
559 #define IOf_START       2       /* check for null ARGV and substitute '-' */
560 #define IOf_FLUSH       4       /* this fp wants a flush after write op */
561 #define IOf_DIDTOP      8       /* just did top of form */
562 #define IOf_UNTAINT     16      /* consider this fp (and its data) "safe" */
563 #define IOf_NOLINE      32      /* slurped a pseudo-line from empty file */
564 #define IOf_FAKE_DIRP   64      /* xio_dirp is fake (source filters kludge) */
565
566 /* The following macros define implementation-independent predicates on SVs. */
567
568 /*
569 =for apidoc Am|U32|SvNIOK|SV* sv
570 Returns a U32 value indicating whether the SV contains a number, integer or
571 double.
572
573 =for apidoc Am|U32|SvNIOKp|SV* sv
574 Returns a U32 value indicating whether the SV contains a number, integer or
575 double.  Checks the B<private> setting.  Use C<SvNIOK> instead.
576
577 =for apidoc Am|void|SvNIOK_off|SV* sv
578 Unsets the NV/IV status of an SV.
579
580 =for apidoc Am|U32|SvOK|SV* sv
581 Returns a U32 value indicating whether the value is defined. This is
582 only meaningful for scalars.
583
584 =for apidoc Am|U32|SvIOKp|SV* sv
585 Returns a U32 value indicating whether the SV contains an integer.  Checks
586 the B<private> setting.  Use C<SvIOK> instead.
587
588 =for apidoc Am|U32|SvNOKp|SV* sv
589 Returns a U32 value indicating whether the SV contains a double.  Checks the
590 B<private> setting.  Use C<SvNOK> instead.
591
592 =for apidoc Am|U32|SvPOKp|SV* sv
593 Returns a U32 value indicating whether the SV contains a character string.
594 Checks the B<private> setting.  Use C<SvPOK> instead.
595
596 =for apidoc Am|U32|SvIOK|SV* sv
597 Returns a U32 value indicating whether the SV contains an integer.
598
599 =for apidoc Am|void|SvIOK_on|SV* sv
600 Tells an SV that it is an integer.
601
602 =for apidoc Am|void|SvIOK_off|SV* sv
603 Unsets the IV status of an SV.
604
605 =for apidoc Am|void|SvIOK_only|SV* sv
606 Tells an SV that it is an integer and disables all other OK bits.
607
608 =for apidoc Am|void|SvIOK_only_UV|SV* sv
609 Tells and SV that it is an unsigned integer and disables all other OK bits.
610
611 =for apidoc Am|bool|SvIOK_UV|SV* sv
612 Returns a boolean indicating whether the SV contains an unsigned integer.
613
614 =for apidoc Am|bool|SvUOK|SV* sv
615 Returns a boolean indicating whether the SV contains an unsigned integer.
616
617 =for apidoc Am|bool|SvIOK_notUV|SV* sv
618 Returns a boolean indicating whether the SV contains a signed integer.
619
620 =for apidoc Am|U32|SvNOK|SV* sv
621 Returns a U32 value indicating whether the SV contains a double.
622
623 =for apidoc Am|void|SvNOK_on|SV* sv
624 Tells an SV that it is a double.
625
626 =for apidoc Am|void|SvNOK_off|SV* sv
627 Unsets the NV status of an SV.
628
629 =for apidoc Am|void|SvNOK_only|SV* sv
630 Tells an SV that it is a double and disables all other OK bits.
631
632 =for apidoc Am|U32|SvPOK|SV* sv
633 Returns a U32 value indicating whether the SV contains a character
634 string.
635
636 =for apidoc Am|void|SvPOK_on|SV* sv
637 Tells an SV that it is a string.
638
639 =for apidoc Am|void|SvPOK_off|SV* sv
640 Unsets the PV status of an SV.
641
642 =for apidoc Am|void|SvPOK_only|SV* sv
643 Tells an SV that it is a string and disables all other OK bits.
644 Will also turn off the UTF-8 status.
645
646 =for apidoc Am|bool|SvVOK|SV* sv
647 Returns a boolean indicating whether the SV contains a v-string.
648
649 =for apidoc Am|U32|SvOOK|SV* sv
650 Returns a U32 indicating whether the pointer to the string buffer is offset.
651 This hack is used internally to speed up removal of characters from the
652 beginning of a SvPV.  When SvOOK is true, then the start of the
653 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
654 This offset used to be stored in SvIVX, but is now stored within the spare
655 part of the buffer.
656
657 =for apidoc Am|U32|SvROK|SV* sv
658 Tests if the SV is an RV.
659
660 =for apidoc Am|void|SvROK_on|SV* sv
661 Tells an SV that it is an RV.
662
663 =for apidoc Am|void|SvROK_off|SV* sv
664 Unsets the RV status of an SV.
665
666 =for apidoc Am|SV*|SvRV|SV* sv
667 Dereferences an RV to return the SV.
668
669 =for apidoc Am|IV|SvIVX|SV* sv
670 Returns the raw value in the SV's IV slot, without checks or conversions.
671 Only use when you are sure SvIOK is true. See also C<SvIV()>.
672
673 =for apidoc Am|UV|SvUVX|SV* sv
674 Returns the raw value in the SV's UV slot, without checks or conversions.
675 Only use when you are sure SvIOK is true. See also C<SvUV()>.
676
677 =for apidoc Am|NV|SvNVX|SV* sv
678 Returns the raw value in the SV's NV slot, without checks or conversions.
679 Only use when you are sure SvNOK is true. See also C<SvNV()>.
680
681 =for apidoc Am|char*|SvPVX|SV* sv
682 Returns a pointer to the physical string in the SV.  The SV must contain a
683 string.
684
685 =for apidoc Am|STRLEN|SvCUR|SV* sv
686 Returns the length of the string which is in the SV.  See C<SvLEN>.
687
688 =for apidoc Am|STRLEN|SvLEN|SV* sv
689 Returns the size of the string buffer in the SV, not including any part
690 attributable to C<SvOOK>.  See C<SvCUR>.
691
692 =for apidoc Am|char*|SvEND|SV* sv
693 Returns a pointer to the last character in the string which is in the SV.
694 See C<SvCUR>.  Access the character as *(SvEND(sv)).
695
696 =for apidoc Am|HV*|SvSTASH|SV* sv
697 Returns the stash of the SV.
698
699 =for apidoc Am|void|SvIV_set|SV* sv|IV val
700 Set the value of the IV pointer in sv to val.  It is possible to perform
701 the same function of this macro with an lvalue assignment to C<SvIVX>.
702 With future Perls, however, it will be more efficient to use 
703 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
704
705 =for apidoc Am|void|SvNV_set|SV* sv|NV val
706 Set the value of the NV pointer in sv to val.  See C<SvIV_set>.
707
708 =for apidoc Am|void|SvPV_set|SV* sv|char* val
709 Set the value of the PV pointer in sv to val.  See C<SvIV_set>.
710
711 =for apidoc Am|void|SvUV_set|SV* sv|UV val
712 Set the value of the UV pointer in sv to val.  See C<SvIV_set>.
713
714 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
715 Set the value of the RV pointer in sv to val.  See C<SvIV_set>.
716
717 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
718 Set the value of the MAGIC pointer in sv to val.  See C<SvIV_set>.
719
720 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
721 Set the value of the STASH pointer in sv to val.  See C<SvIV_set>.
722
723 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
724 Set the current length of the string which is in the SV.  See C<SvCUR>
725 and C<SvIV_set>.
726
727 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
728 Set the actual length of the string which is in the SV.  See C<SvIV_set>.
729
730 =cut
731 */
732
733 #define SvNIOK(sv)              (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
734 #define SvNIOKp(sv)             (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
735 #define SvNIOK_off(sv)          (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
736                                                   SVp_IOK|SVp_NOK|SVf_IVisUV))
737
738 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
739 #define assert_not_ROK(sv)      ({assert(!SvROK(sv) || !SvRV(sv));}),
740 #define assert_not_glob(sv)     ({assert(!isGV_with_GP(sv));}),
741 #else
742 #define assert_not_ROK(sv)      
743 #define assert_not_glob(sv)     
744 #endif
745
746 #define SvOK(sv)                ((SvTYPE(sv) == SVt_BIND)               \
747                                  ? (SvFLAGS(SvRV(sv)) & SVf_OK)         \
748                                  : (SvFLAGS(sv) & SVf_OK))
749 #define SvOK_off(sv)            (assert_not_ROK(sv) assert_not_glob(sv) \
750                                  SvFLAGS(sv) &= ~(SVf_OK|               \
751                                                   SVf_IVisUV|SVf_UTF8), \
752                                                         SvOOK_off(sv))
753 #define SvOK_off_exc_UV(sv)     (assert_not_ROK(sv)                     \
754                                  SvFLAGS(sv) &= ~(SVf_OK|               \
755                                                   SVf_UTF8),            \
756                                                         SvOOK_off(sv))
757
758 #define SvOKp(sv)               (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
759 #define SvIOKp(sv)              (SvFLAGS(sv) & SVp_IOK)
760 #define SvIOKp_on(sv)           (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
761                                     SvFLAGS(sv) |= SVp_IOK)
762 #define SvNOKp(sv)              (SvFLAGS(sv) & SVp_NOK)
763 #define SvNOKp_on(sv)           (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
764 #define SvPOKp(sv)              (SvFLAGS(sv) & SVp_POK)
765 #define SvPOKp_on(sv)           (assert_not_ROK(sv) assert_not_glob(sv) \
766                                  SvFLAGS(sv) |= SVp_POK)
767
768 #define SvIOK(sv)               (SvFLAGS(sv) & SVf_IOK)
769 #define SvIOK_on(sv)            (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
770                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
771 #define SvIOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
772 #define SvIOK_only(sv)          (SvOK_off(sv), \
773                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
774 #define SvIOK_only_UV(sv)       (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
775                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
776
777 #define SvIOK_UV(sv)            ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
778                                  == (SVf_IOK|SVf_IVisUV))
779 #define SvUOK(sv)               SvIOK_UV(sv)
780 #define SvIOK_notUV(sv)         ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
781                                  == SVf_IOK)
782
783 #define SvIsUV(sv)              (SvFLAGS(sv) & SVf_IVisUV)
784 #define SvIsUV_on(sv)           (SvFLAGS(sv) |= SVf_IVisUV)
785 #define SvIsUV_off(sv)          (SvFLAGS(sv) &= ~SVf_IVisUV)
786
787 #define SvNOK(sv)               (SvFLAGS(sv) & SVf_NOK)
788 #define SvNOK_on(sv)            (assert_not_glob(sv) \
789                                  SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
790 #define SvNOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
791 #define SvNOK_only(sv)          (SvOK_off(sv), \
792                                     SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
793
794 /*
795 =for apidoc Am|U32|SvUTF8|SV* sv
796 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
797 Call this after SvPV() in case any call to string overloading updates the
798 internal flag.
799
800 =for apidoc Am|void|SvUTF8_on|SV *sv
801 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
802 Do not use frivolously.
803
804 =for apidoc Am|void|SvUTF8_off|SV *sv
805 Unsets the UTF-8 status of an SV.
806
807 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
808 Tells an SV that it is a string and disables all other OK bits,
809 and leaves the UTF-8 status as it was.
810
811 =cut
812  */
813
814 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
815 in gv.h: */
816 #define SvUTF8(sv)              (SvFLAGS(sv) & SVf_UTF8)
817 #define SvUTF8_on(sv)           (SvFLAGS(sv) |= (SVf_UTF8))
818 #define SvUTF8_off(sv)          (SvFLAGS(sv) &= ~(SVf_UTF8))
819
820 #define SvPOK(sv)               (SvFLAGS(sv) & SVf_POK)
821 #define SvPOK_on(sv)            (assert_not_ROK(sv) assert_not_glob(sv) \
822                                  SvFLAGS(sv) |= (SVf_POK|SVp_POK))
823 #define SvPOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
824 #define SvPOK_only(sv)          (assert_not_ROK(sv) assert_not_glob(sv) \
825                                  SvFLAGS(sv) &= ~(SVf_OK|               \
826                                                   SVf_IVisUV|SVf_UTF8), \
827                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
828 #define SvPOK_only_UTF8(sv)     (assert_not_ROK(sv) assert_not_glob(sv) \
829                                  SvFLAGS(sv) &= ~(SVf_OK|               \
830                                                   SVf_IVisUV),          \
831                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
832
833 #define SvVOK(sv)               (SvMAGICAL(sv)                          \
834                                  && mg_find(sv,PERL_MAGIC_vstring))
835 /* returns the vstring magic, if any */
836 #define SvVSTRING_mg(sv)        (SvMAGICAL(sv) \
837                                  ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
838
839 #define SvOOK(sv)               (SvFLAGS(sv) & SVf_OOK)
840 #define SvOOK_on(sv)            ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
841 #define SvOOK_off(sv)           ((void)(SvOOK(sv) && sv_backoff(sv)))
842
843 #define SvFAKE(sv)              (SvFLAGS(sv) & SVf_FAKE)
844 #define SvFAKE_on(sv)           (SvFLAGS(sv) |= SVf_FAKE)
845 #define SvFAKE_off(sv)          (SvFLAGS(sv) &= ~SVf_FAKE)
846
847 #define SvROK(sv)               (SvFLAGS(sv) & SVf_ROK)
848 #define SvROK_on(sv)            (SvFLAGS(sv) |= SVf_ROK)
849 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~(SVf_ROK))
850
851 #define SvMAGICAL(sv)           (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
852 #define SvMAGICAL_on(sv)        (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
853 #define SvMAGICAL_off(sv)       (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
854
855 #define SvGMAGICAL(sv)          (SvFLAGS(sv) & SVs_GMG)
856 #define SvGMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_GMG)
857 #define SvGMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_GMG)
858
859 #define SvSMAGICAL(sv)          (SvFLAGS(sv) & SVs_SMG)
860 #define SvSMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_SMG)
861 #define SvSMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_SMG)
862
863 #define SvRMAGICAL(sv)          (SvFLAGS(sv) & SVs_RMG)
864 #define SvRMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_RMG)
865 #define SvRMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_RMG)
866
867 #define SvAMAGIC(sv)            (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
868 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
869 #  define SvAMAGIC_on(sv)       ({ SV * const kloink = sv;              \
870                                    assert(SvROK(kloink));               \
871                                    SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
872                                 })
873 #  define SvAMAGIC_off(sv)      ({ SV * const kloink = sv;              \
874                                    if(SvROK(kloink))                    \
875                                         SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
876                                 })
877 #else
878 #  define SvAMAGIC_on(sv)       (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
879 #  define SvAMAGIC_off(sv) \
880         (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
881 #endif
882
883 /*
884 =for apidoc Am|U32|SvGAMAGIC|SV* sv
885
886 Returns true if the SV has get magic or overloading. If either is true then
887 the scalar is active data, and has the potential to return a new value every
888 time it is accessed. Hence you must be careful to only read it once per user
889 logical operation and work with that returned value. If neither is true then
890 the scalar's value cannot change unless written to.
891
892 =cut
893 */
894
895 #define SvGAMAGIC(sv)           (SvGMAGICAL(sv) || SvAMAGIC(sv))
896
897 #define Gv_AMG(stash)           (PL_amagic_generation && Gv_AMupdate(stash, FALSE))
898
899 #define SvWEAKREF(sv)           ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
900                                   == (SVf_ROK|SVprv_WEAKREF))
901 #define SvWEAKREF_on(sv)        (SvFLAGS(sv) |=  (SVf_ROK|SVprv_WEAKREF))
902 #define SvWEAKREF_off(sv)       (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
903
904 #define SvPCS_IMPORTED(sv)      ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
905                                  == (SVf_ROK|SVprv_PCS_IMPORTED))
906 #define SvPCS_IMPORTED_on(sv)   (SvFLAGS(sv) |=  (SVf_ROK|SVprv_PCS_IMPORTED))
907 #define SvPCS_IMPORTED_off(sv)  (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
908
909 #define SvTHINKFIRST(sv)        (SvFLAGS(sv) & SVf_THINKFIRST)
910
911 #define SvPADSTALE(sv)          (SvFLAGS(sv) & SVs_PADSTALE)
912 #define SvPADSTALE_on(sv)       (SvFLAGS(sv) |= SVs_PADSTALE)
913 #define SvPADSTALE_off(sv)      (SvFLAGS(sv) &= ~SVs_PADSTALE)
914
915 #define SvPADTMP(sv)            (SvFLAGS(sv) & SVs_PADTMP)
916 #define SvPADTMP_on(sv)         (SvFLAGS(sv) |= SVs_PADTMP)
917 #define SvPADTMP_off(sv)        (SvFLAGS(sv) &= ~SVs_PADTMP)
918
919 #define SvPADMY(sv)             (SvFLAGS(sv) & SVs_PADMY)
920 #define SvPADMY_on(sv)          (SvFLAGS(sv) |= SVs_PADMY)
921
922 #define SvTEMP(sv)              (SvFLAGS(sv) & SVs_TEMP)
923 #define SvTEMP_on(sv)           (SvFLAGS(sv) |= SVs_TEMP)
924 #define SvTEMP_off(sv)          (SvFLAGS(sv) &= ~SVs_TEMP)
925
926 #define SvOBJECT(sv)            (SvFLAGS(sv) & SVs_OBJECT)
927 #define SvOBJECT_on(sv)         (SvFLAGS(sv) |= SVs_OBJECT)
928 #define SvOBJECT_off(sv)        (SvFLAGS(sv) &= ~SVs_OBJECT)
929
930 #define SvREADONLY(sv)          (SvFLAGS(sv) & SVf_READONLY)
931 #define SvREADONLY_on(sv)       (SvFLAGS(sv) |= SVf_READONLY)
932 #define SvREADONLY_off(sv)      (SvFLAGS(sv) &= ~SVf_READONLY)
933
934 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
935 #define SvSCREAM_on(sv)         (SvFLAGS(sv) |= SVp_SCREAM)
936 #define SvSCREAM_off(sv)        (SvFLAGS(sv) &= ~SVp_SCREAM)
937
938 #define SvCOMPILED(sv)          (SvFLAGS(sv) & SVpfm_COMPILED)
939 #define SvCOMPILED_on(sv)       (SvFLAGS(sv) |= SVpfm_COMPILED)
940 #define SvCOMPILED_off(sv)      (SvFLAGS(sv) &= ~SVpfm_COMPILED)
941
942 #define SvEVALED(sv)            (SvFLAGS(sv) & SVrepl_EVAL)
943 #define SvEVALED_on(sv)         (SvFLAGS(sv) |= SVrepl_EVAL)
944 #define SvEVALED_off(sv)        (SvFLAGS(sv) &= ~SVrepl_EVAL)
945
946 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
947 #  define SvVALID(sv)           ({ const SV *const _svvalid = (const SV*)(sv); \
948                                    if (SvFLAGS(_svvalid) & SVpbm_VALID) \
949                                        assert(!isGV_with_GP(_svvalid)); \
950                                    (SvFLAGS(_svvalid) & SVpbm_VALID);   \
951                                 })
952 #  define SvVALID_on(sv)        ({ SV *const _svvalid = MUTABLE_SV(sv); \
953                                    assert(!isGV_with_GP(_svvalid));     \
954                                    (SvFLAGS(_svvalid) |= SVpbm_VALID);  \
955                                 })
956 #  define SvVALID_off(sv)       ({ SV *const _svvalid = MUTABLE_SV(sv); \
957                                    assert(!isGV_with_GP(_svvalid));     \
958                                    (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
959                                 })
960
961 #  define SvTAIL(sv)    ({ const SV *const _svtail = (const SV *)(sv);  \
962                             assert(SvTYPE(_svtail) != SVt_PVAV);                \
963                             assert(SvTYPE(_svtail) != SVt_PVHV);                \
964                             (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID))    \
965                                 == (SVpbm_TAIL|SVpbm_VALID);            \
966                         })
967 #else
968 #  define SvVALID(sv)           (SvFLAGS(sv) & SVpbm_VALID)
969 #  define SvVALID_on(sv)        (SvFLAGS(sv) |= SVpbm_VALID)
970 #  define SvVALID_off(sv)       (SvFLAGS(sv) &= ~SVpbm_VALID)
971 #  define SvTAIL(sv)        ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID))   \
972                              == (SVpbm_TAIL|SVpbm_VALID))
973
974 #endif
975 #define SvTAIL_on(sv)           (SvFLAGS(sv) |= SVpbm_TAIL)
976 #define SvTAIL_off(sv)          (SvFLAGS(sv) &= ~SVpbm_TAIL)
977
978
979 #define SvPAD_TYPED(sv) \
980         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
981
982 #define SvPAD_OUR(sv)   \
983         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
984
985 #define SvPAD_STATE(sv) \
986         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
987
988 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
989 #  define SvPAD_TYPED_on(sv)    ({                                      \
990             SV *const _svpad = MUTABLE_SV(sv);                          \
991             assert(SvTYPE(_svpad) == SVt_PVMG);                         \
992             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED);                \
993         })
994 #define SvPAD_OUR_on(sv)        ({                                      \
995             SV *const _svpad = MUTABLE_SV(sv);                          \
996             assert(SvTYPE(_svpad) == SVt_PVMG);                         \
997             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR);                  \
998         })
999 #define SvPAD_STATE_on(sv)      ({                                      \
1000             SV *const _svpad = MUTABLE_SV(sv);                          \
1001             assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
1002             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE);                \
1003         })
1004 #else
1005 #  define SvPAD_TYPED_on(sv)    (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1006 #  define SvPAD_OUR_on(sv)      (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1007 #  define SvPAD_STATE_on(sv)    (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1008 #endif
1009
1010 #define SvOURSTASH(sv)  \
1011         (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1012 #define SvOURSTASH_set(sv, st)                                  \
1013         STMT_START {                                            \
1014             assert(SvTYPE(sv) == SVt_PVMG);                     \
1015             ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st;      \
1016         } STMT_END
1017
1018 #ifdef PERL_DEBUG_COW
1019 #else
1020 #endif
1021 #define SvRVx(sv) SvRV(sv)
1022
1023 #ifdef PERL_DEBUG_COW
1024 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1025    +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1026 #  define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1027 #  define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1028 #  define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1029 #  define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1030 #  define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1031 /* Don't test the core XS code yet.  */
1032 #  if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1033 #    define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1034 #  else
1035 #  define SvPVX(sv) SvPVX_mutable(sv)
1036 #  endif
1037 #  define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1038 #  define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1039 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1040
1041 #  ifdef DEBUGGING
1042 #    define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic))
1043 #    define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_stash))
1044 #  else
1045 #    define SvMAGIC(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic)
1046 #    define SvSTASH(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_stash)
1047 #  endif
1048 #else
1049 #  define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1050 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1051
1052 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1053 /* These get expanded inside other macros that already use a variable _sv  */
1054 #    define SvPVX(sv)                                                   \
1055         (*({ SV *const _svpvx = MUTABLE_SV(sv);                         \
1056             assert(SvTYPE(_svpvx) >= SVt_PV);                           \
1057             assert(SvTYPE(_svpvx) != SVt_PVAV);                         \
1058             assert(SvTYPE(_svpvx) != SVt_PVHV);                         \
1059             assert(!isGV_with_GP(_svpvx));                              \
1060             &((_svpvx)->sv_u.svu_pv);                                   \
1061          }))
1062 #    define SvCUR(sv)                                                   \
1063         (*({ const SV *const _svcur = (const SV *)(sv);                 \
1064             assert(SvTYPE(_svcur) >= SVt_PV);                           \
1065             assert(SvTYPE(_svcur) != SVt_PVAV);                         \
1066             assert(SvTYPE(_svcur) != SVt_PVHV);                         \
1067             assert(!isGV_with_GP(_svcur));                              \
1068             &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur);            \
1069          }))
1070 #    define SvIVX(sv)                                                   \
1071         (*({ const SV *const _svivx = (const SV *)(sv);                 \
1072             assert(SvTYPE(_svivx) == SVt_IV || SvTYPE(_svivx) >= SVt_PVIV); \
1073             assert(SvTYPE(_svivx) != SVt_PVAV);                         \
1074             assert(SvTYPE(_svivx) != SVt_PVHV);                         \
1075             assert(SvTYPE(_svivx) != SVt_PVCV);                         \
1076             assert(SvTYPE(_svivx) != SVt_PVFM);                         \
1077             assert(!isGV_with_GP(_svivx));                              \
1078             &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv);           \
1079          }))
1080 #    define SvUVX(sv)                                                   \
1081         (*({ const SV *const _svuvx = (const SV *)(sv);                 \
1082             assert(SvTYPE(_svuvx) == SVt_IV || SvTYPE(_svuvx) >= SVt_PVIV); \
1083             assert(SvTYPE(_svuvx) != SVt_PVAV);                         \
1084             assert(SvTYPE(_svuvx) != SVt_PVHV);                         \
1085             assert(SvTYPE(_svuvx) != SVt_PVCV);                         \
1086             assert(SvTYPE(_svuvx) != SVt_PVFM);                         \
1087             assert(!isGV_with_GP(_svuvx));                              \
1088             &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv);           \
1089          }))
1090 #    define SvNVX(sv)                                                   \
1091         (*({ const SV *const _svnvx = (const SV *)(sv);                 \
1092             assert(SvTYPE(_svnvx) == SVt_NV || SvTYPE(_svnvx) >= SVt_PVNV); \
1093             assert(SvTYPE(_svnvx) != SVt_PVAV);                         \
1094             assert(SvTYPE(_svnvx) != SVt_PVHV);                         \
1095             assert(SvTYPE(_svnvx) != SVt_PVCV);                         \
1096             assert(SvTYPE(_svnvx) != SVt_PVFM);                         \
1097             assert(SvTYPE(_svnvx) != SVt_PVIO);                         \
1098             assert(!isGV_with_GP(_svnvx));                              \
1099             &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv);     \
1100          }))
1101 #    define SvRV(sv)                                                    \
1102         (*({ SV *const _svrv = MUTABLE_SV(sv);                          \
1103             assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1104             assert(SvTYPE(_svrv) != SVt_PVAV);                          \
1105             assert(SvTYPE(_svrv) != SVt_PVHV);                          \
1106             assert(SvTYPE(_svrv) != SVt_PVCV);                          \
1107             assert(SvTYPE(_svrv) != SVt_PVFM);                          \
1108             assert(!isGV_with_GP(_svrv));                               \
1109             &((_svrv)->sv_u.svu_rv);                                    \
1110          }))
1111 #    define SvRV_const(sv)                                              \
1112         ({ const SV *const _svrv = (const SV *)(sv);                    \
1113             assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1114             assert(SvTYPE(_svrv) != SVt_PVAV);                          \
1115             assert(SvTYPE(_svrv) != SVt_PVHV);                          \
1116             assert(SvTYPE(_svrv) != SVt_PVCV);                          \
1117             assert(SvTYPE(_svrv) != SVt_PVFM);                          \
1118             assert(!isGV_with_GP(_svrv));                               \
1119             (_svrv)->sv_u.svu_rv;                                       \
1120          })
1121 #    define SvMAGIC(sv)                                                 \
1122         (*({ const SV *const _svmagic = (const SV *)(sv);               \
1123             assert(SvTYPE(_svmagic) >= SVt_PVMG);                       \
1124             if(SvTYPE(_svmagic) == SVt_PVMG)                            \
1125                 assert(!SvPAD_OUR(_svmagic));                           \
1126             &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1127           }))
1128 #    define SvSTASH(sv)                                                 \
1129         (*({ const SV *const _svstash = (const SV *)(sv);               \
1130             assert(SvTYPE(_svstash) >= SVt_PVMG);                       \
1131             &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash);      \
1132           }))
1133 #  else
1134 #    define SvPVX(sv) ((sv)->sv_u.svu_pv)
1135 #    define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1136 #    define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1137 #    define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1138 #    define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1139 #    define SvRV(sv) ((sv)->sv_u.svu_rv)
1140 #    define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1141 #    define SvMAGIC(sv) ((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic
1142 #    define SvSTASH(sv) ((XPVMG*)  SvANY(sv))->xmg_stash
1143 #  endif
1144 #endif
1145
1146 #ifndef PERL_POISON
1147 /* Given that these two are new, there can't be any existing code using them
1148  *  as LVALUEs  */
1149 #  define SvPVX_mutable(sv)     (0 + (sv)->sv_u.svu_pv)
1150 #  define SvPVX_const(sv)       ((const char*)(0 + (sv)->sv_u.svu_pv))
1151 #else
1152 /* Except for the poison code, which uses & to scribble over the pointer after
1153    free() is called.  */
1154 #  define SvPVX_mutable(sv)     ((sv)->sv_u.svu_pv)
1155 #  define SvPVX_const(sv)       ((const char*)((sv)->sv_u.svu_pv))
1156 #endif
1157
1158 #define SvIVXx(sv) SvIVX(sv)
1159 #define SvUVXx(sv) SvUVX(sv)
1160 #define SvNVXx(sv) SvNVX(sv)
1161 #define SvPVXx(sv) SvPVX(sv)
1162 #define SvLENx(sv) SvLEN(sv)
1163 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1164
1165
1166 /* Ask a scalar nicely to try to become an IV, if possible.
1167    Not guaranteed to stay returning void */
1168 /* Macro won't actually call sv_2iv if already IOK */
1169 #define SvIV_please(sv) \
1170         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1171                 (void) SvIV(sv); } STMT_END
1172 #define SvIV_set(sv, val) \
1173         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1174                 assert(SvTYPE(sv) != SVt_PVAV);         \
1175                 assert(SvTYPE(sv) != SVt_PVHV);         \
1176                 assert(SvTYPE(sv) != SVt_PVCV);         \
1177                 assert(!isGV_with_GP(sv));              \
1178                 (((XPVIV*)  SvANY(sv))->xiv_iv = (val)); } STMT_END
1179 #define SvNV_set(sv, val) \
1180         STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1181             assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1182             assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1183                 assert(SvTYPE(sv) != SVt_PVIO);         \
1184                 assert(!isGV_with_GP(sv));              \
1185                 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1186 #define SvPV_set(sv, val) \
1187         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1188                 assert(SvTYPE(sv) != SVt_PVAV);         \
1189                 assert(SvTYPE(sv) != SVt_PVHV);         \
1190                 assert(!isGV_with_GP(sv));              \
1191                 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1192 #define SvUV_set(sv, val) \
1193         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1194                 assert(SvTYPE(sv) != SVt_PVAV);         \
1195                 assert(SvTYPE(sv) != SVt_PVHV);         \
1196                 assert(SvTYPE(sv) != SVt_PVCV);         \
1197                 assert(!isGV_with_GP(sv));              \
1198                 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1199 #define SvRV_set(sv, val) \
1200         STMT_START { assert(SvTYPE(sv) >=  SVt_PV || SvTYPE(sv) ==  SVt_IV); \
1201                 assert(SvTYPE(sv) != SVt_PVAV);         \
1202                 assert(SvTYPE(sv) != SVt_PVHV);         \
1203                 assert(SvTYPE(sv) != SVt_PVCV);         \
1204                 assert(SvTYPE(sv) != SVt_PVFM);         \
1205                 assert(!isGV_with_GP(sv));              \
1206                 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1207 #define SvMAGIC_set(sv, val) \
1208         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1209                 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1210 #define SvSTASH_set(sv, val) \
1211         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1212                 (((XPVMG*)  SvANY(sv))->xmg_stash = (val)); } STMT_END
1213 #define SvCUR_set(sv, val) \
1214         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1215                 assert(SvTYPE(sv) != SVt_PVAV);         \
1216                 assert(SvTYPE(sv) != SVt_PVHV);         \
1217                 assert(!isGV_with_GP(sv));              \
1218                 (((XPV*)  SvANY(sv))->xpv_cur = (val)); } STMT_END
1219 #define SvLEN_set(sv, val) \
1220         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1221                 assert(SvTYPE(sv) != SVt_PVAV); \
1222                 assert(SvTYPE(sv) != SVt_PVHV); \
1223                 assert(!isGV_with_GP(sv));      \
1224                 (((XPV*)  SvANY(sv))->xpv_len = (val)); } STMT_END
1225 #define SvEND_set(sv, val) \
1226         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1227                 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1228
1229 #define SvPV_renew(sv,n) \
1230         STMT_START { SvLEN_set(sv, n); \
1231                 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)                 \
1232                                 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1233                                                    (MEM_SIZE)((n)))));  \
1234                  } STMT_END
1235
1236 #define SvPV_shrink_to_cur(sv) STMT_START { \
1237                    const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1238                    SvPV_renew(sv, _lEnGtH); \
1239                  } STMT_END
1240
1241 #define SvPV_free(sv)                                                   \
1242     STMT_START {                                                        \
1243                      assert(SvTYPE(sv) >= SVt_PV);                      \
1244                      if (SvLEN(sv)) {                                   \
1245                          assert(!SvROK(sv));                            \
1246                          if(SvOOK(sv)) {                                \
1247                              STRLEN zok;                                \
1248                              SvOOK_offset(sv, zok);                     \
1249                              SvPV_set(sv, SvPVX_mutable(sv) - zok);     \
1250                              SvFLAGS(sv) &= ~SVf_OOK;                   \
1251                          }                                              \
1252                          Safefree(SvPVX(sv));                           \
1253                      }                                                  \
1254                  } STMT_END
1255
1256 #ifdef PERL_CORE
1257 /* Code that crops up in three places to take a scalar and ready it to hold
1258    a reference */
1259 #  define prepare_SV_for_RV(sv)                                         \
1260     STMT_START {                                                        \
1261                     if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV)    \
1262                         sv_upgrade(sv, SVt_IV);                         \
1263                     else if (SvTYPE(sv) >= SVt_PV) {                    \
1264                         SvPV_free(sv);                                  \
1265                         SvLEN_set(sv, 0);                               \
1266                         SvCUR_set(sv, 0);                               \
1267                     }                                                   \
1268                  } STMT_END
1269 #endif
1270
1271 #define PERL_FBM_TABLE_OFFSET 1 /* Number of bytes between EOS and table */
1272
1273 /* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1274    perl -T -e '/$^X/'
1275 */
1276 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1277 #  define BmFLAGS(sv)                                                   \
1278         (*({ SV *const _bmflags = MUTABLE_SV(sv);                       \
1279                 assert(SvTYPE(_bmflags) == SVt_PVGV);                   \
1280                 assert(SvVALID(_bmflags));                              \
1281             &(((XPVGV*) SvANY(_bmflags))->xnv_u.xbm_s.xbm_flags);       \
1282          }))
1283 #  define BmRARE(sv)                                                    \
1284         (*({ SV *const _bmrare = MUTABLE_SV(sv);                        \
1285                 assert(SvTYPE(_bmrare) == SVt_PVGV);                    \
1286                 assert(SvVALID(_bmrare));                               \
1287             &(((XPVGV*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare);         \
1288          }))
1289 #  define BmUSEFUL(sv)                                                  \
1290         (*({ SV *const _bmuseful = MUTABLE_SV(sv);                      \
1291             assert(SvTYPE(_bmuseful) == SVt_PVGV);                      \
1292             assert(SvVALID(_bmuseful));                                 \
1293             assert(!SvIOK(_bmuseful));                                  \
1294             &(((XPVGV*) SvANY(_bmuseful))->xiv_u.xivu_i32);             \
1295          }))
1296 #  define BmPREVIOUS(sv)                                                \
1297     (*({ SV *const _bmprevious = MUTABLE_SV(sv);                        \
1298                 assert(SvTYPE(_bmprevious) == SVt_PVGV);                \
1299                 assert(SvVALID(_bmprevious));                           \
1300             &(((XPVGV*) SvANY(_bmprevious))->xnv_u.xbm_s.xbm_previous); \
1301          }))
1302 #else
1303 #  define BmFLAGS(sv)           ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_flags
1304 #  define BmRARE(sv)            ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1305 #  define BmUSEFUL(sv)          ((XPVGV*) SvANY(sv))->xiv_u.xivu_i32
1306 #  define BmPREVIOUS(sv)        ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_previous
1307
1308 #endif
1309
1310 #define FmLINES(sv)     ((XPVFM*)  SvANY(sv))->xiv_u.xivu_iv
1311
1312 #define LvTYPE(sv)      ((XPVLV*)  SvANY(sv))->xlv_type
1313 #define LvTARG(sv)      ((XPVLV*)  SvANY(sv))->xlv_targ
1314 #define LvTARGOFF(sv)   ((XPVLV*)  SvANY(sv))->xlv_targoff
1315 #define LvTARGLEN(sv)   ((XPVLV*)  SvANY(sv))->xlv_targlen
1316
1317 #define IoIFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ifp
1318 #define IoOFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ofp
1319 #define IoDIRP(sv)      ((XPVIO*)  SvANY(sv))->xio_dirp
1320 #define IoANY(sv)       ((XPVIO*)  SvANY(sv))->xio_any
1321 #define IoLINES(sv)     ((XPVIO*)  SvANY(sv))->xio_lines
1322 #define IoPAGE(sv)      ((XPVIO*)  SvANY(sv))->xio_page
1323 #define IoPAGE_LEN(sv)  ((XPVIO*)  SvANY(sv))->xio_page_len
1324 #define IoLINES_LEFT(sv)((XPVIO*)  SvANY(sv))->xio_lines_left
1325 #define IoTOP_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_top_name
1326 #define IoTOP_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_top_gv
1327 #define IoFMT_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_fmt_name
1328 #define IoFMT_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_fmt_gv
1329 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1330 #define IoBOTTOM_GV(sv) ((XPVIO*)  SvANY(sv))->xio_bottom_gv
1331 #define IoTYPE(sv)      ((XPVIO*)  SvANY(sv))->xio_type
1332 #define IoFLAGS(sv)     ((XPVIO*)  SvANY(sv))->xio_flags
1333
1334 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1335 #define IoTYPE_RDONLY           '<'
1336 #define IoTYPE_WRONLY           '>'
1337 #define IoTYPE_RDWR             '+'
1338 #define IoTYPE_APPEND           'a'
1339 #define IoTYPE_PIPE             '|'
1340 #define IoTYPE_STD              '-'     /* stdin or stdout */
1341 #define IoTYPE_SOCKET           's'
1342 #define IoTYPE_CLOSED           ' '
1343 #define IoTYPE_IMPLICIT         'I'     /* stdin or stdout or stderr */
1344 #define IoTYPE_NUMERIC          '#'     /* fdopen */
1345
1346 /*
1347 =for apidoc Am|bool|SvTAINTED|SV* sv
1348 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1349 not.
1350
1351 =for apidoc Am|void|SvTAINTED_on|SV* sv
1352 Marks an SV as tainted if tainting is enabled.
1353
1354 =for apidoc Am|void|SvTAINTED_off|SV* sv
1355 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1356 some of Perl's fundamental security features. XS module authors should not
1357 use this function unless they fully understand all the implications of
1358 unconditionally untainting the value. Untainting should be done in the
1359 standard perl fashion, via a carefully crafted regexp, rather than directly
1360 untainting variables.
1361
1362 =for apidoc Am|void|SvTAINT|SV* sv
1363 Taints an SV if tainting is enabled.
1364
1365 =cut
1366 */
1367
1368 #define sv_taint(sv)      sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1369
1370 #define SvTAINTED(sv)     (SvMAGICAL(sv) && sv_tainted(sv))
1371 #define SvTAINTED_on(sv)  STMT_START{ if(PL_tainting){sv_taint(sv);}   }STMT_END
1372 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1373
1374 #define SvTAINT(sv)                     \
1375     STMT_START {                        \
1376         if (PL_tainting) {              \
1377             if (PL_tainted)             \
1378                 SvTAINTED_on(sv);       \
1379         }                               \
1380     } STMT_END
1381
1382 /*
1383 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1384 Like C<SvPV> but will force the SV into containing just a string
1385 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1386 directly.
1387
1388 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1389 Like C<SvPV> but will force the SV into containing just a string
1390 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1391 directly. Doesn't process magic.
1392
1393 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1394 Returns a pointer to the string in the SV, or a stringified form of
1395 the SV if the SV does not contain a string.  The SV may cache the
1396 stringified version becoming C<SvPOK>.  Handles 'get' magic. See also
1397 C<SvPVx> for a version which guarantees to evaluate sv only once.
1398
1399 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1400 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1401 Only use this if C<sv> is an expression with side effects, otherwise use the
1402 more efficient C<SvPVX>.
1403
1404 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1405 Like C<SvPV> but doesn't process magic.
1406
1407 =for apidoc Am|char*|SvPV_nolen|SV* sv
1408 Returns a pointer to the string in the SV, or a stringified form of
1409 the SV if the SV does not contain a string.  The SV may cache the
1410 stringified form becoming C<SvPOK>.  Handles 'get' magic.
1411
1412 =for apidoc Am|IV|SvIV|SV* sv
1413 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1414 version which guarantees to evaluate sv only once.
1415
1416 =for apidoc Am|IV|SvIV_nomg|SV* sv
1417 Like C<SvIV> but doesn't process magic.
1418
1419 =for apidoc Am|IV|SvIVx|SV* sv
1420 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1421 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1422 otherwise use the more efficient C<SvIV>.
1423
1424 =for apidoc Am|NV|SvNV|SV* sv
1425 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1426 which guarantees to evaluate sv only once.
1427
1428 =for apidoc Am|NV|SvNVx|SV* sv
1429 Coerces the given SV to a double and returns it. Guarantees to evaluate
1430 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1431 otherwise use the more efficient C<SvNV>.
1432
1433 =for apidoc Am|UV|SvUV|SV* sv
1434 Coerces the given SV to an unsigned integer and returns it.  See C<SvUVx>
1435 for a version which guarantees to evaluate sv only once.
1436
1437 =for apidoc Am|UV|SvUV_nomg|SV* sv
1438 Like C<SvUV> but doesn't process magic.
1439
1440 =for apidoc Am|UV|SvUVx|SV* sv
1441 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1442 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1443 otherwise use the more efficient C<SvUV>.
1444
1445 =for apidoc Am|bool|SvTRUE|SV* sv
1446 Returns a boolean indicating whether Perl would evaluate the SV as true or
1447 false.  See SvOK() for a defined/undefined test.  Does not handle 'get' magic.
1448
1449 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1450 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1451
1452 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1453 Like C<SvPV>, but converts sv to utf8 first if necessary.
1454
1455 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1456 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1457
1458 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1459 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1460
1461 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1462 Like C<SvPV>, but converts sv to byte representation first if necessary.
1463
1464 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1465 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1466
1467 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1468 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1469 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1470 otherwise.
1471
1472 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1473 Like C<SvPV>, but converts sv to utf8 first if necessary.
1474 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1475 otherwise.
1476
1477 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1478 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1479 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1480 otherwise.
1481
1482 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1483 Like C<SvPV>, but converts sv to byte representation first if necessary.
1484 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1485 otherwise.
1486
1487 =for apidoc Am|bool|SvIsCOW|SV* sv
1488 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1489 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1490 COW)
1491
1492 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1493 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1494 scalar.
1495
1496 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1497 Like C<sv_catpvn> but doesn't process magic.
1498
1499 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1500 Like C<sv_setsv> but doesn't process magic.
1501
1502 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1503 Like C<sv_catsv> but doesn't process magic.
1504
1505 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1506
1507 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
1508
1509 =cut
1510 */
1511
1512 /* Let us hope that bitmaps for UV and IV are the same */
1513 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1514 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1515 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1516
1517 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1518 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1519
1520 /* ----*/
1521
1522 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1523 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1524 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1525
1526 #define SvPV_flags(sv, lp, flags) \
1527     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1528      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1529 #define SvPV_flags_const(sv, lp, flags) \
1530     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1531      ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1532      (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1533 #define SvPV_flags_const_nolen(sv, flags) \
1534     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1535      ? SvPVX_const(sv) : \
1536      (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1537 #define SvPV_flags_mutable(sv, lp, flags) \
1538     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1539      ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1540      sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1541
1542 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1543 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1544 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1545
1546 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1547 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1548
1549 #define SvPV_force_flags(sv, lp, flags) \
1550     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1551     ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1552 #define SvPV_force_flags_nolen(sv, flags) \
1553     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1554     ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1555 #define SvPV_force_flags_mutable(sv, lp, flags) \
1556     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1557     ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1558      : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1559
1560 #define SvPV_nolen(sv) \
1561     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1562      ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1563
1564 #define SvPV_nolen_const(sv) \
1565     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1566      ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1567
1568 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1569 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1570 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1571
1572 /* ----*/
1573
1574 #define SvPVutf8(sv, lp) \
1575     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1576      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1577
1578 #define SvPVutf8_force(sv, lp) \
1579     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1580      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1581
1582
1583 #define SvPVutf8_nolen(sv) \
1584     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1585      ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1586
1587 /* ----*/
1588
1589 #define SvPVbyte(sv, lp) \
1590     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1591      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1592
1593 #define SvPVbyte_force(sv, lp) \
1594     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1595      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1596
1597 #define SvPVbyte_nolen(sv) \
1598     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1599      ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1600
1601
1602     
1603 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1604  * var to evaluate the arg once; failing that, use a global if possible;
1605  * failing that, call a function to do the work
1606  */
1607
1608 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1609 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1610 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1611
1612 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1613
1614 #  define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1615 #  define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1616 #  define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1617 #  define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1618 #  define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1619 #  define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1620 #  define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1621 #  define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1622 #  define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1623 #  define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1624 #  define SvTRUE(sv) (                                          \
1625     !sv                                                         \
1626     ? 0                                                         \
1627     :    SvPOK(sv)                                              \
1628         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
1629              nxpv &&                                            \
1630              (nxpv->xpv_cur > 1 ||                              \
1631               (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1632              ? 1                                                \
1633              : 0)                                               \
1634         :                                                       \
1635             SvIOK(sv)                                           \
1636             ? SvIVX(sv) != 0                                    \
1637             :   SvNOK(sv)                                       \
1638                 ? SvNVX(sv) != 0.0                              \
1639                 : sv_2bool(sv) )
1640 #  define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1641
1642 #else /* __GNUC__ */
1643
1644 /* These inlined macros use globals, which will require a thread
1645  * declaration in user code, so we avoid them under threads */
1646
1647 #  define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1648 #  define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1649 #  define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1650 #  define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1651 #  define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1652 #  define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1653 #  define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1654 #  define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1655 #  define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1656 #  define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1657 #  define SvTRUE(sv) (                                          \
1658     !sv                                                         \
1659     ? 0                                                         \
1660     :    SvPOK(sv)                                              \
1661         ?   ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) &&            \
1662              (PL_Xpv->xpv_cur > 1 ||                            \
1663               (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0'))  \
1664              ? 1                                                \
1665              : 0)                                               \
1666         :                                                       \
1667             SvIOK(sv)                                           \
1668             ? SvIVX(sv) != 0                                    \
1669             :   SvNOK(sv)                                       \
1670                 ? SvNVX(sv) != 0.0                              \
1671                 : sv_2bool(sv) )
1672 #  define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1673 #endif /* __GNU__ */
1674
1675 #define SvIsCOW(sv)             ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1676                                     (SVf_FAKE | SVf_READONLY))
1677 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1678
1679 #define SvSHARED_HEK_FROM_PV(pvx) \
1680         ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1681 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1682
1683 /* flag values for sv_*_flags functions */
1684 #define SV_IMMEDIATE_UNREF      1
1685 #define SV_GMAGIC               2
1686 #define SV_COW_DROP_PV          4
1687 #define SV_UTF8_NO_ENCODING     8
1688 #define SV_NOSTEAL              16
1689 #define SV_CONST_RETURN         32
1690 #define SV_MUTABLE_RETURN       64
1691 #define SV_SMAGIC               128
1692 #define SV_HAS_TRAILING_NUL     256
1693 #define SV_COW_SHARED_HASH_KEYS 512
1694 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1695 #define SV_COW_OTHER_PVS        1024
1696 /* Make sv_2pv_flags return NULL if something is undefined.  */
1697 #define SV_UNDEF_RETURNS_NULL   2048
1698 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1699  * This is used when the caller has already determined it is, and avoids
1700  * redundant work */
1701 #define SV_FORCE_UTF8_UPGRADE   4096
1702
1703 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1704    So only default to doing the COW setup if we're in the core.
1705  */
1706 #ifdef PERL_CORE
1707 #  ifndef SV_DO_COW_SVSETSV
1708 #    define SV_DO_COW_SVSETSV   SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1709 #  endif
1710 #endif
1711
1712 #ifndef SV_DO_COW_SVSETSV
1713 #  define SV_DO_COW_SVSETSV     0
1714 #endif
1715
1716
1717 #define sv_unref(sv)            sv_unref_flags(sv, 0)
1718 #define sv_force_normal(sv)     sv_force_normal_flags(sv, 0)
1719 #define sv_usepvn(sv, p, l)     sv_usepvn_flags(sv, p, l, 0)
1720 #define sv_usepvn_mg(sv, p, l)  sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1721
1722 /* We are about to replace the SV's current value. So if it's copy on write
1723    we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1724    the value is about to get thrown away, so drop the PV rather than go to
1725    the effort of making a read-write copy only for it to get immediately
1726    discarded.  */
1727
1728 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1729                                     sv_force_normal_flags(sv, SV_COW_DROP_PV)
1730
1731 #ifdef PERL_OLD_COPY_ON_WRITE
1732 #define SvRELEASE_IVX(sv)   \
1733     ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1734 #  define SvIsCOW_normal(sv)    (SvIsCOW(sv) && SvLEN(sv))
1735 #  define SvRELEASE_IVX_(sv)    SvRELEASE_IVX(sv),
1736 #else
1737 #  define SvRELEASE_IVX(sv)   0
1738 /* This little game brought to you by the need to shut this warning up:
1739 mg.c: In function `Perl_magic_get':
1740 mg.c:1024: warning: left-hand operand of comma expression has no effect
1741 */
1742 #  define SvRELEASE_IVX_(sv)  /**/
1743 #endif /* PERL_OLD_COPY_ON_WRITE */
1744
1745 #define CAN_COW_MASK    (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1746                          SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1747                          SVf_OOK|SVf_BREAK|SVf_READONLY)
1748 #define CAN_COW_FLAGS   (SVp_POK|SVf_POK)
1749
1750 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1751                                     sv_force_normal_flags(sv, 0)
1752
1753
1754 /* all these 'functions' are now just macros */
1755
1756 #define sv_pv(sv) SvPV_nolen(sv)
1757 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1758 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1759
1760 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1761 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 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 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2006
2007 /*
2008  * Local variables:
2009  * c-indentation-style: bsd
2010  * c-basic-offset: 4
2011  * indent-tabs-mode: t
2012  * End:
2013  *
2014  * ex: set ts=8 sts=4 sw=4 noet:
2015  */