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