This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix format closure bug with redefined outer sub
[perl5.git] / sv.h
CommitLineData
a0d0e21e 1/* sv.h
79072805 2 *
1129b882 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
83706693 4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 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 47 SVt_NULL, /* 0 */
1cb9cd50
NC
48 SVt_BIND, /* 1 */
49 SVt_IV, /* 2 */
4df7f6af
NC
50 SVt_NV, /* 3 */
51 /* RV was here, before it was merged with IV. */
52 SVt_PV, /* 4 */
53 SVt_PVIV, /* 5 */
54 SVt_PVNV, /* 6 */
55 SVt_PVMG, /* 7 */
5c35adbb 56 SVt_REGEXP, /* 8 */
cecf5685 57 /* PVBM was here, before BIND replaced it. */
4ce457a6
TP
58 SVt_PVGV, /* 9 */
59 SVt_PVLV, /* 10 */
60 SVt_PVAV, /* 11 */
61 SVt_PVHV, /* 12 */
62 SVt_PVCV, /* 13 */
a0d0e21e 63 SVt_PVFM, /* 14 */
93e68bfb
JC
64 SVt_PVIO, /* 15 */
65 SVt_LAST /* keep last in enum. used to size arrays */
79072805
LW
66} svtype;
67
f1fb8741
DM
68/* *** any alterations to the SV types above need to be reflected in
69 * SVt_MASK and the various PL_valid_types_* tables */
70
71#define SVt_MASK 0xf /* smallest bitmask that covers all types */
72
cecf5685
NC
73#ifndef PERL_CORE
74/* Although Fast Boyer Moore tables are now being stored in PVGVs, for most
75 purposes eternal code wanting to consider PVBM probably needs to think of
76 PVMG instead. */
77# define SVt_PVBM SVt_PVMG
4df7f6af
NC
78/* Anything wanting to create a reference from clean should ensure that it has
79 a scalar of type SVt_IV now: */
80# define SVt_RV SVt_IV
cecf5685
NC
81#endif
82
d2a0f284 83/* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
db93c0c4
NC
84 so never reaches the clause at the end that uses sv_type_details->body_size
85 to determine whether to call safefree(). Hence body_size can be set
86 non-zero to record the size of HEs, without fear of bogus frees. */
6a93a7e5
NC
87#if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
88#define HE_SVSLOT SVt_NULL
89#endif
43e6e717 90
232d1c15
NC
91#define PERL_ARENA_ROOTS_SIZE (SVt_LAST)
92
43e6e717
NC
93/* typedefs to eliminate some typing */
94typedef struct he HE;
95typedef struct hek HEK;
96
79072805
LW
97/* Using C's structural equivalence to help emulate C++ inheritance here... */
98
30153bd2
JC
99/* start with 2 sv-head building blocks */
100#define _SV_HEAD(ptrtype) \
101 ptrtype sv_any; /* pointer to body */ \
102 U32 sv_refcnt; /* how many references to us */ \
103 U32 sv_flags /* what we are */
104
105#define _SV_HEAD_UNION \
106 union { \
2a12fdfc 107 char* svu_pv; /* pointer to malloced string */ \
30153bd2
JC
108 IV svu_iv; \
109 UV svu_uv; \
110 SV* svu_rv; /* pointer to another SV */ \
30153bd2
JC
111 SV** svu_array; \
112 HE** svu_hash; \
f7877b28 113 GP* svu_gp; \
6f7e8353 114 PerlIO *svu_fp; \
30153bd2
JC
115 } sv_u
116
117
5e045b90 118struct STRUCT_SV { /* struct sv { */
30153bd2
JC
119 _SV_HEAD(void*);
120 _SV_HEAD_UNION;
fd0854ff 121#ifdef DEBUG_LEAKING_SCALARS
654eccd5
JD
122 PERL_BITFIELD32 sv_debug_optype:9; /* the type of OP that allocated us */
123 PERL_BITFIELD32 sv_debug_inpad:1; /* was allocated in a pad for an OP */
654eccd5 124 PERL_BITFIELD32 sv_debug_line:16; /* the line where we were allocated */
c895a371 125 UV sv_debug_serial; /* serial number of sv allocation */
cd676548
DM
126 char * sv_debug_file; /* the file where we were allocated */
127 SV * sv_debug_parent; /* what we were cloned from (ithreads)*/
fd0854ff 128#endif
79072805
LW
129};
130
131struct gv {
30153bd2
JC
132 _SV_HEAD(XPVGV*); /* pointer to xpvgv body */
133 _SV_HEAD_UNION;
79072805
LW
134};
135
136struct cv {
30153bd2
JC
137 _SV_HEAD(XPVCV*); /* pointer to xpvcv body */
138 _SV_HEAD_UNION;
79072805
LW
139};
140
141struct av {
0f7b1ae0 142 _SV_HEAD(XPVAV*); /* pointer to xpvav body */
30153bd2 143 _SV_HEAD_UNION;
79072805
LW
144};
145
146struct hv {
30153bd2
JC
147 _SV_HEAD(XPVHV*); /* pointer to xpvhv body */
148 _SV_HEAD_UNION;
8990e307
LW
149};
150
151struct io {
30153bd2
JC
152 _SV_HEAD(XPVIO*); /* pointer to xpvio body */
153 _SV_HEAD_UNION;
79072805
LW
154};
155
d2f13c59
NC
156struct p5rx {
157 _SV_HEAD(struct regexp*); /* pointer to regexp body */
158 _SV_HEAD_UNION;
159};
160
30153bd2 161#undef _SV_HEAD
0f7b1ae0 162#undef _SV_HEAD_UNION /* ensure no pollution */
30153bd2 163
954c1994 164/*
ccfc67b7
JH
165=head1 SV Manipulation Functions
166
954c1994
GS
167=for apidoc Am|U32|SvREFCNT|SV* sv
168Returns the value of the object's reference count.
169
170=for apidoc Am|SV*|SvREFCNT_inc|SV* sv
171Increments the reference count of the given SV.
172
b37c2d43
AL
173All of the following SvREFCNT_inc* macros are optimized versions of
174SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
175
176=for apidoc Am|SV*|SvREFCNT_inc_NN|SV* sv
177Same as SvREFCNT_inc, but can only be used if you know I<sv>
178is not NULL. Since we don't have to check the NULLness, it's faster
179and smaller.
180
f2403e57 181=for apidoc Am|void|SvREFCNT_inc_void|SV* sv
b37c2d43
AL
182Same as SvREFCNT_inc, but can only be used if you don't need the
183return value. The macro doesn't need to return a meaningful value.
184
f2403e57 185=for apidoc Am|void|SvREFCNT_inc_void_NN|SV* sv
b37c2d43
AL
186Same as SvREFCNT_inc, but can only be used if you don't need the return
187value, and you know that I<sv> is not NULL. The macro doesn't need
188to return a meaningful value, or check for NULLness, so it's smaller
189and faster.
190
191=for apidoc Am|SV*|SvREFCNT_inc_simple|SV* sv
4ea561bc
NC
192Same as SvREFCNT_inc, but can only be used with expressions without side
193effects. Since we don't have to store a temporary value, it's faster.
b37c2d43
AL
194
195=for apidoc Am|SV*|SvREFCNT_inc_simple_NN|SV* sv
196Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
197is not NULL. Since we don't have to check the NULLness, it's faster
198and smaller.
199
f2403e57 200=for apidoc Am|void|SvREFCNT_inc_simple_void|SV* sv
b37c2d43
AL
201Same as SvREFCNT_inc_simple, but can only be used if you don't need the
202return value. The macro doesn't need to return a meaningful value.
203
f2403e57 204=for apidoc Am|void|SvREFCNT_inc_simple_void_NN|SV* sv
e638c624
MHM
205Same as SvREFCNT_inc, but can only be used if you don't need the return
206value, and you know that I<sv> is not NULL. The macro doesn't need
207to return a meaningful value, or check for NULLness, so it's smaller
208and faster.
b37c2d43 209
954c1994
GS
210=for apidoc Am|void|SvREFCNT_dec|SV* sv
211Decrements the reference count of the given SV.
212
213=for apidoc Am|svtype|SvTYPE|SV* sv
214Returns the type of the SV. See C<svtype>.
215
216=for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
217Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
218perform the upgrade if necessary. See C<svtype>.
219
220=cut
221*/
222
463ee0b2 223#define SvANY(sv) (sv)->sv_any
79072805 224#define SvFLAGS(sv) (sv)->sv_flags
aeea060c 225#define SvREFCNT(sv) (sv)->sv_refcnt
a863c7d1 226
27669aa4
FC
227#define SvREFCNT_inc(sv) S_SvREFCNT_inc(MUTABLE_SV(sv))
228#define SvREFCNT_inc_simple(sv) SvREFCNT_inc(sv)
229#define SvREFCNT_inc_NN(sv) S_SvREFCNT_inc_NN(MUTABLE_SV(sv))
230#define SvREFCNT_inc_void(sv) S_SvREFCNT_inc_void(MUTABLE_SV(sv))
8990e307 231
b37c2d43 232/* These guys don't need the curly blocks */
e638c624 233#define SvREFCNT_inc_simple_void(sv) STMT_START { if (sv) SvREFCNT(sv)++; } STMT_END
b1bc3f34
NC
234#define SvREFCNT_inc_simple_NN(sv) (++(SvREFCNT(sv)),MUTABLE_SV(sv))
235#define SvREFCNT_inc_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
236#define SvREFCNT_inc_simple_void_NN(sv) (void)(++SvREFCNT(MUTABLE_SV(sv)))
b37c2d43 237
75e16a44 238#define SvREFCNT_dec(sv) S_SvREFCNT_dec(aTHX_ MUTABLE_SV(sv))
a863c7d1 239
8990e307 240#define SVTYPEMASK 0xff
1fef4616 241#define SvTYPE(sv) ((svtype)((sv)->sv_flags & SVTYPEMASK))
79072805 242
0565a181
NC
243/* Sadly there are some parts of the core that have pointers to already-freed
244 SV heads, and rely on being able to tell that they are now free. So mark
245 them all by using a consistent macro. */
246#define SvIS_FREED(sv) ((sv)->sv_flags == SVTYPEMASK)
247
63f97190 248#define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
79072805 249
3f7ef1d4
NC
250#define SVf_IOK 0x00000100 /* has valid public integer value */
251#define SVf_NOK 0x00000200 /* has valid public numeric value */
252#define SVf_POK 0x00000400 /* has valid public pointer value */
253#define SVf_ROK 0x00000800 /* has a valid reference pointer */
254
255#define SVp_IOK 0x00001000 /* has valid non-public integer value */
256#define SVp_NOK 0x00002000 /* has valid non-public numeric value */
257#define SVp_POK 0x00004000 /* has valid non-public pointer value */
fbb778ec 258#define SVp_SCREAM 0x00008000 /* method name is DOES */
2e5b91de
NC
259#define SVphv_CLONEABLE SVp_SCREAM /* PVHV (stashes) clone its objects */
260#define SVpgv_GP SVp_SCREAM /* GV has a valid GP */
1ccdb730
NC
261#define SVprv_PCS_IMPORTED SVp_SCREAM /* RV is a proxy for a constant
262 subroutine in another package. Set the
7eeb6e4e 263 GvIMPORTED_CV_on() if it needs to be
1ccdb730 264 expanded to a real GV */
d3ce79bd 265/* 0x00010000 *** FREE SLOT */
9a214eec
DM
266#define SVs_PADTMP 0x00020000 /* in use as tmp; only if ! SVs_PADMY */
267#define SVs_PADSTALE 0x00020000 /* lexical has gone out of scope;
268 only valid for SVs_PADMY */
3f7ef1d4
NC
269#define SVpad_TYPED 0x00020000 /* pad name is a Typed Lexical */
270#define SVs_PADMY 0x00040000 /* in use a "my" variable */
271#define SVpad_OUR 0x00040000 /* pad name is "our" instead of "my" */
272#define SVs_TEMP 0x00080000 /* string is stealable? */
273#define SVs_OBJECT 0x00100000 /* is "blessed" */
274#define SVs_GMG 0x00200000 /* has magical get method */
275#define SVs_SMG 0x00400000 /* has magical set method */
276#define SVs_RMG 0x00800000 /* has random magical methods */
277
fea3622c 278#define SVf_FAKE 0x01000000 /* 0: glob is just a copy
3f7ef1d4
NC
279 1: SV head arena wasn't malloc()ed
280 2: in conjunction with SVf_READONLY
281 marks a shared hash key scalar
282 (SvLEN == 0) or a copy on write
283 string (SvLEN != 0) [SvIsCOW(sv)]
284 3: For PVCV, whether CvUNIQUE(cv)
285 refers to an eval or once only
286 [CvEVAL(cv), CvSPECIAL(cv)]
86d2c25d 287 4: On a pad name SV, that slot in the
3f7ef1d4
NC
288 frame AV is a REFCNT'ed reference
289 to a lexical from "outside". */
86d2c25d 290#define SVphv_REHASH SVf_FAKE /* 5: On a PVHV, hash values are being
3f7ef1d4
NC
291 recalculated */
292#define SVf_OOK 0x02000000 /* has valid offset value. For a PVHV this
293 means that a hv_aux struct is present
294 after the main array */
295#define SVf_BREAK 0x04000000 /* refcnt is artificially low - used by
36c662f4
NC
296 SVs in final arena cleanup.
297 Set in S_regtry on PL_reg_curpm, so that
298 perl_destruct will skip it. */
3f7ef1d4 299#define SVf_READONLY 0x08000000 /* may not be modified */
8990e307 300
a0d0e21e 301
8990e307 302
5bc28da9 303
4499db73 304#define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE|SVs_RMG)
5bc28da9 305
a0d0e21e 306#define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
2e5b91de 307 SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
a0d0e21e 308
7a77f1af 309#define PRIVSHIFT 4 /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
8990e307 310
cd028baa 311#define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
2e9f07a2
NC
312
313/* Ensure this value does not clash with the GV_ADD* flags in gv.h: */
cd028baa
NC
314#define SVf_UTF8 0x20000000 /* SvPV is UTF-8 encoded
315 This is also set on RVs whose overloaded
316 stringification is UTF-8. This might
317 only happen as a side effect of SvPV() */
318
26a32e18 319
8990e307
LW
320/* Some private flags. */
321
2e9f07a2
NC
322/* PVAV could probably use 0x2000000 without conflict. I assume that PVFM can
323 be UTF-8 encoded, and PVCVs could well have UTF-8 prototypes. PVIOs haven't
324 been restructured, so sometimes get used as string buffers. */
325
26a32e18 326/* PVHV */
3f7ef1d4 327#define SVphv_SHAREKEYS 0x20000000 /* PVHV keys live on shared string table */
e1dcbbca
NC
328
329/* PVNV, PVMG only, and only used in pads. Should be safe to test on any scalar
330 SV, as the core is careful to avoid setting both.
331
332 SVf_POK, SVp_POK also set:
333 0x00004400 Normal
fbb778ec 334 0x0000C400 method name for DOES (SvSCREAM)
e1dcbbca
NC
335 0x40004400 FBM compiled (SvVALID)
336 0x4000C400 pad name.
337
338 0x00008000 GV with GP
339 0x00008800 RV with PCS imported
340*/
341#define SVpad_NAME (SVp_SCREAM|SVpbm_VALID)
342 /* This SV is a name in the PAD, so
3f7ef1d4
NC
343 SVpad_TYPED, SVpad_OUR and SVpad_STATE
344 apply */
26a32e18 345/* PVAV */
3f7ef1d4 346#define SVpav_REAL 0x40000000 /* free old entries */
26a32e18 347/* PVHV */
3f7ef1d4 348#define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
69d97907
NC
349/* This is only set true on a PVGV when it's playing "PVBM", but is tested for
350 on any regular scalar (anything <= PVLV) */
5fe1b2e4 351#define SVpbm_VALID 0x40000000
7f83d853 352/* Only used in toke.c on an SV stored in PL_lex_repl */
3f7ef1d4 353#define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
25da4f38 354
26a32e18 355/* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV */
3f7ef1d4 356#define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
26a32e18 357/* PVAV */
3f7ef1d4 358#define SVpav_REIFY 0x80000000 /* can become real */
26a32e18 359/* PVHV */
3f7ef1d4 360#define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
cecf5685 361/* PVGV when SVpbm_VALID is true */
5fe1b2e4 362#define SVpbm_TAIL 0x80000000
26a32e18 363/* RV upwards. However, SVf_ROK and SVp_IOK are exclusive */
3f7ef1d4 364#define SVprv_WEAKREF 0x80000000 /* Weak reference */
d3ce79bd
DM
365/* pad name vars only */
366#define SVpad_STATE 0x80000000 /* pad name is a "state" var */
810b8aa5 367
f28d8eb1
SH
368/* MSVC6 generates "error C2099: initializer is not a constant" when
369 * initializing bodies_by_type in sv.c. Workaround the compiler bug by
370 * using an anonymous union, but only for MSVC6 since that isn't C89.
371 */
372#if defined(_MSC_VER) && _MSC_VER < 1300
501ba302
FC
373# define _XPV_CUR_U_NAME
374# define xpv_cur xpvcuru_cur
375# define xpv_fmdepth xpvcuru_fmdepth
f28d8eb1 376#else
501ba302
FC
377# define _XPV_CUR_U_NAME xpv_cur_u
378# define xpv_cur xpv_cur_u.xpvcuru_cur
379# define xpv_fmdepth xpv_cur_u.xpvcuru_fmdepth
380#endif
6e128786
NC
381#define _XPV_HEAD \
382 HV* xmg_stash; /* class package */ \
383 union _xmgu xmg_u; \
bb02a38f
FC
384 union { \
385 STRLEN xpvcuru_cur; /* length of svu_pv as a C string */ \
386 I32 xpvcuru_fmdepth; \
501ba302 387 } _XPV_CUR_U_NAME; \
c8e503bf 388 STRLEN xpv_len /* allocated size */
bb02a38f 389
20f4945e
MHM
390union _xnvu {
391 NV xnv_nv; /* numeric value, if any */
392 HV * xgv_stash;
393 struct {
394 U32 xlow;
395 U32 xhigh;
396 } xpad_cop_seq; /* used by pad.c for cop_sequence */
397 struct {
ced45495 398 I32 xbm_useful;
20f4945e
MHM
399 U8 xbm_rare; /* rarest character in string */
400 } xbm_s; /* fields from PVBM */
401};
402
403union _xivu {
404 IV xivu_iv; /* integer value */
20f4945e 405 UV xivu_uv;
20f4945e
MHM
406 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
407};
408
409union _xmgu {
410 MAGIC* xmg_magic; /* linked list of magicalness */
411 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
5bec93be 412 STRLEN xmg_hash_index; /* used while freeing hash entries */
20f4945e 413};
11ca45c0 414
79072805 415struct xpv {
20f4945e 416 _XPV_HEAD;
79072805
LW
417};
418
419struct xpviv {
20f4945e
MHM
420 _XPV_HEAD;
421 union _xivu xiv_u;
79072805
LW
422};
423
311a25d9
NC
424#define xiv_iv xiv_u.xivu_iv
425
ff68c719 426struct xpvuv {
20f4945e
MHM
427 _XPV_HEAD;
428 union _xivu xuv_u;
ff68c719
PP
429};
430
20f4945e 431#define xuv_uv xuv_u.xivu_uv
311a25d9 432
79072805 433struct xpvnv {
20f4945e
MHM
434 _XPV_HEAD;
435 union _xivu xiv_u;
6e128786 436 union _xnvu xnv_u;
79072805
LW
437};
438
3cd3be43 439/* This structure must match the beginning of struct xpvhv in hv.h. */
79072805 440struct xpvmg {
20f4945e 441 _XPV_HEAD;
6e128786
NC
442 union _xivu xiv_u;
443 union _xnvu xnv_u;
79072805
LW
444};
445
446struct xpvlv {
20f4945e 447 _XPV_HEAD;
6e128786
NC
448 union _xivu xiv_u;
449 union _xnvu xnv_u;
79072805
LW
450 STRLEN xlv_targoff;
451 STRLEN xlv_targlen;
452 SV* xlv_targ;
dd28f7bb
DM
453 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
454 * y=alem/helem/iter t=tie T=tied HE */
83f78d1a 455 char xlv_flags; /* 1 = negative offset 2 = negative len */
79072805
LW
456};
457
cecf5685
NC
458/* This structure works in 3 ways - regular scalar, GV with GP, or fast
459 Boyer-Moore. */
79072805 460struct xpvgv {
20f4945e 461 _XPV_HEAD;
6e128786
NC
462 union _xivu xiv_u;
463 union _xnvu xnv_u;
79072805
LW
464};
465
77a005ab
MB
466typedef U16 cv_flags_t;
467
20f4945e
MHM
468#define _XPVCV_COMMON \
469 HV * xcv_stash; \
470 union { \
471 OP * xcv_start; \
472 ANY xcv_xsubany; \
473 } xcv_start_u; \
474 union { \
475 OP * xcv_root; \
476 void (*xcv_xsub) (pTHX_ CV*); \
477 } xcv_root_u; \
478 GV * xcv_gv; \
479 char * xcv_file; \
b70d5558 480 PADLIST * xcv_padlist; \
20f4945e
MHM
481 CV * xcv_outside; \
482 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
483 * compilation) in the lexically enclosing \
484 * sub */ \
485 cv_flags_t xcv_flags
8990e307 486
0d856a3a
FC
487/* This structure must match XPVCV in cv.h */
488
20f4945e
MHM
489struct xpvfm {
490 _XPV_HEAD;
20f4945e 491 _XPVCV_COMMON;
79072805
LW
492};
493
167f2c4d 494
8990e307 495struct xpvio {
20f4945e 496 _XPV_HEAD;
6e128786 497 union _xivu xiv_u;
6f7e8353
NC
498 /* ifp and ofp are normally the same, but sockets need separate streams */
499 PerlIO * xio_ofp;
c951e2ad
NC
500 /* Cray addresses everything by word boundaries (64 bits) and
501 * code and data pointers cannot be mixed (which is exactly what
502 * Perl_filter_add() tries to do with the dirp), hence the
503 * following union trick (as suggested by Gurusamy Sarathy).
504 * For further information see Geir Johansen's problem report
505 * titled [ID 20000612.002] Perl problem on Cray system
506 * The any pointer (known as IoANY()) will also be a good place
507 * to hang any IO disciplines to.
508 */
509 union {
510 DIR * xiou_dirp; /* for opendir, readdir, etc */
511 void * xiou_any; /* for alignment */
512 } xio_dirpu;
513 /* IV xio_lines is now in IVX $. */
514 IV xio_page; /* $% */
515 IV xio_page_len; /* $= */
516 IV xio_lines_left; /* $- */
517 char * xio_top_name; /* $^ */
518 GV * xio_top_gv; /* $^ */
519 char * xio_fmt_name; /* $~ */
520 GV * xio_fmt_gv; /* $~ */
521 char * xio_bottom_name;/* $^B */
522 GV * xio_bottom_gv; /* $^B */
523 char xio_type;
524 U8 xio_flags;
8990e307 525};
167f2c4d 526
4755096e
GS
527#define xio_dirp xio_dirpu.xiou_dirp
528#define xio_any xio_dirpu.xiou_any
8990e307 529
e0c19803
GS
530#define IOf_ARGV 1 /* this fp iterates over ARGV */
531#define IOf_START 2 /* check for null ARGV and substitute '-' */
532#define IOf_FLUSH 4 /* this fp wants a flush after write op */
533#define IOf_DIDTOP 8 /* just did top of form */
534#define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
535#define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
5bb89d25
NC
536#define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
537 Also, when this is set, SvPVX() is valid */
8990e307 538
ed6116ce
LW
539/* The following macros define implementation-independent predicates on SVs. */
540
954c1994 541/*
fbf9f983
RGS
542=for apidoc Am|U32|SvNIOK|SV* sv
543Returns a U32 value indicating whether the SV contains a number, integer or
954c1994
GS
544double.
545
fbf9f983
RGS
546=for apidoc Am|U32|SvNIOKp|SV* sv
547Returns a U32 value indicating whether the SV contains a number, integer or
fe749c9a 548double. Checks the B<private> setting. Use C<SvNIOK> instead.
954c1994
GS
549
550=for apidoc Am|void|SvNIOK_off|SV* sv
551Unsets the NV/IV status of an SV.
552
fbf9f983 553=for apidoc Am|U32|SvOK|SV* sv
c0b6140e
SM
554Returns a U32 value indicating whether the value is defined. This is
555only meaningful for scalars.
954c1994 556
fbf9f983
RGS
557=for apidoc Am|U32|SvIOKp|SV* sv
558Returns a U32 value indicating whether the SV contains an integer. Checks
fe749c9a 559the B<private> setting. Use C<SvIOK> instead.
954c1994 560
fbf9f983
RGS
561=for apidoc Am|U32|SvNOKp|SV* sv
562Returns a U32 value indicating whether the SV contains a double. Checks the
fe749c9a 563B<private> setting. Use C<SvNOK> instead.
954c1994 564
fbf9f983
RGS
565=for apidoc Am|U32|SvPOKp|SV* sv
566Returns a U32 value indicating whether the SV contains a character string.
fe749c9a 567Checks the B<private> setting. Use C<SvPOK> instead.
954c1994 568
fbf9f983
RGS
569=for apidoc Am|U32|SvIOK|SV* sv
570Returns a U32 value indicating whether the SV contains an integer.
954c1994
GS
571
572=for apidoc Am|void|SvIOK_on|SV* sv
573Tells an SV that it is an integer.
574
575=for apidoc Am|void|SvIOK_off|SV* sv
576Unsets the IV status of an SV.
577
578=for apidoc Am|void|SvIOK_only|SV* sv
579Tells an SV that it is an integer and disables all other OK bits.
580
e331fc52
JH
581=for apidoc Am|void|SvIOK_only_UV|SV* sv
582Tells and SV that it is an unsigned integer and disables all other OK bits.
583
12fa07df 584=for apidoc Am|bool|SvIOK_UV|SV* sv
e331fc52
JH
585Returns a boolean indicating whether the SV contains an unsigned integer.
586
fbf9f983 587=for apidoc Am|bool|SvUOK|SV* sv
28e5dec8
JH
588Returns a boolean indicating whether the SV contains an unsigned integer.
589
12fa07df 590=for apidoc Am|bool|SvIOK_notUV|SV* sv
d1be9408 591Returns a boolean indicating whether the SV contains a signed integer.
e331fc52 592
fbf9f983
RGS
593=for apidoc Am|U32|SvNOK|SV* sv
594Returns a U32 value indicating whether the SV contains a double.
954c1994
GS
595
596=for apidoc Am|void|SvNOK_on|SV* sv
597Tells an SV that it is a double.
598
599=for apidoc Am|void|SvNOK_off|SV* sv
600Unsets the NV status of an SV.
601
602=for apidoc Am|void|SvNOK_only|SV* sv
603Tells an SV that it is a double and disables all other OK bits.
604
fbf9f983
RGS
605=for apidoc Am|U32|SvPOK|SV* sv
606Returns a U32 value indicating whether the SV contains a character
954c1994
GS
607string.
608
609=for apidoc Am|void|SvPOK_on|SV* sv
610Tells an SV that it is a string.
611
612=for apidoc Am|void|SvPOK_off|SV* sv
613Unsets the PV status of an SV.
614
615=for apidoc Am|void|SvPOK_only|SV* sv
616Tells an SV that it is a string and disables all other OK bits.
1e54db1a 617Will also turn off the UTF-8 status.
954c1994 618
b0f01acb
JP
619=for apidoc Am|bool|SvVOK|SV* sv
620Returns a boolean indicating whether the SV contains a v-string.
621
fbf9f983 622=for apidoc Am|U32|SvOOK|SV* sv
69240efd
NC
623Returns a U32 indicating whether the pointer to the string buffer is offset.
624This hack is used internally to speed up removal of characters from the
625beginning of a SvPV. When SvOOK is true, then the start of the
626allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
627This offset used to be stored in SvIVX, but is now stored within the spare
628part of the buffer.
954c1994 629
fbf9f983 630=for apidoc Am|U32|SvROK|SV* sv
954c1994
GS
631Tests if the SV is an RV.
632
633=for apidoc Am|void|SvROK_on|SV* sv
634Tells an SV that it is an RV.
635
636=for apidoc Am|void|SvROK_off|SV* sv
637Unsets the RV status of an SV.
638
639=for apidoc Am|SV*|SvRV|SV* sv
640Dereferences an RV to return the SV.
641
642=for apidoc Am|IV|SvIVX|SV* sv
645c22ef 643Returns the raw value in the SV's IV slot, without checks or conversions.
8554e7a0 644Only use when you are sure SvIOK is true. See also C<SvIV()>.
954c1994
GS
645
646=for apidoc Am|UV|SvUVX|SV* sv
645c22ef 647Returns the raw value in the SV's UV slot, without checks or conversions.
8554e7a0 648Only use when you are sure SvIOK is true. See also C<SvUV()>.
954c1994
GS
649
650=for apidoc Am|NV|SvNVX|SV* sv
645c22ef 651Returns the raw value in the SV's NV slot, without checks or conversions.
8554e7a0 652Only use when you are sure SvNOK is true. See also C<SvNV()>.
954c1994
GS
653
654=for apidoc Am|char*|SvPVX|SV* sv
645c22ef 655Returns a pointer to the physical string in the SV. The SV must contain a
954c1994
GS
656string.
657
5b36e945
FC
658This is also used to store the name of an autoloaded subroutine in an XS
659AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
89fc9e2a 660
954c1994
GS
661=for apidoc Am|STRLEN|SvCUR|SV* sv
662Returns the length of the string which is in the SV. See C<SvLEN>.
663
664=for apidoc Am|STRLEN|SvLEN|SV* sv
659239a4
MG
665Returns the size of the string buffer in the SV, not including any part
666attributable to C<SvOOK>. See C<SvCUR>.
954c1994
GS
667
668=for apidoc Am|char*|SvEND|SV* sv
f990ea3e
FC
669Returns a pointer to the spot just after the last character in
670the string which is in the SV, where there is usually a trailing
671null (even though Perl scalars do not strictly require it).
954c1994
GS
672See C<SvCUR>. Access the character as *(SvEND(sv)).
673
f990ea3e
FC
674Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
675unallocated memory.
676
954c1994
GS
677=for apidoc Am|HV*|SvSTASH|SV* sv
678Returns the stash of the SV.
679
672994ce 680=for apidoc Am|void|SvIV_set|SV* sv|IV val
20799e15
SP
681Set the value of the IV pointer in sv to val. It is possible to perform
682the same function of this macro with an lvalue assignment to C<SvIVX>.
683With future Perls, however, it will be more efficient to use
684C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
672994ce
SP
685
686=for apidoc Am|void|SvNV_set|SV* sv|NV val
20799e15 687Set the value of the NV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
688
689=for apidoc Am|void|SvPV_set|SV* sv|char* val
20799e15 690Set the value of the PV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
691
692=for apidoc Am|void|SvUV_set|SV* sv|UV val
20799e15 693Set the value of the UV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
694
695=for apidoc Am|void|SvRV_set|SV* sv|SV* val
20799e15 696Set the value of the RV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
697
698=for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
20799e15 699Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
672994ce 700
b6f4de24 701=for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
20799e15 702Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
672994ce 703
954c1994 704=for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
20799e15
SP
705Set the current length of the string which is in the SV. See C<SvCUR>
706and C<SvIV_set>.
672994ce
SP
707
708=for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
20799e15 709Set the actual length of the string which is in the SV. See C<SvIV_set>.
954c1994
GS
710
711=cut
712*/
713
79072805 714#define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
748a9306 715#define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
a0d0e21e 716#define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
25da4f38 717 SVp_IOK|SVp_NOK|SVf_IVisUV))
79072805 718
c7724415
FC
719#define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv))
720#define assert_not_glob(sv) assert_(!isGV_with_GP(sv))
906ed6d6 721
1cb9cd50
NC
722#define SvOK(sv) ((SvTYPE(sv) == SVt_BIND) \
723 ? (SvFLAGS(SvRV(sv)) & SVf_OK) \
724 : (SvFLAGS(sv) & SVf_OK))
f7877b28 725#define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
dd2eae66 726 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8 727 SVf_IVisUV|SVf_UTF8), \
25da4f38 728 SvOOK_off(sv))
54866b45 729#define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
dd2eae66 730 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8 731 SVf_UTF8), \
a0d0e21e 732 SvOOK_off(sv))
79072805 733
8990e307
LW
734#define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
735#define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
7a4bba22 736#define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
765f542d 737 SvFLAGS(sv) |= SVp_IOK)
8990e307 738#define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
f7877b28 739#define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
8990e307 740#define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
f7877b28 741#define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 742 SvFLAGS(sv) |= SVp_POK)
463ee0b2 743
79072805 744#define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
7a4bba22 745#define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
765f542d 746 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38 747#define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
0c34ef67 748#define SvIOK_only(sv) (SvOK_off(sv), \
a0d0e21e 749 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
f7877b28 750#define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
25da4f38 751 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
70401c6b 752
25da4f38
IZ
753#define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
754 == (SVf_IOK|SVf_IVisUV))
28e5dec8 755#define SvUOK(sv) SvIOK_UV(sv)
25da4f38
IZ
756#define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
757 == SVf_IOK)
758
759#define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
760#define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
761#define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
79072805
LW
762
763#define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
f7877b28
NC
764#define SvNOK_on(sv) (assert_not_glob(sv) \
765 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
8990e307 766#define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
0c34ef67 767#define SvNOK_only(sv) (SvOK_off(sv), \
a0d0e21e 768 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
79072805 769
914184e1 770/*
fbf9f983 771=for apidoc Am|U32|SvUTF8|SV* sv
3c813ed0
KW
772Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
773properly, this indicates whether or not the SV contains UTF-8 encoded data.
cd028baa
NC
774Call this after SvPV() in case any call to string overloading updates the
775internal flag.
914184e1
JH
776
777=for apidoc Am|void|SvUTF8_on|SV *sv
1e54db1a 778Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
d5ce4a7c 779Do not use frivolously.
914184e1
JH
780
781=for apidoc Am|void|SvUTF8_off|SV *sv
3c813ed0
KW
782Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
783Do not use frivolously.
914184e1
JH
784
785=for apidoc Am|void|SvPOK_only_UTF8|SV* sv
d5ce4a7c 786Tells an SV that it is a string and disables all other OK bits,
1e54db1a 787and leaves the UTF-8 status as it was.
f1a1024e 788
914184e1
JH
789=cut
790 */
791
7a5fd60d
NC
792/* Ensure the return value of this macro does not clash with the GV_ADD* flags
793in gv.h: */
a7cb1f99
GS
794#define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
795#define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
796#define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
5bc28da9 797
79072805 798#define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
f7877b28 799#define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 800 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
8990e307 801#define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
f7877b28 802#define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
dd2eae66 803 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8
GS
804 SVf_IVisUV|SVf_UTF8), \
805 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
f7877b28 806#define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
dd2eae66 807 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8 808 SVf_IVisUV), \
a0d0e21e 809 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
79072805 810
4f2da183 811#define SvVOK(sv) (SvMAGICAL(sv) \
b0a11fe1
RGS
812 && mg_find(sv,PERL_MAGIC_vstring))
813/* returns the vstring magic, if any */
814#define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
4f2da183 815 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
b0a11fe1 816
79072805 817#define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
a4f658f7 818#define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
0c34ef67 819#define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
79072805 820
a0d0e21e
LW
821#define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
822#define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
823#define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
824
ed6116ce 825#define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
a0d0e21e 826#define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
dd2eae66 827#define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
79072805 828
8990e307
LW
829#define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
830#define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
831#define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
79072805 832
8990e307
LW
833#define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
834#define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
835#define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
ed6116ce 836
8990e307
LW
837#define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
838#define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
839#define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
ed6116ce 840
8990e307
LW
841#define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
842#define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
843#define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
ed6116ce 844
a1cd65be 845#define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
54c554f3 846 HvAMAGIC(SvSTASH(SvRV(sv))))
a0d0e21e 847
0adc25b0
FC
848/* To be used on the stashes themselves: */
849#define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
850#define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
851#define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
852
4bac9ae4
CS
853
854#define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
855#define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
856#define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
857#define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
858#define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
859
860#define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
861#define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
862#define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
863#define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
864#define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
865
866#define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
867#define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
868
869#define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
870#define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
871
8bb025ae
CS
872#define SvPOK_pure_nogthink(sv) \
873 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
874#define SvPOK_utf8_pure_nogthink(sv) \
875 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
876#define SvPOK_byte_pure_nogthink(sv) \
877 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
878
d34786ba 879/*
458b44e7 880=for apidoc Am|U32|SvGAMAGIC|SV* sv
d34786ba 881
8554e7a0
FC
882Returns true if the SV has get magic or
883overloading. If either is true then
d34786ba 884the scalar is active data, and has the potential to return a new value every
8554e7a0
FC
885time it is accessed. Hence you must be careful to
886only read it once per user logical operation and work
887with that returned value. If neither is true then
d34786ba
NC
888the scalar's value cannot change unless written to.
889
890=cut
891*/
892
dd2eae66 893#define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1426bbf4 894
9299023c 895#define Gv_AMG(stash) \
d3c7a87b
FC
896 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
897 ? 1 \
898 : (HvAMAGIC_off(stash), 0))
a0d0e21e 899
810b8aa5
GS
900#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
901 == (SVf_ROK|SVprv_WEAKREF))
902#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
903#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
904
1ccdb730
NC
905#define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
906 == (SVf_ROK|SVprv_PCS_IMPORTED))
907#define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
908#define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
909
a11eaecb
FC
910/*
911=for apidoc m|U32|SvTHINKFIRST|SV *sv
912
913A quick flag check to see whether an sv should be passed to sv_force_normal
914to be "downgraded" before SvIVX or SvPVX can be modified directly.
915
916For example, if your scalar is a reference and you want to modify the SvIVX
917slot, you can't just do SvROK_off, as that will leak the referent.
918
919This is used internally by various sv-modifying functions, such as
920sv_setsv, sv_setiv and sv_pvn_force.
921
922One case that this does not handle is a gv without SvFAKE set. After
923
924 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
925
926it will still be a gv.
927
928SvTHINKFIRST sometimes produces false positives. In those cases
929sv_force_normal does nothing.
930
931=cut
932*/
933
a0d0e21e 934#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 935
9a214eec
DM
936#define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
937#define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
d9d18af6 938
9a214eec 939/* SVs_PADTMP and SVs_PADSTALE share the same bit, mediated by SVs_PADMY */
ed6116ce 940
9a214eec
DM
941#define SvPADTMP(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP)) == SVs_PADTMP)
942#define SvPADSTALE(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADSTALE)) \
943 == (SVs_PADMY|SVs_PADSTALE))
62bb6514 944
541377b1
FC
945#define SvPADTMP_on(sv) S_SvPADTMP_on(MUTABLE_SV(sv))
946#define SvPADTMP_off(sv) S_SvPADTMP_off(MUTABLE_SV(sv))
947#define SvPADSTALE_on(sv) S_SvPADSTALE_on(MUTABLE_SV(sv))
948#define SvPADSTALE_off(sv) S_SvPADSTALE_off(MUTABLE_SV(sv))
ed6116ce 949
8990e307
LW
950#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
951#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
952#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 953
8990e307
LW
954#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
955#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
956#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 957
8990e307
LW
958#define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
959#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
960#define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
79072805 961
180488f8 962#define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
8990e307
LW
963#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
964#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 965
74e0ddf7
NC
966#ifndef PERL_CORE
967# define SvCOMPILED(sv) 0
968# define SvCOMPILED_on(sv)
969# define SvCOMPILED_off(sv)
970#endif
79072805 971
25da4f38
IZ
972#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
973#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
974#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
975
85efc3a5 976#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
e9726144 977# define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
e5ae200f
RU
978 if (SvFLAGS(_svvalid) & SVpbm_VALID) \
979 assert(!isGV_with_GP(_svvalid)); \
980 (SvFLAGS(_svvalid) & SVpbm_VALID); \
85ffbbb0 981 })
b1bc3f34 982# define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
e5ae200f
RU
983 assert(!isGV_with_GP(_svvalid)); \
984 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
85ffbbb0 985 })
b1bc3f34 986# define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
e5ae200f
RU
987 assert(!isGV_with_GP(_svvalid)); \
988 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
85ffbbb0
NC
989 })
990
e9726144 991# define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
e5ae200f
RU
992 assert(SvTYPE(_svtail) != SVt_PVAV); \
993 assert(SvTYPE(_svtail) != SVt_PVHV); \
78d0cf80
NC
994 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
995 == (SVpbm_TAIL|SVpbm_VALID); \
85efc3a5
NC
996 })
997#else
85ffbbb0
NC
998# define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
999# define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
1000# define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
78d0cf80 1001# define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
fe901688 1002 == (SVpbm_TAIL|SVpbm_VALID))
78d0cf80 1003
85efc3a5 1004#endif
8990e307
LW
1005#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
1006#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
1007
8990e307 1008
075bae1e
NC
1009#define SvPAD_TYPED(sv) \
1010 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
00b1698f 1011
075bae1e
NC
1012#define SvPAD_OUR(sv) \
1013 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
00b1698f 1014
952306ac
RGS
1015#define SvPAD_STATE(sv) \
1016 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
a72e56b0
NC
1017
1018#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1019# define SvPAD_TYPED_on(sv) ({ \
b1bc3f34 1020 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
1021 assert(SvTYPE(_svpad) == SVt_PVMG); \
1022 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \
a72e56b0
NC
1023 })
1024#define SvPAD_OUR_on(sv) ({ \
b1bc3f34 1025 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
1026 assert(SvTYPE(_svpad) == SVt_PVMG); \
1027 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \
a72e56b0
NC
1028 })
1029#define SvPAD_STATE_on(sv) ({ \
b1bc3f34 1030 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
1031 assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
1032 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \
a72e56b0
NC
1033 })
1034#else
1035# define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1036# define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1037# define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1038#endif
952306ac 1039
73d95100 1040#define SvOURSTASH(sv) \
e736a858 1041 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
73d95100 1042#define SvOURSTASH_set(sv, st) \
e736a858 1043 STMT_START { \
2892acdb 1044 assert(SvTYPE(sv) == SVt_PVMG); \
e736a858 1045 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
035dab74
NC
1046 } STMT_END
1047
ed6116ce
LW
1048#define SvRVx(sv) SvRV(sv)
1049
f599b64b 1050#ifdef PERL_DEBUG_COW
8ed30cc1
DD
1051/* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1052 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
771ba71a
NC
1053# define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1054# define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
58430790 1055# define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
ac09da3b 1056# define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
f19a12a3 1057# define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
c0e1089a 1058/* Don't test the core XS code yet. */
771ba71a 1059# if defined (PERL_CORE) && PERL_DEBUG_COW > 1
c7724415 1060# define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
771ba71a
NC
1061# else
1062# define SvPVX(sv) SvPVX_mutable(sv)
1063# endif
771ba71a
NC
1064# define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1065# define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1066# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1067
c7724415
FC
1068# define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1069# define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
f599b64b 1070#else
771ba71a
NC
1071# define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1072# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1073
05ef5f8f
NC
1074# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1075/* These get expanded inside other macros that already use a variable _sv */
f7877b28 1076# define SvPVX(sv) \
d2c6dc5e 1077 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
f1fb8741 1078 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
e5ae200f 1079 assert(!isGV_with_GP(_svpvx)); \
5bb89d25
NC
1080 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1081 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
e5ae200f 1082 &((_svpvx)->sv_u.svu_pv); \
f7877b28 1083 }))
08002bbf 1084# define SvCUR(sv) \
b1bc3f34 1085 (*({ const SV *const _svcur = (const SV *)(sv); \
f1fb8741 1086 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK]); \
e5ae200f 1087 assert(!isGV_with_GP(_svcur)); \
6f7e8353
NC
1088 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1089 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
b1bc3f34 1090 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
08002bbf 1091 }))
05ef5f8f 1092# define SvIVX(sv) \
b1bc3f34 1093 (*({ const SV *const _svivx = (const SV *)(sv); \
f1fb8741 1094 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
e5ae200f 1095 assert(!isGV_with_GP(_svivx)); \
b1bc3f34 1096 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
05ef5f8f
NC
1097 }))
1098# define SvUVX(sv) \
b1bc3f34 1099 (*({ const SV *const _svuvx = (const SV *)(sv); \
f1fb8741 1100 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
e5ae200f 1101 assert(!isGV_with_GP(_svuvx)); \
b1bc3f34 1102 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
05ef5f8f
NC
1103 }))
1104# define SvNVX(sv) \
b1bc3f34 1105 (*({ const SV *const _svnvx = (const SV *)(sv); \
f1fb8741 1106 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
e5ae200f 1107 assert(!isGV_with_GP(_svnvx)); \
b1bc3f34 1108 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
05ef5f8f 1109 }))
ac09da3b 1110# define SvRV(sv) \
f19a12a3 1111 (*({ SV *const _svrv = MUTABLE_SV(sv); \
f1fb8741 1112 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
e5ae200f 1113 assert(!isGV_with_GP(_svrv)); \
6f7e8353
NC
1114 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1115 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
e5ae200f 1116 &((_svrv)->sv_u.svu_rv); \
ac09da3b 1117 }))
f19a12a3
MHM
1118# define SvRV_const(sv) \
1119 ({ const SV *const _svrv = (const SV *)(sv); \
f1fb8741 1120 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
f19a12a3 1121 assert(!isGV_with_GP(_svrv)); \
6f7e8353
NC
1122 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1123 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
f19a12a3
MHM
1124 (_svrv)->sv_u.svu_rv; \
1125 })
05ef5f8f 1126# define SvMAGIC(sv) \
b1bc3f34 1127 (*({ const SV *const _svmagic = (const SV *)(sv); \
e5ae200f
RU
1128 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1129 if(SvTYPE(_svmagic) == SVt_PVMG) \
1130 assert(!SvPAD_OUR(_svmagic)); \
b1bc3f34 1131 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
05ef5f8f
NC
1132 }))
1133# define SvSTASH(sv) \
b1bc3f34 1134 (*({ const SV *const _svstash = (const SV *)(sv); \
e5ae200f 1135 assert(SvTYPE(_svstash) >= SVt_PVMG); \
b1bc3f34 1136 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
05ef5f8f 1137 }))
03687789 1138# else
08002bbf
NC
1139# define SvPVX(sv) ((sv)->sv_u.svu_pv)
1140# define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
05ef5f8f
NC
1141# define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1142# define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
58430790 1143# define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
ac09da3b 1144# define SvRV(sv) ((sv)->sv_u.svu_rv)
f19a12a3 1145# define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
e736a858 1146# define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
771ba71a 1147# define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
03687789 1148# endif
62703e72
NC
1149#endif
1150
06c0cc96 1151#ifndef PERL_POISON
bb496845
SP
1152/* Given that these two are new, there can't be any existing code using them
1153 * as LVALUEs */
06c0cc96
NC
1154# define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1155# define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1156#else
1157/* Except for the poison code, which uses & to scribble over the pointer after
1158 free() is called. */
1159# define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1160# define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1161#endif
bb496845 1162
62703e72
NC
1163#define SvIVXx(sv) SvIVX(sv)
1164#define SvUVXx(sv) SvUVX(sv)
1165#define SvNVXx(sv) SvNVX(sv)
1166#define SvPVXx(sv) SvPVX(sv)
1167#define SvLENx(sv) SvLEN(sv)
1168#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1169
1170
28e5dec8
JH
1171/* Ask a scalar nicely to try to become an IV, if possible.
1172 Not guaranteed to stay returning void */
1173/* Macro won't actually call sv_2iv if already IOK */
1174#define SvIV_please(sv) \
1175 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1176 (void) SvIV(sv); } STMT_END
6f1401dc 1177#define SvIV_please_nomg(sv) \
01f91bf2
FC
1178 (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv)) \
1179 ? (SvIV_nomg(sv), SvIOK(sv)) \
8a68f328 1180 : SvIOK(sv))
79072805 1181#define SvIV_set(sv, val) \
f1fb8741
DM
1182 STMT_START { \
1183 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1184 assert(!isGV_with_GP(sv)); \
b19bbeda 1185 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
79072805 1186#define SvNV_set(sv, val) \
f1fb8741
DM
1187 STMT_START { \
1188 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1189 assert(!isGV_with_GP(sv)); \
58430790 1190 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
79072805 1191#define SvPV_set(sv, val) \
f1fb8741
DM
1192 STMT_START { \
1193 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1194 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1195 assert(!(SvTYPE(sv) == SVt_PVIO \
1196 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
339049b0 1197 ((sv)->sv_u.svu_pv = (val)); } STMT_END
607fa7f2 1198#define SvUV_set(sv, val) \
f1fb8741
DM
1199 STMT_START { \
1200 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1201 assert(!isGV_with_GP(sv)); \
607fa7f2 1202 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
b162af07 1203#define SvRV_set(sv, val) \
f1fb8741
DM
1204 STMT_START { \
1205 assert(PL_valid_types_RV[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1206 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1207 assert(!(SvTYPE(sv) == SVt_PVIO \
1208 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
339049b0 1209 ((sv)->sv_u.svu_rv = (val)); } STMT_END
b162af07
SP
1210#define SvMAGIC_set(sv, val) \
1211 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
e736a858 1212 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
b162af07
SP
1213#define SvSTASH_set(sv, val) \
1214 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1215 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
79072805 1216#define SvCUR_set(sv, val) \
f1fb8741
DM
1217 STMT_START { \
1218 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1219 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1220 assert(!(SvTYPE(sv) == SVt_PVIO \
1221 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
b162af07 1222 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
79072805 1223#define SvLEN_set(sv, val) \
f1fb8741
DM
1224 STMT_START { \
1225 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
f7877b28 1226 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1227 assert(!(SvTYPE(sv) == SVt_PVIO \
1228 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
b162af07 1229 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
7ae8ee9e
NC
1230#define SvEND_set(sv, val) \
1231 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
3ec35e0f 1232 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
79072805 1233
b7e9a5c2 1234#define SvPV_renew(sv,n) \
1da4ca5f
NC
1235 STMT_START { SvLEN_set(sv, n); \
1236 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1237 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1238 (MEM_SIZE)((n))))); \
1239 } STMT_END
1240
1241#define SvPV_shrink_to_cur(sv) STMT_START { \
1242 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1243 SvPV_renew(sv, _lEnGtH); \
1244 } STMT_END
b7e9a5c2 1245
771ba71a
NC
1246#define SvPV_free(sv) \
1247 STMT_START { \
1248 assert(SvTYPE(sv) >= SVt_PV); \
1249 if (SvLEN(sv)) { \
e537ac38 1250 assert(!SvROK(sv)); \
771ba71a 1251 if(SvOOK(sv)) { \
69240efd
NC
1252 STRLEN zok; \
1253 SvOOK_offset(sv, zok); \
1254 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
771ba71a
NC
1255 SvFLAGS(sv) &= ~SVf_OOK; \
1256 } \
1257 Safefree(SvPVX(sv)); \
1258 } \
1259 } STMT_END
8bd4d4c5 1260
43230e26
NC
1261#ifdef PERL_CORE
1262/* Code that crops up in three places to take a scalar and ready it to hold
1263 a reference */
1264# define prepare_SV_for_RV(sv) \
1265 STMT_START { \
1266 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1267 sv_upgrade(sv, SVt_IV); \
662f1f9e 1268 else if (SvTYPE(sv) >= SVt_PV) { \
43230e26
NC
1269 SvPV_free(sv); \
1270 SvLEN_set(sv, 0); \
1271 SvCUR_set(sv, 0); \
1272 } \
1273 } STMT_END
1274#endif
373b357f 1275
cffe132d
NC
1276#ifndef PERL_CORE
1277# define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1278#endif
6976cee3 1279
60c8298a
NC
1280#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1281# define BmRARE(sv) \
b1bc3f34 1282 (*({ SV *const _bmrare = MUTABLE_SV(sv); \
c13a5c80 1283 assert(SvTYPE(_bmrare) == SVt_PVMG); \
e5ae200f 1284 assert(SvVALID(_bmrare)); \
c13a5c80 1285 &(((XPVMG*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare); \
60c8298a
NC
1286 }))
1287# define BmUSEFUL(sv) \
b1bc3f34 1288 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
c13a5c80 1289 assert(SvTYPE(_bmuseful) == SVt_PVMG); \
e5ae200f
RU
1290 assert(SvVALID(_bmuseful)); \
1291 assert(!SvIOK(_bmuseful)); \
c13a5c80 1292 &(((XPVMG*) SvANY(_bmuseful))->xnv_u.xbm_s.xbm_useful); \
60c8298a
NC
1293 }))
1294# define BmPREVIOUS(sv) \
b1bc3f34 1295 (*({ SV *const _bmprevious = MUTABLE_SV(sv); \
c13a5c80 1296 assert(SvTYPE(_bmprevious) == SVt_PVMG); \
e5ae200f 1297 assert(SvVALID(_bmprevious)); \
c13a5c80 1298 &(((XPVMG*) SvANY(_bmprevious))->xiv_u.xivu_uv); \
8eeaf79a 1299 }))
60c8298a 1300#else
c13a5c80
NC
1301# define BmRARE(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1302# define BmUSEFUL(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_useful
1303# define BmPREVIOUS(sv) ((XPVMG*) SvANY(sv))->xiv_u.xivu_uv
b4f6c04b 1304
60c8298a 1305#endif
79072805 1306
f2da823f 1307#define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
79072805
LW
1308
1309#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1310#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1311#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1312#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
83f78d1a 1313#define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
79072805 1314
6f7e8353 1315#define IoIFP(sv) (sv)->sv_u.svu_fp
8990e307
LW
1316#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1317#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
4755096e 1318#define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
c490b21c 1319#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
8990e307
LW
1320#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1321#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1322#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1323#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1324#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1325#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1326#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1327#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1328#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
8990e307
LW
1329#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1330#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1331
50952442 1332/* IoTYPE(sv) is a single character telling the type of I/O connection. */
3b6c1aba
JH
1333#define IoTYPE_RDONLY '<'
1334#define IoTYPE_WRONLY '>'
1335#define IoTYPE_RDWR '+'
1336#define IoTYPE_APPEND 'a'
1337#define IoTYPE_PIPE '|'
1338#define IoTYPE_STD '-' /* stdin or stdout */
1339#define IoTYPE_SOCKET 's'
1340#define IoTYPE_CLOSED ' '
1341#define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1342#define IoTYPE_NUMERIC '#' /* fdopen */
03fcf2fc
GS
1343
1344/*
954c1994 1345=for apidoc Am|bool|SvTAINTED|SV* sv
8554e7a0 1346Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
954c1994
GS
1347not.
1348
1349=for apidoc Am|void|SvTAINTED_on|SV* sv
c55831ac 1350Marks an SV as tainted if tainting is enabled.
954c1994
GS
1351
1352=for apidoc Am|void|SvTAINTED_off|SV* sv
8554e7a0
FC
1353Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1354some of Perl's fundamental security features. XS module authors should not
954c1994
GS
1355use this function unless they fully understand all the implications of
1356unconditionally untainting the value. Untainting should be done in the
1357standard perl fashion, via a carefully crafted regexp, rather than directly
1358untainting variables.
1359
1360=for apidoc Am|void|SvTAINT|SV* sv
c98cdb04
FC
1361Taints an SV if tainting is enabled, and if some input to the current
1362expression is tainted--usually a variable, but possibly also implicit
1363inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1364the outputs of an expression in a pessimistic fashion; i.e., without paying
1365attention to precisely which outputs are influenced by which inputs.
954c1994
GS
1366
1367=cut
1368*/
1369
a0714e2c 1370#define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
aae9cea0 1371
bbce6d69 1372#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22
NIS
1373#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1374#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 1375
c6ee37c5
MB
1376#define SvTAINT(sv) \
1377 STMT_START { \
3280af22 1378 if (PL_tainting) { \
3280af22 1379 if (PL_tainted) \
c6ee37c5
MB
1380 SvTAINTED_on(sv); \
1381 } \
1382 } STMT_END
79072805 1383
954c1994
GS
1384/*
1385=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
8bb025ae 1386Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1473338e 1387only a string (C<SvPOK_only>), by hook or by crook. You want force if you are
8bb025ae 1388going to update the C<SvPVX> directly. Processes get magic.
954c1994 1389
645c22ef 1390=for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
8bb025ae 1391Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1473338e 1392only a string (C<SvPOK_only>), by hook or by crook. You want force if you are
8bb025ae 1393going to update the C<SvPVX> directly. Doesn't process get magic.
645c22ef 1394
954c1994 1395=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
5f08bad4
ST
1396Returns a pointer to the string in the SV, or a stringified form of
1397the SV if the SV does not contain a string. The SV may cache the
8554e7a0 1398stringified version becoming C<SvPOK>. Handles 'get' magic. See also
645c22ef
DM
1399C<SvPVx> for a version which guarantees to evaluate sv only once.
1400
1401=for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
4ea561bc
NC
1402A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1403Only use this if C<sv> is an expression with side effects, otherwise use the
b3adf4c0 1404more efficient C<SvPV>.
954c1994 1405
891f9566
YST
1406=for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1407Like C<SvPV> but doesn't process magic.
1408
954c1994 1409=for apidoc Am|char*|SvPV_nolen|SV* sv
5f08bad4
ST
1410Returns a pointer to the string in the SV, or a stringified form of
1411the SV if the SV does not contain a string. The SV may cache the
1412stringified form becoming C<SvPOK>. Handles 'get' magic.
954c1994 1413
71eb6d8c
TC
1414=for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1415Like C<SvPV_nolen> but doesn't process magic.
1416
954c1994 1417=for apidoc Am|IV|SvIV|SV* sv
8554e7a0 1418Coerces the given SV to an integer and returns it. See C<SvIVx> for a
645c22ef
DM
1419version which guarantees to evaluate sv only once.
1420
891f9566
YST
1421=for apidoc Am|IV|SvIV_nomg|SV* sv
1422Like C<SvIV> but doesn't process magic.
1423
645c22ef 1424=for apidoc Am|IV|SvIVx|SV* sv
8554e7a0
FC
1425Coerces the given SV to an integer and returns it.
1426Guarantees to evaluate C<sv> only once. Only use
1427this if C<sv> is an expression with side effects,
4ea561bc 1428otherwise use the more efficient C<SvIV>.
954c1994
GS
1429
1430=for apidoc Am|NV|SvNV|SV* sv
8554e7a0 1431Coerce the given SV to a double and return it. See C<SvNVx> for a version
645c22ef
DM
1432which guarantees to evaluate sv only once.
1433
6f1401dc
DM
1434=for apidoc Am|NV|SvNV_nomg|SV* sv
1435Like C<SvNV> but doesn't process magic.
1436
645c22ef 1437=for apidoc Am|NV|SvNVx|SV* sv
8554e7a0
FC
1438Coerces the given SV to a double and returns it.
1439Guarantees to evaluate C<sv> only once. Only use
1440this if C<sv> is an expression with side effects,
4ea561bc 1441otherwise use the more efficient C<SvNV>.
954c1994
GS
1442
1443=for apidoc Am|UV|SvUV|SV* sv
645c22ef
DM
1444Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1445for a version which guarantees to evaluate sv only once.
1446
891f9566
YST
1447=for apidoc Am|UV|SvUV_nomg|SV* sv
1448Like C<SvUV> but doesn't process magic.
1449
645c22ef 1450=for apidoc Am|UV|SvUVx|SV* sv
8554e7a0
FC
1451Coerces the given SV to an unsigned integer and
1452returns it. Guarantees to C<sv> only once. Only
1453use this if C<sv> is an expression with side effects,
4ea561bc 1454otherwise use the more efficient C<SvUV>.
954c1994
GS
1455
1456=for apidoc Am|bool|SvTRUE|SV* sv
1457Returns a boolean indicating whether Perl would evaluate the SV as true or
06c841cf
FC
1458false. See SvOK() for a defined/undefined test. Handles 'get' magic
1459unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
1460private flags).
1461
1462=for apidoc Am|bool|SvTRUE_nomg|SV* sv
1463Returns a boolean indicating whether Perl would evaluate the SV as true or
c0b6140e 1464false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
954c1994 1465
645c22ef 1466=for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
b70b15d2 1467Like C<SvPV_force>, but converts sv to utf8 first if necessary.
645c22ef
DM
1468
1469=for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
b70b15d2 1470Like C<SvPV>, but converts sv to utf8 first if necessary.
645c22ef 1471
b70b15d2
TJ
1472=for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1473Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
645c22ef
DM
1474
1475=for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1476Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1477
1478=for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1479Like C<SvPV>, but converts sv to byte representation first if necessary.
1480
b70b15d2 1481=for apidoc Am|char*|SvPVbyte_nolen|SV* sv
645c22ef
DM
1482Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1483
1484=for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
b70b15d2 1485Like C<SvPV_force>, but converts sv to utf8 first if necessary.
d1be9408 1486Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
645c22ef
DM
1487otherwise.
1488
1489=for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
b70b15d2 1490Like C<SvPV>, but converts sv to utf8 first if necessary.
d1be9408 1491Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
645c22ef
DM
1492otherwise.
1493
1494=for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1495Like C<SvPV_force>, but converts sv to byte representation first if necessary.
d1be9408 1496Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
645c22ef
DM
1497otherwise.
1498
1499=for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1500Like C<SvPV>, but converts sv to byte representation first if necessary.
d1be9408 1501Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
645c22ef
DM
1502otherwise.
1503
19dbb8f1 1504=for apidoc Am|bool|SvIsCOW|SV* sv
8554e7a0 1505Returns a boolean indicating whether the SV is Copy-On-Write (either shared
19dbb8f1 1506hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
8554e7a0 1507COW).
19dbb8f1
NC
1508
1509=for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1510Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1511scalar.
645c22ef 1512
0f76ff59
MHM
1513=for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1514Like C<sv_catpvn> but doesn't process magic.
1515
9dcc53ea
Z
1516=for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1517Like C<sv_catpv> but doesn't process magic.
1518
0f76ff59
MHM
1519=for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1520Like C<sv_setsv> but doesn't process magic.
1521
1522=for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1523Like C<sv_catsv> but doesn't process magic.
1524
dc960812
SP
1525=for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1526
8554e7a0 1527Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
dc960812 1528
954c1994
GS
1529=cut
1530*/
1531
25da4f38 1532/* Let us hope that bitmaps for UV and IV are the same */
4bac9ae4
CS
1533#define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1534#define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1535#define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 1536
891f9566
YST
1537#define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1538#define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
6f1401dc 1539#define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
891f9566 1540
baca2b92 1541/* ----*/
8d6d96c1 1542
4bac9ae4
CS
1543#define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1544#define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
44d22300 1545#define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
8d6d96c1 1546
8d6d96c1 1547#define SvPV_flags(sv, lp, flags) \
4bac9ae4 1548 (SvPOK_nog(sv) \
8d6d96c1 1549 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
32a5c6ec 1550#define SvPV_flags_const(sv, lp, flags) \
4bac9ae4 1551 (SvPOK_nog(sv) \
32a5c6ec
NC
1552 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1553 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
2596d9fe 1554#define SvPV_flags_const_nolen(sv, flags) \
4bac9ae4 1555 (SvPOK_nog(sv) \
2596d9fe
NC
1556 ? SvPVX_const(sv) : \
1557 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
44d22300 1558#define SvPV_flags_mutable(sv, lp, flags) \
4bac9ae4 1559 (SvPOK_nog(sv) \
44d22300
NC
1560 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1561 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
79072805 1562
8d6d96c1 1563#define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
13c5b33c 1564#define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
32a5c6ec 1565#define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
baca2b92 1566
8d6d96c1 1567#define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
2596d9fe 1568#define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
8d6d96c1 1569
8d6d96c1 1570#define SvPV_force_flags(sv, lp, flags) \
8bb025ae 1571 (SvPOK_pure_nogthink(sv) \
4bac9ae4
CS
1572 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1573
13c5b33c 1574#define SvPV_force_flags_nolen(sv, flags) \
8bb025ae 1575 (SvPOK_pure_nogthink(sv) \
4bac9ae4
CS
1576 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1577
32a5c6ec 1578#define SvPV_force_flags_mutable(sv, lp, flags) \
8bb025ae 1579 (SvPOK_pure_nogthink(sv) \
4bac9ae4 1580 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
32a5c6ec 1581 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
a0d0e21e 1582
1fa8b10d 1583#define SvPV_nolen(sv) \
4bac9ae4 1584 (SvPOK_nog(sv) \
dafda6d1 1585 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
70401c6b 1586
71eb6d8c 1587#define SvPV_nomg_nolen(sv) \
4bac9ae4 1588 (SvPOK_nog(sv) \
71eb6d8c
TC
1589 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1590
9ce348e8 1591#define SvPV_nolen_const(sv) \
4bac9ae4 1592 (SvPOK_nog(sv) \
9ce348e8
NC
1593 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1594
baca2b92 1595#define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
9ce348e8 1596#define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
2596d9fe 1597#define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
5bc28da9 1598
baca2b92 1599/* ----*/
70401c6b 1600
5bc28da9 1601#define SvPVutf8(sv, lp) \
4bac9ae4 1602 (SvPOK_utf8_nog(sv) \
5bc28da9 1603 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 1604
5bc28da9 1605#define SvPVutf8_force(sv, lp) \
8bb025ae 1606 (SvPOK_utf8_pure_nogthink(sv) \
5bc28da9
NIS
1607 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1608
5bc28da9 1609#define SvPVutf8_nolen(sv) \
4bac9ae4 1610 (SvPOK_utf8_nog(sv) \
dafda6d1 1611 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
70401c6b 1612
baca2b92
DM
1613/* ----*/
1614
5bc28da9 1615#define SvPVbyte(sv, lp) \
4bac9ae4 1616 (SvPOK_byte_nog(sv) \
5bc28da9 1617 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
70401c6b 1618
5bc28da9 1619#define SvPVbyte_force(sv, lp) \
8bb025ae 1620 (SvPOK_byte_pure_nogthink(sv) \
a7ec4e2e 1621 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
5bc28da9 1622
5bc28da9 1623#define SvPVbyte_nolen(sv) \
4bac9ae4 1624 (SvPOK_byte_nog(sv) \
dafda6d1 1625 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
70401c6b 1626
baca2b92
DM
1627
1628/* define FOOx(): idempotent versions of FOO(). If possible, use a local
1629 * var to evaluate the arg once; failing that, use a global if possible;
1630 * failing that, call a function to do the work
1631 */
1632
1633#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1634#define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1635#define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1636
4bac9ae4
CS
1637#define SvTRUE(sv) ((sv) && (SvGMAGICAL(sv) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))))
1638#define SvTRUE_nomg(sv) ((sv) && ( SvTRUE_common(sv, sv_2bool_nomg(sv))))
1639#define SvTRUE_common(sv,fallback) ( \
1640 !SvOK(sv) \
1641 ? 0 \
1642 : (SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK)) \
1643 ? ( (SvPOK(sv) && SvPVXtrue(sv)) \
1644 || (SvIOK(sv) && SvIVX(sv) != 0) \
1645 || (SvNOK(sv) && SvNVX(sv) != 0.0)) \
1646 : (fallback))
1647
5dc8bdac 1648#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
baca2b92 1649
b1bc3f34
NC
1650# define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1651# define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1652# define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
3de3296f 1653# define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
32a5c6ec 1654# define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
002e4c74 1655# define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
9ce348e8 1656# define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
3de3296f
AE
1657# define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1658# define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
002e4c74 1659# define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
4bac9ae4
CS
1660# define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1661# define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
1662# define SvPVXtrue(sv) \
1663 ({XPV *nxpv; \
1664 (nxpv = (XPV*)SvANY(sv)) \
1665 && (nxpv->xpv_cur > 1 \
1666 || (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0'));})
baca2b92 1667
a80f87c4 1668#else /* __GNUC__ */
baca2b92 1669
a80f87c4
GS
1670/* These inlined macros use globals, which will require a thread
1671 * declaration in user code, so we avoid them under threads */
1672
3db8f154
MB
1673# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1674# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1675# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1676# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
32a5c6ec 1677# define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
002e4c74 1678# define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
5f1478c3 1679# define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
3db8f154
MB
1680# define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1681# define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
002e4c74 1682# define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
4bac9ae4
CS
1683# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1684# define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
1685# define SvPVXtrue(sv) \
1686 ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) \
1687 && (PL_Xpv->xpv_cur > 1 \
1688 || (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')))
baca2b92
DM
1689#endif /* __GNU__ */
1690
fa819c1c 1691#define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
3a482d8d
FC
1692 (SVf_FAKE | SVf_READONLY) && !isGV_with_GP(sv) \
1693 && SvTYPE(sv) != SVt_REGEXP)
46187eeb 1694#define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
baca2b92 1695
bdd68bc3
NC
1696#define SvSHARED_HEK_FROM_PV(pvx) \
1697 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
0a356b31 1698#define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
c158a4fd 1699
baca2b92
DM
1700/* flag values for sv_*_flags functions */
1701#define SV_IMMEDIATE_UNREF 1
1702#define SV_GMAGIC 2
765f542d 1703#define SV_COW_DROP_PV 4
88632417 1704#define SV_UTF8_NO_ENCODING 8
5fcdf167 1705#define SV_NOSTEAL 16
32a5c6ec
NC
1706#define SV_CONST_RETURN 32
1707#define SV_MUTABLE_RETURN 64
bddd5118 1708#define SV_SMAGIC 128
c1c21316 1709#define SV_HAS_TRAILING_NUL 256
34482cd6 1710#define SV_COW_SHARED_HASH_KEYS 512
cb23d5b1
NC
1711/* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1712#define SV_COW_OTHER_PVS 1024
9f621bb0
NC
1713/* Make sv_2pv_flags return NULL if something is undefined. */
1714#define SV_UNDEF_RETURNS_NULL 2048
b3ab6785
KW
1715/* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1716 * This is used when the caller has already determined it is, and avoids
1717 * redundant work */
1718#define SV_FORCE_UTF8_UPGRADE 4096
aee036bb
DM
1719/* if (after resolving magic etc), the SV is found to be overloaded,
1720 * don't call the overload magic, just return as-is */
1721#define SV_SKIP_OVERLOAD 8192
c682ebef
FC
1722/* It is not yet clear whether we want this as an API, or what the
1723 * constants should be named. */
1724#ifdef PERL_CORE
1725# define SV_CATBYTES 16384
1726# define SV_CATUTF8 32768
1727#endif
34482cd6
NC
1728
1729/* The core is safe for this COW optimisation. XS code on CPAN may not be.
1730 So only default to doing the COW setup if we're in the core.
1731 */
1732#ifdef PERL_CORE
1733# ifndef SV_DO_COW_SVSETSV
cb23d5b1 1734# define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
34482cd6
NC
1735# endif
1736#endif
1737
1738#ifndef SV_DO_COW_SVSETSV
1739# define SV_DO_COW_SVSETSV 0
1740#endif
1741
765f542d 1742
5abc721d
NC
1743#define sv_unref(sv) sv_unref_flags(sv, 0)
1744#define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
47518d95
NC
1745#define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1746#define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
174c73e3 1747
46187eeb
NC
1748/* We are about to replace the SV's current value. So if it's copy on write
1749 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1750 the value is about to get thrown away, so drop the PV rather than go to
1751 the effort of making a read-write copy only for it to get immediately
1752 discarded. */
765f542d
NC
1753
1754#define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1755 sv_force_normal_flags(sv, SV_COW_DROP_PV)
46187eeb 1756
f8c7b90f 1757#ifdef PERL_OLD_COPY_ON_WRITE
5302ffd4 1758#define SvRELEASE_IVX(sv) \
7a4bba22 1759 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
46187eeb 1760# define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
7a4bba22 1761# define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
b8f9541a 1762#else
7a4bba22
NC
1763# define SvRELEASE_IVX(sv) 0
1764/* This little game brought to you by the need to shut this warning up:
1204f081 1765mg.c: In function 'Perl_magic_get':
7a4bba22
NC
1766mg.c:1024: warning: left-hand operand of comma expression has no effect
1767*/
1768# define SvRELEASE_IVX_(sv) /**/
f8c7b90f 1769#endif /* PERL_OLD_COPY_ON_WRITE */
ed252734
NC
1770
1771#define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1772 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
dd2eae66 1773 SVf_OOK|SVf_BREAK|SVf_READONLY)
ed252734
NC
1774#define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1775
765f542d
NC
1776#define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1777 sv_force_normal_flags(sv, 0)
1778
1779
baca2b92
DM
1780/* all these 'functions' are now just macros */
1781
1782#define sv_pv(sv) SvPV_nolen(sv)
1783#define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1784#define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1785
1786#define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
b3ab6785 1787#define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
baca2b92
DM
1788#define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1789#define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
9dcc53ea 1790#define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
34482cd6
NC
1791#define sv_setsv(dsv, ssv) \
1792 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1793#define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
baca2b92
DM
1794#define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1795#define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
b347df82 1796#define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
baca2b92 1797#define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
4bac9ae4
CS
1798#define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1799#define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
1800#define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
baca2b92 1801#define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
cb2f1b7b
NC
1802#define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1803#define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1804#define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
baca2b92
DM
1805#define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1806#define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1807#define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
891f9566
YST
1808#define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1809#define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
39d5de13 1810#define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
078504b2 1811#define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
e8c9c9d4
NC
1812#define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1813#define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
078504b2 1814#define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
06c841cf 1815#define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
4bac9ae4 1816#define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
84335ee9
NC
1817#define sv_insert(bigstr, offset, len, little, littlelen) \
1818 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1819 (littlelen), SV_GMAGIC)
baca2b92 1820
db79b45b 1821/* Should be named SvCatPVN_utf8_upgrade? */
4bac9ae4 1822#define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
db79b45b
JH
1823 STMT_START { \
1824 if (!(nsv)) \
ad25789c 1825 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
db79b45b
JH
1826 else \
1827 sv_setpvn(nsv, sstr, slen); \
1828 SvUTF8_off(nsv); \
1829 sv_utf8_upgrade(nsv); \
4bac9ae4 1830 sv_catsv_nomg(dsv, nsv); \
db79b45b 1831 } STMT_END
79072805 1832
954c1994
GS
1833/*
1834=for apidoc Am|SV*|newRV_inc|SV* sv
1835
1836Creates an RV wrapper for an SV. The reference count for the original SV is
1837incremented.
1838
1839=cut
1840*/
1841
5f05dabc 1842#define newRV_inc(sv) newRV(sv)
5f05dabc 1843
ef50df4b 1844/* the following macros update any magic values this sv is associated with */
79072805 1845
954c1994 1846/*
ccfc67b7
JH
1847=head1 Magical Functions
1848
954c1994 1849=for apidoc Am|void|SvGETMAGIC|SV* sv
f7e029ab
FC
1850Invokes C<mg_get> on an SV if it has 'get' magic. For example, this
1851will call C<FETCH> on a tied variable. This macro evaluates its
954c1994
GS
1852argument more than once.
1853
1854=for apidoc Am|void|SvSETMAGIC|SV* sv
f7e029ab
FC
1855Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary
1856after modifying a scalar, in case it is a magical variable like C<$|>
1857or a tied variable (it calls C<STORE>). This macro evaluates its
954c1994
GS
1858argument more than once.
1859
1860=for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1861Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1862more than once.
1863
1864=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1865Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
8554e7a0 1866ssv. May evaluate arguments more than once.
954c1994 1867
645c22ef
DM
1868=for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1869Like C<SvSetSV>, but does any set magic required afterwards.
1870
1871=for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
80663158 1872Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
645c22ef 1873
68795e93
NIS
1874=for apidoc Am|void|SvSHARE|SV* sv
1875Arranges for sv to be shared between threads if a suitable module
1876has been loaded.
1877
1878=for apidoc Am|void|SvLOCK|SV* sv
1879Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1880has been loaded.
1881
1882=for apidoc Am|void|SvUNLOCK|SV* sv
1883Releases a mutual exclusion lock on sv if a suitable module
1884has been loaded.
1885
ccfc67b7
JH
1886=head1 SV Manipulation Functions
1887
679ac26e 1888=for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
954c1994
GS
1889Expands the character buffer in the SV so that it has room for the
1890indicated number of bytes (remember to reserve space for an extra trailing
8cf8f3d1 1891NUL character). Calls C<sv_grow> to perform the expansion if necessary.
954c1994
GS
1892Returns a pointer to the character buffer.
1893
1894=cut
1895*/
1896
16c91539
BM
1897#define SvSHARE(sv) PL_sharehook(aTHX_ sv)
1898#define SvLOCK(sv) PL_lockhook(aTHX_ sv)
1899#define SvUNLOCK(sv) PL_unlockhook(aTHX_ sv)
1900#define SvDESTROYABLE(sv) PL_destroyhook(aTHX_ sv)
68795e93 1901
557fbd17 1902#define SvGETMAGIC(x) ((void)(SvGMAGICAL(x) && mg_get(x)))
189b2af5 1903#define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
79072805 1904
54310121 1905#define SvSetSV_and(dst,src,finally) \
189b2af5 1906 STMT_START { \
54310121
PP
1907 if ((dst) != (src)) { \
1908 sv_setsv(dst, src); \
1909 finally; \
189b2af5
GS
1910 } \
1911 } STMT_END
54310121 1912#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 1913 STMT_START { \
8ebc5c01 1914 if ((dst) != (src)) { \
34482cd6 1915 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV); \
54310121 1916 finally; \
189b2af5
GS
1917 } \
1918 } STMT_END
79072805 1919
54310121 1920#define SvSetSV(dst,src) \
c9d716f7 1921 SvSetSV_and(dst,src,/*nothing*/;)
54310121 1922#define SvSetSV_nosteal(dst,src) \
c9d716f7 1923 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121
PP
1924
1925#define SvSetMagicSV(dst,src) \
4e3a8365 1926 SvSetSV_and(dst,src,SvSETMAGIC(dst))
54310121 1927#define SvSetMagicSV_nosteal(dst,src) \
4e3a8365 1928 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
54310121 1929
db79b45b 1930
1045810a 1931#if !defined(SKIP_DEBUGGING)
79072805 1932#define SvPEEK(sv) sv_peek(sv)
3967c732
JD
1933#else
1934#define SvPEEK(sv) ""
1935#endif
79072805 1936
5dc8bdac 1937#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
36477c24 1938
567f3b56
TC
1939/*
1940=for apidoc Am|SV *|boolSV|bool b
1941
1942Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
1943
1944See also C<PL_sv_yes> and C<PL_sv_no>.
1945
1946=cut
1947*/
1948
3280af22 1949#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 1950
79072805 1951#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
f7877b28
NC
1952/* If I give every macro argument a different name, then there won't be bugs
1953 where nested macros get confused. Been there, done that. */
1954#define isGV_with_GP(pwadak) \
2e5b91de 1955 (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP) \
f7877b28 1956 && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
2e5b91de 1957#define isGV_with_GP_on(sv) STMT_START { \
70ad9799
SP
1958 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1959 assert (!SvPOKp(sv)); \
1960 assert (!SvIOKp(sv)); \
1961 (SvFLAGS(sv) |= SVpgv_GP); \
2e5b91de
NC
1962 } STMT_END
1963#define isGV_with_GP_off(sv) STMT_START { \
70ad9799
SP
1964 assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1965 assert (!SvPOKp(sv)); \
1966 assert (!SvIOKp(sv)); \
2e5b91de
NC
1967 (SvFLAGS(sv) &= ~SVpgv_GP); \
1968 } STMT_END
1969
79072805 1970
933fea7f 1971#define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
5902b6a9
NC
1972#define SvGROW_mutable(sv,len) \
1973 (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
933fea7f 1974#define Sv_Grow sv_grow
3d35f11b 1975
a0739874
DM
1976#define CLONEf_COPY_STACKS 1
1977#define CLONEf_KEEP_PTR_TABLE 2
c43294b8 1978#define CLONEf_CLONE_HOST 4
0405e91e 1979#define CLONEf_JOIN_IN 8
a0739874 1980
8cf8f3d1 1981struct clone_params {
d2d73c3e
AB
1982 AV* stashes;
1983 UV flags;
59b40662 1984 PerlInterpreter *proto_perl;
1db366cc 1985 PerlInterpreter *new_perl;
d08d57ef 1986 AV *unreferenced;
8cf8f3d1 1987};
102d3b8a
NC
1988
1989/*
740cce10
NC
1990=for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
1991
1992Creates a new SV and copies a string into it. If utf8 is true, calls
1993C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
1994
1995=cut
1996*/
1997
1998#define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
1999
2000/*
69240efd
NC
2001=for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2002
2003Reads into I<len> the offset from SvPVX back to the true start of the
2004allocated buffer, which will be non-zero if C<sv_chop> has been used to
8554e7a0 2005efficiently remove characters from start of the buffer. Implemented as a
69240efd 2006macro, which takes the address of I<len>, which must be of type C<STRLEN>.
8554e7a0 2007Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
69240efd
NC
2008
2009=cut
2010*/
2011
2012#ifdef DEBUGGING
2013/* Does the bot know something I don't?
201410:28 <@Nicholas> metabatman
201510:28 <+meta> Nicholas: crash
2016*/
2017# define SvOOK_offset(sv, offset) STMT_START { \
2018 assert(sizeof(offset) == sizeof(STRLEN)); \
2019 if (SvOOK(sv)) { \
d845901f
CS
2020 const U8 *_crash = (U8*)SvPVX_const(sv); \
2021 (offset) = *--_crash; \
2022 if (!(offset)) { \
2023 _crash -= sizeof(STRLEN); \
2024 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
69240efd
NC
2025 } \
2026 { \
2027 /* Validate the preceding buffer's sentinels to \
2028 verify that no-one is using it. */ \
d845901f
CS
2029 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2030 while (_crash > _bonk) { \
2031 --_crash; \
2032 assert (*_crash == (U8)PTR2UV(_crash)); \
69240efd
NC
2033 } \
2034 } \
2035 } else { \
d845901f 2036 (offset) = 0; \
69240efd
NC
2037 } \
2038 } STMT_END
2039#else
2040 /* This is the same code, but avoids using any temporary variables: */
2041# define SvOOK_offset(sv, offset) STMT_START { \
2042 assert(sizeof(offset) == sizeof(STRLEN)); \
2043 if (SvOOK(sv)) { \
d845901f
CS
2044 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2045 if (!(offset)) { \
69240efd 2046 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
d845901f 2047 (U8*)&(offset), sizeof(STRLEN), U8); \
69240efd
NC
2048 } \
2049 } else { \
d845901f 2050 (offset) = 0; \
69240efd
NC
2051 } \
2052 } STMT_END
2053#endif
85dca89a
NC
2054
2055#define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2056
69240efd 2057/*
102d3b8a
NC
2058 * Local variables:
2059 * c-indentation-style: bsd
2060 * c-basic-offset: 4
14d04a33 2061 * indent-tabs-mode: nil
102d3b8a
NC
2062 * End:
2063 *
14d04a33 2064 * ex: set ts=8 sts=4 sw=4 et:
102d3b8a 2065 */