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