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