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
61 expressions. SVt_INVLIST is for Perl
62 core internal use only.
64 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 SVt_PVMG, with fewer internal fields.
68 SVt_NULL can only hold undef. SVt_IV can hold undef, an integer, or a
69 reference. (SVt_RV is an alias for SVt_IV, which exists for backward
70 compatibility.) SVt_NV can hold any of those or a double. SVt_PV can only
71 hold undef or a string. SVt_PVIV is a superset of SVt_PV and SVt_IV.
72 SVt_PVNV is similar. SVt_PVMG can hold anything 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 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
164 purposes external code wanting to consider PVBM probably needs to think of
166 # define SVt_PVBM SVt_PVMG
167 /* Anything wanting to create a reference from clean should ensure that it has
168 a scalar of type SVt_IV now: */
169 # define SVt_RV SVt_IV
172 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
173 so never reaches the clause at the end that uses sv_type_details->body_size
174 to determine whether to call safefree(). Hence body_size can be set
175 non-zero to record the size of HEs, without fear of bogus frees. */
176 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
177 #define HE_SVSLOT SVt_NULL
180 # define SVt_FIRST SVt_NULL /* the type of SV that new_SV() in sv.c returns */
183 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
185 /* typedefs to eliminate some typing */
186 typedef struct he HE;
187 typedef struct hek HEK;
189 /* Using C's structural equivalence to help emulate C++ inheritance here... */
191 /* start with 2 sv-head building blocks */
192 #define _SV_HEAD(ptrtype) \
193 ptrtype sv_any; /* pointer to body */ \
194 U32 sv_refcnt; /* how many references to us */ \
195 U32 sv_flags /* what we are */
198 # define _NV_BODYLESS_UNION NV svu_nv;
200 # define _NV_BODYLESS_UNION
203 #define _SV_HEAD_UNION \
205 char* svu_pv; /* pointer to malloced string */ \
209 SV* svu_rv; /* pointer to another SV */ \
210 struct regexp* svu_rx; \
218 struct STRUCT_SV { /* struct sv { */
221 #ifdef DEBUG_LEAKING_SCALARS
222 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */
223 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */
224 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */
225 UV sv_debug_serial; /* serial number of sv allocation */
226 char * sv_debug_file; /* the file where we were allocated */
227 SV * sv_debug_parent; /* what we were cloned from (ithreads)*/
232 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
237 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
242 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
247 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
252 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
257 _SV_HEAD(struct regexp*); /* pointer to regexp body */
262 #undef _SV_HEAD_UNION /* ensure no pollution */
265 =head1 SV Manipulation Functions
267 =for apidoc Am|U32|SvREFCNT|SV* sv
268 Returns the value of the object's reference count.
270 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
271 Increments the reference count of the given SV, returning the SV.
273 All of the following SvREFCNT_inc* macros are optimized versions of
274 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
276 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
277 Same as SvREFCNT_inc, but can only be used if you know I<sv>
278 is not NULL. Since we don't have to check the NULLness, it's faster
281 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
282 Same as SvREFCNT_inc, but can only be used if you don't need the
283 return value. The macro doesn't need to return a meaningful value.
285 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
286 Same as SvREFCNT_inc, but can only be used if you don't need the return
287 value, and you know that I<sv> is not NULL. The macro doesn't need
288 to return a meaningful value, or check for NULLness, so it's smaller
291 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
292 Same as SvREFCNT_inc, but can only be used with expressions without side
293 effects. Since we don't have to store a temporary value, it's faster.
295 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
296 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
297 is not NULL. Since we don't have to check the NULLness, it's faster
300 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
301 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
302 return value. The macro doesn't need to return a meaningful value.
304 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
305 Same as SvREFCNT_inc, but can only be used if you don't need the return
306 value, and you know that I<sv> is not NULL. The macro doesn't need
307 to return a meaningful value, or check for NULLness, so it's smaller
310 =for apidoc Am|void|SvREFCNT_dec|SV* sv
311 Decrements the reference count of the given SV. I<sv> may be NULL.
313 =for apidoc Am|void|SvREFCNT_dec_NN|SV* sv
314 Same as SvREFCNT_dec, but can only be used if you know I<sv>
315 is not NULL. Since we don't have to check the NULLness, it's faster
318 =for apidoc Am|svtype|SvTYPE|SV* sv
319 Returns the type of the SV. See C<svtype>.
321 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
322 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
323 perform the upgrade if necessary. See C<svtype>.
328 #define SvANY(sv) (sv)->sv_any
329 #define SvFLAGS(sv) (sv)->sv_flags
330 #define SvREFCNT(sv) (sv)->sv_refcnt
332 #define SvREFCNT_inc(sv) S_SvREFCNT_inc(MUTABLE_SV(sv))
333 #define SvREFCNT_inc_simple(sv) SvREFCNT_inc(sv)
334 #define SvREFCNT_inc_NN(sv) S_SvREFCNT_inc_NN(MUTABLE_SV(sv))
335 #define SvREFCNT_inc_void(sv) S_SvREFCNT_inc_void(MUTABLE_SV(sv))
337 /* These guys don't need the curly blocks */
338 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
339 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
340 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
341 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
343 #define SvREFCNT_dec(sv) S_SvREFCNT_dec(aTHX_ MUTABLE_SV(sv))
344 #define SvREFCNT_dec_NN(sv) S_SvREFCNT_dec_NN(aTHX_ MUTABLE_SV(sv))
346 #define SVTYPEMASK 0xff
347 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
349 /* Sadly there are some parts of the core that have pointers to already-freed
350 SV heads, and rely on being able to tell that they are now free. So mark
351 them all by using a consistent macro. */
352 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
354 /* this is defined in this peculiar way to avoid compiler warnings.
355 * See the <20121213131428.GD1842@iabyn.com> thread in p5p */
356 #define SvUPGRADE(sv, mt) \
357 ((void)(SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt),1)))
359 #define SVf_IOK 0x00000100 /* has valid public integer value */
360 #define SVf_NOK 0x00000200 /* has valid public numeric value */
361 #define SVf_POK 0x00000400 /* has valid public pointer value */
362 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
364 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
365 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
366 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
367 #define SVp_SCREAM 0x00008000 /* method name is DOES */
368 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
369 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
370 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
371 subroutine in another package. Set the
372 GvIMPORTED_CV_on() if it needs to be
373 expanded to a real GV */
374 #define SVpad_NAMELIST SVp_SCREAM /* AV is a padnamelist */
375 #define SVf_PROTECT 0x00010000 /* very read-only */
376 #define SVs_PADTMP 0x00020000 /* in use as tmp */
377 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
378 #define SVs_PADSTALE 0x00040000 /* lexical has gone out of scope;
379 only used when !PADTMP */
380 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
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: On a pad name SV, that slot in the
393 frame AV is a REFCNT'ed reference
394 to a lexical from "outside".
395 4: HV: informally reserved by DAPM
397 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
398 means that a hv_aux struct is present
399 after the main array */
400 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
401 SVs in final arena cleanup.
402 Set in S_regtry on PL_reg_curpm, so that
403 perl_destruct will skip it. */
404 #define SVf_READONLY 0x08000000 /* may not be modified */
409 #define SVf_THINKFIRST (SVf_READONLY|SVf_PROTECT|SVf_ROK|SVf_FAKE \
412 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
413 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
415 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
417 /* Note that SVf_AMAGIC is now only set on stashes. */
418 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
419 #define SVf_IsCOW 0x10000000 /* copy on write (shared hash key if
422 /* Ensure this value does not clash with the GV_ADD* flags in gv.h, or the
423 CV_CKPROTO_* flags in op.c, or the padadd_* flags in pad.h: */
424 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
425 This is also set on RVs whose overloaded
426 stringification is UTF-8. This might
427 only happen as a side effect of SvPV() */
429 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
431 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
432 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
433 been restructured, so sometimes get used as string buffers. */
436 /* Some private flags. */
439 /* PVNV, PVMG only, and only used in pads. Should be safe to test on any scalar
440 SV, as the core is careful to avoid setting both.
442 SVf_POK, SVp_POK also set:
444 0x0000C400 method name for DOES (SvSCREAM)
445 0x40004400 FBM compiled (SvVALID)
448 0x00008000 GV with GP
449 0x00008800 RV with PCS imported
451 #define SVpad_NAME (SVp_SCREAM|SVpbm_VALID)
452 /* This SV is a name in the PAD, so
453 SVpad_TYPED, SVpad_OUR and SVpad_STATE
456 #define SVpav_REAL 0x40000000 /* free old entries */
458 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
459 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
460 on any regular scalar (anything <= PVLV) */
461 #define SVpbm_VALID 0x40000000
462 /* Only used in toke.c on an SV stored in PL_lex_repl */
463 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
465 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
466 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
468 #define SVpav_REIFY 0x80000000 /* can become real */
470 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
471 /* PVGV when SVpbm_VALID is true */
472 #define SVpbm_TAIL 0x80000000
473 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
474 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
475 /* pad name vars only */
476 #define SVpad_STATE 0x80000000 /* pad name is a "state" var */
479 HV* xmg_stash; /* class package */ \
481 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
483 STRLEN xpvlenu_len; /* allocated size */ \
484 char * xpvlenu_pv; /* regexp string */ \
487 #define xpv_len xpv_len_u.xpvlenu_len
490 NV xnv_nv; /* numeric value, if any */
495 } xpad_cop_seq; /* used by pad.c for cop_sequence */
499 IV xivu_iv; /* integer value */
501 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
505 MAGIC* xmg_magic; /* linked list of magicalness */
506 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
507 STRLEN xmg_hash_index; /* used while freeing hash entries */
508 }; /* also used by PadnamelistMAXNAMED */
519 #define xiv_iv xiv_u.xivu_iv
526 #define xuv_uv xuv_u.xivu_uv
534 /* This structure must match the beginning of struct xpvhv in hv.h. */
547 SSize_t xlvu_stargoff;
551 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
552 * y=alem/helem/iter t=tie T=tied HE */
553 char xlv_flags; /* 1 = negative offset 2 = negative len */
556 #define xlv_targoff xlv_targoff_u.xlvu_targoff
560 IV prev_index; /* caches result of previous invlist_search() */
561 STRLEN iterator; /* Stores where we are in iterating */
562 bool is_offset; /* The data structure for all inversion lists
563 begins with an element for code point U+0000.
564 If this bool is set, the actual list contains
565 that 0; otherwise, the list actually begins
566 with the following element. Thus to invert
567 the list, merely toggle this flag */
570 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
578 typedef U32 cv_flags_t;
580 #define _XPVCV_COMMON \
588 void (*xcv_xsub) (pTHX_ CV*); \
596 PADLIST * xcv_padlist; \
600 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
601 * compilation) in the lexically enclosing \
603 cv_flags_t xcv_flags; \
604 I32 xcv_depth /* >= 2 indicates recursive call */
606 /* This structure must match XPVCV in cv.h */
617 /* ifp and ofp are normally the same, but sockets need separate streams */
619 /* Cray addresses everything by word boundaries (64 bits) and
620 * code and data pointers cannot be mixed (which is exactly what
621 * Perl_filter_add() tries to do with the dirp), hence the
622 * following union trick (as suggested by Gurusamy Sarathy).
623 * For further information see Geir Johansen's problem report
624 * titled [ID 20000612.002] Perl problem on Cray system
625 * The any pointer (known as IoANY()) will also be a good place
626 * to hang any IO disciplines to.
629 DIR * xiou_dirp; /* for opendir, readdir, etc */
630 void * xiou_any; /* for alignment */
632 /* IV xio_lines is now in IVX $. */
633 IV xio_page; /* $% */
634 IV xio_page_len; /* $= */
635 IV xio_lines_left; /* $- */
636 char * xio_top_name; /* $^ */
637 GV * xio_top_gv; /* $^ */
638 char * xio_fmt_name; /* $~ */
639 GV * xio_fmt_gv; /* $~ */
640 char * xio_bottom_name;/* $^B */
641 GV * xio_bottom_gv; /* $^B */
646 #define xio_dirp xio_dirpu.xiou_dirp
647 #define xio_any xio_dirpu.xiou_any
649 #define IOf_ARGV 1 /* this fp iterates over ARGV */
650 #define IOf_START 2 /* check for null ARGV and substitute '-' */
651 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
652 #define IOf_DIDTOP 8 /* just did top of form */
653 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
654 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
655 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
656 Also, when this is set, SvPVX() is valid */
658 /* The following macros define implementation-independent predicates on SVs. */
661 =for apidoc Am|U32|SvNIOK|SV* sv
662 Returns a U32 value indicating whether the SV contains a number, integer or
665 =for apidoc Am|U32|SvNIOKp|SV* sv
666 Returns a U32 value indicating whether the SV contains a number, integer or
667 double. Checks the B<private> setting. Use C<SvNIOK> instead.
669 =for apidoc Am|void|SvNIOK_off|SV* sv
670 Unsets the NV/IV status of an SV.
672 =for apidoc Am|U32|SvOK|SV* sv
673 Returns a U32 value indicating whether the value is defined. This is
674 only meaningful for scalars.
676 =for apidoc Am|U32|SvIOKp|SV* sv
677 Returns a U32 value indicating whether the SV contains an integer. Checks
678 the B<private> setting. Use C<SvIOK> instead.
680 =for apidoc Am|U32|SvNOKp|SV* sv
681 Returns a U32 value indicating whether the SV contains a double. Checks the
682 B<private> setting. Use C<SvNOK> instead.
684 =for apidoc Am|U32|SvPOKp|SV* sv
685 Returns a U32 value indicating whether the SV contains a character string.
686 Checks the B<private> setting. Use C<SvPOK> instead.
688 =for apidoc Am|U32|SvIOK|SV* sv
689 Returns a U32 value indicating whether the SV contains an integer.
691 =for apidoc Am|void|SvIOK_on|SV* sv
692 Tells an SV that it is an integer.
694 =for apidoc Am|void|SvIOK_off|SV* sv
695 Unsets the IV status of an SV.
697 =for apidoc Am|void|SvIOK_only|SV* sv
698 Tells an SV that it is an integer and disables all other OK bits.
700 =for apidoc Am|void|SvIOK_only_UV|SV* sv
701 Tells an SV that it is an unsigned integer and disables all other OK bits.
703 =for apidoc Am|bool|SvIOK_UV|SV* sv
704 Returns a boolean indicating whether the SV contains an integer that must be
705 interpreted as unsigned. A non-negative integer whose value is within the
706 range of both an IV and a UV may be be flagged as either SvUOK or SVIOK.
708 =for apidoc Am|bool|SvUOK|SV* sv
709 Returns a boolean indicating whether the SV contains an integer that must be
710 interpreted as unsigned. A non-negative integer whose value is within the
711 range of both an IV and a UV may be be flagged as either SvUOK or SVIOK.
713 =for apidoc Am|bool|SvIOK_notUV|SV* sv
714 Returns a boolean indicating whether the SV contains a signed integer.
716 =for apidoc Am|U32|SvNOK|SV* sv
717 Returns a U32 value indicating whether the SV contains a double.
719 =for apidoc Am|void|SvNOK_on|SV* sv
720 Tells an SV that it is a double.
722 =for apidoc Am|void|SvNOK_off|SV* sv
723 Unsets the NV status of an SV.
725 =for apidoc Am|void|SvNOK_only|SV* sv
726 Tells an SV that it is a double and disables all other OK bits.
728 =for apidoc Am|U32|SvPOK|SV* sv
729 Returns a U32 value indicating whether the SV contains a character
732 =for apidoc Am|void|SvPOK_on|SV* sv
733 Tells an SV that it is a string.
735 =for apidoc Am|void|SvPOK_off|SV* sv
736 Unsets the PV status of an SV.
738 =for apidoc Am|void|SvPOK_only|SV* sv
739 Tells an SV that it is a string and disables all other OK bits.
740 Will also turn off the UTF-8 status.
742 =for apidoc Am|bool|SvVOK|SV* sv
743 Returns a boolean indicating whether the SV contains a v-string.
745 =for apidoc Am|U32|SvOOK|SV* sv
746 Returns a U32 indicating whether the pointer to the string buffer is offset.
747 This hack is used internally to speed up removal of characters from the
748 beginning of a SvPV. When SvOOK is true, then the start of the
749 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
750 This offset used to be stored in SvIVX, but is now stored within the spare
753 =for apidoc Am|U32|SvROK|SV* sv
754 Tests if the SV is an RV.
756 =for apidoc Am|void|SvROK_on|SV* sv
757 Tells an SV that it is an RV.
759 =for apidoc Am|void|SvROK_off|SV* sv
760 Unsets the RV status of an SV.
762 =for apidoc Am|SV*|SvRV|SV* sv
763 Dereferences an RV to return the SV.
765 =for apidoc Am|IV|SvIVX|SV* sv
766 Returns the raw value in the SV's IV slot, without checks or conversions.
767 Only use when you are sure SvIOK is true. See also C<SvIV()>.
769 =for apidoc Am|UV|SvUVX|SV* sv
770 Returns the raw value in the SV's UV slot, without checks or conversions.
771 Only use when you are sure SvIOK is true. See also C<SvUV()>.
773 =for apidoc Am|NV|SvNVX|SV* sv
774 Returns the raw value in the SV's NV slot, without checks or conversions.
775 Only use when you are sure SvNOK is true. See also C<SvNV()>.
777 =for apidoc Am|char*|SvPVX|SV* sv
778 Returns a pointer to the physical string in the SV. The SV must contain a
779 string. Prior to 5.9.3 it is not safe
780 to execute this macro unless the SV's
783 This is also used to store the name of an autoloaded subroutine in an XS
784 AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
786 =for apidoc Am|STRLEN|SvCUR|SV* sv
787 Returns the length of the string which is in the SV. See C<SvLEN>.
789 =for apidoc Am|STRLEN|SvLEN|SV* sv
790 Returns the size of the string buffer in the SV, not including any part
791 attributable to C<SvOOK>. See C<SvCUR>.
793 =for apidoc Am|char*|SvEND|SV* sv
794 Returns a pointer to the spot just after the last character in
795 the string which is in the SV, where there is usually a trailing
796 C<NUL> character (even though Perl scalars do not strictly require it).
797 See C<SvCUR>. Access the character as *(SvEND(sv)).
799 Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
802 =for apidoc Am|HV*|SvSTASH|SV* sv
803 Returns the stash of the SV.
805 =for apidoc Am|void|SvIV_set|SV* sv|IV val
806 Set the value of the IV pointer in sv to val. It is possible to perform
807 the same function of this macro with an lvalue assignment to C<SvIVX>.
808 With future Perls, however, it will be more efficient to use
809 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
811 =for apidoc Am|void|SvNV_set|SV* sv|NV val
812 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
814 =for apidoc Am|void|SvPV_set|SV* sv|char* val
815 Set the value of the PV pointer in C<sv> to the C<NUL>-terminated string
816 C<val>. See also C<SvIV_set>.
818 Beware that the existing pointer may be involved in copy-on-write or other
819 mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or
820 C<SvPV_force> (or check the SvIsCOW flag) first to make sure this
821 modification is safe.
823 =for apidoc Am|void|SvUV_set|SV* sv|UV val
824 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
826 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
827 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
829 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
830 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
832 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
833 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
835 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
836 Set the current length of the string which is in the SV. See C<SvCUR>
839 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
840 Set the actual length of the string which is in the SV. See C<SvIV_set>.
845 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
846 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
847 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
848 SVp_IOK|SVp_NOK|SVf_IVisUV))
850 #define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv))
851 #define assert_not_glob(sv) assert_(!isGV_with_GP(sv))
853 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK || isREGEXP(sv))
854 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
855 SvFLAGS(sv) &= ~(SVf_OK| \
856 SVf_IVisUV|SVf_UTF8), \
858 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
859 SvFLAGS(sv) &= ~(SVf_OK| \
863 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
864 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
865 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
866 SvFLAGS(sv) |= SVp_IOK)
867 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
868 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
869 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
870 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
871 SvFLAGS(sv) |= SVp_POK)
873 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
874 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
875 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
876 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
877 #define SvIOK_only(sv) (SvOK_off(sv), \
878 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
879 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
880 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
882 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
883 == (SVf_IOK|SVf_IVisUV))
884 #define SvUOK(sv) SvIOK_UV(sv)
885 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
888 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
889 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
890 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
892 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
893 #define SvNOK_on(sv) (assert_not_glob(sv) \
894 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
895 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
896 #define SvNOK_only(sv) (SvOK_off(sv), \
897 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
900 =for apidoc Am|U32|SvUTF8|SV* sv
901 Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
902 properly, this indicates whether or not the SV contains UTF-8 encoded data.
903 You should use this I<after> a call to SvPV() or one of its variants, in
904 case any call to string overloading updates the internal flag.
906 =for apidoc Am|void|SvUTF8_on|SV *sv
907 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
908 Do not use frivolously.
910 =for apidoc Am|void|SvUTF8_off|SV *sv
911 Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
912 Do not use frivolously.
914 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
915 Tells an SV that it is a string and disables all other OK bits,
916 and leaves the UTF-8 status as it was.
921 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
923 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
924 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
925 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
927 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
928 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
929 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
930 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
931 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
932 SvFLAGS(sv) &= ~(SVf_OK| \
933 SVf_IVisUV|SVf_UTF8), \
934 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
935 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
936 SvFLAGS(sv) &= ~(SVf_OK| \
938 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
940 #define SvVOK(sv) (SvMAGICAL(sv) \
941 && mg_find(sv,PERL_MAGIC_vstring))
942 /* returns the vstring magic, if any */
943 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
944 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
946 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
947 #define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
948 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
950 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
951 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
952 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
954 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
955 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
956 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
958 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
959 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
960 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
962 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
963 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
964 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
966 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
967 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
968 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
970 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
971 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
972 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
974 #define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
975 HvAMAGIC(SvSTASH(SvRV(sv))))
977 /* To be used on the stashes themselves: */
978 #define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
979 #define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
980 #define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
983 /* "nog" means "doesn't have get magic" */
984 #define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
985 #define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
986 #define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
987 #define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
988 #define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
990 #define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
991 #define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
992 #define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
993 #define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
994 #define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
996 #define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
997 #define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
999 #define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
1000 #define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1002 #define SvPOK_pure_nogthink(sv) \
1003 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1004 #define SvPOK_utf8_pure_nogthink(sv) \
1005 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1006 #define SvPOK_byte_pure_nogthink(sv) \
1007 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1010 =for apidoc Am|U32|SvGAMAGIC|SV* sv
1012 Returns true if the SV has get magic or
1013 overloading. If either is true then
1014 the scalar is active data, and has the potential to return a new value every
1015 time it is accessed. Hence you must be careful to
1016 only read it once per user logical operation and work
1017 with that returned value. If neither is true then
1018 the scalar's value cannot change unless written to.
1023 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1025 #define Gv_AMG(stash) \
1026 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
1028 : (HvAMAGIC_off(stash), 0))
1030 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1031 == (SVf_ROK|SVprv_WEAKREF))
1032 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1033 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1035 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
1036 == (SVf_ROK|SVprv_PCS_IMPORTED))
1037 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
1038 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
1041 =for apidoc m|U32|SvTHINKFIRST|SV *sv
1043 A quick flag check to see whether an sv should be passed to sv_force_normal
1044 to be "downgraded" before SvIVX or SvPVX can be modified directly.
1046 For example, if your scalar is a reference and you want to modify the SvIVX
1047 slot, you can't just do SvROK_off, as that will leak the referent.
1049 This is used internally by various sv-modifying functions, such as
1050 sv_setsv, sv_setiv and sv_pvn_force.
1052 One case that this does not handle is a gv without SvFAKE set. After
1054 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
1056 it will still be a gv.
1058 SvTHINKFIRST sometimes produces false positives. In those cases
1059 sv_force_normal does nothing.
1064 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1067 #define SvPADMY(sv) !(SvFLAGS(sv) & SVs_PADTMP)
1069 # define SvPADMY_on(sv) SvPADTMP_off(sv)
1072 #define SvPADTMP(sv) (SvFLAGS(sv) & (SVs_PADTMP))
1073 #define SvPADSTALE(sv) (SvFLAGS(sv) & (SVs_PADSTALE))
1075 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1076 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
1077 #define SvPADSTALE_on(sv) S_SvPADSTALE_on(MUTABLE_SV(sv))
1078 #define SvPADSTALE_off(sv) S_SvPADSTALE_off(MUTABLE_SV(sv))
1080 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1081 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1082 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1084 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1085 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1086 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1088 #define SvREADONLY(sv) (SvFLAGS(sv) & (SVf_READONLY|SVf_PROTECT))
1090 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= (SVf_READONLY|SVf_PROTECT))
1091 # define SvREADONLY_off(sv) (SvFLAGS(sv) &=~(SVf_READONLY|SVf_PROTECT))
1093 # define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1094 # define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1097 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1098 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1099 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1102 # define SvCOMPILED(sv) 0
1103 # define SvCOMPILED_on(sv)
1104 # define SvCOMPILED_off(sv)
1107 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1108 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1109 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1111 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1112 # define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
1113 if (SvFLAGS(_svvalid) & SVpbm_VALID && !SvSCREAM(_svvalid)) \
1114 assert(!isGV_with_GP(_svvalid)); \
1115 (SvFLAGS(_svvalid) & SVpbm_VALID); \
1117 # define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
1118 assert(!isGV_with_GP(_svvalid)); \
1119 assert(!SvSCREAM(_svvalid)); \
1120 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
1122 # define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
1123 assert(!isGV_with_GP(_svvalid)); \
1124 assert(!SvSCREAM(_svvalid)); \
1125 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
1128 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
1129 assert(SvTYPE(_svtail) != SVt_PVAV); \
1130 assert(SvTYPE(_svtail) != SVt_PVHV); \
1131 assert(!SvSCREAM(_svtail)); \
1132 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1133 == (SVpbm_TAIL|SVpbm_VALID); \
1136 # define SvVALID(sv) ((SvFLAGS(sv) & SVpbm_VALID) && !SvSCREAM(sv))
1137 # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1138 # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
1139 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1140 == (SVpbm_TAIL|SVpbm_VALID))
1143 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1144 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1147 #define SvPAD_TYPED(sv) \
1148 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1150 #define SvPAD_OUR(sv) \
1151 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1153 #define SvPAD_STATE(sv) \
1154 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1156 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1157 # define SvPAD_TYPED_on(sv) ({ \
1158 SV *const _svpad = MUTABLE_SV(sv); \
1159 assert(SvTYPE(_svpad) == SVt_PVMG); \
1160 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \
1162 #define SvPAD_OUR_on(sv) ({ \
1163 SV *const _svpad = MUTABLE_SV(sv); \
1164 assert(SvTYPE(_svpad) == SVt_PVMG); \
1165 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \
1167 #define SvPAD_STATE_on(sv) ({ \
1168 SV *const _svpad = MUTABLE_SV(sv); \
1169 assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
1170 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \
1173 # define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1174 # define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1175 # define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1178 #define SvOURSTASH(sv) \
1179 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1180 #define SvOURSTASH_set(sv, st) \
1182 assert(SvTYPE(sv) == SVt_PVMG); \
1183 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1186 #define SvRVx(sv) SvRV(sv)
1188 #ifdef PERL_DEBUG_COW
1189 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1190 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1191 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1192 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1193 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1194 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1195 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1196 /* Don't test the core XS code yet. */
1197 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1198 # define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
1200 # define SvPVX(sv) SvPVX_mutable(sv)
1202 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1203 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1204 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1206 # define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1207 # define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
1209 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1210 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1212 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1213 /* These get expanded inside other macros that already use a variable _sv */
1214 # define SvPVX(sv) \
1215 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1216 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
1217 assert(!isGV_with_GP(_svpvx)); \
1218 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1219 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
1220 &((_svpvx)->sv_u.svu_pv); \
1222 # define SvCUR(sv) \
1223 (*({ const SV *const _svcur = (const SV *)(sv); \
1224 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK] \
1225 || SvTYPE(_svcur) == SVt_REGEXP); \
1226 assert(!isGV_with_GP(_svcur)); \
1227 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1228 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1229 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1231 # define SvIVX(sv) \
1232 (*({ const SV *const _svivx = (const SV *)(sv); \
1233 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
1234 assert(!isGV_with_GP(_svivx)); \
1235 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1237 # define SvUVX(sv) \
1238 (*({ const SV *const _svuvx = (const SV *)(sv); \
1239 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
1240 assert(!isGV_with_GP(_svuvx)); \
1241 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1243 # define SvNVX(sv) \
1244 (*({ const SV *const _svnvx = (const SV *)(sv); \
1245 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
1246 assert(!isGV_with_GP(_svnvx)); \
1247 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1250 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1251 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1252 assert(!isGV_with_GP(_svrv)); \
1253 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1254 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1255 &((_svrv)->sv_u.svu_rv); \
1257 # define SvRV_const(sv) \
1258 ({ const SV *const _svrv = (const SV *)(sv); \
1259 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1260 assert(!isGV_with_GP(_svrv)); \
1261 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1262 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1263 (_svrv)->sv_u.svu_rv; \
1265 # define SvMAGIC(sv) \
1266 (*({ const SV *const _svmagic = (const SV *)(sv); \
1267 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1268 if(SvTYPE(_svmagic) == SVt_PVMG) \
1269 assert(!SvPAD_OUR(_svmagic)); \
1270 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1272 # define SvSTASH(sv) \
1273 (*({ const SV *const _svstash = (const SV *)(sv); \
1274 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1275 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1278 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1279 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1280 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1281 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1282 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1283 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1284 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1285 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1286 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1291 /* Given that these two are new, there can't be any existing code using them
1293 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1294 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1296 /* Except for the poison code, which uses & to scribble over the pointer after
1297 free() is called. */
1298 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1299 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1302 #define SvIVXx(sv) SvIVX(sv)
1303 #define SvUVXx(sv) SvUVX(sv)
1304 #define SvNVXx(sv) SvNVX(sv)
1305 #define SvPVXx(sv) SvPVX(sv)
1306 #define SvLENx(sv) SvLEN(sv)
1307 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1310 /* Ask a scalar nicely to try to become an IV, if possible.
1311 Not guaranteed to stay returning void */
1312 /* Macro won't actually call sv_2iv if already IOK */
1313 #define SvIV_please(sv) \
1314 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1315 (void) SvIV(sv); } STMT_END
1316 #define SvIV_please_nomg(sv) \
1317 (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv)) \
1318 ? (SvIV_nomg(sv), SvIOK(sv)) \
1320 #define SvIV_set(sv, val) \
1322 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1323 assert(!isGV_with_GP(sv)); \
1324 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1325 #define SvNV_set(sv, val) \
1327 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
1328 assert(!isGV_with_GP(sv)); \
1329 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1330 #define SvPV_set(sv, val) \
1332 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1333 assert(!isGV_with_GP(sv)); \
1334 assert(!(SvTYPE(sv) == SVt_PVIO \
1335 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1336 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1337 #define SvUV_set(sv, val) \
1339 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1340 assert(!isGV_with_GP(sv)); \
1341 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1342 #define SvRV_set(sv, val) \
1344 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
1345 assert(!isGV_with_GP(sv)); \
1346 assert(!(SvTYPE(sv) == SVt_PVIO \
1347 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1348 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1349 #define SvMAGIC_set(sv, val) \
1350 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1351 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1352 #define SvSTASH_set(sv, val) \
1353 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1354 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1355 #define SvCUR_set(sv, val) \
1357 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK] \
1358 || SvTYPE(sv) == SVt_REGEXP); \
1359 assert(!isGV_with_GP(sv)); \
1360 assert(!(SvTYPE(sv) == SVt_PVIO \
1361 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1362 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1363 #define SvLEN_set(sv, val) \
1365 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1366 assert(!isGV_with_GP(sv)); \
1367 assert(!(SvTYPE(sv) == SVt_PVIO \
1368 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1369 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1370 #define SvEND_set(sv, val) \
1371 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1372 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1374 #define SvPV_renew(sv,n) \
1375 STMT_START { SvLEN_set(sv, n); \
1376 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1377 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1378 (MEM_SIZE)((n))))); \
1381 #define SvPV_shrink_to_cur(sv) STMT_START { \
1382 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1383 SvPV_renew(sv, _lEnGtH); \
1386 #define SvPV_free(sv) \
1388 assert(SvTYPE(sv) >= SVt_PV); \
1390 assert(!SvROK(sv)); \
1391 if(UNLIKELY(SvOOK(sv))) { \
1393 SvOOK_offset(sv, zok); \
1394 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1395 SvFLAGS(sv) &= ~SVf_OOK; \
1397 Safefree(SvPVX(sv)); \
1402 /* Code that crops up in three places to take a scalar and ready it to hold
1404 # define prepare_SV_for_RV(sv) \
1406 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1407 sv_upgrade(sv, SVt_IV); \
1408 else if (SvTYPE(sv) >= SVt_PV) { \
1417 # define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1420 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1421 # define BmUSEFUL(sv) \
1422 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1423 assert(SvTYPE(_bmuseful) >= SVt_PVIV); \
1424 assert(SvVALID(_bmuseful)); \
1425 assert(!SvIOK(_bmuseful)); \
1426 &(((XPVIV*) SvANY(_bmuseful))->xiv_u.xivu_iv); \
1429 # define BmUSEFUL(sv) ((XPVIV*) SvANY(sv))->xiv_u.xivu_iv
1434 # define BmRARE(sv) 0
1435 # define BmPREVIOUS(sv) 0
1438 #define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1440 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1441 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1442 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1443 #define LvSTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff_u.xlvu_stargoff
1444 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1445 #define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
1447 #define IoIFP(sv) (sv)->sv_u.svu_fp
1448 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1449 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1450 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1451 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
1452 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1453 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1454 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1455 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1456 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1457 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1458 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1459 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1460 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1461 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1462 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1464 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1465 #define IoTYPE_RDONLY '<'
1466 #define IoTYPE_WRONLY '>'
1467 #define IoTYPE_RDWR '+'
1468 #define IoTYPE_APPEND 'a'
1469 #define IoTYPE_PIPE '|'
1470 #define IoTYPE_STD '-' /* stdin or stdout */
1471 #define IoTYPE_SOCKET 's'
1472 #define IoTYPE_CLOSED ' '
1473 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1474 #define IoTYPE_NUMERIC '#' /* fdopen */
1477 =for apidoc Am|bool|SvTAINTED|SV* sv
1478 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1481 =for apidoc Am|void|SvTAINTED_on|SV* sv
1482 Marks an SV as tainted if tainting is enabled.
1484 =for apidoc Am|void|SvTAINTED_off|SV* sv
1485 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1486 some of Perl's fundamental security features. XS module authors should not
1487 use this function unless they fully understand all the implications of
1488 unconditionally untainting the value. Untainting should be done in the
1489 standard perl fashion, via a carefully crafted regexp, rather than directly
1490 untainting variables.
1492 =for apidoc Am|void|SvTAINT|SV* sv
1493 Taints an SV if tainting is enabled, and if some input to the current
1494 expression is tainted--usually a variable, but possibly also implicit
1495 inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1496 the outputs of an expression in a pessimistic fashion; i.e., without paying
1497 attention to precisely which outputs are influenced by which inputs.
1502 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1504 #ifdef NO_TAINT_SUPPORT
1505 # define SvTAINTED(sv) 0
1507 # define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1509 #define SvTAINTED_on(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_taint(sv);} }STMT_END
1510 #define SvTAINTED_off(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_untaint(sv);} }STMT_END
1512 #define SvTAINT(sv) \
1514 if (UNLIKELY(TAINTING_get)) { \
1515 if (UNLIKELY(TAINT_get)) \
1521 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1522 Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1523 only a string (C<SvPOK_only>), by hook or by crook. You need force if you are
1524 going to update the C<SvPVX> directly. Processes get magic.
1526 Note that coercing an arbitrary scalar into a plain PV will potentially
1527 strip useful data from it. For example if the SV was C<SvROK>, then the
1528 referent will have its reference count decremented, and the SV itself may
1529 be converted to an C<SvPOK> scalar with a string buffer containing a value
1530 such as C<"ARRAY(0x1234)">.
1532 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1533 Like C<SvPV_force>, but doesn't process get magic.
1535 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1536 Returns a pointer to the string in the SV, or a stringified form of
1537 the SV if the SV does not contain a string. The SV may cache the
1538 stringified version becoming C<SvPOK>. Handles 'get' magic. The
1539 C<len> variable will be set to the length of the string (this is a macro, so
1540 don't use C<&len>). See also C<SvPVx> for a version which guarantees to
1541 evaluate sv only once.
1543 Note that there is no guarantee that the return value of C<SvPV()> is
1544 equal to C<SvPVX(sv)>, or that C<SvPVX(sv)> contains valid data, or that
1545 successive calls to C<SvPV(sv)> will return the same pointer value each
1546 time. This is due to the way that things like overloading and
1547 Copy-On-Write are handled. In these cases, the return value may point to
1548 a temporary buffer or similar. If you absolutely need the SvPVX field to
1549 be valid (for example, if you intend to write to it), then see
1552 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1553 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1554 Only use this if C<sv> is an expression with side effects, otherwise use the
1555 more efficient C<SvPV>.
1557 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1558 Like C<SvPV> but doesn't process magic.
1560 =for apidoc Am|char*|SvPV_nolen|SV* sv
1561 Like C<SvPV> but doesn't set a length variable.
1563 =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1564 Like C<SvPV_nolen> but doesn't process magic.
1566 =for apidoc Am|IV|SvIV|SV* sv
1567 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1568 version which guarantees to evaluate sv only once.
1570 =for apidoc Am|IV|SvIV_nomg|SV* sv
1571 Like C<SvIV> but doesn't process magic.
1573 =for apidoc Am|IV|SvIVx|SV* sv
1574 Coerces the given SV to an integer and returns it.
1575 Guarantees to evaluate C<sv> only once. Only use
1576 this if C<sv> is an expression with side effects,
1577 otherwise use the more efficient C<SvIV>.
1579 =for apidoc Am|NV|SvNV|SV* sv
1580 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1581 which guarantees to evaluate sv only once.
1583 =for apidoc Am|NV|SvNV_nomg|SV* sv
1584 Like C<SvNV> but doesn't process magic.
1586 =for apidoc Am|NV|SvNVx|SV* sv
1587 Coerces the given SV to a double and returns it.
1588 Guarantees to evaluate C<sv> only once. Only use
1589 this if C<sv> is an expression with side effects,
1590 otherwise use the more efficient C<SvNV>.
1592 =for apidoc Am|UV|SvUV|SV* sv
1593 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1594 for a version which guarantees to evaluate sv only once.
1596 =for apidoc Am|UV|SvUV_nomg|SV* sv
1597 Like C<SvUV> but doesn't process magic.
1599 =for apidoc Am|UV|SvUVx|SV* sv
1600 Coerces the given SV to an unsigned integer and
1601 returns it. Guarantees to evaluate C<sv> only once. Only
1602 use this if C<sv> is an expression with side effects,
1603 otherwise use the more efficient C<SvUV>.
1605 =for apidoc Am|bool|SvTRUE|SV* sv
1606 Returns a boolean indicating whether Perl would evaluate the SV as true or
1607 false. See SvOK() for a defined/undefined test. Handles 'get' magic
1608 unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
1611 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
1612 Returns a boolean indicating whether Perl would evaluate the SV as true or
1613 false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
1615 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1616 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1618 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1619 Like C<SvPV>, but converts sv to utf8 first if necessary.
1621 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1622 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1624 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1625 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1627 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1628 Like C<SvPV>, but converts sv to byte representation first if necessary.
1630 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1631 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1633 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1634 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1635 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1638 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1639 Like C<SvPV>, but converts sv to utf8 first if necessary.
1640 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1643 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1644 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1645 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1648 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1649 Like C<SvPV>, but converts sv to byte representation first if necessary.
1650 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1653 =for apidoc Am|U32|SvIsCOW|SV* sv
1654 Returns a U32 value indicating whether the SV is Copy-On-Write (either shared
1655 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1658 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1659 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1662 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1663 Like C<sv_catpvn> but doesn't process magic.
1665 =for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1666 Like C<sv_catpv> but doesn't process magic.
1668 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1669 Like C<sv_setsv> but doesn't process magic.
1671 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1672 Like C<sv_catsv> but doesn't process magic.
1674 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1676 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
1681 /* Let us hope that bitmaps for UV and IV are the same */
1682 #define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1683 #define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1684 #define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
1686 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1687 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1688 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1692 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1693 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1694 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1696 #define SvPV_flags(sv, lp, flags) \
1698 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1699 #define SvPV_flags_const(sv, lp, flags) \
1701 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1702 (const char*) sv_2pv_flags(sv, &lp, (flags|SV_CONST_RETURN)))
1703 #define SvPV_flags_const_nolen(sv, flags) \
1705 ? SvPVX_const(sv) : \
1706 (const char*) sv_2pv_flags(sv, 0, (flags|SV_CONST_RETURN)))
1707 #define SvPV_flags_mutable(sv, lp, flags) \
1709 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1710 sv_2pv_flags(sv, &lp, (flags|SV_MUTABLE_RETURN)))
1712 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1713 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1714 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1716 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1717 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1719 #define SvPV_force_flags(sv, lp, flags) \
1720 (SvPOK_pure_nogthink(sv) \
1721 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1723 #define SvPV_force_flags_nolen(sv, flags) \
1724 (SvPOK_pure_nogthink(sv) \
1725 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1727 #define SvPV_force_flags_mutable(sv, lp, flags) \
1728 (SvPOK_pure_nogthink(sv) \
1729 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1730 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1732 #define SvPV_nolen(sv) \
1734 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1736 /* "_nomg" in these defines means no mg_get() */
1737 #define SvPV_nomg_nolen(sv) \
1739 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1741 #define SvPV_nolen_const(sv) \
1743 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1745 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1746 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1747 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1751 #define SvPVutf8(sv, lp) \
1752 (SvPOK_utf8_nog(sv) \
1753 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1755 #define SvPVutf8_force(sv, lp) \
1756 (SvPOK_utf8_pure_nogthink(sv) \
1757 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1759 #define SvPVutf8_nolen(sv) \
1760 (SvPOK_utf8_nog(sv) \
1761 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1765 #define SvPVbyte(sv, lp) \
1766 (SvPOK_byte_nog(sv) \
1767 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1769 #define SvPVbyte_force(sv, lp) \
1770 (SvPOK_byte_pure_nogthink(sv) \
1771 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1773 #define SvPVbyte_nolen(sv) \
1774 (SvPOK_byte_nog(sv) \
1775 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1778 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1779 * var to evaluate the arg once; failing that, use a global if possible;
1780 * failing that, call a function to do the work
1783 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1784 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1785 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1787 #define SvTRUE(sv) (LIKELY(sv) && (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))))
1788 #define SvTRUE_nomg(sv) (LIKELY(sv) && ( SvTRUE_common(sv, sv_2bool_nomg(sv))))
1789 #define SvTRUE_NN(sv) (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv)))
1790 #define SvTRUE_nomg_NN(sv) ( SvTRUE_common(sv, sv_2bool_nomg(sv)))
1791 #define SvTRUE_common(sv,fallback) ( \
1796 : (SvFLAGS(sv) & (SVf_IOK|SVf_NOK)) \
1797 ? ( (SvIOK(sv) && SvIVX(sv) != 0) \
1798 || (SvNOK(sv) && SvNVX(sv) != 0.0)) \
1801 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1803 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1804 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1805 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1806 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1807 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1808 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1809 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1810 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1811 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1812 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1813 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1814 # define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
1816 #else /* __GNUC__ */
1818 /* These inlined macros use globals, which will require a thread
1819 * declaration in user code, so we avoid them under threads */
1821 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1822 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1823 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1824 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1825 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1826 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1827 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1828 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1829 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1830 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1831 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1832 # define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
1833 #endif /* __GNU__ */
1835 #define SvPVXtrue(sv) ( \
1836 ((XPV*)SvANY((sv))) \
1838 ((XPV*)SvANY((sv)))->xpv_cur > 1 \
1840 ((XPV*)SvANY((sv)))->xpv_cur \
1841 && *(sv)->sv_u.svu_pv != '0' \
1846 #define SvIsCOW(sv) (SvFLAGS(sv) & SVf_IsCOW)
1847 #define SvIsCOW_on(sv) (SvFLAGS(sv) |= SVf_IsCOW)
1848 #define SvIsCOW_off(sv) (SvFLAGS(sv) &= ~SVf_IsCOW)
1849 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1851 #define SvSHARED_HEK_FROM_PV(pvx) \
1852 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1853 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1855 /* flag values for sv_*_flags functions */
1856 #define SV_IMMEDIATE_UNREF 1
1858 #define SV_COW_DROP_PV 4
1859 #define SV_UTF8_NO_ENCODING 8
1860 #define SV_NOSTEAL 16
1861 #define SV_CONST_RETURN 32
1862 #define SV_MUTABLE_RETURN 64
1863 #define SV_SMAGIC 128
1864 #define SV_HAS_TRAILING_NUL 256
1865 #define SV_COW_SHARED_HASH_KEYS 512
1866 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1867 #define SV_COW_OTHER_PVS 1024
1868 /* Make sv_2pv_flags return NULL if something is undefined. */
1869 #define SV_UNDEF_RETURNS_NULL 2048
1870 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1871 * This is used when the caller has already determined it is, and avoids
1873 #define SV_FORCE_UTF8_UPGRADE 4096
1874 /* if (after resolving magic etc), the SV is found to be overloaded,
1875 * don't call the overload magic, just return as-is */
1876 #define SV_SKIP_OVERLOAD 8192
1877 #define SV_CATBYTES 16384
1878 #define SV_CATUTF8 32768
1880 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1881 So only default to doing the COW setup if we're in the core.
1884 # ifndef SV_DO_COW_SVSETSV
1885 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1889 #ifndef SV_DO_COW_SVSETSV
1890 # define SV_DO_COW_SVSETSV 0
1894 #define sv_unref(sv) sv_unref_flags(sv, 0)
1895 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1896 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1897 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1899 /* We are about to replace the SV's current value. So if it's copy on write
1900 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1901 the value is about to get thrown away, so drop the PV rather than go to
1902 the effort of making a read-write copy only for it to get immediately
1905 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1906 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1908 #ifdef PERL_OLD_COPY_ON_WRITE
1909 #define SvRELEASE_IVX(sv) \
1910 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1911 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1912 # define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
1913 # define SvCANCOW(sv) \
1914 (SvIsCOW(sv) || (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS)
1915 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
1917 # define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1918 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1919 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_PROTECT)
1921 # define SvRELEASE_IVX(sv) 0
1922 /* This little game brought to you by the need to shut this warning up:
1923 mg.c: In function 'Perl_magic_get':
1924 mg.c:1024: warning: left-hand operand of comma expression has no effect
1926 # define SvRELEASE_IVX_(sv) /**/
1927 # ifdef PERL_NEW_COPY_ON_WRITE
1928 # define SvCANCOW(sv) \
1930 ? SvLEN(sv) ? CowREFCNT(sv) != SV_COW_REFCNT_MAX : 1 \
1931 : (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS \
1932 && SvCUR(sv)+1 < SvLEN(sv))
1933 /* Note: To allow 256 COW "copies", a refcnt of 0 means 1. */
1934 # define CowREFCNT(sv) (*(U8 *)(SvPVX(sv)+SvLEN(sv)-1))
1935 # define SV_COW_REFCNT_MAX ((1 << sizeof(U8)*8) - 1)
1936 # define CAN_COW_MASK (SVf_POK|SVf_ROK|SVp_POK|SVf_FAKE| \
1937 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_PROTECT)
1939 #endif /* PERL_OLD_COPY_ON_WRITE */
1941 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1943 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1944 sv_force_normal_flags(sv, 0)
1947 /* all these 'functions' are now just macros */
1949 #define sv_pv(sv) SvPV_nolen(sv)
1950 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1951 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1953 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1954 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1955 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1956 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1957 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
1958 #define sv_setsv(dsv, ssv) \
1959 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1960 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1961 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1962 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1963 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1964 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1965 #define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1966 #define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
1967 #define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
1968 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1969 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1970 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1971 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1972 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1973 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1974 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1975 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1976 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1977 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1978 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1979 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1980 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
1981 #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
1982 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
1983 #define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
1984 #define sv_insert(bigstr, offset, len, little, littlelen) \
1985 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1986 (littlelen), SV_GMAGIC)
1987 #define sv_mortalcopy(sv) \
1988 Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1989 #define sv_cathek(sv,hek) \
1991 HEK * const bmxk = hek; \
1992 sv_catpvn_flags(sv, HEK_KEY(bmxk), HEK_LEN(bmxk), \
1993 HEK_UTF8(bmxk) ? SV_CATUTF8 : SV_CATBYTES); \
1996 /* Should be named SvCatPVN_utf8_upgrade? */
1997 #define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
2000 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
2002 sv_setpvn(nsv, sstr, slen); \
2004 sv_utf8_upgrade(nsv); \
2005 sv_catsv_nomg(dsv, nsv); \
2007 #define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \
2008 sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES)
2010 #if defined(PERL_CORE) || defined(PERL_EXT)
2011 # define sv_or_pv_len_utf8(sv, pv, bytelen) \
2013 ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \
2018 =for apidoc Am|SV*|newRV_inc|SV* sv
2020 Creates an RV wrapper for an SV. The reference count for the original SV is
2026 #define newRV_inc(sv) newRV(sv)
2028 /* the following macros update any magic values this sv is associated with */
2031 =head1 Magical Functions
2033 =for apidoc Am|void|SvGETMAGIC|SV* sv
2034 Invokes C<mg_get> on an SV if it has 'get' magic. For example, this
2035 will call C<FETCH> on a tied variable. This macro evaluates its
2036 argument more than once.
2038 =for apidoc Am|void|SvSETMAGIC|SV* sv
2039 Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary
2040 after modifying a scalar, in case it is a magical variable like C<$|>
2041 or a tied variable (it calls C<STORE>). This macro evaluates its
2042 argument more than once.
2044 =for apidoc Am|void|SvSetSV|SV* dsv|SV* ssv
2045 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
2046 more than once. Does not handle 'set' magic on the destination SV.
2048 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
2049 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2050 ssv. May evaluate arguments more than once.
2052 =for apidoc Am|void|SvSetMagicSV|SV* dsv|SV* ssv
2053 Like C<SvSetSV>, but does any set magic required afterwards.
2055 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
2056 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2058 =for apidoc Am|void|SvSHARE|SV* sv
2059 Arranges for sv to be shared between threads if a suitable module
2062 =for apidoc Am|void|SvLOCK|SV* sv
2063 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2066 =for apidoc Am|void|SvUNLOCK|SV* sv
2067 Releases a mutual exclusion lock on sv if a suitable module
2070 =head1 SV Manipulation Functions
2072 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
2073 Expands the character buffer in the SV so that it has room for the
2074 indicated number of bytes (remember to reserve space for an extra trailing
2075 C<NUL> character). Calls C<sv_grow> to perform the expansion if necessary.
2076 Returns a pointer to the character
2077 buffer. SV must be of type >= SVt_PV. One
2078 alternative is to call C<sv_grow> if you are not sure of the type of SV.
2083 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
2084 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
2085 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
2086 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
2088 #define SvGETMAGIC(x) ((void)(UNLIKELY(SvGMAGICAL(x)) && mg_get(x)))
2089 #define SvSETMAGIC(x) STMT_START { if (UNLIKELY(SvSMAGICAL(x))) mg_set(x); } STMT_END
2091 #define SvSetSV_and(dst,src,finally) \
2093 if (LIKELY((dst) != (src))) { \
2094 sv_setsv(dst, src); \
2098 #define SvSetSV_nosteal_and(dst,src,finally) \
2100 if (LIKELY((dst) != (src))) { \
2101 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
2106 #define SvSetSV(dst,src) \
2107 SvSetSV_and(dst,src,/*nothing*/;)
2108 #define SvSetSV_nosteal(dst,src) \
2109 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
2111 #define SvSetMagicSV(dst,src) \
2112 SvSetSV_and(dst,src,SvSETMAGIC(dst))
2113 #define SvSetMagicSV_nosteal(dst,src) \
2114 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
2117 #if !defined(SKIP_DEBUGGING)
2118 #define SvPEEK(sv) sv_peek(sv)
2120 #define SvPEEK(sv) ""
2123 #define SvIMMORTAL(sv) (SvREADONLY(sv) && ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder))
2126 /* exercise the immortal resurrection code in sv_free2() */
2127 # define SvREFCNT_IMMORTAL 1000
2129 # define SvREFCNT_IMMORTAL ((~(U32)0)/2)
2133 =for apidoc Am|SV *|boolSV|bool b
2135 Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
2137 See also C<PL_sv_yes> and C<PL_sv_no>.
2142 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2144 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2145 /* If I give every macro argument a different name, then there won't be bugs
2146 where nested macros get confused. Been there, done that. */
2147 #define isGV_with_GP(pwadak) \
2148 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
2149 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2150 #define isGV_with_GP_on(sv) STMT_START { \
2151 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2152 assert (!SvPOKp(sv)); \
2153 assert (!SvIOKp(sv)); \
2154 (SvFLAGS(sv) |= SVpgv_GP); \
2156 #define isGV_with_GP_off(sv) STMT_START { \
2157 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2158 assert (!SvPOKp(sv)); \
2159 assert (!SvIOKp(sv)); \
2160 (SvFLAGS(sv) &= ~SVpgv_GP); \
2162 #define isREGEXP(sv) \
2163 (SvTYPE(sv) == SVt_REGEXP \
2164 || (SvFLAGS(sv) & (SVTYPEMASK|SVp_POK|SVpgv_GP|SVf_FAKE)) \
2165 == (SVt_PVLV|SVf_FAKE))
2169 # define SvGROW(sv,len) \
2170 (SvIsCOW(sv) || SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2172 # define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2174 #define SvGROW_mutable(sv,len) \
2175 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2176 #define Sv_Grow sv_grow
2178 #define CLONEf_COPY_STACKS 1
2179 #define CLONEf_KEEP_PTR_TABLE 2
2180 #define CLONEf_CLONE_HOST 4
2181 #define CLONEf_JOIN_IN 8
2183 struct clone_params {
2186 PerlInterpreter *proto_perl;
2187 PerlInterpreter *new_perl;
2192 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2194 Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
2195 characters) into it. If utf8 is true, calls
2196 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2201 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2204 =for apidoc Amx|SV*|newSVpadname|PADNAME *pn
2206 Creates a new SV containing the pad name. This is currently identical
2207 to C<newSVsv>, but pad names may cease being SVs at some point, so
2208 C<newSVpadname> is preferable.
2213 #define newSVpadname(pn) newSVsv(pn)
2216 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2218 Reads into I<len> the offset from SvPVX back to the true start of the
2219 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2220 efficiently remove characters from start of the buffer. Implemented as a
2221 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
2222 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
2228 /* Does the bot know something I don't?
2229 10:28 <@Nicholas> metabatman
2230 10:28 <+meta> Nicholas: crash
2232 # define SvOOK_offset(sv, offset) STMT_START { \
2233 assert(sizeof(offset) == sizeof(STRLEN)); \
2235 const U8 *_crash = (U8*)SvPVX_const(sv); \
2236 (offset) = *--_crash; \
2238 _crash -= sizeof(STRLEN); \
2239 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
2242 /* Validate the preceding buffer's sentinels to \
2243 verify that no-one is using it. */ \
2244 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2245 while (_crash > _bonk) { \
2247 assert (*_crash == (U8)PTR2UV(_crash)); \
2255 /* This is the same code, but avoids using any temporary variables: */
2256 # define SvOOK_offset(sv, offset) STMT_START { \
2257 assert(sizeof(offset) == sizeof(STRLEN)); \
2259 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2261 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2262 (U8*)&(offset), sizeof(STRLEN), U8); \
2270 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2272 #define SV_CONST(name) \
2273 PL_sv_consts[SV_CONST_##name] \
2274 ? PL_sv_consts[SV_CONST_##name] \
2275 : (PL_sv_consts[SV_CONST_##name] = newSVpv_share(#name, 0))
2277 #define SV_CONST_TIESCALAR 0
2278 #define SV_CONST_TIEARRAY 1
2279 #define SV_CONST_TIEHASH 2
2280 #define SV_CONST_TIEHANDLE 3
2282 #define SV_CONST_FETCH 4
2283 #define SV_CONST_FETCHSIZE 5
2284 #define SV_CONST_STORE 6
2285 #define SV_CONST_STORESIZE 7
2286 #define SV_CONST_EXISTS 8
2288 #define SV_CONST_PUSH 9
2289 #define SV_CONST_POP 10
2290 #define SV_CONST_SHIFT 11
2291 #define SV_CONST_UNSHIFT 12
2292 #define SV_CONST_SPLICE 13
2293 #define SV_CONST_EXTEND 14
2295 #define SV_CONST_FIRSTKEY 15
2296 #define SV_CONST_NEXTKEY 16
2297 #define SV_CONST_SCALAR 17
2299 #define SV_CONST_OPEN 18
2300 #define SV_CONST_WRITE 19
2301 #define SV_CONST_PRINT 20
2302 #define SV_CONST_PRINTF 21
2303 #define SV_CONST_READ 22
2304 #define SV_CONST_READLINE 23
2305 #define SV_CONST_GETC 24
2306 #define SV_CONST_SEEK 25
2307 #define SV_CONST_TELL 26
2308 #define SV_CONST_EOF 27
2309 #define SV_CONST_BINMODE 28
2310 #define SV_CONST_FILENO 29
2311 #define SV_CONST_CLOSE 30
2313 #define SV_CONST_DELETE 31
2314 #define SV_CONST_CLEAR 32
2315 #define SV_CONST_UNTIE 33
2316 #define SV_CONST_DESTROY 34
2318 #define SV_CONSTS_COUNT 35
2322 * c-indentation-style: bsd
2324 * indent-tabs-mode: nil
2327 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob