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