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