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 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 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */
121 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */
122 PERL_BITFIELD32 sv_debug_cloned:1; /* was cloned for an ithread */
123 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */
124 U32 sv_debug_serial; /* serial number of sv allocation */
125 char * sv_debug_file; /* the file where we were allocated */
130 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
135 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
140 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
145 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
150 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
155 _SV_HEAD(struct regexp*); /* pointer to regexp body */
160 #undef _SV_HEAD_UNION /* ensure no pollution */
163 =head1 SV Manipulation Functions
165 =for apidoc Am|U32|SvREFCNT|SV* sv
166 Returns the value of the object's reference count.
168 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
169 Increments the reference count of the given SV.
171 All of the following SvREFCNT_inc* macros are optimized versions of
172 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
174 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
175 Same as SvREFCNT_inc, but can only be used if you know I<sv>
176 is not NULL. Since we don't have to check the NULLness, it's faster
179 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
180 Same as SvREFCNT_inc, but can only be used if you don't need the
181 return value. The macro doesn't need to return a meaningful value.
183 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
184 Same as SvREFCNT_inc, but can only be used if you don't need the return
185 value, and you know that I<sv> is not NULL. The macro doesn't need
186 to return a meaningful value, or check for NULLness, so it's smaller
189 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
190 Same as SvREFCNT_inc, but can only be used with expressions without side
191 effects. Since we don't have to store a temporary value, it's faster.
193 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
194 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
195 is not NULL. Since we don't have to check the NULLness, it's faster
198 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
199 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
200 return value. The macro doesn't need to return a meaningful value.
202 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
203 Same as SvREFCNT_inc, but can only be used if you don't need the return
204 value, and you know that I<sv> is not NULL. The macro doesn't need
205 to return a meaningful value, or check for NULLness, so it's smaller
208 =for apidoc Am|void|SvREFCNT_dec|SV* sv
209 Decrements the reference count of the given SV.
211 =for apidoc Am|svtype|SvTYPE|SV* sv
212 Returns the type of the SV. See C<svtype>.
214 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
215 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
216 perform the upgrade if necessary. See C<svtype>.
221 #define SvANY(sv) (sv)->sv_any
222 #define SvFLAGS(sv) (sv)->sv_flags
223 #define SvREFCNT(sv) (sv)->sv_refcnt
225 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
226 # define SvREFCNT_inc(sv) \
228 SV * const _sv = MUTABLE_SV(sv); \
233 # define SvREFCNT_inc_simple(sv) \
239 # define SvREFCNT_inc_NN(sv) \
241 SV * const _sv = MUTABLE_SV(sv); \
245 # define SvREFCNT_inc_void(sv) \
247 SV * const _sv = MUTABLE_SV(sv); \
249 (void)(SvREFCNT(_sv)++); \
252 # define SvREFCNT_inc(sv) \
253 ((PL_Sv=MUTABLE_SV(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
254 # define SvREFCNT_inc_simple(sv) \
255 ((sv) ? (SvREFCNT(sv)++,MUTABLE_SV(sv)) : NULL)
256 # define SvREFCNT_inc_NN(sv) \
257 (PL_Sv=MUTABLE_SV(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
258 # define SvREFCNT_inc_void(sv) \
259 (void)((PL_Sv=MUTABLE_SV(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
262 /* These guys don't need the curly blocks */
263 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
264 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
265 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
266 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
268 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
269 # define SvREFCNT_dec(sv) \
271 SV * const _sv = MUTABLE_SV(sv); \
273 if (SvREFCNT(_sv)) { \
274 if (--(SvREFCNT(_sv)) == 0) \
275 Perl_sv_free2(aTHX_ _sv); \
282 #define SvREFCNT_dec(sv) sv_free(MUTABLE_SV(sv))
285 #define SVTYPEMASK 0xff
286 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
288 /* Sadly there are some parts of the core that have pointers to already-freed
289 SV heads, and rely on being able to tell that they are now free. So mark
290 them all by using a consistent macro. */
291 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
293 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
295 #define SVf_IOK 0x00000100 /* has valid public integer value */
296 #define SVf_NOK 0x00000200 /* has valid public numeric value */
297 #define SVf_POK 0x00000400 /* has valid public pointer value */
298 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
300 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
301 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
302 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
303 #define SVp_SCREAM 0x00008000 /* has been studied? */
304 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
305 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
306 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
307 subroutine in another package. Set the
308 CvIMPORTED_CV_ON() if it needs to be
309 expanded to a real GV */
311 #define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
312 #define SVpad_STATE 0x00010000 /* pad name is a "state" var */
313 #define SVs_PADTMP 0x00020000 /* in use as tmp */
314 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
315 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
316 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
317 #define SVs_TEMP 0x00080000 /* string is stealable? */
318 #define SVs_OBJECT 0x00100000 /* is "blessed" */
319 #define SVs_GMG 0x00200000 /* has magical get method */
320 #define SVs_SMG 0x00400000 /* has magical set method */
321 #define SVs_RMG 0x00800000 /* has random magical methods */
323 #define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
324 1: SV head arena wasn't malloc()ed
325 2: in conjunction with SVf_READONLY
326 marks a shared hash key scalar
327 (SvLEN == 0) or a copy on write
328 string (SvLEN != 0) [SvIsCOW(sv)]
329 3: For PVCV, whether CvUNIQUE(cv)
330 refers to an eval or once only
331 [CvEVAL(cv), CvSPECIAL(cv)]
332 4: On a pad name SV, that slot in the
333 frame AV is a REFCNT'ed reference
334 to a lexical from "outside". */
335 #define SVphv_REHASH SVf_FAKE /* 5: On a PVHV, hash values are being
337 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
338 means that a hv_aux struct is present
339 after the main array */
340 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
341 SVs in final arena cleanup.
342 Set in S_regtry on PL_reg_curpm, so that
343 perl_destruct will skip it. */
344 #define SVf_READONLY 0x08000000 /* may not be modified */
349 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
351 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
352 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
354 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
356 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
358 /* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
359 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
360 This is also set on RVs whose overloaded
361 stringification is UTF-8. This might
362 only happen as a side effect of SvPV() */
365 /* Some private flags. */
367 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
368 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
369 been restructured, so sometimes get used as string buffers. */
372 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
373 /* PVNV, PVMG, presumably only inside pads */
374 #define SVpad_NAME 0x40000000 /* This SV is a name in the PAD, so
375 SVpad_TYPED, SVpad_OUR and SVpad_STATE
378 #define SVpav_REAL 0x40000000 /* free old entries */
380 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
381 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
382 on any regular scalar (anything <= PVLV) */
383 #define SVpbm_VALID 0x40000000
385 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
387 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
388 /* Presumably IVs aren't stored in pads */
389 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
391 #define SVpav_REIFY 0x80000000 /* can become real */
393 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
395 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
396 /* PVGV when SVpbm_VALID is true */
397 #define SVpbm_TAIL 0x80000000
398 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
399 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
403 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
404 STRLEN xpv_len /* allocated size */
407 NV xnv_nv; /* numeric value, if any */
412 } xpad_cop_seq; /* used by pad.c for cop_sequence */
414 U32 xbm_previous; /* how many characters in string before rare? */
416 U8 xbm_rare; /* rarest character in string */
417 } xbm_s; /* fields from PVBM */
421 IV xivu_iv; /* integer value */
426 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
427 HV * xivu_hv; /* regexp: paren_names */
431 MAGIC* xmg_magic; /* linked list of magicalness */
432 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
444 #define xiv_iv xiv_u.xivu_iv
451 #define xuv_uv xuv_u.xivu_uv
458 #define _XPVMG_HEAD \
461 HV* xmg_stash /* class package */
463 /* This structure must match the beginning of struct xpvhv in hv.h. */
476 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
477 * y=alem/helem/iter t=tie T=tied HE */
480 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
487 /* This structure must match XPVCV in cv.h */
489 typedef U16 cv_flags_t;
491 #define _XPVCV_COMMON \
499 void (*xcv_xsub) (pTHX_ CV*); \
505 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
506 * compilation) in the lexically enclosing \
516 #define _XPVIO_TAIL \
517 PerlIO * xio_ifp; /* ifp and ofp are normally the same */ \
518 PerlIO * xio_ofp; /* but sockets need separate streams */ \
519 /* Cray addresses everything by word boundaries (64 bits) and \
520 * code and data pointers cannot be mixed (which is exactly what \
521 * Perl_filter_add() tries to do with the dirp), hence the \
522 * following union trick (as suggested by Gurusamy Sarathy). \
523 * For further information see Geir Johansen's problem report \
524 * titled [ID 20000612.002] Perl problem on Cray system \
525 * The any pointer (known as IoANY()) will also be a good place \
526 * to hang any IO disciplines to. \
529 DIR * xiou_dirp; /* for opendir, readdir, etc */ \
530 void * xiou_any; /* for alignment */ \
532 IV xio_lines; /* $. */ \
533 IV xio_page; /* $% */ \
534 IV xio_page_len; /* $= */ \
535 IV xio_lines_left; /* $- */ \
536 char * xio_top_name; /* $^ */ \
537 GV * xio_top_gv; /* $^ */ \
538 char * xio_fmt_name; /* $~ */ \
539 GV * xio_fmt_gv; /* $~ */ \
540 char * xio_bottom_name;/* $^B */ \
541 GV * xio_bottom_gv; /* $^B */ \
552 #define xio_dirp xio_dirpu.xiou_dirp
553 #define xio_any xio_dirpu.xiou_any
555 #define IOf_ARGV 1 /* this fp iterates over ARGV */
556 #define IOf_START 2 /* check for null ARGV and substitute '-' */
557 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
558 #define IOf_DIDTOP 8 /* just did top of form */
559 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
560 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
561 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
563 /* The following macros define implementation-independent predicates on SVs. */
566 =for apidoc Am|U32|SvNIOK|SV* sv
567 Returns a U32 value indicating whether the SV contains a number, integer or
570 =for apidoc Am|U32|SvNIOKp|SV* sv
571 Returns a U32 value indicating whether the SV contains a number, integer or
572 double. Checks the B<private> setting. Use C<SvNIOK> instead.
574 =for apidoc Am|void|SvNIOK_off|SV* sv
575 Unsets the NV/IV status of an SV.
577 =for apidoc Am|U32|SvOK|SV* sv
578 Returns a U32 value indicating whether the value is defined. This is
579 only meaningful for scalars.
581 =for apidoc Am|U32|SvIOKp|SV* sv
582 Returns a U32 value indicating whether the SV contains an integer. Checks
583 the B<private> setting. Use C<SvIOK> instead.
585 =for apidoc Am|U32|SvNOKp|SV* sv
586 Returns a U32 value indicating whether the SV contains a double. Checks the
587 B<private> setting. Use C<SvNOK> instead.
589 =for apidoc Am|U32|SvPOKp|SV* sv
590 Returns a U32 value indicating whether the SV contains a character string.
591 Checks the B<private> setting. Use C<SvPOK> instead.
593 =for apidoc Am|U32|SvIOK|SV* sv
594 Returns a U32 value indicating whether the SV contains an integer.
596 =for apidoc Am|void|SvIOK_on|SV* sv
597 Tells an SV that it is an integer.
599 =for apidoc Am|void|SvIOK_off|SV* sv
600 Unsets the IV status of an SV.
602 =for apidoc Am|void|SvIOK_only|SV* sv
603 Tells an SV that it is an integer and disables all other OK bits.
605 =for apidoc Am|void|SvIOK_only_UV|SV* sv
606 Tells and SV that it is an unsigned integer and disables all other OK bits.
608 =for apidoc Am|bool|SvIOK_UV|SV* sv
609 Returns a boolean indicating whether the SV contains an unsigned integer.
611 =for apidoc Am|bool|SvUOK|SV* sv
612 Returns a boolean indicating whether the SV contains an unsigned integer.
614 =for apidoc Am|bool|SvIOK_notUV|SV* sv
615 Returns a boolean indicating whether the SV contains a signed integer.
617 =for apidoc Am|U32|SvNOK|SV* sv
618 Returns a U32 value indicating whether the SV contains a double.
620 =for apidoc Am|void|SvNOK_on|SV* sv
621 Tells an SV that it is a double.
623 =for apidoc Am|void|SvNOK_off|SV* sv
624 Unsets the NV status of an SV.
626 =for apidoc Am|void|SvNOK_only|SV* sv
627 Tells an SV that it is a double and disables all other OK bits.
629 =for apidoc Am|U32|SvPOK|SV* sv
630 Returns a U32 value indicating whether the SV contains a character
633 =for apidoc Am|void|SvPOK_on|SV* sv
634 Tells an SV that it is a string.
636 =for apidoc Am|void|SvPOK_off|SV* sv
637 Unsets the PV status of an SV.
639 =for apidoc Am|void|SvPOK_only|SV* sv
640 Tells an SV that it is a string and disables all other OK bits.
641 Will also turn off the UTF-8 status.
643 =for apidoc Am|bool|SvVOK|SV* sv
644 Returns a boolean indicating whether the SV contains a v-string.
646 =for apidoc Am|U32|SvOOK|SV* sv
647 Returns a U32 indicating whether the pointer to the string buffer is offset.
648 This hack is used internally to speed up removal of characters from the
649 beginning of a SvPV. When SvOOK is true, then the start of the
650 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
651 This offset used to be stored in SvIVX, but is now stored within the spare
654 =for apidoc Am|U32|SvROK|SV* sv
655 Tests if the SV is an RV.
657 =for apidoc Am|void|SvROK_on|SV* sv
658 Tells an SV that it is an RV.
660 =for apidoc Am|void|SvROK_off|SV* sv
661 Unsets the RV status of an SV.
663 =for apidoc Am|SV*|SvRV|SV* sv
664 Dereferences an RV to return the SV.
666 =for apidoc Am|IV|SvIVX|SV* sv
667 Returns the raw value in the SV's IV slot, without checks or conversions.
668 Only use when you are sure SvIOK is true. See also C<SvIV()>.
670 =for apidoc Am|UV|SvUVX|SV* sv
671 Returns the raw value in the SV's UV slot, without checks or conversions.
672 Only use when you are sure SvIOK is true. See also C<SvUV()>.
674 =for apidoc Am|NV|SvNVX|SV* sv
675 Returns the raw value in the SV's NV slot, without checks or conversions.
676 Only use when you are sure SvNOK is true. See also C<SvNV()>.
678 =for apidoc Am|char*|SvPVX|SV* sv
679 Returns a pointer to the physical string in the SV. The SV must contain a
682 =for apidoc Am|STRLEN|SvCUR|SV* sv
683 Returns the length of the string which is in the SV. See C<SvLEN>.
685 =for apidoc Am|STRLEN|SvLEN|SV* sv
686 Returns the size of the string buffer in the SV, not including any part
687 attributable to C<SvOOK>. See C<SvCUR>.
689 =for apidoc Am|char*|SvEND|SV* sv
690 Returns a pointer to the last character in the string which is in the SV.
691 See C<SvCUR>. Access the character as *(SvEND(sv)).
693 =for apidoc Am|HV*|SvSTASH|SV* sv
694 Returns the stash of the SV.
696 =for apidoc Am|void|SvIV_set|SV* sv|IV val
697 Set the value of the IV pointer in sv to val. It is possible to perform
698 the same function of this macro with an lvalue assignment to C<SvIVX>.
699 With future Perls, however, it will be more efficient to use
700 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
702 =for apidoc Am|void|SvNV_set|SV* sv|NV val
703 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
705 =for apidoc Am|void|SvPV_set|SV* sv|char* val
706 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
708 =for apidoc Am|void|SvUV_set|SV* sv|UV val
709 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
711 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
712 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
714 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
715 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
717 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
718 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
720 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
721 Set the current length of the string which is in the SV. See C<SvCUR>
724 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
725 Set the actual length of the string which is in the SV. See C<SvIV_set>.
730 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
731 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
732 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
733 SVp_IOK|SVp_NOK|SVf_IVisUV))
735 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
736 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
737 #define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
739 #define assert_not_ROK(sv)
740 #define assert_not_glob(sv)
743 #define SvOK(sv) ((SvTYPE(sv) == SVt_BIND) \
744 ? (SvFLAGS(SvRV(sv)) & SVf_OK) \
745 : (SvFLAGS(sv) & SVf_OK))
746 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
747 SvFLAGS(sv) &= ~(SVf_OK| \
748 SVf_IVisUV|SVf_UTF8), \
750 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
751 SvFLAGS(sv) &= ~(SVf_OK| \
755 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
756 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
757 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
758 SvFLAGS(sv) |= SVp_IOK)
759 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
760 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
761 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
762 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
763 SvFLAGS(sv) |= SVp_POK)
765 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
766 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
767 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
768 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
769 #define SvIOK_only(sv) (SvOK_off(sv), \
770 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
771 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
772 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
774 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
775 == (SVf_IOK|SVf_IVisUV))
776 #define SvUOK(sv) SvIOK_UV(sv)
777 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
780 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
781 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
782 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
784 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
785 #define SvNOK_on(sv) (assert_not_glob(sv) \
786 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
787 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
788 #define SvNOK_only(sv) (SvOK_off(sv), \
789 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
792 =for apidoc Am|U32|SvUTF8|SV* sv
793 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
794 Call this after SvPV() in case any call to string overloading updates the
797 =for apidoc Am|void|SvUTF8_on|SV *sv
798 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
799 Do not use frivolously.
801 =for apidoc Am|void|SvUTF8_off|SV *sv
802 Unsets the UTF-8 status of an SV.
804 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
805 Tells an SV that it is a string and disables all other OK bits,
806 and leaves the UTF-8 status as it was.
811 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
813 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
814 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
815 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
817 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
818 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
819 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
820 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
821 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
822 SvFLAGS(sv) &= ~(SVf_OK| \
823 SVf_IVisUV|SVf_UTF8), \
824 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
825 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
826 SvFLAGS(sv) &= ~(SVf_OK| \
828 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
830 #define SvVOK(sv) (SvMAGICAL(sv) \
831 && mg_find(sv,PERL_MAGIC_vstring))
832 /* returns the vstring magic, if any */
833 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
834 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
836 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
837 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
838 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
840 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
841 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
842 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
844 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
845 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
846 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
848 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
849 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
850 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
852 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
853 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
854 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
856 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
857 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
858 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
860 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
861 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
862 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
864 #define SvAMAGIC(sv) (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
865 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
866 # define SvAMAGIC_on(sv) ({ SV * const kloink = sv; \
867 assert(SvROK(kloink)); \
868 SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
870 # define SvAMAGIC_off(sv) ({ SV * const kloink = sv; \
872 SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
875 # define SvAMAGIC_on(sv) (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
876 # define SvAMAGIC_off(sv) \
877 (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
881 =for apidoc Am|U32|SvGAMAGIC|SV* sv
883 Returns true if the SV has get magic or overloading. If either is true then
884 the scalar is active data, and has the potential to return a new value every
885 time it is accessed. Hence you must be careful to only read it once per user
886 logical operation and work with that returned value. If neither is true then
887 the scalar's value cannot change unless written to.
892 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
894 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash, FALSE))
896 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
897 == (SVf_ROK|SVprv_WEAKREF))
898 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
899 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
901 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
902 == (SVf_ROK|SVprv_PCS_IMPORTED))
903 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
904 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
906 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
908 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
909 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
910 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
912 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
913 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
914 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
916 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
917 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
919 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
920 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
921 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
923 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
924 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
925 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
927 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
928 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
929 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
931 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
932 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
933 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
935 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
936 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
937 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
939 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
940 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
941 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
943 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
944 # define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
945 if (SvFLAGS(_svvalid) & SVpbm_VALID) \
946 assert(!isGV_with_GP(_svvalid)); \
947 (SvFLAGS(_svvalid) & SVpbm_VALID); \
949 # define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
950 assert(!isGV_with_GP(_svvalid)); \
951 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
953 # define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
954 assert(!isGV_with_GP(_svvalid)); \
955 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
958 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
959 assert(SvTYPE(_svtail) != SVt_PVAV); \
960 assert(SvTYPE(_svtail) != SVt_PVHV); \
961 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
962 == (SVpbm_TAIL|SVpbm_VALID); \
965 # define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
966 # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
967 # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
968 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
969 == (SVpbm_TAIL|SVpbm_VALID))
972 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
973 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
976 #define SvPAD_TYPED(sv) \
977 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
979 #define SvPAD_OUR(sv) \
980 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
982 #define SvPAD_STATE(sv) \
983 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
985 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
986 # define SvPAD_TYPED_on(sv) ({ \
987 SV *const _svpad = MUTABLE_SV(sv); \
988 assert(SvTYPE(_svpad) == SVt_PVMG); \
989 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \
991 #define SvPAD_OUR_on(sv) ({ \
992 SV *const _svpad = MUTABLE_SV(sv); \
993 assert(SvTYPE(_svpad) == SVt_PVMG); \
994 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \
996 #define SvPAD_STATE_on(sv) ({ \
997 SV *const _svpad = MUTABLE_SV(sv); \
998 assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
999 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \
1002 # define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1003 # define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1004 # define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1007 #define SvOURSTASH(sv) \
1008 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1009 #define SvOURSTASH_set(sv, st) \
1011 assert(SvTYPE(sv) == SVt_PVMG); \
1012 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1015 #ifdef PERL_DEBUG_COW
1018 #define SvRVx(sv) SvRV(sv)
1020 #ifdef PERL_DEBUG_COW
1021 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1022 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1023 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1024 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1025 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1026 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1027 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1028 /* Don't test the core XS code yet. */
1029 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1030 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1032 # define SvPVX(sv) SvPVX_mutable(sv)
1034 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1035 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1036 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1039 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1040 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
1042 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1043 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
1046 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1047 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1049 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1050 /* These get expanded inside other macros that already use a variable _sv */
1051 # define SvPVX(sv) \
1052 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1053 assert(SvTYPE(_svpvx) >= SVt_PV); \
1054 assert(SvTYPE(_svpvx) != SVt_PVAV); \
1055 assert(SvTYPE(_svpvx) != SVt_PVHV); \
1056 assert(!isGV_with_GP(_svpvx)); \
1057 &((_svpvx)->sv_u.svu_pv); \
1059 # define SvCUR(sv) \
1060 (*({ const SV *const _svcur = (const SV *)(sv); \
1061 assert(SvTYPE(_svcur) >= SVt_PV); \
1062 assert(SvTYPE(_svcur) != SVt_PVAV); \
1063 assert(SvTYPE(_svcur) != SVt_PVHV); \
1064 assert(!isGV_with_GP(_svcur)); \
1065 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1067 # define SvIVX(sv) \
1068 (*({ const SV *const _svivx = (const SV *)(sv); \
1069 assert(SvTYPE(_svivx) == SVt_IV || SvTYPE(_svivx) >= SVt_PVIV); \
1070 assert(SvTYPE(_svivx) != SVt_PVAV); \
1071 assert(SvTYPE(_svivx) != SVt_PVHV); \
1072 assert(SvTYPE(_svivx) != SVt_PVCV); \
1073 assert(SvTYPE(_svivx) != SVt_PVFM); \
1074 assert(!isGV_with_GP(_svivx)); \
1075 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1077 # define SvUVX(sv) \
1078 (*({ const SV *const _svuvx = (const SV *)(sv); \
1079 assert(SvTYPE(_svuvx) == SVt_IV || SvTYPE(_svuvx) >= SVt_PVIV); \
1080 assert(SvTYPE(_svuvx) != SVt_PVAV); \
1081 assert(SvTYPE(_svuvx) != SVt_PVHV); \
1082 assert(SvTYPE(_svuvx) != SVt_PVCV); \
1083 assert(SvTYPE(_svuvx) != SVt_PVFM); \
1084 assert(!isGV_with_GP(_svuvx)); \
1085 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1087 # define SvNVX(sv) \
1088 (*({ const SV *const _svnvx = (const SV *)(sv); \
1089 assert(SvTYPE(_svnvx) == SVt_NV || SvTYPE(_svnvx) >= SVt_PVNV); \
1090 assert(SvTYPE(_svnvx) != SVt_PVAV); \
1091 assert(SvTYPE(_svnvx) != SVt_PVHV); \
1092 assert(SvTYPE(_svnvx) != SVt_PVCV); \
1093 assert(SvTYPE(_svnvx) != SVt_PVFM); \
1094 assert(SvTYPE(_svnvx) != SVt_PVIO); \
1095 assert(!isGV_with_GP(_svnvx)); \
1096 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1099 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1100 assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1101 assert(SvTYPE(_svrv) != SVt_PVAV); \
1102 assert(SvTYPE(_svrv) != SVt_PVHV); \
1103 assert(SvTYPE(_svrv) != SVt_PVCV); \
1104 assert(SvTYPE(_svrv) != SVt_PVFM); \
1105 assert(!isGV_with_GP(_svrv)); \
1106 &((_svrv)->sv_u.svu_rv); \
1108 # define SvRV_const(sv) \
1109 ({ const SV *const _svrv = (const SV *)(sv); \
1110 assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1111 assert(SvTYPE(_svrv) != SVt_PVAV); \
1112 assert(SvTYPE(_svrv) != SVt_PVHV); \
1113 assert(SvTYPE(_svrv) != SVt_PVCV); \
1114 assert(SvTYPE(_svrv) != SVt_PVFM); \
1115 assert(!isGV_with_GP(_svrv)); \
1116 (_svrv)->sv_u.svu_rv; \
1118 # define SvMAGIC(sv) \
1119 (*({ const SV *const _svmagic = (const SV *)(sv); \
1120 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1121 if(SvTYPE(_svmagic) == SVt_PVMG) \
1122 assert(!SvPAD_OUR(_svmagic)); \
1123 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1125 # define SvSTASH(sv) \
1126 (*({ const SV *const _svstash = (const SV *)(sv); \
1127 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1128 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1131 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1132 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1133 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1134 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1135 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1136 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1137 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1138 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1139 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1144 /* Given that these two are new, there can't be any existing code using them
1146 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1147 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1149 /* Except for the poison code, which uses & to scribble over the pointer after
1150 free() is called. */
1151 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1152 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1155 #define SvIVXx(sv) SvIVX(sv)
1156 #define SvUVXx(sv) SvUVX(sv)
1157 #define SvNVXx(sv) SvNVX(sv)
1158 #define SvPVXx(sv) SvPVX(sv)
1159 #define SvLENx(sv) SvLEN(sv)
1160 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1163 /* Ask a scalar nicely to try to become an IV, if possible.
1164 Not guaranteed to stay returning void */
1165 /* Macro won't actually call sv_2iv if already IOK */
1166 #define SvIV_please(sv) \
1167 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1168 (void) SvIV(sv); } STMT_END
1169 #define SvIV_set(sv, val) \
1170 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1171 assert(SvTYPE(sv) != SVt_PVAV); \
1172 assert(SvTYPE(sv) != SVt_PVHV); \
1173 assert(SvTYPE(sv) != SVt_PVCV); \
1174 assert(!isGV_with_GP(sv)); \
1175 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1176 #define SvNV_set(sv, val) \
1177 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1178 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1179 assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1180 assert(SvTYPE(sv) != SVt_PVIO); \
1181 assert(!isGV_with_GP(sv)); \
1182 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1183 #define SvPV_set(sv, val) \
1184 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1185 assert(SvTYPE(sv) != SVt_PVAV); \
1186 assert(SvTYPE(sv) != SVt_PVHV); \
1187 assert(!isGV_with_GP(sv)); \
1188 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1189 #define SvUV_set(sv, val) \
1190 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1191 assert(SvTYPE(sv) != SVt_PVAV); \
1192 assert(SvTYPE(sv) != SVt_PVHV); \
1193 assert(SvTYPE(sv) != SVt_PVCV); \
1194 assert(!isGV_with_GP(sv)); \
1195 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1196 #define SvRV_set(sv, val) \
1197 STMT_START { assert(SvTYPE(sv) >= SVt_PV || SvTYPE(sv) == SVt_IV); \
1198 assert(SvTYPE(sv) != SVt_PVAV); \
1199 assert(SvTYPE(sv) != SVt_PVHV); \
1200 assert(SvTYPE(sv) != SVt_PVCV); \
1201 assert(SvTYPE(sv) != SVt_PVFM); \
1202 assert(!isGV_with_GP(sv)); \
1203 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1204 #define SvMAGIC_set(sv, val) \
1205 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1206 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1207 #define SvSTASH_set(sv, val) \
1208 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1209 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1210 #define SvCUR_set(sv, val) \
1211 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1212 assert(SvTYPE(sv) != SVt_PVAV); \
1213 assert(SvTYPE(sv) != SVt_PVHV); \
1214 assert(!isGV_with_GP(sv)); \
1215 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1216 #define SvLEN_set(sv, val) \
1217 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1218 assert(SvTYPE(sv) != SVt_PVAV); \
1219 assert(SvTYPE(sv) != SVt_PVHV); \
1220 assert(!isGV_with_GP(sv)); \
1221 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1222 #define SvEND_set(sv, val) \
1223 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1224 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1226 #define SvPV_renew(sv,n) \
1227 STMT_START { SvLEN_set(sv, n); \
1228 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1229 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1230 (MEM_SIZE)((n))))); \
1233 #define SvPV_shrink_to_cur(sv) STMT_START { \
1234 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1235 SvPV_renew(sv, _lEnGtH); \
1238 #define SvPV_free(sv) \
1240 assert(SvTYPE(sv) >= SVt_PV); \
1242 assert(!SvROK(sv)); \
1245 SvOOK_offset(sv, zok); \
1246 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1247 SvFLAGS(sv) &= ~SVf_OOK; \
1249 Safefree(SvPVX(sv)); \
1254 /* Code that crops up in three places to take a scalar and ready it to hold
1256 # define prepare_SV_for_RV(sv) \
1258 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1259 sv_upgrade(sv, SVt_IV); \
1260 else if (SvTYPE(sv) >= SVt_PV) { \
1268 #define PERL_FBM_TABLE_OFFSET 1 /* Number of bytes between EOS and table */
1270 /* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1273 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1274 # define BmFLAGS(sv) \
1275 (*({ SV *const _bmflags = MUTABLE_SV(sv); \
1276 assert(SvTYPE(_bmflags) == SVt_PVGV); \
1277 assert(SvVALID(_bmflags)); \
1278 &(((XPVGV*) SvANY(_bmflags))->xnv_u.xbm_s.xbm_flags); \
1280 # define BmRARE(sv) \
1281 (*({ SV *const _bmrare = MUTABLE_SV(sv); \
1282 assert(SvTYPE(_bmrare) == SVt_PVGV); \
1283 assert(SvVALID(_bmrare)); \
1284 &(((XPVGV*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare); \
1286 # define BmUSEFUL(sv) \
1287 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1288 assert(SvTYPE(_bmuseful) == SVt_PVGV); \
1289 assert(SvVALID(_bmuseful)); \
1290 assert(!SvIOK(_bmuseful)); \
1291 &(((XPVGV*) SvANY(_bmuseful))->xiv_u.xivu_i32); \
1293 # define BmPREVIOUS(sv) \
1294 (*({ SV *const _bmprevious = MUTABLE_SV(sv); \
1295 assert(SvTYPE(_bmprevious) == SVt_PVGV); \
1296 assert(SvVALID(_bmprevious)); \
1297 &(((XPVGV*) SvANY(_bmprevious))->xnv_u.xbm_s.xbm_previous); \
1300 # define BmFLAGS(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_flags
1301 # define BmRARE(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1302 # define BmUSEFUL(sv) ((XPVGV*) SvANY(sv))->xiv_u.xivu_i32
1303 # define BmPREVIOUS(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_previous
1307 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xiv_u.xivu_iv
1309 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1310 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1311 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1312 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1314 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1315 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1316 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1317 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1318 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1319 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1320 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1321 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1322 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1323 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1324 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1325 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1326 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1327 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1328 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1329 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1331 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1332 #define IoTYPE_RDONLY '<'
1333 #define IoTYPE_WRONLY '>'
1334 #define IoTYPE_RDWR '+'
1335 #define IoTYPE_APPEND 'a'
1336 #define IoTYPE_PIPE '|'
1337 #define IoTYPE_STD '-' /* stdin or stdout */
1338 #define IoTYPE_SOCKET 's'
1339 #define IoTYPE_CLOSED ' '
1340 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1341 #define IoTYPE_NUMERIC '#' /* fdopen */
1344 =for apidoc Am|bool|SvTAINTED|SV* sv
1345 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1348 =for apidoc Am|void|SvTAINTED_on|SV* sv
1349 Marks an SV as tainted if tainting is enabled.
1351 =for apidoc Am|void|SvTAINTED_off|SV* sv
1352 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1353 some of Perl's fundamental security features. XS module authors should not
1354 use this function unless they fully understand all the implications of
1355 unconditionally untainting the value. Untainting should be done in the
1356 standard perl fashion, via a carefully crafted regexp, rather than directly
1357 untainting variables.
1359 =for apidoc Am|void|SvTAINT|SV* sv
1360 Taints an SV if tainting is enabled.
1365 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1367 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1368 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1369 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1371 #define SvTAINT(sv) \
1373 if (PL_tainting) { \
1380 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1381 Like C<SvPV> but will force the SV into containing just a string
1382 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1385 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1386 Like C<SvPV> but will force the SV into containing just a string
1387 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1388 directly. Doesn't process magic.
1390 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1391 Returns a pointer to the string in the SV, or a stringified form of
1392 the SV if the SV does not contain a string. The SV may cache the
1393 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1394 C<SvPVx> for a version which guarantees to evaluate sv only once.
1396 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1397 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1398 Only use this if C<sv> is an expression with side effects, otherwise use the
1399 more efficient C<SvPVX>.
1401 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1402 Like C<SvPV> but doesn't process magic.
1404 =for apidoc Am|char*|SvPV_nolen|SV* sv
1405 Returns a pointer to the string in the SV, or a stringified form of
1406 the SV if the SV does not contain a string. The SV may cache the
1407 stringified form becoming C<SvPOK>. Handles 'get' magic.
1409 =for apidoc Am|IV|SvIV|SV* sv
1410 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1411 version which guarantees to evaluate sv only once.
1413 =for apidoc Am|IV|SvIV_nomg|SV* sv
1414 Like C<SvIV> but doesn't process magic.
1416 =for apidoc Am|IV|SvIVx|SV* sv
1417 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1418 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1419 otherwise use the more efficient C<SvIV>.
1421 =for apidoc Am|NV|SvNV|SV* sv
1422 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1423 which guarantees to evaluate sv only once.
1425 =for apidoc Am|NV|SvNVx|SV* sv
1426 Coerces the given SV to a double and returns it. Guarantees to evaluate
1427 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1428 otherwise use the more efficient C<SvNV>.
1430 =for apidoc Am|UV|SvUV|SV* sv
1431 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1432 for a version which guarantees to evaluate sv only once.
1434 =for apidoc Am|UV|SvUV_nomg|SV* sv
1435 Like C<SvUV> but doesn't process magic.
1437 =for apidoc Am|UV|SvUVx|SV* sv
1438 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1439 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1440 otherwise use the more efficient C<SvUV>.
1442 =for apidoc Am|bool|SvTRUE|SV* sv
1443 Returns a boolean indicating whether Perl would evaluate the SV as true or
1444 false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
1446 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1447 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1449 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1450 Like C<SvPV>, but converts sv to utf8 first if necessary.
1452 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1453 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1455 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1456 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1458 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1459 Like C<SvPV>, but converts sv to byte representation first if necessary.
1461 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1462 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1464 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1465 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1466 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1469 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1470 Like C<SvPV>, but converts sv to utf8 first if necessary.
1471 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1474 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1475 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1476 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1479 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1480 Like C<SvPV>, but converts sv to byte representation first if necessary.
1481 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1484 =for apidoc Am|bool|SvIsCOW|SV* sv
1485 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1486 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1489 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1490 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1493 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1494 Like C<sv_catpvn> but doesn't process magic.
1496 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1497 Like C<sv_setsv> but doesn't process magic.
1499 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1500 Like C<sv_catsv> but doesn't process magic.
1502 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1504 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
1509 /* Let us hope that bitmaps for UV and IV are the same */
1510 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1511 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1512 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1514 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1515 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1519 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1520 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1521 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1523 #define SvPV_flags(sv, lp, flags) \
1524 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1525 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1526 #define SvPV_flags_const(sv, lp, flags) \
1527 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1528 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1529 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1530 #define SvPV_flags_const_nolen(sv, flags) \
1531 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1532 ? SvPVX_const(sv) : \
1533 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1534 #define SvPV_flags_mutable(sv, lp, flags) \
1535 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1536 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1537 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1539 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1540 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1541 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1543 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1544 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1546 #define SvPV_force_flags(sv, lp, flags) \
1547 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1548 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1549 #define SvPV_force_flags_nolen(sv, flags) \
1550 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1551 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1552 #define SvPV_force_flags_mutable(sv, lp, flags) \
1553 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1554 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1555 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1557 #define SvPV_nolen(sv) \
1558 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1559 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1561 #define SvPV_nolen_const(sv) \
1562 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1563 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1565 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1566 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1567 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1571 #define SvPVutf8(sv, lp) \
1572 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1573 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1575 #define SvPVutf8_force(sv, lp) \
1576 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1577 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1580 #define SvPVutf8_nolen(sv) \
1581 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1582 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1586 #define SvPVbyte(sv, lp) \
1587 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1588 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1590 #define SvPVbyte_force(sv, lp) \
1591 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1592 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1594 #define SvPVbyte_nolen(sv) \
1595 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1596 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1600 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1601 * var to evaluate the arg once; failing that, use a global if possible;
1602 * failing that, call a function to do the work
1605 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1606 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1607 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1609 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1611 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1612 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1613 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1614 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1615 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1616 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1617 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1618 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1619 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1620 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1621 # define SvTRUE(sv) ( \
1625 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1627 (nxpv->xpv_cur > 1 || \
1628 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1635 ? SvNVX(sv) != 0.0 \
1637 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1639 #else /* __GNUC__ */
1641 /* These inlined macros use globals, which will require a thread
1642 * declaration in user code, so we avoid them under threads */
1644 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1645 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1646 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1647 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1648 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1649 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1650 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1651 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1652 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1653 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1654 # define SvTRUE(sv) ( \
1658 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1659 (PL_Xpv->xpv_cur > 1 || \
1660 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1667 ? SvNVX(sv) != 0.0 \
1669 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1670 #endif /* __GNU__ */
1672 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1673 (SVf_FAKE | SVf_READONLY))
1674 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1676 #define SvSHARED_HEK_FROM_PV(pvx) \
1677 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1678 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1680 /* flag values for sv_*_flags functions */
1681 #define SV_IMMEDIATE_UNREF 1
1683 #define SV_COW_DROP_PV 4
1684 #define SV_UTF8_NO_ENCODING 8
1685 #define SV_NOSTEAL 16
1686 #define SV_CONST_RETURN 32
1687 #define SV_MUTABLE_RETURN 64
1688 #define SV_SMAGIC 128
1689 #define SV_HAS_TRAILING_NUL 256
1690 #define SV_COW_SHARED_HASH_KEYS 512
1691 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1692 #define SV_COW_OTHER_PVS 1024
1693 /* Make sv_2pv_flags return NULL if something is undefined. */
1694 #define SV_UNDEF_RETURNS_NULL 2048
1695 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1696 * This is used when the caller has already determined it is, and avoids
1698 #define SV_FORCE_UTF8_UPGRADE 4096
1700 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1701 So only default to doing the COW setup if we're in the core.
1704 # ifndef SV_DO_COW_SVSETSV
1705 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1709 #ifndef SV_DO_COW_SVSETSV
1710 # define SV_DO_COW_SVSETSV 0
1714 #define sv_unref(sv) sv_unref_flags(sv, 0)
1715 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1716 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1717 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1719 /* We are about to replace the SV's current value. So if it's copy on write
1720 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1721 the value is about to get thrown away, so drop the PV rather than go to
1722 the effort of making a read-write copy only for it to get immediately
1725 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1726 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1728 #ifdef PERL_OLD_COPY_ON_WRITE
1729 #define SvRELEASE_IVX(sv) \
1730 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1731 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1732 # define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
1734 # define SvRELEASE_IVX(sv) 0
1735 /* This little game brought to you by the need to shut this warning up:
1736 mg.c: In function `Perl_magic_get':
1737 mg.c:1024: warning: left-hand operand of comma expression has no effect
1739 # define SvRELEASE_IVX_(sv) /**/
1740 #endif /* PERL_OLD_COPY_ON_WRITE */
1742 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1743 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1744 SVf_OOK|SVf_BREAK|SVf_READONLY)
1745 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1747 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1748 sv_force_normal_flags(sv, 0)
1751 /* all these 'functions' are now just macros */
1753 #define sv_pv(sv) SvPV_nolen(sv)
1754 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1755 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1757 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1758 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1759 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1760 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1761 #define sv_setsv(dsv, ssv) \
1762 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1763 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1764 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1765 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1766 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1767 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1768 #define sv_catpvn_mg(sv, sstr, slen) \
1769 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1770 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1771 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1772 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1773 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1774 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1775 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1776 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1777 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1778 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1779 #define sv_insert(bigstr, offset, len, little, littlelen) \
1780 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1781 (littlelen), SV_GMAGIC)
1783 /* Should be named SvCatPVN_utf8_upgrade? */
1784 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1787 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
1789 sv_setpvn(nsv, sstr, slen); \
1791 sv_utf8_upgrade(nsv); \
1792 sv_catsv(dsv, nsv); \
1796 =for apidoc Am|SV*|newRV_inc|SV* sv
1798 Creates an RV wrapper for an SV. The reference count for the original SV is
1804 #define newRV_inc(sv) newRV(sv)
1806 /* the following macros update any magic values this sv is associated with */
1809 =head1 Magical Functions
1811 =for apidoc Am|void|SvGETMAGIC|SV* sv
1812 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1813 argument more than once.
1815 =for apidoc Am|void|SvSETMAGIC|SV* sv
1816 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1817 argument more than once.
1819 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1820 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1823 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1824 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1825 ssv. May evaluate arguments more than once.
1827 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1828 Like C<SvSetSV>, but does any set magic required afterwards.
1830 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1831 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1833 =for apidoc Am|void|SvSHARE|SV* sv
1834 Arranges for sv to be shared between threads if a suitable module
1837 =for apidoc Am|void|SvLOCK|SV* sv
1838 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1841 =for apidoc Am|void|SvUNLOCK|SV* sv
1842 Releases a mutual exclusion lock on sv if a suitable module
1845 =head1 SV Manipulation Functions
1847 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1848 Expands the character buffer in the SV so that it has room for the
1849 indicated number of bytes (remember to reserve space for an extra trailing
1850 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1851 Returns a pointer to the character buffer.
1856 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1857 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1858 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1859 #define SvDESTROYABLE(sv) CALL_FPTR(PL_destroyhook)(aTHX_ sv)
1861 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1862 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1864 #define SvSetSV_and(dst,src,finally) \
1866 if ((dst) != (src)) { \
1867 sv_setsv(dst, src); \
1871 #define SvSetSV_nosteal_and(dst,src,finally) \
1873 if ((dst) != (src)) { \
1874 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
1879 #define SvSetSV(dst,src) \
1880 SvSetSV_and(dst,src,/*nothing*/;)
1881 #define SvSetSV_nosteal(dst,src) \
1882 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1884 #define SvSetMagicSV(dst,src) \
1885 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1886 #define SvSetMagicSV_nosteal(dst,src) \
1887 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1890 #if !defined(SKIP_DEBUGGING)
1891 #define SvPEEK(sv) sv_peek(sv)
1893 #define SvPEEK(sv) ""
1896 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1898 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1900 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1901 /* If I give every macro argument a different name, then there won't be bugs
1902 where nested macros get confused. Been there, done that. */
1903 #define isGV_with_GP(pwadak) \
1904 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
1905 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
1906 #define isGV_with_GP_on(sv) STMT_START { \
1907 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1908 assert (!SvPOKp(sv)); \
1909 assert (!SvIOKp(sv)); \
1910 (SvFLAGS(sv) |= SVpgv_GP); \
1912 #define isGV_with_GP_off(sv) STMT_START { \
1913 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1914 assert (!SvPOKp(sv)); \
1915 assert (!SvIOKp(sv)); \
1916 (SvFLAGS(sv) &= ~SVpgv_GP); \
1920 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1921 #define SvGROW_mutable(sv,len) \
1922 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1923 #define Sv_Grow sv_grow
1925 #define CLONEf_COPY_STACKS 1
1926 #define CLONEf_KEEP_PTR_TABLE 2
1927 #define CLONEf_CLONE_HOST 4
1928 #define CLONEf_JOIN_IN 8
1930 struct clone_params {
1933 PerlInterpreter *proto_perl;
1937 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
1939 Creates a new SV and copies a string into it. If utf8 is true, calls
1940 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
1945 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
1948 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
1950 Reads into I<len> the offset from SvPVX back to the true start of the
1951 allocated buffer, which will be non-zero if C<sv_chop> has been used to
1952 efficiently remove characters from start of the buffer. Implemented as a
1953 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
1954 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
1960 /* Does the bot know something I don't?
1961 10:28 <@Nicholas> metabatman
1962 10:28 <+meta> Nicholas: crash
1964 # define SvOOK_offset(sv, offset) STMT_START { \
1965 assert(sizeof(offset) == sizeof(STRLEN)); \
1967 const U8 *crash = (U8*)SvPVX_const(sv); \
1968 offset = *--crash; \
1970 crash -= sizeof(STRLEN); \
1971 Copy(crash, (U8 *)&offset, sizeof(STRLEN), U8); \
1974 /* Validate the preceding buffer's sentinels to \
1975 verify that no-one is using it. */ \
1976 const U8 *const bonk = (U8 *) SvPVX_const(sv) - offset; \
1977 while (crash > bonk) { \
1979 assert (*crash == (U8)PTR2UV(crash)); \
1987 /* This is the same code, but avoids using any temporary variables: */
1988 # define SvOOK_offset(sv, offset) STMT_START { \
1989 assert(sizeof(offset) == sizeof(STRLEN)); \
1991 offset = ((U8*)SvPVX_const(sv))[-1]; \
1993 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
1994 (U8 *)&offset, sizeof(STRLEN), U8); \
2002 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2006 * c-indentation-style: bsd
2008 * indent-tabs-mode: t
2011 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob