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