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