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 F<sv.h>
20 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
42 These are most easily explained from the bottom up.
44 C<SVt_PVIO> is for I/O objects, C<SVt_PVFM> for formats, C<SVt_PVCV> for
45 subroutines, C<SVt_PVHV> for hashes and C<SVt_PVAV> for arrays.
47 All the others are scalar types, that is, things that can be bound to a
48 C<$> variable. For these, the internal types are mostly orthogonal to
49 types in the Perl language.
51 Hence, checking C<< SvTYPE(sv) < SVt_PVAV >> is the best way to see whether
52 something is a scalar.
54 C<SVt_PVGV> represents a typeglob. If C<!SvFAKE(sv)>, then it is a real,
55 incoercible typeglob. If C<SvFAKE(sv)>, then it is a scalar to which a
56 typeglob has been assigned. Assigning to it again will stop it from being
57 a typeglob. C<SVt_PVLV> represents a scalar that delegates to another scalar
58 behind the scenes. It is used, e.g., for the return value of C<substr> and
59 for tied hash and array elements. It can hold any scalar value, including
60 a typeglob. C<SVt_REGEXP> is for regular
61 expressions. C<SVt_INVLIST> is for Perl
62 core internal use only.
64 C<SVt_PVMG> represents a "normal" scalar (not a typeglob, regular expression,
65 or delegate). Since most scalars do not need all the internal fields of a
66 PVMG, we save memory by allocating smaller structs when possible. All the
67 other types are just simpler forms of C<SVt_PVMG>, with fewer internal fields.
68 C<SVt_NULL> can only hold undef. C<SVt_IV> can hold undef, an integer, or a
69 reference. (C<SVt_RV> is an alias for C<SVt_IV>, which exists for backward
70 compatibility.) C<SVt_NV> can hold any of those or a double. C<SVt_PV> can only
71 hold C<undef> or a string. C<SVt_PVIV> is a superset of C<SVt_PV> and C<SVt_IV>.
72 C<SVt_PVNV> is similar. C<SVt_PVMG> can hold anything C<SVt_PVNV> can hold, but it
73 can, but does not have to, be blessed or magical.
75 =for apidoc AmU||SVt_NULL
76 Type flag for scalars. See L</svtype>.
78 =for apidoc AmU||SVt_IV
79 Type flag for scalars. See L</svtype>.
81 =for apidoc AmU||SVt_NV
82 Type flag for scalars. See L</svtype>.
84 =for apidoc AmU||SVt_PV
85 Type flag for scalars. See L</svtype>.
87 =for apidoc AmU||SVt_PVIV
88 Type flag for scalars. See L</svtype>.
90 =for apidoc AmU||SVt_PVNV
91 Type flag for scalars. See L</svtype>.
93 =for apidoc AmU||SVt_PVMG
94 Type flag for scalars. See L</svtype>.
96 =for apidoc AmU||SVt_INVLIST
97 Type flag for scalars. See L</svtype>.
99 =for apidoc AmU||SVt_REGEXP
100 Type flag for regular expressions. See L</svtype>.
102 =for apidoc AmU||SVt_PVGV
103 Type flag for typeglobs. See L</svtype>.
105 =for apidoc AmU||SVt_PVLV
106 Type flag for scalars. See L</svtype>.
108 =for apidoc AmU||SVt_PVAV
109 Type flag for arrays. See L</svtype>.
111 =for apidoc AmU||SVt_PVHV
112 Type flag for hashes. See L</svtype>.
114 =for apidoc AmU||SVt_PVCV
115 Type flag for subroutines. See L</svtype>.
117 =for apidoc AmU||SVt_PVFM
118 Type flag for formats. See L</svtype>.
120 =for apidoc AmU||SVt_PVIO
121 Type flag for I/O objects. See L</svtype>.
125 These are ordered so that the simpler types have a lower value; SvUPGRADE
126 doesn't allow you to upgrade from a higher numbered type to a lower numbered
127 one; also there is code that assumes that anything that has as a PV component
128 has a type numbered >= SVt_PV.
134 /* BIND was here, before INVLIST replaced it. */
137 /* RV was here, before it was merged with IV. */
139 SVt_INVLIST, /* 4, implemented as a PV */
144 /* PVBM was here, before BIND replaced it. */
152 SVt_LAST /* keep last in enum. used to size arrays */
155 /* *** any alterations to the SV types above need to be reflected in
156 * SVt_MASK and the various PL_valid_types_* tables. As of this writing those
157 * tables are in perl.h. There are also two affected names tables in dump.c,
158 * one in B.xs, and 'bodies_by_type[]' in sv.c.
160 * The bits that match 0xf0 are CURRENTLY UNUSED, except that 0xFF means a
161 * freed SV. The bits above that are for flags, like SVf_IOK */
163 #define SVt_MASK 0xf /* smallest bitmask that covers all types */
166 /* Fast Boyer Moore tables are now stored in magic attached to PVMGs */
167 # define SVt_PVBM SVt_PVMG
168 /* Anything wanting to create a reference from clean should ensure that it has
169 a scalar of type SVt_IV now: */
170 # define SVt_RV SVt_IV
173 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
174 so never reaches the clause at the end that uses sv_type_details->body_size
175 to determine whether to call safefree(). Hence body_size can be set
176 non-zero to record the size of HEs, without fear of bogus frees. */
177 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
178 #define HE_SVSLOT SVt_NULL
181 # define SVt_FIRST SVt_NULL /* the type of SV that new_SV() in sv.c returns */
184 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
186 /* typedefs to eliminate some typing */
187 typedef struct he HE;
188 typedef struct hek HEK;
190 /* Using C's structural equivalence to help emulate C++ inheritance here... */
192 /* start with 2 sv-head building blocks */
193 #define _SV_HEAD(ptrtype) \
194 ptrtype sv_any; /* pointer to body */ \
195 U32 sv_refcnt; /* how many references to us */ \
196 U32 sv_flags /* what we are */
199 # define _NV_BODYLESS_UNION NV svu_nv;
201 # define _NV_BODYLESS_UNION
204 #define _SV_HEAD_UNION \
206 char* svu_pv; /* pointer to malloced string */ \
210 SV* svu_rv; /* pointer to another SV */ \
211 struct regexp* svu_rx; \
219 #ifdef DEBUG_LEAKING_SCALARS
220 #define _SV_HEAD_DEBUG ;\
221 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */ \
222 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */ \
223 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */ \
224 UV sv_debug_serial; /* serial number of sv allocation */ \
225 char * sv_debug_file; /* the file where we were allocated */ \
226 SV * sv_debug_parent /* what we were cloned from (ithreads)*/
228 #define _SV_HEAD_DEBUG
231 struct STRUCT_SV { /* struct sv { */
237 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
242 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
247 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
252 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
257 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
262 _SV_HEAD(struct regexp*); /* pointer to regexp body */
267 #undef _SV_HEAD_UNION /* ensure no pollution */
270 =head1 SV Manipulation Functions
272 =for apidoc Am|U32|SvREFCNT|SV* sv
273 Returns the value of the object's reference count. Exposed
274 to perl code via Internals::SvREFCNT().
276 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
277 Increments the reference count of the given SV, returning the SV.
279 All of the following C<SvREFCNT_inc>* macros are optimized versions of
280 C<SvREFCNT_inc>, and can be replaced with C<SvREFCNT_inc>.
282 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
283 Same as C<SvREFCNT_inc>, but can only be used if you know C<sv>
284 is not C<NULL>. Since we don't have to check the NULLness, it's faster
287 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
288 Same as C<SvREFCNT_inc>, but can only be used if you don't need the
289 return value. The macro doesn't need to return a meaningful value.
291 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
292 Same as C<SvREFCNT_inc>, but can only be used if you don't need the return
293 value, and you know that C<sv> is not C<NULL>. The macro doesn't need
294 to return a meaningful value, or check for NULLness, so it's smaller
297 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
298 Same as C<SvREFCNT_inc>, but can only be used with expressions without side
299 effects. Since we don't have to store a temporary value, it's faster.
301 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
302 Same as C<SvREFCNT_inc_simple>, but can only be used if you know C<sv>
303 is not C<NULL>. Since we don't have to check the NULLness, it's faster
306 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
307 Same as C<SvREFCNT_inc_simple>, but can only be used if you don't need the
308 return value. The macro doesn't need to return a meaningful value.
310 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
311 Same as C<SvREFCNT_inc>, but can only be used if you don't need the return
312 value, and you know that C<sv> is not C<NULL>. The macro doesn't need
313 to return a meaningful value, or check for NULLness, so it's smaller
316 =for apidoc Am|void|SvREFCNT_dec|SV* sv
317 Decrements the reference count of the given SV. C<sv> may be C<NULL>.
319 =for apidoc Am|void|SvREFCNT_dec_NN|SV* sv
320 Same as C<SvREFCNT_dec>, but can only be used if you know C<sv>
321 is not C<NULL>. Since we don't have to check the NULLness, it's faster
324 =for apidoc Am|svtype|SvTYPE|SV* sv
325 Returns the type of the SV. See C<L</svtype>>.
327 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
328 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
329 perform the upgrade if necessary. See C<L</svtype>>.
334 #define SvANY(sv) (sv)->sv_any
335 #define SvFLAGS(sv) (sv)->sv_flags
336 #define SvREFCNT(sv) (sv)->sv_refcnt
338 #define SvREFCNT_inc(sv) S_SvREFCNT_inc(MUTABLE_SV(sv))
339 #define SvREFCNT_inc_simple(sv) SvREFCNT_inc(sv)
340 #define SvREFCNT_inc_NN(sv) S_SvREFCNT_inc_NN(MUTABLE_SV(sv))
341 #define SvREFCNT_inc_void(sv) S_SvREFCNT_inc_void(MUTABLE_SV(sv))
343 /* These guys don't need the curly blocks */
344 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
345 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
346 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
347 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
349 #define SvREFCNT_dec(sv) S_SvREFCNT_dec(aTHX_ MUTABLE_SV(sv))
350 #define SvREFCNT_dec_NN(sv) S_SvREFCNT_dec_NN(aTHX_ MUTABLE_SV(sv))
352 #define SVTYPEMASK 0xff
353 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
355 /* Sadly there are some parts of the core that have pointers to already-freed
356 SV heads, and rely on being able to tell that they are now free. So mark
357 them all by using a consistent macro. */
358 #define SvIS_FREED(sv) UNLIKELY(((sv)->sv_flags == SVTYPEMASK))
360 /* this is defined in this peculiar way to avoid compiler warnings.
361 * See the <20121213131428.GD1842@iabyn.com> thread in p5p */
362 #define SvUPGRADE(sv, mt) \
363 ((void)(SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt),1)))
365 #define SVf_IOK 0x00000100 /* has valid public integer value */
366 #define SVf_NOK 0x00000200 /* has valid public numeric value */
367 #define SVf_POK 0x00000400 /* has valid public pointer value */
368 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
370 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
371 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
372 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
373 #define SVp_SCREAM 0x00008000 /* currently unused on plain scalars */
374 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
375 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
376 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
377 subroutine in another package. Set the
378 GvIMPORTED_CV_on() if it needs to be
379 expanded to a real GV */
381 /* SVf_PROTECT is what SVf_READONLY should have been: i.e. modifying
382 * this SV is completely illegal. However, SVf_READONLY (via
383 * Internals::SvREADONLY()) has come to be seen as a flag that can be
384 * temporarily set and unset by the user to indicate e.g. whether a hash
385 * is "locked". Now, Hash::Util et al only set SVf_READONLY, while core
386 * sets both (SVf_READONLY|SVf_PROTECT) to indicate both to core and user
387 * code that this SV should not be messed with.
389 #define SVf_PROTECT 0x00010000 /* very read-only */
390 #define SVs_PADTMP 0x00020000 /* in use as tmp */
391 #define SVs_PADSTALE 0x00040000 /* lexical has gone out of scope;
392 only used when !PADTMP */
393 #define SVs_TEMP 0x00080000 /* mortal (implies string is stealable) */
394 #define SVs_OBJECT 0x00100000 /* is "blessed" */
395 #define SVs_GMG 0x00200000 /* has magical get method */
396 #define SVs_SMG 0x00400000 /* has magical set method */
397 #define SVs_RMG 0x00800000 /* has random magical methods */
399 #define SVf_FAKE 0x01000000 /* 0: glob is just a copy
400 1: SV head arena wasn't malloc()ed
401 2: For PVCV, whether CvUNIQUE(cv)
402 refers to an eval or once only
403 [CvEVAL(cv), CvSPECIAL(cv)]
404 3: HV: informally reserved by DAPM
406 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
407 means that a hv_aux struct is present
408 after the main array */
409 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
410 SVs in final arena cleanup.
411 Set in S_regtry on PL_reg_curpm, so that
412 perl_destruct will skip it.
413 Used for mark and sweep by OP_AASSIGN
415 #define SVf_READONLY 0x08000000 /* may not be modified */
420 #define SVf_THINKFIRST (SVf_READONLY|SVf_PROTECT|SVf_ROK|SVf_FAKE \
423 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
424 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
426 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
428 /* SVf_AMAGIC means that the stash *may* have have overload methods. It's
429 * set each time a function is compiled into a stash, and is reset by the
430 * overload code when called for the first time and finds that there are
431 * no overload methods. Note that this used to be set on the object; but
432 * is now only set on stashes.
434 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
435 #define SVf_IsCOW 0x10000000 /* copy on write (shared hash key if
438 /* Ensure this value does not clash with the GV_ADD* flags in gv.h, or the
439 CV_CKPROTO_* flags in op.c, or the padadd_* flags in pad.h: */
440 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
441 This is also set on RVs whose overloaded
442 stringification is UTF-8. This might
443 only happen as a side effect of SvPV() */
445 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
447 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
448 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
449 been restructured, so sometimes get used as string buffers. */
452 /* Some private flags. */
456 #define SVpav_REAL 0x40000000 /* free old entries */
458 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
460 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
461 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
463 #define SVpav_REIFY 0x80000000 /* can become real */
465 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
466 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
467 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
468 /* pad name vars only */
471 HV* xmg_stash; /* class package */ \
473 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
475 STRLEN xpvlenu_len; /* allocated size */ \
476 char * xpvlenu_pv; /* regexp string */ \
479 #define xpv_len xpv_len_u.xpvlenu_len
482 NV xnv_nv; /* numeric value, if any */
484 line_t xnv_lines; /* used internally by S_scan_subst() */
485 bool xnv_bm_tail; /* an SvVALID (BM) SV has an implicit "\n" */
489 IV xivu_iv; /* integer value */
491 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
492 bool xivu_eval_seen; /* used internally by S_scan_subst() */
497 MAGIC* xmg_magic; /* linked list of magicalness */
498 STRLEN xmg_hash_index; /* used while freeing hash entries */
510 #define xiv_iv xiv_u.xivu_iv
517 #define xuv_uv xuv_u.xivu_uv
525 /* This structure must match the beginning of struct xpvhv in hv.h. */
538 SSize_t xlvu_stargoff;
542 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
543 * y=alem/helem/iter t=tie T=tied HE */
544 char xlv_flags; /* 1 = negative offset 2 = negative len
545 4 = out of range (vec) */
548 #define xlv_targoff xlv_targoff_u.xlvu_targoff
552 IV prev_index; /* caches result of previous invlist_search() */
553 STRLEN iterator; /* Stores where we are in iterating */
554 bool is_offset; /* The data structure for all inversion lists
555 begins with an element for code point U+0000.
556 If this bool is set, the actual list contains
557 that 0; otherwise, the list actually begins
558 with the following element. Thus to invert
559 the list, merely toggle this flag */
562 /* This structure works in 2 ways - regular scalar, or GV with GP */
570 typedef U32 cv_flags_t;
572 #define _XPVCV_COMMON \
580 void (*xcv_xsub) (pTHX_ CV*); \
588 PADLIST * xcv_padlist; \
592 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
593 * compilation) in the lexically enclosing \
595 cv_flags_t xcv_flags; \
596 I32 xcv_depth /* >= 2 indicates recursive call */
598 /* This structure must match XPVCV in cv.h */
609 /* ifp and ofp are normally the same, but sockets need separate streams */
611 /* Cray addresses everything by word boundaries (64 bits) and
612 * code and data pointers cannot be mixed (which is exactly what
613 * Perl_filter_add() tries to do with the dirp), hence the
614 * following union trick (as suggested by Gurusamy Sarathy).
615 * For further information see Geir Johansen's problem report
616 * titled [ID 20000612.002 (#3366)] Perl problem on Cray system
617 * The any pointer (known as IoANY()) will also be a good place
618 * to hang any IO disciplines to.
621 DIR * xiou_dirp; /* for opendir, readdir, etc */
622 void * xiou_any; /* for alignment */
624 /* IV xio_lines is now in IVX $. */
625 IV xio_page; /* $% */
626 IV xio_page_len; /* $= */
627 IV xio_lines_left; /* $- */
628 char * xio_top_name; /* $^ */
629 GV * xio_top_gv; /* $^ */
630 char * xio_fmt_name; /* $~ */
631 GV * xio_fmt_gv; /* $~ */
632 char * xio_bottom_name;/* $^B */
633 GV * xio_bottom_gv; /* $^B */
638 #define xio_dirp xio_dirpu.xiou_dirp
639 #define xio_any xio_dirpu.xiou_any
641 #define IOf_ARGV 1 /* this fp iterates over ARGV */
642 #define IOf_START 2 /* check for null ARGV and substitute '-' */
643 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
644 #define IOf_DIDTOP 8 /* just did top of form */
645 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
646 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
647 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
648 Also, when this is set, SvPVX() is valid */
650 /* The following macros define implementation-independent predicates on SVs. */
653 =for apidoc Am|U32|SvNIOK|SV* sv
654 Returns a U32 value indicating whether the SV contains a number, integer or
657 =for apidoc Am|U32|SvNIOKp|SV* sv
658 Returns a U32 value indicating whether the SV contains a number, integer or
659 double. Checks the B<private> setting. Use C<SvNIOK> instead.
661 =for apidoc Am|void|SvNIOK_off|SV* sv
662 Unsets the NV/IV status of an SV.
664 =for apidoc Am|U32|SvOK|SV* sv
665 Returns a U32 value indicating whether the value is defined. This is
666 only meaningful for scalars.
668 =for apidoc Am|U32|SvIOKp|SV* sv
669 Returns a U32 value indicating whether the SV contains an integer. Checks
670 the B<private> setting. Use C<SvIOK> instead.
672 =for apidoc Am|U32|SvNOKp|SV* sv
673 Returns a U32 value indicating whether the SV contains a double. Checks the
674 B<private> setting. Use C<SvNOK> instead.
676 =for apidoc Am|U32|SvPOKp|SV* sv
677 Returns a U32 value indicating whether the SV contains a character string.
678 Checks the B<private> setting. Use C<SvPOK> instead.
680 =for apidoc Am|U32|SvIOK|SV* sv
681 Returns a U32 value indicating whether the SV contains an integer.
683 =for apidoc Am|void|SvIOK_on|SV* sv
684 Tells an SV that it is an integer.
686 =for apidoc Am|void|SvIOK_off|SV* sv
687 Unsets the IV status of an SV.
689 =for apidoc Am|void|SvIOK_only|SV* sv
690 Tells an SV that it is an integer and disables all other C<OK> bits.
692 =for apidoc Am|void|SvIOK_only_UV|SV* sv
693 Tells an SV that it is an unsigned integer and disables all other C<OK> bits.
695 =for apidoc Am|bool|SvIOK_UV|SV* sv
696 Returns a boolean indicating whether the SV contains an integer that must be
697 interpreted as unsigned. A non-negative integer whose value is within the
698 range of both an IV and a UV may be be flagged as either C<SvUOK> or C<SVIOK>.
700 =for apidoc Am|bool|SvUOK|SV* sv
701 Returns a boolean indicating whether the SV contains an integer that must be
702 interpreted as unsigned. A non-negative integer whose value is within the
703 range of both an IV and a UV may be be flagged as either C<SvUOK> or C<SVIOK>.
705 =for apidoc Am|bool|SvIOK_notUV|SV* sv
706 Returns a boolean indicating whether the SV contains a signed integer.
708 =for apidoc Am|U32|SvNOK|SV* sv
709 Returns a U32 value indicating whether the SV contains a double.
711 =for apidoc Am|void|SvNOK_on|SV* sv
712 Tells an SV that it is a double.
714 =for apidoc Am|void|SvNOK_off|SV* sv
715 Unsets the NV status of an SV.
717 =for apidoc Am|void|SvNOK_only|SV* sv
718 Tells an SV that it is a double and disables all other OK bits.
720 =for apidoc Am|U32|SvPOK|SV* sv
721 Returns a U32 value indicating whether the SV contains a character
724 =for apidoc Am|void|SvPOK_on|SV* sv
725 Tells an SV that it is a string.
727 =for apidoc Am|void|SvPOK_off|SV* sv
728 Unsets the PV status of an SV.
730 =for apidoc Am|void|SvPOK_only|SV* sv
731 Tells an SV that it is a string and disables all other C<OK> bits.
732 Will also turn off the UTF-8 status.
734 =for apidoc Am|bool|SvVOK|SV* sv
735 Returns a boolean indicating whether the SV contains a v-string.
737 =for apidoc Am|U32|SvOOK|SV* sv
738 Returns a U32 indicating whether the pointer to the string buffer is offset.
739 This hack is used internally to speed up removal of characters from the
740 beginning of a C<SvPV>. When C<SvOOK> is true, then the start of the
741 allocated string buffer is actually C<SvOOK_offset()> bytes before C<SvPVX>.
742 This offset used to be stored in C<SvIVX>, but is now stored within the spare
745 =for apidoc Am|U32|SvROK|SV* sv
746 Tests if the SV is an RV.
748 =for apidoc Am|void|SvROK_on|SV* sv
749 Tells an SV that it is an RV.
751 =for apidoc Am|void|SvROK_off|SV* sv
752 Unsets the RV status of an SV.
754 =for apidoc Am|SV*|SvRV|SV* sv
755 Dereferences an RV to return the SV.
757 =for apidoc Am|IV|SvIVX|SV* sv
758 Returns the raw value in the SV's IV slot, without checks or conversions.
759 Only use when you are sure C<SvIOK> is true. See also C<L</SvIV>>.
761 =for apidoc Am|UV|SvUVX|SV* sv
762 Returns the raw value in the SV's UV slot, without checks or conversions.
763 Only use when you are sure C<SvIOK> is true. See also C<L</SvUV>>.
765 =for apidoc Am|NV|SvNVX|SV* sv
766 Returns the raw value in the SV's NV slot, without checks or conversions.
767 Only use when you are sure C<SvNOK> is true. See also C<L</SvNV>>.
769 =for apidoc Am|char*|SvPVX|SV* sv
770 Returns a pointer to the physical string in the SV. The SV must contain a
771 string. Prior to 5.9.3 it is not safe
772 to execute this macro unless the SV's
775 This is also used to store the name of an autoloaded subroutine in an XS
776 AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
778 =for apidoc Am|STRLEN|SvCUR|SV* sv
779 Returns the length of the string which is in the SV. See C<L</SvLEN>>.
781 =for apidoc Am|STRLEN|SvLEN|SV* sv
782 Returns the size of the string buffer in the SV, not including any part
783 attributable to C<SvOOK>. See C<L</SvCUR>>.
785 =for apidoc Am|char*|SvEND|SV* sv
786 Returns a pointer to the spot just after the last character in
787 the string which is in the SV, where there is usually a trailing
788 C<NUL> character (even though Perl scalars do not strictly require it).
789 See C<L</SvCUR>>. Access the character as C<*(SvEND(sv))>.
791 Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
794 =for apidoc Am|HV*|SvSTASH|SV* sv
795 Returns the stash of the SV.
797 =for apidoc Am|void|SvIV_set|SV* sv|IV val
798 Set the value of the IV pointer in sv to val. It is possible to perform
799 the same function of this macro with an lvalue assignment to C<SvIVX>.
800 With future Perls, however, it will be more efficient to use
801 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
803 =for apidoc Am|void|SvNV_set|SV* sv|NV val
804 Set the value of the NV pointer in C<sv> to val. See C<L</SvIV_set>>.
806 =for apidoc Am|void|SvPV_set|SV* sv|char* val
807 This is probably not what you want to use, you probably wanted
808 L</sv_usepvn_flags> or L</sv_setpvn> or L</sv_setpvs>.
810 Set the value of the PV pointer in C<sv> to the Perl allocated
811 C<NUL>-terminated string C<val>. See also C<L</SvIV_set>>.
813 Remember to free the previous PV buffer. There are many things to check.
814 Beware that the existing pointer may be involved in copy-on-write or other
815 mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or
816 C<SvPV_force> (or check the C<SvIsCOW> flag) first to make sure this
817 modification is safe. Then finally, if it is not a COW, call C<SvPV_free> to
818 free the previous PV buffer.
820 =for apidoc Am|void|SvUV_set|SV* sv|UV val
821 Set the value of the UV pointer in C<sv> to val. See C<L</SvIV_set>>.
823 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
824 Set the value of the RV pointer in C<sv> to val. See C<L</SvIV_set>>.
826 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
827 Set the value of the MAGIC pointer in C<sv> to val. See C<L</SvIV_set>>.
829 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
830 Set the value of the STASH pointer in C<sv> to val. See C<L</SvIV_set>>.
832 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
833 Set the current length of the string which is in the SV. See C<L</SvCUR>>
836 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
837 Set the size of the string buffer for the SV. See C<L</SvLEN>>.
842 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
843 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
844 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
845 SVp_IOK|SVp_NOK|SVf_IVisUV))
847 #define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv))
848 #define assert_not_glob(sv) assert_(!isGV_with_GP(sv))
850 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK || isREGEXP(sv))
851 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
852 SvFLAGS(sv) &= ~(SVf_OK| \
853 SVf_IVisUV|SVf_UTF8), \
855 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
856 SvFLAGS(sv) &= ~(SVf_OK| \
860 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
861 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
862 #define SvIOKp_on(sv) (assert_not_glob(sv) \
863 SvFLAGS(sv) |= SVp_IOK)
864 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
865 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
866 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
867 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
868 SvFLAGS(sv) |= SVp_POK)
870 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
871 #define SvIOK_on(sv) (assert_not_glob(sv) \
872 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
873 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
874 #define SvIOK_only(sv) (SvOK_off(sv), \
875 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
876 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
877 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
879 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
880 == (SVf_IOK|SVf_IVisUV))
881 #define SvUOK(sv) SvIOK_UV(sv)
882 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
885 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
886 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
887 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
889 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
890 #define SvNOK_on(sv) (assert_not_glob(sv) \
891 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
892 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
893 #define SvNOK_only(sv) (SvOK_off(sv), \
894 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
897 =for apidoc Am|U32|SvUTF8|SV* sv
898 Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
899 properly, this indicates whether or not the SV contains UTF-8 encoded data.
900 You should use this I<after> a call to C<SvPV()> or one of its variants, in
901 case any call to string overloading updates the internal flag.
903 If you want to take into account the L<bytes> pragma, use C<L</DO_UTF8>>
906 =for apidoc Am|void|SvUTF8_on|SV *sv
907 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
908 Do not use frivolously.
910 =for apidoc Am|void|SvUTF8_off|SV *sv
911 Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
912 Do not use frivolously.
914 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
915 Tells an SV that it is a string and disables all other C<OK> bits,
916 and leaves the UTF-8 status as it was.
921 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
923 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
924 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
925 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
927 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
928 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
929 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
930 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
931 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
932 SvFLAGS(sv) &= ~(SVf_OK| \
933 SVf_IVisUV|SVf_UTF8), \
934 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
935 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
936 SvFLAGS(sv) &= ~(SVf_OK| \
938 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
940 #define SvVOK(sv) (SvMAGICAL(sv) \
941 && mg_find(sv,PERL_MAGIC_vstring))
942 /* returns the vstring magic, if any */
943 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
944 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
946 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
947 #define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
948 #define SvOOK_off(sv) ((void)(SvOOK(sv) && (sv_backoff(sv),0)))
950 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
951 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
952 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
954 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
955 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
956 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
958 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
959 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
960 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
962 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
963 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
964 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
966 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
967 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
968 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
970 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
971 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
972 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
974 #define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
975 HvAMAGIC(SvSTASH(SvRV(sv))))
977 /* To be used on the stashes themselves: */
978 #define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
979 #define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
980 #define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
983 /* "nog" means "doesn't have get magic" */
984 #define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
985 #define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
986 #define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
987 #define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
988 #define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
990 #define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
991 #define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
992 #define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
993 #define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
994 #define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
996 #define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
997 #define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
999 #define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
1000 #define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1002 #define SvPOK_pure_nogthink(sv) \
1003 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1004 #define SvPOK_utf8_pure_nogthink(sv) \
1005 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1006 #define SvPOK_byte_pure_nogthink(sv) \
1007 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1010 =for apidoc Am|U32|SvGAMAGIC|SV* sv
1012 Returns true if the SV has get magic or
1013 overloading. If either is true then
1014 the scalar is active data, and has the potential to return a new value every
1015 time it is accessed. Hence you must be careful to
1016 only read it once per user logical operation and work
1017 with that returned value. If neither is true then
1018 the scalar's value cannot change unless written to.
1023 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1025 #define Gv_AMG(stash) \
1026 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
1028 : (HvAMAGIC_off(stash), 0))
1030 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1031 == (SVf_ROK|SVprv_WEAKREF))
1032 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1033 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1035 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
1036 == (SVf_ROK|SVprv_PCS_IMPORTED))
1037 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
1038 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
1041 =for apidoc m|U32|SvTHINKFIRST|SV *sv
1043 A quick flag check to see whether an C<sv> should be passed to C<sv_force_normal>
1044 to be "downgraded" before C<SvIVX> or C<SvPVX> can be modified directly.
1046 For example, if your scalar is a reference and you want to modify the C<SvIVX>
1047 slot, you can't just do C<SvROK_off>, as that will leak the referent.
1049 This is used internally by various sv-modifying functions, such as
1050 C<sv_setsv>, C<sv_setiv> and C<sv_pvn_force>.
1052 One case that this does not handle is a gv without SvFAKE set. After
1054 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
1056 it will still be a gv.
1058 C<SvTHINKFIRST> sometimes produces false positives. In those cases
1059 C<sv_force_normal> does nothing.
1064 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1067 #define SvPADMY(sv) !(SvFLAGS(sv) & SVs_PADTMP)
1069 # define SvPADMY_on(sv) SvPADTMP_off(sv)
1072 #define SvPADTMP(sv) (SvFLAGS(sv) & (SVs_PADTMP))
1073 #define SvPADSTALE(sv) (SvFLAGS(sv) & (SVs_PADSTALE))
1075 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1076 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1077 #define SvPADSTALE_on(sv) S_SvPADSTALE_on(MUTABLE_SV(sv))
1078 #define SvPADSTALE_off(sv) S_SvPADSTALE_off(MUTABLE_SV(sv))
1080 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1081 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1082 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1084 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1085 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1086 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1089 =for apidoc Am|U32|SvREADONLY|SV* sv
1090 Returns true if the argument is readonly, otherwise returns false.
1091 Exposed to to perl code via Internals::SvREADONLY().
1093 =for apidoc Am|U32|SvREADONLY_on|SV* sv
1094 Mark an object as readonly. Exactly what this means depends on the object
1095 type. Exposed to perl code via Internals::SvREADONLY().
1097 =for apidoc Am|U32|SvREADONLY_off|SV* sv
1098 Mark an object as not-readonly. Exactly what this mean depends on the
1099 object type. Exposed to perl code via Internals::SvREADONLY().
1104 #define SvREADONLY(sv) (SvFLAGS(sv) & (SVf_READONLY|SVf_PROTECT))
1106 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= (SVf_READONLY|SVf_PROTECT))
1107 # define SvREADONLY_off(sv) (SvFLAGS(sv) &=~(SVf_READONLY|SVf_PROTECT))
1109 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1110 # define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1113 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1114 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1115 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1118 # define SvCOMPILED(sv) 0
1119 # define SvCOMPILED_on(sv)
1120 # define SvCOMPILED_off(sv)
1124 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1125 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
1126 assert(SvTYPE(_svtail) != SVt_PVAV); \
1127 assert(SvTYPE(_svtail) != SVt_PVHV); \
1128 assert(!(SvFLAGS(_svtail) & (SVf_NOK|SVp_NOK))); \
1129 assert(SvVALID(_svtail)); \
1130 ((XPVNV*)SvANY(_svtail))->xnv_u.xnv_bm_tail; \
1133 # define SvTAIL(_svtail) (((XPVNV*)SvANY(_svtail))->xnv_u.xnv_bm_tail)
1136 /* Does the SV have a Boyer-Moore table attached as magic?
1137 * 'VALID' is a poor name, but is kept for historical reasons. */
1138 #define SvVALID(_svvalid) ( \
1140 && SvSMAGICAL(_svvalid) \
1141 && SvMAGIC(_svvalid) \
1142 && (SvMAGIC(_svvalid)->mg_type == PERL_MAGIC_bm \
1143 || mg_find(_svvalid, PERL_MAGIC_bm)) \
1146 #define SvRVx(sv) SvRV(sv)
1148 #ifdef PERL_DEBUG_COW
1149 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1150 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1151 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1152 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1153 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1154 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1155 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1156 /* Don't test the core XS code yet. */
1157 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1158 # define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
1160 # define SvPVX(sv) SvPVX_mutable(sv)
1162 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1163 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1164 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1166 # define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1167 # define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
1169 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1170 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1172 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1173 /* These get expanded inside other macros that already use a variable _sv */
1174 # define SvPVX(sv) \
1175 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1176 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
1177 assert(!isGV_with_GP(_svpvx)); \
1178 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1179 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
1180 &((_svpvx)->sv_u.svu_pv); \
1182 # define SvCUR(sv) \
1183 (*({ const SV *const _svcur = (const SV *)(sv); \
1184 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK] \
1185 || SvTYPE(_svcur) == SVt_REGEXP); \
1186 assert(!isGV_with_GP(_svcur)); \
1187 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1188 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1189 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1191 # define SvIVX(sv) \
1192 (*({ const SV *const _svivx = (const SV *)(sv); \
1193 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
1194 assert(!isGV_with_GP(_svivx)); \
1195 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1197 # define SvUVX(sv) \
1198 (*({ const SV *const _svuvx = (const SV *)(sv); \
1199 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
1200 assert(!isGV_with_GP(_svuvx)); \
1201 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1203 # define SvNVX(sv) \
1204 (*({ const SV *const _svnvx = (const SV *)(sv); \
1205 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
1206 assert(!isGV_with_GP(_svnvx)); \
1207 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1210 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1211 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1212 assert(!isGV_with_GP(_svrv)); \
1213 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1214 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1215 &((_svrv)->sv_u.svu_rv); \
1217 # define SvRV_const(sv) \
1218 ({ const SV *const _svrv = (const SV *)(sv); \
1219 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1220 assert(!isGV_with_GP(_svrv)); \
1221 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1222 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1223 (_svrv)->sv_u.svu_rv; \
1225 # define SvMAGIC(sv) \
1226 (*({ const SV *const _svmagic = (const SV *)(sv); \
1227 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1228 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1230 # define SvSTASH(sv) \
1231 (*({ const SV *const _svstash = (const SV *)(sv); \
1232 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1233 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1236 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1237 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1238 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1239 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1240 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1241 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1242 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1243 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1244 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1249 /* Given that these two are new, there can't be any existing code using them
1251 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1252 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1254 /* Except for the poison code, which uses & to scribble over the pointer after
1255 free() is called. */
1256 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1257 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1260 #define SvIVXx(sv) SvIVX(sv)
1261 #define SvUVXx(sv) SvUVX(sv)
1262 #define SvNVXx(sv) SvNVX(sv)
1263 #define SvPVXx(sv) SvPVX(sv)
1264 #define SvLENx(sv) SvLEN(sv)
1265 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1268 /* Ask a scalar nicely to try to become an IV, if possible.
1269 Not guaranteed to stay returning void */
1270 /* Macro won't actually call sv_2iv if already IOK */
1271 #define SvIV_please(sv) \
1272 STMT_START {if (!SvIOKp(sv) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK))) \
1273 (void) SvIV(sv); } STMT_END
1274 #define SvIV_please_nomg(sv) \
1275 (!(SvFLAGS(sv) & (SVf_IOK|SVp_IOK)) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK)) \
1276 ? (sv_2iv_flags(sv, 0), SvIOK(sv)) \
1278 #define SvIV_set(sv, val) \
1280 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1281 assert(!isGV_with_GP(sv)); \
1282 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1283 #define SvNV_set(sv, val) \
1285 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
1286 assert(!isGV_with_GP(sv)); \
1287 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1288 #define SvPV_set(sv, val) \
1290 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1291 assert(!isGV_with_GP(sv)); \
1292 assert(!(SvTYPE(sv) == SVt_PVIO \
1293 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1294 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1295 #define SvUV_set(sv, val) \
1297 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1298 assert(!isGV_with_GP(sv)); \
1299 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1300 #define SvRV_set(sv, val) \
1302 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
1303 assert(!isGV_with_GP(sv)); \
1304 assert(!(SvTYPE(sv) == SVt_PVIO \
1305 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1306 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1307 #define SvMAGIC_set(sv, val) \
1308 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1309 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1310 #define SvSTASH_set(sv, val) \
1311 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1312 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1313 #define SvCUR_set(sv, val) \
1315 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK] \
1316 || SvTYPE(sv) == SVt_REGEXP); \
1317 assert(!isGV_with_GP(sv)); \
1318 assert(!(SvTYPE(sv) == SVt_PVIO \
1319 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1320 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1321 #define SvLEN_set(sv, val) \
1323 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1324 assert(!isGV_with_GP(sv)); \
1325 assert(!(SvTYPE(sv) == SVt_PVIO \
1326 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1327 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1328 #define SvEND_set(sv, val) \
1329 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1330 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1332 #define SvPV_renew(sv,n) \
1333 STMT_START { SvLEN_set(sv, n); \
1334 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1335 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1336 (MEM_SIZE)((n))))); \
1339 #define SvPV_shrink_to_cur(sv) STMT_START { \
1340 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1341 SvPV_renew(sv, _lEnGtH); \
1344 #define SvPV_free(sv) \
1346 assert(SvTYPE(sv) >= SVt_PV); \
1348 assert(!SvROK(sv)); \
1349 if(UNLIKELY(SvOOK(sv))) { \
1351 SvOOK_offset(sv, zok); \
1352 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1353 SvFLAGS(sv) &= ~SVf_OOK; \
1355 Safefree(SvPVX(sv)); \
1360 /* Code that crops up in three places to take a scalar and ready it to hold
1362 # define prepare_SV_for_RV(sv) \
1364 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1365 sv_upgrade(sv, SVt_IV); \
1366 else if (SvTYPE(sv) >= SVt_PV) { \
1375 # define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1378 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1379 # define BmUSEFUL(sv) \
1380 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1381 assert(SvTYPE(_bmuseful) >= SVt_PVIV); \
1382 assert(SvVALID(_bmuseful)); \
1383 assert(!SvIOK(_bmuseful)); \
1384 &(((XPVIV*) SvANY(_bmuseful))->xiv_u.xivu_iv); \
1387 # define BmUSEFUL(sv) ((XPVIV*) SvANY(sv))->xiv_u.xivu_iv
1392 # define BmRARE(sv) 0
1393 # define BmPREVIOUS(sv) 0
1396 #define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1398 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1399 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1400 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1401 #define LvSTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff_u.xlvu_stargoff
1402 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1403 #define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
1405 #define IoIFP(sv) (sv)->sv_u.svu_fp
1406 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1407 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1408 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1409 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
1410 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1411 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1412 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1413 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1414 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1415 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1416 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1417 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1418 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1419 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1420 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1422 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1423 #define IoTYPE_RDONLY '<'
1424 #define IoTYPE_WRONLY '>'
1425 #define IoTYPE_RDWR '+'
1426 #define IoTYPE_APPEND 'a'
1427 #define IoTYPE_PIPE '|'
1428 #define IoTYPE_STD '-' /* stdin or stdout */
1429 #define IoTYPE_SOCKET 's'
1430 #define IoTYPE_CLOSED ' '
1431 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1432 #define IoTYPE_NUMERIC '#' /* fdopen */
1435 =for apidoc Am|bool|SvTAINTED|SV* sv
1436 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1439 =for apidoc Am|void|SvTAINTED_on|SV* sv
1440 Marks an SV as tainted if tainting is enabled.
1442 =for apidoc Am|void|SvTAINTED_off|SV* sv
1443 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1444 some of Perl's fundamental security features. XS module authors should not
1445 use this function unless they fully understand all the implications of
1446 unconditionally untainting the value. Untainting should be done in the
1447 standard perl fashion, via a carefully crafted regexp, rather than directly
1448 untainting variables.
1450 =for apidoc Am|void|SvTAINT|SV* sv
1451 Taints an SV if tainting is enabled, and if some input to the current
1452 expression is tainted--usually a variable, but possibly also implicit
1453 inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1454 the outputs of an expression in a pessimistic fashion; i.e., without paying
1455 attention to precisely which outputs are influenced by which inputs.
1460 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1462 #ifdef NO_TAINT_SUPPORT
1463 # define SvTAINTED(sv) 0
1465 # define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1467 #define SvTAINTED_on(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_taint(sv);} }STMT_END
1468 #define SvTAINTED_off(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_untaint(sv);} }STMT_END
1470 #define SvTAINT(sv) \
1472 assert(TAINTING_get || !TAINT_get); \
1473 if (UNLIKELY(TAINT_get)) \
1478 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1479 Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1480 only a string (C<SvPOK_only>), by hook or by crook. You need force if you are
1481 going to update the C<SvPVX> directly. Processes get magic.
1483 Note that coercing an arbitrary scalar into a plain PV will potentially
1484 strip useful data from it. For example if the SV was C<SvROK>, then the
1485 referent will have its reference count decremented, and the SV itself may
1486 be converted to an C<SvPOK> scalar with a string buffer containing a value
1487 such as C<"ARRAY(0x1234)">.
1489 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1490 Like C<SvPV_force>, but doesn't process get magic.
1492 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1493 Returns a pointer to the string in the SV, or a stringified form of
1494 the SV if the SV does not contain a string. The SV may cache the
1495 stringified version becoming C<SvPOK>. Handles 'get' magic. The
1496 C<len> variable will be set to the length of the string (this is a macro, so
1497 don't use C<&len>). See also C<L</SvPVx>> for a version which guarantees to
1498 evaluate C<sv> only once.
1500 Note that there is no guarantee that the return value of C<SvPV()> is
1501 equal to C<SvPVX(sv)>, or that C<SvPVX(sv)> contains valid data, or that
1502 successive calls to C<SvPV(sv)> will return the same pointer value each
1503 time. This is due to the way that things like overloading and
1504 Copy-On-Write are handled. In these cases, the return value may point to
1505 a temporary buffer or similar. If you absolutely need the C<SvPVX> field to
1506 be valid (for example, if you intend to write to it), then see
1509 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1510 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1511 Only use this if C<sv> is an expression with side effects, otherwise use the
1512 more efficient C<SvPV>.
1514 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1515 Like C<SvPV> but doesn't process magic.
1517 =for apidoc Am|char*|SvPV_nolen|SV* sv
1518 Like C<SvPV> but doesn't set a length variable.
1520 =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1521 Like C<SvPV_nolen> but doesn't process magic.
1523 =for apidoc Am|IV|SvIV|SV* sv
1524 Coerces the given SV to an integer and returns it. See C<L</SvIVx>> for a
1525 version which guarantees to evaluate C<sv> only once.
1527 =for apidoc Am|IV|SvIV_nomg|SV* sv
1528 Like C<SvIV> but doesn't process magic.
1530 =for apidoc Am|IV|SvIVx|SV* sv
1531 Coerces the given SV to an integer and returns it.
1532 Guarantees to evaluate C<sv> only once. Only use
1533 this if C<sv> is an expression with side effects,
1534 otherwise use the more efficient C<SvIV>.
1536 =for apidoc Am|NV|SvNV|SV* sv
1537 Coerce the given SV to a double and return it. See C<L</SvNVx>> for a version
1538 which guarantees to evaluate C<sv> only once.
1540 =for apidoc Am|NV|SvNV_nomg|SV* sv
1541 Like C<SvNV> but doesn't process magic.
1543 =for apidoc Am|NV|SvNVx|SV* sv
1544 Coerces the given SV to a double and returns it.
1545 Guarantees to evaluate C<sv> only once. Only use
1546 this if C<sv> is an expression with side effects,
1547 otherwise use the more efficient C<SvNV>.
1549 =for apidoc Am|UV|SvUV|SV* sv
1550 Coerces the given SV to an unsigned integer and returns it. See C<L</SvUVx>>
1551 for a version which guarantees to evaluate C<sv> only once.
1553 =for apidoc Am|UV|SvUV_nomg|SV* sv
1554 Like C<SvUV> but doesn't process magic.
1556 =for apidoc Am|UV|SvUVx|SV* sv
1557 Coerces the given SV to an unsigned integer and
1558 returns it. Guarantees to evaluate C<sv> only once. Only
1559 use this if C<sv> is an expression with side effects,
1560 otherwise use the more efficient C<SvUV>.
1562 =for apidoc Am|bool|SvTRUE|SV* sv
1563 Returns a boolean indicating whether Perl would evaluate the SV as true or
1564 false. See C<L</SvOK>> for a defined/undefined test. Handles 'get' magic
1565 unless the scalar is already C<SvPOK>, C<SvIOK> or C<SvNOK> (the public, not the
1568 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
1569 Returns a boolean indicating whether Perl would evaluate the SV as true or
1570 false. See C<L</SvOK>> for a defined/undefined test. Does not handle 'get' magic.
1572 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1573 Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
1575 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1576 Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
1578 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1579 Like C<SvPV_nolen>, but converts C<sv> to UTF-8 first if necessary.
1581 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1582 Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary.
1584 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1585 Like C<SvPV>, but converts C<sv> to byte representation first if necessary.
1587 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1588 Like C<SvPV_nolen>, but converts C<sv> to byte representation first if necessary.
1590 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1591 Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
1592 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8_force>
1595 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1596 Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
1597 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8>
1600 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1601 Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary.
1602 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte_force>
1605 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1606 Like C<SvPV>, but converts C<sv> to byte representation first if necessary.
1607 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte>
1610 =for apidoc Am|U32|SvIsCOW|SV* sv
1611 Returns a U32 value indicating whether the SV is Copy-On-Write (either shared
1612 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1615 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1616 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1619 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1620 Like C<sv_catpvn> but doesn't process magic.
1622 =for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1623 Like C<sv_catpv> but doesn't process magic.
1625 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1626 Like C<sv_setsv> but doesn't process magic.
1628 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1629 Like C<sv_catsv> but doesn't process magic.
1631 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1633 Like C<sv_utf8_upgrade>, but doesn't do magic on C<sv>.
1638 /* Let us hope that bitmaps for UV and IV are the same */
1639 #define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1640 #define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1641 #define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
1643 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1644 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1645 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1649 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1650 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1651 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1653 #define SvPV_flags(sv, lp, flags) \
1655 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1656 #define SvPV_flags_const(sv, lp, flags) \
1658 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1659 (const char*) sv_2pv_flags(sv, &lp, (flags|SV_CONST_RETURN)))
1660 #define SvPV_flags_const_nolen(sv, flags) \
1662 ? SvPVX_const(sv) : \
1663 (const char*) sv_2pv_flags(sv, 0, (flags|SV_CONST_RETURN)))
1664 #define SvPV_flags_mutable(sv, lp, flags) \
1666 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1667 sv_2pv_flags(sv, &lp, (flags|SV_MUTABLE_RETURN)))
1669 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1670 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1671 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1673 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1674 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1676 #define SvPV_force_flags(sv, lp, flags) \
1677 (SvPOK_pure_nogthink(sv) \
1678 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1680 #define SvPV_force_flags_nolen(sv, flags) \
1681 (SvPOK_pure_nogthink(sv) \
1682 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1684 #define SvPV_force_flags_mutable(sv, lp, flags) \
1685 (SvPOK_pure_nogthink(sv) \
1686 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1687 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1689 #define SvPV_nolen(sv) \
1691 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1693 /* "_nomg" in these defines means no mg_get() */
1694 #define SvPV_nomg_nolen(sv) \
1696 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1698 #define SvPV_nolen_const(sv) \
1700 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1702 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1703 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1704 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1708 #define SvPVutf8(sv, lp) \
1709 (SvPOK_utf8_nog(sv) \
1710 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1712 #define SvPVutf8_force(sv, lp) \
1713 (SvPOK_utf8_pure_nogthink(sv) \
1714 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1716 #define SvPVutf8_nolen(sv) \
1717 (SvPOK_utf8_nog(sv) \
1718 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1722 #define SvPVbyte(sv, lp) \
1723 (SvPOK_byte_nog(sv) \
1724 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1726 #define SvPVbyte_force(sv, lp) \
1727 (SvPOK_byte_pure_nogthink(sv) \
1728 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1730 #define SvPVbyte_nolen(sv) \
1731 (SvPOK_byte_nog(sv) \
1732 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1735 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1736 * var to evaluate the arg once; failing that, use a global if possible;
1737 * failing that, call a function to do the work
1740 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1741 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1742 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1744 #define SvTRUE(sv) (LIKELY(sv) && (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))))
1745 #define SvTRUE_nomg(sv) (LIKELY(sv) && ( SvTRUE_common(sv, sv_2bool_nomg(sv))))
1746 #define SvTRUE_NN(sv) (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv)))
1747 #define SvTRUE_nomg_NN(sv) ( SvTRUE_common(sv, sv_2bool_nomg(sv)))
1748 #define SvTRUE_common(sv,fallback) ( \
1753 : (SvFLAGS(sv) & (SVf_IOK|SVf_NOK)) \
1754 ? ( (SvIOK(sv) && SvIVX(sv) != 0) \
1755 || (SvNOK(sv) && SvNVX(sv) != 0.0)) \
1758 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1760 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1761 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1762 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1763 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1764 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1765 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1766 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1767 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1768 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1769 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1770 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1771 # define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
1773 #else /* __GNUC__ */
1775 /* These inlined macros use globals, which will require a thread
1776 * declaration in user code, so we avoid them under threads */
1778 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1779 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1780 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1781 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1782 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1783 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1784 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1785 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1786 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1787 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1788 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1789 # define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
1790 #endif /* __GNU__ */
1792 #define SvPVXtrue(sv) ( \
1793 ((XPV*)SvANY((sv))) \
1795 ((XPV*)SvANY((sv)))->xpv_cur > 1 \
1797 ((XPV*)SvANY((sv)))->xpv_cur \
1798 && *(sv)->sv_u.svu_pv != '0' \
1803 #define SvIsCOW(sv) (SvFLAGS(sv) & SVf_IsCOW)
1804 #define SvIsCOW_on(sv) (SvFLAGS(sv) |= SVf_IsCOW)
1805 #define SvIsCOW_off(sv) (SvFLAGS(sv) &= ~SVf_IsCOW)
1806 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1808 #define SvSHARED_HEK_FROM_PV(pvx) \
1809 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1810 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1812 /* flag values for sv_*_flags functions */
1813 #define SV_UTF8_NO_ENCODING 0 /* No longer used */
1814 #define SV_IMMEDIATE_UNREF 1
1816 #define SV_COW_DROP_PV 4
1817 #define SV_NOSTEAL 16
1818 #define SV_CONST_RETURN 32
1819 #define SV_MUTABLE_RETURN 64
1820 #define SV_SMAGIC 128
1821 #define SV_HAS_TRAILING_NUL 256
1822 #define SV_COW_SHARED_HASH_KEYS 512
1823 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1824 /* XXX This flag actually enabled for any COW. But it appears not to do
1825 anything. Can we just remove it? Or will it serve some future
1827 #define SV_COW_OTHER_PVS 1024
1828 /* Make sv_2pv_flags return NULL if something is undefined. */
1829 #define SV_UNDEF_RETURNS_NULL 2048
1830 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1831 * This is used when the caller has already determined it is, and avoids
1833 #define SV_FORCE_UTF8_UPGRADE 4096
1834 /* if (after resolving magic etc), the SV is found to be overloaded,
1835 * don't call the overload magic, just return as-is */
1836 #define SV_SKIP_OVERLOAD 8192
1837 #define SV_CATBYTES 16384
1838 #define SV_CATUTF8 32768
1840 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1841 So only default to doing the COW setup if we're in the core.
1844 # ifndef SV_DO_COW_SVSETSV
1845 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1849 #ifndef SV_DO_COW_SVSETSV
1850 # define SV_DO_COW_SVSETSV 0
1854 #define sv_unref(sv) sv_unref_flags(sv, 0)
1855 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1856 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1857 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1859 /* We are about to replace the SV's current value. So if it's copy on write
1860 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1861 the value is about to get thrown away, so drop the PV rather than go to
1862 the effort of making a read-write copy only for it to get immediately
1865 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1866 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1868 #ifdef PERL_COPY_ON_WRITE
1869 # define SvCANCOW(sv) \
1871 ? SvLEN(sv) ? CowREFCNT(sv) != SV_COW_REFCNT_MAX : 1 \
1872 : (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS \
1873 && SvCUR(sv)+1 < SvLEN(sv))
1874 /* Note: To allow 256 COW "copies", a refcnt of 0 means 1. */
1875 # define CowREFCNT(sv) (*(U8 *)(SvPVX(sv)+SvLEN(sv)-1))
1876 # define SV_COW_REFCNT_MAX ((1 << sizeof(U8)*8) - 1)
1877 # define CAN_COW_MASK (SVf_POK|SVf_ROK|SVp_POK|SVf_FAKE| \
1878 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_PROTECT)
1881 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1883 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1884 sv_force_normal_flags(sv, 0)
1887 /* all these 'functions' are now just macros */
1889 #define sv_pv(sv) SvPV_nolen(sv)
1890 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1891 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1893 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1894 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1895 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1896 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1897 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
1898 #define sv_setsv(dsv, ssv) \
1899 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1900 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1901 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1902 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1903 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1904 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1905 #define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1906 #define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
1907 #define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
1908 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1909 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1910 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1911 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1912 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1913 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1914 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1915 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1916 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1917 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1918 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1919 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1920 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
1921 #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
1922 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
1923 #define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
1924 #define sv_insert(bigstr, offset, len, little, littlelen) \
1925 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1926 (littlelen), SV_GMAGIC)
1927 #define sv_mortalcopy(sv) \
1928 Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1929 #define sv_cathek(sv,hek) \
1931 HEK * const bmxk = hek; \
1932 sv_catpvn_flags(sv, HEK_KEY(bmxk), HEK_LEN(bmxk), \
1933 HEK_UTF8(bmxk) ? SV_CATUTF8 : SV_CATBYTES); \
1936 /* Should be named SvCatPVN_utf8_upgrade? */
1937 #define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
1940 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
1942 sv_setpvn(nsv, sstr, slen); \
1944 sv_utf8_upgrade(nsv); \
1945 sv_catsv_nomg(dsv, nsv); \
1947 #define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \
1948 sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES)
1950 #if defined(PERL_CORE) || defined(PERL_EXT)
1951 # define sv_or_pv_len_utf8(sv, pv, bytelen) \
1953 ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \
1958 =for apidoc Am|SV*|newRV_inc|SV* sv
1960 Creates an RV wrapper for an SV. The reference count for the original SV is
1966 #define newRV_inc(sv) newRV(sv)
1968 /* the following macros update any magic values this C<sv> is associated with */
1971 =head1 Magical Functions
1973 =for apidoc Am|void|SvGETMAGIC|SV* sv
1974 Invokes C<mg_get> on an SV if it has 'get' magic. For example, this
1975 will call C<FETCH> on a tied variable. This macro evaluates its
1976 argument more than once.
1978 =for apidoc Am|void|SvSETMAGIC|SV* sv
1979 Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary
1980 after modifying a scalar, in case it is a magical variable like C<$|>
1981 or a tied variable (it calls C<STORE>). This macro evaluates its
1982 argument more than once.
1984 =for apidoc Am|void|SvSetSV|SV* dsv|SV* ssv
1985 Calls C<sv_setsv> if C<dsv> is not the same as C<ssv>. May evaluate arguments
1986 more than once. Does not handle 'set' magic on the destination SV.
1988 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1989 Calls a non-destructive version of C<sv_setsv> if C<dsv> is not the same as
1990 C<ssv>. May evaluate arguments more than once.
1992 =for apidoc Am|void|SvSetMagicSV|SV* dsv|SV* ssv
1993 Like C<SvSetSV>, but does any set magic required afterwards.
1995 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1996 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1998 =for apidoc Am|void|SvSHARE|SV* sv
1999 Arranges for C<sv> to be shared between threads if a suitable module
2002 =for apidoc Am|void|SvLOCK|SV* sv
2003 Arranges for a mutual exclusion lock to be obtained on C<sv> if a suitable module
2006 =for apidoc Am|void|SvUNLOCK|SV* sv
2007 Releases a mutual exclusion lock on C<sv> if a suitable module
2010 =head1 SV Manipulation Functions
2012 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
2013 Expands the character buffer in the SV so that it has room for the
2014 indicated number of bytes (remember to reserve space for an extra trailing
2015 C<NUL> character). Calls C<sv_grow> to perform the expansion if necessary.
2016 Returns a pointer to the character
2017 buffer. SV must be of type >= C<SVt_PV>. One
2018 alternative is to call C<sv_grow> if you are not sure of the type of SV.
2020 You might mistakenly think that C<len> is the number of bytes to add to the
2021 existing size, but instead it is the total size C<sv> should be.
2023 =for apidoc Am|char *|SvPVCLEAR|SV* sv
2024 Ensures that sv is a SVt_PV and that its SvCUR is 0, and that it is
2025 properly null terminated. Equivalent to sv_setpvs(""), but more efficient.
2030 #define SvPVCLEAR(sv) sv_setpv_bufsize(sv,0,0)
2031 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
2032 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
2033 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
2034 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
2036 #define SvGETMAGIC(x) ((void)(UNLIKELY(SvGMAGICAL(x)) && mg_get(x)))
2037 #define SvSETMAGIC(x) STMT_START { if (UNLIKELY(SvSMAGICAL(x))) mg_set(x); } STMT_END
2039 #define SvSetSV_and(dst,src,finally) \
2041 if (LIKELY((dst) != (src))) { \
2042 sv_setsv(dst, src); \
2046 #define SvSetSV_nosteal_and(dst,src,finally) \
2048 if (LIKELY((dst) != (src))) { \
2049 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
2054 #define SvSetSV(dst,src) \
2055 SvSetSV_and(dst,src,/*nothing*/;)
2056 #define SvSetSV_nosteal(dst,src) \
2057 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
2059 #define SvSetMagicSV(dst,src) \
2060 SvSetSV_and(dst,src,SvSETMAGIC(dst))
2061 #define SvSetMagicSV_nosteal(dst,src) \
2062 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
2065 #if !defined(SKIP_DEBUGGING)
2066 #define SvPEEK(sv) sv_peek(sv)
2068 #define SvPEEK(sv) ""
2071 #define SvIMMORTAL(sv) (SvREADONLY(sv) && ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder))
2074 /* exercise the immortal resurrection code in sv_free2() */
2075 # define SvREFCNT_IMMORTAL 1000
2077 # define SvREFCNT_IMMORTAL ((~(U32)0)/2)
2081 =for apidoc Am|SV *|boolSV|bool b
2083 Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
2085 See also C<L</PL_sv_yes>> and C<L</PL_sv_no>>.
2090 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2092 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2093 /* If I give every macro argument a different name, then there won't be bugs
2094 where nested macros get confused. Been there, done that. */
2095 #define isGV_with_GP(pwadak) \
2096 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
2097 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2098 #define isGV_with_GP_on(sv) STMT_START { \
2099 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2100 assert (!SvPOKp(sv)); \
2101 assert (!SvIOKp(sv)); \
2102 (SvFLAGS(sv) |= SVpgv_GP); \
2104 #define isGV_with_GP_off(sv) STMT_START { \
2105 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2106 assert (!SvPOKp(sv)); \
2107 assert (!SvIOKp(sv)); \
2108 (SvFLAGS(sv) &= ~SVpgv_GP); \
2110 #define isREGEXP(sv) \
2111 (SvTYPE(sv) == SVt_REGEXP \
2112 || (SvFLAGS(sv) & (SVTYPEMASK|SVp_POK|SVpgv_GP|SVf_FAKE)) \
2113 == (SVt_PVLV|SVf_FAKE))
2117 # define SvGROW(sv,len) \
2118 (SvIsCOW(sv) || SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2120 # define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2122 #define SvGROW_mutable(sv,len) \
2123 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2124 #define Sv_Grow sv_grow
2126 #define CLONEf_COPY_STACKS 1
2127 #define CLONEf_KEEP_PTR_TABLE 2
2128 #define CLONEf_CLONE_HOST 4
2129 #define CLONEf_JOIN_IN 8
2131 struct clone_params {
2134 PerlInterpreter *proto_perl;
2135 PerlInterpreter *new_perl;
2140 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2142 Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
2143 characters) into it. If C<utf8> is true, calls
2144 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2149 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2152 =for apidoc Amx|SV*|newSVpadname|PADNAME *pn
2154 Creates a new SV containing the pad name.
2159 #define newSVpadname(pn) newSVpvn_utf8(PadnamePV(pn), PadnameLEN(pn), TRUE)
2162 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2164 Reads into C<len> the offset from C<SvPVX> back to the true start of the
2165 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2166 efficiently remove characters from start of the buffer. Implemented as a
2167 macro, which takes the address of C<len>, which must be of type C<STRLEN>.
2168 Evaluates C<sv> more than once. Sets C<len> to 0 if C<SvOOK(sv)> is false.
2174 /* Does the bot know something I don't?
2175 10:28 <@Nicholas> metabatman
2176 10:28 <+meta> Nicholas: crash
2178 # define SvOOK_offset(sv, offset) STMT_START { \
2179 assert(sizeof(offset) == sizeof(STRLEN)); \
2181 const U8 *_crash = (U8*)SvPVX_const(sv); \
2182 (offset) = *--_crash; \
2184 _crash -= sizeof(STRLEN); \
2185 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
2188 /* Validate the preceding buffer's sentinels to \
2189 verify that no-one is using it. */ \
2190 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2191 while (_crash > _bonk) { \
2193 assert (*_crash == (U8)PTR2UV(_crash)); \
2201 /* This is the same code, but avoids using any temporary variables: */
2202 # define SvOOK_offset(sv, offset) STMT_START { \
2203 assert(sizeof(offset) == sizeof(STRLEN)); \
2205 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2207 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2208 (U8*)&(offset), sizeof(STRLEN), U8); \
2216 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2218 #define SV_CONST(name) \
2219 PL_sv_consts[SV_CONST_##name] \
2220 ? PL_sv_consts[SV_CONST_##name] \
2221 : (PL_sv_consts[SV_CONST_##name] = newSVpv_share(#name, 0))
2223 #define SV_CONST_TIESCALAR 0
2224 #define SV_CONST_TIEARRAY 1
2225 #define SV_CONST_TIEHASH 2
2226 #define SV_CONST_TIEHANDLE 3
2228 #define SV_CONST_FETCH 4
2229 #define SV_CONST_FETCHSIZE 5
2230 #define SV_CONST_STORE 6
2231 #define SV_CONST_STORESIZE 7
2232 #define SV_CONST_EXISTS 8
2234 #define SV_CONST_PUSH 9
2235 #define SV_CONST_POP 10
2236 #define SV_CONST_SHIFT 11
2237 #define SV_CONST_UNSHIFT 12
2238 #define SV_CONST_SPLICE 13
2239 #define SV_CONST_EXTEND 14
2241 #define SV_CONST_FIRSTKEY 15
2242 #define SV_CONST_NEXTKEY 16
2243 #define SV_CONST_SCALAR 17
2245 #define SV_CONST_OPEN 18
2246 #define SV_CONST_WRITE 19
2247 #define SV_CONST_PRINT 20
2248 #define SV_CONST_PRINTF 21
2249 #define SV_CONST_READ 22
2250 #define SV_CONST_READLINE 23
2251 #define SV_CONST_GETC 24
2252 #define SV_CONST_SEEK 25
2253 #define SV_CONST_TELL 26
2254 #define SV_CONST_EOF 27
2255 #define SV_CONST_BINMODE 28
2256 #define SV_CONST_FILENO 29
2257 #define SV_CONST_CLOSE 30
2259 #define SV_CONST_DELETE 31
2260 #define SV_CONST_CLEAR 32
2261 #define SV_CONST_UNTIE 33
2262 #define SV_CONST_DESTROY 34
2264 #define SV_CONSTS_COUNT 35
2267 * Bodyless IVs and NVs!
2269 * Since 5.9.2, we can avoid allocating a body for SVt_IV-type SVs.
2270 * Since the larger IV-holding variants of SVs store their integer
2271 * values in their respective bodies, the family of SvIV() accessor
2272 * macros would naively have to branch on the SV type to find the
2273 * integer value either in the HEAD or BODY. In order to avoid this
2274 * expensive branch, a clever soul has deployed a great hack:
2275 * We set up the SvANY pointer such that instead of pointing to a
2276 * real body, it points into the memory before the location of the
2277 * head. We compute this pointer such that the location of
2278 * the integer member of the hypothetical body struct happens to
2279 * be the same as the location of the integer member of the bodyless
2280 * SV head. This now means that the SvIV() family of accessors can
2281 * always read from the (hypothetical or real) body via SvANY.
2283 * Since the 5.21 dev series, we employ the same trick for NVs
2284 * if the architecture can support it (NVSIZE <= IVSIZE).
2287 /* The following two macros compute the necessary offsets for the above
2288 * trick and store them in SvANY for SvIV() (and friends) to use. */
2291 # define SET_SVANY_FOR_BODYLESS_IV(sv) \
2292 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) \
2293 - STRUCT_OFFSET(XPVIV, xiv_iv))
2295 # define SET_SVANY_FOR_BODYLESS_NV(sv) \
2296 SvANY(sv) = (XPVNV*)((char*)&(sv->sv_u.svu_nv) \
2297 - STRUCT_OFFSET(XPVNV, xnv_u.xnv_nv))
2301 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob