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 Decrements the reference count of the given SV. C<sv> may be C<NULL>.
325 =for apidoc SvREFCNT_dec_NN
326 Same as C<SvREFCNT_dec>, but can only be used if you know C<sv>
327 is not C<NULL>. Since we don't have to check the NULLness, it's faster
330 =for apidoc Am|svtype|SvTYPE|SV* sv
331 Returns the type of the SV. See C<L</svtype>>.
333 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
334 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
335 perform the upgrade if necessary. See C<L</svtype>>.
340 #define SvANY(sv) (sv)->sv_any
341 #define SvFLAGS(sv) (sv)->sv_flags
342 #define SvREFCNT(sv) (sv)->sv_refcnt
344 #define SvREFCNT_inc(sv) Perl_SvREFCNT_inc(MUTABLE_SV(sv))
345 #define SvREFCNT_inc_simple(sv) SvREFCNT_inc(sv)
346 #define SvREFCNT_inc_NN(sv) Perl_SvREFCNT_inc_NN(MUTABLE_SV(sv))
347 #define SvREFCNT_inc_void(sv) Perl_SvREFCNT_inc_void(MUTABLE_SV(sv))
349 /* These guys don't need the curly blocks */
350 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
351 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
352 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
353 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
355 #define SvREFCNT_dec(sv) Perl_SvREFCNT_dec(aTHX_ MUTABLE_SV(sv))
356 #define SvREFCNT_dec_NN(sv) Perl_SvREFCNT_dec_NN(aTHX_ MUTABLE_SV(sv))
358 #define SVTYPEMASK 0xff
359 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
361 /* Sadly there are some parts of the core that have pointers to already-freed
362 SV heads, and rely on being able to tell that they are now free. So mark
363 them all by using a consistent macro. */
364 #define SvIS_FREED(sv) UNLIKELY(((sv)->sv_flags == SVTYPEMASK))
366 /* this is defined in this peculiar way to avoid compiler warnings.
367 * See the <20121213131428.GD1842@iabyn.com> thread in p5p */
368 #define SvUPGRADE(sv, mt) \
369 ((void)(SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt),1)))
371 #define SVf_IOK 0x00000100 /* has valid public integer value */
372 #define SVf_NOK 0x00000200 /* has valid public numeric value */
373 #define SVf_POK 0x00000400 /* has valid public pointer value */
374 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
376 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
377 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
378 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
379 #define SVp_SCREAM 0x00008000 /* currently unused on plain scalars */
380 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
381 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
382 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
383 subroutine in another package. Set the
384 GvIMPORTED_CV_on() if it needs to be
385 expanded to a real GV */
387 /* SVf_PROTECT is what SVf_READONLY should have been: i.e. modifying
388 * this SV is completely illegal. However, SVf_READONLY (via
389 * Internals::SvREADONLY()) has come to be seen as a flag that can be
390 * temporarily set and unset by the user to indicate e.g. whether a hash
391 * is "locked". Now, Hash::Util et al only set SVf_READONLY, while core
392 * sets both (SVf_READONLY|SVf_PROTECT) to indicate both to core and user
393 * code that this SV should not be messed with.
395 #define SVf_PROTECT 0x00010000 /* very read-only */
396 #define SVs_PADTMP 0x00020000 /* in use as tmp */
397 #define SVs_PADSTALE 0x00040000 /* lexical has gone out of scope;
398 only used when !PADTMP */
399 #define SVs_TEMP 0x00080000 /* mortal (implies string is stealable) */
400 #define SVs_OBJECT 0x00100000 /* is "blessed" */
401 #define SVs_GMG 0x00200000 /* has magical get method */
402 #define SVs_SMG 0x00400000 /* has magical set method */
403 #define SVs_RMG 0x00800000 /* has random magical methods */
405 #define SVf_FAKE 0x01000000 /* 0: glob is just a copy
406 1: SV head arena wasn't malloc()ed
407 2: For PVCV, whether CvUNIQUE(cv)
408 refers to an eval or once only
409 [CvEVAL(cv), CvSPECIAL(cv)]
410 3: HV: informally reserved by DAPM
412 4: Together with other flags (or
413 lack thereof) indicates a regex,
414 including PVLV-as-regex. See
417 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
418 means that a hv_aux struct is present
419 after the main array */
420 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
421 SVs in final arena cleanup.
422 Set in S_regtry on PL_reg_curpm, so that
423 perl_destruct will skip it.
424 Used for mark and sweep by OP_AASSIGN
426 #define SVf_READONLY 0x08000000 /* may not be modified */
431 #define SVf_THINKFIRST (SVf_READONLY|SVf_PROTECT|SVf_ROK|SVf_FAKE \
434 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
435 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
437 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
439 /* SVf_AMAGIC means that the stash *may* have overload methods. It's
440 * set each time a function is compiled into a stash, and is reset by the
441 * overload code when called for the first time and finds that there are
442 * no overload methods. Note that this used to be set on the object; but
443 * is now only set on stashes.
445 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
446 #define SVf_IsCOW 0x10000000 /* copy on write (shared hash key if
449 /* Ensure this value does not clash with the GV_ADD* flags in gv.h, or the
450 CV_CKPROTO_* flags in op.c, or the padadd_* flags in pad.h: */
451 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
452 This is also set on RVs whose overloaded
453 stringification is UTF-8. This might
454 only happen as a side effect of SvPV() */
456 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
458 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
459 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
460 been restructured, so sometimes get used as string buffers. */
463 /* Some private flags. */
467 #define SVpav_REAL 0x40000000 /* free old entries */
469 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
471 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
472 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
474 #define SVpav_REIFY 0x80000000 /* can become real */
476 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
477 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
478 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
479 /* pad name vars only */
482 HV* xmg_stash; /* class package */ \
484 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
486 STRLEN xpvlenu_len; /* allocated size */ \
487 struct regexp* xpvlenu_rx; /* regex when SV body is XPVLV */ \
490 #define xpv_len xpv_len_u.xpvlenu_len
493 NV xnv_nv; /* numeric value, if any */
495 line_t xnv_lines; /* used internally by S_scan_subst() */
496 bool xnv_bm_tail; /* an SvVALID (BM) SV has an implicit "\n" */
500 IV xivu_iv; /* integer value */
502 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
503 bool xivu_eval_seen; /* used internally by S_scan_subst() */
508 MAGIC* xmg_magic; /* linked list of magicalness */
509 STRLEN xmg_hash_index; /* used while freeing hash entries */
521 #define xiv_iv xiv_u.xivu_iv
528 #define xuv_uv xuv_u.xivu_uv
536 /* This structure must match the beginning of struct xpvhv in hv.h. */
549 SSize_t xlvu_stargoff;
553 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
554 * y=alem/helem/iter t=tie T=tied HE */
555 char xlv_flags; /* 1 = negative offset 2 = negative len
556 4 = out of range (vec) */
559 #define xlv_targoff xlv_targoff_u.xlvu_targoff
563 IV prev_index; /* caches result of previous invlist_search() */
564 STRLEN iterator; /* Stores where we are in iterating */
565 bool is_offset; /* The data structure for all inversion lists
566 begins with an element for code point U+0000.
567 If this bool is set, the actual list contains
568 that 0; otherwise, the list actually begins
569 with the following element. Thus to invert
570 the list, merely toggle this flag */
573 /* This structure works in 2 ways - regular scalar, or GV with GP */
581 typedef U32 cv_flags_t;
583 #define _XPVCV_COMMON \
591 void (*xcv_xsub) (pTHX_ CV*); \
599 PADLIST * xcv_padlist; \
603 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
604 * compilation) in the lexically enclosing \
606 cv_flags_t xcv_flags; \
607 I32 xcv_depth /* >= 2 indicates recursive call */
609 /* This structure must match XPVCV in cv.h */
620 /* ifp and ofp are normally the same, but sockets need separate streams */
622 /* Cray addresses everything by word boundaries (64 bits) and
623 * code and data pointers cannot be mixed (which is exactly what
624 * Perl_filter_add() tries to do with the dirp), hence the
625 * following union trick (as suggested by Gurusamy Sarathy).
626 * For further information see Geir Johansen's problem report
627 * titled [ID 20000612.002 (#3366)] Perl problem on Cray system
628 * The any pointer (known as IoANY()) will also be a good place
629 * to hang any IO disciplines to.
632 DIR * xiou_dirp; /* for opendir, readdir, etc */
633 void * xiou_any; /* for alignment */
635 /* IV xio_lines is now in IVX $. */
636 IV xio_page; /* $% */
637 IV xio_page_len; /* $= */
638 IV xio_lines_left; /* $- */
639 char * xio_top_name; /* $^ */
640 GV * xio_top_gv; /* $^ */
641 char * xio_fmt_name; /* $~ */
642 GV * xio_fmt_gv; /* $~ */
643 char * xio_bottom_name;/* $^B */
644 GV * xio_bottom_gv; /* $^B */
649 #define xio_dirp xio_dirpu.xiou_dirp
650 #define xio_any xio_dirpu.xiou_any
652 #define IOf_ARGV 1 /* this fp iterates over ARGV */
653 #define IOf_START 2 /* check for null ARGV and substitute '-' */
654 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
655 #define IOf_DIDTOP 8 /* just did top of form */
656 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
657 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
658 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
659 Also, when this is set, SvPVX() is valid */
661 /* The following macros define implementation-independent predicates on SVs. */
664 =for apidoc Am|U32|SvNIOK|SV* sv
665 Returns a U32 value indicating whether the SV contains a number, integer or
668 =for apidoc Am|U32|SvNIOKp|SV* sv
669 Returns a U32 value indicating whether the SV contains a number, integer or
670 double. Checks the B<private> setting. Use C<SvNIOK> instead.
672 =for apidoc Am|void|SvNIOK_off|SV* sv
673 Unsets the NV/IV status of an SV.
675 =for apidoc Am|U32|SvOK|SV* sv
676 Returns a U32 value indicating whether the value is defined. This is
677 only meaningful for scalars.
679 =for apidoc Am|U32|SvIOKp|SV* sv
680 Returns a U32 value indicating whether the SV contains an integer. Checks
681 the B<private> setting. Use C<SvIOK> instead.
683 =for apidoc Am|U32|SvNOKp|SV* sv
684 Returns a U32 value indicating whether the SV contains a double. Checks the
685 B<private> setting. Use C<SvNOK> instead.
687 =for apidoc Am|U32|SvPOKp|SV* sv
688 Returns a U32 value indicating whether the SV contains a character string.
689 Checks the B<private> setting. Use C<SvPOK> instead.
691 =for apidoc Am|U32|SvIOK|SV* sv
692 Returns a U32 value indicating whether the SV contains an integer.
694 =for apidoc Am|void|SvIOK_on|SV* sv
695 Tells an SV that it is an integer.
697 =for apidoc Am|void|SvIOK_off|SV* sv
698 Unsets the IV status of an SV.
700 =for apidoc Am|void|SvIOK_only|SV* sv
701 Tells an SV that it is an integer and disables all other C<OK> bits.
703 =for apidoc Am|void|SvIOK_only_UV|SV* sv
704 Tells an SV that it is an unsigned integer and disables all other C<OK> bits.
706 =for apidoc Am|bool|SvIOK_UV|SV* sv
707 Returns a boolean indicating whether the SV contains an integer that must be
708 interpreted as unsigned. A non-negative integer whose value is within the
709 range of both an IV and a UV may be flagged as either C<SvUOK> or C<SvIOK>.
711 =for apidoc Am|bool|SvUOK|SV* sv
712 Returns a boolean indicating whether the SV contains an integer that must be
713 interpreted as unsigned. A non-negative integer whose value is within the
714 range of both an IV and a UV may be flagged as either C<SvUOK> or C<SvIOK>.
716 =for apidoc Am|bool|SvIOK_notUV|SV* sv
717 Returns a boolean indicating whether the SV contains a signed integer.
719 =for apidoc Am|U32|SvNOK|SV* sv
720 Returns a U32 value indicating whether the SV contains a double.
722 =for apidoc Am|void|SvNOK_on|SV* sv
723 Tells an SV that it is a double.
725 =for apidoc Am|void|SvNOK_off|SV* sv
726 Unsets the NV status of an SV.
728 =for apidoc Am|void|SvNOK_only|SV* sv
729 Tells an SV that it is a double and disables all other OK bits.
731 =for apidoc Am|U32|SvPOK|SV* sv
732 Returns a U32 value indicating whether the SV contains a character
735 =for apidoc Am|void|SvPOK_on|SV* sv
736 Tells an SV that it is a string.
738 =for apidoc Am|void|SvPOK_off|SV* sv
739 Unsets the PV status of an SV.
741 =for apidoc Am|void|SvPOK_only|SV* sv
742 Tells an SV that it is a string and disables all other C<OK> bits.
743 Will also turn off the UTF-8 status.
745 =for apidoc Am|bool|SvVOK|SV* sv
746 Returns a boolean indicating whether the SV contains a v-string.
748 =for apidoc Am|U32|SvOOK|SV* sv
749 Returns a U32 indicating whether the pointer to the string buffer is offset.
750 This hack is used internally to speed up removal of characters from the
751 beginning of a C<SvPV>. When C<SvOOK> is true, then the start of the
752 allocated string buffer is actually C<SvOOK_offset()> bytes before C<SvPVX>.
753 This offset used to be stored in C<SvIVX>, but is now stored within the spare
756 =for apidoc Am|U32|SvROK|SV* sv
757 Tests if the SV is an RV.
759 =for apidoc Am|void|SvROK_on|SV* sv
760 Tells an SV that it is an RV.
762 =for apidoc Am|void|SvROK_off|SV* sv
763 Unsets the RV status of an SV.
765 =for apidoc Am|SV*|SvRV|SV* sv
766 Dereferences an RV to return the SV.
768 =for apidoc Am|IV|SvIVX|SV* sv
769 Returns the raw value in the SV's IV slot, without checks or conversions.
770 Only use when you are sure C<SvIOK> is true. See also C<L</SvIV>>.
772 =for apidoc Am|UV|SvUVX|SV* sv
773 Returns the raw value in the SV's UV slot, without checks or conversions.
774 Only use when you are sure C<SvIOK> is true. See also C<L</SvUV>>.
776 =for apidoc AmD|UV|SvUVXx|SV* sv
777 This is an unnecessary synonym for L</SvUVX>
779 =for apidoc Am|NV|SvNVX|SV* sv
780 Returns the raw value in the SV's NV slot, without checks or conversions.
781 Only use when you are sure C<SvNOK> is true. See also C<L</SvNV>>.
783 =for apidoc Am|char*|SvPVX|SV* sv
784 Returns a pointer to the physical string in the SV. The SV must contain a
785 string. Prior to 5.9.3 it is not safe
786 to execute this macro unless the SV's
789 This is also used to store the name of an autoloaded subroutine in an XS
790 AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
792 =for apidoc Am|STRLEN|SvCUR|SV* sv
793 Returns the length of the string which is in the SV. See C<L</SvLEN>>.
795 =for apidoc Am|STRLEN|SvLEN|SV* sv
796 Returns the size of the string buffer in the SV, not including any part
797 attributable to C<SvOOK>. See C<L</SvCUR>>.
799 =for apidoc Am|char*|SvEND|SV* sv
800 Returns a pointer to the spot just after the last character in
801 the string which is in the SV, where there is usually a trailing
802 C<NUL> character (even though Perl scalars do not strictly require it).
803 See C<L</SvCUR>>. Access the character as C<*(SvEND(sv))>.
805 Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
808 =for apidoc Am|HV*|SvSTASH|SV* sv
809 Returns the stash of the SV.
811 =for apidoc Am|void|SvIV_set|SV* sv|IV val
812 Set the value of the IV pointer in sv to val. It is possible to perform
813 the same function of this macro with an lvalue assignment to C<SvIVX>.
814 With future Perls, however, it will be more efficient to use
815 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
817 =for apidoc Am|void|SvNV_set|SV* sv|NV val
818 Set the value of the NV pointer in C<sv> to val. See C<L</SvIV_set>>.
820 =for apidoc Am|void|SvPV_set|SV* sv|char* val
821 This is probably not what you want to use, you probably wanted
822 L</sv_usepvn_flags> or L</sv_setpvn> or L</sv_setpvs>.
824 Set the value of the PV pointer in C<sv> to the Perl allocated
825 C<NUL>-terminated string C<val>. See also C<L</SvIV_set>>.
827 Remember to free the previous PV buffer. There are many things to check.
828 Beware that the existing pointer may be involved in copy-on-write or other
829 mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or
830 C<SvPV_force> (or check the C<SvIsCOW> flag) first to make sure this
831 modification is safe. Then finally, if it is not a COW, call
832 C<L</SvPV_free>> to free the previous PV buffer.
834 =for apidoc Am|void|SvUV_set|SV* sv|UV val
835 Set the value of the UV pointer in C<sv> to val. See C<L</SvIV_set>>.
837 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
838 Set the value of the RV pointer in C<sv> to val. See C<L</SvIV_set>>.
840 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
841 Set the value of the MAGIC pointer in C<sv> to val. See C<L</SvIV_set>>.
843 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
844 Set the value of the STASH pointer in C<sv> to val. See C<L</SvIV_set>>.
846 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
847 Set the current length of the string which is in the SV. See C<L</SvCUR>>
850 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
851 Set the size of the string buffer for the SV. See C<L</SvLEN>>.
856 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
857 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
858 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
859 SVp_IOK|SVp_NOK|SVf_IVisUV))
861 #define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv))
862 #define assert_not_glob(sv) assert_(!isGV_with_GP(sv))
864 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
865 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
866 SvFLAGS(sv) &= ~(SVf_OK| \
867 SVf_IVisUV|SVf_UTF8), \
869 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
870 SvFLAGS(sv) &= ~(SVf_OK| \
874 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
875 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
876 #define SvIOKp_on(sv) (assert_not_glob(sv) \
877 SvFLAGS(sv) |= SVp_IOK)
878 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
879 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
880 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
881 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
882 SvFLAGS(sv) |= SVp_POK)
884 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
885 #define SvIOK_on(sv) (assert_not_glob(sv) \
886 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
887 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
888 #define SvIOK_only(sv) (SvOK_off(sv), \
889 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
890 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
891 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
893 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
894 == (SVf_IOK|SVf_IVisUV))
895 #define SvUOK(sv) SvIOK_UV(sv)
896 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
899 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
900 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
901 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
903 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
904 #define SvNOK_on(sv) (assert_not_glob(sv) \
905 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
906 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
907 #define SvNOK_only(sv) (SvOK_off(sv), \
908 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
911 =for apidoc Am|U32|SvUTF8|SV* sv
912 Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
913 properly, this indicates whether or not the SV contains UTF-8 encoded data.
914 You should use this I<after> a call to C<SvPV()> or one of its variants, in
915 case any call to string overloading updates the internal flag.
917 If you want to take into account the L<bytes> pragma, use C<L</DO_UTF8>>
920 =for apidoc Am|void|SvUTF8_on|SV *sv
921 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
922 Do not use frivolously.
924 =for apidoc Am|void|SvUTF8_off|SV *sv
925 Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
926 Do not use frivolously.
928 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
929 Tells an SV that it is a string and disables all other C<OK> bits,
930 and leaves the UTF-8 status as it was.
935 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
937 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
938 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
939 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
941 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
942 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
943 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
944 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
945 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
946 SvFLAGS(sv) &= ~(SVf_OK| \
947 SVf_IVisUV|SVf_UTF8), \
948 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
949 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
950 SvFLAGS(sv) &= ~(SVf_OK| \
952 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
954 #define SvVOK(sv) (SvMAGICAL(sv) \
955 && mg_find(sv,PERL_MAGIC_vstring))
957 =for apidoc Am|MAGIC*|SvVSTRING_mg|SV * sv
959 Returns the vstring magic, or NULL if none
963 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
964 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
966 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
967 #define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
971 =for apidoc Am|void|SvOOK_off|SV * sv
973 Remove any string offset.
978 #define SvOOK_off(sv) ((void)(SvOOK(sv) && (sv_backoff(sv),0)))
980 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
981 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
982 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
984 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
985 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
986 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
988 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
989 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
990 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
992 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
993 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
994 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
996 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
997 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
998 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
1000 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
1001 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
1002 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
1004 #define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
1005 HvAMAGIC(SvSTASH(SvRV(sv))))
1007 /* To be used on the stashes themselves: */
1008 #define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
1009 #define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
1010 #define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
1013 /* "nog" means "doesn't have get magic" */
1014 #define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
1015 #define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
1016 #define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
1017 #define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
1018 #define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
1020 #define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1021 #define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
1022 #define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
1023 #define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
1024 #define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
1026 #define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1027 #define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1029 #define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
1030 #define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1032 #define SvPOK_pure_nogthink(sv) \
1033 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1034 #define SvPOK_utf8_pure_nogthink(sv) \
1035 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1036 #define SvPOK_byte_pure_nogthink(sv) \
1037 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1040 =for apidoc Am|U32|SvGAMAGIC|SV* sv
1042 Returns true if the SV has get magic or
1043 overloading. If either is true then
1044 the scalar is active data, and has the potential to return a new value every
1045 time it is accessed. Hence you must be careful to
1046 only read it once per user logical operation and work
1047 with that returned value. If neither is true then
1048 the scalar's value cannot change unless written to.
1053 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1055 #define Gv_AMG(stash) \
1056 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
1058 : (HvAMAGIC_off(stash), 0))
1060 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1061 == (SVf_ROK|SVprv_WEAKREF))
1062 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1063 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1065 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
1066 == (SVf_ROK|SVprv_PCS_IMPORTED))
1067 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
1068 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
1071 =for apidoc m|U32|SvTHINKFIRST|SV *sv
1073 A quick flag check to see whether an C<sv> should be passed to C<sv_force_normal>
1074 to be "downgraded" before C<SvIVX> or C<SvPVX> can be modified directly.
1076 For example, if your scalar is a reference and you want to modify the C<SvIVX>
1077 slot, you can't just do C<SvROK_off>, as that will leak the referent.
1079 This is used internally by various sv-modifying functions, such as
1080 C<sv_setsv>, C<sv_setiv> and C<sv_pvn_force>.
1082 One case that this does not handle is a gv without SvFAKE set. After
1084 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
1086 it will still be a gv.
1088 C<SvTHINKFIRST> sometimes produces false positives. In those cases
1089 C<sv_force_normal> does nothing.
1094 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1097 #define SvPADMY(sv) !(SvFLAGS(sv) & SVs_PADTMP)
1099 # define SvPADMY_on(sv) SvPADTMP_off(sv)
1102 #define SvPADTMP(sv) (SvFLAGS(sv) & (SVs_PADTMP))
1103 #define SvPADSTALE(sv) (SvFLAGS(sv) & (SVs_PADSTALE))
1105 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1106 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1107 #define SvPADSTALE_on(sv) Perl_SvPADSTALE_on(MUTABLE_SV(sv))
1108 #define SvPADSTALE_off(sv) Perl_SvPADSTALE_off(MUTABLE_SV(sv))
1110 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1111 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1112 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1114 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1115 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1116 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1119 =for apidoc Am|U32|SvREADONLY|SV* sv
1120 Returns true if the argument is readonly, otherwise returns false.
1121 Exposed to perl code via Internals::SvREADONLY().
1123 =for apidoc Am|U32|SvREADONLY_on|SV* sv
1124 Mark an object as readonly. Exactly what this means depends on the object
1125 type. Exposed to perl code via Internals::SvREADONLY().
1127 =for apidoc Am|U32|SvREADONLY_off|SV* sv
1128 Mark an object as not-readonly. Exactly what this mean depends on the
1129 object type. Exposed to perl code via Internals::SvREADONLY().
1134 #define SvREADONLY(sv) (SvFLAGS(sv) & (SVf_READONLY|SVf_PROTECT))
1136 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= (SVf_READONLY|SVf_PROTECT))
1137 # define SvREADONLY_off(sv) (SvFLAGS(sv) &=~(SVf_READONLY|SVf_PROTECT))
1139 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1140 # define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1143 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1144 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1145 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1148 # define SvCOMPILED(sv) 0
1149 # define SvCOMPILED_on(sv)
1150 # define SvCOMPILED_off(sv)
1154 #if defined (DEBUGGING) && defined(PERL_USE_GCC_BRACE_GROUPS)
1155 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
1156 assert(SvTYPE(_svtail) != SVt_PVAV); \
1157 assert(SvTYPE(_svtail) != SVt_PVHV); \
1158 assert(!(SvFLAGS(_svtail) & (SVf_NOK|SVp_NOK))); \
1159 assert(SvVALID(_svtail)); \
1160 ((XPVNV*)SvANY(_svtail))->xnv_u.xnv_bm_tail; \
1163 # define SvTAIL(_svtail) (((XPVNV*)SvANY(_svtail))->xnv_u.xnv_bm_tail)
1166 /* Does the SV have a Boyer-Moore table attached as magic?
1167 * 'VALID' is a poor name, but is kept for historical reasons. */
1168 #define SvVALID(_svvalid) ( \
1170 && SvSMAGICAL(_svvalid) \
1171 && SvMAGIC(_svvalid) \
1172 && (SvMAGIC(_svvalid)->mg_type == PERL_MAGIC_bm \
1173 || mg_find(_svvalid, PERL_MAGIC_bm)) \
1176 #define SvRVx(sv) SvRV(sv)
1178 #ifdef PERL_DEBUG_COW
1179 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1180 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1181 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1182 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1183 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1184 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1185 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1186 /* Don't test the core XS code yet. */
1187 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1188 # define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
1190 # define SvPVX(sv) SvPVX_mutable(sv)
1192 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1193 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1194 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1196 # define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1197 # define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
1198 #else /* Below is not PERL_DEBUG_COW */
1200 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1202 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1204 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1206 # if defined (DEBUGGING) && defined(PERL_USE_GCC_BRACE_GROUPS)
1207 /* These get expanded inside other macros that already use a variable _sv */
1208 # define SvPVX(sv) \
1209 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1210 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
1211 assert(!isGV_with_GP(_svpvx)); \
1212 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1213 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
1214 &((_svpvx)->sv_u.svu_pv); \
1217 # define SvCUR(sv) \
1218 ({ const SV *const _svcur = (const SV *)(sv); \
1219 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK]); \
1220 assert(!isGV_with_GP(_svcur)); \
1221 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1222 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1223 (((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1226 # define SvCUR(sv) \
1227 (*({ const SV *const _svcur = (const SV *)(sv); \
1228 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK]); \
1229 assert(!isGV_with_GP(_svcur)); \
1230 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1231 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1232 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1235 # define SvIVX(sv) \
1236 (*({ const SV *const _svivx = (const SV *)(sv); \
1237 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
1238 assert(!isGV_with_GP(_svivx)); \
1239 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1241 # define SvUVX(sv) \
1242 (*({ const SV *const _svuvx = (const SV *)(sv); \
1243 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
1244 assert(!isGV_with_GP(_svuvx)); \
1245 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1247 # define SvNVX(sv) \
1248 (*({ const SV *const _svnvx = (const SV *)(sv); \
1249 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
1250 assert(!isGV_with_GP(_svnvx)); \
1251 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1254 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1255 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1256 assert(!isGV_with_GP(_svrv)); \
1257 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1258 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1259 &((_svrv)->sv_u.svu_rv); \
1261 # define SvRV_const(sv) \
1262 ({ const SV *const _svrv = (const SV *)(sv); \
1263 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1264 assert(!isGV_with_GP(_svrv)); \
1265 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1266 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1267 (_svrv)->sv_u.svu_rv; \
1269 # define SvMAGIC(sv) \
1270 (*({ const SV *const _svmagic = (const SV *)(sv); \
1271 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1272 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1274 # define SvSTASH(sv) \
1275 (*({ const SV *const _svstash = (const SV *)(sv); \
1276 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1277 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1279 # else /* Below is not DEBUGGING or can't use brace groups */
1280 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1281 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1282 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1283 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1284 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1285 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1286 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1287 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1288 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1293 /* Given that these two are new, there can't be any existing code using them
1294 * as LVALUEs, so prevent that from happening */
1295 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1296 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1298 /* Except for the poison code, which uses & to scribble over the pointer after
1299 free() is called. */
1300 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1301 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1304 #define SvIVXx(sv) SvIVX(sv)
1305 #define SvUVXx(sv) SvUVX(sv)
1306 #define SvNVXx(sv) SvNVX(sv)
1307 #define SvPVXx(sv) SvPVX(sv)
1308 #define SvLENx(sv) SvLEN(sv)
1309 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1312 /* Ask a scalar nicely to try to become an IV, if possible.
1313 Not guaranteed to stay returning void */
1314 /* Macro won't actually call sv_2iv if already IOK */
1315 #define SvIV_please(sv) \
1316 STMT_START {if (!SvIOKp(sv) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK))) \
1317 (void) SvIV(sv); } STMT_END
1318 #define SvIV_please_nomg(sv) \
1319 (!(SvFLAGS(sv) & (SVf_IOK|SVp_IOK)) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK)) \
1320 ? (sv_2iv_flags(sv, 0), SvIOK(sv)) \
1322 #define SvIV_set(sv, val) \
1324 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1325 assert(!isGV_with_GP(sv)); \
1326 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1327 #define SvNV_set(sv, val) \
1329 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
1330 assert(!isGV_with_GP(sv)); \
1331 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1332 #define SvPV_set(sv, val) \
1334 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1335 assert(!isGV_with_GP(sv)); \
1336 assert(!(SvTYPE(sv) == SVt_PVIO \
1337 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1338 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1339 #define SvUV_set(sv, val) \
1341 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1342 assert(!isGV_with_GP(sv)); \
1343 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1344 #define SvRV_set(sv, val) \
1346 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
1347 assert(!isGV_with_GP(sv)); \
1348 assert(!(SvTYPE(sv) == SVt_PVIO \
1349 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1350 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1351 #define SvMAGIC_set(sv, val) \
1352 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1353 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1354 #define SvSTASH_set(sv, val) \
1355 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1356 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1357 #define SvCUR_set(sv, val) \
1359 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1360 assert(!isGV_with_GP(sv)); \
1361 assert(!(SvTYPE(sv) == SVt_PVIO \
1362 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1363 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1364 #define SvLEN_set(sv, val) \
1366 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1367 assert(!isGV_with_GP(sv)); \
1368 assert(!(SvTYPE(sv) == SVt_PVIO \
1369 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1370 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1371 #define SvEND_set(sv, val) \
1372 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1373 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1375 #define SvPV_renew(sv,n) \
1376 STMT_START { SvLEN_set(sv, n); \
1377 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1378 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1379 (MEM_SIZE)((n))))); \
1382 #define SvPV_shrink_to_cur(sv) STMT_START { \
1383 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1384 SvPV_renew(sv, _lEnGtH); \
1388 =for apidoc Am|void|SvPV_free|SV * sv
1390 Frees the PV buffer in C<sv>, leaving things in a precarious state, so should
1391 only be used as part of a larger operation
1395 #define SvPV_free(sv) \
1397 assert(SvTYPE(sv) >= SVt_PV); \
1399 assert(!SvROK(sv)); \
1400 if(UNLIKELY(SvOOK(sv))) { \
1402 SvOOK_offset(sv, zok); \
1403 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1404 SvFLAGS(sv) &= ~SVf_OOK; \
1406 Safefree(SvPVX(sv)); \
1411 /* Code that crops up in three places to take a scalar and ready it to hold
1413 # define prepare_SV_for_RV(sv) \
1415 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1416 sv_upgrade(sv, SVt_IV); \
1417 else if (SvTYPE(sv) >= SVt_PV) { \
1426 # define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1429 #if defined (DEBUGGING) && defined(PERL_USE_GCC_BRACE_GROUPS)
1430 # define BmUSEFUL(sv) \
1431 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1432 assert(SvTYPE(_bmuseful) >= SVt_PVIV); \
1433 assert(SvVALID(_bmuseful)); \
1434 assert(!SvIOK(_bmuseful)); \
1435 &(((XPVIV*) SvANY(_bmuseful))->xiv_u.xivu_iv); \
1438 # define BmUSEFUL(sv) ((XPVIV*) SvANY(sv))->xiv_u.xivu_iv
1443 # define BmRARE(sv) 0
1444 # define BmPREVIOUS(sv) 0
1447 #define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1449 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1450 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1451 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1452 #define LvSTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff_u.xlvu_stargoff
1453 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1454 #define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
1456 #define LVf_NEG_OFF 0x1
1457 #define LVf_NEG_LEN 0x2
1458 #define LVf_OUT_OF_RANGE 0x4
1460 #define IoIFP(sv) (sv)->sv_u.svu_fp
1461 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1462 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1463 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1464 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
1465 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1466 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1467 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1468 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1469 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1470 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1471 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1472 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1473 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1474 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1475 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1477 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1478 #define IoTYPE_RDONLY '<'
1479 #define IoTYPE_WRONLY '>'
1480 #define IoTYPE_RDWR '+'
1481 #define IoTYPE_APPEND 'a'
1482 #define IoTYPE_PIPE '|'
1483 #define IoTYPE_STD '-' /* stdin or stdout */
1484 #define IoTYPE_SOCKET 's'
1485 #define IoTYPE_CLOSED ' '
1486 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1487 #define IoTYPE_NUMERIC '#' /* fdopen */
1490 =for apidoc Am|bool|SvTAINTED|SV* sv
1491 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1494 =for apidoc Am|void|SvTAINTED_on|SV* sv
1495 Marks an SV as tainted if tainting is enabled.
1497 =for apidoc Am|void|SvTAINTED_off|SV* sv
1498 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1499 some of Perl's fundamental security features. XS module authors should not
1500 use this function unless they fully understand all the implications of
1501 unconditionally untainting the value. Untainting should be done in the
1502 standard perl fashion, via a carefully crafted regexp, rather than directly
1503 untainting variables.
1505 =for apidoc Am|void|SvTAINT|SV* sv
1506 Taints an SV if tainting is enabled, and if some input to the current
1507 expression is tainted--usually a variable, but possibly also implicit
1508 inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1509 the outputs of an expression in a pessimistic fashion; i.e., without paying
1510 attention to precisely which outputs are influenced by which inputs.
1515 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1517 #ifdef NO_TAINT_SUPPORT
1518 # define SvTAINTED(sv) 0
1520 # define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1522 #define SvTAINTED_on(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_taint(sv);} }STMT_END
1523 #define SvTAINTED_off(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_untaint(sv);} }STMT_END
1525 #define SvTAINT(sv) \
1527 assert(TAINTING_get || !TAINT_get); \
1528 if (UNLIKELY(TAINT_get)) \
1533 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1534 Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1535 only a string (C<SvPOK_only>), by hook or by crook. You need force if you are
1536 going to update the C<SvPVX> directly. Processes get magic.
1538 Note that coercing an arbitrary scalar into a plain PV will potentially
1539 strip useful data from it. For example if the SV was C<SvROK>, then the
1540 referent will have its reference count decremented, and the SV itself may
1541 be converted to an C<SvPOK> scalar with a string buffer containing a value
1542 such as C<"ARRAY(0x1234)">.
1544 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1545 Like C<SvPV_force>, but doesn't process get magic.
1547 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1548 Returns a pointer to the string in the SV, or a stringified form of
1549 the SV if the SV does not contain a string. The SV may cache the
1550 stringified version becoming C<SvPOK>. Handles 'get' magic. The
1551 C<len> variable will be set to the length of the string (this is a macro, so
1552 don't use C<&len>). See also C<L</SvPVx>> for a version which guarantees to
1553 evaluate C<sv> only once.
1555 Note that there is no guarantee that the return value of C<SvPV()> is
1556 equal to C<SvPVX(sv)>, or that C<SvPVX(sv)> contains valid data, or that
1557 successive calls to C<SvPV(sv)> will return the same pointer value each
1558 time. This is due to the way that things like overloading and
1559 Copy-On-Write are handled. In these cases, the return value may point to
1560 a temporary buffer or similar. If you absolutely need the C<SvPVX> field to
1561 be valid (for example, if you intend to write to it), then see
1564 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1565 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1566 Only use this if C<sv> is an expression with side effects, otherwise use the
1567 more efficient C<SvPV>.
1569 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1570 Like C<SvPV> but doesn't process magic.
1572 =for apidoc Am|char*|SvPV_nolen|SV* sv
1573 Like C<SvPV> but doesn't set a length variable.
1575 =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1576 Like C<SvPV_nolen> but doesn't process magic.
1578 =for apidoc Am|IV|SvIV|SV* sv
1579 =for apidoc_item SvIVx
1580 =for apidoc_item SvIV_nomg
1582 These coerce the given SV to IV and return it. The returned value in many
1583 circumstances will get stored in C<sv>'s IV slot, but not in all cases. (Use
1584 C<L</sv_setiv>> to make sure it does).
1586 C<SvIVx> is different from the others in that it is guaranteed to evaluate
1587 C<sv> exactly once; the others may evaluate it multiple times. Only use this
1588 form if C<sv> is an expression with side effects, otherwise use the more
1591 C<SvIV_nomg> is the same as C<SvIV>, but does not perform 'get' magic.
1593 =for apidoc Am|NV|SvNV|SV* sv
1594 =for apidoc_item SvNVx
1595 =for apidoc_item SvNV_nomg
1597 These coerce the given SV to NV and return it. The returned value in many
1598 circumstances will get stored in C<sv>'s NV slot, but not in all cases. (Use
1599 C<L</sv_setnv>> to make sure it does).
1601 C<SvNVx> is different from the others in that it is guaranteed to evaluate
1602 C<sv> exactly once; the others may evaluate it multiple times. Only use this
1603 form if C<sv> is an expression with side effects, otherwise use the more
1606 C<SvNV_nomg> is the same as C<SvNV>, but does not perform 'get' magic.
1608 =for apidoc Am|UV|SvUV|SV* sv
1609 =for apidoc_item SvUVx
1610 =for apidoc_item SvUV_nomg
1612 These coerce the given SV to UV and return it. The returned value in many
1613 circumstances will get stored in C<sv>'s UV slot, but not in all cases. (Use
1614 C<L</sv_setuv>> to make sure it does).
1616 C<SvUVx> is different from the others in that it is guaranteed to evaluate
1617 C<sv> exactly once; the others may evaluate it multiple times. Only use this
1618 form if C<sv> is an expression with side effects, otherwise use the more
1621 C<SvUV_nomg> is the same as C<SvUV>, but does not perform 'get' magic.
1623 =for apidoc Am|bool|SvTRUE|SV* sv
1624 Returns a boolean indicating whether Perl would evaluate the SV as true or
1625 false. See C<L</SvOK>> for a defined/undefined test. Handles 'get' magic
1626 unless the scalar is already C<SvPOK>, C<SvIOK> or C<SvNOK> (the public, not the
1629 As of Perl 5.32, this is guaranteed to evaluate C<sv> only once. Prior to that
1630 release, use C<L</SvTRUEx>> for single evaluation.
1632 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
1633 Returns a boolean indicating whether Perl would evaluate the SV as true or
1634 false. See C<L</SvOK>> for a defined/undefined test. Does not handle 'get' magic.
1636 =for apidoc Am|bool|SvTRUEx|SV* sv
1637 Identical to C<L</SvTRUE>>. Prior to 5.32, they differed in that only this one
1638 was guaranteed to evaluate C<sv> only once; in 5.32 they both evaluated it
1639 once, but C<SvTRUEx> was slightly slower on some platforms; now they are
1642 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1643 Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
1645 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1646 Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
1648 =for apidoc Am|char*|SvPVutf8_nomg|SV* sv|STRLEN len
1649 Like C<SvPVutf8>, but does not process get magic.
1651 =for apidoc Am|char*|SvPVutf8_or_null|SV* sv|STRLEN len
1652 Like C<SvPVutf8>, but when C<sv> is undef, returns C<NULL>.
1654 =for apidoc Am|char*|SvPVutf8_or_null_nomg|SV* sv|STRLEN len
1655 Like C<SvPVutf8_or_null>, but does not process get magic.
1657 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1658 Like C<SvPV_nolen>, but converts C<sv> to UTF-8 first if necessary.
1660 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1661 Like C<SvPV_force>, but converts C<sv> to byte representation first if
1662 necessary. If the SV cannot be downgraded from UTF-8, this croaks.
1664 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1665 Like C<SvPV>, but converts C<sv> to byte representation first if necessary. If
1666 the SV cannot be downgraded from UTF-8, this croaks.
1668 =for apidoc Am|char*|SvPVbyte_nomg|SV* sv|STRLEN len
1669 Like C<SvPVbyte>, but does not process get magic.
1671 =for apidoc Am|char*|SvPVbyte_or_null|SV* sv|STRLEN len
1672 Like C<SvPVbyte>, but when C<sv> is undef, returns C<NULL>.
1674 =for apidoc Am|char*|SvPVbyte_or_null_nomg|SV* sv|STRLEN len
1675 Like C<SvPVbyte_or_null>, but does not process get magic.
1677 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1678 Like C<SvPV_nolen>, but converts C<sv> to byte representation first if
1679 necessary. If the SV cannot be downgraded from UTF-8, this croaks.
1681 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1682 Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
1683 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8_force>
1686 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1687 Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
1688 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8>
1691 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1692 Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary.
1693 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte_force>
1694 otherwise. If the SV cannot be downgraded from UTF-8, this croaks.
1696 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1697 Like C<SvPV>, but converts C<sv> to byte representation first if necessary.
1698 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte>
1699 otherwise. If the SV cannot be downgraded from UTF-8, this croaks.
1701 =for apidoc Am|U32|SvIsCOW|SV* sv
1702 Returns a U32 value indicating whether the SV is Copy-On-Write (either shared
1703 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1706 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1707 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1713 /* Let us hope that bitmaps for UV and IV are the same */
1714 #define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1715 #define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1716 #define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
1718 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1719 #define SvUV_nomg(sv) (SvUOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1720 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1724 #define SvPV(sv, len) SvPV_flags(sv, len, SV_GMAGIC)
1725 #define SvPV_const(sv, len) SvPV_flags_const(sv, len, SV_GMAGIC)
1726 #define SvPV_mutable(sv, len) SvPV_flags_mutable(sv, len, SV_GMAGIC)
1728 #define SvPV_flags(sv, len, flags) \
1730 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &len, flags))
1731 #define SvPV_flags_const(sv, len, flags) \
1733 ? ((len = SvCUR(sv)), SvPVX_const(sv)) : \
1734 (const char*) sv_2pv_flags(sv, &len, (flags|SV_CONST_RETURN)))
1735 #define SvPV_flags_const_nolen(sv, flags) \
1737 ? SvPVX_const(sv) : \
1738 (const char*) sv_2pv_flags(sv, 0, (flags|SV_CONST_RETURN)))
1739 #define SvPV_flags_mutable(sv, len, flags) \
1741 ? ((len = SvCUR(sv)), SvPVX_mutable(sv)) : \
1742 sv_2pv_flags(sv, &len, (flags|SV_MUTABLE_RETURN)))
1744 #define SvPV_force(sv, len) SvPV_force_flags(sv, len, SV_GMAGIC)
1745 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1746 #define SvPV_force_mutable(sv, len) SvPV_force_flags_mutable(sv, len, SV_GMAGIC)
1748 #define SvPV_force_nomg(sv, len) SvPV_force_flags(sv, len, 0)
1749 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1751 #define SvPV_force_flags(sv, len, flags) \
1752 (SvPOK_pure_nogthink(sv) \
1753 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &len, flags))
1755 #define SvPV_force_flags_nolen(sv, flags) \
1756 (SvPOK_pure_nogthink(sv) \
1757 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1759 #define SvPV_force_flags_mutable(sv, len, flags) \
1760 (SvPOK_pure_nogthink(sv) \
1761 ? ((len = SvCUR(sv)), SvPVX_mutable(sv)) \
1762 : sv_pvn_force_flags(sv, &len, flags|SV_MUTABLE_RETURN))
1764 #define SvPV_nolen(sv) \
1766 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1768 /* "_nomg" in these defines means no mg_get() */
1769 #define SvPV_nomg_nolen(sv) \
1771 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1773 #define SvPV_nolen_const(sv) \
1775 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1777 #define SvPV_nomg(sv, len) SvPV_flags(sv, len, 0)
1778 #define SvPV_nomg_const(sv, len) SvPV_flags_const(sv, len, 0)
1779 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1783 #define SvPVutf8(sv, len) \
1784 (SvPOK_utf8_nog(sv) \
1785 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &len))
1787 #define SvPVutf8_or_null(sv, len) \
1788 (SvPOK_utf8_nog(sv) \
1789 ? ((len = SvCUR(sv)), SvPVX(sv)) : (SvGETMAGIC(sv), SvOK(sv)) \
1790 ? sv_2pvutf8_flags(sv, &len, 0) : ((len = 0), NULL))
1792 #define SvPVutf8_nomg(sv, len) \
1793 (SvPOK_utf8_nog(sv) \
1794 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8_flags(sv, &len, 0))
1796 #define SvPVutf8_or_null_nomg(sv, len) \
1797 (SvPOK_utf8_nog(sv) \
1798 ? ((len = SvCUR(sv)), SvPVX(sv)) : SvOK(sv) \
1799 ? sv_2pvutf8_flags(sv, &len, 0) : ((len = 0), NULL))
1801 #define SvPVutf8_force(sv, len) \
1802 (SvPOK_utf8_pure_nogthink(sv) \
1803 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &len))
1805 #define SvPVutf8_nolen(sv) \
1806 (SvPOK_utf8_nog(sv) \
1807 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1811 #define SvPVbyte(sv, len) \
1812 (SvPOK_byte_nog(sv) \
1813 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &len))
1815 #define SvPVbyte_or_null(sv, len) \
1816 (SvPOK_byte_nog(sv) \
1817 ? ((len = SvCUR(sv)), SvPVX(sv)) : (SvGETMAGIC(sv), SvOK(sv)) \
1818 ? sv_2pvbyte_flags(sv, &len, 0) : ((len = 0), NULL))
1820 #define SvPVbyte_nomg(sv, len) \
1821 (SvPOK_byte_nog(sv) \
1822 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte_flags(sv, &len, 0))
1824 #define SvPVbyte_or_null_nomg(sv, len) \
1825 (SvPOK_utf8_nog(sv) \
1826 ? ((len = SvCUR(sv)), SvPVX(sv)) : SvOK(sv) \
1827 ? sv_2pvbyte_flags(sv, &len, 0) : ((len = 0), NULL))
1829 #define SvPVbyte_force(sv, len) \
1830 (SvPOK_byte_pure_nogthink(sv) \
1831 ? ((len = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &len))
1833 #define SvPVbyte_nolen(sv) \
1834 (SvPOK_byte_nog(sv) \
1835 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1838 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1839 * var to evaluate the arg once; failing that, use a global if possible;
1840 * failing that, call a function to do the work
1843 #define SvPVx_force(sv, len) sv_pvn_force(sv, &len)
1844 #define SvPVutf8x_force(sv, len) sv_pvutf8n_force(sv, &len)
1845 #define SvPVbytex_force(sv, len) sv_pvbyten_force(sv, &len)
1847 #define SvTRUE(sv) Perl_SvTRUE(aTHX_ sv)
1848 #define SvTRUEx(sv) SvTRUE(sv)
1849 #define SvTRUE_nomg(sv) (LIKELY(sv) && SvTRUE_nomg_NN(sv))
1850 #define SvTRUE_NN(sv) (SvGETMAGIC(sv), SvTRUE_nomg_NN(sv))
1851 #define SvTRUE_nomg_NN(sv) (SvTRUE_common(sv, sv_2bool_nomg(sv)))
1853 #define SvTRUE_common(sv,fallback) ( \
1854 SvIMMORTAL_INTERP(sv) \
1855 ? SvIMMORTAL_TRUE(sv) \
1861 ? (SvIVX(sv) != 0 /* cast to bool */) \
1862 : (SvROK(sv) && !( SvOBJECT(SvRV(sv)) \
1863 && HvAMAGIC(SvSTASH(SvRV(sv))))) \
1867 #if defined(PERL_USE_GCC_BRACE_GROUPS)
1869 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1870 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1871 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1872 # define SvPVx(sv, len) ({SV *_sv = (sv); SvPV(_sv, len); })
1873 # define SvPVx_const(sv, len) ({SV *_sv = (sv); SvPV_const(_sv, len); })
1874 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1875 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1876 # define SvPVutf8x(sv, len) ({SV *_sv = (sv); SvPVutf8(_sv, len); })
1877 # define SvPVbytex(sv, len) ({SV *_sv = (sv); SvPVbyte(_sv, len); })
1878 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1879 # define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
1881 #else /* __GNUC__ */
1883 /* These inlined macros use globals, which will require a thread
1884 * declaration in user code, so we avoid them under threads */
1886 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1887 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1888 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1889 # define SvPVx(sv, len) ((PL_Sv = (sv)), SvPV(PL_Sv, len))
1890 # define SvPVx_const(sv, len) ((PL_Sv = (sv)), SvPV_const(PL_Sv, len))
1891 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1892 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1893 # define SvPVutf8x(sv, len) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, len))
1894 # define SvPVbytex(sv, len) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, len))
1895 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1896 # define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
1897 #endif /* __GNU__ */
1899 #define SvPVXtrue(sv) ( \
1900 ((XPV*)SvANY((sv))) \
1902 ((XPV*)SvANY((sv)))->xpv_cur > 1 \
1904 ((XPV*)SvANY((sv)))->xpv_cur \
1905 && *(sv)->sv_u.svu_pv != '0' \
1910 #define SvIsCOW(sv) (SvFLAGS(sv) & SVf_IsCOW)
1911 #define SvIsCOW_on(sv) (SvFLAGS(sv) |= SVf_IsCOW)
1912 #define SvIsCOW_off(sv) (SvFLAGS(sv) &= ~SVf_IsCOW)
1913 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1915 #define SvSHARED_HEK_FROM_PV(pvx) \
1916 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1917 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1919 /* flag values for sv_*_flags functions */
1920 #define SV_UTF8_NO_ENCODING 0 /* No longer used */
1923 =for apidoc AmnhD||SV_UTF8_NO_ENCODING
1928 #define SV_IMMEDIATE_UNREF 1
1930 #define SV_COW_DROP_PV 4
1931 #define SV_NOSTEAL 16
1932 #define SV_CONST_RETURN 32
1933 #define SV_MUTABLE_RETURN 64
1934 #define SV_SMAGIC 128
1935 #define SV_HAS_TRAILING_NUL 256
1936 #define SV_COW_SHARED_HASH_KEYS 512
1937 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1938 /* XXX This flag actually enabled for any COW. But it appears not to do
1939 anything. Can we just remove it? Or will it serve some future
1941 #define SV_COW_OTHER_PVS 1024
1942 /* Make sv_2pv_flags return NULL if something is undefined. */
1943 #define SV_UNDEF_RETURNS_NULL 2048
1944 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1945 * This is used when the caller has already determined it is, and avoids
1947 #define SV_FORCE_UTF8_UPGRADE 4096
1948 /* if (after resolving magic etc), the SV is found to be overloaded,
1949 * don't call the overload magic, just return as-is */
1950 #define SV_SKIP_OVERLOAD 8192
1951 #define SV_CATBYTES 16384
1952 #define SV_CATUTF8 32768
1954 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1955 So only default to doing the COW setup if we're in the core.
1958 # ifndef SV_DO_COW_SVSETSV
1959 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1963 #ifndef SV_DO_COW_SVSETSV
1964 # define SV_DO_COW_SVSETSV 0
1968 #define sv_unref(sv) sv_unref_flags(sv, 0)
1969 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1970 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1971 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1973 /* We are about to replace the SV's current value. So if it's copy on write
1974 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1975 the value is about to get thrown away, so drop the PV rather than go to
1976 the effort of making a read-write copy only for it to get immediately
1979 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1980 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1982 #ifdef PERL_COPY_ON_WRITE
1983 # define SvCANCOW(sv) \
1985 ? SvLEN(sv) ? CowREFCNT(sv) != SV_COW_REFCNT_MAX : 1 \
1986 : (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS \
1987 && SvCUR(sv)+1 < SvLEN(sv))
1988 /* Note: To allow 256 COW "copies", a refcnt of 0 means 1. */
1989 # define CowREFCNT(sv) (*(U8 *)(SvPVX(sv)+SvLEN(sv)-1))
1990 # define SV_COW_REFCNT_MAX nBIT_UMAX(sizeof(U8) * CHARBITS)
1991 # define CAN_COW_MASK (SVf_POK|SVf_ROK|SVp_POK|SVf_FAKE| \
1992 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_PROTECT)
1995 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1997 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1998 sv_force_normal_flags(sv, 0)
2001 /* all these 'functions' are now just macros */
2003 #define sv_pv(sv) SvPV_nolen(sv)
2004 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
2005 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
2007 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
2008 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
2009 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
2010 #define sv_utf8_downgrade(sv, fail_ok) sv_utf8_downgrade_flags(sv, fail_ok, SV_GMAGIC)
2011 #define sv_utf8_downgrade_nomg(sv, fail_ok) sv_utf8_downgrade_flags(sv, fail_ok, 0)
2012 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
2013 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
2014 #define sv_setsv(dsv, ssv) \
2015 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
2016 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
2017 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
2018 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
2019 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
2020 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
2021 #define sv_catpvn_mg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
2022 #define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
2023 #define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
2024 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
2025 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
2026 #define sv_2pvbyte(sv, lp) sv_2pvbyte_flags(sv, lp, SV_GMAGIC)
2027 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
2028 #define sv_2pvutf8(sv, lp) sv_2pvutf8_flags(sv, lp, SV_GMAGIC)
2029 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
2030 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
2031 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
2032 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
2033 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
2034 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
2035 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
2036 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
2037 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
2038 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
2039 #define sv_collxfrm(sv, nxp) sv_collxfrm_flags(sv, nxp, SV_GMAGIC)
2040 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
2041 #define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
2042 #define sv_insert(bigstr, offset, len, little, littlelen) \
2043 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
2044 (littlelen), SV_GMAGIC)
2045 #define sv_mortalcopy(sv) \
2046 Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV)
2047 #define sv_cathek(sv,hek) \
2049 HEK * const bmxk = hek; \
2050 sv_catpvn_flags(sv, HEK_KEY(bmxk), HEK_LEN(bmxk), \
2051 HEK_UTF8(bmxk) ? SV_CATUTF8 : SV_CATBYTES); \
2054 /* Should be named SvCatPVN_utf8_upgrade? */
2055 #define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
2058 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
2060 sv_setpvn(nsv, sstr, slen); \
2062 sv_utf8_upgrade(nsv); \
2063 sv_catsv_nomg(dsv, nsv); \
2065 #define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \
2066 sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES)
2068 #if defined(PERL_CORE) || defined(PERL_EXT)
2069 # define sv_or_pv_len_utf8(sv, pv, bytelen) \
2071 ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \
2076 =for apidoc Am|SV*|newRV_inc|SV* sv
2078 Creates an RV wrapper for an SV. The reference count for the original SV is
2084 #define newRV_inc(sv) newRV(sv)
2086 /* the following macros update any magic values this C<sv> is associated with */
2089 =for apidoc_section $magic
2091 =for apidoc Am|void|SvGETMAGIC|SV* sv
2092 Invokes C<L</mg_get>> on an SV if it has 'get' magic. For example, this
2093 will call C<FETCH> on a tied variable. This macro evaluates its
2094 argument more than once.
2096 =for apidoc Am|void|SvSETMAGIC|SV* sv
2097 Invokes C<L</mg_set>> on an SV if it has 'set' magic. This is necessary
2098 after modifying a scalar, in case it is a magical variable like C<$|>
2099 or a tied variable (it calls C<STORE>). This macro evaluates its
2100 argument more than once.
2102 =for apidoc Am|void|SvSetSV|SV* dsv|SV* ssv
2103 Calls C<sv_setsv> if C<dsv> is not the same as C<ssv>. May evaluate arguments
2104 more than once. Does not handle 'set' magic on the destination SV.
2106 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
2107 Calls a non-destructive version of C<sv_setsv> if C<dsv> is not the same as
2108 C<ssv>. May evaluate arguments more than once.
2110 =for apidoc Am|void|SvSetMagicSV|SV* dsv|SV* ssv
2111 Like C<SvSetSV>, but does any set magic required afterwards.
2113 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
2114 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2116 =for apidoc Am|void|SvSHARE|SV* sv
2117 Arranges for C<sv> to be shared between threads if a suitable module
2120 =for apidoc Am|void|SvLOCK|SV* sv
2121 Arranges for a mutual exclusion lock to be obtained on C<sv> if a suitable module
2124 =for apidoc Am|void|SvUNLOCK|SV* sv
2125 Releases a mutual exclusion lock on C<sv> if a suitable module
2128 =for apidoc_section $SV
2130 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
2131 Expands the character buffer in the SV so that it has room for the
2132 indicated number of bytes (remember to reserve space for an extra trailing
2133 C<NUL> character). Calls C<sv_grow> to perform the expansion if necessary.
2134 Returns a pointer to the character
2135 buffer. SV must be of type >= C<SVt_PV>. One
2136 alternative is to call C<sv_grow> if you are not sure of the type of SV.
2138 You might mistakenly think that C<len> is the number of bytes to add to the
2139 existing size, but instead it is the total size C<sv> should be.
2141 =for apidoc Am|char *|SvPVCLEAR|SV* sv
2142 Ensures that sv is a SVt_PV and that its SvCUR is 0, and that it is
2143 properly null terminated. Equivalent to sv_setpvs(""), but more efficient.
2148 #define SvPVCLEAR(sv) sv_setpv_bufsize(sv,0,0)
2149 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
2150 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
2151 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
2152 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
2154 #define SvGETMAGIC(x) ((void)(UNLIKELY(SvGMAGICAL(x)) && mg_get(x)))
2155 #define SvSETMAGIC(x) STMT_START { if (UNLIKELY(SvSMAGICAL(x))) mg_set(x); } STMT_END
2157 #define SvSetSV_and(dst,src,finally) \
2159 if (LIKELY((dst) != (src))) { \
2160 sv_setsv(dst, src); \
2164 #define SvSetSV_nosteal_and(dst,src,finally) \
2166 if (LIKELY((dst) != (src))) { \
2167 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
2172 #define SvSetSV(dst,src) \
2173 SvSetSV_and(dst,src,/*nothing*/;)
2174 #define SvSetSV_nosteal(dst,src) \
2175 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
2177 #define SvSetMagicSV(dst,src) \
2178 SvSetSV_and(dst,src,SvSETMAGIC(dst))
2179 #define SvSetMagicSV_nosteal(dst,src) \
2180 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
2183 #if !defined(SKIP_DEBUGGING)
2184 #define SvPEEK(sv) sv_peek(sv)
2186 #define SvPEEK(sv) ""
2189 /* Is this a per-interpreter immortal SV (rather than global)?
2190 * These should either occupy adjacent entries in the interpreter struct
2191 * (MULTIPLICITY) or adjacent elements of PL_sv_immortals[] otherwise.
2192 * The unsigned (Size_t) cast avoids the need for a second < 0 condition.
2194 #define SvIMMORTAL_INTERP(sv) ((Size_t)((sv) - &PL_sv_yes) < 4)
2196 /* Does this immortal have a true value? Currently only PL_sv_yes does. */
2197 #define SvIMMORTAL_TRUE(sv) ((sv) == &PL_sv_yes)
2199 /* the SvREADONLY() test is to quickly reject most SVs */
2200 #define SvIMMORTAL(sv) \
2202 && (SvIMMORTAL_INTERP(sv) || (sv) == &PL_sv_placeholder))
2205 /* exercise the immortal resurrection code in sv_free2() */
2206 # define SvREFCNT_IMMORTAL 1000
2208 # define SvREFCNT_IMMORTAL ((~(U32)0)/2)
2212 =for apidoc Am|SV *|boolSV|bool b
2214 Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
2216 See also C<L</PL_sv_yes>> and C<L</PL_sv_no>>.
2221 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2223 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2224 /* If I give every macro argument a different name, then there won't be bugs
2225 where nested macros get confused. Been there, done that. */
2227 =for apidoc Am|bool|isGV_with_GP|SV * sv
2228 Returns a boolean as to whether or not C<sv> is a GV with a pointer to a GP
2233 #define isGV_with_GP(pwadak) \
2234 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
2235 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2236 #define isGV_with_GP_on(sv) STMT_START { \
2237 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2238 assert (!SvPOKp(sv)); \
2239 assert (!SvIOKp(sv)); \
2240 (SvFLAGS(sv) |= SVpgv_GP); \
2242 #define isGV_with_GP_off(sv) STMT_START { \
2243 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2244 assert (!SvPOKp(sv)); \
2245 assert (!SvIOKp(sv)); \
2246 (SvFLAGS(sv) &= ~SVpgv_GP); \
2249 # define isGV_or_RVCV(kadawp) \
2250 (isGV(kadawp) || (SvROK(kadawp) && SvTYPE(SvRV(kadawp)) == SVt_PVCV))
2252 #define isREGEXP(sv) \
2253 (SvTYPE(sv) == SVt_REGEXP \
2254 || (SvFLAGS(sv) & (SVTYPEMASK|SVpgv_GP|SVf_FAKE)) \
2255 == (SVt_PVLV|SVf_FAKE))
2259 # define SvGROW(sv,len) \
2260 (SvIsCOW(sv) || SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2262 # define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2264 #define SvGROW_mutable(sv,len) \
2265 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2266 #define Sv_Grow sv_grow
2268 #define CLONEf_COPY_STACKS 1
2269 #define CLONEf_KEEP_PTR_TABLE 2
2270 #define CLONEf_CLONE_HOST 4
2271 #define CLONEf_JOIN_IN 8
2273 struct clone_params {
2276 PerlInterpreter *proto_perl;
2277 PerlInterpreter *new_perl;
2281 /* SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
2282 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
2283 #define newSVsv(sv) newSVsv_flags((sv), SV_GMAGIC|SV_NOSTEAL)
2284 #define newSVsv_nomg(sv) newSVsv_flags((sv), SV_NOSTEAL)
2287 =for apidoc Am|SV*|newSVpvn_utf8|const char* s|STRLEN len|U32 utf8
2289 Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
2290 characters) into it. If C<utf8> is true, calls
2291 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2296 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2299 =for apidoc Amx|SV*|newSVpadname|PADNAME *pn
2301 Creates a new SV containing the pad name.
2306 #define newSVpadname(pn) newSVpvn_utf8(PadnamePV(pn), PadnameLEN(pn), TRUE)
2309 =for apidoc Am|void|SvOOK_offset|SV*sv|STRLEN len
2311 Reads into C<len> the offset from C<SvPVX> back to the true start of the
2312 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2313 efficiently remove characters from start of the buffer. Implemented as a
2314 macro, which takes the address of C<len>, which must be of type C<STRLEN>.
2315 Evaluates C<sv> more than once. Sets C<len> to 0 if C<SvOOK(sv)> is false.
2321 /* Does the bot know something I don't?
2322 10:28 <@Nicholas> metabatman
2323 10:28 <+meta> Nicholas: crash
2325 # define SvOOK_offset(sv, offset) STMT_START { \
2326 STATIC_ASSERT_STMT(sizeof(offset) == sizeof(STRLEN)); \
2328 const U8 *_crash = (U8*)SvPVX_const(sv); \
2329 (offset) = *--_crash; \
2331 _crash -= sizeof(STRLEN); \
2332 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
2335 /* Validate the preceding buffer's sentinels to \
2336 verify that no-one is using it. */ \
2337 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2338 while (_crash > _bonk) { \
2340 assert (*_crash == (U8)PTR2UV(_crash)); \
2348 /* This is the same code, but avoids using any temporary variables: */
2349 # define SvOOK_offset(sv, offset) STMT_START { \
2350 STATIC_ASSERT_STMT(sizeof(offset) == sizeof(STRLEN)); \
2352 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2354 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2355 (U8*)&(offset), sizeof(STRLEN), U8); \
2363 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2365 #if defined(PERL_CORE) || defined(PERL_EXT)
2367 # define SV_CONST(name) \
2368 PL_sv_consts[SV_CONST_##name] \
2369 ? PL_sv_consts[SV_CONST_##name] \
2370 : (PL_sv_consts[SV_CONST_##name] = newSVpv_share(#name, 0))
2372 # define SV_CONST_TIESCALAR 0
2373 # define SV_CONST_TIEARRAY 1
2374 # define SV_CONST_TIEHASH 2
2375 # define SV_CONST_TIEHANDLE 3
2377 # define SV_CONST_FETCH 4
2378 # define SV_CONST_FETCHSIZE 5
2379 # define SV_CONST_STORE 6
2380 # define SV_CONST_STORESIZE 7
2381 # define SV_CONST_EXISTS 8
2383 # define SV_CONST_PUSH 9
2384 # define SV_CONST_POP 10
2385 # define SV_CONST_SHIFT 11
2386 # define SV_CONST_UNSHIFT 12
2387 # define SV_CONST_SPLICE 13
2388 # define SV_CONST_EXTEND 14
2390 # define SV_CONST_FIRSTKEY 15
2391 # define SV_CONST_NEXTKEY 16
2392 # define SV_CONST_SCALAR 17
2394 # define SV_CONST_OPEN 18
2395 # define SV_CONST_WRITE 19
2396 # define SV_CONST_PRINT 20
2397 # define SV_CONST_PRINTF 21
2398 # define SV_CONST_READ 22
2399 # define SV_CONST_READLINE 23
2400 # define SV_CONST_GETC 24
2401 # define SV_CONST_SEEK 25
2402 # define SV_CONST_TELL 26
2403 # define SV_CONST_EOF 27
2404 # define SV_CONST_BINMODE 28
2405 # define SV_CONST_FILENO 29
2406 # define SV_CONST_CLOSE 30
2408 # define SV_CONST_DELETE 31
2409 # define SV_CONST_CLEAR 32
2410 # define SV_CONST_UNTIE 33
2411 # define SV_CONST_DESTROY 34
2414 #define SV_CONSTS_COUNT 35
2417 * Bodyless IVs and NVs!
2419 * Since 5.9.2, we can avoid allocating a body for SVt_IV-type SVs.
2420 * Since the larger IV-holding variants of SVs store their integer
2421 * values in their respective bodies, the family of SvIV() accessor
2422 * macros would naively have to branch on the SV type to find the
2423 * integer value either in the HEAD or BODY. In order to avoid this
2424 * expensive branch, a clever soul has deployed a great hack:
2425 * We set up the SvANY pointer such that instead of pointing to a
2426 * real body, it points into the memory before the location of the
2427 * head. We compute this pointer such that the location of
2428 * the integer member of the hypothetical body struct happens to
2429 * be the same as the location of the integer member of the bodyless
2430 * SV head. This now means that the SvIV() family of accessors can
2431 * always read from the (hypothetical or real) body via SvANY.
2433 * Since the 5.21 dev series, we employ the same trick for NVs
2434 * if the architecture can support it (NVSIZE <= IVSIZE).
2437 /* The following two macros compute the necessary offsets for the above
2438 * trick and store them in SvANY for SvIV() (and friends) to use. */
2441 # define SET_SVANY_FOR_BODYLESS_IV(sv) \
2442 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) \
2443 - STRUCT_OFFSET(XPVIV, xiv_iv))
2445 # define SET_SVANY_FOR_BODYLESS_NV(sv) \
2446 SvANY(sv) = (XPVNV*)((char*)&(sv->sv_u.svu_nv) \
2447 - STRUCT_OFFSET(XPVNV, xnv_u.xnv_nv))
2451 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob