+#ifndef _INC_PERL_XSUB_H
+#define _INC_PERL_XSUB_H 1
+
+/* first, some documentation for xsubpp-generated items */
+
+/*
+=for apidoc Amn|char*|CLASS
+Variable which is setup by C<xsubpp> to indicate the
+class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
+
+=for apidoc Amn|(whatever)|RETVAL
+Variable which is setup by C<xsubpp> to hold the return value for an
+XSUB. This is always the proper type for the XSUB. See
+L<perlxs/"The RETVAL Variable">.
+
+=for apidoc Amn|(whatever)|THIS
+Variable which is setup by C<xsubpp> to designate the object in a C++
+XSUB. This is always the proper type for the C++ object. See C<CLASS> and
+L<perlxs/"Using XS With C++">.
+
+=for apidoc Amn|I32|items
+Variable which is setup by C<xsubpp> to indicate the number of
+items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
+
+=for apidoc Amn|I32|ix
+Variable which is setup by C<xsubpp> to indicate which of an
+XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
+
+=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<xsubpp>.
+
+=for apidoc Ams||dXSARGS
+Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. This
+is usually handled automatically by C<xsubpp>. Declares the C<items>
+variable to indicate the number of items on the stack.
+
+=for apidoc Ams||dXSI32
+Sets up the C<ix> variable for an XSUB which has aliases. This is usually
+handled automatically by C<xsubpp>.
+
+=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
-# define XS(name) void name(CV* cv)
-# endif
+#if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING)
+# define XS(name) __declspec(dllexport) void name(pTHXo_ CV* cv)
#else
-# define XS(name) void name(cv) CV* cv;
+# define XS(name) void name(pTHXo_ CV* cv)
#endif
#define dXSARGS \
I32 ax = mark - PL_stack_base + 1; \
I32 items = sp - mark
+#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)
#define dXSI32 I32 ix = XSANY.any_i32
# 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,cv))(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_dptr = (void (*) (pTHXo_ void*))(f)
/* Simple macros to put new mortal values onto the stack. */
/* Typically used to return values from XS functions. */
+
+/*
+=for apidoc Am|void|XST_mIV|int pos|IV iv
+Place an integer into the specified position C<pos> 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<pos> 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<pos> 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<pos> on the
+stack.
+
+=for apidoc Am|void|XST_mYES|int pos
+Place C<&PL_sv_yes> into the specified position C<pos> on the
+stack.
+
+=for apidoc Am|void|XST_mUNDEF|int pos
+Place C<&PL_sv_undef> into the specified position C<pos> 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<xsubpp>.
+
+=for apidoc Am|void|XSRETURN_IV|IV iv
+Return an integer from an XSUB immediately. Uses C<XST_mIV>.
+
+=for apidoc Am|void|XSRETURN_NV|NV nv
+Return an double from an XSUB immediately. Uses C<XST_mNV>.
+
+=for apidoc Am|void|XSRETURN_PV|char* str
+Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
+
+=for apidoc Ams||XSRETURN_NO
+Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
+
+=for apidoc Ams||XSRETURN_YES
+Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
+
+=for apidoc Ams||XSRETURN_UNDEF
+Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
+
+=for apidoc Ams||XSRETURN_EMPTY
+Return an empty list from an XSUB immediately.
+
+=for apidoc AmU||newXSproto
+Used by C<xsubpp> 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<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
+
+=for apidoc Ams||XS_VERSION_BOOTCHECK
+Macro to verify that a PM module's $VERSION variable matches the XS
+module's C<XS_VERSION> variable. This is usually handled automatically by
+C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
+
+=cut
+*/
+
#define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(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_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
#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
tmpsv = ST(1); \
else { \
/* XXX GV_ADDWARN */ \
- tmpsv = perl_get_sv(form("%s::%s", module, \
- vn = "XS_VERSION"), FALSE); \
+ tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
+ vn = "XS_VERSION"), FALSE); \
if (!tmpsv || !SvOK(tmpsv)) \
- tmpsv = perl_get_sv(form("%s::%s", module, \
- vn = "VERSION"), FALSE); \
+ 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); \
# 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
-# ifdef OVERLOAD
-# define VTBL_amagic get_vtbl(want_vtbl_amagic)
-# define VTBL_amagicelem get_vtbl(want_vtbl_amagicelem)
-# endif
-#else
+#if 1 /* for compatibility */
# define VTBL_sv &PL_vtbl_sv
# define VTBL_env &PL_vtbl_env
# define VTBL_envelem &PL_vtbl_envelem
# ifdef USE_LOCALE_COLLATE
# define VTBL_collxfrm &PL_vtbl_collxfrm
# endif
-# ifdef OVERLOAD
-# define VTBL_amagic &PL_vtbl_amagic
-# define VTBL_amagicelem &PL_vtbl_amagicelem
-# endif
+# define VTBL_amagic &PL_vtbl_amagic
+# 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"
+#include "objXSUB.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_CAPI) || defined(PERL_IMPLICIT_SYS)) && !defined(PERL_CORE)
# ifndef NO_XSLOCKS
# undef closedir
# undef opendir
# define telldir PerlDir_tell
# 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 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
# 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
# define setjmp PerlProc_setjmp
# define longjmp PerlProc_longjmp
# define signal PerlProc_signal
+# define getpid PerlProc_getpid
# define htonl PerlSock_htonl
# define htons PerlSock_htons
# define ntohl PerlSock_ntohl
# define shutdown PerlSock_shutdown
# define socket PerlSock_socket
# define socketpair PerlSock_socketpair
-
-# ifdef WIN32
-# include "XSlock.h"
-# endif /* WIN32 */
# endif /* NO_XSLOCKS */
-#else
-# ifdef PERL_CAPI
-# include "perlCAPI.h"
-# endif
-#endif /* PERL_OBJECT */
+#endif /* PERL_CAPI */
+
+#endif /* _INC_PERL_XSUB_H */ /* include guard */
https://perl5.git.perl.org / perl5.git / blobdiff