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