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