projects / p5sagit/p5-mst-13.2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | history | HEAD
Add =head1 NAMEs so that buildtoc is happy.
[p5sagit/p5-mst-13.2.git] / sv.h
CommitLineData
a0d0e21e 1/* sv.h
79072805 2 *
3818b22b 3 * Copyright (c) 1991-2000, Larry Wall
79072805 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 8 */
9
a0d0e21e 10#ifdef sv_flags
11#undef sv_flags /* Convex has this in <signal.h> for sigvec() */
12#endif
13
954c1994 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 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 60} svtype;
61
79072805 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 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 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 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 86};
87
88struct hv {
463ee0b2 89 XPVHV* sv_any; /* pointer to something */
79072805 90 U32 sv_refcnt; /* how many references to us */
8990e307 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 98};
99
954c1994 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 124#ifdef USE_THREADS
125
b37a7757 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 146#else
147# define ATOMIC_INC(count) (++count)
83b0a010 148# define ATOMIC_DEC_AND_TEST(res, count) (res = (--count == 0))
dce16143 149#endif /* USE_THREADS */
150
a863c7d1 151#ifdef __GNUC__
dce16143 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)
b37a7757 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 171#endif
172
a863c7d1 173#define SvREFCNT_dec(sv) sv_free((SV*)sv)
174
8990e307 175#define SVTYPEMASK 0xff
176#define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
79072805 177
178#define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
179
8990e307 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 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 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 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 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 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 219#define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
220
25da4f38 221#define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
222
223#define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
8990e307 224
225#define SVpbm_VALID 0x80000000
bbce6d69 226#define SVpbm_TAIL 0x40000000
8990e307 227
25da4f38 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 233#define SVprv_WEAKREF 0x80000000 /* Weak reference */
234
ed6116ce 235struct xrv {
236 SV * xrv_rv; /* pointer to another SV */
237};
238
79072805 239struct xpv {
ed6116ce 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 243};
244
245struct xpviv {
ed6116ce 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 250};
251
ff68c719 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 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 265};
266
6ee623d5 267/* These structure must match the beginning of struct xpvhv in hv.h. */
79072805 268struct xpvmg {
ed6116ce 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 274 MAGIC* xmg_magic; /* linked list of magicalness */
275 HV* xmg_stash; /* class package */
276};
277
278struct xpvlv {
ed6116ce 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 284 MAGIC* xmg_magic; /* linked list of magicalness */
285 HV* xmg_stash; /* class package */
8990e307 286
79072805 287 STRLEN xlv_targoff;
288 STRLEN xlv_targlen;
289 SV* xlv_targ;
290 char xlv_type;
291};
292
293struct xpvgv {
ed6116ce 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 299 MAGIC* xmg_magic; /* linked list of magicalness */
300 HV* xmg_stash; /* class package */
8990e307 301
79072805 302 GP* xgv_gp;
303 char* xgv_name;
304 STRLEN xgv_namelen;
305 HV* xgv_stash;
a5f75d66 306 U8 xgv_flags;
79072805 307};
308
309struct xpvbm {
ed6116ce 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 315 MAGIC* xmg_magic; /* linked list of magicalness */
316 HV* xmg_stash; /* class package */
8990e307 317
79072805 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 325typedef U16 cv_flags_t;
326
79072805 327struct xpvfm {
ed6116ce 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 333 MAGIC* xmg_magic; /* linked list of magicalness */
334 HV* xmg_stash; /* class package */
8990e307 335
79072805 336 HV * xcv_stash;
337 OP * xcv_start;
338 OP * xcv_root;
0cb96387 339 void (*xcv_xsub)(pTHXo_ CV*);
a0d0e21e 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 352 I32 xfm_lines;
353};
354
8990e307 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 361 MAGIC* xmg_magic; /* linked list of magicalness */
362 HV* xmg_stash; /* class package */
363
760ac839 364 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
365 PerlIO * xio_ofp; /* but sockets need separate streams */
69b7060a 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), 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 */
373 union {
374 DIR * xiou_dirp; /* for opendir, readdir, etc */
375 void * xiou_dummy; /* for alignment */
376 } xio_dirpu;
8990e307 377 long xio_lines; /* $. */
378 long xio_page; /* $% */
379 long xio_page_len; /* $= */
380 long xio_lines_left; /* $- */
381 char * xio_top_name; /* $^ */
382 GV * xio_top_gv; /* $^ */
383 char * xio_fmt_name; /* $~ */
384 GV * xio_fmt_gv; /* $~ */
385 char * xio_bottom_name;/* $^B */
386 GV * xio_bottom_gv; /* $^B */
387 short xio_subprocess; /* -| or |- */
388 char xio_type;
389 char xio_flags;
390};
69b7060a 391#define xio_dirp xio_dirpu.xiou_dirp
8990e307 392
e0c19803 393#define IOf_ARGV 1 /* this fp iterates over ARGV */
394#define IOf_START 2 /* check for null ARGV and substitute '-' */
395#define IOf_FLUSH 4 /* this fp wants a flush after write op */
396#define IOf_DIDTOP 8 /* just did top of form */
397#define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
398#define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
399#define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
8990e307 400
ed6116ce 401/* The following macros define implementation-independent predicates on SVs. */
402
954c1994 403/*
404=for apidoc Am|bool|SvNIOK|SV* sv
405Returns a boolean indicating whether the SV contains a number, integer or
406double.
407
408=for apidoc Am|bool|SvNIOKp|SV* sv
409Returns a boolean indicating whether the SV contains a number, integer or
410double. Checks the B<private> setting. Use C<SvNIOK>.
411
412=for apidoc Am|void|SvNIOK_off|SV* sv
413Unsets the NV/IV status of an SV.
414
415=for apidoc Am|bool|SvOK|SV* sv
416Returns a boolean indicating whether the value is an SV.
417
418=for apidoc Am|bool|SvIOKp|SV* sv
419Returns a boolean indicating whether the SV contains an integer. Checks
420the B<private> setting. Use C<SvIOK>.
421
422=for apidoc Am|bool|SvNOKp|SV* sv
423Returns a boolean indicating whether the SV contains a double. Checks the
424B<private> setting. Use C<SvNOK>.
425
426=for apidoc Am|bool|SvPOKp|SV* sv
427Returns a boolean indicating whether the SV contains a character string.
428Checks the B<private> setting. Use C<SvPOK>.
429
430=for apidoc Am|bool|SvIOK|SV* sv
431Returns a boolean indicating whether the SV contains an integer.
432
433=for apidoc Am|void|SvIOK_on|SV* sv
434Tells an SV that it is an integer.
435
436=for apidoc Am|void|SvIOK_off|SV* sv
437Unsets the IV status of an SV.
438
439=for apidoc Am|void|SvIOK_only|SV* sv
440Tells an SV that it is an integer and disables all other OK bits.
441
442=for apidoc Am|bool|SvNOK|SV* sv
443Returns a boolean indicating whether the SV contains a double.
444
445=for apidoc Am|void|SvNOK_on|SV* sv
446Tells an SV that it is a double.
447
448=for apidoc Am|void|SvNOK_off|SV* sv
449Unsets the NV status of an SV.
450
451=for apidoc Am|void|SvNOK_only|SV* sv
452Tells an SV that it is a double and disables all other OK bits.
453
454=for apidoc Am|bool|SvPOK|SV* sv
455Returns a boolean indicating whether the SV contains a character
456string.
457
458=for apidoc Am|void|SvPOK_on|SV* sv
459Tells an SV that it is a string.
460
461=for apidoc Am|void|SvPOK_off|SV* sv
462Unsets the PV status of an SV.
463
464=for apidoc Am|void|SvPOK_only|SV* sv
465Tells an SV that it is a string and disables all other OK bits.
466
467=for apidoc Am|bool|SvOOK|SV* sv
468Returns a boolean indicating whether the SvIVX is a valid offset value for
469the SvPVX. This hack is used internally to speed up removal of characters
470from the beginning of a SvPV. When SvOOK is true, then the start of the
471allocated string buffer is really (SvPVX - SvIVX).
472
473=for apidoc Am|bool|SvROK|SV* sv
474Tests if the SV is an RV.
475
476=for apidoc Am|void|SvROK_on|SV* sv
477Tells an SV that it is an RV.
478
479=for apidoc Am|void|SvROK_off|SV* sv
480Unsets the RV status of an SV.
481
482=for apidoc Am|SV*|SvRV|SV* sv
483Dereferences an RV to return the SV.
484
485=for apidoc Am|IV|SvIVX|SV* sv
486Returns the integer which is stored in the SV, assuming SvIOK is
487true.
488
489=for apidoc Am|UV|SvUVX|SV* sv
490Returns the unsigned integer which is stored in the SV, assuming SvIOK is
491true.
492
493=for apidoc Am|NV|SvNVX|SV* sv
494Returns the double which is stored in the SV, assuming SvNOK is
495true.
496
497=for apidoc Am|char*|SvPVX|SV* sv
498Returns a pointer to the string in the SV. The SV must contain a
499string.
500
501=for apidoc Am|STRLEN|SvCUR|SV* sv
502Returns the length of the string which is in the SV. See C<SvLEN>.
503
504=for apidoc Am|STRLEN|SvLEN|SV* sv
505Returns the size of the string buffer in the SV. See C<SvCUR>.
506
507=for apidoc Am|char*|SvEND|SV* sv
508Returns a pointer to the last character in the string which is in the SV.
509See C<SvCUR>. Access the character as *(SvEND(sv)).
510
511=for apidoc Am|HV*|SvSTASH|SV* sv
512Returns the stash of the SV.
513
514=for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
515Set the length of the string which is in the SV. See C<SvCUR>.
516
517=cut
518*/
519
79072805 520#define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
748a9306 521#define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
a0d0e21e 522#define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
25da4f38 523 SVp_IOK|SVp_NOK|SVf_IVisUV))
79072805 524
463ee0b2 525#define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
25da4f38 526#define SvOK_off(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
d41ff1b8 527 SVf_IVisUV|SVf_UTF8), \
25da4f38 528 SvOOK_off(sv))
d41ff1b8 529#define SvOK_off_exc_UV(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
530 SVf_UTF8), \
a0d0e21e 531 SvOOK_off(sv))
79072805 532
8990e307 533#define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
534#define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
155aba94 535#define SvIOKp_on(sv) ((void)SvOOK_off(sv), SvFLAGS(sv) |= SVp_IOK)
8990e307 536#define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
537#define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
538#define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
539#define SvPOKp_on(sv) (SvFLAGS(sv) |= SVp_POK)
463ee0b2 540
79072805 541#define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
155aba94 542#define SvIOK_on(sv) ((void)SvOOK_off(sv), \
a0d0e21e 543 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38 544#define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
155aba94 545#define SvIOK_only(sv) ((void)SvOK_off(sv), \
a0d0e21e 546 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
155aba94 547#define SvIOK_only_UV(sv) ((void)SvOK_off_exc_UV(sv), \
25da4f38 548 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
70401c6b 549
25da4f38 550#define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
551 == (SVf_IOK|SVf_IVisUV))
552#define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
553 == SVf_IOK)
554
555#define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
556#define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
557#define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
79072805 558
559#define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
a0d0e21e 560#define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
8990e307 561#define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
155aba94 562#define SvNOK_only(sv) ((void)SvOK_off(sv), \
a0d0e21e 563 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
79072805 564
a7cb1f99 565#define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
566#define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
567#define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
5bc28da9 568
79072805 569#define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
a0d0e21e 570#define SvPOK_on(sv) (SvFLAGS(sv) |= (SVf_POK|SVp_POK))
8990e307 571#define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
d41ff1b8 572#define SvPOK_only(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
573 SVf_IVisUV|SVf_UTF8), \
574 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
575#define SvPOK_only_UTF8(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
576 SVf_IVisUV), \
a0d0e21e 577 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
79072805 578
579#define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
155aba94 580#define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
79072805 581#define SvOOK_off(sv) (SvOOK(sv) && sv_backoff(sv))
79072805 582
a0d0e21e 583#define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
584#define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
585#define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
586
ed6116ce 587#define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
a0d0e21e 588#define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
a0d0e21e 589#define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
79072805 590
8990e307 591#define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
592#define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
593#define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
79072805 594
8990e307 595#define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
596#define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
597#define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
ed6116ce 598
8990e307 599#define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
600#define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
601#define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
ed6116ce 602
8990e307 603#define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
604#define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
605#define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
ed6116ce 606
9e7bc3e8 607#define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
608#define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
609#define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
a0d0e21e 610
611/*
612#define Gv_AMG(stash) \
613 (HV_AMAGICmb(stash) && \
614 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
615*/
3280af22 616#define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
a0d0e21e 617
810b8aa5 618#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
619 == (SVf_ROK|SVprv_WEAKREF))
620#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
621#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
622
a0d0e21e 623#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 624
8990e307 625#define SvPADBUSY(sv) (SvFLAGS(sv) & SVs_PADBUSY)
ed6116ce 626
8990e307 627#define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
628#define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP|SVs_PADBUSY)
629#define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
ed6116ce 630
8990e307 631#define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
632#define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY|SVs_PADBUSY)
ed6116ce 633
8990e307 634#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
635#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
636#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 637
8990e307 638#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
639#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
640#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 641
8990e307 642#define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
643#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
644#define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
79072805 645
8990e307 646#define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
647#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
648#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 649
8990e307 650#define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
651#define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
652#define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
79072805 653
25da4f38 654#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
655#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
656#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
657
8990e307 658#define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
659#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
660#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
661
8990e307 662#define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
663#define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
664#define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
665
ed6116ce 666#define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
667#define SvRVx(sv) SvRV(sv)
668
463ee0b2 669#define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
670#define SvIVXx(sv) SvIVX(sv)
ff68c719 671#define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
672#define SvUVXx(sv) SvUVX(sv)
463ee0b2 673#define SvNVX(sv) ((XPVNV*)SvANY(sv))->xnv_nv
674#define SvNVXx(sv) SvNVX(sv)
675#define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
676#define SvPVXx(sv) SvPVX(sv)
79072805 677#define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
79072805 678#define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
679#define SvLENx(sv) SvLEN(sv)
680#define SvEND(sv)(((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
6b88bc9c 681#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
79072805 682#define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
683#define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
684
685#define SvIV_set(sv, val) \
80b92232 686 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
687 (((XPVIV*) SvANY(sv))->xiv_iv = val); } STMT_END
79072805 688#define SvNV_set(sv, val) \
80b92232 689 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
690 (((XPVNV*) SvANY(sv))->xnv_nv = val); } STMT_END
79072805 691#define SvPV_set(sv, val) \
80b92232 692 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
693 (((XPV*) SvANY(sv))->xpv_pv = val); } STMT_END
79072805 694#define SvCUR_set(sv, val) \
80b92232 695 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
696 (((XPV*) SvANY(sv))->xpv_cur = val); } STMT_END
79072805 697#define SvLEN_set(sv, val) \
80b92232 698 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
699 (((XPV*) SvANY(sv))->xpv_len = val); } STMT_END
79072805 700#define SvEND_set(sv, val) \
80b92232 701 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
702 (((XPV*) SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
79072805 703
704#define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
705#define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
706#define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
707
708#define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
709
710#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
711#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
712#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
713#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
714
8990e307 715#define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
716#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
717#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
718#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
719#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
720#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
721#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
722#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
723#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
724#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
725#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
726#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
727#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
728#define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
729#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
730#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
731
954c1994 732/*
92d29cee 733IoTYPE(sv) is a single character saying what type of I/O connection
734this is:
735 | pipe
736 - stdin or stdout
737 < read-only
738 > write-only
739 a append
740 + read and write
741 s socket
742 space closed
743*/
744
745/*
954c1994 746=for apidoc Am|bool|SvTAINTED|SV* sv
747Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
748not.
749
750=for apidoc Am|void|SvTAINTED_on|SV* sv
751Marks an SV as tainted.
752
753=for apidoc Am|void|SvTAINTED_off|SV* sv
754Untaints an SV. Be I<very> careful with this routine, as it short-circuits
755some of Perl's fundamental security features. XS module authors should not
756use this function unless they fully understand all the implications of
757unconditionally untainting the value. Untainting should be done in the
758standard perl fashion, via a carefully crafted regexp, rather than directly
759untainting variables.
760
761=for apidoc Am|void|SvTAINT|SV* sv
762Taints an SV if tainting is enabled
763
764=cut
765*/
766
bbce6d69 767#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22 768#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
769#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 770
c6ee37c5 771#define SvTAINT(sv) \
772 STMT_START { \
3280af22 773 if (PL_tainting) { \
c6ee37c5 774 dTHR; \
3280af22 775 if (PL_tainted) \
c6ee37c5 776 SvTAINTED_on(sv); \
777 } \
778 } STMT_END
79072805 779
954c1994 780/*
781=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
782Like <SvPV> but will force the SV into becoming a string (SvPOK). You want
783force if you are going to update the SvPVX directly.
784
785=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
786Returns a pointer to the string in the SV, or a stringified form of the SV
787if the SV does not contain a string. Handles 'get' magic.
788
789=for apidoc Am|char*|SvPV_nolen|SV* sv
790Returns a pointer to the string in the SV, or a stringified form of the SV
791if the SV does not contain a string. Handles 'get' magic.
792
793=for apidoc Am|IV|SvIV|SV* sv
794Coerces the given SV to an integer and returns it.
795
796=for apidoc Am|NV|SvNV|SV* sv
797Coerce the given SV to a double and return it.
798
799=for apidoc Am|UV|SvUV|SV* sv
800Coerces the given SV to an unsigned integer and returns it.
801
802=for apidoc Am|bool|SvTRUE|SV* sv
803Returns a boolean indicating whether Perl would evaluate the SV as true or
804false, defined or undefined. Does not handle 'get' magic.
805
806=cut
807*/
808
a0d0e21e 809#define SvPV_force(sv, lp) sv_pvn_force(sv, &lp)
463ee0b2 810#define SvPV(sv, lp) sv_pvn(sv, &lp)
1fa8b10d 811#define SvPV_nolen(sv) sv_pv(sv)
5bc28da9 812
813#define SvPVutf8_force(sv, lp) sv_pvutf8n_force(sv, &lp)
814#define SvPVutf8(sv, lp) sv_pvutf8n(sv, &lp)
815#define SvPVutf8_nolen(sv) sv_pvutf8(sv)
816
817#define SvPVbyte_force(sv, lp) sv_pvbyte_force(sv, &lp)
818#define SvPVbyte(sv, lp) sv_pvbyten(sv, &lp)
819#define SvPVbyte_nolen(sv) sv_pvbyte(sv)
820
821#define SvPVx(sv, lp) sv_pvn(sv, &lp)
822#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
823#define SvPVutf8x(sv, lp) sv_pvutf8n(sv, &lp)
824#define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
825#define SvPVbytex(sv, lp) sv_pvbyten(sv, &lp)
826#define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
827
4e35701f 828#define SvIVx(sv) sv_iv(sv)
829#define SvUVx(sv) sv_uv(sv)
830#define SvNVx(sv) sv_nv(sv)
5bc28da9 831
4e35701f 832#define SvTRUEx(sv) sv_true(sv)
833
834#define SvIV(sv) SvIVx(sv)
835#define SvNV(sv) SvNVx(sv)
25da4f38 836#define SvUV(sv) SvUVx(sv)
4e35701f 837#define SvTRUE(sv) SvTRUEx(sv)
79072805 838
a80f87c4 839#ifndef CRIPPLED_CC
840/* redefine some things to more efficient inlined versions */
79072805 841
25da4f38 842/* Let us hope that bitmaps for UV and IV are the same */
ff68c719 843#undef SvIV
463ee0b2 844#define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
79072805 845
ff68c719 846#undef SvUV
847#define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
848
849#undef SvNV
463ee0b2 850#define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 851
ff68c719 852#undef SvPV
853#define SvPV(sv, lp) \
5bc28da9 854 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
855 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv(sv, &lp))
70401c6b 856
79072805 857
ff68c719 858#undef SvPV_force
859#define SvPV_force(sv, lp) \
860 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
861 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force(sv, &lp))
a0d0e21e 862
1fa8b10d 863#undef SvPV_nolen
864#define SvPV_nolen(sv) \
5bc28da9 865 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
866 ? SvPVX(sv) : sv_2pv_nolen(sv))
70401c6b 867
5bc28da9 868#undef SvPVutf8
869#define SvPVutf8(sv, lp) \
870 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
871 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 872
5bc28da9 873#undef SvPVutf8_force
874#define SvPVutf8_force(sv, lp) \
70401c6b 875 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
5bc28da9 876 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
877
878#undef SvPVutf8_nolen
879#define SvPVutf8_nolen(sv) \
70401c6b 880 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
5bc28da9 881 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
70401c6b 882
5bc28da9 883#undef SvPVutf8
884#define SvPVutf8(sv, lp) \
885 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
886 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 887
5bc28da9 888#undef SvPVutf8_force
889#define SvPVutf8_force(sv, lp) \
70401c6b 890 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
5bc28da9 891 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
892
893#undef SvPVutf8_nolen
894#define SvPVutf8_nolen(sv) \
895 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
896 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
70401c6b 897
5bc28da9 898#undef SvPVbyte
899#define SvPVbyte(sv, lp) \
900 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
901 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
70401c6b 902
5bc28da9 903#undef SvPVbyte_force
904#define SvPVbyte_force(sv, lp) \
905 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
906 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyte_force(sv, &lp))
907
908#undef SvPVbyte_nolen
909#define SvPVbyte_nolen(sv) \
910 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
911 ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
70401c6b 912
1fa8b10d 913
a80f87c4 914#ifdef __GNUC__
915# undef SvIVx
916# undef SvUVx
917# undef SvNVx
918# undef SvPVx
5bc28da9 919# undef SvPVutf8x
920# undef SvPVbytex
a80f87c4 921# undef SvTRUE
922# undef SvTRUEx
923# define SvIVx(sv) ({SV *nsv = (SV*)(sv); SvIV(nsv); })
924# define SvUVx(sv) ({SV *nsv = (SV*)(sv); SvUV(nsv); })
925# define SvNVx(sv) ({SV *nsv = (SV*)(sv); SvNV(nsv); })
926# define SvPVx(sv, lp) ({SV *nsv = (sv); SvPV(nsv, lp); })
5bc28da9 927# define SvPVutf8x(sv, lp) ({SV *nsv = (sv); SvPVutf8(nsv, lp); })
928# define SvPVbytex(sv, lp) ({SV *nsv = (sv); SvPVbyte(nsv, lp); })
a80f87c4 929# define SvTRUE(sv) ( \
8990e307 930 !sv \
931 ? 0 \
932 : SvPOK(sv) \
a80f87c4 933 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
934 nxpv && \
c2f1de04 935 (nxpv->xpv_cur > 1 || \
a80f87c4 936 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
79072805 937 ? 1 \
938 : 0) \
939 : \
940 SvIOK(sv) \
463ee0b2 941 ? SvIVX(sv) != 0 \
79072805 942 : SvNOK(sv) \
463ee0b2 943 ? SvNVX(sv) != 0.0 \
944 : sv_2bool(sv) )
a80f87c4 945# define SvTRUEx(sv) ({SV *nsv = (sv); SvTRUE(nsv); })
946#else /* __GNUC__ */
947#ifndef USE_THREADS
948/* These inlined macros use globals, which will require a thread
949 * declaration in user code, so we avoid them under threads */
950
951# undef SvIVx
952# undef SvUVx
953# undef SvNVx
954# undef SvPVx
5bc28da9 955# undef SvPVutf8x
956# undef SvPVbytex
a80f87c4 957# undef SvTRUE
958# undef SvTRUEx
6b88bc9c 959# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
960# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
961# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
962# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
5bc28da9 963# define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
f83ee824 964# define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
a80f87c4 965# define SvTRUE(sv) ( \
966 !sv \
967 ? 0 \
968 : SvPOK(sv) \
6b88bc9c 969 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
c2f1de04 970 (PL_Xpv->xpv_cur > 1 || \
6b88bc9c 971 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
a80f87c4 972 ? 1 \
973 : 0) \
974 : \
975 SvIOK(sv) \
976 ? SvIVX(sv) != 0 \
977 : SvNOK(sv) \
978 ? SvNVX(sv) != 0.0 \
979 : sv_2bool(sv) )
6b88bc9c 980# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
a80f87c4 981#endif /* !USE_THREADS */
982#endif /* !__GNU__ */
983#endif /* !CRIPPLED_CC */
79072805 984
954c1994 985/*
986=for apidoc Am|SV*|newRV_inc|SV* sv
987
988Creates an RV wrapper for an SV. The reference count for the original SV is
989incremented.
990
991=cut
992*/
993
5f05dabc 994#define newRV_inc(sv) newRV(sv)
5f05dabc 995
ef50df4b 996/* the following macros update any magic values this sv is associated with */
79072805 997
954c1994 998/*
999=for apidoc Am|void|SvGETMAGIC|SV* sv
1000Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1001argument more than once.
1002
1003=for apidoc Am|void|SvSETMAGIC|SV* sv
1004Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1005argument more than once.
1006
1007=for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1008Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1009more than once.
1010
1011=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1012Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1013ssv. May evaluate arguments more than once.
1014
1015=for apidoc Am|void|SvGROW|SV* sv|STRLEN len
1016Expands the character buffer in the SV so that it has room for the
1017indicated number of bytes (remember to reserve space for an extra trailing
1018NUL character). Calls C<sv_grow> to perform the expansion if necessary.
1019Returns a pointer to the character buffer.
1020
b37a7757 1021=for apidoc Am|void|SvLOCK|SV* sv
1022Aquires an internal mutex for a SV. Used to make sure multiple threads
1023don't stomp on the guts of an SV at the same time
1024
1025=for apidoc Am|void|SvUNLOCK|SV* sv
1026Release the internal mutex for an SV.
1027
954c1994 1028=cut
1029*/
1030
189b2af5 1031#define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1032#define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
79072805 1033
54310121 1034#define SvSetSV_and(dst,src,finally) \
189b2af5 1035 STMT_START { \
54310121 1036 if ((dst) != (src)) { \
1037 sv_setsv(dst, src); \
1038 finally; \
189b2af5 1039 } \
1040 } STMT_END
54310121 1041#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 1042 STMT_START { \
8ebc5c01 1043 if ((dst) != (src)) { \
1044 U32 tMpF = SvFLAGS(src) & SVs_TEMP; \
1045 SvTEMP_off(src); \
1046 sv_setsv(dst, src); \
1047 SvFLAGS(src) |= tMpF; \
54310121 1048 finally; \
189b2af5 1049 } \
1050 } STMT_END
79072805 1051
54310121 1052#define SvSetSV(dst,src) \
c9d716f7 1053 SvSetSV_and(dst,src,/*nothing*/;)
54310121 1054#define SvSetSV_nosteal(dst,src) \
c9d716f7 1055 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121 1056
1057#define SvSetMagicSV(dst,src) \
1058 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1059#define SvSetMagicSV_nosteal(dst,src) \
1060 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1061
3967c732 1062#ifdef DEBUGGING
b37a7757 1063
1064#define SvLOCK(sv) MUTEX_LOCK(&PL_sv_lock_mutex)
1065#define SvUNLOCK(sv) MUTEX_UNLOCK(&PL_sv_lock_mutex)
79072805 1066#define SvPEEK(sv) sv_peek(sv)
3967c732 1067#else
1068#define SvPEEK(sv) ""
1069#endif
79072805 1070
3280af22 1071#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no)
36477c24 1072
3280af22 1073#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 1074
79072805 1075#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1076
933fea7f 1077#define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1078#define Sv_Grow sv_grow
6c85703c 1079
Unnamed repository; edit this file to name it for gitweb.