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