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