This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Finish converting overload.t to Test::More
[perl5.git] / sv.h
CommitLineData
a0d0e21e 1/* sv.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
acde74e1 4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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
22=for apidoc AmU||SVt_PV
23Pointer type flag for scalars. See C<svtype>.
24
25=for apidoc AmU||SVt_IV
26Integer type flag for scalars. See C<svtype>.
27
28=for apidoc AmU||SVt_NV
29Double type flag for scalars. See C<svtype>.
30
31=for apidoc AmU||SVt_PVMG
32Type flag for blessed scalars. See C<svtype>.
33
34=for apidoc AmU||SVt_PVAV
35Type flag for arrays. See C<svtype>.
36
37=for apidoc AmU||SVt_PVHV
38Type flag for hashes. See C<svtype>.
39
40=for apidoc AmU||SVt_PVCV
41Type flag for code refs. See C<svtype>.
42
43=cut
44*/
45
79072805 46typedef enum {
a0d0e21e
LW
47 SVt_NULL, /* 0 */
48 SVt_IV, /* 1 */
49 SVt_NV, /* 2 */
50 SVt_RV, /* 3 */
51 SVt_PV, /* 4 */
52 SVt_PVIV, /* 5 */
53 SVt_PVNV, /* 6 */
54 SVt_PVMG, /* 7 */
55 SVt_PVBM, /* 8 */
4ce457a6
TP
56 SVt_PVGV, /* 9 */
57 SVt_PVLV, /* 10 */
58 SVt_PVAV, /* 11 */
59 SVt_PVHV, /* 12 */
60 SVt_PVCV, /* 13 */
a0d0e21e 61 SVt_PVFM, /* 14 */
93e68bfb
JC
62 SVt_PVIO, /* 15 */
63 SVt_LAST /* keep last in enum. used to size arrays */
79072805
LW
64} svtype;
65
d2a0f284
JC
66/* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
67 and SVt_IV, so never reaches the clause at the end that uses
68 sv_type_details->body_size to determine whether to call safefree(). Hence
69 body_size can be set no-zero to record the size of PTEs and HEs, without
70 fear of bogus frees. */
028b03ee 71#ifdef PERL_IN_SV_C
d2a0f284 72#define PTE_SVSLOT SVt_IV
028b03ee 73#endif
6a93a7e5
NC
74#if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
75#define HE_SVSLOT SVt_NULL
76#endif
43e6e717 77
232d1c15
NC
78#define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
79
43e6e717
NC
80/* typedefs to eliminate some typing */
81typedef struct he HE;
82typedef struct hek HEK;
83
79072805
LW
84/* Using C's structural equivalence to help emulate C++ inheritance here... */
85
30153bd2
JC
86/* start with 2 sv-head building blocks */
87#define _SV_HEAD(ptrtype) \
88 ptrtype sv_any; /* pointer to body */ \
89 U32 sv_refcnt; /* how many references to us */ \
90 U32 sv_flags /* what we are */
91
92#define _SV_HEAD_UNION \
93 union { \
94 IV svu_iv; \
95 UV svu_uv; \
96 SV* svu_rv; /* pointer to another SV */ \
97 char* svu_pv; /* pointer to malloced string */ \
98 SV** svu_array; \
99 HE** svu_hash; \
f7877b28 100 GP* svu_gp; \
30153bd2
JC
101 } sv_u
102
103
5e045b90 104struct STRUCT_SV { /* struct sv { */
30153bd2
JC
105 _SV_HEAD(void*);
106 _SV_HEAD_UNION;
fd0854ff
DM
107#ifdef DEBUG_LEAKING_SCALARS
108 unsigned sv_debug_optype:9; /* the type of OP that allocated us */
109 unsigned sv_debug_inpad:1; /* was allocated in a pad for an OP */
110 unsigned sv_debug_cloned:1; /* was cloned for an ithread */
111 unsigned sv_debug_line:16; /* the line where we were allocated */
112 char * sv_debug_file; /* the file where we were allocated */
113#endif
79072805
LW
114};
115
116struct gv {
30153bd2
JC
117 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
118 _SV_HEAD_UNION;
79072805
LW
119};
120
121struct cv {
30153bd2
JC
122 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
123 _SV_HEAD_UNION;
79072805
LW
124};
125
126struct av {
0f7b1ae0 127 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
30153bd2 128 _SV_HEAD_UNION;
79072805
LW
129};
130
131struct hv {
30153bd2
JC
132 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
133 _SV_HEAD_UNION;
8990e307
LW
134};
135
136struct io {
30153bd2
JC
137 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
138 _SV_HEAD_UNION;
79072805
LW
139};
140
30153bd2 141#undef _SV_HEAD
0f7b1ae0 142#undef _SV_HEAD_UNION /* ensure no pollution */
30153bd2 143
954c1994 144/*
ccfc67b7
JH
145=head1 SV Manipulation Functions
146
954c1994
GS
147=for apidoc Am|U32|SvREFCNT|SV* sv
148Returns the value of the object's reference count.
149
150=for apidoc Am|SV*|SvREFCNT_inc|SV* sv
151Increments the reference count of the given SV.
152
b37c2d43
AL
153All of the following SvREFCNT_inc* macros are optimized versions of
154SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
155
156=for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
157Same as SvREFCNT_inc, but can only be used if you know I<sv>
158is not NULL. Since we don't have to check the NULLness, it's faster
159and smaller.
160
161=for apidoc Am|SV*|SvREFCNT_inc_void|SV* sv
162Same as SvREFCNT_inc, but can only be used if you don't need the
163return value. The macro doesn't need to return a meaningful value.
164
165=for apidoc Am|SV*|SvREFCNT_inc_void_NN|SV* sv
166Same as SvREFCNT_inc, but can only be used if you don't need the return
167value, and you know that I<sv> is not NULL. The macro doesn't need
168to return a meaningful value, or check for NULLness, so it's smaller
169and faster.
170
171=for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
172Same as SvREFCNT_inc, but can only be used with simple variables, not
173expressions or pointer dereferences. Since we don't have to store a
174temporary value, it's faster.
175
176=for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
177Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
178is not NULL. Since we don't have to check the NULLness, it's faster
179and smaller.
180
181=for apidoc Am|SV*|SvREFCNT_inc_simple_void|SV* sv
182Same as SvREFCNT_inc_simple, but can only be used if you don't need the
183return value. The macro doesn't need to return a meaningful value.
184
185=for apidoc Am|SV*|SvREFCNT_inc|SV* sv
186Increments the reference count of the given SV.
187
954c1994
GS
188=for apidoc Am|void|SvREFCNT_dec|SV* sv
189Decrements the reference count of the given SV.
190
191=for apidoc Am|svtype|SvTYPE|SV* sv
192Returns the type of the SV. See C<svtype>.
193
194=for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
195Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
196perform the upgrade if necessary. See C<svtype>.
197
198=cut
199*/
200
463ee0b2 201#define SvANY(sv) (sv)->sv_any
79072805 202#define SvFLAGS(sv) (sv)->sv_flags
aeea060c 203#define SvREFCNT(sv) (sv)->sv_refcnt
a863c7d1 204
93189314 205#if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
dce16143
MB
206# define SvREFCNT_inc(sv) \
207 ({ \
a3b680e6 208 SV * const _sv = (SV*)(sv); \
3de3296f
AE
209 if (_sv) \
210 (SvREFCNT(_sv))++; \
211 _sv; \
dce16143 212 })
b37c2d43
AL
213# define SvREFCNT_inc_simple(sv) \
214 ({ \
215 if (sv) \
216 (SvREFCNT(sv))++; \
0181a44d 217 (SV *)(sv); \
b37c2d43
AL
218 })
219# define SvREFCNT_inc_NN(sv) \
220 ({ \
221 SV * const _sv = (SV*)(sv); \
222 SvREFCNT(_sv)++; \
223 _sv; \
224 })
225# define SvREFCNT_inc_void(sv) \
226 ({ \
227 SV * const _sv = (SV*)(sv); \
228 if (_sv) \
229 (void)(SvREFCNT(_sv)++); \
230 })
8990e307 231#else
3db8f154 232# define SvREFCNT_inc(sv) \
b37c2d43
AL
233 ((PL_Sv=(SV*)(sv)) ? (++(SvREFCNT(PL_Sv)),PL_Sv) : NULL)
234# define SvREFCNT_inc_simple(sv) \
235 ((sv) ? (SvREFCNT(sv)++,(SV*)(sv)) : NULL)
236# define SvREFCNT_inc_NN(sv) \
237 (PL_Sv=(SV*)(sv),++(SvREFCNT(PL_Sv)),PL_Sv)
238# define SvREFCNT_inc_void(sv) \
239 (void)((PL_Sv=(SV*)(sv)) ? ++(SvREFCNT(PL_Sv)) : 0)
8990e307
LW
240#endif
241
b37c2d43
AL
242/* These guys don't need the curly blocks */
243#define SvREFCNT_inc_simple_void(sv) if (sv) (SvREFCNT(sv)++);
244#define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),(SV*)(sv))
245#define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
246#define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT((SV*)(sv)))
247
8c4d3c90
NC
248#if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
249# define SvREFCNT_dec(sv) \
250 ({ \
a3b680e6 251 SV * const _sv = (SV*)(sv); \
3de3296f
AE
252 if (_sv) { \
253 if (SvREFCNT(_sv)) { \
254 if (--(SvREFCNT(_sv)) == 0) \
255 Perl_sv_free2(aTHX_ _sv); \
8c4d3c90 256 } else { \
3de3296f 257 sv_free(_sv); \
8c4d3c90
NC
258 } \
259 } \
260 })
261#else
91f3b821 262#define SvREFCNT_dec(sv) sv_free((SV*)(sv))
8c4d3c90 263#endif
a863c7d1 264
8990e307
LW
265#define SVTYPEMASK 0xff
266#define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
79072805 267
0565a181
NC
268/* Sadly there are some parts of the core that have pointers to already-freed
269 SV heads, and rely on being able to tell that they are now free. So mark
270 them all by using a consistent macro. */
271#define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
272
63f97190 273#define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
79072805 274
7a77f1af
NC
275#define SVf_IOK 0x00000100 /* has valid public integer value */
276#define SVf_NOK 0x00000200 /* has valid public numeric value */
277#define SVf_POK 0x00000400 /* has valid public pointer value */
278#define SVf_ROK 0x00000800 /* has a valid reference pointer */
279
280#define SVp_IOK 0x00001000 /* has valid non-public integer value */
281#define SVp_NOK 0x00002000 /* has valid non-public numeric value */
282#define SVp_POK 0x00004000 /* has valid non-public pointer value */
283#define SVp_SCREAM 0x00008000 /* has been studied? */
284#define SVphv_CLONEABLE 0x00008000 /* PVHV (stashes) clone its objects */
285
286#define SVs_PADSTALE 0x00010000 /* lexical has gone out of scope */
287#define SVs_PADTMP 0x00020000 /* in use as tmp */
075bae1e 288#define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
7a77f1af 289#define SVs_PADMY 0x00040000 /* in use a "my" variable */
075bae1e 290#define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
7a77f1af
NC
291#define SVs_TEMP 0x00080000 /* string is stealable? */
292#define SVs_OBJECT 0x00100000 /* is "blessed" */
293#define SVs_GMG 0x00200000 /* has magical get method */
294#define SVs_SMG 0x00400000 /* has magical set method */
295#define SVs_RMG 0x00800000 /* has random magical methods */
296
297#define SVf_FAKE 0x01000000 /* 0: glob or lexical is just a copy
d112a06d
NC
298 1: SV head arena wasn't malloc()ed
299 2: in conjunction with SVf_READONLY
300 marks a shared hash key scalar
301 (SvLEN == 0) or a copy on write
302 string (SvLEN != 0) [SvIsCOW(sv)]
303 3: For PVCV, whether CvUNIQUE(cv)
304 refers to an eval or once only
305 [CvEVAL(cv), CvSPECIAL(cv)]
306 4: Whether the regexp pointer is in
307 fact an offset [SvREPADTMP(sv)]
120ff8e9
NC
308 5: On a pad name SV, that slot in the
309 frame AV is a REFCNT'ed reference
ba72d282
NC
310 to a lexical from "outside". */
311#define SVphv_REHASH SVf_FAKE /* 6: On a PVHV, hash values are being
312 recalculated */
7a77f1af 313#define SVf_OOK 0x02000000 /* has valid offset value
b79f7545
NC
314 For a PVHV this means that a
315 hv_aux struct is present after the
316 main array */
7a77f1af 317#define SVf_BREAK 0x04000000 /* refcnt is artificially low - used
645c22ef 318 * by SV's in final arena cleanup */
7a77f1af 319#define SVf_READONLY 0x08000000 /* may not be modified */
8990e307 320
a0d0e21e 321
8990e307 322
5bc28da9 323
430eacda 324#define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
5bc28da9 325
a0d0e21e 326#define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
180488f8 327 SVp_IOK|SVp_NOK|SVp_POK|SVp_SCREAM)
a0d0e21e 328
7a77f1af 329#define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
8990e307 330
26a32e18
NC
331#define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
332#define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded */
333/* Ensure this value does not clash with the GV_ADD* flags in gv.h */
334
8990e307
LW
335/* Some private flags. */
336
26a32e18 337/* PVHV */
26a32e18
NC
338#define SVphv_SHAREKEYS 0x20000000 /* PVHV
339 keys live on shared string table */
340/* PVNV, PVMG, PVGV, presumably only inside pads */
075bae1e
NC
341#define SVpad_NAME 0x40000000 /* This SV is a name in the PAD, so
342 SVpad_TYPED and SVpad_OUR apply */
26a32e18
NC
343/* PVAV */
344#define SVpav_REAL 0x40000000 /* free old entries */
345/* PVHV */
346#define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
347/* PVBM */
bbce6d69 348#define SVpbm_TAIL 0x40000000
26a32e18 349/* ??? */
25da4f38
IZ
350#define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
351
26a32e18
NC
352/* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
353/* Presumably IVs aren't stored in pads */
354#define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
355/* PVAV */
356#define SVpav_REIFY 0x80000000 /* can become real */
357/* PVHV */
19692e8d 358#define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
26a32e18
NC
359/* PVFM */
360#define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
361/* PVBM */
362#define SVpbm_VALID 0x80000000
363/* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
810b8aa5
GS
364#define SVprv_WEAKREF 0x80000000 /* Weak reference */
365
11ca45c0 366
79072805 367struct xpv {
58430790
NC
368 union {
369 NV xnv_nv; /* numeric value, if any */
370 HV * xgv_stash;
371 } xnv_u;
339049b0 372 STRLEN xpv_cur; /* length of svu_pv as a C string */
ed6116ce 373 STRLEN xpv_len; /* allocated size */
79072805
LW
374};
375
9f1501b2 376#if 0
59813432 377typedef struct xpv xpv_allocated;
9f1501b2
NC
378#else
379typedef struct {
339049b0 380 STRLEN xpv_cur; /* length of svu_pv as a C string */
9f1501b2
NC
381 STRLEN xpv_len; /* allocated size */
382} xpv_allocated;
383#endif
59813432 384
79072805 385struct xpviv {
58430790
NC
386 union {
387 NV xnv_nv; /* numeric value, if any */
388 HV * xgv_stash;
389 } xnv_u;
339049b0 390 STRLEN xpv_cur; /* length of svu_pv as a C string */
ed6116ce 391 STRLEN xpv_len; /* allocated size */
311a25d9
NC
392 union {
393 IV xivu_iv; /* integer value or pv offset */
394 UV xivu_uv;
395 void * xivu_p1;
bb172083 396 I32 xivu_i32;
69ecfd12 397 HEK * xivu_namehek;
311a25d9 398 } xiv_u;
79072805
LW
399};
400
311a25d9
NC
401#if 0
402typedef struct xpviv xpviv_allocated;
403#else
404typedef struct {
405 STRLEN xpv_cur; /* length of svu_pv as a C string */
406 STRLEN xpv_len; /* allocated size */
407 union {
408 IV xivu_iv; /* integer value or pv offset */
409 UV xivu_uv;
410 void * xivu_p1;
bb172083 411 I32 xivu_i32;
69ecfd12 412 HEK * xivu_namehek;
311a25d9
NC
413 } xiv_u;
414} xpviv_allocated;
415#endif
416
417#define xiv_iv xiv_u.xivu_iv
418
ff68c719 419struct xpvuv {
58430790
NC
420 union {
421 NV xnv_nv; /* numeric value, if any */
422 HV * xgv_stash;
423 } xnv_u;
339049b0 424 STRLEN xpv_cur; /* length of svu_pv as a C string */
ff68c719 425 STRLEN xpv_len; /* allocated size */
311a25d9
NC
426 union {
427 IV xuvu_iv;
428 UV xuvu_uv; /* unsigned value or pv offset */
429 void * xuvu_p1;
69ecfd12 430 HEK * xivu_namehek;
311a25d9 431 } xuv_u;
ff68c719
PP
432};
433
311a25d9
NC
434#define xuv_uv xuv_u.xuvu_uv
435
79072805 436struct xpvnv {
58430790
NC
437 union {
438 NV xnv_nv; /* numeric value, if any */
439 HV * xgv_stash;
440 } xnv_u;
339049b0 441 STRLEN xpv_cur; /* length of svu_pv as a C string */
ed6116ce 442 STRLEN xpv_len; /* allocated size */
e4305a63 443 union {
311a25d9
NC
444 IV xivu_iv; /* integer value or pv offset */
445 UV xivu_uv;
446 void * xivu_p1;
bb172083 447 I32 xivu_i32;
69ecfd12 448 HEK * xivu_namehek;
311a25d9 449 } xiv_u;
79072805
LW
450};
451
6ee623d5 452/* These structure must match the beginning of struct xpvhv in hv.h. */
79072805 453struct xpvmg {
58430790
NC
454 union {
455 NV xnv_nv; /* numeric value, if any */
456 HV * xgv_stash;
457 } xnv_u;
339049b0 458 STRLEN xpv_cur; /* length of svu_pv as a C string */
ed6116ce 459 STRLEN xpv_len; /* allocated size */
e4305a63 460 union {
311a25d9
NC
461 IV xivu_iv; /* integer value or pv offset */
462 UV xivu_uv;
463 void * xivu_p1;
bb172083 464 I32 xivu_i32;
69ecfd12 465 HEK * xivu_namehek;
311a25d9 466 } xiv_u;
e736a858
NC
467 union {
468 MAGIC* xmg_magic; /* linked list of magicalness */
469 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
470 } xmg_u;
79072805
LW
471 HV* xmg_stash; /* class package */
472};
473
474struct xpvlv {
58430790
NC
475 union {
476 NV xnv_nv; /* numeric value, if any */
477 HV * xgv_stash;
478 } xnv_u;
339049b0 479 STRLEN xpv_cur; /* length of svu_pv as a C string */
ed6116ce 480 STRLEN xpv_len; /* allocated size */
e4305a63 481 union {
311a25d9
NC
482 IV xivu_iv; /* integer value or pv offset */
483 UV xivu_uv;
484 void * xivu_p1;
bb172083 485 I32 xivu_i32;
69ecfd12 486 HEK * xivu_namehek; /* GvNAME */
311a25d9 487 } xiv_u;
e736a858
NC
488 union {
489 MAGIC* xmg_magic; /* linked list of magicalness */
490 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
491 } xmg_u;
79072805 492 HV* xmg_stash; /* class package */
8990e307 493
79072805
LW
494 STRLEN xlv_targoff;
495 STRLEN xlv_targlen;
496 SV* xlv_targ;
dd28f7bb
DM
497 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
498 * y=alem/helem/iter t=tie T=tied HE */
79072805
LW
499};
500
501struct xpvgv {
58430790
NC
502 union {
503 NV xnv_nv;
504 HV * xgv_stash; /* The stash of this GV */
505 } xnv_u;
5526b5b3
NC
506 STRLEN xpv_cur; /* xgv_flags */
507 STRLEN xpv_len; /* 0 */
e4305a63 508 union {
69ecfd12 509 IV xivu_iv;
311a25d9
NC
510 UV xivu_uv;
511 void * xivu_p1;
bb172083 512 I32 xivu_i32;
69ecfd12 513 HEK * xivu_namehek; /* GvNAME */
311a25d9 514 } xiv_u;
e736a858
NC
515 union {
516 MAGIC* xmg_magic; /* linked list of magicalness */
517 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
518 } xmg_u;
79072805 519 HV* xmg_stash; /* class package */
8990e307 520
79072805
LW
521};
522
523struct xpvbm {
58430790
NC
524 union {
525 NV xnv_nv; /* numeric value, if any */
526 HV * xgv_stash;
527 } xnv_u;
339049b0 528 STRLEN xpv_cur; /* length of svu_pv as a C string */
ed6116ce 529 STRLEN xpv_len; /* allocated size */
e4305a63 530 union {
311a25d9
NC
531 IV xivu_iv; /* integer value or pv offset */
532 UV xivu_uv;
533 void * xivu_p1;
bb172083 534 I32 xivu_i32;
69ecfd12 535 HEK * xivu_namehek;
311a25d9 536 } xiv_u;
e736a858
NC
537 union {
538 MAGIC* xmg_magic; /* linked list of magicalness */
539 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
540 } xmg_u;
79072805 541 HV* xmg_stash; /* class package */
8990e307 542
79072805
LW
543 I32 xbm_useful; /* is this constant pattern being useful? */
544 U16 xbm_previous; /* how many characters in string before rare? */
545 U8 xbm_rare; /* rarest character in string */
546};
547
fd40b977 548/* This structure must match XPVCV in cv.h */
44a8e56a 549
77a005ab
MB
550typedef U16 cv_flags_t;
551
79072805 552struct xpvfm {
58430790
NC
553 union {
554 NV xnv_nv; /* numeric value, if any */
555 HV * xgv_stash;
556 } xnv_u;
339049b0 557 STRLEN xpv_cur; /* length of svu_pv as a C string */
ed6116ce 558 STRLEN xpv_len; /* allocated size */
e4305a63 559 union {
bb172083 560 IV xivu_iv; /* PVFMs use the pv offset */
311a25d9
NC
561 UV xivu_uv;
562 void * xivu_p1;
bb172083 563 I32 xivu_i32;
69ecfd12 564 HEK * xivu_namehek;
311a25d9 565 } xiv_u;
e736a858
NC
566 union {
567 MAGIC* xmg_magic; /* linked list of magicalness */
568 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
569 } xmg_u;
79072805 570 HV* xmg_stash; /* class package */
8990e307 571
79072805 572 HV * xcv_stash;
bf53b3a5
NC
573 union {
574 OP * xcv_start;
575 ANY xcv_xsubany;
576 } xcv_start_u;
d04ba589
NC
577 union {
578 OP * xcv_root;
579 void (*xcv_xsub) (pTHX_ CV*);
580 } xcv_root_u;
a0d0e21e 581 GV * xcv_gv;
57843af0 582 char * xcv_file;
79072805 583 AV * xcv_padlist;
748a9306 584 CV * xcv_outside;
a3985cdc
DM
585 U32 xcv_outside_seq; /* the COP sequence (at the point of our
586 * compilation) in the lexically enclosing
587 * sub */
bb172083 588 cv_flags_t xcv_flags;
11a7ac70 589 IV xfm_lines;
79072805
LW
590};
591
3038937b
NC
592typedef struct {
593 STRLEN xpv_cur; /* length of svu_pv as a C string */
594 STRLEN xpv_len; /* allocated size */
595 union {
bb172083 596 IV xivu_iv; /* PVFMs use the pv offset */
3038937b
NC
597 UV xivu_uv;
598 void * xivu_p1;
bb172083 599 I32 xivu_i32;
69ecfd12 600 HEK * xivu_namehek;
3038937b 601 } xiv_u;
e736a858
NC
602 union {
603 MAGIC* xmg_magic; /* linked list of magicalness */
604 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
605 } xmg_u;
3038937b
NC
606 HV* xmg_stash; /* class package */
607
608 HV * xcv_stash;
d04ba589
NC
609 union {
610 OP * xcv_start;
611 ANY xcv_xsubany;
612 } xcv_start_u;
613 union {
614 OP * xcv_root;
615 void (*xcv_xsub) (pTHX_ CV*);
616 } xcv_root_u;
3038937b
NC
617 GV * xcv_gv;
618 char * xcv_file;
3038937b
NC
619 AV * xcv_padlist;
620 CV * xcv_outside;
3038937b
NC
621 U32 xcv_outside_seq; /* the COP sequence (at the point of our
622 * compilation) in the lexically enclosing
623 * sub */
bb172083 624 cv_flags_t xcv_flags;
3038937b
NC
625 IV xfm_lines;
626} xpvfm_allocated;
627
8990e307 628struct xpvio {
58430790
NC
629 union {
630 NV xnv_nv; /* numeric value, if any */
631 HV * xgv_stash;
632 } xnv_u;
339049b0 633 STRLEN xpv_cur; /* length of svu_pv as a C string */
8990e307 634 STRLEN xpv_len; /* allocated size */
e4305a63 635 union {
311a25d9
NC
636 IV xivu_iv; /* integer value or pv offset */
637 UV xivu_uv;
638 void * xivu_p1;
bb172083 639 I32 xivu_i32;
69ecfd12 640 HEK * xivu_namehek;
311a25d9 641 } xiv_u;
e736a858
NC
642 union {
643 MAGIC* xmg_magic; /* linked list of magicalness */
644 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
645 } xmg_u;
8990e307
LW
646 HV* xmg_stash; /* class package */
647
760ac839
LW
648 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
649 PerlIO * xio_ofp; /* but sockets need separate streams */
4755096e
GS
650 /* Cray addresses everything by word boundaries (64 bits) and
651 * code and data pointers cannot be mixed (which is exactly what
652 * Perl_filter_add() tries to do with the dirp), hence the following
653 * union trick (as suggested by Gurusamy Sarathy).
654 * For further information see Geir Johansen's problem report titled
655 [ID 20000612.002] Perl problem on Cray system
656 * The any pointer (known as IoANY()) will also be a good place
657 * to hang any IO disciplines to.
658 */
659 union {
660 DIR * xiou_dirp; /* for opendir, readdir, etc */
661 void * xiou_any; /* for alignment */
662 } xio_dirpu;
11a7ac70
JH
663 IV xio_lines; /* $. */
664 IV xio_page; /* $% */
665 IV xio_page_len; /* $= */
666 IV xio_lines_left; /* $- */
8990e307
LW
667 char * xio_top_name; /* $^ */
668 GV * xio_top_gv; /* $^ */
669 char * xio_fmt_name; /* $~ */
670 GV * xio_fmt_gv; /* $~ */
671 char * xio_bottom_name;/* $^B */
672 GV * xio_bottom_gv; /* $^B */
673 short xio_subprocess; /* -| or |- */
674 char xio_type;
675 char xio_flags;
676};
4755096e
GS
677#define xio_dirp xio_dirpu.xiou_dirp
678#define xio_any xio_dirpu.xiou_any
8990e307 679
e0c19803
GS
680#define IOf_ARGV 1 /* this fp iterates over ARGV */
681#define IOf_START 2 /* check for null ARGV and substitute '-' */
682#define IOf_FLUSH 4 /* this fp wants a flush after write op */
683#define IOf_DIDTOP 8 /* just did top of form */
684#define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
685#define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
686#define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
8990e307 687
ed6116ce
LW
688/* The following macros define implementation-independent predicates on SVs. */
689
954c1994
GS
690/*
691=for apidoc Am|bool|SvNIOK|SV* sv
692Returns a boolean indicating whether the SV contains a number, integer or
693double.
694
695=for apidoc Am|bool|SvNIOKp|SV* sv
696Returns a boolean indicating whether the SV contains a number, integer or
697double. Checks the B<private> setting. Use C<SvNIOK>.
698
699=for apidoc Am|void|SvNIOK_off|SV* sv
700Unsets the NV/IV status of an SV.
701
702=for apidoc Am|bool|SvOK|SV* sv
9adebda4
SB
703Returns a boolean indicating whether the value is an SV. It also tells
704whether the value is defined or not.
954c1994
GS
705
706=for apidoc Am|bool|SvIOKp|SV* sv
707Returns a boolean indicating whether the SV contains an integer. Checks
708the B<private> setting. Use C<SvIOK>.
709
710=for apidoc Am|bool|SvNOKp|SV* sv
711Returns a boolean indicating whether the SV contains a double. Checks the
712B<private> setting. Use C<SvNOK>.
713
714=for apidoc Am|bool|SvPOKp|SV* sv
715Returns a boolean indicating whether the SV contains a character string.
716Checks the B<private> setting. Use C<SvPOK>.
717
718=for apidoc Am|bool|SvIOK|SV* sv
719Returns a boolean indicating whether the SV contains an integer.
720
721=for apidoc Am|void|SvIOK_on|SV* sv
722Tells an SV that it is an integer.
723
724=for apidoc Am|void|SvIOK_off|SV* sv
725Unsets the IV status of an SV.
726
727=for apidoc Am|void|SvIOK_only|SV* sv
728Tells an SV that it is an integer and disables all other OK bits.
729
e331fc52
JH
730=for apidoc Am|void|SvIOK_only_UV|SV* sv
731Tells and SV that it is an unsigned integer and disables all other OK bits.
732
12fa07df 733=for apidoc Am|bool|SvIOK_UV|SV* sv
e331fc52
JH
734Returns a boolean indicating whether the SV contains an unsigned integer.
735
28e5dec8
JH
736=for apidoc Am|void|SvUOK|SV* sv
737Returns a boolean indicating whether the SV contains an unsigned integer.
738
12fa07df 739=for apidoc Am|bool|SvIOK_notUV|SV* sv
d1be9408 740Returns a boolean indicating whether the SV contains a signed integer.
e331fc52 741
954c1994
GS
742=for apidoc Am|bool|SvNOK|SV* sv
743Returns a boolean indicating whether the SV contains a double.
744
745=for apidoc Am|void|SvNOK_on|SV* sv
746Tells an SV that it is a double.
747
748=for apidoc Am|void|SvNOK_off|SV* sv
749Unsets the NV status of an SV.
750
751=for apidoc Am|void|SvNOK_only|SV* sv
752Tells an SV that it is a double and disables all other OK bits.
753
754=for apidoc Am|bool|SvPOK|SV* sv
755Returns a boolean indicating whether the SV contains a character
756string.
757
758=for apidoc Am|void|SvPOK_on|SV* sv
759Tells an SV that it is a string.
760
761=for apidoc Am|void|SvPOK_off|SV* sv
762Unsets the PV status of an SV.
763
764=for apidoc Am|void|SvPOK_only|SV* sv
765Tells an SV that it is a string and disables all other OK bits.
1e54db1a 766Will also turn off the UTF-8 status.
954c1994 767
b0f01acb
JP
768=for apidoc Am|bool|SvVOK|SV* sv
769Returns a boolean indicating whether the SV contains a v-string.
770
954c1994
GS
771=for apidoc Am|bool|SvOOK|SV* sv
772Returns a boolean indicating whether the SvIVX is a valid offset value for
773the SvPVX. This hack is used internally to speed up removal of characters
774from the beginning of a SvPV. When SvOOK is true, then the start of the
775allocated string buffer is really (SvPVX - SvIVX).
776
777=for apidoc Am|bool|SvROK|SV* sv
778Tests if the SV is an RV.
779
780=for apidoc Am|void|SvROK_on|SV* sv
781Tells an SV that it is an RV.
782
783=for apidoc Am|void|SvROK_off|SV* sv
784Unsets the RV status of an SV.
785
786=for apidoc Am|SV*|SvRV|SV* sv
787Dereferences an RV to return the SV.
788
789=for apidoc Am|IV|SvIVX|SV* sv
645c22ef
DM
790Returns the raw value in the SV's IV slot, without checks or conversions.
791Only use when you are sure SvIOK is true. See also C<SvIV()>.
954c1994
GS
792
793=for apidoc Am|UV|SvUVX|SV* sv
645c22ef
DM
794Returns the raw value in the SV's UV slot, without checks or conversions.
795Only use when you are sure SvIOK is true. See also C<SvUV()>.
954c1994
GS
796
797=for apidoc Am|NV|SvNVX|SV* sv
645c22ef
DM
798Returns the raw value in the SV's NV slot, without checks or conversions.
799Only use when you are sure SvNOK is true. See also C<SvNV()>.
954c1994
GS
800
801=for apidoc Am|char*|SvPVX|SV* sv
645c22ef 802Returns a pointer to the physical string in the SV. The SV must contain a
954c1994
GS
803string.
804
805=for apidoc Am|STRLEN|SvCUR|SV* sv
806Returns the length of the string which is in the SV. See C<SvLEN>.
807
808=for apidoc Am|STRLEN|SvLEN|SV* sv
659239a4
MG
809Returns the size of the string buffer in the SV, not including any part
810attributable to C<SvOOK>. See C<SvCUR>.
954c1994
GS
811
812=for apidoc Am|char*|SvEND|SV* sv
813Returns a pointer to the last character in the string which is in the SV.
814See C<SvCUR>. Access the character as *(SvEND(sv)).
815
816=for apidoc Am|HV*|SvSTASH|SV* sv
817Returns the stash of the SV.
818
672994ce 819=for apidoc Am|void|SvIV_set|SV* sv|IV val
20799e15
SP
820Set the value of the IV pointer in sv to val. It is possible to perform
821the same function of this macro with an lvalue assignment to C<SvIVX>.
822With future Perls, however, it will be more efficient to use
823C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
672994ce
SP
824
825=for apidoc Am|void|SvNV_set|SV* sv|NV val
20799e15 826Set the value of the NV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
827
828=for apidoc Am|void|SvPV_set|SV* sv|char* val
20799e15 829Set the value of the PV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
830
831=for apidoc Am|void|SvUV_set|SV* sv|UV val
20799e15 832Set the value of the UV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
833
834=for apidoc Am|void|SvRV_set|SV* sv|SV* val
20799e15 835Set the value of the RV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
836
837=for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
20799e15 838Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
672994ce
SP
839
840=for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
20799e15 841Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
672994ce 842
954c1994 843=for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
20799e15
SP
844Set the current length of the string which is in the SV. See C<SvCUR>
845and C<SvIV_set>.
672994ce
SP
846
847=for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
20799e15 848Set the actual length of the string which is in the SV. See C<SvIV_set>.
954c1994
GS
849
850=cut
851*/
852
79072805 853#define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
748a9306 854#define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
a0d0e21e 855#define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
25da4f38 856 SVp_IOK|SVp_NOK|SVf_IVisUV))
79072805 857
5dc8bdac 858#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
29e97371 859#define assert_not_ROK(sv) ({assert(!SvROK(sv) || !SvRV(sv));}),
f7877b28 860#define assert_not_glob(sv) ({assert(!isGV_with_GP(sv));}),
906ed6d6 861#else
54866b45 862#define assert_not_ROK(sv)
f7877b28 863#define assert_not_glob(sv)
906ed6d6
NC
864#endif
865
463ee0b2 866#define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
f7877b28 867#define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 868 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
d41ff1b8 869 SVf_IVisUV|SVf_UTF8), \
25da4f38 870 SvOOK_off(sv))
54866b45 871#define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
906ed6d6 872 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
d41ff1b8 873 SVf_UTF8), \
a0d0e21e 874 SvOOK_off(sv))
79072805 875
8990e307
LW
876#define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
877#define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
f7877b28 878#define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
765f542d 879 SvFLAGS(sv) |= SVp_IOK)
8990e307 880#define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
f7877b28 881#define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
8990e307 882#define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
f7877b28 883#define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 884 SvFLAGS(sv) |= SVp_POK)
463ee0b2 885
79072805 886#define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
f7877b28 887#define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX(sv), \
765f542d 888 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38 889#define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
0c34ef67 890#define SvIOK_only(sv) (SvOK_off(sv), \
a0d0e21e 891 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
f7877b28 892#define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
25da4f38 893 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
70401c6b 894
25da4f38
IZ
895#define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
896 == (SVf_IOK|SVf_IVisUV))
28e5dec8 897#define SvUOK(sv) SvIOK_UV(sv)
25da4f38
IZ
898#define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
899 == SVf_IOK)
900
901#define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
902#define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
903#define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
79072805
LW
904
905#define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
f7877b28
NC
906#define SvNOK_on(sv) (assert_not_glob(sv) \
907 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
8990e307 908#define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
0c34ef67 909#define SvNOK_only(sv) (SvOK_off(sv), \
a0d0e21e 910 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
79072805 911
914184e1 912/*
12fa07df 913=for apidoc Am|bool|SvUTF8|SV* sv
914184e1
JH
914Returns a boolean indicating whether the SV contains UTF-8 encoded data.
915
916=for apidoc Am|void|SvUTF8_on|SV *sv
1e54db1a 917Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
d5ce4a7c 918Do not use frivolously.
914184e1
JH
919
920=for apidoc Am|void|SvUTF8_off|SV *sv
1e54db1a 921Unsets the UTF-8 status of an SV.
914184e1
JH
922
923=for apidoc Am|void|SvPOK_only_UTF8|SV* sv
d5ce4a7c 924Tells an SV that it is a string and disables all other OK bits,
1e54db1a 925and leaves the UTF-8 status as it was.
f1a1024e 926
914184e1
JH
927=cut
928 */
929
7a5fd60d
NC
930/* Ensure the return value of this macro does not clash with the GV_ADD* flags
931in gv.h: */
a7cb1f99
GS
932#define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
933#define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
934#define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
5bc28da9 935
79072805 936#define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
f7877b28 937#define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 938 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
8990e307 939#define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
f7877b28 940#define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 941 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
d41ff1b8
GS
942 SVf_IVisUV|SVf_UTF8), \
943 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
f7877b28 944#define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 945 SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
d41ff1b8 946 SVf_IVisUV), \
a0d0e21e 947 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
79072805 948
4f2da183
NC
949#define SvVOK(sv) (SvMAGICAL(sv) \
950 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
79072805 951#define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
155aba94 952#define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
0c34ef67 953#define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
79072805 954
a0d0e21e
LW
955#define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
956#define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
957#define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
958
ed6116ce 959#define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
a0d0e21e 960#define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
a0d0e21e 961#define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
79072805 962
8990e307
LW
963#define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
964#define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
965#define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
79072805 966
8990e307
LW
967#define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
968#define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
969#define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
ed6116ce 970
8990e307
LW
971#define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
972#define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
973#define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
ed6116ce 974
8990e307
LW
975#define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
976#define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
977#define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
ed6116ce 978
9e7bc3e8
JD
979#define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
980#define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
981#define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
a0d0e21e 982
8cf8f3d1 983#define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
1426bbf4 984
a0d0e21e
LW
985/*
986#define Gv_AMG(stash) \
987 (HV_AMAGICmb(stash) && \
988 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
989*/
3280af22 990#define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
a0d0e21e 991
810b8aa5
GS
992#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
993 == (SVf_ROK|SVprv_WEAKREF))
994#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
995#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
996
a0d0e21e 997#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 998
d9d18af6
DM
999#define SvPADSTALE(sv) (SvFLAGS(sv) & SVs_PADSTALE)
1000#define SvPADSTALE_on(sv) (SvFLAGS(sv) |= SVs_PADSTALE)
1001#define SvPADSTALE_off(sv) (SvFLAGS(sv) &= ~SVs_PADSTALE)
1002
8990e307 1003#define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
235cc2e3 1004#define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP)
8990e307 1005#define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
ed6116ce 1006
8990e307 1007#define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
235cc2e3 1008#define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
ed6116ce 1009
8990e307
LW
1010#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
1011#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
1012#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 1013
8990e307
LW
1014#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
1015#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
1016#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 1017
8990e307
LW
1018#define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
1019#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
1020#define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
79072805 1021
180488f8 1022#define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
8990e307
LW
1023#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
1024#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 1025
8990e307
LW
1026#define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
1027#define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
1028#define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
79072805 1029
25da4f38
IZ
1030#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
1031#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
1032#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
1033
8990e307
LW
1034#define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
1035#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1036#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1037
8990e307
LW
1038#define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
1039#define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1040#define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
1041
1cc8b4c5
AB
1042#ifdef USE_ITHREADS
1043/* The following uses the FAKE flag to show that a regex pointer is infact
8ca6097c 1044 its own offset in the regexpad for ithreads */
1cc8b4c5
AB
1045#define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
1046#define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
1047#define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
1048#endif
1049
075bae1e
NC
1050#define SvPAD_TYPED(sv) \
1051 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1052#define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
00b1698f 1053
075bae1e
NC
1054#define SvPAD_OUR(sv) \
1055 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1056#define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
00b1698f 1057
e736a858
NC
1058#define OURSTASH(sv) \
1059 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1060#define OURSTASH_set(sv, st) \
1061 STMT_START { \
2892acdb 1062 assert(SvTYPE(sv) == SVt_PVMG); \
e736a858 1063 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
035dab74
NC
1064 } STMT_END
1065
b162af07 1066#ifdef PERL_DEBUG_COW
339049b0 1067#define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
b162af07 1068#else
339049b0 1069#define SvRV(sv) ((sv)->sv_u.svu_rv)
b162af07 1070#endif
ed6116ce
LW
1071#define SvRVx(sv) SvRV(sv)
1072
f599b64b 1073#ifdef PERL_DEBUG_COW
8ed30cc1
DD
1074/* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1075 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
771ba71a
NC
1076# define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1077# define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
58430790 1078# define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
c0e1089a 1079/* Don't test the core XS code yet. */
771ba71a
NC
1080# if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1081# define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1082# else
1083# define SvPVX(sv) SvPVX_mutable(sv)
1084# endif
771ba71a
NC
1085# define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1086# define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1087# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1088
1089# ifdef DEBUGGING
064cf529
NC
1090# define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1091# define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*) SvANY(sv))->xmg_stash))
03687789 1092# else
064cf529
NC
1093# define SvMAGIC(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic)
1094# define SvSTASH(sv) (0 + ((XPVMG*) SvANY(sv))->xmg_stash)
03687789 1095# endif
f599b64b 1096#else
771ba71a
NC
1097# define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1098# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1099
05ef5f8f
NC
1100# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1101/* These get expanded inside other macros that already use a variable _sv */
f7877b28
NC
1102# define SvPVX(sv) \
1103 (*({ SV *const _svi = (SV *) sv; \
1104 assert(SvTYPE(_svi) >= SVt_PV); \
1105 assert(SvTYPE(_svi) != SVt_PVAV); \
1106 assert(SvTYPE(_svi) != SVt_PVHV); \
1107 assert(!isGV_with_GP(_svi)); \
1108 &((_svi)->sv_u.svu_pv); \
1109 }))
08002bbf
NC
1110# define SvCUR(sv) \
1111 (*({ SV *const _svi = (SV *) sv; \
1112 assert(SvTYPE(_svi) >= SVt_PV); \
1113 assert(SvTYPE(_svi) != SVt_PVAV); \
1114 assert(SvTYPE(_svi) != SVt_PVHV); \
1115 assert(!isGV_with_GP(_svi)); \
1116 &(((XPV*) SvANY(_svi))->xpv_cur); \
1117 }))
05ef5f8f
NC
1118# define SvIVX(sv) \
1119 (*({ SV *const _svi = (SV *) sv; \
1120 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
675eb423
NC
1121 assert(SvTYPE(_svi) != SVt_PVAV); \
1122 assert(SvTYPE(_svi) != SVt_PVHV); \
bb172083 1123 assert(SvTYPE(_svi) != SVt_PVCV); \
27bd069f 1124 assert(!isGV_with_GP(_svi)); \
05ef5f8f
NC
1125 &(((XPVIV*) SvANY(_svi))->xiv_iv); \
1126 }))
1127# define SvUVX(sv) \
1128 (*({ SV *const _svi = (SV *) sv; \
1129 assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
675eb423
NC
1130 assert(SvTYPE(_svi) != SVt_PVAV); \
1131 assert(SvTYPE(_svi) != SVt_PVHV); \
bb172083 1132 assert(SvTYPE(_svi) != SVt_PVCV); \
27bd069f 1133 assert(!isGV_with_GP(_svi)); \
05ef5f8f
NC
1134 &(((XPVUV*) SvANY(_svi))->xuv_uv); \
1135 }))
1136# define SvNVX(sv) \
1137 (*({ SV *const _svi = (SV *) sv; \
675eb423
NC
1138 assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \
1139 assert(SvTYPE(_svi) != SVt_PVAV); \
1140 assert(SvTYPE(_svi) != SVt_PVHV); \
3038937b 1141 assert(SvTYPE(_svi) != SVt_PVFM); \
27bd069f 1142 assert(!isGV_with_GP(_svi)); \
58430790 1143 &(((XPVNV*) SvANY(_svi))->xnv_u.xnv_nv); \
05ef5f8f
NC
1144 }))
1145# define SvMAGIC(sv) \
1146 (*({ SV *const _svi = (SV *) sv; \
1147 assert(SvTYPE(_svi) >= SVt_PVMG); \
e736a858 1148 &(((XPVMG*) SvANY(_svi))->xmg_u.xmg_magic); \
05ef5f8f
NC
1149 }))
1150# define SvSTASH(sv) \
1151 (*({ SV *const _svi = (SV *) sv; \
1152 assert(SvTYPE(_svi) >= SVt_PVMG); \
1153 &(((XPVMG*) SvANY(_svi))->xmg_stash); \
1154 }))
03687789 1155# else
08002bbf
NC
1156# define SvPVX(sv) ((sv)->sv_u.svu_pv)
1157# define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
05ef5f8f
NC
1158# define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1159# define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
58430790 1160# define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
e736a858 1161# define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
771ba71a 1162# define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
03687789 1163# endif
62703e72
NC
1164#endif
1165
06c0cc96 1166#ifndef PERL_POISON
bb496845
SP
1167/* Given that these two are new, there can't be any existing code using them
1168 * as LVALUEs */
06c0cc96
NC
1169# define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1170# define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1171#else
1172/* Except for the poison code, which uses & to scribble over the pointer after
1173 free() is called. */
1174# define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1175# define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1176#endif
bb496845 1177
62703e72
NC
1178#define SvIVXx(sv) SvIVX(sv)
1179#define SvUVXx(sv) SvUVX(sv)
1180#define SvNVXx(sv) SvNVX(sv)
1181#define SvPVXx(sv) SvPVX(sv)
1182#define SvLENx(sv) SvLEN(sv)
1183#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1184
1185
28e5dec8
JH
1186/* Ask a scalar nicely to try to become an IV, if possible.
1187 Not guaranteed to stay returning void */
1188/* Macro won't actually call sv_2iv if already IOK */
1189#define SvIV_please(sv) \
1190 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1191 (void) SvIV(sv); } STMT_END
79072805 1192#define SvIV_set(sv, val) \
80b92232 1193 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
08002bbf 1194 assert(!isGV_with_GP(sv)); \
b19bbeda 1195 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
79072805 1196#define SvNV_set(sv, val) \
80b92232 1197 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
7ffec4a4 1198 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
08002bbf 1199 assert(!isGV_with_GP(sv)); \
58430790 1200 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
79072805 1201#define SvPV_set(sv, val) \
80b92232 1202 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
08002bbf 1203 assert(!isGV_with_GP(sv)); \
339049b0 1204 ((sv)->sv_u.svu_pv = (val)); } STMT_END
607fa7f2
SP
1205#define SvUV_set(sv, val) \
1206 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
08002bbf 1207 assert(!isGV_with_GP(sv)); \
607fa7f2 1208 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
b162af07
SP
1209#define SvRV_set(sv, val) \
1210 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
08002bbf 1211 assert(!isGV_with_GP(sv)); \
339049b0 1212 ((sv)->sv_u.svu_rv = (val)); } STMT_END
b162af07
SP
1213#define SvMAGIC_set(sv, val) \
1214 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
e736a858 1215 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
b162af07
SP
1216#define SvSTASH_set(sv, val) \
1217 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1218 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
79072805 1219#define SvCUR_set(sv, val) \
80b92232 1220 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
08002bbf 1221 assert(!isGV_with_GP(sv)); \
b162af07 1222 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
79072805 1223#define SvLEN_set(sv, val) \
80b92232 1224 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
f7877b28 1225 assert(!isGV_with_GP(sv)); \
b162af07 1226 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
7ae8ee9e
NC
1227#define SvEND_set(sv, val) \
1228 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1229 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
79072805 1230
b7e9a5c2 1231#define SvPV_renew(sv,n) \
1da4ca5f
NC
1232 STMT_START { SvLEN_set(sv, n); \
1233 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1234 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1235 (MEM_SIZE)((n))))); \
1236 } STMT_END
1237
1238#define SvPV_shrink_to_cur(sv) STMT_START { \
1239 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1240 SvPV_renew(sv, _lEnGtH); \
1241 } STMT_END
b7e9a5c2 1242
771ba71a
NC
1243#define SvPV_free(sv) \
1244 STMT_START { \
1245 assert(SvTYPE(sv) >= SVt_PV); \
1246 if (SvLEN(sv)) { \
1247 if(SvOOK(sv)) { \
1248 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \
1249 SvFLAGS(sv) &= ~SVf_OOK; \
1250 } \
1251 Safefree(SvPVX(sv)); \
1252 } \
1253 } STMT_END
8bd4d4c5 1254
79072805
LW
1255#define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
1256#define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
1257#define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
1258
1259#define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1260
1261#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1262#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1263#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1264#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1265
8990e307
LW
1266#define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1267#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1268#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
4755096e 1269#define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
8990e307
LW
1270#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1271#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1272#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1273#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1274#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1275#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1276#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1277#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1278#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1279#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1280#define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
1281#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1282#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1283
50952442 1284/* IoTYPE(sv) is a single character telling the type of I/O connection. */
3b6c1aba
JH
1285#define IoTYPE_RDONLY '<'
1286#define IoTYPE_WRONLY '>'
1287#define IoTYPE_RDWR '+'
1288#define IoTYPE_APPEND 'a'
1289#define IoTYPE_PIPE '|'
1290#define IoTYPE_STD '-' /* stdin or stdout */
1291#define IoTYPE_SOCKET 's'
1292#define IoTYPE_CLOSED ' '
1293#define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1294#define IoTYPE_NUMERIC '#' /* fdopen */
03fcf2fc
GS
1295
1296/*
954c1994
GS
1297=for apidoc Am|bool|SvTAINTED|SV* sv
1298Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1299not.
1300
1301=for apidoc Am|void|SvTAINTED_on|SV* sv
c55831ac 1302Marks an SV as tainted if tainting is enabled.
954c1994
GS
1303
1304=for apidoc Am|void|SvTAINTED_off|SV* sv
1305Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1306some of Perl's fundamental security features. XS module authors should not
1307use this function unless they fully understand all the implications of
1308unconditionally untainting the value. Untainting should be done in the
1309standard perl fashion, via a carefully crafted regexp, rather than directly
1310untainting variables.
1311
1312=for apidoc Am|void|SvTAINT|SV* sv
c55831ac 1313Taints an SV if tainting is enabled.
954c1994
GS
1314
1315=cut
1316*/
1317
a0714e2c 1318#define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
aae9cea0 1319
bbce6d69 1320#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22
NIS
1321#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1322#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 1323
c6ee37c5
MB
1324#define SvTAINT(sv) \
1325 STMT_START { \
3280af22 1326 if (PL_tainting) { \
3280af22 1327 if (PL_tainted) \
c6ee37c5
MB
1328 SvTAINTED_on(sv); \
1329 } \
1330 } STMT_END
79072805 1331
954c1994
GS
1332/*
1333=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
5f08bad4
ST
1334Like C<SvPV> but will force the SV into containing just a string
1335(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1336directly.
954c1994 1337
645c22ef 1338=for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
5f08bad4
ST
1339Like C<SvPV> but will force the SV into containing just a string
1340(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1341directly. Doesn't process magic.
645c22ef 1342
954c1994 1343=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
5f08bad4
ST
1344Returns a pointer to the string in the SV, or a stringified form of
1345the SV if the SV does not contain a string. The SV may cache the
1346stringified version becoming C<SvPOK>. Handles 'get' magic. See also
645c22ef
DM
1347C<SvPVx> for a version which guarantees to evaluate sv only once.
1348
1349=for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1350A version of C<SvPV> which guarantees to evaluate sv only once.
954c1994 1351
891f9566
YST
1352=for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1353Like C<SvPV> but doesn't process magic.
1354
954c1994 1355=for apidoc Am|char*|SvPV_nolen|SV* sv
5f08bad4
ST
1356Returns a pointer to the string in the SV, or a stringified form of
1357the SV if the SV does not contain a string. The SV may cache the
1358stringified form becoming C<SvPOK>. Handles 'get' magic.
954c1994
GS
1359
1360=for apidoc Am|IV|SvIV|SV* sv
645c22ef
DM
1361Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1362version which guarantees to evaluate sv only once.
1363
891f9566
YST
1364=for apidoc Am|IV|SvIV_nomg|SV* sv
1365Like C<SvIV> but doesn't process magic.
1366
645c22ef
DM
1367=for apidoc Am|IV|SvIVx|SV* sv
1368Coerces the given SV to an integer and returns it. Guarantees to evaluate
d1be9408 1369sv only once. Use the more efficient C<SvIV> otherwise.
954c1994
GS
1370
1371=for apidoc Am|NV|SvNV|SV* sv
645c22ef
DM
1372Coerce the given SV to a double and return it. See C<SvNVx> for a version
1373which guarantees to evaluate sv only once.
1374
1375=for apidoc Am|NV|SvNVx|SV* sv
1376Coerces the given SV to a double and returns it. Guarantees to evaluate
d1be9408 1377sv only once. Use the more efficient C<SvNV> otherwise.
954c1994
GS
1378
1379=for apidoc Am|UV|SvUV|SV* sv
645c22ef
DM
1380Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1381for a version which guarantees to evaluate sv only once.
1382
891f9566
YST
1383=for apidoc Am|UV|SvUV_nomg|SV* sv
1384Like C<SvUV> but doesn't process magic.
1385
645c22ef
DM
1386=for apidoc Am|UV|SvUVx|SV* sv
1387Coerces the given SV to an unsigned integer and returns it. Guarantees to
d1be9408 1388evaluate sv only once. Use the more efficient C<SvUV> otherwise.
954c1994
GS
1389
1390=for apidoc Am|bool|SvTRUE|SV* sv
1391Returns a boolean indicating whether Perl would evaluate the SV as true or
1392false, defined or undefined. Does not handle 'get' magic.
1393
645c22ef 1394=for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
b70b15d2 1395Like C<SvPV_force>, but converts sv to utf8 first if necessary.
645c22ef
DM
1396
1397=for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
b70b15d2 1398Like C<SvPV>, but converts sv to utf8 first if necessary.
645c22ef 1399
b70b15d2
TJ
1400=for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1401Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
645c22ef
DM
1402
1403=for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1404Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1405
1406=for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1407Like C<SvPV>, but converts sv to byte representation first if necessary.
1408
b70b15d2 1409=for apidoc Am|char*|SvPVbyte_nolen|SV* sv
645c22ef
DM
1410Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1411
1412=for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
b70b15d2 1413Like C<SvPV_force>, but converts sv to utf8 first if necessary.
d1be9408 1414Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
645c22ef
DM
1415otherwise.
1416
1417=for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
b70b15d2 1418Like C<SvPV>, but converts sv to utf8 first if necessary.
d1be9408 1419Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
645c22ef
DM
1420otherwise.
1421
1422=for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1423Like C<SvPV_force>, but converts sv to byte representation first if necessary.
d1be9408 1424Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
645c22ef
DM
1425otherwise.
1426
1427=for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1428Like C<SvPV>, but converts sv to byte representation first if necessary.
d1be9408 1429Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
645c22ef
DM
1430otherwise.
1431
19dbb8f1
NC
1432=for apidoc Am|bool|SvIsCOW|SV* sv
1433Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1434hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1435COW)
1436
1437=for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1438Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1439scalar.
645c22ef 1440
0f76ff59
MHM
1441=for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1442Like C<sv_catpvn> but doesn't process magic.
1443
1444=for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1445Like C<sv_setsv> but doesn't process magic.
1446
1447=for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1448Like C<sv_catsv> but doesn't process magic.
1449
954c1994
GS
1450=cut
1451*/
1452
25da4f38 1453/* Let us hope that bitmaps for UV and IV are the same */
463ee0b2 1454#define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
ff68c719 1455#define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
463ee0b2 1456#define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 1457
891f9566
YST
1458#define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1459#define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1460
baca2b92 1461/* ----*/
8d6d96c1 1462
8d6d96c1 1463#define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
32a5c6ec 1464#define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
44d22300 1465#define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
8d6d96c1 1466
8d6d96c1
HS
1467#define SvPV_flags(sv, lp, flags) \
1468 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1469 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
32a5c6ec
NC
1470#define SvPV_flags_const(sv, lp, flags) \
1471 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1472 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1473 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
2596d9fe
NC
1474#define SvPV_flags_const_nolen(sv, flags) \
1475 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1476 ? SvPVX_const(sv) : \
1477 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
44d22300
NC
1478#define SvPV_flags_mutable(sv, lp, flags) \
1479 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1480 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1481 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
79072805 1482
8d6d96c1 1483#define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
13c5b33c 1484#define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
32a5c6ec 1485#define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
baca2b92 1486
8d6d96c1 1487#define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
2596d9fe 1488#define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
8d6d96c1 1489
8d6d96c1 1490#define SvPV_force_flags(sv, lp, flags) \
ff68c719 1491 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
8d6d96c1 1492 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
13c5b33c
NC
1493#define SvPV_force_flags_nolen(sv, flags) \
1494 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1495 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
32a5c6ec
NC
1496#define SvPV_force_flags_mutable(sv, lp, flags) \
1497 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1498 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1499 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
a0d0e21e 1500
1fa8b10d 1501#define SvPV_nolen(sv) \
5bc28da9 1502 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
dafda6d1 1503 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
70401c6b 1504
9ce348e8
NC
1505#define SvPV_nolen_const(sv) \
1506 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1507 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1508
baca2b92 1509#define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
9ce348e8 1510#define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
2596d9fe 1511#define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
5bc28da9 1512
baca2b92 1513/* ----*/
70401c6b 1514
5bc28da9
NIS
1515#define SvPVutf8(sv, lp) \
1516 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1517 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 1518
5bc28da9 1519#define SvPVutf8_force(sv, lp) \
70401c6b 1520 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
5bc28da9
NIS
1521 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1522
baca2b92 1523
5bc28da9
NIS
1524#define SvPVutf8_nolen(sv) \
1525 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
dafda6d1 1526 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
70401c6b 1527
baca2b92
DM
1528/* ----*/
1529
5bc28da9
NIS
1530#define SvPVbyte(sv, lp) \
1531 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1532 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
70401c6b 1533
5bc28da9
NIS
1534#define SvPVbyte_force(sv, lp) \
1535 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
a7ec4e2e 1536 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
5bc28da9 1537
5bc28da9
NIS
1538#define SvPVbyte_nolen(sv) \
1539 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
dafda6d1 1540 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
70401c6b 1541
1fa8b10d 1542
baca2b92
DM
1543
1544/* define FOOx(): idempotent versions of FOO(). If possible, use a local
1545 * var to evaluate the arg once; failing that, use a global if possible;
1546 * failing that, call a function to do the work
1547 */
1548
1549#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1550#define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1551#define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1552
5dc8bdac 1553#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
baca2b92 1554
3de3296f
AE
1555# define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1556# define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1557# define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1558# define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
32a5c6ec 1559# define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
002e4c74 1560# define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
9ce348e8 1561# define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
3de3296f
AE
1562# define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1563# define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
002e4c74 1564# define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
a80f87c4 1565# define SvTRUE(sv) ( \
8990e307
LW
1566 !sv \
1567 ? 0 \
1568 : SvPOK(sv) \
a80f87c4
GS
1569 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1570 nxpv && \
c2f1de04 1571 (nxpv->xpv_cur > 1 || \
339049b0 1572 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
79072805
LW
1573 ? 1 \
1574 : 0) \
1575 : \
1576 SvIOK(sv) \
463ee0b2 1577 ? SvIVX(sv) != 0 \
79072805 1578 : SvNOK(sv) \
463ee0b2
LW
1579 ? SvNVX(sv) != 0.0 \
1580 : sv_2bool(sv) )
3de3296f 1581# define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
baca2b92 1582
a80f87c4 1583#else /* __GNUC__ */
baca2b92 1584
a80f87c4
GS
1585/* These inlined macros use globals, which will require a thread
1586 * declaration in user code, so we avoid them under threads */
1587
3db8f154
MB
1588# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1589# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1590# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1591# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
32a5c6ec 1592# define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
002e4c74 1593# define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
5f1478c3 1594# define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
3db8f154
MB
1595# define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1596# define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
002e4c74 1597# define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
3db8f154 1598# define SvTRUE(sv) ( \
a80f87c4
GS
1599 !sv \
1600 ? 0 \
1601 : SvPOK(sv) \
7b2c381c 1602 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
c2f1de04 1603 (PL_Xpv->xpv_cur > 1 || \
339049b0 1604 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
a80f87c4
GS
1605 ? 1 \
1606 : 0) \
1607 : \
1608 SvIOK(sv) \
1609 ? SvIVX(sv) != 0 \
1610 : SvNOK(sv) \
1611 ? SvNVX(sv) != 0.0 \
1612 : sv_2bool(sv) )
3db8f154 1613# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
baca2b92
DM
1614#endif /* __GNU__ */
1615
765f542d
NC
1616#define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1617 (SVf_FAKE | SVf_READONLY))
46187eeb 1618#define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
baca2b92 1619
bdd68bc3
NC
1620#define SvSHARED_HEK_FROM_PV(pvx) \
1621 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
0a356b31 1622#define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
c158a4fd 1623
baca2b92
DM
1624/* flag values for sv_*_flags functions */
1625#define SV_IMMEDIATE_UNREF 1
1626#define SV_GMAGIC 2
765f542d 1627#define SV_COW_DROP_PV 4
88632417 1628#define SV_UTF8_NO_ENCODING 8
5fcdf167 1629#define SV_NOSTEAL 16
32a5c6ec
NC
1630#define SV_CONST_RETURN 32
1631#define SV_MUTABLE_RETURN 64
bddd5118 1632#define SV_SMAGIC 128
765f542d 1633
5abc721d
NC
1634#define sv_unref(sv) sv_unref_flags(sv, 0)
1635#define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
174c73e3 1636
46187eeb
NC
1637/* We are about to replace the SV's current value. So if it's copy on write
1638 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1639 the value is about to get thrown away, so drop the PV rather than go to
1640 the effort of making a read-write copy only for it to get immediately
1641 discarded. */
765f542d
NC
1642
1643#define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1644 sv_force_normal_flags(sv, SV_COW_DROP_PV)
46187eeb 1645
f8c7b90f 1646#ifdef PERL_OLD_COPY_ON_WRITE
46187eeb 1647# define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
b885210e 1648 && Perl_sv_release_IVX(aTHX_ sv)))
46187eeb 1649# define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
b8f9541a
NC
1650#else
1651# define SvRELEASE_IVX(sv) SvOOK_off(sv)
f8c7b90f 1652#endif /* PERL_OLD_COPY_ON_WRITE */
ed252734
NC
1653
1654#define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1655 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1656 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1657#define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1658
765f542d
NC
1659#define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1660 sv_force_normal_flags(sv, 0)
1661
1662
baca2b92
DM
1663/* all these 'functions' are now just macros */
1664
1665#define sv_pv(sv) SvPV_nolen(sv)
1666#define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1667#define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1668
1669#define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1670#define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1671#define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1672#define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1673#define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1674#define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1675#define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
b347df82 1676#define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
baca2b92 1677#define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
b347df82
NC
1678#define sv_catpvn_mg(sv, sstr, slen) \
1679 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
baca2b92 1680#define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
cb2f1b7b
NC
1681#define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1682#define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1683#define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
baca2b92
DM
1684#define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1685#define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1686#define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
891f9566
YST
1687#define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1688#define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
baca2b92 1689
db79b45b
JH
1690/* Should be named SvCatPVN_utf8_upgrade? */
1691#define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1692 STMT_START { \
1693 if (!(nsv)) \
1694 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1695 else \
1696 sv_setpvn(nsv, sstr, slen); \
1697 SvUTF8_off(nsv); \
1698 sv_utf8_upgrade(nsv); \
1699 sv_catsv(dsv, nsv); \
1700 } STMT_END
79072805 1701
954c1994
GS
1702/*
1703=for apidoc Am|SV*|newRV_inc|SV* sv
1704
1705Creates an RV wrapper for an SV. The reference count for the original SV is
1706incremented.
1707
1708=cut
1709*/
1710
5f05dabc 1711#define newRV_inc(sv) newRV(sv)
5f05dabc 1712
ef50df4b 1713/* the following macros update any magic values this sv is associated with */
79072805 1714
954c1994 1715/*
ccfc67b7
JH
1716=head1 Magical Functions
1717
954c1994
GS
1718=for apidoc Am|void|SvGETMAGIC|SV* sv
1719Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1720argument more than once.
1721
1722=for apidoc Am|void|SvSETMAGIC|SV* sv
1723Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1724argument more than once.
1725
1726=for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1727Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1728more than once.
1729
1730=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1731Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1732ssv. May evaluate arguments more than once.
1733
645c22ef
DM
1734=for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1735Like C<SvSetSV>, but does any set magic required afterwards.
1736
1737=for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
80663158 1738Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
645c22ef 1739
68795e93
NIS
1740=for apidoc Am|void|SvSHARE|SV* sv
1741Arranges for sv to be shared between threads if a suitable module
1742has been loaded.
1743
1744=for apidoc Am|void|SvLOCK|SV* sv
1745Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1746has been loaded.
1747
1748=for apidoc Am|void|SvUNLOCK|SV* sv
1749Releases a mutual exclusion lock on sv if a suitable module
1750has been loaded.
1751
ccfc67b7
JH
1752=head1 SV Manipulation Functions
1753
679ac26e 1754=for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
954c1994
GS
1755Expands the character buffer in the SV so that it has room for the
1756indicated number of bytes (remember to reserve space for an extra trailing
8cf8f3d1 1757NUL character). Calls C<sv_grow> to perform the expansion if necessary.
954c1994
GS
1758Returns a pointer to the character buffer.
1759
1760=cut
1761*/
1762
68795e93
NIS
1763#define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1764#define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1765#define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1766
189b2af5
GS
1767#define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1768#define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
79072805 1769
54310121 1770#define SvSetSV_and(dst,src,finally) \
189b2af5 1771 STMT_START { \
54310121
PP
1772 if ((dst) != (src)) { \
1773 sv_setsv(dst, src); \
1774 finally; \
189b2af5
GS
1775 } \
1776 } STMT_END
54310121 1777#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 1778 STMT_START { \
8ebc5c01 1779 if ((dst) != (src)) { \
5fcdf167 1780 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL); \
54310121 1781 finally; \
189b2af5
GS
1782 } \
1783 } STMT_END
79072805 1784
54310121 1785#define SvSetSV(dst,src) \
c9d716f7 1786 SvSetSV_and(dst,src,/*nothing*/;)
54310121 1787#define SvSetSV_nosteal(dst,src) \
c9d716f7 1788 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121
PP
1789
1790#define SvSetMagicSV(dst,src) \
1791 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1792#define SvSetMagicSV_nosteal(dst,src) \
1793 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1794
db79b45b 1795
1045810a 1796#if !defined(SKIP_DEBUGGING)
79072805 1797#define SvPEEK(sv) sv_peek(sv)
3967c732
JD
1798#else
1799#define SvPEEK(sv) ""
1800#endif
79072805 1801
5dc8bdac 1802#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
36477c24 1803
3280af22 1804#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 1805
79072805 1806#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
f7877b28
NC
1807/* If I give every macro argument a different name, then there won't be bugs
1808 where nested macros get confused. Been there, done that. */
1809#define isGV_with_GP(pwadak) \
1810 (((SvFLAGS(pwadak) & (SVp_POK|SVp_SCREAM)) == SVp_SCREAM) \
1811 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
79072805 1812
933fea7f 1813#define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
5902b6a9
NC
1814#define SvGROW_mutable(sv,len) \
1815 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
933fea7f 1816#define Sv_Grow sv_grow
3d35f11b 1817
a0739874
DM
1818#define CLONEf_COPY_STACKS 1
1819#define CLONEf_KEEP_PTR_TABLE 2
c43294b8 1820#define CLONEf_CLONE_HOST 4
0405e91e 1821#define CLONEf_JOIN_IN 8
a0739874 1822
8cf8f3d1 1823struct clone_params {
d2d73c3e
AB
1824 AV* stashes;
1825 UV flags;
59b40662 1826 PerlInterpreter *proto_perl;
8cf8f3d1 1827};
102d3b8a
NC
1828
1829/*
1830 * Local variables:
1831 * c-indentation-style: bsd
1832 * c-basic-offset: 4
1833 * indent-tabs-mode: t
1834 * End:
1835 *
1836 * ex: set ts=8 sts=4 sw=4 noet:
1837 */