X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/d308986b5b369caa1602a636a5e2ecfa149dfc89..8dbc25a7eceae74c5e1ad14a02cc8019dd0767a2:/XSUB.h diff --git a/XSUB.h b/XSUB.h index cfcad5d..a149115 100644 --- a/XSUB.h +++ b/XSUB.h @@ -1,9 +1,21 @@ +/* XSUB.h + * + * Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, + * 2003, 2004, 2005, 2006, 2007 by Larry Wall and others + * + * You may distribute under the terms of either the GNU General Public + * License or the Artistic License, as specified in the README file. + * + */ + #ifndef _INC_PERL_XSUB_H #define _INC_PERL_XSUB_H 1 /* first, some documentation for xsubpp-generated items */ /* +=head1 Variables created by C and C internal functions + =for apidoc Amn|char*|CLASS Variable which is setup by C to indicate the class name for a C++ XS constructor. This is always a C. See C. @@ -18,6 +30,11 @@ Variable which is setup by C to designate the object in a C++ XSUB. This is always the proper type for the C++ object. See C and L. +=for apidoc Amn|I32|ax +Variable which is setup by C to indicate the stack base offset, +used by the C, C and C macros. The C macro +must be called prior to setup the C variable. + =for apidoc Amn|I32|items Variable which is setup by C to indicate the number of items on the stack. See L. @@ -33,32 +50,101 @@ Used to access elements on the XSUB's stack. Macro to declare an XSUB and its C parameter list. This is handled by C. +=for apidoc Ams||dAX +Sets up the C variable. +This is usually handled automatically by C by calling C. + +=for apidoc Ams||dAXMARK +Sets up the C variable and stack marker variable C. +This is usually handled automatically by C by calling C. + +=for apidoc Ams||dITEMS +Sets up the C variable. +This is usually handled automatically by C by calling C. + =for apidoc Ams||dXSARGS -Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. This -is usually handled automatically by C. Declares the C -variable to indicate the number of items on the stack. +Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. +Sets up the C and C variables by calling C and C. +This is usually handled automatically by C. =for apidoc Ams||dXSI32 Sets up the C variable for an XSUB which has aliases. This is usually handled automatically by C. +=for apidoc Ams||dUNDERBAR +Sets up the C variable for an XSUB that wishes to use +C. + +=for apidoc AmU||UNDERBAR +The SV* corresponding to the $_ variable. Works even if there +is a lexical $_ in scope. + =cut */ +#ifndef PERL_UNUSED_ARG +# if defined(lint) && defined(S_SPLINT_S) /* www.splint.org */ +# include +# define PERL_UNUSED_ARG(x) NOTE(ARGUNUSED(x)) +# else +# define PERL_UNUSED_ARG(x) ((void)x) +# endif +#endif +#ifndef PERL_UNUSED_VAR +# define PERL_UNUSED_VAR(x) ((void)x) +#endif + #define ST(off) PL_stack_base[ax + (off)] +/* XSPROTO() is also used by SWIG like this: + * + * typedef XSPROTO(SwigPerlWrapper); + * typedef SwigPerlWrapper *SwigPerlWrapperPtr; + * + * This code needs to be compilable under both C and C++. + * + * Don't forget to change the __attribute__unused__ version of XS() + * below too if you change XSPROTO() here. + */ +#define XSPROTO(name) void name(pTHX_ CV* cv) + +#undef XS #if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING) -# define XS(name) __declspec(dllexport) void name(pTHXo_ CV* cv) -#else -# define XS(name) void name(pTHXo_ CV* cv) +# define XS(name) __declspec(dllexport) XSPROTO(name) +#endif +#if defined(__SYMBIAN32__) +# define XS(name) EXPORT_C XSPROTO(name) +#endif +#ifndef XS +# if defined(HASATTRIBUTE_UNUSED) && !defined(__cplusplus) +# define XS(name) void name(pTHX_ CV* cv __attribute__unused__) +# else +# ifdef __cplusplus +# define XS(name) extern "C" XSPROTO(name) +# else +# define XS(name) XSPROTO(name) +# endif +# endif #endif -#define dXSARGS \ - dSP; dMARK; \ - I32 ax = mark - PL_stack_base + 1; \ - I32 items = sp - mark +#define dAX const I32 ax = (I32)(MARK - PL_stack_base + 1) + +#define dAXMARK \ + I32 ax = POPMARK; \ + register SV **mark = PL_stack_base + ax++ + +#define dITEMS I32 items = (I32)(SP - MARK) -#define dXSTARG SV * targ = ((PL_op->op_private & OPpENTERSUB_HASTARG) \ +#if defined(lint) && defined(S_SPLINT_S) /* www.splint.org */ +# define dXSARGS \ + NOTE(ARGUNUSED(cv)) \ + dSP; dAXMARK; dITEMS +#else +# define dXSARGS \ + dSP; dAXMARK; dITEMS +#endif + +#define dXSTARG SV * const targ = ((PL_op->op_private & OPpENTERSUB_HASTARG) \ ? PAD_SV(PL_op->op_targ) : sv_newmortal()) /* Should be used before final PUSHi etc. if not in PPCODE section. */ @@ -70,18 +156,27 @@ handled automatically by C. #ifdef __cplusplus # define XSINTERFACE_CVT(ret,name) ret (*name)(...) +# define XSINTERFACE_CVT_ANON(ret) ret (*)(...) #else # define XSINTERFACE_CVT(ret,name) ret (*name)() +# define XSINTERFACE_CVT_ANON(ret) ret (*)() #endif #define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION) -#define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,cv))(f)) +#define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT_ANON(ret))(f)) #define XSINTERFACE_FUNC_SET(cv,f) \ - CvXSUBANY(cv).any_dptr = (void (*) (pTHXo_ void*))(f) + CvXSUBANY(cv).any_dxptr = (void (*) (pTHX_ void*))(f) + +#define dUNDERBAR PADOFFSET padoff_du = find_rundefsvoffset() +#define UNDERBAR ((padoff_du == NOT_IN_PAD \ + || PAD_COMPNAME_FLAGS_isOUR(padoff_du)) \ + ? DEFSV : PAD_SVl(padoff_du)) /* Simple macros to put new mortal values onto the stack. */ /* Typically used to return values from XS functions. */ /* +=head1 Stack Manipulation Macros + =for apidoc Am|void|XST_mIV|int pos|IV iv Place an integer into the specified position C on the stack. The value is stored in a new mortal SV. @@ -113,8 +208,11 @@ handled by C. =for apidoc Am|void|XSRETURN_IV|IV iv Return an integer from an XSUB immediately. Uses C. +=for apidoc Am|void|XSRETURN_UV|IV uv +Return an integer from an XSUB immediately. Uses C. + =for apidoc Am|void|XSRETURN_NV|NV nv -Return an double from an XSUB immediately. Uses C. +Return a double from an XSUB immediately. Uses C. =for apidoc Am|void|XSRETURN_PV|char* str Return a copy of a string from an XSUB immediately. Uses C. @@ -131,7 +229,9 @@ Return C<&PL_sv_undef> from an XSUB immediately. Uses C. =for apidoc Ams||XSRETURN_EMPTY Return an empty list from an XSUB immediately. -=for apidoc AmU||newXSproto +=head1 Variables created by C and C internal functions + +=for apidoc AmU||newXSproto|char* name|XSUBADDR_t f|char* filename|const char *proto Used by C to hook up XSUBs as Perl subs. Adds Perl prototypes to the subs. @@ -144,10 +244,29 @@ Macro to verify that a PM module's $VERSION variable matches the XS module's C variable. This is usually handled automatically by C. See L. +=head1 Simple Exception Handling Macros + +=for apidoc Ams||dXCPT +Set up necessary local variables for exception handling. +See L. + +=for apidoc AmU||XCPT_TRY_START +Starts a try block. See L. + +=for apidoc AmU||XCPT_TRY_END +Ends a try block. See L. + +=for apidoc AmU||XCPT_CATCH +Introduces a catch block. See L. + +=for apidoc Ams||XCPT_RETHROW +Rethrows a previously caught exception. See L. + =cut */ #define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) ) +#define XST_mUV(i,v) (ST(i) = sv_2mortal(newSVuv(v)) ) #define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) ) #define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0))) #define XST_mPVN(i,v,n) (ST(i) = sv_2mortal(newSVpvn(v,n))) @@ -157,11 +276,13 @@ C. See L. #define XSRETURN(off) \ STMT_START { \ - PL_stack_sp = PL_stack_base + ax + ((off) - 1); \ + const IV tmpXSoff = (off); \ + PL_stack_sp = PL_stack_base + ax + (tmpXSoff - 1); \ return; \ } STMT_END #define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END +#define XSRETURN_UV(v) STMT_START { XST_mUV(0,v); XSRETURN(1); } STMT_END #define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END #define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END #define XSRETURN_PVN(v,n) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END @@ -170,33 +291,96 @@ C. See L. #define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END #define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END -#define newXSproto(a,b,c,d) sv_setpv((SV*)newXS(a,b,c), d) +#define newXSproto(a,b,c,d) newXS_flags(a,b,c,d,0) #ifdef XS_VERSION # define XS_VERSION_BOOTCHECK \ STMT_START { \ - SV *tmpsv; STRLEN n_a; \ - char *vn = Nullch, *module = SvPV(ST(0),n_a); \ + SV *_sv; \ + const char *vn = NULL, *module = SvPV_nolen_const(ST(0)); \ if (items >= 2) /* version supplied as bootstrap arg */ \ - tmpsv = ST(1); \ + _sv = ST(1); \ else { \ /* XXX GV_ADDWARN */ \ - tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \ + _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \ vn = "XS_VERSION"), FALSE); \ - if (!tmpsv || !SvOK(tmpsv)) \ - tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \ + if (!_sv || !SvOK(_sv)) \ + _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \ vn = "VERSION"), FALSE); \ } \ - if (tmpsv && (!SvOK(tmpsv) || strNE(XS_VERSION, SvPV(tmpsv, n_a)))) \ - Perl_croak(aTHX_ "%s object version %s does not match %s%s%s%s %"SVf,\ - module, XS_VERSION, \ - vn ? "$" : "", vn ? module : "", vn ? "::" : "", \ - vn ? vn : "bootstrap parameter", tmpsv); \ + if (_sv) { \ + SV *xssv = Perl_newSVpv(aTHX_ XS_VERSION, 0); \ + xssv = new_version(xssv); \ + if ( !sv_derived_from(_sv, "version") ) \ + _sv = new_version(_sv); \ + if ( vcmp(_sv,xssv) ) \ + Perl_croak(aTHX_ "%s object version %"SVf" does not match %s%s%s%s %"SVf,\ + module, SVfARG(vstringify(xssv)), \ + vn ? "$" : "", vn ? module : "", vn ? "::" : "", \ + vn ? vn : "bootstrap parameter", SVfARG(vstringify(_sv)));\ + } \ } STMT_END #else # define XS_VERSION_BOOTCHECK #endif +#ifdef NO_XSLOCKS +# define dXCPT dJMPENV; int rEtV = 0 +# define XCPT_TRY_START JMPENV_PUSH(rEtV); if (rEtV == 0) +# define XCPT_TRY_END JMPENV_POP; +# define XCPT_CATCH if (rEtV != 0) +# define XCPT_RETHROW JMPENV_JUMP(rEtV) +#endif + +/* + The DBM_setFilter & DBM_ckFilter macros are only used by + the *DB*_File modules +*/ + +#define DBM_setFilter(db_type,code) \ + STMT_START { \ + if (db_type) \ + RETVAL = sv_mortalcopy(db_type) ; \ + ST(0) = RETVAL ; \ + if (db_type && (code == &PL_sv_undef)) { \ + SvREFCNT_dec(db_type) ; \ + db_type = NULL ; \ + } \ + else if (code) { \ + if (db_type) \ + sv_setsv(db_type, code) ; \ + else \ + db_type = newSVsv(code) ; \ + } \ + } STMT_END + +#define DBM_ckFilter(arg,type,name) \ + STMT_START { \ + if (db->type) { \ + if (db->filtering) { \ + croak("recursion detected in %s", name) ; \ + } \ + ENTER ; \ + SAVETMPS ; \ + SAVEINT(db->filtering) ; \ + db->filtering = TRUE ; \ + SAVESPTR(DEFSV) ; \ + if (name[7] == 's') \ + arg = newSVsv(arg); \ + DEFSV = arg ; \ + SvTEMP_off(arg) ; \ + PUSHMARK(SP) ; \ + PUTBACK ; \ + (void) perl_call_sv(db->type, G_DISCARD); \ + SPAGAIN ; \ + PUTBACK ; \ + FREETMPS ; \ + LEAVE ; \ + if (name[7] == 's'){ \ + arg = sv_2mortal(arg); \ + } \ + } } STMT_END + #if 1 /* for compatibility */ # define VTBL_sv &PL_vtbl_sv # define VTBL_env &PL_vtbl_env @@ -231,7 +415,12 @@ C. See L. #endif #include "perlapi.h" -#include "objXSUB.h" +#ifndef PERL_MAD +# undef PL_madskills +# undef PL_xmlfp +# define PL_madskills 0 +# define PL_xmlfp 0 +#endif #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT) && !defined(PERL_CORE) # undef aTHX @@ -240,8 +429,17 @@ C. See L. # define aTHX_ aTHX, #endif -#if (defined(PERL_CAPI) || defined(PERL_IMPLICIT_SYS)) && !defined(PERL_CORE) +#if defined(PERL_IMPLICIT_SYS) && !defined(PERL_CORE) # ifndef NO_XSLOCKS +# if defined (NETWARE) && defined (USE_STDIO) +# define times PerlProc_times +# define setuid PerlProc_setuid +# define setgid PerlProc_setgid +# define getpid PerlProc_getpid +# define pause PerlProc_pause +# define exit PerlProc_exit +# define _exit PerlProc__exit +# else # undef closedir # undef opendir # undef stdin @@ -257,6 +455,37 @@ C. See L. # undef ungetc # undef fileno +/* Following symbols were giving redefinition errors while building extensions - sgp 17th Oct 2000 */ +#ifdef NETWARE +# undef readdir +# undef fstat +# undef stat +# undef longjmp +# undef endhostent +# undef endnetent +# undef endprotoent +# undef endservent +# undef gethostbyaddr +# undef gethostbyname +# undef gethostent +# undef getnetbyaddr +# undef getnetbyname +# undef getnetent +# undef getprotobyname +# undef getprotobynumber +# undef getprotoent +# undef getservbyname +# undef getservbyport +# undef getservent +# undef inet_ntoa +# undef sethostent +# undef setnetent +# undef setprotoent +# undef setservent +#endif /* NETWARE */ + +# undef socketpair + # define mkdir PerlDir_mkdir # define chdir PerlDir_chdir # define rmdir PerlDir_rmdir @@ -269,35 +498,35 @@ C. See L. # define putenv PerlEnv_putenv # define getenv PerlEnv_getenv # define uname PerlEnv_uname -# define stdin PerlIO_stdin() -# define stdout PerlIO_stdout() -# define stderr PerlIO_stderr() -# define fopen PerlIO_open -# define fclose PerlIO_close -# define feof PerlIO_eof -# define ferror PerlIO_error -# define fclearerr PerlIO_clearerr -# define getc PerlIO_getc -# define fputc(c, f) PerlIO_putc(f,c) -# define fputs(s, f) PerlIO_puts(f,s) -# define fflush PerlIO_flush -# define ungetc(c, f) PerlIO_ungetc((f),(c)) -# define fileno PerlIO_fileno -# define fdopen PerlIO_fdopen -# define freopen PerlIO_reopen -# define fread(b,s,c,f) PerlIO_read((f),(b),(s*c)) -# define fwrite(b,s,c,f) PerlIO_write((f),(b),(s*c)) -# define setbuf PerlIO_setbuf -# define setvbuf PerlIO_setvbuf -# define setlinebuf PerlIO_setlinebuf -# define stdoutf PerlIO_stdoutf -# define vfprintf PerlIO_vprintf -# define ftell PerlIO_tell -# define fseek PerlIO_seek -# define fgetpos PerlIO_getpos -# define fsetpos PerlIO_setpos -# define frewind PerlIO_rewind -# define tmpfile PerlIO_tmpfile +# define stdin PerlSIO_stdin +# define stdout PerlSIO_stdout +# define stderr PerlSIO_stderr +# define fopen PerlSIO_fopen +# define fclose PerlSIO_fclose +# define feof PerlSIO_feof +# define ferror PerlSIO_ferror +# define clearerr PerlSIO_clearerr +# define getc PerlSIO_getc +# define fputc PerlSIO_fputc +# define fputs PerlSIO_fputs +# define fflush PerlSIO_fflush +# define ungetc PerlSIO_ungetc +# define fileno PerlSIO_fileno +# define fdopen PerlSIO_fdopen +# define freopen PerlSIO_freopen +# define fread PerlSIO_fread +# define fwrite PerlSIO_fwrite +# define setbuf PerlSIO_setbuf +# define setvbuf PerlSIO_setvbuf +# define setlinebuf PerlSIO_setlinebuf +# define stdoutf PerlSIO_stdoutf +# define vfprintf PerlSIO_vprintf +# define ftell PerlSIO_ftell +# define fseek PerlSIO_fseek +# define fgetpos PerlSIO_fgetpos +# define fsetpos PerlSIO_fsetpos +# define frewind PerlSIO_rewind +# define tmpfile PerlSIO_tmpfile # define access PerlLIO_access # define chmod PerlLIO_chmod # define chsize PerlLIO_chsize @@ -351,6 +580,7 @@ C. See L. # define longjmp PerlProc_longjmp # define signal PerlProc_signal # define getpid PerlProc_getpid +# define gettimeofday PerlProc_gettimeofday # define htonl PerlSock_htonl # define htons PerlSock_htons # define ntohl PerlSock_ntohl @@ -394,7 +624,32 @@ C. See L. # define shutdown PerlSock_shutdown # define socket PerlSock_socket # define socketpair PerlSock_socketpair +# endif /* NETWARE && USE_STDIO */ + +# ifdef USE_SOCKETS_AS_HANDLES +# undef fd_set +# undef FD_SET +# undef FD_CLR +# undef FD_ISSET +# undef FD_ZERO +# define fd_set Perl_fd_set +# define FD_SET(n,p) PERL_FD_SET(n,p) +# define FD_CLR(n,p) PERL_FD_CLR(n,p) +# define FD_ISSET(n,p) PERL_FD_ISSET(n,p) +# define FD_ZERO(p) PERL_FD_ZERO(p) +# endif /* USE_SOCKETS_AS_HANDLES */ + # endif /* NO_XSLOCKS */ -#endif /* PERL_CAPI */ +#endif /* PERL_IMPLICIT_SYS && !PERL_CORE */ #endif /* _INC_PERL_XSUB_H */ /* include guard */ + +/* + * Local variables: + * c-indentation-style: bsd + * c-basic-offset: 4 + * indent-tabs-mode: t + * End: + * + * ex: set ts=8 sts=4 sw=4 noet: + */