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