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