3 * Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
11 #ifndef _INC_PERL_XSUB_H
12 #define _INC_PERL_XSUB_H 1
14 /* first, some documentation for xsubpp-generated items */
17 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
19 =for apidoc Amn|char*|CLASS
20 Variable which is setup by C<xsubpp> to indicate the
21 class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
23 =for apidoc Amn|(whatever)|RETVAL
24 Variable which is setup by C<xsubpp> to hold the return value for an
25 XSUB. This is always the proper type for the XSUB. See
26 L<perlxs/"The RETVAL Variable">.
28 =for apidoc Amn|(whatever)|THIS
29 Variable which is setup by C<xsubpp> to designate the object in a C++
30 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
31 L<perlxs/"Using XS With C++">.
33 =for apidoc Amn|I32|ax
34 Variable which is setup by C<xsubpp> to indicate the stack base offset,
35 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
36 must be called prior to setup the C<MARK> variable.
38 =for apidoc Amn|I32|items
39 Variable which is setup by C<xsubpp> to indicate the number of
40 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
42 =for apidoc Amn|I32|ix
43 Variable which is setup by C<xsubpp> to indicate which of an
44 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
46 =for apidoc Am|SV*|ST|int ix
47 Used to access elements on the XSUB's stack.
50 Macro to declare an XSUB and its C parameter list. This is handled by
54 Sets up the C<ax> variable.
55 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
57 =for apidoc Ams||dITEMS
58 Sets up the C<items> variable.
59 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
61 =for apidoc Ams||dXSARGS
62 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
63 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
64 This is usually handled automatically by C<xsubpp>.
66 =for apidoc Ams||dXSI32
67 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
68 handled automatically by C<xsubpp>.
73 #define ST(off) PL_stack_base[ax + (off)]
75 #if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING)
76 # define XS(name) __declspec(dllexport) void name(pTHX_ CV* cv)
78 # define XS(name) void name(pTHX_ CV* cv)
81 #define dAX I32 ax = MARK - PL_stack_base + 1
83 #define dITEMS I32 items = SP - MARK
89 #define dXSTARG SV * targ = ((PL_op->op_private & OPpENTERSUB_HASTARG) \
90 ? PAD_SV(PL_op->op_targ) : sv_newmortal())
92 /* Should be used before final PUSHi etc. if not in PPCODE section. */
93 #define XSprePUSH (sp = PL_stack_base + ax - 1)
95 #define XSANY CvXSUBANY(cv)
97 #define dXSI32 I32 ix = XSANY.any_i32
100 # define XSINTERFACE_CVT(ret,name) ret (*name)(...)
102 # define XSINTERFACE_CVT(ret,name) ret (*name)()
104 #define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION)
105 #define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,))(f))
106 #define XSINTERFACE_FUNC_SET(cv,f) \
107 CvXSUBANY(cv).any_dxptr = (void (*) (pTHX_ void*))(f)
109 /* Simple macros to put new mortal values onto the stack. */
110 /* Typically used to return values from XS functions. */
113 =head1 Stack Manipulation Macros
115 =for apidoc Am|void|XST_mIV|int pos|IV iv
116 Place an integer into the specified position C<pos> on the stack. The
117 value is stored in a new mortal SV.
119 =for apidoc Am|void|XST_mNV|int pos|NV nv
120 Place a double into the specified position C<pos> on the stack. The value
121 is stored in a new mortal SV.
123 =for apidoc Am|void|XST_mPV|int pos|char* str
124 Place a copy of a string into the specified position C<pos> on the stack.
125 The value is stored in a new mortal SV.
127 =for apidoc Am|void|XST_mNO|int pos
128 Place C<&PL_sv_no> into the specified position C<pos> on the
131 =for apidoc Am|void|XST_mYES|int pos
132 Place C<&PL_sv_yes> into the specified position C<pos> on the
135 =for apidoc Am|void|XST_mUNDEF|int pos
136 Place C<&PL_sv_undef> into the specified position C<pos> on the
139 =for apidoc Am|void|XSRETURN|int nitems
140 Return from XSUB, indicating number of items on the stack. This is usually
141 handled by C<xsubpp>.
143 =for apidoc Am|void|XSRETURN_IV|IV iv
144 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
146 =for apidoc Am|void|XSRETURN_UV|IV uv
147 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
149 =for apidoc Am|void|XSRETURN_NV|NV nv
150 Return a double from an XSUB immediately. Uses C<XST_mNV>.
152 =for apidoc Am|void|XSRETURN_PV|char* str
153 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
155 =for apidoc Ams||XSRETURN_NO
156 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
158 =for apidoc Ams||XSRETURN_YES
159 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
161 =for apidoc Ams||XSRETURN_UNDEF
162 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
164 =for apidoc Ams||XSRETURN_EMPTY
165 Return an empty list from an XSUB immediately.
167 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
169 =for apidoc AmU||newXSproto
170 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
173 =for apidoc AmU||XS_VERSION
174 The version identifier for an XS module. This is usually
175 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
177 =for apidoc Ams||XS_VERSION_BOOTCHECK
178 Macro to verify that a PM module's $VERSION variable matches the XS
179 module's C<XS_VERSION> variable. This is usually handled automatically by
180 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
185 #define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) )
186 #define XST_mUV(i,v) (ST(i) = sv_2mortal(newSVuv(v)) )
187 #define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) )
188 #define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0)))
189 #define XST_mPVN(i,v,n) (ST(i) = sv_2mortal(newSVpvn(v,n)))
190 #define XST_mNO(i) (ST(i) = &PL_sv_no )
191 #define XST_mYES(i) (ST(i) = &PL_sv_yes )
192 #define XST_mUNDEF(i) (ST(i) = &PL_sv_undef)
194 #define XSRETURN(off) \
196 IV tmpXSoff = (off); \
197 PL_stack_sp = PL_stack_base + ax + (tmpXSoff - 1); \
201 #define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END
202 #define XSRETURN_UV(v) STMT_START { XST_mUV(0,v); XSRETURN(1); } STMT_END
203 #define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END
204 #define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END
205 #define XSRETURN_PVN(v,n) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END
206 #define XSRETURN_NO STMT_START { XST_mNO(0); XSRETURN(1); } STMT_END
207 #define XSRETURN_YES STMT_START { XST_mYES(0); XSRETURN(1); } STMT_END
208 #define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
209 #define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END
211 #define newXSproto(a,b,c,d) sv_setpv((SV*)newXS(a,b,c), d)
214 # define XS_VERSION_BOOTCHECK \
216 SV *_sv; STRLEN n_a; \
217 char *vn = Nullch, *module = SvPV(ST(0),n_a); \
218 if (items >= 2) /* version supplied as bootstrap arg */ \
221 /* XXX GV_ADDWARN */ \
222 _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
223 vn = "XS_VERSION"), FALSE); \
224 if (!_sv || !SvOK(_sv)) \
225 _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
226 vn = "VERSION"), FALSE); \
228 if (_sv && (!SvOK(_sv) || strNE(XS_VERSION, SvPV(_sv, n_a)))) \
229 Perl_croak(aTHX_ "%s object version %s does not match %s%s%s%s %"SVf,\
230 module, XS_VERSION, \
231 vn ? "$" : "", vn ? module : "", vn ? "::" : "", \
232 vn ? vn : "bootstrap parameter", _sv); \
235 # define XS_VERSION_BOOTCHECK
239 The DBM_setFilter & DBM_ckFilter macros are only used by
240 the *DB*_File modules
243 #define DBM_setFilter(db_type,code) \
246 RETVAL = sv_mortalcopy(db_type) ; \
248 if (db_type && (code == &PL_sv_undef)) { \
249 SvREFCNT_dec(db_type) ; \
254 sv_setsv(db_type, code) ; \
256 db_type = newSVsv(code) ; \
260 #define DBM_ckFilter(arg,type,name) \
262 if (db->filtering) { \
263 croak("recursion detected in %s", name) ; \
267 SAVEINT(db->filtering) ; \
268 db->filtering = TRUE ; \
274 (void) perl_call_sv(db->type, G_DISCARD); \
281 #if 1 /* for compatibility */
282 # define VTBL_sv &PL_vtbl_sv
283 # define VTBL_env &PL_vtbl_env
284 # define VTBL_envelem &PL_vtbl_envelem
285 # define VTBL_sig &PL_vtbl_sig
286 # define VTBL_sigelem &PL_vtbl_sigelem
287 # define VTBL_pack &PL_vtbl_pack
288 # define VTBL_packelem &PL_vtbl_packelem
289 # define VTBL_dbline &PL_vtbl_dbline
290 # define VTBL_isa &PL_vtbl_isa
291 # define VTBL_isaelem &PL_vtbl_isaelem
292 # define VTBL_arylen &PL_vtbl_arylen
293 # define VTBL_glob &PL_vtbl_glob
294 # define VTBL_mglob &PL_vtbl_mglob
295 # define VTBL_nkeys &PL_vtbl_nkeys
296 # define VTBL_taint &PL_vtbl_taint
297 # define VTBL_substr &PL_vtbl_substr
298 # define VTBL_vec &PL_vtbl_vec
299 # define VTBL_pos &PL_vtbl_pos
300 # define VTBL_bm &PL_vtbl_bm
301 # define VTBL_fm &PL_vtbl_fm
302 # define VTBL_uvar &PL_vtbl_uvar
303 # define VTBL_defelem &PL_vtbl_defelem
304 # define VTBL_regexp &PL_vtbl_regexp
305 # define VTBL_regdata &PL_vtbl_regdata
306 # define VTBL_regdatum &PL_vtbl_regdatum
307 # ifdef USE_LOCALE_COLLATE
308 # define VTBL_collxfrm &PL_vtbl_collxfrm
310 # define VTBL_amagic &PL_vtbl_amagic
311 # define VTBL_amagicelem &PL_vtbl_amagicelem
316 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT) && !defined(PERL_CORE)
319 # define aTHX PERL_GET_THX
323 #if defined(PERL_IMPLICIT_SYS) && !defined(PERL_CORE)
325 # if defined (NETWARE) && defined (USE_STDIO)
326 # define times PerlProc_times
327 # define setuid PerlProc_setuid
328 # define setgid PerlProc_setgid
329 # define getpid PerlProc_getpid
330 # define pause PerlProc_pause
331 # define exit PerlProc_exit
332 # define _exit PerlProc__exit
349 /* Following symbols were giving redefinition errors while building extensions - sgp 17th Oct 2000 */
359 # undef gethostbyaddr
360 # undef gethostbyname
365 # undef getprotobyname
366 # undef getprotobynumber
368 # undef getservbyname
369 # undef getservbyport
380 # define mkdir PerlDir_mkdir
381 # define chdir PerlDir_chdir
382 # define rmdir PerlDir_rmdir
383 # define closedir PerlDir_close
384 # define opendir PerlDir_open
385 # define readdir PerlDir_read
386 # define rewinddir PerlDir_rewind
387 # define seekdir PerlDir_seek
388 # define telldir PerlDir_tell
389 # define putenv PerlEnv_putenv
390 # define getenv PerlEnv_getenv
391 # define uname PerlEnv_uname
392 # define stdin PerlSIO_stdin
393 # define stdout PerlSIO_stdout
394 # define stderr PerlSIO_stderr
395 # define fopen PerlSIO_fopen
396 # define fclose PerlSIO_fclose
397 # define feof PerlSIO_feof
398 # define ferror PerlSIO_ferror
399 # define clearerr PerlSIO_clearerr
400 # define getc PerlSIO_getc
401 # define fputc PerlSIO_fputc
402 # define fputs PerlSIO_fputs
403 # define fflush PerlSIO_fflush
404 # define ungetc PerlSIO_ungetc
405 # define fileno PerlSIO_fileno
406 # define fdopen PerlSIO_fdopen
407 # define freopen PerlSIO_freopen
408 # define fread PerlSIO_fread
409 # define fwrite PerlSIO_fwrite
410 # define setbuf PerlSIO_setbuf
411 # define setvbuf PerlSIO_setvbuf
412 # define setlinebuf PerlSIO_setlinebuf
413 # define stdoutf PerlSIO_stdoutf
414 # define vfprintf PerlSIO_vprintf
415 # define ftell PerlSIO_ftell
416 # define fseek PerlSIO_fseek
417 # define fgetpos PerlSIO_fgetpos
418 # define fsetpos PerlSIO_fsetpos
419 # define frewind PerlSIO_rewind
420 # define tmpfile PerlSIO_tmpfile
421 # define access PerlLIO_access
422 # define chmod PerlLIO_chmod
423 # define chsize PerlLIO_chsize
424 # define close PerlLIO_close
425 # define dup PerlLIO_dup
426 # define dup2 PerlLIO_dup2
427 # define flock PerlLIO_flock
428 # define fstat PerlLIO_fstat
429 # define ioctl PerlLIO_ioctl
430 # define isatty PerlLIO_isatty
431 # define link PerlLIO_link
432 # define lseek PerlLIO_lseek
433 # define lstat PerlLIO_lstat
434 # define mktemp PerlLIO_mktemp
435 # define open PerlLIO_open
436 # define read PerlLIO_read
437 # define rename PerlLIO_rename
438 # define setmode PerlLIO_setmode
439 # define stat(buf,sb) PerlLIO_stat(buf,sb)
440 # define tmpnam PerlLIO_tmpnam
441 # define umask PerlLIO_umask
442 # define unlink PerlLIO_unlink
443 # define utime PerlLIO_utime
444 # define write PerlLIO_write
445 # define malloc PerlMem_malloc
446 # define realloc PerlMem_realloc
447 # define free PerlMem_free
448 # define abort PerlProc_abort
449 # define exit PerlProc_exit
450 # define _exit PerlProc__exit
451 # define execl PerlProc_execl
452 # define execv PerlProc_execv
453 # define execvp PerlProc_execvp
454 # define getuid PerlProc_getuid
455 # define geteuid PerlProc_geteuid
456 # define getgid PerlProc_getgid
457 # define getegid PerlProc_getegid
458 # define getlogin PerlProc_getlogin
459 # define kill PerlProc_kill
460 # define killpg PerlProc_killpg
461 # define pause PerlProc_pause
462 # define popen PerlProc_popen
463 # define pclose PerlProc_pclose
464 # define pipe PerlProc_pipe
465 # define setuid PerlProc_setuid
466 # define setgid PerlProc_setgid
467 # define sleep PerlProc_sleep
468 # define times PerlProc_times
469 # define wait PerlProc_wait
470 # define setjmp PerlProc_setjmp
471 # define longjmp PerlProc_longjmp
472 # define signal PerlProc_signal
473 # define getpid PerlProc_getpid
474 # define gettimeofday PerlProc_gettimeofday
475 # define htonl PerlSock_htonl
476 # define htons PerlSock_htons
477 # define ntohl PerlSock_ntohl
478 # define ntohs PerlSock_ntohs
479 # define accept PerlSock_accept
480 # define bind PerlSock_bind
481 # define connect PerlSock_connect
482 # define endhostent PerlSock_endhostent
483 # define endnetent PerlSock_endnetent
484 # define endprotoent PerlSock_endprotoent
485 # define endservent PerlSock_endservent
486 # define gethostbyaddr PerlSock_gethostbyaddr
487 # define gethostbyname PerlSock_gethostbyname
488 # define gethostent PerlSock_gethostent
489 # define gethostname PerlSock_gethostname
490 # define getnetbyaddr PerlSock_getnetbyaddr
491 # define getnetbyname PerlSock_getnetbyname
492 # define getnetent PerlSock_getnetent
493 # define getpeername PerlSock_getpeername
494 # define getprotobyname PerlSock_getprotobyname
495 # define getprotobynumber PerlSock_getprotobynumber
496 # define getprotoent PerlSock_getprotoent
497 # define getservbyname PerlSock_getservbyname
498 # define getservbyport PerlSock_getservbyport
499 # define getservent PerlSock_getservent
500 # define getsockname PerlSock_getsockname
501 # define getsockopt PerlSock_getsockopt
502 # define inet_addr PerlSock_inet_addr
503 # define inet_ntoa PerlSock_inet_ntoa
504 # define listen PerlSock_listen
505 # define recv PerlSock_recv
506 # define recvfrom PerlSock_recvfrom
507 # define select PerlSock_select
508 # define send PerlSock_send
509 # define sendto PerlSock_sendto
510 # define sethostent PerlSock_sethostent
511 # define setnetent PerlSock_setnetent
512 # define setprotoent PerlSock_setprotoent
513 # define setservent PerlSock_setservent
514 # define setsockopt PerlSock_setsockopt
515 # define shutdown PerlSock_shutdown
516 # define socket PerlSock_socket
517 # define socketpair PerlSock_socketpair
518 # endif /* NETWARE && USE_STDIO */
520 # ifdef USE_SOCKETS_AS_HANDLES
526 # define fd_set Perl_fd_set
527 # define FD_SET(n,p) PERL_FD_SET(n,p)
528 # define FD_CLR(n,p) PERL_FD_CLR(n,p)
529 # define FD_ISSET(n,p) PERL_FD_ISSET(n,p)
530 # define FD_ZERO(p) PERL_FD_ZERO(p)
531 # endif /* USE_SOCKETS_AS_HANDLES */
533 # endif /* NO_XSLOCKS */
534 #endif /* PERL_IMPLICIT_SYS && !PERL_CORE */
536 #endif /* _INC_PERL_XSUB_H */ /* include guard */