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