This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #97632] Improve SvTAINT docs
[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
325#define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
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
DM
673Returns the raw value in the SV's IV slot, without checks or conversions.
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
DM
677Returns the raw value in the SV's UV slot, without checks or conversions.
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
DM
681Returns the raw value in the SV's NV slot, without checks or conversions.
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
NC
896
897Returns true if the SV has get magic or overloading. If either is true then
898the scalar is active data, and has the potential to return a new value every
899time it is accessed. Hence you must be careful to only read it once per user
900logical operation and work with that returned value. If neither is true then
901the scalar's value cannot change unless written to.
902
903=cut
904*/
905
dd2eae66 906#define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1426bbf4 907
242f8760 908#define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash, FALSE))
a0d0e21e 909
810b8aa5
GS
910#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
911 == (SVf_ROK|SVprv_WEAKREF))
912#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
913#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
914
1ccdb730
NC
915#define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
916 == (SVf_ROK|SVprv_PCS_IMPORTED))
917#define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
918#define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
919
a0d0e21e 920#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 921
9a214eec
DM
922#define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
923#define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
d9d18af6 924
9a214eec 925/* SVs_PADTMP and SVs_PADSTALE share the same bit, mediated by SVs_PADMY */
ed6116ce 926
9a214eec
DM
927#define SvPADTMP(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP)) == SVs_PADTMP)
928#define SvPADSTALE(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADSTALE)) \
929 == (SVs_PADMY|SVs_PADSTALE))
62bb6514
DM
930
931#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
9a214eec
DM
932# define SvPADTMP_on(sv) ({ \
933 SV *const _svpad = MUTABLE_SV(sv); \
934 assert(!(SvFLAGS(_svpad) & SVs_PADMY)); \
935 SvFLAGS(_svpad) |= SVs_PADTMP; \
936 })
937# define SvPADTMP_off(sv) ({ \
938 SV *const _svpad = MUTABLE_SV(sv); \
939 assert(!(SvFLAGS(_svpad) & SVs_PADMY)); \
940 SvFLAGS(_svpad) &= ~SVs_PADTMP; \
62bb6514 941 })
9a214eec
DM
942# define SvPADSTALE_on(sv) ({ \
943 SV *const _svpad = MUTABLE_SV(sv); \
944 assert(SvFLAGS(_svpad) & SVs_PADMY); \
945 SvFLAGS(_svpad) |= SVs_PADSTALE; \
62bb6514 946 })
9a214eec
DM
947# define SvPADSTALE_off(sv) ({ \
948 SV *const _svpad = MUTABLE_SV(sv); \
949 assert(SvFLAGS(_svpad) & SVs_PADMY); \
950 SvFLAGS(_svpad) &= ~SVs_PADSTALE; \
62bb6514
DM
951 })
952#else
953# define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
9a214eec 954# define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
62bb6514 955# define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
9a214eec 956# define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
62bb6514 957#endif
ed6116ce 958
8990e307
LW
959#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
960#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
961#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 962
8990e307
LW
963#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
964#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
965#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 966
8990e307
LW
967#define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
968#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
969#define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
79072805 970
180488f8 971#define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
8990e307
LW
972#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
973#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 974
74e0ddf7
NC
975#ifndef PERL_CORE
976# define SvCOMPILED(sv) 0
977# define SvCOMPILED_on(sv)
978# define SvCOMPILED_off(sv)
979#endif
79072805 980
25da4f38
IZ
981#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
982#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
983#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
984
85efc3a5 985#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
e9726144 986# define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
e5ae200f
RU
987 if (SvFLAGS(_svvalid) & SVpbm_VALID) \
988 assert(!isGV_with_GP(_svvalid)); \
989 (SvFLAGS(_svvalid) & SVpbm_VALID); \
85ffbbb0 990 })
b1bc3f34 991# define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
e5ae200f
RU
992 assert(!isGV_with_GP(_svvalid)); \
993 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
85ffbbb0 994 })
b1bc3f34 995# define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
e5ae200f
RU
996 assert(!isGV_with_GP(_svvalid)); \
997 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
85ffbbb0
NC
998 })
999
e9726144 1000# define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
e5ae200f
RU
1001 assert(SvTYPE(_svtail) != SVt_PVAV); \
1002 assert(SvTYPE(_svtail) != SVt_PVHV); \
78d0cf80
NC
1003 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1004 == (SVpbm_TAIL|SVpbm_VALID); \
85efc3a5
NC
1005 })
1006#else
85ffbbb0
NC
1007# define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
1008# define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1009# define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
78d0cf80 1010# define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
fe901688 1011 == (SVpbm_TAIL|SVpbm_VALID))
78d0cf80 1012
85efc3a5 1013#endif
8990e307
LW
1014#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1015#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1016
8990e307 1017
075bae1e
NC
1018#define SvPAD_TYPED(sv) \
1019 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
00b1698f 1020
075bae1e
NC
1021#define SvPAD_OUR(sv) \
1022 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
00b1698f 1023
952306ac
RGS
1024#define SvPAD_STATE(sv) \
1025 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
a72e56b0
NC
1026
1027#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1028# define SvPAD_TYPED_on(sv) ({ \
b1bc3f34 1029 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
1030 assert(SvTYPE(_svpad) == SVt_PVMG); \
1031 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \
a72e56b0
NC
1032 })
1033#define SvPAD_OUR_on(sv) ({ \
b1bc3f34 1034 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
1035 assert(SvTYPE(_svpad) == SVt_PVMG); \
1036 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \
a72e56b0
NC
1037 })
1038#define SvPAD_STATE_on(sv) ({ \
b1bc3f34 1039 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
1040 assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
1041 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \
a72e56b0
NC
1042 })
1043#else
1044# define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1045# define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1046# define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1047#endif
952306ac 1048
73d95100 1049#define SvOURSTASH(sv) \
e736a858 1050 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
73d95100 1051#define SvOURSTASH_set(sv, st) \
e736a858 1052 STMT_START { \
2892acdb 1053 assert(SvTYPE(sv) == SVt_PVMG); \
e736a858 1054 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
035dab74
NC
1055 } STMT_END
1056
ed6116ce
LW
1057#define SvRVx(sv) SvRV(sv)
1058
f599b64b 1059#ifdef PERL_DEBUG_COW
8ed30cc1
DD
1060/* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1061 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
771ba71a
NC
1062# define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1063# define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
58430790 1064# define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
ac09da3b 1065# define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
f19a12a3 1066# define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
c0e1089a 1067/* Don't test the core XS code yet. */
771ba71a
NC
1068# if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1069# define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1070# else
1071# define SvPVX(sv) SvPVX_mutable(sv)
1072# endif
771ba71a
NC
1073# define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1074# define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1075# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1076
1077# ifdef DEBUGGING
064cf529
NC
1078# define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1079# define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
03687789 1080# else
064cf529
NC
1081# define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1082# define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
03687789 1083# endif
f599b64b 1084#else
771ba71a
NC
1085# define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1086# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1087
05ef5f8f
NC
1088# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1089/* These get expanded inside other macros that already use a variable _sv */
f7877b28 1090# define SvPVX(sv) \
d2c6dc5e 1091 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
f1fb8741 1092 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
e5ae200f 1093 assert(!isGV_with_GP(_svpvx)); \
5bb89d25
NC
1094 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1095 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
e5ae200f 1096 &((_svpvx)->sv_u.svu_pv); \
f7877b28 1097 }))
08002bbf 1098# define SvCUR(sv) \
b1bc3f34 1099 (*({ const SV *const _svcur = (const SV *)(sv); \
f1fb8741 1100 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK]); \
e5ae200f 1101 assert(!isGV_with_GP(_svcur)); \
6f7e8353
NC
1102 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1103 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
b1bc3f34 1104 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
08002bbf 1105 }))
05ef5f8f 1106# define SvIVX(sv) \
b1bc3f34 1107 (*({ const SV *const _svivx = (const SV *)(sv); \
f1fb8741 1108 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
e5ae200f 1109 assert(!isGV_with_GP(_svivx)); \
b1bc3f34 1110 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
05ef5f8f
NC
1111 }))
1112# define SvUVX(sv) \
b1bc3f34 1113 (*({ const SV *const _svuvx = (const SV *)(sv); \
f1fb8741 1114 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
e5ae200f 1115 assert(!isGV_with_GP(_svuvx)); \
b1bc3f34 1116 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
05ef5f8f
NC
1117 }))
1118# define SvNVX(sv) \
b1bc3f34 1119 (*({ const SV *const _svnvx = (const SV *)(sv); \
f1fb8741 1120 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
e5ae200f 1121 assert(!isGV_with_GP(_svnvx)); \
b1bc3f34 1122 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
05ef5f8f 1123 }))
ac09da3b 1124# define SvRV(sv) \
f19a12a3 1125 (*({ SV *const _svrv = MUTABLE_SV(sv); \
f1fb8741 1126 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
e5ae200f 1127 assert(!isGV_with_GP(_svrv)); \
6f7e8353
NC
1128 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1129 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
e5ae200f 1130 &((_svrv)->sv_u.svu_rv); \
ac09da3b 1131 }))
f19a12a3
MHM
1132# define SvRV_const(sv) \
1133 ({ const SV *const _svrv = (const SV *)(sv); \
f1fb8741 1134 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
f19a12a3 1135 assert(!isGV_with_GP(_svrv)); \
6f7e8353
NC
1136 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1137 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
f19a12a3
MHM
1138 (_svrv)->sv_u.svu_rv; \
1139 })
05ef5f8f 1140# define SvMAGIC(sv) \
b1bc3f34 1141 (*({ const SV *const _svmagic = (const SV *)(sv); \
e5ae200f
RU
1142 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1143 if(SvTYPE(_svmagic) == SVt_PVMG) \
1144 assert(!SvPAD_OUR(_svmagic)); \
b1bc3f34 1145 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
05ef5f8f
NC
1146 }))
1147# define SvSTASH(sv) \
b1bc3f34 1148 (*({ const SV *const _svstash = (const SV *)(sv); \
e5ae200f 1149 assert(SvTYPE(_svstash) >= SVt_PVMG); \
b1bc3f34 1150 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
05ef5f8f 1151 }))
03687789 1152# else
08002bbf
NC
1153# define SvPVX(sv) ((sv)->sv_u.svu_pv)
1154# define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
05ef5f8f
NC
1155# define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1156# define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
58430790 1157# define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
ac09da3b 1158# define SvRV(sv) ((sv)->sv_u.svu_rv)
f19a12a3 1159# define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
e736a858 1160# define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
771ba71a 1161# define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
03687789 1162# endif
62703e72
NC
1163#endif
1164
06c0cc96 1165#ifndef PERL_POISON
bb496845
SP
1166/* Given that these two are new, there can't be any existing code using them
1167 * as LVALUEs */
06c0cc96
NC
1168# define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1169# define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1170#else
1171/* Except for the poison code, which uses & to scribble over the pointer after
1172 free() is called. */
1173# define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1174# define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1175#endif
bb496845 1176
62703e72
NC
1177#define SvIVXx(sv) SvIVX(sv)
1178#define SvUVXx(sv) SvUVX(sv)
1179#define SvNVXx(sv) SvNVX(sv)
1180#define SvPVXx(sv) SvPVX(sv)
1181#define SvLENx(sv) SvLEN(sv)
1182#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1183
1184
28e5dec8
JH
1185/* Ask a scalar nicely to try to become an IV, if possible.
1186 Not guaranteed to stay returning void */
1187/* Macro won't actually call sv_2iv if already IOK */
1188#define SvIV_please(sv) \
1189 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1190 (void) SvIV(sv); } STMT_END
6f1401dc
DM
1191#define SvIV_please_nomg(sv) \
1192 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1193 (void) SvIV_nomg(sv); } STMT_END
79072805 1194#define SvIV_set(sv, val) \
f1fb8741
DM
1195 STMT_START { \
1196 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1197 assert(!isGV_with_GP(sv)); \
b19bbeda 1198 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
79072805 1199#define SvNV_set(sv, val) \
f1fb8741
DM
1200 STMT_START { \
1201 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1202 assert(!isGV_with_GP(sv)); \
58430790 1203 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
79072805 1204#define SvPV_set(sv, val) \
f1fb8741
DM
1205 STMT_START { \
1206 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1207 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1208 assert(!(SvTYPE(sv) == SVt_PVIO \
1209 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
339049b0 1210 ((sv)->sv_u.svu_pv = (val)); } STMT_END
607fa7f2 1211#define SvUV_set(sv, val) \
f1fb8741
DM
1212 STMT_START { \
1213 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1214 assert(!isGV_with_GP(sv)); \
607fa7f2 1215 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
b162af07 1216#define SvRV_set(sv, val) \
f1fb8741
DM
1217 STMT_START { \
1218 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1219 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1220 assert(!(SvTYPE(sv) == SVt_PVIO \
1221 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
339049b0 1222 ((sv)->sv_u.svu_rv = (val)); } STMT_END
b162af07
SP
1223#define SvMAGIC_set(sv, val) \
1224 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
e736a858 1225 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
b162af07
SP
1226#define SvSTASH_set(sv, val) \
1227 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1228 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
79072805 1229#define SvCUR_set(sv, val) \
f1fb8741
DM
1230 STMT_START { \
1231 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1232 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1233 assert(!(SvTYPE(sv) == SVt_PVIO \
1234 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
b162af07 1235 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
79072805 1236#define SvLEN_set(sv, val) \
f1fb8741
DM
1237 STMT_START { \
1238 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
f7877b28 1239 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1240 assert(!(SvTYPE(sv) == SVt_PVIO \
1241 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
b162af07 1242 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
7ae8ee9e
NC
1243#define SvEND_set(sv, val) \
1244 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
3ec35e0f 1245 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
79072805 1246
b7e9a5c2 1247#define SvPV_renew(sv,n) \
1da4ca5f
NC
1248 STMT_START { SvLEN_set(sv, n); \
1249 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1250 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1251 (MEM_SIZE)((n))))); \
1252 } STMT_END
1253
1254#define SvPV_shrink_to_cur(sv) STMT_START { \
1255 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1256 SvPV_renew(sv, _lEnGtH); \
1257 } STMT_END
b7e9a5c2 1258
771ba71a
NC
1259#define SvPV_free(sv) \
1260 STMT_START { \
1261 assert(SvTYPE(sv) >= SVt_PV); \
1262 if (SvLEN(sv)) { \
e537ac38 1263 assert(!SvROK(sv)); \
771ba71a 1264 if(SvOOK(sv)) { \
69240efd
NC
1265 STRLEN zok; \
1266 SvOOK_offset(sv, zok); \
1267 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
771ba71a
NC
1268 SvFLAGS(sv) &= ~SVf_OOK; \
1269 } \
1270 Safefree(SvPVX(sv)); \
1271 } \
1272 } STMT_END
8bd4d4c5 1273
43230e26
NC
1274#ifdef PERL_CORE
1275/* Code that crops up in three places to take a scalar and ready it to hold
1276 a reference */
1277# define prepare_SV_for_RV(sv) \
1278 STMT_START { \
1279 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1280 sv_upgrade(sv, SVt_IV); \
662f1f9e 1281 else if (SvTYPE(sv) >= SVt_PV) { \
43230e26
NC
1282 SvPV_free(sv); \
1283 SvLEN_set(sv, 0); \
1284 SvCUR_set(sv, 0); \
1285 } \
1286 } STMT_END
1287#endif
373b357f 1288
373b357f
NC
1289/* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1290 perl -T -e '/$^X/'
1291*/
6976cee3 1292
cffe132d
NC
1293#ifndef PERL_CORE
1294# define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1295#endif
6976cee3 1296
60c8298a
NC
1297#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1298# define BmRARE(sv) \
b1bc3f34 1299 (*({ SV *const _bmrare = MUTABLE_SV(sv); \
c13a5c80 1300 assert(SvTYPE(_bmrare) == SVt_PVMG); \
e5ae200f 1301 assert(SvVALID(_bmrare)); \
c13a5c80 1302 &(((XPVMG*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare); \
60c8298a
NC
1303 }))
1304# define BmUSEFUL(sv) \
b1bc3f34 1305 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
c13a5c80 1306 assert(SvTYPE(_bmuseful) == SVt_PVMG); \
e5ae200f
RU
1307 assert(SvVALID(_bmuseful)); \
1308 assert(!SvIOK(_bmuseful)); \
c13a5c80 1309 &(((XPVMG*) SvANY(_bmuseful))->xnv_u.xbm_s.xbm_useful); \
60c8298a
NC
1310 }))
1311# define BmPREVIOUS(sv) \
b1bc3f34 1312 (*({ SV *const _bmprevious = MUTABLE_SV(sv); \
c13a5c80 1313 assert(SvTYPE(_bmprevious) == SVt_PVMG); \
e5ae200f 1314 assert(SvVALID(_bmprevious)); \
c13a5c80 1315 &(((XPVMG*) SvANY(_bmprevious))->xiv_u.xivu_uv); \
8eeaf79a 1316 }))
60c8298a 1317#else
c13a5c80
NC
1318# define BmRARE(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1319# define BmUSEFUL(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_useful
1320# define BmPREVIOUS(sv) ((XPVMG*) SvANY(sv))->xiv_u.xivu_uv
b4f6c04b 1321
60c8298a 1322#endif
79072805 1323
c4648999 1324#define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
79072805
LW
1325
1326#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1327#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1328#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1329#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1330
6f7e8353 1331#define IoIFP(sv) (sv)->sv_u.svu_fp
8990e307
LW
1332#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1333#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
4755096e 1334#define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
c490b21c 1335#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
8990e307
LW
1336#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1337#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1338#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1339#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1340#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1341#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1342#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1343#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1344#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
8990e307
LW
1345#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1346#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1347
50952442 1348/* IoTYPE(sv) is a single character telling the type of I/O connection. */
3b6c1aba
JH
1349#define IoTYPE_RDONLY '<'
1350#define IoTYPE_WRONLY '>'
1351#define IoTYPE_RDWR '+'
1352#define IoTYPE_APPEND 'a'
1353#define IoTYPE_PIPE '|'
1354#define IoTYPE_STD '-' /* stdin or stdout */
1355#define IoTYPE_SOCKET 's'
1356#define IoTYPE_CLOSED ' '
1357#define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1358#define IoTYPE_NUMERIC '#' /* fdopen */
03fcf2fc
GS
1359
1360/*
954c1994
GS
1361=for apidoc Am|bool|SvTAINTED|SV* sv
1362Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1363not.
1364
1365=for apidoc Am|void|SvTAINTED_on|SV* sv
c55831ac 1366Marks an SV as tainted if tainting is enabled.
954c1994
GS
1367
1368=for apidoc Am|void|SvTAINTED_off|SV* sv
1369Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1370some of Perl's fundamental security features. XS module authors should not
1371use this function unless they fully understand all the implications of
1372unconditionally untainting the value. Untainting should be done in the
1373standard perl fashion, via a carefully crafted regexp, rather than directly
1374untainting variables.
1375
1376=for apidoc Am|void|SvTAINT|SV* sv
c98cdb04
FC
1377Taints an SV if tainting is enabled, and if some input to the current
1378expression is tainted--usually a variable, but possibly also implicit
1379inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1380the outputs of an expression in a pessimistic fashion; i.e., without paying
1381attention to precisely which outputs are influenced by which inputs.
954c1994
GS
1382
1383=cut
1384*/
1385
a0714e2c 1386#define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
aae9cea0 1387
bbce6d69 1388#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22
NIS
1389#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1390#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 1391
c6ee37c5
MB
1392#define SvTAINT(sv) \
1393 STMT_START { \
3280af22 1394 if (PL_tainting) { \
3280af22 1395 if (PL_tainted) \
c6ee37c5
MB
1396 SvTAINTED_on(sv); \
1397 } \
1398 } STMT_END
79072805 1399
954c1994
GS
1400/*
1401=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
5f08bad4
ST
1402Like C<SvPV> but will force the SV into containing just a string
1403(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1404directly.
954c1994 1405
645c22ef 1406=for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
5f08bad4
ST
1407Like C<SvPV> but will force the SV into containing just a string
1408(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1409directly. Doesn't process magic.
645c22ef 1410
954c1994 1411=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
5f08bad4
ST
1412Returns a pointer to the string in the SV, or a stringified form of
1413the SV if the SV does not contain a string. The SV may cache the
1414stringified version becoming C<SvPOK>. Handles 'get' magic. See also
645c22ef
DM
1415C<SvPVx> for a version which guarantees to evaluate sv only once.
1416
1417=for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
4ea561bc
NC
1418A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1419Only use this if C<sv> is an expression with side effects, otherwise use the
1420more efficient C<SvPVX>.
954c1994 1421
891f9566
YST
1422=for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1423Like C<SvPV> but doesn't process magic.
1424
954c1994 1425=for apidoc Am|char*|SvPV_nolen|SV* sv
5f08bad4
ST
1426Returns a pointer to the string in the SV, or a stringified form of
1427the SV if the SV does not contain a string. The SV may cache the
1428stringified form becoming C<SvPOK>. Handles 'get' magic.
954c1994 1429
71eb6d8c
TC
1430=for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1431Like C<SvPV_nolen> but doesn't process magic.
1432
954c1994 1433=for apidoc Am|IV|SvIV|SV* sv
c40f1585 1434Coerces the given SV to an integer and returns it. See C<SvIVx> for a
645c22ef
DM
1435version which guarantees to evaluate sv only once.
1436
891f9566
YST
1437=for apidoc Am|IV|SvIV_nomg|SV* sv
1438Like C<SvIV> but doesn't process magic.
1439
645c22ef
DM
1440=for apidoc Am|IV|SvIVx|SV* sv
1441Coerces the given SV to an integer and returns it. Guarantees to evaluate
4ea561bc
NC
1442C<sv> only once. Only use this if C<sv> is an expression with side effects,
1443otherwise use the more efficient C<SvIV>.
954c1994
GS
1444
1445=for apidoc Am|NV|SvNV|SV* sv
c40f1585 1446Coerce the given SV to a double and return it. See C<SvNVx> for a version
645c22ef
DM
1447which guarantees to evaluate sv only once.
1448
6f1401dc
DM
1449=for apidoc Am|NV|SvNV_nomg|SV* sv
1450Like C<SvNV> but doesn't process magic.
1451
645c22ef
DM
1452=for apidoc Am|NV|SvNVx|SV* sv
1453Coerces the given SV to a double and returns it. Guarantees to evaluate
4ea561bc
NC
1454C<sv> only once. Only use this if C<sv> is an expression with side effects,
1455otherwise use the more efficient C<SvNV>.
954c1994
GS
1456
1457=for apidoc Am|UV|SvUV|SV* sv
645c22ef
DM
1458Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1459for a version which guarantees to evaluate sv only once.
1460
891f9566
YST
1461=for apidoc Am|UV|SvUV_nomg|SV* sv
1462Like C<SvUV> but doesn't process magic.
1463
645c22ef
DM
1464=for apidoc Am|UV|SvUVx|SV* sv
1465Coerces the given SV to an unsigned integer and returns it. Guarantees to
4ea561bc
NC
1466C<sv> only once. Only use this if C<sv> is an expression with side effects,
1467otherwise use the more efficient C<SvUV>.
954c1994
GS
1468
1469=for apidoc Am|bool|SvTRUE|SV* sv
1470Returns a boolean indicating whether Perl would evaluate the SV as true or
06c841cf
FC
1471false. See SvOK() for a defined/undefined test. Handles 'get' magic
1472unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
1473private flags).
1474
1475=for apidoc Am|bool|SvTRUE_nomg|SV* sv
1476Returns a boolean indicating whether Perl would evaluate the SV as true or
c0b6140e 1477false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
954c1994 1478
645c22ef 1479=for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
b70b15d2 1480Like C<SvPV_force>, but converts sv to utf8 first if necessary.
645c22ef
DM
1481
1482=for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
b70b15d2 1483Like C<SvPV>, but converts sv to utf8 first if necessary.
645c22ef 1484
b70b15d2
TJ
1485=for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1486Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
645c22ef
DM
1487
1488=for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1489Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1490
1491=for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1492Like C<SvPV>, but converts sv to byte representation first if necessary.
1493
b70b15d2 1494=for apidoc Am|char*|SvPVbyte_nolen|SV* sv
645c22ef
DM
1495Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1496
1497=for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
b70b15d2 1498Like C<SvPV_force>, but converts sv to utf8 first if necessary.
d1be9408 1499Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
645c22ef
DM
1500otherwise.
1501
1502=for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
b70b15d2 1503Like C<SvPV>, but converts sv to utf8 first if necessary.
d1be9408 1504Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
645c22ef
DM
1505otherwise.
1506
1507=for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1508Like C<SvPV_force>, but converts sv to byte representation first if necessary.
d1be9408 1509Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
645c22ef
DM
1510otherwise.
1511
1512=for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1513Like C<SvPV>, but converts sv to byte representation first if necessary.
d1be9408 1514Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
645c22ef
DM
1515otherwise.
1516
19dbb8f1
NC
1517=for apidoc Am|bool|SvIsCOW|SV* sv
1518Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1519hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1520COW)
1521
1522=for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1523Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1524scalar.
645c22ef 1525
0f76ff59
MHM
1526=for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1527Like C<sv_catpvn> but doesn't process magic.
1528
9dcc53ea
Z
1529=for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1530Like C<sv_catpv> but doesn't process magic.
1531
0f76ff59
MHM
1532=for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1533Like C<sv_setsv> but doesn't process magic.
1534
1535=for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1536Like C<sv_catsv> but doesn't process magic.
1537
dc960812
SP
1538=for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1539
1540Like sv_utf8_upgrade, but doesn't do magic on C<sv>
1541
954c1994
GS
1542=cut
1543*/
1544
25da4f38 1545/* Let us hope that bitmaps for UV and IV are the same */
463ee0b2 1546#define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
ff68c719 1547#define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
463ee0b2 1548#define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 1549
891f9566
YST
1550#define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1551#define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
6f1401dc 1552#define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
891f9566 1553
baca2b92 1554/* ----*/
8d6d96c1 1555
8d6d96c1 1556#define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
32a5c6ec 1557#define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
44d22300 1558#define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
8d6d96c1 1559
8d6d96c1
HS
1560#define SvPV_flags(sv, lp, flags) \
1561 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1562 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
32a5c6ec
NC
1563#define SvPV_flags_const(sv, lp, flags) \
1564 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1565 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1566 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
2596d9fe
NC
1567#define SvPV_flags_const_nolen(sv, flags) \
1568 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1569 ? SvPVX_const(sv) : \
1570 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
44d22300
NC
1571#define SvPV_flags_mutable(sv, lp, flags) \
1572 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1573 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1574 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
79072805 1575
8d6d96c1 1576#define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
13c5b33c 1577#define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
32a5c6ec 1578#define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
baca2b92 1579
8d6d96c1 1580#define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
2596d9fe 1581#define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
8d6d96c1 1582
8d6d96c1 1583#define SvPV_force_flags(sv, lp, flags) \
ff68c719 1584 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
8d6d96c1 1585 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
13c5b33c
NC
1586#define SvPV_force_flags_nolen(sv, flags) \
1587 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1588 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
32a5c6ec
NC
1589#define SvPV_force_flags_mutable(sv, lp, flags) \
1590 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1591 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1592 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
a0d0e21e 1593
1fa8b10d 1594#define SvPV_nolen(sv) \
5bc28da9 1595 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
dafda6d1 1596 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
70401c6b 1597
71eb6d8c
TC
1598#define SvPV_nomg_nolen(sv) \
1599 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1600 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1601
9ce348e8
NC
1602#define SvPV_nolen_const(sv) \
1603 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1604 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1605
baca2b92 1606#define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
9ce348e8 1607#define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
2596d9fe 1608#define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
5bc28da9 1609
baca2b92 1610/* ----*/
70401c6b 1611
5bc28da9
NIS
1612#define SvPVutf8(sv, lp) \
1613 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1614 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 1615
5bc28da9 1616#define SvPVutf8_force(sv, lp) \
b7a4fb4f 1617 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
5bc28da9
NIS
1618 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1619
baca2b92 1620
5bc28da9
NIS
1621#define SvPVutf8_nolen(sv) \
1622 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
dafda6d1 1623 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
70401c6b 1624
baca2b92
DM
1625/* ----*/
1626
5bc28da9
NIS
1627#define SvPVbyte(sv, lp) \
1628 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1629 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
70401c6b 1630
5bc28da9
NIS
1631#define SvPVbyte_force(sv, lp) \
1632 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
a7ec4e2e 1633 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
5bc28da9 1634
5bc28da9
NIS
1635#define SvPVbyte_nolen(sv) \
1636 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
dafda6d1 1637 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
70401c6b 1638
1fa8b10d 1639
baca2b92
DM
1640
1641/* define FOOx(): idempotent versions of FOO(). If possible, use a local
1642 * var to evaluate the arg once; failing that, use a global if possible;
1643 * failing that, call a function to do the work
1644 */
1645
1646#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1647#define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1648#define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1649
5dc8bdac 1650#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
baca2b92 1651
b1bc3f34
NC
1652# define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1653# define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1654# define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
3de3296f 1655# define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
32a5c6ec 1656# define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
002e4c74 1657# define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
9ce348e8 1658# define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
3de3296f
AE
1659# define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1660# define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
002e4c74 1661# define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
a80f87c4 1662# define SvTRUE(sv) ( \
8990e307
LW
1663 !sv \
1664 ? 0 \
1665 : SvPOK(sv) \
a80f87c4
GS
1666 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1667 nxpv && \
c2f1de04 1668 (nxpv->xpv_cur > 1 || \
339049b0 1669 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
79072805
LW
1670 ? 1 \
1671 : 0) \
1672 : \
1673 SvIOK(sv) \
463ee0b2 1674 ? SvIVX(sv) != 0 \
79072805 1675 : SvNOK(sv) \
463ee0b2
LW
1676 ? SvNVX(sv) != 0.0 \
1677 : sv_2bool(sv) )
06c841cf
FC
1678# define SvTRUE_nomg(sv) ( \
1679 !sv \
1680 ? 0 \
1681 : SvPOK(sv) \
1682 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1683 nxpv && \
1684 (nxpv->xpv_cur > 1 || \
1685 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1686 ? 1 \
1687 : 0) \
1688 : \
1689 SvIOK(sv) \
1690 ? SvIVX(sv) != 0 \
1691 : SvNOK(sv) \
1692 ? SvNVX(sv) != 0.0 \
1693 : sv_2bool_flags(sv,0) )
3de3296f 1694# define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
baca2b92 1695
a80f87c4 1696#else /* __GNUC__ */
baca2b92 1697
a80f87c4
GS
1698/* These inlined macros use globals, which will require a thread
1699 * declaration in user code, so we avoid them under threads */
1700
3db8f154
MB
1701# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1702# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1703# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1704# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
32a5c6ec 1705# define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
002e4c74 1706# define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
5f1478c3 1707# define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
3db8f154
MB
1708# define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1709# define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
002e4c74 1710# define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
3db8f154 1711# define SvTRUE(sv) ( \
a80f87c4
GS
1712 !sv \
1713 ? 0 \
1714 : SvPOK(sv) \
7b2c381c 1715 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
c2f1de04 1716 (PL_Xpv->xpv_cur > 1 || \
339049b0 1717 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
a80f87c4
GS
1718 ? 1 \
1719 : 0) \
1720 : \
1721 SvIOK(sv) \
1722 ? SvIVX(sv) != 0 \
1723 : SvNOK(sv) \
1724 ? SvNVX(sv) != 0.0 \
1725 : sv_2bool(sv) )
396a5c01
FC
1726# define SvTRUE_nomg(sv) ( \
1727 !sv \
1728 ? 0 \
1729 : SvPOK(sv) \
1730 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
1731 (PL_Xpv->xpv_cur > 1 || \
1732 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
1733 ? 1 \
1734 : 0) \
1735 : \
1736 SvIOK(sv) \
1737 ? SvIVX(sv) != 0 \
1738 : SvNOK(sv) \
1739 ? SvNVX(sv) != 0.0 \
1740 : sv_2bool_flags(sv,0) )
3db8f154 1741# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
baca2b92
DM
1742#endif /* __GNU__ */
1743
fa819c1c
FC
1744#define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1745 (SVf_FAKE | SVf_READONLY) && !isGV_with_GP(sv))
46187eeb 1746#define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
baca2b92 1747
bdd68bc3
NC
1748#define SvSHARED_HEK_FROM_PV(pvx) \
1749 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
0a356b31 1750#define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
c158a4fd 1751
baca2b92
DM
1752/* flag values for sv_*_flags functions */
1753#define SV_IMMEDIATE_UNREF 1
1754#define SV_GMAGIC 2
765f542d 1755#define SV_COW_DROP_PV 4
88632417 1756#define SV_UTF8_NO_ENCODING 8
5fcdf167 1757#define SV_NOSTEAL 16
32a5c6ec
NC
1758#define SV_CONST_RETURN 32
1759#define SV_MUTABLE_RETURN 64
bddd5118 1760#define SV_SMAGIC 128
c1c21316 1761#define SV_HAS_TRAILING_NUL 256
34482cd6 1762#define SV_COW_SHARED_HASH_KEYS 512
cb23d5b1
NC
1763/* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1764#define SV_COW_OTHER_PVS 1024
9f621bb0
NC
1765/* Make sv_2pv_flags return NULL if something is undefined. */
1766#define SV_UNDEF_RETURNS_NULL 2048
b3ab6785
KW
1767/* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1768 * This is used when the caller has already determined it is, and avoids
1769 * redundant work */
1770#define SV_FORCE_UTF8_UPGRADE 4096
aee036bb
DM
1771/* if (after resolving magic etc), the SV is found to be overloaded,
1772 * don't call the overload magic, just return as-is */
1773#define SV_SKIP_OVERLOAD 8192
c682ebef
FC
1774/* It is not yet clear whether we want this as an API, or what the
1775 * constants should be named. */
1776#ifdef PERL_CORE
1777# define SV_CATBYTES 16384
1778# define SV_CATUTF8 32768
1779#endif
34482cd6
NC
1780
1781/* The core is safe for this COW optimisation. XS code on CPAN may not be.
1782 So only default to doing the COW setup if we're in the core.
1783 */
1784#ifdef PERL_CORE
1785# ifndef SV_DO_COW_SVSETSV
cb23d5b1 1786# define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
34482cd6
NC
1787# endif
1788#endif
1789
1790#ifndef SV_DO_COW_SVSETSV
1791# define SV_DO_COW_SVSETSV 0
1792#endif
1793
765f542d 1794
5abc721d
NC
1795#define sv_unref(sv) sv_unref_flags(sv, 0)
1796#define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
47518d95
NC
1797#define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1798#define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
174c73e3 1799
46187eeb
NC
1800/* We are about to replace the SV's current value. So if it's copy on write
1801 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1802 the value is about to get thrown away, so drop the PV rather than go to
1803 the effort of making a read-write copy only for it to get immediately
1804 discarded. */
765f542d
NC
1805
1806#define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1807 sv_force_normal_flags(sv, SV_COW_DROP_PV)
46187eeb 1808
f8c7b90f 1809#ifdef PERL_OLD_COPY_ON_WRITE
5302ffd4 1810#define SvRELEASE_IVX(sv) \
7a4bba22 1811 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
46187eeb 1812# define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
7a4bba22 1813# define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
b8f9541a 1814#else
7a4bba22
NC
1815# define SvRELEASE_IVX(sv) 0
1816/* This little game brought to you by the need to shut this warning up:
1204f081 1817mg.c: In function 'Perl_magic_get':
7a4bba22
NC
1818mg.c:1024: warning: left-hand operand of comma expression has no effect
1819*/
1820# define SvRELEASE_IVX_(sv) /**/
f8c7b90f 1821#endif /* PERL_OLD_COPY_ON_WRITE */
ed252734
NC
1822
1823#define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1824 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
dd2eae66 1825 SVf_OOK|SVf_BREAK|SVf_READONLY)
ed252734
NC
1826#define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1827
765f542d
NC
1828#define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1829 sv_force_normal_flags(sv, 0)
1830
1831
baca2b92
DM
1832/* all these 'functions' are now just macros */
1833
1834#define sv_pv(sv) SvPV_nolen(sv)
1835#define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1836#define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1837
1838#define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
b3ab6785 1839#define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
baca2b92
DM
1840#define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1841#define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
9dcc53ea 1842#define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
34482cd6
NC
1843#define sv_setsv(dsv, ssv) \
1844 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1845#define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
baca2b92
DM
1846#define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1847#define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
b347df82 1848#define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
baca2b92 1849#define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
b347df82
NC
1850#define sv_catpvn_mg(sv, sstr, slen) \
1851 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
baca2b92 1852#define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
cb2f1b7b
NC
1853#define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1854#define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1855#define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
baca2b92
DM
1856#define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1857#define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1858#define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
891f9566
YST
1859#define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1860#define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
39d5de13 1861#define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
078504b2 1862#define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
e8c9c9d4
NC
1863#define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1864#define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
078504b2 1865#define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
06c841cf 1866#define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
84335ee9
NC
1867#define sv_insert(bigstr, offset, len, little, littlelen) \
1868 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1869 (littlelen), SV_GMAGIC)
baca2b92 1870
db79b45b
JH
1871/* Should be named SvCatPVN_utf8_upgrade? */
1872#define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1873 STMT_START { \
1874 if (!(nsv)) \
ad25789c 1875 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
db79b45b
JH
1876 else \
1877 sv_setpvn(nsv, sstr, slen); \
1878 SvUTF8_off(nsv); \
1879 sv_utf8_upgrade(nsv); \
1880 sv_catsv(dsv, nsv); \
1881 } STMT_END
79072805 1882
954c1994
GS
1883/*
1884=for apidoc Am|SV*|newRV_inc|SV* sv
1885
1886Creates an RV wrapper for an SV. The reference count for the original SV is
1887incremented.
1888
1889=cut
1890*/
1891
5f05dabc 1892#define newRV_inc(sv) newRV(sv)
5f05dabc 1893
ef50df4b 1894/* the following macros update any magic values this sv is associated with */
79072805 1895
954c1994 1896/*
ccfc67b7
JH
1897=head1 Magical Functions
1898
954c1994
GS
1899=for apidoc Am|void|SvGETMAGIC|SV* sv
1900Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1901argument more than once.
1902
1903=for apidoc Am|void|SvSETMAGIC|SV* sv
1904Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1905argument more than once.
1906
1907=for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1908Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1909more than once.
1910
1911=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1912Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1913ssv. May evaluate arguments more than once.
1914
645c22ef
DM
1915=for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1916Like C<SvSetSV>, but does any set magic required afterwards.
1917
1918=for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
80663158 1919Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
645c22ef 1920
68795e93
NIS
1921=for apidoc Am|void|SvSHARE|SV* sv
1922Arranges for sv to be shared between threads if a suitable module
1923has been loaded.
1924
1925=for apidoc Am|void|SvLOCK|SV* sv
1926Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1927has been loaded.
1928
1929=for apidoc Am|void|SvUNLOCK|SV* sv
1930Releases a mutual exclusion lock on sv if a suitable module
1931has been loaded.
1932
ccfc67b7
JH
1933=head1 SV Manipulation Functions
1934
679ac26e 1935=for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
954c1994
GS
1936Expands the character buffer in the SV so that it has room for the
1937indicated number of bytes (remember to reserve space for an extra trailing
8cf8f3d1 1938NUL character). Calls C<sv_grow> to perform the expansion if necessary.
954c1994
GS
1939Returns a pointer to the character buffer.
1940
1941=cut
1942*/
1943
16c91539
BM
1944#define SvSHARE(sv) PL_sharehook(aTHX_ sv)
1945#define SvLOCK(sv) PL_lockhook(aTHX_ sv)
1946#define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
1947#define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
68795e93 1948
557fbd17 1949#define SvGETMAGIC(x) ((void)(SvGMAGICAL(x) && mg_get(x)))
189b2af5 1950#define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
79072805 1951
54310121 1952#define SvSetSV_and(dst,src,finally) \
189b2af5 1953 STMT_START { \
54310121
PP
1954 if ((dst) != (src)) { \
1955 sv_setsv(dst, src); \
1956 finally; \
189b2af5
GS
1957 } \
1958 } STMT_END
54310121 1959#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 1960 STMT_START { \
8ebc5c01 1961 if ((dst) != (src)) { \
34482cd6 1962 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
54310121 1963 finally; \
189b2af5
GS
1964 } \
1965 } STMT_END
79072805 1966
54310121 1967#define SvSetSV(dst,src) \
c9d716f7 1968 SvSetSV_and(dst,src,/*nothing*/;)
54310121 1969#define SvSetSV_nosteal(dst,src) \
c9d716f7 1970 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121
PP
1971
1972#define SvSetMagicSV(dst,src) \
4e3a8365 1973 SvSetSV_and(dst,src,SvSETMAGIC(dst))
54310121 1974#define SvSetMagicSV_nosteal(dst,src) \
4e3a8365 1975 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
54310121 1976
db79b45b 1977
1045810a 1978#if !defined(SKIP_DEBUGGING)
79072805 1979#define SvPEEK(sv) sv_peek(sv)
3967c732
JD
1980#else
1981#define SvPEEK(sv) ""
1982#endif
79072805 1983
5dc8bdac 1984#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
36477c24 1985
567f3b56
TC
1986/*
1987=for apidoc Am|SV *|boolSV|bool b
1988
1989Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
1990
1991See also C<PL_sv_yes> and C<PL_sv_no>.
1992
1993=cut
1994*/
1995
3280af22 1996#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 1997
79072805 1998#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
f7877b28
NC
1999/* If I give every macro argument a different name, then there won't be bugs
2000 where nested macros get confused. Been there, done that. */
2001#define isGV_with_GP(pwadak) \
2e5b91de 2002 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
f7877b28 2003 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2e5b91de 2004#define isGV_with_GP_on(sv) STMT_START { \
70ad9799
SP
2005 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2006 assert (!SvPOKp(sv)); \
2007 assert (!SvIOKp(sv)); \
2008 (SvFLAGS(sv) |= SVpgv_GP); \
2e5b91de
NC
2009 } STMT_END
2010#define isGV_with_GP_off(sv) STMT_START { \
70ad9799
SP
2011 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2012 assert (!SvPOKp(sv)); \
2013 assert (!SvIOKp(sv)); \
2e5b91de
NC
2014 (SvFLAGS(sv) &= ~SVpgv_GP); \
2015 } STMT_END
2016
79072805 2017
933fea7f 2018#define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
5902b6a9
NC
2019#define SvGROW_mutable(sv,len) \
2020 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
933fea7f 2021#define Sv_Grow sv_grow
3d35f11b 2022
a0739874
DM
2023#define CLONEf_COPY_STACKS 1
2024#define CLONEf_KEEP_PTR_TABLE 2
c43294b8 2025#define CLONEf_CLONE_HOST 4
0405e91e 2026#define CLONEf_JOIN_IN 8
a0739874 2027
8cf8f3d1 2028struct clone_params {
d2d73c3e
AB
2029 AV* stashes;
2030 UV flags;
59b40662 2031 PerlInterpreter *proto_perl;
1db366cc 2032 PerlInterpreter *new_perl;
d08d57ef 2033 AV *unreferenced;
8cf8f3d1 2034};
102d3b8a
NC
2035
2036/*
740cce10
NC
2037=for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2038
2039Creates a new SV and copies a string into it. If utf8 is true, calls
2040C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2041
2042=cut
2043*/
2044
2045#define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2046
2047/*
69240efd
NC
2048=for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2049
2050Reads into I<len> the offset from SvPVX back to the true start of the
2051allocated buffer, which will be non-zero if C<sv_chop> has been used to
2052efficiently remove characters from start of the buffer. Implemented as a
2053macro, which takes the address of I<len>, which must be of type C<STRLEN>.
2054Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
2055
2056=cut
2057*/
2058
2059#ifdef DEBUGGING
2060/* Does the bot know something I don't?
206110:28 <@Nicholas> metabatman
206210:28 <+meta> Nicholas: crash
2063*/
2064# define SvOOK_offset(sv, offset) STMT_START { \
2065 assert(sizeof(offset) == sizeof(STRLEN)); \
2066 if (SvOOK(sv)) { \
2067 const U8 *crash = (U8*)SvPVX_const(sv); \
2068 offset = *--crash; \
2069 if (!offset) { \
2070 crash -= sizeof(STRLEN); \
2071 Copy(crash, (U8 *)&offset, sizeof(STRLEN), U8); \
2072 } \
2073 { \
2074 /* Validate the preceding buffer's sentinels to \
2075 verify that no-one is using it. */ \
2076 const U8 *const bonk = (U8 *) SvPVX_const(sv) - offset; \
2077 while (crash > bonk) { \
2078 --crash; \
2079 assert (*crash == (U8)PTR2UV(crash)); \
2080 } \
2081 } \
2082 } else { \
2083 offset = 0; \
2084 } \
2085 } STMT_END
2086#else
2087 /* This is the same code, but avoids using any temporary variables: */
2088# define SvOOK_offset(sv, offset) STMT_START { \
2089 assert(sizeof(offset) == sizeof(STRLEN)); \
2090 if (SvOOK(sv)) { \
2091 offset = ((U8*)SvPVX_const(sv))[-1]; \
2092 if (!offset) { \
2093 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
2094 (U8 *)&offset, sizeof(STRLEN), U8); \
2095 } \
2096 } else { \
2097 offset = 0; \
2098 } \
2099 } STMT_END
2100#endif
85dca89a
NC
2101
2102#define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2103
69240efd 2104/*
102d3b8a
NC
2105 * Local variables:
2106 * c-indentation-style: bsd
2107 * c-basic-offset: 4
2108 * indent-tabs-mode: t
2109 * End:
2110 *
2111 * ex: set ts=8 sts=4 sw=4 noet:
2112 */