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