sv.h

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