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