This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Simplify the fix for bug #41530
[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
6e128786
NC
368#define _XPV_HEAD \
369 HV* xmg_stash; /* class package */ \
370 union _xmgu xmg_u; \
8de47657 371 STRLEN xpv_cur; /* length of svu_pv as a C string */ \
c8e503bf 372 STRLEN xpv_len /* allocated size */
bb02a38f 373
20f4945e
MHM
374union _xnvu {
375 NV xnv_nv; /* numeric value, if any */
376 HV * xgv_stash;
377 struct {
378 U32 xlow;
379 U32 xhigh;
380 } xpad_cop_seq; /* used by pad.c for cop_sequence */
381 struct {
ced45495 382 I32 xbm_useful;
20f4945e
MHM
383 U8 xbm_rare; /* rarest character in string */
384 } xbm_s; /* fields from PVBM */
385};
386
387union _xivu {
388 IV xivu_iv; /* integer value */
20f4945e 389 UV xivu_uv;
20f4945e
MHM
390 HEK * xivu_namehek; /* xpvlv, xpvgv: GvNAME */
391};
392
393union _xmgu {
394 MAGIC* xmg_magic; /* linked list of magicalness */
395 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
5bec93be 396 STRLEN xmg_hash_index; /* used while freeing hash entries */
20f4945e 397};
11ca45c0 398
79072805 399struct xpv {
20f4945e 400 _XPV_HEAD;
79072805
LW
401};
402
403struct xpviv {
20f4945e
MHM
404 _XPV_HEAD;
405 union _xivu xiv_u;
79072805
LW
406};
407
311a25d9
NC
408#define xiv_iv xiv_u.xivu_iv
409
ff68c719 410struct xpvuv {
20f4945e
MHM
411 _XPV_HEAD;
412 union _xivu xuv_u;
ff68c719
PP
413};
414
20f4945e 415#define xuv_uv xuv_u.xivu_uv
311a25d9 416
79072805 417struct xpvnv {
20f4945e
MHM
418 _XPV_HEAD;
419 union _xivu xiv_u;
6e128786 420 union _xnvu xnv_u;
79072805
LW
421};
422
3cd3be43 423/* This structure must match the beginning of struct xpvhv in hv.h. */
79072805 424struct xpvmg {
20f4945e 425 _XPV_HEAD;
6e128786
NC
426 union _xivu xiv_u;
427 union _xnvu xnv_u;
79072805
LW
428};
429
430struct xpvlv {
20f4945e 431 _XPV_HEAD;
6e128786
NC
432 union _xivu xiv_u;
433 union _xnvu xnv_u;
79072805
LW
434 STRLEN xlv_targoff;
435 STRLEN xlv_targlen;
436 SV* xlv_targ;
dd28f7bb
DM
437 char xlv_type; /* k=keys .=pos x=substr v=vec /=join/re
438 * y=alem/helem/iter t=tie T=tied HE */
83f78d1a 439 char xlv_flags; /* 1 = negative offset 2 = negative len */
79072805
LW
440};
441
cecf5685
NC
442/* This structure works in 3 ways - regular scalar, GV with GP, or fast
443 Boyer-Moore. */
79072805 444struct xpvgv {
20f4945e 445 _XPV_HEAD;
6e128786
NC
446 union _xivu xiv_u;
447 union _xnvu xnv_u;
79072805
LW
448};
449
77a005ab
MB
450typedef U16 cv_flags_t;
451
20f4945e
MHM
452#define _XPVCV_COMMON \
453 HV * xcv_stash; \
454 union { \
455 OP * xcv_start; \
456 ANY xcv_xsubany; \
457 } xcv_start_u; \
458 union { \
459 OP * xcv_root; \
460 void (*xcv_xsub) (pTHX_ CV*); \
461 } xcv_root_u; \
b290562e
FC
462 union { \
463 GV * xcv_gv; \
464 HEK * xcv_hek; \
465 } xcv_gv_u; \
20f4945e 466 char * xcv_file; \
b70d5558 467 PADLIST * xcv_padlist; \
20f4945e
MHM
468 CV * xcv_outside; \
469 U32 xcv_outside_seq; /* the COP sequence (at the point of our \
470 * compilation) in the lexically enclosing \
471 * sub */ \
8de47657
FC
472 cv_flags_t xcv_flags; \
473 I32 xcv_depth /* >= 2 indicates recursive call */
8990e307 474
0d856a3a
FC
475/* This structure must match XPVCV in cv.h */
476
20f4945e
MHM
477struct xpvfm {
478 _XPV_HEAD;
20f4945e 479 _XPVCV_COMMON;
79072805
LW
480};
481
167f2c4d 482
8990e307 483struct xpvio {
20f4945e 484 _XPV_HEAD;
6e128786 485 union _xivu xiv_u;
6f7e8353
NC
486 /* ifp and ofp are normally the same, but sockets need separate streams */
487 PerlIO * xio_ofp;
c951e2ad
NC
488 /* Cray addresses everything by word boundaries (64 bits) and
489 * code and data pointers cannot be mixed (which is exactly what
490 * Perl_filter_add() tries to do with the dirp), hence the
491 * following union trick (as suggested by Gurusamy Sarathy).
492 * For further information see Geir Johansen's problem report
493 * titled [ID 20000612.002] Perl problem on Cray system
494 * The any pointer (known as IoANY()) will also be a good place
495 * to hang any IO disciplines to.
496 */
497 union {
498 DIR * xiou_dirp; /* for opendir, readdir, etc */
499 void * xiou_any; /* for alignment */
500 } xio_dirpu;
501 /* IV xio_lines is now in IVX $. */
502 IV xio_page; /* $% */
503 IV xio_page_len; /* $= */
504 IV xio_lines_left; /* $- */
505 char * xio_top_name; /* $^ */
506 GV * xio_top_gv; /* $^ */
507 char * xio_fmt_name; /* $~ */
508 GV * xio_fmt_gv; /* $~ */
509 char * xio_bottom_name;/* $^B */
510 GV * xio_bottom_gv; /* $^B */
511 char xio_type;
512 U8 xio_flags;
8990e307 513};
167f2c4d 514
4755096e
GS
515#define xio_dirp xio_dirpu.xiou_dirp
516#define xio_any xio_dirpu.xiou_any
8990e307 517
e0c19803
GS
518#define IOf_ARGV 1 /* this fp iterates over ARGV */
519#define IOf_START 2 /* check for null ARGV and substitute '-' */
520#define IOf_FLUSH 4 /* this fp wants a flush after write op */
521#define IOf_DIDTOP 8 /* just did top of form */
522#define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
523#define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
5bb89d25
NC
524#define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge)
525 Also, when this is set, SvPVX() is valid */
8990e307 526
ed6116ce
LW
527/* The following macros define implementation-independent predicates on SVs. */
528
954c1994 529/*
fbf9f983
RGS
530=for apidoc Am|U32|SvNIOK|SV* sv
531Returns a U32 value indicating whether the SV contains a number, integer or
954c1994
GS
532double.
533
fbf9f983
RGS
534=for apidoc Am|U32|SvNIOKp|SV* sv
535Returns a U32 value indicating whether the SV contains a number, integer or
fe749c9a 536double. Checks the B<private> setting. Use C<SvNIOK> instead.
954c1994
GS
537
538=for apidoc Am|void|SvNIOK_off|SV* sv
539Unsets the NV/IV status of an SV.
540
fbf9f983 541=for apidoc Am|U32|SvOK|SV* sv
c0b6140e
SM
542Returns a U32 value indicating whether the value is defined. This is
543only meaningful for scalars.
954c1994 544
fbf9f983
RGS
545=for apidoc Am|U32|SvIOKp|SV* sv
546Returns a U32 value indicating whether the SV contains an integer. Checks
fe749c9a 547the B<private> setting. Use C<SvIOK> instead.
954c1994 548
fbf9f983
RGS
549=for apidoc Am|U32|SvNOKp|SV* sv
550Returns a U32 value indicating whether the SV contains a double. Checks the
fe749c9a 551B<private> setting. Use C<SvNOK> instead.
954c1994 552
fbf9f983
RGS
553=for apidoc Am|U32|SvPOKp|SV* sv
554Returns a U32 value indicating whether the SV contains a character string.
fe749c9a 555Checks the B<private> setting. Use C<SvPOK> instead.
954c1994 556
fbf9f983
RGS
557=for apidoc Am|U32|SvIOK|SV* sv
558Returns a U32 value indicating whether the SV contains an integer.
954c1994
GS
559
560=for apidoc Am|void|SvIOK_on|SV* sv
561Tells an SV that it is an integer.
562
563=for apidoc Am|void|SvIOK_off|SV* sv
564Unsets the IV status of an SV.
565
566=for apidoc Am|void|SvIOK_only|SV* sv
567Tells an SV that it is an integer and disables all other OK bits.
568
e331fc52
JH
569=for apidoc Am|void|SvIOK_only_UV|SV* sv
570Tells and SV that it is an unsigned integer and disables all other OK bits.
571
12fa07df 572=for apidoc Am|bool|SvIOK_UV|SV* sv
e331fc52
JH
573Returns a boolean indicating whether the SV contains an unsigned integer.
574
fbf9f983 575=for apidoc Am|bool|SvUOK|SV* sv
28e5dec8
JH
576Returns a boolean indicating whether the SV contains an unsigned integer.
577
12fa07df 578=for apidoc Am|bool|SvIOK_notUV|SV* sv
d1be9408 579Returns a boolean indicating whether the SV contains a signed integer.
e331fc52 580
fbf9f983
RGS
581=for apidoc Am|U32|SvNOK|SV* sv
582Returns a U32 value indicating whether the SV contains a double.
954c1994
GS
583
584=for apidoc Am|void|SvNOK_on|SV* sv
585Tells an SV that it is a double.
586
587=for apidoc Am|void|SvNOK_off|SV* sv
588Unsets the NV status of an SV.
589
590=for apidoc Am|void|SvNOK_only|SV* sv
591Tells an SV that it is a double and disables all other OK bits.
592
fbf9f983
RGS
593=for apidoc Am|U32|SvPOK|SV* sv
594Returns a U32 value indicating whether the SV contains a character
954c1994
GS
595string.
596
597=for apidoc Am|void|SvPOK_on|SV* sv
598Tells an SV that it is a string.
599
600=for apidoc Am|void|SvPOK_off|SV* sv
601Unsets the PV status of an SV.
602
603=for apidoc Am|void|SvPOK_only|SV* sv
604Tells an SV that it is a string and disables all other OK bits.
1e54db1a 605Will also turn off the UTF-8 status.
954c1994 606
b0f01acb
JP
607=for apidoc Am|bool|SvVOK|SV* sv
608Returns a boolean indicating whether the SV contains a v-string.
609
fbf9f983 610=for apidoc Am|U32|SvOOK|SV* sv
69240efd
NC
611Returns a U32 indicating whether the pointer to the string buffer is offset.
612This hack is used internally to speed up removal of characters from the
613beginning of a SvPV. When SvOOK is true, then the start of the
614allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
615This offset used to be stored in SvIVX, but is now stored within the spare
616part of the buffer.
954c1994 617
fbf9f983 618=for apidoc Am|U32|SvROK|SV* sv
954c1994
GS
619Tests if the SV is an RV.
620
621=for apidoc Am|void|SvROK_on|SV* sv
622Tells an SV that it is an RV.
623
624=for apidoc Am|void|SvROK_off|SV* sv
625Unsets the RV status of an SV.
626
627=for apidoc Am|SV*|SvRV|SV* sv
628Dereferences an RV to return the SV.
629
630=for apidoc Am|IV|SvIVX|SV* sv
645c22ef 631Returns the raw value in the SV's IV slot, without checks or conversions.
8554e7a0 632Only use when you are sure SvIOK is true. See also C<SvIV()>.
954c1994
GS
633
634=for apidoc Am|UV|SvUVX|SV* sv
645c22ef 635Returns the raw value in the SV's UV slot, without checks or conversions.
8554e7a0 636Only use when you are sure SvIOK is true. See also C<SvUV()>.
954c1994
GS
637
638=for apidoc Am|NV|SvNVX|SV* sv
645c22ef 639Returns the raw value in the SV's NV slot, without checks or conversions.
8554e7a0 640Only use when you are sure SvNOK is true. See also C<SvNV()>.
954c1994
GS
641
642=for apidoc Am|char*|SvPVX|SV* sv
645c22ef 643Returns a pointer to the physical string in the SV. The SV must contain a
954c1994
GS
644string.
645
5b36e945
FC
646This is also used to store the name of an autoloaded subroutine in an XS
647AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
89fc9e2a 648
954c1994
GS
649=for apidoc Am|STRLEN|SvCUR|SV* sv
650Returns the length of the string which is in the SV. See C<SvLEN>.
651
652=for apidoc Am|STRLEN|SvLEN|SV* sv
659239a4
MG
653Returns the size of the string buffer in the SV, not including any part
654attributable to C<SvOOK>. See C<SvCUR>.
954c1994
GS
655
656=for apidoc Am|char*|SvEND|SV* sv
f990ea3e
FC
657Returns a pointer to the spot just after the last character in
658the string which is in the SV, where there is usually a trailing
659null (even though Perl scalars do not strictly require it).
954c1994
GS
660See C<SvCUR>. Access the character as *(SvEND(sv)).
661
f990ea3e
FC
662Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
663unallocated memory.
664
954c1994
GS
665=for apidoc Am|HV*|SvSTASH|SV* sv
666Returns the stash of the SV.
667
672994ce 668=for apidoc Am|void|SvIV_set|SV* sv|IV val
20799e15
SP
669Set the value of the IV pointer in sv to val. It is possible to perform
670the same function of this macro with an lvalue assignment to C<SvIVX>.
671With future Perls, however, it will be more efficient to use
672C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
672994ce
SP
673
674=for apidoc Am|void|SvNV_set|SV* sv|NV val
20799e15 675Set the value of the NV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
676
677=for apidoc Am|void|SvPV_set|SV* sv|char* val
20799e15 678Set the value of the PV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
679
680=for apidoc Am|void|SvUV_set|SV* sv|UV val
20799e15 681Set the value of the UV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
682
683=for apidoc Am|void|SvRV_set|SV* sv|SV* val
20799e15 684Set the value of the RV pointer in sv to val. See C<SvIV_set>.
672994ce
SP
685
686=for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
20799e15 687Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
672994ce 688
b6f4de24 689=for apidoc Am|void|SvSTASH_set|SV* sv|HV* val
20799e15 690Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
672994ce 691
954c1994 692=for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
20799e15
SP
693Set the current length of the string which is in the SV. See C<SvCUR>
694and C<SvIV_set>.
672994ce
SP
695
696=for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
20799e15 697Set the actual length of the string which is in the SV. See C<SvIV_set>.
954c1994
GS
698
699=cut
700*/
701
79072805 702#define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
748a9306 703#define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
a0d0e21e 704#define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
25da4f38 705 SVp_IOK|SVp_NOK|SVf_IVisUV))
79072805 706
c7724415
FC
707#define assert_not_ROK(sv) assert_(!SvROK(sv) || !SvRV(sv))
708#define assert_not_glob(sv) assert_(!isGV_with_GP(sv))
906ed6d6 709
1cb9cd50
NC
710#define SvOK(sv) ((SvTYPE(sv) == SVt_BIND) \
711 ? (SvFLAGS(SvRV(sv)) & SVf_OK) \
712 : (SvFLAGS(sv) & SVf_OK))
f7877b28 713#define SvOK_off(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
dd2eae66 714 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8 715 SVf_IVisUV|SVf_UTF8), \
25da4f38 716 SvOOK_off(sv))
54866b45 717#define SvOK_off_exc_UV(sv) (assert_not_ROK(sv) \
dd2eae66 718 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8 719 SVf_UTF8), \
a0d0e21e 720 SvOOK_off(sv))
79072805 721
8990e307
LW
722#define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
723#define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
7a4bba22 724#define SvIOKp_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
765f542d 725 SvFLAGS(sv) |= SVp_IOK)
8990e307 726#define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
f7877b28 727#define SvNOKp_on(sv) (assert_not_glob(sv) SvFLAGS(sv) |= SVp_NOK)
8990e307 728#define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
f7877b28 729#define SvPOKp_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 730 SvFLAGS(sv) |= SVp_POK)
463ee0b2 731
79072805 732#define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
7a4bba22 733#define SvIOK_on(sv) (assert_not_glob(sv) SvRELEASE_IVX_(sv) \
765f542d 734 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38 735#define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
0c34ef67 736#define SvIOK_only(sv) (SvOK_off(sv), \
a0d0e21e 737 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
f7877b28 738#define SvIOK_only_UV(sv) (assert_not_glob(sv) SvOK_off_exc_UV(sv), \
25da4f38 739 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
70401c6b 740
25da4f38
IZ
741#define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
742 == (SVf_IOK|SVf_IVisUV))
28e5dec8 743#define SvUOK(sv) SvIOK_UV(sv)
25da4f38
IZ
744#define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
745 == SVf_IOK)
746
747#define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
748#define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
749#define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
79072805
LW
750
751#define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
f7877b28
NC
752#define SvNOK_on(sv) (assert_not_glob(sv) \
753 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
8990e307 754#define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
0c34ef67 755#define SvNOK_only(sv) (SvOK_off(sv), \
a0d0e21e 756 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
79072805 757
914184e1 758/*
fbf9f983 759=for apidoc Am|U32|SvUTF8|SV* sv
3c813ed0
KW
760Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
761properly, this indicates whether or not the SV contains UTF-8 encoded data.
cd028baa
NC
762Call this after SvPV() in case any call to string overloading updates the
763internal flag.
914184e1
JH
764
765=for apidoc Am|void|SvUTF8_on|SV *sv
1e54db1a 766Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
d5ce4a7c 767Do not use frivolously.
914184e1
JH
768
769=for apidoc Am|void|SvUTF8_off|SV *sv
3c813ed0
KW
770Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
771Do not use frivolously.
914184e1
JH
772
773=for apidoc Am|void|SvPOK_only_UTF8|SV* sv
d5ce4a7c 774Tells an SV that it is a string and disables all other OK bits,
1e54db1a 775and leaves the UTF-8 status as it was.
f1a1024e 776
914184e1
JH
777=cut
778 */
779
7a5fd60d
NC
780/* Ensure the return value of this macro does not clash with the GV_ADD* flags
781in gv.h: */
a7cb1f99
GS
782#define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
783#define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
784#define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
5bc28da9 785
79072805 786#define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
f7877b28 787#define SvPOK_on(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
906ed6d6 788 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
8990e307 789#define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
f7877b28 790#define SvPOK_only(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
dd2eae66 791 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8
GS
792 SVf_IVisUV|SVf_UTF8), \
793 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
f7877b28 794#define SvPOK_only_UTF8(sv) (assert_not_ROK(sv) assert_not_glob(sv) \
dd2eae66 795 SvFLAGS(sv) &= ~(SVf_OK| \
d41ff1b8 796 SVf_IVisUV), \
a0d0e21e 797 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
79072805 798
4f2da183 799#define SvVOK(sv) (SvMAGICAL(sv) \
b0a11fe1
RGS
800 && mg_find(sv,PERL_MAGIC_vstring))
801/* returns the vstring magic, if any */
802#define SvVSTRING_mg(sv) (SvMAGICAL(sv) \
4f2da183 803 ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
b0a11fe1 804
79072805 805#define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
a4f658f7 806#define SvOOK_on(sv) (SvFLAGS(sv) |= SVf_OOK)
0c34ef67 807#define SvOOK_off(sv) ((void)(SvOOK(sv) && sv_backoff(sv)))
79072805 808
a0d0e21e
LW
809#define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
810#define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
811#define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
812
ed6116ce 813#define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
a0d0e21e 814#define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
dd2eae66 815#define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK))
79072805 816
8990e307
LW
817#define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
818#define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
819#define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
79072805 820
8990e307
LW
821#define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
822#define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
823#define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
ed6116ce 824
8990e307
LW
825#define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
826#define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
827#define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
ed6116ce 828
8990e307
LW
829#define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
830#define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
831#define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
ed6116ce 832
a1cd65be 833#define SvAMAGIC(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)) && \
54c554f3 834 HvAMAGIC(SvSTASH(SvRV(sv))))
a0d0e21e 835
0adc25b0
FC
836/* To be used on the stashes themselves: */
837#define HvAMAGIC(hv) (SvFLAGS(hv) & SVf_AMAGIC)
838#define HvAMAGIC_on(hv) (SvFLAGS(hv) |= SVf_AMAGIC)
839#define HvAMAGIC_off(hv) (SvFLAGS(hv) &=~ SVf_AMAGIC)
840
4bac9ae4
CS
841
842#define SvPOK_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVs_GMG)) == SVf_POK)
843#define SvIOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVs_GMG)) == SVf_IOK)
844#define SvUOK_nog(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
845#define SvNOK_nog(sv) ((SvFLAGS(sv) & (SVf_NOK|SVs_GMG)) == SVf_NOK)
846#define SvNIOK_nog(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & SVs_GMG))
847
848#define SvPOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
849#define SvIOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_THINKFIRST|SVs_GMG)) == SVf_IOK)
850#define SvUOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV|SVf_THINKFIRST|SVs_GMG)) == (SVf_IOK|SVf_IVisUV))
851#define SvNOK_nogthink(sv) ((SvFLAGS(sv) & (SVf_NOK|SVf_THINKFIRST|SVs_GMG)) == SVf_NOK)
852#define SvNIOK_nogthink(sv) (SvNIOK(sv) && !(SvFLAGS(sv) & (SVf_THINKFIRST|SVs_GMG)))
853
854#define SvPOK_utf8_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == (SVf_POK|SVf_UTF8))
855#define SvPOK_utf8_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
856
857#define SvPOK_byte_nog(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVs_GMG)) == SVf_POK)
858#define SvPOK_byte_nogthink(sv) ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
859
8bb025ae
CS
860#define SvPOK_pure_nogthink(sv) \
861 ((SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
862#define SvPOK_utf8_pure_nogthink(sv) \
863 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == (SVf_POK|SVf_UTF8))
864#define SvPOK_byte_pure_nogthink(sv) \
865 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_IOK|SVf_NOK|SVf_ROK|SVpgv_GP|SVf_THINKFIRST|SVs_GMG)) == SVf_POK)
866
d34786ba 867/*
458b44e7 868=for apidoc Am|U32|SvGAMAGIC|SV* sv
d34786ba 869
8554e7a0
FC
870Returns true if the SV has get magic or
871overloading. If either is true then
d34786ba 872the scalar is active data, and has the potential to return a new value every
8554e7a0
FC
873time it is accessed. Hence you must be careful to
874only read it once per user logical operation and work
875with that returned value. If neither is true then
d34786ba
NC
876the scalar's value cannot change unless written to.
877
878=cut
879*/
880
dd2eae66 881#define SvGAMAGIC(sv) (SvGMAGICAL(sv) || SvAMAGIC(sv))
1426bbf4 882
9299023c 883#define Gv_AMG(stash) \
d3c7a87b
FC
884 (HvNAME(stash) && Gv_AMupdate(stash,FALSE) \
885 ? 1 \
886 : (HvAMAGIC_off(stash), 0))
a0d0e21e 887
810b8aa5
GS
888#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
889 == (SVf_ROK|SVprv_WEAKREF))
890#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
891#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
892
1ccdb730
NC
893#define SvPCS_IMPORTED(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
894 == (SVf_ROK|SVprv_PCS_IMPORTED))
895#define SvPCS_IMPORTED_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_PCS_IMPORTED))
896#define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
897
a11eaecb
FC
898/*
899=for apidoc m|U32|SvTHINKFIRST|SV *sv
900
901A quick flag check to see whether an sv should be passed to sv_force_normal
902to be "downgraded" before SvIVX or SvPVX can be modified directly.
903
904For example, if your scalar is a reference and you want to modify the SvIVX
905slot, you can't just do SvROK_off, as that will leak the referent.
906
907This is used internally by various sv-modifying functions, such as
908sv_setsv, sv_setiv and sv_pvn_force.
909
910One case that this does not handle is a gv without SvFAKE set. After
911
912 if (SvTHINKFIRST(gv)) sv_force_normal(gv);
913
914it will still be a gv.
915
916SvTHINKFIRST sometimes produces false positives. In those cases
917sv_force_normal does nothing.
918
919=cut
920*/
921
a0d0e21e 922#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 923
9a214eec
DM
924#define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
925#define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY)
d9d18af6 926
9a214eec 927/* SVs_PADTMP and SVs_PADSTALE share the same bit, mediated by SVs_PADMY */
ed6116ce 928
9a214eec
DM
929#define SvPADTMP(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP)) == SVs_PADTMP)
930#define SvPADSTALE(sv) ((SvFLAGS(sv) & (SVs_PADMY|SVs_PADSTALE)) \
931 == (SVs_PADMY|SVs_PADSTALE))
62bb6514 932
541377b1
FC
933#define SvPADTMP_on(sv) S_SvPADTMP_on(MUTABLE_SV(sv))
934#define SvPADTMP_off(sv) S_SvPADTMP_off(MUTABLE_SV(sv))
935#define SvPADSTALE_on(sv) S_SvPADSTALE_on(MUTABLE_SV(sv))
936#define SvPADSTALE_off(sv) S_SvPADSTALE_off(MUTABLE_SV(sv))
ed6116ce 937
8990e307
LW
938#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
939#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
940#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 941
8990e307
LW
942#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
943#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
944#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 945
8990e307
LW
946#define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
947#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
948#define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
79072805 949
180488f8 950#define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
8990e307
LW
951#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
952#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 953
74e0ddf7
NC
954#ifndef PERL_CORE
955# define SvCOMPILED(sv) 0
956# define SvCOMPILED_on(sv)
957# define SvCOMPILED_off(sv)
958#endif
79072805 959
25da4f38
IZ
960#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
961#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
962#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
963
85efc3a5 964#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
e9726144 965# define SvVALID(sv) ({ const SV *const _svvalid = (const SV*)(sv); \
e5ae200f
RU
966 if (SvFLAGS(_svvalid) & SVpbm_VALID) \
967 assert(!isGV_with_GP(_svvalid)); \
968 (SvFLAGS(_svvalid) & SVpbm_VALID); \
85ffbbb0 969 })
b1bc3f34 970# define SvVALID_on(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
e5ae200f
RU
971 assert(!isGV_with_GP(_svvalid)); \
972 (SvFLAGS(_svvalid) |= SVpbm_VALID); \
85ffbbb0 973 })
b1bc3f34 974# define SvVALID_off(sv) ({ SV *const _svvalid = MUTABLE_SV(sv); \
e5ae200f
RU
975 assert(!isGV_with_GP(_svvalid)); \
976 (SvFLAGS(_svvalid) &= ~SVpbm_VALID); \
85ffbbb0
NC
977 })
978
e9726144 979# define SvTAIL(sv) ({ const SV *const _svtail = (const SV *)(sv); \
e5ae200f
RU
980 assert(SvTYPE(_svtail) != SVt_PVAV); \
981 assert(SvTYPE(_svtail) != SVt_PVHV); \
78d0cf80
NC
982 (SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
983 == (SVpbm_TAIL|SVpbm_VALID); \
85efc3a5
NC
984 })
985#else
85ffbbb0
NC
986# define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
987# define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
988# define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
78d0cf80 989# define SvTAIL(sv) ((SvFLAGS(sv) & (SVpbm_TAIL|SVpbm_VALID)) \
fe901688 990 == (SVpbm_TAIL|SVpbm_VALID))
78d0cf80 991
85efc3a5 992#endif
8990e307
LW
993#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
994#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
995
8990e307 996
075bae1e
NC
997#define SvPAD_TYPED(sv) \
998 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
00b1698f 999
075bae1e
NC
1000#define SvPAD_OUR(sv) \
1001 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
00b1698f 1002
952306ac
RGS
1003#define SvPAD_STATE(sv) \
1004 ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
a72e56b0
NC
1005
1006#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1007# define SvPAD_TYPED_on(sv) ({ \
b1bc3f34 1008 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
1009 assert(SvTYPE(_svpad) == SVt_PVMG); \
1010 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_TYPED); \
a72e56b0
NC
1011 })
1012#define SvPAD_OUR_on(sv) ({ \
b1bc3f34 1013 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
1014 assert(SvTYPE(_svpad) == SVt_PVMG); \
1015 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_OUR); \
a72e56b0
NC
1016 })
1017#define SvPAD_STATE_on(sv) ({ \
b1bc3f34 1018 SV *const _svpad = MUTABLE_SV(sv); \
e5ae200f
RU
1019 assert(SvTYPE(_svpad) == SVt_PVNV || SvTYPE(_svpad) == SVt_PVMG); \
1020 (SvFLAGS(_svpad) |= SVpad_NAME|SVpad_STATE); \
a72e56b0
NC
1021 })
1022#else
1023# define SvPAD_TYPED_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1024# define SvPAD_OUR_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1025# define SvPAD_STATE_on(sv) (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1026#endif
952306ac 1027
73d95100 1028#define SvOURSTASH(sv) \
e736a858 1029 (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
73d95100 1030#define SvOURSTASH_set(sv, st) \
e736a858 1031 STMT_START { \
2892acdb 1032 assert(SvTYPE(sv) == SVt_PVMG); \
e736a858 1033 ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st; \
035dab74
NC
1034 } STMT_END
1035
ed6116ce
LW
1036#define SvRVx(sv) SvRV(sv)
1037
f599b64b 1038#ifdef PERL_DEBUG_COW
8ed30cc1
DD
1039/* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1040 +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
771ba71a
NC
1041# define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1042# define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
58430790 1043# define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
ac09da3b 1044# define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
f19a12a3 1045# define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
c0e1089a 1046/* Don't test the core XS code yet. */
771ba71a 1047# if defined (PERL_CORE) && PERL_DEBUG_COW > 1
c7724415 1048# define SvPVX(sv) (0 + (assert_(!SvREADONLY(sv)) (sv)->sv_u.svu_pv))
771ba71a
NC
1049# else
1050# define SvPVX(sv) SvPVX_mutable(sv)
1051# endif
771ba71a
NC
1052# define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1053# define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1054# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1055
c7724415
FC
1056# define SvMAGIC(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_u.xmg_magic))
1057# define SvSTASH(sv) (0 + *(assert_(SvTYPE(sv) >= SVt_PVMG) &((XPVMG*) SvANY(sv))->xmg_stash))
f599b64b 1058#else
771ba71a
NC
1059# define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1060# define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1061
05ef5f8f
NC
1062# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1063/* These get expanded inside other macros that already use a variable _sv */
f7877b28 1064# define SvPVX(sv) \
d2c6dc5e 1065 (*({ SV *const _svpvx = MUTABLE_SV(sv); \
f1fb8741 1066 assert(PL_valid_types_PVX[SvTYPE(_svpvx) & SVt_MASK]); \
e5ae200f 1067 assert(!isGV_with_GP(_svpvx)); \
5bb89d25
NC
1068 assert(!(SvTYPE(_svpvx) == SVt_PVIO \
1069 && !(IoFLAGS(_svpvx) & IOf_FAKE_DIRP))); \
e5ae200f 1070 &((_svpvx)->sv_u.svu_pv); \
f7877b28 1071 }))
08002bbf 1072# define SvCUR(sv) \
b1bc3f34 1073 (*({ const SV *const _svcur = (const SV *)(sv); \
f1fb8741 1074 assert(PL_valid_types_PVX[SvTYPE(_svcur) & SVt_MASK]); \
e5ae200f 1075 assert(!isGV_with_GP(_svcur)); \
6f7e8353
NC
1076 assert(!(SvTYPE(_svcur) == SVt_PVIO \
1077 && !(IoFLAGS(_svcur) & IOf_FAKE_DIRP))); \
b1bc3f34 1078 &(((XPV*) MUTABLE_PTR(SvANY(_svcur)))->xpv_cur); \
08002bbf 1079 }))
05ef5f8f 1080# define SvIVX(sv) \
b1bc3f34 1081 (*({ const SV *const _svivx = (const SV *)(sv); \
f1fb8741 1082 assert(PL_valid_types_IVX[SvTYPE(_svivx) & SVt_MASK]); \
e5ae200f 1083 assert(!isGV_with_GP(_svivx)); \
b1bc3f34 1084 &(((XPVIV*) MUTABLE_PTR(SvANY(_svivx)))->xiv_iv); \
05ef5f8f
NC
1085 }))
1086# define SvUVX(sv) \
b1bc3f34 1087 (*({ const SV *const _svuvx = (const SV *)(sv); \
f1fb8741 1088 assert(PL_valid_types_IVX[SvTYPE(_svuvx) & SVt_MASK]); \
e5ae200f 1089 assert(!isGV_with_GP(_svuvx)); \
b1bc3f34 1090 &(((XPVUV*) MUTABLE_PTR(SvANY(_svuvx)))->xuv_uv); \
05ef5f8f
NC
1091 }))
1092# define SvNVX(sv) \
b1bc3f34 1093 (*({ const SV *const _svnvx = (const SV *)(sv); \
f1fb8741 1094 assert(PL_valid_types_NVX[SvTYPE(_svnvx) & SVt_MASK]); \
e5ae200f 1095 assert(!isGV_with_GP(_svnvx)); \
b1bc3f34 1096 &(((XPVNV*) MUTABLE_PTR(SvANY(_svnvx)))->xnv_u.xnv_nv); \
05ef5f8f 1097 }))
ac09da3b 1098# define SvRV(sv) \
f19a12a3 1099 (*({ SV *const _svrv = MUTABLE_SV(sv); \
f1fb8741 1100 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
e5ae200f 1101 assert(!isGV_with_GP(_svrv)); \
6f7e8353
NC
1102 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1103 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
e5ae200f 1104 &((_svrv)->sv_u.svu_rv); \
ac09da3b 1105 }))
f19a12a3
MHM
1106# define SvRV_const(sv) \
1107 ({ const SV *const _svrv = (const SV *)(sv); \
f1fb8741 1108 assert(PL_valid_types_RV[SvTYPE(_svrv) & SVt_MASK]); \
f19a12a3 1109 assert(!isGV_with_GP(_svrv)); \
6f7e8353
NC
1110 assert(!(SvTYPE(_svrv) == SVt_PVIO \
1111 && !(IoFLAGS(_svrv) & IOf_FAKE_DIRP))); \
f19a12a3
MHM
1112 (_svrv)->sv_u.svu_rv; \
1113 })
05ef5f8f 1114# define SvMAGIC(sv) \
b1bc3f34 1115 (*({ const SV *const _svmagic = (const SV *)(sv); \
e5ae200f
RU
1116 assert(SvTYPE(_svmagic) >= SVt_PVMG); \
1117 if(SvTYPE(_svmagic) == SVt_PVMG) \
1118 assert(!SvPAD_OUR(_svmagic)); \
b1bc3f34 1119 &(((XPVMG*) MUTABLE_PTR(SvANY(_svmagic)))->xmg_u.xmg_magic); \
05ef5f8f
NC
1120 }))
1121# define SvSTASH(sv) \
b1bc3f34 1122 (*({ const SV *const _svstash = (const SV *)(sv); \
e5ae200f 1123 assert(SvTYPE(_svstash) >= SVt_PVMG); \
b1bc3f34 1124 &(((XPVMG*) MUTABLE_PTR(SvANY(_svstash)))->xmg_stash); \
05ef5f8f 1125 }))
03687789 1126# else
08002bbf
NC
1127# define SvPVX(sv) ((sv)->sv_u.svu_pv)
1128# define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
05ef5f8f
NC
1129# define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1130# define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
58430790 1131# define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
ac09da3b 1132# define SvRV(sv) ((sv)->sv_u.svu_rv)
f19a12a3 1133# define SvRV_const(sv) (0 + (sv)->sv_u.svu_rv)
e736a858 1134# define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_u.xmg_magic
771ba71a 1135# define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
03687789 1136# endif
62703e72
NC
1137#endif
1138
06c0cc96 1139#ifndef PERL_POISON
bb496845
SP
1140/* Given that these two are new, there can't be any existing code using them
1141 * as LVALUEs */
06c0cc96
NC
1142# define SvPVX_mutable(sv) (0 + (sv)->sv_u.svu_pv)
1143# define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
1144#else
1145/* Except for the poison code, which uses & to scribble over the pointer after
1146 free() is called. */
1147# define SvPVX_mutable(sv) ((sv)->sv_u.svu_pv)
1148# define SvPVX_const(sv) ((const char*)((sv)->sv_u.svu_pv))
1149#endif
bb496845 1150
62703e72
NC
1151#define SvIVXx(sv) SvIVX(sv)
1152#define SvUVXx(sv) SvUVX(sv)
1153#define SvNVXx(sv) SvNVX(sv)
1154#define SvPVXx(sv) SvPVX(sv)
1155#define SvLENx(sv) SvLEN(sv)
1156#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1157
1158
28e5dec8
JH
1159/* Ask a scalar nicely to try to become an IV, if possible.
1160 Not guaranteed to stay returning void */
1161/* Macro won't actually call sv_2iv if already IOK */
1162#define SvIV_please(sv) \
1163 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1164 (void) SvIV(sv); } STMT_END
6f1401dc 1165#define SvIV_please_nomg(sv) \
01f91bf2
FC
1166 (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv)) \
1167 ? (SvIV_nomg(sv), SvIOK(sv)) \
8a68f328 1168 : SvIOK(sv))
79072805 1169#define SvIV_set(sv, val) \
f1fb8741
DM
1170 STMT_START { \
1171 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1172 assert(!isGV_with_GP(sv)); \
b19bbeda 1173 (((XPVIV*) SvANY(sv))->xiv_iv = (val)); } STMT_END
79072805 1174#define SvNV_set(sv, val) \
f1fb8741
DM
1175 STMT_START { \
1176 assert(PL_valid_types_NV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1177 assert(!isGV_with_GP(sv)); \
58430790 1178 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
79072805 1179#define SvPV_set(sv, val) \
f1fb8741
DM
1180 STMT_START { \
1181 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1182 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1183 assert(!(SvTYPE(sv) == SVt_PVIO \
1184 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
339049b0 1185 ((sv)->sv_u.svu_pv = (val)); } STMT_END
607fa7f2 1186#define SvUV_set(sv, val) \
f1fb8741
DM
1187 STMT_START { \
1188 assert(PL_valid_types_IV_set[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1189 assert(!isGV_with_GP(sv)); \
607fa7f2 1190 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
b162af07 1191#define SvRV_set(sv, val) \
f1fb8741
DM
1192 STMT_START { \
1193 assert(PL_valid_types_RV[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_rv = (val)); } STMT_END
b162af07
SP
1198#define SvMAGIC_set(sv, val) \
1199 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
e736a858 1200 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
b162af07
SP
1201#define SvSTASH_set(sv, val) \
1202 STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1203 (((XPVMG*) SvANY(sv))->xmg_stash = (val)); } STMT_END
79072805 1204#define SvCUR_set(sv, val) \
f1fb8741
DM
1205 STMT_START { \
1206 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
08002bbf 1207 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1208 assert(!(SvTYPE(sv) == SVt_PVIO \
1209 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
b162af07 1210 (((XPV*) SvANY(sv))->xpv_cur = (val)); } STMT_END
79072805 1211#define SvLEN_set(sv, val) \
f1fb8741
DM
1212 STMT_START { \
1213 assert(PL_valid_types_PVX[SvTYPE(sv) & SVt_MASK]); \
f7877b28 1214 assert(!isGV_with_GP(sv)); \
6f7e8353
NC
1215 assert(!(SvTYPE(sv) == SVt_PVIO \
1216 && !(IoFLAGS(sv) & IOf_FAKE_DIRP))); \
b162af07 1217 (((XPV*) SvANY(sv))->xpv_len = (val)); } STMT_END
7ae8ee9e
NC
1218#define SvEND_set(sv, val) \
1219 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
3ec35e0f 1220 SvCUR_set(sv, (val) - SvPVX(sv)); } STMT_END
79072805 1221
b7e9a5c2 1222#define SvPV_renew(sv,n) \
1da4ca5f
NC
1223 STMT_START { SvLEN_set(sv, n); \
1224 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char) \
1225 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1226 (MEM_SIZE)((n))))); \
1227 } STMT_END
1228
1229#define SvPV_shrink_to_cur(sv) STMT_START { \
1230 const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1231 SvPV_renew(sv, _lEnGtH); \
1232 } STMT_END
b7e9a5c2 1233
771ba71a
NC
1234#define SvPV_free(sv) \
1235 STMT_START { \
1236 assert(SvTYPE(sv) >= SVt_PV); \
1237 if (SvLEN(sv)) { \
e537ac38 1238 assert(!SvROK(sv)); \
771ba71a 1239 if(SvOOK(sv)) { \
69240efd
NC
1240 STRLEN zok; \
1241 SvOOK_offset(sv, zok); \
1242 SvPV_set(sv, SvPVX_mutable(sv) - zok); \
771ba71a
NC
1243 SvFLAGS(sv) &= ~SVf_OOK; \
1244 } \
1245 Safefree(SvPVX(sv)); \
1246 } \
1247 } STMT_END
8bd4d4c5 1248
43230e26
NC
1249#ifdef PERL_CORE
1250/* Code that crops up in three places to take a scalar and ready it to hold
1251 a reference */
1252# define prepare_SV_for_RV(sv) \
1253 STMT_START { \
1254 if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV) \
1255 sv_upgrade(sv, SVt_IV); \
662f1f9e 1256 else if (SvTYPE(sv) >= SVt_PV) { \
43230e26
NC
1257 SvPV_free(sv); \
1258 SvLEN_set(sv, 0); \
1259 SvCUR_set(sv, 0); \
1260 } \
1261 } STMT_END
1262#endif
373b357f 1263
cffe132d
NC
1264#ifndef PERL_CORE
1265# define BmFLAGS(sv) (SvTAIL(sv) ? FBMcf_TAIL : 0)
1266#endif
6976cee3 1267
60c8298a
NC
1268#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1269# define BmRARE(sv) \
b1bc3f34 1270 (*({ SV *const _bmrare = MUTABLE_SV(sv); \
c13a5c80 1271 assert(SvTYPE(_bmrare) == SVt_PVMG); \
e5ae200f 1272 assert(SvVALID(_bmrare)); \
c13a5c80 1273 &(((XPVMG*) SvANY(_bmrare))->xnv_u.xbm_s.xbm_rare); \
60c8298a
NC
1274 }))
1275# define BmUSEFUL(sv) \
b1bc3f34 1276 (*({ SV *const _bmuseful = MUTABLE_SV(sv); \
c13a5c80 1277 assert(SvTYPE(_bmuseful) == SVt_PVMG); \
e5ae200f
RU
1278 assert(SvVALID(_bmuseful)); \
1279 assert(!SvIOK(_bmuseful)); \
c13a5c80 1280 &(((XPVMG*) SvANY(_bmuseful))->xnv_u.xbm_s.xbm_useful); \
60c8298a
NC
1281 }))
1282# define BmPREVIOUS(sv) \
b1bc3f34 1283 (*({ SV *const _bmprevious = MUTABLE_SV(sv); \
c13a5c80 1284 assert(SvTYPE(_bmprevious) == SVt_PVMG); \
e5ae200f 1285 assert(SvVALID(_bmprevious)); \
c13a5c80 1286 &(((XPVMG*) SvANY(_bmprevious))->xiv_u.xivu_uv); \
8eeaf79a 1287 }))
60c8298a 1288#else
c13a5c80
NC
1289# define BmRARE(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1290# define BmUSEFUL(sv) ((XPVMG*) SvANY(sv))->xnv_u.xbm_s.xbm_useful
1291# define BmPREVIOUS(sv) ((XPVMG*) SvANY(sv))->xiv_u.xivu_uv
b4f6c04b 1292
60c8298a 1293#endif
79072805 1294
f2da823f 1295#define FmLINES(sv) ((XPVIV*) SvANY(sv))->xiv_iv
79072805
LW
1296
1297#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
1298#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
1299#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
1300#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
83f78d1a 1301#define LvFLAGS(sv) ((XPVLV*) SvANY(sv))->xlv_flags
79072805 1302
6f7e8353 1303#define IoIFP(sv) (sv)->sv_u.svu_fp
8990e307
LW
1304#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
1305#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
4755096e 1306#define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
c490b21c 1307#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xiv_u.xivu_iv
8990e307
LW
1308#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
1309#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
1310#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
1311#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
1312#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
1313#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
1314#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
1315#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1316#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
8990e307
LW
1317#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
1318#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
1319
50952442 1320/* IoTYPE(sv) is a single character telling the type of I/O connection. */
3b6c1aba
JH
1321#define IoTYPE_RDONLY '<'
1322#define IoTYPE_WRONLY '>'
1323#define IoTYPE_RDWR '+'
1324#define IoTYPE_APPEND 'a'
1325#define IoTYPE_PIPE '|'
1326#define IoTYPE_STD '-' /* stdin or stdout */
1327#define IoTYPE_SOCKET 's'
1328#define IoTYPE_CLOSED ' '
1329#define IoTYPE_IMPLICIT 'I' /* stdin or stdout or stderr */
1330#define IoTYPE_NUMERIC '#' /* fdopen */
03fcf2fc
GS
1331
1332/*
954c1994 1333=for apidoc Am|bool|SvTAINTED|SV* sv
8554e7a0 1334Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
954c1994
GS
1335not.
1336
1337=for apidoc Am|void|SvTAINTED_on|SV* sv
c55831ac 1338Marks an SV as tainted if tainting is enabled.
954c1994
GS
1339
1340=for apidoc Am|void|SvTAINTED_off|SV* sv
8554e7a0
FC
1341Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1342some of Perl's fundamental security features. XS module authors should not
954c1994
GS
1343use this function unless they fully understand all the implications of
1344unconditionally untainting the value. Untainting should be done in the
1345standard perl fashion, via a carefully crafted regexp, rather than directly
1346untainting variables.
1347
1348=for apidoc Am|void|SvTAINT|SV* sv
c98cdb04
FC
1349Taints an SV if tainting is enabled, and if some input to the current
1350expression is tainted--usually a variable, but possibly also implicit
1351inputs such as locale settings. C<SvTAINT> propagates that taintedness to
1352the outputs of an expression in a pessimistic fashion; i.e., without paying
1353attention to precisely which outputs are influenced by which inputs.
954c1994
GS
1354
1355=cut
1356*/
1357
a0714e2c 1358#define sv_taint(sv) sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
aae9cea0 1359
bbce6d69 1360#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22
NIS
1361#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
1362#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 1363
c6ee37c5
MB
1364#define SvTAINT(sv) \
1365 STMT_START { \
3280af22 1366 if (PL_tainting) { \
3280af22 1367 if (PL_tainted) \
c6ee37c5
MB
1368 SvTAINTED_on(sv); \
1369 } \
1370 } STMT_END
79072805 1371
954c1994
GS
1372/*
1373=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
8bb025ae 1374Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1473338e 1375only a string (C<SvPOK_only>), by hook or by crook. You want force if you are
8bb025ae 1376going to update the C<SvPVX> directly. Processes get magic.
954c1994 1377
645c22ef 1378=for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
8bb025ae 1379Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
1473338e 1380only a string (C<SvPOK_only>), by hook or by crook. You want force if you are
8bb025ae 1381going to update the C<SvPVX> directly. Doesn't process get magic.
645c22ef 1382
954c1994 1383=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
5f08bad4
ST
1384Returns a pointer to the string in the SV, or a stringified form of
1385the SV if the SV does not contain a string. The SV may cache the
8554e7a0 1386stringified version becoming C<SvPOK>. Handles 'get' magic. See also
645c22ef
DM
1387C<SvPVx> for a version which guarantees to evaluate sv only once.
1388
1389=for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
4ea561bc
NC
1390A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1391Only use this if C<sv> is an expression with side effects, otherwise use the
b3adf4c0 1392more efficient C<SvPV>.
954c1994 1393
891f9566
YST
1394=for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1395Like C<SvPV> but doesn't process magic.
1396
954c1994 1397=for apidoc Am|char*|SvPV_nolen|SV* sv
5f08bad4
ST
1398Returns a pointer to the string in the SV, or a stringified form of
1399the SV if the SV does not contain a string. The SV may cache the
1400stringified form becoming C<SvPOK>. Handles 'get' magic.
954c1994 1401
71eb6d8c
TC
1402=for apidoc Am|char*|SvPV_nomg_nolen|SV* sv
1403Like C<SvPV_nolen> but doesn't process magic.
1404
954c1994 1405=for apidoc Am|IV|SvIV|SV* sv
8554e7a0 1406Coerces the given SV to an integer and returns it. See C<SvIVx> for a
645c22ef
DM
1407version which guarantees to evaluate sv only once.
1408
891f9566
YST
1409=for apidoc Am|IV|SvIV_nomg|SV* sv
1410Like C<SvIV> but doesn't process magic.
1411
645c22ef 1412=for apidoc Am|IV|SvIVx|SV* sv
8554e7a0
FC
1413Coerces the given SV to an integer and returns it.
1414Guarantees to evaluate C<sv> only once. Only use
1415this if C<sv> is an expression with side effects,
4ea561bc 1416otherwise use the more efficient C<SvIV>.
954c1994
GS
1417
1418=for apidoc Am|NV|SvNV|SV* sv
8554e7a0 1419Coerce the given SV to a double and return it. See C<SvNVx> for a version
645c22ef
DM
1420which guarantees to evaluate sv only once.
1421
6f1401dc
DM
1422=for apidoc Am|NV|SvNV_nomg|SV* sv
1423Like C<SvNV> but doesn't process magic.
1424
645c22ef 1425=for apidoc Am|NV|SvNVx|SV* sv
8554e7a0
FC
1426Coerces the given SV to a double and returns it.
1427Guarantees to evaluate C<sv> only once. Only use
1428this if C<sv> is an expression with side effects,
4ea561bc 1429otherwise use the more efficient C<SvNV>.
954c1994
GS
1430
1431=for apidoc Am|UV|SvUV|SV* sv
645c22ef
DM
1432Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
1433for a version which guarantees to evaluate sv only once.
1434
891f9566
YST
1435=for apidoc Am|UV|SvUV_nomg|SV* sv
1436Like C<SvUV> but doesn't process magic.
1437
645c22ef 1438=for apidoc Am|UV|SvUVx|SV* sv
8554e7a0
FC
1439Coerces the given SV to an unsigned integer and
1440returns it. Guarantees to C<sv> only once. Only
1441use this if C<sv> is an expression with side effects,
4ea561bc 1442otherwise use the more efficient C<SvUV>.
954c1994
GS
1443
1444=for apidoc Am|bool|SvTRUE|SV* sv
1445Returns a boolean indicating whether Perl would evaluate the SV as true or
06c841cf
FC
1446false. See SvOK() for a defined/undefined test. Handles 'get' magic
1447unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
1448private flags).
1449
1450=for apidoc Am|bool|SvTRUE_nomg|SV* sv
1451Returns a boolean indicating whether Perl would evaluate the SV as true or
c0b6140e 1452false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.
954c1994 1453
645c22ef 1454=for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
b70b15d2 1455Like C<SvPV_force>, but converts sv to utf8 first if necessary.
645c22ef
DM
1456
1457=for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
b70b15d2 1458Like C<SvPV>, but converts sv to utf8 first if necessary.
645c22ef 1459
b70b15d2
TJ
1460=for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1461Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
645c22ef
DM
1462
1463=for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1464Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1465
1466=for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1467Like C<SvPV>, but converts sv to byte representation first if necessary.
1468
b70b15d2 1469=for apidoc Am|char*|SvPVbyte_nolen|SV* sv
645c22ef
DM
1470Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1471
1472=for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
b70b15d2 1473Like C<SvPV_force>, but converts sv to utf8 first if necessary.
d1be9408 1474Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
645c22ef
DM
1475otherwise.
1476
1477=for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
b70b15d2 1478Like C<SvPV>, but converts sv to utf8 first if necessary.
d1be9408 1479Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
645c22ef
DM
1480otherwise.
1481
1482=for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1483Like C<SvPV_force>, but converts sv to byte representation first if necessary.
d1be9408 1484Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
645c22ef
DM
1485otherwise.
1486
1487=for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1488Like C<SvPV>, but converts sv to byte representation first if necessary.
d1be9408 1489Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
645c22ef
DM
1490otherwise.
1491
19dbb8f1 1492=for apidoc Am|bool|SvIsCOW|SV* sv
8554e7a0 1493Returns a boolean indicating whether the SV is Copy-On-Write (either shared
19dbb8f1 1494hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
8554e7a0 1495COW).
19dbb8f1
NC
1496
1497=for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1498Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1499scalar.
645c22ef 1500
0f76ff59
MHM
1501=for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1502Like C<sv_catpvn> but doesn't process magic.
1503
9dcc53ea
Z
1504=for apidoc Am|void|sv_catpv_nomg|SV* sv|const char* ptr
1505Like C<sv_catpv> but doesn't process magic.
1506
0f76ff59
MHM
1507=for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1508Like C<sv_setsv> but doesn't process magic.
1509
1510=for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1511Like C<sv_catsv> but doesn't process magic.
1512
dc960812
SP
1513=for apidoc Amdb|STRLEN|sv_utf8_upgrade_nomg|NN SV *sv
1514
8554e7a0 1515Like sv_utf8_upgrade, but doesn't do magic on C<sv>.
dc960812 1516
954c1994
GS
1517=cut
1518*/
1519
25da4f38 1520/* Let us hope that bitmaps for UV and IV are the same */
4bac9ae4
CS
1521#define SvIV(sv) (SvIOK_nog(sv) ? SvIVX(sv) : sv_2iv(sv))
1522#define SvUV(sv) (SvUOK_nog(sv) ? SvUVX(sv) : sv_2uv(sv))
1523#define SvNV(sv) (SvNOK_nog(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 1524
891f9566
YST
1525#define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1526#define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
6f1401dc 1527#define SvNV_nomg(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv_flags(sv, 0))
891f9566 1528
baca2b92 1529/* ----*/
8d6d96c1 1530
4bac9ae4
CS
1531#define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1532#define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
44d22300 1533#define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
8d6d96c1 1534
8d6d96c1 1535#define SvPV_flags(sv, lp, flags) \
4bac9ae4 1536 (SvPOK_nog(sv) \
8d6d96c1 1537 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
32a5c6ec 1538#define SvPV_flags_const(sv, lp, flags) \
4bac9ae4 1539 (SvPOK_nog(sv) \
32a5c6ec
NC
1540 ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1541 (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
2596d9fe 1542#define SvPV_flags_const_nolen(sv, flags) \
4bac9ae4 1543 (SvPOK_nog(sv) \
2596d9fe
NC
1544 ? SvPVX_const(sv) : \
1545 (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
44d22300 1546#define SvPV_flags_mutable(sv, lp, flags) \
4bac9ae4 1547 (SvPOK_nog(sv) \
44d22300
NC
1548 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1549 sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
79072805 1550
8d6d96c1 1551#define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
13c5b33c 1552#define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
32a5c6ec 1553#define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
baca2b92 1554
8d6d96c1 1555#define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
2596d9fe 1556#define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
8d6d96c1 1557
8d6d96c1 1558#define SvPV_force_flags(sv, lp, flags) \
8bb025ae 1559 (SvPOK_pure_nogthink(sv) \
4bac9ae4
CS
1560 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1561
13c5b33c 1562#define SvPV_force_flags_nolen(sv, flags) \
8bb025ae 1563 (SvPOK_pure_nogthink(sv) \
4bac9ae4
CS
1564 ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1565
32a5c6ec 1566#define SvPV_force_flags_mutable(sv, lp, flags) \
8bb025ae 1567 (SvPOK_pure_nogthink(sv) \
4bac9ae4 1568 ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
32a5c6ec 1569 : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
a0d0e21e 1570
1fa8b10d 1571#define SvPV_nolen(sv) \
4bac9ae4 1572 (SvPOK_nog(sv) \
dafda6d1 1573 ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
70401c6b 1574
71eb6d8c 1575#define SvPV_nomg_nolen(sv) \
4bac9ae4 1576 (SvPOK_nog(sv) \
71eb6d8c
TC
1577 ? SvPVX(sv) : sv_2pv_flags(sv, 0, 0))
1578
9ce348e8 1579#define SvPV_nolen_const(sv) \
4bac9ae4 1580 (SvPOK_nog(sv) \
9ce348e8
NC
1581 ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1582
baca2b92 1583#define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
9ce348e8 1584#define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
2596d9fe 1585#define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
5bc28da9 1586
baca2b92 1587/* ----*/
70401c6b 1588
5bc28da9 1589#define SvPVutf8(sv, lp) \
4bac9ae4 1590 (SvPOK_utf8_nog(sv) \
5bc28da9 1591 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 1592
5bc28da9 1593#define SvPVutf8_force(sv, lp) \
8bb025ae 1594 (SvPOK_utf8_pure_nogthink(sv) \
5bc28da9
NIS
1595 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1596
5bc28da9 1597#define SvPVutf8_nolen(sv) \
4bac9ae4 1598 (SvPOK_utf8_nog(sv) \
dafda6d1 1599 ? SvPVX(sv) : sv_2pvutf8(sv, 0))
70401c6b 1600
baca2b92
DM
1601/* ----*/
1602
5bc28da9 1603#define SvPVbyte(sv, lp) \
4bac9ae4 1604 (SvPOK_byte_nog(sv) \
5bc28da9 1605 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
70401c6b 1606
5bc28da9 1607#define SvPVbyte_force(sv, lp) \
8bb025ae 1608 (SvPOK_byte_pure_nogthink(sv) \
a7ec4e2e 1609 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
5bc28da9 1610
5bc28da9 1611#define SvPVbyte_nolen(sv) \
4bac9ae4 1612 (SvPOK_byte_nog(sv) \
dafda6d1 1613 ? SvPVX(sv) : sv_2pvbyte(sv, 0))
70401c6b 1614
baca2b92
DM
1615
1616/* define FOOx(): idempotent versions of FOO(). If possible, use a local
1617 * var to evaluate the arg once; failing that, use a global if possible;
1618 * failing that, call a function to do the work
1619 */
1620
1621#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1622#define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1623#define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1624
4bac9ae4
CS
1625#define SvTRUE(sv) ((sv) && (SvGMAGICAL(sv) ? sv_2bool(sv) : SvTRUE_common(sv, sv_2bool_nomg(sv))))
1626#define SvTRUE_nomg(sv) ((sv) && ( SvTRUE_common(sv, sv_2bool_nomg(sv))))
1627#define SvTRUE_common(sv,fallback) ( \
1628 !SvOK(sv) \
1629 ? 0 \
1630 : (SvFLAGS(sv) & (SVf_POK|SVf_IOK|SVf_NOK)) \
1631 ? ( (SvPOK(sv) && SvPVXtrue(sv)) \
1632 || (SvIOK(sv) && SvIVX(sv) != 0) \
1633 || (SvNOK(sv) && SvNVX(sv) != 0.0)) \
1634 : (fallback))
1635
5dc8bdac 1636#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
baca2b92 1637
b1bc3f34
NC
1638# define SvIVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvIV(_sv); })
1639# define SvUVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvUV(_sv); })
1640# define SvNVx(sv) ({SV *_sv = MUTABLE_SV(sv); SvNV(_sv); })
3de3296f 1641# define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
32a5c6ec 1642# define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
002e4c74 1643# define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
9ce348e8 1644# define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
3de3296f
AE
1645# define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1646# define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
002e4c74 1647# define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
4bac9ae4
CS
1648# define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1649# define SvTRUEx_nomg(sv) ({SV *_sv = (sv); SvTRUE_nomg(_sv); })
1650# define SvPVXtrue(sv) \
1651 ({XPV *nxpv; \
1652 (nxpv = (XPV*)SvANY(sv)) \
1653 && (nxpv->xpv_cur > 1 \
1654 || (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0'));})
baca2b92 1655
a80f87c4 1656#else /* __GNUC__ */
baca2b92 1657
a80f87c4
GS
1658/* These inlined macros use globals, which will require a thread
1659 * declaration in user code, so we avoid them under threads */
1660
3db8f154
MB
1661# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1662# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1663# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1664# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
32a5c6ec 1665# define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
002e4c74 1666# define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
5f1478c3 1667# define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
3db8f154
MB
1668# define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1669# define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
002e4c74 1670# define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
4bac9ae4
CS
1671# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1672# define SvTRUEx_nomg(sv) ((PL_Sv = (sv)), SvTRUE_nomg(PL_Sv))
1673# define SvPVXtrue(sv) \
1674 ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) \
1675 && (PL_Xpv->xpv_cur > 1 \
1676 || (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0')))
baca2b92
DM
1677#endif /* __GNU__ */
1678
fa819c1c 1679#define SvIsCOW(sv) ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
3a482d8d
FC
1680 (SVf_FAKE | SVf_READONLY) && !isGV_with_GP(sv) \
1681 && SvTYPE(sv) != SVt_REGEXP)
46187eeb 1682#define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
baca2b92 1683
bdd68bc3
NC
1684#define SvSHARED_HEK_FROM_PV(pvx) \
1685 ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
0a356b31 1686#define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
c158a4fd 1687
baca2b92
DM
1688/* flag values for sv_*_flags functions */
1689#define SV_IMMEDIATE_UNREF 1
1690#define SV_GMAGIC 2
765f542d 1691#define SV_COW_DROP_PV 4
88632417 1692#define SV_UTF8_NO_ENCODING 8
5fcdf167 1693#define SV_NOSTEAL 16
32a5c6ec
NC
1694#define SV_CONST_RETURN 32
1695#define SV_MUTABLE_RETURN 64
bddd5118 1696#define SV_SMAGIC 128
c1c21316 1697#define SV_HAS_TRAILING_NUL 256
34482cd6 1698#define SV_COW_SHARED_HASH_KEYS 512
cb23d5b1
NC
1699/* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1700#define SV_COW_OTHER_PVS 1024
9f621bb0
NC
1701/* Make sv_2pv_flags return NULL if something is undefined. */
1702#define SV_UNDEF_RETURNS_NULL 2048
b3ab6785
KW
1703/* Tell sv_utf8_upgrade() to not check to see if an upgrade is really needed.
1704 * This is used when the caller has already determined it is, and avoids
1705 * redundant work */
1706#define SV_FORCE_UTF8_UPGRADE 4096
aee036bb
DM
1707/* if (after resolving magic etc), the SV is found to be overloaded,
1708 * don't call the overload magic, just return as-is */
1709#define SV_SKIP_OVERLOAD 8192
c682ebef
FC
1710/* It is not yet clear whether we want this as an API, or what the
1711 * constants should be named. */
1712#ifdef PERL_CORE
1713# define SV_CATBYTES 16384
1714# define SV_CATUTF8 32768
1715#endif
34482cd6
NC
1716
1717/* The core is safe for this COW optimisation. XS code on CPAN may not be.
1718 So only default to doing the COW setup if we're in the core.
1719 */
1720#ifdef PERL_CORE
1721# ifndef SV_DO_COW_SVSETSV
cb23d5b1 1722# define SV_DO_COW_SVSETSV SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
34482cd6
NC
1723# endif
1724#endif
1725
1726#ifndef SV_DO_COW_SVSETSV
1727# define SV_DO_COW_SVSETSV 0
1728#endif
1729
765f542d 1730
5abc721d
NC
1731#define sv_unref(sv) sv_unref_flags(sv, 0)
1732#define sv_force_normal(sv) sv_force_normal_flags(sv, 0)
47518d95
NC
1733#define sv_usepvn(sv, p, l) sv_usepvn_flags(sv, p, l, 0)
1734#define sv_usepvn_mg(sv, p, l) sv_usepvn_flags(sv, p, l, SV_SMAGIC)
174c73e3 1735
46187eeb
NC
1736/* We are about to replace the SV's current value. So if it's copy on write
1737 we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1738 the value is about to get thrown away, so drop the PV rather than go to
1739 the effort of making a read-write copy only for it to get immediately
1740 discarded. */
765f542d
NC
1741
1742#define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1743 sv_force_normal_flags(sv, SV_COW_DROP_PV)
46187eeb 1744
f8c7b90f 1745#ifdef PERL_OLD_COPY_ON_WRITE
5302ffd4 1746#define SvRELEASE_IVX(sv) \
7a4bba22 1747 ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
46187eeb 1748# define SvIsCOW_normal(sv) (SvIsCOW(sv) && SvLEN(sv))
7a4bba22 1749# define SvRELEASE_IVX_(sv) SvRELEASE_IVX(sv),
b8f9541a 1750#else
7a4bba22
NC
1751# define SvRELEASE_IVX(sv) 0
1752/* This little game brought to you by the need to shut this warning up:
1204f081 1753mg.c: In function 'Perl_magic_get':
7a4bba22
NC
1754mg.c:1024: warning: left-hand operand of comma expression has no effect
1755*/
1756# define SvRELEASE_IVX_(sv) /**/
f8c7b90f 1757#endif /* PERL_OLD_COPY_ON_WRITE */
ed252734
NC
1758
1759#define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1760 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
dd2eae66 1761 SVf_OOK|SVf_BREAK|SVf_READONLY)
ed252734
NC
1762#define CAN_COW_FLAGS (SVp_POK|SVf_POK)
1763
765f542d
NC
1764#define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1765 sv_force_normal_flags(sv, 0)
1766
1767
baca2b92
DM
1768/* all these 'functions' are now just macros */
1769
1770#define sv_pv(sv) SvPV_nolen(sv)
1771#define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1772#define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1773
1774#define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
b3ab6785 1775#define sv_utf8_upgrade_flags(sv, flags) sv_utf8_upgrade_flags_grow(sv, flags, 0)
baca2b92
DM
1776#define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1777#define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
9dcc53ea 1778#define sv_catpv_nomg(dsv, sstr) sv_catpv_flags(dsv, sstr, 0)
34482cd6
NC
1779#define sv_setsv(dsv, ssv) \
1780 sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1781#define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
baca2b92
DM
1782#define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1783#define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
b347df82 1784#define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
baca2b92 1785#define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
4bac9ae4
CS
1786#define sv_catpvn_mg(sv, sstr, slen) sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1787#define sv_copypv(dsv, ssv) sv_copypv_flags(dsv, ssv, SV_GMAGIC)
1788#define sv_copypv_nomg(dsv, ssv) sv_copypv_flags(dsv, ssv, 0)
baca2b92 1789#define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
cb2f1b7b
NC
1790#define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1791#define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1792#define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
baca2b92
DM
1793#define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1794#define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1795#define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
891f9566
YST
1796#define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1797#define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
39d5de13 1798#define sv_2nv(sv) sv_2nv_flags(sv, SV_GMAGIC)
078504b2 1799#define sv_eq(sv1, sv2) sv_eq_flags(sv1, sv2, SV_GMAGIC)
e8c9c9d4
NC
1800#define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
1801#define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
078504b2 1802#define sv_collxfrm(sv, nxp) sv_cmp_flags(sv, nxp, SV_GMAGIC)
06c841cf 1803#define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)
4bac9ae4 1804#define sv_2bool_nomg(sv) sv_2bool_flags(sv, 0)
84335ee9
NC
1805#define sv_insert(bigstr, offset, len, little, littlelen) \
1806 Perl_sv_insert_flags(aTHX_ (bigstr),(offset), (len), (little), \
1807 (littlelen), SV_GMAGIC)
108cb980
FC
1808#define sv_mortalcopy(sv) \
1809 Perl_sv_mortalcopy_flags(aTHX_ sv, SV_GMAGIC|SV_DO_COW_SVSETSV)
baca2b92 1810
db79b45b 1811/* Should be named SvCatPVN_utf8_upgrade? */
4bac9ae4 1812#define sv_catpvn_nomg_utf8_upgrade(dsv, sstr, slen, nsv) \
db79b45b
JH
1813 STMT_START { \
1814 if (!(nsv)) \
ad25789c 1815 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP); \
db79b45b
JH
1816 else \
1817 sv_setpvn(nsv, sstr, slen); \
1818 SvUTF8_off(nsv); \
1819 sv_utf8_upgrade(nsv); \
4bac9ae4 1820 sv_catsv_nomg(dsv, nsv); \
db79b45b 1821 } STMT_END
64534138
FC
1822#define sv_catpvn_nomg_maybeutf8(dsv, sstr, slen, is_utf8) \
1823 sv_catpvn_flags(dsv, sstr, slen, (is_utf8)?SV_CATUTF8:SV_CATBYTES)
79072805 1824
aec43834
FC
1825#ifdef PERL_CORE
1826# define sv_or_pv_len_utf8(sv, pv, bytelen) \
1827 (SvGAMAGIC(sv) \
1828 ? utf8_length((U8 *)(pv), (U8 *)(pv)+(bytelen)) \
1829 : sv_len_utf8(sv))
6964422a 1830# define sv_or_pv_pos_u2b(sv,s,p,lp) S_sv_or_pv_pos_u2b(aTHX_ sv,s,p,lp)
aec43834
FC
1831#endif
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/*
35e035cc
FC
2001=for apidoc Amx|SV*|newSVpadname|PADNAME *pn
2002
2003Creates a new SV containing the pad name. This is currently identical
2004to C<newSVsv>, but pad names may cease being SVs at some point, so
2005C<newSVpadname> is preferable.
2006
2007=cut
2008*/
2009
2010#define newSVpadname(pn) newSVsv(pn)
2011
2012/*
69240efd
NC
2013=for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
2014
2015Reads into I<len> the offset from SvPVX back to the true start of the
2016allocated buffer, which will be non-zero if C<sv_chop> has been used to
8554e7a0 2017efficiently remove characters from start of the buffer. Implemented as a
69240efd 2018macro, which takes the address of I<len>, which must be of type C<STRLEN>.
8554e7a0 2019Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
69240efd
NC
2020
2021=cut
2022*/
2023
2024#ifdef DEBUGGING
2025/* Does the bot know something I don't?
202610:28 <@Nicholas> metabatman
202710:28 <+meta> Nicholas: crash
2028*/
2029# define SvOOK_offset(sv, offset) STMT_START { \
2030 assert(sizeof(offset) == sizeof(STRLEN)); \
2031 if (SvOOK(sv)) { \
d845901f
CS
2032 const U8 *_crash = (U8*)SvPVX_const(sv); \
2033 (offset) = *--_crash; \
2034 if (!(offset)) { \
2035 _crash -= sizeof(STRLEN); \
2036 Copy(_crash, (U8 *)&(offset), sizeof(STRLEN), U8); \
69240efd
NC
2037 } \
2038 { \
2039 /* Validate the preceding buffer's sentinels to \
2040 verify that no-one is using it. */ \
d845901f
CS
2041 const U8 *const _bonk = (U8*)SvPVX_const(sv) - (offset);\
2042 while (_crash > _bonk) { \
2043 --_crash; \
2044 assert (*_crash == (U8)PTR2UV(_crash)); \
69240efd
NC
2045 } \
2046 } \
2047 } else { \
d845901f 2048 (offset) = 0; \
69240efd
NC
2049 } \
2050 } STMT_END
2051#else
2052 /* This is the same code, but avoids using any temporary variables: */
2053# define SvOOK_offset(sv, offset) STMT_START { \
2054 assert(sizeof(offset) == sizeof(STRLEN)); \
2055 if (SvOOK(sv)) { \
d845901f
CS
2056 (offset) = ((U8*)SvPVX_const(sv))[-1]; \
2057 if (!(offset)) { \
69240efd 2058 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN), \
d845901f 2059 (U8*)&(offset), sizeof(STRLEN), U8); \
69240efd
NC
2060 } \
2061 } else { \
d845901f 2062 (offset) = 0; \
69240efd
NC
2063 } \
2064 } STMT_END
2065#endif
85dca89a
NC
2066
2067#define newIO() MUTABLE_IO(newSV_type(SVt_PVIO))
2068
69240efd 2069/*
102d3b8a
NC
2070 * Local variables:
2071 * c-indentation-style: bsd
2072 * c-basic-offset: 4
14d04a33 2073 * indent-tabs-mode: nil
102d3b8a
NC
2074 * End:
2075 *
14d04a33 2076 * ex: set ts=8 sts=4 sw=4 et:
102d3b8a 2077 */