This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
2785f1459572670efdf5f33126cd1a723ad483a2
[perl5.git] / sv.h
1 /*    sv.h
2  *
3  *    Copyright (c) 1991-2001, 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|SvUOK|SV* sv
452 Returns a boolean indicating whether the SV contains an unsigned integer.
453
454 =for apidoc Am|void|SvIOK_notUV|SV* sv
455 Returns a boolean indicating whether the SV contains an signed integer.
456
457 =for apidoc Am|bool|SvNOK|SV* sv
458 Returns a boolean indicating whether the SV contains a double.
459
460 =for apidoc Am|void|SvNOK_on|SV* sv
461 Tells an SV that it is a double.
462
463 =for apidoc Am|void|SvNOK_off|SV* sv
464 Unsets the NV status of an SV.
465
466 =for apidoc Am|void|SvNOK_only|SV* sv
467 Tells an SV that it is a double and disables all other OK bits.
468
469 =for apidoc Am|bool|SvPOK|SV* sv
470 Returns a boolean indicating whether the SV contains a character
471 string.
472
473 =for apidoc Am|void|SvPOK_on|SV* sv
474 Tells an SV that it is a string.
475
476 =for apidoc Am|void|SvPOK_off|SV* sv
477 Unsets the PV status of an SV.
478
479 =for apidoc Am|void|SvPOK_only|SV* sv
480 Tells an SV that it is a string and disables all other OK bits.
481
482 =for apidoc Am|bool|SvOOK|SV* sv
483 Returns a boolean indicating whether the SvIVX is a valid offset value for
484 the SvPVX.  This hack is used internally to speed up removal of characters
485 from the beginning of a SvPV.  When SvOOK is true, then the start of the
486 allocated string buffer is really (SvPVX - SvIVX).
487
488 =for apidoc Am|bool|SvROK|SV* sv
489 Tests if the SV is an RV.
490
491 =for apidoc Am|void|SvROK_on|SV* sv
492 Tells an SV that it is an RV.
493
494 =for apidoc Am|void|SvROK_off|SV* sv
495 Unsets the RV status of an SV.
496
497 =for apidoc Am|SV*|SvRV|SV* sv
498 Dereferences an RV to return the SV.
499
500 =for apidoc Am|IV|SvIVX|SV* sv
501 Returns the integer which is stored in the SV, assuming SvIOK is
502 true.
503
504 =for apidoc Am|UV|SvUVX|SV* sv
505 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
506 true.
507
508 =for apidoc Am|NV|SvNVX|SV* sv
509 Returns the double which is stored in the SV, assuming SvNOK is
510 true.
511
512 =for apidoc Am|char*|SvPVX|SV* sv
513 Returns a pointer to the string in the SV.  The SV must contain a
514 string.
515
516 =for apidoc Am|STRLEN|SvCUR|SV* sv
517 Returns the length of the string which is in the SV.  See C<SvLEN>.
518
519 =for apidoc Am|STRLEN|SvLEN|SV* sv
520 Returns the size of the string buffer in the SV, not including any part
521 attributable to C<SvOOK>.  See C<SvCUR>.
522
523 =for apidoc Am|char*|SvEND|SV* sv
524 Returns a pointer to the last character in the string which is in the SV.
525 See C<SvCUR>.  Access the character as *(SvEND(sv)).
526
527 =for apidoc Am|HV*|SvSTASH|SV* sv
528 Returns the stash of the SV.
529
530 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
531 Set the length of the string which is in the SV.  See C<SvCUR>.
532
533 =cut
534 */
535
536 #define SvNIOK(sv)              (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
537 #define SvNIOKp(sv)             (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
538 #define SvNIOK_off(sv)          (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
539                                                   SVp_IOK|SVp_NOK|SVf_IVisUV))
540
541 #define SvOK(sv)                (SvFLAGS(sv) & SVf_OK)
542 #define SvOK_off(sv)            (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
543                                                   SVf_IVisUV|SVf_UTF8), \
544                                                         SvOOK_off(sv))
545 #define SvOK_off_exc_UV(sv)     (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
546                                                   SVf_UTF8),            \
547                                                         SvOOK_off(sv))
548
549 #define SvOKp(sv)               (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
550 #define SvIOKp(sv)              (SvFLAGS(sv) & SVp_IOK)
551 #define SvIOKp_on(sv)           ((void)SvOOK_off(sv), SvFLAGS(sv) |= SVp_IOK)
552 #define SvNOKp(sv)              (SvFLAGS(sv) & SVp_NOK)
553 #define SvNOKp_on(sv)           (SvFLAGS(sv) |= SVp_NOK)
554 #define SvPOKp(sv)              (SvFLAGS(sv) & SVp_POK)
555 #define SvPOKp_on(sv)           (SvFLAGS(sv) |= SVp_POK)
556
557 #define SvIOK(sv)               (SvFLAGS(sv) & SVf_IOK)
558 #define SvIOK_on(sv)            ((void)SvOOK_off(sv), \
559                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
560 #define SvIOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
561 #define SvIOK_only(sv)          ((void)SvOK_off(sv), \
562                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
563 #define SvIOK_only_UV(sv)       ((void)SvOK_off_exc_UV(sv), \
564                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
565
566 #define SvIOK_UV(sv)            ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
567                                  == (SVf_IOK|SVf_IVisUV))
568 #define SvUOK(sv)               SvIOK_UV(sv)
569 #define SvIOK_notUV(sv)         ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
570                                  == SVf_IOK)
571
572 #define SvIsUV(sv)              (SvFLAGS(sv) & SVf_IVisUV)
573 #define SvIsUV_on(sv)           (SvFLAGS(sv) |= SVf_IVisUV)
574 #define SvIsUV_off(sv)          (SvFLAGS(sv) &= ~SVf_IVisUV)
575
576 #define SvNOK(sv)               (SvFLAGS(sv) & SVf_NOK)
577 #define SvNOK_on(sv)            (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
578 #define SvNOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
579 #define SvNOK_only(sv)          ((void)SvOK_off(sv), \
580                                     SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
581
582 /*
583 =for apidoc Am|void|SvUTF8|SV* sv
584 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
585
586 =for apidoc Am|void|SvUTF8_on|SV *sv
587 Tells an SV that it is a string and encoded in UTF8.  Do not use frivolously.
588
589 =for apidoc Am|void|SvUTF8_off|SV *sv
590 Unsets the UTF8 status of an SV.
591
592 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
593 Tells an SV that it is a UTF8 string (do not use frivolously)
594 and disables all other OK bits.
595   
596 =cut
597  */
598
599 #define SvUTF8(sv)              (SvFLAGS(sv) & SVf_UTF8)
600 #define SvUTF8_on(sv)           (SvFLAGS(sv) |= (SVf_UTF8))
601 #define SvUTF8_off(sv)          (SvFLAGS(sv) &= ~(SVf_UTF8))
602
603 #define SvPOK(sv)               (SvFLAGS(sv) & SVf_POK)
604 #define SvPOK_on(sv)            (SvFLAGS(sv) |= (SVf_POK|SVp_POK))
605 #define SvPOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
606 #define SvPOK_only(sv)          (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
607                                                   SVf_IVisUV|SVf_UTF8), \
608                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
609 #define SvPOK_only_UTF8(sv)     (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
610                                                   SVf_IVisUV),          \
611                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
612
613 #define SvOOK(sv)               (SvFLAGS(sv) & SVf_OOK)
614 #define SvOOK_on(sv)            ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
615 #define SvOOK_off(sv)           (SvOOK(sv) && sv_backoff(sv))
616
617 #define SvFAKE(sv)              (SvFLAGS(sv) & SVf_FAKE)
618 #define SvFAKE_on(sv)           (SvFLAGS(sv) |= SVf_FAKE)
619 #define SvFAKE_off(sv)          (SvFLAGS(sv) &= ~SVf_FAKE)
620
621 #define SvROK(sv)               (SvFLAGS(sv) & SVf_ROK)
622 #define SvROK_on(sv)            (SvFLAGS(sv) |= SVf_ROK)
623 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
624
625 #define SvMAGICAL(sv)           (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
626 #define SvMAGICAL_on(sv)        (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
627 #define SvMAGICAL_off(sv)       (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
628
629 #define SvGMAGICAL(sv)          (SvFLAGS(sv) & SVs_GMG)
630 #define SvGMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_GMG)
631 #define SvGMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_GMG)
632
633 #define SvSMAGICAL(sv)          (SvFLAGS(sv) & SVs_SMG)
634 #define SvSMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_SMG)
635 #define SvSMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_SMG)
636
637 #define SvRMAGICAL(sv)          (SvFLAGS(sv) & SVs_RMG)
638 #define SvRMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_RMG)
639 #define SvRMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_RMG)
640
641 #define SvAMAGIC(sv)            (SvFLAGS(sv) & SVf_AMAGIC)
642 #define SvAMAGIC_on(sv)         (SvFLAGS(sv) |= SVf_AMAGIC)
643 #define SvAMAGIC_off(sv)        (SvFLAGS(sv) &= ~SVf_AMAGIC)
644
645 #define SvGAMAGIC(sv)           (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC)) 
646
647 /*
648 #define Gv_AMG(stash) \
649         (HV_AMAGICmb(stash) && \
650          ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
651 */
652 #define Gv_AMG(stash)           (PL_amagic_generation && Gv_AMupdate(stash))
653
654 #define SvWEAKREF(sv)           ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
655                                   == (SVf_ROK|SVprv_WEAKREF))
656 #define SvWEAKREF_on(sv)        (SvFLAGS(sv) |=  (SVf_ROK|SVprv_WEAKREF))
657 #define SvWEAKREF_off(sv)       (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
658
659 #define SvTHINKFIRST(sv)        (SvFLAGS(sv) & SVf_THINKFIRST)
660
661 #define SvPADBUSY(sv)           (SvFLAGS(sv) & SVs_PADBUSY)
662
663 #define SvPADTMP(sv)            (SvFLAGS(sv) & SVs_PADTMP)
664 #define SvPADTMP_on(sv)         (SvFLAGS(sv) |= SVs_PADTMP|SVs_PADBUSY)
665 #define SvPADTMP_off(sv)        (SvFLAGS(sv) &= ~SVs_PADTMP)
666
667 #define SvPADMY(sv)             (SvFLAGS(sv) & SVs_PADMY)
668 #define SvPADMY_on(sv)          (SvFLAGS(sv) |= SVs_PADMY|SVs_PADBUSY)
669
670 #define SvTEMP(sv)              (SvFLAGS(sv) & SVs_TEMP)
671 #define SvTEMP_on(sv)           (SvFLAGS(sv) |= SVs_TEMP)
672 #define SvTEMP_off(sv)          (SvFLAGS(sv) &= ~SVs_TEMP)
673
674 #define SvOBJECT(sv)            (SvFLAGS(sv) & SVs_OBJECT)
675 #define SvOBJECT_on(sv)         (SvFLAGS(sv) |= SVs_OBJECT)
676 #define SvOBJECT_off(sv)        (SvFLAGS(sv) &= ~SVs_OBJECT)
677
678 #define SvREADONLY(sv)          (SvFLAGS(sv) & SVf_READONLY)
679 #define SvREADONLY_on(sv)       (SvFLAGS(sv) |= SVf_READONLY)
680 #define SvREADONLY_off(sv)      (SvFLAGS(sv) &= ~SVf_READONLY)
681
682 #define SvSCREAM(sv)            (SvFLAGS(sv) & SVp_SCREAM)
683 #define SvSCREAM_on(sv)         (SvFLAGS(sv) |= SVp_SCREAM)
684 #define SvSCREAM_off(sv)        (SvFLAGS(sv) &= ~SVp_SCREAM)
685
686 #define SvCOMPILED(sv)          (SvFLAGS(sv) & SVpfm_COMPILED)
687 #define SvCOMPILED_on(sv)       (SvFLAGS(sv) |= SVpfm_COMPILED)
688 #define SvCOMPILED_off(sv)      (SvFLAGS(sv) &= ~SVpfm_COMPILED)
689
690 #define SvEVALED(sv)            (SvFLAGS(sv) & SVrepl_EVAL)
691 #define SvEVALED_on(sv)         (SvFLAGS(sv) |= SVrepl_EVAL)
692 #define SvEVALED_off(sv)        (SvFLAGS(sv) &= ~SVrepl_EVAL)
693
694 #define SvTAIL(sv)              (SvFLAGS(sv) & SVpbm_TAIL)
695 #define SvTAIL_on(sv)           (SvFLAGS(sv) |= SVpbm_TAIL)
696 #define SvTAIL_off(sv)          (SvFLAGS(sv) &= ~SVpbm_TAIL)
697
698 #define SvVALID(sv)             (SvFLAGS(sv) & SVpbm_VALID)
699 #define SvVALID_on(sv)          (SvFLAGS(sv) |= SVpbm_VALID)
700 #define SvVALID_off(sv)         (SvFLAGS(sv) &= ~SVpbm_VALID)
701
702 #define SvRV(sv) ((XRV*)  SvANY(sv))->xrv_rv
703 #define SvRVx(sv) SvRV(sv)
704
705 #define SvIVX(sv) ((XPVIV*)  SvANY(sv))->xiv_iv
706 #define SvIVXx(sv) SvIVX(sv)
707 #define SvUVX(sv) ((XPVUV*)  SvANY(sv))->xuv_uv
708 #define SvUVXx(sv) SvUVX(sv)
709 #define SvNVX(sv)  ((XPVNV*)SvANY(sv))->xnv_nv
710 #define SvNVXx(sv) SvNVX(sv)
711 #define SvPVX(sv)  ((XPV*)  SvANY(sv))->xpv_pv
712 #define SvPVXx(sv) SvPVX(sv)
713 #define SvCUR(sv) ((XPV*)  SvANY(sv))->xpv_cur
714 #define SvLEN(sv) ((XPV*)  SvANY(sv))->xpv_len
715 #define SvLENx(sv) SvLEN(sv)
716 #define SvEND(sv)(((XPV*)  SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
717 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
718 #define SvMAGIC(sv)     ((XPVMG*)  SvANY(sv))->xmg_magic
719 #define SvSTASH(sv)     ((XPVMG*)  SvANY(sv))->xmg_stash
720
721 /* Ask a scalar nicely to try to become an IV, if possible.
722    Not guaranteed to stay returning void */
723 /* Macro won't actually call sv_2iv if already IOK */
724 #define SvIV_please(sv) \
725         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
726                 (void) SvIV(sv); } STMT_END
727 #define SvIV_set(sv, val) \
728         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
729                 (((XPVIV*)  SvANY(sv))->xiv_iv = val); } STMT_END
730 #define SvNV_set(sv, val) \
731         STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
732                 (((XPVNV*)  SvANY(sv))->xnv_nv = val); } STMT_END
733 #define SvPV_set(sv, val) \
734         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
735                 (((XPV*)  SvANY(sv))->xpv_pv = val); } STMT_END
736 #define SvCUR_set(sv, val) \
737         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
738                 (((XPV*)  SvANY(sv))->xpv_cur = val); } STMT_END
739 #define SvLEN_set(sv, val) \
740         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
741                 (((XPV*)  SvANY(sv))->xpv_len = val); } STMT_END
742 #define SvEND_set(sv, val) \
743         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
744                 (((XPV*)  SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
745
746 #define BmRARE(sv)      ((XPVBM*)  SvANY(sv))->xbm_rare
747 #define BmUSEFUL(sv)    ((XPVBM*)  SvANY(sv))->xbm_useful
748 #define BmPREVIOUS(sv)  ((XPVBM*)  SvANY(sv))->xbm_previous
749
750 #define FmLINES(sv)     ((XPVFM*)  SvANY(sv))->xfm_lines
751
752 #define LvTYPE(sv)      ((XPVLV*)  SvANY(sv))->xlv_type
753 #define LvTARG(sv)      ((XPVLV*)  SvANY(sv))->xlv_targ
754 #define LvTARGOFF(sv)   ((XPVLV*)  SvANY(sv))->xlv_targoff
755 #define LvTARGLEN(sv)   ((XPVLV*)  SvANY(sv))->xlv_targlen
756
757 #define IoIFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ifp
758 #define IoOFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ofp
759 #define IoDIRP(sv)      ((XPVIO*)  SvANY(sv))->xio_dirp
760 #define IoANY(sv)       ((XPVIO*)  SvANY(sv))->xio_any
761 #define IoLINES(sv)     ((XPVIO*)  SvANY(sv))->xio_lines
762 #define IoPAGE(sv)      ((XPVIO*)  SvANY(sv))->xio_page
763 #define IoPAGE_LEN(sv)  ((XPVIO*)  SvANY(sv))->xio_page_len
764 #define IoLINES_LEFT(sv)((XPVIO*)  SvANY(sv))->xio_lines_left
765 #define IoTOP_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_top_name
766 #define IoTOP_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_top_gv
767 #define IoFMT_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_fmt_name
768 #define IoFMT_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_fmt_gv
769 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
770 #define IoBOTTOM_GV(sv) ((XPVIO*)  SvANY(sv))->xio_bottom_gv
771 #define IoSUBPROCESS(sv)((XPVIO*)  SvANY(sv))->xio_subprocess
772 #define IoTYPE(sv)      ((XPVIO*)  SvANY(sv))->xio_type
773 #define IoFLAGS(sv)     ((XPVIO*)  SvANY(sv))->xio_flags
774
775 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
776 #define IoTYPE_RDONLY   '<'
777 #define IoTYPE_WRONLY   '>'
778 #define IoTYPE_RDWR     '+'
779 #define IoTYPE_APPEND   'a'
780 #define IoTYPE_PIPE     '|'
781 #define IoTYPE_STD      '-'     /* stdin or stdout */
782 #define IoTYPE_SOCKET   's'
783 #define IoTYPE_CLOSED   ' '
784
785 /*
786 =for apidoc Am|bool|SvTAINTED|SV* sv
787 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
788 not.
789
790 =for apidoc Am|void|SvTAINTED_on|SV* sv
791 Marks an SV as tainted.
792
793 =for apidoc Am|void|SvTAINTED_off|SV* sv
794 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
795 some of Perl's fundamental security features. XS module authors should not
796 use this function unless they fully understand all the implications of
797 unconditionally untainting the value. Untainting should be done in the
798 standard perl fashion, via a carefully crafted regexp, rather than directly
799 untainting variables.
800
801 =for apidoc Am|void|SvTAINT|SV* sv
802 Taints an SV if tainting is enabled
803
804 =cut
805 */
806
807 #define SvTAINTED(sv)     (SvMAGICAL(sv) && sv_tainted(sv))
808 #define SvTAINTED_on(sv)  STMT_START{ if(PL_tainting){sv_taint(sv);}   }STMT_END
809 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
810
811 #define SvTAINT(sv)                     \
812     STMT_START {                        \
813         if (PL_tainting) {              \
814             if (PL_tainted)             \
815                 SvTAINTED_on(sv);       \
816         }                               \
817     } STMT_END
818
819 /*
820 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
821 Like <SvPV> but will force the SV into becoming a string (SvPOK).  You want
822 force if you are going to update the SvPVX directly.
823
824 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
825 Returns a pointer to the string in the SV, or a stringified form of the SV
826 if the SV does not contain a string.  Handles 'get' magic.
827
828 =for apidoc Am|char*|SvPV_nolen|SV* sv
829 Returns a pointer to the string in the SV, or a stringified form of the SV
830 if the SV does not contain a string.  Handles 'get' magic.
831
832 =for apidoc Am|IV|SvIV|SV* sv
833 Coerces the given SV to an integer and returns it.
834
835 =for apidoc Am|NV|SvNV|SV* sv
836 Coerce the given SV to a double and return it.
837
838 =for apidoc Am|UV|SvUV|SV* sv
839 Coerces the given SV to an unsigned integer and returns it.
840
841 =for apidoc Am|bool|SvTRUE|SV* sv
842 Returns a boolean indicating whether Perl would evaluate the SV as true or
843 false, defined or undefined.  Does not handle 'get' magic.
844
845 =cut
846 */
847
848 #define SvPV_force(sv, lp) sv_pvn_force(sv, &lp)
849 #define SvPV(sv, lp) sv_pvn(sv, &lp)
850 #define SvPV_nolen(sv) sv_pv(sv)
851
852 #define SvPVutf8_force(sv, lp) sv_pvutf8n_force(sv, &lp)
853 #define SvPVutf8(sv, lp) sv_pvutf8n(sv, &lp)
854 #define SvPVutf8_nolen(sv) sv_pvutf8(sv)
855
856 #define SvPVbyte_force(sv, lp) sv_pvbyte_force(sv, &lp)
857 #define SvPVbyte(sv, lp) sv_pvbyten(sv, &lp)
858 #define SvPVbyte_nolen(sv) sv_pvbyte(sv)
859
860 #define SvPVx(sv, lp) sv_pvn(sv, &lp)
861 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
862 #define SvPVutf8x(sv, lp) sv_pvutf8n(sv, &lp)
863 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
864 #define SvPVbytex(sv, lp) sv_pvbyten(sv, &lp)
865 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
866
867 #define SvIVx(sv) sv_iv(sv)
868 #define SvUVx(sv) sv_uv(sv)
869 #define SvNVx(sv) sv_nv(sv)
870
871 #define SvTRUEx(sv) sv_true(sv)
872
873 #define SvIV(sv) SvIVx(sv)
874 #define SvNV(sv) SvNVx(sv)
875 #define SvUV(sv) SvUVx(sv)
876 #define SvTRUE(sv) SvTRUEx(sv)
877
878 #ifndef CRIPPLED_CC
879 /* redefine some things to more efficient inlined versions */
880
881 /* Let us hope that bitmaps for UV and IV are the same */
882 #undef SvIV
883 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
884
885 #undef SvUV
886 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
887
888 #undef SvNV
889 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
890
891 #undef SvPV
892 #define SvPV(sv, lp) \
893     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
894      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv(sv, &lp))
895
896
897 #undef SvPV_force
898 #define SvPV_force(sv, lp) \
899     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
900      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force(sv, &lp))
901
902 #undef SvPV_nolen
903 #define SvPV_nolen(sv) \
904     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
905      ? SvPVX(sv) : sv_2pv_nolen(sv))
906
907 #undef SvPVutf8
908 #define SvPVutf8(sv, lp) \
909     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
910      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
911
912 #undef SvPVutf8_force
913 #define SvPVutf8_force(sv, lp) \
914     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
915      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
916
917 #undef SvPVutf8_nolen
918 #define SvPVutf8_nolen(sv) \
919     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
920      ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
921
922 #undef SvPVutf8
923 #define SvPVutf8(sv, lp) \
924     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
925      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
926
927 #undef SvPVutf8_force
928 #define SvPVutf8_force(sv, lp) \
929     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
930      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
931
932 #undef SvPVutf8_nolen
933 #define SvPVutf8_nolen(sv) \
934     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
935      ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
936
937 #undef SvPVbyte
938 #define SvPVbyte(sv, lp) \
939     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
940      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
941
942 #undef SvPVbyte_force
943 #define SvPVbyte_force(sv, lp) \
944     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
945      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyte_force(sv, &lp))
946
947 #undef SvPVbyte_nolen
948 #define SvPVbyte_nolen(sv) \
949     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
950      ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
951
952
953 #ifdef __GNUC__
954 #  undef SvIVx
955 #  undef SvUVx
956 #  undef SvNVx
957 #  undef SvPVx
958 #  undef SvPVutf8x
959 #  undef SvPVbytex
960 #  undef SvTRUE
961 #  undef SvTRUEx
962 #  define SvIVx(sv) ({SV *nsv = (SV*)(sv); SvIV(nsv); })
963 #  define SvUVx(sv) ({SV *nsv = (SV*)(sv); SvUV(nsv); })
964 #  define SvNVx(sv) ({SV *nsv = (SV*)(sv); SvNV(nsv); })
965 #  define SvPVx(sv, lp) ({SV *nsv = (sv); SvPV(nsv, lp); })
966 #  define SvPVutf8x(sv, lp) ({SV *nsv = (sv); SvPVutf8(nsv, lp); })
967 #  define SvPVbytex(sv, lp) ({SV *nsv = (sv); SvPVbyte(nsv, lp); })
968 #  define SvTRUE(sv) (                                          \
969     !sv                                                         \
970     ? 0                                                         \
971     :    SvPOK(sv)                                              \
972         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
973              nxpv &&                                            \
974              (nxpv->xpv_cur > 1 ||                              \
975               (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); })      \
976              ? 1                                                \
977              : 0)                                               \
978         :                                                       \
979             SvIOK(sv)                                           \
980             ? SvIVX(sv) != 0                                    \
981             :   SvNOK(sv)                                       \
982                 ? SvNVX(sv) != 0.0                              \
983                 : sv_2bool(sv) )
984 #  define SvTRUEx(sv) ({SV *nsv = (sv); SvTRUE(nsv); })
985 #else /* __GNUC__ */
986 #ifndef USE_THREADS
987 /* These inlined macros use globals, which will require a thread
988  * declaration in user code, so we avoid them under threads */
989
990 #  undef SvIVx
991 #  undef SvUVx
992 #  undef SvNVx
993 #  undef SvPVx
994 #  undef SvPVutf8x
995 #  undef SvPVbytex
996 #  undef SvTRUE
997 #  undef SvTRUEx
998 #  define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
999 #  define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1000 #  define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1001 #  define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1002 #  define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1003 #  define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1004 #  define SvTRUE(sv) (                                          \
1005     !sv                                                         \
1006     ? 0                                                         \
1007     :    SvPOK(sv)                                              \
1008         ?   ((PL_Xpv = (XPV*)SvANY(sv)) &&                      \
1009              (PL_Xpv->xpv_cur > 1 ||                            \
1010               (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0'))      \
1011              ? 1                                                \
1012              : 0)                                               \
1013         :                                                       \
1014             SvIOK(sv)                                           \
1015             ? SvIVX(sv) != 0                                    \
1016             :   SvNOK(sv)                                       \
1017                 ? SvNVX(sv) != 0.0                              \
1018                 : sv_2bool(sv) )
1019 #  define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1020 #endif /* !USE_THREADS */
1021 #endif /* !__GNU__ */
1022 #endif /* !CRIPPLED_CC */
1023
1024 /*
1025 =for apidoc Am|SV*|newRV_inc|SV* sv
1026
1027 Creates an RV wrapper for an SV.  The reference count for the original SV is
1028 incremented.
1029
1030 =cut
1031 */
1032
1033 #define newRV_inc(sv)   newRV(sv)
1034
1035 /* the following macros update any magic values this sv is associated with */
1036
1037 /*
1038 =for apidoc Am|void|SvGETMAGIC|SV* sv
1039 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
1040 argument more than once.
1041
1042 =for apidoc Am|void|SvSETMAGIC|SV* sv
1043 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
1044 argument more than once.
1045
1046 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1047 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
1048 more than once.
1049
1050 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1051 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1052 ssv. May evaluate arguments more than once.
1053
1054 =for apidoc Am|void|SvGROW|SV* sv|STRLEN len
1055 Expands the character buffer in the SV so that it has room for the
1056 indicated number of bytes (remember to reserve space for an extra trailing
1057 NUL character).  Calls C<sv_grow> to perform the expansion if necessary. 
1058 Returns a pointer to the character buffer.
1059
1060 =cut
1061 */
1062
1063 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1064 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1065
1066 #define SvSetSV_and(dst,src,finally) \
1067         STMT_START {                                    \
1068             if ((dst) != (src)) {                       \
1069                 sv_setsv(dst, src);                     \
1070                 finally;                                \
1071             }                                           \
1072         } STMT_END
1073 #define SvSetSV_nosteal_and(dst,src,finally) \
1074         STMT_START {                                    \
1075             if ((dst) != (src)) {                       \
1076                 U32 tMpF = SvFLAGS(src) & SVs_TEMP;     \
1077                 SvTEMP_off(src);                        \
1078                 sv_setsv(dst, src);                     \
1079                 SvFLAGS(src) |= tMpF;                   \
1080                 finally;                                \
1081             }                                           \
1082         } STMT_END
1083
1084 #define SvSetSV(dst,src) \
1085                 SvSetSV_and(dst,src,/*nothing*/;)
1086 #define SvSetSV_nosteal(dst,src) \
1087                 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1088
1089 #define SvSetMagicSV(dst,src) \
1090                 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1091 #define SvSetMagicSV_nosteal(dst,src) \
1092                 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1093
1094 #ifdef DEBUGGING
1095 #define SvPEEK(sv) sv_peek(sv)
1096 #else
1097 #define SvPEEK(sv) ""
1098 #endif
1099
1100 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no)
1101
1102 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1103
1104 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1105
1106 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1107 #define Sv_Grow sv_grow
1108
1109 #define SV_IMMEDIATE_UNREF      1
1110
1111 #define CLONEf_COPY_STACKS 1
1112 #define CLONEf_KEEP_PTR_TABLE 2
1113