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>.
56 /* PVBM was here, before BIND replaced it. */
64 SVt_LAST /* keep last in enum. used to size arrays */
68 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
69 purposes eternal code wanting to consider PVBM probably needs to think of
71 # define SVt_PVBM SVt_PVMG
74 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
75 and SVt_IV, so never reaches the clause at the end that uses
76 sv_type_details->body_size to determine whether to call safefree(). Hence
77 body_size can be set no-zero to record the size of PTEs and HEs, without
78 fear of bogus frees. */
80 #define PTE_SVSLOT SVt_IV
82 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
83 #define HE_SVSLOT SVt_NULL
86 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
88 /* typedefs to eliminate some typing */
90 typedef struct hek HEK;
92 /* Using C's structural equivalence to help emulate C++ inheritance here... */
94 /* start with 2 sv-head building blocks */
95 #define _SV_HEAD(ptrtype) \
96 ptrtype sv_any; /* pointer to body */ \
97 U32 sv_refcnt; /* how many references to us */ \
98 U32 sv_flags /* what we are */
100 #define _SV_HEAD_UNION \
104 SV* svu_rv; /* pointer to another SV */ \
105 char* svu_pv; /* pointer to malloced string */ \
112 struct STRUCT_SV { /* struct sv { */
115 #ifdef DEBUG_LEAKING_SCALARS
116 unsigned sv_debug_optype:9; /* the type of OP that allocated us */
117 unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */
118 unsigned sv_debug_cloned:1; /* was cloned for an ithread */
119 unsigned sv_debug_line:16; /* the line where we were allocated */
120 char * sv_debug_file; /* the file where we were allocated */
125 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
130 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
135 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
140 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
145 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
150 #undef _SV_HEAD_UNION /* ensure no pollution */
153 =head1 SV Manipulation Functions
155 =for apidoc Am|U32|SvREFCNT|SV* sv
156 Returns the value of the object's reference count.
158 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
159 Increments the reference count of the given SV.
161 All of the following SvREFCNT_inc* macros are optimized versions of
162 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
164 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
165 Same as SvREFCNT_inc, but can only be used if you know I<sv>
166 is not NULL. Since we don't have to check the NULLness, it's faster
169 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
170 Same as SvREFCNT_inc, but can only be used if you don't need the
171 return value. The macro doesn't need to return a meaningful value.
173 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
174 Same as SvREFCNT_inc, but can only be used if you don't need the return
175 value, and you know that I<sv> is not NULL. The macro doesn't need
176 to return a meaningful value, or check for NULLness, so it's smaller
179 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
180 Same as SvREFCNT_inc, but can only be used with simple variables, not
181 expressions or pointer dereferences. Since we don't have to store a
182 temporary value, it's faster.
184 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
185 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
186 is not NULL. Since we don't have to check the NULLness, it's faster
189 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
190 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
191 return value. The macro doesn't need to return a meaningful value.
193 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
194 Same as SvREFCNT_inc, but can only be used if you don't need the return
195 value, and you know that I<sv> is not NULL. The macro doesn't need
196 to return a meaningful value, or check for NULLness, so it's smaller
199 =for apidoc Am|void|SvREFCNT_dec|SV* sv
200 Decrements the reference count of the given SV.
202 =for apidoc Am|svtype|SvTYPE|SV* sv
203 Returns the type of the SV. See C<svtype>.
205 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
206 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
207 perform the upgrade if necessary. See C<svtype>.
212 #define SvANY(sv) (sv)->sv_any
213 #define SvFLAGS(sv) (sv)->sv_flags
214 #define SvREFCNT(sv) (sv)->sv_refcnt
216 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
217 # define SvREFCNT_inc(sv) \
219 SV * const _sv = (SV*)(sv); \
224 # define SvREFCNT_inc_simple(sv) \
230 # define SvREFCNT_inc_NN(sv) \
232 SV * const _sv = (SV*)(sv); \
236 # define SvREFCNT_inc_void(sv) \
238 SV * const _sv = (SV*)(sv); \
240 (void)(SvREFCNT(_sv)++); \
243 # define SvREFCNT_inc(sv) \
244 ((PL_Sv=(SV*)(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
245 # define SvREFCNT_inc_simple(sv) \
246 ((sv) ? (SvREFCNT(sv)++,(SV*)(sv)) : NULL)
247 # define SvREFCNT_inc_NN(sv) \
248 (PL_Sv=(SV*)(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
249 # define SvREFCNT_inc_void(sv) \
250 (void)((PL_Sv=(SV*)(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
253 /* These guys don't need the curly blocks */
254 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
255 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),(SV*)(sv))
256 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
257 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
259 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
260 # define SvREFCNT_dec(sv) \
262 SV * const _sv = (SV*)(sv); \
264 if (SvREFCNT(_sv)) { \
265 if (--(SvREFCNT(_sv)) == 0) \
266 Perl_sv_free2(aTHX_ _sv); \
273 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
276 #define SVTYPEMASK 0xff
277 #define SvTYPE(sv) (svtype)((sv)->sv_flags & SVTYPEMASK)
279 /* Sadly there are some parts of the core that have pointers to already-freed
280 SV heads, and rely on being able to tell that they are now free. So mark
281 them all by using a consistent macro. */
282 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
284 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
286 #define SVf_IOK 0x00000100 /* has valid public integer value */
287 #define SVf_NOK 0x00000200 /* has valid public numeric value */
288 #define SVf_POK 0x00000400 /* has valid public pointer value */
289 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
291 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
292 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
293 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
294 #define SVp_SCREAM 0x00008000 /* has been studied? */
295 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
296 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
297 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
298 subroutine in another package. Set the
299 CvIMPORTED_CV_ON() if it needs to be
300 expanded to a real GV */
302 #define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
303 #define SVpad_STATE 0x00010000 /* pad name is a "state" var */
304 #define SVs_PADTMP 0x00020000 /* in use as tmp */
305 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
306 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
307 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
308 #define SVs_TEMP 0x00080000 /* string is stealable? */
309 #define SVs_OBJECT 0x00100000 /* is "blessed" */
310 #define SVs_GMG 0x00200000 /* has magical get method */
311 #define SVs_SMG 0x00400000 /* has magical set method */
312 #define SVs_RMG 0x00800000 /* has random magical methods */
314 #define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
315 1: SV head arena wasn't malloc()ed
316 2: in conjunction with SVf_READONLY
317 marks a shared hash key scalar
318 (SvLEN == 0) or a copy on write
319 string (SvLEN != 0) [SvIsCOW(sv)]
320 3: For PVCV, whether CvUNIQUE(cv)
321 refers to an eval or once only
322 [CvEVAL(cv), CvSPECIAL(cv)]
323 4: Whether the regexp pointer is in
324 fact an offset [SvREPADTMP(sv)]
325 5: On a pad name SV, that slot in the
326 frame AV is a REFCNT'ed reference
327 to a lexical from "outside". */
328 #define SVphv_REHASH SVf_FAKE /* 6: On a PVHV, hash values are being
330 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
331 means that a hv_aux struct is present
332 after the main array */
333 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
334 SV's in final arena cleanup */
335 #define SVf_READONLY 0x08000000 /* may not be modified */
340 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
342 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
343 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
345 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
347 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
348 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
349 This is also set on RVs whose overloaded
350 stringification is UTF-8. This might
351 only happen as a side effect of SvPV() */
353 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
355 /* Some private flags. */
358 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
359 /* PVNV, PVMG, presumably only inside pads */
360 #define SVpad_NAME 0x40000000 /* This SV is a name in the PAD, so
361 SVpad_TYPED, SVpad_OUR and SVpad_STATE
364 #define SVpav_REAL 0x40000000 /* free old entries */
366 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
367 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
368 on any regular scalar (anything <= PVLV) */
369 #define SVpbm_VALID 0x40000000
371 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
373 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
374 /* Presumably IVs aren't stored in pads */
375 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
377 #define SVpav_REIFY 0x80000000 /* can become real */
379 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
381 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
382 /* PVGV when SVpbm_VALID is true */
383 #define SVpbm_TAIL 0x80000000
384 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
385 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
390 NV xnv_nv; /* numeric value, if any */
395 } xpad_cop_seq; /* used by pad.c for cop_sequence */
397 STRLEN xpv_cur; /* length of svu_pv as a C string */
398 STRLEN xpv_len; /* allocated size */
402 typedef struct xpv xpv_allocated;
405 STRLEN xpv_cur; /* length of svu_pv as a C string */
406 STRLEN xpv_len; /* allocated size */
412 NV xnv_nv; /* numeric value, if any */
417 } xpad_cop_seq; /* used by pad.c for cop_sequence */
419 STRLEN xpv_cur; /* length of svu_pv as a C string */
420 STRLEN xpv_len; /* allocated size */
422 IV xivu_iv; /* integer value or pv offset */
431 typedef struct xpviv xpviv_allocated;
434 STRLEN xpv_cur; /* length of svu_pv as a C string */
435 STRLEN xpv_len; /* allocated size */
437 IV xivu_iv; /* integer value or pv offset */
446 #define xiv_iv xiv_u.xivu_iv
450 NV xnv_nv; /* numeric value, if any */
455 } xpad_cop_seq; /* used by pad.c for cop_sequence */
457 STRLEN xpv_cur; /* length of svu_pv as a C string */
458 STRLEN xpv_len; /* allocated size */
461 UV xuvu_uv; /* unsigned value or pv offset */
467 #define xuv_uv xuv_u.xuvu_uv
471 NV xnv_nv; /* numeric value, if any */
476 } xpad_cop_seq; /* used by pad.c for cop_sequence */
478 STRLEN xpv_cur; /* length of svu_pv as a C string */
479 STRLEN xpv_len; /* allocated size */
481 IV xivu_iv; /* integer value or pv offset */
489 /* These structure must match the beginning of struct xpvhv in hv.h. */
492 NV xnv_nv; /* numeric value, if any */
497 } xpad_cop_seq; /* used by pad.c for cop_sequence */
499 STRLEN xpv_cur; /* length of svu_pv as a C string */
500 STRLEN xpv_len; /* allocated size */
502 IV xivu_iv; /* integer value or pv offset */
509 MAGIC* xmg_magic; /* linked list of magicalness */
510 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
512 HV* xmg_stash; /* class package */
517 NV xnv_nv; /* numeric value, if any */
522 } xpad_cop_seq; /* used by pad.c for cop_sequence */
524 STRLEN xpv_cur; /* length of svu_pv as a C string */
525 STRLEN xpv_len; /* allocated size */
527 IV xivu_iv; /* integer value or pv offset */
531 HEK * xivu_namehek; /* GvNAME */
534 MAGIC* xmg_magic; /* linked list of magicalness */
535 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
537 HV* xmg_stash; /* class package */
542 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
543 * y=alem/helem/iter t=tie T=tied HE */
546 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
551 HV * xgv_stash; /* The stash of this GV */
555 } xpad_cop_seq; /* used by pad.c for cop_sequence */
557 STRLEN xpv_cur; /* xgv_flags */
558 STRLEN xpv_len; /* 0 */
563 I32 xivu_i32; /* is this constant pattern being useful? */
564 HEK * xivu_namehek; /* GvNAME */
567 MAGIC* xmg_magic; /* linked list of magicalness */
568 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
570 HV* xmg_stash; /* class package */
574 /* This structure must match XPVCV in cv.h */
576 typedef U16 cv_flags_t;
580 NV xnv_nv; /* numeric value, if any */
585 } xpad_cop_seq; /* used by pad.c for cop_sequence */
587 STRLEN xpv_cur; /* length of svu_pv as a C string */
588 STRLEN xpv_len; /* allocated size */
590 IV xivu_iv; /* PVFMs use the pv offset */
597 MAGIC* xmg_magic; /* linked list of magicalness */
598 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
600 HV* xmg_stash; /* class package */
609 void (*xcv_xsub) (pTHX_ CV*);
615 U32 xcv_outside_seq; /* the COP sequence (at the point of our
616 * compilation) in the lexically enclosing
618 cv_flags_t xcv_flags;
623 STRLEN xpv_cur; /* length of svu_pv as a C string */
624 STRLEN xpv_len; /* allocated size */
626 IV xivu_iv; /* PVFMs use the pv offset */
633 MAGIC* xmg_magic; /* linked list of magicalness */
634 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
636 HV* xmg_stash; /* class package */
645 void (*xcv_xsub) (pTHX_ CV*);
651 U32 xcv_outside_seq; /* the COP sequence (at the point of our
652 * compilation) in the lexically enclosing
654 cv_flags_t xcv_flags;
660 NV xnv_nv; /* numeric value, if any */
665 } xpad_cop_seq; /* used by pad.c for cop_sequence */
667 STRLEN xpv_cur; /* length of svu_pv as a C string */
668 STRLEN xpv_len; /* allocated size */
670 IV xivu_iv; /* integer value or pv offset */
677 MAGIC* xmg_magic; /* linked list of magicalness */
678 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
680 HV* xmg_stash; /* class package */
682 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
683 PerlIO * xio_ofp; /* but sockets need separate streams */
684 /* Cray addresses everything by word boundaries (64 bits) and
685 * code and data pointers cannot be mixed (which is exactly what
686 * Perl_filter_add() tries to do with the dirp), hence the following
687 * union trick (as suggested by Gurusamy Sarathy).
688 * For further information see Geir Johansen's problem report titled
689 [ID 20000612.002] Perl problem on Cray system
690 * The any pointer (known as IoANY()) will also be a good place
691 * to hang any IO disciplines to.
694 DIR * xiou_dirp; /* for opendir, readdir, etc */
695 void * xiou_any; /* for alignment */
697 IV xio_lines; /* $. */
698 IV xio_page; /* $% */
699 IV xio_page_len; /* $= */
700 IV xio_lines_left; /* $- */
701 char * xio_top_name; /* $^ */
702 GV * xio_top_gv; /* $^ */
703 char * xio_fmt_name; /* $~ */
704 GV * xio_fmt_gv; /* $~ */
705 char * xio_bottom_name;/* $^B */
706 GV * xio_bottom_gv; /* $^B */
707 short xio_subprocess; /* -| or |- */
711 #define xio_dirp xio_dirpu.xiou_dirp
712 #define xio_any xio_dirpu.xiou_any
714 #define IOf_ARGV 1 /* this fp iterates over ARGV */
715 #define IOf_START 2 /* check for null ARGV and substitute '-' */
716 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
717 #define IOf_DIDTOP 8 /* just did top of form */
718 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
719 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
720 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
722 /* The following macros define implementation-independent predicates on SVs. */
725 =for apidoc Am|bool|SvNIOK|SV* sv
726 Returns a boolean indicating whether the SV contains a number, integer or
729 =for apidoc Am|bool|SvNIOKp|SV* sv
730 Returns a boolean indicating whether the SV contains a number, integer or
731 double. Checks the B<private> setting. Use C<SvNIOK>.
733 =for apidoc Am|void|SvNIOK_off|SV* sv
734 Unsets the NV/IV status of an SV.
736 =for apidoc Am|bool|SvOK|SV* sv
737 Returns a boolean indicating whether the value is an SV. It also tells
738 whether the value is defined or not.
740 =for apidoc Am|bool|SvIOKp|SV* sv
741 Returns a boolean indicating whether the SV contains an integer. Checks
742 the B<private> setting. Use C<SvIOK>.
744 =for apidoc Am|bool|SvNOKp|SV* sv
745 Returns a boolean indicating whether the SV contains a double. Checks the
746 B<private> setting. Use C<SvNOK>.
748 =for apidoc Am|bool|SvPOKp|SV* sv
749 Returns a boolean indicating whether the SV contains a character string.
750 Checks the B<private> setting. Use C<SvPOK>.
752 =for apidoc Am|bool|SvIOK|SV* sv
753 Returns a boolean indicating whether the SV contains an integer.
755 =for apidoc Am|void|SvIOK_on|SV* sv
756 Tells an SV that it is an integer.
758 =for apidoc Am|void|SvIOK_off|SV* sv
759 Unsets the IV status of an SV.
761 =for apidoc Am|void|SvIOK_only|SV* sv
762 Tells an SV that it is an integer and disables all other OK bits.
764 =for apidoc Am|void|SvIOK_only_UV|SV* sv
765 Tells and SV that it is an unsigned integer and disables all other OK bits.
767 =for apidoc Am|bool|SvIOK_UV|SV* sv
768 Returns a boolean indicating whether the SV contains an unsigned integer.
770 =for apidoc Am|void|SvUOK|SV* sv
771 Returns a boolean indicating whether the SV contains an unsigned integer.
773 =for apidoc Am|bool|SvIOK_notUV|SV* sv
774 Returns a boolean indicating whether the SV contains a signed integer.
776 =for apidoc Am|bool|SvNOK|SV* sv
777 Returns a boolean indicating whether the SV contains a double.
779 =for apidoc Am|void|SvNOK_on|SV* sv
780 Tells an SV that it is a double.
782 =for apidoc Am|void|SvNOK_off|SV* sv
783 Unsets the NV status of an SV.
785 =for apidoc Am|void|SvNOK_only|SV* sv
786 Tells an SV that it is a double and disables all other OK bits.
788 =for apidoc Am|bool|SvPOK|SV* sv
789 Returns a boolean indicating whether the SV contains a character
792 =for apidoc Am|void|SvPOK_on|SV* sv
793 Tells an SV that it is a string.
795 =for apidoc Am|void|SvPOK_off|SV* sv
796 Unsets the PV status of an SV.
798 =for apidoc Am|void|SvPOK_only|SV* sv
799 Tells an SV that it is a string and disables all other OK bits.
800 Will also turn off the UTF-8 status.
802 =for apidoc Am|bool|SvVOK|SV* sv
803 Returns a boolean indicating whether the SV contains a v-string.
805 =for apidoc Am|bool|SvOOK|SV* sv
806 Returns a boolean indicating whether the SvIVX is a valid offset value for
807 the SvPVX. This hack is used internally to speed up removal of characters
808 from the beginning of a SvPV. When SvOOK is true, then the start of the
809 allocated string buffer is really (SvPVX - SvIVX).
811 =for apidoc Am|bool|SvROK|SV* sv
812 Tests if the SV is an RV.
814 =for apidoc Am|void|SvROK_on|SV* sv
815 Tells an SV that it is an RV.
817 =for apidoc Am|void|SvROK_off|SV* sv
818 Unsets the RV status of an SV.
820 =for apidoc Am|SV*|SvRV|SV* sv
821 Dereferences an RV to return the SV.
823 =for apidoc Am|IV|SvIVX|SV* sv
824 Returns the raw value in the SV's IV slot, without checks or conversions.
825 Only use when you are sure SvIOK is true. See also C<SvIV()>.
827 =for apidoc Am|UV|SvUVX|SV* sv
828 Returns the raw value in the SV's UV slot, without checks or conversions.
829 Only use when you are sure SvIOK is true. See also C<SvUV()>.
831 =for apidoc Am|NV|SvNVX|SV* sv
832 Returns the raw value in the SV's NV slot, without checks or conversions.
833 Only use when you are sure SvNOK is true. See also C<SvNV()>.
835 =for apidoc Am|char*|SvPVX|SV* sv
836 Returns a pointer to the physical string in the SV. The SV must contain a
839 =for apidoc Am|STRLEN|SvCUR|SV* sv
840 Returns the length of the string which is in the SV. See C<SvLEN>.
842 =for apidoc Am|STRLEN|SvLEN|SV* sv
843 Returns the size of the string buffer in the SV, not including any part
844 attributable to C<SvOOK>. See C<SvCUR>.
846 =for apidoc Am|char*|SvEND|SV* sv
847 Returns a pointer to the last character in the string which is in the SV.
848 See C<SvCUR>. Access the character as *(SvEND(sv)).
850 =for apidoc Am|HV*|SvSTASH|SV* sv
851 Returns the stash of the SV.
853 =for apidoc Am|void|SvIV_set|SV* sv|IV val
854 Set the value of the IV pointer in sv to val. It is possible to perform
855 the same function of this macro with an lvalue assignment to C<SvIVX>.
856 With future Perls, however, it will be more efficient to use
857 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
859 =for apidoc Am|void|SvNV_set|SV* sv|NV val
860 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
862 =for apidoc Am|void|SvPV_set|SV* sv|char* val
863 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
865 =for apidoc Am|void|SvUV_set|SV* sv|UV val
866 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
868 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
869 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
871 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
872 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
874 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
875 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
877 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
878 Set the current length of the string which is in the SV. See C<SvCUR>
881 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
882 Set the actual length of the string which is in the SV. See C<SvIV_set>.
887 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
888 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
889 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
890 SVp_IOK|SVp_NOK|SVf_IVisUV))
892 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
893 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
894 #define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
896 #define assert_not_ROK(sv)
897 #define assert_not_glob(sv)
900 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
901 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
902 SvFLAGS(sv) &= ~(SVf_OK| \
903 SVf_IVisUV|SVf_UTF8), \
905 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
906 SvFLAGS(sv) &= ~(SVf_OK| \
910 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
911 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
912 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
913 SvFLAGS(sv) |= SVp_IOK)
914 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
915 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
916 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
917 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
918 SvFLAGS(sv) |= SVp_POK)
920 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
921 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
922 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
923 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
924 #define SvIOK_only(sv) (SvOK_off(sv), \
925 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
926 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
927 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
929 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
930 == (SVf_IOK|SVf_IVisUV))
931 #define SvUOK(sv) SvIOK_UV(sv)
932 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
935 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
936 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
937 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
939 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
940 #define SvNOK_on(sv) (assert_not_glob(sv) \
941 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
942 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
943 #define SvNOK_only(sv) (SvOK_off(sv), \
944 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
947 =for apidoc Am|bool|SvUTF8|SV* sv
948 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
949 Call this after SvPV() in case any call to string overloading updates the
952 =for apidoc Am|void|SvUTF8_on|SV *sv
953 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
954 Do not use frivolously.
956 =for apidoc Am|void|SvUTF8_off|SV *sv
957 Unsets the UTF-8 status of an SV.
959 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
960 Tells an SV that it is a string and disables all other OK bits,
961 and leaves the UTF-8 status as it was.
966 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
968 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
969 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
970 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
972 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
973 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
974 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
975 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
976 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
977 SvFLAGS(sv) &= ~(SVf_OK| \
978 SVf_IVisUV|SVf_UTF8), \
979 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
980 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
981 SvFLAGS(sv) &= ~(SVf_OK| \
983 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
985 #define SvVOK(sv) (SvMAGICAL(sv) \
986 && mg_find(sv,PERL_MAGIC_vstring))
987 /* returns the vstring magic, if any */
988 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
989 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
991 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
992 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
993 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
995 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
996 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
997 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
999 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
1000 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
1001 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
1003 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
1004 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
1005 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
1007 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
1008 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
1009 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
1011 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
1012 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
1013 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
1015 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
1016 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
1017 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
1019 #define SvAMAGIC(sv) (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
1020 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1021 # define SvAMAGIC_on(sv) ({ SV * const kloink = sv; \
1022 assert(SvROK(kloink)); \
1023 SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
1025 # define SvAMAGIC_off(sv) ({ SV * const kloink = sv; \
1027 SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
1030 # define SvAMAGIC_on(sv) (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
1031 # define SvAMAGIC_off(sv) \
1032 (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
1036 =for apidoc Am|char*|SvGAMAGIC|SV* sv
1038 Returns true if the SV has get magic or overloading. If either is true then
1039 the scalar is active data, and has the potential to return a new value every
1040 time it is accessed. Hence you must be careful to only read it once per user
1041 logical operation and work with that returned value. If neither is true then
1042 the scalar's value cannot change unless written to.
1047 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1049 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
1051 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1052 == (SVf_ROK|SVprv_WEAKREF))
1053 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1054 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1056 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
1057 == (SVf_ROK|SVprv_PCS_IMPORTED))
1058 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
1059 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
1061 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1063 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
1064 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
1065 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
1067 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
1068 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1069 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1071 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
1072 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
1074 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1075 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1076 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1078 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1079 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1080 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1082 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
1083 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1084 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1086 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1087 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1088 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1090 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
1091 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
1092 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
1094 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1095 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1096 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1098 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1099 # define SvVALID(sv) ({ SV *const thwacke = (SV *) (sv); \
1100 if (SvFLAGS(thwacke) & SVpbm_VALID) \
1101 assert(!isGV_with_GP(thwacke)); \
1102 (SvFLAGS(thwacke) & SVpbm_VALID); \
1104 # define SvVALID_on(sv) ({ SV *const thwacke = (SV *) (sv); \
1105 assert(!isGV_with_GP(thwacke)); \
1106 (SvFLAGS(thwacke) |= SVpbm_VALID); \
1108 # define SvVALID_off(sv) ({ SV *const thwacke = (SV *) (sv); \
1109 assert(!isGV_with_GP(thwacke)); \
1110 (SvFLAGS(thwacke) &= ~SVpbm_VALID); \
1113 # define SvTAIL(sv) ({ SV *const _svi = (SV *) (sv); \
1114 assert(SvTYPE(_svi) != SVt_PVAV); \
1115 assert(SvTYPE(_svi) != SVt_PVHV); \
1116 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1117 == (SVpbm_TAIL|SVpbm_VALID); \
1120 # define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
1121 # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1122 # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
1123 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1124 == (SVpbm_TAIL|SVpbm_VALID))
1127 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1128 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1132 /* The following uses the FAKE flag to show that a regex pointer is infact
1133 its own offset in the regexpad for ithreads */
1134 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
1135 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
1136 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
1139 #define SvPAD_TYPED(sv) \
1140 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1142 #define SvPAD_OUR(sv) \
1143 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1145 #define SvPAD_STATE(sv) \
1146 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1148 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1149 # define SvPAD_TYPED_on(sv) ({ \
1150 SV *const whap = (SV *) (sv); \
1151 assert(SvTYPE(whap) == SVt_PVMG); \
1152 (SvFLAGS(whap) |= SVpad_NAME|SVpad_TYPED); \
1154 #define SvPAD_OUR_on(sv) ({ \
1155 SV *const whap = (SV *) (sv); \
1156 assert(SvTYPE(whap) == SVt_PVMG); \
1157 (SvFLAGS(whap) |= SVpad_NAME|SVpad_OUR); \
1159 #define SvPAD_STATE_on(sv) ({ \
1160 SV *const whap = (SV *) (sv); \
1161 assert(SvTYPE(whap) == SVt_PVNV || SvTYPE(whap) == SVt_PVMG); \
1162 (SvFLAGS(whap) |= SVpad_NAME|SVpad_STATE); \
1165 # define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1166 # define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1167 # define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1170 #define OURSTASH(sv) \
1171 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1172 #define OURSTASH_set(sv, st) \
1174 assert(SvTYPE(sv) == SVt_PVMG); \
1175 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1178 #ifdef PERL_DEBUG_COW
1179 #define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1181 #define SvRV(sv) ((sv)->sv_u.svu_rv)
1183 #define SvRVx(sv) SvRV(sv)
1185 #ifdef PERL_DEBUG_COW
1186 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1187 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1188 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1189 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1190 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1191 /* Don't test the core XS code yet. */
1192 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1193 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1195 # define SvPVX(sv) SvPVX_mutable(sv)
1197 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1198 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1199 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1202 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1203 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
1205 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1206 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
1209 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1210 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1212 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1213 /* These get expanded inside other macros that already use a variable _sv */
1214 # define SvPVX(sv) \
1215 (*({ SV *const _svi = (SV *) (sv); \
1216 assert(SvTYPE(_svi) >= SVt_PV); \
1217 assert(SvTYPE(_svi) != SVt_PVAV); \
1218 assert(SvTYPE(_svi) != SVt_PVHV); \
1219 assert(!isGV_with_GP(_svi)); \
1220 &((_svi)->sv_u.svu_pv); \
1222 # define SvCUR(sv) \
1223 (*({ SV *const _svi = (SV *) (sv); \
1224 assert(SvTYPE(_svi) >= SVt_PV); \
1225 assert(SvTYPE(_svi) != SVt_PVAV); \
1226 assert(SvTYPE(_svi) != SVt_PVHV); \
1227 assert(!isGV_with_GP(_svi)); \
1228 &(((XPV*) SvANY(_svi))->xpv_cur); \
1230 # define SvIVX(sv) \
1231 (*({ SV *const _svi = (SV *) (sv); \
1232 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1233 assert(SvTYPE(_svi) != SVt_PVAV); \
1234 assert(SvTYPE(_svi) != SVt_PVHV); \
1235 assert(SvTYPE(_svi) != SVt_PVCV); \
1236 assert(!isGV_with_GP(_svi)); \
1237 &(((XPVIV*) SvANY(_svi))->xiv_iv); \
1239 # define SvUVX(sv) \
1240 (*({ SV *const _svi = (SV *) (sv); \
1241 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1242 assert(SvTYPE(_svi) != SVt_PVAV); \
1243 assert(SvTYPE(_svi) != SVt_PVHV); \
1244 assert(SvTYPE(_svi) != SVt_PVCV); \
1245 assert(!isGV_with_GP(_svi)); \
1246 &(((XPVUV*) SvANY(_svi))->xuv_uv); \
1248 # define SvNVX(sv) \
1249 (*({ SV *const _svi = (SV *) (sv); \
1250 assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \
1251 assert(SvTYPE(_svi) != SVt_PVAV); \
1252 assert(SvTYPE(_svi) != SVt_PVHV); \
1253 assert(SvTYPE(_svi) != SVt_PVCV); \
1254 assert(SvTYPE(_svi) != SVt_PVFM); \
1255 assert(!isGV_with_GP(_svi)); \
1256 &(((XPVNV*) SvANY(_svi))->xnv_u.xnv_nv); \
1258 # define SvMAGIC(sv) \
1259 (*({ SV *const _svi = (SV *) (sv); \
1260 assert(SvTYPE(_svi) >= SVt_PVMG); \
1261 if(SvTYPE(_svi) == SVt_PVMG) \
1262 assert(!SvPAD_OUR(_svi)); \
1263 &(((XPVMG*) SvANY(_svi))->xmg_u.xmg_magic); \
1265 # define SvSTASH(sv) \
1266 (*({ SV *const _svi = (SV *) (sv); \
1267 assert(SvTYPE(_svi) >= SVt_PVMG); \
1268 &(((XPVMG*) SvANY(_svi))->xmg_stash); \
1271 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1272 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1273 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1274 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1275 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1276 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1277 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1282 /* Given that these two are new, there can't be any existing code using them
1284 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1285 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1287 /* Except for the poison code, which uses & to scribble over the pointer after
1288 free() is called. */
1289 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1290 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1293 #define SvIVXx(sv) SvIVX(sv)
1294 #define SvUVXx(sv) SvUVX(sv)
1295 #define SvNVXx(sv) SvNVX(sv)
1296 #define SvPVXx(sv) SvPVX(sv)
1297 #define SvLENx(sv) SvLEN(sv)
1298 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1301 /* Ask a scalar nicely to try to become an IV, if possible.
1302 Not guaranteed to stay returning void */
1303 /* Macro won't actually call sv_2iv if already IOK */
1304 #define SvIV_please(sv) \
1305 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1306 (void) SvIV(sv); } STMT_END
1307 #define SvIV_set(sv, val) \
1308 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1309 assert(SvTYPE(sv) != SVt_PVAV); \
1310 assert(SvTYPE(sv) != SVt_PVHV); \
1311 assert(SvTYPE(sv) != SVt_PVCV); \
1312 assert(!isGV_with_GP(sv)); \
1313 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1314 #define SvNV_set(sv, val) \
1315 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1316 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1317 assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1318 assert(!isGV_with_GP(sv)); \
1319 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1320 #define SvPV_set(sv, val) \
1321 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1322 assert(SvTYPE(sv) != SVt_PVAV); \
1323 assert(SvTYPE(sv) != SVt_PVHV); \
1324 assert(!isGV_with_GP(sv)); \
1325 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1326 #define SvUV_set(sv, val) \
1327 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1328 assert(SvTYPE(sv) != SVt_PVAV); \
1329 assert(SvTYPE(sv) != SVt_PVHV); \
1330 assert(SvTYPE(sv) != SVt_PVCV); \
1331 assert(!isGV_with_GP(sv)); \
1332 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1333 #define SvRV_set(sv, val) \
1334 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
1335 assert(!isGV_with_GP(sv)); \
1336 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1337 #define SvMAGIC_set(sv, val) \
1338 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1339 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1340 #define SvSTASH_set(sv, val) \
1341 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1342 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1343 #define SvCUR_set(sv, val) \
1344 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1345 assert(SvTYPE(sv) != SVt_PVAV); \
1346 assert(SvTYPE(sv) != SVt_PVHV); \
1347 assert(!isGV_with_GP(sv)); \
1348 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1349 #define SvLEN_set(sv, val) \
1350 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1351 assert(SvTYPE(sv) != SVt_PVAV); \
1352 assert(SvTYPE(sv) != SVt_PVHV); \
1353 assert(!isGV_with_GP(sv)); \
1354 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1355 #define SvEND_set(sv, val) \
1356 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1357 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
1359 #define SvPV_renew(sv,n) \
1360 STMT_START { SvLEN_set(sv, n); \
1361 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1362 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1363 (MEM_SIZE)((n))))); \
1366 #define SvPV_shrink_to_cur(sv) STMT_START { \
1367 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1368 SvPV_renew(sv, _lEnGtH); \
1371 #define SvPV_free(sv) \
1373 assert(SvTYPE(sv) >= SVt_PV); \
1376 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \
1377 SvFLAGS(sv) &= ~SVf_OOK; \
1379 Safefree(SvPVX(sv)); \
1384 #define PERL_FBM_TABLE_OFFSET 5 /* Number of bytes between EOS and table */
1385 #define PERL_FBM_FLAGS_OFFSET_FROM_TABLE -1
1386 /* how many characters in string before rare? */
1387 #if (BYTEORDER == 0x4321) || (BYTEORDER == 0x87654321)
1388 # define PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE -2
1389 # define PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE -3
1391 # define PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE -2
1392 # define PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE -3
1394 /* rarest character in string */
1395 #define PERL_FBM_RARE_OFFSET_FROM_TABLE -4
1397 /* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1400 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1401 # define BmRARE(sv) \
1402 (*({ SV *const uggh = (SV *) (sv); \
1403 assert(SvTYPE(uggh) == SVt_PVGV); \
1404 assert(SvVALID(uggh)); \
1405 assert(SvCUR(uggh) + PERL_FBM_TABLE_OFFSET \
1406 + PERL_FBM_RARE_OFFSET_FROM_TABLE <= SvLEN(uggh)); \
1407 assert(SvPOKp(uggh)); \
1409 + PERL_FBM_TABLE_OFFSET + PERL_FBM_RARE_OFFSET_FROM_TABLE); \
1411 # define BmUSEFUL(sv) \
1412 (*({ SV *const uggh = (SV *) (sv); \
1413 assert(SvTYPE(uggh) == SVt_PVGV); \
1414 assert(SvVALID(uggh)); \
1415 assert(!SvIOK(uggh)); \
1416 &(((XPVGV*) SvANY(uggh))->xiv_u.xivu_i32); \
1418 # define BmPREVIOUS(sv) \
1419 ({ SV *const uggh = (SV *) (sv); \
1420 assert(SvTYPE(uggh) == SVt_PVGV); \
1421 assert(SvVALID(uggh)); \
1422 assert(SvPOKp(uggh)); \
1423 assert(SvCUR(uggh) + PERL_FBM_TABLE_OFFSET <= SvLEN(uggh)); \
1424 (*(U8*)(SvEND(uggh) + PERL_FBM_TABLE_OFFSET \
1425 + PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE) << 8) \
1426 | (*(U8*)(SvEND(uggh) + PERL_FBM_TABLE_OFFSET \
1427 + PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE)); \
1430 # define BmRARE(sv) \
1432 + PERL_FBM_TABLE_OFFSET + PERL_FBM_RARE_OFFSET_FROM_TABLE))
1434 # define BmUSEFUL(sv) ((XPVGV*) SvANY(sv))->xiv_u.xivu_i32
1435 # define BmPREVIOUS(sv) \
1436 ((*(U8*)(SvEND(sv) + PERL_FBM_TABLE_OFFSET \
1437 + PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE) << 8) \
1438 | (*(U8*)(SvEND(sv) + PERL_FBM_TABLE_OFFSET \
1439 + PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE))) \
1442 #define BmPREVIOUS_set(sv, val) \
1443 STMT_START { assert(SvTYPE(sv) == SVt_PVGV); \
1444 assert(SvVALID(sv)); \
1445 assert(SvPOKp(sv)); \
1446 assert(SvCUR(sv) + PERL_FBM_TABLE_OFFSET <= SvLEN(sv)); \
1447 *(U8*)(SvEND(sv) + PERL_FBM_TABLE_OFFSET \
1448 + PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE) = (U8)((U32)(val)>>8); \
1449 *(U8*)(SvEND(sv) + PERL_FBM_TABLE_OFFSET \
1450 + PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE) = (U8)(val); \
1453 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1455 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1456 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1457 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1458 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1460 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1461 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1462 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1463 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1464 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1465 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1466 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1467 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1468 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1469 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1470 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1471 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1472 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1473 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1474 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
1475 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1476 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1478 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1479 #define IoTYPE_RDONLY '<'
1480 #define IoTYPE_WRONLY '>'
1481 #define IoTYPE_RDWR '+'
1482 #define IoTYPE_APPEND 'a'
1483 #define IoTYPE_PIPE '|'
1484 #define IoTYPE_STD '-' /* stdin or stdout */
1485 #define IoTYPE_SOCKET 's'
1486 #define IoTYPE_CLOSED ' '
1487 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1488 #define IoTYPE_NUMERIC '#' /* fdopen */
1491 =for apidoc Am|bool|SvTAINTED|SV* sv
1492 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1495 =for apidoc Am|void|SvTAINTED_on|SV* sv
1496 Marks an SV as tainted if tainting is enabled.
1498 =for apidoc Am|void|SvTAINTED_off|SV* sv
1499 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1500 some of Perl's fundamental security features. XS module authors should not
1501 use this function unless they fully understand all the implications of
1502 unconditionally untainting the value. Untainting should be done in the
1503 standard perl fashion, via a carefully crafted regexp, rather than directly
1504 untainting variables.
1506 =for apidoc Am|void|SvTAINT|SV* sv
1507 Taints an SV if tainting is enabled.
1512 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1514 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1515 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1516 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1518 #define SvTAINT(sv) \
1520 if (PL_tainting) { \
1527 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1528 Like C<SvPV> but will force the SV into containing just a string
1529 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1532 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1533 Like C<SvPV> but will force the SV into containing just a string
1534 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1535 directly. Doesn't process magic.
1537 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1538 Returns a pointer to the string in the SV, or a stringified form of
1539 the SV if the SV does not contain a string. The SV may cache the
1540 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1541 C<SvPVx> for a version which guarantees to evaluate sv only once.
1543 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1544 A version of C<SvPV> which guarantees to evaluate sv only once.
1546 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1547 Like C<SvPV> but doesn't process magic.
1549 =for apidoc Am|char*|SvPV_nolen|SV* sv
1550 Returns a pointer to the string in the SV, or a stringified form of
1551 the SV if the SV does not contain a string. The SV may cache the
1552 stringified form becoming C<SvPOK>. Handles 'get' magic.
1554 =for apidoc Am|IV|SvIV|SV* sv
1555 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1556 version which guarantees to evaluate sv only once.
1558 =for apidoc Am|IV|SvIV_nomg|SV* sv
1559 Like C<SvIV> but doesn't process magic.
1561 =for apidoc Am|IV|SvIVx|SV* sv
1562 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1563 sv only once. Use the more efficient C<SvIV> otherwise.
1565 =for apidoc Am|NV|SvNV|SV* sv
1566 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1567 which guarantees to evaluate sv only once.
1569 =for apidoc Am|NV|SvNVx|SV* sv
1570 Coerces the given SV to a double and returns it. Guarantees to evaluate
1571 sv only once. Use the more efficient C<SvNV> otherwise.
1573 =for apidoc Am|UV|SvUV|SV* sv
1574 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1575 for a version which guarantees to evaluate sv only once.
1577 =for apidoc Am|UV|SvUV_nomg|SV* sv
1578 Like C<SvUV> but doesn't process magic.
1580 =for apidoc Am|UV|SvUVx|SV* sv
1581 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1582 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1584 =for apidoc Am|bool|SvTRUE|SV* sv
1585 Returns a boolean indicating whether Perl would evaluate the SV as true or
1586 false, defined or undefined. Does not handle 'get' magic.
1588 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1589 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1591 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1592 Like C<SvPV>, but converts sv to utf8 first if necessary.
1594 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1595 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1597 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1598 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1600 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1601 Like C<SvPV>, but converts sv to byte representation first if necessary.
1603 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1604 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1606 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1607 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1608 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1611 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1612 Like C<SvPV>, but converts sv to utf8 first if necessary.
1613 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1616 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1617 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1618 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1621 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1622 Like C<SvPV>, but converts sv to byte representation first if necessary.
1623 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1626 =for apidoc Am|bool|SvIsCOW|SV* sv
1627 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1628 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1631 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1632 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1635 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1636 Like C<sv_catpvn> but doesn't process magic.
1638 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1639 Like C<sv_setsv> but doesn't process magic.
1641 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1642 Like C<sv_catsv> but doesn't process magic.
1647 /* Let us hope that bitmaps for UV and IV are the same */
1648 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1649 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1650 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1652 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1653 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1657 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1658 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1659 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1661 #define SvPV_flags(sv, lp, flags) \
1662 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1663 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1664 #define SvPV_flags_const(sv, lp, flags) \
1665 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1666 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1667 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1668 #define SvPV_flags_const_nolen(sv, flags) \
1669 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1670 ? SvPVX_const(sv) : \
1671 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1672 #define SvPV_flags_mutable(sv, lp, flags) \
1673 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1674 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1675 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1677 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1678 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1679 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1681 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1682 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1684 #define SvPV_force_flags(sv, lp, flags) \
1685 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1686 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1687 #define SvPV_force_flags_nolen(sv, flags) \
1688 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1689 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1690 #define SvPV_force_flags_mutable(sv, lp, flags) \
1691 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1692 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1693 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1695 #define SvPV_nolen(sv) \
1696 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1697 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1699 #define SvPV_nolen_const(sv) \
1700 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1701 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1703 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1704 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1705 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1709 #define SvPVutf8(sv, lp) \
1710 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1711 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1713 #define SvPVutf8_force(sv, lp) \
1714 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1715 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1718 #define SvPVutf8_nolen(sv) \
1719 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1720 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1724 #define SvPVbyte(sv, lp) \
1725 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1726 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1728 #define SvPVbyte_force(sv, lp) \
1729 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1730 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1732 #define SvPVbyte_nolen(sv) \
1733 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1734 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1738 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1739 * var to evaluate the arg once; failing that, use a global if possible;
1740 * failing that, call a function to do the work
1743 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1744 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1745 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1747 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1749 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1750 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1751 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1752 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1753 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1754 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1755 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1756 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1757 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1758 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1759 # define SvTRUE(sv) ( \
1763 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1765 (nxpv->xpv_cur > 1 || \
1766 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1773 ? SvNVX(sv) != 0.0 \
1775 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1777 #else /* __GNUC__ */
1779 /* These inlined macros use globals, which will require a thread
1780 * declaration in user code, so we avoid them under threads */
1782 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1783 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1784 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1785 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1786 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1787 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1788 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1789 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1790 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1791 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1792 # define SvTRUE(sv) ( \
1796 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1797 (PL_Xpv->xpv_cur > 1 || \
1798 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1805 ? SvNVX(sv) != 0.0 \
1807 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1808 #endif /* __GNU__ */
1810 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1811 (SVf_FAKE | SVf_READONLY))
1812 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1814 #define SvSHARED_HEK_FROM_PV(pvx) \
1815 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1816 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1818 /* flag values for sv_*_flags functions */
1819 #define SV_IMMEDIATE_UNREF 1
1821 #define SV_COW_DROP_PV 4
1822 #define SV_UTF8_NO_ENCODING 8
1823 #define SV_NOSTEAL 16
1824 #define SV_CONST_RETURN 32
1825 #define SV_MUTABLE_RETURN 64
1826 #define SV_SMAGIC 128
1827 #define SV_HAS_TRAILING_NUL 256
1828 #define SV_COW_SHARED_HASH_KEYS 512
1830 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1831 So only default to doing the COW setup if we're in the core.
1834 # ifndef SV_DO_COW_SVSETSV
1835 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS
1839 #ifndef SV_DO_COW_SVSETSV
1840 # define SV_DO_COW_SVSETSV 0
1844 #define sv_unref(sv) sv_unref_flags(sv, 0)
1845 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1846 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1847 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1849 /* We are about to replace the SV's current value. So if it's copy on write
1850 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1851 the value is about to get thrown away, so drop the PV rather than go to
1852 the effort of making a read-write copy only for it to get immediately
1855 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1856 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1858 #ifdef PERL_OLD_COPY_ON_WRITE
1859 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1860 && Perl_sv_release_IVX(aTHX_ sv)))
1861 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1863 # define SvRELEASE_IVX(sv) SvOOK_off(sv)
1864 #endif /* PERL_OLD_COPY_ON_WRITE */
1866 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1867 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1868 SVf_OOK|SVf_BREAK|SVf_READONLY)
1869 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1871 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1872 sv_force_normal_flags(sv, 0)
1875 /* all these 'functions' are now just macros */
1877 #define sv_pv(sv) SvPV_nolen(sv)
1878 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1879 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1881 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1882 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1883 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1884 #define sv_setsv(dsv, ssv) \
1885 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1886 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1887 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1888 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1889 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1890 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1891 #define sv_catpvn_mg(sv, sstr, slen) \
1892 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1893 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1894 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1895 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1896 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1897 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1898 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1899 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1900 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1901 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1903 /* Should be named SvCatPVN_utf8_upgrade? */
1904 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1907 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1909 sv_setpvn(nsv, sstr, slen); \
1911 sv_utf8_upgrade(nsv); \
1912 sv_catsv(dsv, nsv); \
1916 =for apidoc Am|SV*|newRV_inc|SV* sv
1918 Creates an RV wrapper for an SV. The reference count for the original SV is
1924 #define newRV_inc(sv) newRV(sv)
1926 /* the following macros update any magic values this sv is associated with */
1929 =head1 Magical Functions
1931 =for apidoc Am|void|SvGETMAGIC|SV* sv
1932 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1933 argument more than once.
1935 =for apidoc Am|void|SvSETMAGIC|SV* sv
1936 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1937 argument more than once.
1939 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1940 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1943 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1944 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1945 ssv. May evaluate arguments more than once.
1947 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1948 Like C<SvSetSV>, but does any set magic required afterwards.
1950 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1951 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1953 =for apidoc Am|void|SvSHARE|SV* sv
1954 Arranges for sv to be shared between threads if a suitable module
1957 =for apidoc Am|void|SvLOCK|SV* sv
1958 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1961 =for apidoc Am|void|SvUNLOCK|SV* sv
1962 Releases a mutual exclusion lock on sv if a suitable module
1965 =head1 SV Manipulation Functions
1967 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1968 Expands the character buffer in the SV so that it has room for the
1969 indicated number of bytes (remember to reserve space for an extra trailing
1970 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1971 Returns a pointer to the character buffer.
1976 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1977 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1978 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1980 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1981 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1983 #define SvSetSV_and(dst,src,finally) \
1985 if ((dst) != (src)) { \
1986 sv_setsv(dst, src); \
1990 #define SvSetSV_nosteal_and(dst,src,finally) \
1992 if ((dst) != (src)) { \
1993 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
1998 #define SvSetSV(dst,src) \
1999 SvSetSV_and(dst,src,/*nothing*/;)
2000 #define SvSetSV_nosteal(dst,src) \
2001 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
2003 #define SvSetMagicSV(dst,src) \
2004 SvSetSV_and(dst,src,SvSETMAGIC(dst))
2005 #define SvSetMagicSV_nosteal(dst,src) \
2006 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
2009 #if !defined(SKIP_DEBUGGING)
2010 #define SvPEEK(sv) sv_peek(sv)
2012 #define SvPEEK(sv) ""
2015 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
2017 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2019 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2020 /* If I give every macro argument a different name, then there won't be bugs
2021 where nested macros get confused. Been there, done that. */
2022 #define isGV_with_GP(pwadak) \
2023 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
2024 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2025 #define isGV_with_GP_on(sv) STMT_START { \
2026 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2027 assert (!SvPOKp(sv)); \
2028 assert (!SvIOKp(sv)); \
2029 (SvFLAGS(sv) |= SVpgv_GP); \
2031 #define isGV_with_GP_off(sv) STMT_START { \
2032 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2033 assert (!SvPOKp(sv)); \
2034 assert (!SvIOKp(sv)); \
2035 (SvFLAGS(sv) &= ~SVpgv_GP); \
2039 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2040 #define SvGROW_mutable(sv,len) \
2041 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2042 #define Sv_Grow sv_grow
2044 #define CLONEf_COPY_STACKS 1
2045 #define CLONEf_KEEP_PTR_TABLE 2
2046 #define CLONEf_CLONE_HOST 4
2047 #define CLONEf_JOIN_IN 8
2049 struct clone_params {
2052 PerlInterpreter *proto_perl;
2057 * c-indentation-style: bsd
2059 * indent-tabs-mode: t
2062 * ex: set ts=8 sts=4 sw=4 noet: