This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
assert that you aren't assigning to the NVX of an AV or HV
[perl5.git] / sv.h
1 /*    sv.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2004, 2005 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 #ifdef sv_flags
12 #undef sv_flags         /* Convex has this in <signal.h> for sigvec() */
13 #endif
14
15 /*
16 =head1 SV Flags
17
18 =for apidoc AmU||svtype
19 An enum of flags for Perl types.  These are found in the file B<sv.h>
20 in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
21
22 =for apidoc AmU||SVt_PV
23 Pointer type flag for scalars.  See C<svtype>.
24
25 =for apidoc AmU||SVt_IV
26 Integer type flag for scalars.  See C<svtype>.
27
28 =for apidoc AmU||SVt_NV
29 Double type flag for scalars.  See C<svtype>.
30
31 =for apidoc AmU||SVt_PVMG
32 Type flag for blessed scalars.  See C<svtype>.
33
34 =for apidoc AmU||SVt_PVAV
35 Type flag for arrays.  See C<svtype>.
36
37 =for apidoc AmU||SVt_PVHV
38 Type flag for hashes.  See C<svtype>.
39
40 =for apidoc AmU||SVt_PVCV
41 Type flag for code refs.  See C<svtype>.
42
43 =cut
44 */
45
46 typedef enum {
47         SVt_NULL,       /* 0 */
48         SVt_IV,         /* 1 */
49         SVt_NV,         /* 2 */
50         SVt_RV,         /* 3 */
51         SVt_PV,         /* 4 */
52         SVt_PVIV,       /* 5 */
53         SVt_PVNV,       /* 6 */
54         SVt_PVMG,       /* 7 */
55         SVt_PVBM,       /* 8 */
56         SVt_PVGV,       /* 9 */
57         SVt_PVLV,       /* 10 */
58         SVt_PVAV,       /* 11 */
59         SVt_PVHV,       /* 12 */
60         SVt_PVCV,       /* 13 */
61         SVt_PVFM,       /* 14 */
62         SVt_PVIO        /* 15 */
63 } svtype;
64
65 /* Using C's structural equivalence to help emulate C++ inheritance here... */
66
67 struct STRUCT_SV {              /* struct sv { */
68     void*       sv_any;         /* pointer to something */
69     U32         sv_refcnt;      /* how many references to us */
70     U32         sv_flags;       /* what we are */
71     union {
72         IV      svu_iv;
73         UV      svu_uv;
74         SV*     svu_rv;         /* pointer to another SV */
75         char*   svu_pv;         /* pointer to malloced string */
76         SV**    svu_array;
77     }           sv_u;
78 #ifdef DEBUG_LEAKING_SCALARS
79     unsigned    sv_debug_optype:9;      /* the type of OP that allocated us */
80     unsigned    sv_debug_inpad:1;       /* was allocated in a pad for an OP */
81     unsigned    sv_debug_cloned:1;      /* was cloned for an ithread */
82     unsigned    sv_debug_line:16;       /* the line where we were allocated */
83     char *      sv_debug_file;          /* the file where we were allocated */
84 #endif
85 };
86
87 struct gv {
88     XPVGV*      sv_any;         /* pointer to something */
89     U32         sv_refcnt;      /* how many references to us */
90     U32         sv_flags;       /* what we are */
91     union {
92         IV      svu_iv;
93         UV      svu_uv;
94         SV*     svu_rv;
95         char*   svu_pv;
96         SV**    svu_array;
97     }           sv_u;
98 };
99
100 struct cv {
101     XPVCV*      sv_any;         /* pointer to something */
102     U32         sv_refcnt;      /* how many references to us */
103     U32         sv_flags;       /* what we are */
104     union {
105         IV      svu_iv;
106         UV      svu_uv;
107         SV*     svu_rv;
108         char*   svu_pv;
109         SV**    svu_array;
110     }           sv_u;
111 };
112
113 struct av {
114     XPVAV*      sv_any;         /* pointer to something */
115     U32         sv_refcnt;      /* how many references to us */
116     U32         sv_flags;       /* what we are */
117     union {
118         IV      svu_iv;
119         UV      svu_uv;
120         SV*     svu_rv;
121         char*   svu_pv;         /* pointer to first array element */
122         SV**    svu_array;
123     }           sv_u;
124 };
125
126 struct hv {
127     XPVHV*      sv_any;         /* pointer to something */
128     U32         sv_refcnt;      /* how many references to us */
129     U32         sv_flags;       /* what we are */
130     union {
131         IV      svu_iv;
132         UV      svu_uv;
133         SV*     svu_rv;
134         char*   svu_pv;
135         SV**    svu_array;
136     }           sv_u;
137 };
138
139 struct io {
140     XPVIO*      sv_any;         /* pointer to something */
141     U32         sv_refcnt;      /* how many references to us */
142     U32         sv_flags;       /* what we are */
143     union {
144         IV      svu_iv;
145         UV      svu_uv;
146         SV*     svu_rv;
147         char*   svu_pv;
148         SV**    svu_array;
149     }           sv_u;
150 };
151
152 /*
153 =head1 SV Manipulation Functions
154
155 =for apidoc Am|U32|SvREFCNT|SV* sv
156 Returns the value of the object's reference count.
157
158 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
159 Increments the reference count of the given SV.
160
161 =for apidoc Am|void|SvREFCNT_dec|SV* sv
162 Decrements the reference count of the given SV.
163
164 =for apidoc Am|svtype|SvTYPE|SV* sv
165 Returns the type of the SV.  See C<svtype>.
166
167 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
168 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to
169 perform the upgrade if necessary.  See C<svtype>.
170
171 =cut
172 */
173
174 #define SvANY(sv)       (sv)->sv_any
175 #define SvFLAGS(sv)     (sv)->sv_flags
176 #define SvREFCNT(sv)    (sv)->sv_refcnt
177
178 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
179 #  define SvREFCNT_inc(sv)              \
180     ({                                  \
181         SV * const _sv = (SV*)(sv);     \
182         if (_sv)                        \
183              (SvREFCNT(_sv))++;         \
184         _sv;                            \
185     })
186 #else
187 #  define SvREFCNT_inc(sv)      \
188         ((PL_Sv=(SV*)(sv)), (PL_Sv && ++(SvREFCNT(PL_Sv))), (SV*)PL_Sv)
189 #endif
190
191 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
192 #  define SvREFCNT_dec(sv)              \
193     ({                                  \
194         SV * const _sv = (SV*)(sv);     \
195         if (_sv) {                      \
196             if (SvREFCNT(_sv)) {        \
197                 if (--(SvREFCNT(_sv)) == 0) \
198                     Perl_sv_free2(aTHX_ _sv);   \
199             } else {                    \
200                 sv_free(_sv);           \
201             }                           \
202         }                               \
203     })
204 #else
205 #define SvREFCNT_dec(sv)        sv_free((SV*)(sv))
206 #endif
207
208 #define SVTYPEMASK      0xff
209 #define SvTYPE(sv)      ((sv)->sv_flags & SVTYPEMASK)
210
211 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
212
213 #define SVs_PADSTALE    0x00000100      /* lexical has gone out of scope */
214 #define SVs_PADTMP      0x00000200      /* in use as tmp */
215 #define SVs_PADMY       0x00000400      /* in use a "my" variable */
216 #define SVs_TEMP        0x00000800      /* string is stealable? */
217 #define SVs_OBJECT      0x00001000      /* is "blessed" */
218 #define SVs_GMG         0x00002000      /* has magical get method */
219 #define SVs_SMG         0x00004000      /* has magical set method */
220 #define SVs_RMG         0x00008000      /* has random magical methods */
221
222 #define SVf_IOK         0x00010000      /* has valid public integer value */
223 #define SVf_NOK         0x00020000      /* has valid public numeric value */
224 #define SVf_POK         0x00040000      /* has valid public pointer value */
225 #define SVf_ROK         0x00080000      /* has a valid reference pointer */
226
227 #define SVf_FAKE        0x00100000      /* glob or lexical is just a copy */
228 #define SVf_OOK         0x00200000      /* has valid offset value
229                                            For a PVHV this means that a
230                                            hv_aux struct is present after the
231                                            main array  */
232 #define SVf_BREAK       0x00400000      /* refcnt is artificially low - used
233                                          * by SV's in final arena  cleanup */
234 #define SVf_READONLY    0x00800000      /* may not be modified */
235
236
237 #define SVp_IOK         0x01000000      /* has valid non-public integer value */
238 #define SVp_NOK         0x02000000      /* has valid non-public numeric value */
239 #define SVp_POK         0x04000000      /* has valid non-public pointer value */
240 #define SVp_SCREAM      0x08000000      /* has been studied? */
241
242 #define SVf_UTF8        0x20000000      /* SvPV is UTF-8 encoded */
243 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
244
245 #define SVf_THINKFIRST  (SVf_READONLY|SVf_ROK|SVf_FAKE)
246
247 #define SVf_OK          (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
248                          SVp_IOK|SVp_NOK|SVp_POK)
249
250 #define SVf_AMAGIC      0x10000000      /* has magical overloaded methods */
251
252 #define PRIVSHIFT 8     /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
253
254 /* Some private flags. */
255
256 /* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
257 #define SVpad_OUR       0x80000000      /* pad name is "our" instead of "my" */
258 #define SVpad_TYPED     0x40000000      /* Typed Lexical */
259
260 #define SVf_IVisUV      0x80000000      /* use XPVUV instead of XPVIV */
261
262 #define SVpfm_COMPILED  0x80000000      /* FORMLINE is compiled */
263
264 #define SVpbm_VALID     0x80000000
265 #define SVpbm_TAIL      0x40000000
266
267 #define SVrepl_EVAL     0x40000000      /* Replacement part of s///e */
268
269 #define SVphv_CLONEABLE 0x08000000      /* for stashes: clone its objects */
270 #define SVphv_REHASH    0x10000000      /* HV is recalculating hash values */
271 #define SVphv_SHAREKEYS 0x20000000      /* keys live on shared string table */
272 #define SVphv_LAZYDEL   0x40000000      /* entry in xhv_eiter must be deleted */
273 #define SVphv_HASKFLAGS 0x80000000      /* keys have flag byte after hash */
274
275 #define SVprv_WEAKREF   0x80000000      /* Weak reference */
276
277 #define SVpav_REAL      0x40000000      /* free old entries */
278 #define SVpav_REIFY     0x80000000      /* can become real */
279
280 struct xpv {
281     NV          xnv_nv;         /* numeric value, if any */
282     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
283     STRLEN      xpv_len;        /* allocated size */
284 };
285
286 #if 0
287 typedef struct xpv xpv_allocated;
288 #else
289 typedef struct {
290     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
291     STRLEN      xpv_len;        /* allocated size */
292 } xpv_allocated;
293 #endif
294
295 struct xpviv {
296     NV          xnv_nv;         /* numeric value, if any */
297     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
298     STRLEN      xpv_len;        /* allocated size */
299     union {
300         IV      xivu_iv;        /* integer value or pv offset */
301         UV      xivu_uv;
302         void *  xivu_p1;
303     }           xiv_u;
304 };
305
306 #if 0
307 typedef struct xpviv xpviv_allocated;
308 #else
309 typedef struct {
310     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
311     STRLEN      xpv_len;        /* allocated size */
312     union {
313         IV      xivu_iv;        /* integer value or pv offset */
314         UV      xivu_uv;
315         void *  xivu_p1;
316     }           xiv_u;
317 } xpviv_allocated;
318 #endif
319
320 #define xiv_iv xiv_u.xivu_iv
321
322 struct xpvuv {
323     NV          xnv_nv;         /* numeric value, if any */
324     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
325     STRLEN      xpv_len;        /* allocated size */
326     union {
327         IV      xuvu_iv;
328         UV      xuvu_uv;        /* unsigned value or pv offset */
329         void *  xuvu_p1;
330     }           xuv_u;
331 };
332
333 #define xuv_uv xuv_u.xuvu_uv
334
335 struct xpvnv {
336     NV          xnv_nv;         /* numeric value, if any */
337     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
338     STRLEN      xpv_len;        /* allocated size */
339     union {
340         IV      xivu_iv;        /* integer value or pv offset */
341         UV      xivu_uv;
342         void *  xivu_p1;
343     }           xiv_u;
344 };
345
346 /* These structure must match the beginning of struct xpvhv in hv.h. */
347 struct xpvmg {
348     NV          xnv_nv;         /* numeric value, if any */
349     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
350     STRLEN      xpv_len;        /* allocated size */
351     union {
352         IV      xivu_iv;        /* integer value or pv offset */
353         UV      xivu_uv;
354         void *  xivu_p1;
355     }           xiv_u;
356     MAGIC*      xmg_magic;      /* linked list of magicalness */
357     HV*         xmg_stash;      /* class package */
358 };
359
360 struct xpvlv {
361     NV          xnv_nv;         /* numeric value, if any */
362     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
363     STRLEN      xpv_len;        /* allocated size */
364     union {
365         IV      xivu_iv;        /* integer value or pv offset */
366         UV      xivu_uv;
367         void *  xivu_p1;
368     }           xiv_u;
369     MAGIC*      xmg_magic;      /* linked list of magicalness */
370     HV*         xmg_stash;      /* class package */
371
372     /* a full glob fits into this */
373     GP*         xgv_gp;
374     char*       xgv_name;
375     STRLEN      xgv_namelen;
376     HV*         xgv_stash;
377     U8          xgv_flags;
378
379     STRLEN      xlv_targoff;
380     STRLEN      xlv_targlen;
381     SV*         xlv_targ;
382     char        xlv_type;       /* k=keys .=pos x=substr v=vec /=join/re
383                                  * y=alem/helem/iter t=tie T=tied HE */
384 };
385
386 struct xpvgv {
387     NV          xnv_nv;         /* numeric value, if any */
388     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
389     STRLEN      xpv_len;        /* allocated size */
390     union {
391         IV      xivu_iv;        /* integer value or pv offset */
392         UV      xivu_uv;
393         void *  xivu_p1;
394     }           xiv_u;
395     MAGIC*      xmg_magic;      /* linked list of magicalness */
396     HV*         xmg_stash;      /* class package */
397
398     GP*         xgv_gp;
399     char*       xgv_name;
400     STRLEN      xgv_namelen;
401     HV*         xgv_stash;
402     U8          xgv_flags;
403 };
404
405 struct xpvbm {
406     NV          xnv_nv;         /* numeric value, if any */
407     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
408     STRLEN      xpv_len;        /* allocated size */
409     union {
410         IV      xivu_iv;        /* integer value or pv offset */
411         UV      xivu_uv;
412         void *  xivu_p1;
413     }           xiv_u;
414     MAGIC*      xmg_magic;      /* linked list of magicalness */
415     HV*         xmg_stash;      /* class package */
416
417     I32         xbm_useful;     /* is this constant pattern being useful? */
418     U16         xbm_previous;   /* how many characters in string before rare? */
419     U8          xbm_rare;       /* rarest character in string */
420 };
421
422 /* This structure must match XPVCV in cv.h */
423
424 typedef U16 cv_flags_t;
425
426 struct xpvfm {
427     NV          xnv_nv;         /* numeric value, if any */
428     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
429     STRLEN      xpv_len;        /* allocated size */
430     union {
431         IV      xivu_iv;        /* integer value or pv offset */
432         UV      xivu_uv;
433         void *  xivu_p1;
434     }           xiv_u;
435     MAGIC*      xmg_magic;      /* linked list of magicalness */
436     HV*         xmg_stash;      /* class package */
437
438     HV *        xcv_stash;
439     OP *        xcv_start;
440     OP *        xcv_root;
441     void      (*xcv_xsub)(pTHX_ CV*);
442     ANY         xcv_xsubany;
443     GV *        xcv_gv;
444     char *      xcv_file;
445     long        xcv_depth;      /* >= 2 indicates recursive call */
446     AV *        xcv_padlist;
447     CV *        xcv_outside;
448     cv_flags_t  xcv_flags;
449     U32         xcv_outside_seq; /* the COP sequence (at the point of our
450                                   * compilation) in the lexically enclosing
451                                   * sub */
452     IV          xfm_lines;
453 };
454
455 struct xpvio {
456     NV          xnv_nv;         /* numeric value, if any */
457     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
458     STRLEN      xpv_len;        /* allocated size */
459     union {
460         IV      xivu_iv;        /* integer value or pv offset */
461         UV      xivu_uv;
462         void *  xivu_p1;
463     }           xiv_u;
464     MAGIC*      xmg_magic;      /* linked list of magicalness */
465     HV*         xmg_stash;      /* class package */
466
467     PerlIO *    xio_ifp;        /* ifp and ofp are normally the same */
468     PerlIO *    xio_ofp;        /* but sockets need separate streams */
469     /* Cray addresses everything by word boundaries (64 bits) and
470      * code and data pointers cannot be mixed (which is exactly what
471      * Perl_filter_add() tries to do with the dirp), hence the following
472      * union trick (as suggested by Gurusamy Sarathy).
473      * For further information see Geir Johansen's problem report titled
474        [ID 20000612.002] Perl problem on Cray system
475      * The any pointer (known as IoANY()) will also be a good place
476      * to hang any IO disciplines to.
477      */
478     union {
479         DIR *   xiou_dirp;      /* for opendir, readdir, etc */
480         void *  xiou_any;       /* for alignment */
481     } xio_dirpu;
482     IV          xio_lines;      /* $. */
483     IV          xio_page;       /* $% */
484     IV          xio_page_len;   /* $= */
485     IV          xio_lines_left; /* $- */
486     char *      xio_top_name;   /* $^ */
487     GV *        xio_top_gv;     /* $^ */
488     char *      xio_fmt_name;   /* $~ */
489     GV *        xio_fmt_gv;     /* $~ */
490     char *      xio_bottom_name;/* $^B */
491     GV *        xio_bottom_gv;  /* $^B */
492     short       xio_subprocess; /* -| or |- */
493     char        xio_type;
494     char        xio_flags;
495 };
496 #define xio_dirp        xio_dirpu.xiou_dirp
497 #define xio_any         xio_dirpu.xiou_any
498
499 #define IOf_ARGV        1       /* this fp iterates over ARGV */
500 #define IOf_START       2       /* check for null ARGV and substitute '-' */
501 #define IOf_FLUSH       4       /* this fp wants a flush after write op */
502 #define IOf_DIDTOP      8       /* just did top of form */
503 #define IOf_UNTAINT     16      /* consider this fp (and its data) "safe" */
504 #define IOf_NOLINE      32      /* slurped a pseudo-line from empty file */
505 #define IOf_FAKE_DIRP   64      /* xio_dirp is fake (source filters kludge) */
506
507 /* The following macros define implementation-independent predicates on SVs. */
508
509 /*
510 =for apidoc Am|bool|SvNIOK|SV* sv
511 Returns a boolean indicating whether the SV contains a number, integer or
512 double.
513
514 =for apidoc Am|bool|SvNIOKp|SV* sv
515 Returns a boolean indicating whether the SV contains a number, integer or
516 double.  Checks the B<private> setting.  Use C<SvNIOK>.
517
518 =for apidoc Am|void|SvNIOK_off|SV* sv
519 Unsets the NV/IV status of an SV.
520
521 =for apidoc Am|bool|SvOK|SV* sv
522 Returns a boolean indicating whether the value is an SV. It also tells
523 whether the value is defined or not.
524
525 =for apidoc Am|bool|SvIOKp|SV* sv
526 Returns a boolean indicating whether the SV contains an integer.  Checks
527 the B<private> setting.  Use C<SvIOK>.
528
529 =for apidoc Am|bool|SvNOKp|SV* sv
530 Returns a boolean indicating whether the SV contains a double.  Checks the
531 B<private> setting.  Use C<SvNOK>.
532
533 =for apidoc Am|bool|SvPOKp|SV* sv
534 Returns a boolean indicating whether the SV contains a character string.
535 Checks the B<private> setting.  Use C<SvPOK>.
536
537 =for apidoc Am|bool|SvIOK|SV* sv
538 Returns a boolean indicating whether the SV contains an integer.
539
540 =for apidoc Am|void|SvIOK_on|SV* sv
541 Tells an SV that it is an integer.
542
543 =for apidoc Am|void|SvIOK_off|SV* sv
544 Unsets the IV status of an SV.
545
546 =for apidoc Am|void|SvIOK_only|SV* sv
547 Tells an SV that it is an integer and disables all other OK bits.
548
549 =for apidoc Am|void|SvIOK_only_UV|SV* sv
550 Tells and SV that it is an unsigned integer and disables all other OK bits.
551
552 =for apidoc Am|bool|SvIOK_UV|SV* sv
553 Returns a boolean indicating whether the SV contains an unsigned integer.
554
555 =for apidoc Am|void|SvUOK|SV* sv
556 Returns a boolean indicating whether the SV contains an unsigned integer.
557
558 =for apidoc Am|bool|SvIOK_notUV|SV* sv
559 Returns a boolean indicating whether the SV contains a signed integer.
560
561 =for apidoc Am|bool|SvNOK|SV* sv
562 Returns a boolean indicating whether the SV contains a double.
563
564 =for apidoc Am|void|SvNOK_on|SV* sv
565 Tells an SV that it is a double.
566
567 =for apidoc Am|void|SvNOK_off|SV* sv
568 Unsets the NV status of an SV.
569
570 =for apidoc Am|void|SvNOK_only|SV* sv
571 Tells an SV that it is a double and disables all other OK bits.
572
573 =for apidoc Am|bool|SvPOK|SV* sv
574 Returns a boolean indicating whether the SV contains a character
575 string.
576
577 =for apidoc Am|void|SvPOK_on|SV* sv
578 Tells an SV that it is a string.
579
580 =for apidoc Am|void|SvPOK_off|SV* sv
581 Unsets the PV status of an SV.
582
583 =for apidoc Am|void|SvPOK_only|SV* sv
584 Tells an SV that it is a string and disables all other OK bits.
585 Will also turn off the UTF-8 status.
586
587 =for apidoc Am|bool|SvVOK|SV* sv
588 Returns a boolean indicating whether the SV contains a v-string.
589
590 =for apidoc Am|bool|SvOOK|SV* sv
591 Returns a boolean indicating whether the SvIVX is a valid offset value for
592 the SvPVX.  This hack is used internally to speed up removal of characters
593 from the beginning of a SvPV.  When SvOOK is true, then the start of the
594 allocated string buffer is really (SvPVX - SvIVX).
595
596 =for apidoc Am|bool|SvROK|SV* sv
597 Tests if the SV is an RV.
598
599 =for apidoc Am|void|SvROK_on|SV* sv
600 Tells an SV that it is an RV.
601
602 =for apidoc Am|void|SvROK_off|SV* sv
603 Unsets the RV status of an SV.
604
605 =for apidoc Am|SV*|SvRV|SV* sv
606 Dereferences an RV to return the SV.
607
608 =for apidoc Am|IV|SvIVX|SV* sv
609 Returns the raw value in the SV's IV slot, without checks or conversions.
610 Only use when you are sure SvIOK is true. See also C<SvIV()>.
611
612 =for apidoc Am|UV|SvUVX|SV* sv
613 Returns the raw value in the SV's UV slot, without checks or conversions.
614 Only use when you are sure SvIOK is true. See also C<SvUV()>.
615
616 =for apidoc Am|NV|SvNVX|SV* sv
617 Returns the raw value in the SV's NV slot, without checks or conversions.
618 Only use when you are sure SvNOK is true. See also C<SvNV()>.
619
620 =for apidoc Am|char*|SvPVX|SV* sv
621 Returns a pointer to the physical string in the SV.  The SV must contain a
622 string.
623
624 =for apidoc Am|STRLEN|SvCUR|SV* sv
625 Returns the length of the string which is in the SV.  See C<SvLEN>.
626
627 =for apidoc Am|STRLEN|SvLEN|SV* sv
628 Returns the size of the string buffer in the SV, not including any part
629 attributable to C<SvOOK>.  See C<SvCUR>.
630
631 =for apidoc Am|char*|SvEND|SV* sv
632 Returns a pointer to the last character in the string which is in the SV.
633 See C<SvCUR>.  Access the character as *(SvEND(sv)).
634
635 =for apidoc Am|HV*|SvSTASH|SV* sv
636 Returns the stash of the SV.
637
638 =for apidoc Am|void|SvIV_set|SV* sv|IV val
639 Set the value of the IV pointer in sv to val.  It is possible to perform
640 the same function of this macro with an lvalue assignment to C<SvIVX>.
641 With future Perls, however, it will be more efficient to use 
642 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
643
644 =for apidoc Am|void|SvNV_set|SV* sv|NV val
645 Set the value of the NV pointer in sv to val.  See C<SvIV_set>.
646
647 =for apidoc Am|void|SvPV_set|SV* sv|char* val
648 Set the value of the PV pointer in sv to val.  See C<SvIV_set>.
649
650 =for apidoc Am|void|SvUV_set|SV* sv|UV val
651 Set the value of the UV pointer in sv to val.  See C<SvIV_set>.
652
653 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
654 Set the value of the RV pointer in sv to val.  See C<SvIV_set>.
655
656 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
657 Set the value of the MAGIC pointer in sv to val.  See C<SvIV_set>.
658
659 =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
660 Set the value of the STASH pointer in sv to val.  See C<SvIV_set>.
661
662 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
663 Set the current length of the string which is in the SV.  See C<SvCUR>
664 and C<SvIV_set>.
665
666 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
667 Set the actual length of the string which is in the SV.  See C<SvIV_set>.
668
669 =cut
670 */
671
672 #define SvNIOK(sv)              (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
673 #define SvNIOKp(sv)             (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
674 #define SvNIOK_off(sv)          (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
675                                                   SVp_IOK|SVp_NOK|SVf_IVisUV))
676
677 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
678 #define assert_not_ROK(sv)      ({assert(!SvROK(sv) || !SvRV(sv));}),
679 #else
680 #define assert_not_ROK(sv)      
681 #endif
682
683 #define SvOK(sv)                (SvFLAGS(sv) & SVf_OK)
684 #define SvOK_off(sv)            (assert_not_ROK(sv)                     \
685                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
686                                                   SVf_IVisUV|SVf_UTF8), \
687                                                         SvOOK_off(sv))
688 #define SvOK_off_exc_UV(sv)     (assert_not_ROK(sv)                     \
689                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
690                                                   SVf_UTF8),            \
691                                                         SvOOK_off(sv))
692
693 #define SvOKp(sv)               (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
694 #define SvIOKp(sv)              (SvFLAGS(sv) & SVp_IOK)
695 #define SvIOKp_on(sv)           (SvRELEASE_IVX(sv), \
696                                     SvFLAGS(sv) |= SVp_IOK)
697 #define SvNOKp(sv)              (SvFLAGS(sv) & SVp_NOK)
698 #define SvNOKp_on(sv)           (SvFLAGS(sv) |= SVp_NOK)
699 #define SvPOKp(sv)              (SvFLAGS(sv) & SVp_POK)
700 #define SvPOKp_on(sv)           (assert_not_ROK(sv)                     \
701                                  SvFLAGS(sv) |= SVp_POK)
702
703 #define SvIOK(sv)               (SvFLAGS(sv) & SVf_IOK)
704 #define SvIOK_on(sv)            (SvRELEASE_IVX(sv), \
705                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
706 #define SvIOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
707 #define SvIOK_only(sv)          (SvOK_off(sv), \
708                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
709 #define SvIOK_only_UV(sv)       (SvOK_off_exc_UV(sv), \
710                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
711
712 #define SvIOK_UV(sv)            ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
713                                  == (SVf_IOK|SVf_IVisUV))
714 #define SvUOK(sv)               SvIOK_UV(sv)
715 #define SvIOK_notUV(sv)         ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
716                                  == SVf_IOK)
717
718 #define SvIsUV(sv)              (SvFLAGS(sv) & SVf_IVisUV)
719 #define SvIsUV_on(sv)           (SvFLAGS(sv) |= SVf_IVisUV)
720 #define SvIsUV_off(sv)          (SvFLAGS(sv) &= ~SVf_IVisUV)
721
722 #define SvNOK(sv)               (SvFLAGS(sv) & SVf_NOK)
723 #define SvNOK_on(sv)            (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
724 #define SvNOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
725 #define SvNOK_only(sv)          (SvOK_off(sv), \
726                                     SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
727
728 /*
729 =for apidoc Am|bool|SvUTF8|SV* sv
730 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
731
732 =for apidoc Am|void|SvUTF8_on|SV *sv
733 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
734 Do not use frivolously.
735
736 =for apidoc Am|void|SvUTF8_off|SV *sv
737 Unsets the UTF-8 status of an SV.
738
739 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
740 Tells an SV that it is a string and disables all other OK bits,
741 and leaves the UTF-8 status as it was.
742
743 =cut
744  */
745
746 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
747 in gv.h: */
748 #define SvUTF8(sv)              (SvFLAGS(sv) & SVf_UTF8)
749 #define SvUTF8_on(sv)           (SvFLAGS(sv) |= (SVf_UTF8))
750 #define SvUTF8_off(sv)          (SvFLAGS(sv) &= ~(SVf_UTF8))
751
752 #define SvPOK(sv)               (SvFLAGS(sv) & SVf_POK)
753 #define SvPOK_on(sv)            (assert_not_ROK(sv)                     \
754                                  SvFLAGS(sv) |= (SVf_POK|SVp_POK))
755 #define SvPOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
756 #define SvPOK_only(sv)          (assert_not_ROK(sv)                     \
757                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
758                                                   SVf_IVisUV|SVf_UTF8), \
759                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
760 #define SvPOK_only_UTF8(sv)     (assert_not_ROK(sv)                     \
761                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
762                                                   SVf_IVisUV),          \
763                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
764
765 #define SvVOK(sv)               (SvMAGICAL(sv) && mg_find(sv,'V'))
766 #define SvOOK(sv)               (SvFLAGS(sv) & SVf_OOK)
767 #define SvOOK_on(sv)            ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
768 #define SvOOK_off(sv)           ((void)(SvOOK(sv) && sv_backoff(sv)))
769
770 #define SvFAKE(sv)              (SvFLAGS(sv) & SVf_FAKE)
771 #define SvFAKE_on(sv)           (SvFLAGS(sv) |= SVf_FAKE)
772 #define SvFAKE_off(sv)          (SvFLAGS(sv) &= ~SVf_FAKE)
773
774 #define SvROK(sv)               (SvFLAGS(sv) & SVf_ROK)
775 #define SvROK_on(sv)            (SvFLAGS(sv) |= SVf_ROK)
776 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
777
778 #define SvMAGICAL(sv)           (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
779 #define SvMAGICAL_on(sv)        (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
780 #define SvMAGICAL_off(sv)       (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
781
782 #define SvGMAGICAL(sv)          (SvFLAGS(sv) & SVs_GMG)
783 #define SvGMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_GMG)
784 #define SvGMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_GMG)
785
786 #define SvSMAGICAL(sv)          (SvFLAGS(sv) & SVs_SMG)
787 #define SvSMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_SMG)
788 #define SvSMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_SMG)
789
790 #define SvRMAGICAL(sv)          (SvFLAGS(sv) & SVs_RMG)
791 #define SvRMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_RMG)
792 #define SvRMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_RMG)
793
794 #define SvAMAGIC(sv)            (SvFLAGS(sv) & SVf_AMAGIC)
795 #define SvAMAGIC_on(sv)         (SvFLAGS(sv) |= SVf_AMAGIC)
796 #define SvAMAGIC_off(sv)        (SvFLAGS(sv) &= ~SVf_AMAGIC)
797
798 #define SvGAMAGIC(sv)           (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
799
800 /*
801 #define Gv_AMG(stash) \
802         (HV_AMAGICmb(stash) && \
803          ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
804 */
805 #define Gv_AMG(stash)           (PL_amagic_generation && Gv_AMupdate(stash))
806
807 #define SvWEAKREF(sv)           ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
808                                   == (SVf_ROK|SVprv_WEAKREF))
809 #define SvWEAKREF_on(sv)        (SvFLAGS(sv) |=  (SVf_ROK|SVprv_WEAKREF))
810 #define SvWEAKREF_off(sv)       (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
811
812 #define SvTHINKFIRST(sv)        (SvFLAGS(sv) & SVf_THINKFIRST)
813
814 #define SvPADSTALE(sv)          (SvFLAGS(sv) & SVs_PADSTALE)
815 #define SvPADSTALE_on(sv)       (SvFLAGS(sv) |= SVs_PADSTALE)
816 #define SvPADSTALE_off(sv)      (SvFLAGS(sv) &= ~SVs_PADSTALE)
817
818 #define SvPADTMP(sv)            (SvFLAGS(sv) & SVs_PADTMP)
819 #define SvPADTMP_on(sv)         (SvFLAGS(sv) |= SVs_PADTMP)
820 #define SvPADTMP_off(sv)        (SvFLAGS(sv) &= ~SVs_PADTMP)
821
822 #define SvPADMY(sv)             (SvFLAGS(sv) & SVs_PADMY)
823 #define SvPADMY_on(sv)          (SvFLAGS(sv) |= SVs_PADMY)
824
825 #define SvTEMP(sv)              (SvFLAGS(sv) & SVs_TEMP)
826 #define SvTEMP_on(sv)           (SvFLAGS(sv) |= SVs_TEMP)
827 #define SvTEMP_off(sv)          (SvFLAGS(sv) &= ~SVs_TEMP)
828
829 #define SvOBJECT(sv)            (SvFLAGS(sv) & SVs_OBJECT)
830 #define SvOBJECT_on(sv)         (SvFLAGS(sv) |= SVs_OBJECT)
831 #define SvOBJECT_off(sv)        (SvFLAGS(sv) &= ~SVs_OBJECT)
832
833 #define SvREADONLY(sv)          (SvFLAGS(sv) & SVf_READONLY)
834 #define SvREADONLY_on(sv)       (SvFLAGS(sv) |= SVf_READONLY)
835 #define SvREADONLY_off(sv)      (SvFLAGS(sv) &= ~SVf_READONLY)
836
837 #define SvSCREAM(sv)            (SvFLAGS(sv) & SVp_SCREAM)
838 #define SvSCREAM_on(sv)         (SvFLAGS(sv) |= SVp_SCREAM)
839 #define SvSCREAM_off(sv)        (SvFLAGS(sv) &= ~SVp_SCREAM)
840
841 #define SvCOMPILED(sv)          (SvFLAGS(sv) & SVpfm_COMPILED)
842 #define SvCOMPILED_on(sv)       (SvFLAGS(sv) |= SVpfm_COMPILED)
843 #define SvCOMPILED_off(sv)      (SvFLAGS(sv) &= ~SVpfm_COMPILED)
844
845 #define SvEVALED(sv)            (SvFLAGS(sv) & SVrepl_EVAL)
846 #define SvEVALED_on(sv)         (SvFLAGS(sv) |= SVrepl_EVAL)
847 #define SvEVALED_off(sv)        (SvFLAGS(sv) &= ~SVrepl_EVAL)
848
849 #define SvTAIL(sv)              (SvFLAGS(sv) & SVpbm_TAIL)
850 #define SvTAIL_on(sv)           (SvFLAGS(sv) |= SVpbm_TAIL)
851 #define SvTAIL_off(sv)          (SvFLAGS(sv) &= ~SVpbm_TAIL)
852
853 #define SvVALID(sv)             (SvFLAGS(sv) & SVpbm_VALID)
854 #define SvVALID_on(sv)          (SvFLAGS(sv) |= SVpbm_VALID)
855 #define SvVALID_off(sv)         (SvFLAGS(sv) &= ~SVpbm_VALID)
856
857 #ifdef USE_ITHREADS
858 /* The following uses the FAKE flag to show that a regex pointer is infact
859    its own offset in the regexpad for ithreads */
860 #define SvREPADTMP(sv)          (SvFLAGS(sv) & SVf_FAKE)
861 #define SvREPADTMP_on(sv)       (SvFLAGS(sv) |= SVf_FAKE)
862 #define SvREPADTMP_off(sv)      (SvFLAGS(sv) &= ~SVf_FAKE)
863 #endif
864
865 #ifdef PERL_DEBUG_COW
866 #define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
867 #else
868 #define SvRV(sv) ((sv)->sv_u.svu_rv)
869 #endif
870 #define SvRVx(sv) SvRV(sv)
871
872 #ifdef PERL_DEBUG_COW
873 #define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
874 #define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
875 #define SvNVX(sv) (0 + ((XPVNV*) SvANY(sv))->xnv_nv)
876 /* Don't test the core XS code yet.  */
877 #if defined (PERL_CORE) && PERL_DEBUG_COW > 1
878 #define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
879 #else
880 #define SvPVX(sv) SvPVX_mutable(sv)
881 #endif
882 #define SvPVX_mutable(sv)       (0 + (sv)->sv_u.svu_pv)
883 #define SvPVX_const(sv) ((const char*)(0 + (sv)->sv_u.svu_pv))
884 #define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
885 #define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
886 #define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
887
888 #ifdef DEBUGGING
889 #  ifdef PERL_IN_SV_C
890 /* Can't make this RVALUE because of Perl_sv_unmagic.  */
891 #    define SvMAGIC(sv) (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_magic))
892 #  else
893 #    define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_magic))
894 #  endif
895 #define SvSTASH(sv)     (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_stash))
896 #else
897 #  ifdef PERL_IN_SV_C
898 #    define SvMAGIC(sv) ((XPVMG*)  SvANY(sv))->xmg_magic
899 #  else
900 #    define SvMAGIC(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_magic)
901 #  endif
902 #define SvSTASH(sv)     (0 + ((XPVMG*)  SvANY(sv))->xmg_stash)
903 #endif
904 #else
905 #define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
906 #define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
907 #define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_nv
908 #define SvPVX(sv) ((sv)->sv_u.svu_pv)
909 #define SvPVX_mutable(sv)       SvPVX(sv)
910 #define SvPVX_const(sv) ((const char*)SvPVX(sv))
911 #define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
912 #define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
913 #define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
914
915 #ifdef DEBUGGING
916 #define SvMAGIC(sv)     (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_magic))
917 #define SvSTASH(sv)     (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_stash))
918 #else
919 #define SvMAGIC(sv)     ((XPVMG*)  SvANY(sv))->xmg_magic
920 #define SvSTASH(sv)     ((XPVMG*)  SvANY(sv))->xmg_stash
921 #endif
922
923 #endif
924
925 #define SvIVXx(sv) SvIVX(sv)
926 #define SvUVXx(sv) SvUVX(sv)
927 #define SvNVXx(sv) SvNVX(sv)
928 #define SvPVXx(sv) SvPVX(sv)
929 #define SvLENx(sv) SvLEN(sv)
930 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
931
932
933 /* Ask a scalar nicely to try to become an IV, if possible.
934    Not guaranteed to stay returning void */
935 /* Macro won't actually call sv_2iv if already IOK */
936 #define SvIV_please(sv) \
937         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
938                 (void) SvIV(sv); } STMT_END
939 #define SvIV_set(sv, val) \
940         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
941                 (((XPVIV*)  SvANY(sv))->xiv_iv = (val)); } STMT_END
942 #define SvNV_set(sv, val) \
943         STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
944             assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
945                 (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END
946 #define SvPV_set(sv, val) \
947         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
948                 ((sv)->sv_u.svu_pv = (val)); } STMT_END
949 #define SvUV_set(sv, val) \
950         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
951                 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
952 #define SvRV_set(sv, val) \
953         STMT_START { assert(SvTYPE(sv) >=  SVt_RV); \
954                 ((sv)->sv_u.svu_rv = (val)); } STMT_END
955 #define SvMAGIC_set(sv, val) \
956         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
957                 (((XPVMG*)SvANY(sv))->xmg_magic = (val)); } STMT_END
958 #define SvSTASH_set(sv, val) \
959         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
960                 (((XPVMG*)  SvANY(sv))->xmg_stash = (val)); } STMT_END
961 #define SvCUR_set(sv, val) \
962         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
963                 (((XPV*)  SvANY(sv))->xpv_cur = (val)); } STMT_END
964 #define SvLEN_set(sv, val) \
965         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
966                 (((XPV*)  SvANY(sv))->xpv_len = (val)); } STMT_END
967 #define SvEND_set(sv, val) \
968         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
969                 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
970
971 #define SvPV_renew(sv,n) \
972         STMT_START { SvLEN_set(sv, n); \
973                 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)                 \
974                                 (char*)saferealloc((Malloc_t)SvPVX(sv), \
975                                                    (MEM_SIZE)((n)))));  \
976                  } STMT_END
977
978 #define SvPV_shrink_to_cur(sv) STMT_START { \
979                    const STRLEN _lEnGtH = SvCUR(sv) + 1; \
980                    SvPV_renew(sv, _lEnGtH); \
981                  } STMT_END
982
983 #define SvPV_free(sv) \
984         STMT_START { assert(SvTYPE(sv) >= SVt_PV);      \
985                 if (SvLEN(sv)) {                        \
986                     if(SvOOK(sv)) {                     \
987                       Safefree(SvPVX(sv) - SvIVX(sv));  \
988                       SvFLAGS(sv) &= ~SVf_OOK;          \
989                     } else {                            \
990                       Safefree(SvPVX(sv));              \
991                     }                                   \
992                 }                                       \
993         } STMT_END
994
995 #define BmRARE(sv)      ((XPVBM*)  SvANY(sv))->xbm_rare
996 #define BmUSEFUL(sv)    ((XPVBM*)  SvANY(sv))->xbm_useful
997 #define BmPREVIOUS(sv)  ((XPVBM*)  SvANY(sv))->xbm_previous
998
999 #define FmLINES(sv)     ((XPVFM*)  SvANY(sv))->xfm_lines
1000
1001 #define LvTYPE(sv)      ((XPVLV*)  SvANY(sv))->xlv_type
1002 #define LvTARG(sv)      ((XPVLV*)  SvANY(sv))->xlv_targ
1003 #define LvTARGOFF(sv)   ((XPVLV*)  SvANY(sv))->xlv_targoff
1004 #define LvTARGLEN(sv)   ((XPVLV*)  SvANY(sv))->xlv_targlen
1005
1006 #define IoIFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ifp
1007 #define IoOFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ofp
1008 #define IoDIRP(sv)      ((XPVIO*)  SvANY(sv))->xio_dirp
1009 #define IoANY(sv)       ((XPVIO*)  SvANY(sv))->xio_any
1010 #define IoLINES(sv)     ((XPVIO*)  SvANY(sv))->xio_lines
1011 #define IoPAGE(sv)      ((XPVIO*)  SvANY(sv))->xio_page
1012 #define IoPAGE_LEN(sv)  ((XPVIO*)  SvANY(sv))->xio_page_len
1013 #define IoLINES_LEFT(sv)((XPVIO*)  SvANY(sv))->xio_lines_left
1014 #define IoTOP_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_top_name
1015 #define IoTOP_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_top_gv
1016 #define IoFMT_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_fmt_name
1017 #define IoFMT_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_fmt_gv
1018 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1019 #define IoBOTTOM_GV(sv) ((XPVIO*)  SvANY(sv))->xio_bottom_gv
1020 #define IoSUBPROCESS(sv)((XPVIO*)  SvANY(sv))->xio_subprocess
1021 #define IoTYPE(sv)      ((XPVIO*)  SvANY(sv))->xio_type
1022 #define IoFLAGS(sv)     ((XPVIO*)  SvANY(sv))->xio_flags
1023
1024 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1025 #define IoTYPE_RDONLY           '<'
1026 #define IoTYPE_WRONLY           '>'
1027 #define IoTYPE_RDWR             '+'
1028 #define IoTYPE_APPEND           'a'
1029 #define IoTYPE_PIPE             '|'
1030 #define IoTYPE_STD              '-'     /* stdin or stdout */
1031 #define IoTYPE_SOCKET           's'
1032 #define IoTYPE_CLOSED           ' '
1033 #define IoTYPE_IMPLICIT         'I'     /* stdin or stdout or stderr */
1034 #define IoTYPE_NUMERIC          '#'     /* fdopen */
1035
1036 /*
1037 =for apidoc Am|bool|SvTAINTED|SV* sv
1038 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1039 not.
1040
1041 =for apidoc Am|void|SvTAINTED_on|SV* sv
1042 Marks an SV as tainted if tainting is enabled.
1043
1044 =for apidoc Am|void|SvTAINTED_off|SV* sv
1045 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1046 some of Perl's fundamental security features. XS module authors should not
1047 use this function unless they fully understand all the implications of
1048 unconditionally untainting the value. Untainting should be done in the
1049 standard perl fashion, via a carefully crafted regexp, rather than directly
1050 untainting variables.
1051
1052 =for apidoc Am|void|SvTAINT|SV* sv
1053 Taints an SV if tainting is enabled.
1054
1055 =cut
1056 */
1057
1058 #define SvTAINTED(sv)     (SvMAGICAL(sv) && sv_tainted(sv))
1059 #define SvTAINTED_on(sv)  STMT_START{ if(PL_tainting){sv_taint(sv);}   }STMT_END
1060 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1061
1062 #define SvTAINT(sv)                     \
1063     STMT_START {                        \
1064         if (PL_tainting) {              \
1065             if (PL_tainted)             \
1066                 SvTAINTED_on(sv);       \
1067         }                               \
1068     } STMT_END
1069
1070 /*
1071 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1072 Like C<SvPV> but will force the SV into containing just a string
1073 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1074 directly.
1075
1076 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1077 Like C<SvPV> but will force the SV into containing just a string
1078 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1079 directly. Doesn't process magic.
1080
1081 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1082 Returns a pointer to the string in the SV, or a stringified form of
1083 the SV if the SV does not contain a string.  The SV may cache the
1084 stringified version becoming C<SvPOK>.  Handles 'get' magic. See also
1085 C<SvPVx> for a version which guarantees to evaluate sv only once.
1086
1087 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1088 A version of C<SvPV> which guarantees to evaluate sv only once.
1089
1090 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1091 Like C<SvPV> but doesn't process magic.
1092
1093 =for apidoc Am|char*|SvPV_nolen|SV* sv
1094 Returns a pointer to the string in the SV, or a stringified form of
1095 the SV if the SV does not contain a string.  The SV may cache the
1096 stringified form becoming C<SvPOK>.  Handles 'get' magic.
1097
1098 =for apidoc Am|IV|SvIV|SV* sv
1099 Coerces the given SV to an integer and returns it. See  C<SvIVx> for a
1100 version which guarantees to evaluate sv only once.
1101
1102 =for apidoc Am|IV|SvIV_nomg|SV* sv
1103 Like C<SvIV> but doesn't process magic.
1104
1105 =for apidoc Am|IV|SvIVx|SV* sv
1106 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1107 sv only once. Use the more efficient C<SvIV> otherwise.
1108
1109 =for apidoc Am|NV|SvNV|SV* sv
1110 Coerce the given SV to a double and return it. See  C<SvNVx> for a version
1111 which guarantees to evaluate sv only once.
1112
1113 =for apidoc Am|NV|SvNVx|SV* sv
1114 Coerces the given SV to a double and returns it. Guarantees to evaluate
1115 sv only once. Use the more efficient C<SvNV> otherwise.
1116
1117 =for apidoc Am|UV|SvUV|SV* sv
1118 Coerces the given SV to an unsigned integer and returns it.  See C<SvUVx>
1119 for a version which guarantees to evaluate sv only once.
1120
1121 =for apidoc Am|UV|SvUV_nomg|SV* sv
1122 Like C<SvUV> but doesn't process magic.
1123
1124 =for apidoc Am|UV|SvUVx|SV* sv
1125 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1126 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1127
1128 =for apidoc Am|bool|SvTRUE|SV* sv
1129 Returns a boolean indicating whether Perl would evaluate the SV as true or
1130 false, defined or undefined.  Does not handle 'get' magic.
1131
1132 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1133 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1134
1135 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1136 Like C<SvPV>, but converts sv to utf8 first if necessary.
1137
1138 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1139 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1140
1141 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1142 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1143
1144 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1145 Like C<SvPV>, but converts sv to byte representation first if necessary.
1146
1147 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1148 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1149
1150 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1151 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1152 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1153 otherwise.
1154
1155 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1156 Like C<SvPV>, but converts sv to utf8 first if necessary.
1157 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1158 otherwise.
1159
1160 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1161 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1162 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1163 otherwise.
1164
1165 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1166 Like C<SvPV>, but converts sv to byte representation first if necessary.
1167 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1168 otherwise.
1169
1170 =for apidoc Am|bool|SvIsCOW|SV* sv
1171 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1172 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1173 COW)
1174
1175 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1176 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1177 scalar.
1178
1179 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1180 Like C<sv_catpvn> but doesn't process magic.
1181
1182 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1183 Like C<sv_setsv> but doesn't process magic.
1184
1185 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1186 Like C<sv_catsv> but doesn't process magic.
1187
1188 =cut
1189 */
1190
1191 /* Let us hope that bitmaps for UV and IV are the same */
1192 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1193 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1194 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1195
1196 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1197 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1198
1199 /* ----*/
1200
1201 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1202 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1203 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1204
1205 #define SvPV_flags(sv, lp, flags) \
1206     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1207      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1208 #define SvPV_flags_const(sv, lp, flags) \
1209     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1210      ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1211      (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1212 #define SvPV_flags_mutable(sv, lp, flags) \
1213     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1214      ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1215      sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1216
1217 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1218 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1219 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1220
1221 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1222
1223 #define SvPV_force_flags(sv, lp, flags) \
1224     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1225     ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1226 #define SvPV_force_flags_nolen(sv, flags) \
1227     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1228     ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1229 #define SvPV_force_flags_mutable(sv, lp, flags) \
1230     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1231     ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1232      : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1233
1234 #define SvPV_nolen(sv) \
1235     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1236      ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1237
1238 #define SvPV_nolen_const(sv) \
1239     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1240      ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1241
1242 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1243 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1244
1245 /* ----*/
1246
1247 #define SvPVutf8(sv, lp) \
1248     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1249      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1250
1251 #define SvPVutf8_force(sv, lp) \
1252     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1253      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1254
1255
1256 #define SvPVutf8_nolen(sv) \
1257     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1258      ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1259
1260 /* ----*/
1261
1262 #define SvPVbyte(sv, lp) \
1263     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1264      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1265
1266 #define SvPVbyte_force(sv, lp) \
1267     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1268      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1269
1270 #define SvPVbyte_nolen(sv) \
1271     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1272      ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1273
1274
1275     
1276 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1277  * var to evaluate the arg once; failing that, use a global if possible;
1278  * failing that, call a function to do the work
1279  */
1280
1281 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1282 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1283 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1284
1285 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1286
1287 #  define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1288 #  define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1289 #  define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1290 #  define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1291 #  define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1292 #  define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1293 #  define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1294 #  define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1295 #  define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1296 #  define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1297 #  define SvTRUE(sv) (                                          \
1298     !sv                                                         \
1299     ? 0                                                         \
1300     :    SvPOK(sv)                                              \
1301         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
1302              nxpv &&                                            \
1303              (nxpv->xpv_cur > 1 ||                              \
1304               (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1305              ? 1                                                \
1306              : 0)                                               \
1307         :                                                       \
1308             SvIOK(sv)                                           \
1309             ? SvIVX(sv) != 0                                    \
1310             :   SvNOK(sv)                                       \
1311                 ? SvNVX(sv) != 0.0                              \
1312                 : sv_2bool(sv) )
1313 #  define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1314
1315 #else /* __GNUC__ */
1316
1317 /* These inlined macros use globals, which will require a thread
1318  * declaration in user code, so we avoid them under threads */
1319
1320 #  define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1321 #  define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1322 #  define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1323 #  define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1324 #  define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1325 #  define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1326 #  define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1327 #  define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1328 #  define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1329 #  define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1330 #  define SvTRUE(sv) (                                          \
1331     !sv                                                         \
1332     ? 0                                                         \
1333     :    SvPOK(sv)                                              \
1334         ?   ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) &&            \
1335              (PL_Xpv->xpv_cur > 1 ||                            \
1336               (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0'))  \
1337              ? 1                                                \
1338              : 0)                                               \
1339         :                                                       \
1340             SvIOK(sv)                                           \
1341             ? SvIVX(sv) != 0                                    \
1342             :   SvNOK(sv)                                       \
1343                 ? SvNVX(sv) != 0.0                              \
1344                 : sv_2bool(sv) )
1345 #  define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1346 #endif /* __GNU__ */
1347
1348 #define SvIsCOW(sv)             ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1349                                     (SVf_FAKE | SVf_READONLY))
1350 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1351
1352 #define SvSHARED_HEK_FROM_PV(pvx) \
1353         ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1354 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1355
1356 /* flag values for sv_*_flags functions */
1357 #define SV_IMMEDIATE_UNREF      1
1358 #define SV_GMAGIC               2
1359 #define SV_COW_DROP_PV          4
1360 #define SV_UTF8_NO_ENCODING     8
1361 #define SV_NOSTEAL              16
1362 #define SV_CONST_RETURN         32
1363 #define SV_MUTABLE_RETURN       64
1364
1365 /* We are about to replace the SV's current value. So if it's copy on write
1366    we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1367    the value is about to get thrown away, so drop the PV rather than go to
1368    the effort of making a read-write copy only for it to get immediately
1369    discarded.  */
1370
1371 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1372                                     sv_force_normal_flags(sv, SV_COW_DROP_PV)
1373
1374 #ifdef PERL_OLD_COPY_ON_WRITE
1375 #  define SvRELEASE_IVX(sv)   ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1376                                 && Perl_sv_release_IVX(aTHX_ sv)))
1377 #  define SvIsCOW_normal(sv)    (SvIsCOW(sv) && SvLEN(sv))
1378 #else
1379 #  define SvRELEASE_IVX(sv)   SvOOK_off(sv)
1380 #endif /* PERL_OLD_COPY_ON_WRITE */
1381
1382 #define CAN_COW_MASK    (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1383                          SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1384                          SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1385 #define CAN_COW_FLAGS   (SVp_POK|SVf_POK)
1386
1387 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1388                                     sv_force_normal_flags(sv, 0)
1389
1390
1391 /* all these 'functions' are now just macros */
1392
1393 #define sv_pv(sv) SvPV_nolen(sv)
1394 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1395 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1396
1397 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1398 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1399 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1400 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1401 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1402 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1403 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1404 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1405 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1406 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1407 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1408 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1409 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1410 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1411
1412 /* Should be named SvCatPVN_utf8_upgrade? */
1413 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv)    \
1414         STMT_START {                                    \
1415             if (!(nsv))                                 \
1416                 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1417             else                                        \
1418                 sv_setpvn(nsv, sstr, slen);             \
1419             SvUTF8_off(nsv);                            \
1420             sv_utf8_upgrade(nsv);                       \
1421             sv_catsv(dsv, nsv); \
1422         } STMT_END
1423
1424 /*
1425 =for apidoc Am|SV*|newRV_inc|SV* sv
1426
1427 Creates an RV wrapper for an SV.  The reference count for the original SV is
1428 incremented.
1429
1430 =cut
1431 */
1432
1433 #define newRV_inc(sv)   newRV(sv)
1434
1435 /* the following macros update any magic values this sv is associated with */
1436
1437 /*
1438 =head1 Magical Functions
1439
1440 =for apidoc Am|void|SvGETMAGIC|SV* sv
1441 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
1442 argument more than once.
1443
1444 =for apidoc Am|void|SvSETMAGIC|SV* sv
1445 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
1446 argument more than once.
1447
1448 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1449 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
1450 more than once.
1451
1452 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1453 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1454 ssv. May evaluate arguments more than once.
1455
1456 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1457 Like C<SvSetSV>, but does any set magic required afterwards.
1458
1459 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1460 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1461
1462 =for apidoc Am|void|SvSHARE|SV* sv
1463 Arranges for sv to be shared between threads if a suitable module
1464 has been loaded.
1465
1466 =for apidoc Am|void|SvLOCK|SV* sv
1467 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1468 has been loaded.
1469
1470 =for apidoc Am|void|SvUNLOCK|SV* sv
1471 Releases a mutual exclusion lock on sv if a suitable module
1472 has been loaded.
1473
1474 =head1 SV Manipulation Functions
1475
1476 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1477 Expands the character buffer in the SV so that it has room for the
1478 indicated number of bytes (remember to reserve space for an extra trailing
1479 NUL character).  Calls C<sv_grow> to perform the expansion if necessary.
1480 Returns a pointer to the character buffer.
1481
1482 =cut
1483 */
1484
1485 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1486 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1487 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1488
1489 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1490 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1491
1492 #define SvSetSV_and(dst,src,finally) \
1493         STMT_START {                                    \
1494             if ((dst) != (src)) {                       \
1495                 sv_setsv(dst, src);                     \
1496                 finally;                                \
1497             }                                           \
1498         } STMT_END
1499 #define SvSetSV_nosteal_and(dst,src,finally) \
1500         STMT_START {                                    \
1501             if ((dst) != (src)) {                       \
1502                 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL);       \
1503                 finally;                                \
1504             }                                           \
1505         } STMT_END
1506
1507 #define SvSetSV(dst,src) \
1508                 SvSetSV_and(dst,src,/*nothing*/;)
1509 #define SvSetSV_nosteal(dst,src) \
1510                 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1511
1512 #define SvSetMagicSV(dst,src) \
1513                 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1514 #define SvSetMagicSV_nosteal(dst,src) \
1515                 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1516
1517
1518 #if !defined(SKIP_DEBUGGING)
1519 #define SvPEEK(sv) sv_peek(sv)
1520 #else
1521 #define SvPEEK(sv) ""
1522 #endif
1523
1524 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1525
1526 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1527
1528 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1529
1530 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1531 #define SvGROW_mutable(sv,len) \
1532     (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1533 #define Sv_Grow sv_grow
1534
1535 #define CLONEf_COPY_STACKS 1
1536 #define CLONEf_KEEP_PTR_TABLE 2
1537 #define CLONEf_CLONE_HOST 4
1538 #define CLONEf_JOIN_IN 8
1539
1540 struct clone_params {
1541   AV* stashes;
1542   UV  flags;
1543   PerlInterpreter *proto_perl;
1544 };
1545
1546 /*
1547  * Local variables:
1548  * c-indentation-style: bsd
1549  * c-basic-offset: 4
1550  * indent-tabs-mode: t
1551  * End:
1552  *
1553  * ex: set ts=8 sts=4 sw=4 noet:
1554  */