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