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 */
547 #define xlv_targoff xlv_targoff_u.xlvu_targoff
551 IV prev_index; /* caches result of previous invlist_search() */
552 STRLEN iterator; /* Stores where we are in iterating */
553 bool is_offset; /* The data structure for all inversion lists
554 begins with an element for code point U+0000.
555 If this bool is set, the actual list contains
556 that 0; otherwise, the list actually begins
557 with the following element. Thus to invert
558 the list, merely toggle this flag */
561 /* This structure works in 2 ways - regular scalar, or GV with GP */
569 typedef U32 cv_flags_t;
571 #define _XPVCV_COMMON \
579 void (*xcv_xsub) (pTHX_ CV*); \
587 PADLIST * xcv_padlist; \
591 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
592 * compilation) in the lexically enclosing \
594 cv_flags_t xcv_flags; \
595 I32 xcv_depth /* >= 2 indicates recursive call */
597 /* This structure must match XPVCV in cv.h */
608 /* ifp and ofp are normally the same, but sockets need separate streams */
610 /* Cray addresses everything by word boundaries (64 bits) and
611 * code and data pointers cannot be mixed (which is exactly what
612 * Perl_filter_add() tries to do with the dirp), hence the
613 * following union trick (as suggested by Gurusamy Sarathy).
614 * For further information see Geir Johansen's problem report
615 * titled [ID 20000612.002 (#3366)] Perl problem on Cray system
616 * The any pointer (known as IoANY()) will also be a good place
617 * to hang any IO disciplines to.
620 DIR * xiou_dirp; /* for opendir, readdir, etc */
621 void * xiou_any; /* for alignment */
623 /* IV xio_lines is now in IVX $. */
624 IV xio_page; /* $% */
625 IV xio_page_len; /* $= */
626 IV xio_lines_left; /* $- */
627 char * xio_top_name; /* $^ */
628 GV * xio_top_gv; /* $^ */
629 char * xio_fmt_name; /* $~ */
630 GV * xio_fmt_gv; /* $~ */
631 char * xio_bottom_name;/* $^B */
632 GV * xio_bottom_gv; /* $^B */
637 #define xio_dirp xio_dirpu.xiou_dirp
638 #define xio_any xio_dirpu.xiou_any
640 #define IOf_ARGV 1 /* this fp iterates over ARGV */
641 #define IOf_START 2 /* check for null ARGV and substitute '-' */
642 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
643 #define IOf_DIDTOP 8 /* just did top of form */
644 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
645 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
646 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
647 Also, when this is set, SvPVX() is valid */
649 /* The following macros define implementation-independent predicates on SVs. */
652 =for apidoc Am|U32|SvNIOK|SV* sv
653 Returns a U32 value indicating whether the SV contains a number, integer or
656 =for apidoc Am|U32|SvNIOKp|SV* sv
657 Returns a U32 value indicating whether the SV contains a number, integer or
658 double. Checks the B<private> setting. Use C<SvNIOK> instead.
660 =for apidoc Am|void|SvNIOK_off|SV* sv
661 Unsets the NV/IV status of an SV.
663 =for apidoc Am|U32|SvOK|SV* sv
664 Returns a U32 value indicating whether the value is defined. This is
665 only meaningful for scalars.
667 =for apidoc Am|U32|SvIOKp|SV* sv
668 Returns a U32 value indicating whether the SV contains an integer. Checks
669 the B<private> setting. Use C<SvIOK> instead.
671 =for apidoc Am|U32|SvNOKp|SV* sv
672 Returns a U32 value indicating whether the SV contains a double. Checks the
673 B<private> setting. Use C<SvNOK> instead.
675 =for apidoc Am|U32|SvPOKp|SV* sv
676 Returns a U32 value indicating whether the SV contains a character string.
677 Checks the B<private> setting. Use C<SvPOK> instead.
679 =for apidoc Am|U32|SvIOK|SV* sv
680 Returns a U32 value indicating whether the SV contains an integer.
682 =for apidoc Am|void|SvIOK_on|SV* sv
683 Tells an SV that it is an integer.
685 =for apidoc Am|void|SvIOK_off|SV* sv
686 Unsets the IV status of an SV.
688 =for apidoc Am|void|SvIOK_only|SV* sv
689 Tells an SV that it is an integer and disables all other C<OK> bits.
691 =for apidoc Am|void|SvIOK_only_UV|SV* sv
692 Tells an SV that it is an unsigned integer and disables all other C<OK> bits.
694 =for apidoc Am|bool|SvIOK_UV|SV* sv
695 Returns a boolean indicating whether the SV contains an integer that must be
696 interpreted as unsigned. A non-negative integer whose value is within the
697 range of both an IV and a UV may be be flagged as either C<SvUOK> or C<SVIOK>.
699 =for apidoc Am|bool|SvUOK|SV* sv
700 Returns a boolean indicating whether the SV contains an integer that must be
701 interpreted as unsigned. A non-negative integer whose value is within the
702 range of both an IV and a UV may be be flagged as either C<SvUOK> or C<SVIOK>.
704 =for apidoc Am|bool|SvIOK_notUV|SV* sv
705 Returns a boolean indicating whether the SV contains a signed integer.
707 =for apidoc Am|U32|SvNOK|SV* sv
708 Returns a U32 value indicating whether the SV contains a double.
710 =for apidoc Am|void|SvNOK_on|SV* sv
711 Tells an SV that it is a double.
713 =for apidoc Am|void|SvNOK_off|SV* sv
714 Unsets the NV status of an SV.
716 =for apidoc Am|void|SvNOK_only|SV* sv
717 Tells an SV that it is a double and disables all other OK bits.
719 =for apidoc Am|U32|SvPOK|SV* sv
720 Returns a U32 value indicating whether the SV contains a character
723 =for apidoc Am|void|SvPOK_on|SV* sv
724 Tells an SV that it is a string.
726 =for apidoc Am|void|SvPOK_off|SV* sv
727 Unsets the PV status of an SV.
729 =for apidoc Am|void|SvPOK_only|SV* sv
730 Tells an SV that it is a string and disables all other C<OK> bits.
731 Will also turn off the UTF-8 status.
733 =for apidoc Am|bool|SvVOK|SV* sv
734 Returns a boolean indicating whether the SV contains a v-string.
736 =for apidoc Am|U32|SvOOK|SV* sv
737 Returns a U32 indicating whether the pointer to the string buffer is offset.
738 This hack is used internally to speed up removal of characters from the
739 beginning of a C<SvPV>. When C<SvOOK> is true, then the start of the
740 allocated string buffer is actually C<SvOOK_offset()> bytes before C<SvPVX>.
741 This offset used to be stored in C<SvIVX>, but is now stored within the spare
744 =for apidoc Am|U32|SvROK|SV* sv
745 Tests if the SV is an RV.
747 =for apidoc Am|void|SvROK_on|SV* sv
748 Tells an SV that it is an RV.
750 =for apidoc Am|void|SvROK_off|SV* sv
751 Unsets the RV status of an SV.
753 =for apidoc Am|SV*|SvRV|SV* sv
754 Dereferences an RV to return the SV.
756 =for apidoc Am|IV|SvIVX|SV* sv
757 Returns the raw value in the SV's IV slot, without checks or conversions.
758 Only use when you are sure C<SvIOK> is true. See also C<L</SvIV>>.
760 =for apidoc Am|UV|SvUVX|SV* sv
761 Returns the raw value in the SV's UV slot, without checks or conversions.
762 Only use when you are sure C<SvIOK> is true. See also C<L</SvUV>>.
764 =for apidoc Am|NV|SvNVX|SV* sv
765 Returns the raw value in the SV's NV slot, without checks or conversions.
766 Only use when you are sure C<SvNOK> is true. See also C<L</SvNV>>.
768 =for apidoc Am|char*|SvPVX|SV* sv
769 Returns a pointer to the physical string in the SV. The SV must contain a
770 string. Prior to 5.9.3 it is not safe
771 to execute this macro unless the SV's
774 This is also used to store the name of an autoloaded subroutine in an XS
775 AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
777 =for apidoc Am|STRLEN|SvCUR|SV* sv
778 Returns the length of the string which is in the SV. See C<L</SvLEN>>.
780 =for apidoc Am|STRLEN|SvLEN|SV* sv
781 Returns the size of the string buffer in the SV, not including any part
782 attributable to C<SvOOK>. See C<L</SvCUR>>.
784 =for apidoc Am|char*|SvEND|SV* sv
785 Returns a pointer to the spot just after the last character in
786 the string which is in the SV, where there is usually a trailing
787 C<NUL> character (even though Perl scalars do not strictly require it).
788 See C<L</SvCUR>>. Access the character as C<*(SvEND(sv))>.
790 Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
793 =for apidoc Am|HV*|SvSTASH|SV* sv
794 Returns the stash of the SV.
796 =for apidoc Am|void|SvIV_set|SV* sv|IV val
797 Set the value of the IV pointer in sv to val. It is possible to perform
798 the same function of this macro with an lvalue assignment to C<SvIVX>.
799 With future Perls, however, it will be more efficient to use
800 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
802 =for apidoc Am|void|SvNV_set|SV* sv|NV val
803 Set the value of the NV pointer in C<sv> to val. See C<L</SvIV_set>>.
805 =for apidoc Am|void|SvPV_set|SV* sv|char* val
806 This is probably not what you want to use, you probably wanted
807 L</sv_usepvn_flags> or L</sv_setpvn> or L</sv_setpvs>.
809 Set the value of the PV pointer in C<sv> to the Perl allocated
810 C<NUL>-terminated string C<val>. See also C<L</SvIV_set>>.
812 Remember to free the previous PV buffer. There are many things to check.
813 Beware that the existing pointer may be involved in copy-on-write or other
814 mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or
815 C<SvPV_force> (or check the C<SvIsCOW> flag) first to make sure this
816 modification is safe. Then finally, if it is not a COW, call C<SvPV_free> to
817 free the previous PV buffer.
819 =for apidoc Am|void|SvUV_set|SV* sv|UV val
820 Set the value of the UV pointer in C<sv> to val. See C<L</SvIV_set>>.
822 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
823 Set the value of the RV pointer in C<sv> to val. See C<L</SvIV_set>>.
825 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
826 Set the value of the MAGIC pointer in C<sv> to val. See C<L</SvIV_set>>.
828 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
829 Set the value of the STASH pointer in C<sv> to val. See C<L</SvIV_set>>.
831 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
832 Set the current length of the string which is in the SV. See C<L</SvCUR>>
835 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
836 Set the size of the string buffer for the SV. See C<L</SvLEN>>.
841 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
842 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
843 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
844 SVp_IOK|SVp_NOK|SVf_IVisUV))
846 #define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv))
847 #define assert_not_glob(sv) assert_(!isGV_with_GP(sv))
849 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK || isREGEXP(sv))
850 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
851 SvFLAGS(sv) &= ~(SVf_OK| \
852 SVf_IVisUV|SVf_UTF8), \
854 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
855 SvFLAGS(sv) &= ~(SVf_OK| \
859 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
860 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
861 #define SvIOKp_on(sv) (assert_not_glob(sv) \
862 SvFLAGS(sv) |= SVp_IOK)
863 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
864 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
865 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
866 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
867 SvFLAGS(sv) |= SVp_POK)
869 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
870 #define SvIOK_on(sv) (assert_not_glob(sv) \
871 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
872 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
873 #define SvIOK_only(sv) (SvOK_off(sv), \
874 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
875 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
876 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
878 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
879 == (SVf_IOK|SVf_IVisUV))
880 #define SvUOK(sv) SvIOK_UV(sv)
881 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
884 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
885 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
886 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
888 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
889 #define SvNOK_on(sv) (assert_not_glob(sv) \
890 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
891 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
892 #define SvNOK_only(sv) (SvOK_off(sv), \
893 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
896 =for apidoc Am|U32|SvUTF8|SV* sv
897 Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
898 properly, this indicates whether or not the SV contains UTF-8 encoded data.
899 You should use this I<after> a call to C<SvPV()> or one of its variants, in
900 case any call to string overloading updates the internal flag.
902 If you want to take into account the L<bytes> pragma, use C<L</DO_UTF8>>
905 =for apidoc Am|void|SvUTF8_on|SV *sv
906 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
907 Do not use frivolously.
909 =for apidoc Am|void|SvUTF8_off|SV *sv
910 Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
911 Do not use frivolously.
913 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
914 Tells an SV that it is a string and disables all other C<OK> bits,
915 and leaves the UTF-8 status as it was.
920 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
922 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
923 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
924 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
926 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
927 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
928 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
929 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
930 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
931 SvFLAGS(sv) &= ~(SVf_OK| \
932 SVf_IVisUV|SVf_UTF8), \
933 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
934 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
935 SvFLAGS(sv) &= ~(SVf_OK| \
937 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
939 #define SvVOK(sv) (SvMAGICAL(sv) \
940 && mg_find(sv,PERL_MAGIC_vstring))
941 /* returns the vstring magic, if any */
942 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
943 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
945 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
946 #define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
947 #define SvOOK_off(sv) ((void)(SvOOK(sv) && (sv_backoff(sv),0)))
949 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
950 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
951 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
953 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
954 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
955 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
957 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
958 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
959 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
961 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
962 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
963 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
965 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
966 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
967 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
969 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
970 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
971 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
973 #define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
974 HvAMAGIC(SvSTASH(SvRV(sv))))
976 /* To be used on the stashes themselves: */
977 #define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
978 #define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
979 #define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
982 /* "nog" means "doesn't have get magic" */
983 #define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
984 #define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
985 #define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
986 #define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
987 #define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
989 #define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
990 #define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
991 #define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
992 #define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
993 #define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
995 #define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
996 #define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
998 #define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
999 #define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1001 #define SvPOK_pure_nogthink(sv) \
1002 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1003 #define SvPOK_utf8_pure_nogthink(sv) \
1004 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1005 #define SvPOK_byte_pure_nogthink(sv) \
1006 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1009 =for apidoc Am|U32|SvGAMAGIC|SV* sv
1011 Returns true if the SV has get magic or
1012 overloading. If either is true then
1013 the scalar is active data, and has the potential to return a new value every
1014 time it is accessed. Hence you must be careful to
1015 only read it once per user logical operation and work
1016 with that returned value. If neither is true then
1017 the scalar's value cannot change unless written to.
1022 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1024 #define Gv_AMG(stash) \
1025 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
1027 : (HvAMAGIC_off(stash), 0))
1029 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1030 == (SVf_ROK|SVprv_WEAKREF))
1031 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1032 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1034 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
1035 == (SVf_ROK|SVprv_PCS_IMPORTED))
1036 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
1037 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
1040 =for apidoc m|U32|SvTHINKFIRST|SV *sv
1042 A quick flag check to see whether an C<sv> should be passed to C<sv_force_normal>
1043 to be "downgraded" before C<SvIVX> or C<SvPVX> can be modified directly.
1045 For example, if your scalar is a reference and you want to modify the C<SvIVX>
1046 slot, you can't just do C<SvROK_off>, as that will leak the referent.
1048 This is used internally by various sv-modifying functions, such as
1049 C<sv_setsv>, C<sv_setiv> and C<sv_pvn_force>.
1051 One case that this does not handle is a gv without SvFAKE set. After
1053 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
1055 it will still be a gv.
1057 C<SvTHINKFIRST> sometimes produces false positives. In those cases
1058 C<sv_force_normal> does nothing.
1063 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1066 #define SvPADMY(sv) !(SvFLAGS(sv) & SVs_PADTMP)
1068 # define SvPADMY_on(sv) SvPADTMP_off(sv)
1071 #define SvPADTMP(sv) (SvFLAGS(sv) & (SVs_PADTMP))
1072 #define SvPADSTALE(sv) (SvFLAGS(sv) & (SVs_PADSTALE))
1074 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1075 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1076 #define SvPADSTALE_on(sv) S_SvPADSTALE_on(MUTABLE_SV(sv))
1077 #define SvPADSTALE_off(sv) S_SvPADSTALE_off(MUTABLE_SV(sv))
1079 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1080 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1081 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1083 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1084 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1085 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1088 =for apidoc Am|U32|SvREADONLY|SV* sv
1089 Returns true if the argument is readonly, otherwise returns false.
1090 Exposed to to perl code via Internals::SvREADONLY().
1092 =for apidoc Am|U32|SvREADONLY_on|SV* sv
1093 Mark an object as readonly. Exactly what this means depends on the object
1094 type. Exposed to perl code via Internals::SvREADONLY().
1096 =for apidoc Am|U32|SvREADONLY_off|SV* sv
1097 Mark an object as not-readonly. Exactly what this mean depends on the
1098 object type. Exposed to perl code via Internals::SvREADONLY().
1103 #define SvREADONLY(sv) (SvFLAGS(sv) & (SVf_READONLY|SVf_PROTECT))
1105 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= (SVf_READONLY|SVf_PROTECT))
1106 # define SvREADONLY_off(sv) (SvFLAGS(sv) &=~(SVf_READONLY|SVf_PROTECT))
1108 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1109 # define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1112 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1113 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1114 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1117 # define SvCOMPILED(sv) 0
1118 # define SvCOMPILED_on(sv)
1119 # define SvCOMPILED_off(sv)
1123 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1124 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
1125 assert(SvTYPE(_svtail) != SVt_PVAV); \
1126 assert(SvTYPE(_svtail) != SVt_PVHV); \
1127 assert(!(SvFLAGS(_svtail) & (SVf_NOK|SVp_NOK))); \
1128 assert(SvVALID(_svtail)); \
1129 ((XPVNV*)SvANY(_svtail))->xnv_u.xnv_bm_tail; \
1132 # define SvTAIL(_svtail) (((XPVNV*)SvANY(_svtail))->xnv_u.xnv_bm_tail)
1135 /* Does the SV have a Boyer-Moore table attached as magic?
1136 * 'VALID' is a poor name, but is kept for historical reasons. */
1137 #define SvVALID(_svvalid) ( \
1139 && SvSMAGICAL(_svvalid) \
1140 && SvMAGIC(_svvalid) \
1141 && (SvMAGIC(_svvalid)->mg_type == PERL_MAGIC_bm \
1142 || mg_find(_svvalid, PERL_MAGIC_bm)) \
1145 #define SvRVx(sv) SvRV(sv)
1147 #ifdef PERL_DEBUG_COW
1148 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1149 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1150 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1151 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1152 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1153 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1154 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1155 /* Don't test the core XS code yet. */
1156 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1157 # define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
1159 # define SvPVX(sv) SvPVX_mutable(sv)
1161 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1162 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1163 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1165 # define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1166 # define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
1168 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1169 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1171 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1172 /* These get expanded inside other macros that already use a variable _sv */
1173 # define SvPVX(sv) \
1174 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1175 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
1176 assert(!isGV_with_GP(_svpvx)); \
1177 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1178 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
1179 &((_svpvx)->sv_u.svu_pv); \
1181 # define SvCUR(sv) \
1182 (*({ const SV *const _svcur = (const SV *)(sv); \
1183 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK] \
1184 || SvTYPE(_svcur) == SVt_REGEXP); \
1185 assert(!isGV_with_GP(_svcur)); \
1186 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1187 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1188 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1190 # define SvIVX(sv) \
1191 (*({ const SV *const _svivx = (const SV *)(sv); \
1192 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
1193 assert(!isGV_with_GP(_svivx)); \
1194 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1196 # define SvUVX(sv) \
1197 (*({ const SV *const _svuvx = (const SV *)(sv); \
1198 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
1199 assert(!isGV_with_GP(_svuvx)); \
1200 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1202 # define SvNVX(sv) \
1203 (*({ const SV *const _svnvx = (const SV *)(sv); \
1204 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
1205 assert(!isGV_with_GP(_svnvx)); \
1206 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1209 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1210 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1211 assert(!isGV_with_GP(_svrv)); \
1212 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1213 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1214 &((_svrv)->sv_u.svu_rv); \
1216 # define SvRV_const(sv) \
1217 ({ const SV *const _svrv = (const SV *)(sv); \
1218 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1219 assert(!isGV_with_GP(_svrv)); \
1220 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1221 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1222 (_svrv)->sv_u.svu_rv; \
1224 # define SvMAGIC(sv) \
1225 (*({ const SV *const _svmagic = (const SV *)(sv); \
1226 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1227 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1229 # define SvSTASH(sv) \
1230 (*({ const SV *const _svstash = (const SV *)(sv); \
1231 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1232 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1235 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1236 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1237 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1238 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1239 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1240 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1241 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1242 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1243 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1248 /* Given that these two are new, there can't be any existing code using them
1250 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1251 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1253 /* Except for the poison code, which uses & to scribble over the pointer after
1254 free() is called. */
1255 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1256 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1259 #define SvIVXx(sv) SvIVX(sv)
1260 #define SvUVXx(sv) SvUVX(sv)
1261 #define SvNVXx(sv) SvNVX(sv)
1262 #define SvPVXx(sv) SvPVX(sv)
1263 #define SvLENx(sv) SvLEN(sv)
1264 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1267 /* Ask a scalar nicely to try to become an IV, if possible.
1268 Not guaranteed to stay returning void */
1269 /* Macro won't actually call sv_2iv if already IOK */
1270 #define SvIV_please(sv) \
1271 STMT_START {if (!SvIOKp(sv) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK))) \
1272 (void) SvIV(sv); } STMT_END
1273 #define SvIV_please_nomg(sv) \
1274 (!(SvFLAGS(sv) & (SVf_IOK|SVp_IOK)) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK)) \
1275 ? (sv_2iv_flags(sv, 0), SvIOK(sv)) \
1277 #define SvIV_set(sv, val) \
1279 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1280 assert(!isGV_with_GP(sv)); \
1281 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1282 #define SvNV_set(sv, val) \
1284 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
1285 assert(!isGV_with_GP(sv)); \
1286 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1287 #define SvPV_set(sv, val) \
1289 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1290 assert(!isGV_with_GP(sv)); \
1291 assert(!(SvTYPE(sv) == SVt_PVIO \
1292 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1293 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1294 #define SvUV_set(sv, val) \
1296 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1297 assert(!isGV_with_GP(sv)); \
1298 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1299 #define SvRV_set(sv, val) \
1301 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
1302 assert(!isGV_with_GP(sv)); \
1303 assert(!(SvTYPE(sv) == SVt_PVIO \
1304 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1305 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1306 #define SvMAGIC_set(sv, val) \
1307 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1308 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1309 #define SvSTASH_set(sv, val) \
1310 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1311 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1312 #define SvCUR_set(sv, val) \
1314 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK] \
1315 || SvTYPE(sv) == SVt_REGEXP); \
1316 assert(!isGV_with_GP(sv)); \
1317 assert(!(SvTYPE(sv) == SVt_PVIO \
1318 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1319 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1320 #define SvLEN_set(sv, val) \
1322 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1323 assert(!isGV_with_GP(sv)); \
1324 assert(!(SvTYPE(sv) == SVt_PVIO \
1325 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1326 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1327 #define SvEND_set(sv, val) \
1328 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1329 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1331 #define SvPV_renew(sv,n) \
1332 STMT_START { SvLEN_set(sv, n); \
1333 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1334 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1335 (MEM_SIZE)((n))))); \
1338 #define SvPV_shrink_to_cur(sv) STMT_START { \
1339 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1340 SvPV_renew(sv, _lEnGtH); \
1343 #define SvPV_free(sv) \
1345 assert(SvTYPE(sv) >= SVt_PV); \
1347 assert(!SvROK(sv)); \
1348 if(UNLIKELY(SvOOK(sv))) { \
1350 SvOOK_offset(sv, zok); \
1351 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1352 SvFLAGS(sv) &= ~SVf_OOK; \
1354 Safefree(SvPVX(sv)); \
1359 /* Code that crops up in three places to take a scalar and ready it to hold
1361 # define prepare_SV_for_RV(sv) \
1363 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1364 sv_upgrade(sv, SVt_IV); \
1365 else if (SvTYPE(sv) >= SVt_PV) { \
1374 # define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1377 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1378 # define BmUSEFUL(sv) \
1379 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1380 assert(SvTYPE(_bmuseful) >= SVt_PVIV); \
1381 assert(SvVALID(_bmuseful)); \
1382 assert(!SvIOK(_bmuseful)); \
1383 &(((XPVIV*) SvANY(_bmuseful))->xiv_u.xivu_iv); \
1386 # define BmUSEFUL(sv) ((XPVIV*) SvANY(sv))->xiv_u.xivu_iv
1391 # define BmRARE(sv) 0
1392 # define BmPREVIOUS(sv) 0
1395 #define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1397 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1398 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1399 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1400 #define LvSTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff_u.xlvu_stargoff
1401 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1402 #define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
1404 #define IoIFP(sv) (sv)->sv_u.svu_fp
1405 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1406 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1407 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1408 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
1409 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1410 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1411 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1412 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1413 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1414 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1415 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1416 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1417 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1418 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1419 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1421 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1422 #define IoTYPE_RDONLY '<'
1423 #define IoTYPE_WRONLY '>'
1424 #define IoTYPE_RDWR '+'
1425 #define IoTYPE_APPEND 'a'
1426 #define IoTYPE_PIPE '|'
1427 #define IoTYPE_STD '-' /* stdin or stdout */
1428 #define IoTYPE_SOCKET 's'
1429 #define IoTYPE_CLOSED ' '
1430 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1431 #define IoTYPE_NUMERIC '#' /* fdopen */
1434 =for apidoc Am|bool|SvTAINTED|SV* sv
1435 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1438 =for apidoc Am|void|SvTAINTED_on|SV* sv
1439 Marks an SV as tainted if tainting is enabled.
1441 =for apidoc Am|void|SvTAINTED_off|SV* sv
1442 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1443 some of Perl's fundamental security features. XS module authors should not
1444 use this function unless they fully understand all the implications of
1445 unconditionally untainting the value. Untainting should be done in the
1446 standard perl fashion, via a carefully crafted regexp, rather than directly
1447 untainting variables.
1449 =for apidoc Am|void|SvTAINT|SV* sv
1450 Taints an SV if tainting is enabled, and if some input to the current
1451 expression is tainted--usually a variable, but possibly also implicit
1452 inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1453 the outputs of an expression in a pessimistic fashion; i.e., without paying
1454 attention to precisely which outputs are influenced by which inputs.
1459 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1461 #ifdef NO_TAINT_SUPPORT
1462 # define SvTAINTED(sv) 0
1464 # define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1466 #define SvTAINTED_on(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_taint(sv);} }STMT_END
1467 #define SvTAINTED_off(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_untaint(sv);} }STMT_END
1469 #define SvTAINT(sv) \
1471 assert(TAINTING_get || !TAINT_get); \
1472 if (UNLIKELY(TAINT_get)) \
1477 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1478 Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1479 only a string (C<SvPOK_only>), by hook or by crook. You need force if you are
1480 going to update the C<SvPVX> directly. Processes get magic.
1482 Note that coercing an arbitrary scalar into a plain PV will potentially
1483 strip useful data from it. For example if the SV was C<SvROK>, then the
1484 referent will have its reference count decremented, and the SV itself may
1485 be converted to an C<SvPOK> scalar with a string buffer containing a value
1486 such as C<"ARRAY(0x1234)">.
1488 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1489 Like C<SvPV_force>, but doesn't process get magic.
1491 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1492 Returns a pointer to the string in the SV, or a stringified form of
1493 the SV if the SV does not contain a string. The SV may cache the
1494 stringified version becoming C<SvPOK>. Handles 'get' magic. The
1495 C<len> variable will be set to the length of the string (this is a macro, so
1496 don't use C<&len>). See also C<L</SvPVx>> for a version which guarantees to
1497 evaluate C<sv> only once.
1499 Note that there is no guarantee that the return value of C<SvPV()> is
1500 equal to C<SvPVX(sv)>, or that C<SvPVX(sv)> contains valid data, or that
1501 successive calls to C<SvPV(sv)> will return the same pointer value each
1502 time. This is due to the way that things like overloading and
1503 Copy-On-Write are handled. In these cases, the return value may point to
1504 a temporary buffer or similar. If you absolutely need the C<SvPVX> field to
1505 be valid (for example, if you intend to write to it), then see
1508 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1509 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1510 Only use this if C<sv> is an expression with side effects, otherwise use the
1511 more efficient C<SvPV>.
1513 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1514 Like C<SvPV> but doesn't process magic.
1516 =for apidoc Am|char*|SvPV_nolen|SV* sv
1517 Like C<SvPV> but doesn't set a length variable.
1519 =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1520 Like C<SvPV_nolen> but doesn't process magic.
1522 =for apidoc Am|IV|SvIV|SV* sv
1523 Coerces the given SV to an integer and returns it. See C<L</SvIVx>> for a
1524 version which guarantees to evaluate C<sv> only once.
1526 =for apidoc Am|IV|SvIV_nomg|SV* sv
1527 Like C<SvIV> but doesn't process magic.
1529 =for apidoc Am|IV|SvIVx|SV* sv
1530 Coerces the given SV to an integer and returns it.
1531 Guarantees to evaluate C<sv> only once. Only use
1532 this if C<sv> is an expression with side effects,
1533 otherwise use the more efficient C<SvIV>.
1535 =for apidoc Am|NV|SvNV|SV* sv
1536 Coerce the given SV to a double and return it. See C<L</SvNVx>> for a version
1537 which guarantees to evaluate C<sv> only once.
1539 =for apidoc Am|NV|SvNV_nomg|SV* sv
1540 Like C<SvNV> but doesn't process magic.
1542 =for apidoc Am|NV|SvNVx|SV* sv
1543 Coerces the given SV to a double and returns it.
1544 Guarantees to evaluate C<sv> only once. Only use
1545 this if C<sv> is an expression with side effects,
1546 otherwise use the more efficient C<SvNV>.
1548 =for apidoc Am|UV|SvUV|SV* sv
1549 Coerces the given SV to an unsigned integer and returns it. See C<L</SvUVx>>
1550 for a version which guarantees to evaluate C<sv> only once.
1552 =for apidoc Am|UV|SvUV_nomg|SV* sv
1553 Like C<SvUV> but doesn't process magic.
1555 =for apidoc Am|UV|SvUVx|SV* sv
1556 Coerces the given SV to an unsigned integer and
1557 returns it. Guarantees to evaluate C<sv> only once. Only
1558 use this if C<sv> is an expression with side effects,
1559 otherwise use the more efficient C<SvUV>.
1561 =for apidoc Am|bool|SvTRUE|SV* sv
1562 Returns a boolean indicating whether Perl would evaluate the SV as true or
1563 false. See C<L</SvOK>> for a defined/undefined test. Handles 'get' magic
1564 unless the scalar is already C<SvPOK>, C<SvIOK> or C<SvNOK> (the public, not the
1567 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
1568 Returns a boolean indicating whether Perl would evaluate the SV as true or
1569 false. See C<L</SvOK>> for a defined/undefined test. Does not handle 'get' magic.
1571 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1572 Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
1574 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1575 Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
1577 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1578 Like C<SvPV_nolen>, but converts C<sv> to UTF-8 first if necessary.
1580 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1581 Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary.
1583 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1584 Like C<SvPV>, but converts C<sv> to byte representation first if necessary.
1586 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1587 Like C<SvPV_nolen>, but converts C<sv> to byte representation first if necessary.
1589 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1590 Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
1591 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8_force>
1594 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1595 Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
1596 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8>
1599 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1600 Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary.
1601 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte_force>
1604 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1605 Like C<SvPV>, but converts C<sv> to byte representation first if necessary.
1606 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte>
1609 =for apidoc Am|U32|SvIsCOW|SV* sv
1610 Returns a U32 value indicating whether the SV is Copy-On-Write (either shared
1611 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1614 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1615 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1618 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1619 Like C<sv_catpvn> but doesn't process magic.
1621 =for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1622 Like C<sv_catpv> but doesn't process magic.
1624 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1625 Like C<sv_setsv> but doesn't process magic.
1627 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1628 Like C<sv_catsv> but doesn't process magic.
1630 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1632 Like C<sv_utf8_upgrade>, but doesn't do magic on C<sv>.
1637 /* Let us hope that bitmaps for UV and IV are the same */
1638 #define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1639 #define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1640 #define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
1642 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1643 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1644 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1648 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1649 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1650 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1652 #define SvPV_flags(sv, lp, flags) \
1654 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1655 #define SvPV_flags_const(sv, lp, flags) \
1657 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1658 (const char*) sv_2pv_flags(sv, &lp, (flags|SV_CONST_RETURN)))
1659 #define SvPV_flags_const_nolen(sv, flags) \
1661 ? SvPVX_const(sv) : \
1662 (const char*) sv_2pv_flags(sv, 0, (flags|SV_CONST_RETURN)))
1663 #define SvPV_flags_mutable(sv, lp, flags) \
1665 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1666 sv_2pv_flags(sv, &lp, (flags|SV_MUTABLE_RETURN)))
1668 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1669 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1670 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1672 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1673 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1675 #define SvPV_force_flags(sv, lp, flags) \
1676 (SvPOK_pure_nogthink(sv) \
1677 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1679 #define SvPV_force_flags_nolen(sv, flags) \
1680 (SvPOK_pure_nogthink(sv) \
1681 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1683 #define SvPV_force_flags_mutable(sv, lp, flags) \
1684 (SvPOK_pure_nogthink(sv) \
1685 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1686 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1688 #define SvPV_nolen(sv) \
1690 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1692 /* "_nomg" in these defines means no mg_get() */
1693 #define SvPV_nomg_nolen(sv) \
1695 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1697 #define SvPV_nolen_const(sv) \
1699 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1701 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1702 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1703 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1707 #define SvPVutf8(sv, lp) \
1708 (SvPOK_utf8_nog(sv) \
1709 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1711 #define SvPVutf8_force(sv, lp) \
1712 (SvPOK_utf8_pure_nogthink(sv) \
1713 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1715 #define SvPVutf8_nolen(sv) \
1716 (SvPOK_utf8_nog(sv) \
1717 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1721 #define SvPVbyte(sv, lp) \
1722 (SvPOK_byte_nog(sv) \
1723 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1725 #define SvPVbyte_force(sv, lp) \
1726 (SvPOK_byte_pure_nogthink(sv) \
1727 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1729 #define SvPVbyte_nolen(sv) \
1730 (SvPOK_byte_nog(sv) \
1731 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1734 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1735 * var to evaluate the arg once; failing that, use a global if possible;
1736 * failing that, call a function to do the work
1739 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1740 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1741 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1743 #define SvTRUE(sv) (LIKELY(sv) && (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))))
1744 #define SvTRUE_nomg(sv) (LIKELY(sv) && ( SvTRUE_common(sv, sv_2bool_nomg(sv))))
1745 #define SvTRUE_NN(sv) (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv)))
1746 #define SvTRUE_nomg_NN(sv) ( SvTRUE_common(sv, sv_2bool_nomg(sv)))
1747 #define SvTRUE_common(sv,fallback) ( \
1752 : (SvFLAGS(sv) & (SVf_IOK|SVf_NOK)) \
1753 ? ( (SvIOK(sv) && SvIVX(sv) != 0) \
1754 || (SvNOK(sv) && SvNVX(sv) != 0.0)) \
1757 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1759 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1760 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1761 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1762 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1763 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1764 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1765 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1766 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1767 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1768 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1769 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1770 # define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
1772 #else /* __GNUC__ */
1774 /* These inlined macros use globals, which will require a thread
1775 * declaration in user code, so we avoid them under threads */
1777 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1778 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1779 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1780 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1781 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1782 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1783 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1784 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1785 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1786 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1787 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1788 # define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
1789 #endif /* __GNU__ */
1791 #define SvPVXtrue(sv) ( \
1792 ((XPV*)SvANY((sv))) \
1794 ((XPV*)SvANY((sv)))->xpv_cur > 1 \
1796 ((XPV*)SvANY((sv)))->xpv_cur \
1797 && *(sv)->sv_u.svu_pv != '0' \
1802 #define SvIsCOW(sv) (SvFLAGS(sv) & SVf_IsCOW)
1803 #define SvIsCOW_on(sv) (SvFLAGS(sv) |= SVf_IsCOW)
1804 #define SvIsCOW_off(sv) (SvFLAGS(sv) &= ~SVf_IsCOW)
1805 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1807 #define SvSHARED_HEK_FROM_PV(pvx) \
1808 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1809 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1811 /* flag values for sv_*_flags functions */
1812 #define SV_UTF8_NO_ENCODING 0 /* No longer used */
1813 #define SV_IMMEDIATE_UNREF 1
1815 #define SV_COW_DROP_PV 4
1816 #define SV_NOSTEAL 16
1817 #define SV_CONST_RETURN 32
1818 #define SV_MUTABLE_RETURN 64
1819 #define SV_SMAGIC 128
1820 #define SV_HAS_TRAILING_NUL 256
1821 #define SV_COW_SHARED_HASH_KEYS 512
1822 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1823 /* XXX This flag actually enabled for any COW. But it appears not to do
1824 anything. Can we just remove it? Or will it serve some future
1826 #define SV_COW_OTHER_PVS 1024
1827 /* Make sv_2pv_flags return NULL if something is undefined. */
1828 #define SV_UNDEF_RETURNS_NULL 2048
1829 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1830 * This is used when the caller has already determined it is, and avoids
1832 #define SV_FORCE_UTF8_UPGRADE 4096
1833 /* if (after resolving magic etc), the SV is found to be overloaded,
1834 * don't call the overload magic, just return as-is */
1835 #define SV_SKIP_OVERLOAD 8192
1836 #define SV_CATBYTES 16384
1837 #define SV_CATUTF8 32768
1839 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1840 So only default to doing the COW setup if we're in the core.
1843 # ifndef SV_DO_COW_SVSETSV
1844 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1848 #ifndef SV_DO_COW_SVSETSV
1849 # define SV_DO_COW_SVSETSV 0
1853 #define sv_unref(sv) sv_unref_flags(sv, 0)
1854 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1855 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1856 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1858 /* We are about to replace the SV's current value. So if it's copy on write
1859 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1860 the value is about to get thrown away, so drop the PV rather than go to
1861 the effort of making a read-write copy only for it to get immediately
1864 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1865 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1867 #ifdef PERL_COPY_ON_WRITE
1868 # define SvCANCOW(sv) \
1870 ? SvLEN(sv) ? CowREFCNT(sv) != SV_COW_REFCNT_MAX : 1 \
1871 : (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS \
1872 && SvCUR(sv)+1 < SvLEN(sv))
1873 /* Note: To allow 256 COW "copies", a refcnt of 0 means 1. */
1874 # define CowREFCNT(sv) (*(U8 *)(SvPVX(sv)+SvLEN(sv)-1))
1875 # define SV_COW_REFCNT_MAX ((1 << sizeof(U8)*8) - 1)
1876 # define CAN_COW_MASK (SVf_POK|SVf_ROK|SVp_POK|SVf_FAKE| \
1877 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_PROTECT)
1880 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1882 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1883 sv_force_normal_flags(sv, 0)
1886 /* all these 'functions' are now just macros */
1888 #define sv_pv(sv) SvPV_nolen(sv)
1889 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1890 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1892 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1893 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1894 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1895 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1896 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
1897 #define sv_setsv(dsv, ssv) \
1898 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1899 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1900 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1901 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1902 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1903 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1904 #define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1905 #define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
1906 #define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
1907 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1908 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1909 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1910 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1911 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1912 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1913 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1914 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1915 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1916 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1917 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1918 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1919 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
1920 #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
1921 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
1922 #define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
1923 #define sv_insert(bigstr, offset, len, little, littlelen) \
1924 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1925 (littlelen), SV_GMAGIC)
1926 #define sv_mortalcopy(sv) \
1927 Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1928 #define sv_cathek(sv,hek) \
1930 HEK * const bmxk = hek; \
1931 sv_catpvn_flags(sv, HEK_KEY(bmxk), HEK_LEN(bmxk), \
1932 HEK_UTF8(bmxk) ? SV_CATUTF8 : SV_CATBYTES); \
1935 /* Should be named SvCatPVN_utf8_upgrade? */
1936 #define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
1939 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
1941 sv_setpvn(nsv, sstr, slen); \
1943 sv_utf8_upgrade(nsv); \
1944 sv_catsv_nomg(dsv, nsv); \
1946 #define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \
1947 sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES)
1949 #if defined(PERL_CORE) || defined(PERL_EXT)
1950 # define sv_or_pv_len_utf8(sv, pv, bytelen) \
1952 ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \
1957 =for apidoc Am|SV*|newRV_inc|SV* sv
1959 Creates an RV wrapper for an SV. The reference count for the original SV is
1965 #define newRV_inc(sv) newRV(sv)
1967 /* the following macros update any magic values this C<sv> is associated with */
1970 =head1 Magical Functions
1972 =for apidoc Am|void|SvGETMAGIC|SV* sv
1973 Invokes C<mg_get> on an SV if it has 'get' magic. For example, this
1974 will call C<FETCH> on a tied variable. This macro evaluates its
1975 argument more than once.
1977 =for apidoc Am|void|SvSETMAGIC|SV* sv
1978 Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary
1979 after modifying a scalar, in case it is a magical variable like C<$|>
1980 or a tied variable (it calls C<STORE>). This macro evaluates its
1981 argument more than once.
1983 =for apidoc Am|void|SvSetSV|SV* dsv|SV* ssv
1984 Calls C<sv_setsv> if C<dsv> is not the same as C<ssv>. May evaluate arguments
1985 more than once. Does not handle 'set' magic on the destination SV.
1987 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1988 Calls a non-destructive version of C<sv_setsv> if C<dsv> is not the same as
1989 C<ssv>. May evaluate arguments more than once.
1991 =for apidoc Am|void|SvSetMagicSV|SV* dsv|SV* ssv
1992 Like C<SvSetSV>, but does any set magic required afterwards.
1994 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1995 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1997 =for apidoc Am|void|SvSHARE|SV* sv
1998 Arranges for C<sv> to be shared between threads if a suitable module
2001 =for apidoc Am|void|SvLOCK|SV* sv
2002 Arranges for a mutual exclusion lock to be obtained on C<sv> if a suitable module
2005 =for apidoc Am|void|SvUNLOCK|SV* sv
2006 Releases a mutual exclusion lock on C<sv> if a suitable module
2009 =head1 SV Manipulation Functions
2011 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
2012 Expands the character buffer in the SV so that it has room for the
2013 indicated number of bytes (remember to reserve space for an extra trailing
2014 C<NUL> character). Calls C<sv_grow> to perform the expansion if necessary.
2015 Returns a pointer to the character
2016 buffer. SV must be of type >= C<SVt_PV>. One
2017 alternative is to call C<sv_grow> if you are not sure of the type of SV.
2019 You might mistakenly think that C<len> is the number of bytes to add to the
2020 existing size, but instead it is the total size C<sv> should be.
2022 =for apidoc Am|char *|SvPVCLEAR|SV* sv
2023 Ensures that sv is a SVt_PV and that its SvCUR is 0, and that it is
2024 properly null terminated. Equivalent to sv_setpvs(""), but more efficient.
2029 #define SvPVCLEAR(sv) sv_setpv_bufsize(sv,0,0)
2030 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
2031 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
2032 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
2033 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
2035 #define SvGETMAGIC(x) ((void)(UNLIKELY(SvGMAGICAL(x)) && mg_get(x)))
2036 #define SvSETMAGIC(x) STMT_START { if (UNLIKELY(SvSMAGICAL(x))) mg_set(x); } STMT_END
2038 #define SvSetSV_and(dst,src,finally) \
2040 if (LIKELY((dst) != (src))) { \
2041 sv_setsv(dst, src); \
2045 #define SvSetSV_nosteal_and(dst,src,finally) \
2047 if (LIKELY((dst) != (src))) { \
2048 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
2053 #define SvSetSV(dst,src) \
2054 SvSetSV_and(dst,src,/*nothing*/;)
2055 #define SvSetSV_nosteal(dst,src) \
2056 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
2058 #define SvSetMagicSV(dst,src) \
2059 SvSetSV_and(dst,src,SvSETMAGIC(dst))
2060 #define SvSetMagicSV_nosteal(dst,src) \
2061 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
2064 #if !defined(SKIP_DEBUGGING)
2065 #define SvPEEK(sv) sv_peek(sv)
2067 #define SvPEEK(sv) ""
2070 #define SvIMMORTAL(sv) (SvREADONLY(sv) && ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder))
2073 /* exercise the immortal resurrection code in sv_free2() */
2074 # define SvREFCNT_IMMORTAL 1000
2076 # define SvREFCNT_IMMORTAL ((~(U32)0)/2)
2080 =for apidoc Am|SV *|boolSV|bool b
2082 Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
2084 See also C<L</PL_sv_yes>> and C<L</PL_sv_no>>.
2089 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2091 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2092 /* If I give every macro argument a different name, then there won't be bugs
2093 where nested macros get confused. Been there, done that. */
2094 #define isGV_with_GP(pwadak) \
2095 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
2096 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2097 #define isGV_with_GP_on(sv) STMT_START { \
2098 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2099 assert (!SvPOKp(sv)); \
2100 assert (!SvIOKp(sv)); \
2101 (SvFLAGS(sv) |= SVpgv_GP); \
2103 #define isGV_with_GP_off(sv) STMT_START { \
2104 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2105 assert (!SvPOKp(sv)); \
2106 assert (!SvIOKp(sv)); \
2107 (SvFLAGS(sv) &= ~SVpgv_GP); \
2109 #define isREGEXP(sv) \
2110 (SvTYPE(sv) == SVt_REGEXP \
2111 || (SvFLAGS(sv) & (SVTYPEMASK|SVp_POK|SVpgv_GP|SVf_FAKE)) \
2112 == (SVt_PVLV|SVf_FAKE))
2116 # define SvGROW(sv,len) \
2117 (SvIsCOW(sv) || SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2119 # define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2121 #define SvGROW_mutable(sv,len) \
2122 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2123 #define Sv_Grow sv_grow
2125 #define CLONEf_COPY_STACKS 1
2126 #define CLONEf_KEEP_PTR_TABLE 2
2127 #define CLONEf_CLONE_HOST 4
2128 #define CLONEf_JOIN_IN 8
2130 struct clone_params {
2133 PerlInterpreter *proto_perl;
2134 PerlInterpreter *new_perl;
2139 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2141 Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
2142 characters) into it. If C<utf8> is true, calls
2143 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2148 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2151 =for apidoc Amx|SV*|newSVpadname|PADNAME *pn
2153 Creates a new SV containing the pad name.
2158 #define newSVpadname(pn) newSVpvn_utf8(PadnamePV(pn), PadnameLEN(pn), TRUE)
2161 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2163 Reads into C<len> the offset from C<SvPVX> back to the true start of the
2164 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2165 efficiently remove characters from start of the buffer. Implemented as a
2166 macro, which takes the address of C<len>, which must be of type C<STRLEN>.
2167 Evaluates C<sv> more than once. Sets C<len> to 0 if C<SvOOK(sv)> is false.
2173 /* Does the bot know something I don't?
2174 10:28 <@Nicholas> metabatman
2175 10:28 <+meta> Nicholas: crash
2177 # define SvOOK_offset(sv, offset) STMT_START { \
2178 assert(sizeof(offset) == sizeof(STRLEN)); \
2180 const U8 *_crash = (U8*)SvPVX_const(sv); \
2181 (offset) = *--_crash; \
2183 _crash -= sizeof(STRLEN); \
2184 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
2187 /* Validate the preceding buffer's sentinels to \
2188 verify that no-one is using it. */ \
2189 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2190 while (_crash > _bonk) { \
2192 assert (*_crash == (U8)PTR2UV(_crash)); \
2200 /* This is the same code, but avoids using any temporary variables: */
2201 # define SvOOK_offset(sv, offset) STMT_START { \
2202 assert(sizeof(offset) == sizeof(STRLEN)); \
2204 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2206 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2207 (U8*)&(offset), sizeof(STRLEN), U8); \
2215 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2217 #define SV_CONST(name) \
2218 PL_sv_consts[SV_CONST_##name] \
2219 ? PL_sv_consts[SV_CONST_##name] \
2220 : (PL_sv_consts[SV_CONST_##name] = newSVpv_share(#name, 0))
2222 #define SV_CONST_TIESCALAR 0
2223 #define SV_CONST_TIEARRAY 1
2224 #define SV_CONST_TIEHASH 2
2225 #define SV_CONST_TIEHANDLE 3
2227 #define SV_CONST_FETCH 4
2228 #define SV_CONST_FETCHSIZE 5
2229 #define SV_CONST_STORE 6
2230 #define SV_CONST_STORESIZE 7
2231 #define SV_CONST_EXISTS 8
2233 #define SV_CONST_PUSH 9
2234 #define SV_CONST_POP 10
2235 #define SV_CONST_SHIFT 11
2236 #define SV_CONST_UNSHIFT 12
2237 #define SV_CONST_SPLICE 13
2238 #define SV_CONST_EXTEND 14
2240 #define SV_CONST_FIRSTKEY 15
2241 #define SV_CONST_NEXTKEY 16
2242 #define SV_CONST_SCALAR 17
2244 #define SV_CONST_OPEN 18
2245 #define SV_CONST_WRITE 19
2246 #define SV_CONST_PRINT 20
2247 #define SV_CONST_PRINTF 21
2248 #define SV_CONST_READ 22
2249 #define SV_CONST_READLINE 23
2250 #define SV_CONST_GETC 24
2251 #define SV_CONST_SEEK 25
2252 #define SV_CONST_TELL 26
2253 #define SV_CONST_EOF 27
2254 #define SV_CONST_BINMODE 28
2255 #define SV_CONST_FILENO 29
2256 #define SV_CONST_CLOSE 30
2258 #define SV_CONST_DELETE 31
2259 #define SV_CONST_CLEAR 32
2260 #define SV_CONST_UNTIE 33
2261 #define SV_CONST_DESTROY 34
2263 #define SV_CONSTS_COUNT 35
2266 * Bodyless IVs and NVs!
2268 * Since 5.9.2, we can avoid allocating a body for SVt_IV-type SVs.
2269 * Since the larger IV-holding variants of SVs store their integer
2270 * values in their respective bodies, the family of SvIV() accessor
2271 * macros would naively have to branch on the SV type to find the
2272 * integer value either in the HEAD or BODY. In order to avoid this
2273 * expensive branch, a clever soul has deployed a great hack:
2274 * We set up the SvANY pointer such that instead of pointing to a
2275 * real body, it points into the memory before the location of the
2276 * head. We compute this pointer such that the location of
2277 * the integer member of the hypothetical body struct happens to
2278 * be the same as the location of the integer member of the bodyless
2279 * SV head. This now means that the SvIV() family of accessors can
2280 * always read from the (hypothetical or real) body via SvANY.
2282 * Since the 5.21 dev series, we employ the same trick for NVs
2283 * if the architecture can support it (NVSIZE <= IVSIZE).
2286 /* The following two macros compute the necessary offsets for the above
2287 * trick and store them in SvANY for SvIV() (and friends) to use. */
2290 # define SET_SVANY_FOR_BODYLESS_IV(sv) \
2291 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) \
2292 - STRUCT_OFFSET(XPVIV, xiv_iv))
2294 # define SET_SVANY_FOR_BODYLESS_NV(sv) \
2295 SvANY(sv) = (XPVNV*)((char*)&(sv->sv_u.svu_nv) \
2296 - STRUCT_OFFSET(XPVNV, xnv_u.xnv_nv))
2300 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob