This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
another win32 portability fix: make sysread() and syswrite()
[perl5.git] / XSUB.h
CommitLineData
3280af22 1#define ST(off) PL_stack_base[ax + (off)]
a0d0e21e
LW
2
3#ifdef CAN_PROTOTYPE
76e3520e 4#ifdef PERL_OBJECT
e3b8966e 5#define XS(name) void name(CV* cv, CPerlObj* pPerl)
76e3520e 6#else
a0d0e21e 7#define XS(name) void name(CV* cv)
76e3520e 8#endif
a0d0e21e
LW
9#else
10#define XS(name) void name(cv) CV* cv;
11#endif
12
13#define dXSARGS \
3c78fafa 14 dSP; dMARK; \
3280af22 15 I32 ax = mark - PL_stack_base + 1; \
a0d0e21e
LW
16 I32 items = sp - mark
17
18#define XSANY CvXSUBANY(cv)
19
20#define dXSI32 I32 ix = XSANY.any_i32
21
cfc02341
IZ
22#ifdef __cplusplus
23# define XSINTERFACE_CVT(ret,name) ret (*name)(...)
24#else
25# define XSINTERFACE_CVT(ret,name) ret (*name)()
26#endif
27#define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION)
28#define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,))(f))
29#define XSINTERFACE_FUNC_SET(cv,f) \
30 CvXSUBANY(cv).any_dptr = (void (*) _((void*)))(f)
31
0e4ced38
GS
32#define XSRETURN(off) \
33 STMT_START { \
3280af22 34 PL_stack_sp = PL_stack_base + ax + ((off) - 1); \
0e4ced38
GS
35 return; \
36 } STMT_END
a0d0e21e 37
748a9306
LW
38/* Simple macros to put new mortal values onto the stack. */
39/* Typically used to return values from XS functions. */
4633a7c4
LW
40#define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) )
41#define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) )
42#define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0)))
3280af22
NIS
43#define XST_mNO(i) (ST(i) = &PL_sv_no )
44#define XST_mYES(i) (ST(i) = &PL_sv_yes )
45#define XST_mUNDEF(i) (ST(i) = &PL_sv_undef)
748a9306 46
80b92232
PP
47#define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END
48#define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END
49#define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END
50#define XSRETURN_NO STMT_START { XST_mNO(0); XSRETURN(1); } STMT_END
51#define XSRETURN_YES STMT_START { XST_mYES(0); XSRETURN(1); } STMT_END
52#define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
53#define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END
382b8d97 54
37120919 55#define newXSproto(a,b,c,d) sv_setpv((SV*)newXS(a,b,c), d)
720fb644
PP
56
57#ifdef XS_VERSION
58# define XS_VERSION_BOOTCHECK \
774d564b 59 STMT_START { \
6b88bc9c
GS
60 SV *tmpsv; \
61 char *vn = Nullch, *module = SvPV(ST(0),PL_na); \
774d564b 62 if (items >= 2) /* version supplied as bootstrap arg */ \
6b88bc9c 63 tmpsv = ST(1); \
774d564b 64 else { \
46fc3d4c 65 /* XXX GV_ADDWARN */ \
6b88bc9c 66 tmpsv = perl_get_sv(form("%s::%s", module, \
392e9e90 67 vn = "XS_VERSION"), FALSE); \
6b88bc9c
GS
68 if (!tmpsv || !SvOK(tmpsv)) \
69 tmpsv = perl_get_sv(form("%s::%s", module, \
392e9e90 70 vn = "VERSION"), FALSE); \
774d564b 71 } \
6b88bc9c 72 if (tmpsv && (!SvOK(tmpsv) || strNE(XS_VERSION, SvPV(tmpsv, PL_na)))) \
ae66e5c8
CS
73 croak("%s object version %s does not match %s%s%s%s %_", \
74 module, XS_VERSION, \
75 vn ? "$" : "", vn ? module : "", vn ? "::" : "", \
6b88bc9c 76 vn ? vn : "bootstrap parameter", tmpsv); \
80b92232 77 } STMT_END
720fb644
PP
78#else
79# define XS_VERSION_BOOTCHECK
80#endif
76e3520e 81
dc9e4912
GS
82#ifdef PERL_CAPI
83# define VTBL_sv get_vtbl(want_vtbl_sv)
84# define VTBL_env get_vtbl(want_vtbl_env)
85# define VTBL_envelem get_vtbl(want_vtbl_envelem)
86# define VTBL_sig get_vtbl(want_vtbl_sig)
87# define VTBL_sigelem get_vtbl(want_vtbl_sigelem)
88# define VTBL_pack get_vtbl(want_vtbl_pack)
89# define VTBL_packelem get_vtbl(want_vtbl_packelem)
90# define VTBL_dbline get_vtbl(want_vtbl_dbline)
91# define VTBL_isa get_vtbl(want_vtbl_isa)
92# define VTBL_isaelem get_vtbl(want_vtbl_isaelem)
93# define VTBL_arylen get_vtbl(want_vtbl_arylen)
94# define VTBL_glob get_vtbl(want_vtbl_glob)
95# define VTBL_mglob get_vtbl(want_vtbl_mglob)
96# define VTBL_nkeys get_vtbl(want_vtbl_nkeys)
97# define VTBL_taint get_vtbl(want_vtbl_taint)
98# define VTBL_substr get_vtbl(want_vtbl_substr)
99# define VTBL_vec get_vtbl(want_vtbl_vec)
100# define VTBL_pos get_vtbl(want_vtbl_pos)
101# define VTBL_bm get_vtbl(want_vtbl_bm)
102# define VTBL_fm get_vtbl(want_vtbl_fm)
103# define VTBL_uvar get_vtbl(want_vtbl_uvar)
104# define VTBL_defelem get_vtbl(want_vtbl_defelem)
105# define VTBL_regexp get_vtbl(want_vtbl_regexp)
106# define VTBL_regdata get_vtbl(want_vtbl_regdata)
107# define VTBL_regdatum get_vtbl(want_vtbl_regdatum)
108# ifdef USE_LOCALE_COLLATE
109# define VTBL_collxfrm get_vtbl(want_vtbl_collxfrm)
110# endif
111# ifdef OVERLOAD
112# define VTBL_amagic get_vtbl(want_vtbl_amagic)
113# define VTBL_amagicelem get_vtbl(want_vtbl_amagicelem)
114# endif
115#else
116# define VTBL_sv &PL_vtbl_sv
117# define VTBL_env &PL_vtbl_env
118# define VTBL_envelem &PL_vtbl_envelem
119# define VTBL_sig &PL_vtbl_sig
120# define VTBL_sigelem &PL_vtbl_sigelem
121# define VTBL_pack &PL_vtbl_pack
122# define VTBL_packelem &PL_vtbl_packelem
123# define VTBL_dbline &PL_vtbl_dbline
124# define VTBL_isa &PL_vtbl_isa
125# define VTBL_isaelem &PL_vtbl_isaelem
126# define VTBL_arylen &PL_vtbl_arylen
127# define VTBL_glob &PL_vtbl_glob
128# define VTBL_mglob &PL_vtbl_mglob
129# define VTBL_nkeys &PL_vtbl_nkeys
130# define VTBL_taint &PL_vtbl_taint
131# define VTBL_substr &PL_vtbl_substr
132# define VTBL_vec &PL_vtbl_vec
133# define VTBL_pos &PL_vtbl_pos
134# define VTBL_bm &PL_vtbl_bm
135# define VTBL_fm &PL_vtbl_fm
136# define VTBL_uvar &PL_vtbl_uvar
137# define VTBL_defelem &PL_vtbl_defelem
138# define VTBL_regexp &PL_vtbl_regexp
139# define VTBL_regdata &PL_vtbl_regdata
140# define VTBL_regdatum &PL_vtbl_regdatum
141# ifdef USE_LOCALE_COLLATE
142# define VTBL_collxfrm &PL_vtbl_collxfrm
143# endif
144# ifdef OVERLOAD
145# define VTBL_amagic &PL_vtbl_amagic
146# define VTBL_amagicelem &PL_vtbl_amagicelem
147# endif
148#endif
149
76e3520e 150#ifdef PERL_OBJECT
6de196ee 151#include "objXSUB.h"
565764a8
DL
152#ifndef NO_XSLOCKS
153#ifdef WIN32
6de196ee 154#include "XSlock.h"
565764a8
DL
155#endif /* WIN32 */
156#endif /* NO_XSLOCKS */
e3b8966e
GS
157#else
158#ifdef PERL_CAPI
6de196ee 159#include "perlCAPI.h"
e3b8966e 160#endif
565764a8 161#endif /* PERL_OBJECT */