3 * Copyright (c) 1991-2002, Larry Wall
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
11 #undef sv_flags /* Convex has this in <signal.h> for sigvec() */
17 =for apidoc AmU||svtype
18 An enum of flags for Perl types. These are found in the file B<sv.h>
19 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
21 =for apidoc AmU||SVt_PV
22 Pointer type flag for scalars. See C<svtype>.
24 =for apidoc AmU||SVt_IV
25 Integer type flag for scalars. See C<svtype>.
27 =for apidoc AmU||SVt_NV
28 Double type flag for scalars. See C<svtype>.
30 =for apidoc AmU||SVt_PVMG
31 Type flag for blessed scalars. See C<svtype>.
33 =for apidoc AmU||SVt_PVAV
34 Type flag for arrays. See C<svtype>.
36 =for apidoc AmU||SVt_PVHV
37 Type flag for hashes. See C<svtype>.
39 =for apidoc AmU||SVt_PVCV
40 Type flag for code refs. See C<svtype>.
64 /* Using C's structural equivalence to help emulate C++ inheritance here... */
66 struct STRUCT_SV { /* struct sv { */
67 void* sv_any; /* pointer to something */
68 U32 sv_refcnt; /* how many references to us */
69 U32 sv_flags; /* what we are */
73 XPVGV* sv_any; /* pointer to something */
74 U32 sv_refcnt; /* how many references to us */
75 U32 sv_flags; /* what we are */
79 XPVCV* sv_any; /* pointer to something */
80 U32 sv_refcnt; /* how many references to us */
81 U32 sv_flags; /* what we are */
85 XPVAV* sv_any; /* pointer to something */
86 U32 sv_refcnt; /* how many references to us */
87 U32 sv_flags; /* what we are */
91 XPVHV* sv_any; /* pointer to something */
92 U32 sv_refcnt; /* how many references to us */
93 U32 sv_flags; /* what we are */
97 XPVIO* sv_any; /* pointer to something */
98 U32 sv_refcnt; /* how many references to us */
99 U32 sv_flags; /* what we are */
103 =head1 SV Manipulation Functions
105 =for apidoc Am|U32|SvREFCNT|SV* sv
106 Returns the value of the object's reference count.
108 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
109 Increments the reference count of the given SV.
111 =for apidoc Am|void|SvREFCNT_dec|SV* sv
112 Decrements the reference count of the given SV.
114 =for apidoc Am|svtype|SvTYPE|SV* sv
115 Returns the type of the SV. See C<svtype>.
117 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
118 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
119 perform the upgrade if necessary. See C<svtype>.
124 #define SvANY(sv) (sv)->sv_any
125 #define SvFLAGS(sv) (sv)->sv_flags
126 #define SvREFCNT(sv) (sv)->sv_refcnt
128 #define ATOMIC_INC(count) (++count)
129 #define ATOMIC_DEC_AND_TEST(res, count) (res = (--count == 0))
131 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
132 # define SvREFCNT_inc(sv) \
134 SV *nsv = (SV*)(sv); \
136 ATOMIC_INC(SvREFCNT(nsv)); \
140 # define SvREFCNT_inc(sv) \
141 ((PL_Sv=(SV*)(sv)), (PL_Sv && ATOMIC_INC(SvREFCNT(PL_Sv))), (SV*)PL_Sv)
144 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
146 #define SVTYPEMASK 0xff
147 #define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
149 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
151 #define SVs_PADSTALE 0x00000100 /* lexical has gone out of scope */
152 #define SVs_PADTMP 0x00000200 /* in use as tmp */
153 #define SVs_PADMY 0x00000400 /* in use a "my" variable */
154 #define SVs_TEMP 0x00000800 /* string is stealable? */
155 #define SVs_OBJECT 0x00001000 /* is "blessed" */
156 #define SVs_GMG 0x00002000 /* has magical get method */
157 #define SVs_SMG 0x00004000 /* has magical set method */
158 #define SVs_RMG 0x00008000 /* has random magical methods */
160 #define SVf_IOK 0x00010000 /* has valid public integer value */
161 #define SVf_NOK 0x00020000 /* has valid public numeric value */
162 #define SVf_POK 0x00040000 /* has valid public pointer value */
163 #define SVf_ROK 0x00080000 /* has a valid reference pointer */
165 #define SVf_FAKE 0x00100000 /* glob or lexical is just a copy */
166 #define SVf_OOK 0x00200000 /* has valid offset value */
167 #define SVf_BREAK 0x00400000 /* refcnt is artificially low - used
168 * by SV's in final arena cleanup */
169 #define SVf_READONLY 0x00800000 /* may not be modified */
172 #define SVp_IOK 0x01000000 /* has valid non-public integer value */
173 #define SVp_NOK 0x02000000 /* has valid non-public numeric value */
174 #define SVp_POK 0x04000000 /* has valid non-public pointer value */
175 #define SVp_SCREAM 0x08000000 /* has been studied? */
177 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
179 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
181 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
182 SVp_IOK|SVp_NOK|SVp_POK)
184 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
186 #define PRIVSHIFT 8 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
188 /* Some private flags. */
190 /* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
191 #define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
192 #define SVpad_TYPED 0x40000000 /* Typed Lexical */
194 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
196 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
198 #define SVpbm_VALID 0x80000000
199 #define SVpbm_TAIL 0x40000000
201 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
203 #define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */
204 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
205 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
207 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
210 SV * xrv_rv; /* pointer to another SV */
214 char * xpv_pv; /* pointer to malloced string */
215 STRLEN xpv_cur; /* length of xpv_pv as a C string */
216 STRLEN xpv_len; /* allocated size */
220 char * xpv_pv; /* pointer to malloced string */
221 STRLEN xpv_cur; /* length of xpv_pv as a C string */
222 STRLEN xpv_len; /* allocated size */
223 IV xiv_iv; /* integer value or pv offset */
227 char * xpv_pv; /* pointer to malloced string */
228 STRLEN xpv_cur; /* length of xpv_pv as a C string */
229 STRLEN xpv_len; /* allocated size */
230 UV xuv_uv; /* unsigned value or pv offset */
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 */
238 NV xnv_nv; /* numeric value, if any */
241 /* These structure must match the beginning of struct xpvhv in hv.h. */
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 */
247 NV xnv_nv; /* numeric value, if any */
248 MAGIC* xmg_magic; /* linked list of magicalness */
249 HV* xmg_stash; /* class package */
253 char * xpv_pv; /* pointer to malloced string */
254 STRLEN xpv_cur; /* length of xpv_pv as a C string */
255 STRLEN xpv_len; /* allocated size */
256 IV xiv_iv; /* integer value or pv offset */
257 NV xnv_nv; /* numeric value, if any */
258 MAGIC* xmg_magic; /* linked list of magicalness */
259 HV* xmg_stash; /* class package */
268 char * xpv_pv; /* pointer to malloced string */
269 STRLEN xpv_cur; /* length of xpv_pv as a C string */
270 STRLEN xpv_len; /* allocated size */
271 IV xiv_iv; /* integer value or pv offset */
272 NV xnv_nv; /* numeric value, if any */
273 MAGIC* xmg_magic; /* linked list of magicalness */
274 HV* xmg_stash; /* class package */
284 char * xpv_pv; /* pointer to malloced string */
285 STRLEN xpv_cur; /* length of xpv_pv as a C string */
286 STRLEN xpv_len; /* allocated size */
287 IV xiv_iv; /* integer value or pv offset */
288 NV xnv_nv; /* numeric value, if any */
289 MAGIC* xmg_magic; /* linked list of magicalness */
290 HV* xmg_stash; /* class package */
292 I32 xbm_useful; /* is this constant pattern being useful? */
293 U16 xbm_previous; /* how many characters in string before rare? */
294 U8 xbm_rare; /* rarest character in string */
297 /* This structure much match XPVCV in cv.h */
299 typedef U16 cv_flags_t;
302 char * xpv_pv; /* pointer to malloced string */
303 STRLEN xpv_cur; /* length of xpv_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 */
313 void (*xcv_xsub)(pTHX_ CV*);
317 long xcv_depth; /* >= 2 indicates recursive call */
320 cv_flags_t xcv_flags;
321 U32 xcv_outside_seq; /* the COP sequence (at the point of our
322 * compilation) in the lexically enclosing
328 char * xpv_pv; /* pointer to malloced string */
329 STRLEN xpv_cur; /* length of xpv_pv as a C string */
330 STRLEN xpv_len; /* allocated size */
331 IV xiv_iv; /* integer value or pv offset */
332 NV xnv_nv; /* numeric value, if any */
333 MAGIC* xmg_magic; /* linked list of magicalness */
334 HV* xmg_stash; /* class package */
336 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
337 PerlIO * xio_ofp; /* but sockets need separate streams */
338 /* Cray addresses everything by word boundaries (64 bits) and
339 * code and data pointers cannot be mixed (which is exactly what
340 * Perl_filter_add() tries to do with the dirp), hence the following
341 * union trick (as suggested by Gurusamy Sarathy).
342 * For further information see Geir Johansen's problem report titled
343 [ID 20000612.002] Perl problem on Cray system
344 * The any pointer (known as IoANY()) will also be a good place
345 * to hang any IO disciplines to.
348 DIR * xiou_dirp; /* for opendir, readdir, etc */
349 void * xiou_any; /* for alignment */
351 IV xio_lines; /* $. */
352 IV xio_page; /* $% */
353 IV xio_page_len; /* $= */
354 IV xio_lines_left; /* $- */
355 char * xio_top_name; /* $^ */
356 GV * xio_top_gv; /* $^ */
357 char * xio_fmt_name; /* $~ */
358 GV * xio_fmt_gv; /* $~ */
359 char * xio_bottom_name;/* $^B */
360 GV * xio_bottom_gv; /* $^B */
361 short xio_subprocess; /* -| or |- */
365 #define xio_dirp xio_dirpu.xiou_dirp
366 #define xio_any xio_dirpu.xiou_any
368 #define IOf_ARGV 1 /* this fp iterates over ARGV */
369 #define IOf_START 2 /* check for null ARGV and substitute '-' */
370 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
371 #define IOf_DIDTOP 8 /* just did top of form */
372 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
373 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
374 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
376 /* The following macros define implementation-independent predicates on SVs. */
379 =for apidoc Am|bool|SvNIOK|SV* sv
380 Returns a boolean indicating whether the SV contains a number, integer or
383 =for apidoc Am|bool|SvNIOKp|SV* sv
384 Returns a boolean indicating whether the SV contains a number, integer or
385 double. Checks the B<private> setting. Use C<SvNIOK>.
387 =for apidoc Am|void|SvNIOK_off|SV* sv
388 Unsets the NV/IV status of an SV.
390 =for apidoc Am|bool|SvOK|SV* sv
391 Returns a boolean indicating whether the value is an SV.
393 =for apidoc Am|bool|SvIOKp|SV* sv
394 Returns a boolean indicating whether the SV contains an integer. Checks
395 the B<private> setting. Use C<SvIOK>.
397 =for apidoc Am|bool|SvNOKp|SV* sv
398 Returns a boolean indicating whether the SV contains a double. Checks the
399 B<private> setting. Use C<SvNOK>.
401 =for apidoc Am|bool|SvPOKp|SV* sv
402 Returns a boolean indicating whether the SV contains a character string.
403 Checks the B<private> setting. Use C<SvPOK>.
405 =for apidoc Am|bool|SvIOK|SV* sv
406 Returns a boolean indicating whether the SV contains an integer.
408 =for apidoc Am|void|SvIOK_on|SV* sv
409 Tells an SV that it is an integer.
411 =for apidoc Am|void|SvIOK_off|SV* sv
412 Unsets the IV status of an SV.
414 =for apidoc Am|void|SvIOK_only|SV* sv
415 Tells an SV that it is an integer and disables all other OK bits.
417 =for apidoc Am|void|SvIOK_only_UV|SV* sv
418 Tells and SV that it is an unsigned integer and disables all other OK bits.
420 =for apidoc Am|void|SvIOK_UV|SV* sv
421 Returns a boolean indicating whether the SV contains an unsigned integer.
423 =for apidoc Am|void|SvUOK|SV* sv
424 Returns a boolean indicating whether the SV contains an unsigned integer.
426 =for apidoc Am|void|SvIOK_notUV|SV* sv
427 Returns a boolean indicating whether the SV contains a signed integer.
429 =for apidoc Am|bool|SvNOK|SV* sv
430 Returns a boolean indicating whether the SV contains a double.
432 =for apidoc Am|void|SvNOK_on|SV* sv
433 Tells an SV that it is a double.
435 =for apidoc Am|void|SvNOK_off|SV* sv
436 Unsets the NV status of an SV.
438 =for apidoc Am|void|SvNOK_only|SV* sv
439 Tells an SV that it is a double and disables all other OK bits.
441 =for apidoc Am|bool|SvPOK|SV* sv
442 Returns a boolean indicating whether the SV contains a character
445 =for apidoc Am|void|SvPOK_on|SV* sv
446 Tells an SV that it is a string.
448 =for apidoc Am|void|SvPOK_off|SV* sv
449 Unsets the PV status of an SV.
451 =for apidoc Am|void|SvPOK_only|SV* sv
452 Tells an SV that it is a string and disables all other OK bits.
453 Will also turn off the UTF8 status.
455 =for apidoc Am|bool|SvVOK|SV* sv
456 Returns a boolean indicating whether the SV contains a v-string.
458 =for apidoc Am|bool|SvOOK|SV* sv
459 Returns a boolean indicating whether the SvIVX is a valid offset value for
460 the SvPVX. This hack is used internally to speed up removal of characters
461 from the beginning of a SvPV. When SvOOK is true, then the start of the
462 allocated string buffer is really (SvPVX - SvIVX).
464 =for apidoc Am|bool|SvROK|SV* sv
465 Tests if the SV is an RV.
467 =for apidoc Am|void|SvROK_on|SV* sv
468 Tells an SV that it is an RV.
470 =for apidoc Am|void|SvROK_off|SV* sv
471 Unsets the RV status of an SV.
473 =for apidoc Am|SV*|SvRV|SV* sv
474 Dereferences an RV to return the SV.
476 =for apidoc Am|IV|SvIVX|SV* sv
477 Returns the raw value in the SV's IV slot, without checks or conversions.
478 Only use when you are sure SvIOK is true. See also C<SvIV()>.
480 =for apidoc Am|UV|SvUVX|SV* sv
481 Returns the raw value in the SV's UV slot, without checks or conversions.
482 Only use when you are sure SvIOK is true. See also C<SvUV()>.
484 =for apidoc Am|NV|SvNVX|SV* sv
485 Returns the raw value in the SV's NV slot, without checks or conversions.
486 Only use when you are sure SvNOK is true. See also C<SvNV()>.
488 =for apidoc Am|char*|SvPVX|SV* sv
489 Returns a pointer to the physical string in the SV. The SV must contain a
492 =for apidoc Am|STRLEN|SvCUR|SV* sv
493 Returns the length of the string which is in the SV. See C<SvLEN>.
495 =for apidoc Am|STRLEN|SvLEN|SV* sv
496 Returns the size of the string buffer in the SV, not including any part
497 attributable to C<SvOOK>. See C<SvCUR>.
499 =for apidoc Am|char*|SvEND|SV* sv
500 Returns a pointer to the last character in the string which is in the SV.
501 See C<SvCUR>. Access the character as *(SvEND(sv)).
503 =for apidoc Am|HV*|SvSTASH|SV* sv
504 Returns the stash of the SV.
506 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
507 Set the length of the string which is in the SV. See C<SvCUR>.
512 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
513 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
514 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
515 SVp_IOK|SVp_NOK|SVf_IVisUV))
518 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv))})
520 #define assert_not_ROK(sv) 0
523 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
524 #define SvOK_off(sv) (assert_not_ROK(sv), \
525 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
526 SVf_IVisUV|SVf_UTF8), \
528 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv), \
529 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
533 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
534 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
535 #define SvIOKp_on(sv) (SvRELEASE_IVX(sv), \
536 SvFLAGS(sv) |= SVp_IOK)
537 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
538 #define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
539 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
540 #define SvPOKp_on(sv) (assert_not_ROK(sv), \
541 SvFLAGS(sv) |= SVp_POK)
543 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
544 #define SvIOK_on(sv) (SvRELEASE_IVX(sv), \
545 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
546 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
547 #define SvIOK_only(sv) ((void)SvOK_off(sv), \
548 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
549 #define SvIOK_only_UV(sv) ((void)SvOK_off_exc_UV(sv), \
550 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
552 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
553 == (SVf_IOK|SVf_IVisUV))
554 #define SvUOK(sv) SvIOK_UV(sv)
555 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
558 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
559 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
560 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
562 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
563 #define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
564 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
565 #define SvNOK_only(sv) ((void)SvOK_off(sv), \
566 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
569 =for apidoc Am|void|SvUTF8|SV* sv
570 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
572 =for apidoc Am|void|SvUTF8_on|SV *sv
573 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
574 Do not use frivolously.
576 =for apidoc Am|void|SvUTF8_off|SV *sv
577 Unsets the UTF8 status of an SV.
579 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
580 Tells an SV that it is a string and disables all other OK bits,
581 and leaves the UTF8 status as it was.
586 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
587 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
588 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
590 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
591 #define SvPOK_on(sv) (assert_not_ROK(sv), \
592 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
593 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
594 #define SvPOK_only(sv) (assert_not_ROK(sv), \
595 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
596 SVf_IVisUV|SVf_UTF8), \
597 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
598 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv), \
599 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
601 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
603 #define SvVOK(sv) (SvMAGICAL(sv) && mg_find(sv,'V'))
604 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
605 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
606 #define SvOOK_off(sv) (SvOOK(sv) && sv_backoff(sv))
608 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
609 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
610 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
612 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
613 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
614 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
616 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
617 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
618 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
620 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
621 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
622 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
624 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
625 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
626 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
628 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
629 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
630 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
632 #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
633 #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
634 #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
636 #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
639 #define Gv_AMG(stash) \
640 (HV_AMAGICmb(stash) && \
641 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
643 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
645 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
646 == (SVf_ROK|SVprv_WEAKREF))
647 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
648 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
650 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
652 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
653 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
654 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
656 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
657 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
658 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
660 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
661 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
663 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
664 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
665 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
667 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
668 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
669 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
671 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
672 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
673 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
675 #define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
676 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
677 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
679 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
680 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
681 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
683 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
684 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
685 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
687 #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
688 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
689 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
691 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
692 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
693 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
696 /* The following uses the FAKE flag to show that a regex pointer is infact
697 its own offset in the regexpad for ithreads */
698 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
699 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
700 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
703 #define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
704 #define SvRVx(sv) SvRV(sv)
706 #define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
707 #define SvIVXx(sv) SvIVX(sv)
708 #define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
709 #define SvUVXx(sv) SvUVX(sv)
710 #define SvNVX(sv) ((XPVNV*)SvANY(sv))->xnv_nv
711 #define SvNVXx(sv) SvNVX(sv)
712 #define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
713 #define SvPVXx(sv) SvPVX(sv)
714 #define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
715 #define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
716 #define SvLENx(sv) SvLEN(sv)
717 #define SvEND(sv)(((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
718 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
719 #define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
720 #define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
722 /* Ask a scalar nicely to try to become an IV, if possible.
723 Not guaranteed to stay returning void */
724 /* Macro won't actually call sv_2iv if already IOK */
725 #define SvIV_please(sv) \
726 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
727 (void) SvIV(sv); } STMT_END
728 #define SvIV_set(sv, val) \
729 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
730 (((XPVIV*) SvANY(sv))->xiv_iv = val); } STMT_END
731 #define SvNV_set(sv, val) \
732 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
733 (((XPVNV*) SvANY(sv))->xnv_nv = val); } STMT_END
734 #define SvPV_set(sv, val) \
735 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
736 (((XPV*) SvANY(sv))->xpv_pv = val); } STMT_END
737 #define SvCUR_set(sv, val) \
738 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
739 (((XPV*) SvANY(sv))->xpv_cur = val); } STMT_END
740 #define SvLEN_set(sv, val) \
741 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
742 (((XPV*) SvANY(sv))->xpv_len = val); } STMT_END
743 #define SvEND_set(sv, val) \
744 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
745 (((XPV*) SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
747 #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
748 #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
749 #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
751 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
753 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
754 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
755 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
756 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
758 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
759 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
760 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
761 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
762 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
763 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
764 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
765 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
766 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
767 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
768 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
769 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
770 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
771 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
772 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
773 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
774 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
776 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
777 #define IoTYPE_RDONLY '<'
778 #define IoTYPE_WRONLY '>'
779 #define IoTYPE_RDWR '+'
780 #define IoTYPE_APPEND 'a'
781 #define IoTYPE_PIPE '|'
782 #define IoTYPE_STD '-' /* stdin or stdout */
783 #define IoTYPE_SOCKET 's'
784 #define IoTYPE_CLOSED ' '
787 =for apidoc Am|bool|SvTAINTED|SV* sv
788 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
791 =for apidoc Am|void|SvTAINTED_on|SV* sv
792 Marks an SV as tainted.
794 =for apidoc Am|void|SvTAINTED_off|SV* sv
795 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
796 some of Perl's fundamental security features. XS module authors should not
797 use this function unless they fully understand all the implications of
798 unconditionally untainting the value. Untainting should be done in the
799 standard perl fashion, via a carefully crafted regexp, rather than directly
800 untainting variables.
802 =for apidoc Am|void|SvTAINT|SV* sv
803 Taints an SV if tainting is enabled
808 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
809 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
810 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
812 #define SvTAINT(sv) \
821 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
822 Like C<SvPV> but will force the SV into containing just a string
823 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
826 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
827 Like C<SvPV> but will force the SV into containing just a string
828 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
829 directly. Doesn't process magic.
831 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
832 Returns a pointer to the string in the SV, or a stringified form of
833 the SV if the SV does not contain a string. The SV may cache the
834 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
835 C<SvPVx> for a version which guarantees to evaluate sv only once.
837 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
838 A version of C<SvPV> which guarantees to evaluate sv only once.
840 =for apidoc Am|char*|SvPV_nolen|SV* sv
841 Returns a pointer to the string in the SV, or a stringified form of
842 the SV if the SV does not contain a string. The SV may cache the
843 stringified form becoming C<SvPOK>. Handles 'get' magic.
845 =for apidoc Am|IV|SvIV|SV* sv
846 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
847 version which guarantees to evaluate sv only once.
849 =for apidoc Am|IV|SvIVx|SV* sv
850 Coerces the given SV to an integer and returns it. Guarantees to evaluate
851 sv only once. Use the more efficient C<SvIV> otherwise.
853 =for apidoc Am|NV|SvNV|SV* sv
854 Coerce the given SV to a double and return it. See C<SvNVx> for a version
855 which guarantees to evaluate sv only once.
857 =for apidoc Am|NV|SvNVx|SV* sv
858 Coerces the given SV to a double and returns it. Guarantees to evaluate
859 sv only once. Use the more efficient C<SvNV> otherwise.
861 =for apidoc Am|UV|SvUV|SV* sv
862 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
863 for a version which guarantees to evaluate sv only once.
865 =for apidoc Am|UV|SvUVx|SV* sv
866 Coerces the given SV to an unsigned integer and returns it. Guarantees to
867 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
869 =for apidoc Am|bool|SvTRUE|SV* sv
870 Returns a boolean indicating whether Perl would evaluate the SV as true or
871 false, defined or undefined. Does not handle 'get' magic.
873 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
874 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
876 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
877 Like C<SvPV>, but converts sv to utf8 first if necessary.
879 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
880 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
882 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
883 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
885 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
886 Like C<SvPV>, but converts sv to byte representation first if necessary.
888 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
889 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
891 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
892 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
893 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
896 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
897 Like C<SvPV>, but converts sv to utf8 first if necessary.
898 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
901 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
902 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
903 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
906 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
907 Like C<SvPV>, but converts sv to byte representation first if necessary.
908 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
915 /* Let us hope that bitmaps for UV and IV are the same */
916 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
917 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
918 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
922 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
924 #define SvPV_flags(sv, lp, flags) \
925 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
926 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
928 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
930 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
932 #define SvPV_force_flags(sv, lp, flags) \
933 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
934 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
936 #define SvPV_nolen(sv) \
937 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
938 ? SvPVX(sv) : sv_2pv_nolen(sv))
940 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
944 #define SvPVutf8(sv, lp) \
945 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
946 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
948 #define SvPVutf8_force(sv, lp) \
949 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
950 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
953 #define SvPVutf8_nolen(sv) \
954 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
955 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
959 #define SvPVbyte(sv, lp) \
960 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
961 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
963 #define SvPVbyte_force(sv, lp) \
964 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
965 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyte_force(sv, &lp))
967 #define SvPVbyte_nolen(sv) \
968 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
969 ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
973 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
974 * var to evaluate the arg once; failing that, use a global if possible;
975 * failing that, call a function to do the work
978 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
979 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
980 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
982 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
984 # define SvIVx(sv) ({SV *nsv = (SV*)(sv); SvIV(nsv); })
985 # define SvUVx(sv) ({SV *nsv = (SV*)(sv); SvUV(nsv); })
986 # define SvNVx(sv) ({SV *nsv = (SV*)(sv); SvNV(nsv); })
987 # define SvPVx(sv, lp) ({SV *nsv = (sv); SvPV(nsv, lp); })
988 # define SvPVutf8x(sv, lp) ({SV *nsv = (sv); SvPVutf8(nsv, lp); })
989 # define SvPVbytex(sv, lp) ({SV *nsv = (sv); SvPVbyte(nsv, lp); })
990 # define SvTRUE(sv) ( \
994 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
996 (nxpv->xpv_cur > 1 || \
997 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
1004 ? SvNVX(sv) != 0.0 \
1006 # define SvTRUEx(sv) ({SV *nsv = (sv); SvTRUE(nsv); })
1008 #else /* __GNUC__ */
1010 /* These inlined macros use globals, which will require a thread
1011 * declaration in user code, so we avoid them under threads */
1013 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1014 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1015 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1016 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1017 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1018 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1019 # define SvTRUE(sv) ( \
1023 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
1024 (PL_Xpv->xpv_cur > 1 || \
1025 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
1032 ? SvNVX(sv) != 0.0 \
1034 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1035 #endif /* __GNU__ */
1037 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1038 (SVf_FAKE | SVf_READONLY))
1039 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1041 /* flag values for sv_*_flags functions */
1042 #define SV_IMMEDIATE_UNREF 1
1044 #define SV_COW_DROP_PV 4
1045 #define SV_UTF8_NO_ENCODING 8
1047 /* We are about to replace the SV's current value. So if it's copy on write
1048 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1049 the value is about to get thrown away, so drop the PV rather than go to
1050 the effort of making a read-write copy only for it to get immediately
1053 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1054 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1056 #ifdef PERL_COPY_ON_WRITE
1057 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1058 && sv_release_IVX(sv)))
1059 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1061 # define SvRELEASE_IVX(sv) ((void)SvOOK_off(sv))
1062 #endif /* PERL_COPY_ON_WRITE */
1064 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1065 sv_force_normal_flags(sv, 0)
1068 /* all these 'functions' are now just macros */
1070 #define sv_pv(sv) SvPV_nolen(sv)
1071 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1072 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1074 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1075 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1076 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1077 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1078 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1079 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1080 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1081 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1082 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1083 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1084 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1085 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1089 =for apidoc Am|SV*|newRV_inc|SV* sv
1091 Creates an RV wrapper for an SV. The reference count for the original SV is
1097 #define newRV_inc(sv) newRV(sv)
1099 /* the following macros update any magic values this sv is associated with */
1102 =head1 Magical Functions
1104 =for apidoc Am|void|SvGETMAGIC|SV* sv
1105 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1106 argument more than once.
1108 =for apidoc Am|void|SvSETMAGIC|SV* sv
1109 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1110 argument more than once.
1112 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1113 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1116 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1117 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1118 ssv. May evaluate arguments more than once.
1120 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1121 Like C<SvSetSV>, but does any set magic required afterwards.
1123 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1124 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1126 =for apidoc Am|void|SvSHARE|SV* sv
1127 Arranges for sv to be shared between threads if a suitable module
1130 =for apidoc Am|void|SvLOCK|SV* sv
1131 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1134 =for apidoc Am|void|SvUNLOCK|SV* sv
1135 Releases a mutual exclusion lock on sv if a suitable module
1138 =head1 SV Manipulation Functions
1140 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1141 Expands the character buffer in the SV so that it has room for the
1142 indicated number of bytes (remember to reserve space for an extra trailing
1143 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1144 Returns a pointer to the character buffer.
1149 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1150 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1151 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1153 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1154 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1156 #define SvSetSV_and(dst,src,finally) \
1158 if ((dst) != (src)) { \
1159 sv_setsv(dst, src); \
1163 #define SvSetSV_nosteal_and(dst,src,finally) \
1165 if ((dst) != (src)) { \
1166 U32 tMpF = SvFLAGS(src) & SVs_TEMP; \
1168 sv_setsv(dst, src); \
1169 SvFLAGS(src) |= tMpF; \
1174 #define SvSetSV(dst,src) \
1175 SvSetSV_and(dst,src,/*nothing*/;)
1176 #define SvSetSV_nosteal(dst,src) \
1177 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1179 #define SvSetMagicSV(dst,src) \
1180 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1181 #define SvSetMagicSV_nosteal(dst,src) \
1182 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1184 #if !defined(SKIP_DEBUGGING)
1185 #define SvPEEK(sv) sv_peek(sv)
1187 #define SvPEEK(sv) ""
1190 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no)
1192 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1194 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1196 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1197 #define Sv_Grow sv_grow
1199 #define CLONEf_COPY_STACKS 1
1200 #define CLONEf_KEEP_PTR_TABLE 2
1201 #define CLONEf_CLONE_HOST 4
1202 #define CLONEf_JOIN_IN 8
1204 struct clone_params {
1207 PerlInterpreter *proto_perl;