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