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