sv.h

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