sv.h

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