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