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.
41 These are most easily explained from the bottom up.
43 SVt_PVIO is for I/O objects, SVt_PVFM for formats, SVt_PVCV for
44 subroutines, SVt_PVHV for hashes and SVt_PVAV for arrays.
46 All the others are scalar types, that is, things that can be bound to a
47 C<$> variable. For these, the internal types are mostly orthogonal to
48 types in the Perl language.
50 Hence, checking C<< SvTYPE(sv) < SVt_PVAV >> is the best way to see whether
51 something is a scalar.
53 SVt_PVGV represents a typeglob. If !SvFAKE(sv), then it is a real,
54 incoercible typeglob. If SvFAKE(sv), then it is a scalar to which a
55 typeglob has been assigned. Assigning to it again will stop it from being
56 a typeglob. SVt_PVLV represents a scalar that delegates to another scalar
57 behind the scenes. It is used, e.g., for the return value of C<substr> and
58 for tied hash and array elements. It can hold any scalar value, including
59 a typeglob. SVt_REGEXP is for regular expressions.
61 SVt_PVMG represents a "normal" scalar (not a typeglob, regular expression,
62 or delegate). Since most scalars do not need all the internal fields of a
63 PVMG, we save memory by allocating smaller structs when possible. All the
64 other types are just simpler forms of SVt_PVMG, with fewer internal fields.
65 SVt_NULL can only hold undef. SVt_IV can hold undef, an integer, or a
66 reference. (SVt_RV is an alias for SVt_IV, which exists for backward
67 compatibility.) SVt_NV can hold any of those or a double. SVt_PV can only
68 hold undef or a string. SVt_PVIV is a superset of SVt_PV and SVt_IV.
69 SVt_PVNV is similar. SVt_PVMG can hold anything SVt_PVNV can hold, but it
70 can, but does not have to, be blessed or magical.
72 =for apidoc AmU||SVt_NULL
73 Type flag for scalars. See L</svtype>.
75 =for apidoc AmU||SVt_IV
76 Type flag for scalars. See L</svtype>.
78 =for apidoc AmU||SVt_NV
79 Type flag for scalars. See L</svtype>.
81 =for apidoc AmU||SVt_PV
82 Type flag for scalars. See L</svtype>.
84 =for apidoc AmU||SVt_PVIV
85 Type flag for scalars. See L</svtype>.
87 =for apidoc AmU||SVt_PVNV
88 Type flag for scalars. See L</svtype>.
90 =for apidoc AmU||SVt_PVMG
91 Type flag for scalars. See L</svtype>.
93 =for apidoc AmU||SVt_REGEXP
94 Type flag for regular expressions. See L</svtype>.
96 =for apidoc AmU||SVt_PVGV
97 Type flag for typeglobs. See L</svtype>.
99 =for apidoc AmU||SVt_PVLV
100 Type flag for scalars. See L</svtype>.
102 =for apidoc AmU||SVt_PVAV
103 Type flag for arrays. See L</svtype>.
105 =for apidoc AmU||SVt_PVHV
106 Type flag for hashes. See L</svtype>.
108 =for apidoc AmU||SVt_PVCV
109 Type flag for subroutines. See L</svtype>.
111 =for apidoc AmU||SVt_PVFM
112 Type flag for formats. See L</svtype>.
114 =for apidoc AmU||SVt_PVIO
115 Type flag for I/O objects. See L</svtype>.
125 /* RV was here, before it was merged with IV. */
131 /* PVBM was here, before BIND replaced it. */
139 SVt_LAST /* keep last in enum. used to size arrays */
142 /* *** any alterations to the SV types above need to be reflected in
143 * SVt_MASK and the various PL_valid_types_* tables */
145 #define SVt_MASK 0xf /* smallest bitmask that covers all types */
148 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
149 purposes eternal code wanting to consider PVBM probably needs to think of
151 # define SVt_PVBM SVt_PVMG
152 /* Anything wanting to create a reference from clean should ensure that it has
153 a scalar of type SVt_IV now: */
154 # define SVt_RV SVt_IV
157 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
158 so never reaches the clause at the end that uses sv_type_details->body_size
159 to determine whether to call safefree(). Hence body_size can be set
160 non-zero to record the size of HEs, without fear of bogus frees. */
161 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
162 #define HE_SVSLOT SVt_NULL
165 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
167 /* typedefs to eliminate some typing */
168 typedef struct he HE;
169 typedef struct hek HEK;
171 /* Using C's structural equivalence to help emulate C++ inheritance here... */
173 /* start with 2 sv-head building blocks */
174 #define _SV_HEAD(ptrtype) \
175 ptrtype sv_any; /* pointer to body */ \
176 U32 sv_refcnt; /* how many references to us */ \
177 U32 sv_flags /* what we are */
179 #define _SV_HEAD_UNION \
181 char* svu_pv; /* pointer to malloced string */ \
184 SV* svu_rv; /* pointer to another SV */ \
185 struct regexp* svu_rx; \
193 struct STRUCT_SV { /* struct sv { */
196 #ifdef DEBUG_LEAKING_SCALARS
197 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */
198 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */
199 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */
200 UV sv_debug_serial; /* serial number of sv allocation */
201 char * sv_debug_file; /* the file where we were allocated */
202 SV * sv_debug_parent; /* what we were cloned from (ithreads)*/
207 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
212 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
217 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
222 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
227 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
232 _SV_HEAD(struct regexp*); /* pointer to regexp body */
237 #undef _SV_HEAD_UNION /* ensure no pollution */
240 =head1 SV Manipulation Functions
242 =for apidoc Am|U32|SvREFCNT|SV* sv
243 Returns the value of the object's reference count.
245 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
246 Increments the reference count of the given SV, returning the SV.
248 All of the following SvREFCNT_inc* macros are optimized versions of
249 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
251 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
252 Same as SvREFCNT_inc, but can only be used if you know I<sv>
253 is not NULL. Since we don't have to check the NULLness, it's faster
256 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
257 Same as SvREFCNT_inc, but can only be used if you don't need the
258 return value. The macro doesn't need to return a meaningful value.
260 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
261 Same as SvREFCNT_inc, but can only be used if you don't need the return
262 value, and you know that I<sv> is not NULL. The macro doesn't need
263 to return a meaningful value, or check for NULLness, so it's smaller
266 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
267 Same as SvREFCNT_inc, but can only be used with expressions without side
268 effects. Since we don't have to store a temporary value, it's faster.
270 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
271 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
272 is not NULL. Since we don't have to check the NULLness, it's faster
275 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
276 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
277 return value. The macro doesn't need to return a meaningful value.
279 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
280 Same as SvREFCNT_inc, but can only be used if you don't need the return
281 value, and you know that I<sv> is not NULL. The macro doesn't need
282 to return a meaningful value, or check for NULLness, so it's smaller
285 =for apidoc Am|void|SvREFCNT_dec|SV* sv
286 Decrements the reference count of the given SV. I<sv> may be NULL.
288 =for apidoc Am|void|SvREFCNT_dec_NN|SV* sv
289 Same as SvREFCNT_dec, but can only be used if you know I<sv>
290 is not NULL. Since we don't have to check the NULLness, it's faster
293 =for apidoc Am|svtype|SvTYPE|SV* sv
294 Returns the type of the SV. See C<svtype>.
296 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
297 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
298 perform the upgrade if necessary. See C<svtype>.
303 #define SvANY(sv) (sv)->sv_any
304 #define SvFLAGS(sv) (sv)->sv_flags
305 #define SvREFCNT(sv) (sv)->sv_refcnt
307 #define SvREFCNT_inc(sv) S_SvREFCNT_inc(MUTABLE_SV(sv))
308 #define SvREFCNT_inc_simple(sv) SvREFCNT_inc(sv)
309 #define SvREFCNT_inc_NN(sv) S_SvREFCNT_inc_NN(MUTABLE_SV(sv))
310 #define SvREFCNT_inc_void(sv) S_SvREFCNT_inc_void(MUTABLE_SV(sv))
312 /* These guys don't need the curly blocks */
313 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
314 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
315 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
316 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
318 #define SvREFCNT_dec(sv) S_SvREFCNT_dec(aTHX_ MUTABLE_SV(sv))
319 #define SvREFCNT_dec_NN(sv) S_SvREFCNT_dec_NN(aTHX_ MUTABLE_SV(sv))
321 #define SVTYPEMASK 0xff
322 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
324 /* Sadly there are some parts of the core that have pointers to already-freed
325 SV heads, and rely on being able to tell that they are now free. So mark
326 them all by using a consistent macro. */
327 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
329 /* this is defined in this peculiar way to avoid compiler warnings.
330 * See the <20121213131428.GD1842@iabyn.com> thread in p5p */
331 #define SvUPGRADE(sv, mt) \
332 ((void)(SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt),1)))
334 #define SVf_IOK 0x00000100 /* has valid public integer value */
335 #define SVf_NOK 0x00000200 /* has valid public numeric value */
336 #define SVf_POK 0x00000400 /* has valid public pointer value */
337 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
339 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
340 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
341 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
342 #define SVp_SCREAM 0x00008000 /* method name is DOES */
343 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
344 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
345 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
346 subroutine in another package. Set the
347 GvIMPORTED_CV_on() if it needs to be
348 expanded to a real GV */
349 #define SVf_IsCOW 0x00010000 /* copy on write (shared hash key if
351 #define SVs_PADTMP 0x00020000 /* in use as tmp; only if ! SVs_PADMY */
352 #define SVs_PADSTALE 0x00020000 /* lexical has gone out of scope;
353 only valid for SVs_PADMY */
354 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
355 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
356 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
357 #define SVs_TEMP 0x00080000 /* string is stealable? */
358 #define SVs_OBJECT 0x00100000 /* is "blessed" */
359 #define SVs_GMG 0x00200000 /* has magical get method */
360 #define SVs_SMG 0x00400000 /* has magical set method */
361 #define SVs_RMG 0x00800000 /* has random magical methods */
363 #define SVf_FAKE 0x01000000 /* 0: glob is just a copy
364 1: SV head arena wasn't malloc()ed
365 2: For PVCV, whether CvUNIQUE(cv)
366 refers to an eval or once only
367 [CvEVAL(cv), CvSPECIAL(cv)]
368 3: On a pad name SV, that slot in the
369 frame AV is a REFCNT'ed reference
370 to a lexical from "outside". */
371 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
372 means that a hv_aux struct is present
373 after the main array */
374 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
375 SVs in final arena cleanup.
376 Set in S_regtry on PL_reg_curpm, so that
377 perl_destruct will skip it. */
378 #define SVf_READONLY 0x08000000 /* may not be modified */
383 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE|SVs_RMG|SVf_IsCOW)
385 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
386 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
388 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
390 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
392 /* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
393 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
394 This is also set on RVs whose overloaded
395 stringification is UTF-8. This might
396 only happen as a side effect of SvPV() */
399 /* Some private flags. */
401 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
402 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
403 been restructured, so sometimes get used as string buffers. */
406 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
408 /* PVNV, PVMG only, and only used in pads. Should be safe to test on any scalar
409 SV, as the core is careful to avoid setting both.
411 SVf_POK, SVp_POK also set:
413 0x0000C400 method name for DOES (SvSCREAM)
414 0x40004400 FBM compiled (SvVALID)
417 0x00008000 GV with GP
418 0x00008800 RV with PCS imported
420 #define SVpad_NAME (SVp_SCREAM|SVpbm_VALID)
421 /* This SV is a name in the PAD, so
422 SVpad_TYPED, SVpad_OUR and SVpad_STATE
425 #define SVpav_REAL 0x40000000 /* free old entries */
427 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
428 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
429 on any regular scalar (anything <= PVLV) */
430 #define SVpbm_VALID 0x40000000
431 /* Only used in toke.c on an SV stored in PL_lex_repl */
432 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
434 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
435 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
437 #define SVpav_REIFY 0x80000000 /* can become real */
439 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
440 /* PVGV when SVpbm_VALID is true */
441 #define SVpbm_TAIL 0x80000000
442 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
443 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
444 /* pad name vars only */
445 #define SVpad_STATE 0x80000000 /* pad name is a "state" var */
448 HV* xmg_stash; /* class package */ \
450 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
452 STRLEN xpvlenu_len; /* allocated size */ \
453 char * xpvlenu_pv; /* regexp string */ \
456 #define xpv_len xpv_len_u.xpvlenu_len
459 NV xnv_nv; /* numeric value, if any */
464 } xpad_cop_seq; /* used by pad.c for cop_sequence */
469 IV xivu_iv; /* integer value */
471 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
475 MAGIC* xmg_magic; /* linked list of magicalness */
476 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
477 STRLEN xmg_hash_index; /* used while freeing hash entries */
489 #define xiv_iv xiv_u.xivu_iv
496 #define xuv_uv xuv_u.xivu_uv
504 /* This structure must match the beginning of struct xpvhv in hv.h. */
518 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
519 * y=alem/helem/iter t=tie T=tied HE */
520 char xlv_flags; /* 1 = negative offset 2 = negative len */
523 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
531 typedef U32 cv_flags_t;
533 #define _XPVCV_COMMON \
541 void (*xcv_xsub) (pTHX_ CV*); \
548 PADLIST * xcv_padlist; \
550 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
551 * compilation) in the lexically enclosing \
553 cv_flags_t xcv_flags; \
554 I32 xcv_depth /* >= 2 indicates recursive call */
556 /* This structure must match XPVCV in cv.h */
567 /* ifp and ofp are normally the same, but sockets need separate streams */
569 /* Cray addresses everything by word boundaries (64 bits) and
570 * code and data pointers cannot be mixed (which is exactly what
571 * Perl_filter_add() tries to do with the dirp), hence the
572 * following union trick (as suggested by Gurusamy Sarathy).
573 * For further information see Geir Johansen's problem report
574 * titled [ID 20000612.002] Perl problem on Cray system
575 * The any pointer (known as IoANY()) will also be a good place
576 * to hang any IO disciplines to.
579 DIR * xiou_dirp; /* for opendir, readdir, etc */
580 void * xiou_any; /* for alignment */
582 /* IV xio_lines is now in IVX $. */
583 IV xio_page; /* $% */
584 IV xio_page_len; /* $= */
585 IV xio_lines_left; /* $- */
586 char * xio_top_name; /* $^ */
587 GV * xio_top_gv; /* $^ */
588 char * xio_fmt_name; /* $~ */
589 GV * xio_fmt_gv; /* $~ */
590 char * xio_bottom_name;/* $^B */
591 GV * xio_bottom_gv; /* $^B */
596 #define xio_dirp xio_dirpu.xiou_dirp
597 #define xio_any xio_dirpu.xiou_any
599 #define IOf_ARGV 1 /* this fp iterates over ARGV */
600 #define IOf_START 2 /* check for null ARGV and substitute '-' */
601 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
602 #define IOf_DIDTOP 8 /* just did top of form */
603 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
604 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
605 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
606 Also, when this is set, SvPVX() is valid */
608 /* The following macros define implementation-independent predicates on SVs. */
611 =for apidoc Am|U32|SvNIOK|SV* sv
612 Returns a U32 value indicating whether the SV contains a number, integer or
615 =for apidoc Am|U32|SvNIOKp|SV* sv
616 Returns a U32 value indicating whether the SV contains a number, integer or
617 double. Checks the B<private> setting. Use C<SvNIOK> instead.
619 =for apidoc Am|void|SvNIOK_off|SV* sv
620 Unsets the NV/IV status of an SV.
622 =for apidoc Am|U32|SvOK|SV* sv
623 Returns a U32 value indicating whether the value is defined. This is
624 only meaningful for scalars.
626 =for apidoc Am|U32|SvIOKp|SV* sv
627 Returns a U32 value indicating whether the SV contains an integer. Checks
628 the B<private> setting. Use C<SvIOK> instead.
630 =for apidoc Am|U32|SvNOKp|SV* sv
631 Returns a U32 value indicating whether the SV contains a double. Checks the
632 B<private> setting. Use C<SvNOK> instead.
634 =for apidoc Am|U32|SvPOKp|SV* sv
635 Returns a U32 value indicating whether the SV contains a character string.
636 Checks the B<private> setting. Use C<SvPOK> instead.
638 =for apidoc Am|U32|SvIOK|SV* sv
639 Returns a U32 value indicating whether the SV contains an integer.
641 =for apidoc Am|void|SvIOK_on|SV* sv
642 Tells an SV that it is an integer.
644 =for apidoc Am|void|SvIOK_off|SV* sv
645 Unsets the IV status of an SV.
647 =for apidoc Am|void|SvIOK_only|SV* sv
648 Tells an SV that it is an integer and disables all other OK bits.
650 =for apidoc Am|void|SvIOK_only_UV|SV* sv
651 Tells an SV that it is an unsigned integer and disables all other OK bits.
653 =for apidoc Am|bool|SvIOK_UV|SV* sv
654 Returns a boolean indicating whether the SV contains an integer that must be
655 interpreted as unsigned. A non-negative integer whose value is within the
656 range of both an IV and a UV may be be flagged as either SvUOK or SVIOK.
658 =for apidoc Am|bool|SvUOK|SV* sv
659 Returns a boolean indicating whether the SV contains an integer that must be
660 interpreted as unsigned. A non-negative integer whose value is within the
661 range of both an IV and a UV may be be flagged as either SvUOK or SVIOK.
663 =for apidoc Am|bool|SvIOK_notUV|SV* sv
664 Returns a boolean indicating whether the SV contains a signed integer.
666 =for apidoc Am|U32|SvNOK|SV* sv
667 Returns a U32 value indicating whether the SV contains a double.
669 =for apidoc Am|void|SvNOK_on|SV* sv
670 Tells an SV that it is a double.
672 =for apidoc Am|void|SvNOK_off|SV* sv
673 Unsets the NV status of an SV.
675 =for apidoc Am|void|SvNOK_only|SV* sv
676 Tells an SV that it is a double and disables all other OK bits.
678 =for apidoc Am|U32|SvPOK|SV* sv
679 Returns a U32 value indicating whether the SV contains a character
682 =for apidoc Am|void|SvPOK_on|SV* sv
683 Tells an SV that it is a string.
685 =for apidoc Am|void|SvPOK_off|SV* sv
686 Unsets the PV status of an SV.
688 =for apidoc Am|void|SvPOK_only|SV* sv
689 Tells an SV that it is a string and disables all other OK bits.
690 Will also turn off the UTF-8 status.
692 =for apidoc Am|bool|SvVOK|SV* sv
693 Returns a boolean indicating whether the SV contains a v-string.
695 =for apidoc Am|U32|SvOOK|SV* sv
696 Returns a U32 indicating whether the pointer to the string buffer is offset.
697 This hack is used internally to speed up removal of characters from the
698 beginning of a SvPV. When SvOOK is true, then the start of the
699 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
700 This offset used to be stored in SvIVX, but is now stored within the spare
703 =for apidoc Am|U32|SvROK|SV* sv
704 Tests if the SV is an RV.
706 =for apidoc Am|void|SvROK_on|SV* sv
707 Tells an SV that it is an RV.
709 =for apidoc Am|void|SvROK_off|SV* sv
710 Unsets the RV status of an SV.
712 =for apidoc Am|SV*|SvRV|SV* sv
713 Dereferences an RV to return the SV.
715 =for apidoc Am|IV|SvIVX|SV* sv
716 Returns the raw value in the SV's IV slot, without checks or conversions.
717 Only use when you are sure SvIOK is true. See also C<SvIV()>.
719 =for apidoc Am|UV|SvUVX|SV* sv
720 Returns the raw value in the SV's UV slot, without checks or conversions.
721 Only use when you are sure SvIOK is true. See also C<SvUV()>.
723 =for apidoc Am|NV|SvNVX|SV* sv
724 Returns the raw value in the SV's NV slot, without checks or conversions.
725 Only use when you are sure SvNOK is true. See also C<SvNV()>.
727 =for apidoc Am|char*|SvPVX|SV* sv
728 Returns a pointer to the physical string in the SV. The SV must contain a
729 string. Prior to 5.9.3 it is not safe to execute this macro unless the SV's
732 This is also used to store the name of an autoloaded subroutine in an XS
733 AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
735 =for apidoc Am|STRLEN|SvCUR|SV* sv
736 Returns the length of the string which is in the SV. See C<SvLEN>.
738 =for apidoc Am|STRLEN|SvLEN|SV* sv
739 Returns the size of the string buffer in the SV, not including any part
740 attributable to C<SvOOK>. See C<SvCUR>.
742 =for apidoc Am|char*|SvEND|SV* sv
743 Returns a pointer to the spot just after the last character in
744 the string which is in the SV, where there is usually a trailing
745 null (even though Perl scalars do not strictly require it).
746 See C<SvCUR>. Access the character as *(SvEND(sv)).
748 Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
751 =for apidoc Am|HV*|SvSTASH|SV* sv
752 Returns the stash of the SV.
754 =for apidoc Am|void|SvIV_set|SV* sv|IV val
755 Set the value of the IV pointer in sv to val. It is possible to perform
756 the same function of this macro with an lvalue assignment to C<SvIVX>.
757 With future Perls, however, it will be more efficient to use
758 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
760 =for apidoc Am|void|SvNV_set|SV* sv|NV val
761 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
763 =for apidoc Am|void|SvPV_set|SV* sv|char* val
764 Set the value of the PV pointer in sv to val. See also C<SvIV_set>.
766 Beware that the existing pointer may be involved in copy-on-write or other
767 mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or
768 C<SvPV_force> (or check the SvIsCOW flag) first to make sure this
769 modification is safe.
771 =for apidoc Am|void|SvUV_set|SV* sv|UV val
772 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
774 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
775 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
777 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
778 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
780 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
781 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
783 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
784 Set the current length of the string which is in the SV. See C<SvCUR>
787 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
788 Set the actual length of the string which is in the SV. See C<SvIV_set>.
793 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
794 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
795 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
796 SVp_IOK|SVp_NOK|SVf_IVisUV))
798 #define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv))
799 #define assert_not_glob(sv) assert_(!isGV_with_GP(sv))
801 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK || isREGEXP(sv))
802 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
803 SvFLAGS(sv) &= ~(SVf_OK| \
804 SVf_IVisUV|SVf_UTF8), \
806 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
807 SvFLAGS(sv) &= ~(SVf_OK| \
811 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
812 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
813 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
814 SvFLAGS(sv) |= SVp_IOK)
815 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
816 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
817 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
818 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
819 SvFLAGS(sv) |= SVp_POK)
821 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
822 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
823 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
824 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
825 #define SvIOK_only(sv) (SvOK_off(sv), \
826 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
827 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
828 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
830 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
831 == (SVf_IOK|SVf_IVisUV))
832 #define SvUOK(sv) SvIOK_UV(sv)
833 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
836 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
837 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
838 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
840 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
841 #define SvNOK_on(sv) (assert_not_glob(sv) \
842 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
843 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
844 #define SvNOK_only(sv) (SvOK_off(sv), \
845 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
848 =for apidoc Am|U32|SvUTF8|SV* sv
849 Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
850 properly, this indicates whether or not the SV contains UTF-8 encoded data.
851 You should use this I<after> a call to SvPV() or one of its variants, in
852 case any call to string overloading updates the internal flag.
854 =for apidoc Am|void|SvUTF8_on|SV *sv
855 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
856 Do not use frivolously.
858 =for apidoc Am|void|SvUTF8_off|SV *sv
859 Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
860 Do not use frivolously.
862 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
863 Tells an SV that it is a string and disables all other OK bits,
864 and leaves the UTF-8 status as it was.
869 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
871 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
872 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
873 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
875 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
876 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
877 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
878 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
879 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
880 SvFLAGS(sv) &= ~(SVf_OK| \
881 SVf_IVisUV|SVf_UTF8), \
882 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
883 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
884 SvFLAGS(sv) &= ~(SVf_OK| \
886 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
888 #define SvVOK(sv) (SvMAGICAL(sv) \
889 && mg_find(sv,PERL_MAGIC_vstring))
890 /* returns the vstring magic, if any */
891 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
892 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
894 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
895 #define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
896 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
898 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
899 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
900 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
902 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
903 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
904 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
906 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
907 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
908 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
910 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
911 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
912 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
914 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
915 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
916 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
918 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
919 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
920 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
922 #define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
923 HvAMAGIC(SvSTASH(SvRV(sv))))
925 /* To be used on the stashes themselves: */
926 #define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
927 #define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
928 #define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
931 #define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
932 #define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
933 #define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
934 #define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
935 #define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
937 #define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
938 #define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
939 #define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
940 #define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
941 #define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
943 #define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
944 #define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
946 #define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
947 #define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
949 #define SvPOK_pure_nogthink(sv) \
950 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
951 #define SvPOK_utf8_pure_nogthink(sv) \
952 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
953 #define SvPOK_byte_pure_nogthink(sv) \
954 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
957 =for apidoc Am|U32|SvGAMAGIC|SV* sv
959 Returns true if the SV has get magic or
960 overloading. If either is true then
961 the scalar is active data, and has the potential to return a new value every
962 time it is accessed. Hence you must be careful to
963 only read it once per user logical operation and work
964 with that returned value. If neither is true then
965 the scalar's value cannot change unless written to.
970 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
972 #define Gv_AMG(stash) \
973 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
975 : (HvAMAGIC_off(stash), 0))
977 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
978 == (SVf_ROK|SVprv_WEAKREF))
979 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
980 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
982 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
983 == (SVf_ROK|SVprv_PCS_IMPORTED))
984 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
985 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
988 =for apidoc m|U32|SvTHINKFIRST|SV *sv
990 A quick flag check to see whether an sv should be passed to sv_force_normal
991 to be "downgraded" before SvIVX or SvPVX can be modified directly.
993 For example, if your scalar is a reference and you want to modify the SvIVX
994 slot, you can't just do SvROK_off, as that will leak the referent.
996 This is used internally by various sv-modifying functions, such as
997 sv_setsv, sv_setiv and sv_pvn_force.
999 One case that this does not handle is a gv without SvFAKE set. After
1001 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
1003 it will still be a gv.
1005 SvTHINKFIRST sometimes produces false positives. In those cases
1006 sv_force_normal does nothing.
1011 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
1013 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
1014 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
1016 /* SVs_PADTMP and SVs_PADSTALE share the same bit, mediated by SVs_PADMY */
1018 #define SvPADTMP(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP)) == SVs_PADTMP)
1019 #define SvPADSTALE(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADSTALE)) \
1020 == (SVs_PADMY|SVs_PADSTALE))
1022 #define SvPADTMP_on(sv) S_SvPADTMP_on(MUTABLE_SV(sv))
1023 #define SvPADTMP_off(sv) S_SvPADTMP_off(MUTABLE_SV(sv))
1024 #define SvPADSTALE_on(sv) S_SvPADSTALE_on(MUTABLE_SV(sv))
1025 #define SvPADSTALE_off(sv) S_SvPADSTALE_off(MUTABLE_SV(sv))
1027 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1028 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1029 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
1031 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1032 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1033 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
1035 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
1036 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1037 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1039 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
1040 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1041 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
1044 # define SvCOMPILED(sv) 0
1045 # define SvCOMPILED_on(sv)
1046 # define SvCOMPILED_off(sv)
1049 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1050 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1051 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1053 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1054 # define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
1055 if (SvFLAGS(_svvalid) & SVpbm_VALID) \
1056 assert(!isGV_with_GP(_svvalid)); \
1057 (SvFLAGS(_svvalid) & SVpbm_VALID); \
1059 # define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
1060 assert(!isGV_with_GP(_svvalid)); \
1061 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
1063 # define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
1064 assert(!isGV_with_GP(_svvalid)); \
1065 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
1068 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
1069 assert(SvTYPE(_svtail) != SVt_PVAV); \
1070 assert(SvTYPE(_svtail) != SVt_PVHV); \
1071 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1072 == (SVpbm_TAIL|SVpbm_VALID); \
1075 # define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
1076 # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1077 # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
1078 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1079 == (SVpbm_TAIL|SVpbm_VALID))
1082 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1083 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1086 #define SvPAD_TYPED(sv) \
1087 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1089 #define SvPAD_OUR(sv) \
1090 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1092 #define SvPAD_STATE(sv) \
1093 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1095 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1096 # define SvPAD_TYPED_on(sv) ({ \
1097 SV *const _svpad = MUTABLE_SV(sv); \
1098 assert(SvTYPE(_svpad) == SVt_PVMG); \
1099 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \
1101 #define SvPAD_OUR_on(sv) ({ \
1102 SV *const _svpad = MUTABLE_SV(sv); \
1103 assert(SvTYPE(_svpad) == SVt_PVMG); \
1104 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \
1106 #define SvPAD_STATE_on(sv) ({ \
1107 SV *const _svpad = MUTABLE_SV(sv); \
1108 assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
1109 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \
1112 # define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1113 # define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1114 # define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1117 #define SvOURSTASH(sv) \
1118 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1119 #define SvOURSTASH_set(sv, st) \
1121 assert(SvTYPE(sv) == SVt_PVMG); \
1122 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1125 #define SvRVx(sv) SvRV(sv)
1127 #ifdef PERL_DEBUG_COW
1128 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1129 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1130 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1131 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1132 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1133 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1134 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1135 /* Don't test the core XS code yet. */
1136 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1137 # define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
1139 # define SvPVX(sv) SvPVX_mutable(sv)
1141 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1142 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1143 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1145 # define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1146 # define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
1148 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1149 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1151 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1152 /* These get expanded inside other macros that already use a variable _sv */
1153 # define SvPVX(sv) \
1154 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1155 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
1156 assert(!isGV_with_GP(_svpvx)); \
1157 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1158 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
1159 &((_svpvx)->sv_u.svu_pv); \
1161 # define SvCUR(sv) \
1162 (*({ const SV *const _svcur = (const SV *)(sv); \
1163 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK] \
1164 || SvTYPE(_svcur) == SVt_REGEXP); \
1165 assert(!isGV_with_GP(_svcur)); \
1166 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1167 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1168 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1170 # define SvIVX(sv) \
1171 (*({ const SV *const _svivx = (const SV *)(sv); \
1172 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
1173 assert(!isGV_with_GP(_svivx)); \
1174 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1176 # define SvUVX(sv) \
1177 (*({ const SV *const _svuvx = (const SV *)(sv); \
1178 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
1179 assert(!isGV_with_GP(_svuvx)); \
1180 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1182 # define SvNVX(sv) \
1183 (*({ const SV *const _svnvx = (const SV *)(sv); \
1184 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
1185 assert(!isGV_with_GP(_svnvx)); \
1186 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1189 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1190 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1191 assert(!isGV_with_GP(_svrv)); \
1192 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1193 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1194 &((_svrv)->sv_u.svu_rv); \
1196 # define SvRV_const(sv) \
1197 ({ const SV *const _svrv = (const SV *)(sv); \
1198 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
1199 assert(!isGV_with_GP(_svrv)); \
1200 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1201 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1202 (_svrv)->sv_u.svu_rv; \
1204 # define SvMAGIC(sv) \
1205 (*({ const SV *const _svmagic = (const SV *)(sv); \
1206 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1207 if(SvTYPE(_svmagic) == SVt_PVMG) \
1208 assert(!SvPAD_OUR(_svmagic)); \
1209 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1211 # define SvSTASH(sv) \
1212 (*({ const SV *const _svstash = (const SV *)(sv); \
1213 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1214 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1217 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1218 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1219 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1220 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1221 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1222 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1223 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1224 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1225 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1230 /* Given that these two are new, there can't be any existing code using them
1232 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1233 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1235 /* Except for the poison code, which uses & to scribble over the pointer after
1236 free() is called. */
1237 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1238 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1241 #define SvIVXx(sv) SvIVX(sv)
1242 #define SvUVXx(sv) SvUVX(sv)
1243 #define SvNVXx(sv) SvNVX(sv)
1244 #define SvPVXx(sv) SvPVX(sv)
1245 #define SvLENx(sv) SvLEN(sv)
1246 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1249 /* Ask a scalar nicely to try to become an IV, if possible.
1250 Not guaranteed to stay returning void */
1251 /* Macro won't actually call sv_2iv if already IOK */
1252 #define SvIV_please(sv) \
1253 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1254 (void) SvIV(sv); } STMT_END
1255 #define SvIV_please_nomg(sv) \
1256 (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv)) \
1257 ? (SvIV_nomg(sv), SvIOK(sv)) \
1259 #define SvIV_set(sv, val) \
1261 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1262 assert(!isGV_with_GP(sv)); \
1263 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1264 #define SvNV_set(sv, val) \
1266 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
1267 assert(!isGV_with_GP(sv)); \
1268 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1269 #define SvPV_set(sv, val) \
1271 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1272 assert(!isGV_with_GP(sv)); \
1273 assert(!(SvTYPE(sv) == SVt_PVIO \
1274 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1275 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1276 #define SvUV_set(sv, val) \
1278 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
1279 assert(!isGV_with_GP(sv)); \
1280 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1281 #define SvRV_set(sv, val) \
1283 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
1284 assert(!isGV_with_GP(sv)); \
1285 assert(!(SvTYPE(sv) == SVt_PVIO \
1286 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1287 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1288 #define SvMAGIC_set(sv, val) \
1289 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1290 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1291 #define SvSTASH_set(sv, val) \
1292 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1293 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1294 #define SvCUR_set(sv, val) \
1296 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK] \
1297 || SvTYPE(sv) == SVt_REGEXP); \
1298 assert(!isGV_with_GP(sv)); \
1299 assert(!(SvTYPE(sv) == SVt_PVIO \
1300 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1301 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1302 #define SvLEN_set(sv, val) \
1304 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
1305 assert(!isGV_with_GP(sv)); \
1306 assert(!(SvTYPE(sv) == SVt_PVIO \
1307 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1308 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1309 #define SvEND_set(sv, val) \
1310 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1311 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1313 #define SvPV_renew(sv,n) \
1314 STMT_START { SvLEN_set(sv, n); \
1315 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1316 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1317 (MEM_SIZE)((n))))); \
1320 #define SvPV_shrink_to_cur(sv) STMT_START { \
1321 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1322 SvPV_renew(sv, _lEnGtH); \
1325 #define SvPV_free(sv) \
1327 assert(SvTYPE(sv) >= SVt_PV); \
1329 assert(!SvROK(sv)); \
1332 SvOOK_offset(sv, zok); \
1333 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1334 SvFLAGS(sv) &= ~SVf_OOK; \
1336 Safefree(SvPVX(sv)); \
1341 /* Code that crops up in three places to take a scalar and ready it to hold
1343 # define prepare_SV_for_RV(sv) \
1345 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1346 sv_upgrade(sv, SVt_IV); \
1347 else if (SvTYPE(sv) >= SVt_PV) { \
1356 # define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1359 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1360 # define BmUSEFUL(sv) \
1361 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1362 assert(SvTYPE(_bmuseful) == SVt_PVMG); \
1363 assert(SvVALID(_bmuseful)); \
1364 assert(!SvNOK(_bmuseful)); \
1365 &(((XPVMG*) SvANY(_bmuseful))->xnv_u.xbm_useful); \
1368 # define BmUSEFUL(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_useful
1373 # define BmRARE(sv) 0
1374 # define BmPREVIOUS(sv) 0
1377 #define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1379 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1380 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1381 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1382 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1383 #define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
1385 #define IoIFP(sv) (sv)->sv_u.svu_fp
1386 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1387 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1388 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1389 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
1390 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1391 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1392 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1393 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1394 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1395 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1396 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1397 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1398 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1399 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1400 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1402 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1403 #define IoTYPE_RDONLY '<'
1404 #define IoTYPE_WRONLY '>'
1405 #define IoTYPE_RDWR '+'
1406 #define IoTYPE_APPEND 'a'
1407 #define IoTYPE_PIPE '|'
1408 #define IoTYPE_STD '-' /* stdin or stdout */
1409 #define IoTYPE_SOCKET 's'
1410 #define IoTYPE_CLOSED ' '
1411 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1412 #define IoTYPE_NUMERIC '#' /* fdopen */
1415 =for apidoc Am|bool|SvTAINTED|SV* sv
1416 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1419 =for apidoc Am|void|SvTAINTED_on|SV* sv
1420 Marks an SV as tainted if tainting is enabled.
1422 =for apidoc Am|void|SvTAINTED_off|SV* sv
1423 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1424 some of Perl's fundamental security features. XS module authors should not
1425 use this function unless they fully understand all the implications of
1426 unconditionally untainting the value. Untainting should be done in the
1427 standard perl fashion, via a carefully crafted regexp, rather than directly
1428 untainting variables.
1430 =for apidoc Am|void|SvTAINT|SV* sv
1431 Taints an SV if tainting is enabled, and if some input to the current
1432 expression is tainted--usually a variable, but possibly also implicit
1433 inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1434 the outputs of an expression in a pessimistic fashion; i.e., without paying
1435 attention to precisely which outputs are influenced by which inputs.
1440 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1442 #if NO_TAINT_SUPPORT
1443 # define SvTAINTED(sv) 0
1445 # define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1447 #define SvTAINTED_on(sv) STMT_START{ if(TAINTING_get){sv_taint(sv);} }STMT_END
1448 #define SvTAINTED_off(sv) STMT_START{ if(TAINTING_get){sv_untaint(sv);} }STMT_END
1450 #define SvTAINT(sv) \
1452 if (TAINTING_get) { \
1459 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1460 Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1461 only a string (C<SvPOK_only>), by hook or by crook. You need force if you are
1462 going to update the C<SvPVX> directly. Processes get magic.
1464 Note that coercing an arbitrary scalar into a plain PV will potentially
1465 strip useful data from it. For example if the SV was C<SvROK>, then the
1466 referent will have its reference count decremented, and the SV itself may
1467 be converted to an C<SvPOK> scalar with a string buffer containing a value
1468 such as C<"ARRAY(0x1234)">.
1470 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1471 Like C<SvPV_force>, but doesn't process get magic.
1473 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1474 Returns a pointer to the string in the SV, or a stringified form of
1475 the SV if the SV does not contain a string. The SV may cache the
1476 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1477 C<SvPVx> for a version which guarantees to evaluate sv only once.
1479 Note that there is no guarantee that the return value of C<SvPV()> is
1480 equal to C<SvPVX(sv)>, or that C<SvPVX(sv)> contains valid data, or that
1481 successive calls to C<SvPV(sv)> will return the same pointer value each
1482 time. This is due to the way that things like overloading and
1483 Copy-On-Write are handled. In these cases, the return value may point to
1484 a temporary buffer or similar. If you absolutely need the SvPVX field to
1485 be valid (for example, if you intend to write to it), then see
1488 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1489 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1490 Only use this if C<sv> is an expression with side effects, otherwise use the
1491 more efficient C<SvPV>.
1493 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1494 Like C<SvPV> but doesn't process magic.
1496 =for apidoc Am|char*|SvPV_nolen|SV* sv
1497 Like C<SvPV> but doesn't set a length variable.
1499 =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1500 Like C<SvPV_nolen> but doesn't process magic.
1502 =for apidoc Am|IV|SvIV|SV* sv
1503 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1504 version which guarantees to evaluate sv only once.
1506 =for apidoc Am|IV|SvIV_nomg|SV* sv
1507 Like C<SvIV> but doesn't process magic.
1509 =for apidoc Am|IV|SvIVx|SV* sv
1510 Coerces the given SV to an integer and returns it.
1511 Guarantees to evaluate C<sv> only once. Only use
1512 this if C<sv> is an expression with side effects,
1513 otherwise use the more efficient C<SvIV>.
1515 =for apidoc Am|NV|SvNV|SV* sv
1516 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1517 which guarantees to evaluate sv only once.
1519 =for apidoc Am|NV|SvNV_nomg|SV* sv
1520 Like C<SvNV> but doesn't process magic.
1522 =for apidoc Am|NV|SvNVx|SV* sv
1523 Coerces the given SV to a double and returns it.
1524 Guarantees to evaluate C<sv> only once. Only use
1525 this if C<sv> is an expression with side effects,
1526 otherwise use the more efficient C<SvNV>.
1528 =for apidoc Am|UV|SvUV|SV* sv
1529 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1530 for a version which guarantees to evaluate sv only once.
1532 =for apidoc Am|UV|SvUV_nomg|SV* sv
1533 Like C<SvUV> but doesn't process magic.
1535 =for apidoc Am|UV|SvUVx|SV* sv
1536 Coerces the given SV to an unsigned integer and
1537 returns it. Guarantees to evaluate C<sv> only once. Only
1538 use this if C<sv> is an expression with side effects,
1539 otherwise use the more efficient C<SvUV>.
1541 =for apidoc Am|bool|SvTRUE|SV* sv
1542 Returns a boolean indicating whether Perl would evaluate the SV as true or
1543 false. See SvOK() for a defined/undefined test. Handles 'get' magic
1544 unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
1547 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
1548 Returns a boolean indicating whether Perl would evaluate the SV as true or
1549 false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
1551 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1552 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1554 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1555 Like C<SvPV>, but converts sv to utf8 first if necessary.
1557 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1558 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1560 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1561 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1563 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1564 Like C<SvPV>, but converts sv to byte representation first if necessary.
1566 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1567 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1569 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1570 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1571 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1574 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1575 Like C<SvPV>, but converts sv to utf8 first if necessary.
1576 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1579 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1580 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1581 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1584 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1585 Like C<SvPV>, but converts sv to byte representation first if necessary.
1586 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1589 =for apidoc Am|bool|SvIsCOW|SV* sv
1590 Returns a boolean indicating whether the SV is Copy-On-Write (either shared
1591 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1594 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1595 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1598 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1599 Like C<sv_catpvn> but doesn't process magic.
1601 =for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1602 Like C<sv_catpv> but doesn't process magic.
1604 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1605 Like C<sv_setsv> but doesn't process magic.
1607 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1608 Like C<sv_catsv> but doesn't process magic.
1610 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1612 Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
1617 /* Let us hope that bitmaps for UV and IV are the same */
1618 #define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1619 #define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1620 #define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
1622 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1623 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1624 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1628 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1629 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1630 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1632 #define SvPV_flags(sv, lp, flags) \
1634 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1635 #define SvPV_flags_const(sv, lp, flags) \
1637 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1638 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1639 #define SvPV_flags_const_nolen(sv, flags) \
1641 ? SvPVX_const(sv) : \
1642 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1643 #define SvPV_flags_mutable(sv, lp, flags) \
1645 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1646 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1648 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1649 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1650 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1652 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1653 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1655 #define SvPV_force_flags(sv, lp, flags) \
1656 (SvPOK_pure_nogthink(sv) \
1657 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1659 #define SvPV_force_flags_nolen(sv, flags) \
1660 (SvPOK_pure_nogthink(sv) \
1661 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1663 #define SvPV_force_flags_mutable(sv, lp, flags) \
1664 (SvPOK_pure_nogthink(sv) \
1665 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1666 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1668 #define SvPV_nolen(sv) \
1670 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1672 #define SvPV_nomg_nolen(sv) \
1674 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1676 #define SvPV_nolen_const(sv) \
1678 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1680 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1681 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1682 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1686 #define SvPVutf8(sv, lp) \
1687 (SvPOK_utf8_nog(sv) \
1688 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1690 #define SvPVutf8_force(sv, lp) \
1691 (SvPOK_utf8_pure_nogthink(sv) \
1692 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1694 #define SvPVutf8_nolen(sv) \
1695 (SvPOK_utf8_nog(sv) \
1696 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1700 #define SvPVbyte(sv, lp) \
1701 (SvPOK_byte_nog(sv) \
1702 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1704 #define SvPVbyte_force(sv, lp) \
1705 (SvPOK_byte_pure_nogthink(sv) \
1706 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1708 #define SvPVbyte_nolen(sv) \
1709 (SvPOK_byte_nog(sv) \
1710 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1713 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1714 * var to evaluate the arg once; failing that, use a global if possible;
1715 * failing that, call a function to do the work
1718 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1719 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1720 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1722 #define SvTRUE(sv) ((sv) && (SvGMAGICAL(sv) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))))
1723 #define SvTRUE_nomg(sv) ((sv) && ( SvTRUE_common(sv, sv_2bool_nomg(sv))))
1724 #define SvTRUE_NN(sv) (SvGMAGICAL(sv) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv)))
1725 #define SvTRUE_nomg_NN(sv) ( SvTRUE_common(sv, sv_2bool_nomg(sv)))
1726 #define SvTRUE_common(sv,fallback) ( \
1731 : (SvFLAGS(sv) & (SVf_IOK|SVf_NOK)) \
1732 ? ( (SvIOK(sv) && SvIVX(sv) != 0) \
1733 || (SvNOK(sv) && SvNVX(sv) != 0.0)) \
1736 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1738 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1739 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1740 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1741 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1742 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1743 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1744 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1745 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1746 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1747 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1748 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1749 # define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
1751 #else /* __GNUC__ */
1753 /* These inlined macros use globals, which will require a thread
1754 * declaration in user code, so we avoid them under threads */
1756 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1757 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1758 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1759 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1760 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1761 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1762 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1763 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1764 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1765 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1766 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1767 # define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
1768 #endif /* __GNU__ */
1770 #define SvPVXtrue(sv) ( \
1771 ((XPV*)SvANY((sv))) \
1773 ((XPV*)SvANY((sv)))->xpv_cur > 1 \
1775 ((XPV*)SvANY((sv)))->xpv_cur \
1776 && *(sv)->sv_u.svu_pv != '0' \
1781 #define SvIsCOW(sv) (SvFLAGS(sv) & SVf_IsCOW)
1782 #define SvIsCOW_on(sv) (SvFLAGS(sv) |= SVf_IsCOW)
1783 #define SvIsCOW_off(sv) (SvFLAGS(sv) &= ~SVf_IsCOW)
1784 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1786 #define SvSHARED_HEK_FROM_PV(pvx) \
1787 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1788 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1790 /* flag values for sv_*_flags functions */
1791 #define SV_IMMEDIATE_UNREF 1
1793 #define SV_COW_DROP_PV 4
1794 #define SV_UTF8_NO_ENCODING 8
1795 #define SV_NOSTEAL 16
1796 #define SV_CONST_RETURN 32
1797 #define SV_MUTABLE_RETURN 64
1798 #define SV_SMAGIC 128
1799 #define SV_HAS_TRAILING_NUL 256
1800 #define SV_COW_SHARED_HASH_KEYS 512
1801 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1802 #define SV_COW_OTHER_PVS 1024
1803 /* Make sv_2pv_flags return NULL if something is undefined. */
1804 #define SV_UNDEF_RETURNS_NULL 2048
1805 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1806 * This is used when the caller has already determined it is, and avoids
1808 #define SV_FORCE_UTF8_UPGRADE 4096
1809 /* if (after resolving magic etc), the SV is found to be overloaded,
1810 * don't call the overload magic, just return as-is */
1811 #define SV_SKIP_OVERLOAD 8192
1812 /* It is not yet clear whether we want this as an API, or what the
1813 * constants should be named. */
1815 # define SV_CATBYTES 16384
1816 # define SV_CATUTF8 32768
1819 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1820 So only default to doing the COW setup if we're in the core.
1823 # ifndef SV_DO_COW_SVSETSV
1824 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1828 #ifndef SV_DO_COW_SVSETSV
1829 # define SV_DO_COW_SVSETSV 0
1833 #define sv_unref(sv) sv_unref_flags(sv, 0)
1834 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1835 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1836 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1838 /* We are about to replace the SV's current value. So if it's copy on write
1839 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1840 the value is about to get thrown away, so drop the PV rather than go to
1841 the effort of making a read-write copy only for it to get immediately
1844 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1845 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1847 #ifdef PERL_OLD_COPY_ON_WRITE
1848 #define SvRELEASE_IVX(sv) \
1849 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1850 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1851 # define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
1852 # define SvCANCOW(sv) \
1853 (SvIsCOW(sv) || (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS)
1854 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
1856 # define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1857 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1858 SVf_OOK|SVf_BREAK|SVf_READONLY)
1860 # define SvRELEASE_IVX(sv) 0
1861 /* This little game brought to you by the need to shut this warning up:
1862 mg.c: In function 'Perl_magic_get':
1863 mg.c:1024: warning: left-hand operand of comma expression has no effect
1865 # define SvRELEASE_IVX_(sv) /**/
1866 # ifdef PERL_NEW_COPY_ON_WRITE
1867 # define SvCANCOW(sv) \
1869 ? SvLEN(sv) ? CowREFCNT(sv) != SV_COW_REFCNT_MAX : 1 \
1870 : (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS \
1871 && SvCUR(sv)+1 < SvLEN(sv))
1872 /* Note: To allow 256 COW "copies", a refcnt of 0 means 1. */
1873 # define CowREFCNT(sv) (*(U8 *)(SvPVX(sv)+SvLEN(sv)-1))
1874 # define SV_COW_REFCNT_MAX ((1 << sizeof(U8)*8) - 1)
1875 # ifndef SV_COW_THRESHOLD
1876 # define SV_COW_THRESHOLD 0 /* min string length for cow */
1878 # ifndef SV_COWBUF_THRESHOLD
1879 # define SV_COWBUF_THRESHOLD 1250 /* min string length for cow */
1880 # endif /* over existing buffer */
1881 # define CAN_COW_MASK (SVf_POK|SVf_ROK|SVp_POK|SVf_FAKE| \
1882 SVf_OOK|SVf_BREAK|SVf_READONLY)
1884 #endif /* PERL_OLD_COPY_ON_WRITE */
1886 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1888 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1889 sv_force_normal_flags(sv, 0)
1892 /* all these 'functions' are now just macros */
1894 #define sv_pv(sv) SvPV_nolen(sv)
1895 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1896 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1898 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1899 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1900 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1901 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1902 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
1903 #define sv_setsv(dsv, ssv) \
1904 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1905 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1906 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1907 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1908 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1909 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1910 #define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1911 #define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
1912 #define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
1913 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1914 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1915 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1916 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1917 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1918 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1919 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1920 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1921 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1922 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1923 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1924 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1925 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
1926 #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
1927 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
1928 #define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
1929 #define sv_insert(bigstr, offset, len, little, littlelen) \
1930 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1931 (littlelen), SV_GMAGIC)
1932 #define sv_mortalcopy(sv) \
1933 Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1935 /* Should be named SvCatPVN_utf8_upgrade? */
1936 #define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
1939 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
1941 sv_setpvn(nsv, sstr, slen); \
1943 sv_utf8_upgrade(nsv); \
1944 sv_catsv_nomg(dsv, nsv); \
1946 #define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \
1947 sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES)
1950 # define sv_or_pv_len_utf8(sv, pv, bytelen) \
1952 ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \
1954 # define sv_or_pv_pos_u2b(sv,s,p,lp) S_sv_or_pv_pos_u2b(aTHX_ sv,s,p,lp)
1958 =for apidoc Am|SV*|newRV_inc|SV* sv
1960 Creates an RV wrapper for an SV. The reference count for the original SV is
1966 #define newRV_inc(sv) newRV(sv)
1968 /* the following macros update any magic values this sv is associated with */
1971 =head1 Magical Functions
1973 =for apidoc Am|void|SvGETMAGIC|SV* sv
1974 Invokes C<mg_get> on an SV if it has 'get' magic. For example, this
1975 will call C<FETCH> on a tied variable. This macro evaluates its
1976 argument more than once.
1978 =for apidoc Am|void|SvSETMAGIC|SV* sv
1979 Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary
1980 after modifying a scalar, in case it is a magical variable like C<$|>
1981 or a tied variable (it calls C<STORE>). This macro evaluates its
1982 argument more than once.
1984 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1985 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1988 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1989 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1990 ssv. May evaluate arguments more than once.
1992 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1993 Like C<SvSetSV>, but does any set magic required afterwards.
1995 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1996 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1998 =for apidoc Am|void|SvSHARE|SV* sv
1999 Arranges for sv to be shared between threads if a suitable module
2002 =for apidoc Am|void|SvLOCK|SV* sv
2003 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2006 =for apidoc Am|void|SvUNLOCK|SV* sv
2007 Releases a mutual exclusion lock on sv if a suitable module
2010 =head1 SV Manipulation Functions
2012 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
2013 Expands the character buffer in the SV so that it has room for the
2014 indicated number of bytes (remember to reserve space for an extra trailing
2015 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
2016 Returns a pointer to the character buffer. SV must be of type >= SVt_PV. One
2017 alternative is to call C<sv_grow> if you are not sure of the type of SV.
2022 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
2023 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
2024 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
2025 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
2027 #define SvGETMAGIC(x) ((void)(SvGMAGICAL(x) && mg_get(x)))
2028 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
2030 #define SvSetSV_and(dst,src,finally) \
2032 if ((dst) != (src)) { \
2033 sv_setsv(dst, src); \
2037 #define SvSetSV_nosteal_and(dst,src,finally) \
2039 if ((dst) != (src)) { \
2040 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
2045 #define SvSetSV(dst,src) \
2046 SvSetSV_and(dst,src,/*nothing*/;)
2047 #define SvSetSV_nosteal(dst,src) \
2048 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
2050 #define SvSetMagicSV(dst,src) \
2051 SvSetSV_and(dst,src,SvSETMAGIC(dst))
2052 #define SvSetMagicSV_nosteal(dst,src) \
2053 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
2056 #if !defined(SKIP_DEBUGGING)
2057 #define SvPEEK(sv) sv_peek(sv)
2059 #define SvPEEK(sv) ""
2062 #define SvIMMORTAL(sv) (SvREADONLY(sv) && ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder))
2065 /* exercise the immortal resurrection code in sv_free2() */
2066 # define SvREFCNT_IMMORTAL 1000
2068 # define SvREFCNT_IMMORTAL ((~(U32)0)/2)
2072 =for apidoc Am|SV *|boolSV|bool b
2074 Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
2076 See also C<PL_sv_yes> and C<PL_sv_no>.
2081 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
2083 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
2084 /* If I give every macro argument a different name, then there won't be bugs
2085 where nested macros get confused. Been there, done that. */
2086 #define isGV_with_GP(pwadak) \
2087 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
2088 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2089 #define isGV_with_GP_on(sv) STMT_START { \
2090 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2091 assert (!SvPOKp(sv)); \
2092 assert (!SvIOKp(sv)); \
2093 (SvFLAGS(sv) |= SVpgv_GP); \
2095 #define isGV_with_GP_off(sv) STMT_START { \
2096 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2097 assert (!SvPOKp(sv)); \
2098 assert (!SvIOKp(sv)); \
2099 (SvFLAGS(sv) &= ~SVpgv_GP); \
2101 #define isREGEXP(sv) \
2102 (SvTYPE(sv) == SVt_REGEXP \
2103 || (SvFLAGS(sv) & (SVTYPEMASK|SVp_POK|SVpgv_GP|SVf_FAKE)) \
2104 == (SVt_PVLV|SVf_FAKE))
2107 #ifdef PERL_NEW_COPY_ON_WRITE
2108 # define SvGROW(sv,len) \
2109 (SvIsCOW(sv) || SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2111 # define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2113 #define SvGROW_mutable(sv,len) \
2114 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2115 #define Sv_Grow sv_grow
2117 #define CLONEf_COPY_STACKS 1
2118 #define CLONEf_KEEP_PTR_TABLE 2
2119 #define CLONEf_CLONE_HOST 4
2120 #define CLONEf_JOIN_IN 8
2122 struct clone_params {
2125 PerlInterpreter *proto_perl;
2126 PerlInterpreter *new_perl;
2131 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2133 Creates a new SV and copies a string into it. If utf8 is true, calls
2134 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2139 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2142 =for apidoc Amx|SV*|newSVpadname|PADNAME *pn
2144 Creates a new SV containing the pad name. This is currently identical
2145 to C<newSVsv>, but pad names may cease being SVs at some point, so
2146 C<newSVpadname> is preferable.
2151 #define newSVpadname(pn) newSVsv(pn)
2154 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2156 Reads into I<len> the offset from SvPVX back to the true start of the
2157 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2158 efficiently remove characters from start of the buffer. Implemented as a
2159 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
2160 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
2166 /* Does the bot know something I don't?
2167 10:28 <@Nicholas> metabatman
2168 10:28 <+meta> Nicholas: crash
2170 # define SvOOK_offset(sv, offset) STMT_START { \
2171 assert(sizeof(offset) == sizeof(STRLEN)); \
2173 const U8 *_crash = (U8*)SvPVX_const(sv); \
2174 (offset) = *--_crash; \
2176 _crash -= sizeof(STRLEN); \
2177 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
2180 /* Validate the preceding buffer's sentinels to \
2181 verify that no-one is using it. */ \
2182 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2183 while (_crash > _bonk) { \
2185 assert (*_crash == (U8)PTR2UV(_crash)); \
2193 /* This is the same code, but avoids using any temporary variables: */
2194 # define SvOOK_offset(sv, offset) STMT_START { \
2195 assert(sizeof(offset) == sizeof(STRLEN)); \
2197 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2199 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2200 (U8*)&(offset), sizeof(STRLEN), U8); \
2208 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2210 #define SV_CONST(name) \
2211 PL_sv_consts[SV_CONST_##name] \
2212 ? PL_sv_consts[SV_CONST_##name] \
2213 : (PL_sv_consts[SV_CONST_##name] = newSVpv_share(#name, 0))
2215 #define SV_CONST_TIESCALAR 0
2216 #define SV_CONST_TIEARRAY 1
2217 #define SV_CONST_TIEHASH 2
2218 #define SV_CONST_TIEHANDLE 3
2220 #define SV_CONST_FETCH 4
2221 #define SV_CONST_FETCHSIZE 5
2222 #define SV_CONST_STORE 6
2223 #define SV_CONST_STORESIZE 7
2224 #define SV_CONST_EXISTS 8
2226 #define SV_CONST_PUSH 9
2227 #define SV_CONST_POP 10
2228 #define SV_CONST_SHIFT 11
2229 #define SV_CONST_UNSHIFT 12
2230 #define SV_CONST_SPLICE 13
2231 #define SV_CONST_EXTEND 14
2233 #define SV_CONST_FIRSTKEY 15
2234 #define SV_CONST_NEXTKEY 16
2235 #define SV_CONST_SCALAR 17
2237 #define SV_CONST_OPEN 18
2238 #define SV_CONST_WRITE 19
2239 #define SV_CONST_PRINT 20
2240 #define SV_CONST_PRINTF 21
2241 #define SV_CONST_READ 22
2242 #define SV_CONST_READLINE 23
2243 #define SV_CONST_GETC 24
2244 #define SV_CONST_SEEK 25
2245 #define SV_CONST_TELL 26
2246 #define SV_CONST_EOF 27
2247 #define SV_CONST_BINMODE 28
2248 #define SV_CONST_FILENO 29
2249 #define SV_CONST_CLOSE 30
2251 #define SV_CONST_DELETE 31
2252 #define SV_CONST_CLEAR 32
2253 #define SV_CONST_UNTIE 33
2254 #define SV_CONST_DESTROY 34
2256 #define SV_CONSTS_COUNT 35
2260 * c-indentation-style: bsd
2262 * indent-tabs-mode: nil
2265 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob