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