3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 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 so never reaches the clause at the end that uses sv_type_details->body_size
80 to determine whether to call safefree(). Hence body_size can be set
81 non-zero to record the size of HEs, without fear of bogus frees. */
82 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
83 #define HE_SVSLOT SVt_NULL
86 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
88 /* typedefs to eliminate some typing */
90 typedef struct hek HEK;
92 /* Using C's structural equivalence to help emulate C++ inheritance here... */
94 /* start with 2 sv-head building blocks */
95 #define _SV_HEAD(ptrtype) \
96 ptrtype sv_any; /* pointer to body */ \
97 U32 sv_refcnt; /* how many references to us */ \
98 U32 sv_flags /* what we are */
100 #define _SV_HEAD_UNION \
102 char* svu_pv; /* pointer to malloced string */ \
105 SV* svu_rv; /* pointer to another SV */ \
112 struct STRUCT_SV { /* struct sv { */
115 #ifdef DEBUG_LEAKING_SCALARS
116 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */
117 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */
118 PERL_BITFIELD32 sv_debug_cloned:1; /* was cloned for an ithread */
119 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */
120 U32 sv_debug_serial; /* serial number of sv allocation */
121 char * sv_debug_file; /* the file where we were allocated */
126 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
131 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
136 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
141 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
146 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
151 _SV_HEAD(struct regexp*); /* pointer to regexp body */
156 #undef _SV_HEAD_UNION /* ensure no pollution */
159 =head1 SV Manipulation Functions
161 =for apidoc Am|U32|SvREFCNT|SV* sv
162 Returns the value of the object's reference count.
164 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
165 Increments the reference count of the given SV.
167 All of the following SvREFCNT_inc* macros are optimized versions of
168 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
170 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
171 Same as SvREFCNT_inc, but can only be used if you know I<sv>
172 is not NULL. Since we don't have to check the NULLness, it's faster
175 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
176 Same as SvREFCNT_inc, but can only be used if you don't need the
177 return value. The macro doesn't need to return a meaningful value.
179 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
180 Same as SvREFCNT_inc, but can only be used if you don't need the return
181 value, and you know that I<sv> is not NULL. The macro doesn't need
182 to return a meaningful value, or check for NULLness, so it's smaller
185 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
186 Same as SvREFCNT_inc, but can only be used with expressions without side
187 effects. Since we don't have to store a temporary value, it's faster.
189 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
190 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
191 is not NULL. Since we don't have to check the NULLness, it's faster
194 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
195 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
196 return value. The macro doesn't need to return a meaningful value.
198 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
199 Same as SvREFCNT_inc, but can only be used if you don't need the return
200 value, and you know that I<sv> is not NULL. The macro doesn't need
201 to return a meaningful value, or check for NULLness, so it's smaller
204 =for apidoc Am|void|SvREFCNT_dec|SV* sv
205 Decrements the reference count of the given SV.
207 =for apidoc Am|svtype|SvTYPE|SV* sv
208 Returns the type of the SV. See C<svtype>.
210 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
211 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
212 perform the upgrade if necessary. See C<svtype>.
217 #define SvANY(sv) (sv)->sv_any
218 #define SvFLAGS(sv) (sv)->sv_flags
219 #define SvREFCNT(sv) (sv)->sv_refcnt
221 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
222 # define SvREFCNT_inc(sv) \
224 SV * const _sv = MUTABLE_SV(sv); \
229 # define SvREFCNT_inc_simple(sv) \
235 # define SvREFCNT_inc_NN(sv) \
237 SV * const _sv = MUTABLE_SV(sv); \
241 # define SvREFCNT_inc_void(sv) \
243 SV * const _sv = MUTABLE_SV(sv); \
245 (void)(SvREFCNT(_sv)++); \
248 # define SvREFCNT_inc(sv) \
249 ((PL_Sv=MUTABLE_SV(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
250 # define SvREFCNT_inc_simple(sv) \
251 ((sv) ? (SvREFCNT(sv)++,MUTABLE_SV(sv)) : NULL)
252 # define SvREFCNT_inc_NN(sv) \
253 (PL_Sv=MUTABLE_SV(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
254 # define SvREFCNT_inc_void(sv) \
255 (void)((PL_Sv=MUTABLE_SV(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
258 /* These guys don't need the curly blocks */
259 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
260 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
261 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
262 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
264 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
265 # define SvREFCNT_dec(sv) \
267 SV * const _sv = MUTABLE_SV(sv); \
269 if (SvREFCNT(_sv)) { \
270 if (--(SvREFCNT(_sv)) == 0) \
271 Perl_sv_free2(aTHX_ _sv); \
278 #define SvREFCNT_dec(sv) sv_free(MUTABLE_SV(sv))
281 #define SVTYPEMASK 0xff
282 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
284 /* Sadly there are some parts of the core that have pointers to already-freed
285 SV heads, and rely on being able to tell that they are now free. So mark
286 them all by using a consistent macro. */
287 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
289 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
291 #define SVf_IOK 0x00000100 /* has valid public integer value */
292 #define SVf_NOK 0x00000200 /* has valid public numeric value */
293 #define SVf_POK 0x00000400 /* has valid public pointer value */
294 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
296 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
297 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
298 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
299 #define SVp_SCREAM 0x00008000 /* has been studied? */
300 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
301 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
302 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
303 subroutine in another package. Set the
304 CvIMPORTED_CV_ON() if it needs to be
305 expanded to a real GV */
307 #define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
308 #define SVpad_STATE 0x00010000 /* pad name is a "state" var */
309 #define SVs_PADTMP 0x00020000 /* in use as tmp */
310 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
311 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
312 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
313 #define SVs_TEMP 0x00080000 /* string is stealable? */
314 #define SVs_OBJECT 0x00100000 /* is "blessed" */
315 #define SVs_GMG 0x00200000 /* has magical get method */
316 #define SVs_SMG 0x00400000 /* has magical set method */
317 #define SVs_RMG 0x00800000 /* has random magical methods */
319 #define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
320 1: SV head arena wasn't malloc()ed
321 2: in conjunction with SVf_READONLY
322 marks a shared hash key scalar
323 (SvLEN == 0) or a copy on write
324 string (SvLEN != 0) [SvIsCOW(sv)]
325 3: For PVCV, whether CvUNIQUE(cv)
326 refers to an eval or once only
327 [CvEVAL(cv), CvSPECIAL(cv)]
328 4: 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 /* 5: 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 SVs in final arena cleanup.
338 Set in S_regtry on PL_reg_curpm, so that
339 perl_destruct will skip it. */
340 #define SVf_READONLY 0x08000000 /* may not be modified */
345 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
347 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
348 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
350 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
352 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
354 /* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
355 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
356 This is also set on RVs whose overloaded
357 stringification is UTF-8. This might
358 only happen as a side effect of SvPV() */
361 /* Some private flags. */
363 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
364 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
365 been restructured, so sometimes get used as string buffers. */
368 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
369 /* PVNV, PVMG, presumably only inside pads */
370 #define SVpad_NAME 0x40000000 /* This SV is a name in the PAD, so
371 SVpad_TYPED, SVpad_OUR and SVpad_STATE
374 #define SVpav_REAL 0x40000000 /* free old entries */
376 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
377 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
378 on any regular scalar (anything <= PVLV) */
379 #define SVpbm_VALID 0x40000000
381 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
383 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
384 /* Presumably IVs aren't stored in pads */
385 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
387 #define SVpav_REIFY 0x80000000 /* can become real */
389 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
391 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
392 /* PVGV when SVpbm_VALID is true */
393 #define SVpbm_TAIL 0x80000000
394 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
395 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
398 HV* xmg_stash; /* class package */ \
400 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
401 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 */
422 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
423 HV * xivu_hv; /* regexp: paren_names */
427 MAGIC* xmg_magic; /* linked list of magicalness */
428 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
440 #define xiv_iv xiv_u.xivu_iv
447 #define xuv_uv xuv_u.xivu_uv
455 /* This structure must match the beginning of struct xpvhv in hv.h. */
469 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
470 * y=alem/helem/iter t=tie T=tied HE */
473 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
481 /* This structure must match XPVCV in cv.h */
483 typedef U16 cv_flags_t;
485 #define _XPVCV_COMMON \
494 void (*xcv_xsub) (pTHX_ CV*); \
500 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
501 * compilation) in the lexically enclosing \
510 #define _XPVIO_TAIL \
511 PerlIO * xio_ifp; /* ifp and ofp are normally the same */ \
512 PerlIO * xio_ofp; /* but sockets need separate streams */ \
513 /* Cray addresses everything by word boundaries (64 bits) and \
514 * code and data pointers cannot be mixed (which is exactly what \
515 * Perl_filter_add() tries to do with the dirp), hence the \
516 * following union trick (as suggested by Gurusamy Sarathy). \
517 * For further information see Geir Johansen's problem report \
518 * titled [ID 20000612.002] Perl problem on Cray system \
519 * The any pointer (known as IoANY()) will also be a good place \
520 * to hang any IO disciplines to. \
523 DIR * xiou_dirp; /* for opendir, readdir, etc */ \
524 void * xiou_any; /* for alignment */ \
526 /* IV xio_lines is now in IVX $. */ \
527 IV xio_page; /* $% */ \
528 IV xio_page_len; /* $= */ \
529 IV xio_lines_left; /* $- */ \
530 char * xio_top_name; /* $^ */ \
531 GV * xio_top_gv; /* $^ */ \
532 char * xio_fmt_name; /* $~ */ \
533 GV * xio_fmt_gv; /* $~ */ \
534 char * xio_bottom_name;/* $^B */ \
535 GV * xio_bottom_gv; /* $^B */ \
546 #define xio_dirp xio_dirpu.xiou_dirp
547 #define xio_any xio_dirpu.xiou_any
549 #define IOf_ARGV 1 /* this fp iterates over ARGV */
550 #define IOf_START 2 /* check for null ARGV and substitute '-' */
551 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
552 #define IOf_DIDTOP 8 /* just did top of form */
553 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
554 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
555 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
557 /* The following macros define implementation-independent predicates on SVs. */
560 =for apidoc Am|U32|SvNIOK|SV* sv
561 Returns a U32 value indicating whether the SV contains a number, integer or
564 =for apidoc Am|U32|SvNIOKp|SV* sv
565 Returns a U32 value indicating whether the SV contains a number, integer or
566 double. Checks the B<private> setting. Use C<SvNIOK> instead.
568 =for apidoc Am|void|SvNIOK_off|SV* sv
569 Unsets the NV/IV status of an SV.
571 =for apidoc Am|U32|SvOK|SV* sv
572 Returns a U32 value indicating whether the value is defined. This is
573 only meaningful for scalars.
575 =for apidoc Am|U32|SvIOKp|SV* sv
576 Returns a U32 value indicating whether the SV contains an integer. Checks
577 the B<private> setting. Use C<SvIOK> instead.
579 =for apidoc Am|U32|SvNOKp|SV* sv
580 Returns a U32 value indicating whether the SV contains a double. Checks the
581 B<private> setting. Use C<SvNOK> instead.
583 =for apidoc Am|U32|SvPOKp|SV* sv
584 Returns a U32 value indicating whether the SV contains a character string.
585 Checks the B<private> setting. Use C<SvPOK> instead.
587 =for apidoc Am|U32|SvIOK|SV* sv
588 Returns a U32 value indicating whether the SV contains an integer.
590 =for apidoc Am|void|SvIOK_on|SV* sv
591 Tells an SV that it is an integer.
593 =for apidoc Am|void|SvIOK_off|SV* sv
594 Unsets the IV status of an SV.
596 =for apidoc Am|void|SvIOK_only|SV* sv
597 Tells an SV that it is an integer and disables all other OK bits.
599 =for apidoc Am|void|SvIOK_only_UV|SV* sv
600 Tells and SV that it is an unsigned integer and disables all other OK bits.
602 =for apidoc Am|bool|SvIOK_UV|SV* sv
603 Returns a boolean indicating whether the SV contains an unsigned integer.
605 =for apidoc Am|bool|SvUOK|SV* sv
606 Returns a boolean indicating whether the SV contains an unsigned integer.
608 =for apidoc Am|bool|SvIOK_notUV|SV* sv
609 Returns a boolean indicating whether the SV contains a signed integer.
611 =for apidoc Am|U32|SvNOK|SV* sv
612 Returns a U32 value indicating whether the SV contains a double.
614 =for apidoc Am|void|SvNOK_on|SV* sv
615 Tells an SV that it is a double.
617 =for apidoc Am|void|SvNOK_off|SV* sv
618 Unsets the NV status of an SV.
620 =for apidoc Am|void|SvNOK_only|SV* sv
621 Tells an SV that it is a double and disables all other OK bits.
623 =for apidoc Am|U32|SvPOK|SV* sv
624 Returns a U32 value indicating whether the SV contains a character
627 =for apidoc Am|void|SvPOK_on|SV* sv
628 Tells an SV that it is a string.
630 =for apidoc Am|void|SvPOK_off|SV* sv
631 Unsets the PV status of an SV.
633 =for apidoc Am|void|SvPOK_only|SV* sv
634 Tells an SV that it is a string and disables all other OK bits.
635 Will also turn off the UTF-8 status.
637 =for apidoc Am|bool|SvVOK|SV* sv
638 Returns a boolean indicating whether the SV contains a v-string.
640 =for apidoc Am|U32|SvOOK|SV* sv
641 Returns a U32 indicating whether the pointer to the string buffer is offset.
642 This hack is used internally to speed up removal of characters from the
643 beginning of a SvPV. When SvOOK is true, then the start of the
644 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
645 This offset used to be stored in SvIVX, but is now stored within the spare
648 =for apidoc Am|U32|SvROK|SV* sv
649 Tests if the SV is an RV.
651 =for apidoc Am|void|SvROK_on|SV* sv
652 Tells an SV that it is an RV.
654 =for apidoc Am|void|SvROK_off|SV* sv
655 Unsets the RV status of an SV.
657 =for apidoc Am|SV*|SvRV|SV* sv
658 Dereferences an RV to return the SV.
660 =for apidoc Am|IV|SvIVX|SV* sv
661 Returns the raw value in the SV's IV slot, without checks or conversions.
662 Only use when you are sure SvIOK is true. See also C<SvIV()>.
664 =for apidoc Am|UV|SvUVX|SV* sv
665 Returns the raw value in the SV's UV slot, without checks or conversions.
666 Only use when you are sure SvIOK is true. See also C<SvUV()>.
668 =for apidoc Am|NV|SvNVX|SV* sv
669 Returns the raw value in the SV's NV slot, without checks or conversions.
670 Only use when you are sure SvNOK is true. See also C<SvNV()>.
672 =for apidoc Am|char*|SvPVX|SV* sv
673 Returns a pointer to the physical string in the SV. The SV must contain a
676 =for apidoc Am|STRLEN|SvCUR|SV* sv
677 Returns the length of the string which is in the SV. See C<SvLEN>.
679 =for apidoc Am|STRLEN|SvLEN|SV* sv
680 Returns the size of the string buffer in the SV, not including any part
681 attributable to C<SvOOK>. See C<SvCUR>.
683 =for apidoc Am|char*|SvEND|SV* sv
684 Returns a pointer to the last character in the string which is in the SV.
685 See C<SvCUR>. Access the character as *(SvEND(sv)).
687 =for apidoc Am|HV*|SvSTASH|SV* sv
688 Returns the stash of the SV.
690 =for apidoc Am|void|SvIV_set|SV* sv|IV val
691 Set the value of the IV pointer in sv to val. It is possible to perform
692 the same function of this macro with an lvalue assignment to C<SvIVX>.
693 With future Perls, however, it will be more efficient to use
694 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
696 =for apidoc Am|void|SvNV_set|SV* sv|NV val
697 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
699 =for apidoc Am|void|SvPV_set|SV* sv|char* val
700 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
702 =for apidoc Am|void|SvUV_set|SV* sv|UV val
703 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
705 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
706 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
708 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
709 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
711 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
712 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
714 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
715 Set the current length of the string which is in the SV. See C<SvCUR>
718 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
719 Set the actual length of the string which is in the SV. See C<SvIV_set>.
724 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
725 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
726 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
727 SVp_IOK|SVp_NOK|SVf_IVisUV))
729 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
730 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
731 #define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
733 #define assert_not_ROK(sv)
734 #define assert_not_glob(sv)
737 #define SvOK(sv) ((SvTYPE(sv) == SVt_BIND) \
738 ? (SvFLAGS(SvRV(sv)) & SVf_OK) \
739 : (SvFLAGS(sv) & SVf_OK))
740 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
741 SvFLAGS(sv) &= ~(SVf_OK| \
742 SVf_IVisUV|SVf_UTF8), \
744 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
745 SvFLAGS(sv) &= ~(SVf_OK| \
749 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
750 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
751 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
752 SvFLAGS(sv) |= SVp_IOK)
753 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
754 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
755 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
756 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
757 SvFLAGS(sv) |= SVp_POK)
759 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
760 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
761 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
762 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
763 #define SvIOK_only(sv) (SvOK_off(sv), \
764 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
765 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
766 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
768 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
769 == (SVf_IOK|SVf_IVisUV))
770 #define SvUOK(sv) SvIOK_UV(sv)
771 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
774 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
775 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
776 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
778 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
779 #define SvNOK_on(sv) (assert_not_glob(sv) \
780 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
781 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
782 #define SvNOK_only(sv) (SvOK_off(sv), \
783 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
786 =for apidoc Am|U32|SvUTF8|SV* sv
787 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
788 Call this after SvPV() in case any call to string overloading updates the
791 =for apidoc Am|void|SvUTF8_on|SV *sv
792 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
793 Do not use frivolously.
795 =for apidoc Am|void|SvUTF8_off|SV *sv
796 Unsets the UTF-8 status of an SV.
798 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
799 Tells an SV that it is a string and disables all other OK bits,
800 and leaves the UTF-8 status as it was.
805 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
807 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
808 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
809 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
811 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
812 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
813 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
814 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
815 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
816 SvFLAGS(sv) &= ~(SVf_OK| \
817 SVf_IVisUV|SVf_UTF8), \
818 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
819 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
820 SvFLAGS(sv) &= ~(SVf_OK| \
822 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
824 #define SvVOK(sv) (SvMAGICAL(sv) \
825 && mg_find(sv,PERL_MAGIC_vstring))
826 /* returns the vstring magic, if any */
827 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
828 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
830 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
831 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
832 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
834 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
835 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
836 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
838 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
839 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
840 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
842 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
843 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
844 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
846 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
847 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
848 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
850 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
851 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
852 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
854 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
855 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
856 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
858 #define SvAMAGIC(sv) (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
859 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
860 # define SvAMAGIC_on(sv) ({ SV * const kloink = sv; \
861 assert(SvROK(kloink)); \
862 SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
864 # define SvAMAGIC_off(sv) ({ SV * const kloink = sv; \
866 SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
869 # define SvAMAGIC_on(sv) (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
870 # define SvAMAGIC_off(sv) \
871 (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
875 =for apidoc Am|U32|SvGAMAGIC|SV* sv
877 Returns true if the SV has get magic or overloading. If either is true then
878 the scalar is active data, and has the potential to return a new value every
879 time it is accessed. Hence you must be careful to only read it once per user
880 logical operation and work with that returned value. If neither is true then
881 the scalar's value cannot change unless written to.
886 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
888 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash, FALSE))
890 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
891 == (SVf_ROK|SVprv_WEAKREF))
892 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
893 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
895 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
896 == (SVf_ROK|SVprv_PCS_IMPORTED))
897 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
898 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
900 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
902 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
903 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
904 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
906 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
907 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
908 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
910 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
911 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
913 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
914 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
915 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
917 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
918 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
919 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
921 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
922 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
923 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
925 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
926 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
927 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
929 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
930 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
931 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
933 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
934 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
935 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
937 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
938 # define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
939 if (SvFLAGS(_svvalid) & SVpbm_VALID) \
940 assert(!isGV_with_GP(_svvalid)); \
941 (SvFLAGS(_svvalid) & SVpbm_VALID); \
943 # define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
944 assert(!isGV_with_GP(_svvalid)); \
945 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
947 # define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
948 assert(!isGV_with_GP(_svvalid)); \
949 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
952 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
953 assert(SvTYPE(_svtail) != SVt_PVAV); \
954 assert(SvTYPE(_svtail) != SVt_PVHV); \
955 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
956 == (SVpbm_TAIL|SVpbm_VALID); \
959 # define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
960 # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
961 # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
962 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
963 == (SVpbm_TAIL|SVpbm_VALID))
966 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
967 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
970 #define SvPAD_TYPED(sv) \
971 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
973 #define SvPAD_OUR(sv) \
974 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
976 #define SvPAD_STATE(sv) \
977 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
979 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
980 # define SvPAD_TYPED_on(sv) ({ \
981 SV *const _svpad = MUTABLE_SV(sv); \
982 assert(SvTYPE(_svpad) == SVt_PVMG); \
983 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \
985 #define SvPAD_OUR_on(sv) ({ \
986 SV *const _svpad = MUTABLE_SV(sv); \
987 assert(SvTYPE(_svpad) == SVt_PVMG); \
988 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \
990 #define SvPAD_STATE_on(sv) ({ \
991 SV *const _svpad = MUTABLE_SV(sv); \
992 assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
993 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \
996 # define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
997 # define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
998 # define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1001 #define SvOURSTASH(sv) \
1002 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1003 #define SvOURSTASH_set(sv, st) \
1005 assert(SvTYPE(sv) == SVt_PVMG); \
1006 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1009 #ifdef PERL_DEBUG_COW
1012 #define SvRVx(sv) SvRV(sv)
1014 #ifdef PERL_DEBUG_COW
1015 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1016 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1017 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1018 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1019 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1020 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1021 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1022 /* Don't test the core XS code yet. */
1023 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1024 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1026 # define SvPVX(sv) SvPVX_mutable(sv)
1028 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1029 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1030 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1033 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1034 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
1036 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1037 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
1040 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1041 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1043 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1044 /* These get expanded inside other macros that already use a variable _sv */
1045 # define SvPVX(sv) \
1046 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1047 assert(SvTYPE(_svpvx) >= SVt_PV); \
1048 assert(SvTYPE(_svpvx) != SVt_PVAV); \
1049 assert(SvTYPE(_svpvx) != SVt_PVHV); \
1050 assert(!isGV_with_GP(_svpvx)); \
1051 &((_svpvx)->sv_u.svu_pv); \
1053 # define SvCUR(sv) \
1054 (*({ const SV *const _svcur = (const SV *)(sv); \
1055 assert(SvTYPE(_svcur) >= SVt_PV); \
1056 assert(SvTYPE(_svcur) != SVt_PVAV); \
1057 assert(SvTYPE(_svcur) != SVt_PVHV); \
1058 assert(!isGV_with_GP(_svcur)); \
1059 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1061 # define SvIVX(sv) \
1062 (*({ const SV *const _svivx = (const SV *)(sv); \
1063 assert(SvTYPE(_svivx) == SVt_IV || SvTYPE(_svivx) >= SVt_PVIV); \
1064 assert(SvTYPE(_svivx) != SVt_PVAV); \
1065 assert(SvTYPE(_svivx) != SVt_PVHV); \
1066 assert(SvTYPE(_svivx) != SVt_PVCV); \
1067 assert(SvTYPE(_svivx) != SVt_PVFM); \
1068 assert(SvTYPE(_svivx) != SVt_PVIO); \
1069 assert(SvTYPE(_svivx) != SVt_REGEXP); \
1070 assert(!isGV_with_GP(_svivx)); \
1071 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1073 # define SvUVX(sv) \
1074 (*({ const SV *const _svuvx = (const SV *)(sv); \
1075 assert(SvTYPE(_svuvx) == SVt_IV || SvTYPE(_svuvx) >= SVt_PVIV); \
1076 assert(SvTYPE(_svuvx) != SVt_PVAV); \
1077 assert(SvTYPE(_svuvx) != SVt_PVHV); \
1078 assert(SvTYPE(_svuvx) != SVt_PVCV); \
1079 assert(SvTYPE(_svuvx) != SVt_PVFM); \
1080 assert(SvTYPE(_svuvx) != SVt_PVIO); \
1081 assert(SvTYPE(_svuvx) != SVt_REGEXP); \
1082 assert(!isGV_with_GP(_svuvx)); \
1083 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1085 # define SvNVX(sv) \
1086 (*({ const SV *const _svnvx = (const SV *)(sv); \
1087 assert(SvTYPE(_svnvx) == SVt_NV || SvTYPE(_svnvx) >= SVt_PVNV); \
1088 assert(SvTYPE(_svnvx) != SVt_PVAV); \
1089 assert(SvTYPE(_svnvx) != SVt_PVHV); \
1090 assert(SvTYPE(_svnvx) != SVt_PVCV); \
1091 assert(SvTYPE(_svnvx) != SVt_PVFM); \
1092 assert(SvTYPE(_svnvx) != SVt_PVIO); \
1093 assert(SvTYPE(_svnvx) != SVt_REGEXP); \
1094 assert(!isGV_with_GP(_svnvx)); \
1095 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1098 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1099 assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1100 assert(SvTYPE(_svrv) != SVt_PVAV); \
1101 assert(SvTYPE(_svrv) != SVt_PVHV); \
1102 assert(SvTYPE(_svrv) != SVt_PVCV); \
1103 assert(SvTYPE(_svrv) != SVt_PVFM); \
1104 assert(!isGV_with_GP(_svrv)); \
1105 &((_svrv)->sv_u.svu_rv); \
1107 # define SvRV_const(sv) \
1108 ({ const SV *const _svrv = (const SV *)(sv); \
1109 assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1110 assert(SvTYPE(_svrv) != SVt_PVAV); \
1111 assert(SvTYPE(_svrv) != SVt_PVHV); \
1112 assert(SvTYPE(_svrv) != SVt_PVCV); \
1113 assert(SvTYPE(_svrv) != SVt_PVFM); \
1114 assert(!isGV_with_GP(_svrv)); \
1115 (_svrv)->sv_u.svu_rv; \
1117 # define SvMAGIC(sv) \
1118 (*({ const SV *const _svmagic = (const SV *)(sv); \
1119 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1120 if(SvTYPE(_svmagic) == SVt_PVMG) \
1121 assert(!SvPAD_OUR(_svmagic)); \
1122 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1124 # define SvSTASH(sv) \
1125 (*({ const SV *const _svstash = (const SV *)(sv); \
1126 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1127 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1130 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1131 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1132 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1133 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1134 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1135 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1136 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1137 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1138 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1143 /* Given that these two are new, there can't be any existing code using them
1145 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1146 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1148 /* Except for the poison code, which uses & to scribble over the pointer after
1149 free() is called. */
1150 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1151 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1154 #define SvIVXx(sv) SvIVX(sv)
1155 #define SvUVXx(sv) SvUVX(sv)
1156 #define SvNVXx(sv) SvNVX(sv)
1157 #define SvPVXx(sv) SvPVX(sv)
1158 #define SvLENx(sv) SvLEN(sv)
1159 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1162 /* Ask a scalar nicely to try to become an IV, if possible.
1163 Not guaranteed to stay returning void */
1164 /* Macro won't actually call sv_2iv if already IOK */
1165 #define SvIV_please(sv) \
1166 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1167 (void) SvIV(sv); } STMT_END
1168 #define SvIV_set(sv, val) \
1169 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1170 assert(SvTYPE(sv) != SVt_PVAV); \
1171 assert(SvTYPE(sv) != SVt_PVHV); \
1172 assert(SvTYPE(sv) != SVt_PVCV); \
1173 assert(!isGV_with_GP(sv)); \
1174 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1175 #define SvNV_set(sv, val) \
1176 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1177 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1178 assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1179 assert(SvTYPE(sv) != SVt_PVIO); \
1180 assert(!isGV_with_GP(sv)); \
1181 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1182 #define SvPV_set(sv, val) \
1183 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1184 assert(SvTYPE(sv) != SVt_PVAV); \
1185 assert(SvTYPE(sv) != SVt_PVHV); \
1186 assert(!isGV_with_GP(sv)); \
1187 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1188 #define SvUV_set(sv, val) \
1189 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1190 assert(SvTYPE(sv) != SVt_PVAV); \
1191 assert(SvTYPE(sv) != SVt_PVHV); \
1192 assert(SvTYPE(sv) != SVt_PVCV); \
1193 assert(!isGV_with_GP(sv)); \
1194 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1195 #define SvRV_set(sv, val) \
1196 STMT_START { assert(SvTYPE(sv) >= SVt_PV || SvTYPE(sv) == SVt_IV); \
1197 assert(SvTYPE(sv) != SVt_PVAV); \
1198 assert(SvTYPE(sv) != SVt_PVHV); \
1199 assert(SvTYPE(sv) != SVt_PVCV); \
1200 assert(SvTYPE(sv) != SVt_PVFM); \
1201 assert(!isGV_with_GP(sv)); \
1202 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1203 #define SvMAGIC_set(sv, val) \
1204 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1205 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1206 #define SvSTASH_set(sv, val) \
1207 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1208 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1209 #define SvCUR_set(sv, val) \
1210 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1211 assert(SvTYPE(sv) != SVt_PVAV); \
1212 assert(SvTYPE(sv) != SVt_PVHV); \
1213 assert(!isGV_with_GP(sv)); \
1214 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1215 #define SvLEN_set(sv, val) \
1216 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1217 assert(SvTYPE(sv) != SVt_PVAV); \
1218 assert(SvTYPE(sv) != SVt_PVHV); \
1219 assert(!isGV_with_GP(sv)); \
1220 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1221 #define SvEND_set(sv, val) \
1222 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1223 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1225 #define SvPV_renew(sv,n) \
1226 STMT_START { SvLEN_set(sv, n); \
1227 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1228 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1229 (MEM_SIZE)((n))))); \
1232 #define SvPV_shrink_to_cur(sv) STMT_START { \
1233 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1234 SvPV_renew(sv, _lEnGtH); \
1237 #define SvPV_free(sv) \
1239 assert(SvTYPE(sv) >= SVt_PV); \
1241 assert(!SvROK(sv)); \
1244 SvOOK_offset(sv, zok); \
1245 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1246 SvFLAGS(sv) &= ~SVf_OOK; \
1248 Safefree(SvPVX(sv)); \
1253 /* Code that crops up in three places to take a scalar and ready it to hold
1255 # define prepare_SV_for_RV(sv) \
1257 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1258 sv_upgrade(sv, SVt_IV); \
1259 else if (SvTYPE(sv) >= SVt_PV) { \
1267 #define PERL_FBM_TABLE_OFFSET 1 /* Number of bytes between EOS and table */
1269 /* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1272 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1273 # define BmFLAGS(sv) \
1274 (*({ SV *const _bmflags = MUTABLE_SV(sv); \
1275 assert(SvTYPE(_bmflags) == SVt_PVGV); \
1276 assert(SvVALID(_bmflags)); \
1277 &(((XPVGV*) SvANY(_bmflags))->xnv_u.xbm_s.xbm_flags); \
1279 # define BmRARE(sv) \
1280 (*({ SV *const _bmrare = MUTABLE_SV(sv); \
1281 assert(SvTYPE(_bmrare) == SVt_PVGV); \
1282 assert(SvVALID(_bmrare)); \
1283 &(((XPVGV*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare); \
1285 # define BmUSEFUL(sv) \
1286 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1287 assert(SvTYPE(_bmuseful) == SVt_PVGV); \
1288 assert(SvVALID(_bmuseful)); \
1289 assert(!SvIOK(_bmuseful)); \
1290 &(((XPVGV*) SvANY(_bmuseful))->xiv_u.xivu_i32); \
1292 # define BmPREVIOUS(sv) \
1293 (*({ SV *const _bmprevious = MUTABLE_SV(sv); \
1294 assert(SvTYPE(_bmprevious) == SVt_PVGV); \
1295 assert(SvVALID(_bmprevious)); \
1296 &(((XPVGV*) SvANY(_bmprevious))->xnv_u.xbm_s.xbm_previous); \
1299 # define BmFLAGS(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_flags
1300 # define BmRARE(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1301 # define BmUSEFUL(sv) ((XPVGV*) SvANY(sv))->xiv_u.xivu_i32
1302 # define BmPREVIOUS(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_previous
1306 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xiv_u.xivu_iv
1308 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1309 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1310 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1311 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1313 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1314 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1315 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1316 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1317 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
1318 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1319 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1320 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1321 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1322 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1323 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1324 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1325 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1326 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1327 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1328 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1330 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1331 #define IoTYPE_RDONLY '<'
1332 #define IoTYPE_WRONLY '>'
1333 #define IoTYPE_RDWR '+'
1334 #define IoTYPE_APPEND 'a'
1335 #define IoTYPE_PIPE '|'
1336 #define IoTYPE_STD '-' /* stdin or stdout */
1337 #define IoTYPE_SOCKET 's'
1338 #define IoTYPE_CLOSED ' '
1339 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1340 #define IoTYPE_NUMERIC '#' /* fdopen */
1343 =for apidoc Am|bool|SvTAINTED|SV* sv
1344 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1347 =for apidoc Am|void|SvTAINTED_on|SV* sv
1348 Marks an SV as tainted if tainting is enabled.
1350 =for apidoc Am|void|SvTAINTED_off|SV* sv
1351 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1352 some of Perl's fundamental security features. XS module authors should not
1353 use this function unless they fully understand all the implications of
1354 unconditionally untainting the value. Untainting should be done in the
1355 standard perl fashion, via a carefully crafted regexp, rather than directly
1356 untainting variables.
1358 =for apidoc Am|void|SvTAINT|SV* sv
1359 Taints an SV if tainting is enabled.
1364 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1366 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1367 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1368 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1370 #define SvTAINT(sv) \
1372 if (PL_tainting) { \
1379 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1380 Like C<SvPV> but will force the SV into containing just a string
1381 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1384 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1385 Like C<SvPV> but will force the SV into containing just a string
1386 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1387 directly. Doesn't process magic.
1389 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1390 Returns a pointer to the string in the SV, or a stringified form of
1391 the SV if the SV does not contain a string. The SV may cache the
1392 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1393 C<SvPVx> for a version which guarantees to evaluate sv only once.
1395 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1396 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1397 Only use this if C<sv> is an expression with side effects, otherwise use the
1398 more efficient C<SvPVX>.
1400 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1401 Like C<SvPV> but doesn't process magic.
1403 =for apidoc Am|char*|SvPV_nolen|SV* sv
1404 Returns a pointer to the string in the SV, or a stringified form of
1405 the SV if the SV does not contain a string. The SV may cache the
1406 stringified form becoming C<SvPOK>. Handles 'get' magic.
1408 =for apidoc Am|IV|SvIV|SV* sv
1409 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1410 version which guarantees to evaluate sv only once.
1412 =for apidoc Am|IV|SvIV_nomg|SV* sv
1413 Like C<SvIV> but doesn't process magic.
1415 =for apidoc Am|IV|SvIVx|SV* sv
1416 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1417 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1418 otherwise use the more efficient C<SvIV>.
1420 =for apidoc Am|NV|SvNV|SV* sv
1421 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1422 which guarantees to evaluate sv only once.
1424 =for apidoc Am|NV|SvNVx|SV* sv
1425 Coerces the given SV to a double and returns it. Guarantees to evaluate
1426 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1427 otherwise use the more efficient C<SvNV>.
1429 =for apidoc Am|UV|SvUV|SV* sv
1430 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1431 for a version which guarantees to evaluate sv only once.
1433 =for apidoc Am|UV|SvUV_nomg|SV* sv
1434 Like C<SvUV> but doesn't process magic.
1436 =for apidoc Am|UV|SvUVx|SV* sv
1437 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1438 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1439 otherwise use the more efficient C<SvUV>.
1441 =for apidoc Am|bool|SvTRUE|SV* sv
1442 Returns a boolean indicating whether Perl would evaluate the SV as true or
1443 false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
1445 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1446 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1448 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1449 Like C<SvPV>, but converts sv to utf8 first if necessary.
1451 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1452 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1454 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1455 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1457 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1458 Like C<SvPV>, but converts sv to byte representation first if necessary.
1460 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1461 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1463 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1464 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1465 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1468 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1469 Like C<SvPV>, but converts sv to utf8 first if necessary.
1470 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1473 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1474 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1475 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1478 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1479 Like C<SvPV>, but converts sv to byte representation first if necessary.
1480 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1483 =for apidoc Am|bool|SvIsCOW|SV* sv
1484 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1485 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1488 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1489 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1492 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1493 Like C<sv_catpvn> but doesn't process magic.
1495 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1496 Like C<sv_setsv> but doesn't process magic.
1498 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1499 Like C<sv_catsv> but doesn't process magic.
1501 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1503 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
1508 /* Let us hope that bitmaps for UV and IV are the same */
1509 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1510 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1511 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1513 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1514 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1518 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1519 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1520 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1522 #define SvPV_flags(sv, lp, flags) \
1523 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1524 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1525 #define SvPV_flags_const(sv, lp, flags) \
1526 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1527 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1528 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1529 #define SvPV_flags_const_nolen(sv, flags) \
1530 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1531 ? SvPVX_const(sv) : \
1532 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1533 #define SvPV_flags_mutable(sv, lp, flags) \
1534 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1535 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1536 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1538 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1539 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1540 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1542 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1543 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1545 #define SvPV_force_flags(sv, lp, flags) \
1546 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1547 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1548 #define SvPV_force_flags_nolen(sv, flags) \
1549 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1550 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1551 #define SvPV_force_flags_mutable(sv, lp, flags) \
1552 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1553 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1554 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1556 #define SvPV_nolen(sv) \
1557 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1558 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1560 #define SvPV_nolen_const(sv) \
1561 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1562 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1564 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1565 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1566 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1570 #define SvPVutf8(sv, lp) \
1571 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1572 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1574 #define SvPVutf8_force(sv, lp) \
1575 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1576 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1579 #define SvPVutf8_nolen(sv) \
1580 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1581 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1585 #define SvPVbyte(sv, lp) \
1586 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1587 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1589 #define SvPVbyte_force(sv, lp) \
1590 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1591 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1593 #define SvPVbyte_nolen(sv) \
1594 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1595 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1599 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1600 * var to evaluate the arg once; failing that, use a global if possible;
1601 * failing that, call a function to do the work
1604 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1605 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1606 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1608 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1610 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1611 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1612 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1613 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1614 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1615 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1616 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1617 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1618 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1619 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1620 # define SvTRUE(sv) ( \
1624 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1626 (nxpv->xpv_cur > 1 || \
1627 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1634 ? SvNVX(sv) != 0.0 \
1636 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1638 #else /* __GNUC__ */
1640 /* These inlined macros use globals, which will require a thread
1641 * declaration in user code, so we avoid them under threads */
1643 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1644 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1645 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1646 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1647 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1648 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1649 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1650 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1651 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1652 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1653 # define SvTRUE(sv) ( \
1657 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1658 (PL_Xpv->xpv_cur > 1 || \
1659 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1666 ? SvNVX(sv) != 0.0 \
1668 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1669 #endif /* __GNU__ */
1671 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1672 (SVf_FAKE | SVf_READONLY))
1673 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1675 #define SvSHARED_HEK_FROM_PV(pvx) \
1676 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1677 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1679 /* flag values for sv_*_flags functions */
1680 #define SV_IMMEDIATE_UNREF 1
1682 #define SV_COW_DROP_PV 4
1683 #define SV_UTF8_NO_ENCODING 8
1684 #define SV_NOSTEAL 16
1685 #define SV_CONST_RETURN 32
1686 #define SV_MUTABLE_RETURN 64
1687 #define SV_SMAGIC 128
1688 #define SV_HAS_TRAILING_NUL 256
1689 #define SV_COW_SHARED_HASH_KEYS 512
1690 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1691 #define SV_COW_OTHER_PVS 1024
1692 /* Make sv_2pv_flags return NULL if something is undefined. */
1693 #define SV_UNDEF_RETURNS_NULL 2048
1694 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1695 * This is used when the caller has already determined it is, and avoids
1697 #define SV_FORCE_UTF8_UPGRADE 4096
1698 /* if (after resolving magic etc), the SV is found to be overloaded,
1699 * don't call the overload magic, just return as-is */
1700 #define SV_SKIP_OVERLOAD 8192
1702 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1703 So only default to doing the COW setup if we're in the core.
1706 # ifndef SV_DO_COW_SVSETSV
1707 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1711 #ifndef SV_DO_COW_SVSETSV
1712 # define SV_DO_COW_SVSETSV 0
1716 #define sv_unref(sv) sv_unref_flags(sv, 0)
1717 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1718 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1719 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1721 /* We are about to replace the SV's current value. So if it's copy on write
1722 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1723 the value is about to get thrown away, so drop the PV rather than go to
1724 the effort of making a read-write copy only for it to get immediately
1727 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1728 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1730 #ifdef PERL_OLD_COPY_ON_WRITE
1731 #define SvRELEASE_IVX(sv) \
1732 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1733 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1734 # define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
1736 # define SvRELEASE_IVX(sv) 0
1737 /* This little game brought to you by the need to shut this warning up:
1738 mg.c: In function `Perl_magic_get':
1739 mg.c:1024: warning: left-hand operand of comma expression has no effect
1741 # define SvRELEASE_IVX_(sv) /**/
1742 #endif /* PERL_OLD_COPY_ON_WRITE */
1744 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1745 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1746 SVf_OOK|SVf_BREAK|SVf_READONLY)
1747 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1749 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1750 sv_force_normal_flags(sv, 0)
1753 /* all these 'functions' are now just macros */
1755 #define sv_pv(sv) SvPV_nolen(sv)
1756 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1757 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1759 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1760 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1761 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1762 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1763 #define sv_setsv(dsv, ssv) \
1764 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1765 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1766 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1767 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1768 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1769 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1770 #define sv_catpvn_mg(sv, sstr, slen) \
1771 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1772 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1773 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1774 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1775 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1776 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1777 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1778 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1779 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1780 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1781 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1782 #define sv_insert(bigstr, offset, len, little, littlelen) \
1783 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1784 (littlelen), SV_GMAGIC)
1786 /* Should be named SvCatPVN_utf8_upgrade? */
1787 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1790 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
1792 sv_setpvn(nsv, sstr, slen); \
1794 sv_utf8_upgrade(nsv); \
1795 sv_catsv(dsv, nsv); \
1799 =for apidoc Am|SV*|newRV_inc|SV* sv
1801 Creates an RV wrapper for an SV. The reference count for the original SV is
1807 #define newRV_inc(sv) newRV(sv)
1809 /* the following macros update any magic values this sv is associated with */
1812 =head1 Magical Functions
1814 =for apidoc Am|void|SvGETMAGIC|SV* sv
1815 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1816 argument more than once.
1818 =for apidoc Am|void|SvSETMAGIC|SV* sv
1819 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1820 argument more than once.
1822 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1823 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1826 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1827 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1828 ssv. May evaluate arguments more than once.
1830 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1831 Like C<SvSetSV>, but does any set magic required afterwards.
1833 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1834 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1836 =for apidoc Am|void|SvSHARE|SV* sv
1837 Arranges for sv to be shared between threads if a suitable module
1840 =for apidoc Am|void|SvLOCK|SV* sv
1841 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1844 =for apidoc Am|void|SvUNLOCK|SV* sv
1845 Releases a mutual exclusion lock on sv if a suitable module
1848 =head1 SV Manipulation Functions
1850 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1851 Expands the character buffer in the SV so that it has room for the
1852 indicated number of bytes (remember to reserve space for an extra trailing
1853 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1854 Returns a pointer to the character buffer.
1859 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1860 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1861 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1862 #define SvDESTROYABLE(sv) CALL_FPTR(PL_destroyhook)(aTHX_ sv)
1864 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1865 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1867 #define SvSetSV_and(dst,src,finally) \
1869 if ((dst) != (src)) { \
1870 sv_setsv(dst, src); \
1874 #define SvSetSV_nosteal_and(dst,src,finally) \
1876 if ((dst) != (src)) { \
1877 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
1882 #define SvSetSV(dst,src) \
1883 SvSetSV_and(dst,src,/*nothing*/;)
1884 #define SvSetSV_nosteal(dst,src) \
1885 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1887 #define SvSetMagicSV(dst,src) \
1888 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1889 #define SvSetMagicSV_nosteal(dst,src) \
1890 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1893 #if !defined(SKIP_DEBUGGING)
1894 #define SvPEEK(sv) sv_peek(sv)
1896 #define SvPEEK(sv) ""
1899 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1901 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1903 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1904 /* If I give every macro argument a different name, then there won't be bugs
1905 where nested macros get confused. Been there, done that. */
1906 #define isGV_with_GP(pwadak) \
1907 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
1908 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
1909 #define isGV_with_GP_on(sv) STMT_START { \
1910 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1911 assert (!SvPOKp(sv)); \
1912 assert (!SvIOKp(sv)); \
1913 (SvFLAGS(sv) |= SVpgv_GP); \
1915 #define isGV_with_GP_off(sv) STMT_START { \
1916 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1917 assert (!SvPOKp(sv)); \
1918 assert (!SvIOKp(sv)); \
1919 (SvFLAGS(sv) &= ~SVpgv_GP); \
1923 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1924 #define SvGROW_mutable(sv,len) \
1925 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1926 #define Sv_Grow sv_grow
1928 #define CLONEf_COPY_STACKS 1
1929 #define CLONEf_KEEP_PTR_TABLE 2
1930 #define CLONEf_CLONE_HOST 4
1931 #define CLONEf_JOIN_IN 8
1933 struct clone_params {
1936 PerlInterpreter *proto_perl;
1940 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
1942 Creates a new SV and copies a string into it. If utf8 is true, calls
1943 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
1948 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
1951 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
1953 Reads into I<len> the offset from SvPVX back to the true start of the
1954 allocated buffer, which will be non-zero if C<sv_chop> has been used to
1955 efficiently remove characters from start of the buffer. Implemented as a
1956 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
1957 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
1963 /* Does the bot know something I don't?
1964 10:28 <@Nicholas> metabatman
1965 10:28 <+meta> Nicholas: crash
1967 # define SvOOK_offset(sv, offset) STMT_START { \
1968 assert(sizeof(offset) == sizeof(STRLEN)); \
1970 const U8 *crash = (U8*)SvPVX_const(sv); \
1971 offset = *--crash; \
1973 crash -= sizeof(STRLEN); \
1974 Copy(crash, (U8 *)&offset, sizeof(STRLEN), U8); \
1977 /* Validate the preceding buffer's sentinels to \
1978 verify that no-one is using it. */ \
1979 const U8 *const bonk = (U8 *) SvPVX_const(sv) - offset; \
1980 while (crash > bonk) { \
1982 assert (*crash == (U8)PTR2UV(crash)); \
1990 /* This is the same code, but avoids using any temporary variables: */
1991 # define SvOOK_offset(sv, offset) STMT_START { \
1992 assert(sizeof(offset) == sizeof(STRLEN)); \
1994 offset = ((U8*)SvPVX_const(sv))[-1]; \
1996 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
1997 (U8 *)&offset, sizeof(STRLEN), U8); \
2005 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2009 * c-indentation-style: bsd
2011 * indent-tabs-mode: t
2014 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob