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) (void)(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                                            For a PVHV this means that a
 230                                            hv_aux struct is present after the
 231                                            main array  */
 232 #define SVf_BREAK       0x00400000      /* refcnt is artificially low - used
 233                                          * by SV's in final arena  cleanup */
 234 #define SVf_READONLY    0x00800000      /* may not be modified */
 235
 236
 237 #define SVp_IOK         0x01000000      /* has valid non-public integer value */
 238 #define SVp_NOK         0x02000000      /* has valid non-public numeric value */
 239 #define SVp_POK         0x04000000      /* has valid non-public pointer value */
 240 #define SVp_SCREAM      0x08000000      /* has been studied? */
 241
 242 #define SVf_UTF8        0x20000000      /* SvPV is UTF-8 encoded */
 243 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
 244
 245 #define SVf_THINKFIRST  (SVf_READONLY|SVf_ROK|SVf_FAKE)
 246
 247 #define SVf_OK          (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
 248                          SVp_IOK|SVp_NOK|SVp_POK)
 249
 250 #define SVf_AMAGIC      0x10000000      /* has magical overloaded methods */
 251
 252 #define PRIVSHIFT 8     /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
 253
 254 /* Some private flags. */
 255
 256 /* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
 257 #define SVpad_OUR       0x80000000      /* pad name is "our" instead of "my" */
 258 #define SVpad_TYPED     0x40000000      /* Typed Lexical */
 259
 260 #define SVf_IVisUV      0x80000000      /* use XPVUV instead of XPVIV */
 261
 262 #define SVpfm_COMPILED  0x80000000      /* FORMLINE is compiled */
 263
 264 #define SVpbm_VALID     0x80000000
 265 #define SVpbm_TAIL      0x40000000
 266
 267 #define SVrepl_EVAL     0x40000000      /* Replacement part of s///e */
 268
 269 #define SVphv_CLONEABLE 0x08000000      /* for stashes: clone its objects */
 270 #define SVphv_REHASH    0x10000000      /* HV is recalculating hash values */
 271 #define SVphv_SHAREKEYS 0x20000000      /* keys live on shared string table */
 272 #define SVphv_LAZYDEL   0x40000000      /* entry in xhv_eiter must be deleted */
 273 #define SVphv_HASKFLAGS 0x80000000      /* keys have flag byte after hash */
 274
 275 #define SVprv_WEAKREF   0x80000000      /* Weak reference */
 276
 277 #define SVpav_REAL      0x40000000      /* free old entries */
 278 #define SVpav_REIFY     0x80000000      /* can become real */
 279
 280 struct xpv {
 281     NV          xnv_nv;         /* numeric value, if any */
 282     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 283     STRLEN      xpv_len;        /* allocated size */
 284 };
 285
 286 #if 0
 287 typedef struct xpv xpv_allocated;
 288 #else
 289 typedef struct {
 290     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 291     STRLEN      xpv_len;        /* allocated size */
 292 } xpv_allocated;
 293 #endif
 294
 295 struct xpviv {
 296     NV          xnv_nv;         /* numeric value, if any */
 297     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 298     STRLEN      xpv_len;        /* allocated size */
 299     union {
 300         IV      xivu_iv;        /* integer value or pv offset */
 301         UV      xivu_uv;
 302         void *  xivu_p1;
 303     }           xiv_u;
 304 };
 305
 306 #if 0
 307 typedef struct xpviv xpviv_allocated;
 308 #else
 309 typedef struct {
 310     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 311     STRLEN      xpv_len;        /* allocated size */
 312     union {
 313         IV      xivu_iv;        /* integer value or pv offset */
 314         UV      xivu_uv;
 315         void *  xivu_p1;
 316     }           xiv_u;
 317 } xpviv_allocated;
 318 #endif
 319
 320 #define xiv_iv xiv_u.xivu_iv
 321
 322 struct xpvuv {
 323     NV          xnv_nv;         /* numeric value, if any */
 324     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 325     STRLEN      xpv_len;        /* allocated size */
 326     union {
 327         IV      xuvu_iv;
 328         UV      xuvu_uv;        /* unsigned value or pv offset */
 329         void *  xuvu_p1;
 330     }           xuv_u;
 331 };
 332
 333 #define xuv_uv xuv_u.xuvu_uv
 334
 335 struct xpvnv {
 336     NV          xnv_nv;         /* numeric value, if any */
 337     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 338     STRLEN      xpv_len;        /* allocated size */
 339     union {
 340         IV      xivu_iv;        /* integer value or pv offset */
 341         UV      xivu_uv;
 342         void *  xivu_p1;
 343     }           xiv_u;
 344 };
 345
 346 /* These structure must match the beginning of struct xpvhv in hv.h. */
 347 struct xpvmg {
 348     NV          xnv_nv;         /* numeric value, if any */
 349     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 350     STRLEN      xpv_len;        /* allocated size */
 351     union {
 352         IV      xivu_iv;        /* integer value or pv offset */
 353         UV      xivu_uv;
 354         void *  xivu_p1;
 355     }           xiv_u;
 356     MAGIC*      xmg_magic;      /* linked list of magicalness */
 357     HV*         xmg_stash;      /* class package */
 358 };
 359
 360 struct xpvlv {
 361     NV          xnv_nv;         /* numeric value, if any */
 362     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 363     STRLEN      xpv_len;        /* allocated size */
 364     union {
 365         IV      xivu_iv;        /* integer value or pv offset */
 366         UV      xivu_uv;
 367         void *  xivu_p1;
 368     }           xiv_u;
 369     MAGIC*      xmg_magic;      /* linked list of magicalness */
 370     HV*         xmg_stash;      /* class package */
 371
 372     /* a full glob fits into this */
 373     GP*         xgv_gp;
 374     char*       xgv_name;
 375     STRLEN      xgv_namelen;
 376     HV*         xgv_stash;
 377     U8          xgv_flags;
 378
 379     STRLEN      xlv_targoff;
 380     STRLEN      xlv_targlen;
 381     SV*         xlv_targ;
 382     char        xlv_type;       /* k=keys .=pos x=substr v=vec /=join/re
 383                                  * y=alem/helem/iter t=tie T=tied HE */
 384 };
 385
 386 struct xpvgv {
 387     NV          xnv_nv;         /* numeric value, if any */
 388     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 389     STRLEN      xpv_len;        /* allocated size */
 390     union {
 391         IV      xivu_iv;        /* integer value or pv offset */
 392         UV      xivu_uv;
 393         void *  xivu_p1;
 394     }           xiv_u;
 395     MAGIC*      xmg_magic;      /* linked list of magicalness */
 396     HV*         xmg_stash;      /* class package */
 397
 398     GP*         xgv_gp;
 399     char*       xgv_name;
 400     STRLEN      xgv_namelen;
 401     HV*         xgv_stash;
 402     U8          xgv_flags;
 403 };
 404
 405 struct xpvbm {
 406     NV          xnv_nv;         /* numeric value, if any */
 407     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 408     STRLEN      xpv_len;        /* allocated size */
 409     union {
 410         IV      xivu_iv;        /* integer value or pv offset */
 411         UV      xivu_uv;
 412         void *  xivu_p1;
 413     }           xiv_u;
 414     MAGIC*      xmg_magic;      /* linked list of magicalness */
 415     HV*         xmg_stash;      /* class package */
 416
 417     I32         xbm_useful;     /* is this constant pattern being useful? */
 418     U16         xbm_previous;   /* how many characters in string before rare? */
 419     U8          xbm_rare;       /* rarest character in string */
 420 };
 421
 422 /* This structure must match XPVCV in cv.h */
 423
 424 typedef U16 cv_flags_t;
 425
 426 struct xpvfm {
 427     NV          xnv_nv;         /* numeric value, if any */
 428     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 429     STRLEN      xpv_len;        /* allocated size */
 430     union {
 431         IV      xivu_iv;        /* integer value or pv offset */
 432         UV      xivu_uv;
 433         void *  xivu_p1;
 434     }           xiv_u;
 435     MAGIC*      xmg_magic;      /* linked list of magicalness */
 436     HV*         xmg_stash;      /* class package */
 437
 438     HV *        xcv_stash;
 439     OP *        xcv_start;
 440     OP *        xcv_root;
 441     void      (*xcv_xsub)(pTHX_ CV*);
 442     ANY         xcv_xsubany;
 443     GV *        xcv_gv;
 444     char *      xcv_file;
 445     long        xcv_depth;      /* >= 2 indicates recursive call */
 446     AV *        xcv_padlist;
 447     CV *        xcv_outside;
 448     cv_flags_t  xcv_flags;
 449     U32         xcv_outside_seq; /* the COP sequence (at the point of our
 450                                   * compilation) in the lexically enclosing
 451                                   * sub */
 452     IV          xfm_lines;
 453 };
 454
 455 struct xpvio {
 456     NV          xnv_nv;         /* numeric value, if any */
 457     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 458     STRLEN      xpv_len;        /* allocated size */
 459     union {
 460         IV      xivu_iv;        /* integer value or pv offset */
 461         UV      xivu_uv;
 462         void *  xivu_p1;
 463     }           xiv_u;
 464     MAGIC*      xmg_magic;      /* linked list of magicalness */
 465     HV*         xmg_stash;      /* class package */
 466
 467     PerlIO *    xio_ifp;        /* ifp and ofp are normally the same */
 468     PerlIO *    xio_ofp;        /* but sockets need separate streams */
 469     /* Cray addresses everything by word boundaries (64 bits) and
 470      * code and data pointers cannot be mixed (which is exactly what
 471      * Perl_filter_add() tries to do with the dirp), hence the following
 472      * union trick (as suggested by Gurusamy Sarathy).
 473      * For further information see Geir Johansen's problem report titled
 474        [ID 20000612.002] Perl problem on Cray system
 475      * The any pointer (known as IoANY()) will also be a good place
 476      * to hang any IO disciplines to.
 477      */
 478     union {
 479         DIR *   xiou_dirp;      /* for opendir, readdir, etc */
 480         void *  xiou_any;       /* for alignment */
 481     } xio_dirpu;
 482     IV          xio_lines;      /* $. */
 483     IV          xio_page;       /* $% */
 484     IV          xio_page_len;   /* $= */
 485     IV          xio_lines_left; /* $- */
 486     char *      xio_top_name;   /* $^ */
 487     GV *        xio_top_gv;     /* $^ */
 488     char *      xio_fmt_name;   /* $~ */
 489     GV *        xio_fmt_gv;     /* $~ */
 490     char *      xio_bottom_name;/* $^B */
 491     GV *        xio_bottom_gv;  /* $^B */
 492     short       xio_subprocess; /* -| or |- */
 493     char        xio_type;
 494     char        xio_flags;
 495 };
 496 #define xio_dirp        xio_dirpu.xiou_dirp
 497 #define xio_any         xio_dirpu.xiou_any
 498
 499 #define IOf_ARGV        1       /* this fp iterates over ARGV */
 500 #define IOf_START       2       /* check for null ARGV and substitute '-' */
 501 #define IOf_FLUSH       4       /* this fp wants a flush after write op */
 502 #define IOf_DIDTOP      8       /* just did top of form */
 503 #define IOf_UNTAINT     16      /* consider this fp (and its data) "safe" */
 504 #define IOf_NOLINE      32      /* slurped a pseudo-line from empty file */
 505 #define IOf_FAKE_DIRP   64      /* xio_dirp is fake (source filters kludge) */
 506
 507 /* The following macros define implementation-independent predicates on SVs. */
 508
 509 /*
 510 =for apidoc Am|bool|SvNIOK|SV* sv
 511 Returns a boolean indicating whether the SV contains a number, integer or
 512 double.
 513
 514 =for apidoc Am|bool|SvNIOKp|SV* sv
 515 Returns a boolean indicating whether the SV contains a number, integer or
 516 double.  Checks the B<private> setting.  Use C<SvNIOK>.
 517
 518 =for apidoc Am|void|SvNIOK_off|SV* sv
 519 Unsets the NV/IV status of an SV.
 520
 521 =for apidoc Am|bool|SvOK|SV* sv
 522 Returns a boolean indicating whether the value is an SV. It also tells
 523 whether the value is defined or not.
 524
 525 =for apidoc Am|bool|SvIOKp|SV* sv
 526 Returns a boolean indicating whether the SV contains an integer.  Checks
 527 the B<private> setting.  Use C<SvIOK>.
 528
 529 =for apidoc Am|bool|SvNOKp|SV* sv
 530 Returns a boolean indicating whether the SV contains a double.  Checks the
 531 B<private> setting.  Use C<SvNOK>.
 532
 533 =for apidoc Am|bool|SvPOKp|SV* sv
 534 Returns a boolean indicating whether the SV contains a character string.
 535 Checks the B<private> setting.  Use C<SvPOK>.
 536
 537 =for apidoc Am|bool|SvIOK|SV* sv
 538 Returns a boolean indicating whether the SV contains an integer.
 539
 540 =for apidoc Am|void|SvIOK_on|SV* sv
 541 Tells an SV that it is an integer.
 542
 543 =for apidoc Am|void|SvIOK_off|SV* sv
 544 Unsets the IV status of an SV.
 545
 546 =for apidoc Am|void|SvIOK_only|SV* sv
 547 Tells an SV that it is an integer and disables all other OK bits.
 548
 549 =for apidoc Am|void|SvIOK_only_UV|SV* sv
 550 Tells and SV that it is an unsigned integer and disables all other OK bits.
 551
 552 =for apidoc Am|bool|SvIOK_UV|SV* sv
 553 Returns a boolean indicating whether the SV contains an unsigned integer.
 554
 555 =for apidoc Am|void|SvUOK|SV* sv
 556 Returns a boolean indicating whether the SV contains an unsigned integer.
 557
 558 =for apidoc Am|bool|SvIOK_notUV|SV* sv
 559 Returns a boolean indicating whether the SV contains a signed integer.
 560
 561 =for apidoc Am|bool|SvNOK|SV* sv
 562 Returns a boolean indicating whether the SV contains a double.
 563
 564 =for apidoc Am|void|SvNOK_on|SV* sv
 565 Tells an SV that it is a double.
 566
 567 =for apidoc Am|void|SvNOK_off|SV* sv
 568 Unsets the NV status of an SV.
 569
 570 =for apidoc Am|void|SvNOK_only|SV* sv
 571 Tells an SV that it is a double and disables all other OK bits.
 572
 573 =for apidoc Am|bool|SvPOK|SV* sv
 574 Returns a boolean indicating whether the SV contains a character
 575 string.
 576
 577 =for apidoc Am|void|SvPOK_on|SV* sv
 578 Tells an SV that it is a string.
 579
 580 =for apidoc Am|void|SvPOK_off|SV* sv
 581 Unsets the PV status of an SV.
 582
 583 =for apidoc Am|void|SvPOK_only|SV* sv
 584 Tells an SV that it is a string and disables all other OK bits.
 585 Will also turn off the UTF-8 status.
 586
 587 =for apidoc Am|bool|SvVOK|SV* sv
 588 Returns a boolean indicating whether the SV contains a v-string.
 589
 590 =for apidoc Am|bool|SvOOK|SV* sv
 591 Returns a boolean indicating whether the SvIVX is a valid offset value for
 592 the SvPVX.  This hack is used internally to speed up removal of characters
 593 from the beginning of a SvPV.  When SvOOK is true, then the start of the
 594 allocated string buffer is really (SvPVX - SvIVX).
 595
 596 =for apidoc Am|bool|SvROK|SV* sv
 597 Tests if the SV is an RV.
 598
 599 =for apidoc Am|void|SvROK_on|SV* sv
 600 Tells an SV that it is an RV.
 601
 602 =for apidoc Am|void|SvROK_off|SV* sv
 603 Unsets the RV status of an SV.
 604
 605 =for apidoc Am|SV*|SvRV|SV* sv
 606 Dereferences an RV to return the SV.
 607
 608 =for apidoc Am|IV|SvIVX|SV* sv
 609 Returns the raw value in the SV's IV slot, without checks or conversions.
 610 Only use when you are sure SvIOK is true. See also C<SvIV()>.
 611
 612 =for apidoc Am|UV|SvUVX|SV* sv
 613 Returns the raw value in the SV's UV slot, without checks or conversions.
 614 Only use when you are sure SvIOK is true. See also C<SvUV()>.
 615
 616 =for apidoc Am|NV|SvNVX|SV* sv
 617 Returns the raw value in the SV's NV slot, without checks or conversions.
 618 Only use when you are sure SvNOK is true. See also C<SvNV()>.
 619
 620 =for apidoc Am|char*|SvPVX|SV* sv
 621 Returns a pointer to the physical string in the SV.  The SV must contain a
 622 string.
 623
 624 =for apidoc Am|STRLEN|SvCUR|SV* sv
 625 Returns the length of the string which is in the SV.  See C<SvLEN>.
 626
 627 =for apidoc Am|STRLEN|SvLEN|SV* sv
 628 Returns the size of the string buffer in the SV, not including any part
 629 attributable to C<SvOOK>.  See C<SvCUR>.
 630
 631 =for apidoc Am|char*|SvEND|SV* sv
 632 Returns a pointer to the last character in the string which is in the SV.
 633 See C<SvCUR>.  Access the character as *(SvEND(sv)).
 634
 635 =for apidoc Am|HV*|SvSTASH|SV* sv
 636 Returns the stash of the SV.
 637
 638 =for apidoc Am|void|SvIV_set|SV* sv|IV val
 639 Set the value of the IV pointer in sv to val.  It is possible to perform
 640 the same function of this macro with an lvalue assignment to C<SvIVX>.
 641 With future Perls, however, it will be more efficient to use
 642 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
 643
 644 =for apidoc Am|void|SvNV_set|SV* sv|NV val
 645 Set the value of the NV pointer in sv to val.  See C<SvIV_set>.
 646
 647 =for apidoc Am|void|SvPV_set|SV* sv|char* val
 648 Set the value of the PV pointer in sv to val.  See C<SvIV_set>.
 649
 650 =for apidoc Am|void|SvUV_set|SV* sv|UV val
 651 Set the value of the UV pointer in sv to val.  See C<SvIV_set>.
 652
 653 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
 654 Set the value of the RV pointer in sv to val.  See C<SvIV_set>.
 655
 656 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
 657 Set the value of the MAGIC pointer in sv to val.  See C<SvIV_set>.
 658
 659 =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
 660 Set the value of the STASH pointer in sv to val.  See C<SvIV_set>.
 661
 662 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
 663 Set the current length of the string which is in the SV.  See C<SvCUR>
 664 and C<SvIV_set>.
 665
 666 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
 667 Set the actual length of the string which is in the SV.  See C<SvIV_set>.
 668
 669 =cut
 670 */
 671
 672 #define SvNIOK(sv)              (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
 673 #define SvNIOKp(sv)             (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
 674 #define SvNIOK_off(sv)          (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
 675                                                   SVp_IOK|SVp_NOK|SVf_IVisUV))
 676
 677 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 678 #define assert_not_ROK(sv)      ({assert(!SvROK(sv) || !SvRV(sv));}),
 679 #else
 680 #define assert_not_ROK(sv)
 681 #endif
 682
 683 #define SvOK(sv)                (SvFLAGS(sv) & SVf_OK)
 684 #define SvOK_off(sv)            (assert_not_ROK(sv)                     \
 685                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
 686                                                   SVf_IVisUV|SVf_UTF8), \
 687                                                         SvOOK_off(sv))
 688 #define SvOK_off_exc_UV(sv)     (assert_not_ROK(sv)                     \
 689                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
 690                                                   SVf_UTF8),            \
 691                                                         SvOOK_off(sv))
 692
 693 #define SvOKp(sv)               (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
 694 #define SvIOKp(sv)              (SvFLAGS(sv) & SVp_IOK)
 695 #define SvIOKp_on(sv)           (SvRELEASE_IVX(sv), \
 696                                     SvFLAGS(sv) |= SVp_IOK)
 697 #define SvNOKp(sv)              (SvFLAGS(sv) & SVp_NOK)
 698 #define SvNOKp_on(sv)           (SvFLAGS(sv) |= SVp_NOK)
 699 #define SvPOKp(sv)              (SvFLAGS(sv) & SVp_POK)
 700 #define SvPOKp_on(sv)           (assert_not_ROK(sv)                     \
 701                                  SvFLAGS(sv) |= SVp_POK)
 702
 703 #define SvIOK(sv)               (SvFLAGS(sv) & SVf_IOK)
 704 #define SvIOK_on(sv)            (SvRELEASE_IVX(sv), \
 705                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 706 #define SvIOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
 707 #define SvIOK_only(sv)          (SvOK_off(sv), \
 708                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 709 #define SvIOK_only_UV(sv)       (SvOK_off_exc_UV(sv), \
 710                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 711
 712 #define SvIOK_UV(sv)            ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
 713                                  == (SVf_IOK|SVf_IVisUV))
 714 #define SvUOK(sv)               SvIOK_UV(sv)
 715 #define SvIOK_notUV(sv)         ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
 716                                  == SVf_IOK)
 717
 718 #define SvIsUV(sv)              (SvFLAGS(sv) & SVf_IVisUV)
 719 #define SvIsUV_on(sv)           (SvFLAGS(sv) |= SVf_IVisUV)
 720 #define SvIsUV_off(sv)          (SvFLAGS(sv) &= ~SVf_IVisUV)
 721
 722 #define SvNOK(sv)               (SvFLAGS(sv) & SVf_NOK)
 723 #define SvNOK_on(sv)            (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
 724 #define SvNOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
 725 #define SvNOK_only(sv)          (SvOK_off(sv), \
 726                                     SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
 727
 728 /*
 729 =for apidoc Am|bool|SvUTF8|SV* sv
 730 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
 731
 732 =for apidoc Am|void|SvUTF8_on|SV *sv
 733 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
 734 Do not use frivolously.
 735
 736 =for apidoc Am|void|SvUTF8_off|SV *sv
 737 Unsets the UTF-8 status of an SV.
 738
 739 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
 740 Tells an SV that it is a string and disables all other OK bits,
 741 and leaves the UTF-8 status as it was.
 742
 743 =cut
 744  */
 745
 746 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
 747 in gv.h: */
 748 #define SvUTF8(sv)              (SvFLAGS(sv) & SVf_UTF8)
 749 #define SvUTF8_on(sv)           (SvFLAGS(sv) |= (SVf_UTF8))
 750 #define SvUTF8_off(sv)          (SvFLAGS(sv) &= ~(SVf_UTF8))
 751
 752 #define SvPOK(sv)               (SvFLAGS(sv) & SVf_POK)
 753 #define SvPOK_on(sv)            (assert_not_ROK(sv)                     \
 754                                  SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 755 #define SvPOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
 756 #define SvPOK_only(sv)          (assert_not_ROK(sv)                     \
 757                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
 758                                                   SVf_IVisUV|SVf_UTF8), \
 759                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 760 #define SvPOK_only_UTF8(sv)     (assert_not_ROK(sv)                     \
 761                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
 762                                                   SVf_IVisUV),          \
 763                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 764
 765 #define SvVOK(sv)               (SvMAGICAL(sv) && mg_find(sv,'V'))
 766 #define SvOOK(sv)               (SvFLAGS(sv) & SVf_OOK)
 767 #define SvOOK_on(sv)            ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
 768 #define SvOOK_off(sv)           ((void)(SvOOK(sv) && sv_backoff(sv)))
 769
 770 #define SvFAKE(sv)              (SvFLAGS(sv) & SVf_FAKE)
 771 #define SvFAKE_on(sv)           (SvFLAGS(sv) |= SVf_FAKE)
 772 #define SvFAKE_off(sv)          (SvFLAGS(sv) &= ~SVf_FAKE)
 773
 774 #define SvROK(sv)               (SvFLAGS(sv) & SVf_ROK)
 775 #define SvROK_on(sv)            (SvFLAGS(sv) |= SVf_ROK)
 776 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
 777
 778 #define SvMAGICAL(sv)           (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
 779 #define SvMAGICAL_on(sv)        (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
 780 #define SvMAGICAL_off(sv)       (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
 781
 782 #define SvGMAGICAL(sv)          (SvFLAGS(sv) & SVs_GMG)
 783 #define SvGMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_GMG)
 784 #define SvGMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_GMG)
 785
 786 #define SvSMAGICAL(sv)          (SvFLAGS(sv) & SVs_SMG)
 787 #define SvSMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_SMG)
 788 #define SvSMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_SMG)
 789
 790 #define SvRMAGICAL(sv)          (SvFLAGS(sv) & SVs_RMG)
 791 #define SvRMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_RMG)
 792 #define SvRMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_RMG)
 793
 794 #define SvAMAGIC(sv)            (SvFLAGS(sv) & SVf_AMAGIC)
 795 #define SvAMAGIC_on(sv)         (SvFLAGS(sv) |= SVf_AMAGIC)
 796 #define SvAMAGIC_off(sv)        (SvFLAGS(sv) &= ~SVf_AMAGIC)
 797
 798 #define SvGAMAGIC(sv)           (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
 799
 800 /*
 801 #define Gv_AMG(stash) \
 802         (HV_AMAGICmb(stash) && \
 803          ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
 804 */
 805 #define Gv_AMG(stash)           (PL_amagic_generation && Gv_AMupdate(stash))
 806
 807 #define SvWEAKREF(sv)           ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
 808                                   == (SVf_ROK|SVprv_WEAKREF))
 809 #define SvWEAKREF_on(sv)        (SvFLAGS(sv) |=  (SVf_ROK|SVprv_WEAKREF))
 810 #define SvWEAKREF_off(sv)       (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
 811
 812 #define SvTHINKFIRST(sv)        (SvFLAGS(sv) & SVf_THINKFIRST)
 813
 814 #define SvPADSTALE(sv)          (SvFLAGS(sv) & SVs_PADSTALE)
 815 #define SvPADSTALE_on(sv)       (SvFLAGS(sv) |= SVs_PADSTALE)
 816 #define SvPADSTALE_off(sv)      (SvFLAGS(sv) &= ~SVs_PADSTALE)
 817
 818 #define SvPADTMP(sv)            (SvFLAGS(sv) & SVs_PADTMP)
 819 #define SvPADTMP_on(sv)         (SvFLAGS(sv) |= SVs_PADTMP)
 820 #define SvPADTMP_off(sv)        (SvFLAGS(sv) &= ~SVs_PADTMP)
 821
 822 #define SvPADMY(sv)             (SvFLAGS(sv) & SVs_PADMY)
 823 #define SvPADMY_on(sv)          (SvFLAGS(sv) |= SVs_PADMY)
 824
 825 #define SvTEMP(sv)              (SvFLAGS(sv) & SVs_TEMP)
 826 #define SvTEMP_on(sv)           (SvFLAGS(sv) |= SVs_TEMP)
 827 #define SvTEMP_off(sv)          (SvFLAGS(sv) &= ~SVs_TEMP)
 828
 829 #define SvOBJECT(sv)            (SvFLAGS(sv) & SVs_OBJECT)
 830 #define SvOBJECT_on(sv)         (SvFLAGS(sv) |= SVs_OBJECT)
 831 #define SvOBJECT_off(sv)        (SvFLAGS(sv) &= ~SVs_OBJECT)
 832
 833 #define SvREADONLY(sv)          (SvFLAGS(sv) & SVf_READONLY)
 834 #define SvREADONLY_on(sv)       (SvFLAGS(sv) |= SVf_READONLY)
 835 #define SvREADONLY_off(sv)      (SvFLAGS(sv) &= ~SVf_READONLY)
 836
 837 #define SvSCREAM(sv)            (SvFLAGS(sv) & SVp_SCREAM)
 838 #define SvSCREAM_on(sv)         (SvFLAGS(sv) |= SVp_SCREAM)
 839 #define SvSCREAM_off(sv)        (SvFLAGS(sv) &= ~SVp_SCREAM)
 840
 841 #define SvCOMPILED(sv)          (SvFLAGS(sv) & SVpfm_COMPILED)
 842 #define SvCOMPILED_on(sv)       (SvFLAGS(sv) |= SVpfm_COMPILED)
 843 #define SvCOMPILED_off(sv)      (SvFLAGS(sv) &= ~SVpfm_COMPILED)
 844
 845 #define SvEVALED(sv)            (SvFLAGS(sv) & SVrepl_EVAL)
 846 #define SvEVALED_on(sv)         (SvFLAGS(sv) |= SVrepl_EVAL)
 847 #define SvEVALED_off(sv)        (SvFLAGS(sv) &= ~SVrepl_EVAL)
 848
 849 #define SvTAIL(sv)              (SvFLAGS(sv) & SVpbm_TAIL)
 850 #define SvTAIL_on(sv)           (SvFLAGS(sv) |= SVpbm_TAIL)
 851 #define SvTAIL_off(sv)          (SvFLAGS(sv) &= ~SVpbm_TAIL)
 852
 853 #define SvVALID(sv)             (SvFLAGS(sv) & SVpbm_VALID)
 854 #define SvVALID_on(sv)          (SvFLAGS(sv) |= SVpbm_VALID)
 855 #define SvVALID_off(sv)         (SvFLAGS(sv) &= ~SVpbm_VALID)
 856
 857 #ifdef USE_ITHREADS
 858 /* The following uses the FAKE flag to show that a regex pointer is infact
 859    its own offset in the regexpad for ithreads */
 860 #define SvREPADTMP(sv)          (SvFLAGS(sv) & SVf_FAKE)
 861 #define SvREPADTMP_on(sv)       (SvFLAGS(sv) |= SVf_FAKE)
 862 #define SvREPADTMP_off(sv)      (SvFLAGS(sv) &= ~SVf_FAKE)
 863 #endif
 864
 865 #ifdef PERL_DEBUG_COW
 866 #define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
 867 #else
 868 #define SvRV(sv) ((sv)->sv_u.svu_rv)
 869 #endif
 870 #define SvRVx(sv) SvRV(sv)
 871
 872 #ifdef PERL_DEBUG_COW
 873 #define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
 874 #define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
 875 #define SvNVX(sv) (0 + ((XPVNV*) SvANY(sv))->xnv_nv)
 876 #if PERL_DEBUG_COW > 1
 877 #define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
 878 #else
 879 #define SvPVX(sv) SvPVX_mutable(sv)
 880 #endif
 881 #define SvPVX_mutable(sv)       (0 + (sv)->sv_u.svu_pv)
 882 #define SvPVX_const(sv) ((const char*)(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 SvPVX_mutable(sv)       SvPVX(sv)
 909 #define SvPVX_const(sv) ((const char*)SvPVX(sv))
 910 #define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
 911 #define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
 912 #define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
 913
 914 #ifdef DEBUGGING
 915 #define SvMAGIC(sv)     (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_magic))
 916 #define SvSTASH(sv)     (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_stash))
 917 #else
 918 #define SvMAGIC(sv)     ((XPVMG*)  SvANY(sv))->xmg_magic
 919 #define SvSTASH(sv)     ((XPVMG*)  SvANY(sv))->xmg_stash
 920 #endif
 921
 922 #endif
 923
 924 #define SvIVXx(sv) SvIVX(sv)
 925 #define SvUVXx(sv) SvUVX(sv)
 926 #define SvNVXx(sv) SvNVX(sv)
 927 #define SvPVXx(sv) SvPVX(sv)
 928 #define SvLENx(sv) SvLEN(sv)
 929 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
 930
 931
 932 /* Ask a scalar nicely to try to become an IV, if possible.
 933    Not guaranteed to stay returning void */
 934 /* Macro won't actually call sv_2iv if already IOK */
 935 #define SvIV_please(sv) \
 936         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
 937                 (void) SvIV(sv); } STMT_END
 938 #define SvIV_set(sv, val) \
 939         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
 940                 (((XPVIV*)  SvANY(sv))->xiv_iv = (val)); } STMT_END
 941 #define SvNV_set(sv, val) \
 942         STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
 943                 (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END
 944 #define SvPV_set(sv, val) \
 945         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
 946                 ((sv)->sv_u.svu_pv = (val)); } STMT_END
 947 #define SvUV_set(sv, val) \
 948         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
 949                 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
 950 #define SvRV_set(sv, val) \
 951         STMT_START { assert(SvTYPE(sv) >=  SVt_RV); \
 952                 ((sv)->sv_u.svu_rv = (val)); } STMT_END
 953 #define SvMAGIC_set(sv, val) \
 954         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
 955                 (((XPVMG*)SvANY(sv))->xmg_magic = (val)); } STMT_END
 956 #define SvSTASH_set(sv, val) \
 957         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
 958                 (((XPVMG*)  SvANY(sv))->xmg_stash = (val)); } STMT_END
 959 #define SvCUR_set(sv, val) \
 960         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
 961                 (((XPV*)  SvANY(sv))->xpv_cur = (val)); } STMT_END
 962 #define SvLEN_set(sv, val) \
 963         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
 964                 (((XPV*)  SvANY(sv))->xpv_len = (val)); } STMT_END
 965 #define SvEND_set(sv, val) \
 966         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
 967                 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
 968
 969 #define SvPV_renew(sv,n) \
 970         STMT_START { SvLEN_set(sv, n); \
 971                 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)                 \
 972                                 (char*)saferealloc((Malloc_t)SvPVX(sv), \
 973                                                    (MEM_SIZE)((n)))));  \
 974                  } STMT_END
 975
 976 #define SvPV_shrink_to_cur(sv) STMT_START { \
 977                    const STRLEN _lEnGtH = SvCUR(sv) + 1; \
 978                    SvPV_renew(sv, _lEnGtH); \
 979                  } STMT_END
 980
 981 #define SvPV_free(sv) \
 982         STMT_START { assert(SvTYPE(sv) >= SVt_PV);      \
 983                 if (SvLEN(sv)) {                        \
 984                     if(SvOOK(sv)) {                     \
 985                       Safefree(SvPVX(sv) - SvIVX(sv));  \
 986                       SvFLAGS(sv) &= ~SVf_OOK;          \
 987                     } else {                            \
 988                       Safefree(SvPVX(sv));              \
 989                     }                                   \
 990                 }                                       \
 991         } STMT_END
 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 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1201
1202 #define SvPV_flags(sv, lp, flags) \
1203     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1204      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1205 #define SvPV_flags_const(sv, lp, flags) \
1206     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1207      ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1208      (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1209
1210 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1211 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1212
1213 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1214
1215 #define SvPV_force_flags(sv, lp, flags) \
1216     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1217     ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1218 #define SvPV_force_flags_mutable(sv, lp, flags) \
1219     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1220     ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1221      : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1222
1223 #define SvPV_nolen(sv) \
1224     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1225      ? SvPVX(sv) : sv_2pv_nolen(sv))
1226
1227 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1228
1229 /* ----*/
1230
1231 #define SvPVutf8(sv, lp) \
1232     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1233      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1234
1235 #define SvPVutf8_force(sv, lp) \
1236     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1237      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1238
1239
1240 #define SvPVutf8_nolen(sv) \
1241     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1242      ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
1243
1244 /* ----*/
1245
1246 #define SvPVbyte(sv, lp) \
1247     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1248      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1249
1250 #define SvPVbyte_force(sv, lp) \
1251     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1252      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1253
1254 #define SvPVbyte_nolen(sv) \
1255     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1256      ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
1257
1258
1259
1260 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1261  * var to evaluate the arg once; failing that, use a global if possible;
1262  * failing that, call a function to do the work
1263  */
1264
1265 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1266 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1267 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1268
1269 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1270
1271 #  define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1272 #  define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1273 #  define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1274 #  define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1275 #  define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1276 #  define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1277 #  define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1278 #  define SvTRUE(sv) (                                          \
1279     !sv                                                         \
1280     ? 0                                                         \
1281     :    SvPOK(sv)                                              \
1282         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
1283              nxpv &&                                            \
1284              (nxpv->xpv_cur > 1 ||                              \
1285               (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1286              ? 1                                                \
1287              : 0)                                               \
1288         :                                                       \
1289             SvIOK(sv)                                           \
1290             ? SvIVX(sv) != 0                                    \
1291             :   SvNOK(sv)                                       \
1292                 ? SvNVX(sv) != 0.0                              \
1293                 : sv_2bool(sv) )
1294 #  define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1295
1296 #else /* __GNUC__ */
1297
1298 /* These inlined macros use globals, which will require a thread
1299  * declaration in user code, so we avoid them under threads */
1300
1301 #  define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1302 #  define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1303 #  define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1304 #  define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1305 #  define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1306 #  define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1307 #  define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1308 #  define SvTRUE(sv) (                                          \
1309     !sv                                                         \
1310     ? 0                                                         \
1311     :    SvPOK(sv)                                              \
1312         ?   ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) &&            \
1313              (PL_Xpv->xpv_cur > 1 ||                            \
1314               (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0'))  \
1315              ? 1                                                \
1316              : 0)                                               \
1317         :                                                       \
1318             SvIOK(sv)                                           \
1319             ? SvIVX(sv) != 0                                    \
1320             :   SvNOK(sv)                                       \
1321                 ? SvNVX(sv) != 0.0                              \
1322                 : sv_2bool(sv) )
1323 #  define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1324 #endif /* __GNU__ */
1325
1326 #define SvIsCOW(sv)             ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1327                                     (SVf_FAKE | SVf_READONLY))
1328 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1329
1330 #define SvSHARED_HASH(sv) SvUVX(sv)
1331
1332 /* flag values for sv_*_flags functions */
1333 #define SV_IMMEDIATE_UNREF      1
1334 #define SV_GMAGIC               2
1335 #define SV_COW_DROP_PV          4
1336 #define SV_UTF8_NO_ENCODING     8
1337 #define SV_NOSTEAL              16
1338 #define SV_CONST_RETURN         32
1339 #define SV_MUTABLE_RETURN       64
1340
1341 /* We are about to replace the SV's current value. So if it's copy on write
1342    we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1343    the value is about to get thrown away, so drop the PV rather than go to
1344    the effort of making a read-write copy only for it to get immediately
1345    discarded.  */
1346
1347 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1348                                     sv_force_normal_flags(sv, SV_COW_DROP_PV)
1349
1350 #ifdef PERL_COPY_ON_WRITE
1351 #  define SvRELEASE_IVX(sv)   ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1352                                 && Perl_sv_release_IVX(aTHX_ sv)))
1353 #  define SvIsCOW_normal(sv)    (SvIsCOW(sv) && SvLEN(sv))
1354
1355 #define CAN_COW_MASK    (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1356                          SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1357                          SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1358 #define CAN_COW_FLAGS   (SVp_POK|SVf_POK)
1359
1360 #else
1361 #  define SvRELEASE_IVX(sv)   SvOOK_off(sv)
1362 #endif /* PERL_COPY_ON_WRITE */
1363
1364 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1365                                     sv_force_normal_flags(sv, 0)
1366
1367
1368 /* all these 'functions' are now just macros */
1369
1370 #define sv_pv(sv) SvPV_nolen(sv)
1371 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1372 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1373
1374 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1375 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1376 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1377 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1378 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1379 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1380 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1381 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1382 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1383 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1384 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1385 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1386 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1387 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1388
1389 /* Should be named SvCatPVN_utf8_upgrade? */
1390 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv)    \
1391         STMT_START {                                    \
1392             if (!(nsv))                                 \
1393                 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1394             else                                        \
1395                 sv_setpvn(nsv, sstr, slen);             \
1396             SvUTF8_off(nsv);                            \
1397             sv_utf8_upgrade(nsv);                       \
1398             sv_catsv(dsv, nsv); \
1399         } STMT_END
1400
1401 /*
1402 =for apidoc Am|SV*|newRV_inc|SV* sv
1403
1404 Creates an RV wrapper for an SV.  The reference count for the original SV is
1405 incremented.
1406
1407 =cut
1408 */
1409
1410 #define newRV_inc(sv)   newRV(sv)
1411
1412 /* the following macros update any magic values this sv is associated with */
1413
1414 /*
1415 =head1 Magical Functions
1416
1417 =for apidoc Am|void|SvGETMAGIC|SV* sv
1418 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
1419 argument more than once.
1420
1421 =for apidoc Am|void|SvSETMAGIC|SV* sv
1422 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
1423 argument more than once.
1424
1425 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1426 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
1427 more than once.
1428
1429 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1430 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1431 ssv. May evaluate arguments more than once.
1432
1433 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1434 Like C<SvSetSV>, but does any set magic required afterwards.
1435
1436 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1437 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1438
1439 =for apidoc Am|void|SvSHARE|SV* sv
1440 Arranges for sv to be shared between threads if a suitable module
1441 has been loaded.
1442
1443 =for apidoc Am|void|SvLOCK|SV* sv
1444 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1445 has been loaded.
1446
1447 =for apidoc Am|void|SvUNLOCK|SV* sv
1448 Releases a mutual exclusion lock on sv if a suitable module
1449 has been loaded.
1450
1451 =head1 SV Manipulation Functions
1452
1453 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1454 Expands the character buffer in the SV so that it has room for the
1455 indicated number of bytes (remember to reserve space for an extra trailing
1456 NUL character).  Calls C<sv_grow> to perform the expansion if necessary.
1457 Returns a pointer to the character buffer.
1458
1459 =cut
1460 */
1461
1462 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1463 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1464 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1465
1466 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1467 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1468
1469 #define SvSetSV_and(dst,src,finally) \
1470         STMT_START {                                    \
1471             if ((dst) != (src)) {                       \
1472                 sv_setsv(dst, src);                     \
1473                 finally;                                \
1474             }                                           \
1475         } STMT_END
1476 #define SvSetSV_nosteal_and(dst,src,finally) \
1477         STMT_START {                                    \
1478             if ((dst) != (src)) {                       \
1479                 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL);       \
1480                 finally;                                \
1481             }                                           \
1482         } STMT_END
1483
1484 #define SvSetSV(dst,src) \
1485                 SvSetSV_and(dst,src,/*nothing*/;)
1486 #define SvSetSV_nosteal(dst,src) \
1487                 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1488
1489 #define SvSetMagicSV(dst,src) \
1490                 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1491 #define SvSetMagicSV_nosteal(dst,src) \
1492                 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1493
1494
1495 #if !defined(SKIP_DEBUGGING)
1496 #define SvPEEK(sv) sv_peek(sv)
1497 #else
1498 #define SvPEEK(sv) ""
1499 #endif
1500
1501 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1502
1503 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1504
1505 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1506
1507 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1508 #define Sv_Grow sv_grow
1509
1510 #define CLONEf_COPY_STACKS 1
1511 #define CLONEf_KEEP_PTR_TABLE 2
1512 #define CLONEf_CLONE_HOST 4
1513 #define CLONEf_JOIN_IN 8
1514
1515 struct clone_params {
1516   AV* stashes;
1517   UV  flags;
1518   PerlInterpreter *proto_perl;
1519 };
1520
1521 /*
1522  * Local variables:
1523  * c-indentation-style: bsd
1524  * c-basic-offset: 4
1525  * indent-tabs-mode: t
1526  * End:
1527  *
1528  * ex: set ts=8 sts=4 sw=4 noet:
1529  */