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