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