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