remove recursive as argument for cross-platform consistency

Author: shikokuchuo

R/watch.R

@@ -8,10 +8,8 @@
 #' triggers multiple event flag types, the callback will be called only once.
 #' Default latency is 1s.
 #'
-#' @param path Character path to a file or directory to watch. Defaults to the
-#'   current working directory.
-#' @param recursive Logical value, default TRUE, whether to recursively scan
-#'   `path`, including all subdirectories.
+#' @param path Character path to a file, or directory to watch recursively.
+#'   Defaults to the current working directory.
 #' @param callback A function or formula (see [rlang::as_function]) - to be
 #'   called each time an event is triggered. The default, `NULL`, causes event
 #'   flag types and paths to be written to `stdout` instead.
@@ -29,8 +27,8 @@
 #'
 #' @export
 #'
-watcher <- function(path = getwd(), recursive = TRUE, callback = NULL) {
-  Watcher$new(path, recursive, callback)
+watcher <- function(path = getwd(), callback = NULL) {
+  Watcher$new(path, callback)
 }
 
 # Note: R6 class uses a field for 'running' instead of using 'fsw_is_running()'
@@ -41,14 +39,13 @@ Watcher <- R6Class(
   public = list(
     path = NULL,
     running = FALSE,
-    initialize = function(path, recursive, callback) {
+    initialize = function(path, callback) {
       if (is.null(self$path)) {
         self$path <- path.expand(path)
-        recursive <- as.logical(recursive)
         if (!is.null(callback) && !is.function(callback)) {
           callback <- rlang::as_function(callback)
         }
-        private$watch <- .Call(watcher_create, self$path, recursive, callback)
+        private$watch <- .Call(watcher_create, self$path, callback)
         lockBinding("path", self)
       }
       invisible(self)

README.Rmd

@@ -53,7 +53,7 @@ library(watcher)
 dir <- file.path(tempdir(), "watcher-example")
 dir.create(dir)
 
-w <- watcher(dir, recursive = TRUE, callback = ~print("event triggered"))
+w <- watcher(dir, callback = ~print("event triggered"))
 w
 w$start()
 

README.md

@@ -49,12 +49,12 @@ library(watcher)
 dir <- file.path(tempdir(), "watcher-example")
 dir.create(dir)
 
-w <- watcher(dir, recursive = TRUE, callback = ~print("event triggered"))
+w <- watcher(dir, callback = ~print("event triggered"))
 w
 #> <Watcher>
 #>   Public:
-#>     initialize: function (path, recursive, callback) 
-#>     path: /tmp/RtmpvhoSAP/watcher-example
+#>     initialize: function (path, callback) 
+#>     path: /tmp/Rtmp1YkKqF/watcher-example
 #>     running: FALSE
 #>     start: function () 
 #>     stop: function () 

man/watcher.Rd

@@ -3,7 +3,7 @@
 void (*eln2)(void (*)(void *), void *, double, int);
 
 static const R_CallMethodDef callMethods[] = {
-  {"watcher_create", (DL_FUNC) &watcher_create, 3},
+  {"watcher_create", (DL_FUNC) &watcher_create, 2},
   {"watcher_start_monitor", (DL_FUNC) &watcher_start_monitor, 1},
   {"watcher_stop_monitor", (DL_FUNC) &watcher_stop_monitor, 1},
   {NULL, NULL, 0}

src/init.c

@@ -77,10 +77,12 @@ static void session_finalizer(SEXP xptr) {
 
 }
 
-SEXP watcher_create(SEXP path, SEXP recursive, SEXP callback) {
+/* Note: recursive is always set for consistency of behaviour, as Windows and
+MacOS default monitors are always recursive this would apply only on Linux */
+
+SEXP watcher_create(SEXP path, SEXP callback) {
 
   const char *watch_path = CHAR(STRING_ELT(path, 0));
-  const int recurse = LOGICAL(recursive)[0] == 1;
 
   FSW_HANDLE handle = fsw_init_session(system_default_monitor_type);
   if (handle == NULL)
@@ -89,7 +91,7 @@ SEXP watcher_create(SEXP path, SEXP recursive, SEXP callback) {
   if (fsw_add_path(handle, watch_path) != FSW_OK)
     watcher_error(handle, "Failed to add path to watch");
 
-  if (fsw_set_recursive(handle, recurse) != FSW_OK)
+  if (fsw_set_recursive(handle, true) != FSW_OK)
     watcher_error(handle, "Failed to set recursive watch");
 
   if (fsw_set_callback(handle, process_events, callback) != FSW_OK)

src/watcher.c

@@ -21,7 +21,7 @@
 
 extern void (*eln2)(void (*)(void *), void *, double, int);
 
-SEXP watcher_create(SEXP, SEXP, SEXP);
+SEXP watcher_create(SEXP, SEXP);
 SEXP watcher_start_monitor(SEXP);
 SEXP watcher_stop_monitor(SEXP);
 

src/watcher.h

@@ -4,7 +4,7 @@ dir.create(dir)
 dir.create(subdir)
 
 test_that("watcher() logs", {
-  w <- watcher(dir, recursive = FALSE, callback = NULL)
+  w <- watcher(dir, callback = NULL)
   expect_s3_class(w, "Watcher")
   expect_false(w$running)
   expect_false(w$stop())
@@ -24,7 +24,7 @@ test_that("watcher() logs", {
 
 test_that("watcher() callbacks", {
   x <- 0L
-  w <- watcher(dir, recursive = TRUE, callback = ~ {x <<- x + 1L})
+  w <- watcher(dir, callback = ~ {x <<- x + 1L})
   expect_output(print(w))
   expect_s3_class(w, "Watcher")
   expect_false(w$running)