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