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