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 SVpad_STATE 0x00010000 /* pad name is a "state" var */
288 #define SVs_PADTMP 0x00020000 /* in use as tmp */
289 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
290 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
291 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
292 #define SVs_TEMP 0x00080000 /* string is stealable? */
293 #define SVs_OBJECT 0x00100000 /* is "blessed" */
294 #define SVs_GMG 0x00200000 /* has magical get method */
295 #define SVs_SMG 0x00400000 /* has magical set method */
296 #define SVs_RMG 0x00800000 /* has random magical methods */
298 #define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
299 1: SV head arena wasn't malloc()ed
300 2: in conjunction with SVf_READONLY
301 marks a shared hash key scalar
302 (SvLEN == 0) or a copy on write
303 string (SvLEN != 0) [SvIsCOW(sv)]
304 3: For PVCV, whether CvUNIQUE(cv)
305 refers to an eval or once only
306 [CvEVAL(cv), CvSPECIAL(cv)]
307 4: Whether the regexp pointer is in
308 fact an offset [SvREPADTMP(sv)]
309 5: On a pad name SV, that slot in the
310 frame AV is a REFCNT'ed reference
311 to a lexical from "outside". */
312 #define SVphv_REHASH SVf_FAKE /* 6: On a PVHV, hash values are being
314 #define SVf_OOK 0x02000000 /* has valid offset value
315 For a PVHV this means that a
316 hv_aux struct is present after the
318 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used
319 * by SV's in final arena cleanup */
320 #define SVf_READONLY 0x08000000 /* may not be modified */
325 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
327 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
328 SVp_IOK|SVp_NOK|SVp_POK|SVp_SCREAM)
330 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
332 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
333 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
334 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
336 /* Some private flags. */
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, SVpad_OUR and
346 #define SVpav_REAL 0x40000000 /* free old entries */
348 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
350 #define SVpbm_TAIL 0x40000000
352 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
354 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
355 /* Presumably IVs aren't stored in pads */
356 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
358 #define SVpav_REIFY 0x80000000 /* can become real */
360 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
362 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
364 #define SVpbm_VALID 0x80000000
365 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
366 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
371 NV xnv_nv; /* numeric value, if any */
374 STRLEN xpv_cur; /* length of svu_pv as a C string */
375 STRLEN xpv_len; /* allocated size */
379 typedef struct xpv xpv_allocated;
382 STRLEN xpv_cur; /* length of svu_pv as a C string */
383 STRLEN xpv_len; /* allocated size */
389 NV xnv_nv; /* numeric value, if any */
392 STRLEN xpv_cur; /* length of svu_pv as a C string */
393 STRLEN xpv_len; /* allocated size */
395 IV xivu_iv; /* integer value or pv offset */
404 typedef struct xpviv xpviv_allocated;
407 STRLEN xpv_cur; /* length of svu_pv as a C string */
408 STRLEN xpv_len; /* allocated size */
410 IV xivu_iv; /* integer value or pv offset */
419 #define xiv_iv xiv_u.xivu_iv
423 NV xnv_nv; /* numeric value, if any */
426 STRLEN xpv_cur; /* length of svu_pv as a C string */
427 STRLEN xpv_len; /* allocated size */
430 UV xuvu_uv; /* unsigned value or pv offset */
436 #define xuv_uv xuv_u.xuvu_uv
440 NV xnv_nv; /* numeric value, if any */
443 STRLEN xpv_cur; /* length of svu_pv as a C string */
444 STRLEN xpv_len; /* allocated size */
446 IV xivu_iv; /* integer value or pv offset */
454 /* These structure must match the beginning of struct xpvhv in hv.h. */
457 NV xnv_nv; /* numeric value, if any */
460 STRLEN xpv_cur; /* length of svu_pv as a C string */
461 STRLEN xpv_len; /* allocated size */
463 IV xivu_iv; /* integer value or pv offset */
470 MAGIC* xmg_magic; /* linked list of magicalness */
471 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
473 HV* xmg_stash; /* class package */
478 NV xnv_nv; /* numeric value, if any */
481 STRLEN xpv_cur; /* length of svu_pv as a C string */
482 STRLEN xpv_len; /* allocated size */
484 IV xivu_iv; /* integer value or pv offset */
488 HEK * xivu_namehek; /* GvNAME */
491 MAGIC* xmg_magic; /* linked list of magicalness */
492 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
494 HV* xmg_stash; /* class package */
499 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
500 * y=alem/helem/iter t=tie T=tied HE */
506 HV * xgv_stash; /* The stash of this GV */
508 STRLEN xpv_cur; /* xgv_flags */
509 STRLEN xpv_len; /* 0 */
515 HEK * xivu_namehek; /* GvNAME */
518 MAGIC* xmg_magic; /* linked list of magicalness */
519 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
521 HV* xmg_stash; /* class package */
527 NV xnv_nv; /* numeric value, if any */
530 STRLEN xpv_cur; /* length of svu_pv as a C string */
531 STRLEN xpv_len; /* allocated size */
533 IV xivu_iv; /* integer value or pv offset */
540 MAGIC* xmg_magic; /* linked list of magicalness */
541 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
543 HV* xmg_stash; /* class package */
545 I32 xbm_useful; /* is this constant pattern being useful? */
546 U16 xbm_previous; /* how many characters in string before rare? */
547 U8 xbm_rare; /* rarest character in string */
550 /* This structure must match XPVCV in cv.h */
552 typedef U16 cv_flags_t;
556 NV xnv_nv; /* numeric value, if any */
559 STRLEN xpv_cur; /* length of svu_pv as a C string */
560 STRLEN xpv_len; /* allocated size */
562 IV xivu_iv; /* PVFMs use the pv offset */
569 MAGIC* xmg_magic; /* linked list of magicalness */
570 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
572 HV* xmg_stash; /* class package */
581 void (*xcv_xsub) (pTHX_ CV*);
587 U32 xcv_outside_seq; /* the COP sequence (at the point of our
588 * compilation) in the lexically enclosing
590 cv_flags_t xcv_flags;
595 STRLEN xpv_cur; /* length of svu_pv as a C string */
596 STRLEN xpv_len; /* allocated size */
598 IV xivu_iv; /* PVFMs use the pv offset */
605 MAGIC* xmg_magic; /* linked list of magicalness */
606 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
608 HV* xmg_stash; /* class package */
617 void (*xcv_xsub) (pTHX_ CV*);
623 U32 xcv_outside_seq; /* the COP sequence (at the point of our
624 * compilation) in the lexically enclosing
626 cv_flags_t xcv_flags;
632 NV xnv_nv; /* numeric value, if any */
635 STRLEN xpv_cur; /* length of svu_pv as a C string */
636 STRLEN xpv_len; /* allocated size */
638 IV xivu_iv; /* integer value or pv offset */
645 MAGIC* xmg_magic; /* linked list of magicalness */
646 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
648 HV* xmg_stash; /* class package */
650 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
651 PerlIO * xio_ofp; /* but sockets need separate streams */
652 /* Cray addresses everything by word boundaries (64 bits) and
653 * code and data pointers cannot be mixed (which is exactly what
654 * Perl_filter_add() tries to do with the dirp), hence the following
655 * union trick (as suggested by Gurusamy Sarathy).
656 * For further information see Geir Johansen's problem report titled
657 [ID 20000612.002] Perl problem on Cray system
658 * The any pointer (known as IoANY()) will also be a good place
659 * to hang any IO disciplines to.
662 DIR * xiou_dirp; /* for opendir, readdir, etc */
663 void * xiou_any; /* for alignment */
665 IV xio_lines; /* $. */
666 IV xio_page; /* $% */
667 IV xio_page_len; /* $= */
668 IV xio_lines_left; /* $- */
669 char * xio_top_name; /* $^ */
670 GV * xio_top_gv; /* $^ */
671 char * xio_fmt_name; /* $~ */
672 GV * xio_fmt_gv; /* $~ */
673 char * xio_bottom_name;/* $^B */
674 GV * xio_bottom_gv; /* $^B */
675 short xio_subprocess; /* -| or |- */
679 #define xio_dirp xio_dirpu.xiou_dirp
680 #define xio_any xio_dirpu.xiou_any
682 #define IOf_ARGV 1 /* this fp iterates over ARGV */
683 #define IOf_START 2 /* check for null ARGV and substitute '-' */
684 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
685 #define IOf_DIDTOP 8 /* just did top of form */
686 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
687 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
688 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
690 /* The following macros define implementation-independent predicates on SVs. */
693 =for apidoc Am|bool|SvNIOK|SV* sv
694 Returns a boolean indicating whether the SV contains a number, integer or
697 =for apidoc Am|bool|SvNIOKp|SV* sv
698 Returns a boolean indicating whether the SV contains a number, integer or
699 double. Checks the B<private> setting. Use C<SvNIOK>.
701 =for apidoc Am|void|SvNIOK_off|SV* sv
702 Unsets the NV/IV status of an SV.
704 =for apidoc Am|bool|SvOK|SV* sv
705 Returns a boolean indicating whether the value is an SV. It also tells
706 whether the value is defined or not.
708 =for apidoc Am|bool|SvIOKp|SV* sv
709 Returns a boolean indicating whether the SV contains an integer. Checks
710 the B<private> setting. Use C<SvIOK>.
712 =for apidoc Am|bool|SvNOKp|SV* sv
713 Returns a boolean indicating whether the SV contains a double. Checks the
714 B<private> setting. Use C<SvNOK>.
716 =for apidoc Am|bool|SvPOKp|SV* sv
717 Returns a boolean indicating whether the SV contains a character string.
718 Checks the B<private> setting. Use C<SvPOK>.
720 =for apidoc Am|bool|SvIOK|SV* sv
721 Returns a boolean indicating whether the SV contains an integer.
723 =for apidoc Am|void|SvIOK_on|SV* sv
724 Tells an SV that it is an integer.
726 =for apidoc Am|void|SvIOK_off|SV* sv
727 Unsets the IV status of an SV.
729 =for apidoc Am|void|SvIOK_only|SV* sv
730 Tells an SV that it is an integer and disables all other OK bits.
732 =for apidoc Am|void|SvIOK_only_UV|SV* sv
733 Tells and SV that it is an unsigned integer and disables all other OK bits.
735 =for apidoc Am|bool|SvIOK_UV|SV* sv
736 Returns a boolean indicating whether the SV contains an unsigned integer.
738 =for apidoc Am|void|SvUOK|SV* sv
739 Returns a boolean indicating whether the SV contains an unsigned integer.
741 =for apidoc Am|bool|SvIOK_notUV|SV* sv
742 Returns a boolean indicating whether the SV contains a signed integer.
744 =for apidoc Am|bool|SvNOK|SV* sv
745 Returns a boolean indicating whether the SV contains a double.
747 =for apidoc Am|void|SvNOK_on|SV* sv
748 Tells an SV that it is a double.
750 =for apidoc Am|void|SvNOK_off|SV* sv
751 Unsets the NV status of an SV.
753 =for apidoc Am|void|SvNOK_only|SV* sv
754 Tells an SV that it is a double and disables all other OK bits.
756 =for apidoc Am|bool|SvPOK|SV* sv
757 Returns a boolean indicating whether the SV contains a character
760 =for apidoc Am|void|SvPOK_on|SV* sv
761 Tells an SV that it is a string.
763 =for apidoc Am|void|SvPOK_off|SV* sv
764 Unsets the PV status of an SV.
766 =for apidoc Am|void|SvPOK_only|SV* sv
767 Tells an SV that it is a string and disables all other OK bits.
768 Will also turn off the UTF-8 status.
770 =for apidoc Am|bool|SvVOK|SV* sv
771 Returns a boolean indicating whether the SV contains a v-string.
773 =for apidoc Am|bool|SvOOK|SV* sv
774 Returns a boolean indicating whether the SvIVX is a valid offset value for
775 the SvPVX. This hack is used internally to speed up removal of characters
776 from the beginning of a SvPV. When SvOOK is true, then the start of the
777 allocated string buffer is really (SvPVX - SvIVX).
779 =for apidoc Am|bool|SvROK|SV* sv
780 Tests if the SV is an RV.
782 =for apidoc Am|void|SvROK_on|SV* sv
783 Tells an SV that it is an RV.
785 =for apidoc Am|void|SvROK_off|SV* sv
786 Unsets the RV status of an SV.
788 =for apidoc Am|SV*|SvRV|SV* sv
789 Dereferences an RV to return the SV.
791 =for apidoc Am|IV|SvIVX|SV* sv
792 Returns the raw value in the SV's IV slot, without checks or conversions.
793 Only use when you are sure SvIOK is true. See also C<SvIV()>.
795 =for apidoc Am|UV|SvUVX|SV* sv
796 Returns the raw value in the SV's UV slot, without checks or conversions.
797 Only use when you are sure SvIOK is true. See also C<SvUV()>.
799 =for apidoc Am|NV|SvNVX|SV* sv
800 Returns the raw value in the SV's NV slot, without checks or conversions.
801 Only use when you are sure SvNOK is true. See also C<SvNV()>.
803 =for apidoc Am|char*|SvPVX|SV* sv
804 Returns a pointer to the physical string in the SV. The SV must contain a
807 =for apidoc Am|STRLEN|SvCUR|SV* sv
808 Returns the length of the string which is in the SV. See C<SvLEN>.
810 =for apidoc Am|STRLEN|SvLEN|SV* sv
811 Returns the size of the string buffer in the SV, not including any part
812 attributable to C<SvOOK>. See C<SvCUR>.
814 =for apidoc Am|char*|SvEND|SV* sv
815 Returns a pointer to the last character in the string which is in the SV.
816 See C<SvCUR>. Access the character as *(SvEND(sv)).
818 =for apidoc Am|HV*|SvSTASH|SV* sv
819 Returns the stash of the SV.
821 =for apidoc Am|void|SvIV_set|SV* sv|IV val
822 Set the value of the IV pointer in sv to val. It is possible to perform
823 the same function of this macro with an lvalue assignment to C<SvIVX>.
824 With future Perls, however, it will be more efficient to use
825 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
827 =for apidoc Am|void|SvNV_set|SV* sv|NV val
828 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
830 =for apidoc Am|void|SvPV_set|SV* sv|char* val
831 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
833 =for apidoc Am|void|SvUV_set|SV* sv|UV val
834 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
836 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
837 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
839 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
840 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
842 =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
843 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
845 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
846 Set the current length of the string which is in the SV. See C<SvCUR>
849 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
850 Set the actual length of the string which is in the SV. See C<SvIV_set>.
855 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
856 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
857 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
858 SVp_IOK|SVp_NOK|SVf_IVisUV))
860 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
861 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
862 #define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
864 #define assert_not_ROK(sv)
865 #define assert_not_glob(sv)
868 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
869 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
870 SvFLAGS(sv) &= ~(SVf_OK| \
871 SVf_IVisUV|SVf_UTF8), \
873 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
874 SvFLAGS(sv) &= ~(SVf_OK| \
878 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
879 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
880 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
881 SvFLAGS(sv) |= SVp_IOK)
882 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
883 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
884 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
885 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
886 SvFLAGS(sv) |= SVp_POK)
888 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
889 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
890 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
891 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
892 #define SvIOK_only(sv) (SvOK_off(sv), \
893 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
894 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
895 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
897 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
898 == (SVf_IOK|SVf_IVisUV))
899 #define SvUOK(sv) SvIOK_UV(sv)
900 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
903 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
904 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
905 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
907 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
908 #define SvNOK_on(sv) (assert_not_glob(sv) \
909 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
910 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
911 #define SvNOK_only(sv) (SvOK_off(sv), \
912 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
915 =for apidoc Am|bool|SvUTF8|SV* sv
916 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
918 =for apidoc Am|void|SvUTF8_on|SV *sv
919 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
920 Do not use frivolously.
922 =for apidoc Am|void|SvUTF8_off|SV *sv
923 Unsets the UTF-8 status of an SV.
925 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
926 Tells an SV that it is a string and disables all other OK bits,
927 and leaves the UTF-8 status as it was.
932 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
934 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
935 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
936 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
938 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
939 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
940 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
941 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
942 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
943 SvFLAGS(sv) &= ~(SVf_OK| \
944 SVf_IVisUV|SVf_UTF8), \
945 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
946 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
947 SvFLAGS(sv) &= ~(SVf_OK| \
949 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
951 #define SvVOK(sv) (SvMAGICAL(sv) \
952 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
953 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
954 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
955 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
957 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
958 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
959 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
961 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
962 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
963 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
965 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
966 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
967 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
969 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
970 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
971 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
973 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
974 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
975 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
977 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
978 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
979 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
981 #define SvAMAGIC(sv) (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
982 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
983 # define SvAMAGIC_on(sv) ({ SV * const kloink = sv; \
984 assert(SvROK(kloink)); \
985 SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
987 # define SvAMAGIC_off(sv) ({ SV * const kloink = sv; \
989 SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
992 # define SvAMAGIC_on(sv) (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
993 # define SvAMAGIC_off(sv) \
994 (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
998 =for apidoc Am|char*|SvGAMAGIC|SV* sv
1000 Returns true if the SV has get magic or overloading. If either is true then
1001 the scalar is active data, and has the potential to return a new value every
1002 time it is accessed. Hence you must be careful to only read it once per user
1003 logical operation and work with that returned value. If neither is true then
1004 the scalar's value cannot change unless written to.
1009 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1011 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
1013 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1014 == (SVf_ROK|SVprv_WEAKREF))
1015 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1016 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1018 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1020 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
1021 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
1022 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
1024 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
1025 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1026 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1028 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
1029 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
1031 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1032 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1033 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1035 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1036 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1037 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1039 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
1040 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1041 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1043 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1044 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1045 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1047 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
1048 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
1049 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
1051 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1052 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1053 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1055 #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
1056 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1057 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1059 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
1060 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1061 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
1064 /* The following uses the FAKE flag to show that a regex pointer is infact
1065 its own offset in the regexpad for ithreads */
1066 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
1067 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
1068 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
1071 #define SvPAD_TYPED(sv) \
1072 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1073 #define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1075 #define SvPAD_OUR(sv) \
1076 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1077 #define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1079 #define SvPAD_STATE(sv) \
1080 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1081 #define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1083 #define OURSTASH(sv) \
1084 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1085 #define OURSTASH_set(sv, st) \
1087 assert(SvTYPE(sv) == SVt_PVMG); \
1088 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1091 #ifdef PERL_DEBUG_COW
1092 #define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1094 #define SvRV(sv) ((sv)->sv_u.svu_rv)
1096 #define SvRVx(sv) SvRV(sv)
1098 #ifdef PERL_DEBUG_COW
1099 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1100 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1101 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1102 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1103 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1104 /* Don't test the core XS code yet. */
1105 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1106 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1108 # define SvPVX(sv) SvPVX_mutable(sv)
1110 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1111 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1112 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1115 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1116 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
1118 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1119 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
1122 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1123 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1125 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1126 /* These get expanded inside other macros that already use a variable _sv */
1127 # define SvPVX(sv) \
1128 (*({ SV *const _svi = (SV *) sv; \
1129 assert(SvTYPE(_svi) >= SVt_PV); \
1130 assert(SvTYPE(_svi) != SVt_PVAV); \
1131 assert(SvTYPE(_svi) != SVt_PVHV); \
1132 assert(!isGV_with_GP(_svi)); \
1133 &((_svi)->sv_u.svu_pv); \
1135 # define SvCUR(sv) \
1136 (*({ SV *const _svi = (SV *) sv; \
1137 assert(SvTYPE(_svi) >= SVt_PV); \
1138 assert(SvTYPE(_svi) != SVt_PVAV); \
1139 assert(SvTYPE(_svi) != SVt_PVHV); \
1140 assert(!isGV_with_GP(_svi)); \
1141 &(((XPV*) SvANY(_svi))->xpv_cur); \
1143 # define SvIVX(sv) \
1144 (*({ SV *const _svi = (SV *) sv; \
1145 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1146 assert(SvTYPE(_svi) != SVt_PVAV); \
1147 assert(SvTYPE(_svi) != SVt_PVHV); \
1148 assert(SvTYPE(_svi) != SVt_PVCV); \
1149 assert(!isGV_with_GP(_svi)); \
1150 &(((XPVIV*) SvANY(_svi))->xiv_iv); \
1152 # define SvUVX(sv) \
1153 (*({ SV *const _svi = (SV *) sv; \
1154 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1155 assert(SvTYPE(_svi) != SVt_PVAV); \
1156 assert(SvTYPE(_svi) != SVt_PVHV); \
1157 assert(SvTYPE(_svi) != SVt_PVCV); \
1158 assert(!isGV_with_GP(_svi)); \
1159 &(((XPVUV*) SvANY(_svi))->xuv_uv); \
1161 # define SvNVX(sv) \
1162 (*({ SV *const _svi = (SV *) sv; \
1163 assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \
1164 assert(SvTYPE(_svi) != SVt_PVAV); \
1165 assert(SvTYPE(_svi) != SVt_PVHV); \
1166 assert(SvTYPE(_svi) != SVt_PVFM); \
1167 assert(!isGV_with_GP(_svi)); \
1168 &(((XPVNV*) SvANY(_svi))->xnv_u.xnv_nv); \
1170 # define SvMAGIC(sv) \
1171 (*({ SV *const _svi = (SV *) sv; \
1172 assert(SvTYPE(_svi) >= SVt_PVMG); \
1173 if(SvTYPE(_svi) == SVt_PVMG) \
1174 assert(!SvPAD_OUR(_svi)); \
1175 &(((XPVMG*) SvANY(_svi))->xmg_u.xmg_magic); \
1177 # define SvSTASH(sv) \
1178 (*({ SV *const _svi = (SV *) sv; \
1179 assert(SvTYPE(_svi) >= SVt_PVMG); \
1180 &(((XPVMG*) SvANY(_svi))->xmg_stash); \
1183 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1184 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1185 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1186 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1187 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1188 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1189 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1194 /* Given that these two are new, there can't be any existing code using them
1196 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1197 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1199 /* Except for the poison code, which uses & to scribble over the pointer after
1200 free() is called. */
1201 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1202 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1205 #define SvIVXx(sv) SvIVX(sv)
1206 #define SvUVXx(sv) SvUVX(sv)
1207 #define SvNVXx(sv) SvNVX(sv)
1208 #define SvPVXx(sv) SvPVX(sv)
1209 #define SvLENx(sv) SvLEN(sv)
1210 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1213 /* Ask a scalar nicely to try to become an IV, if possible.
1214 Not guaranteed to stay returning void */
1215 /* Macro won't actually call sv_2iv if already IOK */
1216 #define SvIV_please(sv) \
1217 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1218 (void) SvIV(sv); } STMT_END
1219 #define SvIV_set(sv, val) \
1220 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1221 assert(!isGV_with_GP(sv)); \
1222 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1223 #define SvNV_set(sv, val) \
1224 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1225 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1226 assert(!isGV_with_GP(sv)); \
1227 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1228 #define SvPV_set(sv, val) \
1229 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1230 assert(!isGV_with_GP(sv)); \
1231 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1232 #define SvUV_set(sv, val) \
1233 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1234 assert(!isGV_with_GP(sv)); \
1235 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1236 #define SvRV_set(sv, val) \
1237 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
1238 assert(!isGV_with_GP(sv)); \
1239 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1240 #define SvMAGIC_set(sv, val) \
1241 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1242 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1243 #define SvSTASH_set(sv, val) \
1244 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1245 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1246 #define SvCUR_set(sv, val) \
1247 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1248 assert(!isGV_with_GP(sv)); \
1249 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1250 #define SvLEN_set(sv, val) \
1251 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1252 assert(!isGV_with_GP(sv)); \
1253 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1254 #define SvEND_set(sv, val) \
1255 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1256 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
1258 #define SvPV_renew(sv,n) \
1259 STMT_START { SvLEN_set(sv, n); \
1260 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1261 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1262 (MEM_SIZE)((n))))); \
1265 #define SvPV_shrink_to_cur(sv) STMT_START { \
1266 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1267 SvPV_renew(sv, _lEnGtH); \
1270 #define SvPV_free(sv) \
1272 assert(SvTYPE(sv) >= SVt_PV); \
1275 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \
1276 SvFLAGS(sv) &= ~SVf_OOK; \
1278 Safefree(SvPVX(sv)); \
1282 #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
1283 #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
1284 #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
1286 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1288 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1289 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1290 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1291 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1293 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1294 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1295 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1296 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1297 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1298 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1299 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1300 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1301 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1302 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1303 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1304 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1305 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1306 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1307 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
1308 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1309 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1311 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1312 #define IoTYPE_RDONLY '<'
1313 #define IoTYPE_WRONLY '>'
1314 #define IoTYPE_RDWR '+'
1315 #define IoTYPE_APPEND 'a'
1316 #define IoTYPE_PIPE '|'
1317 #define IoTYPE_STD '-' /* stdin or stdout */
1318 #define IoTYPE_SOCKET 's'
1319 #define IoTYPE_CLOSED ' '
1320 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1321 #define IoTYPE_NUMERIC '#' /* fdopen */
1324 =for apidoc Am|bool|SvTAINTED|SV* sv
1325 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1328 =for apidoc Am|void|SvTAINTED_on|SV* sv
1329 Marks an SV as tainted if tainting is enabled.
1331 =for apidoc Am|void|SvTAINTED_off|SV* sv
1332 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1333 some of Perl's fundamental security features. XS module authors should not
1334 use this function unless they fully understand all the implications of
1335 unconditionally untainting the value. Untainting should be done in the
1336 standard perl fashion, via a carefully crafted regexp, rather than directly
1337 untainting variables.
1339 =for apidoc Am|void|SvTAINT|SV* sv
1340 Taints an SV if tainting is enabled.
1345 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1347 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1348 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1349 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1351 #define SvTAINT(sv) \
1353 if (PL_tainting) { \
1360 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1361 Like C<SvPV> but will force the SV into containing just a string
1362 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1365 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1366 Like C<SvPV> but will force the SV into containing just a string
1367 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1368 directly. Doesn't process magic.
1370 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1371 Returns a pointer to the string in the SV, or a stringified form of
1372 the SV if the SV does not contain a string. The SV may cache the
1373 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1374 C<SvPVx> for a version which guarantees to evaluate sv only once.
1376 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1377 A version of C<SvPV> which guarantees to evaluate sv only once.
1379 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1380 Like C<SvPV> but doesn't process magic.
1382 =for apidoc Am|char*|SvPV_nolen|SV* sv
1383 Returns a pointer to the string in the SV, or a stringified form of
1384 the SV if the SV does not contain a string. The SV may cache the
1385 stringified form becoming C<SvPOK>. Handles 'get' magic.
1387 =for apidoc Am|IV|SvIV|SV* sv
1388 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1389 version which guarantees to evaluate sv only once.
1391 =for apidoc Am|IV|SvIV_nomg|SV* sv
1392 Like C<SvIV> but doesn't process magic.
1394 =for apidoc Am|IV|SvIVx|SV* sv
1395 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1396 sv only once. Use the more efficient C<SvIV> otherwise.
1398 =for apidoc Am|NV|SvNV|SV* sv
1399 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1400 which guarantees to evaluate sv only once.
1402 =for apidoc Am|NV|SvNVx|SV* sv
1403 Coerces the given SV to a double and returns it. Guarantees to evaluate
1404 sv only once. Use the more efficient C<SvNV> otherwise.
1406 =for apidoc Am|UV|SvUV|SV* sv
1407 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1408 for a version which guarantees to evaluate sv only once.
1410 =for apidoc Am|UV|SvUV_nomg|SV* sv
1411 Like C<SvUV> but doesn't process magic.
1413 =for apidoc Am|UV|SvUVx|SV* sv
1414 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1415 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1417 =for apidoc Am|bool|SvTRUE|SV* sv
1418 Returns a boolean indicating whether Perl would evaluate the SV as true or
1419 false, defined or undefined. Does not handle 'get' magic.
1421 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1422 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1424 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1425 Like C<SvPV>, but converts sv to utf8 first if necessary.
1427 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1428 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1430 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1431 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1433 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1434 Like C<SvPV>, but converts sv to byte representation first if necessary.
1436 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1437 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1439 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1440 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1441 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1444 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1445 Like C<SvPV>, but converts sv to utf8 first if necessary.
1446 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1449 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1450 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1451 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1454 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1455 Like C<SvPV>, but converts sv to byte representation first if necessary.
1456 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1459 =for apidoc Am|bool|SvIsCOW|SV* sv
1460 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1461 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1464 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1465 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1468 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1469 Like C<sv_catpvn> but doesn't process magic.
1471 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1472 Like C<sv_setsv> but doesn't process magic.
1474 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1475 Like C<sv_catsv> but doesn't process magic.
1480 /* Let us hope that bitmaps for UV and IV are the same */
1481 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1482 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1483 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1485 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1486 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1490 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1491 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1492 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1494 #define SvPV_flags(sv, lp, flags) \
1495 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1496 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1497 #define SvPV_flags_const(sv, lp, flags) \
1498 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1499 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1500 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1501 #define SvPV_flags_const_nolen(sv, flags) \
1502 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1503 ? SvPVX_const(sv) : \
1504 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1505 #define SvPV_flags_mutable(sv, lp, flags) \
1506 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1507 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1508 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1510 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1511 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1512 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1514 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1515 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1517 #define SvPV_force_flags(sv, lp, flags) \
1518 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1519 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1520 #define SvPV_force_flags_nolen(sv, flags) \
1521 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1522 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1523 #define SvPV_force_flags_mutable(sv, lp, flags) \
1524 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1525 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1526 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1528 #define SvPV_nolen(sv) \
1529 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1530 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1532 #define SvPV_nolen_const(sv) \
1533 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1534 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1536 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1537 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1538 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1542 #define SvPVutf8(sv, lp) \
1543 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1544 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1546 #define SvPVutf8_force(sv, lp) \
1547 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1548 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1551 #define SvPVutf8_nolen(sv) \
1552 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1553 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1557 #define SvPVbyte(sv, lp) \
1558 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1559 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1561 #define SvPVbyte_force(sv, lp) \
1562 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1563 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1565 #define SvPVbyte_nolen(sv) \
1566 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1567 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1571 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1572 * var to evaluate the arg once; failing that, use a global if possible;
1573 * failing that, call a function to do the work
1576 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1577 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1578 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1580 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1582 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1583 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1584 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1585 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1586 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1587 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1588 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1589 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1590 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1591 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1592 # define SvTRUE(sv) ( \
1596 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1598 (nxpv->xpv_cur > 1 || \
1599 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1606 ? SvNVX(sv) != 0.0 \
1608 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1610 #else /* __GNUC__ */
1612 /* These inlined macros use globals, which will require a thread
1613 * declaration in user code, so we avoid them under threads */
1615 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1616 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1617 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1618 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1619 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1620 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1621 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1622 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1623 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1624 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1625 # define SvTRUE(sv) ( \
1629 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1630 (PL_Xpv->xpv_cur > 1 || \
1631 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1638 ? SvNVX(sv) != 0.0 \
1640 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1641 #endif /* __GNU__ */
1643 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1644 (SVf_FAKE | SVf_READONLY))
1645 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1647 #define SvSHARED_HEK_FROM_PV(pvx) \
1648 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1649 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1651 /* flag values for sv_*_flags functions */
1652 #define SV_IMMEDIATE_UNREF 1
1654 #define SV_COW_DROP_PV 4
1655 #define SV_UTF8_NO_ENCODING 8
1656 #define SV_NOSTEAL 16
1657 #define SV_CONST_RETURN 32
1658 #define SV_MUTABLE_RETURN 64
1659 #define SV_SMAGIC 128
1660 #define SV_HAS_TRAILING_NUL 256
1662 #define sv_unref(sv) sv_unref_flags(sv, 0)
1663 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1664 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1665 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1667 /* We are about to replace the SV's current value. So if it's copy on write
1668 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1669 the value is about to get thrown away, so drop the PV rather than go to
1670 the effort of making a read-write copy only for it to get immediately
1673 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1674 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1676 #ifdef PERL_OLD_COPY_ON_WRITE
1677 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1678 && Perl_sv_release_IVX(aTHX_ sv)))
1679 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1681 # define SvRELEASE_IVX(sv) SvOOK_off(sv)
1682 #endif /* PERL_OLD_COPY_ON_WRITE */
1684 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1685 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1686 SVf_OOK|SVf_BREAK|SVf_READONLY)
1687 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1689 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1690 sv_force_normal_flags(sv, 0)
1693 /* all these 'functions' are now just macros */
1695 #define sv_pv(sv) SvPV_nolen(sv)
1696 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1697 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1699 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1700 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1701 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1702 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1703 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1704 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1705 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1706 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1707 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1708 #define sv_catpvn_mg(sv, sstr, slen) \
1709 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1710 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1711 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1712 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1713 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1714 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1715 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1716 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1717 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1718 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1720 /* Should be named SvCatPVN_utf8_upgrade? */
1721 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1724 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1726 sv_setpvn(nsv, sstr, slen); \
1728 sv_utf8_upgrade(nsv); \
1729 sv_catsv(dsv, nsv); \
1733 =for apidoc Am|SV*|newRV_inc|SV* sv
1735 Creates an RV wrapper for an SV. The reference count for the original SV is
1741 #define newRV_inc(sv) newRV(sv)
1743 /* the following macros update any magic values this sv is associated with */
1746 =head1 Magical Functions
1748 =for apidoc Am|void|SvGETMAGIC|SV* sv
1749 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1750 argument more than once.
1752 =for apidoc Am|void|SvSETMAGIC|SV* sv
1753 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1754 argument more than once.
1756 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1757 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1760 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1761 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1762 ssv. May evaluate arguments more than once.
1764 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1765 Like C<SvSetSV>, but does any set magic required afterwards.
1767 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1768 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1770 =for apidoc Am|void|SvSHARE|SV* sv
1771 Arranges for sv to be shared between threads if a suitable module
1774 =for apidoc Am|void|SvLOCK|SV* sv
1775 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1778 =for apidoc Am|void|SvUNLOCK|SV* sv
1779 Releases a mutual exclusion lock on sv if a suitable module
1782 =head1 SV Manipulation Functions
1784 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1785 Expands the character buffer in the SV so that it has room for the
1786 indicated number of bytes (remember to reserve space for an extra trailing
1787 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1788 Returns a pointer to the character buffer.
1793 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1794 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1795 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1797 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1798 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1800 #define SvSetSV_and(dst,src,finally) \
1802 if ((dst) != (src)) { \
1803 sv_setsv(dst, src); \
1807 #define SvSetSV_nosteal_and(dst,src,finally) \
1809 if ((dst) != (src)) { \
1810 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL); \
1815 #define SvSetSV(dst,src) \
1816 SvSetSV_and(dst,src,/*nothing*/;)
1817 #define SvSetSV_nosteal(dst,src) \
1818 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1820 #define SvSetMagicSV(dst,src) \
1821 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1822 #define SvSetMagicSV_nosteal(dst,src) \
1823 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1826 #if !defined(SKIP_DEBUGGING)
1827 #define SvPEEK(sv) sv_peek(sv)
1829 #define SvPEEK(sv) ""
1832 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1834 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1836 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1837 /* If I give every macro argument a different name, then there won't be bugs
1838 where nested macros get confused. Been there, done that. */
1839 #define isGV_with_GP(pwadak) \
1840 (((SvFLAGS(pwadak) & (SVp_POK|SVp_SCREAM)) == SVp_SCREAM) \
1841 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
1843 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1844 #define SvGROW_mutable(sv,len) \
1845 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1846 #define Sv_Grow sv_grow
1848 #define CLONEf_COPY_STACKS 1
1849 #define CLONEf_KEEP_PTR_TABLE 2
1850 #define CLONEf_CLONE_HOST 4
1851 #define CLONEf_JOIN_IN 8
1853 struct clone_params {
1856 PerlInterpreter *proto_perl;
1861 * c-indentation-style: bsd
1863 * indent-tabs-mode: t
1866 * ex: set ts=8 sts=4 sw=4 noet: