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