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