Save an upgrade each by first setting the NV on PL_sv_yes and PL_sv_no
[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: Whether the regexp pointer is in
332                                           fact an offset [SvREPADTMP(sv)]
333                                        5: On a pad name SV, that slot in the
334                                           frame AV is a REFCNT'ed reference
335                                           to a lexical from "outside". */
336 #define SVphv_REHASH    SVf_FAKE    /* 6: On a PVHV, hash values are being
337                                           recalculated */
338 #define SVf_OOK         0x02000000  /* has valid offset value. For a PVHV this
339                                        means that a hv_aux struct is present
340                                        after the main array */
341 #define SVf_BREAK       0x04000000  /* refcnt is artificially low - used by
342                                        SV's in final arena cleanup */
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 #ifdef USE_ITHREADS
992 /* The following uses the FAKE flag to show that a regex pointer is infact
993    its own offset in the regexpad for ithreads */
994 #define SvREPADTMP(sv)          (SvFLAGS(sv) & SVf_FAKE)
995 #define SvREPADTMP_on(sv)       (SvFLAGS(sv) |= SVf_FAKE)
996 #define SvREPADTMP_off(sv)      (SvFLAGS(sv) &= ~SVf_FAKE)
997 #endif
998
999 #define SvPAD_TYPED(sv) \
1000         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
1001
1002 #define SvPAD_OUR(sv)   \
1003         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
1004
1005 #define SvPAD_STATE(sv) \
1006         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_STATE)) == (SVpad_NAME|SVpad_STATE))
1007
1008 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1009 #  define SvPAD_TYPED_on(sv)    ({                                      \
1010             SV *const whap = (SV *) (sv);                               \
1011             assert(SvTYPE(whap) == SVt_PVMG);                           \
1012             (SvFLAGS(whap) |= SVpad_NAME|SVpad_TYPED);                  \
1013         })
1014 #define SvPAD_OUR_on(sv)        ({                                      \
1015             SV *const whap = (SV *) (sv);                               \
1016             assert(SvTYPE(whap) == SVt_PVMG);                           \
1017             (SvFLAGS(whap) |= SVpad_NAME|SVpad_OUR);                    \
1018         })
1019 #define SvPAD_STATE_on(sv)      ({                                      \
1020             SV *const whap = (SV *) (sv);                               \
1021             assert(SvTYPE(whap) == SVt_PVNV || SvTYPE(whap) == SVt_PVMG); \
1022             (SvFLAGS(whap) |= SVpad_NAME|SVpad_STATE);                  \
1023         })
1024 #else
1025 #  define SvPAD_TYPED_on(sv)    (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
1026 #  define SvPAD_OUR_on(sv)      (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
1027 #  define SvPAD_STATE_on(sv)    (SvFLAGS(sv) |= SVpad_NAME|SVpad_STATE)
1028 #endif
1029
1030 #define SvOURSTASH(sv)  \
1031         (SvPAD_OUR(sv) ? ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash : NULL)
1032 #define SvOURSTASH_set(sv, st)                                  \
1033         STMT_START {                                            \
1034             assert(SvTYPE(sv) == SVt_PVMG);                     \
1035             ((XPVMG*) SvANY(sv))->xmg_u.xmg_ourstash = st;      \
1036         } STMT_END
1037
1038 #ifdef PERL_DEBUG_COW
1039 #else
1040 #endif
1041 #define SvRVx(sv) SvRV(sv)
1042
1043 #ifdef PERL_DEBUG_COW
1044 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
1045    +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
1046 #  define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
1047 #  define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
1048 #  define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv)
1049 #  define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
1050 /* Don't test the core XS code yet.  */
1051 #  if defined (PERL_CORE) && PERL_DEBUG_COW > 1
1052 #    define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
1053 #  else
1054 #  define SvPVX(sv) SvPVX_mutable(sv)
1055 #  endif
1056 #  define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
1057 #  define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
1058 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1059
1060 #  ifdef DEBUGGING
1061 #    define SvMAGIC(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic))
1062 #    define SvSTASH(sv) (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_stash))
1063 #  else
1064 #    define SvMAGIC(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic)
1065 #    define SvSTASH(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_stash)
1066 #  endif
1067 #else
1068 #  define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
1069 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
1070
1071 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1072 /* These get expanded inside other macros that already use a variable _sv  */
1073 #    define SvPVX(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             &((_svi)->sv_u.svu_pv);                                     \
1080          }))
1081 #    define SvCUR(sv)                                                   \
1082         (*({ SV *const _svi = (SV *) (sv);                              \
1083             assert(SvTYPE(_svi) >= SVt_PV);                             \
1084             assert(SvTYPE(_svi) != SVt_PVAV);                           \
1085             assert(SvTYPE(_svi) != SVt_PVHV);                           \
1086             assert(!isGV_with_GP(_svi));                                \
1087             &(((XPV*) SvANY(_svi))->xpv_cur);                           \
1088          }))
1089 #    define SvIVX(sv)                                                   \
1090         (*({ SV *const _svi = (SV *) (sv);                              \
1091             assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1092             assert(SvTYPE(_svi) != SVt_PVAV);                           \
1093             assert(SvTYPE(_svi) != SVt_PVHV);                           \
1094             assert(SvTYPE(_svi) != SVt_PVCV);                           \
1095             assert(!isGV_with_GP(_svi));                                \
1096             &(((XPVIV*) SvANY(_svi))->xiv_iv);                          \
1097          }))
1098 #    define SvUVX(sv)                                                   \
1099         (*({ SV *const _svi = (SV *) (sv);                              \
1100             assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1101             assert(SvTYPE(_svi) != SVt_PVAV);                           \
1102             assert(SvTYPE(_svi) != SVt_PVHV);                           \
1103             assert(SvTYPE(_svi) != SVt_PVCV);                           \
1104             assert(!isGV_with_GP(_svi));                                \
1105             &(((XPVUV*) SvANY(_svi))->xuv_uv);                          \
1106          }))
1107 #    define SvNVX(sv)                                                   \
1108         (*({ SV *const _svi = (SV *) (sv);                              \
1109             assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \
1110             assert(SvTYPE(_svi) != SVt_PVAV);                           \
1111             assert(SvTYPE(_svi) != SVt_PVHV);                           \
1112             assert(SvTYPE(_svi) != SVt_PVCV);                           \
1113             assert(SvTYPE(_svi) != SVt_PVFM);                           \
1114             assert(!isGV_with_GP(_svi));                                \
1115            &(((XPVNV*) SvANY(_svi))->xnv_u.xnv_nv);                     \
1116          }))
1117 #    define SvRV(sv)                                                    \
1118         (*({ SV *const _svi = (SV *) (sv);                              \
1119             assert(SvTYPE(_svi) >= SVt_PV || SvTYPE(_svi) == SVt_IV);   \
1120             assert(SvTYPE(_svi) != SVt_PVAV);                           \
1121             assert(SvTYPE(_svi) != SVt_PVHV);                           \
1122             assert(SvTYPE(_svi) != SVt_PVCV);                           \
1123             assert(SvTYPE(_svi) != SVt_PVFM);                           \
1124             assert(!isGV_with_GP(_svi));                                \
1125             &((_svi)->sv_u.svu_rv);                                     \
1126          }))
1127 #    define SvMAGIC(sv)                                                 \
1128         (*({ SV *const _svi = (SV *) (sv);                              \
1129             assert(SvTYPE(_svi) >= SVt_PVMG);                           \
1130             if(SvTYPE(_svi) == SVt_PVMG)                                \
1131                 assert(!SvPAD_OUR(_svi));                               \
1132             &(((XPVMG*) SvANY(_svi))->xmg_u.xmg_magic);                 \
1133           }))
1134 #    define SvSTASH(sv)                                                 \
1135         (*({ SV *const _svi = (SV *) (sv);                              \
1136             assert(SvTYPE(_svi) >= SVt_PVMG);                           \
1137             &(((XPVMG*) SvANY(_svi))->xmg_stash);                       \
1138           }))
1139 #  else
1140 #    define SvPVX(sv) ((sv)->sv_u.svu_pv)
1141 #    define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
1142 #    define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1143 #    define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1144 #    define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_u.xnv_nv
1145 #    define SvRV(sv) ((sv)->sv_u.svu_rv)
1146 #    define SvMAGIC(sv) ((XPVMG*)  SvANY(sv))->xmg_u.xmg_magic
1147 #    define SvSTASH(sv) ((XPVMG*)  SvANY(sv))->xmg_stash
1148 #  endif
1149 #endif
1150
1151 #ifndef PERL_POISON
1152 /* Given that these two are new, there can't be any existing code using them
1153  *  as LVALUEs  */
1154 #  define SvPVX_mutable(sv)     (0 + (sv)->sv_u.svu_pv)
1155 #  define SvPVX_const(sv)       ((const char*)(0 + (sv)->sv_u.svu_pv))
1156 #else
1157 /* Except for the poison code, which uses & to scribble over the pointer after
1158    free() is called.  */
1159 #  define SvPVX_mutable(sv)     ((sv)->sv_u.svu_pv)
1160 #  define SvPVX_const(sv)       ((const char*)((sv)->sv_u.svu_pv))
1161 #endif
1162
1163 #define SvIVXx(sv) SvIVX(sv)
1164 #define SvUVXx(sv) SvUVX(sv)
1165 #define SvNVXx(sv) SvNVX(sv)
1166 #define SvPVXx(sv) SvPVX(sv)
1167 #define SvLENx(sv) SvLEN(sv)
1168 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1169
1170
1171 /* Ask a scalar nicely to try to become an IV, if possible.
1172    Not guaranteed to stay returning void */
1173 /* Macro won't actually call sv_2iv if already IOK */
1174 #define SvIV_please(sv) \
1175         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1176                 (void) SvIV(sv); } STMT_END
1177 #define SvIV_set(sv, val) \
1178         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1179                 assert(SvTYPE(sv) != SVt_PVAV);         \
1180                 assert(SvTYPE(sv) != SVt_PVHV);         \
1181                 assert(SvTYPE(sv) != SVt_PVCV);         \
1182                 assert(!isGV_with_GP(sv));              \
1183                 (((XPVIV*)  SvANY(sv))->xiv_iv = (val)); } STMT_END
1184 #define SvNV_set(sv, val) \
1185         STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1186             assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1187             assert(SvTYPE(sv) != SVt_PVCV); assert(SvTYPE(sv) != SVt_PVFM); \
1188                 assert(!isGV_with_GP(sv));              \
1189                 (((XPVNV*)SvANY(sv))->xnv_u.xnv_nv = (val)); } STMT_END
1190 #define SvPV_set(sv, val) \
1191         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1192                 assert(SvTYPE(sv) != SVt_PVAV);         \
1193                 assert(SvTYPE(sv) != SVt_PVHV);         \
1194                 assert(!isGV_with_GP(sv));              \
1195                 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1196 #define SvUV_set(sv, val) \
1197         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1198                 assert(SvTYPE(sv) != SVt_PVAV);         \
1199                 assert(SvTYPE(sv) != SVt_PVHV);         \
1200                 assert(SvTYPE(sv) != SVt_PVCV);         \
1201                 assert(!isGV_with_GP(sv));              \
1202                 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1203 #define SvRV_set(sv, val) \
1204         STMT_START { assert(SvTYPE(sv) >=  SVt_PV || SvTYPE(sv) ==  SVt_IV); \
1205                 assert(SvTYPE(sv) != SVt_PVAV);         \
1206                 assert(SvTYPE(sv) != SVt_PVHV);         \
1207                 assert(SvTYPE(sv) != SVt_PVCV);         \
1208                 assert(SvTYPE(sv) != SVt_PVFM);         \
1209                 assert(!isGV_with_GP(sv));              \
1210                 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1211 #define SvMAGIC_set(sv, val) \
1212         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1213                 (((XPVMG*)SvANY(sv))->xmg_u.xmg_magic = (val)); } STMT_END
1214 #define SvSTASH_set(sv, val) \
1215         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1216                 (((XPVMG*)  SvANY(sv))->xmg_stash = (val)); } STMT_END
1217 #define SvCUR_set(sv, val) \
1218         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1219                 assert(SvTYPE(sv) != SVt_PVAV);         \
1220                 assert(SvTYPE(sv) != SVt_PVHV);         \
1221                 assert(!isGV_with_GP(sv));              \
1222                 (((XPV*)  SvANY(sv))->xpv_cur = (val)); } STMT_END
1223 #define SvLEN_set(sv, val) \
1224         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1225                 assert(SvTYPE(sv) != SVt_PVAV); \
1226                 assert(SvTYPE(sv) != SVt_PVHV); \
1227                 assert(!isGV_with_GP(sv));      \
1228                 (((XPV*)  SvANY(sv))->xpv_len = (val)); } STMT_END
1229 #define SvEND_set(sv, val) \
1230         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1231                 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
1232
1233 #define SvPV_renew(sv,n) \
1234         STMT_START { SvLEN_set(sv, n); \
1235                 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)                 \
1236                                 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1237                                                    (MEM_SIZE)((n)))));  \
1238                  } STMT_END
1239
1240 #define SvPV_shrink_to_cur(sv) STMT_START { \
1241                    const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1242                    SvPV_renew(sv, _lEnGtH); \
1243                  } STMT_END
1244
1245 #define SvPV_free(sv)                                                   \
1246     STMT_START {                                                        \
1247                      assert(SvTYPE(sv) >= SVt_PV);                      \
1248                      if (SvLEN(sv)) {                                   \
1249                          assert(!SvROK(sv));                            \
1250                          if(SvOOK(sv)) {                                \
1251                              STRLEN zok;                                \
1252                              SvOOK_offset(sv, zok);                     \
1253                              SvPV_set(sv, SvPVX_mutable(sv) - zok);     \
1254                              SvFLAGS(sv) &= ~SVf_OOK;                   \
1255                          }                                              \
1256                          Safefree(SvPVX(sv));                           \
1257                      }                                                  \
1258                  } STMT_END
1259
1260 #ifdef PERL_CORE
1261 /* Code that crops up in three places to take a scalar and ready it to hold
1262    a reference */
1263 #  define prepare_SV_for_RV(sv)                                         \
1264     STMT_START {                                                        \
1265                     if (SvTYPE(sv) < SVt_PV && SvTYPE(sv) != SVt_IV)    \
1266                         sv_upgrade(sv, SVt_IV);                         \
1267                     else if (SvTYPE(sv) >= SVt_PV) {                    \
1268                         SvPV_free(sv);                                  \
1269                         SvLEN_set(sv, 0);                               \
1270                         SvCUR_set(sv, 0);                               \
1271                     }                                                   \
1272                  } STMT_END
1273 #endif
1274
1275 #define PERL_FBM_TABLE_OFFSET 1 /* Number of bytes between EOS and table */
1276
1277 /* SvPOKp not SvPOK in the assertion because the string can be tainted! eg
1278    perl -T -e '/$^X/'
1279 */
1280 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1281 #  define BmFLAGS(sv)                                                   \
1282         (*({ SV *const uggh = (SV *) (sv);                              \
1283                 assert(SvTYPE(uggh) == SVt_PVGV);                       \
1284                 assert(SvVALID(uggh));                                  \
1285             &(((XPVGV*) SvANY(uggh))->xnv_u.xbm_s.xbm_flags);           \
1286          }))
1287 #  define BmRARE(sv)                                                    \
1288         (*({ SV *const uggh = (SV *) (sv);                              \
1289                 assert(SvTYPE(uggh) == SVt_PVGV);                       \
1290                 assert(SvVALID(uggh));                                  \
1291             &(((XPVGV*) SvANY(uggh))->xnv_u.xbm_s.xbm_rare);            \
1292          }))
1293 #  define BmUSEFUL(sv)                                                  \
1294         (*({ SV *const uggh = (SV *) (sv);                              \
1295             assert(SvTYPE(uggh) == SVt_PVGV);                           \
1296             assert(SvVALID(uggh));                                      \
1297             assert(!SvIOK(uggh));                                       \
1298             &(((XPVGV*) SvANY(uggh))->xiv_u.xivu_i32);                  \
1299          }))
1300 #  define BmPREVIOUS(sv)                                                \
1301         (*({ SV *const uggh = (SV *) (sv);                              \
1302                 assert(SvTYPE(uggh) == SVt_PVGV);                       \
1303                 assert(SvVALID(uggh));                                  \
1304             &(((XPVGV*) SvANY(uggh))->xnv_u.xbm_s.xbm_previous);        \
1305          }))
1306 #else
1307 #  define BmFLAGS(sv)           ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_flags
1308 #  define BmRARE(sv)            ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_rare
1309 #  define BmUSEFUL(sv)          ((XPVGV*) SvANY(sv))->xiv_u.xivu_i32
1310 #  define BmPREVIOUS(sv)        ((XPVGV*) SvANY(sv))->xnv_u.xbm_s.xbm_previous
1311
1312 #endif
1313
1314 #define FmLINES(sv)     ((XPVFM*)  SvANY(sv))->xfm_lines
1315
1316 #define LvTYPE(sv)      ((XPVLV*)  SvANY(sv))->xlv_type
1317 #define LvTARG(sv)      ((XPVLV*)  SvANY(sv))->xlv_targ
1318 #define LvTARGOFF(sv)   ((XPVLV*)  SvANY(sv))->xlv_targoff
1319 #define LvTARGLEN(sv)   ((XPVLV*)  SvANY(sv))->xlv_targlen
1320
1321 #define IoIFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ifp
1322 #define IoOFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ofp
1323 #define IoDIRP(sv)      ((XPVIO*)  SvANY(sv))->xio_dirp
1324 #define IoANY(sv)       ((XPVIO*)  SvANY(sv))->xio_any
1325 #define IoLINES(sv)     ((XPVIO*)  SvANY(sv))->xio_lines
1326 #define IoPAGE(sv)      ((XPVIO*)  SvANY(sv))->xio_page
1327 #define IoPAGE_LEN(sv)  ((XPVIO*)  SvANY(sv))->xio_page_len
1328 #define IoLINES_LEFT(sv)((XPVIO*)  SvANY(sv))->xio_lines_left
1329 #define IoTOP_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_top_name
1330 #define IoTOP_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_top_gv
1331 #define IoFMT_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_fmt_name
1332 #define IoFMT_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_fmt_gv
1333 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1334 #define IoBOTTOM_GV(sv) ((XPVIO*)  SvANY(sv))->xio_bottom_gv
1335 #define IoTYPE(sv)      ((XPVIO*)  SvANY(sv))->xio_type
1336 #define IoFLAGS(sv)     ((XPVIO*)  SvANY(sv))->xio_flags
1337
1338 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1339 #define IoTYPE_RDONLY           '<'
1340 #define IoTYPE_WRONLY           '>'
1341 #define IoTYPE_RDWR             '+'
1342 #define IoTYPE_APPEND           'a'
1343 #define IoTYPE_PIPE             '|'
1344 #define IoTYPE_STD              '-'     /* stdin or stdout */
1345 #define IoTYPE_SOCKET           's'
1346 #define IoTYPE_CLOSED           ' '
1347 #define IoTYPE_IMPLICIT         'I'     /* stdin or stdout or stderr */
1348 #define IoTYPE_NUMERIC          '#'     /* fdopen */
1349
1350 /*
1351 =for apidoc Am|bool|SvTAINTED|SV* sv
1352 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1353 not.
1354
1355 =for apidoc Am|void|SvTAINTED_on|SV* sv
1356 Marks an SV as tainted if tainting is enabled.
1357
1358 =for apidoc Am|void|SvTAINTED_off|SV* sv
1359 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1360 some of Perl's fundamental security features. XS module authors should not
1361 use this function unless they fully understand all the implications of
1362 unconditionally untainting the value. Untainting should be done in the
1363 standard perl fashion, via a carefully crafted regexp, rather than directly
1364 untainting variables.
1365
1366 =for apidoc Am|void|SvTAINT|SV* sv
1367 Taints an SV if tainting is enabled.
1368
1369 =cut
1370 */
1371
1372 #define sv_taint(sv)      sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1373
1374 #define SvTAINTED(sv)     (SvMAGICAL(sv) && sv_tainted(sv))
1375 #define SvTAINTED_on(sv)  STMT_START{ if(PL_tainting){sv_taint(sv);}   }STMT_END
1376 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1377
1378 #define SvTAINT(sv)                     \
1379     STMT_START {                        \
1380         if (PL_tainting) {              \
1381             if (PL_tainted)             \
1382                 SvTAINTED_on(sv);       \
1383         }                               \
1384     } STMT_END
1385
1386 /*
1387 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1388 Like C<SvPV> but will force the SV into containing just a string
1389 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1390 directly.
1391
1392 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1393 Like C<SvPV> but will force the SV into containing just a string
1394 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1395 directly. Doesn't process magic.
1396
1397 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1398 Returns a pointer to the string in the SV, or a stringified form of
1399 the SV if the SV does not contain a string.  The SV may cache the
1400 stringified version becoming C<SvPOK>.  Handles 'get' magic. See also
1401 C<SvPVx> for a version which guarantees to evaluate sv only once.
1402
1403 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1404 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
1405 Only use this if C<sv> is an expression with side effects, otherwise use the
1406 more efficient C<SvPVX>.
1407
1408 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1409 Like C<SvPV> but doesn't process magic.
1410
1411 =for apidoc Am|char*|SvPV_nolen|SV* sv
1412 Returns a pointer to the string in the SV, or a stringified form of
1413 the SV if the SV does not contain a string.  The SV may cache the
1414 stringified form becoming C<SvPOK>.  Handles 'get' magic.
1415
1416 =for apidoc Am|IV|SvIV|SV* sv
1417 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
1418 version which guarantees to evaluate sv only once.
1419
1420 =for apidoc Am|IV|SvIV_nomg|SV* sv
1421 Like C<SvIV> but doesn't process magic.
1422
1423 =for apidoc Am|IV|SvIVx|SV* sv
1424 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1425 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1426 otherwise use the more efficient C<SvIV>.
1427
1428 =for apidoc Am|NV|SvNV|SV* sv
1429 Coerce the given SV to a double and return it. See C<SvNVx> for a version
1430 which guarantees to evaluate sv only once.
1431
1432 =for apidoc Am|NV|SvNVx|SV* sv
1433 Coerces the given SV to a double and returns it. Guarantees to evaluate
1434 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1435 otherwise use the more efficient C<SvNV>.
1436
1437 =for apidoc Am|UV|SvUV|SV* sv
1438 Coerces the given SV to an unsigned integer and returns it.  See C<SvUVx>
1439 for a version which guarantees to evaluate sv only once.
1440
1441 =for apidoc Am|UV|SvUV_nomg|SV* sv
1442 Like C<SvUV> but doesn't process magic.
1443
1444 =for apidoc Am|UV|SvUVx|SV* sv
1445 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1446 C<sv> only once. Only use this if C<sv> is an expression with side effects,
1447 otherwise use the more efficient C<SvUV>.
1448
1449 =for apidoc Am|bool|SvTRUE|SV* sv
1450 Returns a boolean indicating whether Perl would evaluate the SV as true or
1451 false, defined or undefined.  Does not handle 'get' magic.
1452
1453 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1454 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1455
1456 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1457 Like C<SvPV>, but converts sv to utf8 first if necessary.
1458
1459 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1460 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1461
1462 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1463 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1464
1465 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1466 Like C<SvPV>, but converts sv to byte representation first if necessary.
1467
1468 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1469 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1470
1471 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1472 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1473 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1474 otherwise.
1475
1476 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1477 Like C<SvPV>, but converts sv to utf8 first if necessary.
1478 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1479 otherwise.
1480
1481 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1482 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1483 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1484 otherwise.
1485
1486 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1487 Like C<SvPV>, but converts sv to byte representation first if necessary.
1488 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1489 otherwise.
1490
1491 =for apidoc Am|bool|SvIsCOW|SV* sv
1492 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1493 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1494 COW)
1495
1496 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1497 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1498 scalar.
1499
1500 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1501 Like C<sv_catpvn> but doesn't process magic.
1502
1503 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1504 Like C<sv_setsv> but doesn't process magic.
1505
1506 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1507 Like C<sv_catsv> but doesn't process magic.
1508
1509 =cut
1510 */
1511
1512 /* Let us hope that bitmaps for UV and IV are the same */
1513 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1514 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1515 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1516
1517 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1518 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1519
1520 /* ----*/
1521
1522 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1523 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1524 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1525
1526 #define SvPV_flags(sv, lp, flags) \
1527     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1528      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1529 #define SvPV_flags_const(sv, lp, flags) \
1530     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1531      ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1532      (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1533 #define SvPV_flags_const_nolen(sv, flags) \
1534     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1535      ? SvPVX_const(sv) : \
1536      (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1537 #define SvPV_flags_mutable(sv, lp, flags) \
1538     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1539      ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1540      sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1541
1542 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1543 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1544 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1545
1546 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1547 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1548
1549 #define SvPV_force_flags(sv, lp, flags) \
1550     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1551     ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1552 #define SvPV_force_flags_nolen(sv, flags) \
1553     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1554     ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1555 #define SvPV_force_flags_mutable(sv, lp, flags) \
1556     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1557     ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1558      : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1559
1560 #define SvPV_nolen(sv) \
1561     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1562      ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1563
1564 #define SvPV_nolen_const(sv) \
1565     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1566      ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1567
1568 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1569 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1570 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1571
1572 /* ----*/
1573
1574 #define SvPVutf8(sv, lp) \
1575     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1576      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1577
1578 #define SvPVutf8_force(sv, lp) \
1579     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1580      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1581
1582
1583 #define SvPVutf8_nolen(sv) \
1584     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1585      ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1586
1587 /* ----*/
1588
1589 #define SvPVbyte(sv, lp) \
1590     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1591      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1592
1593 #define SvPVbyte_force(sv, lp) \
1594     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1595      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1596
1597 #define SvPVbyte_nolen(sv) \
1598     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1599      ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1600
1601
1602     
1603 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1604  * var to evaluate the arg once; failing that, use a global if possible;
1605  * failing that, call a function to do the work
1606  */
1607
1608 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1609 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1610 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1611
1612 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1613
1614 #  define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1615 #  define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1616 #  define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1617 #  define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1618 #  define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1619 #  define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1620 #  define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1621 #  define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1622 #  define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1623 #  define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1624 #  define SvTRUE(sv) (                                          \
1625     !sv                                                         \
1626     ? 0                                                         \
1627     :    SvPOK(sv)                                              \
1628         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
1629              nxpv &&                                            \
1630              (nxpv->xpv_cur > 1 ||                              \
1631               (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1632              ? 1                                                \
1633              : 0)                                               \
1634         :                                                       \
1635             SvIOK(sv)                                           \
1636             ? SvIVX(sv) != 0                                    \
1637             :   SvNOK(sv)                                       \
1638                 ? SvNVX(sv) != 0.0                              \
1639                 : sv_2bool(sv) )
1640 #  define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1641
1642 #else /* __GNUC__ */
1643
1644 /* These inlined macros use globals, which will require a thread
1645  * declaration in user code, so we avoid them under threads */
1646
1647 #  define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1648 #  define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1649 #  define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1650 #  define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1651 #  define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1652 #  define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1653 #  define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1654 #  define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1655 #  define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1656 #  define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1657 #  define SvTRUE(sv) (                                          \
1658     !sv                                                         \
1659     ? 0                                                         \
1660     :    SvPOK(sv)                                              \
1661         ?   ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) &&            \
1662              (PL_Xpv->xpv_cur > 1 ||                            \
1663               (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0'))  \
1664              ? 1                                                \
1665              : 0)                                               \
1666         :                                                       \
1667             SvIOK(sv)                                           \
1668             ? SvIVX(sv) != 0                                    \
1669             :   SvNOK(sv)                                       \
1670                 ? SvNVX(sv) != 0.0                              \
1671                 : sv_2bool(sv) )
1672 #  define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1673 #endif /* __GNU__ */
1674
1675 #define SvIsCOW(sv)             ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1676                                     (SVf_FAKE | SVf_READONLY))
1677 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1678
1679 #define SvSHARED_HEK_FROM_PV(pvx) \
1680         ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1681 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1682
1683 /* flag values for sv_*_flags functions */
1684 #define SV_IMMEDIATE_UNREF      1
1685 #define SV_GMAGIC               2
1686 #define SV_COW_DROP_PV          4
1687 #define SV_UTF8_NO_ENCODING     8
1688 #define SV_NOSTEAL              16
1689 #define SV_CONST_RETURN         32
1690 #define SV_MUTABLE_RETURN       64
1691 #define SV_SMAGIC               128
1692 #define SV_HAS_TRAILING_NUL     256
1693 #define SV_COW_SHARED_HASH_KEYS 512
1694 /* This one is only enabled for PERL_OLD_COPY_ON_WRITE */
1695 #define SV_COW_OTHER_PVS        1024
1696
1697 /* The core is safe for this COW optimisation. XS code on CPAN may not be.
1698    So only default to doing the COW setup if we're in the core.
1699  */
1700 #ifdef PERL_CORE
1701 #  ifndef SV_DO_COW_SVSETSV
1702 #    define SV_DO_COW_SVSETSV   SV_COW_SHARED_HASH_KEYS|SV_COW_OTHER_PVS
1703 #  endif
1704 #endif
1705
1706 #ifndef SV_DO_COW_SVSETSV
1707 #  define SV_DO_COW_SVSETSV     0
1708 #endif
1709
1710
1711 #define sv_unref(sv)            sv_unref_flags(sv, 0)
1712 #define sv_force_normal(sv)     sv_force_normal_flags(sv, 0)
1713 #define sv_usepvn(sv, p, l)     sv_usepvn_flags(sv, p, l, 0)
1714 #define sv_usepvn_mg(sv, p, l)  sv_usepvn_flags(sv, p, l, SV_SMAGIC)
1715
1716 /* We are about to replace the SV's current value. So if it's copy on write
1717    we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1718    the value is about to get thrown away, so drop the PV rather than go to
1719    the effort of making a read-write copy only for it to get immediately
1720    discarded.  */
1721
1722 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1723                                     sv_force_normal_flags(sv, SV_COW_DROP_PV)
1724
1725 #ifdef PERL_OLD_COPY_ON_WRITE
1726 #define SvRELEASE_IVX(sv)   \
1727     ((SvIsCOW(sv) ? sv_force_normal_flags(sv, 0) : (void) 0), 0)
1728 #  define SvIsCOW_normal(sv)    (SvIsCOW(sv) && SvLEN(sv))
1729 #  define SvRELEASE_IVX_(sv)    SvRELEASE_IVX(sv),
1730 #else
1731 #  define SvRELEASE_IVX(sv)   0
1732 /* This little game brought to you by the need to shut this warning up:
1733 mg.c: In function `Perl_magic_get':
1734 mg.c:1024: warning: left-hand operand of comma expression has no effect
1735 */
1736 #  define SvRELEASE_IVX_(sv)  /**/
1737 #endif /* PERL_OLD_COPY_ON_WRITE */
1738
1739 #define CAN_COW_MASK    (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1740                          SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1741                          SVf_OOK|SVf_BREAK|SVf_READONLY)
1742 #define CAN_COW_FLAGS   (SVp_POK|SVf_POK)
1743
1744 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1745                                     sv_force_normal_flags(sv, 0)
1746
1747
1748 /* all these 'functions' are now just macros */
1749
1750 #define sv_pv(sv) SvPV_nolen(sv)
1751 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1752 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1753
1754 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1755 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1756 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1757 #define sv_setsv(dsv, ssv) \
1758         sv_setsv_flags(dsv, ssv, SV_GMAGIC|SV_DO_COW_SVSETSV)
1759 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_DO_COW_SVSETSV)
1760 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1761 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1762 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1763 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1764 #define sv_catpvn_mg(sv, sstr, slen) \
1765         sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1766 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1767 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1768 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1769 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1770 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1771 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1772 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1773 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1774 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1775
1776 /* Should be named SvCatPVN_utf8_upgrade? */
1777 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv)    \
1778         STMT_START {                                    \
1779             if (!(nsv))                                 \
1780                 nsv = newSVpvn_flags(sstr, slen, SVs_TEMP);     \
1781             else                                        \
1782                 sv_setpvn(nsv, sstr, slen);             \
1783             SvUTF8_off(nsv);                            \
1784             sv_utf8_upgrade(nsv);                       \
1785             sv_catsv(dsv, nsv); \
1786         } STMT_END
1787
1788 /*
1789 =for apidoc Am|SV*|newRV_inc|SV* sv
1790
1791 Creates an RV wrapper for an SV.  The reference count for the original SV is
1792 incremented.
1793
1794 =cut
1795 */
1796
1797 #define newRV_inc(sv)   newRV(sv)
1798
1799 /* the following macros update any magic values this sv is associated with */
1800
1801 /*
1802 =head1 Magical Functions
1803
1804 =for apidoc Am|void|SvGETMAGIC|SV* sv
1805 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
1806 argument more than once.
1807
1808 =for apidoc Am|void|SvSETMAGIC|SV* sv
1809 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
1810 argument more than once.
1811
1812 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1813 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
1814 more than once.
1815
1816 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1817 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1818 ssv. May evaluate arguments more than once.
1819
1820 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1821 Like C<SvSetSV>, but does any set magic required afterwards.
1822
1823 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1824 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1825
1826 =for apidoc Am|void|SvSHARE|SV* sv
1827 Arranges for sv to be shared between threads if a suitable module
1828 has been loaded.
1829
1830 =for apidoc Am|void|SvLOCK|SV* sv
1831 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1832 has been loaded.
1833
1834 =for apidoc Am|void|SvUNLOCK|SV* sv
1835 Releases a mutual exclusion lock on sv if a suitable module
1836 has been loaded.
1837
1838 =head1 SV Manipulation Functions
1839
1840 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1841 Expands the character buffer in the SV so that it has room for the
1842 indicated number of bytes (remember to reserve space for an extra trailing
1843 NUL character).  Calls C<sv_grow> to perform the expansion if necessary.
1844 Returns a pointer to the character buffer.
1845
1846 =cut
1847 */
1848
1849 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1850 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1851 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1852 #define SvDESTROYABLE(sv) CALL_FPTR(PL_destroyhook)(aTHX_ sv)
1853
1854 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1855 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1856
1857 #define SvSetSV_and(dst,src,finally) \
1858         STMT_START {                                    \
1859             if ((dst) != (src)) {                       \
1860                 sv_setsv(dst, src);                     \
1861                 finally;                                \
1862             }                                           \
1863         } STMT_END
1864 #define SvSetSV_nosteal_and(dst,src,finally) \
1865         STMT_START {                                    \
1866             if ((dst) != (src)) {                       \
1867                 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL | SV_DO_COW_SVSETSV);   \
1868                 finally;                                \
1869             }                                           \
1870         } STMT_END
1871
1872 #define SvSetSV(dst,src) \
1873                 SvSetSV_and(dst,src,/*nothing*/;)
1874 #define SvSetSV_nosteal(dst,src) \
1875                 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1876
1877 #define SvSetMagicSV(dst,src) \
1878                 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1879 #define SvSetMagicSV_nosteal(dst,src) \
1880                 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1881
1882
1883 #if !defined(SKIP_DEBUGGING)
1884 #define SvPEEK(sv) sv_peek(sv)
1885 #else
1886 #define SvPEEK(sv) ""
1887 #endif
1888
1889 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1890
1891 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1892
1893 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1894 /* If I give every macro argument a different name, then there won't be bugs
1895    where nested macros get confused. Been there, done that.  */
1896 #define isGV_with_GP(pwadak) \
1897         (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP)   \
1898         && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
1899 #define isGV_with_GP_on(sv)     STMT_START {                           \
1900         assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1901         assert (!SvPOKp(sv));                                          \
1902         assert (!SvIOKp(sv));                                          \
1903         (SvFLAGS(sv) |= SVpgv_GP);                                     \
1904     } STMT_END
1905 #define isGV_with_GP_off(sv)    STMT_START {                           \
1906         assert (SvTYPE(sv) == SVt_PVGV || SvTYPE(sv) == SVt_PVLV); \
1907         assert (!SvPOKp(sv));                                          \
1908         assert (!SvIOKp(sv));                                          \
1909         (SvFLAGS(sv) &= ~SVpgv_GP);                                    \
1910     } STMT_END
1911
1912
1913 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1914 #define SvGROW_mutable(sv,len) \
1915     (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1916 #define Sv_Grow sv_grow
1917
1918 #define CLONEf_COPY_STACKS 1
1919 #define CLONEf_KEEP_PTR_TABLE 2
1920 #define CLONEf_CLONE_HOST 4
1921 #define CLONEf_JOIN_IN 8
1922
1923 struct clone_params {
1924   AV* stashes;
1925   UV  flags;
1926   PerlInterpreter *proto_perl;
1927 };
1928
1929 /*
1930 =for apidoc Am|SV*|newSVpvn_utf8|NULLOK const char* s|STRLEN len|U32 utf8
1931
1932 Creates a new SV and copies a string into it.  If utf8 is true, calls
1933 C<SvUTF8_on> on the new SV.  Implemented as a wrapper around C<newSVpvn_flags>.
1934
1935 =cut
1936 */
1937
1938 #define newSVpvn_utf8(s, len, u) newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
1939
1940 /*
1941 =for apidoc Am|void|SvOOK_offset|NN SV*sv|STRLEN len
1942
1943 Reads into I<len> the offset from SvPVX back to the true start of the
1944 allocated buffer, which will be non-zero if C<sv_chop> has been used to
1945 efficiently remove characters from start of the buffer. Implemented as a
1946 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
1947 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
1948
1949 =cut
1950 */
1951
1952 #ifdef DEBUGGING
1953 /* Does the bot know something I don't?
1954 10:28 <@Nicholas> metabatman
1955 10:28 <+meta> Nicholas: crash
1956 */
1957 #  define SvOOK_offset(sv, offset) STMT_START {                         \
1958         assert(sizeof(offset) == sizeof(STRLEN));                       \
1959         if (SvOOK(sv)) {                                                \
1960             const U8 *crash = (U8*)SvPVX_const(sv);                     \
1961             offset = *--crash;                                          \
1962             if (!offset) {                                              \
1963                 crash -= sizeof(STRLEN);                                \
1964                 Copy(crash, (U8 *)&offset, sizeof(STRLEN), U8);         \
1965             }                                                           \
1966             {                                                           \
1967                 /* Validate the preceding buffer's sentinels to         \
1968                    verify that no-one is using it.  */                  \
1969                 const U8 *const bonk = (U8 *) SvPVX_const(sv) - offset; \
1970                 while (crash > bonk) {                                  \
1971                     --crash;                                            \
1972                     assert (*crash == (U8)PTR2UV(crash));               \
1973                 }                                                       \
1974             }                                                           \
1975         } else {                                                        \
1976             offset = 0;                                                 \
1977         }                                                               \
1978     } STMT_END
1979 #else
1980     /* This is the same code, but avoids using any temporary variables:  */
1981 #  define SvOOK_offset(sv, offset) STMT_START {                         \
1982         assert(sizeof(offset) == sizeof(STRLEN));                       \
1983         if (SvOOK(sv)) {                                                \
1984             offset = ((U8*)SvPVX_const(sv))[-1];                        \
1985             if (!offset) {                                              \
1986                 Copy(SvPVX_const(sv) - 1 - sizeof(STRLEN),              \
1987                      (U8 *)&offset, sizeof(STRLEN), U8);                \
1988             }                                                           \
1989         } else {                                                        \
1990             offset = 0;                                                 \
1991         }                                                               \
1992     } STMT_END
1993 #endif
1994 /*
1995  * Local variables:
1996  * c-indentation-style: bsd
1997  * c-basic-offset: 4
1998  * indent-tabs-mode: t
1999  * End:
2000  *
2001  * ex: set ts=8 sts=4 sw=4 noet:
2002  */