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