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