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