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, 2006, 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         SVt_LAST        /* keep last in enum. used to size arrays */
  64 } svtype;
  65
  66 /* There is collusion here with sv_clear - sv_clear exits early for SVt_NULL
  67    and SVt_IV, so never reaches the clause at the end that uses
  68    sv_type_details->body_size to determine whether to call safefree(). Hence
  69    body_size can be set no-zero to record the size of PTEs and HEs, without
  70    fear of bogus frees.  */
  71 #ifdef PERL_IN_SV_C
  72 #define PTE_SVSLOT      SVt_IV
  73 #endif
  74 #if defined(PERL_IN_HV_C) || defined(PERL_IN_XS_APITEST)
  75 #define HE_SVSLOT       SVt_NULL
  76 #endif
  77
  78 #define PERL_ARENA_ROOTS_SIZE   (SVt_LAST)
  79
  80 /* typedefs to eliminate some typing */
  81 typedef struct he HE;
  82 typedef struct hek HEK;
  83
  84 /* Using C's structural equivalence to help emulate C++ inheritance here... */
  85
  86 /* start with 2 sv-head building blocks */
  87 #define _SV_HEAD(ptrtype) \
  88     ptrtype     sv_any;         /* pointer to body */   \
  89     U32         sv_refcnt;      /* how many references to us */ \
  90     U32         sv_flags        /* what we are */
  91
  92 #define _SV_HEAD_UNION \
  93     union {                             \
  94         IV      svu_iv;                 \
  95         UV      svu_uv;                 \
  96         SV*     svu_rv;         /* pointer to another SV */             \
  97         char*   svu_pv;         /* pointer to malloced string */        \
  98         SV**    svu_array;              \
  99         HE**    svu_hash;               \
 100     }   sv_u
 101
 102
 103 struct STRUCT_SV {              /* struct sv { */
 104     _SV_HEAD(void*);
 105     _SV_HEAD_UNION;
 106 #ifdef DEBUG_LEAKING_SCALARS
 107     unsigned    sv_debug_optype:9;      /* the type of OP that allocated us */
 108     unsigned    sv_debug_inpad:1;       /* was allocated in a pad for an OP */
 109     unsigned    sv_debug_cloned:1;      /* was cloned for an ithread */
 110     unsigned    sv_debug_line:16;       /* the line where we were allocated */
 111     char *      sv_debug_file;          /* the file where we were allocated */
 112 #endif
 113 };
 114
 115 struct gv {
 116     _SV_HEAD(XPVGV*);           /* pointer to xpvgv body */
 117     _SV_HEAD_UNION;
 118 };
 119
 120 struct cv {
 121     _SV_HEAD(XPVCV*);           /* pointer to xpvcv body */
 122     _SV_HEAD_UNION;
 123 };
 124
 125 struct av {
 126     _SV_HEAD(XPVAV*);           /* pointer to xpvav body */
 127     _SV_HEAD_UNION;
 128 };
 129
 130 struct hv {
 131     _SV_HEAD(XPVHV*);           /* pointer to xpvhv body */
 132     _SV_HEAD_UNION;
 133 };
 134
 135 struct io {
 136     _SV_HEAD(XPVIO*);           /* pointer to xpvio body */
 137     _SV_HEAD_UNION;
 138 };
 139
 140 #undef _SV_HEAD
 141 #undef _SV_HEAD_UNION           /* ensure no pollution */
 142
 143 /*
 144 =head1 SV Manipulation Functions
 145
 146 =for apidoc Am|U32|SvREFCNT|SV* sv
 147 Returns the value of the object's reference count.
 148
 149 =for apidoc Am|SV*|SvREFCNT_inc|SV* sv
 150 Increments the reference count of the given SV.
 151
 152 =for apidoc Am|void|SvREFCNT_dec|SV* sv
 153 Decrements the reference count of the given SV.
 154
 155 =for apidoc Am|svtype|SvTYPE|SV* sv
 156 Returns the type of the SV.  See C<svtype>.
 157
 158 =for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
 159 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to
 160 perform the upgrade if necessary.  See C<svtype>.
 161
 162 =cut
 163 */
 164
 165 #define SvANY(sv)       (sv)->sv_any
 166 #define SvFLAGS(sv)     (sv)->sv_flags
 167 #define SvREFCNT(sv)    (sv)->sv_refcnt
 168
 169 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
 170 #  define SvREFCNT_inc(sv)              \
 171     ({                                  \
 172         SV * const _sv = (SV*)(sv);     \
 173         if (_sv)                        \
 174              (SvREFCNT(_sv))++;         \
 175         _sv;                            \
 176     })
 177 #else
 178 #  define SvREFCNT_inc(sv)      \
 179         ((PL_Sv=(SV*)(sv)) ? ((++(SvREFCNT(PL_Sv))),(PL_Sv)) : NULL)
 180 #endif
 181
 182 #if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
 183 #  define SvREFCNT_dec(sv)              \
 184     ({                                  \
 185         SV * const _sv = (SV*)(sv);     \
 186         if (_sv) {                      \
 187             if (SvREFCNT(_sv)) {        \
 188                 if (--(SvREFCNT(_sv)) == 0) \
 189                     Perl_sv_free2(aTHX_ _sv);   \
 190             } else {                    \
 191                 sv_free(_sv);           \
 192             }                           \
 193         }                               \
 194     })
 195 #else
 196 #define SvREFCNT_dec(sv)        sv_free((SV*)(sv))
 197 #endif
 198
 199 #define SVTYPEMASK      0xff
 200 #define SvTYPE(sv)      ((sv)->sv_flags & SVTYPEMASK)
 201
 202 /* Sadly there are some parts of the core that have pointers to already-freed
 203    SV heads, and rely on being able to tell that they are now free. So mark
 204    them all by using a consistent macro.  */
 205 #define SvIS_FREED(sv)  ((sv)->sv_flags == SVTYPEMASK)
 206
 207 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
 208
 209 #define SVf_IOK         0x00000100      /* has valid public integer value */
 210 #define SVf_NOK         0x00000200      /* has valid public numeric value */
 211 #define SVf_POK         0x00000400      /* has valid public pointer value */
 212 #define SVf_ROK         0x00000800      /* has a valid reference pointer */
 213
 214 #define SVp_IOK         0x00001000      /* has valid non-public integer value */
 215 #define SVp_NOK         0x00002000      /* has valid non-public numeric value */
 216 #define SVp_POK         0x00004000      /* has valid non-public pointer value */
 217 #define SVp_SCREAM      0x00008000      /* has been studied? */
 218 #define SVphv_CLONEABLE 0x00008000      /* PVHV (stashes) clone its objects */
 219
 220 #define SVs_PADSTALE    0x00010000      /* lexical has gone out of scope */
 221 #define SVs_PADTMP      0x00020000      /* in use as tmp */
 222 #define SVpad_TYPED     0x00020000      /* pad name is a Typed Lexical */
 223 #define SVs_PADMY       0x00040000      /* in use a "my" variable */
 224 #define SVpad_OUR       0x00040000      /* pad name is "our" instead of "my" */
 225 #define SVs_TEMP        0x00080000      /* string is stealable? */
 226 #define SVs_OBJECT      0x00100000      /* is "blessed" */
 227 #define SVs_GMG         0x00200000      /* has magical get method */
 228 #define SVs_SMG         0x00400000      /* has magical set method */
 229 #define SVs_RMG         0x00800000      /* has random magical methods */
 230
 231 #define SVf_FAKE        0x01000000      /* 0: glob or lexical is just a copy
 232                                            1: SV head arena wasn't malloc()ed
 233                                            2: in conjunction with SVf_READONLY
 234                                               marks a shared hash key scalar
 235                                               (SvLEN == 0) or a copy on write
 236                                               string (SvLEN != 0) [SvIsCOW(sv)]
 237                                            3: For PVCV, whether CvUNIQUE(cv)
 238                                               refers to an eval or once only
 239                                               [CvEVAL(cv), CvSPECIAL(cv)]
 240                                            4: Whether the regexp pointer is in
 241                                               fact an offset [SvREPADTMP(sv)]
 242                                            5: On a pad name SV, that slot in the
 243                                               frame AV is a REFCNT'ed reference
 244                                               to a lexical from "outside".
 245                                         */
 246 #define SVf_OOK         0x02000000      /* has valid offset value
 247                                            For a PVHV this means that a
 248                                            hv_aux struct is present after the
 249                                            main array  */
 250 #define SVf_BREAK       0x04000000      /* refcnt is artificially low - used
 251                                          * by SV's in final arena  cleanup */
 252 #define SVf_READONLY    0x08000000      /* may not be modified */
 253
 254
 255
 256
 257 #define SVf_THINKFIRST  (SVf_READONLY|SVf_ROK|SVf_FAKE)
 258
 259 #define SVf_OK          (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
 260                          SVp_IOK|SVp_NOK|SVp_POK|SVp_SCREAM)
 261
 262 #define PRIVSHIFT 4     /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
 263
 264 #define SVf_AMAGIC      0x10000000      /* has magical overloaded methods */
 265 #define SVf_UTF8        0x20000000      /* SvPV is UTF-8 encoded */
 266 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
 267
 268 /* Some private flags. */
 269
 270 /* PVHV */
 271 #define SVphv_REHASH    0x10000000      /* PVHV is recalculating hash values */
 272 /* PVHV */
 273 #define SVphv_SHAREKEYS 0x20000000      /* PVHV
 274                                            keys live on shared string table */
 275 /* PVNV, PVMG, PVGV, presumably only inside pads */
 276 #define SVpad_NAME      0x40000000      /* This SV is a name in the PAD, so
 277                                            SVpad_TYPED and SVpad_OUR apply */
 278 /* PVAV */
 279 #define SVpav_REAL      0x40000000      /* free old entries */
 280 /* PVHV */
 281 #define SVphv_LAZYDEL   0x40000000      /* entry in xhv_eiter must be deleted */
 282 /* PVBM */
 283 #define SVpbm_TAIL      0x40000000
 284 /* ??? */
 285 #define SVrepl_EVAL     0x40000000      /* Replacement part of s///e */
 286
 287 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV  */
 288 /* Presumably IVs aren't stored in pads */
 289 #define SVf_IVisUV      0x80000000      /* use XPVUV instead of XPVIV */
 290 /* PVAV */
 291 #define SVpav_REIFY     0x80000000      /* can become real */
 292 /* PVHV */
 293 #define SVphv_HASKFLAGS 0x80000000      /* keys have flag byte after hash */
 294 /* PVFM */
 295 #define SVpfm_COMPILED  0x80000000      /* FORMLINE is compiled */
 296 /* PVBM */
 297 #define SVpbm_VALID     0x80000000
 298 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive  */
 299 #define SVprv_WEAKREF   0x80000000      /* Weak reference */
 300
 301
 302 struct xpv {
 303     NV          xnv_nv;         /* numeric value, if any */
 304     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 305     STRLEN      xpv_len;        /* allocated size */
 306 };
 307
 308 #if 0
 309 typedef struct xpv xpv_allocated;
 310 #else
 311 typedef struct {
 312     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 313     STRLEN      xpv_len;        /* allocated size */
 314 } xpv_allocated;
 315 #endif
 316
 317 struct xpviv {
 318     NV          xnv_nv;         /* numeric value, if any */
 319     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 320     STRLEN      xpv_len;        /* allocated size */
 321     union {
 322         IV      xivu_iv;        /* integer value or pv offset */
 323         UV      xivu_uv;
 324         void *  xivu_p1;
 325         I32     xivu_i32;
 326     }           xiv_u;
 327 };
 328
 329 #if 0
 330 typedef struct xpviv xpviv_allocated;
 331 #else
 332 typedef struct {
 333     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 334     STRLEN      xpv_len;        /* allocated size */
 335     union {
 336         IV      xivu_iv;        /* integer value or pv offset */
 337         UV      xivu_uv;
 338         void *  xivu_p1;
 339         I32     xivu_i32;
 340     }           xiv_u;
 341 } xpviv_allocated;
 342 #endif
 343
 344 #define xiv_iv xiv_u.xivu_iv
 345
 346 struct xpvuv {
 347     NV          xnv_nv;         /* numeric value, if any */
 348     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 349     STRLEN      xpv_len;        /* allocated size */
 350     union {
 351         IV      xuvu_iv;
 352         UV      xuvu_uv;        /* unsigned value or pv offset */
 353         void *  xuvu_p1;
 354     }           xuv_u;
 355 };
 356
 357 #define xuv_uv xuv_u.xuvu_uv
 358
 359 struct xpvnv {
 360     NV          xnv_nv;         /* numeric value, if any */
 361     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 362     STRLEN      xpv_len;        /* allocated size */
 363     union {
 364         IV      xivu_iv;        /* integer value or pv offset */
 365         UV      xivu_uv;
 366         void *  xivu_p1;
 367         I32     xivu_i32;
 368     }           xiv_u;
 369 };
 370
 371 /* These structure must match the beginning of struct xpvhv in hv.h. */
 372 struct xpvmg {
 373     NV          xnv_nv;         /* numeric value, if any */
 374     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 375     STRLEN      xpv_len;        /* allocated size */
 376     union {
 377         IV      xivu_iv;        /* integer value or pv offset */
 378         UV      xivu_uv;
 379         void *  xivu_p1;
 380         I32     xivu_i32;
 381     }           xiv_u;
 382     MAGIC*      xmg_magic;      /* linked list of magicalness */
 383     HV*         xmg_stash;      /* class package */
 384 };
 385
 386 struct xpvlv {
 387     NV          xnv_nv;         /* numeric value, if any */
 388     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 389     STRLEN      xpv_len;        /* allocated size */
 390     union {
 391         IV      xivu_iv;        /* integer value or pv offset */
 392         UV      xivu_uv;
 393         void *  xivu_p1;
 394         I32     xivu_i32;
 395     }           xiv_u;
 396     MAGIC*      xmg_magic;      /* linked list of magicalness */
 397     HV*         xmg_stash;      /* class package */
 398
 399     /* a full glob fits into this */
 400     GP*         xgv_gp;
 401     char*       xgv_name;
 402     STRLEN      xgv_namelen;
 403     HV*         xgv_stash;
 404     U8          xgv_flags;
 405
 406     STRLEN      xlv_targoff;
 407     STRLEN      xlv_targlen;
 408     SV*         xlv_targ;
 409     char        xlv_type;       /* k=keys .=pos x=substr v=vec /=join/re
 410                                  * y=alem/helem/iter t=tie T=tied HE */
 411 };
 412
 413 struct xpvgv {
 414     NV          xnv_nv;         /* numeric value, if any */
 415     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 416     STRLEN      xpv_len;        /* allocated size */
 417     union {
 418         IV      xivu_iv;        /* integer value or pv offset */
 419         UV      xivu_uv;
 420         void *  xivu_p1;
 421         I32     xivu_i32;
 422     }           xiv_u;
 423     MAGIC*      xmg_magic;      /* linked list of magicalness */
 424     HV*         xmg_stash;      /* class package */
 425
 426     GP*         xgv_gp;
 427     char*       xgv_name;
 428     STRLEN      xgv_namelen;
 429     HV*         xgv_stash;
 430     U8          xgv_flags;
 431 };
 432
 433 struct xpvbm {
 434     NV          xnv_nv;         /* numeric value, if any */
 435     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 436     STRLEN      xpv_len;        /* allocated size */
 437     union {
 438         IV      xivu_iv;        /* integer value or pv offset */
 439         UV      xivu_uv;
 440         void *  xivu_p1;
 441         I32     xivu_i32;
 442     }           xiv_u;
 443     MAGIC*      xmg_magic;      /* linked list of magicalness */
 444     HV*         xmg_stash;      /* class package */
 445
 446     I32         xbm_useful;     /* is this constant pattern being useful? */
 447     U16         xbm_previous;   /* how many characters in string before rare? */
 448     U8          xbm_rare;       /* rarest character in string */
 449 };
 450
 451 /* This structure must match XPVCV in cv.h */
 452
 453 typedef U16 cv_flags_t;
 454
 455 struct xpvfm {
 456     NV          xnv_nv;         /* numeric value, if any */
 457     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 458     STRLEN      xpv_len;        /* allocated size */
 459     union {
 460         IV      xivu_iv;        /* PVFMs use the pv offset */
 461         UV      xivu_uv;
 462         void *  xivu_p1;
 463         I32     xivu_i32;
 464     }           xiv_u;
 465     MAGIC*      xmg_magic;      /* linked list of magicalness */
 466     HV*         xmg_stash;      /* class package */
 467
 468     HV *        xcv_stash;
 469     union {
 470         OP *    xcv_start;
 471         ANY     xcv_xsubany;
 472     }           xcv_start_u;
 473     union {
 474         OP *    xcv_root;
 475         void    (*xcv_xsub) (pTHX_ CV*);
 476     }           xcv_root_u;
 477     GV *        xcv_gv;
 478     char *      xcv_file;
 479     AV *        xcv_padlist;
 480     CV *        xcv_outside;
 481     U32         xcv_outside_seq; /* the COP sequence (at the point of our
 482                                   * compilation) in the lexically enclosing
 483                                   * sub */
 484     cv_flags_t  xcv_flags;
 485     IV          xfm_lines;
 486 };
 487
 488 typedef struct {
 489     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 490     STRLEN      xpv_len;        /* allocated size */
 491     union {
 492         IV      xivu_iv;        /* PVFMs use the pv offset */
 493         UV      xivu_uv;
 494         void *  xivu_p1;
 495         I32     xivu_i32;
 496     }           xiv_u;
 497     MAGIC*      xmg_magic;      /* linked list of magicalness */
 498     HV*         xmg_stash;      /* class package */
 499
 500     HV *        xcv_stash;
 501     union {
 502         OP *    xcv_start;
 503         ANY     xcv_xsubany;
 504     }           xcv_start_u;
 505     union {
 506         OP *    xcv_root;
 507         void    (*xcv_xsub) (pTHX_ CV*);
 508     }           xcv_root_u;
 509     GV *        xcv_gv;
 510     char *      xcv_file;
 511     AV *        xcv_padlist;
 512     CV *        xcv_outside;
 513     U32         xcv_outside_seq; /* the COP sequence (at the point of our
 514                                   * compilation) in the lexically enclosing
 515                                   * sub */
 516     cv_flags_t  xcv_flags;
 517     IV          xfm_lines;
 518 } xpvfm_allocated;
 519
 520 struct xpvio {
 521     NV          xnv_nv;         /* numeric value, if any */
 522     STRLEN      xpv_cur;        /* length of svu_pv as a C string */
 523     STRLEN      xpv_len;        /* allocated size */
 524     union {
 525         IV      xivu_iv;        /* integer value or pv offset */
 526         UV      xivu_uv;
 527         void *  xivu_p1;
 528         I32     xivu_i32;
 529     }           xiv_u;
 530     MAGIC*      xmg_magic;      /* linked list of magicalness */
 531     HV*         xmg_stash;      /* class package */
 532
 533     PerlIO *    xio_ifp;        /* ifp and ofp are normally the same */
 534     PerlIO *    xio_ofp;        /* but sockets need separate streams */
 535     /* Cray addresses everything by word boundaries (64 bits) and
 536      * code and data pointers cannot be mixed (which is exactly what
 537      * Perl_filter_add() tries to do with the dirp), hence the following
 538      * union trick (as suggested by Gurusamy Sarathy).
 539      * For further information see Geir Johansen's problem report titled
 540        [ID 20000612.002] Perl problem on Cray system
 541      * The any pointer (known as IoANY()) will also be a good place
 542      * to hang any IO disciplines to.
 543      */
 544     union {
 545         DIR *   xiou_dirp;      /* for opendir, readdir, etc */
 546         void *  xiou_any;       /* for alignment */
 547     } xio_dirpu;
 548     IV          xio_lines;      /* $. */
 549     IV          xio_page;       /* $% */
 550     IV          xio_page_len;   /* $= */
 551     IV          xio_lines_left; /* $- */
 552     char *      xio_top_name;   /* $^ */
 553     GV *        xio_top_gv;     /* $^ */
 554     char *      xio_fmt_name;   /* $~ */
 555     GV *        xio_fmt_gv;     /* $~ */
 556     char *      xio_bottom_name;/* $^B */
 557     GV *        xio_bottom_gv;  /* $^B */
 558     short       xio_subprocess; /* -| or |- */
 559     char        xio_type;
 560     char        xio_flags;
 561 };
 562 #define xio_dirp        xio_dirpu.xiou_dirp
 563 #define xio_any         xio_dirpu.xiou_any
 564
 565 #define IOf_ARGV        1       /* this fp iterates over ARGV */
 566 #define IOf_START       2       /* check for null ARGV and substitute '-' */
 567 #define IOf_FLUSH       4       /* this fp wants a flush after write op */
 568 #define IOf_DIDTOP      8       /* just did top of form */
 569 #define IOf_UNTAINT     16      /* consider this fp (and its data) "safe" */
 570 #define IOf_NOLINE      32      /* slurped a pseudo-line from empty file */
 571 #define IOf_FAKE_DIRP   64      /* xio_dirp is fake (source filters kludge) */
 572
 573 /* The following macros define implementation-independent predicates on SVs. */
 574
 575 /*
 576 =for apidoc Am|bool|SvNIOK|SV* sv
 577 Returns a boolean indicating whether the SV contains a number, integer or
 578 double.
 579
 580 =for apidoc Am|bool|SvNIOKp|SV* sv
 581 Returns a boolean indicating whether the SV contains a number, integer or
 582 double.  Checks the B<private> setting.  Use C<SvNIOK>.
 583
 584 =for apidoc Am|void|SvNIOK_off|SV* sv
 585 Unsets the NV/IV status of an SV.
 586
 587 =for apidoc Am|bool|SvOK|SV* sv
 588 Returns a boolean indicating whether the value is an SV. It also tells
 589 whether the value is defined or not.
 590
 591 =for apidoc Am|bool|SvIOKp|SV* sv
 592 Returns a boolean indicating whether the SV contains an integer.  Checks
 593 the B<private> setting.  Use C<SvIOK>.
 594
 595 =for apidoc Am|bool|SvNOKp|SV* sv
 596 Returns a boolean indicating whether the SV contains a double.  Checks the
 597 B<private> setting.  Use C<SvNOK>.
 598
 599 =for apidoc Am|bool|SvPOKp|SV* sv
 600 Returns a boolean indicating whether the SV contains a character string.
 601 Checks the B<private> setting.  Use C<SvPOK>.
 602
 603 =for apidoc Am|bool|SvIOK|SV* sv
 604 Returns a boolean indicating whether the SV contains an integer.
 605
 606 =for apidoc Am|void|SvIOK_on|SV* sv
 607 Tells an SV that it is an integer.
 608
 609 =for apidoc Am|void|SvIOK_off|SV* sv
 610 Unsets the IV status of an SV.
 611
 612 =for apidoc Am|void|SvIOK_only|SV* sv
 613 Tells an SV that it is an integer and disables all other OK bits.
 614
 615 =for apidoc Am|void|SvIOK_only_UV|SV* sv
 616 Tells and SV that it is an unsigned integer and disables all other OK bits.
 617
 618 =for apidoc Am|bool|SvIOK_UV|SV* sv
 619 Returns a boolean indicating whether the SV contains an unsigned integer.
 620
 621 =for apidoc Am|void|SvUOK|SV* sv
 622 Returns a boolean indicating whether the SV contains an unsigned integer.
 623
 624 =for apidoc Am|bool|SvIOK_notUV|SV* sv
 625 Returns a boolean indicating whether the SV contains a signed integer.
 626
 627 =for apidoc Am|bool|SvNOK|SV* sv
 628 Returns a boolean indicating whether the SV contains a double.
 629
 630 =for apidoc Am|void|SvNOK_on|SV* sv
 631 Tells an SV that it is a double.
 632
 633 =for apidoc Am|void|SvNOK_off|SV* sv
 634 Unsets the NV status of an SV.
 635
 636 =for apidoc Am|void|SvNOK_only|SV* sv
 637 Tells an SV that it is a double and disables all other OK bits.
 638
 639 =for apidoc Am|bool|SvPOK|SV* sv
 640 Returns a boolean indicating whether the SV contains a character
 641 string.
 642
 643 =for apidoc Am|void|SvPOK_on|SV* sv
 644 Tells an SV that it is a string.
 645
 646 =for apidoc Am|void|SvPOK_off|SV* sv
 647 Unsets the PV status of an SV.
 648
 649 =for apidoc Am|void|SvPOK_only|SV* sv
 650 Tells an SV that it is a string and disables all other OK bits.
 651 Will also turn off the UTF-8 status.
 652
 653 =for apidoc Am|bool|SvVOK|SV* sv
 654 Returns a boolean indicating whether the SV contains a v-string.
 655
 656 =for apidoc Am|bool|SvOOK|SV* sv
 657 Returns a boolean indicating whether the SvIVX is a valid offset value for
 658 the SvPVX.  This hack is used internally to speed up removal of characters
 659 from the beginning of a SvPV.  When SvOOK is true, then the start of the
 660 allocated string buffer is really (SvPVX - SvIVX).
 661
 662 =for apidoc Am|bool|SvROK|SV* sv
 663 Tests if the SV is an RV.
 664
 665 =for apidoc Am|void|SvROK_on|SV* sv
 666 Tells an SV that it is an RV.
 667
 668 =for apidoc Am|void|SvROK_off|SV* sv
 669 Unsets the RV status of an SV.
 670
 671 =for apidoc Am|SV*|SvRV|SV* sv
 672 Dereferences an RV to return the SV.
 673
 674 =for apidoc Am|IV|SvIVX|SV* sv
 675 Returns the raw value in the SV's IV slot, without checks or conversions.
 676 Only use when you are sure SvIOK is true. See also C<SvIV()>.
 677
 678 =for apidoc Am|UV|SvUVX|SV* sv
 679 Returns the raw value in the SV's UV slot, without checks or conversions.
 680 Only use when you are sure SvIOK is true. See also C<SvUV()>.
 681
 682 =for apidoc Am|NV|SvNVX|SV* sv
 683 Returns the raw value in the SV's NV slot, without checks or conversions.
 684 Only use when you are sure SvNOK is true. See also C<SvNV()>.
 685
 686 =for apidoc Am|char*|SvPVX|SV* sv
 687 Returns a pointer to the physical string in the SV.  The SV must contain a
 688 string.
 689
 690 =for apidoc Am|STRLEN|SvCUR|SV* sv
 691 Returns the length of the string which is in the SV.  See C<SvLEN>.
 692
 693 =for apidoc Am|STRLEN|SvLEN|SV* sv
 694 Returns the size of the string buffer in the SV, not including any part
 695 attributable to C<SvOOK>.  See C<SvCUR>.
 696
 697 =for apidoc Am|char*|SvEND|SV* sv
 698 Returns a pointer to the last character in the string which is in the SV.
 699 See C<SvCUR>.  Access the character as *(SvEND(sv)).
 700
 701 =for apidoc Am|HV*|SvSTASH|SV* sv
 702 Returns the stash of the SV.
 703
 704 =for apidoc Am|void|SvIV_set|SV* sv|IV val
 705 Set the value of the IV pointer in sv to val.  It is possible to perform
 706 the same function of this macro with an lvalue assignment to C<SvIVX>.
 707 With future Perls, however, it will be more efficient to use
 708 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
 709
 710 =for apidoc Am|void|SvNV_set|SV* sv|NV val
 711 Set the value of the NV pointer in sv to val.  See C<SvIV_set>.
 712
 713 =for apidoc Am|void|SvPV_set|SV* sv|char* val
 714 Set the value of the PV pointer in sv to val.  See C<SvIV_set>.
 715
 716 =for apidoc Am|void|SvUV_set|SV* sv|UV val
 717 Set the value of the UV pointer in sv to val.  See C<SvIV_set>.
 718
 719 =for apidoc Am|void|SvRV_set|SV* sv|SV* val
 720 Set the value of the RV pointer in sv to val.  See C<SvIV_set>.
 721
 722 =for apidoc Am|void|SvMAGIC_set|SV* sv|MAGIC* val
 723 Set the value of the MAGIC pointer in sv to val.  See C<SvIV_set>.
 724
 725 =for apidoc Am|void|SvSTASH_set|SV* sv|STASH* val
 726 Set the value of the STASH pointer in sv to val.  See C<SvIV_set>.
 727
 728 =for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
 729 Set the current length of the string which is in the SV.  See C<SvCUR>
 730 and C<SvIV_set>.
 731
 732 =for apidoc Am|void|SvLEN_set|SV* sv|STRLEN len
 733 Set the actual length of the string which is in the SV.  See C<SvIV_set>.
 734
 735 =cut
 736 */
 737
 738 #define SvNIOK(sv)              (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
 739 #define SvNIOKp(sv)             (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
 740 #define SvNIOK_off(sv)          (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
 741                                                   SVp_IOK|SVp_NOK|SVf_IVisUV))
 742
 743 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 744 #define assert_not_ROK(sv)      ({assert(!SvROK(sv) || !SvRV(sv));}),
 745 #else
 746 #define assert_not_ROK(sv)
 747 #endif
 748
 749 #define SvOK(sv)                (SvFLAGS(sv) & SVf_OK)
 750 #define SvOK_off(sv)            (assert_not_ROK(sv)                     \
 751                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
 752                                                   SVf_IVisUV|SVf_UTF8), \
 753                                                         SvOOK_off(sv))
 754 #define SvOK_off_exc_UV(sv)     (assert_not_ROK(sv)                     \
 755                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
 756                                                   SVf_UTF8),            \
 757                                                         SvOOK_off(sv))
 758
 759 #define SvOKp(sv)               (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
 760 #define SvIOKp(sv)              (SvFLAGS(sv) & SVp_IOK)
 761 #define SvIOKp_on(sv)           (SvRELEASE_IVX(sv), \
 762                                     SvFLAGS(sv) |= SVp_IOK)
 763 #define SvNOKp(sv)              (SvFLAGS(sv) & SVp_NOK)
 764 #define SvNOKp_on(sv)           (SvFLAGS(sv) |= SVp_NOK)
 765 #define SvPOKp(sv)              (SvFLAGS(sv) & SVp_POK)
 766 #define SvPOKp_on(sv)           (assert_not_ROK(sv)                     \
 767                                  SvFLAGS(sv) |= SVp_POK)
 768
 769 #define SvIOK(sv)               (SvFLAGS(sv) & SVf_IOK)
 770 #define SvIOK_on(sv)            (SvRELEASE_IVX(sv), \
 771                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 772 #define SvIOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
 773 #define SvIOK_only(sv)          (SvOK_off(sv), \
 774                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 775 #define SvIOK_only_UV(sv)       (SvOK_off_exc_UV(sv), \
 776                                     SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
 777
 778 #define SvIOK_UV(sv)            ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
 779                                  == (SVf_IOK|SVf_IVisUV))
 780 #define SvUOK(sv)               SvIOK_UV(sv)
 781 #define SvIOK_notUV(sv)         ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV))   \
 782                                  == SVf_IOK)
 783
 784 #define SvIsUV(sv)              (SvFLAGS(sv) & SVf_IVisUV)
 785 #define SvIsUV_on(sv)           (SvFLAGS(sv) |= SVf_IVisUV)
 786 #define SvIsUV_off(sv)          (SvFLAGS(sv) &= ~SVf_IVisUV)
 787
 788 #define SvNOK(sv)               (SvFLAGS(sv) & SVf_NOK)
 789 #define SvNOK_on(sv)            (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
 790 #define SvNOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
 791 #define SvNOK_only(sv)          (SvOK_off(sv), \
 792                                     SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
 793
 794 /*
 795 =for apidoc Am|bool|SvUTF8|SV* sv
 796 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
 797
 798 =for apidoc Am|void|SvUTF8_on|SV *sv
 799 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
 800 Do not use frivolously.
 801
 802 =for apidoc Am|void|SvUTF8_off|SV *sv
 803 Unsets the UTF-8 status of an SV.
 804
 805 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
 806 Tells an SV that it is a string and disables all other OK bits,
 807 and leaves the UTF-8 status as it was.
 808
 809 =cut
 810  */
 811
 812 /* Ensure the return value of this macro does not clash with the GV_ADD* flags
 813 in gv.h: */
 814 #define SvUTF8(sv)              (SvFLAGS(sv) & SVf_UTF8)
 815 #define SvUTF8_on(sv)           (SvFLAGS(sv) |= (SVf_UTF8))
 816 #define SvUTF8_off(sv)          (SvFLAGS(sv) &= ~(SVf_UTF8))
 817
 818 #define SvPOK(sv)               (SvFLAGS(sv) & SVf_POK)
 819 #define SvPOK_on(sv)            (assert_not_ROK(sv)                     \
 820                                  SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 821 #define SvPOK_off(sv)           (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
 822 #define SvPOK_only(sv)          (assert_not_ROK(sv)                     \
 823                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
 824                                                   SVf_IVisUV|SVf_UTF8), \
 825                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 826 #define SvPOK_only_UTF8(sv)     (assert_not_ROK(sv)                     \
 827                                  SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC|    \
 828                                                   SVf_IVisUV),          \
 829                                     SvFLAGS(sv) |= (SVf_POK|SVp_POK))
 830
 831 #define SvVOK(sv)               (SvMAGICAL(sv)                          \
 832                                  ? mg_find(sv,PERL_MAGIC_vstring) : NULL)
 833 #define SvOOK(sv)               (SvFLAGS(sv) & SVf_OOK)
 834 #define SvOOK_on(sv)            ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
 835 #define SvOOK_off(sv)           ((void)(SvOOK(sv) && sv_backoff(sv)))
 836
 837 #define SvFAKE(sv)              (SvFLAGS(sv) & SVf_FAKE)
 838 #define SvFAKE_on(sv)           (SvFLAGS(sv) |= SVf_FAKE)
 839 #define SvFAKE_off(sv)          (SvFLAGS(sv) &= ~SVf_FAKE)
 840
 841 #define SvROK(sv)               (SvFLAGS(sv) & SVf_ROK)
 842 #define SvROK_on(sv)            (SvFLAGS(sv) |= SVf_ROK)
 843 #define SvROK_off(sv)           (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
 844
 845 #define SvMAGICAL(sv)           (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
 846 #define SvMAGICAL_on(sv)        (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
 847 #define SvMAGICAL_off(sv)       (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
 848
 849 #define SvGMAGICAL(sv)          (SvFLAGS(sv) & SVs_GMG)
 850 #define SvGMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_GMG)
 851 #define SvGMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_GMG)
 852
 853 #define SvSMAGICAL(sv)          (SvFLAGS(sv) & SVs_SMG)
 854 #define SvSMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_SMG)
 855 #define SvSMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_SMG)
 856
 857 #define SvRMAGICAL(sv)          (SvFLAGS(sv) & SVs_RMG)
 858 #define SvRMAGICAL_on(sv)       (SvFLAGS(sv) |= SVs_RMG)
 859 #define SvRMAGICAL_off(sv)      (SvFLAGS(sv) &= ~SVs_RMG)
 860
 861 #define SvAMAGIC(sv)            (SvFLAGS(sv) & SVf_AMAGIC)
 862 #define SvAMAGIC_on(sv)         (SvFLAGS(sv) |= SVf_AMAGIC)
 863 #define SvAMAGIC_off(sv)        (SvFLAGS(sv) &= ~SVf_AMAGIC)
 864
 865 #define SvGAMAGIC(sv)           (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
 866
 867 /*
 868 #define Gv_AMG(stash) \
 869         (HV_AMAGICmb(stash) && \
 870          ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
 871 */
 872 #define Gv_AMG(stash)           (PL_amagic_generation && Gv_AMupdate(stash))
 873
 874 #define SvWEAKREF(sv)           ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
 875                                   == (SVf_ROK|SVprv_WEAKREF))
 876 #define SvWEAKREF_on(sv)        (SvFLAGS(sv) |=  (SVf_ROK|SVprv_WEAKREF))
 877 #define SvWEAKREF_off(sv)       (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
 878
 879 #define SvTHINKFIRST(sv)        (SvFLAGS(sv) & SVf_THINKFIRST)
 880
 881 #define SvPADSTALE(sv)          (SvFLAGS(sv) & SVs_PADSTALE)
 882 #define SvPADSTALE_on(sv)       (SvFLAGS(sv) |= SVs_PADSTALE)
 883 #define SvPADSTALE_off(sv)      (SvFLAGS(sv) &= ~SVs_PADSTALE)
 884
 885 #define SvPADTMP(sv)            (SvFLAGS(sv) & SVs_PADTMP)
 886 #define SvPADTMP_on(sv)         (SvFLAGS(sv) |= SVs_PADTMP)
 887 #define SvPADTMP_off(sv)        (SvFLAGS(sv) &= ~SVs_PADTMP)
 888
 889 #define SvPADMY(sv)             (SvFLAGS(sv) & SVs_PADMY)
 890 #define SvPADMY_on(sv)          (SvFLAGS(sv) |= SVs_PADMY)
 891
 892 #define SvTEMP(sv)              (SvFLAGS(sv) & SVs_TEMP)
 893 #define SvTEMP_on(sv)           (SvFLAGS(sv) |= SVs_TEMP)
 894 #define SvTEMP_off(sv)          (SvFLAGS(sv) &= ~SVs_TEMP)
 895
 896 #define SvOBJECT(sv)            (SvFLAGS(sv) & SVs_OBJECT)
 897 #define SvOBJECT_on(sv)         (SvFLAGS(sv) |= SVs_OBJECT)
 898 #define SvOBJECT_off(sv)        (SvFLAGS(sv) &= ~SVs_OBJECT)
 899
 900 #define SvREADONLY(sv)          (SvFLAGS(sv) & SVf_READONLY)
 901 #define SvREADONLY_on(sv)       (SvFLAGS(sv) |= SVf_READONLY)
 902 #define SvREADONLY_off(sv)      (SvFLAGS(sv) &= ~SVf_READONLY)
 903
 904 #define SvSCREAM(sv) ((SvFLAGS(sv) & (SVp_SCREAM|SVp_POK)) == (SVp_SCREAM|SVp_POK))
 905 #define SvSCREAM_on(sv)         (SvFLAGS(sv) |= SVp_SCREAM)
 906 #define SvSCREAM_off(sv)        (SvFLAGS(sv) &= ~SVp_SCREAM)
 907
 908 #define SvCOMPILED(sv)          (SvFLAGS(sv) & SVpfm_COMPILED)
 909 #define SvCOMPILED_on(sv)       (SvFLAGS(sv) |= SVpfm_COMPILED)
 910 #define SvCOMPILED_off(sv)      (SvFLAGS(sv) &= ~SVpfm_COMPILED)
 911
 912 #define SvEVALED(sv)            (SvFLAGS(sv) & SVrepl_EVAL)
 913 #define SvEVALED_on(sv)         (SvFLAGS(sv) |= SVrepl_EVAL)
 914 #define SvEVALED_off(sv)        (SvFLAGS(sv) &= ~SVrepl_EVAL)
 915
 916 #define SvTAIL(sv)              (SvFLAGS(sv) & SVpbm_TAIL)
 917 #define SvTAIL_on(sv)           (SvFLAGS(sv) |= SVpbm_TAIL)
 918 #define SvTAIL_off(sv)          (SvFLAGS(sv) &= ~SVpbm_TAIL)
 919
 920 #define SvVALID(sv)             (SvFLAGS(sv) & SVpbm_VALID)
 921 #define SvVALID_on(sv)          (SvFLAGS(sv) |= SVpbm_VALID)
 922 #define SvVALID_off(sv)         (SvFLAGS(sv) &= ~SVpbm_VALID)
 923
 924 #ifdef USE_ITHREADS
 925 /* The following uses the FAKE flag to show that a regex pointer is infact
 926    its own offset in the regexpad for ithreads */
 927 #define SvREPADTMP(sv)          (SvFLAGS(sv) & SVf_FAKE)
 928 #define SvREPADTMP_on(sv)       (SvFLAGS(sv) |= SVf_FAKE)
 929 #define SvREPADTMP_off(sv)      (SvFLAGS(sv) &= ~SVf_FAKE)
 930 #endif
 931
 932 #define SvPAD_TYPED(sv) \
 933         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_TYPED)) == (SVpad_NAME|SVpad_TYPED))
 934 #define SvPAD_TYPED_on(sv)      (SvFLAGS(sv) |= SVpad_NAME|SVpad_TYPED)
 935
 936 #define SvPAD_OUR(sv)   \
 937         ((SvFLAGS(sv) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR))
 938 #define SvPAD_OUR_on(sv)        (SvFLAGS(sv) |= SVpad_NAME|SVpad_OUR)
 939
 940 #define OURSTASH(sv)    (SvPAD_OUR(sv) ? GvSTASH(sv) : NULL)
 941 #define OURSTASH_set(sv, st)                    \
 942         STMT_START {                            \
 943             assert(SvTYPE(sv) == SVt_PVGV);     \
 944             GvSTASH(sv) = st;                   \
 945         } STMT_END
 946
 947 #ifdef PERL_DEBUG_COW
 948 #define SvRV(sv) (0 + (sv)->sv_u.svu_rv)
 949 #else
 950 #define SvRV(sv) ((sv)->sv_u.svu_rv)
 951 #endif
 952 #define SvRVx(sv) SvRV(sv)
 953
 954 #ifdef PERL_DEBUG_COW
 955 /* Need -0.0 for SvNVX to preserve IEEE FP "negative zero" because
 956    +0.0 + -0.0 => +0.0 but -0.0 + -0.0 => -0.0 */
 957 #  define SvIVX(sv) (0 + ((XPVIV*) SvANY(sv))->xiv_iv)
 958 #  define SvUVX(sv) (0 + ((XPVUV*) SvANY(sv))->xuv_uv)
 959 #  define SvNVX(sv) (-0.0 + ((XPVNV*) SvANY(sv))->xnv_nv)
 960 /* Don't test the core XS code yet.  */
 961 #  if defined (PERL_CORE) && PERL_DEBUG_COW > 1
 962 #    define SvPVX(sv) (0 + (assert(!SvREADONLY(sv)), (sv)->sv_u.svu_pv))
 963 #  else
 964 #  define SvPVX(sv) SvPVX_mutable(sv)
 965 #  endif
 966 #  define SvCUR(sv) (0 + ((XPV*) SvANY(sv))->xpv_cur)
 967 #  define SvLEN(sv) (0 + ((XPV*) SvANY(sv))->xpv_len)
 968 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
 969
 970 #  ifdef DEBUGGING
 971 #    ifdef PERL_IN_SV_C
 972 /* Can't make this RVALUE because of Perl_sv_unmagic.  */
 973 #      define SvMAGIC(sv)       (*(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_magic))
 974 #    else
 975 #      define SvMAGIC(sv)       (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_magic))
 976 #    endif
 977 #  define SvSTASH(sv)   (0 + *(assert(SvTYPE(sv) >= SVt_PVMG), &((XPVMG*)  SvANY(sv))->xmg_stash))
 978 #  else
 979 #    ifdef PERL_IN_SV_C
 980 #      define SvMAGIC(sv) ((XPVMG*)  SvANY(sv))->xmg_magic
 981 #    else
 982 #      define SvMAGIC(sv) (0 + ((XPVMG*)  SvANY(sv))->xmg_magic)
 983 #    endif
 984 #  define SvSTASH(sv)     (0 + ((XPVMG*)  SvANY(sv))->xmg_stash)
 985 #  endif
 986 #else
 987 #  define SvPVX(sv) ((sv)->sv_u.svu_pv)
 988 #  define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
 989 #  define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
 990 #  define SvEND(sv) ((sv)->sv_u.svu_pv + ((XPV*)SvANY(sv))->xpv_cur)
 991
 992 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 993 /* These get expanded inside other macros that already use a variable _sv  */
 994 #    define SvIVX(sv)                                                   \
 995         (*({ SV *const _svi = (SV *) sv;                                \
 996             assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
 997             assert(SvTYPE(_svi) != SVt_PVAV);                           \
 998             assert(SvTYPE(_svi) != SVt_PVHV);                           \
 999             assert(SvTYPE(_svi) != SVt_PVCV);                           \
1000             &(((XPVIV*) SvANY(_svi))->xiv_iv);                          \
1001          }))
1002 #    define SvUVX(sv)                                                   \
1003         (*({ SV *const _svi = (SV *) sv;                                \
1004             assert(SvTYPE(_svi) == SVt_IV || SvTYPE(_svi) >= SVt_PVIV); \
1005             assert(SvTYPE(_svi) != SVt_PVAV);                           \
1006             assert(SvTYPE(_svi) != SVt_PVHV);                           \
1007             assert(SvTYPE(_svi) != SVt_PVCV);                           \
1008             &(((XPVUV*) SvANY(_svi))->xuv_uv);                          \
1009          }))
1010 #    define SvNVX(sv)                                                   \
1011         (*({ SV *const _svi = (SV *) sv;                                \
1012             assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \
1013             assert(SvTYPE(_svi) != SVt_PVAV);                           \
1014             assert(SvTYPE(_svi) != SVt_PVHV);                           \
1015             assert(SvTYPE(_svi) != SVt_PVFM);                           \
1016            &(((XPVNV*) SvANY(_svi))->xnv_nv);                           \
1017          }))
1018 #    define SvMAGIC(sv)                                                 \
1019         (*({ SV *const _svi = (SV *) sv;                                \
1020             assert(SvTYPE(_svi) >= SVt_PVMG);                           \
1021             if (SvTYPE(_svi) == SVt_PVMG && (SvFLAGS(_svi) & SVpad_NAME)) \
1022                 assert (!((XPVMG*) SvANY(_svi))->xmg_magic); \
1023             &(((XPVMG*) SvANY(_svi))->xmg_magic);                       \
1024           }))
1025 #    define SvSTASH(sv)                                                 \
1026         (*({ SV *const _svi = (SV *) sv;                                \
1027             assert(SvTYPE(_svi) >= SVt_PVMG);                           \
1028             &(((XPVMG*) SvANY(_svi))->xmg_stash);                       \
1029           }))
1030 #  else
1031 #    define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
1032 #    define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
1033 #    define SvNVX(sv) ((XPVNV*) SvANY(sv))->xnv_nv
1034 #    define SvMAGIC(sv) ((XPVMG*)  SvANY(sv))->xmg_magic
1035 #    define SvSTASH(sv) ((XPVMG*)  SvANY(sv))->xmg_stash
1036 #  endif
1037 #endif
1038
1039 #ifndef PERL_POISON
1040 /* Given that these two are new, there can't be any existing code using them
1041  *  as LVALUEs  */
1042 #  define SvPVX_mutable(sv)     (0 + (sv)->sv_u.svu_pv)
1043 #  define SvPVX_const(sv)       ((const char*)(0 + (sv)->sv_u.svu_pv))
1044 #else
1045 /* Except for the poison code, which uses & to scribble over the pointer after
1046    free() is called.  */
1047 #  define SvPVX_mutable(sv)     ((sv)->sv_u.svu_pv)
1048 #  define SvPVX_const(sv)       ((const char*)((sv)->sv_u.svu_pv))
1049 #endif
1050
1051 #define SvIVXx(sv) SvIVX(sv)
1052 #define SvUVXx(sv) SvUVX(sv)
1053 #define SvNVXx(sv) SvNVX(sv)
1054 #define SvPVXx(sv) SvPVX(sv)
1055 #define SvLENx(sv) SvLEN(sv)
1056 #define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
1057
1058
1059 /* Ask a scalar nicely to try to become an IV, if possible.
1060    Not guaranteed to stay returning void */
1061 /* Macro won't actually call sv_2iv if already IOK */
1062 #define SvIV_please(sv) \
1063         STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
1064                 (void) SvIV(sv); } STMT_END
1065 #define SvIV_set(sv, val) \
1066         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1067                 (((XPVIV*)  SvANY(sv))->xiv_iv = (val)); } STMT_END
1068 #define SvNV_set(sv, val) \
1069         STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
1070             assert(SvTYPE(sv) != SVt_PVAV); assert(SvTYPE(sv) != SVt_PVHV); \
1071                 (((XPVNV*)SvANY(sv))->xnv_nv = (val)); } STMT_END
1072 #define SvPV_set(sv, val) \
1073         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1074                 ((sv)->sv_u.svu_pv = (val)); } STMT_END
1075 #define SvUV_set(sv, val) \
1076         STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
1077                 (((XPVUV*)SvANY(sv))->xuv_uv = (val)); } STMT_END
1078 #define SvRV_set(sv, val) \
1079         STMT_START { assert(SvTYPE(sv) >=  SVt_RV); \
1080                 ((sv)->sv_u.svu_rv = (val)); } STMT_END
1081 #define SvMAGIC_set(sv, val) \
1082         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1083                 (((XPVMG*)SvANY(sv))->xmg_magic = (val)); } STMT_END
1084 #define SvSTASH_set(sv, val) \
1085         STMT_START { assert(SvTYPE(sv) >= SVt_PVMG); \
1086                 (((XPVMG*)  SvANY(sv))->xmg_stash = (val)); } STMT_END
1087 #define SvCUR_set(sv, val) \
1088         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1089                 (((XPV*)  SvANY(sv))->xpv_cur = (val)); } STMT_END
1090 #define SvLEN_set(sv, val) \
1091         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1092                 (((XPV*)  SvANY(sv))->xpv_len = (val)); } STMT_END
1093 #define SvEND_set(sv, val) \
1094         STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
1095                 (SvCUR(sv) = (val) - SvPVX(sv)); } STMT_END
1096
1097 #define SvPV_renew(sv,n) \
1098         STMT_START { SvLEN_set(sv, n); \
1099                 SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)                 \
1100                                 (char*)saferealloc((Malloc_t)SvPVX(sv), \
1101                                                    (MEM_SIZE)((n)))));  \
1102                  } STMT_END
1103
1104 #define SvPV_shrink_to_cur(sv) STMT_START { \
1105                    const STRLEN _lEnGtH = SvCUR(sv) + 1; \
1106                    SvPV_renew(sv, _lEnGtH); \
1107                  } STMT_END
1108
1109 #define SvPV_free(sv)                                                   \
1110     STMT_START {                                                        \
1111                      assert(SvTYPE(sv) >= SVt_PV);                      \
1112                      if (SvLEN(sv)) {                                   \
1113                          if(SvOOK(sv)) {                                \
1114                              SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv)); \
1115                              SvFLAGS(sv) &= ~SVf_OOK;                   \
1116                          }                                              \
1117                          Safefree(SvPVX(sv));                           \
1118                      }                                                  \
1119                  } STMT_END
1120
1121 #define BmRARE(sv)      ((XPVBM*)  SvANY(sv))->xbm_rare
1122 #define BmUSEFUL(sv)    ((XPVBM*)  SvANY(sv))->xbm_useful
1123 #define BmPREVIOUS(sv)  ((XPVBM*)  SvANY(sv))->xbm_previous
1124
1125 #define FmLINES(sv)     ((XPVFM*)  SvANY(sv))->xfm_lines
1126
1127 #define LvTYPE(sv)      ((XPVLV*)  SvANY(sv))->xlv_type
1128 #define LvTARG(sv)      ((XPVLV*)  SvANY(sv))->xlv_targ
1129 #define LvTARGOFF(sv)   ((XPVLV*)  SvANY(sv))->xlv_targoff
1130 #define LvTARGLEN(sv)   ((XPVLV*)  SvANY(sv))->xlv_targlen
1131
1132 #define IoIFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ifp
1133 #define IoOFP(sv)       ((XPVIO*)  SvANY(sv))->xio_ofp
1134 #define IoDIRP(sv)      ((XPVIO*)  SvANY(sv))->xio_dirp
1135 #define IoANY(sv)       ((XPVIO*)  SvANY(sv))->xio_any
1136 #define IoLINES(sv)     ((XPVIO*)  SvANY(sv))->xio_lines
1137 #define IoPAGE(sv)      ((XPVIO*)  SvANY(sv))->xio_page
1138 #define IoPAGE_LEN(sv)  ((XPVIO*)  SvANY(sv))->xio_page_len
1139 #define IoLINES_LEFT(sv)((XPVIO*)  SvANY(sv))->xio_lines_left
1140 #define IoTOP_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_top_name
1141 #define IoTOP_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_top_gv
1142 #define IoFMT_NAME(sv)  ((XPVIO*)  SvANY(sv))->xio_fmt_name
1143 #define IoFMT_GV(sv)    ((XPVIO*)  SvANY(sv))->xio_fmt_gv
1144 #define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
1145 #define IoBOTTOM_GV(sv) ((XPVIO*)  SvANY(sv))->xio_bottom_gv
1146 #define IoSUBPROCESS(sv)((XPVIO*)  SvANY(sv))->xio_subprocess
1147 #define IoTYPE(sv)      ((XPVIO*)  SvANY(sv))->xio_type
1148 #define IoFLAGS(sv)     ((XPVIO*)  SvANY(sv))->xio_flags
1149
1150 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
1151 #define IoTYPE_RDONLY           '<'
1152 #define IoTYPE_WRONLY           '>'
1153 #define IoTYPE_RDWR             '+'
1154 #define IoTYPE_APPEND           'a'
1155 #define IoTYPE_PIPE             '|'
1156 #define IoTYPE_STD              '-'     /* stdin or stdout */
1157 #define IoTYPE_SOCKET           's'
1158 #define IoTYPE_CLOSED           ' '
1159 #define IoTYPE_IMPLICIT         'I'     /* stdin or stdout or stderr */
1160 #define IoTYPE_NUMERIC          '#'     /* fdopen */
1161
1162 /*
1163 =for apidoc Am|bool|SvTAINTED|SV* sv
1164 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1165 not.
1166
1167 =for apidoc Am|void|SvTAINTED_on|SV* sv
1168 Marks an SV as tainted if tainting is enabled.
1169
1170 =for apidoc Am|void|SvTAINTED_off|SV* sv
1171 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
1172 some of Perl's fundamental security features. XS module authors should not
1173 use this function unless they fully understand all the implications of
1174 unconditionally untainting the value. Untainting should be done in the
1175 standard perl fashion, via a carefully crafted regexp, rather than directly
1176 untainting variables.
1177
1178 =for apidoc Am|void|SvTAINT|SV* sv
1179 Taints an SV if tainting is enabled.
1180
1181 =cut
1182 */
1183
1184 #define sv_taint(sv)      sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0)
1185
1186 #define SvTAINTED(sv)     (SvMAGICAL(sv) && sv_tainted(sv))
1187 #define SvTAINTED_on(sv)  STMT_START{ if(PL_tainting){sv_taint(sv);}   }STMT_END
1188 #define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
1189
1190 #define SvTAINT(sv)                     \
1191     STMT_START {                        \
1192         if (PL_tainting) {              \
1193             if (PL_tainted)             \
1194                 SvTAINTED_on(sv);       \
1195         }                               \
1196     } STMT_END
1197
1198 /*
1199 =for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
1200 Like C<SvPV> but will force the SV into containing just a string
1201 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1202 directly.
1203
1204 =for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
1205 Like C<SvPV> but will force the SV into containing just a string
1206 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
1207 directly. Doesn't process magic.
1208
1209 =for apidoc Am|char*|SvPV|SV* sv|STRLEN len
1210 Returns a pointer to the string in the SV, or a stringified form of
1211 the SV if the SV does not contain a string.  The SV may cache the
1212 stringified version becoming C<SvPOK>.  Handles 'get' magic. See also
1213 C<SvPVx> for a version which guarantees to evaluate sv only once.
1214
1215 =for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
1216 A version of C<SvPV> which guarantees to evaluate sv only once.
1217
1218 =for apidoc Am|char*|SvPV_nomg|SV* sv|STRLEN len
1219 Like C<SvPV> but doesn't process magic.
1220
1221 =for apidoc Am|char*|SvPV_nolen|SV* sv
1222 Returns a pointer to the string in the SV, or a stringified form of
1223 the SV if the SV does not contain a string.  The SV may cache the
1224 stringified form becoming C<SvPOK>.  Handles 'get' magic.
1225
1226 =for apidoc Am|IV|SvIV|SV* sv
1227 Coerces the given SV to an integer and returns it. See  C<SvIVx> for a
1228 version which guarantees to evaluate sv only once.
1229
1230 =for apidoc Am|IV|SvIV_nomg|SV* sv
1231 Like C<SvIV> but doesn't process magic.
1232
1233 =for apidoc Am|IV|SvIVx|SV* sv
1234 Coerces the given SV to an integer and returns it. Guarantees to evaluate
1235 sv only once. Use the more efficient C<SvIV> otherwise.
1236
1237 =for apidoc Am|NV|SvNV|SV* sv
1238 Coerce the given SV to a double and return it. See  C<SvNVx> for a version
1239 which guarantees to evaluate sv only once.
1240
1241 =for apidoc Am|NV|SvNVx|SV* sv
1242 Coerces the given SV to a double and returns it. Guarantees to evaluate
1243 sv only once. Use the more efficient C<SvNV> otherwise.
1244
1245 =for apidoc Am|UV|SvUV|SV* sv
1246 Coerces the given SV to an unsigned integer and returns it.  See C<SvUVx>
1247 for a version which guarantees to evaluate sv only once.
1248
1249 =for apidoc Am|UV|SvUV_nomg|SV* sv
1250 Like C<SvUV> but doesn't process magic.
1251
1252 =for apidoc Am|UV|SvUVx|SV* sv
1253 Coerces the given SV to an unsigned integer and returns it. Guarantees to
1254 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
1255
1256 =for apidoc Am|bool|SvTRUE|SV* sv
1257 Returns a boolean indicating whether Perl would evaluate the SV as true or
1258 false, defined or undefined.  Does not handle 'get' magic.
1259
1260 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
1261 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1262
1263 =for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
1264 Like C<SvPV>, but converts sv to utf8 first if necessary.
1265
1266 =for apidoc Am|char*|SvPVutf8_nolen|SV* sv
1267 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
1268
1269 =for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
1270 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1271
1272 =for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
1273 Like C<SvPV>, but converts sv to byte representation first if necessary.
1274
1275 =for apidoc Am|char*|SvPVbyte_nolen|SV* sv
1276 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
1277
1278 =for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
1279 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
1280 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
1281 otherwise.
1282
1283 =for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
1284 Like C<SvPV>, but converts sv to utf8 first if necessary.
1285 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
1286 otherwise.
1287
1288 =for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
1289 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
1290 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
1291 otherwise.
1292
1293 =for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
1294 Like C<SvPV>, but converts sv to byte representation first if necessary.
1295 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
1296 otherwise.
1297
1298 =for apidoc Am|bool|SvIsCOW|SV* sv
1299 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1300 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1301 COW)
1302
1303 =for apidoc Am|bool|SvIsCOW_shared_hash|SV* sv
1304 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
1305 scalar.
1306
1307 =for apidoc Am|void|sv_catpvn_nomg|SV* sv|const char* ptr|STRLEN len
1308 Like C<sv_catpvn> but doesn't process magic.
1309
1310 =for apidoc Am|void|sv_setsv_nomg|SV* dsv|SV* ssv
1311 Like C<sv_setsv> but doesn't process magic.
1312
1313 =for apidoc Am|void|sv_catsv_nomg|SV* dsv|SV* ssv
1314 Like C<sv_catsv> but doesn't process magic.
1315
1316 =cut
1317 */
1318
1319 /* Let us hope that bitmaps for UV and IV are the same */
1320 #define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
1321 #define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
1322 #define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
1323
1324 #define SvIV_nomg(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv_flags(sv, 0))
1325 #define SvUV_nomg(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv_flags(sv, 0))
1326
1327 /* ----*/
1328
1329 #define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
1330 #define SvPV_const(sv, lp) SvPV_flags_const(sv, lp, SV_GMAGIC)
1331 #define SvPV_mutable(sv, lp) SvPV_flags_mutable(sv, lp, SV_GMAGIC)
1332
1333 #define SvPV_flags(sv, lp, flags) \
1334     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1335      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
1336 #define SvPV_flags_const(sv, lp, flags) \
1337     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1338      ? ((lp = SvCUR(sv)), SvPVX_const(sv)) : \
1339      (const char*) sv_2pv_flags(sv, &lp, flags|SV_CONST_RETURN))
1340 #define SvPV_flags_const_nolen(sv, flags) \
1341     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1342      ? SvPVX_const(sv) : \
1343      (const char*) sv_2pv_flags(sv, 0, flags|SV_CONST_RETURN))
1344 #define SvPV_flags_mutable(sv, lp, flags) \
1345     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1346      ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) : \
1347      sv_2pv_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1348
1349 #define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
1350 #define SvPV_force_nolen(sv) SvPV_force_flags_nolen(sv, SV_GMAGIC)
1351 #define SvPV_force_mutable(sv, lp) SvPV_force_flags_mutable(sv, lp, SV_GMAGIC)
1352
1353 #define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
1354 #define SvPV_force_nomg_nolen(sv) SvPV_force_flags_nolen(sv, 0)
1355
1356 #define SvPV_force_flags(sv, lp, flags) \
1357     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1358     ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
1359 #define SvPV_force_flags_nolen(sv, flags) \
1360     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1361     ? SvPVX(sv) : sv_pvn_force_flags(sv, 0, flags))
1362 #define SvPV_force_flags_mutable(sv, lp, flags) \
1363     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
1364     ? ((lp = SvCUR(sv)), SvPVX_mutable(sv)) \
1365      : sv_pvn_force_flags(sv, &lp, flags|SV_MUTABLE_RETURN))
1366
1367 #define SvPV_nolen(sv) \
1368     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1369      ? SvPVX(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC))
1370
1371 #define SvPV_nolen_const(sv) \
1372     ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
1373      ? SvPVX_const(sv) : sv_2pv_flags(sv, 0, SV_GMAGIC|SV_CONST_RETURN))
1374
1375 #define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
1376 #define SvPV_nomg_const(sv, lp) SvPV_flags_const(sv, lp, 0)
1377 #define SvPV_nomg_const_nolen(sv) SvPV_flags_const_nolen(sv, 0)
1378
1379 /* ----*/
1380
1381 #define SvPVutf8(sv, lp) \
1382     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
1383      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
1384
1385 #define SvPVutf8_force(sv, lp) \
1386     ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
1387      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
1388
1389
1390 #define SvPVutf8_nolen(sv) \
1391     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
1392      ? SvPVX(sv) : sv_2pvutf8(sv, 0))
1393
1394 /* ----*/
1395
1396 #define SvPVbyte(sv, lp) \
1397     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
1398      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
1399
1400 #define SvPVbyte_force(sv, lp) \
1401     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
1402      ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyten_force(sv, &lp))
1403
1404 #define SvPVbyte_nolen(sv) \
1405     ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
1406      ? SvPVX(sv) : sv_2pvbyte(sv, 0))
1407
1408
1409
1410 /* define FOOx(): idempotent versions of FOO(). If possible, use a local
1411  * var to evaluate the arg once; failing that, use a global if possible;
1412  * failing that, call a function to do the work
1413  */
1414
1415 #define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
1416 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
1417 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
1418
1419 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
1420
1421 #  define SvIVx(sv) ({SV *_sv = (SV*)(sv); SvIV(_sv); })
1422 #  define SvUVx(sv) ({SV *_sv = (SV*)(sv); SvUV(_sv); })
1423 #  define SvNVx(sv) ({SV *_sv = (SV*)(sv); SvNV(_sv); })
1424 #  define SvPVx(sv, lp) ({SV *_sv = (sv); SvPV(_sv, lp); })
1425 #  define SvPVx_const(sv, lp) ({SV *_sv = (sv); SvPV_const(_sv, lp); })
1426 #  define SvPVx_nolen(sv) ({SV *_sv = (sv); SvPV_nolen(_sv); })
1427 #  define SvPVx_nolen_const(sv) ({SV *_sv = (sv); SvPV_nolen_const(_sv); })
1428 #  define SvPVutf8x(sv, lp) ({SV *_sv = (sv); SvPVutf8(_sv, lp); })
1429 #  define SvPVbytex(sv, lp) ({SV *_sv = (sv); SvPVbyte(_sv, lp); })
1430 #  define SvPVbytex_nolen(sv) ({SV *_sv = (sv); SvPVbyte_nolen(_sv); })
1431 #  define SvTRUE(sv) (                                          \
1432     !sv                                                         \
1433     ? 0                                                         \
1434     :    SvPOK(sv)                                              \
1435         ?   (({XPV *nxpv = (XPV*)SvANY(sv);                     \
1436              nxpv &&                                            \
1437              (nxpv->xpv_cur > 1 ||                              \
1438               (nxpv->xpv_cur && *(sv)->sv_u.svu_pv != '0')); }) \
1439              ? 1                                                \
1440              : 0)                                               \
1441         :                                                       \
1442             SvIOK(sv)                                           \
1443             ? SvIVX(sv) != 0                                    \
1444             :   SvNOK(sv)                                       \
1445                 ? SvNVX(sv) != 0.0                              \
1446                 : sv_2bool(sv) )
1447 #  define SvTRUEx(sv) ({SV *_sv = (sv); SvTRUE(_sv); })
1448
1449 #else /* __GNUC__ */
1450
1451 /* These inlined macros use globals, which will require a thread
1452  * declaration in user code, so we avoid them under threads */
1453
1454 #  define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1455 #  define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1456 #  define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1457 #  define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1458 #  define SvPVx_const(sv, lp) ((PL_Sv = (sv)), SvPV_const(PL_Sv, lp))
1459 #  define SvPVx_nolen(sv) ((PL_Sv = (sv)), SvPV_nolen(PL_Sv))
1460 #  define SvPVx_nolen_const(sv) ((PL_Sv = (sv)), SvPV_nolen_const(PL_Sv))
1461 #  define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1462 #  define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1463 #  define SvPVbytex_nolen(sv) ((PL_Sv = (sv)), SvPVbyte_nolen(PL_Sv))
1464 #  define SvTRUE(sv) (                                          \
1465     !sv                                                         \
1466     ? 0                                                         \
1467     :    SvPOK(sv)                                              \
1468         ?   ((PL_Xpv = (XPV*)SvANY(PL_Sv = (sv))) &&            \
1469              (PL_Xpv->xpv_cur > 1 ||                            \
1470               (PL_Xpv->xpv_cur && *PL_Sv->sv_u.svu_pv != '0'))  \
1471              ? 1                                                \
1472              : 0)                                               \
1473         :                                                       \
1474             SvIOK(sv)                                           \
1475             ? SvIVX(sv) != 0                                    \
1476             :   SvNOK(sv)                                       \
1477                 ? SvNVX(sv) != 0.0                              \
1478                 : sv_2bool(sv) )
1479 #  define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1480 #endif /* __GNU__ */
1481
1482 #define SvIsCOW(sv)             ((SvFLAGS(sv) & (SVf_FAKE | SVf_READONLY)) == \
1483                                     (SVf_FAKE | SVf_READONLY))
1484 #define SvIsCOW_shared_hash(sv) (SvIsCOW(sv) && SvLEN(sv) == 0)
1485
1486 #define SvSHARED_HEK_FROM_PV(pvx) \
1487         ((struct hek*)(pvx - STRUCT_OFFSET(struct hek, hek_key)))
1488 #define SvSHARED_HASH(sv) (0 + SvSHARED_HEK_FROM_PV(SvPVX_const(sv))->hek_hash)
1489
1490 /* flag values for sv_*_flags functions */
1491 #define SV_IMMEDIATE_UNREF      1
1492 #define SV_GMAGIC               2
1493 #define SV_COW_DROP_PV          4
1494 #define SV_UTF8_NO_ENCODING     8
1495 #define SV_NOSTEAL              16
1496 #define SV_CONST_RETURN         32
1497 #define SV_MUTABLE_RETURN       64
1498 #define SV_SMAGIC               128
1499
1500 #define sv_unref(sv)            sv_unref_flags(sv, 0)
1501 #define sv_force_normal(sv)     sv_force_normal_flags(sv, 0)
1502
1503 /* We are about to replace the SV's current value. So if it's copy on write
1504    we need to normalise it. Use the SV_COW_DROP_PV flag hint to say that
1505    the value is about to get thrown away, so drop the PV rather than go to
1506    the effort of making a read-write copy only for it to get immediately
1507    discarded.  */
1508
1509 #define SV_CHECK_THINKFIRST_COW_DROP(sv) if (SvTHINKFIRST(sv)) \
1510                                     sv_force_normal_flags(sv, SV_COW_DROP_PV)
1511
1512 #ifdef PERL_OLD_COPY_ON_WRITE
1513 #  define SvRELEASE_IVX(sv)   ((void)((SvFLAGS(sv) & (SVf_OOK|SVf_READONLY|SVf_FAKE)) \
1514                                 && Perl_sv_release_IVX(aTHX_ sv)))
1515 #  define SvIsCOW_normal(sv)    (SvIsCOW(sv) && SvLEN(sv))
1516 #else
1517 #  define SvRELEASE_IVX(sv)   SvOOK_off(sv)
1518 #endif /* PERL_OLD_COPY_ON_WRITE */
1519
1520 #define CAN_COW_MASK    (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
1521                          SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
1522                          SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
1523 #define CAN_COW_FLAGS   (SVp_POK|SVf_POK)
1524
1525 #define SV_CHECK_THINKFIRST(sv) if (SvTHINKFIRST(sv)) \
1526                                     sv_force_normal_flags(sv, 0)
1527
1528
1529 /* all these 'functions' are now just macros */
1530
1531 #define sv_pv(sv) SvPV_nolen(sv)
1532 #define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1533 #define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1534
1535 #define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1536 #define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1537 #define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1538 #define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1539 #define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1540 #define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1541 #define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1542 #define sv_catsv_mg(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC|SV_SMAGIC)
1543 #define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1544 #define sv_catpvn_mg(sv, sstr, slen) \
1545         sv_catpvn_flags(sv, sstr, slen, SV_GMAGIC|SV_SMAGIC);
1546 #define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1547 #define sv_2pv_nolen(sv) sv_2pv(sv, 0)
1548 #define sv_2pvbyte_nolen(sv) sv_2pvbyte(sv, 0)
1549 #define sv_2pvutf8_nolen(sv) sv_2pvutf8(sv, 0)
1550 #define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1551 #define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1552 #define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1553 #define sv_2iv(sv) sv_2iv_flags(sv, SV_GMAGIC)
1554 #define sv_2uv(sv) sv_2uv_flags(sv, SV_GMAGIC)
1555
1556 /* Should be named SvCatPVN_utf8_upgrade? */
1557 #define sv_catpvn_utf8_upgrade(dsv, sstr, slen, nsv)    \
1558         STMT_START {                                    \
1559             if (!(nsv))                                 \
1560                 nsv = sv_2mortal(newSVpvn(sstr, slen)); \
1561             else                                        \
1562                 sv_setpvn(nsv, sstr, slen);             \
1563             SvUTF8_off(nsv);                            \
1564             sv_utf8_upgrade(nsv);                       \
1565             sv_catsv(dsv, nsv); \
1566         } STMT_END
1567
1568 /*
1569 =for apidoc Am|SV*|newRV_inc|SV* sv
1570
1571 Creates an RV wrapper for an SV.  The reference count for the original SV is
1572 incremented.
1573
1574 =cut
1575 */
1576
1577 #define newRV_inc(sv)   newRV(sv)
1578
1579 /* the following macros update any magic values this sv is associated with */
1580
1581 /*
1582 =head1 Magical Functions
1583
1584 =for apidoc Am|void|SvGETMAGIC|SV* sv
1585 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
1586 argument more than once.
1587
1588 =for apidoc Am|void|SvSETMAGIC|SV* sv
1589 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
1590 argument more than once.
1591
1592 =for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1593 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
1594 more than once.
1595
1596 =for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1597 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1598 ssv. May evaluate arguments more than once.
1599
1600 =for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1601 Like C<SvSetSV>, but does any set magic required afterwards.
1602
1603 =for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1604 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
1605
1606 =for apidoc Am|void|SvSHARE|SV* sv
1607 Arranges for sv to be shared between threads if a suitable module
1608 has been loaded.
1609
1610 =for apidoc Am|void|SvLOCK|SV* sv
1611 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1612 has been loaded.
1613
1614 =for apidoc Am|void|SvUNLOCK|SV* sv
1615 Releases a mutual exclusion lock on sv if a suitable module
1616 has been loaded.
1617
1618 =head1 SV Manipulation Functions
1619
1620 =for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
1621 Expands the character buffer in the SV so that it has room for the
1622 indicated number of bytes (remember to reserve space for an extra trailing
1623 NUL character).  Calls C<sv_grow> to perform the expansion if necessary.
1624 Returns a pointer to the character buffer.
1625
1626 =cut
1627 */
1628
1629 #define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1630 #define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1631 #define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1632
1633 #define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1634 #define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
1635
1636 #define SvSetSV_and(dst,src,finally) \
1637         STMT_START {                                    \
1638             if ((dst) != (src)) {                       \
1639                 sv_setsv(dst, src);                     \
1640                 finally;                                \
1641             }                                           \
1642         } STMT_END
1643 #define SvSetSV_nosteal_and(dst,src,finally) \
1644         STMT_START {                                    \
1645             if ((dst) != (src)) {                       \
1646                 sv_setsv_flags(dst, src, SV_GMAGIC | SV_NOSTEAL);       \
1647                 finally;                                \
1648             }                                           \
1649         } STMT_END
1650
1651 #define SvSetSV(dst,src) \
1652                 SvSetSV_and(dst,src,/*nothing*/;)
1653 #define SvSetSV_nosteal(dst,src) \
1654                 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
1655
1656 #define SvSetMagicSV(dst,src) \
1657                 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1658 #define SvSetMagicSV_nosteal(dst,src) \
1659                 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1660
1661
1662 #if !defined(SKIP_DEBUGGING)
1663 #define SvPEEK(sv) sv_peek(sv)
1664 #else
1665 #define SvPEEK(sv) ""
1666 #endif
1667
1668 #define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
1669
1670 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
1671
1672 #define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1673
1674 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1675 #define SvGROW_mutable(sv,len) \
1676     (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX_mutable(sv))
1677 #define Sv_Grow sv_grow
1678
1679 #define CLONEf_COPY_STACKS 1
1680 #define CLONEf_KEEP_PTR_TABLE 2
1681 #define CLONEf_CLONE_HOST 4
1682 #define CLONEf_JOIN_IN 8
1683
1684 struct clone_params {
1685   AV* stashes;
1686   UV  flags;
1687   PerlInterpreter *proto_perl;
1688 };
1689
1690 /*
1691  * Local variables:
1692  * c-indentation-style: bsd
1693  * c-basic-offset: 4
1694  * indent-tabs-mode: t
1695  * End:
1696  *
1697  * ex: set ts=8 sts=4 sw=4 noet:
1698  */