This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Need to quote the version number of perl in perlivp, now
[perl5.git] / XSUB.h
diff --git a/XSUB.h b/XSUB.h
index 24a5607..a149115 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 by Larry Wall and others
+ *    Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
+ *    2003, 2004, 2005, 2006, 2007 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.
@@ -82,33 +82,67 @@ is a lexical $_ in scope.
 =cut
 */
 
+#ifndef PERL_UNUSED_ARG
+#  if defined(lint) && defined(S_SPLINT_S) /* www.splint.org */
+#    include <note.h>
+#    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)
+#  define XS(name) __declspec(dllexport) XSPROTO(name)
 #endif
-#if defined(SYMBIAN)
-#  define XS(name) EXPORT_C void name(pTHX_ CV* cv)
+#if defined(__SYMBIAN32__)
+#  define XS(name) EXPORT_C XSPROTO(name)
 #endif
 #ifndef XS
-#  ifdef HASATTRIBUTE_UNUSED
+#  if defined(HASATTRIBUTE_UNUSED) && !defined(__cplusplus)
 #    define XS(name) void name(pTHX_ CV* cv __attribute__unused__)
 #  else
-#    define XS(name) void name(pTHX_ CV* cv)
+#    ifdef __cplusplus
+#      define XS(name) extern "C" XSPROTO(name)
+#    else
+#      define XS(name) XSPROTO(name)
+#    endif
 #  endif
 #endif
 
-#define dAX const I32 ax = MARK - PL_stack_base + 1
+#define dAX const I32 ax = (I32)(MARK - PL_stack_base + 1)
 
 #define dAXMARK                                \
        I32 ax = POPMARK;       \
-       register SV ** const mark = PL_stack_base + ax++
+       register SV **mark = PL_stack_base + ax++
 
-#define dITEMS I32 items = SP - MARK
+#define dITEMS I32 items = (I32)(SP - MARK)
 
-#define dXSARGS                                \
+#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())
@@ -122,17 +156,19 @@ is a lexical $_ in scope.
 
 #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 I32 padoff_du = find_rundefsvoffset()
+#define dUNDERBAR PADOFFSET padoff_du = find_rundefsvoffset()
 #define UNDERBAR ((padoff_du == NOT_IN_PAD \
-           || PAD_COMPNAME_FLAGS(padoff_du) & SVpad_OUR) \
+           || PAD_COMPNAME_FLAGS_isOUR(padoff_du)) \
        ? DEFSV : PAD_SVl(padoff_du))
 
 /* Simple macros to put new mortal values onto the stack.   */
@@ -211,7 +247,7 @@ C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
 =head1 Simple Exception Handling Macros
 
 =for apidoc Ams||dXCPT
-Set up neccessary local variables for exception handling.
+Set up necessary local variables for exception handling.
 See L<perlguts/"Exception Handling">.
 
 =for apidoc AmU||XCPT_TRY_START
@@ -240,7 +276,7 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
 
 #define XSRETURN(off)                                  \
     STMT_START {                                       \
-       IV tmpXSoff = (off);                            \
+       const IV tmpXSoff = (off);                      \
        PL_stack_sp = PL_stack_base + ax + (tmpXSoff - 1);      \
        return;                                         \
     } STMT_END
@@ -255,13 +291,13 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
 #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;                                            \
-       const char *vn = Nullch, *module = SvPV_const(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 {                                                          \
@@ -273,15 +309,15 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
                                    vn = "VERSION"), FALSE);            \
        }                                                               \
        if (_sv) {                                                      \
-           SV *xssv = Perl_newSVpvf(aTHX_ "%s",XS_VERSION);            \
+           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, vstringify(xssv),                         \
+                     module, SVfARG(vstringify(xssv)),                 \
                      vn ? "$" : "", vn ? module : "", vn ? "::" : "",  \
-                     vn ? vn : "bootstrap parameter", vstringify(_sv));\
+                     vn ? vn : "bootstrap parameter", SVfARG(vstringify(_sv)));\
        }                                                               \
     } STMT_END
 #else
@@ -302,7 +338,7 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
 */
 
 #define DBM_setFilter(db_type,code)                            \
-       {                                                       \
+       STMT_START {                                            \
            if (db_type)                                        \
                RETVAL = sv_mortalcopy(db_type) ;               \
            ST(0) = RETVAL ;                                    \
@@ -316,9 +352,10 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
                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) ;       \
@@ -342,8 +379,7 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
             if (name[7] == 's'){                                \
                 arg = sv_2mortal(arg);                          \
             }                                                   \
-            SvOKp(arg);                                         \
-       }
+       } } STMT_END                                                     
 
 #if 1          /* for compatibility */
 #  define VTBL_sv              &PL_vtbl_sv
@@ -379,6 +415,12 @@ 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
@@ -601,3 +643,13 @@ Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
 #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:
+ */