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