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