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