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