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