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