This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta entries for the double-magic fixes [perl #76814]
[perl5.git] / sv.h
CommitLineData
a0d0e21e 1/* sv.h
79072805 2 *
1129b882 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
83706693 4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
79072805
LW
5 *
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.
8 *
79072805
LW
9 */
10
a0d0e21e
LW
11#ifdef sv_flags
12#undef sv_flags /* Convex has this in <signal.h> for sigvec() */
13#endif
14
954c1994 15/*
ccfc67b7
JH
16=head1 SV Flags
17
954c1994 18=for apidoc AmU||svtype
8cf8f3d1 19An enum of flags for Perl types. These are found in the file B<sv.h>
954c1994
GS
20in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
21
22=for apidoc AmU||SVt_PV
23Pointer type flag for scalars. See C<svtype>.
24
25=for apidoc AmU||SVt_IV
26Integer type flag for scalars. See C<svtype>.
27
28=for apidoc AmU||SVt_NV
29Double type flag for scalars. See C<svtype>.
30
31=for apidoc AmU||SVt_PVMG
32Type flag for blessed scalars. See C<svtype>.
33
34=for apidoc AmU||SVt_PVAV
35Type flag for arrays. See C<svtype>.
36
37=for apidoc AmU||SVt_PVHV
38Type flag for hashes. See C<svtype>.
39
40=for apidoc AmU||SVt_PVCV
41Type flag for code refs. See C<svtype>.
42
43=cut
44*/
45
79072805 46typedef enum {
a0d0e21e 47 SVt_NULL, /* 0 */
1cb9cd50
NC
48 SVt_BIND, /* 1 */
49 SVt_IV, /* 2 */
4df7f6af
NC
50 SVt_NV, /* 3 */
51 /* RV was here, before it was merged with IV. */
52 SVt_PV, /* 4 */
53 SVt_PVIV, /* 5 */
54 SVt_PVNV, /* 6 */
55 SVt_PVMG, /* 7 */
5c35adbb 56 SVt_REGEXP, /* 8 */
cecf5685 57 /* PVBM was here, before BIND replaced it. */
4ce457a6
TP
58 SVt_PVGV, /* 9 */
59 SVt_PVLV, /* 10 */
60 SVt_PVAV, /* 11 */
61 SVt_PVHV, /* 12 */
62 SVt_PVCV, /* 13 */
a0d0e21e 63 SVt_PVFM, /* 14 */
93e68bfb
JC
64 SVt_PVIO, /* 15 */
65 SVt_LAST /* keep last in enum. used to size arrays */
79072805
LW
66} svtype;
67
cecf5685
NC
68#ifndef PERL_CORE
69/* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
70 purposes eternal code wanting to consider PVBM probably needs to think of
71 PVMG instead. */
72# define SVt_PVBM SVt_PVMG
4df7f6af
NC
73/* Anything wanting to create a reference from clean should ensure that it has
74 a scalar of type SVt_IV now: */
75# define SVt_RV SVt_IV
cecf5685
NC
76#endif
77
d2a0f284 78/* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
db93c0c4
NC
79 so never reaches the clause at the end that uses sv_type_details->body_size
80 to determine whether to call safefree(). Hence body_size can be set
81 non-zero to record the size of HEs, without fear of bogus frees. */
6a93a7e5
NC
82#if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
83#define HE_SVSLOT SVt_NULL
84#endif
43e6e717 85
232d1c15
NC
86#define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
87
43e6e717
NC
88/* typedefs to eliminate some typing */
89typedef struct he HE;
90typedef struct hek HEK;
91
79072805
LW
92/* Using C's structural equivalence to help emulate C++ inheritance here... */
93
30153bd2
JC
94/* start with 2 sv-head building blocks */
95#define _SV_HEAD(ptrtype) \
96 ptrtype sv_any; /* pointer to body */ \
97 U32 sv_refcnt; /* how many references to us */ \
98 U32 sv_flags /* what we are */
99
100#define _SV_HEAD_UNION \
101 union { \
2a12fdfc 102 char* svu_pv; /* pointer to malloced string */ \
30153bd2
JC
103 IV svu_iv; \
104 UV svu_uv; \
105 SV* svu_rv; /* pointer to another SV */ \
30153bd2
JC
106 SV** svu_array; \
107 HE** svu_hash; \
f7877b28 108 GP* svu_gp; \
6f7e8353 109 PerlIO *svu_fp; \
30153bd2
JC
110 } sv_u
111
112
5e045b90 113struct STRUCT_SV { /* struct sv { */
30153bd2
JC
114 _SV_HEAD(void*);
115 _SV_HEAD_UNION;
fd0854ff 116#ifdef DEBUG_LEAKING_SCALARS
654eccd5
JD
117 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */
118 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */
654eccd5 119 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */
c895a371 120 UV sv_debug_serial; /* serial number of sv allocation */
cd676548
DM
121 char * sv_debug_file; /* the file where we were allocated */
122 SV * sv_debug_parent; /* what we were cloned from (ithreads)*/
fd0854ff 123#endif
79072805
LW
124};
125
126struct gv {
30153bd2
JC
127 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
128 _SV_HEAD_UNION;
79072805
LW
129};
130
131struct cv {
30153bd2
JC
132 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
133 _SV_HEAD_UNION;
79072805
LW
134};
135
136struct av {
0f7b1ae0 137 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
30153bd2 138 _SV_HEAD_UNION;
79072805
LW
139};
140
141struct hv {
30153bd2
JC
142 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
143 _SV_HEAD_UNION;
8990e307
LW
144};
145
146struct io {
30153bd2
JC
147 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
148 _SV_HEAD_UNION;
79072805
LW
149};
150
d2f13c59
NC
151struct p5rx {
152 _SV_HEAD(struct regexp*); /* pointer to regexp body */
153 _SV_HEAD_UNION;
154};
155
30153bd2 156#undef _SV_HEAD
0f7b1ae0 157#undef _SV_HEAD_UNION /* ensure no pollution */
30153bd2 158
954c1994 159/*
ccfc67b7
JH
160=head1 SV Manipulation Functions
161
954c1994
GS
162=for apidoc Am|U32|SvREFCNT|SV* sv
163Returns the value of the object's reference count.
164
165=for apidoc Am|SV*|SvREFCNT_inc|SV* sv
166Increments the reference count of the given SV.
167
b37c2d43
AL
168All of the following SvREFCNT_inc* macros are optimized versions of
169SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
170
171=for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
172Same as SvREFCNT_inc, but can only be used if you know I<sv>
173is not NULL. Since we don't have to check the NULLness, it's faster
174and smaller.
175
f2403e57 176=for apidoc Am|void|SvREFCNT_inc_void|SV* sv
b37c2d43
AL
177Same as SvREFCNT_inc, but can only be used if you don't need the
178return value. The macro doesn't need to return a meaningful value.
179
f2403e57 180=for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
b37c2d43
AL
181Same as SvREFCNT_inc, but can only be used if you don't need the return
182value, and you know that I<sv> is not NULL. The macro doesn't need
183to return a meaningful value, or check for NULLness, so it's smaller
184and faster.
185
186=for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
4ea561bc
NC
187Same as SvREFCNT_inc, but can only be used with expressions without side
188effects. Since we don't have to store a temporary value, it's faster.
b37c2d43
AL
189
190=for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
191Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
192is not NULL. Since we don't have to check the NULLness, it's faster
193and smaller.
194
f2403e57 195=for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
b37c2d43
AL
196Same as SvREFCNT_inc_simple, but can only be used if you don't need the
197return value. The macro doesn't need to return a meaningful value.
198
f2403e57 199=for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
e638c624
MHM
200Same as SvREFCNT_inc, but can only be used if you don't need the return
201value, and you know that I<sv> is not NULL. The macro doesn't need
202to return a meaningful value, or check for NULLness, so it's smaller
203and faster.
b37c2d43 204
954c1994
GS
205=for apidoc Am|void|SvREFCNT_dec|SV* sv
206Decrements the reference count of the given SV.
207
208=for apidoc Am|svtype|SvTYPE|SV* sv
209Returns the type of the SV. See C<svtype>.
210
211=for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
212Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
213perform the upgrade if necessary. See C<svtype>.
214
215=cut
216*/
217
463ee0b2 218#define SvANY(sv) (sv)->sv_any
79072805 219#define SvFLAGS(sv) (sv)->sv_flags
aeea060c 220#define SvREFCNT(sv) (sv)->sv_refcnt
a863c7d1 221
7fe44985 222#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
dce16143
MB
223# define SvREFCNT_inc(sv) \
224 ({ \
b1bc3f34 225 SV * const _sv = MUTABLE_SV(sv); \
3de3296f
AE
226 if (_sv) \
227 (SvREFCNT(_sv))++; \
228 _sv; \
dce16143 229 })
b37c2d43
AL
230# define SvREFCNT_inc_simple(sv) \
231 ({ \
232 if (sv) \
233 (SvREFCNT(sv))++; \
b1bc3f34 234 MUTABLE_SV(sv); \
b37c2d43
AL
235 })
236# define SvREFCNT_inc_NN(sv) \
237 ({ \
b1bc3f34 238 SV * const _sv = MUTABLE_SV(sv); \
b37c2d43
AL
239 SvREFCNT(_sv)++; \
240 _sv; \
241 })
242# define SvREFCNT_inc_void(sv) \
243 ({ \
b1bc3f34 244 SV * const _sv = MUTABLE_SV(sv); \
b37c2d43
AL
245 if (_sv) \
246 (void)(SvREFCNT(_sv)++); \
247 })
8990e307 248#else
3db8f154 249# define SvREFCNT_inc(sv) \
b1bc3f34 250 ((PL_Sv=MUTABLE_SV(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
b37c2d43 251# define SvREFCNT_inc_simple(sv) \
b1bc3f34 252 ((sv) ? (SvREFCNT(sv)++,MUTABLE_SV(sv)) : NULL)
b37c2d43 253# define SvREFCNT_inc_NN(sv) \
b1bc3f34 254 (PL_Sv=MUTABLE_SV(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
b37c2d43 255# define SvREFCNT_inc_void(sv) \
b1bc3f34 256 (void)((PL_Sv=MUTABLE_SV(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
8990e307
LW
257#endif
258
b37c2d43 259/* These guys don't need the curly blocks */
e638c624 260#define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
b1bc3f34
NC
261#define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
262#define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
263#define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
b37c2d43 264
7fe44985 265#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
8c4d3c90
NC
266# define SvREFCNT_dec(sv) \
267 ({ \
b1bc3f34 268 SV * const _sv = MUTABLE_SV(sv); \
3de3296f
AE
269 if (_sv) { \
270 if (SvREFCNT(_sv)) { \
271 if (--(SvREFCNT(_sv)) == 0) \
272 Perl_sv_free2(aTHX_ _sv); \
8c4d3c90 273 } else { \
3de3296f 274 sv_free(_sv); \
8c4d3c90
NC
275 } \
276 } \
277 })
278#else
b1bc3f34 279#define SvREFCNT_dec(sv) sv_free(MUTABLE_SV(sv))
8c4d3c90 280#endif
a863c7d1 281
8990e307 282#define SVTYPEMASK 0xff
1fef4616 283#define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
79072805 284
0565a181
NC
285/* Sadly there are some parts of the core that have pointers to already-freed
286 SV heads, and rely on being able to tell that they are now free. So mark
287 them all by using a consistent macro. */
288#define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
289
63f97190 290#define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
79072805 291
3f7ef1d4
NC
292#define SVf_IOK 0x00000100 /* has valid public integer value */
293#define SVf_NOK 0x00000200 /* has valid public numeric value */
294#define SVf_POK 0x00000400 /* has valid public pointer value */
295#define SVf_ROK 0x00000800 /* has a valid reference pointer */
296
297#define SVp_IOK 0x00001000 /* has valid non-public integer value */
298#define SVp_NOK 0x00002000 /* has valid non-public numeric value */
299#define SVp_POK 0x00004000 /* has valid non-public pointer value */
300#define SVp_SCREAM 0x00008000 /* has been studied? */
2e5b91de
NC
301#define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
302#define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
1ccdb730
NC
303#define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
304 subroutine in another package. Set the
305 CvIMPORTED_CV_ON() if it needs to be
306 expanded to a real GV */
3f7ef1d4
NC
307
308#define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
309#define SVpad_STATE 0x00010000 /* pad name is a "state" var */
310#define SVs_PADTMP 0x00020000 /* in use as tmp */
311#define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
312#define SVs_PADMY 0x00040000 /* in use a "my" variable */
313#define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
314#define SVs_TEMP 0x00080000 /* string is stealable? */
315#define SVs_OBJECT 0x00100000 /* is "blessed" */
316#define SVs_GMG 0x00200000 /* has magical get method */
317#define SVs_SMG 0x00400000 /* has magical set method */
318#define SVs_RMG 0x00800000 /* has random magical methods */
319
320#define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
321 1: SV head arena wasn't malloc()ed
322 2: in conjunction with SVf_READONLY
323 marks a shared hash key scalar
324 (SvLEN == 0) or a copy on write
325 string (SvLEN != 0) [SvIsCOW(sv)]
326 3: For PVCV, whether CvUNIQUE(cv)
327 refers to an eval or once only
328 [CvEVAL(cv), CvSPECIAL(cv)]
86d2c25d 329 4: On a pad name SV, that slot in the
3f7ef1d4
NC
330 frame AV is a REFCNT'ed reference
331 to a lexical from "outside". */
86d2c25d 332#define SVphv_REHASH SVf_FAKE /* 5: On a PVHV, hash values are being
3f7ef1d4
NC
333 recalculated */
334#define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
335 means that a hv_aux struct is present
336 after the main array */
337#define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
36c662f4
NC
338 SVs in final arena cleanup.
339 Set in S_regtry on PL_reg_curpm, so that
340 perl_destruct will skip it. */
3f7ef1d4 341#define SVf_READONLY 0x08000000 /* may not be modified */
8990e307 342
a0d0e21e 343
8990e307 344
5bc28da9 345
430eacda 346#define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
5bc28da9 347
a0d0e21e 348#define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
2e5b91de 349 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
a0d0e21e 350
7a77f1af 351#define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
8990e307 352
cd028baa 353#define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
2e9f07a2
NC
354
355/* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
cd028baa
NC
356#define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
357 This is also set on RVs whose overloaded
358 stringification is UTF-8. This might
359 only happen as a side effect of SvPV() */
360
26a32e18 361
8990e307
LW
362/* Some private flags. */
363
2e9f07a2
NC
364/* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
365 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
366 been restructured, so sometimes get used as string buffers. */
367
26a32e18 368/* PVHV */
3f7ef1d4 369#define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
a72e56b0 370/* PVNV, PVMG, presumably only inside pads */
3f7ef1d4
NC
371#define SVpad_NAME 0x40000000 /* This SV is a name in the PAD, so
372 SVpad_TYPED, SVpad_OUR and SVpad_STATE
373 apply */
26a32e18 374/* PVAV */
3f7ef1d4 375#define SVpav_REAL 0x40000000 /* free old entries */
26a32e18 376/* PVHV */
3f7ef1d4 377#define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
69d97907
NC
378/* This is only set true on a PVGV when it's playing "PVBM", but is tested for
379 on any regular scalar (anything <= PVLV) */
5fe1b2e4 380#define SVpbm_VALID 0x40000000
26a32e18 381/* ??? */
3f7ef1d4 382#define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
25da4f38 383
26a32e18
NC
384/* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
385/* Presumably IVs aren't stored in pads */
3f7ef1d4 386#define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
26a32e18 387/* PVAV */
3f7ef1d4 388#define SVpav_REIFY 0x80000000 /* can become real */
26a32e18 389/* PVHV */
3f7ef1d4 390#define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
26a32e18 391/* PVFM */
3f7ef1d4 392#define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
cecf5685 393/* PVGV when SVpbm_VALID is true */
5fe1b2e4 394#define SVpbm_TAIL 0x80000000
26a32e18 395/* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
3f7ef1d4 396#define SVprv_WEAKREF 0x80000000 /* Weak reference */
810b8aa5 397
6e128786
NC
398#define _XPV_HEAD \
399 HV* xmg_stash; /* class package */ \
400 union _xmgu xmg_u; \
c8e503bf
NC
401 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
402 STRLEN xpv_len /* allocated size */
20f4945e
MHM
403
404union _xnvu {
405 NV xnv_nv; /* numeric value, if any */
406 HV * xgv_stash;
407 struct {
408 U32 xlow;
409 U32 xhigh;
410 } xpad_cop_seq; /* used by pad.c for cop_sequence */
411 struct {
412 U32 xbm_previous; /* how many characters in string before rare? */
413 U8 xbm_flags;
414 U8 xbm_rare; /* rarest character in string */
415 } xbm_s; /* fields from PVBM */
416};
417
418union _xivu {
419 IV xivu_iv; /* integer value */
20f4945e 420 UV xivu_uv;
c4648999 421 I32 xivu_i32; /* BmUSEFUL */
20f4945e
MHM
422 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
423};
424
425union _xmgu {
426 MAGIC* xmg_magic; /* linked list of magicalness */
427 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
428};
11ca45c0 429
79072805 430struct xpv {
20f4945e 431 _XPV_HEAD;
79072805
LW
432};
433
434struct xpviv {
20f4945e
MHM
435 _XPV_HEAD;
436 union _xivu xiv_u;
79072805
LW
437};
438
311a25d9
NC
439#define xiv_iv xiv_u.xivu_iv
440
ff68c719 441struct xpvuv {
20f4945e
MHM
442 _XPV_HEAD;
443 union _xivu xuv_u;
ff68c719
PP
444};
445
20f4945e 446#define xuv_uv xuv_u.xivu_uv
311a25d9 447
79072805 448struct xpvnv {
20f4945e
MHM
449 _XPV_HEAD;
450 union _xivu xiv_u;
6e128786 451 union _xnvu xnv_u;
79072805
LW
452};
453
3cd3be43 454/* This structure must match the beginning of struct xpvhv in hv.h. */
79072805 455struct xpvmg {
20f4945e 456 _XPV_HEAD;
6e128786
NC
457 union _xivu xiv_u;
458 union _xnvu xnv_u;
79072805
LW
459};
460
461struct xpvlv {
20f4945e 462 _XPV_HEAD;
6e128786
NC
463 union _xivu xiv_u;
464 union _xnvu xnv_u;
79072805
LW
465 STRLEN xlv_targoff;
466 STRLEN xlv_targlen;
467 SV* xlv_targ;
dd28f7bb
DM
468 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
469 * y=alem/helem/iter t=tie T=tied HE */
79072805
LW
470};
471
cecf5685
NC
472/* This structure works in 3 ways - regular scalar, GV with GP, or fast
473 Boyer-Moore. */
79072805 474struct xpvgv {
20f4945e 475 _XPV_HEAD;
6e128786
NC
476 union _xivu xiv_u;
477 union _xnvu xnv_u;
79072805
LW
478};
479
fd40b977 480/* This structure must match XPVCV in cv.h */
44a8e56a 481
77a005ab
MB
482typedef U16 cv_flags_t;
483
20f4945e
MHM
484#define _XPVCV_COMMON \
485 HV * xcv_stash; \
486 union { \
487 OP * xcv_start; \
488 ANY xcv_xsubany; \
489 } xcv_start_u; \
490 union { \
491 OP * xcv_root; \
492 void (*xcv_xsub) (pTHX_ CV*); \
493 } xcv_root_u; \
494 GV * xcv_gv; \
495 char * xcv_file; \
496 AV * xcv_padlist; \
497 CV * xcv_outside; \
498 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
499 * compilation) in the lexically enclosing \
500 * sub */ \
501 cv_flags_t xcv_flags
8990e307 502
20f4945e
MHM
503struct xpvfm {
504 _XPV_HEAD;
20f4945e 505 _XPVCV_COMMON;
c4648999 506 IV xfm_lines;
79072805
LW
507};
508
167f2c4d 509
8990e307 510struct xpvio {
20f4945e 511 _XPV_HEAD;
6e128786 512 union _xivu xiv_u;
6f7e8353
NC
513 /* ifp and ofp are normally the same, but sockets need separate streams */
514 PerlIO * xio_ofp;
c951e2ad
NC
515 /* Cray addresses everything by word boundaries (64 bits) and
516 * code and data pointers cannot be mixed (which is exactly what
517 * Perl_filter_add() tries to do with the dirp), hence the
518 * following union trick (as suggested by Gurusamy Sarathy).
519 * For further information see Geir Johansen's problem report
520 * titled [ID 20000612.002] Perl problem on Cray system
521 * The any pointer (known as IoANY()) will also be a good place
522 * to hang any IO disciplines to.
523 */
524 union {
525 DIR * xiou_dirp; /* for opendir, readdir, etc */
526 void * xiou_any; /* for alignment */
527 } xio_dirpu;
528 /* IV xio_lines is now in IVX $. */
529 IV xio_page; /* $% */
530 IV xio_page_len; /* $= */
531 IV xio_lines_left; /* $- */
532 char * xio_top_name; /* $^ */
533 GV * xio_top_gv; /* $^ */
534 char * xio_fmt_name; /* $~ */
535 GV * xio_fmt_gv; /* $~ */
536 char * xio_bottom_name;/* $^B */
537 GV * xio_bottom_gv; /* $^B */
538 char xio_type;
539 U8 xio_flags;
8990e307 540};
167f2c4d 541
4755096e
GS
542#define xio_dirp xio_dirpu.xiou_dirp
543#define xio_any xio_dirpu.xiou_any
8990e307 544
e0c19803
GS
545#define IOf_ARGV 1 /* this fp iterates over ARGV */
546#define IOf_START 2 /* check for null ARGV and substitute '-' */
547#define IOf_FLUSH 4 /* this fp wants a flush after write op */
548#define IOf_DIDTOP 8 /* just did top of form */
549#define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
550#define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
5bb89d25
NC
551#define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
552 Also, when this is set, SvPVX() is valid */
8990e307 553
ed6116ce
LW
554/* The following macros define implementation-independent predicates on SVs. */
555
954c1994 556/*
fbf9f983
RGS
557=for apidoc Am|U32|SvNIOK|SV* sv
558Returns a U32 value indicating whether the SV contains a number, integer or
954c1994
GS
559double.
560
fbf9f983
RGS
561=for apidoc Am|U32|SvNIOKp|SV* sv
562Returns a U32 value indicating whether the SV contains a number, integer or
fe749c9a 563double. Checks the B<private> setting. Use C<SvNIOK> instead.
954c1994
GS
564
565=for apidoc Am|void|SvNIOK_off|SV* sv
566Unsets the NV/IV status of an SV.
567
fbf9f983 568=for apidoc Am|U32|SvOK|SV* sv
c0b6140e
SM
569Returns a U32 value indicating whether the value is defined. This is
570only meaningful for scalars.
954c1994 571
fbf9f983
RGS
572=for apidoc Am|U32|SvIOKp|SV* sv
573Returns a U32 value indicating whether the SV contains an integer. Checks
fe749c9a 574the B<private> setting. Use C<SvIOK> instead.
954c1994 575
fbf9f983
RGS
576=for apidoc Am|U32|SvNOKp|SV* sv
577Returns a U32 value indicating whether the SV contains a double. Checks the
fe749c9a 578B<private> setting. Use C<SvNOK> instead.
954c1994 579
fbf9f983
RGS
580=for apidoc Am|U32|SvPOKp|SV* sv
581Returns a U32 value indicating whether the SV contains a character string.
fe749c9a 582Checks the B<private> setting. Use C<SvPOK> instead.
954c1994 583
fbf9f983
RGS
584=for apidoc Am|U32|SvIOK|SV* sv
585Returns a U32 value indicating whether the SV contains an integer.
954c1994
GS
586
587=for apidoc Am|void|SvIOK_on|SV* sv
588Tells an SV that it is an integer.
589
590=for apidoc Am|void|SvIOK_off|SV* sv
591Unsets the IV status of an SV.
592
593=for apidoc Am|void|SvIOK_only|SV* sv
594Tells an SV that it is an integer and disables all other OK bits.
595
e331fc52
JH
596=for apidoc Am|void|SvIOK_only_UV|SV* sv
597Tells and SV that it is an unsigned integer and disables all other OK bits.
598
12fa07df 599=for apidoc Am|bool|SvIOK_UV|SV* sv
e331fc52
JH
600Returns a boolean indicating whether the SV contains an unsigned integer.
601
fbf9f983 602=for apidoc Am|bool|SvUOK|SV* sv
28e5dec8
JH
603Returns a boolean indicating whether the SV contains an unsigned integer.
604
12fa07df 605=for apidoc Am|bool|SvIOK_notUV|SV* sv
d1be9408 606Returns a boolean indicating whether the SV contains a signed integer.
e331fc52 607
fbf9f983
RGS
608=for apidoc Am|U32|SvNOK|SV* sv
609Returns a U32 value indicating whether the SV contains a double.
954c1994
GS
610
611=for apidoc Am|void|SvNOK_on|SV* sv
612Tells an SV that it is a double.
613
614=for apidoc Am|void|SvNOK_off|SV* sv
615Unsets the NV status of an SV.
616
617=for apidoc Am|void|SvNOK_only|SV* sv
618Tells an SV that it is a double and disables all other OK bits.
619
fbf9f983
RGS
620=for apidoc Am|U32|SvPOK|SV* sv
621Returns a U32 value indicating whether the SV contains a character
954c1994
GS
622string.
623
624=for apidoc Am|void|SvPOK_on|SV* sv
625Tells an SV that it is a string.
626
627=for apidoc Am|void|SvPOK_off|SV* sv
628Unsets the PV status of an SV.
629
630=for apidoc Am|void|SvPOK_only|SV* sv
631Tells an SV that it is a string and disables all other OK bits.
1e54db1a 632Will also turn off the UTF-8 status.
954c1994 633
b0f01acb
JP
634=for apidoc Am|bool|SvVOK|SV* sv
635Returns a boolean indicating whether the SV contains a v-string.
636
fbf9f983 637=for apidoc Am|U32|SvOOK|SV* sv
69240efd
NC
638Returns a U32 indicating whether the pointer to the string buffer is offset.
639This hack is used internally to speed up removal of characters from the
640beginning of a SvPV. When SvOOK is true, then the start of the
641allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
642This offset used to be stored in SvIVX, but is now stored within the spare
643part of the buffer.
954c1994 644
fbf9f983 645=for apidoc Am|U32|SvROK|SV* sv
954c1994
GS
646Tests if the SV is an RV.
647
648=for apidoc Am|void|SvROK_on|SV* sv
649Tells an SV that it is an RV.
650
651=for apidoc Am|void|SvROK_off|SV* sv
652Unsets the RV status of an SV.
653
654=for apidoc Am|SV*|SvRV|SV* sv
655Dereferences an RV to return the SV.
656
657=for apidoc Am|IV|SvIVX|SV* sv
645c22ef
DM
658Returns the raw value in the SV's IV slot, without checks or conversions.
659Only use when you are sure SvIOK is true. See also C<SvIV()>.
954c1994
GS
660
661=for apidoc Am|UV|SvUVX|SV* sv
645c22ef
DM
662Returns the raw value in the SV's UV slot, without checks or conversions.
663Only use when you are sure SvIOK is true. See also C<SvUV()>.
954c1994
GS
664
665=for apidoc Am|NV|SvNVX|SV* sv
645c22ef
DM
666Returns the raw value in the SV's NV slot, without checks or conversions.
667Only use when you are sure SvNOK is true. See also C<SvNV()>.
954c1994
GS
668
669=for apidoc Am|char*|SvPVX|SV* sv
645c22ef 670Returns a pointer to the physical string in the SV. The SV must contain a
954c1994
GS
671string.
672
673=for apidoc Am|STRLEN|SvCUR|SV* sv
674Returns the length of the string which is in the SV. See C<SvLEN>.
675
676=for apidoc Am|STRLEN|SvLEN|SV* sv
659239a4
MG
677Returns the size of the string buffer in the SV, not including any part
678attributable to C<SvOOK>. See C<SvCUR>.
954c1994
GS
679
680=for apidoc Am|char*|SvEND|SV* sv
681Returns a pointer to the last character in the string which is in the SV.
682See C<SvCUR>. Access the character as *(SvEND(sv)).
683
684=for apidoc Am|HV*|SvSTASH|SV* sv
685Returns the stash of the SV.
686
672994ce 687=for apidoc Am|void|SvIV_set|SV* sv|IV val
20799e15
SP
688Set the value of the IV pointer in sv to val. It is possible to perform
689the same function of this macro with an lvalue assignment to C<SvIVX>.
690With future Perls, however, it will be more efficient to use
691C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
672994ce
SP
692
693=for apidoc Am|void|SvNV_set|SV* sv|NV val
20799e15 694Set the value of the NV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
695
696=for apidoc Am|void|SvPV_set|SV* sv|char* val
20799e15 697Set the value of the PV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
698
699=for apidoc Am|void|SvUV_set|SV* sv|UV val
20799e15 700Set the value of the UV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
701
702=for apidoc Am|void|SvRV_set|SV* sv|SV* val
20799e15 703Set the value of the RV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
704
705=for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
20799e15 706Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
672994ce 707
b6f4de24 708=for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
20799e15 709Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
672994ce 710
954c1994 711=for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
20799e15
SP
712Set the current length of the string which is in the SV. See C<SvCUR>
713and C<SvIV_set>.
672994ce
SP
714
715=for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
20799e15 716Set the actual length of the string which is in the SV. See C<SvIV_set>.
954c1994
GS
717
718=cut
719*/
720
79072805 721#define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
748a9306 722#define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
a0d0e21e 723#define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
25da4f38 724 SVp_IOK|SVp_NOK|SVf_IVisUV))
79072805 725
5dc8bdac 726#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
29e97371 727#define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
f7877b28 728#define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
906ed6d6 729#else
54866b45 730#define assert_not_ROK(sv)
f7877b28 731#define assert_not_glob(sv)
906ed6d6
NC
732#endif
733
1cb9cd50
NC
734#define SvOK(sv) ((SvTYPE(sv) == SVt_BIND) \
735 ? (SvFLAGS(SvRV(sv)) & SVf_OK) \
736 : (SvFLAGS(sv) & SVf_OK))
f7877b28 737#define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
dd2eae66 738 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8 739 SVf_IVisUV|SVf_UTF8), \
25da4f38 740 SvOOK_off(sv))
54866b45 741#define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
dd2eae66 742 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8 743 SVf_UTF8), \
a0d0e21e 744 SvOOK_off(sv))
79072805 745
8990e307
LW
746#define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
747#define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
7a4bba22 748#define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
765f542d 749 SvFLAGS(sv) |= SVp_IOK)
8990e307 750#define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
f7877b28 751#define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
8990e307 752#define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
f7877b28 753#define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 754 SvFLAGS(sv) |= SVp_POK)
463ee0b2 755
79072805 756#define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
7a4bba22 757#define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
765f542d 758 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38 759#define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
0c34ef67 760#define SvIOK_only(sv) (SvOK_off(sv), \
a0d0e21e 761 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
f7877b28 762#define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
25da4f38 763 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
70401c6b 764
25da4f38
IZ
765#define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
766 == (SVf_IOK|SVf_IVisUV))
28e5dec8 767#define SvUOK(sv) SvIOK_UV(sv)
25da4f38
IZ
768#define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
769 == SVf_IOK)
770
771#define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
772#define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
773#define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
79072805
LW
774
775#define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
f7877b28
NC
776#define SvNOK_on(sv) (assert_not_glob(sv) \
777 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
8990e307 778#define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
0c34ef67 779#define SvNOK_only(sv) (SvOK_off(sv), \
a0d0e21e 780 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
79072805 781
914184e1 782/*
fbf9f983
RGS
783=for apidoc Am|U32|SvUTF8|SV* sv
784Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
cd028baa
NC
785Call this after SvPV() in case any call to string overloading updates the
786internal flag.
914184e1
JH
787
788=for apidoc Am|void|SvUTF8_on|SV *sv
1e54db1a 789Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
d5ce4a7c 790Do not use frivolously.
914184e1
JH
791
792=for apidoc Am|void|SvUTF8_off|SV *sv
1e54db1a 793Unsets the UTF-8 status of an SV.
914184e1
JH
794
795=for apidoc Am|void|SvPOK_only_UTF8|SV* sv
d5ce4a7c 796Tells an SV that it is a string and disables all other OK bits,
1e54db1a 797and leaves the UTF-8 status as it was.
f1a1024e 798
914184e1
JH
799=cut
800 */
801
7a5fd60d
NC
802/* Ensure the return value of this macro does not clash with the GV_ADD* flags
803in gv.h: */
a7cb1f99
GS
804#define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
805#define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
806#define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
5bc28da9 807
79072805 808#define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
f7877b28 809#define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 810 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
8990e307 811#define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
f7877b28 812#define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
dd2eae66 813 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8
GS
814 SVf_IVisUV|SVf_UTF8), \
815 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
f7877b28 816#define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
dd2eae66 817 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8 818 SVf_IVisUV), \
a0d0e21e 819 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
79072805 820
4f2da183 821#define SvVOK(sv) (SvMAGICAL(sv) \
b0a11fe1
RGS
822 && mg_find(sv,PERL_MAGIC_vstring))
823/* returns the vstring magic, if any */
824#define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
4f2da183 825 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
b0a11fe1 826
79072805 827#define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
155aba94 828#define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
0c34ef67 829#define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
79072805 830
a0d0e21e
LW
831#define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
832#define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
833#define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
834
ed6116ce 835#define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
a0d0e21e 836#define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
dd2eae66 837#define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
79072805 838
8990e307
LW
839#define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
840#define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
841#define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
79072805 842
8990e307
LW
843#define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
844#define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
845#define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
ed6116ce 846
8990e307
LW
847#define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
848#define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
849#define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
ed6116ce 850
8990e307
LW
851#define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
852#define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
853#define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
ed6116ce 854
dd2eae66
NC
855#define SvAMAGIC(sv) (SvROK(sv) && (SvFLAGS(SvRV(sv)) & SVf_AMAGIC))
856#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
d4c19fe8 857# define SvAMAGIC_on(sv) ({ SV * const kloink = sv; \
dd2eae66
NC
858 assert(SvROK(kloink)); \
859 SvFLAGS(SvRV(kloink)) |= SVf_AMAGIC; \
860 })
d4c19fe8 861# define SvAMAGIC_off(sv) ({ SV * const kloink = sv; \
dd2eae66
NC
862 if(SvROK(kloink)) \
863 SvFLAGS(SvRV(kloink)) &= ~SVf_AMAGIC;\
864 })
865#else
866# define SvAMAGIC_on(sv) (SvFLAGS(SvRV(sv)) |= SVf_AMAGIC)
ce046328
NC
867# define SvAMAGIC_off(sv) \
868 (SvROK(sv) && (SvFLAGS(SvRV(sv)) &= ~SVf_AMAGIC))
dd2eae66 869#endif
a0d0e21e 870
d34786ba 871/*
458b44e7 872=for apidoc Am|U32|SvGAMAGIC|SV* sv
d34786ba
NC
873
874Returns true if the SV has get magic or overloading. If either is true then
875the scalar is active data, and has the potential to return a new value every
876time it is accessed. Hence you must be careful to only read it once per user
877logical operation and work with that returned value. If neither is true then
878the scalar's value cannot change unless written to.
879
880=cut
881*/
882
dd2eae66 883#define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1426bbf4 884
242f8760 885#define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash, FALSE))
a0d0e21e 886
810b8aa5
GS
887#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
888 == (SVf_ROK|SVprv_WEAKREF))
889#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
890#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
891
1ccdb730
NC
892#define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
893 == (SVf_ROK|SVprv_PCS_IMPORTED))
894#define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
895#define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
896
a0d0e21e 897#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 898
d9d18af6
DM
899#define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
900#define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
901#define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
902
8990e307 903#define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
235cc2e3 904#define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
8990e307 905#define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
ed6116ce 906
8990e307 907#define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
235cc2e3 908#define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
ed6116ce 909
8990e307
LW
910#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
911#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
912#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 913
8990e307
LW
914#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
915#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
916#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 917
8990e307
LW
918#define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
919#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
920#define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
79072805 921
180488f8 922#define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
8990e307
LW
923#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
924#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 925
8990e307
LW
926#define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
927#define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
928#define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
79072805 929
25da4f38
IZ
930#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
931#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
932#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
933
85efc3a5 934#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
e9726144 935# define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
e5ae200f
RU
936 if (SvFLAGS(_svvalid) & SVpbm_VALID) \
937 assert(!isGV_with_GP(_svvalid)); \
938 (SvFLAGS(_svvalid) & SVpbm_VALID); \
85ffbbb0 939 })
b1bc3f34 940# define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
e5ae200f
RU
941 assert(!isGV_with_GP(_svvalid)); \
942 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
85ffbbb0 943 })
b1bc3f34 944# define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
e5ae200f
RU
945 assert(!isGV_with_GP(_svvalid)); \
946 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
85ffbbb0
NC
947 })
948
e9726144 949# define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
e5ae200f
RU
950 assert(SvTYPE(_svtail) != SVt_PVAV); \
951 assert(SvTYPE(_svtail) != SVt_PVHV); \
78d0cf80
NC
952 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
953 == (SVpbm_TAIL|SVpbm_VALID); \
85efc3a5
NC
954 })
955#else
85ffbbb0
NC
956# define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
957# define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
958# define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
78d0cf80 959# define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
fe901688 960 == (SVpbm_TAIL|SVpbm_VALID))
78d0cf80 961
85efc3a5 962#endif
8990e307
LW
963#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
964#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
965
8990e307 966
075bae1e
NC
967#define SvPAD_TYPED(sv) \
968 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
00b1698f 969
075bae1e
NC
970#define SvPAD_OUR(sv) \
971 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
00b1698f 972
952306ac
RGS
973#define SvPAD_STATE(sv) \
974 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
a72e56b0
NC
975
976#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
977# define SvPAD_TYPED_on(sv) ({ \
b1bc3f34 978 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
979 assert(SvTYPE(_svpad) == SVt_PVMG); \
980 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \
a72e56b0
NC
981 })
982#define SvPAD_OUR_on(sv) ({ \
b1bc3f34 983 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
984 assert(SvTYPE(_svpad) == SVt_PVMG); \
985 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \
a72e56b0
NC
986 })
987#define SvPAD_STATE_on(sv) ({ \
b1bc3f34 988 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
989 assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
990 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \
a72e56b0
NC
991 })
992#else
993# define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
994# define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
995# define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
996#endif
952306ac 997
73d95100 998#define SvOURSTASH(sv) \
e736a858 999 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
73d95100 1000#define SvOURSTASH_set(sv, st) \
e736a858 1001 STMT_START { \
2892acdb 1002 assert(SvTYPE(sv) == SVt_PVMG); \
e736a858 1003 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
035dab74
NC
1004 } STMT_END
1005
b162af07 1006#ifdef PERL_DEBUG_COW
b162af07 1007#else
b162af07 1008#endif
ed6116ce
LW
1009#define SvRVx(sv) SvRV(sv)
1010
f599b64b 1011#ifdef PERL_DEBUG_COW
8ed30cc1
DD
1012/* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1013 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
771ba71a
NC
1014# define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1015# define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
58430790 1016# define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
ac09da3b 1017# define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
f19a12a3 1018# define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
c0e1089a 1019/* Don't test the core XS code yet. */
771ba71a
NC
1020# if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1021# define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1022# else
1023# define SvPVX(sv) SvPVX_mutable(sv)
1024# endif
771ba71a
NC
1025# define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1026# define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1027# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1028
1029# ifdef DEBUGGING
064cf529
NC
1030# define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1031# define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
03687789 1032# else
064cf529
NC
1033# define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1034# define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
03687789 1035# endif
f599b64b 1036#else
771ba71a
NC
1037# define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1038# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1039
05ef5f8f
NC
1040# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1041/* These get expanded inside other macros that already use a variable _sv */
f7877b28 1042# define SvPVX(sv) \
d2c6dc5e 1043 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
e5ae200f
RU
1044 assert(SvTYPE(_svpvx) >= SVt_PV); \
1045 assert(SvTYPE(_svpvx) != SVt_PVAV); \
1046 assert(SvTYPE(_svpvx) != SVt_PVHV); \
1047 assert(!isGV_with_GP(_svpvx)); \
5bb89d25
NC
1048 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1049 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
e5ae200f 1050 &((_svpvx)->sv_u.svu_pv); \
f7877b28 1051 }))
08002bbf 1052# define SvCUR(sv) \
b1bc3f34 1053 (*({ const SV *const _svcur = (const SV *)(sv); \
e5ae200f
RU
1054 assert(SvTYPE(_svcur) >= SVt_PV); \
1055 assert(SvTYPE(_svcur) != SVt_PVAV); \
1056 assert(SvTYPE(_svcur) != SVt_PVHV); \
1057 assert(!isGV_with_GP(_svcur)); \
6f7e8353
NC
1058 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1059 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
b1bc3f34 1060 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
08002bbf 1061 }))
05ef5f8f 1062# define SvIVX(sv) \
b1bc3f34 1063 (*({ const SV *const _svivx = (const SV *)(sv); \
e5ae200f
RU
1064 assert(SvTYPE(_svivx) == SVt_IV || SvTYPE(_svivx) >= SVt_PVIV); \
1065 assert(SvTYPE(_svivx) != SVt_PVAV); \
1066 assert(SvTYPE(_svivx) != SVt_PVHV); \
1067 assert(SvTYPE(_svivx) != SVt_PVCV); \
30ec677d 1068 assert(SvTYPE(_svivx) != SVt_PVFM); \
3cf51070 1069 assert(SvTYPE(_svivx) != SVt_PVIO); \
e77da3b2 1070 assert(SvTYPE(_svivx) != SVt_REGEXP); \
e5ae200f 1071 assert(!isGV_with_GP(_svivx)); \
b1bc3f34 1072 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
05ef5f8f
NC
1073 }))
1074# define SvUVX(sv) \
b1bc3f34 1075 (*({ const SV *const _svuvx = (const SV *)(sv); \
e5ae200f
RU
1076 assert(SvTYPE(_svuvx) == SVt_IV || SvTYPE(_svuvx) >= SVt_PVIV); \
1077 assert(SvTYPE(_svuvx) != SVt_PVAV); \
1078 assert(SvTYPE(_svuvx) != SVt_PVHV); \
1079 assert(SvTYPE(_svuvx) != SVt_PVCV); \
30ec677d 1080 assert(SvTYPE(_svuvx) != SVt_PVFM); \
3cf51070 1081 assert(SvTYPE(_svuvx) != SVt_PVIO); \
e77da3b2 1082 assert(SvTYPE(_svuvx) != SVt_REGEXP); \
e5ae200f 1083 assert(!isGV_with_GP(_svuvx)); \
b1bc3f34 1084 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
05ef5f8f
NC
1085 }))
1086# define SvNVX(sv) \
b1bc3f34 1087 (*({ const SV *const _svnvx = (const SV *)(sv); \
e5ae200f
RU
1088 assert(SvTYPE(_svnvx) == SVt_NV || SvTYPE(_svnvx) >= SVt_PVNV); \
1089 assert(SvTYPE(_svnvx) != SVt_PVAV); \
1090 assert(SvTYPE(_svnvx) != SVt_PVHV); \
1091 assert(SvTYPE(_svnvx) != SVt_PVCV); \
1092 assert(SvTYPE(_svnvx) != SVt_PVFM); \
1093 assert(SvTYPE(_svnvx) != SVt_PVIO); \
e77da3b2 1094 assert(SvTYPE(_svnvx) != SVt_REGEXP); \
e5ae200f 1095 assert(!isGV_with_GP(_svnvx)); \
b1bc3f34 1096 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
05ef5f8f 1097 }))
ac09da3b 1098# define SvRV(sv) \
f19a12a3 1099 (*({ SV *const _svrv = MUTABLE_SV(sv); \
e5ae200f
RU
1100 assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1101 assert(SvTYPE(_svrv) != SVt_PVAV); \
1102 assert(SvTYPE(_svrv) != SVt_PVHV); \
1103 assert(SvTYPE(_svrv) != SVt_PVCV); \
1104 assert(SvTYPE(_svrv) != SVt_PVFM); \
1105 assert(!isGV_with_GP(_svrv)); \
6f7e8353
NC
1106 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1107 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
e5ae200f 1108 &((_svrv)->sv_u.svu_rv); \
ac09da3b 1109 }))
f19a12a3
MHM
1110# define SvRV_const(sv) \
1111 ({ const SV *const _svrv = (const SV *)(sv); \
1112 assert(SvTYPE(_svrv) >= SVt_PV || SvTYPE(_svrv) == SVt_IV); \
1113 assert(SvTYPE(_svrv) != SVt_PVAV); \
1114 assert(SvTYPE(_svrv) != SVt_PVHV); \
1115 assert(SvTYPE(_svrv) != SVt_PVCV); \
1116 assert(SvTYPE(_svrv) != SVt_PVFM); \
1117 assert(!isGV_with_GP(_svrv)); \
6f7e8353
NC
1118 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1119 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
f19a12a3
MHM
1120 (_svrv)->sv_u.svu_rv; \
1121 })
05ef5f8f 1122# define SvMAGIC(sv) \
b1bc3f34 1123 (*({ const SV *const _svmagic = (const SV *)(sv); \
e5ae200f
RU
1124 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1125 if(SvTYPE(_svmagic) == SVt_PVMG) \
1126 assert(!SvPAD_OUR(_svmagic)); \
b1bc3f34 1127 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
05ef5f8f
NC
1128 }))
1129# define SvSTASH(sv) \
b1bc3f34 1130 (*({ const SV *const _svstash = (const SV *)(sv); \
e5ae200f 1131 assert(SvTYPE(_svstash) >= SVt_PVMG); \
b1bc3f34 1132 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
05ef5f8f 1133 }))
03687789 1134# else
08002bbf
NC
1135# define SvPVX(sv) ((sv)->sv_u.svu_pv)
1136# define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
05ef5f8f
NC
1137# define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1138# define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
58430790 1139# define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
ac09da3b 1140# define SvRV(sv) ((sv)->sv_u.svu_rv)
f19a12a3 1141# define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
e736a858 1142# define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
771ba71a 1143# define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
03687789 1144# endif
62703e72
NC
1145#endif
1146
06c0cc96 1147#ifndef PERL_POISON
bb496845
SP
1148/* Given that these two are new, there can't be any existing code using them
1149 * as LVALUEs */
06c0cc96
NC
1150# define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1151# define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1152#else
1153/* Except for the poison code, which uses & to scribble over the pointer after
1154 free() is called. */
1155# define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1156# define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1157#endif
bb496845 1158
62703e72
NC
1159#define SvIVXx(sv) SvIVX(sv)
1160#define SvUVXx(sv) SvUVX(sv)
1161#define SvNVXx(sv) SvNVX(sv)
1162#define SvPVXx(sv) SvPVX(sv)
1163#define SvLENx(sv) SvLEN(sv)
1164#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1165
1166
28e5dec8
JH
1167/* Ask a scalar nicely to try to become an IV, if possible.
1168 Not guaranteed to stay returning void */
1169/* Macro won't actually call sv_2iv if already IOK */
1170#define SvIV_please(sv) \
1171 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1172 (void) SvIV(sv); } STMT_END
6f1401dc
DM
1173#define SvIV_please_nomg(sv) \
1174 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1175 (void) SvIV_nomg(sv); } STMT_END
79072805 1176#define SvIV_set(sv, val) \
80b92232 1177 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
a0905512
NC
1178 assert(SvTYPE(sv) != SVt_PVAV); \
1179 assert(SvTYPE(sv) != SVt_PVHV); \
1180 assert(SvTYPE(sv) != SVt_PVCV); \
08002bbf 1181 assert(!isGV_with_GP(sv)); \
b19bbeda 1182 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
79072805 1183#define SvNV_set(sv, val) \
80b92232 1184 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
7ffec4a4 1185 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
a0905512 1186 assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
167f2c4d 1187 assert(SvTYPE(sv) != SVt_PVIO); \
08002bbf 1188 assert(!isGV_with_GP(sv)); \
58430790 1189 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
79072805 1190#define SvPV_set(sv, val) \
80b92232 1191 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
9c6bc640 1192 assert(SvTYPE(sv) != SVt_PVAV); \
797c7171 1193 assert(SvTYPE(sv) != SVt_PVHV); \
08002bbf 1194 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1195 assert(!(SvTYPE(sv) == SVt_PVIO \
1196 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
339049b0 1197 ((sv)->sv_u.svu_pv = (val)); } STMT_END
607fa7f2
SP
1198#define SvUV_set(sv, val) \
1199 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
a0905512
NC
1200 assert(SvTYPE(sv) != SVt_PVAV); \
1201 assert(SvTYPE(sv) != SVt_PVHV); \
1202 assert(SvTYPE(sv) != SVt_PVCV); \
08002bbf 1203 assert(!isGV_with_GP(sv)); \
607fa7f2 1204 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
b162af07 1205#define SvRV_set(sv, val) \
4df7f6af 1206 STMT_START { assert(SvTYPE(sv) >= SVt_PV || SvTYPE(sv) == SVt_IV); \
ac09da3b
NC
1207 assert(SvTYPE(sv) != SVt_PVAV); \
1208 assert(SvTYPE(sv) != SVt_PVHV); \
1209 assert(SvTYPE(sv) != SVt_PVCV); \
1210 assert(SvTYPE(sv) != SVt_PVFM); \
08002bbf 1211 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1212 assert(!(SvTYPE(sv) == SVt_PVIO \
1213 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
339049b0 1214 ((sv)->sv_u.svu_rv = (val)); } STMT_END
b162af07
SP
1215#define SvMAGIC_set(sv, val) \
1216 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
e736a858 1217 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
b162af07
SP
1218#define SvSTASH_set(sv, val) \
1219 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1220 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
79072805 1221#define SvCUR_set(sv, val) \
80b92232 1222 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
a0905512
NC
1223 assert(SvTYPE(sv) != SVt_PVAV); \
1224 assert(SvTYPE(sv) != SVt_PVHV); \
08002bbf 1225 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1226 assert(!(SvTYPE(sv) == SVt_PVIO \
1227 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
b162af07 1228 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
79072805 1229#define SvLEN_set(sv, val) \
80b92232 1230 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
a0905512
NC
1231 assert(SvTYPE(sv) != SVt_PVAV); \
1232 assert(SvTYPE(sv) != SVt_PVHV); \
f7877b28 1233 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1234 assert(!(SvTYPE(sv) == SVt_PVIO \
1235 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
b162af07 1236 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
7ae8ee9e
NC
1237#define SvEND_set(sv, val) \
1238 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
3ec35e0f 1239 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
79072805 1240
b7e9a5c2 1241#define SvPV_renew(sv,n) \
1da4ca5f
NC
1242 STMT_START { SvLEN_set(sv, n); \
1243 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1244 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1245 (MEM_SIZE)((n))))); \
1246 } STMT_END
1247
1248#define SvPV_shrink_to_cur(sv) STMT_START { \
1249 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1250 SvPV_renew(sv, _lEnGtH); \
1251 } STMT_END
b7e9a5c2 1252
771ba71a
NC
1253#define SvPV_free(sv) \
1254 STMT_START { \
1255 assert(SvTYPE(sv) >= SVt_PV); \
1256 if (SvLEN(sv)) { \
e537ac38 1257 assert(!SvROK(sv)); \
771ba71a 1258 if(SvOOK(sv)) { \
69240efd
NC
1259 STRLEN zok; \
1260 SvOOK_offset(sv, zok); \
1261 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
771ba71a
NC
1262 SvFLAGS(sv) &= ~SVf_OOK; \
1263 } \
1264 Safefree(SvPVX(sv)); \
1265 } \
1266 } STMT_END
8bd4d4c5 1267
43230e26
NC
1268#ifdef PERL_CORE
1269/* Code that crops up in three places to take a scalar and ready it to hold
1270 a reference */
1271# define prepare_SV_for_RV(sv) \
1272 STMT_START { \
1273 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1274 sv_upgrade(sv, SVt_IV); \
662f1f9e 1275 else if (SvTYPE(sv) >= SVt_PV) { \
43230e26
NC
1276 SvPV_free(sv); \
1277 SvLEN_set(sv, 0); \
1278 SvCUR_set(sv, 0); \
1279 } \
1280 } STMT_END
1281#endif
373b357f 1282
8eeaf79a 1283#define PERL_FBM_TABLE_OFFSET 1 /* Number of bytes between EOS and table */
373b357f
NC
1284
1285/* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1286 perl -T -e '/$^X/'
1287*/
60c8298a 1288#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
8eeaf79a 1289# define BmFLAGS(sv) \
b1bc3f34 1290 (*({ SV *const _bmflags = MUTABLE_SV(sv); \
e5ae200f
RU
1291 assert(SvTYPE(_bmflags) == SVt_PVGV); \
1292 assert(SvVALID(_bmflags)); \
1293 &(((XPVGV*) SvANY(_bmflags))->xnv_u.xbm_s.xbm_flags); \
8eeaf79a 1294 }))
60c8298a 1295# define BmRARE(sv) \
b1bc3f34 1296 (*({ SV *const _bmrare = MUTABLE_SV(sv); \
e5ae200f
RU
1297 assert(SvTYPE(_bmrare) == SVt_PVGV); \
1298 assert(SvVALID(_bmrare)); \
1299 &(((XPVGV*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare); \
60c8298a
NC
1300 }))
1301# define BmUSEFUL(sv) \
b1bc3f34 1302 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
e5ae200f
RU
1303 assert(SvTYPE(_bmuseful) == SVt_PVGV); \
1304 assert(SvVALID(_bmuseful)); \
1305 assert(!SvIOK(_bmuseful)); \
1306 &(((XPVGV*) SvANY(_bmuseful))->xiv_u.xivu_i32); \
60c8298a
NC
1307 }))
1308# define BmPREVIOUS(sv) \
b1bc3f34 1309 (*({ SV *const _bmprevious = MUTABLE_SV(sv); \
e5ae200f
RU
1310 assert(SvTYPE(_bmprevious) == SVt_PVGV); \
1311 assert(SvVALID(_bmprevious)); \
1312 &(((XPVGV*) SvANY(_bmprevious))->xnv_u.xbm_s.xbm_previous); \
8eeaf79a 1313 }))
60c8298a 1314#else
8eeaf79a
NC
1315# define BmFLAGS(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_flags
1316# define BmRARE(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1317# define BmUSEFUL(sv) ((XPVGV*) SvANY(sv))->xiv_u.xivu_i32
1318# define BmPREVIOUS(sv) ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_previous
b4f6c04b 1319
60c8298a 1320#endif
79072805 1321
c4648999 1322#define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
79072805
LW
1323
1324#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1325#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1326#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1327#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1328
6f7e8353 1329#define IoIFP(sv) (sv)->sv_u.svu_fp
8990e307
LW
1330#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1331#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
4755096e 1332#define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
c490b21c 1333#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
8990e307
LW
1334#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1335#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1336#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1337#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1338#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1339#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1340#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1341#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1342#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
8990e307
LW
1343#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1344#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1345
50952442 1346/* IoTYPE(sv) is a single character telling the type of I/O connection. */
3b6c1aba
JH
1347#define IoTYPE_RDONLY '<'
1348#define IoTYPE_WRONLY '>'
1349#define IoTYPE_RDWR '+'
1350#define IoTYPE_APPEND 'a'
1351#define IoTYPE_PIPE '|'
1352#define IoTYPE_STD '-' /* stdin or stdout */
1353#define IoTYPE_SOCKET 's'
1354#define IoTYPE_CLOSED ' '
1355#define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1356#define IoTYPE_NUMERIC '#' /* fdopen */
03fcf2fc
GS
1357
1358/*
954c1994
GS
1359=for apidoc Am|bool|SvTAINTED|SV* sv
1360Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1361not.
1362
1363=for apidoc Am|void|SvTAINTED_on|SV* sv
c55831ac 1364Marks an SV as tainted if tainting is enabled.
954c1994
GS
1365
1366=for apidoc Am|void|SvTAINTED_off|SV* sv
1367Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1368some of Perl's fundamental security features. XS module authors should not
1369use this function unless they fully understand all the implications of
1370unconditionally untainting the value. Untainting should be done in the
1371standard perl fashion, via a carefully crafted regexp, rather than directly
1372untainting variables.
1373
1374=for apidoc Am|void|SvTAINT|SV* sv
c55831ac 1375Taints an SV if tainting is enabled.
954c1994
GS
1376
1377=cut
1378*/
1379
a0714e2c 1380#define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
aae9cea0 1381
bbce6d69 1382#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22
NIS
1383#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1384#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 1385
c6ee37c5
MB
1386#define SvTAINT(sv) \
1387 STMT_START { \
3280af22 1388 if (PL_tainting) { \
3280af22 1389 if (PL_tainted) \
c6ee37c5
MB
1390 SvTAINTED_on(sv); \
1391 } \
1392 } STMT_END
79072805 1393
954c1994
GS
1394/*
1395=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
5f08bad4
ST
1396Like C<SvPV> but will force the SV into containing just a string
1397(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1398directly.
954c1994 1399
645c22ef 1400=for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
5f08bad4
ST
1401Like C<SvPV> but will force the SV into containing just a string
1402(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1403directly. Doesn't process magic.
645c22ef 1404
954c1994 1405=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
5f08bad4
ST
1406Returns a pointer to the string in the SV, or a stringified form of
1407the SV if the SV does not contain a string. The SV may cache the
1408stringified version becoming C<SvPOK>. Handles 'get' magic. See also
645c22ef
DM
1409C<SvPVx> for a version which guarantees to evaluate sv only once.
1410
1411=for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
4ea561bc
NC
1412A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1413Only use this if C<sv> is an expression with side effects, otherwise use the
1414more efficient C<SvPVX>.
954c1994 1415
891f9566
YST
1416=for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1417Like C<SvPV> but doesn't process magic.
1418
954c1994 1419=for apidoc Am|char*|SvPV_nolen|SV* sv
5f08bad4
ST
1420Returns a pointer to the string in the SV, or a stringified form of
1421the SV if the SV does not contain a string. The SV may cache the
1422stringified form becoming C<SvPOK>. Handles 'get' magic.
954c1994
GS
1423
1424=for apidoc Am|IV|SvIV|SV* sv
c40f1585 1425Coerces the given SV to an integer and returns it. See C<SvIVx> for a
645c22ef
DM
1426version which guarantees to evaluate sv only once.
1427
891f9566
YST
1428=for apidoc Am|IV|SvIV_nomg|SV* sv
1429Like C<SvIV> but doesn't process magic.
1430
645c22ef
DM
1431=for apidoc Am|IV|SvIVx|SV* sv
1432Coerces the given SV to an integer and returns it. Guarantees to evaluate
4ea561bc
NC
1433C<sv> only once. Only use this if C<sv> is an expression with side effects,
1434otherwise use the more efficient C<SvIV>.
954c1994
GS
1435
1436=for apidoc Am|NV|SvNV|SV* sv
c40f1585 1437Coerce the given SV to a double and return it. See C<SvNVx> for a version
645c22ef
DM
1438which guarantees to evaluate sv only once.
1439
6f1401dc
DM
1440=for apidoc Am|NV|SvNV_nomg|SV* sv
1441Like C<SvNV> but doesn't process magic.
1442
645c22ef
DM
1443=for apidoc Am|NV|SvNVx|SV* sv
1444Coerces the given SV to a double and returns it. Guarantees to evaluate
4ea561bc
NC
1445C<sv> only once. Only use this if C<sv> is an expression with side effects,
1446otherwise use the more efficient C<SvNV>.
954c1994
GS
1447
1448=for apidoc Am|UV|SvUV|SV* sv
645c22ef
DM
1449Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1450for a version which guarantees to evaluate sv only once.
1451
891f9566
YST
1452=for apidoc Am|UV|SvUV_nomg|SV* sv
1453Like C<SvUV> but doesn't process magic.
1454
645c22ef
DM
1455=for apidoc Am|UV|SvUVx|SV* sv
1456Coerces the given SV to an unsigned integer and returns it. Guarantees to
4ea561bc
NC
1457C<sv> only once. Only use this if C<sv> is an expression with side effects,
1458otherwise use the more efficient C<SvUV>.
954c1994
GS
1459
1460=for apidoc Am|bool|SvTRUE|SV* sv
1461Returns a boolean indicating whether Perl would evaluate the SV as true or
06c841cf
FC
1462false. See SvOK() for a defined/undefined test. Handles 'get' magic
1463unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
1464private flags).
1465
1466=for apidoc Am|bool|SvTRUE_nomg|SV* sv
1467Returns a boolean indicating whether Perl would evaluate the SV as true or
c0b6140e 1468false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
954c1994 1469
645c22ef 1470=for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
b70b15d2 1471Like C<SvPV_force>, but converts sv to utf8 first if necessary.
645c22ef
DM
1472
1473=for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
b70b15d2 1474Like C<SvPV>, but converts sv to utf8 first if necessary.
645c22ef 1475
b70b15d2
TJ
1476=for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1477Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
645c22ef
DM
1478
1479=for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1480Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1481
1482=for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1483Like C<SvPV>, but converts sv to byte representation first if necessary.
1484
b70b15d2 1485=for apidoc Am|char*|SvPVbyte_nolen|SV* sv
645c22ef
DM
1486Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1487
1488=for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
b70b15d2 1489Like C<SvPV_force>, but converts sv to utf8 first if necessary.
d1be9408 1490Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
645c22ef
DM
1491otherwise.
1492
1493=for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
b70b15d2 1494Like C<SvPV>, but converts sv to utf8 first if necessary.
d1be9408 1495Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
645c22ef
DM
1496otherwise.
1497
1498=for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1499Like C<SvPV_force>, but converts sv to byte representation first if necessary.
d1be9408 1500Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
645c22ef
DM
1501otherwise.
1502
1503=for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1504Like C<SvPV>, but converts sv to byte representation first if necessary.
d1be9408 1505Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
645c22ef
DM
1506otherwise.
1507
19dbb8f1
NC
1508=for apidoc Am|bool|SvIsCOW|SV* sv
1509Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1510hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1511COW)
1512
1513=for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1514Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1515scalar.
645c22ef 1516
0f76ff59
MHM
1517=for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1518Like C<sv_catpvn> but doesn't process magic.
1519
1520=for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1521Like C<sv_setsv> but doesn't process magic.
1522
1523=for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1524Like C<sv_catsv> but doesn't process magic.
1525
dc960812
SP
1526=for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1527
1528Like sv_utf8_upgrade, but doesn't do magic on C<sv>
1529
954c1994
GS
1530=cut
1531*/
1532
25da4f38 1533/* Let us hope that bitmaps for UV and IV are the same */
463ee0b2 1534#define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
ff68c719 1535#define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
463ee0b2 1536#define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 1537
891f9566
YST
1538#define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1539#define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
6f1401dc 1540#define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
891f9566 1541
baca2b92 1542/* ----*/
8d6d96c1 1543
8d6d96c1 1544#define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
32a5c6ec 1545#define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
44d22300 1546#define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
8d6d96c1 1547
8d6d96c1
HS
1548#define SvPV_flags(sv, lp, flags) \
1549 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1550 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
32a5c6ec
NC
1551#define SvPV_flags_const(sv, lp, flags) \
1552 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1553 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1554 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
2596d9fe
NC
1555#define SvPV_flags_const_nolen(sv, flags) \
1556 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1557 ? SvPVX_const(sv) : \
1558 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
44d22300
NC
1559#define SvPV_flags_mutable(sv, lp, flags) \
1560 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1561 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1562 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
79072805 1563
8d6d96c1 1564#define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
13c5b33c 1565#define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
32a5c6ec 1566#define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
baca2b92 1567
8d6d96c1 1568#define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
2596d9fe 1569#define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
8d6d96c1 1570
8d6d96c1 1571#define SvPV_force_flags(sv, lp, flags) \
ff68c719 1572 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
8d6d96c1 1573 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
13c5b33c
NC
1574#define SvPV_force_flags_nolen(sv, flags) \
1575 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1576 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
32a5c6ec
NC
1577#define SvPV_force_flags_mutable(sv, lp, flags) \
1578 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1579 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1580 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
a0d0e21e 1581
1fa8b10d 1582#define SvPV_nolen(sv) \
5bc28da9 1583 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
dafda6d1 1584 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
70401c6b 1585
9ce348e8
NC
1586#define SvPV_nolen_const(sv) \
1587 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1588 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1589
baca2b92 1590#define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
9ce348e8 1591#define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
2596d9fe 1592#define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
5bc28da9 1593
baca2b92 1594/* ----*/
70401c6b 1595
5bc28da9
NIS
1596#define SvPVutf8(sv, lp) \
1597 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1598 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 1599
5bc28da9 1600#define SvPVutf8_force(sv, lp) \
b7a4fb4f 1601 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
5bc28da9
NIS
1602 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1603
baca2b92 1604
5bc28da9
NIS
1605#define SvPVutf8_nolen(sv) \
1606 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
dafda6d1 1607 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
70401c6b 1608
baca2b92
DM
1609/* ----*/
1610
5bc28da9
NIS
1611#define SvPVbyte(sv, lp) \
1612 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1613 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
70401c6b 1614
5bc28da9
NIS
1615#define SvPVbyte_force(sv, lp) \
1616 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
a7ec4e2e 1617 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
5bc28da9 1618
5bc28da9
NIS
1619#define SvPVbyte_nolen(sv) \
1620 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
dafda6d1 1621 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
70401c6b 1622
1fa8b10d 1623
baca2b92
DM
1624
1625/* define FOOx(): idempotent versions of FOO(). If possible, use a local
1626 * var to evaluate the arg once; failing that, use a global if possible;
1627 * failing that, call a function to do the work
1628 */
1629
1630#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1631#define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1632#define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1633
5dc8bdac 1634#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
baca2b92 1635
b1bc3f34
NC
1636# define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1637# define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1638# define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
3de3296f 1639# define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
32a5c6ec 1640# define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
002e4c74 1641# define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
9ce348e8 1642# define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
3de3296f
AE
1643# define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1644# define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
002e4c74 1645# define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
a80f87c4 1646# define SvTRUE(sv) ( \
8990e307
LW
1647 !sv \
1648 ? 0 \
1649 : SvPOK(sv) \
a80f87c4
GS
1650 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1651 nxpv && \
c2f1de04 1652 (nxpv->xpv_cur > 1 || \
339049b0 1653 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
79072805
LW
1654 ? 1 \
1655 : 0) \
1656 : \
1657 SvIOK(sv) \
463ee0b2 1658 ? SvIVX(sv) != 0 \
79072805 1659 : SvNOK(sv) \
463ee0b2
LW
1660 ? SvNVX(sv) != 0.0 \
1661 : sv_2bool(sv) )
06c841cf
FC
1662# define SvTRUE_nomg(sv) ( \
1663 !sv \
1664 ? 0 \
1665 : SvPOK(sv) \
1666 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1667 nxpv && \
1668 (nxpv->xpv_cur > 1 || \
1669 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1670 ? 1 \
1671 : 0) \
1672 : \
1673 SvIOK(sv) \
1674 ? SvIVX(sv) != 0 \
1675 : SvNOK(sv) \
1676 ? SvNVX(sv) != 0.0 \
1677 : sv_2bool_flags(sv,0) )
3de3296f 1678# define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
baca2b92 1679
a80f87c4 1680#else /* __GNUC__ */
baca2b92 1681
a80f87c4
GS
1682/* These inlined macros use globals, which will require a thread
1683 * declaration in user code, so we avoid them under threads */
1684
3db8f154
MB
1685# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1686# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1687# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1688# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
32a5c6ec 1689# define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
002e4c74 1690# define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
5f1478c3 1691# define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
3db8f154
MB
1692# define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1693# define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
002e4c74 1694# define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
3db8f154 1695# define SvTRUE(sv) ( \
a80f87c4
GS
1696 !sv \
1697 ? 0 \
1698 : SvPOK(sv) \
7b2c381c 1699 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
c2f1de04 1700 (PL_Xpv->xpv_cur > 1 || \
339049b0 1701 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
a80f87c4
GS
1702 ? 1 \
1703 : 0) \
1704 : \
1705 SvIOK(sv) \
1706 ? SvIVX(sv) != 0 \
1707 : SvNOK(sv) \
1708 ? SvNVX(sv) != 0.0 \
1709 : sv_2bool(sv) )
3db8f154 1710# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
baca2b92
DM
1711#endif /* __GNU__ */
1712
765f542d
NC
1713#define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1714 (SVf_FAKE | SVf_READONLY))
46187eeb 1715#define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
baca2b92 1716
bdd68bc3
NC
1717#define SvSHARED_HEK_FROM_PV(pvx) \
1718 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
0a356b31 1719#define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
c158a4fd 1720
baca2b92
DM
1721/* flag values for sv_*_flags functions */
1722#define SV_IMMEDIATE_UNREF 1
1723#define SV_GMAGIC 2
765f542d 1724#define SV_COW_DROP_PV 4
88632417 1725#define SV_UTF8_NO_ENCODING 8
5fcdf167 1726#define SV_NOSTEAL 16
32a5c6ec
NC
1727#define SV_CONST_RETURN 32
1728#define SV_MUTABLE_RETURN 64
bddd5118 1729#define SV_SMAGIC 128
c1c21316 1730#define SV_HAS_TRAILING_NUL 256
34482cd6 1731#define SV_COW_SHARED_HASH_KEYS 512
cb23d5b1
NC
1732/* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1733#define SV_COW_OTHER_PVS 1024
9f621bb0
NC
1734/* Make sv_2pv_flags return NULL if something is undefined. */
1735#define SV_UNDEF_RETURNS_NULL 2048
b3ab6785
KW
1736/* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1737 * This is used when the caller has already determined it is, and avoids
1738 * redundant work */
1739#define SV_FORCE_UTF8_UPGRADE 4096
aee036bb
DM
1740/* if (after resolving magic etc), the SV is found to be overloaded,
1741 * don't call the overload magic, just return as-is */
1742#define SV_SKIP_OVERLOAD 8192
34482cd6
NC
1743
1744/* The core is safe for this COW optimisation. XS code on CPAN may not be.
1745 So only default to doing the COW setup if we're in the core.
1746 */
1747#ifdef PERL_CORE
1748# ifndef SV_DO_COW_SVSETSV
cb23d5b1 1749# define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
34482cd6
NC
1750# endif
1751#endif
1752
1753#ifndef SV_DO_COW_SVSETSV
1754# define SV_DO_COW_SVSETSV 0
1755#endif
1756
765f542d 1757
5abc721d
NC
1758#define sv_unref(sv) sv_unref_flags(sv, 0)
1759#define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
47518d95
NC
1760#define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1761#define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
174c73e3 1762
46187eeb
NC
1763/* We are about to replace the SV's current value. So if it's copy on write
1764 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1765 the value is about to get thrown away, so drop the PV rather than go to
1766 the effort of making a read-write copy only for it to get immediately
1767 discarded. */
765f542d
NC
1768
1769#define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1770 sv_force_normal_flags(sv, SV_COW_DROP_PV)
46187eeb 1771
f8c7b90f 1772#ifdef PERL_OLD_COPY_ON_WRITE
5302ffd4 1773#define SvRELEASE_IVX(sv) \
7a4bba22 1774 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
46187eeb 1775# define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
7a4bba22 1776# define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
b8f9541a 1777#else
7a4bba22
NC
1778# define SvRELEASE_IVX(sv) 0
1779/* This little game brought to you by the need to shut this warning up:
1780mg.c: In function `Perl_magic_get':
1781mg.c:1024: warning: left-hand operand of comma expression has no effect
1782*/
1783# define SvRELEASE_IVX_(sv) /**/
f8c7b90f 1784#endif /* PERL_OLD_COPY_ON_WRITE */
ed252734
NC
1785
1786#define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1787 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
dd2eae66 1788 SVf_OOK|SVf_BREAK|SVf_READONLY)
ed252734
NC
1789#define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1790
765f542d
NC
1791#define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1792 sv_force_normal_flags(sv, 0)
1793
1794
baca2b92
DM
1795/* all these 'functions' are now just macros */
1796
1797#define sv_pv(sv) SvPV_nolen(sv)
1798#define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1799#define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1800
1801#define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
b3ab6785 1802#define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
baca2b92
DM
1803#define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1804#define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
34482cd6
NC
1805#define sv_setsv(dsv, ssv) \
1806 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1807#define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
baca2b92
DM
1808#define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1809#define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
b347df82 1810#define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
baca2b92 1811#define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
b347df82
NC
1812#define sv_catpvn_mg(sv, sstr, slen) \
1813 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
baca2b92 1814#define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
cb2f1b7b
NC
1815#define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1816#define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1817#define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
baca2b92
DM
1818#define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1819#define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1820#define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
891f9566
YST
1821#define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1822#define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
39d5de13 1823#define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
078504b2
FC
1824#define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
1825#define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
06c841cf 1826#define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
84335ee9
NC
1827#define sv_insert(bigstr, offset, len, little, littlelen) \
1828 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1829 (littlelen), SV_GMAGIC)
baca2b92 1830
db79b45b
JH
1831/* Should be named SvCatPVN_utf8_upgrade? */
1832#define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1833 STMT_START { \
1834 if (!(nsv)) \
ad25789c 1835 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
db79b45b
JH
1836 else \
1837 sv_setpvn(nsv, sstr, slen); \
1838 SvUTF8_off(nsv); \
1839 sv_utf8_upgrade(nsv); \
1840 sv_catsv(dsv, nsv); \
1841 } STMT_END
79072805 1842
954c1994
GS
1843/*
1844=for apidoc Am|SV*|newRV_inc|SV* sv
1845
1846Creates an RV wrapper for an SV. The reference count for the original SV is
1847incremented.
1848
1849=cut
1850*/
1851
5f05dabc 1852#define newRV_inc(sv) newRV(sv)
5f05dabc 1853
ef50df4b 1854/* the following macros update any magic values this sv is associated with */
79072805 1855
954c1994 1856/*
ccfc67b7
JH
1857=head1 Magical Functions
1858
954c1994
GS
1859=for apidoc Am|void|SvGETMAGIC|SV* sv
1860Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1861argument more than once.
1862
1863=for apidoc Am|void|SvSETMAGIC|SV* sv
1864Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1865argument more than once.
1866
1867=for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1868Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1869more than once.
1870
1871=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1872Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1873ssv. May evaluate arguments more than once.
1874
645c22ef
DM
1875=for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1876Like C<SvSetSV>, but does any set magic required afterwards.
1877
1878=for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
80663158 1879Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
645c22ef 1880
68795e93
NIS
1881=for apidoc Am|void|SvSHARE|SV* sv
1882Arranges for sv to be shared between threads if a suitable module
1883has been loaded.
1884
1885=for apidoc Am|void|SvLOCK|SV* sv
1886Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1887has been loaded.
1888
1889=for apidoc Am|void|SvUNLOCK|SV* sv
1890Releases a mutual exclusion lock on sv if a suitable module
1891has been loaded.
1892
ccfc67b7
JH
1893=head1 SV Manipulation Functions
1894
679ac26e 1895=for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
954c1994
GS
1896Expands the character buffer in the SV so that it has room for the
1897indicated number of bytes (remember to reserve space for an extra trailing
8cf8f3d1 1898NUL character). Calls C<sv_grow> to perform the expansion if necessary.
954c1994
GS
1899Returns a pointer to the character buffer.
1900
1901=cut
1902*/
1903
16c91539
BM
1904#define SvSHARE(sv) PL_sharehook(aTHX_ sv)
1905#define SvLOCK(sv) PL_lockhook(aTHX_ sv)
1906#define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
1907#define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
68795e93 1908
189b2af5
GS
1909#define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1910#define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
79072805 1911
54310121 1912#define SvSetSV_and(dst,src,finally) \
189b2af5 1913 STMT_START { \
54310121
PP
1914 if ((dst) != (src)) { \
1915 sv_setsv(dst, src); \
1916 finally; \
189b2af5
GS
1917 } \
1918 } STMT_END
54310121 1919#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 1920 STMT_START { \
8ebc5c01 1921 if ((dst) != (src)) { \
34482cd6 1922 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
54310121 1923 finally; \
189b2af5
GS
1924 } \
1925 } STMT_END
79072805 1926
54310121 1927#define SvSetSV(dst,src) \
c9d716f7 1928 SvSetSV_and(dst,src,/*nothing*/;)
54310121 1929#define SvSetSV_nosteal(dst,src) \
c9d716f7 1930 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121
PP
1931
1932#define SvSetMagicSV(dst,src) \
1933 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1934#define SvSetMagicSV_nosteal(dst,src) \
1935 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1936
db79b45b 1937
1045810a 1938#if !defined(SKIP_DEBUGGING)
79072805 1939#define SvPEEK(sv) sv_peek(sv)
3967c732
JD
1940#else
1941#define SvPEEK(sv) ""
1942#endif
79072805 1943
5dc8bdac 1944#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
36477c24 1945
3280af22 1946#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 1947
79072805 1948#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
f7877b28
NC
1949/* If I give every macro argument a different name, then there won't be bugs
1950 where nested macros get confused. Been there, done that. */
1951#define isGV_with_GP(pwadak) \
2e5b91de 1952 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
f7877b28 1953 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2e5b91de 1954#define isGV_with_GP_on(sv) STMT_START { \
70ad9799
SP
1955 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1956 assert (!SvPOKp(sv)); \
1957 assert (!SvIOKp(sv)); \
1958 (SvFLAGS(sv) |= SVpgv_GP); \
2e5b91de
NC
1959 } STMT_END
1960#define isGV_with_GP_off(sv) STMT_START { \
70ad9799
SP
1961 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1962 assert (!SvPOKp(sv)); \
1963 assert (!SvIOKp(sv)); \
2e5b91de
NC
1964 (SvFLAGS(sv) &= ~SVpgv_GP); \
1965 } STMT_END
1966
79072805 1967
933fea7f 1968#define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
5902b6a9
NC
1969#define SvGROW_mutable(sv,len) \
1970 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
933fea7f 1971#define Sv_Grow sv_grow
3d35f11b 1972
a0739874
DM
1973#define CLONEf_COPY_STACKS 1
1974#define CLONEf_KEEP_PTR_TABLE 2
c43294b8 1975#define CLONEf_CLONE_HOST 4
0405e91e 1976#define CLONEf_JOIN_IN 8
a0739874 1977
8cf8f3d1 1978struct clone_params {
d2d73c3e
AB
1979 AV* stashes;
1980 UV flags;
59b40662 1981 PerlInterpreter *proto_perl;
1db366cc 1982 PerlInterpreter *new_perl;
d08d57ef 1983 AV *unreferenced;
8cf8f3d1 1984};
102d3b8a
NC
1985
1986/*
740cce10
NC
1987=for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
1988
1989Creates a new SV and copies a string into it. If utf8 is true, calls
1990C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
1991
1992=cut
1993*/
1994
1995#define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
1996
1997/*
69240efd
NC
1998=for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
1999
2000Reads into I<len> the offset from SvPVX back to the true start of the
2001allocated buffer, which will be non-zero if C<sv_chop> has been used to
2002efficiently remove characters from start of the buffer. Implemented as a
2003macro, which takes the address of I<len>, which must be of type C<STRLEN>.
2004Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
2005
2006=cut
2007*/
2008
2009#ifdef DEBUGGING
2010/* Does the bot know something I don't?
201110:28 <@Nicholas> metabatman
201210:28 <+meta> Nicholas: crash
2013*/
2014# define SvOOK_offset(sv, offset) STMT_START { \
2015 assert(sizeof(offset) == sizeof(STRLEN)); \
2016 if (SvOOK(sv)) { \
2017 const U8 *crash = (U8*)SvPVX_const(sv); \
2018 offset = *--crash; \
2019 if (!offset) { \
2020 crash -= sizeof(STRLEN); \
2021 Copy(crash, (U8 *)&offset, sizeof(STRLEN), U8); \
2022 } \
2023 { \
2024 /* Validate the preceding buffer's sentinels to \
2025 verify that no-one is using it. */ \
2026 const U8 *const bonk = (U8 *) SvPVX_const(sv) - offset; \
2027 while (crash > bonk) { \
2028 --crash; \
2029 assert (*crash == (U8)PTR2UV(crash)); \
2030 } \
2031 } \
2032 } else { \
2033 offset = 0; \
2034 } \
2035 } STMT_END
2036#else
2037 /* This is the same code, but avoids using any temporary variables: */
2038# define SvOOK_offset(sv, offset) STMT_START { \
2039 assert(sizeof(offset) == sizeof(STRLEN)); \
2040 if (SvOOK(sv)) { \
2041 offset = ((U8*)SvPVX_const(sv))[-1]; \
2042 if (!offset) { \
2043 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2044 (U8 *)&offset, sizeof(STRLEN), U8); \
2045 } \
2046 } else { \
2047 offset = 0; \
2048 } \
2049 } STMT_END
2050#endif
85dca89a
NC
2051
2052#define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2053
69240efd 2054/*
102d3b8a
NC
2055 * Local variables:
2056 * c-indentation-style: bsd
2057 * c-basic-offset: 4
2058 * indent-tabs-mode: t
2059 * End:
2060 *
2061 * ex: set ts=8 sts=4 sw=4 noet:
2062 */