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