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