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