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