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