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