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