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