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