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