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 */ \
103 struct STRUCT_SV { /* struct sv { */
106 #ifdef DEBUG_LEAKING_SCALARS
107 unsigned sv_debug_optype:9; /* the type of OP that allocated us */
108 unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */
109 unsigned sv_debug_cloned:1; /* was cloned for an ithread */
110 unsigned sv_debug_line:16; /* the line where we were allocated */
111 char * sv_debug_file; /* the file where we were allocated */
116 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
121 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
126 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
131 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
136 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
141 #undef _SV_HEAD_UNION /* ensure no pollution */
144 =head1 SV Manipulation Functions
146 =for apidoc Am|U32|SvREFCNT|SV* sv
147 Returns the value of the object's reference count.
149 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
150 Increments the reference count of the given SV.
152 =for apidoc Am|void|SvREFCNT_dec|SV* sv
153 Decrements the reference count of the given SV.
155 =for apidoc Am|svtype|SvTYPE|SV* sv
156 Returns the type of the SV. See C<svtype>.
158 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
159 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
160 perform the upgrade if necessary. See C<svtype>.
165 #define SvANY(sv) (sv)->sv_any
166 #define SvFLAGS(sv) (sv)->sv_flags
167 #define SvREFCNT(sv) (sv)->sv_refcnt
169 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
170 # define SvREFCNT_inc(sv) \
172 SV * const _sv = (SV*)(sv); \
178 # define SvREFCNT_inc(sv) \
179 ((PL_Sv=(SV*)(sv)) ? ((++(SvREFCNT(PL_Sv))),(PL_Sv)) : NULL)
182 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
183 # define SvREFCNT_dec(sv) \
185 SV * const _sv = (SV*)(sv); \
187 if (SvREFCNT(_sv)) { \
188 if (--(SvREFCNT(_sv)) == 0) \
189 Perl_sv_free2(aTHX_ _sv); \
196 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
199 #define SVTYPEMASK 0xff
200 #define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
202 /* Sadly there are some parts of the core that have pointers to already-freed
203 SV heads, and rely on being able to tell that they are now free. So mark
204 them all by using a consistent macro. */
205 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
207 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
209 #define SVf_IOK 0x00000100 /* has valid public integer value */
210 #define SVf_NOK 0x00000200 /* has valid public numeric value */
211 #define SVf_POK 0x00000400 /* has valid public pointer value */
212 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
214 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
215 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
216 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
217 #define SVp_SCREAM 0x00008000 /* has been studied? */
218 #define SVphv_CLONEABLE 0x00008000 /* PVHV (stashes) clone its objects */
220 #define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
221 #define SVs_PADTMP 0x00020000 /* in use as tmp */
222 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
223 #define SVs_TEMP 0x00080000 /* string is stealable? */
224 #define SVs_OBJECT 0x00100000 /* is "blessed" */
225 #define SVs_GMG 0x00200000 /* has magical get method */
226 #define SVs_SMG 0x00400000 /* has magical set method */
227 #define SVs_RMG 0x00800000 /* has random magical methods */
229 #define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
230 1: SV head arena wasn't malloc()ed
231 2: in conjunction with SVf_READONLY
232 marks a shared hash key scalar
233 (SvLEN == 0) or a copy on write
234 string (SvLEN != 0) [SvIsCOW(sv)]
235 3: For PVCV, whether CvUNIQUE(cv)
236 refers to an eval or once only
237 [CvEVAL(cv), CvSPECIAL(cv)]
238 4: Whether the regexp pointer is in
239 fact an offset [SvREPADTMP(sv)]
241 #define SVf_OOK 0x02000000 /* has valid offset value
242 For a PVHV this means that a
243 hv_aux struct is present after the
245 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used
246 * by SV's in final arena cleanup */
247 #define SVf_READONLY 0x08000000 /* may not be modified */
252 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
254 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
255 SVp_IOK|SVp_NOK|SVp_POK)
257 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
259 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
260 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
261 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
263 /* Some private flags. */
266 #define SVphv_REHASH 0x10000000 /* PVHV is recalculating hash values */
268 #define SVphv_SHAREKEYS 0x20000000 /* PVHV
269 keys live on shared string table */
270 /* PVNV, PVMG, PVGV, presumably only inside pads */
271 #define SVpad_TYPED 0x40000000 /* Typed Lexical */
273 #define SVpav_REAL 0x40000000 /* free old entries */
275 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
277 #define SVpbm_TAIL 0x40000000
279 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
281 /* PVNV, PVMG, PVGV, presumably only inside pads */
282 #define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
283 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
284 /* Presumably IVs aren't stored in pads */
285 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
287 #define SVpav_REIFY 0x80000000 /* can become real */
289 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
291 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
293 #define SVpbm_VALID 0x80000000
294 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
295 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
299 NV xnv_nv; /* numeric value, if any */
300 STRLEN xpv_cur; /* length of svu_pv as a C string */
301 STRLEN xpv_len; /* allocated size */
305 typedef struct xpv xpv_allocated;
308 STRLEN xpv_cur; /* length of svu_pv as a C string */
309 STRLEN xpv_len; /* allocated size */
314 NV xnv_nv; /* numeric value, if any */
315 STRLEN xpv_cur; /* length of svu_pv as a C string */
316 STRLEN xpv_len; /* allocated size */
318 IV xivu_iv; /* integer value or pv offset */
326 typedef struct xpviv xpviv_allocated;
329 STRLEN xpv_cur; /* length of svu_pv as a C string */
330 STRLEN xpv_len; /* allocated size */
332 IV xivu_iv; /* integer value or pv offset */
340 #define xiv_iv xiv_u.xivu_iv
343 NV xnv_nv; /* numeric value, if any */
344 STRLEN xpv_cur; /* length of svu_pv as a C string */
345 STRLEN xpv_len; /* allocated size */
348 UV xuvu_uv; /* unsigned value or pv offset */
353 #define xuv_uv xuv_u.xuvu_uv
356 NV xnv_nv; /* numeric value, if any */
357 STRLEN xpv_cur; /* length of svu_pv as a C string */
358 STRLEN xpv_len; /* allocated size */
360 IV xivu_iv; /* integer value or pv offset */
367 /* These structure must match the beginning of struct xpvhv in hv.h. */
369 NV xnv_nv; /* numeric value, if any */
370 STRLEN xpv_cur; /* length of svu_pv as a C string */
371 STRLEN xpv_len; /* allocated size */
373 IV xivu_iv; /* integer value or pv offset */
378 MAGIC* xmg_magic; /* linked list of magicalness */
379 HV* xmg_stash; /* class package */
383 NV xnv_nv; /* numeric value, if any */
384 STRLEN xpv_cur; /* length of svu_pv as a C string */
385 STRLEN xpv_len; /* allocated size */
387 IV xivu_iv; /* integer value or pv offset */
392 MAGIC* xmg_magic; /* linked list of magicalness */
393 HV* xmg_stash; /* class package */
395 /* a full glob fits into this */
405 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
406 * y=alem/helem/iter t=tie T=tied HE */
410 NV xnv_nv; /* numeric value, if any */
411 STRLEN xpv_cur; /* length of svu_pv as a C string */
412 STRLEN xpv_len; /* allocated size */
414 IV xivu_iv; /* integer value or pv offset */
419 MAGIC* xmg_magic; /* linked list of magicalness */
420 HV* xmg_stash; /* class package */
430 NV xnv_nv; /* numeric value, if any */
431 STRLEN xpv_cur; /* length of svu_pv as a C string */
432 STRLEN xpv_len; /* allocated size */
434 IV xivu_iv; /* integer value or pv offset */
439 MAGIC* xmg_magic; /* linked list of magicalness */
440 HV* xmg_stash; /* class package */
442 I32 xbm_useful; /* is this constant pattern being useful? */
443 U16 xbm_previous; /* how many characters in string before rare? */
444 U8 xbm_rare; /* rarest character in string */
447 /* This structure must match XPVCV in cv.h */
449 typedef U16 cv_flags_t;
452 NV xnv_nv; /* numeric value, if any */
453 STRLEN xpv_cur; /* length of svu_pv as a C string */
454 STRLEN xpv_len; /* allocated size */
456 IV xivu_iv; /* PVFMs use the pv offset */
461 MAGIC* xmg_magic; /* linked list of magicalness */
462 HV* xmg_stash; /* class package */
471 void (*xcv_xsub) (pTHX_ CV*);
477 U32 xcv_outside_seq; /* the COP sequence (at the point of our
478 * compilation) in the lexically enclosing
480 cv_flags_t xcv_flags;
485 STRLEN xpv_cur; /* length of svu_pv as a C string */
486 STRLEN xpv_len; /* allocated size */
488 IV xivu_iv; /* PVFMs use the pv offset */
493 MAGIC* xmg_magic; /* linked list of magicalness */
494 HV* xmg_stash; /* class package */
503 void (*xcv_xsub) (pTHX_ CV*);
509 U32 xcv_outside_seq; /* the COP sequence (at the point of our
510 * compilation) in the lexically enclosing
512 cv_flags_t xcv_flags;
517 NV xnv_nv; /* numeric value, if any */
518 STRLEN xpv_cur; /* length of svu_pv as a C string */
519 STRLEN xpv_len; /* allocated size */
521 IV xivu_iv; /* integer value or pv offset */
526 MAGIC* xmg_magic; /* linked list of magicalness */
527 HV* xmg_stash; /* class package */
529 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
530 PerlIO * xio_ofp; /* but sockets need separate streams */
531 /* Cray addresses everything by word boundaries (64 bits) and
532 * code and data pointers cannot be mixed (which is exactly what
533 * Perl_filter_add() tries to do with the dirp), hence the following
534 * union trick (as suggested by Gurusamy Sarathy).
535 * For further information see Geir Johansen's problem report titled
536 [ID 20000612.002] Perl problem on Cray system
537 * The any pointer (known as IoANY()) will also be a good place
538 * to hang any IO disciplines to.
541 DIR * xiou_dirp; /* for opendir, readdir, etc */
542 void * xiou_any; /* for alignment */
544 IV xio_lines; /* $. */
545 IV xio_page; /* $% */
546 IV xio_page_len; /* $= */
547 IV xio_lines_left; /* $- */
548 char * xio_top_name; /* $^ */
549 GV * xio_top_gv; /* $^ */
550 char * xio_fmt_name; /* $~ */
551 GV * xio_fmt_gv; /* $~ */
552 char * xio_bottom_name;/* $^B */
553 GV * xio_bottom_gv; /* $^B */
554 short xio_subprocess; /* -| or |- */
558 #define xio_dirp xio_dirpu.xiou_dirp
559 #define xio_any xio_dirpu.xiou_any
561 #define IOf_ARGV 1 /* this fp iterates over ARGV */
562 #define IOf_START 2 /* check for null ARGV and substitute '-' */
563 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
564 #define IOf_DIDTOP 8 /* just did top of form */
565 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
566 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
567 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
569 /* The following macros define implementation-independent predicates on SVs. */
572 =for apidoc Am|bool|SvNIOK|SV* sv
573 Returns a boolean indicating whether the SV contains a number, integer or
576 =for apidoc Am|bool|SvNIOKp|SV* sv
577 Returns a boolean indicating whether the SV contains a number, integer or
578 double. Checks the B<private> setting. Use C<SvNIOK>.
580 =for apidoc Am|void|SvNIOK_off|SV* sv
581 Unsets the NV/IV status of an SV.
583 =for apidoc Am|bool|SvOK|SV* sv
584 Returns a boolean indicating whether the value is an SV. It also tells
585 whether the value is defined or not.
587 =for apidoc Am|bool|SvIOKp|SV* sv
588 Returns a boolean indicating whether the SV contains an integer. Checks
589 the B<private> setting. Use C<SvIOK>.
591 =for apidoc Am|bool|SvNOKp|SV* sv
592 Returns a boolean indicating whether the SV contains a double. Checks the
593 B<private> setting. Use C<SvNOK>.
595 =for apidoc Am|bool|SvPOKp|SV* sv
596 Returns a boolean indicating whether the SV contains a character string.
597 Checks the B<private> setting. Use C<SvPOK>.
599 =for apidoc Am|bool|SvIOK|SV* sv
600 Returns a boolean indicating whether the SV contains an integer.
602 =for apidoc Am|void|SvIOK_on|SV* sv
603 Tells an SV that it is an integer.
605 =for apidoc Am|void|SvIOK_off|SV* sv
606 Unsets the IV status of an SV.
608 =for apidoc Am|void|SvIOK_only|SV* sv
609 Tells an SV that it is an integer and disables all other OK bits.
611 =for apidoc Am|void|SvIOK_only_UV|SV* sv
612 Tells and SV that it is an unsigned integer and disables all other OK bits.
614 =for apidoc Am|bool|SvIOK_UV|SV* sv
615 Returns a boolean indicating whether the SV contains an unsigned integer.
617 =for apidoc Am|void|SvUOK|SV* sv
618 Returns a boolean indicating whether the SV contains an unsigned integer.
620 =for apidoc Am|bool|SvIOK_notUV|SV* sv
621 Returns a boolean indicating whether the SV contains a signed integer.
623 =for apidoc Am|bool|SvNOK|SV* sv
624 Returns a boolean indicating whether the SV contains a double.
626 =for apidoc Am|void|SvNOK_on|SV* sv
627 Tells an SV that it is a double.
629 =for apidoc Am|void|SvNOK_off|SV* sv
630 Unsets the NV status of an SV.
632 =for apidoc Am|void|SvNOK_only|SV* sv
633 Tells an SV that it is a double and disables all other OK bits.
635 =for apidoc Am|bool|SvPOK|SV* sv
636 Returns a boolean indicating whether the SV contains a character
639 =for apidoc Am|void|SvPOK_on|SV* sv
640 Tells an SV that it is a string.
642 =for apidoc Am|void|SvPOK_off|SV* sv
643 Unsets the PV status of an SV.
645 =for apidoc Am|void|SvPOK_only|SV* sv
646 Tells an SV that it is a string and disables all other OK bits.
647 Will also turn off the UTF-8 status.
649 =for apidoc Am|bool|SvVOK|SV* sv
650 Returns a boolean indicating whether the SV contains a v-string.
652 =for apidoc Am|bool|SvOOK|SV* sv
653 Returns a boolean indicating whether the SvIVX is a valid offset value for
654 the SvPVX. This hack is used internally to speed up removal of characters
655 from the beginning of a SvPV. When SvOOK is true, then the start of the
656 allocated string buffer is really (SvPVX - SvIVX).
658 =for apidoc Am|bool|SvROK|SV* sv
659 Tests if the SV is an RV.
661 =for apidoc Am|void|SvROK_on|SV* sv
662 Tells an SV that it is an RV.
664 =for apidoc Am|void|SvROK_off|SV* sv
665 Unsets the RV status of an SV.
667 =for apidoc Am|SV*|SvRV|SV* sv
668 Dereferences an RV to return the SV.
670 =for apidoc Am|IV|SvIVX|SV* sv
671 Returns the raw value in the SV's IV slot, without checks or conversions.
672 Only use when you are sure SvIOK is true. See also C<SvIV()>.
674 =for apidoc Am|UV|SvUVX|SV* sv
675 Returns the raw value in the SV's UV slot, without checks or conversions.
676 Only use when you are sure SvIOK is true. See also C<SvUV()>.
678 =for apidoc Am|NV|SvNVX|SV* sv
679 Returns the raw value in the SV's NV slot, without checks or conversions.
680 Only use when you are sure SvNOK is true. See also C<SvNV()>.
682 =for apidoc Am|char*|SvPVX|SV* sv
683 Returns a pointer to the physical string in the SV. The SV must contain a
686 =for apidoc Am|STRLEN|SvCUR|SV* sv
687 Returns the length of the string which is in the SV. See C<SvLEN>.
689 =for apidoc Am|STRLEN|SvLEN|SV* sv
690 Returns the size of the string buffer in the SV, not including any part
691 attributable to C<SvOOK>. See C<SvCUR>.
693 =for apidoc Am|char*|SvEND|SV* sv
694 Returns a pointer to the last character in the string which is in the SV.
695 See C<SvCUR>. Access the character as *(SvEND(sv)).
697 =for apidoc Am|HV*|SvSTASH|SV* sv
698 Returns the stash of the SV.
700 =for apidoc Am|void|SvIV_set|SV* sv|IV val
701 Set the value of the IV pointer in sv to val. It is possible to perform
702 the same function of this macro with an lvalue assignment to C<SvIVX>.
703 With future Perls, however, it will be more efficient to use
704 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
706 =for apidoc Am|void|SvNV_set|SV* sv|NV val
707 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
709 =for apidoc Am|void|SvPV_set|SV* sv|char* val
710 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
712 =for apidoc Am|void|SvUV_set|SV* sv|UV val
713 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
715 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
716 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
718 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
719 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
721 =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
722 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
724 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
725 Set the current length of the string which is in the SV. See C<SvCUR>
728 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
729 Set the actual length of the string which is in the SV. See C<SvIV_set>.
734 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
735 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
736 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
737 SVp_IOK|SVp_NOK|SVf_IVisUV))
739 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
740 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
742 #define assert_not_ROK(sv)
745 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
746 #define SvOK_off(sv) (assert_not_ROK(sv) \
747 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
748 SVf_IVisUV|SVf_UTF8), \
750 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
751 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
755 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
756 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
757 #define SvIOKp_on(sv) (SvRELEASE_IVX(sv), \
758 SvFLAGS(sv) |= SVp_IOK)
759 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
760 #define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
761 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
762 #define SvPOKp_on(sv) (assert_not_ROK(sv) \
763 SvFLAGS(sv) |= SVp_POK)
765 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
766 #define SvIOK_on(sv) (SvRELEASE_IVX(sv), \
767 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
768 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
769 #define SvIOK_only(sv) (SvOK_off(sv), \
770 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
771 #define SvIOK_only_UV(sv) (SvOK_off_exc_UV(sv), \
772 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
774 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
775 == (SVf_IOK|SVf_IVisUV))
776 #define SvUOK(sv) SvIOK_UV(sv)
777 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
780 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
781 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
782 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
784 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
785 #define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
786 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
787 #define SvNOK_only(sv) (SvOK_off(sv), \
788 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
791 =for apidoc Am|bool|SvUTF8|SV* sv
792 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
794 =for apidoc Am|void|SvUTF8_on|SV *sv
795 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
796 Do not use frivolously.
798 =for apidoc Am|void|SvUTF8_off|SV *sv
799 Unsets the UTF-8 status of an SV.
801 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
802 Tells an SV that it is a string and disables all other OK bits,
803 and leaves the UTF-8 status as it was.
808 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
810 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
811 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
812 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
814 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
815 #define SvPOK_on(sv) (assert_not_ROK(sv) \
816 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
817 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
818 #define SvPOK_only(sv) (assert_not_ROK(sv) \
819 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
820 SVf_IVisUV|SVf_UTF8), \
821 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
822 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) \
823 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
825 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
827 #define SvVOK(sv) (SvMAGICAL(sv) \
828 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
829 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
830 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
831 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
833 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
834 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
835 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
837 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
838 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
839 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
841 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
842 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
843 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
845 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
846 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
847 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
849 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
850 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
851 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
853 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
854 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
855 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
857 #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
858 #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
859 #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
861 #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
864 #define Gv_AMG(stash) \
865 (HV_AMAGICmb(stash) && \
866 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
868 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
870 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
871 == (SVf_ROK|SVprv_WEAKREF))
872 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
873 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
875 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
877 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
878 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
879 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
881 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
882 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
883 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
885 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
886 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
888 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
889 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
890 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
892 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
893 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
894 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
896 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
897 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
898 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
900 #define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
901 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
902 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
904 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
905 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
906 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
908 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
909 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
910 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
912 #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
913 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
914 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
916 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
917 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
918 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
921 /* The following uses the FAKE flag to show that a regex pointer is infact
922 its own offset in the regexpad for ithreads */
923 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
924 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
925 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
928 #ifdef PERL_DEBUG_COW
929 #define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
931 #define SvRV(sv) ((sv)->sv_u.svu_rv)
933 #define SvRVx(sv) SvRV(sv)
935 #ifdef PERL_DEBUG_COW
936 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
937 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
938 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
939 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
940 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_nv)
941 /* Don't test the core XS code yet. */
942 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
943 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
945 # define SvPVX(sv) SvPVX_mutable(sv)
947 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
948 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
949 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
953 /* Can't make this RVALUE because of Perl_sv_unmagic. */
954 # define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
956 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
958 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
961 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
963 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_magic)
965 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
968 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
969 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
970 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
971 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
973 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
974 /* These get expanded inside other macros that already use a variable _sv */
976 (*({ SV *const _svi = (SV *) sv; \
977 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
978 assert(SvTYPE(_svi) != SVt_PVAV); \
979 assert(SvTYPE(_svi) != SVt_PVHV); \
980 assert(SvTYPE(_svi) != SVt_PVCV); \
981 &(((XPVIV*) SvANY(_svi))->xiv_iv); \
984 (*({ SV *const _svi = (SV *) sv; \
985 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
986 assert(SvTYPE(_svi) != SVt_PVAV); \
987 assert(SvTYPE(_svi) != SVt_PVHV); \
988 assert(SvTYPE(_svi) != SVt_PVCV); \
989 &(((XPVUV*) SvANY(_svi))->xuv_uv); \
992 (*({ SV *const _svi = (SV *) sv; \
993 assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \
994 assert(SvTYPE(_svi) != SVt_PVAV); \
995 assert(SvTYPE(_svi) != SVt_PVHV); \
996 assert(SvTYPE(_svi) != SVt_PVFM); \
997 &(((XPVNV*) SvANY(_svi))->xnv_nv); \
999 # define SvMAGIC(sv) \
1000 (*({ SV *const _svi = (SV *) sv; \
1001 assert(SvTYPE(_svi) >= SVt_PVMG); \
1002 &(((XPVMG*) SvANY(_svi))->xmg_magic); \
1004 # define SvSTASH(sv) \
1005 (*({ SV *const _svi = (SV *) sv; \
1006 assert(SvTYPE(_svi) >= SVt_PVMG); \
1007 &(((XPVMG*) SvANY(_svi))->xmg_stash); \
1010 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1011 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1012 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_nv
1013 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
1014 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1019 /* Given that these two are new, there can't be any existing code using them
1021 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1022 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1024 /* Except for the poison code, which uses & to scribble over the pointer after
1025 free() is called. */
1026 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1027 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1030 #define SvIVXx(sv) SvIVX(sv)
1031 #define SvUVXx(sv) SvUVX(sv)
1032 #define SvNVXx(sv) SvNVX(sv)
1033 #define SvPVXx(sv) SvPVX(sv)
1034 #define SvLENx(sv) SvLEN(sv)
1035 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1038 /* Ask a scalar nicely to try to become an IV, if possible.
1039 Not guaranteed to stay returning void */
1040 /* Macro won't actually call sv_2iv if already IOK */
1041 #define SvIV_please(sv) \
1042 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1043 (void) SvIV(sv); } STMT_END
1044 #define SvIV_set(sv, val) \
1045 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1046 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1047 #define SvNV_set(sv, val) \
1048 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1049 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1050 (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END
1051 #define SvPV_set(sv, val) \
1052 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1053 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1054 #define SvUV_set(sv, val) \
1055 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1056 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1057 #define SvRV_set(sv, val) \
1058 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
1059 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1060 #define SvMAGIC_set(sv, val) \
1061 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1062 (((XPVMG*)SvANY(sv))->xmg_magic = (val)); } STMT_END
1063 #define SvSTASH_set(sv, val) \
1064 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1065 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1066 #define SvCUR_set(sv, val) \
1067 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1068 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1069 #define SvLEN_set(sv, val) \
1070 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1071 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1072 #define SvEND_set(sv, val) \
1073 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1074 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
1076 #define SvPV_renew(sv,n) \
1077 STMT_START { SvLEN_set(sv, n); \
1078 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1079 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1080 (MEM_SIZE)((n))))); \
1083 #define SvPV_shrink_to_cur(sv) STMT_START { \
1084 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1085 SvPV_renew(sv, _lEnGtH); \
1088 #define SvPV_free(sv) \
1090 assert(SvTYPE(sv) >= SVt_PV); \
1093 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \
1094 SvFLAGS(sv) &= ~SVf_OOK; \
1096 Safefree(SvPVX(sv)); \
1100 #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
1101 #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
1102 #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
1104 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1106 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1107 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1108 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1109 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1111 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1112 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1113 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1114 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1115 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1116 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1117 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1118 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1119 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1120 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1121 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1122 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1123 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1124 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1125 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
1126 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1127 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1129 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1130 #define IoTYPE_RDONLY '<'
1131 #define IoTYPE_WRONLY '>'
1132 #define IoTYPE_RDWR '+'
1133 #define IoTYPE_APPEND 'a'
1134 #define IoTYPE_PIPE '|'
1135 #define IoTYPE_STD '-' /* stdin or stdout */
1136 #define IoTYPE_SOCKET 's'
1137 #define IoTYPE_CLOSED ' '
1138 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1139 #define IoTYPE_NUMERIC '#' /* fdopen */
1142 =for apidoc Am|bool|SvTAINTED|SV* sv
1143 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1146 =for apidoc Am|void|SvTAINTED_on|SV* sv
1147 Marks an SV as tainted if tainting is enabled.
1149 =for apidoc Am|void|SvTAINTED_off|SV* sv
1150 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1151 some of Perl's fundamental security features. XS module authors should not
1152 use this function unless they fully understand all the implications of
1153 unconditionally untainting the value. Untainting should be done in the
1154 standard perl fashion, via a carefully crafted regexp, rather than directly
1155 untainting variables.
1157 =for apidoc Am|void|SvTAINT|SV* sv
1158 Taints an SV if tainting is enabled.
1163 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1165 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1166 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1167 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1169 #define SvTAINT(sv) \
1171 if (PL_tainting) { \
1178 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1179 Like C<SvPV> but will force the SV into containing just a string
1180 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1183 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1184 Like C<SvPV> but will force the SV into containing just a string
1185 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1186 directly. Doesn't process magic.
1188 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1189 Returns a pointer to the string in the SV, or a stringified form of
1190 the SV if the SV does not contain a string. The SV may cache the
1191 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1192 C<SvPVx> for a version which guarantees to evaluate sv only once.
1194 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1195 A version of C<SvPV> which guarantees to evaluate sv only once.
1197 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1198 Like C<SvPV> but doesn't process magic.
1200 =for apidoc Am|char*|SvPV_nolen|SV* sv
1201 Returns a pointer to the string in the SV, or a stringified form of
1202 the SV if the SV does not contain a string. The SV may cache the
1203 stringified form becoming C<SvPOK>. Handles 'get' magic.
1205 =for apidoc Am|IV|SvIV|SV* sv
1206 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1207 version which guarantees to evaluate sv only once.
1209 =for apidoc Am|IV|SvIV_nomg|SV* sv
1210 Like C<SvIV> but doesn't process magic.
1212 =for apidoc Am|IV|SvIVx|SV* sv
1213 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1214 sv only once. Use the more efficient C<SvIV> otherwise.
1216 =for apidoc Am|NV|SvNV|SV* sv
1217 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1218 which guarantees to evaluate sv only once.
1220 =for apidoc Am|NV|SvNVx|SV* sv
1221 Coerces the given SV to a double and returns it. Guarantees to evaluate
1222 sv only once. Use the more efficient C<SvNV> otherwise.
1224 =for apidoc Am|UV|SvUV|SV* sv
1225 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1226 for a version which guarantees to evaluate sv only once.
1228 =for apidoc Am|UV|SvUV_nomg|SV* sv
1229 Like C<SvUV> but doesn't process magic.
1231 =for apidoc Am|UV|SvUVx|SV* sv
1232 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1233 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1235 =for apidoc Am|bool|SvTRUE|SV* sv
1236 Returns a boolean indicating whether Perl would evaluate the SV as true or
1237 false, defined or undefined. Does not handle 'get' magic.
1239 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1240 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1242 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1243 Like C<SvPV>, but converts sv to utf8 first if necessary.
1245 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1246 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1248 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1249 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1251 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1252 Like C<SvPV>, but converts sv to byte representation first if necessary.
1254 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1255 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1257 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1258 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1259 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1262 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1263 Like C<SvPV>, but converts sv to utf8 first if necessary.
1264 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1267 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1268 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1269 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1272 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1273 Like C<SvPV>, but converts sv to byte representation first if necessary.
1274 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1277 =for apidoc Am|bool|SvIsCOW|SV* sv
1278 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1279 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1282 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1283 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1286 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1287 Like C<sv_catpvn> but doesn't process magic.
1289 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1290 Like C<sv_setsv> but doesn't process magic.
1292 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1293 Like C<sv_catsv> but doesn't process magic.
1298 /* Let us hope that bitmaps for UV and IV are the same */
1299 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1300 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1301 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1303 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1304 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1308 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1309 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1310 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1312 #define SvPV_flags(sv, lp, flags) \
1313 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1314 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1315 #define SvPV_flags_const(sv, lp, flags) \
1316 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1317 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1318 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1319 #define SvPV_flags_const_nolen(sv, flags) \
1320 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1321 ? SvPVX_const(sv) : \
1322 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1323 #define SvPV_flags_mutable(sv, lp, flags) \
1324 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1325 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1326 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1328 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1329 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1330 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1332 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1333 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1335 #define SvPV_force_flags(sv, lp, flags) \
1336 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1337 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1338 #define SvPV_force_flags_nolen(sv, flags) \
1339 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1340 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1341 #define SvPV_force_flags_mutable(sv, lp, flags) \
1342 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1343 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1344 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1346 #define SvPV_nolen(sv) \
1347 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1348 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1350 #define SvPV_nolen_const(sv) \
1351 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1352 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1354 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1355 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1356 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1360 #define SvPVutf8(sv, lp) \
1361 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1362 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1364 #define SvPVutf8_force(sv, lp) \
1365 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1366 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1369 #define SvPVutf8_nolen(sv) \
1370 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1371 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1375 #define SvPVbyte(sv, lp) \
1376 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1377 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1379 #define SvPVbyte_force(sv, lp) \
1380 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1381 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1383 #define SvPVbyte_nolen(sv) \
1384 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1385 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1389 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1390 * var to evaluate the arg once; failing that, use a global if possible;
1391 * failing that, call a function to do the work
1394 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1395 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1396 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1398 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1400 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1401 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1402 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1403 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1404 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1405 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1406 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1407 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1408 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1409 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1410 # define SvTRUE(sv) ( \
1414 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1416 (nxpv->xpv_cur > 1 || \
1417 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1424 ? SvNVX(sv) != 0.0 \
1426 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1428 #else /* __GNUC__ */
1430 /* These inlined macros use globals, which will require a thread
1431 * declaration in user code, so we avoid them under threads */
1433 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1434 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1435 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1436 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1437 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1438 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1439 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1440 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1441 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1442 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1443 # define SvTRUE(sv) ( \
1447 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1448 (PL_Xpv->xpv_cur > 1 || \
1449 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1456 ? SvNVX(sv) != 0.0 \
1458 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1459 #endif /* __GNU__ */
1461 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1462 (SVf_FAKE | SVf_READONLY))
1463 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1465 #define SvSHARED_HEK_FROM_PV(pvx) \
1466 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1467 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1469 /* flag values for sv_*_flags functions */
1470 #define SV_IMMEDIATE_UNREF 1
1472 #define SV_COW_DROP_PV 4
1473 #define SV_UTF8_NO_ENCODING 8
1474 #define SV_NOSTEAL 16
1475 #define SV_CONST_RETURN 32
1476 #define SV_MUTABLE_RETURN 64
1477 #define SV_SMAGIC 128
1479 #define sv_unref(sv) sv_unref_flags(sv, 0)
1480 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1482 /* We are about to replace the SV's current value. So if it's copy on write
1483 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1484 the value is about to get thrown away, so drop the PV rather than go to
1485 the effort of making a read-write copy only for it to get immediately
1488 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1489 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1491 #ifdef PERL_OLD_COPY_ON_WRITE
1492 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1493 && Perl_sv_release_IVX(aTHX_ sv)))
1494 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1496 # define SvRELEASE_IVX(sv) SvOOK_off(sv)
1497 #endif /* PERL_OLD_COPY_ON_WRITE */
1499 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1500 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1501 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1502 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1504 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1505 sv_force_normal_flags(sv, 0)
1508 /* all these 'functions' are now just macros */
1510 #define sv_pv(sv) SvPV_nolen(sv)
1511 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1512 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1514 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1515 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1516 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1517 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1518 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1519 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1520 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1521 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1522 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1523 #define sv_catpvn_mg(sv, sstr, slen) \
1524 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1525 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1526 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1527 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1528 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1529 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1530 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1531 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1532 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1533 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1535 /* Should be named SvCatPVN_utf8_upgrade? */
1536 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1539 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1541 sv_setpvn(nsv, sstr, slen); \
1543 sv_utf8_upgrade(nsv); \
1544 sv_catsv(dsv, nsv); \
1548 =for apidoc Am|SV*|newRV_inc|SV* sv
1550 Creates an RV wrapper for an SV. The reference count for the original SV is
1556 #define newRV_inc(sv) newRV(sv)
1558 /* the following macros update any magic values this sv is associated with */
1561 =head1 Magical Functions
1563 =for apidoc Am|void|SvGETMAGIC|SV* sv
1564 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1565 argument more than once.
1567 =for apidoc Am|void|SvSETMAGIC|SV* sv
1568 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1569 argument more than once.
1571 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1572 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1575 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1576 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1577 ssv. May evaluate arguments more than once.
1579 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1580 Like C<SvSetSV>, but does any set magic required afterwards.
1582 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1583 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1585 =for apidoc Am|void|SvSHARE|SV* sv
1586 Arranges for sv to be shared between threads if a suitable module
1589 =for apidoc Am|void|SvLOCK|SV* sv
1590 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1593 =for apidoc Am|void|SvUNLOCK|SV* sv
1594 Releases a mutual exclusion lock on sv if a suitable module
1597 =head1 SV Manipulation Functions
1599 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1600 Expands the character buffer in the SV so that it has room for the
1601 indicated number of bytes (remember to reserve space for an extra trailing
1602 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1603 Returns a pointer to the character buffer.
1608 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1609 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1610 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1612 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1613 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1615 #define SvSetSV_and(dst,src,finally) \
1617 if ((dst) != (src)) { \
1618 sv_setsv(dst, src); \
1622 #define SvSetSV_nosteal_and(dst,src,finally) \
1624 if ((dst) != (src)) { \
1625 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL); \
1630 #define SvSetSV(dst,src) \
1631 SvSetSV_and(dst,src,/*nothing*/;)
1632 #define SvSetSV_nosteal(dst,src) \
1633 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1635 #define SvSetMagicSV(dst,src) \
1636 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1637 #define SvSetMagicSV_nosteal(dst,src) \
1638 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1641 #if !defined(SKIP_DEBUGGING)
1642 #define SvPEEK(sv) sv_peek(sv)
1644 #define SvPEEK(sv) ""
1647 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1649 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1651 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1653 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1654 #define SvGROW_mutable(sv,len) \
1655 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1656 #define Sv_Grow sv_grow
1658 #define CLONEf_COPY_STACKS 1
1659 #define CLONEf_KEEP_PTR_TABLE 2
1660 #define CLONEf_CLONE_HOST 4
1661 #define CLONEf_JOIN_IN 8
1663 struct clone_params {
1666 PerlInterpreter *proto_perl;
1671 * c-indentation-style: bsd
1673 * indent-tabs-mode: t
1676 * ex: set ts=8 sts=4 sw=4 noet: