Merge pull request #963 from RcppCore/feature/version_string

Feature/version string

Author: eddelbuettel

ChangeLog

@@ -1,3 +1,22 @@
+2019-04-26  Dirk Eddelbuettel  <[email protected]>
+
+	* DESCRIPTION (Version, Date): Roll minor version
+
+	* R/tools.R (getRcppVersion): More idiomatic code
+
+2019-04-25  Dirk Eddelbuettel  <[email protected]>
+
+	* R/tools.R (getRcppVersion): Export R (and dev) package version
+	* man/getRcppVersion.Rd: Documentation for new function
+
+	* inst/include/Rcpp/config.h (RCPP_VERSION_STRING): New version
+	and development version string #define
+	* src/api.cpp (getRcppVersionStrings): Expose new versions strings
+	* src/internal.h: Register new version string exporter
+	* src/rcpp_init.cpp (callEntries[]): Idem
+
+	* inst/unitTests/runit.misc.R (test.getRcppVersion): test new function
+
 2019-03-23  Ralf Stubner  <[email protected]>
 
 	* vignettes/Rcpp-modules.Rmd: Describe RCPP_EXPOSED_* macros

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: Rcpp
 Title: Seamless R and C++ Integration
-Version: 1.0.1.2
-Date: 2019-03-20
+Version: 1.0.1.3
+Date: 2019-04-26
 Author: Dirk Eddelbuettel, Romain Francois, JJ Allaire, Kevin Ushey, Qiang Kou,
  Nathan Russell, Douglas Bates and John Chambers
 Maintainer: Dirk Eddelbuettel <[email protected]>
@@ -22,4 +22,4 @@ URL: http://www.rcpp.org, http://dirk.eddelbuettel.com/code/rcpp.html, https://g
 License: GPL (>= 2)
 BugReports: https://github.com/RcppCore/Rcpp/issues
 MailingList: Please send questions and comments regarding Rcpp to [email protected]
-RoxygenNote: 6.0.1
+RoxygenNote: 6.1.1

NAMESPACE

@@ -32,7 +32,8 @@ export(Module,
        sizeof,
        cpp_object_initializer,
        cpp_object_dummy,
-       Rcpp.plugin.maker
+       Rcpp.plugin.maker,
+       getRcppVersion
        )
 S3method(print, bytes)
 S3method(format, Rcpp_stack_trace)

R/tools.R

@@ -1,4 +1,4 @@
-# Copyright (C) 2010 - 2017  Dirk Eddelbuettel and Romain Francois
+# Copyright (C) 2010 - 2019  Dirk Eddelbuettel and Romain Francois
 #
 # This file is part of Rcpp.
 #
@@ -24,11 +24,11 @@ forceAssignInNamespace <- function(x, value, env) {
     is_ns <- isNamespace(env)
     unlocker <- get("unlockBinding", baseenv())
     if (is_ns && exists(x, env) && bindingIsLocked(x, env)) {
-        unlocker(x, env)
+        unlocker(x, env)				# #nocov
     }
     assign(x, value, env)
     if (is_ns) {
-        lockBinding(x, env)
+        lockBinding(x, env)				# #nocov
     }
 }
 
@@ -48,3 +48,28 @@ asBuildPath <- function(path) {
 
     return(path)
 }
+
+
+##' Helper function to report the package version of the R installation.
+##'
+##' While \code{packageVersion(Rcpp)} exports the version registers in
+##' {DESCRIPTION}, this version does get incremented more easily
+##' during development and can therefore be higher than the released
+##' version.  The actual \code{#define} long used at the C++ level
+##' corresponds more to an \sQuote{API Version} which is now provided
+##' by this function, and use for example in the package skeleton
+##' generator.
+##'
+##' @title Export the Rcpp (API) Package Version
+##' @param devel An logical value indicating if the development or
+##' release version number should be returned, default is release.
+##' @return A \code{package_version} object with either the release
+##' or development version.
+##' @author Dirk Eddelbuettel
+##' @seealso \code{\link{packageVersion}},
+##' \code{\link{Rcpp.package.skeleton}}
+##' @examples getRcppVersion()
+getRcppVersion <- function(devel = FALSE) {
+    rcpp <- .Call("getRcppVersionStrings", PACKAGE="Rcpp")
+    package_version(rcpp[if(devel) 2 else 1])
+}

inst/include/Rcpp/config.h

@@ -26,9 +26,11 @@
 #define RcppDevVersion(maj, min, rev, dev)  (((maj)*1000000) + ((min)*10000) + ((rev)*100) + (dev))
 
 // the currently released version
-#define RCPP_VERSION Rcpp_Version(1,0,1)
+#define RCPP_VERSION            Rcpp_Version(1,0,1)
+#define RCPP_VERSION_STRING     "1.0.1"
 
 // the current source snapshot
-#define RCPP_DEV_VERSION RcppDevVersion(1,0,1,0)
+#define RCPP_DEV_VERSION        RcppDevVersion(1,0,1,0)
+#define RCPP_DEV_VERSION_STRING "1.0.1.0"
 
 #endif

inst/unitTests/runit.misc.R

@@ -1,6 +1,6 @@
 #!/usr/bin/env r
 #
-# Copyright (C) 2010 - 2017  Dirk Eddelbuettel and Romain Francois
+# Copyright (C) 2010 - 2019  Dirk Eddelbuettel and Romain Francois
 #
 # This file is part of Rcpp.
 #
@@ -214,4 +214,11 @@ if (.runThisTest) {
         checkTrue(nchar(Rcpp:::bib()) > 0, msg="bib file")
     }
 
+    test.getRcppVersion <- function() {
+        checkTrue(inherits(getRcppVersion(), "package_version"),
+                  msg="package_version object")
+        checkTrue(getRcppVersion(devel=TRUE) >= getRcppVersion(devel=FALSE),
+                  msg="dev greater equal release")
+    }
+
 }

man/getRcppVersion.Rd

@@ -325,3 +325,11 @@ SEXP stack_trace(const char* file, int line) {
 
 // }}}
 
+
+// [[Rcpp::internal]]
+SEXP getRcppVersionStrings() {
+    Shield<SEXP> versionstring(Rf_allocVector(STRSXP,2));
+    SET_STRING_ELT(versionstring, 0, Rf_mkChar(RCPP_VERSION_STRING));
+    SET_STRING_ELT(versionstring, 1, Rf_mkChar(RCPP_DEV_VERSION_STRING));
+    return versionstring;
+}

src/api.cpp

@@ -128,6 +128,8 @@ CALLFUN_0(rcpp_capabilities);
 CALLFUN_0(rcpp_can_use_cxx0x);
 CALLFUN_0(rcpp_can_use_cxx11);
 
+CALLFUN_0(getRcppVersionStrings);
+
 /* .External functions */
 EXTFUN(CppMethod__invoke);
 EXTFUN(CppMethod__invoke_void);

src/internal.h

@@ -57,6 +57,8 @@ static R_CallMethodDef callEntries[]  = {
     CALLDEF(rcpp_capabilities,0),
     CALLDEF(rcpp_can_use_cxx0x,0),
     CALLDEF(rcpp_can_use_cxx11,0),
+
+    CALLDEF(getRcppVersionStrings,0),
     {NULL, NULL, 0}
 };
 
@@ -130,7 +132,7 @@ extern "C" void R_unload_Rcpp(DllInfo *) {  // #nocov start
 extern "C" void R_init_Rcpp(DllInfo* dllinfo) {
     setCurrentScope(0);
 
-    registerFunctions();        		// call wrapper to register export symbols 
+    registerFunctions();        		// call wrapper to register export symbols
 
     R_useDynamicSymbols(dllinfo, FALSE);	// set up symbol symbol lookup (cf R 3.4.0)