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 /* typedefs to eliminate some typing */
80 typedef struct hek HEK;
82 /* Using C's structural equivalence to help emulate C++ inheritance here... */
84 /* start with 2 sv-head building blocks */
85 #define _SV_HEAD(ptrtype) \
86 ptrtype sv_any; /* pointer to body */ \
87 U32 sv_refcnt; /* how many references to us */ \
88 U32 sv_flags /* what we are */
90 #define _SV_HEAD_UNION \
94 SV* svu_rv; /* pointer to another SV */ \
95 char* svu_pv; /* pointer to malloced string */ \
101 struct STRUCT_SV { /* struct sv { */
104 #ifdef DEBUG_LEAKING_SCALARS
105 unsigned sv_debug_optype:9; /* the type of OP that allocated us */
106 unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */
107 unsigned sv_debug_cloned:1; /* was cloned for an ithread */
108 unsigned sv_debug_line:16; /* the line where we were allocated */
109 char * sv_debug_file; /* the file where we were allocated */
114 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
119 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
124 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
129 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
134 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
139 #undef _SV_HEAD_UNION /* ensure no pollution */
142 =head1 SV Manipulation Functions
144 =for apidoc Am|U32|SvREFCNT|SV* sv
145 Returns the value of the object's reference count.
147 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
148 Increments the reference count of the given SV.
150 =for apidoc Am|void|SvREFCNT_dec|SV* sv
151 Decrements the reference count of the given SV.
153 =for apidoc Am|svtype|SvTYPE|SV* sv
154 Returns the type of the SV. See C<svtype>.
156 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
157 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
158 perform the upgrade if necessary. See C<svtype>.
163 #define SvANY(sv) (sv)->sv_any
164 #define SvFLAGS(sv) (sv)->sv_flags
165 #define SvREFCNT(sv) (sv)->sv_refcnt
167 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
168 # define SvREFCNT_inc(sv) \
170 SV * const _sv = (SV*)(sv); \
176 # define SvREFCNT_inc(sv) \
177 ((PL_Sv=(SV*)(sv)) ? ((++(SvREFCNT(PL_Sv))),(PL_Sv)) : NULL)
180 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
181 # define SvREFCNT_dec(sv) \
183 SV * const _sv = (SV*)(sv); \
185 if (SvREFCNT(_sv)) { \
186 if (--(SvREFCNT(_sv)) == 0) \
187 Perl_sv_free2(aTHX_ _sv); \
194 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
197 #define SVTYPEMASK 0xff
198 #define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
200 /* Sadly there are some parts of the core that have pointers to already-freed
201 SV heads, and rely on being able to tell that they are now free. So mark
202 them all by using a consistent macro. */
203 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
205 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
207 #define SVs_PADSTALE 0x00000100 /* lexical has gone out of scope */
208 #define SVs_PADTMP 0x00000200 /* in use as tmp */
209 #define SVs_PADMY 0x00000400 /* in use a "my" variable */
210 #define SVs_TEMP 0x00000800 /* string is stealable? */
211 #define SVs_OBJECT 0x00001000 /* is "blessed" */
212 #define SVs_GMG 0x00002000 /* has magical get method */
213 #define SVs_SMG 0x00004000 /* has magical set method */
214 #define SVs_RMG 0x00008000 /* has random magical methods */
216 #define SVf_IOK 0x00010000 /* has valid public integer value */
217 #define SVf_NOK 0x00020000 /* has valid public numeric value */
218 #define SVf_POK 0x00040000 /* has valid public pointer value */
219 #define SVf_ROK 0x00080000 /* has a valid reference pointer */
221 #define SVf_FAKE 0x00100000 /* glob or lexical is just a copy */
222 #define SVf_OOK 0x00200000 /* has valid offset value
223 For a PVHV this means that a
224 hv_aux struct is present after the
226 #define SVf_BREAK 0x00400000 /* refcnt is artificially low - used
227 * by SV's in final arena cleanup */
228 #define SVf_READONLY 0x00800000 /* may not be modified */
231 #define SVp_IOK 0x01000000 /* has valid non-public integer value */
232 #define SVp_NOK 0x02000000 /* has valid non-public numeric value */
233 #define SVp_POK 0x04000000 /* has valid non-public pointer value */
234 #define SVp_SCREAM 0x08000000 /* has been studied? */
236 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
237 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
239 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
241 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
242 SVp_IOK|SVp_NOK|SVp_POK)
244 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
246 #define PRIVSHIFT 8 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
248 /* Some private flags. */
250 /* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
251 #define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
252 #define SVpad_TYPED 0x40000000 /* Typed Lexical */
254 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
256 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
258 #define SVpbm_VALID 0x80000000
259 #define SVpbm_TAIL 0x40000000
261 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
263 #define SVphv_CLONEABLE 0x08000000 /* for stashes: clone its objects */
264 #define SVphv_REHASH 0x10000000 /* HV is recalculating hash values */
265 #define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */
266 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
267 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
269 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
271 #define SVpav_REAL 0x40000000 /* free old entries */
272 #define SVpav_REIFY 0x80000000 /* can become real */
275 NV xnv_nv; /* numeric value, if any */
276 STRLEN xpv_cur; /* length of svu_pv as a C string */
277 STRLEN xpv_len; /* allocated size */
281 typedef struct xpv xpv_allocated;
284 STRLEN xpv_cur; /* length of svu_pv as a C string */
285 STRLEN xpv_len; /* allocated size */
290 NV xnv_nv; /* numeric value, if any */
291 STRLEN xpv_cur; /* length of svu_pv as a C string */
292 STRLEN xpv_len; /* allocated size */
294 IV xivu_iv; /* integer value or pv offset */
301 typedef struct xpviv xpviv_allocated;
304 STRLEN xpv_cur; /* length of svu_pv as a C string */
305 STRLEN xpv_len; /* allocated size */
307 IV xivu_iv; /* integer value or pv offset */
314 #define xiv_iv xiv_u.xivu_iv
317 NV xnv_nv; /* numeric value, if any */
318 STRLEN xpv_cur; /* length of svu_pv as a C string */
319 STRLEN xpv_len; /* allocated size */
322 UV xuvu_uv; /* unsigned value or pv offset */
327 #define xuv_uv xuv_u.xuvu_uv
330 NV xnv_nv; /* numeric value, if any */
331 STRLEN xpv_cur; /* length of svu_pv as a C string */
332 STRLEN xpv_len; /* allocated size */
334 IV xivu_iv; /* integer value or pv offset */
340 /* These structure must match the beginning of struct xpvhv in hv.h. */
342 NV xnv_nv; /* numeric value, if any */
343 STRLEN xpv_cur; /* length of svu_pv as a C string */
344 STRLEN xpv_len; /* allocated size */
346 IV xivu_iv; /* integer value or pv offset */
350 MAGIC* xmg_magic; /* linked list of magicalness */
351 HV* xmg_stash; /* class package */
355 NV xnv_nv; /* numeric value, if any */
356 STRLEN xpv_cur; /* length of svu_pv as a C string */
357 STRLEN xpv_len; /* allocated size */
359 IV xivu_iv; /* integer value or pv offset */
363 MAGIC* xmg_magic; /* linked list of magicalness */
364 HV* xmg_stash; /* class package */
366 /* a full glob fits into this */
376 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
377 * y=alem/helem/iter t=tie T=tied HE */
381 NV xnv_nv; /* numeric value, if any */
382 STRLEN xpv_cur; /* length of svu_pv as a C string */
383 STRLEN xpv_len; /* allocated size */
385 IV xivu_iv; /* integer value or pv offset */
389 MAGIC* xmg_magic; /* linked list of magicalness */
390 HV* xmg_stash; /* class package */
400 NV xnv_nv; /* numeric value, if any */
401 STRLEN xpv_cur; /* length of svu_pv as a C string */
402 STRLEN xpv_len; /* allocated size */
404 IV xivu_iv; /* integer value or pv offset */
408 MAGIC* xmg_magic; /* linked list of magicalness */
409 HV* xmg_stash; /* class package */
411 I32 xbm_useful; /* is this constant pattern being useful? */
412 U16 xbm_previous; /* how many characters in string before rare? */
413 U8 xbm_rare; /* rarest character in string */
416 /* This structure must match XPVCV in cv.h */
418 typedef U16 cv_flags_t;
421 NV xnv_nv; /* numeric value, if any */
422 STRLEN xpv_cur; /* length of svu_pv as a C string */
423 STRLEN xpv_len; /* allocated size */
425 IV xivu_iv; /* integer value or pv offset */
429 MAGIC* xmg_magic; /* linked list of magicalness */
430 HV* xmg_stash; /* class package */
435 void (*xcv_xsub)(pTHX_ CV*);
439 long xcv_depth; /* >= 2 indicates recursive call */
442 cv_flags_t xcv_flags;
443 U32 xcv_outside_seq; /* the COP sequence (at the point of our
444 * compilation) in the lexically enclosing
450 NV xnv_nv; /* numeric value, if any */
451 STRLEN xpv_cur; /* length of svu_pv as a C string */
452 STRLEN xpv_len; /* allocated size */
454 IV xivu_iv; /* integer value or pv offset */
458 MAGIC* xmg_magic; /* linked list of magicalness */
459 HV* xmg_stash; /* class package */
461 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
462 PerlIO * xio_ofp; /* but sockets need separate streams */
463 /* Cray addresses everything by word boundaries (64 bits) and
464 * code and data pointers cannot be mixed (which is exactly what
465 * Perl_filter_add() tries to do with the dirp), hence the following
466 * union trick (as suggested by Gurusamy Sarathy).
467 * For further information see Geir Johansen's problem report titled
468 [ID 20000612.002] Perl problem on Cray system
469 * The any pointer (known as IoANY()) will also be a good place
470 * to hang any IO disciplines to.
473 DIR * xiou_dirp; /* for opendir, readdir, etc */
474 void * xiou_any; /* for alignment */
476 IV xio_lines; /* $. */
477 IV xio_page; /* $% */
478 IV xio_page_len; /* $= */
479 IV xio_lines_left; /* $- */
480 char * xio_top_name; /* $^ */
481 GV * xio_top_gv; /* $^ */
482 char * xio_fmt_name; /* $~ */
483 GV * xio_fmt_gv; /* $~ */
484 char * xio_bottom_name;/* $^B */
485 GV * xio_bottom_gv; /* $^B */
486 short xio_subprocess; /* -| or |- */
490 #define xio_dirp xio_dirpu.xiou_dirp
491 #define xio_any xio_dirpu.xiou_any
493 #define IOf_ARGV 1 /* this fp iterates over ARGV */
494 #define IOf_START 2 /* check for null ARGV and substitute '-' */
495 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
496 #define IOf_DIDTOP 8 /* just did top of form */
497 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
498 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
499 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
501 /* The following macros define implementation-independent predicates on SVs. */
504 =for apidoc Am|bool|SvNIOK|SV* sv
505 Returns a boolean indicating whether the SV contains a number, integer or
508 =for apidoc Am|bool|SvNIOKp|SV* sv
509 Returns a boolean indicating whether the SV contains a number, integer or
510 double. Checks the B<private> setting. Use C<SvNIOK>.
512 =for apidoc Am|void|SvNIOK_off|SV* sv
513 Unsets the NV/IV status of an SV.
515 =for apidoc Am|bool|SvOK|SV* sv
516 Returns a boolean indicating whether the value is an SV. It also tells
517 whether the value is defined or not.
519 =for apidoc Am|bool|SvIOKp|SV* sv
520 Returns a boolean indicating whether the SV contains an integer. Checks
521 the B<private> setting. Use C<SvIOK>.
523 =for apidoc Am|bool|SvNOKp|SV* sv
524 Returns a boolean indicating whether the SV contains a double. Checks the
525 B<private> setting. Use C<SvNOK>.
527 =for apidoc Am|bool|SvPOKp|SV* sv
528 Returns a boolean indicating whether the SV contains a character string.
529 Checks the B<private> setting. Use C<SvPOK>.
531 =for apidoc Am|bool|SvIOK|SV* sv
532 Returns a boolean indicating whether the SV contains an integer.
534 =for apidoc Am|void|SvIOK_on|SV* sv
535 Tells an SV that it is an integer.
537 =for apidoc Am|void|SvIOK_off|SV* sv
538 Unsets the IV status of an SV.
540 =for apidoc Am|void|SvIOK_only|SV* sv
541 Tells an SV that it is an integer and disables all other OK bits.
543 =for apidoc Am|void|SvIOK_only_UV|SV* sv
544 Tells and SV that it is an unsigned integer and disables all other OK bits.
546 =for apidoc Am|bool|SvIOK_UV|SV* sv
547 Returns a boolean indicating whether the SV contains an unsigned integer.
549 =for apidoc Am|void|SvUOK|SV* sv
550 Returns a boolean indicating whether the SV contains an unsigned integer.
552 =for apidoc Am|bool|SvIOK_notUV|SV* sv
553 Returns a boolean indicating whether the SV contains a signed integer.
555 =for apidoc Am|bool|SvNOK|SV* sv
556 Returns a boolean indicating whether the SV contains a double.
558 =for apidoc Am|void|SvNOK_on|SV* sv
559 Tells an SV that it is a double.
561 =for apidoc Am|void|SvNOK_off|SV* sv
562 Unsets the NV status of an SV.
564 =for apidoc Am|void|SvNOK_only|SV* sv
565 Tells an SV that it is a double and disables all other OK bits.
567 =for apidoc Am|bool|SvPOK|SV* sv
568 Returns a boolean indicating whether the SV contains a character
571 =for apidoc Am|void|SvPOK_on|SV* sv
572 Tells an SV that it is a string.
574 =for apidoc Am|void|SvPOK_off|SV* sv
575 Unsets the PV status of an SV.
577 =for apidoc Am|void|SvPOK_only|SV* sv
578 Tells an SV that it is a string and disables all other OK bits.
579 Will also turn off the UTF-8 status.
581 =for apidoc Am|bool|SvVOK|SV* sv
582 Returns a boolean indicating whether the SV contains a v-string.
584 =for apidoc Am|bool|SvOOK|SV* sv
585 Returns a boolean indicating whether the SvIVX is a valid offset value for
586 the SvPVX. This hack is used internally to speed up removal of characters
587 from the beginning of a SvPV. When SvOOK is true, then the start of the
588 allocated string buffer is really (SvPVX - SvIVX).
590 =for apidoc Am|bool|SvROK|SV* sv
591 Tests if the SV is an RV.
593 =for apidoc Am|void|SvROK_on|SV* sv
594 Tells an SV that it is an RV.
596 =for apidoc Am|void|SvROK_off|SV* sv
597 Unsets the RV status of an SV.
599 =for apidoc Am|SV*|SvRV|SV* sv
600 Dereferences an RV to return the SV.
602 =for apidoc Am|IV|SvIVX|SV* sv
603 Returns the raw value in the SV's IV slot, without checks or conversions.
604 Only use when you are sure SvIOK is true. See also C<SvIV()>.
606 =for apidoc Am|UV|SvUVX|SV* sv
607 Returns the raw value in the SV's UV slot, without checks or conversions.
608 Only use when you are sure SvIOK is true. See also C<SvUV()>.
610 =for apidoc Am|NV|SvNVX|SV* sv
611 Returns the raw value in the SV's NV slot, without checks or conversions.
612 Only use when you are sure SvNOK is true. See also C<SvNV()>.
614 =for apidoc Am|char*|SvPVX|SV* sv
615 Returns a pointer to the physical string in the SV. The SV must contain a
618 =for apidoc Am|STRLEN|SvCUR|SV* sv
619 Returns the length of the string which is in the SV. See C<SvLEN>.
621 =for apidoc Am|STRLEN|SvLEN|SV* sv
622 Returns the size of the string buffer in the SV, not including any part
623 attributable to C<SvOOK>. See C<SvCUR>.
625 =for apidoc Am|char*|SvEND|SV* sv
626 Returns a pointer to the last character in the string which is in the SV.
627 See C<SvCUR>. Access the character as *(SvEND(sv)).
629 =for apidoc Am|HV*|SvSTASH|SV* sv
630 Returns the stash of the SV.
632 =for apidoc Am|void|SvIV_set|SV* sv|IV val
633 Set the value of the IV pointer in sv to val. It is possible to perform
634 the same function of this macro with an lvalue assignment to C<SvIVX>.
635 With future Perls, however, it will be more efficient to use
636 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
638 =for apidoc Am|void|SvNV_set|SV* sv|NV val
639 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
641 =for apidoc Am|void|SvPV_set|SV* sv|char* val
642 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
644 =for apidoc Am|void|SvUV_set|SV* sv|UV val
645 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
647 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
648 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
650 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
651 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
653 =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
654 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
656 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
657 Set the current length of the string which is in the SV. See C<SvCUR>
660 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
661 Set the actual length of the string which is in the SV. See C<SvIV_set>.
666 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
667 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
668 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
669 SVp_IOK|SVp_NOK|SVf_IVisUV))
671 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
672 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
674 #define assert_not_ROK(sv)
677 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
678 #define SvOK_off(sv) (assert_not_ROK(sv) \
679 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
680 SVf_IVisUV|SVf_UTF8), \
682 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
683 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
687 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
688 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
689 #define SvIOKp_on(sv) (SvRELEASE_IVX(sv), \
690 SvFLAGS(sv) |= SVp_IOK)
691 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
692 #define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
693 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
694 #define SvPOKp_on(sv) (assert_not_ROK(sv) \
695 SvFLAGS(sv) |= SVp_POK)
697 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
698 #define SvIOK_on(sv) (SvRELEASE_IVX(sv), \
699 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
700 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
701 #define SvIOK_only(sv) (SvOK_off(sv), \
702 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
703 #define SvIOK_only_UV(sv) (SvOK_off_exc_UV(sv), \
704 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
706 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
707 == (SVf_IOK|SVf_IVisUV))
708 #define SvUOK(sv) SvIOK_UV(sv)
709 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
712 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
713 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
714 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
716 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
717 #define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
718 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
719 #define SvNOK_only(sv) (SvOK_off(sv), \
720 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
723 =for apidoc Am|bool|SvUTF8|SV* sv
724 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
726 =for apidoc Am|void|SvUTF8_on|SV *sv
727 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
728 Do not use frivolously.
730 =for apidoc Am|void|SvUTF8_off|SV *sv
731 Unsets the UTF-8 status of an SV.
733 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
734 Tells an SV that it is a string and disables all other OK bits,
735 and leaves the UTF-8 status as it was.
740 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
742 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
743 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
744 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
746 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
747 #define SvPOK_on(sv) (assert_not_ROK(sv) \
748 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
749 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
750 #define SvPOK_only(sv) (assert_not_ROK(sv) \
751 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
752 SVf_IVisUV|SVf_UTF8), \
753 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
754 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) \
755 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
757 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
759 #define SvVOK(sv) (SvMAGICAL(sv) \
760 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
761 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
762 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
763 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
765 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
766 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
767 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
769 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
770 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
771 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
773 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
774 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
775 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
777 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
778 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
779 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
781 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
782 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
783 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
785 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
786 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
787 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
789 #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
790 #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
791 #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
793 #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
796 #define Gv_AMG(stash) \
797 (HV_AMAGICmb(stash) && \
798 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
800 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
802 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
803 == (SVf_ROK|SVprv_WEAKREF))
804 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
805 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
807 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
809 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
810 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
811 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
813 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
814 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
815 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
817 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
818 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
820 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
821 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
822 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
824 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
825 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
826 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
828 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
829 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
830 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
832 #define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
833 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
834 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
836 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
837 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
838 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
840 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
841 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
842 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
844 #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
845 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
846 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
848 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
849 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
850 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
853 /* The following uses the FAKE flag to show that a regex pointer is infact
854 its own offset in the regexpad for ithreads */
855 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
856 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
857 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
860 #ifdef PERL_DEBUG_COW
861 #define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
863 #define SvRV(sv) ((sv)->sv_u.svu_rv)
865 #define SvRVx(sv) SvRV(sv)
867 #ifdef PERL_DEBUG_COW
868 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
869 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
870 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
871 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
872 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_nv)
873 /* Don't test the core XS code yet. */
874 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
875 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
877 # define SvPVX(sv) SvPVX_mutable(sv)
879 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
880 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
881 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
885 /* Can't make this RVALUE because of Perl_sv_unmagic. */
886 # define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
888 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
890 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
893 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
895 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_magic)
897 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
900 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
901 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
902 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_nv
903 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
904 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
905 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
906 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
909 # define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
910 # define SvSTASH(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
912 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
913 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
918 /* Given that these two are new, there can't be any existing code using them
920 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
921 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
923 /* Except for the poison code, which uses & to scribble over the pointer after
925 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
926 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
929 #define SvIVXx(sv) SvIVX(sv)
930 #define SvUVXx(sv) SvUVX(sv)
931 #define SvNVXx(sv) SvNVX(sv)
932 #define SvPVXx(sv) SvPVX(sv)
933 #define SvLENx(sv) SvLEN(sv)
934 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
937 /* Ask a scalar nicely to try to become an IV, if possible.
938 Not guaranteed to stay returning void */
939 /* Macro won't actually call sv_2iv if already IOK */
940 #define SvIV_please(sv) \
941 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
942 (void) SvIV(sv); } STMT_END
943 #define SvIV_set(sv, val) \
944 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
945 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
946 #define SvNV_set(sv, val) \
947 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
948 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
949 (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END
950 #define SvPV_set(sv, val) \
951 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
952 ((sv)->sv_u.svu_pv = (val)); } STMT_END
953 #define SvUV_set(sv, val) \
954 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
955 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
956 #define SvRV_set(sv, val) \
957 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
958 ((sv)->sv_u.svu_rv = (val)); } STMT_END
959 #define SvMAGIC_set(sv, val) \
960 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
961 (((XPVMG*)SvANY(sv))->xmg_magic = (val)); } STMT_END
962 #define SvSTASH_set(sv, val) \
963 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
964 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
965 #define SvCUR_set(sv, val) \
966 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
967 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
968 #define SvLEN_set(sv, val) \
969 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
970 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
971 #define SvEND_set(sv, val) \
972 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
973 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
975 #define SvPV_renew(sv,n) \
976 STMT_START { SvLEN_set(sv, n); \
977 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
978 (char*)saferealloc((Malloc_t)SvPVX(sv), \
979 (MEM_SIZE)((n))))); \
982 #define SvPV_shrink_to_cur(sv) STMT_START { \
983 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
984 SvPV_renew(sv, _lEnGtH); \
987 #define SvPV_free(sv) \
989 assert(SvTYPE(sv) >= SVt_PV); \
992 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \
993 SvFLAGS(sv) &= ~SVf_OOK; \
995 Safefree(SvPVX(sv)); \
999 #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
1000 #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
1001 #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
1003 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1005 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1006 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1007 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1008 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1010 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1011 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1012 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1013 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1014 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1015 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1016 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1017 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1018 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1019 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1020 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1021 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1022 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1023 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1024 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
1025 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1026 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1028 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1029 #define IoTYPE_RDONLY '<'
1030 #define IoTYPE_WRONLY '>'
1031 #define IoTYPE_RDWR '+'
1032 #define IoTYPE_APPEND 'a'
1033 #define IoTYPE_PIPE '|'
1034 #define IoTYPE_STD '-' /* stdin or stdout */
1035 #define IoTYPE_SOCKET 's'
1036 #define IoTYPE_CLOSED ' '
1037 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1038 #define IoTYPE_NUMERIC '#' /* fdopen */
1041 =for apidoc Am|bool|SvTAINTED|SV* sv
1042 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1045 =for apidoc Am|void|SvTAINTED_on|SV* sv
1046 Marks an SV as tainted if tainting is enabled.
1048 =for apidoc Am|void|SvTAINTED_off|SV* sv
1049 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1050 some of Perl's fundamental security features. XS module authors should not
1051 use this function unless they fully understand all the implications of
1052 unconditionally untainting the value. Untainting should be done in the
1053 standard perl fashion, via a carefully crafted regexp, rather than directly
1054 untainting variables.
1056 =for apidoc Am|void|SvTAINT|SV* sv
1057 Taints an SV if tainting is enabled.
1062 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1064 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1065 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1066 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1068 #define SvTAINT(sv) \
1070 if (PL_tainting) { \
1077 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1078 Like C<SvPV> but will force the SV into containing just a string
1079 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1082 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1083 Like C<SvPV> but will force the SV into containing just a string
1084 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1085 directly. Doesn't process magic.
1087 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1088 Returns a pointer to the string in the SV, or a stringified form of
1089 the SV if the SV does not contain a string. The SV may cache the
1090 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1091 C<SvPVx> for a version which guarantees to evaluate sv only once.
1093 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1094 A version of C<SvPV> which guarantees to evaluate sv only once.
1096 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1097 Like C<SvPV> but doesn't process magic.
1099 =for apidoc Am|char*|SvPV_nolen|SV* sv
1100 Returns a pointer to the string in the SV, or a stringified form of
1101 the SV if the SV does not contain a string. The SV may cache the
1102 stringified form becoming C<SvPOK>. Handles 'get' magic.
1104 =for apidoc Am|IV|SvIV|SV* sv
1105 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1106 version which guarantees to evaluate sv only once.
1108 =for apidoc Am|IV|SvIV_nomg|SV* sv
1109 Like C<SvIV> but doesn't process magic.
1111 =for apidoc Am|IV|SvIVx|SV* sv
1112 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1113 sv only once. Use the more efficient C<SvIV> otherwise.
1115 =for apidoc Am|NV|SvNV|SV* sv
1116 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1117 which guarantees to evaluate sv only once.
1119 =for apidoc Am|NV|SvNVx|SV* sv
1120 Coerces the given SV to a double and returns it. Guarantees to evaluate
1121 sv only once. Use the more efficient C<SvNV> otherwise.
1123 =for apidoc Am|UV|SvUV|SV* sv
1124 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1125 for a version which guarantees to evaluate sv only once.
1127 =for apidoc Am|UV|SvUV_nomg|SV* sv
1128 Like C<SvUV> but doesn't process magic.
1130 =for apidoc Am|UV|SvUVx|SV* sv
1131 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1132 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1134 =for apidoc Am|bool|SvTRUE|SV* sv
1135 Returns a boolean indicating whether Perl would evaluate the SV as true or
1136 false, defined or undefined. Does not handle 'get' magic.
1138 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1139 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1141 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1142 Like C<SvPV>, but converts sv to utf8 first if necessary.
1144 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1145 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1147 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1148 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1150 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1151 Like C<SvPV>, but converts sv to byte representation first if necessary.
1153 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1154 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1156 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1157 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1158 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1161 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1162 Like C<SvPV>, but converts sv to utf8 first if necessary.
1163 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1166 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1167 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1168 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1171 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1172 Like C<SvPV>, but converts sv to byte representation first if necessary.
1173 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1176 =for apidoc Am|bool|SvIsCOW|SV* sv
1177 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1178 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1181 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1182 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1185 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1186 Like C<sv_catpvn> but doesn't process magic.
1188 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1189 Like C<sv_setsv> but doesn't process magic.
1191 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1192 Like C<sv_catsv> but doesn't process magic.
1197 /* Let us hope that bitmaps for UV and IV are the same */
1198 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1199 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1200 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1202 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1203 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1207 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1208 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1209 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1211 #define SvPV_flags(sv, lp, flags) \
1212 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1213 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1214 #define SvPV_flags_const(sv, lp, flags) \
1215 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1216 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1217 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1218 #define SvPV_flags_const_nolen(sv, flags) \
1219 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1220 ? SvPVX_const(sv) : \
1221 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1222 #define SvPV_flags_mutable(sv, lp, flags) \
1223 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1224 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1225 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1227 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1228 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1229 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1231 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1232 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1234 #define SvPV_force_flags(sv, lp, flags) \
1235 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1236 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1237 #define SvPV_force_flags_nolen(sv, flags) \
1238 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1239 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1240 #define SvPV_force_flags_mutable(sv, lp, flags) \
1241 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1242 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1243 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1245 #define SvPV_nolen(sv) \
1246 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1247 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1249 #define SvPV_nolen_const(sv) \
1250 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1251 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1253 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1254 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1255 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1259 #define SvPVutf8(sv, lp) \
1260 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1261 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1263 #define SvPVutf8_force(sv, lp) \
1264 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1265 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1268 #define SvPVutf8_nolen(sv) \
1269 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1270 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1274 #define SvPVbyte(sv, lp) \
1275 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1276 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1278 #define SvPVbyte_force(sv, lp) \
1279 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1280 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1282 #define SvPVbyte_nolen(sv) \
1283 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1284 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1288 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1289 * var to evaluate the arg once; failing that, use a global if possible;
1290 * failing that, call a function to do the work
1293 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1294 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1295 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1297 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1299 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1300 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1301 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1302 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1303 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1304 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1305 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1306 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1307 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1308 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1309 # define SvTRUE(sv) ( \
1313 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1315 (nxpv->xpv_cur > 1 || \
1316 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1323 ? SvNVX(sv) != 0.0 \
1325 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1327 #else /* __GNUC__ */
1329 /* These inlined macros use globals, which will require a thread
1330 * declaration in user code, so we avoid them under threads */
1332 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1333 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1334 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1335 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1336 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1337 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1338 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1339 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1340 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1341 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1342 # define SvTRUE(sv) ( \
1346 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1347 (PL_Xpv->xpv_cur > 1 || \
1348 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1355 ? SvNVX(sv) != 0.0 \
1357 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1358 #endif /* __GNU__ */
1360 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1361 (SVf_FAKE | SVf_READONLY))
1362 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1364 #define SvSHARED_HEK_FROM_PV(pvx) \
1365 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1366 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1368 /* flag values for sv_*_flags functions */
1369 #define SV_IMMEDIATE_UNREF 1
1371 #define SV_COW_DROP_PV 4
1372 #define SV_UTF8_NO_ENCODING 8
1373 #define SV_NOSTEAL 16
1374 #define SV_CONST_RETURN 32
1375 #define SV_MUTABLE_RETURN 64
1376 #define SV_SMAGIC 128
1378 #define sv_unref(sv) sv_unref_flags(sv, 0)
1379 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1381 /* We are about to replace the SV's current value. So if it's copy on write
1382 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1383 the value is about to get thrown away, so drop the PV rather than go to
1384 the effort of making a read-write copy only for it to get immediately
1387 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1388 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1390 #ifdef PERL_OLD_COPY_ON_WRITE
1391 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1392 && Perl_sv_release_IVX(aTHX_ sv)))
1393 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1395 # define SvRELEASE_IVX(sv) SvOOK_off(sv)
1396 #endif /* PERL_OLD_COPY_ON_WRITE */
1398 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1399 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1400 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1401 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1403 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1404 sv_force_normal_flags(sv, 0)
1407 /* all these 'functions' are now just macros */
1409 #define sv_pv(sv) SvPV_nolen(sv)
1410 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1411 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1413 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1414 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1415 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1416 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1417 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1418 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1419 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1420 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1421 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1422 #define sv_catpvn_mg(sv, sstr, slen) \
1423 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1424 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1425 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1426 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1427 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1428 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1429 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1430 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1431 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1432 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1434 /* Should be named SvCatPVN_utf8_upgrade? */
1435 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1438 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1440 sv_setpvn(nsv, sstr, slen); \
1442 sv_utf8_upgrade(nsv); \
1443 sv_catsv(dsv, nsv); \
1447 =for apidoc Am|SV*|newRV_inc|SV* sv
1449 Creates an RV wrapper for an SV. The reference count for the original SV is
1455 #define newRV_inc(sv) newRV(sv)
1457 /* the following macros update any magic values this sv is associated with */
1460 =head1 Magical Functions
1462 =for apidoc Am|void|SvGETMAGIC|SV* sv
1463 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1464 argument more than once.
1466 =for apidoc Am|void|SvSETMAGIC|SV* sv
1467 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1468 argument more than once.
1470 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1471 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1474 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1475 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1476 ssv. May evaluate arguments more than once.
1478 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1479 Like C<SvSetSV>, but does any set magic required afterwards.
1481 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1482 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1484 =for apidoc Am|void|SvSHARE|SV* sv
1485 Arranges for sv to be shared between threads if a suitable module
1488 =for apidoc Am|void|SvLOCK|SV* sv
1489 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1492 =for apidoc Am|void|SvUNLOCK|SV* sv
1493 Releases a mutual exclusion lock on sv if a suitable module
1496 =head1 SV Manipulation Functions
1498 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1499 Expands the character buffer in the SV so that it has room for the
1500 indicated number of bytes (remember to reserve space for an extra trailing
1501 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1502 Returns a pointer to the character buffer.
1507 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1508 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1509 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1511 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1512 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1514 #define SvSetSV_and(dst,src,finally) \
1516 if ((dst) != (src)) { \
1517 sv_setsv(dst, src); \
1521 #define SvSetSV_nosteal_and(dst,src,finally) \
1523 if ((dst) != (src)) { \
1524 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL); \
1529 #define SvSetSV(dst,src) \
1530 SvSetSV_and(dst,src,/*nothing*/;)
1531 #define SvSetSV_nosteal(dst,src) \
1532 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1534 #define SvSetMagicSV(dst,src) \
1535 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1536 #define SvSetMagicSV_nosteal(dst,src) \
1537 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1540 #if !defined(SKIP_DEBUGGING)
1541 #define SvPEEK(sv) sv_peek(sv)
1543 #define SvPEEK(sv) ""
1546 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1548 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1550 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1552 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1553 #define SvGROW_mutable(sv,len) \
1554 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1555 #define Sv_Grow sv_grow
1557 #define CLONEf_COPY_STACKS 1
1558 #define CLONEf_KEEP_PTR_TABLE 2
1559 #define CLONEf_CLONE_HOST 4
1560 #define CLONEf_JOIN_IN 8
1562 struct clone_params {
1565 PerlInterpreter *proto_perl;
1570 * c-indentation-style: bsd
1572 * indent-tabs-mode: t
1575 * ex: set ts=8 sts=4 sw=4 noet: