3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 #undef sv_flags /* Convex has this in <signal.h> for sigvec() */
18 =for apidoc AmU||svtype
19 An enum of flags for Perl types. These are found in the file B<sv.h>
20 in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
22 =for apidoc AmU||SVt_PV
23 Pointer type flag for scalars. See C<svtype>.
25 =for apidoc AmU||SVt_IV
26 Integer type flag for scalars. See C<svtype>.
28 =for apidoc AmU||SVt_NV
29 Double type flag for scalars. See C<svtype>.
31 =for apidoc AmU||SVt_PVMG
32 Type flag for blessed scalars. See C<svtype>.
34 =for apidoc AmU||SVt_PVAV
35 Type flag for arrays. See C<svtype>.
37 =for apidoc AmU||SVt_PVHV
38 Type flag for hashes. See C<svtype>.
40 =for apidoc AmU||SVt_PVCV
41 Type flag for code refs. See C<svtype>.
65 /* Using C's structural equivalence to help emulate C++ inheritance here... */
67 struct STRUCT_SV { /* struct sv { */
68 void* sv_any; /* pointer to something */
69 U32 sv_refcnt; /* how many references to us */
70 U32 sv_flags; /* what we are */
71 #ifdef DEBUG_LEAKING_SCALARS
72 unsigned sv_debug_optype:9; /* the type of OP that allocated us */
73 unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */
74 unsigned sv_debug_cloned:1; /* was cloned for an ithread */
75 unsigned sv_debug_line:16; /* the line where we were allocated */
76 char * sv_debug_file; /* the file where we were allocated */
81 XPVGV* sv_any; /* pointer to something */
82 U32 sv_refcnt; /* how many references to us */
83 U32 sv_flags; /* what we are */
87 XPVCV* sv_any; /* pointer to something */
88 U32 sv_refcnt; /* how many references to us */
89 U32 sv_flags; /* what we are */
93 XPVAV* sv_any; /* pointer to something */
94 U32 sv_refcnt; /* how many references to us */
95 U32 sv_flags; /* what we are */
99 XPVHV* sv_any; /* pointer to something */
100 U32 sv_refcnt; /* how many references to us */
101 U32 sv_flags; /* what we are */
105 XPVIO* sv_any; /* pointer to something */
106 U32 sv_refcnt; /* how many references to us */
107 U32 sv_flags; /* what we are */
111 =head1 SV Manipulation Functions
113 =for apidoc Am|U32|SvREFCNT|SV* sv
114 Returns the value of the object's reference count.
116 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
117 Increments the reference count of the given SV.
119 =for apidoc Am|void|SvREFCNT_dec|SV* sv
120 Decrements the reference count of the given SV.
122 =for apidoc Am|svtype|SvTYPE|SV* sv
123 Returns the type of the SV. See C<svtype>.
125 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
126 Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
127 perform the upgrade if necessary. See C<svtype>.
132 #define SvANY(sv) (sv)->sv_any
133 #define SvFLAGS(sv) (sv)->sv_flags
134 #define SvREFCNT(sv) (sv)->sv_refcnt
136 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
137 # define SvREFCNT_inc(sv) \
139 SV *_sv = (SV*)(sv); \
145 # define SvREFCNT_inc(sv) \
146 ((PL_Sv=(SV*)(sv)), (PL_Sv && ++(SvREFCNT(PL_Sv))), (SV*)PL_Sv)
149 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
150 # define SvREFCNT_dec(sv) \
152 SV *_sv = (SV*)(sv); \
154 if (SvREFCNT(_sv)) { \
155 if (--(SvREFCNT(_sv)) == 0) \
156 Perl_sv_free2(aTHX_ _sv); \
163 #define SvREFCNT_dec(sv) sv_free((SV*)(sv))
166 #define SVTYPEMASK 0xff
167 #define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
169 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
171 #define SVs_PADSTALE 0x00000100 /* lexical has gone out of scope */
172 #define SVs_PADTMP 0x00000200 /* in use as tmp */
173 #define SVs_PADMY 0x00000400 /* in use a "my" variable */
174 #define SVs_TEMP 0x00000800 /* string is stealable? */
175 #define SVs_OBJECT 0x00001000 /* is "blessed" */
176 #define SVs_GMG 0x00002000 /* has magical get method */
177 #define SVs_SMG 0x00004000 /* has magical set method */
178 #define SVs_RMG 0x00008000 /* has random magical methods */
180 #define SVf_IOK 0x00010000 /* has valid public integer value */
181 #define SVf_NOK 0x00020000 /* has valid public numeric value */
182 #define SVf_POK 0x00040000 /* has valid public pointer value */
183 #define SVf_ROK 0x00080000 /* has a valid reference pointer */
185 #define SVf_FAKE 0x00100000 /* glob or lexical is just a copy */
186 #define SVf_OOK 0x00200000 /* has valid offset value */
187 #define SVf_BREAK 0x00400000 /* refcnt is artificially low - used
188 * by SV's in final arena cleanup */
189 #define SVf_READONLY 0x00800000 /* may not be modified */
192 #define SVp_IOK 0x01000000 /* has valid non-public integer value */
193 #define SVp_NOK 0x02000000 /* has valid non-public numeric value */
194 #define SVp_POK 0x04000000 /* has valid non-public pointer value */
195 #define SVp_SCREAM 0x08000000 /* has been studied? */
197 #define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
198 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
200 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
202 #define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
203 SVp_IOK|SVp_NOK|SVp_POK)
205 #define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
207 #define PRIVSHIFT 8 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
209 /* Some private flags. */
211 /* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
212 #define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
213 #define SVpad_TYPED 0x40000000 /* Typed Lexical */
215 #define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
217 #define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
219 #define SVpbm_VALID 0x80000000
220 #define SVpbm_TAIL 0x40000000
222 #define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
224 #define SVphv_REHASH 0x10000000 /* HV is recalculating hash values */
225 #define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */
226 #define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
227 #define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
229 #define SVprv_WEAKREF 0x80000000 /* Weak reference */
232 SV * xrv_rv; /* pointer to another SV */
236 char * xpv_pv; /* pointer to malloced string */
237 STRLEN xpv_cur; /* length of xpv_pv as a C string */
238 STRLEN xpv_len; /* allocated size */
242 char * xpv_pv; /* pointer to malloced string */
243 STRLEN xpv_cur; /* length of xpv_pv as a C string */
244 STRLEN xpv_len; /* allocated size */
245 IV xiv_iv; /* integer value or pv offset */
249 char * xpv_pv; /* pointer to malloced string */
250 STRLEN xpv_cur; /* length of xpv_pv as a C string */
251 STRLEN xpv_len; /* allocated size */
252 UV xuv_uv; /* unsigned value or pv offset */
256 char * xpv_pv; /* pointer to malloced string */
257 STRLEN xpv_cur; /* length of xpv_pv as a C string */
258 STRLEN xpv_len; /* allocated size */
259 IV xiv_iv; /* integer value or pv offset */
260 NV xnv_nv; /* numeric value, if any */
263 /* These structure must match the beginning of struct xpvhv in hv.h. */
265 char * xpv_pv; /* pointer to malloced string */
266 STRLEN xpv_cur; /* length of xpv_pv as a C string */
267 STRLEN xpv_len; /* allocated size */
268 IV xiv_iv; /* integer value or pv offset */
269 NV xnv_nv; /* numeric value, if any */
270 MAGIC* xmg_magic; /* linked list of magicalness */
271 HV* xmg_stash; /* class package */
275 char * xpv_pv; /* pointer to malloced string */
276 STRLEN xpv_cur; /* length of xpv_pv as a C string */
277 STRLEN xpv_len; /* allocated size */
278 IV xiv_iv; /* integer value or pv offset */
279 NV xnv_nv; /* numeric value, if any */
280 MAGIC* xmg_magic; /* linked list of magicalness */
281 HV* xmg_stash; /* class package */
283 /* a full glob fits into this */
293 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
294 * y=alem/helem/iter t=tie T=tied HE */
298 char * xpv_pv; /* pointer to malloced string */
299 STRLEN xpv_cur; /* length of xpv_pv as a C string */
300 STRLEN xpv_len; /* allocated size */
301 IV xiv_iv; /* integer value or pv offset */
302 NV xnv_nv; /* numeric value, if any */
303 MAGIC* xmg_magic; /* linked list of magicalness */
304 HV* xmg_stash; /* class package */
314 char * xpv_pv; /* pointer to malloced string */
315 STRLEN xpv_cur; /* length of xpv_pv as a C string */
316 STRLEN xpv_len; /* allocated size */
317 IV xiv_iv; /* integer value or pv offset */
318 NV xnv_nv; /* numeric value, if any */
319 MAGIC* xmg_magic; /* linked list of magicalness */
320 HV* xmg_stash; /* class package */
322 I32 xbm_useful; /* is this constant pattern being useful? */
323 U16 xbm_previous; /* how many characters in string before rare? */
324 U8 xbm_rare; /* rarest character in string */
327 /* This structure must match XPVCV in cv.h */
329 typedef U16 cv_flags_t;
332 char * xpv_pv; /* pointer to malloced string */
333 STRLEN xpv_cur; /* length of xpv_pv as a C string */
334 STRLEN xpv_len; /* allocated size */
335 IV xiv_iv; /* integer value or pv offset */
336 NV xnv_nv; /* numeric value, if any */
337 MAGIC* xmg_magic; /* linked list of magicalness */
338 HV* xmg_stash; /* class package */
343 void (*xcv_xsub)(pTHX_ CV*);
347 long xcv_depth; /* >= 2 indicates recursive call */
350 cv_flags_t xcv_flags;
351 U32 xcv_outside_seq; /* the COP sequence (at the point of our
352 * compilation) in the lexically enclosing
358 char * xpv_pv; /* pointer to malloced string */
359 STRLEN xpv_cur; /* length of xpv_pv as a C string */
360 STRLEN xpv_len; /* allocated size */
361 IV xiv_iv; /* integer value or pv offset */
362 NV xnv_nv; /* numeric value, if any */
363 MAGIC* xmg_magic; /* linked list of magicalness */
364 HV* xmg_stash; /* class package */
366 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
367 PerlIO * xio_ofp; /* but sockets need separate streams */
368 /* Cray addresses everything by word boundaries (64 bits) and
369 * code and data pointers cannot be mixed (which is exactly what
370 * Perl_filter_add() tries to do with the dirp), hence the following
371 * union trick (as suggested by Gurusamy Sarathy).
372 * For further information see Geir Johansen's problem report titled
373 [ID 20000612.002] Perl problem on Cray system
374 * The any pointer (known as IoANY()) will also be a good place
375 * to hang any IO disciplines to.
378 DIR * xiou_dirp; /* for opendir, readdir, etc */
379 void * xiou_any; /* for alignment */
381 IV xio_lines; /* $. */
382 IV xio_page; /* $% */
383 IV xio_page_len; /* $= */
384 IV xio_lines_left; /* $- */
385 char * xio_top_name; /* $^ */
386 GV * xio_top_gv; /* $^ */
387 char * xio_fmt_name; /* $~ */
388 GV * xio_fmt_gv; /* $~ */
389 char * xio_bottom_name;/* $^B */
390 GV * xio_bottom_gv; /* $^B */
391 short xio_subprocess; /* -| or |- */
395 #define xio_dirp xio_dirpu.xiou_dirp
396 #define xio_any xio_dirpu.xiou_any
398 #define IOf_ARGV 1 /* this fp iterates over ARGV */
399 #define IOf_START 2 /* check for null ARGV and substitute '-' */
400 #define IOf_FLUSH 4 /* this fp wants a flush after write op */
401 #define IOf_DIDTOP 8 /* just did top of form */
402 #define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
403 #define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
404 #define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
406 /* The following macros define implementation-independent predicates on SVs. */
409 =for apidoc Am|bool|SvNIOK|SV* sv
410 Returns a boolean indicating whether the SV contains a number, integer or
413 =for apidoc Am|bool|SvNIOKp|SV* sv
414 Returns a boolean indicating whether the SV contains a number, integer or
415 double. Checks the B<private> setting. Use C<SvNIOK>.
417 =for apidoc Am|void|SvNIOK_off|SV* sv
418 Unsets the NV/IV status of an SV.
420 =for apidoc Am|bool|SvOK|SV* sv
421 Returns a boolean indicating whether the value is an SV. It also tells
422 whether the value is defined or not.
424 =for apidoc Am|bool|SvIOKp|SV* sv
425 Returns a boolean indicating whether the SV contains an integer. Checks
426 the B<private> setting. Use C<SvIOK>.
428 =for apidoc Am|bool|SvNOKp|SV* sv
429 Returns a boolean indicating whether the SV contains a double. Checks the
430 B<private> setting. Use C<SvNOK>.
432 =for apidoc Am|bool|SvPOKp|SV* sv
433 Returns a boolean indicating whether the SV contains a character string.
434 Checks the B<private> setting. Use C<SvPOK>.
436 =for apidoc Am|bool|SvIOK|SV* sv
437 Returns a boolean indicating whether the SV contains an integer.
439 =for apidoc Am|void|SvIOK_on|SV* sv
440 Tells an SV that it is an integer.
442 =for apidoc Am|void|SvIOK_off|SV* sv
443 Unsets the IV status of an SV.
445 =for apidoc Am|void|SvIOK_only|SV* sv
446 Tells an SV that it is an integer and disables all other OK bits.
448 =for apidoc Am|void|SvIOK_only_UV|SV* sv
449 Tells and SV that it is an unsigned integer and disables all other OK bits.
451 =for apidoc Am|bool|SvIOK_UV|SV* sv
452 Returns a boolean indicating whether the SV contains an unsigned integer.
454 =for apidoc Am|void|SvUOK|SV* sv
455 Returns a boolean indicating whether the SV contains an unsigned integer.
457 =for apidoc Am|bool|SvIOK_notUV|SV* sv
458 Returns a boolean indicating whether the SV contains a signed integer.
460 =for apidoc Am|bool|SvNOK|SV* sv
461 Returns a boolean indicating whether the SV contains a double.
463 =for apidoc Am|void|SvNOK_on|SV* sv
464 Tells an SV that it is a double.
466 =for apidoc Am|void|SvNOK_off|SV* sv
467 Unsets the NV status of an SV.
469 =for apidoc Am|void|SvNOK_only|SV* sv
470 Tells an SV that it is a double and disables all other OK bits.
472 =for apidoc Am|bool|SvPOK|SV* sv
473 Returns a boolean indicating whether the SV contains a character
476 =for apidoc Am|void|SvPOK_on|SV* sv
477 Tells an SV that it is a string.
479 =for apidoc Am|void|SvPOK_off|SV* sv
480 Unsets the PV status of an SV.
482 =for apidoc Am|void|SvPOK_only|SV* sv
483 Tells an SV that it is a string and disables all other OK bits.
484 Will also turn off the UTF-8 status.
486 =for apidoc Am|bool|SvVOK|SV* sv
487 Returns a boolean indicating whether the SV contains a v-string.
489 =for apidoc Am|bool|SvOOK|SV* sv
490 Returns a boolean indicating whether the SvIVX is a valid offset value for
491 the SvPVX. This hack is used internally to speed up removal of characters
492 from the beginning of a SvPV. When SvOOK is true, then the start of the
493 allocated string buffer is really (SvPVX - SvIVX).
495 =for apidoc Am|bool|SvROK|SV* sv
496 Tests if the SV is an RV.
498 =for apidoc Am|void|SvROK_on|SV* sv
499 Tells an SV that it is an RV.
501 =for apidoc Am|void|SvROK_off|SV* sv
502 Unsets the RV status of an SV.
504 =for apidoc Am|SV*|SvRV|SV* sv
505 Dereferences an RV to return the SV.
507 =for apidoc Am|IV|SvIVX|SV* sv
508 Returns the raw value in the SV's IV slot, without checks or conversions.
509 Only use when you are sure SvIOK is true. See also C<SvIV()>.
511 =for apidoc Am|UV|SvUVX|SV* sv
512 Returns the raw value in the SV's UV slot, without checks or conversions.
513 Only use when you are sure SvIOK is true. See also C<SvUV()>.
515 =for apidoc Am|NV|SvNVX|SV* sv
516 Returns the raw value in the SV's NV slot, without checks or conversions.
517 Only use when you are sure SvNOK is true. See also C<SvNV()>.
519 =for apidoc Am|char*|SvPVX|SV* sv
520 Returns a pointer to the physical string in the SV. The SV must contain a
523 =for apidoc Am|STRLEN|SvCUR|SV* sv
524 Returns the length of the string which is in the SV. See C<SvLEN>.
526 =for apidoc Am|STRLEN|SvLEN|SV* sv
527 Returns the size of the string buffer in the SV, not including any part
528 attributable to C<SvOOK>. See C<SvCUR>.
530 =for apidoc Am|char*|SvEND|SV* sv
531 Returns a pointer to the last character in the string which is in the SV.
532 See C<SvCUR>. Access the character as *(SvEND(sv)).
534 =for apidoc Am|HV*|SvSTASH|SV* sv
535 Returns the stash of the SV.
537 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
538 Set the length of the string which is in the SV. See C<SvCUR>.
543 #define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
544 #define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
545 #define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
546 SVp_IOK|SVp_NOK|SVf_IVisUV))
548 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
549 #define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
551 #define assert_not_ROK(sv)
554 #define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
555 #define SvOK_off(sv) (assert_not_ROK(sv) \
556 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
557 SVf_IVisUV|SVf_UTF8), \
559 #define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
560 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
564 #define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
565 #define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
566 #define SvIOKp_on(sv) (SvRELEASE_IVX(sv), \
567 SvFLAGS(sv) |= SVp_IOK)
568 #define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
569 #define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
570 #define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
571 #define SvPOKp_on(sv) (assert_not_ROK(sv) \
572 SvFLAGS(sv) |= SVp_POK)
574 #define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
575 #define SvIOK_on(sv) (SvRELEASE_IVX(sv), \
576 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
577 #define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
578 #define SvIOK_only(sv) (SvOK_off(sv), \
579 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
580 #define SvIOK_only_UV(sv) (SvOK_off_exc_UV(sv), \
581 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
583 #define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
584 == (SVf_IOK|SVf_IVisUV))
585 #define SvUOK(sv) SvIOK_UV(sv)
586 #define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
589 #define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
590 #define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
591 #define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
593 #define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
594 #define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
595 #define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
596 #define SvNOK_only(sv) (SvOK_off(sv), \
597 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
600 =for apidoc Am|bool|SvUTF8|SV* sv
601 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
603 =for apidoc Am|void|SvUTF8_on|SV *sv
604 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
605 Do not use frivolously.
607 =for apidoc Am|void|SvUTF8_off|SV *sv
608 Unsets the UTF-8 status of an SV.
610 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
611 Tells an SV that it is a string and disables all other OK bits,
612 and leaves the UTF-8 status as it was.
617 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
619 #define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
620 #define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
621 #define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
623 #define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
624 #define SvPOK_on(sv) (assert_not_ROK(sv) \
625 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
626 #define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
627 #define SvPOK_only(sv) (assert_not_ROK(sv) \
628 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
629 SVf_IVisUV|SVf_UTF8), \
630 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
631 #define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) \
632 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
634 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
636 #define SvVOK(sv) (SvMAGICAL(sv) && mg_find(sv,'V'))
637 #define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
638 #define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
639 #define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
641 #define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
642 #define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
643 #define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
645 #define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
646 #define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
647 #define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
649 #define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
650 #define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
651 #define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
653 #define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
654 #define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
655 #define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
657 #define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
658 #define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
659 #define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
661 #define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
662 #define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
663 #define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
665 #define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
666 #define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
667 #define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
669 #define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
672 #define Gv_AMG(stash) \
673 (HV_AMAGICmb(stash) && \
674 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
676 #define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
678 #define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
679 == (SVf_ROK|SVprv_WEAKREF))
680 #define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
681 #define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
683 #define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
685 #define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
686 #define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
687 #define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
689 #define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
690 #define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
691 #define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
693 #define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
694 #define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
696 #define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
697 #define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
698 #define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
700 #define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
701 #define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
702 #define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
704 #define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
705 #define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
706 #define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
708 #define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
709 #define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
710 #define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
712 #define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
713 #define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
714 #define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
716 #define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
717 #define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
718 #define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
720 #define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
721 #define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
722 #define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
724 #define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
725 #define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
726 #define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
729 /* The following uses the FAKE flag to show that a regex pointer is infact
730 its own offset in the regexpad for ithreads */
731 #define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
732 #define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
733 #define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
736 #define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
737 #define SvRVx(sv) SvRV(sv)
739 #ifdef PERL_DEBUG_COW
740 #define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
741 #define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
742 #define SvNVX(sv) (0.0 + ((XPVNV*)SvANY(sv))->xnv_nv)
744 #define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
745 #define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
746 #define SvNVX(sv) ((XPVNV*)SvANY(sv))->xnv_nv
748 #define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
749 #define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
750 #define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
751 #define SvEND(sv)(((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
753 #define SvIVXx(sv) SvIVX(sv)
754 #define SvUVXx(sv) SvUVX(sv)
755 #define SvNVXx(sv) SvNVX(sv)
756 #define SvPVXx(sv) SvPVX(sv)
757 #define SvLENx(sv) SvLEN(sv)
758 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
761 #define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_magic))
762 #define SvSTASH(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
764 #define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
765 #define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
768 /* Ask a scalar nicely to try to become an IV, if possible.
769 Not guaranteed to stay returning void */
770 /* Macro won't actually call sv_2iv if already IOK */
771 #define SvIV_please(sv) \
772 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
773 (void) SvIV(sv); } STMT_END
774 #define SvIV_set(sv, val) \
775 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
776 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
777 #define SvNV_set(sv, val) \
778 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
779 (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END
780 #define SvPV_set(sv, val) \
781 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
782 (SvPVX(sv) = (val)); } STMT_END
783 #define SvCUR_set(sv, val) \
784 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
785 (SvCUR(sv) = (val)); } STMT_END
786 #define SvLEN_set(sv, val) \
787 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
788 (SvLEN(sv) = (val)); } STMT_END
789 #define SvEND_set(sv, val) \
790 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
791 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
793 #define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
794 #define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
795 #define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
797 #define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
799 #define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
800 #define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
801 #define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
802 #define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
804 #define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
805 #define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
806 #define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
807 #define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
808 #define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
809 #define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
810 #define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
811 #define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
812 #define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
813 #define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
814 #define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
815 #define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
816 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
817 #define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
818 #define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
819 #define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
820 #define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
822 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
823 #define IoTYPE_RDONLY '<'
824 #define IoTYPE_WRONLY '>'
825 #define IoTYPE_RDWR '+'
826 #define IoTYPE_APPEND 'a'
827 #define IoTYPE_PIPE '|'
828 #define IoTYPE_STD '-' /* stdin or stdout */
829 #define IoTYPE_SOCKET 's'
830 #define IoTYPE_CLOSED ' '
831 #define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
832 #define IoTYPE_NUMERIC '#' /* fdopen */
835 =for apidoc Am|bool|SvTAINTED|SV* sv
836 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
839 =for apidoc Am|void|SvTAINTED_on|SV* sv
840 Marks an SV as tainted if tainting is enabled.
842 =for apidoc Am|void|SvTAINTED_off|SV* sv
843 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
844 some of Perl's fundamental security features. XS module authors should not
845 use this function unless they fully understand all the implications of
846 unconditionally untainting the value. Untainting should be done in the
847 standard perl fashion, via a carefully crafted regexp, rather than directly
848 untainting variables.
850 =for apidoc Am|void|SvTAINT|SV* sv
851 Taints an SV if tainting is enabled.
856 #define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
857 #define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
858 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
860 #define SvTAINT(sv) \
869 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
870 Like C<SvPV> but will force the SV into containing just a string
871 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
874 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
875 Like C<SvPV> but will force the SV into containing just a string
876 (C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
877 directly. Doesn't process magic.
879 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
880 Returns a pointer to the string in the SV, or a stringified form of
881 the SV if the SV does not contain a string. The SV may cache the
882 stringified version becoming C<SvPOK>. Handles 'get' magic. See also
883 C<SvPVx> for a version which guarantees to evaluate sv only once.
885 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
886 A version of C<SvPV> which guarantees to evaluate sv only once.
888 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
889 Like C<SvPV> but doesn't process magic.
891 =for apidoc Am|char*|SvPV_nolen|SV* sv
892 Returns a pointer to the string in the SV, or a stringified form of
893 the SV if the SV does not contain a string. The SV may cache the
894 stringified form becoming C<SvPOK>. Handles 'get' magic.
896 =for apidoc Am|IV|SvIV|SV* sv
897 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
898 version which guarantees to evaluate sv only once.
900 =for apidoc Am|IV|SvIV_nomg|SV* sv
901 Like C<SvIV> but doesn't process magic.
903 =for apidoc Am|IV|SvIVx|SV* sv
904 Coerces the given SV to an integer and returns it. Guarantees to evaluate
905 sv only once. Use the more efficient C<SvIV> otherwise.
907 =for apidoc Am|NV|SvNV|SV* sv
908 Coerce the given SV to a double and return it. See C<SvNVx> for a version
909 which guarantees to evaluate sv only once.
911 =for apidoc Am|NV|SvNVx|SV* sv
912 Coerces the given SV to a double and returns it. Guarantees to evaluate
913 sv only once. Use the more efficient C<SvNV> otherwise.
915 =for apidoc Am|UV|SvUV|SV* sv
916 Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
917 for a version which guarantees to evaluate sv only once.
919 =for apidoc Am|UV|SvUV_nomg|SV* sv
920 Like C<SvUV> but doesn't process magic.
922 =for apidoc Am|UV|SvUVx|SV* sv
923 Coerces the given SV to an unsigned integer and returns it. Guarantees to
924 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
926 =for apidoc Am|bool|SvTRUE|SV* sv
927 Returns a boolean indicating whether Perl would evaluate the SV as true or
928 false, defined or undefined. Does not handle 'get' magic.
930 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
931 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
933 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
934 Like C<SvPV>, but converts sv to utf8 first if necessary.
936 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
937 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
939 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
940 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
942 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
943 Like C<SvPV>, but converts sv to byte representation first if necessary.
945 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
946 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
948 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
949 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
950 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
953 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
954 Like C<SvPV>, but converts sv to utf8 first if necessary.
955 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
958 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
959 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
960 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
963 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
964 Like C<SvPV>, but converts sv to byte representation first if necessary.
965 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
968 =for apidoc Am|bool|SvIsCOW|SV* sv
969 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
970 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
973 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
974 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
977 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
978 Like C<sv_catpvn> but doesn't process magic.
980 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
981 Like C<sv_setsv> but doesn't process magic.
983 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
984 Like C<sv_catsv> but doesn't process magic.
989 /* Let us hope that bitmaps for UV and IV are the same */
990 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
991 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
992 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
994 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
995 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
999 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1001 #define SvPV_flags(sv, lp, flags) \
1002 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1003 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1005 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1007 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1009 #define SvPV_force_flags(sv, lp, flags) \
1010 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1011 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1013 #define SvPV_nolen(sv) \
1014 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1015 ? SvPVX(sv) : sv_2pv_nolen(sv))
1017 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1021 #define SvPVutf8(sv, lp) \
1022 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1023 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1025 #define SvPVutf8_force(sv, lp) \
1026 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1027 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1030 #define SvPVutf8_nolen(sv) \
1031 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1032 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
1036 #define SvPVbyte(sv, lp) \
1037 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1038 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1040 #define SvPVbyte_force(sv, lp) \
1041 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1042 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1044 #define SvPVbyte_nolen(sv) \
1045 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1046 ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
1050 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1051 * var to evaluate the arg once; failing that, use a global if possible;
1052 * failing that, call a function to do the work
1055 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1056 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1057 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1059 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1061 # define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1062 # define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1063 # define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1064 # define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1065 # define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1066 # define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1067 # define SvTRUE(sv) ( \
1071 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1073 (nxpv->xpv_cur > 1 || \
1074 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
1081 ? SvNVX(sv) != 0.0 \
1083 # define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1085 #else /* __GNUC__ */
1087 /* These inlined macros use globals, which will require a thread
1088 * declaration in user code, so we avoid them under threads */
1090 # define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1091 # define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1092 # define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1093 # define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1094 # define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1095 # define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1096 # define SvTRUE(sv) ( \
1100 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
1101 (PL_Xpv->xpv_cur > 1 || \
1102 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
1109 ? SvNVX(sv) != 0.0 \
1111 # define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1112 #endif /* __GNU__ */
1114 #define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1115 (SVf_FAKE | SVf_READONLY))
1116 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1118 /* flag values for sv_*_flags functions */
1119 #define SV_IMMEDIATE_UNREF 1
1121 #define SV_COW_DROP_PV 4
1122 #define SV_UTF8_NO_ENCODING 8
1123 #define SV_NOSTEAL 16
1125 /* We are about to replace the SV's current value. So if it's copy on write
1126 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1127 the value is about to get thrown away, so drop the PV rather than go to
1128 the effort of making a read-write copy only for it to get immediately
1131 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1132 sv_force_normal_flags(sv, SV_COW_DROP_PV)
1134 #ifdef PERL_COPY_ON_WRITE
1135 # define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1136 && Perl_sv_release_IVX(aTHX_ sv)))
1137 # define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
1139 #define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1140 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1141 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1142 #define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1145 # define SvRELEASE_IVX(sv) SvOOK_off(sv)
1146 #endif /* PERL_COPY_ON_WRITE */
1148 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1149 sv_force_normal_flags(sv, 0)
1152 /* all these 'functions' are now just macros */
1154 #define sv_pv(sv) SvPV_nolen(sv)
1155 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1156 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1158 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1159 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1160 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1161 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1162 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1163 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1164 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1165 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1166 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1167 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1168 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1169 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1170 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1171 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1173 /* Should be named SvCatPVN_utf8_upgrade? */
1174 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1177 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1179 sv_setpvn(nsv, sstr, slen); \
1181 sv_utf8_upgrade(nsv); \
1182 sv_catsv(dsv, nsv); \
1186 =for apidoc Am|SV*|newRV_inc|SV* sv
1188 Creates an RV wrapper for an SV. The reference count for the original SV is
1194 #define newRV_inc(sv) newRV(sv)
1196 /* the following macros update any magic values this sv is associated with */
1199 =head1 Magical Functions
1201 =for apidoc Am|void|SvGETMAGIC|SV* sv
1202 Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1203 argument more than once.
1205 =for apidoc Am|void|SvSETMAGIC|SV* sv
1206 Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1207 argument more than once.
1209 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1210 Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1213 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1214 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1215 ssv. May evaluate arguments more than once.
1217 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1218 Like C<SvSetSV>, but does any set magic required afterwards.
1220 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1221 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1223 =for apidoc Am|void|SvSHARE|SV* sv
1224 Arranges for sv to be shared between threads if a suitable module
1227 =for apidoc Am|void|SvLOCK|SV* sv
1228 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1231 =for apidoc Am|void|SvUNLOCK|SV* sv
1232 Releases a mutual exclusion lock on sv if a suitable module
1235 =head1 SV Manipulation Functions
1237 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1238 Expands the character buffer in the SV so that it has room for the
1239 indicated number of bytes (remember to reserve space for an extra trailing
1240 NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1241 Returns a pointer to the character buffer.
1246 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1247 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1248 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1250 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1251 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1253 #define SvSetSV_and(dst,src,finally) \
1255 if ((dst) != (src)) { \
1256 sv_setsv(dst, src); \
1260 #define SvSetSV_nosteal_and(dst,src,finally) \
1262 if ((dst) != (src)) { \
1263 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL); \
1268 #define SvSetSV(dst,src) \
1269 SvSetSV_and(dst,src,/*nothing*/;)
1270 #define SvSetSV_nosteal(dst,src) \
1271 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1273 #define SvSetMagicSV(dst,src) \
1274 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1275 #define SvSetMagicSV_nosteal(dst,src) \
1276 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1279 #if !defined(SKIP_DEBUGGING)
1280 #define SvPEEK(sv) sv_peek(sv)
1282 #define SvPEEK(sv) ""
1285 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1287 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1289 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1291 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1292 #define Sv_Grow sv_grow
1294 #define CLONEf_COPY_STACKS 1
1295 #define CLONEf_KEEP_PTR_TABLE 2
1296 #define CLONEf_CLONE_HOST 4
1297 #define CLONEf_JOIN_IN 8
1299 struct clone_params {
1302 PerlInterpreter *proto_perl;