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