3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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>.
63 SVt_LAST /* keep last in enum. used to size arrays */
66 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
67 and SVt_IV, so never reaches the clause at the end that uses
68 sv_type_details->body_size to determine whether to call safefree(). Hence
69 body_size can be set no-zero to record the size of PTEs and HEs, without
70 fear of bogus frees. */
72 #define PTE_SVSLOT SVt_IV
74 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
75 #define HE_SVSLOT SVt_NULL
78 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
80 /* typedefs to eliminate some typing */
82 typedef struct hek HEK;
84 /* Using C's structural equivalence to help emulate C++ inheritance here... */
86 /* start with 2 sv-head building blocks */
87 #define _SV_HEAD(ptrtype) \
88 ptrtype sv_any; /* pointer to body */ \
89 U32 sv_refcnt; /* how many references to us */ \
90 U32 sv_flags /* what we are */
92 #define _SV_HEAD_UNION \
96 SV* svu_rv; /* pointer to another SV */ \
97 char* svu_pv; /* pointer to malloced string */ \
104 struct STRUCT_SV { /* struct sv { */
107 #ifdef DEBUG_LEAKING_SCALARS
108 unsigned sv_debug_optype:9; /* the type of OP that allocated us */
109 unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */
110 unsigned sv_debug_cloned:1; /* was cloned for an ithread */
111 unsigned sv_debug_line:16; /* the line where we were allocated */
112 char * sv_debug_file; /* the file where we were allocated */
117 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
122 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
127 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
132 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
137 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
142 #undef _SV_HEAD_UNION /* ensure no pollution */
145 =head1 SV Manipulation Functions
147 =for apidoc Am|U32|SvREFCNT|SV* sv
148 Returns the value of the object's reference count.
150 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
151 Increments the reference count of the given SV.
153 All of the following SvREFCNT_inc* macros are optimized versions of
154 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
156 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
157 Same as SvREFCNT_inc, but can only be used if you know I<sv>
158 is not NULL. Since we don't have to check the NULLness, it's faster
161 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
162 Same as SvREFCNT_inc, but can only be used if you don't need the
163 return value. The macro doesn't need to return a meaningful value.
165 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
166 Same as SvREFCNT_inc, but can only be used if you don't need the return
167 value, and you know that I<sv> is not NULL. The macro doesn't need
168 to return a meaningful value, or check for NULLness, so it's smaller
171 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
172 Same as SvREFCNT_inc, but can only be used with simple variables, not
173 expressions or pointer dereferences. Since we don't have to store a
174 temporary value, it's faster.
176 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
177 Same as SvREFCNT_inc_simple, 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
181 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
182 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
183 return value. The macro doesn't need to return a meaningful value.
185 =for apidoc Am|void|SvREFCNT_inc_simple_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
191 =for apidoc Am|void|SvREFCNT_dec|SV* sv
192 Decrements the reference count of the given SV.
194 =for apidoc Am|svtype|SvTYPE|SV* sv
195 Returns the type of the SV. See C<svtype>.
197 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
198 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
199 perform the upgrade if necessary. See C<svtype>.
204 #define SvANY(sv) (sv)->sv_any
205 #define SvFLAGS(sv) (sv)->sv_flags
206 #define SvREFCNT(sv) (sv)->sv_refcnt
208 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
209 # define SvREFCNT_inc(sv) \
211 SV * const _sv = (SV*)(sv); \
216 # define SvREFCNT_inc_simple(sv) \
222 # define SvREFCNT_inc_NN(sv) \
224 SV * const _sv = (SV*)(sv); \
228 # define SvREFCNT_inc_void(sv) \
230 SV * const _sv = (SV*)(sv); \
232 (void)(SvREFCNT(_sv)++); \
235 # define SvREFCNT_inc(sv) \
236 ((PL_Sv=(SV*)(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
237 # define SvREFCNT_inc_simple(sv) \
238 ((sv) ? (SvREFCNT(sv)++,(SV*)(sv)) : NULL)
239 # define SvREFCNT_inc_NN(sv) \
240 (PL_Sv=(SV*)(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
241 # define SvREFCNT_inc_void(sv) \
242 (void)((PL_Sv=(SV*)(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
245 /* These guys don't need the curly blocks */
246 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
247 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),(SV*)(sv))
248 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
249 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
251 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
252 # define SvREFCNT_dec(sv) \
254 SV * const _sv = (SV*)(sv); \
256 if (SvREFCNT(_sv)) { \
257 if (--(SvREFCNT(_sv)) == 0) \
258 Perl_sv_free2(aTHX_ _sv); \
265 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
268 #define SVTYPEMASK 0xff
269 #define SvTYPE(sv) (svtype)((sv)->sv_flags & SVTYPEMASK)
271 /* Sadly there are some parts of the core that have pointers to already-freed
272 SV heads, and rely on being able to tell that they are now free. So mark
273 them all by using a consistent macro. */
274 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
276 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
278 #define SVf_IOK 0x00000100 /* has valid public integer value */
279 #define SVf_NOK 0x00000200 /* has valid public numeric value */
280 #define SVf_POK 0x00000400 /* has valid public pointer value */
281 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
283 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
284 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
285 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
286 #define SVp_SCREAM 0x00008000 /* has been studied? */
287 #define SVphv_CLONEABLE 0x00008000 /* PVHV (stashes) clone its objects */
289 #define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
290 #define SVpad_STATE 0x00010000 /* pad name is a "state" var */
291 #define SVs_PADTMP 0x00020000 /* in use as tmp */
292 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
293 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
294 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
295 #define SVs_TEMP 0x00080000 /* string is stealable? */
296 #define SVs_OBJECT 0x00100000 /* is "blessed" */
297 #define SVs_GMG 0x00200000 /* has magical get method */
298 #define SVs_SMG 0x00400000 /* has magical set method */
299 #define SVs_RMG 0x00800000 /* has random magical methods */
301 #define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
302 1: SV head arena wasn't malloc()ed
303 2: in conjunction with SVf_READONLY
304 marks a shared hash key scalar
305 (SvLEN == 0) or a copy on write
306 string (SvLEN != 0) [SvIsCOW(sv)]
307 3: For PVCV, whether CvUNIQUE(cv)
308 refers to an eval or once only
309 [CvEVAL(cv), CvSPECIAL(cv)]
310 4: Whether the regexp pointer is in
311 fact an offset [SvREPADTMP(sv)]
312 5: On a pad name SV, that slot in the
313 frame AV is a REFCNT'ed reference
314 to a lexical from "outside". */
315 #define SVphv_REHASH SVf_FAKE /* 6: On a PVHV, hash values are being
317 #define SVf_OOK 0x02000000 /* has valid offset value
318 For a PVHV this means that a
319 hv_aux struct is present after the
321 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used
322 * by SV's in final arena cleanup */
323 #define SVf_READONLY 0x08000000 /* may not be modified */
328 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
330 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
331 SVp_IOK|SVp_NOK|SVp_POK|SVp_SCREAM)
333 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
335 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
336 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
337 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
339 /* Some private flags. */
342 #define SVphv_SHAREKEYS 0x20000000 /* PVHV
343 keys live on shared string table */
344 /* PVNV, PVMG, PVGV, presumably only inside pads */
345 #define SVpad_NAME 0x40000000 /* This SV is a name in the PAD, so
346 SVpad_TYPED, SVpad_OUR and
349 #define SVpav_REAL 0x40000000 /* free old entries */
351 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
352 /* Not just PVBM - basically anything that can be a regular scalar */
353 #define SVpbm_VALID 0x40000000
355 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
357 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
358 /* Presumably IVs aren't stored in pads */
359 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
361 #define SVpav_REIFY 0x80000000 /* can become real */
363 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
365 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
367 #define SVpbm_TAIL 0x80000000
368 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
369 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
374 NV xnv_nv; /* numeric value, if any */
377 STRLEN xpv_cur; /* length of svu_pv as a C string */
378 STRLEN xpv_len; /* allocated size */
382 typedef struct xpv xpv_allocated;
385 STRLEN xpv_cur; /* length of svu_pv as a C string */
386 STRLEN xpv_len; /* allocated size */
392 NV xnv_nv; /* numeric value, if any */
395 STRLEN xpv_cur; /* length of svu_pv as a C string */
396 STRLEN xpv_len; /* allocated size */
398 IV xivu_iv; /* integer value or pv offset */
407 typedef struct xpviv xpviv_allocated;
410 STRLEN xpv_cur; /* length of svu_pv as a C string */
411 STRLEN xpv_len; /* allocated size */
413 IV xivu_iv; /* integer value or pv offset */
422 #define xiv_iv xiv_u.xivu_iv
426 NV xnv_nv; /* numeric value, if any */
429 STRLEN xpv_cur; /* length of svu_pv as a C string */
430 STRLEN xpv_len; /* allocated size */
433 UV xuvu_uv; /* unsigned value or pv offset */
439 #define xuv_uv xuv_u.xuvu_uv
443 NV xnv_nv; /* numeric value, if any */
446 STRLEN xpv_cur; /* length of svu_pv as a C string */
447 STRLEN xpv_len; /* allocated size */
449 IV xivu_iv; /* integer value or pv offset */
457 /* These structure must match the beginning of struct xpvhv in hv.h. */
460 NV xnv_nv; /* numeric value, if any */
463 STRLEN xpv_cur; /* length of svu_pv as a C string */
464 STRLEN xpv_len; /* allocated size */
466 IV xivu_iv; /* integer value or pv offset */
473 MAGIC* xmg_magic; /* linked list of magicalness */
474 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
476 HV* xmg_stash; /* class package */
481 NV xnv_nv; /* numeric value, if any */
484 STRLEN xpv_cur; /* length of svu_pv as a C string */
485 STRLEN xpv_len; /* allocated size */
487 IV xivu_iv; /* integer value or pv offset */
491 HEK * xivu_namehek; /* GvNAME */
494 MAGIC* xmg_magic; /* linked list of magicalness */
495 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
497 HV* xmg_stash; /* class package */
502 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
503 * y=alem/helem/iter t=tie T=tied HE */
509 HV * xgv_stash; /* The stash of this GV */
511 STRLEN xpv_cur; /* xgv_flags */
512 STRLEN xpv_len; /* 0 */
518 HEK * xivu_namehek; /* GvNAME */
521 MAGIC* xmg_magic; /* linked list of magicalness */
522 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
524 HV* xmg_stash; /* class package */
530 NV xnv_nv; /* numeric value, if any */
533 STRLEN xpv_cur; /* length of svu_pv as a C string */
534 STRLEN xpv_len; /* allocated size */
536 IV xivu_iv; /* integer value or pv offset */
539 I32 xivu_i32; /* is this constant pattern being useful? */
543 MAGIC* xmg_magic; /* linked list of magicalness */
544 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
546 HV* xmg_stash; /* class package */
548 U16 xbm_previous; /* how many characters in string before rare? */
549 U8 xbm_rare; /* rarest character in string */
552 /* This structure must match XPVCV in cv.h */
554 typedef U16 cv_flags_t;
558 NV xnv_nv; /* numeric value, if any */
561 STRLEN xpv_cur; /* length of svu_pv as a C string */
562 STRLEN xpv_len; /* allocated size */
564 IV xivu_iv; /* PVFMs use the pv offset */
571 MAGIC* xmg_magic; /* linked list of magicalness */
572 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
574 HV* xmg_stash; /* class package */
583 void (*xcv_xsub) (pTHX_ CV*);
589 U32 xcv_outside_seq; /* the COP sequence (at the point of our
590 * compilation) in the lexically enclosing
592 cv_flags_t xcv_flags;
597 STRLEN xpv_cur; /* length of svu_pv as a C string */
598 STRLEN xpv_len; /* allocated size */
600 IV xivu_iv; /* PVFMs use the pv offset */
607 MAGIC* xmg_magic; /* linked list of magicalness */
608 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
610 HV* xmg_stash; /* class package */
619 void (*xcv_xsub) (pTHX_ CV*);
625 U32 xcv_outside_seq; /* the COP sequence (at the point of our
626 * compilation) in the lexically enclosing
628 cv_flags_t xcv_flags;
634 NV xnv_nv; /* numeric value, if any */
637 STRLEN xpv_cur; /* length of svu_pv as a C string */
638 STRLEN xpv_len; /* allocated size */
640 IV xivu_iv; /* integer value or pv offset */
647 MAGIC* xmg_magic; /* linked list of magicalness */
648 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
650 HV* xmg_stash; /* class package */
652 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
653 PerlIO * xio_ofp; /* but sockets need separate streams */
654 /* Cray addresses everything by word boundaries (64 bits) and
655 * code and data pointers cannot be mixed (which is exactly what
656 * Perl_filter_add() tries to do with the dirp), hence the following
657 * union trick (as suggested by Gurusamy Sarathy).
658 * For further information see Geir Johansen's problem report titled
659 [ID 20000612.002] Perl problem on Cray system
660 * The any pointer (known as IoANY()) will also be a good place
661 * to hang any IO disciplines to.
664 DIR * xiou_dirp; /* for opendir, readdir, etc */
665 void * xiou_any; /* for alignment */
667 IV xio_lines; /* $. */
668 IV xio_page; /* $% */
669 IV xio_page_len; /* $= */
670 IV xio_lines_left; /* $- */
671 char * xio_top_name; /* $^ */
672 GV * xio_top_gv; /* $^ */
673 char * xio_fmt_name; /* $~ */
674 GV * xio_fmt_gv; /* $~ */
675 char * xio_bottom_name;/* $^B */
676 GV * xio_bottom_gv; /* $^B */
677 short xio_subprocess; /* -| or |- */
681 #define xio_dirp xio_dirpu.xiou_dirp
682 #define xio_any xio_dirpu.xiou_any
684 #define IOf_ARGV 1 /* this fp iterates over ARGV */
685 #define IOf_START 2 /* check for null ARGV and substitute '-' */
686 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
687 #define IOf_DIDTOP 8 /* just did top of form */
688 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
689 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
690 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
692 /* The following macros define implementation-independent predicates on SVs. */
695 =for apidoc Am|bool|SvNIOK|SV* sv
696 Returns a boolean indicating whether the SV contains a number, integer or
699 =for apidoc Am|bool|SvNIOKp|SV* sv
700 Returns a boolean indicating whether the SV contains a number, integer or
701 double. Checks the B<private> setting. Use C<SvNIOK>.
703 =for apidoc Am|void|SvNIOK_off|SV* sv
704 Unsets the NV/IV status of an SV.
706 =for apidoc Am|bool|SvOK|SV* sv
707 Returns a boolean indicating whether the value is an SV. It also tells
708 whether the value is defined or not.
710 =for apidoc Am|bool|SvIOKp|SV* sv
711 Returns a boolean indicating whether the SV contains an integer. Checks
712 the B<private> setting. Use C<SvIOK>.
714 =for apidoc Am|bool|SvNOKp|SV* sv
715 Returns a boolean indicating whether the SV contains a double. Checks the
716 B<private> setting. Use C<SvNOK>.
718 =for apidoc Am|bool|SvPOKp|SV* sv
719 Returns a boolean indicating whether the SV contains a character string.
720 Checks the B<private> setting. Use C<SvPOK>.
722 =for apidoc Am|bool|SvIOK|SV* sv
723 Returns a boolean indicating whether the SV contains an integer.
725 =for apidoc Am|void|SvIOK_on|SV* sv
726 Tells an SV that it is an integer.
728 =for apidoc Am|void|SvIOK_off|SV* sv
729 Unsets the IV status of an SV.
731 =for apidoc Am|void|SvIOK_only|SV* sv
732 Tells an SV that it is an integer and disables all other OK bits.
734 =for apidoc Am|void|SvIOK_only_UV|SV* sv
735 Tells and SV that it is an unsigned integer and disables all other OK bits.
737 =for apidoc Am|bool|SvIOK_UV|SV* sv
738 Returns a boolean indicating whether the SV contains an unsigned integer.
740 =for apidoc Am|void|SvUOK|SV* sv
741 Returns a boolean indicating whether the SV contains an unsigned integer.
743 =for apidoc Am|bool|SvIOK_notUV|SV* sv
744 Returns a boolean indicating whether the SV contains a signed integer.
746 =for apidoc Am|bool|SvNOK|SV* sv
747 Returns a boolean indicating whether the SV contains a double.
749 =for apidoc Am|void|SvNOK_on|SV* sv
750 Tells an SV that it is a double.
752 =for apidoc Am|void|SvNOK_off|SV* sv
753 Unsets the NV status of an SV.
755 =for apidoc Am|void|SvNOK_only|SV* sv
756 Tells an SV that it is a double and disables all other OK bits.
758 =for apidoc Am|bool|SvPOK|SV* sv
759 Returns a boolean indicating whether the SV contains a character
762 =for apidoc Am|void|SvPOK_on|SV* sv
763 Tells an SV that it is a string.
765 =for apidoc Am|void|SvPOK_off|SV* sv
766 Unsets the PV status of an SV.
768 =for apidoc Am|void|SvPOK_only|SV* sv
769 Tells an SV that it is a string and disables all other OK bits.
770 Will also turn off the UTF-8 status.
772 =for apidoc Am|bool|SvVOK|SV* sv
773 Returns a boolean indicating whether the SV contains a v-string.
775 =for apidoc Am|bool|SvOOK|SV* sv
776 Returns a boolean indicating whether the SvIVX is a valid offset value for
777 the SvPVX. This hack is used internally to speed up removal of characters
778 from the beginning of a SvPV. When SvOOK is true, then the start of the
779 allocated string buffer is really (SvPVX - SvIVX).
781 =for apidoc Am|bool|SvROK|SV* sv
782 Tests if the SV is an RV.
784 =for apidoc Am|void|SvROK_on|SV* sv
785 Tells an SV that it is an RV.
787 =for apidoc Am|void|SvROK_off|SV* sv
788 Unsets the RV status of an SV.
790 =for apidoc Am|SV*|SvRV|SV* sv
791 Dereferences an RV to return the SV.
793 =for apidoc Am|IV|SvIVX|SV* sv
794 Returns the raw value in the SV's IV slot, without checks or conversions.
795 Only use when you are sure SvIOK is true. See also C<SvIV()>.
797 =for apidoc Am|UV|SvUVX|SV* sv
798 Returns the raw value in the SV's UV slot, without checks or conversions.
799 Only use when you are sure SvIOK is true. See also C<SvUV()>.
801 =for apidoc Am|NV|SvNVX|SV* sv
802 Returns the raw value in the SV's NV slot, without checks or conversions.
803 Only use when you are sure SvNOK is true. See also C<SvNV()>.
805 =for apidoc Am|char*|SvPVX|SV* sv
806 Returns a pointer to the physical string in the SV. The SV must contain a
809 =for apidoc Am|STRLEN|SvCUR|SV* sv
810 Returns the length of the string which is in the SV. See C<SvLEN>.
812 =for apidoc Am|STRLEN|SvLEN|SV* sv
813 Returns the size of the string buffer in the SV, not including any part
814 attributable to C<SvOOK>. See C<SvCUR>.
816 =for apidoc Am|char*|SvEND|SV* sv
817 Returns a pointer to the last character in the string which is in the SV.
818 See C<SvCUR>. Access the character as *(SvEND(sv)).
820 =for apidoc Am|HV*|SvSTASH|SV* sv
821 Returns the stash of the SV.
823 =for apidoc Am|void|SvIV_set|SV* sv|IV val
824 Set the value of the IV pointer in sv to val. It is possible to perform
825 the same function of this macro with an lvalue assignment to C<SvIVX>.
826 With future Perls, however, it will be more efficient to use
827 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
829 =for apidoc Am|void|SvNV_set|SV* sv|NV val
830 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
832 =for apidoc Am|void|SvPV_set|SV* sv|char* val
833 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
835 =for apidoc Am|void|SvUV_set|SV* sv|UV val
836 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
838 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
839 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
841 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
842 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
844 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
845 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
847 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
848 Set the current length of the string which is in the SV. See C<SvCUR>
851 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
852 Set the actual length of the string which is in the SV. See C<SvIV_set>.
857 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
858 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
859 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
860 SVp_IOK|SVp_NOK|SVf_IVisUV))
862 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
863 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
864 #define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
866 #define assert_not_ROK(sv)
867 #define assert_not_glob(sv)
870 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
871 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
872 SvFLAGS(sv) &= ~(SVf_OK| \
873 SVf_IVisUV|SVf_UTF8), \
875 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
876 SvFLAGS(sv) &= ~(SVf_OK| \
880 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
881 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
882 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
883 SvFLAGS(sv) |= SVp_IOK)
884 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
885 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
886 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
887 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
888 SvFLAGS(sv) |= SVp_POK)
890 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
891 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
892 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
893 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
894 #define SvIOK_only(sv) (SvOK_off(sv), \
895 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
896 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
897 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
899 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
900 == (SVf_IOK|SVf_IVisUV))
901 #define SvUOK(sv) SvIOK_UV(sv)
902 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
905 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
906 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
907 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
909 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
910 #define SvNOK_on(sv) (assert_not_glob(sv) \
911 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
912 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
913 #define SvNOK_only(sv) (SvOK_off(sv), \
914 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
917 =for apidoc Am|bool|SvUTF8|SV* sv
918 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
920 =for apidoc Am|void|SvUTF8_on|SV *sv
921 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
922 Do not use frivolously.
924 =for apidoc Am|void|SvUTF8_off|SV *sv
925 Unsets the UTF-8 status of an SV.
927 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
928 Tells an SV that it is a string and disables all other OK bits,
929 and leaves the UTF-8 status as it was.
934 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
936 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
937 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
938 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
940 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
941 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
942 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
943 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
944 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
945 SvFLAGS(sv) &= ~(SVf_OK| \
946 SVf_IVisUV|SVf_UTF8), \
947 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
948 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
949 SvFLAGS(sv) &= ~(SVf_OK| \
951 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
953 #define SvVOK(sv) (SvMAGICAL(sv) \
954 && mg_find(sv,PERL_MAGIC_vstring))
955 /* returns the vstring magic, if any */
956 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
957 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
959 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
960 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
961 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
963 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
964 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
965 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
967 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
968 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
969 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
971 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
972 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
973 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
975 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
976 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
977 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
979 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
980 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
981 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
983 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
984 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
985 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
987 #define SvAMAGIC(sv) (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
988 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
989 # define SvAMAGIC_on(sv) ({ SV * const kloink = sv; \
990 assert(SvROK(kloink)); \
991 SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
993 # define SvAMAGIC_off(sv) ({ SV * const kloink = sv; \
995 SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
998 # define SvAMAGIC_on(sv) (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
999 # define SvAMAGIC_off(sv) \
1000 (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
1004 =for apidoc Am|char*|SvGAMAGIC|SV* sv
1006 Returns true if the SV has get magic or overloading. If either is true then
1007 the scalar is active data, and has the potential to return a new value every
1008 time it is accessed. Hence you must be careful to only read it once per user
1009 logical operation and work with that returned value. If neither is true then
1010 the scalar's value cannot change unless written to.
1015 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1017 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
1019 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1020 == (SVf_ROK|SVprv_WEAKREF))
1021 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1022 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1024 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1026 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
1027 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
1028 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
1030 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
1031 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1032 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1034 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
1035 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
1037 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1038 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1039 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1041 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1042 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1043 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1045 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
1046 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1047 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1049 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1050 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1051 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1053 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
1054 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
1055 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
1057 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1058 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1059 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1061 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1062 # define SvTAIL(sv) ({ SV *const _svi = (SV *) (sv); \
1063 assert(SvTYPE(_svi) != SVt_PVAV); \
1064 assert(SvTYPE(_svi) != SVt_PVHV); \
1065 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1066 == (SVpbm_TAIL|SVpbm_VALID); \
1069 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1070 == (SVpbm_TAIL|SVpbm_VALID));
1073 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1074 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1076 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
1077 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1078 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
1081 /* The following uses the FAKE flag to show that a regex pointer is infact
1082 its own offset in the regexpad for ithreads */
1083 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
1084 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
1085 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
1088 #define SvPAD_TYPED(sv) \
1089 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1090 #define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1092 #define SvPAD_OUR(sv) \
1093 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1094 #define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1096 #define SvPAD_STATE(sv) \
1097 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1098 #define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1100 #define OURSTASH(sv) \
1101 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1102 #define OURSTASH_set(sv, st) \
1104 assert(SvTYPE(sv) == SVt_PVMG); \
1105 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1108 #ifdef PERL_DEBUG_COW
1109 #define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1111 #define SvRV(sv) ((sv)->sv_u.svu_rv)
1113 #define SvRVx(sv) SvRV(sv)
1115 #ifdef PERL_DEBUG_COW
1116 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1117 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1118 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1119 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1120 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1121 /* Don't test the core XS code yet. */
1122 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1123 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1125 # define SvPVX(sv) SvPVX_mutable(sv)
1127 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1128 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1129 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1132 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1133 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
1135 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1136 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
1139 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1140 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1142 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1143 /* These get expanded inside other macros that already use a variable _sv */
1144 # define SvPVX(sv) \
1145 (*({ SV *const _svi = (SV *) (sv); \
1146 assert(SvTYPE(_svi) >= SVt_PV); \
1147 assert(SvTYPE(_svi) != SVt_PVAV); \
1148 assert(SvTYPE(_svi) != SVt_PVHV); \
1149 assert(!isGV_with_GP(_svi)); \
1150 &((_svi)->sv_u.svu_pv); \
1152 # define SvCUR(sv) \
1153 (*({ SV *const _svi = (SV *) (sv); \
1154 assert(SvTYPE(_svi) >= SVt_PV); \
1155 assert(SvTYPE(_svi) != SVt_PVAV); \
1156 assert(SvTYPE(_svi) != SVt_PVHV); \
1157 assert(!isGV_with_GP(_svi)); \
1158 &(((XPV*) SvANY(_svi))->xpv_cur); \
1160 # define SvIVX(sv) \
1161 (*({ SV *const _svi = (SV *) (sv); \
1162 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1163 assert(SvTYPE(_svi) != SVt_PVAV); \
1164 assert(SvTYPE(_svi) != SVt_PVHV); \
1165 assert(SvTYPE(_svi) != SVt_PVCV); \
1166 assert(!isGV_with_GP(_svi)); \
1167 &(((XPVIV*) SvANY(_svi))->xiv_iv); \
1169 # define SvUVX(sv) \
1170 (*({ SV *const _svi = (SV *) (sv); \
1171 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1172 assert(SvTYPE(_svi) != SVt_PVAV); \
1173 assert(SvTYPE(_svi) != SVt_PVHV); \
1174 assert(SvTYPE(_svi) != SVt_PVCV); \
1175 assert(!isGV_with_GP(_svi)); \
1176 &(((XPVUV*) SvANY(_svi))->xuv_uv); \
1178 # define SvNVX(sv) \
1179 (*({ SV *const _svi = (SV *) (sv); \
1180 assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \
1181 assert(SvTYPE(_svi) != SVt_PVAV); \
1182 assert(SvTYPE(_svi) != SVt_PVHV); \
1183 assert(SvTYPE(_svi) != SVt_PVCV); \
1184 assert(SvTYPE(_svi) != SVt_PVFM); \
1185 assert(!isGV_with_GP(_svi)); \
1186 &(((XPVNV*) SvANY(_svi))->xnv_u.xnv_nv); \
1188 # define SvMAGIC(sv) \
1189 (*({ SV *const _svi = (SV *) (sv); \
1190 assert(SvTYPE(_svi) >= SVt_PVMG); \
1191 if(SvTYPE(_svi) == SVt_PVMG) \
1192 assert(!SvPAD_OUR(_svi)); \
1193 &(((XPVMG*) SvANY(_svi))->xmg_u.xmg_magic); \
1195 # define SvSTASH(sv) \
1196 (*({ SV *const _svi = (SV *) (sv); \
1197 assert(SvTYPE(_svi) >= SVt_PVMG); \
1198 &(((XPVMG*) SvANY(_svi))->xmg_stash); \
1201 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1202 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1203 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1204 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1205 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1206 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1207 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1212 /* Given that these two are new, there can't be any existing code using them
1214 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1215 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1217 /* Except for the poison code, which uses & to scribble over the pointer after
1218 free() is called. */
1219 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1220 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1223 #define SvIVXx(sv) SvIVX(sv)
1224 #define SvUVXx(sv) SvUVX(sv)
1225 #define SvNVXx(sv) SvNVX(sv)
1226 #define SvPVXx(sv) SvPVX(sv)
1227 #define SvLENx(sv) SvLEN(sv)
1228 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1231 /* Ask a scalar nicely to try to become an IV, if possible.
1232 Not guaranteed to stay returning void */
1233 /* Macro won't actually call sv_2iv if already IOK */
1234 #define SvIV_please(sv) \
1235 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1236 (void) SvIV(sv); } STMT_END
1237 #define SvIV_set(sv, val) \
1238 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1239 assert(SvTYPE(sv) != SVt_PVAV); \
1240 assert(SvTYPE(sv) != SVt_PVHV); \
1241 assert(SvTYPE(sv) != SVt_PVCV); \
1242 assert(!isGV_with_GP(sv)); \
1243 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1244 #define SvNV_set(sv, val) \
1245 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1246 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1247 assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1248 assert(!isGV_with_GP(sv)); \
1249 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1250 #define SvPV_set(sv, val) \
1251 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1252 assert(SvTYPE(sv) != SVt_PVAV); \
1253 assert(SvTYPE(sv) != SVt_PVHV); \
1254 assert(!isGV_with_GP(sv)); \
1255 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1256 #define SvUV_set(sv, val) \
1257 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1258 assert(SvTYPE(sv) != SVt_PVAV); \
1259 assert(SvTYPE(sv) != SVt_PVHV); \
1260 assert(SvTYPE(sv) != SVt_PVCV); \
1261 assert(!isGV_with_GP(sv)); \
1262 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1263 #define SvRV_set(sv, val) \
1264 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
1265 assert(!isGV_with_GP(sv)); \
1266 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1267 #define SvMAGIC_set(sv, val) \
1268 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1269 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1270 #define SvSTASH_set(sv, val) \
1271 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1272 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1273 #define SvCUR_set(sv, val) \
1274 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1275 assert(SvTYPE(sv) != SVt_PVAV); \
1276 assert(SvTYPE(sv) != SVt_PVHV); \
1277 assert(!isGV_with_GP(sv)); \
1278 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1279 #define SvLEN_set(sv, val) \
1280 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1281 assert(SvTYPE(sv) != SVt_PVAV); \
1282 assert(SvTYPE(sv) != SVt_PVHV); \
1283 assert(!isGV_with_GP(sv)); \
1284 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1285 #define SvEND_set(sv, val) \
1286 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1287 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
1289 #define SvPV_renew(sv,n) \
1290 STMT_START { SvLEN_set(sv, n); \
1291 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1292 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1293 (MEM_SIZE)((n))))); \
1296 #define SvPV_shrink_to_cur(sv) STMT_START { \
1297 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1298 SvPV_renew(sv, _lEnGtH); \
1301 #define SvPV_free(sv) \
1303 assert(SvTYPE(sv) >= SVt_PV); \
1306 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \
1307 SvFLAGS(sv) &= ~SVf_OOK; \
1309 Safefree(SvPVX(sv)); \
1313 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1314 # define BmRARE(sv) \
1315 (*({ SV *const _svi = (SV *) (sv); \
1316 assert(SvTYPE(_svi) == SVt_PVBM); \
1317 assert(SvVALID(_svi)); \
1318 &(((XPVBM*) SvANY(_svi))->xbm_rare); \
1320 # define BmUSEFUL(sv) \
1321 (*({ SV *const _svi = (SV *) (sv); \
1322 assert(SvTYPE(_svi) == SVt_PVBM); \
1323 assert(SvVALID(_svi)); \
1324 assert(!SvIOK(_svi)); \
1325 &(((XPVBM*) SvANY(_svi))->xiv_u.xivu_i32); \
1327 # define BmPREVIOUS(sv) \
1328 (*({ SV *const _svi = (SV *) (sv); \
1329 assert(SvTYPE(_svi) == SVt_PVBM); \
1330 assert(SvVALID(_svi)); \
1331 &(((XPVBM*) SvANY(_svi))->xbm_previous); \
1334 # define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
1335 # define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xiv_u.xivu_i32
1336 # define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
1339 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1341 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1342 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1343 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1344 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1346 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1347 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1348 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1349 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1350 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1351 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1352 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1353 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1354 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1355 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1356 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1357 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1358 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1359 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1360 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
1361 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1362 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1364 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1365 #define IoTYPE_RDONLY '<'
1366 #define IoTYPE_WRONLY '>'
1367 #define IoTYPE_RDWR '+'
1368 #define IoTYPE_APPEND 'a'
1369 #define IoTYPE_PIPE '|'
1370 #define IoTYPE_STD '-' /* stdin or stdout */
1371 #define IoTYPE_SOCKET 's'
1372 #define IoTYPE_CLOSED ' '
1373 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1374 #define IoTYPE_NUMERIC '#' /* fdopen */
1377 =for apidoc Am|bool|SvTAINTED|SV* sv
1378 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1381 =for apidoc Am|void|SvTAINTED_on|SV* sv
1382 Marks an SV as tainted if tainting is enabled.
1384 =for apidoc Am|void|SvTAINTED_off|SV* sv
1385 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1386 some of Perl's fundamental security features. XS module authors should not
1387 use this function unless they fully understand all the implications of
1388 unconditionally untainting the value. Untainting should be done in the
1389 standard perl fashion, via a carefully crafted regexp, rather than directly
1390 untainting variables.
1392 =for apidoc Am|void|SvTAINT|SV* sv
1393 Taints an SV if tainting is enabled.
1398 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1400 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1401 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1402 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1404 #define SvTAINT(sv) \
1406 if (PL_tainting) { \
1413 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1414 Like C<SvPV> but will force the SV into containing just a string
1415 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1418 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1419 Like C<SvPV> but will force the SV into containing just a string
1420 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1421 directly. Doesn't process magic.
1423 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1424 Returns a pointer to the string in the SV, or a stringified form of
1425 the SV if the SV does not contain a string. The SV may cache the
1426 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1427 C<SvPVx> for a version which guarantees to evaluate sv only once.
1429 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1430 A version of C<SvPV> which guarantees to evaluate sv only once.
1432 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1433 Like C<SvPV> but doesn't process magic.
1435 =for apidoc Am|char*|SvPV_nolen|SV* sv
1436 Returns a pointer to the string in the SV, or a stringified form of
1437 the SV if the SV does not contain a string. The SV may cache the
1438 stringified form becoming C<SvPOK>. Handles 'get' magic.
1440 =for apidoc Am|IV|SvIV|SV* sv
1441 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1442 version which guarantees to evaluate sv only once.
1444 =for apidoc Am|IV|SvIV_nomg|SV* sv
1445 Like C<SvIV> but doesn't process magic.
1447 =for apidoc Am|IV|SvIVx|SV* sv
1448 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1449 sv only once. Use the more efficient C<SvIV> otherwise.
1451 =for apidoc Am|NV|SvNV|SV* sv
1452 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1453 which guarantees to evaluate sv only once.
1455 =for apidoc Am|NV|SvNVx|SV* sv
1456 Coerces the given SV to a double and returns it. Guarantees to evaluate
1457 sv only once. Use the more efficient C<SvNV> otherwise.
1459 =for apidoc Am|UV|SvUV|SV* sv
1460 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1461 for a version which guarantees to evaluate sv only once.
1463 =for apidoc Am|UV|SvUV_nomg|SV* sv
1464 Like C<SvUV> but doesn't process magic.
1466 =for apidoc Am|UV|SvUVx|SV* sv
1467 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1468 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1470 =for apidoc Am|bool|SvTRUE|SV* sv
1471 Returns a boolean indicating whether Perl would evaluate the SV as true or
1472 false, defined or undefined. Does not handle 'get' magic.
1474 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1475 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1477 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1478 Like C<SvPV>, but converts sv to utf8 first if necessary.
1480 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1481 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1483 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1484 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1486 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1487 Like C<SvPV>, but converts sv to byte representation first if necessary.
1489 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1490 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1492 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1493 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1494 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1497 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1498 Like C<SvPV>, but converts sv to utf8 first if necessary.
1499 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1502 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1503 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1504 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1507 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1508 Like C<SvPV>, but converts sv to byte representation first if necessary.
1509 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1512 =for apidoc Am|bool|SvIsCOW|SV* sv
1513 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1514 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1517 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1518 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1521 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1522 Like C<sv_catpvn> but doesn't process magic.
1524 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1525 Like C<sv_setsv> but doesn't process magic.
1527 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1528 Like C<sv_catsv> but doesn't process magic.
1533 /* Let us hope that bitmaps for UV and IV are the same */
1534 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1535 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1536 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1538 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1539 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1543 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1544 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1545 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1547 #define SvPV_flags(sv, lp, flags) \
1548 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1549 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1550 #define SvPV_flags_const(sv, lp, flags) \
1551 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1552 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1553 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1554 #define SvPV_flags_const_nolen(sv, flags) \
1555 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1556 ? SvPVX_const(sv) : \
1557 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1558 #define SvPV_flags_mutable(sv, lp, flags) \
1559 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1560 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1561 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1563 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1564 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1565 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1567 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1568 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1570 #define SvPV_force_flags(sv, lp, flags) \
1571 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1572 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1573 #define SvPV_force_flags_nolen(sv, flags) \
1574 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1575 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1576 #define SvPV_force_flags_mutable(sv, lp, flags) \
1577 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1578 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1579 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1581 #define SvPV_nolen(sv) \
1582 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1583 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1585 #define SvPV_nolen_const(sv) \
1586 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1587 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1589 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1590 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1591 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1595 #define SvPVutf8(sv, lp) \
1596 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1597 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1599 #define SvPVutf8_force(sv, lp) \
1600 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1601 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1604 #define SvPVutf8_nolen(sv) \
1605 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1606 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1610 #define SvPVbyte(sv, lp) \
1611 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1612 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1614 #define SvPVbyte_force(sv, lp) \
1615 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1616 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1618 #define SvPVbyte_nolen(sv) \
1619 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1620 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1624 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1625 * var to evaluate the arg once; failing that, use a global if possible;
1626 * failing that, call a function to do the work
1629 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1630 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1631 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1633 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1635 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1636 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1637 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1638 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1639 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1640 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1641 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1642 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1643 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1644 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1645 # define SvTRUE(sv) ( \
1649 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1651 (nxpv->xpv_cur > 1 || \
1652 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1659 ? SvNVX(sv) != 0.0 \
1661 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1663 #else /* __GNUC__ */
1665 /* These inlined macros use globals, which will require a thread
1666 * declaration in user code, so we avoid them under threads */
1668 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1669 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1670 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1671 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1672 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1673 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1674 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1675 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1676 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1677 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1678 # define SvTRUE(sv) ( \
1682 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1683 (PL_Xpv->xpv_cur > 1 || \
1684 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1691 ? SvNVX(sv) != 0.0 \
1693 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1694 #endif /* __GNU__ */
1696 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1697 (SVf_FAKE | SVf_READONLY))
1698 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1700 #define SvSHARED_HEK_FROM_PV(pvx) \
1701 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1702 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1704 /* flag values for sv_*_flags functions */
1705 #define SV_IMMEDIATE_UNREF 1
1707 #define SV_COW_DROP_PV 4
1708 #define SV_UTF8_NO_ENCODING 8
1709 #define SV_NOSTEAL 16
1710 #define SV_CONST_RETURN 32
1711 #define SV_MUTABLE_RETURN 64
1712 #define SV_SMAGIC 128
1713 #define SV_HAS_TRAILING_NUL 256
1714 #define SV_COW_SHARED_HASH_KEYS 512
1716 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1717 So only default to doing the COW setup if we're in the core.
1720 # ifndef SV_DO_COW_SVSETSV
1721 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS
1725 #ifndef SV_DO_COW_SVSETSV
1726 # define SV_DO_COW_SVSETSV 0
1730 #define sv_unref(sv) sv_unref_flags(sv, 0)
1731 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1732 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1733 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1735 /* We are about to replace the SV's current value. So if it's copy on write
1736 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1737 the value is about to get thrown away, so drop the PV rather than go to
1738 the effort of making a read-write copy only for it to get immediately
1741 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1742 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1744 #ifdef PERL_OLD_COPY_ON_WRITE
1745 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1746 && Perl_sv_release_IVX(aTHX_ sv)))
1747 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1749 # define SvRELEASE_IVX(sv) SvOOK_off(sv)
1750 #endif /* PERL_OLD_COPY_ON_WRITE */
1752 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1753 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1754 SVf_OOK|SVf_BREAK|SVf_READONLY)
1755 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1757 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1758 sv_force_normal_flags(sv, 0)
1761 /* all these 'functions' are now just macros */
1763 #define sv_pv(sv) SvPV_nolen(sv)
1764 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1765 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1767 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1768 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1769 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1770 #define sv_setsv(dsv, ssv) \
1771 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1772 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1773 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1774 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1775 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1776 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1777 #define sv_catpvn_mg(sv, sstr, slen) \
1778 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1779 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1780 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1781 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1782 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1783 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1784 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1785 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1786 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1787 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1789 /* Should be named SvCatPVN_utf8_upgrade? */
1790 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1793 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1795 sv_setpvn(nsv, sstr, slen); \
1797 sv_utf8_upgrade(nsv); \
1798 sv_catsv(dsv, nsv); \
1802 =for apidoc Am|SV*|newRV_inc|SV* sv
1804 Creates an RV wrapper for an SV. The reference count for the original SV is
1810 #define newRV_inc(sv) newRV(sv)
1812 /* the following macros update any magic values this sv is associated with */
1815 =head1 Magical Functions
1817 =for apidoc Am|void|SvGETMAGIC|SV* sv
1818 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1819 argument more than once.
1821 =for apidoc Am|void|SvSETMAGIC|SV* sv
1822 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1823 argument more than once.
1825 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1826 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1829 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1830 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1831 ssv. May evaluate arguments more than once.
1833 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1834 Like C<SvSetSV>, but does any set magic required afterwards.
1836 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1837 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1839 =for apidoc Am|void|SvSHARE|SV* sv
1840 Arranges for sv to be shared between threads if a suitable module
1843 =for apidoc Am|void|SvLOCK|SV* sv
1844 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1847 =for apidoc Am|void|SvUNLOCK|SV* sv
1848 Releases a mutual exclusion lock on sv if a suitable module
1851 =head1 SV Manipulation Functions
1853 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1854 Expands the character buffer in the SV so that it has room for the
1855 indicated number of bytes (remember to reserve space for an extra trailing
1856 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1857 Returns a pointer to the character buffer.
1862 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1863 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1864 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1866 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1867 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1869 #define SvSetSV_and(dst,src,finally) \
1871 if ((dst) != (src)) { \
1872 sv_setsv(dst, src); \
1876 #define SvSetSV_nosteal_and(dst,src,finally) \
1878 if ((dst) != (src)) { \
1879 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
1884 #define SvSetSV(dst,src) \
1885 SvSetSV_and(dst,src,/*nothing*/;)
1886 #define SvSetSV_nosteal(dst,src) \
1887 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1889 #define SvSetMagicSV(dst,src) \
1890 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1891 #define SvSetMagicSV_nosteal(dst,src) \
1892 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1895 #if !defined(SKIP_DEBUGGING)
1896 #define SvPEEK(sv) sv_peek(sv)
1898 #define SvPEEK(sv) ""
1901 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1903 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1905 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1906 /* If I give every macro argument a different name, then there won't be bugs
1907 where nested macros get confused. Been there, done that. */
1908 #define isGV_with_GP(pwadak) \
1909 (((SvFLAGS(pwadak) & (SVp_POK|SVp_SCREAM)) == SVp_SCREAM) \
1910 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
1912 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1913 #define SvGROW_mutable(sv,len) \
1914 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1915 #define Sv_Grow sv_grow
1917 #define CLONEf_COPY_STACKS 1
1918 #define CLONEf_KEEP_PTR_TABLE 2
1919 #define CLONEf_CLONE_HOST 4
1920 #define CLONEf_JOIN_IN 8
1922 struct clone_params {
1925 PerlInterpreter *proto_perl;
1930 * c-indentation-style: bsd
1932 * indent-tabs-mode: t
1935 * ex: set ts=8 sts=4 sw=4 noet: