3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 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>.
51 /* RV was here, before it was merged with IV. */
57 /* PVBM was here, before BIND replaced it. */
65 SVt_LAST /* keep last in enum. used to size arrays */
69 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
70 purposes eternal code wanting to consider PVBM probably needs to think of
72 # define SVt_PVBM SVt_PVMG
73 /* Anything wanting to create a reference from clean should ensure that it has
74 a scalar of type SVt_IV now: */
75 # define SVt_RV SVt_IV
78 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
79 and SVt_IV, so never reaches the clause at the end that uses
80 sv_type_details->body_size to determine whether to call safefree(). Hence
81 body_size can be set no-zero to record the size of PTEs and HEs, without
82 fear of bogus frees. */
84 #define PTE_SVSLOT SVt_IV
86 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
87 #define HE_SVSLOT SVt_NULL
90 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
92 /* typedefs to eliminate some typing */
94 typedef struct hek HEK;
96 /* Using C's structural equivalence to help emulate C++ inheritance here... */
98 /* start with 2 sv-head building blocks */
99 #define _SV_HEAD(ptrtype) \
100 ptrtype sv_any; /* pointer to body */ \
101 U32 sv_refcnt; /* how many references to us */ \
102 U32 sv_flags /* what we are */
104 #define _SV_HEAD_UNION \
108 SV* svu_rv; /* pointer to another SV */ \
109 char* svu_pv; /* pointer to malloced string */ \
116 struct STRUCT_SV { /* struct sv { */
119 #ifdef DEBUG_LEAKING_SCALARS
120 unsigned sv_debug_optype:9; /* the type of OP that allocated us */
121 unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */
122 unsigned sv_debug_cloned:1; /* was cloned for an ithread */
123 unsigned sv_debug_line:16; /* the line where we were allocated */
124 char * sv_debug_file; /* the file where we were allocated */
129 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
134 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
139 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
144 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
149 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
154 #undef _SV_HEAD_UNION /* ensure no pollution */
157 =head1 SV Manipulation Functions
159 =for apidoc Am|U32|SvREFCNT|SV* sv
160 Returns the value of the object's reference count.
162 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
163 Increments the reference count of the given SV.
165 All of the following SvREFCNT_inc* macros are optimized versions of
166 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
168 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
169 Same as SvREFCNT_inc, but can only be used if you know I<sv>
170 is not NULL. Since we don't have to check the NULLness, it's faster
173 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
174 Same as SvREFCNT_inc, but can only be used if you don't need the
175 return value. The macro doesn't need to return a meaningful value.
177 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
178 Same as SvREFCNT_inc, but can only be used if you don't need the return
179 value, and you know that I<sv> is not NULL. The macro doesn't need
180 to return a meaningful value, or check for NULLness, so it's smaller
183 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
184 Same as SvREFCNT_inc, but can only be used with expressions without side
185 effects. Since we don't have to store a temporary value, it's faster.
187 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
188 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
189 is not NULL. Since we don't have to check the NULLness, it's faster
192 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
193 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
194 return value. The macro doesn't need to return a meaningful value.
196 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
197 Same as SvREFCNT_inc, but can only be used if you don't need the return
198 value, and you know that I<sv> is not NULL. The macro doesn't need
199 to return a meaningful value, or check for NULLness, so it's smaller
202 =for apidoc Am|void|SvREFCNT_dec|SV* sv
203 Decrements the reference count of the given SV.
205 =for apidoc Am|svtype|SvTYPE|SV* sv
206 Returns the type of the SV. See C<svtype>.
208 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
209 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
210 perform the upgrade if necessary. See C<svtype>.
215 #define SvANY(sv) (sv)->sv_any
216 #define SvFLAGS(sv) (sv)->sv_flags
217 #define SvREFCNT(sv) (sv)->sv_refcnt
219 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
220 # define SvREFCNT_inc(sv) \
222 SV * const _sv = (SV*)(sv); \
227 # define SvREFCNT_inc_simple(sv) \
233 # define SvREFCNT_inc_NN(sv) \
235 SV * const _sv = (SV*)(sv); \
239 # define SvREFCNT_inc_void(sv) \
241 SV * const _sv = (SV*)(sv); \
243 (void)(SvREFCNT(_sv)++); \
246 # define SvREFCNT_inc(sv) \
247 ((PL_Sv=(SV*)(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
248 # define SvREFCNT_inc_simple(sv) \
249 ((sv) ? (SvREFCNT(sv)++,(SV*)(sv)) : NULL)
250 # define SvREFCNT_inc_NN(sv) \
251 (PL_Sv=(SV*)(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
252 # define SvREFCNT_inc_void(sv) \
253 (void)((PL_Sv=(SV*)(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
256 /* These guys don't need the curly blocks */
257 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
258 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),(SV*)(sv))
259 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
260 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
262 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
263 # define SvREFCNT_dec(sv) \
265 SV * const _sv = (SV*)(sv); \
267 if (SvREFCNT(_sv)) { \
268 if (--(SvREFCNT(_sv)) == 0) \
269 Perl_sv_free2(aTHX_ _sv); \
276 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
279 #define SVTYPEMASK 0xff
280 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
282 /* Sadly there are some parts of the core that have pointers to already-freed
283 SV heads, and rely on being able to tell that they are now free. So mark
284 them all by using a consistent macro. */
285 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
287 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
289 #define SVf_IOK 0x00000100 /* has valid public integer value */
290 #define SVf_NOK 0x00000200 /* has valid public numeric value */
291 #define SVf_POK 0x00000400 /* has valid public pointer value */
292 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
294 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
295 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
296 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
297 #define SVp_SCREAM 0x00008000 /* has been studied? */
298 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
299 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
300 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
301 subroutine in another package. Set the
302 CvIMPORTED_CV_ON() if it needs to be
303 expanded to a real GV */
305 #define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
306 #define SVpad_STATE 0x00010000 /* pad name is a "state" var */
307 #define SVs_PADTMP 0x00020000 /* in use as tmp */
308 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
309 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
310 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
311 #define SVs_TEMP 0x00080000 /* string is stealable? */
312 #define SVs_OBJECT 0x00100000 /* is "blessed" */
313 #define SVs_GMG 0x00200000 /* has magical get method */
314 #define SVs_SMG 0x00400000 /* has magical set method */
315 #define SVs_RMG 0x00800000 /* has random magical methods */
317 #define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
318 1: SV head arena wasn't malloc()ed
319 2: in conjunction with SVf_READONLY
320 marks a shared hash key scalar
321 (SvLEN == 0) or a copy on write
322 string (SvLEN != 0) [SvIsCOW(sv)]
323 3: For PVCV, whether CvUNIQUE(cv)
324 refers to an eval or once only
325 [CvEVAL(cv), CvSPECIAL(cv)]
326 4: Whether the regexp pointer is in
327 fact an offset [SvREPADTMP(sv)]
328 5: On a pad name SV, that slot in the
329 frame AV is a REFCNT'ed reference
330 to a lexical from "outside". */
331 #define SVphv_REHASH SVf_FAKE /* 6: On a PVHV, hash values are being
333 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
334 means that a hv_aux struct is present
335 after the main array */
336 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
337 SV's in final arena cleanup */
338 #define SVf_READONLY 0x08000000 /* may not be modified */
343 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
345 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
346 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
348 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
350 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
352 /* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
353 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
354 This is also set on RVs whose overloaded
355 stringification is UTF-8. This might
356 only happen as a side effect of SvPV() */
359 /* Some private flags. */
361 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
362 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
363 been restructured, so sometimes get used as string buffers. */
366 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
367 /* PVNV, PVMG, presumably only inside pads */
368 #define SVpad_NAME 0x40000000 /* This SV is a name in the PAD, so
369 SVpad_TYPED, SVpad_OUR and SVpad_STATE
372 #define SVpav_REAL 0x40000000 /* free old entries */
374 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
375 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
376 on any regular scalar (anything <= PVLV) */
377 #define SVpbm_VALID 0x40000000
379 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
381 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
382 /* Presumably IVs aren't stored in pads */
383 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
385 #define SVpav_REIFY 0x80000000 /* can become real */
387 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
389 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
390 /* PVGV when SVpbm_VALID is true */
391 #define SVpbm_TAIL 0x80000000
392 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
393 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
395 #define _XPV_ALLOCATED_HEAD \
396 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
397 STRLEN xpv_len /* allocated size */
404 NV xnv_nv; /* numeric value, if any */
409 } xpad_cop_seq; /* used by pad.c for cop_sequence */
411 U32 xbm_previous; /* how many characters in string before rare? */
413 U8 xbm_rare; /* rarest character in string */
414 } xbm_s; /* fields from PVBM */
418 IV xivu_iv; /* integer value */
419 /* xpvfm: pv offset */
423 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
424 HV * xivu_hv; /* regexp: paren_names */
428 MAGIC* xmg_magic; /* linked list of magicalness */
429 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
450 #define xiv_iv xiv_u.xivu_iv
457 #define xuv_uv xuv_u.xivu_uv
464 #define _XPVMG_HEAD \
467 HV* xmg_stash /* class package */
469 /* These structure must match the beginning of struct xpvhv in hv.h. */
482 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
483 * y=alem/helem/iter t=tie T=tied HE */
486 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
493 /* This structure must match XPVCV in cv.h */
495 typedef U16 cv_flags_t;
497 #define _XPVCV_COMMON \
505 void (*xcv_xsub) (pTHX_ CV*); \
511 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
512 * compilation) in the lexically enclosing \
534 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
535 PerlIO * xio_ofp; /* but sockets need separate streams */
536 /* Cray addresses everything by word boundaries (64 bits) and
537 * code and data pointers cannot be mixed (which is exactly what
538 * Perl_filter_add() tries to do with the dirp), hence the following
539 * union trick (as suggested by Gurusamy Sarathy).
540 * For further information see Geir Johansen's problem report titled
541 [ID 20000612.002] Perl problem on Cray system
542 * The any pointer (known as IoANY()) will also be a good place
543 * to hang any IO disciplines to.
546 DIR * xiou_dirp; /* for opendir, readdir, etc */
547 void * xiou_any; /* for alignment */
549 IV xio_lines; /* $. */
550 IV xio_page; /* $% */
551 IV xio_page_len; /* $= */
552 IV xio_lines_left; /* $- */
553 char * xio_top_name; /* $^ */
554 GV * xio_top_gv; /* $^ */
555 char * xio_fmt_name; /* $~ */
556 GV * xio_fmt_gv; /* $~ */
557 char * xio_bottom_name;/* $^B */
558 GV * xio_bottom_gv; /* $^B */
562 #define xio_dirp xio_dirpu.xiou_dirp
563 #define xio_any xio_dirpu.xiou_any
565 #define IOf_ARGV 1 /* this fp iterates over ARGV */
566 #define IOf_START 2 /* check for null ARGV and substitute '-' */
567 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
568 #define IOf_DIDTOP 8 /* just did top of form */
569 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
570 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
571 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
573 /* The following macros define implementation-independent predicates on SVs. */
576 =for apidoc Am|U32|SvNIOK|SV* sv
577 Returns a U32 value indicating whether the SV contains a number, integer or
580 =for apidoc Am|U32|SvNIOKp|SV* sv
581 Returns a U32 value indicating whether the SV contains a number, integer or
582 double. Checks the B<private> setting. Use C<SvNIOK>.
584 =for apidoc Am|void|SvNIOK_off|SV* sv
585 Unsets the NV/IV status of an SV.
587 =for apidoc Am|U32|SvOK|SV* sv
588 Returns a U32 value indicating whether the value is an SV. It also tells
589 whether the value is defined or not.
591 =for apidoc Am|U32|SvIOKp|SV* sv
592 Returns a U32 value indicating whether the SV contains an integer. Checks
593 the B<private> setting. Use C<SvIOK>.
595 =for apidoc Am|U32|SvNOKp|SV* sv
596 Returns a U32 value indicating whether the SV contains a double. Checks the
597 B<private> setting. Use C<SvNOK>.
599 =for apidoc Am|U32|SvPOKp|SV* sv
600 Returns a U32 value indicating whether the SV contains a character string.
601 Checks the B<private> setting. Use C<SvPOK>.
603 =for apidoc Am|U32|SvIOK|SV* sv
604 Returns a U32 value indicating whether the SV contains an integer.
606 =for apidoc Am|void|SvIOK_on|SV* sv
607 Tells an SV that it is an integer.
609 =for apidoc Am|void|SvIOK_off|SV* sv
610 Unsets the IV status of an SV.
612 =for apidoc Am|void|SvIOK_only|SV* sv
613 Tells an SV that it is an integer and disables all other OK bits.
615 =for apidoc Am|void|SvIOK_only_UV|SV* sv
616 Tells and SV that it is an unsigned integer and disables all other OK bits.
618 =for apidoc Am|bool|SvIOK_UV|SV* sv
619 Returns a boolean indicating whether the SV contains an unsigned integer.
621 =for apidoc Am|bool|SvUOK|SV* sv
622 Returns a boolean indicating whether the SV contains an unsigned integer.
624 =for apidoc Am|bool|SvIOK_notUV|SV* sv
625 Returns a boolean indicating whether the SV contains a signed integer.
627 =for apidoc Am|U32|SvNOK|SV* sv
628 Returns a U32 value indicating whether the SV contains a double.
630 =for apidoc Am|void|SvNOK_on|SV* sv
631 Tells an SV that it is a double.
633 =for apidoc Am|void|SvNOK_off|SV* sv
634 Unsets the NV status of an SV.
636 =for apidoc Am|void|SvNOK_only|SV* sv
637 Tells an SV that it is a double and disables all other OK bits.
639 =for apidoc Am|U32|SvPOK|SV* sv
640 Returns a U32 value indicating whether the SV contains a character
643 =for apidoc Am|void|SvPOK_on|SV* sv
644 Tells an SV that it is a string.
646 =for apidoc Am|void|SvPOK_off|SV* sv
647 Unsets the PV status of an SV.
649 =for apidoc Am|void|SvPOK_only|SV* sv
650 Tells an SV that it is a string and disables all other OK bits.
651 Will also turn off the UTF-8 status.
653 =for apidoc Am|bool|SvVOK|SV* sv
654 Returns a boolean indicating whether the SV contains a v-string.
656 =for apidoc Am|U32|SvOOK|SV* sv
657 Returns a U32 indicating whether the pointer to the string buffer is offset.
658 This hack is used internally to speed up removal of characters from the
659 beginning of a SvPV. When SvOOK is true, then the start of the
660 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
661 This offset used to be stored in SvIVX, but is now stored within the spare
664 =for apidoc Am|U32|SvROK|SV* sv
665 Tests if the SV is an RV.
667 =for apidoc Am|void|SvROK_on|SV* sv
668 Tells an SV that it is an RV.
670 =for apidoc Am|void|SvROK_off|SV* sv
671 Unsets the RV status of an SV.
673 =for apidoc Am|SV*|SvRV|SV* sv
674 Dereferences an RV to return the SV.
676 =for apidoc Am|IV|SvIVX|SV* sv
677 Returns the raw value in the SV's IV slot, without checks or conversions.
678 Only use when you are sure SvIOK is true. See also C<SvIV()>.
680 =for apidoc Am|UV|SvUVX|SV* sv
681 Returns the raw value in the SV's UV slot, without checks or conversions.
682 Only use when you are sure SvIOK is true. See also C<SvUV()>.
684 =for apidoc Am|NV|SvNVX|SV* sv
685 Returns the raw value in the SV's NV slot, without checks or conversions.
686 Only use when you are sure SvNOK is true. See also C<SvNV()>.
688 =for apidoc Am|char*|SvPVX|SV* sv
689 Returns a pointer to the physical string in the SV. The SV must contain a
692 =for apidoc Am|STRLEN|SvCUR|SV* sv
693 Returns the length of the string which is in the SV. See C<SvLEN>.
695 =for apidoc Am|STRLEN|SvLEN|SV* sv
696 Returns the size of the string buffer in the SV, not including any part
697 attributable to C<SvOOK>. See C<SvCUR>.
699 =for apidoc Am|char*|SvEND|SV* sv
700 Returns a pointer to the last character in the string which is in the SV.
701 See C<SvCUR>. Access the character as *(SvEND(sv)).
703 =for apidoc Am|HV*|SvSTASH|SV* sv
704 Returns the stash of the SV.
706 =for apidoc Am|void|SvIV_set|SV* sv|IV val
707 Set the value of the IV pointer in sv to val. It is possible to perform
708 the same function of this macro with an lvalue assignment to C<SvIVX>.
709 With future Perls, however, it will be more efficient to use
710 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
712 =for apidoc Am|void|SvNV_set|SV* sv|NV val
713 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
715 =for apidoc Am|void|SvPV_set|SV* sv|char* val
716 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
718 =for apidoc Am|void|SvUV_set|SV* sv|UV val
719 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
721 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
722 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
724 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
725 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
727 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
728 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
730 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
731 Set the current length of the string which is in the SV. See C<SvCUR>
734 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
735 Set the actual length of the string which is in the SV. See C<SvIV_set>.
740 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
741 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
742 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
743 SVp_IOK|SVp_NOK|SVf_IVisUV))
745 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
746 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
747 #define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
749 #define assert_not_ROK(sv)
750 #define assert_not_glob(sv)
753 #define SvOK(sv) ((SvTYPE(sv) == SVt_BIND) \
754 ? (SvFLAGS(SvRV(sv)) & SVf_OK) \
755 : (SvFLAGS(sv) & SVf_OK))
756 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
757 SvFLAGS(sv) &= ~(SVf_OK| \
758 SVf_IVisUV|SVf_UTF8), \
760 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
761 SvFLAGS(sv) &= ~(SVf_OK| \
765 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
766 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
767 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
768 SvFLAGS(sv) |= SVp_IOK)
769 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
770 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
771 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
772 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
773 SvFLAGS(sv) |= SVp_POK)
775 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
776 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
777 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
778 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
779 #define SvIOK_only(sv) (SvOK_off(sv), \
780 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
781 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
782 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
784 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
785 == (SVf_IOK|SVf_IVisUV))
786 #define SvUOK(sv) SvIOK_UV(sv)
787 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
790 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
791 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
792 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
794 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
795 #define SvNOK_on(sv) (assert_not_glob(sv) \
796 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
797 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
798 #define SvNOK_only(sv) (SvOK_off(sv), \
799 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
802 =for apidoc Am|U32|SvUTF8|SV* sv
803 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
804 Call this after SvPV() in case any call to string overloading updates the
807 =for apidoc Am|void|SvUTF8_on|SV *sv
808 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
809 Do not use frivolously.
811 =for apidoc Am|void|SvUTF8_off|SV *sv
812 Unsets the UTF-8 status of an SV.
814 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
815 Tells an SV that it is a string and disables all other OK bits,
816 and leaves the UTF-8 status as it was.
821 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
823 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
824 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
825 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
827 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
828 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
829 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
830 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
831 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
832 SvFLAGS(sv) &= ~(SVf_OK| \
833 SVf_IVisUV|SVf_UTF8), \
834 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
835 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
836 SvFLAGS(sv) &= ~(SVf_OK| \
838 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
840 #define SvVOK(sv) (SvMAGICAL(sv) \
841 && mg_find(sv,PERL_MAGIC_vstring))
842 /* returns the vstring magic, if any */
843 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
844 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
846 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
847 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
848 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
850 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
851 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
852 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
854 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
855 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
856 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
858 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
859 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
860 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
862 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
863 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
864 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
866 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
867 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
868 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
870 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
871 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
872 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
874 #define SvAMAGIC(sv) (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
875 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
876 # define SvAMAGIC_on(sv) ({ SV * const kloink = sv; \
877 assert(SvROK(kloink)); \
878 SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
880 # define SvAMAGIC_off(sv) ({ SV * const kloink = sv; \
882 SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
885 # define SvAMAGIC_on(sv) (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
886 # define SvAMAGIC_off(sv) \
887 (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
891 =for apidoc Am|char*|SvGAMAGIC|SV* sv
893 Returns true if the SV has get magic or overloading. If either is true then
894 the scalar is active data, and has the potential to return a new value every
895 time it is accessed. Hence you must be careful to only read it once per user
896 logical operation and work with that returned value. If neither is true then
897 the scalar's value cannot change unless written to.
902 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
904 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
906 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
907 == (SVf_ROK|SVprv_WEAKREF))
908 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
909 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
911 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
912 == (SVf_ROK|SVprv_PCS_IMPORTED))
913 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
914 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
916 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
918 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
919 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
920 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
922 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
923 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
924 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
926 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
927 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
929 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
930 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
931 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
933 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
934 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
935 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
937 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
938 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
939 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
941 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
942 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
943 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
945 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
946 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
947 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
949 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
950 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
951 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
953 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
954 # define SvVALID(sv) ({ SV *const thwacke = (SV *) (sv); \
955 if (SvFLAGS(thwacke) & SVpbm_VALID) \
956 assert(!isGV_with_GP(thwacke)); \
957 (SvFLAGS(thwacke) & SVpbm_VALID); \
959 # define SvVALID_on(sv) ({ SV *const thwacke = (SV *) (sv); \
960 assert(!isGV_with_GP(thwacke)); \
961 (SvFLAGS(thwacke) |= SVpbm_VALID); \
963 # define SvVALID_off(sv) ({ SV *const thwacke = (SV *) (sv); \
964 assert(!isGV_with_GP(thwacke)); \
965 (SvFLAGS(thwacke) &= ~SVpbm_VALID); \
968 # define SvTAIL(sv) ({ SV *const _svi = (SV *) (sv); \
969 assert(SvTYPE(_svi) != SVt_PVAV); \
970 assert(SvTYPE(_svi) != SVt_PVHV); \
971 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
972 == (SVpbm_TAIL|SVpbm_VALID); \
975 # define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
976 # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
977 # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
978 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
979 == (SVpbm_TAIL|SVpbm_VALID))
982 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
983 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
987 /* The following uses the FAKE flag to show that a regex pointer is infact
988 its own offset in the regexpad for ithreads */
989 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
990 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
991 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
994 #define SvPAD_TYPED(sv) \
995 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
997 #define SvPAD_OUR(sv) \
998 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1000 #define SvPAD_STATE(sv) \
1001 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1003 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1004 # define SvPAD_TYPED_on(sv) ({ \
1005 SV *const whap = (SV *) (sv); \
1006 assert(SvTYPE(whap) == SVt_PVMG); \
1007 (SvFLAGS(whap) |= SVpad_NAME|SVpad_TYPED); \
1009 #define SvPAD_OUR_on(sv) ({ \
1010 SV *const whap = (SV *) (sv); \
1011 assert(SvTYPE(whap) == SVt_PVMG); \
1012 (SvFLAGS(whap) |= SVpad_NAME|SVpad_OUR); \
1014 #define SvPAD_STATE_on(sv) ({ \
1015 SV *const whap = (SV *) (sv); \
1016 assert(SvTYPE(whap) == SVt_PVNV || SvTYPE(whap) == SVt_PVMG); \
1017 (SvFLAGS(whap) |= SVpad_NAME|SVpad_STATE); \
1020 # define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1021 # define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1022 # define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1025 #define SvOURSTASH(sv) \
1026 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1027 #define SvOURSTASH_set(sv, st) \
1029 assert(SvTYPE(sv) == SVt_PVMG); \
1030 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1033 #ifdef PERL_DEBUG_COW
1036 #define SvRVx(sv) SvRV(sv)
1038 #ifdef PERL_DEBUG_COW
1039 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1040 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1041 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1042 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1043 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1044 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1045 /* Don't test the core XS code yet. */
1046 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1047 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1049 # define SvPVX(sv) SvPVX_mutable(sv)
1051 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1052 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1053 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1056 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1057 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
1059 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1060 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
1063 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1064 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1066 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1067 /* These get expanded inside other macros that already use a variable _sv */
1068 # define SvPVX(sv) \
1069 (*({ SV *const _svi = (SV *) (sv); \
1070 assert(SvTYPE(_svi) >= SVt_PV); \
1071 assert(SvTYPE(_svi) != SVt_PVAV); \
1072 assert(SvTYPE(_svi) != SVt_PVHV); \
1073 assert(!isGV_with_GP(_svi)); \
1074 &((_svi)->sv_u.svu_pv); \
1076 # define SvCUR(sv) \
1077 (*({ SV *const _svi = (SV *) (sv); \
1078 assert(SvTYPE(_svi) >= SVt_PV); \
1079 assert(SvTYPE(_svi) != SVt_PVAV); \
1080 assert(SvTYPE(_svi) != SVt_PVHV); \
1081 assert(!isGV_with_GP(_svi)); \
1082 &(((XPV*) SvANY(_svi))->xpv_cur); \
1084 # define SvIVX(sv) \
1085 (*({ SV *const _svi = (SV *) (sv); \
1086 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1087 assert(SvTYPE(_svi) != SVt_PVAV); \
1088 assert(SvTYPE(_svi) != SVt_PVHV); \
1089 assert(SvTYPE(_svi) != SVt_PVCV); \
1090 assert(!isGV_with_GP(_svi)); \
1091 &(((XPVIV*) SvANY(_svi))->xiv_iv); \
1093 # define SvUVX(sv) \
1094 (*({ SV *const _svi = (SV *) (sv); \
1095 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1096 assert(SvTYPE(_svi) != SVt_PVAV); \
1097 assert(SvTYPE(_svi) != SVt_PVHV); \
1098 assert(SvTYPE(_svi) != SVt_PVCV); \
1099 assert(!isGV_with_GP(_svi)); \
1100 &(((XPVUV*) SvANY(_svi))->xuv_uv); \
1102 # define SvNVX(sv) \
1103 (*({ SV *const _svi = (SV *) (sv); \
1104 assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \
1105 assert(SvTYPE(_svi) != SVt_PVAV); \
1106 assert(SvTYPE(_svi) != SVt_PVHV); \
1107 assert(SvTYPE(_svi) != SVt_PVCV); \
1108 assert(SvTYPE(_svi) != SVt_PVFM); \
1109 assert(!isGV_with_GP(_svi)); \
1110 &(((XPVNV*) SvANY(_svi))->xnv_u.xnv_nv); \
1113 (*({ SV *const _svi = (SV *) (sv); \
1114 assert(SvTYPE(_svi) >= SVt_PV || SvTYPE(_svi) == SVt_IV); \
1115 assert(SvTYPE(_svi) != SVt_PVAV); \
1116 assert(SvTYPE(_svi) != SVt_PVHV); \
1117 assert(SvTYPE(_svi) != SVt_PVCV); \
1118 assert(SvTYPE(_svi) != SVt_PVFM); \
1119 assert(!isGV_with_GP(_svi)); \
1120 &((_svi)->sv_u.svu_rv); \
1122 # define SvMAGIC(sv) \
1123 (*({ SV *const _svi = (SV *) (sv); \
1124 assert(SvTYPE(_svi) >= SVt_PVMG); \
1125 if(SvTYPE(_svi) == SVt_PVMG) \
1126 assert(!SvPAD_OUR(_svi)); \
1127 &(((XPVMG*) SvANY(_svi))->xmg_u.xmg_magic); \
1129 # define SvSTASH(sv) \
1130 (*({ SV *const _svi = (SV *) (sv); \
1131 assert(SvTYPE(_svi) >= SVt_PVMG); \
1132 &(((XPVMG*) SvANY(_svi))->xmg_stash); \
1135 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1136 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1137 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1138 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1139 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1140 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1141 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1142 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1147 /* Given that these two are new, there can't be any existing code using them
1149 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1150 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1152 /* Except for the poison code, which uses & to scribble over the pointer after
1153 free() is called. */
1154 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1155 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1158 #define SvIVXx(sv) SvIVX(sv)
1159 #define SvUVXx(sv) SvUVX(sv)
1160 #define SvNVXx(sv) SvNVX(sv)
1161 #define SvPVXx(sv) SvPVX(sv)
1162 #define SvLENx(sv) SvLEN(sv)
1163 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1166 /* Ask a scalar nicely to try to become an IV, if possible.
1167 Not guaranteed to stay returning void */
1168 /* Macro won't actually call sv_2iv if already IOK */
1169 #define SvIV_please(sv) \
1170 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1171 (void) SvIV(sv); } STMT_END
1172 #define SvIV_set(sv, val) \
1173 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1174 assert(SvTYPE(sv) != SVt_PVAV); \
1175 assert(SvTYPE(sv) != SVt_PVHV); \
1176 assert(SvTYPE(sv) != SVt_PVCV); \
1177 assert(!isGV_with_GP(sv)); \
1178 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1179 #define SvNV_set(sv, val) \
1180 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1181 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1182 assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1183 assert(!isGV_with_GP(sv)); \
1184 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1185 #define SvPV_set(sv, val) \
1186 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1187 assert(SvTYPE(sv) != SVt_PVAV); \
1188 assert(SvTYPE(sv) != SVt_PVHV); \
1189 assert(!isGV_with_GP(sv)); \
1190 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1191 #define SvUV_set(sv, val) \
1192 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1193 assert(SvTYPE(sv) != SVt_PVAV); \
1194 assert(SvTYPE(sv) != SVt_PVHV); \
1195 assert(SvTYPE(sv) != SVt_PVCV); \
1196 assert(!isGV_with_GP(sv)); \
1197 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1198 #define SvRV_set(sv, val) \
1199 STMT_START { assert(SvTYPE(sv) >= SVt_PV || SvTYPE(sv) == SVt_IV); \
1200 assert(SvTYPE(sv) != SVt_PVAV); \
1201 assert(SvTYPE(sv) != SVt_PVHV); \
1202 assert(SvTYPE(sv) != SVt_PVCV); \
1203 assert(SvTYPE(sv) != SVt_PVFM); \
1204 assert(!isGV_with_GP(sv)); \
1205 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1206 #define SvMAGIC_set(sv, val) \
1207 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1208 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1209 #define SvSTASH_set(sv, val) \
1210 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1211 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1212 #define SvCUR_set(sv, val) \
1213 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1214 assert(SvTYPE(sv) != SVt_PVAV); \
1215 assert(SvTYPE(sv) != SVt_PVHV); \
1216 assert(!isGV_with_GP(sv)); \
1217 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1218 #define SvLEN_set(sv, val) \
1219 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1220 assert(SvTYPE(sv) != SVt_PVAV); \
1221 assert(SvTYPE(sv) != SVt_PVHV); \
1222 assert(!isGV_with_GP(sv)); \
1223 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1224 #define SvEND_set(sv, val) \
1225 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1226 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
1228 #define SvPV_renew(sv,n) \
1229 STMT_START { SvLEN_set(sv, n); \
1230 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1231 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1232 (MEM_SIZE)((n))))); \
1235 #define SvPV_shrink_to_cur(sv) STMT_START { \
1236 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1237 SvPV_renew(sv, _lEnGtH); \
1240 #define SvPV_free(sv) \
1242 assert(SvTYPE(sv) >= SVt_PV); \
1244 assert(!SvROK(sv)); \
1247 SvOOK_offset(sv, zok); \
1248 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1249 SvFLAGS(sv) &= ~SVf_OOK; \
1251 Safefree(SvPVX(sv)); \
1256 /* Code that crops up in three places to take a scalar and ready it to hold
1258 # define prepare_SV_for_RV(sv) \
1260 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1261 sv_upgrade(sv, SVt_IV); \
1262 else if (SvTYPE(sv) >= SVt_PV) { \
1270 #define PERL_FBM_TABLE_OFFSET 1 /* Number of bytes between EOS and table */
1272 /* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1275 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1276 # define BmFLAGS(sv) \
1277 (*({ SV *const uggh = (SV *) (sv); \
1278 assert(SvTYPE(uggh) == SVt_PVGV); \
1279 assert(SvVALID(uggh)); \
1280 &(((XPVGV*) SvANY(uggh))->xnv_u.xbm_s.xbm_flags); \
1282 # define BmRARE(sv) \
1283 (*({ SV *const uggh = (SV *) (sv); \
1284 assert(SvTYPE(uggh) == SVt_PVGV); \
1285 assert(SvVALID(uggh)); \
1286 &(((XPVGV*) SvANY(uggh))->xnv_u.xbm_s.xbm_rare); \
1288 # define BmUSEFUL(sv) \
1289 (*({ SV *const uggh = (SV *) (sv); \
1290 assert(SvTYPE(uggh) == SVt_PVGV); \
1291 assert(SvVALID(uggh)); \
1292 assert(!SvIOK(uggh)); \
1293 &(((XPVGV*) SvANY(uggh))->xiv_u.xivu_i32); \
1295 # define BmPREVIOUS(sv) \
1296 (*({ SV *const uggh = (SV *) (sv); \
1297 assert(SvTYPE(uggh) == SVt_PVGV); \
1298 assert(SvVALID(uggh)); \
1299 &(((XPVGV*) SvANY(uggh))->xnv_u.xbm_s.xbm_previous); \
1302 # define BmFLAGS(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_flags
1303 # define BmRARE(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1304 # define BmUSEFUL(sv) ((XPVGV*) SvANY(sv))->xiv_u.xivu_i32
1305 # define BmPREVIOUS(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_previous
1309 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1311 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1312 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1313 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1314 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1316 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1317 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1318 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1319 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1320 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1321 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1322 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1323 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1324 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1325 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1326 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1327 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1328 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1329 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1330 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1331 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1333 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1334 #define IoTYPE_RDONLY '<'
1335 #define IoTYPE_WRONLY '>'
1336 #define IoTYPE_RDWR '+'
1337 #define IoTYPE_APPEND 'a'
1338 #define IoTYPE_PIPE '|'
1339 #define IoTYPE_STD '-' /* stdin or stdout */
1340 #define IoTYPE_SOCKET 's'
1341 #define IoTYPE_CLOSED ' '
1342 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1343 #define IoTYPE_NUMERIC '#' /* fdopen */
1346 =for apidoc Am|bool|SvTAINTED|SV* sv
1347 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1350 =for apidoc Am|void|SvTAINTED_on|SV* sv
1351 Marks an SV as tainted if tainting is enabled.
1353 =for apidoc Am|void|SvTAINTED_off|SV* sv
1354 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1355 some of Perl's fundamental security features. XS module authors should not
1356 use this function unless they fully understand all the implications of
1357 unconditionally untainting the value. Untainting should be done in the
1358 standard perl fashion, via a carefully crafted regexp, rather than directly
1359 untainting variables.
1361 =for apidoc Am|void|SvTAINT|SV* sv
1362 Taints an SV if tainting is enabled.
1367 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1369 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1370 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1371 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1373 #define SvTAINT(sv) \
1375 if (PL_tainting) { \
1382 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1383 Like C<SvPV> but will force the SV into containing just a string
1384 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1387 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1388 Like C<SvPV> but will force the SV into containing just a string
1389 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1390 directly. Doesn't process magic.
1392 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1393 Returns a pointer to the string in the SV, or a stringified form of
1394 the SV if the SV does not contain a string. The SV may cache the
1395 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1396 C<SvPVx> for a version which guarantees to evaluate sv only once.
1398 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1399 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1400 Only use this if C<sv> is an expression with side effects, otherwise use the
1401 more efficient C<SvPVX>.
1403 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1404 Like C<SvPV> but doesn't process magic.
1406 =for apidoc Am|char*|SvPV_nolen|SV* sv
1407 Returns a pointer to the string in the SV, or a stringified form of
1408 the SV if the SV does not contain a string. The SV may cache the
1409 stringified form becoming C<SvPOK>. Handles 'get' magic.
1411 =for apidoc Am|IV|SvIV|SV* sv
1412 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1413 version which guarantees to evaluate sv only once.
1415 =for apidoc Am|IV|SvIV_nomg|SV* sv
1416 Like C<SvIV> but doesn't process magic.
1418 =for apidoc Am|IV|SvIVx|SV* sv
1419 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1420 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1421 otherwise use the more efficient C<SvIV>.
1423 =for apidoc Am|NV|SvNV|SV* sv
1424 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1425 which guarantees to evaluate sv only once.
1427 =for apidoc Am|NV|SvNVx|SV* sv
1428 Coerces the given SV to a double and returns it. Guarantees to evaluate
1429 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1430 otherwise use the more efficient C<SvNV>.
1432 =for apidoc Am|UV|SvUV|SV* sv
1433 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1434 for a version which guarantees to evaluate sv only once.
1436 =for apidoc Am|UV|SvUV_nomg|SV* sv
1437 Like C<SvUV> but doesn't process magic.
1439 =for apidoc Am|UV|SvUVx|SV* sv
1440 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1441 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1442 otherwise use the more efficient C<SvUV>.
1444 =for apidoc Am|bool|SvTRUE|SV* sv
1445 Returns a boolean indicating whether Perl would evaluate the SV as true or
1446 false, defined or undefined. Does not handle 'get' magic.
1448 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1449 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1451 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1452 Like C<SvPV>, but converts sv to utf8 first if necessary.
1454 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1455 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1457 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1458 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1460 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1461 Like C<SvPV>, but converts sv to byte representation first if necessary.
1463 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1464 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1466 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1467 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1468 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1471 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1472 Like C<SvPV>, but converts sv to utf8 first if necessary.
1473 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1476 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1477 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1478 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1481 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1482 Like C<SvPV>, but converts sv to byte representation first if necessary.
1483 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1486 =for apidoc Am|bool|SvIsCOW|SV* sv
1487 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1488 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1491 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1492 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1495 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1496 Like C<sv_catpvn> but doesn't process magic.
1498 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1499 Like C<sv_setsv> but doesn't process magic.
1501 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1502 Like C<sv_catsv> but doesn't process magic.
1507 /* Let us hope that bitmaps for UV and IV are the same */
1508 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1509 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1510 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1512 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1513 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1517 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1518 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1519 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1521 #define SvPV_flags(sv, lp, flags) \
1522 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1523 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1524 #define SvPV_flags_const(sv, lp, flags) \
1525 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1526 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1527 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1528 #define SvPV_flags_const_nolen(sv, flags) \
1529 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1530 ? SvPVX_const(sv) : \
1531 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1532 #define SvPV_flags_mutable(sv, lp, flags) \
1533 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1534 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1535 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1537 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1538 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1539 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1541 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1542 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1544 #define SvPV_force_flags(sv, lp, flags) \
1545 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1546 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1547 #define SvPV_force_flags_nolen(sv, flags) \
1548 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1549 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1550 #define SvPV_force_flags_mutable(sv, lp, flags) \
1551 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1552 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1553 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1555 #define SvPV_nolen(sv) \
1556 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1557 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1559 #define SvPV_nolen_const(sv) \
1560 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1561 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1563 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1564 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1565 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1569 #define SvPVutf8(sv, lp) \
1570 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1571 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1573 #define SvPVutf8_force(sv, lp) \
1574 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1575 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1578 #define SvPVutf8_nolen(sv) \
1579 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1580 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1584 #define SvPVbyte(sv, lp) \
1585 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1586 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1588 #define SvPVbyte_force(sv, lp) \
1589 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1590 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1592 #define SvPVbyte_nolen(sv) \
1593 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1594 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1598 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1599 * var to evaluate the arg once; failing that, use a global if possible;
1600 * failing that, call a function to do the work
1603 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1604 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1605 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1607 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1609 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1610 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1611 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1612 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1613 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1614 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1615 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1616 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1617 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1618 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1619 # define SvTRUE(sv) ( \
1623 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1625 (nxpv->xpv_cur > 1 || \
1626 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1633 ? SvNVX(sv) != 0.0 \
1635 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1637 #else /* __GNUC__ */
1639 /* These inlined macros use globals, which will require a thread
1640 * declaration in user code, so we avoid them under threads */
1642 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1643 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1644 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1645 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1646 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1647 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1648 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1649 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1650 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1651 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1652 # define SvTRUE(sv) ( \
1656 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1657 (PL_Xpv->xpv_cur > 1 || \
1658 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1665 ? SvNVX(sv) != 0.0 \
1667 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1668 #endif /* __GNU__ */
1670 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1671 (SVf_FAKE | SVf_READONLY))
1672 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1674 #define SvSHARED_HEK_FROM_PV(pvx) \
1675 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1676 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1678 /* flag values for sv_*_flags functions */
1679 #define SV_IMMEDIATE_UNREF 1
1681 #define SV_COW_DROP_PV 4
1682 #define SV_UTF8_NO_ENCODING 8
1683 #define SV_NOSTEAL 16
1684 #define SV_CONST_RETURN 32
1685 #define SV_MUTABLE_RETURN 64
1686 #define SV_SMAGIC 128
1687 #define SV_HAS_TRAILING_NUL 256
1688 #define SV_COW_SHARED_HASH_KEYS 512
1689 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1690 #define SV_COW_OTHER_PVS 1024
1692 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1693 So only default to doing the COW setup if we're in the core.
1696 # ifndef SV_DO_COW_SVSETSV
1697 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1701 #ifndef SV_DO_COW_SVSETSV
1702 # define SV_DO_COW_SVSETSV 0
1706 #define sv_unref(sv) sv_unref_flags(sv, 0)
1707 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1708 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1709 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1711 /* We are about to replace the SV's current value. So if it's copy on write
1712 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1713 the value is about to get thrown away, so drop the PV rather than go to
1714 the effort of making a read-write copy only for it to get immediately
1717 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1718 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1720 #ifdef PERL_OLD_COPY_ON_WRITE
1721 #define SvRELEASE_IVX(sv) \
1722 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1723 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1724 # define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
1726 # define SvRELEASE_IVX(sv) 0
1727 /* This little game brought to you by the need to shut this warning up:
1728 mg.c: In function `Perl_magic_get':
1729 mg.c:1024: warning: left-hand operand of comma expression has no effect
1731 # define SvRELEASE_IVX_(sv) /**/
1732 #endif /* PERL_OLD_COPY_ON_WRITE */
1734 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1735 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1736 SVf_OOK|SVf_BREAK|SVf_READONLY)
1737 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1739 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1740 sv_force_normal_flags(sv, 0)
1743 /* all these 'functions' are now just macros */
1745 #define sv_pv(sv) SvPV_nolen(sv)
1746 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1747 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1749 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1750 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1751 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1752 #define sv_setsv(dsv, ssv) \
1753 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1754 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1755 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1756 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1757 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1758 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1759 #define sv_catpvn_mg(sv, sstr, slen) \
1760 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1761 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1762 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1763 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1764 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1765 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1766 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1767 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1768 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1769 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1771 /* Should be named SvCatPVN_utf8_upgrade? */
1772 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1775 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
1777 sv_setpvn(nsv, sstr, slen); \
1779 sv_utf8_upgrade(nsv); \
1780 sv_catsv(dsv, nsv); \
1784 =for apidoc Am|SV*|newRV_inc|SV* sv
1786 Creates an RV wrapper for an SV. The reference count for the original SV is
1792 #define newRV_inc(sv) newRV(sv)
1794 /* the following macros update any magic values this sv is associated with */
1797 =head1 Magical Functions
1799 =for apidoc Am|void|SvGETMAGIC|SV* sv
1800 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1801 argument more than once.
1803 =for apidoc Am|void|SvSETMAGIC|SV* sv
1804 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1805 argument more than once.
1807 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1808 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1811 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1812 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1813 ssv. May evaluate arguments more than once.
1815 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1816 Like C<SvSetSV>, but does any set magic required afterwards.
1818 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1819 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1821 =for apidoc Am|void|SvSHARE|SV* sv
1822 Arranges for sv to be shared between threads if a suitable module
1825 =for apidoc Am|void|SvLOCK|SV* sv
1826 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1829 =for apidoc Am|void|SvUNLOCK|SV* sv
1830 Releases a mutual exclusion lock on sv if a suitable module
1833 =head1 SV Manipulation Functions
1835 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1836 Expands the character buffer in the SV so that it has room for the
1837 indicated number of bytes (remember to reserve space for an extra trailing
1838 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1839 Returns a pointer to the character buffer.
1844 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1845 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1846 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1847 #define SvDESTROYABLE(sv) CALL_FPTR(PL_destroyhook)(aTHX_ sv)
1849 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1850 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1852 #define SvSetSV_and(dst,src,finally) \
1854 if ((dst) != (src)) { \
1855 sv_setsv(dst, src); \
1859 #define SvSetSV_nosteal_and(dst,src,finally) \
1861 if ((dst) != (src)) { \
1862 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
1867 #define SvSetSV(dst,src) \
1868 SvSetSV_and(dst,src,/*nothing*/;)
1869 #define SvSetSV_nosteal(dst,src) \
1870 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1872 #define SvSetMagicSV(dst,src) \
1873 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1874 #define SvSetMagicSV_nosteal(dst,src) \
1875 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1878 #if !defined(SKIP_DEBUGGING)
1879 #define SvPEEK(sv) sv_peek(sv)
1881 #define SvPEEK(sv) ""
1884 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1886 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1888 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1889 /* If I give every macro argument a different name, then there won't be bugs
1890 where nested macros get confused. Been there, done that. */
1891 #define isGV_with_GP(pwadak) \
1892 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
1893 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
1894 #define isGV_with_GP_on(sv) STMT_START { \
1895 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1896 assert (!SvPOKp(sv)); \
1897 assert (!SvIOKp(sv)); \
1898 (SvFLAGS(sv) |= SVpgv_GP); \
1900 #define isGV_with_GP_off(sv) STMT_START { \
1901 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1902 assert (!SvPOKp(sv)); \
1903 assert (!SvIOKp(sv)); \
1904 (SvFLAGS(sv) &= ~SVpgv_GP); \
1908 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1909 #define SvGROW_mutable(sv,len) \
1910 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1911 #define Sv_Grow sv_grow
1913 #define CLONEf_COPY_STACKS 1
1914 #define CLONEf_KEEP_PTR_TABLE 2
1915 #define CLONEf_CLONE_HOST 4
1916 #define CLONEf_JOIN_IN 8
1918 struct clone_params {
1921 PerlInterpreter *proto_perl;
1925 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
1927 Creates a new SV and copies a string into it. If utf8 is true, calls
1928 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
1933 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
1936 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
1938 Reads into I<len> the offset from SvPVX back to the true start of the
1939 allocated buffer, which will be non-zero if C<sv_chop> has been used to
1940 efficiently remove characters from start of the buffer. Implemented as a
1941 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
1942 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
1948 /* Does the bot know something I don't?
1949 10:28 <@Nicholas> metabatman
1950 10:28 <+meta> Nicholas: crash
1952 # define SvOOK_offset(sv, offset) STMT_START { \
1953 assert(sizeof(offset) == sizeof(STRLEN)); \
1955 const U8 *crash = (U8*)SvPVX_const(sv); \
1956 offset = *--crash; \
1958 crash -= sizeof(STRLEN); \
1959 Copy(crash, (U8 *)&offset, sizeof(STRLEN), U8); \
1962 /* Validate the preceding buffer's sentinels to \
1963 verify that no-one is using it. */ \
1964 const U8 *const bonk = (U8 *) SvPVX_const(sv) - offset; \
1965 while (crash > bonk) { \
1967 assert (*crash == (U8)PTR2UV(crash)); \
1975 /* This is the same code, but avoids using any temporary variables: */
1976 # define SvOOK_offset(sv, offset) STMT_START { \
1977 assert(sizeof(offset) == sizeof(STRLEN)); \
1979 offset = ((U8*)SvPVX_const(sv))[-1]; \
1981 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
1982 (U8 *)&offset, sizeof(STRLEN), U8); \
1991 * c-indentation-style: bsd
1993 * indent-tabs-mode: t
1996 * ex: set ts=8 sts=4 sw=4 noet: