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