This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
C<@a = @b = split(...)> optimization coredumps under ithreads
[perl5.git] / sv.h
CommitLineData
a0d0e21e 1/* sv.h
79072805 2 *
3818b22b 3 * Copyright (c) 1991-2000, Larry Wall
79072805
LW
4 *
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
7 *
79072805
LW
8 */
9
a0d0e21e
LW
10#ifdef sv_flags
11#undef sv_flags /* Convex has this in <signal.h> for sigvec() */
12#endif
13
954c1994
GS
14/*
15=for apidoc AmU||svtype
16An enum of flags for Perl types. These are found in the file B<sv.h>
17in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
18
19=for apidoc AmU||SVt_PV
20Pointer type flag for scalars. See C<svtype>.
21
22=for apidoc AmU||SVt_IV
23Integer type flag for scalars. See C<svtype>.
24
25=for apidoc AmU||SVt_NV
26Double type flag for scalars. See C<svtype>.
27
28=for apidoc AmU||SVt_PVMG
29Type flag for blessed scalars. See C<svtype>.
30
31=for apidoc AmU||SVt_PVAV
32Type flag for arrays. See C<svtype>.
33
34=for apidoc AmU||SVt_PVHV
35Type flag for hashes. See C<svtype>.
36
37=for apidoc AmU||SVt_PVCV
38Type flag for code refs. See C<svtype>.
39
40=cut
41*/
42
79072805 43typedef enum {
a0d0e21e
LW
44 SVt_NULL, /* 0 */
45 SVt_IV, /* 1 */
46 SVt_NV, /* 2 */
47 SVt_RV, /* 3 */
48 SVt_PV, /* 4 */
49 SVt_PVIV, /* 5 */
50 SVt_PVNV, /* 6 */
51 SVt_PVMG, /* 7 */
52 SVt_PVBM, /* 8 */
53 SVt_PVLV, /* 9 */
54 SVt_PVAV, /* 10 */
55 SVt_PVHV, /* 11 */
56 SVt_PVCV, /* 12 */
57 SVt_PVGV, /* 13 */
58 SVt_PVFM, /* 14 */
59 SVt_PVIO /* 15 */
79072805
LW
60} svtype;
61
79072805
LW
62/* Using C's structural equivalence to help emulate C++ inheritance here... */
63
64struct sv {
463ee0b2 65 void* sv_any; /* pointer to something */
79072805 66 U32 sv_refcnt; /* how many references to us */
8990e307 67 U32 sv_flags; /* what we are */
79072805
LW
68};
69
70struct gv {
463ee0b2 71 XPVGV* sv_any; /* pointer to something */
79072805 72 U32 sv_refcnt; /* how many references to us */
8990e307 73 U32 sv_flags; /* what we are */
79072805
LW
74};
75
76struct cv {
232e078e 77 XPVCV* sv_any; /* pointer to something */
79072805 78 U32 sv_refcnt; /* how many references to us */
8990e307 79 U32 sv_flags; /* what we are */
79072805
LW
80};
81
82struct av {
463ee0b2 83 XPVAV* sv_any; /* pointer to something */
79072805 84 U32 sv_refcnt; /* how many references to us */
8990e307 85 U32 sv_flags; /* what we are */
79072805
LW
86};
87
88struct hv {
463ee0b2 89 XPVHV* sv_any; /* pointer to something */
79072805 90 U32 sv_refcnt; /* how many references to us */
8990e307
LW
91 U32 sv_flags; /* what we are */
92};
93
94struct io {
95 XPVIO* sv_any; /* pointer to something */
96 U32 sv_refcnt; /* how many references to us */
97 U32 sv_flags; /* what we are */
79072805
LW
98};
99
954c1994
GS
100/*
101=for apidoc Am|U32|SvREFCNT|SV* sv
102Returns the value of the object's reference count.
103
104=for apidoc Am|SV*|SvREFCNT_inc|SV* sv
105Increments the reference count of the given SV.
106
107=for apidoc Am|void|SvREFCNT_dec|SV* sv
108Decrements the reference count of the given SV.
109
110=for apidoc Am|svtype|SvTYPE|SV* sv
111Returns the type of the SV. See C<svtype>.
112
113=for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
114Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
115perform the upgrade if necessary. See C<svtype>.
116
117=cut
118*/
119
463ee0b2 120#define SvANY(sv) (sv)->sv_any
79072805 121#define SvFLAGS(sv) (sv)->sv_flags
aeea060c 122#define SvREFCNT(sv) (sv)->sv_refcnt
a863c7d1 123
dce16143
MB
124#ifdef USE_THREADS
125
3d35f11b
GS
126# if defined(VMS)
127# define ATOMIC_INC(count) __ATOMIC_INCREMENT_LONG(&count)
128# define ATOMIC_DEC_AND_TEST(res,count) res=(1==__ATOMIC_DECREMENT_LONG(&count))
129 # else
130# ifdef EMULATE_ATOMIC_REFCOUNTS
131 # define ATOMIC_INC(count) STMT_START { \
132 MUTEX_LOCK(&PL_svref_mutex); \
133 ++count; \
134 MUTEX_UNLOCK(&PL_svref_mutex); \
135 } STMT_END
136# define ATOMIC_DEC_AND_TEST(res,count) STMT_START { \
137 MUTEX_LOCK(&PL_svref_mutex); \
138 res = (--count == 0); \
139 MUTEX_UNLOCK(&PL_svref_mutex); \
140 } STMT_END
141# else
142# define ATOMIC_INC(count) atomic_inc(&count)
143# define ATOMIC_DEC_AND_TEST(res,count) (res = atomic_dec_and_test(&count))
144# endif /* EMULATE_ATOMIC_REFCOUNTS */
145# endif /* VMS */
dce16143
MB
146#else
147# define ATOMIC_INC(count) (++count)
83b0a010 148# define ATOMIC_DEC_AND_TEST(res, count) (res = (--count == 0))
dce16143
MB
149#endif /* USE_THREADS */
150
a863c7d1 151#ifdef __GNUC__
dce16143
MB
152# define SvREFCNT_inc(sv) \
153 ({ \
154 SV *nsv = (SV*)(sv); \
155 if (nsv) \
156 ATOMIC_INC(SvREFCNT(nsv)); \
157 nsv; \
158 })
8990e307 159#else
a863c7d1 160# if defined(CRIPPLED_CC) || defined(USE_THREADS)
3d35f11b
GS
161# if defined(VMS) && defined(__ALPHA)
162# define SvREFCNT_inc(sv) \
163 (PL_Sv=(SV*)(sv), (PL_Sv && __ATOMIC_INCREMENT_LONG(&(SvREFCNT(PL_Sv)))), (SV *)PL_Sv)
164# else
165# define SvREFCNT_inc(sv) sv_newref((SV*)sv)
166# endif
a863c7d1 167# else
dce16143 168# define SvREFCNT_inc(sv) \
6b88bc9c 169 ((PL_Sv=(SV*)(sv)), (PL_Sv && ATOMIC_INC(SvREFCNT(PL_Sv))), (SV*)PL_Sv)
a863c7d1 170# endif
8990e307
LW
171#endif
172
a863c7d1
MB
173#define SvREFCNT_dec(sv) sv_free((SV*)sv)
174
8990e307
LW
175#define SVTYPEMASK 0xff
176#define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
79072805
LW
177
178#define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
179
8990e307
LW
180#define SVs_PADBUSY 0x00000100 /* reserved for tmp or my already */
181#define SVs_PADTMP 0x00000200 /* in use as tmp */
182#define SVs_PADMY 0x00000400 /* in use a "my" variable */
183#define SVs_TEMP 0x00000800 /* string is stealable? */
184#define SVs_OBJECT 0x00001000 /* is "blessed" */
185#define SVs_GMG 0x00002000 /* has magical get method */
186#define SVs_SMG 0x00004000 /* has magical set method */
187#define SVs_RMG 0x00008000 /* has random magical methods */
188
189#define SVf_IOK 0x00010000 /* has valid public integer value */
190#define SVf_NOK 0x00020000 /* has valid public numeric value */
191#define SVf_POK 0x00040000 /* has valid public pointer value */
192#define SVf_ROK 0x00080000 /* has a valid reference pointer */
a0d0e21e 193
748a9306 194#define SVf_FAKE 0x00100000 /* glob or lexical is just a copy */
8990e307
LW
195#define SVf_OOK 0x00200000 /* has valid offset value */
196#define SVf_BREAK 0x00400000 /* refcnt is artificially low */
197#define SVf_READONLY 0x00800000 /* may not be modified */
198
a0d0e21e 199
8990e307
LW
200#define SVp_IOK 0x01000000 /* has valid non-public integer value */
201#define SVp_NOK 0x02000000 /* has valid non-public numeric value */
202#define SVp_POK 0x04000000 /* has valid non-public pointer value */
203#define SVp_SCREAM 0x08000000 /* has been studied? */
204
5bc28da9
NIS
205#define SVf_UTF8 0x20000000 /* SvPVX is UTF-8 encoded */
206
207#define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE|SVf_UTF8)
208
a0d0e21e
LW
209#define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
210 SVp_IOK|SVp_NOK|SVp_POK)
211
9e7bc3e8 212#define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
a0d0e21e 213
8990e307
LW
214#define PRIVSHIFT 8
215
216/* Some private flags. */
217
f472eb5c 218/* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
032d6771
GS
219#define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
220
25da4f38
IZ
221#define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
222
223#define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
8990e307
LW
224
225#define SVpbm_VALID 0x80000000
bbce6d69 226#define SVpbm_TAIL 0x40000000
8990e307 227
25da4f38
IZ
228#define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
229
bf6bd887 230#define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */
51594c39 231#define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
bf6bd887 232
810b8aa5
GS
233#define SVprv_WEAKREF 0x80000000 /* Weak reference */
234
ed6116ce
LW
235struct xrv {
236 SV * xrv_rv; /* pointer to another SV */
237};
238
79072805 239struct xpv {
ed6116ce
LW
240 char * xpv_pv; /* pointer to malloced string */
241 STRLEN xpv_cur; /* length of xpv_pv as a C string */
242 STRLEN xpv_len; /* allocated size */
79072805
LW
243};
244
245struct xpviv {
ed6116ce
LW
246 char * xpv_pv; /* pointer to malloced string */
247 STRLEN xpv_cur; /* length of xpv_pv as a C string */
248 STRLEN xpv_len; /* allocated size */
a0d0e21e 249 IV xiv_iv; /* integer value or pv offset */
79072805
LW
250};
251
ff68c719
PP
252struct xpvuv {
253 char * xpv_pv; /* pointer to malloced string */
254 STRLEN xpv_cur; /* length of xpv_pv as a C string */
255 STRLEN xpv_len; /* allocated size */
256 UV xuv_uv; /* unsigned value or pv offset */
257};
258
79072805 259struct xpvnv {
ed6116ce
LW
260 char * xpv_pv; /* pointer to malloced string */
261 STRLEN xpv_cur; /* length of xpv_pv as a C string */
262 STRLEN xpv_len; /* allocated size */
a0d0e21e 263 IV xiv_iv; /* integer value or pv offset */
65202027 264 NV xnv_nv; /* numeric value, if any */
79072805
LW
265};
266
6ee623d5 267/* These structure must match the beginning of struct xpvhv in hv.h. */
79072805 268struct xpvmg {
ed6116ce
LW
269 char * xpv_pv; /* pointer to malloced string */
270 STRLEN xpv_cur; /* length of xpv_pv as a C string */
271 STRLEN xpv_len; /* allocated size */
a0d0e21e 272 IV xiv_iv; /* integer value or pv offset */
65202027 273 NV xnv_nv; /* numeric value, if any */
79072805
LW
274 MAGIC* xmg_magic; /* linked list of magicalness */
275 HV* xmg_stash; /* class package */
276};
277
278struct xpvlv {
ed6116ce
LW
279 char * xpv_pv; /* pointer to malloced string */
280 STRLEN xpv_cur; /* length of xpv_pv as a C string */
281 STRLEN xpv_len; /* allocated size */
a0d0e21e 282 IV xiv_iv; /* integer value or pv offset */
65202027 283 NV xnv_nv; /* numeric value, if any */
79072805
LW
284 MAGIC* xmg_magic; /* linked list of magicalness */
285 HV* xmg_stash; /* class package */
8990e307 286
79072805
LW
287 STRLEN xlv_targoff;
288 STRLEN xlv_targlen;
289 SV* xlv_targ;
290 char xlv_type;
291};
292
293struct xpvgv {
ed6116ce
LW
294 char * xpv_pv; /* pointer to malloced string */
295 STRLEN xpv_cur; /* length of xpv_pv as a C string */
296 STRLEN xpv_len; /* allocated size */
a0d0e21e 297 IV xiv_iv; /* integer value or pv offset */
65202027 298 NV xnv_nv; /* numeric value, if any */
79072805
LW
299 MAGIC* xmg_magic; /* linked list of magicalness */
300 HV* xmg_stash; /* class package */
8990e307 301
79072805
LW
302 GP* xgv_gp;
303 char* xgv_name;
304 STRLEN xgv_namelen;
305 HV* xgv_stash;
a5f75d66 306 U8 xgv_flags;
79072805
LW
307};
308
309struct xpvbm {
ed6116ce
LW
310 char * xpv_pv; /* pointer to malloced string */
311 STRLEN xpv_cur; /* length of xpv_pv as a C string */
312 STRLEN xpv_len; /* allocated size */
a0d0e21e 313 IV xiv_iv; /* integer value or pv offset */
65202027 314 NV xnv_nv; /* numeric value, if any */
79072805
LW
315 MAGIC* xmg_magic; /* linked list of magicalness */
316 HV* xmg_stash; /* class package */
8990e307 317
79072805
LW
318 I32 xbm_useful; /* is this constant pattern being useful? */
319 U16 xbm_previous; /* how many characters in string before rare? */
320 U8 xbm_rare; /* rarest character in string */
321};
322
57843af0 323/* This structure much match XPVCV in cv.h */
44a8e56a 324
77a005ab
MB
325typedef U16 cv_flags_t;
326
79072805 327struct xpvfm {
ed6116ce
LW
328 char * xpv_pv; /* pointer to malloced string */
329 STRLEN xpv_cur; /* length of xpv_pv as a C string */
330 STRLEN xpv_len; /* allocated size */
a0d0e21e 331 IV xiv_iv; /* integer value or pv offset */
65202027 332 NV xnv_nv; /* numeric value, if any */
79072805
LW
333 MAGIC* xmg_magic; /* linked list of magicalness */
334 HV* xmg_stash; /* class package */
8990e307 335
79072805
LW
336 HV * xcv_stash;
337 OP * xcv_start;
338 OP * xcv_root;
0cb96387 339 void (*xcv_xsub)(pTHXo_ CV*);
a0d0e21e
LW
340 ANY xcv_xsubany;
341 GV * xcv_gv;
57843af0 342 char * xcv_file;
b195d487 343 long xcv_depth; /* >= 2 indicates recursive call */
79072805 344 AV * xcv_padlist;
748a9306 345 CV * xcv_outside;
e858de61 346#ifdef USE_THREADS
f6d98b14 347 perl_mutex *xcv_mutexp; /* protects xcv_owner */
52e1cb5e 348 struct perl_thread *xcv_owner; /* current owner thread */
e858de61 349#endif /* USE_THREADS */
77a005ab 350 cv_flags_t xcv_flags;
44a8e56a 351
79072805
LW
352 I32 xfm_lines;
353};
354
8990e307
LW
355struct xpvio {
356 char * xpv_pv; /* pointer to malloced string */
357 STRLEN xpv_cur; /* length of xpv_pv as a C string */
358 STRLEN xpv_len; /* allocated size */
a0d0e21e 359 IV xiv_iv; /* integer value or pv offset */
65202027 360 NV xnv_nv; /* numeric value, if any */
8990e307
LW
361 MAGIC* xmg_magic; /* linked list of magicalness */
362 HV* xmg_stash; /* class package */
363
760ac839
LW
364 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
365 PerlIO * xio_ofp; /* but sockets need separate streams */
4755096e
GS
366 /* Cray addresses everything by word boundaries (64 bits) and
367 * code and data pointers cannot be mixed (which is exactly what
368 * Perl_filter_add() tries to do with the dirp), hence the following
369 * union trick (as suggested by Gurusamy Sarathy).
370 * For further information see Geir Johansen's problem report titled
371 [ID 20000612.002] Perl problem on Cray system
372 * The any pointer (known as IoANY()) will also be a good place
373 * to hang any IO disciplines to.
374 */
375 union {
376 DIR * xiou_dirp; /* for opendir, readdir, etc */
377 void * xiou_any; /* for alignment */
378 } xio_dirpu;
8990e307
LW
379 long xio_lines; /* $. */
380 long xio_page; /* $% */
381 long xio_page_len; /* $= */
382 long xio_lines_left; /* $- */
383 char * xio_top_name; /* $^ */
384 GV * xio_top_gv; /* $^ */
385 char * xio_fmt_name; /* $~ */
386 GV * xio_fmt_gv; /* $~ */
387 char * xio_bottom_name;/* $^B */
388 GV * xio_bottom_gv; /* $^B */
389 short xio_subprocess; /* -| or |- */
390 char xio_type;
391 char xio_flags;
392};
4755096e
GS
393#define xio_dirp xio_dirpu.xiou_dirp
394#define xio_any xio_dirpu.xiou_any
8990e307 395
e0c19803
GS
396#define IOf_ARGV 1 /* this fp iterates over ARGV */
397#define IOf_START 2 /* check for null ARGV and substitute '-' */
398#define IOf_FLUSH 4 /* this fp wants a flush after write op */
399#define IOf_DIDTOP 8 /* just did top of form */
400#define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
401#define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
402#define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
8990e307 403
ed6116ce
LW
404/* The following macros define implementation-independent predicates on SVs. */
405
954c1994
GS
406/*
407=for apidoc Am|bool|SvNIOK|SV* sv
408Returns a boolean indicating whether the SV contains a number, integer or
409double.
410
411=for apidoc Am|bool|SvNIOKp|SV* sv
412Returns a boolean indicating whether the SV contains a number, integer or
413double. Checks the B<private> setting. Use C<SvNIOK>.
414
415=for apidoc Am|void|SvNIOK_off|SV* sv
416Unsets the NV/IV status of an SV.
417
418=for apidoc Am|bool|SvOK|SV* sv
419Returns a boolean indicating whether the value is an SV.
420
421=for apidoc Am|bool|SvIOKp|SV* sv
422Returns a boolean indicating whether the SV contains an integer. Checks
423the B<private> setting. Use C<SvIOK>.
424
425=for apidoc Am|bool|SvNOKp|SV* sv
426Returns a boolean indicating whether the SV contains a double. Checks the
427B<private> setting. Use C<SvNOK>.
428
429=for apidoc Am|bool|SvPOKp|SV* sv
430Returns a boolean indicating whether the SV contains a character string.
431Checks the B<private> setting. Use C<SvPOK>.
432
433=for apidoc Am|bool|SvIOK|SV* sv
434Returns a boolean indicating whether the SV contains an integer.
435
436=for apidoc Am|void|SvIOK_on|SV* sv
437Tells an SV that it is an integer.
438
439=for apidoc Am|void|SvIOK_off|SV* sv
440Unsets the IV status of an SV.
441
442=for apidoc Am|void|SvIOK_only|SV* sv
443Tells an SV that it is an integer and disables all other OK bits.
444
e331fc52
JH
445=for apidoc Am|void|SvIOK_only_UV|SV* sv
446Tells and SV that it is an unsigned integer and disables all other OK bits.
447
448=for apidoc Am|void|SvIOK_UV|SV* sv
449Returns a boolean indicating whether the SV contains an unsigned integer.
450
451=for apidoc Am|void|SvIOK_notUV|SV* sv
452Returns a boolean indicating whether the SV contains an signed integer.
453
954c1994
GS
454=for apidoc Am|bool|SvNOK|SV* sv
455Returns a boolean indicating whether the SV contains a double.
456
457=for apidoc Am|void|SvNOK_on|SV* sv
458Tells an SV that it is a double.
459
460=for apidoc Am|void|SvNOK_off|SV* sv
461Unsets the NV status of an SV.
462
463=for apidoc Am|void|SvNOK_only|SV* sv
464Tells an SV that it is a double and disables all other OK bits.
465
466=for apidoc Am|bool|SvPOK|SV* sv
467Returns a boolean indicating whether the SV contains a character
468string.
469
470=for apidoc Am|void|SvPOK_on|SV* sv
471Tells an SV that it is a string.
472
473=for apidoc Am|void|SvPOK_off|SV* sv
474Unsets the PV status of an SV.
475
476=for apidoc Am|void|SvPOK_only|SV* sv
477Tells an SV that it is a string and disables all other OK bits.
478
479=for apidoc Am|bool|SvOOK|SV* sv
480Returns a boolean indicating whether the SvIVX is a valid offset value for
481the SvPVX. This hack is used internally to speed up removal of characters
482from the beginning of a SvPV. When SvOOK is true, then the start of the
483allocated string buffer is really (SvPVX - SvIVX).
484
485=for apidoc Am|bool|SvROK|SV* sv
486Tests if the SV is an RV.
487
488=for apidoc Am|void|SvROK_on|SV* sv
489Tells an SV that it is an RV.
490
491=for apidoc Am|void|SvROK_off|SV* sv
492Unsets the RV status of an SV.
493
494=for apidoc Am|SV*|SvRV|SV* sv
495Dereferences an RV to return the SV.
496
497=for apidoc Am|IV|SvIVX|SV* sv
498Returns the integer which is stored in the SV, assuming SvIOK is
499true.
500
501=for apidoc Am|UV|SvUVX|SV* sv
502Returns the unsigned integer which is stored in the SV, assuming SvIOK is
503true.
504
505=for apidoc Am|NV|SvNVX|SV* sv
506Returns the double which is stored in the SV, assuming SvNOK is
507true.
508
509=for apidoc Am|char*|SvPVX|SV* sv
510Returns a pointer to the string in the SV. The SV must contain a
511string.
512
513=for apidoc Am|STRLEN|SvCUR|SV* sv
514Returns the length of the string which is in the SV. See C<SvLEN>.
515
516=for apidoc Am|STRLEN|SvLEN|SV* sv
659239a4
MG
517Returns the size of the string buffer in the SV, not including any part
518attributable to C<SvOOK>. See C<SvCUR>.
954c1994
GS
519
520=for apidoc Am|char*|SvEND|SV* sv
521Returns a pointer to the last character in the string which is in the SV.
522See C<SvCUR>. Access the character as *(SvEND(sv)).
523
524=for apidoc Am|HV*|SvSTASH|SV* sv
525Returns the stash of the SV.
526
527=for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
528Set the length of the string which is in the SV. See C<SvCUR>.
529
530=cut
531*/
532
79072805 533#define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
748a9306 534#define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
a0d0e21e 535#define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
25da4f38 536 SVp_IOK|SVp_NOK|SVf_IVisUV))
79072805 537
463ee0b2 538#define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
25da4f38 539#define SvOK_off(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
d41ff1b8 540 SVf_IVisUV|SVf_UTF8), \
25da4f38 541 SvOOK_off(sv))
d41ff1b8
GS
542#define SvOK_off_exc_UV(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
543 SVf_UTF8), \
a0d0e21e 544 SvOOK_off(sv))
79072805 545
8990e307
LW
546#define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
547#define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
155aba94 548#define SvIOKp_on(sv) ((void)SvOOK_off(sv), SvFLAGS(sv) |= SVp_IOK)
8990e307
LW
549#define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
550#define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
551#define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
552#define SvPOKp_on(sv) (SvFLAGS(sv) |= SVp_POK)
463ee0b2 553
79072805 554#define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
155aba94 555#define SvIOK_on(sv) ((void)SvOOK_off(sv), \
a0d0e21e 556 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38 557#define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
155aba94 558#define SvIOK_only(sv) ((void)SvOK_off(sv), \
a0d0e21e 559 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
155aba94 560#define SvIOK_only_UV(sv) ((void)SvOK_off_exc_UV(sv), \
25da4f38 561 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
70401c6b 562
25da4f38
IZ
563#define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
564 == (SVf_IOK|SVf_IVisUV))
565#define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
566 == SVf_IOK)
567
568#define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
569#define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
570#define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
79072805
LW
571
572#define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
a0d0e21e 573#define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
8990e307 574#define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
155aba94 575#define SvNOK_only(sv) ((void)SvOK_off(sv), \
a0d0e21e 576 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
79072805 577
a7cb1f99
GS
578#define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
579#define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
580#define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
5bc28da9 581
79072805 582#define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
a0d0e21e 583#define SvPOK_on(sv) (SvFLAGS(sv) |= (SVf_POK|SVp_POK))
8990e307 584#define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
d41ff1b8
GS
585#define SvPOK_only(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
586 SVf_IVisUV|SVf_UTF8), \
587 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
588#define SvPOK_only_UTF8(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
589 SVf_IVisUV), \
a0d0e21e 590 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
79072805
LW
591
592#define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
155aba94 593#define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
79072805 594#define SvOOK_off(sv) (SvOOK(sv) && sv_backoff(sv))
79072805 595
a0d0e21e
LW
596#define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
597#define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
598#define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
599
ed6116ce 600#define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
a0d0e21e 601#define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
a0d0e21e 602#define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
79072805 603
8990e307
LW
604#define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
605#define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
606#define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
79072805 607
8990e307
LW
608#define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
609#define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
610#define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
ed6116ce 611
8990e307
LW
612#define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
613#define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
614#define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
ed6116ce 615
8990e307
LW
616#define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
617#define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
618#define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
ed6116ce 619
9e7bc3e8
JD
620#define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
621#define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
622#define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
a0d0e21e 623
1426bbf4
MG
624#define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
625
a0d0e21e
LW
626/*
627#define Gv_AMG(stash) \
628 (HV_AMAGICmb(stash) && \
629 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
630*/
3280af22 631#define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
a0d0e21e 632
810b8aa5
GS
633#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
634 == (SVf_ROK|SVprv_WEAKREF))
635#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
636#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
637
a0d0e21e 638#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 639
8990e307 640#define SvPADBUSY(sv) (SvFLAGS(sv) & SVs_PADBUSY)
ed6116ce 641
8990e307
LW
642#define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
643#define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP|SVs_PADBUSY)
644#define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
ed6116ce 645
8990e307
LW
646#define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
647#define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY|SVs_PADBUSY)
ed6116ce 648
8990e307
LW
649#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
650#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
651#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 652
8990e307
LW
653#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
654#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
655#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 656
8990e307
LW
657#define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
658#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
659#define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
79072805 660
8990e307
LW
661#define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
662#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
663#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 664
8990e307
LW
665#define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
666#define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
667#define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
79072805 668
25da4f38
IZ
669#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
670#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
671#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
672
8990e307
LW
673#define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
674#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
675#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
676
8990e307
LW
677#define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
678#define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
679#define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
680
ed6116ce
LW
681#define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
682#define SvRVx(sv) SvRV(sv)
683
463ee0b2
LW
684#define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
685#define SvIVXx(sv) SvIVX(sv)
ff68c719
PP
686#define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
687#define SvUVXx(sv) SvUVX(sv)
463ee0b2
LW
688#define SvNVX(sv) ((XPVNV*)SvANY(sv))->xnv_nv
689#define SvNVXx(sv) SvNVX(sv)
690#define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
691#define SvPVXx(sv) SvPVX(sv)
79072805 692#define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
79072805
LW
693#define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
694#define SvLENx(sv) SvLEN(sv)
695#define SvEND(sv)(((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
6b88bc9c 696#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
79072805
LW
697#define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
698#define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
699
700#define SvIV_set(sv, val) \
80b92232
PP
701 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
702 (((XPVIV*) SvANY(sv))->xiv_iv = val); } STMT_END
79072805 703#define SvNV_set(sv, val) \
80b92232
PP
704 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
705 (((XPVNV*) SvANY(sv))->xnv_nv = val); } STMT_END
79072805 706#define SvPV_set(sv, val) \
80b92232
PP
707 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
708 (((XPV*) SvANY(sv))->xpv_pv = val); } STMT_END
79072805 709#define SvCUR_set(sv, val) \
80b92232
PP
710 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
711 (((XPV*) SvANY(sv))->xpv_cur = val); } STMT_END
79072805 712#define SvLEN_set(sv, val) \
80b92232
PP
713 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
714 (((XPV*) SvANY(sv))->xpv_len = val); } STMT_END
79072805 715#define SvEND_set(sv, val) \
80b92232
PP
716 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
717 (((XPV*) SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
79072805
LW
718
719#define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
720#define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
721#define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
722
723#define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
724
725#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
726#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
727#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
728#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
729
8990e307
LW
730#define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
731#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
732#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
4755096e 733#define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
8990e307
LW
734#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
735#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
736#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
737#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
738#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
739#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
740#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
741#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
742#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
743#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
744#define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
745#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
746#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
747
50952442
JH
748/* IoTYPE(sv) is a single character telling the type of I/O connection. */
749#define IoTYPE_RDONLY '<'
750#define IoTYPE_WRONLY '>'
751#define IoTYPE_RDWR '+'
752#define IoTYPE_APPEND 'a'
753#define IoTYPE_PIPE '|'
754#define IoTYPE_STD '-' /* stdin or stdout */
755#define IoTYPE_SOCKET 's'
756#define IoTYPE_CLOSED ' '
03fcf2fc
GS
757
758/*
954c1994
GS
759=for apidoc Am|bool|SvTAINTED|SV* sv
760Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
761not.
762
763=for apidoc Am|void|SvTAINTED_on|SV* sv
764Marks an SV as tainted.
765
766=for apidoc Am|void|SvTAINTED_off|SV* sv
767Untaints an SV. Be I<very> careful with this routine, as it short-circuits
768some of Perl's fundamental security features. XS module authors should not
769use this function unless they fully understand all the implications of
770unconditionally untainting the value. Untainting should be done in the
771standard perl fashion, via a carefully crafted regexp, rather than directly
772untainting variables.
773
774=for apidoc Am|void|SvTAINT|SV* sv
775Taints an SV if tainting is enabled
776
777=cut
778*/
779
bbce6d69 780#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22
NIS
781#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
782#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 783
c6ee37c5
MB
784#define SvTAINT(sv) \
785 STMT_START { \
3280af22 786 if (PL_tainting) { \
c6ee37c5 787 dTHR; \
3280af22 788 if (PL_tainted) \
c6ee37c5
MB
789 SvTAINTED_on(sv); \
790 } \
791 } STMT_END
79072805 792
954c1994
GS
793/*
794=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
795Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
796force if you are going to update the SvPVX directly.
797
798=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
799Returns a pointer to the string in the SV, or a stringified form of the SV
800if the SV does not contain a string. Handles 'get' magic.
801
802=for apidoc Am|char*|SvPV_nolen|SV* sv
803Returns a pointer to the string in the SV, or a stringified form of the SV
804if the SV does not contain a string. Handles 'get' magic.
805
806=for apidoc Am|IV|SvIV|SV* sv
807Coerces the given SV to an integer and returns it.
808
809=for apidoc Am|NV|SvNV|SV* sv
810Coerce the given SV to a double and return it.
811
812=for apidoc Am|UV|SvUV|SV* sv
813Coerces the given SV to an unsigned integer and returns it.
814
815=for apidoc Am|bool|SvTRUE|SV* sv
816Returns a boolean indicating whether Perl would evaluate the SV as true or
817false, defined or undefined. Does not handle 'get' magic.
818
819=cut
820*/
821
a0d0e21e 822#define SvPV_force(sv, lp) sv_pvn_force(sv, &lp)
463ee0b2 823#define SvPV(sv, lp) sv_pvn(sv, &lp)
1fa8b10d 824#define SvPV_nolen(sv) sv_pv(sv)
5bc28da9
NIS
825
826#define SvPVutf8_force(sv, lp) sv_pvutf8n_force(sv, &lp)
827#define SvPVutf8(sv, lp) sv_pvutf8n(sv, &lp)
828#define SvPVutf8_nolen(sv) sv_pvutf8(sv)
829
830#define SvPVbyte_force(sv, lp) sv_pvbyte_force(sv, &lp)
831#define SvPVbyte(sv, lp) sv_pvbyten(sv, &lp)
832#define SvPVbyte_nolen(sv) sv_pvbyte(sv)
833
834#define SvPVx(sv, lp) sv_pvn(sv, &lp)
835#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
836#define SvPVutf8x(sv, lp) sv_pvutf8n(sv, &lp)
837#define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
838#define SvPVbytex(sv, lp) sv_pvbyten(sv, &lp)
839#define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
840
4e35701f
NIS
841#define SvIVx(sv) sv_iv(sv)
842#define SvUVx(sv) sv_uv(sv)
843#define SvNVx(sv) sv_nv(sv)
5bc28da9 844
4e35701f
NIS
845#define SvTRUEx(sv) sv_true(sv)
846
847#define SvIV(sv) SvIVx(sv)
848#define SvNV(sv) SvNVx(sv)
25da4f38 849#define SvUV(sv) SvUVx(sv)
4e35701f 850#define SvTRUE(sv) SvTRUEx(sv)
79072805 851
a80f87c4
GS
852#ifndef CRIPPLED_CC
853/* redefine some things to more efficient inlined versions */
79072805 854
25da4f38 855/* Let us hope that bitmaps for UV and IV are the same */
ff68c719 856#undef SvIV
463ee0b2 857#define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
79072805 858
ff68c719
PP
859#undef SvUV
860#define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
861
862#undef SvNV
463ee0b2 863#define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 864
ff68c719
PP
865#undef SvPV
866#define SvPV(sv, lp) \
5bc28da9
NIS
867 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
868 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv(sv, &lp))
70401c6b 869
79072805 870
ff68c719
PP
871#undef SvPV_force
872#define SvPV_force(sv, lp) \
873 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
874 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force(sv, &lp))
a0d0e21e 875
1fa8b10d
JD
876#undef SvPV_nolen
877#define SvPV_nolen(sv) \
5bc28da9
NIS
878 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
879 ? SvPVX(sv) : sv_2pv_nolen(sv))
70401c6b 880
5bc28da9
NIS
881#undef SvPVutf8
882#define SvPVutf8(sv, lp) \
883 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
884 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 885
5bc28da9
NIS
886#undef SvPVutf8_force
887#define SvPVutf8_force(sv, lp) \
70401c6b 888 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
5bc28da9
NIS
889 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
890
891#undef SvPVutf8_nolen
892#define SvPVutf8_nolen(sv) \
70401c6b 893 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
5bc28da9 894 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
70401c6b 895
5bc28da9
NIS
896#undef SvPVutf8
897#define SvPVutf8(sv, lp) \
898 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
899 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 900
5bc28da9
NIS
901#undef SvPVutf8_force
902#define SvPVutf8_force(sv, lp) \
70401c6b 903 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
5bc28da9
NIS
904 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
905
906#undef SvPVutf8_nolen
907#define SvPVutf8_nolen(sv) \
908 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
909 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
70401c6b 910
5bc28da9
NIS
911#undef SvPVbyte
912#define SvPVbyte(sv, lp) \
913 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
914 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
70401c6b 915
5bc28da9
NIS
916#undef SvPVbyte_force
917#define SvPVbyte_force(sv, lp) \
918 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
919 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyte_force(sv, &lp))
920
921#undef SvPVbyte_nolen
922#define SvPVbyte_nolen(sv) \
923 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
924 ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
70401c6b 925
1fa8b10d 926
a80f87c4
GS
927#ifdef __GNUC__
928# undef SvIVx
929# undef SvUVx
930# undef SvNVx
931# undef SvPVx
5bc28da9
NIS
932# undef SvPVutf8x
933# undef SvPVbytex
a80f87c4
GS
934# undef SvTRUE
935# undef SvTRUEx
936# define SvIVx(sv) ({SV *nsv = (SV*)(sv); SvIV(nsv); })
937# define SvUVx(sv) ({SV *nsv = (SV*)(sv); SvUV(nsv); })
938# define SvNVx(sv) ({SV *nsv = (SV*)(sv); SvNV(nsv); })
939# define SvPVx(sv, lp) ({SV *nsv = (sv); SvPV(nsv, lp); })
5bc28da9
NIS
940# define SvPVutf8x(sv, lp) ({SV *nsv = (sv); SvPVutf8(nsv, lp); })
941# define SvPVbytex(sv, lp) ({SV *nsv = (sv); SvPVbyte(nsv, lp); })
a80f87c4 942# define SvTRUE(sv) ( \
8990e307
LW
943 !sv \
944 ? 0 \
945 : SvPOK(sv) \
a80f87c4
GS
946 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
947 nxpv && \
c2f1de04 948 (nxpv->xpv_cur > 1 || \
a80f87c4 949 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
79072805
LW
950 ? 1 \
951 : 0) \
952 : \
953 SvIOK(sv) \
463ee0b2 954 ? SvIVX(sv) != 0 \
79072805 955 : SvNOK(sv) \
463ee0b2
LW
956 ? SvNVX(sv) != 0.0 \
957 : sv_2bool(sv) )
a80f87c4
GS
958# define SvTRUEx(sv) ({SV *nsv = (sv); SvTRUE(nsv); })
959#else /* __GNUC__ */
960#ifndef USE_THREADS
961/* These inlined macros use globals, which will require a thread
962 * declaration in user code, so we avoid them under threads */
963
964# undef SvIVx
965# undef SvUVx
966# undef SvNVx
967# undef SvPVx
5bc28da9
NIS
968# undef SvPVutf8x
969# undef SvPVbytex
a80f87c4
GS
970# undef SvTRUE
971# undef SvTRUEx
6b88bc9c
GS
972# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
973# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
974# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
975# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
5bc28da9 976# define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
f83ee824 977# define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
a80f87c4
GS
978# define SvTRUE(sv) ( \
979 !sv \
980 ? 0 \
981 : SvPOK(sv) \
6b88bc9c 982 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
c2f1de04 983 (PL_Xpv->xpv_cur > 1 || \
6b88bc9c 984 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
a80f87c4
GS
985 ? 1 \
986 : 0) \
987 : \
988 SvIOK(sv) \
989 ? SvIVX(sv) != 0 \
990 : SvNOK(sv) \
991 ? SvNVX(sv) != 0.0 \
992 : sv_2bool(sv) )
6b88bc9c 993# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
a80f87c4
GS
994#endif /* !USE_THREADS */
995#endif /* !__GNU__ */
996#endif /* !CRIPPLED_CC */
79072805 997
954c1994
GS
998/*
999=for apidoc Am|SV*|newRV_inc|SV* sv
1000
1001Creates an RV wrapper for an SV. The reference count for the original SV is
1002incremented.
1003
1004=cut
1005*/
1006
5f05dabc 1007#define newRV_inc(sv) newRV(sv)
5f05dabc 1008
ef50df4b 1009/* the following macros update any magic values this sv is associated with */
79072805 1010
954c1994
GS
1011/*
1012=for apidoc Am|void|SvGETMAGIC|SV* sv
1013Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1014argument more than once.
1015
1016=for apidoc Am|void|SvSETMAGIC|SV* sv
1017Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1018argument more than once.
1019
1020=for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1021Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1022more than once.
1023
1024=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1025Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1026ssv. May evaluate arguments more than once.
1027
1028=for apidoc Am|void|SvGROW|SV* sv|STRLEN len
1029Expands the character buffer in the SV so that it has room for the
1030indicated number of bytes (remember to reserve space for an extra trailing
1031NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1032Returns a pointer to the character buffer.
1033
1034=cut
1035*/
1036
189b2af5
GS
1037#define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1038#define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
79072805 1039
54310121 1040#define SvSetSV_and(dst,src,finally) \
189b2af5 1041 STMT_START { \
54310121
PP
1042 if ((dst) != (src)) { \
1043 sv_setsv(dst, src); \
1044 finally; \
189b2af5
GS
1045 } \
1046 } STMT_END
54310121 1047#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 1048 STMT_START { \
8ebc5c01
PP
1049 if ((dst) != (src)) { \
1050 U32 tMpF = SvFLAGS(src) & SVs_TEMP; \
1051 SvTEMP_off(src); \
1052 sv_setsv(dst, src); \
1053 SvFLAGS(src) |= tMpF; \
54310121 1054 finally; \
189b2af5
GS
1055 } \
1056 } STMT_END
79072805 1057
54310121 1058#define SvSetSV(dst,src) \
c9d716f7 1059 SvSetSV_and(dst,src,/*nothing*/;)
54310121 1060#define SvSetSV_nosteal(dst,src) \
c9d716f7 1061 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121
PP
1062
1063#define SvSetMagicSV(dst,src) \
1064 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1065#define SvSetMagicSV_nosteal(dst,src) \
1066 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1067
3967c732 1068#ifdef DEBUGGING
79072805 1069#define SvPEEK(sv) sv_peek(sv)
3967c732
JD
1070#else
1071#define SvPEEK(sv) ""
1072#endif
79072805 1073
3280af22 1074#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no)
36477c24 1075
3280af22 1076#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 1077
79072805
LW
1078#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1079
933fea7f
GS
1080#define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1081#define Sv_Grow sv_grow
3d35f11b 1082