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