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