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