Update IPC-Cmd to CPAN version 0.76
[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 };
444
445 struct xpv {
446     _XPV_HEAD;
447 };
448
449 struct xpviv {
450     _XPV_HEAD;
451     union _xivu xiv_u;
452 };
453
454 #define xiv_iv xiv_u.xivu_iv
455
456 struct xpvuv {
457     _XPV_HEAD;
458     union _xivu xuv_u;
459 };
460
461 #define xuv_uv xuv_u.xivu_uv
462
463 struct xpvnv {
464     _XPV_HEAD;
465     union _xivu xiv_u;
466     union _xnvu xnv_u;
467 };
468
469 /* This structure must match the beginning of struct xpvhv in hv.h. */
470 struct xpvmg {
471     _XPV_HEAD;
472     union _xivu xiv_u;
473     union _xnvu xnv_u;
474 };
475
476 struct xpvlv {
477     _XPV_HEAD;
478     union _xivu xiv_u;
479     union _xnvu xnv_u;
480     STRLEN      xlv_targoff;
481     STRLEN      xlv_targlen;
482     SV*         xlv_targ;
483     char        xlv_type;       /* k=keys .=pos x=substr v=vec /=join/re
484                                  * y=alem/helem/iter t=tie T=tied HE */
485     char        xlv_flags;      /* 1 = negative offset  2 = negative len */
486 };
487
488 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
489    Boyer-Moore.  */
490 struct xpvgv {
491     _XPV_HEAD;
492     union _xivu xiv_u;
493     union _xnvu xnv_u;
494 };
495
496 /* This structure must match XPVCV in cv.h */
497
498 typedef U16 cv_flags_t;
499
500 #define _XPVCV_COMMON                                                           \
501     HV *        xcv_stash;                                                      \
502     union {                                                                     \
503         OP *    xcv_start;                                                      \
504         ANY     xcv_xsubany;                                                    \
505     }           xcv_start_u;                                                    \
506     union {                                                                     \
507         OP *    xcv_root;                                                       \
508         void    (*xcv_xsub) (pTHX_ CV*);                                        \
509     }           xcv_root_u;                                                     \
510     GV *        xcv_gv;                                                         \
511     char *      xcv_file;                                                       \
512     AV *        xcv_padlist;                                                    \
513     CV *        xcv_outside;                                                    \
514     U32         xcv_outside_seq; /* the COP sequence (at the point of our       \
515                                   * compilation) in the lexically enclosing     \
516                                   * sub */                                      \
517     cv_flags_t  xcv_flags
518
519 struct xpvfm {
520     _XPV_HEAD;
521     _XPVCV_COMMON;
522     IV          xfm_lines;
523 };
524
525
526 struct xpvio {
527     _XPV_HEAD;
528     union _xivu xiv_u;
529     /* ifp and ofp are normally the same, but sockets need separate streams */
530     PerlIO *    xio_ofp;
531     /* Cray addresses everything by word boundaries (64 bits) and
532      * code and data pointers cannot be mixed (which is exactly what
533      * Perl_filter_add() tries to do with the dirp), hence the
534      *  following union trick (as suggested by Gurusamy Sarathy).
535      * For further information see Geir Johansen's problem report
536      * titled [ID 20000612.002] Perl problem on Cray system
537      * The any pointer (known as IoANY()) will also be a good place
538      * to hang any IO disciplines to.
539      */
540     union {
541         DIR *   xiou_dirp;      /* for opendir, readdir, etc */
542         void *  xiou_any;       /* for alignment */
543     } xio_dirpu;
544     /* IV xio_lines is now in IVX  $. */
545     IV          xio_page;       /* $% */
546     IV          xio_page_len;   /* $= */
547     IV          xio_lines_left; /* $- */
548     char *      xio_top_name;   /* $^ */
549     GV *        xio_top_gv;     /* $^ */
550     char *      xio_fmt_name;   /* $~ */
551     GV *        xio_fmt_gv;     /* $~ */
552     char *      xio_bottom_name;/* $^B */
553     GV *        xio_bottom_gv;  /* $^B */
554     char        xio_type;
555     U8          xio_flags;
556 };
557
558 #define xio_dirp        xio_dirpu.xiou_dirp
559 #define xio_any         xio_dirpu.xiou_any
560
561 #define IOf_ARGV        1       /* this fp iterates over ARGV */
562 #define IOf_START       2       /* check for null ARGV and substitute '-' */
563 #define IOf_FLUSH       4       /* this fp wants a flush after write op */
564 #define IOf_DIDTOP      8       /* just did top of form */
565 #define IOf_UNTAINT     16      /* consider this fp (and its data) "safe" */
566 #define IOf_NOLINE      32      /* slurped a pseudo-line from empty file */
567 #define IOf_FAKE_DIRP   64      /* xio_dirp is fake (source filters kludge)
568                                    Also, when this is set, SvPVX() is valid */
569
570 /* The following macros define implementation-independent predicates on SVs. */
571
572 /*
573 =for apidoc Am|U32|SvNIOK|SV* sv
574 Returns a U32 value indicating whether the SV contains a number, integer or
575 double.
576
577 =for apidoc Am|U32|SvNIOKp|SV* sv
578 Returns a U32 value indicating whether the SV contains a number, integer or
579 double.  Checks the B<private> setting.  Use C<SvNIOK> instead.
580
581 =for apidoc Am|void|SvNIOK_off|SV* sv
582 Unsets the NV/IV status of an SV.
583
584 =for apidoc Am|U32|SvOK|SV* sv
585 Returns a U32 value indicating whether the value is defined. This is
586 only meaningful for scalars.
587
588 =for apidoc Am|U32|SvIOKp|SV* sv
589 Returns a U32 value indicating whether the SV contains an integer.  Checks
590 the B<private> setting.  Use C<SvIOK> instead.
591
592 =for apidoc Am|U32|SvNOKp|SV* sv
593 Returns a U32 value indicating whether the SV contains a double.  Checks the
594 B<private> setting.  Use C<SvNOK> instead.
595
596 =for apidoc Am|U32|SvPOKp|SV* sv
597 Returns a U32 value indicating whether the SV contains a character string.
598 Checks the B<private> setting.  Use C<SvPOK> instead.
599
600 =for apidoc Am|U32|SvIOK|SV* sv
601 Returns a U32 value indicating whether the SV contains an integer.
602
603 =for apidoc Am|void|SvIOK_on|SV* sv
604 Tells an SV that it is an integer.
605
606 =for apidoc Am|void|SvIOK_off|SV* sv
607 Unsets the IV status of an SV.
608
609 =for apidoc Am|void|SvIOK_only|SV* sv
610 Tells an SV that it is an integer and disables all other OK bits.
611
612 =for apidoc Am|void|SvIOK_only_UV|SV* sv
613 Tells and SV that it is an unsigned integer and disables all other OK bits.
614
615 =for apidoc Am|bool|SvIOK_UV|SV* sv
616 Returns a boolean indicating whether the SV contains an unsigned integer.
617
618 =for apidoc Am|bool|SvUOK|SV* sv
619 Returns a boolean indicating whether the SV contains an unsigned integer.
620
621 =for apidoc Am|bool|SvIOK_notUV|SV* sv
622 Returns a boolean indicating whether the SV contains a signed integer.
623
624 =for apidoc Am|U32|SvNOK|SV* sv
625 Returns a U32 value indicating whether the SV contains a double.
626
627 =for apidoc Am|void|SvNOK_on|SV* sv
628 Tells an SV that it is a double.
629
630 =for apidoc Am|void|SvNOK_off|SV* sv
631 Unsets the NV status of an SV.
632
633 =for apidoc Am|void|SvNOK_only|SV* sv
634 Tells an SV that it is a double and disables all other OK bits.
635
636 =for apidoc Am|U32|SvPOK|SV* sv
637 Returns a U32 value indicating whether the SV contains a character
638 string.
639
640 =for apidoc Am|void|SvPOK_on|SV* sv
641 Tells an SV that it is a string.
642
643 =for apidoc Am|void|SvPOK_off|SV* sv
644 Unsets the PV status of an SV.
645
646 =for apidoc Am|void|SvPOK_only|SV* sv
647 Tells an SV that it is a string and disables all other OK bits.
648 Will also turn off the UTF-8 status.
649
650 =for apidoc Am|bool|SvVOK|SV* sv
651 Returns a boolean indicating whether the SV contains a v-string.
652
653 =for apidoc Am|U32|SvOOK|SV* sv
654 Returns a U32 indicating whether the pointer to the string buffer is offset.
655 This hack is used internally to speed up removal of characters from the
656 beginning of a SvPV.  When SvOOK is true, then the start of the
657 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
658 This offset used to be stored in SvIVX, but is now stored within the spare
659 part of the buffer.
660
661 =for apidoc Am|U32|SvROK|SV* sv
662 Tests if the SV is an RV.
663
664 =for apidoc Am|void|SvROK_on|SV* sv
665 Tells an SV that it is an RV.
666
667 =for apidoc Am|void|SvROK_off|SV* sv
668 Unsets the RV status of an SV.
669
670 =for apidoc Am|SV*|SvRV|SV* sv
671 Dereferences an RV to return the SV.
672
673 =for apidoc Am|IV|SvIVX|SV* sv
674 Returns the raw value in the SV's IV slot, without checks or conversions.
675 Only use when you are sure SvIOK is true.  See also C<SvIV()>.
676
677 =for apidoc Am|UV|SvUVX|SV* sv
678 Returns the raw value in the SV's UV slot, without checks or conversions.
679 Only use when you are sure SvIOK is true.  See also C<SvUV()>.
680
681 =for apidoc Am|NV|SvNVX|SV* sv
682 Returns the raw value in the SV's NV slot, without checks or conversions.
683 Only use when you are sure SvNOK is true.  See also C<SvNV()>.
684
685 =for apidoc Am|char*|SvPVX|SV* sv
686 Returns a pointer to the physical string in the SV.  The SV must contain a
687 string.
688
689 This is also used to store the name of an autoloaded subroutine in an XS
690 AUTOLOAD routine.  See L<perlguts/Autoloading with XSUBs>.
691
692 =for apidoc Am|STRLEN|SvCUR|SV* sv
693 Returns the length of the string which is in the SV.  See C<SvLEN>.
694
695 =for apidoc Am|STRLEN|SvLEN|SV* sv
696 Returns the size of the string buffer in the SV, not including any part
697 attributable to C<SvOOK>.  See C<SvCUR>.
698
699 =for apidoc Am|char*|SvEND|SV* sv
700 Returns a pointer to the spot just after the last character in
701 the string which is in the SV, where there is usually a trailing
702 null (even though Perl scalars do not strictly require it).
703 See C<SvCUR>.  Access the character as *(SvEND(sv)).
704
705 Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
706 unallocated memory.
707
708 =for apidoc Am|HV*|SvSTASH|SV* sv
709 Returns the stash of the SV.
710
711 =for apidoc Am|void|SvIV_set|SV* sv|IV val
712 Set the value of the IV pointer in sv to val.  It is possible to perform
713 the same function of this macro with an lvalue assignment to C<SvIVX>.
714 With future Perls, however, it will be more efficient to use 
715 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
716
717 =for apidoc Am|void|SvNV_set|SV* sv|NV val
718 Set the value of the NV pointer in sv to val.  See C<SvIV_set>.
719
720 =for apidoc Am|void|SvPV_set|SV* sv|char* val
721 Set the value of the PV pointer in sv to val.  See C<SvIV_set>.
722
723 =for apidoc Am|void|SvUV_set|SV* sv|UV val
724 Set the value of the UV pointer in sv to val.  See C<SvIV_set>.
725
726 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
727 Set the value of the RV pointer in sv to val.  See C<SvIV_set>.
728
729 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
730 Set the value of the MAGIC pointer in sv to val.  See C<SvIV_set>.
731
732 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
733 Set the value of the STASH pointer in sv to val.  See C<SvIV_set>.
734
735 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
736 Set the current length of the string which is in the SV.  See C<SvCUR>
737 and C<SvIV_set>.
738
739 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
740 Set the actual length of the string which is in the SV.  See C<SvIV_set>.
741
742 =cut
743 */
744
745 #define SvNIOK(sv)              (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
746 #define SvNIOKp(sv)             (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
747 #define SvNIOK_off(sv)          (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
748                                                   SVp_IOK|SVp_NOK|SVf_IVisUV))
749
750 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
751 #define assert_not_ROK(sv)      ({assert(!SvROK(sv) || !SvRV(sv));}),
752 #define assert_not_glob(sv)     ({assert(!isGV_with_GP(sv));}),
753 #else
754 #define assert_not_ROK(sv)      
755 #define assert_not_glob(sv)     
756 #endif
757
758 #define SvOK(sv)                ((SvTYPE(sv) == SVt_BIND)               \
759                                  ? (SvFLAGS(SvRV(sv)) & SVf_OK)         \
760                                  : (SvFLAGS(sv) & SVf_OK))
761 #define SvOK_off(sv)            (assert_not_ROK(sv) assert_not_glob(sv) \
762                                  SvFLAGS(sv) &= ~(SVf_OK|               \
763                                                   SVf_IVisUV|SVf_UTF8), \
764                                                         SvOOK_off(sv))
765 #define SvOK_off_exc_UV(sv)     (assert_not_ROK(sv)                     \
766                                  SvFLAGS(sv) &= ~(SVf_OK|               \
767                                                   SVf_UTF8),            \
768                                                         SvOOK_off(sv))
769
770 #define SvOKp(sv)               (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
771 #define SvIOKp(sv)              (SvFLAGS(sv) & SVp_IOK)
772 #define SvIOKp_on(sv)           (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
773                                     SvFLAGS(sv) |= SVp_IOK)
774 #define SvNOKp(sv)              (SvFLAGS(sv) & SVp_NOK)
775 #define SvNOKp_on(sv)           (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
776 #define SvPOKp(sv)              (SvFLAGS(sv) & SVp_POK)
777 #define SvPOKp_on(sv)           (assert_not_ROK(sv) assert_not_glob(sv) \
778                                  SvFLAGS(sv) |= SVp_POK)
779
780 #define SvIOK(sv)               (SvFLAGS(sv) & SVf_IOK)
781 #define SvIOK_on(sv)            (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
782                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
783 #define SvIOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
784 #define SvIOK_only(sv)          (SvOK_off(sv), \
785                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
786 #define SvIOK_only_UV(sv)       (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
787                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
788
789 #define SvIOK_UV(sv)            ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
790                                  == (SVf_IOK|SVf_IVisUV))
791 #define SvUOK(sv)               SvIOK_UV(sv)
792 #define SvIOK_notUV(sv)         ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
793                                  == SVf_IOK)
794
795 #define SvIsUV(sv)              (SvFLAGS(sv) & SVf_IVisUV)
796 #define SvIsUV_on(sv)           (SvFLAGS(sv) |= SVf_IVisUV)
797 #define SvIsUV_off(sv)          (SvFLAGS(sv) &= ~SVf_IVisUV)
798
799 #define SvNOK(sv)               (SvFLAGS(sv) & SVf_NOK)
800 #define SvNOK_on(sv)            (assert_not_glob(sv) \
801                                  SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
802 #define SvNOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
803 #define SvNOK_only(sv)          (SvOK_off(sv), \
804                                     SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
805
806 /*
807 =for apidoc Am|U32|SvUTF8|SV* sv
808 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
809 Call this after SvPV() in case any call to string overloading updates the
810 internal flag.
811
812 =for apidoc Am|void|SvUTF8_on|SV *sv
813 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
814 Do not use frivolously.
815
816 =for apidoc Am|void|SvUTF8_off|SV *sv
817 Unsets the UTF-8 status of an SV.
818
819 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
820 Tells an SV that it is a string and disables all other OK bits,
821 and leaves the UTF-8 status as it was.
822
823 =cut
824  */
825
826 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
827 in gv.h: */
828 #define SvUTF8(sv)              (SvFLAGS(sv) & SVf_UTF8)
829 #define SvUTF8_on(sv)           (SvFLAGS(sv) |= (SVf_UTF8))
830 #define SvUTF8_off(sv)          (SvFLAGS(sv) &= ~(SVf_UTF8))
831
832 #define SvPOK(sv)               (SvFLAGS(sv) & SVf_POK)
833 #define SvPOK_on(sv)            (assert_not_ROK(sv) assert_not_glob(sv) \
834                                  SvFLAGS(sv) |= (SVf_POK|SVp_POK))
835 #define SvPOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
836 #define SvPOK_only(sv)          (assert_not_ROK(sv) assert_not_glob(sv) \
837                                  SvFLAGS(sv) &= ~(SVf_OK|               \
838                                                   SVf_IVisUV|SVf_UTF8), \
839                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
840 #define SvPOK_only_UTF8(sv)     (assert_not_ROK(sv) assert_not_glob(sv) \
841                                  SvFLAGS(sv) &= ~(SVf_OK|               \
842                                                   SVf_IVisUV),          \
843                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
844
845 #define SvVOK(sv)               (SvMAGICAL(sv)                          \
846                                  && mg_find(sv,PERL_MAGIC_vstring))
847 /* returns the vstring magic, if any */
848 #define SvVSTRING_mg(sv)        (SvMAGICAL(sv) \
849                                  ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
850
851 #define SvOOK(sv)               (SvFLAGS(sv) & SVf_OOK)
852 #define SvOOK_on(sv)            (SvFLAGS(sv) |= SVf_OOK)
853 #define SvOOK_off(sv)           ((void)(SvOOK(sv) && sv_backoff(sv)))
854
855 #define SvFAKE(sv)              (SvFLAGS(sv) & SVf_FAKE)
856 #define SvFAKE_on(sv)           (SvFLAGS(sv) |= SVf_FAKE)
857 #define SvFAKE_off(sv)          (SvFLAGS(sv) &= ~SVf_FAKE)
858
859 #define SvROK(sv)               (SvFLAGS(sv) & SVf_ROK)
860 #define SvROK_on(sv)            (SvFLAGS(sv) |= SVf_ROK)
861 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~(SVf_ROK))
862
863 #define SvMAGICAL(sv)           (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
864 #define SvMAGICAL_on(sv)        (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
865 #define SvMAGICAL_off(sv)       (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
866
867 #define SvGMAGICAL(sv)          (SvFLAGS(sv) & SVs_GMG)
868 #define SvGMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_GMG)
869 #define SvGMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_GMG)
870
871 #define SvSMAGICAL(sv)          (SvFLAGS(sv) & SVs_SMG)
872 #define SvSMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_SMG)
873 #define SvSMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_SMG)
874
875 #define SvRMAGICAL(sv)          (SvFLAGS(sv) & SVs_RMG)
876 #define SvRMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_RMG)
877 #define SvRMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_RMG)
878
879 #define SvAMAGIC(sv)            (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
880 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
881 #  define SvAMAGIC_on(sv)       ({ SV * const kloink = sv;              \
882                                    assert(SvROK(kloink));               \
883                                    SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
884                                 })
885 #  define SvAMAGIC_off(sv)      ({ SV * const kloink = sv;              \
886                                    if(SvROK(kloink))                    \
887                                         SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
888                                 })
889 #else
890 #  define SvAMAGIC_on(sv)       (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
891 #  define SvAMAGIC_off(sv) \
892         (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
893 #endif
894
895 /*
896 =for apidoc Am|U32|SvGAMAGIC|SV* sv
897
898 Returns true if the SV has get magic or
899 overloading.  If either is true then
900 the scalar is active data, and has the potential to return a new value every
901 time it is accessed.  Hence you must be careful to
902 only read it once per user logical operation and work
903 with that returned value.  If neither is true then
904 the scalar's value cannot change unless written to.
905
906 =cut
907 */
908
909 #define SvGAMAGIC(sv)           (SvGMAGICAL(sv) || SvAMAGIC(sv))
910
911 #define Gv_AMG(stash)           (PL_amagic_generation && Gv_AMupdate(stash, FALSE))
912
913 #define SvWEAKREF(sv)           ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
914                                   == (SVf_ROK|SVprv_WEAKREF))
915 #define SvWEAKREF_on(sv)        (SvFLAGS(sv) |=  (SVf_ROK|SVprv_WEAKREF))
916 #define SvWEAKREF_off(sv)       (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
917
918 #define SvPCS_IMPORTED(sv)      ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
919                                  == (SVf_ROK|SVprv_PCS_IMPORTED))
920 #define SvPCS_IMPORTED_on(sv)   (SvFLAGS(sv) |=  (SVf_ROK|SVprv_PCS_IMPORTED))
921 #define SvPCS_IMPORTED_off(sv)  (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
922
923 #define SvTHINKFIRST(sv)        (SvFLAGS(sv) & SVf_THINKFIRST)
924
925 #define SvPADMY(sv)             (SvFLAGS(sv) & SVs_PADMY)
926 #define SvPADMY_on(sv)          (SvFLAGS(sv) |= SVs_PADMY)
927
928 /* SVs_PADTMP and SVs_PADSTALE share the same bit, mediated by SVs_PADMY */
929
930 #define SvPADTMP(sv)    ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP)) == SVs_PADTMP)
931 #define SvPADSTALE(sv)  ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADSTALE)) \
932                                     == (SVs_PADMY|SVs_PADSTALE))
933
934 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
935 #  define SvPADTMP_on(sv)       ({                      \
936             SV *const _svpad = MUTABLE_SV(sv);          \
937             assert(!(SvFLAGS(_svpad) & SVs_PADMY));     \
938             SvFLAGS(_svpad) |= SVs_PADTMP;              \
939         })
940 #  define SvPADTMP_off(sv)      ({                      \
941             SV *const _svpad = MUTABLE_SV(sv);          \
942             assert(!(SvFLAGS(_svpad) & SVs_PADMY));     \
943             SvFLAGS(_svpad) &= ~SVs_PADTMP;             \
944         })
945 #  define SvPADSTALE_on(sv)     ({                      \
946             SV *const _svpad = MUTABLE_SV(sv);          \
947             assert(SvFLAGS(_svpad) & SVs_PADMY);        \
948             SvFLAGS(_svpad) |= SVs_PADSTALE;            \
949         })
950 #  define SvPADSTALE_off(sv)    ({                      \
951             SV *const _svpad = MUTABLE_SV(sv);          \
952             assert(SvFLAGS(_svpad) & SVs_PADMY);        \
953             SvFLAGS(_svpad) &= ~SVs_PADSTALE;           \
954         })
955 #else
956 #  define SvPADTMP_on(sv)       (SvFLAGS(sv) |= SVs_PADTMP)
957 #  define SvPADTMP_off(sv)      (SvFLAGS(sv) &= ~SVs_PADTMP)
958 #  define SvPADSTALE_on(sv)     (SvFLAGS(sv) |= SVs_PADSTALE)
959 #  define SvPADSTALE_off(sv)    (SvFLAGS(sv) &= ~SVs_PADSTALE)
960 #endif
961
962 #define SvTEMP(sv)              (SvFLAGS(sv) & SVs_TEMP)
963 #define SvTEMP_on(sv)           (SvFLAGS(sv) |= SVs_TEMP)
964 #define SvTEMP_off(sv)          (SvFLAGS(sv) &= ~SVs_TEMP)
965
966 #define SvOBJECT(sv)            (SvFLAGS(sv) & SVs_OBJECT)
967 #define SvOBJECT_on(sv)         (SvFLAGS(sv) |= SVs_OBJECT)
968 #define SvOBJECT_off(sv)        (SvFLAGS(sv) &= ~SVs_OBJECT)
969
970 #define SvREADONLY(sv)          (SvFLAGS(sv) & SVf_READONLY)
971 #define SvREADONLY_on(sv)       (SvFLAGS(sv) |= SVf_READONLY)
972 #define SvREADONLY_off(sv)      (SvFLAGS(sv) &= ~SVf_READONLY)
973
974 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
975 #define SvSCREAM_on(sv)         (SvFLAGS(sv) |= SVp_SCREAM)
976 #define SvSCREAM_off(sv)        (SvFLAGS(sv) &= ~SVp_SCREAM)
977
978 #ifndef PERL_CORE
979 #  define SvCOMPILED(sv)        0
980 #  define SvCOMPILED_on(sv)
981 #  define SvCOMPILED_off(sv)
982 #endif
983
984 #define SvEVALED(sv)            (SvFLAGS(sv) & SVrepl_EVAL)
985 #define SvEVALED_on(sv)         (SvFLAGS(sv) |= SVrepl_EVAL)
986 #define SvEVALED_off(sv)        (SvFLAGS(sv) &= ~SVrepl_EVAL)
987
988 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
989 #  define SvVALID(sv)           ({ const SV *const _svvalid = (const SV*)(sv); \
990                                    if (SvFLAGS(_svvalid) & SVpbm_VALID) \
991                                        assert(!isGV_with_GP(_svvalid)); \
992                                    (SvFLAGS(_svvalid) & SVpbm_VALID);   \
993                                 })
994 #  define SvVALID_on(sv)        ({ SV *const _svvalid = MUTABLE_SV(sv); \
995                                    assert(!isGV_with_GP(_svvalid));     \
996                                    (SvFLAGS(_svvalid) |= SVpbm_VALID);  \
997                                 })
998 #  define SvVALID_off(sv)       ({ SV *const _svvalid = MUTABLE_SV(sv); \
999                                    assert(!isGV_with_GP(_svvalid));     \
1000                                    (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
1001                                 })
1002
1003 #  define SvTAIL(sv)    ({ const SV *const _svtail = (const SV *)(sv);  \
1004                             assert(SvTYPE(_svtail) != SVt_PVAV);                \
1005                             assert(SvTYPE(_svtail) != SVt_PVHV);                \
1006                             (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID))    \
1007                                 == (SVpbm_TAIL|SVpbm_VALID);            \
1008                         })
1009 #else
1010 #  define SvVALID(sv)           (SvFLAGS(sv) & SVpbm_VALID)
1011 #  define SvVALID_on(sv)        (SvFLAGS(sv) |= SVpbm_VALID)
1012 #  define SvVALID_off(sv)       (SvFLAGS(sv) &= ~SVpbm_VALID)
1013 #  define SvTAIL(sv)        ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID))   \
1014                              == (SVpbm_TAIL|SVpbm_VALID))
1015
1016 #endif
1017 #define SvTAIL_on(sv)           (SvFLAGS(sv) |= SVpbm_TAIL)
1018 #define SvTAIL_off(sv)          (SvFLAGS(sv) &= ~SVpbm_TAIL)
1019
1020
1021 #define SvPAD_TYPED(sv) \
1022         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1023
1024 #define SvPAD_OUR(sv)   \
1025         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1026
1027 #define SvPAD_STATE(sv) \
1028         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1029
1030 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1031 #  define SvPAD_TYPED_on(sv)    ({                                      \
1032             SV *const _svpad = MUTABLE_SV(sv);                          \
1033             assert(SvTYPE(_svpad) == SVt_PVMG);                         \
1034             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED);                \
1035         })
1036 #define SvPAD_OUR_on(sv)        ({                                      \
1037             SV *const _svpad = MUTABLE_SV(sv);                          \
1038             assert(SvTYPE(_svpad) == SVt_PVMG);                         \
1039             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR);                  \
1040         })
1041 #define SvPAD_STATE_on(sv)      ({                                      \
1042             SV *const _svpad = MUTABLE_SV(sv);                          \
1043             assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
1044             (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE);                \
1045         })
1046 #else
1047 #  define SvPAD_TYPED_on(sv)    (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1048 #  define SvPAD_OUR_on(sv)      (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1049 #  define SvPAD_STATE_on(sv)    (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1050 #endif
1051
1052 #define SvOURSTASH(sv)  \
1053         (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1054 #define SvOURSTASH_set(sv, st)                                  \
1055         STMT_START {                                            \
1056             assert(SvTYPE(sv) == SVt_PVMG);                     \
1057             ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st;      \
1058         } STMT_END
1059
1060 #define SvRVx(sv) SvRV(sv)
1061
1062 #ifdef PERL_DEBUG_COW
1063 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1064    +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1065 #  define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1066 #  define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1067 #  define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1068 #  define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1069 #  define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1070 /* Don't test the core XS code yet.  */
1071 #  if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1072 #    define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1073 #  else
1074 #  define SvPVX(sv) SvPVX_mutable(sv)
1075 #  endif
1076 #  define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1077 #  define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1078 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1079
1080 #  ifdef DEBUGGING
1081 #    define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic))
1082 #    define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_stash))
1083 #  else
1084 #    define SvMAGIC(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic)
1085 #    define SvSTASH(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_stash)
1086 #  endif
1087 #else
1088 #  define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1089 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1090
1091 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1092 /* These get expanded inside other macros that already use a variable _sv  */
1093 #    define SvPVX(sv)                                                   \
1094         (*({ SV *const _svpvx = MUTABLE_SV(sv);                         \
1095             assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]);      \
1096             assert(!isGV_with_GP(_svpvx));                              \
1097             assert(!(SvTYPE(_svpvx) == SVt_PVIO                         \
1098                      && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP)));           \
1099             &((_svpvx)->sv_u.svu_pv);                                   \
1100          }))
1101 #    define SvCUR(sv)                                                   \
1102         (*({ const SV *const _svcur = (const SV *)(sv);                 \
1103             assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK]);      \
1104             assert(!isGV_with_GP(_svcur));                              \
1105             assert(!(SvTYPE(_svcur) == SVt_PVIO                         \
1106                      && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP)));           \
1107             &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur);            \
1108          }))
1109 #    define SvIVX(sv)                                                   \
1110         (*({ const SV *const _svivx = (const SV *)(sv);                 \
1111             assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]);      \
1112             assert(!isGV_with_GP(_svivx));                              \
1113             &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv);           \
1114          }))
1115 #    define SvUVX(sv)                                                   \
1116         (*({ const SV *const _svuvx = (const SV *)(sv);                 \
1117             assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]);      \
1118             assert(!isGV_with_GP(_svuvx));                              \
1119             &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv);           \
1120          }))
1121 #    define SvNVX(sv)                                                   \
1122         (*({ const SV *const _svnvx = (const SV *)(sv);                 \
1123             assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]);      \
1124             assert(!isGV_with_GP(_svnvx));                              \
1125             &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv);     \
1126          }))
1127 #    define SvRV(sv)                                                    \
1128         (*({ SV *const _svrv = MUTABLE_SV(sv);                          \
1129             assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]);        \
1130             assert(!isGV_with_GP(_svrv));                               \
1131             assert(!(SvTYPE(_svrv) == SVt_PVIO                          \
1132                      && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP)));            \
1133             &((_svrv)->sv_u.svu_rv);                                    \
1134          }))
1135 #    define SvRV_const(sv)                                              \
1136         ({ const SV *const _svrv = (const SV *)(sv);                    \
1137             assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]);        \
1138             assert(!isGV_with_GP(_svrv));                               \
1139             assert(!(SvTYPE(_svrv) == SVt_PVIO                          \
1140                      && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP)));            \
1141             (_svrv)->sv_u.svu_rv;                                       \
1142          })
1143 #    define SvMAGIC(sv)                                                 \
1144         (*({ const SV *const _svmagic = (const SV *)(sv);               \
1145             assert(SvTYPE(_svmagic) >= SVt_PVMG);                       \
1146             if(SvTYPE(_svmagic) == SVt_PVMG)                            \
1147                 assert(!SvPAD_OUR(_svmagic));                           \
1148             &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1149           }))
1150 #    define SvSTASH(sv)                                                 \
1151         (*({ const SV *const _svstash = (const SV *)(sv);               \
1152             assert(SvTYPE(_svstash) >= SVt_PVMG);                       \
1153             &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash);      \
1154           }))
1155 #  else
1156 #    define SvPVX(sv) ((sv)->sv_u.svu_pv)
1157 #    define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1158 #    define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1159 #    define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1160 #    define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1161 #    define SvRV(sv) ((sv)->sv_u.svu_rv)
1162 #    define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1163 #    define SvMAGIC(sv) ((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic
1164 #    define SvSTASH(sv) ((XPVMG*)  SvANY(sv))->xmg_stash
1165 #  endif
1166 #endif
1167
1168 #ifndef PERL_POISON
1169 /* Given that these two are new, there can't be any existing code using them
1170  *  as LVALUEs  */
1171 #  define SvPVX_mutable(sv)     (0 + (sv)->sv_u.svu_pv)
1172 #  define SvPVX_const(sv)       ((const char*)(0 + (sv)->sv_u.svu_pv))
1173 #else
1174 /* Except for the poison code, which uses & to scribble over the pointer after
1175    free() is called.  */
1176 #  define SvPVX_mutable(sv)     ((sv)->sv_u.svu_pv)
1177 #  define SvPVX_const(sv)       ((const char*)((sv)->sv_u.svu_pv))
1178 #endif
1179
1180 #define SvIVXx(sv) SvIVX(sv)
1181 #define SvUVXx(sv) SvUVX(sv)
1182 #define SvNVXx(sv) SvNVX(sv)
1183 #define SvPVXx(sv) SvPVX(sv)
1184 #define SvLENx(sv) SvLEN(sv)
1185 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1186
1187
1188 /* Ask a scalar nicely to try to become an IV, if possible.
1189    Not guaranteed to stay returning void */
1190 /* Macro won't actually call sv_2iv if already IOK */
1191 #define SvIV_please(sv) \
1192         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1193                 (void) SvIV(sv); } STMT_END
1194 #define SvIV_please_nomg(sv) \
1195         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1196                 (void) SvIV_nomg(sv); } STMT_END
1197 #define SvIV_set(sv, val) \
1198         STMT_START { \
1199                 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]);   \
1200                 assert(!isGV_with_GP(sv));              \
1201                 (((XPVIV*)  SvANY(sv))->xiv_iv = (val)); } STMT_END
1202 #define SvNV_set(sv, val) \
1203         STMT_START { \
1204                 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]);   \
1205                 assert(!isGV_with_GP(sv));              \
1206                 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1207 #define SvPV_set(sv, val) \
1208         STMT_START { \
1209                 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]);      \
1210                 assert(!isGV_with_GP(sv));              \
1211                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1212                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1213                 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1214 #define SvUV_set(sv, val) \
1215         STMT_START { \
1216                 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]);   \
1217                 assert(!isGV_with_GP(sv));              \
1218                 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1219 #define SvRV_set(sv, val) \
1220         STMT_START { \
1221                 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]);       \
1222                 assert(!isGV_with_GP(sv));              \
1223                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1224                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1225                 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1226 #define SvMAGIC_set(sv, val) \
1227         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1228                 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1229 #define SvSTASH_set(sv, val) \
1230         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1231                 (((XPVMG*)  SvANY(sv))->xmg_stash = (val)); } STMT_END
1232 #define SvCUR_set(sv, val) \
1233         STMT_START { \
1234                 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]);      \
1235                 assert(!isGV_with_GP(sv));              \
1236                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1237                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1238                 (((XPV*)  SvANY(sv))->xpv_cur = (val)); } STMT_END
1239 #define SvLEN_set(sv, val) \
1240         STMT_START { \
1241                 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]);      \
1242                 assert(!isGV_with_GP(sv));      \
1243                 assert(!(SvTYPE(sv) == SVt_PVIO         \
1244                      && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1245                 (((XPV*)  SvANY(sv))->xpv_len = (val)); } STMT_END
1246 #define SvEND_set(sv, val) \
1247         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1248                 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1249
1250 #define SvPV_renew(sv,n) \
1251         STMT_START { SvLEN_set(sv, n); \
1252                 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)                 \
1253                                 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1254                                                    (MEM_SIZE)((n)))));  \
1255                  } STMT_END
1256
1257 #define SvPV_shrink_to_cur(sv) STMT_START { \
1258                    const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1259                    SvPV_renew(sv, _lEnGtH); \
1260                  } STMT_END
1261
1262 #define SvPV_free(sv)                                                   \
1263     STMT_START {                                                        \
1264                      assert(SvTYPE(sv) >= SVt_PV);                      \
1265                      if (SvLEN(sv)) {                                   \
1266                          assert(!SvROK(sv));                            \
1267                          if(SvOOK(sv)) {                                \
1268                              STRLEN zok;                                \
1269                              SvOOK_offset(sv, zok);                     \
1270                              SvPV_set(sv, SvPVX_mutable(sv) - zok);     \
1271                              SvFLAGS(sv) &= ~SVf_OOK;                   \
1272                          }                                              \
1273                          Safefree(SvPVX(sv));                           \
1274                      }                                                  \
1275                  } STMT_END
1276
1277 #ifdef PERL_CORE
1278 /* Code that crops up in three places to take a scalar and ready it to hold
1279    a reference */
1280 #  define prepare_SV_for_RV(sv)                                         \
1281     STMT_START {                                                        \
1282                     if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV)    \
1283                         sv_upgrade(sv, SVt_IV);                         \
1284                     else if (SvTYPE(sv) >= SVt_PV) {                    \
1285                         SvPV_free(sv);                                  \
1286                         SvLEN_set(sv, 0);                               \
1287                         SvCUR_set(sv, 0);                               \
1288                     }                                                   \
1289                  } STMT_END
1290 #endif
1291
1292 #ifndef PERL_CORE
1293 #  define BmFLAGS(sv)           (SvTAIL(sv) ? FBMcf_TAIL : 0)
1294 #endif
1295
1296 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1297 #  define BmRARE(sv)                                                    \
1298         (*({ SV *const _bmrare = MUTABLE_SV(sv);                        \
1299                 assert(SvTYPE(_bmrare) == SVt_PVMG);                    \
1300                 assert(SvVALID(_bmrare));                               \
1301             &(((XPVMG*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare);         \
1302          }))
1303 #  define BmUSEFUL(sv)                                                  \
1304         (*({ SV *const _bmuseful = MUTABLE_SV(sv);                      \
1305             assert(SvTYPE(_bmuseful) == SVt_PVMG);                      \
1306             assert(SvVALID(_bmuseful));                                 \
1307             assert(!SvIOK(_bmuseful));                                  \
1308             &(((XPVMG*) SvANY(_bmuseful))->xnv_u.xbm_s.xbm_useful);     \
1309          }))
1310 #  define BmPREVIOUS(sv)                                                \
1311     (*({ SV *const _bmprevious = MUTABLE_SV(sv);                        \
1312                 assert(SvTYPE(_bmprevious) == SVt_PVMG);                \
1313                 assert(SvVALID(_bmprevious));                           \
1314             &(((XPVMG*) SvANY(_bmprevious))->xiv_u.xivu_uv);            \
1315          }))
1316 #else
1317 #  define BmRARE(sv)            ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1318 #  define BmUSEFUL(sv)          ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_useful
1319 #  define BmPREVIOUS(sv)        ((XPVMG*) SvANY(sv))->xiv_u.xivu_uv
1320
1321 #endif
1322
1323 #define FmLINES(sv)     ((XPVFM*)  SvANY(sv))->xfm_lines
1324
1325 #define LvTYPE(sv)      ((XPVLV*)  SvANY(sv))->xlv_type
1326 #define LvTARG(sv)      ((XPVLV*)  SvANY(sv))->xlv_targ
1327 #define LvTARGOFF(sv)   ((XPVLV*)  SvANY(sv))->xlv_targoff
1328 #define LvTARGLEN(sv)   ((XPVLV*)  SvANY(sv))->xlv_targlen
1329 #define LvFLAGS(sv)     ((XPVLV*)  SvANY(sv))->xlv_flags
1330
1331 #define IoIFP(sv)       (sv)->sv_u.svu_fp
1332 #define IoOFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ofp
1333 #define IoDIRP(sv)      ((XPVIO*)  SvANY(sv))->xio_dirp
1334 #define IoANY(sv)       ((XPVIO*)  SvANY(sv))->xio_any
1335 #define IoLINES(sv)     ((XPVIO*)  SvANY(sv))->xiv_u.xivu_iv
1336 #define IoPAGE(sv)      ((XPVIO*)  SvANY(sv))->xio_page
1337 #define IoPAGE_LEN(sv)  ((XPVIO*)  SvANY(sv))->xio_page_len
1338 #define IoLINES_LEFT(sv)((XPVIO*)  SvANY(sv))->xio_lines_left
1339 #define IoTOP_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_top_name
1340 #define IoTOP_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_top_gv
1341 #define IoFMT_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_fmt_name
1342 #define IoFMT_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_fmt_gv
1343 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1344 #define IoBOTTOM_GV(sv) ((XPVIO*)  SvANY(sv))->xio_bottom_gv
1345 #define IoTYPE(sv)      ((XPVIO*)  SvANY(sv))->xio_type
1346 #define IoFLAGS(sv)     ((XPVIO*)  SvANY(sv))->xio_flags
1347
1348 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1349 #define IoTYPE_RDONLY           '<'
1350 #define IoTYPE_WRONLY           '>'
1351 #define IoTYPE_RDWR             '+'
1352 #define IoTYPE_APPEND           'a'
1353 #define IoTYPE_PIPE             '|'
1354 #define IoTYPE_STD              '-'     /* stdin or stdout */
1355 #define IoTYPE_SOCKET           's'
1356 #define IoTYPE_CLOSED           ' '
1357 #define IoTYPE_IMPLICIT         'I'     /* stdin or stdout or stderr */
1358 #define IoTYPE_NUMERIC          '#'     /* fdopen */
1359
1360 /*
1361 =for apidoc Am|bool|SvTAINTED|SV* sv
1362 Checks to see if an SV is tainted.  Returns TRUE if it is, FALSE if
1363 not.
1364
1365 =for apidoc Am|void|SvTAINTED_on|SV* sv
1366 Marks an SV as tainted if tainting is enabled.
1367
1368 =for apidoc Am|void|SvTAINTED_off|SV* sv
1369 Untaints an SV.  Be I<very> careful with this routine, as it short-circuits
1370 some of Perl's fundamental security features.  XS module authors should not
1371 use this function unless they fully understand all the implications of
1372 unconditionally untainting the value. Untainting should be done in the
1373 standard perl fashion, via a carefully crafted regexp, rather than directly
1374 untainting variables.
1375
1376 =for apidoc Am|void|SvTAINT|SV* sv
1377 Taints an SV if tainting is enabled, and if some input to the current
1378 expression is tainted--usually a variable, but possibly also implicit
1379 inputs such as locale settings.  C<SvTAINT> propagates that taintedness to
1380 the outputs of an expression in a pessimistic fashion; i.e., without paying
1381 attention to precisely which outputs are influenced by which inputs.
1382
1383 =cut
1384 */
1385
1386 #define sv_taint(sv)      sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1387
1388 #define SvTAINTED(sv)     (SvMAGICAL(sv) && sv_tainted(sv))
1389 #define SvTAINTED_on(sv)  STMT_START{ if(PL_tainting){sv_taint(sv);}   }STMT_END
1390 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1391
1392 #define SvTAINT(sv)                     \
1393     STMT_START {                        \
1394         if (PL_tainting) {              \
1395             if (PL_tainted)             \
1396                 SvTAINTED_on(sv);       \
1397         }                               \
1398     } STMT_END
1399
1400 /*
1401 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1402 Like C<SvPV> but will force the SV into containing just a string
1403 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1404 directly.
1405
1406 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1407 Like C<SvPV> but will force the SV into containing just a string
1408 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1409 directly.  Doesn't process magic.
1410
1411 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1412 Returns a pointer to the string in the SV, or a stringified form of
1413 the SV if the SV does not contain a string.  The SV may cache the
1414 stringified version becoming C<SvPOK>.  Handles 'get' magic.  See also
1415 C<SvPVx> for a version which guarantees to evaluate sv only once.
1416
1417 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1418 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1419 Only use this if C<sv> is an expression with side effects, otherwise use the
1420 more efficient C<SvPV>.
1421
1422 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1423 Like C<SvPV> but doesn't process magic.
1424
1425 =for apidoc Am|char*|SvPV_nolen|SV* sv
1426 Returns a pointer to the string in the SV, or a stringified form of
1427 the SV if the SV does not contain a string.  The SV may cache the
1428 stringified form becoming C<SvPOK>.  Handles 'get' magic.
1429
1430 =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1431 Like C<SvPV_nolen> but doesn't process magic.
1432
1433 =for apidoc Am|IV|SvIV|SV* sv
1434 Coerces the given SV to an integer and returns it.  See C<SvIVx> for a
1435 version which guarantees to evaluate sv only once.
1436
1437 =for apidoc Am|IV|SvIV_nomg|SV* sv
1438 Like C<SvIV> but doesn't process magic.
1439
1440 =for apidoc Am|IV|SvIVx|SV* sv
1441 Coerces the given SV to an integer and returns it.
1442 Guarantees to evaluate C<sv> only once.  Only use
1443 this if C<sv> is an expression with side effects,
1444 otherwise use the more efficient C<SvIV>.
1445
1446 =for apidoc Am|NV|SvNV|SV* sv
1447 Coerce the given SV to a double and return it.  See C<SvNVx> for a version
1448 which guarantees to evaluate sv only once.
1449
1450 =for apidoc Am|NV|SvNV_nomg|SV* sv
1451 Like C<SvNV> but doesn't process magic.
1452
1453 =for apidoc Am|NV|SvNVx|SV* sv
1454 Coerces the given SV to a double and returns it.
1455 Guarantees to evaluate C<sv> only once.  Only use
1456 this if C<sv> is an expression with side effects,
1457 otherwise use the more efficient C<SvNV>.
1458
1459 =for apidoc Am|UV|SvUV|SV* sv
1460 Coerces the given SV to an unsigned integer and returns it.  See C<SvUVx>
1461 for a version which guarantees to evaluate sv only once.
1462
1463 =for apidoc Am|UV|SvUV_nomg|SV* sv
1464 Like C<SvUV> but doesn't process magic.
1465
1466 =for apidoc Am|UV|SvUVx|SV* sv
1467 Coerces the given SV to an unsigned integer and
1468 returns it.  Guarantees to C<sv> only once.  Only
1469 use this if C<sv> is an expression with side effects,
1470 otherwise use the more efficient C<SvUV>.
1471
1472 =for apidoc Am|bool|SvTRUE|SV* sv
1473 Returns a boolean indicating whether Perl would evaluate the SV as true or
1474 false.  See SvOK() for a defined/undefined test.  Handles 'get' magic
1475 unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
1476 private flags).
1477
1478 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
1479 Returns a boolean indicating whether Perl would evaluate the SV as true or
1480 false.  See SvOK() for a defined/undefined test.  Does not handle 'get' magic.
1481
1482 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1483 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1484
1485 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1486 Like C<SvPV>, but converts sv to utf8 first if necessary.
1487
1488 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1489 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1490
1491 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1492 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1493
1494 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1495 Like C<SvPV>, but converts sv to byte representation first if necessary.
1496
1497 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1498 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1499
1500 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1501 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1502 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1503 otherwise.
1504
1505 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1506 Like C<SvPV>, but converts sv to utf8 first if necessary.
1507 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1508 otherwise.
1509
1510 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1511 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1512 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1513 otherwise.
1514
1515 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1516 Like C<SvPV>, but converts sv to byte representation first if necessary.
1517 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1518 otherwise.
1519
1520 =for apidoc Am|bool|SvIsCOW|SV* sv
1521 Returns a boolean indicating whether the SV is Copy-On-Write (either shared
1522 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1523 COW).
1524
1525 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1526 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1527 scalar.
1528
1529 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1530 Like C<sv_catpvn> but doesn't process magic.
1531
1532 =for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1533 Like C<sv_catpv> but doesn't process magic.
1534
1535 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1536 Like C<sv_setsv> but doesn't process magic.
1537
1538 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1539 Like C<sv_catsv> but doesn't process magic.
1540
1541 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1542
1543 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
1544
1545 =cut
1546 */
1547
1548 /* Let us hope that bitmaps for UV and IV are the same */
1549 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1550 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1551 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1552
1553 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1554 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1555 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1556
1557 /* ----*/
1558
1559 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1560 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1561 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1562
1563 #define SvPV_flags(sv, lp, flags) \
1564     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1565      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1566 #define SvPV_flags_const(sv, lp, flags) \
1567     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1568      ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1569      (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1570 #define SvPV_flags_const_nolen(sv, flags) \
1571     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1572      ? SvPVX_const(sv) : \
1573      (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1574 #define SvPV_flags_mutable(sv, lp, flags) \
1575     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1576      ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1577      sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1578
1579 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1580 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1581 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1582
1583 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1584 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1585
1586 #define SvPV_force_flags(sv, lp, flags) \
1587     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1588     ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1589 #define SvPV_force_flags_nolen(sv, flags) \
1590     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1591     ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1592 #define SvPV_force_flags_mutable(sv, lp, flags) \
1593     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1594     ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1595      : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1596
1597 #define SvPV_nolen(sv) \
1598     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1599      ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1600
1601 #define SvPV_nomg_nolen(sv) \
1602     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1603      ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1604
1605 #define SvPV_nolen_const(sv) \
1606     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1607      ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1608
1609 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1610 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1611 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1612
1613 /* ----*/
1614
1615 #define SvPVutf8(sv, lp) \
1616     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1617      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1618
1619 #define SvPVutf8_force(sv, lp) \
1620     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1621      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1622
1623
1624 #define SvPVutf8_nolen(sv) \
1625     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1626      ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1627
1628 /* ----*/
1629
1630 #define SvPVbyte(sv, lp) \
1631     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1632      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1633
1634 #define SvPVbyte_force(sv, lp) \
1635     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1636      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1637
1638 #define SvPVbyte_nolen(sv) \
1639     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1640      ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1641
1642
1643     
1644 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1645  * var to evaluate the arg once; failing that, use a global if possible;
1646  * failing that, call a function to do the work
1647  */
1648
1649 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1650 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1651 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1652
1653 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1654
1655 #  define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1656 #  define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1657 #  define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1658 #  define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1659 #  define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1660 #  define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1661 #  define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1662 #  define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1663 #  define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1664 #  define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1665 #  define SvTRUE(sv) (                                          \
1666     !sv                                                         \
1667     ? 0                                                         \
1668     :    SvPOK(sv)                                              \
1669         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
1670              nxpv &&                                            \
1671              (nxpv->xpv_cur > 1 ||                              \
1672               (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1673              ? 1                                                \
1674              : 0)                                               \
1675         :                                                       \
1676             SvIOK(sv)                                           \
1677             ? SvIVX(sv) != 0                                    \
1678             :   SvNOK(sv)                                       \
1679                 ? SvNVX(sv) != 0.0                              \
1680                 : sv_2bool(sv) )
1681 #  define SvTRUE_nomg(sv) (                                     \
1682     !sv                                                         \
1683     ? 0                                                         \
1684     :    SvPOK(sv)                                              \
1685         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
1686              nxpv &&                                            \
1687              (nxpv->xpv_cur > 1 ||                              \
1688               (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1689              ? 1                                                \
1690              : 0)                                               \
1691         :                                                       \
1692             SvIOK(sv)                                           \
1693             ? SvIVX(sv) != 0                                    \
1694             :   SvNOK(sv)                                       \
1695                 ? SvNVX(sv) != 0.0                              \
1696                 : sv_2bool_flags(sv,0) )
1697 #  define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1698
1699 #else /* __GNUC__ */
1700
1701 /* These inlined macros use globals, which will require a thread
1702  * declaration in user code, so we avoid them under threads */
1703
1704 #  define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1705 #  define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1706 #  define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1707 #  define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1708 #  define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1709 #  define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1710 #  define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1711 #  define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1712 #  define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1713 #  define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1714 #  define SvTRUE(sv) (                                          \
1715     !sv                                                         \
1716     ? 0                                                         \
1717     :    SvPOK(sv)                                              \
1718         ?   ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) &&            \
1719              (PL_Xpv->xpv_cur > 1 ||                            \
1720               (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0'))  \
1721              ? 1                                                \
1722              : 0)                                               \
1723         :                                                       \
1724             SvIOK(sv)                                           \
1725             ? SvIVX(sv) != 0                                    \
1726             :   SvNOK(sv)                                       \
1727                 ? SvNVX(sv) != 0.0                              \
1728                 : sv_2bool(sv) )
1729 #  define SvTRUE_nomg(sv) (                                     \
1730     !sv                                                         \
1731     ? 0                                                         \
1732     :    SvPOK(sv)                                              \
1733         ?   ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) &&            \
1734              (PL_Xpv->xpv_cur > 1 ||                            \
1735               (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0'))  \
1736              ? 1                                                \
1737              : 0)                                               \
1738         :                                                       \
1739             SvIOK(sv)                                           \
1740             ? SvIVX(sv) != 0                                    \
1741             :   SvNOK(sv)                                       \
1742                 ? SvNVX(sv) != 0.0                              \
1743                 : sv_2bool_flags(sv,0) )
1744 #  define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1745 #endif /* __GNU__ */
1746
1747 #define SvIsCOW(sv)     ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1748                            (SVf_FAKE | SVf_READONLY) && !isGV_with_GP(sv) \
1749                            && SvTYPE(sv) != SVt_REGEXP)
1750 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1751
1752 #define SvSHARED_HEK_FROM_PV(pvx) \
1753         ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1754 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1755
1756 /* flag values for sv_*_flags functions */
1757 #define SV_IMMEDIATE_UNREF      1
1758 #define SV_GMAGIC               2
1759 #define SV_COW_DROP_PV          4
1760 #define SV_UTF8_NO_ENCODING     8
1761 #define SV_NOSTEAL              16
1762 #define SV_CONST_RETURN         32
1763 #define SV_MUTABLE_RETURN       64
1764 #define SV_SMAGIC               128
1765 #define SV_HAS_TRAILING_NUL     256
1766 #define SV_COW_SHARED_HASH_KEYS 512
1767 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1768 #define SV_COW_OTHER_PVS        1024
1769 /* Make sv_2pv_flags return NULL if something is undefined.  */
1770 #define SV_UNDEF_RETURNS_NULL   2048
1771 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1772  * This is used when the caller has already determined it is, and avoids
1773  * redundant work */
1774 #define SV_FORCE_UTF8_UPGRADE   4096
1775 /* if (after resolving magic etc), the SV is found to be overloaded,
1776  * don't call the overload magic, just return as-is */
1777 #define SV_SKIP_OVERLOAD        8192
1778 /* It is not yet clear whether we want this as an API, or what the
1779  * constants should be named. */
1780 #ifdef PERL_CORE
1781 # define SV_CATBYTES            16384
1782 # define SV_CATUTF8             32768
1783 #endif
1784
1785 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1786    So only default to doing the COW setup if we're in the core.
1787  */
1788 #ifdef PERL_CORE
1789 #  ifndef SV_DO_COW_SVSETSV
1790 #    define SV_DO_COW_SVSETSV   SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1791 #  endif
1792 #endif
1793
1794 #ifndef SV_DO_COW_SVSETSV
1795 #  define SV_DO_COW_SVSETSV     0
1796 #endif
1797
1798
1799 #define sv_unref(sv)            sv_unref_flags(sv, 0)
1800 #define sv_force_normal(sv)     sv_force_normal_flags(sv, 0)
1801 #define sv_usepvn(sv, p, l)     sv_usepvn_flags(sv, p, l, 0)
1802 #define sv_usepvn_mg(sv, p, l)  sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1803
1804 /* We are about to replace the SV's current value. So if it's copy on write
1805    we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1806    the value is about to get thrown away, so drop the PV rather than go to
1807    the effort of making a read-write copy only for it to get immediately
1808    discarded.  */
1809
1810 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1811                                     sv_force_normal_flags(sv, SV_COW_DROP_PV)
1812
1813 #ifdef PERL_OLD_COPY_ON_WRITE
1814 #define SvRELEASE_IVX(sv)   \
1815     ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1816 #  define SvIsCOW_normal(sv)    (SvIsCOW(sv) && SvLEN(sv))
1817 #  define SvRELEASE_IVX_(sv)    SvRELEASE_IVX(sv),
1818 #else
1819 #  define SvRELEASE_IVX(sv)   0
1820 /* This little game brought to you by the need to shut this warning up:
1821 mg.c: In function 'Perl_magic_get':
1822 mg.c:1024: warning: left-hand operand of comma expression has no effect
1823 */
1824 #  define SvRELEASE_IVX_(sv)  /**/
1825 #endif /* PERL_OLD_COPY_ON_WRITE */
1826
1827 #define CAN_COW_MASK    (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1828                          SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1829                          SVf_OOK|SVf_BREAK|SVf_READONLY)
1830 #define CAN_COW_FLAGS   (SVp_POK|SVf_POK)
1831
1832 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1833                                     sv_force_normal_flags(sv, 0)
1834
1835
1836 /* all these 'functions' are now just macros */
1837
1838 #define sv_pv(sv) SvPV_nolen(sv)
1839 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1840 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1841
1842 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1843 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1844 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1845 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1846 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
1847 #define sv_setsv(dsv, ssv) \
1848         sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1849 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1850 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1851 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1852 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1853 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1854 #define sv_catpvn_mg(sv, sstr, slen) \
1855         sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1856 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1857 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1858 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1859 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1860 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1861 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1862 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1863 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1864 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1865 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1866 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1867 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1868 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
1869 #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
1870 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
1871 #define sv_insert(bigstr, offset, len, little, littlelen)               \
1872         Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little),  \
1873                              (littlelen), SV_GMAGIC)
1874
1875 /* Should be named SvCatPVN_utf8_upgrade? */
1876 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv)    \
1877         STMT_START {                                    \
1878             if (!(nsv))                                 \
1879                 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP);     \
1880             else                                        \
1881                 sv_setpvn(nsv, sstr, slen);             \
1882             SvUTF8_off(nsv);                            \
1883             sv_utf8_upgrade(nsv);                       \
1884             sv_catsv(dsv, nsv); \
1885         } STMT_END
1886
1887 /*
1888 =for apidoc Am|SV*|newRV_inc|SV* sv
1889
1890 Creates an RV wrapper for an SV.  The reference count for the original SV is
1891 incremented.
1892
1893 =cut
1894 */
1895
1896 #define newRV_inc(sv)   newRV(sv)
1897
1898 /* the following macros update any magic values this sv is associated with */
1899
1900 /*
1901 =head1 Magical Functions
1902
1903 =for apidoc Am|void|SvGETMAGIC|SV* sv
1904 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
1905 argument more than once.
1906
1907 =for apidoc Am|void|SvSETMAGIC|SV* sv
1908 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
1909 argument more than once.
1910
1911 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1912 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
1913 more than once.
1914
1915 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1916 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1917 ssv.  May evaluate arguments more than once.
1918
1919 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1920 Like C<SvSetSV>, but does any set magic required afterwards.
1921
1922 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1923 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1924
1925 =for apidoc Am|void|SvSHARE|SV* sv
1926 Arranges for sv to be shared between threads if a suitable module
1927 has been loaded.
1928
1929 =for apidoc Am|void|SvLOCK|SV* sv
1930 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1931 has been loaded.
1932
1933 =for apidoc Am|void|SvUNLOCK|SV* sv
1934 Releases a mutual exclusion lock on sv if a suitable module
1935 has been loaded.
1936
1937 =head1 SV Manipulation Functions
1938
1939 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1940 Expands the character buffer in the SV so that it has room for the
1941 indicated number of bytes (remember to reserve space for an extra trailing
1942 NUL character).  Calls C<sv_grow> to perform the expansion if necessary.
1943 Returns a pointer to the character buffer.
1944
1945 =cut
1946 */
1947
1948 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
1949 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
1950 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
1951 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
1952
1953 #define SvGETMAGIC(x) ((void)(SvGMAGICAL(x) && mg_get(x)))
1954 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1955
1956 #define SvSetSV_and(dst,src,finally) \
1957         STMT_START {                                    \
1958             if ((dst) != (src)) {                       \
1959                 sv_setsv(dst, src);                     \
1960                 finally;                                \
1961             }                                           \
1962         } STMT_END
1963 #define SvSetSV_nosteal_and(dst,src,finally) \
1964         STMT_START {                                    \
1965             if ((dst) != (src)) {                       \
1966                 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV);   \
1967                 finally;                                \
1968             }                                           \
1969         } STMT_END
1970
1971 #define SvSetSV(dst,src) \
1972                 SvSetSV_and(dst,src,/*nothing*/;)
1973 #define SvSetSV_nosteal(dst,src) \
1974                 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1975
1976 #define SvSetMagicSV(dst,src) \
1977                 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1978 #define SvSetMagicSV_nosteal(dst,src) \
1979                 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1980
1981
1982 #if !defined(SKIP_DEBUGGING)
1983 #define SvPEEK(sv) sv_peek(sv)
1984 #else
1985 #define SvPEEK(sv) ""
1986 #endif
1987
1988 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1989
1990 /*
1991 =for apidoc Am|SV *|boolSV|bool b
1992
1993 Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
1994
1995 See also C<PL_sv_yes> and C<PL_sv_no>.
1996
1997 =cut
1998 */
1999
2000 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2001
2002 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2003 /* If I give every macro argument a different name, then there won't be bugs
2004    where nested macros get confused. Been there, done that.  */
2005 #define isGV_with_GP(pwadak) \
2006         (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP)   \
2007         && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2008 #define isGV_with_GP_on(sv)     STMT_START {                           \
2009         assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2010         assert (!SvPOKp(sv));                                          \
2011         assert (!SvIOKp(sv));                                          \
2012         (SvFLAGS(sv) |= SVpgv_GP);                                     \
2013     } STMT_END
2014 #define isGV_with_GP_off(sv)    STMT_START {                           \
2015         assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2016         assert (!SvPOKp(sv));                                          \
2017         assert (!SvIOKp(sv));                                          \
2018         (SvFLAGS(sv) &= ~SVpgv_GP);                                    \
2019     } STMT_END
2020
2021
2022 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2023 #define SvGROW_mutable(sv,len) \
2024     (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2025 #define Sv_Grow sv_grow
2026
2027 #define CLONEf_COPY_STACKS 1
2028 #define CLONEf_KEEP_PTR_TABLE 2
2029 #define CLONEf_CLONE_HOST 4
2030 #define CLONEf_JOIN_IN 8
2031
2032 struct clone_params {
2033   AV* stashes;
2034   UV  flags;
2035   PerlInterpreter *proto_perl;
2036   PerlInterpreter *new_perl;
2037   AV *unreferenced;
2038 };
2039
2040 /*
2041 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2042
2043 Creates a new SV and copies a string into it.  If utf8 is true, calls
2044 C<SvUTF8_on> on the new SV.  Implemented as a wrapper around C<newSVpvn_flags>.
2045
2046 =cut
2047 */
2048
2049 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2050
2051 /*
2052 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2053
2054 Reads into I<len> the offset from SvPVX back to the true start of the
2055 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2056 efficiently remove characters from start of the buffer.  Implemented as a
2057 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
2058 Evaluates I<sv> more than once.  Sets I<len> to 0 if C<SvOOK(sv)> is false.
2059
2060 =cut
2061 */
2062
2063 #ifdef DEBUGGING
2064 /* Does the bot know something I don't?
2065 10:28 <@Nicholas> metabatman
2066 10:28 <+meta> Nicholas: crash
2067 */
2068 #  define SvOOK_offset(sv, offset) STMT_START {                         \
2069         assert(sizeof(offset) == sizeof(STRLEN));                       \
2070         if (SvOOK(sv)) {                                                \
2071             const U8 *crash = (U8*)SvPVX_const(sv);                     \
2072             offset = *--crash;                                          \
2073             if (!offset) {                                              \
2074                 crash -= sizeof(STRLEN);                                \
2075                 Copy(crash, (U8 *)&offset, sizeof(STRLEN), U8);         \
2076             }                                                           \
2077             {                                                           \
2078                 /* Validate the preceding buffer's sentinels to         \
2079                    verify that no-one is using it.  */                  \
2080                 const U8 *const bonk = (U8 *) SvPVX_const(sv) - offset; \
2081                 while (crash > bonk) {                                  \
2082                     --crash;                                            \
2083                     assert (*crash == (U8)PTR2UV(crash));               \
2084                 }                                                       \
2085             }                                                           \
2086         } else {                                                        \
2087             offset = 0;                                                 \
2088         }                                                               \
2089     } STMT_END
2090 #else
2091     /* This is the same code, but avoids using any temporary variables:  */
2092 #  define SvOOK_offset(sv, offset) STMT_START {                         \
2093         assert(sizeof(offset) == sizeof(STRLEN));                       \
2094         if (SvOOK(sv)) {                                                \
2095             offset = ((U8*)SvPVX_const(sv))[-1];                        \
2096             if (!offset) {                                              \
2097                 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN),              \
2098                      (U8 *)&offset, sizeof(STRLEN), U8);                \
2099             }                                                           \
2100         } else {                                                        \
2101             offset = 0;                                                 \
2102         }                                                               \
2103     } STMT_END
2104 #endif
2105
2106 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2107
2108 /*
2109  * Local variables:
2110  * c-indentation-style: bsd
2111  * c-basic-offset: 4
2112  * indent-tabs-mode: t
2113  * End:
2114  *
2115  * ex: set ts=8 sts=4 sw=4 noet:
2116  */