sv.h

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