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