sv.h

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