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