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 */
71 #ifdef DEBUG_LEAKING_SCALARS
72 unsigned sv_debug_optype:9; /* the type of OP that allocated us */
73 unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */
74 unsigned sv_debug_cloned:1; /* was cloned for an ithread */
75 unsigned sv_debug_line:16; /* the line where we were allocated */
76 char * sv_debug_file; /* the file where we were allocated */
81 XPVGV* sv_any; /* pointer to something */
82 U32 sv_refcnt; /* how many references to us */
83 U32 sv_flags; /* what we are */
87 XPVCV* sv_any; /* pointer to something */
88 U32 sv_refcnt; /* how many references to us */
89 U32 sv_flags; /* what we are */
93 XPVAV* sv_any; /* pointer to something */
94 U32 sv_refcnt; /* how many references to us */
95 U32 sv_flags; /* what we are */
99 XPVHV* sv_any; /* pointer to something */
100 U32 sv_refcnt; /* how many references to us */
101 U32 sv_flags; /* what we are */
105 XPVIO* sv_any; /* pointer to something */
106 U32 sv_refcnt; /* how many references to us */
107 U32 sv_flags; /* what we are */
111 =head1 SV Manipulation Functions
113 =for apidoc Am|U32|SvREFCNT|SV* sv
114 Returns the value of the object's reference count.
116 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
117 Increments the reference count of the given SV.
119 =for apidoc Am|void|SvREFCNT_dec|SV* sv
120 Decrements the reference count of the given SV.
122 =for apidoc Am|svtype|SvTYPE|SV* sv
123 Returns the type of the SV. See C<svtype>.
125 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
126 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
127 perform the upgrade if necessary. See C<svtype>.
132 #define SvANY(sv) (sv)->sv_any
133 #define SvFLAGS(sv) (sv)->sv_flags
134 #define SvREFCNT(sv) (sv)->sv_refcnt
136 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
137 # define SvREFCNT_inc(sv) \
139 SV *_sv = (SV*)(sv); \
145 # define SvREFCNT_inc(sv) \
146 ((PL_Sv=(SV*)(sv)), (PL_Sv && ++(SvREFCNT(PL_Sv))), (SV*)PL_Sv)
149 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
150 # define SvREFCNT_dec(sv) \
152 SV *_sv = (SV*)(sv); \
154 if (SvREFCNT(_sv)) { \
155 if (--(SvREFCNT(_sv)) == 0) \
156 Perl_sv_free2(aTHX_ _sv); \
163 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
166 #define SVTYPEMASK 0xff
167 #define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
169 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
171 #define SVs_PADSTALE 0x00000100 /* lexical has gone out of scope */
172 #define SVs_PADTMP 0x00000200 /* in use as tmp */
173 #define SVs_PADMY 0x00000400 /* in use a "my" variable */
174 #define SVs_TEMP 0x00000800 /* string is stealable? */
175 #define SVs_OBJECT 0x00001000 /* is "blessed" */
176 #define SVs_GMG 0x00002000 /* has magical get method */
177 #define SVs_SMG 0x00004000 /* has magical set method */
178 #define SVs_RMG 0x00008000 /* has random magical methods */
180 #define SVf_IOK 0x00010000 /* has valid public integer value */
181 #define SVf_NOK 0x00020000 /* has valid public numeric value */
182 #define SVf_POK 0x00040000 /* has valid public pointer value */
183 #define SVf_ROK 0x00080000 /* has a valid reference pointer */
185 #define SVf_FAKE 0x00100000 /* glob or lexical is just a copy */
186 #define SVf_OOK 0x00200000 /* has valid offset value */
187 #define SVf_BREAK 0x00400000 /* refcnt is artificially low - used
188 * by SV's in final arena cleanup */
189 #define SVf_READONLY 0x00800000 /* may not be modified */
192 #define SVp_IOK 0x01000000 /* has valid non-public integer value */
193 #define SVp_NOK 0x02000000 /* has valid non-public numeric value */
194 #define SVp_POK 0x04000000 /* has valid non-public pointer value */
195 #define SVp_SCREAM 0x08000000 /* has been studied? */
197 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
198 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
200 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
202 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
203 SVp_IOK|SVp_NOK|SVp_POK)
205 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
207 #define PRIVSHIFT 8 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
209 /* Some private flags. */
211 /* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
212 #define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
213 #define SVpad_TYPED 0x40000000 /* Typed Lexical */
215 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
217 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
219 #define SVpbm_VALID 0x80000000
220 #define SVpbm_TAIL 0x40000000
222 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
224 #define SVphv_CLONEABLE 0x08000000 /* for stashes: clone its objects */
225 #define SVphv_REHASH 0x10000000 /* HV is recalculating hash values */
226 #define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */
227 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
228 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
230 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
233 SV * xrv_rv; /* pointer to another SV */
237 char * xpv_pv; /* pointer to malloced string */
238 STRLEN xpv_cur; /* length of xpv_pv as a C string */
239 STRLEN xpv_len; /* allocated size */
243 char * xpv_pv; /* pointer to malloced string */
244 STRLEN xpv_cur; /* length of xpv_pv as a C string */
245 STRLEN xpv_len; /* allocated size */
246 IV xiv_iv; /* integer value or pv offset */
250 char * xpv_pv; /* pointer to malloced string */
251 STRLEN xpv_cur; /* length of xpv_pv as a C string */
252 STRLEN xpv_len; /* allocated size */
253 UV xuv_uv; /* unsigned value or pv offset */
257 char * xpv_pv; /* pointer to malloced string */
258 STRLEN xpv_cur; /* length of xpv_pv as a C string */
259 STRLEN xpv_len; /* allocated size */
260 IV xiv_iv; /* integer value or pv offset */
261 NV xnv_nv; /* numeric value, if any */
264 /* These structure must match the beginning of struct xpvhv in hv.h. */
266 char * xpv_pv; /* pointer to malloced string */
267 STRLEN xpv_cur; /* length of xpv_pv as a C string */
268 STRLEN xpv_len; /* allocated size */
269 IV xiv_iv; /* integer value or pv offset */
270 NV xnv_nv; /* numeric value, if any */
271 MAGIC* xmg_magic; /* linked list of magicalness */
272 HV* xmg_stash; /* class package */
276 char * xpv_pv; /* pointer to malloced string */
277 STRLEN xpv_cur; /* length of xpv_pv as a C string */
278 STRLEN xpv_len; /* allocated size */
279 IV xiv_iv; /* integer value or pv offset */
280 NV xnv_nv; /* numeric value, if any */
281 MAGIC* xmg_magic; /* linked list of magicalness */
282 HV* xmg_stash; /* class package */
284 /* a full glob fits into this */
294 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
295 * y=alem/helem/iter t=tie T=tied HE */
299 char * xpv_pv; /* pointer to malloced string */
300 STRLEN xpv_cur; /* length of xpv_pv as a C string */
301 STRLEN xpv_len; /* allocated size */
302 IV xiv_iv; /* integer value or pv offset */
303 NV xnv_nv; /* numeric value, if any */
304 MAGIC* xmg_magic; /* linked list of magicalness */
305 HV* xmg_stash; /* class package */
315 char * xpv_pv; /* pointer to malloced string */
316 STRLEN xpv_cur; /* length of xpv_pv as a C string */
317 STRLEN xpv_len; /* allocated size */
318 IV xiv_iv; /* integer value or pv offset */
319 NV xnv_nv; /* numeric value, if any */
320 MAGIC* xmg_magic; /* linked list of magicalness */
321 HV* xmg_stash; /* class package */
323 I32 xbm_useful; /* is this constant pattern being useful? */
324 U16 xbm_previous; /* how many characters in string before rare? */
325 U8 xbm_rare; /* rarest character in string */
328 /* This structure must match XPVCV in cv.h */
330 typedef U16 cv_flags_t;
333 char * xpv_pv; /* pointer to malloced string */
334 STRLEN xpv_cur; /* length of xpv_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 */
344 void (*xcv_xsub)(pTHX_ CV*);
348 long xcv_depth; /* >= 2 indicates recursive call */
351 cv_flags_t xcv_flags;
352 U32 xcv_outside_seq; /* the COP sequence (at the point of our
353 * compilation) in the lexically enclosing
359 char * xpv_pv; /* pointer to malloced string */
360 STRLEN xpv_cur; /* length of xpv_pv as a C string */
361 STRLEN xpv_len; /* allocated size */
362 IV xiv_iv; /* integer value or pv offset */
363 NV xnv_nv; /* numeric value, if any */
364 MAGIC* xmg_magic; /* linked list of magicalness */
365 HV* xmg_stash; /* class package */
367 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
368 PerlIO * xio_ofp; /* but sockets need separate streams */
369 /* Cray addresses everything by word boundaries (64 bits) and
370 * code and data pointers cannot be mixed (which is exactly what
371 * Perl_filter_add() tries to do with the dirp), hence the following
372 * union trick (as suggested by Gurusamy Sarathy).
373 * For further information see Geir Johansen's problem report titled
374 [ID 20000612.002] Perl problem on Cray system
375 * The any pointer (known as IoANY()) will also be a good place
376 * to hang any IO disciplines to.
379 DIR * xiou_dirp; /* for opendir, readdir, etc */
380 void * xiou_any; /* for alignment */
382 IV xio_lines; /* $. */
383 IV xio_page; /* $% */
384 IV xio_page_len; /* $= */
385 IV xio_lines_left; /* $- */
386 char * xio_top_name; /* $^ */
387 GV * xio_top_gv; /* $^ */
388 char * xio_fmt_name; /* $~ */
389 GV * xio_fmt_gv; /* $~ */
390 char * xio_bottom_name;/* $^B */
391 GV * xio_bottom_gv; /* $^B */
392 short xio_subprocess; /* -| or |- */
396 #define xio_dirp xio_dirpu.xiou_dirp
397 #define xio_any xio_dirpu.xiou_any
399 #define IOf_ARGV 1 /* this fp iterates over ARGV */
400 #define IOf_START 2 /* check for null ARGV and substitute '-' */
401 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
402 #define IOf_DIDTOP 8 /* just did top of form */
403 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
404 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
405 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
407 /* The following macros define implementation-independent predicates on SVs. */
410 =for apidoc Am|bool|SvNIOK|SV* sv
411 Returns a boolean indicating whether the SV contains a number, integer or
414 =for apidoc Am|bool|SvNIOKp|SV* sv
415 Returns a boolean indicating whether the SV contains a number, integer or
416 double. Checks the B<private> setting. Use C<SvNIOK>.
418 =for apidoc Am|void|SvNIOK_off|SV* sv
419 Unsets the NV/IV status of an SV.
421 =for apidoc Am|bool|SvOK|SV* sv
422 Returns a boolean indicating whether the value is an SV. It also tells
423 whether the value is defined or not.
425 =for apidoc Am|bool|SvIOKp|SV* sv
426 Returns a boolean indicating whether the SV contains an integer. Checks
427 the B<private> setting. Use C<SvIOK>.
429 =for apidoc Am|bool|SvNOKp|SV* sv
430 Returns a boolean indicating whether the SV contains a double. Checks the
431 B<private> setting. Use C<SvNOK>.
433 =for apidoc Am|bool|SvPOKp|SV* sv
434 Returns a boolean indicating whether the SV contains a character string.
435 Checks the B<private> setting. Use C<SvPOK>.
437 =for apidoc Am|bool|SvIOK|SV* sv
438 Returns a boolean indicating whether the SV contains an integer.
440 =for apidoc Am|void|SvIOK_on|SV* sv
441 Tells an SV that it is an integer.
443 =for apidoc Am|void|SvIOK_off|SV* sv
444 Unsets the IV status of an SV.
446 =for apidoc Am|void|SvIOK_only|SV* sv
447 Tells an SV that it is an integer and disables all other OK bits.
449 =for apidoc Am|void|SvIOK_only_UV|SV* sv
450 Tells and SV that it is an unsigned integer and disables all other OK bits.
452 =for apidoc Am|bool|SvIOK_UV|SV* sv
453 Returns a boolean indicating whether the SV contains an unsigned integer.
455 =for apidoc Am|void|SvUOK|SV* sv
456 Returns a boolean indicating whether the SV contains an unsigned integer.
458 =for apidoc Am|bool|SvIOK_notUV|SV* sv
459 Returns a boolean indicating whether the SV contains a signed integer.
461 =for apidoc Am|bool|SvNOK|SV* sv
462 Returns a boolean indicating whether the SV contains a double.
464 =for apidoc Am|void|SvNOK_on|SV* sv
465 Tells an SV that it is a double.
467 =for apidoc Am|void|SvNOK_off|SV* sv
468 Unsets the NV status of an SV.
470 =for apidoc Am|void|SvNOK_only|SV* sv
471 Tells an SV that it is a double and disables all other OK bits.
473 =for apidoc Am|bool|SvPOK|SV* sv
474 Returns a boolean indicating whether the SV contains a character
477 =for apidoc Am|void|SvPOK_on|SV* sv
478 Tells an SV that it is a string.
480 =for apidoc Am|void|SvPOK_off|SV* sv
481 Unsets the PV status of an SV.
483 =for apidoc Am|void|SvPOK_only|SV* sv
484 Tells an SV that it is a string and disables all other OK bits.
485 Will also turn off the UTF-8 status.
487 =for apidoc Am|bool|SvVOK|SV* sv
488 Returns a boolean indicating whether the SV contains a v-string.
490 =for apidoc Am|bool|SvOOK|SV* sv
491 Returns a boolean indicating whether the SvIVX is a valid offset value for
492 the SvPVX. This hack is used internally to speed up removal of characters
493 from the beginning of a SvPV. When SvOOK is true, then the start of the
494 allocated string buffer is really (SvPVX - SvIVX).
496 =for apidoc Am|bool|SvROK|SV* sv
497 Tests if the SV is an RV.
499 =for apidoc Am|void|SvROK_on|SV* sv
500 Tells an SV that it is an RV.
502 =for apidoc Am|void|SvROK_off|SV* sv
503 Unsets the RV status of an SV.
505 =for apidoc Am|SV*|SvRV|SV* sv
506 Dereferences an RV to return the SV.
508 =for apidoc Am|IV|SvIVX|SV* sv
509 Returns the raw value in the SV's IV slot, without checks or conversions.
510 Only use when you are sure SvIOK is true. See also C<SvIV()>.
512 =for apidoc Am|UV|SvUVX|SV* sv
513 Returns the raw value in the SV's UV slot, without checks or conversions.
514 Only use when you are sure SvIOK is true. See also C<SvUV()>.
516 =for apidoc Am|NV|SvNVX|SV* sv
517 Returns the raw value in the SV's NV slot, without checks or conversions.
518 Only use when you are sure SvNOK is true. See also C<SvNV()>.
520 =for apidoc Am|char*|SvPVX|SV* sv
521 Returns a pointer to the physical string in the SV. The SV must contain a
524 =for apidoc Am|STRLEN|SvCUR|SV* sv
525 Returns the length of the string which is in the SV. See C<SvLEN>.
527 =for apidoc Am|STRLEN|SvLEN|SV* sv
528 Returns the size of the string buffer in the SV, not including any part
529 attributable to C<SvOOK>. See C<SvCUR>.
531 =for apidoc Am|char*|SvEND|SV* sv
532 Returns a pointer to the last character in the string which is in the SV.
533 See C<SvCUR>. Access the character as *(SvEND(sv)).
535 =for apidoc Am|HV*|SvSTASH|SV* sv
536 Returns the stash of the SV.
538 =for apidoc Am|void|SvIV_set|SV* sv|IV val
539 Set the value of the IV pointer in sv to val.
541 =for apidoc Am|void|SvNV_set|SV* sv|NV val
542 Set the value of the IV pointer in sv to val.
544 =for apidoc Am|void|SvPV_set|SV* sv|char* val
545 Set the value of the PV pointer in sv to val.
547 =for apidoc Am|void|SvUV_set|SV* sv|UV val
548 Set the value of the PV pointer in sv to val.
550 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
551 Set the value of the RV pointer in sv to val.
553 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
554 Set the value of the MAGIC pointer in sv to val.
556 =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
557 Set the value of the STASH pointer in sv to val.
559 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
560 Set the current length of the string which is in the SV. See C<SvCUR>.
562 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
563 Set the actual length of the string which is in the SV.
568 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
569 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
570 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
571 SVp_IOK|SVp_NOK|SVf_IVisUV))
573 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
574 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
576 #define assert_not_ROK(sv)
579 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
580 #define SvOK_off(sv) (assert_not_ROK(sv) \
581 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
582 SVf_IVisUV|SVf_UTF8), \
584 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
585 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
589 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
590 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
591 #define SvIOKp_on(sv) (SvRELEASE_IVX(sv), \
592 SvFLAGS(sv) |= SVp_IOK)
593 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
594 #define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
595 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
596 #define SvPOKp_on(sv) (assert_not_ROK(sv) \
597 SvFLAGS(sv) |= SVp_POK)
599 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
600 #define SvIOK_on(sv) (SvRELEASE_IVX(sv), \
601 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
602 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
603 #define SvIOK_only(sv) (SvOK_off(sv), \
604 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
605 #define SvIOK_only_UV(sv) (SvOK_off_exc_UV(sv), \
606 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
608 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
609 == (SVf_IOK|SVf_IVisUV))
610 #define SvUOK(sv) SvIOK_UV(sv)
611 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
614 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
615 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
616 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
618 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
619 #define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
620 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
621 #define SvNOK_only(sv) (SvOK_off(sv), \
622 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
625 =for apidoc Am|bool|SvUTF8|SV* sv
626 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
628 =for apidoc Am|void|SvUTF8_on|SV *sv
629 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
630 Do not use frivolously.
632 =for apidoc Am|void|SvUTF8_off|SV *sv
633 Unsets the UTF-8 status of an SV.
635 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
636 Tells an SV that it is a string and disables all other OK bits,
637 and leaves the UTF-8 status as it was.
642 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
644 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
645 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
646 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
648 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
649 #define SvPOK_on(sv) (assert_not_ROK(sv) \
650 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
651 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
652 #define SvPOK_only(sv) (assert_not_ROK(sv) \
653 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
654 SVf_IVisUV|SVf_UTF8), \
655 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
656 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) \
657 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
659 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
661 #define SvVOK(sv) (SvMAGICAL(sv) && mg_find(sv,'V'))
662 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
663 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
664 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
666 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
667 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
668 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
670 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
671 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
672 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
674 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
675 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
676 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
678 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
679 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
680 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
682 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
683 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
684 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
686 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
687 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
688 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
690 #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
691 #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
692 #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
694 #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
697 #define Gv_AMG(stash) \
698 (HV_AMAGICmb(stash) && \
699 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
701 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
703 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
704 == (SVf_ROK|SVprv_WEAKREF))
705 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
706 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
708 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
710 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
711 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
712 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
714 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
715 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
716 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
718 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
719 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
721 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
722 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
723 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
725 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
726 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
727 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
729 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
730 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
731 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
733 #define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
734 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
735 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
737 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
738 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
739 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
741 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
742 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
743 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
745 #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
746 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
747 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
749 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
750 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
751 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
754 /* The following uses the FAKE flag to show that a regex pointer is infact
755 its own offset in the regexpad for ithreads */
756 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
757 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
758 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
761 #ifdef PERL_DEBUG_COW
762 #define SvRV(sv) (0 + ((XRV*) SvANY(sv))->xrv_rv)
764 #define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
766 #define SvRVx(sv) SvRV(sv)
768 #ifdef PERL_DEBUG_COW
769 #define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
770 #define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
771 #define SvNVX(sv) (0 + ((XPVNV*) SvANY(sv))->xnv_nv)
772 #define SvPVX(sv) (0 + ((XPV*) SvANY(sv))->xpv_pv)
773 #define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
774 #define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
775 #define SvEND(sv) (((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
779 /* Can't make this RVALUE because of Perl_sv_unmagic. */
780 # define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
782 # define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
784 #define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
787 # define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
789 # define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_magic)
791 #define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
794 #define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
795 #define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
796 #define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_nv
797 #define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
798 #define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
799 #define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
800 #define SvEND(sv) (((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
803 #define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
804 #define SvSTASH(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
806 #define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
807 #define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
812 #define SvIVXx(sv) SvIVX(sv)
813 #define SvUVXx(sv) SvUVX(sv)
814 #define SvNVXx(sv) SvNVX(sv)
815 #define SvPVXx(sv) SvPVX(sv)
816 #define SvLENx(sv) SvLEN(sv)
817 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
820 /* Ask a scalar nicely to try to become an IV, if possible.
821 Not guaranteed to stay returning void */
822 /* Macro won't actually call sv_2iv if already IOK */
823 #define SvIV_please(sv) \
824 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
825 (void) SvIV(sv); } STMT_END
826 #define SvIV_set(sv, val) \
827 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
828 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
829 #define SvNV_set(sv, val) \
830 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
831 (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END
832 #define SvPV_set(sv, val) \
833 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
834 (((XPV*) SvANY(sv))->xpv_pv = (val)); } STMT_END
835 #define SvUV_set(sv, val) \
836 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
837 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
838 #define SvRV_set(sv, val) \
839 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
840 (((XRV*)SvANY(sv))->xrv_rv = (val)); } STMT_END
841 #define SvMAGIC_set(sv, val) \
842 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
843 (((XPVMG*)SvANY(sv))->xmg_magic = (val)); } STMT_END
844 #define SvSTASH_set(sv, val) \
845 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
846 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
847 #define SvCUR_set(sv, val) \
848 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
849 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
850 #define SvLEN_set(sv, val) \
851 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
852 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
853 #define SvEND_set(sv, val) \
854 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
855 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
857 #define SvPV_renew(sv,n) \
858 STMT_START { SvLEN_set(sv, n); \
859 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
860 (char*)saferealloc((Malloc_t)SvPVX(sv), \
861 (MEM_SIZE)((n))))); \
864 #define SvPV_shrink_to_cur(sv) STMT_START { \
865 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
866 SvPV_renew(sv, _lEnGtH); \
869 #define SvPV_free(sv) \
870 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
873 Safefree(SvPVX(sv) - SvIVX(sv)); \
874 SvFLAGS(sv) &= ~SVf_OOK; \
876 Safefree(SvPVX(sv)); \
881 #define SvPVX_const(sv) ((const char*)SvPVX(sv))
883 #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
884 #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
885 #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
887 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
889 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
890 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
891 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
892 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
894 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
895 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
896 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
897 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
898 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
899 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
900 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
901 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
902 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
903 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
904 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
905 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
906 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
907 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
908 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
909 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
910 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
912 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
913 #define IoTYPE_RDONLY '<'
914 #define IoTYPE_WRONLY '>'
915 #define IoTYPE_RDWR '+'
916 #define IoTYPE_APPEND 'a'
917 #define IoTYPE_PIPE '|'
918 #define IoTYPE_STD '-' /* stdin or stdout */
919 #define IoTYPE_SOCKET 's'
920 #define IoTYPE_CLOSED ' '
921 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
922 #define IoTYPE_NUMERIC '#' /* fdopen */
925 =for apidoc Am|bool|SvTAINTED|SV* sv
926 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
929 =for apidoc Am|void|SvTAINTED_on|SV* sv
930 Marks an SV as tainted if tainting is enabled.
932 =for apidoc Am|void|SvTAINTED_off|SV* sv
933 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
934 some of Perl's fundamental security features. XS module authors should not
935 use this function unless they fully understand all the implications of
936 unconditionally untainting the value. Untainting should be done in the
937 standard perl fashion, via a carefully crafted regexp, rather than directly
938 untainting variables.
940 =for apidoc Am|void|SvTAINT|SV* sv
941 Taints an SV if tainting is enabled.
946 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
947 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
948 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
950 #define SvTAINT(sv) \
959 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
960 Like C<SvPV> but will force the SV into containing just a string
961 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
964 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
965 Like C<SvPV> but will force the SV into containing just a string
966 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
967 directly. Doesn't process magic.
969 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
970 Returns a pointer to the string in the SV, or a stringified form of
971 the SV if the SV does not contain a string. The SV may cache the
972 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
973 C<SvPVx> for a version which guarantees to evaluate sv only once.
975 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
976 A version of C<SvPV> which guarantees to evaluate sv only once.
978 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
979 Like C<SvPV> but doesn't process magic.
981 =for apidoc Am|char*|SvPV_nolen|SV* sv
982 Returns a pointer to the string in the SV, or a stringified form of
983 the SV if the SV does not contain a string. The SV may cache the
984 stringified form becoming C<SvPOK>. Handles 'get' magic.
986 =for apidoc Am|IV|SvIV|SV* sv
987 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
988 version which guarantees to evaluate sv only once.
990 =for apidoc Am|IV|SvIV_nomg|SV* sv
991 Like C<SvIV> but doesn't process magic.
993 =for apidoc Am|IV|SvIVx|SV* sv
994 Coerces the given SV to an integer and returns it. Guarantees to evaluate
995 sv only once. Use the more efficient C<SvIV> otherwise.
997 =for apidoc Am|NV|SvNV|SV* sv
998 Coerce the given SV to a double and return it. See C<SvNVx> for a version
999 which guarantees to evaluate sv only once.
1001 =for apidoc Am|NV|SvNVx|SV* sv
1002 Coerces the given SV to a double and returns it. Guarantees to evaluate
1003 sv only once. Use the more efficient C<SvNV> otherwise.
1005 =for apidoc Am|UV|SvUV|SV* sv
1006 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1007 for a version which guarantees to evaluate sv only once.
1009 =for apidoc Am|UV|SvUV_nomg|SV* sv
1010 Like C<SvUV> but doesn't process magic.
1012 =for apidoc Am|UV|SvUVx|SV* sv
1013 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1014 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1016 =for apidoc Am|bool|SvTRUE|SV* sv
1017 Returns a boolean indicating whether Perl would evaluate the SV as true or
1018 false, defined or undefined. Does not handle 'get' magic.
1020 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1021 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1023 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1024 Like C<SvPV>, but converts sv to utf8 first if necessary.
1026 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1027 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1029 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1030 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1032 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1033 Like C<SvPV>, but converts sv to byte representation first if necessary.
1035 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1036 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1038 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1039 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1040 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1043 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1044 Like C<SvPV>, but converts sv to utf8 first if necessary.
1045 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1048 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1049 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1050 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1053 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1054 Like C<SvPV>, but converts sv to byte representation first if necessary.
1055 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1058 =for apidoc Am|bool|SvIsCOW|SV* sv
1059 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1060 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1063 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1064 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1067 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1068 Like C<sv_catpvn> but doesn't process magic.
1070 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1071 Like C<sv_setsv> but doesn't process magic.
1073 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1074 Like C<sv_catsv> but doesn't process magic.
1079 /* Let us hope that bitmaps for UV and IV are the same */
1080 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1081 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1082 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1084 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1085 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1089 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1091 #define SvPV_flags(sv, lp, flags) \
1092 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1093 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1095 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1097 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1099 #define SvPV_force_flags(sv, lp, flags) \
1100 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1101 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1103 #define SvPV_nolen(sv) \
1104 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1105 ? SvPVX(sv) : sv_2pv_nolen(sv))
1107 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1111 #define SvPVutf8(sv, lp) \
1112 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1113 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1115 #define SvPVutf8_force(sv, lp) \
1116 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1117 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1120 #define SvPVutf8_nolen(sv) \
1121 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1122 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
1126 #define SvPVbyte(sv, lp) \
1127 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1128 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1130 #define SvPVbyte_force(sv, lp) \
1131 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1132 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1134 #define SvPVbyte_nolen(sv) \
1135 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1136 ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
1140 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1141 * var to evaluate the arg once; failing that, use a global if possible;
1142 * failing that, call a function to do the work
1145 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1146 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1147 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1149 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1151 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1152 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1153 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1154 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1155 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1156 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1157 # define SvTRUE(sv) ( \
1161 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1163 (nxpv->xpv_cur > 1 || \
1164 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
1171 ? SvNVX(sv) != 0.0 \
1173 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1175 #else /* __GNUC__ */
1177 /* These inlined macros use globals, which will require a thread
1178 * declaration in user code, so we avoid them under threads */
1180 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1181 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1182 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1183 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1184 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1185 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1186 # define SvTRUE(sv) ( \
1190 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
1191 (PL_Xpv->xpv_cur > 1 || \
1192 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
1199 ? SvNVX(sv) != 0.0 \
1201 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1202 #endif /* __GNU__ */
1204 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1205 (SVf_FAKE | SVf_READONLY))
1206 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1208 /* flag values for sv_*_flags functions */
1209 #define SV_IMMEDIATE_UNREF 1
1211 #define SV_COW_DROP_PV 4
1212 #define SV_UTF8_NO_ENCODING 8
1213 #define SV_NOSTEAL 16
1215 /* We are about to replace the SV's current value. So if it's copy on write
1216 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1217 the value is about to get thrown away, so drop the PV rather than go to
1218 the effort of making a read-write copy only for it to get immediately
1221 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1222 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1224 #ifdef PERL_COPY_ON_WRITE
1225 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1226 && Perl_sv_release_IVX(aTHX_ sv)))
1227 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1229 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1230 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1231 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1232 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1235 # define SvRELEASE_IVX(sv) SvOOK_off(sv)
1236 #endif /* PERL_COPY_ON_WRITE */
1238 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1239 sv_force_normal_flags(sv, 0)
1242 /* all these 'functions' are now just macros */
1244 #define sv_pv(sv) SvPV_nolen(sv)
1245 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1246 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1248 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1249 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1250 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1251 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1252 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1253 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1254 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1255 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1256 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1257 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1258 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1259 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1260 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1261 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1263 /* Should be named SvCatPVN_utf8_upgrade? */
1264 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1267 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1269 sv_setpvn(nsv, sstr, slen); \
1271 sv_utf8_upgrade(nsv); \
1272 sv_catsv(dsv, nsv); \
1276 =for apidoc Am|SV*|newRV_inc|SV* sv
1278 Creates an RV wrapper for an SV. The reference count for the original SV is
1284 #define newRV_inc(sv) newRV(sv)
1286 /* the following macros update any magic values this sv is associated with */
1289 =head1 Magical Functions
1291 =for apidoc Am|void|SvGETMAGIC|SV* sv
1292 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1293 argument more than once.
1295 =for apidoc Am|void|SvSETMAGIC|SV* sv
1296 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1297 argument more than once.
1299 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1300 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1303 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1304 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1305 ssv. May evaluate arguments more than once.
1307 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1308 Like C<SvSetSV>, but does any set magic required afterwards.
1310 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1311 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1313 =for apidoc Am|void|SvSHARE|SV* sv
1314 Arranges for sv to be shared between threads if a suitable module
1317 =for apidoc Am|void|SvLOCK|SV* sv
1318 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1321 =for apidoc Am|void|SvUNLOCK|SV* sv
1322 Releases a mutual exclusion lock on sv if a suitable module
1325 =head1 SV Manipulation Functions
1327 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1328 Expands the character buffer in the SV so that it has room for the
1329 indicated number of bytes (remember to reserve space for an extra trailing
1330 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1331 Returns a pointer to the character buffer.
1336 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1337 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1338 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1340 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1341 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1343 #define SvSetSV_and(dst,src,finally) \
1345 if ((dst) != (src)) { \
1346 sv_setsv(dst, src); \
1350 #define SvSetSV_nosteal_and(dst,src,finally) \
1352 if ((dst) != (src)) { \
1353 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL); \
1358 #define SvSetSV(dst,src) \
1359 SvSetSV_and(dst,src,/*nothing*/;)
1360 #define SvSetSV_nosteal(dst,src) \
1361 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1363 #define SvSetMagicSV(dst,src) \
1364 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1365 #define SvSetMagicSV_nosteal(dst,src) \
1366 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1369 #if !defined(SKIP_DEBUGGING)
1370 #define SvPEEK(sv) sv_peek(sv)
1372 #define SvPEEK(sv) ""
1375 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1377 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1379 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1381 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1382 #define Sv_Grow sv_grow
1384 #define CLONEf_COPY_STACKS 1
1385 #define CLONEf_KEEP_PTR_TABLE 2
1386 #define CLONEf_CLONE_HOST 4
1387 #define CLONEf_JOIN_IN 8
1389 struct clone_params {
1392 PerlInterpreter *proto_perl;