projects / p5sagit/p5-mst-13.2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | history | HEAD
Integrate mainline
[p5sagit/p5-mst-13.2.git] / sv.h
CommitLineData
a0d0e21e 1/* sv.h
79072805 2 *
eb1102fc 3 * Copyright (c) 1991-2002, Larry Wall
79072805 4 *
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
7 *
79072805 8 */
9
a0d0e21e 10#ifdef sv_flags
11#undef sv_flags /* Convex has this in <signal.h> for sigvec() */
12#endif
13
954c1994 14/*
ccfc67b7 15=head1 SV Flags
16
954c1994 17=for apidoc AmU||svtype
8cf8f3d1 18An enum of flags for Perl types. These are found in the file B<sv.h>
954c1994 19in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
20
21=for apidoc AmU||SVt_PV
22Pointer type flag for scalars. See C<svtype>.
23
24=for apidoc AmU||SVt_IV
25Integer type flag for scalars. See C<svtype>.
26
27=for apidoc AmU||SVt_NV
28Double type flag for scalars. See C<svtype>.
29
30=for apidoc AmU||SVt_PVMG
31Type flag for blessed scalars. See C<svtype>.
32
33=for apidoc AmU||SVt_PVAV
34Type flag for arrays. See C<svtype>.
35
36=for apidoc AmU||SVt_PVHV
37Type flag for hashes. See C<svtype>.
38
39=for apidoc AmU||SVt_PVCV
40Type flag for code refs. See C<svtype>.
41
42=cut
43*/
44
79072805 45typedef enum {
a0d0e21e 46 SVt_NULL, /* 0 */
47 SVt_IV, /* 1 */
48 SVt_NV, /* 2 */
49 SVt_RV, /* 3 */
50 SVt_PV, /* 4 */
51 SVt_PVIV, /* 5 */
52 SVt_PVNV, /* 6 */
53 SVt_PVMG, /* 7 */
54 SVt_PVBM, /* 8 */
55 SVt_PVLV, /* 9 */
56 SVt_PVAV, /* 10 */
57 SVt_PVHV, /* 11 */
58 SVt_PVCV, /* 12 */
59 SVt_PVGV, /* 13 */
60 SVt_PVFM, /* 14 */
61 SVt_PVIO /* 15 */
79072805 62} svtype;
63
79072805 64/* Using C's structural equivalence to help emulate C++ inheritance here... */
65
5e045b90 66struct STRUCT_SV { /* struct sv { */
463ee0b2 67 void* sv_any; /* pointer to something */
79072805 68 U32 sv_refcnt; /* how many references to us */
8990e307 69 U32 sv_flags; /* what we are */
79072805 70};
71
72struct gv {
463ee0b2 73 XPVGV* sv_any; /* pointer to something */
79072805 74 U32 sv_refcnt; /* how many references to us */
8990e307 75 U32 sv_flags; /* what we are */
79072805 76};
77
78struct cv {
232e078e 79 XPVCV* sv_any; /* pointer to something */
79072805 80 U32 sv_refcnt; /* how many references to us */
8990e307 81 U32 sv_flags; /* what we are */
79072805 82};
83
84struct av {
463ee0b2 85 XPVAV* sv_any; /* pointer to something */
79072805 86 U32 sv_refcnt; /* how many references to us */
8990e307 87 U32 sv_flags; /* what we are */
79072805 88};
89
90struct hv {
463ee0b2 91 XPVHV* sv_any; /* pointer to something */
79072805 92 U32 sv_refcnt; /* how many references to us */
8990e307 93 U32 sv_flags; /* what we are */
94};
95
96struct io {
97 XPVIO* sv_any; /* pointer to something */
98 U32 sv_refcnt; /* how many references to us */
99 U32 sv_flags; /* what we are */
79072805 100};
101
954c1994 102/*
ccfc67b7 103=head1 SV Manipulation Functions
104
954c1994 105=for apidoc Am|U32|SvREFCNT|SV* sv
106Returns the value of the object's reference count.
107
108=for apidoc Am|SV*|SvREFCNT_inc|SV* sv
109Increments the reference count of the given SV.
110
111=for apidoc Am|void|SvREFCNT_dec|SV* sv
112Decrements the reference count of the given SV.
113
114=for apidoc Am|svtype|SvTYPE|SV* sv
115Returns the type of the SV. See C<svtype>.
116
117=for apidoc Am|void|SvUPGRADE|SV* sv|svtype type
118Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
119perform the upgrade if necessary. See C<svtype>.
120
121=cut
122*/
123
463ee0b2 124#define SvANY(sv) (sv)->sv_any
79072805 125#define SvFLAGS(sv) (sv)->sv_flags
aeea060c 126#define SvREFCNT(sv) (sv)->sv_refcnt
a863c7d1 127
4d1ff10f 128#ifdef USE_5005THREADS
dce16143 129
3d35f11b 130# if defined(VMS)
131# define ATOMIC_INC(count) __ATOMIC_INCREMENT_LONG(&count)
132# define ATOMIC_DEC_AND_TEST(res,count) res=(1==__ATOMIC_DECREMENT_LONG(&count))
133 # else
134# ifdef EMULATE_ATOMIC_REFCOUNTS
135 # define ATOMIC_INC(count) STMT_START { \
136 MUTEX_LOCK(&PL_svref_mutex); \
137 ++count; \
138 MUTEX_UNLOCK(&PL_svref_mutex); \
139 } STMT_END
140# define ATOMIC_DEC_AND_TEST(res,count) STMT_START { \
141 MUTEX_LOCK(&PL_svref_mutex); \
142 res = (--count == 0); \
143 MUTEX_UNLOCK(&PL_svref_mutex); \
144 } STMT_END
145# else
146# define ATOMIC_INC(count) atomic_inc(&count)
147# define ATOMIC_DEC_AND_TEST(res,count) (res = atomic_dec_and_test(&count))
148# endif /* EMULATE_ATOMIC_REFCOUNTS */
149# endif /* VMS */
dce16143 150#else
151# define ATOMIC_INC(count) (++count)
83b0a010 152# define ATOMIC_DEC_AND_TEST(res, count) (res = (--count == 0))
4d1ff10f 153#endif /* USE_5005THREADS */
dce16143 154
a863c7d1 155#ifdef __GNUC__
dce16143 156# define SvREFCNT_inc(sv) \
157 ({ \
158 SV *nsv = (SV*)(sv); \
159 if (nsv) \
160 ATOMIC_INC(SvREFCNT(nsv)); \
161 nsv; \
162 })
8990e307 163#else
9ede5bc8 164# ifdef USE_5005THREADS
3d35f11b 165# if defined(VMS) && defined(__ALPHA)
166# define SvREFCNT_inc(sv) \
167 (PL_Sv=(SV*)(sv), (PL_Sv && __ATOMIC_INCREMENT_LONG(&(SvREFCNT(PL_Sv)))), (SV *)PL_Sv)
168# else
169# define SvREFCNT_inc(sv) sv_newref((SV*)sv)
170# endif
a863c7d1 171# else
dce16143 172# define SvREFCNT_inc(sv) \
6b88bc9c 173 ((PL_Sv=(SV*)(sv)), (PL_Sv && ATOMIC_INC(SvREFCNT(PL_Sv))), (SV*)PL_Sv)
a863c7d1 174# endif
8990e307 175#endif
176
a863c7d1 177#define SvREFCNT_dec(sv) sv_free((SV*)sv)
178
8990e307 179#define SVTYPEMASK 0xff
180#define SvTYPE(sv) ((sv)->sv_flags & SVTYPEMASK)
79072805 181
182#define SvUPGRADE(sv, mt) (SvTYPE(sv) >= mt || sv_upgrade(sv, mt))
183
8990e307 184#define SVs_PADBUSY 0x00000100 /* reserved for tmp or my already */
185#define SVs_PADTMP 0x00000200 /* in use as tmp */
186#define SVs_PADMY 0x00000400 /* in use a "my" variable */
187#define SVs_TEMP 0x00000800 /* string is stealable? */
188#define SVs_OBJECT 0x00001000 /* is "blessed" */
189#define SVs_GMG 0x00002000 /* has magical get method */
190#define SVs_SMG 0x00004000 /* has magical set method */
191#define SVs_RMG 0x00008000 /* has random magical methods */
192
193#define SVf_IOK 0x00010000 /* has valid public integer value */
194#define SVf_NOK 0x00020000 /* has valid public numeric value */
195#define SVf_POK 0x00040000 /* has valid public pointer value */
196#define SVf_ROK 0x00080000 /* has a valid reference pointer */
a0d0e21e 197
748a9306 198#define SVf_FAKE 0x00100000 /* glob or lexical is just a copy */
8990e307 199#define SVf_OOK 0x00200000 /* has valid offset value */
645c22ef 200#define SVf_BREAK 0x00400000 /* refcnt is artificially low - used
201 * by SV's in final arena cleanup */
8990e307 202#define SVf_READONLY 0x00800000 /* may not be modified */
203
a0d0e21e 204
8990e307 205#define SVp_IOK 0x01000000 /* has valid non-public integer value */
206#define SVp_NOK 0x02000000 /* has valid non-public numeric value */
207#define SVp_POK 0x04000000 /* has valid non-public pointer value */
208#define SVp_SCREAM 0x08000000 /* has been studied? */
209
5bc28da9 210#define SVf_UTF8 0x20000000 /* SvPVX is UTF-8 encoded */
211
430eacda 212#define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
5bc28da9 213
a0d0e21e 214#define SVf_OK (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
215 SVp_IOK|SVp_NOK|SVp_POK)
216
9e7bc3e8 217#define SVf_AMAGIC 0x10000000 /* has magical overloaded methods */
a0d0e21e 218
8990e307 219#define PRIVSHIFT 8
220
221/* Some private flags. */
222
f472eb5c 223/* SVpad_OUR may be set on SVt_PV{NV,MG,GV} types */
032d6771 224#define SVpad_OUR 0x80000000 /* pad name is "our" instead of "my" */
524189f1 225#define SVpad_TYPED 0x40000000 /* Typed Lexical */
032d6771 226
25da4f38 227#define SVf_IVisUV 0x80000000 /* use XPVUV instead of XPVIV */
228
229#define SVpfm_COMPILED 0x80000000 /* FORMLINE is compiled */
8990e307 230
231#define SVpbm_VALID 0x80000000
bbce6d69 232#define SVpbm_TAIL 0x40000000
8990e307 233
25da4f38 234#define SVrepl_EVAL 0x40000000 /* Replacement part of s///e */
235
6bfc225d 236#define SVphv_SHAREKEYS 0x20000000 /* keys live on shared string table */
51594c39 237#define SVphv_LAZYDEL 0x40000000 /* entry in xhv_eiter must be deleted */
80a5d8e7 238#define SVphv_HASKFLAGS 0x80000000 /* keys have flag byte after hash */
bf6bd887 239
810b8aa5 240#define SVprv_WEAKREF 0x80000000 /* Weak reference */
241
ed6116ce 242struct xrv {
243 SV * xrv_rv; /* pointer to another SV */
244};
245
79072805 246struct xpv {
ed6116ce 247 char * xpv_pv; /* pointer to malloced string */
248 STRLEN xpv_cur; /* length of xpv_pv as a C string */
249 STRLEN xpv_len; /* allocated size */
79072805 250};
251
252struct xpviv {
ed6116ce 253 char * xpv_pv; /* pointer to malloced string */
254 STRLEN xpv_cur; /* length of xpv_pv as a C string */
255 STRLEN xpv_len; /* allocated size */
a0d0e21e 256 IV xiv_iv; /* integer value or pv offset */
79072805 257};
258
ff68c719 259struct xpvuv {
260 char * xpv_pv; /* pointer to malloced string */
261 STRLEN xpv_cur; /* length of xpv_pv as a C string */
262 STRLEN xpv_len; /* allocated size */
263 UV xuv_uv; /* unsigned value or pv offset */
264};
265
79072805 266struct xpvnv {
ed6116ce 267 char * xpv_pv; /* pointer to malloced string */
268 STRLEN xpv_cur; /* length of xpv_pv as a C string */
269 STRLEN xpv_len; /* allocated size */
a0d0e21e 270 IV xiv_iv; /* integer value or pv offset */
65202027 271 NV xnv_nv; /* numeric value, if any */
79072805 272};
273
6ee623d5 274/* These structure must match the beginning of struct xpvhv in hv.h. */
79072805 275struct xpvmg {
ed6116ce 276 char * xpv_pv; /* pointer to malloced string */
277 STRLEN xpv_cur; /* length of xpv_pv as a C string */
278 STRLEN xpv_len; /* allocated size */
a0d0e21e 279 IV xiv_iv; /* integer value or pv offset */
65202027 280 NV xnv_nv; /* numeric value, if any */
79072805 281 MAGIC* xmg_magic; /* linked list of magicalness */
282 HV* xmg_stash; /* class package */
283};
284
285struct xpvlv {
ed6116ce 286 char * xpv_pv; /* pointer to malloced string */
287 STRLEN xpv_cur; /* length of xpv_pv as a C string */
288 STRLEN xpv_len; /* allocated size */
a0d0e21e 289 IV xiv_iv; /* integer value or pv offset */
65202027 290 NV xnv_nv; /* numeric value, if any */
79072805 291 MAGIC* xmg_magic; /* linked list of magicalness */
292 HV* xmg_stash; /* class package */
8990e307 293
79072805 294 STRLEN xlv_targoff;
295 STRLEN xlv_targlen;
296 SV* xlv_targ;
297 char xlv_type;
298};
299
300struct xpvgv {
ed6116ce 301 char * xpv_pv; /* pointer to malloced string */
302 STRLEN xpv_cur; /* length of xpv_pv as a C string */
303 STRLEN xpv_len; /* allocated size */
a0d0e21e 304 IV xiv_iv; /* integer value or pv offset */
65202027 305 NV xnv_nv; /* numeric value, if any */
79072805 306 MAGIC* xmg_magic; /* linked list of magicalness */
307 HV* xmg_stash; /* class package */
8990e307 308
79072805 309 GP* xgv_gp;
310 char* xgv_name;
311 STRLEN xgv_namelen;
312 HV* xgv_stash;
a5f75d66 313 U8 xgv_flags;
79072805 314};
315
316struct xpvbm {
ed6116ce 317 char * xpv_pv; /* pointer to malloced string */
318 STRLEN xpv_cur; /* length of xpv_pv as a C string */
319 STRLEN xpv_len; /* allocated size */
a0d0e21e 320 IV xiv_iv; /* integer value or pv offset */
65202027 321 NV xnv_nv; /* numeric value, if any */
79072805 322 MAGIC* xmg_magic; /* linked list of magicalness */
323 HV* xmg_stash; /* class package */
8990e307 324
79072805 325 I32 xbm_useful; /* is this constant pattern being useful? */
326 U16 xbm_previous; /* how many characters in string before rare? */
327 U8 xbm_rare; /* rarest character in string */
328};
329
d22779f5 330/* This structure much match XPVCV in cv.h */
44a8e56a 331
77a005ab 332typedef U16 cv_flags_t;
333
79072805 334struct xpvfm {
ed6116ce 335 char * xpv_pv; /* pointer to malloced string */
336 STRLEN xpv_cur; /* length of xpv_pv as a C string */
337 STRLEN xpv_len; /* allocated size */
a0d0e21e 338 IV xiv_iv; /* integer value or pv offset */
65202027 339 NV xnv_nv; /* numeric value, if any */
79072805 340 MAGIC* xmg_magic; /* linked list of magicalness */
341 HV* xmg_stash; /* class package */
8990e307 342
79072805 343 HV * xcv_stash;
344 OP * xcv_start;
345 OP * xcv_root;
acfe0abc 346 void (*xcv_xsub)(pTHX_ CV*);
a0d0e21e 347 ANY xcv_xsubany;
348 GV * xcv_gv;
57843af0 349 char * xcv_file;
b195d487 350 long xcv_depth; /* >= 2 indicates recursive call */
79072805 351 AV * xcv_padlist;
748a9306 352 CV * xcv_outside;
4d1ff10f 353#ifdef USE_5005THREADS
f6d98b14 354 perl_mutex *xcv_mutexp; /* protects xcv_owner */
52e1cb5e 355 struct perl_thread *xcv_owner; /* current owner thread */
4d1ff10f 356#endif /* USE_5005THREADS */
77a005ab 357 cv_flags_t xcv_flags;
44a8e56a 358
11a7ac70 359 IV xfm_lines;
79072805 360};
361
8990e307 362struct xpvio {
363 char * xpv_pv; /* pointer to malloced string */
364 STRLEN xpv_cur; /* length of xpv_pv as a C string */
365 STRLEN xpv_len; /* allocated size */
a0d0e21e 366 IV xiv_iv; /* integer value or pv offset */
65202027 367 NV xnv_nv; /* numeric value, if any */
8990e307 368 MAGIC* xmg_magic; /* linked list of magicalness */
369 HV* xmg_stash; /* class package */
370
760ac839 371 PerlIO * xio_ifp; /* ifp and ofp are normally the same */
372 PerlIO * xio_ofp; /* but sockets need separate streams */
4755096e 373 /* Cray addresses everything by word boundaries (64 bits) and
374 * code and data pointers cannot be mixed (which is exactly what
375 * Perl_filter_add() tries to do with the dirp), hence the following
376 * union trick (as suggested by Gurusamy Sarathy).
377 * For further information see Geir Johansen's problem report titled
378 [ID 20000612.002] Perl problem on Cray system
379 * The any pointer (known as IoANY()) will also be a good place
380 * to hang any IO disciplines to.
381 */
382 union {
383 DIR * xiou_dirp; /* for opendir, readdir, etc */
384 void * xiou_any; /* for alignment */
385 } xio_dirpu;
11a7ac70 386 IV xio_lines; /* $. */
387 IV xio_page; /* $% */
388 IV xio_page_len; /* $= */
389 IV xio_lines_left; /* $- */
8990e307 390 char * xio_top_name; /* $^ */
391 GV * xio_top_gv; /* $^ */
392 char * xio_fmt_name; /* $~ */
393 GV * xio_fmt_gv; /* $~ */
394 char * xio_bottom_name;/* $^B */
395 GV * xio_bottom_gv; /* $^B */
396 short xio_subprocess; /* -| or |- */
397 char xio_type;
398 char xio_flags;
399};
4755096e 400#define xio_dirp xio_dirpu.xiou_dirp
401#define xio_any xio_dirpu.xiou_any
8990e307 402
e0c19803 403#define IOf_ARGV 1 /* this fp iterates over ARGV */
404#define IOf_START 2 /* check for null ARGV and substitute '-' */
405#define IOf_FLUSH 4 /* this fp wants a flush after write op */
406#define IOf_DIDTOP 8 /* just did top of form */
407#define IOf_UNTAINT 16 /* consider this fp (and its data) "safe" */
408#define IOf_NOLINE 32 /* slurped a pseudo-line from empty file */
409#define IOf_FAKE_DIRP 64 /* xio_dirp is fake (source filters kludge) */
80a5d8e7 410#define IOf_DIR_UTF8 128 /* readdir tries to return utf8 */
8990e307 411
ed6116ce 412/* The following macros define implementation-independent predicates on SVs. */
413
954c1994 414/*
415=for apidoc Am|bool|SvNIOK|SV* sv
416Returns a boolean indicating whether the SV contains a number, integer or
417double.
418
419=for apidoc Am|bool|SvNIOKp|SV* sv
420Returns a boolean indicating whether the SV contains a number, integer or
421double. Checks the B<private> setting. Use C<SvNIOK>.
422
423=for apidoc Am|void|SvNIOK_off|SV* sv
424Unsets the NV/IV status of an SV.
425
426=for apidoc Am|bool|SvOK|SV* sv
427Returns a boolean indicating whether the value is an SV.
428
429=for apidoc Am|bool|SvIOKp|SV* sv
430Returns a boolean indicating whether the SV contains an integer. Checks
431the B<private> setting. Use C<SvIOK>.
432
433=for apidoc Am|bool|SvNOKp|SV* sv
434Returns a boolean indicating whether the SV contains a double. Checks the
435B<private> setting. Use C<SvNOK>.
436
437=for apidoc Am|bool|SvPOKp|SV* sv
438Returns a boolean indicating whether the SV contains a character string.
439Checks the B<private> setting. Use C<SvPOK>.
440
441=for apidoc Am|bool|SvIOK|SV* sv
442Returns a boolean indicating whether the SV contains an integer.
443
444=for apidoc Am|void|SvIOK_on|SV* sv
445Tells an SV that it is an integer.
446
447=for apidoc Am|void|SvIOK_off|SV* sv
448Unsets the IV status of an SV.
449
450=for apidoc Am|void|SvIOK_only|SV* sv
451Tells an SV that it is an integer and disables all other OK bits.
452
e331fc52 453=for apidoc Am|void|SvIOK_only_UV|SV* sv
454Tells and SV that it is an unsigned integer and disables all other OK bits.
455
456=for apidoc Am|void|SvIOK_UV|SV* sv
457Returns a boolean indicating whether the SV contains an unsigned integer.
458
28e5dec8 459=for apidoc Am|void|SvUOK|SV* sv
460Returns a boolean indicating whether the SV contains an unsigned integer.
461
e331fc52 462=for apidoc Am|void|SvIOK_notUV|SV* sv
d1be9408 463Returns a boolean indicating whether the SV contains a signed integer.
e331fc52 464
954c1994 465=for apidoc Am|bool|SvNOK|SV* sv
466Returns a boolean indicating whether the SV contains a double.
467
468=for apidoc Am|void|SvNOK_on|SV* sv
469Tells an SV that it is a double.
470
471=for apidoc Am|void|SvNOK_off|SV* sv
472Unsets the NV status of an SV.
473
474=for apidoc Am|void|SvNOK_only|SV* sv
475Tells an SV that it is a double and disables all other OK bits.
476
477=for apidoc Am|bool|SvPOK|SV* sv
478Returns a boolean indicating whether the SV contains a character
479string.
480
481=for apidoc Am|void|SvPOK_on|SV* sv
482Tells an SV that it is a string.
483
484=for apidoc Am|void|SvPOK_off|SV* sv
485Unsets the PV status of an SV.
486
487=for apidoc Am|void|SvPOK_only|SV* sv
488Tells an SV that it is a string and disables all other OK bits.
d5ce4a7c 489Will also turn off the UTF8 status.
954c1994 490
491=for apidoc Am|bool|SvOOK|SV* sv
492Returns a boolean indicating whether the SvIVX is a valid offset value for
493the SvPVX. This hack is used internally to speed up removal of characters
494from the beginning of a SvPV. When SvOOK is true, then the start of the
495allocated string buffer is really (SvPVX - SvIVX).
496
497=for apidoc Am|bool|SvROK|SV* sv
498Tests if the SV is an RV.
499
500=for apidoc Am|void|SvROK_on|SV* sv
501Tells an SV that it is an RV.
502
503=for apidoc Am|void|SvROK_off|SV* sv
504Unsets the RV status of an SV.
505
506=for apidoc Am|SV*|SvRV|SV* sv
507Dereferences an RV to return the SV.
508
509=for apidoc Am|IV|SvIVX|SV* sv
645c22ef 510Returns the raw value in the SV's IV slot, without checks or conversions.
511Only use when you are sure SvIOK is true. See also C<SvIV()>.
954c1994 512
513=for apidoc Am|UV|SvUVX|SV* sv
645c22ef 514Returns the raw value in the SV's UV slot, without checks or conversions.
515Only use when you are sure SvIOK is true. See also C<SvUV()>.
954c1994 516
517=for apidoc Am|NV|SvNVX|SV* sv
645c22ef 518Returns the raw value in the SV's NV slot, without checks or conversions.
519Only use when you are sure SvNOK is true. See also C<SvNV()>.
954c1994 520
521=for apidoc Am|char*|SvPVX|SV* sv
645c22ef 522Returns a pointer to the physical string in the SV. The SV must contain a
954c1994 523string.
524
525=for apidoc Am|STRLEN|SvCUR|SV* sv
526Returns the length of the string which is in the SV. See C<SvLEN>.
527
528=for apidoc Am|STRLEN|SvLEN|SV* sv
659239a4 529Returns the size of the string buffer in the SV, not including any part
530attributable to C<SvOOK>. See C<SvCUR>.
954c1994 531
532=for apidoc Am|char*|SvEND|SV* sv
533Returns a pointer to the last character in the string which is in the SV.
534See C<SvCUR>. Access the character as *(SvEND(sv)).
535
536=for apidoc Am|HV*|SvSTASH|SV* sv
537Returns the stash of the SV.
538
539=for apidoc Am|void|SvCUR_set|SV* sv|STRLEN len
540Set the length of the string which is in the SV. See C<SvCUR>.
541
542=cut
543*/
544
79072805 545#define SvNIOK(sv) (SvFLAGS(sv) & (SVf_IOK|SVf_NOK))
748a9306 546#define SvNIOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK))
a0d0e21e 547#define SvNIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
25da4f38 548 SVp_IOK|SVp_NOK|SVf_IVisUV))
79072805 549
463ee0b2 550#define SvOK(sv) (SvFLAGS(sv) & SVf_OK)
25da4f38 551#define SvOK_off(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
d41ff1b8 552 SVf_IVisUV|SVf_UTF8), \
25da4f38 553 SvOOK_off(sv))
d41ff1b8 554#define SvOK_off_exc_UV(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
555 SVf_UTF8), \
a0d0e21e 556 SvOOK_off(sv))
79072805 557
8990e307 558#define SvOKp(sv) (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK))
559#define SvIOKp(sv) (SvFLAGS(sv) & SVp_IOK)
155aba94 560#define SvIOKp_on(sv) ((void)SvOOK_off(sv), SvFLAGS(sv) |= SVp_IOK)
8990e307 561#define SvNOKp(sv) (SvFLAGS(sv) & SVp_NOK)
562#define SvNOKp_on(sv) (SvFLAGS(sv) |= SVp_NOK)
563#define SvPOKp(sv) (SvFLAGS(sv) & SVp_POK)
564#define SvPOKp_on(sv) (SvFLAGS(sv) |= SVp_POK)
463ee0b2 565
79072805 566#define SvIOK(sv) (SvFLAGS(sv) & SVf_IOK)
155aba94 567#define SvIOK_on(sv) ((void)SvOOK_off(sv), \
a0d0e21e 568 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
25da4f38 569#define SvIOK_off(sv) (SvFLAGS(sv) &= ~(SVf_IOK|SVp_IOK|SVf_IVisUV))
155aba94 570#define SvIOK_only(sv) ((void)SvOK_off(sv), \
a0d0e21e 571 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
155aba94 572#define SvIOK_only_UV(sv) ((void)SvOK_off_exc_UV(sv), \
25da4f38 573 SvFLAGS(sv) |= (SVf_IOK|SVp_IOK))
70401c6b 574
25da4f38 575#define SvIOK_UV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
576 == (SVf_IOK|SVf_IVisUV))
28e5dec8 577#define SvUOK(sv) SvIOK_UV(sv)
25da4f38 578#define SvIOK_notUV(sv) ((SvFLAGS(sv) & (SVf_IOK|SVf_IVisUV)) \
579 == SVf_IOK)
580
581#define SvIsUV(sv) (SvFLAGS(sv) & SVf_IVisUV)
582#define SvIsUV_on(sv) (SvFLAGS(sv) |= SVf_IVisUV)
583#define SvIsUV_off(sv) (SvFLAGS(sv) &= ~SVf_IVisUV)
79072805 584
585#define SvNOK(sv) (SvFLAGS(sv) & SVf_NOK)
a0d0e21e 586#define SvNOK_on(sv) (SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
8990e307 587#define SvNOK_off(sv) (SvFLAGS(sv) &= ~(SVf_NOK|SVp_NOK))
155aba94 588#define SvNOK_only(sv) ((void)SvOK_off(sv), \
a0d0e21e 589 SvFLAGS(sv) |= (SVf_NOK|SVp_NOK))
79072805 590
914184e1 591/*
592=for apidoc Am|void|SvUTF8|SV* sv
593Returns a boolean indicating whether the SV contains UTF-8 encoded data.
594
595=for apidoc Am|void|SvUTF8_on|SV *sv
d5ce4a7c 596Turn on the UTF8 status of an SV (the data is not changed, just the flag).
597Do not use frivolously.
914184e1 598
599=for apidoc Am|void|SvUTF8_off|SV *sv
600Unsets the UTF8 status of an SV.
601
602=for apidoc Am|void|SvPOK_only_UTF8|SV* sv
d5ce4a7c 603Tells an SV that it is a string and disables all other OK bits,
604and leaves the UTF8 status as it was.
f1a1024e 605
914184e1 606=cut
607 */
608
a7cb1f99 609#define SvUTF8(sv) (SvFLAGS(sv) & SVf_UTF8)
610#define SvUTF8_on(sv) (SvFLAGS(sv) |= (SVf_UTF8))
611#define SvUTF8_off(sv) (SvFLAGS(sv) &= ~(SVf_UTF8))
5bc28da9 612
79072805 613#define SvPOK(sv) (SvFLAGS(sv) & SVf_POK)
a0d0e21e 614#define SvPOK_on(sv) (SvFLAGS(sv) |= (SVf_POK|SVp_POK))
8990e307 615#define SvPOK_off(sv) (SvFLAGS(sv) &= ~(SVf_POK|SVp_POK))
d41ff1b8 616#define SvPOK_only(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
617 SVf_IVisUV|SVf_UTF8), \
618 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
619#define SvPOK_only_UTF8(sv) (SvFLAGS(sv) &= ~(SVf_OK|SVf_AMAGIC| \
620 SVf_IVisUV), \
a0d0e21e 621 SvFLAGS(sv) |= (SVf_POK|SVp_POK))
79072805 622
623#define SvOOK(sv) (SvFLAGS(sv) & SVf_OOK)
155aba94 624#define SvOOK_on(sv) ((void)SvIOK_off(sv), SvFLAGS(sv) |= SVf_OOK)
79072805 625#define SvOOK_off(sv) (SvOOK(sv) && sv_backoff(sv))
79072805 626
a0d0e21e 627#define SvFAKE(sv) (SvFLAGS(sv) & SVf_FAKE)
628#define SvFAKE_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
629#define SvFAKE_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
630
ed6116ce 631#define SvROK(sv) (SvFLAGS(sv) & SVf_ROK)
a0d0e21e 632#define SvROK_on(sv) (SvFLAGS(sv) |= SVf_ROK)
a0d0e21e 633#define SvROK_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVf_AMAGIC))
79072805 634
8990e307 635#define SvMAGICAL(sv) (SvFLAGS(sv) & (SVs_GMG|SVs_SMG|SVs_RMG))
636#define SvMAGICAL_on(sv) (SvFLAGS(sv) |= (SVs_GMG|SVs_SMG|SVs_RMG))
637#define SvMAGICAL_off(sv) (SvFLAGS(sv) &= ~(SVs_GMG|SVs_SMG|SVs_RMG))
79072805 638
8990e307 639#define SvGMAGICAL(sv) (SvFLAGS(sv) & SVs_GMG)
640#define SvGMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_GMG)
641#define SvGMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_GMG)
ed6116ce 642
8990e307 643#define SvSMAGICAL(sv) (SvFLAGS(sv) & SVs_SMG)
644#define SvSMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_SMG)
645#define SvSMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_SMG)
ed6116ce 646
8990e307 647#define SvRMAGICAL(sv) (SvFLAGS(sv) & SVs_RMG)
648#define SvRMAGICAL_on(sv) (SvFLAGS(sv) |= SVs_RMG)
649#define SvRMAGICAL_off(sv) (SvFLAGS(sv) &= ~SVs_RMG)
ed6116ce 650
9e7bc3e8 651#define SvAMAGIC(sv) (SvFLAGS(sv) & SVf_AMAGIC)
652#define SvAMAGIC_on(sv) (SvFLAGS(sv) |= SVf_AMAGIC)
653#define SvAMAGIC_off(sv) (SvFLAGS(sv) &= ~SVf_AMAGIC)
a0d0e21e 654
8cf8f3d1 655#define SvGAMAGIC(sv) (SvFLAGS(sv) & (SVs_GMG|SVf_AMAGIC))
1426bbf4 656
a0d0e21e 657/*
658#define Gv_AMG(stash) \
659 (HV_AMAGICmb(stash) && \
660 ((!HV_AMAGICbad(stash) && HV_AMAGIC(stash)) || Gv_AMupdate(stash)))
661*/
3280af22 662#define Gv_AMG(stash) (PL_amagic_generation && Gv_AMupdate(stash))
a0d0e21e 663
810b8aa5 664#define SvWEAKREF(sv) ((SvFLAGS(sv) & (SVf_ROK|SVprv_WEAKREF)) \
665 == (SVf_ROK|SVprv_WEAKREF))
666#define SvWEAKREF_on(sv) (SvFLAGS(sv) |= (SVf_ROK|SVprv_WEAKREF))
667#define SvWEAKREF_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
668
a0d0e21e 669#define SvTHINKFIRST(sv) (SvFLAGS(sv) & SVf_THINKFIRST)
ed6116ce 670
8990e307 671#define SvPADBUSY(sv) (SvFLAGS(sv) & SVs_PADBUSY)
ed6116ce 672
8990e307 673#define SvPADTMP(sv) (SvFLAGS(sv) & SVs_PADTMP)
674#define SvPADTMP_on(sv) (SvFLAGS(sv) |= SVs_PADTMP|SVs_PADBUSY)
675#define SvPADTMP_off(sv) (SvFLAGS(sv) &= ~SVs_PADTMP)
ed6116ce 676
8990e307 677#define SvPADMY(sv) (SvFLAGS(sv) & SVs_PADMY)
678#define SvPADMY_on(sv) (SvFLAGS(sv) |= SVs_PADMY|SVs_PADBUSY)
ed6116ce 679
8990e307 680#define SvTEMP(sv) (SvFLAGS(sv) & SVs_TEMP)
681#define SvTEMP_on(sv) (SvFLAGS(sv) |= SVs_TEMP)
682#define SvTEMP_off(sv) (SvFLAGS(sv) &= ~SVs_TEMP)
79072805 683
8990e307 684#define SvOBJECT(sv) (SvFLAGS(sv) & SVs_OBJECT)
685#define SvOBJECT_on(sv) (SvFLAGS(sv) |= SVs_OBJECT)
686#define SvOBJECT_off(sv) (SvFLAGS(sv) &= ~SVs_OBJECT)
79072805 687
8990e307 688#define SvREADONLY(sv) (SvFLAGS(sv) & SVf_READONLY)
689#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
690#define SvREADONLY_off(sv) (SvFLAGS(sv) &= ~SVf_READONLY)
79072805 691
8990e307 692#define SvSCREAM(sv) (SvFLAGS(sv) & SVp_SCREAM)
693#define SvSCREAM_on(sv) (SvFLAGS(sv) |= SVp_SCREAM)
694#define SvSCREAM_off(sv) (SvFLAGS(sv) &= ~SVp_SCREAM)
79072805 695
8990e307 696#define SvCOMPILED(sv) (SvFLAGS(sv) & SVpfm_COMPILED)
697#define SvCOMPILED_on(sv) (SvFLAGS(sv) |= SVpfm_COMPILED)
698#define SvCOMPILED_off(sv) (SvFLAGS(sv) &= ~SVpfm_COMPILED)
79072805 699
25da4f38 700#define SvEVALED(sv) (SvFLAGS(sv) & SVrepl_EVAL)
701#define SvEVALED_on(sv) (SvFLAGS(sv) |= SVrepl_EVAL)
702#define SvEVALED_off(sv) (SvFLAGS(sv) &= ~SVrepl_EVAL)
703
8990e307 704#define SvTAIL(sv) (SvFLAGS(sv) & SVpbm_TAIL)
705#define SvTAIL_on(sv) (SvFLAGS(sv) |= SVpbm_TAIL)
706#define SvTAIL_off(sv) (SvFLAGS(sv) &= ~SVpbm_TAIL)
707
8990e307 708#define SvVALID(sv) (SvFLAGS(sv) & SVpbm_VALID)
709#define SvVALID_on(sv) (SvFLAGS(sv) |= SVpbm_VALID)
710#define SvVALID_off(sv) (SvFLAGS(sv) &= ~SVpbm_VALID)
711
1cc8b4c5 712#ifdef USE_ITHREADS
713/* The following uses the FAKE flag to show that a regex pointer is infact
8ca6097c 714 its own offset in the regexpad for ithreads */
1cc8b4c5 715#define SvREPADTMP(sv) (SvFLAGS(sv) & SVf_FAKE)
716#define SvREPADTMP_on(sv) (SvFLAGS(sv) |= SVf_FAKE)
717#define SvREPADTMP_off(sv) (SvFLAGS(sv) &= ~SVf_FAKE)
718#endif
719
ed6116ce 720#define SvRV(sv) ((XRV*) SvANY(sv))->xrv_rv
721#define SvRVx(sv) SvRV(sv)
722
463ee0b2 723#define SvIVX(sv) ((XPVIV*) SvANY(sv))->xiv_iv
724#define SvIVXx(sv) SvIVX(sv)
ff68c719 725#define SvUVX(sv) ((XPVUV*) SvANY(sv))->xuv_uv
726#define SvUVXx(sv) SvUVX(sv)
463ee0b2 727#define SvNVX(sv) ((XPVNV*)SvANY(sv))->xnv_nv
728#define SvNVXx(sv) SvNVX(sv)
729#define SvPVX(sv) ((XPV*) SvANY(sv))->xpv_pv
730#define SvPVXx(sv) SvPVX(sv)
79072805 731#define SvCUR(sv) ((XPV*) SvANY(sv))->xpv_cur
79072805 732#define SvLEN(sv) ((XPV*) SvANY(sv))->xpv_len
733#define SvLENx(sv) SvLEN(sv)
734#define SvEND(sv)(((XPV*) SvANY(sv))->xpv_pv + ((XPV*)SvANY(sv))->xpv_cur)
6b88bc9c 735#define SvENDx(sv) ((PL_Sv = (sv)), SvEND(PL_Sv))
79072805 736#define SvMAGIC(sv) ((XPVMG*) SvANY(sv))->xmg_magic
737#define SvSTASH(sv) ((XPVMG*) SvANY(sv))->xmg_stash
738
28e5dec8 739/* Ask a scalar nicely to try to become an IV, if possible.
740 Not guaranteed to stay returning void */
741/* Macro won't actually call sv_2iv if already IOK */
742#define SvIV_please(sv) \
743 STMT_START {if (!SvIOKp(sv) && (SvNOK(sv) || SvPOK(sv))) \
744 (void) SvIV(sv); } STMT_END
79072805 745#define SvIV_set(sv, val) \
80b92232 746 STMT_START { assert(SvTYPE(sv) == SVt_IV || SvTYPE(sv) >= SVt_PVIV); \
747 (((XPVIV*) SvANY(sv))->xiv_iv = val); } STMT_END
79072805 748#define SvNV_set(sv, val) \
80b92232 749 STMT_START { assert(SvTYPE(sv) == SVt_NV || SvTYPE(sv) >= SVt_PVNV); \
750 (((XPVNV*) SvANY(sv))->xnv_nv = val); } STMT_END
79072805 751#define SvPV_set(sv, val) \
80b92232 752 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
753 (((XPV*) SvANY(sv))->xpv_pv = val); } STMT_END
79072805 754#define SvCUR_set(sv, val) \
80b92232 755 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
756 (((XPV*) SvANY(sv))->xpv_cur = val); } STMT_END
79072805 757#define SvLEN_set(sv, val) \
80b92232 758 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
759 (((XPV*) SvANY(sv))->xpv_len = val); } STMT_END
79072805 760#define SvEND_set(sv, val) \
80b92232 761 STMT_START { assert(SvTYPE(sv) >= SVt_PV); \
762 (((XPV*) SvANY(sv))->xpv_cur = val - SvPVX(sv)); } STMT_END
79072805 763
764#define BmRARE(sv) ((XPVBM*) SvANY(sv))->xbm_rare
765#define BmUSEFUL(sv) ((XPVBM*) SvANY(sv))->xbm_useful
766#define BmPREVIOUS(sv) ((XPVBM*) SvANY(sv))->xbm_previous
767
768#define FmLINES(sv) ((XPVFM*) SvANY(sv))->xfm_lines
769
770#define LvTYPE(sv) ((XPVLV*) SvANY(sv))->xlv_type
771#define LvTARG(sv) ((XPVLV*) SvANY(sv))->xlv_targ
772#define LvTARGOFF(sv) ((XPVLV*) SvANY(sv))->xlv_targoff
773#define LvTARGLEN(sv) ((XPVLV*) SvANY(sv))->xlv_targlen
774
8990e307 775#define IoIFP(sv) ((XPVIO*) SvANY(sv))->xio_ifp
776#define IoOFP(sv) ((XPVIO*) SvANY(sv))->xio_ofp
777#define IoDIRP(sv) ((XPVIO*) SvANY(sv))->xio_dirp
4755096e 778#define IoANY(sv) ((XPVIO*) SvANY(sv))->xio_any
8990e307 779#define IoLINES(sv) ((XPVIO*) SvANY(sv))->xio_lines
780#define IoPAGE(sv) ((XPVIO*) SvANY(sv))->xio_page
781#define IoPAGE_LEN(sv) ((XPVIO*) SvANY(sv))->xio_page_len
782#define IoLINES_LEFT(sv)((XPVIO*) SvANY(sv))->xio_lines_left
783#define IoTOP_NAME(sv) ((XPVIO*) SvANY(sv))->xio_top_name
784#define IoTOP_GV(sv) ((XPVIO*) SvANY(sv))->xio_top_gv
785#define IoFMT_NAME(sv) ((XPVIO*) SvANY(sv))->xio_fmt_name
786#define IoFMT_GV(sv) ((XPVIO*) SvANY(sv))->xio_fmt_gv
787#define IoBOTTOM_NAME(sv)((XPVIO*) SvANY(sv))->xio_bottom_name
788#define IoBOTTOM_GV(sv) ((XPVIO*) SvANY(sv))->xio_bottom_gv
789#define IoSUBPROCESS(sv)((XPVIO*) SvANY(sv))->xio_subprocess
790#define IoTYPE(sv) ((XPVIO*) SvANY(sv))->xio_type
791#define IoFLAGS(sv) ((XPVIO*) SvANY(sv))->xio_flags
792
50952442 793/* IoTYPE(sv) is a single character telling the type of I/O connection. */
794#define IoTYPE_RDONLY '<'
795#define IoTYPE_WRONLY '>'
796#define IoTYPE_RDWR '+'
797#define IoTYPE_APPEND 'a'
798#define IoTYPE_PIPE '|'
799#define IoTYPE_STD '-' /* stdin or stdout */
800#define IoTYPE_SOCKET 's'
801#define IoTYPE_CLOSED ' '
03fcf2fc 802
803/*
954c1994 804=for apidoc Am|bool|SvTAINTED|SV* sv
805Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
806not.
807
808=for apidoc Am|void|SvTAINTED_on|SV* sv
809Marks an SV as tainted.
810
811=for apidoc Am|void|SvTAINTED_off|SV* sv
812Untaints an SV. Be I<very> careful with this routine, as it short-circuits
813some of Perl's fundamental security features. XS module authors should not
814use this function unless they fully understand all the implications of
815unconditionally untainting the value. Untainting should be done in the
816standard perl fashion, via a carefully crafted regexp, rather than directly
817untainting variables.
818
819=for apidoc Am|void|SvTAINT|SV* sv
820Taints an SV if tainting is enabled
821
822=cut
823*/
824
bbce6d69 825#define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
3280af22 826#define SvTAINTED_on(sv) STMT_START{ if(PL_tainting){sv_taint(sv);} }STMT_END
827#define SvTAINTED_off(sv) STMT_START{ if(PL_tainting){sv_untaint(sv);} }STMT_END
bbce6d69 828
c6ee37c5 829#define SvTAINT(sv) \
830 STMT_START { \
3280af22 831 if (PL_tainting) { \
3280af22 832 if (PL_tainted) \
c6ee37c5 833 SvTAINTED_on(sv); \
834 } \
835 } STMT_END
79072805 836
954c1994 837/*
838=for apidoc Am|char*|SvPV_force|SV* sv|STRLEN len
5f08bad4 839Like C<SvPV> but will force the SV into containing just a string
840(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
841directly.
954c1994 842
645c22ef 843=for apidoc Am|char*|SvPV_force_nomg|SV* sv|STRLEN len
5f08bad4 844Like C<SvPV> but will force the SV into containing just a string
845(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
846directly. Doesn't process magic.
645c22ef 847
954c1994 848=for apidoc Am|char*|SvPV|SV* sv|STRLEN len
5f08bad4 849Returns a pointer to the string in the SV, or a stringified form of
850the SV if the SV does not contain a string. The SV may cache the
851stringified version becoming C<SvPOK>. Handles 'get' magic. See also
645c22ef 852C<SvPVx> for a version which guarantees to evaluate sv only once.
853
854=for apidoc Am|char*|SvPVx|SV* sv|STRLEN len
855A version of C<SvPV> which guarantees to evaluate sv only once.
954c1994 856
857=for apidoc Am|char*|SvPV_nolen|SV* sv
5f08bad4 858Returns a pointer to the string in the SV, or a stringified form of
859the SV if the SV does not contain a string. The SV may cache the
860stringified form becoming C<SvPOK>. Handles 'get' magic.
954c1994 861
862=for apidoc Am|IV|SvIV|SV* sv
645c22ef 863Coerces the given SV to an integer and returns it. See C<SvIVx> for a
864version which guarantees to evaluate sv only once.
865
866=for apidoc Am|IV|SvIVx|SV* sv
867Coerces the given SV to an integer and returns it. Guarantees to evaluate
d1be9408 868sv only once. Use the more efficient C<SvIV> otherwise.
954c1994 869
870=for apidoc Am|NV|SvNV|SV* sv
645c22ef 871Coerce the given SV to a double and return it. See C<SvNVx> for a version
872which guarantees to evaluate sv only once.
873
874=for apidoc Am|NV|SvNVx|SV* sv
875Coerces the given SV to a double and returns it. Guarantees to evaluate
d1be9408 876sv only once. Use the more efficient C<SvNV> otherwise.
954c1994 877
878=for apidoc Am|UV|SvUV|SV* sv
645c22ef 879Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
880for a version which guarantees to evaluate sv only once.
881
882=for apidoc Am|UV|SvUVx|SV* sv
883Coerces the given SV to an unsigned integer and returns it. Guarantees to
d1be9408 884evaluate sv only once. Use the more efficient C<SvUV> otherwise.
954c1994 885
886=for apidoc Am|bool|SvTRUE|SV* sv
887Returns a boolean indicating whether Perl would evaluate the SV as true or
888false, defined or undefined. Does not handle 'get' magic.
889
645c22ef 890=for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
b70b15d2 891Like C<SvPV_force>, but converts sv to utf8 first if necessary.
645c22ef 892
893=for apidoc Am|char*|SvPVutf8|SV* sv|STRLEN len
b70b15d2 894Like C<SvPV>, but converts sv to utf8 first if necessary.
645c22ef 895
b70b15d2 896=for apidoc Am|char*|SvPVutf8_nolen|SV* sv
897Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
645c22ef 898
899=for apidoc Am|char*|SvPVbyte_force|SV* sv|STRLEN len
900Like C<SvPV_force>, but converts sv to byte representation first if necessary.
901
902=for apidoc Am|char*|SvPVbyte|SV* sv|STRLEN len
903Like C<SvPV>, but converts sv to byte representation first if necessary.
904
b70b15d2 905=for apidoc Am|char*|SvPVbyte_nolen|SV* sv
645c22ef 906Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
907
908=for apidoc Am|char*|SvPVutf8x_force|SV* sv|STRLEN len
b70b15d2 909Like C<SvPV_force>, but converts sv to utf8 first if necessary.
d1be9408 910Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
645c22ef 911otherwise.
912
913=for apidoc Am|char*|SvPVutf8x|SV* sv|STRLEN len
b70b15d2 914Like C<SvPV>, but converts sv to utf8 first if necessary.
d1be9408 915Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
645c22ef 916otherwise.
917
918=for apidoc Am|char*|SvPVbytex_force|SV* sv|STRLEN len
919Like C<SvPV_force>, but converts sv to byte representation first if necessary.
d1be9408 920Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
645c22ef 921otherwise.
922
923=for apidoc Am|char*|SvPVbytex|SV* sv|STRLEN len
924Like C<SvPV>, but converts sv to byte representation first if necessary.
d1be9408 925Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
645c22ef 926otherwise.
927
928
954c1994 929=cut
930*/
931
25da4f38 932/* Let us hope that bitmaps for UV and IV are the same */
463ee0b2 933#define SvIV(sv) (SvIOK(sv) ? SvIVX(sv) : sv_2iv(sv))
ff68c719 934#define SvUV(sv) (SvIOK(sv) ? SvUVX(sv) : sv_2uv(sv))
463ee0b2 935#define SvNV(sv) (SvNOK(sv) ? SvNVX(sv) : sv_2nv(sv))
79072805 936
baca2b92 937/* ----*/
8d6d96c1 938
8d6d96c1 939#define SvPV(sv, lp) SvPV_flags(sv, lp, SV_GMAGIC)
940
8d6d96c1 941#define SvPV_flags(sv, lp, flags) \
942 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
943 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pv_flags(sv, &lp, flags))
79072805 944
8d6d96c1 945#define SvPV_force(sv, lp) SvPV_force_flags(sv, lp, SV_GMAGIC)
baca2b92 946
8d6d96c1 947#define SvPV_force_nomg(sv, lp) SvPV_force_flags(sv, lp, 0)
948
8d6d96c1 949#define SvPV_force_flags(sv, lp, flags) \
ff68c719 950 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == SVf_POK \
8d6d96c1 951 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvn_force_flags(sv, &lp, flags))
a0d0e21e 952
1fa8b10d 953#define SvPV_nolen(sv) \
5bc28da9 954 ((SvFLAGS(sv) & (SVf_POK)) == SVf_POK \
955 ? SvPVX(sv) : sv_2pv_nolen(sv))
70401c6b 956
baca2b92 957#define SvPV_nomg(sv, lp) SvPV_flags(sv, lp, 0)
5bc28da9 958
baca2b92 959/* ----*/
70401c6b 960
5bc28da9 961#define SvPVutf8(sv, lp) \
962 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8) \
963 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvutf8(sv, &lp))
70401c6b 964
5bc28da9 965#define SvPVutf8_force(sv, lp) \
70401c6b 966 ((SvFLAGS(sv) & (SVf_POK|SVf_THINKFIRST)) == (SVf_POK|SVf_UTF8) \
5bc28da9 967 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvutf8n_force(sv, &lp))
968
baca2b92 969
5bc28da9 970#define SvPVutf8_nolen(sv) \
971 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK|SVf_UTF8)\
972 ? SvPVX(sv) : sv_2pvutf8_nolen(sv))
70401c6b 973
baca2b92 974/* ----*/
975
5bc28da9 976#define SvPVbyte(sv, lp) \
977 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
978 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_2pvbyte(sv, &lp))
70401c6b 979
5bc28da9 980#define SvPVbyte_force(sv, lp) \
981 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8|SVf_THINKFIRST)) == (SVf_POK) \
982 ? ((lp = SvCUR(sv)), SvPVX(sv)) : sv_pvbyte_force(sv, &lp))
983
5bc28da9 984#define SvPVbyte_nolen(sv) \
985 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK)\
986 ? SvPVX(sv) : sv_2pvbyte_nolen(sv))
70401c6b 987
1fa8b10d 988
baca2b92 989
990/* define FOOx(): idempotent versions of FOO(). If possible, use a local
991 * var to evaluate the arg once; failing that, use a global if possible;
992 * failing that, call a function to do the work
993 */
994
995#define SvPVx_force(sv, lp) sv_pvn_force(sv, &lp)
996#define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
997#define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
998
a80f87c4 999#ifdef __GNUC__
baca2b92 1000
a80f87c4 1001# define SvIVx(sv) ({SV *nsv = (SV*)(sv); SvIV(nsv); })
1002# define SvUVx(sv) ({SV *nsv = (SV*)(sv); SvUV(nsv); })
1003# define SvNVx(sv) ({SV *nsv = (SV*)(sv); SvNV(nsv); })
1004# define SvPVx(sv, lp) ({SV *nsv = (sv); SvPV(nsv, lp); })
5bc28da9 1005# define SvPVutf8x(sv, lp) ({SV *nsv = (sv); SvPVutf8(nsv, lp); })
1006# define SvPVbytex(sv, lp) ({SV *nsv = (sv); SvPVbyte(nsv, lp); })
a80f87c4 1007# define SvTRUE(sv) ( \
8990e307 1008 !sv \
1009 ? 0 \
1010 : SvPOK(sv) \
a80f87c4 1011 ? (({XPV *nxpv = (XPV*)SvANY(sv); \
1012 nxpv && \
c2f1de04 1013 (nxpv->xpv_cur > 1 || \
a80f87c4 1014 (nxpv->xpv_cur && *nxpv->xpv_pv != '0')); }) \
79072805 1015 ? 1 \
1016 : 0) \
1017 : \
1018 SvIOK(sv) \
463ee0b2 1019 ? SvIVX(sv) != 0 \
79072805 1020 : SvNOK(sv) \
463ee0b2 1021 ? SvNVX(sv) != 0.0 \
1022 : sv_2bool(sv) )
a80f87c4 1023# define SvTRUEx(sv) ({SV *nsv = (sv); SvTRUE(nsv); })
baca2b92 1024
a80f87c4 1025#else /* __GNUC__ */
baca2b92 1026
1027# ifdef USE_5005THREADS
1028# define SvIVx(sv) sv_iv(sv)
1029# define SvUVx(sv) sv_uv(sv)
1030# define SvNVx(sv) sv_nv(sv)
1031# define SvPVx(sv, lp) sv_pvn(sv, &lp)
1032# define SvPVutf8x(sv, lp) sv_pvutf8n(sv, &lp)
1033# define SvPVbytex(sv, lp) sv_pvbyten(sv, &lp)
1034# define SvTRUE(sv) SvTRUEx(sv)
1035# define SvTRUEx(sv) sv_true(sv)
1036
1037# else /* USE_5005THREADS */
1038
a80f87c4 1039/* These inlined macros use globals, which will require a thread
1040 * declaration in user code, so we avoid them under threads */
1041
baca2b92 1042# define SvIVx(sv) ((PL_Sv = (sv)), SvIV(PL_Sv))
1043# define SvUVx(sv) ((PL_Sv = (sv)), SvUV(PL_Sv))
1044# define SvNVx(sv) ((PL_Sv = (sv)), SvNV(PL_Sv))
1045# define SvPVx(sv, lp) ((PL_Sv = (sv)), SvPV(PL_Sv, lp))
1046# define SvPVutf8x(sv, lp) ((PL_Sv = (sv)), SvPVutf8(PL_Sv, lp))
1047# define SvPVbytex(sv, lp) ((PL_Sv = (sv)), SvPVbyte(PL_Sv, lp))
1048# define SvTRUE(sv) ( \
a80f87c4 1049 !sv \
1050 ? 0 \
1051 : SvPOK(sv) \
6b88bc9c 1052 ? ((PL_Xpv = (XPV*)SvANY(sv)) && \
c2f1de04 1053 (PL_Xpv->xpv_cur > 1 || \
6b88bc9c 1054 (PL_Xpv->xpv_cur && *PL_Xpv->xpv_pv != '0')) \
a80f87c4 1055 ? 1 \
1056 : 0) \
1057 : \
1058 SvIOK(sv) \
1059 ? SvIVX(sv) != 0 \
1060 : SvNOK(sv) \
1061 ? SvNVX(sv) != 0.0 \
1062 : sv_2bool(sv) )
baca2b92 1063# define SvTRUEx(sv) ((PL_Sv = (sv)), SvTRUE(PL_Sv))
1064# endif /* USE_5005THREADS */
1065#endif /* __GNU__ */
1066
1067
1068/* flag values for sv_*_flags functions */
1069#define SV_IMMEDIATE_UNREF 1
1070#define SV_GMAGIC 2
1071
1072/* all these 'functions' are now just macros */
1073
1074#define sv_pv(sv) SvPV_nolen(sv)
1075#define sv_pvutf8(sv) SvPVutf8_nolen(sv)
1076#define sv_pvbyte(sv) SvPVbyte_nolen(sv)
1077
1078#define sv_pvn_force_nomg(sv, lp) sv_pvn_force_flags(sv, lp, 0)
1079#define sv_utf8_upgrade_nomg(sv) sv_utf8_upgrade_flags(sv, 0)
1080#define sv_catpvn_nomg(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, 0)
1081#define sv_setsv(dsv, ssv) sv_setsv_flags(dsv, ssv, SV_GMAGIC)
1082#define sv_setsv_nomg(dsv, ssv) sv_setsv_flags(dsv, ssv, 0)
1083#define sv_catsv(dsv, ssv) sv_catsv_flags(dsv, ssv, SV_GMAGIC)
1084#define sv_catsv_nomg(dsv, ssv) sv_catsv_flags(dsv, ssv, 0)
1085#define sv_catpvn(dsv, sstr, slen) sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC)
1086#define sv_2pv(sv, lp) sv_2pv_flags(sv, lp, SV_GMAGIC)
1087#define sv_2pv_nomg(sv, lp) sv_2pv_flags(sv, lp, 0)
1088#define sv_pvn_force(sv, lp) sv_pvn_force_flags(sv, lp, SV_GMAGIC)
1089#define sv_utf8_upgrade(sv) sv_utf8_upgrade_flags(sv, SV_GMAGIC)
1090
79072805 1091
954c1994 1092/*
1093=for apidoc Am|SV*|newRV_inc|SV* sv
1094
1095Creates an RV wrapper for an SV. The reference count for the original SV is
1096incremented.
1097
1098=cut
1099*/
1100
5f05dabc 1101#define newRV_inc(sv) newRV(sv)
5f05dabc 1102
ef50df4b 1103/* the following macros update any magic values this sv is associated with */
79072805 1104
954c1994 1105/*
ccfc67b7 1106=head1 Magical Functions
1107
954c1994 1108=for apidoc Am|void|SvGETMAGIC|SV* sv
1109Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
1110argument more than once.
1111
1112=for apidoc Am|void|SvSETMAGIC|SV* sv
1113Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
1114argument more than once.
1115
1116=for apidoc Am|void|SvSetSV|SV* dsb|SV* ssv
1117Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
1118more than once.
1119
1120=for apidoc Am|void|SvSetSV_nosteal|SV* dsv|SV* ssv
1121Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
1122ssv. May evaluate arguments more than once.
1123
645c22ef 1124=for apidoc Am|void|SvSetMagicSV|SV* dsb|SV* ssv
1125Like C<SvSetSV>, but does any set magic required afterwards.
1126
1127=for apidoc Am|void|SvSetMagicSV_nosteal|SV* dsv|SV* ssv
1128Like C<SvSetMagicSV>, but does any set magic required afterwards.
1129
68795e93 1130=for apidoc Am|void|SvSHARE|SV* sv
1131Arranges for sv to be shared between threads if a suitable module
1132has been loaded.
1133
1134=for apidoc Am|void|SvLOCK|SV* sv
1135Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1136has been loaded.
1137
1138=for apidoc Am|void|SvUNLOCK|SV* sv
1139Releases a mutual exclusion lock on sv if a suitable module
1140has been loaded.
1141
ccfc67b7 1142=head1 SV Manipulation Functions
1143
679ac26e 1144=for apidoc Am|char *|SvGROW|SV* sv|STRLEN len
954c1994 1145Expands the character buffer in the SV so that it has room for the
1146indicated number of bytes (remember to reserve space for an extra trailing
8cf8f3d1 1147NUL character). Calls C<sv_grow> to perform the expansion if necessary.
954c1994 1148Returns a pointer to the character buffer.
1149
1150=cut
1151*/
1152
68795e93 1153#define SvSHARE(sv) CALL_FPTR(PL_sharehook)(aTHX_ sv)
1154#define SvLOCK(sv) CALL_FPTR(PL_lockhook)(aTHX_ sv)
1155#define SvUNLOCK(sv) CALL_FPTR(PL_unlockhook)(aTHX_ sv)
1156
189b2af5 1157#define SvGETMAGIC(x) STMT_START { if (SvGMAGICAL(x)) mg_get(x); } STMT_END
1158#define SvSETMAGIC(x) STMT_START { if (SvSMAGICAL(x)) mg_set(x); } STMT_END
79072805 1159
54310121 1160#define SvSetSV_and(dst,src,finally) \
189b2af5 1161 STMT_START { \
54310121 1162 if ((dst) != (src)) { \
1163 sv_setsv(dst, src); \
1164 finally; \
189b2af5 1165 } \
1166 } STMT_END
54310121 1167#define SvSetSV_nosteal_and(dst,src,finally) \
189b2af5 1168 STMT_START { \
8ebc5c01 1169 if ((dst) != (src)) { \
1170 U32 tMpF = SvFLAGS(src) & SVs_TEMP; \
1171 SvTEMP_off(src); \
1172 sv_setsv(dst, src); \
1173 SvFLAGS(src) |= tMpF; \
54310121 1174 finally; \
189b2af5 1175 } \
1176 } STMT_END
79072805 1177
54310121 1178#define SvSetSV(dst,src) \
c9d716f7 1179 SvSetSV_and(dst,src,/*nothing*/;)
54310121 1180#define SvSetSV_nosteal(dst,src) \
c9d716f7 1181 SvSetSV_nosteal_and(dst,src,/*nothing*/;)
54310121 1182
1183#define SvSetMagicSV(dst,src) \
1184 SvSetSV_and(dst,src,SvSETMAGIC(dst))
1185#define SvSetMagicSV_nosteal(dst,src) \
1186 SvSetSV_nosteal_and(dst,src,SvSETMAGIC(dst))
1187
1045810a 1188#if !defined(SKIP_DEBUGGING)
79072805 1189#define SvPEEK(sv) sv_peek(sv)
3967c732 1190#else
1191#define SvPEEK(sv) ""
1192#endif
79072805 1193
3280af22 1194#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no)
36477c24 1195
3280af22 1196#define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
54310121 1197
79072805 1198#define isGV(sv) (SvTYPE(sv) == SVt_PVGV)
1199
933fea7f 1200#define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
1201#define Sv_Grow sv_grow
3d35f11b 1202
a0739874 1203#define CLONEf_COPY_STACKS 1
1204#define CLONEf_KEEP_PTR_TABLE 2
c43294b8 1205#define CLONEf_CLONE_HOST 4
a0739874 1206
8cf8f3d1 1207struct clone_params {
d2d73c3e 1208 AV* stashes;
1209 UV flags;
8cf8f3d1 1210};
Unnamed repository; edit this file to name it for gitweb.