[perl5.git] / XSUB.h

/*    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<xsubpp> and C<xsubpp> internal functions

=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|ax
Variable which is setup by C<xsubpp> to indicate the stack base offset,
used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros.  The C<dMARK> macro
must be called prior to setup the C<MARK> variable.

=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||dAX
Sets up the C<ax> variable.
This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.

=for apidoc Ams||dITEMS
Sets up the C<items> variable.
This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.

=for apidoc Ams||dXSARGS
Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
This is usually handled automatically by C<xsubpp>.

=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)]

#if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING)
#  define XS(name) __declspec(dllexport) void name(pTHX_ CV* cv)
#else
#  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;			\
	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)

#define dXSI32 I32 ix = XSANY.any_i32

#ifdef __cplusplus
#  define XSINTERFACE_CVT(ret,name) ret (*name)(...)
#else
#  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_SET(cv,f)	\
		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<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_UV|IV uv
Return an integer from an XSUB immediately.  Uses C<XST_mUV>.

=for apidoc Am|void|XSRETURN_NV|NV nv
Return a 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.

=head1 Variables created by C<xsubpp> and C<xsubpp> internal functions

=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_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,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
#define XSRETURN_EMPTY STMT_START {                XSRETURN(0); } STMT_END

#define newXSproto(a,b,c,d)	sv_setpv((SV*)newXS(a,b,c), d)

#ifdef XS_VERSION
#  define XS_VERSION_BOOTCHECK \
    STMT_START {							\
	SV *tmpsv; STRLEN n_a;						\
	char *vn = Nullch, *module = SvPV(ST(0),n_a);			\
	if (items >= 2)	 /* version supplied as bootstrap arg */	\
	    tmpsv = ST(1);						\
	else {								\
	    /* XXX GV_ADDWARN */					\
	    tmpsv = 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,	\
				    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);		\
    } STMT_END
#else
#  define XS_VERSION_BOOTCHECK
#endif

/* 
   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
#  define VTBL_sig		&PL_vtbl_sig
#  define VTBL_sigelem		&PL_vtbl_sigelem
#  define VTBL_pack		&PL_vtbl_pack
#  define VTBL_packelem		&PL_vtbl_packelem
#  define VTBL_dbline		&PL_vtbl_dbline
#  define VTBL_isa		&PL_vtbl_isa
#  define VTBL_isaelem		&PL_vtbl_isaelem
#  define VTBL_arylen		&PL_vtbl_arylen
#  define VTBL_glob		&PL_vtbl_glob
#  define VTBL_mglob		&PL_vtbl_mglob
#  define VTBL_nkeys		&PL_vtbl_nkeys
#  define VTBL_taint		&PL_vtbl_taint
#  define VTBL_substr		&PL_vtbl_substr
#  define VTBL_vec		&PL_vtbl_vec
#  define VTBL_pos		&PL_vtbl_pos
#  define VTBL_bm		&PL_vtbl_bm
#  define VTBL_fm		&PL_vtbl_fm
#  define VTBL_uvar		&PL_vtbl_uvar
#  define VTBL_defelem		&PL_vtbl_defelem
#  define VTBL_regexp		&PL_vtbl_regexp
#  define VTBL_regdata		&PL_vtbl_regdata
#  define VTBL_regdatum		&PL_vtbl_regdatum
#  ifdef USE_LOCALE_COLLATE
#    define VTBL_collxfrm	&PL_vtbl_collxfrm
#  endif
#  define VTBL_amagic		&PL_vtbl_amagic
#  define VTBL_amagicelem	&PL_vtbl_amagicelem
#endif

#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
#    undef stdout
#    undef stderr
#    undef feof
#    undef ferror
#    undef fgetpos
#    undef ioctl
#    undef getlogin
#    undef setjmp
#    undef getc
#    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
#    define closedir		PerlDir_close
#    define opendir		PerlDir_open
#    define readdir		PerlDir_read
#    define rewinddir		PerlDir_rewind
#    define seekdir		PerlDir_seek
#    define telldir		PerlDir_tell
#    define putenv		PerlEnv_putenv
#    define getenv		PerlEnv_getenv
#    define uname		PerlEnv_uname
#    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
#    define close		PerlLIO_close
#    define dup			PerlLIO_dup
#    define dup2		PerlLIO_dup2
#    define flock		PerlLIO_flock
#    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 open		PerlLIO_open
#    define read		PerlLIO_read
#    define rename		PerlLIO_rename
#    define setmode		PerlLIO_setmode
#    define stat(buf,sb)	PerlLIO_stat(buf,sb)
#    define tmpnam		PerlLIO_tmpnam
#    define umask		PerlLIO_umask
#    define unlink		PerlLIO_unlink
#    define utime		PerlLIO_utime
#    define write		PerlLIO_write
#    define malloc		PerlMem_malloc
#    define realloc		PerlMem_realloc
#    define free		PerlMem_free
#    define abort		PerlProc_abort
#    define exit		PerlProc_exit
#    define _exit		PerlProc__exit
#    define execl		PerlProc_execl
#    define execv		PerlProc_execv
#    define execvp		PerlProc_execvp
#    define getuid		PerlProc_getuid
#    define geteuid		PerlProc_geteuid
#    define getgid		PerlProc_getgid
#    define getegid		PerlProc_getegid
#    define getlogin		PerlProc_getlogin
#    define kill		PerlProc_kill
#    define killpg		PerlProc_killpg
#    define pause		PerlProc_pause
#    define popen		PerlProc_popen
#    define pclose		PerlProc_pclose
#    define pipe		PerlProc_pipe
#    define setuid		PerlProc_setuid
#    define setgid		PerlProc_setgid
#    define sleep		PerlProc_sleep
#    define times		PerlProc_times
#    define wait		PerlProc_wait
#    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
#    define ntohs		PerlSock_ntohs
#    define accept		PerlSock_accept
#    define bind		PerlSock_bind
#    define connect		PerlSock_connect
#    define endhostent		PerlSock_endhostent
#    define endnetent		PerlSock_endnetent
#    define endprotoent		PerlSock_endprotoent
#    define endservent		PerlSock_endservent
#    define gethostbyaddr	PerlSock_gethostbyaddr
#    define gethostbyname	PerlSock_gethostbyname
#    define gethostent		PerlSock_gethostent
#    define gethostname		PerlSock_gethostname
#    define getnetbyaddr	PerlSock_getnetbyaddr
#    define getnetbyname	PerlSock_getnetbyname
#    define getnetent		PerlSock_getnetent
#    define getpeername		PerlSock_getpeername
#    define getprotobyname	PerlSock_getprotobyname
#    define getprotobynumber	PerlSock_getprotobynumber
#    define getprotoent		PerlSock_getprotoent
#    define getservbyname	PerlSock_getservbyname
#    define getservbyport	PerlSock_getservbyport
#    define getservent		PerlSock_getservent
#    define getsockname		PerlSock_getsockname
#    define getsockopt		PerlSock_getsockopt
#    define inet_addr		PerlSock_inet_addr
#    define inet_ntoa		PerlSock_inet_ntoa
#    define listen		PerlSock_listen
#    define recv		PerlSock_recv
#    define recvfrom		PerlSock_recvfrom
#    define select		PerlSock_select
#    define send		PerlSock_send
#    define sendto		PerlSock_sendto
#    define sethostent		PerlSock_sethostent
#    define setnetent		PerlSock_setnetent
#    define setprotoent		PerlSock_setprotoent
#    define setservent		PerlSock_setservent
#    define setsockopt		PerlSock_setsockopt
#    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_IMPLICIT_SYS && !PERL_CORE */

#endif /* _INC_PERL_XSUB_H */		/* include guard */
Commit	Line	Data
eb1102fc NIS	1	/* XSUB.h
eb1102fc NIS	2	*
4bb101f2 JH	3	* Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999,
4bb101f2 JH	4	* 2000, 2001, 2002, 2003, by Larry Wall and others
eb1102fc NIS	5	*
	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.
	8	*
	9	*/
	10
b4ba0ab9 GS	11	#ifndef _INC_PERL_XSUB_H
	12	#define _INC_PERL_XSUB_H 1
	13
954c1994 GS	14	/* first, some documentation for xsubpp-generated items */
	15
	16	/*
ccfc67b7 JH	17	=head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
ccfc67b7 JH	18
954c1994 GS	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>.
	22
	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">.
	27
	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++">.
	32
9f2ea798 DM	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.
	37
954c1994 GS	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">.
	41
	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">.
	45
	46	=for apidoc Am\|SV*\|ST\|int ix
	47	Used to access elements on the XSUB's stack.
	48
	49	=for apidoc AmU\|\|XS
	50	Macro to declare an XSUB and its C parameter list. This is handled by
	51	C<xsubpp>.
	52
9f2ea798 DM	53	=for apidoc Ams\|\|dAX
	54	Sets up the C<ax> variable.
	55	This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
	56
	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>.
	60
954c1994	61	=for apidoc Ams\|\|dXSARGS
9f2ea798 DM	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>.
954c1994 GS	65
	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>.
	69
	70	=cut
	71	*/
	72
3280af22	73	#define ST(off) PL_stack_base[ax + (off)]
a0d0e21e	74
d308986b	75	#if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING)
acfe0abc	76	# define XS(name) __declspec(dllexport) void name(pTHX_ CV* cv)
cea2e8a9	77	#else
acfe0abc	78	# define XS(name) void name(pTHX_ CV* cv)
a0d0e21e LW	79	#endif
a0d0e21e LW	80
349b520e	81	#define dAX I32 ax = MARK - PL_stack_base + 1
9f2ea798 DM	82
	83	#define dITEMS I32 items = SP - MARK
	84
a0d0e21e	85	#define dXSARGS \
3c78fafa	86	dSP; dMARK; \
9f2ea798	87	dAX; dITEMS
a0d0e21e	88
8a7fc0dc GS	89	#define dXSTARG SV * targ = ((PL_op->op_private & OPpENTERSUB_HASTARG) \
	90	? PAD_SV(PL_op->op_targ) : sv_newmortal())
	91
b26a54d0 GS	92	/* Should be used before final PUSHi etc. if not in PPCODE section. */
	93	#define XSprePUSH (sp = PL_stack_base + ax - 1)
	94
a0d0e21e LW	95	#define XSANY CvXSUBANY(cv)
	96
	97	#define dXSI32 I32 ix = XSANY.any_i32
	98
cfc02341 IZ	99	#ifdef __cplusplus
	100	# define XSINTERFACE_CVT(ret,name) ret (*name)(...)
	101	#else
	102	# define XSINTERFACE_CVT(ret,name) ret (*name)()
	103	#endif
	104	#define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION)
2554589c	105	#define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,))(f))
cfc02341	106	#define XSINTERFACE_FUNC_SET(cv,f) \
a12c3db7	107	CvXSUBANY(cv).any_dxptr = (void () (pTHX_ void))(f)
cfc02341	108
748a9306 LW	109	/* Simple macros to put new mortal values onto the stack. */
748a9306 LW	110	/* Typically used to return values from XS functions. */
954c1994 GS	111
954c1994 GS	112	/*
ccfc67b7 JH	113	=head1 Stack Manipulation Macros
ccfc67b7 JH	114
954c1994 GS	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.
	118
	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.
	122
	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.
	126
	127	=for apidoc Am\|void\|XST_mNO\|int pos
	128	Place C<&PL_sv_no> into the specified position C<pos> on the
	129	stack.
	130
	131	=for apidoc Am\|void\|XST_mYES\|int pos
	132	Place C<&PL_sv_yes> into the specified position C<pos> on the
	133	stack.
	134
	135	=for apidoc Am\|void\|XST_mUNDEF\|int pos
	136	Place C<&PL_sv_undef> into the specified position C<pos> on the
	137	stack.
	138
	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>.
	142
	143	=for apidoc Am\|void\|XSRETURN_IV\|IV iv
	144	Return an integer from an XSUB immediately. Uses C<XST_mIV>.
	145
108ccc45 JH	146	=for apidoc Am\|void\|XSRETURN_UV\|IV uv
	147	Return an integer from an XSUB immediately. Uses C<XST_mUV>.
	148
954c1994	149	=for apidoc Am\|void\|XSRETURN_NV\|NV nv
d1be9408	150	Return a double from an XSUB immediately. Uses C<XST_mNV>.
954c1994 GS	151
	152	=for apidoc Am\|void\|XSRETURN_PV\|char* str
	153	Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
	154
	155	=for apidoc Ams\|\|XSRETURN_NO
	156	Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
	157
	158	=for apidoc Ams\|\|XSRETURN_YES
	159	Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
	160
	161	=for apidoc Ams\|\|XSRETURN_UNDEF
	162	Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
	163
	164	=for apidoc Ams\|\|XSRETURN_EMPTY
	165	Return an empty list from an XSUB immediately.
	166
ccfc67b7 JH	167	=head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
ccfc67b7 JH	168
954c1994 GS	169	=for apidoc AmU\|\|newXSproto
	170	Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
	171	the subs.
	172
	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>.
	176
	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">.
	181
	182	=cut
	183	*/
	184
4633a7c4	185	#define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) )
108ccc45	186	#define XST_mUV(i,v) (ST(i) = sv_2mortal(newSVuv(v)) )
4633a7c4 LW	187	#define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) )
4633a7c4 LW	188	#define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0)))
79cb57f6	189	#define XST_mPVN(i,v,n) (ST(i) = sv_2mortal(newSVpvn(v,n)))
3280af22 NIS	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)
954c1994 GS	193
	194	#define XSRETURN(off) \
	195	STMT_START { \
	196	PL_stack_sp = PL_stack_base + ax + ((off) - 1); \
	197	return; \
	198	} STMT_END
	199
80b92232	200	#define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END
108ccc45	201	#define XSRETURN_UV(v) STMT_START { XST_mUV(0,v); XSRETURN(1); } STMT_END
80b92232	202	#define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END
80b92232	203	#define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END
954c1994	204	#define XSRETURN_PVN(v,n) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END
80b92232	205	#define XSRETURN_NO STMT_START { XST_mNO(0); XSRETURN(1); } STMT_END
	206	#define XSRETURN_YES STMT_START { XST_mYES(0); XSRETURN(1); } STMT_END
	207	#define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
	208	#define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END
382b8d97	209
37120919	210	#define newXSproto(a,b,c,d) sv_setpv((SV*)newXS(a,b,c), d)
720fb644	211
720fb644	212	#ifdef XS_VERSION
c6af7a1a	213	# define XS_VERSION_BOOTCHECK \
774d564b	214	STMT_START { \
2d8e6c8d GS	215	SV *tmpsv; STRLEN n_a; \
2d8e6c8d GS	216	char vn = Nullch, module = SvPV(ST(0),n_a); \
774d564b	217	if (items >= 2) /* version supplied as bootstrap arg */ \
6b88bc9c	218	tmpsv = ST(1); \
774d564b	219	else { \
46fc3d4c	220	/* XXX GV_ADDWARN */ \
cea2e8a9	221	tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
864dbfa3	222	vn = "XS_VERSION"), FALSE); \
6b88bc9c	223	if (!tmpsv \|\| !SvOK(tmpsv)) \
cea2e8a9	224	tmpsv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
864dbfa3	225	vn = "VERSION"), FALSE); \
774d564b	226	} \
2d8e6c8d	227	if (tmpsv && (!SvOK(tmpsv) \|\| strNE(XS_VERSION, SvPV(tmpsv, n_a)))) \
894356b3	228	Perl_croak(aTHX_ "%s object version %s does not match %s%s%s%s %"SVf,\
ae66e5c8 CS	229	module, XS_VERSION, \
ae66e5c8 CS	230	vn ? "$" : "", vn ? module : "", vn ? "::" : "", \
6b88bc9c	231	vn ? vn : "bootstrap parameter", tmpsv); \
80b92232	232	} STMT_END
720fb644	233	#else
c6af7a1a	234	# define XS_VERSION_BOOTCHECK
720fb644	235	#endif
76e3520e	236
6a31061a PM	237	/*
	238	The DBM_setFilter & DBM_ckFilter macros are only used by
	239	the DB_File modules
	240	*/
	241
	242	#define DBM_setFilter(db_type,code) \
	243	{ \
	244	if (db_type) \
	245	RETVAL = sv_mortalcopy(db_type) ; \
	246	ST(0) = RETVAL ; \
	247	if (db_type && (code == &PL_sv_undef)) { \
	248	SvREFCNT_dec(db_type) ; \
	249	db_type = NULL ; \
	250	} \
	251	else if (code) { \
	252	if (db_type) \
	253	sv_setsv(db_type, code) ; \
	254	else \
	255	db_type = newSVsv(code) ; \
	256	} \
	257	}
	258
	259	#define DBM_ckFilter(arg,type,name) \
	260	if (db->type) { \
	261	if (db->filtering) { \
	262	croak("recursion detected in %s", name) ; \
	263	} \
	264	ENTER ; \
	265	SAVETMPS ; \
	266	SAVEINT(db->filtering) ; \
	267	db->filtering = TRUE ; \
	268	SAVESPTR(DEFSV) ; \
	269	DEFSV = arg ; \
	270	SvTEMP_off(arg) ; \
	271	PUSHMARK(SP) ; \
	272	PUTBACK ; \
	273	(void) perl_call_sv(db->type, G_DISCARD); \
	274	SPAGAIN ; \
	275	PUTBACK ; \
	276	FREETMPS ; \
	277	LEAVE ; \
	278	}
	279
51371543	280	#if 1 /* for compatibility */
dc9e4912 GS	281	# define VTBL_sv &PL_vtbl_sv
	282	# define VTBL_env &PL_vtbl_env
	283	# define VTBL_envelem &PL_vtbl_envelem
	284	# define VTBL_sig &PL_vtbl_sig
	285	# define VTBL_sigelem &PL_vtbl_sigelem
	286	# define VTBL_pack &PL_vtbl_pack
	287	# define VTBL_packelem &PL_vtbl_packelem
	288	# define VTBL_dbline &PL_vtbl_dbline
	289	# define VTBL_isa &PL_vtbl_isa
	290	# define VTBL_isaelem &PL_vtbl_isaelem
	291	# define VTBL_arylen &PL_vtbl_arylen
	292	# define VTBL_glob &PL_vtbl_glob
	293	# define VTBL_mglob &PL_vtbl_mglob
	294	# define VTBL_nkeys &PL_vtbl_nkeys
	295	# define VTBL_taint &PL_vtbl_taint
	296	# define VTBL_substr &PL_vtbl_substr
	297	# define VTBL_vec &PL_vtbl_vec
	298	# define VTBL_pos &PL_vtbl_pos
	299	# define VTBL_bm &PL_vtbl_bm
	300	# define VTBL_fm &PL_vtbl_fm
	301	# define VTBL_uvar &PL_vtbl_uvar
	302	# define VTBL_defelem &PL_vtbl_defelem
	303	# define VTBL_regexp &PL_vtbl_regexp
	304	# define VTBL_regdata &PL_vtbl_regdata
	305	# define VTBL_regdatum &PL_vtbl_regdatum
	306	# ifdef USE_LOCALE_COLLATE
	307	# define VTBL_collxfrm &PL_vtbl_collxfrm
	308	# endif
9e7bc3e8 JD	309	# define VTBL_amagic &PL_vtbl_amagic
9e7bc3e8 JD	310	# define VTBL_amagicelem &PL_vtbl_amagicelem
dc9e4912 GS	311	#endif
dc9e4912 GS	312
6f4183fe	313	#include "perlapi.h"
c6af7a1a	314
e8ee3774	315	#if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT) && !defined(PERL_CORE)
c5be433b GS	316	# undef aTHX
c5be433b GS	317	# undef aTHX_
54aff467 GS	318	# define aTHX PERL_GET_THX
54aff467 GS	319	# define aTHX_ aTHX,
54aff467 GS	320	#endif
54aff467 GS	321
acfe0abc	322	#if defined(PERL_IMPLICIT_SYS) && !defined(PERL_CORE)
c6af7a1a	323	# ifndef NO_XSLOCKS
2986a63f JH	324	# if defined (NETWARE) && defined (USE_STDIO)
	325	# define times PerlProc_times
	326	# define setuid PerlProc_setuid
	327	# define setgid PerlProc_setgid
	328	# define getpid PerlProc_getpid
	329	# define pause PerlProc_pause
	330	# define exit PerlProc_exit
	331	# define _exit PerlProc__exit
	332	# else
c6af7a1a GS	333	# undef closedir
	334	# undef opendir
	335	# undef stdin
	336	# undef stdout
	337	# undef stderr
	338	# undef feof
	339	# undef ferror
	340	# undef fgetpos
	341	# undef ioctl
	342	# undef getlogin
	343	# undef setjmp
	344	# undef getc
	345	# undef ungetc
	346	# undef fileno
	347
cb69f87a	348	/* Following symbols were giving redefinition errors while building extensions - sgp 17th Oct 2000 */
2986a63f JH	349	#ifdef NETWARE
	350	# undef readdir
	351	# undef fstat
	352	# undef stat
	353	# undef longjmp
	354	# undef endhostent
	355	# undef endnetent
	356	# undef endprotoent
	357	# undef endservent
	358	# undef gethostbyaddr
	359	# undef gethostbyname
	360	# undef gethostent
	361	# undef getnetbyaddr
	362	# undef getnetbyname
	363	# undef getnetent
	364	# undef getprotobyname
	365	# undef getprotobynumber
	366	# undef getprotoent
	367	# undef getservbyname
	368	# undef getservbyport
	369	# undef getservent
	370	# undef inet_ntoa
	371	# undef sethostent
	372	# undef setnetent
	373	# undef setprotoent
	374	# undef setservent
	375	#endif /* NETWARE */
	376
1018e26f NIS	377	# undef socketpair
1018e26f NIS	378
c6af7a1a GS	379	# define mkdir PerlDir_mkdir
	380	# define chdir PerlDir_chdir
	381	# define rmdir PerlDir_rmdir
	382	# define closedir PerlDir_close
	383	# define opendir PerlDir_open
	384	# define readdir PerlDir_read
	385	# define rewinddir PerlDir_rewind
	386	# define seekdir PerlDir_seek
	387	# define telldir PerlDir_tell
	388	# define putenv PerlEnv_putenv
	389	# define getenv PerlEnv_getenv
b2af26b1	390	# define uname PerlEnv_uname
197357d0 GS	391	# define stdin PerlSIO_stdin
	392	# define stdout PerlSIO_stdout
	393	# define stderr PerlSIO_stderr
f9415d23 NIS	394	# define fopen PerlSIO_fopen
	395	# define fclose PerlSIO_fclose
	396	# define feof PerlSIO_feof
	397	# define ferror PerlSIO_ferror
b6d726d6	398	# define clearerr PerlSIO_clearerr
f9415d23 NIS	399	# define getc PerlSIO_getc
	400	# define fputc PerlSIO_fputc
	401	# define fputs PerlSIO_fputs
	402	# define fflush PerlSIO_fflush
	403	# define ungetc PerlSIO_ungetc
	404	# define fileno PerlSIO_fileno
	405	# define fdopen PerlSIO_fdopen
	406	# define freopen PerlSIO_freopen
	407	# define fread PerlSIO_fread
	408	# define fwrite PerlSIO_fwrite
22a46b6e NIS	409	# define setbuf PerlSIO_setbuf
	410	# define setvbuf PerlSIO_setvbuf
	411	# define setlinebuf PerlSIO_setlinebuf
1f59ddd9 GS	412	# define stdoutf PerlSIO_stdoutf
1f59ddd9 GS	413	# define vfprintf PerlSIO_vprintf
f9415d23 NIS	414	# define ftell PerlSIO_ftell
	415	# define fseek PerlSIO_fseek
	416	# define fgetpos PerlSIO_fgetpos
	417	# define fsetpos PerlSIO_fsetpos
	418	# define frewind PerlSIO_rewind
	419	# define tmpfile PerlSIO_tmpfile
c6af7a1a GS	420	# define access PerlLIO_access
	421	# define chmod PerlLIO_chmod
	422	# define chsize PerlLIO_chsize
	423	# define close PerlLIO_close
	424	# define dup PerlLIO_dup
	425	# define dup2 PerlLIO_dup2
	426	# define flock PerlLIO_flock
	427	# define fstat PerlLIO_fstat
	428	# define ioctl PerlLIO_ioctl
	429	# define isatty PerlLIO_isatty
6b980173	430	# define link PerlLIO_link
c6af7a1a GS	431	# define lseek PerlLIO_lseek
	432	# define lstat PerlLIO_lstat
	433	# define mktemp PerlLIO_mktemp
	434	# define open PerlLIO_open
	435	# define read PerlLIO_read
	436	# define rename PerlLIO_rename
	437	# define setmode PerlLIO_setmode
4f49e16e	438	# define stat(buf,sb) PerlLIO_stat(buf,sb)
c6af7a1a GS	439	# define tmpnam PerlLIO_tmpnam
	440	# define umask PerlLIO_umask
	441	# define unlink PerlLIO_unlink
	442	# define utime PerlLIO_utime
	443	# define write PerlLIO_write
	444	# define malloc PerlMem_malloc
	445	# define realloc PerlMem_realloc
	446	# define free PerlMem_free
	447	# define abort PerlProc_abort
	448	# define exit PerlProc_exit
	449	# define _exit PerlProc__exit
	450	# define execl PerlProc_execl
	451	# define execv PerlProc_execv
	452	# define execvp PerlProc_execvp
	453	# define getuid PerlProc_getuid
	454	# define geteuid PerlProc_geteuid
	455	# define getgid PerlProc_getgid
	456	# define getegid PerlProc_getegid
	457	# define getlogin PerlProc_getlogin
	458	# define kill PerlProc_kill
	459	# define killpg PerlProc_killpg
	460	# define pause PerlProc_pause
	461	# define popen PerlProc_popen
	462	# define pclose PerlProc_pclose
	463	# define pipe PerlProc_pipe
	464	# define setuid PerlProc_setuid
	465	# define setgid PerlProc_setgid
	466	# define sleep PerlProc_sleep
	467	# define times PerlProc_times
	468	# define wait PerlProc_wait
	469	# define setjmp PerlProc_setjmp
	470	# define longjmp PerlProc_longjmp
	471	# define signal PerlProc_signal
7766f137	472	# define getpid PerlProc_getpid
57ab3dfe	473	# define gettimeofday PerlProc_gettimeofday
c6af7a1a GS	474	# define htonl PerlSock_htonl
	475	# define htons PerlSock_htons
	476	# define ntohl PerlSock_ntohl
	477	# define ntohs PerlSock_ntohs
	478	# define accept PerlSock_accept
	479	# define bind PerlSock_bind
	480	# define connect PerlSock_connect
	481	# define endhostent PerlSock_endhostent
	482	# define endnetent PerlSock_endnetent
	483	# define endprotoent PerlSock_endprotoent
	484	# define endservent PerlSock_endservent
	485	# define gethostbyaddr PerlSock_gethostbyaddr
	486	# define gethostbyname PerlSock_gethostbyname
	487	# define gethostent PerlSock_gethostent
	488	# define gethostname PerlSock_gethostname
	489	# define getnetbyaddr PerlSock_getnetbyaddr
	490	# define getnetbyname PerlSock_getnetbyname
	491	# define getnetent PerlSock_getnetent
	492	# define getpeername PerlSock_getpeername
	493	# define getprotobyname PerlSock_getprotobyname
	494	# define getprotobynumber PerlSock_getprotobynumber
	495	# define getprotoent PerlSock_getprotoent
	496	# define getservbyname PerlSock_getservbyname
	497	# define getservbyport PerlSock_getservbyport
	498	# define getservent PerlSock_getservent
	499	# define getsockname PerlSock_getsockname
	500	# define getsockopt PerlSock_getsockopt
	501	# define inet_addr PerlSock_inet_addr
	502	# define inet_ntoa PerlSock_inet_ntoa
	503	# define listen PerlSock_listen
	504	# define recv PerlSock_recv
	505	# define recvfrom PerlSock_recvfrom
	506	# define select PerlSock_select
	507	# define send PerlSock_send
	508	# define sendto PerlSock_sendto
	509	# define sethostent PerlSock_sethostent
	510	# define setnetent PerlSock_setnetent
	511	# define setprotoent PerlSock_setprotoent
	512	# define setservent PerlSock_setservent
	513	# define setsockopt PerlSock_setsockopt
	514	# define shutdown PerlSock_shutdown
	515	# define socket PerlSock_socket
	516	# define socketpair PerlSock_socketpair
2986a63f	517	# endif /* NETWARE && USE_STDIO */
21c5e947 JH	518
	519	# ifdef USE_SOCKETS_AS_HANDLES
	520	# undef fd_set
	521	# undef FD_SET
	522	# undef FD_CLR
	523	# undef FD_ISSET
	524	# undef FD_ZERO
	525	# define fd_set Perl_fd_set
	526	# define FD_SET(n,p) PERL_FD_SET(n,p)
	527	# define FD_CLR(n,p) PERL_FD_CLR(n,p)
	528	# define FD_ISSET(n,p) PERL_FD_ISSET(n,p)
	529	# define FD_ZERO(p) PERL_FD_ZERO(p)
	530	# endif /* USE_SOCKETS_AS_HANDLES */
	531
c6af7a1a	532	# endif /* NO_XSLOCKS */
acfe0abc	533	#endif /* PERL_IMPLICIT_SYS && !PERL_CORE */
b4ba0ab9	534
cfeeb022	535	#endif /* _INC_PERL_XSUB_H / / include guard */