sv.h

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