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