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