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