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