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