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