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