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