This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Negative subscripts optionally passed to tied array methods
[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
a863c7d1 155#ifdef __GNUC__
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
5bc28da9
NIS
210#define SVf_UTF8 0x20000000 /* SvPVX is UTF-8 encoded */
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
GS
489
490=for apidoc Am|bool|SvOOK|SV* sv
491Returns a boolean indicating whether the SvIVX is a valid offset value for
492the SvPVX. This hack is used internally to speed up removal of characters
493from the beginning of a SvPV. When SvOOK is true, then the start of the
494allocated string buffer is really (SvPVX - SvIVX).
495
496=for apidoc Am|bool|SvROK|SV* sv
497Tests if the SV is an RV.
498
499=for apidoc Am|void|SvROK_on|SV* sv
500Tells an SV that it is an RV.
501
502=for apidoc Am|void|SvROK_off|SV* sv
503Unsets the RV status of an SV.
504
505=for apidoc Am|SV*|SvRV|SV* sv
506Dereferences an RV to return the SV.
507
508=for apidoc Am|IV|SvIVX|SV* sv
645c22ef
DM
509Returns the raw value in the SV's IV slot, without checks or conversions.
510Only use when you are sure SvIOK is true. See also C<SvIV()>.
954c1994
GS
511
512=for apidoc Am|UV|SvUVX|SV* sv
645c22ef
DM
513Returns the raw value in the SV's UV slot, without checks or conversions.
514Only use when you are sure SvIOK is true. See also C<SvUV()>.
954c1994
GS
515
516=for apidoc Am|NV|SvNVX|SV* sv
645c22ef
DM
517Returns the raw value in the SV's NV slot, without checks or conversions.
518Only use when you are sure SvNOK is true. See also C<SvNV()>.
954c1994
GS
519
520=for apidoc Am|char*|SvPVX|SV* sv
645c22ef 521Returns a pointer to the physical string in the SV. The SV must contain a
954c1994
GS
522string.
523
524=for apidoc Am|STRLEN|SvCUR|SV* sv
525Returns the length of the string which is in the SV. See C<SvLEN>.
526
527=for apidoc Am|STRLEN|SvLEN|SV* sv
659239a4
MG
528Returns the size of the string buffer in the SV, not including any part
529attributable to C<SvOOK>. See C<SvCUR>.
954c1994
GS
530
531=for apidoc Am|char*|SvEND|SV* sv
532Returns a pointer to the last character in the string which is in the SV.
533See C<SvCUR>. Access the character as *(SvEND(sv)).
534
535=for apidoc Am|HV*|SvSTASH|SV* sv
536Returns the stash of the SV.
537
538=for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
539Set the length of the string which is in the SV. See C<SvCUR>.
540
541=cut
542*/
543
79072805 544#define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
748a9306 545#define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
a0d0e21e 546#define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
25da4f38 547 SVp_IOK|SVp_NOK|SVf_IVisUV))
79072805 548
463ee0b2 549#define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
25da4f38 550#define SvOK_off(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
d41ff1b8 551 SVf_IVisUV|SVf_UTF8), \
25da4f38 552 SvOOK_off(sv))
d41ff1b8
GS
553#define SvOK_off_exc_UV(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
554 SVf_UTF8), \
a0d0e21e 555 SvOOK_off(sv))
79072805 556
8990e307
LW
557#define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
558#define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
155aba94 559#define SvIOKp_on(sv) ((void)SvOOK_off(sv), SvFLAGS(sv) |= SVp_IOK)
8990e307
LW
560#define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
561#define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
562#define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
563#define SvPOKp_on(sv) (SvFLAGS(sv) |= SVp_POK)
463ee0b2 564
79072805 565#define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
155aba94 566#define SvIOK_on(sv) ((void)SvOOK_off(sv), \
a0d0e21e 567 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38 568#define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
155aba94 569#define SvIOK_only(sv) ((void)SvOK_off(sv), \
a0d0e21e 570 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
155aba94 571#define SvIOK_only_UV(sv) ((void)SvOK_off_exc_UV(sv), \
25da4f38 572 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
70401c6b 573
25da4f38
IZ
574#define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
575 == (SVf_IOK|SVf_IVisUV))
28e5dec8 576#define SvUOK(sv) SvIOK_UV(sv)
25da4f38
IZ
577#define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
578 == SVf_IOK)
579
580#define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
581#define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
582#define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
79072805
LW
583
584#define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
a0d0e21e 585#define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
8990e307 586#define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
155aba94 587#define SvNOK_only(sv) ((void)SvOK_off(sv), \
a0d0e21e 588 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
79072805 589
914184e1
JH
590/*
591=for apidoc Am|void|SvUTF8|SV* sv
592Returns a boolean indicating whether the SV contains UTF-8 encoded data.
593
594=for apidoc Am|void|SvUTF8_on|SV *sv
d5ce4a7c
GA
595Turn on the UTF8 status of an SV (the data is not changed, just the flag).
596Do not use frivolously.
914184e1
JH
597
598=for apidoc Am|void|SvUTF8_off|SV *sv
599Unsets the UTF8 status of an SV.
600
601=for apidoc Am|void|SvPOK_only_UTF8|SV* sv
d5ce4a7c
GA
602Tells an SV that it is a string and disables all other OK bits,
603and leaves the UTF8 status as it was.
f1a1024e 604
914184e1
JH
605=cut
606 */
607
a7cb1f99
GS
608#define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
609#define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
610#define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
5bc28da9 611
79072805 612#define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
a0d0e21e 613#define SvPOK_on(sv) (SvFLAGS(sv) |= (SVf_POK|SVp_POK))
8990e307 614#define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
d41ff1b8
GS
615#define SvPOK_only(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
616 SVf_IVisUV|SVf_UTF8), \
617 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
618#define SvPOK_only_UTF8(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
619 SVf_IVisUV), \
a0d0e21e 620 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
79072805
LW
621
622#define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
155aba94 623#define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
79072805 624#define SvOOK_off(sv) (SvOOK(sv) && sv_backoff(sv))
79072805 625
a0d0e21e
LW
626#define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
627#define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
628#define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
629
ed6116ce 630#define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
a0d0e21e 631#define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
a0d0e21e 632#define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
79072805 633
8990e307
LW
634#define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
635#define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
636#define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
79072805 637
8990e307
LW
638#define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
639#define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
640#define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
ed6116ce 641
8990e307
LW
642#define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
643#define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
644#define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
ed6116ce 645
8990e307
LW
646#define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
647#define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
648#define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
ed6116ce 649
9e7bc3e8
JD
650#define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
651#define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
652#define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
a0d0e21e 653
8cf8f3d1 654#define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
1426bbf4 655
a0d0e21e
LW
656/*
657#define Gv_AMG(stash) \
658 (HV_AMAGICmb(stash) && \
659 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
660*/
3280af22 661#define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
a0d0e21e 662
810b8aa5
GS
663#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
664 == (SVf_ROK|SVprv_WEAKREF))
665#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
666#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
667
a0d0e21e 668#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 669
8990e307 670#define SvPADBUSY(sv) (SvFLAGS(sv) & SVs_PADBUSY)
ed6116ce 671
8990e307
LW
672#define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
673#define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP|SVs_PADBUSY)
674#define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
ed6116ce 675
8990e307
LW
676#define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
677#define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY|SVs_PADBUSY)
ed6116ce 678
8990e307
LW
679#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
680#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
681#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 682
8990e307
LW
683#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
684#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
685#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 686
8990e307
LW
687#define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
688#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
689#define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
79072805 690
8990e307
LW
691#define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
692#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
693#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 694
8990e307
LW
695#define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
696#define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
697#define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
79072805 698
25da4f38
IZ
699#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
700#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
701#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
702
8990e307
LW
703#define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
704#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
705#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
706
8990e307
LW
707#define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
708#define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
709#define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
710
1cc8b4c5
AB
711#ifdef USE_ITHREADS
712/* The following uses the FAKE flag to show that a regex pointer is infact
8ca6097c 713 its own offset in the regexpad for ithreads */
1cc8b4c5
AB
714#define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
715#define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
716#define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
717#endif
718
ed6116ce
LW
719#define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
720#define SvRVx(sv) SvRV(sv)
721
463ee0b2
LW
722#define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
723#define SvIVXx(sv) SvIVX(sv)
ff68c719
PP
724#define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
725#define SvUVXx(sv) SvUVX(sv)
463ee0b2
LW
726#define SvNVX(sv) ((XPVNV*)SvANY(sv))->xnv_nv
727#define SvNVXx(sv) SvNVX(sv)
728#define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
729#define SvPVXx(sv) SvPVX(sv)
79072805 730#define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
79072805
LW
731#define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
732#define SvLENx(sv) SvLEN(sv)
733#define SvEND(sv)(((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
6b88bc9c 734#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
79072805
LW
735#define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
736#define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
737
28e5dec8
JH
738/* Ask a scalar nicely to try to become an IV, if possible.
739 Not guaranteed to stay returning void */
740/* Macro won't actually call sv_2iv if already IOK */
741#define SvIV_please(sv) \
742 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
743 (void) SvIV(sv); } STMT_END
79072805 744#define SvIV_set(sv, val) \
80b92232
PP
745 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
746 (((XPVIV*) SvANY(sv))->xiv_iv = val); } STMT_END
79072805 747#define SvNV_set(sv, val) \
80b92232
PP
748 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
749 (((XPVNV*) SvANY(sv))->xnv_nv = val); } STMT_END
79072805 750#define SvPV_set(sv, val) \
80b92232
PP
751 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
752 (((XPV*) SvANY(sv))->xpv_pv = val); } STMT_END
79072805 753#define SvCUR_set(sv, val) \
80b92232
PP
754 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
755 (((XPV*) SvANY(sv))->xpv_cur = val); } STMT_END
79072805 756#define SvLEN_set(sv, val) \
80b92232
PP
757 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
758 (((XPV*) SvANY(sv))->xpv_len = val); } STMT_END
79072805 759#define SvEND_set(sv, val) \
80b92232
PP
760 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
761 (((XPV*) SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
79072805
LW
762
763#define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
764#define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
765#define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
766
767#define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
768
769#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
770#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
771#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
772#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
773
8990e307
LW
774#define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
775#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
776#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
4755096e 777#define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
8990e307
LW
778#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
779#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
780#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
781#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
782#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
783#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
784#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
785#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
786#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
787#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
788#define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
789#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
790#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
791
50952442
JH
792/* IoTYPE(sv) is a single character telling the type of I/O connection. */
793#define IoTYPE_RDONLY '<'
794#define IoTYPE_WRONLY '>'
795#define IoTYPE_RDWR '+'
796#define IoTYPE_APPEND 'a'
797#define IoTYPE_PIPE '|'
798#define IoTYPE_STD '-' /* stdin or stdout */
799#define IoTYPE_SOCKET 's'
800#define IoTYPE_CLOSED ' '
03fcf2fc
GS
801
802/*
954c1994
GS
803=for apidoc Am|bool|SvTAINTED|SV* sv
804Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
805not.
806
807=for apidoc Am|void|SvTAINTED_on|SV* sv
808Marks an SV as tainted.
809
810=for apidoc Am|void|SvTAINTED_off|SV* sv
811Untaints an SV. Be I<very> careful with this routine, as it short-circuits
812some of Perl's fundamental security features. XS module authors should not
813use this function unless they fully understand all the implications of
814unconditionally untainting the value. Untainting should be done in the
815standard perl fashion, via a carefully crafted regexp, rather than directly
816untainting variables.
817
818=for apidoc Am|void|SvTAINT|SV* sv
819Taints an SV if tainting is enabled
820
821=cut
822*/
823
bbce6d69 824#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22
NIS
825#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
826#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 827
c6ee37c5
MB
828#define SvTAINT(sv) \
829 STMT_START { \
3280af22 830 if (PL_tainting) { \
3280af22 831 if (PL_tainted) \
c6ee37c5
MB
832 SvTAINTED_on(sv); \
833 } \
834 } STMT_END
79072805 835
954c1994
GS
836/*
837=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
5f08bad4
ST
838Like C<SvPV> but will force the SV into containing just a string
839(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
840directly.
954c1994 841
645c22ef 842=for apidoc Am|char*|SvPV_force_nomg|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. Doesn't process magic.
645c22ef 846
954c1994 847=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
5f08bad4
ST
848Returns a pointer to the string in the SV, or a stringified form of
849the SV if the SV does not contain a string. The SV may cache the
850stringified version becoming C<SvPOK>. Handles 'get' magic. See also
645c22ef
DM
851C<SvPVx> for a version which guarantees to evaluate sv only once.
852
853=for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
854A version of C<SvPV> which guarantees to evaluate sv only once.
954c1994
GS
855
856=for apidoc Am|char*|SvPV_nolen|SV* sv
5f08bad4
ST
857Returns a pointer to the string in the SV, or a stringified form of
858the SV if the SV does not contain a string. The SV may cache the
859stringified form becoming C<SvPOK>. Handles 'get' magic.
954c1994
GS
860
861=for apidoc Am|IV|SvIV|SV* sv
645c22ef
DM
862Coerces the given SV to an integer and returns it. See C<SvIVx> for a
863version which guarantees to evaluate sv only once.
864
865=for apidoc Am|IV|SvIVx|SV* sv
866Coerces the given SV to an integer and returns it. Guarantees to evaluate
d1be9408 867sv only once. Use the more efficient C<SvIV> otherwise.
954c1994
GS
868
869=for apidoc Am|NV|SvNV|SV* sv
645c22ef
DM
870Coerce the given SV to a double and return it. See C<SvNVx> for a version
871which guarantees to evaluate sv only once.
872
873=for apidoc Am|NV|SvNVx|SV* sv
874Coerces the given SV to a double and returns it. Guarantees to evaluate
d1be9408 875sv only once. Use the more efficient C<SvNV> otherwise.
954c1994
GS
876
877=for apidoc Am|UV|SvUV|SV* sv
645c22ef
DM
878Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
879for a version which guarantees to evaluate sv only once.
880
881=for apidoc Am|UV|SvUVx|SV* sv
882Coerces the given SV to an unsigned integer and returns it. Guarantees to
d1be9408 883evaluate sv only once. Use the more efficient C<SvUV> otherwise.
954c1994
GS
884
885=for apidoc Am|bool|SvTRUE|SV* sv
886Returns a boolean indicating whether Perl would evaluate the SV as true or
887false, defined or undefined. Does not handle 'get' magic.
888
645c22ef 889=for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
b70b15d2 890Like C<SvPV_force>, but converts sv to utf8 first if necessary.
645c22ef
DM
891
892=for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
b70b15d2 893Like C<SvPV>, but converts sv to utf8 first if necessary.
645c22ef 894
b70b15d2
TJ
895=for apidoc Am|char*|SvPVutf8_nolen|SV* sv
896Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
645c22ef
DM
897
898=for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
899Like C<SvPV_force>, but converts sv to byte representation first if necessary.
900
901=for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
902Like C<SvPV>, but converts sv to byte representation first if necessary.
903
b70b15d2 904=for apidoc Am|char*|SvPVbyte_nolen|SV* sv
645c22ef
DM
905Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
906
907=for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
b70b15d2 908Like C<SvPV_force>, but converts sv to utf8 first if necessary.
d1be9408 909Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
645c22ef
DM
910otherwise.
911
912=for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
b70b15d2 913Like C<SvPV>, but converts sv to utf8 first if necessary.
d1be9408 914Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
645c22ef
DM
915otherwise.
916
917=for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
918Like C<SvPV_force>, but converts sv to byte representation first if necessary.
d1be9408 919Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
645c22ef
DM
920otherwise.
921
922=for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
923Like C<SvPV>, but converts sv to byte representation first if necessary.
d1be9408 924Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
645c22ef
DM
925otherwise.
926
927
954c1994
GS
928=cut
929*/
930
25da4f38 931/* Let us hope that bitmaps for UV and IV are the same */
463ee0b2 932#define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
ff68c719 933#define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
463ee0b2 934#define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 935
baca2b92 936/* ----*/
8d6d96c1 937
8d6d96c1
HS
938#define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
939
8d6d96c1
HS
940#define SvPV_flags(sv, lp, flags) \
941 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
942 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
79072805 943
8d6d96c1 944#define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
baca2b92 945
8d6d96c1
HS
946#define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
947
8d6d96c1 948#define SvPV_force_flags(sv, lp, flags) \
ff68c719 949 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
8d6d96c1 950 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
a0d0e21e 951
1fa8b10d 952#define SvPV_nolen(sv) \
5bc28da9
NIS
953 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
954 ? SvPVX(sv) : sv_2pv_nolen(sv))
70401c6b 955
baca2b92 956#define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
5bc28da9 957
baca2b92 958/* ----*/
70401c6b 959
5bc28da9
NIS
960#define SvPVutf8(sv, lp) \
961 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
962 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 963
5bc28da9 964#define SvPVutf8_force(sv, lp) \
70401c6b 965 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
5bc28da9
NIS
966 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
967
baca2b92 968
5bc28da9
NIS
969#define SvPVutf8_nolen(sv) \
970 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
971 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
70401c6b 972
baca2b92
DM
973/* ----*/
974
5bc28da9
NIS
975#define SvPVbyte(sv, lp) \
976 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
977 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
70401c6b 978
5bc28da9
NIS
979#define SvPVbyte_force(sv, lp) \
980 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
981 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyte_force(sv, &lp))
982
5bc28da9
NIS
983#define SvPVbyte_nolen(sv) \
984 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
985 ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
70401c6b 986
1fa8b10d 987
baca2b92
DM
988
989/* define FOOx(): idempotent versions of FOO(). If possible, use a local
990 * var to evaluate the arg once; failing that, use a global if possible;
991 * failing that, call a function to do the work
992 */
993
994#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
995#define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
996#define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
997
a80f87c4 998#ifdef __GNUC__
baca2b92 999
a80f87c4
GS
1000# define SvIVx(sv) ({SV *nsv = (SV*)(sv); SvIV(nsv); })
1001# define SvUVx(sv) ({SV *nsv = (SV*)(sv); SvUV(nsv); })
1002# define SvNVx(sv) ({SV *nsv = (SV*)(sv); SvNV(nsv); })
1003# define SvPVx(sv, lp) ({SV *nsv = (sv); SvPV(nsv, lp); })
5bc28da9
NIS
1004# define SvPVutf8x(sv, lp) ({SV *nsv = (sv); SvPVutf8(nsv, lp); })
1005# define SvPVbytex(sv, lp) ({SV *nsv = (sv); SvPVbyte(nsv, lp); })
a80f87c4 1006# define SvTRUE(sv) ( \
8990e307
LW
1007 !sv \
1008 ? 0 \
1009 : SvPOK(sv) \
a80f87c4
GS
1010 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1011 nxpv && \
c2f1de04 1012 (nxpv->xpv_cur > 1 || \
a80f87c4 1013 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
79072805
LW
1014 ? 1 \
1015 : 0) \
1016 : \
1017 SvIOK(sv) \
463ee0b2 1018 ? SvIVX(sv) != 0 \
79072805 1019 : SvNOK(sv) \
463ee0b2
LW
1020 ? SvNVX(sv) != 0.0 \
1021 : sv_2bool(sv) )
a80f87c4 1022# define SvTRUEx(sv) ({SV *nsv = (sv); SvTRUE(nsv); })
baca2b92 1023
a80f87c4 1024#else /* __GNUC__ */
baca2b92
DM
1025
1026# ifdef USE_5005THREADS
1027# define SvIVx(sv) sv_iv(sv)
1028# define SvUVx(sv) sv_uv(sv)
1029# define SvNVx(sv) sv_nv(sv)
1030# define SvPVx(sv, lp) sv_pvn(sv, &lp)
1031# define SvPVutf8x(sv, lp) sv_pvutf8n(sv, &lp)
1032# define SvPVbytex(sv, lp) sv_pvbyten(sv, &lp)
1033# define SvTRUE(sv) SvTRUEx(sv)
1034# define SvTRUEx(sv) sv_true(sv)
1035
1036# else /* USE_5005THREADS */
1037
a80f87c4
GS
1038/* These inlined macros use globals, which will require a thread
1039 * declaration in user code, so we avoid them under threads */
1040
baca2b92
DM
1041# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1042# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1043# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1044# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1045# define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1046# define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1047# define SvTRUE(sv) ( \
a80f87c4
GS
1048 !sv \
1049 ? 0 \
1050 : SvPOK(sv) \
6b88bc9c 1051 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
c2f1de04 1052 (PL_Xpv->xpv_cur > 1 || \
6b88bc9c 1053 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
a80f87c4
GS
1054 ? 1 \
1055 : 0) \
1056 : \
1057 SvIOK(sv) \
1058 ? SvIVX(sv) != 0 \
1059 : SvNOK(sv) \
1060 ? SvNVX(sv) != 0.0 \
1061 : sv_2bool(sv) )
baca2b92
DM
1062# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1063# endif /* USE_5005THREADS */
1064#endif /* __GNU__ */
1065
1066
1067/* flag values for sv_*_flags functions */
1068#define SV_IMMEDIATE_UNREF 1
1069#define SV_GMAGIC 2
1070
1071/* all these 'functions' are now just macros */
1072
1073#define sv_pv(sv) SvPV_nolen(sv)
1074#define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1075#define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1076
1077#define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1078#define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1079#define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1080#define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1081#define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1082#define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1083#define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1084#define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1085#define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1086#define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1087#define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1088#define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1089
79072805 1090
954c1994
GS
1091/*
1092=for apidoc Am|SV*|newRV_inc|SV* sv
1093
1094Creates an RV wrapper for an SV. The reference count for the original SV is
1095incremented.
1096
1097=cut
1098*/
1099
5f05dabc 1100#define newRV_inc(sv) newRV(sv)
5f05dabc 1101
ef50df4b 1102/* the following macros update any magic values this sv is associated with */
79072805 1103
954c1994 1104/*
ccfc67b7
JH
1105=head1 Magical Functions
1106
954c1994
GS
1107=for apidoc Am|void|SvGETMAGIC|SV* sv
1108Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1109argument more than once.
1110
1111=for apidoc Am|void|SvSETMAGIC|SV* sv
1112Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1113argument more than once.
1114
1115=for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1116Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1117more than once.
1118
1119=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1120Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1121ssv. May evaluate arguments more than once.
1122
645c22ef
DM
1123=for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1124Like C<SvSetSV>, but does any set magic required afterwards.
1125
1126=for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1127Like C<SvSetMagicSV>, but does any set magic required afterwards.
1128
68795e93
NIS
1129=for apidoc Am|void|SvSHARE|SV* sv
1130Arranges for sv to be shared between threads if a suitable module
1131has been loaded.
1132
1133=for apidoc Am|void|SvLOCK|SV* sv
1134Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1135has been loaded.
1136
1137=for apidoc Am|void|SvUNLOCK|SV* sv
1138Releases a mutual exclusion lock on sv if a suitable module
1139has been loaded.
1140
ccfc67b7
JH
1141=head1 SV Manipulation Functions
1142
679ac26e 1143=for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
954c1994
GS
1144Expands the character buffer in the SV so that it has room for the
1145indicated number of bytes (remember to reserve space for an extra trailing
8cf8f3d1 1146NUL character). Calls C<sv_grow> to perform the expansion if necessary.
954c1994
GS
1147Returns a pointer to the character buffer.
1148
1149=cut
1150*/
1151
68795e93
NIS
1152#define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1153#define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1154#define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1155
189b2af5
GS
1156#define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1157#define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
79072805 1158
54310121 1159#define SvSetSV_and(dst,src,finally) \
189b2af5 1160 STMT_START { \
54310121
PP
1161 if ((dst) != (src)) { \
1162 sv_setsv(dst, src); \
1163 finally; \
189b2af5
GS
1164 } \
1165 } STMT_END
54310121 1166#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 1167 STMT_START { \
8ebc5c01
PP
1168 if ((dst) != (src)) { \
1169 U32 tMpF = SvFLAGS(src) & SVs_TEMP; \
1170 SvTEMP_off(src); \
1171 sv_setsv(dst, src); \
1172 SvFLAGS(src) |= tMpF; \
54310121 1173 finally; \
189b2af5
GS
1174 } \
1175 } STMT_END
79072805 1176
54310121 1177#define SvSetSV(dst,src) \
c9d716f7 1178 SvSetSV_and(dst,src,/*nothing*/;)
54310121 1179#define SvSetSV_nosteal(dst,src) \
c9d716f7 1180 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121
PP
1181
1182#define SvSetMagicSV(dst,src) \
1183 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1184#define SvSetMagicSV_nosteal(dst,src) \
1185 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1186
1045810a 1187#if !defined(SKIP_DEBUGGING)
79072805 1188#define SvPEEK(sv) sv_peek(sv)
3967c732
JD
1189#else
1190#define SvPEEK(sv) ""
1191#endif
79072805 1192
3280af22 1193#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no)
36477c24 1194
3280af22 1195#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 1196
79072805
LW
1197#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1198
933fea7f
GS
1199#define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1200#define Sv_Grow sv_grow
3d35f11b 1201
a0739874
DM
1202#define CLONEf_COPY_STACKS 1
1203#define CLONEf_KEEP_PTR_TABLE 2
c43294b8 1204#define CLONEf_CLONE_HOST 4
a0739874 1205
8cf8f3d1 1206struct clone_params {
d2d73c3e
AB
1207 AV* stashes;
1208 UV flags;
59b40662 1209 PerlInterpreter *proto_perl;
8cf8f3d1 1210};