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