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