3 * Copyright (c) 1991-2001, 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() */
15 =for apidoc AmU||svtype
16 An enum of flags for Perl types. These are found in the file B<sv.h>
17 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
19 =for apidoc AmU||SVt_PV
20 Pointer type flag for scalars. See C<svtype>.
22 =for apidoc AmU||SVt_IV
23 Integer type flag for scalars. See C<svtype>.
25 =for apidoc AmU||SVt_NV
26 Double type flag for scalars. See C<svtype>.
28 =for apidoc AmU||SVt_PVMG
29 Type flag for blessed scalars. See C<svtype>.
31 =for apidoc AmU||SVt_PVAV
32 Type flag for arrays. See C<svtype>.
34 =for apidoc AmU||SVt_PVHV
35 Type flag for hashes. See C<svtype>.
37 =for apidoc AmU||SVt_PVCV
38 Type flag for code refs. See C<svtype>.
62 /* Using C's structural equivalence to help emulate C++ inheritance here... */
65 void* sv_any; /* pointer to something */
66 U32 sv_refcnt; /* how many references to us */
67 U32 sv_flags; /* what we are */
71 XPVGV* sv_any; /* pointer to something */
72 U32 sv_refcnt; /* how many references to us */
73 U32 sv_flags; /* what we are */
77 XPVCV* sv_any; /* pointer to something */
78 U32 sv_refcnt; /* how many references to us */
79 U32 sv_flags; /* what we are */
83 XPVAV* sv_any; /* pointer to something */
84 U32 sv_refcnt; /* how many references to us */
85 U32 sv_flags; /* what we are */
89 XPVHV* sv_any; /* pointer to something */
90 U32 sv_refcnt; /* how many references to us */
91 U32 sv_flags; /* what we are */
95 XPVIO* sv_any; /* pointer to something */
96 U32 sv_refcnt; /* how many references to us */
97 U32 sv_flags; /* what we are */
101 =for apidoc Am|U32|SvREFCNT|SV* sv
102 Returns the value of the object's reference count.
104 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
105 Increments the reference count of the given SV.
107 =for apidoc Am|void|SvREFCNT_dec|SV* sv
108 Decrements the reference count of the given SV.
110 =for apidoc Am|svtype|SvTYPE|SV* sv
111 Returns the type of the SV. See C<svtype>.
113 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
114 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
115 perform the upgrade if necessary. See C<svtype>.
120 #define SvANY(sv) (sv)->sv_any
121 #define SvFLAGS(sv) (sv)->sv_flags
122 #define SvREFCNT(sv) (sv)->sv_refcnt
127 # define ATOMIC_INC(count) __ATOMIC_INCREMENT_LONG(&count)
128 # define ATOMIC_DEC_AND_TEST(res,count) res=(1==__ATOMIC_DECREMENT_LONG(&count))
130 # ifdef EMULATE_ATOMIC_REFCOUNTS
131 # define ATOMIC_INC(count) STMT_START { \
132 MUTEX_LOCK(&PL_svref_mutex); \
134 MUTEX_UNLOCK(&PL_svref_mutex); \
136 # define ATOMIC_DEC_AND_TEST(res,count) STMT_START { \
137 MUTEX_LOCK(&PL_svref_mutex); \
138 res = (--count == 0); \
139 MUTEX_UNLOCK(&PL_svref_mutex); \
142 # define ATOMIC_INC(count) atomic_inc(&count)
143 # define ATOMIC_DEC_AND_TEST(res,count) (res = atomic_dec_and_test(&count))
144 # endif /* EMULATE_ATOMIC_REFCOUNTS */
147 # define ATOMIC_INC(count) (++count)
148 # define ATOMIC_DEC_AND_TEST(res, count) (res = (--count == 0))
149 #endif /* USE_THREADS */
152 # define SvREFCNT_inc(sv) \
154 SV *nsv = (SV*)(sv); \
156 ATOMIC_INC(SvREFCNT(nsv)); \
160 # if defined(CRIPPLED_CC) || defined(USE_THREADS)
161 # if defined(VMS) && defined(__ALPHA)
162 # define SvREFCNT_inc(sv) \
163 (PL_Sv=(SV*)(sv), (PL_Sv && __ATOMIC_INCREMENT_LONG(&(SvREFCNT(PL_Sv)))), (SV *)PL_Sv)
165 # define SvREFCNT_inc(sv) sv_newref((SV*)sv)
168 # define SvREFCNT_inc(sv) \
169 ((PL_Sv=(SV*)(sv)), (PL_Sv && ATOMIC_INC(SvREFCNT(PL_Sv))), (SV*)PL_Sv)
173 #define SvREFCNT_dec(sv) sv_free((SV*)sv)
175 #define SVTYPEMASK 0xff
176 #define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
178 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
180 #define SVs_PADBUSY 0x00000100 /* reserved for tmp or my already */
181 #define SVs_PADTMP 0x00000200 /* in use as tmp */
182 #define SVs_PADMY 0x00000400 /* in use a "my" variable */
183 #define SVs_TEMP 0x00000800 /* string is stealable? */
184 #define SVs_OBJECT 0x00001000 /* is "blessed" */
185 #define SVs_GMG 0x00002000 /* has magical get method */
186 #define SVs_SMG 0x00004000 /* has magical set method */
187 #define SVs_RMG 0x00008000 /* has random magical methods */
189 #define SVf_IOK 0x00010000 /* has valid public integer value */
190 #define SVf_NOK 0x00020000 /* has valid public numeric value */
191 #define SVf_POK 0x00040000 /* has valid public pointer value */
192 #define SVf_ROK 0x00080000 /* has a valid reference pointer */
194 #define SVf_FAKE 0x00100000 /* glob or lexical is just a copy */
195 #define SVf_OOK 0x00200000 /* has valid offset value */
196 #define SVf_BREAK 0x00400000 /* refcnt is artificially low */
197 #define SVf_READONLY 0x00800000 /* may not be modified */
200 #define SVp_IOK 0x01000000 /* has valid non-public integer value */
201 #define SVp_NOK 0x02000000 /* has valid non-public numeric value */
202 #define SVp_POK 0x04000000 /* has valid non-public pointer value */
203 #define SVp_SCREAM 0x08000000 /* has been studied? */
205 #define SVf_UTF8 0x20000000 /* SvPVX is UTF-8 encoded */
207 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
209 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
210 SVp_IOK|SVp_NOK|SVp_POK)
212 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
216 /* Some private flags. */
218 /* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
219 #define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
220 #define SVpad_TYPED 0x40000000 /* Typed Lexical */
222 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
224 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
226 #define SVpbm_VALID 0x80000000
227 #define SVpbm_TAIL 0x40000000
229 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
231 #define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */
232 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
234 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
237 SV * xrv_rv; /* pointer to another SV */
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 */
247 char * xpv_pv; /* pointer to malloced string */
248 STRLEN xpv_cur; /* length of xpv_pv as a C string */
249 STRLEN xpv_len; /* allocated size */
250 IV xiv_iv; /* integer value or pv offset */
254 char * xpv_pv; /* pointer to malloced string */
255 STRLEN xpv_cur; /* length of xpv_pv as a C string */
256 STRLEN xpv_len; /* allocated size */
257 UV xuv_uv; /* unsigned value or pv offset */
261 char * xpv_pv; /* pointer to malloced string */
262 STRLEN xpv_cur; /* length of xpv_pv as a C string */
263 STRLEN xpv_len; /* allocated size */
264 IV xiv_iv; /* integer value or pv offset */
265 NV xnv_nv; /* numeric value, if any */
268 /* These structure must match the beginning of struct xpvhv in hv.h. */
270 char * xpv_pv; /* pointer to malloced string */
271 STRLEN xpv_cur; /* length of xpv_pv as a C string */
272 STRLEN xpv_len; /* allocated size */
273 IV xiv_iv; /* integer value or pv offset */
274 NV xnv_nv; /* numeric value, if any */
275 MAGIC* xmg_magic; /* linked list of magicalness */
276 HV* xmg_stash; /* class package */
280 char * xpv_pv; /* pointer to malloced string */
281 STRLEN xpv_cur; /* length of xpv_pv as a C string */
282 STRLEN xpv_len; /* allocated size */
283 IV xiv_iv; /* integer value or pv offset */
284 NV xnv_nv; /* numeric value, if any */
285 MAGIC* xmg_magic; /* linked list of magicalness */
286 HV* xmg_stash; /* class package */
295 char * xpv_pv; /* pointer to malloced string */
296 STRLEN xpv_cur; /* length of xpv_pv as a C string */
297 STRLEN xpv_len; /* allocated size */
298 IV xiv_iv; /* integer value or pv offset */
299 NV xnv_nv; /* numeric value, if any */
300 MAGIC* xmg_magic; /* linked list of magicalness */
301 HV* xmg_stash; /* class package */
311 char * xpv_pv; /* pointer to malloced string */
312 STRLEN xpv_cur; /* length of xpv_pv as a C string */
313 STRLEN xpv_len; /* allocated size */
314 IV xiv_iv; /* integer value or pv offset */
315 NV xnv_nv; /* numeric value, if any */
316 MAGIC* xmg_magic; /* linked list of magicalness */
317 HV* xmg_stash; /* class package */
319 I32 xbm_useful; /* is this constant pattern being useful? */
320 U16 xbm_previous; /* how many characters in string before rare? */
321 U8 xbm_rare; /* rarest character in string */
324 /* This structure much match XPVCV in cv.h */
326 typedef U16 cv_flags_t;
329 char * xpv_pv; /* pointer to malloced string */
330 STRLEN xpv_cur; /* length of xpv_pv as a C string */
331 STRLEN xpv_len; /* allocated size */
332 IV xiv_iv; /* integer value or pv offset */
333 NV xnv_nv; /* numeric value, if any */
334 MAGIC* xmg_magic; /* linked list of magicalness */
335 HV* xmg_stash; /* class package */
340 void (*xcv_xsub)(pTHXo_ CV*);
344 long xcv_depth; /* >= 2 indicates recursive call */
348 perl_mutex *xcv_mutexp; /* protects xcv_owner */
349 struct perl_thread *xcv_owner; /* current owner thread */
350 #endif /* USE_THREADS */
351 cv_flags_t xcv_flags;
357 char * xpv_pv; /* pointer to malloced string */
358 STRLEN xpv_cur; /* length of xpv_pv as a C string */
359 STRLEN xpv_len; /* allocated size */
360 IV xiv_iv; /* integer value or pv offset */
361 NV xnv_nv; /* numeric value, if any */
362 MAGIC* xmg_magic; /* linked list of magicalness */
363 HV* xmg_stash; /* class package */
365 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
366 PerlIO * xio_ofp; /* but sockets need separate streams */
367 /* Cray addresses everything by word boundaries (64 bits) and
368 * code and data pointers cannot be mixed (which is exactly what
369 * Perl_filter_add() tries to do with the dirp), hence the following
370 * union trick (as suggested by Gurusamy Sarathy).
371 * For further information see Geir Johansen's problem report titled
372 [ID 20000612.002] Perl problem on Cray system
373 * The any pointer (known as IoANY()) will also be a good place
374 * to hang any IO disciplines to.
377 DIR * xiou_dirp; /* for opendir, readdir, etc */
378 void * xiou_any; /* for alignment */
380 long xio_lines; /* $. */
381 long xio_page; /* $% */
382 long xio_page_len; /* $= */
383 long xio_lines_left; /* $- */
384 char * xio_top_name; /* $^ */
385 GV * xio_top_gv; /* $^ */
386 char * xio_fmt_name; /* $~ */
387 GV * xio_fmt_gv; /* $~ */
388 char * xio_bottom_name;/* $^B */
389 GV * xio_bottom_gv; /* $^B */
390 short xio_subprocess; /* -| or |- */
394 #define xio_dirp xio_dirpu.xiou_dirp
395 #define xio_any xio_dirpu.xiou_any
397 #define IOf_ARGV 1 /* this fp iterates over ARGV */
398 #define IOf_START 2 /* check for null ARGV and substitute '-' */
399 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
400 #define IOf_DIDTOP 8 /* just did top of form */
401 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
402 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
403 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
405 /* The following macros define implementation-independent predicates on SVs. */
408 =for apidoc Am|bool|SvNIOK|SV* sv
409 Returns a boolean indicating whether the SV contains a number, integer or
412 =for apidoc Am|bool|SvNIOKp|SV* sv
413 Returns a boolean indicating whether the SV contains a number, integer or
414 double. Checks the B<private> setting. Use C<SvNIOK>.
416 =for apidoc Am|void|SvNIOK_off|SV* sv
417 Unsets the NV/IV status of an SV.
419 =for apidoc Am|bool|SvOK|SV* sv
420 Returns a boolean indicating whether the value is an SV.
422 =for apidoc Am|bool|SvIOKp|SV* sv
423 Returns a boolean indicating whether the SV contains an integer. Checks
424 the B<private> setting. Use C<SvIOK>.
426 =for apidoc Am|bool|SvNOKp|SV* sv
427 Returns a boolean indicating whether the SV contains a double. Checks the
428 B<private> setting. Use C<SvNOK>.
430 =for apidoc Am|bool|SvPOKp|SV* sv
431 Returns a boolean indicating whether the SV contains a character string.
432 Checks the B<private> setting. Use C<SvPOK>.
434 =for apidoc Am|bool|SvIOK|SV* sv
435 Returns a boolean indicating whether the SV contains an integer.
437 =for apidoc Am|void|SvIOK_on|SV* sv
438 Tells an SV that it is an integer.
440 =for apidoc Am|void|SvIOK_off|SV* sv
441 Unsets the IV status of an SV.
443 =for apidoc Am|void|SvIOK_only|SV* sv
444 Tells an SV that it is an integer and disables all other OK bits.
446 =for apidoc Am|void|SvIOK_only_UV|SV* sv
447 Tells and SV that it is an unsigned integer and disables all other OK bits.
449 =for apidoc Am|void|SvIOK_UV|SV* sv
450 Returns a boolean indicating whether the SV contains an unsigned integer.
452 =for apidoc Am|void|SvUOK|SV* sv
453 Returns a boolean indicating whether the SV contains an unsigned integer.
455 =for apidoc Am|void|SvIOK_notUV|SV* sv
456 Returns a boolean indicating whether the SV contains an signed integer.
458 =for apidoc Am|bool|SvNOK|SV* sv
459 Returns a boolean indicating whether the SV contains a double.
461 =for apidoc Am|void|SvNOK_on|SV* sv
462 Tells an SV that it is a double.
464 =for apidoc Am|void|SvNOK_off|SV* sv
465 Unsets the NV status of an SV.
467 =for apidoc Am|void|SvNOK_only|SV* sv
468 Tells an SV that it is a double and disables all other OK bits.
470 =for apidoc Am|bool|SvPOK|SV* sv
471 Returns a boolean indicating whether the SV contains a character
474 =for apidoc Am|void|SvPOK_on|SV* sv
475 Tells an SV that it is a string.
477 =for apidoc Am|void|SvPOK_off|SV* sv
478 Unsets the PV status of an SV.
480 =for apidoc Am|void|SvPOK_only|SV* sv
481 Tells an SV that it is a string and disables all other OK bits.
482 Will also turn off the UTF8 status.
484 =for apidoc Am|bool|SvOOK|SV* sv
485 Returns a boolean indicating whether the SvIVX is a valid offset value for
486 the SvPVX. This hack is used internally to speed up removal of characters
487 from the beginning of a SvPV. When SvOOK is true, then the start of the
488 allocated string buffer is really (SvPVX - SvIVX).
490 =for apidoc Am|bool|SvROK|SV* sv
491 Tests if the SV is an RV.
493 =for apidoc Am|void|SvROK_on|SV* sv
494 Tells an SV that it is an RV.
496 =for apidoc Am|void|SvROK_off|SV* sv
497 Unsets the RV status of an SV.
499 =for apidoc Am|SV*|SvRV|SV* sv
500 Dereferences an RV to return the SV.
502 =for apidoc Am|IV|SvIVX|SV* sv
503 Returns the integer which is stored in the SV, assuming SvIOK is
506 =for apidoc Am|UV|SvUVX|SV* sv
507 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
510 =for apidoc Am|NV|SvNVX|SV* sv
511 Returns the double which is stored in the SV, assuming SvNOK is
514 =for apidoc Am|char*|SvPVX|SV* sv
515 Returns a pointer to the string in the SV. The SV must contain a
518 =for apidoc Am|STRLEN|SvCUR|SV* sv
519 Returns the length of the string which is in the SV. See C<SvLEN>.
521 =for apidoc Am|STRLEN|SvLEN|SV* sv
522 Returns the size of the string buffer in the SV, not including any part
523 attributable to C<SvOOK>. See C<SvCUR>.
525 =for apidoc Am|char*|SvEND|SV* sv
526 Returns a pointer to the last character in the string which is in the SV.
527 See C<SvCUR>. Access the character as *(SvEND(sv)).
529 =for apidoc Am|HV*|SvSTASH|SV* sv
530 Returns the stash of the SV.
532 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
533 Set the length of the string which is in the SV. See C<SvCUR>.
538 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
539 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
540 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
541 SVp_IOK|SVp_NOK|SVf_IVisUV))
543 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
544 #define SvOK_off(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
545 SVf_IVisUV|SVf_UTF8), \
547 #define SvOK_off_exc_UV(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
551 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
552 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
553 #define SvIOKp_on(sv) ((void)SvOOK_off(sv), SvFLAGS(sv) |= SVp_IOK)
554 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
555 #define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
556 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
557 #define SvPOKp_on(sv) (SvFLAGS(sv) |= SVp_POK)
559 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
560 #define SvIOK_on(sv) ((void)SvOOK_off(sv), \
561 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
562 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
563 #define SvIOK_only(sv) ((void)SvOK_off(sv), \
564 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
565 #define SvIOK_only_UV(sv) ((void)SvOK_off_exc_UV(sv), \
566 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
568 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
569 == (SVf_IOK|SVf_IVisUV))
570 #define SvUOK(sv) SvIOK_UV(sv)
571 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
574 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
575 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
576 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
578 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
579 #define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
580 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
581 #define SvNOK_only(sv) ((void)SvOK_off(sv), \
582 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
585 =for apidoc Am|void|SvUTF8|SV* sv
586 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
588 =for apidoc Am|void|SvUTF8_on|SV *sv
589 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
590 Do not use frivolously.
592 =for apidoc Am|void|SvUTF8_off|SV *sv
593 Unsets the UTF8 status of an SV.
595 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
596 Tells an SV that it is a string and disables all other OK bits,
597 and leaves the UTF8 status as it was.
602 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
603 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
604 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
606 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
607 #define SvPOK_on(sv) (SvFLAGS(sv) |= (SVf_POK|SVp_POK))
608 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
609 #define SvPOK_only(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
610 SVf_IVisUV|SVf_UTF8), \
611 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
612 #define SvPOK_only_UTF8(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
614 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
616 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
617 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
618 #define SvOOK_off(sv) (SvOOK(sv) && sv_backoff(sv))
620 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
621 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
622 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
624 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
625 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
626 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
628 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
629 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
630 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
632 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
633 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
634 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
636 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
637 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
638 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
640 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
641 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
642 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
644 #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
645 #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
646 #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
648 #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
651 #define Gv_AMG(stash) \
652 (HV_AMAGICmb(stash) && \
653 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
655 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
657 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
658 == (SVf_ROK|SVprv_WEAKREF))
659 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
660 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
662 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
664 #define SvPADBUSY(sv) (SvFLAGS(sv) & SVs_PADBUSY)
666 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
667 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP|SVs_PADBUSY)
668 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
670 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
671 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY|SVs_PADBUSY)
673 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
674 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
675 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
677 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
678 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
679 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
681 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
682 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
683 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
685 #define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
686 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
687 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
689 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
690 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
691 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
693 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
694 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
695 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
697 #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
698 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
699 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
701 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
702 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
703 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
705 #define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
706 #define SvRVx(sv) SvRV(sv)
708 #define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
709 #define SvIVXx(sv) SvIVX(sv)
710 #define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
711 #define SvUVXx(sv) SvUVX(sv)
712 #define SvNVX(sv) ((XPVNV*)SvANY(sv))->xnv_nv
713 #define SvNVXx(sv) SvNVX(sv)
714 #define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
715 #define SvPVXx(sv) SvPVX(sv)
716 #define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
717 #define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
718 #define SvLENx(sv) SvLEN(sv)
719 #define SvEND(sv)(((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
720 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
721 #define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
722 #define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
724 /* Ask a scalar nicely to try to become an IV, if possible.
725 Not guaranteed to stay returning void */
726 /* Macro won't actually call sv_2iv if already IOK */
727 #define SvIV_please(sv) \
728 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
729 (void) SvIV(sv); } STMT_END
730 #define SvIV_set(sv, val) \
731 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
732 (((XPVIV*) SvANY(sv))->xiv_iv = val); } STMT_END
733 #define SvNV_set(sv, val) \
734 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
735 (((XPVNV*) SvANY(sv))->xnv_nv = val); } STMT_END
736 #define SvPV_set(sv, val) \
737 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
738 (((XPV*) SvANY(sv))->xpv_pv = val); } STMT_END
739 #define SvCUR_set(sv, val) \
740 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
741 (((XPV*) SvANY(sv))->xpv_cur = val); } STMT_END
742 #define SvLEN_set(sv, val) \
743 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
744 (((XPV*) SvANY(sv))->xpv_len = val); } STMT_END
745 #define SvEND_set(sv, val) \
746 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
747 (((XPV*) SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
749 #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
750 #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
751 #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
753 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
755 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
756 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
757 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
758 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
760 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
761 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
762 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
763 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
764 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
765 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
766 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
767 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
768 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
769 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
770 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
771 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
772 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
773 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
774 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
775 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
776 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
778 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
779 #define IoTYPE_RDONLY '<'
780 #define IoTYPE_WRONLY '>'
781 #define IoTYPE_RDWR '+'
782 #define IoTYPE_APPEND 'a'
783 #define IoTYPE_PIPE '|'
784 #define IoTYPE_STD '-' /* stdin or stdout */
785 #define IoTYPE_SOCKET 's'
786 #define IoTYPE_CLOSED ' '
789 =for apidoc Am|bool|SvTAINTED|SV* sv
790 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
793 =for apidoc Am|void|SvTAINTED_on|SV* sv
794 Marks an SV as tainted.
796 =for apidoc Am|void|SvTAINTED_off|SV* sv
797 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
798 some of Perl's fundamental security features. XS module authors should not
799 use this function unless they fully understand all the implications of
800 unconditionally untainting the value. Untainting should be done in the
801 standard perl fashion, via a carefully crafted regexp, rather than directly
802 untainting variables.
804 =for apidoc Am|void|SvTAINT|SV* sv
805 Taints an SV if tainting is enabled
810 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
811 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
812 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
814 #define SvTAINT(sv) \
823 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
824 Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
825 force if you are going to update the SvPVX directly.
827 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
828 Returns a pointer to the string in the SV, or a stringified form of the SV
829 if the SV does not contain a string. Handles 'get' magic.
831 =for apidoc Am|char*|SvPV_nolen|SV* sv
832 Returns a pointer to the string in the SV, or a stringified form of the SV
833 if the SV does not contain a string. Handles 'get' magic.
835 =for apidoc Am|IV|SvIV|SV* sv
836 Coerces the given SV to an integer and returns it.
838 =for apidoc Am|NV|SvNV|SV* sv
839 Coerce the given SV to a double and return it.
841 =for apidoc Am|UV|SvUV|SV* sv
842 Coerces the given SV to an unsigned integer and returns it.
844 =for apidoc Am|bool|SvTRUE|SV* sv
845 Returns a boolean indicating whether Perl would evaluate the SV as true or
846 false, defined or undefined. Does not handle 'get' magic.
851 #define SvPV_force(sv, lp) sv_pvn_force(sv, &lp)
852 #define SvPV(sv, lp) sv_pvn(sv, &lp)
853 #define SvPV_nolen(sv) sv_pv(sv)
855 #define SvPVutf8_force(sv, lp) sv_pvutf8n_force(sv, &lp)
856 #define SvPVutf8(sv, lp) sv_pvutf8n(sv, &lp)
857 #define SvPVutf8_nolen(sv) sv_pvutf8(sv)
859 #define SvPVbyte_force(sv, lp) sv_pvbyte_force(sv, &lp)
860 #define SvPVbyte(sv, lp) sv_pvbyten(sv, &lp)
861 #define SvPVbyte_nolen(sv) sv_pvbyte(sv)
863 #define SvPVx(sv, lp) sv_pvn(sv, &lp)
864 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
865 #define SvPVutf8x(sv, lp) sv_pvutf8n(sv, &lp)
866 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
867 #define SvPVbytex(sv, lp) sv_pvbyten(sv, &lp)
868 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
870 #define SvIVx(sv) sv_iv(sv)
871 #define SvUVx(sv) sv_uv(sv)
872 #define SvNVx(sv) sv_nv(sv)
874 #define SvTRUEx(sv) sv_true(sv)
876 #define SvIV(sv) SvIVx(sv)
877 #define SvNV(sv) SvNVx(sv)
878 #define SvUV(sv) SvUVx(sv)
879 #define SvTRUE(sv) SvTRUEx(sv)
882 /* redefine some things to more efficient inlined versions */
884 /* Let us hope that bitmaps for UV and IV are the same */
886 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
889 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
892 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
894 /* flag values for sv_*_flags functions */
895 #define SV_IMMEDIATE_UNREF 1
898 #define sv_setsv_macro(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
899 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
900 #define sv_catsv_macro(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
901 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
902 #define sv_catpvn_macro(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
903 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
904 #define sv_2pv_macro(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
905 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
906 #define sv_pvn_force_macro(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
907 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
908 #define sv_utf8_upgrade_macro(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
909 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
911 /* function style also available for bincompat */
912 #define sv_setsv(dsv, ssv) sv_setsv_macro(dsv, ssv)
913 #define sv_catsv(dsv, ssv) sv_catsv_macro(dsv, ssv)
914 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_macro(dsv, sstr, slen)
915 #define sv_2pv(sv, lp) sv_2pv_macro(sv, lp)
916 #define sv_pvn_force(sv, lp) sv_pvn_force_macro(sv, lp)
917 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_macro(sv)
920 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
923 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
926 #define SvPV_flags(sv, lp, flags) \
927 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
928 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
931 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
932 #undef SvPV_force_nomg
933 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
935 #undef SvPV_force_flags
936 #define SvPV_force_flags(sv, lp, flags) \
937 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
938 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
941 #define SvPV_nolen(sv) \
942 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
943 ? SvPVX(sv) : sv_2pv_nolen(sv))
946 #define SvPVutf8(sv, lp) \
947 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
948 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
950 #undef SvPVutf8_force
951 #define SvPVutf8_force(sv, lp) \
952 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
953 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
955 #undef SvPVutf8_nolen
956 #define SvPVutf8_nolen(sv) \
957 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
958 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
961 #define SvPVutf8(sv, lp) \
962 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
963 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
965 #undef SvPVutf8_force
966 #define SvPVutf8_force(sv, lp) \
967 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
968 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
970 #undef SvPVutf8_nolen
971 #define SvPVutf8_nolen(sv) \
972 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
973 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
976 #define SvPVbyte(sv, lp) \
977 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
978 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
980 #undef SvPVbyte_force
981 #define SvPVbyte_force(sv, lp) \
982 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
983 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyte_force(sv, &lp))
985 #undef SvPVbyte_nolen
986 #define SvPVbyte_nolen(sv) \
987 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
988 ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
1000 # define SvIVx(sv) ({SV *nsv = (SV*)(sv); SvIV(nsv); })
1001 # define SvUVx(sv) ({SV *nsv = (SV*)(sv); SvUV(nsv); })
1002 # define SvNVx(sv) ({SV *nsv = (SV*)(sv); SvNV(nsv); })
1003 # define SvPVx(sv, lp) ({SV *nsv = (sv); SvPV(nsv, lp); })
1004 # define SvPVutf8x(sv, lp) ({SV *nsv = (sv); SvPVutf8(nsv, lp); })
1005 # define SvPVbytex(sv, lp) ({SV *nsv = (sv); SvPVbyte(nsv, lp); })
1006 # define SvTRUE(sv) ( \
1010 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1012 (nxpv->xpv_cur > 1 || \
1013 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
1020 ? SvNVX(sv) != 0.0 \
1022 # define SvTRUEx(sv) ({SV *nsv = (sv); SvTRUE(nsv); })
1023 #else /* __GNUC__ */
1025 /* These inlined macros use globals, which will require a thread
1026 * declaration in user code, so we avoid them under threads */
1036 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1037 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1038 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1039 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1040 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1041 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1042 # define SvTRUE(sv) ( \
1046 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
1047 (PL_Xpv->xpv_cur > 1 || \
1048 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
1055 ? SvNVX(sv) != 0.0 \
1057 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1058 #endif /* !USE_THREADS */
1059 #endif /* !__GNU__ */
1060 #endif /* !CRIPPLED_CC */
1063 =for apidoc Am|SV*|newRV_inc|SV* sv
1065 Creates an RV wrapper for an SV. The reference count for the original SV is
1071 #define newRV_inc(sv) newRV(sv)
1073 /* the following macros update any magic values this sv is associated with */
1076 =for apidoc Am|void|SvGETMAGIC|SV* sv
1077 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1078 argument more than once.
1080 =for apidoc Am|void|SvSETMAGIC|SV* sv
1081 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1082 argument more than once.
1084 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1085 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1088 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1089 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1090 ssv. May evaluate arguments more than once.
1092 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1093 Expands the character buffer in the SV so that it has room for the
1094 indicated number of bytes (remember to reserve space for an extra trailing
1095 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1096 Returns a pointer to the character buffer.
1101 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1102 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1104 #define SvSetSV_and(dst,src,finally) \
1106 if ((dst) != (src)) { \
1107 sv_setsv(dst, src); \
1111 #define SvSetSV_nosteal_and(dst,src,finally) \
1113 if ((dst) != (src)) { \
1114 U32 tMpF = SvFLAGS(src) & SVs_TEMP; \
1116 sv_setsv(dst, src); \
1117 SvFLAGS(src) |= tMpF; \
1122 #define SvSetSV(dst,src) \
1123 SvSetSV_and(dst,src,/*nothing*/;)
1124 #define SvSetSV_nosteal(dst,src) \
1125 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1127 #define SvSetMagicSV(dst,src) \
1128 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1129 #define SvSetMagicSV_nosteal(dst,src) \
1130 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1133 #define SvPEEK(sv) sv_peek(sv)
1135 #define SvPEEK(sv) ""
1138 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no)
1140 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1142 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1144 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1145 #define Sv_Grow sv_grow
1147 #define CLONEf_COPY_STACKS 1
1148 #define CLONEf_KEEP_PTR_TABLE 2