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