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