3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 #undef sv_flags /* Convex has this in <signal.h> for sigvec() */
18 =for apidoc AmU||svtype
19 An enum of flags for Perl types. These are found in the file B<sv.h>
20 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
22 =for apidoc AmU||SVt_PV
23 Pointer type flag for scalars. See C<svtype>.
25 =for apidoc AmU||SVt_IV
26 Integer type flag for scalars. See C<svtype>.
28 =for apidoc AmU||SVt_NV
29 Double type flag for scalars. See C<svtype>.
31 =for apidoc AmU||SVt_PVMG
32 Type flag for blessed scalars. See C<svtype>.
34 =for apidoc AmU||SVt_PVAV
35 Type flag for arrays. See C<svtype>.
37 =for apidoc AmU||SVt_PVHV
38 Type flag for hashes. See C<svtype>.
40 =for apidoc AmU||SVt_PVCV
41 Type flag for code refs. See C<svtype>.
63 SVt_LAST /* keep last in enum. used to size arrays */
66 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
67 and SVt_IV, so never reaches the clause at the end that uses
68 sv_type_details->body_size to determine whether to call safefree(). Hence
69 body_size can be set no-zero to record the size of PTEs and HEs, without
70 fear of bogus frees. */
72 #define PTE_SVSLOT SVt_IV
74 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
75 #define HE_SVSLOT SVt_NULL
78 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
80 /* typedefs to eliminate some typing */
82 typedef struct hek HEK;
84 /* Using C's structural equivalence to help emulate C++ inheritance here... */
86 /* start with 2 sv-head building blocks */
87 #define _SV_HEAD(ptrtype) \
88 ptrtype sv_any; /* pointer to body */ \
89 U32 sv_refcnt; /* how many references to us */ \
90 U32 sv_flags /* what we are */
92 #define _SV_HEAD_UNION \
96 SV* svu_rv; /* pointer to another SV */ \
97 char* svu_pv; /* pointer to malloced string */ \
104 struct STRUCT_SV { /* struct sv { */
107 #ifdef DEBUG_LEAKING_SCALARS
108 unsigned sv_debug_optype:9; /* the type of OP that allocated us */
109 unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */
110 unsigned sv_debug_cloned:1; /* was cloned for an ithread */
111 unsigned sv_debug_line:16; /* the line where we were allocated */
112 char * sv_debug_file; /* the file where we were allocated */
117 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
122 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
127 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
132 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
137 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
142 #undef _SV_HEAD_UNION /* ensure no pollution */
145 =head1 SV Manipulation Functions
147 =for apidoc Am|U32|SvREFCNT|SV* sv
148 Returns the value of the object's reference count.
150 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
151 Increments the reference count of the given SV.
153 All of the following SvREFCNT_inc* macros are optimized versions of
154 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
156 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
157 Same as SvREFCNT_inc, but can only be used if you know I<sv>
158 is not NULL. Since we don't have to check the NULLness, it's faster
161 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
162 Same as SvREFCNT_inc, but can only be used if you don't need the
163 return value. The macro doesn't need to return a meaningful value.
165 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
166 Same as SvREFCNT_inc, but can only be used if you don't need the return
167 value, and you know that I<sv> is not NULL. The macro doesn't need
168 to return a meaningful value, or check for NULLness, so it's smaller
171 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
172 Same as SvREFCNT_inc, but can only be used with simple variables, not
173 expressions or pointer dereferences. Since we don't have to store a
174 temporary value, it's faster.
176 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
177 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
178 is not NULL. Since we don't have to check the NULLness, it's faster
181 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
182 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
183 return value. The macro doesn't need to return a meaningful value.
185 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
186 Same as SvREFCNT_inc, but can only be used if you don't need the return
187 value, and you know that I<sv> is not NULL. The macro doesn't need
188 to return a meaningful value, or check for NULLness, so it's smaller
191 =for apidoc Am|void|SvREFCNT_dec|SV* sv
192 Decrements the reference count of the given SV.
194 =for apidoc Am|svtype|SvTYPE|SV* sv
195 Returns the type of the SV. See C<svtype>.
197 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
198 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
199 perform the upgrade if necessary. See C<svtype>.
204 #define SvANY(sv) (sv)->sv_any
205 #define SvFLAGS(sv) (sv)->sv_flags
206 #define SvREFCNT(sv) (sv)->sv_refcnt
208 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
209 # define SvREFCNT_inc(sv) \
211 SV * const _sv = (SV*)(sv); \
216 # define SvREFCNT_inc_simple(sv) \
222 # define SvREFCNT_inc_NN(sv) \
224 SV * const _sv = (SV*)(sv); \
228 # define SvREFCNT_inc_void(sv) \
230 SV * const _sv = (SV*)(sv); \
232 (void)(SvREFCNT(_sv)++); \
235 # define SvREFCNT_inc(sv) \
236 ((PL_Sv=(SV*)(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
237 # define SvREFCNT_inc_simple(sv) \
238 ((sv) ? (SvREFCNT(sv)++,(SV*)(sv)) : NULL)
239 # define SvREFCNT_inc_NN(sv) \
240 (PL_Sv=(SV*)(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
241 # define SvREFCNT_inc_void(sv) \
242 (void)((PL_Sv=(SV*)(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
245 /* These guys don't need the curly blocks */
246 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
247 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),(SV*)(sv))
248 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
249 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
251 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
252 # define SvREFCNT_dec(sv) \
254 SV * const _sv = (SV*)(sv); \
256 if (SvREFCNT(_sv)) { \
257 if (--(SvREFCNT(_sv)) == 0) \
258 Perl_sv_free2(aTHX_ _sv); \
265 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
268 #define SVTYPEMASK 0xff
269 #define SvTYPE(sv) (svtype)((sv)->sv_flags & SVTYPEMASK)
271 /* Sadly there are some parts of the core that have pointers to already-freed
272 SV heads, and rely on being able to tell that they are now free. So mark
273 them all by using a consistent macro. */
274 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
276 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
278 #define SVf_IOK 0x00000100 /* has valid public integer value */
279 #define SVf_NOK 0x00000200 /* has valid public numeric value */
280 #define SVf_POK 0x00000400 /* has valid public pointer value */
281 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
283 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
284 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
285 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
286 #define SVp_SCREAM 0x00008000 /* has been studied? */
287 #define SVphv_CLONEABLE 0x00008000 /* PVHV (stashes) clone its objects */
289 #define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
290 #define SVpad_STATE 0x00010000 /* pad name is a "state" var */
291 #define SVs_PADTMP 0x00020000 /* in use as tmp */
292 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
293 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
294 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
295 #define SVs_TEMP 0x00080000 /* string is stealable? */
296 #define SVs_OBJECT 0x00100000 /* is "blessed" */
297 #define SVs_GMG 0x00200000 /* has magical get method */
298 #define SVs_SMG 0x00400000 /* has magical set method */
299 #define SVs_RMG 0x00800000 /* has random magical methods */
301 #define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
302 1: SV head arena wasn't malloc()ed
303 2: in conjunction with SVf_READONLY
304 marks a shared hash key scalar
305 (SvLEN == 0) or a copy on write
306 string (SvLEN != 0) [SvIsCOW(sv)]
307 3: For PVCV, whether CvUNIQUE(cv)
308 refers to an eval or once only
309 [CvEVAL(cv), CvSPECIAL(cv)]
310 4: Whether the regexp pointer is in
311 fact an offset [SvREPADTMP(sv)]
312 5: On a pad name SV, that slot in the
313 frame AV is a REFCNT'ed reference
314 to a lexical from "outside". */
315 #define SVphv_REHASH SVf_FAKE /* 6: On a PVHV, hash values are being
317 #define SVf_OOK 0x02000000 /* has valid offset value
318 For a PVHV this means that a
319 hv_aux struct is present after the
321 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used
322 * by SV's in final arena cleanup */
323 #define SVf_READONLY 0x08000000 /* may not be modified */
328 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
330 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
331 SVp_IOK|SVp_NOK|SVp_POK|SVp_SCREAM)
333 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
335 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
336 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
337 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
339 /* Some private flags. */
342 #define SVphv_SHAREKEYS 0x20000000 /* PVHV
343 keys live on shared string table */
344 /* PVNV, PVMG, PVGV, presumably only inside pads */
345 #define SVpad_NAME 0x40000000 /* This SV is a name in the PAD, so
346 SVpad_TYPED, SVpad_OUR and
349 #define SVpav_REAL 0x40000000 /* free old entries */
351 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
352 /* Not just PVBM - basically anything that can be a regular scalar */
353 #define SVpbm_VALID 0x40000000
355 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
357 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
358 /* Presumably IVs aren't stored in pads */
359 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
361 #define SVpav_REIFY 0x80000000 /* can become real */
363 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
365 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
367 #define SVpbm_TAIL 0x80000000
368 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
369 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
374 NV xnv_nv; /* numeric value, if any */
377 STRLEN xpv_cur; /* length of svu_pv as a C string */
378 STRLEN xpv_len; /* allocated size */
382 typedef struct xpv xpv_allocated;
385 STRLEN xpv_cur; /* length of svu_pv as a C string */
386 STRLEN xpv_len; /* allocated size */
392 NV xnv_nv; /* numeric value, if any */
395 STRLEN xpv_cur; /* length of svu_pv as a C string */
396 STRLEN xpv_len; /* allocated size */
398 IV xivu_iv; /* integer value or pv offset */
407 typedef struct xpviv xpviv_allocated;
410 STRLEN xpv_cur; /* length of svu_pv as a C string */
411 STRLEN xpv_len; /* allocated size */
413 IV xivu_iv; /* integer value or pv offset */
422 #define xiv_iv xiv_u.xivu_iv
426 NV xnv_nv; /* numeric value, if any */
429 STRLEN xpv_cur; /* length of svu_pv as a C string */
430 STRLEN xpv_len; /* allocated size */
433 UV xuvu_uv; /* unsigned value or pv offset */
439 #define xuv_uv xuv_u.xuvu_uv
443 NV xnv_nv; /* numeric value, if any */
446 STRLEN xpv_cur; /* length of svu_pv as a C string */
447 STRLEN xpv_len; /* allocated size */
449 IV xivu_iv; /* integer value or pv offset */
457 /* These structure must match the beginning of struct xpvhv in hv.h. */
460 NV xnv_nv; /* numeric value, if any */
463 STRLEN xpv_cur; /* length of svu_pv as a C string */
464 STRLEN xpv_len; /* allocated size */
466 IV xivu_iv; /* integer value or pv offset */
473 MAGIC* xmg_magic; /* linked list of magicalness */
474 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
476 HV* xmg_stash; /* class package */
481 NV xnv_nv; /* numeric value, if any */
484 STRLEN xpv_cur; /* length of svu_pv as a C string */
485 STRLEN xpv_len; /* allocated size */
487 IV xivu_iv; /* integer value or pv offset */
491 HEK * xivu_namehek; /* GvNAME */
494 MAGIC* xmg_magic; /* linked list of magicalness */
495 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
497 HV* xmg_stash; /* class package */
502 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
503 * y=alem/helem/iter t=tie T=tied HE */
509 HV * xgv_stash; /* The stash of this GV */
511 STRLEN xpv_cur; /* xgv_flags */
512 STRLEN xpv_len; /* 0 */
518 HEK * xivu_namehek; /* GvNAME */
521 MAGIC* xmg_magic; /* linked list of magicalness */
522 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
524 HV* xmg_stash; /* class package */
530 NV xnv_nv; /* numeric value, if any */
533 STRLEN xpv_cur; /* length of svu_pv as a C string */
534 STRLEN xpv_len; /* allocated size */
536 IV xivu_iv; /* integer value or pv offset */
539 I32 xivu_i32; /* is this constant pattern being useful? */
543 MAGIC* xmg_magic; /* linked list of magicalness */
544 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
546 HV* xmg_stash; /* class package */
549 /* This structure must match XPVCV in cv.h */
551 typedef U16 cv_flags_t;
555 NV xnv_nv; /* numeric value, if any */
558 STRLEN xpv_cur; /* length of svu_pv as a C string */
559 STRLEN xpv_len; /* allocated size */
561 IV xivu_iv; /* PVFMs use the pv offset */
568 MAGIC* xmg_magic; /* linked list of magicalness */
569 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
571 HV* xmg_stash; /* class package */
580 void (*xcv_xsub) (pTHX_ CV*);
586 U32 xcv_outside_seq; /* the COP sequence (at the point of our
587 * compilation) in the lexically enclosing
589 cv_flags_t xcv_flags;
594 STRLEN xpv_cur; /* length of svu_pv as a C string */
595 STRLEN xpv_len; /* allocated size */
597 IV xivu_iv; /* PVFMs use the pv offset */
604 MAGIC* xmg_magic; /* linked list of magicalness */
605 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
607 HV* xmg_stash; /* class package */
616 void (*xcv_xsub) (pTHX_ CV*);
622 U32 xcv_outside_seq; /* the COP sequence (at the point of our
623 * compilation) in the lexically enclosing
625 cv_flags_t xcv_flags;
631 NV xnv_nv; /* numeric value, if any */
634 STRLEN xpv_cur; /* length of svu_pv as a C string */
635 STRLEN xpv_len; /* allocated size */
637 IV xivu_iv; /* integer value or pv offset */
644 MAGIC* xmg_magic; /* linked list of magicalness */
645 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
647 HV* xmg_stash; /* class package */
649 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
650 PerlIO * xio_ofp; /* but sockets need separate streams */
651 /* Cray addresses everything by word boundaries (64 bits) and
652 * code and data pointers cannot be mixed (which is exactly what
653 * Perl_filter_add() tries to do with the dirp), hence the following
654 * union trick (as suggested by Gurusamy Sarathy).
655 * For further information see Geir Johansen's problem report titled
656 [ID 20000612.002] Perl problem on Cray system
657 * The any pointer (known as IoANY()) will also be a good place
658 * to hang any IO disciplines to.
661 DIR * xiou_dirp; /* for opendir, readdir, etc */
662 void * xiou_any; /* for alignment */
664 IV xio_lines; /* $. */
665 IV xio_page; /* $% */
666 IV xio_page_len; /* $= */
667 IV xio_lines_left; /* $- */
668 char * xio_top_name; /* $^ */
669 GV * xio_top_gv; /* $^ */
670 char * xio_fmt_name; /* $~ */
671 GV * xio_fmt_gv; /* $~ */
672 char * xio_bottom_name;/* $^B */
673 GV * xio_bottom_gv; /* $^B */
674 short xio_subprocess; /* -| or |- */
678 #define xio_dirp xio_dirpu.xiou_dirp
679 #define xio_any xio_dirpu.xiou_any
681 #define IOf_ARGV 1 /* this fp iterates over ARGV */
682 #define IOf_START 2 /* check for null ARGV and substitute '-' */
683 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
684 #define IOf_DIDTOP 8 /* just did top of form */
685 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
686 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
687 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
689 /* The following macros define implementation-independent predicates on SVs. */
692 =for apidoc Am|bool|SvNIOK|SV* sv
693 Returns a boolean indicating whether the SV contains a number, integer or
696 =for apidoc Am|bool|SvNIOKp|SV* sv
697 Returns a boolean indicating whether the SV contains a number, integer or
698 double. Checks the B<private> setting. Use C<SvNIOK>.
700 =for apidoc Am|void|SvNIOK_off|SV* sv
701 Unsets the NV/IV status of an SV.
703 =for apidoc Am|bool|SvOK|SV* sv
704 Returns a boolean indicating whether the value is an SV. It also tells
705 whether the value is defined or not.
707 =for apidoc Am|bool|SvIOKp|SV* sv
708 Returns a boolean indicating whether the SV contains an integer. Checks
709 the B<private> setting. Use C<SvIOK>.
711 =for apidoc Am|bool|SvNOKp|SV* sv
712 Returns a boolean indicating whether the SV contains a double. Checks the
713 B<private> setting. Use C<SvNOK>.
715 =for apidoc Am|bool|SvPOKp|SV* sv
716 Returns a boolean indicating whether the SV contains a character string.
717 Checks the B<private> setting. Use C<SvPOK>.
719 =for apidoc Am|bool|SvIOK|SV* sv
720 Returns a boolean indicating whether the SV contains an integer.
722 =for apidoc Am|void|SvIOK_on|SV* sv
723 Tells an SV that it is an integer.
725 =for apidoc Am|void|SvIOK_off|SV* sv
726 Unsets the IV status of an SV.
728 =for apidoc Am|void|SvIOK_only|SV* sv
729 Tells an SV that it is an integer and disables all other OK bits.
731 =for apidoc Am|void|SvIOK_only_UV|SV* sv
732 Tells and SV that it is an unsigned integer and disables all other OK bits.
734 =for apidoc Am|bool|SvIOK_UV|SV* sv
735 Returns a boolean indicating whether the SV contains an unsigned integer.
737 =for apidoc Am|void|SvUOK|SV* sv
738 Returns a boolean indicating whether the SV contains an unsigned integer.
740 =for apidoc Am|bool|SvIOK_notUV|SV* sv
741 Returns a boolean indicating whether the SV contains a signed integer.
743 =for apidoc Am|bool|SvNOK|SV* sv
744 Returns a boolean indicating whether the SV contains a double.
746 =for apidoc Am|void|SvNOK_on|SV* sv
747 Tells an SV that it is a double.
749 =for apidoc Am|void|SvNOK_off|SV* sv
750 Unsets the NV status of an SV.
752 =for apidoc Am|void|SvNOK_only|SV* sv
753 Tells an SV that it is a double and disables all other OK bits.
755 =for apidoc Am|bool|SvPOK|SV* sv
756 Returns a boolean indicating whether the SV contains a character
759 =for apidoc Am|void|SvPOK_on|SV* sv
760 Tells an SV that it is a string.
762 =for apidoc Am|void|SvPOK_off|SV* sv
763 Unsets the PV status of an SV.
765 =for apidoc Am|void|SvPOK_only|SV* sv
766 Tells an SV that it is a string and disables all other OK bits.
767 Will also turn off the UTF-8 status.
769 =for apidoc Am|bool|SvVOK|SV* sv
770 Returns a boolean indicating whether the SV contains a v-string.
772 =for apidoc Am|bool|SvOOK|SV* sv
773 Returns a boolean indicating whether the SvIVX is a valid offset value for
774 the SvPVX. This hack is used internally to speed up removal of characters
775 from the beginning of a SvPV. When SvOOK is true, then the start of the
776 allocated string buffer is really (SvPVX - SvIVX).
778 =for apidoc Am|bool|SvROK|SV* sv
779 Tests if the SV is an RV.
781 =for apidoc Am|void|SvROK_on|SV* sv
782 Tells an SV that it is an RV.
784 =for apidoc Am|void|SvROK_off|SV* sv
785 Unsets the RV status of an SV.
787 =for apidoc Am|SV*|SvRV|SV* sv
788 Dereferences an RV to return the SV.
790 =for apidoc Am|IV|SvIVX|SV* sv
791 Returns the raw value in the SV's IV slot, without checks or conversions.
792 Only use when you are sure SvIOK is true. See also C<SvIV()>.
794 =for apidoc Am|UV|SvUVX|SV* sv
795 Returns the raw value in the SV's UV slot, without checks or conversions.
796 Only use when you are sure SvIOK is true. See also C<SvUV()>.
798 =for apidoc Am|NV|SvNVX|SV* sv
799 Returns the raw value in the SV's NV slot, without checks or conversions.
800 Only use when you are sure SvNOK is true. See also C<SvNV()>.
802 =for apidoc Am|char*|SvPVX|SV* sv
803 Returns a pointer to the physical string in the SV. The SV must contain a
806 =for apidoc Am|STRLEN|SvCUR|SV* sv
807 Returns the length of the string which is in the SV. See C<SvLEN>.
809 =for apidoc Am|STRLEN|SvLEN|SV* sv
810 Returns the size of the string buffer in the SV, not including any part
811 attributable to C<SvOOK>. See C<SvCUR>.
813 =for apidoc Am|char*|SvEND|SV* sv
814 Returns a pointer to the last character in the string which is in the SV.
815 See C<SvCUR>. Access the character as *(SvEND(sv)).
817 =for apidoc Am|HV*|SvSTASH|SV* sv
818 Returns the stash of the SV.
820 =for apidoc Am|void|SvIV_set|SV* sv|IV val
821 Set the value of the IV pointer in sv to val. It is possible to perform
822 the same function of this macro with an lvalue assignment to C<SvIVX>.
823 With future Perls, however, it will be more efficient to use
824 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
826 =for apidoc Am|void|SvNV_set|SV* sv|NV val
827 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
829 =for apidoc Am|void|SvPV_set|SV* sv|char* val
830 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
832 =for apidoc Am|void|SvUV_set|SV* sv|UV val
833 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
835 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
836 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
838 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
839 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
841 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
842 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
844 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
845 Set the current length of the string which is in the SV. See C<SvCUR>
848 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
849 Set the actual length of the string which is in the SV. See C<SvIV_set>.
854 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
855 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
856 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
857 SVp_IOK|SVp_NOK|SVf_IVisUV))
859 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
860 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
861 #define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
863 #define assert_not_ROK(sv)
864 #define assert_not_glob(sv)
867 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
868 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
869 SvFLAGS(sv) &= ~(SVf_OK| \
870 SVf_IVisUV|SVf_UTF8), \
872 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
873 SvFLAGS(sv) &= ~(SVf_OK| \
877 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
878 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
879 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
880 SvFLAGS(sv) |= SVp_IOK)
881 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
882 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
883 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
884 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
885 SvFLAGS(sv) |= SVp_POK)
887 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
888 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
889 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
890 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
891 #define SvIOK_only(sv) (SvOK_off(sv), \
892 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
893 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
894 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
896 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
897 == (SVf_IOK|SVf_IVisUV))
898 #define SvUOK(sv) SvIOK_UV(sv)
899 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
902 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
903 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
904 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
906 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
907 #define SvNOK_on(sv) (assert_not_glob(sv) \
908 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
909 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
910 #define SvNOK_only(sv) (SvOK_off(sv), \
911 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
914 =for apidoc Am|bool|SvUTF8|SV* sv
915 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
917 =for apidoc Am|void|SvUTF8_on|SV *sv
918 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
919 Do not use frivolously.
921 =for apidoc Am|void|SvUTF8_off|SV *sv
922 Unsets the UTF-8 status of an SV.
924 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
925 Tells an SV that it is a string and disables all other OK bits,
926 and leaves the UTF-8 status as it was.
931 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
933 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
934 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
935 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
937 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
938 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
939 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
940 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
941 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
942 SvFLAGS(sv) &= ~(SVf_OK| \
943 SVf_IVisUV|SVf_UTF8), \
944 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
945 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
946 SvFLAGS(sv) &= ~(SVf_OK| \
948 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
950 #define SvVOK(sv) (SvMAGICAL(sv) \
951 && mg_find(sv,PERL_MAGIC_vstring))
952 /* returns the vstring magic, if any */
953 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
954 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
956 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
957 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
958 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
960 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
961 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
962 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
964 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
965 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
966 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
968 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
969 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
970 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
972 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
973 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
974 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
976 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
977 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
978 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
980 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
981 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
982 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
984 #define SvAMAGIC(sv) (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
985 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
986 # define SvAMAGIC_on(sv) ({ SV * const kloink = sv; \
987 assert(SvROK(kloink)); \
988 SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
990 # define SvAMAGIC_off(sv) ({ SV * const kloink = sv; \
992 SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
995 # define SvAMAGIC_on(sv) (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
996 # define SvAMAGIC_off(sv) \
997 (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
1001 =for apidoc Am|char*|SvGAMAGIC|SV* sv
1003 Returns true if the SV has get magic or overloading. If either is true then
1004 the scalar is active data, and has the potential to return a new value every
1005 time it is accessed. Hence you must be careful to only read it once per user
1006 logical operation and work with that returned value. If neither is true then
1007 the scalar's value cannot change unless written to.
1012 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1014 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
1016 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1017 == (SVf_ROK|SVprv_WEAKREF))
1018 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1019 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1021 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1023 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
1024 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
1025 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
1027 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
1028 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1029 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1031 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
1032 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
1034 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1035 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1036 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1038 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1039 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1040 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1042 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
1043 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1044 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1046 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1047 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1048 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1050 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
1051 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
1052 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
1054 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1055 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1056 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1058 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1059 # define SvVALID(sv) ({ SV *const thwacke = (SV *) (sv); \
1060 if (SvFLAGS(thwacke) & SVpbm_VALID) \
1061 assert(!isGV_with_GP(thwacke)); \
1062 (SvFLAGS(thwacke) & SVpbm_VALID); \
1064 # define SvVALID_on(sv) ({ SV *const thwacke = (SV *) (sv); \
1065 assert(!isGV_with_GP(thwacke)); \
1066 (SvFLAGS(thwacke) |= SVpbm_VALID); \
1068 # define SvVALID_off(sv) ({ SV *const thwacke = (SV *) (sv); \
1069 assert(!isGV_with_GP(thwacke)); \
1070 (SvFLAGS(thwacke) &= ~SVpbm_VALID); \
1073 # define SvTAIL(sv) ({ SV *const _svi = (SV *) (sv); \
1074 assert(SvTYPE(_svi) != SVt_PVAV); \
1075 assert(SvTYPE(_svi) != SVt_PVHV); \
1076 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1077 == (SVpbm_TAIL|SVpbm_VALID); \
1080 # define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
1081 # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1082 # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
1083 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1084 == (SVpbm_TAIL|SVpbm_VALID))
1087 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1088 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1092 /* The following uses the FAKE flag to show that a regex pointer is infact
1093 its own offset in the regexpad for ithreads */
1094 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
1095 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
1096 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
1099 #define SvPAD_TYPED(sv) \
1100 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1101 #define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1103 #define SvPAD_OUR(sv) \
1104 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1105 #define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1107 #define SvPAD_STATE(sv) \
1108 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1109 #define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1111 #define OURSTASH(sv) \
1112 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1113 #define OURSTASH_set(sv, st) \
1115 assert(SvTYPE(sv) == SVt_PVMG); \
1116 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1119 #ifdef PERL_DEBUG_COW
1120 #define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1122 #define SvRV(sv) ((sv)->sv_u.svu_rv)
1124 #define SvRVx(sv) SvRV(sv)
1126 #ifdef PERL_DEBUG_COW
1127 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1128 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1129 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1130 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1131 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1132 /* Don't test the core XS code yet. */
1133 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1134 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1136 # define SvPVX(sv) SvPVX_mutable(sv)
1138 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1139 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1140 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1143 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1144 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
1146 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1147 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
1150 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1151 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1153 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1154 /* These get expanded inside other macros that already use a variable _sv */
1155 # define SvPVX(sv) \
1156 (*({ SV *const _svi = (SV *) (sv); \
1157 assert(SvTYPE(_svi) >= SVt_PV); \
1158 assert(SvTYPE(_svi) != SVt_PVAV); \
1159 assert(SvTYPE(_svi) != SVt_PVHV); \
1160 assert(!isGV_with_GP(_svi)); \
1161 &((_svi)->sv_u.svu_pv); \
1163 # define SvCUR(sv) \
1164 (*({ SV *const _svi = (SV *) (sv); \
1165 assert(SvTYPE(_svi) >= SVt_PV); \
1166 assert(SvTYPE(_svi) != SVt_PVAV); \
1167 assert(SvTYPE(_svi) != SVt_PVHV); \
1168 assert(!isGV_with_GP(_svi)); \
1169 &(((XPV*) SvANY(_svi))->xpv_cur); \
1171 # define SvIVX(sv) \
1172 (*({ SV *const _svi = (SV *) (sv); \
1173 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1174 assert(SvTYPE(_svi) != SVt_PVAV); \
1175 assert(SvTYPE(_svi) != SVt_PVHV); \
1176 assert(SvTYPE(_svi) != SVt_PVCV); \
1177 assert(!isGV_with_GP(_svi)); \
1178 &(((XPVIV*) SvANY(_svi))->xiv_iv); \
1180 # define SvUVX(sv) \
1181 (*({ SV *const _svi = (SV *) (sv); \
1182 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1183 assert(SvTYPE(_svi) != SVt_PVAV); \
1184 assert(SvTYPE(_svi) != SVt_PVHV); \
1185 assert(SvTYPE(_svi) != SVt_PVCV); \
1186 assert(!isGV_with_GP(_svi)); \
1187 &(((XPVUV*) SvANY(_svi))->xuv_uv); \
1189 # define SvNVX(sv) \
1190 (*({ SV *const _svi = (SV *) (sv); \
1191 assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \
1192 assert(SvTYPE(_svi) != SVt_PVAV); \
1193 assert(SvTYPE(_svi) != SVt_PVHV); \
1194 assert(SvTYPE(_svi) != SVt_PVCV); \
1195 assert(SvTYPE(_svi) != SVt_PVFM); \
1196 assert(!isGV_with_GP(_svi)); \
1197 &(((XPVNV*) SvANY(_svi))->xnv_u.xnv_nv); \
1199 # define SvMAGIC(sv) \
1200 (*({ SV *const _svi = (SV *) (sv); \
1201 assert(SvTYPE(_svi) >= SVt_PVMG); \
1202 if(SvTYPE(_svi) == SVt_PVMG) \
1203 assert(!SvPAD_OUR(_svi)); \
1204 &(((XPVMG*) SvANY(_svi))->xmg_u.xmg_magic); \
1206 # define SvSTASH(sv) \
1207 (*({ SV *const _svi = (SV *) (sv); \
1208 assert(SvTYPE(_svi) >= SVt_PVMG); \
1209 &(((XPVMG*) SvANY(_svi))->xmg_stash); \
1212 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1213 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1214 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1215 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1216 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1217 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1218 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1223 /* Given that these two are new, there can't be any existing code using them
1225 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1226 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1228 /* Except for the poison code, which uses & to scribble over the pointer after
1229 free() is called. */
1230 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1231 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1234 #define SvIVXx(sv) SvIVX(sv)
1235 #define SvUVXx(sv) SvUVX(sv)
1236 #define SvNVXx(sv) SvNVX(sv)
1237 #define SvPVXx(sv) SvPVX(sv)
1238 #define SvLENx(sv) SvLEN(sv)
1239 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1242 /* Ask a scalar nicely to try to become an IV, if possible.
1243 Not guaranteed to stay returning void */
1244 /* Macro won't actually call sv_2iv if already IOK */
1245 #define SvIV_please(sv) \
1246 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1247 (void) SvIV(sv); } STMT_END
1248 #define SvIV_set(sv, val) \
1249 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1250 assert(SvTYPE(sv) != SVt_PVAV); \
1251 assert(SvTYPE(sv) != SVt_PVHV); \
1252 assert(SvTYPE(sv) != SVt_PVCV); \
1253 assert(!isGV_with_GP(sv)); \
1254 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1255 #define SvNV_set(sv, val) \
1256 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1257 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1258 assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1259 assert(!isGV_with_GP(sv)); \
1260 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1261 #define SvPV_set(sv, val) \
1262 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1263 assert(SvTYPE(sv) != SVt_PVAV); \
1264 assert(SvTYPE(sv) != SVt_PVHV); \
1265 assert(!isGV_with_GP(sv)); \
1266 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1267 #define SvUV_set(sv, val) \
1268 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1269 assert(SvTYPE(sv) != SVt_PVAV); \
1270 assert(SvTYPE(sv) != SVt_PVHV); \
1271 assert(SvTYPE(sv) != SVt_PVCV); \
1272 assert(!isGV_with_GP(sv)); \
1273 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1274 #define SvRV_set(sv, val) \
1275 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
1276 assert(!isGV_with_GP(sv)); \
1277 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1278 #define SvMAGIC_set(sv, val) \
1279 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1280 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1281 #define SvSTASH_set(sv, val) \
1282 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1283 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1284 #define SvCUR_set(sv, val) \
1285 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1286 assert(SvTYPE(sv) != SVt_PVAV); \
1287 assert(SvTYPE(sv) != SVt_PVHV); \
1288 assert(!isGV_with_GP(sv)); \
1289 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1290 #define SvLEN_set(sv, val) \
1291 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1292 assert(SvTYPE(sv) != SVt_PVAV); \
1293 assert(SvTYPE(sv) != SVt_PVHV); \
1294 assert(!isGV_with_GP(sv)); \
1295 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1296 #define SvEND_set(sv, val) \
1297 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1298 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
1300 #define SvPV_renew(sv,n) \
1301 STMT_START { SvLEN_set(sv, n); \
1302 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1303 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1304 (MEM_SIZE)((n))))); \
1307 #define SvPV_shrink_to_cur(sv) STMT_START { \
1308 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1309 SvPV_renew(sv, _lEnGtH); \
1312 #define SvPV_free(sv) \
1314 assert(SvTYPE(sv) >= SVt_PV); \
1317 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \
1318 SvFLAGS(sv) &= ~SVf_OOK; \
1320 Safefree(SvPVX(sv)); \
1325 #define PERL_FBM_TABLE_OFFSET 5 /* Number of bytes between EOS and table */
1326 #define PERL_FBM_FLAGS_OFFSET_FROM_TABLE -1
1327 #define PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE -2
1328 #define PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE -3
1329 #define PERL_FBM_RARE_OFFSET_FROM_TABLE -4
1331 /* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1334 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1335 # define BmRARE(sv) \
1336 (*({ SV *const uggh = (SV *) (sv); \
1337 assert(SvTYPE(uggh) == SVt_PVBM); \
1338 assert(SvVALID(uggh)); \
1339 assert(SvCUR(uggh) + PERL_FBM_TABLE_OFFSET \
1340 + PERL_FBM_RARE_OFFSET_FROM_TABLE <= SvLEN(uggh)); \
1341 assert(SvPOKp(uggh)); \
1343 + PERL_FBM_TABLE_OFFSET + PERL_FBM_RARE_OFFSET_FROM_TABLE); \
1345 # define BmUSEFUL(sv) \
1346 (*({ SV *const uggh = (SV *) (sv); \
1347 assert(SvTYPE(uggh) == SVt_PVBM); \
1348 assert(SvVALID(uggh)); \
1349 assert(!SvIOK(uggh)); \
1350 &(((XPVBM*) SvANY(uggh))->xiv_u.xivu_i32); \
1352 # define BmPREVIOUS(sv) \
1353 ({ SV *const uggh = (SV *) (sv); \
1354 assert(SvTYPE(uggh) == SVt_PVBM); \
1355 assert(SvVALID(uggh)); \
1356 assert(SvPOKp(uggh)); \
1357 assert(SvCUR(uggh) + PERL_FBM_TABLE_OFFSET <= SvLEN(uggh)); \
1358 (*(U8*)(SvEND(uggh) + PERL_FBM_TABLE_OFFSET \
1359 + PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE) << 8) \
1360 | (*(U8*)(SvEND(uggh) + PERL_FBM_TABLE_OFFSET \
1361 + PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE)); \
1364 # define BmRARE(sv) \
1366 + PERL_FBM_TABLE_OFFSET + PERL_FBM_RARE_OFFSET_FROM_TABLE))
1368 # define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xiv_u.xivu_i32
1369 # define BmPREVIOUS(sv) \
1370 ((*(U8*)(SvEND(sv) + PERL_FBM_TABLE_OFFSET \
1371 + PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE) << 8) \
1372 | (*(U8*)(SvEND(sv) + PERL_FBM_TABLE_OFFSET \
1373 + PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE))) \
1376 #define BmPREVIOUS_set(sv, val) \
1377 STMT_START { assert(SvTYPE(sv) == SVt_PVBM); \
1378 assert(SvVALID(sv)); \
1379 assert(SvPOKp(sv)); \
1380 assert(SvCUR(sv) + PERL_FBM_TABLE_OFFSET <= SvLEN(sv)); \
1381 *(U8*)(SvEND(sv) + PERL_FBM_TABLE_OFFSET \
1382 + PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE) = (U8)((U32)(val)>>8); \
1383 *(U8*)(SvEND(sv) + PERL_FBM_TABLE_OFFSET \
1384 + PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE) = (U8)(val); \
1387 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1389 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1390 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1391 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1392 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1394 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1395 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1396 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1397 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1398 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1399 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1400 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1401 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1402 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1403 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1404 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1405 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1406 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1407 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1408 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
1409 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1410 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1412 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1413 #define IoTYPE_RDONLY '<'
1414 #define IoTYPE_WRONLY '>'
1415 #define IoTYPE_RDWR '+'
1416 #define IoTYPE_APPEND 'a'
1417 #define IoTYPE_PIPE '|'
1418 #define IoTYPE_STD '-' /* stdin or stdout */
1419 #define IoTYPE_SOCKET 's'
1420 #define IoTYPE_CLOSED ' '
1421 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1422 #define IoTYPE_NUMERIC '#' /* fdopen */
1425 =for apidoc Am|bool|SvTAINTED|SV* sv
1426 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1429 =for apidoc Am|void|SvTAINTED_on|SV* sv
1430 Marks an SV as tainted if tainting is enabled.
1432 =for apidoc Am|void|SvTAINTED_off|SV* sv
1433 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1434 some of Perl's fundamental security features. XS module authors should not
1435 use this function unless they fully understand all the implications of
1436 unconditionally untainting the value. Untainting should be done in the
1437 standard perl fashion, via a carefully crafted regexp, rather than directly
1438 untainting variables.
1440 =for apidoc Am|void|SvTAINT|SV* sv
1441 Taints an SV if tainting is enabled.
1446 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1448 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1449 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1450 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1452 #define SvTAINT(sv) \
1454 if (PL_tainting) { \
1461 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1462 Like C<SvPV> but will force the SV into containing just a string
1463 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1466 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1467 Like C<SvPV> but will force the SV into containing just a string
1468 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1469 directly. Doesn't process magic.
1471 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1472 Returns a pointer to the string in the SV, or a stringified form of
1473 the SV if the SV does not contain a string. The SV may cache the
1474 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1475 C<SvPVx> for a version which guarantees to evaluate sv only once.
1477 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1478 A version of C<SvPV> which guarantees to evaluate sv only once.
1480 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1481 Like C<SvPV> but doesn't process magic.
1483 =for apidoc Am|char*|SvPV_nolen|SV* sv
1484 Returns a pointer to the string in the SV, or a stringified form of
1485 the SV if the SV does not contain a string. The SV may cache the
1486 stringified form becoming C<SvPOK>. Handles 'get' magic.
1488 =for apidoc Am|IV|SvIV|SV* sv
1489 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1490 version which guarantees to evaluate sv only once.
1492 =for apidoc Am|IV|SvIV_nomg|SV* sv
1493 Like C<SvIV> but doesn't process magic.
1495 =for apidoc Am|IV|SvIVx|SV* sv
1496 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1497 sv only once. Use the more efficient C<SvIV> otherwise.
1499 =for apidoc Am|NV|SvNV|SV* sv
1500 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1501 which guarantees to evaluate sv only once.
1503 =for apidoc Am|NV|SvNVx|SV* sv
1504 Coerces the given SV to a double and returns it. Guarantees to evaluate
1505 sv only once. Use the more efficient C<SvNV> otherwise.
1507 =for apidoc Am|UV|SvUV|SV* sv
1508 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1509 for a version which guarantees to evaluate sv only once.
1511 =for apidoc Am|UV|SvUV_nomg|SV* sv
1512 Like C<SvUV> but doesn't process magic.
1514 =for apidoc Am|UV|SvUVx|SV* sv
1515 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1516 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1518 =for apidoc Am|bool|SvTRUE|SV* sv
1519 Returns a boolean indicating whether Perl would evaluate the SV as true or
1520 false, defined or undefined. Does not handle 'get' magic.
1522 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1523 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1525 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1526 Like C<SvPV>, but converts sv to utf8 first if necessary.
1528 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1529 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1531 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1532 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1534 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1535 Like C<SvPV>, but converts sv to byte representation first if necessary.
1537 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1538 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1540 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1541 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1542 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1545 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1546 Like C<SvPV>, but converts sv to utf8 first if necessary.
1547 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1550 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1551 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1552 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1555 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1556 Like C<SvPV>, but converts sv to byte representation first if necessary.
1557 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1560 =for apidoc Am|bool|SvIsCOW|SV* sv
1561 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1562 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1565 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1566 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1569 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1570 Like C<sv_catpvn> but doesn't process magic.
1572 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1573 Like C<sv_setsv> but doesn't process magic.
1575 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1576 Like C<sv_catsv> but doesn't process magic.
1581 /* Let us hope that bitmaps for UV and IV are the same */
1582 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1583 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1584 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1586 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1587 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1591 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1592 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1593 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1595 #define SvPV_flags(sv, lp, flags) \
1596 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1597 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1598 #define SvPV_flags_const(sv, lp, flags) \
1599 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1600 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1601 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1602 #define SvPV_flags_const_nolen(sv, flags) \
1603 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1604 ? SvPVX_const(sv) : \
1605 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1606 #define SvPV_flags_mutable(sv, lp, flags) \
1607 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1608 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1609 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1611 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1612 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1613 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1615 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1616 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1618 #define SvPV_force_flags(sv, lp, flags) \
1619 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1620 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1621 #define SvPV_force_flags_nolen(sv, flags) \
1622 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1623 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1624 #define SvPV_force_flags_mutable(sv, lp, flags) \
1625 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1626 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1627 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1629 #define SvPV_nolen(sv) \
1630 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1631 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1633 #define SvPV_nolen_const(sv) \
1634 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1635 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1637 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1638 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1639 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1643 #define SvPVutf8(sv, lp) \
1644 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1645 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1647 #define SvPVutf8_force(sv, lp) \
1648 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1649 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1652 #define SvPVutf8_nolen(sv) \
1653 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1654 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1658 #define SvPVbyte(sv, lp) \
1659 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1660 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1662 #define SvPVbyte_force(sv, lp) \
1663 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1664 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1666 #define SvPVbyte_nolen(sv) \
1667 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1668 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1672 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1673 * var to evaluate the arg once; failing that, use a global if possible;
1674 * failing that, call a function to do the work
1677 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1678 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1679 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1681 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1683 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1684 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1685 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1686 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1687 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1688 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1689 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1690 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1691 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1692 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1693 # define SvTRUE(sv) ( \
1697 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1699 (nxpv->xpv_cur > 1 || \
1700 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1707 ? SvNVX(sv) != 0.0 \
1709 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1711 #else /* __GNUC__ */
1713 /* These inlined macros use globals, which will require a thread
1714 * declaration in user code, so we avoid them under threads */
1716 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1717 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1718 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1719 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1720 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1721 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1722 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1723 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1724 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1725 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1726 # define SvTRUE(sv) ( \
1730 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1731 (PL_Xpv->xpv_cur > 1 || \
1732 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1739 ? SvNVX(sv) != 0.0 \
1741 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1742 #endif /* __GNU__ */
1744 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1745 (SVf_FAKE | SVf_READONLY))
1746 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1748 #define SvSHARED_HEK_FROM_PV(pvx) \
1749 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1750 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1752 /* flag values for sv_*_flags functions */
1753 #define SV_IMMEDIATE_UNREF 1
1755 #define SV_COW_DROP_PV 4
1756 #define SV_UTF8_NO_ENCODING 8
1757 #define SV_NOSTEAL 16
1758 #define SV_CONST_RETURN 32
1759 #define SV_MUTABLE_RETURN 64
1760 #define SV_SMAGIC 128
1761 #define SV_HAS_TRAILING_NUL 256
1762 #define SV_COW_SHARED_HASH_KEYS 512
1764 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1765 So only default to doing the COW setup if we're in the core.
1768 # ifndef SV_DO_COW_SVSETSV
1769 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS
1773 #ifndef SV_DO_COW_SVSETSV
1774 # define SV_DO_COW_SVSETSV 0
1778 #define sv_unref(sv) sv_unref_flags(sv, 0)
1779 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1780 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1781 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1783 /* We are about to replace the SV's current value. So if it's copy on write
1784 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1785 the value is about to get thrown away, so drop the PV rather than go to
1786 the effort of making a read-write copy only for it to get immediately
1789 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1790 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1792 #ifdef PERL_OLD_COPY_ON_WRITE
1793 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1794 && Perl_sv_release_IVX(aTHX_ sv)))
1795 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1797 # define SvRELEASE_IVX(sv) SvOOK_off(sv)
1798 #endif /* PERL_OLD_COPY_ON_WRITE */
1800 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1801 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1802 SVf_OOK|SVf_BREAK|SVf_READONLY)
1803 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1805 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1806 sv_force_normal_flags(sv, 0)
1809 /* all these 'functions' are now just macros */
1811 #define sv_pv(sv) SvPV_nolen(sv)
1812 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1813 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1815 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1816 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1817 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1818 #define sv_setsv(dsv, ssv) \
1819 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1820 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1821 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1822 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1823 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1824 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1825 #define sv_catpvn_mg(sv, sstr, slen) \
1826 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1827 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1828 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1829 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1830 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1831 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1832 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1833 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1834 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1835 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1837 /* Should be named SvCatPVN_utf8_upgrade? */
1838 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1841 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1843 sv_setpvn(nsv, sstr, slen); \
1845 sv_utf8_upgrade(nsv); \
1846 sv_catsv(dsv, nsv); \
1850 =for apidoc Am|SV*|newRV_inc|SV* sv
1852 Creates an RV wrapper for an SV. The reference count for the original SV is
1858 #define newRV_inc(sv) newRV(sv)
1860 /* the following macros update any magic values this sv is associated with */
1863 =head1 Magical Functions
1865 =for apidoc Am|void|SvGETMAGIC|SV* sv
1866 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1867 argument more than once.
1869 =for apidoc Am|void|SvSETMAGIC|SV* sv
1870 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1871 argument more than once.
1873 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1874 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1877 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1878 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1879 ssv. May evaluate arguments more than once.
1881 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1882 Like C<SvSetSV>, but does any set magic required afterwards.
1884 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1885 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1887 =for apidoc Am|void|SvSHARE|SV* sv
1888 Arranges for sv to be shared between threads if a suitable module
1891 =for apidoc Am|void|SvLOCK|SV* sv
1892 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1895 =for apidoc Am|void|SvUNLOCK|SV* sv
1896 Releases a mutual exclusion lock on sv if a suitable module
1899 =head1 SV Manipulation Functions
1901 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1902 Expands the character buffer in the SV so that it has room for the
1903 indicated number of bytes (remember to reserve space for an extra trailing
1904 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1905 Returns a pointer to the character buffer.
1910 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1911 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1912 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1914 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1915 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1917 #define SvSetSV_and(dst,src,finally) \
1919 if ((dst) != (src)) { \
1920 sv_setsv(dst, src); \
1924 #define SvSetSV_nosteal_and(dst,src,finally) \
1926 if ((dst) != (src)) { \
1927 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
1932 #define SvSetSV(dst,src) \
1933 SvSetSV_and(dst,src,/*nothing*/;)
1934 #define SvSetSV_nosteal(dst,src) \
1935 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1937 #define SvSetMagicSV(dst,src) \
1938 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1939 #define SvSetMagicSV_nosteal(dst,src) \
1940 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1943 #if !defined(SKIP_DEBUGGING)
1944 #define SvPEEK(sv) sv_peek(sv)
1946 #define SvPEEK(sv) ""
1949 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1951 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1953 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1954 /* If I give every macro argument a different name, then there won't be bugs
1955 where nested macros get confused. Been there, done that. */
1956 #define isGV_with_GP(pwadak) \
1957 (((SvFLAGS(pwadak) & (SVp_POK|SVp_SCREAM)) == SVp_SCREAM) \
1958 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
1960 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1961 #define SvGROW_mutable(sv,len) \
1962 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1963 #define Sv_Grow sv_grow
1965 #define CLONEf_COPY_STACKS 1
1966 #define CLONEf_KEEP_PTR_TABLE 2
1967 #define CLONEf_CLONE_HOST 4
1968 #define CLONEf_JOIN_IN 8
1970 struct clone_params {
1973 PerlInterpreter *proto_perl;
1978 * c-indentation-style: bsd
1980 * indent-tabs-mode: t
1983 * ex: set ts=8 sts=4 sw=4 noet: