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