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