added generic get_slice and get_reconstruction functions

Author: Ellpeck

NAMESPACE

@@ -1,6 +1,9 @@
 # Generated by roxygen2: do not edit by hand
 
 export(dump_dependencies_addin)
+export(dump_reconstruct_addin)
+export(get_reconstruction)
+export(get_slice)
 export(install_node_addin)
 export(open_prefs_addin)
 export(reconstruct_addin)

R/slice.R

@@ -21,19 +21,35 @@ reconstruct_addin <- function() {
 #'
 #' @export
 dump_reconstruct_addin <- function() {
-  result <- get_slice()$result
-  code <- result$results$reconstruct$code
-  cat(if (is.null(code)) "No reconstructed code available" else code)
-  return(invisible(code))
+  get_reconstruction(print = TRUE)
 }
 
-get_slice <- function() {
-  context <- rstudioapi::getActiveDocumentContext()
-  selection <- context$selection[[1]]$range["start"][[1]]
-
-  criterion <- find_criterion(selection[[1]], selection[[2]], context$contents)
-
-  cat(paste0("[flowR] Slicing for criterion ", criterion, "\n"))
+#' Generates a slice for the given filename and criterion, code fragment and criterion, or the currently highlighted variable in the active RStudio document.
+#'
+#' @param filename The name of the file to slice. If NULL, the passed code fragment is used.
+#' @param code The code fragment to slice, as a character. If also NULL, the currently active document is used.
+#' @param criterion The slicing criterion to use. Needs to be non-NULL if filename or code is provided.
+#'
+#' @return A list containing the filename, criterion, result of the slice request, a mapping from IDs to locations, and the slice locations.
+#'
+#' @export
+get_slice <- function(filename = NULL, code = NULL, criterion = NULL) {
+  if (is.null(filename) && is.null(code)) {
+    context <- rstudioapi::getActiveDocumentContext()
+    filename <- context$path
+    code <- paste0(context$contents, collapse = "\n")
+    selection <- context$selection[[1]]$range["start"][[1]]
+    criterion <- find_criterion(selection[[1]], selection[[2]], context$contents)
+    cat(paste0("[flowR] Slicing for criterion ", criterion, "\n"))
+  } else if (is.null(criterion)) {
+    stop("Slicing for a given filename or code fragment requires passing a slicing criterion")
+  } else if (!is.null(filename) && !is.null(code)) {
+    stop("Either pass a filename or a code fragment, but not both")
+  } else if (!is.null(filename)) {
+    code <- paste0(readLines(filename, warn = FALSE), collapse = "\n")
+  } else if (!is.null(code)) {
+    filename <- "__tmp"
+  }
 
   # nolint: object_usage_linter (fails to recognize flowr_session_storage as a global var)
   conn_pid <- flowr_session_storage()
@@ -45,10 +61,10 @@ get_slice <- function() {
   analysis <- flowr::send_request(conn_pid$connection, list(
     type = "request-file-analysis",
     id = "0",
-    filename = context$path,
+    filename = filename,
     format = "json",
     filetoken = "@tmp",
-    content = paste0(context$contents, collapse = "\n")
+    content = code
   ))
   id_to_location_map <- flowr::make_id_to_location_map(analysis$results$normalize$ast)
 
@@ -68,10 +84,31 @@ get_slice <- function() {
   }
 
   return(list(
-    filename = context$path,
+    filename = filename,
     criterion = criterion,
     result = result,
     id_to_location_map = id_to_location_map,
     slice_locations = slice_locations
   ))
 }
+
+#' Generates a slice for the given filename and criterion, code fragment and criterion, or the currently highlighted variable in the active RStudio document and returns the reconstructed code fragment.
+#'
+#' @param filename The name of the file to slice. If NULL, the passed code fragment is used.
+#' @param code The code fragment to slice, as a character. If also NULL, the currently active document is used.
+#' @param criterion The slicing criterion to use. Needs to be non-NULL if filename or code is provided.
+#' @param print If TRUE, the reconstructed code is printed to the console and returned invisibly. Defaults to FALSE.
+#'
+#' @return The reconstructed code fragment for the generated slice.
+#'
+#' @export
+get_reconstruction <- function(filename = NULL, code = NULL, criterion = NULL, print = FALSE) {
+  result <- get_slice(filename, code, criterion)$result
+  code <- result$results$reconstruct$code
+  if (print) {
+    cat(if (is.null(code)) "No reconstructed code available" else code)
+    return(invisible(code))
+  } else {
+    return(code)
+  }
+}