X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=XSUB.h;h=ce76a7b132b60264e7d77c7302086cae745c558b;hb=3d27e215577f06a0418206573270be9a039edb17;hp=5c3ec647eaa664a086208c280ee37dc19fcc0c33;hpb=864dbfa3ca8032ef66f7aa86961933b19b962357;p=p5sagit%2Fp5-mst-13.2.git diff --git a/XSUB.h b/XSUB.h index 5c3ec64..ce76a7b 100644 --- a/XSUB.h +++ b/XSUB.h @@ -1,23 +1,96 @@ +/* XSUB.h + * + * Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, + * 2000, 2001, 2002, 2003, 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. + +=for apidoc Amn|(whatever)|RETVAL +Variable which is setup by C to hold the return value for an +XSUB. This is always the proper type for the XSUB. See +L. + +=for apidoc Amn|(whatever)|THIS +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. + +=for apidoc Amn|I32|ix +Variable which is setup by C to indicate which of an +XSUB's aliases was used to invoke it. See L. + +=for apidoc Am|SV*|ST|int ix +Used to access elements on the XSUB's stack. + +=for apidoc AmU||XS +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||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. +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. + +=cut +*/ + #define ST(off) PL_stack_base[ax + (off)] -#ifdef CAN_PROTOTYPE -# ifdef PERL_OBJECT -# define XS(name) void name(CV* cv, CPerlObj* pPerl) -# else -# if defined(CYGWIN32) && defined(USE_DYNAMIC_LOADING) -# define XS(name) __declspec(dllexport) void name(CV* cv) -# else -# define XS(name) void name(CV* cv) -# endif -# endif +#if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING) +# define XS(name) __declspec(dllexport) void name(pTHX_ CV* cv) #else -# define XS(name) void name(cv) CV* cv; +# define XS(name) void name(pTHX_ CV* cv) #endif +#define dAX I32 ax = MARK - PL_stack_base + 1 + +#define dITEMS I32 items = SP - MARK + #define dXSARGS \ dSP; dMARK; \ - I32 ax = mark - PL_stack_base + 1; \ - I32 items = sp - mark + dAX; dITEMS + +#define dXSTARG SV * 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. */ +#define XSprePUSH (sp = PL_stack_base + ax - 1) #define XSANY CvXSUBANY(cv) @@ -29,30 +102,106 @@ # define XSINTERFACE_CVT(ret,name) ret (*name)() #endif #define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION) -#define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,))(f)) +#define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,))(f)) #define XSINTERFACE_FUNC_SET(cv,f) \ - CvXSUBANY(cv).any_dptr = (void (*) (void*))(f) - -#define XSRETURN(off) \ - STMT_START { \ - PL_stack_sp = PL_stack_base + ax + ((off) - 1); \ - return; \ - } STMT_END + CvXSUBANY(cv).any_dxptr = (void (*) (pTHX_ void*))(f) /* 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. + +=for apidoc Am|void|XST_mNV|int pos|NV nv +Place a double into the specified position C on the stack. The value +is stored in a new mortal SV. + +=for apidoc Am|void|XST_mPV|int pos|char* str +Place a copy of a string into the specified position C on the stack. +The value is stored in a new mortal SV. + +=for apidoc Am|void|XST_mNO|int pos +Place C<&PL_sv_no> into the specified position C on the +stack. + +=for apidoc Am|void|XST_mYES|int pos +Place C<&PL_sv_yes> into the specified position C on the +stack. + +=for apidoc Am|void|XST_mUNDEF|int pos +Place C<&PL_sv_undef> into the specified position C on the +stack. + +=for apidoc Am|void|XSRETURN|int nitems +Return from XSUB, indicating number of items on the stack. This is usually +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 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. + +=for apidoc Ams||XSRETURN_NO +Return C<&PL_sv_no> from an XSUB immediately. Uses C. + +=for apidoc Ams||XSRETURN_YES +Return C<&PL_sv_yes> from an XSUB immediately. Uses C. + +=for apidoc Ams||XSRETURN_UNDEF +Return C<&PL_sv_undef> from an XSUB immediately. Uses C. + +=for apidoc Ams||XSRETURN_EMPTY +Return an empty list from an XSUB immediately. + +=head1 Variables created by C and C internal functions + +=for apidoc AmU||newXSproto +Used by C to hook up XSUBs as Perl subs. Adds Perl prototypes to +the subs. + +=for apidoc AmU||XS_VERSION +The version identifier for an XS module. This is usually +handled automatically by C. See C. + +=for apidoc Ams||XS_VERSION_BOOTCHECK +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. + +=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))) #define XST_mNO(i) (ST(i) = &PL_sv_no ) #define XST_mYES(i) (ST(i) = &PL_sv_yes ) #define XST_mUNDEF(i) (ST(i) = &PL_sv_undef) - + +#define XSRETURN(off) \ + STMT_START { \ + PL_stack_sp = PL_stack_base + ax + ((off) - 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) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END +#define XSRETURN_PVN(v,n) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END #define XSRETURN_NO STMT_START { XST_mNO(0); XSRETURN(1); } STMT_END #define XSRETURN_YES STMT_START { XST_mYES(0); XSRETURN(1); } STMT_END #define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END @@ -69,14 +218,14 @@ tmpsv = ST(1); \ else { \ /* XXX GV_ADDWARN */ \ - tmpsv = get_sv(form("%s::%s", module, \ + tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \ vn = "XS_VERSION"), FALSE); \ if (!tmpsv || !SvOK(tmpsv)) \ - tmpsv = get_sv(form("%s::%s", module, \ + tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \ vn = "VERSION"), FALSE); \ } \ if (tmpsv && (!SvOK(tmpsv) || strNE(XS_VERSION, SvPV(tmpsv, n_a)))) \ - croak("%s object version %s does not match %s%s%s%s %_", \ + 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); \ @@ -85,38 +234,50 @@ # define XS_VERSION_BOOTCHECK #endif -#ifdef PERL_CAPI -# define VTBL_sv get_vtbl(want_vtbl_sv) -# define VTBL_env get_vtbl(want_vtbl_env) -# define VTBL_envelem get_vtbl(want_vtbl_envelem) -# define VTBL_sig get_vtbl(want_vtbl_sig) -# define VTBL_sigelem get_vtbl(want_vtbl_sigelem) -# define VTBL_pack get_vtbl(want_vtbl_pack) -# define VTBL_packelem get_vtbl(want_vtbl_packelem) -# define VTBL_dbline get_vtbl(want_vtbl_dbline) -# define VTBL_isa get_vtbl(want_vtbl_isa) -# define VTBL_isaelem get_vtbl(want_vtbl_isaelem) -# define VTBL_arylen get_vtbl(want_vtbl_arylen) -# define VTBL_glob get_vtbl(want_vtbl_glob) -# define VTBL_mglob get_vtbl(want_vtbl_mglob) -# define VTBL_nkeys get_vtbl(want_vtbl_nkeys) -# define VTBL_taint get_vtbl(want_vtbl_taint) -# define VTBL_substr get_vtbl(want_vtbl_substr) -# define VTBL_vec get_vtbl(want_vtbl_vec) -# define VTBL_pos get_vtbl(want_vtbl_pos) -# define VTBL_bm get_vtbl(want_vtbl_bm) -# define VTBL_fm get_vtbl(want_vtbl_fm) -# define VTBL_uvar get_vtbl(want_vtbl_uvar) -# define VTBL_defelem get_vtbl(want_vtbl_defelem) -# define VTBL_regexp get_vtbl(want_vtbl_regexp) -# define VTBL_regdata get_vtbl(want_vtbl_regdata) -# define VTBL_regdatum get_vtbl(want_vtbl_regdatum) -# ifdef USE_LOCALE_COLLATE -# define VTBL_collxfrm get_vtbl(want_vtbl_collxfrm) -# endif -# define VTBL_amagic get_vtbl(want_vtbl_amagic) -# define VTBL_amagicelem get_vtbl(want_vtbl_amagicelem) -#else +/* + The DBM_setFilter & DBM_ckFilter macros are only used by + the *DB*_File modules +*/ + +#define DBM_setFilter(db_type,code) \ + { \ + 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) ; \ + } \ + } + +#define DBM_ckFilter(arg,type,name) \ + if (db->type) { \ + if (db->filtering) { \ + croak("recursion detected in %s", name) ; \ + } \ + ENTER ; \ + SAVETMPS ; \ + SAVEINT(db->filtering) ; \ + db->filtering = TRUE ; \ + SAVESPTR(DEFSV) ; \ + DEFSV = arg ; \ + SvTEMP_off(arg) ; \ + PUSHMARK(SP) ; \ + PUTBACK ; \ + (void) perl_call_sv(db->type, G_DISCARD); \ + SPAGAIN ; \ + PUTBACK ; \ + FREETMPS ; \ + LEAVE ; \ + } + +#if 1 /* for compatibility */ # define VTBL_sv &PL_vtbl_sv # define VTBL_env &PL_vtbl_env # define VTBL_envelem &PL_vtbl_envelem @@ -149,40 +310,26 @@ # define VTBL_amagicelem &PL_vtbl_amagicelem #endif -#ifdef PERL_OBJECT -# include "objXSUB.h" - -# undef PERL_OBJECT_THIS -# define PERL_OBJECT_THIS pPerl -# undef PERL_OBJECT_THIS_ -# define PERL_OBJECT_THIS_ pPerl, - -# undef SAVEDESTRUCTOR -# define SAVEDESTRUCTOR(f,p) \ - pPerl->Perl_save_destructor((FUNC_NAME_TO_PTR(f)),(p)) - -# ifdef WIN32 -# ifndef WIN32IO_IS_STDIO -# undef errno -# define errno ErrorNo() -# endif -# undef ErrorNo -# define ErrorNo pPerl->ErrorNo -# undef NtCrypt -# define NtCrypt pPerl->NtCrypt -# undef NtGetLib -# define NtGetLib pPerl->NtGetLib -# undef NtGetArchLib -# define NtGetArchLib pPerl->NtGetArchLib -# undef NtGetSiteLib -# define NtGetSiteLib pPerl->NtGetSiteLib -# undef NtGetBin -# define NtGetBin pPerl->NtGetBin -# undef NtGetDebugScriptStr -# define NtGetDebugScriptStr pPerl->NtGetDebugScriptStr -# endif /* WIN32 */ +#include "perlapi.h" +#if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT) && !defined(PERL_CORE) +# undef aTHX +# undef aTHX_ +# define aTHX PERL_GET_THX +# define aTHX_ aTHX, +#endif + +#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 @@ -198,6 +345,37 @@ # 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 @@ -210,35 +388,35 @@ # 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 @@ -249,6 +427,7 @@ # define fstat PerlLIO_fstat # define ioctl PerlLIO_ioctl # define isatty PerlLIO_isatty +# define link PerlLIO_link # define lseek PerlLIO_lseek # define lstat PerlLIO_lstat # define mktemp PerlLIO_mktemp @@ -256,7 +435,7 @@ # define read PerlLIO_read # define rename PerlLIO_rename # define setmode PerlLIO_setmode -# define stat PerlLIO_stat +# define stat(buf,sb) PerlLIO_stat(buf,sb) # define tmpnam PerlLIO_tmpnam # define umask PerlLIO_umask # define unlink PerlLIO_unlink @@ -290,6 +469,8 @@ # define setjmp PerlProc_setjmp # 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 @@ -333,13 +514,22 @@ # 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 */ -# ifdef WIN32 -# include "XSlock.h" -# endif /* WIN32 */ # endif /* NO_XSLOCKS */ -#else -# ifdef PERL_CAPI -# include "perlCAPI.h" -# endif -#endif /* PERL_OBJECT */ +#endif /* PERL_IMPLICIT_SYS && !PERL_CORE */ + +#endif /* _INC_PERL_XSUB_H */ /* include guard */