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