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 */
68 /* *** any alterations to the SV types above need to be reflected in
69 * SVt_MASK and the various PL_valid_types_* tables */
71 #define SVt_MASK 0xf /* smallest bitmask that covers all types */
74 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
75 purposes eternal code wanting to consider PVBM probably needs to think of
77 # define SVt_PVBM SVt_PVMG
78 /* Anything wanting to create a reference from clean should ensure that it has
79 a scalar of type SVt_IV now: */
80 # define SVt_RV SVt_IV
83 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
84 so never reaches the clause at the end that uses sv_type_details->body_size
85 to determine whether to call safefree(). Hence body_size can be set
86 non-zero to record the size of HEs, without fear of bogus frees. */
87 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
88 #define HE_SVSLOT SVt_NULL
91 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
93 /* typedefs to eliminate some typing */
95 typedef struct hek HEK;
97 /* Using C's structural equivalence to help emulate C++ inheritance here... */
99 /* start with 2 sv-head building blocks */
100 #define _SV_HEAD(ptrtype) \
101 ptrtype sv_any; /* pointer to body */ \
102 U32 sv_refcnt; /* how many references to us */ \
103 U32 sv_flags /* what we are */
105 #define _SV_HEAD_UNION \
107 char* svu_pv; /* pointer to malloced string */ \
110 SV* svu_rv; /* pointer to another SV */ \
118 struct STRUCT_SV { /* struct sv { */
121 #ifdef DEBUG_LEAKING_SCALARS
122 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */
123 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */
124 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */
125 UV sv_debug_serial; /* serial number of sv allocation */
126 char * sv_debug_file; /* the file where we were allocated */
127 SV * sv_debug_parent; /* what we were cloned from (ithreads)*/
132 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
137 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
142 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
147 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
152 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
157 _SV_HEAD(struct regexp*); /* pointer to regexp body */
162 #undef _SV_HEAD_UNION /* ensure no pollution */
165 =head1 SV Manipulation Functions
167 =for apidoc Am|U32|SvREFCNT|SV* sv
168 Returns the value of the object's reference count.
170 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
171 Increments the reference count of the given SV.
173 All of the following SvREFCNT_inc* macros are optimized versions of
174 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
176 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
177 Same as SvREFCNT_inc, but can only be used if you know I<sv>
178 is not NULL. Since we don't have to check the NULLness, it's faster
181 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
182 Same as SvREFCNT_inc, but can only be used if you don't need the
183 return value. The macro doesn't need to return a meaningful value.
185 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
186 Same as SvREFCNT_inc, but can only be used if you don't need the return
187 value, and you know that I<sv> is not NULL. The macro doesn't need
188 to return a meaningful value, or check for NULLness, so it's smaller
191 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
192 Same as SvREFCNT_inc, but can only be used with expressions without side
193 effects. Since we don't have to store a temporary value, it's faster.
195 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
196 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
197 is not NULL. Since we don't have to check the NULLness, it's faster
200 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
201 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
202 return value. The macro doesn't need to return a meaningful value.
204 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
205 Same as SvREFCNT_inc, but can only be used if you don't need the return
206 value, and you know that I<sv> is not NULL. The macro doesn't need
207 to return a meaningful value, or check for NULLness, so it's smaller
210 =for apidoc Am|void|SvREFCNT_dec|SV* sv
211 Decrements the reference count of the given SV.
213 =for apidoc Am|svtype|SvTYPE|SV* sv
214 Returns the type of the SV. See C<svtype>.
216 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
217 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
218 perform the upgrade if necessary. See C<svtype>.
223 #define SvANY(sv) (sv)->sv_any
224 #define SvFLAGS(sv) (sv)->sv_flags
225 #define SvREFCNT(sv) (sv)->sv_refcnt
227 #define SvREFCNT_inc(sv) S_SvREFCNT_inc(MUTABLE_SV(sv))
228 #define SvREFCNT_inc_simple(sv) SvREFCNT_inc(sv)
229 #define SvREFCNT_inc_NN(sv) S_SvREFCNT_inc_NN(MUTABLE_SV(sv))
230 #define SvREFCNT_inc_void(sv) S_SvREFCNT_inc_void(MUTABLE_SV(sv))
232 /* These guys don't need the curly blocks */
233 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
234 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
235 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
236 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
238 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
239 # define SvREFCNT_dec(sv) \
241 SV * const _sv = MUTABLE_SV(sv); \
243 if (SvREFCNT(_sv)) { \
244 if (--(SvREFCNT(_sv)) == 0) \
245 Perl_sv_free2(aTHX_ _sv); \
252 #define SvREFCNT_dec(sv) sv_free(MUTABLE_SV(sv))
255 #define SVTYPEMASK 0xff
256 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
258 /* Sadly there are some parts of the core that have pointers to already-freed
259 SV heads, and rely on being able to tell that they are now free. So mark
260 them all by using a consistent macro. */
261 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
263 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
265 #define SVf_IOK 0x00000100 /* has valid public integer value */
266 #define SVf_NOK 0x00000200 /* has valid public numeric value */
267 #define SVf_POK 0x00000400 /* has valid public pointer value */
268 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
270 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
271 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
272 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
273 #define SVp_SCREAM 0x00008000 /* method name is DOES */
274 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
275 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
276 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
277 subroutine in another package. Set the
278 GvIMPORTED_CV_on() if it needs to be
279 expanded to a real GV */
280 /* 0x00010000 *** FREE SLOT */
281 #define SVs_PADTMP 0x00020000 /* in use as tmp; only if ! SVs_PADMY */
282 #define SVs_PADSTALE 0x00020000 /* lexical has gone out of scope;
283 only valid for SVs_PADMY */
284 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
285 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
286 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
287 #define SVs_TEMP 0x00080000 /* string is stealable? */
288 #define SVs_OBJECT 0x00100000 /* is "blessed" */
289 #define SVs_GMG 0x00200000 /* has magical get method */
290 #define SVs_SMG 0x00400000 /* has magical set method */
291 #define SVs_RMG 0x00800000 /* has random magical methods */
293 #define SVf_FAKE 0x01000000 /* 0: glob is just a copy
294 1: SV head arena wasn't malloc()ed
295 2: in conjunction with SVf_READONLY
296 marks a shared hash key scalar
297 (SvLEN == 0) or a copy on write
298 string (SvLEN != 0) [SvIsCOW(sv)]
299 3: For PVCV, whether CvUNIQUE(cv)
300 refers to an eval or once only
301 [CvEVAL(cv), CvSPECIAL(cv)]
302 4: On a pad name SV, that slot in the
303 frame AV is a REFCNT'ed reference
304 to a lexical from "outside". */
305 #define SVphv_REHASH SVf_FAKE /* 5: On a PVHV, hash values are being
307 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
308 means that a hv_aux struct is present
309 after the main array */
310 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
311 SVs in final arena cleanup.
312 Set in S_regtry on PL_reg_curpm, so that
313 perl_destruct will skip it. */
314 #define SVf_READONLY 0x08000000 /* may not be modified */
319 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE|SVs_RMG)
321 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
322 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
324 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
326 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
328 /* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
329 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
330 This is also set on RVs whose overloaded
331 stringification is UTF-8. This might
332 only happen as a side effect of SvPV() */
335 /* Some private flags. */
337 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
338 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
339 been restructured, so sometimes get used as string buffers. */
342 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
344 /* PVNV, PVMG only, and only used in pads. Should be safe to test on any scalar
345 SV, as the core is careful to avoid setting both.
347 SVf_POK, SVp_POK also set:
349 0x0000C400 method name for DOES (SvSCREAM)
350 0x40004400 FBM compiled (SvVALID)
353 0x00008000 GV with GP
354 0x00008800 RV with PCS imported
356 #define SVpad_NAME (SVp_SCREAM|SVpbm_VALID)
357 /* This SV is a name in the PAD, so
358 SVpad_TYPED, SVpad_OUR and SVpad_STATE
361 #define SVpav_REAL 0x40000000 /* free old entries */
363 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
364 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
365 on any regular scalar (anything <= PVLV) */
366 #define SVpbm_VALID 0x40000000
367 /* Only used in toke.c on an SV stored in PL_lex_repl */
368 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
370 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
371 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
373 #define SVpav_REIFY 0x80000000 /* can become real */
375 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
376 /* PVGV when SVpbm_VALID is true */
377 #define SVpbm_TAIL 0x80000000
378 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
379 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
380 /* pad name vars only */
381 #define SVpad_STATE 0x80000000 /* pad name is a "state" var */
383 /* MSVC6 generates "error C2099: initializer is not a constant" when
384 * initializing bodies_by_type in sv.c. Workaround the compiler bug by
385 * using an anonymous union, but only for MSVC6 since that isn't C89.
387 #if defined(_MSC_VER) && _MSC_VER < 1300
388 # define _XPV_CUR_U_NAME
389 # define xpv_cur xpvcuru_cur
390 # define xpv_fmdepth xpvcuru_fmdepth
392 # define _XPV_CUR_U_NAME xpv_cur_u
393 # define xpv_cur xpv_cur_u.xpvcuru_cur
394 # define xpv_fmdepth xpv_cur_u.xpvcuru_fmdepth
397 HV* xmg_stash; /* class package */ \
400 STRLEN xpvcuru_cur; /* length of svu_pv as a C string */ \
401 I32 xpvcuru_fmdepth; \
403 STRLEN xpv_len /* allocated size */
406 NV xnv_nv; /* numeric value, if any */
411 } xpad_cop_seq; /* used by pad.c for cop_sequence */
414 U8 xbm_rare; /* rarest character in string */
415 } xbm_s; /* fields from PVBM */
419 IV xivu_iv; /* integer value */
421 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
425 MAGIC* xmg_magic; /* linked list of magicalness */
426 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
427 STRLEN xmg_hash_index; /* used while freeing hash entries */
439 #define xiv_iv xiv_u.xivu_iv
446 #define xuv_uv xuv_u.xivu_uv
454 /* This structure must match the beginning of struct xpvhv in hv.h. */
468 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
469 * y=alem/helem/iter t=tie T=tied HE */
470 char xlv_flags; /* 1 = negative offset 2 = negative len */
473 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
481 typedef U16 cv_flags_t;
483 #define _XPVCV_COMMON \
491 void (*xcv_xsub) (pTHX_ CV*); \
497 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
498 * compilation) in the lexically enclosing \
502 /* This structure must match XPVCV in cv.h */
513 /* ifp and ofp are normally the same, but sockets need separate streams */
515 /* Cray addresses everything by word boundaries (64 bits) and
516 * code and data pointers cannot be mixed (which is exactly what
517 * Perl_filter_add() tries to do with the dirp), hence the
518 * following union trick (as suggested by Gurusamy Sarathy).
519 * For further information see Geir Johansen's problem report
520 * titled [ID 20000612.002] Perl problem on Cray system
521 * The any pointer (known as IoANY()) will also be a good place
522 * to hang any IO disciplines to.
525 DIR * xiou_dirp; /* for opendir, readdir, etc */
526 void * xiou_any; /* for alignment */
528 /* IV xio_lines is now in IVX $. */
529 IV xio_page; /* $% */
530 IV xio_page_len; /* $= */
531 IV xio_lines_left; /* $- */
532 char * xio_top_name; /* $^ */
533 GV * xio_top_gv; /* $^ */
534 char * xio_fmt_name; /* $~ */
535 GV * xio_fmt_gv; /* $~ */
536 char * xio_bottom_name;/* $^B */
537 GV * xio_bottom_gv; /* $^B */
542 #define xio_dirp xio_dirpu.xiou_dirp
543 #define xio_any xio_dirpu.xiou_any
545 #define IOf_ARGV 1 /* this fp iterates over ARGV */
546 #define IOf_START 2 /* check for null ARGV and substitute '-' */
547 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
548 #define IOf_DIDTOP 8 /* just did top of form */
549 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
550 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
551 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
552 Also, when this is set, SvPVX() is valid */
554 /* The following macros define implementation-independent predicates on SVs. */
557 =for apidoc Am|U32|SvNIOK|SV* sv
558 Returns a U32 value indicating whether the SV contains a number, integer or
561 =for apidoc Am|U32|SvNIOKp|SV* sv
562 Returns a U32 value indicating whether the SV contains a number, integer or
563 double. Checks the B<private> setting. Use C<SvNIOK> instead.
565 =for apidoc Am|void|SvNIOK_off|SV* sv
566 Unsets the NV/IV status of an SV.
568 =for apidoc Am|U32|SvOK|SV* sv
569 Returns a U32 value indicating whether the value is defined. This is
570 only meaningful for scalars.
572 =for apidoc Am|U32|SvIOKp|SV* sv
573 Returns a U32 value indicating whether the SV contains an integer. Checks
574 the B<private> setting. Use C<SvIOK> instead.
576 =for apidoc Am|U32|SvNOKp|SV* sv
577 Returns a U32 value indicating whether the SV contains a double. Checks the
578 B<private> setting. Use C<SvNOK> instead.
580 =for apidoc Am|U32|SvPOKp|SV* sv
581 Returns a U32 value indicating whether the SV contains a character string.
582 Checks the B<private> setting. Use C<SvPOK> instead.
584 =for apidoc Am|U32|SvIOK|SV* sv
585 Returns a U32 value indicating whether the SV contains an integer.
587 =for apidoc Am|void|SvIOK_on|SV* sv
588 Tells an SV that it is an integer.
590 =for apidoc Am|void|SvIOK_off|SV* sv
591 Unsets the IV status of an SV.
593 =for apidoc Am|void|SvIOK_only|SV* sv
594 Tells an SV that it is an integer and disables all other OK bits.
596 =for apidoc Am|void|SvIOK_only_UV|SV* sv
597 Tells and SV that it is an unsigned integer and disables all other OK bits.
599 =for apidoc Am|bool|SvIOK_UV|SV* sv
600 Returns a boolean indicating whether the SV contains an unsigned integer.
602 =for apidoc Am|bool|SvUOK|SV* sv
603 Returns a boolean indicating whether the SV contains an unsigned integer.
605 =for apidoc Am|bool|SvIOK_notUV|SV* sv
606 Returns a boolean indicating whether the SV contains a signed integer.
608 =for apidoc Am|U32|SvNOK|SV* sv
609 Returns a U32 value indicating whether the SV contains a double.
611 =for apidoc Am|void|SvNOK_on|SV* sv
612 Tells an SV that it is a double.
614 =for apidoc Am|void|SvNOK_off|SV* sv
615 Unsets the NV status of an SV.
617 =for apidoc Am|void|SvNOK_only|SV* sv
618 Tells an SV that it is a double and disables all other OK bits.
620 =for apidoc Am|U32|SvPOK|SV* sv
621 Returns a U32 value indicating whether the SV contains a character
624 =for apidoc Am|void|SvPOK_on|SV* sv
625 Tells an SV that it is a string.
627 =for apidoc Am|void|SvPOK_off|SV* sv
628 Unsets the PV status of an SV.
630 =for apidoc Am|void|SvPOK_only|SV* sv
631 Tells an SV that it is a string and disables all other OK bits.
632 Will also turn off the UTF-8 status.
634 =for apidoc Am|bool|SvVOK|SV* sv
635 Returns a boolean indicating whether the SV contains a v-string.
637 =for apidoc Am|U32|SvOOK|SV* sv
638 Returns a U32 indicating whether the pointer to the string buffer is offset.
639 This hack is used internally to speed up removal of characters from the
640 beginning of a SvPV. When SvOOK is true, then the start of the
641 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
642 This offset used to be stored in SvIVX, but is now stored within the spare
645 =for apidoc Am|U32|SvROK|SV* sv
646 Tests if the SV is an RV.
648 =for apidoc Am|void|SvROK_on|SV* sv
649 Tells an SV that it is an RV.
651 =for apidoc Am|void|SvROK_off|SV* sv
652 Unsets the RV status of an SV.
654 =for apidoc Am|SV*|SvRV|SV* sv
655 Dereferences an RV to return the SV.
657 =for apidoc Am|IV|SvIVX|SV* sv
658 Returns the raw value in the SV's IV slot, without checks or conversions.
659 Only use when you are sure SvIOK is true. See also C<SvIV()>.
661 =for apidoc Am|UV|SvUVX|SV* sv
662 Returns the raw value in the SV's UV slot, without checks or conversions.
663 Only use when you are sure SvIOK is true. See also C<SvUV()>.
665 =for apidoc Am|NV|SvNVX|SV* sv
666 Returns the raw value in the SV's NV slot, without checks or conversions.
667 Only use when you are sure SvNOK is true. See also C<SvNV()>.
669 =for apidoc Am|char*|SvPVX|SV* sv
670 Returns a pointer to the physical string in the SV. The SV must contain a
673 This is also used to store the name of an autoloaded subroutine in an XS
674 AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
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 spot just after the last character in
685 the string which is in the SV, where there is usually a trailing
686 null (even though Perl scalars do not strictly require it).
687 See C<SvCUR>. Access the character as *(SvEND(sv)).
689 Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
692 =for apidoc Am|HV*|SvSTASH|SV* sv
693 Returns the stash of the SV.
695 =for apidoc Am|void|SvIV_set|SV* sv|IV val
696 Set the value of the IV pointer in sv to val. It is possible to perform
697 the same function of this macro with an lvalue assignment to C<SvIVX>.
698 With future Perls, however, it will be more efficient to use
699 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
701 =for apidoc Am|void|SvNV_set|SV* sv|NV val
702 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
704 =for apidoc Am|void|SvPV_set|SV* sv|char* val
705 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
707 =for apidoc Am|void|SvUV_set|SV* sv|UV val
708 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
710 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
711 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
713 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
714 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
716 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
717 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
719 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
720 Set the current length of the string which is in the SV. See C<SvCUR>
723 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
724 Set the actual length of the string which is in the SV. See C<SvIV_set>.
729 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
730 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
731 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
732 SVp_IOK|SVp_NOK|SVf_IVisUV))
734 #define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv))
735 #define assert_not_glob(sv) assert_(!isGV_with_GP(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 the UTF-8 status of an SV. If things are set-up
788 properly, this indicates whether or not the SV contains UTF-8 encoded data.
789 Call this after SvPV() in case any call to string overloading updates the
792 =for apidoc Am|void|SvUTF8_on|SV *sv
793 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
794 Do not use frivolously.
796 =for apidoc Am|void|SvUTF8_off|SV *sv
797 Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
798 Do not use frivolously.
800 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
801 Tells an SV that it is a string and disables all other OK bits,
802 and leaves the UTF-8 status as it was.
807 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
809 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
810 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
811 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
813 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
814 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
815 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
816 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
817 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
818 SvFLAGS(sv) &= ~(SVf_OK| \
819 SVf_IVisUV|SVf_UTF8), \
820 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
821 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
822 SvFLAGS(sv) &= ~(SVf_OK| \
824 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
826 #define SvVOK(sv) (SvMAGICAL(sv) \
827 && mg_find(sv,PERL_MAGIC_vstring))
828 /* returns the vstring magic, if any */
829 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
830 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
832 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
833 #define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
834 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
836 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
837 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
838 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
840 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
841 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
842 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
844 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
845 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
846 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
848 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
849 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
850 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
852 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
853 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
854 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
856 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
857 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
858 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
860 #define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
861 HvAMAGIC(SvSTASH(SvRV(sv))))
862 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
863 # define SvAMAGIC_on(sv) ({ SV * const kloink = sv; \
864 assert(SvROK(kloink)); \
865 if (SvOBJECT(SvRV(kloink))) \
866 HvAMAGIC_on(SvSTASH(SvRV(kloink))); \
868 # define SvAMAGIC_off(sv) ({ SV * const kloink = sv; \
870 && SvOBJECT(SvRV(kloink))) \
871 HvAMAGIC_off(SvSTASH(SvRV(kloink))); \
874 # define SvAMAGIC_on(sv) \
875 SvOBJECT(SvRV(sv)) && (SvFLAGS(SvSTASH(SvRV(sv))) |= SVf_AMAGIC)
876 # define SvAMAGIC_off(sv) \
877 (SvROK(sv) && SvOBJECT(SvRV(sv)) \
878 && (SvFLAGS(SvSTASH(SvRV(sv))) &= ~SVf_AMAGIC))
881 /* To be used on the stashes themselves: */
882 #define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
883 #define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
884 #define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
887 #define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
888 #define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
889 #define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
890 #define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
891 #define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
893 #define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
894 #define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
895 #define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
896 #define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
897 #define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
899 #define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
900 #define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
902 #define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
903 #define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
905 #define SvPOK_pure_nogthink(sv) \
906 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
907 #define SvPOK_utf8_pure_nogthink(sv) \
908 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
909 #define SvPOK_byte_pure_nogthink(sv) \
910 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
913 =for apidoc Am|U32|SvGAMAGIC|SV* sv
915 Returns true if the SV has get magic or
916 overloading. If either is true then
917 the scalar is active data, and has the potential to return a new value every
918 time it is accessed. Hence you must be careful to
919 only read it once per user logical operation and work
920 with that returned value. If neither is true then
921 the scalar's value cannot change unless written to.
926 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
928 #define Gv_AMG(stash) \
929 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
931 : (HvAMAGIC_off(stash), 0))
933 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
934 == (SVf_ROK|SVprv_WEAKREF))
935 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
936 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
938 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
939 == (SVf_ROK|SVprv_PCS_IMPORTED))
940 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
941 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
944 =for apidoc m|U32|SvTHINKFIRST|SV *sv
946 A quick flag check to see whether an sv should be passed to sv_force_normal
947 to be "downgraded" before SvIVX or SvPVX can be modified directly.
949 For example, if your scalar is a reference and you want to modify the SvIVX
950 slot, you can't just do SvROK_off, as that will leak the referent.
952 This is used internally by various sv-modifying functions, such as
953 sv_setsv, sv_setiv and sv_pvn_force.
955 One case that this does not handle is a gv without SvFAKE set. After
957 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
959 it will still be a gv.
961 SvTHINKFIRST sometimes produces false positives. In those cases
962 sv_force_normal does nothing.
967 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
969 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
970 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
972 /* SVs_PADTMP and SVs_PADSTALE share the same bit, mediated by SVs_PADMY */
974 #define SvPADTMP(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP)) == SVs_PADTMP)
975 #define SvPADSTALE(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADSTALE)) \
976 == (SVs_PADMY|SVs_PADSTALE))
978 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
979 # define SvPADTMP_on(sv) ({ \
980 SV *const _svpad = MUTABLE_SV(sv); \
981 assert(!(SvFLAGS(_svpad) & SVs_PADMY)); \
982 SvFLAGS(_svpad) |= SVs_PADTMP; \
984 # define SvPADTMP_off(sv) ({ \
985 SV *const _svpad = MUTABLE_SV(sv); \
986 assert(!(SvFLAGS(_svpad) & SVs_PADMY)); \
987 SvFLAGS(_svpad) &= ~SVs_PADTMP; \
989 # define SvPADSTALE_on(sv) ({ \
990 SV *const _svpad = MUTABLE_SV(sv); \
991 assert(SvFLAGS(_svpad) & SVs_PADMY); \
992 SvFLAGS(_svpad) |= SVs_PADSTALE; \
994 # define SvPADSTALE_off(sv) ({ \
995 SV *const _svpad = MUTABLE_SV(sv); \
996 assert(SvFLAGS(_svpad) & SVs_PADMY); \
997 SvFLAGS(_svpad) &= ~SVs_PADSTALE; \
1000 # define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1001 # define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1002 # define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
1003 # define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
1006 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1007 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1008 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1010 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1011 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1012 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1014 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
1015 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1016 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1018 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1019 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1020 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1023 # define SvCOMPILED(sv) 0
1024 # define SvCOMPILED_on(sv)
1025 # define SvCOMPILED_off(sv)
1028 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1029 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1030 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1032 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1033 # define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
1034 if (SvFLAGS(_svvalid) & SVpbm_VALID) \
1035 assert(!isGV_with_GP(_svvalid)); \
1036 (SvFLAGS(_svvalid) & SVpbm_VALID); \
1038 # define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
1039 assert(!isGV_with_GP(_svvalid)); \
1040 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
1042 # define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
1043 assert(!isGV_with_GP(_svvalid)); \
1044 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
1047 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
1048 assert(SvTYPE(_svtail) != SVt_PVAV); \
1049 assert(SvTYPE(_svtail) != SVt_PVHV); \
1050 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1051 == (SVpbm_TAIL|SVpbm_VALID); \
1054 # define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
1055 # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1056 # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
1057 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1058 == (SVpbm_TAIL|SVpbm_VALID))
1061 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1062 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1065 #define SvPAD_TYPED(sv) \
1066 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1068 #define SvPAD_OUR(sv) \
1069 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1071 #define SvPAD_STATE(sv) \
1072 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1074 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1075 # define SvPAD_TYPED_on(sv) ({ \
1076 SV *const _svpad = MUTABLE_SV(sv); \
1077 assert(SvTYPE(_svpad) == SVt_PVMG); \
1078 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \
1080 #define SvPAD_OUR_on(sv) ({ \
1081 SV *const _svpad = MUTABLE_SV(sv); \
1082 assert(SvTYPE(_svpad) == SVt_PVMG); \
1083 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \
1085 #define SvPAD_STATE_on(sv) ({ \
1086 SV *const _svpad = MUTABLE_SV(sv); \
1087 assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
1088 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \
1091 # define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1092 # define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1093 # define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1096 #define SvOURSTASH(sv) \
1097 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1098 #define SvOURSTASH_set(sv, st) \
1100 assert(SvTYPE(sv) == SVt_PVMG); \
1101 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1104 #define SvRVx(sv) SvRV(sv)
1106 #ifdef PERL_DEBUG_COW
1107 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1108 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1109 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1110 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1111 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1112 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1113 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1114 /* Don't test the core XS code yet. */
1115 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1116 # define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
1118 # define SvPVX(sv) SvPVX_mutable(sv)
1120 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1121 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1122 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1124 # define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1125 # define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
1127 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1128 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1130 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1131 /* These get expanded inside other macros that already use a variable _sv */
1132 # define SvPVX(sv) \
1133 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1134 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
1135 assert(!isGV_with_GP(_svpvx)); \
1136 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1137 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
1138 &((_svpvx)->sv_u.svu_pv); \
1140 # define SvCUR(sv) \
1141 (*({ const SV *const _svcur = (const SV *)(sv); \
1142 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK]); \
1143 assert(!isGV_with_GP(_svcur)); \
1144 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1145 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1146 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1148 # define SvIVX(sv) \
1149 (*({ const SV *const _svivx = (const SV *)(sv); \
1150 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
1151 assert(!isGV_with_GP(_svivx)); \
1152 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1154 # define SvUVX(sv) \
1155 (*({ const SV *const _svuvx = (const SV *)(sv); \
1156 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
1157 assert(!isGV_with_GP(_svuvx)); \
1158 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1160 # define SvNVX(sv) \
1161 (*({ const SV *const _svnvx = (const SV *)(sv); \
1162 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
1163 assert(!isGV_with_GP(_svnvx)); \
1164 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1167 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1168 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1169 assert(!isGV_with_GP(_svrv)); \
1170 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1171 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1172 &((_svrv)->sv_u.svu_rv); \
1174 # define SvRV_const(sv) \
1175 ({ const SV *const _svrv = (const SV *)(sv); \
1176 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1177 assert(!isGV_with_GP(_svrv)); \
1178 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1179 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1180 (_svrv)->sv_u.svu_rv; \
1182 # define SvMAGIC(sv) \
1183 (*({ const SV *const _svmagic = (const SV *)(sv); \
1184 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1185 if(SvTYPE(_svmagic) == SVt_PVMG) \
1186 assert(!SvPAD_OUR(_svmagic)); \
1187 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1189 # define SvSTASH(sv) \
1190 (*({ const SV *const _svstash = (const SV *)(sv); \
1191 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1192 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1195 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1196 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1197 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1198 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1199 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1200 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1201 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1202 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1203 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1208 /* Given that these two are new, there can't be any existing code using them
1210 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1211 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1213 /* Except for the poison code, which uses & to scribble over the pointer after
1214 free() is called. */
1215 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1216 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1219 #define SvIVXx(sv) SvIVX(sv)
1220 #define SvUVXx(sv) SvUVX(sv)
1221 #define SvNVXx(sv) SvNVX(sv)
1222 #define SvPVXx(sv) SvPVX(sv)
1223 #define SvLENx(sv) SvLEN(sv)
1224 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1227 /* Ask a scalar nicely to try to become an IV, if possible.
1228 Not guaranteed to stay returning void */
1229 /* Macro won't actually call sv_2iv if already IOK */
1230 #define SvIV_please(sv) \
1231 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1232 (void) SvIV(sv); } STMT_END
1233 #define SvIV_please_nomg(sv) \
1234 (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv)) \
1235 ? (SvIV_nomg(sv), SvIOK(sv)) \
1237 #define SvIV_set(sv, val) \
1239 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1240 assert(!isGV_with_GP(sv)); \
1241 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1242 #define SvNV_set(sv, val) \
1244 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
1245 assert(!isGV_with_GP(sv)); \
1246 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1247 #define SvPV_set(sv, val) \
1249 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1250 assert(!isGV_with_GP(sv)); \
1251 assert(!(SvTYPE(sv) == SVt_PVIO \
1252 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1253 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1254 #define SvUV_set(sv, val) \
1256 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1257 assert(!isGV_with_GP(sv)); \
1258 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1259 #define SvRV_set(sv, val) \
1261 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
1262 assert(!isGV_with_GP(sv)); \
1263 assert(!(SvTYPE(sv) == SVt_PVIO \
1264 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1265 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1266 #define SvMAGIC_set(sv, val) \
1267 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1268 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1269 #define SvSTASH_set(sv, val) \
1270 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1271 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1272 #define SvCUR_set(sv, val) \
1274 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1275 assert(!isGV_with_GP(sv)); \
1276 assert(!(SvTYPE(sv) == SVt_PVIO \
1277 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1278 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1279 #define SvLEN_set(sv, val) \
1281 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1282 assert(!isGV_with_GP(sv)); \
1283 assert(!(SvTYPE(sv) == SVt_PVIO \
1284 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1285 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1286 #define SvEND_set(sv, val) \
1287 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1288 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1290 #define SvPV_renew(sv,n) \
1291 STMT_START { SvLEN_set(sv, n); \
1292 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1293 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1294 (MEM_SIZE)((n))))); \
1297 #define SvPV_shrink_to_cur(sv) STMT_START { \
1298 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1299 SvPV_renew(sv, _lEnGtH); \
1302 #define SvPV_free(sv) \
1304 assert(SvTYPE(sv) >= SVt_PV); \
1306 assert(!SvROK(sv)); \
1309 SvOOK_offset(sv, zok); \
1310 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1311 SvFLAGS(sv) &= ~SVf_OOK; \
1313 Safefree(SvPVX(sv)); \
1318 /* Code that crops up in three places to take a scalar and ready it to hold
1320 # define prepare_SV_for_RV(sv) \
1322 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1323 sv_upgrade(sv, SVt_IV); \
1324 else if (SvTYPE(sv) >= SVt_PV) { \
1333 # define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1336 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1337 # define BmRARE(sv) \
1338 (*({ SV *const _bmrare = MUTABLE_SV(sv); \
1339 assert(SvTYPE(_bmrare) == SVt_PVMG); \
1340 assert(SvVALID(_bmrare)); \
1341 &(((XPVMG*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare); \
1343 # define BmUSEFUL(sv) \
1344 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1345 assert(SvTYPE(_bmuseful) == SVt_PVMG); \
1346 assert(SvVALID(_bmuseful)); \
1347 assert(!SvIOK(_bmuseful)); \
1348 &(((XPVMG*) SvANY(_bmuseful))->xnv_u.xbm_s.xbm_useful); \
1350 # define BmPREVIOUS(sv) \
1351 (*({ SV *const _bmprevious = MUTABLE_SV(sv); \
1352 assert(SvTYPE(_bmprevious) == SVt_PVMG); \
1353 assert(SvVALID(_bmprevious)); \
1354 &(((XPVMG*) SvANY(_bmprevious))->xiv_u.xivu_uv); \
1357 # define BmRARE(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1358 # define BmUSEFUL(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_useful
1359 # define BmPREVIOUS(sv) ((XPVMG*) SvANY(sv))->xiv_u.xivu_uv
1363 #define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1365 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1366 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1367 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1368 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1369 #define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
1371 #define IoIFP(sv) (sv)->sv_u.svu_fp
1372 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1373 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1374 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1375 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
1376 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1377 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1378 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1379 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1380 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1381 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1382 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1383 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1384 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1385 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1386 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1388 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1389 #define IoTYPE_RDONLY '<'
1390 #define IoTYPE_WRONLY '>'
1391 #define IoTYPE_RDWR '+'
1392 #define IoTYPE_APPEND 'a'
1393 #define IoTYPE_PIPE '|'
1394 #define IoTYPE_STD '-' /* stdin or stdout */
1395 #define IoTYPE_SOCKET 's'
1396 #define IoTYPE_CLOSED ' '
1397 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1398 #define IoTYPE_NUMERIC '#' /* fdopen */
1401 =for apidoc Am|bool|SvTAINTED|SV* sv
1402 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1405 =for apidoc Am|void|SvTAINTED_on|SV* sv
1406 Marks an SV as tainted if tainting is enabled.
1408 =for apidoc Am|void|SvTAINTED_off|SV* sv
1409 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1410 some of Perl's fundamental security features. XS module authors should not
1411 use this function unless they fully understand all the implications of
1412 unconditionally untainting the value. Untainting should be done in the
1413 standard perl fashion, via a carefully crafted regexp, rather than directly
1414 untainting variables.
1416 =for apidoc Am|void|SvTAINT|SV* sv
1417 Taints an SV if tainting is enabled, and if some input to the current
1418 expression is tainted--usually a variable, but possibly also implicit
1419 inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1420 the outputs of an expression in a pessimistic fashion; i.e., without paying
1421 attention to precisely which outputs are influenced by which inputs.
1426 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1428 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1429 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1430 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1432 #define SvTAINT(sv) \
1434 if (PL_tainting) { \
1441 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1442 Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1443 only a string (C<SvPOK_only>), by hook or by crook. You want force if you are
1444 going to update the C<SvPVX> directly. Processes get magic.
1446 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1447 Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1448 only a string (C<SvPOK_only>), by hook or by crook. You want force if you are
1449 going to update the C<SvPVX> directly. Doesn't process get magic.
1451 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1452 Returns a pointer to the string in the SV, or a stringified form of
1453 the SV if the SV does not contain a string. The SV may cache the
1454 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1455 C<SvPVx> for a version which guarantees to evaluate sv only once.
1457 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1458 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1459 Only use this if C<sv> is an expression with side effects, otherwise use the
1460 more efficient C<SvPV>.
1462 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1463 Like C<SvPV> but doesn't process magic.
1465 =for apidoc Am|char*|SvPV_nolen|SV* sv
1466 Returns a pointer to the string in the SV, or a stringified form of
1467 the SV if the SV does not contain a string. The SV may cache the
1468 stringified form becoming C<SvPOK>. Handles 'get' magic.
1470 =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1471 Like C<SvPV_nolen> but doesn't process magic.
1473 =for apidoc Am|IV|SvIV|SV* sv
1474 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1475 version which guarantees to evaluate sv only once.
1477 =for apidoc Am|IV|SvIV_nomg|SV* sv
1478 Like C<SvIV> but doesn't process magic.
1480 =for apidoc Am|IV|SvIVx|SV* sv
1481 Coerces the given SV to an integer and returns it.
1482 Guarantees to evaluate C<sv> only once. Only use
1483 this if C<sv> is an expression with side effects,
1484 otherwise use the more efficient C<SvIV>.
1486 =for apidoc Am|NV|SvNV|SV* sv
1487 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1488 which guarantees to evaluate sv only once.
1490 =for apidoc Am|NV|SvNV_nomg|SV* sv
1491 Like C<SvNV> but doesn't process magic.
1493 =for apidoc Am|NV|SvNVx|SV* sv
1494 Coerces the given SV to a double and returns it.
1495 Guarantees to evaluate C<sv> only once. Only use
1496 this if C<sv> is an expression with side effects,
1497 otherwise use the more efficient C<SvNV>.
1499 =for apidoc Am|UV|SvUV|SV* sv
1500 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1501 for a version which guarantees to evaluate sv only once.
1503 =for apidoc Am|UV|SvUV_nomg|SV* sv
1504 Like C<SvUV> but doesn't process magic.
1506 =for apidoc Am|UV|SvUVx|SV* sv
1507 Coerces the given SV to an unsigned integer and
1508 returns it. Guarantees to C<sv> only once. Only
1509 use this if C<sv> is an expression with side effects,
1510 otherwise use the more efficient C<SvUV>.
1512 =for apidoc Am|bool|SvTRUE|SV* sv
1513 Returns a boolean indicating whether Perl would evaluate the SV as true or
1514 false. See SvOK() for a defined/undefined test. Handles 'get' magic
1515 unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
1518 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
1519 Returns a boolean indicating whether Perl would evaluate the SV as true or
1520 false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
1522 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1523 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1525 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1526 Like C<SvPV>, but converts sv to utf8 first if necessary.
1528 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1529 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1531 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1532 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1534 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1535 Like C<SvPV>, but converts sv to byte representation first if necessary.
1537 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1538 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1540 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1541 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1542 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1545 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1546 Like C<SvPV>, but converts sv to utf8 first if necessary.
1547 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1550 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1551 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1552 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1555 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1556 Like C<SvPV>, but converts sv to byte representation first if necessary.
1557 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1560 =for apidoc Am|bool|SvIsCOW|SV* sv
1561 Returns a boolean indicating whether the SV is Copy-On-Write (either shared
1562 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1565 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1566 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1569 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1570 Like C<sv_catpvn> but doesn't process magic.
1572 =for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1573 Like C<sv_catpv> but doesn't process magic.
1575 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1576 Like C<sv_setsv> but doesn't process magic.
1578 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1579 Like C<sv_catsv> but doesn't process magic.
1581 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1583 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
1588 /* Let us hope that bitmaps for UV and IV are the same */
1589 #define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1590 #define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1591 #define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
1593 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1594 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1595 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1599 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1600 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1601 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1603 #define SvPV_flags(sv, lp, flags) \
1605 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1606 #define SvPV_flags_const(sv, lp, flags) \
1608 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1609 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1610 #define SvPV_flags_const_nolen(sv, flags) \
1612 ? SvPVX_const(sv) : \
1613 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1614 #define SvPV_flags_mutable(sv, lp, flags) \
1616 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1617 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1619 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1620 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1621 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1623 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1624 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1626 #define SvPV_force_flags(sv, lp, flags) \
1627 (SvPOK_pure_nogthink(sv) \
1628 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1630 #define SvPV_force_flags_nolen(sv, flags) \
1631 (SvPOK_pure_nogthink(sv) \
1632 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1634 #define SvPV_force_flags_mutable(sv, lp, flags) \
1635 (SvPOK_pure_nogthink(sv) \
1636 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1637 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1639 #define SvPV_nolen(sv) \
1641 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1643 #define SvPV_nomg_nolen(sv) \
1645 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1647 #define SvPV_nolen_const(sv) \
1649 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1651 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1652 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1653 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1657 #define SvPVutf8(sv, lp) \
1658 (SvPOK_utf8_nog(sv) \
1659 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1661 #define SvPVutf8_force(sv, lp) \
1662 (SvPOK_utf8_pure_nogthink(sv) \
1663 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1665 #define SvPVutf8_nolen(sv) \
1666 (SvPOK_utf8_nog(sv) \
1667 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1671 #define SvPVbyte(sv, lp) \
1672 (SvPOK_byte_nog(sv) \
1673 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1675 #define SvPVbyte_force(sv, lp) \
1676 (SvPOK_byte_pure_nogthink(sv) \
1677 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1679 #define SvPVbyte_nolen(sv) \
1680 (SvPOK_byte_nog(sv) \
1681 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1684 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1685 * var to evaluate the arg once; failing that, use a global if possible;
1686 * failing that, call a function to do the work
1689 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1690 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1691 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1693 #define SvTRUE(sv) ((sv) && (SvGMAGICAL(sv) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))))
1694 #define SvTRUE_nomg(sv) ((sv) && ( SvTRUE_common(sv, sv_2bool_nomg(sv))))
1695 #define SvTRUE_common(sv,fallback) ( \
1698 : (SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK)) \
1699 ? ( (SvPOK(sv) && SvPVXtrue(sv)) \
1700 || (SvIOK(sv) && SvIVX(sv) != 0) \
1701 || (SvNOK(sv) && SvNVX(sv) != 0.0)) \
1704 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1706 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1707 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1708 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1709 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1710 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1711 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1712 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1713 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1714 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1715 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1716 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1717 # define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
1718 # define SvPVXtrue(sv) \
1720 (nxpv = (XPV*)SvANY(sv)) \
1721 && (nxpv->xpv_cur > 1 \
1722 || (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0'));})
1724 #else /* __GNUC__ */
1726 /* These inlined macros use globals, which will require a thread
1727 * declaration in user code, so we avoid them under threads */
1729 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1730 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1731 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1732 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1733 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1734 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1735 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1736 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1737 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1738 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1739 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1740 # define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
1741 # define SvPVXtrue(sv) \
1742 ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) \
1743 && (PL_Xpv->xpv_cur > 1 \
1744 || (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')))
1745 #endif /* __GNU__ */
1747 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1748 (SVf_FAKE | SVf_READONLY) && !isGV_with_GP(sv) \
1749 && SvTYPE(sv) != SVt_REGEXP)
1750 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1752 #define SvSHARED_HEK_FROM_PV(pvx) \
1753 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1754 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1756 /* flag values for sv_*_flags functions */
1757 #define SV_IMMEDIATE_UNREF 1
1759 #define SV_COW_DROP_PV 4
1760 #define SV_UTF8_NO_ENCODING 8
1761 #define SV_NOSTEAL 16
1762 #define SV_CONST_RETURN 32
1763 #define SV_MUTABLE_RETURN 64
1764 #define SV_SMAGIC 128
1765 #define SV_HAS_TRAILING_NUL 256
1766 #define SV_COW_SHARED_HASH_KEYS 512
1767 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1768 #define SV_COW_OTHER_PVS 1024
1769 /* Make sv_2pv_flags return NULL if something is undefined. */
1770 #define SV_UNDEF_RETURNS_NULL 2048
1771 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1772 * This is used when the caller has already determined it is, and avoids
1774 #define SV_FORCE_UTF8_UPGRADE 4096
1775 /* if (after resolving magic etc), the SV is found to be overloaded,
1776 * don't call the overload magic, just return as-is */
1777 #define SV_SKIP_OVERLOAD 8192
1778 /* It is not yet clear whether we want this as an API, or what the
1779 * constants should be named. */
1781 # define SV_CATBYTES 16384
1782 # define SV_CATUTF8 32768
1785 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1786 So only default to doing the COW setup if we're in the core.
1789 # ifndef SV_DO_COW_SVSETSV
1790 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1794 #ifndef SV_DO_COW_SVSETSV
1795 # define SV_DO_COW_SVSETSV 0
1799 #define sv_unref(sv) sv_unref_flags(sv, 0)
1800 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1801 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1802 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1804 /* We are about to replace the SV's current value. So if it's copy on write
1805 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1806 the value is about to get thrown away, so drop the PV rather than go to
1807 the effort of making a read-write copy only for it to get immediately
1810 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1811 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1813 #ifdef PERL_OLD_COPY_ON_WRITE
1814 #define SvRELEASE_IVX(sv) \
1815 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1816 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1817 # define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
1819 # define SvRELEASE_IVX(sv) 0
1820 /* This little game brought to you by the need to shut this warning up:
1821 mg.c: In function 'Perl_magic_get':
1822 mg.c:1024: warning: left-hand operand of comma expression has no effect
1824 # define SvRELEASE_IVX_(sv) /**/
1825 #endif /* PERL_OLD_COPY_ON_WRITE */
1827 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1828 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1829 SVf_OOK|SVf_BREAK|SVf_READONLY)
1830 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1832 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1833 sv_force_normal_flags(sv, 0)
1836 /* all these 'functions' are now just macros */
1838 #define sv_pv(sv) SvPV_nolen(sv)
1839 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1840 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1842 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1843 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1844 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1845 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1846 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
1847 #define sv_setsv(dsv, ssv) \
1848 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1849 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1850 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1851 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1852 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1853 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1854 #define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1855 #define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
1856 #define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
1857 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1858 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1859 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1860 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1861 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1862 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1863 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1864 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1865 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1866 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1867 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1868 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1869 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
1870 #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
1871 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
1872 #define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
1873 #define sv_insert(bigstr, offset, len, little, littlelen) \
1874 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1875 (littlelen), SV_GMAGIC)
1877 /* Should be named SvCatPVN_utf8_upgrade? */
1878 #define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
1881 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
1883 sv_setpvn(nsv, sstr, slen); \
1885 sv_utf8_upgrade(nsv); \
1886 sv_catsv_nomg(dsv, nsv); \
1890 =for apidoc Am|SV*|newRV_inc|SV* sv
1892 Creates an RV wrapper for an SV. The reference count for the original SV is
1898 #define newRV_inc(sv) newRV(sv)
1900 /* the following macros update any magic values this sv is associated with */
1903 =head1 Magical Functions
1905 =for apidoc Am|void|SvGETMAGIC|SV* sv
1906 Invokes C<mg_get> on an SV if it has 'get' magic. For example, this
1907 will call C<FETCH> on a tied variable. This macro evaluates its
1908 argument more than once.
1910 =for apidoc Am|void|SvSETMAGIC|SV* sv
1911 Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary
1912 after modifying a scalar, in case it is a magical variable like C<$|>
1913 or a tied variable (it calls C<STORE>). This macro evaluates its
1914 argument more than once.
1916 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1917 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1920 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1921 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1922 ssv. May evaluate arguments more than once.
1924 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1925 Like C<SvSetSV>, but does any set magic required afterwards.
1927 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1928 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1930 =for apidoc Am|void|SvSHARE|SV* sv
1931 Arranges for sv to be shared between threads if a suitable module
1934 =for apidoc Am|void|SvLOCK|SV* sv
1935 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1938 =for apidoc Am|void|SvUNLOCK|SV* sv
1939 Releases a mutual exclusion lock on sv if a suitable module
1942 =head1 SV Manipulation Functions
1944 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1945 Expands the character buffer in the SV so that it has room for the
1946 indicated number of bytes (remember to reserve space for an extra trailing
1947 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1948 Returns a pointer to the character buffer.
1953 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
1954 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
1955 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
1956 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
1958 #define SvGETMAGIC(x) ((void)(SvGMAGICAL(x) && mg_get(x)))
1959 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1961 #define SvSetSV_and(dst,src,finally) \
1963 if ((dst) != (src)) { \
1964 sv_setsv(dst, src); \
1968 #define SvSetSV_nosteal_and(dst,src,finally) \
1970 if ((dst) != (src)) { \
1971 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
1976 #define SvSetSV(dst,src) \
1977 SvSetSV_and(dst,src,/*nothing*/;)
1978 #define SvSetSV_nosteal(dst,src) \
1979 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1981 #define SvSetMagicSV(dst,src) \
1982 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1983 #define SvSetMagicSV_nosteal(dst,src) \
1984 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1987 #if !defined(SKIP_DEBUGGING)
1988 #define SvPEEK(sv) sv_peek(sv)
1990 #define SvPEEK(sv) ""
1993 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1996 =for apidoc Am|SV *|boolSV|bool b
1998 Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
2000 See also C<PL_sv_yes> and C<PL_sv_no>.
2005 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2007 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2008 /* If I give every macro argument a different name, then there won't be bugs
2009 where nested macros get confused. Been there, done that. */
2010 #define isGV_with_GP(pwadak) \
2011 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
2012 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2013 #define isGV_with_GP_on(sv) STMT_START { \
2014 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2015 assert (!SvPOKp(sv)); \
2016 assert (!SvIOKp(sv)); \
2017 (SvFLAGS(sv) |= SVpgv_GP); \
2019 #define isGV_with_GP_off(sv) STMT_START { \
2020 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2021 assert (!SvPOKp(sv)); \
2022 assert (!SvIOKp(sv)); \
2023 (SvFLAGS(sv) &= ~SVpgv_GP); \
2027 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2028 #define SvGROW_mutable(sv,len) \
2029 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2030 #define Sv_Grow sv_grow
2032 #define CLONEf_COPY_STACKS 1
2033 #define CLONEf_KEEP_PTR_TABLE 2
2034 #define CLONEf_CLONE_HOST 4
2035 #define CLONEf_JOIN_IN 8
2037 struct clone_params {
2040 PerlInterpreter *proto_perl;
2041 PerlInterpreter *new_perl;
2046 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2048 Creates a new SV and copies a string into it. If utf8 is true, calls
2049 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2054 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2057 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2059 Reads into I<len> the offset from SvPVX back to the true start of the
2060 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2061 efficiently remove characters from start of the buffer. Implemented as a
2062 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
2063 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
2069 /* Does the bot know something I don't?
2070 10:28 <@Nicholas> metabatman
2071 10:28 <+meta> Nicholas: crash
2073 # define SvOOK_offset(sv, offset) STMT_START { \
2074 assert(sizeof(offset) == sizeof(STRLEN)); \
2076 const U8 *_crash = (U8*)SvPVX_const(sv); \
2077 (offset) = *--_crash; \
2079 _crash -= sizeof(STRLEN); \
2080 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
2083 /* Validate the preceding buffer's sentinels to \
2084 verify that no-one is using it. */ \
2085 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2086 while (_crash > _bonk) { \
2088 assert (*_crash == (U8)PTR2UV(_crash)); \
2096 /* This is the same code, but avoids using any temporary variables: */
2097 # define SvOOK_offset(sv, offset) STMT_START { \
2098 assert(sizeof(offset) == sizeof(STRLEN)); \
2100 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2102 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2103 (U8*)&(offset), sizeof(STRLEN), U8); \
2111 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2115 * c-indentation-style: bsd
2117 * indent-tabs-mode: nil
2120 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob