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