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