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