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