3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
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.
12 #undef sv_flags /* Convex has this in <signal.h> for sigvec() */
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.
22 =for apidoc AmU||SVt_PV
23 Pointer type flag for scalars. See C<svtype>.
25 =for apidoc AmU||SVt_IV
26 Integer type flag for scalars. See C<svtype>.
28 =for apidoc AmU||SVt_NV
29 Double type flag for scalars. See C<svtype>.
31 =for apidoc AmU||SVt_PVMG
32 Type flag for blessed scalars. See C<svtype>.
34 =for apidoc AmU||SVt_PVAV
35 Type flag for arrays. See C<svtype>.
37 =for apidoc AmU||SVt_PVHV
38 Type flag for hashes. See C<svtype>.
40 =for apidoc AmU||SVt_PVCV
41 Type flag for code refs. See C<svtype>.
56 /* PVBM was here, before BIND replaced it. */
64 SVt_LAST /* keep last in enum. used to size arrays */
68 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
69 purposes eternal code wanting to consider PVBM probably needs to think of
71 # define SVt_PVBM SVt_PVMG
74 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
75 and SVt_IV, so never reaches the clause at the end that uses
76 sv_type_details->body_size to determine whether to call safefree(). Hence
77 body_size can be set no-zero to record the size of PTEs and HEs, without
78 fear of bogus frees. */
80 #define PTE_SVSLOT SVt_IV
82 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
83 #define HE_SVSLOT SVt_NULL
86 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
88 /* typedefs to eliminate some typing */
90 typedef struct hek HEK;
92 /* Using C's structural equivalence to help emulate C++ inheritance here... */
94 /* start with 2 sv-head building blocks */
95 #define _SV_HEAD(ptrtype) \
96 ptrtype sv_any; /* pointer to body */ \
97 U32 sv_refcnt; /* how many references to us */ \
98 U32 sv_flags /* what we are */
100 #define _SV_HEAD_UNION \
104 SV* svu_rv; /* pointer to another SV */ \
105 char* svu_pv; /* pointer to malloced string */ \
112 struct STRUCT_SV { /* struct sv { */
115 #ifdef DEBUG_LEAKING_SCALARS
116 unsigned sv_debug_optype:9; /* the type of OP that allocated us */
117 unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */
118 unsigned sv_debug_cloned:1; /* was cloned for an ithread */
119 unsigned sv_debug_line:16; /* the line where we were allocated */
120 char * sv_debug_file; /* the file where we were allocated */
125 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
130 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
135 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
140 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
145 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
150 #undef _SV_HEAD_UNION /* ensure no pollution */
153 =head1 SV Manipulation Functions
155 =for apidoc Am|U32|SvREFCNT|SV* sv
156 Returns the value of the object's reference count.
158 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
159 Increments the reference count of the given SV.
161 All of the following SvREFCNT_inc* macros are optimized versions of
162 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
164 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
165 Same as SvREFCNT_inc, but can only be used if you know I<sv>
166 is not NULL. Since we don't have to check the NULLness, it's faster
169 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
170 Same as SvREFCNT_inc, but can only be used if you don't need the
171 return value. The macro doesn't need to return a meaningful value.
173 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
174 Same as SvREFCNT_inc, but can only be used if you don't need the return
175 value, and you know that I<sv> is not NULL. The macro doesn't need
176 to return a meaningful value, or check for NULLness, so it's smaller
179 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
180 Same as SvREFCNT_inc, but can only be used with expressions without side
181 effects. Since we don't have to store a temporary value, it's faster.
183 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
184 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
185 is not NULL. Since we don't have to check the NULLness, it's faster
188 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
189 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
190 return value. The macro doesn't need to return a meaningful value.
192 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
193 Same as SvREFCNT_inc, but can only be used if you don't need the return
194 value, and you know that I<sv> is not NULL. The macro doesn't need
195 to return a meaningful value, or check for NULLness, so it's smaller
198 =for apidoc Am|void|SvREFCNT_dec|SV* sv
199 Decrements the reference count of the given SV.
201 =for apidoc Am|svtype|SvTYPE|SV* sv
202 Returns the type of the SV. See C<svtype>.
204 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
205 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
206 perform the upgrade if necessary. See C<svtype>.
211 #define SvANY(sv) (sv)->sv_any
212 #define SvFLAGS(sv) (sv)->sv_flags
213 #define SvREFCNT(sv) (sv)->sv_refcnt
215 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
216 # define SvREFCNT_inc(sv) \
218 SV * const _sv = (SV*)(sv); \
223 # define SvREFCNT_inc_simple(sv) \
229 # define SvREFCNT_inc_NN(sv) \
231 SV * const _sv = (SV*)(sv); \
235 # define SvREFCNT_inc_void(sv) \
237 SV * const _sv = (SV*)(sv); \
239 (void)(SvREFCNT(_sv)++); \
242 # define SvREFCNT_inc(sv) \
243 ((PL_Sv=(SV*)(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
244 # define SvREFCNT_inc_simple(sv) \
245 ((sv) ? (SvREFCNT(sv)++,(SV*)(sv)) : NULL)
246 # define SvREFCNT_inc_NN(sv) \
247 (PL_Sv=(SV*)(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
248 # define SvREFCNT_inc_void(sv) \
249 (void)((PL_Sv=(SV*)(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
252 /* These guys don't need the curly blocks */
253 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
254 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),(SV*)(sv))
255 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
256 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
258 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
259 # define SvREFCNT_dec(sv) \
261 SV * const _sv = (SV*)(sv); \
263 if (SvREFCNT(_sv)) { \
264 if (--(SvREFCNT(_sv)) == 0) \
265 Perl_sv_free2(aTHX_ _sv); \
272 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
275 #define SVTYPEMASK 0xff
276 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
278 /* Sadly there are some parts of the core that have pointers to already-freed
279 SV heads, and rely on being able to tell that they are now free. So mark
280 them all by using a consistent macro. */
281 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
283 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
285 #define SVf_IOK 0x00000100 /* has valid public integer value */
286 #define SVf_NOK 0x00000200 /* has valid public numeric value */
287 #define SVf_POK 0x00000400 /* has valid public pointer value */
288 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
290 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
291 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
292 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
293 #define SVp_SCREAM 0x00008000 /* has been studied? */
294 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
295 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
296 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
297 subroutine in another package. Set the
298 CvIMPORTED_CV_ON() if it needs to be
299 expanded to a real GV */
301 #define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
302 #define SVpad_STATE 0x00010000 /* pad name is a "state" var */
303 #define SVs_PADTMP 0x00020000 /* in use as tmp */
304 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
305 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
306 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
307 #define SVs_TEMP 0x00080000 /* string is stealable? */
308 #define SVs_OBJECT 0x00100000 /* is "blessed" */
309 #define SVs_GMG 0x00200000 /* has magical get method */
310 #define SVs_SMG 0x00400000 /* has magical set method */
311 #define SVs_RMG 0x00800000 /* has random magical methods */
313 #define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
314 1: SV head arena wasn't malloc()ed
315 2: in conjunction with SVf_READONLY
316 marks a shared hash key scalar
317 (SvLEN == 0) or a copy on write
318 string (SvLEN != 0) [SvIsCOW(sv)]
319 3: For PVCV, whether CvUNIQUE(cv)
320 refers to an eval or once only
321 [CvEVAL(cv), CvSPECIAL(cv)]
322 4: Whether the regexp pointer is in
323 fact an offset [SvREPADTMP(sv)]
324 5: On a pad name SV, that slot in the
325 frame AV is a REFCNT'ed reference
326 to a lexical from "outside". */
327 #define SVphv_REHASH SVf_FAKE /* 6: On a PVHV, hash values are being
329 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
330 means that a hv_aux struct is present
331 after the main array */
332 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
333 SV's in final arena cleanup */
334 #define SVf_READONLY 0x08000000 /* may not be modified */
339 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
341 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
342 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
344 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
346 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
348 /* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
349 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
350 This is also set on RVs whose overloaded
351 stringification is UTF-8. This might
352 only happen as a side effect of SvPV() */
355 /* Some private flags. */
357 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
358 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
359 been restructured, so sometimes get used as string buffers. */
362 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
363 /* PVNV, PVMG, presumably only inside pads */
364 #define SVpad_NAME 0x40000000 /* This SV is a name in the PAD, so
365 SVpad_TYPED, SVpad_OUR and SVpad_STATE
368 #define SVpav_REAL 0x40000000 /* free old entries */
370 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
371 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
372 on any regular scalar (anything <= PVLV) */
373 #define SVpbm_VALID 0x40000000
375 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
377 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
378 /* Presumably IVs aren't stored in pads */
379 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
381 #define SVpav_REIFY 0x80000000 /* can become real */
383 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
385 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
386 /* PVGV when SVpbm_VALID is true */
387 #define SVpbm_TAIL 0x80000000
388 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
389 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
394 NV xnv_nv; /* numeric value, if any */
399 } xpad_cop_seq; /* used by pad.c for cop_sequence */
401 U32 xbm_previous; /* how many characters in string before rare? */
403 U8 xbm_rare; /* rarest character in string */
404 } xbm_s; /* fields from PVBM */
406 STRLEN xpv_cur; /* length of svu_pv as a C string */
407 STRLEN xpv_len; /* allocated size */
411 STRLEN xpv_cur; /* length of svu_pv as a C string */
412 STRLEN xpv_len; /* allocated size */
417 NV xnv_nv; /* numeric value, if any */
422 } xpad_cop_seq; /* used by pad.c for cop_sequence */
424 U32 xbm_previous; /* how many characters in string before rare? */
426 U8 xbm_rare; /* rarest character in string */
427 } xbm_s; /* fields from PVBM */
429 STRLEN xpv_cur; /* length of svu_pv as a C string */
430 STRLEN xpv_len; /* allocated size */
432 IV xivu_iv; /* integer value or pv offset */
441 STRLEN xpv_cur; /* length of svu_pv as a C string */
442 STRLEN xpv_len; /* allocated size */
444 IV xivu_iv; /* integer value or pv offset */
452 #define xiv_iv xiv_u.xivu_iv
456 NV xnv_nv; /* numeric value, if any */
461 } xpad_cop_seq; /* used by pad.c for cop_sequence */
463 U32 xbm_previous; /* how many characters in string before rare? */
465 U8 xbm_rare; /* rarest character in string */
466 } xbm_s; /* fields from PVBM */
468 STRLEN xpv_cur; /* length of svu_pv as a C string */
469 STRLEN xpv_len; /* allocated size */
472 UV xuvu_uv; /* unsigned value or pv offset */
478 #define xuv_uv xuv_u.xuvu_uv
482 NV xnv_nv; /* numeric value, if any */
487 } xpad_cop_seq; /* used by pad.c for cop_sequence */
489 U32 xbm_previous; /* how many characters in string before rare? */
491 U8 xbm_rare; /* rarest character in string */
492 } xbm_s; /* fields from PVBM */
494 STRLEN xpv_cur; /* length of svu_pv as a C string */
495 STRLEN xpv_len; /* allocated size */
497 IV xivu_iv; /* integer value or pv offset */
505 /* These structure must match the beginning of struct xpvhv in hv.h. */
508 NV xnv_nv; /* numeric value, if any */
513 } xpad_cop_seq; /* used by pad.c for cop_sequence */
515 U32 xbm_previous; /* how many characters in string before rare? */
517 U8 xbm_rare; /* rarest character in string */
518 } xbm_s; /* fields from PVBM */
520 STRLEN xpv_cur; /* length of svu_pv as a C string */
521 STRLEN xpv_len; /* allocated size */
523 IV xivu_iv; /* integer value or pv offset */
530 MAGIC* xmg_magic; /* linked list of magicalness */
531 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
533 HV* xmg_stash; /* class package */
538 NV xnv_nv; /* numeric value, if any */
543 } xpad_cop_seq; /* used by pad.c for cop_sequence */
545 U32 xbm_previous; /* how many characters in string before rare? */
547 U8 xbm_rare; /* rarest character in string */
548 } xbm_s; /* fields from PVBM */
550 STRLEN xpv_cur; /* length of svu_pv as a C string */
551 STRLEN xpv_len; /* allocated size */
553 IV xivu_iv; /* integer value or pv offset */
557 HEK * xivu_namehek; /* GvNAME */
560 MAGIC* xmg_magic; /* linked list of magicalness */
561 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
563 HV* xmg_stash; /* class package */
568 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
569 * y=alem/helem/iter t=tie T=tied HE */
572 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
577 HV * xgv_stash; /* The stash of this GV */
581 } xpad_cop_seq; /* used by pad.c for cop_sequence */
583 U32 xbm_previous; /* how many characters in string before rare? */
585 U8 xbm_rare; /* rarest character in string */
586 } xbm_s; /* fields from PVBM */
588 STRLEN xpv_cur; /* xgv_flags */
589 STRLEN xpv_len; /* 0 */
594 I32 xivu_i32; /* is this constant pattern being useful? */
595 HEK * xivu_namehek; /* GvNAME */
598 MAGIC* xmg_magic; /* linked list of magicalness */
599 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
601 HV* xmg_stash; /* class package */
605 /* This structure must match XPVCV in cv.h */
607 typedef U16 cv_flags_t;
611 NV xnv_nv; /* numeric value, if any */
616 } xpad_cop_seq; /* used by pad.c for cop_sequence */
618 U32 xbm_previous; /* how many characters in string before rare? */
620 U8 xbm_rare; /* rarest character in string */
621 } xbm_s; /* fields from PVBM */
623 STRLEN xpv_cur; /* length of svu_pv as a C string */
624 STRLEN xpv_len; /* allocated size */
626 IV xivu_iv; /* PVFMs use the pv offset */
633 MAGIC* xmg_magic; /* linked list of magicalness */
634 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
636 HV* xmg_stash; /* class package */
645 void (*xcv_xsub) (pTHX_ CV*);
651 U32 xcv_outside_seq; /* the COP sequence (at the point of our
652 * compilation) in the lexically enclosing
654 cv_flags_t xcv_flags;
659 STRLEN xpv_cur; /* length of svu_pv as a C string */
660 STRLEN xpv_len; /* allocated size */
662 IV xivu_iv; /* PVFMs use the pv offset */
669 MAGIC* xmg_magic; /* linked list of magicalness */
670 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
672 HV* xmg_stash; /* class package */
681 void (*xcv_xsub) (pTHX_ CV*);
687 U32 xcv_outside_seq; /* the COP sequence (at the point of our
688 * compilation) in the lexically enclosing
690 cv_flags_t xcv_flags;
696 NV xnv_nv; /* numeric value, if any */
701 } xpad_cop_seq; /* used by pad.c for cop_sequence */
703 U32 xbm_previous; /* how many characters in string before rare? */
705 U8 xbm_rare; /* rarest character in string */
706 } xbm_s; /* fields from PVBM */
708 STRLEN xpv_cur; /* length of svu_pv as a C string */
709 STRLEN xpv_len; /* allocated size */
711 IV xivu_iv; /* integer value or pv offset */
718 MAGIC* xmg_magic; /* linked list of magicalness */
719 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
721 HV* xmg_stash; /* class package */
723 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
724 PerlIO * xio_ofp; /* but sockets need separate streams */
725 /* Cray addresses everything by word boundaries (64 bits) and
726 * code and data pointers cannot be mixed (which is exactly what
727 * Perl_filter_add() tries to do with the dirp), hence the following
728 * union trick (as suggested by Gurusamy Sarathy).
729 * For further information see Geir Johansen's problem report titled
730 [ID 20000612.002] Perl problem on Cray system
731 * The any pointer (known as IoANY()) will also be a good place
732 * to hang any IO disciplines to.
735 DIR * xiou_dirp; /* for opendir, readdir, etc */
736 void * xiou_any; /* for alignment */
738 IV xio_lines; /* $. */
739 IV xio_page; /* $% */
740 IV xio_page_len; /* $= */
741 IV xio_lines_left; /* $- */
742 char * xio_top_name; /* $^ */
743 GV * xio_top_gv; /* $^ */
744 char * xio_fmt_name; /* $~ */
745 GV * xio_fmt_gv; /* $~ */
746 char * xio_bottom_name;/* $^B */
747 GV * xio_bottom_gv; /* $^B */
748 short xio_subprocess; /* -| or |- */
752 #define xio_dirp xio_dirpu.xiou_dirp
753 #define xio_any xio_dirpu.xiou_any
755 #define IOf_ARGV 1 /* this fp iterates over ARGV */
756 #define IOf_START 2 /* check for null ARGV and substitute '-' */
757 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
758 #define IOf_DIDTOP 8 /* just did top of form */
759 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
760 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
761 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
763 /* The following macros define implementation-independent predicates on SVs. */
766 =for apidoc Am|U32|SvNIOK|SV* sv
767 Returns a U32 value indicating whether the SV contains a number, integer or
770 =for apidoc Am|U32|SvNIOKp|SV* sv
771 Returns a U32 value indicating whether the SV contains a number, integer or
772 double. Checks the B<private> setting. Use C<SvNIOK>.
774 =for apidoc Am|void|SvNIOK_off|SV* sv
775 Unsets the NV/IV status of an SV.
777 =for apidoc Am|U32|SvOK|SV* sv
778 Returns a U32 value indicating whether the value is an SV. It also tells
779 whether the value is defined or not.
781 =for apidoc Am|U32|SvIOKp|SV* sv
782 Returns a U32 value indicating whether the SV contains an integer. Checks
783 the B<private> setting. Use C<SvIOK>.
785 =for apidoc Am|U32|SvNOKp|SV* sv
786 Returns a U32 value indicating whether the SV contains a double. Checks the
787 B<private> setting. Use C<SvNOK>.
789 =for apidoc Am|U32|SvPOKp|SV* sv
790 Returns a U32 value indicating whether the SV contains a character string.
791 Checks the B<private> setting. Use C<SvPOK>.
793 =for apidoc Am|U32|SvIOK|SV* sv
794 Returns a U32 value indicating whether the SV contains an integer.
796 =for apidoc Am|void|SvIOK_on|SV* sv
797 Tells an SV that it is an integer.
799 =for apidoc Am|void|SvIOK_off|SV* sv
800 Unsets the IV status of an SV.
802 =for apidoc Am|void|SvIOK_only|SV* sv
803 Tells an SV that it is an integer and disables all other OK bits.
805 =for apidoc Am|void|SvIOK_only_UV|SV* sv
806 Tells and SV that it is an unsigned integer and disables all other OK bits.
808 =for apidoc Am|bool|SvIOK_UV|SV* sv
809 Returns a boolean indicating whether the SV contains an unsigned integer.
811 =for apidoc Am|bool|SvUOK|SV* sv
812 Returns a boolean indicating whether the SV contains an unsigned integer.
814 =for apidoc Am|bool|SvIOK_notUV|SV* sv
815 Returns a boolean indicating whether the SV contains a signed integer.
817 =for apidoc Am|U32|SvNOK|SV* sv
818 Returns a U32 value indicating whether the SV contains a double.
820 =for apidoc Am|void|SvNOK_on|SV* sv
821 Tells an SV that it is a double.
823 =for apidoc Am|void|SvNOK_off|SV* sv
824 Unsets the NV status of an SV.
826 =for apidoc Am|void|SvNOK_only|SV* sv
827 Tells an SV that it is a double and disables all other OK bits.
829 =for apidoc Am|U32|SvPOK|SV* sv
830 Returns a U32 value indicating whether the SV contains a character
833 =for apidoc Am|void|SvPOK_on|SV* sv
834 Tells an SV that it is a string.
836 =for apidoc Am|void|SvPOK_off|SV* sv
837 Unsets the PV status of an SV.
839 =for apidoc Am|void|SvPOK_only|SV* sv
840 Tells an SV that it is a string and disables all other OK bits.
841 Will also turn off the UTF-8 status.
843 =for apidoc Am|bool|SvVOK|SV* sv
844 Returns a boolean indicating whether the SV contains a v-string.
846 =for apidoc Am|U32|SvOOK|SV* sv
847 Returns a U32 indicating whether the SvIVX is a valid offset value for
848 the SvPVX. This hack is used internally to speed up removal of characters
849 from the beginning of a SvPV. When SvOOK is true, then the start of the
850 allocated string buffer is really (SvPVX - SvIVX).
852 =for apidoc Am|U32|SvROK|SV* sv
853 Tests if the SV is an RV.
855 =for apidoc Am|void|SvROK_on|SV* sv
856 Tells an SV that it is an RV.
858 =for apidoc Am|void|SvROK_off|SV* sv
859 Unsets the RV status of an SV.
861 =for apidoc Am|SV*|SvRV|SV* sv
862 Dereferences an RV to return the SV.
864 =for apidoc Am|IV|SvIVX|SV* sv
865 Returns the raw value in the SV's IV slot, without checks or conversions.
866 Only use when you are sure SvIOK is true. See also C<SvIV()>.
868 =for apidoc Am|UV|SvUVX|SV* sv
869 Returns the raw value in the SV's UV slot, without checks or conversions.
870 Only use when you are sure SvIOK is true. See also C<SvUV()>.
872 =for apidoc Am|NV|SvNVX|SV* sv
873 Returns the raw value in the SV's NV slot, without checks or conversions.
874 Only use when you are sure SvNOK is true. See also C<SvNV()>.
876 =for apidoc Am|char*|SvPVX|SV* sv
877 Returns a pointer to the physical string in the SV. The SV must contain a
880 =for apidoc Am|STRLEN|SvCUR|SV* sv
881 Returns the length of the string which is in the SV. See C<SvLEN>.
883 =for apidoc Am|STRLEN|SvLEN|SV* sv
884 Returns the size of the string buffer in the SV, not including any part
885 attributable to C<SvOOK>. See C<SvCUR>.
887 =for apidoc Am|char*|SvEND|SV* sv
888 Returns a pointer to the last character in the string which is in the SV.
889 See C<SvCUR>. Access the character as *(SvEND(sv)).
891 =for apidoc Am|HV*|SvSTASH|SV* sv
892 Returns the stash of the SV.
894 =for apidoc Am|void|SvIV_set|SV* sv|IV val
895 Set the value of the IV pointer in sv to val. It is possible to perform
896 the same function of this macro with an lvalue assignment to C<SvIVX>.
897 With future Perls, however, it will be more efficient to use
898 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
900 =for apidoc Am|void|SvNV_set|SV* sv|NV val
901 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
903 =for apidoc Am|void|SvPV_set|SV* sv|char* val
904 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
906 =for apidoc Am|void|SvUV_set|SV* sv|UV val
907 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
909 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
910 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
912 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
913 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
915 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
916 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
918 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
919 Set the current length of the string which is in the SV. See C<SvCUR>
922 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
923 Set the actual length of the string which is in the SV. See C<SvIV_set>.
928 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
929 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
930 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
931 SVp_IOK|SVp_NOK|SVf_IVisUV))
933 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
934 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
935 #define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
937 #define assert_not_ROK(sv)
938 #define assert_not_glob(sv)
941 #define SvOK(sv) ((SvTYPE(sv) == SVt_BIND) \
942 ? (SvFLAGS(SvRV(sv)) & SVf_OK) \
943 : (SvFLAGS(sv) & SVf_OK))
944 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
945 SvFLAGS(sv) &= ~(SVf_OK| \
946 SVf_IVisUV|SVf_UTF8), \
948 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
949 SvFLAGS(sv) &= ~(SVf_OK| \
953 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
954 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
955 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
956 SvFLAGS(sv) |= SVp_IOK)
957 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
958 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
959 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
960 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
961 SvFLAGS(sv) |= SVp_POK)
963 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
964 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
965 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
966 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
967 #define SvIOK_only(sv) (SvOK_off(sv), \
968 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
969 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
970 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
972 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
973 == (SVf_IOK|SVf_IVisUV))
974 #define SvUOK(sv) SvIOK_UV(sv)
975 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
978 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
979 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
980 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
982 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
983 #define SvNOK_on(sv) (assert_not_glob(sv) \
984 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
985 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
986 #define SvNOK_only(sv) (SvOK_off(sv), \
987 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
990 =for apidoc Am|U32|SvUTF8|SV* sv
991 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
992 Call this after SvPV() in case any call to string overloading updates the
995 =for apidoc Am|void|SvUTF8_on|SV *sv
996 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
997 Do not use frivolously.
999 =for apidoc Am|void|SvUTF8_off|SV *sv
1000 Unsets the UTF-8 status of an SV.
1002 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
1003 Tells an SV that it is a string and disables all other OK bits,
1004 and leaves the UTF-8 status as it was.
1009 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
1011 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
1012 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
1013 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
1015 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
1016 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
1017 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
1018 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
1019 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
1020 SvFLAGS(sv) &= ~(SVf_OK| \
1021 SVf_IVisUV|SVf_UTF8), \
1022 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
1023 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
1024 SvFLAGS(sv) &= ~(SVf_OK| \
1026 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
1028 #define SvVOK(sv) (SvMAGICAL(sv) \
1029 && mg_find(sv,PERL_MAGIC_vstring))
1030 /* returns the vstring magic, if any */
1031 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
1032 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
1034 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
1035 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
1036 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
1038 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
1039 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
1040 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
1042 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
1043 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
1044 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
1046 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
1047 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
1048 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
1050 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
1051 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
1052 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
1054 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
1055 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
1056 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
1058 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
1059 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
1060 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
1062 #define SvAMAGIC(sv) (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
1063 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1064 # define SvAMAGIC_on(sv) ({ SV * const kloink = sv; \
1065 assert(SvROK(kloink)); \
1066 SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
1068 # define SvAMAGIC_off(sv) ({ SV * const kloink = sv; \
1070 SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
1073 # define SvAMAGIC_on(sv) (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
1074 # define SvAMAGIC_off(sv) \
1075 (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
1079 =for apidoc Am|char*|SvGAMAGIC|SV* sv
1081 Returns true if the SV has get magic or overloading. If either is true then
1082 the scalar is active data, and has the potential to return a new value every
1083 time it is accessed. Hence you must be careful to only read it once per user
1084 logical operation and work with that returned value. If neither is true then
1085 the scalar's value cannot change unless written to.
1090 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1092 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
1094 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1095 == (SVf_ROK|SVprv_WEAKREF))
1096 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1097 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1099 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
1100 == (SVf_ROK|SVprv_PCS_IMPORTED))
1101 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
1102 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
1104 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1106 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
1107 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
1108 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
1110 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
1111 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1112 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1114 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
1115 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
1117 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1118 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1119 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1121 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1122 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1123 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1125 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
1126 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1127 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1129 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1130 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1131 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1133 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
1134 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
1135 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
1137 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1138 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1139 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1141 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1142 # define SvVALID(sv) ({ SV *const thwacke = (SV *) (sv); \
1143 if (SvFLAGS(thwacke) & SVpbm_VALID) \
1144 assert(!isGV_with_GP(thwacke)); \
1145 (SvFLAGS(thwacke) & SVpbm_VALID); \
1147 # define SvVALID_on(sv) ({ SV *const thwacke = (SV *) (sv); \
1148 assert(!isGV_with_GP(thwacke)); \
1149 (SvFLAGS(thwacke) |= SVpbm_VALID); \
1151 # define SvVALID_off(sv) ({ SV *const thwacke = (SV *) (sv); \
1152 assert(!isGV_with_GP(thwacke)); \
1153 (SvFLAGS(thwacke) &= ~SVpbm_VALID); \
1156 # define SvTAIL(sv) ({ SV *const _svi = (SV *) (sv); \
1157 assert(SvTYPE(_svi) != SVt_PVAV); \
1158 assert(SvTYPE(_svi) != SVt_PVHV); \
1159 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1160 == (SVpbm_TAIL|SVpbm_VALID); \
1163 # define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
1164 # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1165 # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
1166 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1167 == (SVpbm_TAIL|SVpbm_VALID))
1170 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1171 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1175 /* The following uses the FAKE flag to show that a regex pointer is infact
1176 its own offset in the regexpad for ithreads */
1177 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
1178 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
1179 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
1182 #define SvPAD_TYPED(sv) \
1183 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1185 #define SvPAD_OUR(sv) \
1186 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1188 #define SvPAD_STATE(sv) \
1189 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1191 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1192 # define SvPAD_TYPED_on(sv) ({ \
1193 SV *const whap = (SV *) (sv); \
1194 assert(SvTYPE(whap) == SVt_PVMG); \
1195 (SvFLAGS(whap) |= SVpad_NAME|SVpad_TYPED); \
1197 #define SvPAD_OUR_on(sv) ({ \
1198 SV *const whap = (SV *) (sv); \
1199 assert(SvTYPE(whap) == SVt_PVMG); \
1200 (SvFLAGS(whap) |= SVpad_NAME|SVpad_OUR); \
1202 #define SvPAD_STATE_on(sv) ({ \
1203 SV *const whap = (SV *) (sv); \
1204 assert(SvTYPE(whap) == SVt_PVNV || SvTYPE(whap) == SVt_PVMG); \
1205 (SvFLAGS(whap) |= SVpad_NAME|SVpad_STATE); \
1208 # define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1209 # define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1210 # define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1213 #define SvOURSTASH(sv) \
1214 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1215 #define SvOURSTASH_set(sv, st) \
1217 assert(SvTYPE(sv) == SVt_PVMG); \
1218 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1221 #ifdef PERL_DEBUG_COW
1224 #define SvRVx(sv) SvRV(sv)
1226 #ifdef PERL_DEBUG_COW
1227 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1228 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1229 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1230 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1231 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1232 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1233 /* Don't test the core XS code yet. */
1234 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1235 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1237 # define SvPVX(sv) SvPVX_mutable(sv)
1239 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1240 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1241 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1244 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1245 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
1247 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1248 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
1251 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1252 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1254 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1255 /* These get expanded inside other macros that already use a variable _sv */
1256 # define SvPVX(sv) \
1257 (*({ SV *const _svi = (SV *) (sv); \
1258 assert(SvTYPE(_svi) >= SVt_PV); \
1259 assert(SvTYPE(_svi) != SVt_PVAV); \
1260 assert(SvTYPE(_svi) != SVt_PVHV); \
1261 assert(!isGV_with_GP(_svi)); \
1262 &((_svi)->sv_u.svu_pv); \
1264 # define SvCUR(sv) \
1265 (*({ SV *const _svi = (SV *) (sv); \
1266 assert(SvTYPE(_svi) >= SVt_PV); \
1267 assert(SvTYPE(_svi) != SVt_PVAV); \
1268 assert(SvTYPE(_svi) != SVt_PVHV); \
1269 assert(!isGV_with_GP(_svi)); \
1270 &(((XPV*) SvANY(_svi))->xpv_cur); \
1272 # define SvIVX(sv) \
1273 (*({ SV *const _svi = (SV *) (sv); \
1274 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1275 assert(SvTYPE(_svi) != SVt_PVAV); \
1276 assert(SvTYPE(_svi) != SVt_PVHV); \
1277 assert(SvTYPE(_svi) != SVt_PVCV); \
1278 assert(!isGV_with_GP(_svi)); \
1279 &(((XPVIV*) SvANY(_svi))->xiv_iv); \
1281 # define SvUVX(sv) \
1282 (*({ SV *const _svi = (SV *) (sv); \
1283 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1284 assert(SvTYPE(_svi) != SVt_PVAV); \
1285 assert(SvTYPE(_svi) != SVt_PVHV); \
1286 assert(SvTYPE(_svi) != SVt_PVCV); \
1287 assert(!isGV_with_GP(_svi)); \
1288 &(((XPVUV*) SvANY(_svi))->xuv_uv); \
1290 # define SvNVX(sv) \
1291 (*({ SV *const _svi = (SV *) (sv); \
1292 assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \
1293 assert(SvTYPE(_svi) != SVt_PVAV); \
1294 assert(SvTYPE(_svi) != SVt_PVHV); \
1295 assert(SvTYPE(_svi) != SVt_PVCV); \
1296 assert(SvTYPE(_svi) != SVt_PVFM); \
1297 assert(!isGV_with_GP(_svi)); \
1298 &(((XPVNV*) SvANY(_svi))->xnv_u.xnv_nv); \
1301 (*({ SV *const _svi = (SV *) (sv); \
1302 assert(SvTYPE(_svi) >= SVt_RV); \
1303 assert(SvTYPE(_svi) != SVt_PVAV); \
1304 assert(SvTYPE(_svi) != SVt_PVHV); \
1305 assert(SvTYPE(_svi) != SVt_PVCV); \
1306 assert(SvTYPE(_svi) != SVt_PVFM); \
1307 assert(!isGV_with_GP(_svi)); \
1308 &((_svi)->sv_u.svu_rv); \
1310 # define SvMAGIC(sv) \
1311 (*({ SV *const _svi = (SV *) (sv); \
1312 assert(SvTYPE(_svi) >= SVt_PVMG); \
1313 if(SvTYPE(_svi) == SVt_PVMG) \
1314 assert(!SvPAD_OUR(_svi)); \
1315 &(((XPVMG*) SvANY(_svi))->xmg_u.xmg_magic); \
1317 # define SvSTASH(sv) \
1318 (*({ SV *const _svi = (SV *) (sv); \
1319 assert(SvTYPE(_svi) >= SVt_PVMG); \
1320 &(((XPVMG*) SvANY(_svi))->xmg_stash); \
1323 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1324 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1325 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1326 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1327 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1328 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1329 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1330 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1335 /* Given that these two are new, there can't be any existing code using them
1337 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1338 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1340 /* Except for the poison code, which uses & to scribble over the pointer after
1341 free() is called. */
1342 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1343 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1346 #define SvIVXx(sv) SvIVX(sv)
1347 #define SvUVXx(sv) SvUVX(sv)
1348 #define SvNVXx(sv) SvNVX(sv)
1349 #define SvPVXx(sv) SvPVX(sv)
1350 #define SvLENx(sv) SvLEN(sv)
1351 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1354 /* Ask a scalar nicely to try to become an IV, if possible.
1355 Not guaranteed to stay returning void */
1356 /* Macro won't actually call sv_2iv if already IOK */
1357 #define SvIV_please(sv) \
1358 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1359 (void) SvIV(sv); } STMT_END
1360 #define SvIV_set(sv, val) \
1361 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1362 assert(SvTYPE(sv) != SVt_PVAV); \
1363 assert(SvTYPE(sv) != SVt_PVHV); \
1364 assert(SvTYPE(sv) != SVt_PVCV); \
1365 assert(!isGV_with_GP(sv)); \
1366 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1367 #define SvNV_set(sv, val) \
1368 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1369 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1370 assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1371 assert(!isGV_with_GP(sv)); \
1372 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1373 #define SvPV_set(sv, val) \
1374 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1375 assert(SvTYPE(sv) != SVt_PVAV); \
1376 assert(SvTYPE(sv) != SVt_PVHV); \
1377 assert(!isGV_with_GP(sv)); \
1378 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1379 #define SvUV_set(sv, val) \
1380 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1381 assert(SvTYPE(sv) != SVt_PVAV); \
1382 assert(SvTYPE(sv) != SVt_PVHV); \
1383 assert(SvTYPE(sv) != SVt_PVCV); \
1384 assert(!isGV_with_GP(sv)); \
1385 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1386 #define SvRV_set(sv, val) \
1387 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
1388 assert(SvTYPE(sv) != SVt_PVAV); \
1389 assert(SvTYPE(sv) != SVt_PVHV); \
1390 assert(SvTYPE(sv) != SVt_PVCV); \
1391 assert(SvTYPE(sv) != SVt_PVFM); \
1392 assert(!isGV_with_GP(sv)); \
1393 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1394 #define SvMAGIC_set(sv, val) \
1395 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1396 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1397 #define SvSTASH_set(sv, val) \
1398 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1399 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1400 #define SvCUR_set(sv, val) \
1401 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1402 assert(SvTYPE(sv) != SVt_PVAV); \
1403 assert(SvTYPE(sv) != SVt_PVHV); \
1404 assert(!isGV_with_GP(sv)); \
1405 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1406 #define SvLEN_set(sv, val) \
1407 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1408 assert(SvTYPE(sv) != SVt_PVAV); \
1409 assert(SvTYPE(sv) != SVt_PVHV); \
1410 assert(!isGV_with_GP(sv)); \
1411 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1412 #define SvEND_set(sv, val) \
1413 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1414 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
1416 #define SvPV_renew(sv,n) \
1417 STMT_START { SvLEN_set(sv, n); \
1418 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1419 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1420 (MEM_SIZE)((n))))); \
1423 #define SvPV_shrink_to_cur(sv) STMT_START { \
1424 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1425 SvPV_renew(sv, _lEnGtH); \
1428 #define SvPV_free(sv) \
1430 assert(SvTYPE(sv) >= SVt_PV); \
1433 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \
1434 SvFLAGS(sv) &= ~SVf_OOK; \
1436 Safefree(SvPVX(sv)); \
1441 #define PERL_FBM_TABLE_OFFSET 1 /* Number of bytes between EOS and table */
1443 /* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1446 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1447 # define BmFLAGS(sv) \
1448 (*({ SV *const uggh = (SV *) (sv); \
1449 assert(SvTYPE(uggh) == SVt_PVGV); \
1450 assert(SvVALID(uggh)); \
1451 &(((XPVGV*) SvANY(uggh))->xnv_u.xbm_s.xbm_flags); \
1453 # define BmRARE(sv) \
1454 (*({ SV *const uggh = (SV *) (sv); \
1455 assert(SvTYPE(uggh) == SVt_PVGV); \
1456 assert(SvVALID(uggh)); \
1457 &(((XPVGV*) SvANY(uggh))->xnv_u.xbm_s.xbm_rare); \
1459 # define BmUSEFUL(sv) \
1460 (*({ SV *const uggh = (SV *) (sv); \
1461 assert(SvTYPE(uggh) == SVt_PVGV); \
1462 assert(SvVALID(uggh)); \
1463 assert(!SvIOK(uggh)); \
1464 &(((XPVGV*) SvANY(uggh))->xiv_u.xivu_i32); \
1466 # define BmPREVIOUS(sv) \
1467 (*({ SV *const uggh = (SV *) (sv); \
1468 assert(SvTYPE(uggh) == SVt_PVGV); \
1469 assert(SvVALID(uggh)); \
1470 &(((XPVGV*) SvANY(uggh))->xnv_u.xbm_s.xbm_previous); \
1473 # define BmFLAGS(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_flags
1474 # define BmRARE(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1475 # define BmUSEFUL(sv) ((XPVGV*) SvANY(sv))->xiv_u.xivu_i32
1476 # define BmPREVIOUS(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_previous
1480 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1482 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1483 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1484 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1485 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1487 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1488 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1489 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1490 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1491 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1492 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1493 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1494 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1495 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1496 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1497 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1498 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1499 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1500 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1501 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
1502 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1503 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1505 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1506 #define IoTYPE_RDONLY '<'
1507 #define IoTYPE_WRONLY '>'
1508 #define IoTYPE_RDWR '+'
1509 #define IoTYPE_APPEND 'a'
1510 #define IoTYPE_PIPE '|'
1511 #define IoTYPE_STD '-' /* stdin or stdout */
1512 #define IoTYPE_SOCKET 's'
1513 #define IoTYPE_CLOSED ' '
1514 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1515 #define IoTYPE_NUMERIC '#' /* fdopen */
1518 =for apidoc Am|bool|SvTAINTED|SV* sv
1519 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1522 =for apidoc Am|void|SvTAINTED_on|SV* sv
1523 Marks an SV as tainted if tainting is enabled.
1525 =for apidoc Am|void|SvTAINTED_off|SV* sv
1526 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1527 some of Perl's fundamental security features. XS module authors should not
1528 use this function unless they fully understand all the implications of
1529 unconditionally untainting the value. Untainting should be done in the
1530 standard perl fashion, via a carefully crafted regexp, rather than directly
1531 untainting variables.
1533 =for apidoc Am|void|SvTAINT|SV* sv
1534 Taints an SV if tainting is enabled.
1539 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1541 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1542 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1543 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1545 #define SvTAINT(sv) \
1547 if (PL_tainting) { \
1554 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1555 Like C<SvPV> but will force the SV into containing just a string
1556 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1559 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1560 Like C<SvPV> but will force the SV into containing just a string
1561 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1562 directly. Doesn't process magic.
1564 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1565 Returns a pointer to the string in the SV, or a stringified form of
1566 the SV if the SV does not contain a string. The SV may cache the
1567 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1568 C<SvPVx> for a version which guarantees to evaluate sv only once.
1570 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1571 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1572 Only use this if C<sv> is an expression with side effects, otherwise use the
1573 more efficient C<SvPVX>.
1575 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1576 Like C<SvPV> but doesn't process magic.
1578 =for apidoc Am|char*|SvPV_nolen|SV* sv
1579 Returns a pointer to the string in the SV, or a stringified form of
1580 the SV if the SV does not contain a string. The SV may cache the
1581 stringified form becoming C<SvPOK>. Handles 'get' magic.
1583 =for apidoc Am|IV|SvIV|SV* sv
1584 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1585 version which guarantees to evaluate sv only once.
1587 =for apidoc Am|IV|SvIV_nomg|SV* sv
1588 Like C<SvIV> but doesn't process magic.
1590 =for apidoc Am|IV|SvIVx|SV* sv
1591 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1592 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1593 otherwise use the more efficient C<SvIV>.
1595 =for apidoc Am|NV|SvNV|SV* sv
1596 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1597 which guarantees to evaluate sv only once.
1599 =for apidoc Am|NV|SvNVx|SV* sv
1600 Coerces the given SV to a double and returns it. Guarantees to evaluate
1601 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1602 otherwise use the more efficient C<SvNV>.
1604 =for apidoc Am|UV|SvUV|SV* sv
1605 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1606 for a version which guarantees to evaluate sv only once.
1608 =for apidoc Am|UV|SvUV_nomg|SV* sv
1609 Like C<SvUV> but doesn't process magic.
1611 =for apidoc Am|UV|SvUVx|SV* sv
1612 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1613 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1614 otherwise use the more efficient C<SvUV>.
1616 =for apidoc Am|bool|SvTRUE|SV* sv
1617 Returns a boolean indicating whether Perl would evaluate the SV as true or
1618 false, defined or undefined. Does not handle 'get' magic.
1620 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1621 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1623 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1624 Like C<SvPV>, but converts sv to utf8 first if necessary.
1626 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1627 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1629 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1630 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1632 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1633 Like C<SvPV>, but converts sv to byte representation first if necessary.
1635 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1636 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1638 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1639 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1640 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1643 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1644 Like C<SvPV>, but converts sv to utf8 first if necessary.
1645 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1648 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1649 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1650 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1653 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1654 Like C<SvPV>, but converts sv to byte representation first if necessary.
1655 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1658 =for apidoc Am|bool|SvIsCOW|SV* sv
1659 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1660 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1663 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1664 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1667 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1668 Like C<sv_catpvn> but doesn't process magic.
1670 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1671 Like C<sv_setsv> but doesn't process magic.
1673 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1674 Like C<sv_catsv> but doesn't process magic.
1679 /* Let us hope that bitmaps for UV and IV are the same */
1680 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1681 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1682 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1684 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1685 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1689 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1690 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1691 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1693 #define SvPV_flags(sv, lp, flags) \
1694 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1695 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1696 #define SvPV_flags_const(sv, lp, flags) \
1697 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1698 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1699 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1700 #define SvPV_flags_const_nolen(sv, flags) \
1701 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1702 ? SvPVX_const(sv) : \
1703 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1704 #define SvPV_flags_mutable(sv, lp, flags) \
1705 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1706 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1707 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1709 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1710 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1711 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1713 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1714 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1716 #define SvPV_force_flags(sv, lp, flags) \
1717 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1718 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1719 #define SvPV_force_flags_nolen(sv, flags) \
1720 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1721 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1722 #define SvPV_force_flags_mutable(sv, lp, flags) \
1723 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1724 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1725 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1727 #define SvPV_nolen(sv) \
1728 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1729 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1731 #define SvPV_nolen_const(sv) \
1732 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1733 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1735 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1736 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1737 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1741 #define SvPVutf8(sv, lp) \
1742 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1743 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1745 #define SvPVutf8_force(sv, lp) \
1746 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1747 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1750 #define SvPVutf8_nolen(sv) \
1751 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1752 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1756 #define SvPVbyte(sv, lp) \
1757 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1758 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1760 #define SvPVbyte_force(sv, lp) \
1761 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1762 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1764 #define SvPVbyte_nolen(sv) \
1765 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1766 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1770 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1771 * var to evaluate the arg once; failing that, use a global if possible;
1772 * failing that, call a function to do the work
1775 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1776 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1777 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1779 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1781 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1782 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1783 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1784 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1785 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1786 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1787 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1788 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1789 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1790 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1791 # define SvTRUE(sv) ( \
1795 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1797 (nxpv->xpv_cur > 1 || \
1798 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1805 ? SvNVX(sv) != 0.0 \
1807 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1809 #else /* __GNUC__ */
1811 /* These inlined macros use globals, which will require a thread
1812 * declaration in user code, so we avoid them under threads */
1814 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1815 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1816 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1817 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1818 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1819 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1820 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1821 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1822 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1823 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1824 # define SvTRUE(sv) ( \
1828 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1829 (PL_Xpv->xpv_cur > 1 || \
1830 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1837 ? SvNVX(sv) != 0.0 \
1839 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1840 #endif /* __GNU__ */
1842 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1843 (SVf_FAKE | SVf_READONLY))
1844 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1846 #define SvSHARED_HEK_FROM_PV(pvx) \
1847 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1848 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1850 /* flag values for sv_*_flags functions */
1851 #define SV_IMMEDIATE_UNREF 1
1853 #define SV_COW_DROP_PV 4
1854 #define SV_UTF8_NO_ENCODING 8
1855 #define SV_NOSTEAL 16
1856 #define SV_CONST_RETURN 32
1857 #define SV_MUTABLE_RETURN 64
1858 #define SV_SMAGIC 128
1859 #define SV_HAS_TRAILING_NUL 256
1860 #define SV_COW_SHARED_HASH_KEYS 512
1861 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1862 #define SV_COW_OTHER_PVS 1024
1864 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1865 So only default to doing the COW setup if we're in the core.
1868 # ifndef SV_DO_COW_SVSETSV
1869 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1873 #ifndef SV_DO_COW_SVSETSV
1874 # define SV_DO_COW_SVSETSV 0
1878 #define sv_unref(sv) sv_unref_flags(sv, 0)
1879 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1880 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1881 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1883 /* We are about to replace the SV's current value. So if it's copy on write
1884 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1885 the value is about to get thrown away, so drop the PV rather than go to
1886 the effort of making a read-write copy only for it to get immediately
1889 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1890 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1892 #ifdef PERL_OLD_COPY_ON_WRITE
1893 #define SvRELEASE_IVX(sv) \
1894 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), SvOOK_off(sv))
1895 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1897 # define SvRELEASE_IVX(sv) SvOOK_off(sv)
1898 #endif /* PERL_OLD_COPY_ON_WRITE */
1900 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1901 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1902 SVf_OOK|SVf_BREAK|SVf_READONLY)
1903 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1905 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1906 sv_force_normal_flags(sv, 0)
1909 /* all these 'functions' are now just macros */
1911 #define sv_pv(sv) SvPV_nolen(sv)
1912 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1913 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1915 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1916 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1917 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1918 #define sv_setsv(dsv, ssv) \
1919 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1920 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1921 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1922 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1923 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1924 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1925 #define sv_catpvn_mg(sv, sstr, slen) \
1926 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1927 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1928 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1929 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1930 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1931 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1932 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1933 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1934 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1935 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1937 /* Should be named SvCatPVN_utf8_upgrade? */
1938 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1941 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1943 sv_setpvn(nsv, sstr, slen); \
1945 sv_utf8_upgrade(nsv); \
1946 sv_catsv(dsv, nsv); \
1950 =for apidoc Am|SV*|newRV_inc|SV* sv
1952 Creates an RV wrapper for an SV. The reference count for the original SV is
1958 #define newRV_inc(sv) newRV(sv)
1960 /* the following macros update any magic values this sv is associated with */
1963 =head1 Magical Functions
1965 =for apidoc Am|void|SvGETMAGIC|SV* sv
1966 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1967 argument more than once.
1969 =for apidoc Am|void|SvSETMAGIC|SV* sv
1970 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1971 argument more than once.
1973 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1974 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1977 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1978 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1979 ssv. May evaluate arguments more than once.
1981 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1982 Like C<SvSetSV>, but does any set magic required afterwards.
1984 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1985 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1987 =for apidoc Am|void|SvSHARE|SV* sv
1988 Arranges for sv to be shared between threads if a suitable module
1991 =for apidoc Am|void|SvLOCK|SV* sv
1992 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1995 =for apidoc Am|void|SvUNLOCK|SV* sv
1996 Releases a mutual exclusion lock on sv if a suitable module
1999 =head1 SV Manipulation Functions
2001 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
2002 Expands the character buffer in the SV so that it has room for the
2003 indicated number of bytes (remember to reserve space for an extra trailing
2004 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2005 Returns a pointer to the character buffer.
2010 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
2011 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
2012 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
2014 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
2015 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
2017 #define SvSetSV_and(dst,src,finally) \
2019 if ((dst) != (src)) { \
2020 sv_setsv(dst, src); \
2024 #define SvSetSV_nosteal_and(dst,src,finally) \
2026 if ((dst) != (src)) { \
2027 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
2032 #define SvSetSV(dst,src) \
2033 SvSetSV_and(dst,src,/*nothing*/;)
2034 #define SvSetSV_nosteal(dst,src) \
2035 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
2037 #define SvSetMagicSV(dst,src) \
2038 SvSetSV_and(dst,src,SvSETMAGIC(dst))
2039 #define SvSetMagicSV_nosteal(dst,src) \
2040 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
2043 #if !defined(SKIP_DEBUGGING)
2044 #define SvPEEK(sv) sv_peek(sv)
2046 #define SvPEEK(sv) ""
2049 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
2051 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2053 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2054 /* If I give every macro argument a different name, then there won't be bugs
2055 where nested macros get confused. Been there, done that. */
2056 #define isGV_with_GP(pwadak) \
2057 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
2058 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2059 #define isGV_with_GP_on(sv) STMT_START { \
2060 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2061 assert (!SvPOKp(sv)); \
2062 assert (!SvIOKp(sv)); \
2063 (SvFLAGS(sv) |= SVpgv_GP); \
2065 #define isGV_with_GP_off(sv) STMT_START { \
2066 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2067 assert (!SvPOKp(sv)); \
2068 assert (!SvIOKp(sv)); \
2069 (SvFLAGS(sv) &= ~SVpgv_GP); \
2073 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2074 #define SvGROW_mutable(sv,len) \
2075 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2076 #define Sv_Grow sv_grow
2078 #define CLONEf_COPY_STACKS 1
2079 #define CLONEf_KEEP_PTR_TABLE 2
2080 #define CLONEf_CLONE_HOST 4
2081 #define CLONEf_JOIN_IN 8
2083 struct clone_params {
2086 PerlInterpreter *proto_perl;
2091 * c-indentation-style: bsd
2093 * indent-tabs-mode: t
2096 * ex: set ts=8 sts=4 sw=4 noet: