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