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