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