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