X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/5bbd4290dc068a04b65fb118bd01be1ae58c7454..20c8f8f9118fd23081c818637815bf1aab60b808:/XSUB.h diff --git a/XSUB.h b/XSUB.h index b4c241a..06cb1c3 100644 --- a/XSUB.h +++ b/XSUB.h @@ -1,7 +1,7 @@ /* XSUB.h * - * Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, - * 2000, 2001, 2002, 2003, by Larry Wall and others + * Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, + * 2003, 2004, 2005, 2006, 2007, 2008 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. @@ -54,6 +54,10 @@ C. 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. @@ -67,26 +71,80 @@ This is usually handled automatically by C. 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(pTHX_ CV* cv) -#else -# define XS(name) void name(pTHX_ 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 dAX I32 ax = MARK - PL_stack_base + 1 +#define dAX const I32 ax = (I32)(MARK - PL_stack_base + 1) -#define dITEMS I32 items = SP - MARK +#define dAXMARK \ + I32 ax = POPMARK; \ + register SV **mark = PL_stack_base + ax++ -#define dXSARGS \ - dSP; dMARK; \ - dAX; dITEMS +#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. */ @@ -98,14 +156,21 @@ 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,))(f)) +#define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT_ANON(ret))(f)) #define XSINTERFACE_FUNC_SET(cv,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. */ @@ -166,7 +231,7 @@ Return an empty list from an XSUB immediately. =head1 Variables created by C and C internal functions -=for apidoc AmU||newXSproto +=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. @@ -179,6 +244,24 @@ 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 */ @@ -186,14 +269,14 @@ C. See L. #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_mPVN(i,v,n) (ST(i) = newSVpvn_flags(v,n, SVs_TEMP)) #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 { \ - IV tmpXSoff = (off); \ + const IV tmpXSoff = (off); \ PL_stack_sp = PL_stack_base + ax + (tmpXSoff - 1); \ return; \ } STMT_END @@ -208,13 +291,13 @@ 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 *_sv; 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 */ \ _sv = ST(1); \ else { \ @@ -225,23 +308,37 @@ C. See L. _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \ vn = "VERSION"), FALSE); \ } \ - if (_sv && (!SvOK(_sv) || strNE(XS_VERSION, SvPV(_sv, 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", _sv); \ + 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 ; \ @@ -255,9 +352,10 @@ C. See L. 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) ; \ @@ -266,10 +364,10 @@ C. See L. SAVETMPS ; \ SAVEINT(db->filtering) ; \ db->filtering = TRUE ; \ - SAVESPTR(DEFSV) ; \ + SAVE_DEFSV ; \ if (name[7] == 's') \ arg = newSVsv(arg); \ - DEFSV = arg ; \ + DEFSV_set(arg) ; \ SvTEMP_off(arg) ; \ PUSHMARK(SP) ; \ PUTBACK ; \ @@ -281,8 +379,7 @@ C. See L. if (name[7] == 's'){ \ arg = sv_2mortal(arg); \ } \ - SvOKp(arg); \ - } + } } STMT_END #if 1 /* for compatibility */ # define VTBL_sv &PL_vtbl_sv @@ -381,6 +478,12 @@ C. See L. # undef setservent #endif /* NETWARE */ +/* to avoid warnings: "xyz" redefined */ +#ifdef WIN32 +# undef popen +# undef pclose +#endif /* WIN32 */ + # undef socketpair # define mkdir PerlDir_mkdir @@ -404,6 +507,7 @@ C. See L. # define ferror PerlSIO_ferror # define clearerr PerlSIO_clearerr # define getc PerlSIO_getc +# define fgets PerlSIO_fgets # define fputc PerlSIO_fputc # define fputs PerlSIO_fputs # define fflush PerlSIO_fflush @@ -540,3 +644,13 @@ C. See L. #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: + */