add cleanupCacheDir option to sourceCpp

Author: jjallaire

R/Attributes.R

@@ -24,6 +24,7 @@ sourceCpp <- function(file = "",
                       embeddedR = TRUE,
                       rebuild = FALSE,
                       cacheDir = tempdir(),
+                      cleanupCacheDir = FALSE,
                       showOutput = verbose,
                       verbose = getOption("verbose"),
                       dryRun = FALSE) {
@@ -32,8 +33,8 @@ sourceCpp <- function(file = "",
     # (since cached dynlibs can now perist across sessions we need to be
     # sure to invalidate them when R or Rcpp versions change)
     cacheDir <- path.expand(cacheDir)
-    cacheDir <- normalizePath(cacheDir, winslash = "/", mustWork = FALSE)
     cacheDir <- .sourceCppPlatformCacheDir(cacheDir)
+    cacheDir <- normalizePath(cacheDir)
 
     # resolve code into a file if necessary. also track the working
     # directory to source the R embedded code chunk within
@@ -197,6 +198,10 @@ sourceCpp <- function(file = "",
         setwd(rWorkingDir) # will be reset by previous on.exit handler
         source(file=srcConn, echo=TRUE)
     }
+    
+    # cleanup the cache dir if requested
+    if (cleanupCacheDir)
+        cleanupSourceCppCache(cacheDir, context$cppSourcePath, context$buildDirectory)
 
     # return (invisibly) a list containing exported functions and modules
     invisible(list(functions = context$exportedFunctions,
@@ -205,6 +210,27 @@ sourceCpp <- function(file = "",
                    buildDirectory = context$buildDirectory))
 }
 
+
+# Cleanup a directory used as the cache for a sourceCpp compilation. This will
+# remove all files from the cache directory that aren't a result of the 
+# compilation that yielded the passed buildDirectory. 
+cleanupSourceCppCache <- function(cacheDir, cppSourcePath, buildDirectory) {
+    # normalize cpp source path and build directory 
+    cppSourcePath <- normalizePath(cppSourcePath)
+    buildDirectory <- normalizePath(buildDirectory)
+    
+    # determine the parent dir that was used for the compilation then collect all the
+    # *.cpp files and subdirectories therein
+    cacheFiles <- list.files(cacheDir, pattern = glob2rx("*.cpp"), recursive = FALSE, full.names = TRUE)
+    cacheFiles <- c(cacheFiles, list.dirs(cacheDir, recursive = FALSE, full.names = TRUE))
+    cacheFiles <- normalizePath(cacheFiles)
+    
+    # determine the list of tiles that were not yielded by the passed sourceCpp
+    # result and remove them
+    oldCacheFiles <- cacheFiles[!cacheFiles %in% c(cppSourcePath, buildDirectory)]
+    unlink(oldCacheFiles, recursive = TRUE)
+}
+
 # Define a single C++ function
 cppFunction <- function(code,
                         depends = character(),
@@ -1063,10 +1089,8 @@ sourceCppFunction <- function(func, isVoid, dll, symbol) {
 .sourceCppPlatformCacheDir <- function(cacheDir) {
 
     dir <- file.path(cacheDir,
-                     paste("sourceCpp",
+                     paste(R.version$platform,
                            utils::packageVersion("Rcpp"),
-                           R.version$platform,
-                           R.version$`svn rev`,
                            sep = "-"))
     if (!dir.exists(dir))
         dir.create(dir, recursive = TRUE)

man/sourceCpp.Rd

@@ -9,7 +9,8 @@ and RCPP_MODULE declarations. A shared library is then built and its exported fu
 }
 \usage{
 sourceCpp(file = "", code = NULL, env = globalenv(),
-          embeddedR = TRUE, rebuild = FALSE, cacheDir = tempdir(),
+          embeddedR = TRUE, rebuild = FALSE, 
+          cacheDir = tempdir(), cleanupCacheDir = FALSE,
           showOutput = verbose, verbose = getOption("verbose"),
           dryRun = FALSE)
 }
@@ -31,6 +32,9 @@ sourceCpp(file = "", code = NULL, env = globalenv(),
 }
   \item{cacheDir}{
     Directory to use for caching shared libraries. If the underlying file or code passed to \code{sourceCpp} has not changed since the last invocation then a cached version of the shared library is used. The default value of \code{tempdir()} results in the cache being valid only for the current R session. Pass an alternate directory to preserve the cache across R sessions.
+}
+\item{cleanupCacheDir}{
+    Cleanup all files in the cacheDir that were not a result of this compilation. Note that this will cleanup the cache from all other calls to sourceCpp with the same cacheDir. This option should therefore only be specified by callers that provide a unique cacheDir per scope (e.g. chunk labels in a weaved document).
 }
   \item{showOutput}{
     \code{TRUE} to print \code{R CMD SHLIB} output to the console.
@@ -74,7 +78,7 @@ fibonacci(10)
 */
 }
 
-	Multiple R code chunks can be included in a C++ file. R code is sourced after the C++ compliation is completed so all functions and modules will be available to the R code.   
+	Multiple R code chunks can be included in a C++ file. R code is sourced after the C++ compilation is completed so all functions and modules will be available to the R code.   
 }
 
 \value{