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