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