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