3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 #undef sv_flags /* Convex has this in <signal.h> for sigvec() */
18 =for apidoc AmU||svtype
19 An enum of flags for Perl types. These are found in the file F<sv.h>
20 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
42 These are most easily explained from the bottom up.
44 C<SVt_PVIO> is for I/O objects, C<SVt_PVFM> for formats, C<SVt_PVCV> for
45 subroutines, C<SVt_PVHV> for hashes and C<SVt_PVAV> for arrays.
47 All the others are scalar types, that is, things that can be bound to a
48 C<$> variable. For these, the internal types are mostly orthogonal to
49 types in the Perl language.
51 Hence, checking C<< SvTYPE(sv) < SVt_PVAV >> is the best way to see whether
52 something is a scalar.
54 C<SVt_PVGV> represents a typeglob. If C<!SvFAKE(sv)>, then it is a real,
55 incoercible typeglob. If C<SvFAKE(sv)>, then it is a scalar to which a
56 typeglob has been assigned. Assigning to it again will stop it from being
57 a typeglob. C<SVt_PVLV> represents a scalar that delegates to another scalar
58 behind the scenes. It is used, e.g., for the return value of C<substr> and
59 for tied hash and array elements. It can hold any scalar value, including
60 a typeglob. C<SVt_REGEXP> is for regular
61 expressions. C<SVt_INVLIST> is for Perl
62 core internal use only.
64 C<SVt_PVMG> represents a "normal" scalar (not a typeglob, regular expression,
65 or delegate). Since most scalars do not need all the internal fields of a
66 PVMG, we save memory by allocating smaller structs when possible. All the
67 other types are just simpler forms of C<SVt_PVMG>, with fewer internal fields.
68 C<SVt_NULL> can only hold undef. C<SVt_IV> can hold undef, an integer, or a
69 reference. (C<SVt_RV> is an alias for C<SVt_IV>, which exists for backward
70 compatibility.) C<SVt_NV> can hold any of those or a double. C<SVt_PV> can only
71 hold C<undef> or a string. C<SVt_PVIV> is a superset of C<SVt_PV> and C<SVt_IV>.
72 C<SVt_PVNV> is similar. C<SVt_PVMG> can hold anything C<SVt_PVNV> can hold, but it
73 can, but does not have to, be blessed or magical.
75 =for apidoc AmU||SVt_NULL
76 Type flag for scalars. See L</svtype>.
78 =for apidoc AmU||SVt_IV
79 Type flag for scalars. See L</svtype>.
81 =for apidoc AmU||SVt_NV
82 Type flag for scalars. See L</svtype>.
84 =for apidoc AmU||SVt_PV
85 Type flag for scalars. See L</svtype>.
87 =for apidoc AmU||SVt_PVIV
88 Type flag for scalars. See L</svtype>.
90 =for apidoc AmU||SVt_PVNV
91 Type flag for scalars. See L</svtype>.
93 =for apidoc AmU||SVt_PVMG
94 Type flag for scalars. See L</svtype>.
96 =for apidoc AmU||SVt_INVLIST
97 Type flag for scalars. See L</svtype>.
99 =for apidoc AmU||SVt_REGEXP
100 Type flag for regular expressions. See L</svtype>.
102 =for apidoc AmU||SVt_PVGV
103 Type flag for typeglobs. See L</svtype>.
105 =for apidoc AmU||SVt_PVLV
106 Type flag for scalars. See L</svtype>.
108 =for apidoc AmU||SVt_PVAV
109 Type flag for arrays. See L</svtype>.
111 =for apidoc AmU||SVt_PVHV
112 Type flag for hashes. See L</svtype>.
114 =for apidoc AmU||SVt_PVCV
115 Type flag for subroutines. See L</svtype>.
117 =for apidoc AmU||SVt_PVFM
118 Type flag for formats. See L</svtype>.
120 =for apidoc AmU||SVt_PVIO
121 Type flag for I/O objects. See L</svtype>.
125 These are ordered so that the simpler types have a lower value; SvUPGRADE
126 doesn't allow you to upgrade from a higher numbered type to a lower numbered
127 one; also there is code that assumes that anything that has as a PV component
128 has a type numbered >= SVt_PV.
134 /* BIND was here, before INVLIST replaced it. */
137 /* RV was here, before it was merged with IV. */
139 SVt_INVLIST, /* 4, implemented as a PV */
144 /* PVBM was here, before BIND replaced it. */
152 SVt_LAST /* keep last in enum. used to size arrays */
155 /* *** any alterations to the SV types above need to be reflected in
156 * SVt_MASK and the various PL_valid_types_* tables. As of this writing those
157 * tables are in perl.h. There are also two affected names tables in dump.c,
158 * one in B.xs, and 'bodies_by_type[]' in sv.c */
160 #define SVt_MASK 0xf /* smallest bitmask that covers all types */
163 /* Fast Boyer Moore tables are now stored in magic attached to PVMGs */
164 # define SVt_PVBM SVt_PVMG
165 /* Anything wanting to create a reference from clean should ensure that it has
166 a scalar of type SVt_IV now: */
167 # define SVt_RV SVt_IV
170 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
171 so never reaches the clause at the end that uses sv_type_details->body_size
172 to determine whether to call safefree(). Hence body_size can be set
173 non-zero to record the size of HEs, without fear of bogus frees. */
174 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
175 #define HE_SVSLOT SVt_NULL
178 # define SVt_FIRST SVt_NULL /* the type of SV that new_SV() in sv.c returns */
181 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
183 /* typedefs to eliminate some typing */
184 typedef struct he HE;
185 typedef struct hek HEK;
187 /* Using C's structural equivalence to help emulate C++ inheritance here... */
189 /* start with 2 sv-head building blocks */
190 #define _SV_HEAD(ptrtype) \
191 ptrtype sv_any; /* pointer to body */ \
192 U32 sv_refcnt; /* how many references to us */ \
193 U32 sv_flags /* what we are */
196 # define _NV_BODYLESS_UNION NV svu_nv;
198 # define _NV_BODYLESS_UNION
201 #define _SV_HEAD_UNION \
203 char* svu_pv; /* pointer to malloced string */ \
207 SV* svu_rv; /* pointer to another SV */ \
208 struct regexp* svu_rx; \
216 #ifdef DEBUG_LEAKING_SCALARS
217 #define _SV_HEAD_DEBUG ;\
218 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */ \
219 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */ \
220 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */ \
221 UV sv_debug_serial; /* serial number of sv allocation */ \
222 char * sv_debug_file; /* the file where we were allocated */ \
223 SV * sv_debug_parent /* what we were cloned from (ithreads)*/
225 #define _SV_HEAD_DEBUG
228 struct STRUCT_SV { /* struct sv { */
234 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
239 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
244 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
249 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
254 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
259 _SV_HEAD(struct regexp*); /* pointer to regexp body */
264 #undef _SV_HEAD_UNION /* ensure no pollution */
267 =head1 SV Manipulation Functions
269 =for apidoc Am|U32|SvREFCNT|SV* sv
270 Returns the value of the object's reference count. Exposed
271 to perl code via Internals::SvREFCNT().
273 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
274 Increments the reference count of the given SV, returning the SV.
276 All of the following C<SvREFCNT_inc>* macros are optimized versions of
277 C<SvREFCNT_inc>, and can be replaced with C<SvREFCNT_inc>.
279 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
280 Same as C<SvREFCNT_inc>, but can only be used if you know C<sv>
281 is not C<NULL>. Since we don't have to check the NULLness, it's faster
284 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
285 Same as C<SvREFCNT_inc>, but can only be used if you don't need the
286 return value. The macro doesn't need to return a meaningful value.
288 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
289 Same as C<SvREFCNT_inc>, but can only be used if you don't need the return
290 value, and you know that C<sv> is not C<NULL>. The macro doesn't need
291 to return a meaningful value, or check for NULLness, so it's smaller
294 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
295 Same as C<SvREFCNT_inc>, but can only be used with expressions without side
296 effects. Since we don't have to store a temporary value, it's faster.
298 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
299 Same as C<SvREFCNT_inc_simple>, but can only be used if you know C<sv>
300 is not C<NULL>. Since we don't have to check the NULLness, it's faster
303 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
304 Same as C<SvREFCNT_inc_simple>, but can only be used if you don't need the
305 return value. The macro doesn't need to return a meaningful value.
307 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
308 Same as C<SvREFCNT_inc>, but can only be used if you don't need the return
309 value, and you know that C<sv> is not C<NULL>. The macro doesn't need
310 to return a meaningful value, or check for NULLness, so it's smaller
313 =for apidoc Am|void|SvREFCNT_dec|SV* sv
314 Decrements the reference count of the given SV. C<sv> may be C<NULL>.
316 =for apidoc Am|void|SvREFCNT_dec_NN|SV* sv
317 Same as C<SvREFCNT_dec>, but can only be used if you know C<sv>
318 is not C<NULL>. Since we don't have to check the NULLness, it's faster
321 =for apidoc Am|svtype|SvTYPE|SV* sv
322 Returns the type of the SV. See C<L</svtype>>.
324 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
325 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
326 perform the upgrade if necessary. See C<L</svtype>>.
331 #define SvANY(sv) (sv)->sv_any
332 #define SvFLAGS(sv) (sv)->sv_flags
333 #define SvREFCNT(sv) (sv)->sv_refcnt
335 #define SvREFCNT_inc(sv) S_SvREFCNT_inc(MUTABLE_SV(sv))
336 #define SvREFCNT_inc_simple(sv) SvREFCNT_inc(sv)
337 #define SvREFCNT_inc_NN(sv) S_SvREFCNT_inc_NN(MUTABLE_SV(sv))
338 #define SvREFCNT_inc_void(sv) S_SvREFCNT_inc_void(MUTABLE_SV(sv))
340 /* These guys don't need the curly blocks */
341 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
342 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
343 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
344 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
346 #define SvREFCNT_dec(sv) S_SvREFCNT_dec(aTHX_ MUTABLE_SV(sv))
347 #define SvREFCNT_dec_NN(sv) S_SvREFCNT_dec_NN(aTHX_ MUTABLE_SV(sv))
349 #define SVTYPEMASK 0xff
350 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
352 /* Sadly there are some parts of the core that have pointers to already-freed
353 SV heads, and rely on being able to tell that they are now free. So mark
354 them all by using a consistent macro. */
355 #define SvIS_FREED(sv) UNLIKELY(((sv)->sv_flags == SVTYPEMASK))
357 /* this is defined in this peculiar way to avoid compiler warnings.
358 * See the <20121213131428.GD1842@iabyn.com> thread in p5p */
359 #define SvUPGRADE(sv, mt) \
360 ((void)(SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt),1)))
362 #define SVf_IOK 0x00000100 /* has valid public integer value */
363 #define SVf_NOK 0x00000200 /* has valid public numeric value */
364 #define SVf_POK 0x00000400 /* has valid public pointer value */
365 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
367 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
368 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
369 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
370 #define SVp_SCREAM 0x00008000 /* currently unused on plain scalars */
371 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
372 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
373 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
374 subroutine in another package. Set the
375 GvIMPORTED_CV_on() if it needs to be
376 expanded to a real GV */
377 #define SVf_PROTECT 0x00010000 /* very read-only */
378 #define SVs_PADTMP 0x00020000 /* in use as tmp */
379 #define SVs_PADSTALE 0x00040000 /* lexical has gone out of scope;
380 only used when !PADTMP */
381 #define SVs_TEMP 0x00080000 /* mortal (implies string is stealable) */
382 #define SVs_OBJECT 0x00100000 /* is "blessed" */
383 #define SVs_GMG 0x00200000 /* has magical get method */
384 #define SVs_SMG 0x00400000 /* has magical set method */
385 #define SVs_RMG 0x00800000 /* has random magical methods */
387 #define SVf_FAKE 0x01000000 /* 0: glob is just a copy
388 1: SV head arena wasn't malloc()ed
389 2: For PVCV, whether CvUNIQUE(cv)
390 refers to an eval or once only
391 [CvEVAL(cv), CvSPECIAL(cv)]
392 3: HV: informally reserved by DAPM
394 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
395 means that a hv_aux struct is present
396 after the main array */
397 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
398 SVs in final arena cleanup.
399 Set in S_regtry on PL_reg_curpm, so that
400 perl_destruct will skip it.
401 Used for mark and sweep by OP_AASSIGN
403 #define SVf_READONLY 0x08000000 /* may not be modified */
408 #define SVf_THINKFIRST (SVf_READONLY|SVf_PROTECT|SVf_ROK|SVf_FAKE \
411 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
412 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
414 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
416 /* Note that SVf_AMAGIC is now only set on stashes. */
417 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
418 #define SVf_IsCOW 0x10000000 /* copy on write (shared hash key if
421 /* Ensure this value does not clash with the GV_ADD* flags in gv.h, or the
422 CV_CKPROTO_* flags in op.c, or the padadd_* flags in pad.h: */
423 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
424 This is also set on RVs whose overloaded
425 stringification is UTF-8. This might
426 only happen as a side effect of SvPV() */
428 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
430 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
431 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
432 been restructured, so sometimes get used as string buffers. */
435 /* Some private flags. */
439 #define SVpav_REAL 0x40000000 /* free old entries */
441 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
443 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
444 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
446 #define SVpav_REIFY 0x80000000 /* can become real */
448 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
449 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
450 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
451 /* pad name vars only */
454 HV* xmg_stash; /* class package */ \
456 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
458 STRLEN xpvlenu_len; /* allocated size */ \
459 char * xpvlenu_pv; /* regexp string */ \
462 #define xpv_len xpv_len_u.xpvlenu_len
465 NV xnv_nv; /* numeric value, if any */
467 line_t xnv_lines; /* used internally by S_scan_subst() */
468 bool xnv_bm_tail; /* an SvVALID (BM) SV has an implicit "\n" */
472 IV xivu_iv; /* integer value */
474 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
475 bool xivu_eval_seen; /* used internally by S_scan_subst() */
480 MAGIC* xmg_magic; /* linked list of magicalness */
481 STRLEN xmg_hash_index; /* used while freeing hash entries */
493 #define xiv_iv xiv_u.xivu_iv
500 #define xuv_uv xuv_u.xivu_uv
508 /* This structure must match the beginning of struct xpvhv in hv.h. */
521 SSize_t xlvu_stargoff;
525 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
526 * y=alem/helem/iter t=tie T=tied HE */
527 char xlv_flags; /* 1 = negative offset 2 = negative len */
530 #define xlv_targoff xlv_targoff_u.xlvu_targoff
534 IV prev_index; /* caches result of previous invlist_search() */
535 STRLEN iterator; /* Stores where we are in iterating */
536 bool is_offset; /* The data structure for all inversion lists
537 begins with an element for code point U+0000.
538 If this bool is set, the actual list contains
539 that 0; otherwise, the list actually begins
540 with the following element. Thus to invert
541 the list, merely toggle this flag */
544 /* This structure works in 2 ways - regular scalar, or GV with GP */
552 typedef U32 cv_flags_t;
554 #define _XPVCV_COMMON \
562 void (*xcv_xsub) (pTHX_ CV*); \
570 PADLIST * xcv_padlist; \
574 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
575 * compilation) in the lexically enclosing \
577 cv_flags_t xcv_flags; \
578 I32 xcv_depth /* >= 2 indicates recursive call */
580 /* This structure must match XPVCV in cv.h */
591 /* ifp and ofp are normally the same, but sockets need separate streams */
593 /* Cray addresses everything by word boundaries (64 bits) and
594 * code and data pointers cannot be mixed (which is exactly what
595 * Perl_filter_add() tries to do with the dirp), hence the
596 * following union trick (as suggested by Gurusamy Sarathy).
597 * For further information see Geir Johansen's problem report
598 * titled [ID 20000612.002 (#3366)] Perl problem on Cray system
599 * The any pointer (known as IoANY()) will also be a good place
600 * to hang any IO disciplines to.
603 DIR * xiou_dirp; /* for opendir, readdir, etc */
604 void * xiou_any; /* for alignment */
606 /* IV xio_lines is now in IVX $. */
607 IV xio_page; /* $% */
608 IV xio_page_len; /* $= */
609 IV xio_lines_left; /* $- */
610 char * xio_top_name; /* $^ */
611 GV * xio_top_gv; /* $^ */
612 char * xio_fmt_name; /* $~ */
613 GV * xio_fmt_gv; /* $~ */
614 char * xio_bottom_name;/* $^B */
615 GV * xio_bottom_gv; /* $^B */
620 #define xio_dirp xio_dirpu.xiou_dirp
621 #define xio_any xio_dirpu.xiou_any
623 #define IOf_ARGV 1 /* this fp iterates over ARGV */
624 #define IOf_START 2 /* check for null ARGV and substitute '-' */
625 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
626 #define IOf_DIDTOP 8 /* just did top of form */
627 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
628 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
629 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
630 Also, when this is set, SvPVX() is valid */
632 /* The following macros define implementation-independent predicates on SVs. */
635 =for apidoc Am|U32|SvNIOK|SV* sv
636 Returns a U32 value indicating whether the SV contains a number, integer or
639 =for apidoc Am|U32|SvNIOKp|SV* sv
640 Returns a U32 value indicating whether the SV contains a number, integer or
641 double. Checks the B<private> setting. Use C<SvNIOK> instead.
643 =for apidoc Am|void|SvNIOK_off|SV* sv
644 Unsets the NV/IV status of an SV.
646 =for apidoc Am|U32|SvOK|SV* sv
647 Returns a U32 value indicating whether the value is defined. This is
648 only meaningful for scalars.
650 =for apidoc Am|U32|SvIOKp|SV* sv
651 Returns a U32 value indicating whether the SV contains an integer. Checks
652 the B<private> setting. Use C<SvIOK> instead.
654 =for apidoc Am|U32|SvNOKp|SV* sv
655 Returns a U32 value indicating whether the SV contains a double. Checks the
656 B<private> setting. Use C<SvNOK> instead.
658 =for apidoc Am|U32|SvPOKp|SV* sv
659 Returns a U32 value indicating whether the SV contains a character string.
660 Checks the B<private> setting. Use C<SvPOK> instead.
662 =for apidoc Am|U32|SvIOK|SV* sv
663 Returns a U32 value indicating whether the SV contains an integer.
665 =for apidoc Am|void|SvIOK_on|SV* sv
666 Tells an SV that it is an integer.
668 =for apidoc Am|void|SvIOK_off|SV* sv
669 Unsets the IV status of an SV.
671 =for apidoc Am|void|SvIOK_only|SV* sv
672 Tells an SV that it is an integer and disables all other C<OK> bits.
674 =for apidoc Am|void|SvIOK_only_UV|SV* sv
675 Tells an SV that it is an unsigned integer and disables all other C<OK> bits.
677 =for apidoc Am|bool|SvIOK_UV|SV* sv
678 Returns a boolean indicating whether the SV contains an integer that must be
679 interpreted as unsigned. A non-negative integer whose value is within the
680 range of both an IV and a UV may be be flagged as either C<SvUOK> or C<SVIOK>.
682 =for apidoc Am|bool|SvUOK|SV* sv
683 Returns a boolean indicating whether the SV contains an integer that must be
684 interpreted as unsigned. A non-negative integer whose value is within the
685 range of both an IV and a UV may be be flagged as either C<SvUOK> or C<SVIOK>.
687 =for apidoc Am|bool|SvIOK_notUV|SV* sv
688 Returns a boolean indicating whether the SV contains a signed integer.
690 =for apidoc Am|U32|SvNOK|SV* sv
691 Returns a U32 value indicating whether the SV contains a double.
693 =for apidoc Am|void|SvNOK_on|SV* sv
694 Tells an SV that it is a double.
696 =for apidoc Am|void|SvNOK_off|SV* sv
697 Unsets the NV status of an SV.
699 =for apidoc Am|void|SvNOK_only|SV* sv
700 Tells an SV that it is a double and disables all other OK bits.
702 =for apidoc Am|U32|SvPOK|SV* sv
703 Returns a U32 value indicating whether the SV contains a character
706 =for apidoc Am|void|SvPOK_on|SV* sv
707 Tells an SV that it is a string.
709 =for apidoc Am|void|SvPOK_off|SV* sv
710 Unsets the PV status of an SV.
712 =for apidoc Am|void|SvPOK_only|SV* sv
713 Tells an SV that it is a string and disables all other C<OK> bits.
714 Will also turn off the UTF-8 status.
716 =for apidoc Am|bool|SvVOK|SV* sv
717 Returns a boolean indicating whether the SV contains a v-string.
719 =for apidoc Am|U32|SvOOK|SV* sv
720 Returns a U32 indicating whether the pointer to the string buffer is offset.
721 This hack is used internally to speed up removal of characters from the
722 beginning of a C<SvPV>. When C<SvOOK> is true, then the start of the
723 allocated string buffer is actually C<SvOOK_offset()> bytes before C<SvPVX>.
724 This offset used to be stored in C<SvIVX>, but is now stored within the spare
727 =for apidoc Am|U32|SvROK|SV* sv
728 Tests if the SV is an RV.
730 =for apidoc Am|void|SvROK_on|SV* sv
731 Tells an SV that it is an RV.
733 =for apidoc Am|void|SvROK_off|SV* sv
734 Unsets the RV status of an SV.
736 =for apidoc Am|SV*|SvRV|SV* sv
737 Dereferences an RV to return the SV.
739 =for apidoc Am|IV|SvIVX|SV* sv
740 Returns the raw value in the SV's IV slot, without checks or conversions.
741 Only use when you are sure C<SvIOK> is true. See also C<L</SvIV>>.
743 =for apidoc Am|UV|SvUVX|SV* sv
744 Returns the raw value in the SV's UV slot, without checks or conversions.
745 Only use when you are sure C<SvIOK> is true. See also C<L</SvUV>>.
747 =for apidoc Am|NV|SvNVX|SV* sv
748 Returns the raw value in the SV's NV slot, without checks or conversions.
749 Only use when you are sure C<SvNOK> is true. See also C<L</SvNV>>.
751 =for apidoc Am|char*|SvPVX|SV* sv
752 Returns a pointer to the physical string in the SV. The SV must contain a
753 string. Prior to 5.9.3 it is not safe
754 to execute this macro unless the SV's
757 This is also used to store the name of an autoloaded subroutine in an XS
758 AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
760 =for apidoc Am|STRLEN|SvCUR|SV* sv
761 Returns the length of the string which is in the SV. See C<L</SvLEN>>.
763 =for apidoc Am|STRLEN|SvLEN|SV* sv
764 Returns the size of the string buffer in the SV, not including any part
765 attributable to C<SvOOK>. See C<L</SvCUR>>.
767 =for apidoc Am|char*|SvEND|SV* sv
768 Returns a pointer to the spot just after the last character in
769 the string which is in the SV, where there is usually a trailing
770 C<NUL> character (even though Perl scalars do not strictly require it).
771 See C<L</SvCUR>>. Access the character as C<*(SvEND(sv))>.
773 Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
776 =for apidoc Am|HV*|SvSTASH|SV* sv
777 Returns the stash of the SV.
779 =for apidoc Am|void|SvIV_set|SV* sv|IV val
780 Set the value of the IV pointer in sv to val. It is possible to perform
781 the same function of this macro with an lvalue assignment to C<SvIVX>.
782 With future Perls, however, it will be more efficient to use
783 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
785 =for apidoc Am|void|SvNV_set|SV* sv|NV val
786 Set the value of the NV pointer in C<sv> to val. See C<L</SvIV_set>>.
788 =for apidoc Am|void|SvPV_set|SV* sv|char* val
789 This is probably not what you want to use, you probably wanted
790 L</sv_usepvn_flags> or L</sv_setpvn> or L</sv_setpvs>.
792 Set the value of the PV pointer in C<sv> to the Perl allocated
793 C<NUL>-terminated string C<val>. See also C<L</SvIV_set>>.
795 Remember to free the previous PV buffer. There are many things to check.
796 Beware that the existing pointer may be involved in copy-on-write or other
797 mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or
798 C<SvPV_force> (or check the C<SvIsCOW> flag) first to make sure this
799 modification is safe. Then finally, if it is not a COW, call C<SvPV_free> to
800 free the previous PV buffer.
802 =for apidoc Am|void|SvUV_set|SV* sv|UV val
803 Set the value of the UV pointer in C<sv> to val. See C<L</SvIV_set>>.
805 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
806 Set the value of the RV pointer in C<sv> to val. See C<L</SvIV_set>>.
808 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
809 Set the value of the MAGIC pointer in C<sv> to val. See C<L</SvIV_set>>.
811 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
812 Set the value of the STASH pointer in C<sv> to val. See C<L</SvIV_set>>.
814 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
815 Set the current length of the string which is in the SV. See C<L</SvCUR>>
818 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
819 Set the size of the string buffer for the SV. See C<L</SvLEN>>.
824 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
825 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
826 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
827 SVp_IOK|SVp_NOK|SVf_IVisUV))
829 #define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv))
830 #define assert_not_glob(sv) assert_(!isGV_with_GP(sv))
832 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK || isREGEXP(sv))
833 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
834 SvFLAGS(sv) &= ~(SVf_OK| \
835 SVf_IVisUV|SVf_UTF8), \
837 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
838 SvFLAGS(sv) &= ~(SVf_OK| \
842 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
843 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
844 #define SvIOKp_on(sv) (assert_not_glob(sv) \
845 SvFLAGS(sv) |= SVp_IOK)
846 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
847 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
848 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
849 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
850 SvFLAGS(sv) |= SVp_POK)
852 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
853 #define SvIOK_on(sv) (assert_not_glob(sv) \
854 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
855 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
856 #define SvIOK_only(sv) (SvOK_off(sv), \
857 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
858 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
859 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
861 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
862 == (SVf_IOK|SVf_IVisUV))
863 #define SvUOK(sv) SvIOK_UV(sv)
864 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
867 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
868 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
869 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
871 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
872 #define SvNOK_on(sv) (assert_not_glob(sv) \
873 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
874 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
875 #define SvNOK_only(sv) (SvOK_off(sv), \
876 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
879 =for apidoc Am|U32|SvUTF8|SV* sv
880 Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
881 properly, this indicates whether or not the SV contains UTF-8 encoded data.
882 You should use this I<after> a call to C<SvPV()> or one of its variants, in
883 case any call to string overloading updates the internal flag.
885 If you want to take into account the L<bytes> pragma, use C<L</DO_UTF8>>
888 =for apidoc Am|void|SvUTF8_on|SV *sv
889 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
890 Do not use frivolously.
892 =for apidoc Am|void|SvUTF8_off|SV *sv
893 Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
894 Do not use frivolously.
896 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
897 Tells an SV that it is a string and disables all other C<OK> bits,
898 and leaves the UTF-8 status as it was.
903 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
905 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
906 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
907 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
909 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
910 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
911 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
912 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
913 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
914 SvFLAGS(sv) &= ~(SVf_OK| \
915 SVf_IVisUV|SVf_UTF8), \
916 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
917 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
918 SvFLAGS(sv) &= ~(SVf_OK| \
920 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
922 #define SvVOK(sv) (SvMAGICAL(sv) \
923 && mg_find(sv,PERL_MAGIC_vstring))
924 /* returns the vstring magic, if any */
925 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
926 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
928 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
929 #define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
930 #define SvOOK_off(sv) ((void)(SvOOK(sv) && (sv_backoff(sv),0)))
932 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
933 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
934 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
936 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
937 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
938 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
940 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
941 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
942 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
944 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
945 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
946 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
948 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
949 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
950 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
952 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
953 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
954 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
956 #define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
957 HvAMAGIC(SvSTASH(SvRV(sv))))
959 /* To be used on the stashes themselves: */
960 #define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
961 #define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
962 #define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
965 /* "nog" means "doesn't have get magic" */
966 #define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
967 #define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
968 #define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
969 #define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
970 #define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
972 #define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
973 #define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
974 #define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
975 #define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
976 #define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
978 #define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
979 #define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
981 #define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
982 #define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
984 #define SvPOK_pure_nogthink(sv) \
985 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
986 #define SvPOK_utf8_pure_nogthink(sv) \
987 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
988 #define SvPOK_byte_pure_nogthink(sv) \
989 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
992 =for apidoc Am|U32|SvGAMAGIC|SV* sv
994 Returns true if the SV has get magic or
995 overloading. If either is true then
996 the scalar is active data, and has the potential to return a new value every
997 time it is accessed. Hence you must be careful to
998 only read it once per user logical operation and work
999 with that returned value. If neither is true then
1000 the scalar's value cannot change unless written to.
1005 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1007 #define Gv_AMG(stash) \
1008 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
1010 : (HvAMAGIC_off(stash), 0))
1012 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1013 == (SVf_ROK|SVprv_WEAKREF))
1014 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1015 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1017 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
1018 == (SVf_ROK|SVprv_PCS_IMPORTED))
1019 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
1020 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
1023 =for apidoc m|U32|SvTHINKFIRST|SV *sv
1025 A quick flag check to see whether an C<sv> should be passed to C<sv_force_normal>
1026 to be "downgraded" before C<SvIVX> or C<SvPVX> can be modified directly.
1028 For example, if your scalar is a reference and you want to modify the C<SvIVX>
1029 slot, you can't just do C<SvROK_off>, as that will leak the referent.
1031 This is used internally by various sv-modifying functions, such as
1032 C<sv_setsv>, C<sv_setiv> and C<sv_pvn_force>.
1034 One case that this does not handle is a gv without SvFAKE set. After
1036 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
1038 it will still be a gv.
1040 C<SvTHINKFIRST> sometimes produces false positives. In those cases
1041 C<sv_force_normal> does nothing.
1046 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1049 #define SvPADMY(sv) !(SvFLAGS(sv) & SVs_PADTMP)
1051 # define SvPADMY_on(sv) SvPADTMP_off(sv)
1054 #define SvPADTMP(sv) (SvFLAGS(sv) & (SVs_PADTMP))
1055 #define SvPADSTALE(sv) (SvFLAGS(sv) & (SVs_PADSTALE))
1057 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1058 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1059 #define SvPADSTALE_on(sv) S_SvPADSTALE_on(MUTABLE_SV(sv))
1060 #define SvPADSTALE_off(sv) S_SvPADSTALE_off(MUTABLE_SV(sv))
1062 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1063 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1064 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1066 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1067 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1068 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1071 =for apidoc Am|U32|SvREADONLY|SV* sv
1072 Returns true if the argument is readonly, otherwise returns false.
1073 Exposed to to perl code via Internals::SvREADONLY().
1075 =for apidoc Am|U32|SvREADONLY_on|SV* sv
1076 Mark an object as readonly. Exactly what this means depends on the object
1077 type. Exposed to perl code via Internals::SvREADONLY().
1079 =for apidoc Am|U32|SvREADONLY_off|SV* sv
1080 Mark an object as not-readonly. Exactly what this mean depends on the
1081 object type. Exposed to perl code via Internals::SvREADONLY().
1086 #define SvREADONLY(sv) (SvFLAGS(sv) & (SVf_READONLY|SVf_PROTECT))
1088 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= (SVf_READONLY|SVf_PROTECT))
1089 # define SvREADONLY_off(sv) (SvFLAGS(sv) &=~(SVf_READONLY|SVf_PROTECT))
1091 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1092 # define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1095 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1096 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1097 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1100 # define SvCOMPILED(sv) 0
1101 # define SvCOMPILED_on(sv)
1102 # define SvCOMPILED_off(sv)
1106 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1107 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
1108 assert(SvTYPE(_svtail) != SVt_PVAV); \
1109 assert(SvTYPE(_svtail) != SVt_PVHV); \
1110 assert(!(SvFLAGS(_svtail) & (SVf_NOK|SVp_NOK))); \
1111 assert(SvVALID(_svtail)); \
1112 ((XPVNV*)SvANY(_svtail))->xnv_u.xnv_bm_tail; \
1115 # define SvTAIL(_svtail) (((XPVNV*)SvANY(_svtail))->xnv_u.xnv_bm_tail)
1118 /* Does the SV have a Boyer-Moore table attached as magic?
1119 * 'VALID' is a poor name, but is kept for historical reasons. */
1120 #define SvVALID(_svvalid) ( \
1122 && SvSMAGICAL(_svvalid) \
1123 && SvMAGIC(_svvalid) \
1124 && (SvMAGIC(_svvalid)->mg_type == PERL_MAGIC_bm \
1125 || mg_find(_svvalid, PERL_MAGIC_bm)) \
1128 #define SvRVx(sv) SvRV(sv)
1130 #ifdef PERL_DEBUG_COW
1131 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1132 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1133 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1134 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1135 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1136 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1137 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1138 /* Don't test the core XS code yet. */
1139 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1140 # define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
1142 # define SvPVX(sv) SvPVX_mutable(sv)
1144 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1145 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1146 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1148 # define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1149 # define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
1151 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1152 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1154 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1155 /* These get expanded inside other macros that already use a variable _sv */
1156 # define SvPVX(sv) \
1157 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1158 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
1159 assert(!isGV_with_GP(_svpvx)); \
1160 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1161 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
1162 &((_svpvx)->sv_u.svu_pv); \
1164 # define SvCUR(sv) \
1165 (*({ const SV *const _svcur = (const SV *)(sv); \
1166 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK] \
1167 || SvTYPE(_svcur) == SVt_REGEXP); \
1168 assert(!isGV_with_GP(_svcur)); \
1169 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1170 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1171 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1173 # define SvIVX(sv) \
1174 (*({ const SV *const _svivx = (const SV *)(sv); \
1175 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
1176 assert(!isGV_with_GP(_svivx)); \
1177 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1179 # define SvUVX(sv) \
1180 (*({ const SV *const _svuvx = (const SV *)(sv); \
1181 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
1182 assert(!isGV_with_GP(_svuvx)); \
1183 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1185 # define SvNVX(sv) \
1186 (*({ const SV *const _svnvx = (const SV *)(sv); \
1187 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
1188 assert(!isGV_with_GP(_svnvx)); \
1189 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1192 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1193 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1194 assert(!isGV_with_GP(_svrv)); \
1195 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1196 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1197 &((_svrv)->sv_u.svu_rv); \
1199 # define SvRV_const(sv) \
1200 ({ const SV *const _svrv = (const SV *)(sv); \
1201 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1202 assert(!isGV_with_GP(_svrv)); \
1203 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1204 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1205 (_svrv)->sv_u.svu_rv; \
1207 # define SvMAGIC(sv) \
1208 (*({ const SV *const _svmagic = (const SV *)(sv); \
1209 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1210 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1212 # define SvSTASH(sv) \
1213 (*({ const SV *const _svstash = (const SV *)(sv); \
1214 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1215 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1218 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1219 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1220 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1221 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1222 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1223 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1224 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1225 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1226 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1231 /* Given that these two are new, there can't be any existing code using them
1233 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1234 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1236 /* Except for the poison code, which uses & to scribble over the pointer after
1237 free() is called. */
1238 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1239 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1242 #define SvIVXx(sv) SvIVX(sv)
1243 #define SvUVXx(sv) SvUVX(sv)
1244 #define SvNVXx(sv) SvNVX(sv)
1245 #define SvPVXx(sv) SvPVX(sv)
1246 #define SvLENx(sv) SvLEN(sv)
1247 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1250 /* Ask a scalar nicely to try to become an IV, if possible.
1251 Not guaranteed to stay returning void */
1252 /* Macro won't actually call sv_2iv if already IOK */
1253 #define SvIV_please(sv) \
1254 STMT_START {if (!SvIOKp(sv) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK))) \
1255 (void) SvIV(sv); } STMT_END
1256 #define SvIV_please_nomg(sv) \
1257 (!(SvFLAGS(sv) & (SVf_IOK|SVp_IOK)) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK)) \
1258 ? (sv_2iv_flags(sv, 0), SvIOK(sv)) \
1260 #define SvIV_set(sv, val) \
1262 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1263 assert(!isGV_with_GP(sv)); \
1264 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1265 #define SvNV_set(sv, val) \
1267 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
1268 assert(!isGV_with_GP(sv)); \
1269 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1270 #define SvPV_set(sv, val) \
1272 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1273 assert(!isGV_with_GP(sv)); \
1274 assert(!(SvTYPE(sv) == SVt_PVIO \
1275 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1276 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1277 #define SvUV_set(sv, val) \
1279 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1280 assert(!isGV_with_GP(sv)); \
1281 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1282 #define SvRV_set(sv, val) \
1284 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
1285 assert(!isGV_with_GP(sv)); \
1286 assert(!(SvTYPE(sv) == SVt_PVIO \
1287 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1288 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1289 #define SvMAGIC_set(sv, val) \
1290 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1291 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1292 #define SvSTASH_set(sv, val) \
1293 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1294 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1295 #define SvCUR_set(sv, val) \
1297 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK] \
1298 || SvTYPE(sv) == SVt_REGEXP); \
1299 assert(!isGV_with_GP(sv)); \
1300 assert(!(SvTYPE(sv) == SVt_PVIO \
1301 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1302 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1303 #define SvLEN_set(sv, val) \
1305 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1306 assert(!isGV_with_GP(sv)); \
1307 assert(!(SvTYPE(sv) == SVt_PVIO \
1308 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1309 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1310 #define SvEND_set(sv, val) \
1311 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1312 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1314 #define SvPV_renew(sv,n) \
1315 STMT_START { SvLEN_set(sv, n); \
1316 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1317 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1318 (MEM_SIZE)((n))))); \
1321 #define SvPV_shrink_to_cur(sv) STMT_START { \
1322 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1323 SvPV_renew(sv, _lEnGtH); \
1326 #define SvPV_free(sv) \
1328 assert(SvTYPE(sv) >= SVt_PV); \
1330 assert(!SvROK(sv)); \
1331 if(UNLIKELY(SvOOK(sv))) { \
1333 SvOOK_offset(sv, zok); \
1334 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1335 SvFLAGS(sv) &= ~SVf_OOK; \
1337 Safefree(SvPVX(sv)); \
1342 /* Code that crops up in three places to take a scalar and ready it to hold
1344 # define prepare_SV_for_RV(sv) \
1346 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1347 sv_upgrade(sv, SVt_IV); \
1348 else if (SvTYPE(sv) >= SVt_PV) { \
1357 # define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1360 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1361 # define BmUSEFUL(sv) \
1362 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1363 assert(SvTYPE(_bmuseful) >= SVt_PVIV); \
1364 assert(SvVALID(_bmuseful)); \
1365 assert(!SvIOK(_bmuseful)); \
1366 &(((XPVIV*) SvANY(_bmuseful))->xiv_u.xivu_iv); \
1369 # define BmUSEFUL(sv) ((XPVIV*) SvANY(sv))->xiv_u.xivu_iv
1374 # define BmRARE(sv) 0
1375 # define BmPREVIOUS(sv) 0
1378 #define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1380 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1381 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1382 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1383 #define LvSTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff_u.xlvu_stargoff
1384 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1385 #define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
1387 #define IoIFP(sv) (sv)->sv_u.svu_fp
1388 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1389 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1390 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1391 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
1392 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1393 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1394 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1395 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1396 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1397 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1398 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1399 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1400 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1401 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1402 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1404 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1405 #define IoTYPE_RDONLY '<'
1406 #define IoTYPE_WRONLY '>'
1407 #define IoTYPE_RDWR '+'
1408 #define IoTYPE_APPEND 'a'
1409 #define IoTYPE_PIPE '|'
1410 #define IoTYPE_STD '-' /* stdin or stdout */
1411 #define IoTYPE_SOCKET 's'
1412 #define IoTYPE_CLOSED ' '
1413 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1414 #define IoTYPE_NUMERIC '#' /* fdopen */
1417 =for apidoc Am|bool|SvTAINTED|SV* sv
1418 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1421 =for apidoc Am|void|SvTAINTED_on|SV* sv
1422 Marks an SV as tainted if tainting is enabled.
1424 =for apidoc Am|void|SvTAINTED_off|SV* sv
1425 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1426 some of Perl's fundamental security features. XS module authors should not
1427 use this function unless they fully understand all the implications of
1428 unconditionally untainting the value. Untainting should be done in the
1429 standard perl fashion, via a carefully crafted regexp, rather than directly
1430 untainting variables.
1432 =for apidoc Am|void|SvTAINT|SV* sv
1433 Taints an SV if tainting is enabled, and if some input to the current
1434 expression is tainted--usually a variable, but possibly also implicit
1435 inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1436 the outputs of an expression in a pessimistic fashion; i.e., without paying
1437 attention to precisely which outputs are influenced by which inputs.
1442 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1444 #ifdef NO_TAINT_SUPPORT
1445 # define SvTAINTED(sv) 0
1447 # define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1449 #define SvTAINTED_on(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_taint(sv);} }STMT_END
1450 #define SvTAINTED_off(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_untaint(sv);} }STMT_END
1452 #define SvTAINT(sv) \
1454 assert(TAINTING_get || !TAINT_get); \
1455 if (UNLIKELY(TAINT_get)) \
1460 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1461 Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1462 only a string (C<SvPOK_only>), by hook or by crook. You need force if you are
1463 going to update the C<SvPVX> directly. Processes get magic.
1465 Note that coercing an arbitrary scalar into a plain PV will potentially
1466 strip useful data from it. For example if the SV was C<SvROK>, then the
1467 referent will have its reference count decremented, and the SV itself may
1468 be converted to an C<SvPOK> scalar with a string buffer containing a value
1469 such as C<"ARRAY(0x1234)">.
1471 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1472 Like C<SvPV_force>, but doesn't process get magic.
1474 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1475 Returns a pointer to the string in the SV, or a stringified form of
1476 the SV if the SV does not contain a string. The SV may cache the
1477 stringified version becoming C<SvPOK>. Handles 'get' magic. The
1478 C<len> variable will be set to the length of the string (this is a macro, so
1479 don't use C<&len>). See also C<L</SvPVx>> for a version which guarantees to
1480 evaluate C<sv> only once.
1482 Note that there is no guarantee that the return value of C<SvPV()> is
1483 equal to C<SvPVX(sv)>, or that C<SvPVX(sv)> contains valid data, or that
1484 successive calls to C<SvPV(sv)> will return the same pointer value each
1485 time. This is due to the way that things like overloading and
1486 Copy-On-Write are handled. In these cases, the return value may point to
1487 a temporary buffer or similar. If you absolutely need the C<SvPVX> field to
1488 be valid (for example, if you intend to write to it), then see
1491 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1492 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1493 Only use this if C<sv> is an expression with side effects, otherwise use the
1494 more efficient C<SvPV>.
1496 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1497 Like C<SvPV> but doesn't process magic.
1499 =for apidoc Am|char*|SvPV_nolen|SV* sv
1500 Like C<SvPV> but doesn't set a length variable.
1502 =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1503 Like C<SvPV_nolen> but doesn't process magic.
1505 =for apidoc Am|IV|SvIV|SV* sv
1506 Coerces the given SV to an integer and returns it. See C<L</SvIVx>> for a
1507 version which guarantees to evaluate C<sv> only once.
1509 =for apidoc Am|IV|SvIV_nomg|SV* sv
1510 Like C<SvIV> but doesn't process magic.
1512 =for apidoc Am|IV|SvIVx|SV* sv
1513 Coerces the given SV to an integer and returns it.
1514 Guarantees to evaluate C<sv> only once. Only use
1515 this if C<sv> is an expression with side effects,
1516 otherwise use the more efficient C<SvIV>.
1518 =for apidoc Am|NV|SvNV|SV* sv
1519 Coerce the given SV to a double and return it. See C<L</SvNVx>> for a version
1520 which guarantees to evaluate C<sv> only once.
1522 =for apidoc Am|NV|SvNV_nomg|SV* sv
1523 Like C<SvNV> but doesn't process magic.
1525 =for apidoc Am|NV|SvNVx|SV* sv
1526 Coerces the given SV to a double and returns it.
1527 Guarantees to evaluate C<sv> only once. Only use
1528 this if C<sv> is an expression with side effects,
1529 otherwise use the more efficient C<SvNV>.
1531 =for apidoc Am|UV|SvUV|SV* sv
1532 Coerces the given SV to an unsigned integer and returns it. See C<L</SvUVx>>
1533 for a version which guarantees to evaluate C<sv> only once.
1535 =for apidoc Am|UV|SvUV_nomg|SV* sv
1536 Like C<SvUV> but doesn't process magic.
1538 =for apidoc Am|UV|SvUVx|SV* sv
1539 Coerces the given SV to an unsigned integer and
1540 returns it. Guarantees to evaluate C<sv> only once. Only
1541 use this if C<sv> is an expression with side effects,
1542 otherwise use the more efficient C<SvUV>.
1544 =for apidoc Am|bool|SvTRUE|SV* sv
1545 Returns a boolean indicating whether Perl would evaluate the SV as true or
1546 false. See C<L</SvOK>> for a defined/undefined test. Handles 'get' magic
1547 unless the scalar is already C<SvPOK>, C<SvIOK> or C<SvNOK> (the public, not the
1550 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
1551 Returns a boolean indicating whether Perl would evaluate the SV as true or
1552 false. See C<L</SvOK>> for a defined/undefined test. Does not handle 'get' magic.
1554 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1555 Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
1557 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1558 Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
1560 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1561 Like C<SvPV_nolen>, but converts C<sv> to UTF-8 first if necessary.
1563 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1564 Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary.
1566 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1567 Like C<SvPV>, but converts C<sv> to byte representation first if necessary.
1569 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1570 Like C<SvPV_nolen>, but converts C<sv> to byte representation first if necessary.
1572 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1573 Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
1574 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8_force>
1577 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1578 Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
1579 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8>
1582 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1583 Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary.
1584 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte_force>
1587 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1588 Like C<SvPV>, but converts C<sv> to byte representation first if necessary.
1589 Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte>
1592 =for apidoc Am|U32|SvIsCOW|SV* sv
1593 Returns a U32 value indicating whether the SV is Copy-On-Write (either shared
1594 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1597 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1598 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1601 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1602 Like C<sv_catpvn> but doesn't process magic.
1604 =for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1605 Like C<sv_catpv> but doesn't process magic.
1607 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1608 Like C<sv_setsv> but doesn't process magic.
1610 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1611 Like C<sv_catsv> but doesn't process magic.
1613 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1615 Like C<sv_utf8_upgrade>, but doesn't do magic on C<sv>.
1620 /* Let us hope that bitmaps for UV and IV are the same */
1621 #define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1622 #define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1623 #define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
1625 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1626 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1627 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1631 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1632 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1633 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1635 #define SvPV_flags(sv, lp, flags) \
1637 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1638 #define SvPV_flags_const(sv, lp, flags) \
1640 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1641 (const char*) sv_2pv_flags(sv, &lp, (flags|SV_CONST_RETURN)))
1642 #define SvPV_flags_const_nolen(sv, flags) \
1644 ? SvPVX_const(sv) : \
1645 (const char*) sv_2pv_flags(sv, 0, (flags|SV_CONST_RETURN)))
1646 #define SvPV_flags_mutable(sv, lp, flags) \
1648 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1649 sv_2pv_flags(sv, &lp, (flags|SV_MUTABLE_RETURN)))
1651 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1652 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1653 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1655 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1656 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1658 #define SvPV_force_flags(sv, lp, flags) \
1659 (SvPOK_pure_nogthink(sv) \
1660 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1662 #define SvPV_force_flags_nolen(sv, flags) \
1663 (SvPOK_pure_nogthink(sv) \
1664 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1666 #define SvPV_force_flags_mutable(sv, lp, flags) \
1667 (SvPOK_pure_nogthink(sv) \
1668 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1669 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1671 #define SvPV_nolen(sv) \
1673 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1675 /* "_nomg" in these defines means no mg_get() */
1676 #define SvPV_nomg_nolen(sv) \
1678 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1680 #define SvPV_nolen_const(sv) \
1682 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1684 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1685 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1686 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1690 #define SvPVutf8(sv, lp) \
1691 (SvPOK_utf8_nog(sv) \
1692 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1694 #define SvPVutf8_force(sv, lp) \
1695 (SvPOK_utf8_pure_nogthink(sv) \
1696 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1698 #define SvPVutf8_nolen(sv) \
1699 (SvPOK_utf8_nog(sv) \
1700 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1704 #define SvPVbyte(sv, lp) \
1705 (SvPOK_byte_nog(sv) \
1706 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1708 #define SvPVbyte_force(sv, lp) \
1709 (SvPOK_byte_pure_nogthink(sv) \
1710 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1712 #define SvPVbyte_nolen(sv) \
1713 (SvPOK_byte_nog(sv) \
1714 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1717 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1718 * var to evaluate the arg once; failing that, use a global if possible;
1719 * failing that, call a function to do the work
1722 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1723 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1724 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1726 #define SvTRUE(sv) (LIKELY(sv) && (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))))
1727 #define SvTRUE_nomg(sv) (LIKELY(sv) && ( SvTRUE_common(sv, sv_2bool_nomg(sv))))
1728 #define SvTRUE_NN(sv) (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv)))
1729 #define SvTRUE_nomg_NN(sv) ( SvTRUE_common(sv, sv_2bool_nomg(sv)))
1730 #define SvTRUE_common(sv,fallback) ( \
1735 : (SvFLAGS(sv) & (SVf_IOK|SVf_NOK)) \
1736 ? ( (SvIOK(sv) && SvIVX(sv) != 0) \
1737 || (SvNOK(sv) && SvNVX(sv) != 0.0)) \
1740 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1742 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1743 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1744 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1745 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1746 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1747 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1748 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1749 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1750 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1751 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1752 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1753 # define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
1755 #else /* __GNUC__ */
1757 /* These inlined macros use globals, which will require a thread
1758 * declaration in user code, so we avoid them under threads */
1760 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1761 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1762 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1763 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1764 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1765 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1766 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1767 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1768 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1769 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1770 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1771 # define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
1772 #endif /* __GNU__ */
1774 #define SvPVXtrue(sv) ( \
1775 ((XPV*)SvANY((sv))) \
1777 ((XPV*)SvANY((sv)))->xpv_cur > 1 \
1779 ((XPV*)SvANY((sv)))->xpv_cur \
1780 && *(sv)->sv_u.svu_pv != '0' \
1785 #define SvIsCOW(sv) (SvFLAGS(sv) & SVf_IsCOW)
1786 #define SvIsCOW_on(sv) (SvFLAGS(sv) |= SVf_IsCOW)
1787 #define SvIsCOW_off(sv) (SvFLAGS(sv) &= ~SVf_IsCOW)
1788 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1790 #define SvSHARED_HEK_FROM_PV(pvx) \
1791 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1792 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1794 /* flag values for sv_*_flags functions */
1795 #define SV_IMMEDIATE_UNREF 1
1797 #define SV_COW_DROP_PV 4
1798 #define SV_UTF8_NO_ENCODING 8
1799 #define SV_NOSTEAL 16
1800 #define SV_CONST_RETURN 32
1801 #define SV_MUTABLE_RETURN 64
1802 #define SV_SMAGIC 128
1803 #define SV_HAS_TRAILING_NUL 256
1804 #define SV_COW_SHARED_HASH_KEYS 512
1805 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1806 /* XXX This flag actually enabled for any COW. But it appears not to do
1807 anything. Can we just remove it? Or will it serve some future
1809 #define SV_COW_OTHER_PVS 1024
1810 /* Make sv_2pv_flags return NULL if something is undefined. */
1811 #define SV_UNDEF_RETURNS_NULL 2048
1812 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1813 * This is used when the caller has already determined it is, and avoids
1815 #define SV_FORCE_UTF8_UPGRADE 4096
1816 /* if (after resolving magic etc), the SV is found to be overloaded,
1817 * don't call the overload magic, just return as-is */
1818 #define SV_SKIP_OVERLOAD 8192
1819 #define SV_CATBYTES 16384
1820 #define SV_CATUTF8 32768
1822 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1823 So only default to doing the COW setup if we're in the core.
1826 # ifndef SV_DO_COW_SVSETSV
1827 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1831 #ifndef SV_DO_COW_SVSETSV
1832 # define SV_DO_COW_SVSETSV 0
1836 #define sv_unref(sv) sv_unref_flags(sv, 0)
1837 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1838 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1839 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1841 /* We are about to replace the SV's current value. So if it's copy on write
1842 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1843 the value is about to get thrown away, so drop the PV rather than go to
1844 the effort of making a read-write copy only for it to get immediately
1847 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1848 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1850 #ifdef PERL_COPY_ON_WRITE
1851 # define SvCANCOW(sv) \
1853 ? SvLEN(sv) ? CowREFCNT(sv) != SV_COW_REFCNT_MAX : 1 \
1854 : (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS \
1855 && SvCUR(sv)+1 < SvLEN(sv))
1856 /* Note: To allow 256 COW "copies", a refcnt of 0 means 1. */
1857 # define CowREFCNT(sv) (*(U8 *)(SvPVX(sv)+SvLEN(sv)-1))
1858 # define SV_COW_REFCNT_MAX ((1 << sizeof(U8)*8) - 1)
1859 # define CAN_COW_MASK (SVf_POK|SVf_ROK|SVp_POK|SVf_FAKE| \
1860 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_PROTECT)
1863 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1865 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1866 sv_force_normal_flags(sv, 0)
1869 /* all these 'functions' are now just macros */
1871 #define sv_pv(sv) SvPV_nolen(sv)
1872 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1873 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1875 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1876 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1877 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1878 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1879 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
1880 #define sv_setsv(dsv, ssv) \
1881 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1882 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1883 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1884 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1885 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1886 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1887 #define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1888 #define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
1889 #define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
1890 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1891 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1892 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1893 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1894 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1895 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1896 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1897 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1898 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1899 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1900 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1901 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1902 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
1903 #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
1904 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
1905 #define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
1906 #define sv_insert(bigstr, offset, len, little, littlelen) \
1907 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1908 (littlelen), SV_GMAGIC)
1909 #define sv_mortalcopy(sv) \
1910 Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1911 #define sv_cathek(sv,hek) \
1913 HEK * const bmxk = hek; \
1914 sv_catpvn_flags(sv, HEK_KEY(bmxk), HEK_LEN(bmxk), \
1915 HEK_UTF8(bmxk) ? SV_CATUTF8 : SV_CATBYTES); \
1918 /* Should be named SvCatPVN_utf8_upgrade? */
1919 #define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
1922 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
1924 sv_setpvn(nsv, sstr, slen); \
1926 sv_utf8_upgrade(nsv); \
1927 sv_catsv_nomg(dsv, nsv); \
1929 #define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \
1930 sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES)
1932 #if defined(PERL_CORE) || defined(PERL_EXT)
1933 # define sv_or_pv_len_utf8(sv, pv, bytelen) \
1935 ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \
1940 =for apidoc Am|SV*|newRV_inc|SV* sv
1942 Creates an RV wrapper for an SV. The reference count for the original SV is
1948 #define newRV_inc(sv) newRV(sv)
1950 /* the following macros update any magic values this C<sv> is associated with */
1953 =head1 Magical Functions
1955 =for apidoc Am|void|SvGETMAGIC|SV* sv
1956 Invokes C<mg_get> on an SV if it has 'get' magic. For example, this
1957 will call C<FETCH> on a tied variable. This macro evaluates its
1958 argument more than once.
1960 =for apidoc Am|void|SvSETMAGIC|SV* sv
1961 Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary
1962 after modifying a scalar, in case it is a magical variable like C<$|>
1963 or a tied variable (it calls C<STORE>). This macro evaluates its
1964 argument more than once.
1966 =for apidoc Am|void|SvSetSV|SV* dsv|SV* ssv
1967 Calls C<sv_setsv> if C<dsv> is not the same as C<ssv>. May evaluate arguments
1968 more than once. Does not handle 'set' magic on the destination SV.
1970 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1971 Calls a non-destructive version of C<sv_setsv> if C<dsv> is not the same as
1972 C<ssv>. May evaluate arguments more than once.
1974 =for apidoc Am|void|SvSetMagicSV|SV* dsv|SV* ssv
1975 Like C<SvSetSV>, but does any set magic required afterwards.
1977 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1978 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1980 =for apidoc Am|void|SvSHARE|SV* sv
1981 Arranges for C<sv> to be shared between threads if a suitable module
1984 =for apidoc Am|void|SvLOCK|SV* sv
1985 Arranges for a mutual exclusion lock to be obtained on C<sv> if a suitable module
1988 =for apidoc Am|void|SvUNLOCK|SV* sv
1989 Releases a mutual exclusion lock on C<sv> if a suitable module
1992 =head1 SV Manipulation Functions
1994 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1995 Expands the character buffer in the SV so that it has room for the
1996 indicated number of bytes (remember to reserve space for an extra trailing
1997 C<NUL> character). Calls C<sv_grow> to perform the expansion if necessary.
1998 Returns a pointer to the character
1999 buffer. SV must be of type >= C<SVt_PV>. One
2000 alternative is to call C<sv_grow> if you are not sure of the type of SV.
2002 =for apidoc Am|char *|SvPVCLEAR|SV* sv
2003 Ensures that sv is a SVt_PV and that its SvCUR is 0, and that it is
2004 properly null terminated. Equivalent to sv_setpvs(""), but more efficient.
2009 #define SvPVCLEAR(sv) sv_setpv_bufsize(sv,0,0)
2010 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
2011 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
2012 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
2013 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
2015 #define SvGETMAGIC(x) ((void)(UNLIKELY(SvGMAGICAL(x)) && mg_get(x)))
2016 #define SvSETMAGIC(x) STMT_START { if (UNLIKELY(SvSMAGICAL(x))) mg_set(x); } STMT_END
2018 #define SvSetSV_and(dst,src,finally) \
2020 if (LIKELY((dst) != (src))) { \
2021 sv_setsv(dst, src); \
2025 #define SvSetSV_nosteal_and(dst,src,finally) \
2027 if (LIKELY((dst) != (src))) { \
2028 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
2033 #define SvSetSV(dst,src) \
2034 SvSetSV_and(dst,src,/*nothing*/;)
2035 #define SvSetSV_nosteal(dst,src) \
2036 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
2038 #define SvSetMagicSV(dst,src) \
2039 SvSetSV_and(dst,src,SvSETMAGIC(dst))
2040 #define SvSetMagicSV_nosteal(dst,src) \
2041 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
2044 #if !defined(SKIP_DEBUGGING)
2045 #define SvPEEK(sv) sv_peek(sv)
2047 #define SvPEEK(sv) ""
2050 #define SvIMMORTAL(sv) (SvREADONLY(sv) && ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder))
2053 /* exercise the immortal resurrection code in sv_free2() */
2054 # define SvREFCNT_IMMORTAL 1000
2056 # define SvREFCNT_IMMORTAL ((~(U32)0)/2)
2060 =for apidoc Am|SV *|boolSV|bool b
2062 Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
2064 See also C<L</PL_sv_yes>> and C<L</PL_sv_no>>.
2069 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2071 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2072 /* If I give every macro argument a different name, then there won't be bugs
2073 where nested macros get confused. Been there, done that. */
2074 #define isGV_with_GP(pwadak) \
2075 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
2076 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2077 #define isGV_with_GP_on(sv) STMT_START { \
2078 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2079 assert (!SvPOKp(sv)); \
2080 assert (!SvIOKp(sv)); \
2081 (SvFLAGS(sv) |= SVpgv_GP); \
2083 #define isGV_with_GP_off(sv) STMT_START { \
2084 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2085 assert (!SvPOKp(sv)); \
2086 assert (!SvIOKp(sv)); \
2087 (SvFLAGS(sv) &= ~SVpgv_GP); \
2089 #define isREGEXP(sv) \
2090 (SvTYPE(sv) == SVt_REGEXP \
2091 || (SvFLAGS(sv) & (SVTYPEMASK|SVp_POK|SVpgv_GP|SVf_FAKE)) \
2092 == (SVt_PVLV|SVf_FAKE))
2096 # define SvGROW(sv,len) \
2097 (SvIsCOW(sv) || SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2099 # define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2101 #define SvGROW_mutable(sv,len) \
2102 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2103 #define Sv_Grow sv_grow
2105 #define CLONEf_COPY_STACKS 1
2106 #define CLONEf_KEEP_PTR_TABLE 2
2107 #define CLONEf_CLONE_HOST 4
2108 #define CLONEf_JOIN_IN 8
2110 struct clone_params {
2113 PerlInterpreter *proto_perl;
2114 PerlInterpreter *new_perl;
2119 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2121 Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
2122 characters) into it. If C<utf8> is true, calls
2123 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2128 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2131 =for apidoc Amx|SV*|newSVpadname|PADNAME *pn
2133 Creates a new SV containing the pad name.
2138 #define newSVpadname(pn) newSVpvn_utf8(PadnamePV(pn), PadnameLEN(pn), TRUE)
2141 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2143 Reads into C<len> the offset from C<SvPVX> back to the true start of the
2144 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2145 efficiently remove characters from start of the buffer. Implemented as a
2146 macro, which takes the address of C<len>, which must be of type C<STRLEN>.
2147 Evaluates C<sv> more than once. Sets C<len> to 0 if C<SvOOK(sv)> is false.
2153 /* Does the bot know something I don't?
2154 10:28 <@Nicholas> metabatman
2155 10:28 <+meta> Nicholas: crash
2157 # define SvOOK_offset(sv, offset) STMT_START { \
2158 assert(sizeof(offset) == sizeof(STRLEN)); \
2160 const U8 *_crash = (U8*)SvPVX_const(sv); \
2161 (offset) = *--_crash; \
2163 _crash -= sizeof(STRLEN); \
2164 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
2167 /* Validate the preceding buffer's sentinels to \
2168 verify that no-one is using it. */ \
2169 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2170 while (_crash > _bonk) { \
2172 assert (*_crash == (U8)PTR2UV(_crash)); \
2180 /* This is the same code, but avoids using any temporary variables: */
2181 # define SvOOK_offset(sv, offset) STMT_START { \
2182 assert(sizeof(offset) == sizeof(STRLEN)); \
2184 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2186 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2187 (U8*)&(offset), sizeof(STRLEN), U8); \
2195 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2197 #define SV_CONST(name) \
2198 PL_sv_consts[SV_CONST_##name] \
2199 ? PL_sv_consts[SV_CONST_##name] \
2200 : (PL_sv_consts[SV_CONST_##name] = newSVpv_share(#name, 0))
2202 #define SV_CONST_TIESCALAR 0
2203 #define SV_CONST_TIEARRAY 1
2204 #define SV_CONST_TIEHASH 2
2205 #define SV_CONST_TIEHANDLE 3
2207 #define SV_CONST_FETCH 4
2208 #define SV_CONST_FETCHSIZE 5
2209 #define SV_CONST_STORE 6
2210 #define SV_CONST_STORESIZE 7
2211 #define SV_CONST_EXISTS 8
2213 #define SV_CONST_PUSH 9
2214 #define SV_CONST_POP 10
2215 #define SV_CONST_SHIFT 11
2216 #define SV_CONST_UNSHIFT 12
2217 #define SV_CONST_SPLICE 13
2218 #define SV_CONST_EXTEND 14
2220 #define SV_CONST_FIRSTKEY 15
2221 #define SV_CONST_NEXTKEY 16
2222 #define SV_CONST_SCALAR 17
2224 #define SV_CONST_OPEN 18
2225 #define SV_CONST_WRITE 19
2226 #define SV_CONST_PRINT 20
2227 #define SV_CONST_PRINTF 21
2228 #define SV_CONST_READ 22
2229 #define SV_CONST_READLINE 23
2230 #define SV_CONST_GETC 24
2231 #define SV_CONST_SEEK 25
2232 #define SV_CONST_TELL 26
2233 #define SV_CONST_EOF 27
2234 #define SV_CONST_BINMODE 28
2235 #define SV_CONST_FILENO 29
2236 #define SV_CONST_CLOSE 30
2238 #define SV_CONST_DELETE 31
2239 #define SV_CONST_CLEAR 32
2240 #define SV_CONST_UNTIE 33
2241 #define SV_CONST_DESTROY 34
2243 #define SV_CONSTS_COUNT 35
2246 * Bodyless IVs and NVs!
2248 * Since 5.9.2, we can avoid allocating a body for SVt_IV-type SVs.
2249 * Since the larger IV-holding variants of SVs store their integer
2250 * values in their respective bodies, the family of SvIV() accessor
2251 * macros would naively have to branch on the SV type to find the
2252 * integer value either in the HEAD or BODY. In order to avoid this
2253 * expensive branch, a clever soul has deployed a great hack:
2254 * We set up the SvANY pointer such that instead of pointing to a
2255 * real body, it points into the memory before the location of the
2256 * head. We compute this pointer such that the location of
2257 * the integer member of the hypothetical body struct happens to
2258 * be the same as the location of the integer member of the bodyless
2259 * SV head. This now means that the SvIV() family of accessors can
2260 * always read from the (hypothetical or real) body via SvANY.
2262 * Since the 5.21 dev series, we employ the same trick for NVs
2263 * if the architecture can support it (NVSIZE <= IVSIZE).
2266 /* The following two macros compute the necessary offsets for the above
2267 * trick and store them in SvANY for SvIV() (and friends) to use. */
2270 # define SET_SVANY_FOR_BODYLESS_IV(sv) \
2271 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) \
2272 - STRUCT_OFFSET(XPVIV, xiv_iv))
2274 # define SET_SVANY_FOR_BODYLESS_NV(sv) \
2275 SvANY(sv) = (XPVNV*)((char*)&(sv->sv_u.svu_nv) \
2276 - STRUCT_OFFSET(XPVNV, xnv_u.xnv_nv))
2280 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob