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