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