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