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 B<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 SVt_PVIO is for I/O objects, SVt_PVFM for formats, SVt_PVCV for
45 subroutines, SVt_PVHV for hashes and 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 SVt_PVGV represents a typeglob. If !SvFAKE(sv), then it is a real,
55 incoercible typeglob. If 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. 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. SVt_REGEXP is for regular expressions.
62 SVt_PVMG represents a "normal" scalar (not a typeglob, regular expression,
63 or delegate). Since most scalars do not need all the internal fields of a
64 PVMG, we save memory by allocating smaller structs when possible. All the
65 other types are just simpler forms of SVt_PVMG, with fewer internal fields.
66 SVt_NULL can only hold undef. SVt_IV can hold undef, an integer, or a
67 reference. (SVt_RV is an alias for SVt_IV, which exists for backward
68 compatibility.) SVt_NV can hold any of those or a double. SVt_PV can only
69 hold undef or a string. SVt_PVIV is a superset of SVt_PV and SVt_IV.
70 SVt_PVNV is similar. SVt_PVMG can hold anything SVt_PVNV can hold, but it
71 can, but does not have to, be blessed or magical.
73 =for apidoc AmU||SVt_NULL
74 Type flag for scalars. See L</svtype>.
76 =for apidoc AmU||SVt_IV
77 Type flag for scalars. See L</svtype>.
79 =for apidoc AmU||SVt_NV
80 Type flag for scalars. See L</svtype>.
82 =for apidoc AmU||SVt_PV
83 Type flag for scalars. See L</svtype>.
85 =for apidoc AmU||SVt_PVIV
86 Type flag for scalars. See L</svtype>.
88 =for apidoc AmU||SVt_PVNV
89 Type flag for scalars. See L</svtype>.
91 =for apidoc AmU||SVt_PVMG
92 Type flag for scalars. See L</svtype>.
94 =for apidoc AmU||SVt_REGEXP
95 Type flag for regular expressions. See L</svtype>.
97 =for apidoc AmU||SVt_PVGV
98 Type flag for typeglobs. See L</svtype>.
100 =for apidoc AmU||SVt_PVLV
101 Type flag for scalars. See L</svtype>.
103 =for apidoc AmU||SVt_PVAV
104 Type flag for arrays. See L</svtype>.
106 =for apidoc AmU||SVt_PVHV
107 Type flag for hashes. See L</svtype>.
109 =for apidoc AmU||SVt_PVCV
110 Type flag for subroutines. See L</svtype>.
112 =for apidoc AmU||SVt_PVFM
113 Type flag for formats. See L</svtype>.
115 =for apidoc AmU||SVt_PVIO
116 Type flag for I/O objects. See L</svtype>.
126 /* RV was here, before it was merged with IV. */
132 /* PVBM was here, before BIND replaced it. */
140 SVt_LAST /* keep last in enum. used to size arrays */
143 /* *** any alterations to the SV types above need to be reflected in
144 * SVt_MASK and the various PL_valid_types_* tables */
146 #define SVt_MASK 0xf /* smallest bitmask that covers all types */
149 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
150 purposes eternal code wanting to consider PVBM probably needs to think of
152 # define SVt_PVBM SVt_PVMG
153 /* Anything wanting to create a reference from clean should ensure that it has
154 a scalar of type SVt_IV now: */
155 # define SVt_RV SVt_IV
158 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
159 so never reaches the clause at the end that uses sv_type_details->body_size
160 to determine whether to call safefree(). Hence body_size can be set
161 non-zero to record the size of HEs, without fear of bogus frees. */
162 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
163 #define HE_SVSLOT SVt_NULL
166 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
168 /* typedefs to eliminate some typing */
169 typedef struct he HE;
170 typedef struct hek HEK;
172 /* Using C's structural equivalence to help emulate C++ inheritance here... */
174 /* start with 2 sv-head building blocks */
175 #define _SV_HEAD(ptrtype) \
176 ptrtype sv_any; /* pointer to body */ \
177 U32 sv_refcnt; /* how many references to us */ \
178 U32 sv_flags /* what we are */
180 #define _SV_HEAD_UNION \
182 char* svu_pv; /* pointer to malloced string */ \
185 SV* svu_rv; /* pointer to another SV */ \
186 struct regexp* svu_rx; \
194 struct STRUCT_SV { /* struct sv { */
197 #ifdef DEBUG_LEAKING_SCALARS
198 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */
199 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */
200 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */
201 UV sv_debug_serial; /* serial number of sv allocation */
202 char * sv_debug_file; /* the file where we were allocated */
203 SV * sv_debug_parent; /* what we were cloned from (ithreads)*/
208 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
213 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
218 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
223 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
228 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
233 _SV_HEAD(struct regexp*); /* pointer to regexp body */
238 #undef _SV_HEAD_UNION /* ensure no pollution */
241 =head1 SV Manipulation Functions
243 =for apidoc Am|U32|SvREFCNT|SV* sv
244 Returns the value of the object's reference count.
246 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
247 Increments the reference count of the given SV, returning the SV.
249 All of the following SvREFCNT_inc* macros are optimized versions of
250 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
252 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
253 Same as SvREFCNT_inc, but can only be used if you know I<sv>
254 is not NULL. Since we don't have to check the NULLness, it's faster
257 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
258 Same as SvREFCNT_inc, but can only be used if you don't need the
259 return value. The macro doesn't need to return a meaningful value.
261 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
262 Same as SvREFCNT_inc, but can only be used if you don't need the return
263 value, and you know that I<sv> is not NULL. The macro doesn't need
264 to return a meaningful value, or check for NULLness, so it's smaller
267 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
268 Same as SvREFCNT_inc, but can only be used with expressions without side
269 effects. Since we don't have to store a temporary value, it's faster.
271 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
272 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
273 is not NULL. Since we don't have to check the NULLness, it's faster
276 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
277 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
278 return value. The macro doesn't need to return a meaningful value.
280 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
281 Same as SvREFCNT_inc, but can only be used if you don't need the return
282 value, and you know that I<sv> is not NULL. The macro doesn't need
283 to return a meaningful value, or check for NULLness, so it's smaller
286 =for apidoc Am|void|SvREFCNT_dec|SV* sv
287 Decrements the reference count of the given SV. I<sv> may be NULL.
289 =for apidoc Am|void|SvREFCNT_dec_NN|SV* sv
290 Same as SvREFCNT_dec, but can only be used if you know I<sv>
291 is not NULL. Since we don't have to check the NULLness, it's faster
294 =for apidoc Am|svtype|SvTYPE|SV* sv
295 Returns the type of the SV. See C<svtype>.
297 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
298 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
299 perform the upgrade if necessary. See C<svtype>.
304 #define SvANY(sv) (sv)->sv_any
305 #define SvFLAGS(sv) (sv)->sv_flags
306 #define SvREFCNT(sv) (sv)->sv_refcnt
308 #define SvREFCNT_inc(sv) S_SvREFCNT_inc(MUTABLE_SV(sv))
309 #define SvREFCNT_inc_simple(sv) SvREFCNT_inc(sv)
310 #define SvREFCNT_inc_NN(sv) S_SvREFCNT_inc_NN(MUTABLE_SV(sv))
311 #define SvREFCNT_inc_void(sv) S_SvREFCNT_inc_void(MUTABLE_SV(sv))
313 /* These guys don't need the curly blocks */
314 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
315 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
316 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
317 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
319 #define SvREFCNT_dec(sv) S_SvREFCNT_dec(aTHX_ MUTABLE_SV(sv))
320 #define SvREFCNT_dec_NN(sv) S_SvREFCNT_dec_NN(aTHX_ MUTABLE_SV(sv))
322 #define SVTYPEMASK 0xff
323 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
325 /* Sadly there are some parts of the core that have pointers to already-freed
326 SV heads, and rely on being able to tell that they are now free. So mark
327 them all by using a consistent macro. */
328 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
330 /* this is defined in this peculiar way to avoid compiler warnings.
331 * See the <20121213131428.GD1842@iabyn.com> thread in p5p */
332 #define SvUPGRADE(sv, mt) \
333 ((void)(SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt),1)))
335 #define SVf_IOK 0x00000100 /* has valid public integer value */
336 #define SVf_NOK 0x00000200 /* has valid public numeric value */
337 #define SVf_POK 0x00000400 /* has valid public pointer value */
338 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
340 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
341 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
342 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
343 #define SVp_SCREAM 0x00008000 /* method name is DOES */
344 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
345 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
346 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
347 subroutine in another package. Set the
348 GvIMPORTED_CV_on() if it needs to be
349 expanded to a real GV */
350 #define SVf_IsCOW 0x00010000 /* copy on write (shared hash key if
352 #define SVs_PADTMP 0x00020000 /* in use as tmp; only if ! SVs_PADMY */
353 #define SVs_PADSTALE 0x00020000 /* lexical has gone out of scope;
354 only valid for SVs_PADMY */
355 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
356 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
357 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
358 #define SVs_TEMP 0x00080000 /* string is stealable? */
359 #define SVs_OBJECT 0x00100000 /* is "blessed" */
360 #define SVs_GMG 0x00200000 /* has magical get method */
361 #define SVs_SMG 0x00400000 /* has magical set method */
362 #define SVs_RMG 0x00800000 /* has random magical methods */
364 #define SVf_FAKE 0x01000000 /* 0: glob is just a copy
365 1: SV head arena wasn't malloc()ed
366 2: For PVCV, whether CvUNIQUE(cv)
367 refers to an eval or once only
368 [CvEVAL(cv), CvSPECIAL(cv)]
369 3: On a pad name SV, that slot in the
370 frame AV is a REFCNT'ed reference
371 to a lexical from "outside". */
372 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
373 means that a hv_aux struct is present
374 after the main array */
375 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
376 SVs in final arena cleanup.
377 Set in S_regtry on PL_reg_curpm, so that
378 perl_destruct will skip it. */
379 #define SVf_READONLY 0x08000000 /* may not be modified */
384 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE|SVs_RMG|SVf_IsCOW)
386 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
387 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
389 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
391 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
393 /* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
394 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
395 This is also set on RVs whose overloaded
396 stringification is UTF-8. This might
397 only happen as a side effect of SvPV() */
400 /* Some private flags. */
402 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
403 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
404 been restructured, so sometimes get used as string buffers. */
407 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
409 /* PVNV, PVMG only, and only used in pads. Should be safe to test on any scalar
410 SV, as the core is careful to avoid setting both.
412 SVf_POK, SVp_POK also set:
414 0x0000C400 method name for DOES (SvSCREAM)
415 0x40004400 FBM compiled (SvVALID)
418 0x00008000 GV with GP
419 0x00008800 RV with PCS imported
421 #define SVpad_NAME (SVp_SCREAM|SVpbm_VALID)
422 /* This SV is a name in the PAD, so
423 SVpad_TYPED, SVpad_OUR and SVpad_STATE
426 #define SVpav_REAL 0x40000000 /* free old entries */
428 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
429 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
430 on any regular scalar (anything <= PVLV) */
431 #define SVpbm_VALID 0x40000000
432 /* Only used in toke.c on an SV stored in PL_lex_repl */
433 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
435 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
436 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
438 #define SVpav_REIFY 0x80000000 /* can become real */
440 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
441 /* PVGV when SVpbm_VALID is true */
442 #define SVpbm_TAIL 0x80000000
443 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
444 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
445 /* pad name vars only */
446 #define SVpad_STATE 0x80000000 /* pad name is a "state" var */
449 HV* xmg_stash; /* class package */ \
451 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
453 STRLEN xpvlenu_len; /* allocated size */ \
454 char * xpvlenu_pv; /* regexp string */ \
457 #define xpv_len xpv_len_u.xpvlenu_len
460 NV xnv_nv; /* numeric value, if any */
465 } xpad_cop_seq; /* used by pad.c for cop_sequence */
468 U8 xbm_rare; /* rarest character in string */
469 } xbm_s; /* fields from PVBM */
473 IV xivu_iv; /* integer value */
475 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
479 MAGIC* xmg_magic; /* linked list of magicalness */
480 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
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. */
522 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
523 * y=alem/helem/iter t=tie T=tied HE */
524 char xlv_flags; /* 1 = negative offset 2 = negative len */
527 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
535 typedef U16 cv_flags_t;
537 #define _XPVCV_COMMON \
545 void (*xcv_xsub) (pTHX_ CV*); \
552 PADLIST * xcv_padlist; \
554 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
555 * compilation) in the lexically enclosing \
557 cv_flags_t xcv_flags; \
558 I32 xcv_depth /* >= 2 indicates recursive call */
560 /* This structure must match XPVCV in cv.h */
571 /* ifp and ofp are normally the same, but sockets need separate streams */
573 /* Cray addresses everything by word boundaries (64 bits) and
574 * code and data pointers cannot be mixed (which is exactly what
575 * Perl_filter_add() tries to do with the dirp), hence the
576 * following union trick (as suggested by Gurusamy Sarathy).
577 * For further information see Geir Johansen's problem report
578 * titled [ID 20000612.002] Perl problem on Cray system
579 * The any pointer (known as IoANY()) will also be a good place
580 * to hang any IO disciplines to.
583 DIR * xiou_dirp; /* for opendir, readdir, etc */
584 void * xiou_any; /* for alignment */
586 /* IV xio_lines is now in IVX $. */
587 IV xio_page; /* $% */
588 IV xio_page_len; /* $= */
589 IV xio_lines_left; /* $- */
590 char * xio_top_name; /* $^ */
591 GV * xio_top_gv; /* $^ */
592 char * xio_fmt_name; /* $~ */
593 GV * xio_fmt_gv; /* $~ */
594 char * xio_bottom_name;/* $^B */
595 GV * xio_bottom_gv; /* $^B */
600 #define xio_dirp xio_dirpu.xiou_dirp
601 #define xio_any xio_dirpu.xiou_any
603 #define IOf_ARGV 1 /* this fp iterates over ARGV */
604 #define IOf_START 2 /* check for null ARGV and substitute '-' */
605 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
606 #define IOf_DIDTOP 8 /* just did top of form */
607 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
608 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
609 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
610 Also, when this is set, SvPVX() is valid */
612 /* The following macros define implementation-independent predicates on SVs. */
615 =for apidoc Am|U32|SvNIOK|SV* sv
616 Returns a U32 value indicating whether the SV contains a number, integer or
619 =for apidoc Am|U32|SvNIOKp|SV* sv
620 Returns a U32 value indicating whether the SV contains a number, integer or
621 double. Checks the B<private> setting. Use C<SvNIOK> instead.
623 =for apidoc Am|void|SvNIOK_off|SV* sv
624 Unsets the NV/IV status of an SV.
626 =for apidoc Am|U32|SvOK|SV* sv
627 Returns a U32 value indicating whether the value is defined. This is
628 only meaningful for scalars.
630 =for apidoc Am|U32|SvIOKp|SV* sv
631 Returns a U32 value indicating whether the SV contains an integer. Checks
632 the B<private> setting. Use C<SvIOK> instead.
634 =for apidoc Am|U32|SvNOKp|SV* sv
635 Returns a U32 value indicating whether the SV contains a double. Checks the
636 B<private> setting. Use C<SvNOK> instead.
638 =for apidoc Am|U32|SvPOKp|SV* sv
639 Returns a U32 value indicating whether the SV contains a character string.
640 Checks the B<private> setting. Use C<SvPOK> instead.
642 =for apidoc Am|U32|SvIOK|SV* sv
643 Returns a U32 value indicating whether the SV contains an integer.
645 =for apidoc Am|void|SvIOK_on|SV* sv
646 Tells an SV that it is an integer.
648 =for apidoc Am|void|SvIOK_off|SV* sv
649 Unsets the IV status of an SV.
651 =for apidoc Am|void|SvIOK_only|SV* sv
652 Tells an SV that it is an integer and disables all other OK bits.
654 =for apidoc Am|void|SvIOK_only_UV|SV* sv
655 Tells an SV that it is an unsigned integer and disables all other OK bits.
657 =for apidoc Am|bool|SvIOK_UV|SV* sv
658 Returns a boolean indicating whether the SV contains an unsigned integer
659 that is too large to store as an IV.
661 =for apidoc Am|bool|SvUOK|SV* sv
662 Returns a boolean indicating whether the SV contains an unsigned integer
663 that is too large to store as an IV.
665 =for apidoc Am|bool|SvIOK_notUV|SV* sv
666 Returns a boolean indicating whether the SV contains a signed integer.
668 =for apidoc Am|U32|SvNOK|SV* sv
669 Returns a U32 value indicating whether the SV contains a double.
671 =for apidoc Am|void|SvNOK_on|SV* sv
672 Tells an SV that it is a double.
674 =for apidoc Am|void|SvNOK_off|SV* sv
675 Unsets the NV status of an SV.
677 =for apidoc Am|void|SvNOK_only|SV* sv
678 Tells an SV that it is a double and disables all other OK bits.
680 =for apidoc Am|U32|SvPOK|SV* sv
681 Returns a U32 value indicating whether the SV contains a character
684 =for apidoc Am|void|SvPOK_on|SV* sv
685 Tells an SV that it is a string.
687 =for apidoc Am|void|SvPOK_off|SV* sv
688 Unsets the PV status of an SV.
690 =for apidoc Am|void|SvPOK_only|SV* sv
691 Tells an SV that it is a string and disables all other OK bits.
692 Will also turn off the UTF-8 status.
694 =for apidoc Am|bool|SvVOK|SV* sv
695 Returns a boolean indicating whether the SV contains a v-string.
697 =for apidoc Am|U32|SvOOK|SV* sv
698 Returns a U32 indicating whether the pointer to the string buffer is offset.
699 This hack is used internally to speed up removal of characters from the
700 beginning of a SvPV. When SvOOK is true, then the start of the
701 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
702 This offset used to be stored in SvIVX, but is now stored within the spare
705 =for apidoc Am|U32|SvROK|SV* sv
706 Tests if the SV is an RV.
708 =for apidoc Am|void|SvROK_on|SV* sv
709 Tells an SV that it is an RV.
711 =for apidoc Am|void|SvROK_off|SV* sv
712 Unsets the RV status of an SV.
714 =for apidoc Am|SV*|SvRV|SV* sv
715 Dereferences an RV to return the SV.
717 =for apidoc Am|IV|SvIVX|SV* sv
718 Returns the raw value in the SV's IV slot, without checks or conversions.
719 Only use when you are sure SvIOK is true. See also C<SvIV()>.
721 =for apidoc Am|UV|SvUVX|SV* sv
722 Returns the raw value in the SV's UV slot, without checks or conversions.
723 Only use when you are sure SvIOK is true. See also C<SvUV()>.
725 =for apidoc Am|NV|SvNVX|SV* sv
726 Returns the raw value in the SV's NV slot, without checks or conversions.
727 Only use when you are sure SvNOK is true. See also C<SvNV()>.
729 =for apidoc Am|char*|SvPVX|SV* sv
730 Returns a pointer to the physical string in the SV. The SV must contain a
733 This is also used to store the name of an autoloaded subroutine in an XS
734 AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
736 =for apidoc Am|STRLEN|SvCUR|SV* sv
737 Returns the length of the string which is in the SV. See C<SvLEN>.
739 =for apidoc Am|STRLEN|SvLEN|SV* sv
740 Returns the size of the string buffer in the SV, not including any part
741 attributable to C<SvOOK>. See C<SvCUR>.
743 =for apidoc Am|char*|SvEND|SV* sv
744 Returns a pointer to the spot just after the last character in
745 the string which is in the SV, where there is usually a trailing
746 null (even though Perl scalars do not strictly require it).
747 See C<SvCUR>. Access the character as *(SvEND(sv)).
749 Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
752 =for apidoc Am|HV*|SvSTASH|SV* sv
753 Returns the stash of the SV.
755 =for apidoc Am|void|SvIV_set|SV* sv|IV val
756 Set the value of the IV pointer in sv to val. It is possible to perform
757 the same function of this macro with an lvalue assignment to C<SvIVX>.
758 With future Perls, however, it will be more efficient to use
759 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
761 =for apidoc Am|void|SvNV_set|SV* sv|NV val
762 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
764 =for apidoc Am|void|SvPV_set|SV* sv|char* val
765 Set the value of the PV pointer in sv to val. See also C<SvIV_set>.
767 Beware that the existing pointer may be involved in copy-on-write or other
768 mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or
769 C<SvPV_force> (or check the SvIsCOW flag) first to make sure this
770 modification is safe.
772 =for apidoc Am|void|SvUV_set|SV* sv|UV val
773 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
775 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
776 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
778 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
779 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
781 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
782 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
784 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
785 Set the current length of the string which is in the SV. See C<SvCUR>
788 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
789 Set the actual length of the string which is in the SV. See C<SvIV_set>.
794 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
795 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
796 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
797 SVp_IOK|SVp_NOK|SVf_IVisUV))
799 #define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv))
800 #define assert_not_glob(sv) assert_(!isGV_with_GP(sv))
802 #define SvOK(sv) ((SvTYPE(sv) == SVt_BIND) \
803 ? (SvFLAGS(SvRV(sv)) & SVf_OK \
804 || isREGEXP(SvRV(sv))) \
805 : (SvFLAGS(sv) & SVf_OK \
807 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
808 SvFLAGS(sv) &= ~(SVf_OK| \
809 SVf_IVisUV|SVf_UTF8), \
811 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
812 SvFLAGS(sv) &= ~(SVf_OK| \
816 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
817 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
818 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
819 SvFLAGS(sv) |= SVp_IOK)
820 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
821 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
822 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
823 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
824 SvFLAGS(sv) |= SVp_POK)
826 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
827 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
828 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
829 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
830 #define SvIOK_only(sv) (SvOK_off(sv), \
831 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
832 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
833 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
835 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
836 == (SVf_IOK|SVf_IVisUV))
837 #define SvUOK(sv) SvIOK_UV(sv)
838 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
841 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
842 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
843 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
845 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
846 #define SvNOK_on(sv) (assert_not_glob(sv) \
847 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
848 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
849 #define SvNOK_only(sv) (SvOK_off(sv), \
850 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
853 =for apidoc Am|U32|SvUTF8|SV* sv
854 Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
855 properly, this indicates whether or not the SV contains UTF-8 encoded data.
856 Call this after SvPV() in case any call to string overloading updates the
859 =for apidoc Am|void|SvUTF8_on|SV *sv
860 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
861 Do not use frivolously.
863 =for apidoc Am|void|SvUTF8_off|SV *sv
864 Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
865 Do not use frivolously.
867 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
868 Tells an SV that it is a string and disables all other OK bits,
869 and leaves the UTF-8 status as it was.
874 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
876 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
877 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
878 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
880 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
881 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
882 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
883 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
884 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
885 SvFLAGS(sv) &= ~(SVf_OK| \
886 SVf_IVisUV|SVf_UTF8), \
887 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
888 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
889 SvFLAGS(sv) &= ~(SVf_OK| \
891 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
893 #define SvVOK(sv) (SvMAGICAL(sv) \
894 && mg_find(sv,PERL_MAGIC_vstring))
895 /* returns the vstring magic, if any */
896 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
897 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
899 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
900 #define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
901 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
903 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
904 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
905 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
907 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
908 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
909 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
911 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
912 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
913 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
915 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
916 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
917 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
919 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
920 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
921 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
923 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
924 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
925 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
927 #define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
928 HvAMAGIC(SvSTASH(SvRV(sv))))
930 /* To be used on the stashes themselves: */
931 #define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
932 #define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
933 #define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
936 #define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
937 #define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
938 #define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
939 #define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
940 #define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
942 #define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
943 #define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
944 #define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
945 #define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
946 #define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
948 #define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
949 #define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
951 #define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
952 #define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
954 #define SvPOK_pure_nogthink(sv) \
955 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
956 #define SvPOK_utf8_pure_nogthink(sv) \
957 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
958 #define SvPOK_byte_pure_nogthink(sv) \
959 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
962 =for apidoc Am|U32|SvGAMAGIC|SV* sv
964 Returns true if the SV has get magic or
965 overloading. If either is true then
966 the scalar is active data, and has the potential to return a new value every
967 time it is accessed. Hence you must be careful to
968 only read it once per user logical operation and work
969 with that returned value. If neither is true then
970 the scalar's value cannot change unless written to.
975 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
977 #define Gv_AMG(stash) \
978 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
980 : (HvAMAGIC_off(stash), 0))
982 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
983 == (SVf_ROK|SVprv_WEAKREF))
984 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
985 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
987 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
988 == (SVf_ROK|SVprv_PCS_IMPORTED))
989 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
990 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
993 =for apidoc m|U32|SvTHINKFIRST|SV *sv
995 A quick flag check to see whether an sv should be passed to sv_force_normal
996 to be "downgraded" before SvIVX or SvPVX can be modified directly.
998 For example, if your scalar is a reference and you want to modify the SvIVX
999 slot, you can't just do SvROK_off, as that will leak the referent.
1001 This is used internally by various sv-modifying functions, such as
1002 sv_setsv, sv_setiv and sv_pvn_force.
1004 One case that this does not handle is a gv without SvFAKE set. After
1006 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
1008 it will still be a gv.
1010 SvTHINKFIRST sometimes produces false positives. In those cases
1011 sv_force_normal does nothing.
1016 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1018 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
1019 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
1021 /* SVs_PADTMP and SVs_PADSTALE share the same bit, mediated by SVs_PADMY */
1023 #define SvPADTMP(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP)) == SVs_PADTMP)
1024 #define SvPADSTALE(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADSTALE)) \
1025 == (SVs_PADMY|SVs_PADSTALE))
1027 #define SvPADTMP_on(sv) S_SvPADTMP_on(MUTABLE_SV(sv))
1028 #define SvPADTMP_off(sv) S_SvPADTMP_off(MUTABLE_SV(sv))
1029 #define SvPADSTALE_on(sv) S_SvPADSTALE_on(MUTABLE_SV(sv))
1030 #define SvPADSTALE_off(sv) S_SvPADSTALE_off(MUTABLE_SV(sv))
1032 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1033 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1034 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1036 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1037 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1038 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1040 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
1041 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1042 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1044 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1045 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1046 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1049 # define SvCOMPILED(sv) 0
1050 # define SvCOMPILED_on(sv)
1051 # define SvCOMPILED_off(sv)
1054 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1055 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1056 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1058 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1059 # define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
1060 if (SvFLAGS(_svvalid) & SVpbm_VALID) \
1061 assert(!isGV_with_GP(_svvalid)); \
1062 (SvFLAGS(_svvalid) & SVpbm_VALID); \
1064 # define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
1065 assert(!isGV_with_GP(_svvalid)); \
1066 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
1068 # define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
1069 assert(!isGV_with_GP(_svvalid)); \
1070 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
1073 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
1074 assert(SvTYPE(_svtail) != SVt_PVAV); \
1075 assert(SvTYPE(_svtail) != SVt_PVHV); \
1076 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1077 == (SVpbm_TAIL|SVpbm_VALID); \
1080 # define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
1081 # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1082 # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
1083 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1084 == (SVpbm_TAIL|SVpbm_VALID))
1087 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1088 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1091 #define SvPAD_TYPED(sv) \
1092 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1094 #define SvPAD_OUR(sv) \
1095 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1097 #define SvPAD_STATE(sv) \
1098 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1100 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1101 # define SvPAD_TYPED_on(sv) ({ \
1102 SV *const _svpad = MUTABLE_SV(sv); \
1103 assert(SvTYPE(_svpad) == SVt_PVMG); \
1104 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \
1106 #define SvPAD_OUR_on(sv) ({ \
1107 SV *const _svpad = MUTABLE_SV(sv); \
1108 assert(SvTYPE(_svpad) == SVt_PVMG); \
1109 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \
1111 #define SvPAD_STATE_on(sv) ({ \
1112 SV *const _svpad = MUTABLE_SV(sv); \
1113 assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
1114 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \
1117 # define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1118 # define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1119 # define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1122 #define SvOURSTASH(sv) \
1123 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1124 #define SvOURSTASH_set(sv, st) \
1126 assert(SvTYPE(sv) == SVt_PVMG); \
1127 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1130 #define SvRVx(sv) SvRV(sv)
1132 #ifdef PERL_DEBUG_COW
1133 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1134 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1135 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1136 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1137 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1138 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1139 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1140 /* Don't test the core XS code yet. */
1141 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1142 # define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
1144 # define SvPVX(sv) SvPVX_mutable(sv)
1146 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1147 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1148 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1150 # define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1151 # define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
1153 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1154 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1156 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1157 /* These get expanded inside other macros that already use a variable _sv */
1158 # define SvPVX(sv) \
1159 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1160 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
1161 assert(!isGV_with_GP(_svpvx)); \
1162 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1163 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
1164 &((_svpvx)->sv_u.svu_pv); \
1166 # define SvCUR(sv) \
1167 (*({ const SV *const _svcur = (const SV *)(sv); \
1168 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK] \
1169 || SvTYPE(_svcur) == SVt_REGEXP); \
1170 assert(!isGV_with_GP(_svcur)); \
1171 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1172 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1173 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1175 # define SvIVX(sv) \
1176 (*({ const SV *const _svivx = (const SV *)(sv); \
1177 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
1178 assert(!isGV_with_GP(_svivx)); \
1179 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1181 # define SvUVX(sv) \
1182 (*({ const SV *const _svuvx = (const SV *)(sv); \
1183 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
1184 assert(!isGV_with_GP(_svuvx)); \
1185 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1187 # define SvNVX(sv) \
1188 (*({ const SV *const _svnvx = (const SV *)(sv); \
1189 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
1190 assert(!isGV_with_GP(_svnvx)); \
1191 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1194 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1195 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1196 assert(!isGV_with_GP(_svrv)); \
1197 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1198 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1199 &((_svrv)->sv_u.svu_rv); \
1201 # define SvRV_const(sv) \
1202 ({ const SV *const _svrv = (const SV *)(sv); \
1203 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1204 assert(!isGV_with_GP(_svrv)); \
1205 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1206 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1207 (_svrv)->sv_u.svu_rv; \
1209 # define SvMAGIC(sv) \
1210 (*({ const SV *const _svmagic = (const SV *)(sv); \
1211 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1212 if(SvTYPE(_svmagic) == SVt_PVMG) \
1213 assert(!SvPAD_OUR(_svmagic)); \
1214 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1216 # define SvSTASH(sv) \
1217 (*({ const SV *const _svstash = (const SV *)(sv); \
1218 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1219 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1222 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1223 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1224 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1225 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1226 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1227 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1228 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1229 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1230 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1235 /* Given that these two are new, there can't be any existing code using them
1237 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1238 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1240 /* Except for the poison code, which uses & to scribble over the pointer after
1241 free() is called. */
1242 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1243 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1246 #define SvIVXx(sv) SvIVX(sv)
1247 #define SvUVXx(sv) SvUVX(sv)
1248 #define SvNVXx(sv) SvNVX(sv)
1249 #define SvPVXx(sv) SvPVX(sv)
1250 #define SvLENx(sv) SvLEN(sv)
1251 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1254 /* Ask a scalar nicely to try to become an IV, if possible.
1255 Not guaranteed to stay returning void */
1256 /* Macro won't actually call sv_2iv if already IOK */
1257 #define SvIV_please(sv) \
1258 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1259 (void) SvIV(sv); } STMT_END
1260 #define SvIV_please_nomg(sv) \
1261 (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv)) \
1262 ? (SvIV_nomg(sv), SvIOK(sv)) \
1264 #define SvIV_set(sv, val) \
1266 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1267 assert(!isGV_with_GP(sv)); \
1268 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1269 #define SvNV_set(sv, val) \
1271 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
1272 assert(!isGV_with_GP(sv)); \
1273 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1274 #define SvPV_set(sv, val) \
1276 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1277 assert(!isGV_with_GP(sv)); \
1278 assert(!(SvTYPE(sv) == SVt_PVIO \
1279 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1280 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1281 #define SvUV_set(sv, val) \
1283 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1284 assert(!isGV_with_GP(sv)); \
1285 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1286 #define SvRV_set(sv, val) \
1288 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
1289 assert(!isGV_with_GP(sv)); \
1290 assert(!(SvTYPE(sv) == SVt_PVIO \
1291 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1292 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1293 #define SvMAGIC_set(sv, val) \
1294 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1295 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1296 #define SvSTASH_set(sv, val) \
1297 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1298 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1299 #define SvCUR_set(sv, val) \
1301 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK] \
1302 || SvTYPE(sv) == SVt_REGEXP); \
1303 assert(!isGV_with_GP(sv)); \
1304 assert(!(SvTYPE(sv) == SVt_PVIO \
1305 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1306 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1307 #define SvLEN_set(sv, val) \
1309 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1310 assert(!isGV_with_GP(sv)); \
1311 assert(!(SvTYPE(sv) == SVt_PVIO \
1312 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1313 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1314 #define SvEND_set(sv, val) \
1315 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1316 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1318 #define SvPV_renew(sv,n) \
1319 STMT_START { SvLEN_set(sv, n); \
1320 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1321 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1322 (MEM_SIZE)((n))))); \
1325 #define SvPV_shrink_to_cur(sv) STMT_START { \
1326 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1327 SvPV_renew(sv, _lEnGtH); \
1330 #define SvPV_free(sv) \
1332 assert(SvTYPE(sv) >= SVt_PV); \
1334 assert(!SvROK(sv)); \
1337 SvOOK_offset(sv, zok); \
1338 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1339 SvFLAGS(sv) &= ~SVf_OOK; \
1341 Safefree(SvPVX(sv)); \
1346 /* Code that crops up in three places to take a scalar and ready it to hold
1348 # define prepare_SV_for_RV(sv) \
1350 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1351 sv_upgrade(sv, SVt_IV); \
1352 else if (SvTYPE(sv) >= SVt_PV) { \
1361 # define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1364 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1365 # define BmRARE(sv) \
1366 (*({ SV *const _bmrare = MUTABLE_SV(sv); \
1367 assert(SvTYPE(_bmrare) == SVt_PVMG); \
1368 assert(SvVALID(_bmrare)); \
1369 &(((XPVMG*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare); \
1371 # define BmUSEFUL(sv) \
1372 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1373 assert(SvTYPE(_bmuseful) == SVt_PVMG); \
1374 assert(SvVALID(_bmuseful)); \
1375 assert(!SvIOK(_bmuseful)); \
1376 &(((XPVMG*) SvANY(_bmuseful))->xnv_u.xbm_s.xbm_useful); \
1378 # define BmPREVIOUS(sv) \
1379 (*({ SV *const _bmprevious = MUTABLE_SV(sv); \
1380 assert(SvTYPE(_bmprevious) == SVt_PVMG); \
1381 assert(SvVALID(_bmprevious)); \
1382 &(((XPVMG*) SvANY(_bmprevious))->xiv_u.xivu_uv); \
1385 # define BmRARE(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1386 # define BmUSEFUL(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_useful
1387 # define BmPREVIOUS(sv) ((XPVMG*) SvANY(sv))->xiv_u.xivu_uv
1391 #define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1393 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1394 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1395 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1396 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1397 #define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
1399 #define IoIFP(sv) (sv)->sv_u.svu_fp
1400 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1401 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1402 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1403 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
1404 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1405 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1406 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1407 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1408 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1409 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1410 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1411 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1412 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1413 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1414 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1416 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1417 #define IoTYPE_RDONLY '<'
1418 #define IoTYPE_WRONLY '>'
1419 #define IoTYPE_RDWR '+'
1420 #define IoTYPE_APPEND 'a'
1421 #define IoTYPE_PIPE '|'
1422 #define IoTYPE_STD '-' /* stdin or stdout */
1423 #define IoTYPE_SOCKET 's'
1424 #define IoTYPE_CLOSED ' '
1425 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1426 #define IoTYPE_NUMERIC '#' /* fdopen */
1429 =for apidoc Am|bool|SvTAINTED|SV* sv
1430 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1433 =for apidoc Am|void|SvTAINTED_on|SV* sv
1434 Marks an SV as tainted if tainting is enabled.
1436 =for apidoc Am|void|SvTAINTED_off|SV* sv
1437 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1438 some of Perl's fundamental security features. XS module authors should not
1439 use this function unless they fully understand all the implications of
1440 unconditionally untainting the value. Untainting should be done in the
1441 standard perl fashion, via a carefully crafted regexp, rather than directly
1442 untainting variables.
1444 =for apidoc Am|void|SvTAINT|SV* sv
1445 Taints an SV if tainting is enabled, and if some input to the current
1446 expression is tainted--usually a variable, but possibly also implicit
1447 inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1448 the outputs of an expression in a pessimistic fashion; i.e., without paying
1449 attention to precisely which outputs are influenced by which inputs.
1454 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1456 #if NO_TAINT_SUPPORT
1457 # define SvTAINTED(sv) 0
1459 # define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1461 #define SvTAINTED_on(sv) STMT_START{ if(TAINTING_get){sv_taint(sv);} }STMT_END
1462 #define SvTAINTED_off(sv) STMT_START{ if(TAINTING_get){sv_untaint(sv);} }STMT_END
1464 #define SvTAINT(sv) \
1466 if (TAINTING_get) { \
1473 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1474 Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1475 only a string (C<SvPOK_only>), by hook or by crook. You want force if you are
1476 going to update the C<SvPVX> directly. Processes get magic.
1478 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1479 Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1480 only a string (C<SvPOK_only>), by hook or by crook. You want force if you are
1481 going to update the C<SvPVX> directly. Doesn't process get magic.
1483 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1484 Returns a pointer to the string in the SV, or a stringified form of
1485 the SV if the SV does not contain a string. The SV may cache the
1486 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1487 C<SvPVx> for a version which guarantees to evaluate sv only once.
1489 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1490 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1491 Only use this if C<sv> is an expression with side effects, otherwise use the
1492 more efficient C<SvPV>.
1494 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1495 Like C<SvPV> but doesn't process magic.
1497 =for apidoc Am|char*|SvPV_nolen|SV* sv
1498 Returns a pointer to the string in the SV, or a stringified form of
1499 the SV if the SV does not contain a string. The SV may cache the
1500 stringified form becoming C<SvPOK>. Handles 'get' magic.
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<SvIVx> for a
1507 version which guarantees to evaluate 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<SvNVx> for a version
1520 which guarantees to evaluate 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<SvUVx>
1533 for a version which guarantees to evaluate 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 SvOK() for a defined/undefined test. Handles 'get' magic
1547 unless the scalar is already SvPOK, SvIOK or 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 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 sv to utf8 first if necessary.
1557 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1558 Like C<SvPV>, but converts sv to utf8 first if necessary.
1560 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1561 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1563 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1564 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1566 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1567 Like C<SvPV>, but converts sv to byte representation first if necessary.
1569 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1570 Like C<SvPV_nolen>, but converts 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 sv to utf8 first if necessary.
1574 Guarantees to evaluate 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 sv to utf8 first if necessary.
1579 Guarantees to evaluate 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 sv to byte representation first if necessary.
1584 Guarantees to evaluate 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 sv to byte representation first if necessary.
1589 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1592 =for apidoc Am|bool|SvIsCOW|SV* sv
1593 Returns a boolean 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 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 #define SvPV_nomg_nolen(sv) \
1677 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1679 #define SvPV_nolen_const(sv) \
1681 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1683 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1684 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1685 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1689 #define SvPVutf8(sv, lp) \
1690 (SvPOK_utf8_nog(sv) \
1691 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1693 #define SvPVutf8_force(sv, lp) \
1694 (SvPOK_utf8_pure_nogthink(sv) \
1695 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1697 #define SvPVutf8_nolen(sv) \
1698 (SvPOK_utf8_nog(sv) \
1699 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1703 #define SvPVbyte(sv, lp) \
1704 (SvPOK_byte_nog(sv) \
1705 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1707 #define SvPVbyte_force(sv, lp) \
1708 (SvPOK_byte_pure_nogthink(sv) \
1709 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1711 #define SvPVbyte_nolen(sv) \
1712 (SvPOK_byte_nog(sv) \
1713 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1716 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1717 * var to evaluate the arg once; failing that, use a global if possible;
1718 * failing that, call a function to do the work
1721 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1722 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1723 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1725 #define SvTRUE(sv) ((sv) && (SvGMAGICAL(sv) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))))
1726 #define SvTRUE_nomg(sv) ((sv) && ( SvTRUE_common(sv, sv_2bool_nomg(sv))))
1727 #define SvTRUE_NN(sv) (SvGMAGICAL(sv) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv)))
1728 #define SvTRUE_nomg_NN(sv) ( SvTRUE_common(sv, sv_2bool_nomg(sv)))
1729 #define SvTRUE_common(sv,fallback) ( \
1732 : (SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK)) \
1733 ? ( (SvPOK(sv) && SvPVXtrue(sv)) \
1734 || (SvIOK(sv) && SvIVX(sv) != 0) \
1735 || (SvNOK(sv) && SvNVX(sv) != 0.0)) \
1738 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1740 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1741 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1742 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1743 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1744 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1745 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1746 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1747 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1748 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1749 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1750 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1751 # define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
1753 #else /* __GNUC__ */
1755 /* These inlined macros use globals, which will require a thread
1756 * declaration in user code, so we avoid them under threads */
1758 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1759 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1760 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1761 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1762 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1763 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1764 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1765 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1766 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1767 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1768 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1769 # define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
1770 #endif /* __GNU__ */
1772 #define SvPVXtrue(sv) ( \
1773 ((XPV*)SvANY((sv))) \
1775 ((XPV*)SvANY((sv)))->xpv_cur > 1 \
1777 ((XPV*)SvANY((sv)))->xpv_cur \
1778 && *(sv)->sv_u.svu_pv != '0' \
1783 #define SvIsCOW(sv) (SvFLAGS(sv) & SVf_IsCOW)
1784 #define SvIsCOW_on(sv) (SvFLAGS(sv) |= SVf_IsCOW)
1785 #define SvIsCOW_off(sv) (SvFLAGS(sv) &= ~SVf_IsCOW)
1786 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1788 #define SvSHARED_HEK_FROM_PV(pvx) \
1789 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1790 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1792 /* flag values for sv_*_flags functions */
1793 #define SV_IMMEDIATE_UNREF 1
1795 #define SV_COW_DROP_PV 4
1796 #define SV_UTF8_NO_ENCODING 8
1797 #define SV_NOSTEAL 16
1798 #define SV_CONST_RETURN 32
1799 #define SV_MUTABLE_RETURN 64
1800 #define SV_SMAGIC 128
1801 #define SV_HAS_TRAILING_NUL 256
1802 #define SV_COW_SHARED_HASH_KEYS 512
1803 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1804 #define SV_COW_OTHER_PVS 1024
1805 /* Make sv_2pv_flags return NULL if something is undefined. */
1806 #define SV_UNDEF_RETURNS_NULL 2048
1807 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1808 * This is used when the caller has already determined it is, and avoids
1810 #define SV_FORCE_UTF8_UPGRADE 4096
1811 /* if (after resolving magic etc), the SV is found to be overloaded,
1812 * don't call the overload magic, just return as-is */
1813 #define SV_SKIP_OVERLOAD 8192
1814 /* It is not yet clear whether we want this as an API, or what the
1815 * constants should be named. */
1817 # define SV_CATBYTES 16384
1818 # define SV_CATUTF8 32768
1821 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1822 So only default to doing the COW setup if we're in the core.
1825 # ifndef SV_DO_COW_SVSETSV
1826 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1830 #ifndef SV_DO_COW_SVSETSV
1831 # define SV_DO_COW_SVSETSV 0
1835 #define sv_unref(sv) sv_unref_flags(sv, 0)
1836 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1837 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1838 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1840 /* We are about to replace the SV's current value. So if it's copy on write
1841 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1842 the value is about to get thrown away, so drop the PV rather than go to
1843 the effort of making a read-write copy only for it to get immediately
1846 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1847 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1849 #ifdef PERL_OLD_COPY_ON_WRITE
1850 #define SvRELEASE_IVX(sv) \
1851 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1852 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1853 # define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
1854 # define SvCANCOW(sv) \
1855 (SvIsCOW(sv) || (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS)
1856 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
1858 # define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1859 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1860 SVf_OOK|SVf_BREAK|SVf_READONLY)
1862 # define SvRELEASE_IVX(sv) 0
1863 /* This little game brought to you by the need to shut this warning up:
1864 mg.c: In function 'Perl_magic_get':
1865 mg.c:1024: warning: left-hand operand of comma expression has no effect
1867 # define SvRELEASE_IVX_(sv) /**/
1868 # ifdef PERL_NEW_COPY_ON_WRITE
1869 # define SvCANCOW(sv) \
1871 ? SvLEN(sv) ? CowREFCNT(sv) != SV_COW_REFCNT_MAX : 1 \
1872 : (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS \
1873 && SvCUR(sv)+1 < SvLEN(sv))
1874 /* Note: To allow 256 COW "copies", a refcnt of 0 means 1. */
1875 # define CowREFCNT(sv) (*(U8 *)(SvPVX(sv)+SvLEN(sv)-1))
1876 # define SV_COW_REFCNT_MAX ((1 << sizeof(U8)*8) - 1)
1877 # ifndef SV_COW_THRESHOLD
1878 # define SV_COW_THRESHOLD 0 /* min string length for cow */
1880 # ifndef SV_COWBUF_THRESHOLD
1881 # define SV_COWBUF_THRESHOLD 1250 /* min string length for cow */
1882 # endif /* over existing buffer */
1883 # define CAN_COW_MASK (SVf_POK|SVf_ROK|SVp_POK|SVf_FAKE| \
1884 SVf_OOK|SVf_BREAK|SVf_READONLY)
1886 #endif /* PERL_OLD_COPY_ON_WRITE */
1888 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1890 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1891 sv_force_normal_flags(sv, 0)
1894 /* all these 'functions' are now just macros */
1896 #define sv_pv(sv) SvPV_nolen(sv)
1897 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1898 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1900 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1901 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1902 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1903 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1904 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
1905 #define sv_setsv(dsv, ssv) \
1906 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1907 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1908 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1909 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1910 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1911 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1912 #define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1913 #define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
1914 #define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
1915 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1916 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1917 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1918 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1919 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1920 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1921 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1922 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1923 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1924 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1925 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1926 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1927 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
1928 #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
1929 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
1930 #define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
1931 #define sv_insert(bigstr, offset, len, little, littlelen) \
1932 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1933 (littlelen), SV_GMAGIC)
1934 #define sv_mortalcopy(sv) \
1935 Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1937 /* Should be named SvCatPVN_utf8_upgrade? */
1938 #define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
1941 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
1943 sv_setpvn(nsv, sstr, slen); \
1945 sv_utf8_upgrade(nsv); \
1946 sv_catsv_nomg(dsv, nsv); \
1948 #define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \
1949 sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES)
1952 # define sv_or_pv_len_utf8(sv, pv, bytelen) \
1954 ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \
1956 # define sv_or_pv_pos_u2b(sv,s,p,lp) S_sv_or_pv_pos_u2b(aTHX_ sv,s,p,lp)
1960 =for apidoc Am|SV*|newRV_inc|SV* sv
1962 Creates an RV wrapper for an SV. The reference count for the original SV is
1968 #define newRV_inc(sv) newRV(sv)
1970 /* the following macros update any magic values this sv is associated with */
1973 =head1 Magical Functions
1975 =for apidoc Am|void|SvGETMAGIC|SV* sv
1976 Invokes C<mg_get> on an SV if it has 'get' magic. For example, this
1977 will call C<FETCH> on a tied variable. This macro evaluates its
1978 argument more than once.
1980 =for apidoc Am|void|SvSETMAGIC|SV* sv
1981 Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary
1982 after modifying a scalar, in case it is a magical variable like C<$|>
1983 or a tied variable (it calls C<STORE>). This macro evaluates its
1984 argument more than once.
1986 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1987 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1990 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1991 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1992 ssv. May evaluate arguments more than once.
1994 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1995 Like C<SvSetSV>, but does any set magic required afterwards.
1997 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1998 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2000 =for apidoc Am|void|SvSHARE|SV* sv
2001 Arranges for sv to be shared between threads if a suitable module
2004 =for apidoc Am|void|SvLOCK|SV* sv
2005 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2008 =for apidoc Am|void|SvUNLOCK|SV* sv
2009 Releases a mutual exclusion lock on sv if a suitable module
2012 =head1 SV Manipulation Functions
2014 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
2015 Expands the character buffer in the SV so that it has room for the
2016 indicated number of bytes (remember to reserve space for an extra trailing
2017 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2018 Returns a pointer to the character buffer. SV must be of type >= SVt_PV. One
2019 alternative is to call C<sv_grow> if you are not sure of the type of SV.
2024 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
2025 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
2026 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
2027 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
2029 #define SvGETMAGIC(x) ((void)(SvGMAGICAL(x) && mg_get(x)))
2030 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
2032 #define SvSetSV_and(dst,src,finally) \
2034 if ((dst) != (src)) { \
2035 sv_setsv(dst, src); \
2039 #define SvSetSV_nosteal_and(dst,src,finally) \
2041 if ((dst) != (src)) { \
2042 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
2047 #define SvSetSV(dst,src) \
2048 SvSetSV_and(dst,src,/*nothing*/;)
2049 #define SvSetSV_nosteal(dst,src) \
2050 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
2052 #define SvSetMagicSV(dst,src) \
2053 SvSetSV_and(dst,src,SvSETMAGIC(dst))
2054 #define SvSetMagicSV_nosteal(dst,src) \
2055 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
2058 #if !defined(SKIP_DEBUGGING)
2059 #define SvPEEK(sv) sv_peek(sv)
2061 #define SvPEEK(sv) ""
2064 #define SvIMMORTAL(sv) (SvREADONLY(sv) && ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder))
2067 /* exercise the immortal resurrection code in sv_free2() */
2068 # define SvREFCNT_IMMORTAL 1000
2070 # define SvREFCNT_IMMORTAL ((~(U32)0)/2)
2074 =for apidoc Am|SV *|boolSV|bool b
2076 Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
2078 See also C<PL_sv_yes> and C<PL_sv_no>.
2083 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2085 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2086 /* If I give every macro argument a different name, then there won't be bugs
2087 where nested macros get confused. Been there, done that. */
2088 #define isGV_with_GP(pwadak) \
2089 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
2090 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2091 #define isGV_with_GP_on(sv) STMT_START { \
2092 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2093 assert (!SvPOKp(sv)); \
2094 assert (!SvIOKp(sv)); \
2095 (SvFLAGS(sv) |= SVpgv_GP); \
2097 #define isGV_with_GP_off(sv) STMT_START { \
2098 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2099 assert (!SvPOKp(sv)); \
2100 assert (!SvIOKp(sv)); \
2101 (SvFLAGS(sv) &= ~SVpgv_GP); \
2103 #define isREGEXP(sv) \
2104 (SvTYPE(sv) == SVt_REGEXP \
2105 || (SvFLAGS(sv) & (SVTYPEMASK|SVp_POK|SVpgv_GP|SVf_FAKE)) \
2106 == (SVt_PVLV|SVf_FAKE))
2109 #ifdef PERL_NEW_COPY_ON_WRITE
2110 # define SvGROW(sv,len) \
2111 (SvIsCOW(sv) || SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2113 # define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2115 #define SvGROW_mutable(sv,len) \
2116 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2117 #define Sv_Grow sv_grow
2119 #define CLONEf_COPY_STACKS 1
2120 #define CLONEf_KEEP_PTR_TABLE 2
2121 #define CLONEf_CLONE_HOST 4
2122 #define CLONEf_JOIN_IN 8
2124 struct clone_params {
2127 PerlInterpreter *proto_perl;
2128 PerlInterpreter *new_perl;
2133 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2135 Creates a new SV and copies a string into it. If utf8 is true, calls
2136 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2141 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2144 =for apidoc Amx|SV*|newSVpadname|PADNAME *pn
2146 Creates a new SV containing the pad name. This is currently identical
2147 to C<newSVsv>, but pad names may cease being SVs at some point, so
2148 C<newSVpadname> is preferable.
2153 #define newSVpadname(pn) newSVsv(pn)
2156 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2158 Reads into I<len> the offset from SvPVX back to the true start of the
2159 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2160 efficiently remove characters from start of the buffer. Implemented as a
2161 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
2162 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
2168 /* Does the bot know something I don't?
2169 10:28 <@Nicholas> metabatman
2170 10:28 <+meta> Nicholas: crash
2172 # define SvOOK_offset(sv, offset) STMT_START { \
2173 assert(sizeof(offset) == sizeof(STRLEN)); \
2175 const U8 *_crash = (U8*)SvPVX_const(sv); \
2176 (offset) = *--_crash; \
2178 _crash -= sizeof(STRLEN); \
2179 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
2182 /* Validate the preceding buffer's sentinels to \
2183 verify that no-one is using it. */ \
2184 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2185 while (_crash > _bonk) { \
2187 assert (*_crash == (U8)PTR2UV(_crash)); \
2195 /* This is the same code, but avoids using any temporary variables: */
2196 # define SvOOK_offset(sv, offset) STMT_START { \
2197 assert(sizeof(offset) == sizeof(STRLEN)); \
2199 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2201 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2202 (U8*)&(offset), sizeof(STRLEN), U8); \
2210 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2214 * c-indentation-style: bsd
2216 * indent-tabs-mode: nil
2219 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob