3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 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 XPVGV* sv_any; /* pointer to something */
75 U32 sv_refcnt; /* how many references to us */
76 U32 sv_flags; /* what we are */
80 XPVCV* sv_any; /* pointer to something */
81 U32 sv_refcnt; /* how many references to us */
82 U32 sv_flags; /* what we are */
86 XPVAV* sv_any; /* pointer to something */
87 U32 sv_refcnt; /* how many references to us */
88 U32 sv_flags; /* what we are */
92 XPVHV* sv_any; /* pointer to something */
93 U32 sv_refcnt; /* how many references to us */
94 U32 sv_flags; /* what we are */
98 XPVIO* sv_any; /* pointer to something */
99 U32 sv_refcnt; /* how many references to us */
100 U32 sv_flags; /* what we are */
104 =head1 SV Manipulation Functions
106 =for apidoc Am|U32|SvREFCNT|SV* sv
107 Returns the value of the object's reference count.
109 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
110 Increments the reference count of the given SV.
112 =for apidoc Am|void|SvREFCNT_dec|SV* sv
113 Decrements the reference count of the given SV.
115 =for apidoc Am|svtype|SvTYPE|SV* sv
116 Returns the type of the SV. See C<svtype>.
118 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
119 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
120 perform the upgrade if necessary. See C<svtype>.
125 #define SvANY(sv) (sv)->sv_any
126 #define SvFLAGS(sv) (sv)->sv_flags
127 #define SvREFCNT(sv) (sv)->sv_refcnt
129 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
130 # define SvREFCNT_inc(sv) \
132 SV *_sv = (SV*)(sv); \
138 # define SvREFCNT_inc(sv) \
139 ((PL_Sv=(SV*)(sv)), (PL_Sv && ++(SvREFCNT(PL_Sv))), (SV*)PL_Sv)
142 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
143 # define SvREFCNT_dec(sv) \
145 SV *_sv = (SV*)(sv); \
147 if (SvREFCNT(_sv)) { \
148 if (--(SvREFCNT(_sv)) == 0) \
149 Perl_sv_free2(aTHX_ _sv); \
156 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
159 #define SVTYPEMASK 0xff
160 #define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
162 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
164 #define SVs_PADSTALE 0x00000100 /* lexical has gone out of scope */
165 #define SVs_PADTMP 0x00000200 /* in use as tmp */
166 #define SVs_PADMY 0x00000400 /* in use a "my" variable */
167 #define SVs_TEMP 0x00000800 /* string is stealable? */
168 #define SVs_OBJECT 0x00001000 /* is "blessed" */
169 #define SVs_GMG 0x00002000 /* has magical get method */
170 #define SVs_SMG 0x00004000 /* has magical set method */
171 #define SVs_RMG 0x00008000 /* has random magical methods */
173 #define SVf_IOK 0x00010000 /* has valid public integer value */
174 #define SVf_NOK 0x00020000 /* has valid public numeric value */
175 #define SVf_POK 0x00040000 /* has valid public pointer value */
176 #define SVf_ROK 0x00080000 /* has a valid reference pointer */
178 #define SVf_FAKE 0x00100000 /* glob or lexical is just a copy */
179 #define SVf_OOK 0x00200000 /* has valid offset value */
180 #define SVf_BREAK 0x00400000 /* refcnt is artificially low - used
181 * by SV's in final arena cleanup */
182 #define SVf_READONLY 0x00800000 /* may not be modified */
185 #define SVp_IOK 0x01000000 /* has valid non-public integer value */
186 #define SVp_NOK 0x02000000 /* has valid non-public numeric value */
187 #define SVp_POK 0x04000000 /* has valid non-public pointer value */
188 #define SVp_SCREAM 0x08000000 /* has been studied? */
190 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
192 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
194 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
195 SVp_IOK|SVp_NOK|SVp_POK)
197 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
199 #define PRIVSHIFT 8 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
201 /* Some private flags. */
203 /* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
204 #define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
205 #define SVpad_TYPED 0x40000000 /* Typed Lexical */
207 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
209 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
211 #define SVpbm_VALID 0x80000000
212 #define SVpbm_TAIL 0x40000000
214 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
216 #define SVphv_REHASH 0x10000000 /* HV is recalculating hash values */
217 #define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */
218 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
219 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
221 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
224 SV * xrv_rv; /* pointer to another SV */
228 char * xpv_pv; /* pointer to malloced string */
229 STRLEN xpv_cur; /* length of xpv_pv as a C string */
230 STRLEN xpv_len; /* allocated size */
234 char * xpv_pv; /* pointer to malloced string */
235 STRLEN xpv_cur; /* length of xpv_pv as a C string */
236 STRLEN xpv_len; /* allocated size */
237 IV xiv_iv; /* integer value or pv offset */
241 char * xpv_pv; /* pointer to malloced string */
242 STRLEN xpv_cur; /* length of xpv_pv as a C string */
243 STRLEN xpv_len; /* allocated size */
244 UV xuv_uv; /* unsigned value or pv offset */
248 char * xpv_pv; /* pointer to malloced string */
249 STRLEN xpv_cur; /* length of xpv_pv as a C string */
250 STRLEN xpv_len; /* allocated size */
251 IV xiv_iv; /* integer value or pv offset */
252 NV xnv_nv; /* numeric value, if any */
255 /* These structure must match the beginning of struct xpvhv in hv.h. */
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 */
262 MAGIC* xmg_magic; /* linked list of magicalness */
263 HV* xmg_stash; /* class package */
267 char * xpv_pv; /* pointer to malloced string */
268 STRLEN xpv_cur; /* length of xpv_pv as a C string */
269 STRLEN xpv_len; /* allocated size */
270 IV xiv_iv; /* integer value or pv offset */
271 NV xnv_nv; /* numeric value, if any */
272 MAGIC* xmg_magic; /* linked list of magicalness */
273 HV* xmg_stash; /* class package */
278 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
279 * y=alem/helem/iter t=tie T=tied HE */
283 char * xpv_pv; /* pointer to malloced string */
284 STRLEN xpv_cur; /* length of xpv_pv as a C string */
285 STRLEN xpv_len; /* allocated size */
286 IV xiv_iv; /* integer value or pv offset */
287 NV xnv_nv; /* numeric value, if any */
288 MAGIC* xmg_magic; /* linked list of magicalness */
289 HV* xmg_stash; /* class package */
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 */
307 I32 xbm_useful; /* is this constant pattern being useful? */
308 U16 xbm_previous; /* how many characters in string before rare? */
309 U8 xbm_rare; /* rarest character in string */
312 /* This structure must match XPVCV in cv.h */
314 typedef U16 cv_flags_t;
317 char * xpv_pv; /* pointer to malloced string */
318 STRLEN xpv_cur; /* length of xpv_pv as a C string */
319 STRLEN xpv_len; /* allocated size */
320 IV xiv_iv; /* integer value or pv offset */
321 NV xnv_nv; /* numeric value, if any */
322 MAGIC* xmg_magic; /* linked list of magicalness */
323 HV* xmg_stash; /* class package */
328 void (*xcv_xsub)(pTHX_ CV*);
332 long xcv_depth; /* >= 2 indicates recursive call */
335 cv_flags_t xcv_flags;
336 U32 xcv_outside_seq; /* the COP sequence (at the point of our
337 * compilation) in the lexically enclosing
343 char * xpv_pv; /* pointer to malloced string */
344 STRLEN xpv_cur; /* length of xpv_pv as a C string */
345 STRLEN xpv_len; /* allocated size */
346 IV xiv_iv; /* integer value or pv offset */
347 NV xnv_nv; /* numeric value, if any */
348 MAGIC* xmg_magic; /* linked list of magicalness */
349 HV* xmg_stash; /* class package */
351 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
352 PerlIO * xio_ofp; /* but sockets need separate streams */
353 /* Cray addresses everything by word boundaries (64 bits) and
354 * code and data pointers cannot be mixed (which is exactly what
355 * Perl_filter_add() tries to do with the dirp), hence the following
356 * union trick (as suggested by Gurusamy Sarathy).
357 * For further information see Geir Johansen's problem report titled
358 [ID 20000612.002] Perl problem on Cray system
359 * The any pointer (known as IoANY()) will also be a good place
360 * to hang any IO disciplines to.
363 DIR * xiou_dirp; /* for opendir, readdir, etc */
364 void * xiou_any; /* for alignment */
366 IV xio_lines; /* $. */
367 IV xio_page; /* $% */
368 IV xio_page_len; /* $= */
369 IV xio_lines_left; /* $- */
370 char * xio_top_name; /* $^ */
371 GV * xio_top_gv; /* $^ */
372 char * xio_fmt_name; /* $~ */
373 GV * xio_fmt_gv; /* $~ */
374 char * xio_bottom_name;/* $^B */
375 GV * xio_bottom_gv; /* $^B */
376 short xio_subprocess; /* -| or |- */
380 #define xio_dirp xio_dirpu.xiou_dirp
381 #define xio_any xio_dirpu.xiou_any
383 #define IOf_ARGV 1 /* this fp iterates over ARGV */
384 #define IOf_START 2 /* check for null ARGV and substitute '-' */
385 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
386 #define IOf_DIDTOP 8 /* just did top of form */
387 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
388 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
389 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
391 /* The following macros define implementation-independent predicates on SVs. */
394 =for apidoc Am|bool|SvNIOK|SV* sv
395 Returns a boolean indicating whether the SV contains a number, integer or
398 =for apidoc Am|bool|SvNIOKp|SV* sv
399 Returns a boolean indicating whether the SV contains a number, integer or
400 double. Checks the B<private> setting. Use C<SvNIOK>.
402 =for apidoc Am|void|SvNIOK_off|SV* sv
403 Unsets the NV/IV status of an SV.
405 =for apidoc Am|bool|SvOK|SV* sv
406 Returns a boolean indicating whether the value is an SV.
408 =for apidoc Am|bool|SvIOKp|SV* sv
409 Returns a boolean indicating whether the SV contains an integer. Checks
410 the B<private> setting. Use C<SvIOK>.
412 =for apidoc Am|bool|SvNOKp|SV* sv
413 Returns a boolean indicating whether the SV contains a double. Checks the
414 B<private> setting. Use C<SvNOK>.
416 =for apidoc Am|bool|SvPOKp|SV* sv
417 Returns a boolean indicating whether the SV contains a character string.
418 Checks the B<private> setting. Use C<SvPOK>.
420 =for apidoc Am|bool|SvIOK|SV* sv
421 Returns a boolean indicating whether the SV contains an integer.
423 =for apidoc Am|void|SvIOK_on|SV* sv
424 Tells an SV that it is an integer.
426 =for apidoc Am|void|SvIOK_off|SV* sv
427 Unsets the IV status of an SV.
429 =for apidoc Am|void|SvIOK_only|SV* sv
430 Tells an SV that it is an integer and disables all other OK bits.
432 =for apidoc Am|void|SvIOK_only_UV|SV* sv
433 Tells and SV that it is an unsigned integer and disables all other OK bits.
435 =for apidoc Am|void|SvIOK_UV|SV* sv
436 Returns a boolean indicating whether the SV contains an unsigned integer.
438 =for apidoc Am|void|SvUOK|SV* sv
439 Returns a boolean indicating whether the SV contains an unsigned integer.
441 =for apidoc Am|void|SvIOK_notUV|SV* sv
442 Returns a boolean indicating whether the SV contains a signed integer.
444 =for apidoc Am|bool|SvNOK|SV* sv
445 Returns a boolean indicating whether the SV contains a double.
447 =for apidoc Am|void|SvNOK_on|SV* sv
448 Tells an SV that it is a double.
450 =for apidoc Am|void|SvNOK_off|SV* sv
451 Unsets the NV status of an SV.
453 =for apidoc Am|void|SvNOK_only|SV* sv
454 Tells an SV that it is a double and disables all other OK bits.
456 =for apidoc Am|bool|SvPOK|SV* sv
457 Returns a boolean indicating whether the SV contains a character
460 =for apidoc Am|void|SvPOK_on|SV* sv
461 Tells an SV that it is a string.
463 =for apidoc Am|void|SvPOK_off|SV* sv
464 Unsets the PV status of an SV.
466 =for apidoc Am|void|SvPOK_only|SV* sv
467 Tells an SV that it is a string and disables all other OK bits.
468 Will also turn off the UTF-8 status.
470 =for apidoc Am|bool|SvVOK|SV* sv
471 Returns a boolean indicating whether the SV contains a v-string.
473 =for apidoc Am|bool|SvOOK|SV* sv
474 Returns a boolean indicating whether the SvIVX is a valid offset value for
475 the SvPVX. This hack is used internally to speed up removal of characters
476 from the beginning of a SvPV. When SvOOK is true, then the start of the
477 allocated string buffer is really (SvPVX - SvIVX).
479 =for apidoc Am|bool|SvROK|SV* sv
480 Tests if the SV is an RV.
482 =for apidoc Am|void|SvROK_on|SV* sv
483 Tells an SV that it is an RV.
485 =for apidoc Am|void|SvROK_off|SV* sv
486 Unsets the RV status of an SV.
488 =for apidoc Am|SV*|SvRV|SV* sv
489 Dereferences an RV to return the SV.
491 =for apidoc Am|IV|SvIVX|SV* sv
492 Returns the raw value in the SV's IV slot, without checks or conversions.
493 Only use when you are sure SvIOK is true. See also C<SvIV()>.
495 =for apidoc Am|UV|SvUVX|SV* sv
496 Returns the raw value in the SV's UV slot, without checks or conversions.
497 Only use when you are sure SvIOK is true. See also C<SvUV()>.
499 =for apidoc Am|NV|SvNVX|SV* sv
500 Returns the raw value in the SV's NV slot, without checks or conversions.
501 Only use when you are sure SvNOK is true. See also C<SvNV()>.
503 =for apidoc Am|char*|SvPVX|SV* sv
504 Returns a pointer to the physical string in the SV. The SV must contain a
507 =for apidoc Am|STRLEN|SvCUR|SV* sv
508 Returns the length of the string which is in the SV. See C<SvLEN>.
510 =for apidoc Am|STRLEN|SvLEN|SV* sv
511 Returns the size of the string buffer in the SV, not including any part
512 attributable to C<SvOOK>. See C<SvCUR>.
514 =for apidoc Am|char*|SvEND|SV* sv
515 Returns a pointer to the last character in the string which is in the SV.
516 See C<SvCUR>. Access the character as *(SvEND(sv)).
518 =for apidoc Am|HV*|SvSTASH|SV* sv
519 Returns the stash of the SV.
521 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
522 Set the length of the string which is in the SV. See C<SvCUR>.
527 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
528 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
529 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
530 SVp_IOK|SVp_NOK|SVf_IVisUV))
532 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
533 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
535 #define assert_not_ROK(sv)
538 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
539 #define SvOK_off(sv) (assert_not_ROK(sv) \
540 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
541 SVf_IVisUV|SVf_UTF8), \
543 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
544 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
548 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
549 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
550 #define SvIOKp_on(sv) (SvRELEASE_IVX(sv), \
551 SvFLAGS(sv) |= SVp_IOK)
552 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
553 #define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
554 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
555 #define SvPOKp_on(sv) (assert_not_ROK(sv) \
556 SvFLAGS(sv) |= SVp_POK)
558 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
559 #define SvIOK_on(sv) (SvRELEASE_IVX(sv), \
560 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
561 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
562 #define SvIOK_only(sv) ((void)SvOK_off(sv), \
563 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
564 #define SvIOK_only_UV(sv) ((void)SvOK_off_exc_UV(sv), \
565 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
567 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
568 == (SVf_IOK|SVf_IVisUV))
569 #define SvUOK(sv) SvIOK_UV(sv)
570 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
573 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
574 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
575 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
577 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
578 #define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
579 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
580 #define SvNOK_only(sv) ((void)SvOK_off(sv), \
581 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
584 =for apidoc Am|void|SvUTF8|SV* sv
585 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
587 =for apidoc Am|void|SvUTF8_on|SV *sv
588 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
589 Do not use frivolously.
591 =for apidoc Am|void|SvUTF8_off|SV *sv
592 Unsets the UTF-8 status of an SV.
594 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
595 Tells an SV that it is a string and disables all other OK bits,
596 and leaves the UTF-8 status as it was.
601 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
602 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
603 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
605 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
606 #define SvPOK_on(sv) (assert_not_ROK(sv) \
607 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
608 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
609 #define SvPOK_only(sv) (assert_not_ROK(sv) \
610 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
611 SVf_IVisUV|SVf_UTF8), \
612 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
613 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) \
614 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
616 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
618 #define SvVOK(sv) (SvMAGICAL(sv) && mg_find(sv,'V'))
619 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
620 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
621 #define SvOOK_off(sv) (SvOOK(sv) && sv_backoff(sv))
623 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
624 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
625 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
627 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
628 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
629 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
631 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
632 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
633 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
635 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
636 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
637 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
639 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
640 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
641 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
643 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
644 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
645 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
647 #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
648 #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
649 #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
651 #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
654 #define Gv_AMG(stash) \
655 (HV_AMAGICmb(stash) && \
656 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
658 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
660 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
661 == (SVf_ROK|SVprv_WEAKREF))
662 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
663 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
665 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
667 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
668 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
669 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
671 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
672 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
673 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
675 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
676 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
678 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
679 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
680 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
682 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
683 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
684 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
686 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
687 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
688 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
690 #define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
691 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
692 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
694 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
695 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
696 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
698 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
699 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
700 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
702 #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
703 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
704 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
706 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
707 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
708 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
711 /* The following uses the FAKE flag to show that a regex pointer is infact
712 its own offset in the regexpad for ithreads */
713 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
714 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
715 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
718 #define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
719 #define SvRVx(sv) SvRV(sv)
721 #define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
722 #define SvIVXx(sv) SvIVX(sv)
723 #define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
724 #define SvUVXx(sv) SvUVX(sv)
725 #define SvNVX(sv) ((XPVNV*)SvANY(sv))->xnv_nv
726 #define SvNVXx(sv) SvNVX(sv)
727 #define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
728 #define SvPVXx(sv) SvPVX(sv)
729 #define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
730 #define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
731 #define SvLENx(sv) SvLEN(sv)
732 #define SvEND(sv)(((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
733 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
734 #define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
735 #define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
737 /* Ask a scalar nicely to try to become an IV, if possible.
738 Not guaranteed to stay returning void */
739 /* Macro won't actually call sv_2iv if already IOK */
740 #define SvIV_please(sv) \
741 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
742 (void) SvIV(sv); } STMT_END
743 #define SvIV_set(sv, val) \
744 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
745 (((XPVIV*) SvANY(sv))->xiv_iv = val); } STMT_END
746 #define SvNV_set(sv, val) \
747 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
748 (((XPVNV*) SvANY(sv))->xnv_nv = val); } STMT_END
749 #define SvPV_set(sv, val) \
750 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
751 (((XPV*) SvANY(sv))->xpv_pv = val); } STMT_END
752 #define SvCUR_set(sv, val) \
753 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
754 (((XPV*) SvANY(sv))->xpv_cur = val); } STMT_END
755 #define SvLEN_set(sv, val) \
756 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
757 (((XPV*) SvANY(sv))->xpv_len = val); } STMT_END
758 #define SvEND_set(sv, val) \
759 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
760 (((XPV*) SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
762 #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
763 #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
764 #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
766 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
768 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
769 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
770 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
771 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
773 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
774 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
775 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
776 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
777 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
778 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
779 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
780 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
781 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
782 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
783 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
784 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
785 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
786 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
787 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
788 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
789 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
791 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
792 #define IoTYPE_RDONLY '<'
793 #define IoTYPE_WRONLY '>'
794 #define IoTYPE_RDWR '+'
795 #define IoTYPE_APPEND 'a'
796 #define IoTYPE_PIPE '|'
797 #define IoTYPE_STD '-' /* stdin or stdout */
798 #define IoTYPE_SOCKET 's'
799 #define IoTYPE_CLOSED ' '
800 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
801 #define IoTYPE_NUMERIC '#' /* fdopen */
804 =for apidoc Am|bool|SvTAINTED|SV* sv
805 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
808 =for apidoc Am|void|SvTAINTED_on|SV* sv
809 Marks an SV as tainted if tainting is enabled.
811 =for apidoc Am|void|SvTAINTED_off|SV* sv
812 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
813 some of Perl's fundamental security features. XS module authors should not
814 use this function unless they fully understand all the implications of
815 unconditionally untainting the value. Untainting should be done in the
816 standard perl fashion, via a carefully crafted regexp, rather than directly
817 untainting variables.
819 =for apidoc Am|void|SvTAINT|SV* sv
820 Taints an SV if tainting is enabled.
825 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
826 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
827 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
829 #define SvTAINT(sv) \
838 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
839 Like C<SvPV> but will force the SV into containing just a string
840 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
843 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
844 Like C<SvPV> but will force the SV into containing just a string
845 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
846 directly. Doesn't process magic.
848 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
849 Returns a pointer to the string in the SV, or a stringified form of
850 the SV if the SV does not contain a string. The SV may cache the
851 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
852 C<SvPVx> for a version which guarantees to evaluate sv only once.
854 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
855 A version of C<SvPV> which guarantees to evaluate sv only once.
857 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
858 Like C<SvPV> but doesn't process magic.
860 =for apidoc Am|char*|SvPV_nolen|SV* sv
861 Returns a pointer to the string in the SV, or a stringified form of
862 the SV if the SV does not contain a string. The SV may cache the
863 stringified form becoming C<SvPOK>. Handles 'get' magic.
865 =for apidoc Am|IV|SvIV|SV* sv
866 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
867 version which guarantees to evaluate sv only once.
869 =for apidoc Am|IV|SvIV_nomg|SV* sv
870 Like C<SvIV> but doesn't process magic.
872 =for apidoc Am|IV|SvIVx|SV* sv
873 Coerces the given SV to an integer and returns it. Guarantees to evaluate
874 sv only once. Use the more efficient C<SvIV> otherwise.
876 =for apidoc Am|NV|SvNV|SV* sv
877 Coerce the given SV to a double and return it. See C<SvNVx> for a version
878 which guarantees to evaluate sv only once.
880 =for apidoc Am|NV|SvNVx|SV* sv
881 Coerces the given SV to a double and returns it. Guarantees to evaluate
882 sv only once. Use the more efficient C<SvNV> otherwise.
884 =for apidoc Am|UV|SvUV|SV* sv
885 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
886 for a version which guarantees to evaluate sv only once.
888 =for apidoc Am|UV|SvUV_nomg|SV* sv
889 Like C<SvUV> but doesn't process magic.
891 =for apidoc Am|UV|SvUVx|SV* sv
892 Coerces the given SV to an unsigned integer and returns it. Guarantees to
893 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
895 =for apidoc Am|bool|SvTRUE|SV* sv
896 Returns a boolean indicating whether Perl would evaluate the SV as true or
897 false, defined or undefined. Does not handle 'get' magic.
899 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
900 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
902 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
903 Like C<SvPV>, but converts sv to utf8 first if necessary.
905 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
906 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
908 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
909 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
911 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
912 Like C<SvPV>, but converts sv to byte representation first if necessary.
914 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
915 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
917 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
918 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
919 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
922 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
923 Like C<SvPV>, but converts sv to utf8 first if necessary.
924 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
927 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
928 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
929 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
932 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
933 Like C<SvPV>, but converts sv to byte representation first if necessary.
934 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
937 =for apidoc Am|bool|SvIsCOW|SV* sv
938 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
939 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
942 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
943 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
949 /* Let us hope that bitmaps for UV and IV are the same */
950 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
951 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
952 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
954 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
955 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
959 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
961 #define SvPV_flags(sv, lp, flags) \
962 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
963 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
965 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
967 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
969 #define SvPV_force_flags(sv, lp, flags) \
970 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
971 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
973 #define SvPV_nolen(sv) \
974 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
975 ? SvPVX(sv) : sv_2pv_nolen(sv))
977 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
981 #define SvPVutf8(sv, lp) \
982 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
983 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
985 #define SvPVutf8_force(sv, lp) \
986 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
987 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
990 #define SvPVutf8_nolen(sv) \
991 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
992 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
996 #define SvPVbyte(sv, lp) \
997 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
998 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1000 #define SvPVbyte_force(sv, lp) \
1001 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1002 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyte_force(sv, &lp))
1004 #define SvPVbyte_nolen(sv) \
1005 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1006 ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
1010 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1011 * var to evaluate the arg once; failing that, use a global if possible;
1012 * failing that, call a function to do the work
1015 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1016 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1017 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1019 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1021 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1022 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1023 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1024 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1025 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1026 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1027 # define SvTRUE(sv) ( \
1031 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1033 (nxpv->xpv_cur > 1 || \
1034 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
1041 ? SvNVX(sv) != 0.0 \
1043 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1045 #else /* __GNUC__ */
1047 /* These inlined macros use globals, which will require a thread
1048 * declaration in user code, so we avoid them under threads */
1050 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1051 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1052 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1053 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1054 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1055 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1056 # define SvTRUE(sv) ( \
1060 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
1061 (PL_Xpv->xpv_cur > 1 || \
1062 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
1069 ? SvNVX(sv) != 0.0 \
1071 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1072 #endif /* __GNU__ */
1074 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1075 (SVf_FAKE | SVf_READONLY))
1076 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1078 /* flag values for sv_*_flags functions */
1079 #define SV_IMMEDIATE_UNREF 1
1081 #define SV_COW_DROP_PV 4
1082 #define SV_UTF8_NO_ENCODING 8
1084 /* We are about to replace the SV's current value. So if it's copy on write
1085 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1086 the value is about to get thrown away, so drop the PV rather than go to
1087 the effort of making a read-write copy only for it to get immediately
1090 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1091 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1093 #ifdef PERL_COPY_ON_WRITE
1094 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1095 && Perl_sv_release_IVX(aTHX_ sv)))
1096 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1098 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1099 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1100 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1101 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1104 # define SvRELEASE_IVX(sv) ((void)SvOOK_off(sv))
1105 #endif /* PERL_COPY_ON_WRITE */
1107 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1108 sv_force_normal_flags(sv, 0)
1111 /* all these 'functions' are now just macros */
1113 #define sv_pv(sv) SvPV_nolen(sv)
1114 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1115 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1117 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1118 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1119 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1120 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1121 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1122 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1123 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1124 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1125 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1126 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1127 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1128 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1129 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1130 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1132 /* Should be named SvCatPVN_utf8_upgrade? */
1133 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1136 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1138 sv_setpvn(nsv, sstr, slen); \
1140 sv_utf8_upgrade(nsv); \
1141 sv_catsv(dsv, nsv); \
1145 =for apidoc Am|SV*|newRV_inc|SV* sv
1147 Creates an RV wrapper for an SV. The reference count for the original SV is
1153 #define newRV_inc(sv) newRV(sv)
1155 /* the following macros update any magic values this sv is associated with */
1158 =head1 Magical Functions
1160 =for apidoc Am|void|SvGETMAGIC|SV* sv
1161 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1162 argument more than once.
1164 =for apidoc Am|void|SvSETMAGIC|SV* sv
1165 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1166 argument more than once.
1168 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1169 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1172 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1173 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1174 ssv. May evaluate arguments more than once.
1176 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1177 Like C<SvSetSV>, but does any set magic required afterwards.
1179 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1180 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1182 =for apidoc Am|void|SvSHARE|SV* sv
1183 Arranges for sv to be shared between threads if a suitable module
1186 =for apidoc Am|void|SvLOCK|SV* sv
1187 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1190 =for apidoc Am|void|SvUNLOCK|SV* sv
1191 Releases a mutual exclusion lock on sv if a suitable module
1194 =head1 SV Manipulation Functions
1196 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1197 Expands the character buffer in the SV so that it has room for the
1198 indicated number of bytes (remember to reserve space for an extra trailing
1199 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1200 Returns a pointer to the character buffer.
1205 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1206 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1207 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1209 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1210 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1212 #define SvSetSV_and(dst,src,finally) \
1214 if ((dst) != (src)) { \
1215 sv_setsv(dst, src); \
1219 #define SvSetSV_nosteal_and(dst,src,finally) \
1221 if ((dst) != (src)) { \
1222 U32 tMpF = SvFLAGS(src) & SVs_TEMP; \
1224 sv_setsv(dst, src); \
1225 SvFLAGS(src) |= tMpF; \
1230 #define SvSetSV(dst,src) \
1231 SvSetSV_and(dst,src,/*nothing*/;)
1232 #define SvSetSV_nosteal(dst,src) \
1233 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1235 #define SvSetMagicSV(dst,src) \
1236 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1237 #define SvSetMagicSV_nosteal(dst,src) \
1238 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1241 #if !defined(SKIP_DEBUGGING)
1242 #define SvPEEK(sv) sv_peek(sv)
1244 #define SvPEEK(sv) ""
1247 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1249 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1251 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1253 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1254 #define Sv_Grow sv_grow
1256 #define CLONEf_COPY_STACKS 1
1257 #define CLONEf_KEEP_PTR_TABLE 2
1258 #define CLONEf_CLONE_HOST 4
1259 #define CLONEf_JOIN_IN 8
1261 struct clone_params {
1264 PerlInterpreter *proto_perl;