sv.h

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