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