sv.h

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