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