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