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