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