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|SV*|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|SV*|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|SV*|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|SV*|SvREFCNT_inc|SV* sv
186 Increments the reference count of the given SV.
188 =for apidoc Am|void|SvREFCNT_dec|SV* sv
189 Decrements the reference count of the given SV.
191 =for apidoc Am|svtype|SvTYPE|SV* sv
192 Returns the type of the SV. See C<svtype>.
194 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
195 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
196 perform the upgrade if necessary. See C<svtype>.
201 #define SvANY(sv) (sv)->sv_any
202 #define SvFLAGS(sv) (sv)->sv_flags
203 #define SvREFCNT(sv) (sv)->sv_refcnt
205 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
206 # define SvREFCNT_inc(sv) \
208 SV * const _sv = (SV*)(sv); \
213 # define SvREFCNT_inc_simple(sv) \
219 # define SvREFCNT_inc_NN(sv) \
221 SV * const _sv = (SV*)(sv); \
225 # define SvREFCNT_inc_void(sv) \
227 SV * const _sv = (SV*)(sv); \
229 (void)(SvREFCNT(_sv)++); \
232 # define SvREFCNT_inc(sv) \
233 ((PL_Sv=(SV*)(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
234 # define SvREFCNT_inc_simple(sv) \
235 ((sv) ? (SvREFCNT(sv)++,(SV*)(sv)) : NULL)
236 # define SvREFCNT_inc_NN(sv) \
237 (PL_Sv=(SV*)(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
238 # define SvREFCNT_inc_void(sv) \
239 (void)((PL_Sv=(SV*)(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
242 /* These guys don't need the curly blocks */
243 #define SvREFCNT_inc_simple_void(sv) if (sv) (SvREFCNT(sv)++);
244 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),(SV*)(sv))
245 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
246 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
248 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
249 # define SvREFCNT_dec(sv) \
251 SV * const _sv = (SV*)(sv); \
253 if (SvREFCNT(_sv)) { \
254 if (--(SvREFCNT(_sv)) == 0) \
255 Perl_sv_free2(aTHX_ _sv); \
262 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
265 #define SVTYPEMASK 0xff
266 #define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
268 /* Sadly there are some parts of the core that have pointers to already-freed
269 SV heads, and rely on being able to tell that they are now free. So mark
270 them all by using a consistent macro. */
271 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
273 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
275 #define SVf_IOK 0x00000100 /* has valid public integer value */
276 #define SVf_NOK 0x00000200 /* has valid public numeric value */
277 #define SVf_POK 0x00000400 /* has valid public pointer value */
278 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
280 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
281 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
282 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
283 #define SVp_SCREAM 0x00008000 /* has been studied? */
284 #define SVphv_CLONEABLE 0x00008000 /* PVHV (stashes) clone its objects */
286 #define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
287 #define SVs_PADTMP 0x00020000 /* in use as tmp */
288 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
289 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
290 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
291 #define SVs_TEMP 0x00080000 /* string is stealable? */
292 #define SVs_OBJECT 0x00100000 /* is "blessed" */
293 #define SVs_GMG 0x00200000 /* has magical get method */
294 #define SVs_SMG 0x00400000 /* has magical set method */
295 #define SVs_RMG 0x00800000 /* has random magical methods */
297 #define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
298 1: SV head arena wasn't malloc()ed
299 2: in conjunction with SVf_READONLY
300 marks a shared hash key scalar
301 (SvLEN == 0) or a copy on write
302 string (SvLEN != 0) [SvIsCOW(sv)]
303 3: For PVCV, whether CvUNIQUE(cv)
304 refers to an eval or once only
305 [CvEVAL(cv), CvSPECIAL(cv)]
306 4: Whether the regexp pointer is in
307 fact an offset [SvREPADTMP(sv)]
308 5: On a pad name SV, that slot in the
309 frame AV is a REFCNT'ed reference
310 to a lexical from "outside".
312 #define SVf_OOK 0x02000000 /* has valid offset value
313 For a PVHV this means that a
314 hv_aux struct is present after the
316 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used
317 * by SV's in final arena cleanup */
318 #define SVf_READONLY 0x08000000 /* may not be modified */
323 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
325 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
326 SVp_IOK|SVp_NOK|SVp_POK|SVp_SCREAM)
328 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
330 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
331 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
332 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
334 /* Some private flags. */
337 #define SVphv_REHASH 0x10000000 /* PVHV is recalculating hash values */
339 #define SVphv_SHAREKEYS 0x20000000 /* PVHV
340 keys live on shared string table */
341 /* PVNV, PVMG, PVGV, presumably only inside pads */
342 #define SVpad_NAME 0x40000000 /* This SV is a name in the PAD, so
343 SVpad_TYPED and SVpad_OUR apply */
345 #define SVpav_REAL 0x40000000 /* free old entries */
347 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
349 #define SVpbm_TAIL 0x40000000
351 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
353 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
354 /* Presumably IVs aren't stored in pads */
355 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
357 #define SVpav_REIFY 0x80000000 /* can become real */
359 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
361 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
363 #define SVpbm_VALID 0x80000000
364 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
365 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
370 NV xnv_nv; /* numeric value, if any */
373 STRLEN xpv_cur; /* length of svu_pv as a C string */
374 STRLEN xpv_len; /* allocated size */
378 typedef struct xpv xpv_allocated;
381 STRLEN xpv_cur; /* length of svu_pv as a C string */
382 STRLEN xpv_len; /* allocated size */
388 NV xnv_nv; /* numeric value, if any */
391 STRLEN xpv_cur; /* length of svu_pv as a C string */
392 STRLEN xpv_len; /* allocated size */
394 IV xivu_iv; /* integer value or pv offset */
403 typedef struct xpviv xpviv_allocated;
406 STRLEN xpv_cur; /* length of svu_pv as a C string */
407 STRLEN xpv_len; /* allocated size */
409 IV xivu_iv; /* integer value or pv offset */
418 #define xiv_iv xiv_u.xivu_iv
422 NV xnv_nv; /* numeric value, if any */
425 STRLEN xpv_cur; /* length of svu_pv as a C string */
426 STRLEN xpv_len; /* allocated size */
429 UV xuvu_uv; /* unsigned value or pv offset */
435 #define xuv_uv xuv_u.xuvu_uv
439 NV xnv_nv; /* numeric value, if any */
442 STRLEN xpv_cur; /* length of svu_pv as a C string */
443 STRLEN xpv_len; /* allocated size */
445 IV xivu_iv; /* integer value or pv offset */
453 /* These structure must match the beginning of struct xpvhv in hv.h. */
456 NV xnv_nv; /* numeric value, if any */
459 STRLEN xpv_cur; /* length of svu_pv as a C string */
460 STRLEN xpv_len; /* allocated size */
462 IV xivu_iv; /* integer value or pv offset */
469 MAGIC* xmg_magic; /* linked list of magicalness */
470 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
472 HV* xmg_stash; /* class package */
477 NV xnv_nv; /* numeric value, if any */
480 STRLEN xpv_cur; /* length of svu_pv as a C string */
481 STRLEN xpv_len; /* allocated size */
483 IV xivu_iv; /* integer value or pv offset */
487 HEK * xivu_namehek; /* GvNAME */
490 MAGIC* xmg_magic; /* linked list of magicalness */
491 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
493 HV* xmg_stash; /* class package */
498 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
499 * y=alem/helem/iter t=tie T=tied HE */
505 HV * xgv_stash; /* The stash of this GV */
507 STRLEN xpv_cur; /* xgv_flags */
508 STRLEN xpv_len; /* 0 */
514 HEK * xivu_namehek; /* GvNAME */
517 MAGIC* xmg_magic; /* linked list of magicalness */
518 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
520 HV* xmg_stash; /* class package */
526 NV xnv_nv; /* numeric value, if any */
529 STRLEN xpv_cur; /* length of svu_pv as a C string */
530 STRLEN xpv_len; /* allocated size */
532 IV xivu_iv; /* integer value or pv offset */
539 MAGIC* xmg_magic; /* linked list of magicalness */
540 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
542 HV* xmg_stash; /* class package */
544 I32 xbm_useful; /* is this constant pattern being useful? */
545 U16 xbm_previous; /* how many characters in string before rare? */
546 U8 xbm_rare; /* rarest character in string */
549 /* This structure must match XPVCV in cv.h */
551 typedef U16 cv_flags_t;
555 NV xnv_nv; /* numeric value, if any */
558 STRLEN xpv_cur; /* length of svu_pv as a C string */
559 STRLEN xpv_len; /* allocated size */
561 IV xivu_iv; /* PVFMs use the pv offset */
568 MAGIC* xmg_magic; /* linked list of magicalness */
569 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
571 HV* xmg_stash; /* class package */
580 void (*xcv_xsub) (pTHX_ CV*);
586 U32 xcv_outside_seq; /* the COP sequence (at the point of our
587 * compilation) in the lexically enclosing
589 cv_flags_t xcv_flags;
594 STRLEN xpv_cur; /* length of svu_pv as a C string */
595 STRLEN xpv_len; /* allocated size */
597 IV xivu_iv; /* PVFMs use the pv offset */
604 MAGIC* xmg_magic; /* linked list of magicalness */
605 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
607 HV* xmg_stash; /* class package */
616 void (*xcv_xsub) (pTHX_ CV*);
622 U32 xcv_outside_seq; /* the COP sequence (at the point of our
623 * compilation) in the lexically enclosing
625 cv_flags_t xcv_flags;
631 NV xnv_nv; /* numeric value, if any */
634 STRLEN xpv_cur; /* length of svu_pv as a C string */
635 STRLEN xpv_len; /* allocated size */
637 IV xivu_iv; /* integer value or pv offset */
644 MAGIC* xmg_magic; /* linked list of magicalness */
645 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
647 HV* xmg_stash; /* class package */
649 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
650 PerlIO * xio_ofp; /* but sockets need separate streams */
651 /* Cray addresses everything by word boundaries (64 bits) and
652 * code and data pointers cannot be mixed (which is exactly what
653 * Perl_filter_add() tries to do with the dirp), hence the following
654 * union trick (as suggested by Gurusamy Sarathy).
655 * For further information see Geir Johansen's problem report titled
656 [ID 20000612.002] Perl problem on Cray system
657 * The any pointer (known as IoANY()) will also be a good place
658 * to hang any IO disciplines to.
661 DIR * xiou_dirp; /* for opendir, readdir, etc */
662 void * xiou_any; /* for alignment */
664 IV xio_lines; /* $. */
665 IV xio_page; /* $% */
666 IV xio_page_len; /* $= */
667 IV xio_lines_left; /* $- */
668 char * xio_top_name; /* $^ */
669 GV * xio_top_gv; /* $^ */
670 char * xio_fmt_name; /* $~ */
671 GV * xio_fmt_gv; /* $~ */
672 char * xio_bottom_name;/* $^B */
673 GV * xio_bottom_gv; /* $^B */
674 short xio_subprocess; /* -| or |- */
678 #define xio_dirp xio_dirpu.xiou_dirp
679 #define xio_any xio_dirpu.xiou_any
681 #define IOf_ARGV 1 /* this fp iterates over ARGV */
682 #define IOf_START 2 /* check for null ARGV and substitute '-' */
683 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
684 #define IOf_DIDTOP 8 /* just did top of form */
685 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
686 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
687 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
689 /* The following macros define implementation-independent predicates on SVs. */
692 =for apidoc Am|bool|SvNIOK|SV* sv
693 Returns a boolean indicating whether the SV contains a number, integer or
696 =for apidoc Am|bool|SvNIOKp|SV* sv
697 Returns a boolean indicating whether the SV contains a number, integer or
698 double. Checks the B<private> setting. Use C<SvNIOK>.
700 =for apidoc Am|void|SvNIOK_off|SV* sv
701 Unsets the NV/IV status of an SV.
703 =for apidoc Am|bool|SvOK|SV* sv
704 Returns a boolean indicating whether the value is an SV. It also tells
705 whether the value is defined or not.
707 =for apidoc Am|bool|SvIOKp|SV* sv
708 Returns a boolean indicating whether the SV contains an integer. Checks
709 the B<private> setting. Use C<SvIOK>.
711 =for apidoc Am|bool|SvNOKp|SV* sv
712 Returns a boolean indicating whether the SV contains a double. Checks the
713 B<private> setting. Use C<SvNOK>.
715 =for apidoc Am|bool|SvPOKp|SV* sv
716 Returns a boolean indicating whether the SV contains a character string.
717 Checks the B<private> setting. Use C<SvPOK>.
719 =for apidoc Am|bool|SvIOK|SV* sv
720 Returns a boolean indicating whether the SV contains an integer.
722 =for apidoc Am|void|SvIOK_on|SV* sv
723 Tells an SV that it is an integer.
725 =for apidoc Am|void|SvIOK_off|SV* sv
726 Unsets the IV status of an SV.
728 =for apidoc Am|void|SvIOK_only|SV* sv
729 Tells an SV that it is an integer and disables all other OK bits.
731 =for apidoc Am|void|SvIOK_only_UV|SV* sv
732 Tells and SV that it is an unsigned integer and disables all other OK bits.
734 =for apidoc Am|bool|SvIOK_UV|SV* sv
735 Returns a boolean indicating whether the SV contains an unsigned integer.
737 =for apidoc Am|void|SvUOK|SV* sv
738 Returns a boolean indicating whether the SV contains an unsigned integer.
740 =for apidoc Am|bool|SvIOK_notUV|SV* sv
741 Returns a boolean indicating whether the SV contains a signed integer.
743 =for apidoc Am|bool|SvNOK|SV* sv
744 Returns a boolean indicating whether the SV contains a double.
746 =for apidoc Am|void|SvNOK_on|SV* sv
747 Tells an SV that it is a double.
749 =for apidoc Am|void|SvNOK_off|SV* sv
750 Unsets the NV status of an SV.
752 =for apidoc Am|void|SvNOK_only|SV* sv
753 Tells an SV that it is a double and disables all other OK bits.
755 =for apidoc Am|bool|SvPOK|SV* sv
756 Returns a boolean indicating whether the SV contains a character
759 =for apidoc Am|void|SvPOK_on|SV* sv
760 Tells an SV that it is a string.
762 =for apidoc Am|void|SvPOK_off|SV* sv
763 Unsets the PV status of an SV.
765 =for apidoc Am|void|SvPOK_only|SV* sv
766 Tells an SV that it is a string and disables all other OK bits.
767 Will also turn off the UTF-8 status.
769 =for apidoc Am|bool|SvVOK|SV* sv
770 Returns a boolean indicating whether the SV contains a v-string.
772 =for apidoc Am|bool|SvOOK|SV* sv
773 Returns a boolean indicating whether the SvIVX is a valid offset value for
774 the SvPVX. This hack is used internally to speed up removal of characters
775 from the beginning of a SvPV. When SvOOK is true, then the start of the
776 allocated string buffer is really (SvPVX - SvIVX).
778 =for apidoc Am|bool|SvROK|SV* sv
779 Tests if the SV is an RV.
781 =for apidoc Am|void|SvROK_on|SV* sv
782 Tells an SV that it is an RV.
784 =for apidoc Am|void|SvROK_off|SV* sv
785 Unsets the RV status of an SV.
787 =for apidoc Am|SV*|SvRV|SV* sv
788 Dereferences an RV to return the SV.
790 =for apidoc Am|IV|SvIVX|SV* sv
791 Returns the raw value in the SV's IV slot, without checks or conversions.
792 Only use when you are sure SvIOK is true. See also C<SvIV()>.
794 =for apidoc Am|UV|SvUVX|SV* sv
795 Returns the raw value in the SV's UV slot, without checks or conversions.
796 Only use when you are sure SvIOK is true. See also C<SvUV()>.
798 =for apidoc Am|NV|SvNVX|SV* sv
799 Returns the raw value in the SV's NV slot, without checks or conversions.
800 Only use when you are sure SvNOK is true. See also C<SvNV()>.
802 =for apidoc Am|char*|SvPVX|SV* sv
803 Returns a pointer to the physical string in the SV. The SV must contain a
806 =for apidoc Am|STRLEN|SvCUR|SV* sv
807 Returns the length of the string which is in the SV. See C<SvLEN>.
809 =for apidoc Am|STRLEN|SvLEN|SV* sv
810 Returns the size of the string buffer in the SV, not including any part
811 attributable to C<SvOOK>. See C<SvCUR>.
813 =for apidoc Am|char*|SvEND|SV* sv
814 Returns a pointer to the last character in the string which is in the SV.
815 See C<SvCUR>. Access the character as *(SvEND(sv)).
817 =for apidoc Am|HV*|SvSTASH|SV* sv
818 Returns the stash of the SV.
820 =for apidoc Am|void|SvIV_set|SV* sv|IV val
821 Set the value of the IV pointer in sv to val. It is possible to perform
822 the same function of this macro with an lvalue assignment to C<SvIVX>.
823 With future Perls, however, it will be more efficient to use
824 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
826 =for apidoc Am|void|SvNV_set|SV* sv|NV val
827 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
829 =for apidoc Am|void|SvPV_set|SV* sv|char* val
830 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
832 =for apidoc Am|void|SvUV_set|SV* sv|UV val
833 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
835 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
836 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
838 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
839 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
841 =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
842 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
844 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
845 Set the current length of the string which is in the SV. See C<SvCUR>
848 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
849 Set the actual length of the string which is in the SV. See C<SvIV_set>.
854 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
855 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
856 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
857 SVp_IOK|SVp_NOK|SVf_IVisUV))
859 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
860 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
861 #define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
863 #define assert_not_ROK(sv)
864 #define assert_not_glob(sv)
867 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
868 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
869 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
870 SVf_IVisUV|SVf_UTF8), \
872 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
873 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
877 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
878 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
879 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
880 SvFLAGS(sv) |= SVp_IOK)
881 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
882 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
883 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
884 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
885 SvFLAGS(sv) |= SVp_POK)
887 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
888 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
889 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
890 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
891 #define SvIOK_only(sv) (SvOK_off(sv), \
892 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
893 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
894 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
896 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
897 == (SVf_IOK|SVf_IVisUV))
898 #define SvUOK(sv) SvIOK_UV(sv)
899 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
902 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
903 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
904 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
906 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
907 #define SvNOK_on(sv) (assert_not_glob(sv) \
908 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
909 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
910 #define SvNOK_only(sv) (SvOK_off(sv), \
911 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
914 =for apidoc Am|bool|SvUTF8|SV* sv
915 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
917 =for apidoc Am|void|SvUTF8_on|SV *sv
918 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
919 Do not use frivolously.
921 =for apidoc Am|void|SvUTF8_off|SV *sv
922 Unsets the UTF-8 status of an SV.
924 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
925 Tells an SV that it is a string and disables all other OK bits,
926 and leaves the UTF-8 status as it was.
931 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
933 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
934 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
935 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
937 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
938 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
939 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
940 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
941 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
942 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
943 SVf_IVisUV|SVf_UTF8), \
944 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
945 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
946 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
948 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
950 #define SvVOK(sv) (SvMAGICAL(sv) \
951 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
952 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
953 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
954 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
956 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
957 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
958 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
960 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
961 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
962 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
964 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
965 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
966 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
968 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
969 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
970 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
972 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
973 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
974 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
976 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
977 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
978 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
980 #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
981 #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
982 #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
984 #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
987 #define Gv_AMG(stash) \
988 (HV_AMAGICmb(stash) && \
989 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
991 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
993 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
994 == (SVf_ROK|SVprv_WEAKREF))
995 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
996 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
998 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1000 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
1001 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
1002 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
1004 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
1005 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1006 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1008 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
1009 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
1011 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1012 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1013 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1015 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1016 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1017 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1019 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
1020 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1021 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1023 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1024 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1025 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1027 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
1028 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
1029 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
1031 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1032 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1033 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1035 #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
1036 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1037 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1039 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
1040 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1041 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
1044 /* The following uses the FAKE flag to show that a regex pointer is infact
1045 its own offset in the regexpad for ithreads */
1046 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
1047 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
1048 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
1051 #define SvPAD_TYPED(sv) \
1052 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1053 #define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1055 #define SvPAD_OUR(sv) \
1056 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1057 #define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1059 #define OURSTASH(sv) \
1060 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1061 #define OURSTASH_set(sv, st) \
1063 assert(SvTYPE(sv) == SVt_PVMG); \
1064 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1067 #ifdef PERL_DEBUG_COW
1068 #define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1070 #define SvRV(sv) ((sv)->sv_u.svu_rv)
1072 #define SvRVx(sv) SvRV(sv)
1074 #ifdef PERL_DEBUG_COW
1075 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1076 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1077 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1078 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1079 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1080 /* Don't test the core XS code yet. */
1081 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1082 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1084 # define SvPVX(sv) SvPVX_mutable(sv)
1086 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1087 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1088 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1091 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1092 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
1094 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1095 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
1098 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1099 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1101 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1102 /* These get expanded inside other macros that already use a variable _sv */
1103 # define SvPVX(sv) \
1104 (*({ SV *const _svi = (SV *) sv; \
1105 assert(SvTYPE(_svi) >= SVt_PV); \
1106 assert(SvTYPE(_svi) != SVt_PVAV); \
1107 assert(SvTYPE(_svi) != SVt_PVHV); \
1108 assert(!isGV_with_GP(_svi)); \
1109 &((_svi)->sv_u.svu_pv); \
1111 # define SvCUR(sv) \
1112 (*({ SV *const _svi = (SV *) sv; \
1113 assert(SvTYPE(_svi) >= SVt_PV); \
1114 assert(SvTYPE(_svi) != SVt_PVAV); \
1115 assert(SvTYPE(_svi) != SVt_PVHV); \
1116 assert(!isGV_with_GP(_svi)); \
1117 &(((XPV*) SvANY(_svi))->xpv_cur); \
1119 # define SvIVX(sv) \
1120 (*({ SV *const _svi = (SV *) sv; \
1121 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1122 assert(SvTYPE(_svi) != SVt_PVAV); \
1123 assert(SvTYPE(_svi) != SVt_PVHV); \
1124 assert(SvTYPE(_svi) != SVt_PVCV); \
1125 assert(!isGV_with_GP(_svi)); \
1126 &(((XPVIV*) SvANY(_svi))->xiv_iv); \
1128 # define SvUVX(sv) \
1129 (*({ SV *const _svi = (SV *) sv; \
1130 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1131 assert(SvTYPE(_svi) != SVt_PVAV); \
1132 assert(SvTYPE(_svi) != SVt_PVHV); \
1133 assert(SvTYPE(_svi) != SVt_PVCV); \
1134 assert(!isGV_with_GP(_svi)); \
1135 &(((XPVUV*) SvANY(_svi))->xuv_uv); \
1137 # define SvNVX(sv) \
1138 (*({ SV *const _svi = (SV *) sv; \
1139 assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \
1140 assert(SvTYPE(_svi) != SVt_PVAV); \
1141 assert(SvTYPE(_svi) != SVt_PVHV); \
1142 assert(SvTYPE(_svi) != SVt_PVFM); \
1143 assert(!isGV_with_GP(_svi)); \
1144 &(((XPVNV*) SvANY(_svi))->xnv_u.xnv_nv); \
1146 # define SvMAGIC(sv) \
1147 (*({ SV *const _svi = (SV *) sv; \
1148 assert(SvTYPE(_svi) >= SVt_PVMG); \
1149 &(((XPVMG*) SvANY(_svi))->xmg_u.xmg_magic); \
1151 # define SvSTASH(sv) \
1152 (*({ SV *const _svi = (SV *) sv; \
1153 assert(SvTYPE(_svi) >= SVt_PVMG); \
1154 &(((XPVMG*) SvANY(_svi))->xmg_stash); \
1157 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1158 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1159 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1160 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1161 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1162 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1163 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1168 /* Given that these two are new, there can't be any existing code using them
1170 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1171 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1173 /* Except for the poison code, which uses & to scribble over the pointer after
1174 free() is called. */
1175 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1176 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1179 #define SvIVXx(sv) SvIVX(sv)
1180 #define SvUVXx(sv) SvUVX(sv)
1181 #define SvNVXx(sv) SvNVX(sv)
1182 #define SvPVXx(sv) SvPVX(sv)
1183 #define SvLENx(sv) SvLEN(sv)
1184 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1187 /* Ask a scalar nicely to try to become an IV, if possible.
1188 Not guaranteed to stay returning void */
1189 /* Macro won't actually call sv_2iv if already IOK */
1190 #define SvIV_please(sv) \
1191 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1192 (void) SvIV(sv); } STMT_END
1193 #define SvIV_set(sv, val) \
1194 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1195 assert(!isGV_with_GP(sv)); \
1196 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1197 #define SvNV_set(sv, val) \
1198 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1199 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1200 assert(!isGV_with_GP(sv)); \
1201 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1202 #define SvPV_set(sv, val) \
1203 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1204 assert(!isGV_with_GP(sv)); \
1205 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1206 #define SvUV_set(sv, val) \
1207 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1208 assert(!isGV_with_GP(sv)); \
1209 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1210 #define SvRV_set(sv, val) \
1211 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
1212 assert(!isGV_with_GP(sv)); \
1213 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1214 #define SvMAGIC_set(sv, val) \
1215 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1216 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1217 #define SvSTASH_set(sv, val) \
1218 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1219 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1220 #define SvCUR_set(sv, val) \
1221 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1222 assert(!isGV_with_GP(sv)); \
1223 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1224 #define SvLEN_set(sv, val) \
1225 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1226 assert(!isGV_with_GP(sv)); \
1227 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1228 #define SvEND_set(sv, val) \
1229 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1230 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
1232 #define SvPV_renew(sv,n) \
1233 STMT_START { SvLEN_set(sv, n); \
1234 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1235 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1236 (MEM_SIZE)((n))))); \
1239 #define SvPV_shrink_to_cur(sv) STMT_START { \
1240 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1241 SvPV_renew(sv, _lEnGtH); \
1244 #define SvPV_free(sv) \
1246 assert(SvTYPE(sv) >= SVt_PV); \
1249 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \
1250 SvFLAGS(sv) &= ~SVf_OOK; \
1252 Safefree(SvPVX(sv)); \
1256 #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
1257 #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
1258 #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
1260 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1262 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1263 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1264 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1265 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1267 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1268 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1269 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1270 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1271 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1272 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1273 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1274 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1275 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1276 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1277 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1278 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1279 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1280 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1281 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
1282 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1283 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1285 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1286 #define IoTYPE_RDONLY '<'
1287 #define IoTYPE_WRONLY '>'
1288 #define IoTYPE_RDWR '+'
1289 #define IoTYPE_APPEND 'a'
1290 #define IoTYPE_PIPE '|'
1291 #define IoTYPE_STD '-' /* stdin or stdout */
1292 #define IoTYPE_SOCKET 's'
1293 #define IoTYPE_CLOSED ' '
1294 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1295 #define IoTYPE_NUMERIC '#' /* fdopen */
1298 =for apidoc Am|bool|SvTAINTED|SV* sv
1299 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1302 =for apidoc Am|void|SvTAINTED_on|SV* sv
1303 Marks an SV as tainted if tainting is enabled.
1305 =for apidoc Am|void|SvTAINTED_off|SV* sv
1306 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1307 some of Perl's fundamental security features. XS module authors should not
1308 use this function unless they fully understand all the implications of
1309 unconditionally untainting the value. Untainting should be done in the
1310 standard perl fashion, via a carefully crafted regexp, rather than directly
1311 untainting variables.
1313 =for apidoc Am|void|SvTAINT|SV* sv
1314 Taints an SV if tainting is enabled.
1319 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1321 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1322 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1323 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1325 #define SvTAINT(sv) \
1327 if (PL_tainting) { \
1334 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1335 Like C<SvPV> but will force the SV into containing just a string
1336 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1339 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1340 Like C<SvPV> but will force the SV into containing just a string
1341 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1342 directly. Doesn't process magic.
1344 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1345 Returns a pointer to the string in the SV, or a stringified form of
1346 the SV if the SV does not contain a string. The SV may cache the
1347 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1348 C<SvPVx> for a version which guarantees to evaluate sv only once.
1350 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1351 A version of C<SvPV> which guarantees to evaluate sv only once.
1353 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1354 Like C<SvPV> but doesn't process magic.
1356 =for apidoc Am|char*|SvPV_nolen|SV* sv
1357 Returns a pointer to the string in the SV, or a stringified form of
1358 the SV if the SV does not contain a string. The SV may cache the
1359 stringified form becoming C<SvPOK>. Handles 'get' magic.
1361 =for apidoc Am|IV|SvIV|SV* sv
1362 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1363 version which guarantees to evaluate sv only once.
1365 =for apidoc Am|IV|SvIV_nomg|SV* sv
1366 Like C<SvIV> but doesn't process magic.
1368 =for apidoc Am|IV|SvIVx|SV* sv
1369 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1370 sv only once. Use the more efficient C<SvIV> otherwise.
1372 =for apidoc Am|NV|SvNV|SV* sv
1373 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1374 which guarantees to evaluate sv only once.
1376 =for apidoc Am|NV|SvNVx|SV* sv
1377 Coerces the given SV to a double and returns it. Guarantees to evaluate
1378 sv only once. Use the more efficient C<SvNV> otherwise.
1380 =for apidoc Am|UV|SvUV|SV* sv
1381 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1382 for a version which guarantees to evaluate sv only once.
1384 =for apidoc Am|UV|SvUV_nomg|SV* sv
1385 Like C<SvUV> but doesn't process magic.
1387 =for apidoc Am|UV|SvUVx|SV* sv
1388 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1389 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1391 =for apidoc Am|bool|SvTRUE|SV* sv
1392 Returns a boolean indicating whether Perl would evaluate the SV as true or
1393 false, defined or undefined. Does not handle 'get' magic.
1395 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1396 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1398 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1399 Like C<SvPV>, but converts sv to utf8 first if necessary.
1401 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1402 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1404 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1405 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1407 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1408 Like C<SvPV>, but converts sv to byte representation first if necessary.
1410 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1411 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1413 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1414 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1415 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1418 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1419 Like C<SvPV>, but converts sv to utf8 first if necessary.
1420 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1423 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1424 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1425 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1428 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1429 Like C<SvPV>, but converts sv to byte representation first if necessary.
1430 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1433 =for apidoc Am|bool|SvIsCOW|SV* sv
1434 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1435 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1438 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1439 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1442 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1443 Like C<sv_catpvn> but doesn't process magic.
1445 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1446 Like C<sv_setsv> but doesn't process magic.
1448 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1449 Like C<sv_catsv> but doesn't process magic.
1454 /* Let us hope that bitmaps for UV and IV are the same */
1455 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1456 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1457 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1459 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1460 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1464 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1465 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1466 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1468 #define SvPV_flags(sv, lp, flags) \
1469 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1470 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1471 #define SvPV_flags_const(sv, lp, flags) \
1472 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1473 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1474 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1475 #define SvPV_flags_const_nolen(sv, flags) \
1476 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1477 ? SvPVX_const(sv) : \
1478 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1479 #define SvPV_flags_mutable(sv, lp, flags) \
1480 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1481 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1482 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1484 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1485 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1486 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1488 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1489 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1491 #define SvPV_force_flags(sv, lp, flags) \
1492 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1493 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1494 #define SvPV_force_flags_nolen(sv, flags) \
1495 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1496 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1497 #define SvPV_force_flags_mutable(sv, lp, flags) \
1498 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1499 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1500 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1502 #define SvPV_nolen(sv) \
1503 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1504 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1506 #define SvPV_nolen_const(sv) \
1507 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1508 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1510 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1511 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1512 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1516 #define SvPVutf8(sv, lp) \
1517 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1518 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1520 #define SvPVutf8_force(sv, lp) \
1521 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1522 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1525 #define SvPVutf8_nolen(sv) \
1526 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1527 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1531 #define SvPVbyte(sv, lp) \
1532 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1533 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1535 #define SvPVbyte_force(sv, lp) \
1536 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1537 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1539 #define SvPVbyte_nolen(sv) \
1540 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1541 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1545 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1546 * var to evaluate the arg once; failing that, use a global if possible;
1547 * failing that, call a function to do the work
1550 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1551 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1552 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1554 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1556 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1557 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1558 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1559 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1560 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1561 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1562 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1563 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1564 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1565 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1566 # define SvTRUE(sv) ( \
1570 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1572 (nxpv->xpv_cur > 1 || \
1573 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1580 ? SvNVX(sv) != 0.0 \
1582 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1584 #else /* __GNUC__ */
1586 /* These inlined macros use globals, which will require a thread
1587 * declaration in user code, so we avoid them under threads */
1589 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1590 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1591 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1592 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1593 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1594 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1595 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1596 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1597 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1598 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1599 # define SvTRUE(sv) ( \
1603 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1604 (PL_Xpv->xpv_cur > 1 || \
1605 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1612 ? SvNVX(sv) != 0.0 \
1614 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1615 #endif /* __GNU__ */
1617 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1618 (SVf_FAKE | SVf_READONLY))
1619 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1621 #define SvSHARED_HEK_FROM_PV(pvx) \
1622 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1623 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1625 /* flag values for sv_*_flags functions */
1626 #define SV_IMMEDIATE_UNREF 1
1628 #define SV_COW_DROP_PV 4
1629 #define SV_UTF8_NO_ENCODING 8
1630 #define SV_NOSTEAL 16
1631 #define SV_CONST_RETURN 32
1632 #define SV_MUTABLE_RETURN 64
1633 #define SV_SMAGIC 128
1635 #define sv_unref(sv) sv_unref_flags(sv, 0)
1636 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1638 /* We are about to replace the SV's current value. So if it's copy on write
1639 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1640 the value is about to get thrown away, so drop the PV rather than go to
1641 the effort of making a read-write copy only for it to get immediately
1644 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1645 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1647 #ifdef PERL_OLD_COPY_ON_WRITE
1648 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1649 && Perl_sv_release_IVX(aTHX_ sv)))
1650 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1652 # define SvRELEASE_IVX(sv) SvOOK_off(sv)
1653 #endif /* PERL_OLD_COPY_ON_WRITE */
1655 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1656 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1657 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1658 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1660 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1661 sv_force_normal_flags(sv, 0)
1664 /* all these 'functions' are now just macros */
1666 #define sv_pv(sv) SvPV_nolen(sv)
1667 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1668 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1670 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1671 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1672 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1673 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1674 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1675 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1676 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1677 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1678 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1679 #define sv_catpvn_mg(sv, sstr, slen) \
1680 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1681 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1682 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1683 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1684 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1685 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1686 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1687 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1688 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1689 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1691 /* Should be named SvCatPVN_utf8_upgrade? */
1692 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1695 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1697 sv_setpvn(nsv, sstr, slen); \
1699 sv_utf8_upgrade(nsv); \
1700 sv_catsv(dsv, nsv); \
1704 =for apidoc Am|SV*|newRV_inc|SV* sv
1706 Creates an RV wrapper for an SV. The reference count for the original SV is
1712 #define newRV_inc(sv) newRV(sv)
1714 /* the following macros update any magic values this sv is associated with */
1717 =head1 Magical Functions
1719 =for apidoc Am|void|SvGETMAGIC|SV* sv
1720 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1721 argument more than once.
1723 =for apidoc Am|void|SvSETMAGIC|SV* sv
1724 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1725 argument more than once.
1727 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1728 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1731 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1732 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1733 ssv. May evaluate arguments more than once.
1735 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1736 Like C<SvSetSV>, but does any set magic required afterwards.
1738 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1739 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1741 =for apidoc Am|void|SvSHARE|SV* sv
1742 Arranges for sv to be shared between threads if a suitable module
1745 =for apidoc Am|void|SvLOCK|SV* sv
1746 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1749 =for apidoc Am|void|SvUNLOCK|SV* sv
1750 Releases a mutual exclusion lock on sv if a suitable module
1753 =head1 SV Manipulation Functions
1755 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1756 Expands the character buffer in the SV so that it has room for the
1757 indicated number of bytes (remember to reserve space for an extra trailing
1758 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1759 Returns a pointer to the character buffer.
1764 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1765 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1766 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1768 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1769 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1771 #define SvSetSV_and(dst,src,finally) \
1773 if ((dst) != (src)) { \
1774 sv_setsv(dst, src); \
1778 #define SvSetSV_nosteal_and(dst,src,finally) \
1780 if ((dst) != (src)) { \
1781 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL); \
1786 #define SvSetSV(dst,src) \
1787 SvSetSV_and(dst,src,/*nothing*/;)
1788 #define SvSetSV_nosteal(dst,src) \
1789 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1791 #define SvSetMagicSV(dst,src) \
1792 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1793 #define SvSetMagicSV_nosteal(dst,src) \
1794 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1797 #if !defined(SKIP_DEBUGGING)
1798 #define SvPEEK(sv) sv_peek(sv)
1800 #define SvPEEK(sv) ""
1803 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1805 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1807 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1808 /* If I give every macro argument a different name, then there won't be bugs
1809 where nested macros get confused. Been there, done that. */
1810 #define isGV_with_GP(pwadak) \
1811 (((SvFLAGS(pwadak) & (SVp_POK|SVp_SCREAM)) == SVp_SCREAM) \
1812 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
1814 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1815 #define SvGROW_mutable(sv,len) \
1816 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1817 #define Sv_Grow sv_grow
1819 #define CLONEf_COPY_STACKS 1
1820 #define CLONEf_KEEP_PTR_TABLE 2
1821 #define CLONEf_CLONE_HOST 4
1822 #define CLONEf_JOIN_IN 8
1824 struct clone_params {
1827 PerlInterpreter *proto_perl;
1832 * c-indentation-style: bsd
1834 * indent-tabs-mode: t
1837 * ex: set ts=8 sts=4 sw=4 noet: