This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
improve SvPV_set's docs, it really shouldn't be public API
[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 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
JH
899
900=for apidoc Am|void|SvUTF8_on|SV *sv
1e54db1a 901Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
d5ce4a7c 902Do not use frivolously.
914184e1
JH
903
904=for apidoc Am|void|SvUTF8_off|SV *sv
3c813ed0
KW
905Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
906Do not use frivolously.
914184e1
JH
907
908=for apidoc Am|void|SvPOK_only_UTF8|SV* sv
d5ce4a7c 909Tells an SV that it is a string and disables all other OK bits,
1e54db1a 910and leaves the UTF-8 status as it was.
f1a1024e 911
914184e1
JH
912=cut
913 */
914
7a5fd60d
NC
915/* Ensure the return value of this macro does not clash with the GV_ADD* flags
916in gv.h: */
a7cb1f99
GS
917#define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
918#define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
919#define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
5bc28da9 920
79072805 921#define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
f7877b28 922#define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 923 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
8990e307 924#define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
f7877b28 925#define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
dd2eae66 926 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8
GS
927 SVf_IVisUV|SVf_UTF8), \
928 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
f7877b28 929#define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
dd2eae66 930 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8 931 SVf_IVisUV), \
a0d0e21e 932 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
79072805 933
4f2da183 934#define SvVOK(sv) (SvMAGICAL(sv) \
b0a11fe1
RGS
935 && mg_find(sv,PERL_MAGIC_vstring))
936/* returns the vstring magic, if any */
937#define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
4f2da183 938 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
b0a11fe1 939
79072805 940#define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
a4f658f7 941#define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
0c34ef67 942#define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
79072805 943
a0d0e21e
LW
944#define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
945#define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
946#define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
947
ed6116ce 948#define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
a0d0e21e 949#define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
dd2eae66 950#define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
79072805 951
8990e307
LW
952#define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
953#define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
954#define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
79072805 955
8990e307
LW
956#define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
957#define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
958#define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
ed6116ce 959
8990e307
LW
960#define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
961#define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
962#define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
ed6116ce 963
8990e307
LW
964#define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
965#define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
966#define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
ed6116ce 967
a1cd65be 968#define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
54c554f3 969 HvAMAGIC(SvSTASH(SvRV(sv))))
a0d0e21e 970
0adc25b0
FC
971/* To be used on the stashes themselves: */
972#define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
973#define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
974#define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
975
4bac9ae4 976
1078c6a2 977/* "nog" means "doesn't have get magic" */
4bac9ae4
CS
978#define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
979#define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
980#define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
981#define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
982#define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
983
984#define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
985#define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
986#define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
987#define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
988#define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
989
990#define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
991#define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
992
993#define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
994#define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
995
8bb025ae
CS
996#define SvPOK_pure_nogthink(sv) \
997 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
998#define SvPOK_utf8_pure_nogthink(sv) \
999 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
1000#define SvPOK_byte_pure_nogthink(sv) \
1001 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
1002
d34786ba 1003/*
458b44e7 1004=for apidoc Am|U32|SvGAMAGIC|SV* sv
d34786ba 1005
8554e7a0
FC
1006Returns true if the SV has get magic or
1007overloading. If either is true then
d34786ba 1008the scalar is active data, and has the potential to return a new value every
8554e7a0
FC
1009time it is accessed. Hence you must be careful to
1010only read it once per user logical operation and work
1011with that returned value. If neither is true then
d34786ba
NC
1012the scalar's value cannot change unless written to.
1013
1014=cut
1015*/
1016
dd2eae66 1017#define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1426bbf4 1018
9299023c 1019#define Gv_AMG(stash) \
d3c7a87b
FC
1020 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
1021 ? 1 \
1022 : (HvAMAGIC_off(stash), 0))
a0d0e21e 1023
810b8aa5
GS
1024#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
1025 == (SVf_ROK|SVprv_WEAKREF))
1026#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
1027#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
1028
1ccdb730
NC
1029#define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
1030 == (SVf_ROK|SVprv_PCS_IMPORTED))
1031#define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
1032#define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
1033
a11eaecb
FC
1034/*
1035=for apidoc m|U32|SvTHINKFIRST|SV *sv
1036
1037A quick flag check to see whether an sv should be passed to sv_force_normal
1038to be "downgraded" before SvIVX or SvPVX can be modified directly.
1039
1040For example, if your scalar is a reference and you want to modify the SvIVX
1041slot, you can't just do SvROK_off, as that will leak the referent.
1042
1043This is used internally by various sv-modifying functions, such as
1044sv_setsv, sv_setiv and sv_pvn_force.
1045
1046One case that this does not handle is a gv without SvFAKE set. After
1047
1048 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
1049
1050it will still be a gv.
1051
1052SvTHINKFIRST sometimes produces false positives. In those cases
1053sv_force_normal does nothing.
1054
1055=cut
1056*/
1057
a0d0e21e 1058#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 1059
c0683843
FC
1060#define SVs_PADMY 0
1061#define SvPADMY(sv) !(SvFLAGS(sv) & SVs_PADTMP)
145bf8ee
FC
1062#ifndef PERL_CORE
1063# define SvPADMY_on(sv) SvPADTMP_off(sv)
1064#endif
d9d18af6 1065
c0683843
FC
1066#define SvPADTMP(sv) (SvFLAGS(sv) & (SVs_PADTMP))
1067#define SvPADSTALE(sv) (SvFLAGS(sv) & (SVs_PADSTALE))
62bb6514 1068
145bf8ee
FC
1069#define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
1070#define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
541377b1
FC
1071#define SvPADSTALE_on(sv) S_SvPADSTALE_on(MUTABLE_SV(sv))
1072#define SvPADSTALE_off(sv) S_SvPADSTALE_off(MUTABLE_SV(sv))
ed6116ce 1073
8990e307
LW
1074#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1075#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1076#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 1077
8990e307
LW
1078#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1079#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1080#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 1081
a623f893
FC
1082#define SvREADONLY(sv) (SvFLAGS(sv) & (SVf_READONLY|SVf_PROTECT))
1083#ifdef PERL_CORE
1084# define SvREADONLY_on(sv) (SvFLAGS(sv) |= (SVf_READONLY|SVf_PROTECT))
1085# define SvREADONLY_off(sv) (SvFLAGS(sv) &=~(SVf_READONLY|SVf_PROTECT))
1086#else
1087# define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1088# define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
1089#endif
79072805 1090
180488f8 1091#define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
8990e307
LW
1092#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1093#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 1094
74e0ddf7
NC
1095#ifndef PERL_CORE
1096# define SvCOMPILED(sv) 0
1097# define SvCOMPILED_on(sv)
1098# define SvCOMPILED_off(sv)
1099#endif
79072805 1100
25da4f38
IZ
1101#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1102#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1103#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1104
85efc3a5 1105#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
e9726144 1106# define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
654c0d3f 1107 if (SvFLAGS(_svvalid) & SVpbm_VALID && !SvSCREAM(_svvalid)) \
e5ae200f
RU
1108 assert(!isGV_with_GP(_svvalid)); \
1109 (SvFLAGS(_svvalid) & SVpbm_VALID); \
85ffbbb0 1110 })
b1bc3f34 1111# define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
e5ae200f 1112 assert(!isGV_with_GP(_svvalid)); \
654c0d3f 1113 assert(!SvSCREAM(_svvalid)); \
e5ae200f 1114 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
85ffbbb0 1115 })
b1bc3f34 1116# define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
e5ae200f 1117 assert(!isGV_with_GP(_svvalid)); \
654c0d3f 1118 assert(!SvSCREAM(_svvalid)); \
e5ae200f 1119 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
85ffbbb0
NC
1120 })
1121
e9726144 1122# define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
654c0d3f
RU
1123 assert(SvTYPE(_svtail) != SVt_PVAV); \
1124 assert(SvTYPE(_svtail) != SVt_PVHV); \
1125 assert(!SvSCREAM(_svtail)); \
78d0cf80
NC
1126 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
1127 == (SVpbm_TAIL|SVpbm_VALID); \
85efc3a5
NC
1128 })
1129#else
654c0d3f 1130# define SvVALID(sv) ((SvFLAGS(sv) & SVpbm_VALID) && !SvSCREAM(sv))
85ffbbb0
NC
1131# define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1132# define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
78d0cf80 1133# define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
fe901688 1134 == (SVpbm_TAIL|SVpbm_VALID))
78d0cf80 1135
85efc3a5 1136#endif
8990e307
LW
1137#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1138#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1139
ed6116ce
LW
1140#define SvRVx(sv) SvRV(sv)
1141
f599b64b 1142#ifdef PERL_DEBUG_COW
8ed30cc1
DD
1143/* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1144 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
771ba71a
NC
1145# define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1146# define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
58430790 1147# define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
ac09da3b 1148# define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
f19a12a3 1149# define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
c0e1089a 1150/* Don't test the core XS code yet. */
771ba71a 1151# if defined (PERL_CORE) && PERL_DEBUG_COW > 1
c7724415 1152# define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
771ba71a
NC
1153# else
1154# define SvPVX(sv) SvPVX_mutable(sv)
1155# endif
771ba71a
NC
1156# define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1157# define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1158# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1159
c7724415
FC
1160# define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1161# define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
f599b64b 1162#else
771ba71a
NC
1163# define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1164# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1165
05ef5f8f
NC
1166# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1167/* These get expanded inside other macros that already use a variable _sv */
f7877b28 1168# define SvPVX(sv) \
d2c6dc5e 1169 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
f1fb8741 1170 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
e5ae200f 1171 assert(!isGV_with_GP(_svpvx)); \
5bb89d25
NC
1172 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1173 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
e5ae200f 1174 &((_svpvx)->sv_u.svu_pv); \
f7877b28 1175 }))
08002bbf 1176# define SvCUR(sv) \
b1bc3f34 1177 (*({ const SV *const _svcur = (const SV *)(sv); \
8d919b0a
FC
1178 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK] \
1179 || SvTYPE(_svcur) == SVt_REGEXP); \
e5ae200f 1180 assert(!isGV_with_GP(_svcur)); \
6f7e8353
NC
1181 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1182 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
b1bc3f34 1183 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
08002bbf 1184 }))
05ef5f8f 1185# define SvIVX(sv) \
b1bc3f34 1186 (*({ const SV *const _svivx = (const SV *)(sv); \
f1fb8741 1187 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
e5ae200f 1188 assert(!isGV_with_GP(_svivx)); \
b1bc3f34 1189 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
05ef5f8f
NC
1190 }))
1191# define SvUVX(sv) \
b1bc3f34 1192 (*({ const SV *const _svuvx = (const SV *)(sv); \
f1fb8741 1193 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
e5ae200f 1194 assert(!isGV_with_GP(_svuvx)); \
b1bc3f34 1195 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
05ef5f8f
NC
1196 }))
1197# define SvNVX(sv) \
b1bc3f34 1198 (*({ const SV *const _svnvx = (const SV *)(sv); \
f1fb8741 1199 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
e5ae200f 1200 assert(!isGV_with_GP(_svnvx)); \
b1bc3f34 1201 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
05ef5f8f 1202 }))
ac09da3b 1203# define SvRV(sv) \
f19a12a3 1204 (*({ SV *const _svrv = MUTABLE_SV(sv); \
f1fb8741 1205 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
e5ae200f 1206 assert(!isGV_with_GP(_svrv)); \
6f7e8353
NC
1207 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1208 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
e5ae200f 1209 &((_svrv)->sv_u.svu_rv); \
ac09da3b 1210 }))
f19a12a3
MHM
1211# define SvRV_const(sv) \
1212 ({ const SV *const _svrv = (const SV *)(sv); \
f1fb8741 1213 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
f19a12a3 1214 assert(!isGV_with_GP(_svrv)); \
6f7e8353
NC
1215 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1216 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
f19a12a3
MHM
1217 (_svrv)->sv_u.svu_rv; \
1218 })
05ef5f8f 1219# define SvMAGIC(sv) \
b1bc3f34 1220 (*({ const SV *const _svmagic = (const SV *)(sv); \
e5ae200f 1221 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
b1bc3f34 1222 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
05ef5f8f
NC
1223 }))
1224# define SvSTASH(sv) \
b1bc3f34 1225 (*({ const SV *const _svstash = (const SV *)(sv); \
e5ae200f 1226 assert(SvTYPE(_svstash) >= SVt_PVMG); \
b1bc3f34 1227 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
05ef5f8f 1228 }))
03687789 1229# else
08002bbf
NC
1230# define SvPVX(sv) ((sv)->sv_u.svu_pv)
1231# define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
05ef5f8f
NC
1232# define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1233# define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
58430790 1234# define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
ac09da3b 1235# define SvRV(sv) ((sv)->sv_u.svu_rv)
f19a12a3 1236# define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
e736a858 1237# define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
771ba71a 1238# define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
03687789 1239# endif
62703e72
NC
1240#endif
1241
06c0cc96 1242#ifndef PERL_POISON
bb496845
SP
1243/* Given that these two are new, there can't be any existing code using them
1244 * as LVALUEs */
06c0cc96
NC
1245# define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1246# define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1247#else
1248/* Except for the poison code, which uses & to scribble over the pointer after
1249 free() is called. */
1250# define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1251# define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1252#endif
bb496845 1253
62703e72
NC
1254#define SvIVXx(sv) SvIVX(sv)
1255#define SvUVXx(sv) SvUVX(sv)
1256#define SvNVXx(sv) SvNVX(sv)
1257#define SvPVXx(sv) SvPVX(sv)
1258#define SvLENx(sv) SvLEN(sv)
1259#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1260
1261
28e5dec8
JH
1262/* Ask a scalar nicely to try to become an IV, if possible.
1263 Not guaranteed to stay returning void */
1264/* Macro won't actually call sv_2iv if already IOK */
1265#define SvIV_please(sv) \
3ea8bc93 1266 STMT_START {if (!SvIOKp(sv) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK))) \
28e5dec8 1267 (void) SvIV(sv); } STMT_END
6f1401dc 1268#define SvIV_please_nomg(sv) \
3ea8bc93
DD
1269 (!(SvFLAGS(sv) & (SVf_IOK|SVp_IOK)) && (SvFLAGS(sv) & (SVf_NOK|SVf_POK)) \
1270 ? (sv_2iv_flags(sv, 0), SvIOK(sv)) \
8a68f328 1271 : SvIOK(sv))
79072805 1272#define SvIV_set(sv, val) \
f1fb8741
DM
1273 STMT_START { \
1274 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1275 assert(!isGV_with_GP(sv)); \
b19bbeda 1276 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
79072805 1277#define SvNV_set(sv, val) \
f1fb8741
DM
1278 STMT_START { \
1279 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1280 assert(!isGV_with_GP(sv)); \
58430790 1281 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
79072805 1282#define SvPV_set(sv, val) \
f1fb8741
DM
1283 STMT_START { \
1284 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1285 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1286 assert(!(SvTYPE(sv) == SVt_PVIO \
1287 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
339049b0 1288 ((sv)->sv_u.svu_pv = (val)); } STMT_END
607fa7f2 1289#define SvUV_set(sv, val) \
f1fb8741
DM
1290 STMT_START { \
1291 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1292 assert(!isGV_with_GP(sv)); \
607fa7f2 1293 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
b162af07 1294#define SvRV_set(sv, val) \
f1fb8741
DM
1295 STMT_START { \
1296 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1297 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1298 assert(!(SvTYPE(sv) == SVt_PVIO \
1299 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
339049b0 1300 ((sv)->sv_u.svu_rv = (val)); } STMT_END
b162af07
SP
1301#define SvMAGIC_set(sv, val) \
1302 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
e736a858 1303 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
b162af07
SP
1304#define SvSTASH_set(sv, val) \
1305 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1306 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
79072805 1307#define SvCUR_set(sv, val) \
f1fb8741 1308 STMT_START { \
8d919b0a
FC
1309 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK] \
1310 || SvTYPE(sv) == SVt_REGEXP); \
08002bbf 1311 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1312 assert(!(SvTYPE(sv) == SVt_PVIO \
1313 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
b162af07 1314 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
79072805 1315#define SvLEN_set(sv, val) \
f1fb8741
DM
1316 STMT_START { \
1317 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
f7877b28 1318 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1319 assert(!(SvTYPE(sv) == SVt_PVIO \
1320 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
b162af07 1321 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
7ae8ee9e
NC
1322#define SvEND_set(sv, val) \
1323 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
3ec35e0f 1324 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
79072805 1325
b7e9a5c2 1326#define SvPV_renew(sv,n) \
1da4ca5f
NC
1327 STMT_START { SvLEN_set(sv, n); \
1328 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1329 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1330 (MEM_SIZE)((n))))); \
1331 } STMT_END
1332
1333#define SvPV_shrink_to_cur(sv) STMT_START { \
1334 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1335 SvPV_renew(sv, _lEnGtH); \
1336 } STMT_END
b7e9a5c2 1337
771ba71a
NC
1338#define SvPV_free(sv) \
1339 STMT_START { \
1340 assert(SvTYPE(sv) >= SVt_PV); \
1341 if (SvLEN(sv)) { \
e537ac38 1342 assert(!SvROK(sv)); \
5d9574c1 1343 if(UNLIKELY(SvOOK(sv))) { \
69240efd
NC
1344 STRLEN zok; \
1345 SvOOK_offset(sv, zok); \
1346 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
771ba71a
NC
1347 SvFLAGS(sv) &= ~SVf_OOK; \
1348 } \
1349 Safefree(SvPVX(sv)); \
1350 } \
1351 } STMT_END
8bd4d4c5 1352
43230e26
NC
1353#ifdef PERL_CORE
1354/* Code that crops up in three places to take a scalar and ready it to hold
1355 a reference */
1356# define prepare_SV_for_RV(sv) \
1357 STMT_START { \
1358 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1359 sv_upgrade(sv, SVt_IV); \
662f1f9e 1360 else if (SvTYPE(sv) >= SVt_PV) { \
43230e26
NC
1361 SvPV_free(sv); \
1362 SvLEN_set(sv, 0); \
1363 SvCUR_set(sv, 0); \
1364 } \
1365 } STMT_END
1366#endif
373b357f 1367
cffe132d
NC
1368#ifndef PERL_CORE
1369# define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1370#endif
6976cee3 1371
60c8298a 1372#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
60c8298a 1373# define BmUSEFUL(sv) \
b1bc3f34 1374 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
408dc2ec 1375 assert(SvTYPE(_bmuseful) >= SVt_PVIV); \
e5ae200f 1376 assert(SvVALID(_bmuseful)); \
408dc2ec
NC
1377 assert(!SvIOK(_bmuseful)); \
1378 &(((XPVIV*) SvANY(_bmuseful))->xiv_u.xivu_iv); \
8eeaf79a 1379 }))
60c8298a 1380#else
50c7be83 1381# define BmUSEFUL(sv) ((XPVIV*) SvANY(sv))->xiv_u.xivu_iv
b4f6c04b 1382
60c8298a 1383#endif
79072805 1384
8922e438
FC
1385#ifndef PERL_CORE
1386# define BmRARE(sv) 0
1387# define BmPREVIOUS(sv) 0
1388#endif
1389
f2da823f 1390#define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
79072805
LW
1391
1392#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1393#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1394#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
bbfdc870 1395#define LvSTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff_u.xlvu_stargoff
79072805 1396#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
83f78d1a 1397#define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
79072805 1398
6f7e8353 1399#define IoIFP(sv) (sv)->sv_u.svu_fp
8990e307
LW
1400#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1401#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
4755096e 1402#define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
c490b21c 1403#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
8990e307
LW
1404#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1405#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1406#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1407#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1408#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1409#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1410#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1411#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1412#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
8990e307
LW
1413#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1414#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1415
50952442 1416/* IoTYPE(sv) is a single character telling the type of I/O connection. */
3b6c1aba
JH
1417#define IoTYPE_RDONLY '<'
1418#define IoTYPE_WRONLY '>'
1419#define IoTYPE_RDWR '+'
1420#define IoTYPE_APPEND 'a'
1421#define IoTYPE_PIPE '|'
1422#define IoTYPE_STD '-' /* stdin or stdout */
1423#define IoTYPE_SOCKET 's'
1424#define IoTYPE_CLOSED ' '
1425#define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1426#define IoTYPE_NUMERIC '#' /* fdopen */
03fcf2fc
GS
1427
1428/*
954c1994 1429=for apidoc Am|bool|SvTAINTED|SV* sv
8554e7a0 1430Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
954c1994
GS
1431not.
1432
1433=for apidoc Am|void|SvTAINTED_on|SV* sv
c55831ac 1434Marks an SV as tainted if tainting is enabled.
954c1994
GS
1435
1436=for apidoc Am|void|SvTAINTED_off|SV* sv
8554e7a0
FC
1437Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1438some of Perl's fundamental security features. XS module authors should not
954c1994 1439use this function unless they fully understand all the implications of
72d33970 1440unconditionally untainting the value. Untainting should be done in the
954c1994
GS
1441standard perl fashion, via a carefully crafted regexp, rather than directly
1442untainting variables.
1443
1444=for apidoc Am|void|SvTAINT|SV* sv
c98cdb04
FC
1445Taints an SV if tainting is enabled, and if some input to the current
1446expression is tainted--usually a variable, but possibly also implicit
1447inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1448the outputs of an expression in a pessimistic fashion; i.e., without paying
1449attention to precisely which outputs are influenced by which inputs.
954c1994
GS
1450
1451=cut
1452*/
1453
a0714e2c 1454#define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
aae9cea0 1455
dc6d7f5c 1456#ifdef NO_TAINT_SUPPORT
284167a5
S
1457# define SvTAINTED(sv) 0
1458#else
1459# define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
1460#endif
5d9574c1
DM
1461#define SvTAINTED_on(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_taint(sv);} }STMT_END
1462#define SvTAINTED_off(sv) STMT_START{ if(UNLIKELY(TAINTING_get)){sv_untaint(sv);} }STMT_END
bbce6d69 1463
c6ee37c5
MB
1464#define SvTAINT(sv) \
1465 STMT_START { \
5d9574c1
DM
1466 if (UNLIKELY(TAINTING_get)) { \
1467 if (UNLIKELY(TAINT_get)) \
c6ee37c5
MB
1468 SvTAINTED_on(sv); \
1469 } \
1470 } STMT_END
79072805 1471
954c1994
GS
1472/*
1473=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
8bb025ae 1474Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
fd142383 1475only a string (C<SvPOK_only>), by hook or by crook. You need force if you are
8bb025ae 1476going to update the C<SvPVX> directly. Processes get magic.
954c1994 1477
fd142383 1478Note that coercing an arbitrary scalar into a plain PV will potentially
72d33970 1479strip useful data from it. For example if the SV was C<SvROK>, then the
fd142383
DM
1480referent will have its reference count decremented, and the SV itself may
1481be converted to an C<SvPOK> scalar with a string buffer containing a value
1482such as C<"ARRAY(0x1234)">.
1483
645c22ef 1484=for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
fd142383 1485Like C<SvPV_force>, but doesn't process get magic.
645c22ef 1486
954c1994 1487=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
5f08bad4
ST
1488Returns a pointer to the string in the SV, or a stringified form of
1489the SV if the SV does not contain a string. The SV may cache the
cfe3322a
DG
1490stringified version becoming C<SvPOK>. Handles 'get' magic. The
1491C<len> variable will be set to the length of the string (this is a macro, so
7e234f81 1492don't use C<&len>). See also C<SvPVx> for a version which guarantees to
cfe3322a 1493evaluate sv only once.
645c22ef 1494
fd142383 1495Note that there is no guarantee that the return value of C<SvPV()> is
fe02ddb7 1496equal to C<SvPVX(sv)>, or that C<SvPVX(sv)> contains valid data, or that
c07def6d 1497successive calls to C<SvPV(sv)> will return the same pointer value each
72d33970 1498time. This is due to the way that things like overloading and
fe02ddb7
DM
1499Copy-On-Write are handled. In these cases, the return value may point to
1500a temporary buffer or similar. If you absolutely need the SvPVX field to
1501be valid (for example, if you intend to write to it), then see
1502L</SvPV_force>.
fd142383 1503
645c22ef 1504=for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
4ea561bc
NC
1505A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1506Only use this if C<sv> is an expression with side effects, otherwise use the
b3adf4c0 1507more efficient C<SvPV>.
954c1994 1508
891f9566
YST
1509=for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1510Like C<SvPV> but doesn't process magic.
1511
954c1994 1512=for apidoc Am|char*|SvPV_nolen|SV* sv
fd142383 1513Like C<SvPV> but doesn't set a length variable.
954c1994 1514
71eb6d8c
TC
1515=for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1516Like C<SvPV_nolen> but doesn't process magic.
1517
954c1994 1518=for apidoc Am|IV|SvIV|SV* sv
8554e7a0 1519Coerces the given SV to an integer and returns it. See C<SvIVx> for a
645c22ef
DM
1520version which guarantees to evaluate sv only once.
1521
891f9566
YST
1522=for apidoc Am|IV|SvIV_nomg|SV* sv
1523Like C<SvIV> but doesn't process magic.
1524
645c22ef 1525=for apidoc Am|IV|SvIVx|SV* sv
8554e7a0
FC
1526Coerces the given SV to an integer and returns it.
1527Guarantees to evaluate C<sv> only once. Only use
1528this if C<sv> is an expression with side effects,
4ea561bc 1529otherwise use the more efficient C<SvIV>.
954c1994
GS
1530
1531=for apidoc Am|NV|SvNV|SV* sv
8554e7a0 1532Coerce the given SV to a double and return it. See C<SvNVx> for a version
645c22ef
DM
1533which guarantees to evaluate sv only once.
1534
6f1401dc
DM
1535=for apidoc Am|NV|SvNV_nomg|SV* sv
1536Like C<SvNV> but doesn't process magic.
1537
645c22ef 1538=for apidoc Am|NV|SvNVx|SV* sv
8554e7a0
FC
1539Coerces the given SV to a double and returns it.
1540Guarantees to evaluate C<sv> only once. Only use
1541this if C<sv> is an expression with side effects,
4ea561bc 1542otherwise use the more efficient C<SvNV>.
954c1994
GS
1543
1544=for apidoc Am|UV|SvUV|SV* sv
645c22ef
DM
1545Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1546for a version which guarantees to evaluate sv only once.
1547
891f9566
YST
1548=for apidoc Am|UV|SvUV_nomg|SV* sv
1549Like C<SvUV> but doesn't process magic.
1550
645c22ef 1551=for apidoc Am|UV|SvUVx|SV* sv
8554e7a0 1552Coerces the given SV to an unsigned integer and
feba1f01 1553returns it. Guarantees to evaluate C<sv> only once. Only
8554e7a0 1554use this if C<sv> is an expression with side effects,
4ea561bc 1555otherwise use the more efficient C<SvUV>.
954c1994
GS
1556
1557=for apidoc Am|bool|SvTRUE|SV* sv
1558Returns a boolean indicating whether Perl would evaluate the SV as true or
06c841cf
FC
1559false. See SvOK() for a defined/undefined test. Handles 'get' magic
1560unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
1561private flags).
1562
1563=for apidoc Am|bool|SvTRUE_nomg|SV* sv
1564Returns a boolean indicating whether Perl would evaluate the SV as true or
c0b6140e 1565false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
954c1994 1566
645c22ef 1567=for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
b70b15d2 1568Like C<SvPV_force>, but converts sv to utf8 first if necessary.
645c22ef
DM
1569
1570=for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
b70b15d2 1571Like C<SvPV>, but converts sv to utf8 first if necessary.
645c22ef 1572
b70b15d2
TJ
1573=for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1574Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
645c22ef
DM
1575
1576=for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1577Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1578
1579=for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1580Like C<SvPV>, but converts sv to byte representation first if necessary.
1581
b70b15d2 1582=for apidoc Am|char*|SvPVbyte_nolen|SV* sv
645c22ef
DM
1583Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1584
1585=for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
b70b15d2 1586Like C<SvPV_force>, but converts sv to utf8 first if necessary.
d1be9408 1587Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
645c22ef
DM
1588otherwise.
1589
1590=for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
b70b15d2 1591Like C<SvPV>, but converts sv to utf8 first if necessary.
d1be9408 1592Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
645c22ef
DM
1593otherwise.
1594
1595=for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1596Like C<SvPV_force>, but converts sv to byte representation first if necessary.
d1be9408 1597Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
645c22ef
DM
1598otherwise.
1599
1600=for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1601Like C<SvPV>, but converts sv to byte representation first if necessary.
d1be9408 1602Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
645c22ef
DM
1603otherwise.
1604
df8dcb28
DD
1605=for apidoc Am|U32|SvIsCOW|SV* sv
1606Returns a U32 value indicating whether the SV is Copy-On-Write (either shared
19dbb8f1 1607hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
8554e7a0 1608COW).
19dbb8f1
NC
1609
1610=for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1611Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1612scalar.
645c22ef 1613
0f76ff59
MHM
1614=for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1615Like C<sv_catpvn> but doesn't process magic.
1616
9dcc53ea
Z
1617=for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1618Like C<sv_catpv> but doesn't process magic.
1619
0f76ff59
MHM
1620=for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1621Like C<sv_setsv> but doesn't process magic.
1622
1623=for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1624Like C<sv_catsv> but doesn't process magic.
1625
dc960812
SP
1626=for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1627
8554e7a0 1628Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
dc960812 1629
954c1994
GS
1630=cut
1631*/
1632
25da4f38 1633/* Let us hope that bitmaps for UV and IV are the same */
4bac9ae4
CS
1634#define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1635#define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1636#define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 1637
891f9566
YST
1638#define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1639#define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
6f1401dc 1640#define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
891f9566 1641
baca2b92 1642/* ----*/
8d6d96c1 1643
4bac9ae4
CS
1644#define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1645#define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
44d22300 1646#define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
8d6d96c1 1647
8d6d96c1 1648#define SvPV_flags(sv, lp, flags) \
4bac9ae4 1649 (SvPOK_nog(sv) \
8d6d96c1 1650 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
32a5c6ec 1651#define SvPV_flags_const(sv, lp, flags) \
4bac9ae4 1652 (SvPOK_nog(sv) \
32a5c6ec 1653 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
c77ed9ca 1654 (const char*) sv_2pv_flags(sv, &lp, (flags|SV_CONST_RETURN)))
2596d9fe 1655#define SvPV_flags_const_nolen(sv, flags) \
4bac9ae4 1656 (SvPOK_nog(sv) \
2596d9fe 1657 ? SvPVX_const(sv) : \
c77ed9ca 1658 (const char*) sv_2pv_flags(sv, 0, (flags|SV_CONST_RETURN)))
44d22300 1659#define SvPV_flags_mutable(sv, lp, flags) \
4bac9ae4 1660 (SvPOK_nog(sv) \
44d22300 1661 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
c77ed9ca 1662 sv_2pv_flags(sv, &lp, (flags|SV_MUTABLE_RETURN)))
79072805 1663
8d6d96c1 1664#define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
13c5b33c 1665#define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
32a5c6ec 1666#define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
baca2b92 1667
8d6d96c1 1668#define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
2596d9fe 1669#define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
8d6d96c1 1670
8d6d96c1 1671#define SvPV_force_flags(sv, lp, flags) \
8bb025ae 1672 (SvPOK_pure_nogthink(sv) \
4bac9ae4
CS
1673 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1674
13c5b33c 1675#define SvPV_force_flags_nolen(sv, flags) \
8bb025ae 1676 (SvPOK_pure_nogthink(sv) \
4bac9ae4
CS
1677 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1678
32a5c6ec 1679#define SvPV_force_flags_mutable(sv, lp, flags) \
8bb025ae 1680 (SvPOK_pure_nogthink(sv) \
4bac9ae4 1681 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
32a5c6ec 1682 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
a0d0e21e 1683
1fa8b10d 1684#define SvPV_nolen(sv) \
4bac9ae4 1685 (SvPOK_nog(sv) \
dafda6d1 1686 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
70401c6b 1687
0334097d 1688/* "_nomg" in these defines means no mg_get() */
71eb6d8c 1689#define SvPV_nomg_nolen(sv) \
4bac9ae4 1690 (SvPOK_nog(sv) \
71eb6d8c
TC
1691 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1692
9ce348e8 1693#define SvPV_nolen_const(sv) \
4bac9ae4 1694 (SvPOK_nog(sv) \
9ce348e8
NC
1695 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1696
baca2b92 1697#define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
9ce348e8 1698#define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
2596d9fe 1699#define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
5bc28da9 1700
baca2b92 1701/* ----*/
70401c6b 1702
5bc28da9 1703#define SvPVutf8(sv, lp) \
4bac9ae4 1704 (SvPOK_utf8_nog(sv) \
5bc28da9 1705 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 1706
5bc28da9 1707#define SvPVutf8_force(sv, lp) \
8bb025ae 1708 (SvPOK_utf8_pure_nogthink(sv) \
5bc28da9
NIS
1709 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1710
5bc28da9 1711#define SvPVutf8_nolen(sv) \
4bac9ae4 1712 (SvPOK_utf8_nog(sv) \
dafda6d1 1713 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
70401c6b 1714
baca2b92
DM
1715/* ----*/
1716
5bc28da9 1717#define SvPVbyte(sv, lp) \
4bac9ae4 1718 (SvPOK_byte_nog(sv) \
5bc28da9 1719 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
70401c6b 1720
5bc28da9 1721#define SvPVbyte_force(sv, lp) \
8bb025ae 1722 (SvPOK_byte_pure_nogthink(sv) \
a7ec4e2e 1723 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
5bc28da9 1724
5bc28da9 1725#define SvPVbyte_nolen(sv) \
4bac9ae4 1726 (SvPOK_byte_nog(sv) \
dafda6d1 1727 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
70401c6b 1728
baca2b92
DM
1729
1730/* define FOOx(): idempotent versions of FOO(). If possible, use a local
1731 * var to evaluate the arg once; failing that, use a global if possible;
1732 * failing that, call a function to do the work
1733 */
1734
1735#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1736#define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1737#define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1738
5d9574c1
DM
1739#define SvTRUE(sv) (LIKELY(sv) && (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))))
1740#define SvTRUE_nomg(sv) (LIKELY(sv) && ( SvTRUE_common(sv, sv_2bool_nomg(sv))))
1741#define SvTRUE_NN(sv) (UNLIKELY(SvGMAGICAL(sv)) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv)))
716ae3b0 1742#define SvTRUE_nomg_NN(sv) ( SvTRUE_common(sv, sv_2bool_nomg(sv)))
4bac9ae4
CS
1743#define SvTRUE_common(sv,fallback) ( \
1744 !SvOK(sv) \
1745 ? 0 \
762dbf22
FC
1746 : SvPOK(sv) \
1747 ? SvPVXtrue(sv) \
1748 : (SvFLAGS(sv) & (SVf_IOK|SVf_NOK)) \
1749 ? ( (SvIOK(sv) && SvIVX(sv) != 0) \
659c4b96 1750 || (SvNOK(sv) && SvNVX(sv) != 0.0)) \
4bac9ae4
CS
1751 : (fallback))
1752
5dc8bdac 1753#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
baca2b92 1754
b1bc3f34
NC
1755# define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1756# define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1757# define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
3de3296f 1758# define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
32a5c6ec 1759# define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
002e4c74 1760# define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
9ce348e8 1761# define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
3de3296f
AE
1762# define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1763# define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
002e4c74 1764# define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
4bac9ae4
CS
1765# define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1766# define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
baca2b92 1767
a80f87c4 1768#else /* __GNUC__ */
baca2b92 1769
a80f87c4
GS
1770/* These inlined macros use globals, which will require a thread
1771 * declaration in user code, so we avoid them under threads */
1772
3db8f154
MB
1773# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1774# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1775# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1776# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
32a5c6ec 1777# define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
002e4c74 1778# define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
5f1478c3 1779# define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
3db8f154
MB
1780# define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1781# define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
002e4c74 1782# define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
4bac9ae4
CS
1783# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1784# define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
baca2b92
DM
1785#endif /* __GNU__ */
1786
630b72b0
DD
1787#define SvPVXtrue(sv) ( \
1788 ((XPV*)SvANY((sv))) \
1789 && ( \
1790 ((XPV*)SvANY((sv)))->xpv_cur > 1 \
1791 || ( \
1792 ((XPV*)SvANY((sv)))->xpv_cur \
1793 && *(sv)->sv_u.svu_pv != '0' \
1794 ) \
1795 ) \
1796)
1797
e3918bb7
FC
1798#define SvIsCOW(sv) (SvFLAGS(sv) & SVf_IsCOW)
1799#define SvIsCOW_on(sv) (SvFLAGS(sv) |= SVf_IsCOW)
1800#define SvIsCOW_off(sv) (SvFLAGS(sv) &= ~SVf_IsCOW)
46187eeb 1801#define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
baca2b92 1802
bdd68bc3
NC
1803#define SvSHARED_HEK_FROM_PV(pvx) \
1804 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
0a356b31 1805#define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
c158a4fd 1806
baca2b92
DM
1807/* flag values for sv_*_flags functions */
1808#define SV_IMMEDIATE_UNREF 1
1809#define SV_GMAGIC 2
765f542d 1810#define SV_COW_DROP_PV 4
88632417 1811#define SV_UTF8_NO_ENCODING 8
5fcdf167 1812#define SV_NOSTEAL 16
32a5c6ec
NC
1813#define SV_CONST_RETURN 32
1814#define SV_MUTABLE_RETURN 64
bddd5118 1815#define SV_SMAGIC 128
c1c21316 1816#define SV_HAS_TRAILING_NUL 256
34482cd6 1817#define SV_COW_SHARED_HASH_KEYS 512
cb23d5b1
NC
1818/* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1819#define SV_COW_OTHER_PVS 1024
9f621bb0
NC
1820/* Make sv_2pv_flags return NULL if something is undefined. */
1821#define SV_UNDEF_RETURNS_NULL 2048
b3ab6785
KW
1822/* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1823 * This is used when the caller has already determined it is, and avoids
1824 * redundant work */
1825#define SV_FORCE_UTF8_UPGRADE 4096
aee036bb
DM
1826/* if (after resolving magic etc), the SV is found to be overloaded,
1827 * don't call the overload magic, just return as-is */
1828#define SV_SKIP_OVERLOAD 8192
20c88bf7
FC
1829#define SV_CATBYTES 16384
1830#define SV_CATUTF8 32768
34482cd6
NC
1831
1832/* The core is safe for this COW optimisation. XS code on CPAN may not be.
1833 So only default to doing the COW setup if we're in the core.
1834 */
1835#ifdef PERL_CORE
1836# ifndef SV_DO_COW_SVSETSV
cb23d5b1 1837# define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
34482cd6
NC
1838# endif
1839#endif
1840
1841#ifndef SV_DO_COW_SVSETSV
1842# define SV_DO_COW_SVSETSV 0
1843#endif
1844
765f542d 1845
5abc721d
NC
1846#define sv_unref(sv) sv_unref_flags(sv, 0)
1847#define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
47518d95
NC
1848#define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1849#define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
174c73e3 1850
46187eeb
NC
1851/* We are about to replace the SV's current value. So if it's copy on write
1852 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1853 the value is about to get thrown away, so drop the PV rather than go to
1854 the effort of making a read-write copy only for it to get immediately
1855 discarded. */
765f542d
NC
1856
1857#define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1858 sv_force_normal_flags(sv, SV_COW_DROP_PV)
46187eeb 1859
f8c7b90f 1860#ifdef PERL_OLD_COPY_ON_WRITE
5302ffd4 1861#define SvRELEASE_IVX(sv) \
7a4bba22 1862 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
46187eeb 1863# define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
7a4bba22 1864# define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
db2c6cb3
FC
1865# define SvCANCOW(sv) \
1866 (SvIsCOW(sv) || (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS)
f7a8268c
FC
1867/* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
1868 on-write. */
1869# define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1870 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
a623f893 1871 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_PROTECT)
b8f9541a 1872#else
7a4bba22
NC
1873# define SvRELEASE_IVX(sv) 0
1874/* This little game brought to you by the need to shut this warning up:
1204f081 1875mg.c: In function 'Perl_magic_get':
7a4bba22
NC
1876mg.c:1024: warning: left-hand operand of comma expression has no effect
1877*/
1878# define SvRELEASE_IVX_(sv) /**/
db2c6cb3
FC
1879# ifdef PERL_NEW_COPY_ON_WRITE
1880# define SvCANCOW(sv) \
1881 (SvIsCOW(sv) \
1882 ? SvLEN(sv) ? CowREFCNT(sv) != SV_COW_REFCNT_MAX : 1 \
1883 : (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS \
1884 && SvCUR(sv)+1 < SvLEN(sv))
1885 /* Note: To allow 256 COW "copies", a refcnt of 0 means 1. */
1886# define CowREFCNT(sv) (*(U8 *)(SvPVX(sv)+SvLEN(sv)-1))
1887# define SV_COW_REFCNT_MAX ((1 << sizeof(U8)*8) - 1)
f7a8268c 1888# define CAN_COW_MASK (SVf_POK|SVf_ROK|SVp_POK|SVf_FAKE| \
a623f893 1889 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_PROTECT)
db2c6cb3 1890# endif
f8c7b90f 1891#endif /* PERL_OLD_COPY_ON_WRITE */
ed252734 1892
ed252734
NC
1893#define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1894
765f542d
NC
1895#define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1896 sv_force_normal_flags(sv, 0)
1897
1898
baca2b92
DM
1899/* all these 'functions' are now just macros */
1900
1901#define sv_pv(sv) SvPV_nolen(sv)
1902#define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1903#define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1904
1905#define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
b3ab6785 1906#define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
baca2b92
DM
1907#define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1908#define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
9dcc53ea 1909#define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
34482cd6
NC
1910#define sv_setsv(dsv, ssv) \
1911 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1912#define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
baca2b92
DM
1913#define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1914#define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
b347df82 1915#define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
baca2b92 1916#define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
4bac9ae4
CS
1917#define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1918#define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
1919#define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
baca2b92 1920#define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
cb2f1b7b
NC
1921#define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1922#define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1923#define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
baca2b92
DM
1924#define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1925#define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1926#define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
891f9566
YST
1927#define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1928#define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
39d5de13 1929#define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
078504b2 1930#define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
e8c9c9d4
NC
1931#define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1932#define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
078504b2 1933#define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
06c841cf 1934#define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
4bac9ae4 1935#define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
84335ee9
NC
1936#define sv_insert(bigstr, offset, len, little, littlelen) \
1937 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1938 (littlelen), SV_GMAGIC)
108cb980
FC
1939#define sv_mortalcopy(sv) \
1940 Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV)
f34d8cdd
FC
1941#define sv_cathek(sv,hek) \
1942 STMT_START { \
1943 HEK * const bmxk = hek; \
1944 sv_catpvn_flags(sv, HEK_KEY(bmxk), HEK_LEN(bmxk), \
1945 HEK_UTF8(bmxk) ? SV_CATUTF8 : SV_CATBYTES); \
1946 } STMT_END
baca2b92 1947
db79b45b 1948/* Should be named SvCatPVN_utf8_upgrade? */
4bac9ae4 1949#define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
db79b45b
JH
1950 STMT_START { \
1951 if (!(nsv)) \
ad25789c 1952 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
db79b45b
JH
1953 else \
1954 sv_setpvn(nsv, sstr, slen); \
1955 SvUTF8_off(nsv); \
1956 sv_utf8_upgrade(nsv); \
4bac9ae4 1957 sv_catsv_nomg(dsv, nsv); \
db79b45b 1958 } STMT_END
64534138
FC
1959#define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \
1960 sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES)
79072805 1961
25fdce4a 1962#if defined(PERL_CORE) || defined(PERL_EXT)
aec43834
FC
1963# define sv_or_pv_len_utf8(sv, pv, bytelen) \
1964 (SvGAMAGIC(sv) \
1965 ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \
1966 : sv_len_utf8(sv))
aec43834
FC
1967#endif
1968
954c1994
GS
1969/*
1970=for apidoc Am|SV*|newRV_inc|SV* sv
1971
1972Creates an RV wrapper for an SV. The reference count for the original SV is
1973incremented.
1974
1975=cut
1976*/
1977
5f05dabc 1978#define newRV_inc(sv) newRV(sv)
5f05dabc 1979
ef50df4b 1980/* the following macros update any magic values this sv is associated with */
79072805 1981
954c1994 1982/*
ccfc67b7
JH
1983=head1 Magical Functions
1984
954c1994 1985=for apidoc Am|void|SvGETMAGIC|SV* sv
f7e029ab
FC
1986Invokes C<mg_get> on an SV if it has 'get' magic. For example, this
1987will call C<FETCH> on a tied variable. This macro evaluates its
954c1994
GS
1988argument more than once.
1989
1990=for apidoc Am|void|SvSETMAGIC|SV* sv
f7e029ab
FC
1991Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary
1992after modifying a scalar, in case it is a magical variable like C<$|>
1993or a tied variable (it calls C<STORE>). This macro evaluates its
954c1994
GS
1994argument more than once.
1995
87ef9da8 1996=for apidoc Am|void|SvSetSV|SV* dsv|SV* ssv
954c1994 1997Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
f31006c9 1998more than once. Does not handle 'set' magic on the destination SV.
954c1994
GS
1999
2000=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
2001Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
8554e7a0 2002ssv. May evaluate arguments more than once.
954c1994 2003
87ef9da8 2004=for apidoc Am|void|SvSetMagicSV|SV* dsv|SV* ssv
645c22ef
DM
2005Like C<SvSetSV>, but does any set magic required afterwards.
2006
2007=for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
80663158 2008Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
645c22ef 2009
68795e93
NIS
2010=for apidoc Am|void|SvSHARE|SV* sv
2011Arranges for sv to be shared between threads if a suitable module
2012has been loaded.
2013
2014=for apidoc Am|void|SvLOCK|SV* sv
2015Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2016has been loaded.
2017
2018=for apidoc Am|void|SvUNLOCK|SV* sv
2019Releases a mutual exclusion lock on sv if a suitable module
2020has been loaded.
2021
ccfc67b7
JH
2022=head1 SV Manipulation Functions
2023
679ac26e 2024=for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
954c1994
GS
2025Expands the character buffer in the SV so that it has room for the
2026indicated number of bytes (remember to reserve space for an extra trailing
6602b933 2027C<NUL> character). Calls C<sv_grow> to perform the expansion if necessary.
72d33970
FC
2028Returns a pointer to the character
2029buffer. SV must be of type >= SVt_PV. One
4b1e7f06 2030alternative is to call C<sv_grow> if you are not sure of the type of SV.
954c1994
GS
2031
2032=cut
2033*/
2034
16c91539
BM
2035#define SvSHARE(sv) PL_sharehook(aTHX_ sv)
2036#define SvLOCK(sv) PL_lockhook(aTHX_ sv)
2037#define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
2038#define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
68795e93 2039
5d9574c1
DM
2040#define SvGETMAGIC(x) ((void)(UNLIKELY(SvGMAGICAL(x)) && mg_get(x)))
2041#define SvSETMAGIC(x) STMT_START { if (UNLIKELY(SvSMAGICAL(x))) mg_set(x); } STMT_END
79072805 2042
54310121 2043#define SvSetSV_and(dst,src,finally) \
189b2af5 2044 STMT_START { \
5d9574c1 2045 if (LIKELY((dst) != (src))) { \
54310121 2046 sv_setsv(dst, src); \
2047 finally; \
189b2af5
GS
2048 } \
2049 } STMT_END
54310121 2050#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 2051 STMT_START { \
5d9574c1 2052 if (LIKELY((dst) != (src))) { \
34482cd6 2053 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
54310121 2054 finally; \
189b2af5
GS
2055 } \
2056 } STMT_END
79072805 2057
54310121 2058#define SvSetSV(dst,src) \
c9d716f7 2059 SvSetSV_and(dst,src,/*nothing*/;)
54310121 2060#define SvSetSV_nosteal(dst,src) \
c9d716f7 2061 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121 2062
2063#define SvSetMagicSV(dst,src) \
4e3a8365 2064 SvSetSV_and(dst,src,SvSETMAGIC(dst))
54310121 2065#define SvSetMagicSV_nosteal(dst,src) \
4e3a8365 2066 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
54310121 2067
db79b45b 2068
1045810a 2069#if !defined(SKIP_DEBUGGING)
79072805 2070#define SvPEEK(sv) sv_peek(sv)
3967c732
JD
2071#else
2072#define SvPEEK(sv) ""
2073#endif
79072805 2074
3041a168 2075#define SvIMMORTAL(sv) (SvREADONLY(sv) && ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder))
36477c24 2076
fe54beba
DM
2077#ifdef DEBUGGING
2078 /* exercise the immortal resurrection code in sv_free2() */
2079# define SvREFCNT_IMMORTAL 1000
2080#else
2081# define SvREFCNT_IMMORTAL ((~(U32)0)/2)
2082#endif
2083
567f3b56
TC
2084/*
2085=for apidoc Am|SV *|boolSV|bool b
2086
2087Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
2088
2089See also C<PL_sv_yes> and C<PL_sv_no>.
2090
2091=cut
2092*/
2093
3280af22 2094#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 2095
79072805 2096#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
f7877b28
NC
2097/* If I give every macro argument a different name, then there won't be bugs
2098 where nested macros get confused. Been there, done that. */
2099#define isGV_with_GP(pwadak) \
2e5b91de 2100 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
f7877b28 2101 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2e5b91de 2102#define isGV_with_GP_on(sv) STMT_START { \
70ad9799
SP
2103 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2104 assert (!SvPOKp(sv)); \
2105 assert (!SvIOKp(sv)); \
2106 (SvFLAGS(sv) |= SVpgv_GP); \
2e5b91de
NC
2107 } STMT_END
2108#define isGV_with_GP_off(sv) STMT_START { \
70ad9799
SP
2109 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
2110 assert (!SvPOKp(sv)); \
2111 assert (!SvIOKp(sv)); \
2e5b91de
NC
2112 (SvFLAGS(sv) &= ~SVpgv_GP); \
2113 } STMT_END
8d919b0a
FC
2114#define isREGEXP(sv) \
2115 (SvTYPE(sv) == SVt_REGEXP \
2116 || (SvFLAGS(sv) & (SVTYPEMASK|SVp_POK|SVpgv_GP|SVf_FAKE)) \
2117 == (SVt_PVLV|SVf_FAKE))
2e5b91de 2118
79072805 2119
bba82a09 2120#ifdef PERL_ANY_COW
db2c6cb3
FC
2121# define SvGROW(sv,len) \
2122 (SvIsCOW(sv) || SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2123#else
2124# define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
2125#endif
5902b6a9
NC
2126#define SvGROW_mutable(sv,len) \
2127 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
933fea7f 2128#define Sv_Grow sv_grow
3d35f11b 2129
a0739874
DM
2130#define CLONEf_COPY_STACKS 1
2131#define CLONEf_KEEP_PTR_TABLE 2
c43294b8 2132#define CLONEf_CLONE_HOST 4
0405e91e 2133#define CLONEf_JOIN_IN 8
a0739874 2134
8cf8f3d1 2135struct clone_params {
d2d73c3e
AB
2136 AV* stashes;
2137 UV flags;
59b40662 2138 PerlInterpreter *proto_perl;
1db366cc 2139 PerlInterpreter *new_perl;
d08d57ef 2140 AV *unreferenced;
8cf8f3d1 2141};
102d3b8a
NC
2142
2143/*
740cce10
NC
2144=for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
2145
30a15352
KW
2146Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
2147characters) into it. If utf8 is true, calls
740cce10
NC
2148C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
2149
2150=cut
2151*/
2152
2153#define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2154
2155/*
35e035cc
FC
2156=for apidoc Amx|SV*|newSVpadname|PADNAME *pn
2157
0f94cb1f 2158Creates a new SV containing the pad name.
35e035cc
FC
2159
2160=cut
2161*/
2162
0f94cb1f 2163#define newSVpadname(pn) newSVpvn_utf8(PadnamePV(pn), PadnameLEN(pn), TRUE)
35e035cc
FC
2164
2165/*
69240efd
NC
2166=for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2167
2168Reads into I<len> the offset from SvPVX back to the true start of the
2169allocated buffer, which will be non-zero if C<sv_chop> has been used to
8554e7a0 2170efficiently remove characters from start of the buffer. Implemented as a
69240efd 2171macro, which takes the address of I<len>, which must be of type C<STRLEN>.
8554e7a0 2172Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
69240efd
NC
2173
2174=cut
2175*/
2176
2177#ifdef DEBUGGING
2178/* Does the bot know something I don't?
217910:28 <@Nicholas> metabatman
218010:28 <+meta> Nicholas: crash
2181*/
2182# define SvOOK_offset(sv, offset) STMT_START { \
2183 assert(sizeof(offset) == sizeof(STRLEN)); \
2184 if (SvOOK(sv)) { \
d845901f
CS
2185 const U8 *_crash = (U8*)SvPVX_const(sv); \
2186 (offset) = *--_crash; \
2187 if (!(offset)) { \
2188 _crash -= sizeof(STRLEN); \
2189 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
69240efd
NC
2190 } \
2191 { \
2192 /* Validate the preceding buffer's sentinels to \
2193 verify that no-one is using it. */ \
d845901f
CS
2194 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2195 while (_crash > _bonk) { \
2196 --_crash; \
2197 assert (*_crash == (U8)PTR2UV(_crash)); \
69240efd
NC
2198 } \
2199 } \
2200 } else { \
d845901f 2201 (offset) = 0; \
69240efd
NC
2202 } \
2203 } STMT_END
2204#else
2205 /* This is the same code, but avoids using any temporary variables: */
2206# define SvOOK_offset(sv, offset) STMT_START { \
2207 assert(sizeof(offset) == sizeof(STRLEN)); \
2208 if (SvOOK(sv)) { \
d845901f
CS
2209 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2210 if (!(offset)) { \
69240efd 2211 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
d845901f 2212 (U8*)&(offset), sizeof(STRLEN), U8); \
69240efd
NC
2213 } \
2214 } else { \
d845901f 2215 (offset) = 0; \
69240efd
NC
2216 } \
2217 } STMT_END
2218#endif
85dca89a
NC
2219
2220#define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2221
a38ab475
RZ
2222#define SV_CONST(name) \
2223 PL_sv_consts[SV_CONST_##name] \
2224 ? PL_sv_consts[SV_CONST_##name] \
2225 : (PL_sv_consts[SV_CONST_##name] = newSVpv_share(#name, 0))
2226
2227#define SV_CONST_TIESCALAR 0
2228#define SV_CONST_TIEARRAY 1
2229#define SV_CONST_TIEHASH 2
2230#define SV_CONST_TIEHANDLE 3
2231
2232#define SV_CONST_FETCH 4
2233#define SV_CONST_FETCHSIZE 5
2234#define SV_CONST_STORE 6
2235#define SV_CONST_STORESIZE 7
2236#define SV_CONST_EXISTS 8
2237
2238#define SV_CONST_PUSH 9
2239#define SV_CONST_POP 10
2240#define SV_CONST_SHIFT 11
2241#define SV_CONST_UNSHIFT 12
2242#define SV_CONST_SPLICE 13
2243#define SV_CONST_EXTEND 14
2244
2245#define SV_CONST_FIRSTKEY 15
2246#define SV_CONST_NEXTKEY 16
2247#define SV_CONST_SCALAR 17
2248
2249#define SV_CONST_OPEN 18
2250#define SV_CONST_WRITE 19
2251#define SV_CONST_PRINT 20
2252#define SV_CONST_PRINTF 21
2253#define SV_CONST_READ 22
2254#define SV_CONST_READLINE 23
2255#define SV_CONST_GETC 24
2256#define SV_CONST_SEEK 25
2257#define SV_CONST_TELL 26
2258#define SV_CONST_EOF 27
2259#define SV_CONST_BINMODE 28
2260#define SV_CONST_FILENO 29
2261#define SV_CONST_CLOSE 30
2262
2263#define SV_CONST_DELETE 31
2264#define SV_CONST_CLEAR 32
2265#define SV_CONST_UNTIE 33
2266#define SV_CONST_DESTROY 34
2267
2268#define SV_CONSTS_COUNT 35
2269
69240efd 2270/*
102d3b8a
NC
2271 * Local variables:
2272 * c-indentation-style: bsd
2273 * c-basic-offset: 4
14d04a33 2274 * indent-tabs-mode: nil
102d3b8a
NC
2275 * End:
2276 *
14d04a33 2277 * ex: set ts=8 sts=4 sw=4 et:
102d3b8a 2278 */