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