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