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