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