don't use cpp_source!

Author: pachadotdev

DESCRIPTION

@@ -47,7 +47,7 @@ Suggests:
 VignetteBuilder:
     knitr
 Config/testthat/edition: 3
-Config/Needs/cpp4r/cpp_register:
+Config/Needs/cpp4r/register:
     brio,
     cli,
     decor,

NAMESPACE

@@ -1,7 +1,5 @@
 # Generated by roxygen2: do not edit by hand
 
-export(cpp_eval)
-export(cpp_function)
-export(cpp_register)
-export(cpp_source)
-export(cpp_vendor)
+export(register)
+export(unvendor)
+export(vendor)

R/knitr.R

@@ -7,7 +7,7 @@
 #' Note registered functions will not be *exported* from your package unless
 #' you also add a `@export` roxygen2 directive for them.
 #'
-#' In order to use `cpp_register()` the `cli`, `decor`, `desc`, `glue`,
+#' In order to use `register()` the `cli`, `decor`, `desc`, `glue`,
 #' `tibble` and `vctrs` packages must also be installed.
 #' @param path The path to the package root directory
 #' @param quiet If `TRUE` suppresses output from this function
@@ -28,16 +28,16 @@
 #' writeLines("[[cpp4r::register]] int one() { return 1; }", file.path(dir, "src", "one.cpp"))
 #'
 #' # register the functions in the package
-#' cpp_register(dir)
+#' register(dir)
 #'
 #' # Files generated by registration
 #' file.exists(file.path(dir, "R", "cpp4r.R"))
 #' file.exists(file.path(dir, "src", "cpp4r.cpp"))
 #'
 #' # cleanup
 #' unlink(dir, recursive = TRUE)
-cpp_register <- function(path = ".", quiet = !is_interactive(), extension = c(".cpp", ".cc")) {
-  stop_unless_installed(get_cpp_register_needs())
+register <- function(path = ".", quiet = !is_interactive(), extension = c(".cpp", ".cc")) {
+  stop_unless_installed(get_register_needs())
   extension <- match.arg(extension)
 
   r_path <- file.path(path, "R", "cpp4r.R")
@@ -300,8 +300,8 @@ pkg_links_to_rcpp <- function(path) {
   any(deps$type == "LinkingTo" & deps$package == "Rcpp")
 }
 
-get_cpp_register_needs <- function() {
-  res <- read.dcf(system.file("DESCRIPTION", package = "cpp4r"))[, "Config/Needs/cpp4r/cpp_register"]
+get_register_needs <- function() {
+  res <- read.dcf(system.file("DESCRIPTION", package = "cpp4r"))[, "Config/Needs/cpp4r/register"]
   strsplit(res, "[[:space:]]*,[[:space:]]*")[[1]]
 }
 

R/register.R

@@ -0,0 +1,39 @@
+#' Unvendor the cpp4r headers
+#'
+#' This function removes the vendored cpp4r headers from your package and
+#' restores the `LinkingTo: cpp4r` field in the DESCRIPTION file if it was removed.
+#'
+#' @inheritParams register
+#' @return The file path to the unvendored code (invisibly).
+#' @export
+#' @examples
+#' # create a new directory
+#' dir <- tempfile()
+#' dir.create(dir)
+#'
+#' # vendor the cpp4r headers into the directory
+#' vendor(dir)
+#'
+#' # unvendor the cpp4r headers from the directory
+#' unvendor(dir)
+#'
+#' list.files(file.path(dir, "inst", "include", "cpp4r"))
+#'
+#' # cleanup
+#' unlink(dir, recursive = TRUE)
+unvendor <- function(path = ".") {
+  new <- file.path(path, "inst", "include", "cpp4r")
+
+  if (!dir.exists(new)) {
+    stop("'", new, "' does not exist", call. = FALSE)
+  }
+
+  unlink(new, recursive = TRUE)
+
+  cpp4r_hpp <- file.path(dirname(new), "cpp4r.hpp")
+  if (file.exists(cpp4r_hpp)) {
+    unlink(cpp4r_hpp)
+  }
+
+  invisible(new)
+}