This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Redo previous sv.h change.
[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 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); \
1014 &(((XPVMG*) SvANY(_svi))->xmg_magic); \
1015 }))
1016# define SvSTASH(sv) \
1017 (*({ SV *const _svi = (SV *) sv; \
1018 assert(SvTYPE(_svi) >= SVt_PVMG); \
1019 &(((XPVMG*) SvANY(_svi))->xmg_stash); \
1020 }))
03687789 1021# else
05ef5f8f
NC
1022# define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1023# define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1024# define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_nv
771ba71a
NC
1025# define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
1026# define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
03687789 1027# endif
62703e72
NC
1028#endif
1029
06c0cc96 1030#ifndef PERL_POISON
bb496845
SP
1031/* Given that these two are new, there can't be any existing code using them
1032 * as LVALUEs */
06c0cc96
NC
1033# define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1034# define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1035#else
1036/* Except for the poison code, which uses & to scribble over the pointer after
1037 free() is called. */
1038# define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1039# define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1040#endif
bb496845 1041
62703e72
NC
1042#define SvIVXx(sv) SvIVX(sv)
1043#define SvUVXx(sv) SvUVX(sv)
1044#define SvNVXx(sv) SvNVX(sv)
1045#define SvPVXx(sv) SvPVX(sv)
1046#define SvLENx(sv) SvLEN(sv)
1047#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1048
1049
28e5dec8
JH
1050/* Ask a scalar nicely to try to become an IV, if possible.
1051 Not guaranteed to stay returning void */
1052/* Macro won't actually call sv_2iv if already IOK */
1053#define SvIV_please(sv) \
1054 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1055 (void) SvIV(sv); } STMT_END
79072805 1056#define SvIV_set(sv, val) \
80b92232 1057 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
b19bbeda 1058 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
79072805 1059#define SvNV_set(sv, val) \
80b92232 1060 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
7ffec4a4 1061 assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
f599b64b 1062 (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END
79072805 1063#define SvPV_set(sv, val) \
80b92232 1064 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
339049b0 1065 ((sv)->sv_u.svu_pv = (val)); } STMT_END
607fa7f2
SP
1066#define SvUV_set(sv, val) \
1067 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1068 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
b162af07
SP
1069#define SvRV_set(sv, val) \
1070 STMT_START { assert(SvTYPE(sv) >= SVt_RV); \
339049b0 1071 ((sv)->sv_u.svu_rv = (val)); } STMT_END
b162af07
SP
1072#define SvMAGIC_set(sv, val) \
1073 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1074 (((XPVMG*)SvANY(sv))->xmg_magic = (val)); } STMT_END
1075#define SvSTASH_set(sv, val) \
1076 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1077 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
79072805 1078#define SvCUR_set(sv, val) \
80b92232 1079 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
b162af07 1080 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
79072805 1081#define SvLEN_set(sv, val) \
80b92232 1082 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
b162af07 1083 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
7ae8ee9e
NC
1084#define SvEND_set(sv, val) \
1085 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1086 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
79072805 1087
b7e9a5c2 1088#define SvPV_renew(sv,n) \
1da4ca5f
NC
1089 STMT_START { SvLEN_set(sv, n); \
1090 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1091 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1092 (MEM_SIZE)((n))))); \
1093 } STMT_END
1094
1095#define SvPV_shrink_to_cur(sv) STMT_START { \
1096 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1097 SvPV_renew(sv, _lEnGtH); \
1098 } STMT_END
b7e9a5c2 1099
771ba71a
NC
1100#define SvPV_free(sv) \
1101 STMT_START { \
1102 assert(SvTYPE(sv) >= SVt_PV); \
1103 if (SvLEN(sv)) { \
1104 if(SvOOK(sv)) { \
1105 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \
1106 SvFLAGS(sv) &= ~SVf_OOK; \
1107 } \
1108 Safefree(SvPVX(sv)); \
1109 } \
1110 } STMT_END
8bd4d4c5 1111
79072805
LW
1112#define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
1113#define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
1114#define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
1115
1116#define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
1117
1118#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1119#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1120#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1121#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
1122
8990e307
LW
1123#define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
1124#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1125#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
4755096e 1126#define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
8990e307
LW
1127#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
1128#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1129#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1130#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1131#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1132#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1133#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1134#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1135#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1136#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
1137#define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
1138#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1139#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1140
50952442 1141/* IoTYPE(sv) is a single character telling the type of I/O connection. */
3b6c1aba
JH
1142#define IoTYPE_RDONLY '<'
1143#define IoTYPE_WRONLY '>'
1144#define IoTYPE_RDWR '+'
1145#define IoTYPE_APPEND 'a'
1146#define IoTYPE_PIPE '|'
1147#define IoTYPE_STD '-' /* stdin or stdout */
1148#define IoTYPE_SOCKET 's'
1149#define IoTYPE_CLOSED ' '
1150#define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1151#define IoTYPE_NUMERIC '#' /* fdopen */
03fcf2fc
GS
1152
1153/*
954c1994
GS
1154=for apidoc Am|bool|SvTAINTED|SV* sv
1155Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1156not.
1157
1158=for apidoc Am|void|SvTAINTED_on|SV* sv
c55831ac 1159Marks an SV as tainted if tainting is enabled.
954c1994
GS
1160
1161=for apidoc Am|void|SvTAINTED_off|SV* sv
1162Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1163some of Perl's fundamental security features. XS module authors should not
1164use this function unless they fully understand all the implications of
1165unconditionally untainting the value. Untainting should be done in the
1166standard perl fashion, via a carefully crafted regexp, rather than directly
1167untainting variables.
1168
1169=for apidoc Am|void|SvTAINT|SV* sv
c55831ac 1170Taints an SV if tainting is enabled.
954c1994
GS
1171
1172=cut
1173*/
1174
a0714e2c 1175#define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
aae9cea0 1176
bbce6d69 1177#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22
NIS
1178#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1179#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 1180
c6ee37c5
MB
1181#define SvTAINT(sv) \
1182 STMT_START { \
3280af22 1183 if (PL_tainting) { \
3280af22 1184 if (PL_tainted) \
c6ee37c5
MB
1185 SvTAINTED_on(sv); \
1186 } \
1187 } STMT_END
79072805 1188
954c1994
GS
1189/*
1190=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
5f08bad4
ST
1191Like C<SvPV> but will force the SV into containing just a string
1192(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1193directly.
954c1994 1194
645c22ef 1195=for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
5f08bad4
ST
1196Like C<SvPV> but will force the SV into containing just a string
1197(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
1198directly. Doesn't process magic.
645c22ef 1199
954c1994 1200=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
5f08bad4
ST
1201Returns a pointer to the string in the SV, or a stringified form of
1202the SV if the SV does not contain a string. The SV may cache the
1203stringified version becoming C<SvPOK>. Handles 'get' magic. See also
645c22ef
DM
1204C<SvPVx> for a version which guarantees to evaluate sv only once.
1205
1206=for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1207A version of C<SvPV> which guarantees to evaluate sv only once.
954c1994 1208
891f9566
YST
1209=for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1210Like C<SvPV> but doesn't process magic.
1211
954c1994 1212=for apidoc Am|char*|SvPV_nolen|SV* sv
5f08bad4
ST
1213Returns a pointer to the string in the SV, or a stringified form of
1214the SV if the SV does not contain a string. The SV may cache the
1215stringified form becoming C<SvPOK>. Handles 'get' magic.
954c1994
GS
1216
1217=for apidoc Am|IV|SvIV|SV* sv
645c22ef
DM
1218Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1219version which guarantees to evaluate sv only once.
1220
891f9566
YST
1221=for apidoc Am|IV|SvIV_nomg|SV* sv
1222Like C<SvIV> but doesn't process magic.
1223
645c22ef
DM
1224=for apidoc Am|IV|SvIVx|SV* sv
1225Coerces the given SV to an integer and returns it. Guarantees to evaluate
d1be9408 1226sv only once. Use the more efficient C<SvIV> otherwise.
954c1994
GS
1227
1228=for apidoc Am|NV|SvNV|SV* sv
645c22ef
DM
1229Coerce the given SV to a double and return it. See C<SvNVx> for a version
1230which guarantees to evaluate sv only once.
1231
1232=for apidoc Am|NV|SvNVx|SV* sv
1233Coerces the given SV to a double and returns it. Guarantees to evaluate
d1be9408 1234sv only once. Use the more efficient C<SvNV> otherwise.
954c1994
GS
1235
1236=for apidoc Am|UV|SvUV|SV* sv
645c22ef
DM
1237Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1238for a version which guarantees to evaluate sv only once.
1239
891f9566
YST
1240=for apidoc Am|UV|SvUV_nomg|SV* sv
1241Like C<SvUV> but doesn't process magic.
1242
645c22ef
DM
1243=for apidoc Am|UV|SvUVx|SV* sv
1244Coerces the given SV to an unsigned integer and returns it. Guarantees to
d1be9408 1245evaluate sv only once. Use the more efficient C<SvUV> otherwise.
954c1994
GS
1246
1247=for apidoc Am|bool|SvTRUE|SV* sv
1248Returns a boolean indicating whether Perl would evaluate the SV as true or
1249false, defined or undefined. Does not handle 'get' magic.
1250
645c22ef 1251=for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
b70b15d2 1252Like C<SvPV_force>, but converts sv to utf8 first if necessary.
645c22ef
DM
1253
1254=for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
b70b15d2 1255Like C<SvPV>, but converts sv to utf8 first if necessary.
645c22ef 1256
b70b15d2
TJ
1257=for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1258Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
645c22ef
DM
1259
1260=for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1261Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1262
1263=for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1264Like C<SvPV>, but converts sv to byte representation first if necessary.
1265
b70b15d2 1266=for apidoc Am|char*|SvPVbyte_nolen|SV* sv
645c22ef
DM
1267Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1268
1269=for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
b70b15d2 1270Like C<SvPV_force>, but converts sv to utf8 first if necessary.
d1be9408 1271Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
645c22ef
DM
1272otherwise.
1273
1274=for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
b70b15d2 1275Like C<SvPV>, but converts sv to utf8 first if necessary.
d1be9408 1276Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
645c22ef
DM
1277otherwise.
1278
1279=for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1280Like C<SvPV_force>, but converts sv to byte representation first if necessary.
d1be9408 1281Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
645c22ef
DM
1282otherwise.
1283
1284=for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1285Like C<SvPV>, but converts sv to byte representation first if necessary.
d1be9408 1286Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
645c22ef
DM
1287otherwise.
1288
19dbb8f1
NC
1289=for apidoc Am|bool|SvIsCOW|SV* sv
1290Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1291hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1292COW)
1293
1294=for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1295Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1296scalar.
645c22ef 1297
0f76ff59
MHM
1298=for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1299Like C<sv_catpvn> but doesn't process magic.
1300
1301=for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1302Like C<sv_setsv> but doesn't process magic.
1303
1304=for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1305Like C<sv_catsv> but doesn't process magic.
1306
954c1994
GS
1307=cut
1308*/
1309
25da4f38 1310/* Let us hope that bitmaps for UV and IV are the same */
463ee0b2 1311#define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
ff68c719 1312#define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
463ee0b2 1313#define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 1314
891f9566
YST
1315#define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1316#define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1317
baca2b92 1318/* ----*/
8d6d96c1 1319
8d6d96c1 1320#define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
32a5c6ec 1321#define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
44d22300 1322#define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
8d6d96c1 1323
8d6d96c1
HS
1324#define SvPV_flags(sv, lp, flags) \
1325 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1326 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
32a5c6ec
NC
1327#define SvPV_flags_const(sv, lp, flags) \
1328 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1329 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1330 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
2596d9fe
NC
1331#define SvPV_flags_const_nolen(sv, flags) \
1332 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1333 ? SvPVX_const(sv) : \
1334 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
44d22300
NC
1335#define SvPV_flags_mutable(sv, lp, flags) \
1336 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1337 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1338 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
79072805 1339
8d6d96c1 1340#define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
13c5b33c 1341#define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
32a5c6ec 1342#define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
baca2b92 1343
8d6d96c1 1344#define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
2596d9fe 1345#define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
8d6d96c1 1346
8d6d96c1 1347#define SvPV_force_flags(sv, lp, flags) \
ff68c719 1348 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
8d6d96c1 1349 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
13c5b33c
NC
1350#define SvPV_force_flags_nolen(sv, flags) \
1351 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1352 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
32a5c6ec
NC
1353#define SvPV_force_flags_mutable(sv, lp, flags) \
1354 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1355 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1356 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
a0d0e21e 1357
1fa8b10d 1358#define SvPV_nolen(sv) \
5bc28da9 1359 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
dafda6d1 1360 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
70401c6b 1361
9ce348e8
NC
1362#define SvPV_nolen_const(sv) \
1363 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1364 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1365
baca2b92 1366#define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
9ce348e8 1367#define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
2596d9fe 1368#define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
5bc28da9 1369
baca2b92 1370/* ----*/
70401c6b 1371
5bc28da9
NIS
1372#define SvPVutf8(sv, lp) \
1373 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1374 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 1375
5bc28da9 1376#define SvPVutf8_force(sv, lp) \
70401c6b 1377 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
5bc28da9
NIS
1378 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1379
baca2b92 1380
5bc28da9
NIS
1381#define SvPVutf8_nolen(sv) \
1382 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
dafda6d1 1383 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
70401c6b 1384
baca2b92
DM
1385/* ----*/
1386
5bc28da9
NIS
1387#define SvPVbyte(sv, lp) \
1388 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1389 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
70401c6b 1390
5bc28da9
NIS
1391#define SvPVbyte_force(sv, lp) \
1392 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
a7ec4e2e 1393 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
5bc28da9 1394
5bc28da9
NIS
1395#define SvPVbyte_nolen(sv) \
1396 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
dafda6d1 1397 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
70401c6b 1398
1fa8b10d 1399
baca2b92
DM
1400
1401/* define FOOx(): idempotent versions of FOO(). If possible, use a local
1402 * var to evaluate the arg once; failing that, use a global if possible;
1403 * failing that, call a function to do the work
1404 */
1405
1406#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1407#define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1408#define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1409
5dc8bdac 1410#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
baca2b92 1411
3de3296f
AE
1412# define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1413# define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1414# define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1415# define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
32a5c6ec 1416# define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
002e4c74 1417# define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
9ce348e8 1418# define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
3de3296f
AE
1419# define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1420# define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
002e4c74 1421# define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
a80f87c4 1422# define SvTRUE(sv) ( \
8990e307
LW
1423 !sv \
1424 ? 0 \
1425 : SvPOK(sv) \
a80f87c4
GS
1426 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1427 nxpv && \
c2f1de04 1428 (nxpv->xpv_cur > 1 || \
339049b0 1429 (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
79072805
LW
1430 ? 1 \
1431 : 0) \
1432 : \
1433 SvIOK(sv) \
463ee0b2 1434 ? SvIVX(sv) != 0 \
79072805 1435 : SvNOK(sv) \
463ee0b2
LW
1436 ? SvNVX(sv) != 0.0 \
1437 : sv_2bool(sv) )
3de3296f 1438# define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
baca2b92 1439
a80f87c4 1440#else /* __GNUC__ */
baca2b92 1441
a80f87c4
GS
1442/* These inlined macros use globals, which will require a thread
1443 * declaration in user code, so we avoid them under threads */
1444
3db8f154
MB
1445# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1446# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1447# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1448# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
32a5c6ec 1449# define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
002e4c74 1450# define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
5f1478c3 1451# define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
3db8f154
MB
1452# define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1453# define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
002e4c74 1454# define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
3db8f154 1455# define SvTRUE(sv) ( \
a80f87c4
GS
1456 !sv \
1457 ? 0 \
1458 : SvPOK(sv) \
7b2c381c 1459 ? ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) && \
c2f1de04 1460 (PL_Xpv->xpv_cur > 1 || \
339049b0 1461 (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')) \
a80f87c4
GS
1462 ? 1 \
1463 : 0) \
1464 : \
1465 SvIOK(sv) \
1466 ? SvIVX(sv) != 0 \
1467 : SvNOK(sv) \
1468 ? SvNVX(sv) != 0.0 \
1469 : sv_2bool(sv) )
3db8f154 1470# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
baca2b92
DM
1471#endif /* __GNU__ */
1472
765f542d
NC
1473#define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1474 (SVf_FAKE | SVf_READONLY))
46187eeb 1475#define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
baca2b92 1476
bdd68bc3
NC
1477#define SvSHARED_HEK_FROM_PV(pvx) \
1478 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
0a356b31 1479#define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
c158a4fd 1480
baca2b92
DM
1481/* flag values for sv_*_flags functions */
1482#define SV_IMMEDIATE_UNREF 1
1483#define SV_GMAGIC 2
765f542d 1484#define SV_COW_DROP_PV 4
88632417 1485#define SV_UTF8_NO_ENCODING 8
5fcdf167 1486#define SV_NOSTEAL 16
32a5c6ec
NC
1487#define SV_CONST_RETURN 32
1488#define SV_MUTABLE_RETURN 64
bddd5118 1489#define SV_SMAGIC 128
765f542d 1490
5abc721d
NC
1491#define sv_unref(sv) sv_unref_flags(sv, 0)
1492#define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
174c73e3 1493
46187eeb
NC
1494/* We are about to replace the SV's current value. So if it's copy on write
1495 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1496 the value is about to get thrown away, so drop the PV rather than go to
1497 the effort of making a read-write copy only for it to get immediately
1498 discarded. */
765f542d
NC
1499
1500#define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1501 sv_force_normal_flags(sv, SV_COW_DROP_PV)
46187eeb 1502
f8c7b90f 1503#ifdef PERL_OLD_COPY_ON_WRITE
46187eeb 1504# define SvRELEASE_IVX(sv) ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
b885210e 1505 && Perl_sv_release_IVX(aTHX_ sv)))
46187eeb 1506# define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
b8f9541a
NC
1507#else
1508# define SvRELEASE_IVX(sv) SvOOK_off(sv)
f8c7b90f 1509#endif /* PERL_OLD_COPY_ON_WRITE */
ed252734
NC
1510
1511#define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1512 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1513 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1514#define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1515
765f542d
NC
1516#define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1517 sv_force_normal_flags(sv, 0)
1518
1519
baca2b92
DM
1520/* all these 'functions' are now just macros */
1521
1522#define sv_pv(sv) SvPV_nolen(sv)
1523#define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1524#define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1525
1526#define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1527#define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1528#define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1529#define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1530#define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1531#define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1532#define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
b347df82 1533#define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
baca2b92 1534#define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
b347df82
NC
1535#define sv_catpvn_mg(sv, sstr, slen) \
1536 sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
baca2b92 1537#define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
cb2f1b7b
NC
1538#define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1539#define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1540#define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
baca2b92
DM
1541#define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1542#define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1543#define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
891f9566
YST
1544#define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1545#define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
baca2b92 1546
db79b45b
JH
1547/* Should be named SvCatPVN_utf8_upgrade? */
1548#define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv) \
1549 STMT_START { \
1550 if (!(nsv)) \
1551 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1552 else \
1553 sv_setpvn(nsv, sstr, slen); \
1554 SvUTF8_off(nsv); \
1555 sv_utf8_upgrade(nsv); \
1556 sv_catsv(dsv, nsv); \
1557 } STMT_END
79072805 1558
954c1994
GS
1559/*
1560=for apidoc Am|SV*|newRV_inc|SV* sv
1561
1562Creates an RV wrapper for an SV. The reference count for the original SV is
1563incremented.
1564
1565=cut
1566*/
1567
5f05dabc 1568#define newRV_inc(sv) newRV(sv)
5f05dabc 1569
ef50df4b 1570/* the following macros update any magic values this sv is associated with */
79072805 1571
954c1994 1572/*
ccfc67b7
JH
1573=head1 Magical Functions
1574
954c1994
GS
1575=for apidoc Am|void|SvGETMAGIC|SV* sv
1576Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1577argument more than once.
1578
1579=for apidoc Am|void|SvSETMAGIC|SV* sv
1580Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1581argument more than once.
1582
1583=for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1584Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1585more than once.
1586
1587=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1588Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1589ssv. May evaluate arguments more than once.
1590
645c22ef
DM
1591=for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1592Like C<SvSetSV>, but does any set magic required afterwards.
1593
1594=for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
80663158 1595Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
645c22ef 1596
68795e93
NIS
1597=for apidoc Am|void|SvSHARE|SV* sv
1598Arranges for sv to be shared between threads if a suitable module
1599has been loaded.
1600
1601=for apidoc Am|void|SvLOCK|SV* sv
1602Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1603has been loaded.
1604
1605=for apidoc Am|void|SvUNLOCK|SV* sv
1606Releases a mutual exclusion lock on sv if a suitable module
1607has been loaded.
1608
ccfc67b7
JH
1609=head1 SV Manipulation Functions
1610
679ac26e 1611=for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
954c1994
GS
1612Expands the character buffer in the SV so that it has room for the
1613indicated number of bytes (remember to reserve space for an extra trailing
8cf8f3d1 1614NUL character). Calls C<sv_grow> to perform the expansion if necessary.
954c1994
GS
1615Returns a pointer to the character buffer.
1616
1617=cut
1618*/
1619
68795e93
NIS
1620#define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1621#define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1622#define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1623
189b2af5
GS
1624#define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1625#define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
79072805 1626
54310121 1627#define SvSetSV_and(dst,src,finally) \
189b2af5 1628 STMT_START { \
54310121 1629 if ((dst) != (src)) { \
1630 sv_setsv(dst, src); \
1631 finally; \
189b2af5
GS
1632 } \
1633 } STMT_END
54310121 1634#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 1635 STMT_START { \
8ebc5c01 1636 if ((dst) != (src)) { \
5fcdf167 1637 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL); \
54310121 1638 finally; \
189b2af5
GS
1639 } \
1640 } STMT_END
79072805 1641
54310121 1642#define SvSetSV(dst,src) \
c9d716f7 1643 SvSetSV_and(dst,src,/*nothing*/;)
54310121 1644#define SvSetSV_nosteal(dst,src) \
c9d716f7 1645 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121 1646
1647#define SvSetMagicSV(dst,src) \
1648 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1649#define SvSetMagicSV_nosteal(dst,src) \
1650 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1651
db79b45b 1652
1045810a 1653#if !defined(SKIP_DEBUGGING)
79072805 1654#define SvPEEK(sv) sv_peek(sv)
3967c732
JD
1655#else
1656#define SvPEEK(sv) ""
1657#endif
79072805 1658
5dc8bdac 1659#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
36477c24 1660
3280af22 1661#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 1662
79072805
LW
1663#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1664
933fea7f 1665#define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
5902b6a9
NC
1666#define SvGROW_mutable(sv,len) \
1667 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
933fea7f 1668#define Sv_Grow sv_grow
3d35f11b 1669
a0739874
DM
1670#define CLONEf_COPY_STACKS 1
1671#define CLONEf_KEEP_PTR_TABLE 2
c43294b8 1672#define CLONEf_CLONE_HOST 4
0405e91e 1673#define CLONEf_JOIN_IN 8
a0739874 1674
8cf8f3d1 1675struct clone_params {
d2d73c3e
AB
1676 AV* stashes;
1677 UV flags;
59b40662 1678 PerlInterpreter *proto_perl;
8cf8f3d1 1679};
102d3b8a
NC
1680
1681/*
1682 * Local variables:
1683 * c-indentation-style: bsd
1684 * c-basic-offset: 4
1685 * indent-tabs-mode: t
1686 * End:
1687 *
1688 * ex: set ts=8 sts=4 sw=4 noet:
1689 */