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