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