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