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