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