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