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