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