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