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