3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005 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>.
65 /* Using C's structural equivalence to help emulate C++ inheritance here... */
67 struct STRUCT_SV { /* struct sv { */
68 void* sv_any; /* pointer to something */
69 U32 sv_refcnt; /* how many references to us */
70 U32 sv_flags; /* what we are */
74 SV* sv_rv; /* pointer to another SV */
75 char* sv_pv; /* pointer to malloced string */
78 #ifdef DEBUG_LEAKING_SCALARS
79 unsigned sv_debug_optype:9; /* the type of OP that allocated us */
80 unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */
81 unsigned sv_debug_cloned:1; /* was cloned for an ithread */
82 unsigned sv_debug_line:16; /* the line where we were allocated */
83 char * sv_debug_file; /* the file where we were allocated */
88 XPVGV* sv_any; /* pointer to something */
89 U32 sv_refcnt; /* how many references to us */
90 U32 sv_flags; /* what we are */
101 XPVCV* sv_any; /* pointer to something */
102 U32 sv_refcnt; /* how many references to us */
103 U32 sv_flags; /* what we are */
114 XPVAV* sv_any; /* pointer to something */
115 U32 sv_refcnt; /* how many references to us */
116 U32 sv_flags; /* what we are */
121 char* sv_pv; /* pointer to first array element */
127 XPVHV* sv_any; /* pointer to something */
128 U32 sv_refcnt; /* how many references to us */
129 U32 sv_flags; /* what we are */
140 XPVIO* sv_any; /* pointer to something */
141 U32 sv_refcnt; /* how many references to us */
142 U32 sv_flags; /* what we are */
153 =head1 SV Manipulation Functions
155 =for apidoc Am|U32|SvREFCNT|SV* sv
156 Returns the value of the object's reference count.
158 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
159 Increments the reference count of the given SV.
161 =for apidoc Am|void|SvREFCNT_dec|SV* sv
162 Decrements the reference count of the given SV.
164 =for apidoc Am|svtype|SvTYPE|SV* sv
165 Returns the type of the SV. See C<svtype>.
167 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
168 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
169 perform the upgrade if necessary. See C<svtype>.
174 #define SvANY(sv) (sv)->sv_any
175 #define SvFLAGS(sv) (sv)->sv_flags
176 #define SvREFCNT(sv) (sv)->sv_refcnt
178 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
179 # define SvREFCNT_inc(sv) \
181 SV * const _sv = (SV*)(sv); \
187 # define SvREFCNT_inc(sv) \
188 ((PL_Sv=(SV*)(sv)), (PL_Sv && ++(SvREFCNT(PL_Sv))), (SV*)PL_Sv)
191 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
192 # define SvREFCNT_dec(sv) \
194 SV * const _sv = (SV*)(sv); \
196 if (SvREFCNT(_sv)) { \
197 if (--(SvREFCNT(_sv)) == 0) \
198 Perl_sv_free2(aTHX_ _sv); \
205 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
208 #define SVTYPEMASK 0xff
209 #define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
211 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
213 #define SVs_PADSTALE 0x00000100 /* lexical has gone out of scope */
214 #define SVs_PADTMP 0x00000200 /* in use as tmp */
215 #define SVs_PADMY 0x00000400 /* in use a "my" variable */
216 #define SVs_TEMP 0x00000800 /* string is stealable? */
217 #define SVs_OBJECT 0x00001000 /* is "blessed" */
218 #define SVs_GMG 0x00002000 /* has magical get method */
219 #define SVs_SMG 0x00004000 /* has magical set method */
220 #define SVs_RMG 0x00008000 /* has random magical methods */
222 #define SVf_IOK 0x00010000 /* has valid public integer value */
223 #define SVf_NOK 0x00020000 /* has valid public numeric value */
224 #define SVf_POK 0x00040000 /* has valid public pointer value */
225 #define SVf_ROK 0x00080000 /* has a valid reference pointer */
227 #define SVf_FAKE 0x00100000 /* glob or lexical is just a copy */
228 #define SVf_OOK 0x00200000 /* has valid offset value */
229 #define SVf_BREAK 0x00400000 /* refcnt is artificially low - used
230 * by SV's in final arena cleanup */
231 #define SVf_READONLY 0x00800000 /* may not be modified */
234 #define SVp_IOK 0x01000000 /* has valid non-public integer value */
235 #define SVp_NOK 0x02000000 /* has valid non-public numeric value */
236 #define SVp_POK 0x04000000 /* has valid non-public pointer value */
237 #define SVp_SCREAM 0x08000000 /* has been studied? */
239 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
240 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
242 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
244 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
245 SVp_IOK|SVp_NOK|SVp_POK)
247 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
249 #define PRIVSHIFT 8 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
251 /* Some private flags. */
253 /* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
254 #define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
255 #define SVpad_TYPED 0x40000000 /* Typed Lexical */
257 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
259 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
261 #define SVpbm_VALID 0x80000000
262 #define SVpbm_TAIL 0x40000000
264 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
266 #define SVphv_CLONEABLE 0x08000000 /* for stashes: clone its objects */
267 #define SVphv_REHASH 0x10000000 /* HV is recalculating hash values */
268 #define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */
269 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
270 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
272 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
274 #define SVpav_REAL 0x40000000 /* free old entries */
275 #define SVpav_REIFY 0x80000000 /* can become real */
278 STRLEN xpv_cur; /* length of sv_pv as a C string */
279 STRLEN xpv_len; /* allocated size */
283 STRLEN xpv_cur; /* length of sv_pv as a C string */
284 STRLEN xpv_len; /* allocated size */
285 IV xiv_iv; /* integer value or pv offset */
289 STRLEN xpv_cur; /* length of sv_pv as a C string */
290 STRLEN xpv_len; /* allocated size */
291 UV xuv_uv; /* unsigned value or pv offset */
295 STRLEN xpv_cur; /* length of sv_pv as a C string */
296 STRLEN xpv_len; /* allocated size */
297 IV xiv_iv; /* integer value or pv offset */
298 NV xnv_nv; /* numeric value, if any */
301 /* These structure must match the beginning of struct xpvhv in hv.h. */
303 STRLEN xpv_cur; /* length of sv_pv as a C string */
304 STRLEN xpv_len; /* allocated size */
305 IV xiv_iv; /* integer value or pv offset */
306 NV xnv_nv; /* numeric value, if any */
307 MAGIC* xmg_magic; /* linked list of magicalness */
308 HV* xmg_stash; /* class package */
312 STRLEN xpv_cur; /* length of sv_pv as a C string */
313 STRLEN xpv_len; /* allocated size */
314 IV xiv_iv; /* integer value or pv offset */
315 NV xnv_nv; /* numeric value, if any */
316 MAGIC* xmg_magic; /* linked list of magicalness */
317 HV* xmg_stash; /* class package */
319 /* a full glob fits into this */
329 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
330 * y=alem/helem/iter t=tie T=tied HE */
334 STRLEN xpv_cur; /* length of sv_pv as a C string */
335 STRLEN xpv_len; /* allocated size */
336 IV xiv_iv; /* integer value or pv offset */
337 NV xnv_nv; /* numeric value, if any */
338 MAGIC* xmg_magic; /* linked list of magicalness */
339 HV* xmg_stash; /* class package */
349 STRLEN xpv_cur; /* length of sv_pv as a C string */
350 STRLEN xpv_len; /* allocated size */
351 IV xiv_iv; /* integer value or pv offset */
352 NV xnv_nv; /* numeric value, if any */
353 MAGIC* xmg_magic; /* linked list of magicalness */
354 HV* xmg_stash; /* class package */
356 I32 xbm_useful; /* is this constant pattern being useful? */
357 U16 xbm_previous; /* how many characters in string before rare? */
358 U8 xbm_rare; /* rarest character in string */
361 /* This structure must match XPVCV in cv.h */
363 typedef U16 cv_flags_t;
366 STRLEN xpv_cur; /* length of sv_pv as a C string */
367 STRLEN xpv_len; /* allocated size */
368 IV xiv_iv; /* integer value or pv offset */
369 NV xnv_nv; /* numeric value, if any */
370 MAGIC* xmg_magic; /* linked list of magicalness */
371 HV* xmg_stash; /* class package */
376 void (*xcv_xsub)(pTHX_ CV*);
380 long xcv_depth; /* >= 2 indicates recursive call */
383 cv_flags_t xcv_flags;
384 U32 xcv_outside_seq; /* the COP sequence (at the point of our
385 * compilation) in the lexically enclosing
391 STRLEN xpv_cur; /* length of sv_pv as a C string */
392 STRLEN xpv_len; /* allocated size */
393 IV xiv_iv; /* integer value or pv offset */
394 NV xnv_nv; /* numeric value, if any */
395 MAGIC* xmg_magic; /* linked list of magicalness */
396 HV* xmg_stash; /* class package */
398 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
399 PerlIO * xio_ofp; /* but sockets need separate streams */
400 /* Cray addresses everything by word boundaries (64 bits) and
401 * code and data pointers cannot be mixed (which is exactly what
402 * Perl_filter_add() tries to do with the dirp), hence the following
403 * union trick (as suggested by Gurusamy Sarathy).
404 * For further information see Geir Johansen's problem report titled
405 [ID 20000612.002] Perl problem on Cray system
406 * The any pointer (known as IoANY()) will also be a good place
407 * to hang any IO disciplines to.
410 DIR * xiou_dirp; /* for opendir, readdir, etc */
411 void * xiou_any; /* for alignment */
413 IV xio_lines; /* $. */
414 IV xio_page; /* $% */
415 IV xio_page_len; /* $= */
416 IV xio_lines_left; /* $- */
417 char * xio_top_name; /* $^ */
418 GV * xio_top_gv; /* $^ */
419 char * xio_fmt_name; /* $~ */
420 GV * xio_fmt_gv; /* $~ */
421 char * xio_bottom_name;/* $^B */
422 GV * xio_bottom_gv; /* $^B */
423 short xio_subprocess; /* -| or |- */
427 #define xio_dirp xio_dirpu.xiou_dirp
428 #define xio_any xio_dirpu.xiou_any
430 #define IOf_ARGV 1 /* this fp iterates over ARGV */
431 #define IOf_START 2 /* check for null ARGV and substitute '-' */
432 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
433 #define IOf_DIDTOP 8 /* just did top of form */
434 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
435 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
436 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
438 /* The following macros define implementation-independent predicates on SVs. */
441 =for apidoc Am|bool|SvNIOK|SV* sv
442 Returns a boolean indicating whether the SV contains a number, integer or
445 =for apidoc Am|bool|SvNIOKp|SV* sv
446 Returns a boolean indicating whether the SV contains a number, integer or
447 double. Checks the B<private> setting. Use C<SvNIOK>.
449 =for apidoc Am|void|SvNIOK_off|SV* sv
450 Unsets the NV/IV status of an SV.
452 =for apidoc Am|bool|SvOK|SV* sv
453 Returns a boolean indicating whether the value is an SV. It also tells
454 whether the value is defined or not.
456 =for apidoc Am|bool|SvIOKp|SV* sv
457 Returns a boolean indicating whether the SV contains an integer. Checks
458 the B<private> setting. Use C<SvIOK>.
460 =for apidoc Am|bool|SvNOKp|SV* sv
461 Returns a boolean indicating whether the SV contains a double. Checks the
462 B<private> setting. Use C<SvNOK>.
464 =for apidoc Am|bool|SvPOKp|SV* sv
465 Returns a boolean indicating whether the SV contains a character string.
466 Checks the B<private> setting. Use C<SvPOK>.
468 =for apidoc Am|bool|SvIOK|SV* sv
469 Returns a boolean indicating whether the SV contains an integer.
471 =for apidoc Am|void|SvIOK_on|SV* sv
472 Tells an SV that it is an integer.
474 =for apidoc Am|void|SvIOK_off|SV* sv
475 Unsets the IV status of an SV.
477 =for apidoc Am|void|SvIOK_only|SV* sv
478 Tells an SV that it is an integer and disables all other OK bits.
480 =for apidoc Am|void|SvIOK_only_UV|SV* sv
481 Tells and SV that it is an unsigned integer and disables all other OK bits.
483 =for apidoc Am|bool|SvIOK_UV|SV* sv
484 Returns a boolean indicating whether the SV contains an unsigned integer.
486 =for apidoc Am|void|SvUOK|SV* sv
487 Returns a boolean indicating whether the SV contains an unsigned integer.
489 =for apidoc Am|bool|SvIOK_notUV|SV* sv
490 Returns a boolean indicating whether the SV contains a signed integer.
492 =for apidoc Am|bool|SvNOK|SV* sv
493 Returns a boolean indicating whether the SV contains a double.
495 =for apidoc Am|void|SvNOK_on|SV* sv
496 Tells an SV that it is a double.
498 =for apidoc Am|void|SvNOK_off|SV* sv
499 Unsets the NV status of an SV.
501 =for apidoc Am|void|SvNOK_only|SV* sv
502 Tells an SV that it is a double and disables all other OK bits.
504 =for apidoc Am|bool|SvPOK|SV* sv
505 Returns a boolean indicating whether the SV contains a character
508 =for apidoc Am|void|SvPOK_on|SV* sv
509 Tells an SV that it is a string.
511 =for apidoc Am|void|SvPOK_off|SV* sv
512 Unsets the PV status of an SV.
514 =for apidoc Am|void|SvPOK_only|SV* sv
515 Tells an SV that it is a string and disables all other OK bits.
516 Will also turn off the UTF-8 status.
518 =for apidoc Am|bool|SvVOK|SV* sv
519 Returns a boolean indicating whether the SV contains a v-string.
521 =for apidoc Am|bool|SvOOK|SV* sv
522 Returns a boolean indicating whether the SvIVX is a valid offset value for
523 the SvPVX. This hack is used internally to speed up removal of characters
524 from the beginning of a SvPV. When SvOOK is true, then the start of the
525 allocated string buffer is really (SvPVX - SvIVX).
527 =for apidoc Am|bool|SvROK|SV* sv
528 Tests if the SV is an RV.
530 =for apidoc Am|void|SvROK_on|SV* sv
531 Tells an SV that it is an RV.
533 =for apidoc Am|void|SvROK_off|SV* sv
534 Unsets the RV status of an SV.
536 =for apidoc Am|SV*|SvRV|SV* sv
537 Dereferences an RV to return the SV.
539 =for apidoc Am|IV|SvIVX|SV* sv
540 Returns the raw value in the SV's IV slot, without checks or conversions.
541 Only use when you are sure SvIOK is true. See also C<SvIV()>.
543 =for apidoc Am|UV|SvUVX|SV* sv
544 Returns the raw value in the SV's UV slot, without checks or conversions.
545 Only use when you are sure SvIOK is true. See also C<SvUV()>.
547 =for apidoc Am|NV|SvNVX|SV* sv
548 Returns the raw value in the SV's NV slot, without checks or conversions.
549 Only use when you are sure SvNOK is true. See also C<SvNV()>.
551 =for apidoc Am|char*|SvPVX|SV* sv
552 Returns a pointer to the physical string in the SV. The SV must contain a
555 =for apidoc Am|STRLEN|SvCUR|SV* sv
556 Returns the length of the string which is in the SV. See C<SvLEN>.
558 =for apidoc Am|STRLEN|SvLEN|SV* sv
559 Returns the size of the string buffer in the SV, not including any part
560 attributable to C<SvOOK>. See C<SvCUR>.
562 =for apidoc Am|char*|SvEND|SV* sv
563 Returns a pointer to the last character in the string which is in the SV.
564 See C<SvCUR>. Access the character as *(SvEND(sv)).
566 =for apidoc Am|HV*|SvSTASH|SV* sv
567 Returns the stash of the SV.
569 =for apidoc Am|void|SvIV_set|SV* sv|IV val
570 Set the value of the IV pointer in sv to val.
572 =for apidoc Am|void|SvNV_set|SV* sv|NV val
573 Set the value of the IV pointer in sv to val.
575 =for apidoc Am|void|SvPV_set|SV* sv|char* val
576 Set the value of the PV pointer in sv to val.
578 =for apidoc Am|void|SvUV_set|SV* sv|UV val
579 Set the value of the PV pointer in sv to val.
581 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
582 Set the value of the RV pointer in sv to val.
584 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
585 Set the value of the MAGIC pointer in sv to val.
587 =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
588 Set the value of the STASH pointer in sv to val.
590 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
591 Set the current length of the string which is in the SV. See C<SvCUR>.
593 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
594 Set the actual length of the string which is in the SV.
599 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
600 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
601 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
602 SVp_IOK|SVp_NOK|SVf_IVisUV))
604 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
605 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
607 #define assert_not_ROK(sv)
610 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
611 #define SvOK_off(sv) (assert_not_ROK(sv) \
612 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
613 SVf_IVisUV|SVf_UTF8), \
615 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
616 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
620 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
621 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
622 #define SvIOKp_on(sv) (SvRELEASE_IVX(sv), \
623 SvFLAGS(sv) |= SVp_IOK)
624 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
625 #define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
626 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
627 #define SvPOKp_on(sv) (assert_not_ROK(sv) \
628 SvFLAGS(sv) |= SVp_POK)
630 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
631 #define SvIOK_on(sv) (SvRELEASE_IVX(sv), \
632 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
633 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
634 #define SvIOK_only(sv) (SvOK_off(sv), \
635 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
636 #define SvIOK_only_UV(sv) (SvOK_off_exc_UV(sv), \
637 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
639 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
640 == (SVf_IOK|SVf_IVisUV))
641 #define SvUOK(sv) SvIOK_UV(sv)
642 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
645 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
646 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
647 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
649 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
650 #define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
651 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
652 #define SvNOK_only(sv) (SvOK_off(sv), \
653 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
656 =for apidoc Am|bool|SvUTF8|SV* sv
657 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
659 =for apidoc Am|void|SvUTF8_on|SV *sv
660 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
661 Do not use frivolously.
663 =for apidoc Am|void|SvUTF8_off|SV *sv
664 Unsets the UTF-8 status of an SV.
666 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
667 Tells an SV that it is a string and disables all other OK bits,
668 and leaves the UTF-8 status as it was.
673 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
675 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
676 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
677 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
679 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
680 #define SvPOK_on(sv) (assert_not_ROK(sv) \
681 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
682 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
683 #define SvPOK_only(sv) (assert_not_ROK(sv) \
684 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
685 SVf_IVisUV|SVf_UTF8), \
686 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
687 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) \
688 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
690 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
692 #define SvVOK(sv) (SvMAGICAL(sv) && mg_find(sv,'V'))
693 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
694 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
695 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
697 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
698 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
699 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
701 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
702 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
703 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
705 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
706 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
707 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
709 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
710 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
711 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
713 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
714 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
715 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
717 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
718 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
719 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
721 #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
722 #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
723 #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
725 #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
728 #define Gv_AMG(stash) \
729 (HV_AMAGICmb(stash) && \
730 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
732 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
734 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
735 == (SVf_ROK|SVprv_WEAKREF))
736 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
737 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
739 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
741 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
742 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
743 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
745 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
746 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
747 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
749 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
750 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
752 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
753 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
754 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
756 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
757 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
758 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
760 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
761 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
762 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
764 #define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
765 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
766 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
768 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
769 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
770 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
772 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
773 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
774 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
776 #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
777 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
778 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
780 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
781 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
782 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
785 /* The following uses the FAKE flag to show that a regex pointer is infact
786 its own offset in the regexpad for ithreads */
787 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
788 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
789 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
792 #ifdef PERL_DEBUG_COW
793 #define SvRV(sv) (0 + (sv)->sv_u.sv_rv)
795 #define SvRV(sv) ((sv)->sv_u.sv_rv)
797 #define SvRVx(sv) SvRV(sv)
799 #ifdef PERL_DEBUG_COW
800 #define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
801 #define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
802 #define SvNVX(sv) (0 + ((XPVNV*) SvANY(sv))->xnv_nv)
803 #define SvPVX(sv) (0 + (sv)->sv_u.sv_pv)
804 #define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
805 #define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
806 #define SvEND(sv) ((sv)->sv_u.sv_pv + ((XPV*)SvANY(sv))->xpv_cur)
810 /* Can't make this RVALUE because of Perl_sv_unmagic. */
811 # define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
813 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
815 #define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
818 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
820 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_magic)
822 #define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
825 #define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
826 #define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
827 #define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_nv
828 #define SvPVX(sv) ((sv)->sv_u.sv_pv)
829 #define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
830 #define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
831 #define SvEND(sv) ((sv)->sv_u.sv_pv + ((XPV*)SvANY(sv))->xpv_cur)
834 #define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
835 #define SvSTASH(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
837 #define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
838 #define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
843 #define SvIVXx(sv) SvIVX(sv)
844 #define SvUVXx(sv) SvUVX(sv)
845 #define SvNVXx(sv) SvNVX(sv)
846 #define SvPVXx(sv) SvPVX(sv)
847 #define SvLENx(sv) SvLEN(sv)
848 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
851 /* Ask a scalar nicely to try to become an IV, if possible.
852 Not guaranteed to stay returning void */
853 /* Macro won't actually call sv_2iv if already IOK */
854 #define SvIV_please(sv) \
855 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
856 (void) SvIV(sv); } STMT_END
857 #define SvIV_set(sv, val) \
858 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
859 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
860 #define SvNV_set(sv, val) \
861 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
862 (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END
863 #define SvPV_set(sv, val) \
864 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
865 ((sv)->sv_u.sv_pv = (val)); } STMT_END
866 #define SvUV_set(sv, val) \
867 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
868 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
869 #define SvRV_set(sv, val) \
870 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
871 ((sv)->sv_u.sv_rv = (val)); } STMT_END
872 #define SvMAGIC_set(sv, val) \
873 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
874 (((XPVMG*)SvANY(sv))->xmg_magic = (val)); } STMT_END
875 #define SvSTASH_set(sv, val) \
876 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
877 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
878 #define SvCUR_set(sv, val) \
879 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
880 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
881 #define SvLEN_set(sv, val) \
882 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
883 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
884 #define SvEND_set(sv, val) \
885 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
886 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
888 #define SvPV_renew(sv,n) \
889 STMT_START { SvLEN_set(sv, n); \
890 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
891 (char*)saferealloc((Malloc_t)SvPVX(sv), \
892 (MEM_SIZE)((n))))); \
895 #define SvPV_shrink_to_cur(sv) STMT_START { \
896 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
897 SvPV_renew(sv, _lEnGtH); \
900 #define SvPV_free(sv) \
901 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
904 Safefree(SvPVX(sv) - SvIVX(sv)); \
905 SvFLAGS(sv) &= ~SVf_OOK; \
907 Safefree(SvPVX(sv)); \
912 #define SvPVX_const(sv) ((const char*)SvPVX(sv))
914 #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
915 #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
916 #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
918 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
920 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
921 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
922 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
923 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
925 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
926 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
927 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
928 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
929 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
930 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
931 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
932 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
933 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
934 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
935 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
936 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
937 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
938 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
939 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
940 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
941 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
943 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
944 #define IoTYPE_RDONLY '<'
945 #define IoTYPE_WRONLY '>'
946 #define IoTYPE_RDWR '+'
947 #define IoTYPE_APPEND 'a'
948 #define IoTYPE_PIPE '|'
949 #define IoTYPE_STD '-' /* stdin or stdout */
950 #define IoTYPE_SOCKET 's'
951 #define IoTYPE_CLOSED ' '
952 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
953 #define IoTYPE_NUMERIC '#' /* fdopen */
956 =for apidoc Am|bool|SvTAINTED|SV* sv
957 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
960 =for apidoc Am|void|SvTAINTED_on|SV* sv
961 Marks an SV as tainted if tainting is enabled.
963 =for apidoc Am|void|SvTAINTED_off|SV* sv
964 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
965 some of Perl's fundamental security features. XS module authors should not
966 use this function unless they fully understand all the implications of
967 unconditionally untainting the value. Untainting should be done in the
968 standard perl fashion, via a carefully crafted regexp, rather than directly
969 untainting variables.
971 =for apidoc Am|void|SvTAINT|SV* sv
972 Taints an SV if tainting is enabled.
977 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
978 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
979 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
981 #define SvTAINT(sv) \
990 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
991 Like C<SvPV> but will force the SV into containing just a string
992 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
995 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
996 Like C<SvPV> but will force the SV into containing just a string
997 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
998 directly. Doesn't process magic.
1000 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1001 Returns a pointer to the string in the SV, or a stringified form of
1002 the SV if the SV does not contain a string. The SV may cache the
1003 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
1004 C<SvPVx> for a version which guarantees to evaluate sv only once.
1006 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1007 A version of C<SvPV> which guarantees to evaluate sv only once.
1009 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1010 Like C<SvPV> but doesn't process magic.
1012 =for apidoc Am|char*|SvPV_nolen|SV* sv
1013 Returns a pointer to the string in the SV, or a stringified form of
1014 the SV if the SV does not contain a string. The SV may cache the
1015 stringified form becoming C<SvPOK>. Handles 'get' magic.
1017 =for apidoc Am|IV|SvIV|SV* sv
1018 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1019 version which guarantees to evaluate sv only once.
1021 =for apidoc Am|IV|SvIV_nomg|SV* sv
1022 Like C<SvIV> but doesn't process magic.
1024 =for apidoc Am|IV|SvIVx|SV* sv
1025 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1026 sv only once. Use the more efficient C<SvIV> otherwise.
1028 =for apidoc Am|NV|SvNV|SV* sv
1029 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1030 which guarantees to evaluate sv only once.
1032 =for apidoc Am|NV|SvNVx|SV* sv
1033 Coerces the given SV to a double and returns it. Guarantees to evaluate
1034 sv only once. Use the more efficient C<SvNV> otherwise.
1036 =for apidoc Am|UV|SvUV|SV* sv
1037 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1038 for a version which guarantees to evaluate sv only once.
1040 =for apidoc Am|UV|SvUV_nomg|SV* sv
1041 Like C<SvUV> but doesn't process magic.
1043 =for apidoc Am|UV|SvUVx|SV* sv
1044 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1045 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1047 =for apidoc Am|bool|SvTRUE|SV* sv
1048 Returns a boolean indicating whether Perl would evaluate the SV as true or
1049 false, defined or undefined. Does not handle 'get' magic.
1051 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1052 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1054 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1055 Like C<SvPV>, but converts sv to utf8 first if necessary.
1057 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1058 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1060 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1061 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1063 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1064 Like C<SvPV>, but converts sv to byte representation first if necessary.
1066 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1067 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1069 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1070 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1071 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1074 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1075 Like C<SvPV>, but converts sv to utf8 first if necessary.
1076 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1079 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1080 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1081 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1084 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1085 Like C<SvPV>, but converts sv to byte representation first if necessary.
1086 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1089 =for apidoc Am|bool|SvIsCOW|SV* sv
1090 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1091 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1094 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1095 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1098 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1099 Like C<sv_catpvn> but doesn't process magic.
1101 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1102 Like C<sv_setsv> but doesn't process magic.
1104 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1105 Like C<sv_catsv> but doesn't process magic.
1110 /* Let us hope that bitmaps for UV and IV are the same */
1111 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1112 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1113 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1115 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1116 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1120 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1122 #define SvPV_flags(sv, lp, flags) \
1123 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1124 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1126 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1128 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1130 #define SvPV_force_flags(sv, lp, flags) \
1131 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1132 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1134 #define SvPV_nolen(sv) \
1135 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1136 ? SvPVX(sv) : sv_2pv_nolen(sv))
1138 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1142 #define SvPVutf8(sv, lp) \
1143 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1144 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1146 #define SvPVutf8_force(sv, lp) \
1147 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1148 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1151 #define SvPVutf8_nolen(sv) \
1152 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1153 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
1157 #define SvPVbyte(sv, lp) \
1158 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1159 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1161 #define SvPVbyte_force(sv, lp) \
1162 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1163 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1165 #define SvPVbyte_nolen(sv) \
1166 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1167 ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
1171 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1172 * var to evaluate the arg once; failing that, use a global if possible;
1173 * failing that, call a function to do the work
1176 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1177 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1178 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1180 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1182 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1183 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1184 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1185 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1186 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1187 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1188 # define SvTRUE(sv) ( \
1192 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1194 (nxpv->xpv_cur > 1 || \
1195 (nxpv->xpv_cur && *(sv)->sv_u.sv_pv != '0')); }) \
1202 ? SvNVX(sv) != 0.0 \
1204 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1206 #else /* __GNUC__ */
1208 /* These inlined macros use globals, which will require a thread
1209 * declaration in user code, so we avoid them under threads */
1211 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1212 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1213 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1214 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1215 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1216 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1217 # define SvTRUE(sv) ( \
1221 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1222 (PL_Xpv->xpv_cur > 1 || \
1223 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.sv_pv != '0')) \
1230 ? SvNVX(sv) != 0.0 \
1232 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1233 #endif /* __GNU__ */
1235 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1236 (SVf_FAKE | SVf_READONLY))
1237 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1239 /* flag values for sv_*_flags functions */
1240 #define SV_IMMEDIATE_UNREF 1
1242 #define SV_COW_DROP_PV 4
1243 #define SV_UTF8_NO_ENCODING 8
1244 #define SV_NOSTEAL 16
1246 /* We are about to replace the SV's current value. So if it's copy on write
1247 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1248 the value is about to get thrown away, so drop the PV rather than go to
1249 the effort of making a read-write copy only for it to get immediately
1252 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1253 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1255 #ifdef PERL_COPY_ON_WRITE
1256 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1257 && Perl_sv_release_IVX(aTHX_ sv)))
1258 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1260 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1261 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1262 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1263 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1266 # define SvRELEASE_IVX(sv) SvOOK_off(sv)
1267 #endif /* PERL_COPY_ON_WRITE */
1269 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1270 sv_force_normal_flags(sv, 0)
1273 /* all these 'functions' are now just macros */
1275 #define sv_pv(sv) SvPV_nolen(sv)
1276 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1277 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1279 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1280 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1281 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1282 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1283 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1284 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1285 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1286 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1287 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1288 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1289 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1290 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1291 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1292 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1294 /* Should be named SvCatPVN_utf8_upgrade? */
1295 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1298 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1300 sv_setpvn(nsv, sstr, slen); \
1302 sv_utf8_upgrade(nsv); \
1303 sv_catsv(dsv, nsv); \
1307 =for apidoc Am|SV*|newRV_inc|SV* sv
1309 Creates an RV wrapper for an SV. The reference count for the original SV is
1315 #define newRV_inc(sv) newRV(sv)
1317 /* the following macros update any magic values this sv is associated with */
1320 =head1 Magical Functions
1322 =for apidoc Am|void|SvGETMAGIC|SV* sv
1323 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1324 argument more than once.
1326 =for apidoc Am|void|SvSETMAGIC|SV* sv
1327 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1328 argument more than once.
1330 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1331 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1334 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1335 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1336 ssv. May evaluate arguments more than once.
1338 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1339 Like C<SvSetSV>, but does any set magic required afterwards.
1341 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1342 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1344 =for apidoc Am|void|SvSHARE|SV* sv
1345 Arranges for sv to be shared between threads if a suitable module
1348 =for apidoc Am|void|SvLOCK|SV* sv
1349 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1352 =for apidoc Am|void|SvUNLOCK|SV* sv
1353 Releases a mutual exclusion lock on sv if a suitable module
1356 =head1 SV Manipulation Functions
1358 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1359 Expands the character buffer in the SV so that it has room for the
1360 indicated number of bytes (remember to reserve space for an extra trailing
1361 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1362 Returns a pointer to the character buffer.
1367 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1368 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1369 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1371 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1372 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1374 #define SvSetSV_and(dst,src,finally) \
1376 if ((dst) != (src)) { \
1377 sv_setsv(dst, src); \
1381 #define SvSetSV_nosteal_and(dst,src,finally) \
1383 if ((dst) != (src)) { \
1384 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL); \
1389 #define SvSetSV(dst,src) \
1390 SvSetSV_and(dst,src,/*nothing*/;)
1391 #define SvSetSV_nosteal(dst,src) \
1392 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1394 #define SvSetMagicSV(dst,src) \
1395 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1396 #define SvSetMagicSV_nosteal(dst,src) \
1397 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1400 #if !defined(SKIP_DEBUGGING)
1401 #define SvPEEK(sv) sv_peek(sv)
1403 #define SvPEEK(sv) ""
1406 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1408 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1410 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1412 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1413 #define Sv_Grow sv_grow
1415 #define CLONEf_COPY_STACKS 1
1416 #define CLONEf_KEEP_PTR_TABLE 2
1417 #define CLONEf_CLONE_HOST 4
1418 #define CLONEf_JOIN_IN 8
1420 struct clone_params {
1423 PerlInterpreter *proto_perl;