This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
integrate cfgperl changes into mainline
[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
GS
81
82#ifdef PERL_OBJECT
6de196ee 83#include "objXSUB.h"
565764a8
DL
84#ifndef NO_XSLOCKS
85#ifdef WIN32
6de196ee 86#include "XSlock.h"
565764a8
DL
87#endif /* WIN32 */
88#endif /* NO_XSLOCKS */
e3b8966e
GS
89#else
90#ifdef PERL_CAPI
6de196ee 91#include "perlCAPI.h"
e3b8966e 92#endif
565764a8 93#endif /* PERL_OBJECT */