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