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