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