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