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