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