CppFunction gains get_function_ptr (implemented in all its child classes)

romainfrancois · romainfrancois · commit a4028bf0e7fe · 2012-11-02T16:08:32.000Z
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,10 @@
+2012-11-02  Romain Francois <romain@r-enthusiasts.com>
+
+        * include/Rcpp/module/CppFunction.h : factored CppFunction in its own file
+        and added the get_function_ptr virtual method. added documentation
+        * include/Rcpp/module/Module_generated_CppFunction.h: implementation 
+        of get_function_ptr in classes that derive CppFunction
+
 2012-11-01  Dirk Eddelbuettel  <edd@debian.org>
 
 	* inst/unitTests/runit.rmath.R: New unit test file added
diff --git a/inst/include/Rcpp/Module.h b/inst/include/Rcpp/Module.h
@@ -81,21 +81,7 @@ namespace Rcpp{
         }
     } 
 
-    class CppFunction {
-    public:
-        CppFunction(const char* doc = 0) : docstring( doc == 0 ? "" : doc) {}
-        virtual SEXP operator()(SEXP*) { 
-            return R_NilValue ;
-        }
-        virtual ~CppFunction(){} ;
-        virtual int nargs(){ return 0 ; }
-        virtual bool is_void(){ return false ; }
-        virtual void signature(std::string&, const char* ){}
-        virtual SEXP get_formals(){ return R_NilValue; }
-                
-        std::string docstring ;
-    };
-
+#include <Rcpp/module/CppFunction.h>
 #include <Rcpp/module/Module_generated_get_return_type.h>
 #include <Rcpp/module/Module_generated_get_signature.h>
 
diff --git a/inst/include/Rcpp/module/CppFunction.h b/inst/include/Rcpp/module/CppFunction.h
@@ -0,0 +1,76 @@
+// -*- mode: C++; c-indent-level: 4; c-basic-offset: 4; indent-tabs-mode: nil; -*-
+//
+// CppFunction.h: Rcpp R/C++ interface class library -- C++ exposed function
+//
+// Copyright (C) 2012 Dirk Eddelbuettel and Romain Francois
+//
+// This file is part of Rcpp.
+//
+// Rcpp is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 2 of the License, or           
+// (at your option) any later version.
+//
+// Rcpp is distributed in the hope that it will be useful, but
+// WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Rcpp.  If not, see <http://www.gnu.org/licenses/>.
+
+#ifndef Rcpp_Module_CppFunction_h
+#define Rcpp_Module_CppFunction_h
+
+    /** 
+     * base class of all exported C++ functions. Template deduction in the
+     * Module_generated_function.h file creates an instance of a class that 
+     * derives CppFunction (see Module_generated_CppFunction.h fr all the 
+     * definitions
+     */
+    class CppFunction {
+    public:
+        CppFunction(const char* doc = 0) : docstring( doc == 0 ? "" : doc) {}
+        
+        /**
+         * modules call the function with this interface. input: an array of SEXP
+         * output: a SEXP. 
+         */
+        virtual SEXP operator()(SEXP*) { 
+            return R_NilValue ;
+        }
+        virtual ~CppFunction(){} ;
+        
+        /**
+         * The number of arguments of the function
+         */
+        virtual int nargs(){ return 0 ; }
+        
+        /**
+         * voidness
+         */
+        virtual bool is_void(){ return false ; }
+        
+        /**
+         * Human readable function signature (demangled if possible)
+         */
+        virtual void signature(std::string&, const char* ){}
+        
+        /**
+         * formal arguments
+         */
+        virtual SEXP get_formals(){ return R_NilValue; }
+        
+        /**
+         * The actual function pointer, as a catch all function pointer
+         * (see Rdynload.h for definition of DL_FUNC)
+         */
+        virtual DL_FUNC get_function_ptr() ;        
+        
+        /**
+         * description of the function
+         */
+        std::string docstring ;
+    };
+
+#endif
diff --git a/inst/include/Rcpp/module/Module_generated_CppFunction.h b/inst/include/Rcpp/module/Module_generated_CppFunction.h
