1 #ifndef _INC_PERL_XSUB_H
2 #define _INC_PERL_XSUB_H 1
4 /* first, some documentation for xsubpp-generated items */
7 =for apidoc Amn|char*|CLASS
8 Variable which is setup by C<xsubpp> to indicate the
9 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
11 =for apidoc Amn|(whatever)|RETVAL
12 Variable which is setup by C<xsubpp> to hold the return value for an
13 XSUB. This is always the proper type for the XSUB. See
14 L<perlxs/"The RETVAL Variable">.
16 =for apidoc Amn|(whatever)|THIS
17 Variable which is setup by C<xsubpp> to designate the object in a C++
18 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
19 L<perlxs/"Using XS With C++">.
21 =for apidoc Amn|I32|items
22 Variable which is setup by C<xsubpp> to indicate the number of
23 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
25 =for apidoc Amn|I32|ix
26 Variable which is setup by C<xsubpp> to indicate which of an
27 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
29 =for apidoc Am|SV*|ST|int ix
30 Used to access elements on the XSUB's stack.
33 Macro to declare an XSUB and its C parameter list. This is handled by
36 =for apidoc Ams||dXSARGS
37 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. This
38 is usually handled automatically by C<xsubpp>. Declares the C<items>
39 variable to indicate the number of items on the stack.
41 =for apidoc Ams||dXSI32
42 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
43 handled automatically by C<xsubpp>.
48 #define ST(off) PL_stack_base[ax + (off)]
50 #if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING)
51 # define XS(name) __declspec(dllexport) void name(pTHXo_ CV* cv)
53 # define XS(name) void name(pTHXo_ CV* cv)
56 /* gcc -Wall: if an xsub has no arguments and PPCODE is used
57 * and none of ST, XSRETURN or XSprePUSH macros are used
58 * then `ax' (setup by dXSARGS) is unused. */
61 I32 ax __attribute__((unused)) = mark - PL_stack_base + 1; \
64 #define dXSTARG SV * targ = ((PL_op->op_private & OPpENTERSUB_HASTARG) \
65 ? PAD_SV(PL_op->op_targ) : sv_newmortal())
67 /* Should be used before final PUSHi etc. if not in PPCODE section. */
68 #define XSprePUSH (sp = PL_stack_base + ax - 1)
70 #define XSANY CvXSUBANY(cv)
72 #define dXSI32 I32 ix = XSANY.any_i32
75 # define XSINTERFACE_CVT(ret,name) ret (*name)(...)
77 # define XSINTERFACE_CVT(ret,name) ret (*name)()
79 #define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION)
80 #define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,cv))(f))
81 #define XSINTERFACE_FUNC_SET(cv,f) \
82 CvXSUBANY(cv).any_dptr = (void (*) (pTHXo_ void*))(f)
84 /* Simple macros to put new mortal values onto the stack. */
85 /* Typically used to return values from XS functions. */
88 =for apidoc Am|void|XST_mIV|int pos|IV iv
89 Place an integer into the specified position C<pos> on the stack. The
90 value is stored in a new mortal SV.
92 =for apidoc Am|void|XST_mNV|int pos|NV nv
93 Place a double into the specified position C<pos> on the stack. The value
94 is stored in a new mortal SV.
96 =for apidoc Am|void|XST_mPV|int pos|char* str
97 Place a copy of a string into the specified position C<pos> on the stack.
98 The value is stored in a new mortal SV.
100 =for apidoc Am|void|XST_mNO|int pos
101 Place C<&PL_sv_no> into the specified position C<pos> on the
104 =for apidoc Am|void|XST_mYES|int pos
105 Place C<&PL_sv_yes> into the specified position C<pos> on the
108 =for apidoc Am|void|XST_mUNDEF|int pos
109 Place C<&PL_sv_undef> into the specified position C<pos> on the
112 =for apidoc Am|void|XSRETURN|int nitems
113 Return from XSUB, indicating number of items on the stack. This is usually
114 handled by C<xsubpp>.
116 =for apidoc Am|void|XSRETURN_IV|IV iv
117 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
119 =for apidoc Am|void|XSRETURN_NV|NV nv
120 Return an double from an XSUB immediately. Uses C<XST_mNV>.
122 =for apidoc Am|void|XSRETURN_PV|char* str
123 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
125 =for apidoc Ams||XSRETURN_NO
126 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
128 =for apidoc Ams||XSRETURN_YES
129 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
131 =for apidoc Ams||XSRETURN_UNDEF
132 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
134 =for apidoc Ams||XSRETURN_EMPTY
135 Return an empty list from an XSUB immediately.
137 =for apidoc AmU||newXSproto
138 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
141 =for apidoc AmU||XS_VERSION
142 The version identifier for an XS module. This is usually
143 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
145 =for apidoc Ams||XS_VERSION_BOOTCHECK
146 Macro to verify that a PM module's $VERSION variable matches the XS
147 module's C<XS_VERSION> variable. This is usually handled automatically by
148 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
153 #define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) )
154 #define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) )
155 #define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0)))
156 #define XST_mPVN(i,v,n) (ST(i) = sv_2mortal(newSVpvn(v,n)))
157 #define XST_mNO(i) (ST(i) = &PL_sv_no )
158 #define XST_mYES(i) (ST(i) = &PL_sv_yes )
159 #define XST_mUNDEF(i) (ST(i) = &PL_sv_undef)
161 #define XSRETURN(off) \
163 PL_stack_sp = PL_stack_base + ax + ((off) - 1); \
167 #define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END
168 #define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END
169 #define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END
170 #define XSRETURN_PVN(v,n) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END
171 #define XSRETURN_NO STMT_START { XST_mNO(0); XSRETURN(1); } STMT_END
172 #define XSRETURN_YES STMT_START { XST_mYES(0); XSRETURN(1); } STMT_END
173 #define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
174 #define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END
176 #define newXSproto(a,b,c,d) sv_setpv((SV*)newXS(a,b,c), d)
179 # define XS_VERSION_BOOTCHECK \
181 SV *tmpsv; STRLEN n_a; \
182 char *vn = Nullch, *module = SvPV(ST(0),n_a); \
183 if (items >= 2) /* version supplied as bootstrap arg */ \
186 /* XXX GV_ADDWARN */ \
187 tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
188 vn = "XS_VERSION"), FALSE); \
189 if (!tmpsv || !SvOK(tmpsv)) \
190 tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
191 vn = "VERSION"), FALSE); \
193 if (tmpsv && (!SvOK(tmpsv) || strNE(XS_VERSION, SvPV(tmpsv, n_a)))) \
194 Perl_croak(aTHX_ "%s object version %s does not match %s%s%s%s %"SVf,\
195 module, XS_VERSION, \
196 vn ? "$" : "", vn ? module : "", vn ? "::" : "", \
197 vn ? vn : "bootstrap parameter", tmpsv); \
200 # define XS_VERSION_BOOTCHECK
203 #if 1 /* for compatibility */
204 # define VTBL_sv &PL_vtbl_sv
205 # define VTBL_env &PL_vtbl_env
206 # define VTBL_envelem &PL_vtbl_envelem
207 # define VTBL_sig &PL_vtbl_sig
208 # define VTBL_sigelem &PL_vtbl_sigelem
209 # define VTBL_pack &PL_vtbl_pack
210 # define VTBL_packelem &PL_vtbl_packelem
211 # define VTBL_dbline &PL_vtbl_dbline
212 # define VTBL_isa &PL_vtbl_isa
213 # define VTBL_isaelem &PL_vtbl_isaelem
214 # define VTBL_arylen &PL_vtbl_arylen
215 # define VTBL_glob &PL_vtbl_glob
216 # define VTBL_mglob &PL_vtbl_mglob
217 # define VTBL_nkeys &PL_vtbl_nkeys
218 # define VTBL_taint &PL_vtbl_taint
219 # define VTBL_substr &PL_vtbl_substr
220 # define VTBL_vec &PL_vtbl_vec
221 # define VTBL_pos &PL_vtbl_pos
222 # define VTBL_bm &PL_vtbl_bm
223 # define VTBL_fm &PL_vtbl_fm
224 # define VTBL_uvar &PL_vtbl_uvar
225 # define VTBL_defelem &PL_vtbl_defelem
226 # define VTBL_regexp &PL_vtbl_regexp
227 # define VTBL_regdata &PL_vtbl_regdata
228 # define VTBL_regdatum &PL_vtbl_regdatum
229 # ifdef USE_LOCALE_COLLATE
230 # define VTBL_collxfrm &PL_vtbl_collxfrm
232 # define VTBL_amagic &PL_vtbl_amagic
233 # define VTBL_amagicelem &PL_vtbl_amagicelem
239 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT) && !defined(PERL_CORE)
242 # define aTHX PERL_GET_THX
246 #if (defined(PERL_CAPI) || defined(PERL_IMPLICIT_SYS)) && !defined(PERL_CORE)
263 # define mkdir PerlDir_mkdir
264 # define chdir PerlDir_chdir
265 # define rmdir PerlDir_rmdir
266 # define closedir PerlDir_close
267 # define opendir PerlDir_open
268 # define readdir PerlDir_read
269 # define rewinddir PerlDir_rewind
270 # define seekdir PerlDir_seek
271 # define telldir PerlDir_tell
272 # define putenv PerlEnv_putenv
273 # define getenv PerlEnv_getenv
274 # define uname PerlEnv_uname
275 # define stdin PerlIO_stdin()
276 # define stdout PerlIO_stdout()
277 # define stderr PerlIO_stderr()
278 # define fopen PerlIO_open
279 # define fclose PerlIO_close
280 # define feof PerlIO_eof
281 # define ferror PerlIO_error
282 # define fclearerr PerlIO_clearerr
283 # define getc PerlIO_getc
284 # define fputc(c, f) PerlIO_putc(f,c)
285 # define fputs(s, f) PerlIO_puts(f,s)
286 # define fflush PerlIO_flush
287 # define ungetc(c, f) PerlIO_ungetc((f),(c))
288 # define fileno PerlIO_fileno
289 # define fdopen PerlIO_fdopen
290 # define freopen PerlIO_reopen
291 # define fread(b,s,c,f) PerlIO_read((f),(b),(s*c))
292 # define fwrite(b,s,c,f) PerlIO_write((f),(b),(s*c))
293 # define setbuf PerlIO_setbuf
294 # define setvbuf PerlIO_setvbuf
295 # define setlinebuf PerlIO_setlinebuf
296 # define stdoutf PerlIO_stdoutf
297 # define vfprintf PerlIO_vprintf
298 # define ftell PerlIO_tell
299 # define fseek PerlIO_seek
300 # define fgetpos PerlIO_getpos
301 # define fsetpos PerlIO_setpos
302 # define frewind PerlIO_rewind
303 # define tmpfile PerlIO_tmpfile
304 # define access PerlLIO_access
305 # define chmod PerlLIO_chmod
306 # define chsize PerlLIO_chsize
307 # define close PerlLIO_close
308 # define dup PerlLIO_dup
309 # define dup2 PerlLIO_dup2
310 # define flock PerlLIO_flock
311 # define fstat PerlLIO_fstat
312 # define ioctl PerlLIO_ioctl
313 # define isatty PerlLIO_isatty
314 # define link PerlLIO_link
315 # define lseek PerlLIO_lseek
316 # define lstat PerlLIO_lstat
317 # define mktemp PerlLIO_mktemp
318 # define open PerlLIO_open
319 # define read PerlLIO_read
320 # define rename PerlLIO_rename
321 # define setmode PerlLIO_setmode
322 # define stat(buf,sb) PerlLIO_stat(buf,sb)
323 # define tmpnam PerlLIO_tmpnam
324 # define umask PerlLIO_umask
325 # define unlink PerlLIO_unlink
326 # define utime PerlLIO_utime
327 # define write PerlLIO_write
328 # define malloc PerlMem_malloc
329 # define realloc PerlMem_realloc
330 # define free PerlMem_free
331 # define abort PerlProc_abort
332 # define exit PerlProc_exit
333 # define _exit PerlProc__exit
334 # define execl PerlProc_execl
335 # define execv PerlProc_execv
336 # define execvp PerlProc_execvp
337 # define getuid PerlProc_getuid
338 # define geteuid PerlProc_geteuid
339 # define getgid PerlProc_getgid
340 # define getegid PerlProc_getegid
341 # define getlogin PerlProc_getlogin
342 # define kill PerlProc_kill
343 # define killpg PerlProc_killpg
344 # define pause PerlProc_pause
345 # define popen PerlProc_popen
346 # define pclose PerlProc_pclose
347 # define pipe PerlProc_pipe
348 # define setuid PerlProc_setuid
349 # define setgid PerlProc_setgid
350 # define sleep PerlProc_sleep
351 # define times PerlProc_times
352 # define wait PerlProc_wait
353 # define setjmp PerlProc_setjmp
354 # define longjmp PerlProc_longjmp
355 # define signal PerlProc_signal
356 # define getpid PerlProc_getpid
357 # define htonl PerlSock_htonl
358 # define htons PerlSock_htons
359 # define ntohl PerlSock_ntohl
360 # define ntohs PerlSock_ntohs
361 # define accept PerlSock_accept
362 # define bind PerlSock_bind
363 # define connect PerlSock_connect
364 # define endhostent PerlSock_endhostent
365 # define endnetent PerlSock_endnetent
366 # define endprotoent PerlSock_endprotoent
367 # define endservent PerlSock_endservent
368 # define gethostbyaddr PerlSock_gethostbyaddr
369 # define gethostbyname PerlSock_gethostbyname
370 # define gethostent PerlSock_gethostent
371 # define gethostname PerlSock_gethostname
372 # define getnetbyaddr PerlSock_getnetbyaddr
373 # define getnetbyname PerlSock_getnetbyname
374 # define getnetent PerlSock_getnetent
375 # define getpeername PerlSock_getpeername
376 # define getprotobyname PerlSock_getprotobyname
377 # define getprotobynumber PerlSock_getprotobynumber
378 # define getprotoent PerlSock_getprotoent
379 # define getservbyname PerlSock_getservbyname
380 # define getservbyport PerlSock_getservbyport
381 # define getservent PerlSock_getservent
382 # define getsockname PerlSock_getsockname
383 # define getsockopt PerlSock_getsockopt
384 # define inet_addr PerlSock_inet_addr
385 # define inet_ntoa PerlSock_inet_ntoa
386 # define listen PerlSock_listen
387 # define recv PerlSock_recv
388 # define recvfrom PerlSock_recvfrom
389 # define select PerlSock_select
390 # define send PerlSock_send
391 # define sendto PerlSock_sendto
392 # define sethostent PerlSock_sethostent
393 # define setnetent PerlSock_setnetent
394 # define setprotoent PerlSock_setprotoent
395 # define setservent PerlSock_setservent
396 # define setsockopt PerlSock_setsockopt
397 # define shutdown PerlSock_shutdown
398 # define socket PerlSock_socket
399 # define socketpair PerlSock_socketpair
400 # endif /* NO_XSLOCKS */
401 #endif /* PERL_CAPI */
403 #endif /* _INC_PERL_XSUB_H */ /* include guard */