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