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