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