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