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>.
70 =for apidoc Ams||dUNDERBAR
71 Sets up the C<padoff_du> variable for an XSUB that wishes to use
74 =for apidoc AmU||UNDERBAR
75 The SV* corresponding to the $_ variable. Works even if there
76 is a lexical $_ in scope.
81 #define ST(off) PL_stack_base[ax + (off)]
83 #if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING)
84 # define XS(name) __declspec(dllexport) void name(pTHX_ CV* cv)
86 # define XS(name) void name(pTHX_ CV* cv)
89 #define dAX I32 ax = MARK - PL_stack_base + 1
91 #define dITEMS I32 items = SP - MARK
97 #define dXSTARG SV * targ = ((PL_op->op_private & OPpENTERSUB_HASTARG) \
98 ? PAD_SV(PL_op->op_targ) : sv_newmortal())
100 /* Should be used before final PUSHi etc. if not in PPCODE section. */
101 #define XSprePUSH (sp = PL_stack_base + ax - 1)
103 #define XSANY CvXSUBANY(cv)
105 #define dXSI32 I32 ix = XSANY.any_i32
108 # define XSINTERFACE_CVT(ret,name) ret (*name)(...)
110 # define XSINTERFACE_CVT(ret,name) ret (*name)()
112 #define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION)
113 #define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,))(f))
114 #define XSINTERFACE_FUNC_SET(cv,f) \
115 CvXSUBANY(cv).any_dxptr = (void (*) (pTHX_ void*))(f)
117 #define dUNDERBAR I32 padoff_du = find_rundefsvoffset()
118 #define UNDERBAR ((padoff_du == NOT_IN_PAD \
119 || PAD_COMPNAME_FLAGS(padoff_du) & SVpad_OUR) \
120 ? DEFSV : PAD_SVl(padoff_du))
122 /* Simple macros to put new mortal values onto the stack. */
123 /* Typically used to return values from XS functions. */
126 =head1 Stack Manipulation Macros
128 =for apidoc Am|void|XST_mIV|int pos|IV iv
129 Place an integer into the specified position C<pos> on the stack. The
130 value is stored in a new mortal SV.
132 =for apidoc Am|void|XST_mNV|int pos|NV nv
133 Place a double into the specified position C<pos> on the stack. The value
134 is stored in a new mortal SV.
136 =for apidoc Am|void|XST_mPV|int pos|char* str
137 Place a copy of a string into the specified position C<pos> on the stack.
138 The value is stored in a new mortal SV.
140 =for apidoc Am|void|XST_mNO|int pos
141 Place C<&PL_sv_no> into the specified position C<pos> on the
144 =for apidoc Am|void|XST_mYES|int pos
145 Place C<&PL_sv_yes> into the specified position C<pos> on the
148 =for apidoc Am|void|XST_mUNDEF|int pos
149 Place C<&PL_sv_undef> into the specified position C<pos> on the
152 =for apidoc Am|void|XSRETURN|int nitems
153 Return from XSUB, indicating number of items on the stack. This is usually
154 handled by C<xsubpp>.
156 =for apidoc Am|void|XSRETURN_IV|IV iv
157 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
159 =for apidoc Am|void|XSRETURN_UV|IV uv
160 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
162 =for apidoc Am|void|XSRETURN_NV|NV nv
163 Return a double from an XSUB immediately. Uses C<XST_mNV>.
165 =for apidoc Am|void|XSRETURN_PV|char* str
166 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
168 =for apidoc Ams||XSRETURN_NO
169 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
171 =for apidoc Ams||XSRETURN_YES
172 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
174 =for apidoc Ams||XSRETURN_UNDEF
175 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
177 =for apidoc Ams||XSRETURN_EMPTY
178 Return an empty list from an XSUB immediately.
180 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
182 =for apidoc AmU||newXSproto|char* name|XSUBADDR_t f|char* filename|const char *proto
183 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
186 =for apidoc AmU||XS_VERSION
187 The version identifier for an XS module. This is usually
188 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
190 =for apidoc Ams||XS_VERSION_BOOTCHECK
191 Macro to verify that a PM module's $VERSION variable matches the XS
192 module's C<XS_VERSION> variable. This is usually handled automatically by
193 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
195 =head1 Simple Exception Handling Macros
197 =for apidoc Ams||dXCPT
198 Set up neccessary local variables for exception handling.
199 See L<perlguts/"Exception Handling">.
201 =for apidoc AmU||XCPT_TRY_START
202 Starts a try block. See L<perlguts/"Exception Handling">.
204 =for apidoc AmU||XCPT_TRY_END
205 Ends a try block. See L<perlguts/"Exception Handling">.
207 =for apidoc AmU||XCPT_CATCH
208 Introduces a catch block. See L<perlguts/"Exception Handling">.
210 =for apidoc Ams||XCPT_RETHROW
211 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
216 #define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) )
217 #define XST_mUV(i,v) (ST(i) = sv_2mortal(newSVuv(v)) )
218 #define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) )
219 #define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0)))
220 #define XST_mPVN(i,v,n) (ST(i) = sv_2mortal(newSVpvn(v,n)))
221 #define XST_mNO(i) (ST(i) = &PL_sv_no )
222 #define XST_mYES(i) (ST(i) = &PL_sv_yes )
223 #define XST_mUNDEF(i) (ST(i) = &PL_sv_undef)
225 #define XSRETURN(off) \
227 IV tmpXSoff = (off); \
228 PL_stack_sp = PL_stack_base + ax + (tmpXSoff - 1); \
232 #define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END
233 #define XSRETURN_UV(v) STMT_START { XST_mUV(0,v); XSRETURN(1); } STMT_END
234 #define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END
235 #define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END
236 #define XSRETURN_PVN(v,n) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END
237 #define XSRETURN_NO STMT_START { XST_mNO(0); XSRETURN(1); } STMT_END
238 #define XSRETURN_YES STMT_START { XST_mYES(0); XSRETURN(1); } STMT_END
239 #define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
240 #define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END
242 #define newXSproto(a,b,c,d) sv_setpv((SV*)newXS(a,b,c), d)
245 # define XS_VERSION_BOOTCHECK \
247 SV *_sv; STRLEN n_a; \
248 char *vn = Nullch, *module = SvPV(ST(0),n_a); \
249 if (items >= 2) /* version supplied as bootstrap arg */ \
252 /* XXX GV_ADDWARN */ \
253 _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
254 vn = "XS_VERSION"), FALSE); \
255 if (!_sv || !SvOK(_sv)) \
256 _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
257 vn = "VERSION"), FALSE); \
260 SV *xssv = Perl_newSVpvf(aTHX_ "%s",XS_VERSION); \
261 xssv = new_version(xssv); \
262 if ( !sv_derived_from(_sv, "version") ) \
263 _sv = new_version(_sv); \
264 if ( vcmp(_sv,xssv) ) \
265 Perl_croak(aTHX_ "%s object version %"SVf" does not match %s%s%s%s %"SVf,\
266 module, vstringify(xssv), \
267 vn ? "$" : "", vn ? module : "", vn ? "::" : "", \
268 vn ? vn : "bootstrap parameter", vstringify(_sv));\
272 # define XS_VERSION_BOOTCHECK
275 #define dXCPT dJMPENV; int rEtV = 0
276 #define XCPT_TRY_START JMPENV_PUSH(rEtV); if (rEtV == 0)
277 #define XCPT_TRY_END JMPENV_POP;
278 #define XCPT_CATCH if (rEtV != 0)
279 #define XCPT_RETHROW JMPENV_JUMP(rEtV)
282 The DBM_setFilter & DBM_ckFilter macros are only used by
283 the *DB*_File modules
286 #define DBM_setFilter(db_type,code) \
289 RETVAL = sv_mortalcopy(db_type) ; \
291 if (db_type && (code == &PL_sv_undef)) { \
292 SvREFCNT_dec(db_type) ; \
297 sv_setsv(db_type, code) ; \
299 db_type = newSVsv(code) ; \
303 #define DBM_ckFilter(arg,type,name) \
305 if (db->filtering) { \
306 croak("recursion detected in %s", name) ; \
310 SAVEINT(db->filtering) ; \
311 db->filtering = TRUE ; \
313 if (name[7] == 's') \
314 arg = newSVsv(arg); \
319 (void) perl_call_sv(db->type, G_DISCARD); \
324 if (name[7] == 's'){ \
325 arg = sv_2mortal(arg); \
330 #if 1 /* for compatibility */
331 # define VTBL_sv &PL_vtbl_sv
332 # define VTBL_env &PL_vtbl_env
333 # define VTBL_envelem &PL_vtbl_envelem
334 # define VTBL_sig &PL_vtbl_sig
335 # define VTBL_sigelem &PL_vtbl_sigelem
336 # define VTBL_pack &PL_vtbl_pack
337 # define VTBL_packelem &PL_vtbl_packelem
338 # define VTBL_dbline &PL_vtbl_dbline
339 # define VTBL_isa &PL_vtbl_isa
340 # define VTBL_isaelem &PL_vtbl_isaelem
341 # define VTBL_arylen &PL_vtbl_arylen
342 # define VTBL_glob &PL_vtbl_glob
343 # define VTBL_mglob &PL_vtbl_mglob
344 # define VTBL_nkeys &PL_vtbl_nkeys
345 # define VTBL_taint &PL_vtbl_taint
346 # define VTBL_substr &PL_vtbl_substr
347 # define VTBL_vec &PL_vtbl_vec
348 # define VTBL_pos &PL_vtbl_pos
349 # define VTBL_bm &PL_vtbl_bm
350 # define VTBL_fm &PL_vtbl_fm
351 # define VTBL_uvar &PL_vtbl_uvar
352 # define VTBL_defelem &PL_vtbl_defelem
353 # define VTBL_regexp &PL_vtbl_regexp
354 # define VTBL_regdata &PL_vtbl_regdata
355 # define VTBL_regdatum &PL_vtbl_regdatum
356 # ifdef USE_LOCALE_COLLATE
357 # define VTBL_collxfrm &PL_vtbl_collxfrm
359 # define VTBL_amagic &PL_vtbl_amagic
360 # define VTBL_amagicelem &PL_vtbl_amagicelem
365 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT) && !defined(PERL_CORE)
368 # define aTHX PERL_GET_THX
372 #if defined(PERL_IMPLICIT_SYS) && !defined(PERL_CORE)
374 # if defined (NETWARE) && defined (USE_STDIO)
375 # define times PerlProc_times
376 # define setuid PerlProc_setuid
377 # define setgid PerlProc_setgid
378 # define getpid PerlProc_getpid
379 # define pause PerlProc_pause
380 # define exit PerlProc_exit
381 # define _exit PerlProc__exit
398 /* Following symbols were giving redefinition errors while building extensions - sgp 17th Oct 2000 */
408 # undef gethostbyaddr
409 # undef gethostbyname
414 # undef getprotobyname
415 # undef getprotobynumber
417 # undef getservbyname
418 # undef getservbyport
429 # define mkdir PerlDir_mkdir
430 # define chdir PerlDir_chdir
431 # define rmdir PerlDir_rmdir
432 # define closedir PerlDir_close
433 # define opendir PerlDir_open
434 # define readdir PerlDir_read
435 # define rewinddir PerlDir_rewind
436 # define seekdir PerlDir_seek
437 # define telldir PerlDir_tell
438 # define putenv PerlEnv_putenv
439 # define getenv PerlEnv_getenv
440 # define uname PerlEnv_uname
441 # define stdin PerlSIO_stdin
442 # define stdout PerlSIO_stdout
443 # define stderr PerlSIO_stderr
444 # define fopen PerlSIO_fopen
445 # define fclose PerlSIO_fclose
446 # define feof PerlSIO_feof
447 # define ferror PerlSIO_ferror
448 # define clearerr PerlSIO_clearerr
449 # define getc PerlSIO_getc
450 # define fputc PerlSIO_fputc
451 # define fputs PerlSIO_fputs
452 # define fflush PerlSIO_fflush
453 # define ungetc PerlSIO_ungetc
454 # define fileno PerlSIO_fileno
455 # define fdopen PerlSIO_fdopen
456 # define freopen PerlSIO_freopen
457 # define fread PerlSIO_fread
458 # define fwrite PerlSIO_fwrite
459 # define setbuf PerlSIO_setbuf
460 # define setvbuf PerlSIO_setvbuf
461 # define setlinebuf PerlSIO_setlinebuf
462 # define stdoutf PerlSIO_stdoutf
463 # define vfprintf PerlSIO_vprintf
464 # define ftell PerlSIO_ftell
465 # define fseek PerlSIO_fseek
466 # define fgetpos PerlSIO_fgetpos
467 # define fsetpos PerlSIO_fsetpos
468 # define frewind PerlSIO_rewind
469 # define tmpfile PerlSIO_tmpfile
470 # define access PerlLIO_access
471 # define chmod PerlLIO_chmod
472 # define chsize PerlLIO_chsize
473 # define close PerlLIO_close
474 # define dup PerlLIO_dup
475 # define dup2 PerlLIO_dup2
476 # define flock PerlLIO_flock
477 # define fstat PerlLIO_fstat
478 # define ioctl PerlLIO_ioctl
479 # define isatty PerlLIO_isatty
480 # define link PerlLIO_link
481 # define lseek PerlLIO_lseek
482 # define lstat PerlLIO_lstat
483 # define mktemp PerlLIO_mktemp
484 # define open PerlLIO_open
485 # define read PerlLIO_read
486 # define rename PerlLIO_rename
487 # define setmode PerlLIO_setmode
488 # define stat(buf,sb) PerlLIO_stat(buf,sb)
489 # define tmpnam PerlLIO_tmpnam
490 # define umask PerlLIO_umask
491 # define unlink PerlLIO_unlink
492 # define utime PerlLIO_utime
493 # define write PerlLIO_write
494 # define malloc PerlMem_malloc
495 # define realloc PerlMem_realloc
496 # define free PerlMem_free
497 # define abort PerlProc_abort
498 # define exit PerlProc_exit
499 # define _exit PerlProc__exit
500 # define execl PerlProc_execl
501 # define execv PerlProc_execv
502 # define execvp PerlProc_execvp
503 # define getuid PerlProc_getuid
504 # define geteuid PerlProc_geteuid
505 # define getgid PerlProc_getgid
506 # define getegid PerlProc_getegid
507 # define getlogin PerlProc_getlogin
508 # define kill PerlProc_kill
509 # define killpg PerlProc_killpg
510 # define pause PerlProc_pause
511 # define popen PerlProc_popen
512 # define pclose PerlProc_pclose
513 # define pipe PerlProc_pipe
514 # define setuid PerlProc_setuid
515 # define setgid PerlProc_setgid
516 # define sleep PerlProc_sleep
517 # define times PerlProc_times
518 # define wait PerlProc_wait
519 # define setjmp PerlProc_setjmp
520 # define longjmp PerlProc_longjmp
521 # define signal PerlProc_signal
522 # define getpid PerlProc_getpid
523 # define gettimeofday PerlProc_gettimeofday
524 # define htonl PerlSock_htonl
525 # define htons PerlSock_htons
526 # define ntohl PerlSock_ntohl
527 # define ntohs PerlSock_ntohs
528 # define accept PerlSock_accept
529 # define bind PerlSock_bind
530 # define connect PerlSock_connect
531 # define endhostent PerlSock_endhostent
532 # define endnetent PerlSock_endnetent
533 # define endprotoent PerlSock_endprotoent
534 # define endservent PerlSock_endservent
535 # define gethostbyaddr PerlSock_gethostbyaddr
536 # define gethostbyname PerlSock_gethostbyname
537 # define gethostent PerlSock_gethostent
538 # define gethostname PerlSock_gethostname
539 # define getnetbyaddr PerlSock_getnetbyaddr
540 # define getnetbyname PerlSock_getnetbyname
541 # define getnetent PerlSock_getnetent
542 # define getpeername PerlSock_getpeername
543 # define getprotobyname PerlSock_getprotobyname
544 # define getprotobynumber PerlSock_getprotobynumber
545 # define getprotoent PerlSock_getprotoent
546 # define getservbyname PerlSock_getservbyname
547 # define getservbyport PerlSock_getservbyport
548 # define getservent PerlSock_getservent
549 # define getsockname PerlSock_getsockname
550 # define getsockopt PerlSock_getsockopt
551 # define inet_addr PerlSock_inet_addr
552 # define inet_ntoa PerlSock_inet_ntoa
553 # define listen PerlSock_listen
554 # define recv PerlSock_recv
555 # define recvfrom PerlSock_recvfrom
556 # define select PerlSock_select
557 # define send PerlSock_send
558 # define sendto PerlSock_sendto
559 # define sethostent PerlSock_sethostent
560 # define setnetent PerlSock_setnetent
561 # define setprotoent PerlSock_setprotoent
562 # define setservent PerlSock_setservent
563 # define setsockopt PerlSock_setsockopt
564 # define shutdown PerlSock_shutdown
565 # define socket PerlSock_socket
566 # define socketpair PerlSock_socketpair
567 # endif /* NETWARE && USE_STDIO */
569 # ifdef USE_SOCKETS_AS_HANDLES
575 # define fd_set Perl_fd_set
576 # define FD_SET(n,p) PERL_FD_SET(n,p)
577 # define FD_CLR(n,p) PERL_FD_CLR(n,p)
578 # define FD_ISSET(n,p) PERL_FD_ISSET(n,p)
579 # define FD_ZERO(p) PERL_FD_ZERO(p)
580 # endif /* USE_SOCKETS_AS_HANDLES */
582 # endif /* NO_XSLOCKS */
583 #endif /* PERL_IMPLICIT_SYS && !PERL_CORE */
585 #endif /* _INC_PERL_XSUB_H */ /* include guard */