This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add /d, /l, /u (infixed) regex modifiers
[perl5.git] / XSUB.h
diff --git a/XSUB.h b/XSUB.h
index 268a2ff..7a7e882 100644 (file)
--- a/XSUB.h
+++ b/XSUB.h
@@ -1,7 +1,7 @@
 /*    XSUB.h
  *
  *    Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
- *    2003, 2004, 2005, 2006, 2007 by Larry Wall and others
+ *    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.
@@ -72,8 +72,9 @@ Sets up the C<ix> variable for an XSUB which has aliases.  This is usually
 handled automatically by C<xsubpp>.
 
 =for apidoc Ams||dUNDERBAR
-Sets up the C<padoff_du> variable for an XSUB that wishes to use
-C<UNDERBAR>.
+Sets up any variable needed by the C<UNDERBAR> macro. It used to define
+C<padoff_du>, but it is currently a noop. However, it is strongly adviced
+to still use it for ensuring past and future compatibility.
 
 =for apidoc AmU||UNDERBAR
 The SV* corresponding to the $_ variable. Works even if there
@@ -96,21 +97,33 @@ is a lexical $_ in scope.
 
 #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)
+#  define XS(name) __declspec(dllexport) XSPROTO(name)
 #endif
 #if defined(__SYMBIAN32__)
-#  define XS(name) EXPORT_C void name(pTHX_ CV* cv)
+#  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" void name(pTHX_ CV* cv)
+#      define XS(name) extern "C" XSPROTO(name)
 #    else
-#      define XS(name) void name(pTHX_ CV* cv)
+#      define XS(name) XSPROTO(name)
 #    endif
 #  endif
 #endif
@@ -154,10 +167,8 @@ is a lexical $_ in scope.
 #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))
+#define dUNDERBAR dNOOP
+#define UNDERBAR  find_rundefsv()
 
 /* Simple macros to put new mortal values onto the stack.   */
 /* Typically used to return values from XS functions.       */
@@ -232,6 +243,10 @@ 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">.
 
+=for apidoc Ams||XS_APIVERSION_BOOTCHECK
+Macro to verify that the perl api version an XS module has been compiled against
+matches the api version of the perl interpreter it's being loaded into.
+
 =head1 Simple Exception Handling Macros
 
 =for apidoc Ams||dXCPT
@@ -257,7 +272,7 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
 #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)
@@ -282,7 +297,7 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
 #define newXSproto(a,b,c,d)    newXS_flags(a,b,c,d,0)
 
 #ifdef XS_VERSION
-#  define XS_VERSION_BOOTCHECK \
+#  define XS_VERSION_BOOTCHECK                                         \
     STMT_START {                                                       \
        SV *_sv;                                                        \
        const char *vn = NULL, *module = SvPV_nolen_const(ST(0));       \
@@ -291,27 +306,59 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
        else {                                                          \
            /* XXX GV_ADDWARN */                                        \
            _sv = get_sv(Perl_form(aTHX_ "%s::%s", module,              \
-                               vn = "XS_VERSION"), FALSE);             \
+                               vn = "XS_VERSION"), 0);                 \
            if (!_sv || !SvOK(_sv))                                     \
-               _sv = get_sv(Perl_form(aTHX_ "%s::%s", module,  \
-                                   vn = "VERSION"), FALSE);            \
+               _sv = get_sv(Perl_form(aTHX_ "%s::%s", module,          \
+                                   vn = "VERSION"), 0);                \
        }                                                               \
        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)));\
+           SV *xpt = NULL;                                             \
+           SV *xssv = Perl_newSVpvn(aTHX_ STR_WITH_LEN(XS_VERSION));   \
+           SV *pmsv = sv_derived_from(_sv, "version")                  \
+               ? SvREFCNT_inc_simple_NN(_sv)                           \
+               : new_version(_sv);                                     \
+           xssv = upg_version(xssv, 0);                                \
+           if ( vcmp(pmsv,xssv) ) {                                    \
+               xpt = Perl_newSVpvf(aTHX_ "%s object version %"SVf      \
+                                   " does not match %s%s%s%s %"SVf,    \
+                                   module,                             \
+                                   SVfARG(Perl_sv_2mortal(aTHX_ vstringify(xssv))), \
+                                   vn ? "$" : "", vn ? module : "",    \
+                                   vn ? "::" : "",                     \
+                                   vn ? vn : "bootstrap parameter",    \
+                                   SVfARG(Perl_sv_2mortal(aTHX_ vstringify(pmsv)))); \
+               Perl_sv_2mortal(aTHX_ xpt);                             \
+           }                                                           \
+           SvREFCNT_dec(xssv);                                         \
+           SvREFCNT_dec(pmsv);                                         \
+           if (xpt)                                                    \
+               Perl_croak_sv(aTHX_ xpt);                               \
        }                                                               \
     } STMT_END
 #else
 #  define XS_VERSION_BOOTCHECK
 #endif
 
+#define XS_APIVERSION_BOOTCHECK                                                \
+    STMT_START {                                                       \
+       SV *_xpt = NULL;                                                \
+       SV *_compver = Perl_newSVpv(aTHX_ "v" PERL_API_VERSION_STRING, 0); \
+       SV *_runver = new_version(PL_apiversion);                       \
+       _compver = upg_version(_compver, 0);                            \
+       if (vcmp(_compver, _runver)) {                                  \
+           _xpt = Perl_newSVpvf(aTHX_ "Perl API version %"SVf          \
+                                " of %s does not match %"SVf,          \
+                                SVfARG(Perl_sv_2mortal(aTHX_ vstringify(_compver))), \
+                                SvPV_nolen_const(ST(0)),               \
+                                SVfARG(Perl_sv_2mortal(aTHX_ vstringify(_runver)))); \
+           Perl_sv_2mortal(aTHX_ _xpt);                                \
+       }                                                               \
+       SvREFCNT_dec(_compver);                                         \
+       SvREFCNT_dec(_runver);                                          \
+       if (_xpt)                                                       \
+           Perl_croak_sv(aTHX_ _xpt);                                  \
+    } STMT_END
+
 #ifdef NO_XSLOCKS
 #  define dXCPT             dJMPENV; int rEtV = 0
 #  define XCPT_TRY_START    JMPENV_PUSH(rEtV); if (rEtV == 0)
@@ -320,9 +367,9 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
 #  define XCPT_RETHROW      JMPENV_JUMP(rEtV)
 #endif
 
-/* 
-   The DBM_setFilter & DBM_ckFilter macros are only used by 
-   the *DB*_File modules 
+/*
+   The DBM_setFilter & DBM_ckFilter macros are only used by
+   the *DB*_File modules
 */
 
 #define DBM_setFilter(db_type,code)                            \
@@ -352,10 +399,10 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
            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 ;                                           \
@@ -403,12 +450,6 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
 #endif
 
 #include "perlapi.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
@@ -472,6 +513,12 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
 #      undef setservent
 #endif /* NETWARE */
 
+/* to avoid warnings: "xyz" redefined */
+#ifdef WIN32
+#    undef  popen
+#    undef  pclose
+#endif /* WIN32 */
+
 #    undef  socketpair
 
 #    define mkdir              PerlDir_mkdir
@@ -495,6 +542,7 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
 #    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