This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
support USE_THREADS+MULTIPLICITY; source compat tweaks for
[perl5.git] / XSUB.h
CommitLineData
3280af22 1#define ST(off) PL_stack_base[ax + (off)]
a0d0e21e 2
873b149f 3#if defined(CYGWIN) && defined(USE_DYNAMIC_LOADING)
0cb96387 4# define XS(name) __declspec(dllexport) void name(pTHXo_ CV* cv)
cea2e8a9 5#else
0cb96387 6# define XS(name) void name(pTHXo_ CV* cv)
a0d0e21e
LW
7#endif
8
9#define dXSARGS \
3c78fafa 10 dSP; dMARK; \
3280af22 11 I32 ax = mark - PL_stack_base + 1; \
a0d0e21e
LW
12 I32 items = sp - mark
13
14#define XSANY CvXSUBANY(cv)
15
16#define dXSI32 I32 ix = XSANY.any_i32
17
cfc02341
IZ
18#ifdef __cplusplus
19# define XSINTERFACE_CVT(ret,name) ret (*name)(...)
20#else
21# define XSINTERFACE_CVT(ret,name) ret (*name)()
22#endif
23#define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION)
73c4f7a1 24#define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,cv))(f))
cfc02341 25#define XSINTERFACE_FUNC_SET(cv,f) \
51371543 26 CvXSUBANY(cv).any_dptr = (void (*) (pTHXo_ void*))(f)
cfc02341 27
0e4ced38
GS
28#define XSRETURN(off) \
29 STMT_START { \
3280af22 30 PL_stack_sp = PL_stack_base + ax + ((off) - 1); \
0e4ced38
GS
31 return; \
32 } STMT_END
a0d0e21e 33
748a9306
LW
34/* Simple macros to put new mortal values onto the stack. */
35/* Typically used to return values from XS functions. */
4633a7c4
LW
36#define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) )
37#define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) )
38#define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0)))
79cb57f6 39#define XST_mPVN(i,v,n) (ST(i) = sv_2mortal(newSVpvn(v,n)))
3280af22
NIS
40#define XST_mNO(i) (ST(i) = &PL_sv_no )
41#define XST_mYES(i) (ST(i) = &PL_sv_yes )
42#define XST_mUNDEF(i) (ST(i) = &PL_sv_undef)
748a9306 43
80b92232
PP
44#define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END
45#define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END
46#define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END
79cb57f6 47#define XSRETURN_PVN(v) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END
80b92232
PP
48#define XSRETURN_NO STMT_START { XST_mNO(0); XSRETURN(1); } STMT_END
49#define XSRETURN_YES STMT_START { XST_mYES(0); XSRETURN(1); } STMT_END
50#define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
51#define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END
382b8d97 52
37120919 53#define newXSproto(a,b,c,d) sv_setpv((SV*)newXS(a,b,c), d)
720fb644
PP
54
55#ifdef XS_VERSION
c6af7a1a 56# define XS_VERSION_BOOTCHECK \
774d564b 57 STMT_START { \
2d8e6c8d
GS
58 SV *tmpsv; STRLEN n_a; \
59 char *vn = Nullch, *module = SvPV(ST(0),n_a); \
774d564b 60 if (items >= 2) /* version supplied as bootstrap arg */ \
6b88bc9c 61 tmpsv = ST(1); \
774d564b 62 else { \
46fc3d4c 63 /* XXX GV_ADDWARN */ \
cea2e8a9 64 tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
864dbfa3 65 vn = "XS_VERSION"), FALSE); \
6b88bc9c 66 if (!tmpsv || !SvOK(tmpsv)) \
cea2e8a9 67 tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
864dbfa3 68 vn = "VERSION"), FALSE); \
774d564b 69 } \
2d8e6c8d 70 if (tmpsv && (!SvOK(tmpsv) || strNE(XS_VERSION, SvPV(tmpsv, n_a)))) \
cea2e8a9 71 Perl_croak(aTHX_ "%s object version %s does not match %s%s%s%s %_", \
ae66e5c8
CS
72 module, XS_VERSION, \
73 vn ? "$" : "", vn ? module : "", vn ? "::" : "", \
6b88bc9c 74 vn ? vn : "bootstrap parameter", tmpsv); \
80b92232 75 } STMT_END
720fb644 76#else
c6af7a1a 77# define XS_VERSION_BOOTCHECK
720fb644 78#endif
76e3520e 79
51371543 80#if 1 /* for compatibility */
dc9e4912
GS
81# define VTBL_sv &PL_vtbl_sv
82# define VTBL_env &PL_vtbl_env
83# define VTBL_envelem &PL_vtbl_envelem
84# define VTBL_sig &PL_vtbl_sig
85# define VTBL_sigelem &PL_vtbl_sigelem
86# define VTBL_pack &PL_vtbl_pack
87# define VTBL_packelem &PL_vtbl_packelem
88# define VTBL_dbline &PL_vtbl_dbline
89# define VTBL_isa &PL_vtbl_isa
90# define VTBL_isaelem &PL_vtbl_isaelem
91# define VTBL_arylen &PL_vtbl_arylen
92# define VTBL_glob &PL_vtbl_glob
93# define VTBL_mglob &PL_vtbl_mglob
94# define VTBL_nkeys &PL_vtbl_nkeys
95# define VTBL_taint &PL_vtbl_taint
96# define VTBL_substr &PL_vtbl_substr
97# define VTBL_vec &PL_vtbl_vec
98# define VTBL_pos &PL_vtbl_pos
99# define VTBL_bm &PL_vtbl_bm
100# define VTBL_fm &PL_vtbl_fm
101# define VTBL_uvar &PL_vtbl_uvar
102# define VTBL_defelem &PL_vtbl_defelem
103# define VTBL_regexp &PL_vtbl_regexp
104# define VTBL_regdata &PL_vtbl_regdata
105# define VTBL_regdatum &PL_vtbl_regdatum
106# ifdef USE_LOCALE_COLLATE
107# define VTBL_collxfrm &PL_vtbl_collxfrm
108# endif
9e7bc3e8
JD
109# define VTBL_amagic &PL_vtbl_amagic
110# define VTBL_amagicelem &PL_vtbl_amagicelem
dc9e4912
GS
111#endif
112
c5be433b 113#if defined(PERL_OBJECT) || defined(PERL_CAPI)
51371543 114# include "perlapi.h"
c6af7a1a 115# include "objXSUB.h"
c5be433b 116#endif /* PERL_OBJECT || PERL_CAPI */
c6af7a1a 117
54aff467 118#if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT)
c5be433b
GS
119# undef aTHX
120# undef aTHX_
121# undef _aTHX
54aff467
GS
122# define aTHX PERL_GET_THX
123# define aTHX_ aTHX,
124# define _aTHX ,aTHX
125#endif
126
127#if defined(PERL_CAPI)
c6af7a1a
GS
128# ifndef NO_XSLOCKS
129# undef closedir
130# undef opendir
131# undef stdin
132# undef stdout
133# undef stderr
134# undef feof
135# undef ferror
136# undef fgetpos
137# undef ioctl
138# undef getlogin
139# undef setjmp
140# undef getc
141# undef ungetc
142# undef fileno
143
144# define mkdir PerlDir_mkdir
145# define chdir PerlDir_chdir
146# define rmdir PerlDir_rmdir
147# define closedir PerlDir_close
148# define opendir PerlDir_open
149# define readdir PerlDir_read
150# define rewinddir PerlDir_rewind
151# define seekdir PerlDir_seek
152# define telldir PerlDir_tell
153# define putenv PerlEnv_putenv
154# define getenv PerlEnv_getenv
b2af26b1 155# define uname PerlEnv_uname
c6af7a1a
GS
156# define stdin PerlIO_stdin()
157# define stdout PerlIO_stdout()
158# define stderr PerlIO_stderr()
159# define fopen PerlIO_open
160# define fclose PerlIO_close
161# define feof PerlIO_eof
162# define ferror PerlIO_error
163# define fclearerr PerlIO_clearerr
164# define getc PerlIO_getc
165# define fputc(c, f) PerlIO_putc(f,c)
166# define fputs(s, f) PerlIO_puts(f,s)
167# define fflush PerlIO_flush
168# define ungetc(c, f) PerlIO_ungetc((f),(c))
169# define fileno PerlIO_fileno
170# define fdopen PerlIO_fdopen
171# define freopen PerlIO_reopen
172# define fread(b,s,c,f) PerlIO_read((f),(b),(s*c))
173# define fwrite(b,s,c,f) PerlIO_write((f),(b),(s*c))
174# define setbuf PerlIO_setbuf
175# define setvbuf PerlIO_setvbuf
176# define setlinebuf PerlIO_setlinebuf
177# define stdoutf PerlIO_stdoutf
178# define vfprintf PerlIO_vprintf
179# define ftell PerlIO_tell
180# define fseek PerlIO_seek
181# define fgetpos PerlIO_getpos
182# define fsetpos PerlIO_setpos
183# define frewind PerlIO_rewind
184# define tmpfile PerlIO_tmpfile
185# define access PerlLIO_access
186# define chmod PerlLIO_chmod
187# define chsize PerlLIO_chsize
188# define close PerlLIO_close
189# define dup PerlLIO_dup
190# define dup2 PerlLIO_dup2
191# define flock PerlLIO_flock
192# define fstat PerlLIO_fstat
193# define ioctl PerlLIO_ioctl
194# define isatty PerlLIO_isatty
195# define lseek PerlLIO_lseek
196# define lstat PerlLIO_lstat
197# define mktemp PerlLIO_mktemp
198# define open PerlLIO_open
199# define read PerlLIO_read
200# define rename PerlLIO_rename
201# define setmode PerlLIO_setmode
202# define stat PerlLIO_stat
203# define tmpnam PerlLIO_tmpnam
204# define umask PerlLIO_umask
205# define unlink PerlLIO_unlink
206# define utime PerlLIO_utime
207# define write PerlLIO_write
208# define malloc PerlMem_malloc
209# define realloc PerlMem_realloc
210# define free PerlMem_free
211# define abort PerlProc_abort
212# define exit PerlProc_exit
213# define _exit PerlProc__exit
214# define execl PerlProc_execl
215# define execv PerlProc_execv
216# define execvp PerlProc_execvp
217# define getuid PerlProc_getuid
218# define geteuid PerlProc_geteuid
219# define getgid PerlProc_getgid
220# define getegid PerlProc_getegid
221# define getlogin PerlProc_getlogin
222# define kill PerlProc_kill
223# define killpg PerlProc_killpg
224# define pause PerlProc_pause
225# define popen PerlProc_popen
226# define pclose PerlProc_pclose
227# define pipe PerlProc_pipe
228# define setuid PerlProc_setuid
229# define setgid PerlProc_setgid
230# define sleep PerlProc_sleep
231# define times PerlProc_times
232# define wait PerlProc_wait
233# define setjmp PerlProc_setjmp
234# define longjmp PerlProc_longjmp
235# define signal PerlProc_signal
236# define htonl PerlSock_htonl
237# define htons PerlSock_htons
238# define ntohl PerlSock_ntohl
239# define ntohs PerlSock_ntohs
240# define accept PerlSock_accept
241# define bind PerlSock_bind
242# define connect PerlSock_connect
243# define endhostent PerlSock_endhostent
244# define endnetent PerlSock_endnetent
245# define endprotoent PerlSock_endprotoent
246# define endservent PerlSock_endservent
247# define gethostbyaddr PerlSock_gethostbyaddr
248# define gethostbyname PerlSock_gethostbyname
249# define gethostent PerlSock_gethostent
250# define gethostname PerlSock_gethostname
251# define getnetbyaddr PerlSock_getnetbyaddr
252# define getnetbyname PerlSock_getnetbyname
253# define getnetent PerlSock_getnetent
254# define getpeername PerlSock_getpeername
255# define getprotobyname PerlSock_getprotobyname
256# define getprotobynumber PerlSock_getprotobynumber
257# define getprotoent PerlSock_getprotoent
258# define getservbyname PerlSock_getservbyname
259# define getservbyport PerlSock_getservbyport
260# define getservent PerlSock_getservent
261# define getsockname PerlSock_getsockname
262# define getsockopt PerlSock_getsockopt
263# define inet_addr PerlSock_inet_addr
264# define inet_ntoa PerlSock_inet_ntoa
265# define listen PerlSock_listen
266# define recv PerlSock_recv
267# define recvfrom PerlSock_recvfrom
268# define select PerlSock_select
269# define send PerlSock_send
270# define sendto PerlSock_sendto
271# define sethostent PerlSock_sethostent
272# define setnetent PerlSock_setnetent
273# define setprotoent PerlSock_setprotoent
274# define setservent PerlSock_setservent
275# define setsockopt PerlSock_setsockopt
276# define shutdown PerlSock_shutdown
277# define socket PerlSock_socket
278# define socketpair PerlSock_socketpair
c6af7a1a 279# endif /* NO_XSLOCKS */
c5be433b 280#endif /* PERL_CAPI */