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