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_PADBUSY 0x00000100 /* reserved for tmp or my already */
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 */
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;
326 char * xpv_pv; /* pointer to malloced string */
327 STRLEN xpv_cur; /* length of xpv_pv as a C string */
328 STRLEN xpv_len; /* allocated size */
329 IV xiv_iv; /* integer value or pv offset */
330 NV xnv_nv; /* numeric value, if any */
331 MAGIC* xmg_magic; /* linked list of magicalness */
332 HV* xmg_stash; /* class package */
334 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
335 PerlIO * xio_ofp; /* but sockets need separate streams */
336 /* Cray addresses everything by word boundaries (64 bits) and
337 * code and data pointers cannot be mixed (which is exactly what
338 * Perl_filter_add() tries to do with the dirp), hence the following
339 * union trick (as suggested by Gurusamy Sarathy).
340 * For further information see Geir Johansen's problem report titled
341 [ID 20000612.002] Perl problem on Cray system
342 * The any pointer (known as IoANY()) will also be a good place
343 * to hang any IO disciplines to.
346 DIR * xiou_dirp; /* for opendir, readdir, etc */
347 void * xiou_any; /* for alignment */
349 IV xio_lines; /* $. */
350 IV xio_page; /* $% */
351 IV xio_page_len; /* $= */
352 IV xio_lines_left; /* $- */
353 char * xio_top_name; /* $^ */
354 GV * xio_top_gv; /* $^ */
355 char * xio_fmt_name; /* $~ */
356 GV * xio_fmt_gv; /* $~ */
357 char * xio_bottom_name;/* $^B */
358 GV * xio_bottom_gv; /* $^B */
359 short xio_subprocess; /* -| or |- */
363 #define xio_dirp xio_dirpu.xiou_dirp
364 #define xio_any xio_dirpu.xiou_any
366 #define IOf_ARGV 1 /* this fp iterates over ARGV */
367 #define IOf_START 2 /* check for null ARGV and substitute '-' */
368 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
369 #define IOf_DIDTOP 8 /* just did top of form */
370 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
371 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
372 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
374 /* The following macros define implementation-independent predicates on SVs. */
377 =for apidoc Am|bool|SvNIOK|SV* sv
378 Returns a boolean indicating whether the SV contains a number, integer or
381 =for apidoc Am|bool|SvNIOKp|SV* sv
382 Returns a boolean indicating whether the SV contains a number, integer or
383 double. Checks the B<private> setting. Use C<SvNIOK>.
385 =for apidoc Am|void|SvNIOK_off|SV* sv
386 Unsets the NV/IV status of an SV.
388 =for apidoc Am|bool|SvOK|SV* sv
389 Returns a boolean indicating whether the value is an SV.
391 =for apidoc Am|bool|SvIOKp|SV* sv
392 Returns a boolean indicating whether the SV contains an integer. Checks
393 the B<private> setting. Use C<SvIOK>.
395 =for apidoc Am|bool|SvNOKp|SV* sv
396 Returns a boolean indicating whether the SV contains a double. Checks the
397 B<private> setting. Use C<SvNOK>.
399 =for apidoc Am|bool|SvPOKp|SV* sv
400 Returns a boolean indicating whether the SV contains a character string.
401 Checks the B<private> setting. Use C<SvPOK>.
403 =for apidoc Am|bool|SvIOK|SV* sv
404 Returns a boolean indicating whether the SV contains an integer.
406 =for apidoc Am|void|SvIOK_on|SV* sv
407 Tells an SV that it is an integer.
409 =for apidoc Am|void|SvIOK_off|SV* sv
410 Unsets the IV status of an SV.
412 =for apidoc Am|void|SvIOK_only|SV* sv
413 Tells an SV that it is an integer and disables all other OK bits.
415 =for apidoc Am|void|SvIOK_only_UV|SV* sv
416 Tells and SV that it is an unsigned integer and disables all other OK bits.
418 =for apidoc Am|void|SvIOK_UV|SV* sv
419 Returns a boolean indicating whether the SV contains an unsigned integer.
421 =for apidoc Am|void|SvUOK|SV* sv
422 Returns a boolean indicating whether the SV contains an unsigned integer.
424 =for apidoc Am|void|SvIOK_notUV|SV* sv
425 Returns a boolean indicating whether the SV contains a signed integer.
427 =for apidoc Am|bool|SvNOK|SV* sv
428 Returns a boolean indicating whether the SV contains a double.
430 =for apidoc Am|void|SvNOK_on|SV* sv
431 Tells an SV that it is a double.
433 =for apidoc Am|void|SvNOK_off|SV* sv
434 Unsets the NV status of an SV.
436 =for apidoc Am|void|SvNOK_only|SV* sv
437 Tells an SV that it is a double and disables all other OK bits.
439 =for apidoc Am|bool|SvPOK|SV* sv
440 Returns a boolean indicating whether the SV contains a character
443 =for apidoc Am|void|SvPOK_on|SV* sv
444 Tells an SV that it is a string.
446 =for apidoc Am|void|SvPOK_off|SV* sv
447 Unsets the PV status of an SV.
449 =for apidoc Am|void|SvPOK_only|SV* sv
450 Tells an SV that it is a string and disables all other OK bits.
451 Will also turn off the UTF8 status.
453 =for apidoc Am|bool|SvVOK|SV* sv
454 Returns a boolean indicating whether the SV contains a v-string.
456 =for apidoc Am|bool|SvOOK|SV* sv
457 Returns a boolean indicating whether the SvIVX is a valid offset value for
458 the SvPVX. This hack is used internally to speed up removal of characters
459 from the beginning of a SvPV. When SvOOK is true, then the start of the
460 allocated string buffer is really (SvPVX - SvIVX).
462 =for apidoc Am|bool|SvROK|SV* sv
463 Tests if the SV is an RV.
465 =for apidoc Am|void|SvROK_on|SV* sv
466 Tells an SV that it is an RV.
468 =for apidoc Am|void|SvROK_off|SV* sv
469 Unsets the RV status of an SV.
471 =for apidoc Am|SV*|SvRV|SV* sv
472 Dereferences an RV to return the SV.
474 =for apidoc Am|IV|SvIVX|SV* sv
475 Returns the raw value in the SV's IV slot, without checks or conversions.
476 Only use when you are sure SvIOK is true. See also C<SvIV()>.
478 =for apidoc Am|UV|SvUVX|SV* sv
479 Returns the raw value in the SV's UV slot, without checks or conversions.
480 Only use when you are sure SvIOK is true. See also C<SvUV()>.
482 =for apidoc Am|NV|SvNVX|SV* sv
483 Returns the raw value in the SV's NV slot, without checks or conversions.
484 Only use when you are sure SvNOK is true. See also C<SvNV()>.
486 =for apidoc Am|char*|SvPVX|SV* sv
487 Returns a pointer to the physical string in the SV. The SV must contain a
490 =for apidoc Am|STRLEN|SvCUR|SV* sv
491 Returns the length of the string which is in the SV. See C<SvLEN>.
493 =for apidoc Am|STRLEN|SvLEN|SV* sv
494 Returns the size of the string buffer in the SV, not including any part
495 attributable to C<SvOOK>. See C<SvCUR>.
497 =for apidoc Am|char*|SvEND|SV* sv
498 Returns a pointer to the last character in the string which is in the SV.
499 See C<SvCUR>. Access the character as *(SvEND(sv)).
501 =for apidoc Am|HV*|SvSTASH|SV* sv
502 Returns the stash of the SV.
504 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
505 Set the length of the string which is in the SV. See C<SvCUR>.
510 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
511 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
512 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
513 SVp_IOK|SVp_NOK|SVf_IVisUV))
515 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
516 #define SvOK_off(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
517 SVf_IVisUV|SVf_UTF8), \
519 #define SvOK_off_exc_UV(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
523 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
524 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
525 #define SvIOKp_on(sv) (SvRELEASE_IVX(sv), \
526 SvFLAGS(sv) |= SVp_IOK)
527 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
528 #define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
529 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
530 #define SvPOKp_on(sv) (SvFLAGS(sv) |= SVp_POK)
532 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
533 #define SvIOK_on(sv) (SvRELEASE_IVX(sv), \
534 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
535 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
536 #define SvIOK_only(sv) ((void)SvOK_off(sv), \
537 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
538 #define SvIOK_only_UV(sv) ((void)SvOK_off_exc_UV(sv), \
539 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
541 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
542 == (SVf_IOK|SVf_IVisUV))
543 #define SvUOK(sv) SvIOK_UV(sv)
544 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
547 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
548 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
549 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
551 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
552 #define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
553 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
554 #define SvNOK_only(sv) ((void)SvOK_off(sv), \
555 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
558 =for apidoc Am|void|SvUTF8|SV* sv
559 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
561 =for apidoc Am|void|SvUTF8_on|SV *sv
562 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
563 Do not use frivolously.
565 =for apidoc Am|void|SvUTF8_off|SV *sv
566 Unsets the UTF8 status of an SV.
568 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
569 Tells an SV that it is a string and disables all other OK bits,
570 and leaves the UTF8 status as it was.
575 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
576 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
577 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
579 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
580 #define SvPOK_on(sv) (SvFLAGS(sv) |= (SVf_POK|SVp_POK))
581 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
582 #define SvPOK_only(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
583 SVf_IVisUV|SVf_UTF8), \
584 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
585 #define SvPOK_only_UTF8(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
587 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
589 #define SvVOK(sv) (SvMAGICAL(sv) && mg_find(sv,'V'))
590 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
591 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
592 #define SvOOK_off(sv) (SvOOK(sv) && sv_backoff(sv))
594 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
595 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
596 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
598 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
599 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
600 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
602 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
603 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
604 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
606 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
607 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
608 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
610 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
611 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
612 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
614 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
615 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
616 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
618 #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
619 #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
620 #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
622 #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
625 #define Gv_AMG(stash) \
626 (HV_AMAGICmb(stash) && \
627 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
629 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
631 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
632 == (SVf_ROK|SVprv_WEAKREF))
633 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
634 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
636 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
638 #define SvPADBUSY(sv) (SvFLAGS(sv) & SVs_PADBUSY)
640 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
641 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP|SVs_PADBUSY)
642 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
644 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
645 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY|SVs_PADBUSY)
647 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
648 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
649 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
651 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
652 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
653 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
655 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
656 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
657 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
659 #define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
660 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
661 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
663 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
664 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
665 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
667 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
668 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
669 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
671 #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
672 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
673 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
675 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
676 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
677 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
680 /* The following uses the FAKE flag to show that a regex pointer is infact
681 its own offset in the regexpad for ithreads */
682 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
683 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
684 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
687 #define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
688 #define SvRVx(sv) SvRV(sv)
690 #define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
691 #define SvIVXx(sv) SvIVX(sv)
692 #define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
693 #define SvUVXx(sv) SvUVX(sv)
694 #define SvNVX(sv) ((XPVNV*)SvANY(sv))->xnv_nv
695 #define SvNVXx(sv) SvNVX(sv)
696 #define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
697 #define SvPVXx(sv) SvPVX(sv)
698 #define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
699 #define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
700 #define SvLENx(sv) SvLEN(sv)
701 #define SvEND(sv)(((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
702 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
703 #define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
704 #define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
706 /* Ask a scalar nicely to try to become an IV, if possible.
707 Not guaranteed to stay returning void */
708 /* Macro won't actually call sv_2iv if already IOK */
709 #define SvIV_please(sv) \
710 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
711 (void) SvIV(sv); } STMT_END
712 #define SvIV_set(sv, val) \
713 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
714 (((XPVIV*) SvANY(sv))->xiv_iv = val); } STMT_END
715 #define SvNV_set(sv, val) \
716 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
717 (((XPVNV*) SvANY(sv))->xnv_nv = val); } STMT_END
718 #define SvPV_set(sv, val) \
719 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
720 (((XPV*) SvANY(sv))->xpv_pv = val); } STMT_END
721 #define SvCUR_set(sv, val) \
722 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
723 (((XPV*) SvANY(sv))->xpv_cur = val); } STMT_END
724 #define SvLEN_set(sv, val) \
725 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
726 (((XPV*) SvANY(sv))->xpv_len = val); } STMT_END
727 #define SvEND_set(sv, val) \
728 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
729 (((XPV*) SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
731 #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
732 #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
733 #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
735 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
737 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
738 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
739 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
740 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
742 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
743 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
744 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
745 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
746 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
747 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
748 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
749 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
750 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
751 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
752 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
753 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
754 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
755 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
756 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
757 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
758 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
760 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
761 #define IoTYPE_RDONLY '<'
762 #define IoTYPE_WRONLY '>'
763 #define IoTYPE_RDWR '+'
764 #define IoTYPE_APPEND 'a'
765 #define IoTYPE_PIPE '|'
766 #define IoTYPE_STD '-' /* stdin or stdout */
767 #define IoTYPE_SOCKET 's'
768 #define IoTYPE_CLOSED ' '
771 =for apidoc Am|bool|SvTAINTED|SV* sv
772 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
775 =for apidoc Am|void|SvTAINTED_on|SV* sv
776 Marks an SV as tainted.
778 =for apidoc Am|void|SvTAINTED_off|SV* sv
779 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
780 some of Perl's fundamental security features. XS module authors should not
781 use this function unless they fully understand all the implications of
782 unconditionally untainting the value. Untainting should be done in the
783 standard perl fashion, via a carefully crafted regexp, rather than directly
784 untainting variables.
786 =for apidoc Am|void|SvTAINT|SV* sv
787 Taints an SV if tainting is enabled
792 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
793 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
794 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
796 #define SvTAINT(sv) \
805 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
806 Like C<SvPV> but will force the SV into containing just a string
807 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
810 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
811 Like C<SvPV> but will force the SV into containing just a string
812 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
813 directly. Doesn't process magic.
815 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
816 Returns a pointer to the string in the SV, or a stringified form of
817 the SV if the SV does not contain a string. The SV may cache the
818 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
819 C<SvPVx> for a version which guarantees to evaluate sv only once.
821 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
822 A version of C<SvPV> which guarantees to evaluate sv only once.
824 =for apidoc Am|char*|SvPV_nolen|SV* sv
825 Returns a pointer to the string in the SV, or a stringified form of
826 the SV if the SV does not contain a string. The SV may cache the
827 stringified form becoming C<SvPOK>. Handles 'get' magic.
829 =for apidoc Am|IV|SvIV|SV* sv
830 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
831 version which guarantees to evaluate sv only once.
833 =for apidoc Am|IV|SvIVx|SV* sv
834 Coerces the given SV to an integer and returns it. Guarantees to evaluate
835 sv only once. Use the more efficient C<SvIV> otherwise.
837 =for apidoc Am|NV|SvNV|SV* sv
838 Coerce the given SV to a double and return it. See C<SvNVx> for a version
839 which guarantees to evaluate sv only once.
841 =for apidoc Am|NV|SvNVx|SV* sv
842 Coerces the given SV to a double and returns it. Guarantees to evaluate
843 sv only once. Use the more efficient C<SvNV> otherwise.
845 =for apidoc Am|UV|SvUV|SV* sv
846 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
847 for a version which guarantees to evaluate sv only once.
849 =for apidoc Am|UV|SvUVx|SV* sv
850 Coerces the given SV to an unsigned integer and returns it. Guarantees to
851 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
853 =for apidoc Am|bool|SvTRUE|SV* sv
854 Returns a boolean indicating whether Perl would evaluate the SV as true or
855 false, defined or undefined. Does not handle 'get' magic.
857 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
858 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
860 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
861 Like C<SvPV>, but converts sv to utf8 first if necessary.
863 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
864 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
866 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
867 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
869 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
870 Like C<SvPV>, but converts sv to byte representation first if necessary.
872 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
873 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
875 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
876 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
877 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
880 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
881 Like C<SvPV>, but converts sv to utf8 first if necessary.
882 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
885 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
886 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
887 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
890 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
891 Like C<SvPV>, but converts sv to byte representation first if necessary.
892 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
899 /* Let us hope that bitmaps for UV and IV are the same */
900 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
901 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
902 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
906 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
908 #define SvPV_flags(sv, lp, flags) \
909 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
910 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
912 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
914 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
916 #define SvPV_force_flags(sv, lp, flags) \
917 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
918 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
920 #define SvPV_nolen(sv) \
921 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
922 ? SvPVX(sv) : sv_2pv_nolen(sv))
924 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
928 #define SvPVutf8(sv, lp) \
929 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
930 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
932 #define SvPVutf8_force(sv, lp) \
933 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
934 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
937 #define SvPVutf8_nolen(sv) \
938 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
939 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
943 #define SvPVbyte(sv, lp) \
944 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
945 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
947 #define SvPVbyte_force(sv, lp) \
948 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
949 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyte_force(sv, &lp))
951 #define SvPVbyte_nolen(sv) \
952 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
953 ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
957 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
958 * var to evaluate the arg once; failing that, use a global if possible;
959 * failing that, call a function to do the work
962 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
963 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
964 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
966 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
968 # define SvIVx(sv) ({SV *nsv = (SV*)(sv); SvIV(nsv); })
969 # define SvUVx(sv) ({SV *nsv = (SV*)(sv); SvUV(nsv); })
970 # define SvNVx(sv) ({SV *nsv = (SV*)(sv); SvNV(nsv); })
971 # define SvPVx(sv, lp) ({SV *nsv = (sv); SvPV(nsv, lp); })
972 # define SvPVutf8x(sv, lp) ({SV *nsv = (sv); SvPVutf8(nsv, lp); })
973 # define SvPVbytex(sv, lp) ({SV *nsv = (sv); SvPVbyte(nsv, lp); })
974 # define SvTRUE(sv) ( \
978 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
980 (nxpv->xpv_cur > 1 || \
981 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
990 # define SvTRUEx(sv) ({SV *nsv = (sv); SvTRUE(nsv); })
994 /* These inlined macros use globals, which will require a thread
995 * declaration in user code, so we avoid them under threads */
997 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
998 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
999 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1000 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1001 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1002 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1003 # define SvTRUE(sv) ( \
1007 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
1008 (PL_Xpv->xpv_cur > 1 || \
1009 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
1016 ? SvNVX(sv) != 0.0 \
1018 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1019 #endif /* __GNU__ */
1021 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1022 (SVf_FAKE | SVf_READONLY))
1023 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1025 /* flag values for sv_*_flags functions */
1026 #define SV_IMMEDIATE_UNREF 1
1028 #define SV_COW_DROP_PV 4
1030 /* We are about to replace the SV's current value. So if it's copy on write
1031 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1032 the value is about to get thrown away, so drop the PV rather than go to
1033 the effort of making a read-write copy only for it to get immediately
1036 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1037 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1039 #ifdef PERL_COPY_ON_WRITE
1040 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1041 && sv_release_IVX(sv)))
1042 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1044 # define SvRELEASE_IVX(sv) ((void)SvOOK_off(sv))
1045 #endif /* PERL_COPY_ON_WRITE */
1047 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1048 sv_force_normal_flags(sv, 0)
1051 /* all these 'functions' are now just macros */
1053 #define sv_pv(sv) SvPV_nolen(sv)
1054 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1055 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1057 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1058 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1059 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1060 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1061 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1062 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1063 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1064 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1065 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1066 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1067 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1068 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1072 =for apidoc Am|SV*|newRV_inc|SV* sv
1074 Creates an RV wrapper for an SV. The reference count for the original SV is
1080 #define newRV_inc(sv) newRV(sv)
1082 /* the following macros update any magic values this sv is associated with */
1085 =head1 Magical Functions
1087 =for apidoc Am|void|SvGETMAGIC|SV* sv
1088 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1089 argument more than once.
1091 =for apidoc Am|void|SvSETMAGIC|SV* sv
1092 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1093 argument more than once.
1095 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1096 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1099 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1100 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1101 ssv. May evaluate arguments more than once.
1103 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1104 Like C<SvSetSV>, but does any set magic required afterwards.
1106 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1107 Like C<SvSetMagicSV>, but does any set magic required afterwards.
1109 =for apidoc Am|void|SvSHARE|SV* sv
1110 Arranges for sv to be shared between threads if a suitable module
1113 =for apidoc Am|void|SvLOCK|SV* sv
1114 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1117 =for apidoc Am|void|SvUNLOCK|SV* sv
1118 Releases a mutual exclusion lock on sv if a suitable module
1121 =head1 SV Manipulation Functions
1123 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1124 Expands the character buffer in the SV so that it has room for the
1125 indicated number of bytes (remember to reserve space for an extra trailing
1126 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1127 Returns a pointer to the character buffer.
1132 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1133 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1134 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1136 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1137 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1139 #define SvSetSV_and(dst,src,finally) \
1141 if ((dst) != (src)) { \
1142 sv_setsv(dst, src); \
1146 #define SvSetSV_nosteal_and(dst,src,finally) \
1148 if ((dst) != (src)) { \
1149 U32 tMpF = SvFLAGS(src) & SVs_TEMP; \
1151 sv_setsv(dst, src); \
1152 SvFLAGS(src) |= tMpF; \
1157 #define SvSetSV(dst,src) \
1158 SvSetSV_and(dst,src,/*nothing*/;)
1159 #define SvSetSV_nosteal(dst,src) \
1160 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1162 #define SvSetMagicSV(dst,src) \
1163 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1164 #define SvSetMagicSV_nosteal(dst,src) \
1165 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1167 #if !defined(SKIP_DEBUGGING)
1168 #define SvPEEK(sv) sv_peek(sv)
1170 #define SvPEEK(sv) ""
1173 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no)
1175 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1177 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1179 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1180 #define Sv_Grow sv_grow
1182 #define CLONEf_COPY_STACKS 1
1183 #define CLONEf_KEEP_PTR_TABLE 2
1184 #define CLONEf_CLONE_HOST 4
1186 struct clone_params {
1189 PerlInterpreter *proto_perl;