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() */
16 =for apidoc_section $SV_flags
18 =for apidoc Ay||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 AmnU||SVt_NULL
76 Type flag for scalars. See L</svtype>.
78 =for apidoc AmnU||SVt_IV
79 Type flag for scalars. See L</svtype>.
81 =for apidoc AmnU||SVt_NV
82 Type flag for scalars. See L</svtype>.
84 =for apidoc AmnU||SVt_PV
85 Type flag for scalars. See L</svtype>.
87 =for apidoc AmnU||SVt_PVIV
88 Type flag for scalars. See L</svtype>.
90 =for apidoc AmnU||SVt_PVNV
91 Type flag for scalars. See L</svtype>.
93 =for apidoc AmnU||SVt_PVMG
94 Type flag for scalars. See L</svtype>.
96 =for apidoc CmnU||SVt_INVLIST
97 Type flag for scalars. See L<perlapi/svtype>.
99 =for apidoc AmnU||SVt_REGEXP
100 Type flag for regular expressions. See L</svtype>.
102 =for apidoc AmnU||SVt_PVGV
103 Type flag for typeglobs. See L</svtype>.
105 =for apidoc AmnU||SVt_PVLV
106 Type flag for scalars. See L</svtype>.
108 =for apidoc AmnU||SVt_PVAV
109 Type flag for arrays. See L</svtype>.
111 =for apidoc AmnU||SVt_PVHV
112 Type flag for hashes. See L</svtype>.
114 =for apidoc AmnU||SVt_PVCV
115 Type flag for subroutines. See L</svtype>.
117 =for apidoc AmnU||SVt_PVFM
118 Type flag for formats. See L</svtype>.
120 =for apidoc AmnU||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 /* 16-31: Unused, though one should be reserved for a
153 * freed sv, if the other 3 bits below the flags ones
155 SVt_LAST /* keep last in enum. used to size arrays */
158 /* *** any alterations to the SV types above need to be reflected in
159 * SVt_MASK and the various PL_valid_types_* tables. As of this writing those
160 * tables are in perl.h. There are also two affected names tables in dump.c,
161 * one in B.xs, and 'bodies_by_type[]' in sv.c.
163 * The bits that match 0xe0 are CURRENTLY UNUSED
164 * The bits above that are for flags, like SVf_IOK */
166 #define SVt_MASK 0x1f /* smallest bitmask that covers all types */
169 /* Fast Boyer Moore tables are now stored in magic attached to PVMGs */
170 # define SVt_PVBM SVt_PVMG
171 /* Anything wanting to create a reference from clean should ensure that it has
172 a scalar of type SVt_IV now: */
173 # define SVt_RV SVt_IV
176 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
177 so never reaches the clause at the end that uses sv_type_details->body_size
178 to determine whether to call safefree(). Hence body_size can be set
179 non-zero to record the size of HEs, without fear of bogus frees. */
180 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
181 #define HE_SVSLOT SVt_NULL
184 # define SVt_FIRST SVt_NULL /* the type of SV that new_SV() in sv.c returns */
187 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
189 /* typedefs to eliminate some typing */
190 typedef struct he HE;
191 typedef struct hek HEK;
193 /* Using C's structural equivalence to help emulate C++ inheritance here... */
195 /* start with 2 sv-head building blocks */
196 #define _SV_HEAD(ptrtype) \
197 ptrtype sv_any; /* pointer to body */ \
198 U32 sv_refcnt; /* how many references to us */ \
199 U32 sv_flags /* what we are */
202 # define _NV_BODYLESS_UNION NV svu_nv;
204 # define _NV_BODYLESS_UNION
207 #define _SV_HEAD_UNION \
209 char* svu_pv; /* pointer to malloced string */ \
213 SV* svu_rv; /* pointer to another SV */ \
221 #ifdef DEBUG_LEAKING_SCALARS
222 #define _SV_HEAD_DEBUG ;\
223 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */ \
224 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */ \
225 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */ \
226 UV sv_debug_serial; /* serial number of sv allocation */ \
227 char * sv_debug_file; /* the file where we were allocated */ \
228 SV * sv_debug_parent /* what we were cloned from (ithreads)*/
230 #define _SV_HEAD_DEBUG
233 struct STRUCT_SV { /* struct sv { */
239 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
244 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
249 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
254 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
259 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
264 _SV_HEAD(struct regexp*); /* pointer to regexp body */
269 _SV_HEAD(XINVLIST*); /* pointer to xpvinvlist body */
274 #undef _SV_HEAD_UNION /* ensure no pollution */
277 =for apidoc_section $SV
279 =for apidoc Am|U32|SvREFCNT|SV* sv
280 Returns the value of the object's reference count. Exposed
281 to perl code via Internals::SvREFCNT().
283 =for apidoc SvREFCNT_inc
284 =for apidoc_item SvREFCNT_inc_NN
285 =for apidoc_item SvREFCNT_inc_void
286 =for apidoc_item |void|SvREFCNT_inc_void_NN|SV* sv
287 =for apidoc_item |SV*|SvREFCNT_inc_simple|SV* sv
288 =for apidoc_item |SV*|SvREFCNT_inc_simple_NN|SV* sv
289 =for apidoc_item |void|SvREFCNT_inc_simple_void|SV* sv
290 =for apidoc_item |void|SvREFCNT_inc_simple_void_NN|SV* sv
292 These all increment the reference count of the given SV.
293 The ones without C<void> in their names return the SV.
295 C<SvREFCNT_inc> is the base operation; the rest are optimizations if various
296 input constraints are known to be true; hence, all can be replaced with
299 C<SvREFCNT_inc_NN> can only be used if you know C<sv> is not C<NULL>. Since we
300 don't have to check the NULLness, it's faster and smaller.
302 C<SvREFCNT_inc_void> can only be used if you don't need the
303 return value. The macro doesn't need to return a meaningful value.
305 C<SvREFCNT_inc_void_NN> can only be used if you both don't need the return
306 value, and you know that C<sv> is not C<NULL>. The macro doesn't need to
307 return a meaningful value, or check for NULLness, so it's smaller and faster.
309 C<SvREFCNT_inc_simple> can only be used with expressions without side
310 effects. Since we don't have to store a temporary value, it's faster.
312 C<SvREFCNT_inc_simple_NN> can only be used with expressions without side
313 effects and you know C<sv> is not C<NULL>. Since we don't have to store a
314 temporary value, nor check for NULLness, it's faster and smaller.
316 C<SvREFCNT_inc_simple_void> can only be used with expressions without side
317 effects and you don't need the return value.
319 C<SvREFCNT_inc_simple_void_NN> can only be used with expressions without side
320 effects, you don't need the return value, and you know C<sv> is not C<NULL>.
322 =for apidoc SvREFCNT_dec
323 =for apidoc_item SvREFCNT_dec_NN
325 These decrement the reference count of the given SV.
327 C<SvREFCNT_dec_NN> may only be used when C<sv> is known to not be C<NULL>.
329 =for apidoc Am|svtype|SvTYPE|SV* sv
330 Returns the type of the SV. See C<L</svtype>>.
332 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
333 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
334 perform the upgrade if necessary. See C<L</svtype>>.
339 #define SvANY(sv) (sv)->sv_any
340 #define SvFLAGS(sv) (sv)->sv_flags
341 #define SvREFCNT(sv) (sv)->sv_refcnt
343 #define SvREFCNT_inc(sv) Perl_SvREFCNT_inc(MUTABLE_SV(sv))
344 #define SvREFCNT_inc_simple(sv) SvREFCNT_inc(sv)
345 #define SvREFCNT_inc_NN(sv) Perl_SvREFCNT_inc_NN(MUTABLE_SV(sv))
346 #define SvREFCNT_inc_void(sv) Perl_SvREFCNT_inc_void(MUTABLE_SV(sv))
348 /* These guys don't need the curly blocks */
349 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
350 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
351 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
352 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
354 #define SvREFCNT_dec(sv) Perl_SvREFCNT_dec(aTHX_ MUTABLE_SV(sv))
355 #define SvREFCNT_dec_NN(sv) Perl_SvREFCNT_dec_NN(aTHX_ MUTABLE_SV(sv))
357 #define SVTYPEMASK 0xff
358 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
360 /* Sadly there are some parts of the core that have pointers to already-freed
361 SV heads, and rely on being able to tell that they are now free. So mark
362 them all by using a consistent macro. */
363 #define SvIS_FREED(sv) UNLIKELY(((sv)->sv_flags == SVTYPEMASK))
365 /* this is defined in this peculiar way to avoid compiler warnings.
366 * See the <20121213131428.GD1842@iabyn.com> thread in p5p */
367 #define SvUPGRADE(sv, mt) \
368 ((void)(SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt),1)))
370 #define SVf_IOK 0x00000100 /* has valid public integer value */
371 #define SVf_NOK 0x00000200 /* has valid public numeric value */
372 #define SVf_POK 0x00000400 /* has valid public pointer value */
373 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
375 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
376 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
377 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
378 #define SVp_SCREAM 0x00008000 /* currently unused on plain scalars */
379 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
380 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
381 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
382 subroutine in another package. Set the
383 GvIMPORTED_CV_on() if it needs to be
384 expanded to a real GV */
386 /* SVf_PROTECT is what SVf_READONLY should have been: i.e. modifying
387 * this SV is completely illegal. However, SVf_READONLY (via
388 * Internals::SvREADONLY()) has come to be seen as a flag that can be
389 * temporarily set and unset by the user to indicate e.g. whether a hash
390 * is "locked". Now, Hash::Util et al only set SVf_READONLY, while core
391 * sets both (SVf_READONLY|SVf_PROTECT) to indicate both to core and user
392 * code that this SV should not be messed with.
394 #define SVf_PROTECT 0x00010000 /* very read-only */
395 #define SVs_PADTMP 0x00020000 /* in use as tmp */
396 #define SVs_PADSTALE 0x00040000 /* lexical has gone out of scope;
397 only used when !PADTMP */
398 #define SVs_TEMP 0x00080000 /* mortal (implies string is stealable) */
399 #define SVs_OBJECT 0x00100000 /* is "blessed" */
400 #define SVs_GMG 0x00200000 /* has magical get method */
401 #define SVs_SMG 0x00400000 /* has magical set method */
402 #define SVs_RMG 0x00800000 /* has random magical methods */
404 #define SVf_FAKE 0x01000000 /* 0: glob is just a copy
405 1: SV head arena wasn't malloc()ed
406 2: For PVCV, whether CvUNIQUE(cv)
407 refers to an eval or once only
408 [CvEVAL(cv), CvSPECIAL(cv)]
409 3: HV: informally reserved by DAPM
411 4: Together with other flags (or
412 lack thereof) indicates a regex,
413 including PVLV-as-regex. See
416 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
417 means that a hv_aux struct is present
418 after the main array */
419 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
420 SVs in final arena cleanup.
421 Set in S_regtry on PL_reg_curpm, so that
422 perl_destruct will skip it.
423 Used for mark and sweep by OP_AASSIGN
425 #define SVf_READONLY 0x08000000 /* may not be modified */
430 #define SVf_THINKFIRST (SVf_READONLY|SVf_PROTECT|SVf_ROK|SVf_FAKE \
433 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
434 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
436 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
438 /* SVf_AMAGIC means that the stash *may* have overload methods. It's
439 * set each time a function is compiled into a stash, and is reset by the
440 * overload code when called for the first time and finds that there are
441 * no overload methods. Note that this used to be set on the object; but
442 * is now only set on stashes.
444 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
445 #define SVf_IsCOW 0x10000000 /* copy on write (shared hash key if
448 /* Ensure this value does not clash with the GV_ADD* flags in gv.h, or the
449 CV_CKPROTO_* flags in op.c, or the padadd_* flags in pad.h: */
450 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
451 This is also set on RVs whose overloaded
452 stringification is UTF-8. This might
453 only happen as a side effect of SvPV() */
455 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
457 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
458 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
459 been restructured, so sometimes get used as string buffers. */
462 /* Some private flags. */
466 #define SVpav_REAL 0x40000000 /* free old entries */
468 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
470 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
471 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
473 #define SVpav_REIFY 0x80000000 /* can become real */
475 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
476 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
477 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
478 /* pad name vars only */
481 HV* xmg_stash; /* class package */ \
483 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
485 STRLEN xpvlenu_len; /* allocated size */ \
486 struct regexp* xpvlenu_rx; /* regex when SV body is XPVLV */ \
489 #define xpv_len xpv_len_u.xpvlenu_len
492 NV xnv_nv; /* numeric value, if any */
494 line_t xnv_lines; /* used internally by S_scan_subst() */
495 bool xnv_bm_tail; /* an SvVALID (BM) SV has an implicit "\n" */
499 IV xivu_iv; /* integer value */
501 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
502 bool xivu_eval_seen; /* used internally by S_scan_subst() */
507 MAGIC* xmg_magic; /* linked list of magicalness */
508 STRLEN xmg_hash_index; /* used while freeing hash entries */
520 #define xiv_iv xiv_u.xivu_iv
527 #define xuv_uv xuv_u.xivu_uv
535 /* This structure must match the beginning of struct xpvhv in hv.h. */
548 SSize_t xlvu_stargoff;
552 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
553 * y=alem/helem/iter t=tie T=tied HE */
554 char xlv_flags; /* 1 = negative offset 2 = negative len
555 4 = out of range (vec) */
558 #define xlv_targoff xlv_targoff_u.xlvu_targoff
562 IV prev_index; /* caches result of previous invlist_search() */
563 STRLEN iterator; /* Stores where we are in iterating */
564 bool is_offset; /* The data structure for all inversion lists
565 begins with an element for code point U+0000.
566 If this bool is set, the actual list contains
567 that 0; otherwise, the list actually begins
568 with the following element. Thus to invert
569 the list, merely toggle this flag */
572 /* This structure works in 2 ways - regular scalar, or GV with GP */
580 typedef U32 cv_flags_t;
582 #define _XPVCV_COMMON \
590 void (*xcv_xsub) (pTHX_ CV*); \
598 PADLIST * xcv_padlist; \
602 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
603 * compilation) in the lexically enclosing \
605 cv_flags_t xcv_flags; \
606 I32 xcv_depth /* >= 2 indicates recursive call */
608 /* This structure must match XPVCV in cv.h */
619 /* ifp and ofp are normally the same, but sockets need separate streams */
621 /* Cray addresses everything by word boundaries (64 bits) and
622 * code and data pointers cannot be mixed (which is exactly what
623 * Perl_filter_add() tries to do with the dirp), hence the
624 * following union trick (as suggested by Gurusamy Sarathy).
625 * For further information see Geir Johansen's problem report
626 * titled [ID 20000612.002 (#3366)] Perl problem on Cray system
627 * The any pointer (known as IoANY()) will also be a good place
628 * to hang any IO disciplines to.
631 DIR * xiou_dirp; /* for opendir, readdir, etc */
632 void * xiou_any; /* for alignment */
634 /* IV xio_lines is now in IVX $. */
635 IV xio_page; /* $% */
636 IV xio_page_len; /* $= */
637 IV xio_lines_left; /* $- */
638 char * xio_top_name; /* $^ */
639 GV * xio_top_gv; /* $^ */
640 char * xio_fmt_name; /* $~ */
641 GV * xio_fmt_gv; /* $~ */
642 char * xio_bottom_name;/* $^B */
643 GV * xio_bottom_gv; /* $^B */
648 #define xio_dirp xio_dirpu.xiou_dirp
649 #define xio_any xio_dirpu.xiou_any
651 #define IOf_ARGV 1 /* this fp iterates over ARGV */
652 #define IOf_START 2 /* check for null ARGV and substitute '-' */
653 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
654 #define IOf_DIDTOP 8 /* just did top of form */
655 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
656 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
657 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
658 Also, when this is set, SvPVX() is valid */
660 /* The following macros define implementation-independent predicates on SVs. */
663 =for apidoc Am|U32|SvNIOK|SV* sv
664 Returns a U32 value indicating whether the SV contains a number, integer or
667 =for apidoc Am|U32|SvNIOKp|SV* sv
668 Returns a U32 value indicating whether the SV contains a number, integer or
669 double. Checks the B<private> setting. Use C<SvNIOK> instead.
671 =for apidoc Am|void|SvNIOK_off|SV* sv
672 Unsets the NV/IV status of an SV.
674 =for apidoc Am|U32|SvOK|SV* sv
675 Returns a U32 value indicating whether the value is defined. This is
676 only meaningful for scalars.
678 =for apidoc Am|U32|SvIOKp|SV* sv
679 Returns a U32 value indicating whether the SV contains an integer. Checks
680 the B<private> setting. Use C<SvIOK> instead.
682 =for apidoc Am|U32|SvNOKp|SV* sv
683 Returns a U32 value indicating whether the SV contains a double. Checks the
684 B<private> setting. Use C<SvNOK> instead.
686 =for apidoc Am|U32|SvPOKp|SV* sv
687 Returns a U32 value indicating whether the SV contains a character string.
688 Checks the B<private> setting. Use C<SvPOK> instead.
690 =for apidoc Am|U32|SvIOK|SV* sv
691 Returns a U32 value indicating whether the SV contains an integer.
693 =for apidoc Am|void|SvIOK_on|SV* sv
694 Tells an SV that it is an integer.
696 =for apidoc Am|void|SvIOK_off|SV* sv
697 Unsets the IV status of an SV.
699 =for apidoc Am|void|SvIOK_only|SV* sv
700 Tells an SV that it is an integer and disables all other C<OK> bits.
702 =for apidoc Am|void|SvIOK_only_UV|SV* sv
703 Tells an SV that it is an unsigned integer and disables all other C<OK> bits.
705 =for apidoc Am|bool|SvIOK_UV|SV* sv
706 Returns a boolean indicating whether the SV contains an integer that must be
707 interpreted as unsigned. A non-negative integer whose value is within the
708 range of both an IV and a UV may be flagged as either C<SvUOK> or C<SvIOK>.
710 =for apidoc Am|bool|SvUOK|SV* sv
711 Returns a boolean indicating whether the SV contains an integer that must be
712 interpreted as unsigned. A non-negative integer whose value is within the
713 range of both an IV and a UV may be flagged as either C<SvUOK> or C<SvIOK>.
715 =for apidoc Am|bool|SvIOK_notUV|SV* sv
716 Returns a boolean indicating whether the SV contains a signed integer.
718 =for apidoc Am|U32|SvNOK|SV* sv
719 Returns a U32 value indicating whether the SV contains a double.
721 =for apidoc Am|void|SvNOK_on|SV* sv
722 Tells an SV that it is a double.
724 =for apidoc Am|void|SvNOK_off|SV* sv
725 Unsets the NV status of an SV.
727 =for apidoc Am|void|SvNOK_only|SV* sv
728 Tells an SV that it is a double and disables all other OK bits.
730 =for apidoc Am|U32|SvPOK|SV* sv
731 Returns a U32 value indicating whether the SV contains a character
734 =for apidoc Am|void|SvPOK_on|SV* sv
735 Tells an SV that it is a string.
737 =for apidoc Am|void|SvPOK_off|SV* sv
738 Unsets the PV status of an SV.
740 =for apidoc Am|void|SvPOK_only|SV* sv
741 Tells an SV that it is a string and disables all other C<OK> bits.
742 Will also turn off the UTF-8 status.
744 =for apidoc Am|bool|SvVOK|SV* sv
745 Returns a boolean indicating whether the SV contains a v-string.
747 =for apidoc Am|U32|SvOOK|SV* sv
748 Returns a U32 indicating whether the pointer to the string buffer is offset.
749 This hack is used internally to speed up removal of characters from the
750 beginning of a C<L</SvPV>>. When C<SvOOK> is true, then the start of the
751 allocated string buffer is actually C<SvOOK_offset()> bytes before C<SvPVX>.
752 This offset used to be stored in C<SvIVX>, but is now stored within the spare
755 =for apidoc Am|U32|SvROK|SV* sv
756 Tests if the SV is an RV.
758 =for apidoc Am|void|SvROK_on|SV* sv
759 Tells an SV that it is an RV.
761 =for apidoc Am|void|SvROK_off|SV* sv
762 Unsets the RV status of an SV.
764 =for apidoc Am|SV*|SvRV|SV* sv
765 Dereferences an RV to return the SV.
767 =for apidoc Am|IV|SvIVX|SV* sv
768 Returns the raw value in the SV's IV slot, without checks or conversions.
769 Only use when you are sure C<SvIOK> is true. See also C<L</SvIV>>.
771 =for apidoc Am|UV|SvUVX|SV* sv
772 Returns the raw value in the SV's UV slot, without checks or conversions.
773 Only use when you are sure C<SvIOK> is true. See also C<L</SvUV>>.
775 =for apidoc AmD|UV|SvUVXx|SV* sv
776 This is an unnecessary synonym for L</SvUVX>
778 =for apidoc Am|NV|SvNVX|SV* sv
779 Returns the raw value in the SV's NV slot, without checks or conversions.
780 Only use when you are sure C<SvNOK> is true. See also C<L</SvNV>>.
782 =for apidoc Am|char*|SvPVX|SV* sv
783 =for apidoc_item |char*|SvPVXx|SV* sv
784 =for apidoc_item |const char*|SvPVX_const|SV* sv
785 =for apidoc_item |char*|SvPVX_mutable|SV* sv
787 These return a pointer to the physical string in the SV. The SV must contain a
788 string. Prior to 5.9.3 it is not safe to execute these unless the SV's
791 These are also used to store the name of an autoloaded subroutine in an XS
792 AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
794 C<SvPVXx> is identical to C<SvPVX>.
796 C<SvPVX_mutable> is merely a synonym for C<SvPVX>, but its name emphasizes that
797 the string is modifiable by the caller.
799 C<SvPVX_const> differs in that the return value has been cast so that the
800 compiler will complain if you were to try to modify the contents of the string,
801 (unless you cast away const yourself).
803 =for apidoc Am|STRLEN|SvCUR|SV* sv
804 Returns the length, in bytes, of the PV inside the SV.
805 Note that this may not match Perl's C<length>; for that, use
806 C<sv_len_utf8(sv)>. See C<L</SvLEN>> also.
808 =for apidoc Am|STRLEN|SvLEN|SV* sv
809 Returns the size of the string buffer in the SV, not including any part
810 attributable to C<SvOOK>. See C<L</SvCUR>>.
812 =for apidoc Am|char*|SvEND|SV* sv
813 Returns a pointer to the spot just after the last character in
814 the string which is in the SV, where there is usually a trailing
815 C<NUL> character (even though Perl scalars do not strictly require it).
816 See C<L</SvCUR>>. Access the character as C<*(SvEND(sv))>.
818 Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
821 =for apidoc Am|HV*|SvSTASH|SV* sv
822 Returns the stash of the SV.
824 =for apidoc Am|void|SvIV_set|SV* sv|IV val
825 Set the value of the IV pointer in sv to val. It is possible to perform
826 the same function of this macro with an lvalue assignment to C<SvIVX>.
827 With future Perls, however, it will be more efficient to use
828 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
830 =for apidoc Am|void|SvNV_set|SV* sv|NV val
831 Set the value of the NV pointer in C<sv> to val. See C<L</SvIV_set>>.
833 =for apidoc Am|void|SvPV_set|SV* sv|char* val
834 This is probably not what you want to use, you probably wanted
835 L</sv_usepvn_flags> or L</sv_setpvn> or L</sv_setpvs>.
837 Set the value of the PV pointer in C<sv> to the Perl allocated
838 C<NUL>-terminated string C<val>. See also C<L</SvIV_set>>.
840 Remember to free the previous PV buffer. There are many things to check.
841 Beware that the existing pointer may be involved in copy-on-write or other
842 mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or
843 C<SvPV_force> (or check the C<SvIsCOW> flag) first to make sure this
844 modification is safe. Then finally, if it is not a COW, call
845 C<L</SvPV_free>> to free the previous PV buffer.
847 =for apidoc Am|void|SvUV_set|SV* sv|UV val
848 Set the value of the UV pointer in C<sv> to val. See C<L</SvIV_set>>.
850 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
851 Set the value of the RV pointer in C<sv> to val. See C<L</SvIV_set>>.
853 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
854 Set the value of the MAGIC pointer in C<sv> to val. See C<L</SvIV_set>>.
856 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
857 Set the value of the STASH pointer in C<sv> to val. See C<L</SvIV_set>>.
859 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
860 Sets the current length, in bytes, of the C string which is in the SV.
861 See C<L</SvCUR>> and C<SvIV_set>>.
863 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
864 Set the size of the string buffer for the SV. See C<L</SvLEN>>.
869 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
870 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
871 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
872 SVp_IOK|SVp_NOK|SVf_IVisUV))
874 #define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv))
875 #define assert_not_glob(sv) assert_(!isGV_with_GP(sv))
877 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
878 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
879 SvFLAGS(sv) &= ~(SVf_OK| \
880 SVf_IVisUV|SVf_UTF8), \
882 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
883 SvFLAGS(sv) &= ~(SVf_OK| \
887 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
888 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
889 #define SvIOKp_on(sv) (assert_not_glob(sv) \
890 SvFLAGS(sv) |= SVp_IOK)
891 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
892 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
893 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
894 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
895 SvFLAGS(sv) |= SVp_POK)
897 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
898 #define SvIOK_on(sv) (assert_not_glob(sv) \
899 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
900 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
901 #define SvIOK_only(sv) (SvOK_off(sv), \
902 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
903 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
904 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
906 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
907 == (SVf_IOK|SVf_IVisUV))
908 #define SvUOK(sv) SvIOK_UV(sv)
909 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
912 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
913 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
914 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
916 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
917 #define SvNOK_on(sv) (assert_not_glob(sv) \
918 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
919 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
920 #define SvNOK_only(sv) (SvOK_off(sv), \
921 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
924 =for apidoc Am|U32|SvUTF8|SV* sv
925 Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
926 properly, this indicates whether or not the SV contains UTF-8 encoded data.
927 You should use this I<after> a call to C<L</SvPV>> or one of its variants, in
928 case any call to string overloading updates the internal flag.
930 If you want to take into account the L<bytes> pragma, use C<L</DO_UTF8>>
933 =for apidoc Am|void|SvUTF8_on|SV *sv
934 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
935 Do not use frivolously.
937 =for apidoc Am|void|SvUTF8_off|SV *sv
938 Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
939 Do not use frivolously.
941 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
942 Tells an SV that it is a string and disables all other C<OK> bits,
943 and leaves the UTF-8 status as it was.
948 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
950 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
951 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
952 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
954 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
955 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
956 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
957 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
958 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
959 SvFLAGS(sv) &= ~(SVf_OK| \
960 SVf_IVisUV|SVf_UTF8), \
961 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
962 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
963 SvFLAGS(sv) &= ~(SVf_OK| \
965 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
967 #define SvVOK(sv) (SvMAGICAL(sv) \
968 && mg_find(sv,PERL_MAGIC_vstring))
970 =for apidoc Am|MAGIC*|SvVSTRING_mg|SV * sv
972 Returns the vstring magic, or NULL if none
976 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
977 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
979 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
980 #define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
984 =for apidoc Am|void|SvOOK_off|SV * sv
986 Remove any string offset.
991 #define SvOOK_off(sv) ((void)(SvOOK(sv) && (sv_backoff(sv),0)))
993 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
994 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
995 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
997 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
998 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
999 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
1001 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
1002 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
1003 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
1005 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
1006 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
1007 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
1009 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
1010 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
1011 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
1013 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
1014 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
1015 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
1017 #define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
1018 HvAMAGIC(SvSTASH(SvRV(sv))))
1020 /* To be used on the stashes themselves: */
1021 #define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
1022 #define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
1023 #define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
1026 /* "nog" means "doesn't have get magic" */
1027 #define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
1028 #define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
1029 #define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
1030 #define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
1031 #define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
1033 #define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1034 #define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
1035 #define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
1036 #define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
1037 #define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
1039 #define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1040 #define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1042 #define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
1043 #define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1045 #define SvPOK_pure_nogthink(sv) \
1046 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1047 #define SvPOK_utf8_pure_nogthink(sv) \
1048 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1049 #define SvPOK_byte_pure_nogthink(sv) \
1050 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1053 =for apidoc Am|U32|SvGAMAGIC|SV* sv
1055 Returns true if the SV has get magic or
1056 overloading. If either is true then
1057 the scalar is active data, and has the potential to return a new value every
1058 time it is accessed. Hence you must be careful to
1059 only read it once per user logical operation and work
1060 with that returned value. If neither is true then
1061 the scalar's value cannot change unless written to.
1066 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1068 #define Gv_AMG(stash) \
1069 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
1071 : (HvAMAGIC_off(stash), 0))
1073 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1074 == (SVf_ROK|SVprv_WEAKREF))
1075 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1076 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1078 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
1079 == (SVf_ROK|SVprv_PCS_IMPORTED))
1080 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
1081 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
1084 =for apidoc m|U32|SvTHINKFIRST|SV *sv
1086 A quick flag check to see whether an C<sv> should be passed to C<sv_force_normal>
1087 to be "downgraded" before C<SvIVX> or C<SvPVX> can be modified directly.
1089 For example, if your scalar is a reference and you want to modify the C<SvIVX>
1090 slot, you can't just do C<SvROK_off>, as that will leak the referent.
1092 This is used internally by various sv-modifying functions, such as
1093 C<sv_setsv>, C<sv_setiv> and C<sv_pvn_force>.
1095 One case that this does not handle is a gv without SvFAKE set. After
1097 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
1099 it will still be a gv.
1101 C<SvTHINKFIRST> sometimes produces false positives. In those cases
1102 C<sv_force_normal> does nothing.
1107 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1110 #define SvPADMY(sv) !(SvFLAGS(sv) & SVs_PADTMP)
1112 # define SvPADMY_on(sv) SvPADTMP_off(sv)
1115 #define SvPADTMP(sv) (SvFLAGS(sv) & (SVs_PADTMP))
1116 #define SvPADSTALE(sv) (SvFLAGS(sv) & (SVs_PADSTALE))
1118 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1119 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1120 #define SvPADSTALE_on(sv) Perl_SvPADSTALE_on(MUTABLE_SV(sv))
1121 #define SvPADSTALE_off(sv) Perl_SvPADSTALE_off(MUTABLE_SV(sv))
1123 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1124 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1125 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1127 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1128 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1129 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1132 =for apidoc Am|U32|SvREADONLY|SV* sv
1133 Returns true if the argument is readonly, otherwise returns false.
1134 Exposed to perl code via Internals::SvREADONLY().
1136 =for apidoc Am|U32|SvREADONLY_on|SV* sv
1137 Mark an object as readonly. Exactly what this means depends on the object
1138 type. Exposed to perl code via Internals::SvREADONLY().
1140 =for apidoc Am|U32|SvREADONLY_off|SV* sv
1141 Mark an object as not-readonly. Exactly what this mean depends on the
1142 object type. Exposed to perl code via Internals::SvREADONLY().
1147 #define SvREADONLY(sv) (SvFLAGS(sv) & (SVf_READONLY|SVf_PROTECT))
1149 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= (SVf_READONLY|SVf_PROTECT))
1150 # define SvREADONLY_off(sv) (SvFLAGS(sv) &=~(SVf_READONLY|SVf_PROTECT))
1152 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1153 # define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1156 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1157 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1158 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1161 # define SvCOMPILED(sv) 0
1162 # define SvCOMPILED_on(sv)
1163 # define SvCOMPILED_off(sv)
1167 #if defined (DEBUGGING) && defined(PERL_USE_GCC_BRACE_GROUPS)
1168 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
1169 assert(SvTYPE(_svtail) != SVt_PVAV); \
1170 assert(SvTYPE(_svtail) != SVt_PVHV); \
1171 assert(!(SvFLAGS(_svtail) & (SVf_NOK|SVp_NOK))); \
1172 assert(SvVALID(_svtail)); \
1173 ((XPVNV*)SvANY(_svtail))->xnv_u.xnv_bm_tail; \
1176 # define SvTAIL(_svtail) (((XPVNV*)SvANY(_svtail))->xnv_u.xnv_bm_tail)
1179 /* Does the SV have a Boyer-Moore table attached as magic?
1180 * 'VALID' is a poor name, but is kept for historical reasons. */
1181 #define SvVALID(_svvalid) ( \
1183 && SvSMAGICAL(_svvalid) \
1184 && SvMAGIC(_svvalid) \
1185 && (SvMAGIC(_svvalid)->mg_type == PERL_MAGIC_bm \
1186 || mg_find(_svvalid, PERL_MAGIC_bm)) \
1189 #define SvRVx(sv) SvRV(sv)
1191 #ifdef PERL_DEBUG_COW
1192 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1193 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1194 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1195 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1196 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1197 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1198 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1199 /* Don't test the core XS code yet. */
1200 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1201 # define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
1203 # define SvPVX(sv) SvPVX_mutable(sv)
1205 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1206 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1207 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1209 # define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1210 # define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
1211 #else /* Below is not PERL_DEBUG_COW */
1213 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1215 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1217 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1219 # if defined (DEBUGGING) && defined(PERL_USE_GCC_BRACE_GROUPS)
1220 /* These get expanded inside other macros that already use a variable _sv */
1221 # define SvPVX(sv) \
1222 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1223 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
1224 assert(!isGV_with_GP(_svpvx)); \
1225 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1226 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
1227 &((_svpvx)->sv_u.svu_pv); \
1230 # define SvCUR(sv) \
1231 ({ const SV *const _svcur = (const SV *)(sv); \
1232 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK]); \
1233 assert(!isGV_with_GP(_svcur)); \
1234 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1235 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1236 (((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1239 # define SvCUR(sv) \
1240 (*({ const SV *const _svcur = (const SV *)(sv); \
1241 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK]); \
1242 assert(!isGV_with_GP(_svcur)); \
1243 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1244 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1245 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1248 # define SvIVX(sv) \
1249 (*({ const SV *const _svivx = (const SV *)(sv); \
1250 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
1251 assert(!isGV_with_GP(_svivx)); \
1252 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1254 # define SvUVX(sv) \
1255 (*({ const SV *const _svuvx = (const SV *)(sv); \
1256 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
1257 assert(!isGV_with_GP(_svuvx)); \
1258 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1260 # define SvNVX(sv) \
1261 (*({ const SV *const _svnvx = (const SV *)(sv); \
1262 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
1263 assert(!isGV_with_GP(_svnvx)); \
1264 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1267 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1268 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1269 assert(!isGV_with_GP(_svrv)); \
1270 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1271 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1272 &((_svrv)->sv_u.svu_rv); \
1274 # define SvRV_const(sv) \
1275 ({ const SV *const _svrv = (const SV *)(sv); \
1276 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1277 assert(!isGV_with_GP(_svrv)); \
1278 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1279 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1280 (_svrv)->sv_u.svu_rv; \
1282 # define SvMAGIC(sv) \
1283 (*({ const SV *const _svmagic = (const SV *)(sv); \
1284 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1285 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1287 # define SvSTASH(sv) \
1288 (*({ const SV *const _svstash = (const SV *)(sv); \
1289 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1290 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1292 # else /* Below is not DEBUGGING or can't use brace groups */
1293 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1294 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1295 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1296 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1297 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1298 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1299 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1300 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1301 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1306 /* Given that these two are new, there can't be any existing code using them
1307 * as LVALUEs, so prevent that from happening */
1308 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1309 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1311 /* Except for the poison code, which uses & to scribble over the pointer after
1312 free() is called. */
1313 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1314 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1317 #define SvIVXx(sv) SvIVX(sv)
1318 #define SvUVXx(sv) SvUVX(sv)
1319 #define SvNVXx(sv) SvNVX(sv)
1320 #define SvPVXx(sv) SvPVX(sv)
1321 #define SvLENx(sv) SvLEN(sv)
1322 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1325 /* Ask a scalar nicely to try to become an IV, if possible.
1326 Not guaranteed to stay returning void */
1327 /* Macro won't actually call sv_2iv if already IOK */
1328 #define SvIV_please(sv) \
1329 STMT_START {if (!SvIOKp(sv) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK))) \
1330 (void) SvIV(sv); } STMT_END
1331 #define SvIV_please_nomg(sv) \
1332 (!(SvFLAGS(sv) & (SVf_IOK|SVp_IOK)) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK)) \
1333 ? (sv_2iv_flags(sv, 0), SvIOK(sv)) \
1335 #define SvIV_set(sv, val) \
1337 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1338 assert(!isGV_with_GP(sv)); \
1339 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1340 #define SvNV_set(sv, val) \
1342 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
1343 assert(!isGV_with_GP(sv)); \
1344 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1345 #define SvPV_set(sv, val) \
1347 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1348 assert(!isGV_with_GP(sv)); \
1349 assert(!(SvTYPE(sv) == SVt_PVIO \
1350 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1351 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1352 #define SvUV_set(sv, val) \
1354 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1355 assert(!isGV_with_GP(sv)); \
1356 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1357 #define SvRV_set(sv, val) \
1359 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
1360 assert(!isGV_with_GP(sv)); \
1361 assert(!(SvTYPE(sv) == SVt_PVIO \
1362 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1363 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1364 #define SvMAGIC_set(sv, val) \
1365 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1366 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1367 #define SvSTASH_set(sv, val) \
1368 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1369 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1370 #define SvCUR_set(sv, val) \
1372 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1373 assert(!isGV_with_GP(sv)); \
1374 assert(!(SvTYPE(sv) == SVt_PVIO \
1375 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1376 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1377 #define SvLEN_set(sv, val) \
1379 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1380 assert(!isGV_with_GP(sv)); \
1381 assert(!(SvTYPE(sv) == SVt_PVIO \
1382 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1383 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1384 #define SvEND_set(sv, val) \
1385 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1386 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1389 =for apidoc Am|void|SvPV_renew|SV* sv|STRLEN len
1390 Low level micro optimization of C<L</SvGROW>>. It is generally better to use
1391 C<SvGROW> instead. This is because C<SvPV_renew> ignores potential issues that
1392 C<SvGROW> handles. C<sv> needs to have a real C<PV> that is unencombered by
1393 things like COW. Using C<SV_CHECK_THINKFIRST> or
1394 C<SV_CHECK_THINKFIRST_COW_DROP> before calling this should clean it up, but
1395 why not just use C<SvGROW> if you're not sure about the provenance?
1399 #define SvPV_renew(sv,n) \
1400 STMT_START { SvLEN_set(sv, n); \
1401 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1402 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1403 (MEM_SIZE)((n))))); \
1406 #define SvPV_shrink_to_cur(sv) STMT_START { \
1407 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1408 SvPV_renew(sv, _lEnGtH); \
1412 =for apidoc Am|void|SvPV_free|SV * sv
1414 Frees the PV buffer in C<sv>, leaving things in a precarious state, so should
1415 only be used as part of a larger operation
1419 #define SvPV_free(sv) \
1421 assert(SvTYPE(sv) >= SVt_PV); \
1423 assert(!SvROK(sv)); \
1424 if(UNLIKELY(SvOOK(sv))) { \
1426 SvOOK_offset(sv, zok); \
1427 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1428 SvFLAGS(sv) &= ~SVf_OOK; \
1430 Safefree(SvPVX(sv)); \
1435 /* Code that crops up in three places to take a scalar and ready it to hold
1437 # define prepare_SV_for_RV(sv) \
1439 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1440 sv_upgrade(sv, SVt_IV); \
1441 else if (SvTYPE(sv) >= SVt_PV) { \
1450 # define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1453 #if defined (DEBUGGING) && defined(PERL_USE_GCC_BRACE_GROUPS)
1454 # define BmUSEFUL(sv) \
1455 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1456 assert(SvTYPE(_bmuseful) >= SVt_PVIV); \
1457 assert(SvVALID(_bmuseful)); \
1458 assert(!SvIOK(_bmuseful)); \
1459 &(((XPVIV*) SvANY(_bmuseful))->xiv_u.xivu_iv); \
1462 # define BmUSEFUL(sv) ((XPVIV*) SvANY(sv))->xiv_u.xivu_iv
1467 # define BmRARE(sv) 0
1468 # define BmPREVIOUS(sv) 0
1471 #define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1473 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1474 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1475 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1476 #define LvSTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff_u.xlvu_stargoff
1477 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1478 #define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
1480 #define LVf_NEG_OFF 0x1
1481 #define LVf_NEG_LEN 0x2
1482 #define LVf_OUT_OF_RANGE 0x4
1484 #define IoIFP(sv) (sv)->sv_u.svu_fp
1485 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1486 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1487 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1488 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
1489 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1490 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1491 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1492 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1493 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1494 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1495 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1496 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1497 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1498 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1499 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1501 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1502 #define IoTYPE_RDONLY '<'
1503 #define IoTYPE_WRONLY '>'
1504 #define IoTYPE_RDWR '+'
1505 #define IoTYPE_APPEND 'a'
1506 #define IoTYPE_PIPE '|'
1507 #define IoTYPE_STD '-' /* stdin or stdout */
1508 #define IoTYPE_SOCKET 's'
1509 #define IoTYPE_CLOSED ' '
1510 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1511 #define IoTYPE_NUMERIC '#' /* fdopen */
1514 =for apidoc Am|bool|SvTAINTED|SV* sv
1515 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1518 =for apidoc Am|void|SvTAINTED_on|SV* sv
1519 Marks an SV as tainted if tainting is enabled.
1521 =for apidoc Am|void|SvTAINTED_off|SV* sv
1522 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1523 some of Perl's fundamental security features. XS module authors should not
1524 use this function unless they fully understand all the implications of
1525 unconditionally untainting the value. Untainting should be done in the
1526 standard perl fashion, via a carefully crafted regexp, rather than directly
1527 untainting variables.
1529 =for apidoc Am|void|SvTAINT|SV* sv
1530 Taints an SV if tainting is enabled, and if some input to the current
1531 expression is tainted--usually a variable, but possibly also implicit
1532 inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1533 the outputs of an expression in a pessimistic fashion; i.e., without paying
1534 attention to precisely which outputs are influenced by which inputs.
1539 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1541 #ifdef NO_TAINT_SUPPORT
1542 # define SvTAINTED(sv) 0
1544 # define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1546 #define SvTAINTED_on(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_taint(sv);} }STMT_END
1547 #define SvTAINTED_off(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_untaint(sv);} }STMT_END
1549 #define SvTAINT(sv) \
1551 assert(TAINTING_get || !TAINT_get); \
1552 if (UNLIKELY(TAINT_get)) \
1557 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1558 =for apidoc_item ||SvPV_force_nolen|SV* sv
1559 =for apidoc_item ||SvPVx_force|SV* sv|STRLEN len
1560 =for apidoc_item ||SvPV_force_nomg|SV* sv|STRLEN len
1561 =for apidoc_item ||SvPV_force_nomg_nolen|SV * sv
1562 =for apidoc_item ||SvPV_force_mutable|SV * sv|STRLEN len
1563 =for apidoc_item ||SvPV_force_flags|SV * sv|STRLEN len|U32 flags
1564 =for apidoc_item ||SvPV_force_flags_nolen|SV * sv|U32 flags
1565 =for apidoc_item ||SvPV_force_flags_mutable|SV * sv|STRLEN len|U32 flags
1566 =for apidoc_item ||SvPVbyte_force
1567 =for apidoc_item ||SvPVbytex_force
1568 =for apidoc_item ||SvPVutf8_force
1569 =for apidoc_item ||SvPVutf8x_force
1571 These are like C<L</SvPV>>, returning the string in the SV, but will force the
1572 SV into containing a string (C<L</SvPOK>>), and only a string
1573 (C<L</SvPOK_only>>), by hook or by crook. You need to use one of these
1574 C<force> routines if you are going to update the C<L</SvPVX>> directly.
1576 Note that coercing an arbitrary scalar into a plain PV will potentially
1577 strip useful data from it. For example if the SV was C<SvROK>, then the
1578 referent will have its reference count decremented, and the SV itself may
1579 be converted to an C<SvPOK> scalar with a string buffer containing a value
1580 such as C<"ARRAY(0x1234)">.
1582 The differences between the forms are:
1584 The forms with C<flags> in their names allow you to use the C<flags> parameter
1585 to specify to perform 'get' magic (by setting the C<SV_GMAGIC> flag) or to skip
1586 'get' magic (by clearing it). The other forms do perform 'get' magic, except
1587 for the ones with C<nomg> in their names, which skip 'get' magic.
1589 The forms that take a C<len> parameter will set that variable to the byte
1590 length of the resultant string (these are macros, so don't use C<&len>).
1592 The forms with C<nolen> in their names indicate they don't have a C<len>
1593 parameter. They should be used only when it is known that the PV is a C
1594 string, terminated by a NUL byte, and without intermediate NUL characters; or
1595 when you don't care about its length.
1597 The forms with C<mutable> in their names are effectively the same as those without,
1598 but the name emphasizes that the string is modifiable by the caller, which it is
1601 C<SvPVutf8_force> is like C<SvPV_force>, but converts C<sv> to UTF-8 first if
1604 C<SvPVutf8x_force> is like C<SvPVutf8_force>, but guarantees to evaluate C<sv>
1605 only once; use the more efficient C<SvPVutf8_force> otherwise.
1607 C<SvPVbyte_force> is like C<SvPV_force>, but converts C<sv> to byte
1608 representation first if currently encoded as UTF-8. If the SV cannot be
1609 downgraded from UTF-8, this croaks.
1611 C<SvPVbytex_force> is like C<SvPVbyte_force>, but guarantees to evaluate C<sv>
1612 only once; use the more efficient C<SvPVbyte_force> otherwise.
1614 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1615 =for apidoc_item |char*|SvPVx|SV* sv|STRLEN len
1616 =for apidoc_item |char*|SvPV_nomg|SV* sv|STRLEN len
1617 =for apidoc_item |char*|SvPV_nolen|SV* sv
1618 =for apidoc_item |char*|SvPVx_nolen|SV* sv
1619 =for apidoc_item |char*|SvPV_nomg_nolen|SV* sv
1620 =for apidoc_item |char*|SvPV_mutable|SV* sv|STRLEN len
1621 =for apidoc_item |const char*|SvPV_const|SV* sv|STRLEN len
1622 =for apidoc_item |const char*|SvPVx_const|SV* sv|STRLEN len
1623 =for apidoc_item |const char*|SvPV_nolen_const|SV* sv
1624 =for apidoc_item |const char*|SvPVx_nolen_const|SV* sv
1625 =for apidoc_item |const char*|SvPV_nomg_const|SV* sv|STRLEN len
1626 =for apidoc_item |const char*|SvPV_nomg_const_nolen|SV* sv
1627 =for apidoc_item |char *|SvPV_flags|SV * sv|STRLEN len|U32 flags
1628 =for apidoc_item |const char *|SvPV_flags_const|SV * sv|STRLEN len|U32 flags
1629 =for apidoc_item |char *|SvPV_flags_mutable|SV * sv|STRLEN len|U32 flags
1630 =for apidoc_item |char*|SvPVbyte|SV* sv|STRLEN len
1631 =for apidoc_item |char*|SvPVbyte_nomg|SV* sv|STRLEN len
1632 =for apidoc_item |char*|SvPVbyte_nolen|SV* sv
1633 =for apidoc_item |char*|SvPVbytex_nolen|SV* sv
1634 =for apidoc_item |char*|SvPVbytex|SV* sv|STRLEN len
1635 =for apidoc_item |char*|SvPVbyte_or_null|SV* sv|STRLEN len
1636 =for apidoc_item |char*|SvPVbyte_or_null_nomg|SV* sv|STRLEN len
1637 =for apidoc_item |char*|SvPVutf8|SV* sv|STRLEN len
1638 =for apidoc_item |char*|SvPVutf8x|SV* sv|STRLEN len
1639 =for apidoc_item |char*|SvPVutf8_nomg|SV* sv|STRLEN len
1640 =for apidoc_item |char*|SvPVutf8_nolen|SV* sv
1641 =for apidoc_item |char*|SvPVutf8_or_null|SV* sv|STRLEN len
1642 =for apidoc_item |char*|SvPVutf8_or_null_nomg|SV* sv|STRLEN len
1644 All these return a pointer to the string in C<sv>, or a stringified form of
1645 C<sv> if it does not contain a string. The SV may cache the stringified
1646 version becoming C<SvPOK>.
1648 This is a very basic and common operation, so there are lots of slightly
1649 different versions of it.
1651 Note that there is no guarantee that the return value of C<SvPV(sv)>, for
1652 example, is equal to C<SvPVX(sv)>, or that C<SvPVX(sv)> contains valid data, or
1653 that successive calls to C<SvPV(sv)> (or another of these forms) will return
1654 the same pointer value each time. This is due to the way that things like
1655 overloading and Copy-On-Write are handled. In these cases, the return value
1656 may point to a temporary buffer or similar. If you absolutely need the
1657 C<SvPVX> field to be valid (for example, if you intend to write to it), then
1658 see C<L</SvPV_force>>.
1660 The differences between the forms are:
1662 The forms with neither C<byte> nor C<utf8> in their names (e.g., C<SvPV> or
1663 C<SvPV_nolen>) can expose the SV's internal string buffer. If
1664 that buffer consists entirely of bytes 0-255 and includes any bytes above
1665 127, then you B<MUST> consult C<SvUTF8> to determine the actual code points
1666 the string is meant to contain. Generally speaking, it is probably safer to
1667 prefer C<SvPVbyte>, C<SvPVutf8>, and the like. See
1668 L<perlguts/How do I pass a Perl string to a C library?> for more details.
1670 The forms with C<flags> in their names allow you to use the C<flags> parameter
1671 to specify to process 'get' magic (by setting the C<SV_GMAGIC> flag) or to skip
1672 'get' magic (by clearing it). The other forms process 'get' magic, except for
1673 the ones with C<nomg> in their names, which skip 'get' magic.
1675 The forms that take a C<len> parameter will set that variable to the byte
1676 length of the resultant string (these are macros, so don't use C<&len>).
1678 The forms with C<nolen> in their names indicate they don't have a C<len>
1679 parameter. They should be used only when it is known that the PV is a C
1680 string, terminated by a NUL byte, and without intermediate NUL characters; or
1681 when you don't care about its length.
1683 The forms with C<const> in their names return S<C<const char *>> so that the
1684 compiler will hopefully complain if you were to try to modify the contents of
1685 the string (unless you cast away const yourself).
1687 The other forms return a mutable pointer so that the string is modifiable by
1688 the caller; this is emphasized for the ones with C<mutable> in their names.
1690 The forms whose name ends in C<x> are the same as the corresponding form
1691 without the C<x>, but the C<x> form is guaranteed to evaluate C<sv> exactly
1692 once, with a slight loss of efficiency. Use this if C<sv> is an expression
1695 C<SvPVutf8> is like C<SvPV>, but converts C<sv> to UTF-8 first if not already
1696 UTF-8. Similiarly, the other forms with C<utf8> in their names correspond to
1697 their respective forms without.
1699 C<SvPVutf8_or_null> and C<SvPVutf8_or_null_nomg> don't have corresponding
1700 non-C<utf8> forms. Instead they are like C<SvPVutf8_nomg>, but when C<sv> is
1701 undef, they return C<NULL>.
1703 C<SvPVbyte> is like C<SvPV>, but converts C<sv> to byte representation first if
1704 currently encoded as UTF-8. If C<sv> cannot be downgraded from UTF-8, it
1705 croaks. Similiarly, the other forms with C<byte> in their names correspond to
1706 their respective forms without.
1708 C<SvPVbyte_or_null> doesn't have a corresponding non-C<byte> form. Instead it
1709 is like C<SvPVbyte>, but when C<sv> is undef, it returns C<NULL>.
1711 =for apidoc Am|IV|SvIV|SV* sv
1712 =for apidoc_item SvIVx
1713 =for apidoc_item SvIV_nomg
1715 These coerce the given SV to IV and return it. The returned value in many
1716 circumstances will get stored in C<sv>'s IV slot, but not in all cases. (Use
1717 C<L</sv_setiv>> to make sure it does).
1719 C<SvIVx> is different from the others in that it is guaranteed to evaluate
1720 C<sv> exactly once; the others may evaluate it multiple times. Only use this
1721 form if C<sv> is an expression with side effects, otherwise use the more
1724 C<SvIV_nomg> is the same as C<SvIV>, but does not perform 'get' magic.
1726 =for apidoc Am|NV|SvNV|SV* sv
1727 =for apidoc_item SvNVx
1728 =for apidoc_item SvNV_nomg
1730 These coerce the given SV to NV and return it. The returned value in many
1731 circumstances will get stored in C<sv>'s NV slot, but not in all cases. (Use
1732 C<L</sv_setnv>> to make sure it does).
1734 C<SvNVx> is different from the others in that it is guaranteed to evaluate
1735 C<sv> exactly once; the others may evaluate it multiple times. Only use this
1736 form if C<sv> is an expression with side effects, otherwise use the more
1739 C<SvNV_nomg> is the same as C<SvNV>, but does not perform 'get' magic.
1741 =for apidoc Am|UV|SvUV|SV* sv
1742 =for apidoc_item SvUVx
1743 =for apidoc_item SvUV_nomg
1745 These coerce the given SV to UV and return it. The returned value in many
1746 circumstances will get stored in C<sv>'s UV slot, but not in all cases. (Use
1747 C<L</sv_setuv>> to make sure it does).
1749 C<SvUVx> is different from the others in that it is guaranteed to evaluate
1750 C<sv> exactly once; the others may evaluate it multiple times. Only use this
1751 form if C<sv> is an expression with side effects, otherwise use the more
1754 C<SvUV_nomg> is the same as C<SvUV>, but does not perform 'get' magic.
1757 =for apidoc_item SvTRUEx
1758 =for apidoc_item SvTRUE_nomg
1759 =for apidoc_item SvTRUE_NN
1760 =for apidoc_item SvTRUE_nomg_NN
1762 These return a boolean indicating whether Perl would evaluate the SV as true or
1763 false. See C<L</SvOK>> for a defined/undefined test.
1765 As of Perl 5.32, all are guaranteed to evaluate C<sv> only once. Prior to that
1766 release, only C<SvTRUEx> guaranteed single evaluation; now C<SvTRUEx> is
1767 identical to C<SvTRUE>.
1769 C<SvTRUE_nomg> and C<TRUE_nomg_NN> do not perform 'get' magic; the others do
1770 unless the scalar is already C<SvPOK>, C<SvIOK>, or C<SvNOK> (the public, not
1773 C<SvTRUE_NN> is like C<L</SvTRUE>>, but C<sv> is assumed to be
1774 non-null (NN). If there is a possibility that it is NULL, use plain
1777 C<SvTRUE_nomg_NN> is like C<L</SvTRUE_nomg>>, but C<sv> is assumed to be
1778 non-null (NN). If there is a possibility that it is NULL, use plain
1781 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1782 Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
1784 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1785 Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
1787 =for apidoc Am|char*|SvPVutf8_nomg|SV* sv|STRLEN len
1788 Like C<SvPVutf8>, but does not process get magic.
1790 =for apidoc Am|char*|SvPVutf8_or_null|SV* sv|STRLEN len
1791 Like C<SvPVutf8>, but when C<sv> is undef, returns C<NULL>.
1793 =for apidoc Am|char*|SvPVutf8_or_null_nomg|SV* sv|STRLEN len
1794 Like C<SvPVutf8_or_null>, but does not process get magic.
1796 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1797 Like C<SvPV_nolen>, but converts C<sv> to UTF-8 first if necessary.
1799 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1800 Like C<SvPV_force>, but converts C<sv> to byte representation first if
1801 necessary. If the SV cannot be downgraded from UTF-8, this croaks.
1803 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1804 Like C<SvPV>, but converts C<sv> to byte representation first if necessary. If
1805 the SV cannot be downgraded from UTF-8, this croaks.
1807 =for apidoc Am|char*|SvPVbyte_nomg|SV* sv|STRLEN len
1808 Like C<SvPVbyte>, but does not process get magic.
1810 =for apidoc Am|char*|SvPVbyte_or_null|SV* sv|STRLEN len
1811 Like C<SvPVbyte>, but when C<sv> is undef, returns C<NULL>.
1813 =for apidoc Am|char*|SvPVbyte_or_null_nomg|SV* sv|STRLEN len
1814 Like C<SvPVbyte_or_null>, but does not process get magic.
1816 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1817 Like C<SvPV_nolen>, but converts C<sv> to byte representation first if
1818 necessary. If the SV cannot be downgraded from UTF-8, this croaks.
1820 =for apidoc Am|U32|SvIsCOW|SV* sv
1821 Returns a U32 value indicating whether the SV is Copy-On-Write (either shared
1822 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1825 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1826 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1832 /* Let us hope that bitmaps for UV and IV are the same */
1833 #define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1834 #define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1835 #define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
1837 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1838 #define SvUV_nomg(sv) (SvUOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1839 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1843 #define SvPV(sv, len) SvPV_flags(sv, len, SV_GMAGIC)
1844 #define SvPV_const(sv, len) SvPV_flags_const(sv, len, SV_GMAGIC)
1845 #define SvPV_mutable(sv, len) SvPV_flags_mutable(sv, len, SV_GMAGIC)
1847 #define SvPV_flags(sv, len, flags) \
1849 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &len, flags))
1850 #define SvPV_flags_const(sv, len, flags) \
1852 ? ((len = SvCUR(sv)), SvPVX_const(sv)) : \
1853 (const char*) sv_2pv_flags(sv, &len, (flags|SV_CONST_RETURN)))
1854 #define SvPV_flags_const_nolen(sv, flags) \
1856 ? SvPVX_const(sv) : \
1857 (const char*) sv_2pv_flags(sv, 0, (flags|SV_CONST_RETURN)))
1858 #define SvPV_flags_mutable(sv, len, flags) \
1860 ? ((len = SvCUR(sv)), SvPVX_mutable(sv)) : \
1861 sv_2pv_flags(sv, &len, (flags|SV_MUTABLE_RETURN)))
1863 #define SvPV_force(sv, len) SvPV_force_flags(sv, len, SV_GMAGIC)
1864 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1865 #define SvPV_force_mutable(sv, len) SvPV_force_flags_mutable(sv, len, SV_GMAGIC)
1867 #define SvPV_force_nomg(sv, len) SvPV_force_flags(sv, len, 0)
1868 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1870 #define SvPV_force_flags(sv, len, flags) \
1871 (SvPOK_pure_nogthink(sv) \
1872 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &len, flags))
1874 #define SvPV_force_flags_nolen(sv, flags) \
1875 (SvPOK_pure_nogthink(sv) \
1876 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1878 #define SvPV_force_flags_mutable(sv, len, flags) \
1879 (SvPOK_pure_nogthink(sv) \
1880 ? ((len = SvCUR(sv)), SvPVX_mutable(sv)) \
1881 : sv_pvn_force_flags(sv, &len, flags|SV_MUTABLE_RETURN))
1883 #define SvPV_nolen(sv) \
1885 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1887 /* "_nomg" in these defines means no mg_get() */
1888 #define SvPV_nomg_nolen(sv) \
1890 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1892 #define SvPV_nolen_const(sv) \
1894 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1896 #define SvPV_nomg(sv, len) SvPV_flags(sv, len, 0)
1897 #define SvPV_nomg_const(sv, len) SvPV_flags_const(sv, len, 0)
1898 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1902 #define SvPVutf8(sv, len) \
1903 (SvPOK_utf8_nog(sv) \
1904 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &len))
1906 #define SvPVutf8_or_null(sv, len) \
1907 (SvPOK_utf8_nog(sv) \
1908 ? ((len = SvCUR(sv)), SvPVX(sv)) : (SvGETMAGIC(sv), SvOK(sv)) \
1909 ? sv_2pvutf8_flags(sv, &len, 0) : ((len = 0), NULL))
1911 #define SvPVutf8_nomg(sv, len) \
1912 (SvPOK_utf8_nog(sv) \
1913 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8_flags(sv, &len, 0))
1915 #define SvPVutf8_or_null_nomg(sv, len) \
1916 (SvPOK_utf8_nog(sv) \
1917 ? ((len = SvCUR(sv)), SvPVX(sv)) : SvOK(sv) \
1918 ? sv_2pvutf8_flags(sv, &len, 0) : ((len = 0), NULL))
1920 #define SvPVutf8_force(sv, len) \
1921 (SvPOK_utf8_pure_nogthink(sv) \
1922 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &len))
1924 #define SvPVutf8_nolen(sv) \
1925 (SvPOK_utf8_nog(sv) \
1926 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1930 #define SvPVbyte(sv, len) \
1931 (SvPOK_byte_nog(sv) \
1932 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &len))
1934 #define SvPVbyte_or_null(sv, len) \
1935 (SvPOK_byte_nog(sv) \
1936 ? ((len = SvCUR(sv)), SvPVX(sv)) : (SvGETMAGIC(sv), SvOK(sv)) \
1937 ? sv_2pvbyte_flags(sv, &len, 0) : ((len = 0), NULL))
1939 #define SvPVbyte_nomg(sv, len) \
1940 (SvPOK_byte_nog(sv) \
1941 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte_flags(sv, &len, 0))
1943 #define SvPVbyte_or_null_nomg(sv, len) \
1944 (SvPOK_utf8_nog(sv) \
1945 ? ((len = SvCUR(sv)), SvPVX(sv)) : SvOK(sv) \
1946 ? sv_2pvbyte_flags(sv, &len, 0) : ((len = 0), NULL))
1948 #define SvPVbyte_force(sv, len) \
1949 (SvPOK_byte_pure_nogthink(sv) \
1950 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &len))
1952 #define SvPVbyte_nolen(sv) \
1953 (SvPOK_byte_nog(sv) \
1954 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1957 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1958 * var to evaluate the arg once; failing that, use a global if possible;
1959 * failing that, call a function to do the work
1962 #define SvPVx_force(sv, len) sv_pvn_force(sv, &len)
1963 #define SvPVutf8x_force(sv, len) sv_pvutf8n_force(sv, &len)
1964 #define SvPVbytex_force(sv, len) sv_pvbyten_force(sv, &len)
1966 #define SvTRUEx(sv) SvTRUE(sv)
1967 #define SvTRUEx_nomg(sv) SvTRUE_nomg(sv)
1968 #define SvTRUE_nomg_NN(sv) SvTRUE_common(sv, TRUE)
1970 #if defined(PERL_USE_GCC_BRACE_GROUPS)
1972 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1973 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1974 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1975 # define SvPVx(sv, len) ({SV *_sv = (sv); SvPV(_sv, len); })
1976 # define SvPVx_const(sv, len) ({SV *_sv = (sv); SvPV_const(_sv, len); })
1977 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1978 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1979 # define SvPVutf8x(sv, len) ({SV *_sv = (sv); SvPVutf8(_sv, len); })
1980 # define SvPVbytex(sv, len) ({SV *_sv = (sv); SvPVbyte(_sv, len); })
1981 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1983 #else /* __GNUC__ */
1985 /* These inlined macros use globals, which will require a thread
1986 * declaration in user code, so we avoid them under threads */
1988 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1989 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1990 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1991 # define SvPVx(sv, len) ((PL_Sv = (sv)), SvPV(PL_Sv, len))
1992 # define SvPVx_const(sv, len) ((PL_Sv = (sv)), SvPV_const(PL_Sv, len))
1993 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1994 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1995 # define SvPVutf8x(sv, len) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, len))
1996 # define SvPVbytex(sv, len) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, len))
1997 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1998 #endif /* __GNU__ */
2000 #define SvPVXtrue(sv) ( \
2001 ((XPV*)SvANY((sv))) \
2003 ((XPV*)SvANY((sv)))->xpv_cur > 1 \
2005 ((XPV*)SvANY((sv)))->xpv_cur \
2006 && *(sv)->sv_u.svu_pv != '0' \
2011 #define SvIsCOW(sv) (SvFLAGS(sv) & SVf_IsCOW)
2012 #define SvIsCOW_on(sv) (SvFLAGS(sv) |= SVf_IsCOW)
2013 #define SvIsCOW_off(sv) (SvFLAGS(sv) &= ~SVf_IsCOW)
2014 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
2016 #define SvSHARED_HEK_FROM_PV(pvx) \
2017 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
2019 =for apidoc Am|struct hek*|SvSHARED_HASH|SV * sv
2020 Returns the hash for C<sv> created by C<L</newSVpvn_share>>.
2024 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
2026 /* flag values for sv_*_flags functions */
2027 #define SV_UTF8_NO_ENCODING 0 /* No longer used */
2030 =for apidoc AmnhD||SV_UTF8_NO_ENCODING
2035 #define SV_IMMEDIATE_UNREF 1
2037 #define SV_COW_DROP_PV 4
2038 #define SV_NOSTEAL 16
2039 #define SV_CONST_RETURN 32
2040 #define SV_MUTABLE_RETURN 64
2041 #define SV_SMAGIC 128
2042 #define SV_HAS_TRAILING_NUL 256
2043 #define SV_COW_SHARED_HASH_KEYS 512
2044 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
2045 /* XXX This flag actually enabled for any COW. But it appears not to do
2046 anything. Can we just remove it? Or will it serve some future
2048 #define SV_COW_OTHER_PVS 1024
2049 /* Make sv_2pv_flags return NULL if something is undefined. */
2050 #define SV_UNDEF_RETURNS_NULL 2048
2051 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
2052 * This is used when the caller has already determined it is, and avoids
2054 #define SV_FORCE_UTF8_UPGRADE 4096
2055 /* if (after resolving magic etc), the SV is found to be overloaded,
2056 * don't call the overload magic, just return as-is */
2057 #define SV_SKIP_OVERLOAD 8192
2058 #define SV_CATBYTES 16384
2059 #define SV_CATUTF8 32768
2061 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
2062 So only default to doing the COW setup if we're in the core.
2065 # ifndef SV_DO_COW_SVSETSV
2066 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
2070 #ifndef SV_DO_COW_SVSETSV
2071 # define SV_DO_COW_SVSETSV 0
2075 #define sv_unref(sv) sv_unref_flags(sv, 0)
2076 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
2077 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
2078 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
2080 /* We are about to replace the SV's current value. So if it's copy on write
2081 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
2082 the value is about to get thrown away, so drop the PV rather than go to
2083 the effort of making a read-write copy only for it to get immediately
2086 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
2087 sv_force_normal_flags(sv, SV_COW_DROP_PV)
2089 #ifdef PERL_COPY_ON_WRITE
2090 # define SvCANCOW(sv) \
2092 ? SvLEN(sv) ? CowREFCNT(sv) != SV_COW_REFCNT_MAX : 1 \
2093 : (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS \
2094 && SvCUR(sv)+1 < SvLEN(sv))
2095 /* Note: To allow 256 COW "copies", a refcnt of 0 means 1. */
2096 # define CowREFCNT(sv) (*(U8 *)(SvPVX(sv)+SvLEN(sv)-1))
2097 # define SV_COW_REFCNT_MAX nBIT_UMAX(sizeof(U8) * CHARBITS)
2098 # define CAN_COW_MASK (SVf_POK|SVf_ROK|SVp_POK|SVf_FAKE| \
2099 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_PROTECT)
2102 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
2104 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
2105 sv_force_normal_flags(sv, 0)
2108 /* all these 'functions' are now just macros */
2110 #define sv_pv(sv) SvPV_nolen(sv)
2111 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
2112 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
2114 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
2115 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
2116 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
2117 #define sv_utf8_downgrade(sv, fail_ok) sv_utf8_downgrade_flags(sv, fail_ok, SV_GMAGIC)
2118 #define sv_utf8_downgrade_nomg(sv, fail_ok) sv_utf8_downgrade_flags(sv, fail_ok, 0)
2119 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
2120 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
2121 #define sv_setsv(dsv, ssv) \
2122 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
2123 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
2124 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
2125 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
2126 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
2127 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
2128 #define sv_catpvn_mg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
2129 #define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
2130 #define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
2131 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
2132 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
2133 #define sv_2pvbyte(sv, lp) sv_2pvbyte_flags(sv, lp, SV_GMAGIC)
2134 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
2135 #define sv_2pvutf8(sv, lp) sv_2pvutf8_flags(sv, lp, SV_GMAGIC)
2136 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
2137 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
2138 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
2139 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
2140 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
2141 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
2142 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
2143 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
2144 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
2145 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
2146 #define sv_collxfrm(sv, nxp) sv_collxfrm_flags(sv, nxp, SV_GMAGIC)
2147 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
2148 #define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
2149 #define sv_insert(bigstr, offset, len, little, littlelen) \
2150 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
2151 (littlelen), SV_GMAGIC)
2152 #define sv_mortalcopy(sv) \
2153 Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV)
2154 #define sv_cathek(sv,hek) \
2156 HEK * const bmxk = hek; \
2157 sv_catpvn_flags(sv, HEK_KEY(bmxk), HEK_LEN(bmxk), \
2158 HEK_UTF8(bmxk) ? SV_CATUTF8 : SV_CATBYTES); \
2161 /* Should be named SvCatPVN_utf8_upgrade? */
2162 #define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
2165 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
2167 sv_setpvn(nsv, sstr, slen); \
2169 sv_utf8_upgrade(nsv); \
2170 sv_catsv_nomg(dsv, nsv); \
2172 #define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \
2173 sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES)
2175 #if defined(PERL_CORE) || defined(PERL_EXT)
2176 # define sv_or_pv_len_utf8(sv, pv, bytelen) \
2178 ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \
2184 =for apidoc_item ||newRV_inc|
2186 These are identical. They create an RV wrapper for an SV. The reference count
2187 for the original SV is incremented.
2192 #define newRV_inc(sv) newRV(sv)
2194 /* the following macros update any magic values this C<sv> is associated with */
2197 =for apidoc_section $SV
2199 =for apidoc Am|void|SvGETMAGIC|SV* sv
2200 Invokes C<L</mg_get>> on an SV if it has 'get' magic. For example, this
2201 will call C<FETCH> on a tied variable. This macro evaluates its
2202 argument more than once.
2204 =for apidoc Am|void|SvSETMAGIC|SV* sv
2205 Invokes C<L</mg_set>> on an SV if it has 'set' magic. This is necessary
2206 after modifying a scalar, in case it is a magical variable like C<$|>
2207 or a tied variable (it calls C<STORE>). This macro evaluates its
2208 argument more than once.
2210 =for apidoc Am|void|SvSetSV|SV* dsv|SV* ssv
2211 =for apidoc_item SvSetMagicSV
2212 =for apidoc_item SvSetSV_nosteal
2213 =for apidoc_item SvSetMagicSV_nosteal
2215 if C<dsv> is the same as C<ssv>, these do nothing. Otherwise they all call
2216 some form of C<L</sv_setsv>>. They may evaluate their arguments more than
2219 The only differences are:
2221 C<SvSetMagicSV> and C<SvSetMagicSV_nosteal> perform any required 'set' magic
2222 afterwards on the destination SV; C<SvSetSV> and C<SvSetSV_nosteal> do not.
2224 C<SvSetSV_nosteal> C<SvSetMagicSV_nosteal> call a non-destructive version of
2227 =for apidoc Am|void|SvSHARE|SV* sv
2228 Arranges for C<sv> to be shared between threads if a suitable module
2231 =for apidoc Am|void|SvLOCK|SV* sv
2232 Arranges for a mutual exclusion lock to be obtained on C<sv> if a suitable module
2235 =for apidoc Am|void|SvUNLOCK|SV* sv
2236 Releases a mutual exclusion lock on C<sv> if a suitable module
2239 =for apidoc_section $SV
2241 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
2242 Expands the character buffer in the SV so that it has room for the
2243 indicated number of bytes (remember to reserve space for an extra trailing
2244 C<NUL> character). Calls C<sv_grow> to perform the expansion if necessary.
2245 Returns a pointer to the character
2246 buffer. SV must be of type >= C<SVt_PV>. One
2247 alternative is to call C<sv_grow> if you are not sure of the type of SV.
2249 You might mistakenly think that C<len> is the number of bytes to add to the
2250 existing size, but instead it is the total size C<sv> should be.
2252 =for apidoc Am|char *|SvPVCLEAR|SV* sv
2253 Ensures that sv is a SVt_PV and that its SvCUR is 0, and that it is
2254 properly null terminated. Equivalent to sv_setpvs(""), but more efficient.
2259 #define SvPVCLEAR(sv) sv_setpv_bufsize(sv,0,0)
2260 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
2261 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
2262 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
2263 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
2265 #define SvGETMAGIC(x) ((void)(UNLIKELY(SvGMAGICAL(x)) && mg_get(x)))
2266 #define SvSETMAGIC(x) STMT_START { if (UNLIKELY(SvSMAGICAL(x))) mg_set(x); } STMT_END
2268 #define SvSetSV_and(dst,src,finally) \
2270 if (LIKELY((dst) != (src))) { \
2271 sv_setsv(dst, src); \
2275 #define SvSetSV_nosteal_and(dst,src,finally) \
2277 if (LIKELY((dst) != (src))) { \
2278 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
2283 #define SvSetSV(dst,src) \
2284 SvSetSV_and(dst,src,/*nothing*/;)
2285 #define SvSetSV_nosteal(dst,src) \
2286 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
2288 #define SvSetMagicSV(dst,src) \
2289 SvSetSV_and(dst,src,SvSETMAGIC(dst))
2290 #define SvSetMagicSV_nosteal(dst,src) \
2291 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
2294 #if !defined(SKIP_DEBUGGING)
2295 #define SvPEEK(sv) sv_peek(sv)
2297 #define SvPEEK(sv) ""
2300 /* Is this a per-interpreter immortal SV (rather than global)?
2301 * These should either occupy adjacent entries in the interpreter struct
2302 * (MULTIPLICITY) or adjacent elements of PL_sv_immortals[] otherwise.
2303 * The unsigned (Size_t) cast avoids the need for a second < 0 condition.
2305 #define SvIMMORTAL_INTERP(sv) ((Size_t)((sv) - &PL_sv_yes) < 4)
2307 /* Does this immortal have a true value? Currently only PL_sv_yes does. */
2308 #define SvIMMORTAL_TRUE(sv) ((sv) == &PL_sv_yes)
2310 /* the SvREADONLY() test is to quickly reject most SVs */
2311 #define SvIMMORTAL(sv) \
2313 && (SvIMMORTAL_INTERP(sv) || (sv) == &PL_sv_placeholder))
2316 /* exercise the immortal resurrection code in sv_free2() */
2317 # define SvREFCNT_IMMORTAL 1000
2319 # define SvREFCNT_IMMORTAL ((~(U32)0)/2)
2323 =for apidoc Am|SV *|boolSV|bool b
2325 Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
2327 See also C<L</PL_sv_yes>> and C<L</PL_sv_no>>.
2332 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2334 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2335 /* If I give every macro argument a different name, then there won't be bugs
2336 where nested macros get confused. Been there, done that. */
2338 =for apidoc Am|bool|isGV_with_GP|SV * sv
2339 Returns a boolean as to whether or not C<sv> is a GV with a pointer to a GP
2344 #define isGV_with_GP(pwadak) \
2345 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
2346 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2347 #define isGV_with_GP_on(sv) STMT_START { \
2348 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2349 assert (!SvPOKp(sv)); \
2350 assert (!SvIOKp(sv)); \
2351 (SvFLAGS(sv) |= SVpgv_GP); \
2353 #define isGV_with_GP_off(sv) STMT_START { \
2354 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2355 assert (!SvPOKp(sv)); \
2356 assert (!SvIOKp(sv)); \
2357 (SvFLAGS(sv) &= ~SVpgv_GP); \
2360 # define isGV_or_RVCV(kadawp) \
2361 (isGV(kadawp) || (SvROK(kadawp) && SvTYPE(SvRV(kadawp)) == SVt_PVCV))
2363 #define isREGEXP(sv) \
2364 (SvTYPE(sv) == SVt_REGEXP \
2365 || (SvFLAGS(sv) & (SVTYPEMASK|SVpgv_GP|SVf_FAKE)) \
2366 == (SVt_PVLV|SVf_FAKE))
2370 # define SvGROW(sv,len) \
2371 (SvIsCOW(sv) || SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2373 # define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2375 #define SvGROW_mutable(sv,len) \
2376 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2377 #define Sv_Grow sv_grow
2379 #define CLONEf_COPY_STACKS 1
2380 #define CLONEf_KEEP_PTR_TABLE 2
2381 #define CLONEf_CLONE_HOST 4
2382 #define CLONEf_JOIN_IN 8
2384 struct clone_params {
2387 PerlInterpreter *proto_perl;
2388 PerlInterpreter *new_perl;
2392 /* SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
2393 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
2394 #define newSVsv(sv) newSVsv_flags((sv), SV_GMAGIC|SV_NOSTEAL)
2395 #define newSVsv_nomg(sv) newSVsv_flags((sv), SV_NOSTEAL)
2398 =for apidoc Am|SV*|newSVpvn_utf8|const char* s|STRLEN len|U32 utf8
2400 Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
2401 characters) into it. If C<utf8> is true, calls
2402 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2407 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2410 =for apidoc Amx|SV*|newSVpadname|PADNAME *pn
2412 Creates a new SV containing the pad name.
2417 #define newSVpadname(pn) newSVpvn_utf8(PadnamePV(pn), PadnameLEN(pn), TRUE)
2420 =for apidoc Am|void|SvOOK_offset|SV*sv|STRLEN len
2422 Reads into C<len> the offset from C<SvPVX> back to the true start of the
2423 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2424 efficiently remove characters from start of the buffer. Implemented as a
2425 macro, which takes the address of C<len>, which must be of type C<STRLEN>.
2426 Evaluates C<sv> more than once. Sets C<len> to 0 if C<SvOOK(sv)> is false.
2432 /* Does the bot know something I don't?
2433 10:28 <@Nicholas> metabatman
2434 10:28 <+meta> Nicholas: crash
2436 # define SvOOK_offset(sv, offset) STMT_START { \
2437 STATIC_ASSERT_STMT(sizeof(offset) == sizeof(STRLEN)); \
2439 const U8 *_crash = (U8*)SvPVX_const(sv); \
2440 (offset) = *--_crash; \
2442 _crash -= sizeof(STRLEN); \
2443 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
2446 /* Validate the preceding buffer's sentinels to \
2447 verify that no-one is using it. */ \
2448 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2449 while (_crash > _bonk) { \
2451 assert (*_crash == (U8)PTR2UV(_crash)); \
2459 /* This is the same code, but avoids using any temporary variables: */
2460 # define SvOOK_offset(sv, offset) STMT_START { \
2461 STATIC_ASSERT_STMT(sizeof(offset) == sizeof(STRLEN)); \
2463 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2465 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2466 (U8*)&(offset), sizeof(STRLEN), U8); \
2474 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2476 #if defined(PERL_CORE) || defined(PERL_EXT)
2478 # define SV_CONST(name) \
2479 PL_sv_consts[SV_CONST_##name] \
2480 ? PL_sv_consts[SV_CONST_##name] \
2481 : (PL_sv_consts[SV_CONST_##name] = newSVpv_share(#name, 0))
2483 # define SV_CONST_TIESCALAR 0
2484 # define SV_CONST_TIEARRAY 1
2485 # define SV_CONST_TIEHASH 2
2486 # define SV_CONST_TIEHANDLE 3
2488 # define SV_CONST_FETCH 4
2489 # define SV_CONST_FETCHSIZE 5
2490 # define SV_CONST_STORE 6
2491 # define SV_CONST_STORESIZE 7
2492 # define SV_CONST_EXISTS 8
2494 # define SV_CONST_PUSH 9
2495 # define SV_CONST_POP 10
2496 # define SV_CONST_SHIFT 11
2497 # define SV_CONST_UNSHIFT 12
2498 # define SV_CONST_SPLICE 13
2499 # define SV_CONST_EXTEND 14
2501 # define SV_CONST_FIRSTKEY 15
2502 # define SV_CONST_NEXTKEY 16
2503 # define SV_CONST_SCALAR 17
2505 # define SV_CONST_OPEN 18
2506 # define SV_CONST_WRITE 19
2507 # define SV_CONST_PRINT 20
2508 # define SV_CONST_PRINTF 21
2509 # define SV_CONST_READ 22
2510 # define SV_CONST_READLINE 23
2511 # define SV_CONST_GETC 24
2512 # define SV_CONST_SEEK 25
2513 # define SV_CONST_TELL 26
2514 # define SV_CONST_EOF 27
2515 # define SV_CONST_BINMODE 28
2516 # define SV_CONST_FILENO 29
2517 # define SV_CONST_CLOSE 30
2519 # define SV_CONST_DELETE 31
2520 # define SV_CONST_CLEAR 32
2521 # define SV_CONST_UNTIE 33
2522 # define SV_CONST_DESTROY 34
2525 #define SV_CONSTS_COUNT 35
2528 * Bodyless IVs and NVs!
2530 * Since 5.9.2, we can avoid allocating a body for SVt_IV-type SVs.
2531 * Since the larger IV-holding variants of SVs store their integer
2532 * values in their respective bodies, the family of SvIV() accessor
2533 * macros would naively have to branch on the SV type to find the
2534 * integer value either in the HEAD or BODY. In order to avoid this
2535 * expensive branch, a clever soul has deployed a great hack:
2536 * We set up the SvANY pointer such that instead of pointing to a
2537 * real body, it points into the memory before the location of the
2538 * head. We compute this pointer such that the location of
2539 * the integer member of the hypothetical body struct happens to
2540 * be the same as the location of the integer member of the bodyless
2541 * SV head. This now means that the SvIV() family of accessors can
2542 * always read from the (hypothetical or real) body via SvANY.
2544 * Since the 5.21 dev series, we employ the same trick for NVs
2545 * if the architecture can support it (NVSIZE <= IVSIZE).
2548 /* The following two macros compute the necessary offsets for the above
2549 * trick and store them in SvANY for SvIV() (and friends) to use. */
2552 # define SET_SVANY_FOR_BODYLESS_IV(sv) \
2553 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) \
2554 - STRUCT_OFFSET(XPVIV, xiv_iv))
2556 # define SET_SVANY_FOR_BODYLESS_NV(sv) \
2557 SvANY(sv) = (XPVNV*)((char*)&(sv->sv_u.svu_nv) \
2558 - STRUCT_OFFSET(XPVNV, xnv_u.xnv_nv))
2562 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob