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