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