sv.h

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