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