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.
22 =for apidoc AmU||SVt_PV
23 Pointer type flag for scalars. See C<svtype>.
25 =for apidoc AmU||SVt_IV
26 Integer type flag for scalars. See C<svtype>.
28 =for apidoc AmU||SVt_NV
29 Double type flag for scalars. See C<svtype>.
31 =for apidoc AmU||SVt_PVMG
32 Type flag for blessed scalars. See C<svtype>.
34 =for apidoc AmU||SVt_PVAV
35 Type flag for arrays. See C<svtype>.
37 =for apidoc AmU||SVt_PVHV
38 Type flag for hashes. See C<svtype>.
40 =for apidoc AmU||SVt_PVCV
41 Type flag for code refs. See C<svtype>.
51 /* RV was here, before it was merged with IV. */
57 /* PVBM was here, before BIND replaced it. */
65 SVt_LAST /* keep last in enum. used to size arrays */
69 /* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
70 purposes eternal code wanting to consider PVBM probably needs to think of
72 # define SVt_PVBM SVt_PVMG
73 /* Anything wanting to create a reference from clean should ensure that it has
74 a scalar of type SVt_IV now: */
75 # define SVt_RV SVt_IV
78 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
79 so never reaches the clause at the end that uses sv_type_details->body_size
80 to determine whether to call safefree(). Hence body_size can be set
81 non-zero to record the size of HEs, without fear of bogus frees. */
82 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
83 #define HE_SVSLOT SVt_NULL
86 #define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
88 /* typedefs to eliminate some typing */
90 typedef struct hek HEK;
92 /* Using C's structural equivalence to help emulate C++ inheritance here... */
94 /* start with 2 sv-head building blocks */
95 #define _SV_HEAD(ptrtype) \
96 ptrtype sv_any; /* pointer to body */ \
97 U32 sv_refcnt; /* how many references to us */ \
98 U32 sv_flags /* what we are */
100 #define _SV_HEAD_UNION \
102 char* svu_pv; /* pointer to malloced string */ \
105 SV* svu_rv; /* pointer to another SV */ \
113 struct STRUCT_SV { /* struct sv { */
116 #ifdef DEBUG_LEAKING_SCALARS
117 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */
118 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */
119 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */
120 UV sv_debug_serial; /* serial number of sv allocation */
121 char * sv_debug_file; /* the file where we were allocated */
122 SV * sv_debug_parent; /* what we were cloned from (ithreads)*/
127 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
132 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
137 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
142 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
147 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
152 _SV_HEAD(struct regexp*); /* pointer to regexp body */
157 #undef _SV_HEAD_UNION /* ensure no pollution */
160 =head1 SV Manipulation Functions
162 =for apidoc Am|U32|SvREFCNT|SV* sv
163 Returns the value of the object's reference count.
165 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
166 Increments the reference count of the given SV.
168 All of the following SvREFCNT_inc* macros are optimized versions of
169 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
171 =for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
172 Same as SvREFCNT_inc, but can only be used if you know I<sv>
173 is not NULL. Since we don't have to check the NULLness, it's faster
176 =for apidoc Am|void|SvREFCNT_inc_void|SV* sv
177 Same as SvREFCNT_inc, but can only be used if you don't need the
178 return value. The macro doesn't need to return a meaningful value.
180 =for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
181 Same as SvREFCNT_inc, but can only be used if you don't need the return
182 value, and you know that I<sv> is not NULL. The macro doesn't need
183 to return a meaningful value, or check for NULLness, so it's smaller
186 =for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
187 Same as SvREFCNT_inc, but can only be used with expressions without side
188 effects. Since we don't have to store a temporary value, it's faster.
190 =for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
191 Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
192 is not NULL. Since we don't have to check the NULLness, it's faster
195 =for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
196 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
197 return value. The macro doesn't need to return a meaningful value.
199 =for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
200 Same as SvREFCNT_inc, but can only be used if you don't need the return
201 value, and you know that I<sv> is not NULL. The macro doesn't need
202 to return a meaningful value, or check for NULLness, so it's smaller
205 =for apidoc Am|void|SvREFCNT_dec|SV* sv
206 Decrements the reference count of the given SV.
208 =for apidoc Am|svtype|SvTYPE|SV* sv
209 Returns the type of the SV. See C<svtype>.
211 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
212 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
213 perform the upgrade if necessary. See C<svtype>.
218 #define SvANY(sv) (sv)->sv_any
219 #define SvFLAGS(sv) (sv)->sv_flags
220 #define SvREFCNT(sv) (sv)->sv_refcnt
222 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
223 # define SvREFCNT_inc(sv) \
225 SV * const _sv = MUTABLE_SV(sv); \
230 # define SvREFCNT_inc_simple(sv) \
236 # define SvREFCNT_inc_NN(sv) \
238 SV * const _sv = MUTABLE_SV(sv); \
242 # define SvREFCNT_inc_void(sv) \
244 SV * const _sv = MUTABLE_SV(sv); \
246 (void)(SvREFCNT(_sv)++); \
249 # define SvREFCNT_inc(sv) \
250 ((PL_Sv=MUTABLE_SV(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
251 # define SvREFCNT_inc_simple(sv) \
252 ((sv) ? (SvREFCNT(sv)++,MUTABLE_SV(sv)) : NULL)
253 # define SvREFCNT_inc_NN(sv) \
254 (PL_Sv=MUTABLE_SV(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
255 # define SvREFCNT_inc_void(sv) \
256 (void)((PL_Sv=MUTABLE_SV(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
259 /* These guys don't need the curly blocks */
260 #define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
261 #define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
262 #define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
263 #define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
265 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
266 # define SvREFCNT_dec(sv) \
268 SV * const _sv = MUTABLE_SV(sv); \
270 if (SvREFCNT(_sv)) { \
271 if (--(SvREFCNT(_sv)) == 0) \
272 Perl_sv_free2(aTHX_ _sv); \
279 #define SvREFCNT_dec(sv) sv_free(MUTABLE_SV(sv))
282 #define SVTYPEMASK 0xff
283 #define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
285 /* Sadly there are some parts of the core that have pointers to already-freed
286 SV heads, and rely on being able to tell that they are now free. So mark
287 them all by using a consistent macro. */
288 #define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
290 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
292 #define SVf_IOK 0x00000100 /* has valid public integer value */
293 #define SVf_NOK 0x00000200 /* has valid public numeric value */
294 #define SVf_POK 0x00000400 /* has valid public pointer value */
295 #define SVf_ROK 0x00000800 /* has a valid reference pointer */
297 #define SVp_IOK 0x00001000 /* has valid non-public integer value */
298 #define SVp_NOK 0x00002000 /* has valid non-public numeric value */
299 #define SVp_POK 0x00004000 /* has valid non-public pointer value */
300 #define SVp_SCREAM 0x00008000 /* has been studied? */
301 #define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
302 #define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
303 #define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
304 subroutine in another package. Set the
305 CvIMPORTED_CV_ON() if it needs to be
306 expanded to a real GV */
308 #define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
309 #define SVpad_STATE 0x00010000 /* pad name is a "state" var */
310 #define SVs_PADTMP 0x00020000 /* in use as tmp */
311 #define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
312 #define SVs_PADMY 0x00040000 /* in use a "my" variable */
313 #define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
314 #define SVs_TEMP 0x00080000 /* string is stealable? */
315 #define SVs_OBJECT 0x00100000 /* is "blessed" */
316 #define SVs_GMG 0x00200000 /* has magical get method */
317 #define SVs_SMG 0x00400000 /* has magical set method */
318 #define SVs_RMG 0x00800000 /* has random magical methods */
320 #define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
321 1: SV head arena wasn't malloc()ed
322 2: in conjunction with SVf_READONLY
323 marks a shared hash key scalar
324 (SvLEN == 0) or a copy on write
325 string (SvLEN != 0) [SvIsCOW(sv)]
326 3: For PVCV, whether CvUNIQUE(cv)
327 refers to an eval or once only
328 [CvEVAL(cv), CvSPECIAL(cv)]
329 4: On a pad name SV, that slot in the
330 frame AV is a REFCNT'ed reference
331 to a lexical from "outside". */
332 #define SVphv_REHASH SVf_FAKE /* 5: On a PVHV, hash values are being
334 #define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
335 means that a hv_aux struct is present
336 after the main array */
337 #define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
338 SVs in final arena cleanup.
339 Set in S_regtry on PL_reg_curpm, so that
340 perl_destruct will skip it. */
341 #define SVf_READONLY 0x08000000 /* may not be modified */
346 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
348 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
349 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
351 #define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
353 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
355 /* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
356 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
357 This is also set on RVs whose overloaded
358 stringification is UTF-8. This might
359 only happen as a side effect of SvPV() */
362 /* Some private flags. */
364 /* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
365 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
366 been restructured, so sometimes get used as string buffers. */
369 #define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
371 /* PVNV, PVMG only, and only used in pads. Should be safe to test on any scalar
372 SV, as the core is careful to avoid setting both.
374 SVf_POK, SVp_POK also set:
376 0x0000C400 Studied (SvSCREAM)
377 0x40004400 FBM compiled (SvVALID)
380 0x00008000 GV with GP
381 0x00008800 RV with PCS imported
383 #define SVpad_NAME (SVp_SCREAM|SVpbm_VALID)
384 /* This SV is a name in the PAD, so
385 SVpad_TYPED, SVpad_OUR and SVpad_STATE
388 #define SVpav_REAL 0x40000000 /* free old entries */
390 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
391 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
392 on any regular scalar (anything <= PVLV) */
393 #define SVpbm_VALID 0x40000000
394 /* Only used in toke.c on an SV stored in PL_lex_repl */
395 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
397 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
398 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
400 #define SVpav_REIFY 0x80000000 /* can become real */
402 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
403 /* PVGV when SVpbm_VALID is true */
404 #define SVpbm_TAIL 0x80000000
405 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
406 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
409 HV* xmg_stash; /* class package */ \
411 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
412 STRLEN xpv_len /* allocated size */
415 NV xnv_nv; /* numeric value, if any */
420 } xpad_cop_seq; /* used by pad.c for cop_sequence */
423 U8 xbm_rare; /* rarest character in string */
424 } xbm_s; /* fields from PVBM */
428 IV xivu_iv; /* integer value */
430 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
434 MAGIC* xmg_magic; /* linked list of magicalness */
435 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
447 #define xiv_iv xiv_u.xivu_iv
454 #define xuv_uv xuv_u.xivu_uv
462 /* This structure must match the beginning of struct xpvhv in hv.h. */
476 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
477 * y=alem/helem/iter t=tie T=tied HE */
480 /* This structure works in 3 ways - regular scalar, GV with GP, or fast
488 /* This structure must match XPVCV in cv.h */
490 typedef U16 cv_flags_t;
492 #define _XPVCV_COMMON \
500 void (*xcv_xsub) (pTHX_ CV*); \
506 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
507 * compilation) in the lexically enclosing \
521 /* ifp and ofp are normally the same, but sockets need separate streams */
523 /* Cray addresses everything by word boundaries (64 bits) and
524 * code and data pointers cannot be mixed (which is exactly what
525 * Perl_filter_add() tries to do with the dirp), hence the
526 * following union trick (as suggested by Gurusamy Sarathy).
527 * For further information see Geir Johansen's problem report
528 * titled [ID 20000612.002] Perl problem on Cray system
529 * The any pointer (known as IoANY()) will also be a good place
530 * to hang any IO disciplines to.
533 DIR * xiou_dirp; /* for opendir, readdir, etc */
534 void * xiou_any; /* for alignment */
536 /* IV xio_lines is now in IVX $. */
537 IV xio_page; /* $% */
538 IV xio_page_len; /* $= */
539 IV xio_lines_left; /* $- */
540 char * xio_top_name; /* $^ */
541 GV * xio_top_gv; /* $^ */
542 char * xio_fmt_name; /* $~ */
543 GV * xio_fmt_gv; /* $~ */
544 char * xio_bottom_name;/* $^B */
545 GV * xio_bottom_gv; /* $^B */
550 #define xio_dirp xio_dirpu.xiou_dirp
551 #define xio_any xio_dirpu.xiou_any
553 #define IOf_ARGV 1 /* this fp iterates over ARGV */
554 #define IOf_START 2 /* check for null ARGV and substitute '-' */
555 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
556 #define IOf_DIDTOP 8 /* just did top of form */
557 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
558 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
559 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
560 Also, when this is set, SvPVX() is valid */
562 /* The following macros define implementation-independent predicates on SVs. */
565 =for apidoc Am|U32|SvNIOK|SV* sv
566 Returns a U32 value indicating whether the SV contains a number, integer or
569 =for apidoc Am|U32|SvNIOKp|SV* sv
570 Returns a U32 value indicating whether the SV contains a number, integer or
571 double. Checks the B<private> setting. Use C<SvNIOK> instead.
573 =for apidoc Am|void|SvNIOK_off|SV* sv
574 Unsets the NV/IV status of an SV.
576 =for apidoc Am|U32|SvOK|SV* sv
577 Returns a U32 value indicating whether the value is defined. This is
578 only meaningful for scalars.
580 =for apidoc Am|U32|SvIOKp|SV* sv
581 Returns a U32 value indicating whether the SV contains an integer. Checks
582 the B<private> setting. Use C<SvIOK> instead.
584 =for apidoc Am|U32|SvNOKp|SV* sv
585 Returns a U32 value indicating whether the SV contains a double. Checks the
586 B<private> setting. Use C<SvNOK> instead.
588 =for apidoc Am|U32|SvPOKp|SV* sv
589 Returns a U32 value indicating whether the SV contains a character string.
590 Checks the B<private> setting. Use C<SvPOK> instead.
592 =for apidoc Am|U32|SvIOK|SV* sv
593 Returns a U32 value indicating whether the SV contains an integer.
595 =for apidoc Am|void|SvIOK_on|SV* sv
596 Tells an SV that it is an integer.
598 =for apidoc Am|void|SvIOK_off|SV* sv
599 Unsets the IV status of an SV.
601 =for apidoc Am|void|SvIOK_only|SV* sv
602 Tells an SV that it is an integer and disables all other OK bits.
604 =for apidoc Am|void|SvIOK_only_UV|SV* sv
605 Tells and SV that it is an unsigned integer and disables all other OK bits.
607 =for apidoc Am|bool|SvIOK_UV|SV* sv
608 Returns a boolean indicating whether the SV contains an unsigned integer.
610 =for apidoc Am|bool|SvUOK|SV* sv
611 Returns a boolean indicating whether the SV contains an unsigned integer.
613 =for apidoc Am|bool|SvIOK_notUV|SV* sv
614 Returns a boolean indicating whether the SV contains a signed integer.
616 =for apidoc Am|U32|SvNOK|SV* sv
617 Returns a U32 value indicating whether the SV contains a double.
619 =for apidoc Am|void|SvNOK_on|SV* sv
620 Tells an SV that it is a double.
622 =for apidoc Am|void|SvNOK_off|SV* sv
623 Unsets the NV status of an SV.
625 =for apidoc Am|void|SvNOK_only|SV* sv
626 Tells an SV that it is a double and disables all other OK bits.
628 =for apidoc Am|U32|SvPOK|SV* sv
629 Returns a U32 value indicating whether the SV contains a character
632 =for apidoc Am|void|SvPOK_on|SV* sv
633 Tells an SV that it is a string.
635 =for apidoc Am|void|SvPOK_off|SV* sv
636 Unsets the PV status of an SV.
638 =for apidoc Am|void|SvPOK_only|SV* sv
639 Tells an SV that it is a string and disables all other OK bits.
640 Will also turn off the UTF-8 status.
642 =for apidoc Am|bool|SvVOK|SV* sv
643 Returns a boolean indicating whether the SV contains a v-string.
645 =for apidoc Am|U32|SvOOK|SV* sv
646 Returns a U32 indicating whether the pointer to the string buffer is offset.
647 This hack is used internally to speed up removal of characters from the
648 beginning of a SvPV. When SvOOK is true, then the start of the
649 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
650 This offset used to be stored in SvIVX, but is now stored within the spare
653 =for apidoc Am|U32|SvROK|SV* sv
654 Tests if the SV is an RV.
656 =for apidoc Am|void|SvROK_on|SV* sv
657 Tells an SV that it is an RV.
659 =for apidoc Am|void|SvROK_off|SV* sv
660 Unsets the RV status of an SV.
662 =for apidoc Am|SV*|SvRV|SV* sv
663 Dereferences an RV to return the SV.
665 =for apidoc Am|IV|SvIVX|SV* sv
666 Returns the raw value in the SV's IV slot, without checks or conversions.
667 Only use when you are sure SvIOK is true. See also C<SvIV()>.
669 =for apidoc Am|UV|SvUVX|SV* sv
670 Returns the raw value in the SV's UV slot, without checks or conversions.
671 Only use when you are sure SvIOK is true. See also C<SvUV()>.
673 =for apidoc Am|NV|SvNVX|SV* sv
674 Returns the raw value in the SV's NV slot, without checks or conversions.
675 Only use when you are sure SvNOK is true. See also C<SvNV()>.
677 =for apidoc Am|char*|SvPVX|SV* sv
678 Returns a pointer to the physical string in the SV. The SV must contain a
681 =for apidoc Am|STRLEN|SvCUR|SV* sv
682 Returns the length of the string which is in the SV. See C<SvLEN>.
684 =for apidoc Am|STRLEN|SvLEN|SV* sv
685 Returns the size of the string buffer in the SV, not including any part
686 attributable to C<SvOOK>. See C<SvCUR>.
688 =for apidoc Am|char*|SvEND|SV* sv
689 Returns a pointer to the last character in the string which is in the SV.
690 See C<SvCUR>. Access the character as *(SvEND(sv)).
692 =for apidoc Am|HV*|SvSTASH|SV* sv
693 Returns the stash of the SV.
695 =for apidoc Am|void|SvIV_set|SV* sv|IV val
696 Set the value of the IV pointer in sv to val. It is possible to perform
697 the same function of this macro with an lvalue assignment to C<SvIVX>.
698 With future Perls, however, it will be more efficient to use
699 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
701 =for apidoc Am|void|SvNV_set|SV* sv|NV val
702 Set the value of the NV pointer in sv to val. See C<SvIV_set>.
704 =for apidoc Am|void|SvPV_set|SV* sv|char* val
705 Set the value of the PV pointer in sv to val. See C<SvIV_set>.
707 =for apidoc Am|void|SvUV_set|SV* sv|UV val
708 Set the value of the UV pointer in sv to val. See C<SvIV_set>.
710 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
711 Set the value of the RV pointer in sv to val. See C<SvIV_set>.
713 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
714 Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
716 =for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
717 Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
719 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
720 Set the current length of the string which is in the SV. See C<SvCUR>
723 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
724 Set the actual length of the string which is in the SV. See C<SvIV_set>.
729 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
730 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
731 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
732 SVp_IOK|SVp_NOK|SVf_IVisUV))
734 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
735 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
736 #define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
738 #define assert_not_ROK(sv)
739 #define assert_not_glob(sv)
742 #define SvOK(sv) ((SvTYPE(sv) == SVt_BIND) \
743 ? (SvFLAGS(SvRV(sv)) & SVf_OK) \
744 : (SvFLAGS(sv) & SVf_OK))
745 #define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
746 SvFLAGS(sv) &= ~(SVf_OK| \
747 SVf_IVisUV|SVf_UTF8), \
749 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
750 SvFLAGS(sv) &= ~(SVf_OK| \
754 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
755 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
756 #define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
757 SvFLAGS(sv) |= SVp_IOK)
758 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
759 #define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
760 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
761 #define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
762 SvFLAGS(sv) |= SVp_POK)
764 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
765 #define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
766 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
767 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
768 #define SvIOK_only(sv) (SvOK_off(sv), \
769 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
770 #define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
771 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
773 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
774 == (SVf_IOK|SVf_IVisUV))
775 #define SvUOK(sv) SvIOK_UV(sv)
776 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
779 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
780 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
781 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
783 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
784 #define SvNOK_on(sv) (assert_not_glob(sv) \
785 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
786 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
787 #define SvNOK_only(sv) (SvOK_off(sv), \
788 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
791 =for apidoc Am|U32|SvUTF8|SV* sv
792 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
793 Call this after SvPV() in case any call to string overloading updates the
796 =for apidoc Am|void|SvUTF8_on|SV *sv
797 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
798 Do not use frivolously.
800 =for apidoc Am|void|SvUTF8_off|SV *sv
801 Unsets the UTF-8 status of an SV.
803 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
804 Tells an SV that it is a string and disables all other OK bits,
805 and leaves the UTF-8 status as it was.
810 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
812 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
813 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
814 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
816 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
817 #define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
818 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
819 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
820 #define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
821 SvFLAGS(sv) &= ~(SVf_OK| \
822 SVf_IVisUV|SVf_UTF8), \
823 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
824 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
825 SvFLAGS(sv) &= ~(SVf_OK| \
827 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
829 #define SvVOK(sv) (SvMAGICAL(sv) \
830 && mg_find(sv,PERL_MAGIC_vstring))
831 /* returns the vstring magic, if any */
832 #define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
833 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
835 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
836 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
837 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
839 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
840 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
841 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
843 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
844 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
845 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
847 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
848 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
849 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
851 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
852 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
853 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
855 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
856 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
857 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
859 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
860 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
861 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
863 #define SvAMAGIC(sv) (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
864 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
865 # define SvAMAGIC_on(sv) ({ SV * const kloink = sv; \
866 assert(SvROK(kloink)); \
867 SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
869 # define SvAMAGIC_off(sv) ({ SV * const kloink = sv; \
871 SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
874 # define SvAMAGIC_on(sv) (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
875 # define SvAMAGIC_off(sv) \
876 (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
880 =for apidoc Am|U32|SvGAMAGIC|SV* sv
882 Returns true if the SV has get magic or overloading. If either is true then
883 the scalar is active data, and has the potential to return a new value every
884 time it is accessed. Hence you must be careful to only read it once per user
885 logical operation and work with that returned value. If neither is true then
886 the scalar's value cannot change unless written to.
891 #define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
893 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash, FALSE))
895 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
896 == (SVf_ROK|SVprv_WEAKREF))
897 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
898 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
900 #define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
901 == (SVf_ROK|SVprv_PCS_IMPORTED))
902 #define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
903 #define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
905 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
907 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
908 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
909 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
911 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
912 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
913 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
915 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
916 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
918 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
919 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
920 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
922 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
923 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
924 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
926 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
927 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
928 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
930 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
931 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
932 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
935 # define SvCOMPILED(sv) 0
936 # define SvCOMPILED_on(sv)
937 # define SvCOMPILED_off(sv)
940 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
941 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
942 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
944 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
945 # define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
946 if (SvFLAGS(_svvalid) & SVpbm_VALID) \
947 assert(!isGV_with_GP(_svvalid)); \
948 (SvFLAGS(_svvalid) & SVpbm_VALID); \
950 # define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
951 assert(!isGV_with_GP(_svvalid)); \
952 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
954 # define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
955 assert(!isGV_with_GP(_svvalid)); \
956 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
959 # define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
960 assert(SvTYPE(_svtail) != SVt_PVAV); \
961 assert(SvTYPE(_svtail) != SVt_PVHV); \
962 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
963 == (SVpbm_TAIL|SVpbm_VALID); \
966 # define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
967 # define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
968 # define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
969 # define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
970 == (SVpbm_TAIL|SVpbm_VALID))
973 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
974 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
977 #define SvPAD_TYPED(sv) \
978 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
980 #define SvPAD_OUR(sv) \
981 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
983 #define SvPAD_STATE(sv) \
984 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
986 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
987 # define SvPAD_TYPED_on(sv) ({ \
988 SV *const _svpad = MUTABLE_SV(sv); \
989 assert(SvTYPE(_svpad) == SVt_PVMG); \
990 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \
992 #define SvPAD_OUR_on(sv) ({ \
993 SV *const _svpad = MUTABLE_SV(sv); \
994 assert(SvTYPE(_svpad) == SVt_PVMG); \
995 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \
997 #define SvPAD_STATE_on(sv) ({ \
998 SV *const _svpad = MUTABLE_SV(sv); \
999 assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
1000 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \
1003 # define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1004 # define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1005 # define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1008 #define SvOURSTASH(sv) \
1009 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1010 #define SvOURSTASH_set(sv, st) \
1012 assert(SvTYPE(sv) == SVt_PVMG); \
1013 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
1016 #define SvRVx(sv) SvRV(sv)
1018 #ifdef PERL_DEBUG_COW
1019 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1020 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1021 # define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1022 # define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1023 # define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1024 # define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1025 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1026 /* Don't test the core XS code yet. */
1027 # if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1028 # define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1030 # define SvPVX(sv) SvPVX_mutable(sv)
1032 # define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1033 # define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1034 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1037 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1038 # define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
1040 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1041 # define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
1044 # define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1045 # define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1047 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1048 /* These get expanded inside other macros that already use a variable _sv */
1049 # define SvPVX(sv) \
1050 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
1051 assert(SvTYPE(_svpvx) >= SVt_PV); \
1052 assert(SvTYPE(_svpvx) != SVt_PVAV); \
1053 assert(SvTYPE(_svpvx) != SVt_PVHV); \
1054 assert(!isGV_with_GP(_svpvx)); \
1055 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1056 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
1057 &((_svpvx)->sv_u.svu_pv); \
1059 # define SvCUR(sv) \
1060 (*({ const SV *const _svcur = (const SV *)(sv); \
1061 assert(SvTYPE(_svcur) >= SVt_PV); \
1062 assert(SvTYPE(_svcur) != SVt_PVAV); \
1063 assert(SvTYPE(_svcur) != SVt_PVHV); \
1064 assert(!isGV_with_GP(_svcur)); \
1065 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1066 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
1067 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
1069 # define SvIVX(sv) \
1070 (*({ const SV *const _svivx = (const SV *)(sv); \
1071 assert(SvTYPE(_svivx) == SVt_IV || SvTYPE(_svivx) >= SVt_PVIV); \
1072 assert(SvTYPE(_svivx) != SVt_PVAV); \
1073 assert(SvTYPE(_svivx) != SVt_PVHV); \
1074 assert(SvTYPE(_svivx) != SVt_PVCV); \
1075 assert(SvTYPE(_svivx) != SVt_PVFM); \
1076 assert(SvTYPE(_svivx) != SVt_PVIO); \
1077 assert(SvTYPE(_svivx) != SVt_REGEXP); \
1078 assert(!isGV_with_GP(_svivx)); \
1079 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
1081 # define SvUVX(sv) \
1082 (*({ const SV *const _svuvx = (const SV *)(sv); \
1083 assert(SvTYPE(_svuvx) == SVt_IV || SvTYPE(_svuvx) >= SVt_PVIV); \
1084 assert(SvTYPE(_svuvx) != SVt_PVAV); \
1085 assert(SvTYPE(_svuvx) != SVt_PVHV); \
1086 assert(SvTYPE(_svuvx) != SVt_PVCV); \
1087 assert(SvTYPE(_svuvx) != SVt_PVFM); \
1088 assert(SvTYPE(_svuvx) != SVt_PVIO); \
1089 assert(SvTYPE(_svuvx) != SVt_REGEXP); \
1090 assert(!isGV_with_GP(_svuvx)); \
1091 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
1093 # define SvNVX(sv) \
1094 (*({ const SV *const _svnvx = (const SV *)(sv); \
1095 assert(SvTYPE(_svnvx) == SVt_NV || SvTYPE(_svnvx) >= SVt_PVNV); \
1096 assert(SvTYPE(_svnvx) != SVt_PVAV); \
1097 assert(SvTYPE(_svnvx) != SVt_PVHV); \
1098 assert(SvTYPE(_svnvx) != SVt_PVCV); \
1099 assert(SvTYPE(_svnvx) != SVt_PVFM); \
1100 assert(SvTYPE(_svnvx) != SVt_PVIO); \
1101 assert(SvTYPE(_svnvx) != SVt_REGEXP); \
1102 assert(!isGV_with_GP(_svnvx)); \
1103 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
1106 (*({ SV *const _svrv = MUTABLE_SV(sv); \
1107 assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1108 assert(SvTYPE(_svrv) != SVt_PVAV); \
1109 assert(SvTYPE(_svrv) != SVt_PVHV); \
1110 assert(SvTYPE(_svrv) != SVt_PVCV); \
1111 assert(SvTYPE(_svrv) != SVt_PVFM); \
1112 assert(!isGV_with_GP(_svrv)); \
1113 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1114 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1115 &((_svrv)->sv_u.svu_rv); \
1117 # define SvRV_const(sv) \
1118 ({ const SV *const _svrv = (const SV *)(sv); \
1119 assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1120 assert(SvTYPE(_svrv) != SVt_PVAV); \
1121 assert(SvTYPE(_svrv) != SVt_PVHV); \
1122 assert(SvTYPE(_svrv) != SVt_PVCV); \
1123 assert(SvTYPE(_svrv) != SVt_PVFM); \
1124 assert(!isGV_with_GP(_svrv)); \
1125 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1126 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
1127 (_svrv)->sv_u.svu_rv; \
1129 # define SvMAGIC(sv) \
1130 (*({ const SV *const _svmagic = (const SV *)(sv); \
1131 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1132 if(SvTYPE(_svmagic) == SVt_PVMG) \
1133 assert(!SvPAD_OUR(_svmagic)); \
1134 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
1136 # define SvSTASH(sv) \
1137 (*({ const SV *const _svstash = (const SV *)(sv); \
1138 assert(SvTYPE(_svstash) >= SVt_PVMG); \
1139 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
1142 # define SvPVX(sv) ((sv)->sv_u.svu_pv)
1143 # define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1144 # define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1145 # define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1146 # define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1147 # define SvRV(sv) ((sv)->sv_u.svu_rv)
1148 # define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
1149 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
1150 # define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
1155 /* Given that these two are new, there can't be any existing code using them
1157 # define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1158 # define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1160 /* Except for the poison code, which uses & to scribble over the pointer after
1161 free() is called. */
1162 # define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1163 # define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1166 #define SvIVXx(sv) SvIVX(sv)
1167 #define SvUVXx(sv) SvUVX(sv)
1168 #define SvNVXx(sv) SvNVX(sv)
1169 #define SvPVXx(sv) SvPVX(sv)
1170 #define SvLENx(sv) SvLEN(sv)
1171 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1174 /* Ask a scalar nicely to try to become an IV, if possible.
1175 Not guaranteed to stay returning void */
1176 /* Macro won't actually call sv_2iv if already IOK */
1177 #define SvIV_please(sv) \
1178 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1179 (void) SvIV(sv); } STMT_END
1180 #define SvIV_please_nomg(sv) \
1181 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1182 (void) SvIV_nomg(sv); } STMT_END
1183 #define SvIV_set(sv, val) \
1184 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1185 assert(SvTYPE(sv) != SVt_PVAV); \
1186 assert(SvTYPE(sv) != SVt_PVHV); \
1187 assert(SvTYPE(sv) != SVt_PVCV); \
1188 assert(!isGV_with_GP(sv)); \
1189 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
1190 #define SvNV_set(sv, val) \
1191 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1192 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1193 assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1194 assert(SvTYPE(sv) != SVt_PVIO); \
1195 assert(!isGV_with_GP(sv)); \
1196 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1197 #define SvPV_set(sv, val) \
1198 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1199 assert(SvTYPE(sv) != SVt_PVAV); \
1200 assert(SvTYPE(sv) != SVt_PVHV); \
1201 assert(!isGV_with_GP(sv)); \
1202 assert(!(SvTYPE(sv) == SVt_PVIO \
1203 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1204 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1205 #define SvUV_set(sv, val) \
1206 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1207 assert(SvTYPE(sv) != SVt_PVAV); \
1208 assert(SvTYPE(sv) != SVt_PVHV); \
1209 assert(SvTYPE(sv) != SVt_PVCV); \
1210 assert(!isGV_with_GP(sv)); \
1211 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1212 #define SvRV_set(sv, val) \
1213 STMT_START { assert(SvTYPE(sv) >= SVt_PV || SvTYPE(sv) == SVt_IV); \
1214 assert(SvTYPE(sv) != SVt_PVAV); \
1215 assert(SvTYPE(sv) != SVt_PVHV); \
1216 assert(SvTYPE(sv) != SVt_PVCV); \
1217 assert(SvTYPE(sv) != SVt_PVFM); \
1218 assert(!isGV_with_GP(sv)); \
1219 assert(!(SvTYPE(sv) == SVt_PVIO \
1220 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1221 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1222 #define SvMAGIC_set(sv, val) \
1223 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1224 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1225 #define SvSTASH_set(sv, val) \
1226 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1227 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
1228 #define SvCUR_set(sv, val) \
1229 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1230 assert(SvTYPE(sv) != SVt_PVAV); \
1231 assert(SvTYPE(sv) != SVt_PVHV); \
1232 assert(!isGV_with_GP(sv)); \
1233 assert(!(SvTYPE(sv) == SVt_PVIO \
1234 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1235 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
1236 #define SvLEN_set(sv, val) \
1237 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1238 assert(SvTYPE(sv) != SVt_PVAV); \
1239 assert(SvTYPE(sv) != SVt_PVHV); \
1240 assert(!isGV_with_GP(sv)); \
1241 assert(!(SvTYPE(sv) == SVt_PVIO \
1242 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
1243 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
1244 #define SvEND_set(sv, val) \
1245 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1246 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
1248 #define SvPV_renew(sv,n) \
1249 STMT_START { SvLEN_set(sv, n); \
1250 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1251 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1252 (MEM_SIZE)((n))))); \
1255 #define SvPV_shrink_to_cur(sv) STMT_START { \
1256 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1257 SvPV_renew(sv, _lEnGtH); \
1260 #define SvPV_free(sv) \
1262 assert(SvTYPE(sv) >= SVt_PV); \
1264 assert(!SvROK(sv)); \
1267 SvOOK_offset(sv, zok); \
1268 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
1269 SvFLAGS(sv) &= ~SVf_OOK; \
1271 Safefree(SvPVX(sv)); \
1276 /* Code that crops up in three places to take a scalar and ready it to hold
1278 # define prepare_SV_for_RV(sv) \
1280 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1281 sv_upgrade(sv, SVt_IV); \
1282 else if (SvTYPE(sv) >= SVt_PV) { \
1290 /* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1295 # define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1298 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1299 # define BmRARE(sv) \
1300 (*({ SV *const _bmrare = MUTABLE_SV(sv); \
1301 assert(SvTYPE(_bmrare) == SVt_PVMG); \
1302 assert(SvVALID(_bmrare)); \
1303 &(((XPVMG*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare); \
1305 # define BmUSEFUL(sv) \
1306 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
1307 assert(SvTYPE(_bmuseful) == SVt_PVMG); \
1308 assert(SvVALID(_bmuseful)); \
1309 assert(!SvIOK(_bmuseful)); \
1310 &(((XPVMG*) SvANY(_bmuseful))->xnv_u.xbm_s.xbm_useful); \
1312 # define BmPREVIOUS(sv) \
1313 (*({ SV *const _bmprevious = MUTABLE_SV(sv); \
1314 assert(SvTYPE(_bmprevious) == SVt_PVMG); \
1315 assert(SvVALID(_bmprevious)); \
1316 &(((XPVMG*) SvANY(_bmprevious))->xiv_u.xivu_uv); \
1319 # define BmRARE(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1320 # define BmUSEFUL(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_useful
1321 # define BmPREVIOUS(sv) ((XPVMG*) SvANY(sv))->xiv_u.xivu_uv
1325 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1327 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1328 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1329 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1330 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1332 #define IoIFP(sv) (sv)->sv_u.svu_fp
1333 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1334 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
1335 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
1336 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
1337 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1338 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1339 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1340 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1341 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1342 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1343 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1344 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1345 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1346 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1347 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1349 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1350 #define IoTYPE_RDONLY '<'
1351 #define IoTYPE_WRONLY '>'
1352 #define IoTYPE_RDWR '+'
1353 #define IoTYPE_APPEND 'a'
1354 #define IoTYPE_PIPE '|'
1355 #define IoTYPE_STD '-' /* stdin or stdout */
1356 #define IoTYPE_SOCKET 's'
1357 #define IoTYPE_CLOSED ' '
1358 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1359 #define IoTYPE_NUMERIC '#' /* fdopen */
1362 =for apidoc Am|bool|SvTAINTED|SV* sv
1363 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1366 =for apidoc Am|void|SvTAINTED_on|SV* sv
1367 Marks an SV as tainted if tainting is enabled.
1369 =for apidoc Am|void|SvTAINTED_off|SV* sv
1370 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1371 some of Perl's fundamental security features. XS module authors should not
1372 use this function unless they fully understand all the implications of
1373 unconditionally untainting the value. Untainting should be done in the
1374 standard perl fashion, via a carefully crafted regexp, rather than directly
1375 untainting variables.
1377 =for apidoc Am|void|SvTAINT|SV* sv
1378 Taints an SV if tainting is enabled.
1383 #define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1385 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1386 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1387 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1389 #define SvTAINT(sv) \
1391 if (PL_tainting) { \
1398 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1399 Like C<SvPV> but will force the SV into containing just a string
1400 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1403 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1404 Like C<SvPV> but will force the SV into containing just a string
1405 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1406 directly. Doesn't process magic.
1408 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1409 Returns a pointer to the string in the SV, or a stringified form of
1410 the SV if the SV does not contain a string. The SV may cache the
1411 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1412 C<SvPVx> for a version which guarantees to evaluate sv only once.
1414 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1415 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1416 Only use this if C<sv> is an expression with side effects, otherwise use the
1417 more efficient C<SvPVX>.
1419 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1420 Like C<SvPV> but doesn't process magic.
1422 =for apidoc Am|char*|SvPV_nolen|SV* sv
1423 Returns a pointer to the string in the SV, or a stringified form of
1424 the SV if the SV does not contain a string. The SV may cache the
1425 stringified form becoming C<SvPOK>. Handles 'get' magic.
1427 =for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1428 Like C<SvPV_nolen> but doesn't process magic.
1430 =for apidoc Am|IV|SvIV|SV* sv
1431 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1432 version which guarantees to evaluate sv only once.
1434 =for apidoc Am|IV|SvIV_nomg|SV* sv
1435 Like C<SvIV> but doesn't process magic.
1437 =for apidoc Am|IV|SvIVx|SV* sv
1438 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1439 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1440 otherwise use the more efficient C<SvIV>.
1442 =for apidoc Am|NV|SvNV|SV* sv
1443 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1444 which guarantees to evaluate sv only once.
1446 =for apidoc Am|NV|SvNV_nomg|SV* sv
1447 Like C<SvNV> but doesn't process magic.
1449 =for apidoc Am|NV|SvNVx|SV* sv
1450 Coerces the given SV to a double and returns it. Guarantees to evaluate
1451 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1452 otherwise use the more efficient C<SvNV>.
1454 =for apidoc Am|UV|SvUV|SV* sv
1455 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1456 for a version which guarantees to evaluate sv only once.
1458 =for apidoc Am|UV|SvUV_nomg|SV* sv
1459 Like C<SvUV> but doesn't process magic.
1461 =for apidoc Am|UV|SvUVx|SV* sv
1462 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1463 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1464 otherwise use the more efficient C<SvUV>.
1466 =for apidoc Am|bool|SvTRUE|SV* sv
1467 Returns a boolean indicating whether Perl would evaluate the SV as true or
1468 false. See SvOK() for a defined/undefined test. Handles 'get' magic
1469 unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
1472 =for apidoc Am|bool|SvTRUE_nomg|SV* sv
1473 Returns a boolean indicating whether Perl would evaluate the SV as true or
1474 false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
1476 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1477 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1479 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1480 Like C<SvPV>, but converts sv to utf8 first if necessary.
1482 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1483 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1485 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1486 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1488 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1489 Like C<SvPV>, but converts sv to byte representation first if necessary.
1491 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1492 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1494 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1495 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1496 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1499 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1500 Like C<SvPV>, but converts sv to utf8 first if necessary.
1501 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1504 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1505 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1506 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1509 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1510 Like C<SvPV>, but converts sv to byte representation first if necessary.
1511 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1514 =for apidoc Am|bool|SvIsCOW|SV* sv
1515 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1516 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1519 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1520 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1523 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1524 Like C<sv_catpvn> but doesn't process magic.
1526 =for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1527 Like C<sv_catpv> but doesn't process magic.
1529 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1530 Like C<sv_setsv> but doesn't process magic.
1532 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1533 Like C<sv_catsv> but doesn't process magic.
1535 =for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1537 Like sv_utf8_upgrade, but doesn't do magic on C<sv>
1542 /* Let us hope that bitmaps for UV and IV are the same */
1543 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1544 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1545 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1547 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1548 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1549 #define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
1553 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1554 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1555 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1557 #define SvPV_flags(sv, lp, flags) \
1558 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1559 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1560 #define SvPV_flags_const(sv, lp, flags) \
1561 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1562 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1563 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1564 #define SvPV_flags_const_nolen(sv, flags) \
1565 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1566 ? SvPVX_const(sv) : \
1567 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1568 #define SvPV_flags_mutable(sv, lp, flags) \
1569 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1570 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1571 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1573 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1574 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1575 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1577 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1578 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1580 #define SvPV_force_flags(sv, lp, flags) \
1581 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1582 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1583 #define SvPV_force_flags_nolen(sv, flags) \
1584 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1585 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1586 #define SvPV_force_flags_mutable(sv, lp, flags) \
1587 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1588 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1589 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1591 #define SvPV_nolen(sv) \
1592 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1593 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1595 #define SvPV_nomg_nolen(sv) \
1596 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1597 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1599 #define SvPV_nolen_const(sv) \
1600 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1601 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1603 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1604 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1605 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1609 #define SvPVutf8(sv, lp) \
1610 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1611 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1613 #define SvPVutf8_force(sv, lp) \
1614 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1615 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1618 #define SvPVutf8_nolen(sv) \
1619 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1620 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1624 #define SvPVbyte(sv, lp) \
1625 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1626 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1628 #define SvPVbyte_force(sv, lp) \
1629 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1630 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1632 #define SvPVbyte_nolen(sv) \
1633 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1634 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1638 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1639 * var to evaluate the arg once; failing that, use a global if possible;
1640 * failing that, call a function to do the work
1643 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1644 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1645 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1647 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1649 # define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1650 # define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1651 # define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
1652 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1653 # define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1654 # define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1655 # define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1656 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1657 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1658 # define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1659 # define SvTRUE(sv) ( \
1663 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1665 (nxpv->xpv_cur > 1 || \
1666 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1673 ? SvNVX(sv) != 0.0 \
1675 # define SvTRUE_nomg(sv) ( \
1679 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1681 (nxpv->xpv_cur > 1 || \
1682 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1689 ? SvNVX(sv) != 0.0 \
1690 : sv_2bool_flags(sv,0) )
1691 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1693 #else /* __GNUC__ */
1695 /* These inlined macros use globals, which will require a thread
1696 * declaration in user code, so we avoid them under threads */
1698 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1699 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1700 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1701 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1702 # define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1703 # define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1704 # define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1705 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1706 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1707 # define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1708 # define SvTRUE(sv) ( \
1712 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1713 (PL_Xpv->xpv_cur > 1 || \
1714 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1721 ? SvNVX(sv) != 0.0 \
1723 # define SvTRUE_nomg(sv) ( \
1727 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1728 (PL_Xpv->xpv_cur > 1 || \
1729 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1736 ? SvNVX(sv) != 0.0 \
1737 : sv_2bool_flags(sv,0) )
1738 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1739 #endif /* __GNU__ */
1741 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1742 (SVf_FAKE | SVf_READONLY))
1743 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1745 #define SvSHARED_HEK_FROM_PV(pvx) \
1746 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1747 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1749 /* flag values for sv_*_flags functions */
1750 #define SV_IMMEDIATE_UNREF 1
1752 #define SV_COW_DROP_PV 4
1753 #define SV_UTF8_NO_ENCODING 8
1754 #define SV_NOSTEAL 16
1755 #define SV_CONST_RETURN 32
1756 #define SV_MUTABLE_RETURN 64
1757 #define SV_SMAGIC 128
1758 #define SV_HAS_TRAILING_NUL 256
1759 #define SV_COW_SHARED_HASH_KEYS 512
1760 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1761 #define SV_COW_OTHER_PVS 1024
1762 /* Make sv_2pv_flags return NULL if something is undefined. */
1763 #define SV_UNDEF_RETURNS_NULL 2048
1764 /* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1765 * This is used when the caller has already determined it is, and avoids
1767 #define SV_FORCE_UTF8_UPGRADE 4096
1768 /* if (after resolving magic etc), the SV is found to be overloaded,
1769 * don't call the overload magic, just return as-is */
1770 #define SV_SKIP_OVERLOAD 8192
1772 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1773 So only default to doing the COW setup if we're in the core.
1776 # ifndef SV_DO_COW_SVSETSV
1777 # define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1781 #ifndef SV_DO_COW_SVSETSV
1782 # define SV_DO_COW_SVSETSV 0
1786 #define sv_unref(sv) sv_unref_flags(sv, 0)
1787 #define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
1788 #define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1789 #define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1791 /* We are about to replace the SV's current value. So if it's copy on write
1792 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1793 the value is about to get thrown away, so drop the PV rather than go to
1794 the effort of making a read-write copy only for it to get immediately
1797 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1798 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1800 #ifdef PERL_OLD_COPY_ON_WRITE
1801 #define SvRELEASE_IVX(sv) \
1802 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1803 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1804 # define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
1806 # define SvRELEASE_IVX(sv) 0
1807 /* This little game brought to you by the need to shut this warning up:
1808 mg.c: In function `Perl_magic_get':
1809 mg.c:1024: warning: left-hand operand of comma expression has no effect
1811 # define SvRELEASE_IVX_(sv) /**/
1812 #endif /* PERL_OLD_COPY_ON_WRITE */
1814 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1815 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1816 SVf_OOK|SVf_BREAK|SVf_READONLY)
1817 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1819 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1820 sv_force_normal_flags(sv, 0)
1823 /* all these 'functions' are now just macros */
1825 #define sv_pv(sv) SvPV_nolen(sv)
1826 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1827 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1829 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1830 #define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
1831 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1832 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1833 #define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
1834 #define sv_setsv(dsv, ssv) \
1835 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1836 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1837 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1838 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1839 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1840 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1841 #define sv_catpvn_mg(sv, sstr, slen) \
1842 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1843 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1844 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1845 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1846 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1847 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1848 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1849 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1850 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1851 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1852 #define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
1853 #define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1854 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1855 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
1856 #define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
1857 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
1858 #define sv_insert(bigstr, offset, len, little, littlelen) \
1859 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1860 (littlelen), SV_GMAGIC)
1862 /* Should be named SvCatPVN_utf8_upgrade? */
1863 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1866 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
1868 sv_setpvn(nsv, sstr, slen); \
1870 sv_utf8_upgrade(nsv); \
1871 sv_catsv(dsv, nsv); \
1875 =for apidoc Am|SV*|newRV_inc|SV* sv
1877 Creates an RV wrapper for an SV. The reference count for the original SV is
1883 #define newRV_inc(sv) newRV(sv)
1885 /* the following macros update any magic values this sv is associated with */
1888 =head1 Magical Functions
1890 =for apidoc Am|void|SvGETMAGIC|SV* sv
1891 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1892 argument more than once.
1894 =for apidoc Am|void|SvSETMAGIC|SV* sv
1895 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1896 argument more than once.
1898 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1899 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1902 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1903 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1904 ssv. May evaluate arguments more than once.
1906 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1907 Like C<SvSetSV>, but does any set magic required afterwards.
1909 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1910 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1912 =for apidoc Am|void|SvSHARE|SV* sv
1913 Arranges for sv to be shared between threads if a suitable module
1916 =for apidoc Am|void|SvLOCK|SV* sv
1917 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1920 =for apidoc Am|void|SvUNLOCK|SV* sv
1921 Releases a mutual exclusion lock on sv if a suitable module
1924 =head1 SV Manipulation Functions
1926 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1927 Expands the character buffer in the SV so that it has room for the
1928 indicated number of bytes (remember to reserve space for an extra trailing
1929 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1930 Returns a pointer to the character buffer.
1935 #define SvSHARE(sv) PL_sharehook(aTHX_ sv)
1936 #define SvLOCK(sv) PL_lockhook(aTHX_ sv)
1937 #define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
1938 #define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
1940 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1941 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1943 #define SvSetSV_and(dst,src,finally) \
1945 if ((dst) != (src)) { \
1946 sv_setsv(dst, src); \
1950 #define SvSetSV_nosteal_and(dst,src,finally) \
1952 if ((dst) != (src)) { \
1953 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
1958 #define SvSetSV(dst,src) \
1959 SvSetSV_and(dst,src,/*nothing*/;)
1960 #define SvSetSV_nosteal(dst,src) \
1961 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1963 #define SvSetMagicSV(dst,src) \
1964 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1965 #define SvSetMagicSV_nosteal(dst,src) \
1966 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1969 #if !defined(SKIP_DEBUGGING)
1970 #define SvPEEK(sv) sv_peek(sv)
1972 #define SvPEEK(sv) ""
1975 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1977 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1979 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1980 /* If I give every macro argument a different name, then there won't be bugs
1981 where nested macros get confused. Been there, done that. */
1982 #define isGV_with_GP(pwadak) \
1983 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
1984 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
1985 #define isGV_with_GP_on(sv) STMT_START { \
1986 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1987 assert (!SvPOKp(sv)); \
1988 assert (!SvIOKp(sv)); \
1989 (SvFLAGS(sv) |= SVpgv_GP); \
1991 #define isGV_with_GP_off(sv) STMT_START { \
1992 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1993 assert (!SvPOKp(sv)); \
1994 assert (!SvIOKp(sv)); \
1995 (SvFLAGS(sv) &= ~SVpgv_GP); \
1999 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2000 #define SvGROW_mutable(sv,len) \
2001 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
2002 #define Sv_Grow sv_grow
2004 #define CLONEf_COPY_STACKS 1
2005 #define CLONEf_KEEP_PTR_TABLE 2
2006 #define CLONEf_CLONE_HOST 4
2007 #define CLONEf_JOIN_IN 8
2009 struct clone_params {
2012 PerlInterpreter *proto_perl;
2013 PerlInterpreter *new_perl;
2018 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2020 Creates a new SV and copies a string into it. If utf8 is true, calls
2021 C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2026 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2029 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2031 Reads into I<len> the offset from SvPVX back to the true start of the
2032 allocated buffer, which will be non-zero if C<sv_chop> has been used to
2033 efficiently remove characters from start of the buffer. Implemented as a
2034 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
2035 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
2041 /* Does the bot know something I don't?
2042 10:28 <@Nicholas> metabatman
2043 10:28 <+meta> Nicholas: crash
2045 # define SvOOK_offset(sv, offset) STMT_START { \
2046 assert(sizeof(offset) == sizeof(STRLEN)); \
2048 const U8 *crash = (U8*)SvPVX_const(sv); \
2049 offset = *--crash; \
2051 crash -= sizeof(STRLEN); \
2052 Copy(crash, (U8 *)&offset, sizeof(STRLEN), U8); \
2055 /* Validate the preceding buffer's sentinels to \
2056 verify that no-one is using it. */ \
2057 const U8 *const bonk = (U8 *) SvPVX_const(sv) - offset; \
2058 while (crash > bonk) { \
2060 assert (*crash == (U8)PTR2UV(crash)); \
2068 /* This is the same code, but avoids using any temporary variables: */
2069 # define SvOOK_offset(sv, offset) STMT_START { \
2070 assert(sizeof(offset) == sizeof(STRLEN)); \
2072 offset = ((U8*)SvPVX_const(sv))[-1]; \
2074 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2075 (U8 *)&offset, sizeof(STRLEN), U8); \
2083 #define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2087 * c-indentation-style: bsd
2089 * indent-tabs-mode: t
2092 * ex: set ts=8 sts=4 sw=4 noet: